@shopfront/bridge 3.0.7 → 3.0.8--canary.26.3363b8d.0

package/README.md

@@ -17,14 +17,13 @@ The setup of the frame is the default way of use, and nothing special is require
 
 ### JavaScript Communicator
 
-Shopfront expects an ES Module which exports the following three functions:
+Shopfront expects an ES Module which exports either the application or the following three functions:
 
 - `execute`
 - `registerSendMessage`
 - `onReceiveMessage`
 
-The application exposes methods allowing your application to work directly with this, all you need to do is
-export them:
+Exporting the application is the easiest and recommended option, make sure it's exported as default:
 
 ```javascript
 import { Bridge } from "@shopfront/bridge";
@@ -34,13 +33,10 @@ const application = Bridge.createApplication({
     communicator: "javascript",
 });
 
-export const execute = application.communicator.execute;
-export const registerSendMessage = application.communicator.registerSendMessage;
-export const onReceiveMessage = application.communicator.onReceiveMessage;
+export default application;
 ```
-
-Alternatively, you can export the application as the default item and Shopfront will automatically infer the functions 
-from it.
+If you're wanting to do something custom or don't want to expose the application to Shopfront, then you can instead
+expose the methods individually from the application:
 
 ```javascript
 import { Bridge } from "@shopfront/bridge";
@@ -50,5 +46,15 @@ const application = Bridge.createApplication({
     communicator: "javascript",
 });
 
-export default application;
+export const execute = application.communicator.execute;
+export const registerSendMessage = application.communicator.registerSendMessage;
+export const onReceiveMessage = application.communicator.onReceiveMessage;
 ```
+
+> [!NOTE]
+> When exporting the methods individually, you may receive the TypeScript error "TS2742: The inferred type of 
+> onReceiveMessage cannot be named without a reference to Bridge". You can resolve this by specifying the type 
+> directly:
+> ```javascript
+> export const onReceiveMessage: typeof application.communicator.onReceiveMessage = application.communicator.onReceiveMessage;
+> ```