@kubb/plugin-client 3.0.0-alpha.8 → 3.0.0-beta.1

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.
Files changed (64) hide show
  1. package/README.md +14 -5
  2. package/client.ts +2 -2
  3. package/dist/chunk-6W3SC7JK.cjs +228 -0
  4. package/dist/chunk-6W3SC7JK.cjs.map +1 -0
  5. package/dist/chunk-LI44LDXH.js +218 -0
  6. package/dist/chunk-LI44LDXH.js.map +1 -0
  7. package/dist/chunk-X73EA6RA.cjs +133 -0
  8. package/dist/chunk-X73EA6RA.cjs.map +1 -0
  9. package/dist/chunk-YYBNZBCI.js +130 -0
  10. package/dist/chunk-YYBNZBCI.js.map +1 -0
  11. package/dist/client.cjs +16 -7
  12. package/dist/client.cjs.map +1 -1
  13. package/dist/client.d.cts +2 -2
  14. package/dist/client.d.ts +2 -2
  15. package/dist/client.js +5 -6
  16. package/dist/client.js.map +1 -1
  17. package/dist/components.cjs +11 -4
  18. package/dist/components.cjs.map +1 -1
  19. package/dist/components.d.cts +37 -7
  20. package/dist/components.d.ts +37 -7
  21. package/dist/components.js +2 -8
  22. package/dist/components.js.map +1 -1
  23. package/dist/generators.cjs +21 -0
  24. package/dist/generators.cjs.map +1 -0
  25. package/dist/generators.d.cts +11 -0
  26. package/dist/generators.d.ts +11 -0
  27. package/dist/generators.js +4 -0
  28. package/dist/generators.js.map +1 -0
  29. package/dist/index.cjs +10 -128
  30. package/dist/index.cjs.map +1 -1
  31. package/dist/index.d.cts +1 -6
  32. package/dist/index.d.ts +1 -6
  33. package/dist/index.js +3 -134
  34. package/dist/index.js.map +1 -1
  35. package/dist/types-Bk_NZurp.d.cts +86 -0
  36. package/dist/types-Bk_NZurp.d.ts +86 -0
  37. package/package.json +22 -17
  38. package/src/components/Client.tsx +109 -208
  39. package/src/components/Operations.tsx +5 -71
  40. package/src/generators/__snapshots__/deletePet.ts +13 -0
  41. package/src/generators/__snapshots__/deletePetObject.ts +15 -0
  42. package/src/generators/__snapshots__/findByTags.ts +13 -0
  43. package/src/generators/__snapshots__/findByTagsFull.ts +13 -0
  44. package/src/generators/__snapshots__/findByTagsWithZod.ts +13 -0
  45. package/src/generators/__snapshots__/findByTagsWithZodFull.ts +13 -0
  46. package/src/generators/__snapshots__/importPath.ts +13 -0
  47. package/src/generators/__snapshots__/operations.ts +82 -0
  48. package/src/generators/__snapshots__/updatePetById.ts +12 -0
  49. package/src/generators/clientGenerator.tsx +66 -0
  50. package/src/generators/groupedClientGenerator.tsx +70 -0
  51. package/src/generators/index.ts +3 -0
  52. package/src/generators/operationsGenerator.tsx +26 -0
  53. package/src/plugin.ts +34 -45
  54. package/src/types.ts +33 -75
  55. package/dist/chunk-E562RKCC.js +0 -199
  56. package/dist/chunk-E562RKCC.js.map +0 -1
  57. package/dist/chunk-PXA2JOEN.cjs +0 -199
  58. package/dist/chunk-PXA2JOEN.cjs.map +0 -1
  59. package/dist/types-C_-LImV-.d.cts +0 -233
  60. package/dist/types-C_-LImV-.d.ts +0 -233
  61. package/src/OperationGenerator.tsx +0 -29
  62. package/src/components/__snapshots__/Client/showPetById.ts +0 -8
  63. package/src/components/__snapshots__/Operations/showPetById.ts +0 -6
  64. package/src/components/__snapshots__/Query/showPetById.ts +0 -15
package/dist/index.cjs CHANGED
@@ -1,135 +1,17 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }
1
+ 'use strict';
2
2
 
3
+ var chunk6W3SC7JK_cjs = require('./chunk-6W3SC7JK.cjs');
4
+ require('./chunk-X73EA6RA.cjs');
3
5
 
4
- var _chunkPXA2JOENcjs = require('./chunk-PXA2JOEN.cjs');
5
6
 
6
- // src/plugin.ts
7
- var _path = require('path'); var _path2 = _interopRequireDefault(_path);
8
- var _core = require('@kubb/core');
9
- var _transformers = require('@kubb/core/transformers');
10
- var _utils = require('@kubb/core/utils');
11
- var _pluginoas = require('@kubb/plugin-oas');
12
7
 
13
- // src/OperationGenerator.tsx
14
-
15
- require('@kubb/plugin-oas/components');
16
- require('@kubb/react');
17
- var _jsxruntime = require('@kubb/react/jsx-runtime');
18
- var clientParser = _pluginoas.createReactParser.call(void 0, {
19
- name: "plugin-client",
20
- Operations({ options }) {
21
- if (!options.templates.operations) {
22
- return null;
23
- }
24
- return /* @__PURE__ */ _jsxruntime.jsx.call(void 0, _chunkPXA2JOENcjs.Operations.File, { baseURL: options.baseURL, templates: options.templates.operations });
25
- },
26
- Operation({ options, operation }) {
27
- const isEnabled = options.client.methods.some((method) => operation.method === method);
28
- if (!options.templates.client || !isEnabled) {
29
- return null;
30
- }
31
- return /* @__PURE__ */ _jsxruntime.jsx.call(void 0, _chunkPXA2JOENcjs.Client.File, { baseURL: options.baseURL, templates: options.templates.client });
32
- }
8
+ Object.defineProperty(exports, "pluginClient", {
9
+ enumerable: true,
10
+ get: function () { return chunk6W3SC7JK_cjs.pluginClient; }
33
11
  });
34
-
35
- // src/plugin.ts
36
- var pluginClientName = "plugin-client";
37
- var pluginClient = _core.createPlugin.call(void 0, (options) => {
38
- const {
39
- output = { path: "clients" },
40
- group,
41
- exclude = [],
42
- include,
43
- override = [],
44
- transformers = {},
45
- dataReturnType = "data",
46
- pathParamsType = "inline",
47
- templates
48
- } = options;
49
- const template = _optionalChain([group, 'optionalAccess', _ => _.output]) ? group.output : `${output.path}/{{tag}}Controller`;
50
- return {
51
- name: pluginClientName,
52
- output: {
53
- exportType: "barrelNamed",
54
- ...output
55
- },
56
- options: {
57
- extName: output.extName,
58
- dataReturnType,
59
- client: {
60
- importPath: "@kubb/plugin-client/client",
61
- methods: ["get", "post", "delete", "put"],
62
- ...options.client
63
- },
64
- pathParamsType,
65
- templates: {
66
- operations: _chunkPXA2JOENcjs.Operations.templates,
67
- client: _chunkPXA2JOENcjs.Client.templates,
68
- ...templates
69
- },
70
- baseURL: void 0
71
- },
72
- pre: [_pluginoas.pluginOasName],
73
- resolvePath(baseName, pathMode, options2) {
74
- const root = _path2.default.resolve(this.config.root, this.config.output.path);
75
- const mode = _nullishCoalesce(pathMode, () => ( _core.FileManager.getMode(_path2.default.resolve(root, output.path))));
76
- if (mode === "single") {
77
- return _path2.default.resolve(root, output.path);
78
- }
79
- if (_optionalChain([options2, 'optionalAccess', _2 => _2.tag]) && _optionalChain([group, 'optionalAccess', _3 => _3.type]) === "tag") {
80
- const tag = _transformers.camelCase.call(void 0, options2.tag);
81
- return _path2.default.resolve(root, _utils.renderTemplate.call(void 0, template, { tag }), baseName);
82
- }
83
- return _path2.default.resolve(root, output.path, baseName);
84
- },
85
- resolveName(name, type) {
86
- const resolvedName = _transformers.camelCase.call(void 0, name, { isFile: type === "file" });
87
- if (type) {
88
- return _optionalChain([transformers, 'optionalAccess', _4 => _4.name, 'optionalCall', _5 => _5(resolvedName, type)]) || resolvedName;
89
- }
90
- return resolvedName;
91
- },
92
- async buildStart() {
93
- const [swaggerPlugin] = _core.PluginManager.getDependedPlugins(this.plugins, [_pluginoas.pluginOasName]);
94
- const oas = await swaggerPlugin.context.getOas();
95
- const root = _path2.default.resolve(this.config.root, this.config.output.path);
96
- const mode = _core.FileManager.getMode(_path2.default.resolve(root, output.path));
97
- const baseURL = await swaggerPlugin.context.getBaseURL();
98
- const operationGenerator = new (0, _pluginoas.OperationGenerator)(
99
- {
100
- ...this.plugin.options,
101
- baseURL
102
- },
103
- {
104
- oas,
105
- pluginManager: this.pluginManager,
106
- plugin: this.plugin,
107
- contentType: swaggerPlugin.context.contentType,
108
- exclude,
109
- include,
110
- override,
111
- mode
112
- }
113
- );
114
- const files = await operationGenerator.build(clientParser);
115
- await this.addFile(...files);
116
- if (this.config.output.exportType) {
117
- const barrelFiles = await this.fileManager.getBarrelFiles({
118
- root,
119
- output,
120
- files: this.fileManager.files,
121
- meta: {
122
- pluginKey: this.plugin.key
123
- },
124
- logger: this.logger
125
- });
126
- await this.addFile(...barrelFiles);
127
- }
128
- }
129
- };
12
+ Object.defineProperty(exports, "pluginClientName", {
13
+ enumerable: true,
14
+ get: function () { return chunk6W3SC7JK_cjs.pluginClientName; }
130
15
  });
131
-
132
-
133
-
134
- exports.pluginClient = pluginClient; exports.pluginClientName = pluginClientName;
16
+ //# sourceMappingURL=index.cjs.map
135
17
  //# sourceMappingURL=index.cjs.map
@@ -1 +1 @@
1
- {"version":3,"sources":["/home/runner/work/kubb/kubb/packages/plugin-client/dist/index.cjs","../src/plugin.ts","../src/OperationGenerator.tsx"],"names":[],"mappings":"AAAA;AACE;AACA;AACF,wDAA6B;AAC7B;AACA;ACLA,wEAAiB;AAEjB,kCAAyD;AACzD,uDAA0B;AAC1B,yCAA+B;AAC/B,6CAAkD;ADMlD;AACA;AEZA;AACA,uCAAoB;AACpB,uBAAgC;AAerB,qDAAA;AAPJ,IAAM,aAAA,EAAe,0CAAA;AAAgC,EAC1D,IAAA,EAAM,eAAA;AAAA,EACN,UAAA,CAAW,EAAE,QAAQ,CAAA,EAAG;AACtB,IAAA,GAAA,CAAI,CAAC,OAAA,CAAQ,SAAA,CAAU,UAAA,EAAY;AACjC,MAAA,OAAO,IAAA;AAAA,IACT;AAEA,IAAA,uBAAO,6BAAA,4BAAC,CAAW,IAAA,EAAX,EAAgB,OAAA,EAAS,OAAA,CAAQ,OAAA,EAAS,SAAA,EAAW,OAAA,CAAQ,SAAA,CAAU,WAAA,CAAY,CAAA;AAAA,EAC7F,CAAA;AAAA,EACA,SAAA,CAAU,EAAE,OAAA,EAAS,UAAU,CAAA,EAAG;AAChC,IAAA,MAAM,UAAA,EAAY,OAAA,CAAQ,MAAA,CAAO,OAAA,CAAQ,IAAA,CAAK,CAAC,MAAA,EAAA,GAAW,SAAA,CAAU,OAAA,IAAW,MAAM,CAAA;AAErF,IAAA,GAAA,CAAI,CAAC,OAAA,CAAQ,SAAA,CAAU,OAAA,GAAU,CAAC,SAAA,EAAW;AAC3C,MAAA,OAAO,IAAA;AAAA,IACT;AAEA,IAAA,uBAAO,6BAAA,wBAAC,CAAO,IAAA,EAAP,EAAY,OAAA,EAAS,OAAA,CAAQ,OAAA,EAAS,SAAA,EAAW,OAAA,CAAQ,SAAA,CAAU,OAAA,CAAQ,CAAA;AAAA,EACrF;AACF,CAAC,CAAA;AFKD;AACA;ACpBO,IAAM,iBAAA,EAAmB,eAAA;AAEzB,IAAM,aAAA,EAAe,gCAAA,CAA4B,OAAA,EAAA,GAAY;AAClE,EAAA,MAAM;AAAA,IACJ,OAAA,EAAS,EAAE,IAAA,EAAM,UAAU,CAAA;AAAA,IAC3B,KAAA;AAAA,IACA,QAAA,EAAU,CAAC,CAAA;AAAA,IACX,OAAA;AAAA,IACA,SAAA,EAAW,CAAC,CAAA;AAAA,IACZ,aAAA,EAAe,CAAC,CAAA;AAAA,IAChB,eAAA,EAAiB,MAAA;AAAA,IACjB,eAAA,EAAiB,QAAA;AAAA,IACjB;AAAA,EACF,EAAA,EAAI,OAAA;AAEJ,EAAA,MAAM,SAAA,kBAAW,KAAA,2BAAO,SAAA,EAAS,KAAA,CAAM,OAAA,EAAS,CAAA,EAAA;AAEzC,EAAA;AACC,IAAA;AACE,IAAA;AACM,MAAA;AACT,MAAA;AACL,IAAA;AACS,IAAA;AACS,MAAA;AAChB,MAAA;AACQ,MAAA;AACM,QAAA;AAC4B,QAAA;AAC7B,QAAA;AACb,MAAA;AACA,MAAA;AACW,MAAA;AACc,QAAA;AACR,QAAA;AACZ,QAAA;AACL,MAAA;AACS,MAAA;AACX,IAAA;AACmB,IAAA;AACsB,IAAA;AACK,MAAA;AACC,MAAA;AAEtB,MAAA;AAKgB,QAAA;AACvC,MAAA;AAE2C,MAAA;AACR,QAAA;AAEQ,QAAA;AAC3C,MAAA;AAEuC,MAAA;AACzC,IAAA;AACwB,IAAA;AACiB,MAAA;AAE7B,MAAA;AACkC,QAAA;AAC5C,MAAA;AAEO,MAAA;AACT,IAAA;AACmB,IAAA;AACqD,MAAA;AAE9B,MAAA;AACI,MAAA;AACN,MAAA;AACM,MAAA;AAEb,MAAA;AAC7B,QAAA;AACiB,UAAA;AACf,UAAA;AACF,QAAA;AACA,QAAA;AACE,UAAA;AACoB,UAAA;AACP,UAAA;AACsB,UAAA;AACnC,UAAA;AACA,UAAA;AACA,UAAA;AACA,UAAA;AACF,QAAA;AACF,MAAA;AAE6C,MAAA;AAElB,MAAA;AAEQ,MAAA;AACU,QAAA;AACzC,UAAA;AACA,UAAA;AACwB,UAAA;AAClB,UAAA;AACmB,YAAA;AACzB,UAAA;AACa,UAAA;AACd,QAAA;AAEgC,QAAA;AACnC,MAAA;AACF,IAAA;AACF,EAAA;AACD;ADGkD;AACA;AACA;AACA","file":"/home/runner/work/kubb/kubb/packages/plugin-client/dist/index.cjs","sourcesContent":[null,"import path from 'node:path'\n\nimport { FileManager, PluginManager, createPlugin } from '@kubb/core'\nimport { camelCase } from '@kubb/core/transformers'\nimport { renderTemplate } from '@kubb/core/utils'\nimport { OperationGenerator, pluginOasName } from '@kubb/plugin-oas'\n\nimport { clientParser } from './OperationGenerator.tsx'\nimport { Client, Operations } from './components/index.ts'\n\nimport type { Plugin } from '@kubb/core'\nimport type { PluginOas as SwaggerPluginOptions } from '@kubb/plugin-oas'\nimport type { PluginClient } from './types.ts'\n\nexport const pluginClientName = 'plugin-client' satisfies PluginClient['name']\n\nexport const pluginClient = createPlugin<PluginClient>((options) => {\n const {\n output = { path: 'clients' },\n group,\n exclude = [],\n include,\n override = [],\n transformers = {},\n dataReturnType = 'data',\n pathParamsType = 'inline',\n templates,\n } = options\n\n const template = group?.output ? group.output : `${output.path}/{{tag}}Controller`\n\n return {\n name: pluginClientName,\n output: {\n exportType: 'barrelNamed',\n ...output,\n },\n options: {\n extName: output.extName,\n dataReturnType,\n client: {\n importPath: '@kubb/plugin-client/client',\n methods: ['get', 'post', 'delete', 'put'],\n ...options.client,\n },\n pathParamsType,\n templates: {\n operations: Operations.templates,\n client: Client.templates,\n ...templates,\n },\n baseURL: undefined,\n },\n pre: [pluginOasName],\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 (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 if (options?.tag && group?.type === 'tag') {\n const tag = camelCase(options.tag)\n\n return path.resolve(root, renderTemplate(template, { tag }), baseName)\n }\n\n return path.resolve(root, output.path, baseName)\n },\n resolveName(name, type) {\n const resolvedName = camelCase(name, { isFile: type === 'file' })\n\n if (type) {\n return transformers?.name?.(resolvedName, type) || resolvedName\n }\n\n return resolvedName\n },\n async buildStart() {\n const [swaggerPlugin]: [Plugin<SwaggerPluginOptions>] = PluginManager.getDependedPlugins<SwaggerPluginOptions>(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 const baseURL = await swaggerPlugin.context.getBaseURL()\n\n const operationGenerator = new OperationGenerator(\n {\n ...this.plugin.options,\n baseURL,\n },\n {\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\n const files = await operationGenerator.build(clientParser)\n\n await this.addFile(...files)\n\n if (this.config.output.exportType) {\n const barrelFiles = await this.fileManager.getBarrelFiles({\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})\n","import { createReactParser, OperationGenerator as Generator } from '@kubb/plugin-oas'\nimport { Oas } from '@kubb/plugin-oas/components'\nimport { App, createRoot } from '@kubb/react'\n\nimport { Client, Operations } from './components/index.ts'\n\nimport type { Operation } from '@kubb/oas'\nimport type { OperationMethodResult, OperationsByMethod } from '@kubb/plugin-oas'\nimport type { FileMeta, PluginClient } from './types.ts'\n\nexport const clientParser = createReactParser<PluginClient>({\n name: 'plugin-client',\n Operations({ options }) {\n if (!options.templates.operations) {\n return null\n }\n\n return <Operations.File baseURL={options.baseURL} templates={options.templates.operations} />\n },\n Operation({ options, operation }) {\n const isEnabled = options.client.methods.some((method) => operation.method === method)\n\n if (!options.templates.client || !isEnabled) {\n return null\n }\n\n return <Client.File baseURL={options.baseURL} templates={options.templates.client} />\n },\n})\n"]}
1
+ {"version":3,"sources":[],"names":[],"mappings":"","file":"index.cjs"}
package/dist/index.d.cts CHANGED
@@ -1,11 +1,6 @@
1
1
  import * as _kubb_core from '@kubb/core';
2
- import { O as Options, P as PluginClient } from './types-C_-LImV-.cjs';
3
- import '@kubb/fs/types';
4
- import '@kubb/oas';
2
+ import { O as Options, P as PluginClient } from './types-Bk_NZurp.cjs';
5
3
  import '@kubb/plugin-oas';
6
- import '@kubb/core/utils';
7
- import '@kubb/react/types';
8
- import 'react';
9
4
 
10
5
  declare const pluginClientName = "plugin-client";
11
6
  declare const pluginClient: (options?: Options | undefined) => _kubb_core.UserPluginWithLifeCycle<PluginClient>;
package/dist/index.d.ts CHANGED
@@ -1,11 +1,6 @@
1
1
  import * as _kubb_core from '@kubb/core';
2
- import { O as Options, P as PluginClient } from './types-C_-LImV-.js';
3
- import '@kubb/fs/types';
4
- import '@kubb/oas';
2
+ import { O as Options, P as PluginClient } from './types-Bk_NZurp.js';
5
3
  import '@kubb/plugin-oas';
6
- import '@kubb/core/utils';
7
- import '@kubb/react/types';
8
- import 'react';
9
4
 
10
5
  declare const pluginClientName = "plugin-client";
11
6
  declare const pluginClient: (options?: Options | undefined) => _kubb_core.UserPluginWithLifeCycle<PluginClient>;
package/dist/index.js CHANGED
@@ -1,135 +1,4 @@
1
- import {
2
- Client,
3
- Operations
4
- } from "./chunk-E562RKCC.js";
5
-
6
- // src/plugin.ts
7
- import path from "node:path";
8
- import { FileManager, PluginManager, createPlugin } from "@kubb/core";
9
- import { camelCase } from "@kubb/core/transformers";
10
- import { renderTemplate } from "@kubb/core/utils";
11
- import { OperationGenerator, pluginOasName } from "@kubb/plugin-oas";
12
-
13
- // src/OperationGenerator.tsx
14
- import { createReactParser } from "@kubb/plugin-oas";
15
- import "@kubb/plugin-oas/components";
16
- import "@kubb/react";
17
- import { jsx } from "@kubb/react/jsx-runtime";
18
- var clientParser = createReactParser({
19
- name: "plugin-client",
20
- Operations({ options }) {
21
- if (!options.templates.operations) {
22
- return null;
23
- }
24
- return /* @__PURE__ */ jsx(Operations.File, { baseURL: options.baseURL, templates: options.templates.operations });
25
- },
26
- Operation({ options, operation }) {
27
- const isEnabled = options.client.methods.some((method) => operation.method === method);
28
- if (!options.templates.client || !isEnabled) {
29
- return null;
30
- }
31
- return /* @__PURE__ */ jsx(Client.File, { baseURL: options.baseURL, templates: options.templates.client });
32
- }
33
- });
34
-
35
- // src/plugin.ts
36
- var pluginClientName = "plugin-client";
37
- var pluginClient = createPlugin((options) => {
38
- const {
39
- output = { path: "clients" },
40
- group,
41
- exclude = [],
42
- include,
43
- override = [],
44
- transformers = {},
45
- dataReturnType = "data",
46
- pathParamsType = "inline",
47
- templates
48
- } = options;
49
- const template = group?.output ? group.output : `${output.path}/{{tag}}Controller`;
50
- return {
51
- name: pluginClientName,
52
- output: {
53
- exportType: "barrelNamed",
54
- ...output
55
- },
56
- options: {
57
- extName: output.extName,
58
- dataReturnType,
59
- client: {
60
- importPath: "@kubb/plugin-client/client",
61
- methods: ["get", "post", "delete", "put"],
62
- ...options.client
63
- },
64
- pathParamsType,
65
- templates: {
66
- operations: Operations.templates,
67
- client: Client.templates,
68
- ...templates
69
- },
70
- baseURL: void 0
71
- },
72
- pre: [pluginOasName],
73
- resolvePath(baseName, pathMode, options2) {
74
- const root = path.resolve(this.config.root, this.config.output.path);
75
- const mode = pathMode ?? FileManager.getMode(path.resolve(root, output.path));
76
- if (mode === "single") {
77
- return path.resolve(root, output.path);
78
- }
79
- if (options2?.tag && group?.type === "tag") {
80
- const tag = camelCase(options2.tag);
81
- return path.resolve(root, renderTemplate(template, { tag }), baseName);
82
- }
83
- return path.resolve(root, output.path, baseName);
84
- },
85
- resolveName(name, type) {
86
- const resolvedName = camelCase(name, { isFile: type === "file" });
87
- if (type) {
88
- return transformers?.name?.(resolvedName, type) || resolvedName;
89
- }
90
- return resolvedName;
91
- },
92
- async buildStart() {
93
- const [swaggerPlugin] = PluginManager.getDependedPlugins(this.plugins, [pluginOasName]);
94
- const oas = await swaggerPlugin.context.getOas();
95
- const root = path.resolve(this.config.root, this.config.output.path);
96
- const mode = FileManager.getMode(path.resolve(root, output.path));
97
- const baseURL = await swaggerPlugin.context.getBaseURL();
98
- const operationGenerator = new OperationGenerator(
99
- {
100
- ...this.plugin.options,
101
- baseURL
102
- },
103
- {
104
- oas,
105
- pluginManager: this.pluginManager,
106
- plugin: this.plugin,
107
- contentType: swaggerPlugin.context.contentType,
108
- exclude,
109
- include,
110
- override,
111
- mode
112
- }
113
- );
114
- const files = await operationGenerator.build(clientParser);
115
- await this.addFile(...files);
116
- if (this.config.output.exportType) {
117
- const barrelFiles = await this.fileManager.getBarrelFiles({
118
- root,
119
- output,
120
- files: this.fileManager.files,
121
- meta: {
122
- pluginKey: this.plugin.key
123
- },
124
- logger: this.logger
125
- });
126
- await this.addFile(...barrelFiles);
127
- }
128
- }
129
- };
130
- });
131
- export {
132
- pluginClient,
133
- pluginClientName
134
- };
1
+ export { pluginClient, pluginClientName } from './chunk-LI44LDXH.js';
2
+ import './chunk-YYBNZBCI.js';
3
+ //# sourceMappingURL=index.js.map
135
4
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/plugin.ts","../src/OperationGenerator.tsx"],"sourcesContent":["import path from 'node:path'\n\nimport { FileManager, PluginManager, createPlugin } from '@kubb/core'\nimport { camelCase } from '@kubb/core/transformers'\nimport { renderTemplate } from '@kubb/core/utils'\nimport { OperationGenerator, pluginOasName } from '@kubb/plugin-oas'\n\nimport { clientParser } from './OperationGenerator.tsx'\nimport { Client, Operations } from './components/index.ts'\n\nimport type { Plugin } from '@kubb/core'\nimport type { PluginOas as SwaggerPluginOptions } from '@kubb/plugin-oas'\nimport type { PluginClient } from './types.ts'\n\nexport const pluginClientName = 'plugin-client' satisfies PluginClient['name']\n\nexport const pluginClient = createPlugin<PluginClient>((options) => {\n const {\n output = { path: 'clients' },\n group,\n exclude = [],\n include,\n override = [],\n transformers = {},\n dataReturnType = 'data',\n pathParamsType = 'inline',\n templates,\n } = options\n\n const template = group?.output ? group.output : `${output.path}/{{tag}}Controller`\n\n return {\n name: pluginClientName,\n output: {\n exportType: 'barrelNamed',\n ...output,\n },\n options: {\n extName: output.extName,\n dataReturnType,\n client: {\n importPath: '@kubb/plugin-client/client',\n methods: ['get', 'post', 'delete', 'put'],\n ...options.client,\n },\n pathParamsType,\n templates: {\n operations: Operations.templates,\n client: Client.templates,\n ...templates,\n },\n baseURL: undefined,\n },\n pre: [pluginOasName],\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 (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 if (options?.tag && group?.type === 'tag') {\n const tag = camelCase(options.tag)\n\n return path.resolve(root, renderTemplate(template, { tag }), baseName)\n }\n\n return path.resolve(root, output.path, baseName)\n },\n resolveName(name, type) {\n const resolvedName = camelCase(name, { isFile: type === 'file' })\n\n if (type) {\n return transformers?.name?.(resolvedName, type) || resolvedName\n }\n\n return resolvedName\n },\n async buildStart() {\n const [swaggerPlugin]: [Plugin<SwaggerPluginOptions>] = PluginManager.getDependedPlugins<SwaggerPluginOptions>(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 const baseURL = await swaggerPlugin.context.getBaseURL()\n\n const operationGenerator = new OperationGenerator(\n {\n ...this.plugin.options,\n baseURL,\n },\n {\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\n const files = await operationGenerator.build(clientParser)\n\n await this.addFile(...files)\n\n if (this.config.output.exportType) {\n const barrelFiles = await this.fileManager.getBarrelFiles({\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})\n","import { createReactParser, OperationGenerator as Generator } from '@kubb/plugin-oas'\nimport { Oas } from '@kubb/plugin-oas/components'\nimport { App, createRoot } from '@kubb/react'\n\nimport { Client, Operations } from './components/index.ts'\n\nimport type { Operation } from '@kubb/oas'\nimport type { OperationMethodResult, OperationsByMethod } from '@kubb/plugin-oas'\nimport type { FileMeta, PluginClient } from './types.ts'\n\nexport const clientParser = createReactParser<PluginClient>({\n name: 'plugin-client',\n Operations({ options }) {\n if (!options.templates.operations) {\n return null\n }\n\n return <Operations.File baseURL={options.baseURL} templates={options.templates.operations} />\n },\n Operation({ options, operation }) {\n const isEnabled = options.client.methods.some((method) => operation.method === method)\n\n if (!options.templates.client || !isEnabled) {\n return null\n }\n\n return <Client.File baseURL={options.baseURL} templates={options.templates.client} />\n },\n})\n"],"mappings":";;;;;;AAAA,OAAO,UAAU;AAEjB,SAAS,aAAa,eAAe,oBAAoB;AACzD,SAAS,iBAAiB;AAC1B,SAAS,sBAAsB;AAC/B,SAAS,oBAAoB,qBAAqB;;;ACLlD,SAAS,yBAA0D;AACnE,OAAoB;AACpB,OAAgC;AAerB;AAPJ,IAAM,eAAe,kBAAgC;AAAA,EAC1D,MAAM;AAAA,EACN,WAAW,EAAE,QAAQ,GAAG;AACtB,QAAI,CAAC,QAAQ,UAAU,YAAY;AACjC,aAAO;AAAA,IACT;AAEA,WAAO,oBAAC,WAAW,MAAX,EAAgB,SAAS,QAAQ,SAAS,WAAW,QAAQ,UAAU,YAAY;AAAA,EAC7F;AAAA,EACA,UAAU,EAAE,SAAS,UAAU,GAAG;AAChC,UAAM,YAAY,QAAQ,OAAO,QAAQ,KAAK,CAAC,WAAW,UAAU,WAAW,MAAM;AAErF,QAAI,CAAC,QAAQ,UAAU,UAAU,CAAC,WAAW;AAC3C,aAAO;AAAA,IACT;AAEA,WAAO,oBAAC,OAAO,MAAP,EAAY,SAAS,QAAQ,SAAS,WAAW,QAAQ,UAAU,QAAQ;AAAA,EACrF;AACF,CAAC;;;ADdM,IAAM,mBAAmB;AAEzB,IAAM,eAAe,aAA2B,CAAC,YAAY;AAClE,QAAM;AAAA,IACJ,SAAS,EAAE,MAAM,UAAU;AAAA,IAC3B;AAAA,IACA,UAAU,CAAC;AAAA,IACX;AAAA,IACA,WAAW,CAAC;AAAA,IACZ,eAAe,CAAC;AAAA,IAChB,iBAAiB;AAAA,IACjB,iBAAiB;AAAA,IACjB;AAAA,EACF,IAAI;AAEJ,QAAM,WAAW,OAAO,SAAS,MAAM,SAAS,GAAG,OAAO,IAAI;AAE9D,SAAO;AAAA,IACL,MAAM;AAAA,IACN,QAAQ;AAAA,MACN,YAAY;AAAA,MACZ,GAAG;AAAA,IACL;AAAA,IACA,SAAS;AAAA,MACP,SAAS,OAAO;AAAA,MAChB;AAAA,MACA,QAAQ;AAAA,QACN,YAAY;AAAA,QACZ,SAAS,CAAC,OAAO,QAAQ,UAAU,KAAK;AAAA,QACxC,GAAG,QAAQ;AAAA,MACb;AAAA,MACA;AAAA,MACA,WAAW;AAAA,QACT,YAAY,WAAW;AAAA,QACvB,QAAQ,OAAO;AAAA,QACf,GAAG;AAAA,MACL;AAAA,MACA,SAAS;AAAA,IACX;AAAA,IACA,KAAK,CAAC,aAAa;AAAA,IACnB,YAAY,UAAU,UAAUA,UAAS;AACvC,YAAM,OAAO,KAAK,QAAQ,KAAK,OAAO,MAAM,KAAK,OAAO,OAAO,IAAI;AACnE,YAAM,OAAO,YAAY,YAAY,QAAQ,KAAK,QAAQ,MAAM,OAAO,IAAI,CAAC;AAE5E,UAAI,SAAS,UAAU;AAKrB,eAAO,KAAK,QAAQ,MAAM,OAAO,IAAI;AAAA,MACvC;AAEA,UAAIA,UAAS,OAAO,OAAO,SAAS,OAAO;AACzC,cAAM,MAAM,UAAUA,SAAQ,GAAG;AAEjC,eAAO,KAAK,QAAQ,MAAM,eAAe,UAAU,EAAE,IAAI,CAAC,GAAG,QAAQ;AAAA,MACvE;AAEA,aAAO,KAAK,QAAQ,MAAM,OAAO,MAAM,QAAQ;AAAA,IACjD;AAAA,IACA,YAAY,MAAM,MAAM;AACtB,YAAM,eAAe,UAAU,MAAM,EAAE,QAAQ,SAAS,OAAO,CAAC;AAEhE,UAAI,MAAM;AACR,eAAO,cAAc,OAAO,cAAc,IAAI,KAAK;AAAA,MACrD;AAEA,aAAO;AAAA,IACT;AAAA,IACA,MAAM,aAAa;AACjB,YAAM,CAAC,aAAa,IAAoC,cAAc,mBAAyC,KAAK,SAAS,CAAC,aAAa,CAAC;AAE5I,YAAM,MAAM,MAAM,cAAc,QAAQ,OAAO;AAC/C,YAAM,OAAO,KAAK,QAAQ,KAAK,OAAO,MAAM,KAAK,OAAO,OAAO,IAAI;AACnE,YAAM,OAAO,YAAY,QAAQ,KAAK,QAAQ,MAAM,OAAO,IAAI,CAAC;AAChE,YAAM,UAAU,MAAM,cAAc,QAAQ,WAAW;AAEvD,YAAM,qBAAqB,IAAI;AAAA,QAC7B;AAAA,UACE,GAAG,KAAK,OAAO;AAAA,UACf;AAAA,QACF;AAAA,QACA;AAAA,UACE;AAAA,UACA,eAAe,KAAK;AAAA,UACpB,QAAQ,KAAK;AAAA,UACb,aAAa,cAAc,QAAQ;AAAA,UACnC;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,QACF;AAAA,MACF;AAEA,YAAM,QAAQ,MAAM,mBAAmB,MAAM,YAAY;AAEzD,YAAM,KAAK,QAAQ,GAAG,KAAK;AAE3B,UAAI,KAAK,OAAO,OAAO,YAAY;AACjC,cAAM,cAAc,MAAM,KAAK,YAAY,eAAe;AAAA,UACxD;AAAA,UACA;AAAA,UACA,OAAO,KAAK,YAAY;AAAA,UACxB,MAAM;AAAA,YACJ,WAAW,KAAK,OAAO;AAAA,UACzB;AAAA,UACA,QAAQ,KAAK;AAAA,QACf,CAAC;AAED,cAAM,KAAK,QAAQ,GAAG,WAAW;AAAA,MACnC;AAAA,IACF;AAAA,EACF;AACF,CAAC;","names":["options"]}
1
+ {"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}
@@ -0,0 +1,86 @@
1
+ import { PluginFactoryOptions, Output, Group, ResolveNameParams } from '@kubb/core';
2
+ import { ResolvePathOptions, Exclude, Include, Override, Generator } from '@kubb/plugin-oas';
3
+
4
+ type Options = {
5
+ /**
6
+ * Specify the export location for the files and define the behavior of the output
7
+ * @default { path: 'clients', barrelType: 'named' }
8
+ */
9
+ output?: Output;
10
+ /**
11
+ * Group the clients based on the provided name.
12
+ */
13
+ group?: Group;
14
+ /**
15
+ * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
16
+ */
17
+ exclude?: Array<Exclude>;
18
+ /**
19
+ * Array containing include parameters to include tags/operations/methods/paths.
20
+ */
21
+ include?: Array<Include>;
22
+ /**
23
+ * Array containing override parameters to override `options` based on tags/operations/methods/paths.
24
+ */
25
+ override?: Array<Override<ResolvedOptions>>;
26
+ /**
27
+ * Create `operations.ts` file with all operations grouped by methods.
28
+ * @default `false`
29
+ */
30
+ operations?: boolean;
31
+ /**
32
+ * Path to the client import path that will be used to do the API calls.
33
+ * It will be used as `import client from '${client.importPath}'`.
34
+ * It allows both relative and absolute path but be aware that we will not change the path.
35
+ * @default '@kubb/plugin-client/client'
36
+ */
37
+ importPath?: string;
38
+ /**
39
+ * ReturnType that will be used when calling the client.
40
+ *
41
+ * `Data` will return ResponseConfig[data].
42
+ *
43
+ * `Full` will return ResponseConfig.
44
+ * @default `'data'`
45
+ * @private
46
+ */
47
+ dataReturnType?: 'data' | 'full';
48
+ /**
49
+ * How to pass your pathParams.
50
+ *
51
+ * `object` will return the pathParams as an object.
52
+ *
53
+ * `inline` will return the pathParams as comma separated params.
54
+ * @default `'inline'`
55
+ * @private
56
+ */
57
+ pathParamsType?: 'object' | 'inline';
58
+ /**
59
+ * Which parser can be used before returning the data
60
+ * `'zod'` will use `@kubb/plugin-zod` to parse the data.
61
+ * @default 'client'
62
+ */
63
+ parser?: 'client' | 'zod';
64
+ transformers?: {
65
+ /**
66
+ * Customize the names based on the type that is provided by the plugin.
67
+ */
68
+ name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
69
+ };
70
+ /**
71
+ * Define some generators next to the client generators
72
+ */
73
+ generators?: Array<Generator<PluginClient>>;
74
+ };
75
+ type ResolvedOptions = {
76
+ output: Output;
77
+ group?: Options['group'];
78
+ baseURL: string | undefined;
79
+ parser: NonNullable<Options['parser']>;
80
+ importPath: NonNullable<Options['importPath']>;
81
+ dataReturnType: NonNullable<Options['dataReturnType']>;
82
+ pathParamsType: NonNullable<Options['pathParamsType']>;
83
+ };
84
+ type PluginClient = PluginFactoryOptions<'plugin-client', Options, ResolvedOptions, never, ResolvePathOptions>;
85
+
86
+ export type { Options as O, PluginClient as P };
@@ -0,0 +1,86 @@
1
+ import { PluginFactoryOptions, Output, Group, ResolveNameParams } from '@kubb/core';
2
+ import { ResolvePathOptions, Exclude, Include, Override, Generator } from '@kubb/plugin-oas';
3
+
4
+ type Options = {
5
+ /**
6
+ * Specify the export location for the files and define the behavior of the output
7
+ * @default { path: 'clients', barrelType: 'named' }
8
+ */
9
+ output?: Output;
10
+ /**
11
+ * Group the clients based on the provided name.
12
+ */
13
+ group?: Group;
14
+ /**
15
+ * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
16
+ */
17
+ exclude?: Array<Exclude>;
18
+ /**
19
+ * Array containing include parameters to include tags/operations/methods/paths.
20
+ */
21
+ include?: Array<Include>;
22
+ /**
23
+ * Array containing override parameters to override `options` based on tags/operations/methods/paths.
24
+ */
25
+ override?: Array<Override<ResolvedOptions>>;
26
+ /**
27
+ * Create `operations.ts` file with all operations grouped by methods.
28
+ * @default `false`
29
+ */
30
+ operations?: boolean;
31
+ /**
32
+ * Path to the client import path that will be used to do the API calls.
33
+ * It will be used as `import client from '${client.importPath}'`.
34
+ * It allows both relative and absolute path but be aware that we will not change the path.
35
+ * @default '@kubb/plugin-client/client'
36
+ */
37
+ importPath?: string;
38
+ /**
39
+ * ReturnType that will be used when calling the client.
40
+ *
41
+ * `Data` will return ResponseConfig[data].
42
+ *
43
+ * `Full` will return ResponseConfig.
44
+ * @default `'data'`
45
+ * @private
46
+ */
47
+ dataReturnType?: 'data' | 'full';
48
+ /**
49
+ * How to pass your pathParams.
50
+ *
51
+ * `object` will return the pathParams as an object.
52
+ *
53
+ * `inline` will return the pathParams as comma separated params.
54
+ * @default `'inline'`
55
+ * @private
56
+ */
57
+ pathParamsType?: 'object' | 'inline';
58
+ /**
59
+ * Which parser can be used before returning the data
60
+ * `'zod'` will use `@kubb/plugin-zod` to parse the data.
61
+ * @default 'client'
62
+ */
63
+ parser?: 'client' | 'zod';
64
+ transformers?: {
65
+ /**
66
+ * Customize the names based on the type that is provided by the plugin.
67
+ */
68
+ name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
69
+ };
70
+ /**
71
+ * Define some generators next to the client generators
72
+ */
73
+ generators?: Array<Generator<PluginClient>>;
74
+ };
75
+ type ResolvedOptions = {
76
+ output: Output;
77
+ group?: Options['group'];
78
+ baseURL: string | undefined;
79
+ parser: NonNullable<Options['parser']>;
80
+ importPath: NonNullable<Options['importPath']>;
81
+ dataReturnType: NonNullable<Options['dataReturnType']>;
82
+ pathParamsType: NonNullable<Options['pathParamsType']>;
83
+ };
84
+ type PluginClient = PluginFactoryOptions<'plugin-client', Options, ResolvedOptions, never, ResolvePathOptions>;
85
+
86
+ export type { Options as O, PluginClient as P };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kubb/plugin-client",
3
- "version": "3.0.0-alpha.8",
3
+ "version": "3.0.0-beta.1",
4
4
  "description": "Generator plugin-client",
5
5
  "keywords": [
6
6
  "typescript",
@@ -26,6 +26,11 @@
26
26
  "require": "./dist/index.cjs",
27
27
  "default": "./dist/index.cjs"
28
28
  },
29
+ "./generators": {
30
+ "import": "./dist/generators.js",
31
+ "require": "./dist/generators.cjs",
32
+ "default": "./dist/generators.cjs"
33
+ },
29
34
  "./components": {
30
35
  "import": "./dist/components.js",
31
36
  "require": "./dist/components.cjs",
@@ -51,6 +56,9 @@
51
56
  "*": {
52
57
  "components": [
53
58
  "./dist/components.d.ts"
59
+ ],
60
+ "generators": [
61
+ "./dist/generators.d.ts"
54
62
  ]
55
63
  }
56
64
  },
@@ -64,27 +72,24 @@
64
72
  "!/**/__tests__/**"
65
73
  ],
66
74
  "dependencies": {
67
- "@kubb/core": "3.0.0-alpha.8",
68
- "@kubb/fs": "3.0.0-alpha.8",
69
- "@kubb/oas": "3.0.0-alpha.8",
70
- "@kubb/parser-ts": "3.0.0-alpha.8",
71
- "@kubb/plugin-oas": "3.0.0-alpha.8",
72
- "@kubb/plugin-ts": "3.0.0-alpha.8",
73
- "@kubb/react": "3.0.0-alpha.8"
75
+ "@kubb/core": "3.0.0-beta.1",
76
+ "@kubb/fs": "3.0.0-beta.1",
77
+ "@kubb/oas": "3.0.0-beta.1",
78
+ "@kubb/plugin-oas": "3.0.0-beta.1",
79
+ "@kubb/plugin-ts": "3.0.0-beta.1",
80
+ "@kubb/plugin-zod": "3.0.0-beta.1",
81
+ "@kubb/react": "3.0.0-beta.1"
74
82
  },
75
83
  "devDependencies": {
76
- "@types/react": "^18.3.4",
77
- "axios": "^1.7.5",
78
- "react": "^18.3.1",
79
- "tsup": "^8.2.4",
80
- "typescript": "^5.5.4",
81
- "@kubb/config-biome": "3.0.0-alpha.8",
82
- "@kubb/config-ts": "3.0.0-alpha.8",
83
- "@kubb/config-tsup": "3.0.0-alpha.8"
84
+ "axios": "^1.7.7",
85
+ "tsup": "^8.3.0",
86
+ "typescript": "^5.6.2",
87
+ "@kubb/config-ts": "3.0.0-beta.1",
88
+ "@kubb/config-tsup": "3.0.0-beta.1"
84
89
  },
85
90
  "peerDependencies": {
86
91
  "axios": "^1.7.2",
87
- "@kubb/react": "3.0.0-alpha.8"
92
+ "@kubb/react": "3.0.0-beta.1"
88
93
  },
89
94
  "peerDependenciesMeta": {
90
95
  "axios": {