@kubb/plugin-zod 0.0.0-canary-20241104172400

package/src/plugin.ts

@@ -0,0 +1,139 @@
+import path from 'node:path'
+
+import { FileManager, type Group, PluginManager, createPlugin } from '@kubb/core'
+import { camelCase, pascalCase } from '@kubb/core/transformers'
+import { OperationGenerator, SchemaGenerator, pluginOasName } from '@kubb/plugin-oas'
+
+import { pluginTsName } from '@kubb/plugin-ts'
+
+import type { Plugin } from '@kubb/core'
+import type { PluginOas as SwaggerPluginOptions } from '@kubb/plugin-oas'
+import { operationsGenerator } from './generators'
+import { zodGenerator } from './generators/zodGenerator.tsx'
+import type { PluginZod } from './types.ts'
+
+export const pluginZodName = 'plugin-zod' satisfies PluginZod['name']
+
+export const pluginZod = createPlugin<PluginZod>((options) => {
+  const {
+    output = { path: 'zod', barrelType: 'named' },
+    group,
+    exclude = [],
+    include,
+    override = [],
+    transformers = {},
+    dateType = 'string',
+    unknownType = 'any',
+    typed = false,
+    mapper = {},
+    operations = false,
+    importPath = 'zod',
+    coercion = false,
+    inferred = false,
+    generators = [zodGenerator, operations ? operationsGenerator : undefined].filter(Boolean),
+  } = options
+
+  return {
+    name: pluginZodName,
+    options: {
+      output,
+      transformers,
+      include,
+      exclude,
+      override,
+      typed,
+      dateType,
+      unknownType,
+      mapper,
+      importPath,
+      coercion,
+      operations,
+      inferred,
+    },
+    pre: [pluginOasName, typed ? pluginTsName : undefined].filter(Boolean),
+    resolvePath(baseName, pathMode, options) {
+      const root = path.resolve(this.config.root, this.config.output.path)
+      const mode = pathMode ?? FileManager.getMode(path.resolve(root, output.path))
+
+      if (options?.tag && group?.type === 'tag') {
+        const groupName: Group['name'] = group?.name ? group.name : (ctx) => `${ctx.group}Controller`
+
+        return path.resolve(root, output.path, groupName({ group: camelCase(options.tag) }), baseName)
+      }
+
+      if (mode === 'single') {
+        /**
+         * when output is a file then we will always append to the same file(output file), see fileManager.addOrAppend
+         * Other plugins then need to call addOrAppend instead of just add from the fileManager class
+         */
+        return path.resolve(root, output.path)
+      }
+
+      return path.resolve(root, output.path, baseName)
+    },
+    resolveName(name, type) {
+      let resolvedName = camelCase(name, {
+        suffix: type ? 'schema' : undefined,
+        isFile: type === 'file',
+      })
+
+      if (type === 'type') {
+        resolvedName = pascalCase(resolvedName)
+      }
+
+      if (type) {
+        return transformers?.name?.(resolvedName, type) || resolvedName
+      }
+
+      return resolvedName
+    },
+    async buildStart() {
+      const [swaggerPlugin]: [Plugin<SwaggerPluginOptions>] = PluginManager.getDependedPlugins<SwaggerPluginOptions>(this.plugins, [pluginOasName])
+
+      const oas = await swaggerPlugin.context.getOas()
+      const root = path.resolve(this.config.root, this.config.output.path)
+      const mode = FileManager.getMode(path.resolve(root, output.path))
+
+      const schemaGenerator = new SchemaGenerator(this.plugin.options, {
+        oas,
+        pluginManager: this.pluginManager,
+        plugin: this.plugin,
+        contentType: swaggerPlugin.context.contentType,
+        include: undefined,
+        override,
+        mode,
+        output: output.path,
+      })
+
+      const schemaFiles = await schemaGenerator.build(...generators)
+      await this.addFile(...schemaFiles)
+
+      const operationGenerator = new OperationGenerator(this.plugin.options, {
+        oas,
+        pluginManager: this.pluginManager,
+        plugin: this.plugin,
+        contentType: swaggerPlugin.context.contentType,
+        exclude,
+        include,
+        override,
+        mode,
+      })
+
+      const operationFiles = await operationGenerator.build(...generators)
+      await this.addFile(...operationFiles)
+
+      const barrelFiles = await this.fileManager.getBarrelFiles({
+        type: output.barrelType ?? 'named',
+        root,
+        output,
+        files: this.fileManager.files,
+        meta: {
+          pluginKey: this.plugin.key,
+        },
+        logger: this.logger,
+      })
+
+      await this.addFile(...barrelFiles)
+    },
+  }
+})

package/src/types.ts

@@ -0,0 +1,106 @@
+import type { Group, Output, PluginFactoryOptions, ResolveNameParams } from '@kubb/core'
+import type { SchemaObject } from '@kubb/oas'
+import type { Exclude, Generator, Include, Override, ResolvePathOptions, Schema } from '@kubb/plugin-oas'
+
+export type Options = {
+  /**
+   * @default 'zod'
+   */
+  output?: Output
+  /**
+   * 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 will be used as `import { z } from '${importPath}'`.
+   * It allows both relative and absolute path.
+   * the path will be applied as is, so relative path should be based on the file being generated.
+   * @default 'zod'
+   */
+  importPath?: string
+
+  /**
+   * Choose to use `date` or `datetime` as JavaScript `Date` instead of `string`.
+   * False will fallback on a simple z.string() format
+   * @default 'string' 'stringOffset' will become the default in Kubb v3
+   */
+  dateType?: false | 'string' | 'stringOffset' | 'stringLocal' | 'date'
+  /**
+   * Which type to use when the Swagger/OpenAPI file is not providing more information
+   * @default 'any'
+   */
+  unknownType?: 'any' | 'unknown'
+  /**
+   * 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(propertName) and return FakerMeta array
+     * TODO TODO add docs
+     * @beta
+     */
+    schema?: (
+      props: {
+        schema?: SchemaObject
+        name?: string
+        parentName?: string
+      },
+      defaultSchemas: Schema[],
+    ) => Schema[] | undefined
+  }
+  /**
+   * Define some generators next to the zod generators
+   */
+  generators?: Array<Generator<PluginZod>>
+}
+
+type ResolvedOptions = {
+  output: Output
+  override: NonNullable<Options['override']>
+  transformers: NonNullable<Options['transformers']>
+  dateType: NonNullable<Options['dateType']>
+  unknownType: NonNullable<Options['unknownType']>
+  typed: NonNullable<Options['typed']>
+  inferred: NonNullable<Options['inferred']>
+  mapper: NonNullable<Options['mapper']>
+  importPath: NonNullable<Options['importPath']>
+  coercion: NonNullable<Options['coercion']>
+  operations: NonNullable<Options['operations']>
+}
+
+export type PluginZod = PluginFactoryOptions<'plugin-zod', Options, ResolvedOptions, never, ResolvePathOptions>