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

package/testing/reviewStates.d.ts

@@ -0,0 +1,17 @@
+import type { TargetReviewPresenter } from "@webiny/app-workflows/review/presentation/targetReview/abstractions.js";
+export declare const CHECKING = "Checking review status\u2026";
+export declare const FAILED_REASON = "The review status could not be loaded. Try again from the review bar.";
+export declare const NEEDS_REVIEW = "Publishing needs an approved review. Request a review first.";
+export declare const REJECTED_REASON = "This revision was rejected. Create a new revision, then request a new review.";
+export declare const IN_REVIEW_REASON = "This revision is in review. Publishing is allowed once every step approves.";
+export declare const NO_MOVE = "Can\u2019t move while this revision is in review.";
+type Rules = Partial<TargetReviewPresenter.ViewModel>;
+export declare const NO_WORKFLOW: Rules;
+export declare const BOUND_NO_REVIEW: Rules;
+export declare const BOUND_UNPUBLISHED: Rules;
+export declare const LOADING: Rules;
+export declare const FAILED: Rules;
+export declare const IN_REVIEW: Rules;
+export declare const REJECTED: Rules;
+export declare const APPROVED: Rules;
+export {};

package/testing/reviewStates.js

@@ -0,0 +1,65 @@
+const CHECKING = "Checking review status…";
+const FAILED_REASON = "The review status could not be loaded. Try again from the review bar.";
+const NEEDS_REVIEW = "Publishing needs an approved review. Request a review first.";
+const REJECTED_REASON = "This revision was rejected. Create a new revision, then request a new review.";
+const IN_REVIEW_REASON = "This revision is in review. Publishing is allowed once every step approves.";
+const NO_MOVE = "Can’t move while this revision is in review.";
+const NO_WORKFLOW = {
+    status: "noWorkflow",
+    allowsEditing: true,
+    allowsPublishing: true,
+    publishDisabledReason: null,
+    moveDisabledReason: null
+};
+const BOUND_NO_REVIEW = {
+    status: "none",
+    allowsEditing: true,
+    allowsPublishing: false,
+    publishDisabledReason: NEEDS_REVIEW,
+    moveDisabledReason: null
+};
+const BOUND_UNPUBLISHED = {
+    status: "none",
+    allowsEditing: true,
+    allowsPublishing: true,
+    publishDisabledReason: null,
+    moveDisabledReason: null
+};
+const LOADING = {
+    status: "loading",
+    allowsEditing: false,
+    allowsPublishing: false,
+    publishDisabledReason: CHECKING,
+    moveDisabledReason: CHECKING
+};
+const FAILED = {
+    status: "failed",
+    allowsEditing: false,
+    allowsPublishing: false,
+    publishDisabledReason: FAILED_REASON,
+    moveDisabledReason: FAILED_REASON
+};
+const IN_REVIEW = {
+    status: "active",
+    allowsEditing: false,
+    allowsPublishing: false,
+    publishDisabledReason: IN_REVIEW_REASON,
+    moveDisabledReason: NO_MOVE
+};
+const REJECTED = {
+    status: "active",
+    allowsEditing: false,
+    allowsPublishing: false,
+    publishDisabledReason: REJECTED_REASON,
+    moveDisabledReason: null
+};
+const APPROVED = {
+    status: "active",
+    allowsEditing: false,
+    allowsPublishing: true,
+    publishDisabledReason: null,
+    moveDisabledReason: null
+};
+export { APPROVED, BOUND_NO_REVIEW, BOUND_UNPUBLISHED, CHECKING, FAILED, FAILED_REASON, IN_REVIEW, IN_REVIEW_REASON, LOADING, NEEDS_REVIEW, NO_MOVE, NO_WORKFLOW, REJECTED, REJECTED_REASON };
+
+//# sourceMappingURL=reviewStates.js.map

package/testing/reviewStates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing/reviewStates.js","sources":["../../src/testing/reviewStates.ts"],"sourcesContent":["import type { TargetReviewPresenter } from \"@webiny/app-workflows/review/presentation/targetReview/abstractions.js\";\n\nexport const CHECKING = \"Checking review status…\";\nexport const FAILED_REASON =\n    \"The review status could not be loaded. Try again from the review bar.\";\nexport const NEEDS_REVIEW = \"Publishing needs an approved review. Request a review first.\";\nexport const REJECTED_REASON =\n    \"This revision was rejected. Create a new revision, then request a new review.\";\nexport const IN_REVIEW_REASON =\n    \"This revision is in review. Publishing is allowed once every step approves.\";\nexport const NO_MOVE = \"Can’t move while this revision is in review.\";\n\ntype Rules = Partial<TargetReviewPresenter.ViewModel>;\n\n// A model without a workflow: nothing is shown and nothing is gated.\nexport const NO_WORKFLOW: Rules = {\n    status: \"noWorkflow\",\n    allowsEditing: true,\n    allowsPublishing: true,\n    publishDisabledReason: null,\n    moveDisabledReason: null\n};\n\n// A workflow is bound but there is no active review: editing is free, publishing needs a review.\nexport const BOUND_NO_REVIEW: Rules = {\n    status: \"none\",\n    allowsEditing: true,\n    allowsPublishing: false,\n    publishDisabledReason: NEEDS_REVIEW,\n    moveDisabledReason: null\n};\n\n/*\n * An unpublished revision with no review: it was reviewed before it was published, so it can be\n * published again (R226, Q19).\n */\nexport const BOUND_UNPUBLISHED: Rules = {\n    status: \"none\",\n    allowsEditing: true,\n    allowsPublishing: true,\n    publishDisabledReason: null,\n    moveDisabledReason: null\n};\n\nexport const LOADING: Rules = {\n    status: \"loading\",\n    allowsEditing: false,\n    allowsPublishing: false,\n    publishDisabledReason: CHECKING,\n    moveDisabledReason: CHECKING\n};\n\nexport const FAILED: Rules = {\n    status: \"failed\",\n    allowsEditing: false,\n    allowsPublishing: false,\n    publishDisabledReason: FAILED_REASON,\n    moveDisabledReason: FAILED_REASON\n};\n\nexport const IN_REVIEW: Rules = {\n    status: \"active\",\n    allowsEditing: false,\n    allowsPublishing: false,\n    publishDisabledReason: IN_REVIEW_REASON,\n    moveDisabledReason: NO_MOVE\n};\n\nexport const REJECTED: Rules = {\n    status: \"active\",\n    allowsEditing: false,\n    allowsPublishing: false,\n    publishDisabledReason: REJECTED_REASON,\n    moveDisabledReason: null\n};\n\nexport const APPROVED: Rules = {\n    status: \"active\",\n    allowsEditing: false,\n    allowsPublishing: true,\n    publishDisabledReason: null,\n    moveDisabledReason: null\n};\n"],"names":["CHECKING","FAILED_REASON","NEEDS_REVIEW","REJECTED_REASON","IN_REVIEW_REASON","NO_MOVE","NO_WORKFLOW","BOUND_NO_REVIEW","BOUND_UNPUBLISHED","LOADING","FAILED","IN_REVIEW","REJECTED","APPROVED"],"mappings":"AAEO,MAAMA,WAAW;AACjB,MAAMC,gBACT;AACG,MAAMC,eAAe;AACrB,MAAMC,kBACT;AACG,MAAMC,mBACT;AACG,MAAMC,UAAU;AAKhB,MAAMC,cAAqB;IAC9B,QAAQ;IACR,eAAe;IACf,kBAAkB;IAClB,uBAAuB;IACvB,oBAAoB;AACxB;AAGO,MAAMC,kBAAyB;IAClC,QAAQ;IACR,eAAe;IACf,kBAAkB;IAClB,uBAAuBL;IACvB,oBAAoB;AACxB;AAMO,MAAMM,oBAA2B;IACpC,QAAQ;IACR,eAAe;IACf,kBAAkB;IAClB,uBAAuB;IACvB,oBAAoB;AACxB;AAEO,MAAMC,UAAiB;IAC1B,QAAQ;IACR,eAAe;IACf,kBAAkB;IAClB,uBAAuBT;IACvB,oBAAoBA;AACxB;AAEO,MAAMU,SAAgB;IACzB,QAAQ;IACR,eAAe;IACf,kBAAkB;IAClB,uBAAuBT;IACvB,oBAAoBA;AACxB;AAEO,MAAMU,YAAmB;IAC5B,QAAQ;IACR,eAAe;IACf,kBAAkB;IAClB,uBAAuBP;IACvB,oBAAoBC;AACxB;AAEO,MAAMO,WAAkB;IAC3B,QAAQ;IACR,eAAe;IACf,kBAAkB;IAClB,uBAAuBT;IACvB,oBAAoB;AACxB;AAEO,MAAMU,WAAkB;IAC3B,QAAQ;IACR,eAAe;IACf,kBAAkB;IAClB,uBAAuB;IACvB,oBAAoB;AACxB"}

package/types.d.ts

@@ -0,0 +1,10 @@
+import type { CmsContentEntry } from "@webiny/app-headless-cms-common/types/index.js";
+import type { SystemWorkflowValue } from "@webiny/app-workflows/review/domain/types.js";
+export interface ICmsEntrySystemWithReview {
+    workflow?: SystemWorkflowValue | null;
+}
+type CmsEntryMeta = CmsContentEntry["meta"];
+export interface ICmsEntryMetaWithReview extends CmsEntryMeta {
+    system?: ICmsEntrySystemWithReview | null;
+}
+export {};

package/utils/appName.d.ts

@@ -0,0 +1,4 @@
+import type { CmsModel } from "@webiny/app-headless-cms-common/types/index.js";
+export declare const createAppName: (model: Pick<CmsModel, "modelId">) => string;
+export declare const parseAppName: (appName: string) => string;
+export declare const isCmsAppName: (appName: string) => boolean;

package/utils/appName.js

@@ -0,0 +1,13 @@
+const createAppName = (model)=>`cms.${model.modelId}`;
+const parseAppName = (appName)=>{
+    const parts = appName.split(".");
+    if (2 !== parts.length || "cms" !== parts[0]) throw new Error(`Invalid app name: "${appName}".`);
+    return parts[1];
+};
+const isCmsAppName = (appName)=>{
+    const parts = appName.split(".");
+    return 2 === parts.length && "cms" === parts[0];
+};
+export { createAppName, isCmsAppName, parseAppName };
+
+//# sourceMappingURL=appName.js.map

package/utils/appName.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils/appName.js","sources":["../../src/utils/appName.ts"],"sourcesContent":["import type { CmsModel } from \"@webiny/app-headless-cms-common/types/index.js\";\n\nexport const createAppName = (model: Pick<CmsModel, \"modelId\">): string => {\n    return `cms.${model.modelId}`;\n};\n\nexport const parseAppName = (appName: string): string => {\n    const parts = appName.split(\".\");\n    if (parts.length !== 2 || parts[0] !== \"cms\") {\n        throw new Error(`Invalid app name: \"${appName}\".`);\n    }\n    return parts[1];\n};\n\nexport const isCmsAppName = (appName: string): boolean => {\n    const parts = appName.split(\".\");\n    return parts.length === 2 && parts[0] === \"cms\";\n};\n"],"names":["createAppName","model","parseAppName","appName","parts","Error","isCmsAppName"],"mappings":"AAEO,MAAMA,gBAAgB,CAACC,QACnB,CAAC,IAAI,EAAEA,MAAM,OAAO,EAAE;AAG1B,MAAMC,eAAe,CAACC;IACzB,MAAMC,QAAQD,QAAQ,KAAK,CAAC;IAC5B,IAAIC,AAAiB,MAAjBA,MAAM,MAAM,IAAUA,AAAa,UAAbA,KAAK,CAAC,EAAE,EAC9B,MAAM,IAAIC,MAAM,CAAC,mBAAmB,EAAEF,QAAQ,EAAE,CAAC;IAErD,OAAOC,KAAK,CAAC,EAAE;AACnB;AAEO,MAAME,eAAe,CAACH;IACzB,MAAMC,QAAQD,QAAQ,KAAK,CAAC;IAC5B,OAAOC,AAAiB,MAAjBA,MAAM,MAAM,IAAUA,AAAa,UAAbA,KAAK,CAAC,EAAE;AACzC"}

package/utils/isReviewableModel.d.ts

@@ -0,0 +1,2 @@
+import type { CmsModel } from "@webiny/app-headless-cms-common/types/index.js";
+export declare function isReviewableModel(model: Pick<CmsModel, "tags">): boolean;

package/utils/isReviewableModel.js

@@ -0,0 +1,7 @@
+import { CMS_MODEL_SINGLETON_TAG } from "@webiny/app-headless-cms-common";
+function isReviewableModel(model) {
+    return !model.tags.includes(CMS_MODEL_SINGLETON_TAG);
+}
+export { isReviewableModel };
+
+//# sourceMappingURL=isReviewableModel.js.map

package/utils/isReviewableModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils/isReviewableModel.js","sources":["../../src/utils/isReviewableModel.ts"],"sourcesContent":["import { CMS_MODEL_SINGLETON_TAG } from \"@webiny/app-headless-cms-common\";\nimport type { CmsModel } from \"@webiny/app-headless-cms-common/types/index.js\";\n\n/*\n * Singleton models have one entry that is edited in place and are never bound to a workflow (the\n * old editor skipped them the same way).\n */\nexport function isReviewableModel(model: Pick<CmsModel, \"tags\">): boolean {\n    return !model.tags.includes(CMS_MODEL_SINGLETON_TAG);\n}\n"],"names":["isReviewableModel","model","CMS_MODEL_SINGLETON_TAG"],"mappings":";AAOO,SAASA,kBAAkBC,KAA6B;IAC3D,OAAO,CAACA,MAAM,IAAI,CAAC,QAAQ,CAACC;AAChC"}

package/utils/renderModelIcon.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import type { CmsModel } from "@webiny/app-headless-cms/types.js";
+export declare const renderModelIcon: (model: Pick<CmsModel, "name" | "icon">) => React.ReactNode;

package/utils/renderModelIcon.js

@@ -0,0 +1,19 @@
+import react from "react";
+import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
+import { Icon } from "@webiny/admin-ui";
+import { normalizeIcon } from "@webiny/app-headless-cms/utils/normalizeIcon.js";
+const renderModelIcon = (model)=>{
+    const icon = normalizeIcon(model.icon);
+    if (!icon) return null;
+    return /*#__PURE__*/ react.createElement(Icon, {
+        icon: /*#__PURE__*/ react.createElement(FontAwesomeIcon, {
+            icon: icon
+        }),
+        label: model.name,
+        size: "sm",
+        color: "neutral-light"
+    });
+};
+export { renderModelIcon };
+
+//# sourceMappingURL=renderModelIcon.js.map

package/utils/renderModelIcon.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils/renderModelIcon.js","sources":["../../src/utils/renderModelIcon.tsx"],"sourcesContent":["import React from \"react\";\nimport { FontAwesomeIcon } from \"@fortawesome/react-fontawesome\";\nimport { Icon } from \"@webiny/admin-ui\";\nimport type { CmsModel } from \"@webiny/app-headless-cms/types.js\";\nimport { normalizeIcon } from \"@webiny/app-headless-cms/utils/normalizeIcon.js\";\n\n/*\n * The icon of a content model, drawn from `CmsModel.icon`. A model without a usable icon gets\n * `null`, so each caller picks its own fallback.\n */\nexport const renderModelIcon = (model: Pick<CmsModel, \"name\" | \"icon\">): React.ReactNode => {\n    const icon = normalizeIcon(model.icon);\n    if (!icon) {\n        return null;\n    }\n\n    return (\n        <Icon\n            icon={<FontAwesomeIcon icon={icon} />}\n            label={model.name}\n            size=\"sm\"\n            color=\"neutral-light\"\n        />\n    );\n};\n"],"names":["renderModelIcon","model","icon","normalizeIcon","Icon","FontAwesomeIcon"],"mappings":";;;;AAUO,MAAMA,kBAAkB,CAACC;IAC5B,MAAMC,OAAOC,cAAcF,MAAM,IAAI;IACrC,IAAI,CAACC,MACD,OAAO;IAGX,OAAO,WAAP,GACI,oBAACE,MAAIA;QACD,oBAAM,oBAACC,iBAAeA;YAAC,MAAMH;;QAC7B,OAAOD,MAAM,IAAI;QACjB,MAAK;QACL,OAAM;;AAGlB"}

package/utils/renderModelIconOrFallback.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import type { CmsModel } from "@webiny/app-headless-cms/types.js";
+export declare const renderModelIconOrFallback: (model: Pick<CmsModel, "name" | "icon"> | undefined, fallbackLabel: string) => React.ReactNode;

package/utils/renderModelIconOrFallback.js

@@ -0,0 +1,17 @@
+import react from "react";
+import { Icon } from "@webiny/admin-ui";
+import { ReactComponent } from "@webiny/icons/devices_other.svg";
+import { renderModelIcon } from "./renderModelIcon.js";
+const renderModelIconOrFallback = (model, fallbackLabel)=>{
+    const icon = model ? renderModelIcon(model) : null;
+    if (icon) return icon;
+    return /*#__PURE__*/ react.createElement(Icon, {
+        icon: /*#__PURE__*/ react.createElement(ReactComponent, null),
+        label: model?.name ?? fallbackLabel,
+        size: "sm",
+        color: "neutral-light"
+    });
+};
+export { renderModelIconOrFallback };
+
+//# sourceMappingURL=renderModelIconOrFallback.js.map

package/utils/renderModelIconOrFallback.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils/renderModelIconOrFallback.js","sources":["../../src/utils/renderModelIconOrFallback.tsx"],"sourcesContent":["import React from \"react\";\nimport { Icon } from \"@webiny/admin-ui\";\nimport type { CmsModel } from \"@webiny/app-headless-cms/types.js\";\nimport { ReactComponent as DevicesOtherIcon } from \"@webiny/icons/devices_other.svg\";\nimport { renderModelIcon } from \"./renderModelIcon.js\";\n\n/*\n * The icon of a content model, or the generic `devices_other` icon for a model without a usable\n * icon (or no model at all, labelled with `fallbackLabel`).\n */\nexport const renderModelIconOrFallback = (\n    model: Pick<CmsModel, \"name\" | \"icon\"> | undefined,\n    fallbackLabel: string\n): React.ReactNode => {\n    const icon = model ? renderModelIcon(model) : null;\n    if (icon) {\n        return icon;\n    }\n\n    return (\n        <Icon\n            icon={<DevicesOtherIcon />}\n            label={model?.name ?? fallbackLabel}\n            size=\"sm\"\n            color=\"neutral-light\"\n        />\n    );\n};\n"],"names":["renderModelIconOrFallback","model","fallbackLabel","icon","renderModelIcon","Icon","DevicesOtherIcon"],"mappings":";;;;AAUO,MAAMA,4BAA4B,CACrCC,OACAC;IAEA,MAAMC,OAAOF,QAAQG,gBAAgBH,SAAS;IAC9C,IAAIE,MACA,OAAOA;IAGX,OAAO,WAAP,GACI,oBAACE,MAAIA;QACD,oBAAM,oBAACC,gBAAgBA;QACvB,OAAOL,OAAO,QAAQC;QACtB,MAAK;QACL,OAAM;;AAGlB"}