@kubb/plugin-faker 5.2.1 → 5.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +176 -119
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2 -13
- package/dist/index.d.ts +2 -13
- package/dist/index.js +173 -116
- package/dist/index.js.map +1 -1
- package/docs/options.md +2 -0
- package/kubb-extension.json +1 -1
- package/package.json +4 -4
package/dist/index.d.cts
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { Exclude, Group, Include, Output, OutputOptions, Override, PluginType, Resolver, ResolverPatch, ast } from "kubb/kit";
|
|
2
2
|
import { KubbReactNode } from "kubb/jsx";
|
|
3
|
-
//#region src/types.d.ts
|
|
4
3
|
/**
|
|
5
4
|
* Resolver for Faker that provides naming methods for mock functions.
|
|
6
5
|
*
|
|
@@ -172,8 +171,6 @@ declare global {
|
|
|
172
171
|
}
|
|
173
172
|
}
|
|
174
173
|
}
|
|
175
|
-
//#endregion
|
|
176
|
-
//#region src/printers/printerFaker.d.ts
|
|
177
174
|
/**
|
|
178
175
|
* Partial map of node-type overrides for the Faker printer. Each key is a
|
|
179
176
|
* `SchemaType` (`'string'`, `'date'`, ...) and each handler returns the
|
|
@@ -231,8 +228,6 @@ type PrinterFakerFactory = ast.PrinterFactoryOptions<'faker', PrinterFakerOption
|
|
|
231
228
|
* Handles circular references gracefully by emitting memoizing getters for cyclic properties.
|
|
232
229
|
*/
|
|
233
230
|
export declare const printerFaker: (options: PrinterFakerOptions) => ast.Printer<PrinterFakerFactory>;
|
|
234
|
-
//#endregion
|
|
235
|
-
//#region src/components/Faker.d.ts
|
|
236
231
|
type Props = {
|
|
237
232
|
name: string;
|
|
238
233
|
typeName: string;
|
|
@@ -241,10 +236,9 @@ type Props = {
|
|
|
241
236
|
description?: string;
|
|
242
237
|
canOverride: boolean;
|
|
243
238
|
typeMode?: PluginFaker['resolvedOptions']['typeMode'];
|
|
239
|
+
keysToOmit?: Array<string> | null;
|
|
244
240
|
};
|
|
245
|
-
export declare function Faker({ node, description, name, typeName, printer, canOverride, typeMode }: Props): KubbReactNode;
|
|
246
|
-
//#endregion
|
|
247
|
-
//#region src/generators/fakerGenerator.d.ts
|
|
241
|
+
export declare function Faker({ node, description, name, typeName, printer, canOverride, typeMode, keysToOmit }: Props): KubbReactNode;
|
|
248
242
|
/**
|
|
249
243
|
* Built-in generator for `@kubb/plugin-faker`. Emits one `createX` factory
|
|
250
244
|
* per schema in the spec plus per-operation request/response factories. Each
|
|
@@ -252,8 +246,6 @@ export declare function Faker({ node, description, name, typeName, printer, canO
|
|
|
252
246
|
* `@kubb/plugin-ts`.
|
|
253
247
|
*/
|
|
254
248
|
export declare const fakerGenerator: import("kubb/kit").Generator<PluginFaker, unknown>;
|
|
255
|
-
//#endregion
|
|
256
|
-
//#region src/plugin.d.ts
|
|
257
249
|
/**
|
|
258
250
|
* Canonical plugin name for `@kubb/plugin-faker`. Used for driver lookups and
|
|
259
251
|
* cross-plugin dependency references.
|
|
@@ -284,8 +276,6 @@ export declare const pluginFakerName = "plugin-faker";
|
|
|
284
276
|
* ```
|
|
285
277
|
*/
|
|
286
278
|
export declare const pluginFaker: import("kubb/kit").PluginFactory<PluginFaker>;
|
|
287
|
-
//#endregion
|
|
288
|
-
//#region src/resolvers/resolverFaker.d.ts
|
|
289
279
|
/**
|
|
290
280
|
* Default resolver used by `@kubb/plugin-faker`. Decides the names and file
|
|
291
281
|
* paths for every generated mock factory. Functions and files are prefixed
|
|
@@ -299,6 +289,5 @@ export declare const pluginFaker: import("kubb/kit").PluginFactory<PluginFaker>;
|
|
|
299
289
|
* ```
|
|
300
290
|
*/
|
|
301
291
|
export declare const resolverFaker: ResolverFaker;
|
|
302
|
-
//#endregion
|
|
303
292
|
export { type PluginFaker, type PrinterFakerFactory, type PrinterFakerNodes, type PrinterFakerOptions, type ResolverFaker, pluginFaker as default };
|
|
304
293
|
//# sourceMappingURL=index.d.cts.map
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { Exclude, Group, Include, Output, OutputOptions, Override, PluginType, Resolver, ResolverPatch, ast } from "kubb/kit";
|
|
2
2
|
import { KubbReactNode } from "kubb/jsx";
|
|
3
|
-
//#region src/types.d.ts
|
|
4
3
|
/**
|
|
5
4
|
* Resolver for Faker that provides naming methods for mock functions.
|
|
6
5
|
*
|
|
@@ -172,8 +171,6 @@ declare global {
|
|
|
172
171
|
}
|
|
173
172
|
}
|
|
174
173
|
}
|
|
175
|
-
//#endregion
|
|
176
|
-
//#region src/printers/printerFaker.d.ts
|
|
177
174
|
/**
|
|
178
175
|
* Partial map of node-type overrides for the Faker printer. Each key is a
|
|
179
176
|
* `SchemaType` (`'string'`, `'date'`, ...) and each handler returns the
|
|
@@ -231,8 +228,6 @@ type PrinterFakerFactory = ast.PrinterFactoryOptions<'faker', PrinterFakerOption
|
|
|
231
228
|
* Handles circular references gracefully by emitting memoizing getters for cyclic properties.
|
|
232
229
|
*/
|
|
233
230
|
export declare const printerFaker: (options: PrinterFakerOptions) => ast.Printer<PrinterFakerFactory>;
|
|
234
|
-
//#endregion
|
|
235
|
-
//#region src/components/Faker.d.ts
|
|
236
231
|
type Props = {
|
|
237
232
|
name: string;
|
|
238
233
|
typeName: string;
|
|
@@ -241,10 +236,9 @@ type Props = {
|
|
|
241
236
|
description?: string;
|
|
242
237
|
canOverride: boolean;
|
|
243
238
|
typeMode?: PluginFaker['resolvedOptions']['typeMode'];
|
|
239
|
+
keysToOmit?: Array<string> | null;
|
|
244
240
|
};
|
|
245
|
-
export declare function Faker({ node, description, name, typeName, printer, canOverride, typeMode }: Props): KubbReactNode;
|
|
246
|
-
//#endregion
|
|
247
|
-
//#region src/generators/fakerGenerator.d.ts
|
|
241
|
+
export declare function Faker({ node, description, name, typeName, printer, canOverride, typeMode, keysToOmit }: Props): KubbReactNode;
|
|
248
242
|
/**
|
|
249
243
|
* Built-in generator for `@kubb/plugin-faker`. Emits one `createX` factory
|
|
250
244
|
* per schema in the spec plus per-operation request/response factories. Each
|
|
@@ -252,8 +246,6 @@ export declare function Faker({ node, description, name, typeName, printer, canO
|
|
|
252
246
|
* `@kubb/plugin-ts`.
|
|
253
247
|
*/
|
|
254
248
|
export declare const fakerGenerator: import("kubb/kit").Generator<PluginFaker, unknown>;
|
|
255
|
-
//#endregion
|
|
256
|
-
//#region src/plugin.d.ts
|
|
257
249
|
/**
|
|
258
250
|
* Canonical plugin name for `@kubb/plugin-faker`. Used for driver lookups and
|
|
259
251
|
* cross-plugin dependency references.
|
|
@@ -284,8 +276,6 @@ export declare const pluginFakerName = "plugin-faker";
|
|
|
284
276
|
* ```
|
|
285
277
|
*/
|
|
286
278
|
export declare const pluginFaker: import("kubb/kit").PluginFactory<PluginFaker>;
|
|
287
|
-
//#endregion
|
|
288
|
-
//#region src/resolvers/resolverFaker.d.ts
|
|
289
279
|
/**
|
|
290
280
|
* Default resolver used by `@kubb/plugin-faker`. Decides the names and file
|
|
291
281
|
* paths for every generated mock factory. Functions and files are prefixed
|
|
@@ -299,6 +289,5 @@ export declare const pluginFaker: import("kubb/kit").PluginFactory<PluginFaker>;
|
|
|
299
289
|
* ```
|
|
300
290
|
*/
|
|
301
291
|
export declare const resolverFaker: ResolverFaker;
|
|
302
|
-
//#endregion
|
|
303
292
|
export { type PluginFaker, type PrinterFakerFactory, type PrinterFakerNodes, type PrinterFakerOptions, type ResolverFaker, pluginFaker as default };
|
|
304
293
|
//# sourceMappingURL=index.d.ts.map
|