openapi-sync 2.1.4 → 2.1.5

package/dist/Openapi-sync/index.d.ts

@@ -0,0 +1,3 @@
+import { IConfig } from "../types";
+declare const OpenapiSync: (apiUrl: string, apiName: string, config: IConfig, refetchInterval?: number) => Promise<void>;
+export default OpenapiSync;

package/dist/Openapi-sync/state.d.ts

@@ -0,0 +1,4 @@
+import { IOpenApiSpec } from "../types";
+export declare const setState: (key: string, value: IOpenApiSpec) => void;
+export declare const getState: (key: string) => IOpenApiSpec | undefined;
+export declare const resetState: () => void;

package/dist/helpers.d.ts

@@ -0,0 +1,12 @@
+export declare const isJson: (value: any) => boolean;
+export declare const isYamlString: (fileContent: string) => boolean;
+export declare const yamlStringToJson: (fileContent: string) => any;
+export declare const capitalize: (text: string) => string;
+export declare const getEndpointDetails: (path: string, method: string) => {
+    name: string;
+    variables: string[];
+    pathParts: string[];
+};
+export declare const JSONStringify: (obj: Record<string, any>, indent?: number) => string;
+export declare const renderTypeRefMD: (typeRef: string, indent?: number) => string;
+export declare function getNestedValue<T>(obj: object, path: string): T | undefined;

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./types";
+export * from "./helpers";
+export * from "./regex";
+export declare const Init: (options?: {
+    refetchInterval?: number;
+}) => Promise<void>;

package/dist/index.js

@@ -1,4 +1,18 @@
 "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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -18,6 +32,10 @@ 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");
+// Re-export modules for user consumption
+__exportStar(require("./types"), exports);
+__exportStar(require("./helpers"), exports);
+__exportStar(require("./regex"), exports);
 dotenv_1.default.config();
 const rootUsingCwd = process.cwd();
 const Init = (options) => __awaiter(void 0, void 0, void 0, function* () {

package/dist/openapi.sync.sample.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/openapi.sync.sample.js

@@ -1,9 +1,4 @@
 "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,
@@ -16,7 +11,7 @@ const config = {
     types: {
         name: {
             prefix: "",
-            format: (source, data) => {
+            format: (source, data, defaultName) => {
                 if (source === "shared") {
                     return `${data.name}`;
                 }
@@ -45,7 +40,7 @@ const config = {
         name: {
             prefix: "",
             useOperationId: true,
-            format: ({ method, path, summary, operationId }) => {
+            format: ({ method, path, summary, operationId }, defaultName) => {
                 if (path === "/")
                     return "root";
                 return path.replace(/\//g, "_").replace(/{|}/g, "");

package/dist/regex.d.ts

@@ -0,0 +1,2 @@
+export declare const variableName: RegExp;
+export declare const variableNameChar: RegExp;

package/dist/types.d.ts

@@ -0,0 +1,113 @@
+import { Method } from "axios";
+export type IOpenApiSpec = Record<"openapi", string> & Record<string, any>;
+export type IOpenApSchemaSpec = {
+    nullable?: boolean;
+    type: "string" | "integer" | "number" | "array" | "object" | "boolean" | "null" | any[];
+    example?: any;
+    enum?: string[];
+    format?: string;
+    items?: IOpenApSchemaSpec;
+    required?: string[];
+    description?: string;
+    $ref?: string;
+    properties?: Record<string, IOpenApSchemaSpec>;
+    additionalProperties?: IOpenApSchemaSpec;
+    anyOf?: IOpenApSchemaSpec[];
+    oneOf?: IOpenApSchemaSpec[];
+    allOf?: IOpenApSchemaSpec[];
+};
+export type IOpenApiParameterSpec = {
+    $ref?: string;
+    name: string;
+    in: string;
+    enum?: string[];
+    description?: string;
+    required?: boolean;
+    deprecated?: boolean;
+    allowEmptyValue?: boolean;
+    style?: string;
+    explode?: boolean;
+    allowReserved?: boolean;
+    schema?: IOpenApSchemaSpec;
+    example?: any;
+    examples?: any[];
+};
+export type IOpenApiMediaTypeSpec = {
+    schema?: IOpenApSchemaSpec;
+    example?: any;
+    examples?: any[];
+    encoding?: any;
+};
+export type IOpenApiRequestBodySpec = {
+    description?: string;
+    required?: boolean;
+    content: Record<string, IOpenApiMediaTypeSpec>;
+};
+export type IOpenApiResponseSpec = Record<string, IOpenApiRequestBodySpec>;
+export type IConfigReplaceWord = {
+    /**  string and regular expression as a string*/
+    replace: string;
+    with: string;
+    type?: "endpoint" | "type";
+};
+export type IConfigDoc = {
+    disable?: boolean;
+    showCurl?: boolean;
+};
+export type IConfig = {
+    refetchInterval?: number;
+    folder?: string;
+    api: Record<string, string>;
+    server?: number | string;
+    types?: {
+        name?: {
+            prefix?: string;
+            format?: (source: "shared" | "endpoint", data: {
+                name?: string;
+                type?: "response" | "dto" | "query";
+                code?: string;
+                method?: Method;
+                path?: string;
+                summary?: string;
+            }, defaultName: string) => string | null | undefined;
+        };
+        doc?: IConfigDoc;
+    };
+    endpoints?: {
+        value?: {
+            replaceWords?: IConfigReplaceWord[];
+            includeServer?: boolean;
+            type?: "string" | "object";
+        };
+        name?: {
+            format?: (data: {
+                method: Method;
+                path: string;
+                summary: string;
+                operationId: string;
+            }, defaultName: string) => string | null;
+            prefix?: string;
+            useOperationId?: boolean;
+        };
+        doc?: IConfigDoc;
+    };
+};
+export type IOpenApiSecuritySchemes = {
+    [key: string]: {
+        type: "http" | "apiKey" | "oauth2" | "openIdConnect" | "mutualTLS";
+        scheme?: "bearer" | "basic";
+        in?: "query" | "header" | "cookie";
+        flows?: {
+            authorizationCode: {
+                authorizationUrl: "https://example.com/auth";
+                tokenUrl: "https://example.com/token";
+                scopes: {
+                    "read:data": "Grants read access";
+                };
+            };
+        };
+        bearerFormat?: "JWT";
+        openIdConnectUrl?: string;
+        name?: string;
+    };
+};

package/package.json

@@ -1,9 +1,31 @@
 {
   "name": "openapi-sync",
-  "version": "2.1.4",
+  "version": "2.1.5",
   "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",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.js"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "require": "./dist/types.js",
+      "import": "./dist/types.js"
+    },
+    "./helpers": {
+      "types": "./dist/helpers.d.ts",
+      "require": "./dist/helpers.js",
+      "import": "./dist/helpers.js"
+    },
+    "./regex": {
+      "types": "./dist/regex.d.ts",
+      "require": "./dist/regex.js",
+      "import": "./dist/regex.js"
+    }
+  },
   "bin": {
     "openapi-sync": "./bin/cli.js"
   },
@@ -24,9 +46,6 @@
     "bin",
     "dist",
     "db.json",
-    "types.ts",
-    "helpers.ts",
-    "regex.ts",
     "LICENSE",
     "README.md",
     "package.json"

package/dist/Openapi-sync/components/helpers.js

@@ -1,145 +0,0 @@
-"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/Openapi-sync/components/regex.js

@@ -1,5 +0,0 @@
-"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_$]/;