@shopfront/bridge 1.20.2 → 1.20.5

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,29 @@
+name: Pack and Distribute
+on:
+    release:
+        types: [created]
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: '20.x'
+            - run: npm ci
+            - run: npm run-script build
+    publish-npm:
+        needs: build
+        runs-on: ubuntu-latest
+        permissions:
+            id-token: write
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: '20.x'
+                  registry-url: 'https://registry.npmjs.org/'
+            - run: npm ci
+            - run: npm publish --provenance --access public
+              env:
+                  NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

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

@@ -7,6 +7,7 @@
     <option name="transferred" value="true" />
   </component>
   <component name="PHPCodeSnifferOptionsConfiguration">
+    <option name="highlightLevel" value="WARNING" />
     <option name="transferred" value="true" />
   </component>
   <component name="PhpStanOptionsConfiguration">

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/.idea/vcs.xml

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

package/lib/APIs/Fulfilment/FulfilmentTypes.d.ts

@@ -30,7 +30,7 @@ export interface OrderItem {
         id?: number;
         barcode?: "auto" | number;
         mdbId?: number;
-        supplierCodes?: number;
+        supplierCode?: number;
         defaultTo: number;
     };
     price: number;

package/lib/Application.js

@@ -32,6 +32,7 @@ const FulfilmentCompleteOrder_1 = require("./Events/FulfilmentCompleteOrder");
 const CurrentSale_1 = require("./APIs/Sale/CurrentSale");
 const SaleCreate_1 = require("./Utilities/SaleCreate");
 const AudioReady_1 = require("./Events/AudioReady");
+const GiftCardCodeCheck_1 = require("./Events/GiftCardCodeCheck");
 class ShopfrontTokenDecodingError extends Error {
 }
 exports.ShopfrontTokenDecodingError = ShopfrontTokenDecodingError;
@@ -63,6 +64,7 @@ class Application {
             FULFILMENT_ORDER_APPROVAL: new Map(),
             FULFILMENT_ORDER_COLLECTED: new Map(),
             FULFILMENT_ORDER_COMPLETED: new Map(),
+            GIFT_CARD_CODE_CHECK: new Map(),
         };
         this.directListeners = {};
         this.handleEvent = (event, data, id) => {
@@ -188,6 +190,12 @@ class Application {
                     .then(res => {
                     return UIPipeline_1.UIPipeline.respond(this.bridge, res.flat(), id);
                 });
+            case "GIFT_CARD_CODE_CHECK":
+                results = results;
+                return Promise.all(results)
+                    .then(res => {
+                    return GiftCardCodeCheck_1.GiftCardCodeCheck.respond(this.bridge, res[0], id);
+                });
             case "PAYMENT_METHODS_ENABLED":
                 results = results;
                 return Promise.all(results)
@@ -303,6 +311,10 @@ class Application {
                 c = new FulfilmentCompleteOrder_1.FulfilmentCompleteOrder(callback);
                 this.listeners[event].set(callback, c);
                 break;
+            case "GIFT_CARD_CODE_CHECK":
+                c = new GiftCardCodeCheck_1.GiftCardCodeCheck(callback);
+                this.listeners[event].set(callback, c);
+                break;
         }
         if (typeof c === "undefined") {
             throw new TypeError(`${event} has not been defined`);

package/lib/ApplicationEvents.d.ts

@@ -27,6 +27,7 @@ import { FulfilmentCollectOrder } from "./Events/FulfilmentCollectOrder";
 import { FulfilmentCompleteOrder } from "./Events/FulfilmentCompleteOrder";
 import { Sale } from "./APIs/Sale";
 import { AudioReady } from "./Events/AudioReady";
+import { GiftCardCodeCheck } from "./Events/GiftCardCodeCheck";
 export declare enum ToShopfront {
     READY = "READY",
     SERIALIZED = "SERIALIZED",
@@ -48,6 +49,7 @@ export declare enum ToShopfront {
     REDIRECT = "REDIRECT",
     GET_OPTION = "GET_OPTION",
     RESPONSE_UI_PIPELINE = "RESPONSE_UI_PIPELINE",
+    RESPONSE_GIFT_CARD_CODE_CHECK = "RESPONSE_GIFT_CARD_CODE_CHECK",
     REQUEST_SECURE_KEY = "REQUEST_SECURE_KEY",
     ROTATE_SIGNING_KEY = "ROTATE_SIGNING_KEY",
     AUDIO_REQUEST_PERMISSION = "AUDIO_REQUEST_PERMISSION",
@@ -129,6 +131,10 @@ export interface FromShopfrontReturns {
         success: boolean;
         message?: string;
     };
+    GIFT_CARD_CODE_CHECK: {
+        code: string;
+        message: string | null;
+    };
 }
 export interface InternalPageMessageEvent {
     method: "REQUEST_SETTINGS" | "REQUEST_SELL_SCREEN_OPTIONS" | "EXTERNAL_APPLICATION";
@@ -141,6 +147,10 @@ export interface RegisterChangedEvent {
     outlet: null | string;
     user: null | string;
 }
+export interface GiftCardCodeCheckEvent {
+    code: string;
+    message: string | null;
+}
 export interface FormatIntegratedProductEvent {
     product: FormattedSaleProduct;
 }
@@ -205,6 +215,7 @@ export interface FromShopfrontCallbacks {
     FULFILMENT_ORDER_APPROVAL: (event: FulfilmentApprovalEvent) => MaybePromise<FromShopfrontReturns["FULFILMENT_ORDER_APPROVAL"]>;
     FULFILMENT_ORDER_COLLECTED: (id: string) => MaybePromise<FromShopfrontReturns["FULFILMENT_ORDER_COLLECTED"]>;
     FULFILMENT_ORDER_COMPLETED: (id: string) => MaybePromise<FromShopfrontReturns["FULFILMENT_ORDER_COMPLETED"]>;
+    GIFT_CARD_CODE_CHECK: (event: GiftCardCodeCheckEvent, context: unknown) => MaybePromise<FromShopfrontReturns["GIFT_CARD_CODE_CHECK"]>;
 }
 export interface FromShopfront {
     READY: Ready;
@@ -229,6 +240,7 @@ export interface FromShopfront {
     FULFILMENT_ORDER_APPROVAL: FulfilmentOrderApproval;
     FULFILMENT_ORDER_COLLECTED: FulfilmentCollectOrder;
     FULFILMENT_ORDER_COMPLETED: FulfilmentCompleteOrder;
+    GIFT_CARD_CODE_CHECK: GiftCardCodeCheck;
 }
 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];

package/lib/ApplicationEvents.js

@@ -23,6 +23,7 @@ var ToShopfront;
     ToShopfront["REDIRECT"] = "REDIRECT";
     ToShopfront["GET_OPTION"] = "GET_OPTION";
     ToShopfront["RESPONSE_UI_PIPELINE"] = "RESPONSE_UI_PIPELINE";
+    ToShopfront["RESPONSE_GIFT_CARD_CODE_CHECK"] = "RESPONSE_GIFT_CARD_CODE_CHECK";
     ToShopfront["REQUEST_SECURE_KEY"] = "REQUEST_SECURE_KEY";
     ToShopfront["ROTATE_SIGNING_KEY"] = "ROTATE_SIGNING_KEY";
     // Audio Events

package/lib/Events/CheckGiftCardCollision.d.ts

@@ -0,0 +1,14 @@
+import { BaseEvent } from "./BaseEvent";
+import { FromShopfrontCallbacks, FromShopfrontReturns, CheckGiftCardCodeCollisionEvent } from "../ApplicationEvents";
+import { Bridge } from "../Bridge";
+import { MaybePromise } from "../Utilities/MiscTypes";
+export declare class CheckGiftCardCollision extends BaseEvent<{
+    data: CheckGiftCardCodeCollisionEvent;
+}, MaybePromise<FromShopfrontReturns["GIFT_CARD_CODE_CHECK"]>, FromShopfrontReturns["GIFT_CARD_CODE_CHECK"], CheckGiftCardCodeCollisionEvent> {
+    constructor(callback: FromShopfrontCallbacks["GIFT_CARD_CODE_CHECK"]);
+    emit(data: {
+        data: CheckGiftCardCodeCollisionEvent;
+        context: undefined;
+    }): Promise<FromShopfrontReturns["GIFT_CARD_CODE_CHECK"]>;
+    static respond(bridge: Bridge, data: FromShopfrontReturns["GIFT_CARD_CODE_CHECK"], id: string): Promise<void>;
+}

package/lib/Events/CheckGiftCardCollision.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckGiftCardCollision = void 0;
+const BaseEvent_1 = require("./BaseEvent");
+const ApplicationEvents_1 = require("../ApplicationEvents");
+class CheckGiftCardCollision extends BaseEvent_1.BaseEvent {
+    constructor(callback) {
+        super(callback);
+    }
+    async emit(data) {
+        console.log("About to start Emit in Bridge" + Date.now());
+        const result = await this.callback(data.data, data.context);
+        console.log("Finished Emit" + Date.now());
+        if (typeof result !== "object") {
+            throw new TypeError("Callback must return an object");
+        }
+        return result;
+    }
+    static async respond(bridge, data, id) {
+        console.log("About to start Response in Bridge" + Date.now());
+        bridge.sendMessage(ApplicationEvents_1.ToShopfront.RESPONSE_CHECK_GIFT_CODE_COLLISION, data, id);
+        console.log("Finished Response" + Date.now());
+    }
+}
+exports.CheckGiftCardCollision = CheckGiftCardCollision;

package/lib/Events/GiftCardCodeCheck.d.ts

@@ -0,0 +1,14 @@
+import { BaseEvent } from "./BaseEvent";
+import { FromShopfrontCallbacks, FromShopfrontReturns, GiftCardCodeCheckEvent } from "../ApplicationEvents";
+import { Bridge } from "../Bridge";
+import { MaybePromise } from "../Utilities/MiscTypes";
+export declare class GiftCardCodeCheck extends BaseEvent<{
+    data: GiftCardCodeCheckEvent;
+}, MaybePromise<FromShopfrontReturns["GIFT_CARD_CODE_CHECK"]>, FromShopfrontReturns["GIFT_CARD_CODE_CHECK"], GiftCardCodeCheckEvent> {
+    constructor(callback: FromShopfrontCallbacks["GIFT_CARD_CODE_CHECK"]);
+    emit(data: {
+        data: GiftCardCodeCheckEvent;
+        context: undefined;
+    }): Promise<FromShopfrontReturns["GIFT_CARD_CODE_CHECK"]>;
+    static respond(bridge: Bridge, data: FromShopfrontReturns["GIFT_CARD_CODE_CHECK"], id: string): Promise<void>;
+}

package/lib/Events/GiftCardCodeCheck.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GiftCardCodeCheck = void 0;
+const BaseEvent_1 = require("./BaseEvent");
+const ApplicationEvents_1 = require("../ApplicationEvents");
+class GiftCardCodeCheck extends BaseEvent_1.BaseEvent {
+    constructor(callback) {
+        super(callback);
+    }
+    async emit(data) {
+        const result = await this.callback(data.data, data.context);
+        if (typeof result !== "object") {
+            throw new TypeError("Callback must return an object");
+        }
+        return result;
+    }
+    static async respond(bridge, data, id) {
+        bridge.sendMessage(ApplicationEvents_1.ToShopfront.RESPONSE_GIFT_CARD_CODE_CHECK, data, id);
+    }
+}
+exports.GiftCardCodeCheck = GiftCardCodeCheck;

package/package.json

@@ -1,14 +1,14 @@
 {
     "name": "@shopfront/bridge",
-    "version": "1.20.2",
+    "version": "1.20.5",
     "main": "./lib/index.js",
     "license": "ISC",
     "description": "The bridge used to embed your application within Shopfront",
     "homepage": "https://developer.onshopfront.com/documentation/Embedded/Introduction",
-    "bugs": "https://bitbucket.org/sasonline/shopfront-embedded-bridge/issues",
+    "bugs": "https://github.com/onshopfront/shopfront-embedded-bridge/issues",
     "repository": {
         "type": "git",
-        "url": "https://bitbucket.org/sasonline/shopfront-embedded-bridge.git"
+        "url": "https://github.com/onshopfront/shopfront-embedded-bridge.git"
     },
     "author": "Shopfront <api@shopfront.com.au> (https://shopfront.com.au)",
     "contributors": [

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/lib/APIs/CurrentSale/Exceptions.d.ts

@@ -1,6 +0,0 @@
-export declare class SaleCancelledError extends Error {
-    constructor();
-}
-export declare class InvalidSaleDeviceError extends Error {
-    constructor();
-}

package/lib/APIs/CurrentSale/Exceptions.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidSaleDeviceError = exports.SaleCancelledError = void 0;
-class SaleCancelledError extends Error {
-    constructor() {
-        super("The sale is no longer active.");
-    }
-}
-exports.SaleCancelledError = SaleCancelledError;
-class InvalidSaleDeviceError extends Error {
-    constructor() {
-        super("This device is no longer a register able to perform a sale.");
-    }
-}
-exports.InvalidSaleDeviceError = InvalidSaleDeviceError;

package/lib/APIs/CurrentSale/Sale.d.ts

@@ -1,182 +0,0 @@
-import { Application } from "../../Application";
-import { ShopfrontSaleState } from "./ShopfrontSaleState";
-import { SaleUpdate, SaleUpdateChanges } from "../../Actions/SaleUpdate";
-import { SaleProduct } from "./SaleProduct";
-import { SalePayment } from "./SalePayment";
-import { SaleCustomer } from "./SaleCustomer";
-export declare class Sale {
-    protected application: Application;
-    protected sale: ShopfrontSaleState;
-    protected cancelled: boolean;
-    /**
-     * Create a sale from a sale state.
-     * It's highly recommend to not construct a sale manually, instead use application.getCurrentSale().
-     *
-     * @param {Application} application
-     * @param {ShopfrontSaleState} sale
-     */
-    constructor(application: Application, sale: ShopfrontSaleState);
-    /**
-     * Get the raw state of the sale, it is highly recommend that you DO NOT use this method as the
-     * returned data may be quite volatile.
-     *
-     * @internal
-     * @returns {ShopfrontSaleState}
-     */
-    getRawState(): ShopfrontSaleState;
-    /**
-     * Update the sale to be the latest sale that exists on the sell screen.
-     *
-     * @returns {Promise<void>}
-     */
-    refreshSale(): Promise<void>;
-    /**
-     * Check if the sale has already been cancelled, if it has, throw a SaleCancelledError.
-     *
-     * @protected
-     */
-    protected checkIfCancelled(): void;
-    /**
-     * Send a sale update to Shopfront.
-     *
-     * @protected
-     * @param {SaleUpdate} update
-     * @returns {Promise<void>}
-     */
-    protected sendSaleUpdate(update: SaleUpdate<keyof SaleUpdateChanges>): Promise<void>;
-    /**
-     * Get the products that are currently on the sale.
-     *
-     * @returns {Array<SaleProduct>}
-     */
-    getProducts(): Array<SaleProduct>;
-    /**
-     * Get the payments that are currently on the sale.
-     *
-     * @returns {Array<SalePayment>}
-     */
-    getPayments(): Array<SalePayment>;
-    /**
-     * Get the current customer on the sale.
-     *
-     * @returns {SaleCustomer | null}
-     */
-    getCustomer(): null | SaleCustomer;
-    /**
-     * Get the external sale note (visible to the customer).
-     *
-     * @returns {string}
-     */
-    getExternalNote(): string;
-    /**
-     * Get the internal sale note.
-     *
-     * @returns {string}
-     */
-    getInternalNote(): string;
-    /**
-     * Get the order reference (visible to the customer).
-     *
-     * @returns {string}
-     */
-    getOrderReference(): string;
-    /**
-     * Get the current meta data for the sale
-     *
-     * @returns {Record<string, unknown>}
-     */
-    getMetaData(): Record<string, unknown>;
-    /**
-     * Cancel the current sale in progress.
-     *
-     * @returns {Promise<void>}
-     */
-    cancelSale(): Promise<void>;
-    /**
-     * Add a product to the sale.
-     *
-     * @param {SaleProduct} product
-     * @returns {Promise<void>}
-     */
-    addProduct(product: SaleProduct): Promise<void>;
-    /**
-     * Remove a product from the sale.
-     * It's highly recommended that you pass in a product that has been retrieved using sale.getProducts().
-     *
-     * @param {SaleProduct} product
-     * @returns {Promise<void>}
-     */
-    removeProduct(product: SaleProduct): Promise<void>;
-    /**
-     * Add a payment to the sell screen.
-     *
-     * If you specify a payment with a status, it will bypass the payment gateway (i.e. it won't request that the
-     * user takes money from the customer).
-     *
-     * If you don't specify a cashout amount, it will automatically determine if the payment method normally requests
-     * cashout (from the payment method settings).
-     *
-     * @param {SalePayment} payment
-     * @returns {Promise<void>}
-     */
-    addPayment(payment: SalePayment): Promise<void>;
-    /**
-     * Reverse a payment on the sell screen.
-     *
-     * This is used to issue a refund to the customer. The sale payment amount should be positive.
-     *
-     * @param {SalePayment} payment
-     * @returns {Promise<void>}
-     */
-    reversePayment(payment: SalePayment): Promise<void>;
-    /**
-     * Add a customer to the sale.
-     * If there is already a customer on the sale this will override that customer.
-     *
-     * @param {SaleCustomer} customer
-     * @returns {Promise<void>}
-     */
-    addCustomer(customer: SaleCustomer): Promise<void>;
-    /**
-     * Remove the customer from the current sale.
-     * If there is no customer currently on the sale this will be ignored.
-     * If there are "on account" or loyalty payments still on the sale, this will be ignored.
-     *
-     * @returns {Promise<void>}
-     */
-    removeCustomer(): Promise<void>;
-    /**
-     * Set the external note for the sale.
-     *
-     * @param {string} note The note to set.
-     * @param {boolean} append Whether to append the note to the current sale note.
-     * @returns {Promise<void>}
-     */
-    setExternalNote(note: string, append?: boolean): Promise<void>;
-    /**
-     * Set the internal note for the sale.
-     *
-     * @param {string} note The note to set.
-     * @param {boolean} append Whether to append the note to the current sale note.
-     * @returns {Promise<void>}
-     */
-    setInternalNote(note: string, append?: boolean): Promise<void>;
-    /**
-     * Set the order reference to the provided string.
-     *
-     * @param {string} reference
-     * @returns {Promise<void>}
-     */
-    setOrderReference(reference: string): Promise<void>;
-    /**
-     * Set the meta data of the sale, this will override the previous meta data.
-     *
-     * @param metaData
-     */
-    setMetaData(metaData: Record<string, unknown>): Promise<void>;
-    /**
-     * Update a product's details, currently this only updates the top-level meta data
-     * @param product
-     */
-    updateProduct(product: SaleProduct): Promise<void>;
-}