Merge pull request #606 from contentstack/develop_v4

Develop v4

Author: kirtesh-cstk

src/common/inIframe.ts

@@ -8,6 +8,14 @@ export function inIframe(): boolean {
     }
 }
 
+export function inVisualEditor(): boolean{
+    try {
+        return inIframe() && window?.name == 'visual-editor'
+    } catch (e) {
+        return false;
+    }
+}
+
 export function isOpeningInNewTab(): boolean {
     try {
         if(hasWindow()) {

src/configManager/__test__/configManager.test.ts

@@ -1,4 +1,4 @@
-import Config, { updateConfigFromUrl } from "../configManager";
+import Config, { updateConfigFromUrl, syncToStackSdk } from "../configManager";
 import { getDefaultConfig, getUserInitData } from "../config.default";
 import { DeepSignal } from "deepsignal";
 import { IConfig } from "../../types/types";
@@ -102,6 +102,73 @@ describe("config default flags", () => {
     });
 });
 
+describe("syncToStackSdk", () => {
+    beforeEach(() => {
+        Config.reset();
+    });
+
+    afterAll(() => {
+        Config.reset();
+    });
+
+    test("should set hash, stackSdkLivePreview.hash and stackSdkLivePreview.live_preview when hash is provided", () => {
+        syncToStackSdk({ hash: "abc123" });
+
+        const config = Config.get();
+        expect(config.stackSdk.live_preview.hash).toBe("abc123");
+        expect(config.stackSdk.live_preview.live_preview).toBe("abc123");
+        expect(config.stackSdk.live_preview.content_type_uid).toBeUndefined();
+        expect(config.stackSdk.live_preview.entry_uid).toBeUndefined();
+    });
+
+    test("should set content_type_uid on stackSdk when contentTypeUid is provided", () => {
+        syncToStackSdk({ contentTypeUid: "blog" });
+
+        const config = Config.get();
+        expect(config.stackSdk.live_preview.content_type_uid).toBe("blog");
+        expect(config.stackSdk.live_preview.hash).toBeUndefined();
+        expect(config.stackSdk.live_preview.entry_uid).toBeUndefined();
+    });
+
+    test("should set entry_uid on stackSdk when entryUid is provided", () => {
+        syncToStackSdk({ entryUid: "entry-42" });
+
+        const config = Config.get();
+        expect(config.stackSdk.live_preview.entry_uid).toBe("entry-42");
+        expect(config.stackSdk.live_preview.hash).toBeUndefined();
+        expect(config.stackSdk.live_preview.content_type_uid).toBeUndefined();
+    });
+
+    test("should set all three fields when all params are provided", () => {
+        syncToStackSdk({ hash: "h1", contentTypeUid: "page", entryUid: "e1" });
+
+        const config = Config.get();
+        expect(config.stackSdk.live_preview.hash).toBe("h1");
+        expect(config.stackSdk.live_preview.live_preview).toBe("h1");
+        expect(config.stackSdk.live_preview.content_type_uid).toBe("page");
+        expect(config.stackSdk.live_preview.entry_uid).toBe("e1");
+    });
+
+    test("should skip falsy values — null and undefined are ignored", () => {
+        syncToStackSdk({ hash: null, contentTypeUid: undefined, entryUid: null });
+
+        const config = Config.get();
+        expect(config.stackSdk.live_preview.hash).toBeUndefined();
+        expect(config.stackSdk.live_preview.content_type_uid).toBeUndefined();
+        expect(config.stackSdk.live_preview.entry_uid).toBeUndefined();
+    });
+
+    test("should not overwrite existing stackSdk values for keys not passed", () => {
+        syncToStackSdk({ hash: "first", contentTypeUid: "ct1", entryUid: "e1" });
+        syncToStackSdk({ hash: "second" });
+
+        const config = Config.get();
+        expect(config.stackSdk.live_preview.hash).toBe("second");
+        expect(config.stackSdk.live_preview.content_type_uid).toBe("ct1");
+        expect(config.stackSdk.live_preview.entry_uid).toBe("e1");
+    });
+});
+
 describe("update config from url", () => {
     let config: DeepSignal<IConfig>;
 

src/configManager/config.default.ts

@@ -118,5 +118,6 @@ export function getDefaultConfig(): IConfig {
             payload: [],
         },
         enableLivePreviewOutsideIframe: undefined,
+        pageContext: null,
     };
 }

src/configManager/configManager.ts

@@ -73,22 +73,50 @@ export function setConfigFromParams(
     const content_type_uid = urlParams.get("content_type_uid");
     const entry_uid = urlParams.get("entry_uid");
 
-    const stackSdkLivePreview = Config.get().stackSdk.live_preview;
-
     if (live_preview) {
         Config.set("hash", live_preview);
-        stackSdkLivePreview.hash = live_preview;
-        stackSdkLivePreview.live_preview = live_preview;
     }
 
     if (content_type_uid) {
         Config.set("stackDetails.contentTypeUid", content_type_uid);
-        stackSdkLivePreview.content_type_uid = content_type_uid;
     }
 
     if (entry_uid) {
         Config.set("stackDetails.entryUid", entry_uid);
-        stackSdkLivePreview.entry_uid = entry_uid;
+    }
+
+    syncToStackSdk({
+        hash: live_preview,
+        contentTypeUid: content_type_uid,
+        entryUid: entry_uid,
+    });
+}
+
+/**
+ * Syncs hash, contentTypeUid, and entryUid into the user's stackSdk.live_preview object.
+ * Auto-effects via deepsignal were ruled out because Config.reset() replaces the deepSignal
+ * instance, which would blind any bound effect. Explicit sync is the safe alternative.
+ */
+export function syncToStackSdk({
+    hash,
+    contentTypeUid,
+    entryUid,
+}: {
+    hash?: string | null;
+    contentTypeUid?: string | null;
+    entryUid?: string | null;
+}): void {
+    const stackSdkLivePreview = Config.get().stackSdk.live_preview;
+
+    if (hash) {
+        stackSdkLivePreview.hash = hash;
+        stackSdkLivePreview.live_preview = hash;
+    }
+    if (contentTypeUid) {
+        stackSdkLivePreview.content_type_uid = contentTypeUid;
+    }
+    if (entryUid) {
+        stackSdkLivePreview.entry_uid = entryUid;
     }
 
     Config.set("stackSdk.live_preview", stackSdkLivePreview);