@shopfront/bridge 1.11.0 → 1.12.0

package/.idea/misc.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="JavaScriptSettings">
+    <option name="languageLevel" value="ES6" />
+  </component>
+  <component name="NodePackageJsonFileManager">
+    <packageJsonPaths />
+  </component>
+</project>

package/.idea/modules.xml

@@ -2,7 +2,7 @@
 <project version="4">
   <component name="ProjectModuleManager">
     <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/embedded-bridge.iml" filepath="$PROJECT_DIR$/.idea/embedded-bridge.iml" />
+      <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

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="PhpProjectSharedConfiguration" php_language_level="7.2" />
+</project>

package/.idea/{embedded-bridge.iml → shopfront-embedded-bridge.iml}

@@ -1,9 +1,7 @@
 <?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>
+    <content url="file://$MODULE_DIR$" />
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />
   </component>

package/lib/Application.d.ts

@@ -1,5 +1,5 @@
 import { Bridge } from "./Bridge";
-import { DirectShopfrontEvent, FromShopfront, FromShopfrontCallbacks, FromShopfrontInternal, RegisterChangedEvent } from "./ApplicationEvents";
+import { DirectShopfrontEvent, FromShopfront, FromShopfrontCallbacks, FromShopfrontInternal, RegisterChangedEvent, SoundEvents } from "./ApplicationEvents";
 import { Serializable } from "./Common/Serializable";
 import { BaseEmitableEvent } from "./EmitableEvents/BaseEmitableEvent";
 import { Sale } from "./APIs/CurrentSale";
@@ -65,6 +65,38 @@ export declare class Application {
         user: string | null;
     }>;
     printReceipt(content: string): void;
+    protected dataIsAudioResponse(data: Record<string, unknown>): data is {
+        requestId: string;
+        success: boolean;
+        message?: string;
+    };
+    protected sendAudioRequest(type: SoundEvents, data?: unknown): Promise<{
+        success: boolean;
+        message?: string;
+    }>;
+    /**
+     * Requests permission from the user to be able to play audio
+     */
+    requestAudioPermission(): Promise<{
+        success: boolean;
+        message?: string;
+    }>;
+    /**
+     * Requests shopfront to preload audio so that it can be pre-cached before being played
+     * @param url
+     */
+    audioPreload(url: string): Promise<{
+        success: boolean;
+        message?: string;
+    }>;
+    /**
+     * Requests the sound to be played
+     * @param url
+     */
+    audioPlay(url: string): Promise<{
+        success: boolean;
+        message?: string;
+    }>;
     protected dataIsOption<TValueType>(data: Record<string, unknown>): data is {
         requestId: string;
         option: string;

package/lib/Application.js

@@ -23,6 +23,7 @@ const RequestSaleKeys_1 = require("./Events/RequestSaleKeys");
 const SaleComplete_1 = require("./Events/SaleComplete");
 const UIPipeline_1 = require("./Events/UIPipeline");
 const PaymentMethodsEnabled_1 = require("./Events/PaymentMethodsEnabled");
+const AudioPermissionChange_1 = require("./Events/AudioPermissionChange");
 // noinspection JSUnusedGlobalSymbols
 class Application {
     constructor(bridge) {
@@ -40,6 +41,7 @@ class Application {
             SALE_COMPLETE: new Map(),
             UI_PIPELINE: new Map(),
             PAYMENT_METHODS_ENABLED: new Map(),
+            AUDIO_PERMISSION_CHANGE: new Map(),
         };
         this.directListeners = {};
         this.handleEvent = (event, data, id) => {
@@ -70,7 +72,8 @@ class Application {
             else if (event === "RESPONSE_CURRENT_SALE" ||
                 event === "RESPONSE_DATABASE_REQUEST" ||
                 event === "RESPONSE_LOCATION" ||
-                event === "RESPONSE_OPTION") {
+                event === "RESPONSE_OPTION" ||
+                event === "RESPONSE_AUDIO_REQUEST") {
                 // Handled elsewhere
                 return;
             }
@@ -236,6 +239,10 @@ class Application {
                 c = new PaymentMethodsEnabled_1.PaymentMethodsEnabled(callback);
                 this.listeners[event].set(callback, c);
                 break;
+            case "AUDIO_PERMISSION_CHANGE":
+                c = new AudioPermissionChange_1.AudioPermissionChange(callback);
+                this.listeners[event].set(callback, c);
+                break;
         }
         if (typeof c === "undefined") {
             throw new TypeError(`${event} has not been defined`);
@@ -375,6 +382,62 @@ class Application {
             type: "text",
         });
     }
+    dataIsAudioResponse(data) {
+        return typeof data.requestId === "string" &&
+            typeof data.success === "boolean" && (typeof data.message === "string" ||
+            typeof data.message === "undefined");
+    }
+    sendAudioRequest(type, data) {
+        const request = `AudioRequest-${type}-${Date.now().toString()}`;
+        const promise = new Promise(res => {
+            const listener = (event, data) => {
+                if (event !== "RESPONSE_AUDIO_REQUEST") {
+                    return;
+                }
+                if (!this.dataIsAudioResponse(data)) {
+                    return;
+                }
+                if (data.requestId !== request) {
+                    return;
+                }
+                this.bridge.removeEventListener(listener);
+                res({
+                    success: data.success,
+                    message: data.message,
+                });
+            };
+            this.bridge.addEventListener(listener);
+        });
+        this.bridge.sendMessage(type, {
+            requestId: request,
+            data,
+        });
+        return promise;
+    }
+    /**
+     * Requests permission from the user to be able to play audio
+     */
+    requestAudioPermission() {
+        return this.sendAudioRequest(ApplicationEvents_1.ToShopfront.AUDIO_REQUEST_PERMISSION);
+    }
+    /**
+     * Requests shopfront to preload audio so that it can be pre-cached before being played
+     * @param url
+     */
+    audioPreload(url) {
+        return this.sendAudioRequest(ApplicationEvents_1.ToShopfront.AUDIO_PRELOAD, {
+            url
+        });
+    }
+    /**
+     * Requests the sound to be played
+     * @param url
+     */
+    audioPlay(url) {
+        return this.sendAudioRequest(ApplicationEvents_1.ToShopfront.AUDIO_PLAY, {
+            url
+        });
+    }
     dataIsOption(data) {
         return typeof data.requestId === "string" && typeof data.option === "string";
     }

package/lib/ApplicationEvents.d.ts

@@ -17,6 +17,7 @@ import { RequestSaleKeys } from "./Events/RequestSaleKeys";
 import { CompletedSale, SaleComplete } from "./Events/SaleComplete";
 import { UIPipeline } from "./Events/UIPipeline";
 import { PaymentMethodsEnabled } from "./Events/PaymentMethodsEnabled";
+import { AudioPermissionChange } from "./Events/AudioPermissionChange";
 export declare enum ToShopfront {
     READY = "READY",
     SERIALIZED = "SERIALIZED",
@@ -38,12 +39,16 @@ export declare enum ToShopfront {
     REDIRECT = "REDIRECT",
     GET_OPTION = "GET_OPTION",
     RESPONSE_UI_PIPELINE = "RESPONSE_UI_PIPELINE",
+    AUDIO_REQUEST_PERMISSION = "AUDIO_REQUEST_PERMISSION",
+    AUDIO_PRELOAD = "AUDIO_PRELOAD",
+    AUDIO_PLAY = "AUDIO_PLAY",
     SELL_SCREEN_OPTION_CHANGE = "SELL_SCREEN_OPTION_CHANGE",
     INTERNAL_PAGE_MESSAGE = "INTERNAL_PAGE_MESSAGE",
     TABLE_UPDATE = "TABLE_UPDATE",
     PIPELINE_TRIGGER = "PIPELINE_TRIGGER",
     SELL_SCREEN_PROMOTION_APPLICABLE = "SELL_SCREEN_PROMOTION_APPLICABLE"
 }
+export declare type SoundEvents = ToShopfront.AUDIO_REQUEST_PERMISSION | ToShopfront.AUDIO_PRELOAD | ToShopfront.AUDIO_PLAY;
 export interface FromShopfrontReturns {
     READY: void;
     REQUEST_SETTINGS: {
@@ -79,12 +84,18 @@ export interface FromShopfrontReturns {
         outlet: string | null;
         user: string | null;
     };
+    RESPONSE_AUDIO_REQUEST: {
+        requestId: string;
+        success: boolean;
+        message?: string;
+    };
     FORMAT_INTEGRATED_PRODUCT: FormatIntegratedProductEvent;
     REQUEST_CUSTOMER_LIST_OPTIONS: Array<SellScreenCustomerListOption>;
     REQUEST_SALE_KEYS: Array<SaleKey>;
     SALE_COMPLETE: void;
     UI_PIPELINE: Array<UIPipelineResponse>;
     PAYMENT_METHODS_ENABLED: Array<SellScreenPaymentMethod>;
+    AUDIO_PERMISSION_CHANGE: void;
 }
 export interface InternalPageMessageEvent {
     method: "REQUEST_SETTINGS" | "REQUEST_SELL_SCREEN_OPTIONS" | "EXTERNAL_APPLICATION";
@@ -103,6 +114,9 @@ export interface FormatIntegratedProductEvent {
 export interface SaleCompletedEvent {
     sale: CompletedSale;
 }
+export interface AudioPermissionChangeEvent {
+    permitted: boolean;
+}
 export declare type UIPipelineResponse = {
     name: string;
     content: string;
@@ -142,6 +156,7 @@ export interface FromShopfrontCallbacks {
     SALE_COMPLETE: (event: SaleCompletedEvent) => MaybePromise<FromShopfrontReturns["SALE_COMPLETE"]>;
     UI_PIPELINE: (event: Array<UIPipelineResponse>, context: UIPipelineContext) => MaybePromise<FromShopfrontReturns["UI_PIPELINE"]>;
     PAYMENT_METHODS_ENABLED: (event: Array<SellScreenPaymentMethod>, context: PaymentMethodEnabledContext) => MaybePromise<FromShopfrontReturns["PAYMENT_METHODS_ENABLED"]>;
+    AUDIO_PERMISSION_CHANGE: (event: AudioPermissionChangeEvent) => MaybePromise<FromShopfrontReturns["AUDIO_PERMISSION_CHANGE"]>;
 }
 export interface FromShopfront {
     READY: Ready;
@@ -158,6 +173,7 @@ export interface FromShopfront {
     REQUEST_SALE_KEYS: RequestSaleKeys;
     UI_PIPELINE: UIPipeline;
     PAYMENT_METHODS_ENABLED: PaymentMethodsEnabled;
+    AUDIO_PERMISSION_CHANGE: AudioPermissionChange;
 }
 export declare const directShopfrontEvents: readonly ["SALE_ADD_PRODUCT", "SALE_REMOVE_PRODUCT", "SALE_UPDATE_PRODUCTS", "SALE_CHANGE_QUANTITY", "SALE_ADD_CUSTOMER", "SALE_REMOVE_CUSTOMER", "SALE_CLEAR"];
 export declare type DirectShopfrontEvent = typeof directShopfrontEvents[number];
@@ -168,4 +184,5 @@ export interface FromShopfrontInternal {
     RESPONSE_DATABASE_REQUEST: "RESPONSE_DATABASE_REQUEST";
     RESPONSE_LOCATION: "RESPONSE_LOCATION";
     RESPONSE_OPTION: "RESPONSE_OPTION";
+    RESPONSE_AUDIO_REQUEST: "RESPONSE_AUDIO_REQUEST";
 }

package/lib/ApplicationEvents.js

@@ -23,6 +23,10 @@ var ToShopfront;
     ToShopfront["REDIRECT"] = "REDIRECT";
     ToShopfront["GET_OPTION"] = "GET_OPTION";
     ToShopfront["RESPONSE_UI_PIPELINE"] = "RESPONSE_UI_PIPELINE";
+    // Audio Events
+    ToShopfront["AUDIO_REQUEST_PERMISSION"] = "AUDIO_REQUEST_PERMISSION";
+    ToShopfront["AUDIO_PRELOAD"] = "AUDIO_PRELOAD";
+    ToShopfront["AUDIO_PLAY"] = "AUDIO_PLAY";
     // Emitable Events
     ToShopfront["SELL_SCREEN_OPTION_CHANGE"] = "SELL_SCREEN_OPTION_CHANGE";
     ToShopfront["INTERNAL_PAGE_MESSAGE"] = "INTERNAL_PAGE_MESSAGE";

package/lib/Events/AudioPermissionChange.d.ts

@@ -0,0 +1,6 @@
+import { BaseEvent } from "./BaseEvent";
+import { AudioPermissionChangeEvent, FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents";
+export declare class AudioPermissionChange extends BaseEvent<AudioPermissionChangeEvent> {
+    constructor(callback: FromShopfrontCallbacks["AUDIO_PERMISSION_CHANGE"]);
+    emit(data: AudioPermissionChangeEvent): Promise<FromShopfrontReturns["AUDIO_PERMISSION_CHANGE"]>;
+}

package/lib/Events/AudioPermissionChange.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AudioPermissionChange = void 0;
+const BaseEvent_1 = require("./BaseEvent");
+class AudioPermissionChange extends BaseEvent_1.BaseEvent {
+    constructor(callback) {
+        super(callback);
+    }
+    async emit(data) {
+        this.callback(data, undefined);
+    }
+}
+exports.AudioPermissionChange = AudioPermissionChange;

package/package.json

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

package/.idea/inspectionProfiles/Project_Default.xml

@@ -1,6 +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" />
-  </profile>
-</component>