openapi-sync 1.0.14 → 1.0.17

package/README.md

@@ -1,6 +1,6 @@
 # Openapi-sync
 
-**Openapi-sync** leverages the power of OpenAPI schemas, just like Swagger UI, Postman, Redoc, and other popular tools. This package automates the creation of endpoint URIs and all defined types (including shared types) in a simple and developer-friendly manner and ensures your API remains up-to-date by checking for updates at intervals or right before committing your code (pre-commit).
+**Openapi-sync** is 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. Whether you need real-time synchronization before commits or periodic updates, openapi-sync ensures your API structure is always current and consistent. With an easy-to-use CLI, this tool integrates seamlessly into your development workflow, making API maintenance simpler and more reliable.
 
 ## Installation
 
@@ -12,7 +12,7 @@ npm install openapi-sync
 
 ## Configuration
 
-Create an `openapi.sync.json` file at the root of your project to configure openapi-sync. You can use the provided `openapi.sync.sample.json` as a reference.
+Create an `openapi.sync.json` file at the root of your project to configure openapi-sync. You can use the provided [`openapi.sync.sample.json`](https://github.com/akintomiwa-fisayo/openapi-sync/blob/master/openapi.sync.sample.json) as reference.
 
 ## Usage
 
@@ -32,6 +32,6 @@ You can also add it as a script in your package.json for easy access:
 
 ## Features
 
-- Endpoint URI Generation: Automatically generate endpoint URIs from your OpenAPI schema.
-- Types Generation: Generate all defined types, including shared types, from your OpenAPI schema.
-- CLI Commands: Use the command-line interface to regenerate files at any time—on app start, pre-commit, or whenever needed.
+- Automated Endpoint URI Generation: Effortlessly generate endpoint URIs from your OpenAPI schema.
+- Type Generation: Automatically create all types defined in your API schema, including shared types, for better code consistency.
+- Flexible CLI Commands: Sync your API at any point in the development process on app start, pre-commit, or via manual triggers.

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

@@ -95,66 +95,68 @@ exports.getEndpointDetails = getEndpointDetails;
 const parseSchemaToType = (apiDoc, schema, name, isRequired, options) => {
     let typeName = name ? `\t${name}${isRequired ? "" : "?"}: ` : "";
     let type = "";
-    if (schema.$ref) {
-        if (schema.$ref[0] === "#") {
-            let pathToComponentParts = (schema.$ref || "").split("/");
-            pathToComponentParts.shift();
-            const pathToComponent = pathToComponentParts.join(".");
-            const component = lodash_1.default.get(apiDoc, pathToComponent, null);
-            if (component) {
-                const componentName = pathToComponentParts[pathToComponentParts.length - 1];
-                // Reference component via import instead of parsing
-                type += `${(options === null || options === void 0 ? void 0 : options.noSharedImport) ? "" : "Shared."}${(0, exports.getSharedComponentName)(componentName)}`;
-                // type += `${parseSchemaToType(apiDoc, component, "", isRequired)}`;
+    if (schema) {
+        if (schema.$ref) {
+            if (schema.$ref[0] === "#") {
+                let pathToComponentParts = (schema.$ref || "").split("/");
+                pathToComponentParts.shift();
+                const pathToComponent = pathToComponentParts.join(".");
+                const component = lodash_1.default.get(apiDoc, pathToComponent, null);
+                if (component) {
+                    const componentName = pathToComponentParts[pathToComponentParts.length - 1];
+                    // Reference component via import instead of parsing
+                    type += `${(options === null || options === void 0 ? void 0 : options.noSharedImport) ? "" : "Shared."}${(0, exports.getSharedComponentName)(componentName)}`;
+                    // type += `${parseSchemaToType(apiDoc, component, "", isRequired)}`;
+                }
             }
-        }
-        else {
-            type += "";
-            //TODO $ref is a uri - use axios to fetch doc
-        }
-    }
-    else if (schema.type) {
-        if (schema.enum && schema.enum.length > 0) {
-            if (schema.enum.length > 1)
-                type += "(";
-            type += schema.enum
-                .map((v) => `"${v}"`)
-                .join("|")
-                .toString();
-            if (schema.enum.length > 1)
-                type += ")";
-        }
-        else if (["string", "integer", "number", "array"].includes(schema.type)) {
-            if (schema.type === "string") {
-                type += `string`;
+            else {
+                type += "";
+                //TODO $ref is a uri - use axios to fetch doc
             }
-            else if (["integer", "number"].includes(schema.type)) {
-                type += `number`;
+        }
+        else if (schema.type) {
+            if (schema.enum && schema.enum.length > 0) {
+                if (schema.enum.length > 1)
+                    type += "(";
+                type += schema.enum
+                    .map((v) => `"${v}"`)
+                    .join("|")
+                    .toString();
+                if (schema.enum.length > 1)
+                    type += ")";
             }
-            else if (schema.type === "array") {
-                if (schema.items) {
-                    type += `${(0, exports.parseSchemaToType)(apiDoc, schema.items, "", false, options)}[]`;
+            else if (["string", "integer", "number", "array"].includes(schema.type)) {
+                if (schema.type === "string") {
+                    type += `string`;
                 }
-                else {
-                    type += "any[]";
+                else if (["integer", "number"].includes(schema.type)) {
+                    type += `number`;
                 }
-            }
-        }
-        else if (schema.type === "object") {
-            if (schema.properties) {
-                //parse object key one at a time
-                const objKeys = Object.keys(schema.properties);
-                const requiredKeys = schema.required || [];
-                let typeCnt = "";
-                objKeys.forEach((key) => {
-                    var _a;
-                    typeCnt += `${(0, exports.parseSchemaToType)(apiDoc, (_a = schema.properties) === null || _a === void 0 ? void 0 : _a[key], key, requiredKeys.includes(key), options)}`;
-                });
-                if (typeCnt.length > 0) {
-                    type += `{\n${typeCnt}}`;
+                else if (schema.type === "array") {
+                    if (schema.items) {
+                        type += `${(0, exports.parseSchemaToType)(apiDoc, schema.items, "", false, options)}[]`;
+                    }
+                    else {
+                        type += "any[]";
+                    }
                 }
-                else {
-                    type += "object";
+            }
+            else if (schema.type === "object") {
+                if (schema.properties) {
+                    //parse object key one at a time
+                    const objKeys = Object.keys(schema.properties);
+                    const requiredKeys = schema.required || [];
+                    let typeCnt = "";
+                    objKeys.forEach((key) => {
+                        var _a;
+                        typeCnt += `${(0, exports.parseSchemaToType)(apiDoc, (_a = schema.properties) === null || _a === void 0 ? void 0 : _a[key], key, requiredKeys.includes(key), options)}`;
+                    });
+                    if (typeCnt.length > 0) {
+                        type += `{\n${typeCnt}}`;
+                    }
+                    else {
+                        type += "object";
+                    }
                 }
             }
         }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "openapi-sync",
-  "version": "1.0.14",
-  "description": "sync openapi variables",
+  "version": "1.0.17",
+  "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",
   "bin": {