match endpoints with a function, exclude endpoints (#1713)

Co-authored-by: Matt Sutkowski <msutkowski@gmail.com>

Author: lindapaiste

packages/rtk-query-codegen-openapi/src/generate.ts

@@ -15,7 +15,7 @@ import {
 } from 'oazapfts/lib/codegen/tscodegen';
 import type { OpenAPIV3 } from 'openapi-types';
 import { generateReactHooks } from './generators/react-hooks';
-import type { EndpointOverrides, GenerationOptions, OperationDefinition } from './types';
+import type { EndpointMatcher, EndpointOverrides, GenerationOptions, OperationDefinition, TextMatcher } from './types';
 import { capitalize, getOperationDefinitions, getV3Doc, isQuery as testIsQuery, removeUndefined } from './utils';
 import type { ObjectPropertyDefinitions } from './codegen';
 import { generateCreateApiCall, generateEndpointDefinition, generateImportNode } from './codegen';
@@ -33,22 +33,30 @@ function getOperationName({ verb, path, operation }: Pick<OperationDefinition, '
   return _getOperationName(verb, path, operation.operationId);
 }
 
-function patternMatches(pattern?: string | RegExp | (string | RegExp)[]) {
+function patternMatches(pattern?: TextMatcher) {
   const filters = Array.isArray(pattern) ? pattern : [pattern];
-  return function matcher(operationDefinition: OperationDefinition) {
+  return function matcher(operationName: string) {
     if (!pattern) return true;
-    const operationName = getOperationName(operationDefinition);
     return filters.some((filter) =>
       typeof filter === 'string' ? filter === operationName : filter?.test(operationName)
     );
   };
 }
 
+function operationMatches(pattern?: EndpointMatcher) {
+  const checkMatch = typeof pattern === 'function' ? pattern : patternMatches(pattern);
+  return function matcher(operationDefinition: OperationDefinition) {
+    if (!pattern) return true;
+    const operationName = getOperationName(operationDefinition);
+    return checkMatch(operationName, operationDefinition);
+  };
+}
+
 export function getOverrides(
   operation: OperationDefinition,
   endpointOverrides?: EndpointOverrides[]
 ): EndpointOverrides | undefined {
-  return endpointOverrides?.find((override) => patternMatches(override.pattern)(operation));
+  return endpointOverrides?.find((override) => operationMatches(override.pattern)(operation));
 }
 
 export async function generateApi(
@@ -70,7 +78,7 @@ export async function generateApi(
 
   const apiGen = new ApiGenerator(v3Doc, {});
 
-  const operationDefinitions = getOperationDefinitions(v3Doc).filter(patternMatches(filterEndpoints));
+  const operationDefinitions = getOperationDefinitions(v3Doc).filter(operationMatches(filterEndpoints));
 
   const resultFile = ts.createSourceFile(
     'someFileName.ts',

packages/rtk-query-codegen-openapi/src/types.ts

@@ -53,14 +53,20 @@ export interface CommonOptions {
   hooks?: boolean;
 }
 
+export type TextMatcher = string | RegExp | (string | RegExp)[];
+
+export type EndpointMatcherFunction = (operationName: string, operationDefinition: OperationDefinition) => boolean;
+
+export type EndpointMatcher = TextMatcher | EndpointMatcherFunction;
+
 export interface OutputFileOptions extends Partial<CommonOptions> {
   outputFile: string;
-  filterEndpoints?: string | RegExp | (string | RegExp)[];
+  filterEndpoints?: EndpointMatcher;
   endpointOverrides?: EndpointOverrides[];
 }
 
 export interface EndpointOverrides {
-  pattern: string | RegExp | (string | RegExp)[];
+  pattern: EndpointMatcher;
   type: 'mutation' | 'query';
 }
 

packages/rtk-query-codegen-openapi/test/generateEndpoints.test.ts

@@ -31,6 +31,26 @@ test('endpoint filtering', async () => {
   expect(api).toMatchSnapshot('should only have endpoints loginUser, placeOrder, getOrderById, deleteOrder');
 });
 
+test('endpoint filtering by function', async () => {
+  const api = await generateEndpoints({
+    apiFile: './fixtures/emptyApi.ts',
+    schemaFile: resolve(__dirname, 'fixtures/petstore.json'),
+    filterEndpoints: (name, endpoint) => name.match(/order/i) !== null && endpoint.verb === 'get',
+  });
+  expect(api).toMatch(/getOrderById:/);
+  expect(api).not.toMatch(/placeOrder:/);
+  expect(api).not.toMatch(/loginUser:/);
+});
+
+test('negated endpoint filtering', async () => {
+  const api = await generateEndpoints({
+    apiFile: './fixtures/emptyApi.ts',
+    schemaFile: resolve(__dirname, 'fixtures/petstore.json'),
+    filterEndpoints: (name) => !/user/i.test(name),
+  });
+  expect(api).not.toMatch(/loginUser:/);
+});
+
 test('endpoint overrides', async () => {
   const api = await generateEndpoints({
     apiFile: './fixtures/emptyApi.ts',