Merge pull request #1195 from hey-api/fix/tanstack-query-missing-import

fix: TanStack Query plugin using missing import for infinite query

Author: mrlubos

.changeset/orange-singers-drop.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: TanStack Query plugin using missing import for infinite query

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

@@ -1,6 +1,6 @@
 import type { IRSchemaObject } from './ir';
 
-export const paginationKeywordsRegExp = /^(cursor|offset|page|start)/;
+export const paginationKeywordsRegExp = /^(cursor|offset|page|start)$/;
 
 export interface Pagination {
   in: string;

packages/openapi-ts/src/openApi/index.ts

@@ -68,7 +68,7 @@ export const parseExperimental = ({
   config: Config;
   parserConfig: ParserConfig;
   spec: unknown;
-}) => {
+}): IRContext | undefined => {
   const context = new IRContext({
     config,
     parserConfig,
@@ -78,17 +78,15 @@ export const parseExperimental = ({
   switch (context.spec.openapi) {
     case '3.0.3':
       parseV3_0_3(context as IRContext<OpenApiV3_0_3>);
-      break;
+      return context;
     case '3.1.0':
       parseV3_1_0(context as IRContext<OpenApiV3_1_0>);
-      break;
+      return context;
     default:
       // TODO: parser - uncomment after removing legacy parser.
       // For now, we fall back to legacy parser if spec version
       // is not supported
-      break;
-    // throw new Error('Unsupported OpenAPI specification');
+      // throw new Error('Unsupported OpenAPI specification');
+      return;
   }
-
-  return context;
 };

packages/openapi-ts/src/plugins/@tanstack/query-core/plugin-legacy.ts

@@ -17,6 +17,7 @@ import {
 } from '../../../generate/services';
 import { relativeModulePath } from '../../../generate/utils';
 import type { IROperationObject } from '../../../ir/ir';
+import { paginationKeywordsRegExp } from '../../../ir/pagination';
 import { isOperationParameterRequired } from '../../../openApi';
 import { getOperationKey } from '../../../openApi/common/parser/operation';
 import type {
@@ -101,8 +102,6 @@ const getPaginationIn = (parameter: OperationParameter) => {
   }
 };
 
-const paginationWordsRegExp = /^(cursor|offset|page|start)/;
-
 const createInfiniteParamsFn = 'createInfiniteParams';
 const createQueryKeyFn = 'createQueryKey';
 const infiniteQueryOptionsFn = 'infiniteQueryOptions';
@@ -903,8 +902,8 @@ export const handlerLegacy: PluginLegacyHandler<
         let paginationField!: Model | OperationParameter;
 
         const paginationParameter = operation.parameters.find((parameter) => {
-          paginationWordsRegExp.lastIndex = 0;
-          if (paginationWordsRegExp.test(parameter.name)) {
+          paginationKeywordsRegExp.lastIndex = 0;
+          if (paginationKeywordsRegExp.test(parameter.name)) {
             paginationField = parameter;
             return true;
           }
@@ -919,17 +918,17 @@ export const handlerLegacy: PluginLegacyHandler<
               (model) => model.meta?.$ref === ref,
             );
             return refModel?.properties.find((property) => {
-              paginationWordsRegExp.lastIndex = 0;
-              if (paginationWordsRegExp.test(property.name)) {
+              paginationKeywordsRegExp.lastIndex = 0;
+              if (paginationKeywordsRegExp.test(property.name)) {
                 paginationField = property;
                 return true;
               }
             });
           }
 
           return parameter.properties.find((property) => {
-            paginationWordsRegExp.lastIndex = 0;
-            if (paginationWordsRegExp.test(property.name)) {
+            paginationKeywordsRegExp.lastIndex = 0;
+            if (paginationKeywordsRegExp.test(property.name)) {
               paginationField = property;
               return true;
             }

packages/openapi-ts/test/sample.cjs

@@ -11,8 +11,8 @@ const main = async () => {
     // debug: true,
     experimental_parser: true,
     // input: './test/spec/v3.json',
-    input: './test/spec/3.1.0/full.json',
-    // input: './test/spec/v2.json',
+    // input: './test/spec/3.1.0/full.json',
+    input: './test/spec/tanstack.json',
     // input: 'https://mongodb-mms-prod-build-server.s3.amazonaws.com/openapi/2caffd88277a4e27c95dcefc7e3b6a63a3b03297-v2-2023-11-15.json',
     // name: 'foo',
     output: {

packages/openapi-ts/test/spec/tanstack.json

@@ -0,0 +1,71 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "paths": {
+    "/api/search": {
+      "post": {
+        "operationId": "search",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/SearchRequest"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "SearchParamsRequest": {
+        "required": ["contractIds", "contractNumbers"],
+        "type": "object",
+        "properties": {
+          "contractIds": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "format": "uuid"
+            }
+          },
+          "contractNumbers": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "SearchRequest": {
+        "required": ["searchParameters"],
+        "type": "object",
+        "properties": {
+          "searchParameters": {
+            "$ref": "#/components/schemas/SearchParamsRequest"
+          },
+          "pageParameters": {
+            "$ref": "#/components/schemas/PageParameters"
+          }
+        }
+      },
+      "PageParameters": {
+        "type": "object",
+        "properties": {
+          "offset": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "limit": {
+            "type": "integer",
+            "format": "int32"
+          }
+        }
+      }
+    }
+  }
+}