openapi-sync 1.0.8 → 1.0.9

package/README.md

@@ -1,11 +1,37 @@
-## Install Openapi-sync
+# Openapi-sync
 
-`npm i 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).
 
-## Add a Openapi-sync config file
+## Installation
 
-Add a `openapi.sync.json` file at the root of your project (check out `openapi.sync.sample.json`)
+To install `openapi-sync`, run the following command:
 
-## Run `openapi-sync`
+```bash
+npm install openapi-sync
+```
 
-Run `openapi-sync` in terminal to start (you can also add it as a script in package.json)
+## 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.
+
+## Usage
+
+To start using openapi-sync, simply run the following command in your terminal:
+
+```bash
+npx openapi-sync
+```
+
+You can also add it as a script in your package.json for easy access:
+
+```bash
+"scripts": {
+  "api-sync": "openapi-sync",
+}
+```
+
+## 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.

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

@@ -28,8 +28,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseSchemaToType = exports.getEndpointDetails = exports.getSharedComponentName = exports.capitalize = exports.yamlStringToJson = exports.isYamlString = exports.isJson = void 0;
 const regex_1 = require("./regex");
-const property_expr_1 = __importDefault(require("property-expr"));
 const yaml = __importStar(require("js-yaml"));
+const lodash_1 = __importDefault(require("lodash"));
 const isJson = (value) => {
     return ["object"].includes(typeof value) && !(value instanceof Blob);
 };
@@ -100,7 +100,7 @@ const parseSchemaToType = (apiDoc, schema, name, isRequired, options) => {
             let pathToComponentParts = (schema.$ref || "").split("/");
             pathToComponentParts.shift();
             const pathToComponent = pathToComponentParts.join(".");
-            const component = property_expr_1.default.getter(pathToComponent)(apiDoc);
+            const component = lodash_1.default.get(apiDoc, pathToComponent, null);
             if (component) {
                 const componentName = pathToComponentParts[pathToComponentParts.length - 1];
                 // Reference component via import instead of parsing

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-sync",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "sync openapi variables",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,24 +17,24 @@
   "scripts": {
     "test": "echo \"Error: no test specified\"",
     "build": "tsc",
-    "publish": "npm run build  npm version patch  npm publish",
+    "publish-package": "npm run build && npm version patch &&  npm publish",
     "start": "ts-node index.ts"
   },
   "author": "P-Technologies",
   "license": "ISC",
-  "devDependencies": {},
-  "dependencies": {
+  "devDependencies": {
     "@types/js-yaml": "^4.0.9",
     "@types/lodash": "^4.17.7",
     "@types/node": "^22.1.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.5.4",
+    "typescript": "^5.5.4"
+  },
+  "dependencies": {
     "@redocly/openapi-core": "^1.19.0",
     "axios": "^1.7.3",
     "axios-retry": "^4.5.0",
     "dotenv": "^16.4.5",
     "js-yaml": "^4.1.0",
-    "lodash": "^4.17.21",
-    "property-expr": "^2.0.6"
+    "lodash": "^4.17.21"
   }
 }