Merge branch 'main' of https://github.com/contentstack/live-preview-sdk into VE-4232

Author: sairajchouhan

.github/workflows/npm-alpha-publish.yml

@@ -0,0 +1,31 @@
+name: Publish Alpha Package to npmjs
+on:
+    push:
+        branches:
+            - "alpha/*"
+        tags:
+            - "v*.*.*-alpha.*"
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        permissions:
+            contents: read
+            id-token: write
+        steps:
+            - uses: actions/checkout@v4
+
+            # Setup Node.js and npm registry
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: "18"
+                  registry-url: "https://registry.npmjs.org"
+                  always-auth: true
+
+            - run: npm ci
+            - run: npm run build
+
+            # Publish package to npm under the "alpha" tag
+            - run: npm publish --tag alpha --provenance
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

CHANGELOG.md

@@ -15,8 +15,8 @@ npm install @contentstack/live-preview-utils
 Alternatively, if you want to include the package directly in your website HTML code, use the following command:
 
 ```html
-<script type='module'  integrity='sha384-LQQFdnInqHR0YPq3ypmbejKtYGi+kb43FlR7STQHgZtSrkLXPrN1eovxsdlxofuL' crossorigin="anonymous">
-     import ContentstackLivePreview from 'https://esm.sh/@contentstack/live-preview-utils@3.1.3';
+<script type='module'  integrity='sha384-Q1kNLAr9TbfZ9lsUUXH&#x2F;vW79LERzfbYJc7aLNSYjKFLzBZQDp&#x2F;Jk09+ADHo9mhEq' crossorigin="anonymous">
+     import ContentstackLivePreview from 'https://esm.sh/@contentstack/live-preview-utils@3.2.0';
 
      ContentstackLivePreview.init({
         stackDetails: {

README.md

@@ -1,6 +1,6 @@
 {
     "name": "@contentstack/live-preview-utils",
-    "version": "3.1.3",
+    "version": "3.2.0",
     "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",
@@ -28,7 +28,7 @@
         "test": "vitest",
         "test:once": "vitest run",
         "test:coverage": "vitest --coverage",
-        "dev": "tsup --watch",
+        "dev": "NODE_OPTIONS='--max-old-space-size=16384' tsup --watch",
         "prepare": "husky",
         "lint": "eslint src",
         "lint:fix": "eslint --fix",
@@ -89,7 +89,10 @@
         "@preact/compat": "17.1.2",
         "@preact/signals": "1.2.2",
         "classnames": "^2.5.1",
+        "dayjs": "^1.11.13",
         "deepsignal": "^1.5.0",
+        "dompurify": "^3.2.3",
+        "get-xpath": "^3.2.0",
         "goober": "^2.1.14",
         "lodash-es": "^4.17.21",
         "mustache": "^4.2.0",

package-lock.json

@@ -95,5 +95,20 @@ export function getDefaultConfig(): IConfig {
         elements: {
             highlightedElement: null,
         },
+        collab: {
+            enable: false,
+            fromShare: false,
+            pauseFeedback: false,
+            isFeedbackMode: false,
+            inviteMetadata: {
+                currentUser: {
+                    email: "",
+                    uid: "",
+                },
+                users: [],
+                inviteUid: "",
+            },
+            payload: [],
+        },
     };
 }

package.json

@@ -1,20 +1,64 @@
 import ContentstackLivePreviewHOC from "./preview/contentstack-live-preview-HOC";
-
 import { IStackSdk as ExternalStackSdkType } from "./types/types";
+
+import {
+    OnEntryChangeCallback,
+    OnEntryChangeCallbackUID,
+    OnEntryChangeConfig,
+} from "./livePreview/types/onEntryChangeCallback.type";
+
 export type IStackSdk = ExternalStackSdkType;
-class LightLivePreviewHoC implements ContentstackLivePreviewHOC {
-    static init() {}
 
-    get hash() {
+class LightLivePreviewHoC {
+    private static previewConstructors = {};
+    private static onEntryChangeCallbacks = {};
+
+    static init() {
+        if (typeof window === "undefined") {
+            return Promise.resolve(LightLivePreviewHoC.previewConstructors);
+        }
+
+        return LightLivePreviewHoC.initializePreview();
+    }
+
+    private static initializePreview() {
+        LightLivePreviewHoC.previewConstructors = {
+            livePreview: {},
+            visualBuilder: {},
+        };
+
+        LightLivePreviewHoC.onEntryChangeCallbacks = {};
+
+        return Promise.resolve(LightLivePreviewHoC.previewConstructors);
+    }
+
+    static get hash() {
         return "";
     }
 
-    static onEntryChange(callback: (...args: any[]) => void) {
-        return callback();
+    static get config() {
+        return {};
     }
 
-    static onLiveEdit() {
-        // intentionally empty
+    static isInitialized() {
+        return false;
+    }
+
+    static onEntryChange(
+        callback: OnEntryChangeCallback,
+        config: OnEntryChangeConfig = {}
+    ): OnEntryChangeCallbackUID {
+        const { skipInitialRender = false } = config;
+
+        if (!skipInitialRender) {
+            callback();
+        }
+
+        return "live-preview-id";
+    }
+
+    static onLiveEdit(callback: OnEntryChangeCallback) {
+        return "live-preview-id";
     }
 
     static unsubscribeOnEntryChange() {
@@ -26,8 +70,10 @@ class LightLivePreviewHoC implements ContentstackLivePreviewHOC {
     }
 }
 
-// export const ContentstackLivePreview: ContentstackLivePreviewHOC =
-//     ContentstackLivePreviewHOC;
+const ContentstackLivePreview =
+    process.env.PURGE_PREVIEW_SDK || process.env.REACT_APP_PURGE_PREVIEW_SDK
+        ? LightLivePreviewHoC
+        : ContentstackLivePreviewHOC;
 
 export const VB_EmptyBlockParentClass = "visual-builder__empty-block-parent";
-export default ContentstackLivePreviewHOC;
+export default ContentstackLivePreview;