From 03001cb7e5af033b04b2c00308520cdd46326298 Mon Sep 17 00:00:00 2001
From: Urata Daiki <7nohe@users.noreply.github.com>
Date: Tue, 21 Jan 2025 07:59:57 +0900
Subject: [PATCH 1/4] feat: Support string type for `pageParam` and
 `nextPageParam` options (#149)

---
 .../app/components/PaginatedPets.tsx          |   2 +-
 examples/nextjs-app/package.json              |   2 +-
 examples/petstore.yaml                        |  60 +++++++++-
 examples/react-app/package.json               |   2 +-
 lefthook.yml                                  |   2 +-
 src/cli.mts                                   |   6 +-
 src/createUseQuery.mts                        | 110 ++++++++++++++----
 tests/__snapshots__/createSource.test.ts.snap |  61 +++++++++-
 tests/__snapshots__/generate.test.ts.snap     |  73 ++++++++++++
 tests/createExports.test.ts                   |   6 +
 tests/inputs/petstore.yaml                    |  60 +++++++++-
 tests/service.test.ts                         |   1 +
 12 files changed, 344 insertions(+), 41 deletions(-)

diff --git a/examples/nextjs-app/app/components/PaginatedPets.tsx b/examples/nextjs-app/app/components/PaginatedPets.tsx
index bfaee46..e153082 100644
--- a/examples/nextjs-app/app/components/PaginatedPets.tsx
+++ b/examples/nextjs-app/app/components/PaginatedPets.tsx
@@ -22,7 +22,7 @@ export default function PaginatedPets() {
           </React.Fragment>
         ))}
       </ul>
-      {data?.pages.at(-1)?.nextPage && (
+      {data?.pages.at(-1)?.meta?.next && (
         <button
           type="button"
           onClick={() => fetchNextPage()}
diff --git a/examples/nextjs-app/package.json b/examples/nextjs-app/package.json
index 2d2eed1..52996aa 100644
--- a/examples/nextjs-app/package.json
+++ b/examples/nextjs-app/package.json
@@ -9,7 +9,7 @@
     "build": "next build",
     "start": "next start",
     "lint": "next lint",
-    "generate:api": "rimraf ./openapi && node ../../dist/cli.mjs -i ../petstore.yaml -c axios --request ./request.ts --format=biome --lint=biome"
+    "generate:api": "rimraf ./openapi && node ../../dist/cli.mjs -i ../petstore.yaml -c axios --request ./request.ts --format=biome --lint=biome --nextPageParam=meta.next"
   },
   "dependencies": {
     "@tanstack/react-query": "^5.32.1",
diff --git a/examples/petstore.yaml b/examples/petstore.yaml
index 2a038a1..b9c0f36 100644
--- a/examples/petstore.yaml
+++ b/examples/petstore.yaml
@@ -176,10 +176,62 @@ paths:
                     type: array
                     items:
                       $ref: '#/components/schemas/Pet'
-                  nextPage: 
-                    type: integer
-                    format: int32
-                    minimum: 1
+                  meta: 
+                    type: object
+                    properties:
+                      next: 
+                        type: integer
+                        format: int32
+                        minimum: 1
+                      total: 
+                        type: integer
+  /cursor-based-pets:
+    get:
+      description: |
+        Returns cursor-based pets from the system that the user has access to
+      operationId: findCursorBasedPets
+      parameters:
+        - name: page
+          in: query
+          description: string to start from
+          required: false
+          schema:
+            type: string
+        - name: tags
+          in: query
+          description: tags to filter by
+          required: false
+          style: form
+          schema:
+            type: array
+            items:
+              type: string
+        - name: limit
+          in: query
+          description: maximum number of results to return
+          required: false
+          schema:
+            type: integer
+            format: int32
+      responses:
+        '200':
+          description: pet response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  pets:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Pet'
+                  meta: 
+                    type: object
+                    properties:
+                      next: 
+                        type: string
+                      total: 
+                        type: integer
 
 components:
   schemas:
diff --git a/examples/react-app/package.json b/examples/react-app/package.json
index d5f8f7c..c502a38 100644
--- a/examples/react-app/package.json
+++ b/examples/react-app/package.json
@@ -9,7 +9,7 @@
     "dev:mock": "prism mock ../petstore.yaml --dynamic",
     "build": "tsc && vite build",
     "preview": "vite preview",
-    "generate:api": "rimraf ./openapi && node ../../dist/cli.mjs -i ../petstore.yaml -c axios --request ./request.ts --format=biome --lint=biome",
+    "generate:api": "rimraf ./openapi && node ../../dist/cli.mjs -i ../petstore.yaml -c axios --request ./request.ts --format=biome --lint=biome --nextPageParam=meta.next",
     "test:generated": "tsc -p ./tsconfig.openapi.json --noEmit"
   },
   "dependencies": {
diff --git a/lefthook.yml b/lefthook.yml
index 3e5f29e..01aa466 100644
--- a/lefthook.yml
+++ b/lefthook.yml
@@ -2,7 +2,7 @@ pre-commit:
   commands:
     check:
       glob: "*.{js,ts,cjs,mjs,d.cts,d.mts,jsx,tsx,json,jsonc}"
-      run: npx biome check --apply --no-errors-on-unmatched --files-ignore-unknown=true ./ && git update-index --again
+      run: npx biome check --write --no-errors-on-unmatched --files-ignore-unknown=true ./ && git update-index --again
     test:
       glob: "*.{js,ts,cjs,mjs,d.cts,d.mts,jsx,tsx,json,jsonc}"
       run: npx vitest run
diff --git a/src/cli.mts b/src/cli.mts
index c4ec10c..8025144 100644
--- a/src/cli.mts
+++ b/src/cli.mts
@@ -103,11 +103,7 @@ async function setupProgram() {
       "Name of the response parameter used for next page",
       "nextPage",
     )
-    .option(
-      "--initialPageParam <value>",
-      "Initial page value to query",
-      "initialPageParam",
-    )
+    .option("--initialPageParam <value>", "Initial page value to query", "1")
     .parse();
 
   const options = program.opts<LimitedUserConfig>();
diff --git a/src/createUseQuery.mts b/src/createUseQuery.mts
index 2dd225e..6a9488a 100644
--- a/src/createUseQuery.mts
+++ b/src/createUseQuery.mts
@@ -1,4 +1,4 @@
-import type { MethodDeclaration } from "ts-morph";
+import type { MethodDeclaration, Symbol as TMSymbol } from "ts-morph";
 import ts from "typescript";
 import {
   BuildCommonTypeName,
@@ -19,7 +19,10 @@ import { addJSDocToNode } from "./util.mjs";
 export const createApiResponseType = ({
   className,
   methodName,
-}: { className: string; methodName: string }) => {
+}: {
+  className: string;
+  methodName: string;
+}) => {
   /** Awaited<ReturnType<typeof myClass.myMethod>> */
   const awaitedResponseDataType = ts.factory.createTypeReferenceNode(
     ts.factory.createIdentifier("Awaited"),
@@ -44,7 +47,9 @@ export const createApiResponseType = ({
   const apiResponse = ts.factory.createTypeAliasDeclaration(
     [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
     ts.factory.createIdentifier(
-      `${capitalizeFirstLetter(className)}${capitalizeFirstLetter(methodName)}DefaultResponse`,
+      `${capitalizeFirstLetter(className)}${capitalizeFirstLetter(
+        methodName,
+      )}DefaultResponse`,
     ),
     undefined,
     awaitedResponseDataType,
@@ -146,7 +151,9 @@ export function createReturnTypeExport({
   return ts.factory.createTypeAliasDeclaration(
     [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
     ts.factory.createIdentifier(
-      `${capitalizeFirstLetter(className)}${capitalizeFirstLetter(methodName)}QueryResult`,
+      `${capitalizeFirstLetter(className)}${capitalizeFirstLetter(
+        methodName,
+      )}QueryResult`,
     ),
     [
       ts.factory.createTypeParameterDeclaration(
@@ -179,7 +186,11 @@ export function createQueryKeyExport({
   className,
   methodName,
   queryKey,
-}: { className: string; methodName: string; queryKey: string }) {
+}: {
+  className: string;
+  methodName: string;
+  queryKey: string;
+}) {
   return ts.factory.createVariableStatement(
     [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
     ts.factory.createVariableDeclarationList(
@@ -201,7 +212,10 @@ export function createQueryKeyExport({
 export function hookNameFromMethod({
   method,
   className,
-}: { method: MethodDeclaration; className: string }) {
+}: {
+  method: MethodDeclaration;
+  className: string;
+}) {
   const methodName = getNameFromMethod(method);
   return `use${className}${capitalizeFirstLetter(methodName)}`;
 }
@@ -209,12 +223,45 @@ export function hookNameFromMethod({
 export function createQueryKeyFromMethod({
   method,
   className,
-}: { method: MethodDeclaration; className: string }) {
+}: {
+  method: MethodDeclaration;
+  className: string;
+}) {
   const customHookName = hookNameFromMethod({ method, className });
   const queryKey = `${customHookName}Key`;
   return queryKey;
 }
 
+/**
+ * Extracts the type of the next page parameter from the given properties.
+ *
+ * @param properties The properties to search through.
+ * @param nextPageParam The name of the next page parameter.
+ * @returns The type of the next page parameter, if found.
+ */
+function findNextPageParamType(
+  properties: TMSymbol[] | undefined,
+  nextPageParam: string,
+): string | undefined {
+  if (!properties) return undefined;
+
+  for (const property of properties) {
+    if (property.getName() === nextPageParam) {
+      return property?.getDeclarations()?.at(0)?.getType()?.getText();
+    }
+
+    const type = property.getDeclarations().at(0)?.getType();
+    const nestedProperties = type?.getProperties();
+
+    if (!type?.isObject() || type.isArray()) continue;
+
+    const result = findNextPageParamType(nestedProperties, nextPageParam);
+    if (result) return result;
+  }
+
+  return undefined;
+}
+
 /**
  * Creates a custom hook for a query
  * @param queryString The type of query to use from react-query
@@ -260,6 +307,18 @@ export function createQueryHook({
   const responseDataTypeIdentifier =
     responseDataTypeRef.typeName as ts.Identifier;
 
+  const arg = method.getReturnType().getTypeArguments().at(0);
+
+  const nextPageParamTypePropetires = arg?.getProperties();
+
+  const nextPageParamType =
+    arg?.isObject() && nextPageParam
+      ? findNextPageParamType(
+          nextPageParamTypePropetires,
+          nextPageParam.split(".").at(-1) ?? "",
+        )
+      : undefined;
+
   const hookExport = ts.factory.createVariableStatement(
     [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
     ts.factory.createVariableDeclarationList(
@@ -430,7 +489,11 @@ export function createQueryHook({
                                                   "pageParam",
                                                 ),
                                                 ts.factory.createKeywordTypeNode(
-                                                  ts.SyntaxKind.NumberKeyword,
+                                                  p.type?.getText() === "number"
+                                                    ? ts.SyntaxKind
+                                                        .NumberKeyword
+                                                    : ts.SyntaxKind
+                                                        .StringKeyword,
                                                 ),
                                               ),
                                             )
@@ -453,6 +516,7 @@ export function createQueryHook({
                     pageParam,
                     nextPageParam,
                     initialPageParam,
+                    nextPageParamType,
                   ),
                   ts.factory.createSpreadAssignment(
                     ts.factory.createIdentifier("options"),
@@ -637,6 +701,7 @@ function createInfiniteQueryParams(
   pageParam?: string,
   nextPageParam?: string,
   initialPageParam = "1",
+  type?: string,
 ) {
   if (pageParam === undefined || nextPageParam === undefined) {
     return [];
@@ -667,18 +732,23 @@ function createInfiniteQueryParams(
           ts.factory.createParenthesizedExpression(
             ts.factory.createAsExpression(
               ts.factory.createIdentifier("response"),
-              nextPageParam.split(".").reduceRight((acc, segment) => {
-                return ts.factory.createTypeLiteralNode([
-                  ts.factory.createPropertySignature(
-                    undefined,
-                    ts.factory.createIdentifier(segment),
-                    undefined,
-                    acc,
-                  ),
-                ]);
-              }, ts.factory.createKeywordTypeNode(
-                ts.SyntaxKind.NumberKeyword,
-              ) as ts.TypeNode),
+              nextPageParam.split(".").reduceRight(
+                (acc, segment) => {
+                  return ts.factory.createTypeLiteralNode([
+                    ts.factory.createPropertySignature(
+                      undefined,
+                      ts.factory.createIdentifier(segment),
+                      undefined,
+                      acc,
+                    ),
+                  ]);
+                },
+                ts.factory.createKeywordTypeNode(
+                  type === "number"
+                    ? ts.SyntaxKind.NumberKeyword
+                    : ts.SyntaxKind.StringKeyword,
+                ) as ts.TypeNode,
+              ),
             ),
           ),
           ts.factory.createIdentifier(nextPageParam),
diff --git a/tests/__snapshots__/createSource.test.ts.snap b/tests/__snapshots__/createSource.test.ts.snap
index 65c2193..018cd2c 100644
--- a/tests/__snapshots__/createSource.test.ts.snap
+++ b/tests/__snapshots__/createSource.test.ts.snap
@@ -13,7 +13,7 @@ exports[`createSource > createSource 2`] = `
 
 import { type QueryClient, useQuery, useSuspenseQuery, useMutation, UseQueryResult, UseQueryOptions, UseMutationOptions, UseMutationResult } from "@tanstack/react-query";
 import { DefaultService } from "../requests/services.gen";
-import { Pet, NewPet, Error, FindPetsData, FindPetsResponse, AddPetData, AddPetResponse, GetNotDefinedResponse, PostNotDefinedResponse, FindPetByIdData, FindPetByIdResponse, DeletePetData, DeletePetResponse, FindPaginatedPetsData, FindPaginatedPetsResponse, $OpenApiTs } from "../requests/types.gen";
+import { Pet, NewPet, Error, FindPetsData, FindPetsResponse, AddPetData, AddPetResponse, GetNotDefinedResponse, PostNotDefinedResponse, FindPetByIdData, FindPetByIdResponse, DeletePetData, DeletePetResponse, FindPaginatedPetsData, FindPaginatedPetsResponse, FindCursorBasedPetsData, FindCursorBasedPetsResponse, $OpenApiTs } from "../requests/types.gen";
 export type DefaultServiceFindPetsDefaultResponse = Awaited<ReturnType<typeof DefaultService.findPets>>;
 export type DefaultServiceFindPetsQueryResult<TData = DefaultServiceFindPetsDefaultResponse, TError = unknown> = UseQueryResult<TData, TError>;
 export const useDefaultServiceFindPetsKey = "DefaultServiceFindPets";
@@ -39,6 +39,14 @@ export const UseDefaultServiceFindPaginatedPetsKeyFn = ({ limit, page, tags }: {
     page?: number;
     tags?: string[];
 } = {}, queryKey?: Array<unknown>) => [useDefaultServiceFindPaginatedPetsKey, ...(queryKey ?? [{ limit, page, tags }])];
+export type DefaultServiceFindCursorBasedPetsDefaultResponse = Awaited<ReturnType<typeof DefaultService.findCursorBasedPets>>;
+export type DefaultServiceFindCursorBasedPetsQueryResult<TData = DefaultServiceFindCursorBasedPetsDefaultResponse, TError = unknown> = UseQueryResult<TData, TError>;
+export const useDefaultServiceFindCursorBasedPetsKey = "DefaultServiceFindCursorBasedPets";
+export const UseDefaultServiceFindCursorBasedPetsKeyFn = ({ limit, page, tags }: {
+    limit?: number;
+    page?: string;
+    tags?: string[];
+} = {}, queryKey?: Array<unknown>) => [useDefaultServiceFindCursorBasedPetsKey, ...(queryKey ?? [{ limit, page, tags }])];
 export type DefaultServiceAddPetMutationResult = Awaited<ReturnType<typeof DefaultService.addPet>>;
 export type DefaultServicePostNotDefinedMutationResult = Awaited<ReturnType<typeof DefaultService.postNotDefined>>;
 export type DefaultServiceDeletePetMutationResult = Awaited<ReturnType<typeof DefaultService.deletePet>>;
@@ -51,7 +59,7 @@ exports[`createSource > createSource 3`] = `
 import * as Common from "./common";
 import { type QueryClient, useQuery, useSuspenseQuery, useMutation, UseQueryResult, UseQueryOptions, UseMutationOptions, UseMutationResult } from "@tanstack/react-query";
 import { DefaultService } from "../requests/services.gen";
-import { Pet, NewPet, Error, FindPetsData, FindPetsResponse, AddPetData, AddPetResponse, GetNotDefinedResponse, PostNotDefinedResponse, FindPetByIdData, FindPetByIdResponse, DeletePetData, DeletePetResponse, FindPaginatedPetsData, FindPaginatedPetsResponse, $OpenApiTs } from "../requests/types.gen";
+import { Pet, NewPet, Error, FindPetsData, FindPetsResponse, AddPetData, AddPetResponse, GetNotDefinedResponse, PostNotDefinedResponse, FindPetByIdData, FindPetByIdResponse, DeletePetData, DeletePetResponse, FindPaginatedPetsData, FindPaginatedPetsResponse, FindCursorBasedPetsData, FindCursorBasedPetsResponse, $OpenApiTs } from "../requests/types.gen";
 /**
 * Returns all pets from the system that the user has access to
 * Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
@@ -101,6 +109,21 @@ export const useDefaultServiceFindPaginatedPets = <TData = Common.DefaultService
     tags?: string[];
 } = {}, queryKey?: TQueryKey, options?: Omit<UseQueryOptions<TData, TError>, "queryKey" | "queryFn">) => useQuery<TData, TError>({ queryKey: Common.UseDefaultServiceFindPaginatedPetsKeyFn({ limit, page, tags }, queryKey), queryFn: () => DefaultService.findPaginatedPets({ limit, page, tags }) as TData, ...options });
 /**
+* Returns cursor-based pets from the system that the user has access to
+*
+* @param data The data for the request.
+* @param data.page string to start from
+* @param data.tags tags to filter by
+* @param data.limit maximum number of results to return
+* @returns unknown pet response
+* @throws ApiError
+*/
+export const useDefaultServiceFindCursorBasedPets = <TData = Common.DefaultServiceFindCursorBasedPetsDefaultResponse, TError = unknown, TQueryKey extends Array<unknown> = unknown[]>({ limit, page, tags }: {
+    limit?: number;
+    page?: string;
+    tags?: string[];
+} = {}, queryKey?: TQueryKey, options?: Omit<UseQueryOptions<TData, TError>, "queryKey" | "queryFn">) => useQuery<TData, TError>({ queryKey: Common.UseDefaultServiceFindCursorBasedPetsKeyFn({ limit, page, tags }, queryKey), queryFn: () => DefaultService.findCursorBasedPets({ limit, page, tags }) as TData, ...options });
+/**
 * Creates a new pet in the store. Duplicates are allowed
 * @param data The data for the request.
 * @param data.requestBody Pet to add to the store
@@ -140,7 +163,7 @@ exports[`createSource > createSource 4`] = `
 import * as Common from "./common";
 import { type QueryClient, useQuery, useSuspenseQuery, useMutation, UseQueryResult, UseQueryOptions, UseMutationOptions, UseMutationResult } from "@tanstack/react-query";
 import { DefaultService } from "../requests/services.gen";
-import { Pet, NewPet, Error, FindPetsData, FindPetsResponse, AddPetData, AddPetResponse, GetNotDefinedResponse, PostNotDefinedResponse, FindPetByIdData, FindPetByIdResponse, DeletePetData, DeletePetResponse, FindPaginatedPetsData, FindPaginatedPetsResponse, $OpenApiTs } from "../requests/types.gen";
+import { Pet, NewPet, Error, FindPetsData, FindPetsResponse, AddPetData, AddPetResponse, GetNotDefinedResponse, PostNotDefinedResponse, FindPetByIdData, FindPetByIdResponse, DeletePetData, DeletePetResponse, FindPaginatedPetsData, FindPaginatedPetsResponse, FindCursorBasedPetsData, FindCursorBasedPetsResponse, $OpenApiTs } from "../requests/types.gen";
 /**
 * Returns all pets from the system that the user has access to
 * Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
@@ -189,6 +212,21 @@ export const useDefaultServiceFindPaginatedPetsSuspense = <TData = Common.Defaul
     page?: number;
     tags?: string[];
 } = {}, queryKey?: TQueryKey, options?: Omit<UseQueryOptions<TData, TError>, "queryKey" | "queryFn">) => useSuspenseQuery<TData, TError>({ queryKey: Common.UseDefaultServiceFindPaginatedPetsKeyFn({ limit, page, tags }, queryKey), queryFn: () => DefaultService.findPaginatedPets({ limit, page, tags }) as TData, ...options });
+/**
+* Returns cursor-based pets from the system that the user has access to
+*
+* @param data The data for the request.
+* @param data.page string to start from
+* @param data.tags tags to filter by
+* @param data.limit maximum number of results to return
+* @returns unknown pet response
+* @throws ApiError
+*/
+export const useDefaultServiceFindCursorBasedPetsSuspense = <TData = Common.DefaultServiceFindCursorBasedPetsDefaultResponse, TError = unknown, TQueryKey extends Array<unknown> = unknown[]>({ limit, page, tags }: {
+    limit?: number;
+    page?: string;
+    tags?: string[];
+} = {}, queryKey?: TQueryKey, options?: Omit<UseQueryOptions<TData, TError>, "queryKey" | "queryFn">) => useSuspenseQuery<TData, TError>({ queryKey: Common.UseDefaultServiceFindCursorBasedPetsKeyFn({ limit, page, tags }, queryKey), queryFn: () => DefaultService.findCursorBasedPets({ limit, page, tags }) as TData, ...options });
 "
 `;
 
@@ -198,7 +236,7 @@ exports[`createSource > createSource 5`] = `
 import * as Common from "./common";
 import { type QueryClient, useQuery, useSuspenseQuery, useMutation, UseQueryResult, UseQueryOptions, UseMutationOptions, UseMutationResult } from "@tanstack/react-query";
 import { DefaultService } from "../requests/services.gen";
-import { Pet, NewPet, Error, FindPetsData, FindPetsResponse, AddPetData, AddPetResponse, GetNotDefinedResponse, PostNotDefinedResponse, FindPetByIdData, FindPetByIdResponse, DeletePetData, DeletePetResponse, FindPaginatedPetsData, FindPaginatedPetsResponse, $OpenApiTs } from "../requests/types.gen";
+import { Pet, NewPet, Error, FindPetsData, FindPetsResponse, AddPetData, AddPetResponse, GetNotDefinedResponse, PostNotDefinedResponse, FindPetByIdData, FindPetByIdResponse, DeletePetData, DeletePetResponse, FindPaginatedPetsData, FindPaginatedPetsResponse, FindCursorBasedPetsData, FindCursorBasedPetsResponse, $OpenApiTs } from "../requests/types.gen";
 /**
 * Returns all pets from the system that the user has access to
 * Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
@@ -247,5 +285,20 @@ export const prefetchUseDefaultServiceFindPaginatedPets = (queryClient: QueryCli
     page?: number;
     tags?: string[];
 } = {}) => queryClient.prefetchQuery({ queryKey: Common.UseDefaultServiceFindPaginatedPetsKeyFn({ limit, page, tags }), queryFn: () => DefaultService.findPaginatedPets({ limit, page, tags }) });
+/**
+* Returns cursor-based pets from the system that the user has access to
+*
+* @param data The data for the request.
+* @param data.page string to start from
+* @param data.tags tags to filter by
+* @param data.limit maximum number of results to return
+* @returns unknown pet response
+* @throws ApiError
+*/
+export const prefetchUseDefaultServiceFindCursorBasedPets = (queryClient: QueryClient, { limit, page, tags }: {
+    limit?: number;
+    page?: string;
+    tags?: string[];
+} = {}) => queryClient.prefetchQuery({ queryKey: Common.UseDefaultServiceFindCursorBasedPetsKeyFn({ limit, page, tags }), queryFn: () => DefaultService.findCursorBasedPets({ limit, page, tags }) });
 "
 `;
diff --git a/tests/__snapshots__/generate.test.ts.snap b/tests/__snapshots__/generate.test.ts.snap
index 94cd5be..b32c121 100644
--- a/tests/__snapshots__/generate.test.ts.snap
+++ b/tests/__snapshots__/generate.test.ts.snap
@@ -30,6 +30,14 @@ export const UseDefaultServiceFindPaginatedPetsKeyFn = ({ limit, page, tags }: {
   page?: number;
   tags?: string[];
 } = {}, queryKey?: Array<unknown>) => [useDefaultServiceFindPaginatedPetsKey, ...(queryKey ?? [{ limit, page, tags }])];
+export type DefaultServiceFindCursorBasedPetsDefaultResponse = Awaited<ReturnType<typeof DefaultService.findCursorBasedPets>>;
+export type DefaultServiceFindCursorBasedPetsQueryResult<TData = DefaultServiceFindCursorBasedPetsDefaultResponse, TError = unknown> = UseQueryResult<TData, TError>;
+export const useDefaultServiceFindCursorBasedPetsKey = "DefaultServiceFindCursorBasedPets";
+export const UseDefaultServiceFindCursorBasedPetsKeyFn = ({ limit, page, tags }: {
+  limit?: number;
+  page?: string;
+  tags?: string[];
+} = {}, queryKey?: Array<unknown>) => [useDefaultServiceFindCursorBasedPetsKey, ...(queryKey ?? [{ limit, page, tags }])];
 export type DefaultServiceAddPetMutationResult = Awaited<ReturnType<typeof DefaultService.addPet>>;
 export type DefaultServicePostNotDefinedMutationResult = Awaited<ReturnType<typeof DefaultService.postNotDefined>>;
 export type DefaultServiceDeletePetMutationResult = Awaited<ReturnType<typeof DefaultService.deletePet>>;
@@ -126,6 +134,26 @@ export const useDefaultServiceFindPaginatedPetsInfinite = <TData = InfiniteData<
     };
   }).meta.next, ...options
 });
+/**
+* Returns cursor-based pets from the system that the user has access to
+*
+* @param data The data for the request.
+* @param data.page string to start from
+* @param data.tags tags to filter by
+* @param data.limit maximum number of results to return
+* @returns unknown pet response
+* @throws ApiError
+*/
+export const useDefaultServiceFindCursorBasedPetsInfinite = <TData = InfiniteData<Common.DefaultServiceFindCursorBasedPetsDefaultResponse>, TError = unknown, TQueryKey extends Array<unknown> = unknown[]>({ limit, tags }: {
+  limit?: number;
+  tags?: string[];
+} = {}, queryKey?: TQueryKey, options?: Omit<UseInfiniteQueryOptions<TData, TError>, "queryKey" | "queryFn">) => useInfiniteQuery({
+  queryKey: Common.UseDefaultServiceFindCursorBasedPetsKeyFn({ limit, tags }, queryKey), queryFn: ({ pageParam }) => DefaultService.findCursorBasedPets({ limit, page: pageParam as string, tags }) as TData, initialPageParam: "initial", getNextPageParam: response => (response as {
+    meta: {
+      next: string;
+    };
+  }).meta.next, ...options
+});
 "
 `;
 
@@ -183,6 +211,21 @@ export const prefetchUseDefaultServiceFindPaginatedPets = (queryClient: QueryCli
   page?: number;
   tags?: string[];
 } = {}) => queryClient.prefetchQuery({ queryKey: Common.UseDefaultServiceFindPaginatedPetsKeyFn({ limit, page, tags }), queryFn: () => DefaultService.findPaginatedPets({ limit, page, tags }) });
+/**
+* Returns cursor-based pets from the system that the user has access to
+*
+* @param data The data for the request.
+* @param data.page string to start from
+* @param data.tags tags to filter by
+* @param data.limit maximum number of results to return
+* @returns unknown pet response
+* @throws ApiError
+*/
+export const prefetchUseDefaultServiceFindCursorBasedPets = (queryClient: QueryClient, { limit, page, tags }: {
+  limit?: number;
+  page?: string;
+  tags?: string[];
+} = {}) => queryClient.prefetchQuery({ queryKey: Common.UseDefaultServiceFindCursorBasedPetsKeyFn({ limit, page, tags }), queryFn: () => DefaultService.findCursorBasedPets({ limit, page, tags }) });
 "
 `;
 
@@ -242,6 +285,21 @@ export const useDefaultServiceFindPaginatedPets = <TData = Common.DefaultService
   tags?: string[];
 } = {}, queryKey?: TQueryKey, options?: Omit<UseQueryOptions<TData, TError>, "queryKey" | "queryFn">) => useQuery<TData, TError>({ queryKey: Common.UseDefaultServiceFindPaginatedPetsKeyFn({ limit, page, tags }, queryKey), queryFn: () => DefaultService.findPaginatedPets({ limit, page, tags }) as TData, ...options });
 /**
+* Returns cursor-based pets from the system that the user has access to
+*
+* @param data The data for the request.
+* @param data.page string to start from
+* @param data.tags tags to filter by
+* @param data.limit maximum number of results to return
+* @returns unknown pet response
+* @throws ApiError
+*/
+export const useDefaultServiceFindCursorBasedPets = <TData = Common.DefaultServiceFindCursorBasedPetsDefaultResponse, TError = unknown, TQueryKey extends Array<unknown> = unknown[]>({ limit, page, tags }: {
+  limit?: number;
+  page?: string;
+  tags?: string[];
+} = {}, queryKey?: TQueryKey, options?: Omit<UseQueryOptions<TData, TError>, "queryKey" | "queryFn">) => useQuery<TData, TError>({ queryKey: Common.UseDefaultServiceFindCursorBasedPetsKeyFn({ limit, page, tags }, queryKey), queryFn: () => DefaultService.findCursorBasedPets({ limit, page, tags }) as TData, ...options });
+/**
 * Creates a new pet in the store. Duplicates are allowed
 * @param data The data for the request.
 * @param data.requestBody Pet to add to the store
@@ -329,5 +387,20 @@ export const useDefaultServiceFindPaginatedPetsSuspense = <TData = Common.Defaul
   page?: number;
   tags?: string[];
 } = {}, queryKey?: TQueryKey, options?: Omit<UseQueryOptions<TData, TError>, "queryKey" | "queryFn">) => useSuspenseQuery<TData, TError>({ queryKey: Common.UseDefaultServiceFindPaginatedPetsKeyFn({ limit, page, tags }, queryKey), queryFn: () => DefaultService.findPaginatedPets({ limit, page, tags }) as TData, ...options });
+/**
+* Returns cursor-based pets from the system that the user has access to
+*
+* @param data The data for the request.
+* @param data.page string to start from
+* @param data.tags tags to filter by
+* @param data.limit maximum number of results to return
+* @returns unknown pet response
+* @throws ApiError
+*/
+export const useDefaultServiceFindCursorBasedPetsSuspense = <TData = Common.DefaultServiceFindCursorBasedPetsDefaultResponse, TError = unknown, TQueryKey extends Array<unknown> = unknown[]>({ limit, page, tags }: {
+  limit?: number;
+  page?: string;
+  tags?: string[];
+} = {}, queryKey?: TQueryKey, options?: Omit<UseQueryOptions<TData, TError>, "queryKey" | "queryFn">) => useSuspenseQuery<TData, TError>({ queryKey: Common.UseDefaultServiceFindCursorBasedPetsKeyFn({ limit, page, tags }, queryKey), queryFn: () => DefaultService.findCursorBasedPets({ limit, page, tags }) as TData, ...options });
 "
 `;
diff --git a/tests/createExports.test.ts b/tests/createExports.test.ts
index 2784f49..8232790 100644
--- a/tests/createExports.test.ts
+++ b/tests/createExports.test.ts
@@ -32,6 +32,8 @@ describe(fileName, () => {
       "DefaultServiceFindPetByIdQueryResult",
       "DefaultServiceFindPaginatedPetsDefaultResponse",
       "DefaultServiceFindPaginatedPetsQueryResult",
+      "DefaultServiceFindCursorBasedPetsDefaultResponse",
+      "DefaultServiceFindCursorBasedPetsQueryResult",
       "DefaultServiceAddPetMutationResult",
       "DefaultServicePostNotDefinedMutationResult",
       "DefaultServiceDeletePetMutationResult",
@@ -50,6 +52,8 @@ describe(fileName, () => {
       "UseDefaultServiceFindPetByIdKeyFn",
       "useDefaultServiceFindPaginatedPetsKey",
       "UseDefaultServiceFindPaginatedPetsKeyFn",
+      "useDefaultServiceFindCursorBasedPetsKey",
+      "UseDefaultServiceFindCursorBasedPetsKeyFn",
     ]);
 
     const mainExports = exports.mainExports.map(
@@ -61,6 +65,7 @@ describe(fileName, () => {
       "useDefaultServiceGetNotDefined",
       "useDefaultServiceFindPetById",
       "useDefaultServiceFindPaginatedPets",
+      "useDefaultServiceFindCursorBasedPets",
       "useDefaultServiceAddPet",
       "useDefaultServicePostNotDefined",
       "useDefaultServiceDeletePet",
@@ -75,6 +80,7 @@ describe(fileName, () => {
       "useDefaultServiceGetNotDefinedSuspense",
       "useDefaultServiceFindPetByIdSuspense",
       "useDefaultServiceFindPaginatedPetsSuspense",
+      "useDefaultServiceFindCursorBasedPetsSuspense",
     ]);
   });
 });
diff --git a/tests/inputs/petstore.yaml b/tests/inputs/petstore.yaml
index 2c067d8..91aa902 100644
--- a/tests/inputs/petstore.yaml
+++ b/tests/inputs/petstore.yaml
@@ -176,10 +176,62 @@ paths:
                     type: array
                     items:
                       $ref: '#/components/schemas/Pet'
-                  nextPage: 
-                    type: integer
-                    format: int32
-                    minimum: 1
+                  meta: 
+                    type: object
+                    properties:
+                      next: 
+                        type: integer
+                        format: int32
+                        minimum: 1
+                      total: 
+                        type: string
+  /cursor-based-pets:
+    get:
+      description: |
+        Returns cursor-based pets from the system that the user has access to
+      operationId: findCursorBasedPets
+      parameters:
+        - name: page
+          in: query
+          description: string to start from
+          required: false
+          schema:
+            type: string
+        - name: tags
+          in: query
+          description: tags to filter by
+          required: false
+          style: form
+          schema:
+            type: array
+            items:
+              type: string
+        - name: limit
+          in: query
+          description: maximum number of results to return
+          required: false
+          schema:
+            type: integer
+            format: int32
+      responses:
+        '200':
+          description: pet response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  pets:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Pet'
+                  meta: 
+                    type: object
+                    properties:
+                      next: 
+                        type: string
+                      total: 
+                        type: integer
 components:
   schemas:
     Pet:
diff --git a/tests/service.test.ts b/tests/service.test.ts
index d2f64b2..0022d9f 100644
--- a/tests/service.test.ts
+++ b/tests/service.test.ts
@@ -27,6 +27,7 @@ describe(fileName, () => {
       "findPetById",
       "deletePet",
       "findPaginatedPets",
+      "findCursorBasedPets",
     ]);
   });
 

From 7ae866ffb86905a72748eb80f16cc29d0a7dede4 Mon Sep 17 00:00:00 2001
From: Urata Daiki <7nohe@users.noreply.github.com>
Date: Tue, 21 Jan 2025 08:08:01 +0900
Subject: [PATCH 2/4] fix: Pass the `operationId` option correctly to
 `@hey-api/openapi-ts` (#151)

---
 examples/nextjs-app/package.json          |  2 +-
 examples/react-app/package.json           |  2 +-
 src/generate.mts                          |  1 +
 tests/__snapshots__/generate.test.ts.snap | 15 +++++++++++++++
 tests/generate.test.ts                    |  1 +
 5 files changed, 19 insertions(+), 2 deletions(-)

diff --git a/examples/nextjs-app/package.json b/examples/nextjs-app/package.json
index 52996aa..e798010 100644
--- a/examples/nextjs-app/package.json
+++ b/examples/nextjs-app/package.json
@@ -9,7 +9,7 @@
     "build": "next build",
     "start": "next start",
     "lint": "next lint",
-    "generate:api": "rimraf ./openapi && node ../../dist/cli.mjs -i ../petstore.yaml -c axios --request ./request.ts --format=biome --lint=biome --nextPageParam=meta.next"
+    "generate:api": "rimraf ./openapi && node ../../dist/cli.mjs -i ../petstore.yaml -c axios --request ./request.ts --format=biome --lint=biome --operationId --nextPageParam=meta.next"
   },
   "dependencies": {
     "@tanstack/react-query": "^5.32.1",
diff --git a/examples/react-app/package.json b/examples/react-app/package.json
index c502a38..57471b8 100644
--- a/examples/react-app/package.json
+++ b/examples/react-app/package.json
@@ -9,7 +9,7 @@
     "dev:mock": "prism mock ../petstore.yaml --dynamic",
     "build": "tsc && vite build",
     "preview": "vite preview",
-    "generate:api": "rimraf ./openapi && node ../../dist/cli.mjs -i ../petstore.yaml -c axios --request ./request.ts --format=biome --lint=biome --nextPageParam=meta.next",
+    "generate:api": "rimraf ./openapi && node ../../dist/cli.mjs -i ../petstore.yaml -c axios --request ./request.ts --format=biome --lint=biome --operationId --nextPageParam=meta.next",
     "test:generated": "tsc -p ./tsconfig.openapi.json --noEmit"
   },
   "dependencies": {
diff --git a/src/generate.mts b/src/generate.mts
index 6026d4f..8b63bb0 100644
--- a/src/generate.mts
+++ b/src/generate.mts
@@ -34,6 +34,7 @@ export async function generate(options: LimitedUserConfig, version: string) {
       export: true,
       response: formattedOptions.serviceResponse,
       asClass: true,
+      operationId: formattedOptions.operationId ?? false,
     },
     types: {
       dates: formattedOptions.useDateType,
diff --git a/tests/__snapshots__/generate.test.ts.snap b/tests/__snapshots__/generate.test.ts.snap
index b32c121..93aa29e 100644
--- a/tests/__snapshots__/generate.test.ts.snap
+++ b/tests/__snapshots__/generate.test.ts.snap
@@ -98,6 +98,21 @@ export const ensureUseDefaultServiceFindPaginatedPetsData = (queryClient: QueryC
   page?: number;
   tags?: string[];
 } = {}) => queryClient.ensureQueryData({ queryKey: Common.UseDefaultServiceFindPaginatedPetsKeyFn({ limit, page, tags }), queryFn: () => DefaultService.findPaginatedPets({ limit, page, tags }) });
+/**
+* Returns cursor-based pets from the system that the user has access to
+*
+* @param data The data for the request.
+* @param data.page string to start from
+* @param data.tags tags to filter by
+* @param data.limit maximum number of results to return
+* @returns unknown pet response
+* @throws ApiError
+*/
+export const ensureUseDefaultServiceFindCursorBasedPetsData = (queryClient: QueryClient, { limit, page, tags }: {
+  limit?: number;
+  page?: string;
+  tags?: string[];
+} = {}) => queryClient.ensureQueryData({ queryKey: Common.UseDefaultServiceFindCursorBasedPetsKeyFn({ limit, page, tags }), queryFn: () => DefaultService.findCursorBasedPets({ limit, page, tags }) });
 "
 `;
 
diff --git a/tests/generate.test.ts b/tests/generate.test.ts
index 71aaed5..b6d35ab 100644
--- a/tests/generate.test.ts
+++ b/tests/generate.test.ts
@@ -22,6 +22,7 @@ describe("generate", () => {
       pageParam: "page",
       nextPageParam: "meta.next",
       initialPageParam: "initial",
+      operationId: true,
     };
     await generate(options, "1.0.0");
   });

From 98558526f1c3b55a61ce06483b2ce6397f9f0453 Mon Sep 17 00:00:00 2001
From: Urata Daiki <7nohe@users.noreply.github.com>
Date: Thu, 23 Jan 2025 07:37:42 +0900
Subject: [PATCH 3/4] chore: Update release script to include version branch

---
 package.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/package.json b/package.json
index e51199f..af4c2af 100644
--- a/package.json
+++ b/package.json
@@ -32,7 +32,7 @@
     "lint:fix": "biome check --write .",
     "prepublishOnly": "npm run build",
     "preview": "npm run build && npm -C examples/react-app run generate:api",
-    "release": "npx git-ensure -a && npx bumpp --commit --tag --push",
+    "release": "npx git-ensure -a -b v1 && npx bumpp --commit --tag --push",
     "snapshot": "vitest --update",
     "test": "vitest --coverage.enabled true"
   },

From 169bb3220c49ebc0aac78744bc174122f34a453b Mon Sep 17 00:00:00 2001
From: Urata Daiki <7nohe@users.noreply.github.com>
Date: Thu, 23 Jan 2025 07:47:14 +0900
Subject: [PATCH 4/4] chore: release v1.6.2

---
 package.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/package.json b/package.json
index af4c2af..2f1d049 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@7nohe/openapi-react-query-codegen",
-  "version": "1.6.1",
+  "version": "1.6.2",
   "description": "OpenAPI React Query Codegen",
   "keywords": [
     "codegen",