@dudousxd/nestjs-codegen 0.14.1 → 0.15.0

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { U as UserConfig, R as ResolvedConfig, a as RouteDescriptor, S as SchemaNode, b as RenderContext, c as SchemaModule, d as RenderedModule, e as ResolvedFormsConfig, V as ValidationAdapter, C as CodegenExtension, E as ExtensionContext, f as SerializationMode } from './index-DT8SgPxp.cjs';
-export { A as AdapterUsage, g as ContractDescriptor, h as ContractSource, i as ControllerRef, N as NumberCheck, j as ScopeConfig, k as StringCheck, T as TypeRef, l as ValidationOption, r as resolveAdapter } from './index-DT8SgPxp.cjs';
+import { U as UserConfig, R as ResolvedConfig, a as RouteDescriptor, S as SchemaNode, b as RenderContext, c as SchemaModule, d as RenderedModule, e as ResolvedFormsConfig, V as ValidationAdapter, C as CodegenExtension, E as ExtensionContext, f as SerializationMode } from './index-CjIDPMsV.cjs';
+export { A as AdapterUsage, g as ContractDescriptor, h as ContractSource, i as ControllerRef, N as NumberCheck, j as ScopeConfig, k as StringCheck, T as TypeRef, l as ValidationOption, r as resolveAdapter } from './index-CjIDPMsV.cjs';
 import { ClassDeclaration, SourceFile, Project } from 'ts-morph';
 
 declare function defineConfig(c: UserConfig): UserConfig;
@@ -73,6 +73,12 @@ interface CodegenManifest {
      * unrelated source-file changes. Absent on pre-drift-guard manifests.
      */
     configHash?: string;
+    /**
+     * Per-top-level-key hashes of the serialized resolved config, so a drift-guard
+     * failure can NAME the keys that differ instead of asking the consumer to
+     * eyeball two whole configs. Absent on manifests written before this field.
+     */
+    configKeyHashes?: Record<string, string>;
     /** Generated output files, relative to `outDir`, recorded after the last run. */
     files: string[];
 }
@@ -367,6 +373,6 @@ interface FastDiscoveryOptions {
 }
 declare function discoverContractsFast(opts: FastDiscoveryOptions): Promise<RouteDescriptor[]>;
 
-declare const VERSION = "0.14.1";
+declare const VERSION = "0.15.0";
 
 export { type ChainModuleRendererOptions, CodegenError, type CodegenManifest, ConfigError, DriftGuardError, type EntryPoint, type FastDiscoveryOptions, type JsonSchema, type MocksEmitOptions, type OpenApiDocument, type OpenApiEmitOptions, type OpenApiInfo, RenderContext, RenderedModule, ResolvedConfig, RouteDescriptor, SchemaModule, SchemaNode, type TsTypeContext, UserConfig, VERSION, ValidationAdapter, type WatchOptions, type Watcher, acquireLock, buildMocksFile, buildOpenApiSpec, createChainModuleRenderer, defineConfig, discoverContractsFast, emitApi, emitForms, emitMocks, emitOpenApi, emitRoutes, extractSchemaFromDto, generate, loadConfig, renderTsType, resolveConfig, schemaModuleToJsonSchema, schemaNodeToJsonSchema, toObjectKey, typeNameFor, watch };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { U as UserConfig, R as ResolvedConfig, a as RouteDescriptor, S as SchemaNode, b as RenderContext, c as SchemaModule, d as RenderedModule, e as ResolvedFormsConfig, V as ValidationAdapter, C as CodegenExtension, E as ExtensionContext, f as SerializationMode } from './index-DT8SgPxp.js';
-export { A as AdapterUsage, g as ContractDescriptor, h as ContractSource, i as ControllerRef, N as NumberCheck, j as ScopeConfig, k as StringCheck, T as TypeRef, l as ValidationOption, r as resolveAdapter } from './index-DT8SgPxp.js';
+import { U as UserConfig, R as ResolvedConfig, a as RouteDescriptor, S as SchemaNode, b as RenderContext, c as SchemaModule, d as RenderedModule, e as ResolvedFormsConfig, V as ValidationAdapter, C as CodegenExtension, E as ExtensionContext, f as SerializationMode } from './index-CjIDPMsV.js';
+export { A as AdapterUsage, g as ContractDescriptor, h as ContractSource, i as ControllerRef, N as NumberCheck, j as ScopeConfig, k as StringCheck, T as TypeRef, l as ValidationOption, r as resolveAdapter } from './index-CjIDPMsV.js';
 import { ClassDeclaration, SourceFile, Project } from 'ts-morph';
 
 declare function defineConfig(c: UserConfig): UserConfig;
@@ -73,6 +73,12 @@ interface CodegenManifest {
      * unrelated source-file changes. Absent on pre-drift-guard manifests.
      */
     configHash?: string;
+    /**
+     * Per-top-level-key hashes of the serialized resolved config, so a drift-guard
+     * failure can NAME the keys that differ instead of asking the consumer to
+     * eyeball two whole configs. Absent on manifests written before this field.
+     */
+    configKeyHashes?: Record<string, string>;
     /** Generated output files, relative to `outDir`, recorded after the last run. */
     files: string[];
 }
@@ -367,6 +373,6 @@ interface FastDiscoveryOptions {
 }
 declare function discoverContractsFast(opts: FastDiscoveryOptions): Promise<RouteDescriptor[]>;
 
-declare const VERSION = "0.14.1";
+declare const VERSION = "0.15.0";
 
 export { type ChainModuleRendererOptions, CodegenError, type CodegenManifest, ConfigError, DriftGuardError, type EntryPoint, type FastDiscoveryOptions, type JsonSchema, type MocksEmitOptions, type OpenApiDocument, type OpenApiEmitOptions, type OpenApiInfo, RenderContext, RenderedModule, ResolvedConfig, RouteDescriptor, SchemaModule, SchemaNode, type TsTypeContext, UserConfig, VERSION, ValidationAdapter, type WatchOptions, type Watcher, acquireLock, buildMocksFile, buildOpenApiSpec, createChainModuleRenderer, defineConfig, discoverContractsFast, emitApi, emitForms, emitMocks, emitOpenApi, emitRoutes, extractSchemaFromDto, generate, loadConfig, renderTsType, resolveConfig, schemaModuleToJsonSchema, schemaNodeToJsonSchema, toObjectKey, typeNameFor, watch };

package/dist/index.js

@@ -746,6 +746,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 = [];
@@ -772,7 +775,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(
@@ -812,6 +816,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']`);
@@ -841,7 +846,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) {
@@ -876,9 +886,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},`);
   }
@@ -1150,6 +1175,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(
@@ -2159,19 +2187,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] = 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);
@@ -2206,6 +2256,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 {
@@ -2259,8 +2310,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);
@@ -2271,9 +2323,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 ?? [];
@@ -2343,6 +2403,7 @@ async function generate(config, inputRoutes = [], entryPoint = "cli") {
     hash: inputsHash,
     entryPoint,
     configHash,
+    configKeyHashes,
     files: outputFiles
   });
 }
@@ -4873,7 +4934,7 @@ function createChainModuleRenderer(opts) {
 }
 
 // src/index.ts
-var VERSION = "0.14.1";
+var VERSION = "0.15.0";
 export {
   CodegenError,
   ConfigError,