@contentstack/live-preview-utils 2.0.3 → 3.0.0

package/dist/legacy/livePreview/removeFromOnChangeSubscribers.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/livePreview/removeFromOnChangeSubscribers.ts"],"sourcesContent":["import { PublicLogger } from \"../logger/logger\";\nimport {\n    OnEntryChangeCallbackUID,\n    OnEntryChangeCallback,\n} from \"./types/onEntryChangeCallback.type\";\n\nexport function removeFromOnChangeSubscribers(\n    callbackStack: {\n        [callbackUid: OnEntryChangeCallbackUID]: OnEntryChangeCallback;\n    },\n    callback: OnEntryChangeCallbackUID | OnEntryChangeCallback\n): void {\n    if (typeof callback === \"string\") {\n        if (!callbackStack[callback]) {\n            PublicLogger.warn(\"No subscriber found with the given id.\");\n        }\n        delete callbackStack[callback];\n    } else if (typeof callback === \"function\") {\n        const isCallbackDeleted = Object.entries<() => void>(\n            callbackStack\n        ).some(([uid, func]) => {\n            if (func === callback) {\n                delete callbackStack[uid];\n                return true;\n            }\n            return false;\n        });\n\n        if (!isCallbackDeleted) {\n            PublicLogger.warn(\"No subscriber found with the given callback.\");\n        }\n    }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAA6B;AAMtB,SAAS,8BACZ,eAGA,UACI;AACJ,MAAI,OAAO,aAAa,UAAU;AAC9B,QAAI,CAAC,cAAc,QAAQ,GAAG;AAC1B,iCAAa,KAAK,wCAAwC;AAAA,IAC9D;AACA,WAAO,cAAc,QAAQ;AAAA,EACjC,WAAW,OAAO,aAAa,YAAY;AACvC,UAAM,oBAAoB,OAAO;AAAA,MAC7B;AAAA,IACJ,EAAE,KAAK,CAAC,CAAC,KAAK,IAAI,MAAM;AACpB,UAAI,SAAS,UAAU;AACnB,eAAO,cAAc,GAAG;AACxB,eAAO;AAAA,MACX;AACA,aAAO;AAAA,IACX,CAAC;AAED,QAAI,CAAC,mBAAmB;AACpB,iCAAa,KAAK,8CAA8C;AAAA,IACpE;AAAA,EACJ;AACJ;","names":[]}

package/dist/legacy/livePreview/removeFromOnChangeSubscribers.d.cts

@@ -0,0 +1,7 @@
+import { OnEntryChangeCallback, OnEntryChangeCallbackUID } from './types/onEntryChangeCallback.type.cjs';
+
+declare function removeFromOnChangeSubscribers(callbackStack: {
+    [callbackUid: OnEntryChangeCallbackUID]: OnEntryChangeCallback;
+}, callback: OnEntryChangeCallbackUID | OnEntryChangeCallback): void;
+
+export { removeFromOnChangeSubscribers };

package/dist/legacy/livePreview/removeFromOnChangeSubscribers.d.ts

@@ -0,0 +1,7 @@
+import { OnEntryChangeCallback, OnEntryChangeCallbackUID } from './types/onEntryChangeCallback.type.js';
+
+declare function removeFromOnChangeSubscribers(callbackStack: {
+    [callbackUid: OnEntryChangeCallbackUID]: OnEntryChangeCallback;
+}, callback: OnEntryChangeCallbackUID | OnEntryChangeCallback): void;
+
+export { removeFromOnChangeSubscribers };

package/dist/legacy/livePreview/removeFromOnChangeSubscribers.js

@@ -0,0 +1,29 @@
+import "../chunk-5WRI5ZAA.js";
+
+// src/livePreview/removeFromOnChangeSubscribers.ts
+import { PublicLogger } from "../logger/logger.js";
+function removeFromOnChangeSubscribers(callbackStack, callback) {
+  if (typeof callback === "string") {
+    if (!callbackStack[callback]) {
+      PublicLogger.warn("No subscriber found with the given id.");
+    }
+    delete callbackStack[callback];
+  } else if (typeof callback === "function") {
+    const isCallbackDeleted = Object.entries(
+      callbackStack
+    ).some(([uid, func]) => {
+      if (func === callback) {
+        delete callbackStack[uid];
+        return true;
+      }
+      return false;
+    });
+    if (!isCallbackDeleted) {
+      PublicLogger.warn("No subscriber found with the given callback.");
+    }
+  }
+}
+export {
+  removeFromOnChangeSubscribers
+};
+//# sourceMappingURL=removeFromOnChangeSubscribers.js.map

package/dist/legacy/livePreview/removeFromOnChangeSubscribers.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/livePreview/removeFromOnChangeSubscribers.ts"],"sourcesContent":["import { PublicLogger } from \"../logger/logger\";\nimport {\n    OnEntryChangeCallbackUID,\n    OnEntryChangeCallback,\n} from \"./types/onEntryChangeCallback.type\";\n\nexport function removeFromOnChangeSubscribers(\n    callbackStack: {\n        [callbackUid: OnEntryChangeCallbackUID]: OnEntryChangeCallback;\n    },\n    callback: OnEntryChangeCallbackUID | OnEntryChangeCallback\n): void {\n    if (typeof callback === \"string\") {\n        if (!callbackStack[callback]) {\n            PublicLogger.warn(\"No subscriber found with the given id.\");\n        }\n        delete callbackStack[callback];\n    } else if (typeof callback === \"function\") {\n        const isCallbackDeleted = Object.entries<() => void>(\n            callbackStack\n        ).some(([uid, func]) => {\n            if (func === callback) {\n                delete callbackStack[uid];\n                return true;\n            }\n            return false;\n        });\n\n        if (!isCallbackDeleted) {\n            PublicLogger.warn(\"No subscriber found with the given callback.\");\n        }\n    }\n}\n"],"mappings":";;;AAAA,SAAS,oBAAoB;AAMtB,SAAS,8BACZ,eAGA,UACI;AACJ,MAAI,OAAO,aAAa,UAAU;AAC9B,QAAI,CAAC,cAAc,QAAQ,GAAG;AAC1B,mBAAa,KAAK,wCAAwC;AAAA,IAC9D;AACA,WAAO,cAAc,QAAQ;AAAA,EACjC,WAAW,OAAO,aAAa,YAAY;AACvC,UAAM,oBAAoB,OAAO;AAAA,MAC7B;AAAA,IACJ,EAAE,KAAK,CAAC,CAAC,KAAK,IAAI,MAAM;AACpB,UAAI,SAAS,UAAU;AACnB,eAAO,cAAc,GAAG;AACxB,eAAO;AAAA,MACX;AACA,aAAO;AAAA,IACX,CAAC;AAED,QAAI,CAAC,mBAAmB;AACpB,mBAAa,KAAK,8CAA8C;AAAA,IACpE;AAAA,EACJ;AACJ;","names":[]}

package/dist/legacy/livePreview/types/onEntryChangeCallback.type.cjs

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/livePreview/types/onEntryChangeCallback.type.ts
+var onEntryChangeCallback_type_exports = {};
+module.exports = __toCommonJS(onEntryChangeCallback_type_exports);
+//# sourceMappingURL=onEntryChangeCallback.type.cjs.map

package/dist/legacy/livePreview/types/onEntryChangeCallback.type.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/livePreview/types/onEntryChangeCallback.type.ts"],"sourcesContent":["export declare type OnEntryChangeCallback = () => void;\n\nexport declare type OnEntryChangeConfig = {\n    skipInitialRender?: boolean;\n};\n\nexport declare type OnEntryChangeCallbackUID = string;\n\nexport type OnEntryChangeCallbackSubscribers = Record<\n    OnEntryChangeCallbackUID,\n    OnEntryChangeCallback\n>;\n\nexport type OnEntryChangeUnsubscribeParameters =\n    | OnEntryChangeCallbackUID\n    | OnEntryChangeCallback;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/legacy/livePreview/types/onEntryChangeCallback.type.d.cts

@@ -0,0 +1,9 @@
+declare type OnEntryChangeCallback = () => void;
+declare type OnEntryChangeConfig = {
+    skipInitialRender?: boolean;
+};
+declare type OnEntryChangeCallbackUID = string;
+type OnEntryChangeCallbackSubscribers = Record<OnEntryChangeCallbackUID, OnEntryChangeCallback>;
+type OnEntryChangeUnsubscribeParameters = OnEntryChangeCallbackUID | OnEntryChangeCallback;
+
+export type { OnEntryChangeCallback, OnEntryChangeCallbackSubscribers, OnEntryChangeCallbackUID, OnEntryChangeConfig, OnEntryChangeUnsubscribeParameters };

package/dist/legacy/livePreview/types/onEntryChangeCallback.type.d.ts

@@ -0,0 +1,9 @@
+declare type OnEntryChangeCallback = () => void;
+declare type OnEntryChangeConfig = {
+    skipInitialRender?: boolean;
+};
+declare type OnEntryChangeCallbackUID = string;
+type OnEntryChangeCallbackSubscribers = Record<OnEntryChangeCallbackUID, OnEntryChangeCallback>;
+type OnEntryChangeUnsubscribeParameters = OnEntryChangeCallbackUID | OnEntryChangeCallback;
+
+export type { OnEntryChangeCallback, OnEntryChangeCallbackSubscribers, OnEntryChangeCallbackUID, OnEntryChangeConfig, OnEntryChangeUnsubscribeParameters };

package/dist/legacy/livePreview/types/onEntryChangeCallback.type.js

@@ -0,0 +1 @@
+//# sourceMappingURL=onEntryChangeCallback.type.js.map

package/dist/legacy/livePreview/types/onEntryChangeCallback.type.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/{modern/utils/public-logger.cjs → legacy/logger/logger.cjs}

@@ -17,15 +17,16 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// src/utils/public-logger.ts
-var public_logger_exports = {};
-__export(public_logger_exports, {
+// src/logger/logger.ts
+var logger_exports = {};
+__export(logger_exports, {
   PublicLogger: () => PublicLogger
 });
-module.exports = __toCommonJS(public_logger_exports);
+module.exports = __toCommonJS(logger_exports);
 var PublicLogger = class {
   static logEvent(logCallback, message) {
-    if (process.env.NODE_ENV !== "test") {
+    var _a;
+    if (((_a = process == null ? void 0 : process.env) == null ? void 0 : _a.NODE_ENV) !== "test") {
       logCallback("Live_Preview_SDK:", ...message);
     }
   }
@@ -43,4 +44,4 @@ var PublicLogger = class {
 0 && (module.exports = {
   PublicLogger
 });
-//# sourceMappingURL=public-logger.cjs.map
+//# sourceMappingURL=logger.cjs.map

package/dist/legacy/logger/logger.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/logger/logger.ts"],"sourcesContent":["export class PublicLogger {\n    private static logEvent(\n        logCallback:\n            | Console[\"log\"]\n            | Console[\"warn\"]\n            | Console[\"error\"]\n            | Console[\"debug\"]\n            | Console[\"info\"],\n        message: any[]\n    ): void {\n        if (process?.env?.NODE_ENV !== \"test\") {\n            logCallback(\"Live_Preview_SDK:\", ...message);\n        }\n    }\n\n    public static error(...data: any[]): void {\n        this.logEvent(console.error, data);\n    }\n\n    public static warn(...data: any[]): void {\n        this.logEvent(console.warn, data);\n    }\n\n    public static debug(...data: any[]): void {\n        this.logEvent(console.debug, data);\n    }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAO,IAAM,eAAN,MAAmB;AAAA,EACtB,OAAe,SACX,aAMA,SACI;AATZ;AAUQ,UAAI,wCAAS,QAAT,mBAAc,cAAa,QAAQ;AACnC,kBAAY,qBAAqB,GAAG,OAAO;AAAA,IAC/C;AAAA,EACJ;AAAA,EAEA,OAAc,SAAS,MAAmB;AACtC,SAAK,SAAS,QAAQ,OAAO,IAAI;AAAA,EACrC;AAAA,EAEA,OAAc,QAAQ,MAAmB;AACrC,SAAK,SAAS,QAAQ,MAAM,IAAI;AAAA,EACpC;AAAA,EAEA,OAAc,SAAS,MAAmB;AACtC,SAAK,SAAS,QAAQ,OAAO,IAAI;AAAA,EACrC;AACJ;","names":[]}

package/dist/{modern/utils/public-logger.js → legacy/logger/logger.js}

@@ -1,7 +1,10 @@
-// src/utils/public-logger.ts
+import "../chunk-5WRI5ZAA.js";
+
+// src/logger/logger.ts
 var PublicLogger = class {
   static logEvent(logCallback, message) {
-    if (process.env.NODE_ENV !== "test") {
+    var _a;
+    if (((_a = process == null ? void 0 : process.env) == null ? void 0 : _a.NODE_ENV) !== "test") {
       logCallback("Live_Preview_SDK:", ...message);
     }
   }
@@ -18,4 +21,4 @@ var PublicLogger = class {
 export {
   PublicLogger
 };
-//# sourceMappingURL=public-logger.js.map
+//# sourceMappingURL=logger.js.map

package/dist/legacy/logger/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/logger/logger.ts"],"sourcesContent":["export class PublicLogger {\n    private static logEvent(\n        logCallback:\n            | Console[\"log\"]\n            | Console[\"warn\"]\n            | Console[\"error\"]\n            | Console[\"debug\"]\n            | Console[\"info\"],\n        message: any[]\n    ): void {\n        if (process?.env?.NODE_ENV !== \"test\") {\n            logCallback(\"Live_Preview_SDK:\", ...message);\n        }\n    }\n\n    public static error(...data: any[]): void {\n        this.logEvent(console.error, data);\n    }\n\n    public static warn(...data: any[]): void {\n        this.logEvent(console.warn, data);\n    }\n\n    public static debug(...data: any[]): void {\n        this.logEvent(console.debug, data);\n    }\n}\n"],"mappings":";;;AAAO,IAAM,eAAN,MAAmB;AAAA,EACtB,OAAe,SACX,aAMA,SACI;AATZ;AAUQ,UAAI,wCAAS,QAAT,mBAAc,cAAa,QAAQ;AACnC,kBAAY,qBAAqB,GAAG,OAAO;AAAA,IAC/C;AAAA,EACJ;AAAA,EAEA,OAAc,SAAS,MAAmB;AACtC,SAAK,SAAS,QAAQ,OAAO,IAAI;AAAA,EACrC;AAAA,EAEA,OAAc,QAAQ,MAAmB;AACrC,SAAK,SAAS,QAAQ,MAAM,IAAI;AAAA,EACpC;AAAA,EAEA,OAAc,SAAS,MAAmB;AACtC,SAAK,SAAS,QAAQ,OAAO,IAAI;AAAA,EACrC;AACJ;","names":[]}

package/dist/legacy/preview/contentstack-live-preview-HOC.cjs

@@ -0,0 +1,217 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/preview/contentstack-live-preview-HOC.ts
+var contentstack_live_preview_HOC_exports = {};
+__export(contentstack_live_preview_HOC_exports, {
+  default: () => contentstack_live_preview_HOC_default
+});
+module.exports = __toCommonJS(contentstack_live_preview_HOC_exports);
+var import_uuid = require("uuid");
+var import_lodash_es = require("lodash-es");
+var import_config = require("../configManager/config.default.cjs");
+var import_configManager = __toESM(require("../configManager/configManager.cjs"), 1);
+var import_visualBuilder = require("../visualBuilder/index.cjs");
+var import_live_preview = __toESM(require("../livePreview/live-preview.cjs"), 1);
+var import_removeFromOnChangeSubscribers = require("../livePreview/removeFromOnChangeSubscribers.cjs");
+var import_logger = require("../logger/logger.cjs");
+var import_onPageTraversal = require("../livePreview/onPageTraversal.cjs");
+var import_compare = require("../timeline/compare/compare.cjs");
+var _ContentstackLivePreview = class _ContentstackLivePreview {
+  /**
+   * Initializes the Live Preview SDK with the provided user configuration.
+   * If the SDK is already initialized, subsequent calls to this method will return the existing SDK instance.
+   * @param userConfig - The user configuration to initialize the SDK with. See {@link https://github.com/contentstack/live-preview-sdk/blob/main/docs/live-preview-configs.md#initconfig-iconfig|Live preview User config} for more details.
+   * @returns A promise that resolves to the constructors of the Live Preview SDK.
+   */
+  static init(userConfig = (0, import_config.getUserInitData)()) {
+    if (typeof window === "undefined") {
+      import_logger.PublicLogger.warn("The SDK is not initialized in the browser.");
+      return Promise.resolve(_ContentstackLivePreview.previewConstructors);
+    }
+    import_configManager.default.replace(userConfig);
+    (0, import_configManager.updateConfigFromUrl)();
+    if (_ContentstackLivePreview.isInitialized()) {
+      import_logger.PublicLogger.warn(
+        "You have already initialized the Live Preview SDK. So, any subsequent initialization returns the existing SDK instance."
+      );
+      return Promise.resolve(_ContentstackLivePreview.previewConstructors);
+    } else {
+      return _ContentstackLivePreview.initializePreview();
+    }
+  }
+  /**
+   * It is the live preview hash.
+   * This hash could be used when data is fetched manually.
+   */
+  static get hash() {
+    if (!_ContentstackLivePreview.isInitialized()) {
+      (0, import_configManager.updateConfigFromUrl)();
+    }
+    return import_configManager.default.get().hash;
+  }
+  static isInitialized() {
+    return !(0, import_lodash_es.isEmpty)(_ContentstackLivePreview.previewConstructors);
+  }
+  static initializePreview() {
+    _ContentstackLivePreview.previewConstructors = {
+      livePreview: new import_live_preview.default(),
+      visualBuilder: new import_visualBuilder.VisualBuilder()
+    };
+    const livePreview = _ContentstackLivePreview.previewConstructors.livePreview;
+    Object.entries(_ContentstackLivePreview.onEntryChangeCallbacks).forEach(
+      ([callbackUid, callback]) => {
+        livePreview.subscribeToOnEntryChange(callback, callbackUid);
+      }
+    );
+    _ContentstackLivePreview.onEntryChangeCallbacks = {};
+    (0, import_onPageTraversal.handlePageTraversal)();
+    (0, import_compare.handleWebCompare)();
+    return Promise.resolve(_ContentstackLivePreview.previewConstructors);
+  }
+  /**
+   * Registers a callback function to be called when an entry changes.
+   * @param onChangeCallback The callback function to be called when an entry changes.
+   * @param config Optional configuration for the callback.
+   * @param config.skipInitialRender If true, the callback will not be called when it is first registered.
+   * @returns A unique identifier for the registered callback.
+   *
+   * @example
+   * ```js
+   * const callbackUid = ContentstackLivePreview.onEntryChange(() => {
+   *    console.log("Entry changed");
+   * });
+   *
+   * // Unsubscribe the callback
+   * ContentstackLivePreview.unsubscribeOnEntryChange(callbackUid);
+   * ```
+   */
+  static onEntryChange(onChangeCallback, config = {}) {
+    const { skipInitialRender = false } = config;
+    const callbackUid = (0, import_uuid.v4)();
+    if (_ContentstackLivePreview.isInitialized()) {
+      _ContentstackLivePreview.previewConstructors.livePreview.subscribeToOnEntryChange(
+        onChangeCallback,
+        callbackUid
+      );
+    } else {
+      _ContentstackLivePreview.onEntryChangeCallbacks[callbackUid] = onChangeCallback;
+    }
+    if (!skipInitialRender) {
+      onChangeCallback();
+    }
+    return callbackUid;
+  }
+  /**
+   * Registers a callback function to be called when there is a change in the entry being edited in live preview mode. The difference between this and `onEntryChange` is that this callback will not be called when it is first registered.
+   * @param onChangeCallback The callback function to be called when there is a change in the entry.
+   * @returns A unique identifier for the registered callback.
+   *
+   * @example
+   * ```js
+   * const callbackUid = ContentstackLivePreview.onLiveEdit(() => {
+   *   console.log("Entry changed");
+   * });
+   *
+   * // Unsubscribe the callback
+   * ContentstackLivePreview.unsubscribeOnEntryChange(callbackUid);
+   * ```
+   *
+   */
+  static onLiveEdit(onChangeCallback) {
+    return _ContentstackLivePreview.onEntryChange(onChangeCallback, {
+      skipInitialRender: true
+    });
+  }
+  /**
+   * Unsubscribes from the entry change event.
+   * @param callback - The callback function to be unsubscribed.
+   *
+   * @example
+   * ```js
+   * // unsubscribing using the Callback UID
+   * const callbackUid = ContentstackLivePreview.onEntryChange(() => {
+   *  console.log("Entry changed");
+   * });
+   *
+   * // Unsubscribe the callback
+   * ContentstackLivePreview.unsubscribeOnEntryChange(callbackUid);
+   * ```
+   *
+   * @example
+   * ```js
+   * // unsubscribing using the callback function
+   * const callback = () => {console.log("Entry changed")};
+   * ContentstackLivePreview.onEntryChange(callback);
+   *
+   * // Unsubscribe the callback
+   * ContentstackLivePreview.unsubscribeOnEntryChange(callback);
+   * ```
+   *
+   * @example
+   * ```js
+   * // The same is applicable to onLiveEdit
+   * const callbackUid = ContentstackLivePreview.onLiveEdit(() => {
+   * console.log("Entry changed");
+   * });
+   *
+   * // Unsubscribe the callback
+   * ContentstackLivePreview.unsubscribeOnEntryChange(callbackUid);
+   * ```
+   *
+   *
+   */
+  static unsubscribeOnEntryChange(callback) {
+    if (!_ContentstackLivePreview.isInitialized()) {
+      (0, import_removeFromOnChangeSubscribers.removeFromOnChangeSubscribers)(
+        _ContentstackLivePreview.onEntryChangeCallbacks,
+        callback
+      );
+      return;
+    }
+    _ContentstackLivePreview.previewConstructors.livePreview.unsubscribeOnEntryChange(
+      callback
+    );
+  }
+  /**
+   * Retrieves the version of the SDK.
+   * @returns The version of the SDK as a string.
+   */
+  static getSdkVersion() {
+    return "3.0.0";
+  }
+};
+_ContentstackLivePreview.previewConstructors = {};
+/**
+ * The subscribers for the onEntryChange event. We store them here when the SDK is not initialized.
+ */
+_ContentstackLivePreview.onEntryChangeCallbacks = {};
+var ContentstackLivePreview = _ContentstackLivePreview;
+var contentstack_live_preview_HOC_default = ContentstackLivePreview;
+//# sourceMappingURL=contentstack-live-preview-HOC.cjs.map

package/dist/legacy/preview/contentstack-live-preview-HOC.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/preview/contentstack-live-preview-HOC.ts"],"sourcesContent":["import { v4 as uuidv4 } from \"uuid\";\n\nimport { isEmpty } from \"lodash-es\";\nimport { getUserInitData } from \"../configManager/config.default\";\nimport Config, { updateConfigFromUrl } from \"../configManager/configManager\";\nimport { VisualBuilder } from \"../visualBuilder\";\nimport LivePreview from \"../livePreview/live-preview\";\nimport { removeFromOnChangeSubscribers } from \"../livePreview/removeFromOnChangeSubscribers\";\nimport {\n    OnEntryChangeCallback,\n    OnEntryChangeCallbackSubscribers,\n    OnEntryChangeCallbackUID,\n    OnEntryChangeConfig,\n    OnEntryChangeUnsubscribeParameters,\n} from \"../livePreview/types/onEntryChangeCallback.type\";\nimport { PublicLogger } from \"../logger/logger\";\nimport type { IInitData } from \"../types/types\";\nimport { handlePageTraversal } from \"../livePreview/onPageTraversal\";\nimport { handleWebCompare } from \"../timeline/compare/compare\";\n\nclass ContentstackLivePreview {\n    private static previewConstructors:\n        | {\n              livePreview: LivePreview;\n              visualBuilder: VisualBuilder;\n          }\n        | Record<string, never> = {};\n\n    /**\n     * The subscribers for the onEntryChange event. We store them here when the SDK is not initialized.\n     */\n    private static onEntryChangeCallbacks: OnEntryChangeCallbackSubscribers =\n        {};\n\n    /**\n     * Initializes the Live Preview SDK with the provided user configuration.\n     * If the SDK is already initialized, subsequent calls to this method will return the existing SDK instance.\n     * @param userConfig - The user configuration to initialize the SDK with. See {@link https://github.com/contentstack/live-preview-sdk/blob/main/docs/live-preview-configs.md#initconfig-iconfig|Live preview User config} for more details.\n     * @returns A promise that resolves to the constructors of the Live Preview SDK.\n     */\n    static init(\n        userConfig: Partial<IInitData> = getUserInitData()\n    ): Promise<typeof ContentstackLivePreview.previewConstructors> {\n        if (typeof window === \"undefined\") {\n            PublicLogger.warn(\"The SDK is not initialized in the browser.\");\n            return Promise.resolve(ContentstackLivePreview.previewConstructors);\n        }\n\n        // handle user config\n        Config.replace(userConfig);\n        updateConfigFromUrl();\n\n        if (ContentstackLivePreview.isInitialized()) {\n            PublicLogger.warn(\n                \"You have already initialized the Live Preview SDK. So, any subsequent initialization returns the existing SDK instance.\"\n            );\n            return Promise.resolve(ContentstackLivePreview.previewConstructors);\n        } else {\n            return ContentstackLivePreview.initializePreview();\n        }\n    }\n\n    /**\n     * It is the live preview hash.\n     * This hash could be used when data is fetched manually.\n     */\n    static get hash(): string {\n        if (!ContentstackLivePreview.isInitialized()) {\n            updateConfigFromUrl(); // check if we could extract from the URL\n        }\n        return Config.get().hash;\n    }\n\n    private static isInitialized(): boolean {\n        return !isEmpty(ContentstackLivePreview.previewConstructors);\n    }\n\n    private static initializePreview() {\n        ContentstackLivePreview.previewConstructors = {\n            livePreview: new LivePreview(),\n            visualBuilder: new VisualBuilder(),\n        };\n\n        // set up onEntryChange callbacks added when the SDK was not initialized\n        const livePreview =\n            ContentstackLivePreview.previewConstructors.livePreview;\n        Object.entries(ContentstackLivePreview.onEntryChangeCallbacks).forEach(\n            ([callbackUid, callback]) => {\n                livePreview.subscribeToOnEntryChange(callback, callbackUid);\n            }\n        );\n\n        ContentstackLivePreview.onEntryChangeCallbacks = {};\n\n        handlePageTraversal();\n        handleWebCompare();\n\n        return Promise.resolve(ContentstackLivePreview.previewConstructors);\n    }\n\n    /**\n     * Registers a callback function to be called when an entry changes.\n     * @param onChangeCallback The callback function to be called when an entry changes.\n     * @param config Optional configuration for the callback.\n     * @param config.skipInitialRender If true, the callback will not be called when it is first registered.\n     * @returns A unique identifier for the registered callback.\n     *\n     * @example\n     * ```js\n     * const callbackUid = ContentstackLivePreview.onEntryChange(() => {\n     *    console.log(\"Entry changed\");\n     * });\n     *\n     * // Unsubscribe the callback\n     * ContentstackLivePreview.unsubscribeOnEntryChange(callbackUid);\n     * ```\n     */\n    static onEntryChange(\n        onChangeCallback: OnEntryChangeCallback,\n        config: OnEntryChangeConfig = {}\n    ): OnEntryChangeCallbackUID {\n        const { skipInitialRender = false } = config;\n\n        const callbackUid = uuidv4();\n\n        if (ContentstackLivePreview.isInitialized()) {\n            ContentstackLivePreview.previewConstructors.livePreview.subscribeToOnEntryChange(\n                onChangeCallback,\n                callbackUid\n            );\n        } else {\n            ContentstackLivePreview.onEntryChangeCallbacks[callbackUid] =\n                onChangeCallback;\n        }\n\n        if (!skipInitialRender) {\n            onChangeCallback();\n        }\n\n        return callbackUid;\n    }\n\n    /**\n     * Registers a callback function to be called when there is a change in the entry being edited in live preview mode. The difference between this and `onEntryChange` is that this callback will not be called when it is first registered.\n     * @param onChangeCallback The callback function to be called when there is a change in the entry.\n     * @returns A unique identifier for the registered callback.\n     *\n     * @example\n     * ```js\n     * const callbackUid = ContentstackLivePreview.onLiveEdit(() => {\n     *   console.log(\"Entry changed\");\n     * });\n     *\n     * // Unsubscribe the callback\n     * ContentstackLivePreview.unsubscribeOnEntryChange(callbackUid);\n     * ```\n     *\n     */\n    static onLiveEdit(\n        onChangeCallback: OnEntryChangeCallback\n    ): OnEntryChangeCallbackUID {\n        return ContentstackLivePreview.onEntryChange(onChangeCallback, {\n            skipInitialRender: true,\n        });\n    }\n\n    /**\n     * Unsubscribes from the entry change event.\n     * @param callback - The callback function to be unsubscribed.\n     *\n     * @example\n     * ```js\n     * // unsubscribing using the Callback UID\n     * const callbackUid = ContentstackLivePreview.onEntryChange(() => {\n     *  console.log(\"Entry changed\");\n     * });\n     *\n     * // Unsubscribe the callback\n     * ContentstackLivePreview.unsubscribeOnEntryChange(callbackUid);\n     * ```\n     *\n     * @example\n     * ```js\n     * // unsubscribing using the callback function\n     * const callback = () => {console.log(\"Entry changed\")};\n     * ContentstackLivePreview.onEntryChange(callback);\n     *\n     * // Unsubscribe the callback\n     * ContentstackLivePreview.unsubscribeOnEntryChange(callback);\n     * ```\n     *\n     * @example\n     * ```js\n     * // The same is applicable to onLiveEdit\n     * const callbackUid = ContentstackLivePreview.onLiveEdit(() => {\n     * console.log(\"Entry changed\");\n     * });\n     *\n     * // Unsubscribe the callback\n     * ContentstackLivePreview.unsubscribeOnEntryChange(callbackUid);\n     * ```\n     *\n     *\n     */\n    static unsubscribeOnEntryChange(\n        callback: OnEntryChangeUnsubscribeParameters\n    ): void {\n        if (!ContentstackLivePreview.isInitialized()) {\n            removeFromOnChangeSubscribers(\n                ContentstackLivePreview.onEntryChangeCallbacks,\n                callback\n            );\n            return;\n        }\n        ContentstackLivePreview.previewConstructors.livePreview.unsubscribeOnEntryChange(\n            callback\n        );\n    }\n\n    /**\n     * Retrieves the version of the SDK.\n     * @returns The version of the SDK as a string.\n     */\n    static getSdkVersion(): string {\n        return process?.env?.PACKAGE_VERSION!;\n    }\n}\n\nexport default ContentstackLivePreview;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAA6B;AAE7B,uBAAwB;AACxB,oBAAgC;AAChC,2BAA4C;AAC5C,2BAA8B;AAC9B,0BAAwB;AACxB,2CAA8C;AAQ9C,oBAA6B;AAE7B,6BAAoC;AACpC,qBAAiC;AAEjC,IAAM,2BAAN,MAAM,yBAAwB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoB1B,OAAO,KACH,iBAAiC,+BAAgB,GACU;AAC3D,QAAI,OAAO,WAAW,aAAa;AAC/B,iCAAa,KAAK,4CAA4C;AAC9D,aAAO,QAAQ,QAAQ,yBAAwB,mBAAmB;AAAA,IACtE;AAGA,yBAAAA,QAAO,QAAQ,UAAU;AACzB,kDAAoB;AAEpB,QAAI,yBAAwB,cAAc,GAAG;AACzC,iCAAa;AAAA,QACT;AAAA,MACJ;AACA,aAAO,QAAQ,QAAQ,yBAAwB,mBAAmB;AAAA,IACtE,OAAO;AACH,aAAO,yBAAwB,kBAAkB;AAAA,IACrD;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,WAAW,OAAe;AACtB,QAAI,CAAC,yBAAwB,cAAc,GAAG;AAC1C,oDAAoB;AAAA,IACxB;AACA,WAAO,qBAAAA,QAAO,IAAI,EAAE;AAAA,EACxB;AAAA,EAEA,OAAe,gBAAyB;AACpC,WAAO,KAAC,0BAAQ,yBAAwB,mBAAmB;AAAA,EAC/D;AAAA,EAEA,OAAe,oBAAoB;AAC/B,6BAAwB,sBAAsB;AAAA,MAC1C,aAAa,IAAI,oBAAAC,QAAY;AAAA,MAC7B,eAAe,IAAI,mCAAc;AAAA,IACrC;AAGA,UAAM,cACF,yBAAwB,oBAAoB;AAChD,WAAO,QAAQ,yBAAwB,sBAAsB,EAAE;AAAA,MAC3D,CAAC,CAAC,aAAa,QAAQ,MAAM;AACzB,oBAAY,yBAAyB,UAAU,WAAW;AAAA,MAC9D;AAAA,IACJ;AAEA,6BAAwB,yBAAyB,CAAC;AAElD,oDAAoB;AACpB,yCAAiB;AAEjB,WAAO,QAAQ,QAAQ,yBAAwB,mBAAmB;AAAA,EACtE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBA,OAAO,cACH,kBACA,SAA8B,CAAC,GACP;AACxB,UAAM,EAAE,oBAAoB,MAAM,IAAI;AAEtC,UAAM,kBAAc,YAAAC,IAAO;AAE3B,QAAI,yBAAwB,cAAc,GAAG;AACzC,+BAAwB,oBAAoB,YAAY;AAAA,QACpD;AAAA,QACA;AAAA,MACJ;AAAA,IACJ,OAAO;AACH,+BAAwB,uBAAuB,WAAW,IACtD;AAAA,IACR;AAEA,QAAI,CAAC,mBAAmB;AACpB,uBAAiB;AAAA,IACrB;AAEA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBA,OAAO,WACH,kBACwB;AACxB,WAAO,yBAAwB,cAAc,kBAAkB;AAAA,MAC3D,mBAAmB;AAAA,IACvB,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAwCA,OAAO,yBACH,UACI;AACJ,QAAI,CAAC,yBAAwB,cAAc,GAAG;AAC1C;AAAA,QACI,yBAAwB;AAAA,QACxB;AAAA,MACJ;AACA;AAAA,IACJ;AACA,6BAAwB,oBAAoB,YAAY;AAAA,MACpD;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAO,gBAAwB;AAC3B,WAAO;AAAA,EACX;AACJ;AA9MM,yBACa,sBAKe,CAAC;AAAA;AAAA;AAAA;AAN7B,yBAWa,yBACX,CAAC;AAZT,IAAM,0BAAN;AAgNA,IAAO,wCAAQ;","names":["Config","LivePreview","uuidv4"]}

package/dist/legacy/preview/contentstack-live-preview-HOC.d.cts

@@ -0,0 +1,105 @@
+import { OnEntryChangeCallback, OnEntryChangeConfig, OnEntryChangeCallbackUID, OnEntryChangeUnsubscribeParameters } from '../livePreview/types/onEntryChangeCallback.type.cjs';
+import { IInitData } from '../types/types.cjs';
+
+declare class ContentstackLivePreview {
+    private static previewConstructors;
+    /**
+     * The subscribers for the onEntryChange event. We store them here when the SDK is not initialized.
+     */
+    private static onEntryChangeCallbacks;
+    /**
+     * Initializes the Live Preview SDK with the provided user configuration.
+     * If the SDK is already initialized, subsequent calls to this method will return the existing SDK instance.
+     * @param userConfig - The user configuration to initialize the SDK with. See {@link https://github.com/contentstack/live-preview-sdk/blob/main/docs/live-preview-configs.md#initconfig-iconfig|Live preview User config} for more details.
+     * @returns A promise that resolves to the constructors of the Live Preview SDK.
+     */
+    static init(userConfig?: Partial<IInitData>): Promise<typeof ContentstackLivePreview.previewConstructors>;
+    /**
+     * It is the live preview hash.
+     * This hash could be used when data is fetched manually.
+     */
+    static get hash(): string;
+    private static isInitialized;
+    private static initializePreview;
+    /**
+     * Registers a callback function to be called when an entry changes.
+     * @param onChangeCallback The callback function to be called when an entry changes.
+     * @param config Optional configuration for the callback.
+     * @param config.skipInitialRender If true, the callback will not be called when it is first registered.
+     * @returns A unique identifier for the registered callback.
+     *
+     * @example
+     * ```js
+     * const callbackUid = ContentstackLivePreview.onEntryChange(() => {
+     *    console.log("Entry changed");
+     * });
+     *
+     * // Unsubscribe the callback
+     * ContentstackLivePreview.unsubscribeOnEntryChange(callbackUid);
+     * ```
+     */
+    static onEntryChange(onChangeCallback: OnEntryChangeCallback, config?: OnEntryChangeConfig): OnEntryChangeCallbackUID;
+    /**
+     * Registers a callback function to be called when there is a change in the entry being edited in live preview mode. The difference between this and `onEntryChange` is that this callback will not be called when it is first registered.
+     * @param onChangeCallback The callback function to be called when there is a change in the entry.
+     * @returns A unique identifier for the registered callback.
+     *
+     * @example
+     * ```js
+     * const callbackUid = ContentstackLivePreview.onLiveEdit(() => {
+     *   console.log("Entry changed");
+     * });
+     *
+     * // Unsubscribe the callback
+     * ContentstackLivePreview.unsubscribeOnEntryChange(callbackUid);
+     * ```
+     *
+     */
+    static onLiveEdit(onChangeCallback: OnEntryChangeCallback): OnEntryChangeCallbackUID;
+    /**
+     * Unsubscribes from the entry change event.
+     * @param callback - The callback function to be unsubscribed.
+     *
+     * @example
+     * ```js
+     * // unsubscribing using the Callback UID
+     * const callbackUid = ContentstackLivePreview.onEntryChange(() => {
+     *  console.log("Entry changed");
+     * });
+     *
+     * // Unsubscribe the callback
+     * ContentstackLivePreview.unsubscribeOnEntryChange(callbackUid);
+     * ```
+     *
+     * @example
+     * ```js
+     * // unsubscribing using the callback function
+     * const callback = () => {console.log("Entry changed")};
+     * ContentstackLivePreview.onEntryChange(callback);
+     *
+     * // Unsubscribe the callback
+     * ContentstackLivePreview.unsubscribeOnEntryChange(callback);
+     * ```
+     *
+     * @example
+     * ```js
+     * // The same is applicable to onLiveEdit
+     * const callbackUid = ContentstackLivePreview.onLiveEdit(() => {
+     * console.log("Entry changed");
+     * });
+     *
+     * // Unsubscribe the callback
+     * ContentstackLivePreview.unsubscribeOnEntryChange(callbackUid);
+     * ```
+     *
+     *
+     */
+    static unsubscribeOnEntryChange(callback: OnEntryChangeUnsubscribeParameters): void;
+    /**
+     * Retrieves the version of the SDK.
+     * @returns The version of the SDK as a string.
+     */
+    static getSdkVersion(): string;
+}
+
+export { ContentstackLivePreview as default };

package/dist/legacy/preview/contentstack-live-preview-HOC.d.ts

@@ -0,0 +1,105 @@
+import { OnEntryChangeCallback, OnEntryChangeConfig, OnEntryChangeCallbackUID, OnEntryChangeUnsubscribeParameters } from '../livePreview/types/onEntryChangeCallback.type.js';
+import { IInitData } from '../types/types.js';
+
+declare class ContentstackLivePreview {
+    private static previewConstructors;
+    /**
+     * The subscribers for the onEntryChange event. We store them here when the SDK is not initialized.
+     */
+    private static onEntryChangeCallbacks;
+    /**
+     * Initializes the Live Preview SDK with the provided user configuration.
+     * If the SDK is already initialized, subsequent calls to this method will return the existing SDK instance.
+     * @param userConfig - The user configuration to initialize the SDK with. See {@link https://github.com/contentstack/live-preview-sdk/blob/main/docs/live-preview-configs.md#initconfig-iconfig|Live preview User config} for more details.
+     * @returns A promise that resolves to the constructors of the Live Preview SDK.
+     */
+    static init(userConfig?: Partial<IInitData>): Promise<typeof ContentstackLivePreview.previewConstructors>;
+    /**
+     * It is the live preview hash.
+     * This hash could be used when data is fetched manually.
+     */
+    static get hash(): string;
+    private static isInitialized;
+    private static initializePreview;
+    /**
+     * Registers a callback function to be called when an entry changes.
+     * @param onChangeCallback The callback function to be called when an entry changes.
+     * @param config Optional configuration for the callback.
+     * @param config.skipInitialRender If true, the callback will not be called when it is first registered.
+     * @returns A unique identifier for the registered callback.
+     *
+     * @example
+     * ```js
+     * const callbackUid = ContentstackLivePreview.onEntryChange(() => {
+     *    console.log("Entry changed");
+     * });
+     *
+     * // Unsubscribe the callback
+     * ContentstackLivePreview.unsubscribeOnEntryChange(callbackUid);
+     * ```
+     */
+    static onEntryChange(onChangeCallback: OnEntryChangeCallback, config?: OnEntryChangeConfig): OnEntryChangeCallbackUID;
+    /**
+     * Registers a callback function to be called when there is a change in the entry being edited in live preview mode. The difference between this and `onEntryChange` is that this callback will not be called when it is first registered.
+     * @param onChangeCallback The callback function to be called when there is a change in the entry.
+     * @returns A unique identifier for the registered callback.
+     *
+     * @example
+     * ```js
+     * const callbackUid = ContentstackLivePreview.onLiveEdit(() => {
+     *   console.log("Entry changed");
+     * });
+     *
+     * // Unsubscribe the callback
+     * ContentstackLivePreview.unsubscribeOnEntryChange(callbackUid);
+     * ```
+     *
+     */
+    static onLiveEdit(onChangeCallback: OnEntryChangeCallback): OnEntryChangeCallbackUID;
+    /**
+     * Unsubscribes from the entry change event.
+     * @param callback - The callback function to be unsubscribed.
+     *
+     * @example
+     * ```js
+     * // unsubscribing using the Callback UID
+     * const callbackUid = ContentstackLivePreview.onEntryChange(() => {
+     *  console.log("Entry changed");
+     * });
+     *
+     * // Unsubscribe the callback
+     * ContentstackLivePreview.unsubscribeOnEntryChange(callbackUid);
+     * ```
+     *
+     * @example
+     * ```js
+     * // unsubscribing using the callback function
+     * const callback = () => {console.log("Entry changed")};
+     * ContentstackLivePreview.onEntryChange(callback);
+     *
+     * // Unsubscribe the callback
+     * ContentstackLivePreview.unsubscribeOnEntryChange(callback);
+     * ```
+     *
+     * @example
+     * ```js
+     * // The same is applicable to onLiveEdit
+     * const callbackUid = ContentstackLivePreview.onLiveEdit(() => {
+     * console.log("Entry changed");
+     * });
+     *
+     * // Unsubscribe the callback
+     * ContentstackLivePreview.unsubscribeOnEntryChange(callbackUid);
+     * ```
+     *
+     *
+     */
+    static unsubscribeOnEntryChange(callback: OnEntryChangeUnsubscribeParameters): void;
+    /**
+     * Retrieves the version of the SDK.
+     * @returns The version of the SDK as a string.
+     */
+    static getSdkVersion(): string;
+}
+
+export { ContentstackLivePreview as default };