zod-nest 1.5.1 → 1.6.1

package/README.md

@@ -431,7 +431,7 @@ A compact, link-out index. Type signatures and detailed semantics live in the co
 - `ZodNestModule.forRoot(options?)`, `ZodNestModuleOptions`, `DEFAULT_REDACT_KEYS`, `DEFAULT_MAX_LOGGED_VALUE_BYTES`, `ZOD_NEST_OPTIONS`
 
 **Schema engine** — single-schema mode and extension points
-- `toOpenApi(schema, opts)`, `createRegistry()`, `defaultRegistry`, `ZodNestRegistry`, `Override`, `OverrideContext`, `overrideJSONSchema(schema, fragment | { input?, output? })`, `OverrideJSONSchemaArg`, `ZodNestError`, `ZodNestUnrepresentableError`, `extend`, `getLineage`, `LineageEntry`
+- `toOpenApi(schema, opts)`, `createRegistry()`, `defaultRegistry`, `registerSchema(schema, registry?, options?)`, `ZodNestRegistry`, `RegisterSchemaOptions`, `Override`, `OverrideContext`, `overrideJSONSchema(schema, fragment | { input?, output? })`, `OverrideJSONSchemaArg`, `ZodNestError`, `ZodNestUnrepresentableError`, `extend`, `getLineage`, `LineageEntry`
 
 **Helpers** (subpath: `zod-nest/helpers`) — common JSON Schema fragments + presets for assembling overrides
 - **Fragment catalog** (frozen consts): `dateTimeFragment`, `dateFragment`, `timeFragment`, `uuidFragment`, `emailFragment`, `uriFragment`, `hostnameFragment`, `ipv4Fragment`, `ipv6Fragment`, `binaryFragment`, `byteFragment`, `int32Fragment`, `int64Fragment`, `floatFragment`, `doubleFragment`, `opaqueFragment`

package/dist/index.d.mts

@@ -46,6 +46,25 @@ interface ZodNestRegistry {
 declare const createRegistry: () => ZodNestRegistry;
 /** Process-wide default registry, used when no explicit `options.registry` is passed. */
 declare const defaultRegistry: ZodNestRegistry;
+interface RegisterSchemaOptions {
+    /** Forces this id, overriding any `.meta({ id })` already on the schema. */
+    readonly id?: string;
+}
+/**
+ * Register a schema with the given registry, resolving its id from (in order):
+ * an explicit `options.id`, then `.meta({ id })` on the schema. Returns the
+ * resolved id, or `undefined` when neither source yields one (the call is then
+ * a no-op — callers with their own fallback path handle that case).
+ *
+ * Shared by `createZodDto` and `extend` so a schema named via `.meta({ id })`
+ * gets its body emitted into `components.schemas` even when it never flows
+ * through `createZodDto` (e.g. used only as an `extend()` parent — Zod's
+ * `.extend()` produces a flat object, so the parent isn't a transitive
+ * descendant of the child and would otherwise be missed by `discoverDependents`).
+ *
+ * Idempotent — `registry.register` already deduplicates repeat calls.
+ */
+declare const registerSchema: (schema: z.ZodType, registry?: ZodNestRegistry, options?: RegisterSchemaOptions) => string | undefined;
 
 /**
  * Composition layer — emits OpenAPI `allOf` for schemas derived via `extend`.
@@ -600,4 +619,4 @@ declare class ZodNestDocumentError extends ZodNestError {
     constructor(code: ZodNestDocumentErrorCode, message: string, details?: Record<string, unknown>);
 }
 
-export { type ApplyZodNestOptions, COMPONENTS_SCHEMAS_PREFIX, type CreateSerializationException, type CreateValidationException, type CreateZodDtoOptions, DEFAULT_MAX_LOGGED_VALUE_BYTES, DEFAULT_REDACT_KEYS, type Io, type LineageEntry, type NormalizedZodNestOptions, type Override, type OverrideContext, type OverrideJSONSchemaArg, type ResponseStatusInput, type ResponseStatusWildcard, type ResponseVariant, type ResponseVariantKind, SchemaObject, type ToOpenApiOptions, type ToOpenApiResult, ZOD_DTO_SYMBOL, ZOD_NEST_DTO_EXTENSION, ZOD_NEST_ERROR_DUPLICATE_ID, ZOD_NEST_ERROR_EXTENSION, ZOD_NEST_OPTIONS, ZOD_RESPONSES_METADATA_KEY, type ZodDto, type ZodDtoMarker, ZodNestDocumentError, type ZodNestDocumentErrorCode, ZodNestError, ZodNestModule, type ZodNestModuleOptions, type ZodNestRegistry, ZodNestUnrepresentableError, ZodResponse, type ZodResponseDescription, type ZodResponseOptions, type ZodResponseType, ZodSerializationException, ZodSerializerInterceptor, ZodValidationException, ZodValidationPipe, type ZodValidationPipeArg, type ZodValidationPipeOptions, applyZodNest, createRegistry, createZodDto, defaultRegistry, defaultStatusFor, extend, getLineage, isZodDto, isZodDtoMarker, makeZodDtoMarker, overrideJSONSchema, resolveEffectiveStatus, toOpenApi };
+export { type ApplyZodNestOptions, COMPONENTS_SCHEMAS_PREFIX, type CreateSerializationException, type CreateValidationException, type CreateZodDtoOptions, DEFAULT_MAX_LOGGED_VALUE_BYTES, DEFAULT_REDACT_KEYS, type Io, type LineageEntry, type NormalizedZodNestOptions, type Override, type OverrideContext, type OverrideJSONSchemaArg, type RegisterSchemaOptions, type ResponseStatusInput, type ResponseStatusWildcard, type ResponseVariant, type ResponseVariantKind, SchemaObject, type ToOpenApiOptions, type ToOpenApiResult, ZOD_DTO_SYMBOL, ZOD_NEST_DTO_EXTENSION, ZOD_NEST_ERROR_DUPLICATE_ID, ZOD_NEST_ERROR_EXTENSION, ZOD_NEST_OPTIONS, ZOD_RESPONSES_METADATA_KEY, type ZodDto, type ZodDtoMarker, ZodNestDocumentError, type ZodNestDocumentErrorCode, ZodNestError, ZodNestModule, type ZodNestModuleOptions, type ZodNestRegistry, ZodNestUnrepresentableError, ZodResponse, type ZodResponseDescription, type ZodResponseOptions, type ZodResponseType, ZodSerializationException, ZodSerializerInterceptor, ZodValidationException, ZodValidationPipe, type ZodValidationPipeArg, type ZodValidationPipeOptions, applyZodNest, createRegistry, createZodDto, defaultRegistry, defaultStatusFor, extend, getLineage, isZodDto, isZodDtoMarker, makeZodDtoMarker, overrideJSONSchema, registerSchema, resolveEffectiveStatus, toOpenApi };

package/dist/index.d.ts

@@ -46,6 +46,25 @@ interface ZodNestRegistry {
 declare const createRegistry: () => ZodNestRegistry;
 /** Process-wide default registry, used when no explicit `options.registry` is passed. */
 declare const defaultRegistry: ZodNestRegistry;
+interface RegisterSchemaOptions {
+    /** Forces this id, overriding any `.meta({ id })` already on the schema. */
+    readonly id?: string;
+}
+/**
+ * Register a schema with the given registry, resolving its id from (in order):
+ * an explicit `options.id`, then `.meta({ id })` on the schema. Returns the
+ * resolved id, or `undefined` when neither source yields one (the call is then
+ * a no-op — callers with their own fallback path handle that case).
+ *
+ * Shared by `createZodDto` and `extend` so a schema named via `.meta({ id })`
+ * gets its body emitted into `components.schemas` even when it never flows
+ * through `createZodDto` (e.g. used only as an `extend()` parent — Zod's
+ * `.extend()` produces a flat object, so the parent isn't a transitive
+ * descendant of the child and would otherwise be missed by `discoverDependents`).
+ *
+ * Idempotent — `registry.register` already deduplicates repeat calls.
+ */
+declare const registerSchema: (schema: z.ZodType, registry?: ZodNestRegistry, options?: RegisterSchemaOptions) => string | undefined;
 
 /**
  * Composition layer — emits OpenAPI `allOf` for schemas derived via `extend`.
@@ -600,4 +619,4 @@ declare class ZodNestDocumentError extends ZodNestError {
     constructor(code: ZodNestDocumentErrorCode, message: string, details?: Record<string, unknown>);
 }
 
-export { type ApplyZodNestOptions, COMPONENTS_SCHEMAS_PREFIX, type CreateSerializationException, type CreateValidationException, type CreateZodDtoOptions, DEFAULT_MAX_LOGGED_VALUE_BYTES, DEFAULT_REDACT_KEYS, type Io, type LineageEntry, type NormalizedZodNestOptions, type Override, type OverrideContext, type OverrideJSONSchemaArg, type ResponseStatusInput, type ResponseStatusWildcard, type ResponseVariant, type ResponseVariantKind, SchemaObject, type ToOpenApiOptions, type ToOpenApiResult, ZOD_DTO_SYMBOL, ZOD_NEST_DTO_EXTENSION, ZOD_NEST_ERROR_DUPLICATE_ID, ZOD_NEST_ERROR_EXTENSION, ZOD_NEST_OPTIONS, ZOD_RESPONSES_METADATA_KEY, type ZodDto, type ZodDtoMarker, ZodNestDocumentError, type ZodNestDocumentErrorCode, ZodNestError, ZodNestModule, type ZodNestModuleOptions, type ZodNestRegistry, ZodNestUnrepresentableError, ZodResponse, type ZodResponseDescription, type ZodResponseOptions, type ZodResponseType, ZodSerializationException, ZodSerializerInterceptor, ZodValidationException, ZodValidationPipe, type ZodValidationPipeArg, type ZodValidationPipeOptions, applyZodNest, createRegistry, createZodDto, defaultRegistry, defaultStatusFor, extend, getLineage, isZodDto, isZodDtoMarker, makeZodDtoMarker, overrideJSONSchema, resolveEffectiveStatus, toOpenApi };
+export { type ApplyZodNestOptions, COMPONENTS_SCHEMAS_PREFIX, type CreateSerializationException, type CreateValidationException, type CreateZodDtoOptions, DEFAULT_MAX_LOGGED_VALUE_BYTES, DEFAULT_REDACT_KEYS, type Io, type LineageEntry, type NormalizedZodNestOptions, type Override, type OverrideContext, type OverrideJSONSchemaArg, type RegisterSchemaOptions, type ResponseStatusInput, type ResponseStatusWildcard, type ResponseVariant, type ResponseVariantKind, SchemaObject, type ToOpenApiOptions, type ToOpenApiResult, ZOD_DTO_SYMBOL, ZOD_NEST_DTO_EXTENSION, ZOD_NEST_ERROR_DUPLICATE_ID, ZOD_NEST_ERROR_EXTENSION, ZOD_NEST_OPTIONS, ZOD_RESPONSES_METADATA_KEY, type ZodDto, type ZodDtoMarker, ZodNestDocumentError, type ZodNestDocumentErrorCode, ZodNestError, ZodNestModule, type ZodNestModuleOptions, type ZodNestRegistry, ZodNestUnrepresentableError, ZodResponse, type ZodResponseDescription, type ZodResponseOptions, type ZodResponseType, ZodSerializationException, ZodSerializerInterceptor, ZodValidationException, ZodValidationPipe, type ZodValidationPipeArg, type ZodValidationPipeOptions, applyZodNest, createRegistry, createZodDto, defaultRegistry, defaultStatusFor, extend, getLineage, isZodDto, isZodDtoMarker, makeZodDtoMarker, overrideJSONSchema, registerSchema, resolveEffectiveStatus, toOpenApi };

package/dist/index.js

@@ -22,6 +22,191 @@ var DEFS_PREFIX = "#/$defs/";
 var ZOD_NEST_ERROR_EXTENSION = "x-zod-nest-error";
 var ZOD_NEST_ERROR_DUPLICATE_ID = "duplicate-id";
 var ZOD_NEST_DTO_EXTENSION = "x-zod-nest-dto";
+var INNER_TYPE_WRAPPERS = /* @__PURE__ */ new Set([
+  "optional",
+  "nullable",
+  "default",
+  "prefault",
+  "catch",
+  "nonoptional",
+  "success",
+  "readonly",
+  "promise"
+]);
+var readId = /* @__PURE__ */ __name((schema) => {
+  const meta = zod.z.globalRegistry.get(schema);
+  if (meta === void 0) {
+    return void 0;
+  }
+  const id = meta.id;
+  return typeof id === "string" ? id : void 0;
+}, "readId");
+var collectChildren = /* @__PURE__ */ __name((schema) => {
+  const def = schema._zod.def;
+  if (def.type === "object") {
+    const out = [];
+    const shape = def.shape;
+    if (shape !== void 0) {
+      for (const value of Object.values(shape)) {
+        out.push(value);
+      }
+    }
+    if (def.catchall !== void 0) {
+      out.push(def.catchall);
+    }
+    return out;
+  }
+  if (def.type === "array") {
+    return [
+      def.element
+    ];
+  }
+  if (def.type === "union") {
+    return def.options.map((opt) => opt);
+  }
+  if (def.type === "intersection") {
+    return [
+      def.left,
+      def.right
+    ];
+  }
+  if (def.type === "tuple") {
+    const out = def.items.map((it) => it);
+    if (def.rest !== null) {
+      out.push(def.rest);
+    }
+    return out;
+  }
+  if (def.type === "record" || def.type === "map") {
+    return [
+      def.keyType,
+      def.valueType
+    ];
+  }
+  if (def.type === "set") {
+    return [
+      def.valueType
+    ];
+  }
+  if (def.type === "pipe") {
+    return [
+      def.in,
+      def.out
+    ];
+  }
+  if (def.type === "lazy") {
+    return [
+      def.getter()
+    ];
+  }
+  if (INNER_TYPE_WRAPPERS.has(def.type)) {
+    return [
+      def.innerType
+    ];
+  }
+  return [];
+}, "collectChildren");
+var discoverDependents = /* @__PURE__ */ __name((schema) => {
+  const visited = /* @__PURE__ */ new WeakSet();
+  const out = [];
+  const stack = [
+    schema
+  ];
+  while (stack.length > 0) {
+    const current = stack.pop();
+    if (visited.has(current)) {
+      continue;
+    }
+    visited.add(current);
+    for (const child of collectChildren(current)) {
+      if (child === void 0 || visited.has(child)) {
+        continue;
+      }
+      const id = readId(child);
+      if (id !== void 0) {
+        out.push([
+          child,
+          id
+        ]);
+      }
+      stack.push(child);
+    }
+  }
+  return out;
+}, "discoverDependents");
+
+// src/schema/registry.ts
+var createRegistry = /* @__PURE__ */ __name(() => {
+  const seen = /* @__PURE__ */ new Map();
+  const recordOnce = /* @__PURE__ */ __name((schema, id) => {
+    let set = seen.get(id);
+    if (set === void 0) {
+      set = /* @__PURE__ */ new Set();
+      seen.set(id, set);
+    }
+    if (set.has(schema)) {
+      return false;
+    }
+    set.add(schema);
+    return true;
+  }, "recordOnce");
+  return {
+    zodRegistry: zod.z.globalRegistry,
+    register: /* @__PURE__ */ __name((schema, id) => {
+      if (zod.z.globalRegistry.has(schema)) {
+        const existing = zod.z.globalRegistry.get(schema);
+        if (existing?.id !== id) {
+          zod.z.globalRegistry.add(schema, {
+            ...existing ?? {},
+            id
+          });
+        }
+      } else {
+        zod.z.globalRegistry.add(schema, {
+          id
+        });
+      }
+      if (!recordOnce(schema, id)) {
+        return;
+      }
+      for (const [child, childId] of discoverDependents(schema)) {
+        recordOnce(child, childId);
+      }
+    }, "register"),
+    hasCollision: /* @__PURE__ */ __name((id) => {
+      const set = seen.get(id);
+      return set !== void 0 && set.size > 1;
+    }, "hasCollision"),
+    getCollisions: /* @__PURE__ */ __name(() => {
+      const out = /* @__PURE__ */ new Map();
+      for (const [id, set] of seen) {
+        if (set.size <= 1) {
+          continue;
+        }
+        out.set(id, set);
+      }
+      return out;
+    }, "getCollisions"),
+    ids: /* @__PURE__ */ __name(() => [
+      ...seen.keys()
+    ], "ids")
+  };
+}, "createRegistry");
+var defaultRegistry = createRegistry();
+var registerSchema = /* @__PURE__ */ __name((schema, registry = defaultRegistry, options) => {
+  const explicit = options?.id;
+  if (typeof explicit === "string" && explicit !== "") {
+    registry.register(schema, explicit);
+    return explicit;
+  }
+  const meta = registry.zodRegistry.get(schema);
+  const metaId = meta === void 0 ? void 0 : meta.id;
+  if (typeof metaId !== "string" || metaId === "") {
+    return void 0;
+  }
+  registry.register(schema, metaId);
+  return metaId;
+}, "registerSchema");
 
 // src/schema/composition.ts
 var lineageMap = /* @__PURE__ */ new WeakMap();
@@ -52,6 +237,8 @@ var extend = /* @__PURE__ */ __name((parent, build) => {
   if (!propsMap.has(parent)) {
     propsMap.set(parent, computeShapeKeys(parent));
   }
+  registerSchema(parent);
+  registerSchema(result);
   return result;
 }, "extend");
 var getLineage = /* @__PURE__ */ __name((schema) => lineageMap.get(schema), "getLineage");
@@ -72,6 +259,7 @@ var createCompositionOverride = /* @__PURE__ */ __name((opts) => {
     if (parentId === void 0) {
       return;
     }
+    registerSchema(entry.parent, registry);
     const childProps = jsonSchema.properties ?? {};
     const childRequired = jsonSchema.required ?? [];
     const parentPropSet = new Set(parentCache.properties);
@@ -350,167 +538,6 @@ var toOpenApi = /* @__PURE__ */ __name((schema, opts) => {
   }
   return result;
 }, "toOpenApi");
-var INNER_TYPE_WRAPPERS = /* @__PURE__ */ new Set([
-  "optional",
-  "nullable",
-  "default",
-  "prefault",
-  "catch",
-  "nonoptional",
-  "success",
-  "readonly",
-  "promise"
-]);
-var readId = /* @__PURE__ */ __name((schema) => {
-  const meta = zod.z.globalRegistry.get(schema);
-  if (meta === void 0) {
-    return void 0;
-  }
-  const id = meta.id;
-  return typeof id === "string" ? id : void 0;
-}, "readId");
-var collectChildren = /* @__PURE__ */ __name((schema) => {
-  const def = schema._zod.def;
-  if (def.type === "object") {
-    const out = [];
-    const shape = def.shape;
-    if (shape !== void 0) {
-      for (const value of Object.values(shape)) {
-        out.push(value);
-      }
-    }
-    if (def.catchall !== void 0) {
-      out.push(def.catchall);
-    }
-    return out;
-  }
-  if (def.type === "array") {
-    return [
-      def.element
-    ];
-  }
-  if (def.type === "union") {
-    return def.options.map((opt) => opt);
-  }
-  if (def.type === "intersection") {
-    return [
-      def.left,
-      def.right
-    ];
-  }
-  if (def.type === "tuple") {
-    const out = def.items.map((it) => it);
-    if (def.rest !== null) {
-      out.push(def.rest);
-    }
-    return out;
-  }
-  if (def.type === "record" || def.type === "map") {
-    return [
-      def.keyType,
-      def.valueType
-    ];
-  }
-  if (def.type === "set") {
-    return [
-      def.valueType
-    ];
-  }
-  if (def.type === "pipe") {
-    return [
-      def.in,
-      def.out
-    ];
-  }
-  if (def.type === "lazy") {
-    return [
-      def.getter()
-    ];
-  }
-  if (INNER_TYPE_WRAPPERS.has(def.type)) {
-    return [
-      def.innerType
-    ];
-  }
-  return [];
-}, "collectChildren");
-var discoverDependents = /* @__PURE__ */ __name((schema) => {
-  const visited = /* @__PURE__ */ new WeakSet();
-  const out = [];
-  const stack = [
-    schema
-  ];
-  while (stack.length > 0) {
-    const current = stack.pop();
-    if (visited.has(current)) {
-      continue;
-    }
-    visited.add(current);
-    for (const child of collectChildren(current)) {
-      if (visited.has(child)) {
-        continue;
-      }
-      const id = readId(child);
-      if (id !== void 0) {
-        out.push([
-          child,
-          id
-        ]);
-      }
-      stack.push(child);
-    }
-  }
-  return out;
-}, "discoverDependents");
-
-// src/schema/registry.ts
-var createRegistry = /* @__PURE__ */ __name(() => {
-  const seen = /* @__PURE__ */ new Map();
-  const recordOnce = /* @__PURE__ */ __name((schema, id) => {
-    let set = seen.get(id);
-    if (set === void 0) {
-      set = /* @__PURE__ */ new Set();
-      seen.set(id, set);
-    }
-    if (set.has(schema)) {
-      return false;
-    }
-    set.add(schema);
-    return true;
-  }, "recordOnce");
-  return {
-    zodRegistry: zod.z.globalRegistry,
-    register: /* @__PURE__ */ __name((schema, id) => {
-      zod.z.globalRegistry.add(schema, {
-        id
-      });
-      if (!recordOnce(schema, id)) {
-        return;
-      }
-      for (const [child, childId] of discoverDependents(schema)) {
-        recordOnce(child, childId);
-      }
-    }, "register"),
-    hasCollision: /* @__PURE__ */ __name((id) => {
-      const set = seen.get(id);
-      return set !== void 0 && set.size > 1;
-    }, "hasCollision"),
-    getCollisions: /* @__PURE__ */ __name(() => {
-      const out = /* @__PURE__ */ new Map();
-      for (const [id, set] of seen) {
-        if (set.size <= 1) {
-          continue;
-        }
-        out.set(id, set);
-      }
-      return out;
-    }, "getCollisions"),
-    ids: /* @__PURE__ */ __name(() => [
-      ...seen.keys()
-    ], "ids")
-  };
-}, "createRegistry");
-var defaultRegistry = createRegistry();
 
 // src/dto/marker.ts
 var makeZodDtoMarker = /* @__PURE__ */ __name((dtoId, io) => ({
@@ -573,14 +600,7 @@ var resolveOutput = /* @__PURE__ */ __name((parent, schema) => {
 // src/dto/create-zod-dto.ts
 var anonCounter = 0;
 var warnedOnAnonymous = false;
-var resolveId = /* @__PURE__ */ __name((registry, schema, providedId, className) => {
-  if (providedId !== void 0 && providedId !== "") {
-    return providedId;
-  }
-  const meta = registry.zodRegistry.get(schema);
-  if (meta && typeof meta.id === "string" && meta.id !== "") {
-    return meta.id;
-  }
+var resolveFallbackId = /* @__PURE__ */ __name((className) => {
   if (className !== "" && className.length > 1) {
     return className;
   }
@@ -591,7 +611,7 @@ var resolveId = /* @__PURE__ */ __name((registry, schema, providedId, className)
     console.warn(`[zod-nest] Could not resolve a DTO id from class name (got "${className}"). Using "${fallback}". Set an explicit id via \`schema.meta({ id: 'Foo' })\` (preferred) or \`createZodDto(schema, { id: 'Foo' })\` \u2014 important under minification, where class names become single mangled characters.`);
   }
   return fallback;
-}, "resolveId");
+}, "resolveFallbackId");
 var createZodDto = /* @__PURE__ */ __name((schema, options) => {
   const registry = options?.registry ?? defaultRegistry;
   const io = "input";
@@ -600,7 +620,14 @@ var createZodDto = /* @__PURE__ */ __name((schema, options) => {
     if (cachedId !== void 0) {
       return cachedId;
     }
-    cachedId = resolveId(registry, schema, options?.id, className);
+    const named = registerSchema(schema, registry, {
+      id: options?.id
+    });
+    if (named !== void 0) {
+      cachedId = named;
+      return cachedId;
+    }
+    cachedId = resolveFallbackId(className);
     registry.register(schema, cachedId);
     return cachedId;
   }, "ensureRegistered");
@@ -1946,6 +1973,7 @@ exports.isZodDto = isZodDto;
 exports.isZodDtoMarker = isZodDtoMarker;
 exports.makeZodDtoMarker = makeZodDtoMarker;
 exports.overrideJSONSchema = overrideJSONSchema;
+exports.registerSchema = registerSchema;
 exports.resolveEffectiveStatus = resolveEffectiveStatus;
 exports.toOpenApi = toOpenApi;
 //# sourceMappingURL=index.js.map