@openapi-qraft/tanstack-query-react-plugin 2.0.0-next.8 → 2.0.0

package/dist/ts-factory/tsdoc/lib/createOperationMethodParametersExampleNodes.js

@@ -0,0 +1,47 @@
+import camelcase from 'camelcase';
+import ts from 'typescript';
+export const createOperationMethodParametersExampleNodes = (operation, transformOperationParameterIdentifier) => {
+    if (!operation.parameters)
+        return [];
+    const parametersTypeList = operation.parameters
+        .map((parameter) => parameter.in)
+        .filter((parameterKind, index, array) => array.indexOf(parameterKind) === index);
+    const operationRequiredParameters = operation.parameters.filter((parameter) => parameter.required);
+    return parametersTypeList.reduce((acc, parameterKind) => {
+        let operationParameters = operationRequiredParameters.filter((parameter) => parameter.in === parameterKind);
+        if (!operationParameters.length) {
+            const operationParameter = operation.parameters?.find((parameter) => parameter.in === parameterKind);
+            if (operationParameter) {
+                operationParameters = [operationParameter];
+            }
+        }
+        if (!operationParameters.length)
+            return acc;
+        const factory = ts.factory;
+        return [
+            ...acc,
+            factory.createPropertyAssignment(factory.createIdentifier(parameterKind), factory.createObjectLiteralExpression(operationParameters.map((parameter) => factory.createPropertyAssignment(isIdentifierCompatibleVariableName(parameter.name)
+                ? factory.createIdentifier(parameter.name)
+                : factory.createStringLiteral(parameter.name), parameter.example // todo:: add example type inferring
+                ? factory.createStringLiteral(parameter.example)
+                : factory.createIdentifier(transformOperationParameterIdentifier
+                    ? transformOperationParameterIdentifier(parameter)
+                    : camelcase(parameter.name)))), true)),
+        ];
+    }, []);
+};
+/**
+ * Checks if the given name is a valid identifier name.
+ *
+ * @example
+ * ```ts
+ * isIdentifierCompatibleVariableName('foo'); // true
+ * isIdentifierCompatibleVariableName('foo-bar'); // false
+ * isIdentifierCompatibleVariableName('foo_bar'); // true
+ * isIdentifierCompatibleVariableName('foo.bar'); // false
+ * ```
+ */
+function isIdentifierCompatibleVariableName(name) {
+    return !/[^a-zA-Z0-9_$]/.test(name);
+}
+//# sourceMappingURL=createOperationMethodParametersExampleNodes.js.map

package/dist/ts-factory/tsdoc/lib/createOperationMethodParametersExampleNodes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createOperationMethodParametersExampleNodes.js","sourceRoot":"","sources":["../../../../src/ts-factory/tsdoc/lib/createOperationMethodParametersExampleNodes.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,MAAM,CAAC,MAAM,2CAA2C,GAAG,CACzD,SAA2B,EAC3B,qCAEW,EACc,EAAE;IAC3B,IAAI,CAAC,SAAS,CAAC,UAAU;QAAE,OAAO,EAAE,CAAC;IAErC,MAAM,kBAAkB,GAAG,SAAS,CAAC,UAAU;SAC5C,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;SAChC,MAAM,CACL,CAAC,aAAa,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,KAAK,CACxE,CAAC;IAEJ,MAAM,2BAA2B,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,CAC7D,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAClC,CAAC;IAEF,OAAO,kBAAkB,CAAC,MAAM,CAC9B,CAAC,GAAG,EAAE,aAAa,EAAE,EAAE;QACrB,IAAI,mBAAmB,GAAG,2BAA2B,CAAC,MAAM,CAC1D,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,aAAa,CAC9C,CAAC;QAEF,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,CAAC;YAChC,MAAM,kBAAkB,GAAG,SAAS,CAAC,UAAU,EAAE,IAAI,CACnD,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,aAAa,CAC9C,CAAC;YACF,IAAI,kBAAkB,EAAE,CAAC;gBACvB,mBAAmB,GAAG,CAAC,kBAAkB,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;QAED,IAAI,CAAC,mBAAmB,CAAC,MAAM;YAAE,OAAO,GAAG,CAAC;QAE5C,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC;QAE3B,OAAO;YACL,GAAG,GAAG;YACN,OAAO,CAAC,wBAAwB,CAC9B,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,EACvC,OAAO,CAAC,6BAA6B,CACnC,mBAAmB,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CACpC,OAAO,CAAC,wBAAwB,CAC9B,kCAAkC,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChD,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC;gBAC1C,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,SAAS,CAAC,IAAI,CAAC,EAC/C,SAAS,CAAC,OAAO,CAAC,oCAAoC;gBACpD,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,SAAS,CAAC,OAAO,CAAC;gBAChD,CAAC,CAAC,OAAO,CAAC,gBAAgB,CACtB,qCAAqC;oBACnC,CAAC,CAAC,qCAAqC,CAAC,SAAS,CAAC;oBAClD,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,CAC9B,CACN,CACF,EACD,IAAI,CACL,CACF;SACF,CAAC;IACJ,CAAC,EACD,EAAE,CACH,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,SAAS,kCAAkC,CAAC,IAAY;IACtD,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACtC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-qraft/tanstack-query-react-plugin",
-  "version": "2.0.0-next.8",
+  "version": "2.0.0",
   "type": "module",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -27,18 +27,18 @@
     }
   },
   "dependencies": {
-    "@openapi-qraft/plugin": "^2.0.0-next.8",
-    "typescript": "^5.5.4"
+    "@openapi-qraft/plugin": "^2.0.0",
+    "typescript": "^5.6.2"
   },
   "devDependencies": {
     "@openapi-qraft/eslint-config": "1.0.0",
     "@openapi-qraft/test-fixtures": "1.0.0",
     "@openapi-qraft/ts-factory-code-generator": "1.0.0",
     "camelcase": "^8.0.0",
-    "eslint": "^9.0.0",
-    "memfs": "^4.9.2",
+    "eslint": "^9.16.0",
+    "memfs": "^4.11.1",
     "rimraf": "^5.0.10",
-    "vitest": "^1.4.0"
+    "vitest": "^2.1.8"
   },
   "files": [
     "dist",

package/src/generateCode.ts

@@ -1,7 +1,7 @@
 import { URL } from 'node:url';
 import { formatFileHeader } from '@openapi-qraft/plugin/lib/formatFileHeader';
 import { GeneratorFile } from '@openapi-qraft/plugin/lib/GeneratorFile';
-import { Service } from '@openapi-qraft/plugin/lib/open-api/getServices';
+import { OpenAPIService } from '@openapi-qraft/plugin/lib/open-api/OpenAPIService';
 import { OutputOptions as OutputOptionsBase } from '@openapi-qraft/plugin/lib/OutputOptions';
 import { PredefinedParametersGlob } from '@openapi-qraft/plugin/lib/predefineSchemaParameters';
 import c from 'ansi-colors';
@@ -19,7 +19,7 @@ import { getServiceIndexFactory } from './ts-factory/getServiceIndexFactory.js';
 interface OutputOptions extends OutputOptionsBase {
   fileHeader: string | undefined;
   servicesDirName: string;
-  explicitImportExtensions: boolean;
+  explicitImportExtensions: '.js' | '.ts' | undefined;
   exportSchemaTypes: boolean | undefined;
   operationPredefinedParameters: Array<PredefinedParametersGlob> | undefined;
 }
@@ -31,7 +31,7 @@ export const generateCode = async ({
   output,
 }: {
   spinner: Ora;
-  services: Service[];
+  services: OpenAPIService[];
   serviceImports: ServiceImportsFactoryOptions;
   output: OutputOptions;
 }) => {
@@ -58,7 +58,7 @@ const composeServicesDirPath = (
 
 const generateServices = async (
   spinner: Ora,
-  services: Service[],
+  services: OpenAPIService[],
   serviceImports: ServiceImportsFactoryOptions,
   output: OutputOptions
 ) => {
@@ -112,7 +112,7 @@ const generateServices = async (
 
 const generateServiceIndex = async (
   spinner: Ora,
-  services: Service[],
+  services: OpenAPIService[],
   output: OutputOptions
 ) => {
   spinner.start('Generating services index');
@@ -127,7 +127,7 @@ const generateServiceIndex = async (
   try {
     const code = astToString(
       getServiceIndexFactory(services, {
-        explicitImportExtensions: Boolean(output.explicitImportExtensions),
+        explicitImportExtensions: output.explicitImportExtensions,
       })
     );
 
@@ -157,7 +157,7 @@ const generateClient = async (spinner: Ora, output: OutputOptions) => {
     const code = astToString(
       getClientFactory({
         servicesDirName: output.servicesDirName,
-        explicitImportExtensions: Boolean(output.explicitImportExtensions),
+        explicitImportExtensions: output.explicitImportExtensions,
       })
     );
 
@@ -228,7 +228,7 @@ const generateIndex = async (
     const code = astToString(
       getIndexFactory({
         servicesDirName: output.servicesDirName,
-        explicitImportExtensions: Boolean(output.explicitImportExtensions),
+        explicitImportExtensions: output.explicitImportExtensions,
         openapiTypesImportPath: output.exportSchemaTypes
           ? serviceImports.openapiTypesImportPath
           : undefined,

package/src/lib/createOperationCommonTSDoc.ts

@@ -0,0 +1,11 @@
+import { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIService';
+
+export const createOperationCommonTSDoc = (operation: ServiceOperation) => {
+  return [
+    operation.deprecated ? '@deprecated' : null,
+    operation.summary ? `@summary ${operation.summary}` : null,
+    operation.description ? `@description ${operation.description}` : null,
+  ].filter((comment): comment is NonNullable<typeof comment> =>
+    Boolean(comment)
+  );
+};

package/src/plugin.ts

@@ -5,6 +5,7 @@ import {
 } from '@openapi-qraft/plugin/lib/predefineSchemaParameters';
 import { QraftCommand } from '@openapi-qraft/plugin/lib/QraftCommand';
 import { QraftCommandPlugin } from '@openapi-qraft/plugin/lib/QraftCommandPlugin';
+import { Option } from 'commander';
 import { generateCode } from './generateCode.js';
 
 export const plugin: QraftCommandPlugin = {
@@ -15,9 +16,13 @@ export const plugin: QraftCommandPlugin = {
         '--openapi-types-import-path <path>',
         'Path to schema types file (.d.ts), eg: "../schema.d.ts"'
       )
-      .option(
-        '--explicit-import-extensions',
-        'All import statements will include explicit `.js` extensions. Ideal for projects using ECMAScript modules.'
+      .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]',

package/src/ts-factory/filterUnusedTypes.ts

@@ -0,0 +1,49 @@
+import ts from 'typescript';
+
+/**
+ * Checks if a type is used in the given nodes.
+ * @param typeImports Record<moduleName, typeName[]>
+ * @param nodes
+ * @returns Record<moduleName, typeName[]>
+ */
+export function filterUnusedTypes(
+  typeImports: Record<string, string[]>,
+  nodes: ts.Node[]
+): Record<string, string[]> {
+  const usedTypeImports: Record<string, string[]> = {};
+  const targetTypeNames = Object.entries(typeImports).reduce<
+    Record<string, string>
+  >(
+    (acc, [moduleName, typeImports]) =>
+      typeImports.reduce((acc, typeName) => {
+        acc[typeName] = moduleName;
+        return acc;
+      }, acc),
+    {}
+  );
+
+  const transformer =
+    (context: ts.TransformationContext) => (rootNode: ts.Node) => {
+      function visit(node: ts.Node): ts.Node {
+        if (ts.isTypeReferenceNode(node) && ts.isIdentifier(node.typeName)) {
+          const typeName = node.typeName.text;
+          const moduleName = targetTypeNames[typeName];
+          if (moduleName) {
+            usedTypeImports[moduleName] ??= [];
+            if (!usedTypeImports[moduleName].includes(typeName)) {
+              usedTypeImports[moduleName].push(typeName);
+              usedTypeImports[moduleName].sort();
+            }
+          }
+        }
+
+        return ts.visitEachChild(node, visit, context);
+      }
+
+      return ts.visitNode(rootNode, visit);
+    };
+
+  ts.transform(nodes, [transformer]).dispose();
+
+  return usedTypeImports;
+}

package/src/ts-factory/getClientFactory.ts

@@ -2,7 +2,7 @@ import ts from 'typescript';
 
 type Options = {
   servicesDirName: string;
-  explicitImportExtensions: boolean;
+  explicitImportExtensions: '.js' | '.ts' | undefined;
 };
 
 export const getClientFactory = (options: Options) => {
@@ -79,7 +79,7 @@ const getClientImportsFactory = ({
         ])
       ),
       factory.createStringLiteral(
-        `./${servicesDirName}/index${explicitImportExtensions ? '.js' : ''}`
+        `./${servicesDirName}/index${explicitImportExtensions ?? ''}`
       ),
       undefined
     ),

package/src/ts-factory/getIndexFactory.ts

@@ -8,18 +8,27 @@ export const getIndexFactory = ({
   explicitImportExtensions,
 }: {
   servicesDirName: string;
-  explicitImportExtensions: boolean;
+  explicitImportExtensions: '.js' | '.ts' | undefined;
 } & Partial<Pick<ServiceImportsFactoryOptions, 'openapiTypesImportPath'>>) => {
   const factory = ts.factory;
-  const importExtension = explicitImportExtensions ? '.js' : '';
+  const importExtension = explicitImportExtensions ?? '';
 
   return [
     ...(openapiTypesImportPath
       ? [
           factory.createExportDeclaration(
             undefined,
-            openapiTypesImportPath.endsWith('.d.ts'),
-            undefined,
+            true,
+            factory.createNamedExports(
+              ['$defs', 'paths', 'components', 'operations', 'webhooks'].map(
+                (name) =>
+                  factory.createExportSpecifier(
+                    false,
+                    undefined,
+                    factory.createIdentifier(name)
+                  )
+              )
+            ),
             factory.createStringLiteral(
               maybeResolveImport({ openapiTypesImportPath, servicesDirName })
             ),