@contentstack/live-preview-utils 2.0.3 → 3.0.0

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

@@ -1,169 +0,0 @@
-// src/contentstack-live-preview-HOC.ts
-import { v4 } from "uuid";
-import camelCase from "./utils/camelCase.js";
-import LivePreview from "./live-preview.js";
-import { userInitData } from "./utils/defaults.js";
-import { PublicLogger } from "./utils/public-logger.js";
-import { handleWebCompare } from "./compare.js";
-import { handlePageTraversal } from "./utils/handlePageTraversal.js";
-var ContentstackLivePreview = {
-  livePreview: null,
-  userConfig: null,
-  subscribers: {},
-  configs: {
-    params: {}
-  },
-  init(userConfig = userInitData) {
-    if (typeof window !== "undefined") {
-      if (ContentstackLivePreview.livePreview) {
-        PublicLogger.warn(
-          "You have already initialized the Live Preview SDK. So, any subsequent initialization returns the existing SDK instance."
-        );
-        return Promise.resolve(ContentstackLivePreview.livePreview);
-      } else {
-        handleWebCompare();
-        handlePageTraversal();
-        ContentstackLivePreview.livePreview = new LivePreview(
-          userConfig
-        );
-        ContentstackLivePreview.livePreview.setOnChangeCallback(
-          ContentstackLivePreview.publish
-        );
-        ContentstackLivePreview.livePreview.setConfigFromParams(
-          ContentstackLivePreview.configs.params
-        );
-        ContentstackLivePreview.configs.params = {};
-        return Promise.resolve(ContentstackLivePreview.livePreview);
-      }
-    } else {
-      ContentstackLivePreview.userConfig = userConfig;
-    }
-  },
-  get hash() {
-    if (!ContentstackLivePreview.livePreview) {
-      const urlParams = new URLSearchParams(
-        ContentstackLivePreview.configs.params
-      );
-      return urlParams.get("live_preview") ?? "";
-    }
-    return ContentstackLivePreview.livePreview.hash;
-  },
-  /**
-   * Sets the live preview hash from the query param which is
-   * accessible via `hash` property.
-   * @param params query param in an object form
-   */
-  setConfigFromParams(params = {}) {
-    if (!ContentstackLivePreview.livePreview) {
-      ContentstackLivePreview.configs.params = params;
-      return;
-    }
-    ContentstackLivePreview.livePreview.setConfigFromParams(params);
-  },
-  publish() {
-    Object.values(
-      ContentstackLivePreview.subscribers
-    ).forEach((func) => {
-      func();
-    });
-  },
-  subscribe(callback) {
-    const callbackUid = v4();
-    ContentstackLivePreview.subscribers[callbackUid] = callback;
-    return callbackUid;
-  },
-  /**
-   * @type {function}
-   * @param onChangeCallback A function param to fetch the data from contentstack database
-   * @param config An optional object param, pass {skipInitialRender:Boolean} to skip init call to onChangeCallback
-   * @returns Subscribed Callback UID
-   */
-  onEntryChange(onChangeCallback, config) {
-    const { skipInitialRender = false } = config || {};
-    if (ContentstackLivePreview.userConfig) {
-      ContentstackLivePreview.livePreview = new LivePreview(
-        ContentstackLivePreview.userConfig
-      );
-      ContentstackLivePreview.livePreview.setOnChangeCallback(
-        ContentstackLivePreview.publish
-      );
-      ContentstackLivePreview.livePreview.setConfigFromParams(
-        ContentstackLivePreview.configs.params
-      );
-      ContentstackLivePreview.configs.params = {};
-      ContentstackLivePreview.userConfig = null;
-    }
-    const callbackUid = ContentstackLivePreview.subscribe(onChangeCallback);
-    if (!skipInitialRender) {
-      onChangeCallback();
-    }
-    return callbackUid;
-  },
-  /**
-   * @type {function}
-   * @param onChangeCallback A function param to fetch the data from contentstack database on content change.
-   * @returns Subscribed Callback UID
-   */
-  onLiveEdit(onChangeCallback) {
-    return ContentstackLivePreview.onEntryChange(onChangeCallback, {
-      skipInitialRender: true
-    });
-  },
-  unsubscribeOnEntryChange(callback) {
-    if (typeof callback === "string") {
-      if (!ContentstackLivePreview.subscribers[callback]) {
-        PublicLogger.warn("No subscriber found with the given id.");
-      }
-      delete ContentstackLivePreview.subscribers[callback];
-    } else if (typeof callback === "function") {
-      const isCallbackDeleted = Object.entries(
-        ContentstackLivePreview.subscribers
-      ).some(([uid, func]) => {
-        if (func === callback) {
-          delete ContentstackLivePreview.subscribers[uid];
-          return true;
-        }
-        return false;
-      });
-      if (!isCallbackDeleted) {
-        PublicLogger.warn(
-          "No subscriber found with the given callback."
-        );
-      }
-    }
-  },
-  async getGatsbyDataFormat(sdkQuery, prefix) {
-    if (typeof sdkQuery.find === "function") {
-      return sdkQuery.toJSON().find().then((result) => {
-        return result.map((res) => {
-          return res.map((entry) => {
-            const dataTitle = camelCase(
-              `${prefix}_${sdkQuery.content_type_uid}`
-            );
-            return { [dataTitle]: entry };
-          });
-        });
-      }).catch((err) => {
-        console.error(err);
-      });
-    } else if (typeof sdkQuery.fetch === "function") {
-      return sdkQuery.toJSON().fetch().then((ent) => {
-        const dataTitle = camelCase(
-          `${prefix}_${sdkQuery.content_type_uid}`
-        );
-        const entry = { [dataTitle]: ent };
-        return entry;
-      }).catch((err) => {
-        console.error(err);
-      });
-    }
-  },
-  getSdkVersion() {
-    return "2.0.3";
-  }
-};
-var contentstack_live_preview_HOC_default = ContentstackLivePreview;
-export {
-  contentstack_live_preview_HOC_default as default
-};
-//# sourceMappingURL=contentstack-live-preview-HOC.js.map

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

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/contentstack-live-preview-HOC.ts"],"sourcesContent":["import { v4 } from \"uuid\";\nimport camelCase from \"./utils/camelCase\";\n\nimport {\n    IInitData,\n    IStackSdk,\n    OnEntryChangeCallback,\n    OnEntryChangeCallbackUID,\n    OnEntryChangeConfig,\n} from \"./utils/types\";\nimport LivePreview from \"./live-preview\";\nimport { userInitData } from \"./utils/defaults\";\nimport { PublicLogger } from \"./utils/public-logger\";\nimport { handleWebCompare } from \"./compare\";\nimport { handlePageTraversal } from \"./utils/handlePageTraversal\";\n\nexport interface ICSLivePreview {\n    livePreview: LivePreview | null;\n    userConfig: Partial<IInitData> | null;\n    subscribers: { [uid: string]: OnEntryChangeCallback };\n    configs: {\n        params: ConstructorParameters<typeof URLSearchParams>[0];\n    };\n    init: (userConfig?: Partial<IInitData>) => Promise<LivePreview> | undefined;\n    hash: string;\n    setConfigFromParams(\n        params: ConstructorParameters<typeof URLSearchParams>[0]\n    ): void;\n    publish(): void;\n    subscribe(callback: OnEntryChangeCallback): OnEntryChangeCallbackUID;\n    onEntryChange(\n        onChangeCallback: OnEntryChangeCallback,\n        config?: OnEntryChangeConfig\n    ): OnEntryChangeCallbackUID;\n    onLiveEdit(\n        onChangeCallback: OnEntryChangeCallback\n    ): OnEntryChangeCallbackUID;\n    unsubscribeOnEntryChange(callback: string | OnEntryChangeCallback): void;\n    getGatsbyDataFormat(sdkQuery: IStackSdk, prefix: string): Promise<any>;\n    getSdkVersion(): string;\n}\n\nconst ContentstackLivePreview: ICSLivePreview = {\n    livePreview: null,\n    userConfig: null,\n    subscribers: {},\n    configs: {\n        params: {},\n    },\n\n    init(\n        userConfig: Partial<IInitData> = userInitData\n    ): Promise<LivePreview> | undefined {\n        if (typeof window !== \"undefined\") {\n            if (ContentstackLivePreview.livePreview) {\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.livePreview);\n            } else {\n                handleWebCompare();\n                handlePageTraversal();\n\n                ContentstackLivePreview.livePreview = new LivePreview(\n                    userConfig\n                );\n                ContentstackLivePreview.livePreview.setOnChangeCallback(\n                    ContentstackLivePreview.publish\n                );\n\n                ContentstackLivePreview.livePreview.setConfigFromParams(\n                    ContentstackLivePreview.configs.params\n                );\n                ContentstackLivePreview.configs.params = {};\n\n                return Promise.resolve(ContentstackLivePreview.livePreview);\n            }\n        } else {\n            ContentstackLivePreview.userConfig = userConfig;\n        }\n    },\n\n    get hash(): string {\n        if (!ContentstackLivePreview.livePreview) {\n            const urlParams = new URLSearchParams(\n                ContentstackLivePreview.configs.params\n            );\n            return urlParams.get(\"live_preview\") ?? \"\";\n        }\n\n        return ContentstackLivePreview.livePreview.hash;\n    },\n\n    /**\n     * Sets the live preview hash from the query param which is\n     * accessible via `hash` property.\n     * @param params query param in an object form\n     */\n    setConfigFromParams(\n        params: ConstructorParameters<typeof URLSearchParams>[0] = {}\n    ): void {\n        if (!ContentstackLivePreview.livePreview) {\n            ContentstackLivePreview.configs.params = params;\n            return;\n        }\n\n        ContentstackLivePreview.livePreview.setConfigFromParams(params);\n    },\n\n    publish(): void {\n        Object.values<OnEntryChangeCallback>(\n            ContentstackLivePreview.subscribers\n        ).forEach((func) => {\n            func();\n        });\n    },\n    subscribe(callback: OnEntryChangeCallback): OnEntryChangeCallbackUID {\n        const callbackUid = v4();\n        ContentstackLivePreview.subscribers[callbackUid] = callback;\n        return callbackUid;\n    },\n    /**\n     * @type {function}\n     * @param onChangeCallback A function param to fetch the data from contentstack database\n     * @param config An optional object param, pass {skipInitialRender:Boolean} to skip init call to onChangeCallback\n     * @returns Subscribed Callback UID\n     */\n    onEntryChange(\n        onChangeCallback: OnEntryChangeCallback,\n        config?: OnEntryChangeConfig\n    ): OnEntryChangeCallbackUID {\n        const { skipInitialRender = false } = config || {};\n        if (ContentstackLivePreview.userConfig) {\n            ContentstackLivePreview.livePreview = new LivePreview(\n                ContentstackLivePreview.userConfig\n            );\n            ContentstackLivePreview.livePreview.setOnChangeCallback(\n                ContentstackLivePreview.publish\n            );\n\n            ContentstackLivePreview.livePreview.setConfigFromParams(\n                ContentstackLivePreview.configs.params\n            );\n\n            ContentstackLivePreview.configs.params = {};\n\n            ContentstackLivePreview.userConfig = null;\n        }\n        const callbackUid = ContentstackLivePreview.subscribe(onChangeCallback);\n        if (!skipInitialRender) {\n            onChangeCallback();\n        }\n        return callbackUid;\n    },\n    /**\n     * @type {function}\n     * @param onChangeCallback A function param to fetch the data from contentstack database on content change.\n     * @returns Subscribed Callback UID\n     */\n    onLiveEdit(\n        onChangeCallback: OnEntryChangeCallback\n    ): OnEntryChangeCallbackUID {\n        return ContentstackLivePreview.onEntryChange(onChangeCallback, {\n            skipInitialRender: true,\n        });\n    },\n    unsubscribeOnEntryChange(callback: string | OnEntryChangeCallback): void {\n        if (typeof callback === \"string\") {\n            if (!ContentstackLivePreview.subscribers[callback]) {\n                PublicLogger.warn(\"No subscriber found with the given id.\");\n            }\n            delete ContentstackLivePreview.subscribers[callback];\n        } else if (typeof callback === \"function\") {\n            const isCallbackDeleted = Object.entries<() => void>(\n                ContentstackLivePreview.subscribers\n            ).some(([uid, func]) => {\n                if (func === callback) {\n                    delete ContentstackLivePreview.subscribers[uid];\n                    return true;\n                }\n                return false;\n            });\n\n            if (!isCallbackDeleted) {\n                PublicLogger.warn(\n                    \"No subscriber found with the given callback.\"\n                );\n            }\n        }\n    },\n    async getGatsbyDataFormat(\n        sdkQuery: IStackSdk,\n        prefix: string\n    ): Promise<any> {\n        if (typeof sdkQuery.find === \"function\") {\n            return sdkQuery\n                .toJSON()\n                .find()\n                .then((result: { [key: string]: any }) => {\n                    return result.map((res: { [key: string]: any }) => {\n                        return res.map((entry: { [key: string]: any }) => {\n                            const dataTitle = camelCase(\n                                `${prefix}_${sdkQuery.content_type_uid}`\n                            );\n                            return { [dataTitle]: entry };\n                        });\n                    });\n                })\n                .catch((err: any) => {\n                    console.error(err);\n                });\n        } else if (typeof sdkQuery.fetch === \"function\") {\n            return sdkQuery\n                .toJSON()\n                .fetch()\n                .then((ent: { [key: string]: any }) => {\n                    const dataTitle = camelCase(\n                        `${prefix}_${sdkQuery.content_type_uid}`\n                    );\n                    const entry = { [dataTitle]: ent };\n\n                    return entry;\n                })\n                .catch((err: unknown) => {\n                    console.error(err);\n                });\n        }\n    },\n    getSdkVersion(): string {\n        return process.env.PACKAGE_VERSION!;\n    },\n};\n\nexport default ContentstackLivePreview;\n"],"mappings":";AAAA,SAAS,UAAU;AACnB,OAAO,eAAe;AAStB,OAAO,iBAAiB;AACxB,SAAS,oBAAoB;AAC7B,SAAS,oBAAoB;AAC7B,SAAS,wBAAwB;AACjC,SAAS,2BAA2B;AA4BpC,IAAM,0BAA0C;AAAA,EAC5C,aAAa;AAAA,EACb,YAAY;AAAA,EACZ,aAAa,CAAC;AAAA,EACd,SAAS;AAAA,IACL,QAAQ,CAAC;AAAA,EACb;AAAA,EAEA,KACI,aAAiC,cACD;AAChC,QAAI,OAAO,WAAW,aAAa;AAC/B,UAAI,wBAAwB,aAAa;AACrC,qBAAa;AAAA,UACT;AAAA,QACJ;AACA,eAAO,QAAQ,QAAQ,wBAAwB,WAAW;AAAA,MAC9D,OAAO;AACH,yBAAiB;AACjB,4BAAoB;AAEpB,gCAAwB,cAAc,IAAI;AAAA,UACtC;AAAA,QACJ;AACA,gCAAwB,YAAY;AAAA,UAChC,wBAAwB;AAAA,QAC5B;AAEA,gCAAwB,YAAY;AAAA,UAChC,wBAAwB,QAAQ;AAAA,QACpC;AACA,gCAAwB,QAAQ,SAAS,CAAC;AAE1C,eAAO,QAAQ,QAAQ,wBAAwB,WAAW;AAAA,MAC9D;AAAA,IACJ,OAAO;AACH,8BAAwB,aAAa;AAAA,IACzC;AAAA,EACJ;AAAA,EAEA,IAAI,OAAe;AACf,QAAI,CAAC,wBAAwB,aAAa;AACtC,YAAM,YAAY,IAAI;AAAA,QAClB,wBAAwB,QAAQ;AAAA,MACpC;AACA,aAAO,UAAU,IAAI,cAAc,KAAK;AAAA,IAC5C;AAEA,WAAO,wBAAwB,YAAY;AAAA,EAC/C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,oBACI,SAA2D,CAAC,GACxD;AACJ,QAAI,CAAC,wBAAwB,aAAa;AACtC,8BAAwB,QAAQ,SAAS;AACzC;AAAA,IACJ;AAEA,4BAAwB,YAAY,oBAAoB,MAAM;AAAA,EAClE;AAAA,EAEA,UAAgB;AACZ,WAAO;AAAA,MACH,wBAAwB;AAAA,IAC5B,EAAE,QAAQ,CAAC,SAAS;AAChB,WAAK;AAAA,IACT,CAAC;AAAA,EACL;AAAA,EACA,UAAU,UAA2D;AACjE,UAAM,cAAc,GAAG;AACvB,4BAAwB,YAAY,WAAW,IAAI;AACnD,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,cACI,kBACA,QACwB;AACxB,UAAM,EAAE,oBAAoB,MAAM,IAAI,UAAU,CAAC;AACjD,QAAI,wBAAwB,YAAY;AACpC,8BAAwB,cAAc,IAAI;AAAA,QACtC,wBAAwB;AAAA,MAC5B;AACA,8BAAwB,YAAY;AAAA,QAChC,wBAAwB;AAAA,MAC5B;AAEA,8BAAwB,YAAY;AAAA,QAChC,wBAAwB,QAAQ;AAAA,MACpC;AAEA,8BAAwB,QAAQ,SAAS,CAAC;AAE1C,8BAAwB,aAAa;AAAA,IACzC;AACA,UAAM,cAAc,wBAAwB,UAAU,gBAAgB;AACtE,QAAI,CAAC,mBAAmB;AACpB,uBAAiB;AAAA,IACrB;AACA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,WACI,kBACwB;AACxB,WAAO,wBAAwB,cAAc,kBAAkB;AAAA,MAC3D,mBAAmB;AAAA,IACvB,CAAC;AAAA,EACL;AAAA,EACA,yBAAyB,UAAgD;AACrE,QAAI,OAAO,aAAa,UAAU;AAC9B,UAAI,CAAC,wBAAwB,YAAY,QAAQ,GAAG;AAChD,qBAAa,KAAK,wCAAwC;AAAA,MAC9D;AACA,aAAO,wBAAwB,YAAY,QAAQ;AAAA,IACvD,WAAW,OAAO,aAAa,YAAY;AACvC,YAAM,oBAAoB,OAAO;AAAA,QAC7B,wBAAwB;AAAA,MAC5B,EAAE,KAAK,CAAC,CAAC,KAAK,IAAI,MAAM;AACpB,YAAI,SAAS,UAAU;AACnB,iBAAO,wBAAwB,YAAY,GAAG;AAC9C,iBAAO;AAAA,QACX;AACA,eAAO;AAAA,MACX,CAAC;AAED,UAAI,CAAC,mBAAmB;AACpB,qBAAa;AAAA,UACT;AAAA,QACJ;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AAAA,EACA,MAAM,oBACF,UACA,QACY;AACZ,QAAI,OAAO,SAAS,SAAS,YAAY;AACrC,aAAO,SACF,OAAO,EACP,KAAK,EACL,KAAK,CAAC,WAAmC;AACtC,eAAO,OAAO,IAAI,CAAC,QAAgC;AAC/C,iBAAO,IAAI,IAAI,CAAC,UAAkC;AAC9C,kBAAM,YAAY;AAAA,cACd,GAAG,MAAM,IAAI,SAAS,gBAAgB;AAAA,YAC1C;AACA,mBAAO,EAAE,CAAC,SAAS,GAAG,MAAM;AAAA,UAChC,CAAC;AAAA,QACL,CAAC;AAAA,MACL,CAAC,EACA,MAAM,CAAC,QAAa;AACjB,gBAAQ,MAAM,GAAG;AAAA,MACrB,CAAC;AAAA,IACT,WAAW,OAAO,SAAS,UAAU,YAAY;AAC7C,aAAO,SACF,OAAO,EACP,MAAM,EACN,KAAK,CAAC,QAAgC;AACnC,cAAM,YAAY;AAAA,UACd,GAAG,MAAM,IAAI,SAAS,gBAAgB;AAAA,QAC1C;AACA,cAAM,QAAQ,EAAE,CAAC,SAAS,GAAG,IAAI;AAEjC,eAAO;AAAA,MACX,CAAC,EACA,MAAM,CAAC,QAAiB;AACrB,gBAAQ,MAAM,GAAG;AAAA,MACrB,CAAC;AAAA,IACT;AAAA,EACJ;AAAA,EACA,gBAAwB;AACpB,WAAO;AAAA,EACX;AACJ;AAEA,IAAO,wCAAQ;","names":[]}