@namecheap/tsoa-cli/dist/metadataGeneration/extension.js

Build swagger-compliant REST APIs using TypeScript and Node

"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.getExtensions = getExtensions;
exports.getExtensionsFromJSDocComments = getExtensionsFromJSDocComments;
const ts = __importStar(require("typescript"));
const initializer_value_1 = require("./initializer-value");
const jsonUtils_1 = require("../utils/jsonUtils");
function getExtensions(decorators, metadataGenerator) {
    const extensions = decorators.map(extensionDecorator => {
        if (!ts.isCallExpression(extensionDecorator.parent)) {
            throw new Error('The parent of the @Extension is not a CallExpression. Are you using it in the right place?');
        }
        const [decoratorKeyArg, decoratorValueArg] = extensionDecorator.parent.arguments;
        if (!ts.isStringLiteral(decoratorKeyArg) && !ts.isIdentifier(decoratorKeyArg)) {
            throw new Error('The first argument of @Extension must be a string');
        }
        const attributeKey = ts.isIdentifier(decoratorKeyArg) ? (0, initializer_value_1.getInitializerValue)(decoratorKeyArg, metadataGenerator.typeChecker) : decoratorKeyArg.text;
        if (typeof attributeKey !== 'string') {
            throw new Error('The first argument of @Extension must be a string');
        }
        if (!decoratorValueArg) {
            throw new Error(`Extension '${attributeKey}' must contain a value`);
        }
        assertValidExtensionKey(attributeKey);
        const attributeValue = (0, initializer_value_1.getInitializerValue)(decoratorValueArg, metadataGenerator.typeChecker);
        if (!(0, initializer_value_1.isNonUndefinedInitializerValue)(attributeValue)) {
            throw new Error(`Extension '${attributeKey}' cannot have an undefined initializer value`);
        }
        return { key: attributeKey, value: attributeValue };
    });
    return extensions;
}
function getExtensionsFromJSDocComments(comments) {
    const extensions = [];
    comments.forEach(comment => {
        const extensionData = (0, jsonUtils_1.safeFromJson)(comment);
        if (extensionData) {
            const keys = Object.keys(extensionData);
            keys.forEach(key => {
                assertValidExtensionKey(key);
                extensions.push({ key: key, value: extensionData[key] });
            });
        }
    });
    return extensions;
}
function assertValidExtensionKey(key) {
    if (!key.startsWith('x-')) {
        throw new Error('Extensions must begin with "x-" to be valid. Please see the following link for more information: https://swagger.io/docs/specification/openapi-extensions/');
    }
}
//# sourceMappingURL=extension.js.map