@shopfront/bridge 2.0.1 → 2.0.4

package/lib/Mocks/MockApplication.js

@@ -1,27 +1,5 @@
 import { isDirectShopfrontEvent, ToShopfront, } from "../ApplicationEvents.js";
 import { BaseApplication } from "../BaseApplication.js";
-import { AudioPermissionChange } from "../Events/AudioPermissionChange.js";
-import { AudioReady } from "../Events/AudioReady.js";
-import { FormatIntegratedProduct } from "../Events/FormatIntegratedProduct.js";
-import { FulfilmentCollectOrder } from "../Events/FulfilmentCollectOrder.js";
-import { FulfilmentCompleteOrder } from "../Events/FulfilmentCompleteOrder.js";
-import { FulfilmentGetOrder } from "../Events/FulfilmentGetOrder.js";
-import { FulfilmentOrderApproval } from "../Events/FulfilmentOrderApproval.js";
-import { FulfilmentProcessOrder } from "../Events/FulfilmentProcessOrder.js";
-import { FulfilmentVoidOrder } from "../Events/FulfilmentVoidOrder.js";
-import { GiftCardCodeCheck } from "../Events/GiftCardCodeCheck.js";
-import { InternalPageMessage } from "../Events/InternalPageMessage.js";
-import { PaymentMethodsEnabled } from "../Events/PaymentMethodsEnabled.js";
-import { Ready } from "../Events/Ready.js";
-import { RegisterChanged } from "../Events/RegisterChanged.js";
-import { RequestButtons } from "../Events/RequestButtons.js";
-import { RequestCustomerListOptions } from "../Events/RequestCustomerListOptions.js";
-import { RequestSaleKeys } from "../Events/RequestSaleKeys.js";
-import { RequestSellScreenOptions } from "../Events/RequestSellScreenOptions.js";
-import { RequestSettings } from "../Events/RequestSettings.js";
-import { RequestTableColumns } from "../Events/RequestTableColumns.js";
-import { SaleComplete } from "../Events/SaleComplete.js";
-import { UIPipeline } from "../Events/UIPipeline.js";
 import ActionEventRegistrar from "../Utilities/ActionEventRegistrar.js";
 import { MockCurrentSale } from "./APIs/Sale/MockCurrentSale.js";
 import { MockDatabase } from "./Database/MockDatabase.js";
@@ -32,7 +10,7 @@ export class MockApplication extends BaseApplication {
         /**
          * Handles an application event
          */
-        this.handleEvent = (event, data, id) => {
+        this.handleEvent = async (event, data, id) => {
             if (event === "READY") {
                 this.isReady = true;
                 this.key = data.key;
@@ -66,7 +44,7 @@ export class MockApplication extends BaseApplication {
                 // Handled elsewhere
                 return;
             }
-            this.emit(event, data, id);
+            await this.emit(event, data, id);
         };
         /**
          * Updates the cached location data
@@ -95,21 +73,18 @@ export class MockApplication extends BaseApplication {
     /**
      * Calls any registered listeners for the received event
      */
-    emit(event, data = {}, id) {
+    async emit(event, data = {}, id) {
         if (isDirectShopfrontEvent(event)) {
             const listeners = this.directListeners[event];
             if (typeof listeners === "undefined") {
-                // Don't need to do anything here
-                return;
+                return this.bridge.sendMessage(ToShopfront.NOT_LISTENING_TO_EVENT);
             }
             const results = [];
             for (const e of listeners.values()) {
-                results.push(e());
+                results.push(e.emit(data));
             }
-            return Promise.all(results)
-                .then(() => {
-                // Ensure void is returned
-            });
+            await Promise.all(results);
+            return;
         }
         const results = [];
         if (typeof this.listeners[event] === "undefined") {
@@ -124,137 +99,9 @@ export class MockApplication extends BaseApplication {
         for (const e of this.listeners[event].values()) {
             results.push(e.emit(data, bridge));
         }
+        await Promise.allSettled(results);
         // The responses have been removed as we don't currently need them
     }
-    /**
-     * @inheritDoc
-     */
-    addEventListener(event, callback) {
-        if (isDirectShopfrontEvent(event)) {
-            if (typeof this.directListeners[event] === "undefined") {
-                this.directListeners[event] = new Set();
-            }
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            this.directListeners[event].add(callback);
-            return;
-        }
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        let c;
-        switch (event) {
-            case "READY":
-                c = new Ready(callback);
-                this.listeners[event].set(callback, c);
-                break;
-            case "REQUEST_SETTINGS":
-                c = new RequestSettings(callback);
-                this.listeners[event].set(callback, c);
-                break;
-            case "REQUEST_BUTTONS":
-                c = new RequestButtons(callback);
-                this.listeners[event].set(callback, c);
-                break;
-            case "REQUEST_TABLE_COLUMNS":
-                c = new RequestTableColumns(callback);
-                this.listeners[event].set(callback, c);
-                break;
-            case "REQUEST_SELL_SCREEN_OPTIONS":
-                c = new RequestSellScreenOptions(callback);
-                this.listeners[event].set(callback, c);
-                break;
-            case "INTERNAL_PAGE_MESSAGE":
-                c = new InternalPageMessage(callback, this);
-                this.listeners[event].set(callback, c);
-                break;
-            case "REGISTER_CHANGED":
-                c = new RegisterChanged(callback);
-                this.listeners[event].set(callback, c);
-                break;
-            case "REQUEST_CUSTOMER_LIST_OPTIONS":
-                c = new RequestCustomerListOptions(callback);
-                this.listeners[event].set(callback, c);
-                break;
-            case "FORMAT_INTEGRATED_PRODUCT":
-                c = new FormatIntegratedProduct(callback);
-                this.listeners[event].set(callback, c);
-                break;
-            case "REQUEST_SALE_KEYS":
-                c = new RequestSaleKeys(callback);
-                this.listeners[event].set(callback, c);
-                break;
-            case "SALE_COMPLETE":
-                c = new SaleComplete(callback);
-                this.listeners[event].set(callback, c);
-                break;
-            case "UI_PIPELINE":
-                c = new UIPipeline(callback);
-                this.listeners[event].set(callback, c);
-                break;
-            case "PAYMENT_METHODS_ENABLED":
-                c = new PaymentMethodsEnabled(callback);
-                this.listeners[event].set(callback, c);
-                break;
-            case "AUDIO_READY":
-                c = new AudioReady(callback);
-                this.listeners[event].set(callback, c);
-                break;
-            case "AUDIO_PERMISSION_CHANGE":
-                c = new AudioPermissionChange(callback);
-                this.listeners[event].set(callback, c);
-                break;
-            case "FULFILMENT_GET_ORDER":
-                if (this.listeners[event].size !== 0) {
-                    throw new TypeError("Application already has 'FULFILMENT_GET_ORDER' event listener registered.");
-                }
-                c = new FulfilmentGetOrder(callback);
-                this.listeners[event].set(callback, c);
-                break;
-            case "FULFILMENT_VOID_ORDER":
-                c = new FulfilmentVoidOrder(callback);
-                this.listeners[event].set(callback, c);
-                break;
-            case "FULFILMENT_PROCESS_ORDER":
-                c = new FulfilmentProcessOrder(callback);
-                this.listeners[event].set(callback, c);
-                break;
-            case "FULFILMENT_ORDER_APPROVAL":
-                c = new FulfilmentOrderApproval(callback);
-                this.listeners[event].set(callback, c);
-                break;
-            case "FULFILMENT_ORDER_COLLECTED":
-                c = new FulfilmentCollectOrder(callback);
-                this.listeners[event].set(callback, c);
-                break;
-            case "FULFILMENT_ORDER_COMPLETED":
-                c = new FulfilmentCompleteOrder(callback);
-                this.listeners[event].set(callback, c);
-                break;
-            case "GIFT_CARD_CODE_CHECK":
-                c = new GiftCardCodeCheck(callback);
-                this.listeners[event].set(callback, c);
-                break;
-        }
-        if (typeof c === "undefined") {
-            throw new TypeError(`${event} has not been defined`);
-        }
-        if (event === "READY" && this.isReady) {
-            c = c;
-            c.emit({
-                outlet: this.outlet,
-                register: this.register,
-                user: this.user,
-            });
-        }
-    }
-    /**
-     * @inheritDoc
-     */
-    removeEventListener(event, callback) {
-        if (isDirectShopfrontEvent(event)) {
-            this.directListeners[event]?.delete(callback);
-            return;
-        }
-        this.listeners[event].delete(callback);
-    }
     /**
      * @inheritDoc
      */
@@ -319,7 +166,6 @@ export class MockApplication extends BaseApplication {
         const payments = sale.getPayments();
         let totalPaid = 0;
         for (const payment of payments) {
-            // TODO: Double check this is still the case
             if (payment.getCashout()) {
                 return {
                     success: false,
@@ -463,7 +309,7 @@ export class MockApplication extends BaseApplication {
     /**
      * Mocks an event being fired from Shopfront
      */
-    fireEvent(event, ...data) {
+    async fireEvent(event, ...data) {
         let params;
         if (data.length > 0) {
             if (typeof data[0] === "object") {
@@ -474,9 +320,10 @@ export class MockApplication extends BaseApplication {
             else {
                 params = data[0];
             }
-            // We don't care about the Bridge parameter, as that is passed in by the `emit` method
+            // We don't care about the Bridge param in FromShopfront events, as that is passed in by the `emit` method
+            // Direct events do not pass in a second parameter
         }
-        this.emit(event, params, "");
+        await this.emit(event, params, "");
     }
     ;
 }

package/lib/Mocks/MockBridge.d.ts

@@ -19,7 +19,7 @@ export declare class MockBridge extends BaseBridge {
     /**
      * @inheritDoc
      */
-    sendMessage(type: ApplicationEvents.ToShopfront, data?: unknown, id?: string): void;
+    sendMessage(type: ApplicationEvents.ToShopfront, data?: unknown, id?: string): Promise<void>;
     /**
      * @inheritDoc
      */

package/lib/Mocks/MockBridge.js

@@ -4,6 +4,8 @@ export class MockBridge extends BaseBridge {
     constructor(key, url) {
         super(key, url);
         this.isReady = false;
+        this.registerListeners();
+        this.sendMessage(ApplicationEvents.ToShopfront.READY);
     }
     /**
      * @inheritDoc
@@ -26,7 +28,7 @@ export class MockBridge extends BaseBridge {
     /**
      * @inheritDoc
      */
-    sendMessage(type, data, id) {
+    async sendMessage(type, data, id) {
         if (type === ApplicationEvents.ToShopfront.READY) {
             if (typeof data !== "undefined") {
                 throw new TypeError("The `data` parameter must be undefined when requesting ready state");

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@shopfront/bridge",
-    "version": "2.0.1",
+    "version": "2.0.4",
     "main": "./lib/index.js",
     "license": "ISC",
     "description": "The bridge used to embed your application within Shopfront",

package/.idea/codeStyles/Project.xml

@@ -1,10 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <code_scheme name="Project" version="173">
-    <JSCodeStyleSettings version="0">
-      <option name="FORCE_SEMICOLON_STYLE" value="true" />
-    </JSCodeStyleSettings>
-    <TypeScriptCodeStyleSettings version="0">
-      <option name="FORCE_SEMICOLON_STYLE" value="true" />
-    </TypeScriptCodeStyleSettings>
-  </code_scheme>
-</component>

package/.idea/codeStyles/codeStyleConfig.xml

@@ -1,5 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <state>
-    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
-  </state>
-</component>

package/.idea/git_toolbox_blame.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="GitToolBoxBlameSettings">
-    <option name="version" value="2" />
-  </component>
-</project>

package/.idea/git_toolbox_prj.xml

@@ -1,15 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="GitToolBoxProjectSettings">
-    <option name="commitMessageIssueKeyValidationOverride">
-      <BoolValueOverride>
-        <option name="enabled" value="true" />
-      </BoolValueOverride>
-    </option>
-    <option name="commitMessageValidationEnabledOverride">
-      <BoolValueOverride>
-        <option name="enabled" value="true" />
-      </BoolValueOverride>
-    </option>
-  </component>
-</project>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -1,11 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <profile version="1.0">
-    <option name="myName" value="Project Default" />
-    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
-    <inspection_tool class="ImplicitTypeConversion" enabled="true" level="WARNING" enabled_by_default="true">
-      <option name="BITS" value="1720" />
-      <option name="FLAG_EXPLICIT_CONVERSION" value="true" />
-      <option name="IGNORE_NODESET_TO_BOOLEAN_VIA_STRING" value="true" />
-    </inspection_tool>
-  </profile>
-</component>

package/.idea/jsLinters/eslint.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="EslintConfiguration">
-    <option name="fix-on-save" value="true" />
-  </component>
-</project>

package/.idea/misc.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="TaskProjectConfiguration">
-    <server type="JIRA" url="https://onshopfront.atlassian.net" />
-  </component>
-</project>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/shopfront-embedded-bridge.iml" filepath="$PROJECT_DIR$/.idea/shopfront-embedded-bridge.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/php.xml

@@ -1,33 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="MessDetectorOptionsConfiguration">
-    <option name="transferred" value="true" />
-  </component>
-  <component name="PHPCSFixerOptionsConfiguration">
-    <option name="transferred" value="true" />
-  </component>
-  <component name="PHPCodeSnifferOptionsConfiguration">
-    <option name="transferred" value="true" />
-  </component>
-  <component name="PhpCodeSniffer">
-    <phpcs_settings>
-      <phpcs_by_interpreter asDefaultInterpreter="true" interpreter_id="bb870563-23b2-4cfc-9ac5-70a3316d78e5" timeout="30000" />
-    </phpcs_settings>
-  </component>
-  <component name="PhpStan">
-    <PhpStan_settings>
-      <phpstan_by_interpreter asDefaultInterpreter="true" interpreter_id="bb870563-23b2-4cfc-9ac5-70a3316d78e5" timeout="60000" />
-    </PhpStan_settings>
-  </component>
-  <component name="PhpStanOptionsConfiguration">
-    <option name="transferred" value="true" />
-  </component>
-  <component name="Psalm">
-    <Psalm_settings>
-      <psalm_fixer_by_interpreter asDefaultInterpreter="true" interpreter_id="bb870563-23b2-4cfc-9ac5-70a3316d78e5" timeout="60000" />
-    </Psalm_settings>
-  </component>
-  <component name="PsalmOptionsConfiguration">
-    <option name="transferred" value="true" />
-  </component>
-</project>

package/.idea/shopfront-embedded-bridge.iml

@@ -1,10 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <excludeFolder url="file://$MODULE_DIR$/lib" />
-    </content>
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>