@openapi-qraft/cli 1.13.0 → 1.14.0-beta.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @openapi-qraft/cli
 
+## 1.14.0-beta.0
+
+### Patch Changes
+
+- Updated dependencies [77f0812]
+- Updated dependencies [49dc44f]
+- Updated dependencies [787f568]
+  - @openapi-qraft/plugin@1.14.0-beta.0
+  - @openapi-qraft/tanstack-query-react-plugin@1.14.0-beta.0
+  - @openapi-qraft/openapi-typescript-plugin@1.1.0-beta.0
+
 ## 1.13.0
 
 ### Patch Changes

package/README.md

@@ -104,10 +104,19 @@ npx openapi-qraft --plugin tanstack-query-react --plugin openapi-typescript http
     - `--operation-predefined-parameters '/**,!/auth/token:header.x-entity-id'` - set `header.x-entity-id` as optional parameters for all services except `/auth/token`.
     - `--operation-predefined-parameters '/**:header.x-monite-version,query.x-api-key' '/user/**,/post/**:header.x-monite-entity-id'` -
       set `header.x-monite-version` and `query.x-api-key` as optional parameters for all services, and `header.x-monite-entity-id` for the `/user/**` and `/post/**` services.
+    - `--operation-predefined-parameters 'post,put /**:header.x-entity-id'` - set the `Header` record `x-entity-id` as an optional parameter for the `POST` and `PUT` methods.
 
-      > **Note:** In future versions of the library, this feature will be expanded. Not only will it make parameters optional,
-      > but it will also offer typed suggestions for these predefined parameters when creating a client. This enhancement will
-      > further improve type safety and developer experience.
+  > **Note:** In future versions of the library, this feature will be expanded. Not only will it make parameters
+  > optional, but it will also offer typed suggestions for these predefined parameters when creating a client. This enhancement will
+  > further improve type safety and developer experience.
+
+- **`--operation-name-modifier <patterns...>`:** Modifies operation names using a pattern.
+
+  - Examples:
+    - `--operation-name-modifier 'get /**:[A-Za-z]+Id ==> findOne'` - will change all `GET` operations with `Id` suffix to `findOne`.
+    - `--operation-name-modifier 'put,patch /**:[A-Za-z]+Id ==> updateOne'` - will change all `PUT` and `PATCH` operations with `Id` suffix to `updateOne`.
+    - `--operation-name-modifier '/posts,/files:create[a-zA-Z]+ ==> createOne'` - will change all operations under `/posts` and `/files` to `createOne` if the operation name starts with `create`.
+    - `--operation-name-modifier 'post /files ==> createOne' 'put /posts ==> updateOne'` - will change all `POST` operations under `/files` to `createOne` and all `PUT` operations under `/posts` to `updateOne`.
 
 - **`--service-name-base <endpoint[<index>] | tags>`:** Use OpenAPI Operation `endpoint[<index>]` path part (e.g.: `/0/1/2`) or `tags` as the base name of the service. _(optional, default: `endpoint[0]`)_.
   - Examples:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-qraft/cli",
-  "version": "1.13.0",
+  "version": "1.14.0-beta.0",
   "description": "CLI for generating typed Tanstack Query React Hooks and services from OpenAPI Schemas, improving type safety in React apps",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -15,9 +15,9 @@
     "openapi-qraft": "./bin.mjs"
   },
   "dependencies": {
-    "@openapi-qraft/openapi-typescript-plugin": "1.0.7",
-    "@openapi-qraft/plugin": "1.13.0",
-    "@openapi-qraft/tanstack-query-react-plugin": "1.13.0",
+    "@openapi-qraft/openapi-typescript-plugin": "1.1.0-beta.0",
+    "@openapi-qraft/plugin": "1.14.0-beta.0",
+    "@openapi-qraft/tanstack-query-react-plugin": "1.14.0-beta.0",
     "commander": "^11.1.0"
   },
   "devDependencies": {