@webiny/api-apw 0.0.0-ee-vpcs.549378cf03

package/plugins/pageBuilder/notifications/contentUrl.js

@@ -0,0 +1,53 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createContentUrlPlugin = void 0;
+
+var _ApwContentUrlPlugin = require("../../../ApwContentUrlPlugin");
+
+var _types = require("../../../types");
+
+/**
+ * In this file we create a plugin which in turn creates a content entry url when requested by the code which sends notifications.
+ * Due to multiple content types for the APW, everything needs to be pluginable.
+ */
+const createPageUrl = params => {
+  /**
+   * All variables must exist for URL to be created.
+   * We go through all vars and throw a log if it does not exist.
+   */
+  for (const key in params) {
+    if (!!key) {
+      continue;
+    }
+
+    console.log(`Missing variable "${key}", which we use to create a page URL.`);
+    return null;
+  }
+
+  const {
+    baseUrl,
+    id
+  } = params;
+  return `${baseUrl}/page-builder/pages?id=${id}`;
+};
+
+const createContentUrlPlugin = () => {
+  return (0, _ApwContentUrlPlugin.createApwContentUrlPlugin)(_types.ApwContentTypes.PAGE, params => {
+    const {
+      baseUrl,
+      contentReview
+    } = params;
+    const {
+      id
+    } = contentReview.content;
+    return createPageUrl({
+      baseUrl,
+      id
+    });
+  });
+};
+
+exports.createContentUrlPlugin = createContentUrlPlugin;

package/plugins/pageBuilder/notifications/contentUrl.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["createPageUrl","params","key","console","log","baseUrl","id","createContentUrlPlugin","createApwContentUrlPlugin","ApwContentTypes","PAGE","contentReview","content"],"sources":["contentUrl.ts"],"sourcesContent":["/**\n * In this file we create a plugin which in turn creates a content entry url when requested by the code which sends notifications.\n * Due to multiple content types for the APW, everything needs to be pluginable.\n */\nimport { createApwContentUrlPlugin } from \"~/ApwContentUrlPlugin\";\nimport { ApwContentTypes } from \"~/types\";\n\ninterface CreatePageUrlParams {\n    baseUrl?: string;\n    id: string;\n}\nconst createPageUrl = (params: CreatePageUrlParams): string | null => {\n    /**\n     * All variables must exist for URL to be created.\n     * We go through all vars and throw a log if it does not exist.\n     */\n    for (const key in params) {\n        if (!!key) {\n            continue;\n        }\n        console.log(`Missing variable \"${key}\", which we use to create a page URL.`);\n        return null;\n    }\n    const { baseUrl, id } = params;\n    return `${baseUrl}/page-builder/pages?id=${id}`;\n};\n\nexport const createContentUrlPlugin = () => {\n    return createApwContentUrlPlugin(ApwContentTypes.PAGE, params => {\n        const { baseUrl, contentReview } = params;\n        const { id } = contentReview.content;\n        return createPageUrl({\n            baseUrl,\n            id\n        });\n    });\n};\n"],"mappings":";;;;;;;AAIA;;AACA;;AALA;AACA;AACA;AACA;AAQA,MAAMA,aAAa,GAAIC,MAAD,IAAgD;EAClE;AACJ;AACA;AACA;EACI,KAAK,MAAMC,GAAX,IAAkBD,MAAlB,EAA0B;IACtB,IAAI,CAAC,CAACC,GAAN,EAAW;MACP;IACH;;IACDC,OAAO,CAACC,GAAR,CAAa,qBAAoBF,GAAI,uCAArC;IACA,OAAO,IAAP;EACH;;EACD,MAAM;IAAEG,OAAF;IAAWC;EAAX,IAAkBL,MAAxB;EACA,OAAQ,GAAEI,OAAQ,0BAAyBC,EAAG,EAA9C;AACH,CAdD;;AAgBO,MAAMC,sBAAsB,GAAG,MAAM;EACxC,OAAO,IAAAC,8CAAA,EAA0BC,sBAAA,CAAgBC,IAA1C,EAAgDT,MAAM,IAAI;IAC7D,MAAM;MAAEI,OAAF;MAAWM;IAAX,IAA6BV,MAAnC;IACA,MAAM;MAAEK;IAAF,IAASK,aAAa,CAACC,OAA7B;IACA,OAAOZ,aAAa,CAAC;MACjBK,OADiB;MAEjBC;IAFiB,CAAD,CAApB;EAIH,CAPM,CAAP;AAQH,CATM"}

package/plugins/pageBuilder/triggerContentReview.d.ts

@@ -0,0 +1,8 @@
+import { AdvancedPublishingWorkflow } from "../../types";
+import { PageBuilderContextObject } from "@webiny/api-page-builder/graphql/types";
+interface TriggerContentReviewParams {
+    apw: AdvancedPublishingWorkflow;
+    pageBuilder: PageBuilderContextObject;
+}
+export declare const triggerContentReview: (params: TriggerContentReviewParams) => void;
+export {};

package/plugins/pageBuilder/triggerContentReview.js

@@ -0,0 +1,50 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.triggerContentReview = void 0;
+
+var _get = _interopRequireDefault(require("lodash/get"));
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+var _types = require("../../types");
+
+const triggerContentReview = params => {
+  const {
+    pageBuilder,
+    apw
+  } = params;
+  pageBuilder.onPageBeforePublish.subscribe(async ({
+    page
+  }) => {
+    const contentReviewId = (0, _get.default)(page, "settings.apw.contentReviewId");
+
+    if (contentReviewId) {
+      const contentReview = await apw.contentReview.get(contentReviewId);
+
+      if (contentReview.reviewStatus === _types.ApwContentReviewStatus.UNDER_REVIEW) {
+        throw new _error.default(`A peer review for this content has been already requested.`, "REVIEW_ALREADY_EXIST", {
+          contentReviewId,
+          page
+        });
+      }
+
+      return;
+    }
+
+    const workflowId = (0, _get.default)(page, "settings.apw.workflowId");
+
+    if (workflowId) {
+      throw new _error.default("This content requires peer review approval before it can be published.", "REVIEW_REQUIRED", {
+        workflowId,
+        page
+      });
+    }
+  });
+};
+
+exports.triggerContentReview = triggerContentReview;

package/plugins/pageBuilder/triggerContentReview.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["triggerContentReview","params","pageBuilder","apw","onPageBeforePublish","subscribe","page","contentReviewId","get","contentReview","reviewStatus","ApwContentReviewStatus","UNDER_REVIEW","Error","workflowId"],"sources":["triggerContentReview.ts"],"sourcesContent":["import get from \"lodash/get\";\nimport Error from \"@webiny/error\";\nimport {\n    AdvancedPublishingWorkflow,\n    ApwContentReviewStatus,\n    ApwOnPageBeforePublishTopicParams\n} from \"~/types\";\nimport { PageBuilderContextObject } from \"@webiny/api-page-builder/graphql/types\";\n\ninterface TriggerContentReviewParams {\n    apw: AdvancedPublishingWorkflow;\n    pageBuilder: PageBuilderContextObject;\n}\n\nexport const triggerContentReview = (params: TriggerContentReviewParams) => {\n    const { pageBuilder, apw } = params;\n\n    pageBuilder.onPageBeforePublish.subscribe<ApwOnPageBeforePublishTopicParams>(\n        async ({ page }) => {\n            const contentReviewId = get(page, \"settings.apw.contentReviewId\");\n            if (contentReviewId) {\n                const contentReview = await apw.contentReview.get(contentReviewId);\n\n                if (contentReview.reviewStatus === ApwContentReviewStatus.UNDER_REVIEW) {\n                    throw new Error(\n                        `A peer review for this content has been already requested.`,\n                        \"REVIEW_ALREADY_EXIST\",\n                        {\n                            contentReviewId,\n                            page\n                        }\n                    );\n                }\n                return;\n            }\n\n            const workflowId = get(page, \"settings.apw.workflowId\");\n\n            if (workflowId) {\n                throw new Error(\n                    \"This content requires peer review approval before it can be published.\",\n                    \"REVIEW_REQUIRED\",\n                    {\n                        workflowId,\n                        page\n                    }\n                );\n            }\n        }\n    );\n};\n"],"mappings":";;;;;;;;;AAAA;;AACA;;AACA;;AAYO,MAAMA,oBAAoB,GAAIC,MAAD,IAAwC;EACxE,MAAM;IAAEC,WAAF;IAAeC;EAAf,IAAuBF,MAA7B;EAEAC,WAAW,CAACE,mBAAZ,CAAgCC,SAAhC,CACI,OAAO;IAAEC;EAAF,CAAP,KAAoB;IAChB,MAAMC,eAAe,GAAG,IAAAC,YAAA,EAAIF,IAAJ,EAAU,8BAAV,CAAxB;;IACA,IAAIC,eAAJ,EAAqB;MACjB,MAAME,aAAa,GAAG,MAAMN,GAAG,CAACM,aAAJ,CAAkBD,GAAlB,CAAsBD,eAAtB,CAA5B;;MAEA,IAAIE,aAAa,CAACC,YAAd,KAA+BC,6BAAA,CAAuBC,YAA1D,EAAwE;QACpE,MAAM,IAAIC,cAAJ,CACD,4DADC,EAEF,sBAFE,EAGF;UACIN,eADJ;UAEID;QAFJ,CAHE,CAAN;MAQH;;MACD;IACH;;IAED,MAAMQ,UAAU,GAAG,IAAAN,YAAA,EAAIF,IAAJ,EAAU,yBAAV,CAAnB;;IAEA,IAAIQ,UAAJ,EAAgB;MACZ,MAAM,IAAID,cAAJ,CACF,wEADE,EAEF,iBAFE,EAGF;QACIC,UADJ;QAEIR;MAFJ,CAHE,CAAN;IAQH;EACJ,CA/BL;AAiCH,CApCM"}

package/plugins/pageBuilder/updateContentReviewStatus.d.ts

@@ -0,0 +1,10 @@
+import { AdvancedPublishingWorkflow } from "../../types";
+import { PageBuilderContextObject } from "@webiny/api-page-builder/graphql/types";
+import { Security } from "@webiny/api-security/types";
+interface UpdateContentReviewStatusParams {
+    apw: AdvancedPublishingWorkflow;
+    pageBuilder: PageBuilderContextObject;
+    security: Security;
+}
+export declare const updateContentReviewStatus: (params: UpdateContentReviewStatusParams) => void;
+export {};

package/plugins/pageBuilder/updateContentReviewStatus.js

@@ -0,0 +1,79 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.updateContentReviewStatus = void 0;
+
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
+
+var _get = _interopRequireDefault(require("lodash/get"));
+
+var _types = require("../../types");
+
+var _utils = require("../../crud/utils");
+
+const updateContentReviewStatus = params => {
+  const {
+    apw,
+    pageBuilder,
+    security
+  } = params;
+  pageBuilder.onPageAfterPublish.subscribe(async ({
+    page
+  }) => {
+    const contentReviewId = (0, _get.default)(page, "settings.apw.contentReviewId");
+    /**
+     * Bail out if there is no "content review" linked.
+     */
+
+    if (!contentReviewId) {
+      return;
+    }
+
+    const contentReview = await apw.contentReview.get(contentReviewId);
+    const identity = security.getIdentity();
+    /**
+     * If content review is "readyToBePublished set its status as "published" after page publish.
+     */
+
+    if (contentReview.reviewStatus === _types.ApwContentReviewStatus.READY_TO_BE_PUBLISHED) {
+      await apw.contentReview.update(contentReviewId, {
+        reviewStatus: _types.ApwContentReviewStatus.PUBLISHED,
+        content: (0, _objectSpread2.default)((0, _objectSpread2.default)((0, _objectSpread2.default)({}, contentReview.content), _utils.INITIAL_CONTENT_REVIEW_CONTENT_SCHEDULE_META), {}, {
+          publishedBy: identity.id
+        })
+      });
+    }
+  });
+  pageBuilder.onPageAfterUnpublish.subscribe(async ({
+    page
+  }) => {
+    const contentReviewId = (0, _get.default)(page, "settings.apw.contentReviewId");
+    /**
+     * Bail out if there is no "content review" linked.
+     */
+
+    if (!contentReviewId) {
+      return;
+    }
+
+    const contentReview = await apw.contentReview.get(contentReviewId);
+    /**
+     * If content review is "published set its status as "readyToBePublished" after page unpublish.
+     */
+
+    if (contentReview.reviewStatus === _types.ApwContentReviewStatus.PUBLISHED) {
+      await apw.contentReview.update(contentReviewId, {
+        reviewStatus: _types.ApwContentReviewStatus.READY_TO_BE_PUBLISHED,
+        content: (0, _objectSpread2.default)((0, _objectSpread2.default)((0, _objectSpread2.default)({}, contentReview.content), _utils.INITIAL_CONTENT_REVIEW_CONTENT_SCHEDULE_META), {}, {
+          publishedBy: null
+        })
+      });
+    }
+  });
+};
+
+exports.updateContentReviewStatus = updateContentReviewStatus;

package/plugins/pageBuilder/updateContentReviewStatus.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["updateContentReviewStatus","params","apw","pageBuilder","security","onPageAfterPublish","subscribe","page","contentReviewId","get","contentReview","identity","getIdentity","reviewStatus","ApwContentReviewStatus","READY_TO_BE_PUBLISHED","update","PUBLISHED","content","INITIAL_CONTENT_REVIEW_CONTENT_SCHEDULE_META","publishedBy","id","onPageAfterUnpublish"],"sources":["updateContentReviewStatus.ts"],"sourcesContent":["import get from \"lodash/get\";\nimport {\n    AdvancedPublishingWorkflow,\n    ApwContentReviewStatus,\n    ApwOnPageBeforePublishTopicParams\n} from \"~/types\";\nimport { INITIAL_CONTENT_REVIEW_CONTENT_SCHEDULE_META } from \"~/crud/utils\";\nimport { PageBuilderContextObject } from \"@webiny/api-page-builder/graphql/types\";\nimport { Security } from \"@webiny/api-security/types\";\n\ninterface UpdateContentReviewStatusParams {\n    apw: AdvancedPublishingWorkflow;\n    pageBuilder: PageBuilderContextObject;\n    security: Security;\n}\n\nexport const updateContentReviewStatus = (params: UpdateContentReviewStatusParams) => {\n    const { apw, pageBuilder, security } = params;\n\n    pageBuilder.onPageAfterPublish.subscribe<ApwOnPageBeforePublishTopicParams>(\n        async ({ page }) => {\n            const contentReviewId = get(page, \"settings.apw.contentReviewId\");\n            /**\n             * Bail out if there is no \"content review\" linked.\n             */\n            if (!contentReviewId) {\n                return;\n            }\n\n            const contentReview = await apw.contentReview.get(contentReviewId);\n            const identity = security.getIdentity();\n            /**\n             * If content review is \"readyToBePublished set its status as \"published\" after page publish.\n             */\n            if (contentReview.reviewStatus === ApwContentReviewStatus.READY_TO_BE_PUBLISHED) {\n                await apw.contentReview.update(contentReviewId, {\n                    reviewStatus: ApwContentReviewStatus.PUBLISHED,\n                    content: {\n                        ...contentReview.content,\n                        ...INITIAL_CONTENT_REVIEW_CONTENT_SCHEDULE_META,\n                        publishedBy: identity.id\n                    }\n                });\n            }\n        }\n    );\n    pageBuilder.onPageAfterUnpublish.subscribe<ApwOnPageBeforePublishTopicParams>(\n        async ({ page }) => {\n            const contentReviewId = get(page, \"settings.apw.contentReviewId\");\n            /**\n             * Bail out if there is no \"content review\" linked.\n             */\n            if (!contentReviewId) {\n                return;\n            }\n\n            const contentReview = await apw.contentReview.get(contentReviewId);\n            /**\n             * If content review is \"published set its status as \"readyToBePublished\" after page unpublish.\n             */\n\n            if (contentReview.reviewStatus === ApwContentReviewStatus.PUBLISHED) {\n                await apw.contentReview.update(contentReviewId, {\n                    reviewStatus: ApwContentReviewStatus.READY_TO_BE_PUBLISHED,\n                    content: {\n                        ...contentReview.content,\n                        ...INITIAL_CONTENT_REVIEW_CONTENT_SCHEDULE_META,\n                        publishedBy: null\n                    }\n                });\n            }\n        }\n    );\n};\n"],"mappings":";;;;;;;;;;;AAAA;;AACA;;AAKA;;AAUO,MAAMA,yBAAyB,GAAIC,MAAD,IAA6C;EAClF,MAAM;IAAEC,GAAF;IAAOC,WAAP;IAAoBC;EAApB,IAAiCH,MAAvC;EAEAE,WAAW,CAACE,kBAAZ,CAA+BC,SAA/B,CACI,OAAO;IAAEC;EAAF,CAAP,KAAoB;IAChB,MAAMC,eAAe,GAAG,IAAAC,YAAA,EAAIF,IAAJ,EAAU,8BAAV,CAAxB;IACA;AACZ;AACA;;IACY,IAAI,CAACC,eAAL,EAAsB;MAClB;IACH;;IAED,MAAME,aAAa,GAAG,MAAMR,GAAG,CAACQ,aAAJ,CAAkBD,GAAlB,CAAsBD,eAAtB,CAA5B;IACA,MAAMG,QAAQ,GAAGP,QAAQ,CAACQ,WAAT,EAAjB;IACA;AACZ;AACA;;IACY,IAAIF,aAAa,CAACG,YAAd,KAA+BC,6BAAA,CAAuBC,qBAA1D,EAAiF;MAC7E,MAAMb,GAAG,CAACQ,aAAJ,CAAkBM,MAAlB,CAAyBR,eAAzB,EAA0C;QAC5CK,YAAY,EAAEC,6BAAA,CAAuBG,SADO;QAE5CC,OAAO,0FACAR,aAAa,CAACQ,OADd,GAEAC,mDAFA;UAGHC,WAAW,EAAET,QAAQ,CAACU;QAHnB;MAFqC,CAA1C,CAAN;IAQH;EACJ,CAzBL;EA2BAlB,WAAW,CAACmB,oBAAZ,CAAiChB,SAAjC,CACI,OAAO;IAAEC;EAAF,CAAP,KAAoB;IAChB,MAAMC,eAAe,GAAG,IAAAC,YAAA,EAAIF,IAAJ,EAAU,8BAAV,CAAxB;IACA;AACZ;AACA;;IACY,IAAI,CAACC,eAAL,EAAsB;MAClB;IACH;;IAED,MAAME,aAAa,GAAG,MAAMR,GAAG,CAACQ,aAAJ,CAAkBD,GAAlB,CAAsBD,eAAtB,CAA5B;IACA;AACZ;AACA;;IAEY,IAAIE,aAAa,CAACG,YAAd,KAA+BC,6BAAA,CAAuBG,SAA1D,EAAqE;MACjE,MAAMf,GAAG,CAACQ,aAAJ,CAAkBM,MAAlB,CAAyBR,eAAzB,EAA0C;QAC5CK,YAAY,EAAEC,6BAAA,CAAuBC,qBADO;QAE5CG,OAAO,0FACAR,aAAa,CAACQ,OADd,GAEAC,mDAFA;UAGHC,WAAW,EAAE;QAHV;MAFqC,CAA1C,CAAN;IAQH;EACJ,CAzBL;AA2BH,CAzDM"}

package/plugins/pageBuilder/utils.d.ts

@@ -0,0 +1,22 @@
+import { ApwWorkflow, ApwWorkflowCrud, ApwWorkflowScope, PageWithWorkflow } from "../../types";
+import { PageBuilderContextObject } from "@webiny/api-page-builder/graphql/types";
+interface AssignWorkflowToPageParams {
+    listWorkflow: ApwWorkflowCrud["list"];
+    page: PageWithWorkflow;
+}
+export declare const assignWorkflowToPage: ({ listWorkflow, page }: AssignWorkflowToPageParams) => Promise<void>;
+export declare const hasPages: (workflow: ApwWorkflow) => Boolean;
+export declare const shouldUpdatePages: (scope: ApwWorkflowScope, prevScope: ApwWorkflowScope) => Boolean;
+interface GetUpdatePageOpsResult {
+    addedPages: string[];
+    removedPages: string[];
+}
+export declare const getPagesDiff: (currentPages: string[], prevPages: string[]) => GetUpdatePageOpsResult;
+interface UpdatePageSettingsParams {
+    getPage: PageBuilderContextObject["getPage"];
+    updatePage: PageBuilderContextObject["updatePage"];
+    uniquePageId: string;
+    getNewSettings: (settings: PageWithWorkflow["settings"]) => PageWithWorkflow["settings"];
+}
+export declare const updatePageSettings: ({ getPage, updatePage, uniquePageId, getNewSettings }: UpdatePageSettingsParams) => Promise<void>;
+export {};

package/plugins/pageBuilder/utils.js

@@ -0,0 +1,184 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.updatePageSettings = exports.shouldUpdatePages = exports.hasPages = exports.getPagesDiff = exports.assignWorkflowToPage = void 0;
+
+var _get = _interopRequireDefault(require("lodash/get"));
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+var _types = require("../../types");
+
+var _utils = require("../utils");
+
+const isWorkflowApplicable = (page, workflow) => {
+  const application = workflow.app;
+
+  if (application !== _types.ApwWorkflowApplications.PB) {
+    return false;
+  }
+
+  const scopeType = workflow.scope.type;
+
+  if (scopeType === _types.WorkflowScopeTypes.DEFAULT) {
+    return true;
+  } else if (scopeType === _types.WorkflowScopeTypes.CUSTOM) {
+    const categories = (0, _get.default)(workflow, "scope.data.categories");
+
+    if (Array.isArray(categories) && categories.includes(page.category)) {
+      return true;
+    }
+
+    const pages = (0, _get.default)(workflow, "scope.data.pages");
+
+    if (Array.isArray(pages) && pages.includes(page.pid)) {
+      return true;
+    }
+
+    return false;
+  }
+
+  throw new _error.default(`Unknown scope type "${scopeType}".`, "UNKNOWN_SCOPE_TYPE", {
+    workflow
+  });
+};
+
+const assignWorkflowToPage = async ({
+  listWorkflow,
+  page
+}) => {
+  /**
+   * Lookup and assign "workflowId".
+   */
+  try {
+    /*
+     * List all workflows for app pageBuilder
+     */
+    const [entries] = await listWorkflow({
+      where: {
+        app: _types.ApwWorkflowApplications.PB
+      }
+    });
+    /*
+     *  Re-order them based on workflow scope and pre-defined rule i.e.
+     *  "specific" entry -> entry for a "category" -> "default".
+     *  There can be more than one workflow with same "scope" and "app".
+     *  Therefore, we are also sorting the workflows by `createdOn` to get the latest workflow.
+     */
+
+    const sortedWorkflows = entries.sort(_utils.workflowByPrecedenceDesc).sort(_utils.workflowByCreatedOnDesc);
+
+    for (const workflow of sortedWorkflows) {
+      /**
+       * Assign the first applicable workflow to the page and exit.
+       */
+      if (isWorkflowApplicable(page, workflow)) {
+        page.settings.apw = {
+          workflowId: workflow.id,
+          contentReviewId: null
+        };
+        break;
+      }
+    }
+  } catch (ex) {
+    throw new _error.default(`Failed to assign workflow to page "${page.pid}".`, ex.code, ex.data);
+  }
+};
+
+exports.assignWorkflowToPage = assignWorkflowToPage;
+
+const hasPages = workflow => {
+  const {
+    app,
+    scope
+  } = workflow;
+  return app === _types.ApwWorkflowApplications.PB && scope.type === _types.WorkflowScopeTypes.CUSTOM && scope.data && Array.isArray(scope.data.pages);
+};
+
+exports.hasPages = hasPages;
+
+const shouldUpdatePages = (scope, prevScope) => {
+  /**
+   * Bail out early if the scope is not "CUSTOM" - at that point all pages should be updated.
+   */
+  if (prevScope.type !== _types.WorkflowScopeTypes.CUSTOM) {
+    return true;
+  }
+
+  const prevScopePages = (0, _get.default)(prevScope, "data.pages");
+  const currentScopePages = (0, _get.default)(scope, "data.pages");
+  /**
+   * Bail out early if there were no pages assigned previously.
+   */
+
+  if (prevScopePages.length === 0) {
+    return true;
+  }
+  /**
+   * Bail out early if number of pages has been changed.
+   */
+
+
+  if (currentScopePages.length !== prevScopePages.length) {
+    return true;
+  }
+  /*
+   * Check whether previous scope has the exactly same pages as in the new scope.
+   */
+
+
+  return !prevScopePages.every(pid => currentScopePages.includes(pid));
+};
+
+exports.shouldUpdatePages = shouldUpdatePages;
+
+const getPagesDiff = (currentPages, prevPages) => {
+  const addedPages = currentPages.filter(id => !prevPages.includes(id));
+  const removedPages = prevPages.filter(id => !currentPages.includes(id));
+  return {
+    addedPages,
+    removedPages
+  };
+};
+
+exports.getPagesDiff = getPagesDiff;
+
+const updatePageSettings = async ({
+  getPage,
+  updatePage,
+  uniquePageId,
+  getNewSettings
+}) => {
+  try {
+    /**
+     * Currently, we only assign "workflow" to latest page.
+     */
+    const page = await getPage(uniquePageId);
+    /**
+     * We can't update a page that is "locked".
+     */
+
+    if (page.locked) {
+      return;
+    }
+    /**
+     * There can be more than one workflow with same `scope` for same `app`. That is why;
+     * We'll update the workflow reference even though it already had one assign.
+     */
+
+
+    await updatePage(page.id, {
+      settings: getNewSettings(page.settings)
+    });
+  } catch (e) {
+    if (e.code !== "NOT_FOUND") {
+      throw e;
+    }
+  }
+};
+
+exports.updatePageSettings = updatePageSettings;

package/plugins/pageBuilder/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["isWorkflowApplicable","page","workflow","application","app","ApwWorkflowApplications","PB","scopeType","scope","type","WorkflowScopeTypes","DEFAULT","CUSTOM","categories","get","Array","isArray","includes","category","pages","pid","WebinyError","assignWorkflowToPage","listWorkflow","entries","where","sortedWorkflows","sort","workflowByPrecedenceDesc","workflowByCreatedOnDesc","settings","apw","workflowId","id","contentReviewId","ex","code","data","hasPages","shouldUpdatePages","prevScope","prevScopePages","currentScopePages","length","every","getPagesDiff","currentPages","prevPages","addedPages","filter","removedPages","updatePageSettings","getPage","updatePage","uniquePageId","getNewSettings","locked","e"],"sources":["utils.ts"],"sourcesContent":["import get from \"lodash/get\";\nimport WebinyError from \"@webiny/error\";\nimport {\n    ApwWorkflow,\n    ApwWorkflowApplications,\n    ApwWorkflowCrud,\n    ApwWorkflowScope,\n    PageWithWorkflow,\n    WorkflowScopeTypes\n} from \"~/types\";\nimport { workflowByCreatedOnDesc, workflowByPrecedenceDesc } from \"~/plugins/utils\";\nimport { PageBuilderContextObject } from \"@webiny/api-page-builder/graphql/types\";\n\nconst isWorkflowApplicable = (page: PageWithWorkflow, workflow: ApwWorkflow) => {\n    const application = workflow.app;\n    if (application !== ApwWorkflowApplications.PB) {\n        return false;\n    }\n\n    const scopeType = workflow.scope.type;\n\n    if (scopeType === WorkflowScopeTypes.DEFAULT) {\n        return true;\n    } else if (scopeType === WorkflowScopeTypes.CUSTOM) {\n        const categories = get(workflow, \"scope.data.categories\");\n\n        if (Array.isArray(categories) && categories.includes(page.category)) {\n            return true;\n        }\n\n        const pages = get(workflow, \"scope.data.pages\");\n        if (Array.isArray(pages) && pages.includes(page.pid)) {\n            return true;\n        }\n        return false;\n    }\n    throw new WebinyError(`Unknown scope type \"${scopeType}\".`, \"UNKNOWN_SCOPE_TYPE\", {\n        workflow\n    });\n};\n\ninterface AssignWorkflowToPageParams {\n    listWorkflow: ApwWorkflowCrud[\"list\"];\n    page: PageWithWorkflow;\n}\n\nexport const assignWorkflowToPage = async ({ listWorkflow, page }: AssignWorkflowToPageParams) => {\n    /**\n     * Lookup and assign \"workflowId\".\n     */\n    try {\n        /*\n         * List all workflows for app pageBuilder\n         */\n        const [entries] = await listWorkflow({\n            where: {\n                app: ApwWorkflowApplications.PB\n            }\n        });\n\n        /*\n         *  Re-order them based on workflow scope and pre-defined rule i.e.\n         *  \"specific\" entry -> entry for a \"category\" -> \"default\".\n         *  There can be more than one workflow with same \"scope\" and \"app\".\n         *  Therefore, we are also sorting the workflows by `createdOn` to get the latest workflow.\n         */\n        const sortedWorkflows = entries\n            .sort(workflowByPrecedenceDesc)\n            .sort(workflowByCreatedOnDesc);\n\n        for (const workflow of sortedWorkflows) {\n            /**\n             * Assign the first applicable workflow to the page and exit.\n             */\n            if (isWorkflowApplicable(page, workflow)) {\n                page.settings.apw = {\n                    workflowId: workflow.id,\n                    contentReviewId: null\n                };\n                break;\n            }\n        }\n    } catch (ex) {\n        throw new WebinyError(`Failed to assign workflow to page \"${page.pid}\".`, ex.code, ex.data);\n    }\n};\n\nexport const hasPages = (workflow: ApwWorkflow): Boolean => {\n    const { app, scope } = workflow;\n    return (\n        app === ApwWorkflowApplications.PB &&\n        scope.type === WorkflowScopeTypes.CUSTOM &&\n        scope.data &&\n        Array.isArray(scope.data.pages)\n    );\n};\n\nexport const shouldUpdatePages = (\n    scope: ApwWorkflowScope,\n    prevScope: ApwWorkflowScope\n): Boolean => {\n    /**\n     * Bail out early if the scope is not \"CUSTOM\" - at that point all pages should be updated.\n     */\n    if (prevScope.type !== WorkflowScopeTypes.CUSTOM) {\n        return true;\n    }\n    const prevScopePages: string[] = get(prevScope, \"data.pages\") as unknown as string[];\n    const currentScopePages: string[] = get(scope, \"data.pages\") as unknown as string[];\n    /**\n     * Bail out early if there were no pages assigned previously.\n     */\n    if (prevScopePages.length === 0) {\n        return true;\n    }\n    /**\n     * Bail out early if number of pages has been changed.\n     */\n    if (currentScopePages.length !== prevScopePages.length) {\n        return true;\n    }\n    /*\n     * Check whether previous scope has the exactly same pages as in the new scope.\n     */\n    return !prevScopePages.every(pid => currentScopePages.includes(pid));\n};\n\ninterface GetUpdatePageOpsResult {\n    addedPages: string[];\n    removedPages: string[];\n}\n\nexport const getPagesDiff = (\n    currentPages: string[],\n    prevPages: string[]\n): GetUpdatePageOpsResult => {\n    const addedPages = currentPages.filter(id => !prevPages.includes(id));\n    const removedPages = prevPages.filter(id => !currentPages.includes(id));\n\n    return {\n        addedPages,\n        removedPages\n    };\n};\n\ninterface UpdatePageSettingsParams {\n    getPage: PageBuilderContextObject[\"getPage\"];\n    updatePage: PageBuilderContextObject[\"updatePage\"];\n    uniquePageId: string;\n    getNewSettings: (settings: PageWithWorkflow[\"settings\"]) => PageWithWorkflow[\"settings\"];\n}\n\nexport const updatePageSettings = async ({\n    getPage,\n    updatePage,\n    uniquePageId,\n    getNewSettings\n}: UpdatePageSettingsParams) => {\n    try {\n        /**\n         * Currently, we only assign \"workflow\" to latest page.\n         */\n        const page = await getPage<PageWithWorkflow>(uniquePageId);\n        /**\n         * We can't update a page that is \"locked\".\n         */\n        if (page.locked) {\n            return;\n        }\n        /**\n         * There can be more than one workflow with same `scope` for same `app`. That is why;\n         * We'll update the workflow reference even though it already had one assign.\n         */\n        await updatePage(page.id, {\n            settings: getNewSettings(page.settings)\n        });\n    } catch (e) {\n        if (e.code !== \"NOT_FOUND\") {\n            throw e;\n        }\n    }\n};\n"],"mappings":";;;;;;;;;AAAA;;AACA;;AACA;;AAQA;;AAGA,MAAMA,oBAAoB,GAAG,CAACC,IAAD,EAAyBC,QAAzB,KAAmD;EAC5E,MAAMC,WAAW,GAAGD,QAAQ,CAACE,GAA7B;;EACA,IAAID,WAAW,KAAKE,8BAAA,CAAwBC,EAA5C,EAAgD;IAC5C,OAAO,KAAP;EACH;;EAED,MAAMC,SAAS,GAAGL,QAAQ,CAACM,KAAT,CAAeC,IAAjC;;EAEA,IAAIF,SAAS,KAAKG,yBAAA,CAAmBC,OAArC,EAA8C;IAC1C,OAAO,IAAP;EACH,CAFD,MAEO,IAAIJ,SAAS,KAAKG,yBAAA,CAAmBE,MAArC,EAA6C;IAChD,MAAMC,UAAU,GAAG,IAAAC,YAAA,EAAIZ,QAAJ,EAAc,uBAAd,CAAnB;;IAEA,IAAIa,KAAK,CAACC,OAAN,CAAcH,UAAd,KAA6BA,UAAU,CAACI,QAAX,CAAoBhB,IAAI,CAACiB,QAAzB,CAAjC,EAAqE;MACjE,OAAO,IAAP;IACH;;IAED,MAAMC,KAAK,GAAG,IAAAL,YAAA,EAAIZ,QAAJ,EAAc,kBAAd,CAAd;;IACA,IAAIa,KAAK,CAACC,OAAN,CAAcG,KAAd,KAAwBA,KAAK,CAACF,QAAN,CAAehB,IAAI,CAACmB,GAApB,CAA5B,EAAsD;MAClD,OAAO,IAAP;IACH;;IACD,OAAO,KAAP;EACH;;EACD,MAAM,IAAIC,cAAJ,CAAiB,uBAAsBd,SAAU,IAAjD,EAAsD,oBAAtD,EAA4E;IAC9EL;EAD8E,CAA5E,CAAN;AAGH,CA1BD;;AAiCO,MAAMoB,oBAAoB,GAAG,OAAO;EAAEC,YAAF;EAAgBtB;AAAhB,CAAP,KAA8D;EAC9F;AACJ;AACA;EACI,IAAI;IACA;AACR;AACA;IACQ,MAAM,CAACuB,OAAD,IAAY,MAAMD,YAAY,CAAC;MACjCE,KAAK,EAAE;QACHrB,GAAG,EAAEC,8BAAA,CAAwBC;MAD1B;IAD0B,CAAD,CAApC;IAMA;AACR;AACA;AACA;AACA;AACA;;IACQ,MAAMoB,eAAe,GAAGF,OAAO,CAC1BG,IADmB,CACdC,+BADc,EAEnBD,IAFmB,CAEdE,8BAFc,CAAxB;;IAIA,KAAK,MAAM3B,QAAX,IAAuBwB,eAAvB,EAAwC;MACpC;AACZ;AACA;MACY,IAAI1B,oBAAoB,CAACC,IAAD,EAAOC,QAAP,CAAxB,EAA0C;QACtCD,IAAI,CAAC6B,QAAL,CAAcC,GAAd,GAAoB;UAChBC,UAAU,EAAE9B,QAAQ,CAAC+B,EADL;UAEhBC,eAAe,EAAE;QAFD,CAApB;QAIA;MACH;IACJ;EACJ,CAhCD,CAgCE,OAAOC,EAAP,EAAW;IACT,MAAM,IAAId,cAAJ,CAAiB,sCAAqCpB,IAAI,CAACmB,GAAI,IAA/D,EAAoEe,EAAE,CAACC,IAAvE,EAA6ED,EAAE,CAACE,IAAhF,CAAN;EACH;AACJ,CAvCM;;;;AAyCA,MAAMC,QAAQ,GAAIpC,QAAD,IAAoC;EACxD,MAAM;IAAEE,GAAF;IAAOI;EAAP,IAAiBN,QAAvB;EACA,OACIE,GAAG,KAAKC,8BAAA,CAAwBC,EAAhC,IACAE,KAAK,CAACC,IAAN,KAAeC,yBAAA,CAAmBE,MADlC,IAEAJ,KAAK,CAAC6B,IAFN,IAGAtB,KAAK,CAACC,OAAN,CAAcR,KAAK,CAAC6B,IAAN,CAAWlB,KAAzB,CAJJ;AAMH,CARM;;;;AAUA,MAAMoB,iBAAiB,GAAG,CAC7B/B,KAD6B,EAE7BgC,SAF6B,KAGnB;EACV;AACJ;AACA;EACI,IAAIA,SAAS,CAAC/B,IAAV,KAAmBC,yBAAA,CAAmBE,MAA1C,EAAkD;IAC9C,OAAO,IAAP;EACH;;EACD,MAAM6B,cAAwB,GAAG,IAAA3B,YAAA,EAAI0B,SAAJ,EAAe,YAAf,CAAjC;EACA,MAAME,iBAA2B,GAAG,IAAA5B,YAAA,EAAIN,KAAJ,EAAW,YAAX,CAApC;EACA;AACJ;AACA;;EACI,IAAIiC,cAAc,CAACE,MAAf,KAA0B,CAA9B,EAAiC;IAC7B,OAAO,IAAP;EACH;EACD;AACJ;AACA;;;EACI,IAAID,iBAAiB,CAACC,MAAlB,KAA6BF,cAAc,CAACE,MAAhD,EAAwD;IACpD,OAAO,IAAP;EACH;EACD;AACJ;AACA;;;EACI,OAAO,CAACF,cAAc,CAACG,KAAf,CAAqBxB,GAAG,IAAIsB,iBAAiB,CAACzB,QAAlB,CAA2BG,GAA3B,CAA5B,CAAR;AACH,CA5BM;;;;AAmCA,MAAMyB,YAAY,GAAG,CACxBC,YADwB,EAExBC,SAFwB,KAGC;EACzB,MAAMC,UAAU,GAAGF,YAAY,CAACG,MAAb,CAAoBhB,EAAE,IAAI,CAACc,SAAS,CAAC9B,QAAV,CAAmBgB,EAAnB,CAA3B,CAAnB;EACA,MAAMiB,YAAY,GAAGH,SAAS,CAACE,MAAV,CAAiBhB,EAAE,IAAI,CAACa,YAAY,CAAC7B,QAAb,CAAsBgB,EAAtB,CAAxB,CAArB;EAEA,OAAO;IACHe,UADG;IAEHE;EAFG,CAAP;AAIH,CAXM;;;;AAoBA,MAAMC,kBAAkB,GAAG,OAAO;EACrCC,OADqC;EAErCC,UAFqC;EAGrCC,YAHqC;EAIrCC;AAJqC,CAAP,KAKF;EAC5B,IAAI;IACA;AACR;AACA;IACQ,MAAMtD,IAAI,GAAG,MAAMmD,OAAO,CAAmBE,YAAnB,CAA1B;IACA;AACR;AACA;;IACQ,IAAIrD,IAAI,CAACuD,MAAT,EAAiB;MACb;IACH;IACD;AACR;AACA;AACA;;;IACQ,MAAMH,UAAU,CAACpD,IAAI,CAACgC,EAAN,EAAU;MACtBH,QAAQ,EAAEyB,cAAc,CAACtD,IAAI,CAAC6B,QAAN;IADF,CAAV,CAAhB;EAGH,CAlBD,CAkBE,OAAO2B,CAAP,EAAU;IACR,IAAIA,CAAC,CAACrB,IAAF,KAAW,WAAf,EAA4B;MACxB,MAAMqB,CAAN;IACH;EACJ;AACJ,CA7BM"}

package/plugins/utils.d.ts

@@ -0,0 +1,35 @@
+import { CmsModelField } from "@webiny/api-headless-cms/types";
+import { SecurityIdentity } from "@webiny/api-security/types";
+import { ApwChangeRequest, ApwContentReview, ApwContentReviewCrud, ApwContentReviewStep, ApwContentReviewStepStatus, ApwContext, ApwReviewerCrud, ApwWorkflow, ApwWorkflowStep, ApwWorkflowStepTypes } from "../types";
+export interface CreateModelFieldParams extends Omit<CmsModelField, "id" | "storageId" | "fieldId"> {
+    fieldId?: string;
+    parent: string;
+}
+export interface HasReviewersParams {
+    identity: SecurityIdentity;
+    step: ApwContentReviewStep;
+    getReviewer: ApwReviewerCrud["get"];
+}
+export declare const hasReviewer: (params: HasReviewersParams) => Promise<Boolean>;
+export declare const getValue: (object: Record<string, any>, key: string) => any;
+export declare const getContentReviewStepInitialStatus: (workflowSteps: ApwWorkflowStep[], index: number, previousStepStatus?: ApwContentReviewStepStatus) => ApwContentReviewStepStatus;
+export declare const getNextStepStatus: (previousStepType: ApwWorkflowStepTypes, previousStepStatus: ApwContentReviewStepStatus) => ApwContentReviewStepStatus;
+export interface ExtractContentReviewIdAndStepResult {
+    id: string;
+    stepId: string;
+}
+export declare const extractContentReviewIdAndStep: (step: ApwChangeRequest["step"]) => ExtractContentReviewIdAndStepResult;
+declare type SafelyGetContentReviewParams = Pick<UpdateContentReviewParams, "id" | "contentReviewMethods">;
+export declare const safelyGetContentReview: ({ id, contentReviewMethods }: SafelyGetContentReviewParams) => Promise<ApwContentReview | null>;
+export interface UpdateContentReviewParams {
+    id: string;
+    contentReviewMethods: ApwContentReviewCrud;
+    getNewContentReviewData: (entry: ApwContentReview) => ApwContentReview;
+}
+export declare const updateContentReview: ({ contentReviewMethods, id, getNewContentReviewData }: UpdateContentReviewParams) => Promise<void>;
+export declare const updateContentReviewStep: (steps: ApwContentReviewStep[], stepId: string, updater: (step: ApwContentReviewStep) => ApwContentReviewStep) => ApwContentReviewStep[];
+declare type CheckInstallationParams = Pick<ApwContext, "tenancy" | "i18n">;
+export declare const isInstallationPending: ({ tenancy, i18n }: CheckInstallationParams) => boolean;
+export declare const workflowByPrecedenceDesc: (a: ApwWorkflow, b: ApwWorkflow) => number;
+export declare const workflowByCreatedOnDesc: (a: ApwWorkflow, b: ApwWorkflow) => number;
+export {};