@openapi-qraft/tanstack-query-react-plugin 2.3.2 → 2.4.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @openapi-qraft/tanstack-query-react-plugin
 
+## 2.4.0
+
+### Patch Changes
+
+- Updated dependencies [cc314c3]
+  - @openapi-qraft/plugin@2.4.0
+
 ## 2.3.2
 
 ### Patch Changes

package/dist/plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,kBAAkB,EAAE,MAAM,8CAA8C,CAAC;AAIlF,eAAO,MAAM,MAAM,EAAE,kBAgDpB,CAAC"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,kBAAkB,EAAE,MAAM,8CAA8C,CAAC;AAIlF,eAAO,MAAM,MAAM,EAAE,kBAkDpB,CAAC"}

package/dist/plugin.js

@@ -5,12 +5,12 @@ import { generateCode } from './generateCode.js';
 export const plugin = {
     setupCommand(command) {
         command
-            .description('Generate TanStack Query React client from OpenAPI Schema')
-            .requiredOption('--openapi-types-import-path <path>', 'Path to schema types file (.d.ts), eg: "../schema.d.ts"')
+            .description('Generate a TanStack Query React client from OpenAPI Document')
+            .requiredOption('--openapi-types-import-path <path>', 'Path to schema types file (.d.ts), e.g.: "../schema.d.ts"')
             .addOption(new Option('--explicit-import-extensions [extension]', 'All import statements will contain an explicit file extension. Ideal for projects using ECMAScript modules.')
             .preset('.js')
             .choices(['.js', '.ts']))
-            .option('--export-openapi-types [bool]', 'Export the OpenAPI schema types from the generated `./index.ts` file', (arg) => {
+            .option('--export-openapi-types [bool]', "Add an export statement of the generated OpenAPI document types from the `./index.ts' file. Useful for sharing types within your project.", (arg) => {
             return arg?.toLowerCase() !== 'false';
         })
             .action(async ({ spinner, output, args, services, schema }, resolve) => {
@@ -28,7 +28,7 @@ export const plugin = {
                     exportSchemaTypes: args.exportOpenapiTypes,
                     operationPredefinedParameters: args.operationPredefinedParameters
                         ? createPredefinedParametersGlobs(schema, parseOperationPredefinedParametersOption(...args.operationPredefinedParameters))
-                        : undefined, // inherited from `--operation-predefined-parameters` option
+                        : undefined, // This value is inherited from the `--operation-predefined-parameters` option
                 },
             }).then(resolve));
         });

package/dist/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AAClE,OAAO,EACL,+BAA+B,EAC/B,wCAAwC,GACzC,MAAM,qDAAqD,CAAC;AAG7D,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,MAAM,CAAC,MAAM,MAAM,GAAuB;IACxC,YAAY,CAAC,OAAqB;QAChC,OAAO;aACJ,WAAW,CAAC,0DAA0D,CAAC;aACvE,cAAc,CACb,oCAAoC,EACpC,yDAAyD,CAC1D;aACA,SAAS,CACR,IAAI,MAAM,CACR,0CAA0C,EAC1C,6GAA6G,CAC9G;aACE,MAAM,CAAC,KAAK,CAAC;aACb,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAC3B;aACA,MAAM,CACL,+BAA+B,EAC/B,sEAAsE,EACtE,CAAC,GAAG,EAAE,EAAE;YACN,OAAO,GAAG,EAAE,WAAW,EAAE,KAAK,OAAO,CAAC;QACxC,CAAC,CACF;aACA,MAAM,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE;YACrE,OAAO,KAAK,CAAC,MAAM,YAAY,CAAC;gBAC9B,OAAO;gBACP,QAAQ;gBACR,cAAc,EAAE;oBACd,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;iBACpD;gBACD,MAAM,EAAE;oBACN,GAAG,MAAM;oBACT,UAAU,EAAE,IAAI,CAAC,UAAU,IAAI,UAAU;oBACzC,wBAAwB,EAAE,IAAI,CAAC,wBAAwB;oBACvD,eAAe,EAAE,UAAU;oBAC3B,iBAAiB,EAAE,IAAI,CAAC,kBAAkB;oBAC1C,6BAA6B,EAAE,IAAI,CAAC,6BAA6B;wBAC/D,CAAC,CAAC,+BAA+B,CAC7B,MAAM,EACN,wCAAwC,CACtC,GAAG,IAAI,CAAC,6BAA6B,CACtC,CACF;wBACH,CAAC,CAAC,SAAS,EAAE,4DAA4D;iBAC5E;aACF,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;IACP,CAAC;CACF,CAAC"}
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AAClE,OAAO,EACL,+BAA+B,EAC/B,wCAAwC,GACzC,MAAM,qDAAqD,CAAC;AAG7D,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,MAAM,CAAC,MAAM,MAAM,GAAuB;IACxC,YAAY,CAAC,OAAqB;QAChC,OAAO;aACJ,WAAW,CACV,8DAA8D,CAC/D;aACA,cAAc,CACb,oCAAoC,EACpC,2DAA2D,CAC5D;aACA,SAAS,CACR,IAAI,MAAM,CACR,0CAA0C,EAC1C,6GAA6G,CAC9G;aACE,MAAM,CAAC,KAAK,CAAC;aACb,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAC3B;aACA,MAAM,CACL,+BAA+B,EAC/B,2IAA2I,EAC3I,CAAC,GAAG,EAAE,EAAE;YACN,OAAO,GAAG,EAAE,WAAW,EAAE,KAAK,OAAO,CAAC;QACxC,CAAC,CACF;aACA,MAAM,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE;YACrE,OAAO,KAAK,CAAC,MAAM,YAAY,CAAC;gBAC9B,OAAO;gBACP,QAAQ;gBACR,cAAc,EAAE;oBACd,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;iBACpD;gBACD,MAAM,EAAE;oBACN,GAAG,MAAM;oBACT,UAAU,EAAE,IAAI,CAAC,UAAU,IAAI,UAAU;oBACzC,wBAAwB,EAAE,IAAI,CAAC,wBAAwB;oBACvD,eAAe,EAAE,UAAU;oBAC3B,iBAAiB,EAAE,IAAI,CAAC,kBAAkB;oBAC1C,6BAA6B,EAAE,IAAI,CAAC,6BAA6B;wBAC/D,CAAC,CAAC,+BAA+B,CAC7B,MAAM,EACN,wCAAwC,CACtC,GAAG,IAAI,CAAC,6BAA6B,CACtC,CACF;wBACH,CAAC,CAAC,SAAS,EAAE,8EAA8E;iBAC9F;aACF,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;IACP,CAAC;CACF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-qraft/tanstack-query-react-plugin",
-  "version": "2.3.2",
+  "version": "2.4.0",
   "type": "module",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -35,12 +35,12 @@
     }
   },
   "dependencies": {
-    "@openapi-qraft/plugin": "^2.3.2",
+    "@openapi-qraft/plugin": "^2.4.0",
     "typescript": "^5.6.2"
   },
   "devDependencies": {
     "@openapi-qraft/eslint-config": "1.0.1",
-    "@openapi-qraft/tanstack-query-react-types": "2.3.2",
+    "@openapi-qraft/tanstack-query-react-types": "2.4.0",
     "@openapi-qraft/test-fixtures": "1.0.1",
     "@openapi-qraft/ts-factory-code-generator": "1.0.2",
     "camelcase": "^8.0.0",

package/src/plugin.ts

@@ -11,10 +11,12 @@ import { generateCode } from './generateCode.js';
 export const plugin: QraftCommandPlugin = {
   setupCommand(command: QraftCommand) {
     command
-      .description('Generate TanStack Query React client from OpenAPI Schema')
+      .description(
+        'Generate a TanStack Query React client from OpenAPI Document'
+      )
       .requiredOption(
         '--openapi-types-import-path <path>',
-        'Path to schema types file (.d.ts), eg: "../schema.d.ts"'
+        'Path to schema types file (.d.ts), e.g.: "../schema.d.ts"'
       )
       .addOption(
         new Option(
@@ -26,7 +28,7 @@ export const plugin: QraftCommandPlugin = {
       )
       .option(
         '--export-openapi-types [bool]',
-        'Export the OpenAPI schema types from the generated `./index.ts` file',
+        "Add an export statement of the generated OpenAPI document types from the `./index.ts' file. Useful for sharing types within your project.",
         (arg) => {
           return arg?.toLowerCase() !== 'false';
         }
@@ -51,7 +53,7 @@ export const plugin: QraftCommandPlugin = {
                     ...args.operationPredefinedParameters
                   )
                 )
-              : undefined, // inherited from `--operation-predefined-parameters` option
+              : undefined, // This value is inherited from the `--operation-predefined-parameters` option
           },
         }).then(resolve));
       });