@final-commerce/common 1.1.4-beta.4 → 1.2.4-beta.2

package/dist/pos-types/index.d.mts

@@ -1,5 +1,3 @@
-import { R as InventorySpecificActionType, H as CustomTableAvailability, v as AttributeType, a0 as OwnerType, X as NonRevenueItemType, C as CurrencyCode, a6 as Platform, aa as ProductStatus, a5 as PaymentTransitionPath, M as FulfillmentTransitionPath, a3 as PathMode, c as CrossAxisRule, T as TransitionConditionSet, S as StatePair, D as DisplayStateRule, u as TransitionBlockedBy, al as StationStatus, aq as UserTypes, o as PaymentState, p as FulfillmentState, ab as ProductType } from '../interfaces-6GnQyqYd.mjs';
-
 type Enrich<TBase, TEnrichment> = Omit<TBase, keyof TEnrichment> & TEnrichment;
 
 interface BaseDocument {
@@ -215,6 +213,237 @@ interface RefundDiscount {
     itemDiscounts?: RefundItemDiscount[];
 }
 
+declare enum CurrencyCode {
+    USD = "USD",
+    EUR = "EUR",
+    GBP = "GBP",
+    CAD = "CAD",
+    AUD = "AUD",
+    NZD = "NZD",
+    CHF = "CHF",
+    CNY = "CNY",
+    INR = "INR",
+    MXN = "MXN",
+    BRL = "BRL",
+    ZAR = "ZAR",
+    SGD = "SGD",
+    HKD = "HKD",
+    SEK = "SEK",
+    NOK = "NOK",
+    DKK = "DKK",
+    PLN = "PLN",
+    THB = "THB",
+    MYR = "MYR",
+    PHP = "PHP",
+    IDR = "IDR",
+    AED = "AED",
+    SAR = "SAR",
+    ILS = "ILS",
+    TRY = "TRY",
+    RUB = "RUB",
+    HTG = "HTG",
+    BND = "BND",
+    CRC = "CRC",
+    BDT = "BDT",
+    UAH = "UAH",
+    NGN = "NGN",
+    AFN = "AFN",
+    ALL = "ALL",
+    AMD = "AMD",
+    ANG = "ANG",
+    AOA = "AOA",
+    ARS = "ARS",
+    AWG = "AWG",
+    AZN = "AZN",
+    BAM = "BAM",
+    BBD = "BBD",
+    BGN = "BGN",
+    BMD = "BMD",
+    BOB = "BOB",
+    BSD = "BSD",
+    BTN = "BTN",
+    BWP = "BWP",
+    BYN = "BYN",
+    BZD = "BZD",
+    COP = "COP",
+    CZK = "CZK",
+    DOP = "DOP",
+    DZD = "DZD",
+    EGP = "EGP",
+    ETB = "ETB",
+    FJD = "FJD",
+    GEL = "GEL",
+    GHS = "GHS",
+    GTQ = "GTQ",
+    GYD = "GYD",
+    HNL = "HNL",
+    IRR = "IRR",
+    JMD = "JMD",
+    KES = "KES",
+    KGS = "KGS",
+    KHR = "KHR",
+    KYD = "KYD",
+    KZT = "KZT",
+    LAK = "LAK",
+    LBP = "LBP",
+    LKR = "LKR",
+    MAD = "MAD",
+    MDL = "MDL",
+    MKD = "MKD",
+    MMK = "MMK",
+    MNT = "MNT",
+    MOP = "MOP",
+    MUR = "MUR",
+    MVR = "MVR",
+    MZN = "MZN",
+    NAD = "NAD",
+    NIO = "NIO",
+    NPR = "NPR",
+    PAB = "PAB",
+    PEN = "PEN",
+    PGK = "PGK",
+    PKR = "PKR",
+    QAR = "QAR",
+    RON = "RON",
+    RSD = "RSD",
+    SBD = "SBD",
+    SRD = "SRD",
+    SYP = "SYP",
+    TJS = "TJS",
+    TMT = "TMT",
+    TOP = "TOP",
+    TTD = "TTD",
+    TZS = "TZS",
+    UYU = "UYU",
+    UZS = "UZS",
+    VES = "VES",
+    WST = "WST",
+    XCD = "XCD",
+    YER = "YER",
+    ZMW = "ZMW",
+    CDF = "CDF",
+    CUP = "CUP",
+    ERN = "ERN",
+    FKP = "FKP",
+    GIP = "GIP",
+    GMD = "GMD",
+    KPW = "KPW",
+    LRD = "LRD",
+    LSL = "LSL",
+    MGA = "MGA",
+    MWK = "MWK",
+    SCR = "SCR",
+    SDG = "SDG",
+    SHP = "SHP",
+    SLE = "SLE",
+    SOS = "SOS",
+    SSP = "SSP",
+    STN = "STN",
+    SZL = "SZL",
+    VED = "VED",
+    XCG = "XCG",
+    JPY = "JPY",
+    KRW = "KRW",
+    VND = "VND",
+    CLP = "CLP",
+    ISK = "ISK",
+    HUF = "HUF",
+    TWD = "TWD",
+    GNF = "GNF",
+    BIF = "BIF",
+    DJF = "DJF",
+    KMF = "KMF",
+    PYG = "PYG",
+    RWF = "RWF",
+    UGX = "UGX",
+    VUV = "VUV",
+    XAF = "XAF",
+    XOF = "XOF",
+    XPF = "XPF",
+    KWD = "KWD",
+    BHD = "BHD",
+    OMR = "OMR",
+    JOD = "JOD",
+    TND = "TND",
+    LYD = "LYD",
+    IQD = "IQD"
+}
+
+declare enum CustomTableAvailability {
+    PUBLIC = "public",
+    ORGANIZATION = "organization"
+}
+declare enum AttributeType {
+    STRING = "string",
+    NUMBER = "number",
+    BOOLEAN = "boolean",
+    DATE = "date",
+    JSON_STRING = "json-string"
+}
+declare enum Platform {
+    WOO_COMMERCE = "woo-commerce",
+    SHOPIFY = "shopify",
+    OLIVER = "oliver",
+    STANDALONE = "standalone"
+}
+declare enum StationStatus {
+    IN_USE = "IN_USE",
+    AVAILABLE = "AVAILABLE"
+}
+declare enum InventorySpecificActionType {
+    STOCK_RECEIVED = "STOCK_RECEIVED",
+    INVENTORY_RECOUNT = "INVENTORY_RECOUNT",
+    DAMAGE = "DAMAGE",
+    THEFT = "THEFT",
+    LOSS = "LOSS",
+    RESTOCK_RETURN = "RESTOCK_RETURN",
+    REFUND_RESTOCK_RETURN = "REFUND_RESTOCK_RETURN",
+    REFUND_DAMAGE = "REFUND_DAMAGE",
+    SALE = "SALE",
+    TRANSFER = "TRANSFER",
+    BULK_RECOUNT = "BULK_RECOUNT",
+    APPLIED_FROM_WOO = "APPLIED_FROM_WOO",
+    PO_RECEIVED = "PO_RECEIVED"
+}
+declare enum UserTypes {
+    COMPANY_OWNER = "owner",
+    ORG_USER = "organization_user",
+    ORG_OWNER = "organization_owner",
+    FINAL_USER = "final_user",
+    FINAL_OWNER = "final_owner",
+    EMPLOYEE = "employee",
+    SUPER_ADMIN = "super_admin",
+    MANAGER = "manager",
+    ADMIN = "admin",
+    ASSISTANT_MANAGER = "assistant",
+    CASHIER = "cashier",
+    RESELLER = "reseller"
+}
+declare enum OwnerType {
+    API_KEY = "api-key",
+    ORGANIZATION = "organization",
+    COMPANY = "company"
+}
+declare enum NonRevenueItemType {
+    GIFT_CARD = "gift-card"
+}
+
+declare enum ProductType {
+    SIMPLE = "simple",
+    VARIABLE = "variable"
+}
+declare enum ProductStatus {
+    ACTIVE = "active",
+    INACTIVE = "inactive",
+    DRAFT = "draft"
+}
+
+declare enum PaymentProcessor {
+    STRIPE = "stripe",
+    ADYEN = "adyen",
+    EXTERNAL = "external"
+}
+
 interface RefundLineItem {
     taxes?: OrderTax[];
     discount?: RefundDiscount;
@@ -629,6 +858,74 @@ interface Transaction extends BaseEntity {
     minorUnits?: number;
 }
 
+type PaymentState = 'unpaid' | 'payment_pending' | 'partially_paid' | 'paid' | 'partially_refunded' | 'refunded' | 'voided';
+type FulfillmentState = 'draft' | 'pending' | 'on_hold' | 'in_progress' | 'fulfilled' | 'partially_fulfilled' | 'returned' | 'partially_returned' | 'cancelled';
+interface StatePair {
+    payment: PaymentState;
+    fulfillment: FulfillmentState;
+}
+type ConditionOperator = 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'notIn' | 'isEmpty' | 'isNotEmpty';
+type PathMode = 'strict' | 'permissive';
+
+interface PaymentTransitionPath {
+    from: PaymentState;
+    to: PaymentState;
+    conditionSetId?: string;
+    _sourceExtensionId?: string;
+}
+interface FulfillmentTransitionPath {
+    from: FulfillmentState;
+    to: FulfillmentState;
+    conditionSetId?: string;
+    _sourceExtensionId?: string;
+}
+interface Condition {
+    field: string;
+    operator: ConditionOperator;
+    value: unknown;
+}
+interface ConditionGroup {
+    conditions: Condition[];
+}
+interface TransitionConditionSet {
+    id: string;
+    label: string;
+    groups: ConditionGroup[];
+    _sourceExtensionId?: string;
+}
+type CrossAxisTrigger = {
+    axis: 'payment';
+    to: PaymentState | PaymentState[];
+} | {
+    axis: 'fulfillment';
+    to: FulfillmentState | FulfillmentState[];
+};
+type CrossAxisRequires = {
+    axis: 'payment';
+    states: PaymentState[];
+} | {
+    axis: 'fulfillment';
+    states: FulfillmentState[];
+};
+interface CrossAxisRule {
+    id: string;
+    label: string;
+    description?: string;
+    enabled: boolean;
+    trigger: CrossAxisTrigger;
+    requires: CrossAxisRequires;
+    _sourceExtensionId?: string;
+}
+interface DisplayStateRule {
+    paymentState?: PaymentState | PaymentState[];
+    fulfillmentState?: FulfillmentState | FulfillmentState[];
+    label: string;
+    color?: string;
+    icon?: string;
+    _sourceExtensionId?: string;
+}
+type TransitionBlockedBy = 'financial_invariant' | 'cross_axis_rule' | 'path' | 'condition';
+
 interface OrderStateConfig extends BaseEntity {
     version: number;
     name: string;
@@ -1041,12 +1338,14 @@ interface RefundedTipPayment {
     tipTo: string;
     tendered?: number;
 }
+
 interface PaymentMethod {
     transactionId: string;
     paymentType: string;
     amount: number;
     timestamp: string;
     processor: string;
+    provider?: PaymentProcessor;
     saleId?: string;
     change?: number | null;
     tip?: TipPayment | null;
@@ -1366,6 +1665,8 @@ interface PrinterDetails {
     ipAddress: string | null;
     macAddress: string | null;
     isAirPrint: boolean;
+    printerId?: string;
+    brand?: string | null;
 }
 interface PaymentResponse {
     status: PaymentStatus;
@@ -1680,6 +1981,7 @@ interface ActiveEntityChanges {
 }
 interface Flow {
     _id: string;
+    hubId?: string;
     companyId: string;
     title: string;
     description: string;
@@ -1718,7 +2020,7 @@ interface ReaderCapabilities {
     tapToPay: boolean;
     terminal: boolean;
 }
-type ServiceChannelMessageType = 'POSBRAIN_READY' | 'HOST_HELLO' | 'SERVICE_INIT' | 'BOOTSTRAP' | 'TOKEN_REFRESH' | 'SELECTION' | 'HOST_SHUTDOWN' | 'READER_CAPABILITIES' | 'RUNTIME_READY' | 'SYNC_PROGRESS' | 'DEVICE_OP_REQUEST' | 'DEVICE_OP_RESPONSE';
+type ServiceChannelMessageType = 'POSBRAIN_READY' | 'HOST_HELLO' | 'SERVICE_INIT' | 'BOOTSTRAP' | 'TOKEN_REFRESH' | 'SELECTION' | 'HOST_SHUTDOWN' | 'READER_CAPABILITIES' | 'RUNTIME_READY' | 'HOST_NAVIGATE' | 'SYNC_PROGRESS' | 'DEVICE_OP_REQUEST' | 'DEVICE_OP_RESPONSE' | 'PUBSUB_TOPICS_REQUEST' | 'PUBSUB_TOPICS_LIST' | 'PUBSUB_SUBSCRIBE' | 'PUBSUB_UNSUBSCRIBE' | 'PUBSUB_EVENT';
 interface PosBrainReadyMessage {
     type: 'POSBRAIN_READY';
 }
@@ -1757,6 +2059,11 @@ interface ReaderCapabilitiesMessage {
 interface RuntimeReadyMessage {
     type: 'RUNTIME_READY';
 }
+type HostNavigateTarget = 'station-home';
+interface HostNavigateMessage {
+    type: 'HOST_NAVIGATE';
+    target: HostNavigateTarget;
+}
 interface SyncProgressMessage {
     type: 'SYNC_PROGRESS';
     total: number;
@@ -1764,7 +2071,7 @@ interface SyncProgressMessage {
     pending: string[];
     done: boolean;
 }
-type DeviceOpName = 'printImage' | 'printHTML' | 'printReceipt' | 'openCashDrawer' | 'captureCardPresent';
+type DeviceOpName = 'printImage' | 'printHTML' | 'printReceipt' | 'openCashDrawer' | 'captureCardPresent' | 'cancelCardPresent' | 'refundCardPresent';
 interface DeviceOpRequestMessage {
     type: 'DEVICE_OP_REQUEST';
     id: string;
@@ -1776,7 +2083,40 @@ interface DeviceOpResponseMessage {
     id: string;
     ok: boolean;
     error?: string;
+    data?: PaymentResponse;
+}
+interface TopicDefinitionWire {
+    id: string;
+    name: string;
+    description?: string;
+    eventTypes: {
+        id: string;
+        description?: string;
+    }[];
+}
+interface TopicEventWire {
+    topic: string;
+    type: string;
+    data: unknown;
+    timestamp: string;
+}
+interface PubsubTopicsRequestMessage {
+    type: 'PUBSUB_TOPICS_REQUEST';
+    id: string;
+}
+interface PubsubTopicsListMessage {
+    type: 'PUBSUB_TOPICS_LIST';
+    id: string;
+    topics: TopicDefinitionWire[];
+}
+interface PubsubSubscribeMessage {
+    type: 'PUBSUB_SUBSCRIBE' | 'PUBSUB_UNSUBSCRIBE';
+    topic: string;
+}
+interface PubsubEventMessage {
+    type: 'PUBSUB_EVENT';
+    event: TopicEventWire;
 }
-type ServiceChannelMessage = PosBrainReadyMessage | HostHelloMessage | ServiceInitMessage | BootstrapMessage | TokenRefreshMessage | SelectionMessage | HostShutdownMessage | ReaderCapabilitiesMessage | RuntimeReadyMessage | SyncProgressMessage | DeviceOpRequestMessage | DeviceOpResponseMessage;
+type ServiceChannelMessage = PosBrainReadyMessage | HostHelloMessage | ServiceInitMessage | BootstrapMessage | TokenRefreshMessage | SelectionMessage | HostShutdownMessage | ReaderCapabilitiesMessage | RuntimeReadyMessage | HostNavigateMessage | SyncProgressMessage | DeviceOpRequestMessage | DeviceOpResponseMessage | PubsubTopicsRequestMessage | PubsubTopicsListMessage | PubsubSubscribeMessage | PubsubEventMessage;
 
-export { type ActiveCart, type ActiveCartProduct, type ActiveCompany, type ActiveCustomSales, type ActiveCustomer, type ActiveEntityChanges, ActiveEntityType, type ActiveFullProduct, type ActiveOrder, type ActiveOutlet, type ActivePark, type ActiveProduct, type ActiveRefundOrder, type ActiveSession, type ActiveSplitPayment, type ActiveStation, type ActiveTaxDetails, type ActiveTimer, type ActiveUpdatedOrder, type ActiveUser, type ActiveUserRole, type Address, type Attribute, type AttributeEmbedded, type AttributeOption, type BaseDocument, type BaseEntity, type BaseTile, type BootstrapMessage, type CalculatedTaxDetails, type CartDiscountItem, type CartFeeItem, type CartFeeTaxEntry, type CartFeesDetails, type CashPaymentSettings, type CashRoundingIncrement, type Category, type CompanyExtension, type CompanySettingsEavValue, type CompanySettingsEavValueType, type CustomExtension, type CustomFee, type CustomSale, type CustomSaleDetails, type CustomTable, type CustomTableField, type CustomTableMetadata, type CustomTableRow, type CustomTableValue, type Customer, type CustomerNote, type DeviceEnvAttribute, type DeviceEnvCategory, type DeviceEnvValue, type DeviceOpName, type DeviceOpRequestMessage, type DeviceOpResponseMessage, type Discount, type DiscountDetail, type DiscountLineItem, type Enrich, EnvironmentDataKeys, EnvironmentDataSubKeys, type FeeDetail, type FeeLineItem, type Flow, type FlowSettings, type FlowSettingsKey, type FlowWebApp, type FlowWebAppVersion, type FullProduct, type HostHelloMessage, type HostShutdownMessage, type Inventory, type LineItem, type Metadata, type MetadataItem, type NonRevenueItem, type Note, type Order, type OrderCartDiscount, type OrderCartFee, type OrderCustomSale, type OrderCustomSaleDiscount, type OrderCustomSaleFee, type OrderLineItem, type OrderLineItemDiscount, type OrderLineItemFee, type OrderNote, type OrderPaymentMethod, type OrderPosData, type OrderRefund, type OrderRefundSummary, type OrderStateActor, type OrderStateActorType, type OrderStateConfig, type OrderStateEvent, type OrderStateEventTrigger, type OrderStateHistoryEntry, type OrderStateOperation, type OrderStatePair, type OrderSummary, type OrderSummaryPayments, type OrderTax, type OrderTip, type Outlet, type PaymentMethod, type PaymentResponse, type PaymentSetting, PaymentStatus, type PosBrainReadyMessage, type PosDataItem, type PriceModifierDetail, type PrinterDetails, ProcessorType, type ProdDiscountBreakdown, type ProdFeeBreakdown, type Product, type ProductTaxDetails, type ProductVariant, type Reader, type ReaderCapabilities, type ReaderCapabilitiesMessage, type Refund, type RefundCartDiscount, type RefundDiscount, type RefundItem, type RefundItemDiscount, type RefundLineItem, type RefundPayment, type RefundProcessingStatus, type RefundSummary, type RefundTip, type RefundedCustomSale, type RefundedLineItem, type RefundedTipPayment, type Role, type RolePermission, type RuntimeReadyMessage, type SelectionContext, type SelectionFlowContext, type SelectionMessage, type SelectionRoleContext, type ServiceChannelMessage, type ServiceChannelMessageType, type ServiceInitMessage, type Session, type SessionClosingAmounts, type SmartGridSetting, type SmartGridSettings, type SmartGridSettingsData, type Station, type StripeAccount, type Summary, type SummaryPayments, type SyncProgressMessage, type Tax, type TaxRate, type TaxRateValue, type TaxTable, type TaxTableActive, type TaxTableRate, type TileGrid, type Tip, type TipData, type TipPayment, type TipsDetails, type TokenRefreshMessage, type Transaction, type TransactionPaymentData, type User, type UserType, type Variant, type VariantInventory };
+export { type ActiveCart, type ActiveCartProduct, type ActiveCompany, type ActiveCustomSales, type ActiveCustomer, type ActiveEntityChanges, ActiveEntityType, type ActiveFullProduct, type ActiveOrder, type ActiveOutlet, type ActivePark, type ActiveProduct, type ActiveRefundOrder, type ActiveSession, type ActiveSplitPayment, type ActiveStation, type ActiveTaxDetails, type ActiveTimer, type ActiveUpdatedOrder, type ActiveUser, type ActiveUserRole, type Address, type Attribute, type AttributeEmbedded, type AttributeOption, type BaseDocument, type BaseEntity, type BaseTile, type BootstrapMessage, type CalculatedTaxDetails, type CartDiscountItem, type CartFeeItem, type CartFeeTaxEntry, type CartFeesDetails, type CashPaymentSettings, type CashRoundingIncrement, type Category, type CompanyExtension, type CompanySettingsEavValue, type CompanySettingsEavValueType, type CustomExtension, type CustomFee, type CustomSale, type CustomSaleDetails, type CustomTable, type CustomTableField, type CustomTableMetadata, type CustomTableRow, type CustomTableValue, type Customer, type CustomerNote, type DeviceEnvAttribute, type DeviceEnvCategory, type DeviceEnvValue, type DeviceOpName, type DeviceOpRequestMessage, type DeviceOpResponseMessage, type Discount, type DiscountDetail, type DiscountLineItem, type Enrich, EnvironmentDataKeys, EnvironmentDataSubKeys, type FeeDetail, type FeeLineItem, type Flow, type FlowSettings, type FlowSettingsKey, type FlowWebApp, type FlowWebAppVersion, type FullProduct, type HostHelloMessage, type HostNavigateMessage, type HostNavigateTarget, type HostShutdownMessage, type Inventory, type LineItem, type Metadata, type MetadataItem, type NonRevenueItem, type Note, type Order, type OrderCartDiscount, type OrderCartFee, type OrderCustomSale, type OrderCustomSaleDiscount, type OrderCustomSaleFee, type OrderLineItem, type OrderLineItemDiscount, type OrderLineItemFee, type OrderNote, type OrderPaymentMethod, type OrderPosData, type OrderRefund, type OrderRefundSummary, type OrderStateActor, type OrderStateActorType, type OrderStateConfig, type OrderStateEvent, type OrderStateEventTrigger, type OrderStateHistoryEntry, type OrderStateOperation, type OrderStatePair, type OrderSummary, type OrderSummaryPayments, type OrderTax, type OrderTip, type Outlet, type PaymentMethod, type PaymentResponse, type PaymentSetting, PaymentStatus, type PosBrainReadyMessage, type PosDataItem, type PriceModifierDetail, type PrinterDetails, ProcessorType, type ProdDiscountBreakdown, type ProdFeeBreakdown, type Product, type ProductTaxDetails, type ProductVariant, type PubsubEventMessage, type PubsubSubscribeMessage, type PubsubTopicsListMessage, type PubsubTopicsRequestMessage, type Reader, type ReaderCapabilities, type ReaderCapabilitiesMessage, type Refund, type RefundCartDiscount, type RefundDiscount, type RefundItem, type RefundItemDiscount, type RefundLineItem, type RefundPayment, type RefundProcessingStatus, type RefundSummary, type RefundTip, type RefundedCustomSale, type RefundedLineItem, type RefundedTipPayment, type Role, type RolePermission, type RuntimeReadyMessage, type SelectionContext, type SelectionFlowContext, type SelectionMessage, type SelectionRoleContext, type ServiceChannelMessage, type ServiceChannelMessageType, type ServiceInitMessage, type Session, type SessionClosingAmounts, type SmartGridSetting, type SmartGridSettings, type SmartGridSettingsData, type Station, type StripeAccount, type Summary, type SummaryPayments, type SyncProgressMessage, type Tax, type TaxRate, type TaxRateValue, type TaxTable, type TaxTableActive, type TaxTableRate, type TileGrid, type Tip, type TipData, type TipPayment, type TipsDetails, type TokenRefreshMessage, type TopicDefinitionWire, type TopicEventWire, type Transaction, type TransactionPaymentData, type User, type UserType, type Variant, type VariantInventory };