@pack/react 1.0.0 → 2.0.0

package/dist/types.d.ts

@@ -7,4 +7,64 @@ export type SectionConfig = {
     name: string;
 };
 export type SectionMap = Map<string, Section>;
+export interface MessageTypeDataMap {
+    INIT: {
+        version: string;
+        storefrontMeta: any[];
+    };
+    ACK: {
+        messageId: string;
+    };
+    PING: never;
+    PONG: {
+        url: string;
+    };
+    ERROR: {
+        code: string;
+        message: string;
+    };
+    DISPLAY_ERROR: {
+        message: string;
+        errorCode?: string;
+    };
+    NAVIGATE_TO_PAGE: {
+        path: string;
+    };
+    SET_CURRENT_ROUTE: {
+        currentPath: string;
+        description: string;
+        environment: string;
+        handle: string;
+        title: string;
+        template?: string;
+        templateType?: string;
+    };
+    SET_SECTIONS_SCHEMAS: {
+        schema: string;
+    };
+    SET_STOREFRONT_SETTINGS_SCHEMA: {
+        schema: string;
+    };
+    SET_PAGE_DATA: {
+        content: Record<string, unknown>;
+    };
+    SEND_STOREFRONT_SETTINGS: never;
+    SET_STOREFRONT_SETTINGS: {
+        settings: Record<string, unknown>;
+    };
+    SCROLL_TO_SECTION: {
+        sectionId: string;
+    };
+}
+export interface MessageProtocol<T extends keyof MessageTypeDataMap = keyof MessageTypeDataMap> {
+    pack: {
+        type: T;
+        data?: MessageTypeDataMap[T];
+        origin: string;
+        version: string;
+        messageId: string;
+        timestamp: number;
+        errorCode?: string;
+    };
+}
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AACzC,MAAM,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AACrE,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AACzC,MAAM,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AACrE,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAG9C,MAAM,WAAW,kBAAkB;IAEjC,IAAI,EAAE;QACJ,OAAO,EAAE,MAAM,CAAC;QAChB,cAAc,EAAE,GAAG,EAAE,CAAC;KACvB,CAAC;IACF,GAAG,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3B,IAAI,EAAE,KAAK,CAAC;IACZ,IAAI,EAAE;QACJ,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;IAGF,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IACzC,aAAa,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAGvD,gBAAgB,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACnC,iBAAiB,EAAE;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,WAAW,EAAE,MAAM,CAAC;QACpB,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;IAGF,oBAAoB,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IACzC,8BAA8B,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAGnD,aAAa,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC;IACpD,wBAAwB,EAAE,KAAK,CAAC;IAChC,uBAAuB,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC;IAG/D,iBAAiB,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;CAC1C;AAED,MAAM,WAAW,eAAe,CAC9B,CAAC,SAAS,MAAM,kBAAkB,GAAG,MAAM,kBAAkB;IAE7D,IAAI,EAAE;QACJ,IAAI,EAAE,CAAC,CAAC;QACR,IAAI,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;CACH"}

package/dist/use-customizer-shell.d.ts

@@ -1,4 +1,8 @@
-export declare const useCustomizerShell: ({ environment, sectionComponents, storefrontSettingsSchema, }: any) => {
+export declare const useCustomizerShell: ({ environment, sectionComponents, storefrontSettingsSchema, }: {
+    environment: string;
+    sectionComponents: any;
+    storefrontSettingsSchema?: any;
+}) => {
     content: any;
 };
 //# sourceMappingURL=use-customizer-shell.d.ts.map

package/dist/use-customizer-shell.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-customizer-shell.d.ts","sourceRoot":"","sources":["../src/use-customizer-shell.tsx"],"names":[],"mappings":"AAWA,eAAO,MAAM,kBAAkB,kEAI5B,GAAG;;CA4JL,CAAC"}
+{"version":3,"file":"use-customizer-shell.d.ts","sourceRoot":"","sources":["../src/use-customizer-shell.tsx"],"names":[],"mappings":"AAkBA,eAAO,MAAM,kBAAkB;iBAKhB,MAAM;uBACA,GAAG;+BACK,GAAG;;;CAiQ/B,CAAC"}

package/dist/use-customizer-shell.js

@@ -1,8 +1,8 @@
 import { useCallback, useContext, useEffect, useMemo, useRef, useState, } from "react";
-import { connectToParent, ErrorCode } from "penpal";
+import { VERSION } from "./version";
 import { PreviewContext } from "./preview/preview-content";
 export const useCustomizerShell = ({ environment, sectionComponents, storefrontSettingsSchema, }) => {
-    const { isPreview, content, setContent, setSiteSettings } = useContext(PreviewContext);
+    const { content, isPreview, pathname, setContent, setSiteSettings } = useContext(PreviewContext);
     const data = {
         content,
         template: content.template?.type,
@@ -11,27 +11,119 @@ export const useCustomizerShell = ({ environment, sectionComponents, storefrontS
         title: content.title,
         description: content.description,
     };
-    const windowLocationRef = useRef();
-    const [parentConnection, setParentConnection] = useState(null);
-    const [shouldConnectToParent, setShouldConnectToParent] = useState(false);
-    const navigate = (path) => {
-        window.location.href = path;
-    };
-    useEffect(() => {
-        /*
-         * Should not try to connect to customizer
-         * if not in an iframe or not in preview mode
-         */
-        const isIframe = window.self !== window.top;
-        if (!isIframe || !isPreview)
-            return;
-        setShouldConnectToParent(true);
+    const [hasInit, setHasInit] = useState(false);
+    const pendingMessagesRef = useRef(new Map());
+    const currentPathRef = useRef();
+    const canConnectToParent = useCanConnectCheck({ isPreview });
+    const sendToParent = useCallback(async (type, data) => {
+        const messageId = crypto.randomUUID();
+        const message = {
+            pack: {
+                type,
+                data,
+                origin: "*",
+                version: VERSION,
+                messageId,
+                timestamp: Date.now(),
+            },
+        };
+        if (type === "ACK") {
+            window.parent.postMessage(message, "*");
+            return Promise.resolve();
+        }
+        const messagePromise = new Promise((resolve, reject) => {
+            const timeout = setTimeout(() => {
+                pendingMessagesRef.current.delete(messageId);
+                reject(new Error(`Message ${messageId} timed out waiting for ACK`));
+            }, 2000);
+            pendingMessagesRef.current.set(messageId, {
+                messageId,
+                resolve,
+                reject,
+                timeout,
+            });
+        });
+        window.parent.postMessage(message, "*");
+        return messagePromise;
     }, []);
     useEffect(() => {
-        windowLocationRef.current = window.location;
-    }, [data.handle]);
+        if (!isPreview || !canConnectToParent || hasInit)
+            return;
+        sendToParent("INIT", {
+            storefrontMeta: [],
+            version: VERSION,
+        }).catch((error) => {
+            console.error("Failed to initialize:", error);
+        });
+        setHasInit(true);
+        const handleParentMessages = (event) => {
+            if (!event.data?.pack) {
+                return;
+            }
+            const message = event.data;
+            // Handle ACK messages
+            if (message.pack.type === "ACK") {
+                const acknowledgedMessageId = message.pack.data?.messageId;
+                const pendingMessage = pendingMessagesRef.current.get(acknowledgedMessageId);
+                if (pendingMessage) {
+                    clearTimeout(pendingMessage.timeout);
+                    pendingMessage.resolve();
+                    pendingMessagesRef.current.delete(acknowledgedMessageId);
+                }
+                return;
+            }
+            // Handle other message types
+            sendToParent("ACK", { messageId: message.pack.messageId }).catch(console.error);
+            switch (message.pack.type) {
+                case "PING":
+                    sendToParent("PONG", {
+                        url: window.location.href,
+                    });
+                    break;
+                case "NAVIGATE_TO_PAGE":
+                    const path = message.pack.data?.path;
+                    if (path) {
+                        window.location.href = path;
+                    }
+                    break;
+                case "SCROLL_TO_SECTION":
+                    const sectionId = message.pack.data?.sectionId;
+                    if (sectionId) {
+                        const sectionEl = document.querySelector(`[data-comp-id="${sectionId}"]`);
+                        if (sectionEl)
+                            sectionEl.scrollIntoView({ behavior: "smooth" });
+                    }
+                    break;
+                case "SET_PAGE_DATA":
+                    setContent(message.pack.data?.content);
+                    break;
+                case "SET_STOREFRONT_SETTINGS":
+                    setSiteSettings({
+                        data: {
+                            siteSettings: {
+                                settings: message.pack
+                                    .data?.settings,
+                            },
+                        },
+                    });
+                    break;
+                default:
+                    break;
+            }
+        };
+        window.addEventListener("message", handleParentMessages);
+        return () => {
+            window.removeEventListener("message", handleParentMessages);
+            // Clean up any pending messages
+            pendingMessagesRef.current.forEach((pending) => {
+                clearTimeout(pending.timeout);
+                pending.reject(new Error("Component unmounted"));
+            });
+            pendingMessagesRef.current.clear();
+        };
+    }, [canConnectToParent, isPreview, sendToParent]);
     const refreshSections = useCallback(() => {
-        if (!sectionComponents || !parentConnection)
+        if (!sectionComponents)
             return [];
         const sectionSchemas = Array.from(sectionComponents)
             .map(([, section]) => {
@@ -41,78 +133,60 @@ export const useCustomizerShell = ({ environment, sectionComponents, storefrontS
         })
             .filter(Boolean);
         try {
-            parentConnection?.setSectionsSchemas(JSON.stringify(sectionSchemas));
+            sendToParent("SET_SECTIONS_SCHEMAS", {
+                schema: JSON.stringify(sectionSchemas),
+            });
         }
         catch (error) {
-            if (error.code !== ErrorCode.ConnectionDestroyed) {
-                parentConnection?.displayError("Something went wrong parsing sections");
+            if (error.code !== "ConnectionDestroyed") {
+                sendToParent("DISPLAY_ERROR", {
+                    message: "Something went wrong parsing sections",
+                });
             }
         }
         return;
-    }, [data.handle, parentConnection, sectionComponents]);
+    }, [data.handle, sectionComponents, sendToParent]);
     const refreshStorefrontSettingsSchema = useCallback(() => {
-        if (!storefrontSettingsSchema || !parentConnection || !sectionComponents) {
+        if (!storefrontSettingsSchema || !sectionComponents) {
             return [];
         }
         try {
-            parentConnection.setStorefrontSettingsSchema(JSON.stringify(storefrontSettingsSchema));
+            sendToParent("SET_STOREFRONT_SETTINGS_SCHEMA", {
+                schema: JSON.stringify(storefrontSettingsSchema),
+            });
         }
         catch (error) {
-            if (error.code !== ErrorCode.ConnectionDestroyed) {
-                parentConnection?.displayError("Something went wrong parsing sections");
+            if (error.code !== "ConnectionDestroyed") {
+                sendToParent("DISPLAY_ERROR", {
+                    message: "Something went wrong parsing settings",
+                });
             }
         }
         return;
         // eslint-disable-next-line react-hooks/exhaustive-deps
-    }, [data.handle, parentConnection, storefrontSettingsSchema]);
+    }, [data.handle, sendToParent, storefrontSettingsSchema]);
+    // Update the ref whenever pathname changes
     useEffect(() => {
-        if (!isPreview ||
-            !windowLocationRef.current?.pathname ||
-            !shouldConnectToParent)
+        currentPathRef.current = pathname;
+    }, [pathname]);
+    // Tell the parent window about the current route
+    useEffect(() => {
+        if (!hasInit || !currentPathRef.current)
             return;
-        const connection = connectToParent({
-            methods: {
-                routeToPage(path) {
-                    navigate(path);
-                },
-                scrollToSection(sectionId) {
-                    const sectionEl = document.querySelector(`[data-comp-id="${sectionId}"]`);
-                    if (sectionEl)
-                        sectionEl.scrollIntoView({ behavior: "smooth" });
-                },
-                setPageData(content) {
-                    setContent(content);
-                },
-                setStorefrontSettings(settings) {
-                    setSiteSettings({ data: { siteSettings: { settings } } });
-                },
-            },
-        });
-        connection.promise.then((parent) => {
-            const { template, templateType, handle, title, description } = data;
-            parent.sendStorefrontSettings();
-            parent.setCurrentRoute({
-                environment,
-                currentPath: windowLocationRef.current?.pathname,
-                template,
-                templateType,
-                handle,
-                title,
-                description,
-            });
-            setParentConnection(parent);
+        const { template, templateType, handle, title, description } = data;
+        sendToParent("SET_CURRENT_ROUTE", {
+            environment,
+            currentPath: currentPathRef.current,
+            template,
+            templateType,
+            handle,
+            title,
+            description,
         });
-        return () => connection.destroy();
-    }, [
-        shouldConnectToParent,
-        data.handle,
-        data.title,
-        data.description,
-        data.template,
-        data.templateType,
-    ]);
+    }, [hasInit, environment, data.handle, sendToParent]);
+    // Refresh sections and storefront settings schema
     useEffect(() => {
-        if (!isPreview)
+        if (!isPreview || !hasInit)
             return;
         refreshSections();
         refreshStorefrontSettingsSchema();
@@ -122,6 +196,7 @@ export const useCustomizerShell = ({ environment, sectionComponents, storefrontS
         refreshSections,
         refreshStorefrontSettingsSchema,
         sectionComponents,
+        hasInit,
     ]);
     if (!isPreview) {
         return {
@@ -132,3 +207,13 @@ export const useCustomizerShell = ({ environment, sectionComponents, storefrontS
         return { content };
     }, [content]);
 };
+const useCanConnectCheck = ({ isPreview }) => {
+    const [canConnect, setCanConnect] = useState(false);
+    useEffect(() => {
+        const isIframe = window.self !== window.top;
+        if (!isIframe || !isPreview)
+            return;
+        setCanConnect(isIframe);
+    }, [isPreview]);
+    return canConnect;
+};

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = "0.1.4";
+export const VERSION = "2.0.0";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pack/react",
   "description": "React",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "engines": {
@@ -12,7 +12,7 @@
   },
   "scripts": {
     "clean": "npx rimraf dist",
-    "build": "npx tsc",
+    "build": "node scripts/build.js",
     "test": "npx vitest run",
     "test:watch": "npx vitest"
   },
@@ -30,7 +30,5 @@
     "react": "^18.0.0",
     "react-dom": "^18.0.0"
   },
-  "dependencies": {
-    "penpal": "^6.2.2"
-  }
+  "dependencies": {}
 }