test(pagination): add coverage for body and query fallback logic

Author: BogdanMaier

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,192 @@ describe('paginationKeywordsRegExp', () => {
       const pagination: Config['input']['pagination'] = {
         keywords: ['customPagination', 'pageSize', 'perPage'],
       };
-
       const paginationRegExp = getPaginationKeywordsRegExp(pagination);
       expect(paginationRegExp.test(value)).toEqual(result);
     },
   );
 });
+
+describe('operationPagination', () => {
+  const queryScenarios: Array<{
+    hasPagination: boolean;
+    operation: IR.OperationObject;
+  }> = [
+    {
+      hasPagination: true,
+      operation: {
+        id: 'op1',
+        method: 'get',
+        parameters: {
+          query: {
+            page: {
+              explode: true,
+              location: 'query',
+              name: 'page',
+              schema: { type: 'integer' },
+              style: 'form',
+            },
+            perPage: {
+              explode: true,
+              location: 'query',
+              name: 'perPage',
+              schema: { type: 'integer' },
+              style: 'form',
+            },
+          },
+        },
+        path: '/test',
+      },
+    },
+    {
+      hasPagination: false,
+      operation: {
+        id: 'op2',
+        method: 'get',
+        parameters: {
+          query: {
+            sort: {
+              explode: true,
+              location: 'query',
+              name: 'sort',
+              schema: { type: 'string' },
+              style: 'form',
+            },
+          },
+        },
+        path: '/test',
+      },
+    },
+  ];
+
+  it.each(queryScenarios)(
+    'query params for $operation.id → $hasPagination',
+    ({ hasPagination, operation }) => {
+      const result = operationPagination({ context: {} as any, operation });
+      expect(Boolean(result)).toEqual(hasPagination);
+    },
+  );
+
+  it('body.pagination === true returns entire body', () => {
+    const operation: IR.OperationObject = {
+      body: {
+        mediaType: 'application/json',
+        pagination: true,
+        schema: {
+          properties: {
+            page: { type: 'integer' },
+          },
+          type: 'object',
+        },
+      },
+      id: 'bodyTrue',
+      method: 'post',
+      path: '/test',
+    };
+
+    const result = operationPagination({ context: {} as any, 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 = {
+      body: {
+        mediaType: 'application/json',
+        pagination: 'pagination',
+        schema: {
+          properties: {
+            pagination: {
+              properties: {
+                page: { type: 'integer' },
+              },
+              type: 'object',
+            },
+          },
+          type: 'object',
+        },
+      },
+      id: 'bodyField',
+      method: 'post',
+      path: '/test',
+    };
+
+    const result = operationPagination({ context: {} as any, 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 = {
+      body: {
+        mediaType: 'application/json',
+        pagination: 'pagination',
+        schema: { $ref: '#/components/schemas/PaginationBody' },
+      },
+      id: 'refPagination',
+      method: 'post',
+      path: '/test',
+    };
+
+    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 = {
+      body: {
+        mediaType: 'application/json',
+        pagination: 'pagination',
+        schema: {
+          properties: {
+            notPagination: { type: 'string' },
+          },
+          type: 'object',
+        },
+      },
+      id: 'fallback',
+      method: 'post',
+      parameters: {
+        query: {
+          cursor: {
+            explode: true,
+            location: 'query',
+            name: 'cursor',
+            schema: { type: 'string' },
+            style: 'form',
+          },
+        },
+      },
+      path: '/test',
+    };
+
+    const result = operationPagination({ context: {} as any, operation });
+
+    expect(result?.in).toEqual('query');
+    expect(result?.schema?.properties?.cursor).toBeDefined();
+  });
+});