@webiny/app-headless-cms-workflows 0.0.0-unstable.0156a4c312

package/features/cache/CmsReviewEntriesCacheProviderDecorator.test.js

@@ -0,0 +1,129 @@
+import { beforeEach, describe, expect, it } from "vitest";
+import { Container } from "@webiny/di";
+import { ContentEntriesCacheProvider } from "@webiny/app-headless-cms/features/contentEntry/abstractions.js";
+import { ContentEntriesCacheProvider as ContentEntriesCacheProvider_js_ContentEntriesCacheProvider } from "@webiny/app-headless-cms/features/contentEntry/ContentEntriesCacheProvider.js";
+import { ReviewState } from "@webiny/app-workflows/review/domain/ReviewState.js";
+import { StepState } from "@webiny/app-workflows/review/domain/StepState.js";
+import { CmsWorkflowsCacheFeature } from "../feature.js";
+import { CmsReviewEntriesCacheProviderDecorator } from "./CmsReviewEntriesCacheProviderDecorator.js";
+const CANCELLED = {
+    workflowId: "wf-1",
+    reviewState: ReviewState.Cancelled,
+    stepId: "step-1",
+    stepName: "Legal review",
+    stepState: StepState.InReview
+};
+function createEntry(params = {}) {
+    const { version = 1, title = "Hello", system } = params;
+    const meta = {
+        title,
+        status: "draft",
+        version,
+        locked: false
+    };
+    if (void 0 !== system) meta.system = system;
+    return {
+        id: `entry-1#000${version}`,
+        entryId: "entry-1",
+        meta
+    };
+}
+function readWorkflow(entry) {
+    const meta = entry?.meta;
+    return meta?.system?.workflow;
+}
+let container;
+function getCache() {
+    return container.resolve(ContentEntriesCacheProvider).get("article");
+}
+function readEntry() {
+    return getCache().getItem((entry)=>"entry-1" === entry.entryId);
+}
+beforeEach(()=>{
+    container = new Container();
+    container.register(ContentEntriesCacheProvider_js_ContentEntriesCacheProvider).inSingletonScope();
+    container.registerDecorator(CmsReviewEntriesCacheProviderDecorator);
+    getCache().setItems([
+        createEntry({
+            system: {
+                workflow: CANCELLED
+            }
+        })
+    ]);
+});
+describe("CmsReviewEntriesCacheProviderDecorator", ()=>{
+    it("keeps the cached workflow when a mutation returns the same revision without one", ()=>{
+        getCache().addItems([
+            createEntry({
+                title: "Edited"
+            })
+        ]);
+        const entry = readEntry();
+        expect(entry?.meta.title).toBe("Edited");
+        expect(readWorkflow(entry)).toEqual(CANCELLED);
+    });
+    it("keeps the cached workflow when the returned entry selects other system fields", ()=>{
+        getCache().addItems([
+            createEntry({
+                title: "Edited",
+                system: {}
+            })
+        ]);
+        expect(readWorkflow(readEntry())).toEqual(CANCELLED);
+    });
+    it("takes the workflow the added entry carries, including no review", ()=>{
+        getCache().addItems([
+            createEntry({
+                system: {
+                    workflow: null
+                }
+            })
+        ]);
+        expect(readWorkflow(readEntry())).toBeNull();
+    });
+    it("gives a new revision of the entry no workflow of the cached revision", ()=>{
+        getCache().addItems([
+            createEntry({
+                version: 2
+            })
+        ]);
+        const entry = readEntry();
+        expect(entry?.id).toBe("entry-1#0002");
+        expect(readWorkflow(entry)).toBeUndefined();
+    });
+    it("adds an entry that is not cached unchanged", ()=>{
+        getCache().clear();
+        const added = createEntry({
+            title: "New"
+        });
+        getCache().addItems([
+            added
+        ]);
+        expect(readEntry()).toEqual(added);
+    });
+    it("hands every other cache call to the cached list", ()=>{
+        getCache().removeItems((entry)=>"entry-1" === entry.entryId);
+        expect(getCache().count()).toBe(0);
+        expect(getCache().hasItems()).toBe(false);
+    });
+    it("is registered by the CMS workflows cache feature", ()=>{
+        container = new Container();
+        container.register(ContentEntriesCacheProvider_js_ContentEntriesCacheProvider).inSingletonScope();
+        CmsWorkflowsCacheFeature.register(container);
+        getCache().setItems([
+            createEntry({
+                system: {
+                    workflow: CANCELLED
+                }
+            })
+        ]);
+        getCache().addItems([
+            createEntry({
+                title: "Edited"
+            })
+        ]);
+        expect(readWorkflow(readEntry())).toEqual(CANCELLED);
+    });
+});
+
+//# sourceMappingURL=CmsReviewEntriesCacheProviderDecorator.test.js.map

package/features/cache/CmsReviewEntriesCacheProviderDecorator.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"features/cache/CmsReviewEntriesCacheProviderDecorator.test.js","sources":["../../../src/features/cache/CmsReviewEntriesCacheProviderDecorator.test.ts"],"sourcesContent":["import { beforeEach } from \"vitest\";\nimport { describe } from \"vitest\";\nimport { expect } from \"vitest\";\nimport { it } from \"vitest\";\nimport { Container } from \"@webiny/di\";\nimport { ContentEntriesCacheProvider as ContentEntriesCacheProviderAbstraction } from \"@webiny/app-headless-cms/features/contentEntry/abstractions.js\";\nimport { ContentEntriesCacheProvider } from \"@webiny/app-headless-cms/features/contentEntry/ContentEntriesCacheProvider.js\";\nimport type { CmsContentEntry } from \"@webiny/app-headless-cms-common/types/index.js\";\nimport { ReviewState } from \"@webiny/app-workflows/review/domain/ReviewState.js\";\nimport { StepState } from \"@webiny/app-workflows/review/domain/StepState.js\";\nimport type { SystemWorkflowValue } from \"@webiny/app-workflows/review/domain/types.js\";\nimport type { ICmsEntryMetaWithReview } from \"~/types.js\";\nimport { CmsWorkflowsCacheFeature } from \"~/features/feature.js\";\nimport { CmsReviewEntriesCacheProviderDecorator } from \"./CmsReviewEntriesCacheProviderDecorator.js\";\n\nconst CANCELLED: SystemWorkflowValue = {\n    workflowId: \"wf-1\",\n    reviewState: ReviewState.Cancelled,\n    stepId: \"step-1\",\n    stepName: \"Legal review\",\n    stepState: StepState.InReview\n};\n\ninterface CreateEntryParams {\n    version?: number;\n    title?: string;\n    system?: ICmsEntryMetaWithReview[\"system\"];\n}\n\nfunction createEntry(params: CreateEntryParams = {}): CmsContentEntry {\n    const { version = 1, title = \"Hello\", system } = params;\n    const meta: Record<string, unknown> = { title, status: \"draft\", version, locked: false };\n    if (system !== undefined) {\n        meta.system = system;\n    }\n    return {\n        id: `entry-1#000${version}`,\n        entryId: \"entry-1\",\n        meta\n    } as unknown as CmsContentEntry;\n}\n\nfunction readWorkflow(entry: CmsContentEntry | undefined): unknown {\n    const meta: ICmsEntryMetaWithReview | undefined = entry?.meta;\n    return meta?.system?.workflow;\n}\n\nlet container: Container;\n\nfunction getCache() {\n    return container.resolve(ContentEntriesCacheProviderAbstraction).get(\"article\");\n}\n\nfunction readEntry(): CmsContentEntry | undefined {\n    return getCache().getItem(entry => entry.entryId === \"entry-1\");\n}\n\nbeforeEach(() => {\n    container = new Container();\n    container.register(ContentEntriesCacheProvider).inSingletonScope();\n    container.registerDecorator(CmsReviewEntriesCacheProviderDecorator);\n    getCache().setItems([createEntry({ system: { workflow: CANCELLED } })]);\n});\n\ndescribe(\"CmsReviewEntriesCacheProviderDecorator\", () => {\n    it(\"keeps the cached workflow when a mutation returns the same revision without one\", () => {\n        getCache().addItems([createEntry({ title: \"Edited\" })]);\n\n        const entry = readEntry();\n        expect(entry?.meta.title).toBe(\"Edited\");\n        expect(readWorkflow(entry)).toEqual(CANCELLED);\n    });\n\n    it(\"keeps the cached workflow when the returned entry selects other system fields\", () => {\n        getCache().addItems([createEntry({ title: \"Edited\", system: {} })]);\n\n        expect(readWorkflow(readEntry())).toEqual(CANCELLED);\n    });\n\n    it(\"takes the workflow the added entry carries, including no review\", () => {\n        getCache().addItems([createEntry({ system: { workflow: null } })]);\n\n        expect(readWorkflow(readEntry())).toBeNull();\n    });\n\n    it(\"gives a new revision of the entry no workflow of the cached revision\", () => {\n        getCache().addItems([createEntry({ version: 2 })]);\n\n        const entry = readEntry();\n        expect(entry?.id).toBe(\"entry-1#0002\");\n        expect(readWorkflow(entry)).toBeUndefined();\n    });\n\n    it(\"adds an entry that is not cached unchanged\", () => {\n        getCache().clear();\n        const added = createEntry({ title: \"New\" });\n\n        getCache().addItems([added]);\n\n        expect(readEntry()).toEqual(added);\n    });\n\n    it(\"hands every other cache call to the cached list\", () => {\n        getCache().removeItems(entry => entry.entryId === \"entry-1\");\n\n        expect(getCache().count()).toBe(0);\n        expect(getCache().hasItems()).toBe(false);\n    });\n\n    it(\"is registered by the CMS workflows cache feature\", () => {\n        container = new Container();\n        container.register(ContentEntriesCacheProvider).inSingletonScope();\n        CmsWorkflowsCacheFeature.register(container);\n        getCache().setItems([createEntry({ system: { workflow: CANCELLED } })]);\n\n        getCache().addItems([createEntry({ title: \"Edited\" })]);\n\n        expect(readWorkflow(readEntry())).toEqual(CANCELLED);\n    });\n});\n"],"names":["CANCELLED","ReviewState","StepState","createEntry","params","version","title","system","meta","undefined","readWorkflow","entry","container","getCache","ContentEntriesCacheProviderAbstraction","readEntry","beforeEach","Container","ContentEntriesCacheProvider","CmsReviewEntriesCacheProviderDecorator","describe","it","expect","added","CmsWorkflowsCacheFeature"],"mappings":";;;;;;;;AAeA,MAAMA,YAAiC;IACnC,YAAY;IACZ,aAAaC,YAAY,SAAS;IAClC,QAAQ;IACR,UAAU;IACV,WAAWC,UAAU,QAAQ;AACjC;AAQA,SAASC,YAAYC,SAA4B,CAAC,CAAC;IAC/C,MAAM,EAAEC,UAAU,CAAC,EAAEC,QAAQ,OAAO,EAAEC,MAAM,EAAE,GAAGH;IACjD,MAAMI,OAAgC;QAAEF;QAAO,QAAQ;QAASD;QAAS,QAAQ;IAAM;IACvF,IAAIE,AAAWE,WAAXF,QACAC,KAAK,MAAM,GAAGD;IAElB,OAAO;QACH,IAAI,CAAC,WAAW,EAAEF,SAAS;QAC3B,SAAS;QACTG;IACJ;AACJ;AAEA,SAASE,aAAaC,KAAkC;IACpD,MAAMH,OAA4CG,OAAO;IACzD,OAAOH,MAAM,QAAQ;AACzB;AAEA,IAAII;AAEJ,SAASC;IACL,OAAOD,UAAU,OAAO,CAACE,6BAAwC,GAAG,CAAC;AACzE;AAEA,SAASC;IACL,OAAOF,WAAW,OAAO,CAACF,CAAAA,QAASA,AAAkB,cAAlBA,MAAM,OAAO;AACpD;AAEAK,WAAW;IACPJ,YAAY,IAAIK;IAChBL,UAAU,QAAQ,CAACM,4DAA6B,gBAAgB;IAChEN,UAAU,iBAAiB,CAACO;IAC5BN,WAAW,QAAQ,CAAC;QAACV,YAAY;YAAE,QAAQ;gBAAE,UAAUH;YAAU;QAAE;KAAG;AAC1E;AAEAoB,SAAS,0CAA0C;IAC/CC,GAAG,mFAAmF;QAClFR,WAAW,QAAQ,CAAC;YAACV,YAAY;gBAAE,OAAO;YAAS;SAAG;QAEtD,MAAMQ,QAAQI;QACdO,OAAOX,OAAO,KAAK,OAAO,IAAI,CAAC;QAC/BW,OAAOZ,aAAaC,QAAQ,OAAO,CAACX;IACxC;IAEAqB,GAAG,iFAAiF;QAChFR,WAAW,QAAQ,CAAC;YAACV,YAAY;gBAAE,OAAO;gBAAU,QAAQ,CAAC;YAAE;SAAG;QAElEmB,OAAOZ,aAAaK,cAAc,OAAO,CAACf;IAC9C;IAEAqB,GAAG,mEAAmE;QAClER,WAAW,QAAQ,CAAC;YAACV,YAAY;gBAAE,QAAQ;oBAAE,UAAU;gBAAK;YAAE;SAAG;QAEjEmB,OAAOZ,aAAaK,cAAc,QAAQ;IAC9C;IAEAM,GAAG,wEAAwE;QACvER,WAAW,QAAQ,CAAC;YAACV,YAAY;gBAAE,SAAS;YAAE;SAAG;QAEjD,MAAMQ,QAAQI;QACdO,OAAOX,OAAO,IAAI,IAAI,CAAC;QACvBW,OAAOZ,aAAaC,QAAQ,aAAa;IAC7C;IAEAU,GAAG,8CAA8C;QAC7CR,WAAW,KAAK;QAChB,MAAMU,QAAQpB,YAAY;YAAE,OAAO;QAAM;QAEzCU,WAAW,QAAQ,CAAC;YAACU;SAAM;QAE3BD,OAAOP,aAAa,OAAO,CAACQ;IAChC;IAEAF,GAAG,mDAAmD;QAClDR,WAAW,WAAW,CAACF,CAAAA,QAASA,AAAkB,cAAlBA,MAAM,OAAO;QAE7CW,OAAOT,WAAW,KAAK,IAAI,IAAI,CAAC;QAChCS,OAAOT,WAAW,QAAQ,IAAI,IAAI,CAAC;IACvC;IAEAQ,GAAG,oDAAoD;QACnDT,YAAY,IAAIK;QAChBL,UAAU,QAAQ,CAACM,4DAA6B,gBAAgB;QAChEM,yBAAyB,QAAQ,CAACZ;QAClCC,WAAW,QAAQ,CAAC;YAACV,YAAY;gBAAE,QAAQ;oBAAE,UAAUH;gBAAU;YAAE;SAAG;QAEtEa,WAAW,QAAQ,CAAC;YAACV,YAAY;gBAAE,OAAO;YAAS;SAAG;QAEtDmB,OAAOZ,aAAaK,cAAc,OAAO,CAACf;IAC9C;AACJ"}

package/features/cache/ReviewPreservingEntriesCache.d.ts

@@ -0,0 +1,18 @@
+import type { IListCache } from "@webiny/app-admin/features/listCache/index.js";
+import type { IListCacheItemUpdater } from "@webiny/app-admin/features/listCache/index.js";
+import type { IListCachePredicate } from "@webiny/app-admin/features/listCache/index.js";
+import type { CmsContentEntry } from "@webiny/app-headless-cms-common/types/index.js";
+export declare class ReviewPreservingEntriesCache implements IListCache<CmsContentEntry> {
+    private readonly cache;
+    constructor(cache: IListCache<CmsContentEntry>);
+    count(): number;
+    clear(): void;
+    hasItems(): boolean;
+    getItems(): CmsContentEntry[];
+    getItem(predicate: IListCachePredicate<CmsContentEntry>): CmsContentEntry | undefined;
+    addItems(items: CmsContentEntry[]): void;
+    setItems(items: CmsContentEntry[]): void;
+    updateItems(updater: IListCacheItemUpdater<CmsContentEntry>): void;
+    removeItems(predicate: IListCachePredicate<CmsContentEntry>): void;
+    private keepCachedWorkflow;
+}

package/features/cache/ReviewPreservingEntriesCache.js

@@ -0,0 +1,54 @@
+class ReviewPreservingEntriesCache {
+    constructor(cache){
+        this.cache = cache;
+    }
+    count() {
+        return this.cache.count();
+    }
+    clear() {
+        this.cache.clear();
+    }
+    hasItems() {
+        return this.cache.hasItems();
+    }
+    getItems() {
+        return this.cache.getItems();
+    }
+    getItem(predicate) {
+        return this.cache.getItem(predicate);
+    }
+    addItems(items) {
+        this.cache.addItems(items.map((item)=>this.keepCachedWorkflow(item)));
+    }
+    setItems(items) {
+        this.cache.setItems(items);
+    }
+    updateItems(updater) {
+        this.cache.updateItems(updater);
+    }
+    removeItems(predicate) {
+        this.cache.removeItems(predicate);
+    }
+    keepCachedWorkflow(item) {
+        const meta = item.meta;
+        if (meta.system?.workflow !== void 0) return item;
+        const cached = this.cache.getItem((entry)=>entry.id === item.id);
+        const cachedMeta = cached?.meta;
+        const workflow = cachedMeta?.system?.workflow;
+        if (void 0 === workflow) return item;
+        const nextMeta = {
+            ...item.meta,
+            system: {
+                ...meta.system,
+                workflow
+            }
+        };
+        return {
+            ...item,
+            meta: nextMeta
+        };
+    }
+}
+export { ReviewPreservingEntriesCache };
+
+//# sourceMappingURL=ReviewPreservingEntriesCache.js.map

package/features/cache/ReviewPreservingEntriesCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"features/cache/ReviewPreservingEntriesCache.js","sources":["../../../src/features/cache/ReviewPreservingEntriesCache.ts"],"sourcesContent":["import type { IListCache } from \"@webiny/app-admin/features/listCache/index.js\";\nimport type { IListCacheItemUpdater } from \"@webiny/app-admin/features/listCache/index.js\";\nimport type { IListCachePredicate } from \"@webiny/app-admin/features/listCache/index.js\";\nimport type { CmsContentEntry } from \"@webiny/app-headless-cms-common/types/index.js\";\nimport type { ICmsEntryMetaWithReview } from \"~/types.js\";\n\n/*\n * Only the entry list and entry reads select `meta.system.workflow`; the entries the mutations\n * return (update, publish, restore, ...) do not, and adding one replaces the cached row. An added\n * entry without a workflow selection keeps the cached revision's workflow; a different revision\n * of the entry (a new one) has no review of its own yet, so it keeps nothing.\n */\nexport class ReviewPreservingEntriesCache implements IListCache<CmsContentEntry> {\n    constructor(private readonly cache: IListCache<CmsContentEntry>) {}\n\n    count(): number {\n        return this.cache.count();\n    }\n\n    clear(): void {\n        this.cache.clear();\n    }\n\n    hasItems(): boolean {\n        return this.cache.hasItems();\n    }\n\n    getItems(): CmsContentEntry[] {\n        return this.cache.getItems();\n    }\n\n    getItem(predicate: IListCachePredicate<CmsContentEntry>): CmsContentEntry | undefined {\n        return this.cache.getItem(predicate);\n    }\n\n    addItems(items: CmsContentEntry[]): void {\n        this.cache.addItems(items.map(item => this.keepCachedWorkflow(item)));\n    }\n\n    setItems(items: CmsContentEntry[]): void {\n        this.cache.setItems(items);\n    }\n\n    updateItems(updater: IListCacheItemUpdater<CmsContentEntry>): void {\n        this.cache.updateItems(updater);\n    }\n\n    removeItems(predicate: IListCachePredicate<CmsContentEntry>): void {\n        this.cache.removeItems(predicate);\n    }\n\n    private keepCachedWorkflow(item: CmsContentEntry): CmsContentEntry {\n        const meta: ICmsEntryMetaWithReview = item.meta;\n\n        if (meta.system?.workflow !== undefined) {\n            return item;\n        }\n\n        const cached = this.cache.getItem(entry => entry.id === item.id);\n        const cachedMeta: ICmsEntryMetaWithReview | undefined = cached?.meta;\n        const workflow = cachedMeta?.system?.workflow;\n\n        if (workflow === undefined) {\n            return item;\n        }\n\n        const nextMeta: ICmsEntryMetaWithReview = {\n            ...item.meta,\n            system: { ...meta.system, workflow }\n        };\n\n        return { ...item, meta: nextMeta };\n    }\n}\n"],"names":["ReviewPreservingEntriesCache","cache","predicate","items","item","updater","meta","undefined","cached","entry","cachedMeta","workflow","nextMeta"],"mappings":"AAYO,MAAMA;IACT,YAA6BC,KAAkC,CAAE;aAApCA,KAAK,GAALA;IAAqC;IAElE,QAAgB;QACZ,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK;IAC3B;IAEA,QAAc;QACV,IAAI,CAAC,KAAK,CAAC,KAAK;IACpB;IAEA,WAAoB;QAChB,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ;IAC9B;IAEA,WAA8B;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ;IAC9B;IAEA,QAAQC,SAA+C,EAA+B;QAClF,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAACA;IAC9B;IAEA,SAASC,KAAwB,EAAQ;QACrC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAACA,MAAM,GAAG,CAACC,CAAAA,OAAQ,IAAI,CAAC,kBAAkB,CAACA;IAClE;IAEA,SAASD,KAAwB,EAAQ;QACrC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAACA;IACxB;IAEA,YAAYE,OAA+C,EAAQ;QAC/D,IAAI,CAAC,KAAK,CAAC,WAAW,CAACA;IAC3B;IAEA,YAAYH,SAA+C,EAAQ;QAC/D,IAAI,CAAC,KAAK,CAAC,WAAW,CAACA;IAC3B;IAEQ,mBAAmBE,IAAqB,EAAmB;QAC/D,MAAME,OAAgCF,KAAK,IAAI;QAE/C,IAAIE,KAAK,MAAM,EAAE,aAAaC,QAC1B,OAAOH;QAGX,MAAMI,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAACC,CAAAA,QAASA,MAAM,EAAE,KAAKL,KAAK,EAAE;QAC/D,MAAMM,aAAkDF,QAAQ;QAChE,MAAMG,WAAWD,YAAY,QAAQ;QAErC,IAAIC,AAAaJ,WAAbI,UACA,OAAOP;QAGX,MAAMQ,WAAoC;YACtC,GAAGR,KAAK,IAAI;YACZ,QAAQ;gBAAE,GAAGE,KAAK,MAAM;gBAAEK;YAAS;QACvC;QAEA,OAAO;YAAE,GAAGP,IAAI;YAAE,MAAMQ;QAAS;IACrC;AACJ"}

package/features/cache/abstractions.d.ts

@@ -0,0 +1,5 @@
+import type { IReviewCacheWriter } from "@webiny/app-workflows/review/cache/IReviewCacheWriter.js";
+export declare const CmsReviewCacheWriter: import("@webiny/di").Abstraction<IReviewCacheWriter>;
+export declare namespace CmsReviewCacheWriter {
+    type Interface = IReviewCacheWriter;
+}

package/features/cache/abstractions.js

@@ -0,0 +1,5 @@
+import { createAbstraction } from "@webiny/feature/admin";
+const CmsReviewCacheWriter = createAbstraction("Cms/Workflows/ReviewCacheWriter");
+export { CmsReviewCacheWriter };
+
+//# sourceMappingURL=abstractions.js.map

package/features/cache/abstractions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"features/cache/abstractions.js","sources":["../../../src/features/cache/abstractions.ts"],"sourcesContent":["import { createAbstraction } from \"@webiny/feature/admin\";\nimport type { IReviewCacheWriter } from \"@webiny/app-workflows/review/cache/IReviewCacheWriter.js\";\n\nexport const CmsReviewCacheWriter = createAbstraction<IReviewCacheWriter>(\n    \"Cms/Workflows/ReviewCacheWriter\"\n);\n\nexport namespace CmsReviewCacheWriter {\n    export type Interface = IReviewCacheWriter;\n}\n"],"names":["CmsReviewCacheWriter","createAbstraction"],"mappings":";AAGO,MAAMA,uBAAuBC,kBAChC"}

package/features/editorGateway/CmsWorkflowEditorGateway/CmsWorkflowEditorGateway.d.ts

@@ -0,0 +1,26 @@
+import { MainGraphQLClient } from "@webiny/app/features/mainGraphQLClient/abstractions.js";
+import type { EditorEnvelope } from "@webiny/app-workflows/editor/gateway/dto.js";
+import type { EditorWorkflowDto } from "@webiny/app-workflows/editor/gateway/dto.js";
+import type { RoutingInspectionDto } from "@webiny/app-workflows/editor/gateway/dto.js";
+import type { WorkflowModelPageDto } from "@webiny/app-workflows/editor/gateway/dto.js";
+import type { FolderExistsParams } from "@webiny/app-workflows/editor/appGateway/IWorkflowEditorAppGateway.js";
+import type { InspectRoutingParams } from "@webiny/app-workflows/editor/appGateway/IWorkflowEditorAppGateway.js";
+import type { ListWorkflowModelsParams } from "@webiny/app-workflows/editor/appGateway/IWorkflowEditorAppGateway.js";
+import type { StoreWorkflowParams } from "@webiny/app-workflows/editor/appGateway/IWorkflowEditorAppGateway.js";
+import type { WorkflowAppKind } from "@webiny/app-workflows/domain/WorkflowAppKind.js";
+import { WorkflowEditorAppGateway as GatewayAbstraction } from "@webiny/app-workflows/editor/appGateway/abstractions.js";
+declare class CmsWorkflowEditorGatewayImpl implements GatewayAbstraction.Interface {
+    private client;
+    readonly app: WorkflowAppKind;
+    constructor(client: MainGraphQLClient.Interface);
+    listModels(params: ListWorkflowModelsParams): Promise<EditorEnvelope<WorkflowModelPageDto>>;
+    getWorkflow(id: string): Promise<EditorEnvelope<EditorWorkflowDto>>;
+    storeWorkflow(params: StoreWorkflowParams): Promise<EditorEnvelope<EditorWorkflowDto>>;
+    deleteWorkflow(id: string): Promise<EditorEnvelope<EditorWorkflowDto>>;
+    inspectRouting(params: InspectRoutingParams): Promise<EditorEnvelope<RoutingInspectionDto>>;
+    folderExists(params: FolderExistsParams): Promise<EditorEnvelope<boolean>>;
+}
+export declare const CmsWorkflowEditorGateway: typeof CmsWorkflowEditorGatewayImpl & {
+    __abstraction: import("@webiny/di").Abstraction<import("@webiny/app-workflows/editor/appGateway/IWorkflowEditorAppGateway.js").IWorkflowEditorAppGateway>;
+};
+export {};

package/features/editorGateway/CmsWorkflowEditorGateway/CmsWorkflowEditorGateway.js

@@ -0,0 +1,104 @@
+import { MainGraphQLClient } from "@webiny/app/features/mainGraphQLClient/abstractions.js";
+import { WorkflowEditorAppGateway } from "@webiny/app-workflows/editor/appGateway/abstractions.js";
+import { CMS_ENTRY_FOLDER_EXISTS } from "../graphql/cmsEntryFolderExists.js";
+import { DELETE_CMS_ENTRY_WORKFLOW } from "../graphql/deleteCmsEntryWorkflow.js";
+import { GET_CMS_ENTRY_WORKFLOW } from "../graphql/getCmsEntryWorkflow.js";
+import { INSPECT_CMS_ENTRY_ROUTING } from "../graphql/inspectCmsEntryRouting.js";
+import { LIST_CMS_ENTRY_WORKFLOW_MODELS } from "../graphql/listCmsEntryWorkflowModels.js";
+import { STORE_CMS_ENTRY_WORKFLOW } from "../graphql/storeCmsEntryWorkflow.js";
+class CmsWorkflowEditorGatewayImpl {
+    constructor(client){
+        this.client = client;
+        this.app = "cms";
+    }
+    async listModels(params) {
+        const search = params.search.length > 0 ? params.search : null;
+        const response = await this.client.execute({
+            query: LIST_CMS_ENTRY_WORKFLOW_MODELS,
+            variables: {
+                search,
+                limit: params.limit,
+                after: params.after
+            }
+        });
+        const envelope = response.cms.listCmsEntryWorkflowModels;
+        if (envelope.error) return {
+            data: null,
+            error: envelope.error
+        };
+        if (!envelope.data) return {
+            data: null,
+            error: null
+        };
+        const meta = envelope.meta ?? {
+            cursor: null,
+            hasMoreItems: false
+        };
+        return {
+            data: {
+                rows: envelope.data,
+                meta
+            },
+            error: null
+        };
+    }
+    async getWorkflow(id) {
+        const response = await this.client.execute({
+            query: GET_CMS_ENTRY_WORKFLOW,
+            variables: {
+                id
+            }
+        });
+        return response.cms.getCmsEntryWorkflow;
+    }
+    async storeWorkflow(params) {
+        const response = await this.client.execute({
+            query: STORE_CMS_ENTRY_WORKFLOW,
+            variables: {
+                data: params.data,
+                savedOn: params.savedOn
+            }
+        });
+        return response.cms.storeCmsEntryWorkflow;
+    }
+    async deleteWorkflow(id) {
+        const response = await this.client.execute({
+            query: DELETE_CMS_ENTRY_WORKFLOW,
+            variables: {
+                id
+            }
+        });
+        return response.cms.deleteCmsEntryWorkflow;
+    }
+    async inspectRouting(params) {
+        const response = await this.client.execute({
+            query: INSPECT_CMS_ENTRY_ROUTING,
+            variables: {
+                stepConfig: params.stepConfig,
+                modelId: params.modelId,
+                requesterId: params.requesterId,
+                folderId: params.folderId
+            }
+        });
+        return response.cms.inspectCmsEntryRouting;
+    }
+    async folderExists(params) {
+        const response = await this.client.execute({
+            query: CMS_ENTRY_FOLDER_EXISTS,
+            variables: {
+                id: params.id,
+                type: params.type
+            }
+        });
+        return response.cms.cmsEntryFolderExists;
+    }
+}
+const CmsWorkflowEditorGateway = WorkflowEditorAppGateway.createImplementation({
+    implementation: CmsWorkflowEditorGatewayImpl,
+    dependencies: [
+        MainGraphQLClient
+    ]
+});
+export { CmsWorkflowEditorGateway };
+
+//# sourceMappingURL=CmsWorkflowEditorGateway.js.map

package/features/editorGateway/CmsWorkflowEditorGateway/CmsWorkflowEditorGateway.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"features/editorGateway/CmsWorkflowEditorGateway/CmsWorkflowEditorGateway.js","sources":["../../../../src/features/editorGateway/CmsWorkflowEditorGateway/CmsWorkflowEditorGateway.ts"],"sourcesContent":["import { MainGraphQLClient } from \"@webiny/app/features/mainGraphQLClient/abstractions.js\";\nimport type { EditorEnvelope } from \"@webiny/app-workflows/editor/gateway/dto.js\";\nimport type { EditorErrorDto } from \"@webiny/app-workflows/editor/gateway/dto.js\";\nimport type { EditorListMetaDto } from \"@webiny/app-workflows/editor/gateway/dto.js\";\nimport type { EditorWorkflowDto } from \"@webiny/app-workflows/editor/gateway/dto.js\";\nimport type { RoutingInspectionDto } from \"@webiny/app-workflows/editor/gateway/dto.js\";\nimport type { WorkflowModelPageDto } from \"@webiny/app-workflows/editor/gateway/dto.js\";\nimport type { WorkflowModelRowDto } from \"@webiny/app-workflows/editor/gateway/dto.js\";\nimport type { FolderExistsParams } from \"@webiny/app-workflows/editor/appGateway/IWorkflowEditorAppGateway.js\";\nimport type { InspectRoutingParams } from \"@webiny/app-workflows/editor/appGateway/IWorkflowEditorAppGateway.js\";\nimport type { ListWorkflowModelsParams } from \"@webiny/app-workflows/editor/appGateway/IWorkflowEditorAppGateway.js\";\nimport type { StoreWorkflowParams } from \"@webiny/app-workflows/editor/appGateway/IWorkflowEditorAppGateway.js\";\nimport type { WorkflowAppKind } from \"@webiny/app-workflows/domain/WorkflowAppKind.js\";\nimport type { CmsOperationResponse } from \"~/features/gateway/graphql/CmsOperationResponse.js\";\nimport { WorkflowEditorAppGateway as GatewayAbstraction } from \"@webiny/app-workflows/editor/appGateway/abstractions.js\";\nimport { CMS_ENTRY_FOLDER_EXISTS } from \"../graphql/cmsEntryFolderExists.js\";\nimport { DELETE_CMS_ENTRY_WORKFLOW } from \"../graphql/deleteCmsEntryWorkflow.js\";\nimport { GET_CMS_ENTRY_WORKFLOW } from \"../graphql/getCmsEntryWorkflow.js\";\nimport { INSPECT_CMS_ENTRY_ROUTING } from \"../graphql/inspectCmsEntryRouting.js\";\nimport { LIST_CMS_ENTRY_WORKFLOW_MODELS } from \"../graphql/listCmsEntryWorkflowModels.js\";\nimport { STORE_CMS_ENTRY_WORKFLOW } from \"../graphql/storeCmsEntryWorkflow.js\";\n\n// A list answer of the server: the rows and the page meta next to the error.\ninterface CmsWorkflowModelListEnvelope {\n    data: WorkflowModelRowDto[] | null;\n    meta: EditorListMetaDto | null;\n    error: EditorErrorDto | null;\n}\n\nclass CmsWorkflowEditorGatewayImpl implements GatewayAbstraction.Interface {\n    // The routing `WorkflowEditorGateway` picks this gateway for `app: \"cms\"` (R347).\n    public readonly app: WorkflowAppKind = \"cms\";\n\n    constructor(private client: MainGraphQLClient.Interface) {}\n\n    async listModels(\n        params: ListWorkflowModelsParams\n    ): Promise<EditorEnvelope<WorkflowModelPageDto>> {\n        const search = params.search.length > 0 ? params.search : null;\n\n        const response = await this.client.execute<\n            CmsOperationResponse<\"listCmsEntryWorkflowModels\", CmsWorkflowModelListEnvelope>\n        >({\n            query: LIST_CMS_ENTRY_WORKFLOW_MODELS,\n            variables: { search, limit: params.limit, after: params.after }\n        });\n\n        const envelope = response.cms.listCmsEntryWorkflowModels;\n        if (envelope.error) {\n            return { data: null, error: envelope.error };\n        }\n        if (!envelope.data) {\n            return { data: null, error: null };\n        }\n        const meta: EditorListMetaDto = envelope.meta ?? { cursor: null, hasMoreItems: false };\n        return { data: { rows: envelope.data, meta }, error: null };\n    }\n\n    async getWorkflow(id: string): Promise<EditorEnvelope<EditorWorkflowDto>> {\n        const response = await this.client.execute<\n            CmsOperationResponse<\"getCmsEntryWorkflow\", EditorEnvelope<EditorWorkflowDto>>\n        >({\n            query: GET_CMS_ENTRY_WORKFLOW,\n            variables: { id }\n        });\n\n        return response.cms.getCmsEntryWorkflow;\n    }\n\n    async storeWorkflow(params: StoreWorkflowParams): Promise<EditorEnvelope<EditorWorkflowDto>> {\n        const response = await this.client.execute<\n            CmsOperationResponse<\"storeCmsEntryWorkflow\", EditorEnvelope<EditorWorkflowDto>>\n        >({\n            query: STORE_CMS_ENTRY_WORKFLOW,\n            variables: { data: params.data, savedOn: params.savedOn }\n        });\n\n        return response.cms.storeCmsEntryWorkflow;\n    }\n\n    async deleteWorkflow(id: string): Promise<EditorEnvelope<EditorWorkflowDto>> {\n        const response = await this.client.execute<\n            CmsOperationResponse<\"deleteCmsEntryWorkflow\", EditorEnvelope<EditorWorkflowDto>>\n        >({\n            query: DELETE_CMS_ENTRY_WORKFLOW,\n            variables: { id }\n        });\n\n        return response.cms.deleteCmsEntryWorkflow;\n    }\n\n    async inspectRouting(\n        params: InspectRoutingParams\n    ): Promise<EditorEnvelope<RoutingInspectionDto>> {\n        const response = await this.client.execute<\n            CmsOperationResponse<\"inspectCmsEntryRouting\", EditorEnvelope<RoutingInspectionDto>>\n        >({\n            query: INSPECT_CMS_ENTRY_ROUTING,\n            variables: {\n                stepConfig: params.stepConfig,\n                modelId: params.modelId,\n                requesterId: params.requesterId,\n                folderId: params.folderId\n            }\n        });\n\n        return response.cms.inspectCmsEntryRouting;\n    }\n\n    async folderExists(params: FolderExistsParams): Promise<EditorEnvelope<boolean>> {\n        const response = await this.client.execute<\n            CmsOperationResponse<\"cmsEntryFolderExists\", EditorEnvelope<boolean>>\n        >({\n            query: CMS_ENTRY_FOLDER_EXISTS,\n            variables: { id: params.id, type: params.type }\n        });\n\n        return response.cms.cmsEntryFolderExists;\n    }\n}\n\n/*\n * The CMS registration of the shared `WorkflowEditorAppGateway` token (R347). It keeps its app name\n * (R344): the CMS and WB registrations of one token stay distinguishable.\n */\nexport const CmsWorkflowEditorGateway = GatewayAbstraction.createImplementation({\n    implementation: CmsWorkflowEditorGatewayImpl,\n    dependencies: [MainGraphQLClient]\n});\n"],"names":["CmsWorkflowEditorGatewayImpl","client","params","search","response","LIST_CMS_ENTRY_WORKFLOW_MODELS","envelope","meta","id","GET_CMS_ENTRY_WORKFLOW","STORE_CMS_ENTRY_WORKFLOW","DELETE_CMS_ENTRY_WORKFLOW","INSPECT_CMS_ENTRY_ROUTING","CMS_ENTRY_FOLDER_EXISTS","CmsWorkflowEditorGateway","GatewayAbstraction","MainGraphQLClient"],"mappings":";;;;;;;;AA6BA,MAAMA;IAIF,YAAoBC,MAAmC,CAAE;aAArCA,MAAM,GAANA;aAFJ,GAAG,GAAoB;IAEmB;IAE1D,MAAM,WACFC,MAAgC,EACa;QAC7C,MAAMC,SAASD,OAAO,MAAM,CAAC,MAAM,GAAG,IAAIA,OAAO,MAAM,GAAG;QAE1D,MAAME,WAAW,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAExC;YACE,OAAOC;YACP,WAAW;gBAAEF;gBAAQ,OAAOD,OAAO,KAAK;gBAAE,OAAOA,OAAO,KAAK;YAAC;QAClE;QAEA,MAAMI,WAAWF,SAAS,GAAG,CAAC,0BAA0B;QACxD,IAAIE,SAAS,KAAK,EACd,OAAO;YAAE,MAAM;YAAM,OAAOA,SAAS,KAAK;QAAC;QAE/C,IAAI,CAACA,SAAS,IAAI,EACd,OAAO;YAAE,MAAM;YAAM,OAAO;QAAK;QAErC,MAAMC,OAA0BD,SAAS,IAAI,IAAI;YAAE,QAAQ;YAAM,cAAc;QAAM;QACrF,OAAO;YAAE,MAAM;gBAAE,MAAMA,SAAS,IAAI;gBAAEC;YAAK;YAAG,OAAO;QAAK;IAC9D;IAEA,MAAM,YAAYC,EAAU,EAA8C;QACtE,MAAMJ,WAAW,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAExC;YACE,OAAOK;YACP,WAAW;gBAAED;YAAG;QACpB;QAEA,OAAOJ,SAAS,GAAG,CAAC,mBAAmB;IAC3C;IAEA,MAAM,cAAcF,MAA2B,EAA8C;QACzF,MAAME,WAAW,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAExC;YACE,OAAOM;YACP,WAAW;gBAAE,MAAMR,OAAO,IAAI;gBAAE,SAASA,OAAO,OAAO;YAAC;QAC5D;QAEA,OAAOE,SAAS,GAAG,CAAC,qBAAqB;IAC7C;IAEA,MAAM,eAAeI,EAAU,EAA8C;QACzE,MAAMJ,WAAW,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAExC;YACE,OAAOO;YACP,WAAW;gBAAEH;YAAG;QACpB;QAEA,OAAOJ,SAAS,GAAG,CAAC,sBAAsB;IAC9C;IAEA,MAAM,eACFF,MAA4B,EACiB;QAC7C,MAAME,WAAW,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAExC;YACE,OAAOQ;YACP,WAAW;gBACP,YAAYV,OAAO,UAAU;gBAC7B,SAASA,OAAO,OAAO;gBACvB,aAAaA,OAAO,WAAW;gBAC/B,UAAUA,OAAO,QAAQ;YAC7B;QACJ;QAEA,OAAOE,SAAS,GAAG,CAAC,sBAAsB;IAC9C;IAEA,MAAM,aAAaF,MAA0B,EAAoC;QAC7E,MAAME,WAAW,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAExC;YACE,OAAOS;YACP,WAAW;gBAAE,IAAIX,OAAO,EAAE;gBAAE,MAAMA,OAAO,IAAI;YAAC;QAClD;QAEA,OAAOE,SAAS,GAAG,CAAC,oBAAoB;IAC5C;AACJ;AAMO,MAAMU,2BAA2BC,yBAAAA,oBAAuC,CAAC;IAC5E,gBAAgBf;IAChB,cAAc;QAACgB;KAAkB;AACrC"}

package/features/editorGateway/CmsWorkflowEditorGateway/CmsWorkflowEditorGateway.test.d.ts

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