@orpc/zod 0.0.0-next.cc4cb21 → 0.0.0-next.cc8802c

package/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
 </div>
 
 <h1></h1>

package/dist/index.d.mts

@@ -0,0 +1,82 @@
+import { JSONSchema, ConditionalSchemaConverter, SchemaConvertOptions } from '@orpc/openapi';
+import { ZodTypeAny, input, output, ZodTypeDef, CustomErrorParams, ZodType, ZodEffects } from 'zod';
+import { Context } from '@orpc/server';
+import { HandlerPlugin } from '@orpc/server/plugins';
+import { StandardHandlerOptions } from '@orpc/server/standard';
+import { AnySchema } from '@orpc/contract';
+
+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 HandlerPlugin<TContext> {
+    init(options: StandardHandlerOptions<TContext>): void;
+}
+
+interface ZodToJsonSchemaOptions {
+    /**
+     * Max depth of lazy type, if it exceeds.
+     *
+     * Used `{}` when reach max depth
+     *
+     * @default 3
+     */
+    maxLazyDepth?: number;
+    /**
+     * The schema to be used when the Zod schema is unsupported.
+     *
+     * @default { not: {} }
+     */
+    unsupportedJsonSchema?: Exclude<JSONSchema, boolean>;
+    /**
+     * The schema to be used to represent the any | unknown type.
+     *
+     * @default { }
+     */
+    anyJsonSchema?: Exclude<JSONSchema, boolean>;
+}
+declare class ZodToJsonSchemaConverter implements ConditionalSchemaConverter {
+    #private;
+    private readonly maxLazyDepth;
+    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): [required: boolean, jsonSchema: Exclude<JSONSchema, boolean>];
+}
+
+declare const oz: {
+    file: typeof file;
+    blob: typeof blob;
+    url: typeof url;
+    regexp: typeof regexp;
+    openapi: typeof customJsonSchema;
+};
+
+export { type CustomParams, type CustomZodDef, ZodSmartCoercionPlugin, ZodToJsonSchemaConverter, type ZodToJsonSchemaOptions, blob, composeParams, customJsonSchema, file, getCustomJsonSchema, getCustomZodDef, oz, regexp, setCustomZodDef, url };

package/dist/index.d.ts

@@ -0,0 +1,82 @@
+import { JSONSchema, ConditionalSchemaConverter, SchemaConvertOptions } from '@orpc/openapi';
+import { ZodTypeAny, input, output, ZodTypeDef, CustomErrorParams, ZodType, ZodEffects } from 'zod';
+import { Context } from '@orpc/server';
+import { HandlerPlugin } from '@orpc/server/plugins';
+import { StandardHandlerOptions } from '@orpc/server/standard';
+import { AnySchema } from '@orpc/contract';
+
+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 HandlerPlugin<TContext> {
+    init(options: StandardHandlerOptions<TContext>): void;
+}
+
+interface ZodToJsonSchemaOptions {
+    /**
+     * Max depth of lazy type, if it exceeds.
+     *
+     * Used `{}` when reach max depth
+     *
+     * @default 3
+     */
+    maxLazyDepth?: number;
+    /**
+     * The schema to be used when the Zod schema is unsupported.
+     *
+     * @default { not: {} }
+     */
+    unsupportedJsonSchema?: Exclude<JSONSchema, boolean>;
+    /**
+     * The schema to be used to represent the any | unknown type.
+     *
+     * @default { }
+     */
+    anyJsonSchema?: Exclude<JSONSchema, boolean>;
+}
+declare class ZodToJsonSchemaConverter implements ConditionalSchemaConverter {
+    #private;
+    private readonly maxLazyDepth;
+    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): [required: boolean, jsonSchema: Exclude<JSONSchema, boolean>];
+}
+
+declare const oz: {
+    file: typeof file;
+    blob: typeof blob;
+    url: typeof url;
+    regexp: typeof regexp;
+    openapi: typeof customJsonSchema;
+};
+
+export { type CustomParams, type CustomZodDef, ZodSmartCoercionPlugin, ZodToJsonSchemaConverter, type ZodToJsonSchemaOptions, blob, composeParams, customJsonSchema, file, getCustomJsonSchema, getCustomZodDef, oz, regexp, setCustomZodDef, url };