@page-component-object/adapter-cypress 0.1.0

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 ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 David Vega
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,65 @@
1
+ import { UserAgent } from '@page-component-object/core';
2
+ export { resetSharedUserAgent } from '@page-component-object/core';
3
+ import { ComponentTestObject } from '@page-component-object/queries';
4
+
5
+ type PCOChainable<T extends HTMLElement = HTMLElement> = Cypress.Chainable<JQuery<T>> & {
6
+ /** PCO semantic click — enqueues Cypress click on this chain. */
7
+ userClick(options?: Partial<Cypress.ClickOptions>): Cypress.Chainable<void>;
8
+ /** PCO semantic type — clear + type (matches `createCypressUserAgent` behavior). */
9
+ userType(text: string, options?: Partial<Cypress.TypeOptions>): Cypress.Chainable<void>;
10
+ /** Clear the field via Cypress native clear. */
11
+ userClear(): PCOChainable<T>;
12
+ /**
13
+ * PCO semantic select — select an option by its visible text (native `<select>` only).
14
+ *
15
+ * Uses the text of `<option>` elements to derive the option value, then calls Cypress `.select()`.
16
+ */
17
+ selectOptionByText(text: string | RegExp): Cypress.Chainable<void>;
18
+ };
19
+ /** Wrap a Cypress chain with PCO semantic methods. Native `.type()` / `.click()` / `.should()` unchanged. */
20
+ declare function asPCOChainable<T extends HTMLElement>(chain: Cypress.Chainable<JQuery<T>>): PCOChainable<T>;
21
+
22
+ /**
23
+ * Cypress-oriented test object base (Option B).
24
+ * Getters return `PCOChainable` for native Cypress chains plus PCO semantic methods.
25
+ * Use in E2E specs — not in Vitest/Jest/Storybook (those use `ComponentTestObject`).
26
+ *
27
+ * Queries use `@testing-library/cypress` (`cy.findBy*` / `cy.findAllBy*`) wherever possible.
28
+ * Register commands once: `import '@testing-library/cypress/add-commands'`.
29
+ */
30
+ declare class CypressComponentTestObject extends ComponentTestObject {
31
+ /** Wrap a resolved element in a PCO-augmented Cypress chain. Prefer `findBy*` for new getters. */
32
+ protected chain<T extends HTMLElement = HTMLElement>(resolve: () => T): PCOChainable<T>;
33
+ /** Chainable for one element from a sync RTL list getter. Prefer `findAllBy*At` for new getters. */
34
+ protected chainAt(resolveAll: () => HTMLElement[], index: number): PCOChainable;
35
+ protected findByRole(...args: Parameters<typeof cy.findByRole>): PCOChainable;
36
+ protected findAllByRoleAt(role: Parameters<typeof cy.findAllByRole>[0], optionsOrIndex: Parameters<typeof cy.findAllByRole>[1] | number, index?: number): PCOChainable;
37
+ protected findByLabelText(...args: Parameters<typeof cy.findByLabelText>): PCOChainable;
38
+ protected findAllByLabelTextAt(text: Parameters<typeof cy.findAllByLabelText>[0], optionsOrIndex: Parameters<typeof cy.findAllByLabelText>[1] | number, index?: number): PCOChainable;
39
+ protected findByText(...args: Parameters<typeof cy.findByText>): PCOChainable;
40
+ protected findAllByTextAt(text: Parameters<typeof cy.findAllByText>[0], optionsOrIndex: Parameters<typeof cy.findAllByText>[1] | number, index?: number): PCOChainable;
41
+ protected findByTestId(...args: Parameters<typeof cy.findByTestId>): PCOChainable;
42
+ protected findAllByTestIdAt(id: Parameters<typeof cy.findAllByTestId>[0], optionsOrIndex: Parameters<typeof cy.findAllByTestId>[1] | number, index?: number): PCOChainable;
43
+ protected findByPlaceholderText(...args: Parameters<typeof cy.findByPlaceholderText>): PCOChainable;
44
+ protected findAllByPlaceholderTextAt(text: Parameters<typeof cy.findAllByPlaceholderText>[0], optionsOrIndex: Parameters<typeof cy.findAllByPlaceholderText>[1] | number, index?: number): PCOChainable;
45
+ protected findByDisplayValue(...args: Parameters<typeof cy.findByDisplayValue>): PCOChainable;
46
+ protected findAllByDisplayValueAt(text: Parameters<typeof cy.findAllByDisplayValue>[0], optionsOrIndex: Parameters<typeof cy.findAllByDisplayValue>[1] | number, index?: number): PCOChainable;
47
+ protected findByAltText(...args: Parameters<typeof cy.findByAltText>): PCOChainable;
48
+ protected findAllByAltTextAt(text: Parameters<typeof cy.findAllByAltText>[0], optionsOrIndex: Parameters<typeof cy.findAllByAltText>[1] | number, index?: number): PCOChainable;
49
+ protected findByTitle(...args: Parameters<typeof cy.findByTitle>): PCOChainable;
50
+ protected findAllByTitleAt(text: Parameters<typeof cy.findAllByTitle>[0], optionsOrIndex: Parameters<typeof cy.findAllByTitle>[1] | number, index?: number): PCOChainable;
51
+ }
52
+
53
+ declare function runCypressCommand(command: () => Cypress.Chainable): Promise<void>;
54
+
55
+ declare function createCypressUserAgent(): UserAgent;
56
+ interface SetupPCOCypressOptions {
57
+ resetUserAgentEachTest?: boolean;
58
+ }
59
+ /**
60
+ * Configure PCO runtime for Cypress E2E/component tests.
61
+ * Call once from `cypress/support/e2e.ts`.
62
+ */
63
+ declare function setupPCOCypress(options?: SetupPCOCypressOptions): void;
64
+
65
+ export { CypressComponentTestObject, type PCOChainable, type SetupPCOCypressOptions, asPCOChainable, createCypressUserAgent, runCypressCommand, setupPCOCypress };
package/dist/index.js ADDED
@@ -0,0 +1,177 @@
1
+ // src/index.ts
2
+ import { configureRuntime, resetSharedUserAgent } from "@page-component-object/core";
3
+
4
+ // src/cypressCommand.ts
5
+ function runCypressCommand(command) {
6
+ return new Cypress.Promise((resolve) => {
7
+ command().then(() => {
8
+ resolve();
9
+ });
10
+ });
11
+ }
12
+
13
+ // src/CypressComponentTestObject.ts
14
+ import { ComponentTestObject } from "@page-component-object/queries";
15
+
16
+ // src/cypressTestingLibrary.ts
17
+ import "@testing-library/cypress";
18
+
19
+ // src/pcoChainable.ts
20
+ function asPCOChainable(chain) {
21
+ const pco = chain;
22
+ pco.userClick = (options) => chain.click(options);
23
+ pco.userType = (text, options) => chain.clear().type(text, options);
24
+ pco.userClear = () => chain.clear();
25
+ pco.selectOptionByText = (text) => chain.then(($select) => {
26
+ const options = $select.find("option").toArray();
27
+ const matched = options.find((opt) => {
28
+ const label = (opt.textContent ?? "").trim();
29
+ if (typeof text === "string") return label === text;
30
+ return text.test(label);
31
+ });
32
+ if (!matched) {
33
+ throw new Error(`selectOptionByText: no <option> matched "${text}"`);
34
+ }
35
+ const value = matched.value;
36
+ return cy.wrap($select).select(value);
37
+ });
38
+ return pco;
39
+ }
40
+
41
+ // src/cypressTestingLibrary.ts
42
+ function cyFindBy(command, ...args) {
43
+ const run = cy[command];
44
+ return asPCOChainable(run(...args));
45
+ }
46
+ function cyFindAllByAt(command, index, ...args) {
47
+ const run = cy[command];
48
+ const list = args.length > 0 ? run(...args) : run();
49
+ return asPCOChainable(list.eq(index));
50
+ }
51
+
52
+ // src/CypressComponentTestObject.ts
53
+ var CypressComponentTestObject = class extends ComponentTestObject {
54
+ /** Wrap a resolved element in a PCO-augmented Cypress chain. Prefer `findBy*` for new getters. */
55
+ chain(resolve) {
56
+ return asPCOChainable(cy.wrap(resolve()));
57
+ }
58
+ /** Chainable for one element from a sync RTL list getter. Prefer `findAllBy*At` for new getters. */
59
+ chainAt(resolveAll, index) {
60
+ return asPCOChainable(cy.wrap(resolveAll()[index]));
61
+ }
62
+ findByRole(...args) {
63
+ return cyFindBy("findByRole", ...args);
64
+ }
65
+ findAllByRoleAt(role, optionsOrIndex, index) {
66
+ if (typeof optionsOrIndex === "number") {
67
+ return cyFindAllByAt("findAllByRole", optionsOrIndex, role);
68
+ }
69
+ return cyFindAllByAt("findAllByRole", index ?? 0, role, optionsOrIndex);
70
+ }
71
+ findByLabelText(...args) {
72
+ return cyFindBy("findByLabelText", ...args);
73
+ }
74
+ findAllByLabelTextAt(text, optionsOrIndex, index) {
75
+ if (typeof optionsOrIndex === "number") {
76
+ return cyFindAllByAt("findAllByLabelText", optionsOrIndex, text);
77
+ }
78
+ return cyFindAllByAt("findAllByLabelText", index ?? 0, text, optionsOrIndex);
79
+ }
80
+ findByText(...args) {
81
+ return cyFindBy("findByText", ...args);
82
+ }
83
+ findAllByTextAt(text, optionsOrIndex, index) {
84
+ if (typeof optionsOrIndex === "number") {
85
+ return cyFindAllByAt("findAllByText", optionsOrIndex, text);
86
+ }
87
+ return cyFindAllByAt("findAllByText", index ?? 0, text, optionsOrIndex);
88
+ }
89
+ findByTestId(...args) {
90
+ return cyFindBy("findByTestId", ...args);
91
+ }
92
+ findAllByTestIdAt(id, optionsOrIndex, index) {
93
+ if (typeof optionsOrIndex === "number") {
94
+ return cyFindAllByAt("findAllByTestId", optionsOrIndex, id);
95
+ }
96
+ return cyFindAllByAt("findAllByTestId", index ?? 0, id, optionsOrIndex);
97
+ }
98
+ findByPlaceholderText(...args) {
99
+ return cyFindBy("findByPlaceholderText", ...args);
100
+ }
101
+ findAllByPlaceholderTextAt(text, optionsOrIndex, index) {
102
+ if (typeof optionsOrIndex === "number") {
103
+ return cyFindAllByAt("findAllByPlaceholderText", optionsOrIndex, text);
104
+ }
105
+ return cyFindAllByAt("findAllByPlaceholderText", index ?? 0, text, optionsOrIndex);
106
+ }
107
+ findByDisplayValue(...args) {
108
+ return cyFindBy("findByDisplayValue", ...args);
109
+ }
110
+ findAllByDisplayValueAt(text, optionsOrIndex, index) {
111
+ if (typeof optionsOrIndex === "number") {
112
+ return cyFindAllByAt("findAllByDisplayValue", optionsOrIndex, text);
113
+ }
114
+ return cyFindAllByAt(
115
+ "findAllByDisplayValue",
116
+ index ?? 0,
117
+ text,
118
+ optionsOrIndex
119
+ );
120
+ }
121
+ findByAltText(...args) {
122
+ return cyFindBy("findByAltText", ...args);
123
+ }
124
+ findAllByAltTextAt(text, optionsOrIndex, index) {
125
+ if (typeof optionsOrIndex === "number") {
126
+ return cyFindAllByAt("findAllByAltText", optionsOrIndex, text);
127
+ }
128
+ return cyFindAllByAt("findAllByAltText", index ?? 0, text, optionsOrIndex);
129
+ }
130
+ findByTitle(...args) {
131
+ return cyFindBy("findByTitle", ...args);
132
+ }
133
+ findAllByTitleAt(text, optionsOrIndex, index) {
134
+ if (typeof optionsOrIndex === "number") {
135
+ return cyFindAllByAt("findAllByTitle", optionsOrIndex, text);
136
+ }
137
+ return cyFindAllByAt("findAllByTitle", index ?? 0, text, optionsOrIndex);
138
+ }
139
+ };
140
+
141
+ // src/index.ts
142
+ function createCypressUserAgent() {
143
+ return {
144
+ click: (target, options) => runCypressCommand(() => cy.wrap(target).click(options)),
145
+ dblClick: (target, options) => runCypressCommand(() => cy.wrap(target).dblclick(options)),
146
+ hover: (target, options) => runCypressCommand(() => cy.wrap(target).trigger("mouseover", options)),
147
+ type: (target, text, options) => runCypressCommand(() => cy.wrap(target).clear().type(text, options)),
148
+ keyboard: (text, options) => runCypressCommand(() => cy.focused().type(text, options)),
149
+ tab: () => runCypressCommand(() => cy.focused().trigger("keydown", { key: "Tab", keyCode: 9 })),
150
+ upload: (target, files) => runCypressCommand(() => cy.wrap(target).selectFile(files, { force: true }))
151
+ };
152
+ }
153
+ function setupPCOCypress(options = {}) {
154
+ configureRuntime({
155
+ spyFactory: {
156
+ fn: (impl) => {
157
+ const stub = cy.stub().callsFake(impl);
158
+ return stub;
159
+ }
160
+ },
161
+ createUserAgent: createCypressUserAgent
162
+ });
163
+ if (options.resetUserAgentEachTest !== false) {
164
+ beforeEach(() => {
165
+ resetSharedUserAgent();
166
+ });
167
+ }
168
+ }
169
+ export {
170
+ CypressComponentTestObject,
171
+ asPCOChainable,
172
+ createCypressUserAgent,
173
+ resetSharedUserAgent,
174
+ runCypressCommand,
175
+ setupPCOCypress
176
+ };
177
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/index.ts","../src/cypressCommand.ts","../src/CypressComponentTestObject.ts","../src/cypressTestingLibrary.ts","../src/pcoChainable.ts"],"sourcesContent":["import { configureRuntime, resetSharedUserAgent, type UserAgent } from '@page-component-object/core';\r\n\r\nimport { runCypressCommand } from './cypressCommand';\r\n\r\nexport { CypressComponentTestObject } from './CypressComponentTestObject';\r\nexport { asPCOChainable, type PCOChainable } from './pcoChainable';\r\nexport { runCypressCommand } from './cypressCommand';\r\n\r\nexport function createCypressUserAgent(): UserAgent {\r\n return {\r\n click: (target, options) => runCypressCommand(() => cy.wrap(target).click(options)),\r\n dblClick: (target, options) => runCypressCommand(() => cy.wrap(target).dblclick(options)),\r\n hover: (target, options) =>\r\n runCypressCommand(() => cy.wrap(target).trigger('mouseover', options)),\r\n type: (target, text, options) =>\r\n runCypressCommand(() => cy.wrap(target).clear().type(text, options)),\r\n keyboard: (text, options) => runCypressCommand(() => cy.focused().type(text, options)),\r\n tab: () =>\r\n runCypressCommand(() => cy.focused().trigger('keydown', { key: 'Tab', keyCode: 9 })),\r\n upload: (target, files) =>\r\n runCypressCommand(() => cy.wrap(target).selectFile(files as never, { force: true })),\r\n };\r\n}\r\n\r\nexport interface SetupPCOCypressOptions {\r\n resetUserAgentEachTest?: boolean;\r\n}\r\n\r\n/**\r\n * Configure PCO runtime for Cypress E2E/component tests.\r\n * Call once from `cypress/support/e2e.ts`.\r\n */\r\nexport function setupPCOCypress(options: SetupPCOCypressOptions = {}): void {\r\n configureRuntime({\r\n spyFactory: {\r\n fn: (impl) => {\r\n const stub = cy.stub().callsFake(impl as never);\r\n return stub as never;\r\n },\r\n },\r\n createUserAgent: createCypressUserAgent,\r\n });\r\n\r\n if (options.resetUserAgentEachTest !== false) {\r\n beforeEach(() => {\r\n resetSharedUserAgent();\r\n });\r\n }\r\n}\r\n\r\nexport { resetSharedUserAgent };\r\n","export function runCypressCommand(command: () => Cypress.Chainable): Promise<void> {\r\n return new Cypress.Promise<void>((resolve) => {\r\n command().then(() => {\r\n resolve();\r\n });\r\n });\r\n}\r\n","import { ComponentTestObject } from '@page-component-object/queries';\r\n\r\nimport { cyFindAllByAt, cyFindBy } from './cypressTestingLibrary';\r\nimport { asPCOChainable, type PCOChainable } from './pcoChainable';\r\n\r\n/**\r\n * Cypress-oriented test object base (Option B).\r\n * Getters return `PCOChainable` for native Cypress chains plus PCO semantic methods.\r\n * Use in E2E specs — not in Vitest/Jest/Storybook (those use `ComponentTestObject`).\r\n *\r\n * Queries use `@testing-library/cypress` (`cy.findBy*` / `cy.findAllBy*`) wherever possible.\r\n * Register commands once: `import '@testing-library/cypress/add-commands'`.\r\n */\r\nexport class CypressComponentTestObject extends ComponentTestObject {\r\n /** Wrap a resolved element in a PCO-augmented Cypress chain. Prefer `findBy*` for new getters. */\r\n protected chain<T extends HTMLElement = HTMLElement>(resolve: () => T): PCOChainable<T> {\r\n return asPCOChainable(cy.wrap(resolve()));\r\n }\r\n\r\n /** Chainable for one element from a sync RTL list getter. Prefer `findAllBy*At` for new getters. */\r\n protected chainAt(resolveAll: () => HTMLElement[], index: number): PCOChainable {\r\n return asPCOChainable(cy.wrap(resolveAll()[index]));\r\n }\r\n\r\n protected findByRole(...args: Parameters<typeof cy.findByRole>): PCOChainable {\r\n return cyFindBy('findByRole', ...args);\r\n }\r\n\r\n protected findAllByRoleAt(\r\n role: Parameters<typeof cy.findAllByRole>[0],\r\n optionsOrIndex: Parameters<typeof cy.findAllByRole>[1] | number,\r\n index?: number,\r\n ): PCOChainable {\r\n if (typeof optionsOrIndex === 'number') {\r\n return cyFindAllByAt('findAllByRole', optionsOrIndex, role);\r\n }\r\n return cyFindAllByAt('findAllByRole', index ?? 0, role, optionsOrIndex);\r\n }\r\n\r\n protected findByLabelText(...args: Parameters<typeof cy.findByLabelText>): PCOChainable {\r\n return cyFindBy('findByLabelText', ...args);\r\n }\r\n\r\n protected findAllByLabelTextAt(\r\n text: Parameters<typeof cy.findAllByLabelText>[0],\r\n optionsOrIndex: Parameters<typeof cy.findAllByLabelText>[1] | number,\r\n index?: number,\r\n ): PCOChainable {\r\n if (typeof optionsOrIndex === 'number') {\r\n return cyFindAllByAt('findAllByLabelText', optionsOrIndex, text);\r\n }\r\n return cyFindAllByAt('findAllByLabelText', index ?? 0, text, optionsOrIndex);\r\n }\r\n\r\n protected findByText(...args: Parameters<typeof cy.findByText>): PCOChainable {\r\n return cyFindBy('findByText', ...args);\r\n }\r\n\r\n protected findAllByTextAt(\r\n text: Parameters<typeof cy.findAllByText>[0],\r\n optionsOrIndex: Parameters<typeof cy.findAllByText>[1] | number,\r\n index?: number,\r\n ): PCOChainable {\r\n if (typeof optionsOrIndex === 'number') {\r\n return cyFindAllByAt('findAllByText', optionsOrIndex, text);\r\n }\r\n return cyFindAllByAt('findAllByText', index ?? 0, text, optionsOrIndex);\r\n }\r\n\r\n protected findByTestId(...args: Parameters<typeof cy.findByTestId>): PCOChainable {\r\n return cyFindBy('findByTestId', ...args);\r\n }\r\n\r\n protected findAllByTestIdAt(\r\n id: Parameters<typeof cy.findAllByTestId>[0],\r\n optionsOrIndex: Parameters<typeof cy.findAllByTestId>[1] | number,\r\n index?: number,\r\n ): PCOChainable {\r\n if (typeof optionsOrIndex === 'number') {\r\n return cyFindAllByAt('findAllByTestId', optionsOrIndex, id);\r\n }\r\n return cyFindAllByAt('findAllByTestId', index ?? 0, id, optionsOrIndex);\r\n }\r\n\r\n protected findByPlaceholderText(\r\n ...args: Parameters<typeof cy.findByPlaceholderText>\r\n ): PCOChainable {\r\n return cyFindBy('findByPlaceholderText', ...args);\r\n }\r\n\r\n protected findAllByPlaceholderTextAt(\r\n text: Parameters<typeof cy.findAllByPlaceholderText>[0],\r\n optionsOrIndex: Parameters<typeof cy.findAllByPlaceholderText>[1] | number,\r\n index?: number,\r\n ): PCOChainable {\r\n if (typeof optionsOrIndex === 'number') {\r\n return cyFindAllByAt('findAllByPlaceholderText', optionsOrIndex, text);\r\n }\r\n return cyFindAllByAt('findAllByPlaceholderText', index ?? 0, text, optionsOrIndex);\r\n }\r\n\r\n protected findByDisplayValue(\r\n ...args: Parameters<typeof cy.findByDisplayValue>\r\n ): PCOChainable {\r\n return cyFindBy('findByDisplayValue', ...args);\r\n }\r\n\r\n protected findAllByDisplayValueAt(\r\n text: Parameters<typeof cy.findAllByDisplayValue>[0],\r\n optionsOrIndex: Parameters<typeof cy.findAllByDisplayValue>[1] | number,\r\n index?: number,\r\n ): PCOChainable {\r\n if (typeof optionsOrIndex === 'number') {\r\n return cyFindAllByAt('findAllByDisplayValue', optionsOrIndex, text);\r\n }\r\n return cyFindAllByAt(\r\n 'findAllByDisplayValue',\r\n index ?? 0,\r\n text,\r\n optionsOrIndex,\r\n );\r\n }\r\n\r\n protected findByAltText(\r\n ...args: Parameters<typeof cy.findByAltText>\r\n ): PCOChainable {\r\n return cyFindBy('findByAltText', ...args);\r\n }\r\n\r\n protected findAllByAltTextAt(\r\n text: Parameters<typeof cy.findAllByAltText>[0],\r\n optionsOrIndex: Parameters<typeof cy.findAllByAltText>[1] | number,\r\n index?: number,\r\n ): PCOChainable {\r\n if (typeof optionsOrIndex === 'number') {\r\n return cyFindAllByAt('findAllByAltText', optionsOrIndex, text);\r\n }\r\n return cyFindAllByAt('findAllByAltText', index ?? 0, text, optionsOrIndex);\r\n }\r\n\r\n protected findByTitle(\r\n ...args: Parameters<typeof cy.findByTitle>\r\n ): PCOChainable {\r\n return cyFindBy('findByTitle', ...args);\r\n }\r\n\r\n protected findAllByTitleAt(\r\n text: Parameters<typeof cy.findAllByTitle>[0],\r\n optionsOrIndex: Parameters<typeof cy.findAllByTitle>[1] | number,\r\n index?: number,\r\n ): PCOChainable {\r\n if (typeof optionsOrIndex === 'number') {\r\n return cyFindAllByAt('findAllByTitle', optionsOrIndex, text);\r\n }\r\n return cyFindAllByAt('findAllByTitle', index ?? 0, text, optionsOrIndex);\r\n }\r\n}\r\n","import '@testing-library/cypress';\r\n\r\nimport { asPCOChainable, type PCOChainable } from './pcoChainable';\r\n\r\ntype FindByCommand =\r\n | 'findByRole'\r\n | 'findByLabelText'\r\n | 'findByText'\r\n | 'findByTestId'\r\n | 'findByPlaceholderText'\r\n | 'findByDisplayValue'\r\n | 'findByAltText'\r\n | 'findByTitle';\r\n\r\ntype FindAllByCommand =\r\n | 'findAllByRole'\r\n | 'findAllByLabelText'\r\n | 'findAllByText'\r\n | 'findAllByTestId'\r\n | 'findAllByPlaceholderText'\r\n | 'findAllByDisplayValue'\r\n | 'findAllByAltText'\r\n | 'findAllByTitle';\r\n\r\n/** Wrap a `cy.findBy*` command as a PCO chainable. */\r\nexport function cyFindBy(command: FindByCommand, ...args: unknown[]): PCOChainable {\r\n const run = (cy as Record<FindByCommand, (...a: unknown[]) => Cypress.Chainable<JQuery<HTMLElement>>>)[\r\n command\r\n ];\r\n return asPCOChainable(run(...args));\r\n}\r\n\r\n/** Wrap `cy.findAllBy*(…).eq(index)` as a PCO chainable. */\r\nexport function cyFindAllByAt(\r\n command: FindAllByCommand,\r\n index: number,\r\n ...args: unknown[]\r\n): PCOChainable {\r\n const run = (cy as Record<\r\n FindAllByCommand,\r\n (...a: unknown[]) => Cypress.Chainable<JQuery<HTMLElement>>\r\n >)[command];\r\n const list = args.length > 0 ? run(...args) : run();\r\n return asPCOChainable(list.eq(index));\r\n}\r\n","export type PCOChainable<T extends HTMLElement = HTMLElement> = Cypress.Chainable<JQuery<T>> & {\r\n /** PCO semantic click — enqueues Cypress click on this chain. */\r\n userClick(options?: Partial<Cypress.ClickOptions>): Cypress.Chainable<void>;\r\n /** PCO semantic type — clear + type (matches `createCypressUserAgent` behavior). */\r\n userType(text: string, options?: Partial<Cypress.TypeOptions>): Cypress.Chainable<void>;\r\n /** Clear the field via Cypress native clear. */\r\n userClear(): PCOChainable<T>;\r\n /**\r\n * PCO semantic select — select an option by its visible text (native `<select>` only).\r\n *\r\n * Uses the text of `<option>` elements to derive the option value, then calls Cypress `.select()`.\r\n */\r\n selectOptionByText(text: string | RegExp): Cypress.Chainable<void>;\r\n};\r\n\r\n/** Wrap a Cypress chain with PCO semantic methods. Native `.type()` / `.click()` / `.should()` unchanged. */\r\nexport function asPCOChainable<T extends HTMLElement>(\r\n chain: Cypress.Chainable<JQuery<T>>,\r\n): PCOChainable<T> {\r\n const pco = chain as PCOChainable<T>;\r\n\r\n pco.userClick = (options?: Partial<Cypress.ClickOptions>) =>\r\n chain.click(options) as unknown as Cypress.Chainable<void>;\r\n\r\n pco.userType = (text: string, options?: Partial<Cypress.TypeOptions>) =>\r\n chain.clear().type(text, options) as unknown as Cypress.Chainable<void>;\r\n\r\n pco.userClear = () => chain.clear() as PCOChainable<T>;\r\n\r\n pco.selectOptionByText = (text: string | RegExp) =>\r\n chain.then(($select) => {\r\n const options = $select.find('option').toArray();\r\n const matched = options.find((opt) => {\r\n const label = (opt.textContent ?? '').trim();\r\n if (typeof text === 'string') return label === text;\r\n return text.test(label);\r\n });\r\n\r\n if (!matched) {\r\n throw new Error(`selectOptionByText: no <option> matched \"${text}\"`);\r\n }\r\n\r\n const value = (matched as unknown as HTMLOptionElement).value;\r\n return cy.wrap($select as unknown as JQuery<HTMLElement>).select(value as never);\r\n }) as unknown as Cypress.Chainable<void>;\r\n\r\n return pco;\r\n}\r\n"],"mappings":";AAAA,SAAS,kBAAkB,4BAA4C;;;ACAhE,SAAS,kBAAkB,SAAiD;AACjF,SAAO,IAAI,QAAQ,QAAc,CAAC,YAAY;AAC5C,YAAQ,EAAE,KAAK,MAAM;AACnB,cAAQ;AAAA,IACV,CAAC;AAAA,EACH,CAAC;AACH;;;ACNA,SAAS,2BAA2B;;;ACApC,OAAO;;;ACgBA,SAAS,eACd,OACiB;AACjB,QAAM,MAAM;AAEZ,MAAI,YAAY,CAAC,YACf,MAAM,MAAM,OAAO;AAErB,MAAI,WAAW,CAAC,MAAc,YAC5B,MAAM,MAAM,EAAE,KAAK,MAAM,OAAO;AAElC,MAAI,YAAY,MAAM,MAAM,MAAM;AAElC,MAAI,qBAAqB,CAAC,SACxB,MAAM,KAAK,CAAC,YAAY;AACtB,UAAM,UAAU,QAAQ,KAAK,QAAQ,EAAE,QAAQ;AAC/C,UAAM,UAAU,QAAQ,KAAK,CAAC,QAAQ;AACpC,YAAM,SAAS,IAAI,eAAe,IAAI,KAAK;AAC3C,UAAI,OAAO,SAAS,SAAU,QAAO,UAAU;AAC/C,aAAO,KAAK,KAAK,KAAK;AAAA,IACxB,CAAC;AAED,QAAI,CAAC,SAAS;AACZ,YAAM,IAAI,MAAM,4CAA4C,IAAI,GAAG;AAAA,IACrE;AAEA,UAAM,QAAS,QAAyC;AACxD,WAAO,GAAG,KAAK,OAAyC,EAAE,OAAO,KAAc;AAAA,EACjF,CAAC;AAEH,SAAO;AACT;;;ADtBO,SAAS,SAAS,YAA2B,MAA+B;AACjF,QAAM,MAAO,GACX,OACF;AACA,SAAO,eAAe,IAAI,GAAG,IAAI,CAAC;AACpC;AAGO,SAAS,cACd,SACA,UACG,MACW;AACd,QAAM,MAAO,GAGV,OAAO;AACV,QAAM,OAAO,KAAK,SAAS,IAAI,IAAI,GAAG,IAAI,IAAI,IAAI;AAClD,SAAO,eAAe,KAAK,GAAG,KAAK,CAAC;AACtC;;;AD/BO,IAAM,6BAAN,cAAyC,oBAAoB;AAAA;AAAA,EAExD,MAA2C,SAAmC;AACtF,WAAO,eAAe,GAAG,KAAK,QAAQ,CAAC,CAAC;AAAA,EAC1C;AAAA;AAAA,EAGU,QAAQ,YAAiC,OAA6B;AAC9E,WAAO,eAAe,GAAG,KAAK,WAAW,EAAE,KAAK,CAAC,CAAC;AAAA,EACpD;AAAA,EAEU,cAAc,MAAsD;AAC5E,WAAO,SAAS,cAAc,GAAG,IAAI;AAAA,EACvC;AAAA,EAEU,gBACR,MACA,gBACA,OACc;AACd,QAAI,OAAO,mBAAmB,UAAU;AACtC,aAAO,cAAc,iBAAiB,gBAAgB,IAAI;AAAA,IAC5D;AACA,WAAO,cAAc,iBAAiB,SAAS,GAAG,MAAM,cAAc;AAAA,EACxE;AAAA,EAEU,mBAAmB,MAA2D;AACtF,WAAO,SAAS,mBAAmB,GAAG,IAAI;AAAA,EAC5C;AAAA,EAEU,qBACR,MACA,gBACA,OACc;AACd,QAAI,OAAO,mBAAmB,UAAU;AACtC,aAAO,cAAc,sBAAsB,gBAAgB,IAAI;AAAA,IACjE;AACA,WAAO,cAAc,sBAAsB,SAAS,GAAG,MAAM,cAAc;AAAA,EAC7E;AAAA,EAEU,cAAc,MAAsD;AAC5E,WAAO,SAAS,cAAc,GAAG,IAAI;AAAA,EACvC;AAAA,EAEU,gBACR,MACA,gBACA,OACc;AACd,QAAI,OAAO,mBAAmB,UAAU;AACtC,aAAO,cAAc,iBAAiB,gBAAgB,IAAI;AAAA,IAC5D;AACA,WAAO,cAAc,iBAAiB,SAAS,GAAG,MAAM,cAAc;AAAA,EACxE;AAAA,EAEU,gBAAgB,MAAwD;AAChF,WAAO,SAAS,gBAAgB,GAAG,IAAI;AAAA,EACzC;AAAA,EAEU,kBACR,IACA,gBACA,OACc;AACd,QAAI,OAAO,mBAAmB,UAAU;AACtC,aAAO,cAAc,mBAAmB,gBAAgB,EAAE;AAAA,IAC5D;AACA,WAAO,cAAc,mBAAmB,SAAS,GAAG,IAAI,cAAc;AAAA,EACxE;AAAA,EAEU,yBACL,MACW;AACd,WAAO,SAAS,yBAAyB,GAAG,IAAI;AAAA,EAClD;AAAA,EAEU,2BACR,MACA,gBACA,OACc;AACd,QAAI,OAAO,mBAAmB,UAAU;AACtC,aAAO,cAAc,4BAA4B,gBAAgB,IAAI;AAAA,IACvE;AACA,WAAO,cAAc,4BAA4B,SAAS,GAAG,MAAM,cAAc;AAAA,EACnF;AAAA,EAEU,sBACL,MACW;AACd,WAAO,SAAS,sBAAsB,GAAG,IAAI;AAAA,EAC/C;AAAA,EAEU,wBACR,MACA,gBACA,OACc;AACd,QAAI,OAAO,mBAAmB,UAAU;AACtC,aAAO,cAAc,yBAAyB,gBAAgB,IAAI;AAAA,IACpE;AACA,WAAO;AAAA,MACL;AAAA,MACA,SAAS;AAAA,MACT;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA,EAEU,iBACL,MACW;AACd,WAAO,SAAS,iBAAiB,GAAG,IAAI;AAAA,EAC1C;AAAA,EAEU,mBACR,MACA,gBACA,OACc;AACd,QAAI,OAAO,mBAAmB,UAAU;AACtC,aAAO,cAAc,oBAAoB,gBAAgB,IAAI;AAAA,IAC/D;AACA,WAAO,cAAc,oBAAoB,SAAS,GAAG,MAAM,cAAc;AAAA,EAC3E;AAAA,EAEU,eACL,MACW;AACd,WAAO,SAAS,eAAe,GAAG,IAAI;AAAA,EACxC;AAAA,EAEU,iBACR,MACA,gBACA,OACc;AACd,QAAI,OAAO,mBAAmB,UAAU;AACtC,aAAO,cAAc,kBAAkB,gBAAgB,IAAI;AAAA,IAC7D;AACA,WAAO,cAAc,kBAAkB,SAAS,GAAG,MAAM,cAAc;AAAA,EACzE;AACF;;;AFpJO,SAAS,yBAAoC;AAClD,SAAO;AAAA,IACL,OAAO,CAAC,QAAQ,YAAY,kBAAkB,MAAM,GAAG,KAAK,MAAM,EAAE,MAAM,OAAO,CAAC;AAAA,IAClF,UAAU,CAAC,QAAQ,YAAY,kBAAkB,MAAM,GAAG,KAAK,MAAM,EAAE,SAAS,OAAO,CAAC;AAAA,IACxF,OAAO,CAAC,QAAQ,YACd,kBAAkB,MAAM,GAAG,KAAK,MAAM,EAAE,QAAQ,aAAa,OAAO,CAAC;AAAA,IACvE,MAAM,CAAC,QAAQ,MAAM,YACnB,kBAAkB,MAAM,GAAG,KAAK,MAAM,EAAE,MAAM,EAAE,KAAK,MAAM,OAAO,CAAC;AAAA,IACrE,UAAU,CAAC,MAAM,YAAY,kBAAkB,MAAM,GAAG,QAAQ,EAAE,KAAK,MAAM,OAAO,CAAC;AAAA,IACrF,KAAK,MACH,kBAAkB,MAAM,GAAG,QAAQ,EAAE,QAAQ,WAAW,EAAE,KAAK,OAAO,SAAS,EAAE,CAAC,CAAC;AAAA,IACrF,QAAQ,CAAC,QAAQ,UACf,kBAAkB,MAAM,GAAG,KAAK,MAAM,EAAE,WAAW,OAAgB,EAAE,OAAO,KAAK,CAAC,CAAC;AAAA,EACvF;AACF;AAUO,SAAS,gBAAgB,UAAkC,CAAC,GAAS;AAC1E,mBAAiB;AAAA,IACf,YAAY;AAAA,MACV,IAAI,CAAC,SAAS;AACZ,cAAM,OAAO,GAAG,KAAK,EAAE,UAAU,IAAa;AAC9C,eAAO;AAAA,MACT;AAAA,IACF;AAAA,IACA,iBAAiB;AAAA,EACnB,CAAC;AAED,MAAI,QAAQ,2BAA2B,OAAO;AAC5C,eAAW,MAAM;AACf,2BAAqB;AAAA,IACvB,CAAC;AAAA,EACH;AACF;","names":[]}
package/package.json ADDED
@@ -0,0 +1,49 @@
1
+ {
2
+ "name": "@page-component-object/adapter-cypress",
3
+ "version": "0.1.0",
4
+ "type": "module",
5
+ "exports": {
6
+ ".": {
7
+ "types": "./dist/index.d.ts",
8
+ "import": "./dist/index.js"
9
+ }
10
+ },
11
+ "main": "./dist/index.js",
12
+ "types": "./dist/index.d.ts",
13
+ "files": [
14
+ "dist"
15
+ ],
16
+ "dependencies": {
17
+ "@page-component-object/core": "0.1.0",
18
+ "@page-component-object/queries": "0.1.0"
19
+ },
20
+ "peerDependencies": {
21
+ "@testing-library/cypress": "^10.0.0",
22
+ "cypress": "^13.0.0 || ^14.0.0 || ^15.0.0"
23
+ },
24
+ "devDependencies": {
25
+ "cypress": "^14.0.0",
26
+ "@testing-library/cypress": "^10.0.0",
27
+ "rimraf": "^6.0.1",
28
+ "tsup": "^8.3.5",
29
+ "typescript": "^5.7.2"
30
+ },
31
+ "license": "MIT",
32
+ "repository": {
33
+ "type": "git",
34
+ "url": "git+https://github.com/dvegap95/page-component-test-object.git",
35
+ "directory": "packages/adapters/cypress"
36
+ },
37
+ "homepage": "https://github.com/dvegap95/page-component-test-object#readme",
38
+ "bugs": {
39
+ "url": "https://github.com/dvegap95/page-component-test-object/issues"
40
+ },
41
+ "publishConfig": {
42
+ "access": "public"
43
+ },
44
+ "scripts": {
45
+ "build": "tsup",
46
+ "typecheck": "tsc --noEmit",
47
+ "clean": "rimraf dist"
48
+ }
49
+ }