swaggular 0.2.2 → 0.2.4

package/dist/generators/generate-service.js

@@ -1,302 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateServices = generateServices;
-exports.generateServiceFiles = generateServiceFiles;
-exports.buildMethods = buildMethods;
-exports.buildMethod = buildMethod;
-exports.computeName = computeName;
-const services_store_1 = require("../stores/services-store");
-const swagger_store_1 = require("../stores/swagger-store");
-const angular_template_1 = require("../templates/services/angular-template");
-const build_types_1 = require("../utils/build-types");
-const path_utils_1 = require("../utils/path-utils");
-const string_utils_1 = require("../utils/string-utils");
-const type_guard_1 = require("../utils/type-guard");
-const generate_interface_1 = require("./generate-interface");
-const generate_comments_1 = require("./generate-comments");
-/**
- * Pick the paths grouped by scope and generate services for them.
- * Each group will generate one service data.
- * Each service data will contain the methods for the paths.
- *
- * The name will be the group name concatenated with Service
- *
- * The imports will be the types used in the methods. Including
- * the response type and the parameters types.
- *
- * The base url will be the base url of the group compound by the
- * base segments of the group.
- *
- * Each method will be generated based on a path
- *
- * The method name will be computed based on the path.
- * It has to follow some stantardized rules.
- *
- * The method parameters will be computed based on the path parameters
- * The method path will be computed based on the path, but it will be
- * computed as `${this.baseUrl}/something/else/{id}`
- * The method response type will be computed based on the path response
- * The method parameters will be computed based on the path parameters
- * The method parameter name will be computed based on the path parameter name if
- * the parameters has the property "in" set to "path". If the parameter has the property
- * "in" set to "query", it will be computed as "parameters" and query parameters should be grouped
- * in the same object. Check computeParametersName() method in generate-interface.ts to
- * understand how the name is computed.
- *
- * The method parameter in property will be computed based on the path parameter "in" property
- * The method parameter type will be computed based on the path parameter type property.
- * Check computeParametersName() method in generate-interface.ts to
- * understand how the name is computed.
- * The method parameter required will be computed based on the path parameter required property
- * @returns ServiceData[]
- */
-function generateServices() {
-    const servicesData = [];
-    const groupedPaths = swagger_store_1.swaggerStore.getPathsGroupedByScope();
-    const paths = swagger_store_1.swaggerStore.getPaths();
-    if (!groupedPaths || !paths)
-        return;
-    for (const [key, value] of Object.entries(groupedPaths)) {
-        const methods = buildMethods(value);
-        const importsSet = new Set();
-        methods.forEach((method) => {
-            const allTypes = [
-                method.responseType,
-                ...method.parameters.map((p) => p.type),
-            ];
-            allTypes.forEach((t) => {
-                const identifiers = t.match(/[a-zA-Z_][a-zA-Z0-9_]*/g) || [];
-                identifiers.forEach((id) => {
-                    if (!(0, type_guard_1.isNativeType)(id) && id !== "void") {
-                        importsSet.add(id);
-                    }
-                });
-            });
-        });
-        const serviceData = {
-            name: key + "Service",
-            imports: Array.from(importsSet),
-            baseUrl: value.baseUrl,
-            methods: methods,
-        };
-        servicesData.push(serviceData);
-    }
-    services_store_1.serviceStore.addServices(servicesData);
-}
-function generateServiceFiles(locations) {
-    const services = Object.values(services_store_1.serviceStore.services);
-    const filesContent = [];
-    for (const service of services) {
-        const methodsString = service.methods
-            .map((method) => generateMethodString(method))
-            .join("\n\n");
-        const templateParams = {
-            name: service.name.replace("Service", ""),
-            baseUrl: service.baseUrl,
-            methods: methodsString,
-            imports: service.imports.join(", "),
-            hasHttpParamsHandler: service.methods.some((m) => m.parameters.some((p) => p.in === "query")),
-        };
-        // If imports are empty, we might want to clean up the template later,
-        // but for now we follow the existing template structure.
-        filesContent.push({
-            location: ["services", ...(locations?.[service.name] ?? [])],
-            name: (0, string_utils_1.toKebabCase)(service.name.replace("Service", "")) + ".service",
-            content: (0, angular_template_1.angularServiceTemplate)(templateParams),
-            extension: "ts",
-        });
-    }
-    return filesContent;
-}
-function generateMethodString(method) {
-    const paramsSignature = method.parameters
-        .map((p) => `${p.name}${p.required ? "" : "?"}: ${p.type}`)
-        .join(", ");
-    const httpMethod = method.method.toLowerCase();
-    const responseType = method.responseType;
-    // Convert {id} to ${id} in path
-    let path = method.path.replace(/{([^}]+)}/g, "${$1}");
-    if (!path.startsWith("`")) {
-        // Remove the first $
-        path = `\`${path.slice(1)}\``;
-    }
-    let body = "";
-    const queryParam = method.parameters.find((p) => p.in === "query");
-    if (queryParam) {
-        body += `    const params = HttpHelper.toHttpParams(${queryParam.name} ?? {});\n`;
-    }
-    const options = [];
-    if (queryParam)
-        options.push("params");
-    if (responseType === "Blob" || responseType === "File") {
-        options.push("responseType: 'blob'");
-    }
-    if (httpMethod === "delete" &&
-        method.parameters.some((p) => p.in === "body")) {
-        options.push("body: " + method.parameters.find((p) => p.in === "body")?.name);
-    }
-    const optionsString = options.length > 0 ? `, { ${options.join(", ")} }` : "";
-    if (httpMethod === "get" || httpMethod === "delete") {
-        body += `    return this.http.${httpMethod}<${responseType}>(${path}${optionsString});`;
-    }
-    else {
-        // post, put, patch
-        const dataParam = method.parameters.find((p) => p.in === "body")?.name || "null";
-        body += `    return this.http.${httpMethod}<${responseType}>(${path}, ${dataParam}${optionsString});`;
-    }
-    return `${method.comments}\n  public ${method.name}(${paramsSignature}): Observable<${responseType}> {
-${body}
-  }`;
-}
-function buildMethods(groupedPath) {
-    const methods = [];
-    const pathData = swagger_store_1.swaggerStore.getPaths();
-    const usedNames = [];
-    for (const path of groupedPath.paths) {
-        if (!pathData || !pathData[path])
-            continue;
-        for (const [httpMethod, pathInfo] of Object.entries(pathData[path])) {
-            if (typeof pathInfo !== "object")
-                continue;
-            const method = buildMethod(path, httpMethod, pathInfo, groupedPath, usedNames);
-            methods.push(method);
-            usedNames.push(method.name);
-        }
-    }
-    return methods;
-}
-function buildMethod(path, httpMethod, pathInfo, groupedPath, usedNames) {
-    const baseUrl = groupedPath.baseUrl;
-    const extraSegments = (0, path_utils_1.getExtraSegments)(path, baseUrl).join("/");
-    const methodPath = extraSegments
-        ? `\${this.baseUrl}/${extraSegments}`
-        : `\${this.baseUrl}`;
-    const responseType = getMethodResponseType(pathInfo);
-    const parameters = getMethodParameters(path, httpMethod, pathInfo, groupedPath);
-    const method = {
-        name: computeName(path, httpMethod, usedNames),
-        path: methodPath,
-        method: httpMethod,
-        parameters: parameters,
-        responseType: responseType,
-        comments: (0, generate_comments_1.generateServiceComments)(pathInfo.summary || "", responseType, parameters),
-    };
-    return method;
-}
-function getMethodResponseType(pathInfo) {
-    const responses = pathInfo.responses;
-    if (!responses)
-        return "void";
-    const successResponse = responses["200"] || responses["201"] || responses["default"];
-    if (!successResponse)
-        return "void";
-    if ((0, type_guard_1.isReference)(successResponse)) {
-        return "any";
-    }
-    const content = successResponse.content;
-    if (!content || !content["application/json"])
-        return "void";
-    const schema = content["application/json"].schema;
-    if (!schema)
-        return "void";
-    return (0, build_types_1.switchTypeJson)(schema);
-}
-function getMethodParameters(path, httpMethod, pathInfo, groupedPath) {
-    const parameters = [];
-    const openApiParameters = pathInfo.parameters || [];
-    // Path parameters
-    openApiParameters.forEach((param) => {
-        if ((0, type_guard_1.isReference)(param))
-            return;
-        if (param.in === "path") {
-            parameters.push({
-                name: param.name,
-                in: "path",
-                required: param.required || false,
-                type: (0, build_types_1.switchTypeJson)(param.schema),
-            });
-        }
-    });
-    // Query parameters (grouped)
-    const queryParams = openApiParameters.filter((param) => !(0, type_guard_1.isReference)(param) && param.in === "query");
-    if (queryParams.length > 0) {
-        parameters.push({
-            name: "parameters",
-            in: "query",
-            required: queryParams.some((p) => p.required),
-            type: (0, generate_interface_1.computeParametersName)(httpMethod, path, groupedPath),
-        });
-    }
-    // Request Body
-    if (pathInfo.requestBody) {
-        let bodyType = "any";
-        if ((0, type_guard_1.isReference)(pathInfo.requestBody)) {
-            bodyType = pathInfo.requestBody.$ref.split("/").pop();
-        }
-        else {
-            const content = pathInfo.requestBody.content;
-            if (content && content["application/json"]) {
-                const schema = content["application/json"].schema;
-                if (schema) {
-                    bodyType = (0, build_types_1.switchTypeJson)(schema);
-                }
-            }
-        }
-        parameters.push({
-            name: "data",
-            in: "body",
-            required: true,
-            type: bodyType,
-        });
-    }
-    return parameters;
-}
-function computeName(path, httpMethod, usedNames) {
-    const dict = {
-        get: "get",
-        post: "create",
-        put: "update",
-        delete: "delete",
-        patch: "patch",
-    };
-    const parts = path.split("/").filter((p) => p);
-    const endsInVariable = (0, path_utils_1.isVariable)(parts[parts.length - 1]);
-    if (endsInVariable) {
-        const name = dict[httpMethod];
-        if (usedNames.includes(name)) {
-            return name + (0, string_utils_1.kebabToPascalCase)(parts[parts.length - 2]);
-        }
-        return name;
-    }
-    if (httpMethod === "get" || httpMethod === "put" || httpMethod === "patch") {
-        let name = dict[httpMethod] + "All";
-        if (!usedNames.includes(name)) {
-            return name;
-        }
-        name = dict[httpMethod] + (0, string_utils_1.kebabToPascalCase)(parts[parts.length - 1]);
-        if (!usedNames.includes(name)) {
-            return name;
-        }
-        return dict[httpMethod] + "By" + (0, string_utils_1.kebabToPascalCase)(parts[parts.length - 1]);
-    }
-    if (httpMethod === "post") {
-        let name = dict[httpMethod];
-        if (!usedNames.includes(name)) {
-            return name;
-        }
-        name = (0, string_utils_1.kebabToPascalCase)(parts[parts.length - 1]);
-        if (!usedNames.includes(name)) {
-            return name;
-        }
-        name = "createBy" + (0, string_utils_1.kebabToPascalCase)(parts[parts.length - 1]);
-        if (!usedNames.includes(name)) {
-            return name;
-        }
-        return "create" + (0, string_utils_1.kebabToPascalCase)(parts[parts.length - 1]);
-    }
-    const name = dict[httpMethod];
-    if (usedNames.includes(name)) {
-        return name + (0, string_utils_1.kebabToPascalCase)(parts[parts.length - 1]);
-    }
-    return name + "By" + (0, string_utils_1.kebabToPascalCase)(parts[parts.length - 1]);
-}

package/dist/models/file-content.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/grouped-paths.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/interface-data.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/parsed-args.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/service-data.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/types.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AngularRequestType = exports.AngularResponseType = exports.NativeType = void 0;
-var NativeType;
-(function (NativeType) {
-    NativeType["String"] = "string";
-    NativeType["Number"] = "number";
-    NativeType["Boolean"] = "boolean";
-    NativeType["Array"] = "Array";
-    NativeType["Date"] = "Date";
-    NativeType["File"] = "File";
-    NativeType["Any"] = "any";
-    NativeType["Void"] = "void";
-})(NativeType || (exports.NativeType = NativeType = {}));
-var AngularResponseType;
-(function (AngularResponseType) {
-    AngularResponseType["Json"] = "json";
-    AngularResponseType["Text"] = "text";
-    AngularResponseType["Blob"] = "blob";
-    AngularResponseType["ArrayBuffer"] = "arrayBuffer";
-})(AngularResponseType || (exports.AngularResponseType = AngularResponseType = {}));
-var AngularRequestType;
-(function (AngularRequestType) {
-    AngularRequestType["Get"] = "get";
-    AngularRequestType["Post"] = "post";
-    AngularRequestType["Put"] = "put";
-    AngularRequestType["Delete"] = "delete";
-    AngularRequestType["Patch"] = "patch";
-})(AngularRequestType || (exports.AngularRequestType = AngularRequestType = {}));

package/dist/stores/interface-data-store.js

@@ -1,62 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.interfaceDataStore = void 0;
-class InterfaceDataStore {
-    genericInterfaces = {};
-    baseInterfaces = {};
-    generatedInterfaces = {};
-    generatedEnums = {};
-    componentsSchemas = {};
-    constructor() { }
-    setComponentsSchemas(componentsSchemas) {
-        this.componentsSchemas = componentsSchemas;
-    }
-    getComponentsSchema(name) {
-        return this.componentsSchemas[name];
-    }
-    exists(name) {
-        return (this.genericInterfaces[name] !== undefined ||
-            this.baseInterfaces[name] !== undefined ||
-            this.generatedInterfaces[name] !== undefined ||
-            this.generatedEnums[name] !== undefined);
-    }
-    addInterfaces(interfacesData) {
-        for (const inter of interfacesData) {
-            this.generatedInterfaces[inter.name] = inter;
-        }
-    }
-    computeExtendsFrom(properties) {
-        if (properties.length === 0)
-            return { extendsFrom: undefined, properties: [] };
-        const currentPropertiesNames = new Set(properties.map((p) => p.name));
-        for (const [name, schema] of Object.entries(this.baseInterfaces)) {
-            if (schema.properties.length !== properties.length)
-                continue;
-            const required = schema.properties
-                .filter((p) => !p.optional)
-                .map((p) => p.name);
-            if (required.some((r) => !currentPropertiesNames.has(r))) {
-                continue;
-            }
-            const optional = schema.properties
-                .filter((p) => p.optional)
-                .map((p) => p.name);
-            const remainingProperties = properties
-                .filter((p) => !required.includes(p.name))
-                .filter((p) => !optional.includes(p.name));
-            if (remainingProperties.length === 0 &&
-                schema.properties.some((p) => p.type === "generic")) {
-                return {
-                    extendsFrom: name,
-                    properties: [],
-                };
-            }
-            return {
-                extendsFrom: name,
-                properties: remainingProperties,
-            };
-        }
-        return { extendsFrom: undefined, properties };
-    }
-}
-exports.interfaceDataStore = new InterfaceDataStore();

package/dist/stores/services-store.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.serviceStore = void 0;
-class ServiceStore {
-    services = {};
-    addService(name, content) {
-        this.services[name] = content;
-    }
-    addServices(services) {
-        services.forEach((service) => {
-            this.services[service.name] = service;
-        });
-    }
-    getService(name) {
-        return this.services[name];
-    }
-}
-exports.serviceStore = new ServiceStore();