@code.pops/js-test-tools 1.0.0

package/README.md

@@ -0,0 +1,7 @@
+# jsTestTools
+
+A collection of wrapper functions around common javascript test frameworks. Support for Playwright currently, but more to come.
+
+## Who to contact
+
+Send an email to: [copepops](mailto:codepops@mailbox.org)

package/dist/async-function-tuple.d.ts

@@ -0,0 +1,5 @@
+export type AsyncFunctionTuple = [
+    (...args: any[]) => Promise<unknown>,
+    ...unknown[]
+];
+//# sourceMappingURL=async-function-tuple.d.ts.map

package/dist/async-function-tuple.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-function-tuple.d.ts","sourceRoot":"","sources":["../src/async-function-tuple.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,kBAAkB,GAAG;IAC/B,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,OAAO,CAAC;IACpC,GAAG,OAAO,EAAE;CACb,CAAC"}

package/dist/async-function-tuple.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=async-function-tuple.js.map

package/dist/async-function-tuple.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-function-tuple.js","sourceRoot":"","sources":["../src/async-function-tuple.ts"],"names":[],"mappings":""}

package/dist/get-by-role-options.d.ts

@@ -0,0 +1,12 @@
+type GetByRoleOptions = {
+    checked?: boolean;
+    disabled?: boolean;
+    exact?: boolean;
+    expanded?: boolean;
+    includeHidden?: boolean;
+    level?: number;
+    name?: string | RegExp;
+    pressed?: boolean;
+    selected?: boolean;
+};
+//# sourceMappingURL=get-by-role-options.d.ts.map

package/dist/get-by-role-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-by-role-options.d.ts","sourceRoot":"","sources":["../src/get-by-role-options.ts"],"names":[],"mappings":"AAAA,KAAK,gBAAgB,GAAG;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC"}

package/dist/get-by-role-options.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=get-by-role-options.js.map

package/dist/get-by-role-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-by-role-options.js","sourceRoot":"","sources":["../src/get-by-role-options.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./js-test-tools.factory";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from "./js-test-tools.factory";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC"}

package/dist/inner-text.d.ts

@@ -0,0 +1,6 @@
+type KebabToCamel<S extends string> = S extends `${infer Head}-${infer Tail}` ? `${Head}${Capitalize<KebabToCamel<Tail>>}` : S;
+export type InnerText<T extends string> = {
+    [K in T as KebabToCamel<K>]: string;
+};
+export {};
+//# sourceMappingURL=inner-text.d.ts.map

package/dist/inner-text.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inner-text.d.ts","sourceRoot":"","sources":["../src/inner-text.ts"],"names":[],"mappings":"AAAA,KAAK,YAAY,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,GAAG,MAAM,IAAI,IAAI,MAAM,IAAI,EAAE,GACzE,GAAG,IAAI,GAAG,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,GAC1C,CAAC,CAAC;AAEN,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,IAAI;KACvC,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,GAAG,MAAM;CACpC,CAAC"}

package/dist/inner-text.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=inner-text.js.map

package/dist/inner-text.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inner-text.js","sourceRoot":"","sources":["../src/inner-text.ts"],"names":[],"mappings":""}

package/dist/js-test-tools.factory.d.ts

@@ -0,0 +1,4 @@
+import { Page } from "@playwright/test";
+import { jsTestTools } from "./js-test-tools.type";
+export declare function jsTestToolsFactory(page: Page): jsTestTools;
+//# sourceMappingURL=js-test-tools.factory.d.ts.map

package/dist/js-test-tools.factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"js-test-tools.factory.d.ts","sourceRoot":"","sources":["../src/js-test-tools.factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAKnD,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,IAAI,GAAG,WAAW,CAyD1D"}

package/dist/js-test-tools.factory.js

@@ -0,0 +1,39 @@
+export function jsTestToolsFactory(page) {
+    const byId = (locator) => page.getByTestId(locator), byRole = (role, options) => page.getByRole(role, options), clickById = (locator) => byId(locator).click(), clickByRole = (role, options) => byRole(role, options).click(), clickMultipleById = async (locators) => {
+        for (const locator of locators) {
+            await clickById(locator);
+        }
+    }, innerTextById = (locator) => byId(locator).innerText(), innerTextByRole = (role, options) => byRole(role, options).innerText(), goto = (url) => page.goto(url), waitForTimeout = (timeout) => page.waitForTimeout(timeout), waitForResponse = (url) => page.waitForResponse(url), executeSequentially = async (actions) => {
+        for (const action of actions) {
+            if (typeof action === "function")
+                await action();
+            else {
+                const [fn, ...args] = action;
+                await fn(...args);
+            }
+        }
+    };
+    async function multipleInnerTextById(locators) {
+        const result = {};
+        for (const locator of locators) {
+            const key = locator.replace(/-([a-z])/g, (_, char) => char.toUpperCase());
+            result[key] = await innerTextById(locator);
+        }
+        return result;
+    }
+    return {
+        byId,
+        byRole,
+        clickById,
+        clickByRole,
+        clickMultipleById,
+        executeSequentially,
+        goto,
+        innerTextById,
+        innerTextByRole,
+        multipleInnerTextById,
+        waitForResponse,
+        waitForTimeout,
+    };
+}
+//# sourceMappingURL=js-test-tools.factory.js.map

package/dist/js-test-tools.factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"js-test-tools.factory.js","sourceRoot":"","sources":["../src/js-test-tools.factory.ts"],"names":[],"mappings":"AAMA,MAAM,UAAU,kBAAkB,CAAC,IAAU;IAC3C,MAAM,IAAI,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EACzD,MAAM,GAAG,CAAC,IAAW,EAAE,OAA0B,EAAE,EAAE,CACnD,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,EAC/B,SAAS,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EACtD,WAAW,GAAG,CAAC,IAAW,EAAE,OAA0B,EAAE,EAAE,CACxD,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,KAAK,EAAE,EAC/B,iBAAiB,GAAG,KAAK,EAAE,QAAkB,EAAE,EAAE;QAC/C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC,EACD,aAAa,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAC9D,eAAe,GAAG,CAAC,IAAW,EAAE,OAA0B,EAAE,EAAE,CAC5D,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,SAAS,EAAE,EACnC,IAAI,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EACtC,cAAc,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,EAClE,eAAe,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAC5D,mBAAmB,GAAG,KAAK,EACzB,OAAkE,EAClE,EAAE;QACF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,OAAO,MAAM,KAAK,UAAU;gBAAE,MAAM,MAAM,EAAE,CAAC;iBAC5C,CAAC;gBACJ,MAAM,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,GAAG,MAAM,CAAC;gBAC7B,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;YACpB,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IAEJ,KAAK,UAAU,qBAAqB,CAClC,QAAsB;QAEtB,MAAM,MAAM,GAA2B,EAAE,CAAC;QAE1C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;YAC1E,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,aAAa,CAAC,OAAO,CAAC,CAAC;QAC7C,CAAC;QAED,OAAO,MAAsB,CAAC;IAChC,CAAC;IAED,OAAO;QACL,IAAI;QACJ,MAAM;QACN,SAAS;QACT,WAAW;QACX,iBAAiB;QACjB,mBAAmB;QACnB,IAAI;QACJ,aAAa;QACb,eAAe;QACf,qBAAqB;QACrB,eAAe;QACf,cAAc;KACf,CAAC;AACJ,CAAC"}

package/dist/js-test-tools.type.d.ts

@@ -0,0 +1,19 @@
+import { Locator, Response } from "@playwright/test";
+import { Roles } from "./roles";
+import { AsyncFunctionTuple } from "./async-function-tuple";
+import { InnerText } from "./inner-text";
+export type jsTestTools = {
+    byId: (locator: string) => Locator;
+    byRole: (role: Roles, options?: GetByRoleOptions) => Locator;
+    clickById: (locator: string) => Promise<void>;
+    clickByRole: (role: Roles, options?: GetByRoleOptions) => Promise<void>;
+    clickMultipleById: (locators: string[]) => Promise<void>;
+    executeSequentially: (actions: Array<() => Promise<unknown>> | Array<AsyncFunctionTuple>) => Promise<void>;
+    goto: (url: string) => Promise<Response | null>;
+    innerTextById: (locator: string) => Promise<string>;
+    innerTextByRole: (role: Roles, options?: GetByRoleOptions) => Promise<string>;
+    multipleInnerTextById<T extends string>(locators: readonly T[]): Promise<InnerText<T>>;
+    waitForTimeout: (timeout: number) => Promise<void>;
+    waitForResponse: (url: string) => Promise<Response>;
+};
+//# sourceMappingURL=js-test-tools.type.d.ts.map

package/dist/js-test-tools.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"js-test-tools.type.d.ts","sourceRoot":"","sources":["../src/js-test-tools.type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC;IACnC,MAAM,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,gBAAgB,KAAK,OAAO,CAAC;IAC7D,SAAS,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C,WAAW,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,gBAAgB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACxE,iBAAiB,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,mBAAmB,EAAE,CACnB,OAAO,EAAE,KAAK,CAAC,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,KAAK,CAAC,kBAAkB,CAAC,KAC/D,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC;IAChD,aAAa,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IACpD,eAAe,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,gBAAgB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9E,qBAAqB,CAAC,CAAC,SAAS,MAAM,EACpC,QAAQ,EAAE,SAAS,CAAC,EAAE,GACrB,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IACzB,cAAc,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnD,eAAe,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;CACrD,CAAC"}

package/dist/js-test-tools.type.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=js-test-tools.type.js.map

package/dist/js-test-tools.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"js-test-tools.type.js","sourceRoot":"","sources":["../src/js-test-tools.type.ts"],"names":[],"mappings":""}

package/dist/kebab-to-camel.d.ts

@@ -0,0 +1,2 @@
+export type KebabToCamel<S extends string> = S extends `${infer Head}-${infer Tail}` ? `${Head}${Capitalize<KebabToCamel<Tail>>}` : S;
+//# sourceMappingURL=kebab-to-camel.d.ts.map

package/dist/kebab-to-camel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kebab-to-camel.d.ts","sourceRoot":"","sources":["../src/kebab-to-camel.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,IACvC,CAAC,SAAS,GAAG,MAAM,IAAI,IAAI,MAAM,IAAI,EAAE,GACnC,GAAG,IAAI,GAAG,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,GAC1C,CAAC,CAAC"}

package/dist/kebab-to-camel.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=kebab-to-camel.js.map

package/dist/kebab-to-camel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"kebab-to-camel.js","sourceRoot":"","sources":["../src/kebab-to-camel.ts"],"names":[],"mappings":""}

package/dist/roles.d.ts

@@ -0,0 +1,2 @@
+export type Roles = "alert" | "alertdialog" | "application" | "article" | "banner" | "blockquote" | "button" | "caption" | "cell" | "checkbox" | "code" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "deletion" | "dialog" | "directory" | "document" | "emphasis" | "feed" | "figure" | "form" | "generic" | "grid" | "gridcell" | "group" | "heading" | "img" | "insertion" | "link" | "list" | "listbox" | "listitem" | "log" | "main" | "marquee" | "math" | "meter" | "menu" | "menubar" | "menuitem" | "menuitemcheckbox" | "menuitemradio" | "navigation" | "none" | "note" | "option" | "paragraph" | "presentation" | "progressbar" | "radio" | "radiogroup" | "region" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "search" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "strong" | "subscript" | "superscript" | "switch" | "tab" | "table" | "tablist" | "tabpanel" | "term" | "textbox" | "time" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem";
+//# sourceMappingURL=roles.d.ts.map

package/dist/roles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"roles.d.ts","sourceRoot":"","sources":["../src/roles.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,KAAK,GACb,OAAO,GACP,aAAa,GACb,aAAa,GACb,SAAS,GACT,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,MAAM,GACN,cAAc,GACd,UAAU,GACV,eAAe,GACf,aAAa,GACb,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,WAAW,GACX,UAAU,GACV,UAAU,GACV,MAAM,GACN,QAAQ,GACR,MAAM,GACN,SAAS,GACT,MAAM,GACN,UAAU,GACV,OAAO,GACP,SAAS,GACT,KAAK,GACL,WAAW,GACX,MAAM,GACN,MAAM,GACN,SAAS,GACT,UAAU,GACV,KAAK,GACL,MAAM,GACN,SAAS,GACT,MAAM,GACN,OAAO,GACP,MAAM,GACN,SAAS,GACT,UAAU,GACV,kBAAkB,GAClB,eAAe,GACf,YAAY,GACZ,MAAM,GACN,MAAM,GACN,QAAQ,GACR,WAAW,GACX,cAAc,GACd,aAAa,GACb,OAAO,GACP,YAAY,GACZ,QAAQ,GACR,KAAK,GACL,UAAU,GACV,WAAW,GACX,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,WAAW,GACX,aAAa,GACb,QAAQ,GACR,KAAK,GACL,OAAO,GACP,SAAS,GACT,UAAU,GACV,MAAM,GACN,SAAS,GACT,MAAM,GACN,OAAO,GACP,SAAS,GACT,SAAS,GACT,MAAM,GACN,UAAU,GACV,UAAU,CAAC"}

package/dist/roles.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=roles.js.map

package/dist/roles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"roles.js","sourceRoot":"","sources":["../src/roles.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@code.pops/js-test-tools",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "pack": "mkdir -p package && npm pack --pack-destination ./package",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "codePops <codepops@mailbox.org>",
+  "license": "ISC",
+  "description": "A collection of wrapper functions around common javascript test frameworks. Support for Playwright currently, but more to come.",
+  "devDependencies": {
+    "@playwright/test": "^1.58.2",
+    "eslint-plugin-playwright": "^2.8.0",
+    "typescript": "^5.9.3"
+  }
+}