Merge branch 'main' into fixing_nullable_dates_in_transformers

mrlubos · web-flow · commit abddb56803da · 2025-04-04T12:05:58.000+01:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -24,7 +24,7 @@ jobs:
         with:
           fetch-depth: 0
 
-      - uses: pnpm/action-setup@v4.0.0
+      - uses: pnpm/action-setup@v4.1.0
 
       - uses: actions/setup-node@v4
         with:
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -21,7 +21,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4.2.2
 
-      - uses: pnpm/action-setup@v4.0.0
+      - uses: pnpm/action-setup@v4.1.0
 
       - uses: actions/setup-node@v4
         with:
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -21,7 +21,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4.2.2
 
-      - uses: pnpm/action-setup@v4.0.0
+      - uses: pnpm/action-setup@v4.1.0
 
       - uses: actions/setup-node@v4
         with:
@@ -35,7 +35,7 @@ jobs:
         run: pnpm build
 
       - name: Create Release Pull Request
-        uses: changesets/action@v1.4.9
+        uses: changesets/action@v1.4.10
         with:
           publish: pnpm changeset publish
           version: pnpm changeset version
diff --git a/examples/openapi-ts-axios/package.json b/examples/openapi-ts-axios/package.json
@@ -16,7 +16,7 @@
     "@radix-ui/react-form": "0.1.1",
     "@radix-ui/react-icons": "1.3.2",
     "@radix-ui/themes": "3.1.6",
-    "axios": "1.7.9",
+    "axios": "1.8.2",
     "react": "19.0.0",
     "react-dom": "19.0.0"
   },
@@ -35,6 +35,6 @@
     "prettier": "3.4.2",
     "tailwindcss": "3.4.9",
     "typescript": "5.5.3",
-    "vite": "6.0.9"
+    "vite": "6.0.13"
   }
 }
diff --git a/examples/openapi-ts-fetch/package.json b/examples/openapi-ts-fetch/package.json
@@ -34,6 +34,6 @@
     "prettier": "3.4.2",
     "tailwindcss": "3.4.9",
     "typescript": "5.5.3",
-    "vite": "6.0.9"
+    "vite": "6.0.13"
   }
 }
diff --git a/examples/openapi-ts-nuxt/package.json b/examples/openapi-ts-nuxt/package.json
@@ -19,6 +19,6 @@
     "zod": "3.23.8"
   },
   "devDependencies": {
-    "vite": "6.0.9"
+    "vite": "6.0.13"
   }
 }
diff --git a/examples/openapi-ts-sample/package.json b/examples/openapi-ts-sample/package.json
@@ -34,6 +34,6 @@
     "prettier": "3.4.2",
     "tailwindcss": "3.4.9",
     "typescript": "5.5.3",
-    "vite": "6.0.9"
+    "vite": "6.0.13"
   }
 }
diff --git a/examples/openapi-ts-tanstack-react-query/package.json b/examples/openapi-ts-tanstack-react-query/package.json
@@ -36,6 +36,6 @@
     "prettier": "3.4.2",
     "tailwindcss": "3.4.9",
     "typescript": "5.5.3",
-    "vite": "6.0.9"
+    "vite": "6.0.13"
   }
 }
diff --git a/examples/openapi-ts-tanstack-svelte-query/package.json b/examples/openapi-ts-tanstack-svelte-query/package.json
@@ -37,7 +37,7 @@
     "svelte-check": "4.1.4",
     "typescript": "5.5.3",
     "typescript-eslint": "8.19.1",
-    "vite": "6.0.9",
+    "vite": "6.0.13",
     "vitest": "1.6.0"
   }
 }
diff --git a/examples/openapi-ts-tanstack-vue-query/package.json b/examples/openapi-ts-tanstack-vue-query/package.json
@@ -43,7 +43,7 @@
     "prettier": "3.4.2",
     "tailwindcss": "3.4.9",
     "typescript": "5.5.3",
-    "vite": "6.0.9",
+    "vite": "6.0.13",
     "vite-plugin-vue-devtools": "7.7.0",
     "vitest": "1.6.0",
     "vue-tsc": "2.2.0"
diff --git a/packages/client-axios/package.json b/packages/client-axios/package.json
@@ -72,6 +72,6 @@
   "devDependencies": {
     "@hey-api/client-core": "workspace:*",
     "@hey-api/openapi-ts": "workspace:*",
-    "axios": "1.7.9"
+    "axios": "1.8.2"
   }
 }
diff --git a/packages/client-nuxt/package.json b/packages/client-nuxt/package.json
@@ -69,6 +69,6 @@
     "@hey-api/client-core": "workspace:*",
     "@hey-api/openapi-ts": "workspace:*",
     "@nuxt/test-utils": "3.14.0",
-    "vite": "6.0.9"
+    "vite": "6.0.13"
   }
 }
diff --git a/packages/nuxt/package.json b/packages/nuxt/package.json
@@ -68,6 +68,6 @@
     "@nuxt/module-builder": "0.8.4",
     "@nuxt/schema": "3.14.1592",
     "@nuxt/test-utils": "3.14.0",
-    "vite": "6.0.9"
+    "vite": "6.0.13"
   }
 }
diff --git a/packages/openapi-ts-tests/package.json b/packages/openapi-ts-tests/package.json
@@ -43,7 +43,7 @@
     "@tanstack/vue-query": "5.62.12",
     "@types/cross-spawn": "6.0.6",
     "@types/express": "4.17.21",
-    "axios": "1.7.9",
+    "axios": "1.8.2",
     "cross-spawn": "7.0.5",
     "eslint": "9.17.0",
     "express": "4.21.0",
diff --git a/packages/openapi-ts/CHANGELOG.md b/packages/openapi-ts/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @hey-api/openapi-ts
 
+## 0.66.2
+
+### Patch Changes
+
+- [#1913](https://github.com/hey-api/openapi-ts/pull/1913) [`7cfa4a7`](https://github.com/hey-api/openapi-ts/commit/7cfa4a76b13ca97d49c5f0366ba7264f94753d8b) Thanks [@BogdanMaier](https://github.com/BogdanMaier)! - fix: prevent crash when optional pagination field is missing
+
 ## 0.66.1
 
 ### Patch Changes
diff --git a/packages/openapi-ts/package.json b/packages/openapi-ts/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@hey-api/openapi-ts",
-  "version": "0.66.1",
+  "version": "0.66.2",
   "description": "🚀 The OpenAPI to TypeScript codegen. Generate clients, SDKs, validators, and more.",
   "homepage": "https://heyapi.dev/",
   "repository": {
@@ -89,7 +89,7 @@
   "devDependencies": {
     "@types/cross-spawn": "6.0.6",
     "@types/express": "4.17.21",
-    "axios": "1.7.9",
+    "axios": "1.8.2",
     "cross-spawn": "7.0.5",
     "eslint": "9.17.0",
     "express": "4.21.0",
diff --git a/packages/openapi-ts/src/ir/__tests__/pagination.test.ts b/packages/openapi-ts/src/ir/__tests__/pagination.test.ts
@@ -1,7 +1,9 @@
-import { describe, expect, it } from 'vitest';
+import { describe, expect, it, vi } from 'vitest';
 
 import type { Config } from '../../types/config';
+import { operationPagination } from '../operation';
 import { getPaginationKeywordsRegExp } from '../pagination';
+import type { IR } from '../types';
 
 describe('paginationKeywordsRegExp', () => {
   const defaultScenarios: Array<{
@@ -66,9 +68,190 @@ describe('paginationKeywordsRegExp', () => {
       const pagination: Config['input']['pagination'] = {
         keywords: ['customPagination', 'pageSize', 'perPage'],
       };
-
       const paginationRegExp = getPaginationKeywordsRegExp(pagination);
       expect(paginationRegExp.test(value)).toEqual(result);
     },
   );
 });
+
+describe('operationPagination', () => {
+  const queryParam = (
+    name: string,
+    type: IR.SchemaObject['type'] = 'string',
+    pagination = false,
+  ): IR.ParameterObject => ({
+    explode: true,
+    location: 'query',
+    name,
+    schema: { type },
+    style: 'form',
+    ...(pagination ? { pagination: true } : {}),
+  });
+
+  const emptyContext = {} as IR.Context;
+
+  const baseOperationMeta = {
+    method: 'post' as const,
+    path: '/test' as const,
+  };
+
+  const queryScenarios: Array<{
+    hasPagination: boolean;
+    operation: IR.OperationObject;
+  }> = [
+    {
+      hasPagination: true,
+      operation: {
+        ...baseOperationMeta,
+        id: 'op1',
+        method: 'get',
+        parameters: {
+          query: {
+            page: queryParam('page', 'integer', true),
+          },
+        },
+      },
+    },
+    {
+      hasPagination: false,
+      operation: {
+        ...baseOperationMeta,
+        id: 'op2',
+        method: 'get',
+        parameters: {
+          query: {
+            sort: queryParam('sort', 'string'),
+          },
+        },
+      },
+    },
+  ];
+
+  it.each(queryScenarios)(
+    'query params for $operation.id → $hasPagination',
+    ({
+      hasPagination,
+      operation,
+    }: {
+      hasPagination: boolean;
+      operation: IR.OperationObject;
+    }) => {
+      const result = operationPagination({ context: emptyContext, operation });
+      expect(Boolean(result)).toEqual(hasPagination);
+    },
+  );
+
+  it('body.pagination === true returns entire body', () => {
+    const operation: IR.OperationObject = {
+      ...baseOperationMeta,
+      body: {
+        mediaType: 'application/json',
+        pagination: true,
+        schema: {
+          properties: {
+            page: { type: 'integer' },
+          },
+          type: 'object',
+        },
+      },
+      id: 'bodyTrue',
+    };
+
+    const result = operationPagination({ context: emptyContext, operation });
+
+    expect(result?.in).toEqual('body');
+    expect(result?.name).toEqual('body');
+    expect(result?.schema?.type).toEqual('object');
+  });
+
+  it('body.pagination = "pagination" returns the matching property', () => {
+    const operation: IR.OperationObject = {
+      ...baseOperationMeta,
+      body: {
+        mediaType: 'application/json',
+        pagination: 'pagination',
+        schema: {
+          properties: {
+            pagination: {
+              properties: {
+                page: { type: 'integer' },
+              },
+              type: 'object',
+            },
+          },
+          type: 'object',
+        },
+      },
+      id: 'bodyField',
+    };
+
+    const result = operationPagination({ context: emptyContext, operation });
+
+    expect(result?.in).toEqual('body');
+    expect(result?.name).toEqual('pagination');
+    expect(result?.schema?.type).toEqual('object');
+  });
+
+  it('resolves $ref and uses the resolved pagination property', () => {
+    const context: IR.Context = {
+      resolveIrRef: vi.fn().mockReturnValue({
+        properties: {
+          pagination: {
+            properties: {
+              page: { type: 'integer' },
+            },
+            type: 'object',
+          },
+        },
+        type: 'object',
+      }),
+    } as unknown as IR.Context;
+
+    const operation: IR.OperationObject = {
+      ...baseOperationMeta,
+      body: {
+        mediaType: 'application/json',
+        pagination: 'pagination',
+        schema: { $ref: '#/components/schemas/PaginationBody' },
+      },
+      id: 'refPagination',
+    };
+
+    const result = operationPagination({ context, operation });
+
+    expect(context.resolveIrRef).toHaveBeenCalledWith(
+      '#/components/schemas/PaginationBody',
+    );
+    expect(result?.in).toEqual('body');
+    expect(result?.name).toEqual('pagination');
+    expect(result?.schema?.type).toEqual('object');
+  });
+
+  it('falls back to query when pagination key not found in body', () => {
+    const operation: IR.OperationObject = {
+      ...baseOperationMeta,
+      body: {
+        mediaType: 'application/json',
+        pagination: 'pagination',
+        schema: {
+          properties: {
+            notPagination: { type: 'string' },
+          },
+          type: 'object',
+        },
+      },
+      id: 'fallback',
+      parameters: {
+        query: {
+          cursor: queryParam('cursor', 'string', true),
+        },
+      },
+    };
+
+    const result = operationPagination({ context: emptyContext, operation });
+
+    expect(result?.in).toEqual('query');
+    expect(result?.name).toEqual('cursor');
+    expect(result?.schema?.type).toEqual('string');
+  });
+});
diff --git a/packages/openapi-ts/src/ir/operation.ts b/packages/openapi-ts/src/ir/operation.ts
diff --git a/packages/vite-plugin/package.json b/packages/vite-plugin/package.json
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,6 @@`
`34`	`34`	`"prettier": "3.4.2",`
`35`	`35`	`"tailwindcss": "3.4.9",`
`36`	`36`	`"typescript": "5.5.3",`
`37`		`- "vite": "6.0.9"`
	`37`	`+ "vite": "6.0.13"`
`38`	`38`	`}`
`39`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,6 @@`
`19`	`19`	`"zod": "3.23.8"`
`20`	`20`	`},`
`21`	`21`	`"devDependencies": {`
`22`		`- "vite": "6.0.9"`
	`22`	`+ "vite": "6.0.13"`
`23`	`23`	`}`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,6 @@`
`36`	`36`	`"prettier": "3.4.2",`
`37`	`37`	`"tailwindcss": "3.4.9",`
`38`	`38`	`"typescript": "5.5.3",`
`39`		`- "vite": "6.0.9"`
	`39`	`+ "vite": "6.0.13"`
`40`	`40`	`}`
`41`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@`
`37`	`37`	`"svelte-check": "4.1.4",`
`38`	`38`	`"typescript": "5.5.3",`
`39`	`39`	`"typescript-eslint": "8.19.1",`
`40`		`- "vite": "6.0.9",`
	`40`	`+ "vite": "6.0.13",`
`41`	`41`	`"vitest": "1.6.0"`
`42`	`42`	`}`
`43`	`43`	`}`