jsii-diff/lib/stability.js

Assembly comparison for jsii

"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    var desc = Object.getOwnPropertyDescriptor(m, k);
    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
      desc = { enumerable: true, get: function() { return m[k]; } };
    }
    Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
    Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
    o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
    var ownKeys = function(o) {
        ownKeys = Object.getOwnPropertyNames || function (o) {
            var ar = [];
            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
            return ar;
        };
        return ownKeys(o);
    };
    return function (mod) {
        if (mod && mod.__esModule) return mod;
        var result = {};
        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
        __setModuleDefault(result, mod);
        return result;
    };
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.validateStabilities = validateStabilities;
const spec = __importStar(require("@jsii/spec"));
function validateStabilities(original, updated, mismatches) {
    // Nothing to do in these cases
    if (original.docs.stability === undefined ||
        original.docs.stability === updated.docs.stability) {
        return;
    }
    // Not allowed to disavow stability
    if (updated.docs.stability === undefined) {
        mismatches.report({
            ruleKey: 'removed-stability',
            message: `stability was '${original.docs.stability}', has been removed`,
            violator: original,
        });
        return;
    }
    const allowed = allowedTransitions(original.docs.stability);
    if (!allowed.includes(updated.docs.stability)) {
        mismatches.report({
            ruleKey: 'changed-stability',
            message: `stability not allowed to go from '${original.docs.stability}' to '${updated.docs.stability}'`,
            violator: original,
        });
    }
}
function allowedTransitions(start) {
    switch (start) {
        // Experimental can go to stable, external, or be deprecated
        case spec.Stability.Experimental:
            return [
                spec.Stability.Stable,
                spec.Stability.Deprecated,
                spec.Stability.External,
            ];
        // Stable can be deprecated, or switched to external
        case spec.Stability.Stable:
            return [spec.Stability.Deprecated, spec.Stability.External];
        // Deprecated can be reinstated
        case spec.Stability.Deprecated:
            return [spec.Stability.Stable, spec.Stability.External];
        // external can be stableified, or deprecated
        case spec.Stability.External:
            return [spec.Stability.Stable, spec.Stability.Deprecated];
        default:
            throw new Error(`Unrecognized stability: ${start}`);
    }
}
//# sourceMappingURL=stability.js.map