swaggular 0.2.2 → 0.2.4

package/dist/index.js

@@ -16,6 +16,7 @@ async function main() {
     try {
         const parsed = (0, args_1.getParseArgs)(process.argv.slice(2));
         const variables = (0, variables_1.toVariables)(parsed);
+        console.log('Generating interfaces and services using Swaggular@' + process.env.npm_package_version);
         swagger_parser_1.SwaggerParser.parse(variables.input, {
             mode: variables.groupingMode,
             segmentsToIgnore: variables.segmentsToIgnore,

package/dist/renderers/generate-interface.js

@@ -154,7 +154,11 @@ function generateComponentsSchemas() {
         const interData = {
             name: key,
             type: 'interface',
-            imports: properties.filter((p) => !(0, type_guard_1.isNativeType)(p.type)).map((p) => p.type),
+            imports: properties
+                .filter((p) => !(0, type_guard_1.isNativeType)(p.type))
+                .map((p) => {
+                return p.type.replaceAll('[]', '');
+            }),
             properties,
         };
         const generic = (0, generic_types_1.isGenericType)(interData);
@@ -175,7 +179,7 @@ function generateInterfacesFiles(locations) {
     const filesContent = [];
     for (const [key, value] of Object.entries(interfacesData)) {
         const location = [value.type === 'enum' ? 'enums' : 'dtos', ...(locations?.[key] ?? [])];
-        const content = generateContent(value, location.length);
+        const content = generateContent(value, location.length + 1);
         const extraName = value.type === 'enum' ? 'enum' : 'dto';
         filesContent.push({
             location: location,
@@ -188,9 +192,8 @@ function generateInterfacesFiles(locations) {
 }
 function generateContent(interfaceData, deep = 0) {
     const imports = [...interfaceData.imports];
-    const importsTemplate = imports.length > 0
-        ? `import { ${imports.join(', ')} } from "${'../'.repeat(deep)}models";`
-        : '';
+    const path = '../'.repeat(deep);
+    const importsTemplate = imports.length > 0 ? `import { ${imports.join(', ')} } from "${path}models";` : '';
     if (interfaceData.type === 'interface') {
         const content = `${importsTemplate}\n\nexport interface ${interfaceData.name} ${interfaceData.extendsFrom && interfaceData.extendsFrom.length > 0 ? `extends ${interfaceData.extendsFrom.join(', ')}` : ''} {
     ${interfaceData.properties

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swaggular",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {

package/dist/app/get-parse-args.js

@@ -1,48 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getParseArgs = getParseArgs;
-function getParseArgs(argv) {
-    const args = {};
-    const positional = [];
-    for (let i = 0; i < argv.length; i++) {
-        const arg = argv[i];
-        if (arg.startsWith("--") && arg.includes("=")) {
-            const [k, v] = arg.slice(2).split("=");
-            args[k] = v;
-            continue;
-        }
-        if (arg.startsWith("--")) {
-            const k = arg.slice(2);
-            const next = argv[i + 1];
-            if (!next || next.startsWith("-")) {
-                args[k] = true;
-            }
-            else {
-                args[k] = next;
-                i++;
-            }
-            continue;
-        }
-        if (arg.startsWith("-") && arg.length > 2) {
-            arg
-                .slice(1)
-                .split("")
-                .forEach((k) => (args[k] = true));
-            continue;
-        }
-        if (arg.startsWith("-")) {
-            const k = arg.slice(1);
-            const next = argv[i + 1];
-            if (!next || next.startsWith("-")) {
-                args[k] = true;
-            }
-            else {
-                args[k] = next;
-                i++;
-            }
-            continue;
-        }
-        positional.push(arg);
-    }
-    return { args, positional };
-}

package/dist/app/parse-variables.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.toVariables = toVariables;
-function toVariables(parsed) {
-    const variables = {};
-    if (parsed.args.mode) {
-        variables.groupingMode = parsed.args.mode;
-    }
-    if (parsed.args.segmentsToIgnore) {
-        if (typeof parsed.args.segmentsToIgnore === "string") {
-            variables.segmentsToIgnore = parsed.args.segmentsToIgnore.split(",");
-        }
-    }
-    if (parsed.args.ignoreVariables) {
-        variables.ignoreVariables =
-            parsed.args.ignoreVariables === "true" ||
-                parsed.args.ignoreVariables === true;
-    }
-    return {
-        groupingMode: variables.groupingMode || "path",
-        segmentsToIgnore: variables.segmentsToIgnore || ["api"],
-        ignoreVariables: variables.ignoreVariables || true,
-    };
-}

package/dist/builders/build-comments.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildComments = buildComments;
-function buildComments(param) {
-    const comments = [];
-    if (param.format !== undefined) {
-        comments.push(`format: ${param.format}`);
-    }
-    if (param.minLength !== undefined) {
-        comments.push(`minLength: ${param.minLength}`);
-    }
-    if (param.maxLength !== undefined) {
-        comments.push(`maxLength: ${param.maxLength}`);
-    }
-    if (param.minimum !== undefined) {
-        comments.push(`minimum: ${param.minimum}`);
-    }
-    if (param.maximum !== undefined) {
-        comments.push(`maximum: ${param.maximum}`);
-    }
-    if (comments.length > 0) {
-        return `  /**\n   * ${comments.join("\n   * ")}\n   */`;
-    }
-    return "";
-}

package/dist/examples/services/get.example.js

@@ -1 +0,0 @@
-"use strict";

package/dist/generators/generate-comments.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateInterfaceComments = generateInterfaceComments;
-exports.generateServiceComments = generateServiceComments;
-function generateInterfaceComments(param) {
-    const comments = [];
-    if (param.format !== undefined) {
-        comments.push(`format: ${param.format}`);
-    }
-    if (param.minLength !== undefined) {
-        comments.push(`minLength: ${param.minLength}`);
-    }
-    if (param.maxLength !== undefined) {
-        comments.push(`maxLength: ${param.maxLength}`);
-    }
-    if (param.minimum !== undefined) {
-        comments.push(`minimum: ${param.minimum}`);
-    }
-    if (param.maximum !== undefined) {
-        comments.push(`maximum: ${param.maximum}`);
-    }
-    if (comments.length > 0) {
-        return `  /**\n   * ${comments.join("\n   * ")}\n   */`;
-    }
-    return "";
-}
-function generateServiceComments(summary, responseType, parameters) {
-    const summarySplited = [];
-    for (let i = 0; i < summary.length; i += 100) {
-        summarySplited.push(summary.slice(i, i + 100));
-    }
-    const comments = summarySplited;
-    if (parameters && parameters.length > 0) {
-        comments.push(`${parameters.map((p) => `\t\t @param ${p.name} : ${p.type}`).join("\n")}`);
-    }
-    if (responseType) {
-        comments.push(`\t\t @returns Observable<${responseType}>`);
-    }
-    return `/**\n${comments.map((c) => `\t\t* ${c}\n`).join("")}\n */`;
-}

package/dist/generators/generate-interface.js

@@ -1,219 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parametersToIProperties = parametersToIProperties;
-exports.propertiesToIProperties = propertiesToIProperties;
-exports.generateInterfaces = generateInterfaces;
-exports.generateWithParameters = generateWithParameters;
-exports.computeParametersName = computeParametersName;
-exports.generateComponentsSchemas = generateComponentsSchemas;
-exports.generateInterfacesFiles = generateInterfacesFiles;
-exports.generateContent = generateContent;
-const interface_data_store_1 = require("../stores/interface-data-store");
-const swagger_store_1 = require("../stores/swagger-store");
-const extends_from_types_1 = require("../templates/types/extends-from-types");
-const generic_types_1 = require("../templates/types/generic-types");
-const build_types_1 = require("../utils/build-types");
-const object_utils_1 = require("../utils/object-utils");
-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_comments_1 = require("./generate-comments");
-function parametersToIProperties(parameters) {
-    const properties = [];
-    for (const param of parameters) {
-        if ((0, type_guard_1.isReference)(param)) {
-            const ref = param.$ref.split("/").pop();
-            properties.push({
-                name: (0, string_utils_1.lowerFirst)(ref),
-                type: ref,
-                optional: false,
-                comments: "",
-            });
-            continue;
-        }
-        if (param.in !== "query")
-            continue;
-        const tsType = (0, build_types_1.switchTypeJson)(param.schema);
-        properties.push({
-            name: (0, string_utils_1.lowerFirst)(param.name),
-            type: tsType,
-            optional: !param.required,
-            comments: (0, generate_comments_1.generateInterfaceComments)(param.schema),
-        });
-    }
-    return properties;
-}
-function propertiesToIProperties(properties) {
-    const interfaceDataProperties = [];
-    for (const [name, property] of Object.entries(properties)) {
-        if ((0, type_guard_1.isReference)(property)) {
-            const ref = property.$ref.split("/").pop();
-            interfaceDataProperties.push({
-                name,
-                type: ref,
-                optional: false,
-                comments: "",
-            });
-            continue;
-        }
-        interfaceDataProperties.push({
-            name,
-            type: (0, build_types_1.switchTypeJson)(property),
-            optional: property.nullable ?? false,
-            comments: (0, generate_comments_1.generateInterfaceComments)(property),
-        });
-    }
-    return interfaceDataProperties;
-}
-function generateInterfaces() {
-    generateComponentsSchemas();
-    generateWithParameters();
-}
-function generateWithParameters() {
-    const paths = swagger_store_1.swaggerStore.getPaths();
-    const groupedPaths = swagger_store_1.swaggerStore.getPathsGroupedByScope();
-    if (!paths || !groupedPaths)
-        return;
-    const interfacesData = [];
-    for (const groupedPath of Object.values(groupedPaths)) {
-        for (const innerPath of groupedPath.paths) {
-            const pathInfo = paths[innerPath];
-            if (!pathInfo)
-                continue;
-            const methods = (0, object_utils_1.removeFalsyValues)({
-                get: pathInfo.get,
-                post: pathInfo.post,
-                put: pathInfo.put,
-                delete: pathInfo.delete,
-                patch: pathInfo.patch,
-            });
-            for (const [httpMethod, pathData] of Object.entries(methods)) {
-                if (!pathData?.parameters)
-                    continue;
-                const parameters = pathData.parameters;
-                const properties = parametersToIProperties(parameters);
-                if (properties.length === 0)
-                    continue;
-                const interfaceName = computeParametersName(httpMethod, innerPath, groupedPath);
-                const interData = {
-                    name: interfaceName,
-                    type: "interface",
-                    imports: properties
-                        .filter((p) => !(0, type_guard_1.isNativeType)(p.type))
-                        .map((p) => p.type),
-                    properties,
-                };
-                const generic = (0, generic_types_1.isGenericType)(interData);
-                if (generic)
-                    continue;
-                const interDataWithExtendsFrom = (0, extends_from_types_1.computeExtendsFromType)(interData);
-                interfacesData.push(interDataWithExtendsFrom);
-            }
-        }
-    }
-    interface_data_store_1.interfaceDataStore.addInterfaces(interfacesData);
-}
-function computeParametersName(method, innerPath, groupedPath) {
-    const dict = {
-        get: "",
-        post: "Create",
-        put: "Update",
-        delete: "Delete",
-        patch: "Patch",
-    };
-    const name = dict[method];
-    const extra = (0, string_utils_1.kebabToPascalCase)((0, path_utils_1.removeVariablesFromPath)((0, path_utils_1.getExtraSegments)(innerPath, (0, path_utils_1.createBaseUrl)(groupedPath.baseSegments)).join("")));
-    return name + groupedPath.groupName + (0, string_utils_1.upFirst)(extra) + "Params";
-}
-function generateComponentsSchemas() {
-    const schemas = swagger_store_1.swaggerStore.getSchemas();
-    if (!schemas)
-        return;
-    const interfaces = [];
-    for (const [key, value] of Object.entries(schemas)) {
-        if ((0, type_guard_1.isReference)(value))
-            continue;
-        if (!value.properties) {
-            if (value.enum) {
-                const interData = {
-                    name: key,
-                    type: "enum",
-                    imports: [],
-                    properties: value.enum.map((e) => {
-                        return {
-                            name: e,
-                            type: e,
-                            optional: false,
-                            comments: "",
-                        };
-                    }),
-                };
-                interfaces.push(interData);
-            }
-            continue;
-        }
-        const properties = propertiesToIProperties(value.properties);
-        const interData = {
-            name: key,
-            type: "interface",
-            imports: properties
-                .filter((p) => !(0, type_guard_1.isNativeType)(p.type))
-                .map((p) => p.type),
-            properties,
-        };
-        const generic = (0, generic_types_1.isGenericType)(interData);
-        if (generic) {
-            continue;
-        }
-        const interDataWithExtendsFrom = (0, extends_from_types_1.computeExtendsFromType)(interData);
-        interfaces.push(interDataWithExtendsFrom);
-    }
-    interface_data_store_1.interfaceDataStore.addInterfaces(interfaces);
-}
-function generateInterfacesFiles(locations) {
-    const interfacesData = [
-        ...generic_types_1.genericTypesData,
-        ...extends_from_types_1.extendsFromTypes,
-        ...Array.from(Object.values(interface_data_store_1.interfaceDataStore.generatedInterfaces)),
-    ];
-    const filesContent = [];
-    for (const [key, value] of Object.entries(interfacesData)) {
-        const location = [
-            value.type === "enum" ? "enums" : "dtos",
-            ...(locations?.[key] ?? []),
-        ];
-        const content = generateContent(value, location.length);
-        const extraName = value.type === "enum" ? "enum" : "dto";
-        filesContent.push({
-            location: location,
-            content,
-            extension: "ts",
-            name: (0, string_utils_1.toKebabCase)(value.name) + `.${extraName}`,
-        });
-    }
-    return filesContent;
-}
-generateContent;
-function generateContent(interfaceData, deep = 0) {
-    const imports = [...interfaceData.imports];
-    const importsTemplate = imports.length > 0
-        ? `import { ${imports.join(", ")} } from "${"../".repeat(deep)}models";`
-        : "";
-    if (interfaceData.type === "interface") {
-        const content = `${importsTemplate}\n\nexport interface ${interfaceData.name} ${interfaceData.extendsFrom && interfaceData.extendsFrom.length > 0 ? `extends ${interfaceData.extendsFrom.join(", ")}` : ""} {
-    ${interfaceData.properties
-            .map((p) => `${p.comments}\n\t${(0, string_utils_1.lowerFirst)(p.name)}${p.optional ? "?" : ""}: ${p.type};`)
-            .join("\n")}
-  }`;
-        return content;
-    }
-    if (interfaceData.type === "enum") {
-        const content = `export enum ${interfaceData.name} {
-    ${interfaceData.properties
-            .map((p) => `${p.comments}\n\t${p.name} = '${p.type}',`)
-            .join("\n")}
-  }`;
-        return content;
-    }
-    return "";
-}