openapi-sync 1.0.25 → 2.0.1

package/dist/index.js

@@ -21,7 +21,20 @@ dotenv_1.default.config();
 const rootUsingCwd = process.cwd();
 const Init = (options) => __awaiter(void 0, void 0, void 0, function* () {
     // Load config file
-    const config = require(path_1.default.join(rootUsingCwd, "openapi.sync.json"));
+    let configJS, configJson;
+    try {
+        configJS = require(path_1.default.join(rootUsingCwd, "openapi.sync.js"));
+    }
+    catch (e) {
+        // console.log(e);
+    }
+    try {
+        configJson = require(path_1.default.join(rootUsingCwd, "openapi.sync.json"));
+    }
+    catch (e) {
+        // console.log(e);
+    }
+    const config = configJS || configJson;
     const apiNames = Object.keys(config.api);
     const refetchInterval = options &&
         "refetchInterval" in options &&
@@ -32,7 +45,7 @@ const Init = (options) => __awaiter(void 0, void 0, void 0, function* () {
     for (let i = 0; i < apiNames.length; i += 1) {
         const apiName = apiNames[i];
         const apiUrl = config.api[apiName];
-        (0, Openapi_sync_1.default)(apiUrl, apiName, refetchInterval);
+        (0, Openapi_sync_1.default)(apiUrl, apiName, config, refetchInterval);
     }
 });
 exports.Init = Init;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-sync",
-  "version": "1.0.25",
+  "version": "2.0.1",
   "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",
@@ -24,6 +24,7 @@
     "bin",
     "dist",
     "db.json",
+    "types.ts",
     "LICENSE",
     "README.md",
     "package.json"
@@ -46,6 +47,7 @@
     "@redocly/openapi-core": "^1.19.0",
     "axios": "^1.7.3",
     "axios-retry": "^4.5.0",
+    "curl-generator": "^0.4.2",
     "dotenv": "^16.4.5",
     "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",

package/types.ts

@@ -0,0 +1,124 @@
+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";
+  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;
+  types?: {
+    name?: {
+      prefix?: string;
+      format?: (
+        source: "shared" | "endpoint",
+        data: {
+          name?: string;
+          ////. endpoint source //////
+          type?: "response" | "dto" | "query";
+          code?: string;
+          method?: Method;
+          path?: string;
+          summary?: string;
+        }
+      ) => string | null | undefined;
+    };
+    doc: IConfigDoc;
+  };
+  endpoints?: {
+    value?: {
+      replaceWords?: IConfigReplaceWord[];
+      includeServer?: boolean;
+    };
+    name?: {
+      format?: (data: {
+        method: Method;
+        path: string;
+        summary: string;
+      }) => string | null;
+      prefix?: string;
+    };
+    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;
+  };
+};