Merge pull request #379 from contentstack/rename-to-editInVisualBuilderButton

chore: rename `editButtonBulider` to `editInVisualBuilderButton`

Author: hiteshshetty-dev

docs/live-preview-configs.md

@@ -124,12 +124,12 @@ ContentstackLivePreview.init({
 });
 ```
 
-### `editButtonBuilder`
-the editButtonBuilder object allows you to manage the "Start Editing" button outside Visual Builder. It offers the following features:
+### `editInVisualBuilderButton`
+the editInVisualBuilderButton object allows you to manage the "Start Editing" button outside Visual Builder. It offers the following features:
 - Enable/disable the "Start Editing" button
 - Adjust the position of the "Start Editing" button using four predefined positions
 
-The editButtonBuilder object contains two keys:
+The editInVisualBuilderButton object contains two keys:
 
 1. #### `enable`
     | type    | default | optional |

src/configManager/config.default.ts

@@ -16,7 +16,7 @@ export function getUserInitData(): IInitData {
             position: "top",
             includeByQueryParameter: true,
         },
-        editButtonBuilder: {
+        editInVisualBuilderButton: {
             enable: true,
             position: "bottom-right"
         },
@@ -54,7 +54,7 @@ export function getDefaultConfig(): IConfig {
             position: "top",
             includeByQueryParameter: true,
         },
-        editButtonBuilder: {
+        editInVisualBuilderButton: {
             enable: true,
             position: "bottom-right"
         },

src/configManager/handleUserConfig.ts

@@ -109,15 +109,15 @@ export const handleInitData = (initData: Partial<IInitData>): void => {
             true,
     });
 
-    Config.set("editButtonBuilder", {
+    Config.set("editInVisualBuilderButton", {
         enable:
-            initData.editButtonBuilder?.enable ??
-            stackSdk.live_preview?.editButtonBuilder?.enable ??
-            config.editButtonBuilder.enable,
+            initData.editInVisualBuilderButton?.enable ??
+            stackSdk.live_preview?.editInVisualBuilderButton?.enable ??
+            config.editInVisualBuilderButton.enable,
         position:  
-            initData.editButtonBuilder?.position ??
+            initData.editInVisualBuilderButton?.position ??
             stackSdk.live_preview?.position ??
-            config.editButtonBuilder.position ??
+            config.editInVisualBuilderButton.position ??
             "bottom-right",
     })
 

src/types/types.ts

@@ -79,14 +79,15 @@ export declare interface IConfig {
     windowType: ILivePreviewWindowType;
     hash: string;
     editButton: IConfigEditButton;
-    editButtonBuilder: IConfigEditButtonBuilder;
+    editInVisualBuilderButton: IConfigEditInVisualBuilderButton;
     mode: ILivePreviewModeConfig;
     elements: {
         highlightedElement: HTMLElement | null;
     };
 }
 
-export declare interface IConfigEditButtonBuilder {
+
+export declare interface IConfigEditInVisualBuilderButton {
     enable: boolean;
     position?:
         | "top-left"
@@ -126,7 +127,7 @@ export declare interface IInitData {
     clientUrlParams: Partial<Omit<IClientUrlParams, "url">>;
     stackSdk: IStackSdk;
     editButton: IConfigEditButton;
-    editButtonBuilder: IConfigEditButtonBuilder;
+    editInVisualBuilderButton: IConfigEditInVisualBuilderButton;
     mode: ILivePreviewMode;
 }
 

src/visualBuilder/components/__test__/startEditingButton.test.tsx

@@ -47,13 +47,13 @@ describe("StartEditingButtonComponent", () => {
     });
 
     test("should not render when enable is false", async () => {
-        Config.set("editButtonBuilder.enable", false);
+        Config.set("editInVisualBuilderButton.enable", false);
         const { container } = await asyncRender(<StartEditingButtonComponent />);
         expect(container).toBeEmptyDOMElement();
     });
 
     test("should render when enable is true", async () => {
-        Config.set("editButtonBuilder.enable", true);
+        Config.set("editInVisualBuilderButton.enable", true);
         const { getByTestId } = await asyncRender(<StartEditingButtonComponent />);
         const button = getByTestId("vcms-start-editing-btn");
         expect(button).toBeInTheDocument();
@@ -82,15 +82,15 @@ describe("StartEditingButtonComponent", () => {
         expect(getEditButtonPosition(invalidPosition)).toBe('bottom-right');
     });
 
-    test("should render with default values when editButtonBuilder config is missing", async () => {
+    test("should render with default values when editInVisualBuilderButton config is missing", async () => {
         Config.reset();
         Config.set("stackDetails.apiKey", "bltapikey");
         Config.set("stackDetails.environment", "bltenvironment");
 
         const { getByTestId } = await asyncRender(<StartEditingButtonComponent />);
         const button = getByTestId("vcms-start-editing-btn");
 
-        expect(Config.get().editButtonBuilder.position).toBe("bottom-right")
+        expect(Config.get().editInVisualBuilderButton.position).toBe("bottom-right")
         expect(button).toBeInTheDocument();
     });
 

src/visualBuilder/components/startEditingButton.tsx

@@ -4,10 +4,10 @@ import { EditIcon } from "./icons";
 import { visualBuilderStyles } from "../visualBuilder.style";
 import React from "preact/compat";
 import Config from "../../configManager/configManager";
-import { IConfigEditButtonBuilder } from "../../types/types";
+import { IConfigEditInVisualBuilderButton } from "../../types/types";
 
 
-type Position = NonNullable<IConfigEditButtonBuilder['position']>;
+type Position = NonNullable<IConfigEditInVisualBuilderButton['position']>;
 
 const positionStyles: Record<Position, string> = {
     "bottom-right": visualBuilderStyles()['visual-builder__start-editing-btn__bottom-right'],
@@ -27,8 +27,8 @@ export function getEditButtonPosition(position: any): Position {
 
 function StartEditingButtonComponent(): JSX.Element | null {
     const config = Config.get()
-    const enable = config.editButtonBuilder.enable;
-    const position = config.editButtonBuilder.position || "bottom-right";
+    const enable = config.editInVisualBuilderButton.enable;
+    const position = config.editInVisualBuilderButton.position || "bottom-right";
 
     function updateTargetUrl(e: any){
         const targetElement = e.target as HTMLAnchorElement;