@dudousxd/nestjs-codegen 0.14.1 → 0.15.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @dudousxd/nestjs-codegen
 
+## 0.15.0
+
+### Minor Changes
+
+- 20db5c0: Emit `filterFields` as a runtime `as const` array on each filter leaf, alongside the existing type-level union, plus an `isFilterField` type guard exported from the generated `api.ts`. Previously the filterable field set existed only as a type, so a field name arriving as a plain `string` from runtime state (a saved view, a user-picked column) could not be passed to `filterQuery().where()` without a cast. Now `api.route.leaf().filterFields` is a `readonly [...] as const` value and `isFilterField(leaf.filterFields, value)` narrows an arbitrary string to the field union, so dynamic field names validate at runtime instead of being asserted with `as`. The runtime array is generated from the same discovered field list as the type-level union (single source in the emitter), so the value can never drift from the type. Purely additive — the guard is emitted only when a route carries filter fields, and leaves without a filter gain no new member.
+- 9b5298b: Add a `@QueryList()` param decorator and a `toStringList` normalizer to the `/nest` subpath for receiving array query params safely. Express (and Nest's default query parser) returns a bare `string` for a single-value query param (`?ids=a`) and a `string[]` only for two or more (`?ids=a&ids=b`), so `ParseArrayPipe` 400s the common single-select case. `@QueryList('ids')` normalizes `string | string[] | comma-joined string | undefined` into a clean `string[]` (`['a']`, `['a','b']`, `[]`), and `toStringList` is exported for the equivalent `class-transformer` `@Transform` on a DTO field. Pairs with the client's `arrayFormat` option: once the client sends `arrayFormat: 'repeat'`, the comma-split becomes a no-op fallback that still covers hand-rolled and `curl` callers. Documented under a new "Receiving array query params" docs page.
+
+## 0.14.2
+
+### Patch Changes
+
+- 79d5e73: Fix a drift-guard false positive that permanently blocked incremental regeneration for shared configs: the config hash folded functions in via `toString()`, but the same shared config object yields different function source text per entry point (the CLI loads TS via Node's type stripping; the Nest module runs tsc/SWC-compiled dist), so a genuinely-shared config was flagged as drifted the moment both entry points touched the same outDir. Functions now hash by name only — every setting that can actually diverge is plain data and is still hashed in full. The drift error also now NAMES the top-level keys that differ (via new per-key hashes recorded in the manifest as `configKeyHashes`) instead of a generic example.
+
 ## 0.14.1
 
 ### Patch Changes

package/dist/cli/main.cjs

@@ -775,6 +775,9 @@ function buildErrorType(c) {
   }
   return c.contractSource.error ?? "unknown";
 }
+function filterFieldLiterals(fields) {
+  return fields?.length ? fields.map((f) => JSON.stringify(f)) : [];
+}
 function emitRouterTypeBlock(tree, indent, outDir, serialization) {
   const pad = " ".repeat(indent);
   const lines = [];
@@ -801,7 +804,8 @@ function emitRouterTypeBlock(tree, indent, outDir, serialization) {
       const params = buildParamsType(c.params);
       const safeMethod = JSON.stringify(method);
       const safeUrl = JSON.stringify(c.path);
-      const filterFields = c.contractSource.filterFields?.length ? c.contractSource.filterFields.map((f) => JSON.stringify(f)).join(" | ") : "never";
+      const filterLiterals = filterFieldLiterals(c.contractSource.filterFields);
+      const filterFields = filterLiterals.length ? filterLiterals.join(" | ") : "never";
       const stream = c.contractSource.stream ? "true" : "false";
       const binary = c.contractSource.binaryResponse ? "true" : "false";
       lines.push(
@@ -841,6 +845,7 @@ function buildRequestModel(c) {
   const TA = buildRouterTypeAccess(c.name);
   const withParams = hasPathParams(c.params);
   const { isGet, isQuery, hasBody, hasQuery } = requestShape(c.route);
+  const filterLiterals = filterFieldLiterals(c.contractSource.filterFields);
   const fields = [];
   if (withParams) fields.push(`params: ${TA}['params']`);
   if (hasQuery) fields.push(`query?: ${TA}['query']`);
@@ -870,7 +875,12 @@ function buildRequestModel(c) {
     // (`[name]` rather than `[name, undefined]`) so the bare `.queryKey()` is a
     // clean prefix that partial-matches every parametrized variant — making it
     // directly usable for `invalidateQueries`.
-    queryKeyExpr: `(input === undefined ? [${flat}] as const : [${flat}, input] as const)`
+    queryKeyExpr: `(input === undefined ? [${flat}] as const : [${flat}, input] as const)`,
+    // Runtime counterpart to the type-level `filterFields` union: the same
+    // discovered field list, emitted as a literal `[...] as const` so apps can
+    // validate a dynamic/user-supplied field string with `isFilterField(...)`
+    // instead of casting. Omitted for routes with no filter.
+    ...filterLiterals.length ? { filterFieldsExpr: `[${filterLiterals.join(", ")}] as const` } : {}
   };
 }
 function renderFetcherRequest(req, binaryResponse) {
@@ -905,9 +915,24 @@ function emitReqHelper() {
     ""
   ];
 }
+function emitFilterFieldGuard() {
+  return [
+    "/** Runtime guard: narrows `value` to one of the leaf's `filterFields` (a `readonly K[] as const`), so a dynamic field string can be passed to `.where()` without a cast. */",
+    "export function isFilterField<const K extends string>(",
+    "  fields: readonly K[],",
+    "  value: string,",
+    "): value is K {",
+    "  return (fields as readonly string[]).includes(value);",
+    "}",
+    ""
+  ];
+}
 function renderLeaf(pad, objKey, req, requestExpr, members, streamExpr) {
   const lines = [`${pad}${objKey}: (input?: ${req.inputType}) => ({`];
   lines.push(`${pad}  ...__req<${req.responseType}>(() => ${requestExpr}),`);
+  if (req.filterFieldsExpr) {
+    lines.push(`${pad}  filterFields: ${req.filterFieldsExpr},`);
+  }
   if (streamExpr) {
     lines.push(`${pad}  stream: () => ${streamExpr},`);
   }
@@ -1179,6 +1204,9 @@ function buildApiFile(routes, outDir, opts = {}) {
   lines.push("};");
   lines.push("");
   lines.push(...emitReqHelper());
+  if (contracted.some((r) => r.contract?.contractSource.filterFields?.length)) {
+    lines.push(...emitFilterFieldGuard());
+  }
   lines.push("export function createApi(fetcher: Fetcher) {");
   lines.push("  return {");
   lines.push(
@@ -2185,19 +2213,41 @@ function isManifestShape(value) {
   if (typeof candidate.hash !== "string") return false;
   if (candidate.entryPoint !== void 0 && !isEntryPoint(candidate.entryPoint)) return false;
   if (candidate.configHash !== void 0 && typeof candidate.configHash !== "string") return false;
+  if (candidate.configKeyHashes !== void 0 && !isStringRecord(candidate.configKeyHashes)) {
+    return false;
+  }
   if (!Array.isArray(candidate.files)) return false;
   return candidate.files.every((entry) => typeof entry === "string");
 }
+function isStringRecord(value) {
+  if (typeof value !== "object" || value === null || Array.isArray(value)) return false;
+  return Object.values(value).every((entry) => typeof entry === "string");
+}
 function serializeConfig(config) {
+  return serializeConfigValue(config, `unserializable:${config.codegen.outDir}`);
+}
+function serializeConfigValue(value, unserializableMarker) {
   try {
-    return JSON.stringify(config, (_key, value) => {
-      if (typeof value === "function") return `[fn:${value.name}]${value.toString()}`;
-      return value;
+    return JSON.stringify(value, (_key, entry) => {
+      if (typeof entry === "function") return `[fn:${entry.name}]`;
+      return entry;
     });
   } catch {
-    return `unserializable:${config.codegen.outDir}:${config.contracts.glob}`;
+    return unserializableMarker;
   }
 }
+function computeConfigKeyHashes(config) {
+  const hashes = {};
+  for (const [key, value] of Object.entries(config)) {
+    if (value === void 0) continue;
+    hashes[key] = (0, import_node_crypto.createHash)("sha256").update(serializeConfigValue(value, `unserializable:${key}`)).digest("hex");
+  }
+  return hashes;
+}
+function diffConfigKeyHashes(previous, current) {
+  const keys = /* @__PURE__ */ new Set([...Object.keys(previous), ...Object.keys(current)]);
+  return [...keys].filter((key) => previous[key] !== current[key]).sort();
+}
 async function discoverInputFiles(config) {
   const globs = [config.contracts.glob, config.forms.watch];
   if (config.pages) globs.push(config.pages.glob);
@@ -2232,6 +2282,7 @@ async function readManifest(outDir) {
       hash: parsed.hash,
       ...parsed.entryPoint ? { entryPoint: parsed.entryPoint } : {},
       ...parsed.configHash ? { configHash: parsed.configHash } : {},
+      ...parsed.configKeyHashes ? { configKeyHashes: parsed.configKeyHashes } : {},
       files: parsed.files
     };
   } catch {
@@ -2285,8 +2336,9 @@ function debugWarn(message) {
 }
 
 // src/generate.ts
-function driftGuardMessage(outDir, previousEntryPoint, currentEntryPoint) {
-  return `[nestjs-codegen] Config drift detected in "${outDir}": the last generate ran from the "${previousEntryPoint}" entry point, this run is from the "${currentEntryPoint}" entry point, and their resolved configs differ (e.g. \`serialization: "json"\` vs \`"superjson"\`). Both entry points must read the SAME config \u2014 export a shared config object (e.g. codegen.config.ts) and import it from BOTH nestjs-codegen.config.ts (CLI) and NestjsCodegenModule.forRoot() (Nest module), or set \`driftGuard: false\` on either config to opt out of this check.`;
+function driftGuardMessage(outDir, previousEntryPoint, currentEntryPoint, differingKeys) {
+  const differ = differingKeys.length > 0 ? `their resolved configs differ at: ${differingKeys.map((key) => `\`${key}\``).join(", ")}` : "their resolved configs differ (re-run after this generate records per-key hashes to see which keys)";
+  return `[nestjs-codegen] Config drift detected in "${outDir}": the last generate ran from the "${previousEntryPoint}" entry point, this run is from the "${currentEntryPoint}" entry point, and ${differ}. Both entry points must read the SAME config \u2014 export a shared config object (e.g. codegen.config.ts) and import it from BOTH nestjs-codegen.config.ts (CLI) and NestjsCodegenModule.forRoot() (Nest module), or set \`driftGuard: false\` on either config to opt out of this check.`;
 }
 async function generate(config, inputRoutes = [], entryPoint = "cli") {
   setCodegenDebug(config.debug);
@@ -2297,9 +2349,17 @@ async function generate(config, inputRoutes = [], entryPoint = "cli") {
     return;
   }
   const configHash = computeConfigHash(config);
+  const configKeyHashes = computeConfigKeyHashes(config);
   if (config.driftGuard && manifest?.entryPoint && manifest.entryPoint !== entryPoint && manifest.configHash && manifest.configHash !== configHash) {
     throw new DriftGuardError(
-      driftGuardMessage(config.codegen.outDir, manifest.entryPoint, entryPoint)
+      driftGuardMessage(
+        config.codegen.outDir,
+        manifest.entryPoint,
+        entryPoint,
+        // A pre-key-hash manifest can't tell us WHICH keys differ — pass none
+        // rather than diffing against {} (which would name every key).
+        manifest.configKeyHashes ? diffConfigKeyHashes(manifest.configKeyHashes, configKeyHashes) : []
+      )
     );
   }
   const extensions = config.extensions ?? [];
@@ -2369,6 +2429,7 @@ async function generate(config, inputRoutes = [], entryPoint = "cli") {
     hash: inputsHash,
     entryPoint,
     configHash,
+    configKeyHashes,
     files: outputFiles
   });
 }
@@ -4801,7 +4862,7 @@ async function watch(config, onChange, options = {}) {
 }
 
 // src/index.ts
-var VERSION = "0.14.1";
+var VERSION = "0.15.0";
 
 // src/cli/codegen.ts
 async function runCodegen(opts = {}) {