@webiny/api-apw 0.0.0-unstable.5e7233243f

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");
+
+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\");\n    const currentScopePages: string[] = get(scope, \"data.pages\");\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 declare const getNanoid: (size?: number | undefined) => string;
+export interface CreateModelFieldParams extends Omit<CmsModelField, "id" | "storageId" | "fieldId"> {
+    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 {};

package/plugins/utils.js

@@ -0,0 +1,197 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.workflowByPrecedenceDesc = exports.workflowByCreatedOnDesc = exports.updateContentReviewStep = exports.updateContentReview = exports.safelyGetContentReview = exports.isInstallationPending = exports.hasReviewer = exports.getValue = exports.getNextStepStatus = exports.getNanoid = exports.getContentReviewStepInitialStatus = exports.extractContentReviewIdAndStep = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _get = _interopRequireDefault(require("lodash/get"));
+
+var _nanoid = require("nanoid");
+
+var _types = require("../types");
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+const ALPHANUMERIC = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+const getNanoid = (0, _nanoid.customAlphabet)(ALPHANUMERIC, 10);
+exports.getNanoid = getNanoid;
+
+const hasReviewer = async params => {
+  const {
+    getReviewer,
+    identity,
+    step
+  } = params;
+
+  for (const stepReviewer of step.reviewers) {
+    const entry = await getReviewer(stepReviewer.id);
+
+    if (entry.identityId === identity.id) {
+      return true;
+    }
+  }
+
+  return false;
+};
+
+exports.hasReviewer = hasReviewer;
+
+const getValue = (object, key) => {
+  return (0, _get.default)(object, `values.${key}`);
+};
+
+exports.getValue = getValue;
+
+const getContentReviewStepInitialStatus = (workflowSteps, index, previousStepStatus) => {
+  /**
+   * Always set first step 'active' by default.
+   */
+  if (index === 0) {
+    return _types.ApwContentReviewStepStatus.ACTIVE;
+  }
+
+  const previousStep = workflowSteps[index - 1];
+
+  if (previousStepStatus === _types.ApwContentReviewStepStatus.ACTIVE && previousStep.type !== _types.ApwWorkflowStepTypes.MANDATORY_BLOCKING) {
+    return _types.ApwContentReviewStepStatus.ACTIVE;
+  }
+
+  return _types.ApwContentReviewStepStatus.INACTIVE;
+};
+
+exports.getContentReviewStepInitialStatus = getContentReviewStepInitialStatus;
+
+const getNextStepStatus = (previousStepType, previousStepStatus) => {
+  if (previousStepStatus === _types.ApwContentReviewStepStatus.DONE) {
+    return _types.ApwContentReviewStepStatus.ACTIVE;
+  }
+
+  if (previousStepStatus === _types.ApwContentReviewStepStatus.ACTIVE && previousStepType !== _types.ApwWorkflowStepTypes.MANDATORY_BLOCKING) {
+    return _types.ApwContentReviewStepStatus.ACTIVE;
+  }
+
+  return _types.ApwContentReviewStepStatus.INACTIVE;
+};
+
+exports.getNextStepStatus = getNextStepStatus;
+
+const extractContentReviewIdAndStep = step => {
+  /*
+   * Get associated content review entry.
+   */
+  const [entryId, version, stepId] = step.split("#");
+  const revisionId = `${entryId}#${version}`;
+  return {
+    id: revisionId,
+    stepId
+  };
+};
+
+exports.extractContentReviewIdAndStep = extractContentReviewIdAndStep;
+
+const safelyGetContentReview = async ({
+  id,
+  contentReviewMethods
+}) => {
+  let contentReviewEntry = null;
+
+  try {
+    contentReviewEntry = await contentReviewMethods.get(id);
+  } catch (e) {
+    if (e.message !== "index_not_found_exception" && e.code !== "NOT_FOUND") {
+      throw e;
+    }
+  }
+
+  return contentReviewEntry;
+};
+
+exports.safelyGetContentReview = safelyGetContentReview;
+
+const updateContentReview = async ({
+  contentReviewMethods,
+  id,
+  getNewContentReviewData
+}) => {
+  const contentReviewEntry = await safelyGetContentReview({
+    id,
+    contentReviewMethods
+  });
+
+  if (contentReviewEntry) {
+    const newContentReviewData = getNewContentReviewData(contentReviewEntry);
+    /**
+     * Update content review entry.
+     */
+
+    await contentReviewMethods.update(contentReviewEntry.id, newContentReviewData);
+  }
+};
+
+exports.updateContentReview = updateContentReview;
+
+const updateContentReviewStep = (steps, stepId, updater) => {
+  return steps.map(step => {
+    if (step.id === stepId) {
+      return _objectSpread({}, updater(step));
+    }
+
+    return step;
+  });
+};
+
+exports.updateContentReviewStep = updateContentReviewStep;
+
+const isInstallationPending = ({
+  tenancy,
+  i18n
+}) => {
+  /**
+   * In case of a fresh webiny project "tenant" and "locale" won't be there until
+   * installation is completed. So, we need to skip "APW" creation till then.
+   */
+  const tenant = tenancy.getCurrentTenant();
+
+  if (!tenant) {
+    return true;
+  }
+
+  return !i18n.getContentLocale();
+};
+
+exports.isInstallationPending = isInstallationPending;
+const WORKFLOW_PRECEDENCE = {
+  [_types.WorkflowScopeTypes.DEFAULT]: 0,
+  [_types.WorkflowScopeTypes.CUSTOM]: 1
+};
+
+const workflowByPrecedenceDesc = (a, b) => {
+  const scoreA = WORKFLOW_PRECEDENCE[a.scope.type];
+  const scoreB = WORKFLOW_PRECEDENCE[b.scope.type];
+  /**
+   * In descending order of workflow precedence.
+   */
+
+  return scoreB - scoreA;
+};
+
+exports.workflowByPrecedenceDesc = workflowByPrecedenceDesc;
+
+const workflowByCreatedOnDesc = (a, b) => {
+  const createdOnA = (0, _get.default)(a, "createdOn");
+  const createdOnB = (0, _get.default)(b, "createdOn");
+  /**
+   * In descending order of workflow createdOn i.e. the most recent one first.
+   */
+
+  return new Date(createdOnB).getTime() - new Date(createdOnA).getTime();
+};
+
+exports.workflowByCreatedOnDesc = workflowByCreatedOnDesc;

package/plugins/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["ALPHANUMERIC","getNanoid","customAlphabet","hasReviewer","params","getReviewer","identity","step","stepReviewer","reviewers","entry","id","identityId","getValue","object","key","get","getContentReviewStepInitialStatus","workflowSteps","index","previousStepStatus","ApwContentReviewStepStatus","ACTIVE","previousStep","type","ApwWorkflowStepTypes","MANDATORY_BLOCKING","INACTIVE","getNextStepStatus","previousStepType","DONE","extractContentReviewIdAndStep","entryId","version","stepId","split","revisionId","safelyGetContentReview","contentReviewMethods","contentReviewEntry","e","message","code","updateContentReview","getNewContentReviewData","newContentReviewData","update","updateContentReviewStep","steps","updater","map","isInstallationPending","tenancy","i18n","tenant","getCurrentTenant","getContentLocale","WORKFLOW_PRECEDENCE","WorkflowScopeTypes","DEFAULT","CUSTOM","workflowByPrecedenceDesc","a","b","scoreA","scope","scoreB","workflowByCreatedOnDesc","createdOnA","createdOnB","Date","getTime"],"sources":["utils.ts"],"sourcesContent":["import get from \"lodash/get\";\nimport { customAlphabet } from \"nanoid\";\nimport { CmsModelField } from \"@webiny/api-headless-cms/types\";\nimport { SecurityIdentity } from \"@webiny/api-security/types\";\nimport {\n    ApwChangeRequest,\n    ApwContentReview,\n    ApwContentReviewCrud,\n    ApwContentReviewStep,\n    ApwContentReviewStepStatus,\n    ApwContext,\n    ApwReviewerCrud,\n    ApwWorkflow,\n    ApwWorkflowStep,\n    ApwWorkflowStepTypes,\n    WorkflowScopeTypes\n} from \"~/types\";\n\nconst ALPHANUMERIC = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\";\nexport const getNanoid = customAlphabet(ALPHANUMERIC, 10);\n\nexport interface CreateModelFieldParams\n    extends Omit<CmsModelField, \"id\" | \"storageId\" | \"fieldId\"> {\n    parent: string;\n}\n\nexport interface HasReviewersParams {\n    identity: SecurityIdentity;\n    step: ApwContentReviewStep;\n    getReviewer: ApwReviewerCrud[\"get\"];\n}\n\nexport const hasReviewer = async (params: HasReviewersParams): Promise<Boolean> => {\n    const { getReviewer, identity, step } = params;\n    for (const stepReviewer of step.reviewers) {\n        const entry = await getReviewer(stepReviewer.id);\n\n        if (entry.identityId === identity.id) {\n            return true;\n        }\n    }\n\n    return false;\n};\n\nexport const getValue = (object: Record<string, any>, key: string) => {\n    return get(object, `values.${key}`);\n};\n\nexport const getContentReviewStepInitialStatus = (\n    workflowSteps: ApwWorkflowStep[],\n    index: number,\n    previousStepStatus?: ApwContentReviewStepStatus\n): ApwContentReviewStepStatus => {\n    /**\n     * Always set first step 'active' by default.\n     */\n    if (index === 0) {\n        return ApwContentReviewStepStatus.ACTIVE;\n    }\n\n    const previousStep = workflowSteps[index - 1];\n    if (\n        previousStepStatus === ApwContentReviewStepStatus.ACTIVE &&\n        previousStep.type !== ApwWorkflowStepTypes.MANDATORY_BLOCKING\n    ) {\n        return ApwContentReviewStepStatus.ACTIVE;\n    }\n\n    return ApwContentReviewStepStatus.INACTIVE;\n};\n\nexport const getNextStepStatus = (\n    previousStepType: ApwWorkflowStepTypes,\n    previousStepStatus: ApwContentReviewStepStatus\n): ApwContentReviewStepStatus => {\n    if (previousStepStatus === ApwContentReviewStepStatus.DONE) {\n        return ApwContentReviewStepStatus.ACTIVE;\n    }\n\n    if (\n        previousStepStatus === ApwContentReviewStepStatus.ACTIVE &&\n        previousStepType !== ApwWorkflowStepTypes.MANDATORY_BLOCKING\n    ) {\n        return ApwContentReviewStepStatus.ACTIVE;\n    }\n\n    return ApwContentReviewStepStatus.INACTIVE;\n};\n\nexport interface ExtractContentReviewIdAndStepResult {\n    id: string;\n    stepId: string;\n}\n\nexport const extractContentReviewIdAndStep = (\n    step: ApwChangeRequest[\"step\"]\n): ExtractContentReviewIdAndStepResult => {\n    /*\n     * Get associated content review entry.\n     */\n    const [entryId, version, stepId] = step.split(\"#\");\n    const revisionId = `${entryId}#${version}`;\n\n    return {\n        id: revisionId,\n        stepId\n    };\n};\n\ntype SafelyGetContentReviewParams = Pick<UpdateContentReviewParams, \"id\" | \"contentReviewMethods\">;\n\nexport const safelyGetContentReview = async ({\n    id,\n    contentReviewMethods\n}: SafelyGetContentReviewParams): Promise<ApwContentReview | null> => {\n    let contentReviewEntry = null;\n    try {\n        contentReviewEntry = await contentReviewMethods.get(id);\n    } catch (e) {\n        if (e.message !== \"index_not_found_exception\" && e.code !== \"NOT_FOUND\") {\n            throw e;\n        }\n    }\n\n    return contentReviewEntry;\n};\n\nexport interface UpdateContentReviewParams {\n    id: string;\n    contentReviewMethods: ApwContentReviewCrud;\n    getNewContentReviewData: (entry: ApwContentReview) => ApwContentReview;\n}\n\nexport const updateContentReview = async ({\n    contentReviewMethods,\n    id,\n    getNewContentReviewData\n}: UpdateContentReviewParams): Promise<void> => {\n    const contentReviewEntry = await safelyGetContentReview({ id, contentReviewMethods });\n    if (contentReviewEntry) {\n        const newContentReviewData = getNewContentReviewData(contentReviewEntry);\n        /**\n         * Update content review entry.\n         */\n        await contentReviewMethods.update(contentReviewEntry.id, newContentReviewData);\n    }\n};\n\nexport const updateContentReviewStep = (\n    steps: ApwContentReviewStep[],\n    stepId: string,\n    updater: (step: ApwContentReviewStep) => ApwContentReviewStep\n): ApwContentReviewStep[] => {\n    return steps.map(step => {\n        if (step.id === stepId) {\n            return {\n                ...updater(step)\n            };\n        }\n        return step;\n    });\n};\n\ntype CheckInstallationParams = Pick<ApwContext, \"tenancy\" | \"i18n\">;\n\nexport const isInstallationPending = ({ tenancy, i18n }: CheckInstallationParams): boolean => {\n    /**\n     * In case of a fresh webiny project \"tenant\" and \"locale\" won't be there until\n     * installation is completed. So, we need to skip \"APW\" creation till then.\n     */\n    const tenant = tenancy.getCurrentTenant();\n    if (!tenant) {\n        return true;\n    }\n\n    return !i18n.getContentLocale();\n};\n\nconst WORKFLOW_PRECEDENCE = {\n    [WorkflowScopeTypes.DEFAULT]: 0,\n    [WorkflowScopeTypes.CUSTOM]: 1\n};\n\nexport const workflowByPrecedenceDesc = (a: ApwWorkflow, b: ApwWorkflow) => {\n    const scoreA = WORKFLOW_PRECEDENCE[a.scope.type];\n    const scoreB = WORKFLOW_PRECEDENCE[b.scope.type];\n    /**\n     * In descending order of workflow precedence.\n     */\n    return scoreB - scoreA;\n};\n\nexport const workflowByCreatedOnDesc = (a: ApwWorkflow, b: ApwWorkflow) => {\n    const createdOnA = get(a, \"createdOn\");\n    const createdOnB = get(b, \"createdOn\");\n    /**\n     * In descending order of workflow createdOn i.e. the most recent one first.\n     */\n    return new Date(createdOnB).getTime() - new Date(createdOnA).getTime();\n};\n"],"mappings":";;;;;;;;;;;AAAA;;AACA;;AAGA;;;;;;AAcA,MAAMA,YAAY,GAAG,gEAArB;AACO,MAAMC,SAAS,GAAG,IAAAC,sBAAA,EAAeF,YAAf,EAA6B,EAA7B,CAAlB;;;AAaA,MAAMG,WAAW,GAAG,MAAOC,MAAP,IAAwD;EAC/E,MAAM;IAAEC,WAAF;IAAeC,QAAf;IAAyBC;EAAzB,IAAkCH,MAAxC;;EACA,KAAK,MAAMI,YAAX,IAA2BD,IAAI,CAACE,SAAhC,EAA2C;IACvC,MAAMC,KAAK,GAAG,MAAML,WAAW,CAACG,YAAY,CAACG,EAAd,CAA/B;;IAEA,IAAID,KAAK,CAACE,UAAN,KAAqBN,QAAQ,CAACK,EAAlC,EAAsC;MAClC,OAAO,IAAP;IACH;EACJ;;EAED,OAAO,KAAP;AACH,CAXM;;;;AAaA,MAAME,QAAQ,GAAG,CAACC,MAAD,EAA8BC,GAA9B,KAA8C;EAClE,OAAO,IAAAC,YAAA,EAAIF,MAAJ,EAAa,UAASC,GAAI,EAA1B,CAAP;AACH,CAFM;;;;AAIA,MAAME,iCAAiC,GAAG,CAC7CC,aAD6C,EAE7CC,KAF6C,EAG7CC,kBAH6C,KAIhB;EAC7B;AACJ;AACA;EACI,IAAID,KAAK,KAAK,CAAd,EAAiB;IACb,OAAOE,iCAAA,CAA2BC,MAAlC;EACH;;EAED,MAAMC,YAAY,GAAGL,aAAa,CAACC,KAAK,GAAG,CAAT,CAAlC;;EACA,IACIC,kBAAkB,KAAKC,iCAAA,CAA2BC,MAAlD,IACAC,YAAY,CAACC,IAAb,KAAsBC,2BAAA,CAAqBC,kBAF/C,EAGE;IACE,OAAOL,iCAAA,CAA2BC,MAAlC;EACH;;EAED,OAAOD,iCAAA,CAA2BM,QAAlC;AACH,CArBM;;;;AAuBA,MAAMC,iBAAiB,GAAG,CAC7BC,gBAD6B,EAE7BT,kBAF6B,KAGA;EAC7B,IAAIA,kBAAkB,KAAKC,iCAAA,CAA2BS,IAAtD,EAA4D;IACxD,OAAOT,iCAAA,CAA2BC,MAAlC;EACH;;EAED,IACIF,kBAAkB,KAAKC,iCAAA,CAA2BC,MAAlD,IACAO,gBAAgB,KAAKJ,2BAAA,CAAqBC,kBAF9C,EAGE;IACE,OAAOL,iCAAA,CAA2BC,MAAlC;EACH;;EAED,OAAOD,iCAAA,CAA2BM,QAAlC;AACH,CAhBM;;;;AAuBA,MAAMI,6BAA6B,GACtCxB,IADyC,IAEH;EACtC;AACJ;AACA;EACI,MAAM,CAACyB,OAAD,EAAUC,OAAV,EAAmBC,MAAnB,IAA6B3B,IAAI,CAAC4B,KAAL,CAAW,GAAX,CAAnC;EACA,MAAMC,UAAU,GAAI,GAAEJ,OAAQ,IAAGC,OAAQ,EAAzC;EAEA,OAAO;IACHtB,EAAE,EAAEyB,UADD;IAEHF;EAFG,CAAP;AAIH,CAbM;;;;AAiBA,MAAMG,sBAAsB,GAAG,OAAO;EACzC1B,EADyC;EAEzC2B;AAFyC,CAAP,KAGgC;EAClE,IAAIC,kBAAkB,GAAG,IAAzB;;EACA,IAAI;IACAA,kBAAkB,GAAG,MAAMD,oBAAoB,CAACtB,GAArB,CAAyBL,EAAzB,CAA3B;EACH,CAFD,CAEE,OAAO6B,CAAP,EAAU;IACR,IAAIA,CAAC,CAACC,OAAF,KAAc,2BAAd,IAA6CD,CAAC,CAACE,IAAF,KAAW,WAA5D,EAAyE;MACrE,MAAMF,CAAN;IACH;EACJ;;EAED,OAAOD,kBAAP;AACH,CAdM;;;;AAsBA,MAAMI,mBAAmB,GAAG,OAAO;EACtCL,oBADsC;EAEtC3B,EAFsC;EAGtCiC;AAHsC,CAAP,KAIa;EAC5C,MAAML,kBAAkB,GAAG,MAAMF,sBAAsB,CAAC;IAAE1B,EAAF;IAAM2B;EAAN,CAAD,CAAvD;;EACA,IAAIC,kBAAJ,EAAwB;IACpB,MAAMM,oBAAoB,GAAGD,uBAAuB,CAACL,kBAAD,CAApD;IACA;AACR;AACA;;IACQ,MAAMD,oBAAoB,CAACQ,MAArB,CAA4BP,kBAAkB,CAAC5B,EAA/C,EAAmDkC,oBAAnD,CAAN;EACH;AACJ,CAbM;;;;AAeA,MAAME,uBAAuB,GAAG,CACnCC,KADmC,EAEnCd,MAFmC,EAGnCe,OAHmC,KAIV;EACzB,OAAOD,KAAK,CAACE,GAAN,CAAU3C,IAAI,IAAI;IACrB,IAAIA,IAAI,CAACI,EAAL,KAAYuB,MAAhB,EAAwB;MACpB,yBACOe,OAAO,CAAC1C,IAAD,CADd;IAGH;;IACD,OAAOA,IAAP;EACH,CAPM,CAAP;AAQH,CAbM;;;;AAiBA,MAAM4C,qBAAqB,GAAG,CAAC;EAAEC,OAAF;EAAWC;AAAX,CAAD,KAAyD;EAC1F;AACJ;AACA;AACA;EACI,MAAMC,MAAM,GAAGF,OAAO,CAACG,gBAAR,EAAf;;EACA,IAAI,CAACD,MAAL,EAAa;IACT,OAAO,IAAP;EACH;;EAED,OAAO,CAACD,IAAI,CAACG,gBAAL,EAAR;AACH,CAXM;;;AAaP,MAAMC,mBAAmB,GAAG;EACxB,CAACC,yBAAA,CAAmBC,OAApB,GAA8B,CADN;EAExB,CAACD,yBAAA,CAAmBE,MAApB,GAA6B;AAFL,CAA5B;;AAKO,MAAMC,wBAAwB,GAAG,CAACC,CAAD,EAAiBC,CAAjB,KAAoC;EACxE,MAAMC,MAAM,GAAGP,mBAAmB,CAACK,CAAC,CAACG,KAAF,CAAQzC,IAAT,CAAlC;EACA,MAAM0C,MAAM,GAAGT,mBAAmB,CAACM,CAAC,CAACE,KAAF,CAAQzC,IAAT,CAAlC;EACA;AACJ;AACA;;EACI,OAAO0C,MAAM,GAAGF,MAAhB;AACH,CAPM;;;;AASA,MAAMG,uBAAuB,GAAG,CAACL,CAAD,EAAiBC,CAAjB,KAAoC;EACvE,MAAMK,UAAU,GAAG,IAAApD,YAAA,EAAI8C,CAAJ,EAAO,WAAP,CAAnB;EACA,MAAMO,UAAU,GAAG,IAAArD,YAAA,EAAI+C,CAAJ,EAAO,WAAP,CAAnB;EACA;AACJ;AACA;;EACI,OAAO,IAAIO,IAAJ,CAASD,UAAT,EAAqBE,OAArB,KAAiC,IAAID,IAAJ,CAASF,UAAT,EAAqBG,OAArB,EAAxC;AACH,CAPM"}

package/scheduler/createScheduleActionMethods.d.ts

@@ -0,0 +1,2 @@
+import { ApwScheduleActionCrud, CreateScheduleActionParams } from "./types";
+export declare function createScheduleActionMethods({ storageOperations, getIdentity, getTenant, getLocale }: CreateScheduleActionParams): ApwScheduleActionCrud;

package/scheduler/createScheduleActionMethods.js

@@ -0,0 +1,146 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createScheduleActionMethods = createScheduleActionMethods;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _mdbid = _interopRequireDefault(require("mdbid"));
+
+var _fields = require("@commodo/fields");
+
+var _validation = require("@webiny/validation");
+
+var _types = require("./types");
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+const CreateDataModel = (0, _fields.withFields)(instance => {
+  return {
+    datetime: (0, _fields.string)({
+      validation: _validation.validation.create(`required`)
+    }),
+    type: (0, _fields.string)({
+      validation: _validation.validation.create(`required,in:${_types.ApwContentTypes.PAGE}:${_types.ApwContentTypes.CMS_ENTRY}`)
+    }),
+    action: (0, _fields.string)({
+      validation: _validation.validation.create(`required,in:${_types.ApwScheduleActionTypes.PUBLISH}:${_types.ApwScheduleActionTypes.UNPUBLISH}`)
+    }),
+    entryId: (0, _fields.string)({
+      validation: _validation.validation.create(`required`)
+    }),
+    modelId: (0, _fields.string)({
+      validation: value => {
+        if (instance.type !== _types.ApwContentTypes.CMS_ENTRY) {
+          return true;
+        } else if (!!value) {
+          return true;
+        }
+
+        throw new Error(`There is no modelId defined when type is "${_types.ApwContentTypes.CMS_ENTRY}"`);
+      }
+    })
+  };
+})();
+
+function createScheduleActionMethods({
+  storageOperations,
+  getIdentity,
+  getTenant,
+  getLocale
+}) {
+  const getTenantAndLocale = () => {
+    const tenant = getTenant().id;
+    const locale = getLocale().code;
+    return {
+      tenant,
+      locale
+    };
+  };
+
+  return {
+    async get(id) {
+      return storageOperations.get({
+        where: _objectSpread({
+          id
+        }, getTenantAndLocale())
+      });
+    },
+
+    async list(params) {
+      return storageOperations.list(_objectSpread(_objectSpread({}, params), {}, {
+        where: _objectSpread(_objectSpread({}, params.where), getTenantAndLocale())
+      }));
+    },
+
+    async create(input) {
+      const createDataModel = new CreateDataModel().populate(input);
+      await createDataModel.validate();
+      const id = (0, _mdbid.default)();
+      const identity = getIdentity();
+      const data = await createDataModel.toJSON();
+
+      const scheduleAction = _objectSpread(_objectSpread({}, getTenantAndLocale()), {}, {
+        data,
+        id,
+        createdOn: new Date().toISOString(),
+        savedOn: new Date().toISOString(),
+        createdBy: {
+          id: identity.id,
+          type: identity.type,
+          displayName: identity.displayName
+        }
+      });
+
+      return await storageOperations.create({
+        item: scheduleAction,
+        input
+      });
+    },
+
+    async update(id, data) {
+      const updateDataModel = new CreateDataModel().populate(data);
+      await updateDataModel.validate();
+      const original = await this.get(id);
+
+      if (!original) {
+        throw new Error("Not found!");
+      }
+
+      return await storageOperations.update({
+        item: original,
+        input: data
+      });
+    },
+
+    async delete(id) {
+      await storageOperations.delete(_objectSpread({
+        id
+      }, getTenantAndLocale()));
+      return true;
+    },
+
+    async getCurrentTask() {
+      return await storageOperations.getCurrentTask({
+        where: _objectSpread({}, getTenantAndLocale())
+      });
+    },
+
+    async updateCurrentTask(item) {
+      return await storageOperations.updateCurrentTask({
+        item
+      });
+    },
+
+    async deleteCurrentTask() {
+      return await storageOperations.deleteCurrentTask(_objectSpread({}, getTenantAndLocale()));
+    }
+
+  };
+}

package/scheduler/createScheduleActionMethods.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["CreateDataModel","withFields","instance","datetime","string","validation","create","type","ApwContentTypes","PAGE","CMS_ENTRY","action","ApwScheduleActionTypes","PUBLISH","UNPUBLISH","entryId","modelId","value","Error","createScheduleActionMethods","storageOperations","getIdentity","getTenant","getLocale","getTenantAndLocale","tenant","id","locale","code","get","where","list","params","input","createDataModel","populate","validate","mdbid","identity","data","toJSON","scheduleAction","createdOn","Date","toISOString","savedOn","createdBy","displayName","item","update","updateDataModel","original","delete","getCurrentTask","updateCurrentTask","deleteCurrentTask"],"sources":["createScheduleActionMethods.ts"],"sourcesContent":["/**\n * Package mdbid does not have types.\n */\n// @ts-ignore\nimport mdbid from \"mdbid\";\n/**\n * Package @commodo/fields does not have types.\n */\n// @ts-ignore\nimport { string, withFields } from \"@commodo/fields\";\nimport { validation } from \"@webiny/validation\";\nimport {\n    ApwContentTypes,\n    ApwScheduleAction,\n    ApwScheduleActionCrud,\n    ApwScheduleActionData,\n    ApwScheduleActionTypes,\n    CreateScheduleActionParams\n} from \"~/scheduler/types\";\n\nconst CreateDataModel = withFields((instance: any) => {\n    return {\n        datetime: string({\n            validation: validation.create(`required`)\n        }),\n        type: string({\n            validation: validation.create(\n                `required,in:${ApwContentTypes.PAGE}:${ApwContentTypes.CMS_ENTRY}`\n            )\n        }),\n        action: string({\n            validation: validation.create(\n                `required,in:${ApwScheduleActionTypes.PUBLISH}:${ApwScheduleActionTypes.UNPUBLISH}`\n            )\n        }),\n        entryId: string({\n            validation: validation.create(`required`)\n        }),\n        modelId: string({\n            validation: (value: string) => {\n                if (instance.type !== ApwContentTypes.CMS_ENTRY) {\n                    return true;\n                } else if (!!value) {\n                    return true;\n                }\n                throw new Error(\n                    `There is no modelId defined when type is \"${ApwContentTypes.CMS_ENTRY}\"`\n                );\n            }\n        })\n    };\n})();\n\ninterface GetTenantAndLocaleResult {\n    tenant: string;\n    locale: string;\n}\n\nexport function createScheduleActionMethods({\n    storageOperations,\n    getIdentity,\n    getTenant,\n    getLocale\n}: CreateScheduleActionParams): ApwScheduleActionCrud {\n    const getTenantAndLocale = (): GetTenantAndLocaleResult => {\n        const tenant = getTenant().id;\n        const locale = getLocale().code;\n        return {\n            tenant,\n            locale\n        };\n    };\n    return {\n        async get(id) {\n            return storageOperations.get({\n                where: {\n                    id,\n                    ...getTenantAndLocale()\n                }\n            });\n        },\n        async list(params) {\n            return storageOperations.list({\n                ...params,\n                where: {\n                    ...params.where,\n                    ...getTenantAndLocale()\n                }\n            });\n        },\n        async create(input) {\n            const createDataModel = new CreateDataModel().populate(input);\n\n            await createDataModel.validate();\n\n            const id: string = mdbid();\n            const identity = getIdentity();\n\n            const data: ApwScheduleActionData = await createDataModel.toJSON();\n\n            const scheduleAction: ApwScheduleAction = {\n                ...getTenantAndLocale(),\n                data,\n                id,\n                createdOn: new Date().toISOString(),\n                savedOn: new Date().toISOString(),\n                createdBy: {\n                    id: identity.id,\n                    type: identity.type,\n                    displayName: identity.displayName\n                }\n            };\n\n            return await storageOperations.create({\n                item: scheduleAction,\n                input\n            });\n        },\n        async update(id, data) {\n            const updateDataModel = new CreateDataModel().populate(data);\n\n            await updateDataModel.validate();\n\n            const original = await this.get(id);\n\n            if (!original) {\n                throw new Error(\"Not found!\");\n            }\n\n            return await storageOperations.update({ item: original, input: data });\n        },\n        async delete(id: string) {\n            await storageOperations.delete({ id, ...getTenantAndLocale() });\n\n            return true;\n        },\n        async getCurrentTask() {\n            return await storageOperations.getCurrentTask({ where: { ...getTenantAndLocale() } });\n        },\n        async updateCurrentTask(item) {\n            return await storageOperations.updateCurrentTask({ item });\n        },\n        async deleteCurrentTask() {\n            return await storageOperations.deleteCurrentTask({ ...getTenantAndLocale() });\n        }\n    };\n}\n"],"mappings":";;;;;;;;;;;AAIA;;AAKA;;AACA;;AACA;;;;;;AASA,MAAMA,eAAe,GAAG,IAAAC,kBAAA,EAAYC,QAAD,IAAmB;EAClD,OAAO;IACHC,QAAQ,EAAE,IAAAC,cAAA,EAAO;MACbC,UAAU,EAAEA,sBAAA,CAAWC,MAAX,CAAmB,UAAnB;IADC,CAAP,CADP;IAIHC,IAAI,EAAE,IAAAH,cAAA,EAAO;MACTC,UAAU,EAAEA,sBAAA,CAAWC,MAAX,CACP,eAAcE,sBAAA,CAAgBC,IAAK,IAAGD,sBAAA,CAAgBE,SAAU,EADzD;IADH,CAAP,CAJH;IASHC,MAAM,EAAE,IAAAP,cAAA,EAAO;MACXC,UAAU,EAAEA,sBAAA,CAAWC,MAAX,CACP,eAAcM,6BAAA,CAAuBC,OAAQ,IAAGD,6BAAA,CAAuBE,SAAU,EAD1E;IADD,CAAP,CATL;IAcHC,OAAO,EAAE,IAAAX,cAAA,EAAO;MACZC,UAAU,EAAEA,sBAAA,CAAWC,MAAX,CAAmB,UAAnB;IADA,CAAP,CAdN;IAiBHU,OAAO,EAAE,IAAAZ,cAAA,EAAO;MACZC,UAAU,EAAGY,KAAD,IAAmB;QAC3B,IAAIf,QAAQ,CAACK,IAAT,KAAkBC,sBAAA,CAAgBE,SAAtC,EAAiD;UAC7C,OAAO,IAAP;QACH,CAFD,MAEO,IAAI,CAAC,CAACO,KAAN,EAAa;UAChB,OAAO,IAAP;QACH;;QACD,MAAM,IAAIC,KAAJ,CACD,6CAA4CV,sBAAA,CAAgBE,SAAU,GADrE,CAAN;MAGH;IAVW,CAAP;EAjBN,CAAP;AA8BH,CA/BuB,GAAxB;;AAsCO,SAASS,2BAAT,CAAqC;EACxCC,iBADwC;EAExCC,WAFwC;EAGxCC,SAHwC;EAIxCC;AAJwC,CAArC,EAK+C;EAClD,MAAMC,kBAAkB,GAAG,MAAgC;IACvD,MAAMC,MAAM,GAAGH,SAAS,GAAGI,EAA3B;IACA,MAAMC,MAAM,GAAGJ,SAAS,GAAGK,IAA3B;IACA,OAAO;MACHH,MADG;MAEHE;IAFG,CAAP;EAIH,CAPD;;EAQA,OAAO;IACH,MAAME,GAAN,CAAUH,EAAV,EAAc;MACV,OAAON,iBAAiB,CAACS,GAAlB,CAAsB;QACzBC,KAAK;UACDJ;QADC,GAEEF,kBAAkB,EAFpB;MADoB,CAAtB,CAAP;IAMH,CARE;;IASH,MAAMO,IAAN,CAAWC,MAAX,EAAmB;MACf,OAAOZ,iBAAiB,CAACW,IAAlB,iCACAC,MADA;QAEHF,KAAK,kCACEE,MAAM,CAACF,KADT,GAEEN,kBAAkB,EAFpB;MAFF,GAAP;IAOH,CAjBE;;IAkBH,MAAMlB,MAAN,CAAa2B,KAAb,EAAoB;MAChB,MAAMC,eAAe,GAAG,IAAIlC,eAAJ,GAAsBmC,QAAtB,CAA+BF,KAA/B,CAAxB;MAEA,MAAMC,eAAe,CAACE,QAAhB,EAAN;MAEA,MAAMV,EAAU,GAAG,IAAAW,cAAA,GAAnB;MACA,MAAMC,QAAQ,GAAGjB,WAAW,EAA5B;MAEA,MAAMkB,IAA2B,GAAG,MAAML,eAAe,CAACM,MAAhB,EAA1C;;MAEA,MAAMC,cAAiC,mCAChCjB,kBAAkB,EADc;QAEnCe,IAFmC;QAGnCb,EAHmC;QAInCgB,SAAS,EAAE,IAAIC,IAAJ,GAAWC,WAAX,EAJwB;QAKnCC,OAAO,EAAE,IAAIF,IAAJ,GAAWC,WAAX,EAL0B;QAMnCE,SAAS,EAAE;UACPpB,EAAE,EAAEY,QAAQ,CAACZ,EADN;UAEPnB,IAAI,EAAE+B,QAAQ,CAAC/B,IAFR;UAGPwC,WAAW,EAAET,QAAQ,CAACS;QAHf;MANwB,EAAvC;;MAaA,OAAO,MAAM3B,iBAAiB,CAACd,MAAlB,CAAyB;QAClC0C,IAAI,EAAEP,cAD4B;QAElCR;MAFkC,CAAzB,CAAb;IAIH,CA7CE;;IA8CH,MAAMgB,MAAN,CAAavB,EAAb,EAAiBa,IAAjB,EAAuB;MACnB,MAAMW,eAAe,GAAG,IAAIlD,eAAJ,GAAsBmC,QAAtB,CAA+BI,IAA/B,CAAxB;MAEA,MAAMW,eAAe,CAACd,QAAhB,EAAN;MAEA,MAAMe,QAAQ,GAAG,MAAM,KAAKtB,GAAL,CAASH,EAAT,CAAvB;;MAEA,IAAI,CAACyB,QAAL,EAAe;QACX,MAAM,IAAIjC,KAAJ,CAAU,YAAV,CAAN;MACH;;MAED,OAAO,MAAME,iBAAiB,CAAC6B,MAAlB,CAAyB;QAAED,IAAI,EAAEG,QAAR;QAAkBlB,KAAK,EAAEM;MAAzB,CAAzB,CAAb;IACH,CA1DE;;IA2DH,MAAMa,MAAN,CAAa1B,EAAb,EAAyB;MACrB,MAAMN,iBAAiB,CAACgC,MAAlB;QAA2B1B;MAA3B,GAAkCF,kBAAkB,EAApD,EAAN;MAEA,OAAO,IAAP;IACH,CA/DE;;IAgEH,MAAM6B,cAAN,GAAuB;MACnB,OAAO,MAAMjC,iBAAiB,CAACiC,cAAlB,CAAiC;QAAEvB,KAAK,oBAAON,kBAAkB,EAAzB;MAAP,CAAjC,CAAb;IACH,CAlEE;;IAmEH,MAAM8B,iBAAN,CAAwBN,IAAxB,EAA8B;MAC1B,OAAO,MAAM5B,iBAAiB,CAACkC,iBAAlB,CAAoC;QAAEN;MAAF,CAApC,CAAb;IACH,CArEE;;IAsEH,MAAMO,iBAAN,GAA0B;MACtB,OAAO,MAAMnC,iBAAiB,CAACmC,iBAAlB,mBAAyC/B,kBAAkB,EAA3D,EAAb;IACH;;EAxEE,CAAP;AA0EH"}

package/scheduler/handlers/executeAction/index.d.ts

@@ -0,0 +1,13 @@
+import { ApwScheduleActionStorageOperations } from "../../types";
+import { ContextPlugin } from "@webiny/api";
+export interface HandlerArgs {
+    datetime: string;
+    tenant: string;
+    locale: string;
+    futureDatetime?: string;
+}
+interface Configuration {
+    storageOperations: ApwScheduleActionStorageOperations;
+}
+export declare const executeActionHandlerPlugins: (config: Configuration) => ((import("@webiny/db-dynamodb/plugins/definitions/ValueFilterPlugin").ValueFilterPlugin[][] | import("@webiny/handler").HandlerResultPlugin<import("@webiny/handler/types").Context> | ContextPlugin<import("@webiny/handler-db/types").DbContext>[])[] | import("@webiny/handler").EventPlugin<HandlerArgs, import("@webiny/handler/types").Context, any> | ContextPlugin<import("@webiny/api/types").Context>)[];
+export {};