@shopfront/types 0.0.1-alpha.8 → 0.0.1-alpha.9

package/Database.gen.ts

@@ -0,0 +1,2061 @@
+// This file is automatically generated by publish-types.mjs
+// Merged for alias: database
+
+// External symbols resolved from imports
+export interface KitchenShopfrontSale {
+    id: string;
+    status: "COMPLETED" | "INCOMPLETE" | "PARKED";
+    register: {
+        id: string;
+        outlet: {
+            id: string;
+        };
+    };
+    invoiceId: string;
+    note: string;
+    internalNote: string;
+    createdAt: string;
+    customer: null | {
+        firstName: string;
+        lastName: string;
+    };
+    items: Array<KitchenShopfrontItem>;
+}
+
+export interface KitchenShopfrontItem<
+    TItem extends KitchenSellableItem | KitchenShopfrontProduct = KitchenSellableItem | KitchenShopfrontProduct
+> {
+    id: string;
+    quantity: number;
+    note: string;
+    kitchenReadyAt: null | string;
+    contains: Array<KitchenShopfrontItemContents>;
+    item: TItem;
+}
+
+export interface KitchenSellableItem {
+    id: string;
+}
+
+export interface KitchenShopfrontProduct {
+    id: string;
+    name: string;
+    category: null | {
+        id: string;
+    };
+    tags: Array<{
+        id: string;
+    }>;
+}
+
+export interface KitchenShopfrontItemContents {
+    id: string;
+    parentId: string | null;
+    quantity: number;
+    item: KitchenShopfrontProduct;
+}
+
+export enum UPLOAD_TYPES {
+    SALE = "sale",
+    UPDATE_SALE = "update-sale",
+    BARCODE = "barcode",
+    OPEN_REGISTER = "open-register",
+    CUSTOMER = "customer",
+    UPDATE_CUSTOMER = "update-customer",
+    EMAIL_RECEIPT = "email-receipt",
+    ACTION = "action",
+    TAKINGS = "takings",
+    VOID_SALE = "void-sale",
+    UNPARK_SALE = "unpark-sale",
+    CUSTOMER_PAYMENT = "customer-payment",
+    EMAIL_COMPONENT = "email-component",
+    CLOSE_REGISTER = "close-register",
+    STOCKTAKE_COUNT = "stocktake-count",
+    ERROR = "error",
+    SECURITY_EVENT = "security-event",
+    KITCHEN_ORDER = "kitchen-order",
+}
+
+/* eslint-disable */
+// This file is automatically generated from Shopfront (generate:types). Manual changes will be overwritten.
+export interface Options {
+    use_quantity_rate: boolean;
+    promotion_display_products: boolean;
+    promotion_display_categories: boolean;
+    promotion_display_brands: boolean;
+    promotion_display_families: boolean;
+    promotion_display_tags: boolean;
+    product_single_text: string;
+    product_case_text: string;
+    sell_cases: boolean;
+    find_on_lookup: boolean;
+    register_default_payment_method: string | null;
+    round_to: number;
+    prevent_blur: boolean;
+    register_offline_invoice_suffix: string;
+    invoice_width: number;
+    register_current_invoice_number: number;
+    team_message: string;
+    discount_require_reason: boolean;
+    default_sale_keys: string | null;
+    outlet_default_sale_keys: string | null;
+    register_default_sale_keys: string | null;
+    user_default_sale_keys: string | null;
+    register_default_receipt_template: string | null;
+    allow_cashout_without_sale: boolean;
+    sign_in_type: "type" | "click";
+    sign_in_require_password: boolean;
+    register_login_after_sale: boolean;
+    view_receipt_timeout: number;
+    outlet_enable_gift_cards: boolean;
+    outlet_gift_card_expiry_amount: number;
+    outlet_gift_card_expiry_period: "days" | "weeks" | "months" | "years";
+    outlet_gift_card_expiry_change: boolean;
+    share_gift_cards: boolean;
+    share_held_sales: boolean;
+    display_details_on_customer_add: boolean;
+    register_customer_display_left: number;
+    register_customer_display_top: number;
+    register_never_open_cash_drawer: boolean;
+    use_average_cost: boolean;
+    has_weighable_products: boolean;
+    register_training_sales_mode_enabled: boolean;
+    sign_in_mask_username: boolean;
+    timezone: string;
+    register_current_invoice_max: number | null;
+    outlet_accounts_flow_key: string;
+    register_customer_display: string;
+    keep_select_product_on_screen: boolean;
+    display_select_product_paginated: boolean;
+    outlet_email_receipt_template: string | null;
+    register_default_price_set: string | null;
+    outlet_use_global_cost: boolean;
+    register_safe_drop_amount: number;
+    register_print_receipt_on_refund: boolean;
+    integrate_liquid_mix: boolean;
+    register_integrated_receipts: boolean;
+    cross_promotion_count: boolean;
+    weight_price_labels: boolean;
+    note_on_held_sale: boolean;
+    use_components_and_packages: boolean;
+    outlet_update_last_cost_from_transfer: boolean;
+    outlet_update_average_cost_from_transfer: boolean;
+    outlet_send_transfers_using_average_cost: boolean;
+    outlet_default_statement: string;
+    price_change_notifications: boolean;
+    outlet_outlet_email: string;
+    cost_calculation_method: "last" | "mixed" | "average";
+    statement_reply_email: string;
+    register_next_invoice_batch: number | null;
+    family_distribution: "match_price_points" | "evenly";
+    date_format: string;
+    time_format: string;
+    start_of_week: "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday";
+    profitability_display: "profit-percentage" | "markup";
+    register_consolidate_sale_lines: boolean;
+    future_price_time: number;
+    auto_logout_time: number;
+    auto_logout_during_sale: boolean;
+    register_open_display_on_open_register: boolean;
+    currency_code: string;
+    number_locale: string;
+    require_refund_reason: boolean;
+    use_barcode_templates: boolean;
+    show_order_prices_using_average_cost: boolean;
+    register_note_on_closure_discrepancy: boolean;
+    register_dark_mode: "light" | "dark" | "auto";
+    register_dedicated_promotion_worker: boolean;
+    sale_keys_position: "left" | "right" | "default";
+    outlet_sale_keys_position: "left" | "right" | "default";
+    register_sale_keys_position: "left" | "right" | "default";
+    user_sale_keys_position: "left" | "right" | "default";
+    enable_metcash_host_integration: boolean;
+    "outlet_metcash_credentials.customer_id": string;
+    "outlet_metcash_credentials.state_code": string;
+    "outlet_metcash_credentials.pillar_id": string;
+    "outlet_metcash_credentials.import_promotions": boolean;
+    "outlet_metcash_credentials.b2b_account": string;
+    "outlet_metcash_credentials.password": string;
+    "outlet_metcash_credentials.import_buying_periods": boolean;
+    rounding_mode: "redistribute" | "round";
+    search_customers_memory_level: "full" | "english" | "strict" | "offload";
+    search_products_memory_level: "full" | "english" | "strict" | "offload";
+    ui_logging_level: "essential" | "normal" | "verbose";
+    register_customer_display_mode: "presentation" | "popup";
+    require_cash_drawer_reason: boolean;
+    search_save_location: "indexeddb" | "none";
+    outlet_discount_below_cost_behaviour: "ignore" | "warn" | "prevent";
+    predefined_discount_reasons: Array<string>;
+    user_override_dark_mode: "default" | "light" | "dark" | "auto";
+    outlet_default_order_reviewers: Array<string>;
+    outlet_review_before_sending_order: boolean;
+    outlet_review_before_receiving_order: boolean;
+    outlet_review_before_sending_return: boolean;
+    outlet_review_before_sending_transfer: boolean;
+    outlet_review_before_receiving_transfer: boolean;
+    outlet_review_before_sending_credit_note: boolean;
+    outlet_review_receiving_quantity_discrepancy: boolean;
+    outlet_review_receiving_total_discrepancy: boolean;
+    outlet_review_receiving_cost_discrepancy: boolean;
+    outlet_minimum_order_review_approvals: number;
+    predefined_cash_drawer_reasons: Array<string>;
+    predefined_cash_out_reasons: Array<string>;
+    predefined_cash_in_reasons: Array<string>;
+    set_prices_based_on: "cost_calculation_method" | "last_cost" | "highest_cost";
+    sign_in_password_first_login: boolean;
+    register_invoice_number_mode: "incremental" | "random_string" | "random_number";
+    new_user_default_reporting_all_access: boolean;
+    flag_force_product_redesign: boolean;
+    "flag:use_css_tickets": boolean;
+    "flag:view_host_file": boolean;
+ }
+
+export type OptionValue = string
+    | boolean
+    | number
+    | Record<string, unknown>
+    | undefined
+    | null
+    | Array<unknown>;
+
+export const defaultOptions: Options = {
+    use_quantity_rate: false,
+    promotion_display_products: true,
+    promotion_display_categories: true,
+    promotion_display_brands: true,
+    promotion_display_families: true,
+    promotion_display_tags: true,
+    product_single_text: "Item",
+    product_case_text: "Case",
+    sell_cases: true,
+    find_on_lookup: false,
+    register_default_payment_method: null,
+    round_to: 0.05,
+    prevent_blur: true,
+    register_offline_invoice_suffix: "",
+    invoice_width: 0,
+    register_current_invoice_number: 1000,
+    team_message: "Need assistance? <a href=\"https://support.onshopfront.com\">Check out our help center</a>.",
+    discount_require_reason: false,
+    default_sale_keys: null,
+    outlet_default_sale_keys: "default",
+    register_default_sale_keys: "default",
+    user_default_sale_keys: "default",
+    register_default_receipt_template: null,
+    allow_cashout_without_sale: true,
+    sign_in_type: "click",
+    sign_in_require_password: true,
+    register_login_after_sale: false,
+    view_receipt_timeout: 10000,
+    outlet_enable_gift_cards: true,
+    outlet_gift_card_expiry_amount: 3,
+    outlet_gift_card_expiry_period: "years",
+    outlet_gift_card_expiry_change: true,
+    share_gift_cards: true,
+    share_held_sales: true,
+    display_details_on_customer_add: false,
+    register_customer_display_left: 0,
+    register_customer_display_top: 0,
+    register_never_open_cash_drawer: true,
+    use_average_cost: true,
+    has_weighable_products: false,
+    register_training_sales_mode_enabled: false,
+    sign_in_mask_username: false,
+    timezone: "Australia/Melbourne",
+    register_current_invoice_max: null,
+    outlet_accounts_flow_key: "",
+    register_customer_display: "",
+    keep_select_product_on_screen: false,
+    display_select_product_paginated: false,
+    outlet_email_receipt_template: null,
+    register_default_price_set: "default",
+    outlet_use_global_cost: true,
+    register_safe_drop_amount: Infinity,
+    register_print_receipt_on_refund: false,
+    integrate_liquid_mix: false,
+    register_integrated_receipts: true,
+    cross_promotion_count: true,
+    weight_price_labels: false,
+    note_on_held_sale: false,
+    use_components_and_packages: false,
+    outlet_update_last_cost_from_transfer: true,
+    outlet_update_average_cost_from_transfer: true,
+    outlet_send_transfers_using_average_cost: true,
+    outlet_default_statement: "",
+    price_change_notifications: false,
+    outlet_outlet_email: "noreply@onshopfront.com",
+    cost_calculation_method: "mixed",
+    statement_reply_email: "",
+    register_next_invoice_batch: null,
+    family_distribution: "match_price_points",
+    date_format: "DD/MM/YYYY",
+    time_format: "HH:mm:ss",
+    start_of_week: "monday",
+    profitability_display: "profit-percentage",
+    register_consolidate_sale_lines: true,
+    future_price_time: 0,
+    auto_logout_time: 0,
+    auto_logout_during_sale: false,
+    register_open_display_on_open_register: false,
+    currency_code: "AUD",
+    number_locale: "en-AU",
+    require_refund_reason: true,
+    use_barcode_templates: false,
+    show_order_prices_using_average_cost: false,
+    register_note_on_closure_discrepancy: false,
+    register_dark_mode: "light",
+    register_dedicated_promotion_worker: true,
+    sale_keys_position: "left",
+    outlet_sale_keys_position: "default",
+    register_sale_keys_position: "default",
+    user_sale_keys_position: "default",
+    enable_metcash_host_integration: false,
+    "outlet_metcash_credentials.customer_id": "",
+    "outlet_metcash_credentials.state_code": "",
+    "outlet_metcash_credentials.pillar_id": "",
+    "outlet_metcash_credentials.import_promotions": false,
+    "outlet_metcash_credentials.b2b_account": "",
+    "outlet_metcash_credentials.password": "",
+    "outlet_metcash_credentials.import_buying_periods": false,
+    rounding_mode: "redistribute",
+    search_customers_memory_level: "full",
+    search_products_memory_level: "full",
+    ui_logging_level: "essential",
+    register_customer_display_mode: "popup",
+    require_cash_drawer_reason: false,
+    search_save_location: "indexeddb",
+    outlet_discount_below_cost_behaviour: "ignore",
+    predefined_discount_reasons: [],
+    user_override_dark_mode: "default",
+    outlet_default_order_reviewers: [],
+    outlet_review_before_sending_order: false,
+    outlet_review_before_receiving_order: false,
+    outlet_review_before_sending_return: false,
+    outlet_review_before_sending_transfer: false,
+    outlet_review_before_receiving_transfer: false,
+    outlet_review_before_sending_credit_note: false,
+    outlet_review_receiving_quantity_discrepancy: false,
+    outlet_review_receiving_total_discrepancy: false,
+    outlet_review_receiving_cost_discrepancy: false,
+    outlet_minimum_order_review_approvals: 0,
+    predefined_cash_drawer_reasons: [],
+    predefined_cash_out_reasons: [],
+    predefined_cash_in_reasons: [],
+    set_prices_based_on: "cost_calculation_method",
+    sign_in_password_first_login: false,
+    register_invoice_number_mode: "incremental",
+    new_user_default_reporting_all_access: true,
+    flag_force_product_redesign: true,
+    "flag:use_css_tickets": false,
+    "flag:view_host_file": false,
+ };
+
+/* eslint-disable */
+// This file is automatically generated from Shopfront (generate:types). Manual changes will be overwritten.
+export interface LocalDatabaseBrand {
+    mdb_id: number | null;
+    name: string;
+    uuid: string;
+ }
+
+export interface LocalDatabaseCategory {
+    mdb_id: number | null;
+    name: string;
+    uuid: string;
+    metcash_msc: string | null;
+ }
+
+export interface LocalDatabaseContact {
+    address_city: string;
+    address_country: string;
+    address_postcode: string;
+    address_state: string;
+    address_street_1: string;
+    address_street_2: string;
+    address_suburb: string;
+    email: string;
+    facebook: string;
+    fax: string;
+    mobile: string;
+    phone: string;
+    twitter: string;
+    uuid: string;
+    website: string;
+ }
+
+export interface LocalDatabaseCustomer {
+    uuid: string;
+    account_limit: number | null;
+    account_receipt: string | null;
+    allow_account_sales: boolean;
+    autoprint_account_receipt: boolean;
+    autoprint_receipt: boolean;
+    autoprint_parked_receipt: boolean;
+    billing: LocalDatabaseContact;
+    billing_contact_id: string;
+    birthday: string | null;
+    business_number: string;
+    client_id: string;
+    code: string;
+    comments: string;
+    company: string;
+    current_owing: number;
+    customer_group_id: string | null;
+    delivery: LocalDatabaseContact;
+    delivery_contact_id: string;
+    disable_promotions: boolean;
+    email: string;
+    first_name: string;
+    gender: string;
+    invoice_message: string;
+    last_name: string;
+    loyalty: boolean;
+    loyalty_points: number;
+    loyalty_rate: number | null;
+    merged_into: string | null;
+    override_customer_group: boolean;
+    pricelist_id: string | null;
+    receipt: string | null;
+    require_order_reference: boolean;
+    full_name: string;
+    name_index: Array<string>;
+    phones: Array<string>;
+ }
+
+export interface LocalDatabaseCustomerDisplay {
+    idle_display: string;
+    main_colour: string;
+    name: string;
+    sale_display: string;
+    text_colour: string;
+    uuid: string;
+ }
+
+export interface LocalDatabaseCustomerGroup {
+    account_limit: number | null;
+    account_receipt_id: string | null;
+    allow_account_sales: boolean;
+    auto_email_receipt: boolean;
+    autoprint_account_receipt: boolean;
+    autoprint_receipt: boolean;
+    autoprint_parked_receipt: boolean;
+    credit_terms: Array<string> | null;
+    disable_promotions: boolean;
+    email_receipt_id: string | null;
+    loyalty: boolean;
+    loyalty_rate: number | null;
+    name: string;
+    pricelist_id: string | null;
+    statement_template_id: string | null;
+    require_order_reference: boolean;
+    uuid: string;
+ }
+
+export interface LocalDatabaseFamily {
+    mdb_id: number | null;
+    name: string;
+    uuid: string;
+ }
+
+export interface LocalDatabaseGiftCard {
+    client_id: string;
+    code: string;
+    current_amount: number;
+    expiry: string;
+    original_amount: number;
+    outlet_id: string;
+    status: "active" | "cancelled" | "pending";
+    uuid: string;
+ }
+
+export interface LocalDatabaseKitchenScreen {
+    uuid: string;
+    name: string;
+    rules: {
+        ready: "NOT_DONE"
+            | "NOT_STARTED"
+            | "STARTED"
+            | "DONE",
+        categories: Array<string>,
+        tags: Array<string>,
+        registers: Array<string>,
+        outlets: Array<string>,
+    };
+ }
+
+export interface LocalDatabaseOutlet {
+    uuid: string;
+    loyalty_enabled: boolean;
+    loyalty_name: string;
+    has_kitchen_screen: boolean;
+    name: string;
+    business_number: string;
+    contact: LocalDatabaseContact | null;
+    logo: string | null;
+    settings: Record<string, OptionValue>;
+    ticketing_price_set_id: string | null;
+ }
+
+export interface LocalDatabasePageRule {
+    type: "PRODUCT_WIZARD" | "CUSTOMER_WIZARD" | "PROMOTION_WIZARD";
+    rule: string;
+ }
+
+export interface LocalDatabasePaymentMethod {
+    actual_denominations: string;
+    allow_cash_out: boolean;
+    always_open_drawer: boolean;
+    always_print: boolean;
+    background_colour: string;
+    cashout_method_id: string | null;
+    dark_mode_background_colour: string;
+    dark_mode_text_colour: string;
+    default_pay_exact: boolean;
+    gateway_url: string;
+    name: string;
+    surcharge: number;
+    text_colour: string;
+    action: string;
+    type: "global"
+        | "cash"
+        | "eftpos"
+        | "giftcard"
+        | "voucher"
+        | "cheque"
+        | "pc-eftpos"
+        | "linkly-vaa"
+        | "direct-deposit"
+        | "tyro"
+        | "custom";
+    use_rounding: boolean;
+    uuid: string;
+ }
+
+export interface LocalDatabasePriceSet {
+    name: string;
+    uuid: string;
+    parent_id: string | null;
+ }
+
+export interface LocalDatabaseSyncablePriceListExclude {
+    brands: Array<string>;
+    categories: Array<string>;
+    families: Array<string>;
+    products: Array<string>;
+    tags: Array<string>;
+ }
+
+export interface LocalDatabasePriceList {
+    active: boolean;
+    allow_higher_price: boolean;
+    allow_discounting_promotions: boolean;
+    brands: Array<{
+        min_rule: "no-minimum"
+            | "discount-percentage"
+            | "discount-amount"
+            | "discount-item-amount"
+            | "cost-percentage"
+            | "cost-amount"
+            | "last-cost-percentage"
+            | "last-cost-amount",
+        min_rule_amount: number,
+        rule: "discount-percentage"
+            | "discount-amount"
+            | "discount-item-amount"
+            | "cost-percentage"
+            | "cost-amount"
+            | "last-cost-percentage"
+            | "last-cost-amount",
+        rule_amount: number,
+        uuid: string,
+    }>;
+    categories: Array<{
+        min_rule: "no-minimum"
+            | "discount-percentage"
+            | "discount-amount"
+            | "discount-item-amount"
+            | "cost-percentage"
+            | "cost-amount"
+            | "last-cost-percentage"
+            | "last-cost-amount",
+        min_rule_amount: number,
+        rule: "discount-percentage"
+            | "discount-amount"
+            | "discount-item-amount"
+            | "cost-percentage"
+            | "cost-amount"
+            | "last-cost-percentage"
+            | "last-cost-amount",
+        rule_amount: number,
+        uuid: string,
+    }>;
+    excludes: LocalDatabaseSyncablePriceListExclude;
+    fallback_rule: {
+        min_rule: "no-minimum"
+            | "discount-percentage"
+            | "discount-amount"
+            | "discount-item-amount"
+            | "cost-percentage"
+            | "cost-amount"
+            | "last-cost-percentage"
+            | "last-cost-amount",
+        min_rule_amount: number,
+        rule: "discount-percentage"
+            | "discount-amount"
+            | "discount-item-amount"
+            | "cost-percentage"
+            | "cost-amount"
+            | "last-cost-percentage"
+            | "last-cost-amount",
+        rule_amount: number,
+    } | null;
+    families: Array<{
+        min_rule: "no-minimum"
+            | "discount-percentage"
+            | "discount-amount"
+            | "discount-item-amount"
+            | "cost-percentage"
+            | "cost-amount"
+            | "last-cost-percentage"
+            | "last-cost-amount"
+            | "override",
+        min_rule_amount: number,
+        rule: "discount-percentage"
+            | "discount-amount"
+            | "discount-item-amount"
+            | "cost-percentage"
+            | "cost-amount"
+            | "last-cost-percentage"
+            | "last-cost-amount"
+            | "override",
+        rule_amount: number,
+        min_prices: Array<{
+            quantity: number,
+            price: number,
+        }>,
+        prices: Array<{
+            quantity: number,
+            price: number,
+        }>,
+        uuid: string,
+    }>;
+    name: string;
+    products: Array<{
+        min_rule: "no-minimum"
+            | "discount-percentage"
+            | "discount-amount"
+            | "discount-item-amount"
+            | "cost-percentage"
+            | "cost-amount"
+            | "last-cost-percentage"
+            | "last-cost-amount"
+            | "override",
+        min_rule_amount: number,
+        rule: "discount-percentage"
+            | "discount-amount"
+            | "discount-item-amount"
+            | "cost-percentage"
+            | "cost-amount"
+            | "last-cost-percentage"
+            | "last-cost-amount"
+            | "override",
+        rule_amount: number,
+        min_prices: Array<{
+            quantity: number,
+            price: number,
+        }>,
+        prices: Array<{
+            quantity: number,
+            price: number,
+        }>,
+        uuid: string,
+    }>;
+    tags: Array<{
+        min_rule: "no-minimum"
+            | "discount-percentage"
+            | "discount-amount"
+            | "discount-item-amount"
+            | "cost-percentage"
+            | "cost-amount"
+            | "last-cost-percentage"
+            | "last-cost-amount",
+        min_rule_amount: number,
+        rule: "discount-percentage"
+            | "discount-amount"
+            | "discount-item-amount"
+            | "cost-percentage"
+            | "cost-amount"
+            | "last-cost-percentage"
+            | "last-cost-amount",
+        rule_amount: number,
+        uuid: string,
+    }>;
+    uuid: string;
+ }
+
+export interface LocalDatabaseBarcode {
+    code: string;
+    quantity: string;
+    template: string | null;
+ }
+
+export interface LocalDatabaseInventory {
+    outlet_id: string;
+    single_level: number;
+    case_level: number;
+    single_reorder_level: number;
+    case_reorder_level: number;
+    single_reorder_amount: number;
+    case_reorder_amount: number;
+    single_reorder_limit: number | null;
+    case_reorder_limit: number | null;
+    single_max_quantity: number | null;
+    case_max_quantity: number | null;
+    reorder_rounding: "none"
+        | "ceiling"
+        | "floor"
+        | "natural";
+ }
+
+export interface LocalDatabaseLoyalty {
+    classification_id: string;
+    classification_type: string;
+    loyalty_value: number;
+    outlet_id: string;
+    quantity: number;
+    redeem_value: number | null;
+ }
+
+export interface LocalDatabasePrice {
+    price: number;
+    price_set_id: string | null;
+    quantity: number;
+ }
+
+export interface LocalDatabaseProduct {
+    additional: Record<string, string>;
+    average_cost: string;
+    alternate_names: Array<{
+        host_connection_id: string,
+        quantity: number | null,
+        name: string,
+    }>;
+    barcodes: Array<LocalDatabaseBarcode>;
+    brand_id: string | null;
+    case_quantity: number;
+    category_id: string | null;
+    components: Array<{
+        add_price: number,
+        quantity: number,
+        remove_price: number,
+        uuid: string,
+    }>;
+    core_supplier_id: string | null;
+    cost: string;
+    cost_percentage: boolean;
+    costs: Array<{
+        outlet_id: string,
+        average_cost: string,
+        last_cost: string,
+    }>;
+    description: string;
+    family_id: string | null;
+    image: string | null;
+    inventory: Array<LocalDatabaseInventory>;
+    last_cost: string;
+    last_supplier_id: string | null;
+    loyalty_rates: Array<LocalDatabaseLoyalty>;
+    mdb_id: number | null;
+    name: string;
+    order_notes: string;
+    invoice_notes: string;
+    parents: Array<string>;
+    prices: Array<LocalDatabasePrice>;
+    request_price: boolean;
+    request_quantity: boolean;
+    prevent_manual_discounts: boolean;
+    ignore_price_host_changes: boolean;
+    ignore_barcode_host_changes: boolean;
+    status: "active"
+        | "inactive"
+        | "not-selling"
+        | "not-purchasing";
+    suppliers: Array<{
+        minimum_order_quantity: number,
+        supplier_code: string,
+        uuid: string,
+    }>;
+    tags: Array<string>;
+    tax_rate: {
+        uuid: string,
+        amount: number,
+    } | null;
+    cost_tax_rate: {
+        amount: number,
+        uuid: string,
+    } | null;
+    track_inventory: boolean;
+    type: "normal"
+        | "basket"
+        | "voucher"
+        | "package"
+        | "component"
+        | "integrated";
+    use_barcode_templates: boolean;
+    use_scales: boolean;
+    uuid: string;
+    name_index: Array<string>;
+    supplier_ids: Array<string>;
+    supplier_codes: Array<string>;
+    code_index: Array<string>;
+ }
+
+export interface LocalDatabaseSyncablePromotionCriteriaItem {
+    id: string;
+    type: string;
+    rebate: number;
+    exclude: boolean;
+ }
+
+export interface LocalDatabasePromotionCriteria {
+    type: "sell-item"
+        | "sell-total"
+        | "discount-item-amount"
+        | "discount-total-amount"
+        | "discount-percentage"
+        | "sell-rate"
+        | "quantity-only";
+    quantity_type: "exact" | "more";
+    buy_amount_type: "quantity" | "amount";
+    buy_amount: number;
+    buy_amount_max: number | null;
+    discount_amount: number;
+    min_quantity: number | null;
+    optional: boolean;
+    mixed_only: boolean;
+    exclude_price_points: boolean;
+    discount_everyday_promotions: boolean;
+    exclude_count_quantity: boolean;
+    items: Array<LocalDatabaseSyncablePromotionCriteriaItem>;
+    products: Array<{ uuid: string; rebate: number; }>;
+    brands: Array<{ uuid: string; rebate: number; }>;
+    categories: Array<{ uuid: string; rebate: number; }>;
+    families: Array<{ uuid: string; rebate: number; }>;
+    tags: Array<{ uuid: string; rebate: number; }>;
+    allItems: null | number;
+    excludes: {
+        products: Array<string>;
+        categories: Array<string>;
+        brands: Array<string>;
+        families: Array<string>;
+        tags: Array<string>;
+    };
+ }
+
+export interface LocalDatabasePromotion {
+    uuid: string;
+    name: string;
+    mdb_id: number | null;
+    express: boolean;
+    promotion_category_id: string | null;
+    active: boolean;
+    start: string | null;
+    end: string | null;
+    available_to: Array<string> | null;
+    mix_criteria: boolean;
+    sale_max_application_count: number | null;
+    criteria: Array<LocalDatabasePromotionCriteria>;
+    outlets: Array<string>;
+    has_schedule: boolean;
+    activated_by: string | null;
+ }
+
+export interface LocalDatabasePromotionCategory {
+    name: string;
+    uuid: string;
+    show_on_order: boolean;
+    source: string | null;
+ }
+
+export interface LocalDatabaseReceipt {
+    accountReceipt: boolean;
+    components: string;
+    padding: {
+        top: number | null,
+        left: number | null,
+        right: number | null,
+        bottom: number | null,
+    } | null;
+    name: string;
+    receiptWidth: number;
+    type: "receipt-text"
+        | "receipt-full"
+        | "a4"
+        | "email";
+    uuid: string;
+    attachments: Array<{
+        name: string,
+        receipt: string,
+    }> | null;
+ }
+
+export interface LocalDatabaseSyncableRegisterSurcharge {
+    id: number;
+    type: "PERCENTAGE" | "FIXED";
+    amount: number;
+    taxRate: string | null;
+    day: "MONDAY"
+        | "TUESDAY"
+        | "WEDNESDAY"
+        | "THURSDAY"
+        | "FRIDAY"
+        | "SATURDAY"
+        | "SUNDAY";
+    start: string;
+    end: string;
+    name: string;
+    appliesTo: Array<{
+        id: string,
+        type: "Category" | "Tag",
+    }> | null;
+ }
+
+export interface LocalDatabaseRegister {
+    uuid: string;
+    closure_print_settings: {
+        account: "table" | "total" | "none",
+        account_payments: "table" | "total" | "none",
+        discounts: "table" | "total" | "none",
+        gift_cards_redeemed: "table" | "total" | "none",
+        gift_cards_sold: "table" | "total" | "none",
+        movements: "table" | "total" | "none",
+        payments: "table" | "total" | "none",
+        refunds: "table" | "total" | "none",
+        tax: "table" | "total" | "none",
+        loyalty: "table" | "total" | "none",
+        notes: boolean,
+        tags: boolean,
+        payment_subtypes: boolean,
+        statistics: boolean,
+    };
+    close_register_tags: Array<string>;
+    float: {
+        monday: number,
+        tuesday: number,
+        wednesday: number,
+        thursday: number,
+        friday: number,
+        saturday: number,
+        sunday: number,
+    };
+    surcharges: Array<LocalDatabaseSyncableRegisterSurcharge> | null;
+    surcharging_enabled: boolean;
+    name: string;
+    outlet_id: string;
+    payment_methods: Array<string>;
+    settings: Record<string, OptionValue>;
+ }
+
+export interface LocalDatabaseSaleKey {
+    uuid: string;
+    name: string;
+    keys: Record<string, any>;
+ }
+
+export interface LocalDatabaseSupplier {
+    uuid: string;
+    account_number: string;
+    business_number: string;
+    comments: string;
+    contact: LocalDatabaseContact;
+    default_order_tax: "inc_tax" | "ex_tax" | "ex_wet";
+    distribute_fees: "proportionally" | "evenly";
+    distribute_freight: "items" | "cases" | "mixed";
+    email_format: "inline" | "csv" | "pdf";
+    fee_amount: number;
+    mdb_id: number | null;
+    name: string;
+    order_automatic_email: boolean;
+    allow_order_below_minimum: boolean;
+    order_notes: string;
+    order_internal_notes: string;
+    freight_included_on_invoices: boolean;
+    freight_tax_id: string | null;
+    fees_tax_id: string | null;
+    minimum_order_value: number | null;
+    maximum_order_value: number | null;
+    status: "ACTIVE" | "INACTIVE";
+    default_days_until_due: number | null;
+    freight_fixed_cost_per_case: number | null;
+ }
+
+export interface LocalDatabaseTag {
+    mdb_id: number | null;
+    name: string;
+    uuid: string;
+ }
+
+export interface LocalDatabaseTaxRate {
+    amount: number;
+    mdbId: number | null;
+    name: string;
+    uuid: string;
+ }
+
+export interface LocalDatabaseTransferee {
+    uuid: string;
+    name: string;
+    email_format: "inline" | "csv" | "pdf";
+    order_automatic_email: boolean;
+    contact: LocalDatabaseContact;
+ }
+
+export interface LocalDatabaseUser {
+    dashboard: string;
+    email: string;
+    image: string;
+    is_api_user: boolean;
+    last_login_at: string | null;
+    name: string;
+    permissions: Record<string, number> | null;
+    scope: Record<string, number>;
+    phone: string;
+    quick_menu: Array<{
+        external: boolean,
+        id: number,
+        name: string,
+        url: string,
+    }>;
+    role_id: string | null;
+    sale_keys: string;
+    sale_keys_position: "default" | "left" | "right";
+    dark_mode: "default"
+        | "dark"
+        | "light"
+        | "auto";
+    favourite_fields: Record<"product", Array<string>>;
+    username: string;
+    uuid: string;
+ }
+
+export abstract class BaseRepository<DataType extends object = object, IdType = string> {
+    public abstract all(orderBy?: string): Promise<Array<DataType>>;
+    public abstract get(uuid: IdType): Promise<DataType>;
+    public abstract put(item: Array<DataType> | DataType): Promise<IdType>;
+    public abstract update(uuid: IdType, changes: Partial<DataType>): Promise<void>;
+    public abstract count(): Promise<number>;
+    public abstract empty(): Promise<void>;
+    public abstract delete(items: IdType | Array<IdType>): Promise<void>;
+    public abstract each(callback: (item: DataType) => void): Promise<void>;
+
+    /**
+     * Access the source data directly, ensure instanceof is used.
+     * TODO: Remove this.
+     */
+    public abstract raw(): any;
+}
+
+
+export interface BaseSearchableRepository<DataType extends object, SearchOptions = undefined> {
+    search(needle: string, options?: Partial<SearchOptions>): Promise<Array<DataType>>;
+}
+
+
+export interface LocalDatabaseApplication {
+    auth: string;
+    embedded: string;
+    id: string;
+    name: string;
+    logo: string;
+    expiryDate: string;
+}
+
+export type BaseApplicationRepository =
+    BaseRepository<LocalDatabaseApplication> &
+    BaseSearchableRepository<LocalDatabaseApplication>;
+
+
+export interface LocalDatabaseBarcodeTemplate {
+    id: number;
+    name: string;
+    recalculate_quantity: boolean;
+    template: string;
+}
+
+export type BaseBarcodeTemplateRepository = BaseRepository<LocalDatabaseBarcodeTemplate, number>;
+
+
+export type BaseCategoryRepository =
+    BaseRepository<LocalDatabaseCategory> &
+    BaseSearchableRepository<LocalDatabaseCategory>;
+
+
+export interface LocalDatabaseClassification {
+    name: string;
+    uuid: string;
+    mdb_id: number | null;
+}
+
+export type BaseClassificationRepository =
+    BaseRepository<LocalDatabaseClassification> &
+    BaseSearchableRepository<LocalDatabaseClassification>;
+
+
+export type BaseCustomerDisplayRepository = BaseRepository<LocalDatabaseCustomerDisplay>;
+
+
+export type BaseCustomerGroupRepository =
+    BaseRepository<LocalDatabaseCustomerGroup> &
+    BaseSearchableRepository<LocalDatabaseCustomerGroup>;
+
+
+export interface CustomerRepositorySearchOptions {
+    name: boolean;
+    code: boolean;
+    email: boolean;
+    phone: boolean;
+    company: boolean;
+    customerGroups: Array<string>;
+    exactMatch: boolean;
+    sort: boolean;
+    limit: number;
+    filter: ((customer: LocalDatabaseCustomer) => boolean) | undefined;
+}
+
+export interface BaseCustomerRepository extends
+    BaseRepository<LocalDatabaseCustomer>,
+    BaseSearchableRepository<
+        LocalDatabaseCustomer,
+        CustomerRepositorySearchOptions
+    >
+{
+    getByCustomerGroup(customerGroupId: string): Promise<Array<LocalDatabaseCustomer>>;
+    getByPriceList(priceListId: string): Promise<Array<LocalDatabaseCustomer>>;
+}
+
+
+export abstract class BaseDataSource implements DataSourceTables {
+    // Tables
+    public products!: BaseProductRepository;
+    public customers!: BaseCustomerRepository;
+    public customerGroups!: BaseCustomerGroupRepository;
+    public promotions!: BasePromotionRepository;
+    public promotionCategories!: BasePromotionCategoryRepository;
+    public users!: BaseUserRepository;
+    public priceLists!: BasePriceListRepository;
+    public paymentMethods!: BasePaymentMethodRepository;
+    public salesKeys!: BaseSalesKeyRepository;
+    public receipts!: BaseReceiptRepository;
+    public giftCards!: BaseGiftCardRepository;
+    public loyalty!: BaseLoyaltyRepository;
+    public customerDisplays!: BaseCustomerDisplayRepository;
+    public sales!: BaseSalesRepository;
+    public brands!: BaseClassificationRepository;
+    public categories!: BaseCategoryRepository;
+    public families!: BaseClassificationRepository;
+    public tags!: BaseClassificationRepository;
+    public outlets!: BaseOutletRepository;
+    public registers!: BaseRegisterRepository;
+    public uploads!: BaseUploadRepository;
+    public taxRates!: BaseTaxRateRepository;
+    public takings!: BaseTakingsRepository;
+    public pageRules!: BasePageRuleRepository;
+    public suppliers!: BaseSupplierRepository;
+    public priceSets!: BasePriceSetRepository;
+    public transferees!: BaseTransfereeRepository;
+    public movements!: BaseMovementRepository;
+    public stocktakes!: BaseStocktakeRepository;
+    public stocktakeScanned!: BaseStocktakeScannedRepository;
+    public stocktakeAccumulated!: BaseStocktakeAccumulatedRepository;
+    public applications!: BaseApplicationRepository;
+    public barcodeTemplates!: BaseBarcodeTemplateRepository;
+    public vendorConnections!: BaseVendorConnectionRepository;
+    public lockedResources!: BaseLockedResourceRepository;
+    public system!: BaseSystemRepository;
+    public enterprises!: BaseEnterpriseRepository;
+    public kitchenOrders!: BaseKitchenOrderRepository;
+    public kitchenScreens!: BaseKitchenScreenRepository;
+
+    // Methods
+    public abstract transaction(table: Array<keyof DataSourceTables>, callback: () => Promise<void>): Promise<void>;
+    public abstract clearDatabase(): Promise<void>;
+    public abstract getVersion(): Promise<number | undefined>;
+}
+
+
+export interface LocalDatabaseEnterprise {
+    auth: string;
+    id: string;
+    name: string;
+}
+
+export type BaseEnterpriseRepository =
+    BaseRepository<LocalDatabaseEnterprise> &
+    BaseSearchableRepository<LocalDatabaseEnterprise>;
+
+
+
+
+export interface BaseGiftCardRepository extends BaseRepository<LocalDatabaseGiftCard> {
+    getByCode(code: string): Promise<Array<LocalDatabaseGiftCard>>;
+}
+
+
+export interface KitchenOrderItemComponent {
+    id: string;
+    name: string;
+    quantity: number;
+    components: Array<KitchenOrderItemComponent>;
+}
+
+export interface KitchenOrderItem {
+    id: string; // This is a unique ID for the item on the order
+    product: string; // The general ID of the item
+    ready: boolean;
+    category: string;
+    tags: Array<string>;
+    name: string;
+    quantity: number;
+    note: string;
+    components: Array<KitchenOrderItemComponent>;
+}
+
+export interface KitchenOrder {
+    id: string; // This is a unique ID for the order, not necessarily the sale ID
+    register: string;
+    outlet: string;
+    invoiceId: string;
+    note: string;
+    internalNote: string;
+    saleTime: string;
+    customerName: null | string;
+    items: Array<KitchenOrderItem>;
+}
+
+export interface LocalKitchenOrder {
+    version: number;
+    id: string;
+    order: KitchenOrder;
+}
+
+export interface BaseKitchenOrderRepository extends BaseRepository<LocalKitchenOrder> {
+    removeVersionsBefore(version: number): Promise<void>;
+}
+
+
+export type KitchenDisplayRuleReady = "NOT_DONE" | "NOT_STARTED" | "STARTED" | "DONE";
+
+export interface KitchenDisplayFilterRules {
+    ready: KitchenDisplayRuleReady;
+    categories: Array<string>;
+    tags: Array<string>;
+    registers: Array<string>;
+    outlets: Array<string>;
+}
+
+export interface LocalKitchenScreen {
+    uuid: string;
+    name: string;
+    rules: KitchenDisplayFilterRules;
+}
+
+export interface BaseKitchenScreenRepository extends BaseRepository<LocalKitchenScreen> {}
+
+
+export interface LocalDatabaseLockedResource {
+    type: string;
+    uuid: string;
+    resource: string;
+}
+
+export interface BaseLockedResourceRepository extends BaseRepository<
+    LocalDatabaseLockedResource
+> {
+    getByResource(resource: string): Promise<LocalDatabaseLockedResource>;
+}
+
+
+export type LoyaltyUnion = "brand" | "category" | "family" | "tag" | "product";
+
+export interface LocalDatabaseOutletLoyalty {
+    id: number;
+    loyalty_value: null | string; // TODO: Make a number
+    quantity: string; // TODO: Make a number
+    redeem_value: null | string; // TODO: Make a number
+    type: LoyaltyUnion;
+    uuid: string; // The ID of the classification
+}
+
+export interface BaseLoyaltyRepository extends BaseRepository<LocalDatabaseOutletLoyalty, number> {
+    getByType(id: string, type: LoyaltyUnion): Promise<Array<LocalDatabaseOutletLoyalty>>;
+}
+
+
+export interface LocalDatabaseMovement {
+    amount: string; // TODO: Make a number
+    denominations: Array<{
+        direction: "IN" | "OUT";
+        denomination: number;
+        amount: number;
+    }>;
+    paymentMethod: string;
+    reason: string;
+    register: string;
+    timestamp: string;
+    user: string;
+    uuid: string;
+}
+
+export type BaseMovementRepository = BaseRepository<LocalDatabaseMovement>;
+
+
+export interface BaseOutletRepository extends BaseRepository<LocalDatabaseOutlet> {
+    update(id: string, changes: Partial<LocalDatabaseOutlet>): Promise<void>;
+}
+
+
+export abstract class BasePageRuleRepository extends BaseRepository<LocalDatabasePageRule> {}
+
+
+export type PaymentMethodTypeUnion = LocalDatabasePaymentMethod["type"];
+
+export interface BasePaymentMethodRepository extends BaseRepository<LocalDatabasePaymentMethod> {
+    getByType(type: PaymentMethodTypeUnion | Array<PaymentMethodTypeUnion>): Promise<Array<LocalDatabasePaymentMethod>>;
+}
+
+
+export type PriceListRuleUnion = LocalDatabasePriceList["products"][number]["rule"];
+export type PriceListRuleBaseUnion = Omit<PriceListRuleUnion, "override">;
+
+export type LocalDatabasePriceListFallback = LocalDatabasePriceList["fallback_rule"];
+
+export type LocalDatabasePriceListRule = LocalDatabasePriceListFallback & {
+    uuid: string;
+};
+
+export type LocalDatabasePriceListWithPricesRule = LocalDatabasePriceList["products"][number];
+
+export type PriceListItemTypeUnion = keyof LocalDatabaseSyncablePriceListExclude;
+
+export interface BasePriceListRepository extends
+    BaseRepository<LocalDatabasePriceList>,
+    BaseSearchableRepository<LocalDatabasePriceList>
+{}
+
+
+export type BasePriceSetRepository = BaseRepository<LocalDatabasePriceSet>;
+
+
+export type LocalDatabaseCost = LocalDatabaseProduct["costs"][number];
+export type ProductTypeUnion = LocalDatabaseProduct["type"];
+export type ProductStatusUnion = LocalDatabaseProduct["status"];
+
+export type ProductRepositorySearchOptions = {
+    name: boolean;
+    barcode: boolean | string;
+    exactMatch: boolean; // TODO: Remove
+    quantityCheck: boolean;
+    quantityCount: number;
+    sort: boolean;
+    filter: undefined | ((product: LocalDatabaseProduct) => boolean);
+    exact: boolean;
+    limit: number;
+};
+
+export interface ProductSearchDataType {
+    quantity?: number;
+    kind?: "product";
+    searchBarcode?: string;
+}
+
+export type ProductSearchResultType = LocalDatabaseProduct & ProductSearchDataType;
+
+export type ProductClassificationUnion = "category" |
+    "brand" |
+    "family" |
+    "tag" |
+    "supplier" |
+    "supplier_code";
+
+export interface BaseProductRepository extends
+    BaseRepository<LocalDatabaseProduct>,
+    BaseSearchableRepository<
+        ProductSearchResultType,
+        ProductRepositorySearchOptions
+    >
+{
+    getFromClassification(
+        classificationType: ProductClassificationUnion,
+        uuid: string
+    ): Promise<Array<LocalDatabaseProduct>>;
+    getByStatus(status: ProductStatusUnion | Array<ProductStatusUnion>): Promise<Array<LocalDatabaseProduct>>;
+    getByType(type: ProductTypeUnion | Array<ProductTypeUnion>): Promise<Array<LocalDatabaseProduct>>;
+    getBulk(ids: Array<string>): Promise<Array<LocalDatabaseProduct>>;
+    getByMDBId(mdbId: number): Promise<Array<LocalDatabaseProduct>>;
+    getBySupplierCodes(supplierCodes: Array<string>): Promise<Array<LocalDatabaseProduct>>;
+    update(id: string, changes: Partial<LocalDatabaseProduct>): Promise<void>;
+    clearCache(): void;
+}
+
+
+export type BasePromotionCategoryRepository =
+    BaseRepository<LocalDatabasePromotionCategory> &
+    BaseSearchableRepository<LocalDatabasePromotionCategory>;
+
+
+export type LocalDatabaseCriteriaTypeUnion = LocalDatabasePromotionCriteria["type"];
+
+export type PromotionClassificationUnion = "categories" |
+    "brands" |
+    "families" |
+    "tags";
+
+export interface BasePromotionRepository extends BaseRepository<
+    LocalDatabasePromotion
+>, BaseSearchableRepository<LocalDatabasePromotion> {
+    update(id: string, update: Partial<LocalDatabasePromotion>): Promise<void>;
+    getPromotionsForProduct(product: string): Promise<Array<string>>;
+    getByCategory(id: string): Promise<Array<LocalDatabasePromotion>>;
+    getByClassification(type: PromotionClassificationUnion, id: string): Array<string>;
+    filter(filter: (promotion: LocalDatabasePromotion) => boolean): Promise<Array<LocalDatabasePromotion>>;
+    simulate(originalId: null | string, promotion: null | LocalDatabasePromotion): Promise<void>;
+    getBulk(ids: Array<string>): Promise<Array<LocalDatabasePromotion>>;
+    mapToCache(): Promise<void>;
+}
+
+
+export type ReceiptTypeUnion = LocalDatabaseReceipt["type"];
+export type ReceiptServerTypeUnion = "NORMAL" | "TEXT_ONLY" | "A4" | "EMAIL";
+
+export const ReceiptServerToLocalMap: Record<ReceiptServerTypeUnion, ReceiptTypeUnion> = {
+    NORMAL   : "receipt-full",
+    TEXT_ONLY: "receipt-text",
+    A4       : "a4",
+    EMAIL    : "email",
+};
+
+export const ReceiptLocalToServerMap: Record<ReceiptTypeUnion, ReceiptServerTypeUnion> = {
+    "receipt-full": "NORMAL",
+    "receipt-text": "TEXT_ONLY",
+    "a4"          : "A4",
+    "email"       : "EMAIL",
+};
+
+export type ReceiptPaddingType = Exclude<LocalDatabaseReceipt["padding"], null>;
+
+export interface BaseReceiptRepository extends BaseRepository<LocalDatabaseReceipt> {
+    filter(filter: (item: LocalDatabaseReceipt) => boolean): Promise<Array<LocalDatabaseReceipt>>;
+    getByType(type: ReceiptTypeUnion): Promise<Array<LocalDatabaseReceipt>>;
+}
+
+
+export type DayOfWeek =
+    "monday" |
+    "tuesday" |
+    "wednesday" |
+    "thursday" |
+    "friday" |
+    "saturday" |
+    "sunday";
+
+export type ShouldPrintOptions = LocalDatabaseRegister["closure_print_settings"]["account"];
+
+export interface BaseRegisterRepository extends BaseRepository<LocalDatabaseRegister> {
+    update(id: string, changes: Partial<LocalDatabaseRegister>): Promise<void>;
+}
+
+
+export type SaleKeyActionType =
+    "add-single" |
+    "add-case" |
+    "add-giftcard" |
+    "product-details" |
+    "case" |
+    "open-drawer" |
+    "add-note" |
+    "create-customer" |
+    "return-item" |
+    "flip-sale" |
+    "pay-exact" |
+    "pay-amount" |
+    "view-promotions" |
+    "sale-search" |
+    "cancel-sale" |
+    "add-product" |
+    "subtract-product" |
+    "add-product-barcode" |
+    "subtract-product-barcode" |
+    "open-folder" |
+    "previous-folder" |
+    "display-classification" |
+    "keyboard" |
+    "reweigh" |
+    "customer-list" |
+    "live-profit" |
+    "current-time" |
+    "previous-date" |
+    "add-component" |
+    "remove-component" |
+    "display-classification-case" |
+    "change-price-set" |
+    "add-customer" |
+    "make-customer-payment" |
+    "apply-discount" |
+    "add-component-to-current" |
+    "remove-component-from-current" |
+    "add-order-reference" |
+    "search-additional" |
+    "show-backorders" |
+    "pay-loyalty";
+
+// Note: Actions connected to the Embedded API are the reason for the string union
+export type SaleKeyActionUnion = SaleKeyActionType | "noop" | string;
+
+export interface SaleKeyType {
+    action: SaleKeyActionUnion;
+    actionargs: Record<string, unknown>;
+    background: string;
+    backgroundhover: string;
+    bordercolour: string;
+    constrainheight: boolean;
+    constrainwidth: boolean;
+    disabled: boolean;
+    fill: boolean;
+    hover: boolean;
+    hoveranimation: boolean;
+    image: string | null;
+    imagehover: string | null;
+    preventdisable: boolean;
+    text: string;
+    textcolour: string;
+    texthover: string;
+    texthovercolour: string;
+    top: number;
+    left: number;
+    width: number;
+    height: number;
+    fontSize?: number;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+}
+
+export interface LocalDatabaseSaleKeys {
+    keys: Array<SaleKeyType>;
+    name: string;
+    uuid: string;
+}
+
+export type BaseSalesKeyRepository = BaseRepository<LocalDatabaseSaleKeys>;
+
+
+export type SaleActionType =
+// If changing, modify SaleActionEnum.php
+    "PRODUCT_SCAN" |
+    "PRODUCT_SEARCH_ADD" |
+    "PRODUCT_KEY_ADD" |
+    "QUANTITY_OVERRIDE" |
+    "INCREMENT" |
+    "DECREMENT" |
+    "REMOVE_PRODUCT" |
+    "CUSTOMER_SCAN" |
+    "CUSTOMER_SEARCH_ADD" |
+    "CUSTOMER_KEY_ADD" |
+    "REMOVE_CUSTOMER" |
+    "ADD_PAYMENT" |
+    "REMOVE_PAYMENT";
+
+export interface SaleAction {
+    timestamp: string;
+    action: SaleActionType;
+    // for product / customer scan this is the barcode,
+    // for product / customer search add this is the search string
+    // for product / customer key add this is the key's rules
+    // for quantity override this is the new quantity,
+    // for increment / decrement it is the amount incremented
+    // for remove product this is "keyboard" or "trash"
+    // for remove customer this is blank
+    // for add / remove payment this is the internal id of the payment
+    value: string;
+    affecting: string; // The ID of the item this is affecting, e.g. product, customer, payment method
+    user: string; // The ID of the user
+}
+
+export type LocalDatabaseSalePaymentStatus = "cancelled" | "completed" | "failed";
+
+type SaleStatus = "COMPLETED" | "CANCELLED" | "PARKED" | "INCOMPLETE" | "UNPARKED";
+export type ServerSaleStatus = "COMPLETED" | "CANCELLED" | "PARKED" | "INCOMPLETE";
+
+export interface LocalDatabaseSaleItemTypeProduct {
+    id: string;
+    type: "Product";
+    name: string;
+}
+
+export interface LocalDatabaseSaleItemTypeGiftCard {
+    type: "GiftCard";
+    id: string;
+    name: string;
+    code: string;
+    expiry: string;
+    source: string;
+}
+
+export interface LocalDatabaseSaleItemTypeSurcharge {
+    type: "Surcharge";
+}
+
+export type LocalDatabaseSaleItemType =
+    LocalDatabaseSaleItemTypeProduct |
+    LocalDatabaseSaleItemTypeGiftCard |
+    LocalDatabaseSaleItemTypeSurcharge;
+
+export interface LocalDatabaseSaleItemPromotion {
+    promotion: string;
+    rebateAmount: number;
+    rebateQuantity: number;
+    savings: number;
+    quantity: number;
+}
+
+export interface LocalDatabaseSaleItem {
+    basePrice: number;
+    caseQuantity: number;
+    cost?: number;
+    discount: {
+        amount: string; // TODO: Make a number
+        reason: string;
+    };
+    item: LocalDatabaseSaleItemType;
+    loyaltyValue: number;
+    note: string;
+    products: Array<LocalDatabaseSaleItem>;
+    promotions: Array<LocalDatabaseSaleItemPromotion>;
+    quantity: number;
+    savings: number;
+    tax: number;
+    taxRate: string | null;
+    totalPrice: number;
+    priceList: boolean;
+    metaData: Record<string, unknown>;
+}
+
+export interface LocalDatabaseSalePayment {
+    amount: number;
+    metaData?: Record<string, any>;
+    metadata?: unknown; // Deprecated
+    cashout: number;
+    rounding: number;
+    paymentMethodId: string;
+    registerId: string;
+    status: LocalDatabaseSalePaymentStatus;
+    processTime: string;
+    receipt: string | null;
+    subtype: null | string;
+    cancelledAt?: string | null;
+}
+
+export interface LocalDatabaseSale {
+    cashout: number;
+    clientId?: string;
+    createdAt: string;
+    customerId: null | string;
+    discount: {
+        amount: string; // TODO: Make a number
+        reason: string;
+    };
+    id: string;
+    invoiceId: string;
+    items: Array<LocalDatabaseSaleItem>;
+    linkedTo: null | string;
+    loyaltyValue: number;
+    notes: {
+        internal: string;
+        sale: string;
+    };
+    orderReference: string;
+    payments: Array<LocalDatabaseSalePayment>;
+    refundReason: null | string;
+    registerId: string;
+    status: SaleStatus;
+    totalBase: number;
+    totalChange: number;
+    totalCost: number;
+    totalPrice: number;
+    totalQuantity: number;
+    totalRounding: number;
+    totalTax: number;
+    updatedAt: string;
+    uploaded: boolean;
+    userId: string;
+    actions: Array<SaleAction>;
+    metaData: Record<string, unknown>;
+    isCancellable?: boolean;
+}
+
+export interface BaseSalesRepository extends BaseRepository<LocalDatabaseSale> {
+    parked(): Promise<Array<LocalDatabaseSale>>;
+    getByClientId(id: string): Promise<Array<LocalDatabaseSale>>;
+    search(invoiceId: string): Promise<Array<LocalDatabaseSale>>;
+    filter(callback: (sale: LocalDatabaseSale) => boolean): Promise<Array<LocalDatabaseSale>>;
+}
+
+
+export interface LocalDatabaseStocktakeAccumulated {
+    accumulated: number;
+    stocktake_id: string;
+    uuid: string;
+}
+
+export interface BaseStocktakeAccumulatedRepository extends BaseRepository<
+    LocalDatabaseStocktakeAccumulated
+> {
+    getByStocktake(stocktake: string): Promise<Array<LocalDatabaseStocktakeAccumulated>>;
+    update(uuid: string, changes: Partial<LocalDatabaseStocktakeAccumulated>): Promise<void>;
+}
+
+
+export interface LocalDatabaseStocktake {
+    display_expected: boolean;
+    name: string;
+    outlet_id: string;
+    uuid: string;
+}
+
+export type BaseStocktakeRepository = BaseRepository<LocalDatabaseStocktake>;
+
+
+export interface LocalDatabaseStocktakeScanned {
+    id?: number;
+    accumulated: number;
+    linked_to: null | number;
+    product_id: string;
+    quantity: number;
+    removed: boolean;
+    stocktake_id: string;
+    timestamp: string;
+    user_id: null | string;
+    barcode: string | undefined;
+    client_id: string;
+}
+
+export interface BaseStocktakeScannedRepository extends BaseRepository<
+    LocalDatabaseStocktakeScanned,
+    number
+> {
+    getByStocktake(stocktake: string): Promise<Array<LocalDatabaseStocktakeScanned>>;
+    update(id: number, changes: Partial<LocalDatabaseStocktakeScanned>): Promise<void>;
+}
+
+
+export type BaseSupplierRepository =
+    BaseRepository<LocalDatabaseSupplier> &
+    BaseSearchableRepository<LocalDatabaseSupplier>;
+
+
+export interface LocalDatabaseSystem<TValue> {
+    key: string;
+    value: TValue;
+}
+
+export abstract class BaseSystemRepository extends BaseRepository<LocalDatabaseSystem<unknown>> {
+    public abstract get<TValue>(key: string): Promise<TValue>;
+}
+
+
+export interface LocalDatabaseTakings {
+    amount: number;
+    type: PaymentMethodTypeUnion;
+    uuid: string;
+}
+
+export interface BaseTakingsRepository extends BaseRepository<LocalDatabaseTakings> {
+    getByType(type: PaymentMethodTypeUnion): Promise<Array<LocalDatabaseTakings>>;
+}
+
+
+export type BaseTaxRateRepository = BaseRepository<LocalDatabaseTaxRate> &
+    BaseSearchableRepository<LocalDatabaseTaxRate>;
+
+
+export type LocalEmailFormatUnion = LocalDatabaseTransferee["email_format"];
+
+export type BaseTransfereeRepository =
+    BaseRepository<LocalDatabaseTransferee> &
+    BaseSearchableRepository<LocalDatabaseTransferee>;
+
+
+export interface QueuedItem<Type extends UPLOAD_TYPES> {
+    id?: number;
+    attempts?: number;
+    status?: "queued" | "failed";
+    requestId?: string;
+    type?: UPLOAD_TYPES;
+    dismissed?: boolean;
+    data: QueuedItemData[Type];
+    createdAt?: string;
+}
+
+export interface QueuedItemData {
+    [UPLOAD_TYPES.SALE]: string;
+    [UPLOAD_TYPES.UPDATE_SALE]: UpdateSaleQueuedDate;
+    [UPLOAD_TYPES.BARCODE]: BarcodeQueuedData;
+    [UPLOAD_TYPES.OPEN_REGISTER]: RegisterOpenQueuedData;
+    [UPLOAD_TYPES.CUSTOMER]: string;
+    [UPLOAD_TYPES.UPDATE_CUSTOMER]: UpdateCustomerQueuedData;
+    [UPLOAD_TYPES.EMAIL_RECEIPT]: EmailReceiptQueuedData;
+    [UPLOAD_TYPES.ACTION]: ActionQueuedData;
+    [UPLOAD_TYPES.TAKINGS]: TakingQueuedData;
+    [UPLOAD_TYPES.VOID_SALE]: string;
+    [UPLOAD_TYPES.UNPARK_SALE]: string | UnparkSaleQueuedData;
+    [UPLOAD_TYPES.CUSTOMER_PAYMENT]: CustomerPaymentQueuedData;
+    [UPLOAD_TYPES.EMAIL_COMPONENT]: EmailComponentQueuedData;
+    [UPLOAD_TYPES.CLOSE_REGISTER]: RegisterClosureQueuedData;
+    [UPLOAD_TYPES.STOCKTAKE_COUNT]: StocktakeCountQueuedData;
+    [UPLOAD_TYPES.ERROR]: ErrorQueuedData;
+    [UPLOAD_TYPES.SECURITY_EVENT]: SecurityEventQueuedData;
+    [UPLOAD_TYPES.KITCHEN_ORDER]: KitchenOrderQueuedData;
+}
+
+export interface UpdateSaleQueuedDate {
+    clientId: string;
+    invoiceId: string | undefined;
+    customer?: string;
+    saleTime?: string;
+    user?: string;
+    note?: string;
+    internalNote?: string;
+}
+
+export interface BarcodeQueuedData {
+    productId: string;
+    barcode: string;
+    quantity: number;
+}
+
+export interface RegisterOpenQueuedData {
+    time: string;
+    id: string;
+}
+
+export interface UpdateCustomerQueuedData {
+    customerId: string;
+    email: string;
+}
+
+export interface EmailReceiptQueuedData {
+    to: string;
+    register: string | false;
+    receipt: string;
+    status: ServerSaleStatus | undefined;
+    invoiceNo: string | undefined;
+    attachments: Array<{
+        name: string;
+        data: string;
+    }>;
+}
+
+export interface ActionQueuedData {
+    user: string;
+    affectingType: string;
+    affectingId: string;
+    action: string;
+    additional: string | null;
+    createdAt?: string;
+}
+
+export interface TakingQueuedData extends Omit<LocalDatabaseMovement, "denominations"> {
+    denominations: {
+        in?: Array<{
+            denomination: number;
+            amount: number;
+        }>;
+        out?: Array<{
+            denomination: number;
+            amount: number;
+        }>;
+    };
+}
+
+export interface UnparkSaleQueuedData {
+    id: string;
+    time: string | null;
+    register: string | null;
+}
+
+export interface CustomerPaymentQueuedData {
+    customer: string;
+    paymentMethod: string;
+    paymentMethodSubtype: string | undefined;
+    user: string | false;
+    register: string | null;
+    reference: string;
+    amount: number;
+    timestamp: string;
+    invoices: Array<{
+        id: string;
+        amount: number;
+    }>;
+}
+
+export interface EmailComponentQueuedData {
+    to: string | Array<string>;
+    subject: string;
+    attachments?: Array<{
+        data: string;
+        name: string;
+        mime: string;
+    }>;
+    cc?: Array<string>;
+    body: string;
+    replyTo?: [string, string] | string | null;
+    width?: number;
+}
+
+export interface RegisterClosureQueuedData {
+    user: string;
+    register: string;
+    paymentMethods: Array<{
+        id: string;
+        expected: number;
+        received: number;
+        additional: unknown;
+    }>;
+    openTime: string;
+    closeTime: string;
+    note: string;
+}
+
+export interface StocktakeCountQueuedData {
+    stocktake: string;
+    items: Array<number>;
+}
+
+export interface ErrorQueuedData {
+    subject: string;
+    body: string;
+}
+
+export interface SecurityEventQueuedData {
+    user: string | null;
+    register: string | null;
+    outlet: string | null;
+    event: string;
+    metaData: string;
+    timestamp: string;
+}
+
+export interface KitchenOrderQueuedData {
+    version: number;
+    sale: string;
+    ready: boolean;
+    items: Array<string>;
+}
+
+export interface QueuedReturn {
+    [UPLOAD_TYPES.SALE]: boolean;
+    [UPLOAD_TYPES.UPDATE_SALE]: void;
+    [UPLOAD_TYPES.BARCODE]: void;
+    [UPLOAD_TYPES.OPEN_REGISTER]: {
+        openTime: string;
+    };
+    [UPLOAD_TYPES.CUSTOMER]: string;
+    [UPLOAD_TYPES.UPDATE_CUSTOMER]: void;
+    [UPLOAD_TYPES.EMAIL_RECEIPT]: void;
+    [UPLOAD_TYPES.ACTION]: void;
+    [UPLOAD_TYPES.TAKINGS]: void;
+    [UPLOAD_TYPES.VOID_SALE]: void;
+    [UPLOAD_TYPES.UNPARK_SALE]: boolean;
+    [UPLOAD_TYPES.CUSTOMER_PAYMENT]: void;
+    [UPLOAD_TYPES.EMAIL_COMPONENT]: void;
+    [UPLOAD_TYPES.CLOSE_REGISTER]: undefined | {
+        data: {
+            closeRegister: {
+                id: string;
+            };
+        };
+    };
+    [UPLOAD_TYPES.STOCKTAKE_COUNT]: void;
+    [UPLOAD_TYPES.ERROR]: void;
+    [UPLOAD_TYPES.SECURITY_EVENT]: void;
+    [UPLOAD_TYPES.KITCHEN_ORDER]: undefined | {
+        data: {
+            changeSaleItemReadyStatus: KitchenShopfrontSale;
+        };
+    };
+}
+
+export interface BaseUploadRepository extends BaseRepository<QueuedItem<UPLOAD_TYPES>, number> {
+    getFailedUploads(retryLimit: number): Promise<Array<QueuedItem<UPLOAD_TYPES>>>;
+    dismissErrors(ids: Array<number>): Promise<void>;
+    getQueue(retryLimit: null | number): Promise<Array<QueuedItem<UPLOAD_TYPES>>>;
+    resetIdempotence(): Promise<void>;
+    resetAttempts(): Promise<void>;
+}
+
+
+export type SaleKeysPosition = LocalDatabaseUser["sale_keys_position"];
+export type DarkModeOverride = LocalDatabaseUser["dark_mode"];
+
+// If more pages are added they need to be added in UpdateUserFormFavourites.php, UserTypes.tsx and
+// TrashedItemsRestore.ts
+export type FavouriteFormPages = "product";
+
+export interface BaseUserRepository extends BaseRepository<
+    LocalDatabaseUser
+>, BaseSearchableRepository<LocalDatabaseUser> {
+    getUserByUsername(username: string): Promise<LocalDatabaseUser>;
+    update(id: string, updates: Partial<LocalDatabaseUser>): Promise<void>;
+}
+
+
+export interface LocalDatabaseVendorConnection {
+    uuid: string;
+    name: string;
+}
+
+export type BaseVendorConnectionRepository =
+    BaseRepository<LocalDatabaseVendorConnection> &
+    BaseSearchableRepository<LocalDatabaseVendorConnection>;
+
+
+export interface DataSourceTables {
+    products: BaseProductRepository;
+    customers: BaseCustomerRepository;
+    customerGroups: BaseCustomerGroupRepository;
+    promotions: BasePromotionRepository;
+    promotionCategories: BasePromotionCategoryRepository;
+    users: BaseUserRepository;
+    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;
+    uploads: BaseUploadRepository;
+    taxRates: BaseTaxRateRepository;
+    takings: BaseTakingsRepository;
+    pageRules: BasePageRuleRepository;
+    suppliers: BaseSupplierRepository;
+    priceSets: BasePriceSetRepository;
+    transferees: BaseTransfereeRepository;
+    movements: BaseMovementRepository;
+    stocktakes: BaseStocktakeRepository;
+    stocktakeScanned: BaseStocktakeScannedRepository;
+    stocktakeAccumulated: BaseStocktakeAccumulatedRepository;
+    applications: BaseApplicationRepository;
+    barcodeTemplates: BaseBarcodeTemplateRepository;
+    vendorConnections: BaseVendorConnectionRepository;
+    system: BaseSystemRepository;
+    enterprises: BaseEnterpriseRepository;
+}
+
+