@temporary-name/zod 1.9.3-alpha.0d2fa3247b6b23bbc2e3097a95f631b86740e4d8

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Stainless
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,67 @@
+## `@temporary-name/zod`
+
+More schemas that [Zod](https://zod.dev/) doesn't support yet, and provides `ZodToJsonSchemaConverter` for generating OpenAPI specs.
+
+### More Schemas
+
+- `oz.url`: Zod schema for [URL](https://developer.mozilla.org/en-US/docs/Web/API/URL) instance.
+- `oz.blob`: Zod schema for [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) instance.
+- `oz.file`: Zod schema for [File](https://developer.mozilla.org/en-US/docs/Web/API/File) instance.
+- `oz.regexp`: Zod schema for [RegExp](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp) instance.
+
+```ts
+import { oz } from '@temporary-name/zod'
+import { z } from 'zod/v3'
+
+const Example = z.object({
+  url: oz.url(),
+  blob: oz.blob(),
+  file: oz.file().type('image/png'),
+  regexp: oz.regexp(),
+})
+```
+
+### Generate OpenAPI Spec
+
+```ts
+import { OpenAPIGenerator } from '@temporary-name/openapi'
+import { ZodToJsonSchemaConverter } from '@temporary-name/zod/zod4'
+
+const openAPIGenerator = new OpenAPIGenerator({
+  schemaConverters: [new ZodToJsonSchemaConverter()],
+})
+
+const specFromContract = await openAPIGenerator.generate(contract, {
+  info: {
+    title: 'My App',
+    version: '0.0.0',
+  },
+})
+
+const specFromRouter = await openAPIGenerator.generate(router, {
+  info: {
+    title: 'My App',
+    version: '0.0.0',
+  },
+})
+```
+
+### Extending the Specification
+
+```ts
+import { oz } from '@temporary-name/zod'
+import * as z from 'zod'
+
+const InputSchema = oz.openapi(
+  z.object({
+    name: z.string(),
+  }),
+  {
+    examples: [
+      { name: 'Earth' },
+      { name: 'Mars' },
+    ],
+    // additional options...
+  }
+)
+```

package/dist/index.d.mts

@@ -0,0 +1,91 @@
+import { JSONSchema, ConditionalSchemaConverter, SchemaConvertOptions } from '@temporary-name/openapi';
+import { ZodTypeAny, input, output, ZodTypeDef, CustomErrorParams, ZodType, ZodEffects } from 'zod/v3';
+import { Context } from '@temporary-name/server';
+import { StandardHandlerPlugin, StandardHandlerOptions } from '@temporary-name/server/standard';
+import { AnySchema } from '@temporary-name/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 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 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>];
+}
+
+declare const oz: {
+    file: typeof file;
+    blob: typeof blob;
+    url: typeof url;
+    regexp: typeof regexp;
+    openapi: typeof customJsonSchema;
+};
+
+export { ZodSmartCoercionPlugin, ZodToJsonSchemaConverter, blob, composeParams, customJsonSchema, file, getCustomJsonSchema, getCustomZodDef, oz, regexp, setCustomZodDef, url };
+export type { CustomParams, CustomZodDef, ZodToJsonSchemaOptions };

package/dist/index.d.ts

@@ -0,0 +1,91 @@
+import { JSONSchema, ConditionalSchemaConverter, SchemaConvertOptions } from '@temporary-name/openapi';
+import { ZodTypeAny, input, output, ZodTypeDef, CustomErrorParams, ZodType, ZodEffects } from 'zod/v3';
+import { Context } from '@temporary-name/server';
+import { StandardHandlerPlugin, StandardHandlerOptions } from '@temporary-name/server/standard';
+import { AnySchema } from '@temporary-name/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 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 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>];
+}
+
+declare const oz: {
+    file: typeof file;
+    blob: typeof blob;
+    url: typeof url;
+    regexp: typeof regexp;
+    openapi: typeof customJsonSchema;
+};
+
+export { ZodSmartCoercionPlugin, ZodToJsonSchemaConverter, blob, composeParams, customJsonSchema, file, getCustomJsonSchema, getCustomZodDef, oz, regexp, setCustomZodDef, url };
+export type { CustomParams, CustomZodDef, ZodToJsonSchemaOptions };