zod-nest 0.12.0 → 0.13.0

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`, `ZodNestError`, `ZodNestUnrepresentableError`, `extend`, `getLineage`, `LineageEntry`
+- `toOpenApi(schema, opts)`, `createRegistry()`, `defaultRegistry`, `ZodNestRegistry`, `Override`, `OverrideContext`, `overrideJSONSchema(schema, fragment)`, `ZodNestError`, `ZodNestUnrepresentableError`, `extend`, `getLineage`, `LineageEntry`
 
 ## Documentation
 

package/dist/index.d.mts

@@ -79,6 +79,28 @@ declare const extend: <P extends z.ZodObject, S extends z.ZodObject>(parent: P,
  */
 declare const getLineage: (schema: z.ZodType) => LineageEntry | undefined;
 
+/**
+ * Register a fixed JSON Schema fragment for a specific Zod schema instance.
+ *
+ * Designed for shapes JSON Schema can't model directly — `z.custom<T>()` and
+ * `z.instanceof(...)` (e.g. multipart `File` fields) — which Zod emits as `{}`,
+ * tripping `ZodNestUnrepresentableError` in strict mode. After registration
+ * the engine writes the supplied fragment in-place wherever that schema
+ * instance is emitted (single-schema `toOpenApi`, bulk emission, nested
+ * inside `z.object({...})`, anywhere).
+ *
+ * Idempotent: subsequent calls for the same schema overwrite the prior
+ * registration (last-write-wins).
+ *
+ * @example
+ *   const FileSchema = z.instanceof(File);
+ *   overrideJSONSchema(FileSchema, { type: 'string', format: 'binary' });
+ *
+ *   class UploadDto extends createZodDto(z.object({ file: FileSchema })) {}
+ *   // OpenAPI doc emits `properties.file = { type: 'string', format: 'binary' }`
+ */
+declare const overrideJSONSchema: (schema: z.ZodType, jsonSchema: SchemaObject) => void;
+
 interface ToOpenApiOptions {
     io: 'input' | 'output';
     registry: ZodNestRegistry;
@@ -527,4 +549,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 ResponseStatusInput, type ResponseStatusWildcard, type ResponseVariant, type ResponseVariantKind, type 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, 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 ResponseStatusInput, type ResponseStatusWildcard, type ResponseVariant, type ResponseVariantKind, type 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 };

package/dist/index.d.ts

@@ -79,6 +79,28 @@ declare const extend: <P extends z.ZodObject, S extends z.ZodObject>(parent: P,
  */
 declare const getLineage: (schema: z.ZodType) => LineageEntry | undefined;
 
+/**
+ * Register a fixed JSON Schema fragment for a specific Zod schema instance.
+ *
+ * Designed for shapes JSON Schema can't model directly — `z.custom<T>()` and
+ * `z.instanceof(...)` (e.g. multipart `File` fields) — which Zod emits as `{}`,
+ * tripping `ZodNestUnrepresentableError` in strict mode. After registration
+ * the engine writes the supplied fragment in-place wherever that schema
+ * instance is emitted (single-schema `toOpenApi`, bulk emission, nested
+ * inside `z.object({...})`, anywhere).
+ *
+ * Idempotent: subsequent calls for the same schema overwrite the prior
+ * registration (last-write-wins).
+ *
+ * @example
+ *   const FileSchema = z.instanceof(File);
+ *   overrideJSONSchema(FileSchema, { type: 'string', format: 'binary' });
+ *
+ *   class UploadDto extends createZodDto(z.object({ file: FileSchema })) {}
+ *   // OpenAPI doc emits `properties.file = { type: 'string', format: 'binary' }`
+ */
+declare const overrideJSONSchema: (schema: z.ZodType, jsonSchema: SchemaObject) => void;
+
 interface ToOpenApiOptions {
     io: 'input' | 'output';
     registry: ZodNestRegistry;
@@ -527,4 +549,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 ResponseStatusInput, type ResponseStatusWildcard, type ResponseVariant, type ResponseVariantKind, type 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, 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 ResponseStatusInput, type ResponseStatusWildcard, type ResponseVariant, type ResponseVariantKind, type 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 };

package/dist/index.js

@@ -104,6 +104,22 @@ var createCompositionOverride = /* @__PURE__ */ __name((opts) => {
   };
 }, "createCompositionOverride");
 
+// src/schema/custom-override.ts
+var customOverrideMap = /* @__PURE__ */ new WeakMap();
+var overrideJSONSchema = /* @__PURE__ */ __name((schema, jsonSchema) => {
+  customOverrideMap.set(schema, jsonSchema);
+}, "overrideJSONSchema");
+var customOverride = /* @__PURE__ */ __name(({ zodSchema, jsonSchema }) => {
+  const fragment = customOverrideMap.get(zodSchema);
+  if (fragment === void 0) {
+    return;
+  }
+  for (const key of Object.keys(jsonSchema)) {
+    Reflect.deleteProperty(jsonSchema, key);
+  }
+  Object.assign(jsonSchema, fragment);
+}, "customOverride");
+
 // src/schema/errors.ts
 var ZodNestError = class extends Error {
   static {
@@ -232,7 +248,7 @@ var buildToJsonSchemaOptions = /* @__PURE__ */ __name((params) => {
     buildRef: params.uri ?? DEFAULT_BUILD_REF,
     registry: params.registry
   });
-  const merged = combine(primitiveOverride, compositionOverride, params.override);
+  const merged = combine(primitiveOverride, compositionOverride, customOverride, params.override);
   const unrepresentableHits = [];
   const wrapped = /* @__PURE__ */ __name((ctx) => {
     merged(ctx);
@@ -1482,6 +1498,7 @@ exports.getLineage = getLineage;
 exports.isZodDto = isZodDto;
 exports.isZodDtoMarker = isZodDtoMarker;
 exports.makeZodDtoMarker = makeZodDtoMarker;
+exports.overrideJSONSchema = overrideJSONSchema;
 exports.resolveEffectiveStatus = resolveEffectiveStatus;
 exports.toOpenApi = toOpenApi;
 //# sourceMappingURL=index.js.map