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

package/README.md

@@ -0,0 +1,22 @@
+# @axinom/mosaic-e2e-page-model
+
+## About the Package
+
+This package is part of the Axinom Mosaic development platform. More information
+can be found at https://portal.axinom.com/mosaic.
+
+This library models the Mosaic management system for use in Playwright tests.
+The shell UI and managed services are modelled.
+
+Customized services should be modelled with `@axinom/mosaic-e2e-ui-selectors`
+which is intended to be used in concert with this library.
+
+## License
+
+This package can be licensed under the
+[Axinom Products Licensing Agreement](https://portal.axinom.com/mosaic/contracts/products-licensing-agreement)
+or evaluated under the
+[Axinom Products Evaluation Agreement](https://portal.axinom.com/mosaic/contracts/products-evaluation-agreement).  
+No part of Axinom's software may be copied, modified, propagated, or distributed
+except in accordance with the terms contained in the Axinom Products Licensing
+Agreement and Axinom Products Evaluation Agreement.

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from './managed-services';
+export * from './page-model';
+export * from './service-model';
+export * from './sign-in';
+export * from './ui-selectors';
+//# 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,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./managed-services"), exports);
+__exportStar(require("./page-model"), exports);
+__exportStar(require("./service-model"), exports);
+__exportStar(require("./sign-in"), exports);
+__exportStar(require("./ui-selectors"), exports);
+//# 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,qDAAmC;AACnC,+CAA6B;AAC7B,kDAAgC;AAChC,4CAA0B;AAC1B,iDAA+B"}

package/dist/managed-services/image-selection-explorer.d.ts

@@ -0,0 +1,16 @@
+import { SelectionExplorer } from '@axinom/mosaic-e2e-ui-selectors';
+/** A mod*e*l for the mod*a*l image explorer component used to select images. */
+export declare class ImageSelectionExplorer extends SelectionExplorer {
+    /**
+     * Select an image by title.
+     * If the image explorer modal is not showing or the selected title does not exist then an exception will be raised.
+     *
+     * The following steps will be taken:
+     * - Verify that the page header title is 'Select Image'
+     * - Filter by title and verify that at least one result is shown
+     * - Select the first result by row action
+     * - Wait for the modal to be closed
+     */
+    selectImage(imageTitle: string): Promise<void>;
+}
+//# sourceMappingURL=image-selection-explorer.d.ts.map

package/dist/managed-services/image-selection-explorer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-selection-explorer.d.ts","sourceRoot":"","sources":["../../src/managed-services/image-selection-explorer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAEpE,gFAAgF;AAChF,qBAAa,sBAAuB,SAAQ,iBAAiB;IAC3D;;;;;;;;;OASG;IACG,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAwBrD"}

package/dist/managed-services/image-selection-explorer.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImageSelectionExplorer = void 0;
+const mosaic_e2e_ui_selectors_1 = require("@axinom/mosaic-e2e-ui-selectors");
+/** A mod*e*l for the mod*a*l image explorer component used to select images. */
+class ImageSelectionExplorer extends mosaic_e2e_ui_selectors_1.SelectionExplorer {
+    /**
+     * Select an image by title.
+     * If the image explorer modal is not showing or the selected title does not exist then an exception will be raised.
+     *
+     * The following steps will be taken:
+     * - Verify that the page header title is 'Select Image'
+     * - Filter by title and verify that at least one result is shown
+     * - Select the first result by row action
+     * - Wait for the modal to be closed
+     */
+    async selectImage(imageTitle) {
+        // verify the modal header
+        await this.pageHeader.title.waitFor({ state: 'visible' });
+        if ((await this.pageHeader.title.textContent()) !== 'Select Image') {
+            throw new Error('Image explorer modal must be showing.');
+        }
+        await this.list.waitForData();
+        await this.filters
+            .getFilterByName('title')
+            .asFreeTextFilter()
+            .setValue(imageTitle);
+        await this.list.waitForData();
+        // verify that one result is showing
+        if ((await this.list.allVisibleRows.count()) === 0) {
+            throw new Error('An image with the specified title was not found.');
+        }
+        await this.list.getRow(1).selectButton.click();
+        // wait for the modal to close
+        await this.pageHeader.title.waitFor({ state: 'detached' });
+    }
+}
+exports.ImageSelectionExplorer = ImageSelectionExplorer;
+//# sourceMappingURL=image-selection-explorer.js.map

package/dist/managed-services/image-selection-explorer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-selection-explorer.js","sourceRoot":"","sources":["../../src/managed-services/image-selection-explorer.ts"],"names":[],"mappings":";;;AAAA,6EAAoE;AAEpE,gFAAgF;AAChF,MAAa,sBAAuB,SAAQ,2CAAiB;IAC3D;;;;;;;;;OASG;IACH,KAAK,CAAC,WAAW,CAAC,UAAkB;QAClC,0BAA0B;QAC1B,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,KAAK,cAAc,EAAE;YAClE,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;SAC1D;QACD,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QAE9B,MAAM,IAAI,CAAC,OAAO;aACf,eAAe,CAAC,OAAO,CAAC;aACxB,gBAAgB,EAAE;aAClB,QAAQ,CAAC,UAAU,CAAC,CAAC;QACxB,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QAE9B,oCAAoC;QACpC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,EAAE;YAClD,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;SACrE;QAED,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QAE/C,8BAA8B;QAC9B,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;IAC7D,CAAC;CACF;AAnCD,wDAmCC"}

package/dist/managed-services/image-service.d.ts

@@ -0,0 +1,65 @@
+import { ImageSelectionExplorer } from './image-selection-explorer';
+import { ManagedServiceModel } from './managed-service-model';
+/** A model for the managed image service. */
+export declare class ImageService extends ManagedServiceModel {
+    /**
+     * This method navigates to an image details station by title.
+     * The management system must be loaded & signed in before using this method.
+     * If there is not exactly one matching image an exception will be raised.
+     *
+     * The following steps will be taken:
+     * - Navigate to the home breadcrumb then the 'Images' tile
+     * - Filter by title and verify that a single result is shown
+     * - Click the image row action
+     * - Wait for the image details station to load
+     */
+    navigateToImageDetails(filterBy: {
+        title: string;
+    }): Promise<void>;
+    /**
+     * This method uploads an image file from the local file system.
+     * The management system must be loaded & signed in before using this method.
+     * A unique image title and a valid image type must be provided.
+     *
+     * The following steps will be taken:
+     * - Navigate to the home breadcrumb then the 'Images' tile
+     * - Click the 'Upload' action
+     * - Enter file and image type inputs then click 'Proceed'
+     * - Edit the image title
+     * - Click the 'refresh' breadcrumb and wait for the image details station to reload
+     */
+    uploadImage(properties: {
+        /** Path to a local image file. */
+        localFilename: string;
+        /** A unique image title. */
+        title: string;
+        /** An existing image type. */
+        imageType: string;
+    }): Promise<void>;
+    /**
+     * This method archives an image by title.
+     * The management system must be loaded & signed in before using this method.
+     * If a single matching, non-archived image is not found then an exception will be raised.
+     *
+     * The following steps will be taken:
+     * - Navigate to the home breadcrumb then the 'Images' tile
+     * - Filter by title and verify that a single result is shown
+     * - Navigate to the image with the row action
+     * - Click 'Archive' and confirm
+     * - Wait for the image explorer station to load
+     */
+    archiveImage(filters: {
+        title: string;
+    }): Promise<void>;
+    /**
+     * A reference to the ImageSelectionExplorer component mod*e*l which can be used
+     * to select images in a mod*a*l. e.g.
+     * ```
+     * await app.ui.form.modal
+     *  .as(app.imageService.ImageSelectionExplorer)
+     *  .selectImage('My image title');
+     * ```
+     */
+    readonly ImageSelectionExplorer: typeof ImageSelectionExplorer;
+}
+//# sourceMappingURL=image-service.d.ts.map

package/dist/managed-services/image-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-service.d.ts","sourceRoot":"","sources":["../../src/managed-services/image-service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAE9D,6CAA6C;AAC7C,qBAAa,YAAa,SAAQ,mBAAmB;IACnD;;;;;;;;;;OAUG;IACG,sBAAsB,CAAC,QAAQ,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAyBxE;;;;;;;;;;;OAWG;IACG,WAAW,CAAC,UAAU,EAAE;QAC5B,kCAAkC;QAClC,aAAa,EAAE,MAAM,CAAC;QACtB,4BAA4B;QAC5B,KAAK,EAAE,MAAM,CAAC;QACd,8BAA8B;QAC9B,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,IAAI,CAAC;IAkCjB;;;;;;;;;;;OAWG;IACG,YAAY,CAAC,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAc7D;;;;;;;;OAQG;IACH,QAAQ,CAAC,sBAAsB,gCAA0B;CAC1D"}

package/dist/managed-services/image-service.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImageService = void 0;
+const mosaic_e2e_ui_selectors_1 = require("@axinom/mosaic-e2e-ui-selectors");
+const image_selection_explorer_1 = require("./image-selection-explorer");
+const managed_service_model_1 = require("./managed-service-model");
+/** A model for the managed image service. */
+class ImageService extends managed_service_model_1.ManagedServiceModel {
+    constructor() {
+        super(...arguments);
+        /**
+         * A reference to the ImageSelectionExplorer component mod*e*l which can be used
+         * to select images in a mod*a*l. e.g.
+         * ```
+         * await app.ui.form.modal
+         *  .as(app.imageService.ImageSelectionExplorer)
+         *  .selectImage('My image title');
+         * ```
+         */
+        this.ImageSelectionExplorer = image_selection_explorer_1.ImageSelectionExplorer;
+    }
+    /**
+     * This method navigates to an image details station by title.
+     * The management system must be loaded & signed in before using this method.
+     * If there is not exactly one matching image an exception will be raised.
+     *
+     * The following steps will be taken:
+     * - Navigate to the home breadcrumb then the 'Images' tile
+     * - Filter by title and verify that a single result is shown
+     * - Click the image row action
+     * - Wait for the image details station to load
+     */
+    async navigateToImageDetails(filterBy) {
+        const { form, list, filters } = this.uiManagedWorkflows;
+        await this.uiShell.navigateToLandingPageTile('Images');
+        await list.waitForData();
+        // filter to the item
+        await filters
+            .getFilterByName('title')
+            .asFreeTextFilter()
+            .setValue(filterBy.title);
+        await list.waitForData();
+        // Verify that there is exactly one matching row
+        if ((await list.allVisibleRows.count()) !== 1) {
+            throw new Error(`Failed to find exactly one image with title '${filterBy.title}'.`);
+        }
+        // navigate
+        await list.getRow(1).actionButton.click();
+        await this.uiShell.waitForPageTransition();
+        await form.waitForData();
+    }
+    /**
+     * This method uploads an image file from the local file system.
+     * The management system must be loaded & signed in before using this method.
+     * A unique image title and a valid image type must be provided.
+     *
+     * The following steps will be taken:
+     * - Navigate to the home breadcrumb then the 'Images' tile
+     * - Click the 'Upload' action
+     * - Enter file and image type inputs then click 'Proceed'
+     * - Edit the image title
+     * - Click the 'refresh' breadcrumb and wait for the image details station to reload
+     */
+    async uploadImage(properties) {
+        const { form, pageHeader, actions } = this.uiManagedWorkflows;
+        await this.uiShell.navigateToLandingPageTile('Images');
+        await pageHeader.actions.getActionByLabel('Upload').click();
+        await this.uiShell.waitForPageTransition();
+        // Setting image upload input
+        await form
+            .getFieldByName('file')
+            .asFileUploadField()
+            .setValue(properties.localFilename);
+        // Set image type.
+        await form
+            .getFieldByName('imageType')
+            .asSelectField()
+            .setValue(properties.imageType);
+        // Submitting the upload
+        await actions.getActionByLabel(mosaic_e2e_ui_selectors_1.ActionLabel.Proceed).click();
+        await this.uiShell.waitForPageTransition();
+        await form.waitForData();
+        // Set image title.
+        await form
+            .getFieldByName('title')
+            .asSingleLineTextField()
+            .setValue(properties.title);
+        // Refresh to save
+        await this.uiShell.navigateToBreadcrumbRefresh();
+        await form.waitForData();
+    }
+    /**
+     * This method archives an image by title.
+     * The management system must be loaded & signed in before using this method.
+     * If a single matching, non-archived image is not found then an exception will be raised.
+     *
+     * The following steps will be taken:
+     * - Navigate to the home breadcrumb then the 'Images' tile
+     * - Filter by title and verify that a single result is shown
+     * - Navigate to the image with the row action
+     * - Click 'Archive' and confirm
+     * - Wait for the image explorer station to load
+     */
+    async archiveImage(filters) {
+        const { list, actions } = this.uiManagedWorkflows;
+        await this.navigateToImageDetails(filters);
+        try {
+            await actions.getActionByLabel('Archive').waitFor({ state: 'visible' });
+        }
+        catch (_a) {
+            throw new Error(`The image archive button is not visible.`);
+        }
+        await actions.getActionByLabel('Archive').click();
+        await actions.confirmButton.click();
+        await this.uiShell.waitForPageTransition();
+        await list.waitForData();
+    }
+}
+exports.ImageService = ImageService;
+//# sourceMappingURL=image-service.js.map

package/dist/managed-services/image-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-service.js","sourceRoot":"","sources":["../../src/managed-services/image-service.ts"],"names":[],"mappings":";;;AAAA,6EAA8D;AAC9D,yEAAoE;AACpE,mEAA8D;AAE9D,6CAA6C;AAC7C,MAAa,YAAa,SAAQ,2CAAmB;IAArD;;QAoHE;;;;;;;;WAQG;QACM,2BAAsB,GAAG,iDAAsB,CAAC;IAC3D,CAAC;IA7HC;;;;;;;;;;OAUG;IACH,KAAK,CAAC,sBAAsB,CAAC,QAA2B;QACtD,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC;QACxD,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC;QACvD,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAEzB,qBAAqB;QACrB,MAAM,OAAO;aACV,eAAe,CAAC,OAAO,CAAC;aACxB,gBAAgB,EAAE;aAClB,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC5B,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAEzB,gDAAgD;QAChD,IAAI,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,EAAE;YAC7C,MAAM,IAAI,KAAK,CACb,gDAAgD,QAAQ,CAAC,KAAK,IAAI,CACnE,CAAC;SACH;QAED,WAAW;QACX,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QAC1C,MAAM,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;QAC3C,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,WAAW,CAAC,UAOjB;QACC,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAC9D,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC;QACvD,MAAM,UAAU,CAAC,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC;QAC5D,MAAM,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;QAE3C,6BAA6B;QAC7B,MAAM,IAAI;aACP,cAAc,CAAC,MAAM,CAAC;aACtB,iBAAiB,EAAE;aACnB,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAEtC,kBAAkB;QAClB,MAAM,IAAI;aACP,cAAc,CAAC,WAAW,CAAC;aAC3B,aAAa,EAAE;aACf,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAElC,wBAAwB;QACxB,MAAM,OAAO,CAAC,gBAAgB,CAAC,qCAAW,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC;QAC5D,MAAM,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;QAC3C,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAEzB,mBAAmB;QACnB,MAAM,IAAI;aACP,cAAc,CAAC,OAAO,CAAC;aACvB,qBAAqB,EAAE;aACvB,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAE9B,kBAAkB;QAClB,MAAM,IAAI,CAAC,OAAO,CAAC,2BAA2B,EAAE,CAAC;QACjD,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,YAAY,CAAC,OAA0B;QAC3C,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAClD,MAAM,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI;YACF,MAAM,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;SACzE;QAAC,WAAM;YACN,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;SAC7D;QACD,MAAM,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,CAAC;QAClD,MAAM,OAAO,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;QACpC,MAAM,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;QAC3C,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;IAC3B,CAAC;CAYF;AA9HD,oCA8HC"}

package/dist/managed-services/index.d.ts

@@ -0,0 +1,4 @@
+export * from './image-selection-explorer';
+export * from './image-service';
+export * from './monetization-service';
+//# sourceMappingURL=index.d.ts.map

package/dist/managed-services/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/managed-services/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC"}

package/dist/managed-services/index.js

@@ -0,0 +1,16 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./image-selection-explorer"), exports);
+__exportStar(require("./image-service"), exports);
+__exportStar(require("./monetization-service"), exports);
+//# sourceMappingURL=index.js.map

package/dist/managed-services/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/managed-services/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6DAA2C;AAC3C,kDAAgC;AAChC,yDAAuC"}

package/dist/managed-services/managed-service-model.d.ts

@@ -0,0 +1,46 @@
+import { UiWorkflowsModel } from '@axinom/mosaic-e2e-ui-selectors';
+import { Page } from 'playwright-core';
+import { UiShellModel } from '../ui-selectors/ui-shell-model';
+/**
+ * An abstract model representing a Mosaic managed service.
+ */
+export declare abstract class ManagedServiceModel {
+    /** The playwright page object. */
+    protected readonly page: Page;
+    /**
+     * A model representing the Mosaic UI shell including methods for navigation.
+     *
+     * Use this model to interact with:
+     * - The breadcrumbs bar (on any page)
+     * - The landing page
+     * - The settings hub page
+     */
+    protected readonly uiShell: UiShellModel;
+    /**
+     * A model representing Mosaic UI workflows.
+     *
+     * Use this model to interact with workflows or mod*a*ls of any managed
+     * service (Image, Video, Monetization, etc).
+     */
+    protected readonly uiManagedWorkflows: UiWorkflowsModel;
+    constructor(
+    /** The playwright page object. */
+    page: Page, 
+    /**
+     * A model representing the Mosaic UI shell including methods for navigation.
+     *
+     * Use this model to interact with:
+     * - The breadcrumbs bar (on any page)
+     * - The landing page
+     * - The settings hub page
+     */
+    uiShell: UiShellModel, 
+    /**
+     * A model representing Mosaic UI workflows.
+     *
+     * Use this model to interact with workflows or mod*a*ls of any managed
+     * service (Image, Video, Monetization, etc).
+     */
+    uiManagedWorkflows: UiWorkflowsModel);
+}
+//# sourceMappingURL=managed-service-model.d.ts.map

package/dist/managed-services/managed-service-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"managed-service-model.d.ts","sourceRoot":"","sources":["../../src/managed-services/managed-service-model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAE9D;;GAEG;AACH,8BAAsB,mBAAmB;IAErC,kCAAkC;IAClC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI;IAE7B;;;;;;;OAOG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,YAAY;IAExC;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,gBAAgB;;IAnBvD,kCAAkC;IACf,IAAI,EAAE,IAAI;IAE7B;;;;;;;OAOG;IACgB,OAAO,EAAE,YAAY;IAExC;;;;;OAKG;IACgB,kBAAkB,EAAE,gBAAgB;CAE1D"}

package/dist/managed-services/managed-service-model.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManagedServiceModel = void 0;
+/**
+ * An abstract model representing a Mosaic managed service.
+ */
+class ManagedServiceModel {
+    constructor(
+    /** The playwright page object. */
+    page, 
+    /**
+     * A model representing the Mosaic UI shell including methods for navigation.
+     *
+     * Use this model to interact with:
+     * - The breadcrumbs bar (on any page)
+     * - The landing page
+     * - The settings hub page
+     */
+    uiShell, 
+    /**
+     * A model representing Mosaic UI workflows.
+     *
+     * Use this model to interact with workflows or mod*a*ls of any managed
+     * service (Image, Video, Monetization, etc).
+     */
+    uiManagedWorkflows) {
+        this.page = page;
+        this.uiShell = uiShell;
+        this.uiManagedWorkflows = uiManagedWorkflows;
+    }
+}
+exports.ManagedServiceModel = ManagedServiceModel;
+//# sourceMappingURL=managed-service-model.js.map

package/dist/managed-services/managed-service-model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"managed-service-model.js","sourceRoot":"","sources":["../../src/managed-services/managed-service-model.ts"],"names":[],"mappings":";;;AAIA;;GAEG;AACH,MAAsB,mBAAmB;IACvC;IACE,kCAAkC;IACf,IAAU;IAE7B;;;;;;;OAOG;IACgB,OAAqB;IAExC;;;;;OAKG;IACgB,kBAAoC;QAlBpC,SAAI,GAAJ,IAAI,CAAM;QAUV,YAAO,GAAP,OAAO,CAAc;QAQrB,uBAAkB,GAAlB,kBAAkB,CAAkB;IACtD,CAAC;CACL;AAvBD,kDAuBC"}

package/dist/managed-services/monetization-service.d.ts

@@ -0,0 +1,208 @@
+import { ManagedServiceModel } from './managed-service-model';
+/** A model for the managed monetization service. */
+export declare class MonetizationService extends ManagedServiceModel {
+    /** Verify the URL is a subscription plan details station. */
+    private verifySubscriptionPlanDetailsUrl;
+    /** Verify the URL is a payment plan details station. */
+    private verifyPaymentPlanDetailsUrl;
+    /** Verify the URL is a claim set details station. */
+    private verifyClaimSetDetailsUrl;
+    /**
+     * This method navigates to the subscription plans explorer station.
+     * The management system must be loaded & signed in before using this method.
+     *
+     * The following steps will be taken:
+     * - Navigate to the home breadcrumb, then tiles: 'Monetization', 'Subscription Plans'
+     * - Wait for the page transition to complete
+     */
+    navigateToSubscriptionPlans(): Promise<void>;
+    /**
+     * This method navigates to the claim sets explorer station.
+     * The management system must be loaded & signed in before using this method.
+     *
+     * The following steps will be taken:
+     * - Navigate to the home breadcrumb, then tiles: 'Monetization', 'Claim Sets'
+     * - Wait for the page transition to complete
+     */
+    navigateToClaimSets(): Promise<void>;
+    /**
+     * This method navigates to a subscription plan details station by title.
+     * The management system must be loaded & signed in before using this method.
+     * If there is not exactly one matching subscription plan an exception will be raised.
+     *
+     * The following steps will be taken:
+     * - Navigate to the home breadcrumb, then tiles: 'Monetization', 'Subscription Plans'
+     * - Filter by title and verify that a single result is shown
+     * - Click the subscription plan row action
+     * - Wait for the subscription plan details page to load
+     */
+    navigateToSubscriptionPlanDetails(filterBy: {
+        title: string;
+    }): Promise<void>;
+    /**
+     * This method navigates to a claim set details station by unique key.
+     * The management system must be loaded & signed in before using this method.
+     * If there is not exactly one matching claim set an exception will be raised.
+     *
+     * The following steps will be taken:
+     * - Navigate to the home breadcrumb, then tiles: 'Monetization', 'Claim Sets'
+     * - Filter by unique key and verify that a single result is shown
+     * - Click the claim set row action
+     * - Wait for the claim set details station to load
+     */
+    navigateToClaimSetDetails(filterBy: {
+        uniqueKey: string;
+    }): Promise<void>;
+    /**
+     * This method creates a new subscription plan.
+     * The management system must be loaded & signed in before using this method.
+     * When this method completes, the new subscription plan details station will be loaded.
+     *
+     * The following steps will be taken:
+     * - Navigate to the home breadcrumb, then tiles: 'Monetization', 'Subscription Plans'
+     * - Click 'NEW', enter the title then click 'Proceed'
+     * - Wait for the subscription plan details station to load
+     */
+    createSubscriptionPlan(properties: {
+        title: string;
+    }): Promise<void>;
+    /**
+     * This method configures a payment provider for the subscription plan.
+     * The subscription plan details station must be loaded before using this method.
+     * If the payment provider is not enabled for the environment, or is already added an exception will be raised.
+     *
+     * The following steps will be taken:
+     * - Verify that a subscription plan details station is loaded
+     * - Add a payment provider by key, and set the external Id field (if it is shown).
+     * - Click the 'refresh' breadcrumb and wait for the subscription plan details station to reload
+     */
+    subscriptionPlanAddPaymentProvider(paymentProviderSettings: {
+        providerKey: string;
+        externalId?: string;
+    }): Promise<void>;
+    /**
+     * This method assigns a claim set to the subscription plan.
+     * The subscription plan details station must be loaded before using this method.
+     * If the claim set does not exist, or is already added to this subscription plan then an exception will be raised.
+     *
+     * The following steps will be taken:
+     * - Verify that a subscription plan details station is loaded
+     * - Click 'Claim Sets'
+     * - Open the claim sets explorer modal, filter by key and select the first result
+     * - Click the 'previous' breadcrumb and wait for the subscription plan details station to load
+     */
+    subscriptionPlanAssignClaimSet(claimSetKey: string): Promise<void>;
+    /**
+     * This method publishes the subscription plan.
+     * The subscription plan details station must be loaded before using this method.
+     * If the subscription plan cannot be published then an exception will be raised.
+     *
+     * The following steps will be taken:
+     * - Verify that a subscription plan details station is loaded
+     * - Click 'Publishing'
+     * - Click 'Publish' and confirm
+     * - Wait for the subscription plan details station to load and verify that the publication state is 'PUBLISHED'
+     */
+    subscriptionPlanPublish(): Promise<void>;
+    /**
+     * This method creates a new payment plan owned by the subscription plan.
+     * The subscription plan details station must be loaded before using this method.
+     *
+     * The following steps will be taken:
+     * - Verify that a subscription plan details station is loaded
+     * - Click 'Payment Plans' then click 'NEW'
+     * - Enter the title and click 'Proceed'
+     * - Edit the recurrence period fields
+     * - Click the 'refresh' breadcrumb and wait for the payment plan details station to reload
+     */
+    subscriptionPlanCreatePaymentPlan(properties: {
+        title: string;
+        recurrencePeriodQuantity: number;
+        recurrencePeriodUnit: 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
+    }): Promise<void>;
+    /**
+     * This method configures a payment provider for the payment plan.
+     * The subscription plan details station must be loaded before using this method.
+     * If the payment provider is not added to the parent subscription plan, or is already added to this payment plan then an exception will be raised.
+     *
+     * The following steps will be taken:
+     * - Verify that a payment plan details station is loaded
+     * - Add a payment provider by key, and set the external Id field (if it is shown).
+     * - Click the 'refresh' breadcrumb and wait for the payment plan details station to reload.
+     */
+    paymentPlanAddPaymentProvider(paymentProviderSettings: {
+        providerKey: string;
+        externalId?: string;
+    }): Promise<void>;
+    /**
+     * This method sets a price for the payment plan for a specific country.
+     * The payment plan details station must be loaded before using this method.
+     *
+     * The following steps will be taken:
+     * - Verify that a payment plan details station is loaded
+     * - Click 'Price per Country'
+     * - Enter new price details and click the add button
+     * - Click the 'previous' breadcrumb and wait for the payment plan details station to load
+     */
+    paymentPlanAddPrice(pricePerCountry: {
+        country: string;
+        currency: string;
+        price: number;
+    }): Promise<void>;
+    /**
+     * This method creates a new claim set.
+     * The management system must be loaded & signed in before using this method.
+     * When this method completes, the new claim set details station will be loaded.
+     *
+     * The following steps will be taken:
+     * - Navigate to the home breadcrumb, then tiles: 'Monetization', 'Claim Sets'
+     * - Click 'NEW', enter the title and key then click 'Proceed'
+     * - Wait for the claim set details station to load
+     */
+    createClaimSet(properties: {
+        title: string;
+        key: string;
+    }): Promise<void>;
+    /**
+     * This method assigns claims to a claim set.
+     * This claim set details station must be loaded before using this method.
+     * NOTE: Only claims which can be added by radio or checkbox are supported.
+     *
+     * The following steps will be taken:
+     * - Verify that a claim set details station is loaded
+     * - Click 'Claims'
+     * - Add each claim by checkbox or radio button
+     * - Click the 'previous' breadcrumb and wait for the claim set details station to load
+     */
+    claimSetAssignClaims(claims: string[]): Promise<void>;
+    /**
+     * This method publishes a claim set.
+     * The claim set details station must be loaded before using this method.
+     * If the claim set cannot be published then an exception will be raised.
+     *
+     * The following steps will be taken:
+     * - Verify that a claim set details station is loaded
+     * - Click 'Publishing'
+     * - Click 'Publish' and confirm
+     * - Wait for the claim set details station to load and verify that the publication state is 'PUBLISHED'
+     */
+    claimSetPublish(): Promise<void>;
+    /**
+     * This method deletes a claim set by unique key.
+     * The management system must be loaded & signed in before using this method.
+     * If the claim set is published then it will first be unpublished.
+     * If the claim set cannot be deleted then an exception will be raised.
+     *
+     * The following steps will be taken:
+     * - Navigate to the home breadcrumb, then tiles: 'Monetization', 'Claim Sets'
+     * - Filter by unique key and verify that a single result is shown
+     * - Navigate to the claim set with the row action
+     * - If the action is shown, click 'Unpublish' and confirm
+     * - Click 'Delete' and confirm
+     * - Wait for the claim sets explorer to load
+     */
+    deleteClaimSet(filterBy: {
+        uniqueKey: string;
+    }): Promise<void>;
+}
+//# sourceMappingURL=monetization-service.d.ts.map

package/dist/managed-services/monetization-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"monetization-service.d.ts","sourceRoot":"","sources":["../../src/managed-services/monetization-service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAG9D,oDAAoD;AACpD,qBAAa,mBAAoB,SAAQ,mBAAmB;IAC1D,6DAA6D;YAC/C,gCAAgC;IAY9C,wDAAwD;YAC1C,2BAA2B;IAYzC,qDAAqD;YACvC,wBAAwB;IAUtC;;;;;;;OAOG;IACG,2BAA2B,IAAI,OAAO,CAAC,IAAI,CAAC;IAiBlD;;;;;;;OAOG;IACG,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAiB1C;;;;;;;;;;OAUG;IACG,iCAAiC,CAAC,QAAQ,EAAE;QAChD,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBjB;;;;;;;;;;OAUG;IACG,yBAAyB,CAAC,QAAQ,EAAE;QACxC,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBjB;;;;;;;;;OASG;IACG,sBAAsB,CAAC,UAAU,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAe1E;;;;;;;;;OASG;IACG,kCAAkC,CAAC,uBAAuB,EAAE;QAChE,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBjB;;;;;;;;;;OAUG;IACG,8BAA8B,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBxE;;;;;;;;;;OAUG;IACG,uBAAuB,IAAI,OAAO,CAAC,IAAI,CAAC;IAoB9C;;;;;;;;;;OAUG;IACG,iCAAiC,CAAC,UAAU,EAAE;QAClD,KAAK,EAAE,MAAM,CAAC;QACd,wBAAwB,EAAE,MAAM,CAAC;QACjC,oBAAoB,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;KACzD,GAAG,OAAO,CAAC,IAAI,CAAC;IA6BjB;;;;;;;;;OASG;IACG,6BAA6B,CAAC,uBAAuB,EAAE;QAC3D,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBjB;;;;;;;;;OASG;IACG,mBAAmB,CAAC,eAAe,EAAE;QACzC,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBjB;;;;;;;;;OASG;IACG,cAAc,CAAC,UAAU,EAAE;QAC/B,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;KACb,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBjB;;;;;;;;;;OAUG;IACG,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAyB3D;;;;;;;;;;OAUG;IACG,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAoBtC;;;;;;;;;;;;;OAaG;IACG,cAAc,CAAC,QAAQ,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAuBrE"}