@kubb/plugin-cypress 5.0.0-alpha.9 → 5.0.0-beta.10

package/dist/index.cjs

@@ -1,81 +1,569 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_components = require("./components-Drg_gLu2.cjs");
-const require_generators = require("./generators-C73nd-xB.cjs");
-let node_path = require("node:path");
-node_path = require_components.__toESM(node_path);
+Object.defineProperties(exports, {
+	__esModule: { value: true },
+	[Symbol.toStringTag]: { value: "Module" }
+});
+//#endregion
 let _kubb_core = require("@kubb/core");
-let _kubb_plugin_oas = require("@kubb/plugin-oas");
 let _kubb_plugin_ts = require("@kubb/plugin-ts");
+let _kubb_renderer_jsx = require("@kubb/renderer-jsx");
+let _kubb_renderer_jsx_jsx_runtime = require("@kubb/renderer-jsx/jsx-runtime");
+//#region ../../internals/utils/src/casing.ts
+/**
+* Shared implementation for camelCase and PascalCase conversion.
+* Splits on common word boundaries (spaces, hyphens, underscores, dots, slashes, colons)
+* and capitalizes each word according to `pascal`.
+*
+* When `pascal` is `true` the first word is also capitalized (PascalCase), otherwise only subsequent words are.
+*/
+function toCamelOrPascal(text, pascal) {
+	return text.trim().replace(/([a-z\d])([A-Z])/g, "$1 $2").replace(/([A-Z]+)([A-Z][a-z])/g, "$1 $2").replace(/(\d)([a-z])/g, "$1 $2").split(/[\s\-_./\\:]+/).filter(Boolean).map((word, i) => {
+		if (word.length > 1 && word === word.toUpperCase()) return word;
+		if (i === 0 && !pascal) return word.charAt(0).toLowerCase() + word.slice(1);
+		return word.charAt(0).toUpperCase() + word.slice(1);
+	}).join("").replace(/[^a-zA-Z0-9]/g, "");
+}
+/**
+* Splits `text` on `.` and applies `transformPart` to each segment.
+* The last segment receives `isLast = true`, all earlier segments receive `false`.
+* Segments are joined with `/` to form a file path.
+*
+* Only splits on dots followed by a letter so that version numbers
+* embedded in operationIds (e.g. `v2025.0`) are kept intact.
+*/
+function applyToFileParts(text, transformPart) {
+	const parts = text.split(/\.(?=[a-zA-Z])/);
+	return parts.map((part, i) => transformPart(part, i === parts.length - 1)).join("/");
+}
+/**
+* Converts `text` to camelCase.
+* When `isFile` is `true`, dot-separated segments are each cased independently and joined with `/`.
+*
+* @example
+* camelCase('hello-world')                   // 'helloWorld'
+* camelCase('pet.petId', { isFile: true })   // 'pet/petId'
+*/
+function camelCase(text, { isFile, prefix = "", suffix = "" } = {}) {
+	if (isFile) return applyToFileParts(text, (part, isLast) => camelCase(part, isLast ? {
+		prefix,
+		suffix
+	} : {}));
+	return toCamelOrPascal(`${prefix} ${text} ${suffix}`, false);
+}
+//#endregion
+//#region ../../internals/utils/src/reserved.ts
+/**
+* JavaScript and Java reserved words.
+* @link https://github.com/jonschlinkert/reserved/blob/master/index.js
+*/
+const reservedWords = new Set([
+	"abstract",
+	"arguments",
+	"boolean",
+	"break",
+	"byte",
+	"case",
+	"catch",
+	"char",
+	"class",
+	"const",
+	"continue",
+	"debugger",
+	"default",
+	"delete",
+	"do",
+	"double",
+	"else",
+	"enum",
+	"eval",
+	"export",
+	"extends",
+	"false",
+	"final",
+	"finally",
+	"float",
+	"for",
+	"function",
+	"goto",
+	"if",
+	"implements",
+	"import",
+	"in",
+	"instanceof",
+	"int",
+	"interface",
+	"let",
+	"long",
+	"native",
+	"new",
+	"null",
+	"package",
+	"private",
+	"protected",
+	"public",
+	"return",
+	"short",
+	"static",
+	"super",
+	"switch",
+	"synchronized",
+	"this",
+	"throw",
+	"throws",
+	"transient",
+	"true",
+	"try",
+	"typeof",
+	"var",
+	"void",
+	"volatile",
+	"while",
+	"with",
+	"yield",
+	"Array",
+	"Date",
+	"hasOwnProperty",
+	"Infinity",
+	"isFinite",
+	"isNaN",
+	"isPrototypeOf",
+	"length",
+	"Math",
+	"name",
+	"NaN",
+	"Number",
+	"Object",
+	"prototype",
+	"String",
+	"toString",
+	"undefined",
+	"valueOf"
+]);
+/**
+* Returns `true` when `name` is a syntactically valid JavaScript variable name.
+*
+* @example
+* ```ts
+* isValidVarName('status')  // true
+* isValidVarName('class')   // false (reserved word)
+* isValidVarName('42foo')   // false (starts with digit)
+* ```
+*/
+function isValidVarName(name) {
+	if (!name || reservedWords.has(name)) return false;
+	return /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(name);
+}
+//#endregion
+//#region ../../internals/utils/src/urlPath.ts
+/**
+* Parses and transforms an OpenAPI/Swagger path string into various URL formats.
+*
+* @example
+* const p = new URLPath('/pet/{petId}')
+* p.URL      // '/pet/:petId'
+* p.template // '`/pet/${petId}`'
+*/
+var URLPath = class {
+	/**
+	* The raw OpenAPI/Swagger path string, e.g. `/pet/{petId}`.
+	*/
+	path;
+	#options;
+	constructor(path, options = {}) {
+		this.path = path;
+		this.#options = options;
+	}
+	/** Converts the OpenAPI path to Express-style colon syntax, e.g. `/pet/{petId}` → `/pet/:petId`.
+	*
+	* @example
+	* ```ts
+	* new URLPath('/pet/{petId}').URL // '/pet/:petId'
+	* ```
+	*/
+	get URL() {
+		return this.toURLPath();
+	}
+	/** Returns `true` when `path` is a fully-qualified URL (e.g. starts with `https://`).
+	*
+	* @example
+	* ```ts
+	* new URLPath('https://petstore.swagger.io/v2/pet').isURL // true
+	* new URLPath('/pet/{petId}').isURL                       // false
+	* ```
+	*/
+	get isURL() {
+		try {
+			return !!new URL(this.path).href;
+		} catch {
+			return false;
+		}
+	}
+	/**
+	* Converts the OpenAPI path to a TypeScript template literal string.
+	*
+	* @example
+	* new URLPath('/pet/{petId}').template              // '`/pet/${petId}`'
+	* new URLPath('/account/monetary-accountID').template // '`/account/${monetaryAccountId}`'
+	*/
+	get template() {
+		return this.toTemplateString();
+	}
+	/** Returns the path and its extracted params as a structured `URLObject`, or as a stringified expression when `stringify` is set.
+	*
+	* @example
+	* ```ts
+	* new URLPath('/pet/{petId}').object
+	* // { url: '/pet/:petId', params: { petId: 'petId' } }
+	* ```
+	*/
+	get object() {
+		return this.toObject();
+	}
+	/** Returns a map of path parameter names, or `undefined` when the path has no parameters.
+	*
+	* @example
+	* ```ts
+	* new URLPath('/pet/{petId}').params // { petId: 'petId' }
+	* new URLPath('/pet').params         // undefined
+	* ```
+	*/
+	get params() {
+		return this.toParamsObject();
+	}
+	#transformParam(raw) {
+		const param = isValidVarName(raw) ? raw : camelCase(raw);
+		return this.#options.casing === "camelcase" ? camelCase(param) : param;
+	}
+	/**
+	* Iterates over every `{param}` token in `path`, calling `fn` with the raw token and transformed name.
+	*/
+	#eachParam(fn) {
+		for (const match of this.path.matchAll(/\{([^}]+)\}/g)) {
+			const raw = match[1];
+			fn(raw, this.#transformParam(raw));
+		}
+	}
+	toObject({ type = "path", replacer, stringify } = {}) {
+		const object = {
+			url: type === "path" ? this.toURLPath() : this.toTemplateString({ replacer }),
+			params: this.toParamsObject()
+		};
+		if (stringify) {
+			if (type === "template") return JSON.stringify(object).replaceAll("'", "").replaceAll(`"`, "");
+			if (object.params) return `{ url: '${object.url}', params: ${JSON.stringify(object.params).replaceAll("'", "").replaceAll(`"`, "")} }`;
+			return `{ url: '${object.url}' }`;
+		}
+		return object;
+	}
+	/**
+	* Converts the OpenAPI path to a TypeScript template literal string.
+	* An optional `replacer` can transform each extracted parameter name before interpolation.
+	*
+	* @example
+	* new URLPath('/pet/{petId}').toTemplateString() // '`/pet/${petId}`'
+	*/
+	toTemplateString({ prefix = "", replacer } = {}) {
+		return `\`${prefix}${this.path.split(/\{([^}]+)\}/).map((part, i) => {
+			if (i % 2 === 0) return part;
+			const param = this.#transformParam(part);
+			return `\${${replacer ? replacer(param) : param}}`;
+		}).join("")}\``;
+	}
+	/**
+	* Extracts all `{param}` segments from the path and returns them as a key-value map.
+	* An optional `replacer` transforms each parameter name in both key and value positions.
+	* Returns `undefined` when no path parameters are found.
+	*
+	* @example
+	* ```ts
+	* new URLPath('/pet/{petId}/tag/{tagId}').toParamsObject()
+	* // { petId: 'petId', tagId: 'tagId' }
+	* ```
+	*/
+	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;
+	}
+	/** Converts the OpenAPI path to Express-style colon syntax.
+	*
+	* @example
+	* ```ts
+	* new URLPath('/pet/{petId}').toURLPath() // '/pet/:petId'
+	* ```
+	*/
+	toURLPath() {
+		return this.path.replace(/\{([^}]+)\}/g, ":$1");
+	}
+};
+//#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) ? void 0 : code;
+}
+function isErrorStatusCode(statusCode) {
+	const code = getStatusCodeNumber(statusCode);
+	return code !== void 0 && 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));
+}
+function resolveOperationTypeNames(node, resolver, options = {}) {
+	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) : void 0, resolver.resolveResponseName(node)];
+	return (options.order === "body-response-first" ? [
+		...bodyAndResponseNames,
+		...paramNames,
+		...responseStatusNames
+	] : [
+		...paramNames,
+		...bodyAndResponseNames,
+		...responseStatusNames
+	]).filter((name) => Boolean(name) && !exclude.has(name));
+}
+//#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 }) {
+	const paramsNode = _kubb_core.ast.createOperationParams(node, {
+		paramsType,
+		pathParamsType,
+		paramsCasing,
+		resolver,
+		extraParams: [_kubb_core.ast.createFunctionParameter({
+			name: "options",
+			type: _kubb_core.ast.createParamsType({
+				variant: "reference",
+				name: "Partial<Cypress.RequestOptions>"
+			}),
+			default: "{}"
+		})]
+	});
+	const paramsSignature = declarationPrinter.print(paramsNode) ?? "";
+	const responseType = resolver.resolveResponseName(node);
+	const returnType = dataReturnType === "data" ? `Cypress.Chainable<${responseType}>` : `Cypress.Chainable<Cypress.Response<${responseType}>>`;
+	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 = getOperationParameters(node).query;
+	if (queryParams.length > 0) {
+		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 = getOperationParameters(node).header;
+	if (headerParams.length > 0) {
+		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`);
+		} else requestOptions.push("headers");
+	}
+	if (node.requestBody?.content?.[0]?.schema) requestOptions.push("body: data");
+	requestOptions.push("...options");
+	return /* @__PURE__ */ (0, _kubb_renderer_jsx_jsx_runtime.jsx)(_kubb_renderer_jsx.File.Source, {
+		name,
+		isIndexable: true,
+		isExportable: true,
+		children: /* @__PURE__ */ (0, _kubb_renderer_jsx_jsx_runtime.jsx)(_kubb_renderer_jsx.Function, {
+			name,
+			export: true,
+			params: paramsSignature,
+			returnType,
+			children: dataReturnType === "data" ? `return cy.request<${responseType}>({
+  ${requestOptions.join(",\n  ")}
+}).then((res) => res.body)` : `return cy.request<${responseType}>({
+  ${requestOptions.join(",\n  ")}
+})`
+		})
+	});
+}
+//#endregion
+//#region src/generators/cypressGenerator.tsx
+const cypressGenerator = (0, _kubb_core.defineGenerator)({
+	name: "cypress",
+	renderer: _kubb_renderer_jsx.jsxRenderer,
+	operation(node, ctx) {
+		const { adapter, 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 importedTypeNames = resolveOperationTypeNames(node, tsResolver, { paramsCasing });
+		const meta = {
+			name: resolver.resolveName(node.operationId),
+			file: resolver.resolveFile({
+				name: node.operationId,
+				extname: ".ts",
+				tag: node.tags[0] ?? "default",
+				path: node.path
+			}, {
+				root,
+				output,
+				group
+			}),
+			fileTs: tsResolver.resolveFile({
+				name: node.operationId,
+				extname: ".ts",
+				tag: node.tags[0] ?? "default",
+				path: node.path
+			}, {
+				root,
+				output: pluginTs.options?.output ?? output,
+				group: pluginTs.options?.group
+			})
+		};
+		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, {
+				output,
+				config
+			}),
+			footer: resolver.resolveFooter(adapter.inputNode, {
+				output,
+				config
+			}),
+			children: [meta.fileTs && importedTypeNames.length > 0 && /* @__PURE__ */ (0, _kubb_renderer_jsx_jsx_runtime.jsx)(_kubb_renderer_jsx.File.Import, {
+				name: importedTypeNames,
+				root: meta.file.path,
+				path: meta.fileTs.path,
+				isTypeOnly: true
+			}), /* @__PURE__ */ (0, _kubb_renderer_jsx_jsx_runtime.jsx)(Request, {
+				name: meta.name,
+				node,
+				resolver: tsResolver,
+				dataReturnType,
+				paramsCasing,
+				paramsType,
+				pathParamsType,
+				baseURL
+			})]
+		});
+	}
+});
+//#endregion
+//#region src/resolvers/resolverCypress.ts
+/**
+* Naming convention resolver for Cypress plugin.
+*
+* Provides default naming helpers using camelCase for functions and file paths.
+*
+* @example
+* `resolverCypress.default('list pets', 'function')  // → 'listPets'`
+*/
+const resolverCypress = (0, _kubb_core.defineResolver)(() => ({
+	name: "default",
+	pluginName: "plugin-cypress",
+	default(name, type) {
+		return camelCase(name, { isFile: type === "file" });
+	},
+	resolveName(name) {
+		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.
+*/
 const pluginCypressName = "plugin-cypress";
-const pluginCypress = (0, _kubb_core.createPlugin)((options) => {
+/**
+* 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`.
+*
+* @example
+* ```ts
+* import pluginCypress from '@kubb/plugin-cypress'
+*
+* export default defineConfig({
+*   plugins: [pluginCypress({ output: { path: 'cypress' } })],
+* })
+* ```
+*/
+const pluginCypress = (0, _kubb_core.definePlugin)((options) => {
 	const { output = {
 		path: "cypress",
 		barrelType: "named"
-	}, group, dataReturnType = "data", exclude = [], include, override = [], transformers = {}, generators = [require_generators.cypressGenerator].filter(Boolean), contentType, baseURL, paramsCasing, paramsType = "inline", pathParamsType = paramsType === "object" ? "object" : options.pathParamsType || "inline" } = options;
+	}, 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;
 	return {
 		name: pluginCypressName,
-		options: {
-			output,
-			dataReturnType,
-			group,
-			baseURL,
-			paramsCasing,
-			paramsType,
-			pathParamsType
-		},
-		pre: [_kubb_plugin_oas.pluginOasName, _kubb_plugin_ts.pluginTsName].filter(Boolean),
-		resolvePath(baseName, pathMode, options) {
-			const root = node_path.default.resolve(this.config.root, this.config.output.path);
-			if ((pathMode ?? (0, _kubb_core.getMode)(node_path.default.resolve(root, output.path))) === "single")
- /**
-			* when output is a file then we will always append to the same file(output file), see fileManager.addOrAppend
-			* Other plugins then need to call addOrAppend instead of just add from the fileManager class
-			*/
-			return node_path.default.resolve(root, output.path);
-			if (group && (options?.group?.path || options?.group?.tag)) {
-				const groupName = group?.name ? group.name : (ctx) => {
-					if (group?.type === "path") return `${ctx.group.split("/")[1]}`;
-					return `${require_components.camelCase(ctx.group)}Requests`;
-				};
-				return node_path.default.resolve(root, output.path, groupName({ group: group.type === "path" ? options.group.path : options.group.tag }), baseName);
-			}
-			return node_path.default.resolve(root, output.path, baseName);
-		},
-		resolveName(name, type) {
-			const resolvedName = require_components.camelCase(name, { isFile: type === "file" });
-			if (type) return transformers?.name?.(resolvedName, type) || resolvedName;
-			return resolvedName;
-		},
-		async install() {
-			const root = node_path.default.resolve(this.config.root, this.config.output.path);
-			const mode = (0, _kubb_core.getMode)(node_path.default.resolve(root, output.path));
-			const oas = await this.getOas();
-			const files = await new _kubb_plugin_oas.OperationGenerator(this.plugin.options, {
-				fabric: this.fabric,
-				oas,
-				driver: this.driver,
-				events: this.events,
-				plugin: this.plugin,
-				contentType,
+		options,
+		dependencies: [_kubb_plugin_ts.pluginTsName],
+		hooks: { "kubb:plugin:setup"(ctx) {
+			const resolver = userResolver ? {
+				...resolverCypress,
+				...userResolver
+			} : resolverCypress;
+			ctx.setOptions({
+				output,
 				exclude,
 				include,
 				override,
-				mode
-			}).build(...generators);
-			await this.upsertFile(...files);
-			const barrelFiles = await (0, _kubb_core.getBarrelFiles)(this.fabric.files, {
-				type: output.barrelType ?? "named",
-				root,
-				output,
-				meta: { pluginName: this.plugin.name }
+				dataReturnType,
+				group: groupConfig,
+				baseURL,
+				paramsCasing,
+				paramsType,
+				pathParamsType,
+				resolver
 			});
-			await this.upsertFile(...barrelFiles);
-		}
+			ctx.setResolver(resolver);
+			if (userTransformer) ctx.setTransformer(userTransformer);
+			ctx.addGenerator(cypressGenerator);
+			for (const gen of userGenerators) ctx.addGenerator(gen);
+		} }
 	};
 });
 //#endregion
+exports.Request = Request;
+exports.cypressGenerator = cypressGenerator;
+exports.default = pluginCypress;
 exports.pluginCypress = pluginCypress;
 exports.pluginCypressName = pluginCypressName;
+exports.resolverCypress = resolverCypress;
 
 //# sourceMappingURL=index.cjs.map