@7nohe/openapi-react-query-codegen 1.6.0 → 1.6.1

package/README.md

@@ -42,24 +42,25 @@ Usage: openapi-rq [options]
 Generate React Query code based on OpenAPI
 
 Options:
-  -V, --version              output the version number
-  -i, --input <value>        OpenAPI specification, can be a path, url or string content (required)
-  -o, --output <value>       Output directory (default: "openapi")
-  -c, --client <value>       HTTP client to generate (choices: "angular", "axios", "fetch", "node", "xhr", default: "fetch")
-  --request <value>          Path to custom request file
-  --format <value>           Process output folder with formatter? (choices: "biome", "prettier")
-  --lint <value>             Process output folder with linter? (choices: "biome", "eslint")
-  --operationId              Use operation ID to generate operation names?
-  --serviceResponse <value>  Define shape of returned value from service calls (choices: "body", "response", default: "body")
-  --base <value>             Manually set base in OpenAPI config instead of inferring from server value
-  --enums <value>            Generate JavaScript objects from enum definitions? ['javascript', 'typescript', 'typescript+namespace']
-  --enums <value>            Generate JavaScript objects from enum definitions? (choices: "javascript", "typescript")
-  --useDateType              Use Date type instead of string for date types for models, this will not convert the data to a Date object
-  --debug                    Run in debug mode?
-  --noSchemas                Disable generating JSON schemas
-  --schemaType <value>       Type of JSON schema [Default: 'json'] (choices: "form", "json")
-  --pageParam <value>        Name of the query parameter used for pagination (default: "page")
-  --nextPageParam <value>    Name of the response parameter used for next page (default: "nextPage")
+  -V, --version               output the version number
+  -i, --input <value>         OpenAPI specification, can be a path, url or string content (required)
+  -o, --output <value>        Output directory (default: "openapi")
+  -c, --client <value>        HTTP client to generate (choices: "angular", "axios", "fetch", "node", "xhr", default: "fetch")
+  --request <value>           Path to custom request file
+  --format <value>            Process output folder with formatter? (choices: "biome", "prettier")
+  --lint <value>              Process output folder with linter? (choices: "biome", "eslint")
+  --operationId               Use operation ID to generate operation names?
+  --serviceResponse <value>   Define shape of returned value from service calls (choices: "body", "response", default: "body")
+  --base <value>              Manually set base in OpenAPI config instead of inferring from server value
+  --enums <value>             Generate JavaScript objects from enum definitions? ['javascript', 'typescript', 'typescript+namespace']
+  --enums <value>             Generate JavaScript objects from enum definitions? (choices: "javascript", "typescript")
+  --useDateType               Use Date type instead of string for date types for models, this will not convert the data to a Date object
+  --debug                     Run in debug mode?
+  --noSchemas                 Disable generating JSON schemas
+  --schemaType <value>        Type of JSON schema [Default: 'json'] (choices: "form", "json")
+  --pageParam <value>         Name of the query parameter used for pagination (default: "page")
+  --nextPageParam <value>     Name of the response parameter used for next page (default: "nextPage")
+  --initialPageParam <value>  Initial value for the pagination parameter (default: "1")
   -h, --help                 display help for command
 ```
 
@@ -241,6 +242,8 @@ export default App;
 
 This feature will generate a function in infiniteQueries.ts when the name specified by the `pageParam` option exists in the query parameters and the name specified by the `nextPageParam` option exists in the response.
 
+The `initialPageParam` option can be specified to set the intial page to load, defaults to 1. The `nextPageParam` supports dot notation for nested values (i.e. `meta.next`).
+
 Example Schema:
 
 ```yml

package/dist/cli.mjs

@@ -36,6 +36,7 @@ async function setupProgram() {
         .addOption(new Option("--schemaType <value>", "Type of JSON schema [Default: 'json']").choices(["form", "json"]))
         .option("--pageParam <value>", "Name of the query parameter used for pagination", "page")
         .option("--nextPageParam <value>", "Name of the response parameter used for next page", "nextPage")
+        .option("--initialPageParam <value>", "Initial page value to query", "initialPageParam")
         .parse();
     const options = program.opts();
     await generate(options, version);

package/dist/createExports.mjs

@@ -1,7 +1,7 @@
 import { createPrefetch } from "./createPrefetch.mjs";
 import { createUseMutation } from "./createUseMutation.mjs";
 import { createUseQuery } from "./createUseQuery.mjs";
-export const createExports = (service, pageParam, nextPageParam) => {
+export const createExports = (service, pageParam, nextPageParam, initialPageParam) => {
     const { klasses } = service;
     const methods = klasses.flatMap((k) => k.methods);
     const allGet = methods.filter((m) => m.httpMethodName.toUpperCase().includes("GET"));
@@ -9,7 +9,7 @@ export const createExports = (service, pageParam, nextPageParam) => {
     const allPut = methods.filter((m) => m.httpMethodName.toUpperCase().includes("PUT"));
     const allPatch = methods.filter((m) => m.httpMethodName.toUpperCase().includes("PATCH"));
     const allDelete = methods.filter((m) => m.httpMethodName.toUpperCase().includes("DELETE"));
-    const allGetQueries = allGet.map((m) => createUseQuery(m, pageParam, nextPageParam));
+    const allGetQueries = allGet.map((m) => createUseQuery(m, pageParam, nextPageParam, initialPageParam));
     const allPrefetchQueries = allGet.map((m) => createPrefetch(m));
     const allPostMutations = allPost.map((m) => createUseMutation(m));
     const allPutMutations = allPut.map((m) => createUseMutation(m));

package/dist/createSource.mjs

@@ -5,7 +5,7 @@ import { OpenApiRqFiles } from "./constants.mjs";
 import { createExports } from "./createExports.mjs";
 import { createImports } from "./createImports.mjs";
 import { getServices } from "./service.mjs";
-const createSourceFile = async (outputPath, serviceEndName, pageParam, nextPageParam) => {
+const createSourceFile = async (outputPath, serviceEndName, pageParam, nextPageParam, initialPageParam) => {
     const project = new Project({
         // Optionally specify compiler options, tsconfig.json, in-memory file system, and more here.
         // If you initialize with a tsconfig.json, then it will automatically populate the project
@@ -20,7 +20,7 @@ const createSourceFile = async (outputPath, serviceEndName, pageParam, nextPageP
         serviceEndName,
         project,
     });
-    const exports = createExports(service, pageParam, nextPageParam);
+    const exports = createExports(service, pageParam, nextPageParam, initialPageParam);
     const commonSource = ts.factory.createSourceFile([...imports, ...exports.allCommon], ts.factory.createToken(ts.SyntaxKind.EndOfFileToken), ts.NodeFlags.None);
     const commonImport = ts.factory.createImportDeclaration(undefined, ts.factory.createImportClause(false, ts.factory.createIdentifier("* as Common"), undefined), ts.factory.createStringLiteral(`./${OpenApiRqFiles.common}`), undefined);
     const commonExport = ts.factory.createExportDeclaration(undefined, false, undefined, ts.factory.createStringLiteral(`./${OpenApiRqFiles.common}`), undefined);
@@ -39,7 +39,7 @@ const createSourceFile = async (outputPath, serviceEndName, pageParam, nextPageP
         prefetchSource,
     };
 };
-export const createSource = async ({ outputPath, version, serviceEndName, pageParam, nextPageParam, }) => {
+export const createSource = async ({ outputPath, version, serviceEndName, pageParam, nextPageParam, initialPageParam, }) => {
     const queriesFile = ts.createSourceFile(`${OpenApiRqFiles.queries}.ts`, "", ts.ScriptTarget.Latest, false, ts.ScriptKind.TS);
     const infiniteQueriesFile = ts.createSourceFile(`${OpenApiRqFiles.infiniteQueries}.ts`, "", ts.ScriptTarget.Latest, false, ts.ScriptKind.TS);
     const commonFile = ts.createSourceFile(`${OpenApiRqFiles.common}.ts`, "", ts.ScriptTarget.Latest, false, ts.ScriptKind.TS);
@@ -50,7 +50,7 @@ export const createSource = async ({ outputPath, version, serviceEndName, pagePa
         newLine: ts.NewLineKind.LineFeed,
         removeComments: false,
     });
-    const { commonSource, mainSource, infiniteQueriesSource, suspenseSource, indexSource, prefetchSource, } = await createSourceFile(outputPath, serviceEndName, pageParam, nextPageParam);
+    const { commonSource, mainSource, infiniteQueriesSource, suspenseSource, indexSource, prefetchSource, } = await createSourceFile(outputPath, serviceEndName, pageParam, nextPageParam, initialPageParam);
     const comment = `// generated with @7nohe/openapi-react-query-codegen@${version} \n\n`;
     const commonResult = comment +
         printer.printNode(ts.EmitHint.Unspecified, commonSource, commonFile);

package/dist/createUseQuery.mjs

@@ -90,7 +90,7 @@ export function createQueryKeyFromMethod({ method, className, }) {
  * @param queryString The type of query to use from react-query
  * @param suffix The suffix to append to the hook name
  */
-export function createQueryHook({ queryString, suffix, responseDataType, requestParams, method, className, pageParam, nextPageParam, }) {
+export function createQueryHook({ queryString, suffix, responseDataType, requestParams, method, className, pageParam, nextPageParam, initialPageParam, }) {
     const methodName = getNameFromMethod(method);
     const customHookName = hookNameFromMethod({ method, className });
     const queryKey = createQueryKeyFromMethod({ method, className });
@@ -155,14 +155,14 @@ export function createQueryHook({ queryString, suffix, responseDataType, request
                             : ts.factory.createShorthandPropertyAssignment(ts.factory.createIdentifier(p.name))))),
                     ]
                     : undefined), ts.factory.createTypeReferenceNode(TData)))),
-                ...createInfiniteQueryParams(pageParam, nextPageParam),
+                ...createInfiniteQueryParams(pageParam, nextPageParam, initialPageParam),
                 ts.factory.createSpreadAssignment(ts.factory.createIdentifier("options")),
             ]),
         ]))),
     ], ts.NodeFlags.Const));
     return hookExport;
 }
-export const createUseQuery = ({ className, method, jsDoc }, pageParam, nextPageParam) => {
+export const createUseQuery = ({ className, method, jsDoc }, pageParam, nextPageParam, initialPageParam) => {
     const methodName = getNameFromMethod(method);
     const queryKey = createQueryKeyFromMethod({ method, className });
     const { apiResponse: defaultApiResponse, responseDataType } = createApiResponseType({
@@ -206,6 +206,7 @@ export const createUseQuery = ({ className, method, jsDoc }, pageParam, nextPage
             className,
             pageParam,
             nextPageParam,
+            initialPageParam,
         })
         : undefined;
     const hookWithJsDoc = addJSDocToNode(queryHook, jsDoc);
@@ -257,16 +258,20 @@ function queryKeyFn(queryKey, method) {
             : ts.factory.createArrayLiteralExpression([])))),
     ], false);
 }
-function createInfiniteQueryParams(pageParam, nextPageParam) {
+function createInfiniteQueryParams(pageParam, nextPageParam, initialPageParam = "1") {
     if (pageParam === undefined || nextPageParam === undefined) {
         return [];
     }
     return [
-        ts.factory.createPropertyAssignment(ts.factory.createIdentifier("initialPageParam"), ts.factory.createNumericLiteral(1)),
+        ts.factory.createPropertyAssignment(ts.factory.createIdentifier("initialPageParam"), ts.factory.createStringLiteral(initialPageParam)),
         ts.factory.createPropertyAssignment(ts.factory.createIdentifier("getNextPageParam"), 
         // (response) => (response as { nextPage: number }).nextPage,
         ts.factory.createArrowFunction(undefined, undefined, [
             ts.factory.createParameterDeclaration(undefined, undefined, ts.factory.createIdentifier("response"), undefined, undefined),
-        ], undefined, EqualsOrGreaterThanToken, ts.factory.createPropertyAccessExpression(ts.factory.createParenthesizedExpression(ts.factory.createAsExpression(ts.factory.createIdentifier("response"), ts.factory.createTypeReferenceNode(ts.factory.createIdentifier(`{ ${nextPageParam}: number }`)))), ts.factory.createIdentifier(nextPageParam)))),
+        ], undefined, EqualsOrGreaterThanToken, ts.factory.createPropertyAccessExpression(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)))), ts.factory.createIdentifier(nextPageParam)))),
     ];
 }

package/dist/generate.mjs

@@ -42,6 +42,7 @@ export async function generate(options, version) {
         serviceEndName: "Service", // we are hard coding this because changing the service end name was depreciated in @hey-api/openapi-ts
         pageParam: formattedOptions.pageParam,
         nextPageParam: formattedOptions.nextPageParam,
+        initialPageParam: formattedOptions.initialPageParam.toString(),
     });
     await print(source, formattedOptions);
     const queriesOutputPath = buildQueriesOutputPath(options.output);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@7nohe/openapi-react-query-codegen",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "description": "OpenAPI React Query Codegen",
   "keywords": [
     "codegen",
@@ -59,7 +59,7 @@
   "scripts": {
     "build": "rimraf dist && tsc -p tsconfig.json",
     "lint": "biome check .",
-    "lint:fix": "biome check --apply .",
+    "lint:fix": "biome check --write .",
     "preview": "npm run build && npm -C examples/react-app run generate:api",
     "release": "npx git-ensure -a && npx bumpp --commit --tag --push",
     "snapshot": "vitest --update",