@kubb/plugin-cypress 5.0.0-beta.4 → 5.0.0-beta.42

package/README.md

@@ -1,19 +1,16 @@
 <div align="center">
-  <h1>Plugin Cypress</h1>
   <a href="https://kubb.dev" target="_blank" rel="noopener noreferrer">
-    <img width="180" src="https://raw.githubusercontent.com/kubb-labs/kubb/main/assets/logo.png" alt="Kubb logo">
+    <img src="https://kubb.dev/og.png" alt="Kubb banner">
   </a>
 
 [![npm version][npm-version-src]][npm-version-href]
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
-[![Coverage][coverage-src]][coverage-href]
+[![Stars][stars-src]][stars-href]
 [![License][license-src]][license-href]
-[![Sponsors][sponsors-src]][sponsors-href]
+[![Node][node-src]][node-href]
 
 <h4>
-<a href="https://codesandbox.io/s/github/kubb-labs/kubb/tree/main//examples/typescript" target="_blank">View Demo</a>
-<span> · </span>
-<a href="https://kubb.dev/" target="_blank">Documentation</a>
+<a href="https://kubb.dev/plugins/cypress" target="_blank">Documentation</a>
 <span> · </span>
 <a href="https://github.com/kubb-labs/kubb/issues/" target="_blank">Report Bug</a>
 <span> · </span>
@@ -21,11 +18,31 @@
 </h4>
 </div>
 
-Swagger integration to create Cypress requests commands.
+<br />
+
+# @kubb/plugin-cypress
+
+### Generate Cypress commands from OpenAPI
+
+`@kubb/plugin-cypress` generates Cypress request commands from your OpenAPI specification. Each operation in the spec becomes a typed Cypress command, ready to use in your test files.
+
+## Installation
+
+```bash
+bun add @kubb/plugin-cypress
+# or
+pnpm add @kubb/plugin-cypress
+# or
+npm install @kubb/plugin-cypress
+```
+
+## Documentation
+
+See the [full documentation](https://kubb.dev/plugins/cypress) for configuration options and examples.
 
 ## Supporting Kubb
 
-Kubb uses an MIT-licensed open source project with its ongoing development made possible entirely by the support of Sponsors. If you would like to become a sponsor, please consider:
+Kubb is an open source project, and its development is funded entirely by sponsors. If you would like to become a sponsor, please consider:
 
 - [Become a Sponsor on GitHub](https://github.com/sponsors/stijnvanhulle)
 
@@ -35,19 +52,19 @@ Kubb uses an MIT-licensed open source project with its ongoing development made
   </a>
 </p>
 
+## License
+
+[MIT](https://github.com/kubb-labs/plugins/blob/main/LICENSE)
+
 <!-- Badges -->
 
-[npm-version-src]: https://img.shields.io/npm/v/@kubb/plugin-cypress?flat&colorA=18181B&colorB=f58517
-[npm-version-href]: https://npmjs.com/package/@kubb/plugin-cypress
-[npm-downloads-src]: https://img.shields.io/npm/dm/@kubb/plugin-cypress?flat&colorA=18181B&colorB=f58517
-[npm-downloads-href]: https://npmjs.com/package/@kubb/plugin-cypress
-[license-src]: https://img.shields.io/github/license/kubb-labs/kubb.svg?flat&colorA=18181B&colorB=f58517
+[npm-version-src]: https://shieldcn.dev/npm/v/@kubb/plugin-cypress.svg?variant=secondary&size=xs&theme=zinc&mode=dark
+[npm-version-href]: https://npmx.dev/package/@kubb/plugin-cypress
+[npm-downloads-src]: https://shieldcn.dev/npm/dm/@kubb/plugin-cypress.svg?variant=secondary&size=xs&theme=zinc&mode=dark
+[npm-downloads-href]: https://npmx.dev/package/@kubb/plugin-cypress
+[stars-src]: https://shieldcn.dev/github/stars/kubb-labs/kubb.svg?variant=secondary&size=xs&theme=zinc&mode=dark
+[stars-href]: https://github.com/kubb-labs/kubb
+[license-src]: https://shieldcn.dev/npm/license/@kubb/plugin-cypress.svg?variant=secondary&size=xs&theme=zinc
 [license-href]: https://github.com/kubb-labs/kubb/blob/main/LICENSE
-[build-src]: https://img.shields.io/github/actions/workflow/status/kubb-labs/kubb/ci.yaml?style=flat&colorA=18181B&colorB=f58517
-[build-href]: https://www.npmjs.com/package/@kubb/plugin-cypress
-[minified-src]: https://img.shields.io/bundlephobia/min/@kubb/plugin-cypress?style=flat&colorA=18181B&colorB=f58517
-[minified-href]: https://www.npmjs.com/package/@kubb/plugin-cypress
-[coverage-src]: https://img.shields.io/codecov/c/github/kubb-labs/kubb?style=flat&colorA=18181B&colorB=f58517
-[coverage-href]: https://www.npmjs.com/package/@kubb/plugin-cypress
-[sponsors-src]: https://img.shields.io/github/sponsors/stijnvanhulle?style=flat&colorA=18181B&colorB=f58517
-[sponsors-href]: https://github.com/sponsors/stijnvanhulle/
+[node-src]: https://shieldcn.dev/npm/node/@kubb/plugin-cypress.svg?variant=secondary&size=xs&theme=zinc&mode=dark
+[node-href]: https://npmx.dev/package/@kubb/plugin-cypress

package/dist/index.cjs

@@ -218,16 +218,16 @@ var URLPath = class {
 	get object() {
 		return this.toObject();
 	}
-	/** Returns a map of path parameter names, or `undefined` when the path has no parameters.
+	/** Returns a map of path parameter names, or `null` when the path has no parameters.
 	*
 	* @example
 	* ```ts
 	* new URLPath('/pet/{petId}').params // { petId: 'petId' }
-	* new URLPath('/pet').params         // undefined
+	* new URLPath('/pet').params         // null
 	* ```
 	*/
 	get params() {
-		return this.getParams();
+		return this.toParamsObject();
 	}
 	#transformParam(raw) {
 		const param = isValidVarName(raw) ? raw : camelCase(raw);
@@ -245,7 +245,7 @@ var URLPath = class {
 	toObject({ type = "path", replacer, stringify } = {}) {
 		const object = {
 			url: type === "path" ? this.toURLPath() : this.toTemplateString({ replacer }),
-			params: this.getParams()
+			params: this.toParamsObject()
 		};
 		if (stringify) {
 			if (type === "template") return JSON.stringify(object).replaceAll("'", "").replaceAll(`"`, "");
@@ -261,12 +261,13 @@ var URLPath = class {
 	* @example
 	* new URLPath('/pet/{petId}').toTemplateString() // '`/pet/${petId}`'
 	*/
-	toTemplateString({ prefix = "", replacer } = {}) {
-		return `\`${prefix}${this.path.split(/\{([^}]+)\}/).map((part, i) => {
+	toTemplateString({ prefix, replacer } = {}) {
+		const result = this.path.split(/\{([^}]+)\}/).map((part, i) => {
 			if (i % 2 === 0) return part;
 			const param = this.#transformParam(part);
 			return `\${${replacer ? replacer(param) : param}}`;
-		}).join("")}\``;
+		}).join("");
+		return `\`${prefix ?? ""}${result}\``;
 	}
 	/**
 	* Extracts all `{param}` segments from the path and returns them as a key-value map.
@@ -275,17 +276,17 @@ var URLPath = class {
 	*
 	* @example
 	* ```ts
-	* new URLPath('/pet/{petId}/tag/{tagId}').getParams()
+	* new URLPath('/pet/{petId}/tag/{tagId}').toParamsObject()
 	* // { petId: 'petId', tagId: 'tagId' }
 	* ```
 	*/
-	getParams(replacer) {
+	toParamsObject(replacer) {
 		const params = {};
 		this.#eachParam((_raw, param) => {
 			const key = replacer ? replacer(param) : param;
 			params[key] = key;
 		});
-		return Object.keys(params).length > 0 ? params : void 0;
+		return Object.keys(params).length > 0 ? params : null;
 	}
 	/** Converts the OpenAPI path to Express-style colon syntax.
 	*
@@ -299,9 +300,100 @@ var URLPath = class {
 	}
 };
 //#endregion
+//#region ../../internals/shared/src/operation.ts
+function getOperationParameters(node, options = {}) {
+	const params = _kubb_core.ast.caseParams(node.parameters, options.paramsCasing);
+	return {
+		path: params.filter((param) => param.in === "path"),
+		query: params.filter((param) => param.in === "query"),
+		header: params.filter((param) => param.in === "header"),
+		cookie: params.filter((param) => param.in === "cookie")
+	};
+}
+function getStatusCodeNumber(statusCode) {
+	const code = Number(statusCode);
+	return Number.isNaN(code) ? null : code;
+}
+function isErrorStatusCode(statusCode) {
+	const code = getStatusCodeNumber(statusCode);
+	return code !== null && code >= 400;
+}
+function resolveErrorNames(node, resolver) {
+	return node.responses.filter((response) => isErrorStatusCode(response.statusCode)).map((response) => resolver.resolveResponseStatusName(node, response.statusCode));
+}
+function resolveStatusCodeNames(node, resolver) {
+	return node.responses.map((response) => resolver.resolveResponseStatusName(node, response.statusCode));
+}
+const typeNamesByResolver = /* @__PURE__ */ new WeakMap();
+function resolveOperationTypeNames(node, resolver, options = {}) {
+	const cacheKey = `${node.operationId}\0${options.paramsCasing ?? ""}\0${options.order ?? ""}\0${options.responseStatusNames ?? ""}\0${(options.exclude ?? []).join(",")}`;
+	let byResolver = typeNamesByResolver.get(resolver);
+	if (byResolver) {
+		const cached = byResolver.get(cacheKey);
+		if (cached) return cached;
+	} else {
+		byResolver = /* @__PURE__ */ new Map();
+		typeNamesByResolver.set(resolver, byResolver);
+	}
+	const { path, query, header } = getOperationParameters(node, { paramsCasing: options.paramsCasing });
+	const responseStatusNames = options.responseStatusNames === "error" ? resolveErrorNames(node, resolver) : options.responseStatusNames === false ? [] : resolveStatusCodeNames(node, resolver);
+	const exclude = new Set(options.exclude ?? []);
+	const paramNames = [
+		...path.map((param) => resolver.resolvePathParamsName(node, param)),
+		...query.map((param) => resolver.resolveQueryParamsName(node, param)),
+		...header.map((param) => resolver.resolveHeaderParamsName(node, param))
+	];
+	const bodyAndResponseNames = [node.requestBody?.content?.[0]?.schema ? resolver.resolveDataName(node) : null, resolver.resolveResponseName(node)];
+	const result = (options.order === "body-response-first" ? [
+		...bodyAndResponseNames,
+		...paramNames,
+		...responseStatusNames
+	] : [
+		...paramNames,
+		...bodyAndResponseNames,
+		...responseStatusNames
+	]).filter((name) => Boolean(name) && !exclude.has(name));
+	byResolver.set(cacheKey, result);
+	return result;
+}
+//#endregion
+//#region ../../internals/shared/src/group.ts
+/**
+* Builds the `group` config a Kubb plugin passes to `ctx.setOptions`, applying the
+* shared default naming so every plugin groups output consistently:
+*
+* - `path` groups use the second path segment (`/pet/findByStatus` → `pet`).
+* - other groups use `${camelCase(group)}${suffix}` (e.g. `petController`).
+*
+* A user-provided `group.name` always wins over the default namer, so callers stay in
+* control of their output folders. Returns `null` when grouping is disabled, matching the
+* per-plugin convention.
+*
+* @param group - The user-supplied group option, or `undefined` to disable grouping.
+* @param options.suffix - Appended to non-`path` group names, e.g. `'Controller'` or `'Requests'`.
+*
+* @example
+* ```ts
+* createGroupConfig(group, { suffix: 'Controller' }) // plugin-ts, plugin-client, …
+* createGroupConfig(group, { suffix: 'Requests' })   // plugin-cypress, plugin-mcp
+* ```
+*/
+function createGroupConfig(group, options) {
+	if (!group) return null;
+	const defaultName = (ctx) => {
+		if (group.type === "path") return `${ctx.group.split("/")[1]}`;
+		return `${camelCase(ctx.group)}${options.suffix}`;
+	};
+	return {
+		...group,
+		name: group.name ? group.name : defaultName
+	};
+}
+//#endregion
 //#region src/components/Request.tsx
 const declarationPrinter = (0, _kubb_plugin_ts.functionPrinter)({ mode: "declaration" });
 function Request({ baseURL = "", name, dataReturnType, resolver, node, paramsType, pathParamsType, paramsCasing }) {
+	if (!_kubb_core.ast.isHttpOperationNode(node)) return null;
 	const paramsNode = _kubb_core.ast.createOperationParams(node, {
 		paramsType,
 		pathParamsType,
@@ -319,24 +411,24 @@ function Request({ baseURL = "", name, dataReturnType, resolver, node, paramsTyp
 	const paramsSignature = declarationPrinter.print(paramsNode) ?? "";
 	const responseType = resolver.resolveResponseName(node);
 	const returnType = dataReturnType === "data" ? `Cypress.Chainable<${responseType}>` : `Cypress.Chainable<Cypress.Response<${responseType}>>`;
-	const casedPathParams = _kubb_core.ast.caseParams(node.parameters.filter((p) => p.in === "path"), paramsCasing);
+	const casedPathParams = getOperationParameters(node, { paramsCasing }).path;
 	const pathParamNameMap = new Map(casedPathParams.map((p) => [camelCase(p.name), p.name]));
 	const urlTemplate = new URLPath(node.path, { casing: paramsCasing }).toTemplateString({
 		prefix: baseURL,
 		replacer: (param) => pathParamNameMap.get(camelCase(param)) ?? param
 	});
 	const requestOptions = [`method: '${node.method}'`, `url: ${urlTemplate}`];
-	const queryParams = node.parameters.filter((p) => p.in === "query");
+	const queryParams = getOperationParameters(node).query;
 	if (queryParams.length > 0) {
-		const casedQueryParams = _kubb_core.ast.caseParams(queryParams, paramsCasing);
+		const casedQueryParams = getOperationParameters(node, { paramsCasing }).query;
 		if (casedQueryParams.some((p, i) => p.name !== queryParams[i].name)) {
 			const pairs = queryParams.map((orig, i) => `${orig.name}: params.${casedQueryParams[i].name}`).join(", ");
 			requestOptions.push(`qs: params ? { ${pairs} } : undefined`);
 		} else requestOptions.push("qs: params");
 	}
-	const headerParams = node.parameters.filter((p) => p.in === "header");
+	const headerParams = getOperationParameters(node).header;
 	if (headerParams.length > 0) {
-		const casedHeaderParams = _kubb_core.ast.caseParams(headerParams, paramsCasing);
+		const casedHeaderParams = getOperationParameters(node, { paramsCasing }).header;
 		if (casedHeaderParams.some((p, i) => p.name !== headerParams[i].name)) {
 			const pairs = headerParams.map((orig, i) => `'${orig.name}': headers.${casedHeaderParams[i].name}`).join(", ");
 			requestOptions.push(`headers: headers ? { ${pairs} } : undefined`);
@@ -363,26 +455,22 @@ function Request({ baseURL = "", name, dataReturnType, resolver, node, paramsTyp
 }
 //#endregion
 //#region src/generators/cypressGenerator.tsx
+/**
+* Built-in generator for `@kubb/plugin-cypress`. Emits one typed
+* `cy.request()` wrapper per OpenAPI operation, ready to call inside Cypress
+* test specs and custom commands.
+*/
 const cypressGenerator = (0, _kubb_core.defineGenerator)({
 	name: "cypress",
-	renderer: _kubb_renderer_jsx.jsxRenderer,
+	renderer: _kubb_renderer_jsx.jsxRendererSync,
 	operation(node, ctx) {
-		const { adapter, config, resolver, driver, root } = ctx;
+		if (!_kubb_core.ast.isHttpOperationNode(node)) return null;
+		const { config, resolver, driver, root } = ctx;
 		const { output, baseURL, dataReturnType, paramsCasing, paramsType, pathParamsType, group } = ctx.options;
 		const pluginTs = driver.getPlugin(_kubb_plugin_ts.pluginTsName);
 		if (!pluginTs) return null;
 		const tsResolver = driver.getResolver(_kubb_plugin_ts.pluginTsName);
-		const casedParams = _kubb_core.ast.caseParams(node.parameters, paramsCasing);
-		const pathParams = casedParams.filter((p) => p.in === "path");
-		const queryParams = casedParams.filter((p) => p.in === "query");
-		const headerParams = casedParams.filter((p) => p.in === "header");
-		const importedTypeNames = [
-			...pathParams.map((p) => tsResolver.resolvePathParamsName(node, p)),
-			...queryParams.map((p) => tsResolver.resolveQueryParamsName(node, p)),
-			...headerParams.map((p) => tsResolver.resolveHeaderParamsName(node, p)),
-			node.requestBody?.content?.[0]?.schema ? tsResolver.resolveDataName(node) : void 0,
-			tsResolver.resolveResponseName(node)
-		].filter(Boolean);
+		const importedTypeNames = resolveOperationTypeNames(node, tsResolver, { paramsCasing });
 		const meta = {
 			name: resolver.resolveName(node.operationId),
 			file: resolver.resolveFile({
@@ -393,7 +481,7 @@ const cypressGenerator = (0, _kubb_core.defineGenerator)({
 			}, {
 				root,
 				output,
-				group
+				group: group ?? void 0
 			}),
 			fileTs: tsResolver.resolveFile({
 				name: node.operationId,
@@ -403,23 +491,31 @@ const cypressGenerator = (0, _kubb_core.defineGenerator)({
 			}, {
 				root,
 				output: pluginTs.options?.output ?? output,
-				group: pluginTs.options?.group
+				group: pluginTs.options?.group ?? void 0
 			})
 		};
 		return /* @__PURE__ */ (0, _kubb_renderer_jsx_jsx_runtime.jsxs)(_kubb_renderer_jsx.File, {
 			baseName: meta.file.baseName,
 			path: meta.file.path,
 			meta: meta.file.meta,
-			banner: resolver.resolveBanner(adapter.inputNode, {
+			banner: resolver.resolveBanner(ctx.meta, {
 				output,
-				config
+				config,
+				file: {
+					path: meta.file.path,
+					baseName: meta.file.baseName
+				}
 			}),
-			footer: resolver.resolveFooter(adapter.inputNode, {
+			footer: resolver.resolveFooter(ctx.meta, {
 				output,
-				config
+				config,
+				file: {
+					path: meta.file.path,
+					baseName: meta.file.baseName
+				}
 			}),
 			children: [meta.fileTs && importedTypeNames.length > 0 && /* @__PURE__ */ (0, _kubb_renderer_jsx_jsx_runtime.jsx)(_kubb_renderer_jsx.File.Import, {
-				name: Array.from(new Set(importedTypeNames)),
+				name: importedTypeNames,
 				root: meta.file.path,
 				path: meta.fileTs.path,
 				isTypeOnly: true
@@ -439,43 +535,57 @@ const cypressGenerator = (0, _kubb_core.defineGenerator)({
 //#endregion
 //#region src/resolvers/resolverCypress.ts
 /**
-* Naming convention resolver for Cypress plugin.
+* Default resolver used by `@kubb/plugin-cypress`. Decides the names and file
+* paths for every generated `cy.request()` wrapper. Functions and files use
+* camelCase, matching the convention from `@kubb/plugin-client`.
 *
-* Provides default naming helpers using camelCase for functions and file paths.
+* @example Resolve a helper name
+* ```ts
+* import { resolverCypress } from '@kubb/plugin-cypress'
 *
-* @example
-* `resolverCypress.default('list pets', 'function')  // → 'listPets'`
+* resolverCypress.default('list pets', 'function') // 'listPets'
+* ```
 */
-const resolverCypress = (0, _kubb_core.defineResolver)((ctx) => ({
+const resolverCypress = (0, _kubb_core.defineResolver)(() => ({
 	name: "default",
 	pluginName: "plugin-cypress",
 	default(name, type) {
 		return camelCase(name, { isFile: type === "file" });
 	},
 	resolveName(name) {
-		return ctx.default(name, "function");
+		return this.default(name, "function");
+	},
+	resolvePathName(name, type) {
+		return this.default(name, type);
 	}
 }));
 //#endregion
 //#region src/plugin.ts
 /**
-* Canonical plugin name for `@kubb/plugin-cypress`, used to identify the plugin
-* in driver lookups and warnings.
+* Canonical plugin name for `@kubb/plugin-cypress`. Used for driver lookups and
+* cross-plugin dependency references.
 */
 const pluginCypressName = "plugin-cypress";
 /**
-* The `@kubb/plugin-cypress` plugin factory.
-*
-* Generates Cypress `cy.request()` test functions from an OpenAPI/AST `RootNode`.
-* Walks operations, delegates rendering to the active generators,
-* and writes barrel files based on `output.barrelType`.
+* Generates one typed `cy.request()` wrapper per OpenAPI operation. Each helper
+* has typed path params, body, query, and a typed response, so failing API
+* calls in Cypress show up at compile time instead of inside the test runner.
 *
 * @example
 * ```ts
-* import pluginCypress from '@kubb/plugin-cypress'
+* import { defineConfig } from 'kubb'
+* import { pluginTs } from '@kubb/plugin-ts'
+* import { pluginCypress } from '@kubb/plugin-cypress'
 *
 * export default defineConfig({
-*   plugins: [pluginCypress({ output: { path: 'cypress' } })],
+*   input: { path: './petStore.yaml' },
+*   output: { path: './src/gen' },
+*   plugins: [
+*     pluginTs(),
+*     pluginCypress({
+*       output: { path: './cypress' },
+*     }),
+*   ],
 * })
 * ```
 */
@@ -484,13 +594,7 @@ const pluginCypress = (0, _kubb_core.definePlugin)((options) => {
 		path: "cypress",
 		barrelType: "named"
 	}, group, exclude = [], include, override = [], dataReturnType = "data", baseURL, paramsCasing, paramsType = "inline", pathParamsType = paramsType === "object" ? "object" : options.pathParamsType || "inline", resolver: userResolver, transformer: userTransformer, generators: userGenerators = [] } = options;
-	const groupConfig = group ? {
-		...group,
-		name: group.name ? group.name : (ctx) => {
-			if (group.type === "path") return `${ctx.group.split("/")[1]}`;
-			return `${camelCase(ctx.group)}Requests`;
-		}
-	} : void 0;
+	const groupConfig = createGroupConfig(group, { suffix: "Requests" });
 	return {
 		name: pluginCypressName,
 		options,