@kubb/plugin-zod 5.0.0-alpha.3 → 5.0.0-alpha.31

package/dist/types-D0wsPC6Y.d.ts

@@ -1,172 +0,0 @@
-import { t as __name } from "./chunk--u3MIqq1.js";
-import { Group, Output, PluginFactoryOptions, ResolveNameParams } from "@kubb/core";
-import { Exclude, Include, Override, ResolvePathOptions, Schema } from "@kubb/plugin-oas";
-import { Generator } from "@kubb/plugin-oas/generators";
-import { Oas, SchemaObject, contentType } from "@kubb/oas";
-
-//#region src/types.d.ts
-type Options = {
-  /**
-   * @default 'zod'
-   */
-  output?: Output<Oas>;
-  /**
-   * Define which contentType should be used.
-   * By default, the first JSON valid mediaType is used
-   */
-  contentType?: contentType;
-  /**
-   * Group the Zod schemas based on the provided name.
-   */
-  group?: Group;
-  /**
-   * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
-   */
-  exclude?: Array<Exclude>;
-  /**
-   * Array containing include parameters to include tags/operations/methods/paths.
-   */
-  include?: Array<Include>;
-  /**
-   * Array containing override parameters to override `options` based on tags/operations/methods/paths.
-   */
-  override?: Array<Override<ResolvedOptions>>;
-  /**
-   * Path to Zod
-   * It used as `import { z } from '${importPath}'`.
-   * Accepts relative and absolute paths.
-   * Path is used as-is; relative paths are based on the generated file location.
-   * @default 'zod'
-   */
-  importPath?: string;
-  /**
-   * Choose to use date or datetime as JavaScript Date instead of string.
-   * - false falls back to a simple z.string() format.
-   * - 'string' uses z.string().datetime() for datetime validation.
-   * - 'stringOffset' uses z.string().datetime({ offset: true }) for datetime with timezone offset validation.
-   * - 'stringLocal' uses z.string().datetime({ local: true }) for local datetime validation.
-   * - 'date' uses z.date() for JavaScript Date objects.
-   * @default 'string'
-   * @note 'stringOffset' will become the default in Kubb v3.
-   */
-  dateType?: false | 'string' | 'stringOffset' | 'stringLocal' | 'date';
-  /**
-   * Choose to use `number` or `bigint` for integer fields with `int64` format.
-   * - 'number' uses the JavaScript `number` type (matches JSON.parse() runtime behavior).
-   * - 'bigint' uses the JavaScript `bigint` type (accurate for values exceeding Number.MAX_SAFE_INTEGER).
-   * @note in v5 of Kubb 'bigint' will become the default to better align with OpenAPI's int64 specification.
-   * @default 'number'
-   */
-  integerType?: 'number' | 'bigint';
-  /**
-   * Which type to use when the Swagger/OpenAPI file is not providing more information.
-   * - 'any' allows any value.
-   * - 'unknown' requires type narrowing before use.
-   * - 'void' represents no value.
-   * @default 'any'
-   */
-  unknownType?: 'any' | 'unknown' | 'void';
-  /**
-   * Which type to use for empty schema values.
-   * - 'any' allows any value.
-   * - 'unknown' requires type narrowing before use.
-   * - 'void' represents no value.
-   * @default `unknownType`
-   */
-  emptySchemaType?: 'any' | 'unknown' | 'void';
-  /**
-   * Use TypeScript(`@kubb/plugin-ts`) to add type annotation.
-   */
-  typed?: boolean;
-  /**
-   * Return Zod generated schema as type with z.infer<TYPE>
-   */
-  inferred?: boolean;
-  /**
-   * Use of z.coerce.string() instead of z.string()
-   * can also be an object to enable coercion for dates, strings, and numbers
-   */
-  coercion?: boolean | {
-    dates?: boolean;
-    strings?: boolean;
-    numbers?: boolean;
-  };
-  operations?: boolean;
-  mapper?: Record<string, string>;
-  transformers?: {
-    /**
-     * Customize the names based on the type that is provided by the plugin.
-     */
-    name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
-    /**
-     * Receive schema and baseName(propertyName) and return FakerMeta array
-     * TODO TODO add docs
-     * @beta
-     */
-    schema?: (props: {
-      schema: SchemaObject | null;
-      name: string | null;
-      parentName: string | null;
-    }, defaultSchemas: Schema[]) => Schema[] | undefined;
-  };
-  /**
-   * Which version of Zod should be used.
-   * - '3' uses Zod v3.x syntax and features.
-   * - '4' uses Zod v4.x syntax and features.
-   * @default '3'
-   */
-  version?: '3' | '4';
-  /**
-   * Which Zod GUID validator to use for OpenAPI `format: uuid`.
-   * - 'uuid' uses UUID validation.
-   * - 'guid' uses GUID validation (Zod v4 only).
-   * @default 'uuid'
-   */
-  guidType?: 'uuid' | 'guid';
-  /**
-   * Use Zod Mini's functional API for better tree-shaking support.
-   * When enabled, generates functional syntax (e.g., `z.optional(z.string())`) instead of chainable methods (e.g., `z.string().optional()`).
-   * Requires Zod v4 or later. When `mini: true`, `version` is set to '4' and `importPath` will default to 'zod/mini'.
-   * @default false
-   */
-  mini?: boolean;
-  /**
-   * Callback function to wrap the output of the generated zod schema
-   *
-   * This is useful for edge case scenarios where you might leverage something like `z.object({ ... }).openapi({ example: { some: "complex-example" }})`
-   * or `extendApi(z.object({ ... }), { example: { some: "complex-example", ...otherOpenApiProperties }})`
-   * while going from openapi -> zod -> openapi
-   */
-  wrapOutput?: (arg: {
-    output: string;
-    schema: SchemaObject;
-  }) => string | undefined;
-  /**
-   * Define some generators next to the zod generators
-   */
-  generators?: Array<Generator<PluginZod>>;
-};
-type ResolvedOptions = {
-  output: Output<Oas>;
-  group: Options['group'];
-  override: NonNullable<Options['override']>;
-  transformers: NonNullable<Options['transformers']>;
-  dateType: NonNullable<Options['dateType']>;
-  integerType: NonNullable<Options['integerType']>;
-  unknownType: NonNullable<Options['unknownType']>;
-  emptySchemaType: NonNullable<Options['emptySchemaType']>;
-  typed: NonNullable<Options['typed']>;
-  inferred: NonNullable<Options['inferred']>;
-  mapper: NonNullable<Options['mapper']>;
-  importPath: NonNullable<Options['importPath']>;
-  coercion: NonNullable<Options['coercion']>;
-  operations: NonNullable<Options['operations']>;
-  wrapOutput: Options['wrapOutput'];
-  version: NonNullable<Options['version']>;
-  guidType: NonNullable<Options['guidType']>;
-  mini: NonNullable<Options['mini']>;
-};
-type PluginZod = PluginFactoryOptions<'plugin-zod', Options, ResolvedOptions, never, ResolvePathOptions>;
-//#endregion
-export { PluginZod as n, Options as t };
-//# sourceMappingURL=types-D0wsPC6Y.d.ts.map

package/src/components/index.ts

@@ -1,2 +0,0 @@
-export { Operations } from './Operations.tsx'
-export { Zod } from './Zod.tsx'

package/src/generators/index.ts

@@ -1,2 +0,0 @@
-export { operationsGenerator } from './operationsGenerator.tsx'
-export { zodGenerator } from './zodGenerator.tsx'

package/src/generators/operationsGenerator.tsx

@@ -1,50 +0,0 @@
-import { usePluginManager } from '@kubb/core/hooks'
-import { createReactGenerator } from '@kubb/plugin-oas/generators'
-import { useOas, useOperationManager } from '@kubb/plugin-oas/hooks'
-import { getBanner, getFooter } from '@kubb/plugin-oas/utils'
-import { File } from '@kubb/react-fabric'
-import { Operations } from '../components/Operations.tsx'
-import type { PluginZod } from '../types'
-
-export const operationsGenerator = createReactGenerator<PluginZod>({
-  name: 'operations',
-  Operations({ operations, generator, plugin }) {
-    const {
-      name: pluginName,
-      options: { output, importPath },
-    } = plugin
-    const pluginManager = usePluginManager()
-
-    const oas = useOas()
-    const { getFile, groupSchemasByName } = useOperationManager(generator)
-
-    const name = 'operations'
-    const file = pluginManager.getFile({ name, extname: '.ts', pluginName })
-
-    const transformedOperations = operations.map((operation) => ({ operation, data: groupSchemasByName(operation, { type: 'function' }) }))
-
-    const imports = Object.entries(transformedOperations)
-      .map(([key, { data, operation }]) => {
-        const names = [data.request, ...Object.values(data.responses), ...Object.values(data.parameters)].filter(Boolean)
-
-        return <File.Import key={key} name={names} root={file.path} path={getFile(operation).path} />
-      })
-      .filter(Boolean)
-
-    const isZodImport = importPath === 'zod' || importPath === 'zod/mini'
-
-    return (
-      <File
-        baseName={file.baseName}
-        path={file.path}
-        meta={file.meta}
-        banner={getBanner({ oas, output, config: pluginManager.config })}
-        footer={getFooter({ oas, output })}
-      >
-        <File.Import isTypeOnly name={isZodImport ? 'z' : ['z']} path={importPath} isNameSpace={isZodImport} />
-        {imports}
-        <Operations name={name} operations={transformedOperations} />
-      </File>
-    )
-  },
-})