npm - swaggerjsontoapidocs - Versions diffs - 1.1.0 - Mend

swaggerjsontoapidocs 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/dist/index.js ADDED Viewed

@@ -0,0 +1,86 @@
+#!/usr/bin/env 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;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = require("fs");
+const chalk_1 = __importDefault(require("chalk"));
+const readline = __importStar(require("node:readline/promises"));
+const node_path_1 = __importDefault(require("node:path"));
+const jsonToApiDocs_1 = require("./jsonToApiDocs");
+async function main() {
+    console.log(chalk_1.default.green("To configure the script correctly, you must ensure that BE is running and you can view the Swagger page.".toUpperCase()));
+    console.log(chalk_1.default.red("Have the PATH of the swagger.json and the BASEPATH which will determine how the endpoints will be returned."));
+    await promptConfigFile();
+    (0, jsonToApiDocs_1.initScript)();
+}
+async function promptConfigFile() {
+    return new Promise((resolve) => {
+        (async () => {
+            const rl = readline.createInterface({
+                input: process.stdin,
+                output: process.stdout,
+            });
+            let pathInputValid = true;
+            let basepathInputValid = true;
+            let pathInput = "";
+            let basepathInput = "";
+            while (pathInputValid) {
+                pathInput = await rl.question("Copy the correct path to download the swagger.json file, e.g.: http://localhost:5033/swagger/v1/swagger.json: ");
+                if (pathInput.trim().length > 0) {
+                    pathInputValid = false;
+                }
+            }
+            while (basepathInputValid) {
+                basepathInput = await rl.question("Enter the basepath, e.g.: /api/ to deleted of path /api/Users/{id} => return export const Users_id = (id: any) => `Users/${id}`:");
+                if (basepathInput.trim().length > 0) {
+                    basepathInputValid = false;
+                }
+            }
+            rl.close();
+            (0, fs_1.writeFile)(node_path_1.default.join(__dirname, "config.json"), `{"BASEPATH": "${basepathInput.trim()}","PATH": "${pathInput.trim()}"}`, "utf8", async (err) => {
+                if (err) {
+                    console.error(err);
+                }
+                else {
+                    resolve();
+                }
+            });
+        })();
+    });
+}
+main();

package/dist/jsonToApiDocs.js ADDED Viewed

@@ -0,0 +1,156 @@
+"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;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initScript = initScript;
+const fs_1 = require("fs");
+const promises_1 = require("fs/promises");
+const path = __importStar(require("path"));
+const chalk_1 = __importDefault(require("chalk"));
+const prettier_1 = require("prettier");
+const mainFolderOutPut = path.join(__dirname, "api_docs");
+let urlSwaggerJson = "";
+let basepath = "";
+async function cleanFolderOutPut() {
+    await (0, promises_1.rm)(mainFolderOutPut, {
+        recursive: true,
+        force: true,
+    });
+}
+async function initScript() {
+    await cleanFolderOutPut();
+    const raw = await (0, promises_1.readFile)(path.join(__dirname, "config.json"), "utf8");
+    const config = await JSON.parse(raw);
+    urlSwaggerJson = config.PATH;
+    basepath = config.BASEPATH;
+    try {
+        const response = await fetch(urlSwaggerJson);
+        const data = await response.json();
+        (0, fs_1.writeFile)(path.join(__dirname, "paths.json"), `${JSON.stringify(data, null, 2)}`, "utf8", async (err) => {
+            if (err) {
+                console.error(err);
+            }
+            else {
+                await filterPathsObject();
+            }
+        });
+    }
+    catch (error) {
+        if (error instanceof Error && error.message.includes("ECONNREFUSED")) {
+            console.log(chalk_1.default.bgRed.white(" ERROR ") +
+                chalk_1.default.red("Could not connect: The server is off or the URL is incorrect."));
+        }
+        else {
+            console.log(chalk_1.default.red(`✘ unknown error: ${error}`));
+        }
+        await cleanFileAndConfig();
+        return null;
+    }
+}
+async function filterPathsObject() {
+    const raw = await (0, promises_1.readFile)(path.join(__dirname, "paths.json"), "utf8");
+    const pathsObj = await JSON.parse(raw);
+    const endpoints = Object.keys(pathsObj.paths).map((endpoint) => endpoint.split(basepath)[1]);
+    const foldersName = endpoints.map((endpoint) => endpoint.split("/")[0]);
+    await makeFolders(foldersName);
+    await makeFileContainer(endpoints, foldersName);
+    await cleanFileAndConfig();
+}
+async function cleanFileAndConfig() {
+    await cleanFile();
+    await cleanConfig();
+    console.log("🧹 Cleaned.");
+}
+async function cleanFile() {
+    await (0, promises_1.rm)(path.join(__dirname, "paths.json"), { force: true });
+}
+async function cleanConfig() {
+    await (0, promises_1.rm)(path.join(__dirname, "config.json"), { force: true });
+}
+async function makeFolders(foldersName) {
+    await (0, promises_1.mkdir)(mainFolderOutPut, { recursive: true });
+    for (const folder of [...new Set(foldersName)]) {
+        const folderPath = path.join(mainFolderOutPut, folder);
+        await (0, promises_1.mkdir)(folderPath, { recursive: true });
+    }
+}
+async function makeFileContainer(endpoints, foldersName) {
+    for (const folder of [...new Set(foldersName)]) {
+        await (0, promises_1.appendFile)(`${mainFolderOutPut}/${folder}/${folder}.ts`, "");
+    }
+    for (const [index, folder] of foldersName.entries()) {
+        const endpoint = endpoints[index];
+        const filePath = `${mainFolderOutPut}/${folder}/${folder}.ts`;
+        const paramsMatch = endpoint.match(/\{([^}]+)\}/g);
+        const args = paramsMatch
+            ? paramsMatch.map((p) => p.replace(/[{}]/g, "").concat(":any")).join(", ")
+            : "";
+        let jsDoc = "";
+        if (paramsMatch?.length) {
+            const paramsDoc = paramsMatch
+                .map((p) => ` * @param ${p.replace(/[{}]/g, "")}`)
+                .join("\n");
+            jsDoc = `/**\n${paramsDoc}\n */\n`;
+        }
+        const name = endpoint
+            .replace(/[/|{}]/g, "_")
+            .replace(/_+/g, "_")
+            .replace(/^_|_$/g, "");
+        const templatePath = endpoint.replace(/\{/g, "${");
+        const line = `${jsDoc} export const ${name} = (${args}) => \`${templatePath}\`;\n`;
+        try {
+            await (0, promises_1.appendFile)(filePath, line);
+            await formatWhitPrettier(filePath);
+            console.log(`✅ Generated: ${name}`);
+        }
+        catch (error) {
+            console.error(`❌ Error occurred while writing to ${filePath}:`, error);
+        }
+    }
+    console.log(`💾 show result ---> ${mainFolderOutPut}`);
+}
+async function formatWhitPrettier(filePath) {
+    const content = await (0, promises_1.readFile)(filePath, "utf8");
+    const formatted = await (0, prettier_1.format)(content, {
+        parser: "typescript",
+        filepath: filePath,
+        semi: true,
+        singleQuote: true,
+        trailingComma: "all",
+    });
+    (0, fs_1.writeFile)(filePath, formatted, () => { });
+}

package/package.json ADDED Viewed

@@ -0,0 +1,38 @@
+{
+  "name": "swaggerjsontoapidocs",
+  "version": "1.1.0",
+  "description": "script to convert swagger json to api docs, this help us to consume functions and center all endpoints in one place",
+  "main": "index.ts",
+  "scripts": {
+    "build": "tsc",
+    "api": "ts-node ./src/",
+    "dist": "node ./dist/",
+    "lint": "eslint ."
+  },
+  "author": "Esteban Fernandez",
+  "license": "ISC",
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "prettier": "^3.7.4"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.2",
+    "@types/prettier": "^2.7.3",
+    "eslint": "^9.39.2",
+    "globals": "^17.0.0",
+    "jiti": "^2.6.1",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.52.0",
+    "ts-node": "^10.9.2"
+  },
+  "files": [
+    "dist",
+    "package.json"
+  ],
+  "engines": {
+    "node": ">=15.0.0"
+  },
+  "bin": {
+    "swaggerjsontoapidocs": "dist/index.js"
+  }
+}