@qavajs/cypress 2.8.2 → 2.9.0

package/CHANGELOG.md

@@ -10,6 +10,11 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 :pencil: - chore
 :microscope: - experimental
 
+## [2.9.0]
+- :pencil: added TypeScript declaration files (`index.d.ts`, `po.d.ts`, `defineQavajs.d.ts`)
+- :pencil: added `tsconfig.json`
+- :pencil: added `types` and `exports` fields to `package.json`
+
 ## [2.8.2]
 - :rocket: added `clickable` condition (checks element is visible and not disabled)
 - :beetle: fixed `validateAllOf` exiting after first successful match instead of validating all values

package/README.md

@@ -56,9 +56,9 @@ class Header {
 
 export default class App {
     // Simple CSS/XPath selector
-    SearchInput  = locator('#search');
+    SearchInput = locator('#search');
     SearchButton = locator('#searchBtn');
-    Results      = locator('.result-item');
+    Results = locator('.result-item');
 
     // Parameterized selector
     ResultByIndex = locator.template(idx => `.result-item:nth-child(${idx})`);
@@ -79,11 +79,11 @@ The memory class stores values accessible in steps via the `$key` syntax.
 
 ```typescript
 export default class Memory {
-    baseUrl      = 'https://example.com';
-    testUser     = 'user@example.com';
+    baseUrl = 'https://example.com';
+    testUser = 'user@example.com';
     // Functions are called on access
-    timestamp    = () => Date.now();
-    uppercase    = (str: string) => str.toUpperCase();
+    timestamp = () => Date.now();
+    uppercase = (str: string) => str.toUpperCase();
 }
 ```
 

package/defineQavajs.d.ts

@@ -0,0 +1,27 @@
+/** Options passed to {@link defineQavajs} to wire up the qavajs runtime. */
+export interface QavajsOptions {
+    /** Root page-object instance or class used to resolve element aliases. */
+    pageObject: object;
+    /** Memory instance used for expression interpolation and value storage. */
+    memory: object;
+}
+
+/**
+ * Initialise the qavajs runtime by attaching the page-object and memory
+ * instances to the Cypress `window` object so step definitions can access them.
+ * Call this once in your Cypress support file before any tests run.
+ *
+ * @param options - Page-object and memory configuration.
+ *
+ * @example
+ * ```ts
+ * import defineQavajs from '@qavajs/cypress/defineQavajs';
+ * import App from './page_object';
+ * import Memory from './memory';
+ *
+ * defineQavajs({ pageObject: new App(), memory: new Memory() });
+ * ```
+ */
+export declare function defineQavajs(options: QavajsOptions): void;
+
+export default defineQavajs;

package/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Side-effect import that registers all qavajs Cucumber step definitions
+ * (actions, validations, memory, HTTP, mouse, storage, etc.) with the
+ * `@qavajs/cypress-runner-adapter` runtime.
+ *
+ * Import this once in your Cypress support file:
+ * ```ts
+ * import '@qavajs/cypress';
+ * ```
+ */
+export {};

package/package.json

@@ -1,8 +1,23 @@
 {
   "name": "@qavajs/cypress",
-  "version": "2.8.2",
+  "version": "2.9.0",
   "description": "qavajs for cypress runner",
   "main": "index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    },
+    "./po": {
+      "types": "./po.d.ts",
+      "default": "./po.js"
+    },
+    "./defineQavajs": {
+      "types": "./defineQavajs.d.ts",
+      "default": "./defineQavajs.js"
+    }
+  },
   "scripts": {
     "debug": "cypress open --config-file test-e2e/cypress.config.js",
     "debug:it": "MODE=it cypress open --config-file test-e2e/cypress.config.js",
@@ -32,8 +47,8 @@
     "node": ">=18"
   },
   "devDependencies": {
-    "@qavajs/cypress-runner-adapter": "^1.9.2",
+    "@qavajs/cypress-runner-adapter": "^1.11.0",
     "@qavajs/memory": "^1.11.0",
-    "cypress": "^15.14.1"
+    "cypress": "^15.15.0"
   }
 }

package/po.d.ts

@@ -0,0 +1,53 @@
+/** Determines how a selector is resolved against the DOM. */
+export type SelectorType = 'simple' | 'template' | 'native';
+
+/** Represents a page-object element definition. */
+export declare class Selector {
+    /** selector string */
+    selector: string | null;
+    /** Resolution strategy used when traversing the element chain. */
+    type: SelectorType;
+    /** Optional component class whose properties describe child elements. */
+    component?: new () => object;
+
+    constructor(selector: string | null, type?: SelectorType);
+
+    /**
+     * Attach a component class to this selector so its properties can be
+     * used as child element aliases.
+     * @param component - Component class whose instance defines child aliases.
+     */
+    as(component: new () => object): this;
+}
+
+export interface LocatorFn {
+    /**
+     * Create a simple selector entry.
+     * @param selector - Selector string.
+     */
+    (selector: string): Selector;
+
+    /**
+     * Create a template selector whose final value is produced by calling
+     * `Alias (argument)` at query time, allowing dynamic substitution.
+     * @param selector - Function that receives the runtime argument and returns the selector string.
+     */
+    template(selector: (argument: string) => string): Selector;
+
+    /**
+     * Create a native selector resolved via a custom Cypress command chain.
+     * The function receives context at query time and must return a Chainable.
+     * @param selector - Function that builds and returns a Cypress Chainable.
+     */
+    native(selector: (ctx: { parent: Cypress.Chainable; cy: Cypress.cy; argument: string }) => Cypress.Chainable): Selector;
+
+    /**
+     * Create a component-only node with no selector of its own.
+     * Useful when the root of a sub-tree is already in scope.
+     * @param component - Component class whose instance defines child aliases.
+     */
+    as(component: new () => object): Selector;
+}
+
+/** Factory for building page-object element definitions. */
+export declare const locator: LocatorFn;

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "declaration": true,
+    "strict": true,
+    "types": ["cypress"],
+    "noEmit": true
+  },
+  "include": ["*.d.ts"]
+}