@kubb/plugin-swr 5.0.0-alpha.8 → 5.0.0-beta.100

package/dist/generators.d.ts

@@ -1,479 +0,0 @@
-import { t as __name } from "./chunk--u3MIqq1.js";
-import { n as PluginSwr } from "./types-BIaGRPjD.js";
-import { AsyncEventEmitter, Config, FileMetaBase, Generator, Group, KubbEvents, Output, Plugin, PluginDriver, PluginFactoryOptions, ResolveNameParams } from "@kubb/core";
-import { HttpMethod, Oas, Operation, SchemaObject, contentType } from "@kubb/oas";
-import { FabricReactNode } from "@kubb/react-fabric/types";
-import { Fabric, KubbFile } from "@kubb/fabric-core/types";
-
-//#region ../plugin-oas/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 {}
-  }
-}
-/**
- * `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
- *
- * `pluginName` 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;
-  pluginName?: string;
-};
-type Refs = Record<string, Ref>;
-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 | BySchemaName;
-type Include = ByTag | ByOperationId | ByPath | ByMethod | ByContentType | BySchemaName;
-type Override<TOptions> = (ByTag | ByOperationId | ByPath | ByMethod | BySchemaName | ByContentType) & {
-  options: Partial<TOptions>;
-};
-//#endregion
-//#region ../plugin-oas/src/OperationGenerator.d.ts
-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;
-  driver: PluginDriver;
-  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> {
-  #private;
-  constructor(options: TPluginOptions['resolvedOptions'], context: Context$1<TPluginOptions['resolvedOptions'], TPluginOptions>);
-  get options(): TPluginOptions['resolvedOptions'];
-  set options(options: TPluginOptions['resolvedOptions']);
-  get context(): Context$1<TPluginOptions['resolvedOptions'], TPluginOptions>;
-  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$1<TPluginOptions>>): Promise<Array<KubbFile.File<TFileMeta>>>;
-}
-//#endregion
-//#region ../plugin-oas/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';
-  };
-};
-type Schema = {
-  keyword: string;
-} | SchemaKeywordMapper[keyof SchemaKeywordMapper];
-//#endregion
-//#region ../plugin-oas/src/SchemaGenerator.d.ts
-type Context<TOptions, TPluginOptions extends PluginFactoryOptions> = {
-  fabric: Fabric;
-  oas: Oas;
-  driver: PluginDriver;
-  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 Schema array.
-     * Return `undefined` to fall through to default schema generation.
-     * @beta
-     */
-    schema?: (schemaProps: SchemaProps$1, defaultSchemas: Schema[]) => Array<Schema> | undefined;
-  };
-};
-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> {
-  #private;
-  constructor(options: TOptions, context: Context<TOptions, TPluginOptions>);
-  get options(): TOptions;
-  set options(options: TOptions);
-  get context(): Context<TOptions, TPluginOptions>;
-  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$1<TPluginOptions>>): Promise<Array<KubbFile.File<TFileMeta>>>;
-}
-//#endregion
-//#region ../plugin-oas/src/generators/createGenerator.d.ts
-type CoreGenerator<TOptions extends PluginFactoryOptions> = {
-  name: string;
-  type: 'core';
-  version: '1';
-  operations: (props: OperationsProps<TOptions>) => Promise<KubbFile.File[]>;
-  operation: (props: OperationProps<TOptions>) => Promise<KubbFile.File[]>;
-  schema: (props: SchemaProps<TOptions>) => Promise<KubbFile.File[]>;
-};
-//#endregion
-//#region ../plugin-oas/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$1<TOptions extends PluginFactoryOptions> = CoreGenerator<TOptions> | ReactGenerator<TOptions> | Generator<TOptions>;
-//#endregion
-//#region ../plugin-oas/src/generators/createReactGenerator.d.ts
-type ReactGenerator<TOptions extends PluginFactoryOptions> = {
-  name: string;
-  type: 'react';
-  version: '1';
-  Operations: (props: OperationsProps<TOptions>) => FabricReactNode;
-  Operation: (props: OperationProps<TOptions>) => FabricReactNode;
-  Schema: (props: SchemaProps<TOptions>) => FabricReactNode;
-};
-//#endregion
-//#region src/generators/mutationGenerator.d.ts
-declare const mutationGenerator: ReactGenerator<PluginSwr>;
-//#endregion
-//#region src/generators/queryGenerator.d.ts
-declare const queryGenerator: ReactGenerator<PluginSwr>;
-//#endregion
-export { mutationGenerator, queryGenerator };
-//# sourceMappingURL=generators.d.ts.map

package/dist/generators.js

@@ -1,2 +0,0 @@
-import { n as mutationGenerator, t as queryGenerator } from "./generators-CRSl6u2M.js";
-export { mutationGenerator, queryGenerator };

package/dist/types-BIaGRPjD.d.ts

@@ -1,210 +0,0 @@
-import { t as __name } from "./chunk--u3MIqq1.js";
-import { Group, Output, PluginFactoryOptions, ResolveNameParams } from "@kubb/core";
-import { ClientImportPath, PluginClient } from "@kubb/plugin-client";
-import { Exclude, Include, OperationSchemas, Override, ResolvePathOptions } from "@kubb/plugin-oas";
-import { HttpMethod, Oas, Operation, contentType } from "@kubb/oas";
-import { FunctionParams } from "@kubb/react-fabric";
-import { Generator as Generator$1 } from "@kubb/plugin-oas/generators";
-import { FabricReactNode } from "@kubb/react-fabric/types";
-
-//#region ../../internals/tanstack-query/src/types.d.ts
-type ParamsCasing = 'camelcase' | undefined;
-type PathParamsType = 'object' | 'inline';
-type TransformerProps = {
-  operation: Operation;
-  schemas: OperationSchemas;
-  casing: ParamsCasing;
-};
-type Transformer = (props: TransformerProps) => unknown[];
-//#endregion
-//#region ../../internals/tanstack-query/src/components/MutationKey.d.ts
-type Props$1 = {
-  name: string;
-  typeName: string;
-  typeSchemas: OperationSchemas;
-  operation: Operation;
-  paramsCasing: ParamsCasing;
-  pathParamsType: PathParamsType;
-  transformer: Transformer | undefined;
-};
-type GetParamsProps$1 = {
-  pathParamsType: PathParamsType;
-  typeSchemas: OperationSchemas;
-};
-declare function MutationKey$1({
-  name,
-  typeSchemas,
-  pathParamsType,
-  paramsCasing,
-  operation,
-  typeName,
-  transformer
-}: Props$1): FabricReactNode;
-declare namespace MutationKey$1 {
-  var getParams: ({}: GetParamsProps$1) => FunctionParams;
-  var getTransformer: Transformer;
-}
-//#endregion
-//#region ../../internals/tanstack-query/src/components/QueryKey.d.ts
-type Props = {
-  name: string;
-  typeName: string;
-  typeSchemas: OperationSchemas;
-  operation: Operation;
-  paramsCasing: ParamsCasing;
-  pathParamsType: PathParamsType;
-  transformer: Transformer | undefined;
-};
-type GetParamsProps = {
-  paramsCasing: ParamsCasing;
-  pathParamsType: PathParamsType;
-  typeSchemas: OperationSchemas;
-};
-declare function QueryKey$1({
-  name,
-  typeSchemas,
-  paramsCasing,
-  pathParamsType,
-  operation,
-  typeName,
-  transformer
-}: Props): FabricReactNode;
-declare namespace QueryKey$1 {
-  var getParams: ({
-    pathParamsType,
-    paramsCasing,
-    typeSchemas
-  }: GetParamsProps) => FunctionParams;
-  var getTransformer: Transformer;
-}
-//#endregion
-//#region src/types.d.ts
-/**
- * Customize the queryKey
- */
-type QueryKey = Transformer;
-/**
- * Customize the mutationKey
- */
-type MutationKey = Transformer;
-type Query = {
-  /**
-   * Define which HttpMethods can be used for queries
-   * @default ['get']
-   */
-  methods?: Array<HttpMethod>;
-  /**
-   * Path to the useQuery hook for useQuery functionality.
-   * Used as `import { useQuery } from '${importPath}'`.
-   * Accepts relative and absolute paths.
-   * Path is used as-is; relative paths are based on the generated file location.
-   * @default 'swr'
-   */
-  importPath?: string;
-};
-type Mutation = {
-  /**
-   * Define which HttpMethods can be used for queries
-   * @default ['post', 'put', 'delete', 'patch']
-   */
-  methods?: Array<HttpMethod>;
-  /**
-   * Path to the useQuery hook for useQuery functionality.
-   * Used as `import { useQuery } from '${importPath}'`.
-   * Accepts relative and absolute paths.
-   * Path is used as-is; relative paths are based on the generated file location.
-   * @default 'swr/mutation'
-   */
-  importPath?: string;
-  /**
-   * When true, mutation parameters (path params, query params, headers, body) is passed via `trigger()` instead of as hook arguments.
-   * This aligns with React Query's mutation pattern where variables are passed when triggering the mutation.
-   * @default false
-   * @deprecated This will become the default behavior in v5. Set to `true` to opt-in early.
-   */
-  paramsToTrigger?: boolean;
-};
-type Options = {
-  /**
-   * Specify the export location for the files and define the behavior of the output
-   * @default { path: 'hooks', barrelType: 'named' }
-   */
-  output?: Output<Oas>;
-  /**
-   * Define which contentType should be used.
-   * By default, the first JSON valid mediaType is used
-   */
-  contentType?: contentType;
-  /**
-   * Group the SWR hooks 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>>;
-  client?: ClientImportPath & Pick<PluginClient['options'], 'clientType' | 'dataReturnType' | 'baseURL' | 'bundle' | 'paramsCasing'>;
-  queryKey?: QueryKey;
-  query?: Query | false;
-  mutationKey?: MutationKey;
-  mutation?: Mutation | false;
-  /**
-   * How to style your params, by default no casing is applied
-   * - 'camelcase' uses camelcase for the params names
-   */
-  paramsCasing?: 'camelcase';
-  /**
-   * How to pass your params
-   * - 'object' returns the params and pathParams as an object.
-   * - 'inline' returns the params as comma separated params.
-   * @default 'inline'
-   */
-  paramsType?: 'object' | 'inline';
-  /**
-   * How to pass your pathParams.
-   * - 'object' returns the pathParams as an object.
-   * - 'inline': returns the pathParams as comma separated params.
-   * @default 'inline'
-   */
-  pathParamsType?: PluginClient['options']['pathParamsType'];
-  /**
-   * Which parser should be used before returning the data to `swr`.
-   * `'zod'` uses `@kubb/plugin-zod` to parse the data.
-   */
-  parser?: PluginClient['options']['parser'];
-  transformers?: {
-    /**
-     * Customize the names based on the type that is provided by the plugin.
-     */
-    name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
-  };
-  /**
-   * Define some generators next to the swr generators
-   */
-  generators?: Array<Generator$1<PluginSwr>>;
-};
-type ResolvedOptions = {
-  output: Output<Oas>;
-  client: Pick<PluginClient['options'], 'client' | 'clientType' | 'dataReturnType' | 'importPath' | 'baseURL' | 'bundle' | 'paramsCasing'>;
-  parser: Required<NonNullable<Options['parser']>>;
-  queryKey: QueryKey | undefined;
-  query: NonNullable<Required<Query>> | false;
-  mutationKey: MutationKey | undefined;
-  mutation: (Required<Pick<Mutation, 'methods' | 'importPath'>> & Pick<Mutation, 'paramsToTrigger'>) | false;
-  paramsCasing: Options['paramsCasing'];
-  paramsType: NonNullable<Options['paramsType']>;
-  pathParamsType: NonNullable<Options['pathParamsType']>;
-  group: Options['group'];
-};
-type PluginSwr = PluginFactoryOptions<'plugin-swr', Options, ResolvedOptions, never, ResolvePathOptions>;
-//#endregion
-export { MutationKey$1 as i, PluginSwr as n, QueryKey$1 as r, Options as t };
-//# sourceMappingURL=types-BIaGRPjD.d.ts.map