sftpgo-api-client - npm Package Compare versions

Comparing version 0.0.5 to 0.0.6

dist/sftpgo-api-client/package.json

@@ -10,3 +10,3 @@ {
   },
-  "version": "0.0.3",
+  "version": "0.0.6",
   "license": "MIT",
@@ -16,3 +16,5 @@ "scripts": {
     "load": "typegen https://raw.githubusercontent.com/drakkan/sftpgo/main/openapi/openapi.yaml > src/lib/client.d.ts",
-    "example:run": "nx build --skip-nx-cache && node dist/sftpgo-api-client/src/example/index.js",
+    "example:start": "ts-node example/index.ts",
+    "prepublish": "nx build --skip-nx-cache",
+    "publish": "npm publish --access public",
     "test": "nx test"
@@ -43,2 +45,3 @@ },
     "prettier": "^2.6.2",
+    "ts-node": "^10.9.2",
     "typescript": "~5.2.2",
@@ -50,3 +53,10 @@ "vite": "^5.0.0",
   "main": "./src/index.js",
-  "typings": "dist/sftpgo-api-client/src/index.d.ts"
+  "typings": "dist/sftpgo-api-client/src/index.d.ts",
+  "keywords": [
+    "axios",
+    "client",
+    "openapi",
+    "sftpgo",
+    "typescript"
+  ]
 }

dist/sftpgo-api-client/README.md

 # sftpgo-api-client
 
-This library was generated with [Nx](https://nx.dev).
+🚀 Leveraging [openapi-client-axios](https://www.npmjs.com/package/openapi-client-axios) and the [official openapi-schema from SFTPGo](https://raw.githubusercontent.com/drakkan/sftpgo/main/openapi/openapi.yaml), I fast-track the development of a fully-typed client for SFTPGo with a myriad of advantages:
 
-## Building
+- **Efficiency Unleashed**: Swiftly build a robust SFTP client with the power of openapi-client-axios.
 
-Run `nx build sftpgo-api-client` to build the library.
+- **Type-Safe Mastery**: Embrace full-typed capabilities, ensuring code integrity and reducing errors in your SFTP interactions.
 
-## Running unit tests
+- **Seamless Integration**: Effortlessly integrate the official openapi-schema from SFTPGo for a harmonious development experience.
 
-Run `nx test sftpgo-api-client` to execute the unit tests via [Vitest](https://vitest.dev/).
+- **Rapid Prototyping**: Accelerate your development cycle, transforming ideas into functional SFTP clients at an impressive pace.
+
+- **Future-Proof Solutions**: Stay ahead with a client built on the latest openapi standards, ensuring compatibility and adaptability for evolving requirements.
+
+Unleash the potential of SFTP interactions with a client crafted for speed, precision, and adaptability! 🔧✨
+
+## Usage
+
+Check example [here](https://github.com/BangNPD-Studio/sftpgo-api-client/tree/main/example)
+
+![example-hint-routes](https://raw.githubusercontent.com/BangNPD-Studio/sftpgo-api-client/main/assets/example-hint-routes.png "Show hint for routes")
+
+![example-hint-parameter](https://raw.githubusercontent.com/BangNPD-Studio/sftpgo-api-client/main/assets/example-hint-parameter.png "Show hint for parameters")
+
+
+## Credit
+
+This library was generated with [Nx](https://nx.dev).  
+Thanks for [openapi-client-axios](https://www.npmjs.com/package/openapi-client-axios).

dist/sftpgo-api-client/src/lib/sftpgo-api-client.js

@@ -7,3 +7,3 @@ "use strict";
     // definition: resolve(process.cwd(), 'src', 'assets', 'openapi.json'),
-    definition: "https://raw.githubusercontent.com/BangNPD-Studio/sftpgo-api-client/main/src/assets/openapi.json",
+    definition: 'https://raw.githubusercontent.com/BangNPD-Studio/sftpgo-api-client/main/assets/openapi.json',
     serverUrl: 'http://localhost:8080/api/v2',
@@ -10,0 +10,0 @@ };

package.json

@@ -10,3 +10,3 @@ {
   },
-  "version": "0.0.5",
+  "version": "0.0.6",
   "license": "MIT",
@@ -17,2 +17,3 @@ "scripts": {
     "example:start": "ts-node example/index.ts",
+    "prepublish": "nx build --skip-nx-cache",
     "publish": "npm publish --access public",
@@ -19,0 +20,0 @@ "test": "nx test"

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

817715

increased by0.2%

No dependency changes