@shopfront/bridge 1.18.0 → 1.18.3

package/.idea/codeStyles/Project.xml

@@ -1,121 +1,10 @@
 <component name="ProjectCodeStyleConfiguration">
   <code_scheme name="Project" version="173">
-    <DB2CodeStyleSettings version="6">
-      <option name="USE_GENERAL_STYLE" value="false" />
-      <option name="KEYWORD_CASE" value="2" />
-      <option name="IDENTIFIER_CASE" value="1" />
-      <option name="FROM_INDENT_JOIN" value="false" />
-    </DB2CodeStyleSettings>
-    <DerbyCodeStyleSettings version="6">
-      <option name="USE_GENERAL_STYLE" value="false" />
-      <option name="KEYWORD_CASE" value="2" />
-      <option name="IDENTIFIER_CASE" value="1" />
-      <option name="FROM_INDENT_JOIN" value="false" />
-    </DerbyCodeStyleSettings>
-    <H2CodeStyleSettings version="6">
-      <option name="USE_GENERAL_STYLE" value="false" />
-      <option name="KEYWORD_CASE" value="2" />
-      <option name="IDENTIFIER_CASE" value="1" />
-      <option name="FROM_INDENT_JOIN" value="false" />
-    </H2CodeStyleSettings>
-    <H2CodeStyleSettings version="6">
-      <option name="USE_GENERAL_STYLE" value="false" />
-      <option name="KEYWORD_CASE" value="2" />
-      <option name="IDENTIFIER_CASE" value="1" />
-      <option name="FROM_INDENT_JOIN" value="false" />
-    </H2CodeStyleSettings>
-    <HSQLCodeStyleSettings version="6">
-      <option name="USE_GENERAL_STYLE" value="false" />
-      <option name="KEYWORD_CASE" value="2" />
-      <option name="IDENTIFIER_CASE" value="1" />
-      <option name="FROM_INDENT_JOIN" value="false" />
-    </HSQLCodeStyleSettings>
-    <HTMLCodeStyleSettings>
-      <option name="HTML_ATTRIBUTE_WRAP" value="4" />
-      <option name="HTML_NEWLINE_BEFORE_FIRST_ATTRIBUTE" value="When multiline" />
-      <option name="HTML_NEWLINE_AFTER_LAST_ATTRIBUTE" value="When multiline" />
-    </HTMLCodeStyleSettings>
     <JSCodeStyleSettings version="0">
       <option name="FORCE_SEMICOLON_STYLE" value="true" />
-      <option name="ALIGN_OBJECT_PROPERTIES" value="2" />
-      <option name="ALIGN_VAR_STATEMENTS" value="2" />
-      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
-      <option name="SPACES_WITHIN_IMPORTS" value="true" />
     </JSCodeStyleSettings>
-    <MSSQLCodeStyleSettings version="6">
-      <option name="USE_GENERAL_STYLE" value="false" />
-      <option name="KEYWORD_CASE" value="2" />
-      <option name="IDENTIFIER_CASE" value="1" />
-      <option name="FROM_INDENT_JOIN" value="false" />
-    </MSSQLCodeStyleSettings>
-    <MySQLCodeStyleSettings version="6">
-      <option name="USE_GENERAL_STYLE" value="false" />
-      <option name="KEYWORD_CASE" value="2" />
-      <option name="IDENTIFIER_CASE" value="1" />
-      <option name="FROM_INDENT_JOIN" value="false" />
-    </MySQLCodeStyleSettings>
-    <OracleCodeStyleSettings version="6">
-      <option name="USE_GENERAL_STYLE" value="false" />
-      <option name="KEYWORD_CASE" value="2" />
-      <option name="IDENTIFIER_CASE" value="1" />
-      <option name="FROM_INDENT_JOIN" value="false" />
-    </OracleCodeStyleSettings>
-    <PostgresCodeStyleSettings version="6">
-      <option name="USE_GENERAL_STYLE" value="false" />
-      <option name="KEYWORD_CASE" value="2" />
-      <option name="IDENTIFIER_CASE" value="1" />
-      <option name="FROM_INDENT_JOIN" value="false" />
-    </PostgresCodeStyleSettings>
-    <SQLiteCodeStyleSettings version="6">
-      <option name="USE_GENERAL_STYLE" value="false" />
-      <option name="KEYWORD_CASE" value="2" />
-      <option name="IDENTIFIER_CASE" value="1" />
-      <option name="FROM_INDENT_JOIN" value="false" />
-    </SQLiteCodeStyleSettings>
-    <SqlCodeStyleSettings version="6">
-      <option name="KEYWORD_CASE" value="2" />
-      <option name="IDENTIFIER_CASE" value="1" />
-      <option name="FROM_INDENT_JOIN" value="false" />
-    </SqlCodeStyleSettings>
-    <SybaseCodeStyleSettings version="6">
-      <option name="USE_GENERAL_STYLE" value="false" />
-      <option name="KEYWORD_CASE" value="2" />
-      <option name="IDENTIFIER_CASE" value="1" />
-      <option name="FROM_INDENT_JOIN" value="false" />
-    </SybaseCodeStyleSettings>
     <TypeScriptCodeStyleSettings version="0">
       <option name="FORCE_SEMICOLON_STYLE" value="true" />
-      <option name="SPACE_WITHIN_ARRAY_INITIALIZER_BRACKETS" value="true" />
-      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
-      <option name="SPACES_WITHIN_IMPORTS" value="true" />
     </TypeScriptCodeStyleSettings>
-    <codeStyleSettings language="CSS">
-      <indentOptions>
-        <option name="INDENT_SIZE" value="2" />
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-    <codeStyleSettings language="HTML">
-      <indentOptions>
-        <option name="CONTINUATION_INDENT_SIZE" value="4" />
-      </indentOptions>
-    </codeStyleSettings>
-    <codeStyleSettings language="JavaScript">
-      <option name="KEEP_BLANK_LINES_IN_CODE" value="1" />
-    </codeStyleSettings>
-    <codeStyleSettings language="PHP">
-      <option name="KEEP_LINE_BREAKS" value="false" />
-      <option name="KEEP_FIRST_COLUMN_COMMENT" value="false" />
-      <option name="CLASS_BRACE_STYLE" value="1" />
-      <option name="METHOD_BRACE_STYLE" value="1" />
-      <option name="KEEP_SIMPLE_METHODS_IN_ONE_LINE" value="true" />
-    </codeStyleSettings>
-    <codeStyleSettings language="SCSS">
-      <indentOptions>
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
   </code_scheme>
 </component>

package/.idea/misc.xml

@@ -0,0 +1,6 @@
+<?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/php.xml

@@ -0,0 +1,18 @@
+<?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="PhpStanOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PsalmOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+</project>

package/.idea/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/APIs/Sale/SalePayment.d.ts

@@ -12,6 +12,7 @@ export declare class SalePayment {
     protected amount: number;
     protected cashout?: number;
     protected rounding?: number;
+    protected metaData: Record<string, unknown>;
     constructor(id: string, amount: number, cashout?: number, status?: SalePaymentStatus);
     /**
      * Hydrate a sale payment from the SaleState.
@@ -66,4 +67,10 @@ export declare class SalePayment {
      * @returns {number | undefined}
      */
     getRounding(): number | undefined;
+    /**
+     * Get the metadata attached to this payment method
+     *
+     * @returns {Record<string, unknown>}
+     */
+    getMetaData(): Record<string, unknown>;
 }

package/lib/APIs/Sale/SalePayment.js

@@ -13,6 +13,7 @@ var SalePaymentStatus;
 })(SalePaymentStatus = exports.SalePaymentStatus || (exports.SalePaymentStatus = {}));
 class SalePayment {
     constructor(id, amount, cashout, status) {
+        this.metaData = {};
         this.internalId = UUID_1.default.generate();
         this.id = id;
         this.amount = amount;
@@ -51,6 +52,7 @@ class SalePayment {
     setInternal(data) {
         this.type = data.type;
         this.rounding = data.rounding;
+        this.metaData = JSON.parse(data.metadata);
     }
     /**
      * Get the ID of the sale payment method.
@@ -100,5 +102,13 @@ class SalePayment {
     getRounding() {
         return this.rounding;
     }
+    /**
+     * Get the metadata attached to this payment method
+     *
+     * @returns {Record<string, unknown>}
+     */
+    getMetaData() {
+        return this.metaData;
+    }
 }
 exports.SalePayment = SalePayment;

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

@@ -30,6 +30,7 @@ export interface ShopfrontSalePayment {
     amount: number;
     cashout: number;
     rounding: number;
+    metadata: string;
 }
 export interface ShopfrontSaleState {
     clientId?: string;

package/lib/Application.d.ts

@@ -18,8 +18,14 @@ export interface ShopfrontEmbeddedVerificationToken {
         loaded: string;
     };
 }
+export interface ShopfrontEmbeddedTokenError {
+    error: boolean;
+    type: string;
+}
 export declare class ShopfrontTokenDecodingError extends Error {
 }
+export declare class ShopfrontTokenRequestError extends Error {
+}
 export declare class Application {
     protected bridge: Bridge;
     protected isReady: boolean;
@@ -41,7 +47,8 @@ export declare class Application {
     protected emit(event: keyof Omit<FromShopfront, "CALLBACK"> | DirectShopfrontEvent, data: Record<string, unknown> | undefined, id: string): void | Promise<void>;
     addEventListener<E extends keyof FromShopfrontCallbacks>(event: E, callback: FromShopfrontCallbacks[E]): void;
     addEventListener<D>(event: DirectShopfrontEvent, callback: (event: D) => MaybePromise<void>): void;
-    removeEventListener(event: keyof Omit<FromShopfront, "CALLBACK"> | DirectShopfrontEvent, callback: (...args: Array<unknown>) => MaybePromise<void>): void;
+    removeEventListener<E extends keyof FromShopfrontCallbacks>(event: E, callback: FromShopfrontCallbacks[E]): void;
+    removeEventListener<D>(event: DirectShopfrontEvent, callback: (event: D) => MaybePromise<void>): void;
     send(item: BaseEmitableEvent<unknown>): void;
     send(item: Serializable<unknown>): void;
     download(file: string): void;
@@ -138,6 +145,7 @@ export declare class Application {
     };
     protected generateSigningKey(): Promise<void>;
     protected decodeToken(signature: BufferSource, data: BufferSource, returnTokenObject?: boolean): Promise<ShopfrontEmbeddedVerificationToken | string>;
+    protected tokenDataContainsErrors(data: unknown): data is ShopfrontEmbeddedTokenError;
     getToken(returnTokenObject: true): Promise<ShopfrontEmbeddedVerificationToken>;
     getToken(returnTokenObject?: false): Promise<string>;
 }

package/lib/Application.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Application = exports.ShopfrontTokenDecodingError = void 0;
+exports.Application = exports.ShopfrontTokenRequestError = exports.ShopfrontTokenDecodingError = void 0;
 const ApplicationEvents_1 = require("./ApplicationEvents");
 const Ready_1 = require("./Events/Ready");
 const Button_1 = require("./Actions/Button");
@@ -34,6 +34,9 @@ const SaleCreate_1 = require("./Utilities/SaleCreate");
 class ShopfrontTokenDecodingError extends Error {
 }
 exports.ShopfrontTokenDecodingError = ShopfrontTokenDecodingError;
+class ShopfrontTokenRequestError extends Error {
+}
+exports.ShopfrontTokenRequestError = ShopfrontTokenRequestError;
 // noinspection JSUnusedGlobalSymbols
 class Application {
     constructor(bridge) {
@@ -595,6 +598,12 @@ class Application {
         }
         return decoded.auth;
     }
+    tokenDataContainsErrors(data) {
+        if (!data || typeof data !== "object") {
+            return false;
+        }
+        return "error" in data && "type" in data;
+    }
     async getToken(returnTokenObject) {
         await this.generateSigningKey();
         const request = `TokenRequest-${Date.now().toString()}`;
@@ -617,7 +626,12 @@ class Application {
         this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.REQUEST_SECURE_KEY, {
             requestId: request,
         });
-        return this.decodeToken(...(await promise), returnTokenObject);
+        const [signature, data] = await promise;
+        // Throw the error if there is one
+        if (this.tokenDataContainsErrors(data)) {
+            throw new ShopfrontTokenRequestError(data.type);
+        }
+        return this.decodeToken(signature, data, returnTokenObject);
     }
 }
 exports.Application = Application;

package/lib/Utilities/SaleCreate.d.ts

@@ -16,6 +16,7 @@ export interface SalePaymentData {
     status: undefined | ShopfrontSalePaymentStatus;
     rounding: number;
     cashout: number;
+    metaData: Record<string, unknown>;
 }
 export interface SaleData extends BaseSaleData {
     customer: null | string;

package/lib/Utilities/SaleCreate.js

@@ -49,6 +49,7 @@ function buildSaleData(sale) {
             status: payment.getStatus(),
             rounding: payment.getRounding() || 0,
             cashout: payment.getCashout() || 0,
+            metaData: payment.getMetaData()
         })),
     };
 }

package/package.json

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

package/lib/EmitableEvents/Fulfilment/OrderSaleCreate.d.ts

@@ -1,8 +0,0 @@
-import { BaseEmitableEvent } from "../BaseEmitableEvent";
-import { FulfilmentSale } from "../../APIs/Fulfilment/FulfilmentTypes";
-export declare class OrderSaleCreate extends BaseEmitableEvent<{
-    id: string;
-    sale: FulfilmentSale;
-}> {
-    constructor(id: string, sale: FulfilmentSale);
-}

package/lib/EmitableEvents/Fulfilment/OrderSaleCreate.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrderSaleCreate = void 0;
-const BaseEmitableEvent_1 = require("../BaseEmitableEvent");
-const ApplicationEvents_1 = require("../../ApplicationEvents");
-class OrderSaleCreate extends BaseEmitableEvent_1.BaseEmitableEvent {
-    constructor(id, sale) {
-        super(ApplicationEvents_1.ToShopfront.FULFILMENT_CREATE_SALE, {
-            id,
-            sale,
-        });
-    }
-}
-exports.OrderSaleCreate = OrderSaleCreate;

package/lib/EmitableEvents/SaleCreate.d.ts

@@ -1,31 +0,0 @@
-import { BaseEmitableEvent } from "./BaseEmitableEvent";
-import { BaseSaleData } from "../APIs/Sale/BaseSale";
-import { Sale } from "../APIs/Sale";
-import { ShopfrontSalePaymentStatus } from "../APIs/Sale";
-export interface SaleProductData {
-    uuid: string;
-    caseQuantity: number;
-    quantity: number;
-    price: number;
-    metaData: Record<string, unknown>;
-    products: Array<SaleProductData>;
-    note: string;
-}
-export interface SalePaymentData {
-    method: string;
-    type: undefined | string;
-    amount: number;
-    status: undefined | ShopfrontSalePaymentStatus;
-    rounding: number;
-    cashout: number;
-}
-export interface SaleData extends BaseSaleData {
-    customer: null | string;
-    payments: Array<SalePaymentData>;
-    products: Array<SaleProductData>;
-}
-export declare class SaleCreate extends BaseEmitableEvent<{
-    sale: SaleData;
-}> {
-    constructor(sale: Sale);
-}

package/lib/EmitableEvents/SaleCreate.js

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SaleCreate = void 0;
-const BaseEmitableEvent_1 = require("./BaseEmitableEvent");
-const ApplicationEvents_1 = require("../ApplicationEvents");
-function buildSaleProductData(product) {
-    const price = product.getPrice();
-    if (typeof price !== "number") {
-        throw new TypeError("Sale Product must have price when creating the sale.");
-    }
-    const caseQuantity = product.getCaseQuantity();
-    if (typeof caseQuantity !== "number") {
-        throw new TypeError("Sale Product must have case quantity when creating the sale.");
-    }
-    return {
-        uuid: product.getId(),
-        quantity: product.getQuantity(),
-        metaData: product.getMetaData(),
-        products: product.getContains().map(buildSaleProductData),
-        note: product.getNote(),
-        caseQuantity,
-        price,
-    };
-}
-function buildSaleData(sale) {
-    const customer = sale.getCustomer();
-    return {
-        clientId: sale.getClientId(),
-        notes: {
-            internal: sale.getInternalNote(),
-            sale: sale.getExternalNote(),
-        },
-        totals: {
-            sale: sale.getSaleTotal(),
-            paid: sale.getPaidTotal(),
-            savings: sale.getSavingsTotal(),
-            discount: sale.getDiscountTotal(),
-        },
-        linkedTo: sale.getLinkedTo(),
-        orderReference: sale.getOrderReference(),
-        refundReason: sale.getRefundReason(),
-        priceSet: sale.getPriceSet(),
-        metaData: sale.getMetaData(),
-        customer: customer ? customer.getId() : null,
-        products: sale.getProducts().map(buildSaleProductData),
-        payments: sale.getPayments().map(payment => ({
-            method: payment.getId(),
-            type: payment.getType(),
-            amount: payment.getAmount(),
-            status: payment.getStatus(),
-            rounding: payment.getRounding() || 0,
-            cashout: payment.getCashout() || 0,
-        })),
-    };
-}
-class SaleCreate extends BaseEmitableEvent_1.BaseEmitableEvent {
-    constructor(sale) {
-        super(ApplicationEvents_1.ToShopfront.CREATE_SALE, {
-            sale: buildSaleData(sale),
-        });
-    }
-}
-exports.SaleCreate = SaleCreate;