Skip to content

feat(VE-7062-dev): disable editing based on workflow stage rules #489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
faraazb merged 12 commits into from
Aug 13, 2025
Merged

feat(VE-7062-dev): disable editing based on workflow stage rules #489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
7aeeb63
feat: disable editing when workflow stage rules restrict the same
faraazb-contentstack Aug 6, 2025
790875a
test: fix tests
faraazb-contentstack Aug 7, 2025
1af5522
Merge branch 'main' into VE-7062-disable-entry-edit-workflow-stage
faraazb-contentstack Aug 7, 2025
ce60715
Merge branch 'develop_v3' into dev-VE-7062-disable-entry-edit-workflo…
faraazb-contentstack Aug 7, 2025
0bbf435
Merge branch 'develop_v3' into dev-VE-7062-disable-entry-edit-workflo…
faraazb-contentstack Aug 7, 2025
07f3c96
chore: remove sequential from unit tests
faraazb-contentstack Aug 7, 2025
2e5044e
Merge branch 'VE-7062-disable-entry-edit-workflow-stage' into dev-VE-…
faraazb-contentstack Aug 7, 2025
10c763d
test: add cases for isFieldDisabled
faraazb-contentstack Aug 8, 2025
b26c4ac
Merge branch 'VE-7062-disable-entry-edit-workflow-stage' into dev-VE-…
faraazb-contentstack Aug 8, 2025
472e2e6
fix: handle empty stage name correctly
faraazb-contentstack Aug 11, 2025
5e216ea
chore: replace ifs with switch
faraazb-contentstack Aug 11, 2025
289c505
Merge branch 'VE-7062-disable-entry-edit-workflow-stage' into dev-VE-…
faraazb-contentstack Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 49 additions & 29 deletions src/visualBuilder/__test__/click/fields/multi-line.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ import { VisualBuilderPostMessageEvents } from "../../../utils/types/postMessage
import { VisualBuilder } from "../../../index";
import { triggerAndWaitForClickAction } from "../../../../__test__/utils";

const EXAMPLE_STAGE_NAME = "Example Stage";

vi.mock("../../../components/FieldToolbar", () => {
return {
default: () => {
Expand Down Expand Up @@ -94,23 +96,28 @@ describe("When an element is clicked in visual builder mode", () => {
beforeAll(async () => {
(visualBuilderPostMessage?.send as Mock).mockImplementation(
(eventName: string, args) => {
if (
eventName ===
VisualBuilderPostMessageEvents.GET_FIELD_DATA
) {
return Promise.resolve({
fieldData: "Hello world",
});
} else if (
eventName ===
VisualBuilderPostMessageEvents.GET_FIELD_DISPLAY_NAMES
) {
return Promise.resolve({
"all_fields.bltapikey.en-us.single_line":
"Single Line",
});
switch (eventName) {
case VisualBuilderPostMessageEvents.GET_FIELD_DATA:
return Promise.resolve({
fieldData: "Hello world",
});
case VisualBuilderPostMessageEvents.GET_FIELD_DISPLAY_NAMES:
return Promise.resolve({
"all_fields.bltapikey.en-us.single_line":
"Single Line",
});
case VisualBuilderPostMessageEvents.GET_WORKFLOW_STAGE_DETAILS:
return Promise.resolve({
stage: { name: EXAMPLE_STAGE_NAME },
permissions: {
entry: {
update: true,
},
},
});
default:
return Promise.resolve({});
}
return Promise.resolve({});
}
);

Expand Down Expand Up @@ -185,20 +192,33 @@ describe("When an element is clicked in visual builder mode", () => {
beforeAll(async () => {
(visualBuilderPostMessage?.send as Mock).mockImplementation(
(eventName: string, args) => {
if (
eventName ===
VisualBuilderPostMessageEvents.GET_FIELD_DATA
) {
const values: Record<string, any> = {
multi_line_textbox_multiple_: ["Hello", "world"],
"multi_line_textbox_multiple_.0": "Hello",
"multi_line_textbox_multiple_.1": "world",
};
return Promise.resolve({
fieldData: values[args.entryPath],
});
switch (eventName) {
case VisualBuilderPostMessageEvents.GET_FIELD_DATA: {
const values: Record<string, any> = {
multi_line_textbox_multiple_: [
"Hello",
"world",
],
"multi_line_textbox_multiple_.0": "Hello",
"multi_line_textbox_multiple_.1": "world",
};
return Promise.resolve({
fieldData: values[args.entryPath],
});
}
case VisualBuilderPostMessageEvents.GET_WORKFLOW_STAGE_DETAILS: {
return Promise.resolve({
stage: { name: EXAMPLE_STAGE_NAME },
permissions: {
entry: {
update: true,
},
},
});
}
default:
return Promise.resolve({});
}
return Promise.resolve({});
}
);

Expand Down
26 changes: 26 additions & 0 deletions src/visualBuilder/__test__/click/fields/number.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ import { VisualBuilderPostMessageEvents } from "../../../utils/types/postMessage
import { VisualBuilder } from "../../../index";
import { triggerAndWaitForClickAction } from "../../../../__test__/utils";

const EXAMPLE_STAGE_NAME = "Example Stage";

const VALUES = {
number: "10.5",
};
Expand Down Expand Up @@ -112,6 +114,18 @@ describe("When an element is clicked in visual builder mode", () => {
return Promise.resolve({
"all_fields.bltapikey.en-us.number": "Number",
});
} else if (
eventName ===
VisualBuilderPostMessageEvents.GET_WORKFLOW_STAGE_DETAILS
) {
return Promise.resolve({
stage: { name: EXAMPLE_STAGE_NAME },
permissions: {
entry: {
update: true,
},
},
});
}
return Promise.resolve({});
}
Expand Down Expand Up @@ -196,6 +210,18 @@ describe("When an element is clicked in visual builder mode", () => {
return Promise.resolve({
fieldData: values[args.entryPath],
});
} else if (
eventName ===
VisualBuilderPostMessageEvents.GET_WORKFLOW_STAGE_DETAILS
) {
return Promise.resolve({
stage: { name: EXAMPLE_STAGE_NAME },
permissions: {
entry: {
update: true,
},
},
});
}
return Promise.resolve({});
}
Expand Down
78 changes: 48 additions & 30 deletions src/visualBuilder/__test__/click/fields/single-line.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ import { Mock, vi } from "vitest";
import { VisualBuilderPostMessageEvents } from "../../../utils/types/postMessage.types";
import { VisualBuilder } from "../../../index";
import { triggerAndWaitForClickAction } from "../../../../__test__/utils";
import { act } from "preact/test-utils";

const EXAMPLE_STAGE_NAME = "Example Stage";

const VALUES = {
singleLine: "Single line",
Expand Down Expand Up @@ -99,23 +100,28 @@ describe("When an element is clicked in visual builder mode", () => {
beforeAll(async () => {
(visualBuilderPostMessage?.send as Mock).mockImplementation(
(eventName: string) => {
if (
eventName ===
VisualBuilderPostMessageEvents.GET_FIELD_DATA
) {
return Promise.resolve({
fieldData: VALUES.singleLine,
});
} else if (
eventName ===
VisualBuilderPostMessageEvents.GET_FIELD_DISPLAY_NAMES
) {
return Promise.resolve({
"all_fields.bltapikey.en-us.single_line":
"Single Line",
});
switch (eventName) {
case VisualBuilderPostMessageEvents.GET_FIELD_DATA:
return Promise.resolve({
fieldData: VALUES.singleLine,
});
case VisualBuilderPostMessageEvents.GET_FIELD_DISPLAY_NAMES:
return Promise.resolve({
"all_fields.bltapikey.en-us.single_line":
"Single Line",
});
case VisualBuilderPostMessageEvents.GET_WORKFLOW_STAGE_DETAILS:
return Promise.resolve({
stage: { name: EXAMPLE_STAGE_NAME },
permissions: {
entry: {
update: true,
},
},
});
default:
return Promise.resolve({});
}
return Promise.resolve({});
}
);

Expand Down Expand Up @@ -205,20 +211,32 @@ describe("When an element is clicked in visual builder mode", () => {
beforeAll(async () => {
(visualBuilderPostMessage?.send as Mock).mockImplementation(
(eventName: string, args) => {
if (
eventName ===
VisualBuilderPostMessageEvents.GET_FIELD_DATA
) {
const values: Record<string, any> = {
single_line_textbox_multiple_: ["Hello", "world"],
"single_line_textbox_multiple_.0": "Hello",
"single_line_textbox_multiple_.1": "world",
};
return Promise.resolve({
fieldData: values[args.entryPath],
});
switch (eventName) {
case VisualBuilderPostMessageEvents.GET_FIELD_DATA: {
const values: Record<string, any> = {
single_line_textbox_multiple_: [
"Hello",
"world",
],
"single_line_textbox_multiple_.0": "Hello",
"single_line_textbox_multiple_.1": "world",
};
return Promise.resolve({
fieldData: values[args.entryPath],
});
}
case VisualBuilderPostMessageEvents.GET_WORKFLOW_STAGE_DETAILS:
return Promise.resolve({
stage: { name: EXAMPLE_STAGE_NAME },
permissions: {
entry: {
update: true,
},
},
});
default:
return Promise.resolve({});
}
return Promise.resolve({});
}
);

Expand Down
15 changes: 6 additions & 9 deletions src/visualBuilder/components/FieldToolbar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import getChildrenDirection from "../utils/getChildrenDirection";
import {
ALLOWED_MODAL_EDITABLE_FIELD,
ALLOWED_REPLACE_FIELDS,
DEFAULT_MULTIPLE_FIELDS,
} from "../utils/constants";
import { getFieldType } from "../utils/getFieldType";
import {
Expand All @@ -20,7 +19,6 @@ import {
MoveLeftIcon,
MoveRightIcon,
ReplaceAssetIcon,
MoreIcon,
} from "./icons";
import { fieldIcons } from "./icons/fields";
import classNames from "classnames";
Expand All @@ -42,10 +40,9 @@ import {
} from "./FieldRevert/FieldRevertComponent";
import { LoadingIcon } from "./icons/loading";
import { EntryPermissions } from "../utils/getEntryPermissions";
import { EmptyAppIcon } from "./icons/EmptyAppIcon";
import { FieldLocationAppList } from "./FieldLocationAppList";
import { FieldLocationIcon } from "./FieldLocationIcon";

import { WorkflowStageDetails } from "../utils/getWorkflowStageDetails";

export type FieldDetails = Pick<
VisualBuilderCslpEventDetails,
Expand All @@ -58,7 +55,8 @@ interface MultipleFieldToolbarProps {
eventDetails: VisualBuilderCslpEventDetails;
hideOverlay: () => void;
isVariant?: boolean;
entryPermissions?: EntryPermissions;
entryPermissions?: EntryPermissions | undefined;
entryWorkflowStageDetails?: WorkflowStageDetails | undefined;
}

function handleReplaceAsset(fieldMetadata: CslpData) {
Expand Down Expand Up @@ -118,6 +116,7 @@ function FieldToolbarComponent(
eventDetails,
isVariant: isVariantOrParentOfVariant,
entryPermissions,
entryWorkflowStageDetails,
} = props;
const { fieldMetadata, editableElement: targetElement } = eventDetails;
const [isFormLoading, setIsFormLoading] = useState(false);
Expand Down Expand Up @@ -158,12 +157,12 @@ function FieldToolbarComponent(
editableElement: targetElement,
fieldMetadata,
},
entryPermissions
entryPermissions,
entryWorkflowStageDetails
);
disableFieldActions = isDisabled;

fieldType = getFieldType(fieldSchema);


Icon = fieldIcons[fieldType];

Expand Down Expand Up @@ -394,8 +393,6 @@ function FieldToolbarComponent(
};
}, []);



useEffect(() => {
const fetchFieldLocationData = async () => {
try {
Expand Down
Loading
Loading