@shopfront/bridge 2.0.0 → 2.0.2

package/lib/APIs/Database/types/BaseTakingsRepository.d.ts

@@ -0,0 +1,13 @@
+import { PaymentMethodTypeUnion } from "./BasePaymentMethodRepository.js";
+import BaseRepository from "./BaseRepository.js";
+export interface LocalDatabaseTakings {
+    amount: number;
+    type: PaymentMethodTypeUnion;
+    uuid: string;
+}
+export interface BaseTakingsRepository extends BaseRepository<LocalDatabaseTakings> {
+    /**
+     * Retrieve all takings with the specified type
+     */
+    getByType(type: PaymentMethodTypeUnion): Promise<Array<LocalDatabaseTakings>>;
+}

package/lib/APIs/Database/types/BaseTakingsRepository.js

@@ -0,0 +1 @@
+export {};

package/lib/APIs/Database/types/BaseTaxRateRepository.d.ts

@@ -0,0 +1,9 @@
+import BaseRepository from "./BaseRepository.js";
+import { BaseSearchableRepository } from "./BaseSearchableRepository.js";
+export interface LocalDatabaseTaxRate {
+    amount: number;
+    mdb_id: null | number;
+    name: string;
+    uuid: string;
+}
+export type BaseTaxRateRepository = BaseRepository<LocalDatabaseTaxRate> & BaseSearchableRepository<LocalDatabaseTaxRate>;

package/lib/APIs/Database/types/BaseTaxRateRepository.js

@@ -0,0 +1 @@
+export {};

package/lib/APIs/Database/types/BaseTransfereeRepository.d.ts

@@ -0,0 +1,12 @@
+import { LocalDatabaseContact } from "./BaseCustomerRepository.js";
+import BaseRepository from "./BaseRepository.js";
+import { BaseSearchableRepository } from "./BaseSearchableRepository.js";
+export type LocalEmailFormatUnion = "inline" | "csv" | "pdf";
+export interface LocalDatabaseTransferee {
+    name: string;
+    uuid: string;
+    contact: LocalDatabaseContact;
+    email_format: LocalEmailFormatUnion;
+    order_automatic_email: boolean;
+}
+export type BaseTransfereeRepository = BaseRepository<LocalDatabaseTransferee> & BaseSearchableRepository<LocalDatabaseTransferee>;

package/lib/APIs/Database/types/BaseTransfereeRepository.js

@@ -0,0 +1 @@
+export {};

package/lib/APIs/Database/types/BaseVendorConnectionRepository.d.ts

@@ -0,0 +1,7 @@
+import BaseRepository from "./BaseRepository.js";
+import { BaseSearchableRepository } from "./BaseSearchableRepository.js";
+export interface LocalDatabaseVendorConnection {
+    uuid: string;
+    name: string;
+}
+export type BaseVendorConnectionRepository = BaseRepository<LocalDatabaseVendorConnection> & BaseSearchableRepository<LocalDatabaseVendorConnection>;

package/lib/APIs/Database/types/BaseVendorConnectionRepository.js

@@ -0,0 +1 @@
+export {};

package/lib/APIs/Database/types/DataSourceTables.d.ts

@@ -0,0 +1,61 @@
+import { BaseBarcodeTemplateRepository } from "./BaseBarcodeTemplateRepository.js";
+import { BaseClassificationRepository } from "./BaseClassificationRepository.js";
+import { BaseCustomerDisplayRepository } from "./BaseCustomerDisplayRepository.js";
+import { BaseCustomerGroupRepository } from "./BaseCustomerGroupRepository.js";
+import { BaseCustomerRepository } from "./BaseCustomerRepository.js";
+import { BaseEnterpriseRepository } from "./BaseEnterpriseRepository.js";
+import { BaseGiftCardRepository } from "./BaseGiftCardRepository.js";
+import { BaseLoyaltyRepository } from "./BaseLoyaltyRepository.js";
+import { BaseMovementRepository } from "./BaseMovementRepository.js";
+import { BaseOutletRepository } from "./BaseOutletRepository.js";
+import { BasePaymentMethodRepository } from "./BasePaymentMethodRepository.js";
+import { BasePriceListRepository } from "./BasePriceListRepository.js";
+import { BasePriceSetRepository } from "./BasePriceSetRepository.js";
+import { BaseProductRepository } from "./BaseProductRepository.js";
+import { BasePromotionCategoryRepository } from "./BasePromotionCategoryRepository.js";
+import { BasePromotionRepository } from "./BasePromotionRepository.js";
+import { BaseReceiptRepository } from "./BaseReceiptRepository.js";
+import { BaseRegisterRepository } from "./BaseRegisterRepository.js";
+import { BaseSalesKeyRepository } from "./BaseSalesKeyRepository.js";
+import { BaseSalesRepository } from "./BaseSalesRepository.js";
+import { BaseStocktakeAccumulatedRepository } from "./BaseStocktakeAccumulatedRepository.js";
+import { BaseStocktakeRepository } from "./BaseStocktakeRepository.js";
+import { BaseStocktakeScannedRepository } from "./BaseStocktakeScannedRepository.js";
+import { BaseSupplierRepository } from "./BaseSupplierRepository.js";
+import { BaseTakingsRepository } from "./BaseTakingsRepository.js";
+import { BaseTaxRateRepository } from "./BaseTaxRateRepository.js";
+import { BaseTransfereeRepository } from "./BaseTransfereeRepository.js";
+import { BaseVendorConnectionRepository } from "./BaseVendorConnectionRepository.js";
+export interface DataSourceTables {
+    products: BaseProductRepository;
+    customers: BaseCustomerRepository;
+    customerGroups: BaseCustomerGroupRepository;
+    promotions: BasePromotionRepository;
+    promotionCategories: BasePromotionCategoryRepository;
+    priceLists: BasePriceListRepository;
+    paymentMethods: BasePaymentMethodRepository;
+    salesKeys: BaseSalesKeyRepository;
+    receipts: BaseReceiptRepository;
+    giftCards: BaseGiftCardRepository;
+    loyalty: BaseLoyaltyRepository;
+    customerDisplays: BaseCustomerDisplayRepository;
+    sales: BaseSalesRepository;
+    brands: BaseClassificationRepository;
+    categories: BaseClassificationRepository;
+    families: BaseClassificationRepository;
+    tags: BaseClassificationRepository;
+    outlets: BaseOutletRepository;
+    registers: BaseRegisterRepository;
+    taxRates: BaseTaxRateRepository;
+    takings: BaseTakingsRepository;
+    suppliers: BaseSupplierRepository;
+    priceSets: BasePriceSetRepository;
+    transferees: BaseTransfereeRepository;
+    movements: BaseMovementRepository;
+    stocktakes: BaseStocktakeRepository;
+    stocktakeScanned: BaseStocktakeScannedRepository;
+    stocktakeAccumulated: BaseStocktakeAccumulatedRepository;
+    barcodeTemplates: BaseBarcodeTemplateRepository;
+    vendorConnections: BaseVendorConnectionRepository;
+    enterprises: BaseEnterpriseRepository;
+}

package/lib/APIs/Database/types/DataSourceTables.js

@@ -0,0 +1 @@
+export {};

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

@@ -1,4 +1,4 @@
-export declare type OrderStatus = "PENDING_APPROVAL" | "WAITING_FOR_PACKING" | "PACKED" | "COLLECTED" | "COMPLETED";
+export type OrderStatus = "PENDING_APPROVAL" | "WAITING_FOR_PACKING" | "PACKED" | "COLLECTED" | "COMPLETED";
 export interface OrderSummaryDetails {
     id: string;
     customer: {
@@ -17,7 +17,7 @@ export interface OrderSummaryDetails {
     finalLabel?: string;
     createdAt: string;
 }
-export declare type OrderCreateDetails = Omit<OrderSummaryDetails, "status"> & Partial<Pick<OrderSummaryDetails, "status">>;
+export type OrderCreateDetails = Omit<OrderSummaryDetails, "status"> & Partial<Pick<OrderSummaryDetails, "status">>;
 export interface OrderDetails extends OrderSummaryDetails {
     items: Array<OrderItem>;
 }

package/lib/APIs/Fulfilment/FulfilmentTypes.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/lib/APIs/InternalMessages/InternalMessageSource.d.ts

@@ -1,10 +1,13 @@
-import { Application } from "../../Application";
-import { FromShopfront } from "../../ApplicationEvents";
-export declare type InternalPageMessageMethod = keyof FromShopfront | "EXTERNAL_APPLICATION";
+import { Application } from "../../Application.js";
+import { FromShopfront } from "../../ApplicationEvents.js";
+export type InternalPageMessageMethod = keyof FromShopfront | "EXTERNAL_APPLICATION";
 export declare class InternalMessageSource {
     protected application: Application;
     protected method: InternalPageMessageMethod;
     protected url: string;
     constructor(application: Application, method: InternalPageMessageMethod, url: string);
+    /**
+     * Sends an internal message to Shopfront
+     */
     send(message: unknown): void;
 }

package/lib/APIs/InternalMessages/InternalMessageSource.js

@@ -1,15 +1,14 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InternalMessageSource = void 0;
-const InternalMessage_1 = require("../../EmitableEvents/InternalMessage");
-class InternalMessageSource {
+import { InternalMessage } from "../../EmitableEvents/InternalMessage.js";
+export class InternalMessageSource {
     constructor(application, method, url) {
         this.application = application;
         this.method = method;
         this.url = url;
     }
+    /**
+     * Sends an internal message to Shopfront
+     */
     send(message) {
-        this.application.send(new InternalMessage_1.InternalMessage(this.method, this.url, message));
+        this.application.send(new InternalMessage(this.method, this.url, message));
     }
 }
-exports.InternalMessageSource = InternalMessageSource;

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

@@ -0,0 +1,83 @@
+import { BaseApplication } from "../../BaseApplication.js";
+import { BaseSale } from "./BaseSale.js";
+import { SaleCustomer } from "./SaleCustomer.js";
+import { SalePayment } from "./SalePayment.js";
+import { SaleProduct } from "./SaleProduct.js";
+import { ShopfrontSaleState } from "./ShopfrontSaleState.js";
+export declare abstract class BaseCurrentSale extends BaseSale {
+    protected application: BaseApplication;
+    protected cancelled: boolean;
+    /**
+     * Create a sale from a sale state.
+     * It's highly recommend to not construct a sale manually, instead use application.getCurrentSale().
+     */
+    constructor(application: BaseApplication, saleState: ShopfrontSaleState);
+    /**
+     * Update the sale to be the latest sale that exists on the sell screen.
+     */
+    abstract refreshSale(): Promise<void>;
+    /**
+     * Cancel the current sale in progress.
+     */
+    abstract cancelSale(): Promise<void>;
+    /**
+     * Add a product to the sale.
+     */
+    abstract 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().
+     */
+    abstract 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).
+     */
+    abstract 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.
+     */
+    abstract 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.
+     */
+    abstract 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.
+     */
+    abstract removeCustomer(): Promise<void>;
+    /**
+     * Set the external note for the sale.
+     * @param note The note to set.
+     * @param append Whether to append the note to the current sale note.
+     */
+    abstract setExternalNote(note: string, append?: boolean): Promise<void>;
+    /**
+     * Set the internal note for the sale.
+     * @param note The note to set.
+     * @param append Whether to append the note to the current sale note.
+     */
+    abstract setInternalNote(note: string, append?: boolean): Promise<void>;
+    /**
+     * Set the order reference to the provided string.
+     */
+    abstract setOrderReference(reference: string): Promise<void>;
+    /**
+     * Set the meta-data of the sale, this will override the previous meta data.
+     */
+    abstract setMetaData(metaData: Record<string, unknown>): Promise<void>;
+    /**
+     * Update a product's details; currently this can update quantity, price and metadata
+     */
+    abstract updateProduct(product: SaleProduct): Promise<void>;
+}

package/lib/APIs/Sale/BaseCurrentSale.js

@@ -0,0 +1,13 @@
+import { BaseSale } from "./BaseSale.js";
+import { Sale } from "./Sale.js";
+export class BaseCurrentSale extends BaseSale {
+    /**
+     * Create a sale from a sale state.
+     * It's highly recommend to not construct a sale manually, instead use application.getCurrentSale().
+     */
+    constructor(application, saleState) {
+        super(Sale.buildSaleData(saleState));
+        this.application = application;
+        this.cancelled = false;
+    }
+}

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

@@ -1,6 +1,6 @@
-import { SaleCustomer } from "./SaleCustomer";
-import { SalePayment } from "./SalePayment";
-import { SaleProduct } from "./SaleProduct";
+import { SaleCustomer } from "./SaleCustomer.js";
+import { SalePayment } from "./SalePayment.js";
+import { SaleProduct } from "./SaleProduct.js";
 export interface BaseSaleData {
     register: string | undefined;
     clientId: string | undefined;
@@ -33,105 +33,70 @@ export declare abstract class BaseSale {
     protected constructor({ customer, payments, products, ...sale }: SaleData);
     /**
      * Updates the sale data to be inline with the new sale
-     *
-     * @param {BaseSale} sale
-     * @protected
      */
     protected hydrate(sale: BaseSale): 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 register.
-     *
-     * @returns {string | undefined}
      */
     getRegister(): string | undefined;
     /**
      * Get the client id.
-     *
-     * @returns {string | null}
      */
     getClientId(): string | undefined;
     /**
      * Get the current sale total on the sale.
-     *
-     * @returns {number}
      */
     getSaleTotal(): number;
     /**
      * Get the current paid total on the sale.
-     *
-     * @returns {number}
      */
     getPaidTotal(): number;
     /**
      * Get the current savings total on the sale.
-     *
-     * @returns {number}
      */
     getSavingsTotal(): number;
     /**
      * Get the current discount total on the sale.
-     *
-     * @returns {number}
      */
     getDiscountTotal(): number;
     /**
      * Get the linked to value on the sale.
-     *
-     * @returns {string}
      */
     getLinkedTo(): string;
     /**
      * Get the refund reason on the sale.
-     *
-     * @returns {string}
      */
     getRefundReason(): string;
     /**
      * Get the price set on the sale.
-     *
-     * @returns {string | null}
      */
     getPriceSet(): string | null;
     /**
      * 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>;
     abstract addProduct(product: SaleProduct): Promise<void>;

package/lib/APIs/Sale/BaseSale.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseSale = void 0;
-class BaseSale {
+export class BaseSale {
     constructor({ customer, payments, products, ...sale }) {
         this.sale = sale;
         this.customer = customer;
@@ -10,9 +7,6 @@ class BaseSale {
     }
     /**
      * Updates the sale data to be inline with the new sale
-     *
-     * @param {BaseSale} sale
-     * @protected
      */
     hydrate(sale) {
         this.sale = sale.sale;
@@ -22,131 +16,98 @@ class BaseSale {
     }
     /**
      * Get the products that are currently on the sale.
-     *
-     * @returns {Array<SaleProduct>}
      */
     getProducts() {
         return this.products;
     }
     /**
      * Get the payments that are currently on the sale.
-     *
-     * @returns {Array<SalePayment>}
      */
     getPayments() {
         return this.payments;
     }
     /**
      * Get the current customer on the sale.
-     *
-     * @returns {SaleCustomer | null}
      */
     getCustomer() {
         return this.customer;
     }
     /**
      * Get the register.
-     *
-     * @returns {string | undefined}
      */
     getRegister() {
         return this.sale.register;
     }
     /**
      * Get the client id.
-     *
-     * @returns {string | null}
      */
     getClientId() {
         return this.sale.clientId;
     }
     /**
      * Get the current sale total on the sale.
-     *
-     * @returns {number}
      */
     getSaleTotal() {
         return this.sale.totals.sale;
     }
     /**
      * Get the current paid total on the sale.
-     *
-     * @returns {number}
      */
     getPaidTotal() {
         return this.sale.totals.paid;
     }
     /**
      * Get the current savings total on the sale.
-     *
-     * @returns {number}
      */
     getSavingsTotal() {
         return this.sale.totals.savings;
     }
     /**
      * Get the current discount total on the sale.
-     *
-     * @returns {number}
      */
     getDiscountTotal() {
         return this.sale.totals.discount;
     }
     /**
      * Get the linked to value on the sale.
-     *
-     * @returns {string}
      */
     getLinkedTo() {
         return this.sale.linkedTo;
     }
     /**
      * Get the refund reason on the sale.
-     *
-     * @returns {string}
      */
     getRefundReason() {
         return this.sale.refundReason;
     }
     /**
      * Get the price set on the sale.
-     *
-     * @returns {string | null}
      */
     getPriceSet() {
         return this.sale.priceSet;
     }
     /**
      * Get the external sale note (visible to the customer).
-     *
-     * @returns {string}
      */
     getExternalNote() {
         return this.sale.notes.sale;
     }
     /**
      * Get the internal sale note.
-     *
-     * @returns {string}
      */
     getInternalNote() {
         return this.sale.notes.internal;
     }
     /**
      * Get the order reference (visible to the customer).
-     *
-     * @returns {string}
      */
     getOrderReference() {
         return this.sale.orderReference;
     }
     /**
      * Get the current meta data for the sale
-     *
-     * @returns {Record<string, unknown>}
      */
     getMetaData() {
         return this.sale.metaData;
     }
 }
-exports.BaseSale = BaseSale;