@webiny/app-website-builder-workflows 0.0.0-unstable.0156a4c312

package/Components/PageEditor/getPageReadOnlyReason.d.ts

@@ -0,0 +1,4 @@
+import type { WbStatus } from "@webiny/app-website-builder/constants.js";
+import type { TargetReviewPresenter } from "@webiny/app-workflows/review/presentation/targetReview/abstractions.js";
+export type PageReadOnlyReasonVm = Pick<TargetReviewPresenter.ViewModel, "status" | "reviewKind">;
+export declare function getPageReadOnlyReason(vm: PageReadOnlyReasonVm, pageStatus: WbStatus): string | null;

package/Components/PageEditor/getPageReadOnlyReason.js

@@ -0,0 +1,20 @@
+import { WbPageStatus } from "@webiny/app-website-builder/constants.js";
+const NOT_LOADED = "Read-only until the review status loads.";
+const PUBLISHED = "Read-only. The Website Builder only edits draft revisions. Create a new revision to make changes.";
+const APPROVED = "Read-only: this revision has an approved review. Create a new revision to make changes; it needs a new review.";
+const REJECTED = "Read-only: this revision was rejected. Create a new revision to fix it.";
+function getPageReadOnlyReason(vm, pageStatus) {
+    if ("loading" === vm.status || "failed" === vm.status) return NOT_LOADED;
+    if ("noWorkflow" === vm.status) return null;
+    if (pageStatus === WbPageStatus.Published) return PUBLISHED;
+    if ("active" === vm.status) {
+        if ("approved" === vm.reviewKind) return APPROVED;
+        if ("rejected" === vm.reviewKind) return REJECTED;
+        return null;
+    }
+    if (pageStatus !== WbPageStatus.Draft) return PUBLISHED;
+    return null;
+}
+export { getPageReadOnlyReason };
+
+//# sourceMappingURL=getPageReadOnlyReason.js.map

package/Components/PageEditor/getPageReadOnlyReason.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Components/PageEditor/getPageReadOnlyReason.js","sources":["../../../src/Components/PageEditor/getPageReadOnlyReason.ts"],"sourcesContent":["import { WbPageStatus } from \"@webiny/app-website-builder/constants.js\";\nimport type { WbStatus } from \"@webiny/app-website-builder/constants.js\";\nimport type { TargetReviewPresenter } from \"@webiny/app-workflows/review/presentation/targetReview/abstractions.js\";\n\nexport type PageReadOnlyReasonVm = Pick<TargetReviewPresenter.ViewModel, \"status\" | \"reviewKind\">;\n\nconst NOT_LOADED = \"Read-only until the review status loads.\";\nconst PUBLISHED =\n    \"Read-only. The Website Builder only edits draft revisions. Create a new revision to make changes.\";\nconst APPROVED =\n    \"Read-only: this revision has an approved review. Create a new revision to make changes; it needs a new review.\";\nconst REJECTED = \"Read-only: this revision was rejected. Create a new revision to fix it.\";\n\n/*\n * The canvas note of the Website Builder design frames (QBZ-23), switched on `vm.status` and\n * `vm.reviewKind` (R240), never on label text.\n */\nexport function getPageReadOnlyReason(\n    vm: PageReadOnlyReasonVm,\n    pageStatus: WbStatus\n): string | null {\n    if (vm.status === \"loading\" || vm.status === \"failed\") {\n        return NOT_LOADED;\n    }\n\n    if (vm.status === \"noWorkflow\") {\n        return null;\n    }\n\n    if (pageStatus === WbPageStatus.Published) {\n        return PUBLISHED;\n    }\n\n    if (vm.status === \"active\") {\n        if (vm.reviewKind === \"approved\") {\n            return APPROVED;\n        }\n        if (vm.reviewKind === \"rejected\") {\n            return REJECTED;\n        }\n        // The strip's lock text already says the revision is locked while in review.\n        return null;\n    }\n\n    if (pageStatus !== WbPageStatus.Draft) {\n        return PUBLISHED;\n    }\n\n    return null;\n}\n"],"names":["NOT_LOADED","PUBLISHED","APPROVED","REJECTED","getPageReadOnlyReason","vm","pageStatus","WbPageStatus"],"mappings":";AAMA,MAAMA,aAAa;AACnB,MAAMC,YACF;AACJ,MAAMC,WACF;AACJ,MAAMC,WAAW;AAMV,SAASC,sBACZC,EAAwB,EACxBC,UAAoB;IAEpB,IAAID,AAAc,cAAdA,GAAG,MAAM,IAAkBA,AAAc,aAAdA,GAAG,MAAM,EACpC,OAAOL;IAGX,IAAIK,AAAc,iBAAdA,GAAG,MAAM,EACT,OAAO;IAGX,IAAIC,eAAeC,aAAa,SAAS,EACrC,OAAON;IAGX,IAAII,AAAc,aAAdA,GAAG,MAAM,EAAe;QACxB,IAAIA,AAAkB,eAAlBA,GAAG,UAAU,EACb,OAAOH;QAEX,IAAIG,AAAkB,eAAlBA,GAAG,UAAU,EACb,OAAOF;QAGX,OAAO;IACX;IAEA,IAAIG,eAAeC,aAAa,KAAK,EACjC,OAAON;IAGX,OAAO;AACX"}

package/Components/PageEditor/getPageReadOnlyReason.test.d.ts

@@ -0,0 +1 @@
+export {};

package/Components/PageEditor/getPageReadOnlyReason.test.js

@@ -0,0 +1,122 @@
+import { describe, expect, it } from "vitest";
+import { createFakeVm } from "../../testing/createFakeVm.js";
+import { getPageReadOnlyReason } from "./getPageReadOnlyReason.js";
+const NOT_LOADED = "Read-only until the review status loads.";
+const PUBLISHED = "Read-only. The Website Builder only edits draft revisions. Create a new revision to make changes.";
+const APPROVED = "Read-only: this revision has an approved review. Create a new revision to make changes; it needs a new review.";
+const REJECTED = "Read-only: this revision was rejected. Create a new revision to fix it.";
+const CASES = [
+    {
+        kind: "loading",
+        page: "draft",
+        reason: NOT_LOADED
+    },
+    {
+        kind: "loading",
+        page: "published",
+        reason: NOT_LOADED
+    },
+    {
+        kind: "loading",
+        page: "unpublished",
+        reason: NOT_LOADED
+    },
+    {
+        kind: "failed",
+        page: "draft",
+        reason: NOT_LOADED
+    },
+    {
+        kind: "failed",
+        page: "published",
+        reason: NOT_LOADED
+    },
+    {
+        kind: "failed",
+        page: "unpublished",
+        reason: NOT_LOADED
+    },
+    {
+        kind: "noWorkflow",
+        page: "draft",
+        reason: null
+    },
+    {
+        kind: "noWorkflow",
+        page: "published",
+        reason: null
+    },
+    {
+        kind: "noWorkflow",
+        page: "unpublished",
+        reason: null
+    },
+    {
+        kind: "none",
+        page: "draft",
+        reason: null
+    },
+    {
+        kind: "none",
+        page: "published",
+        reason: PUBLISHED
+    },
+    {
+        kind: "none",
+        page: "unpublished",
+        reason: PUBLISHED
+    },
+    {
+        kind: "inProgress",
+        page: "draft",
+        reason: null
+    },
+    {
+        kind: "inProgress",
+        page: "published",
+        reason: PUBLISHED
+    },
+    {
+        kind: "inProgress",
+        page: "unpublished",
+        reason: null
+    },
+    {
+        kind: "approved",
+        page: "draft",
+        reason: APPROVED
+    },
+    {
+        kind: "approved",
+        page: "published",
+        reason: PUBLISHED
+    },
+    {
+        kind: "approved",
+        page: "unpublished",
+        reason: APPROVED
+    },
+    {
+        kind: "rejected",
+        page: "draft",
+        reason: REJECTED
+    },
+    {
+        kind: "rejected",
+        page: "published",
+        reason: PUBLISHED
+    },
+    {
+        kind: "rejected",
+        page: "unpublished",
+        reason: REJECTED
+    }
+];
+describe("getPageReadOnlyReason", ()=>{
+    it.each(CASES)("$kind review on a $page page", ({ kind, page, reason })=>{
+        const vm = createFakeVm(kind);
+        expect(getPageReadOnlyReason(vm, page)).toBe(reason);
+    });
+});
+
+//# sourceMappingURL=getPageReadOnlyReason.test.js.map

package/Components/PageEditor/getPageReadOnlyReason.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Components/PageEditor/getPageReadOnlyReason.test.js","sources":["../../../src/Components/PageEditor/getPageReadOnlyReason.test.ts"],"sourcesContent":["import { describe } from \"vitest\";\nimport { expect } from \"vitest\";\nimport { it } from \"vitest\";\nimport type { WbStatus } from \"@webiny/app-website-builder/constants.js\";\nimport { createFakeVm } from \"~/testing/createFakeVm.js\";\nimport type { FakeReviewKind } from \"~/testing/createFakeVm.js\";\nimport { getPageReadOnlyReason } from \"./getPageReadOnlyReason.js\";\n\nconst NOT_LOADED = \"Read-only until the review status loads.\";\nconst PUBLISHED =\n    \"Read-only. The Website Builder only edits draft revisions. Create a new revision to make changes.\";\nconst APPROVED =\n    \"Read-only: this revision has an approved review. Create a new revision to make changes; it needs a new review.\";\nconst REJECTED = \"Read-only: this revision was rejected. Create a new revision to fix it.\";\n\ninterface ReasonCase {\n    kind: FakeReviewKind;\n    page: WbStatus;\n    reason: string | null;\n}\n\nconst CASES: ReasonCase[] = [\n    { kind: \"loading\", page: \"draft\", reason: NOT_LOADED },\n    { kind: \"loading\", page: \"published\", reason: NOT_LOADED },\n    { kind: \"loading\", page: \"unpublished\", reason: NOT_LOADED },\n    { kind: \"failed\", page: \"draft\", reason: NOT_LOADED },\n    { kind: \"failed\", page: \"published\", reason: NOT_LOADED },\n    { kind: \"failed\", page: \"unpublished\", reason: NOT_LOADED },\n    { kind: \"noWorkflow\", page: \"draft\", reason: null },\n    { kind: \"noWorkflow\", page: \"published\", reason: null },\n    { kind: \"noWorkflow\", page: \"unpublished\", reason: null },\n    { kind: \"none\", page: \"draft\", reason: null },\n    { kind: \"none\", page: \"published\", reason: PUBLISHED },\n    { kind: \"none\", page: \"unpublished\", reason: PUBLISHED },\n    { kind: \"inProgress\", page: \"draft\", reason: null },\n    { kind: \"inProgress\", page: \"published\", reason: PUBLISHED },\n    { kind: \"inProgress\", page: \"unpublished\", reason: null },\n    { kind: \"approved\", page: \"draft\", reason: APPROVED },\n    { kind: \"approved\", page: \"published\", reason: PUBLISHED },\n    { kind: \"approved\", page: \"unpublished\", reason: APPROVED },\n    { kind: \"rejected\", page: \"draft\", reason: REJECTED },\n    { kind: \"rejected\", page: \"published\", reason: PUBLISHED },\n    { kind: \"rejected\", page: \"unpublished\", reason: REJECTED }\n];\n\ndescribe(\"getPageReadOnlyReason\", () => {\n    it.each(CASES)(\"$kind review on a $page page\", ({ kind, page, reason }) => {\n        const vm = createFakeVm(kind);\n\n        expect(getPageReadOnlyReason(vm, page)).toBe(reason);\n    });\n});\n"],"names":["NOT_LOADED","PUBLISHED","APPROVED","REJECTED","CASES","describe","it","kind","page","reason","vm","createFakeVm","expect","getPageReadOnlyReason"],"mappings":";;;AAQA,MAAMA,aAAa;AACnB,MAAMC,YACF;AACJ,MAAMC,WACF;AACJ,MAAMC,WAAW;AAQjB,MAAMC,QAAsB;IACxB;QAAE,MAAM;QAAW,MAAM;QAAS,QAAQJ;IAAW;IACrD;QAAE,MAAM;QAAW,MAAM;QAAa,QAAQA;IAAW;IACzD;QAAE,MAAM;QAAW,MAAM;QAAe,QAAQA;IAAW;IAC3D;QAAE,MAAM;QAAU,MAAM;QAAS,QAAQA;IAAW;IACpD;QAAE,MAAM;QAAU,MAAM;QAAa,QAAQA;IAAW;IACxD;QAAE,MAAM;QAAU,MAAM;QAAe,QAAQA;IAAW;IAC1D;QAAE,MAAM;QAAc,MAAM;QAAS,QAAQ;IAAK;IAClD;QAAE,MAAM;QAAc,MAAM;QAAa,QAAQ;IAAK;IACtD;QAAE,MAAM;QAAc,MAAM;QAAe,QAAQ;IAAK;IACxD;QAAE,MAAM;QAAQ,MAAM;QAAS,QAAQ;IAAK;IAC5C;QAAE,MAAM;QAAQ,MAAM;QAAa,QAAQC;IAAU;IACrD;QAAE,MAAM;QAAQ,MAAM;QAAe,QAAQA;IAAU;IACvD;QAAE,MAAM;QAAc,MAAM;QAAS,QAAQ;IAAK;IAClD;QAAE,MAAM;QAAc,MAAM;QAAa,QAAQA;IAAU;IAC3D;QAAE,MAAM;QAAc,MAAM;QAAe,QAAQ;IAAK;IACxD;QAAE,MAAM;QAAY,MAAM;QAAS,QAAQC;IAAS;IACpD;QAAE,MAAM;QAAY,MAAM;QAAa,QAAQD;IAAU;IACzD;QAAE,MAAM;QAAY,MAAM;QAAe,QAAQC;IAAS;IAC1D;QAAE,MAAM;QAAY,MAAM;QAAS,QAAQC;IAAS;IACpD;QAAE,MAAM;QAAY,MAAM;QAAa,QAAQF;IAAU;IACzD;QAAE,MAAM;QAAY,MAAM;QAAe,QAAQE;IAAS;CAC7D;AAEDE,SAAS,yBAAyB;IAC9BC,GAAG,IAAI,CAACF,OAAO,gCAAgC,CAAC,EAAEG,IAAI,EAAEC,IAAI,EAAEC,MAAM,EAAE;QAClE,MAAMC,KAAKC,aAAaJ;QAExBK,OAAOC,sBAAsBH,IAAIF,OAAO,IAAI,CAACC;IACjD;AACJ"}

package/Components/PageEditor/getPageReviewContext.d.ts

@@ -0,0 +1,9 @@
+import type { TargetReviewContext } from "@webiny/app-workflows/review/presentation/targetReview/abstractions.js";
+import type { ISelectedPage } from "./pageEditorDocument.js";
+export interface IPageReviewEditorOptions {
+    isReadOnly?: boolean;
+}
+export interface IPageReviewEditor {
+    getEditorOptions(): IPageReviewEditorOptions;
+}
+export declare function getPageReviewContext(editor: IPageReviewEditor, page: ISelectedPage, canEdit: boolean): TargetReviewContext;

package/Components/PageEditor/getPageReviewContext.js

@@ -0,0 +1,13 @@
+import { WbPageStatus } from "@webiny/app-website-builder/constants.js";
+function getPageReviewContext(editor, page, canEdit) {
+    const options = editor.getEditorOptions();
+    return {
+        targetTitle: page.title,
+        canRequest: canEdit && true !== options.isReadOnly,
+        isPublished: page.status === WbPageStatus.Published,
+        isUnpublished: page.status === WbPageStatus.Unpublished
+    };
+}
+export { getPageReviewContext };
+
+//# sourceMappingURL=getPageReviewContext.js.map

package/Components/PageEditor/getPageReviewContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Components/PageEditor/getPageReviewContext.js","sources":["../../../src/Components/PageEditor/getPageReviewContext.ts"],"sourcesContent":["import type { TargetReviewContext } from \"@webiny/app-workflows/review/presentation/targetReview/abstractions.js\";\nimport { WbPageStatus } from \"@webiny/app-website-builder/constants.js\";\nimport type { ISelectedPage } from \"./pageEditorDocument.js\";\n\nexport interface IPageReviewEditorOptions {\n    isReadOnly?: boolean;\n}\n\nexport interface IPageReviewEditor {\n    getEditorOptions(): IPageReviewEditorOptions;\n}\n\n/*\n * The review context of the open page: what the review bar needs to know about it. A review can\n * be requested only by a user who can edit the page, on an editable page. Pure.\n */\nexport function getPageReviewContext(\n    editor: IPageReviewEditor,\n    page: ISelectedPage,\n    canEdit: boolean\n): TargetReviewContext {\n    const options = editor.getEditorOptions();\n\n    return {\n        targetTitle: page.title,\n        canRequest: canEdit && options.isReadOnly !== true,\n        isPublished: page.status === WbPageStatus.Published,\n        isUnpublished: page.status === WbPageStatus.Unpublished\n    };\n}\n"],"names":["getPageReviewContext","editor","page","canEdit","options","WbPageStatus"],"mappings":";AAgBO,SAASA,qBACZC,MAAyB,EACzBC,IAAmB,EACnBC,OAAgB;IAEhB,MAAMC,UAAUH,OAAO,gBAAgB;IAEvC,OAAO;QACH,aAAaC,KAAK,KAAK;QACvB,YAAYC,WAAWC,AAAuB,SAAvBA,QAAQ,UAAU;QACzC,aAAaF,KAAK,MAAM,KAAKG,aAAa,SAAS;QACnD,eAAeH,KAAK,MAAM,KAAKG,aAAa,WAAW;IAC3D;AACJ"}

package/Components/PageEditor/getPageReviewContext.test.d.ts

@@ -0,0 +1 @@
+export {};

package/Components/PageEditor/getPageReviewContext.test.js

@@ -0,0 +1,42 @@
+import { describe, expect, it } from "vitest";
+import { WbPageStatus } from "@webiny/app-website-builder/constants.js";
+import { getPageReviewContext } from "./getPageReviewContext.js";
+const editor = (isReadOnly)=>({
+        getEditorOptions: ()=>({
+                isReadOnly
+            })
+    });
+const page = (status)=>({
+        id: "page-1#0001",
+        title: "Home",
+        status,
+        createdById: null
+    });
+describe("getPageReviewContext", ()=>{
+    it("can request on an editable draft", ()=>{
+        expect(getPageReviewContext(editor(false), page(WbPageStatus.Draft), true)).toEqual({
+            targetTitle: "Home",
+            canRequest: true,
+            isPublished: false,
+            isUnpublished: false
+        });
+    });
+    it("cannot request when the editor is read-only", ()=>{
+        const context = getPageReviewContext(editor(true), page(WbPageStatus.Draft), true);
+        expect(context.canRequest).toBe(false);
+    });
+    it("cannot request without the permission to edit the page", ()=>{
+        const context = getPageReviewContext(editor(false), page(WbPageStatus.Draft), false);
+        expect(context.canRequest).toBe(false);
+    });
+    it("marks a published and an unpublished page", ()=>{
+        const published = getPageReviewContext(editor(true), page(WbPageStatus.Published), true);
+        const unpublished = getPageReviewContext(editor(true), page(WbPageStatus.Unpublished), true);
+        expect(published.isPublished).toBe(true);
+        expect(published.isUnpublished).toBe(false);
+        expect(unpublished.isPublished).toBe(false);
+        expect(unpublished.isUnpublished).toBe(true);
+    });
+});
+
+//# sourceMappingURL=getPageReviewContext.test.js.map

package/Components/PageEditor/getPageReviewContext.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Components/PageEditor/getPageReviewContext.test.js","sources":["../../../src/Components/PageEditor/getPageReviewContext.test.ts"],"sourcesContent":["import { describe } from \"vitest\";\nimport { expect } from \"vitest\";\nimport { it } from \"vitest\";\nimport { WbPageStatus } from \"@webiny/app-website-builder/constants.js\";\nimport { getPageReviewContext } from \"./getPageReviewContext.js\";\nimport type { ISelectedPage } from \"./pageEditorDocument.js\";\n\nconst editor = (isReadOnly: boolean) => ({ getEditorOptions: () => ({ isReadOnly }) });\nconst page = (status: ISelectedPage[\"status\"]): ISelectedPage => ({\n    id: \"page-1#0001\",\n    title: \"Home\",\n    status,\n    createdById: null\n});\n\ndescribe(\"getPageReviewContext\", () => {\n    it(\"can request on an editable draft\", () => {\n        expect(getPageReviewContext(editor(false), page(WbPageStatus.Draft), true)).toEqual({\n            targetTitle: \"Home\",\n            canRequest: true,\n            isPublished: false,\n            isUnpublished: false\n        });\n    });\n\n    it(\"cannot request when the editor is read-only\", () => {\n        const context = getPageReviewContext(editor(true), page(WbPageStatus.Draft), true);\n        expect(context.canRequest).toBe(false);\n    });\n\n    it(\"cannot request without the permission to edit the page\", () => {\n        const context = getPageReviewContext(editor(false), page(WbPageStatus.Draft), false);\n        expect(context.canRequest).toBe(false);\n    });\n\n    it(\"marks a published and an unpublished page\", () => {\n        const published = getPageReviewContext(editor(true), page(WbPageStatus.Published), true);\n        const unpublished = getPageReviewContext(\n            editor(true),\n            page(WbPageStatus.Unpublished),\n            true\n        );\n\n        expect(published.isPublished).toBe(true);\n        expect(published.isUnpublished).toBe(false);\n        expect(unpublished.isPublished).toBe(false);\n        expect(unpublished.isUnpublished).toBe(true);\n    });\n});\n"],"names":["editor","isReadOnly","page","status","describe","it","expect","getPageReviewContext","WbPageStatus","context","published","unpublished"],"mappings":";;;AAOA,MAAMA,SAAS,CAACC,aAAyB;QAAE,kBAAkB,IAAO;gBAAEA;YAAW;IAAG;AACpF,MAAMC,OAAO,CAACC,SAAoD;QAC9D,IAAI;QACJ,OAAO;QACPA;QACA,aAAa;IACjB;AAEAC,SAAS,wBAAwB;IAC7BC,GAAG,oCAAoC;QACnCC,OAAOC,qBAAqBP,OAAO,QAAQE,KAAKM,aAAa,KAAK,GAAG,OAAO,OAAO,CAAC;YAChF,aAAa;YACb,YAAY;YACZ,aAAa;YACb,eAAe;QACnB;IACJ;IAEAH,GAAG,+CAA+C;QAC9C,MAAMI,UAAUF,qBAAqBP,OAAO,OAAOE,KAAKM,aAAa,KAAK,GAAG;QAC7EF,OAAOG,QAAQ,UAAU,EAAE,IAAI,CAAC;IACpC;IAEAJ,GAAG,0DAA0D;QACzD,MAAMI,UAAUF,qBAAqBP,OAAO,QAAQE,KAAKM,aAAa,KAAK,GAAG;QAC9EF,OAAOG,QAAQ,UAAU,EAAE,IAAI,CAAC;IACpC;IAEAJ,GAAG,6CAA6C;QAC5C,MAAMK,YAAYH,qBAAqBP,OAAO,OAAOE,KAAKM,aAAa,SAAS,GAAG;QACnF,MAAMG,cAAcJ,qBAChBP,OAAO,OACPE,KAAKM,aAAa,WAAW,GAC7B;QAGJF,OAAOI,UAAU,WAAW,EAAE,IAAI,CAAC;QACnCJ,OAAOI,UAAU,aAAa,EAAE,IAAI,CAAC;QACrCJ,OAAOK,YAAY,WAAW,EAAE,IAAI,CAAC;QACrCL,OAAOK,YAAY,aAAa,EAAE,IAAI,CAAC;IAC3C;AACJ"}

package/Components/PageEditor/pageEditorDocument.d.ts

@@ -0,0 +1,17 @@
+import type { EditorDocument } from "@webiny/app-website-builder/BaseEditor/hooks/useSelectFromDocument.js";
+import type { WbStatus } from "@webiny/app-website-builder/constants.js";
+export interface IPageEditorDocumentIdentity {
+    id: string;
+}
+export interface IPageEditorDocument extends EditorDocument {
+    status: WbStatus;
+    savedOn?: string;
+    modifiedOn?: string | null;
+    createdBy?: IPageEditorDocumentIdentity | null;
+}
+export interface ISelectedPage {
+    id: string;
+    title: string;
+    status: WbStatus;
+    createdById: string | null;
+}

package/Components/PageEditor/pageReviewMatrix.test.d.ts

@@ -0,0 +1 @@
+export {};

package/Components/PageEditor/pageReviewMatrix.test.js

@@ -0,0 +1,223 @@
+import react from "react";
+import { cleanup, render, screen } from "@testing-library/react";
+import { afterEach, describe, expect, it, vi } from "vitest";
+import { Container } from "@webiny/di";
+import { PageEditorConfig } from "@webiny/app-website-builder/presentation/pages/PageEditor/PageEditorConfig.js";
+import { WbPageReview } from "../../features/editorReview/abstractions.js";
+import { WbEditorHarness } from "../../testing/WbEditorHarness.js";
+import { createFakeSession } from "../../testing/createFakeSession.js";
+import { createPageEditor } from "../../testing/createPageEditor.js";
+import { registerPageContent } from "../../testing/registerPageContent.js";
+import { PageEditorLayout } from "./PageEditorLayout.js";
+import { PageEditorTopBar } from "./PageEditorTopBar.js";
+vi.mock("@webiny/icons/info.svg", ()=>({
+        ReactComponent: ()=>null
+    }));
+vi.mock("@webiny/app-website-builder/BaseEditor/config/Layout.js", async ()=>{
+    const React = await import("react");
+    const { makeDecoratable } = await import("@webiny/react-composition");
+    const Layout = makeDecoratable("EditorLayout", ()=>React.createElement("div", {
+            "data-testid": "base-layout"
+        }));
+    return {
+        Layout
+    };
+});
+vi.mock("@webiny/app-website-builder/BaseEditor/config/TopBar/Layout.js", async ()=>{
+    const React = await import("react");
+    const { makeDecoratable } = await import("@webiny/react-composition");
+    const Layout = makeDecoratable("TopBarLayout", ()=>React.createElement("div", {
+            "data-testid": "base-top-bar"
+        }));
+    return {
+        Layout,
+        TopBarOptionsMenu: ()=>null
+    };
+});
+vi.mock("@webiny/app-workflows/review/editor/components/EditorReviewBar.js", async ()=>{
+    const React = await import("react");
+    const EditorReviewBar = ()=>React.createElement("div", {
+            "data-testid": "review-bar"
+        });
+    return {
+        EditorReviewBar
+    };
+});
+const { Ui: Ui } = PageEditorConfig;
+const NOT_LOADED = "Read-only until the review status loads.";
+const PUBLISHED = "Read-only. The Website Builder only edits draft revisions. Create a new revision to make changes.";
+const APPROVED = "Read-only: this revision has an approved review. Create a new revision to make changes; it needs a new review.";
+const REJECTED = "Read-only: this revision was rejected. Create a new revision to fix it.";
+const MATRIX = [
+    {
+        kind: "loading",
+        page: "draft",
+        bar: true,
+        note: NOT_LOADED,
+        readOnly: true
+    },
+    {
+        kind: "loading",
+        page: "published",
+        bar: true,
+        note: NOT_LOADED,
+        readOnly: true
+    },
+    {
+        kind: "loading",
+        page: "unpublished",
+        bar: true,
+        note: NOT_LOADED,
+        readOnly: true
+    },
+    {
+        kind: "failed",
+        page: "draft",
+        bar: true,
+        note: NOT_LOADED,
+        readOnly: true
+    },
+    {
+        kind: "failed",
+        page: "published",
+        bar: true,
+        note: NOT_LOADED,
+        readOnly: true
+    },
+    {
+        kind: "failed",
+        page: "unpublished",
+        bar: true,
+        note: NOT_LOADED,
+        readOnly: true
+    },
+    {
+        kind: "noWorkflow",
+        page: "draft",
+        bar: false,
+        note: null,
+        readOnly: false
+    },
+    {
+        kind: "noWorkflow",
+        page: "published",
+        bar: false,
+        note: null,
+        readOnly: true
+    },
+    {
+        kind: "noWorkflow",
+        page: "unpublished",
+        bar: false,
+        note: null,
+        readOnly: true
+    },
+    {
+        kind: "none",
+        page: "draft",
+        bar: true,
+        note: null,
+        readOnly: false
+    },
+    {
+        kind: "none",
+        page: "published",
+        bar: true,
+        note: PUBLISHED,
+        readOnly: true
+    },
+    {
+        kind: "none",
+        page: "unpublished",
+        bar: true,
+        note: PUBLISHED,
+        readOnly: true
+    },
+    {
+        kind: "inProgress",
+        page: "draft",
+        bar: true,
+        note: null,
+        readOnly: true
+    },
+    {
+        kind: "inProgress",
+        page: "published",
+        bar: true,
+        note: PUBLISHED,
+        readOnly: true
+    },
+    {
+        kind: "inProgress",
+        page: "unpublished",
+        bar: true,
+        note: null,
+        readOnly: true
+    },
+    {
+        kind: "approved",
+        page: "draft",
+        bar: true,
+        note: APPROVED,
+        readOnly: true
+    },
+    {
+        kind: "approved",
+        page: "published",
+        bar: true,
+        note: PUBLISHED,
+        readOnly: true
+    },
+    {
+        kind: "approved",
+        page: "unpublished",
+        bar: true,
+        note: APPROVED,
+        readOnly: true
+    },
+    {
+        kind: "rejected",
+        page: "draft",
+        bar: true,
+        note: REJECTED,
+        readOnly: true
+    },
+    {
+        kind: "rejected",
+        page: "published",
+        bar: true,
+        note: PUBLISHED,
+        readOnly: true
+    },
+    {
+        kind: "rejected",
+        page: "unpublished",
+        bar: true,
+        note: REJECTED,
+        readOnly: true
+    }
+];
+describe("review status x page status (bar, note and canvas)", ()=>{
+    afterEach(()=>{
+        cleanup();
+    });
+    it.each(MATRIX)("$kind review on a $page page", ({ kind, page, bar, note, readOnly })=>{
+        const handle = createFakeSession(kind, "unpublished" === page);
+        const container = new Container();
+        container.registerInstance(WbPageReview, handle.session);
+        registerPageContent(container);
+        const editor = createPageEditor(page);
+        render(/*#__PURE__*/ react.createElement(WbEditorHarness, {
+            container: container,
+            editor: editor
+        }, /*#__PURE__*/ react.createElement(PageEditorTopBar, null), /*#__PURE__*/ react.createElement(PageEditorLayout, null), /*#__PURE__*/ react.createElement(Ui.Layout, null), /*#__PURE__*/ react.createElement(Ui.TopBar.Layout, null)));
+        const bars = screen.queryAllByTestId("review-bar");
+        expect(bars).toHaveLength(bar ? 1 : 0);
+        const alert = screen.queryByRole("alert");
+        if (null === note) expect(alert).toBeNull();
+        else expect(alert?.textContent).toContain(note);
+        expect(editor.getEditorState().read().isReadOnly).toBe(readOnly);
+    });
+});
+
+//# sourceMappingURL=pageReviewMatrix.test.js.map

package/Components/PageEditor/pageReviewMatrix.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Components/PageEditor/pageReviewMatrix.test.js","sources":["../../../src/Components/PageEditor/pageReviewMatrix.test.tsx"],"sourcesContent":["import React from \"react\";\nimport { cleanup } from \"@testing-library/react\";\nimport { render } from \"@testing-library/react\";\nimport { screen } from \"@testing-library/react\";\nimport { afterEach } from \"vitest\";\nimport { describe } from \"vitest\";\nimport { expect } from \"vitest\";\nimport { it } from \"vitest\";\nimport { vi } from \"vitest\";\nimport { Container } from \"@webiny/di\";\nimport { PageEditorConfig } from \"@webiny/app-website-builder/presentation/pages/PageEditor/PageEditorConfig.js\";\nimport type { WbStatus } from \"@webiny/app-website-builder/constants.js\";\nimport { WbPageReview } from \"~/features/editorReview/abstractions.js\";\nimport { WbEditorHarness } from \"~/testing/WbEditorHarness.js\";\nimport { createFakeSession } from \"~/testing/createFakeSession.js\";\nimport { createPageEditor } from \"~/testing/createPageEditor.js\";\nimport { registerPageContent } from \"~/testing/registerPageContent.js\";\nimport type { FakeReviewKind } from \"~/testing/createFakeVm.js\";\nimport { PageEditorLayout } from \"./PageEditorLayout.js\";\nimport { PageEditorTopBar } from \"./PageEditorTopBar.js\";\n\nvi.mock(\"@webiny/icons/info.svg\", () => {\n    return { ReactComponent: () => null };\n});\n\nvi.mock(\"@webiny/app-website-builder/BaseEditor/config/Layout.js\", async () => {\n    const React = await import(\"react\");\n    const { makeDecoratable } = await import(\"@webiny/react-composition\");\n    const Layout = makeDecoratable(\"EditorLayout\", () => {\n        return React.createElement(\"div\", { \"data-testid\": \"base-layout\" });\n    });\n    return { Layout };\n});\n\nvi.mock(\"@webiny/app-website-builder/BaseEditor/config/TopBar/Layout.js\", async () => {\n    const React = await import(\"react\");\n    const { makeDecoratable } = await import(\"@webiny/react-composition\");\n    const Layout = makeDecoratable(\"TopBarLayout\", () => {\n        return React.createElement(\"div\", { \"data-testid\": \"base-top-bar\" });\n    });\n    return { Layout, TopBarOptionsMenu: () => null };\n});\n\nvi.mock(\"@webiny/app-workflows/review/editor/components/EditorReviewBar.js\", async () => {\n    const React = await import(\"react\");\n    const EditorReviewBar = () => {\n        return React.createElement(\"div\", { \"data-testid\": \"review-bar\" });\n    };\n    return { EditorReviewBar };\n});\n\nconst { Ui } = PageEditorConfig;\n\nconst NOT_LOADED = \"Read-only until the review status loads.\";\nconst PUBLISHED =\n    \"Read-only. The Website Builder only edits draft revisions. Create a new revision to make changes.\";\nconst APPROVED =\n    \"Read-only: this revision has an approved review. Create a new revision to make changes; it needs a new review.\";\nconst REJECTED = \"Read-only: this revision was rejected. Create a new revision to fix it.\";\n\ninterface MatrixCase {\n    kind: FakeReviewKind;\n    page: WbStatus;\n    bar: boolean;\n    note: string | null;\n    readOnly: boolean;\n}\n\nconst MATRIX: MatrixCase[] = [\n    { kind: \"loading\", page: \"draft\", bar: true, note: NOT_LOADED, readOnly: true },\n    { kind: \"loading\", page: \"published\", bar: true, note: NOT_LOADED, readOnly: true },\n    { kind: \"loading\", page: \"unpublished\", bar: true, note: NOT_LOADED, readOnly: true },\n    { kind: \"failed\", page: \"draft\", bar: true, note: NOT_LOADED, readOnly: true },\n    { kind: \"failed\", page: \"published\", bar: true, note: NOT_LOADED, readOnly: true },\n    { kind: \"failed\", page: \"unpublished\", bar: true, note: NOT_LOADED, readOnly: true },\n    { kind: \"noWorkflow\", page: \"draft\", bar: false, note: null, readOnly: false },\n    { kind: \"noWorkflow\", page: \"published\", bar: false, note: null, readOnly: true },\n    { kind: \"noWorkflow\", page: \"unpublished\", bar: false, note: null, readOnly: true },\n    { kind: \"none\", page: \"draft\", bar: true, note: null, readOnly: false },\n    { kind: \"none\", page: \"published\", bar: true, note: PUBLISHED, readOnly: true },\n    { kind: \"none\", page: \"unpublished\", bar: true, note: PUBLISHED, readOnly: true },\n    { kind: \"inProgress\", page: \"draft\", bar: true, note: null, readOnly: true },\n    { kind: \"inProgress\", page: \"published\", bar: true, note: PUBLISHED, readOnly: true },\n    { kind: \"inProgress\", page: \"unpublished\", bar: true, note: null, readOnly: true },\n    { kind: \"approved\", page: \"draft\", bar: true, note: APPROVED, readOnly: true },\n    { kind: \"approved\", page: \"published\", bar: true, note: PUBLISHED, readOnly: true },\n    { kind: \"approved\", page: \"unpublished\", bar: true, note: APPROVED, readOnly: true },\n    { kind: \"rejected\", page: \"draft\", bar: true, note: REJECTED, readOnly: true },\n    { kind: \"rejected\", page: \"published\", bar: true, note: PUBLISHED, readOnly: true },\n    { kind: \"rejected\", page: \"unpublished\", bar: true, note: REJECTED, readOnly: true }\n];\n\ndescribe(\"review status x page status (bar, note and canvas)\", () => {\n    afterEach(() => {\n        cleanup();\n    });\n\n    it.each(MATRIX)(\"$kind review on a $page page\", ({ kind, page, bar, note, readOnly }) => {\n        const handle = createFakeSession(kind, page === \"unpublished\");\n        const container = new Container();\n        container.registerInstance(WbPageReview, handle.session);\n        registerPageContent(container);\n        const editor = createPageEditor(page);\n\n        render(\n            <WbEditorHarness container={container} editor={editor}>\n                <PageEditorTopBar />\n                <PageEditorLayout />\n                <Ui.Layout />\n                <Ui.TopBar.Layout />\n            </WbEditorHarness>\n        );\n\n        const bars = screen.queryAllByTestId(\"review-bar\");\n        expect(bars).toHaveLength(bar ? 1 : 0);\n        const alert = screen.queryByRole(\"alert\");\n        if (note === null) {\n            expect(alert).toBeNull();\n        } else {\n            expect(alert?.textContent).toContain(note);\n        }\n        expect(editor.getEditorState().read().isReadOnly).toBe(readOnly);\n    });\n});\n"],"names":["vi","React","makeDecoratable","Layout","EditorReviewBar","Ui","PageEditorConfig","NOT_LOADED","PUBLISHED","APPROVED","REJECTED","MATRIX","describe","afterEach","cleanup","it","kind","page","bar","note","readOnly","handle","createFakeSession","container","Container","WbPageReview","registerPageContent","editor","createPageEditor","render","WbEditorHarness","PageEditorTopBar","PageEditorLayout","bars","screen","expect","alert"],"mappings":";;;;;;;;;;;;AAqBAA,GAAG,IAAI,CAAC,0BAA0B,IACvB;QAAE,gBAAgB,IAAM;IAAK;AAGxCA,GAAG,IAAI,CAAC,2DAA2D;IAC/D,MAAMC,QAAQ,MAAM,MAAM,CAAC;IAC3B,MAAM,EAAEC,eAAe,EAAE,GAAG,MAAM,MAAM,CAAC;IACzC,MAAMC,SAASD,gBAAgB,gBAAgB,IACpCD,MAAM,aAAa,CAAC,OAAO;YAAE,eAAe;QAAc;IAErE,OAAO;QAAEE;IAAO;AACpB;AAEAH,GAAG,IAAI,CAAC,kEAAkE;IACtE,MAAMC,QAAQ,MAAM,MAAM,CAAC;IAC3B,MAAM,EAAEC,eAAe,EAAE,GAAG,MAAM,MAAM,CAAC;IACzC,MAAMC,SAASD,gBAAgB,gBAAgB,IACpCD,MAAM,aAAa,CAAC,OAAO;YAAE,eAAe;QAAe;IAEtE,OAAO;QAAEE;QAAQ,mBAAmB,IAAM;IAAK;AACnD;AAEAH,GAAG,IAAI,CAAC,qEAAqE;IACzE,MAAMC,QAAQ,MAAM,MAAM,CAAC;IAC3B,MAAMG,kBAAkB,IACbH,MAAM,aAAa,CAAC,OAAO;YAAE,eAAe;QAAa;IAEpE,OAAO;QAAEG;IAAgB;AAC7B;AAEA,MAAM,EAAEC,IAAAA,EAAE,EAAE,GAAGC;AAEf,MAAMC,aAAa;AACnB,MAAMC,YACF;AACJ,MAAMC,WACF;AACJ,MAAMC,WAAW;AAUjB,MAAMC,SAAuB;IACzB;QAAE,MAAM;QAAW,MAAM;QAAS,KAAK;QAAM,MAAMJ;QAAY,UAAU;IAAK;IAC9E;QAAE,MAAM;QAAW,MAAM;QAAa,KAAK;QAAM,MAAMA;QAAY,UAAU;IAAK;IAClF;QAAE,MAAM;QAAW,MAAM;QAAe,KAAK;QAAM,MAAMA;QAAY,UAAU;IAAK;IACpF;QAAE,MAAM;QAAU,MAAM;QAAS,KAAK;QAAM,MAAMA;QAAY,UAAU;IAAK;IAC7E;QAAE,MAAM;QAAU,MAAM;QAAa,KAAK;QAAM,MAAMA;QAAY,UAAU;IAAK;IACjF;QAAE,MAAM;QAAU,MAAM;QAAe,KAAK;QAAM,MAAMA;QAAY,UAAU;IAAK;IACnF;QAAE,MAAM;QAAc,MAAM;QAAS,KAAK;QAAO,MAAM;QAAM,UAAU;IAAM;IAC7E;QAAE,MAAM;QAAc,MAAM;QAAa,KAAK;QAAO,MAAM;QAAM,UAAU;IAAK;IAChF;QAAE,MAAM;QAAc,MAAM;QAAe,KAAK;QAAO,MAAM;QAAM,UAAU;IAAK;IAClF;QAAE,MAAM;QAAQ,MAAM;QAAS,KAAK;QAAM,MAAM;QAAM,UAAU;IAAM;IACtE;QAAE,MAAM;QAAQ,MAAM;QAAa,KAAK;QAAM,MAAMC;QAAW,UAAU;IAAK;IAC9E;QAAE,MAAM;QAAQ,MAAM;QAAe,KAAK;QAAM,MAAMA;QAAW,UAAU;IAAK;IAChF;QAAE,MAAM;QAAc,MAAM;QAAS,KAAK;QAAM,MAAM;QAAM,UAAU;IAAK;IAC3E;QAAE,MAAM;QAAc,MAAM;QAAa,KAAK;QAAM,MAAMA;QAAW,UAAU;IAAK;IACpF;QAAE,MAAM;QAAc,MAAM;QAAe,KAAK;QAAM,MAAM;QAAM,UAAU;IAAK;IACjF;QAAE,MAAM;QAAY,MAAM;QAAS,KAAK;QAAM,MAAMC;QAAU,UAAU;IAAK;IAC7E;QAAE,MAAM;QAAY,MAAM;QAAa,KAAK;QAAM,MAAMD;QAAW,UAAU;IAAK;IAClF;QAAE,MAAM;QAAY,MAAM;QAAe,KAAK;QAAM,MAAMC;QAAU,UAAU;IAAK;IACnF;QAAE,MAAM;QAAY,MAAM;QAAS,KAAK;QAAM,MAAMC;QAAU,UAAU;IAAK;IAC7E;QAAE,MAAM;QAAY,MAAM;QAAa,KAAK;QAAM,MAAMF;QAAW,UAAU;IAAK;IAClF;QAAE,MAAM;QAAY,MAAM;QAAe,KAAK;QAAM,MAAME;QAAU,UAAU;IAAK;CACtF;AAEDE,SAAS,sDAAsD;IAC3DC,UAAU;QACNC;IACJ;IAEAC,GAAG,IAAI,CAACJ,QAAQ,gCAAgC,CAAC,EAAEK,IAAI,EAAEC,IAAI,EAAEC,GAAG,EAAEC,IAAI,EAAEC,QAAQ,EAAE;QAChF,MAAMC,SAASC,kBAAkBN,MAAMC,AAAS,kBAATA;QACvC,MAAMM,YAAY,IAAIC;QACtBD,UAAU,gBAAgB,CAACE,cAAcJ,OAAO,OAAO;QACvDK,oBAAoBH;QACpB,MAAMI,SAASC,iBAAiBX;QAEhCY,OAAO,WAADA,GACF,oBAACC,iBAAeA;YAAC,WAAWP;YAAW,QAAQI;yBAC3C,oBAACI,kBAAgBA,OAAAA,WAAAA,GACjB,oBAACC,kBAAgBA,OAAAA,WAAAA,GACjB,oBAAC3B,GAAG,MAAM,uBACV,oBAACA,GAAG,MAAM,CAAC,MAAM;QAIzB,MAAM4B,OAAOC,OAAO,gBAAgB,CAAC;QACrCC,OAAOF,MAAM,YAAY,CAACf,MAAM,IAAI;QACpC,MAAMkB,QAAQF,OAAO,WAAW,CAAC;QACjC,IAAIf,AAAS,SAATA,MACAgB,OAAOC,OAAO,QAAQ;aAEtBD,OAAOC,OAAO,aAAa,SAAS,CAACjB;QAEzCgB,OAAOR,OAAO,cAAc,GAAG,IAAI,GAAG,UAAU,EAAE,IAAI,CAACP;IAC3D;AACJ"}

package/Components/PageEditor/publishMatrix.test.d.ts

@@ -0,0 +1 @@
+export {};