refactor: update pagination keywords handling to support custom configuration

Author: fml09

packages/openapi-ts/src/ir/__tests__/pagination.test.ts

@@ -1,5 +1,6 @@
 import { describe, expect, it } from 'vitest';
 
+import type { Config } from '../../types/config';
 import { getPaginationKeywordsRegExp } from '../pagination';
 
 describe('paginationKeywordsRegExp', () => {
@@ -9,35 +10,35 @@ describe('paginationKeywordsRegExp', () => {
   }> = [
     {
       result: true,
-      value: 'after',
+      value: 'page',
     },
     {
       result: true,
-      value: 'before',
+      value: 'cursor',
     },
     {
       result: true,
-      value: 'cursor',
+      value: 'after',
     },
     {
       result: true,
-      value: 'offset',
+      value: 'before',
     },
     {
       result: true,
-      value: 'page',
+      value: 'offset',
     },
     {
       result: true,
       value: 'start',
     },
     {
       result: false,
-      value: 'my_start',
+      value: 'pageSize',
     },
     {
       result: false,
-      value: 'start_my',
+      value: 'perPage',
     },
   ];
 
@@ -49,4 +50,28 @@ describe('paginationKeywordsRegExp', () => {
       expect(paginationRegExp.test(value)).toEqual(result);
     },
   );
+
+  it('uses custom keywords from config', async () => {
+    const config: Config = {
+      input: {
+        pagination: {
+          keywords: ['customPagination', 'pageSize', 'perPage'],
+        },
+      },
+    } as Config;
+
+    const paginationRegExp = getPaginationKeywordsRegExp(config);
+
+    // Should match custom keywords
+    paginationRegExp.lastIndex = 0;
+    expect(paginationRegExp.test('customPagination')).toEqual(true);
+    paginationRegExp.lastIndex = 0;
+    expect(paginationRegExp.test('pageSize')).toEqual(true);
+    paginationRegExp.lastIndex = 0;
+    expect(paginationRegExp.test('perPage')).toEqual(true);
+
+    // Should not match default keywords
+    paginationRegExp.lastIndex = 0;
+    expect(paginationRegExp.test('page')).toEqual(false);
+  });
 });

packages/openapi-ts/src/ir/pagination.ts

@@ -1,6 +1,7 @@
+import type { Config } from '../types/config';
 import type { IR } from './types';
 
-const DEFAULT_PAGINATION_KEYWORDS = [
+export const DEFAULT_PAGINATION_KEYWORDS = [
   'after',
   'before',
   'cursor',
@@ -9,31 +10,13 @@ const DEFAULT_PAGINATION_KEYWORDS = [
   'start',
 ];
 
-let currentPaginationKeywords = DEFAULT_PAGINATION_KEYWORDS;
-
-export function setPaginationKeywords(
-  keywords: string[] = DEFAULT_PAGINATION_KEYWORDS,
-): void {
-  currentPaginationKeywords = keywords;
-}
-
-export function createPaginationKeywordsRegExp(keywords?: string[]): RegExp {
-  const keywordsToUse = keywords || currentPaginationKeywords;
-  const pattern = `^(${keywordsToUse.join('|')})$`;
+export function getPaginationKeywordsRegExp(config?: Config): RegExp {
+  const configKeywords = config?.input?.pagination?.keywords;
+  const keywords = configKeywords || DEFAULT_PAGINATION_KEYWORDS;
+  const pattern = `^(${keywords.join('|')})$`;
   return new RegExp(pattern);
 }
 
-let paginationKeywordsRegExp: RegExp | undefined;
-
-export function getPaginationKeywordsRegExp(): RegExp {
-  if (!paginationKeywordsRegExp) {
-    paginationKeywordsRegExp = createPaginationKeywordsRegExp(
-      currentPaginationKeywords,
-    );
-  }
-  return paginationKeywordsRegExp;
-}
-
 export interface Pagination {
   in: string;
   name: string;