@kubb/plugin-cypress 5.0.9 → 5.0.11

package/dist/index.cjs

@@ -392,7 +392,7 @@ var compatibility = {
 };
 //#endregion
 //#region package.json
-var version = "5.0.9";
+var version = "5.0.11";
 //#endregion
 //#region src/resolvers/resolverCypress.ts
 /**

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { t as __name } from "./rolldown-runtime-C0LytTxp.js";
-import { Exclude, Group, Include, Output, OutputOptions, Override, PluginFactoryOptions, Resolver, ResolverPatch, ast } from "kubb/kit";
+import { Exclude, Group, Include, Output, OutputOptions, Override, PluginType, Resolver, ResolverPatch, ast } from "kubb/kit";
 import { KubbReactNode } from "kubb/jsx";
 import { ResolverTs } from "@kubb/plugin-ts";
 //#region src/components/Request.d.ts
@@ -67,7 +67,7 @@ type ResolvedOptions = {
   baseURL: Options['baseURL'] | undefined;
   resolver: ResolverCypress;
 };
-type PluginCypress = PluginFactoryOptions<'plugin-cypress', Options, ResolvedOptions, ResolverCypress>;
+type PluginCypress = PluginType<'plugin-cypress', Options, ResolvedOptions, ResolverCypress>;
 declare global {
   namespace Kubb {
     interface PluginRegistry {

package/dist/index.js

@@ -388,7 +388,7 @@ var compatibility = {
 };
 //#endregion
 //#region package.json
-var version = "5.0.9";
+var version = "5.0.11";
 //#endregion
 //#region src/resolvers/resolverCypress.ts
 /**

package/docs/overview.md

@@ -1,20 +1,25 @@
 # Cypress
 
-Generates a typed `cy.request()` helper for each operation in your OpenAPI spec. Your Cypress tests call the API through these helpers, so a call with the wrong parameters fails at compile time instead of at run time.
+The Cypress plugin generates a typed `cy.request()` helper for each operation in your OpenAPI spec.
 
 Each helper takes grouped `path`, `query`, `headers`, and `body` parameters named after the spec. It returns the response body typed as `Cypress.Chainable<{Operation}Response>`.
 
 ## Setup
 
 - Add `@kubb/plugin-ts` for the request and response types.
-- The generated helpers need Cypress v13 or higher.
+- Install `cypress` v15 or v16 in the project that runs the tests.
+- Add `"types": ["cypress"]` to the tsconfig that covers the generated files, because the helpers use the global `Cypress` namespace.
 
 ## Options worth knowing
 
-- `baseURL` is prepended to every request.
+- `baseURL` is prepended to every request. Without it, Cypress resolves the path against its own `baseUrl`.
+
+See [Options](https://kubb.dev/extensions/kubb-labs/plugin-cypress/options) for every option and its default.
 
 ## Example
 
+The config below writes the helpers to `src/gen/cypress`.
+
 ```typescript [kubb.config.ts]
 import { defineConfig } from 'kubb/config'
 import { pluginTs } from '@kubb/plugin-ts'
@@ -30,20 +35,16 @@ export default defineConfig({
 })
 ```
 
-```typescript [pet.cy.ts]
-import { getPetById } from '../src/gen/cypress/getPetById'
+A test then calls a helper and gets a typed response body. `petId` is an `int64`, which the default adapter types as `bigint`.
+
+```typescript [cypress/e2e/pet.cy.ts]
+import { getPetById } from '../../src/gen/cypress/getPetById'
 
 describe('Pet API', () => {
   it('returns the pet by id', () => {
     getPetById({ path: { petId: 1n } }).then((pet) => {
-      expect(pet.id).to.eq(1n)
+      expect(pet.name).to.be.a('string')
     })
   })
 })
 ```
-
-## See also
-
-- [Cypress](https://www.cypress.io/)
-- [cy.request()](https://docs.cypress.io/api/commands/request)
-- [@kubb/plugin-ts](https://kubb.dev/extensions/kubb-labs/plugin-ts)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-cypress",
-  "version": "5.0.9",
+  "version": "5.0.11",
   "description": "Generate Cypress request commands and e2e test fixtures with Kubb for automated API testing.",
   "keywords": [
     "code-generation",
@@ -63,17 +63,17 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@kubb/plugin-ts": "^5.0.9"
+    "@kubb/plugin-ts": "^5.0.11"
   },
   "devDependencies": {
     "@internals/shared": "0.0.0",
     "@internals/utils": "0.0.0",
     "cypress": "^16.1.1",
-    "kubb": "^5.8.3"
+    "kubb": "^5.9.2"
   },
   "peerDependencies": {
     "cypress": "^15.0.0 || ^16.0.0",
-    "kubb": "^5.8.3"
+    "kubb": "^5.9.2"
   },
   "peerDependenciesMeta": {
     "cypress": {