@kubb/plugin-faker 0.0.0-canary-20241104172400
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/LICENSE +21 -0
- package/README.md +53 -0
- package/dist/chunk-FCIZHQ4X.cjs +339 -0
- package/dist/chunk-FCIZHQ4X.cjs.map +1 -0
- package/dist/chunk-OOL6ZKDZ.cjs +115 -0
- package/dist/chunk-OOL6ZKDZ.cjs.map +1 -0
- package/dist/chunk-PLVSF3YP.js +333 -0
- package/dist/chunk-PLVSF3YP.js.map +1 -0
- package/dist/chunk-ZOJMDISS.js +113 -0
- package/dist/chunk-ZOJMDISS.js.map +1 -0
- package/dist/components.cjs +12 -0
- package/dist/components.cjs.map +1 -0
- package/dist/components.d.cts +20 -0
- package/dist/components.d.ts +20 -0
- package/dist/components.js +3 -0
- package/dist/components.js.map +1 -0
- package/dist/generators.cjs +13 -0
- package/dist/generators.cjs.map +1 -0
- package/dist/generators.d.cts +8 -0
- package/dist/generators.d.ts +8 -0
- package/dist/generators.js +4 -0
- package/dist/generators.js.map +1 -0
- package/dist/index.cjs +115 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +9 -0
- package/dist/index.d.ts +9 -0
- package/dist/index.js +108 -0
- package/dist/index.js.map +1 -0
- package/dist/types-Cq8z4Gto.d.cts +95 -0
- package/dist/types-Cq8z4Gto.d.ts +95 -0
- package/package.json +98 -0
- package/src/components/Faker.tsx +82 -0
- package/src/components/index.ts +1 -0
- package/src/generators/__snapshots__/createPet.ts +26 -0
- package/src/generators/__snapshots__/createPetSeed.ts +30 -0
- package/src/generators/__snapshots__/createPetUnknownTypeAny.ts +26 -0
- package/src/generators/__snapshots__/deletePet.ts +3 -0
- package/src/generators/__snapshots__/enumNames.ts +5 -0
- package/src/generators/__snapshots__/enumVarNames.ts +5 -0
- package/src/generators/__snapshots__/getPets.ts +26 -0
- package/src/generators/__snapshots__/pet.ts +8 -0
- package/src/generators/__snapshots__/petWithDateString.ts +8 -0
- package/src/generators/__snapshots__/petWithDayjs.ts +9 -0
- package/src/generators/__snapshots__/petWithMapper.ts +8 -0
- package/src/generators/__snapshots__/petWithRandExp.ts +9 -0
- package/src/generators/__snapshots__/pets.ts +8 -0
- package/src/generators/__snapshots__/showPetById.ts +26 -0
- package/src/generators/fakerGenerator.tsx +140 -0
- package/src/generators/index.ts +1 -0
- package/src/index.ts +2 -0
- package/src/parser/index.ts +351 -0
- package/src/plugin.ts +128 -0
- package/src/types.ts +92 -0
package/dist/index.cjs
ADDED
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var chunkOOL6ZKDZ_cjs = require('./chunk-OOL6ZKDZ.cjs');
|
|
4
|
+
require('./chunk-FCIZHQ4X.cjs');
|
|
5
|
+
var path = require('path');
|
|
6
|
+
var core = require('@kubb/core');
|
|
7
|
+
var transformers = require('@kubb/core/transformers');
|
|
8
|
+
var pluginOas = require('@kubb/plugin-oas');
|
|
9
|
+
var pluginTs = require('@kubb/plugin-ts');
|
|
10
|
+
|
|
11
|
+
function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
|
|
12
|
+
|
|
13
|
+
var path__default = /*#__PURE__*/_interopDefault(path);
|
|
14
|
+
|
|
15
|
+
var pluginFakerName = "plugin-faker";
|
|
16
|
+
var pluginFaker = core.createPlugin((options) => {
|
|
17
|
+
const {
|
|
18
|
+
output = { path: "mocks", barrelType: "named" },
|
|
19
|
+
seed,
|
|
20
|
+
group,
|
|
21
|
+
exclude = [],
|
|
22
|
+
include,
|
|
23
|
+
override = [],
|
|
24
|
+
transformers: transformers$1 = {},
|
|
25
|
+
mapper = {},
|
|
26
|
+
unknownType = "any",
|
|
27
|
+
dateType = "string",
|
|
28
|
+
dateParser = "faker",
|
|
29
|
+
generators = [chunkOOL6ZKDZ_cjs.fakerGenerator].filter(Boolean),
|
|
30
|
+
regexGenerator = "faker"
|
|
31
|
+
} = options;
|
|
32
|
+
return {
|
|
33
|
+
name: pluginFakerName,
|
|
34
|
+
options: {
|
|
35
|
+
output,
|
|
36
|
+
transformers: transformers$1,
|
|
37
|
+
seed,
|
|
38
|
+
dateType,
|
|
39
|
+
unknownType,
|
|
40
|
+
dateParser,
|
|
41
|
+
mapper,
|
|
42
|
+
override,
|
|
43
|
+
regexGenerator
|
|
44
|
+
},
|
|
45
|
+
pre: [pluginOas.pluginOasName, pluginTs.pluginTsName],
|
|
46
|
+
resolvePath(baseName, pathMode, options2) {
|
|
47
|
+
const root = path__default.default.resolve(this.config.root, this.config.output.path);
|
|
48
|
+
const mode = pathMode ?? core.FileManager.getMode(path__default.default.resolve(root, output.path));
|
|
49
|
+
if (options2?.tag && group?.type === "tag") {
|
|
50
|
+
const groupName = group?.name ? group.name : (ctx) => `${ctx.group}Controller`;
|
|
51
|
+
return path__default.default.resolve(root, output.path, groupName({ group: transformers.camelCase(options2.tag) }), baseName);
|
|
52
|
+
}
|
|
53
|
+
if (mode === "single") {
|
|
54
|
+
return path__default.default.resolve(root, output.path);
|
|
55
|
+
}
|
|
56
|
+
return path__default.default.resolve(root, output.path, baseName);
|
|
57
|
+
},
|
|
58
|
+
resolveName(name, type) {
|
|
59
|
+
const resolvedName = transformers.camelCase(name, {
|
|
60
|
+
prefix: type ? "create" : void 0,
|
|
61
|
+
isFile: type === "file"
|
|
62
|
+
});
|
|
63
|
+
if (type) {
|
|
64
|
+
return transformers$1?.name?.(resolvedName, type) || resolvedName;
|
|
65
|
+
}
|
|
66
|
+
return resolvedName;
|
|
67
|
+
},
|
|
68
|
+
async buildStart() {
|
|
69
|
+
const [swaggerPlugin] = core.PluginManager.getDependedPlugins(this.plugins, [pluginOas.pluginOasName]);
|
|
70
|
+
const oas = await swaggerPlugin.context.getOas();
|
|
71
|
+
const root = path__default.default.resolve(this.config.root, this.config.output.path);
|
|
72
|
+
const mode = core.FileManager.getMode(path__default.default.resolve(root, output.path));
|
|
73
|
+
const schemaGenerator = new pluginOas.SchemaGenerator(this.plugin.options, {
|
|
74
|
+
oas,
|
|
75
|
+
pluginManager: this.pluginManager,
|
|
76
|
+
plugin: this.plugin,
|
|
77
|
+
contentType: swaggerPlugin.context.contentType,
|
|
78
|
+
include: void 0,
|
|
79
|
+
override,
|
|
80
|
+
mode,
|
|
81
|
+
output: output.path
|
|
82
|
+
});
|
|
83
|
+
const schemaFiles = await schemaGenerator.build(...generators);
|
|
84
|
+
await this.addFile(...schemaFiles);
|
|
85
|
+
const operationGenerator = new pluginOas.OperationGenerator(this.plugin.options, {
|
|
86
|
+
oas,
|
|
87
|
+
pluginManager: this.pluginManager,
|
|
88
|
+
plugin: this.plugin,
|
|
89
|
+
contentType: swaggerPlugin.context.contentType,
|
|
90
|
+
exclude,
|
|
91
|
+
include,
|
|
92
|
+
override,
|
|
93
|
+
mode
|
|
94
|
+
});
|
|
95
|
+
const operationFiles = await operationGenerator.build(...generators);
|
|
96
|
+
await this.addFile(...operationFiles);
|
|
97
|
+
const barrelFiles = await this.fileManager.getBarrelFiles({
|
|
98
|
+
type: output.barrelType ?? "named",
|
|
99
|
+
root,
|
|
100
|
+
output,
|
|
101
|
+
files: this.fileManager.files,
|
|
102
|
+
meta: {
|
|
103
|
+
pluginKey: this.plugin.key
|
|
104
|
+
},
|
|
105
|
+
logger: this.logger
|
|
106
|
+
});
|
|
107
|
+
await this.addFile(...barrelFiles);
|
|
108
|
+
}
|
|
109
|
+
};
|
|
110
|
+
});
|
|
111
|
+
|
|
112
|
+
exports.pluginFaker = pluginFaker;
|
|
113
|
+
exports.pluginFakerName = pluginFakerName;
|
|
114
|
+
//# sourceMappingURL=index.cjs.map
|
|
115
|
+
//# sourceMappingURL=index.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/plugin.ts"],"names":["createPlugin","transformers","fakerGenerator","pluginOasName","pluginTsName","options","path","FileManager","camelCase","PluginManager","SchemaGenerator","OperationGenerator"],"mappings":";;;;;;;;;;;;;;AAaO,IAAM,eAAkB,GAAA;AAElB,IAAA,WAAA,GAAcA,iBAA0B,CAAA,CAAC,OAAY,KAAA;AAChE,EAAM,MAAA;AAAA,IACJ,MAAS,GAAA,EAAE,IAAM,EAAA,OAAA,EAAS,YAAY,OAAQ,EAAA;AAAA,IAC9C,IAAA;AAAA,IACA,KAAA;AAAA,IACA,UAAU,EAAC;AAAA,IACX,OAAA;AAAA,IACA,WAAW,EAAC;AAAA,kBACZC,iBAAe,EAAC;AAAA,IAChB,SAAS,EAAC;AAAA,IACV,WAAc,GAAA,KAAA;AAAA,IACd,QAAW,GAAA,QAAA;AAAA,IACX,UAAa,GAAA,OAAA;AAAA,IACb,UAAa,GAAA,CAACC,gCAAc,CAAA,CAAE,OAAO,OAAO,CAAA;AAAA,IAC5C,cAAiB,GAAA;AAAA,GACf,GAAA,OAAA;AAEJ,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,eAAA;AAAA,IACN,OAAS,EAAA;AAAA,MACP,MAAA;AAAA,oBACAD,cAAA;AAAA,MACA,IAAA;AAAA,MACA,QAAA;AAAA,MACA,WAAA;AAAA,MACA,UAAA;AAAA,MACA,MAAA;AAAA,MACA,QAAA;AAAA,MACA;AAAA,KACF;AAAA,IACA,GAAA,EAAK,CAACE,uBAAA,EAAeC,qBAAY,CAAA;AAAA,IACjC,WAAA,CAAY,QAAU,EAAA,QAAA,EAAUC,QAAS,EAAA;AACvC,MAAM,MAAA,IAAA,GAAOC,sBAAK,OAAQ,CAAA,IAAA,CAAK,OAAO,IAAM,EAAA,IAAA,CAAK,MAAO,CAAA,MAAA,CAAO,IAAI,CAAA;AACnE,MAAM,MAAA,IAAA,GAAO,YAAYC,gBAAY,CAAA,OAAA,CAAQD,sBAAK,OAAQ,CAAA,IAAA,EAAM,MAAO,CAAA,IAAI,CAAC,CAAA;AAE5E,MAAA,IAAID,QAAS,EAAA,GAAA,IAAO,KAAO,EAAA,IAAA,KAAS,KAAO,EAAA;AACzC,QAAM,MAAA,SAAA,GAA2B,OAAO,IAAO,GAAA,KAAA,CAAM,OAAO,CAAC,GAAA,KAAQ,CAAG,EAAA,GAAA,CAAI,KAAK,CAAA,UAAA,CAAA;AAEjF,QAAA,OAAOC,qBAAK,CAAA,OAAA,CAAQ,IAAM,EAAA,MAAA,CAAO,MAAM,SAAU,CAAA,EAAE,KAAO,EAAAE,sBAAA,CAAUH,QAAQ,CAAA,GAAG,CAAE,EAAC,GAAG,QAAQ,CAAA;AAAA;AAG/F,MAAA,IAAI,SAAS,QAAU,EAAA;AAKrB,QAAA,OAAOC,qBAAK,CAAA,OAAA,CAAQ,IAAM,EAAA,MAAA,CAAO,IAAI,CAAA;AAAA;AAGvC,MAAA,OAAOA,qBAAK,CAAA,OAAA,CAAQ,IAAM,EAAA,MAAA,CAAO,MAAM,QAAQ,CAAA;AAAA,KACjD;AAAA,IACA,WAAA,CAAY,MAAM,IAAM,EAAA;AACtB,MAAM,MAAA,YAAA,GAAeE,uBAAU,IAAM,EAAA;AAAA,QACnC,MAAA,EAAQ,OAAO,QAAW,GAAA,KAAA,CAAA;AAAA,QAC1B,QAAQ,IAAS,KAAA;AAAA,OAClB,CAAA;AAED,MAAA,IAAI,IAAM,EAAA;AACR,QAAA,OAAOP,cAAc,EAAA,IAAA,GAAO,YAAc,EAAA,IAAI,CAAK,IAAA,YAAA;AAAA;AAGrD,MAAO,OAAA,YAAA;AAAA,KACT;AAAA,IACA,MAAM,UAAa,GAAA;AACjB,MAAM,MAAA,CAAC,aAAa,CAAyB,GAAAQ,kBAAA,CAAc,mBAA8B,IAAK,CAAA,OAAA,EAAS,CAACN,uBAAa,CAAC,CAAA;AAEtH,MAAA,MAAM,GAAM,GAAA,MAAM,aAAc,CAAA,OAAA,CAAQ,MAAO,EAAA;AAC/C,MAAM,MAAA,IAAA,GAAOG,sBAAK,OAAQ,CAAA,IAAA,CAAK,OAAO,IAAM,EAAA,IAAA,CAAK,MAAO,CAAA,MAAA,CAAO,IAAI,CAAA;AACnE,MAAM,MAAA,IAAA,GAAOC,iBAAY,OAAQ,CAAAD,qBAAA,CAAK,QAAQ,IAAM,EAAA,MAAA,CAAO,IAAI,CAAC,CAAA;AAEhE,MAAA,MAAM,eAAkB,GAAA,IAAII,yBAAgB,CAAA,IAAA,CAAK,OAAO,OAAS,EAAA;AAAA,QAC/D,GAAA;AAAA,QACA,eAAe,IAAK,CAAA,aAAA;AAAA,QACpB,QAAQ,IAAK,CAAA,MAAA;AAAA,QACb,WAAA,EAAa,cAAc,OAAQ,CAAA,WAAA;AAAA,QACnC,OAAS,EAAA,KAAA,CAAA;AAAA,QACT,QAAA;AAAA,QACA,IAAA;AAAA,QACA,QAAQ,MAAO,CAAA;AAAA,OAChB,CAAA;AAED,MAAA,MAAM,WAAc,GAAA,MAAM,eAAgB,CAAA,KAAA,CAAM,GAAG,UAAU,CAAA;AAC7D,MAAM,MAAA,IAAA,CAAK,OAAQ,CAAA,GAAG,WAAW,CAAA;AAEjC,MAAA,MAAM,kBAAqB,GAAA,IAAIC,4BAAmB,CAAA,IAAA,CAAK,OAAO,OAAS,EAAA;AAAA,QACrE,GAAA;AAAA,QACA,eAAe,IAAK,CAAA,aAAA;AAAA,QACpB,QAAQ,IAAK,CAAA,MAAA;AAAA,QACb,WAAA,EAAa,cAAc,OAAQ,CAAA,WAAA;AAAA,QACnC,OAAA;AAAA,QACA,OAAA;AAAA,QACA,QAAA;AAAA,QACA;AAAA,OACD,CAAA;AAED,MAAA,MAAM,cAAiB,GAAA,MAAM,kBAAmB,CAAA,KAAA,CAAM,GAAG,UAAU,CAAA;AACnE,MAAM,MAAA,IAAA,CAAK,OAAQ,CAAA,GAAG,cAAc,CAAA;AAEpC,MAAA,MAAM,WAAc,GAAA,MAAM,IAAK,CAAA,WAAA,CAAY,cAAe,CAAA;AAAA,QACxD,IAAA,EAAM,OAAO,UAAc,IAAA,OAAA;AAAA,QAC3B,IAAA;AAAA,QACA,MAAA;AAAA,QACA,KAAA,EAAO,KAAK,WAAY,CAAA,KAAA;AAAA,QACxB,IAAM,EAAA;AAAA,UACJ,SAAA,EAAW,KAAK,MAAO,CAAA;AAAA,SACzB;AAAA,QACA,QAAQ,IAAK,CAAA;AAAA,OACd,CAAA;AAED,MAAM,MAAA,IAAA,CAAK,OAAQ,CAAA,GAAG,WAAW,CAAA;AAAA;AACnC,GACF;AACF,CAAC","file":"index.cjs","sourcesContent":["import path from 'node:path'\n\nimport { FileManager, type Group, PluginManager, createPlugin } from '@kubb/core'\nimport { camelCase } from '@kubb/core/transformers'\nimport { OperationGenerator, SchemaGenerator, pluginOasName } from '@kubb/plugin-oas'\n\nimport { pluginTsName } from '@kubb/plugin-ts'\n\nimport type { Plugin } from '@kubb/core'\nimport type { PluginOas } from '@kubb/plugin-oas'\nimport { fakerGenerator } from './generators/fakerGenerator.tsx'\nimport type { PluginFaker } from './types.ts'\n\nexport const pluginFakerName = 'plugin-faker' satisfies PluginFaker['name']\n\nexport const pluginFaker = createPlugin<PluginFaker>((options) => {\n const {\n output = { path: 'mocks', barrelType: 'named' },\n seed,\n group,\n exclude = [],\n include,\n override = [],\n transformers = {},\n mapper = {},\n unknownType = 'any',\n dateType = 'string',\n dateParser = 'faker',\n generators = [fakerGenerator].filter(Boolean),\n regexGenerator = 'faker',\n } = options\n\n return {\n name: pluginFakerName,\n options: {\n output,\n transformers,\n seed,\n dateType,\n unknownType,\n dateParser,\n mapper,\n override,\n regexGenerator,\n },\n pre: [pluginOasName, pluginTsName],\n resolvePath(baseName, pathMode, options) {\n const root = path.resolve(this.config.root, this.config.output.path)\n const mode = pathMode ?? FileManager.getMode(path.resolve(root, output.path))\n\n if (options?.tag && group?.type === 'tag') {\n const groupName: Group['name'] = group?.name ? group.name : (ctx) => `${ctx.group}Controller`\n\n return path.resolve(root, output.path, groupName({ group: camelCase(options.tag) }), baseName)\n }\n\n if (mode === 'single') {\n /**\n * when output is a file then we will always append to the same file(output file), see fileManager.addOrAppend\n * Other plugins then need to call addOrAppend instead of just add from the fileManager class\n */\n return path.resolve(root, output.path)\n }\n\n return path.resolve(root, output.path, baseName)\n },\n resolveName(name, type) {\n const resolvedName = camelCase(name, {\n prefix: type ? 'create' : undefined,\n isFile: type === 'file',\n })\n\n if (type) {\n return transformers?.name?.(resolvedName, type) || resolvedName\n }\n\n return resolvedName\n },\n async buildStart() {\n const [swaggerPlugin]: [Plugin<PluginOas>] = PluginManager.getDependedPlugins<PluginOas>(this.plugins, [pluginOasName])\n\n const oas = await swaggerPlugin.context.getOas()\n const root = path.resolve(this.config.root, this.config.output.path)\n const mode = FileManager.getMode(path.resolve(root, output.path))\n\n const schemaGenerator = new SchemaGenerator(this.plugin.options, {\n oas,\n pluginManager: this.pluginManager,\n plugin: this.plugin,\n contentType: swaggerPlugin.context.contentType,\n include: undefined,\n override,\n mode,\n output: output.path,\n })\n\n const schemaFiles = await schemaGenerator.build(...generators)\n await this.addFile(...schemaFiles)\n\n const operationGenerator = new OperationGenerator(this.plugin.options, {\n oas,\n pluginManager: this.pluginManager,\n plugin: this.plugin,\n contentType: swaggerPlugin.context.contentType,\n exclude,\n include,\n override,\n mode,\n })\n\n const operationFiles = await operationGenerator.build(...generators)\n await this.addFile(...operationFiles)\n\n const barrelFiles = await this.fileManager.getBarrelFiles({\n type: output.barrelType ?? 'named',\n root,\n output,\n files: this.fileManager.files,\n meta: {\n pluginKey: this.plugin.key,\n },\n logger: this.logger,\n })\n\n await this.addFile(...barrelFiles)\n },\n }\n})\n"]}
|
package/dist/index.d.cts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import * as _kubb_core from '@kubb/core';
|
|
2
|
+
import { O as Options, P as PluginFaker } from './types-Cq8z4Gto.cjs';
|
|
3
|
+
import '@kubb/oas';
|
|
4
|
+
import '@kubb/plugin-oas';
|
|
5
|
+
|
|
6
|
+
declare const pluginFakerName = "plugin-faker";
|
|
7
|
+
declare const pluginFaker: (options?: Options | undefined) => _kubb_core.UserPluginWithLifeCycle<PluginFaker>;
|
|
8
|
+
|
|
9
|
+
export { PluginFaker, pluginFaker, pluginFakerName };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import * as _kubb_core from '@kubb/core';
|
|
2
|
+
import { O as Options, P as PluginFaker } from './types-Cq8z4Gto.js';
|
|
3
|
+
import '@kubb/oas';
|
|
4
|
+
import '@kubb/plugin-oas';
|
|
5
|
+
|
|
6
|
+
declare const pluginFakerName = "plugin-faker";
|
|
7
|
+
declare const pluginFaker: (options?: Options | undefined) => _kubb_core.UserPluginWithLifeCycle<PluginFaker>;
|
|
8
|
+
|
|
9
|
+
export { PluginFaker, pluginFaker, pluginFakerName };
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
import { fakerGenerator } from './chunk-ZOJMDISS.js';
|
|
2
|
+
import './chunk-PLVSF3YP.js';
|
|
3
|
+
import path from 'node:path';
|
|
4
|
+
import { createPlugin, FileManager, PluginManager } from '@kubb/core';
|
|
5
|
+
import { camelCase } from '@kubb/core/transformers';
|
|
6
|
+
import { pluginOasName, SchemaGenerator, OperationGenerator } from '@kubb/plugin-oas';
|
|
7
|
+
import { pluginTsName } from '@kubb/plugin-ts';
|
|
8
|
+
|
|
9
|
+
var pluginFakerName = "plugin-faker";
|
|
10
|
+
var pluginFaker = createPlugin((options) => {
|
|
11
|
+
const {
|
|
12
|
+
output = { path: "mocks", barrelType: "named" },
|
|
13
|
+
seed,
|
|
14
|
+
group,
|
|
15
|
+
exclude = [],
|
|
16
|
+
include,
|
|
17
|
+
override = [],
|
|
18
|
+
transformers = {},
|
|
19
|
+
mapper = {},
|
|
20
|
+
unknownType = "any",
|
|
21
|
+
dateType = "string",
|
|
22
|
+
dateParser = "faker",
|
|
23
|
+
generators = [fakerGenerator].filter(Boolean),
|
|
24
|
+
regexGenerator = "faker"
|
|
25
|
+
} = options;
|
|
26
|
+
return {
|
|
27
|
+
name: pluginFakerName,
|
|
28
|
+
options: {
|
|
29
|
+
output,
|
|
30
|
+
transformers,
|
|
31
|
+
seed,
|
|
32
|
+
dateType,
|
|
33
|
+
unknownType,
|
|
34
|
+
dateParser,
|
|
35
|
+
mapper,
|
|
36
|
+
override,
|
|
37
|
+
regexGenerator
|
|
38
|
+
},
|
|
39
|
+
pre: [pluginOasName, pluginTsName],
|
|
40
|
+
resolvePath(baseName, pathMode, options2) {
|
|
41
|
+
const root = path.resolve(this.config.root, this.config.output.path);
|
|
42
|
+
const mode = pathMode ?? FileManager.getMode(path.resolve(root, output.path));
|
|
43
|
+
if (options2?.tag && group?.type === "tag") {
|
|
44
|
+
const groupName = group?.name ? group.name : (ctx) => `${ctx.group}Controller`;
|
|
45
|
+
return path.resolve(root, output.path, groupName({ group: camelCase(options2.tag) }), baseName);
|
|
46
|
+
}
|
|
47
|
+
if (mode === "single") {
|
|
48
|
+
return path.resolve(root, output.path);
|
|
49
|
+
}
|
|
50
|
+
return path.resolve(root, output.path, baseName);
|
|
51
|
+
},
|
|
52
|
+
resolveName(name, type) {
|
|
53
|
+
const resolvedName = camelCase(name, {
|
|
54
|
+
prefix: type ? "create" : void 0,
|
|
55
|
+
isFile: type === "file"
|
|
56
|
+
});
|
|
57
|
+
if (type) {
|
|
58
|
+
return transformers?.name?.(resolvedName, type) || resolvedName;
|
|
59
|
+
}
|
|
60
|
+
return resolvedName;
|
|
61
|
+
},
|
|
62
|
+
async buildStart() {
|
|
63
|
+
const [swaggerPlugin] = PluginManager.getDependedPlugins(this.plugins, [pluginOasName]);
|
|
64
|
+
const oas = await swaggerPlugin.context.getOas();
|
|
65
|
+
const root = path.resolve(this.config.root, this.config.output.path);
|
|
66
|
+
const mode = FileManager.getMode(path.resolve(root, output.path));
|
|
67
|
+
const schemaGenerator = new SchemaGenerator(this.plugin.options, {
|
|
68
|
+
oas,
|
|
69
|
+
pluginManager: this.pluginManager,
|
|
70
|
+
plugin: this.plugin,
|
|
71
|
+
contentType: swaggerPlugin.context.contentType,
|
|
72
|
+
include: void 0,
|
|
73
|
+
override,
|
|
74
|
+
mode,
|
|
75
|
+
output: output.path
|
|
76
|
+
});
|
|
77
|
+
const schemaFiles = await schemaGenerator.build(...generators);
|
|
78
|
+
await this.addFile(...schemaFiles);
|
|
79
|
+
const operationGenerator = new OperationGenerator(this.plugin.options, {
|
|
80
|
+
oas,
|
|
81
|
+
pluginManager: this.pluginManager,
|
|
82
|
+
plugin: this.plugin,
|
|
83
|
+
contentType: swaggerPlugin.context.contentType,
|
|
84
|
+
exclude,
|
|
85
|
+
include,
|
|
86
|
+
override,
|
|
87
|
+
mode
|
|
88
|
+
});
|
|
89
|
+
const operationFiles = await operationGenerator.build(...generators);
|
|
90
|
+
await this.addFile(...operationFiles);
|
|
91
|
+
const barrelFiles = await this.fileManager.getBarrelFiles({
|
|
92
|
+
type: output.barrelType ?? "named",
|
|
93
|
+
root,
|
|
94
|
+
output,
|
|
95
|
+
files: this.fileManager.files,
|
|
96
|
+
meta: {
|
|
97
|
+
pluginKey: this.plugin.key
|
|
98
|
+
},
|
|
99
|
+
logger: this.logger
|
|
100
|
+
});
|
|
101
|
+
await this.addFile(...barrelFiles);
|
|
102
|
+
}
|
|
103
|
+
};
|
|
104
|
+
});
|
|
105
|
+
|
|
106
|
+
export { pluginFaker, pluginFakerName };
|
|
107
|
+
//# sourceMappingURL=index.js.map
|
|
108
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/plugin.ts"],"names":["options"],"mappings":";;;;;;;;AAaO,IAAM,eAAkB,GAAA;AAElB,IAAA,WAAA,GAAc,YAA0B,CAAA,CAAC,OAAY,KAAA;AAChE,EAAM,MAAA;AAAA,IACJ,MAAS,GAAA,EAAE,IAAM,EAAA,OAAA,EAAS,YAAY,OAAQ,EAAA;AAAA,IAC9C,IAAA;AAAA,IACA,KAAA;AAAA,IACA,UAAU,EAAC;AAAA,IACX,OAAA;AAAA,IACA,WAAW,EAAC;AAAA,IACZ,eAAe,EAAC;AAAA,IAChB,SAAS,EAAC;AAAA,IACV,WAAc,GAAA,KAAA;AAAA,IACd,QAAW,GAAA,QAAA;AAAA,IACX,UAAa,GAAA,OAAA;AAAA,IACb,UAAa,GAAA,CAAC,cAAc,CAAA,CAAE,OAAO,OAAO,CAAA;AAAA,IAC5C,cAAiB,GAAA;AAAA,GACf,GAAA,OAAA;AAEJ,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,eAAA;AAAA,IACN,OAAS,EAAA;AAAA,MACP,MAAA;AAAA,MACA,YAAA;AAAA,MACA,IAAA;AAAA,MACA,QAAA;AAAA,MACA,WAAA;AAAA,MACA,UAAA;AAAA,MACA,MAAA;AAAA,MACA,QAAA;AAAA,MACA;AAAA,KACF;AAAA,IACA,GAAA,EAAK,CAAC,aAAA,EAAe,YAAY,CAAA;AAAA,IACjC,WAAA,CAAY,QAAU,EAAA,QAAA,EAAUA,QAAS,EAAA;AACvC,MAAM,MAAA,IAAA,GAAO,KAAK,OAAQ,CAAA,IAAA,CAAK,OAAO,IAAM,EAAA,IAAA,CAAK,MAAO,CAAA,MAAA,CAAO,IAAI,CAAA;AACnE,MAAM,MAAA,IAAA,GAAO,YAAY,WAAY,CAAA,OAAA,CAAQ,KAAK,OAAQ,CAAA,IAAA,EAAM,MAAO,CAAA,IAAI,CAAC,CAAA;AAE5E,MAAA,IAAIA,QAAS,EAAA,GAAA,IAAO,KAAO,EAAA,IAAA,KAAS,KAAO,EAAA;AACzC,QAAM,MAAA,SAAA,GAA2B,OAAO,IAAO,GAAA,KAAA,CAAM,OAAO,CAAC,GAAA,KAAQ,CAAG,EAAA,GAAA,CAAI,KAAK,CAAA,UAAA,CAAA;AAEjF,QAAA,OAAO,IAAK,CAAA,OAAA,CAAQ,IAAM,EAAA,MAAA,CAAO,MAAM,SAAU,CAAA,EAAE,KAAO,EAAA,SAAA,CAAUA,QAAQ,CAAA,GAAG,CAAE,EAAC,GAAG,QAAQ,CAAA;AAAA;AAG/F,MAAA,IAAI,SAAS,QAAU,EAAA;AAKrB,QAAA,OAAO,IAAK,CAAA,OAAA,CAAQ,IAAM,EAAA,MAAA,CAAO,IAAI,CAAA;AAAA;AAGvC,MAAA,OAAO,IAAK,CAAA,OAAA,CAAQ,IAAM,EAAA,MAAA,CAAO,MAAM,QAAQ,CAAA;AAAA,KACjD;AAAA,IACA,WAAA,CAAY,MAAM,IAAM,EAAA;AACtB,MAAM,MAAA,YAAA,GAAe,UAAU,IAAM,EAAA;AAAA,QACnC,MAAA,EAAQ,OAAO,QAAW,GAAA,KAAA,CAAA;AAAA,QAC1B,QAAQ,IAAS,KAAA;AAAA,OAClB,CAAA;AAED,MAAA,IAAI,IAAM,EAAA;AACR,QAAA,OAAO,YAAc,EAAA,IAAA,GAAO,YAAc,EAAA,IAAI,CAAK,IAAA,YAAA;AAAA;AAGrD,MAAO,OAAA,YAAA;AAAA,KACT;AAAA,IACA,MAAM,UAAa,GAAA;AACjB,MAAM,MAAA,CAAC,aAAa,CAAyB,GAAA,aAAA,CAAc,mBAA8B,IAAK,CAAA,OAAA,EAAS,CAAC,aAAa,CAAC,CAAA;AAEtH,MAAA,MAAM,GAAM,GAAA,MAAM,aAAc,CAAA,OAAA,CAAQ,MAAO,EAAA;AAC/C,MAAM,MAAA,IAAA,GAAO,KAAK,OAAQ,CAAA,IAAA,CAAK,OAAO,IAAM,EAAA,IAAA,CAAK,MAAO,CAAA,MAAA,CAAO,IAAI,CAAA;AACnE,MAAM,MAAA,IAAA,GAAO,YAAY,OAAQ,CAAA,IAAA,CAAK,QAAQ,IAAM,EAAA,MAAA,CAAO,IAAI,CAAC,CAAA;AAEhE,MAAA,MAAM,eAAkB,GAAA,IAAI,eAAgB,CAAA,IAAA,CAAK,OAAO,OAAS,EAAA;AAAA,QAC/D,GAAA;AAAA,QACA,eAAe,IAAK,CAAA,aAAA;AAAA,QACpB,QAAQ,IAAK,CAAA,MAAA;AAAA,QACb,WAAA,EAAa,cAAc,OAAQ,CAAA,WAAA;AAAA,QACnC,OAAS,EAAA,KAAA,CAAA;AAAA,QACT,QAAA;AAAA,QACA,IAAA;AAAA,QACA,QAAQ,MAAO,CAAA;AAAA,OAChB,CAAA;AAED,MAAA,MAAM,WAAc,GAAA,MAAM,eAAgB,CAAA,KAAA,CAAM,GAAG,UAAU,CAAA;AAC7D,MAAM,MAAA,IAAA,CAAK,OAAQ,CAAA,GAAG,WAAW,CAAA;AAEjC,MAAA,MAAM,kBAAqB,GAAA,IAAI,kBAAmB,CAAA,IAAA,CAAK,OAAO,OAAS,EAAA;AAAA,QACrE,GAAA;AAAA,QACA,eAAe,IAAK,CAAA,aAAA;AAAA,QACpB,QAAQ,IAAK,CAAA,MAAA;AAAA,QACb,WAAA,EAAa,cAAc,OAAQ,CAAA,WAAA;AAAA,QACnC,OAAA;AAAA,QACA,OAAA;AAAA,QACA,QAAA;AAAA,QACA;AAAA,OACD,CAAA;AAED,MAAA,MAAM,cAAiB,GAAA,MAAM,kBAAmB,CAAA,KAAA,CAAM,GAAG,UAAU,CAAA;AACnE,MAAM,MAAA,IAAA,CAAK,OAAQ,CAAA,GAAG,cAAc,CAAA;AAEpC,MAAA,MAAM,WAAc,GAAA,MAAM,IAAK,CAAA,WAAA,CAAY,cAAe,CAAA;AAAA,QACxD,IAAA,EAAM,OAAO,UAAc,IAAA,OAAA;AAAA,QAC3B,IAAA;AAAA,QACA,MAAA;AAAA,QACA,KAAA,EAAO,KAAK,WAAY,CAAA,KAAA;AAAA,QACxB,IAAM,EAAA;AAAA,UACJ,SAAA,EAAW,KAAK,MAAO,CAAA;AAAA,SACzB;AAAA,QACA,QAAQ,IAAK,CAAA;AAAA,OACd,CAAA;AAED,MAAM,MAAA,IAAA,CAAK,OAAQ,CAAA,GAAG,WAAW,CAAA;AAAA;AACnC,GACF;AACF,CAAC","file":"index.js","sourcesContent":["import path from 'node:path'\n\nimport { FileManager, type Group, PluginManager, createPlugin } from '@kubb/core'\nimport { camelCase } from '@kubb/core/transformers'\nimport { OperationGenerator, SchemaGenerator, pluginOasName } from '@kubb/plugin-oas'\n\nimport { pluginTsName } from '@kubb/plugin-ts'\n\nimport type { Plugin } from '@kubb/core'\nimport type { PluginOas } from '@kubb/plugin-oas'\nimport { fakerGenerator } from './generators/fakerGenerator.tsx'\nimport type { PluginFaker } from './types.ts'\n\nexport const pluginFakerName = 'plugin-faker' satisfies PluginFaker['name']\n\nexport const pluginFaker = createPlugin<PluginFaker>((options) => {\n const {\n output = { path: 'mocks', barrelType: 'named' },\n seed,\n group,\n exclude = [],\n include,\n override = [],\n transformers = {},\n mapper = {},\n unknownType = 'any',\n dateType = 'string',\n dateParser = 'faker',\n generators = [fakerGenerator].filter(Boolean),\n regexGenerator = 'faker',\n } = options\n\n return {\n name: pluginFakerName,\n options: {\n output,\n transformers,\n seed,\n dateType,\n unknownType,\n dateParser,\n mapper,\n override,\n regexGenerator,\n },\n pre: [pluginOasName, pluginTsName],\n resolvePath(baseName, pathMode, options) {\n const root = path.resolve(this.config.root, this.config.output.path)\n const mode = pathMode ?? FileManager.getMode(path.resolve(root, output.path))\n\n if (options?.tag && group?.type === 'tag') {\n const groupName: Group['name'] = group?.name ? group.name : (ctx) => `${ctx.group}Controller`\n\n return path.resolve(root, output.path, groupName({ group: camelCase(options.tag) }), baseName)\n }\n\n if (mode === 'single') {\n /**\n * when output is a file then we will always append to the same file(output file), see fileManager.addOrAppend\n * Other plugins then need to call addOrAppend instead of just add from the fileManager class\n */\n return path.resolve(root, output.path)\n }\n\n return path.resolve(root, output.path, baseName)\n },\n resolveName(name, type) {\n const resolvedName = camelCase(name, {\n prefix: type ? 'create' : undefined,\n isFile: type === 'file',\n })\n\n if (type) {\n return transformers?.name?.(resolvedName, type) || resolvedName\n }\n\n return resolvedName\n },\n async buildStart() {\n const [swaggerPlugin]: [Plugin<PluginOas>] = PluginManager.getDependedPlugins<PluginOas>(this.plugins, [pluginOasName])\n\n const oas = await swaggerPlugin.context.getOas()\n const root = path.resolve(this.config.root, this.config.output.path)\n const mode = FileManager.getMode(path.resolve(root, output.path))\n\n const schemaGenerator = new SchemaGenerator(this.plugin.options, {\n oas,\n pluginManager: this.pluginManager,\n plugin: this.plugin,\n contentType: swaggerPlugin.context.contentType,\n include: undefined,\n override,\n mode,\n output: output.path,\n })\n\n const schemaFiles = await schemaGenerator.build(...generators)\n await this.addFile(...schemaFiles)\n\n const operationGenerator = new OperationGenerator(this.plugin.options, {\n oas,\n pluginManager: this.pluginManager,\n plugin: this.plugin,\n contentType: swaggerPlugin.context.contentType,\n exclude,\n include,\n override,\n mode,\n })\n\n const operationFiles = await operationGenerator.build(...generators)\n await this.addFile(...operationFiles)\n\n const barrelFiles = await this.fileManager.getBarrelFiles({\n type: output.barrelType ?? 'named',\n root,\n output,\n files: this.fileManager.files,\n meta: {\n pluginKey: this.plugin.key,\n },\n logger: this.logger,\n })\n\n await this.addFile(...barrelFiles)\n },\n }\n})\n"]}
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import { PluginFactoryOptions, Output, Group, ResolveNameParams } from '@kubb/core';
|
|
2
|
+
import { SchemaObject } from '@kubb/oas';
|
|
3
|
+
import { ResolvePathOptions, Exclude, Include, Override, Schema, Generator } from '@kubb/plugin-oas';
|
|
4
|
+
|
|
5
|
+
type Options = {
|
|
6
|
+
/**
|
|
7
|
+
* Specify the export location for the files and define the behavior of the output
|
|
8
|
+
* @default { path: 'handlers', barrelType: 'named' }
|
|
9
|
+
*/
|
|
10
|
+
output?: Output;
|
|
11
|
+
/**
|
|
12
|
+
* Group the Faker mocks based on the provided name.
|
|
13
|
+
*/
|
|
14
|
+
group?: Group;
|
|
15
|
+
/**
|
|
16
|
+
* Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
|
|
17
|
+
*/
|
|
18
|
+
exclude?: Array<Exclude>;
|
|
19
|
+
/**
|
|
20
|
+
* Array containing include parameters to include tags/operations/methods/paths.
|
|
21
|
+
*/
|
|
22
|
+
include?: Array<Include>;
|
|
23
|
+
/**
|
|
24
|
+
* Array containing override parameters to override `options` based on tags/operations/methods/paths.
|
|
25
|
+
*/
|
|
26
|
+
override?: Array<Override<ResolvedOptions>>;
|
|
27
|
+
/**
|
|
28
|
+
* Choose to use `date` or `datetime` as JavaScript `Date` instead of `string`.
|
|
29
|
+
* @default 'string'
|
|
30
|
+
*/
|
|
31
|
+
dateType?: 'string' | 'date';
|
|
32
|
+
/**
|
|
33
|
+
* Which parser should be used when dateType is set to 'string'.
|
|
34
|
+
* - Schema with format 'date' will use ISO date format (YYYY-MM-DD)
|
|
35
|
+
* - `'dayjs'` will use `dayjs(faker.date.anytime()).format("YYYY-MM-DD")`.
|
|
36
|
+
* - `undefined` will use `faker.date.anytime().toString()`
|
|
37
|
+
* - Schema with format 'time' will use ISO time format (HH:mm:ss[.SSSSSS])
|
|
38
|
+
* - `'dayjs'` will use `dayjs(faker.date.anytime()).format("HH:mm:ss")`.
|
|
39
|
+
* - `undefined` will use `faker.date.anytime().toString()`
|
|
40
|
+
* * @default 'faker'
|
|
41
|
+
*/
|
|
42
|
+
dateParser?: 'faker' | 'dayjs' | 'moment' | (string & {});
|
|
43
|
+
/**
|
|
44
|
+
* Which type to use when the Swagger/OpenAPI file is not providing more information
|
|
45
|
+
* @default 'any'
|
|
46
|
+
*/
|
|
47
|
+
unknownType?: 'any' | 'unknown';
|
|
48
|
+
/**
|
|
49
|
+
* Choose which generator to use when using Regexp.
|
|
50
|
+
*
|
|
51
|
+
* `'faker'` will use `faker.helpers.fromRegExp(new RegExp(/test/))`
|
|
52
|
+
* `'randexp'` will use `new RandExp(/test/).gen()`
|
|
53
|
+
* @default 'faker'
|
|
54
|
+
*/
|
|
55
|
+
regexGenerator?: 'faker' | 'randexp';
|
|
56
|
+
mapper?: Record<string, string>;
|
|
57
|
+
/**
|
|
58
|
+
* The use of Seed is intended to allow for consistent values in a test.
|
|
59
|
+
*/
|
|
60
|
+
seed?: number | number[];
|
|
61
|
+
transformers?: {
|
|
62
|
+
/**
|
|
63
|
+
* Customize the names based on the type that is provided by the plugin.
|
|
64
|
+
*/
|
|
65
|
+
name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
|
|
66
|
+
/**
|
|
67
|
+
* Receive schema and baseName(propertName) and return FakerMeta array
|
|
68
|
+
* TODO TODO add docs
|
|
69
|
+
* @beta
|
|
70
|
+
*/
|
|
71
|
+
schema?: (props: {
|
|
72
|
+
schema?: SchemaObject;
|
|
73
|
+
name?: string;
|
|
74
|
+
parentName?: string;
|
|
75
|
+
}, defaultSchemas: Schema[]) => Schema[] | undefined;
|
|
76
|
+
};
|
|
77
|
+
/**
|
|
78
|
+
* Define some generators next to the faker generators
|
|
79
|
+
*/
|
|
80
|
+
generators?: Array<Generator<PluginFaker>>;
|
|
81
|
+
};
|
|
82
|
+
type ResolvedOptions = {
|
|
83
|
+
output: Output;
|
|
84
|
+
override: NonNullable<Options['override']>;
|
|
85
|
+
dateType: NonNullable<Options['dateType']>;
|
|
86
|
+
dateParser: NonNullable<Options['dateParser']>;
|
|
87
|
+
unknownType: NonNullable<Options['unknownType']>;
|
|
88
|
+
transformers: NonNullable<Options['transformers']>;
|
|
89
|
+
seed: NonNullable<Options['seed']> | undefined;
|
|
90
|
+
mapper: NonNullable<Options['mapper']>;
|
|
91
|
+
regexGenerator: NonNullable<Options['regexGenerator']>;
|
|
92
|
+
};
|
|
93
|
+
type PluginFaker = PluginFactoryOptions<'plugin-faker', Options, ResolvedOptions, never, ResolvePathOptions>;
|
|
94
|
+
|
|
95
|
+
export type { Options as O, PluginFaker as P };
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import { PluginFactoryOptions, Output, Group, ResolveNameParams } from '@kubb/core';
|
|
2
|
+
import { SchemaObject } from '@kubb/oas';
|
|
3
|
+
import { ResolvePathOptions, Exclude, Include, Override, Schema, Generator } from '@kubb/plugin-oas';
|
|
4
|
+
|
|
5
|
+
type Options = {
|
|
6
|
+
/**
|
|
7
|
+
* Specify the export location for the files and define the behavior of the output
|
|
8
|
+
* @default { path: 'handlers', barrelType: 'named' }
|
|
9
|
+
*/
|
|
10
|
+
output?: Output;
|
|
11
|
+
/**
|
|
12
|
+
* Group the Faker mocks based on the provided name.
|
|
13
|
+
*/
|
|
14
|
+
group?: Group;
|
|
15
|
+
/**
|
|
16
|
+
* Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
|
|
17
|
+
*/
|
|
18
|
+
exclude?: Array<Exclude>;
|
|
19
|
+
/**
|
|
20
|
+
* Array containing include parameters to include tags/operations/methods/paths.
|
|
21
|
+
*/
|
|
22
|
+
include?: Array<Include>;
|
|
23
|
+
/**
|
|
24
|
+
* Array containing override parameters to override `options` based on tags/operations/methods/paths.
|
|
25
|
+
*/
|
|
26
|
+
override?: Array<Override<ResolvedOptions>>;
|
|
27
|
+
/**
|
|
28
|
+
* Choose to use `date` or `datetime` as JavaScript `Date` instead of `string`.
|
|
29
|
+
* @default 'string'
|
|
30
|
+
*/
|
|
31
|
+
dateType?: 'string' | 'date';
|
|
32
|
+
/**
|
|
33
|
+
* Which parser should be used when dateType is set to 'string'.
|
|
34
|
+
* - Schema with format 'date' will use ISO date format (YYYY-MM-DD)
|
|
35
|
+
* - `'dayjs'` will use `dayjs(faker.date.anytime()).format("YYYY-MM-DD")`.
|
|
36
|
+
* - `undefined` will use `faker.date.anytime().toString()`
|
|
37
|
+
* - Schema with format 'time' will use ISO time format (HH:mm:ss[.SSSSSS])
|
|
38
|
+
* - `'dayjs'` will use `dayjs(faker.date.anytime()).format("HH:mm:ss")`.
|
|
39
|
+
* - `undefined` will use `faker.date.anytime().toString()`
|
|
40
|
+
* * @default 'faker'
|
|
41
|
+
*/
|
|
42
|
+
dateParser?: 'faker' | 'dayjs' | 'moment' | (string & {});
|
|
43
|
+
/**
|
|
44
|
+
* Which type to use when the Swagger/OpenAPI file is not providing more information
|
|
45
|
+
* @default 'any'
|
|
46
|
+
*/
|
|
47
|
+
unknownType?: 'any' | 'unknown';
|
|
48
|
+
/**
|
|
49
|
+
* Choose which generator to use when using Regexp.
|
|
50
|
+
*
|
|
51
|
+
* `'faker'` will use `faker.helpers.fromRegExp(new RegExp(/test/))`
|
|
52
|
+
* `'randexp'` will use `new RandExp(/test/).gen()`
|
|
53
|
+
* @default 'faker'
|
|
54
|
+
*/
|
|
55
|
+
regexGenerator?: 'faker' | 'randexp';
|
|
56
|
+
mapper?: Record<string, string>;
|
|
57
|
+
/**
|
|
58
|
+
* The use of Seed is intended to allow for consistent values in a test.
|
|
59
|
+
*/
|
|
60
|
+
seed?: number | number[];
|
|
61
|
+
transformers?: {
|
|
62
|
+
/**
|
|
63
|
+
* Customize the names based on the type that is provided by the plugin.
|
|
64
|
+
*/
|
|
65
|
+
name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
|
|
66
|
+
/**
|
|
67
|
+
* Receive schema and baseName(propertName) and return FakerMeta array
|
|
68
|
+
* TODO TODO add docs
|
|
69
|
+
* @beta
|
|
70
|
+
*/
|
|
71
|
+
schema?: (props: {
|
|
72
|
+
schema?: SchemaObject;
|
|
73
|
+
name?: string;
|
|
74
|
+
parentName?: string;
|
|
75
|
+
}, defaultSchemas: Schema[]) => Schema[] | undefined;
|
|
76
|
+
};
|
|
77
|
+
/**
|
|
78
|
+
* Define some generators next to the faker generators
|
|
79
|
+
*/
|
|
80
|
+
generators?: Array<Generator<PluginFaker>>;
|
|
81
|
+
};
|
|
82
|
+
type ResolvedOptions = {
|
|
83
|
+
output: Output;
|
|
84
|
+
override: NonNullable<Options['override']>;
|
|
85
|
+
dateType: NonNullable<Options['dateType']>;
|
|
86
|
+
dateParser: NonNullable<Options['dateParser']>;
|
|
87
|
+
unknownType: NonNullable<Options['unknownType']>;
|
|
88
|
+
transformers: NonNullable<Options['transformers']>;
|
|
89
|
+
seed: NonNullable<Options['seed']> | undefined;
|
|
90
|
+
mapper: NonNullable<Options['mapper']>;
|
|
91
|
+
regexGenerator: NonNullable<Options['regexGenerator']>;
|
|
92
|
+
};
|
|
93
|
+
type PluginFaker = PluginFactoryOptions<'plugin-faker', Options, ResolvedOptions, never, ResolvePathOptions>;
|
|
94
|
+
|
|
95
|
+
export type { Options as O, PluginFaker as P };
|
package/package.json
ADDED
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@kubb/plugin-faker",
|
|
3
|
+
"version": "0.0.0-canary-20241104172400",
|
|
4
|
+
"description": "Generator plugin-faker",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"faker",
|
|
7
|
+
"faker.js",
|
|
8
|
+
"mock",
|
|
9
|
+
"mocking",
|
|
10
|
+
"plugins",
|
|
11
|
+
"kubb",
|
|
12
|
+
"codegen",
|
|
13
|
+
"swagger",
|
|
14
|
+
"openapi"
|
|
15
|
+
],
|
|
16
|
+
"repository": {
|
|
17
|
+
"type": "git",
|
|
18
|
+
"url": "git://github.com/kubb-labs/kubb.git",
|
|
19
|
+
"directory": "packages/plugin-faker"
|
|
20
|
+
},
|
|
21
|
+
"license": "MIT",
|
|
22
|
+
"author": "Stijn Van Hulle <stijn@stijnvanhulle.be",
|
|
23
|
+
"sideEffects": false,
|
|
24
|
+
"type": "module",
|
|
25
|
+
"exports": {
|
|
26
|
+
".": {
|
|
27
|
+
"import": "./dist/index.js",
|
|
28
|
+
"require": "./dist/index.cjs",
|
|
29
|
+
"default": "./dist/index.cjs"
|
|
30
|
+
},
|
|
31
|
+
"./generators": {
|
|
32
|
+
"import": "./dist/generators.js",
|
|
33
|
+
"require": "./dist/generators.cjs",
|
|
34
|
+
"default": "./dist/generators.cjs"
|
|
35
|
+
},
|
|
36
|
+
"./components": {
|
|
37
|
+
"import": "./dist/components.js",
|
|
38
|
+
"require": "./dist/components.cjs",
|
|
39
|
+
"default": "./dist/components.cjs"
|
|
40
|
+
},
|
|
41
|
+
"./package.json": "./package.json",
|
|
42
|
+
"./*": "./*"
|
|
43
|
+
},
|
|
44
|
+
"main": "dist/index.cjs",
|
|
45
|
+
"module": "dist/index.js",
|
|
46
|
+
"types": "./dist/index.d.ts",
|
|
47
|
+
"typesVersions": {
|
|
48
|
+
"*": {
|
|
49
|
+
"components": [
|
|
50
|
+
"./dist/components.d.ts"
|
|
51
|
+
],
|
|
52
|
+
"generators": [
|
|
53
|
+
"./dist/generators.d.ts"
|
|
54
|
+
]
|
|
55
|
+
}
|
|
56
|
+
},
|
|
57
|
+
"files": [
|
|
58
|
+
"src",
|
|
59
|
+
"dist",
|
|
60
|
+
"!/**/**.test.**",
|
|
61
|
+
"!/**/__tests__/**"
|
|
62
|
+
],
|
|
63
|
+
"dependencies": {
|
|
64
|
+
"@kubb/core": "0.0.0-canary-20241104172400",
|
|
65
|
+
"@kubb/fs": "0.0.0-canary-20241104172400",
|
|
66
|
+
"@kubb/oas": "0.0.0-canary-20241104172400",
|
|
67
|
+
"@kubb/plugin-oas": "0.0.0-canary-20241104172400",
|
|
68
|
+
"@kubb/plugin-ts": "0.0.0-canary-20241104172400",
|
|
69
|
+
"@kubb/react": "0.0.0-canary-20241104172400"
|
|
70
|
+
},
|
|
71
|
+
"devDependencies": {
|
|
72
|
+
"tsup": "^8.3.5",
|
|
73
|
+
"typescript": "^5.6.3",
|
|
74
|
+
"@kubb/config-ts": "0.0.0-canary-20241104172400",
|
|
75
|
+
"@kubb/config-tsup": "0.0.0-canary-20241104172400"
|
|
76
|
+
},
|
|
77
|
+
"peerDependencies": {
|
|
78
|
+
"@kubb/react": "0.0.0-canary-20241104172400"
|
|
79
|
+
},
|
|
80
|
+
"engines": {
|
|
81
|
+
"node": ">=20"
|
|
82
|
+
},
|
|
83
|
+
"publishConfig": {
|
|
84
|
+
"access": "public",
|
|
85
|
+
"registry": "https://registry.npmjs.org/"
|
|
86
|
+
},
|
|
87
|
+
"scripts": {
|
|
88
|
+
"build": "tsup",
|
|
89
|
+
"clean": "npx rimraf ./dist",
|
|
90
|
+
"lint": "bun biome lint .",
|
|
91
|
+
"lint:fix": "bun biome lint --apply-unsafe .",
|
|
92
|
+
"release": "pnpm publish --no-git-check",
|
|
93
|
+
"release:canary": "bash ../../.github/canary.sh && node ../../scripts/build.js canary && pnpm publish --no-git-check",
|
|
94
|
+
"start": "tsup --watch",
|
|
95
|
+
"test": "vitest --passWithNoTests",
|
|
96
|
+
"typecheck": "tsc -p ./tsconfig.json --noEmit --emitDeclarationOnly false"
|
|
97
|
+
}
|
|
98
|
+
}
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
import { File, Function, FunctionParams } from '@kubb/react'
|
|
2
|
+
|
|
3
|
+
import transformers from '@kubb/core/transformers'
|
|
4
|
+
import type { Schema } from '@kubb/plugin-oas'
|
|
5
|
+
import type { KubbNode } from '@kubb/react/types'
|
|
6
|
+
import * as parserFaker from '../parser/index.ts'
|
|
7
|
+
import type { PluginFaker } from '../types.ts'
|
|
8
|
+
|
|
9
|
+
type Props = {
|
|
10
|
+
name: string
|
|
11
|
+
typeName: string
|
|
12
|
+
tree: Array<Schema>
|
|
13
|
+
seed?: PluginFaker['options']['seed']
|
|
14
|
+
description?: string
|
|
15
|
+
regexGenerator?: PluginFaker['options']['regexGenerator']
|
|
16
|
+
mapper?: PluginFaker['options']['mapper']
|
|
17
|
+
dateParser?: PluginFaker['options']['dateParser']
|
|
18
|
+
canOverride: boolean
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
export function Faker({ tree, description, name, typeName, seed, regexGenerator, canOverride, mapper, dateParser }: Props): KubbNode {
|
|
22
|
+
const fakerText = parserFaker.joinItems(
|
|
23
|
+
tree
|
|
24
|
+
.map((schema, _index, siblings) =>
|
|
25
|
+
parserFaker.parse(
|
|
26
|
+
{ parent: undefined, current: schema, siblings },
|
|
27
|
+
{
|
|
28
|
+
name,
|
|
29
|
+
typeName,
|
|
30
|
+
seed,
|
|
31
|
+
regexGenerator,
|
|
32
|
+
mapper,
|
|
33
|
+
canOverride,
|
|
34
|
+
dateParser,
|
|
35
|
+
},
|
|
36
|
+
),
|
|
37
|
+
)
|
|
38
|
+
.filter(Boolean),
|
|
39
|
+
)
|
|
40
|
+
|
|
41
|
+
let fakerTextWithOverride = fakerText
|
|
42
|
+
|
|
43
|
+
if (canOverride && fakerText.startsWith('{')) {
|
|
44
|
+
fakerTextWithOverride = `{
|
|
45
|
+
...${fakerText},
|
|
46
|
+
...data || {}
|
|
47
|
+
}`
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
if (canOverride && fakerText.startsWith('faker.helpers.arrayElement')) {
|
|
51
|
+
fakerTextWithOverride = `${fakerText} || data`
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
if ((canOverride && fakerText.startsWith('faker.helpers.arrayElements')) || fakerText.startsWith('faker.helpers.multiple')) {
|
|
55
|
+
fakerTextWithOverride = `[
|
|
56
|
+
...${fakerText},
|
|
57
|
+
...data || []
|
|
58
|
+
]`
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
const params = FunctionParams.factory({
|
|
62
|
+
data: {
|
|
63
|
+
type: `Partial<${typeName}>`,
|
|
64
|
+
optional: true,
|
|
65
|
+
},
|
|
66
|
+
})
|
|
67
|
+
|
|
68
|
+
return (
|
|
69
|
+
<File.Source name={name} isExportable isIndexable>
|
|
70
|
+
<Function
|
|
71
|
+
export
|
|
72
|
+
name={name}
|
|
73
|
+
JSDoc={{ comments: [description ? `@description ${transformers.jsStringEscape(description)}` : undefined].filter(Boolean) }}
|
|
74
|
+
params={canOverride ? params.toConstructor() : undefined}
|
|
75
|
+
>
|
|
76
|
+
{seed ? `faker.seed(${JSON.stringify(seed)})` : undefined}
|
|
77
|
+
<br />
|
|
78
|
+
{`return ${fakerTextWithOverride}`}
|
|
79
|
+
</Function>
|
|
80
|
+
</File.Source>
|
|
81
|
+
)
|
|
82
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { Faker } from './Faker.tsx'
|