@kubb/plugin-faker 3.0.0-alpha.0

package/dist/index.d.cts

@@ -0,0 +1,135 @@
+import * as _kubb_core from '@kubb/core';
+import { PluginFactoryOptions, ResolveNameParams } from '@kubb/core';
+import * as KubbFile from '@kubb/fs/types';
+import { SchemaObject } from '@kubb/oas';
+import { ResolvePathOptions, Exclude, Include, Override, Schema } from '@kubb/plugin-oas';
+
+type Options = {
+    output?: {
+        /**
+         * Relative path to save the Faker mocks.
+         * When output is a file it will save all models inside that file else it will create a file per schema item.
+         * @default 'mocks'
+         */
+        path: string;
+        /**
+         * Name to be used for the `export * as {{exportAs}} from './'`
+         */
+        exportAs?: string;
+        /**
+         * Add an extension to the generated imports and exports, default it will not use an extension
+         */
+        extName?: KubbFile.Extname;
+        /**
+         * Define what needs to exported, here you can also disable the export of barrel files
+         * @default `'barrel'`
+         */
+        exportType?: 'barrel' | 'barrelNamed' | false;
+    };
+    /**
+     * Group the Faker mocks based on the provided name.
+     */
+    group?: {
+        /**
+         * Tag will group based on the operation tag inside the Swagger file
+         */
+        type: 'tag';
+        /**
+         * Relative path to save the grouped Faker mocks.
+         *
+         * `{{tag}}` will be replaced by the current tagName.
+         * @example `${output}/{{tag}}Controller` => `mocks/PetController`
+         * @default `${output}/{{tag}}Controller`
+         */
+        output?: string;
+        /**
+         * Name to be used for the `export * as {{exportAs}} from './`
+         * @default `"{{tag}}Mocks"`
+         */
+        exportAs?: string;
+    };
+    /**
+     * 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>>;
+    /**
+     * Choose to use `date` or `datetime` as JavaScript `Date` instead of `string`.
+     * @default 'string'
+     */
+    dateType?: 'string' | 'date';
+    /**
+     * Which parser should be used when dateType is set to 'string'.
+     * - Schema with format 'date' will use ISO date format (YYYY-MM-DD)
+     *   - `'dayjs'` will use `dayjs(faker.date.anytime()).format("YYYY-MM-DD")`.
+     *   - `undefined` will use `faker.date.anytime().toString()`
+     * - Schema with format 'time' will use ISO time format (HH:mm:ss[.SSSSSS])
+     *   - `'dayjs'` will use `dayjs(faker.date.anytime()).format("HH:mm:ss")`.
+     *   - `undefined` will use `faker.date.anytime().toString()`
+     * * @default undefined
+     */
+    dateParser?: 'dayjs' | 'moment' | (string & {});
+    /**
+     * Which type to use when the Swagger/OpenAPI file is not providing more information
+     * @default 'any'
+     */
+    unknownType?: 'any' | 'unknown';
+    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;
+    };
+    /**
+     * Choose which generator to use when using Regexp.
+     *
+     * `'faker'` will use `faker.helpers.fromRegExp(new RegExp(/test/))`
+     * `'randexp'` will use `new RandExp(/test/).gen()`
+     * @default 'faker'
+     */
+    regexGenerator?: 'faker' | 'randexp';
+    mapper?: Record<string, string>;
+    /**
+     * The use of Seed is intended to allow for consistent values in a test.
+     */
+    seed?: number | number[];
+};
+type ResolvedOptions = {
+    extName: KubbFile.Extname | undefined;
+    dateType: NonNullable<Options['dateType']>;
+    dateParser: Options['dateParser'];
+    unknownType: NonNullable<Options['unknownType']>;
+    transformers: NonNullable<Options['transformers']>;
+    override: NonNullable<Options['override']>;
+    seed: NonNullable<Options['seed']> | undefined;
+    mapper: NonNullable<Options['mapper']>;
+    regexGenerator: NonNullable<Options['regexGenerator']>;
+};
+type PluginFaker = PluginFactoryOptions<'plugin-faker', Options, ResolvedOptions, never, ResolvePathOptions>;
+declare module '@kubb/core' {
+    interface _Register {
+        ['@kubb/plugin-faker']: PluginFaker;
+    }
+}
+
+declare const pluginFakerName = "plugin-faker";
+declare const pluginFaker: (options?: Options | undefined) => _kubb_core.UserPluginWithLifeCycle<PluginFaker>;
+
+export { type PluginFaker, pluginFaker, pluginFakerName };

package/dist/index.d.ts

@@ -0,0 +1,135 @@
+import * as _kubb_core from '@kubb/core';
+import { PluginFactoryOptions, ResolveNameParams } from '@kubb/core';
+import * as KubbFile from '@kubb/fs/types';
+import { SchemaObject } from '@kubb/oas';
+import { ResolvePathOptions, Exclude, Include, Override, Schema } from '@kubb/plugin-oas';
+
+type Options = {
+    output?: {
+        /**
+         * Relative path to save the Faker mocks.
+         * When output is a file it will save all models inside that file else it will create a file per schema item.
+         * @default 'mocks'
+         */
+        path: string;
+        /**
+         * Name to be used for the `export * as {{exportAs}} from './'`
+         */
+        exportAs?: string;
+        /**
+         * Add an extension to the generated imports and exports, default it will not use an extension
+         */
+        extName?: KubbFile.Extname;
+        /**
+         * Define what needs to exported, here you can also disable the export of barrel files
+         * @default `'barrel'`
+         */
+        exportType?: 'barrel' | 'barrelNamed' | false;
+    };
+    /**
+     * Group the Faker mocks based on the provided name.
+     */
+    group?: {
+        /**
+         * Tag will group based on the operation tag inside the Swagger file
+         */
+        type: 'tag';
+        /**
+         * Relative path to save the grouped Faker mocks.
+         *
+         * `{{tag}}` will be replaced by the current tagName.
+         * @example `${output}/{{tag}}Controller` => `mocks/PetController`
+         * @default `${output}/{{tag}}Controller`
+         */
+        output?: string;
+        /**
+         * Name to be used for the `export * as {{exportAs}} from './`
+         * @default `"{{tag}}Mocks"`
+         */
+        exportAs?: string;
+    };
+    /**
+     * 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>>;
+    /**
+     * Choose to use `date` or `datetime` as JavaScript `Date` instead of `string`.
+     * @default 'string'
+     */
+    dateType?: 'string' | 'date';
+    /**
+     * Which parser should be used when dateType is set to 'string'.
+     * - Schema with format 'date' will use ISO date format (YYYY-MM-DD)
+     *   - `'dayjs'` will use `dayjs(faker.date.anytime()).format("YYYY-MM-DD")`.
+     *   - `undefined` will use `faker.date.anytime().toString()`
+     * - Schema with format 'time' will use ISO time format (HH:mm:ss[.SSSSSS])
+     *   - `'dayjs'` will use `dayjs(faker.date.anytime()).format("HH:mm:ss")`.
+     *   - `undefined` will use `faker.date.anytime().toString()`
+     * * @default undefined
+     */
+    dateParser?: 'dayjs' | 'moment' | (string & {});
+    /**
+     * Which type to use when the Swagger/OpenAPI file is not providing more information
+     * @default 'any'
+     */
+    unknownType?: 'any' | 'unknown';
+    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;
+    };
+    /**
+     * Choose which generator to use when using Regexp.
+     *
+     * `'faker'` will use `faker.helpers.fromRegExp(new RegExp(/test/))`
+     * `'randexp'` will use `new RandExp(/test/).gen()`
+     * @default 'faker'
+     */
+    regexGenerator?: 'faker' | 'randexp';
+    mapper?: Record<string, string>;
+    /**
+     * The use of Seed is intended to allow for consistent values in a test.
+     */
+    seed?: number | number[];
+};
+type ResolvedOptions = {
+    extName: KubbFile.Extname | undefined;
+    dateType: NonNullable<Options['dateType']>;
+    dateParser: Options['dateParser'];
+    unknownType: NonNullable<Options['unknownType']>;
+    transformers: NonNullable<Options['transformers']>;
+    override: NonNullable<Options['override']>;
+    seed: NonNullable<Options['seed']> | undefined;
+    mapper: NonNullable<Options['mapper']>;
+    regexGenerator: NonNullable<Options['regexGenerator']>;
+};
+type PluginFaker = PluginFactoryOptions<'plugin-faker', Options, ResolvedOptions, never, ResolvePathOptions>;
+declare module '@kubb/core' {
+    interface _Register {
+        ['@kubb/plugin-faker']: PluginFaker;
+    }
+}
+
+declare const pluginFakerName = "plugin-faker";
+declare const pluginFaker: (options?: Options | undefined) => _kubb_core.UserPluginWithLifeCycle<PluginFaker>;
+
+export { type PluginFaker, pluginFaker, pluginFakerName };