Merge pull request #1540 from hey-api/chore/nuxt-utils

chore: import identifier only when it's accessed
hey-api · Jan 9, 2025 · caa46ec · caa46ec
2 parents 0270ac8 + 20782ee
commit caa46ec
Show file tree

Hide file tree

Showing 63 changed files with 2,767 additions and 3,489 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -18,7 +18,9 @@ jobs:
     strategy:
       matrix:
         os: [macos-latest, ubuntu-latest, windows-latest]
-        node-version: [18.x, 20.x, 22.x]
+        # node-version: [18.x, 20.x, 22.x]
+        # tests decided to fail for Node 18 out of nowhere, disable for now
+        node-version: [20.x, 22.x]
     steps:
       - uses: actions/checkout@v4
 

diff --git a/.gitignore b/.gitignore
@@ -12,6 +12,8 @@ yarn-error.log*
 dist
 coverage
 .env
+.nuxt
+.output
 .svelte-kit
 
 # test files

diff --git a/.prettierignore b/.prettierignore
@@ -2,6 +2,8 @@
 **/node_modules
 **/templates
 **/dist
+**/.nuxt
+**/.output
 **/.svelte-kit
 **/.vitepress/cache
 **/.vitepress/dist

diff --git a/eslint.config.js b/eslint.config.js
@@ -53,6 +53,12 @@ export default tseslint.config(
       '@typescript-eslint/consistent-type-imports': 'off',
     },
   },
+  {
+    files: ['**/*.cjs'],
+    rules: {
+      '@typescript-eslint/no-require-imports': 'off',
+    },
+  },
   configPrettier,
   {
     ignores: [
@@ -65,6 +71,8 @@ export default tseslint.config(
       '**/test/e2e/generated/',
       '**/test/generated/',
       '**/__snapshots__/',
+      '**/.nuxt/',
+      '**/.output/',
       '**/.svelte-kit/',
       '**/.vitepress/cache',
       '**/.vitepress/dist',

diff --git a/packages/client-core/package.json b/packages/client-core/package.json
@@ -20,11 +20,11 @@
   },
   "scripts": {
     "prepublishOnly": "pnpm build",
-    "test:coverage": "vitest run --coverage",
-    "test:update": "vitest watch --update",
-    "test:watch": "vitest watch",
-    "test": "vitest run",
-    "typecheck": "tsc --noEmit"
+    "test:coverage:disabled": "vitest run --coverage",
+    "test:update:disabled": "vitest watch --update",
+    "test:watch:disabled": "vitest watch",
+    "test:disabled": "vitest run",
+    "typecheck:disabled": "tsc --noEmit"
   },
   "engines": {
     "node": "^18.0.0 || >=20.0.0"

diff --git a/packages/openapi-ts/bin/index.cjs b/packages/openapi-ts/bin/index.cjs
@@ -114,7 +114,7 @@ async function start() {
     if (!context[0] || !context[0].config.watch) {
       process.exit(0);
     }
-  } catch (error) {
+  } catch {
     process.exit(1);
   }
 }

diff --git a/packages/openapi-ts/src/generate/files.ts b/packages/openapi-ts/src/generate/files.ts
@@ -11,7 +11,7 @@ import type { StringCase } from '../types/config';
 import { stringCase } from '../utils/stringCase';
 import { ensureDirSync } from './utils';
 
-interface Identifier {
+export interface Identifier {
   /**
    * Did this function add a new property to the file's `identifiers` map?
    */

diff --git a/packages/openapi-ts/src/plugins/@hey-api/sdk/plugin.ts b/packages/openapi-ts/src/plugins/@hey-api/sdk/plugin.ts
@@ -36,17 +36,25 @@ interface Auth {
 }
 
 export const operationOptionsType = ({
-  identifierData,
+  context,
+  file,
+  operation,
   throwOnError,
 }: {
   context: IR.Context;
-  identifierData?: ReturnType<TypeScriptFile['identifier']>;
-  // TODO: refactor this so we don't need to import error type unless it's used here
-  identifierError?: ReturnType<TypeScriptFile['identifier']>;
+  file: TypeScriptFile;
+  operation: IR.OperationObject;
   throwOnError?: string;
 }) => {
+  const identifierData = importIdentifierData({ context, file, operation });
+
   const optionsName = clientApi.Options.name;
 
+  // if (context.config.client.name === '@hey-api/client-nuxt') {
+  //   const identifierError = importIdentifierError({ context, file, operation });
+  //   return `${optionsName}<${identifierData?.name || 'unknown'}, ${identifierError?.name || 'unknown'}, TComposable>`;
+  // }
+
   // TODO: refactor this to be more generic, works for now
   if (throwOnError) {
     return `${optionsName}<${identifierData?.name || 'unknown'}, ${throwOnError}>`;
@@ -444,10 +452,6 @@ const generateClassSdk = ({
   const sdks = new Map<string, Array<ts.MethodDeclaration>>();
 
   context.subscribe('operation', ({ operation }) => {
-    const identifierData = importIdentifierData({ context, file, operation });
-    // TODO: import error type only if we are sure we are going to use it
-    // const identifierError = importIdentifierError({ context, file, operation });
-
     const node = compiler.methodDeclaration({
       accessLevel: 'public',
       comment: [
@@ -468,8 +472,8 @@ const generateClassSdk = ({
           name: 'options',
           type: operationOptionsType({
             context,
-            identifierData,
-            // identifierError,
+            file,
+            operation,
             throwOnError: 'ThrowOnError',
           }),
         },
@@ -527,10 +531,6 @@ const generateFlatSdk = ({
   const file = context.file({ id: sdkId })!;
 
   context.subscribe('operation', ({ operation }) => {
-    const identifierData = importIdentifierData({ context, file, operation });
-    // TODO: import error type only if we are sure we are going to use it
-    // const identifierError = importIdentifierError({ context, file, operation });
-
     const node = compiler.constVariable({
       comment: [
         operation.deprecated && '@deprecated',
@@ -545,8 +545,8 @@ const generateFlatSdk = ({
             name: 'options',
             type: operationOptionsType({
               context,
-              identifierData,
-              // identifierError,
+              file,
+              operation,
               throwOnError: 'ThrowOnError',
             }),
           },

diff --git a/packages/openapi-ts/src/plugins/@hey-api/typescript/ref.ts b/packages/openapi-ts/src/plugins/@hey-api/typescript/ref.ts
@@ -1,9 +1,22 @@
-import type { TypeScriptFile } from '../../../generate/files';
+import type { Identifier, TypeScriptFile } from '../../../generate/files';
 import type { IR } from '../../../ir/types';
 import { operationIrRef } from '../../shared/utils/ref';
 
 export const typesId = 'types';
 
+function refIdentifier<T extends Identifier>(
+  identifier: T,
+  onGet?: (identifier: T) => void,
+): T {
+  return {
+    ...identifier,
+    get name() {
+      onGet?.(identifier);
+      return identifier.name;
+    },
+  };
+}
+
 export const importIdentifierData = ({
   context,
   file,
@@ -12,19 +25,20 @@ export const importIdentifierData = ({
   context: IR.Context;
   file: TypeScriptFile;
   operation: IR.OperationObject;
-}): ReturnType<TypeScriptFile['identifier']> => {
+}): Identifier => {
   const identifierData = context.file({ id: 'types' })!.identifier({
     $ref: operationIrRef({ id: operation.id, type: 'data' }),
     namespace: 'type',
   });
-  if (identifierData.name) {
-    file.import({
-      asType: true,
-      module: file.relativePathToFile({ context, id: 'types' }),
-      name: identifierData.name,
-    });
-  }
-  return identifierData;
+  return refIdentifier(identifierData, (identifier) => {
+    if (identifier.name) {
+      file.import({
+        asType: true,
+        module: file.relativePathToFile({ context, id: 'types' }),
+        name: identifier.name,
+      });
+    }
+  });
 };
 
 export const importIdentifierError = ({
@@ -35,19 +49,20 @@ export const importIdentifierError = ({
   context: IR.Context;
   file: TypeScriptFile;
   operation: IR.OperationObject;
-}): ReturnType<TypeScriptFile['identifier']> => {
+}): Identifier => {
   const identifierError = context.file({ id: 'types' })!.identifier({
     $ref: operationIrRef({ id: operation.id, type: 'error' }),
     namespace: 'type',
   });
-  if (identifierError.name) {
-    file.import({
-      asType: true,
-      module: file.relativePathToFile({ context, id: 'types' }),
-      name: identifierError.name,
-    });
-  }
-  return identifierError;
+  return refIdentifier(identifierError, (identifier) => {
+    if (identifier.name) {
+      file.import({
+        asType: true,
+        module: file.relativePathToFile({ context, id: 'types' }),
+        name: identifier.name,
+      });
+    }
+  });
 };
 
 export const importIdentifierResponse = ({
@@ -58,17 +73,18 @@ export const importIdentifierResponse = ({
   context: IR.Context;
   file: TypeScriptFile;
   operation: IR.OperationObject;
-}): ReturnType<TypeScriptFile['identifier']> => {
+}): Identifier => {
   const identifierResponse = context.file({ id: 'types' })!.identifier({
     $ref: operationIrRef({ id: operation.id, type: 'response' }),
     namespace: 'type',
   });
-  if (identifierResponse.name) {
-    file.import({
-      asType: true,
-      module: file.relativePathToFile({ context, id: 'types' }),
-      name: identifierResponse.name,
-    });
-  }
-  return identifierResponse;
+  return refIdentifier(identifierResponse, (identifier) => {
+    if (identifier.name) {
+      file.import({
+        asType: true,
+        module: file.relativePathToFile({ context, id: 'types' }),
+        name: identifier.name,
+      });
+    }
+  });
 };
diff --git a/packages/openapi-ts/src/plugins/@tanstack/query-core/useType.ts b/packages/openapi-ts/src/plugins/@tanstack/query-core/useType.ts
@@ -2,7 +2,6 @@ import type { ImportExportItemObject } from '../../../compiler/utils';
 import type { IR } from '../../../ir/types';
 import { operationOptionsType } from '../../@hey-api/sdk/plugin';
 import {
-  importIdentifierData,
   importIdentifierError,
   importIdentifierResponse,
 } from '../../@hey-api/typescript/ref';
@@ -19,14 +18,10 @@ export const useTypeData = ({
 }) => {
   const file = context.file({ id: plugin.name })!;
 
-  const identifierData = importIdentifierData({ context, file, operation });
-  // TODO: import error type only if we are sure we are going to use it
-  // const identifierError = importIdentifierError({ context, file, operation });
-
   const typeData = operationOptionsType({
     context,
-    identifierData,
-    // identifierError,
+    file,
+    operation,
   });
   return typeData;
 };

diff --git a/packages/openapi-ts/test/__snapshots__/2.0.x/plugins/@hey-api/sdk/default/sdk.gen.ts b/packages/openapi-ts/test/__snapshots__/2.0.x/plugins/@hey-api/sdk/default/sdk.gen.ts
@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
 import { createClient, createConfig, type Options } from '@hey-api/client-fetch';
-import type { ServiceWithEmptyTagData, DeleteCallWithoutParametersAndResponseData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, OptionsCallWithoutParametersAndResponseData, PatchCallWithoutParametersAndResponseData, PostCallWithoutParametersAndResponseData, PutCallWithoutParametersAndResponseData, CallWithDescriptionsData, CallWithParametersData, CallWithWeirdParameterNamesData, CallWithDefaultParametersData, CallWithDefaultOptionalParametersData, CallToTestOrderOfParamsData, DuplicateNameData, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, CallWithNoContentResponseData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponse, DummyAData, DummyBData, CallWithResponseData, CallWithResponseResponse, CallWithDuplicateResponsesData, CallWithDuplicateResponsesError, CallWithDuplicateResponsesResponse, CallWithResponsesData, CallWithResponsesError, CallWithResponsesResponse, CollectionFormatData, TypesData, TypesResponse, ComplexTypesData, ComplexTypesResponse, CallWithResultFromHeaderData, TestErrorCodeData, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, PostApiVbyApiVersionBodyData, PostApiVbyApiVersionBodyError, PostApiVbyApiVersionBodyResponse } from './types.gen';
+import type { ServiceWithEmptyTagData, DeleteCallWithoutParametersAndResponseData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, OptionsCallWithoutParametersAndResponseData, PatchCallWithoutParametersAndResponseData, PostCallWithoutParametersAndResponseData, PutCallWithoutParametersAndResponseData, CallWithDescriptionsData, CallWithParametersData, CallWithWeirdParameterNamesData, CallWithDefaultParametersData, CallWithDefaultOptionalParametersData, CallToTestOrderOfParamsData, DuplicateNameData, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, CallWithNoContentResponseData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponse, DummyAData, DummyBData, CallWithResponseData, CallWithResponseResponse, CallWithDuplicateResponsesData, CallWithDuplicateResponsesResponse, CallWithDuplicateResponsesError, CallWithResponsesData, CallWithResponsesResponse, CallWithResponsesError, CollectionFormatData, TypesData, TypesResponse, ComplexTypesData, ComplexTypesResponse, CallWithResultFromHeaderData, TestErrorCodeData, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, PostApiVbyApiVersionBodyData, PostApiVbyApiVersionBodyResponse, PostApiVbyApiVersionBodyError } from './types.gen';
 
 export const client = createClient(createConfig());
 

diff --git a/packages/openapi-ts/test/__snapshots__/2.0.x/plugins/@hey-api/sdk/throwOnError/sdk.gen.ts b/packages/openapi-ts/test/__snapshots__/2.0.x/plugins/@hey-api/sdk/throwOnError/sdk.gen.ts
@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
 import { createClient, createConfig, type Options } from '@hey-api/client-fetch';
-import type { ServiceWithEmptyTagData, DeleteCallWithoutParametersAndResponseData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, OptionsCallWithoutParametersAndResponseData, PatchCallWithoutParametersAndResponseData, PostCallWithoutParametersAndResponseData, PutCallWithoutParametersAndResponseData, CallWithDescriptionsData, CallWithParametersData, CallWithWeirdParameterNamesData, CallWithDefaultParametersData, CallWithDefaultOptionalParametersData, CallToTestOrderOfParamsData, DuplicateNameData, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, CallWithNoContentResponseData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponse, DummyAData, DummyBData, CallWithResponseData, CallWithResponseResponse, CallWithDuplicateResponsesData, CallWithDuplicateResponsesError, CallWithDuplicateResponsesResponse, CallWithResponsesData, CallWithResponsesError, CallWithResponsesResponse, CollectionFormatData, TypesData, TypesResponse, ComplexTypesData, ComplexTypesResponse, CallWithResultFromHeaderData, TestErrorCodeData, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, PostApiVbyApiVersionBodyData, PostApiVbyApiVersionBodyError, PostApiVbyApiVersionBodyResponse } from './types.gen';
+import type { ServiceWithEmptyTagData, DeleteCallWithoutParametersAndResponseData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, OptionsCallWithoutParametersAndResponseData, PatchCallWithoutParametersAndResponseData, PostCallWithoutParametersAndResponseData, PutCallWithoutParametersAndResponseData, CallWithDescriptionsData, CallWithParametersData, CallWithWeirdParameterNamesData, CallWithDefaultParametersData, CallWithDefaultOptionalParametersData, CallToTestOrderOfParamsData, DuplicateNameData, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, CallWithNoContentResponseData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponse, DummyAData, DummyBData, CallWithResponseData, CallWithResponseResponse, CallWithDuplicateResponsesData, CallWithDuplicateResponsesResponse, CallWithDuplicateResponsesError, CallWithResponsesData, CallWithResponsesResponse, CallWithResponsesError, CollectionFormatData, TypesData, TypesResponse, ComplexTypesData, ComplexTypesResponse, CallWithResultFromHeaderData, TestErrorCodeData, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, PostApiVbyApiVersionBodyData, PostApiVbyApiVersionBodyResponse, PostApiVbyApiVersionBodyError } from './types.gen';
 
 export const client = createClient(createConfig({
     throwOnError: true

diff --git a/.../test/__snapshots__/2.0.x/plugins/@tanstack/angular-query-experimental/asClass/sdk.gen.ts b/.../test/__snapshots__/2.0.x/plugins/@tanstack/angular-query-experimental/asClass/sdk.gen.ts
@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
 import { createClient, createConfig, type Options } from '@hey-api/client-fetch';
-import type { ServiceWithEmptyTagData, DeleteCallWithoutParametersAndResponseData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, OptionsCallWithoutParametersAndResponseData, PatchCallWithoutParametersAndResponseData, PostCallWithoutParametersAndResponseData, PutCallWithoutParametersAndResponseData, CallWithDescriptionsData, CallWithParametersData, CallWithWeirdParameterNamesData, CallWithDefaultParametersData, CallWithDefaultOptionalParametersData, CallToTestOrderOfParamsData, DuplicateNameData, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, CallWithNoContentResponseData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponse, DummyAData, DummyBData, CallWithResponseData, CallWithResponseResponse, CallWithDuplicateResponsesData, CallWithDuplicateResponsesError, CallWithDuplicateResponsesResponse, CallWithResponsesData, CallWithResponsesError, CallWithResponsesResponse, CollectionFormatData, TypesData, TypesResponse, ComplexTypesData, ComplexTypesResponse, CallWithResultFromHeaderData, TestErrorCodeData, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, PostApiVbyApiVersionBodyData, PostApiVbyApiVersionBodyError, PostApiVbyApiVersionBodyResponse } from './types.gen';
+import type { ServiceWithEmptyTagData, DeleteCallWithoutParametersAndResponseData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, OptionsCallWithoutParametersAndResponseData, PatchCallWithoutParametersAndResponseData, PostCallWithoutParametersAndResponseData, PutCallWithoutParametersAndResponseData, CallWithDescriptionsData, CallWithParametersData, CallWithWeirdParameterNamesData, CallWithDefaultParametersData, CallWithDefaultOptionalParametersData, CallToTestOrderOfParamsData, DuplicateNameData, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, CallWithNoContentResponseData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponse, DummyAData, DummyBData, CallWithResponseData, CallWithResponseResponse, CallWithDuplicateResponsesData, CallWithDuplicateResponsesResponse, CallWithDuplicateResponsesError, CallWithResponsesData, CallWithResponsesResponse, CallWithResponsesError, CollectionFormatData, TypesData, TypesResponse, ComplexTypesData, ComplexTypesResponse, CallWithResultFromHeaderData, TestErrorCodeData, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, PostApiVbyApiVersionBodyData, PostApiVbyApiVersionBodyResponse, PostApiVbyApiVersionBodyError } from './types.gen';
 
 export const client = createClient(createConfig());
 

diff --git a/...ts/test/__snapshots__/2.0.x/plugins/@tanstack/angular-query-experimental/axios/sdk.gen.ts b/...ts/test/__snapshots__/2.0.x/plugins/@tanstack/angular-query-experimental/axios/sdk.gen.ts
@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
 import { createClient, createConfig, type Options } from '@hey-api/client-axios';
-import type { ServiceWithEmptyTagData, DeleteCallWithoutParametersAndResponseData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, OptionsCallWithoutParametersAndResponseData, PatchCallWithoutParametersAndResponseData, PostCallWithoutParametersAndResponseData, PutCallWithoutParametersAndResponseData, CallWithDescriptionsData, CallWithParametersData, CallWithWeirdParameterNamesData, CallWithDefaultParametersData, CallWithDefaultOptionalParametersData, CallToTestOrderOfParamsData, DuplicateNameData, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, CallWithNoContentResponseData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponse, DummyAData, DummyBData, CallWithResponseData, CallWithResponseResponse, CallWithDuplicateResponsesData, CallWithDuplicateResponsesError, CallWithDuplicateResponsesResponse, CallWithResponsesData, CallWithResponsesError, CallWithResponsesResponse, CollectionFormatData, TypesData, TypesResponse, ComplexTypesData, ComplexTypesResponse, CallWithResultFromHeaderData, TestErrorCodeData, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, PostApiVbyApiVersionBodyData, PostApiVbyApiVersionBodyError, PostApiVbyApiVersionBodyResponse } from './types.gen';
+import type { ServiceWithEmptyTagData, DeleteCallWithoutParametersAndResponseData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, OptionsCallWithoutParametersAndResponseData, PatchCallWithoutParametersAndResponseData, PostCallWithoutParametersAndResponseData, PutCallWithoutParametersAndResponseData, CallWithDescriptionsData, CallWithParametersData, CallWithWeirdParameterNamesData, CallWithDefaultParametersData, CallWithDefaultOptionalParametersData, CallToTestOrderOfParamsData, DuplicateNameData, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, CallWithNoContentResponseData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponse, DummyAData, DummyBData, CallWithResponseData, CallWithResponseResponse, CallWithDuplicateResponsesData, CallWithDuplicateResponsesResponse, CallWithDuplicateResponsesError, CallWithResponsesData, CallWithResponsesResponse, CallWithResponsesError, CollectionFormatData, TypesData, TypesResponse, ComplexTypesData, ComplexTypesResponse, CallWithResultFromHeaderData, TestErrorCodeData, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, PostApiVbyApiVersionBodyData, PostApiVbyApiVersionBodyResponse, PostApiVbyApiVersionBodyError } from './types.gen';
 
 export const client = createClient(createConfig());
-Original file line number
+Diff line change
@@ Expand Up / @@ -12,6 +12,8 @@ yarn-error.log* @@
     dist
     coverage
     .env
+    .nuxt
+    .output
     .svelte-kit
     # test files
@@ Expand Down @@