feat: v3.2.5 lp sdk

.talismanrc

@@ -5,7 +5,7 @@ fileignoreconfig:
     - filename: README.md
       checksum: 568289bbe7c088967493db246dbf29e465382648ac574c1b1236be57d5662a38
     - filename: CHANGELOG.md
-      checksum: be8ee3f933a1e11d3d3f77339f982f0eca5a76311389d5a20da8645f83194b42
+      checksum: 09ed2613ba45ee13b6dbb4fc178911e93674d4e5c40af026d66266ea172374a4
     - filename: src/visualBuilder/components/__test__/fieldToolbar.test.tsx
       checksum: 3badd6a142456b6a361569e6fc546349a38ac6b366bef7fd5255d1e93220444e
     - filename: src/visualBuilder/components/Collab/ThreadPopup/__test__/CommentTextArea.test.tsx

CHANGELOG.md

@@ -1,13 +1,49 @@
 # Changelog
 
+## [v3.2.5](https://github.com/contentstack/live-preview-sdk/compare/v3.2.4...v3.2.5)
+
+> 9 July 2025
+
+### Fixes
+
+- fix(VE-6459): psuedo-editable height collapse (Faraaz Biyabani - [#451](https://github.com/contentstack/live-preview-sdk/pull/451))
+- fix: start editing button not rendering (Sahil Chalke - [#447](https://github.com/contentstack/live-preview-sdk/pull/447))
+
+### General Changes
+
+- Optimisation: `init` to emit postMessage on `DOMContentLoaded` (Ayush Dubey - [#448](https://github.com/contentstack/live-preview-sdk/pull/448))
+- VE-6559:add isOpenInBuilder utility function and integrate into VisualBuilder components (Sahil Chalke - [#446](https://github.com/contentstack/live-preview-sdk/pull/446))
+
+### New Features
+
+- feat: add isOpenInBuilder utility function and integrate into VisualBuilder components (SahilCs15 - [8e80517](https://github.com/contentstack/live-preview-sdk/commit/8e80517437e979fd143a162cc5b293cabb84e94e))
+
+### Fixes
+
+- fix: extract the overriding function and improve unit tests (Faraaz Biyabani - [e8388d0](https://github.com/contentstack/live-preview-sdk/commit/e8388d05c49464ab3352cd566ca9a1976ff5f6b1))
+- fix: psuedo-editable height collapse (Faraaz Biyabani - [f28d629](https://github.com/contentstack/live-preview-sdk/commit/f28d629d362d5820b8583f748b42bd98d464c180))
+- fix: changed DOM events (csAyushDubey - [8e433b4](https://github.com/contentstack/live-preview-sdk/commit/8e433b41328acefd969ba157d25cf6f6ad5cc351))
+- fix: test fix (csAyushDubey - [af6acf5](https://github.com/contentstack/live-preview-sdk/commit/af6acf5eba9236ba3fb13bb32da8fdade9063d51))
+
+### Chores And Housekeeping
+
+- chore: update README.md to reference ContentstackLivePreview version 3.2.5 (hiteshshetty-dev - [e063d6e](https://github.com/contentstack/live-preview-sdk/commit/e063d6ef8fd95faaef612981f4586b4db66f9e4d))
+
 ## [v3.2.4](https://github.com/contentstack/live-preview-sdk/compare/v3.2.3...v3.2.4)
 
-> 10 June 2025
+> 16 June 2025
 
 ### General Changes
 
+- Release - 12th June (merge `stage_v3`) (Hitesh Shetty - [#445](https://github.com/contentstack/live-preview-sdk/pull/445))
+- Staging develop_v3 (Ayush Dubey - [#444](https://github.com/contentstack/live-preview-sdk/pull/444))
 - Revert 441 revert 439 collab (diwakarmk7 - [#443](https://github.com/contentstack/live-preview-sdk/pull/443))
 
+### Chores And Housekeeping
+
+- chore: talismanrc update (csAyushDubey - [c9c9bda](https://github.com/contentstack/live-preview-sdk/commit/c9c9bda746467c15da4cba9ac22f6428bbc7e1ef))
+- chore: readme update (csAyushDubey - [76bb848](https://github.com/contentstack/live-preview-sdk/commit/76bb84894055450762aa64df0c2a453d0f7782cd))
+
 ### General Changes
 
 - Revert "Revert "Collab"" (diwakarmk7 - [087ab2a](https://github.com/contentstack/live-preview-sdk/commit/087ab2aa818897ce409c61c2472f4b03cbf9762b))

README.md

@@ -16,7 +16,7 @@ Alternatively, if you want to include the package directly in your website HTML
 
 ```html
 <script type='module'  integrity='sha384-b6G+ggU20rGxqCqsgaS6zludFgj5N11xsuXhMEIARMuQY2PtyDS04TU0H5goP+32' crossorigin="anonymous">
-     import ContentstackLivePreview from 'https://esm.sh/@contentstack/live-preview-utils@3.2.4';
+     import ContentstackLivePreview from 'https://esm.sh/@contentstack/live-preview-utils@3.2.5';
 
      ContentstackLivePreview.init({
         stackDetails: {

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@contentstack/live-preview-utils",
-    "version": "3.2.4",
+    "version": "3.2.5",
     "description": "Contentstack provides the Live Preview SDK to establish a communication channel between the various Contentstack SDKs and your website, transmitting  live changes to the preview pane.",
     "type": "module",
     "types": "dist/legacy/index.d.ts",

src/livePreview/__test__/live-preview.test.ts

@@ -460,7 +460,7 @@ describe("testing window event listeners", () => {
         document.body.appendChild(descPara);
         document.body.appendChild(linkPara);
 
-        addEventListenerMock = vi.spyOn(window, "addEventListener");
+        addEventListenerMock = vi.spyOn(document, "addEventListener");
     });
 
     afterEach(() => {
@@ -482,7 +482,7 @@ describe("testing window event listeners", () => {
         livePreviewInstance = new LivePreview();
 
         expect(addEventListenerMock).toBeCalledWith(
-            "load",
+            "DOMContentLoaded",
             expect.any(Function)
         );
         readyState.mockRestore();

src/livePreview/live-preview.ts

@@ -39,10 +39,13 @@ export default class LivePreview {
 
         if (config.enable) {
             if (
-                typeof document !== undefined &&
-                document.readyState === "complete"
+                typeof document !== undefined
             ) {
-                this.requestDataSync();
+                if(document.readyState === "interactive" || document.readyState === "complete"){
+                    this.requestDataSync();
+                } else {
+                    document.addEventListener("DOMContentLoaded", this.requestDataSync);
+                }
             } else {
                 window.addEventListener("load", this.requestDataSync);
             }

src/utils/index.ts

@@ -27,4 +27,13 @@ export function isOpeningInTimeline(): boolean {
         return !!previewTimestamp;
     }
     return false;
-}
+}
+
+export function isOpenInBuilder(): boolean {
+    if (hasWindow()) {
+        const urlParams = new URLSearchParams(window.location.search);
+        const builder = urlParams.get("builder");
+        return !!builder;
+    }
+    return false;
+}

src/visualBuilder/__test__/click/fields/boolean.test.tsx

@@ -60,6 +60,15 @@ vi.mock("../../../utils/visualBuilderPostMessage", async () => {
     };
 });
 
+vi.mock("../../../../utils/index.ts", async () => {
+    const actual = await vi.importActual("../../../../utils");
+    return {
+        __esModule: true,
+        ...actual,
+        isOpenInBuilder: vi.fn().mockReturnValue(true),
+    };
+});
+
 describe("When an element is clicked in visual builder mode", () => {
     let mouseClickEvent: Event;
 
@@ -107,7 +116,10 @@ describe("When an element is clicked in visual builder mode", () => {
             document.body.appendChild(booleanField);
 
             visualBuilder = new VisualBuilder();
-            await triggerAndWaitForClickAction(visualBuilderPostMessage, booleanField);
+            await triggerAndWaitForClickAction(
+                visualBuilderPostMessage,
+                booleanField
+            );
         });
 
         afterAll(() => {
@@ -147,7 +159,6 @@ describe("When an element is clicked in visual builder mode", () => {
         });
 
         test("should send a focus field message to parent", async () => {
-
             await waitFor(() => {
                 expect(visualBuilderPostMessage?.send).toBeCalledWith(
                     VisualBuilderPostMessageEvents.FOCUS_FIELD,

src/visualBuilder/__test__/click/fields/date.test.tsx

@@ -60,6 +60,15 @@ vi.mock("../../../utils/visualBuilderPostMessage", async () => {
     };
 });
 
+vi.mock("../../../../utils/index.ts", async () => {
+    const actual = await vi.importActual("../../../../utils");
+    return {
+        __esModule: true,
+        ...actual,
+        isOpenInBuilder: vi.fn().mockReturnValue(true),
+    };
+});
+
 describe("When an element is clicked in visual builder mode", () => {
     let mouseClickEvent: Event;
 
@@ -107,7 +116,10 @@ describe("When an element is clicked in visual builder mode", () => {
             document.body.appendChild(dateField);
 
             visualBuilder = new VisualBuilder();
-            await triggerAndWaitForClickAction(visualBuilderPostMessage, dateField);
+            await triggerAndWaitForClickAction(
+                visualBuilderPostMessage,
+                dateField
+            );
         });
 
         afterAll(() => {

src/visualBuilder/__test__/click/fields/file.test.tsx

@@ -49,6 +49,15 @@ vi.mock("../../../utils/visualBuilderPostMessage", async () => {
     };
 });
 
+vi.mock("../../../../utils/index.ts", async () => {
+    const actual = await vi.importActual("../../../../utils");
+    return {
+        __esModule: true,
+        ...actual,
+        isOpenInBuilder: vi.fn().mockReturnValue(true),
+    };
+});
+
 describe("When an element is clicked in visual builder mode", () => {
     let mouseClickEvent: Event;
 
@@ -105,7 +114,10 @@ describe("When an element is clicked in visual builder mode", () => {
             document.body.appendChild(fileField);
             document.body.appendChild(imageField);
             visualBuilder = new VisualBuilder();
-            await triggerAndWaitForClickAction(visualBuilderPostMessage, fileField);
+            await triggerAndWaitForClickAction(
+                visualBuilderPostMessage,
+                fileField
+            );
         });
 
         afterAll(() => {
@@ -202,7 +214,10 @@ describe("When an element is clicked in visual builder mode", () => {
             document.body.appendChild(container);
 
             visualBuilder = new VisualBuilder();
-            await triggerAndWaitForClickAction(visualBuilderPostMessage, container);
+            await triggerAndWaitForClickAction(
+                visualBuilderPostMessage,
+                container
+            );
         });
 
         afterAll(() => {

src/visualBuilder/__test__/click/fields/group.test.tsx

@@ -49,6 +49,15 @@ vi.mock("../../../utils/visualBuilderPostMessage", async () => {
     };
 });
 
+vi.mock("../../../../utils/index.ts", async () => {
+    const actual = await vi.importActual("../../../../utils");
+    return {
+        __esModule: true,
+        ...actual,
+        isOpenInBuilder: vi.fn().mockReturnValue(true),
+    };
+});
+
 describe("When an element is clicked in visual builder mode", () => {
     let mouseClickEvent: Event;
 
@@ -98,7 +107,10 @@ describe("When an element is clicked in visual builder mode", () => {
             document.body.appendChild(groupField);
 
             visualBuilder = new VisualBuilder();
-            await triggerAndWaitForClickAction(visualBuilderPostMessage, groupField);
+            await triggerAndWaitForClickAction(
+                visualBuilderPostMessage,
+                groupField
+            );
         });
 
         afterAll(() => {
@@ -190,7 +202,10 @@ describe("When an element is clicked in visual builder mode", () => {
             document.body.appendChild(container);
 
             visualBuilder = new VisualBuilder();
-            await triggerAndWaitForClickAction(visualBuilderPostMessage, container);
+            await triggerAndWaitForClickAction(
+                visualBuilderPostMessage,
+                container
+            );
         });
 
         afterAll(() => {

src/visualBuilder/__test__/click/fields/html-rte.test.tsx

@@ -49,6 +49,15 @@ vi.mock("../../../utils/visualBuilderPostMessage", async () => {
     };
 });
 
+vi.mock("../../../../utils/index.ts", async () => {
+    const actual = await vi.importActual("../../../../utils");
+    return {
+        __esModule: true,
+        ...actual,
+        isOpenInBuilder: vi.fn().mockReturnValue(true),
+    };
+});
+
 describe("When an element is clicked in visual builder mode", () => {
     let mouseClickEvent: Event;
 
@@ -96,7 +105,10 @@ describe("When an element is clicked in visual builder mode", () => {
             );
             document.body.appendChild(htmlRteField);
             visualBuilder = new VisualBuilder();
-            await triggerAndWaitForClickAction(visualBuilderPostMessage, htmlRteField)
+            await triggerAndWaitForClickAction(
+                visualBuilderPostMessage,
+                htmlRteField
+            );
         });
 
         afterAll(() => {
@@ -177,7 +189,10 @@ describe("When an element is clicked in visual builder mode", () => {
             document.body.appendChild(container);
 
             visualBuilder = new VisualBuilder();
-            await triggerAndWaitForClickAction(visualBuilderPostMessage, container);
+            await triggerAndWaitForClickAction(
+                visualBuilderPostMessage,
+                container
+            );
         });
         afterAll(() => {
             visualBuilder.destroy();

src/visualBuilder/__test__/click/fields/json-rte.test.tsx

@@ -49,6 +49,15 @@ vi.mock("../../../utils/visualBuilderPostMessage", async () => {
     };
 });
 
+vi.mock("../../../../utils/index.ts", async () => {
+    const actual = await vi.importActual("../../../../utils");
+    return {
+        __esModule: true,
+        ...actual,
+        isOpenInBuilder: vi.fn().mockReturnValue(true),
+    };
+});
+
 describe("When an element is clicked in visual builder mode", () => {
     let mouseClickEvent: Event;
 
@@ -97,7 +106,10 @@ describe("When an element is clicked in visual builder mode", () => {
             document.body.appendChild(jsonRteField);
             visualBuilder = new VisualBuilder();
 
-            await triggerAndWaitForClickAction(visualBuilderPostMessage, jsonRteField);
+            await triggerAndWaitForClickAction(
+                visualBuilderPostMessage,
+                jsonRteField
+            );
         });
 
         afterAll(() => {
@@ -178,7 +190,10 @@ describe("When an element is clicked in visual builder mode", () => {
             document.body.appendChild(container);
 
             visualBuilder = new VisualBuilder();
-            await triggerAndWaitForClickAction(visualBuilderPostMessage, container);
+            await triggerAndWaitForClickAction(
+                visualBuilderPostMessage,
+                container
+            );
         });
 
         afterAll(() => {