@7nohe/openapi-react-query-codegen 3.0.0-beta.3 → 3.0.0-beta.4

package/dist/cli.mjs

@@ -32,6 +32,7 @@ async function setupProgram() {
         .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", "1")
+        .option("--omitInitialPageParam", "Send no initial page parameter at all (overrides --initialPageParam)")
         .parse();
     const options = program.opts();
     await generate(options, version);

package/dist/common.mjs

@@ -52,6 +52,12 @@ export function BuildCommonTypeName(name) {
  * @returns The parsed number or NaN if the value is not a valid number.
  */
 export function safeParseNumber(value) {
+    // `Number("")` is 0, which would silently turn a blank option such as
+    // `--initialPageParam ""` into a numeric 0. Treat blank strings as NaN so
+    // callers keep the original value.
+    if (typeof value === "string" && value.trim() === "") {
+        return Number.NaN;
+    }
     const parsed = Number(value);
     if (!Number.isNaN(parsed) && Number.isFinite(parsed)) {
         return parsed;

package/dist/createSource.mjs

@@ -5,7 +5,7 @@ import { generateAllFiles } from "./tsmorph/index.mjs";
 /**
  * Create source files using ts-morph based generation.
  */
-export const createSource = async ({ outputPath, client, version, pageParam, nextPageParam, initialPageParam, }) => {
+export const createSource = async ({ outputPath, client, version, pageParam, nextPageParam, initialPageParam, omitInitialPageParam, }) => {
     // Initialize ts-morph project to read the generated OpenAPI client
     const project = new Project({
         skipAddingFilesFromTsConfig: true,
@@ -15,7 +15,7 @@ export const createSource = async ({ outputPath, client, version, pageParam, nex
     // Parse operations from the service file
     const operations = await parseOperations(project, pageParam);
     // Build generation context
-    const ctx = buildGenerationContext(project, client, pageParam, nextPageParam, initialPageParam, version);
+    const ctx = buildGenerationContext(project, client, pageParam, nextPageParam, initialPageParam, omitInitialPageParam, version);
     // Generate all files using ts-morph
     return generateAllFiles(operations, ctx);
 };

package/dist/generate.mjs

@@ -59,6 +59,7 @@ export async function generate(options, version) {
         pageParam: formattedOptions.pageParam,
         nextPageParam: formattedOptions.nextPageParam,
         initialPageParam: formattedOptions.initialPageParam.toString(),
+        omitInitialPageParam: formattedOptions.omitInitialPageParam ?? false,
     });
     await print(source, formattedOptions);
     const queriesOutputPath = buildQueriesOutputPath(options.output);

package/dist/parseOperations.mjs

@@ -96,7 +96,7 @@ export async function parseOperations(project, pageParam) {
 /**
  * Build generation context from project configuration.
  */
-export function buildGenerationContext(project, client, pageParam, nextPageParam, initialPageParam, version) {
+export function buildGenerationContext(project, client, pageParam, nextPageParam, initialPageParam, omitInitialPageParam, version) {
     const modelsFile = project
         .getSourceFiles()
         .find((sf) => sf.getFilePath().includes(modelsFileName));
@@ -117,6 +117,7 @@ export function buildGenerationContext(project, client, pageParam, nextPageParam
         pageParam,
         nextPageParam,
         initialPageParam,
+        omitInitialPageParam,
         version,
     };
 }

package/dist/tsmorph/buildQueryHooks.mjs

@@ -58,13 +58,22 @@ export function buildPagedQueryFn(op, ctx, castTData) {
     const thenClause = castTData
         ? ".then(response => response.data as TData) as TData"
         : ".then(response => response.data)";
-    return `({ pageParam }) => ${op.methodName}({ ...clientOptions, query: { ...clientOptions.query, ${ctx.pageParam}: pageParam as number }, throwOnError: true } as Options<${dataTypeName}, true>)${thenClause}`;
+    // When the initial page param is omitted, the first request must send no
+    // page param at all, so spread it in only once TanStack Query provides one.
+    const pageQuery = ctx.omitInitialPageParam
+        ? `...(pageParam === undefined ? {} : { ${ctx.pageParam}: pageParam as number })`
+        : `${ctx.pageParam}: pageParam as number`;
+    return `({ pageParam }) => ${op.methodName}({ ...clientOptions, query: { ...clientOptions.query, ${pageQuery} }, throwOnError: true } as Options<${dataTypeName}, true>)${thenClause}`;
 }
 /**
- * Format the initialPageParam literal. Emits a numeric literal when possible
- * so the inferred pageParam type matches what getNextPageParam returns.
+ * Format the initialPageParam literal. Emits `undefined` when the caller opted
+ * to omit it (#177); otherwise a numeric literal when possible so the inferred
+ * pageParam type matches what getNextPageParam returns.
  */
 export function formatInitialPageParam(ctx) {
+    if (ctx.omitInitialPageParam) {
+        return "undefined";
+    }
     return /^-?\d+$/.test(ctx.initialPageParam)
         ? ctx.initialPageParam
         : JSON.stringify(ctx.initialPageParam);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@7nohe/openapi-react-query-codegen",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-beta.4",
   "description": "OpenAPI React Query Codegen",
   "bin": {
     "openapi-rq": "dist/cli.mjs"