@kubb/plugin-cypress 5.0.0-alpha.8 → 5.0.0-beta.10
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 +17 -10
- package/README.md +25 -7
- package/dist/index.cjs +549 -61
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +183 -4
- package/dist/index.js +543 -62
- package/dist/index.js.map +1 -1
- package/extension.yaml +441 -0
- package/package.json +41 -67
- package/src/components/Request.tsx +72 -107
- package/src/generators/cypressGenerator.tsx +38 -44
- package/src/index.ts +9 -2
- package/src/plugin.ts +68 -92
- package/src/resolvers/resolverCypress.ts +25 -0
- package/src/types.ts +79 -43
- package/dist/components-BK_6GU4v.js +0 -257
- package/dist/components-BK_6GU4v.js.map +0 -1
- package/dist/components-Drg_gLu2.cjs +0 -305
- package/dist/components-Drg_gLu2.cjs.map +0 -1
- package/dist/components.cjs +0 -3
- package/dist/components.d.ts +0 -50
- package/dist/components.js +0 -2
- package/dist/generators-B3FWG2Ck.js +0 -71
- package/dist/generators-B3FWG2Ck.js.map +0 -1
- package/dist/generators-C73nd-xB.cjs +0 -75
- package/dist/generators-C73nd-xB.cjs.map +0 -1
- package/dist/generators.cjs +0 -3
- package/dist/generators.d.ts +0 -476
- package/dist/generators.js +0 -2
- package/dist/types-DGvL0jsn.d.ts +0 -85
- package/src/components/index.ts +0 -1
- package/src/generators/index.ts +0 -1
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":[],"sources":["../src/plugin.ts"],"sourcesContent":["import path from 'node:path'\nimport { camelCase } from '@internals/utils'\nimport { createPlugin, type Group, getBarrelFiles, getMode } from '@kubb/core'\nimport { OperationGenerator, pluginOasName } from '@kubb/plugin-oas'\nimport { pluginTsName } from '@kubb/plugin-ts'\nimport { cypressGenerator } from './generators'\nimport type { PluginCypress } from './types.ts'\n\nexport const pluginCypressName = 'plugin-cypress' satisfies PluginCypress['name']\n\nexport const pluginCypress = createPlugin<PluginCypress>((options) => {\n const {\n output = { path: 'cypress', barrelType: 'named' },\n group,\n dataReturnType = 'data',\n exclude = [],\n include,\n override = [],\n transformers = {},\n generators = [cypressGenerator].filter(Boolean),\n contentType,\n baseURL,\n paramsCasing,\n paramsType = 'inline',\n pathParamsType = paramsType === 'object' ? 'object' : options.pathParamsType || 'inline',\n } = options\n\n return {\n name: pluginCypressName,\n options: {\n output,\n dataReturnType,\n group,\n baseURL,\n\n paramsCasing,\n paramsType,\n pathParamsType,\n },\n pre: [pluginOasName, pluginTsName].filter(Boolean),\n resolvePath(baseName, pathMode, options) {\n const root = path.resolve(this.config.root, this.config.output.path)\n const mode = pathMode ?? 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 (group && (options?.group?.path || options?.group?.tag)) {\n const groupName: Group['name'] = group?.name\n ? group.name\n : (ctx) => {\n if (group?.type === 'path') {\n return `${ctx.group.split('/')[1]}`\n }\n return `${camelCase(ctx.group)}Requests`\n }\n\n return path.resolve(\n root,\n output.path,\n groupName({\n group: group.type === 'path' ? options.group.path! : options.group.tag!,\n }),\n baseName,\n )\n }\n\n return path.resolve(root, output.path, baseName)\n },\n resolveName(name, type) {\n const resolvedName = camelCase(name, {\n isFile: type === 'file',\n })\n\n if (type) {\n return transformers?.name?.(resolvedName, type) || resolvedName\n }\n\n return resolvedName\n },\n async install() {\n const root = path.resolve(this.config.root, this.config.output.path)\n const mode = getMode(path.resolve(root, output.path))\n const oas = await this.getOas()\n\n const operationGenerator = new OperationGenerator(this.plugin.options, {\n fabric: this.fabric,\n oas,\n driver: this.driver,\n events: this.events,\n plugin: this.plugin,\n contentType,\n exclude,\n include,\n override,\n mode,\n })\n\n const files = await operationGenerator.build(...generators)\n await this.upsertFile(...files)\n\n const barrelFiles = await getBarrelFiles(this.fabric.files, {\n type: output.barrelType ?? 'named',\n root,\n output,\n meta: {\n pluginName: this.plugin.name,\n },\n })\n\n await this.upsertFile(...barrelFiles)\n },\n }\n})\n"],"mappings":";;;;;;;;AAQA,MAAa,oBAAoB;AAEjC,MAAa,gBAAgB,cAA6B,YAAY;CACpE,MAAM,EACJ,SAAS;EAAE,MAAM;EAAW,YAAY;EAAS,EACjD,OACA,iBAAiB,QACjB,UAAU,EAAE,EACZ,SACA,WAAW,EAAE,EACb,eAAe,EAAE,EACjB,aAAa,CAAC,iBAAiB,CAAC,OAAO,QAAQ,EAC/C,aACA,SACA,cACA,aAAa,UACb,iBAAiB,eAAe,WAAW,WAAW,QAAQ,kBAAkB,aAC9E;AAEJ,QAAO;EACL,MAAM;EACN,SAAS;GACP;GACA;GACA;GACA;GAEA;GACA;GACA;GACD;EACD,KAAK,CAAC,eAAe,aAAa,CAAC,OAAO,QAAQ;EAClD,YAAY,UAAU,UAAU,SAAS;GACvC,MAAM,OAAO,KAAK,QAAQ,KAAK,OAAO,MAAM,KAAK,OAAO,OAAO,KAAK;AAGpE,QAFa,YAAY,QAAQ,KAAK,QAAQ,MAAM,OAAO,KAAK,CAAC,MAEpD;;;;;AAKX,UAAO,KAAK,QAAQ,MAAM,OAAO,KAAK;AAGxC,OAAI,UAAU,SAAS,OAAO,QAAQ,SAAS,OAAO,MAAM;IAC1D,MAAM,YAA2B,OAAO,OACpC,MAAM,QACL,QAAQ;AACP,SAAI,OAAO,SAAS,OAClB,QAAO,GAAG,IAAI,MAAM,MAAM,IAAI,CAAC;AAEjC,YAAO,GAAG,UAAU,IAAI,MAAM,CAAC;;AAGrC,WAAO,KAAK,QACV,MACA,OAAO,MACP,UAAU,EACR,OAAO,MAAM,SAAS,SAAS,QAAQ,MAAM,OAAQ,QAAQ,MAAM,KACpE,CAAC,EACF,SACD;;AAGH,UAAO,KAAK,QAAQ,MAAM,OAAO,MAAM,SAAS;;EAElD,YAAY,MAAM,MAAM;GACtB,MAAM,eAAe,UAAU,MAAM,EACnC,QAAQ,SAAS,QAClB,CAAC;AAEF,OAAI,KACF,QAAO,cAAc,OAAO,cAAc,KAAK,IAAI;AAGrD,UAAO;;EAET,MAAM,UAAU;GACd,MAAM,OAAO,KAAK,QAAQ,KAAK,OAAO,MAAM,KAAK,OAAO,OAAO,KAAK;GACpE,MAAM,OAAO,QAAQ,KAAK,QAAQ,MAAM,OAAO,KAAK,CAAC;GACrD,MAAM,MAAM,MAAM,KAAK,QAAQ;GAe/B,MAAM,QAAQ,MAba,IAAI,mBAAmB,KAAK,OAAO,SAAS;IACrE,QAAQ,KAAK;IACb;IACA,QAAQ,KAAK;IACb,QAAQ,KAAK;IACb,QAAQ,KAAK;IACb;IACA;IACA;IACA;IACA;IACD,CAAC,CAEqC,MAAM,GAAG,WAAW;AAC3D,SAAM,KAAK,WAAW,GAAG,MAAM;GAE/B,MAAM,cAAc,MAAM,eAAe,KAAK,OAAO,OAAO;IAC1D,MAAM,OAAO,cAAc;IAC3B;IACA;IACA,MAAM,EACJ,YAAY,KAAK,OAAO,MACzB;IACF,CAAC;AAEF,SAAM,KAAK,WAAW,GAAG,YAAY;;EAExC;EACD"}
|
|
1
|
+
{"version":3,"file":"index.js","names":["#options","#transformParam","#eachParam"],"sources":["../../../internals/utils/src/casing.ts","../../../internals/utils/src/reserved.ts","../../../internals/utils/src/urlPath.ts","../../../internals/shared/src/operation.ts","../src/components/Request.tsx","../src/generators/cypressGenerator.tsx","../src/resolvers/resolverCypress.ts","../src/plugin.ts"],"sourcesContent":["type Options = {\n /**\n * When `true`, dot-separated segments are split on `.` and joined with `/` after casing.\n */\n isFile?: boolean\n /**\n * Text prepended before casing is applied.\n */\n prefix?: string\n /**\n * Text appended before casing is applied.\n */\n suffix?: string\n}\n\n/**\n * Shared implementation for camelCase and PascalCase conversion.\n * Splits on common word boundaries (spaces, hyphens, underscores, dots, slashes, colons)\n * and capitalizes each word according to `pascal`.\n *\n * When `pascal` is `true` the first word is also capitalized (PascalCase), otherwise only subsequent words are.\n */\nfunction toCamelOrPascal(text: string, pascal: boolean): string {\n const normalized = text\n .trim()\n .replace(/([a-z\\d])([A-Z])/g, '$1 $2')\n .replace(/([A-Z]+)([A-Z][a-z])/g, '$1 $2')\n .replace(/(\\d)([a-z])/g, '$1 $2')\n\n const words = normalized.split(/[\\s\\-_./\\\\:]+/).filter(Boolean)\n\n return words\n .map((word, i) => {\n const allUpper = word.length > 1 && word === word.toUpperCase()\n if (allUpper) return word\n if (i === 0 && !pascal) return word.charAt(0).toLowerCase() + word.slice(1)\n return word.charAt(0).toUpperCase() + word.slice(1)\n })\n .join('')\n .replace(/[^a-zA-Z0-9]/g, '')\n}\n\n/**\n * Splits `text` on `.` and applies `transformPart` to each segment.\n * The last segment receives `isLast = true`, all earlier segments receive `false`.\n * Segments are joined with `/` to form a file path.\n *\n * Only splits on dots followed by a letter so that version numbers\n * embedded in operationIds (e.g. `v2025.0`) are kept intact.\n */\nfunction applyToFileParts(text: string, transformPart: (part: string, isLast: boolean) => string): string {\n const parts = text.split(/\\.(?=[a-zA-Z])/)\n return parts.map((part, i) => transformPart(part, i === parts.length - 1)).join('/')\n}\n\n/**\n * Converts `text` to camelCase.\n * When `isFile` is `true`, dot-separated segments are each cased independently and joined with `/`.\n *\n * @example\n * camelCase('hello-world') // 'helloWorld'\n * camelCase('pet.petId', { isFile: true }) // 'pet/petId'\n */\nexport function camelCase(text: string, { isFile, prefix = '', suffix = '' }: Options = {}): string {\n if (isFile) {\n return applyToFileParts(text, (part, isLast) => camelCase(part, isLast ? { prefix, suffix } : {}))\n }\n\n return toCamelOrPascal(`${prefix} ${text} ${suffix}`, false)\n}\n\n/**\n * Converts `text` to PascalCase.\n * When `isFile` is `true`, the last dot-separated segment is PascalCased and earlier segments are camelCased.\n *\n * @example\n * pascalCase('hello-world') // 'HelloWorld'\n * pascalCase('pet.petId', { isFile: true }) // 'pet/PetId'\n */\nexport function pascalCase(text: string, { isFile, prefix = '', suffix = '' }: Options = {}): string {\n if (isFile) {\n return applyToFileParts(text, (part, isLast) => (isLast ? pascalCase(part, { prefix, suffix }) : camelCase(part)))\n }\n\n return toCamelOrPascal(`${prefix} ${text} ${suffix}`, true)\n}\n\n/**\n * Converts `text` to snake_case.\n *\n * @example\n * snakeCase('helloWorld') // 'hello_world'\n * snakeCase('Hello-World') // 'hello_world'\n */\nexport function snakeCase(text: string, { prefix = '', suffix = '' }: Omit<Options, 'isFile'> = {}): string {\n const processed = `${prefix} ${text} ${suffix}`.trim()\n return processed\n .replace(/([a-z])([A-Z])/g, '$1_$2')\n .replace(/[\\s\\-.]+/g, '_')\n .replace(/[^a-zA-Z0-9_]/g, '')\n .toLowerCase()\n .split('_')\n .filter(Boolean)\n .join('_')\n}\n\n/**\n * Converts `text` to SCREAMING_SNAKE_CASE.\n *\n * @example\n * screamingSnakeCase('helloWorld') // 'HELLO_WORLD'\n */\nexport function screamingSnakeCase(text: string, { prefix = '', suffix = '' }: Omit<Options, 'isFile'> = {}): string {\n return snakeCase(text, { prefix, suffix }).toUpperCase()\n}\n","/**\n * JavaScript and Java reserved words.\n * @link https://github.com/jonschlinkert/reserved/blob/master/index.js\n */\nconst reservedWords = new Set([\n 'abstract',\n 'arguments',\n 'boolean',\n 'break',\n 'byte',\n 'case',\n 'catch',\n 'char',\n 'class',\n 'const',\n 'continue',\n 'debugger',\n 'default',\n 'delete',\n 'do',\n 'double',\n 'else',\n 'enum',\n 'eval',\n 'export',\n 'extends',\n 'false',\n 'final',\n 'finally',\n 'float',\n 'for',\n 'function',\n 'goto',\n 'if',\n 'implements',\n 'import',\n 'in',\n 'instanceof',\n 'int',\n 'interface',\n 'let',\n 'long',\n 'native',\n 'new',\n 'null',\n 'package',\n 'private',\n 'protected',\n 'public',\n 'return',\n 'short',\n 'static',\n 'super',\n 'switch',\n 'synchronized',\n 'this',\n 'throw',\n 'throws',\n 'transient',\n 'true',\n 'try',\n 'typeof',\n 'var',\n 'void',\n 'volatile',\n 'while',\n 'with',\n 'yield',\n 'Array',\n 'Date',\n 'hasOwnProperty',\n 'Infinity',\n 'isFinite',\n 'isNaN',\n 'isPrototypeOf',\n 'length',\n 'Math',\n 'name',\n 'NaN',\n 'Number',\n 'Object',\n 'prototype',\n 'String',\n 'toString',\n 'undefined',\n 'valueOf',\n] as const)\n\n/**\n * Returns `true` when `name` is a syntactically valid JavaScript variable name.\n *\n * @example\n * ```ts\n * isValidVarName('status') // true\n * isValidVarName('class') // false (reserved word)\n * isValidVarName('42foo') // false (starts with digit)\n * ```\n */\nexport function isValidVarName(name: string): boolean {\n if (!name || reservedWords.has(name as 'valueOf')) {\n return false\n }\n return /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(name)\n}\n","import { camelCase } from './casing.ts'\nimport { isValidVarName } from './reserved.ts'\n\nexport type URLObject = {\n /**\n * The resolved URL string (Express-style or template literal, depending on context).\n */\n url: string\n /**\n * Extracted path parameters as a key-value map, or `undefined` when the path has none.\n */\n params?: Record<string, string>\n}\n\ntype ObjectOptions = {\n /**\n * Controls whether the `url` is rendered as an Express path or a template literal.\n * @default 'path'\n */\n type?: 'path' | 'template'\n /**\n * Optional transform applied to each extracted parameter name.\n */\n replacer?: (pathParam: string) => string\n /**\n * When `true`, the result is serialized to a string expression instead of a plain object.\n */\n stringify?: boolean\n}\n\n/**\n * Supported identifier casing strategies for path parameters.\n */\ntype PathCasing = 'camelcase'\n\ntype Options = {\n /**\n * Casing strategy applied to path parameter names.\n * @default undefined (original identifier preserved)\n */\n casing?: PathCasing\n}\n\n/**\n * Parses and transforms an OpenAPI/Swagger path string into various URL formats.\n *\n * @example\n * const p = new URLPath('/pet/{petId}')\n * p.URL // '/pet/:petId'\n * p.template // '`/pet/${petId}`'\n */\nexport class URLPath {\n /**\n * The raw OpenAPI/Swagger path string, e.g. `/pet/{petId}`.\n */\n path: string\n\n #options: Options\n\n constructor(path: string, options: Options = {}) {\n this.path = path\n this.#options = options\n }\n\n /** Converts the OpenAPI path to Express-style colon syntax, e.g. `/pet/{petId}` → `/pet/:petId`.\n *\n * @example\n * ```ts\n * new URLPath('/pet/{petId}').URL // '/pet/:petId'\n * ```\n */\n get URL(): string {\n return this.toURLPath()\n }\n\n /** Returns `true` when `path` is a fully-qualified URL (e.g. starts with `https://`).\n *\n * @example\n * ```ts\n * new URLPath('https://petstore.swagger.io/v2/pet').isURL // true\n * new URLPath('/pet/{petId}').isURL // false\n * ```\n */\n get isURL(): boolean {\n try {\n return !!new URL(this.path).href\n } catch {\n return false\n }\n }\n\n /**\n * Converts the OpenAPI path to a TypeScript template literal string.\n *\n * @example\n * new URLPath('/pet/{petId}').template // '`/pet/${petId}`'\n * new URLPath('/account/monetary-accountID').template // '`/account/${monetaryAccountId}`'\n */\n get template(): string {\n return this.toTemplateString()\n }\n\n /** Returns the path and its extracted params as a structured `URLObject`, or as a stringified expression when `stringify` is set.\n *\n * @example\n * ```ts\n * new URLPath('/pet/{petId}').object\n * // { url: '/pet/:petId', params: { petId: 'petId' } }\n * ```\n */\n get object(): URLObject | string {\n return this.toObject()\n }\n\n /** Returns a map of path parameter names, or `undefined` when the path has no parameters.\n *\n * @example\n * ```ts\n * new URLPath('/pet/{petId}').params // { petId: 'petId' }\n * new URLPath('/pet').params // undefined\n * ```\n */\n get params(): Record<string, string> | undefined {\n return this.toParamsObject()\n }\n\n #transformParam(raw: string): string {\n const param = isValidVarName(raw) ? raw : camelCase(raw)\n return this.#options.casing === 'camelcase' ? camelCase(param) : param\n }\n\n /**\n * Iterates over every `{param}` token in `path`, calling `fn` with the raw token and transformed name.\n */\n #eachParam(fn: (raw: string, param: string) => void): void {\n for (const match of this.path.matchAll(/\\{([^}]+)\\}/g)) {\n const raw = match[1]!\n fn(raw, this.#transformParam(raw))\n }\n }\n\n toObject({ type = 'path', replacer, stringify }: ObjectOptions = {}): URLObject | string {\n const object = {\n url: type === 'path' ? this.toURLPath() : this.toTemplateString({ replacer }),\n params: this.toParamsObject(),\n }\n\n if (stringify) {\n if (type === 'template') {\n return JSON.stringify(object).replaceAll(\"'\", '').replaceAll(`\"`, '')\n }\n\n if (object.params) {\n return `{ url: '${object.url}', params: ${JSON.stringify(object.params).replaceAll(\"'\", '').replaceAll(`\"`, '')} }`\n }\n\n return `{ url: '${object.url}' }`\n }\n\n return object\n }\n\n /**\n * Converts the OpenAPI path to a TypeScript template literal string.\n * An optional `replacer` can transform each extracted parameter name before interpolation.\n *\n * @example\n * new URLPath('/pet/{petId}').toTemplateString() // '`/pet/${petId}`'\n */\n toTemplateString({ prefix = '', replacer }: { prefix?: string; replacer?: (pathParam: string) => string } = {}): string {\n const parts = this.path.split(/\\{([^}]+)\\}/)\n const result = parts\n .map((part, i) => {\n if (i % 2 === 0) return part\n const param = this.#transformParam(part)\n return `\\${${replacer ? replacer(param) : param}}`\n })\n .join('')\n\n return `\\`${prefix}${result}\\``\n }\n\n /**\n * Extracts all `{param}` segments from the path and returns them as a key-value map.\n * An optional `replacer` transforms each parameter name in both key and value positions.\n * Returns `undefined` when no path parameters are found.\n *\n * @example\n * ```ts\n * new URLPath('/pet/{petId}/tag/{tagId}').toParamsObject()\n * // { petId: 'petId', tagId: 'tagId' }\n * ```\n */\n toParamsObject(replacer?: (pathParam: string) => string): Record<string, string> | undefined {\n const params: Record<string, string> = {}\n\n this.#eachParam((_raw, param) => {\n const key = replacer ? replacer(param) : param\n params[key] = key\n })\n\n return Object.keys(params).length > 0 ? params : undefined\n }\n\n /** Converts the OpenAPI path to Express-style colon syntax.\n *\n * @example\n * ```ts\n * new URLPath('/pet/{petId}').toURLPath() // '/pet/:petId'\n * ```\n */\n toURLPath(): string {\n return this.path.replace(/\\{([^}]+)\\}/g, ':$1')\n }\n}\n","import { URLPath } from '@internals/utils'\nimport { ast } from '@kubb/core'\n\nexport type ContentTypeInfo = {\n contentTypes: string[]\n isMultipleContentTypes: boolean\n contentTypeUnion: string\n defaultContentType: string\n hasFormData: boolean\n}\n\nexport type RequestConfigResolver = {\n resolveDataName(node: ast.OperationNode): string\n}\n\nexport type ResponseStatusNameResolver = {\n resolveResponseStatusName(node: ast.OperationNode, statusCode: ast.StatusCode): string\n}\n\nexport type ResponseNameResolver = ResponseStatusNameResolver & {\n resolveResponseName(node: ast.OperationNode): string\n}\n\nexport type OperationTypeNameResolver = RequestConfigResolver &\n ResponseNameResolver & {\n resolvePathParamsName(node: ast.OperationNode, param: ast.ParameterNode): string\n resolveQueryParamsName(node: ast.OperationNode, param: ast.ParameterNode): string\n resolveHeaderParamsName(node: ast.OperationNode, param: ast.ParameterNode): string\n }\n\nexport type OperationCommentLink = 'pathTemplate' | 'urlPath' | false | ((node: ast.OperationNode) => string | undefined)\n\nexport type BuildOperationCommentsOptions = {\n link?: OperationCommentLink\n linkPosition?: 'beforeDeprecated' | 'afterDeprecated'\n splitLines?: boolean\n}\n\ntype ResponseLike = {\n statusCode: ast.StatusCode | number | string\n}\n\nexport type OperationParameterGroups = Record<ast.ParameterNode['in'], Array<ast.ParameterNode>>\n\nexport type ResolveOperationTypeNameOptions = {\n paramsCasing?: 'camelcase'\n responseStatusNames?: boolean | 'error'\n exclude?: ReadonlyArray<string | undefined>\n order?: 'params-first' | 'body-response-first'\n}\n\nfunction getOperationLink(node: ast.OperationNode, link: OperationCommentLink): string | undefined {\n if (!link) {\n return undefined\n }\n\n if (typeof link === 'function') {\n return link(node)\n }\n\n if (link === 'urlPath') {\n return node.path ? `{@link ${new URLPath(node.path).URL}}` : undefined\n }\n\n return `{@link ${node.path.replaceAll('{', ':').replaceAll('}', '')}}`\n}\n\nexport function getContentTypeInfo(node: ast.OperationNode): ContentTypeInfo {\n const contentTypes = node.requestBody?.content?.map((e) => e.contentType) ?? []\n const isMultipleContentTypes = contentTypes.length > 1\n\n return {\n contentTypes,\n isMultipleContentTypes,\n contentTypeUnion: isMultipleContentTypes ? contentTypes.map((ct) => JSON.stringify(ct)).join(' | ') : '',\n defaultContentType: contentTypes[0] ?? 'application/json',\n hasFormData: contentTypes.some((ct) => ct === 'multipart/form-data'),\n }\n}\n\nexport function buildRequestConfigType(node: ast.OperationNode, resolver: RequestConfigResolver): string {\n const requestName = node.requestBody?.content?.[0]?.schema ? resolver.resolveDataName(node) : undefined\n const { isMultipleContentTypes, contentTypeUnion } = getContentTypeInfo(node)\n const configType = requestName ? `Partial<RequestConfig<${requestName}>>` : 'Partial<RequestConfig>'\n const configProps = ['client?: Client', isMultipleContentTypes ? `contentType?: ${contentTypeUnion}` : undefined].filter(Boolean).join('; ')\n\n return `${configType} & { ${configProps} }`\n}\n\nexport function buildOperationComments(node: ast.OperationNode, options: BuildOperationCommentsOptions = {}): Array<string> {\n const { link = 'pathTemplate', linkPosition = 'afterDeprecated', splitLines = false } = options\n const linkComment = getOperationLink(node, link)\n const comments =\n linkPosition === 'beforeDeprecated'\n ? [node.description && `@description ${node.description}`, node.summary && `@summary ${node.summary}`, linkComment, node.deprecated && '@deprecated']\n : [node.description && `@description ${node.description}`, node.summary && `@summary ${node.summary}`, node.deprecated && '@deprecated', linkComment]\n\n const filteredComments = comments.filter((comment): comment is string => Boolean(comment))\n\n if (!splitLines) {\n return filteredComments\n }\n\n return filteredComments.flatMap((text) => text.split(/\\r?\\n/).map((line) => line.trim())).filter((comment): comment is string => Boolean(comment))\n}\n\nexport function getOperationParameters(node: ast.OperationNode, options: { paramsCasing?: 'camelcase' } = {}): OperationParameterGroups {\n const params = ast.caseParams(node.parameters, options.paramsCasing)\n\n return {\n path: params.filter((param) => param.in === 'path'),\n query: params.filter((param) => param.in === 'query'),\n header: params.filter((param) => param.in === 'header'),\n cookie: params.filter((param) => param.in === 'cookie'),\n }\n}\n\nexport function getStatusCodeNumber(statusCode: ast.StatusCode | number | string): number | undefined {\n const code = Number(statusCode)\n\n return Number.isNaN(code) ? undefined : code\n}\n\nexport function isSuccessStatusCode(statusCode: ast.StatusCode | number | string): boolean {\n const code = getStatusCodeNumber(statusCode)\n\n return code !== undefined && code >= 200 && code < 300\n}\n\nexport function isErrorStatusCode(statusCode: ast.StatusCode | number | string): boolean {\n const code = getStatusCodeNumber(statusCode)\n\n return code !== undefined && code >= 400\n}\n\nexport function getSuccessResponses<TResponse extends ResponseLike>(responses: ReadonlyArray<TResponse>): Array<TResponse> {\n return responses.filter((response) => isSuccessStatusCode(response.statusCode))\n}\n\nexport function getOperationSuccessResponses(node: ast.OperationNode): Array<ast.ResponseNode> {\n return getSuccessResponses(node.responses)\n}\n\nexport function getPrimarySuccessResponse(node: ast.OperationNode): ast.ResponseNode | undefined {\n return getOperationSuccessResponses(node)[0]\n}\n\nexport function resolveErrorNames(node: ast.OperationNode, resolver: ResponseStatusNameResolver): string[] {\n return node.responses\n .filter((response) => isErrorStatusCode(response.statusCode))\n .map((response) => resolver.resolveResponseStatusName(node, response.statusCode))\n}\n\nexport function resolveStatusCodeNames(node: ast.OperationNode, resolver: ResponseStatusNameResolver): string[] {\n return node.responses.map((response) => resolver.resolveResponseStatusName(node, response.statusCode))\n}\n\nexport function resolveOperationTypeNames(\n node: ast.OperationNode,\n resolver: OperationTypeNameResolver,\n options: ResolveOperationTypeNameOptions = {},\n): string[] {\n const { path, query, header } = getOperationParameters(node, { paramsCasing: options.paramsCasing })\n const responseStatusNames =\n options.responseStatusNames === 'error'\n ? resolveErrorNames(node, resolver)\n : options.responseStatusNames === false\n ? []\n : resolveStatusCodeNames(node, resolver)\n const exclude = new Set(options.exclude ?? [])\n const paramNames = [\n ...path.map((param) => resolver.resolvePathParamsName(node, param)),\n ...query.map((param) => resolver.resolveQueryParamsName(node, param)),\n ...header.map((param) => resolver.resolveHeaderParamsName(node, param)),\n ]\n const bodyAndResponseNames = [node.requestBody?.content?.[0]?.schema ? resolver.resolveDataName(node) : undefined, resolver.resolveResponseName(node)]\n const names =\n options.order === 'body-response-first'\n ? [...bodyAndResponseNames, ...paramNames, ...responseStatusNames]\n : [...paramNames, ...bodyAndResponseNames, ...responseStatusNames]\n\n return names.filter((name): name is string => Boolean(name) && !exclude.has(name))\n}\n\nexport function resolveResponseTypes(node: ast.OperationNode, resolver: ResponseNameResolver): Array<[statusCode: number | 'default', typeName: string]> {\n const types: Array<[number | 'default', string]> = []\n\n for (const response of node.responses) {\n if (response.statusCode === 'default') {\n types.push(['default', resolver.resolveResponseName(node)])\n continue\n }\n\n const code = getStatusCodeNumber(response.statusCode)\n if (code === undefined) {\n continue\n }\n\n types.push([code, isSuccessStatusCode(code) ? resolver.resolveResponseName(node) : resolver.resolveResponseStatusName(node, response.statusCode)])\n }\n\n return types\n}\n\nexport function findSuccessStatusCode(responses: Array<{ statusCode: ast.StatusCode | number | string }>): ast.StatusCode | undefined {\n for (const response of responses) {\n if (isSuccessStatusCode(response.statusCode)) {\n return response.statusCode as ast.StatusCode\n }\n }\n\n return undefined\n}\n","import { getOperationParameters } from '@internals/shared'\nimport { camelCase, URLPath } from '@internals/utils'\nimport { ast } from '@kubb/core'\nimport type { ResolverTs } from '@kubb/plugin-ts'\nimport { functionPrinter } from '@kubb/plugin-ts'\nimport { File, Function } from '@kubb/renderer-jsx'\nimport type { KubbReactNode } from '@kubb/renderer-jsx/types'\nimport type { PluginCypress } from '../types.ts'\n\ntype Props = {\n /**\n * Name of the function\n */\n name: string\n /**\n * AST operation node\n */\n node: ast.OperationNode\n /**\n * TypeScript resolver for resolving param/data/response type names\n */\n resolver: ResolverTs\n baseURL: string | undefined\n dataReturnType: PluginCypress['resolvedOptions']['dataReturnType']\n paramsCasing: PluginCypress['resolvedOptions']['paramsCasing']\n paramsType: PluginCypress['resolvedOptions']['paramsType']\n pathParamsType: PluginCypress['resolvedOptions']['pathParamsType']\n}\n\nconst declarationPrinter = functionPrinter({ mode: 'declaration' })\n\nexport function Request({ baseURL = '', name, dataReturnType, resolver, node, paramsType, pathParamsType, paramsCasing }: Props): KubbReactNode {\n const paramsNode = ast.createOperationParams(node, {\n paramsType,\n pathParamsType,\n paramsCasing,\n resolver,\n extraParams: [\n ast.createFunctionParameter({\n name: 'options',\n type: ast.createParamsType({ variant: 'reference', name: 'Partial<Cypress.RequestOptions>' }),\n default: '{}',\n }),\n ],\n })\n const paramsSignature = declarationPrinter.print(paramsNode) ?? ''\n\n const responseType = resolver.resolveResponseName(node)\n const returnType = dataReturnType === 'data' ? `Cypress.Chainable<${responseType}>` : `Cypress.Chainable<Cypress.Response<${responseType}>>`\n\n const casedPathParams = getOperationParameters(node, { paramsCasing }).path\n // Build a lookup keyed by camelCase-normalized name so that path-template names\n // (e.g. `{pet_id}`) correctly resolve to the function-parameter name (`petId`)\n // even when the OpenAPI spec has inconsistent casing between the two.\n const pathParamNameMap = new Map(casedPathParams.map((p) => [camelCase(p.name), p.name]))\n\n const urlPath = new URLPath(node.path, { casing: paramsCasing })\n const urlTemplate = urlPath.toTemplateString({\n prefix: baseURL,\n replacer: (param) => pathParamNameMap.get(camelCase(param)) ?? param,\n })\n\n const requestOptions: string[] = [`method: '${node.method}'`, `url: ${urlTemplate}`]\n\n const queryParams = getOperationParameters(node).query\n if (queryParams.length > 0) {\n const casedQueryParams = getOperationParameters(node, { paramsCasing }).query\n // When paramsCasing renames query params (e.g. page_size → pageSize), we must remap\n // the camelCase keys back to the original API names before passing them to `qs`.\n const needsQsTransform = casedQueryParams.some((p, i) => p.name !== queryParams[i]!.name)\n if (needsQsTransform) {\n const pairs = queryParams.map((orig, i) => `${orig.name}: params.${casedQueryParams[i]!.name}`).join(', ')\n requestOptions.push(`qs: params ? { ${pairs} } : undefined`)\n } else {\n requestOptions.push('qs: params')\n }\n }\n\n const headerParams = getOperationParameters(node).header\n if (headerParams.length > 0) {\n const casedHeaderParams = getOperationParameters(node, { paramsCasing }).header\n // When paramsCasing renames header params (e.g. x-api-key → xApiKey), we must remap\n // the camelCase keys back to the original API names before passing them to `headers`.\n const needsHeaderTransform = casedHeaderParams.some((p, i) => p.name !== headerParams[i]!.name)\n if (needsHeaderTransform) {\n const pairs = headerParams.map((orig, i) => `'${orig.name}': headers.${casedHeaderParams[i]!.name}`).join(', ')\n requestOptions.push(`headers: headers ? { ${pairs} } : undefined`)\n } else {\n requestOptions.push('headers')\n }\n }\n\n if (node.requestBody?.content?.[0]?.schema) {\n requestOptions.push('body: data')\n }\n\n requestOptions.push('...options')\n\n return (\n <File.Source name={name} isIndexable isExportable>\n <Function name={name} export params={paramsSignature} returnType={returnType}>\n {dataReturnType === 'data'\n ? `return cy.request<${responseType}>({\n ${requestOptions.join(',\\n ')}\n}).then((res) => res.body)`\n : `return cy.request<${responseType}>({\n ${requestOptions.join(',\\n ')}\n})`}\n </Function>\n </File.Source>\n )\n}\n","import { resolveOperationTypeNames } from '@internals/shared'\nimport { defineGenerator } from '@kubb/core'\nimport { pluginTsName } from '@kubb/plugin-ts'\nimport { File, jsxRenderer } from '@kubb/renderer-jsx'\nimport { Request } from '../components/Request.tsx'\nimport type { PluginCypress } from '../types.ts'\n\nexport const cypressGenerator = defineGenerator<PluginCypress>({\n name: 'cypress',\n renderer: jsxRenderer,\n operation(node, ctx) {\n const { adapter, config, resolver, driver, root } = ctx\n const { output, baseURL, dataReturnType, paramsCasing, paramsType, pathParamsType, group } = ctx.options\n\n const pluginTs = driver.getPlugin(pluginTsName)\n\n if (!pluginTs) {\n return null\n }\n\n const tsResolver = driver.getResolver(pluginTsName)\n\n const importedTypeNames = resolveOperationTypeNames(node, tsResolver, { paramsCasing })\n\n const meta = {\n name: resolver.resolveName(node.operationId),\n file: resolver.resolveFile({ name: node.operationId, extname: '.ts', tag: node.tags[0] ?? 'default', path: node.path }, { root, output, group }),\n fileTs: tsResolver.resolveFile(\n { name: node.operationId, extname: '.ts', tag: node.tags[0] ?? 'default', path: node.path },\n {\n root,\n output: pluginTs.options?.output ?? output,\n group: pluginTs.options?.group,\n },\n ),\n } as const\n\n return (\n <File\n baseName={meta.file.baseName}\n path={meta.file.path}\n meta={meta.file.meta}\n banner={resolver.resolveBanner(adapter.inputNode, { output, config })}\n footer={resolver.resolveFooter(adapter.inputNode, { output, config })}\n >\n {meta.fileTs && importedTypeNames.length > 0 && <File.Import name={importedTypeNames} root={meta.file.path} path={meta.fileTs.path} isTypeOnly />}\n <Request\n name={meta.name}\n node={node}\n resolver={tsResolver}\n dataReturnType={dataReturnType}\n paramsCasing={paramsCasing}\n paramsType={paramsType}\n pathParamsType={pathParamsType}\n baseURL={baseURL}\n />\n </File>\n )\n },\n})\n","import { camelCase } from '@internals/utils'\nimport { defineResolver } from '@kubb/core'\nimport type { PluginCypress } from '../types.ts'\n\n/**\n * Naming convention resolver for Cypress plugin.\n *\n * Provides default naming helpers using camelCase for functions and file paths.\n *\n * @example\n * `resolverCypress.default('list pets', 'function') // → 'listPets'`\n */\nexport const resolverCypress = defineResolver<PluginCypress>(() => ({\n name: 'default',\n pluginName: 'plugin-cypress',\n default(name, type) {\n return camelCase(name, { isFile: type === 'file' })\n },\n resolveName(name) {\n return this.default(name, 'function')\n },\n resolvePathName(name, type) {\n return this.default(name, type)\n },\n}))\n","import { camelCase } from '@internals/utils'\nimport { definePlugin, type Group } from '@kubb/core'\nimport { pluginTsName } from '@kubb/plugin-ts'\nimport { cypressGenerator } from './generators/cypressGenerator.tsx'\nimport { resolverCypress } from './resolvers/resolverCypress.ts'\nimport type { PluginCypress } from './types.ts'\n\n/**\n * Canonical plugin name for `@kubb/plugin-cypress`, used to identify the plugin\n * in driver lookups and warnings.\n */\nexport const pluginCypressName = 'plugin-cypress' satisfies PluginCypress['name']\n\n/**\n * The `@kubb/plugin-cypress` plugin factory.\n *\n * Generates Cypress `cy.request()` test functions from an OpenAPI/AST `RootNode`.\n * Walks operations, delegates rendering to the active generators,\n * and writes barrel files based on `output.barrelType`.\n *\n * @example\n * ```ts\n * import pluginCypress from '@kubb/plugin-cypress'\n *\n * export default defineConfig({\n * plugins: [pluginCypress({ output: { path: 'cypress' } })],\n * })\n * ```\n */\nexport const pluginCypress = definePlugin<PluginCypress>((options) => {\n const {\n output = { path: 'cypress', barrelType: 'named' },\n group,\n exclude = [],\n include,\n override = [],\n dataReturnType = 'data',\n baseURL,\n paramsCasing,\n paramsType = 'inline',\n pathParamsType = paramsType === 'object' ? 'object' : options.pathParamsType || 'inline',\n resolver: userResolver,\n transformer: userTransformer,\n generators: userGenerators = [],\n } = options\n\n const groupConfig = group\n ? ({\n ...group,\n name: group.name\n ? group.name\n : (ctx: { group: string }) => {\n if (group.type === 'path') {\n return `${ctx.group.split('/')[1]}`\n }\n return `${camelCase(ctx.group)}Requests`\n },\n } satisfies Group)\n : undefined\n\n return {\n name: pluginCypressName,\n options,\n dependencies: [pluginTsName],\n hooks: {\n 'kubb:plugin:setup'(ctx) {\n const resolver = userResolver ? { ...resolverCypress, ...userResolver } : resolverCypress\n\n ctx.setOptions({\n output,\n exclude,\n include,\n override,\n dataReturnType,\n group: groupConfig,\n baseURL,\n paramsCasing,\n paramsType,\n pathParamsType,\n resolver,\n })\n ctx.setResolver(resolver)\n if (userTransformer) {\n ctx.setTransformer(userTransformer)\n }\n ctx.addGenerator(cypressGenerator)\n for (const gen of userGenerators) {\n ctx.addGenerator(gen)\n }\n },\n },\n }\n})\n\nexport default pluginCypress\n"],"mappings":";;;;;;;;;;;;;AAsBA,SAAS,gBAAgB,MAAc,QAAyB;CAS9D,OARmB,KAChB,MAAM,CACN,QAAQ,qBAAqB,QAAQ,CACrC,QAAQ,yBAAyB,QAAQ,CACzC,QAAQ,gBAAgB,QAEH,CAAC,MAAM,gBAAgB,CAAC,OAAO,QAE3C,CACT,KAAK,MAAM,MAAM;EAEhB,IADiB,KAAK,SAAS,KAAK,SAAS,KAAK,aAAa,EACjD,OAAO;EACrB,IAAI,MAAM,KAAK,CAAC,QAAQ,OAAO,KAAK,OAAO,EAAE,CAAC,aAAa,GAAG,KAAK,MAAM,EAAE;EAC3E,OAAO,KAAK,OAAO,EAAE,CAAC,aAAa,GAAG,KAAK,MAAM,EAAE;GACnD,CACD,KAAK,GAAG,CACR,QAAQ,iBAAiB,GAAG;;;;;;;;;;AAWjC,SAAS,iBAAiB,MAAc,eAAkE;CACxG,MAAM,QAAQ,KAAK,MAAM,iBAAiB;CAC1C,OAAO,MAAM,KAAK,MAAM,MAAM,cAAc,MAAM,MAAM,MAAM,SAAS,EAAE,CAAC,CAAC,KAAK,IAAI;;;;;;;;;;AAWtF,SAAgB,UAAU,MAAc,EAAE,QAAQ,SAAS,IAAI,SAAS,OAAgB,EAAE,EAAU;CAClG,IAAI,QACF,OAAO,iBAAiB,OAAO,MAAM,WAAW,UAAU,MAAM,SAAS;EAAE;EAAQ;EAAQ,GAAG,EAAE,CAAC,CAAC;CAGpG,OAAO,gBAAgB,GAAG,OAAO,GAAG,KAAK,GAAG,UAAU,MAAM;;;;;;;;AChE9D,MAAM,gBAAgB,IAAI,IAAI;CAC5B;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD,CAAU;;;;;;;;;;;AAYX,SAAgB,eAAe,MAAuB;CACpD,IAAI,CAAC,QAAQ,cAAc,IAAI,KAAkB,EAC/C,OAAO;CAET,OAAO,6BAA6B,KAAK,KAAK;;;;;;;;;;;;ACnDhD,IAAa,UAAb,MAAqB;;;;CAInB;CAEA;CAEA,YAAY,MAAc,UAAmB,EAAE,EAAE;EAC/C,KAAK,OAAO;EACZ,KAAKA,WAAW;;;;;;;;;CAUlB,IAAI,MAAc;EAChB,OAAO,KAAK,WAAW;;;;;;;;;;CAWzB,IAAI,QAAiB;EACnB,IAAI;GACF,OAAO,CAAC,CAAC,IAAI,IAAI,KAAK,KAAK,CAAC;UACtB;GACN,OAAO;;;;;;;;;;CAWX,IAAI,WAAmB;EACrB,OAAO,KAAK,kBAAkB;;;;;;;;;;CAWhC,IAAI,SAA6B;EAC/B,OAAO,KAAK,UAAU;;;;;;;;;;CAWxB,IAAI,SAA6C;EAC/C,OAAO,KAAK,gBAAgB;;CAG9B,gBAAgB,KAAqB;EACnC,MAAM,QAAQ,eAAe,IAAI,GAAG,MAAM,UAAU,IAAI;EACxD,OAAO,KAAKA,SAAS,WAAW,cAAc,UAAU,MAAM,GAAG;;;;;CAMnE,WAAW,IAAgD;EACzD,KAAK,MAAM,SAAS,KAAK,KAAK,SAAS,eAAe,EAAE;GACtD,MAAM,MAAM,MAAM;GAClB,GAAG,KAAK,KAAKC,gBAAgB,IAAI,CAAC;;;CAItC,SAAS,EAAE,OAAO,QAAQ,UAAU,cAA6B,EAAE,EAAsB;EACvF,MAAM,SAAS;GACb,KAAK,SAAS,SAAS,KAAK,WAAW,GAAG,KAAK,iBAAiB,EAAE,UAAU,CAAC;GAC7E,QAAQ,KAAK,gBAAgB;GAC9B;EAED,IAAI,WAAW;GACb,IAAI,SAAS,YACX,OAAO,KAAK,UAAU,OAAO,CAAC,WAAW,KAAK,GAAG,CAAC,WAAW,KAAK,GAAG;GAGvE,IAAI,OAAO,QACT,OAAO,WAAW,OAAO,IAAI,aAAa,KAAK,UAAU,OAAO,OAAO,CAAC,WAAW,KAAK,GAAG,CAAC,WAAW,KAAK,GAAG,CAAC;GAGlH,OAAO,WAAW,OAAO,IAAI;;EAG/B,OAAO;;;;;;;;;CAUT,iBAAiB,EAAE,SAAS,IAAI,aAA4E,EAAE,EAAU;EAUtH,OAAO,KAAK,SATE,KAAK,KAAK,MAAM,cACV,CACjB,KAAK,MAAM,MAAM;GAChB,IAAI,IAAI,MAAM,GAAG,OAAO;GACxB,MAAM,QAAQ,KAAKA,gBAAgB,KAAK;GACxC,OAAO,MAAM,WAAW,SAAS,MAAM,GAAG,MAAM;IAChD,CACD,KAAK,GAEmB,CAAC;;;;;;;;;;;;;CAc9B,eAAe,UAA8E;EAC3F,MAAM,SAAiC,EAAE;EAEzC,KAAKC,YAAY,MAAM,UAAU;GAC/B,MAAM,MAAM,WAAW,SAAS,MAAM,GAAG;GACzC,OAAO,OAAO;IACd;EAEF,OAAO,OAAO,KAAK,OAAO,CAAC,SAAS,IAAI,SAAS,KAAA;;;;;;;;;CAUnD,YAAoB;EAClB,OAAO,KAAK,KAAK,QAAQ,gBAAgB,MAAM;;;;;AC1GnD,SAAgB,uBAAuB,MAAyB,UAA0C,EAAE,EAA4B;CACtI,MAAM,SAAS,IAAI,WAAW,KAAK,YAAY,QAAQ,aAAa;CAEpE,OAAO;EACL,MAAM,OAAO,QAAQ,UAAU,MAAM,OAAO,OAAO;EACnD,OAAO,OAAO,QAAQ,UAAU,MAAM,OAAO,QAAQ;EACrD,QAAQ,OAAO,QAAQ,UAAU,MAAM,OAAO,SAAS;EACvD,QAAQ,OAAO,QAAQ,UAAU,MAAM,OAAO,SAAS;EACxD;;AAGH,SAAgB,oBAAoB,YAAkE;CACpG,MAAM,OAAO,OAAO,WAAW;CAE/B,OAAO,OAAO,MAAM,KAAK,GAAG,KAAA,IAAY;;AAS1C,SAAgB,kBAAkB,YAAuD;CACvF,MAAM,OAAO,oBAAoB,WAAW;CAE5C,OAAO,SAAS,KAAA,KAAa,QAAQ;;AAevC,SAAgB,kBAAkB,MAAyB,UAAgD;CACzG,OAAO,KAAK,UACT,QAAQ,aAAa,kBAAkB,SAAS,WAAW,CAAC,CAC5D,KAAK,aAAa,SAAS,0BAA0B,MAAM,SAAS,WAAW,CAAC;;AAGrF,SAAgB,uBAAuB,MAAyB,UAAgD;CAC9G,OAAO,KAAK,UAAU,KAAK,aAAa,SAAS,0BAA0B,MAAM,SAAS,WAAW,CAAC;;AAGxG,SAAgB,0BACd,MACA,UACA,UAA2C,EAAE,EACnC;CACV,MAAM,EAAE,MAAM,OAAO,WAAW,uBAAuB,MAAM,EAAE,cAAc,QAAQ,cAAc,CAAC;CACpG,MAAM,sBACJ,QAAQ,wBAAwB,UAC5B,kBAAkB,MAAM,SAAS,GACjC,QAAQ,wBAAwB,QAC9B,EAAE,GACF,uBAAuB,MAAM,SAAS;CAC9C,MAAM,UAAU,IAAI,IAAI,QAAQ,WAAW,EAAE,CAAC;CAC9C,MAAM,aAAa;EACjB,GAAG,KAAK,KAAK,UAAU,SAAS,sBAAsB,MAAM,MAAM,CAAC;EACnE,GAAG,MAAM,KAAK,UAAU,SAAS,uBAAuB,MAAM,MAAM,CAAC;EACrE,GAAG,OAAO,KAAK,UAAU,SAAS,wBAAwB,MAAM,MAAM,CAAC;EACxE;CACD,MAAM,uBAAuB,CAAC,KAAK,aAAa,UAAU,IAAI,SAAS,SAAS,gBAAgB,KAAK,GAAG,KAAA,GAAW,SAAS,oBAAoB,KAAK,CAAC;CAMtJ,QAJE,QAAQ,UAAU,wBACd;EAAC,GAAG;EAAsB,GAAG;EAAY,GAAG;EAAoB,GAChE;EAAC,GAAG;EAAY,GAAG;EAAsB,GAAG;EAAoB,EAEzD,QAAQ,SAAyB,QAAQ,KAAK,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC;;;;ACxJpF,MAAM,qBAAqB,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAEnE,SAAgB,QAAQ,EAAE,UAAU,IAAI,MAAM,gBAAgB,UAAU,MAAM,YAAY,gBAAgB,gBAAsC;CAC9I,MAAM,aAAa,IAAI,sBAAsB,MAAM;EACjD;EACA;EACA;EACA;EACA,aAAa,CACX,IAAI,wBAAwB;GAC1B,MAAM;GACN,MAAM,IAAI,iBAAiB;IAAE,SAAS;IAAa,MAAM;IAAmC,CAAC;GAC7F,SAAS;GACV,CAAC,CACH;EACF,CAAC;CACF,MAAM,kBAAkB,mBAAmB,MAAM,WAAW,IAAI;CAEhE,MAAM,eAAe,SAAS,oBAAoB,KAAK;CACvD,MAAM,aAAa,mBAAmB,SAAS,qBAAqB,aAAa,KAAK,sCAAsC,aAAa;CAEzI,MAAM,kBAAkB,uBAAuB,MAAM,EAAE,cAAc,CAAC,CAAC;CAIvE,MAAM,mBAAmB,IAAI,IAAI,gBAAgB,KAAK,MAAM,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;CAGzF,MAAM,cAAc,IADA,QAAQ,KAAK,MAAM,EAAE,QAAQ,cAAc,CACpC,CAAC,iBAAiB;EAC3C,QAAQ;EACR,WAAW,UAAU,iBAAiB,IAAI,UAAU,MAAM,CAAC,IAAI;EAChE,CAAC;CAEF,MAAM,iBAA2B,CAAC,YAAY,KAAK,OAAO,IAAI,QAAQ,cAAc;CAEpF,MAAM,cAAc,uBAAuB,KAAK,CAAC;CACjD,IAAI,YAAY,SAAS,GAAG;EAC1B,MAAM,mBAAmB,uBAAuB,MAAM,EAAE,cAAc,CAAC,CAAC;EAIxE,IADyB,iBAAiB,MAAM,GAAG,MAAM,EAAE,SAAS,YAAY,GAAI,KAChE,EAAE;GACpB,MAAM,QAAQ,YAAY,KAAK,MAAM,MAAM,GAAG,KAAK,KAAK,WAAW,iBAAiB,GAAI,OAAO,CAAC,KAAK,KAAK;GAC1G,eAAe,KAAK,kBAAkB,MAAM,gBAAgB;SAE5D,eAAe,KAAK,aAAa;;CAIrC,MAAM,eAAe,uBAAuB,KAAK,CAAC;CAClD,IAAI,aAAa,SAAS,GAAG;EAC3B,MAAM,oBAAoB,uBAAuB,MAAM,EAAE,cAAc,CAAC,CAAC;EAIzE,IAD6B,kBAAkB,MAAM,GAAG,MAAM,EAAE,SAAS,aAAa,GAAI,KAClE,EAAE;GACxB,MAAM,QAAQ,aAAa,KAAK,MAAM,MAAM,IAAI,KAAK,KAAK,aAAa,kBAAkB,GAAI,OAAO,CAAC,KAAK,KAAK;GAC/G,eAAe,KAAK,wBAAwB,MAAM,gBAAgB;SAElE,eAAe,KAAK,UAAU;;CAIlC,IAAI,KAAK,aAAa,UAAU,IAAI,QAClC,eAAe,KAAK,aAAa;CAGnC,eAAe,KAAK,aAAa;CAEjC,OACE,oBAAC,KAAK,QAAN;EAAmB;EAAM,aAAA;EAAY,cAAA;YACnC,oBAAC,UAAD;GAAgB;GAAM,QAAA;GAAO,QAAQ;GAA6B;aAC/D,mBAAmB,SAChB,qBAAqB,aAAa;IAC1C,eAAe,KAAK,QAAQ,CAAC;8BAErB,qBAAqB,aAAa;IAC1C,eAAe,KAAK,QAAQ,CAAC;;GAEhB,CAAA;EACC,CAAA;;;;ACtGlB,MAAa,mBAAmB,gBAA+B;CAC7D,MAAM;CACN,UAAU;CACV,UAAU,MAAM,KAAK;EACnB,MAAM,EAAE,SAAS,QAAQ,UAAU,QAAQ,SAAS;EACpD,MAAM,EAAE,QAAQ,SAAS,gBAAgB,cAAc,YAAY,gBAAgB,UAAU,IAAI;EAEjG,MAAM,WAAW,OAAO,UAAU,aAAa;EAE/C,IAAI,CAAC,UACH,OAAO;EAGT,MAAM,aAAa,OAAO,YAAY,aAAa;EAEnD,MAAM,oBAAoB,0BAA0B,MAAM,YAAY,EAAE,cAAc,CAAC;EAEvF,MAAM,OAAO;GACX,MAAM,SAAS,YAAY,KAAK,YAAY;GAC5C,MAAM,SAAS,YAAY;IAAE,MAAM,KAAK;IAAa,SAAS;IAAO,KAAK,KAAK,KAAK,MAAM;IAAW,MAAM,KAAK;IAAM,EAAE;IAAE;IAAM;IAAQ;IAAO,CAAC;GAChJ,QAAQ,WAAW,YACjB;IAAE,MAAM,KAAK;IAAa,SAAS;IAAO,KAAK,KAAK,KAAK,MAAM;IAAW,MAAM,KAAK;IAAM,EAC3F;IACE;IACA,QAAQ,SAAS,SAAS,UAAU;IACpC,OAAO,SAAS,SAAS;IAC1B,CACF;GACF;EAED,OACE,qBAAC,MAAD;GACE,UAAU,KAAK,KAAK;GACpB,MAAM,KAAK,KAAK;GAChB,MAAM,KAAK,KAAK;GAChB,QAAQ,SAAS,cAAc,QAAQ,WAAW;IAAE;IAAQ;IAAQ,CAAC;GACrE,QAAQ,SAAS,cAAc,QAAQ,WAAW;IAAE;IAAQ;IAAQ,CAAC;aALvE,CAOG,KAAK,UAAU,kBAAkB,SAAS,KAAK,oBAAC,KAAK,QAAN;IAAa,MAAM;IAAmB,MAAM,KAAK,KAAK;IAAM,MAAM,KAAK,OAAO;IAAM,YAAA;IAAa,CAAA,EACjJ,oBAAC,SAAD;IACE,MAAM,KAAK;IACL;IACN,UAAU;IACM;IACF;IACF;IACI;IACP;IACT,CAAA,CACG;;;CAGZ,CAAC;;;;;;;;;;;AC/CF,MAAa,kBAAkB,sBAAqC;CAClE,MAAM;CACN,YAAY;CACZ,QAAQ,MAAM,MAAM;EAClB,OAAO,UAAU,MAAM,EAAE,QAAQ,SAAS,QAAQ,CAAC;;CAErD,YAAY,MAAM;EAChB,OAAO,KAAK,QAAQ,MAAM,WAAW;;CAEvC,gBAAgB,MAAM,MAAM;EAC1B,OAAO,KAAK,QAAQ,MAAM,KAAK;;CAElC,EAAE;;;;;;;ACbH,MAAa,oBAAoB;;;;;;;;;;;;;;;;;AAkBjC,MAAa,gBAAgB,cAA6B,YAAY;CACpE,MAAM,EACJ,SAAS;EAAE,MAAM;EAAW,YAAY;EAAS,EACjD,OACA,UAAU,EAAE,EACZ,SACA,WAAW,EAAE,EACb,iBAAiB,QACjB,SACA,cACA,aAAa,UACb,iBAAiB,eAAe,WAAW,WAAW,QAAQ,kBAAkB,UAChF,UAAU,cACV,aAAa,iBACb,YAAY,iBAAiB,EAAE,KAC7B;CAEJ,MAAM,cAAc,QACf;EACC,GAAG;EACH,MAAM,MAAM,OACR,MAAM,QACL,QAA2B;GAC1B,IAAI,MAAM,SAAS,QACjB,OAAO,GAAG,IAAI,MAAM,MAAM,IAAI,CAAC;GAEjC,OAAO,GAAG,UAAU,IAAI,MAAM,CAAC;;EAEtC,GACD,KAAA;CAEJ,OAAO;EACL,MAAM;EACN;EACA,cAAc,CAAC,aAAa;EAC5B,OAAO,EACL,oBAAoB,KAAK;GACvB,MAAM,WAAW,eAAe;IAAE,GAAG;IAAiB,GAAG;IAAc,GAAG;GAE1E,IAAI,WAAW;IACb;IACA;IACA;IACA;IACA;IACA,OAAO;IACP;IACA;IACA;IACA;IACA;IACD,CAAC;GACF,IAAI,YAAY,SAAS;GACzB,IAAI,iBACF,IAAI,eAAe,gBAAgB;GAErC,IAAI,aAAa,iBAAiB;GAClC,KAAK,MAAM,OAAO,gBAChB,IAAI,aAAa,IAAI;KAG1B;EACF;EACD"}
|
package/extension.yaml
ADDED
|
@@ -0,0 +1,441 @@
|
|
|
1
|
+
$schema: https://kubb.dev/schemas/extension.json
|
|
2
|
+
kind: plugin
|
|
3
|
+
id: plugin-cypress
|
|
4
|
+
name: Cypress
|
|
5
|
+
description: Generate Cypress end-to-end tests from OpenAPI specifications.
|
|
6
|
+
category: testing
|
|
7
|
+
type: official
|
|
8
|
+
npmPackage: '@kubb/plugin-cypress'
|
|
9
|
+
docsPath: /plugins/plugin-cypress
|
|
10
|
+
repo: https://github.com/kubb-labs/plugins
|
|
11
|
+
maintainers:
|
|
12
|
+
- name: Stijn Van Hulle
|
|
13
|
+
github: stijnvanhulle
|
|
14
|
+
compatibility:
|
|
15
|
+
kubb: '>=5.0.0'
|
|
16
|
+
node: '>=22'
|
|
17
|
+
tags:
|
|
18
|
+
- cypress
|
|
19
|
+
- e2e-testing
|
|
20
|
+
- api-testing
|
|
21
|
+
- test-generation
|
|
22
|
+
- codegen
|
|
23
|
+
- openapi
|
|
24
|
+
dependencies:
|
|
25
|
+
- plugin-ts
|
|
26
|
+
resources:
|
|
27
|
+
documentation: https://kubb.dev/plugins/plugin-cypress
|
|
28
|
+
repository: https://github.com/kubb-labs/plugins
|
|
29
|
+
issues: https://github.com/kubb-labs/plugins/issues
|
|
30
|
+
changelog: https://github.com/kubb-labs/plugins/blob/main/packages/plugin-cypress/CHANGELOG.md
|
|
31
|
+
codesandbox: https://codesandbox.io/p/github/kubb-labs/plugins/main/examples/cypress
|
|
32
|
+
featured: false
|
|
33
|
+
icon:
|
|
34
|
+
light: https://kubb.dev/feature/cypress.svg
|
|
35
|
+
intro: |
|
|
36
|
+
# @kubb/plugin-cypress
|
|
37
|
+
|
|
38
|
+
Generate typed `cy.request()` wrappers from your OpenAPI schema. Each API operation becomes a reusable function you can call in Cypress tests, with full TypeScript support.
|
|
39
|
+
options:
|
|
40
|
+
- name: output
|
|
41
|
+
type: Output
|
|
42
|
+
required: false
|
|
43
|
+
default: "{ path: 'cypress', barrelType: 'named' }"
|
|
44
|
+
description: Specify the export location for the files and define the behavior of the output.
|
|
45
|
+
properties:
|
|
46
|
+
- name: path
|
|
47
|
+
type: string
|
|
48
|
+
required: true
|
|
49
|
+
description: Output directory or file for the generated code, relative to the global `output.path`.
|
|
50
|
+
tip: |
|
|
51
|
+
if `output.path` is a file, `group` cannot be used.
|
|
52
|
+
default: "'cypress'"
|
|
53
|
+
- name: barrelType
|
|
54
|
+
type: "'all' | 'named' | 'propagate' | false"
|
|
55
|
+
required: false
|
|
56
|
+
default: "'named'"
|
|
57
|
+
description: Specify what to export and optionally disable barrel-file generation.
|
|
58
|
+
tip: |
|
|
59
|
+
Using `propagate` will prevent a plugin from creating a barrel file, but it will still propagate, allowing [`output.barrelType`](https://kubb.dev/docs/5.x/configuration#output-barreltype) to export the specific function or type.
|
|
60
|
+
examples:
|
|
61
|
+
- name: all
|
|
62
|
+
files:
|
|
63
|
+
- lang: typescript
|
|
64
|
+
code: |
|
|
65
|
+
export * from './gen/petService.ts'
|
|
66
|
+
twoslash: false
|
|
67
|
+
- name: named
|
|
68
|
+
files:
|
|
69
|
+
- lang: typescript
|
|
70
|
+
code: |
|
|
71
|
+
export { PetService } from './gen/petService.ts'
|
|
72
|
+
twoslash: false
|
|
73
|
+
- name: propagate
|
|
74
|
+
files:
|
|
75
|
+
- lang: typescript
|
|
76
|
+
code: ''
|
|
77
|
+
twoslash: false
|
|
78
|
+
- name: 'false'
|
|
79
|
+
files:
|
|
80
|
+
- lang: typescript
|
|
81
|
+
code: ''
|
|
82
|
+
twoslash: false
|
|
83
|
+
- name: banner
|
|
84
|
+
type: 'string | ((node: RootNode) => string)'
|
|
85
|
+
required: false
|
|
86
|
+
description: Add a banner comment at the top of every generated file. Accepts a static string or a function that receives the `RootNode` and returns a string.
|
|
87
|
+
- name: footer
|
|
88
|
+
type: 'string | ((node: RootNode) => string)'
|
|
89
|
+
required: false
|
|
90
|
+
description: Add a footer comment at the end of every generated file. Accepts a static string or a function that receives the `RootNode` and returns a string.
|
|
91
|
+
- name: override
|
|
92
|
+
type: boolean
|
|
93
|
+
required: false
|
|
94
|
+
default: 'false'
|
|
95
|
+
description: Whether Kubb overrides existing external files that can be generated if they already exist.
|
|
96
|
+
- name: resolver
|
|
97
|
+
type: Partial<ResolverCypress> & ThisType<ResolverCypress>
|
|
98
|
+
required: false
|
|
99
|
+
description: |
|
|
100
|
+
A single resolver that overrides the naming and path-resolution conventions. Each method you provide replaces the corresponding built-in one. When a method returns `null` or `undefined`, the resolver's result is used as the fallback, so you only need to supply the methods you want to change.
|
|
101
|
+
|
|
102
|
+
`this` inside each method is bound to the **full** resolver, so you can call other resolver methods (e.g. `this.default(name, 'function')`) without losing context.
|
|
103
|
+
body: |
|
|
104
|
+
Each plugin ships a built-in resolver:
|
|
105
|
+
|
|
106
|
+
| Plugin | Default resolver |
|
|
107
|
+
| --- | --- |
|
|
108
|
+
| `@kubb/plugin-ts` | `resolverTs` |
|
|
109
|
+
| `@kubb/plugin-zod` | `resolverZod` |
|
|
110
|
+
| `@kubb/plugin-cypress` | `resolverCypress` |
|
|
111
|
+
| `@kubb/plugin-mcp` | `resolverMcp` |
|
|
112
|
+
codeBlock:
|
|
113
|
+
lang: typescript
|
|
114
|
+
title: Custom resolver (plugin-ts example)
|
|
115
|
+
code: |
|
|
116
|
+
import { pluginTs } from '@kubb/plugin-ts'
|
|
117
|
+
|
|
118
|
+
pluginTs({
|
|
119
|
+
resolver: {
|
|
120
|
+
resolveName(name) {
|
|
121
|
+
// Prefix every operation-derived name; falls back for names where
|
|
122
|
+
// this returns null/undefined.
|
|
123
|
+
return `Api${this.default(name, 'function')}`
|
|
124
|
+
},
|
|
125
|
+
},
|
|
126
|
+
})
|
|
127
|
+
tip: |
|
|
128
|
+
Use `resolver` for fine-grained control over naming conventions.
|
|
129
|
+
- name: paramsType
|
|
130
|
+
type: "'object' | 'inline'"
|
|
131
|
+
required: false
|
|
132
|
+
default: "'inline'"
|
|
133
|
+
description: Defines how parameters are passed to generated functions. Switch between object-style parameters and inline parameters.
|
|
134
|
+
tip: |
|
|
135
|
+
When `paramsType` is set to `'object'`, `pathParams` will also be set to `'object'`.
|
|
136
|
+
body: |
|
|
137
|
+
- `'object'` returns params and pathParams as an object.
|
|
138
|
+
- `'inline'` returns params as comma-separated params.
|
|
139
|
+
examples:
|
|
140
|
+
- name: object
|
|
141
|
+
files:
|
|
142
|
+
- lang: typescript
|
|
143
|
+
code: |
|
|
144
|
+
export async function deletePet(
|
|
145
|
+
{
|
|
146
|
+
petId,
|
|
147
|
+
headers,
|
|
148
|
+
}: {
|
|
149
|
+
petId: DeletePetPathParams['petId']
|
|
150
|
+
headers?: DeletePetHeaderParams
|
|
151
|
+
},
|
|
152
|
+
config: Partial<RequestConfig> = {},
|
|
153
|
+
) {
|
|
154
|
+
...
|
|
155
|
+
}
|
|
156
|
+
twoslash: false
|
|
157
|
+
- name: inline
|
|
158
|
+
files:
|
|
159
|
+
- lang: typescript
|
|
160
|
+
code: |
|
|
161
|
+
export async function deletePet(
|
|
162
|
+
petId: DeletePetPathParams['petId'],
|
|
163
|
+
headers?: DeletePetHeaderParams,
|
|
164
|
+
config: Partial<RequestConfig> = {}
|
|
165
|
+
){
|
|
166
|
+
...
|
|
167
|
+
}
|
|
168
|
+
twoslash: false
|
|
169
|
+
- name: paramsCasing
|
|
170
|
+
type: "'camelcase'"
|
|
171
|
+
required: false
|
|
172
|
+
description: Transform parameter names to a specific casing format for path, query, and header parameters in generated client code.
|
|
173
|
+
important: |
|
|
174
|
+
When using `paramsCasing`, ensure that `@kubb/plugin-ts` also has the same `paramsCasing` setting. This option automatically maps transformed parameter names back to their original API names in HTTP requests.
|
|
175
|
+
body: |
|
|
176
|
+
- `'camelcase'` transforms parameter names to camelCase.
|
|
177
|
+
examples:
|
|
178
|
+
- name: With paramsCasing camelcase
|
|
179
|
+
files:
|
|
180
|
+
- lang: typescript
|
|
181
|
+
code: |
|
|
182
|
+
// Function parameters use camelCase
|
|
183
|
+
export async function deletePet(
|
|
184
|
+
petId: DeletePetPathParams['petId'], // ✓ camelCase
|
|
185
|
+
headers?: DeletePetHeaderParams,
|
|
186
|
+
config: Partial<RequestConfig> = {}
|
|
187
|
+
) {
|
|
188
|
+
// Automatically maps back to original name for the API
|
|
189
|
+
const pet_id = petId
|
|
190
|
+
|
|
191
|
+
return fetch({
|
|
192
|
+
method: 'DELETE',
|
|
193
|
+
url: `/pet/${pet_id}`, // Uses original API parameter name
|
|
194
|
+
...
|
|
195
|
+
})
|
|
196
|
+
}
|
|
197
|
+
twoslash: false
|
|
198
|
+
- name: Without paramsCasing
|
|
199
|
+
files:
|
|
200
|
+
- lang: typescript
|
|
201
|
+
code: |
|
|
202
|
+
// Parameters use original API naming
|
|
203
|
+
export async function deletePet(
|
|
204
|
+
pet_id: DeletePetPathParams['pet_id'], // Original naming
|
|
205
|
+
headers?: DeletePetHeaderParams,
|
|
206
|
+
config: Partial<RequestConfig> = {}
|
|
207
|
+
) {
|
|
208
|
+
return fetch({
|
|
209
|
+
method: 'DELETE',
|
|
210
|
+
url: `/pet/${pet_id}`,
|
|
211
|
+
...
|
|
212
|
+
})
|
|
213
|
+
}
|
|
214
|
+
twoslash: false
|
|
215
|
+
tip: |
|
|
216
|
+
The client automatically generates mapping code to convert camelCase parameter names back to the original API format. You write code with developer-friendly camelCase names, but HTTP requests use the exact parameter names from your OpenAPI specification.
|
|
217
|
+
- name: pathParamsType
|
|
218
|
+
type: "'object' | 'inline'"
|
|
219
|
+
required: false
|
|
220
|
+
default: "'inline'"
|
|
221
|
+
description: Defines how pathParams are passed to generated functions.
|
|
222
|
+
body: |
|
|
223
|
+
- `'object'` returns pathParams as an object.
|
|
224
|
+
- `'inline'` returns pathParams as comma-separated params.
|
|
225
|
+
examples:
|
|
226
|
+
- name: object
|
|
227
|
+
files:
|
|
228
|
+
- lang: typescript
|
|
229
|
+
code: |
|
|
230
|
+
export async function getPetById(
|
|
231
|
+
{ petId }: GetPetByIdPathParams,
|
|
232
|
+
) {
|
|
233
|
+
...
|
|
234
|
+
}
|
|
235
|
+
twoslash: false
|
|
236
|
+
- name: inline
|
|
237
|
+
files:
|
|
238
|
+
- lang: typescript
|
|
239
|
+
code: |
|
|
240
|
+
export async function getPetById(
|
|
241
|
+
petId: GetPetByIdPathParams,
|
|
242
|
+
) {
|
|
243
|
+
...
|
|
244
|
+
}
|
|
245
|
+
twoslash: false
|
|
246
|
+
- name: dataReturnType
|
|
247
|
+
type: "'data' | 'full'"
|
|
248
|
+
required: false
|
|
249
|
+
default: "'data'"
|
|
250
|
+
description: |
|
|
251
|
+
Return type used when calling the client.
|
|
252
|
+
|
|
253
|
+
- `'data'` returns `ResponseConfig['data']`.
|
|
254
|
+
- `'full'` returns the full `ResponseConfig`.
|
|
255
|
+
examples:
|
|
256
|
+
- name: data
|
|
257
|
+
files:
|
|
258
|
+
- lang: typescript
|
|
259
|
+
code: |
|
|
260
|
+
export async function getPetById<TData>(
|
|
261
|
+
petId: GetPetByIdPathParams,
|
|
262
|
+
): Promise<ResponseConfig<TData>['data']> {
|
|
263
|
+
...
|
|
264
|
+
}
|
|
265
|
+
twoslash: false
|
|
266
|
+
- name: full
|
|
267
|
+
files:
|
|
268
|
+
- lang: typescript
|
|
269
|
+
code: |
|
|
270
|
+
export async function getPetById<TData>(
|
|
271
|
+
petId: GetPetByIdPathParams,
|
|
272
|
+
): Promise<ResponseConfig<TData>> {
|
|
273
|
+
...
|
|
274
|
+
}
|
|
275
|
+
twoslash: false
|
|
276
|
+
- name: baseURL
|
|
277
|
+
type: string
|
|
278
|
+
required: false
|
|
279
|
+
description: Sets a custom base URL for all generated calls. When not set, the base URL is automatically taken from the OAS spec via the adapter (e.g. the `servers[0].url` field).
|
|
280
|
+
- name: group
|
|
281
|
+
type: Group
|
|
282
|
+
required: false
|
|
283
|
+
description: |
|
|
284
|
+
Grouping combines files in a folder based on a specific `type`.
|
|
285
|
+
examples:
|
|
286
|
+
- name: kubb.config.ts
|
|
287
|
+
files:
|
|
288
|
+
- lang: typescript
|
|
289
|
+
code: |
|
|
290
|
+
group: {
|
|
291
|
+
type: 'tag',
|
|
292
|
+
name({ group }) {
|
|
293
|
+
return `${group}Controller`
|
|
294
|
+
}
|
|
295
|
+
}
|
|
296
|
+
twoslash: false
|
|
297
|
+
body: |
|
|
298
|
+
With the configuration above, the generator emits:
|
|
299
|
+
|
|
300
|
+
```text
|
|
301
|
+
.
|
|
302
|
+
├── src/
|
|
303
|
+
│ └── petController/
|
|
304
|
+
│ │ ├── addPet.ts
|
|
305
|
+
│ │ └── getPet.ts
|
|
306
|
+
│ └── storeController/
|
|
307
|
+
│ ├── createStore.ts
|
|
308
|
+
│ └── getStoreById.ts
|
|
309
|
+
├── petStore.yaml
|
|
310
|
+
├── kubb.config.ts
|
|
311
|
+
└── package.json
|
|
312
|
+
```
|
|
313
|
+
properties:
|
|
314
|
+
- name: type
|
|
315
|
+
type: "'tag'"
|
|
316
|
+
required: true
|
|
317
|
+
description: Specify the property to group files by. Required when `group` is defined.
|
|
318
|
+
note: |
|
|
319
|
+
`Required: true*` means this is required only when the `group` option is used. The `group` option itself is optional.
|
|
320
|
+
body: |
|
|
321
|
+
- `'tag'`: Uses the first tag from `operation.getTags().at(0)?.name`
|
|
322
|
+
- name: name
|
|
323
|
+
type: '(context: GroupContext) => string'
|
|
324
|
+
required: false
|
|
325
|
+
default: (ctx) => `${ctx.group}Requests`
|
|
326
|
+
description: Return the name of a group based on the group name. This is used for file and identifier generation.
|
|
327
|
+
- name: include
|
|
328
|
+
type: Array<Include>
|
|
329
|
+
required: false
|
|
330
|
+
description: Array containing include parameters to include tags, operations, methods, paths, or content types.
|
|
331
|
+
codeBlock:
|
|
332
|
+
lang: typescript
|
|
333
|
+
title: Include
|
|
334
|
+
code: |
|
|
335
|
+
export type Include = {
|
|
336
|
+
type: 'tag' | 'operationId' | 'path' | 'method' | 'contentType'
|
|
337
|
+
pattern: string | RegExp
|
|
338
|
+
}
|
|
339
|
+
- name: exclude
|
|
340
|
+
type: Array<Exclude>
|
|
341
|
+
required: false
|
|
342
|
+
description: Array containing exclude parameters to exclude or skip tags, operations, methods, paths, or content types.
|
|
343
|
+
codeBlock:
|
|
344
|
+
lang: typescript
|
|
345
|
+
title: Exclude
|
|
346
|
+
code: |
|
|
347
|
+
export type Exclude = {
|
|
348
|
+
type: 'tag' | 'operationId' | 'path' | 'method' | 'contentType'
|
|
349
|
+
pattern: string | RegExp
|
|
350
|
+
}
|
|
351
|
+
- name: override
|
|
352
|
+
type: Array<Override>
|
|
353
|
+
required: false
|
|
354
|
+
description: Array containing override parameters to override `options` based on tags, operations, methods, paths, or content types.
|
|
355
|
+
codeBlock:
|
|
356
|
+
lang: typescript
|
|
357
|
+
title: Override
|
|
358
|
+
code: |
|
|
359
|
+
export type Override = {
|
|
360
|
+
type: 'tag' | 'operationId' | 'path' | 'method' | 'contentType'
|
|
361
|
+
pattern: string | RegExp
|
|
362
|
+
options: PluginOptions
|
|
363
|
+
}
|
|
364
|
+
- name: generators
|
|
365
|
+
type: Array<Generator<PluginCypress>>
|
|
366
|
+
required: false
|
|
367
|
+
experimental: true
|
|
368
|
+
description: |
|
|
369
|
+
Define additional generators next to the built-in generators.
|
|
370
|
+
|
|
371
|
+
See [Generators](https://kubb.dev/docs/5.x/guides/creating-plugins) for more information on how to use generators.
|
|
372
|
+
- name: transformer
|
|
373
|
+
type: Visitor
|
|
374
|
+
required: false
|
|
375
|
+
description: |
|
|
376
|
+
A single AST visitor applied to every node before code is printed. Each method you provide replaces the corresponding built-in one. When a method returns `null` or `undefined`, the preset transformer's result is used as the fallback — so you only need to supply the methods you want to change.
|
|
377
|
+
|
|
378
|
+
Visitor methods receive the node and a context object. Return a modified node to replace it, or return `undefined`/`void` to leave it unchanged.
|
|
379
|
+
examples:
|
|
380
|
+
- name: Strip descriptions before printing
|
|
381
|
+
files:
|
|
382
|
+
- lang: typescript
|
|
383
|
+
code: |
|
|
384
|
+
import { pluginTs } from '@kubb/plugin-ts'
|
|
385
|
+
|
|
386
|
+
pluginTs({
|
|
387
|
+
transformer: {
|
|
388
|
+
schema(node) {
|
|
389
|
+
return { ...node, description: undefined }
|
|
390
|
+
},
|
|
391
|
+
},
|
|
392
|
+
})
|
|
393
|
+
twoslash: false
|
|
394
|
+
- name: Prefix every operationId
|
|
395
|
+
files:
|
|
396
|
+
- lang: typescript
|
|
397
|
+
code: |
|
|
398
|
+
import { pluginTs } from '@kubb/plugin-ts'
|
|
399
|
+
|
|
400
|
+
pluginTs({
|
|
401
|
+
transformer: {
|
|
402
|
+
operation(node) {
|
|
403
|
+
return { ...node, operationId: `api_${node.operationId}` }
|
|
404
|
+
},
|
|
405
|
+
},
|
|
406
|
+
})
|
|
407
|
+
twoslash: false
|
|
408
|
+
tip: |
|
|
409
|
+
Use `transformer` to rewrite node properties before printing. For output naming customization, use `resolver` instead.
|
|
410
|
+
examples:
|
|
411
|
+
- name: kubb.config.ts
|
|
412
|
+
files:
|
|
413
|
+
- lang: typescript
|
|
414
|
+
code: |
|
|
415
|
+
import { defineConfig } from 'kubb'
|
|
416
|
+
import { pluginTs } from '@kubb/plugin-ts'
|
|
417
|
+
import { pluginCypress } from '@kubb/plugin-cypress'
|
|
418
|
+
|
|
419
|
+
export default defineConfig({
|
|
420
|
+
input: {
|
|
421
|
+
path: './petStore.yaml',
|
|
422
|
+
},
|
|
423
|
+
output: {
|
|
424
|
+
path: './src/gen',
|
|
425
|
+
},
|
|
426
|
+
plugins: [
|
|
427
|
+
pluginTs(),
|
|
428
|
+
pluginCypress({
|
|
429
|
+
output: {
|
|
430
|
+
path: './cypress',
|
|
431
|
+
barrelType: 'named',
|
|
432
|
+
banner: '/* eslint-disable no-alert, no-console */',
|
|
433
|
+
},
|
|
434
|
+
group: {
|
|
435
|
+
type: 'tag',
|
|
436
|
+
name: ({ group }) => `${group}Requests`,
|
|
437
|
+
},
|
|
438
|
+
}),
|
|
439
|
+
],
|
|
440
|
+
})
|
|
441
|
+
twoslash: false
|