@umbraco/playwright-testhelpers 16.0.24 → 16.0.25

package/dist/lib/helpers/WebhookApiHelper.js

@@ -0,0 +1,169 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookApiHelper = void 0;
+const test_1 = require("@playwright/test");
+const json_models_builders_1 = require("@umbraco/json-models-builders");
+const ConstantHelper_1 = require("./ConstantHelper");
+class WebhookApiHelper {
+    api;
+    page;
+    webhookSiteUrl = 'https://webhook.site/';
+    constructor(api, page) {
+        this.api = api;
+        this.page = page;
+    }
+    async get(id) {
+        const response = await this.api.get(this.api.baseUrl + '/umbraco/management/api/v1/webhook/' + id);
+        const json = await response.json();
+        if (json !== null) {
+            return json;
+        }
+        return null;
+    }
+    async doesExist(id) {
+        const response = await this.get(this.api.baseUrl + '/umbraco/management/api/v1/webhook/' + id);
+        return response.status() === 200;
+    }
+    async create(webhookData) {
+        if (webhookData == null) {
+            return;
+        }
+        const response = await this.api.post(this.api.baseUrl + '/umbraco/management/api/v1/webhook', webhookData);
+        // Returns the id of the created webhook
+        return response.headers().location.split("/").pop();
+    }
+    async delete(id) {
+        return await this.api.delete(this.api.baseUrl + '/umbraco/management/api/v1/webhook/' + id);
+    }
+    async update(webhook) {
+        return await this.api.put(this.api.baseUrl + '/umbraco/management/api/v1/webhook/', webhook);
+    }
+    async getAll() {
+        return await this.api.get(this.api.baseUrl + '/umbraco/management/api/v1/webhook?pageSize=50&skip=0&take=10000');
+    }
+    async doesNameExist(name) {
+        return await this.getByName(name);
+    }
+    async getByName(name) {
+        const allWebhooks = await this.getAll();
+        const jsonWebhooks = await allWebhooks.json();
+        for (const webhook of jsonWebhooks.items) {
+            if (webhook.name === name) {
+                return await this.get(webhook.id);
+            }
+        }
+        return null;
+    }
+    async ensureNameNotExists(name) {
+        const allWebhooks = await this.getAll();
+        const jsonWebhooks = await allWebhooks.json();
+        for (const webhook of jsonWebhooks.items) {
+            if (webhook.name === name) {
+                return await this.delete(webhook.id);
+            }
+        }
+        return null;
+    }
+    async generateWebhookSiteToken() {
+        const createWebhookResponse = await this.page.request.post(this.webhookSiteUrl + 'token', {
+            headers: {
+                'Accept': 'application/json'
+            }
+        });
+        const webhookData = await createWebhookResponse.json();
+        const webhookToken = webhookData.uuid;
+        return webhookToken;
+    }
+    async getWebhookSiteRequestResponse(webhookSiteToken, timeoutMs = 15000, pollInterval = 1000) {
+        const requestUrl = this.webhookSiteUrl + 'token/' + webhookSiteToken + '/requests';
+        const start = Date.now();
+        while (Date.now() - start < timeoutMs) {
+            const requestResponse = await this.page.request.get(requestUrl, {
+                headers: {
+                    'Accept': 'application/json'
+                }
+            });
+            const requestJson = await requestResponse.json();
+            if (requestJson.total > 0) {
+                return requestJson.data;
+            }
+            // Polling again if there is no webhook received yet
+            await new Promise((resolve) => setTimeout(resolve, pollInterval));
+        }
+        return null;
+    }
+    async doesWebhookHaveEvent(webhookName, eventName) {
+        const webhookData = await this.getByName(webhookName);
+        return webhookData.events.find(event => event.eventName === eventName);
+    }
+    async doesWebhookHaveContentTypeId(webhookName, contentTypeId) {
+        const webhookData = await this.getByName(webhookName);
+        return webhookData.contentTypeKeys.includes(contentTypeId);
+    }
+    async doesWebhookHaveHeader(webhookName, headerName, headerValue) {
+        const webhookData = await this.getByName(webhookName);
+        return webhookData.headers[headerName] === headerValue;
+    }
+    async doesWebhookHaveUrl(webhookName, url) {
+        const webhookData = await this.getByName(webhookName);
+        return webhookData.url === url;
+    }
+    async isWebhookEnabled(webhookName, isEnabled = true) {
+        const webhookData = await this.getByName(webhookName);
+        return (0, test_1.expect)(webhookData.enabled).toBe(isEnabled);
+    }
+    async getEventTypeValue(eventName) {
+        const eventData = ConstantHelper_1.ConstantHelper.webhookEvents.find(event => event.eventName === eventName);
+        return eventData?.eventType || '';
+    }
+    async getEventAliasValue(eventName) {
+        const eventData = ConstantHelper_1.ConstantHelper.webhookEvents.find(event => event.eventName === eventName);
+        return eventData?.alias || '';
+    }
+    async createDefaultWebhook(webhookName, webhookSiteToken, eventName = 'Content Published', isEnabled = true) {
+        await this.ensureNameNotExists(webhookName);
+        const webhookUrl = this.webhookSiteUrl + webhookSiteToken;
+        const eventAlias = await this.getEventAliasValue(eventName);
+        const webhook = new json_models_builders_1.WebhookBuilder()
+            .withName(webhookName)
+            .withUrl(webhookUrl)
+            .withEventAlias(eventAlias)
+            .withEnabled(isEnabled)
+            .build();
+        return await this.create(webhook);
+    }
+    async createWebhookForSpecificContentType(webhookName, webhookSiteToken, eventName, contentTypeName) {
+        await this.ensureNameNotExists(webhookName);
+        const webhookUrl = this.webhookSiteUrl + webhookSiteToken;
+        const eventAlias = await this.getEventAliasValue(eventName);
+        const eventType = await this.getEventTypeValue(eventName);
+        let contentTypeData;
+        if (eventType == 'Content') {
+            contentTypeData = await this.api.documentType.getByName(contentTypeName);
+        }
+        else {
+            contentTypeData = await this.api.mediaType.getByName(contentTypeName);
+        }
+        const webhook = new json_models_builders_1.WebhookBuilder()
+            .withName(webhookName)
+            .withUrl(webhookUrl)
+            .withEventAlias(eventAlias)
+            .withContentTypeKey(contentTypeData.id)
+            .build();
+        return await this.create(webhook);
+    }
+    async createWebhookWithHeader(webhookName, webhookSiteToken, eventName, headerName, headerValue) {
+        await this.ensureNameNotExists(webhookName);
+        const webhookUrl = this.webhookSiteUrl + webhookSiteToken;
+        const eventAlias = await this.getEventAliasValue(eventName);
+        const webhook = new json_models_builders_1.WebhookBuilder()
+            .withName(webhookName)
+            .withUrl(webhookUrl)
+            .withEventAlias(eventAlias)
+            .withHeader(headerName, headerValue)
+            .build();
+        return await this.create(webhook);
+    }
+}
+exports.WebhookApiHelper = WebhookApiHelper;
+//# sourceMappingURL=WebhookApiHelper.js.map

package/dist/lib/helpers/WebhookApiHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebhookApiHelper.js","sourceRoot":"","sources":["../../../lib/helpers/WebhookApiHelper.ts"],"names":[],"mappings":";;;AAAA,2CAA8C;AAE9C,wEAA6D;AAC7D,qDAAgD;AAEhD,MAAa,gBAAgB;IAC3B,GAAG,CAAa;IAChB,IAAI,CAAO;IACX,cAAc,GAAW,uBAAuB,CAAC;IAEjD,YAAY,GAAe,EAAE,IAAU;QACrC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,EAAU;QAClB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,qCAAqC,GAAG,EAAE,CAAC,CAAC;QACnG,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEnC,IAAI,IAAI,KAAK,IAAI,EAAE;YACjB,OAAO,IAAI,CAAC;SACb;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,EAAU;QACxB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,qCAAqC,GAAG,EAAE,CAAC,CAAC;QAC/F,OAAO,QAAQ,CAAC,MAAM,EAAE,KAAK,GAAG,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,WAAW;QACtB,IAAI,WAAW,IAAI,IAAI,EAAE;YACvB,OAAO;SACR;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,oCAAoC,EAAE,WAAW,CAAC,CAAC;QAC3G,wCAAwC;QACxC,OAAO,QAAQ,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU;QACrB,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,qCAAqC,GAAG,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,OAAe;QAC1B,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,qCAAqC,EAAE,OAAO,CAAC,CAAC;IAC/F,CAAC;IAED,KAAK,CAAC,MAAM;QACV,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,kEAAkE,CAAC,CAAC;IACnH,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,IAAY;QAC9B,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,IAAY;QAC1B,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACxC,MAAM,YAAY,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,CAAC;QAE9C,KAAK,MAAM,OAAO,IAAI,YAAY,CAAC,KAAK,EAAE;YACxC,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,EAAE;gBACzB,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;aACnC;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,IAAY;QACpC,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACxC,MAAM,YAAY,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,CAAC;QAE9C,KAAK,MAAM,OAAO,IAAI,YAAY,CAAC,KAAK,EAAE;YACxC,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,EAAE;gBACzB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;aACtC;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,wBAAwB;QAC5B,MAAM,qBAAqB,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,GAAG,OAAO,EAAE;YACxF,OAAO,EAAE;gBACP,QAAQ,EAAE,kBAAkB;aAC7B;SACF,CAAC,CAAC;QACH,MAAM,WAAW,GAAG,MAAM,qBAAqB,CAAC,IAAI,EAAE,CAAC;QACvD,MAAM,YAAY,GAAG,WAAW,CAAC,IAAI,CAAC;QACtC,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,6BAA6B,CAAC,gBAAwB,EAAE,YAAoB,KAAK,EAAE,eAAuB,IAAI;QAClH,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,GAAG,QAAQ,GAAG,gBAAgB,GAAG,WAAW,CAAC;QACnF,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEzB,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,SAAS,EAAE;YACrC,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE;gBAC9D,OAAO,EAAE;oBACP,QAAQ,EAAE,kBAAkB;iBAC7B;aACF,CAAC,CAAC;YACH,MAAM,WAAW,GAAG,MAAM,eAAe,CAAC,IAAI,EAAE,CAAC;YACjD,IAAI,WAAW,CAAC,KAAK,GAAG,CAAC,EAAE;gBACzB,OAAO,WAAW,CAAC,IAAI,CAAC;aACzB;YAED,oDAAoD;YACpD,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC;SACnE;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,WAAmB,EAAE,SAAiB;QAC/D,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACtD,OAAO,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC;IACzE,CAAC;IAED,KAAK,CAAC,4BAA4B,CAAC,WAAmB,EAAE,aAAqB;QAC3E,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACtD,OAAO,WAAW,CAAC,eAAe,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;IAC7D,CAAC;IAED,KAAK,CAAC,qBAAqB,CAAC,WAAmB,EAAE,UAAkB,EAAE,WAAmB;QACtF,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACtD,OAAO,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,WAAW,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,WAAmB,EAAE,GAAW;QACvD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACtD,OAAO,WAAW,CAAC,GAAG,KAAK,GAAG,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,WAAmB,EAAE,YAAqB,IAAI;QACnE,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACtD,OAAO,IAAA,aAAM,EAAC,WAAW,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,SAAiB;QACvC,MAAM,SAAS,GAAG,+BAAc,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC;QAC5F,OAAO,SAAS,EAAE,SAAS,IAAI,EAAE,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,SAAiB;QACxC,MAAM,SAAS,GAAG,+BAAc,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC;QAC5F,OAAO,SAAS,EAAE,KAAK,IAAI,EAAE,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,WAAmB,EAAE,gBAAwB,EAAE,YAAoB,mBAAmB,EAAE,YAAqB,IAAI;QAC1I,MAAM,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,GAAG,gBAAgB,CAAC;QAC1D,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAE5D,MAAM,OAAO,GAAG,IAAI,qCAAc,EAAE;aACjC,QAAQ,CAAC,WAAW,CAAC;aACrB,OAAO,CAAC,UAAU,CAAC;aACnB,cAAc,CAAC,UAAU,CAAC;aAC1B,WAAW,CAAC,SAAS,CAAC;aACtB,KAAK,EAAE,CAAC;QAEX,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,mCAAmC,CAAC,WAAmB,EAAE,gBAAwB,EAAE,SAAiB,EAAE,eAAuB;QACjI,MAAM,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,GAAG,gBAAgB,CAAC;QAC1D,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC1D,IAAI,eAAe,CAAC;QACpB,IAAI,SAAS,IAAI,SAAS,EAAE;YAC1B,eAAe,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;SAC1E;aAAM;YACL,eAAe,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;SACvE;QAED,MAAM,OAAO,GAAG,IAAI,qCAAc,EAAE;aACjC,QAAQ,CAAC,WAAW,CAAC;aACrB,OAAO,CAAC,UAAU,CAAC;aACnB,cAAc,CAAC,UAAU,CAAC;aAC1B,kBAAkB,CAAC,eAAe,CAAC,EAAE,CAAC;aACtC,KAAK,EAAE,CAAC;QAEX,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,uBAAuB,CAAC,WAAmB,EAAE,gBAAwB,EAAE,SAAiB,EAAE,UAAkB,EAAE,WAAmB;QACrI,MAAM,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,GAAG,gBAAgB,CAAC;QAC1D,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAE5D,MAAM,OAAO,GAAG,IAAI,qCAAc,EAAE;aACjC,QAAQ,CAAC,WAAW,CAAC;aACrB,OAAO,CAAC,UAAU,CAAC;aACnB,cAAc,CAAC,UAAU,CAAC;aAC1B,UAAU,CAAC,UAAU,EAAE,WAAW,CAAC;aACnC,KAAK,EAAE,CAAC;QAEX,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;CACF;AAhMD,4CAgMC","sourcesContent":["import {expect, Page} from \"@playwright/test\";\nimport {ApiHelpers} from \"./ApiHelpers\";\nimport {WebhookBuilder} from \"@umbraco/json-models-builders\";\nimport {ConstantHelper} from \"./ConstantHelper\";\n\nexport class WebhookApiHelper {\n  api: ApiHelpers;\n  page: Page;\n  webhookSiteUrl: string = 'https://webhook.site/';\n\n  constructor(api: ApiHelpers, page: Page) {\n    this.api = api;\n    this.page = page;\n  }\n\n  async get(id: string) {\n    const response = await this.api.get(this.api.baseUrl + '/umbraco/management/api/v1/webhook/' + id);\n    const json = await response.json();\n\n    if (json !== null) {\n      return json;\n    }\n    return null;\n  }\n\n  async doesExist(id: string) {\n    const response = await this.get(this.api.baseUrl + '/umbraco/management/api/v1/webhook/' + id);\n    return response.status() === 200;\n  }\n\n  async create(webhookData) {\n    if (webhookData == null) {\n      return;\n    }\n    const response = await this.api.post(this.api.baseUrl + '/umbraco/management/api/v1/webhook', webhookData);\n    // Returns the id of the created webhook\n    return response.headers().location.split(\"/\").pop();\n  }\n\n  async delete(id: string) {\n    return await this.api.delete(this.api.baseUrl + '/umbraco/management/api/v1/webhook/' + id);\n  }\n\n  async update(webhook: object) {\n    return await this.api.put(this.api.baseUrl + '/umbraco/management/api/v1/webhook/', webhook);\n  }\n\n  async getAll() {\n    return await this.api.get(this.api.baseUrl + '/umbraco/management/api/v1/webhook?pageSize=50&skip=0&take=10000');\n  }\n\n  async doesNameExist(name: string) {\n    return await this.getByName(name);\n  }\n\n  async getByName(name: string) {\n    const allWebhooks = await this.getAll();\n    const jsonWebhooks = await allWebhooks.json();\n\n    for (const webhook of jsonWebhooks.items) {\n      if (webhook.name === name) {\n        return await this.get(webhook.id);\n      }\n    }\n    return null;\n  }\n\n  async ensureNameNotExists(name: string) {\n    const allWebhooks = await this.getAll();\n    const jsonWebhooks = await allWebhooks.json();\n\n    for (const webhook of jsonWebhooks.items) {\n      if (webhook.name === name) {\n        return await this.delete(webhook.id);\n      }\n    }\n    return null;\n  }\n\n  async generateWebhookSiteToken() {\n    const createWebhookResponse = await this.page.request.post(this.webhookSiteUrl + 'token', {\n      headers: {\n        'Accept': 'application/json'\n      }\n    });\n    const webhookData = await createWebhookResponse.json();\n    const webhookToken = webhookData.uuid;\n    return webhookToken;\n  }\n\n  async getWebhookSiteRequestResponse(webhookSiteToken: string, timeoutMs: number = 15000, pollInterval: number = 1000) {\n    const requestUrl = this.webhookSiteUrl + 'token/' + webhookSiteToken + '/requests';\n    const start = Date.now();\n\n    while (Date.now() - start < timeoutMs) {\n      const requestResponse = await this.page.request.get(requestUrl, {\n        headers: {\n          'Accept': 'application/json'\n        }\n      });\n      const requestJson = await requestResponse.json();\n      if (requestJson.total > 0) {\n        return requestJson.data;\n      }\n      \n      // Polling again if there is no webhook received yet\n      await new Promise((resolve) => setTimeout(resolve, pollInterval));\n    }\n    return null;\n  }\n\n  async doesWebhookHaveEvent(webhookName: string, eventName: string) {\n    const webhookData = await this.getByName(webhookName);\n    return webhookData.events.find(event => event.eventName === eventName);\n  }\n\n  async doesWebhookHaveContentTypeId(webhookName: string, contentTypeId: string) {\n    const webhookData = await this.getByName(webhookName);\n    return webhookData.contentTypeKeys.includes(contentTypeId);\n  }\n\n  async doesWebhookHaveHeader(webhookName: string, headerName: string, headerValue: string) {\n    const webhookData = await this.getByName(webhookName);\n    return webhookData.headers[headerName] === headerValue;\n  }\n\n  async doesWebhookHaveUrl(webhookName: string, url: string) {\n    const webhookData = await this.getByName(webhookName);\n    return webhookData.url === url;\n  }\n\n  async isWebhookEnabled(webhookName: string, isEnabled: boolean = true) {\n    const webhookData = await this.getByName(webhookName);\n    return expect(webhookData.enabled).toBe(isEnabled);\n  }\n\n  async getEventTypeValue(eventName: string) {\n    const eventData = ConstantHelper.webhookEvents.find(event => event.eventName === eventName);\n    return eventData?.eventType || '';\n  }\n\n  async getEventAliasValue(eventName: string) {\n    const eventData = ConstantHelper.webhookEvents.find(event => event.eventName === eventName);\n    return eventData?.alias || '';\n  }\n\n  async createDefaultWebhook(webhookName: string, webhookSiteToken: string, eventName: string = 'Content Published', isEnabled: boolean = true) {\n    await this.ensureNameNotExists(webhookName);\n    const webhookUrl = this.webhookSiteUrl + webhookSiteToken;\n    const eventAlias = await this.getEventAliasValue(eventName);\n\n    const webhook = new WebhookBuilder()\n      .withName(webhookName)\n      .withUrl(webhookUrl)\n      .withEventAlias(eventAlias)\n      .withEnabled(isEnabled)\n      .build();\n\n    return await this.create(webhook);\n  }\n\n  async createWebhookForSpecificContentType(webhookName: string, webhookSiteToken: string, eventName: string, contentTypeName: string) {\n    await this.ensureNameNotExists(webhookName);\n    const webhookUrl = this.webhookSiteUrl + webhookSiteToken;\n    const eventAlias = await this.getEventAliasValue(eventName);\n    const eventType = await this.getEventTypeValue(eventName);\n    let contentTypeData;\n    if (eventType == 'Content') {\n      contentTypeData = await this.api.documentType.getByName(contentTypeName);\n    } else {\n      contentTypeData = await this.api.mediaType.getByName(contentTypeName);\n    }\n\n    const webhook = new WebhookBuilder()\n      .withName(webhookName)\n      .withUrl(webhookUrl)\n      .withEventAlias(eventAlias)\n      .withContentTypeKey(contentTypeData.id)\n      .build();\n\n    return await this.create(webhook);\n  }\n\n  async createWebhookWithHeader(webhookName: string, webhookSiteToken: string, eventName: string, headerName: string, headerValue: string) {\n    await this.ensureNameNotExists(webhookName);\n    const webhookUrl = this.webhookSiteUrl + webhookSiteToken;\n    const eventAlias = await this.getEventAliasValue(eventName);\n\n    const webhook = new WebhookBuilder()\n      .withName(webhookName)\n      .withUrl(webhookUrl)\n      .withEventAlias(eventAlias)\n      .withHeader(headerName, headerValue)\n      .build();\n\n    return await this.create(webhook);\n  }\n}"]}

package/dist/lib/helpers/WebhookUiHelper.d.ts

@@ -0,0 +1,29 @@
+import { Page } from "@playwright/test";
+import { UiBaseLocators } from "./UiBaseLocators";
+export declare class WebhookUiHelper extends UiBaseLocators {
+    private readonly webhookCreateBtn;
+    private readonly webhookNameTxt;
+    private readonly urlTxt;
+    private readonly chooseEventBtn;
+    private readonly chooseContentTypeBtn;
+    private readonly enabledToggle;
+    private readonly addHeadersBtn;
+    private readonly headerNameTxt;
+    private readonly headerValueTxt;
+    private readonly deleteWebhookEntityAction;
+    private readonly headerRemoveBtn;
+    constructor(page: Page);
+    goToWebhooks(): Promise<void>;
+    goToWebhookWithName(name: string): Promise<void>;
+    clickWebhookCreateButton(): Promise<void>;
+    enterWebhookName(name: string): Promise<void>;
+    enterUrl(url: string): Promise<void>;
+    clickChooseEventButton(): Promise<void>;
+    clickChooseContentTypeButton(): Promise<void>;
+    clickEnabledToggleButton(): Promise<void>;
+    clickAddHeadersButton(): Promise<void>;
+    enterHeaderName(name: string): Promise<void>;
+    enterHeaderValue(value: string): Promise<void>;
+    clickDeleteWebhookWithName(name: string): Promise<void>;
+    clickHeaderRemoveButton(): Promise<void>;
+}

package/dist/lib/helpers/WebhookUiHelper.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookUiHelper = void 0;
+const test_1 = require("@playwright/test");
+const UiBaseLocators_1 = require("./UiBaseLocators");
+const ConstantHelper_1 = require("./ConstantHelper");
+class WebhookUiHelper extends UiBaseLocators_1.UiBaseLocators {
+    webhookCreateBtn;
+    webhookNameTxt;
+    urlTxt;
+    chooseEventBtn;
+    chooseContentTypeBtn;
+    enabledToggle;
+    addHeadersBtn;
+    headerNameTxt;
+    headerValueTxt;
+    deleteWebhookEntityAction;
+    headerRemoveBtn;
+    constructor(page) {
+        super(page);
+        this.webhookCreateBtn = page.getByTestId('collection-action:Umb.CollectionAction.Webhook.Create');
+        this.webhookNameTxt = page.locator('#name #input');
+        this.urlTxt = page.locator('umb-property-layout[label="URL"] #input');
+        this.chooseEventBtn = page.locator('umb-property-layout[label="Events"]').getByLabel('Choose');
+        this.chooseContentTypeBtn = page.locator('umb-property-layout[label="Content Type"]').getByLabel('Choose');
+        this.enabledToggle = page.locator('umb-property-layout[label="Enabled"] #toggle');
+        this.addHeadersBtn = page.locator('umb-property-layout[label="Headers"] #add');
+        this.headerNameTxt = page.locator('umb-input-webhook-headers').locator('[list="nameList"]');
+        this.headerValueTxt = page.locator('umb-input-webhook-headers').locator('[list="valueList"]');
+        this.deleteWebhookEntityAction = page.getByTestId('entity-action:Umb.EntityAction.Webhook.Delete');
+        this.headerRemoveBtn = page.locator('umb-input-webhook-headers').locator('[label="Remove"]');
+    }
+    async goToWebhooks() {
+        await this.goToSection(ConstantHelper_1.ConstantHelper.sections.settings);
+        await this.goToSettingsTreeItem('Webhooks');
+    }
+    async goToWebhookWithName(name) {
+        await this.goToWebhooks();
+        await this.clickTextButtonWithName(name);
+    }
+    async clickWebhookCreateButton() {
+        await (0, test_1.expect)(this.webhookCreateBtn).toBeVisible();
+        await this.webhookCreateBtn.click();
+    }
+    async enterWebhookName(name) {
+        await (0, test_1.expect)(this.webhookNameTxt).toBeVisible();
+        await this.webhookNameTxt.clear();
+        await this.webhookNameTxt.fill(name);
+    }
+    async enterUrl(url) {
+        await (0, test_1.expect)(this.urlTxt).toBeVisible();
+        await this.urlTxt.clear();
+        await this.urlTxt.fill(url);
+    }
+    async clickChooseEventButton() {
+        await (0, test_1.expect)(this.chooseEventBtn).toBeVisible();
+        await this.chooseEventBtn.click();
+    }
+    async clickChooseContentTypeButton() {
+        await (0, test_1.expect)(this.chooseContentTypeBtn).toBeVisible();
+        await this.chooseContentTypeBtn.click();
+    }
+    async clickEnabledToggleButton() {
+        await (0, test_1.expect)(this.enabledToggle).toBeVisible();
+        await this.enabledToggle.click();
+    }
+    async clickAddHeadersButton() {
+        await (0, test_1.expect)(this.addHeadersBtn).toBeVisible();
+        await this.addHeadersBtn.click();
+    }
+    async enterHeaderName(name) {
+        await (0, test_1.expect)(this.headerNameTxt).toBeVisible();
+        await this.headerNameTxt.clear();
+        await this.headerNameTxt.fill(name);
+    }
+    async enterHeaderValue(value) {
+        await (0, test_1.expect)(this.headerValueTxt).toBeVisible();
+        await this.headerValueTxt.clear();
+        await this.headerValueTxt.fill(value);
+    }
+    async clickDeleteWebhookWithName(name) {
+        const deleteLocator = this.page.locator('uui-table-row').filter({ has: this.page.getByText(name, { exact: true }) }).locator(this.deleteWebhookEntityAction);
+        await (0, test_1.expect)(deleteLocator).toBeVisible();
+        await deleteLocator.click();
+    }
+    async clickHeaderRemoveButton() {
+        await (0, test_1.expect)(this.headerRemoveBtn).toBeVisible();
+        await this.headerRemoveBtn.click();
+    }
+}
+exports.WebhookUiHelper = WebhookUiHelper;
+//# sourceMappingURL=WebhookUiHelper.js.map

package/dist/lib/helpers/WebhookUiHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebhookUiHelper.js","sourceRoot":"","sources":["../../../lib/helpers/WebhookUiHelper.ts"],"names":[],"mappings":";;;AAAA,2CAAsD;AACtD,qDAAgD;AAChD,qDAAgD;AAEhD,MAAa,eAAgB,SAAQ,+BAAc;IAChC,gBAAgB,CAAU;IAC1B,cAAc,CAAU;IACxB,MAAM,CAAU;IAChB,cAAc,CAAU;IACxB,oBAAoB,CAAU;IAC9B,aAAa,CAAU;IACvB,aAAa,CAAU;IACvB,aAAa,CAAU;IACvB,cAAc,CAAU;IACxB,yBAAyB,CAAU;IACnC,eAAe,CAAU;IAE1C,YAAY,IAAU;QACpB,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,WAAW,CAAC,uDAAuD,CAAC,CAAC;QAClG,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACnD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,yCAAyC,CAAC,CAAC;QACtE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,qCAAqC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAC/F,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,OAAO,CAAC,2CAA2C,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAC3G,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,8CAA8C,CAAC,CAAC;QAClF,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,2CAA2C,CAAC,CAAC;QAC/E,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAC5F,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAC9F,IAAI,CAAC,yBAAyB,GAAG,IAAI,CAAC,WAAW,CAAC,+CAA+C,CAAC,CAAC;QACnG,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC/F,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,MAAM,IAAI,CAAC,WAAW,CAAC,+BAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACzD,MAAM,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,IAAY;QACpC,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC1B,MAAM,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,wBAAwB;QAC5B,MAAM,IAAA,aAAM,EAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,WAAW,EAAE,CAAC;QAClD,MAAM,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,IAAY;QACjC,MAAM,IAAA,aAAM,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC,WAAW,EAAE,CAAC;QAChD,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAClC,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACtC,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,GAAW;QACxB,MAAM,IAAA,aAAM,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;QACxC,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QAC1B,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,sBAAsB;QAC1B,MAAM,IAAA,aAAM,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC,WAAW,EAAE,CAAC;QAChD,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,4BAA4B;QAChC,MAAM,IAAA,aAAM,EAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,WAAW,EAAE,CAAC;QACtD,MAAM,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,wBAAwB;QAC5B,MAAM,IAAA,aAAM,EAAC,IAAI,CAAC,aAAa,CAAC,CAAC,WAAW,EAAE,CAAC;QAC/C,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,qBAAqB;QACzB,MAAM,IAAA,aAAM,EAAC,IAAI,CAAC,aAAa,CAAC,CAAC,WAAW,EAAE,CAAC;QAC/C,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,IAAY;QAChC,MAAM,IAAA,aAAM,EAAC,IAAI,CAAC,aAAa,CAAC,CAAC,WAAW,EAAE,CAAC;QAC/C,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;QACjC,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,KAAa;QAClC,MAAM,IAAA,aAAM,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC,WAAW,EAAE,CAAC;QAChD,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAClC,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;IAED,KAAK,CAAC,0BAA0B,CAAC,IAAY;QAC3C,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,EAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC,EAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QACzJ,MAAM,IAAA,aAAM,EAAC,aAAa,CAAC,CAAC,WAAW,EAAE,CAAC;QAC1C,MAAM,aAAa,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,uBAAuB;QAC3B,MAAM,IAAA,aAAM,EAAC,IAAI,CAAC,eAAe,CAAC,CAAC,WAAW,EAAE,CAAC;QACjD,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IACrC,CAAC;CACF;AAjGD,0CAiGC","sourcesContent":["import {Page, Locator, expect} from \"@playwright/test\"\nimport {UiBaseLocators} from \"./UiBaseLocators\";\nimport {ConstantHelper} from \"./ConstantHelper\";\n\nexport class WebhookUiHelper extends UiBaseLocators {\n  private readonly webhookCreateBtn: Locator;\n  private readonly webhookNameTxt: Locator;\n  private readonly urlTxt: Locator;\n  private readonly chooseEventBtn: Locator;\n  private readonly chooseContentTypeBtn: Locator;\n  private readonly enabledToggle: Locator;\n  private readonly addHeadersBtn: Locator;\n  private readonly headerNameTxt: Locator;\n  private readonly headerValueTxt: Locator;\n  private readonly deleteWebhookEntityAction: Locator;\n  private readonly headerRemoveBtn: Locator;\n\n  constructor(page: Page) {\n    super(page);\n    this.webhookCreateBtn = page.getByTestId('collection-action:Umb.CollectionAction.Webhook.Create');\n    this.webhookNameTxt = page.locator('#name #input');\n    this.urlTxt = page.locator('umb-property-layout[label=\"URL\"] #input');\n    this.chooseEventBtn = page.locator('umb-property-layout[label=\"Events\"]').getByLabel('Choose');\n    this.chooseContentTypeBtn = page.locator('umb-property-layout[label=\"Content Type\"]').getByLabel('Choose');\n    this.enabledToggle = page.locator('umb-property-layout[label=\"Enabled\"] #toggle');\n    this.addHeadersBtn = page.locator('umb-property-layout[label=\"Headers\"] #add');\n    this.headerNameTxt = page.locator('umb-input-webhook-headers').locator('[list=\"nameList\"]');\n    this.headerValueTxt = page.locator('umb-input-webhook-headers').locator('[list=\"valueList\"]');\n    this.deleteWebhookEntityAction = page.getByTestId('entity-action:Umb.EntityAction.Webhook.Delete');\n    this.headerRemoveBtn = page.locator('umb-input-webhook-headers').locator('[label=\"Remove\"]');\n  }\n\n  async goToWebhooks() {\n    await this.goToSection(ConstantHelper.sections.settings);\n    await this.goToSettingsTreeItem('Webhooks');\n  }\n\n  async goToWebhookWithName(name: string) {\n    await this.goToWebhooks();\n    await this.clickTextButtonWithName(name);\n  }\n\n  async clickWebhookCreateButton() {\n    await expect(this.webhookCreateBtn).toBeVisible();\n    await this.webhookCreateBtn.click();\n  }\n\n  async enterWebhookName(name: string) {\n    await expect(this.webhookNameTxt).toBeVisible();\n    await this.webhookNameTxt.clear();\n    await this.webhookNameTxt.fill(name)\n  }\n\n  async enterUrl(url: string) {\n    await expect(this.urlTxt).toBeVisible();\n    await this.urlTxt.clear();\n    await this.urlTxt.fill(url);\n  }\n\n  async clickChooseEventButton() {\n    await expect(this.chooseEventBtn).toBeVisible();\n    await this.chooseEventBtn.click();\n  }\n\n  async clickChooseContentTypeButton() {\n    await expect(this.chooseContentTypeBtn).toBeVisible();\n    await this.chooseContentTypeBtn.click();\n  }\n\n  async clickEnabledToggleButton() {\n    await expect(this.enabledToggle).toBeVisible();\n    await this.enabledToggle.click();\n  }\n\n  async clickAddHeadersButton() {\n    await expect(this.addHeadersBtn).toBeVisible();\n    await this.addHeadersBtn.click();\n  }\n\n  async enterHeaderName(name: string) {\n    await expect(this.headerNameTxt).toBeVisible();\n    await this.headerNameTxt.clear();\n    await this.headerNameTxt.fill(name);\n  }\n\n  async enterHeaderValue(value: string) {\n    await expect(this.headerValueTxt).toBeVisible();\n    await this.headerValueTxt.clear();\n    await this.headerValueTxt.fill(value);\n  }\n\n  async clickDeleteWebhookWithName(name: string) {\n    const deleteLocator = this.page.locator('uui-table-row').filter({has: this.page.getByText(name, {exact: true})}).locator(this.deleteWebhookEntityAction);\n    await expect(deleteLocator).toBeVisible();\n    await deleteLocator.click();\n  }\n\n  async clickHeaderRemoveButton() {\n    await expect(this.headerRemoveBtn).toBeVisible();\n    await this.headerRemoveBtn.click();\n  }\n}"]}