openapi-sync 2.1.2 → 2.1.4

package/dist/Openapi-sync/index.js

@@ -15,7 +15,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const lodash_1 = __importDefault(require("lodash"));
-const helpers_1 = require("./components/helpers");
+const helpers_1 = require("../helpers");
 const lodash_2 = require("lodash");
 const axios_1 = __importDefault(require("axios"));
 const axios_retry_1 = __importDefault(require("axios-retry"));
@@ -65,14 +65,15 @@ const OpenapiSync = (apiUrl, apiName, config, refetchInterval) => __awaiter(void
         : "";
     const getSharedComponentName = (componentName, componentType) => {
         var _a, _b;
+        const defaultName = (0, helpers_1.capitalize)(componentName);
         if ((_b = (_a = config === null || config === void 0 ? void 0 : config.types) === null || _a === void 0 ? void 0 : _a.name) === null || _b === void 0 ? void 0 : _b.format) {
             const formattedName = config === null || config === void 0 ? void 0 : config.types.name.format("shared", {
                 name: componentName,
-            });
+            }, defaultName);
             if (formattedName)
                 return `${typePrefix}${formattedName}`;
         }
-        return `${typePrefix}${(0, helpers_1.capitalize)(componentName)}`;
+        return `${typePrefix}${defaultName}`;
     };
     const parseSchemaToType = (apiDoc, schema, name, isRequired, options, indentLevel = 0) => {
         let overrideName = "";
@@ -552,7 +553,7 @@ const OpenapiSync = (apiUrl, apiName, config, refetchInterval) => __awaiter(void
                             method,
                             path: endpointPath,
                             summary: eSpec === null || eSpec === void 0 ? void 0 : eSpec.summary,
-                        });
+                        }, name);
                         if (formattedName)
                             name = formattedName;
                     }
@@ -573,7 +574,7 @@ const OpenapiSync = (apiUrl, apiName, config, refetchInterval) => __awaiter(void
                             method,
                             path: endpointPath,
                             summary: eSpec === null || eSpec === void 0 ? void 0 : eSpec.summary,
-                        });
+                        }, name);
                         if (formattedName)
                             name = formattedName;
                     }
@@ -599,7 +600,7 @@ const OpenapiSync = (apiUrl, apiName, config, refetchInterval) => __awaiter(void
                                 method,
                                 path: endpointPath,
                                 summary: eSpec === null || eSpec === void 0 ? void 0 : eSpec.summary,
-                            });
+                            }, name);
                             if (formattedName)
                                 name = formattedName;
                         }
@@ -731,7 +732,7 @@ ${(0, curl_generator_1.CurlGenerator)({
                     path: endpointPath,
                     summary: eSpec === null || eSpec === void 0 ? void 0 : eSpec.summary,
                     operationId: eSpec === null || eSpec === void 0 ? void 0 : eSpec.operationId,
-                });
+                }, name);
                 if (formattedName)
                     name = formattedName;
             }

package/dist/helpers.js

@@ -0,0 +1,145 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderTypeRefMD = exports.JSONStringify = exports.getEndpointDetails = exports.capitalize = exports.yamlStringToJson = exports.isYamlString = exports.isJson = void 0;
+exports.getNestedValue = getNestedValue;
+const regex_1 = require("./regex");
+const yaml = __importStar(require("js-yaml"));
+const isJson = (value) => {
+    return ["object"].includes(typeof value) && !(value instanceof Blob);
+};
+exports.isJson = isJson;
+const isYamlString = (fileContent) => {
+    try {
+        yaml.load(fileContent);
+        return true;
+    }
+    catch (en) {
+        const e = en;
+        if (e instanceof yaml.YAMLException) {
+            return false;
+        }
+        else {
+            throw e;
+        }
+    }
+};
+exports.isYamlString = isYamlString;
+const yamlStringToJson = (fileContent) => {
+    if ((0, exports.isYamlString)(fileContent)) {
+        const content = yaml.load(fileContent);
+        const jsonString = JSON.stringify(content, null, 2);
+        const json = JSON.parse(jsonString);
+        return json;
+    }
+};
+exports.yamlStringToJson = yamlStringToJson;
+const capitalize = (text) => {
+    const capitalizedWord = text.substring(0, 1).toUpperCase() + text.substring(1);
+    return capitalizedWord;
+};
+exports.capitalize = capitalize;
+const getEndpointDetails = (path, method) => {
+    const pathParts = path.split("/");
+    let name = `${(0, exports.capitalize)(method)}`;
+    const variables = [];
+    pathParts.forEach((part) => {
+        // check if part is a variable
+        //api/{userId}
+        if (part[0] === "{" && part[part.length - 1] === "}") {
+            const s = part.replace(/{/, "").replace(/}/, "");
+            variables.push(s);
+            part = `$${s}`;
+        }
+        //api/<userId>
+        else if (part[0] === "<" && part[part.length - 1] === ">") {
+            const s = part.replace(/</, "").replace(/>/, "");
+            variables.push(s);
+            part = `$${s}`;
+        }
+        //api/:userId
+        else if (part[0] === ":") {
+            const s = part.replace(/:/, "");
+            variables.push(s);
+            part = `$${s}`;
+        }
+        // parse to variable name
+        let partVal = "";
+        part.split("").forEach((char) => {
+            let c = char;
+            if (!regex_1.variableNameChar.test(char))
+                c = "/";
+            partVal += c;
+        });
+        partVal.split("/").forEach((val) => {
+            name += (0, exports.capitalize)(val);
+        });
+    });
+    return { name, variables, pathParts };
+};
+exports.getEndpointDetails = getEndpointDetails;
+const JSONStringify = (obj, indent = 1) => {
+    let result = "{";
+    const keys = Object.keys(obj);
+    for (let i = 0; i < keys.length; i++) {
+        const key = keys[i];
+        const value = obj[key];
+        result += "\n" + "    ".repeat(indent) + key + ": ";
+        if (typeof value === "object" && value !== null) {
+            result += "" + (0, exports.JSONStringify)(value, indent + 1);
+        }
+        else {
+            result += value
+                .split("\n")
+                .filter((line) => line.trim() !== "")
+                .join(`\n${"    ".repeat(indent)}`);
+        }
+        if (i < keys.length - 1) {
+            result += ", ";
+        }
+    }
+    result += `\n${"    ".repeat(indent - 1)}}`;
+    return result;
+};
+exports.JSONStringify = JSONStringify;
+const renderTypeRefMD = (typeRef, indent = 1) => {
+    return `\n\`\`\`typescript\n${"  ".repeat(indent)}  ${typeRef
+        .split("\n")
+        .filter((line) => line.trim() !== "")
+        .join(`\n${"  ".repeat(indent)}  `)}\n\`\`\``;
+};
+exports.renderTypeRefMD = renderTypeRefMD;
+function getNestedValue(obj, path) {
+    // Split the path string into an array of keys
+    const keys = path.split(".");
+    // Use the reduce method to navigate the object
+    return keys.reduce((currentObj, key) => {
+        // If the current object is not null or undefined,
+        // return the value of the next key. Otherwise, return undefined.
+        return currentObj && currentObj[key] !== undefined
+            ? currentObj[key]
+            : undefined;
+    }, obj);
+}

package/dist/index.js

@@ -16,25 +16,41 @@ exports.Init = void 0;
 const Openapi_sync_1 = __importDefault(require("./Openapi-sync"));
 const dotenv_1 = __importDefault(require("dotenv"));
 const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
 const state_1 = require("./Openapi-sync/state");
 dotenv_1.default.config();
 const rootUsingCwd = process.cwd();
 const Init = (options) => __awaiter(void 0, void 0, void 0, function* () {
     // Load config file
-    let configJS, configJson;
+    let configJS;
+    // Register TypeScript loader before requiring the file
     try {
-        configJS = require(path_1.default.join(rootUsingCwd, "openapi.sync.js"));
+        require("esbuild-register");
     }
-    catch (e) {
-        // console.log(e);
+    catch (registerError) {
+        throw registerError;
     }
+    const jsConfigPath = path_1.default.join(rootUsingCwd, "openapi.sync.");
+    const tsConfigPath = path_1.default.join(rootUsingCwd, "openapi.sync.ts");
+    const jsonConfigPath = path_1.default.join(rootUsingCwd, "openapi.sync.json");
+    const configPaths = [jsConfigPath, tsConfigPath, jsonConfigPath];
     try {
-        configJson = require(path_1.default.join(rootUsingCwd, "openapi.sync.json"));
+        for (const configPath of configPaths) {
+            if (fs_1.default.existsSync(configPath)) {
+                configJS = require(configPath);
+                if (Object.keys(configJS).length === 1 && configJS.default) {
+                    configJS = configJS.default;
+                }
+            }
+        }
     }
     catch (e) {
-        // console.log(e);
+        console.log(e);
+    }
+    const config = configJS;
+    if (!config) {
+        throw new Error("No config found");
     }
-    const config = configJS || configJson;
     const apiNames = Object.keys(config.api);
     const refetchInterval = options &&
         "refetchInterval" in options &&

package/dist/openapi.sync.sample.js

@@ -0,0 +1,60 @@
+"use strict";
+// TypeScript config file for openapi-sync
+// To use this file, install a TypeScript loader:
+// npm install --save-dev esbuild-register  (recommended - fastest & lightest)
+// or: npm install --save-dev tsx
+// or: npm install --save-dev @swc/register
+Object.defineProperty(exports, "__esModule", { value: true });
+const config = {
+    refetchInterval: 5000,
+    folder: "/inputed/path/",
+    api: {
+        example1: "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json",
+        example2: "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.yaml",
+    },
+    server: 0,
+    types: {
+        name: {
+            prefix: "",
+            format: (source, data) => {
+                if (source === "shared") {
+                    return `${data.name}`;
+                }
+                else if (source === "endpoint") {
+                    return `${data.method.toLowerCase()}${data
+                        .path.replace(/\//g, "_")
+                        .replace(/{|}/g, "")}${data.code}${data.type}`;
+                }
+            },
+        },
+        doc: {
+            disable: true,
+        },
+    },
+    endpoints: {
+        value: {
+            replaceWords: [
+                {
+                    replace: "/api/v\\d/",
+                    with: "",
+                },
+            ],
+            includeServer: true,
+            type: "object",
+        },
+        name: {
+            prefix: "",
+            useOperationId: true,
+            format: ({ method, path, summary, operationId }) => {
+                if (path === "/")
+                    return "root";
+                return path.replace(/\//g, "_").replace(/{|}/g, "");
+            },
+        },
+        doc: {
+            disable: false,
+            showCurl: true,
+        },
+    },
+};
+module.exports = config;

package/dist/regex.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.variableNameChar = exports.variableName = void 0;
+exports.variableName = /^[A-Za-z_$][A-Za-z0-9_$]*$/;
+exports.variableNameChar = /[A-Za-z0-9_$]/;

package/helpers.ts

@@ -0,0 +1,128 @@
+import { variableNameChar } from "./regex";
+import * as yaml from "js-yaml";
+
+export const isJson = (value: any) => {
+  return ["object"].includes(typeof value) && !(value instanceof Blob);
+};
+
+export const isYamlString = (fileContent: string) => {
+  try {
+    yaml.load(fileContent);
+    return true;
+  } catch (en) {
+    const e = en as any;
+    if (e instanceof yaml.YAMLException) {
+      return false;
+    } else {
+      throw e;
+    }
+  }
+};
+
+export const yamlStringToJson = (fileContent: string) => {
+  if (isYamlString(fileContent)) {
+    const content = yaml.load(fileContent);
+
+    const jsonString = JSON.stringify(content, null, 2);
+    const json = JSON.parse(jsonString);
+    return json;
+  }
+};
+
+export const capitalize = (text: string) => {
+  const capitalizedWord =
+    text.substring(0, 1).toUpperCase() + text.substring(1);
+  return capitalizedWord;
+};
+
+export const getEndpointDetails = (path: string, method: string) => {
+  const pathParts = path.split("/");
+  let name = `${capitalize(method)}`;
+  const variables: string[] = [];
+  pathParts.forEach((part) => {
+    // check if part is a variable
+    //api/{userId}
+    if (part[0] === "{" && part[part.length - 1] === "}") {
+      const s = part.replace(/{/, "").replace(/}/, "");
+      variables.push(s);
+      part = `$${s}`;
+    }
+
+    //api/<userId>
+    else if (part[0] === "<" && part[part.length - 1] === ">") {
+      const s = part.replace(/</, "").replace(/>/, "");
+      variables.push(s);
+      part = `$${s}`;
+    }
+
+    //api/:userId
+    else if (part[0] === ":") {
+      const s = part.replace(/:/, "");
+      variables.push(s);
+      part = `$${s}`;
+    }
+
+    // parse to variable name
+    let partVal = "";
+    part.split("").forEach((char) => {
+      let c = char;
+      if (!variableNameChar.test(char)) c = "/";
+      partVal += c;
+    });
+
+    partVal.split("/").forEach((val) => {
+      name += capitalize(val);
+    });
+  });
+
+  return { name, variables, pathParts };
+};
+
+export const JSONStringify = (obj: Record<string, any>, indent = 1) => {
+  let result = "{";
+  const keys = Object.keys(obj);
+
+  for (let i = 0; i < keys.length; i++) {
+    const key = keys[i];
+    const value = obj[key];
+
+    result += "\n" + "    ".repeat(indent) + key + ": ";
+
+    if (typeof value === "object" && value !== null) {
+      result += "" + JSONStringify(value, indent + 1);
+    } else {
+      result += value
+        .split("\n")
+        .filter((line: string) => line.trim() !== "")
+        .join(`\n${"    ".repeat(indent)}`);
+    }
+
+    if (i < keys.length - 1) {
+      result += ", ";
+    }
+  }
+
+  result += `\n${"    ".repeat(indent - 1)}}`;
+  return result;
+};
+
+export const renderTypeRefMD = (typeRef: string, indent = 1) => {
+  return `\n\`\`\`typescript\n${"  ".repeat(indent)}  ${typeRef
+    .split("\n")
+    .filter((line) => line.trim() !== "")
+    .join(`\n${"  ".repeat(indent)}  `)}\n\`\`\``;
+};
+
+export function getNestedValue<T>(obj: object, path: string): T | undefined {
+  // Split the path string into an array of keys
+  const keys = path.split(".");
+
+  // Use the reduce method to navigate the object
+  return keys.reduce((currentObj: any, key: string) => {
+    // If the current object is not null or undefined,
+    // return the value of the next key. Otherwise, return undefined.
+    return currentObj && currentObj[key] !== undefined
+      ? currentObj[key]
+      : undefined;
+  }, obj) as T | undefined;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-sync",
-  "version": "2.1.2",
+  "version": "2.1.4",
   "description": "A developer-friendly tool designed to keep your API up-to-date by leveraging OpenAPI schemas. It automates the generation of endpoint URIs and type definitions, including shared types, directly from your OpenAPI specification.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -25,6 +25,8 @@
     "dist",
     "db.json",
     "types.ts",
+    "helpers.ts",
+    "regex.ts",
     "LICENSE",
     "README.md",
     "package.json"
@@ -47,6 +49,7 @@
     "@redocly/openapi-core": "^1.19.0",
     "axios": "^1.7.3",
     "axios-retry": "^4.5.0",
+    "esbuild-register": "^3.6.0",
     "curl-generator": "^0.4.2",
     "dotenv": "^16.4.5",
     "js-yaml": "^4.1.0",

package/regex.ts

@@ -0,0 +1,2 @@
+export const variableName = /^[A-Za-z_$][A-Za-z0-9_$]*$/;
+export const variableNameChar = /[A-Za-z0-9_$]/;

package/types.ts

@@ -89,7 +89,8 @@ export type IConfig = {
           method?: Method;
           path?: string;
           summary?: string;
-        }
+        },
+        defaultName: string
       ) => string | null | undefined;
     };
     doc?: IConfigDoc;
@@ -101,12 +102,15 @@ export type IConfig = {
       type?: "string" | "object";
     };
     name?: {
-      format?: (data: {
-        method: Method;
-        path: string;
-        summary: string;
-        operationId: string;
-      }) => string | null;
+      format?: (
+        data: {
+          method: Method;
+          path: string;
+          summary: string;
+          operationId: string;
+        },
+        defaultName: string
+      ) => string | null;
       prefix?: string;
       useOperationId?: boolean;
     };