@shopfront/bridge 3.0.5 → 3.0.6

package/README.md

@@ -38,3 +38,17 @@ export const execute = application.communicator.execute;
 export const registerSendMessage = application.communicator.registerSendMessage;
 export const onReceiveMessage = application.communicator.onReceiveMessage;
 ```
+
+Alternatively, you can export the application as the default item and Shopfront will automatically infer the functions 
+from it.
+
+```javascript
+import { Bridge } from "@shopfront/bridge";
+
+const application = Bridge.createApplication({
+    id          : "<< my client id >>",
+    communicator: "javascript",
+});
+
+export default application;
+```

package/lib/Bridge.d.ts

@@ -17,11 +17,10 @@ type JavaScriptSendMessageCallback = (message: {
     data: unknown;
     id?: string;
 }) => void;
-export type JavaScriptReceiveMessageCallback = (type: keyof FromShopfront | keyof FromShopfrontInternal, data: Record<string, unknown>, id: string) => void;
 export interface JavaScriptCommunicatorExports {
     execute: () => void;
     registerSendMessage: (callback: JavaScriptSendMessageCallback) => void;
-    onReceiveMessage: JavaScriptReceiveMessageCallback;
+    onReceiveMessage: (type: keyof FromShopfront | keyof FromShopfrontInternal, data: Record<string, unknown>, id: string) => void;
 }
 export declare class Bridge extends BaseBridge {
     protected communicateVia: "frame" | "javascript";