@kubb/plugin-oas 4.31.0 → 4.31.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-oas",
-  "version": "4.31.0",
+  "version": "4.31.1",
   "description": "OpenAPI Specification (OAS) plugin for Kubb, providing core functionality for parsing and processing OpenAPI/Swagger schemas for code generation.",
   "keywords": [
     "openapi",
@@ -81,13 +81,13 @@
     }
   ],
   "dependencies": {
-    "@kubb/react-fabric": "0.13.2",
+    "@kubb/react-fabric": "0.13.3",
     "remeda": "^2.33.6",
-    "@kubb/core": "4.31.0",
-    "@kubb/oas": "4.31.0"
+    "@kubb/core": "4.31.1",
+    "@kubb/oas": "4.31.1"
   },
   "peerDependencies": {
-    "@kubb/react-fabric": "0.13.2"
+    "@kubb/react-fabric": "0.13.3"
   },
   "engines": {
     "node": ">=20"

package/dist/SchemaMapper-nkCtMfTV.d.ts

@@ -1,294 +0,0 @@
-import { KubbFile } from "@kubb/fabric-core/types";
-import { SchemaObject } from "@kubb/oas";
-
-//#region \0rolldown/runtime.js
-//#endregion
-//#region src/SchemaMapper.d.ts
-type SchemaKeywordMapper = {
-  object: {
-    keyword: 'object';
-    args: {
-      properties: {
-        [x: string]: Schema[];
-      };
-      additionalProperties: Schema[];
-      patternProperties?: Record<string, Schema[]>;
-      strict?: boolean;
-    };
-  };
-  url: {
-    keyword: 'url';
-  };
-  readOnly: {
-    keyword: 'readOnly';
-  };
-  writeOnly: {
-    keyword: 'writeOnly';
-  };
-  uuid: {
-    keyword: 'uuid';
-  };
-  email: {
-    keyword: 'email';
-  };
-  firstName: {
-    keyword: 'firstName';
-  };
-  lastName: {
-    keyword: 'lastName';
-  };
-  phone: {
-    keyword: 'phone';
-  };
-  password: {
-    keyword: 'password';
-  };
-  date: {
-    keyword: 'date';
-    args: {
-      type?: 'date' | 'string';
-    };
-  };
-  time: {
-    keyword: 'time';
-    args: {
-      type?: 'date' | 'string';
-    };
-  };
-  datetime: {
-    keyword: 'datetime';
-    args: {
-      offset?: boolean;
-      local?: boolean;
-    };
-  };
-  tuple: {
-    keyword: 'tuple';
-    args: {
-      items: Schema[];
-      min?: number;
-      max?: number;
-      rest?: Schema;
-    };
-  };
-  array: {
-    keyword: 'array';
-    args: {
-      items: Schema[];
-      min?: number;
-      max?: number;
-      unique?: boolean;
-    };
-  };
-  enum: {
-    keyword: 'enum';
-    args: {
-      name: string;
-      typeName: string;
-      asConst: boolean;
-      items: Array<{
-        name: string | number;
-        format: 'string' | 'number' | 'boolean';
-        value?: string | number | boolean;
-      }>;
-    };
-  };
-  and: {
-    keyword: 'and';
-    args: Schema[];
-  };
-  const: {
-    keyword: 'const';
-    args: {
-      name: string | number;
-      format: 'string' | 'number' | 'boolean';
-      value?: string | number | boolean;
-    };
-  };
-  union: {
-    keyword: 'union';
-    args: Schema[];
-  };
-  ref: {
-    keyword: 'ref';
-    args: {
-      name: string;
-      $ref: string;
-      /**
-       * Full qualified path.
-       */
-      path: KubbFile.Path;
-      /**
-       * When true `File.Import` is used.
-       * When false a reference is used inside the current file.
-       */
-      isImportable: boolean;
-    };
-  };
-  matches: {
-    keyword: 'matches';
-    args?: string;
-  };
-  boolean: {
-    keyword: 'boolean';
-  };
-  default: {
-    keyword: 'default';
-    args: string | number | boolean;
-  };
-  string: {
-    keyword: 'string';
-  };
-  integer: {
-    keyword: 'integer';
-  };
-  bigint: {
-    keyword: 'bigint';
-  };
-  number: {
-    keyword: 'number';
-  };
-  max: {
-    keyword: 'max';
-    args: number;
-  };
-  min: {
-    keyword: 'min';
-    args: number;
-  };
-  exclusiveMaximum: {
-    keyword: 'exclusiveMaximum';
-    args: number;
-  };
-  exclusiveMinimum: {
-    keyword: 'exclusiveMinimum';
-    args: number;
-  };
-  describe: {
-    keyword: 'describe';
-    args: string;
-  };
-  example: {
-    keyword: 'example';
-    args: string;
-  };
-  deprecated: {
-    keyword: 'deprecated';
-  };
-  optional: {
-    keyword: 'optional';
-  };
-  undefined: {
-    keyword: 'undefined';
-  };
-  nullish: {
-    keyword: 'nullish';
-  };
-  nullable: {
-    keyword: 'nullable';
-  };
-  null: {
-    keyword: 'null';
-  };
-  any: {
-    keyword: 'any';
-  };
-  unknown: {
-    keyword: 'unknown';
-  };
-  void: {
-    keyword: 'void';
-  };
-  blob: {
-    keyword: 'blob';
-  };
-  schema: {
-    keyword: 'schema';
-    args: {
-      type: 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object';
-      format?: string;
-    };
-  };
-  name: {
-    keyword: 'name';
-    args: string;
-  };
-  catchall: {
-    keyword: 'catchall';
-  };
-  interface: {
-    keyword: 'interface';
-  };
-};
-declare const schemaKeywords: {
-  any: "any";
-  unknown: "unknown";
-  number: "number";
-  integer: "integer";
-  bigint: "bigint";
-  string: "string";
-  boolean: "boolean";
-  undefined: "undefined";
-  nullable: "nullable";
-  null: "null";
-  nullish: "nullish";
-  array: "array";
-  tuple: "tuple";
-  enum: "enum";
-  union: "union";
-  datetime: "datetime";
-  date: "date";
-  email: "email";
-  uuid: "uuid";
-  url: "url";
-  void: "void";
-  default: "default";
-  const: "const";
-  and: "and";
-  describe: "describe";
-  min: "min";
-  max: "max";
-  exclusiveMinimum: "exclusiveMinimum";
-  exclusiveMaximum: "exclusiveMaximum";
-  optional: "optional";
-  readOnly: "readOnly";
-  writeOnly: "writeOnly";
-  object: "object";
-  ref: "ref";
-  matches: "matches";
-  firstName: "firstName";
-  lastName: "lastName";
-  password: "password";
-  phone: "phone";
-  blob: "blob";
-  deprecated: "deprecated";
-  example: "example";
-  schema: "schema";
-  catchall: "catchall";
-  time: "time";
-  name: "name";
-  interface: "interface";
-};
-type SchemaKeyword = keyof SchemaKeywordMapper;
-type SchemaMapper<T = string | null | undefined> = { [K in keyof SchemaKeywordMapper]: (() => T | undefined) | undefined };
-type SchemaKeywordBase<T> = {
-  keyword: SchemaKeyword;
-  args: T;
-};
-type Schema = {
-  keyword: string;
-} | SchemaKeywordMapper[keyof SchemaKeywordMapper];
-type SchemaTree = {
-  schema: SchemaObject;
-  parent: Schema | undefined;
-  current: Schema;
-  siblings: Schema[];
-  /**
-   * this is equal to the key of a property(object)
-   */
-  name?: string;
-};
-declare function isKeyword<T extends Schema, K extends keyof SchemaKeywordMapper>(meta: T, keyword: K): meta is Extract<T, SchemaKeywordMapper[K]>;
-//#endregion
-export { SchemaMapper as a, schemaKeywords as c, SchemaKeywordMapper as i, __name as l, SchemaKeyword as n, SchemaTree as o, SchemaKeywordBase as r, isKeyword as s, Schema as t };
-//# sourceMappingURL=SchemaMapper-nkCtMfTV.d.ts.map

package/dist/createGenerator-Dh3WEfpI.d.ts

@@ -1,362 +0,0 @@
-import { i as SchemaKeywordMapper, l as __name, t as Schema } from "./SchemaMapper-nkCtMfTV.js";
-import { BaseGenerator, Config, FileMetaBase, Group, KubbEvents, Output, Plugin, PluginFactoryOptions, PluginManager, ResolveNameParams } from "@kubb/core";
-import { KubbFile } from "@kubb/fabric-core/types";
-import { HttpMethod, Oas, Operation, SchemaObject, contentType } from "@kubb/oas";
-import { AsyncEventEmitter } from "@kubb/core/utils";
-import { Fabric } from "@kubb/react-fabric";
-import { FabricReactNode } from "@kubb/react-fabric/types";
-
-//#region src/types.d.ts
-type GetOasOptions = {
-  validate?: boolean;
-};
-type Context$2 = {
-  getOas(options?: GetOasOptions): Promise<Oas>;
-  getBaseURL(): Promise<string | undefined>;
-};
-declare global {
-  namespace Kubb {
-    interface PluginContext extends Context$2 {}
-  }
-}
-type ResolvePathOptions = {
-  pluginKey?: Plugin['key'];
-  group?: {
-    tag?: string;
-    path?: string;
-  };
-  type?: ResolveNameParams['type'];
-};
-type Options = {
-  /**
-   * Validate your input(see kubb.config) based on '@readme/openapi-parser'.
-   * @default true
-   */
-  validate?: boolean;
-  /**
-   * Specify the export location for the files and define the behavior of the output
-   * @default { path: 'schemas', barrelType: 'named' }
-   */
-  output?: Output<Oas>;
-  /**
-   * Group the JSON files based on the provided name.
-   */
-  group?: Group;
-  /**
-   * Which server to use from the array of `servers.url[serverIndex]`
-   * @example
-   * - `0` returns `http://petstore.swagger.io/api`
-   * - `1` returns `http://localhost:3000`
-   */
-  serverIndex?: number;
-  /**
-   * Define which contentType should be used.
-   * By default, uses the first valid JSON media type.
-   */
-  contentType?: contentType;
-  /**
-   * Defines how the discriminator value should be interpreted during processing.
-   * - 'strict' uses the oneOf schemas as defined, without modification.
-   * - 'inherit' replaces the oneOf schema with the schema referenced by discriminator.mapping[key].
-   * @default 'strict'
-   * @see https://github.com/kubb-labs/kubb/issues/1736
-   */
-  discriminator?: 'strict' | 'inherit';
-  /**
-   * Override some behavior of the Oas class instance, see '@kubb/oas'
-   */
-  oasClass?: typeof Oas;
-  /**
-   * Define some generators next to the JSON generation
-   */
-  generators?: Array<Generator<PluginOas>>;
-  /**
-   * Resolve name collisions when schemas from different components share the same name (case-insensitive).
-   *
-   * When enabled, Kubb automatically detects and resolves collisions using intelligent suffixes:
-   * - Cross-component collisions: Adds semantic suffixes based on the component type (Schema/Response/Request)
-   * - Same-component collisions: Adds numeric suffixes (2, 3, ...) for case-insensitive duplicates
-   * - Nested enum collisions: Includes root schema name in enum names to prevent duplicates across schemas
-   *
-   * When disabled (legacy behavior), collisions may result in duplicate files or overwrite issues.
-   *
-   * **Cross-component collision example:**
-   * If you have "Order" in both schemas and requestBodies:
-   * - With `collisionDetection: true`: Generates `OrderSchema.ts`, `OrderRequest.ts`
-   * - With `collisionDetection: false`: May generate duplicate `Order.ts` files
-   *
-   * **Same-component collision example:**
-   * If you have "Variant" and "variant" in schemas:
-   * - With `collisionDetection: true`: Generates `Variant.ts`, `Variant2.ts`
-   * - With `collisionDetection: false`: May overwrite or create duplicates
-   *
-   * **Nested enum collision example:**
-   * If you have "params.channel" enum in both "NotificationTypeA" and "NotificationTypeB":
-   * - With `collisionDetection: true`: Generates `notificationTypeAParamsChannelEnum`, `notificationTypeBParamsChannelEnum`
-   * - With `collisionDetection: false`: Generates duplicate `paramsChannelEnum` in both files
-   *
-   * @default false (will be `true` in v5)
-   * @see https://github.com/kubb-labs/kubb/issues/1999
-   * @note In Kubb v5, this will be enabled by default and the deprecated `usedEnumNames` mechanism will be removed
-   */
-  collisionDetection?: boolean;
-};
-/**
- * `propertyName` is the ref name + resolved with the nameResolver
- *  @example import { Pet } from './Pet'
- *
- * `originalName` is the original name used(in PascalCase), only used to remove duplicates
- *
- * `pluginKey` can be used to override the current plugin being used, handy when you want to import a type/schema out of another plugin
- * @example import a type(plugin-ts) for a mock file(swagger-faker)
- */
-type Ref = {
-  propertyName: string;
-  originalName: string;
-  path: KubbFile.Path;
-  pluginKey?: Plugin['key'];
-};
-type Refs = Record<string, Ref>;
-type Resolver = {
-  /**
-   * Original name or name resolved by `resolveName({ name: operation?.getOperationId() as string, pluginName })`
-   */
-  name: string;
-  baseName: KubbFile.BaseName;
-  path: KubbFile.Path;
-};
-type OperationSchema = {
-  /**
-   * Converted name, contains already `PathParams`, `QueryParams`, ...
-   */
-  name: string;
-  schema: SchemaObject;
-  operation?: Operation;
-  /**
-   * OperationName in PascalCase, only being used in OperationGenerator
-   */
-  operationName: string;
-  description?: string;
-  statusCode?: number;
-  keys?: string[];
-  keysToOmit?: string[];
-  withData?: boolean;
-};
-type OperationSchemas = {
-  pathParams?: OperationSchema & {
-    keysToOmit?: never;
-  };
-  queryParams?: OperationSchema & {
-    keysToOmit?: never;
-  };
-  headerParams?: OperationSchema & {
-    keysToOmit?: never;
-  };
-  request?: OperationSchema;
-  response: OperationSchema;
-  responses: Array<OperationSchema>;
-  statusCodes?: Array<OperationSchema>;
-  errors?: Array<OperationSchema>;
-};
-type ByTag = {
-  type: 'tag';
-  pattern: string | RegExp;
-};
-type ByOperationId = {
-  type: 'operationId';
-  pattern: string | RegExp;
-};
-type ByPath = {
-  type: 'path';
-  pattern: string | RegExp;
-};
-type ByMethod = {
-  type: 'method';
-  pattern: HttpMethod | RegExp;
-};
-type BySchemaName = {
-  type: 'schemaName';
-  pattern: string | RegExp;
-};
-type ByContentType = {
-  type: 'contentType';
-  pattern: string | RegExp;
-};
-type Exclude = ByTag | ByOperationId | ByPath | ByMethod | ByContentType;
-type Include = ByTag | ByOperationId | ByPath | ByMethod | ByContentType;
-type Override<TOptions> = (ByTag | ByOperationId | ByPath | ByMethod | BySchemaName | ByContentType) & {
-  options: Partial<TOptions>;
-};
-type ResolvedOptions = Options & {
-  output: Output<Oas>;
-};
-type PluginOas = PluginFactoryOptions<'plugin-oas', Options, ResolvedOptions, Context$2, ResolvePathOptions>;
-//#endregion
-//#region src/OperationGenerator.d.ts
-type OperationMethodResult<TFileMeta extends FileMetaBase> = Promise<KubbFile.File<TFileMeta> | Array<KubbFile.File<TFileMeta>> | null>;
-type Context$1<TOptions, TPluginOptions extends PluginFactoryOptions> = {
-  fabric: Fabric;
-  oas: Oas;
-  exclude: Array<Exclude> | undefined;
-  include: Array<Include> | undefined;
-  override: Array<Override<TOptions>> | undefined;
-  contentType: contentType | undefined;
-  pluginManager: PluginManager;
-  events?: AsyncEventEmitter<KubbEvents>;
-  /**
-   * Current plugin
-   */
-  plugin: Plugin<TPluginOptions>;
-  mode: KubbFile.Mode;
-  UNSTABLE_NAMING?: true;
-};
-declare class OperationGenerator<TPluginOptions extends PluginFactoryOptions = PluginFactoryOptions, TFileMeta extends FileMetaBase = FileMetaBase> extends BaseGenerator<TPluginOptions['resolvedOptions'], Context$1<TPluginOptions['resolvedOptions'], TPluginOptions>> {
-  #private;
-  getOptions(operation: Operation, method: HttpMethod): Partial<TPluginOptions['resolvedOptions']>;
-  getSchemas(operation: Operation, {
-    resolveName
-  }?: {
-    resolveName?: (name: string) => string;
-  }): OperationSchemas;
-  getOperations(): Promise<Array<{
-    path: string;
-    method: HttpMethod;
-    operation: Operation;
-  }>>;
-  build(...generators: Array<Generator<TPluginOptions>>): Promise<Array<KubbFile.File<TFileMeta>>>;
-}
-//#endregion
-//#region src/SchemaGenerator.d.ts
-type GetSchemaGeneratorOptions<T extends SchemaGenerator<any, any, any>> = T extends SchemaGenerator<infer Options, any, any> ? Options : never;
-type SchemaMethodResult<TFileMeta extends FileMetaBase> = Promise<KubbFile.File<TFileMeta> | Array<KubbFile.File<TFileMeta>> | null>;
-type Context<TOptions, TPluginOptions extends PluginFactoryOptions> = {
-  fabric: Fabric;
-  oas: Oas;
-  pluginManager: PluginManager;
-  events?: AsyncEventEmitter<KubbEvents>;
-  /**
-   * Current plugin
-   */
-  plugin: Plugin<TPluginOptions>;
-  mode: KubbFile.Mode;
-  include?: Array<'schemas' | 'responses' | 'requestBodies'>;
-  override: Array<Override<TOptions>> | undefined;
-  contentType?: contentType;
-  output?: string;
-};
-type SchemaGeneratorOptions = {
-  dateType: false | 'string' | 'stringOffset' | 'stringLocal' | 'date';
-  integerType?: 'number' | 'bigint';
-  unknownType: 'any' | 'unknown' | 'void';
-  emptySchemaType: 'any' | 'unknown' | 'void';
-  enumType?: 'enum' | 'asConst' | 'asPascalConst' | 'constEnum' | 'literal' | 'inlineLiteral';
-  enumSuffix?: string;
-  /**
-   * @deprecated Will be removed in v5. Use `collisionDetection: true` instead to prevent enum name collisions.
-   * When `collisionDetection` is enabled, the rootName-based approach eliminates the need for numeric suffixes.
-   * @internal
-   */
-  usedEnumNames?: Record<string, number>;
-  mapper?: Record<string, string>;
-  typed?: boolean;
-  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 name(propertyName) and return FakerMeta array
-     * TODO TODO add docs
-     * @beta
-     */
-    schema?: (schemaProps: SchemaProps$1, defaultSchemas: Schema[]) => Array<Schema> | undefined;
-  };
-};
-type SchemaGeneratorBuildOptions = Omit<OperationSchema, 'name' | 'schema'>;
-type SchemaProps$1 = {
-  schema: SchemaObject | null;
-  name: string | null;
-  parentName: string | null;
-  rootName?: string | null;
-};
-declare class SchemaGenerator<TOptions extends SchemaGeneratorOptions = SchemaGeneratorOptions, TPluginOptions extends PluginFactoryOptions = PluginFactoryOptions, TFileMeta extends FileMetaBase = FileMetaBase> extends BaseGenerator<TOptions, Context<TOptions, TPluginOptions>> {
-  #private;
-  refs: Refs;
-  /**
-   * Creates a type node from a given schema.
-   * Delegates to getBaseTypeFromSchema internally and
-   * optionally adds a union with null.
-   */
-  parse(props: SchemaProps$1): Schema[];
-  static deepSearch<T extends keyof SchemaKeywordMapper>(tree: Schema[] | undefined, keyword: T): Array<SchemaKeywordMapper[T]>;
-  static find<T extends keyof SchemaKeywordMapper>(tree: Schema[] | undefined, keyword: T): SchemaKeywordMapper[T] | undefined;
-  static combineObjects(tree: Schema[] | undefined): Schema[];
-  build(...generators: Array<Generator<TPluginOptions>>): Promise<Array<KubbFile.File<TFileMeta>>>;
-}
-//#endregion
-//#region src/generators/createReactGenerator.d.ts
-type UserGenerator$1<TOptions extends PluginFactoryOptions> = {
-  name: string;
-  Operations?: (props: OperationsProps<TOptions>) => FabricReactNode;
-  Operation?: (props: OperationProps<TOptions>) => FabricReactNode;
-  Schema?: (props: SchemaProps<TOptions>) => FabricReactNode;
-};
-type ReactGenerator<TOptions extends PluginFactoryOptions> = {
-  name: string;
-  type: 'react';
-  Operations: (props: OperationsProps<TOptions>) => FabricReactNode;
-  Operation: (props: OperationProps<TOptions>) => FabricReactNode;
-  Schema: (props: SchemaProps<TOptions>) => FabricReactNode;
-};
-/****
- * Creates a generator that uses React component functions to generate files for OpenAPI operations and schemas.
- *
- * The returned generator exposes async methods for generating files from operations, a single operation, or a schema, using the corresponding React components if provided. If a component is not defined, the method returns an empty array.
- *
- * @returns A generator object with async methods for operations, operation, and schema file generation.
- */
-declare function createReactGenerator<TOptions extends PluginFactoryOptions>(generator: UserGenerator$1<TOptions>): ReactGenerator<TOptions>;
-//#endregion
-//#region src/generators/types.d.ts
-type OperationsProps<TOptions extends PluginFactoryOptions> = {
-  config: Config;
-  generator: Omit<OperationGenerator<TOptions>, 'build'>;
-  plugin: Plugin<TOptions>;
-  operations: Array<Operation>;
-};
-type OperationProps<TOptions extends PluginFactoryOptions> = {
-  config: Config;
-  generator: Omit<OperationGenerator<TOptions>, 'build'>;
-  plugin: Plugin<TOptions>;
-  operation: Operation;
-};
-type SchemaProps<TOptions extends PluginFactoryOptions> = {
-  config: Config;
-  generator: Omit<SchemaGenerator<SchemaGeneratorOptions, TOptions>, 'build'>;
-  plugin: Plugin<TOptions>;
-  schema: {
-    name: string;
-    tree: Array<Schema>;
-    value: SchemaObject;
-  };
-};
-type Generator<TOptions extends PluginFactoryOptions> = CoreGenerator<TOptions> | ReactGenerator<TOptions>;
-//#endregion
-//#region src/generators/createGenerator.d.ts
-type UserGenerator<TOptions extends PluginFactoryOptions> = {
-  name: string;
-  operations?: (props: OperationsProps<TOptions>) => Promise<KubbFile.File[]>;
-  operation?: (props: OperationProps<TOptions>) => Promise<KubbFile.File[]>;
-  schema?: (props: SchemaProps<TOptions>) => Promise<KubbFile.File[]>;
-};
-type CoreGenerator<TOptions extends PluginFactoryOptions> = {
-  name: string;
-  type: 'core';
-  operations: (props: OperationsProps<TOptions>) => Promise<KubbFile.File[]>;
-  operation: (props: OperationProps<TOptions>) => Promise<KubbFile.File[]>;
-  schema: (props: SchemaProps<TOptions>) => Promise<KubbFile.File[]>;
-};
-declare function createGenerator<TOptions extends PluginFactoryOptions>(generator: UserGenerator<TOptions>): CoreGenerator<TOptions>;
-//#endregion
-export { Resolver as C, ResolvePathOptions as S, Options as _, createReactGenerator as a, Ref as b, SchemaGeneratorBuildOptions as c, OperationGenerator as d, OperationMethodResult as f, OperationSchemas as g, OperationSchema as h, ReactGenerator as i, SchemaGeneratorOptions as l, Include as m, createGenerator as n, GetSchemaGeneratorOptions as o, Exclude as p, Generator as r, SchemaGenerator as s, CoreGenerator as t, SchemaMethodResult as u, Override as v, Refs as x, PluginOas as y };
-//# sourceMappingURL=createGenerator-Dh3WEfpI.d.ts.map