@openapi-qraft/tanstack-query-react-plugin 1.8.0 → 1.10.0

package/src/__snapshots__/index.ts.snapshot.ts

@@ -1,13 +1,9 @@
-import fs from 'node:fs';
-import { expect } from 'vitest';
+/**
+ * This file was auto-generated by @openapi-qraft/cli.
+ * Do not make direct changes to the file.
+ */
 
-export default function () {
-  expect(fs.readFileSync('/mock-fs/index.ts', 'utf-8')).toMatchInlineSnapshot(`
-    "/* generated using @openapi-qraft/cli -- do no edit */
-    /* istanbul ignore file */
-    export { services } from "./services/index.js";
-    export type { Services } from "./services/index.js";
-    export { createAPIClient } from "./create-api-client.js";
-    "
-  `);
-}
+export type * from "./../openapi.js";
+export { services } from "./services/index.js";
+export type { Services } from "./services/index.js";
+export { createAPIClient } from "./create-api-client.js";

package/src/__snapshots__/services/ApprovalPoliciesService.ts.snapshot.ts

@@ -1,64 +1,69 @@
-import fs from 'node:fs';
-import { expect } from 'vitest';
+/**
+ * This file was auto-generated by @openapi-qraft/cli.
+ * Do not make direct changes to the file.
+ */
 
-export default function () {
-  expect(
-    fs.readFileSync('/mock-fs/services/ApprovalPoliciesService.ts', 'utf-8')
-  ).toMatchInlineSnapshot(`
-    "/* generated using @openapi-qraft/cli -- do no edit */
-    /* istanbul ignore file */
-    import type { paths } from "../../openapi.js";
-    import type { ServiceOperationQuery, ServiceOperationMutation } from "@openapi-qraft/react";
-    export interface ApprovalPoliciesService {
-        /**
-         * @summary Get an approval policy by ID
-         * @description Retrieve a specific approval policy.
-         */
-        getApprovalPoliciesId: ServiceOperationQuery<{
-            method: "get";
-            url: "/approval_policies/{approval_policy_id}";
-        }, paths["/approval_policies/{approval_policy_id}"]["get"]["responses"]["200"]["content"]["application/json"], paths["/approval_policies/{approval_policy_id}"]["get"]["parameters"], paths["/approval_policies/{approval_policy_id}"]["get"]["responses"]["401"]["content"]["application/json"] | paths["/approval_policies/{approval_policy_id}"]["get"]["responses"]["422"]["content"]["application/json"] | paths["/approval_policies/{approval_policy_id}"]["get"]["responses"]["default"]["content"]["application/json"]>;
-        /**
-         * @summary Delete an approval policy
-         * @description Delete an existing approval policy.
-         */
-        deleteApprovalPoliciesId: ServiceOperationMutation<{
-            method: "delete";
-            url: "/approval_policies/{approval_policy_id}";
-        }, undefined, paths["/approval_policies/{approval_policy_id}"]["delete"]["responses"]["200"]["content"]["application/json"], paths["/approval_policies/{approval_policy_id}"]["delete"]["parameters"], paths["/approval_policies/{approval_policy_id}"]["delete"]["responses"]["401"]["content"]["application/json"] | paths["/approval_policies/{approval_policy_id}"]["delete"]["responses"]["422"]["content"]["application/json"] | paths["/approval_policies/{approval_policy_id}"]["delete"]["responses"]["default"]["content"]["application/json"]>;
-        /**
-         * @summary Update an approval policy
-         * @description Update an existing approval policy.
-         */
-        patchApprovalPoliciesId: ServiceOperationMutation<{
-            method: "patch";
-            url: "/approval_policies/{approval_policy_id}";
-            mediaType: "application/json";
-        }, NonNullable<paths["/approval_policies/{approval_policy_id}"]["patch"]["requestBody"]>["content"]["application/json"], paths["/approval_policies/{approval_policy_id}"]["patch"]["responses"]["200"]["content"]["application/json"], paths["/approval_policies/{approval_policy_id}"]["patch"]["parameters"], paths["/approval_policies/{approval_policy_id}"]["patch"]["responses"]["401"]["content"]["application/json"] | paths["/approval_policies/{approval_policy_id}"]["patch"]["responses"]["422"]["content"]["application/json"] | paths["/approval_policies/{approval_policy_id}"]["patch"]["responses"]["default"]["content"]["application/json"]>;
-    }
-    export const approvalPoliciesService: {
-        [key in keyof ApprovalPoliciesService]: Pick<ApprovalPoliciesService[key], "schema">;
-    } = {
-        getApprovalPoliciesId: {
-            schema: {
-                method: "get",
-                url: "/approval_policies/{approval_policy_id}"
-            }
-        },
-        deleteApprovalPoliciesId: {
-            schema: {
-                method: "delete",
-                url: "/approval_policies/{approval_policy_id}"
-            }
-        },
-        patchApprovalPoliciesId: {
-            schema: {
-                method: "patch",
-                url: "/approval_policies/{approval_policy_id}",
-                mediaType: "application/json"
-            }
-        }
-    } as const;
-    "
-  `);
+import type { paths } from "../../openapi.js";
+import type { ServiceOperationQuery, ServiceOperationMutation } from "@openapi-qraft/react";
+export interface ApprovalPoliciesService {
+    /**
+     * @summary Get an approval policy by ID
+     * @description Retrieve a specific approval policy.
+     */
+    getApprovalPoliciesId: ServiceOperationQuery<{
+        method: "get";
+        url: "/approval_policies/{approval_policy_id}";
+        security: [
+            "partnerToken"
+        ];
+    }, paths["/approval_policies/{approval_policy_id}"]["get"]["responses"]["200"]["content"]["application/json"], paths["/approval_policies/{approval_policy_id}"]["get"]["parameters"], paths["/approval_policies/{approval_policy_id}"]["get"]["responses"]["401"]["content"]["application/json"] | paths["/approval_policies/{approval_policy_id}"]["get"]["responses"]["422"]["content"]["application/json"] | paths["/approval_policies/{approval_policy_id}"]["get"]["responses"]["default"]["content"]["application/json"]>;
+    /**
+     * @summary Delete an approval policy
+     * @description Delete an existing approval policy.
+     */
+    deleteApprovalPoliciesId: ServiceOperationMutation<{
+        method: "delete";
+        url: "/approval_policies/{approval_policy_id}";
+        security: [
+            "HTTPBearer"
+        ];
+    }, undefined, paths["/approval_policies/{approval_policy_id}"]["delete"]["responses"]["200"]["content"]["application/json"], paths["/approval_policies/{approval_policy_id}"]["delete"]["parameters"], paths["/approval_policies/{approval_policy_id}"]["delete"]["responses"]["401"]["content"]["application/json"] | paths["/approval_policies/{approval_policy_id}"]["delete"]["responses"]["422"]["content"]["application/json"] | paths["/approval_policies/{approval_policy_id}"]["delete"]["responses"]["default"]["content"]["application/json"]>;
+    /**
+     * @summary Update an approval policy
+     * @description Update an existing approval policy.
+     */
+    patchApprovalPoliciesId: ServiceOperationMutation<{
+        method: "patch";
+        url: "/approval_policies/{approval_policy_id}";
+        mediaType: "application/json";
+        security: [
+            "HTTPBearer"
+        ];
+    }, NonNullable<paths["/approval_policies/{approval_policy_id}"]["patch"]["requestBody"]>["content"]["application/json"], paths["/approval_policies/{approval_policy_id}"]["patch"]["responses"]["200"]["content"]["application/json"], paths["/approval_policies/{approval_policy_id}"]["patch"]["parameters"], paths["/approval_policies/{approval_policy_id}"]["patch"]["responses"]["401"]["content"]["application/json"] | paths["/approval_policies/{approval_policy_id}"]["patch"]["responses"]["422"]["content"]["application/json"] | paths["/approval_policies/{approval_policy_id}"]["patch"]["responses"]["default"]["content"]["application/json"]>;
 }
+export const approvalPoliciesService: {
+    [key in keyof ApprovalPoliciesService]: Pick<ApprovalPoliciesService[key], "schema">;
+} = {
+    getApprovalPoliciesId: {
+        schema: {
+            method: "get",
+            url: "/approval_policies/{approval_policy_id}",
+            security: ["partnerToken"]
+        }
+    },
+    deleteApprovalPoliciesId: {
+        schema: {
+            method: "delete",
+            url: "/approval_policies/{approval_policy_id}",
+            security: ["HTTPBearer"]
+        }
+    },
+    patchApprovalPoliciesId: {
+        schema: {
+            method: "patch",
+            url: "/approval_policies/{approval_policy_id}",
+            mediaType: "application/json",
+            security: ["HTTPBearer"]
+        }
+    }
+} as const;

package/src/__snapshots__/services/FilesService.ts.snapshot.ts

@@ -1,57 +1,59 @@
-import fs from 'node:fs';
-import { expect } from 'vitest';
+/**
+ * This file was auto-generated by @openapi-qraft/cli.
+ * Do not make direct changes to the file.
+ */
 
-export default function () {
-  expect(fs.readFileSync('/mock-fs/services/FilesService.ts', 'utf-8'))
-    .toMatchInlineSnapshot(`
-      "/* generated using @openapi-qraft/cli -- do no edit */
-      /* istanbul ignore file */
-      import type { paths } from "../../openapi.js";
-      import type { ServiceOperationQuery, ServiceOperationMutation } from "@openapi-qraft/react";
-      export interface FilesService {
-          /** @summary Get a files by ID */
-          getFiles: ServiceOperationQuery<{
-              method: "get";
-              url: "/files";
-          }, paths["/files"]["get"]["responses"]["200"]["content"]["application/json"], paths["/files"]["get"]["parameters"], paths["/files"]["get"]["responses"]["405"]["content"]["application/json"] | paths["/files"]["get"]["responses"]["422"]["content"]["application/json"] | paths["/files"]["get"]["responses"]["default"]["content"]["application/json"]>;
-          /** @summary Upload a files by ID */
-          postFiles: ServiceOperationMutation<{
-              method: "post";
-              url: "/files";
-              mediaType: "multipart/form-data";
-          }, NonNullable<paths["/files"]["post"]["requestBody"]>["content"]["multipart/form-data"], paths["/files"]["post"]["responses"]["200"]["content"]["application/json"], undefined, paths["/files"]["post"]["responses"]["default"]["content"]["application/json"]>;
-          /**
-           * @deprecated
-           * @summary Get a file list
-           */
-          getFileList: ServiceOperationQuery<{
-              method: "get";
-              url: "/files/list";
-          }, paths["/files/list"]["get"]["responses"]["200"]["content"]["application/json"], paths["/files/list"]["get"]["parameters"], paths["/files/list"]["get"]["responses"]["default"]["content"]["application/json"]>;
-      }
-      export const filesService: {
-          [key in keyof FilesService]: Pick<FilesService[key], "schema">;
-      } = {
-          getFiles: {
-              schema: {
-                  method: "get",
-                  url: "/files"
-              }
-          },
-          postFiles: {
-              schema: {
-                  method: "post",
-                  url: "/files",
-                  mediaType: "multipart/form-data"
-              }
-          },
-          getFileList: {
-              schema: {
-                  method: "get",
-                  url: "/files/list"
-              }
-          }
-      } as const;
-      "
-    `);
+import type { paths } from "../../openapi.js";
+import type { ServiceOperationQuery, ServiceOperationMutation } from "@openapi-qraft/react";
+export interface FilesService {
+    /** @summary Get a files by ID */
+    getFiles: ServiceOperationQuery<{
+        method: "get";
+        url: "/files";
+        security: [
+            "HTTPBearer"
+        ];
+    }, paths["/files"]["get"]["responses"]["200"]["content"]["application/json"], paths["/files"]["get"]["parameters"], paths["/files"]["get"]["responses"]["405"]["content"]["application/json"] | paths["/files"]["get"]["responses"]["422"]["content"]["application/json"] | paths["/files"]["get"]["responses"]["default"]["content"]["application/json"]>;
+    /** @summary Upload a files by ID */
+    postFiles: ServiceOperationMutation<{
+        method: "post";
+        url: "/files";
+        mediaType: "multipart/form-data";
+    }, NonNullable<paths["/files"]["post"]["requestBody"]>["content"]["multipart/form-data"], paths["/files"]["post"]["responses"]["200"]["content"]["application/json"], undefined, paths["/files"]["post"]["responses"]["default"]["content"]["application/json"]>;
+    /**
+     * @deprecated
+     * @summary Get a file list
+     */
+    getFileList: ServiceOperationQuery<{
+        method: "get";
+        url: "/files/list";
+        security: [
+            "HTTPBearer"
+        ];
+    }, paths["/files/list"]["get"]["responses"]["200"]["content"]["application/json"], paths["/files/list"]["get"]["parameters"], paths["/files/list"]["get"]["responses"]["default"]["content"]["application/json"]>;
 }
+export const filesService: {
+    [key in keyof FilesService]: Pick<FilesService[key], "schema">;
+} = {
+    getFiles: {
+        schema: {
+            method: "get",
+            url: "/files",
+            security: ["HTTPBearer"]
+        }
+    },
+    postFiles: {
+        schema: {
+            method: "post",
+            url: "/files",
+            mediaType: "multipart/form-data"
+        }
+    },
+    getFileList: {
+        schema: {
+            method: "get",
+            url: "/files/list",
+            security: ["HTTPBearer"]
+        }
+    }
+} as const;

package/src/__snapshots__/services/index.ts.snapshot.ts

@@ -1,24 +1,18 @@
-import fs from 'node:fs';
-import { expect } from 'vitest';
+/**
+ * This file was auto-generated by @openapi-qraft/cli.
+ * Do not make direct changes to the file.
+ */
 
-export default function () {
-  expect(fs.readFileSync('/mock-fs/services/index.ts', 'utf-8'))
-    .toMatchInlineSnapshot(`
-      "/* generated using @openapi-qraft/cli -- do no edit */
-      /* istanbul ignore file */
-      import { EntitiesService, entitiesService } from "./EntitiesService.js";
-      import { ApprovalPoliciesService, approvalPoliciesService } from "./ApprovalPoliciesService.js";
-      import { FilesService, filesService } from "./FilesService.js";
-      export type Services = {
-          entities: EntitiesService;
-          approvalPolicies: ApprovalPoliciesService;
-          files: FilesService;
-      };
-      export const services = {
-          entities: entitiesService,
-          approvalPolicies: approvalPoliciesService,
-          files: filesService
-      } as const;
-      "
-    `);
-}
+import { EntitiesService, entitiesService } from "./EntitiesService.js";
+import { ApprovalPoliciesService, approvalPoliciesService } from "./ApprovalPoliciesService.js";
+import { FilesService, filesService } from "./FilesService.js";
+export type Services = {
+    entities: EntitiesService;
+    approvalPolicies: ApprovalPoliciesService;
+    files: FilesService;
+};
+export const services = {
+    entities: entitiesService,
+    approvalPolicies: approvalPoliciesService,
+    files: filesService
+} as const;

package/src/generateCode.ts

@@ -1,3 +1,4 @@
+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 { OutputOptions as OutputOptionsBase } from '@openapi-qraft/plugin/lib/OutputOptions';
@@ -19,6 +20,7 @@ interface OutputOptions extends OutputOptionsBase {
   fileHeader: string | undefined;
   servicesDirName: string;
   explicitImportExtensions: boolean;
+  exportSchemaTypes: boolean | undefined;
 }
 
 export const generateCode = async ({
@@ -36,7 +38,7 @@ export const generateCode = async ({
     ...(await generateServices(spinner, services, serviceImports, output)),
     ...(await generateServiceIndex(spinner, services, output)),
     ...(await generateClient(spinner, output)),
-    ...(await generateIndex(spinner, output)),
+    ...(await generateIndex(spinner, serviceImports, output)),
   ];
 };
 
@@ -82,7 +84,7 @@ const generateServices = async (
 
       serviceFiles.push({
         file: new URL(`${fileBaseName}.ts`, servicesDir),
-        code: getFileHeader(output) + code,
+        code: formatFileHeader(output.fileHeader) + code,
       });
     } catch (error) {
       spinner.fail(
@@ -123,7 +125,7 @@ const generateServiceIndex = async (
 
     serviceIndexFiles.push({
       file: new URL('index.ts', composeServicesDirPath(output)),
-      code: getFileHeader(output) + code,
+      code: formatFileHeader(output.fileHeader) + code,
     });
   } catch (error) {
     spinner.fail(
@@ -153,7 +155,7 @@ const generateClient = async (spinner: Ora, output: OutputOptions) => {
 
     clientFiles.push({
       file: new URL('create-api-client.ts', output.dir),
-      code: getFileHeader(output) + code,
+      code: formatFileHeader(output.fileHeader) + code,
     });
   } catch (error) {
     spinner.fail(c.redBright('Error occurred during client generation'));
@@ -166,7 +168,11 @@ const generateClient = async (spinner: Ora, output: OutputOptions) => {
   return clientFiles;
 };
 
-const generateIndex = async (spinner: Ora, output: OutputOptions) => {
+const generateIndex = async (
+  spinner: Ora,
+  serviceImports: ServiceImportsFactoryOptions,
+  output: OutputOptions
+) => {
   spinner.start('Generating index');
 
   const indexFiles: GeneratorFile[] = [];
@@ -176,12 +182,15 @@ const generateIndex = async (spinner: Ora, output: OutputOptions) => {
       getIndexFactory({
         servicesDirName: output.servicesDirName,
         explicitImportExtensions: Boolean(output.explicitImportExtensions),
+        openapiTypesImportPath: output.exportSchemaTypes
+          ? serviceImports.openapiTypesImportPath
+          : undefined,
       })
     );
 
     indexFiles.push({
       file: new URL('index.ts', output.dir),
-      code: getFileHeader(output) + code,
+      code: formatFileHeader(output.fileHeader) + code,
     });
   } catch (error) {
     spinner.fail(c.redBright('Error occurred during index generation'));
@@ -193,9 +202,3 @@ const generateIndex = async (spinner: Ora, output: OutputOptions) => {
 
   return indexFiles;
 };
-
-export const getFileHeader = ({
-  fileHeader,
-}: Pick<OutputOptions, 'fileHeader'>) => {
-  return fileHeader && `${fileHeader}\n`;
-};

package/src/plugin.ts

@@ -9,24 +9,27 @@ export const plugin: QraftCommandPlugin = {
     command
       .description('Generate TanStack Query React client from OpenAPI Schema')
       .requiredOption(
-        '--openapi-types-import-path <path>', // todo::specify better param name to avoid confusion with real path
-        'Path to schema types file (.d.ts), eg: "../openapi.d.ts"'
-      )
-      .option(
-        '--file-header <string>',
-        'Header to be added to the generated file (eg: /* eslint-disable */)'
+        '--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.'
       )
+      .option(
+        '--export-openapi-types [bool]',
+        'Export the OpenAPI schema types from the generated `./index.ts` file',
+        (arg) => {
+          return arg?.toLowerCase() !== 'false';
+        }
+      )
       .option(
         '--operation-generics-import-path <path>',
         'Path to operation generics file',
         '@openapi-qraft/react'
       )
-      .action(({ spinner, output, args, services }, resolve) => {
-        return void generateCode({
+      .action(async ({ spinner, output, args, services }, resolve) => {
+        return void (await generateCode({
           spinner,
           services,
           serviceImports: {
@@ -38,8 +41,9 @@ export const plugin: QraftCommandPlugin = {
             fileHeader: args.fileHeader ?? fileHeader,
             explicitImportExtensions: args.explicitImportExtensions,
             servicesDirName: 'services',
+            exportSchemaTypes: args.exportOpenapiTypes,
           },
-        }).then(resolve);
+        }).then(resolve));
       });
   },
 };

package/src/ts-factory/getIndexFactory.ts

@@ -1,16 +1,32 @@
 import ts from 'typescript';
 
+import type { ServiceImportsFactoryOptions } from './getServiceFactory.js';
+
 export const getIndexFactory = ({
+  openapiTypesImportPath,
   servicesDirName,
   explicitImportExtensions,
 }: {
   servicesDirName: string;
   explicitImportExtensions: boolean;
-}) => {
+} & Partial<Pick<ServiceImportsFactoryOptions, 'openapiTypesImportPath'>>) => {
   const factory = ts.factory;
   const importExtension = explicitImportExtensions ? '.js' : '';
 
   return [
+    ...(openapiTypesImportPath
+      ? [
+          factory.createExportDeclaration(
+            undefined,
+            true,
+            undefined,
+            factory.createStringLiteral(
+              maybeResolveImport({ openapiTypesImportPath, servicesDirName })
+            ),
+            undefined
+          ),
+        ]
+      : []),
     factory.createExportDeclaration(
       undefined,
       false,
@@ -56,3 +72,23 @@ export const getIndexFactory = ({
     ),
   ];
 };
+
+/**
+ * Resolve the import path if it's a relative path.
+ * Normally,`openapiTypesImportPath` is a relative path to services directory.
+ */
+export function maybeResolveImport<T extends string | undefined>({
+  openapiTypesImportPath,
+  servicesDirName,
+}: {
+  openapiTypesImportPath: T;
+  servicesDirName: string;
+}) {
+  if (openapiTypesImportPath?.startsWith('../')) {
+    return `./${openapiTypesImportPath.slice(3)}`;
+  } else if (openapiTypesImportPath?.startsWith('./')) {
+    return `./${servicesDirName}/${openapiTypesImportPath.slice(2)}`;
+  }
+
+  return openapiTypesImportPath;
+}

package/src/ts-factory/getServiceFactory.ts

@@ -182,6 +182,22 @@ const getOperationSchemaFactory = (operation: ServiceOperation) => {
             )
           )
         : null,
+
+      operation.security
+        ? factory.createPropertySignature(
+            undefined,
+            factory.createIdentifier('security'),
+            undefined,
+            factory.createTupleTypeNode(
+              getOperationSecuritySchemas(operation.security).map(
+                (securitySchemaName) =>
+                  factory.createLiteralTypeNode(
+                    factory.createStringLiteral(securitySchemaName)
+                  )
+              )
+            )
+          )
+        : null,
     ].filter((node): node is NonNullable<typeof node> => Boolean(node))
   );
 };
@@ -382,6 +398,18 @@ const getServiceVariablePropertyFactory = (operation: ServiceOperation) => {
                     factory.createStringLiteral(operation.mediaType)
                   )
                 : null,
+
+              operation.security
+                ? factory.createPropertyAssignment(
+                    factory.createIdentifier('security'),
+                    factory.createArrayLiteralExpression(
+                      getOperationSecuritySchemas(operation.security).map(
+                        (securitySchemaName) =>
+                          factory.createStringLiteral(securitySchemaName)
+                      )
+                    )
+                  )
+                : null,
             ].filter((node): node is NonNullable<typeof node> => Boolean(node)),
             true
           )
@@ -408,3 +436,10 @@ const createMultilineComment = (comment: string[]) => {
 
   return '';
 };
+
+const getOperationSecuritySchemas = (
+  security: NonNullable<ServiceOperation['security']>
+) =>
+  security.flatMap((security) =>
+    Object.keys(security).map((securitySchemaName) => securitySchemaName)
+  );

package/dist/__snapshots__/create-api-client.ts.snapshot.d.ts

@@ -1 +0,0 @@
-export default function (): void;