@orpc/zod 1.14.11 → 1.14.12

package/dist/index.d.ts

@@ -1,256 +1,91 @@
-import { JsonSchemaConverter, AnySchema, JsonSchemaConverterDirection, JsonSchema } from '@orpc/json-schema';
-import * as zod_v4_core from 'zod/v4/core';
-import { ToJSONSchemaParams, $input, $output } from 'zod/v4/core';
-import * as json_schema_typed from 'json-schema-typed';
+import { JSONSchema, ConditionalSchemaConverter, SchemaConvertOptions } from '@orpc/openapi';
+import { ZodTypeAny, input, output, ZodTypeDef, CustomErrorParams, ZodType, ZodEffects } from 'zod/v3';
+import { Context } from '@orpc/server';
+import { StandardHandlerPlugin, StandardHandlerOptions } from '@orpc/server/standard';
+import { AnySchema } from '@orpc/contract';
 
-interface ZodToJsonSchemaConverterOptions extends Omit<ToJSONSchemaParams, 'target' | 'io'> {
+declare function getCustomJsonSchema(def: ZodTypeDef, options: {
+    strategy: 'input' | 'output' | 'both';
+}): Exclude<JSONSchema, boolean> | undefined;
+declare function customJsonSchema<T extends ZodTypeAny, TStrategy extends 'input' | 'output' | 'both' = 'both'>(schema: T, custom: Exclude<JSONSchema<TStrategy extends 'input' ? input<T> : TStrategy extends 'output' ? output<T> : input<T> & output<T>>, boolean>, options?: {
+    strategy?: TStrategy;
+}): T;
+
+type CustomParams = CustomErrorParams & {
+    fatal?: boolean;
+};
+type CustomZodDef = {
+    type: 'blob' | 'regexp' | 'url';
+} | {
+    type: 'file';
+    mimeType?: string;
+};
+declare function setCustomZodDef<T extends ZodTypeDef>(def: T, custom: CustomZodDef): void;
+declare function getCustomZodDef(def: ZodTypeDef): CustomZodDef | undefined;
+declare function composeParams<T = unknown>(defaultMessage: (input: T) => string, params: undefined | string | CustomParams | ((input: T) => CustomParams)): (input: T) => CustomParams;
+
+declare function blob(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<Blob, ZodTypeDef, Blob>;
+
+declare function file(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<File, ZodTypeDef, File> & {
+    type(mimeType: string, params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodEffects<ZodType<File, ZodTypeDef, File>, File, File>;
+};
+
+declare function regexp(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<RegExp, ZodTypeDef, RegExp>;
+
+declare function url(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<URL, ZodTypeDef, URL>;
+
+declare class ZodSmartCoercionPlugin<TContext extends Context> implements StandardHandlerPlugin<TContext> {
+    init(options: StandardHandlerOptions<TContext>): void;
+}
+
+interface ZodToJsonSchemaOptions {
+    /**
+     * Max depth of lazy type
+     *
+     * Used `{}` when exceed max depth
+     *
+     * @default 3
+     */
+    maxLazyDepth?: number;
+    /**
+     * Max depth of nested types
+     *
+     * Used anyJsonSchema (`{}`) when exceed max depth
+     *
+     * @default 10
+     */
+    maxStructureDepth?: number;
+    /**
+     * The schema to be used to represent the any | unknown type.
+     *
+     * @default { }
+     */
+    anyJsonSchema?: Exclude<JSONSchema, boolean>;
+    /**
+     * The schema to be used when the Zod schema is unsupported.
+     *
+     * @default { not: {} }
+     */
+    unsupportedJsonSchema?: Exclude<JSONSchema, boolean>;
 }
-declare class ZodToJsonSchemaConverter implements JsonSchemaConverter {
-    private readonly options;
-    constructor(options?: ZodToJsonSchemaConverterOptions);
-    condition(schema: AnySchema | undefined, _direction: JsonSchemaConverterDirection): boolean;
-    convert(schema: AnySchema | undefined, direction: JsonSchemaConverterDirection): [jsonSchema: JsonSchema, optional: boolean];
-    private convertZod;
-    private getCustomJsonSchema;
+declare class ZodToJsonSchemaConverter implements ConditionalSchemaConverter {
+    #private;
+    private readonly maxLazyDepth;
+    private readonly maxStructureDepth;
+    private readonly unsupportedJsonSchema;
+    private readonly anyJsonSchema;
+    constructor(options?: ZodToJsonSchemaOptions);
+    condition(schema: AnySchema | undefined): boolean;
+    convert(schema: AnySchema | undefined, options: SchemaConvertOptions, lazyDepth?: number, isHandledCustomJSONSchema?: boolean, isHandledZodDescription?: boolean, structureDepth?: number): [required: boolean, jsonSchema: Exclude<JSONSchema, boolean>];
 }
 
-/**
- * Zod registry for customizing generated JSON schema, can use both for .input and .output
- *
- * @example
- * ```ts
- * import { JSON_SCHEMA_REGISTRY } from '@orpc/zod'
- *
- * const user = z.object({
- *   name: z.string(),
- *   age: z.number(),
- * })
- *
- * JSON_SCHEMA_REGISTRY.add(user, {
- *   examples: [{ name: 'John', age: 20 }],
- * })
- * ```
- */
-declare const JSON_SCHEMA_REGISTRY: zod_v4_core.$ZodRegistry<{
-    $anchor?: string;
-    $comment?: string;
-    $defs?: Record<string, json_schema_typed.JSONSchema>;
-    $dynamicAnchor?: string;
-    $dynamicRef?: string;
-    $id?: string;
-    $ref?: string;
-    $schema?: string;
-    $vocabulary?: Record<string, string>;
-    additionalItems?: json_schema_typed.JSONSchema;
-    additionalProperties?: json_schema_typed.JSONSchema;
-    allOf?: (json_schema_typed.JSONSchema<typeof $input | typeof $output, json_schema_typed.JSONSchema.TypeValue>[] | readonly json_schema_typed.JSONSchema<typeof $input | typeof $output, json_schema_typed.JSONSchema.TypeValue>[]) | undefined;
-    anyOf?: (json_schema_typed.JSONSchema<typeof $input | typeof $output, json_schema_typed.JSONSchema.TypeValue>[] | readonly json_schema_typed.JSONSchema<typeof $input | typeof $output, json_schema_typed.JSONSchema.TypeValue>[]) | undefined;
-    const?: typeof $input | typeof $output | undefined;
-    contains?: json_schema_typed.JSONSchema<typeof $input | typeof $output, json_schema_typed.JSONSchema.TypeValue> | undefined;
-    contentEncoding?: "7bit" | "8bit" | "base64" | "binary" | "ietf-token" | "quoted-printable" | "x-token";
-    contentMediaType?: string;
-    contentSchema?: json_schema_typed.JSONSchema<typeof $input | typeof $output, json_schema_typed.JSONSchema.TypeValue> | undefined;
-    default?: typeof $input | typeof $output | undefined;
-    definitions?: Record<string, json_schema_typed.JSONSchema>;
-    dependencies?: Record<string, (string[] | readonly string[]) | json_schema_typed.JSONSchema>;
-    dependentRequired?: Record<string, string[] | readonly string[]>;
-    dependentSchemas?: Record<string, json_schema_typed.JSONSchema>;
-    deprecated?: boolean;
-    description?: string;
-    else?: json_schema_typed.JSONSchema<typeof $input | typeof $output, json_schema_typed.JSONSchema.TypeValue> | undefined;
-    enum?: ((typeof $input | typeof $output)[] | readonly (typeof $input | typeof $output)[]) | undefined;
-    examples?: ((typeof $input | typeof $output)[] | readonly (typeof $input | typeof $output)[]) | undefined;
-    exclusiveMaximum?: number;
-    exclusiveMinimum?: number;
-    format?: string;
-    if?: json_schema_typed.JSONSchema<typeof $input | typeof $output, json_schema_typed.JSONSchema.TypeValue> | undefined;
-    items?: json_schema_typed.JSONSchema;
-    maxContains?: number;
-    maximum?: number;
-    maxItems?: number;
-    maxLength?: number;
-    maxProperties?: number;
-    minContains?: number;
-    minimum?: number;
-    minItems?: number;
-    minLength?: number;
-    minProperties?: number;
-    multipleOf?: number;
-    not?: json_schema_typed.JSONSchema<typeof $input | typeof $output, json_schema_typed.JSONSchema.TypeValue> | undefined;
-    oneOf?: (json_schema_typed.JSONSchema<typeof $input | typeof $output, json_schema_typed.JSONSchema.TypeValue>[] | readonly json_schema_typed.JSONSchema<typeof $input | typeof $output, json_schema_typed.JSONSchema.TypeValue>[]) | undefined;
-    pattern?: string;
-    patternProperties?: Record<string, json_schema_typed.JSONSchema>;
-    prefixItems?: (json_schema_typed.JSONSchema<any, json_schema_typed.JSONSchema.TypeValue>[] | readonly json_schema_typed.JSONSchema<any, json_schema_typed.JSONSchema.TypeValue>[]) | json_schema_typed.JSONSchema;
-    properties?: Record<string, json_schema_typed.JSONSchema>;
-    propertyNames?: json_schema_typed.JSONSchema;
-    readOnly?: boolean;
-    required?: string[] | readonly string[];
-    then?: json_schema_typed.JSONSchema<typeof $input | typeof $output, json_schema_typed.JSONSchema.TypeValue> | undefined;
-    title?: string;
-    type?: json_schema_typed.JSONSchema.TypeValue | undefined;
-    unevaluatedItems?: json_schema_typed.JSONSchema;
-    unevaluatedProperties?: json_schema_typed.JSONSchema;
-    uniqueItems?: boolean;
-    writeOnly?: boolean;
-}, zod_v4_core.$ZodType<unknown, unknown, zod_v4_core.$ZodTypeInternals<unknown, unknown>>>;
-/**
- * Zod registry for customizing generated JSON schema, only useful for .input
- *
- * @example
- * ```ts
- * import { JSON_SCHEMA_INPUT_REGISTRY } from '@orpc/zod'
- *
- * const user = z.object({
- *   name: z.string(),
- *   age: z.string().transform(v => Number(v)),
- * })
- *
- * JSON_SCHEMA_INPUT_REGISTRY.add(user, {
- *   examples: [{ name: 'John', age: "20" }],
- * })
- * ```
- */
-declare const JSON_SCHEMA_INPUT_REGISTRY: zod_v4_core.$ZodRegistry<{
-    $anchor?: string;
-    $comment?: string;
-    $defs?: Record<string, json_schema_typed.JSONSchema>;
-    $dynamicAnchor?: string;
-    $dynamicRef?: string;
-    $id?: string;
-    $ref?: string;
-    $schema?: string;
-    $vocabulary?: Record<string, string>;
-    additionalItems?: json_schema_typed.JSONSchema;
-    additionalProperties?: json_schema_typed.JSONSchema;
-    allOf?: (json_schema_typed.JSONSchema<typeof $input, json_schema_typed.JSONSchema.TypeValue>[] | readonly json_schema_typed.JSONSchema<typeof $input, json_schema_typed.JSONSchema.TypeValue>[]) | undefined;
-    anyOf?: (json_schema_typed.JSONSchema<typeof $input, json_schema_typed.JSONSchema.TypeValue>[] | readonly json_schema_typed.JSONSchema<typeof $input, json_schema_typed.JSONSchema.TypeValue>[]) | undefined;
-    const?: typeof $input | undefined;
-    contains?: json_schema_typed.JSONSchema<typeof $input, json_schema_typed.JSONSchema.TypeValue> | undefined;
-    contentEncoding?: "7bit" | "8bit" | "base64" | "binary" | "ietf-token" | "quoted-printable" | "x-token";
-    contentMediaType?: string;
-    contentSchema?: json_schema_typed.JSONSchema<typeof $input, json_schema_typed.JSONSchema.TypeValue> | undefined;
-    default?: typeof $input | undefined;
-    definitions?: Record<string, json_schema_typed.JSONSchema>;
-    dependencies?: Record<string, (string[] | readonly string[]) | json_schema_typed.JSONSchema>;
-    dependentRequired?: Record<string, string[] | readonly string[]>;
-    dependentSchemas?: Record<string, json_schema_typed.JSONSchema>;
-    deprecated?: boolean;
-    description?: string;
-    else?: json_schema_typed.JSONSchema<typeof $input, json_schema_typed.JSONSchema.TypeValue> | undefined;
-    enum?: ((typeof $input)[] | readonly (typeof $input)[]) | undefined;
-    examples?: ((typeof $input)[] | readonly (typeof $input)[]) | undefined;
-    exclusiveMaximum?: number;
-    exclusiveMinimum?: number;
-    format?: string;
-    if?: json_schema_typed.JSONSchema<typeof $input, json_schema_typed.JSONSchema.TypeValue> | undefined;
-    items?: json_schema_typed.JSONSchema;
-    maxContains?: number;
-    maximum?: number;
-    maxItems?: number;
-    maxLength?: number;
-    maxProperties?: number;
-    minContains?: number;
-    minimum?: number;
-    minItems?: number;
-    minLength?: number;
-    minProperties?: number;
-    multipleOf?: number;
-    not?: json_schema_typed.JSONSchema<typeof $input, json_schema_typed.JSONSchema.TypeValue> | undefined;
-    oneOf?: (json_schema_typed.JSONSchema<typeof $input, json_schema_typed.JSONSchema.TypeValue>[] | readonly json_schema_typed.JSONSchema<typeof $input, json_schema_typed.JSONSchema.TypeValue>[]) | undefined;
-    pattern?: string;
-    patternProperties?: Record<string, json_schema_typed.JSONSchema>;
-    prefixItems?: (json_schema_typed.JSONSchema<any, json_schema_typed.JSONSchema.TypeValue>[] | readonly json_schema_typed.JSONSchema<any, json_schema_typed.JSONSchema.TypeValue>[]) | json_schema_typed.JSONSchema;
-    properties?: Record<string, json_schema_typed.JSONSchema>;
-    propertyNames?: json_schema_typed.JSONSchema;
-    readOnly?: boolean;
-    required?: string[] | readonly string[];
-    then?: json_schema_typed.JSONSchema<typeof $input, json_schema_typed.JSONSchema.TypeValue> | undefined;
-    title?: string;
-    type?: json_schema_typed.JSONSchema.TypeValue | undefined;
-    unevaluatedItems?: json_schema_typed.JSONSchema;
-    unevaluatedProperties?: json_schema_typed.JSONSchema;
-    uniqueItems?: boolean;
-    writeOnly?: boolean;
-}, zod_v4_core.$ZodType<unknown, unknown, zod_v4_core.$ZodTypeInternals<unknown, unknown>>>;
-/**
- * Zod registry for customizing generated JSON schema, only useful for .output
- *
- * @example
- * ```ts
- * import { JSON_SCHEMA_OUTPUT_REGISTRY } from '@orpc/zod'
- *
- * const user = z.object({
- *   name: z.string(),
- *   age: z.string().transform(v => Number(v)),
- * })
- *
- * JSON_SCHEMA_OUTPUT_REGISTRY.add(user, {
- *   examples: [{ name: 'John', age: 20 }],
- * })
- * ```
- */
-declare const JSON_SCHEMA_OUTPUT_REGISTRY: zod_v4_core.$ZodRegistry<{
-    $anchor?: string;
-    $comment?: string;
-    $defs?: Record<string, json_schema_typed.JSONSchema>;
-    $dynamicAnchor?: string;
-    $dynamicRef?: string;
-    $id?: string;
-    $ref?: string;
-    $schema?: string;
-    $vocabulary?: Record<string, string>;
-    additionalItems?: json_schema_typed.JSONSchema;
-    additionalProperties?: json_schema_typed.JSONSchema;
-    allOf?: (json_schema_typed.JSONSchema<typeof $output, json_schema_typed.JSONSchema.TypeValue>[] | readonly json_schema_typed.JSONSchema<typeof $output, json_schema_typed.JSONSchema.TypeValue>[]) | undefined;
-    anyOf?: (json_schema_typed.JSONSchema<typeof $output, json_schema_typed.JSONSchema.TypeValue>[] | readonly json_schema_typed.JSONSchema<typeof $output, json_schema_typed.JSONSchema.TypeValue>[]) | undefined;
-    const?: typeof $output | undefined;
-    contains?: json_schema_typed.JSONSchema<typeof $output, json_schema_typed.JSONSchema.TypeValue> | undefined;
-    contentEncoding?: "7bit" | "8bit" | "base64" | "binary" | "ietf-token" | "quoted-printable" | "x-token";
-    contentMediaType?: string;
-    contentSchema?: json_schema_typed.JSONSchema<typeof $output, json_schema_typed.JSONSchema.TypeValue> | undefined;
-    default?: typeof $output | undefined;
-    definitions?: Record<string, json_schema_typed.JSONSchema>;
-    dependencies?: Record<string, (string[] | readonly string[]) | json_schema_typed.JSONSchema>;
-    dependentRequired?: Record<string, string[] | readonly string[]>;
-    dependentSchemas?: Record<string, json_schema_typed.JSONSchema>;
-    deprecated?: boolean;
-    description?: string;
-    else?: json_schema_typed.JSONSchema<typeof $output, json_schema_typed.JSONSchema.TypeValue> | undefined;
-    enum?: ((typeof $output)[] | readonly (typeof $output)[]) | undefined;
-    examples?: ((typeof $output)[] | readonly (typeof $output)[]) | undefined;
-    exclusiveMaximum?: number;
-    exclusiveMinimum?: number;
-    format?: string;
-    if?: json_schema_typed.JSONSchema<typeof $output, json_schema_typed.JSONSchema.TypeValue> | undefined;
-    items?: json_schema_typed.JSONSchema;
-    maxContains?: number;
-    maximum?: number;
-    maxItems?: number;
-    maxLength?: number;
-    maxProperties?: number;
-    minContains?: number;
-    minimum?: number;
-    minItems?: number;
-    minLength?: number;
-    minProperties?: number;
-    multipleOf?: number;
-    not?: json_schema_typed.JSONSchema<typeof $output, json_schema_typed.JSONSchema.TypeValue> | undefined;
-    oneOf?: (json_schema_typed.JSONSchema<typeof $output, json_schema_typed.JSONSchema.TypeValue>[] | readonly json_schema_typed.JSONSchema<typeof $output, json_schema_typed.JSONSchema.TypeValue>[]) | undefined;
-    pattern?: string;
-    patternProperties?: Record<string, json_schema_typed.JSONSchema>;
-    prefixItems?: (json_schema_typed.JSONSchema<any, json_schema_typed.JSONSchema.TypeValue>[] | readonly json_schema_typed.JSONSchema<any, json_schema_typed.JSONSchema.TypeValue>[]) | json_schema_typed.JSONSchema;
-    properties?: Record<string, json_schema_typed.JSONSchema>;
-    propertyNames?: json_schema_typed.JSONSchema;
-    readOnly?: boolean;
-    required?: string[] | readonly string[];
-    then?: json_schema_typed.JSONSchema<typeof $output, json_schema_typed.JSONSchema.TypeValue> | undefined;
-    title?: string;
-    type?: json_schema_typed.JSONSchema.TypeValue | undefined;
-    unevaluatedItems?: json_schema_typed.JSONSchema;
-    unevaluatedProperties?: json_schema_typed.JSONSchema;
-    uniqueItems?: boolean;
-    writeOnly?: boolean;
-}, zod_v4_core.$ZodType<unknown, unknown, zod_v4_core.$ZodTypeInternals<unknown, unknown>>>;
+declare const oz: {
+    file: typeof file;
+    blob: typeof blob;
+    url: typeof url;
+    regexp: typeof regexp;
+    openapi: typeof customJsonSchema;
+};
 
-export { JSON_SCHEMA_INPUT_REGISTRY, JSON_SCHEMA_OUTPUT_REGISTRY, JSON_SCHEMA_REGISTRY, ZodToJsonSchemaConverter };
-export type { ZodToJsonSchemaConverterOptions };
+export { ZodSmartCoercionPlugin, ZodToJsonSchemaConverter, blob, composeParams, customJsonSchema, file, getCustomJsonSchema, getCustomZodDef, oz, regexp, setCustomZodDef, url };
+export type { CustomParams, CustomZodDef, ZodToJsonSchemaOptions };