@axinom/mosaic-e2e-page-model 0.1.0-rc.3

package/dist/ui-selectors/ui-shell-model.js

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UiShellModel = void 0;
+const mosaic_e2e_ui_selectors_1 = require("@axinom/mosaic-e2e-ui-selectors");
+/**
+ * A model representing the Mosaic UI including methods for navigation.
+ * This model should be used for page and UI components which are provided by Mosaic as a service.
+ *
+ * Use this model to interact with:
+ * - The breadcrumbs bar (on any page)
+ * - The landing page
+ * - The settings hub page
+ * - Pages, settings or mod*a*ls of any managed service (Image, Video, Monetization, etc)
+ */
+class UiShellModel {
+    constructor(
+    /** The playwright page object. */
+    page) {
+        this.page = page;
+        /** A model for the breadcrumbs bar. */
+        this.breadcrumbs = new mosaic_e2e_ui_selectors_1.Breadcrumbs(this.page);
+        /** A model for the header on the landing page. */
+        this.landingPageHeader = new mosaic_e2e_ui_selectors_1.LandingPageHeader(this.page);
+        /** A model for the landing page tiles. */
+        this.landingPageTiles = new mosaic_e2e_ui_selectors_1.LandingPageTiles(this.page);
+        /** A model for the settings page header. */
+        this.settingsPageHeader = new mosaic_e2e_ui_selectors_1.PageHeader(this.page);
+        /** A model for the settings pages navigation hub. */
+        this.settingsPageHub = new mosaic_e2e_ui_selectors_1.Hub(this.page);
+    }
+    /**
+     * This method navigates to the landing page breadcrumb.
+     * The management system must be loaded & signed in before using this method.
+     *
+     * The following steps will be taken:
+     * - Click the first (home) breadcrumb
+     * - Wait for a page transition to complete
+     */
+    async navigateToBreadcrumbHome() {
+        const breadcrumb = this.breadcrumbs.getBreadcrumb(1);
+        try {
+            await breadcrumb.getLocator().waitFor({ state: 'visible' });
+        }
+        catch (_a) {
+            throw new Error(`The breadcrumbs home button is not visible. Is the management system loaded and signed in?`);
+        }
+        await breadcrumb.navigate();
+    }
+    /**
+     * This method navigates to the 'previous' breadcrumb.
+     * The management system must be loaded & signed in before using this method.
+     *
+     * The following steps will be taken:
+     * - Click the last-but-one breadcrumb
+     * - Wait for a page transition to complete
+     */
+    async navigateToBreadcrumbPrevious() {
+        const breadcrumb = this.breadcrumbs.getBreadcrumb(-2);
+        try {
+            await breadcrumb.getLocator().waitFor({ state: 'visible' });
+        }
+        catch (_a) {
+            throw new Error(`The 'previous' breadcrumb button is not visible. Is the management system loaded and signed in? Are there at least 3 breadcrumbs visible?`);
+        }
+        await breadcrumb.navigate();
+    }
+    /**
+     * This method navigates to the 'refresh' breadcrumb.
+     * The management system must be loaded & signed in before using this method.
+     *
+     * The following steps will be taken:
+     * - Click the last breadcrumb
+     * - Wait for a page transition to complete
+     */
+    async navigateToBreadcrumbRefresh() {
+        const breadcrumb = this.breadcrumbs.getBreadcrumb(-1);
+        try {
+            await breadcrumb.getLocator().waitFor({ state: 'visible' });
+        }
+        catch (_a) {
+            throw new Error(`The 'refresh' breadcrumb button is not visible. Is the management system loaded and signed in? Are there at least 2 breadcrumbs visible?`);
+        }
+        await breadcrumb.navigate();
+    }
+    /**
+     * This method navigates to a landing page tile by label.
+     * The management system must be loaded & signed in before using this method.
+     *
+     * The following steps will be taken:
+     * - Navigate to the home breadcrumb
+     * - Navigate to a tile by label
+     * - Wait for a page transition to complete
+     */
+    async navigateToLandingPageTile(label) {
+        const tile = this.landingPageTiles.getTileByLabel(label);
+        await this.navigateToBreadcrumbHome();
+        try {
+            await tile.getLocator().waitFor({ state: 'visible' });
+        }
+        catch (_a) {
+            throw new Error(`Landing page tile with label '${label}' is not visible. Is the label correct? Is the service enabled for this environment?`);
+        }
+        await tile.navigate();
+    }
+    /**
+     * This method navigates to a settings page tile by label.
+     * The management system must be loaded & signed in before using this method.
+     *
+     * The following steps will be taken:
+     * - Navigate to the home breadcrumb
+     * - Navigate to the 'Settings' tile
+     * - Navigate to a tile by group label and tile label
+     * - Wait for a page transition to complete
+     */
+    async navigateToSettingsTile(groupLabel, tileLabel) {
+        await this.navigateToLandingPageTile('Settings');
+        const tile = this.settingsPageHub
+            .getGroupByLabel(groupLabel)
+            .getTileByLabel(tileLabel);
+        try {
+            await tile.getLocator().waitFor({ state: 'visible' });
+        }
+        catch (_a) {
+            throw new Error(`Settings tile in group '${groupLabel}' with label '${tileLabel}' is not visible. Is the label correct? Is the service enabled for this environment?`);
+        }
+        await tile.navigate();
+    }
+    /** This method waits for a page transition to complete after navigation or page refresh. */
+    async waitForPageTransition() {
+        await (0, mosaic_e2e_ui_selectors_1.waitForPageTransition)(this.page);
+    }
+}
+exports.UiShellModel = UiShellModel;
+//# sourceMappingURL=ui-shell-model.js.map

package/dist/ui-selectors/ui-shell-model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui-shell-model.js","sourceRoot":"","sources":["../../src/ui-selectors/ui-shell-model.ts"],"names":[],"mappings":";;;AAAA,6EAOyC;AAGzC;;;;;;;;;GASG;AACH,MAAa,YAAY;IACvB;IACE,kCAAkC;IACf,IAAU;QAAV,SAAI,GAAJ,IAAI,CAAM;QAG/B,uCAAuC;QAC9B,gBAAW,GAAG,IAAI,qCAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAElD,kDAAkD;QACzC,sBAAiB,GAAG,IAAI,2CAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE9D,0CAA0C;QACjC,qBAAgB,GAAG,IAAI,0CAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE5D,4CAA4C;QACnC,uBAAkB,GAAG,IAAI,oCAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAExD,qDAAqD;QAC5C,oBAAe,GAAG,IAAI,6BAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAf3C,CAAC;IAiBJ;;;;;;;OAOG;IACH,KAAK,CAAC,wBAAwB;QAC5B,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QACrD,IAAI;YACF,MAAM,UAAU,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;SAC7D;QAAC,WAAM;YACN,MAAM,IAAI,KAAK,CACb,4FAA4F,CAC7F,CAAC;SACH;QACD,MAAM,UAAU,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,4BAA4B;QAChC,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QACtD,IAAI;YACF,MAAM,UAAU,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;SAC7D;QAAC,WAAM;YACN,MAAM,IAAI,KAAK,CACb,2IAA2I,CAC5I,CAAC;SACH;QACD,MAAM,UAAU,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,2BAA2B;QAC/B,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QACtD,IAAI;YACF,MAAM,UAAU,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;SAC7D;QAAC,WAAM;YACN,MAAM,IAAI,KAAK,CACb,0IAA0I,CAC3I,CAAC;SACH;QACD,MAAM,UAAU,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,yBAAyB,CAAC,KAAa;QAC3C,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QACzD,MAAM,IAAI,CAAC,wBAAwB,EAAE,CAAC;QACtC,IAAI;YACF,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;SACvD;QAAC,WAAM;YACN,MAAM,IAAI,KAAK,CACb,iCAAiC,KAAK,sFAAsF,CAC7H,CAAC;SACH;QACD,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;IACxB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,sBAAsB,CAC1B,UAAkB,EAClB,SAAiB;QAEjB,MAAM,IAAI,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC;QACjD,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe;aAC9B,eAAe,CAAC,UAAU,CAAC;aAC3B,cAAc,CAAC,SAAS,CAAC,CAAC;QAC7B,IAAI;YACF,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;SACvD;QAAC,WAAM;YACN,MAAM,IAAI,KAAK,CACb,2BAA2B,UAAU,iBAAiB,SAAS,sFAAsF,CACtJ,CAAC;SACH;QACD,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;IACxB,CAAC;IAED,4FAA4F;IAC5F,KAAK,CAAC,qBAAqB;QACzB,MAAM,IAAA,+CAAqB,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;CACF;AAvID,oCAuIC"}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@axinom/mosaic-e2e-page-model",
+  "version": "0.1.0-rc.3",
+  "description": "A page model for testing an Axinom Mosaic Management System with Playwright.",
+  "author": "Axinom",
+  "license": "PROPRIETARY",
+  "keywords": [
+    "axinom",
+    "mosaic",
+    "axinom mosaic"
+  ],
+  "files": [
+    "dist"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "yarn clean && tsc",
+    "build:ci": "yarn workspaces focus && yarn build",
+    "dev": "tsc -w"
+  },
+  "dependencies": {
+    "@axinom/mosaic-e2e-ui-selectors": "^0.1.0-rc.3"
+  },
+  "devDependencies": {
+    "@types/node": "^14.18.0",
+    "eslint-plugin-playwright": "^0.8.0",
+    "playwright-core": "^1.24.2",
+    "rimraf": "^3.0.2",
+    "typescript": "^4.5.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "d3c927a0cd672a877187648d7c1725224447ee3a"
+}