@final-commerce/common 2.7.0 → 2.7.1-online.1

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

@@ -50,230 +50,6 @@ interface OrderTax {
     priority?: number;
 }
 
-interface OrderTip {
-    percentage?: number;
-    amount?: number;
-    tipTo?: string;
-}
-
-interface OrderSummaryPayments {
-    cardTotal: number;
-    cashTotal: number;
-    customTotal: number;
-    cardProcessingFeesTotal: number;
-}
-interface OrderSummary {
-    discountTotal: number;
-    shippingTotal?: number;
-    total: number;
-    totalTaxes: number;
-    isTaxInclusive: boolean;
-    subtotalAfterFees: number;
-    nonRevenueTotal?: number;
-    grossSales?: number;
-    lineDiscountTotal?: number;
-    cartDiscountTotal?: number;
-    feesTotal?: number;
-    lineFeesTotal?: number;
-    cartFeesTotal?: number;
-    taxableFeesTotal?: number;
-    nonTaxableFeesTotal?: number;
-    modifiersTotal?: number;
-    taxableModifiersTotal?: number;
-    nonTaxableModifiersTotal?: number;
-    totalTaxableSales?: number;
-    totalNonTaxableSales?: number;
-    tipTotal?: number;
-    cashRounding: number;
-    payments?: OrderSummaryPayments;
-    totalBeforeTip?: number;
-    amountPaid?: number;
-    taxes: OrderTax[];
-    tip?: OrderTip;
-}
-
-interface PriceModifierDetail {
-    percentage: number;
-    amount: number;
-    label?: string;
-    tax?: number;
-    taxTableId?: string;
-    taxRateId?: string;
-}
-
-interface OrderCartDiscount {
-    amount: number;
-    percentage: number;
-    label?: string;
-}
-
-interface OrderCartFee {
-    label: string;
-    id: string;
-    percentage: number;
-    amount: number;
-    taxName?: string;
-    taxTableId?: string;
-    tax?: number;
-    taxes?: OrderTax[];
-}
-
-interface OrderPaymentMethod {
-    paymentType: string;
-    amount: number;
-    transactionId: string;
-    timestamp?: string;
-    emv?: string | null;
-    cashRounding?: number;
-    change?: number;
-    processor?: string;
-    processorFee?: number;
-    tendered?: number;
-    tip?: OrderTip | null;
-}
-
-interface OrderPosData {
-    outlet?: string;
-    station?: string;
-    employee?: string;
-}
-
-interface OrderAssignedUser {
-    userId: string;
-    assignedAt: string;
-}
-
-interface OrderInCart {
-    active: boolean;
-    stationId: string | null;
-    since: string;
-}
-
-interface OrderCustomStatus {
-    id: string;
-    key?: string;
-    label: string;
-    setAt: string;
-    setBy: string | null;
-}
-
-interface OrderLineItemDiscount {
-    itemDiscounts?: PriceModifierDetail[];
-    cartDiscount?: PriceModifierDetail;
-}
-interface OrderLineItemFee {
-    cartFee?: PriceModifierDetail;
-    itemFees?: PriceModifierDetail[];
-}
-interface OrderLineItemModifier {
-    modifierId: string;
-    modifierName: string;
-    choiceId: string;
-    choiceName: string;
-    unitPrice: number;
-    quantity: number;
-    total: number;
-    totalTax?: number;
-    taxes?: OrderTax[];
-    componentIndex?: number;
-}
-interface OrderLineItemComponent {
-    productId: string;
-    variantId: string;
-    name: string;
-    attributes?: string;
-    sku?: string;
-    productExternalId?: string;
-    variantExternalId?: string;
-    partName?: string;
-    quantity: number;
-    price: number;
-    unitId?: string;
-    unitAbbreviation?: string;
-    unitRatioToBase?: number;
-    stockQuantity?: number;
-    stockVariantId?: string;
-    taxTableId?: string;
-    totalTax?: number;
-    taxes?: OrderTax[];
-}
-interface OrderLineItem {
-    id?: string;
-    productId?: string;
-    variantId?: string;
-    name?: string;
-    quantity?: number;
-    manageStock?: boolean;
-    price?: number;
-    description?: string;
-    sku?: string;
-    totalTax?: number;
-    total?: number;
-    productExternalId?: string;
-    variantExternalId?: string;
-    lineItemExternalId?: string;
-    internalId?: string;
-    note?: string;
-    image?: string;
-    attributes?: string;
-    taxes?: OrderTax[];
-    discount?: OrderLineItemDiscount;
-    fee?: OrderLineItemFee;
-    modifiers?: OrderLineItemModifier[];
-    components?: OrderLineItemComponent[];
-    lineNetWithFees?: number;
-    metadata?: Metadata[];
-    stock?: number;
-    subTotal?: number;
-    unitId?: string;
-    unitAbbreviation?: string;
-    stockQuantity?: number;
-    unitRatioToBase?: number;
-    stockVariantId?: string;
-}
-
-interface OrderCustomSaleDiscount {
-    cartDiscount: OrderCartDiscount;
-}
-interface OrderCustomSaleFee {
-    cartFee: PriceModifierDetail;
-}
-interface OrderCustomSale {
-    customSaleId: string;
-    applyTaxes: boolean;
-    quantity: number;
-    name: string;
-    price: number;
-    totalTax: number;
-    total: number;
-    taxes?: OrderTax[];
-    discount?: OrderCustomSaleDiscount;
-    fee?: OrderCustomSaleFee;
-}
-
-interface OrderRefundSummary {
-    total?: number;
-}
-interface OrderRefund {
-    externalId?: string;
-    reason?: string;
-    summary?: OrderRefundSummary;
-}
-
-interface RefundCartDiscount {
-    amount?: number;
-    percentage?: number;
-}
-interface RefundItemDiscount {
-    amount?: number;
-    percentage?: number;
-    label?: string;
-}
-interface RefundDiscount {
-    cartDiscount?: RefundCartDiscount;
-    itemDiscounts?: RefundItemDiscount[];
-}
-
 declare enum CurrencyCode {
     USD = "USD",
     EUR = "EUR",
@@ -544,6 +320,254 @@ declare enum ReservationStatus {
     EXPIRED = "expired"
 }
 
+declare enum ShippingOptionType {
+    SHIP = "ship",
+    PICKUP = "pickup"
+}
+declare enum ShippingRateType {
+    FLAT = "flat"
+}
+declare enum ShippingChannel {
+    WEB = "web",
+    POS = "pos"
+}
+
+interface OrderShippingLine {
+    type: ShippingOptionType | `${ShippingOptionType}`;
+    name?: string;
+    amount: number;
+    zoneId?: string;
+    optionId?: string;
+    minDays?: number;
+    maxDays?: number;
+    pickupOutletId?: string;
+    taxes?: OrderTax[];
+}
+
+interface OrderTip {
+    percentage?: number;
+    amount?: number;
+    tipTo?: string;
+}
+
+interface OrderSummaryPayments {
+    cardTotal: number;
+    cashTotal: number;
+    customTotal: number;
+    cardProcessingFeesTotal: number;
+}
+interface OrderSummary {
+    discountTotal: number;
+    shippingTotal?: number;
+    total: number;
+    totalTaxes: number;
+    isTaxInclusive: boolean;
+    subtotalAfterFees: number;
+    nonRevenueTotal?: number;
+    grossSales?: number;
+    lineDiscountTotal?: number;
+    cartDiscountTotal?: number;
+    feesTotal?: number;
+    lineFeesTotal?: number;
+    cartFeesTotal?: number;
+    taxableFeesTotal?: number;
+    nonTaxableFeesTotal?: number;
+    modifiersTotal?: number;
+    taxableModifiersTotal?: number;
+    nonTaxableModifiersTotal?: number;
+    totalTaxableSales?: number;
+    totalNonTaxableSales?: number;
+    tipTotal?: number;
+    cashRounding: number;
+    payments?: OrderSummaryPayments;
+    totalBeforeTip?: number;
+    amountPaid?: number;
+    taxes: OrderTax[];
+    tip?: OrderTip;
+}
+
+interface PriceModifierDetail {
+    percentage: number;
+    amount: number;
+    label?: string;
+    tax?: number;
+    taxTableId?: string;
+    taxRateId?: string;
+}
+
+interface OrderCartDiscount {
+    amount: number;
+    percentage: number;
+    label?: string;
+}
+
+interface OrderCartFee {
+    label: string;
+    id: string;
+    percentage: number;
+    amount: number;
+    taxName?: string;
+    taxTableId?: string;
+    tax?: number;
+    taxes?: OrderTax[];
+}
+
+interface OrderPaymentMethod {
+    paymentType: string;
+    amount: number;
+    transactionId: string;
+    timestamp?: string;
+    emv?: string | null;
+    cashRounding?: number;
+    change?: number;
+    processor?: string;
+    processorFee?: number;
+    tendered?: number;
+    tip?: OrderTip | null;
+}
+
+interface OrderPosData {
+    outlet?: string;
+    station?: string;
+    employee?: string;
+}
+
+interface OrderAssignedUser {
+    userId: string;
+    assignedAt: string;
+}
+
+interface OrderInCart {
+    active: boolean;
+    stationId: string | null;
+    since: string;
+}
+
+interface OrderCustomStatus {
+    id: string;
+    key?: string;
+    label: string;
+    setAt: string;
+    setBy: string | null;
+}
+
+interface OrderLineItemDiscount {
+    itemDiscounts?: PriceModifierDetail[];
+    cartDiscount?: PriceModifierDetail;
+}
+interface OrderLineItemFee {
+    cartFee?: PriceModifierDetail;
+    itemFees?: PriceModifierDetail[];
+}
+interface OrderLineItemModifier {
+    modifierId: string;
+    modifierName: string;
+    choiceId: string;
+    choiceName: string;
+    unitPrice: number;
+    quantity: number;
+    total: number;
+    totalTax?: number;
+    taxes?: OrderTax[];
+    componentIndex?: number;
+}
+interface OrderLineItemComponent {
+    productId: string;
+    variantId: string;
+    name: string;
+    attributes?: string;
+    sku?: string;
+    productExternalId?: string;
+    variantExternalId?: string;
+    partName?: string;
+    quantity: number;
+    price: number;
+    unitId?: string;
+    unitAbbreviation?: string;
+    unitRatioToBase?: number;
+    stockQuantity?: number;
+    stockVariantId?: string;
+    taxTableId?: string;
+    totalTax?: number;
+    taxes?: OrderTax[];
+}
+interface OrderLineItem {
+    id?: string;
+    productId?: string;
+    variantId?: string;
+    name?: string;
+    quantity?: number;
+    manageStock?: boolean;
+    price?: number;
+    description?: string;
+    sku?: string;
+    totalTax?: number;
+    total?: number;
+    productExternalId?: string;
+    variantExternalId?: string;
+    lineItemExternalId?: string;
+    internalId?: string;
+    note?: string;
+    image?: string;
+    attributes?: string;
+    taxes?: OrderTax[];
+    discount?: OrderLineItemDiscount;
+    fee?: OrderLineItemFee;
+    modifiers?: OrderLineItemModifier[];
+    components?: OrderLineItemComponent[];
+    lineNetWithFees?: number;
+    metadata?: Metadata[];
+    stock?: number;
+    subTotal?: number;
+    unitId?: string;
+    unitAbbreviation?: string;
+    stockQuantity?: number;
+    unitRatioToBase?: number;
+    stockVariantId?: string;
+}
+
+interface OrderCustomSaleDiscount {
+    cartDiscount: OrderCartDiscount;
+}
+interface OrderCustomSaleFee {
+    cartFee: PriceModifierDetail;
+}
+interface OrderCustomSale {
+    customSaleId: string;
+    applyTaxes: boolean;
+    quantity: number;
+    name: string;
+    price: number;
+    totalTax: number;
+    total: number;
+    taxes?: OrderTax[];
+    discount?: OrderCustomSaleDiscount;
+    fee?: OrderCustomSaleFee;
+}
+
+interface OrderRefundSummary {
+    total?: number;
+}
+interface OrderRefund {
+    externalId?: string;
+    reason?: string;
+    summary?: OrderRefundSummary;
+}
+
+interface RefundCartDiscount {
+    amount?: number;
+    percentage?: number;
+}
+interface RefundItemDiscount {
+    amount?: number;
+    percentage?: number;
+    label?: string;
+}
+interface RefundDiscount {
+    cartDiscount?: RefundCartDiscount;
+    itemDiscounts?: RefundItemDiscount[];
+}
+
 interface RefundLineItem {
     taxes?: OrderTax[];
     discount?: RefundDiscount;
@@ -975,6 +999,7 @@ interface Order extends BaseEntity {
     notes: OrderNote$1[];
     billing?: Address$1;
     shipping?: Address$1;
+    shippingLine?: OrderShippingLine;
     lineItems: Partial<OrderLineItem>[];
     customSales?: OrderCustomSale[];
     nonRevenueItems?: NonRevenueItem$1[];
@@ -1905,6 +1930,48 @@ interface CartReservation extends OrderReservation {
     fees?: CustomFee[];
 }
 
+interface ShippingPriceTier {
+    from: number;
+    price: number;
+}
+interface ShippingOptionRule {
+    id: string;
+    type: ShippingOptionType | `${ShippingOptionType}`;
+    rate?: ShippingRateType | `${ShippingRateType}`;
+    name?: string | null;
+    price: number;
+    priceByTotal?: ShippingPriceTier[] | null;
+    freeOver?: number | null;
+    minDays?: number | null;
+    maxDays?: number | null;
+    channels: (ShippingChannel | `${ShippingChannel}`)[];
+    outletId?: string | null;
+}
+
+interface CartAddress {
+    firstName?: string;
+    lastName?: string;
+    address1?: string;
+    address2?: string;
+    city?: string;
+    state?: string;
+    postCode?: string;
+    country?: string;
+    fromCustomer?: boolean;
+}
+interface CartShipping {
+    zoneId: string;
+    optionId: string;
+    type: ShippingOptionType | `${ShippingOptionType}`;
+    name: string | null;
+    amount: number;
+    taxes?: Tax[];
+    minDays: number | null;
+    maxDays: number | null;
+    outletId: string | null;
+    rule?: Pick<ShippingOptionRule, 'price' | 'priceByTotal' | 'freeOver'>;
+}
+
 interface ActiveCustomSales {
     id: string;
     name: string;
@@ -1940,6 +2007,10 @@ interface ActiveCart {
     amountToBeCharged: number;
     customer?: Partial<ActiveCustomer | null> | null;
     orderNotes?: string;
+    shippingAddress?: CartAddress | null;
+    billingAddress?: CartAddress | null;
+    shipping?: CartShipping | null;
+    shippingTotal?: number;
     cartTotal?: number;
     orderTotal?: number;
     orderId?: string;
@@ -2053,6 +2124,7 @@ declare enum ProcessorType {
     REDEEM = "Redeem",
     INTEGRATION = "Integration",
     PAYMENT_LINK = "PaymentLink",
+    ONLINE_PAYMENT = "OnlinePayment",
     EXTERNAL = "External"
 }
 
@@ -2263,6 +2335,7 @@ interface CalculatedTaxDetails {
     };
     totalTaxes: TaxesDetails;
     cartFees: CartFeesDetails[];
+    shipping?: CartFeesDetails;
 }
 interface TipData {
     value: number;
@@ -2560,4 +2633,4 @@ interface PubsubEventMessage {
 }
 type ServiceChannelMessage = PosBrainReadyMessage | HostHelloMessage | ServiceInitMessage | BootstrapMessage | TokenRefreshMessage | RequestTokenRefreshMessage | SelectionMessage | HostShutdownMessage | ReaderCapabilitiesMessage | PrinterSettingsMessage | 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 ActiveOrderReservation, 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 AdyenCardEntryConfig, type Attribute, type AttributeEmbedded, type AttributeOption, type BaseDocument, type BaseEntity, type BaseTile, type Booking, type BookingAvailability, type BookingResource, type BookingSlot, type BookingSlotResource, type BootstrapMessage, type CalculatedTaxDetails, type CartDiscountItem, type CartFeeItem, type CartFeeTaxEntry, type CartFeesDetails, type CartLineComponent, type CartLineModifier, type CartReservation, type CashDrawerPolicy, type CashPaymentSettings, type CashRoundingIncrement, type Category, type CompanyExtension, type CompanySettingsEavValue, type CompanySettingsEavValueType, type Composite, type CompositeChoice, type CompositeItem, type CompositeItemUnavailable, type CompositePart, type CompositePick, 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 ModifierChoiceSelection, type ModifierSelection, type ModifierSelectionType, type NonRevenueItem, type Note, type Order, type OrderAssignedUser, type OrderCartDiscount, type OrderCartFee, type OrderCustomSale, type OrderCustomSaleDiscount, type OrderCustomSaleFee, type OrderCustomStatus, type OrderInCart, type OrderLineItem, type OrderLineItemComponent, type OrderLineItemDiscount, type OrderLineItemFee, type OrderLineItemModifier, type OrderNote, type OrderPaymentMethod, type OrderPosData, type OrderRefund, type OrderRefundSummary, type OrderReservation, 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, type PrinterSettings, type PrinterSettingsMessage, ProcessorType, type ProdDiscountBreakdown, type ProdFeeBreakdown, type ProdModifierBreakdown, type Product, type ProductTaxDetails, type ProductVariant, type PubsubEventMessage, type PubsubSubscribeMessage, type PubsubTopicsListMessage, type PubsubTopicsRequestMessage, type Reader, type ReaderAvailability, 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 RequestTokenRefreshMessage, type ResolvedModifier, type ResolvedModifierChoice, 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 TimeClockEntry, type TimeClockEntryStatus, 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 };
+export { type ActiveCart, type ActiveCartProduct, type ActiveCompany, type ActiveCustomSales, type ActiveCustomer, type ActiveEntityChanges, ActiveEntityType, type ActiveFullProduct, type ActiveOrder, type ActiveOrderReservation, 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 AdyenCardEntryConfig, type Attribute, type AttributeEmbedded, type AttributeOption, type BaseDocument, type BaseEntity, type BaseTile, type Booking, type BookingAvailability, type BookingResource, type BookingSlot, type BookingSlotResource, type BootstrapMessage, type CalculatedTaxDetails, type CartAddress, type CartDiscountItem, type CartFeeItem, type CartFeeTaxEntry, type CartFeesDetails, type CartLineComponent, type CartLineModifier, type CartReservation, type CartShipping, type CashDrawerPolicy, type CashPaymentSettings, type CashRoundingIncrement, type Category, type CompanyExtension, type CompanySettingsEavValue, type CompanySettingsEavValueType, type Composite, type CompositeChoice, type CompositeItem, type CompositeItemUnavailable, type CompositePart, type CompositePick, 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 ModifierChoiceSelection, type ModifierSelection, type ModifierSelectionType, type NonRevenueItem, type Note, type Order, type OrderAssignedUser, type OrderCartDiscount, type OrderCartFee, type OrderCustomSale, type OrderCustomSaleDiscount, type OrderCustomSaleFee, type OrderCustomStatus, type OrderInCart, type OrderLineItem, type OrderLineItemComponent, type OrderLineItemDiscount, type OrderLineItemFee, type OrderLineItemModifier, type OrderNote, type OrderPaymentMethod, type OrderPosData, type OrderRefund, type OrderRefundSummary, type OrderReservation, type OrderShippingLine, 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, type PrinterSettings, type PrinterSettingsMessage, ProcessorType, type ProdDiscountBreakdown, type ProdFeeBreakdown, type ProdModifierBreakdown, type Product, type ProductTaxDetails, type ProductVariant, type PubsubEventMessage, type PubsubSubscribeMessage, type PubsubTopicsListMessage, type PubsubTopicsRequestMessage, type Reader, type ReaderAvailability, 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 RequestTokenRefreshMessage, type ResolvedModifier, type ResolvedModifierChoice, 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 TimeClockEntry, type TimeClockEntryStatus, 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 };

package/dist/pos-types/index.js

@@ -49,6 +49,7 @@ var ProcessorType = /* @__PURE__ */ ((ProcessorType2) => {
   ProcessorType2["REDEEM"] = "Redeem";
   ProcessorType2["INTEGRATION"] = "Integration";
   ProcessorType2["PAYMENT_LINK"] = "PaymentLink";
+  ProcessorType2["ONLINE_PAYMENT"] = "OnlinePayment";
   ProcessorType2["EXTERNAL"] = "External";
   return ProcessorType2;
 })(ProcessorType || {});

package/dist/pos-types/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../pos-types/index.ts","../../pos-types/active/PaymentStatus.ts","../../pos-types/active/ProcessorType.ts","../../pos-types/active/pos-runtime.ts"],"sourcesContent":["// @final-commerce/common/pos-types\n//\n// Public POS contract types for Final Commerce terminals — consumed by render\n// and command-frame. These mirror the public (wire) subset of data-layer's\n// Mongoose schemas (option D: manually mirrored, no data-layer dependency),\n// public-scrubbed: `_id`→`id`, `__v`/`_class`/`isDeleted` omitted, ObjectId\n// refs stringified, dates as ISO 8601 strings, secrets dropped.\n//\n// Shared primitives (CurrencyCode and the other enums, the order-state-machine\n// engine types) live elsewhere in this package — import them from\n// `@final-commerce/common` directly.\n\n// Type-level helpers (e.g. `Enrich` — builds Active* types from wire bases).\nexport type { Enrich } from './util';\n\n// Public bases for entities (BaseDocument = no companyId; BaseEntity adds it).\nexport type { BaseDocument, BaseEntity } from './base';\n\n// Embedded sub-document shapes.\nexport * from './embedded';\n\n// Entity shapes (wire).\nexport * from './entities';\n\n// Enriched (Render in-memory) `Active*` layer.\nexport * from './active';\n\n// Seam contract — the frozen station-home (HOST) ↔ pos-brain (runtime)\n// interface: selection-context snapshot + ServiceChannel message union.\nexport * from './seam';\n","export enum PaymentStatus {\n  FAILED = 'failed',\n  SUCCESS = 'success',\n  CANCELED = 'canceled',\n  IN_PROGRESS = 'inProgress',\n}\n","// Payment processor / tender type for a POS payment. Shared by Render and\n// command-frame; the string values are the wire contract used by orders.\nexport enum ProcessorType {\n  FINAL_PAY = 'Terminal',\n  TAP_TO_PAY = 'TapToPay',\n  MOTO = 'Moto',\n  CLOUD = 'Cloud',\n  /**\n   * @deprecated No payment path stamps this. Bluetooth-reader sales stamp `FINAL_PAY`\n   * ('Terminal') as their processor; station-home reuses this member only for the\n   * unrelated reader-connectionType UI field, not for an order/payment record.\n   */\n  BLUETOOTH = 'Bluetooth',\n  CASH = 'Cash',\n  CUSTOM_PAY = 'CustomPay',\n  VENDARA = 'Vendara',\n  /** Extension-controlled payment (e.g. gift card redeem); order uses paymentType `redeem`. */\n  REDEEM = 'Redeem',\n  /** Extension-controlled integration (e.g. Stripe-like); order uses paymentType `integration`. */\n  INTEGRATION = 'Integration',\n  /**\n   * Written by hub-api's payment-link settle as the payment method's processor label — the\n   * channel (like Moto/Terminal/Cloud), not the PSP brand (that lives in `paymentData.processor`).\n   * Card-not-present for receipt purposes.\n   */\n  PAYMENT_LINK = 'PaymentLink',\n  /**\n   * Money taken outside the terminal (online, a delivery app, a voucher…), recorded under\n   * a label with no device and no cash drawer. The order uses paymentType `external` —\n   * deliberately distinct from `custom`, the Custom Payments extension's billed tender.\n   */\n  EXTERNAL = 'External',\n}\n","// Render in-memory POS runtime support types (tax engine, tips, cash, active-entity discriminator, environment data, flow) — the PaymentStatus-dependent active types (ActiveSplitPayment/RefundProcessingStatus/ActiveRefundOrder) remain in Render until PaymentStatus moves.\n\nimport type { CartFeeTaxEntry } from './CartFee';\nimport type { OrderTax } from '../embedded/OrderTax';\n\ninterface TaxesDetails {\n  [id: string]: {\n    amount: number;\n    percentage: number;\n    name: string;\n    taxTableName: string;\n    taxTableId: string;\n    compounding?: boolean;\n    priority?: number;\n  };\n}\n\nexport interface ProdDiscountBreakdown {\n  amount: number;\n  percentage: number;\n  label?: string;\n}\n\nexport interface ProdFeeBreakdown {\n  amount: number;\n  percentage: number;\n  label?: string;\n  tax: number;\n  taxTableId?: string;\n  taxRateId?: string;\n  applyTaxes: boolean;\n}\n\n/**\n * One modifier row after the tax engine ran (FT-0010): the cart row extended by the\n * line quantity, plus the tax computed on it. buildOrderFromCart copies these onto\n * OrderLineItem.modifiers[] as { …row, total: amount, totalTax: tax }.\n */\nexport interface ProdModifierBreakdown {\n  modifierId: string;\n  modifierName: string;\n  choiceId: string;\n  choiceName: string;\n  /** Display label from the cart row — \"{modifierName} - {choiceName}\". Not persisted on the order row. */\n  label?: string;\n  unitPrice: number;\n  quantity: number;\n  /** unitPrice × quantity × line.quantity, in minor units. */\n  amount: number;\n  tax: number;\n  /** Engine INPUT (from the cart row): which table taxes this row. Not persisted on the order row. */\n  taxTableId?: string;\n  /** Engine OUTPUT: per-rate breakdown of `tax` — becomes OrderLineItemModifier.taxes. */\n  taxes?: OrderTax[];\n  /** From the cart row: the composite component it applies to, so rows arrive split per component (B28). */\n  componentIndex?: number;\n}\n\nexport interface ProductTaxDetails {\n  tax: number;\n  prodDiscount: number;\n  /** Line-level item discount in minor units (originalLineTotal − lineDisplayBase); drift-free, matches the value written to orders/refunds. */\n  prodDiscountTotal: number;\n  cartDiscount: number;\n  prodDiscountPercentage: number;\n  cartDiscountPercentage: number;\n  taxes: TaxesDetails;\n  fee?: number;\n  feeTax?: number;\n  feePercentage?: number;\n  feeLabel?: string;\n  cartFee?: number;\n  cartFeeTax?: number;\n  cartFeePercentage?: number;\n  cartFeeLabel?: string;\n  feeTaxTableId?: string;\n  cartFeeTaxTableId?: string;\n  prodDiscountLabel?: string;\n  /** Staging: line total including fee for discount allocation */\n  lineDisplayWithFee?: number;\n  cartDiscountAllocated?: number;\n  lineAfterCartDiscount?: number;\n  computedLineTotal?: number;\n  computedLineTax?: number;\n  feeDisplay?: number;\n  prodDiscounts?: ProdDiscountBreakdown[];\n  fees?: ProdFeeBreakdown[];\n  /** Staging: (price × qty) − sum(itemDiscounts) + sum(itemFees) + sum(modifiers) */\n  lineNetWithFees?: number;\n  /** Σ modifier rows extended by the line quantity — fee-level money, joins the line after the product discount. */\n  modifierDisplay?: number;\n  /** Tax computed on the modifier rows (product's tax table unless a row names its own). Inside computedLineTax. */\n  modifierTax?: number;\n  modifiers?: ProdModifierBreakdown[];\n}\n\nexport interface CustomSaleDetails {\n  tax: number;\n  cartDiscount: number;\n  cartDiscountPercentage: number;\n  taxes: TaxesDetails;\n  cartFee?: number;\n  cartFeeTax?: number;\n  cartFeePercentage?: number;\n  cartFeeLabel?: string;\n  cartFeeTaxTableId?: string;\n  applyTaxes?: boolean;\n  /** Staging: for discount allocation and order total */\n  lineDisplayWithFee?: number;\n  cartDiscountAllocated?: number;\n  lineAfterCartDiscount?: number;\n  computedLineTotal?: number;\n  computedLineTax?: number;\n}\n\nexport interface CartFeesDetails {\n  name: string;\n  amount: number;\n  percentage: number;\n  feeTax: number;\n  taxTableId: string;\n  taxName: string;\n  /** Per-rate breakdown (gst, hst, etc.) so order/refund summary can show correct amounts per rate. */\n  taxes?: CartFeeTaxEntry[];\n}\n\nexport interface CalculatedTaxDetails {\n  tax: number;\n  total: number;\n  subtotal: number;\n  orderSubtotal: number;\n  totalDiscount: number;\n  /** Staging: cart discount amount and subtotal after discount */\n  discountAmount?: number;\n  subtotalAfterDiscount?: number;\n  products: { [id: string]: ProductTaxDetails };\n  customSales: { [id: string]: CustomSaleDetails };\n  totalTaxes: TaxesDetails;\n  cartFees: CartFeesDetails[];\n}\n\nexport interface TipData {\n  value: number;\n  label?: string;\n  isPercent: boolean;\n}\n\nexport interface TipsDetails {\n  total: number;\n  tips: TipData[];\n  currency?: string;\n  noTipLabel?: string;\n  customTipLabel?: string;\n  selectedTip?: TipData;\n  cashChange?: number;\n  enabled?: boolean;\n}\n\nexport type CashRoundingIncrement = '' | '0.05' | '0.10' | '0.25' | '0.50' | '1.00';\n\nexport interface CashPaymentSettings {\n  cashRounding: CashRoundingIncrement;\n}\n\nexport enum ActiveEntityType {\n  TAX = 'tax',\n  CART = 'cart',\n  USER = 'user',\n  ORDER = 'order',\n  PRODUCT = 'product',\n  FULL_PRODUCT = 'fullProduct',\n  CUSTOMER = 'customer',\n  OUTLET = 'outlet',\n  CHANGES = 'changes',\n  SPLIT_PAYMENT = 'splitPayment',\n  CALCULATED_TAX = 'calculatedTaxDetails',\n  TIPS_DETAILS = 'tipsDetails',\n  CASH_PAYMENT_SETTINGS = 'cashPaymentSettings',\n  REFUND_DETAILS = 'refundDetails',\n  COMPANY = 'company',\n  IS_AUTHENTICATED = 'isAuthenticated',\n  TIMER = 'timer',\n  UPDATED_ORDER_ACTIONS = 'updatedOrderActions', //FOR ORDER UPDATE VIA ACTION\n  BUILD = 'activeBuild',\n  BUILD_UPDATE_INFO = 'buildUpdateInfo',\n  GLOBAL_BLOCKS = 'globalBlocks',\n  ACTIVE_STATION = 'activeStation',\n  SMART_GRID = 'smartGrid',\n  CUSTOM_SALE = 'customSale',\n  ACTIVE_FLOW = 'activeFlow',\n  ACTIVE_FLOW_VERSION_URL = 'activeFlowVersionUrl',\n}\n\nexport enum EnvironmentDataKeys {\n  NETWORK_INFO = 'Network Info',\n  DISPLAY = 'Display',\n  APP_INFO = 'App Info',\n  LOCATION = 'Location',\n  DEVICE_INFO = 'Device Info',\n  SYSTEM_HEALTH = 'System Health',\n  DEVELOPER = 'Developer',\n  PERIPHERAL_DEVICES = 'Peripheral Devices',\n}\n\nexport enum EnvironmentDataSubKeys {\n  DEVICE_STATUS = 'Device Status',\n  LAST_ONLINE_TIME = 'Last Online Time',\n  NETWORK_TYPE = 'Network Type',\n  SIGNAL_STRENGTH = 'Signal Strength',\n  NETWORK_NAME = 'Network name',\n  IP_ADDRESS = 'IP Address',\n\n  SCREEN_RESOLUTION = 'Screen Resolution',\n  PIXEL_RATIO = 'Pixel Ratio',\n  ORIENTATION = 'Orientation',\n\n  APP_VERSION = 'App Version',\n  BUILD_NUMBER = 'Build Number',\n  BUNDLE_ID = 'Bundle ID',\n  INSTALLED = 'Installed',\n  LAST_UPDATED = 'Last Updated',\n\n  LOCATION_ACCESS = 'Location Access',\n  CURRENT_LOCATION = 'Current Location',\n\n  MODEL = 'Model',\n  SYSTEM_VERSION = 'System Version',\n  FIRMWARE_VERSION = 'Firmware Version',\n  SERIAL_NUMBER = 'Serial Number',\n  IMEI_NUMBER = 'IMEI Number',\n  MAC_ADDRESS = 'MAC Address',\n  ACTIVATION_TIME = 'Activation Time',\n  TIME_ZONE = 'Time Zone',\n  DEVICE_LANGUAGE = 'Device Language',\n\n  TOTAL_RAM = 'Total RAM',\n  BATTERY_LEVEL = 'Battery Level',\n  BATTERY_STATUS = 'Battery Status',\n  LOW_POWER_MODE = 'Low Power Mode',\n  AVERAGE_CPU_USAGE = 'Average CPU Usage',\n  CPU_SPEED = 'CPU Speed',\n  AVAILABLE_STORAGE = 'Available Storage',\n  TOTAL_STORAGE = 'Total Storage',\n  UPTIME = 'Uptime',\n\n  FLUTTER_VERSION = 'Flutter Version',\n  DART_VERSION = 'Dart Version',\n  ENVIRONMENT = 'Environment',\n\n  CONNECTED_PRINTER = 'Connected Printer',\n}\n\nexport interface ActiveTimer {\n  initialTimer: string;\n  currentTimer: string;\n}\n\nexport interface ActiveUpdatedOrder {\n  customerNote?: string;\n  status?: string;\n}\n\nexport interface TaxTableActive {\n  name: string;\n  country: string;\n  postcode: string;\n  rate: number;\n  priority: number;\n  compounding: boolean;\n  id: string;\n  taxTableName: string;\n  taxTableId: string;\n}\n\nexport interface ActiveTaxDetails {\n  taxIncl?: boolean;\n  tables: { [name: string]: TaxTableActive[] };\n}\n\nexport interface ActiveEntityChanges {\n  productInCart: string[] | null; //array of ids of product in cart\n  numberOfProductsInCart: number;\n  cartValue: number;\n  user: string | null;\n  customer: string | null;\n  order: string | null;\n  role: string | null;\n  product: string | null;\n}\n\nexport interface Flow {\n  _id: string;\n  /**\n   * Stable ObjectId hub-api keys FlowSettings / PaymentSettings under.\n   * Set for AI flows resolved Miami-direct (station-home adapts the service\n   * projection onto this shape); absent on regular flows, where `_id` is the\n   * settings key. Settings lookups should key by `hubId ?? _id`.\n   */\n  hubId?: string;\n  companyId: string;\n  title: string;\n  description: string;\n  template: string;\n  createdBy: string;\n  flowData: Record<string, any>;\n  isDeleted: boolean;\n  createdAt: string;\n  updatedAt: string;\n  previewImage: string;\n  currentVersion: string;\n  webAppId: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAO,IAAK,gBAAL,kBAAKA,mBAAL;AACL,EAAAA,eAAA,YAAS;AACT,EAAAA,eAAA,aAAU;AACV,EAAAA,eAAA,cAAW;AACX,EAAAA,eAAA,iBAAc;AAJJ,SAAAA;AAAA,GAAA;;;ACEL,IAAK,gBAAL,kBAAKC,mBAAL;AACL,EAAAA,eAAA,eAAY;AACZ,EAAAA,eAAA,gBAAa;AACb,EAAAA,eAAA,UAAO;AACP,EAAAA,eAAA,WAAQ;AAMR,EAAAA,eAAA,eAAY;AACZ,EAAAA,eAAA,UAAO;AACP,EAAAA,eAAA,gBAAa;AACb,EAAAA,eAAA,aAAU;AAEV,EAAAA,eAAA,YAAS;AAET,EAAAA,eAAA,iBAAc;AAMd,EAAAA,eAAA,kBAAe;AAMf,EAAAA,eAAA,cAAW;AA7BD,SAAAA;AAAA,GAAA;;;ACkKL,IAAK,mBAAL,kBAAKC,sBAAL;AACL,EAAAA,kBAAA,SAAM;AACN,EAAAA,kBAAA,UAAO;AACP,EAAAA,kBAAA,UAAO;AACP,EAAAA,kBAAA,WAAQ;AACR,EAAAA,kBAAA,aAAU;AACV,EAAAA,kBAAA,kBAAe;AACf,EAAAA,kBAAA,cAAW;AACX,EAAAA,kBAAA,YAAS;AACT,EAAAA,kBAAA,aAAU;AACV,EAAAA,kBAAA,mBAAgB;AAChB,EAAAA,kBAAA,oBAAiB;AACjB,EAAAA,kBAAA,kBAAe;AACf,EAAAA,kBAAA,2BAAwB;AACxB,EAAAA,kBAAA,oBAAiB;AACjB,EAAAA,kBAAA,aAAU;AACV,EAAAA,kBAAA,sBAAmB;AACnB,EAAAA,kBAAA,WAAQ;AACR,EAAAA,kBAAA,2BAAwB;AACxB,EAAAA,kBAAA,WAAQ;AACR,EAAAA,kBAAA,uBAAoB;AACpB,EAAAA,kBAAA,mBAAgB;AAChB,EAAAA,kBAAA,oBAAiB;AACjB,EAAAA,kBAAA,gBAAa;AACb,EAAAA,kBAAA,iBAAc;AACd,EAAAA,kBAAA,iBAAc;AACd,EAAAA,kBAAA,6BAA0B;AA1BhB,SAAAA;AAAA,GAAA;AA6BL,IAAK,sBAAL,kBAAKC,yBAAL;AACL,EAAAA,qBAAA,kBAAe;AACf,EAAAA,qBAAA,aAAU;AACV,EAAAA,qBAAA,cAAW;AACX,EAAAA,qBAAA,cAAW;AACX,EAAAA,qBAAA,iBAAc;AACd,EAAAA,qBAAA,mBAAgB;AAChB,EAAAA,qBAAA,eAAY;AACZ,EAAAA,qBAAA,wBAAqB;AARX,SAAAA;AAAA,GAAA;AAWL,IAAK,yBAAL,kBAAKC,4BAAL;AACL,EAAAA,wBAAA,mBAAgB;AAChB,EAAAA,wBAAA,sBAAmB;AACnB,EAAAA,wBAAA,kBAAe;AACf,EAAAA,wBAAA,qBAAkB;AAClB,EAAAA,wBAAA,kBAAe;AACf,EAAAA,wBAAA,gBAAa;AAEb,EAAAA,wBAAA,uBAAoB;AACpB,EAAAA,wBAAA,iBAAc;AACd,EAAAA,wBAAA,iBAAc;AAEd,EAAAA,wBAAA,iBAAc;AACd,EAAAA,wBAAA,kBAAe;AACf,EAAAA,wBAAA,eAAY;AACZ,EAAAA,wBAAA,eAAY;AACZ,EAAAA,wBAAA,kBAAe;AAEf,EAAAA,wBAAA,qBAAkB;AAClB,EAAAA,wBAAA,sBAAmB;AAEnB,EAAAA,wBAAA,WAAQ;AACR,EAAAA,wBAAA,oBAAiB;AACjB,EAAAA,wBAAA,sBAAmB;AACnB,EAAAA,wBAAA,mBAAgB;AAChB,EAAAA,wBAAA,iBAAc;AACd,EAAAA,wBAAA,iBAAc;AACd,EAAAA,wBAAA,qBAAkB;AAClB,EAAAA,wBAAA,eAAY;AACZ,EAAAA,wBAAA,qBAAkB;AAElB,EAAAA,wBAAA,eAAY;AACZ,EAAAA,wBAAA,mBAAgB;AAChB,EAAAA,wBAAA,oBAAiB;AACjB,EAAAA,wBAAA,oBAAiB;AACjB,EAAAA,wBAAA,uBAAoB;AACpB,EAAAA,wBAAA,eAAY;AACZ,EAAAA,wBAAA,uBAAoB;AACpB,EAAAA,wBAAA,mBAAgB;AAChB,EAAAA,wBAAA,YAAS;AAET,EAAAA,wBAAA,qBAAkB;AAClB,EAAAA,wBAAA,kBAAe;AACf,EAAAA,wBAAA,iBAAc;AAEd,EAAAA,wBAAA,uBAAoB;AA7CV,SAAAA;AAAA,GAAA;","names":["PaymentStatus","ProcessorType","ActiveEntityType","EnvironmentDataKeys","EnvironmentDataSubKeys"]}
+{"version":3,"sources":["../../pos-types/index.ts","../../pos-types/active/PaymentStatus.ts","../../pos-types/active/ProcessorType.ts","../../pos-types/active/pos-runtime.ts"],"sourcesContent":["// @final-commerce/common/pos-types\n//\n// Public POS contract types for Final Commerce terminals — consumed by render\n// and command-frame. These mirror the public (wire) subset of data-layer's\n// Mongoose schemas (option D: manually mirrored, no data-layer dependency),\n// public-scrubbed: `_id`→`id`, `__v`/`_class`/`isDeleted` omitted, ObjectId\n// refs stringified, dates as ISO 8601 strings, secrets dropped.\n//\n// Shared primitives (CurrencyCode and the other enums, the order-state-machine\n// engine types) live elsewhere in this package — import them from\n// `@final-commerce/common` directly.\n\n// Type-level helpers (e.g. `Enrich` — builds Active* types from wire bases).\nexport type { Enrich } from './util';\n\n// Public bases for entities (BaseDocument = no companyId; BaseEntity adds it).\nexport type { BaseDocument, BaseEntity } from './base';\n\n// Embedded sub-document shapes.\nexport * from './embedded';\n\n// Entity shapes (wire).\nexport * from './entities';\n\n// Enriched (Render in-memory) `Active*` layer.\nexport * from './active';\n\n// Seam contract — the frozen station-home (HOST) ↔ pos-brain (runtime)\n// interface: selection-context snapshot + ServiceChannel message union.\nexport * from './seam';\n","export enum PaymentStatus {\n  FAILED = 'failed',\n  SUCCESS = 'success',\n  CANCELED = 'canceled',\n  IN_PROGRESS = 'inProgress',\n}\n","// Payment processor / tender type for a POS payment. Shared by Render and\n// command-frame; the string values are the wire contract used by orders.\nexport enum ProcessorType {\n  FINAL_PAY = 'Terminal',\n  TAP_TO_PAY = 'TapToPay',\n  MOTO = 'Moto',\n  CLOUD = 'Cloud',\n  /**\n   * @deprecated No payment path stamps this. Bluetooth-reader sales stamp `FINAL_PAY`\n   * ('Terminal') as their processor; station-home reuses this member only for the\n   * unrelated reader-connectionType UI field, not for an order/payment record.\n   */\n  BLUETOOTH = 'Bluetooth',\n  CASH = 'Cash',\n  CUSTOM_PAY = 'CustomPay',\n  VENDARA = 'Vendara',\n  /** Extension-controlled payment (e.g. gift card redeem); order uses paymentType `redeem`. */\n  REDEEM = 'Redeem',\n  /** Extension-controlled integration (e.g. Stripe-like); order uses paymentType `integration`. */\n  INTEGRATION = 'Integration',\n  /**\n   * Written by hub-api's payment-link settle as the payment method's processor label — the\n   * channel (like Moto/Terminal/Cloud), not the PSP brand (that lives in `paymentData.processor`).\n   * Card-not-present for receipt purposes.\n   */\n  PAYMENT_LINK = 'PaymentLink',\n  /**\n   * A shopper paying on a published online store, with their own card, in their own browser.\n   * Written by hub-api's settle for an order whose `source` is `OrderPlatform.ONLINE_STORE`.\n   *\n   * SEPARATE FROM `PAYMENT_LINK` DELIBERATELY, even though both settle through the same Adyen\n   * notification path: reports group a tender by `(paymentType, processor)`, so sharing a label\n   * would fold every website sale into the merchant's Pay-by-Link row with no way to tell them\n   * apart. Same channel-not-brand rule as the rest of this enum — the PSP stays on the\n   * transaction's `paymentData.processor`.\n   *\n   * Card-not-present for receipt purposes, like `PAYMENT_LINK`, but the card was entered by the\n   * SHOPPER on an Ecommerce checkout rather than by the merchant or on a hosted page.\n   */\n  ONLINE_PAYMENT = 'OnlinePayment',\n  /**\n   * Money taken outside the terminal (online, a delivery app, a voucher…), recorded under\n   * a label with no device and no cash drawer. The order uses paymentType `external` —\n   * deliberately distinct from `custom`, the Custom Payments extension's billed tender.\n   */\n  EXTERNAL = 'External',\n}\n","// Render in-memory POS runtime support types (tax engine, tips, cash, active-entity discriminator, environment data, flow) — the PaymentStatus-dependent active types (ActiveSplitPayment/RefundProcessingStatus/ActiveRefundOrder) remain in Render until PaymentStatus moves.\n\nimport type { CartFeeTaxEntry } from './CartFee';\nimport type { OrderTax } from '../embedded/OrderTax';\n\ninterface TaxesDetails {\n  [id: string]: {\n    amount: number;\n    percentage: number;\n    name: string;\n    taxTableName: string;\n    taxTableId: string;\n    compounding?: boolean;\n    priority?: number;\n  };\n}\n\nexport interface ProdDiscountBreakdown {\n  amount: number;\n  percentage: number;\n  label?: string;\n}\n\nexport interface ProdFeeBreakdown {\n  amount: number;\n  percentage: number;\n  label?: string;\n  tax: number;\n  taxTableId?: string;\n  taxRateId?: string;\n  applyTaxes: boolean;\n}\n\n/**\n * One modifier row after the tax engine ran (FT-0010): the cart row extended by the\n * line quantity, plus the tax computed on it. buildOrderFromCart copies these onto\n * OrderLineItem.modifiers[] as { …row, total: amount, totalTax: tax }.\n */\nexport interface ProdModifierBreakdown {\n  modifierId: string;\n  modifierName: string;\n  choiceId: string;\n  choiceName: string;\n  /** Display label from the cart row — \"{modifierName} - {choiceName}\". Not persisted on the order row. */\n  label?: string;\n  unitPrice: number;\n  quantity: number;\n  /** unitPrice × quantity × line.quantity, in minor units. */\n  amount: number;\n  tax: number;\n  /** Engine INPUT (from the cart row): which table taxes this row. Not persisted on the order row. */\n  taxTableId?: string;\n  /** Engine OUTPUT: per-rate breakdown of `tax` — becomes OrderLineItemModifier.taxes. */\n  taxes?: OrderTax[];\n  /** From the cart row: the composite component it applies to, so rows arrive split per component (B28). */\n  componentIndex?: number;\n}\n\nexport interface ProductTaxDetails {\n  tax: number;\n  prodDiscount: number;\n  /** Line-level item discount in minor units (originalLineTotal − lineDisplayBase); drift-free, matches the value written to orders/refunds. */\n  prodDiscountTotal: number;\n  cartDiscount: number;\n  prodDiscountPercentage: number;\n  cartDiscountPercentage: number;\n  taxes: TaxesDetails;\n  fee?: number;\n  feeTax?: number;\n  feePercentage?: number;\n  feeLabel?: string;\n  cartFee?: number;\n  cartFeeTax?: number;\n  cartFeePercentage?: number;\n  cartFeeLabel?: string;\n  feeTaxTableId?: string;\n  cartFeeTaxTableId?: string;\n  prodDiscountLabel?: string;\n  /** Staging: line total including fee for discount allocation */\n  lineDisplayWithFee?: number;\n  cartDiscountAllocated?: number;\n  lineAfterCartDiscount?: number;\n  computedLineTotal?: number;\n  computedLineTax?: number;\n  feeDisplay?: number;\n  prodDiscounts?: ProdDiscountBreakdown[];\n  fees?: ProdFeeBreakdown[];\n  /** Staging: (price × qty) − sum(itemDiscounts) + sum(itemFees) + sum(modifiers) */\n  lineNetWithFees?: number;\n  /** Σ modifier rows extended by the line quantity — fee-level money, joins the line after the product discount. */\n  modifierDisplay?: number;\n  /** Tax computed on the modifier rows (product's tax table unless a row names its own). Inside computedLineTax. */\n  modifierTax?: number;\n  modifiers?: ProdModifierBreakdown[];\n}\n\nexport interface CustomSaleDetails {\n  tax: number;\n  cartDiscount: number;\n  cartDiscountPercentage: number;\n  taxes: TaxesDetails;\n  cartFee?: number;\n  cartFeeTax?: number;\n  cartFeePercentage?: number;\n  cartFeeLabel?: string;\n  cartFeeTaxTableId?: string;\n  applyTaxes?: boolean;\n  /** Staging: for discount allocation and order total */\n  lineDisplayWithFee?: number;\n  cartDiscountAllocated?: number;\n  lineAfterCartDiscount?: number;\n  computedLineTotal?: number;\n  computedLineTax?: number;\n}\n\nexport interface CartFeesDetails {\n  name: string;\n  amount: number;\n  percentage: number;\n  feeTax: number;\n  taxTableId: string;\n  taxName: string;\n  /** Per-rate breakdown (gst, hst, etc.) so order/refund summary can show correct amounts per rate. */\n  taxes?: CartFeeTaxEntry[];\n}\n\nexport interface CalculatedTaxDetails {\n  tax: number;\n  total: number;\n  subtotal: number;\n  orderSubtotal: number;\n  totalDiscount: number;\n  /** Staging: cart discount amount and subtotal after discount */\n  discountAmount?: number;\n  subtotalAfterDiscount?: number;\n  products: { [id: string]: ProductTaxDetails };\n  customSales: { [id: string]: CustomSaleDetails };\n  totalTaxes: TaxesDetails;\n  cartFees: CartFeesDetails[];\n  /** The cart's shipping, taxed like a cart fee against the standard tax table. Absent when nothing ships. */\n  shipping?: CartFeesDetails;\n}\n\nexport interface TipData {\n  value: number;\n  label?: string;\n  isPercent: boolean;\n}\n\nexport interface TipsDetails {\n  total: number;\n  tips: TipData[];\n  currency?: string;\n  noTipLabel?: string;\n  customTipLabel?: string;\n  selectedTip?: TipData;\n  cashChange?: number;\n  enabled?: boolean;\n}\n\nexport type CashRoundingIncrement = '' | '0.05' | '0.10' | '0.25' | '0.50' | '1.00';\n\nexport interface CashPaymentSettings {\n  cashRounding: CashRoundingIncrement;\n}\n\nexport enum ActiveEntityType {\n  TAX = 'tax',\n  CART = 'cart',\n  USER = 'user',\n  ORDER = 'order',\n  PRODUCT = 'product',\n  FULL_PRODUCT = 'fullProduct',\n  CUSTOMER = 'customer',\n  OUTLET = 'outlet',\n  CHANGES = 'changes',\n  SPLIT_PAYMENT = 'splitPayment',\n  CALCULATED_TAX = 'calculatedTaxDetails',\n  TIPS_DETAILS = 'tipsDetails',\n  CASH_PAYMENT_SETTINGS = 'cashPaymentSettings',\n  REFUND_DETAILS = 'refundDetails',\n  COMPANY = 'company',\n  IS_AUTHENTICATED = 'isAuthenticated',\n  TIMER = 'timer',\n  UPDATED_ORDER_ACTIONS = 'updatedOrderActions', //FOR ORDER UPDATE VIA ACTION\n  BUILD = 'activeBuild',\n  BUILD_UPDATE_INFO = 'buildUpdateInfo',\n  GLOBAL_BLOCKS = 'globalBlocks',\n  ACTIVE_STATION = 'activeStation',\n  SMART_GRID = 'smartGrid',\n  CUSTOM_SALE = 'customSale',\n  ACTIVE_FLOW = 'activeFlow',\n  ACTIVE_FLOW_VERSION_URL = 'activeFlowVersionUrl',\n}\n\nexport enum EnvironmentDataKeys {\n  NETWORK_INFO = 'Network Info',\n  DISPLAY = 'Display',\n  APP_INFO = 'App Info',\n  LOCATION = 'Location',\n  DEVICE_INFO = 'Device Info',\n  SYSTEM_HEALTH = 'System Health',\n  DEVELOPER = 'Developer',\n  PERIPHERAL_DEVICES = 'Peripheral Devices',\n}\n\nexport enum EnvironmentDataSubKeys {\n  DEVICE_STATUS = 'Device Status',\n  LAST_ONLINE_TIME = 'Last Online Time',\n  NETWORK_TYPE = 'Network Type',\n  SIGNAL_STRENGTH = 'Signal Strength',\n  NETWORK_NAME = 'Network name',\n  IP_ADDRESS = 'IP Address',\n\n  SCREEN_RESOLUTION = 'Screen Resolution',\n  PIXEL_RATIO = 'Pixel Ratio',\n  ORIENTATION = 'Orientation',\n\n  APP_VERSION = 'App Version',\n  BUILD_NUMBER = 'Build Number',\n  BUNDLE_ID = 'Bundle ID',\n  INSTALLED = 'Installed',\n  LAST_UPDATED = 'Last Updated',\n\n  LOCATION_ACCESS = 'Location Access',\n  CURRENT_LOCATION = 'Current Location',\n\n  MODEL = 'Model',\n  SYSTEM_VERSION = 'System Version',\n  FIRMWARE_VERSION = 'Firmware Version',\n  SERIAL_NUMBER = 'Serial Number',\n  IMEI_NUMBER = 'IMEI Number',\n  MAC_ADDRESS = 'MAC Address',\n  ACTIVATION_TIME = 'Activation Time',\n  TIME_ZONE = 'Time Zone',\n  DEVICE_LANGUAGE = 'Device Language',\n\n  TOTAL_RAM = 'Total RAM',\n  BATTERY_LEVEL = 'Battery Level',\n  BATTERY_STATUS = 'Battery Status',\n  LOW_POWER_MODE = 'Low Power Mode',\n  AVERAGE_CPU_USAGE = 'Average CPU Usage',\n  CPU_SPEED = 'CPU Speed',\n  AVAILABLE_STORAGE = 'Available Storage',\n  TOTAL_STORAGE = 'Total Storage',\n  UPTIME = 'Uptime',\n\n  FLUTTER_VERSION = 'Flutter Version',\n  DART_VERSION = 'Dart Version',\n  ENVIRONMENT = 'Environment',\n\n  CONNECTED_PRINTER = 'Connected Printer',\n}\n\nexport interface ActiveTimer {\n  initialTimer: string;\n  currentTimer: string;\n}\n\nexport interface ActiveUpdatedOrder {\n  customerNote?: string;\n  status?: string;\n}\n\nexport interface TaxTableActive {\n  name: string;\n  country: string;\n  postcode: string;\n  rate: number;\n  priority: number;\n  compounding: boolean;\n  id: string;\n  taxTableName: string;\n  taxTableId: string;\n}\n\nexport interface ActiveTaxDetails {\n  taxIncl?: boolean;\n  tables: { [name: string]: TaxTableActive[] };\n}\n\nexport interface ActiveEntityChanges {\n  productInCart: string[] | null; //array of ids of product in cart\n  numberOfProductsInCart: number;\n  cartValue: number;\n  user: string | null;\n  customer: string | null;\n  order: string | null;\n  role: string | null;\n  product: string | null;\n}\n\nexport interface Flow {\n  _id: string;\n  /**\n   * Stable ObjectId hub-api keys FlowSettings / PaymentSettings under.\n   * Set for AI flows resolved Miami-direct (station-home adapts the service\n   * projection onto this shape); absent on regular flows, where `_id` is the\n   * settings key. Settings lookups should key by `hubId ?? _id`.\n   */\n  hubId?: string;\n  companyId: string;\n  title: string;\n  description: string;\n  template: string;\n  createdBy: string;\n  flowData: Record<string, any>;\n  isDeleted: boolean;\n  createdAt: string;\n  updatedAt: string;\n  previewImage: string;\n  currentVersion: string;\n  webAppId: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAO,IAAK,gBAAL,kBAAKA,mBAAL;AACL,EAAAA,eAAA,YAAS;AACT,EAAAA,eAAA,aAAU;AACV,EAAAA,eAAA,cAAW;AACX,EAAAA,eAAA,iBAAc;AAJJ,SAAAA;AAAA,GAAA;;;ACEL,IAAK,gBAAL,kBAAKC,mBAAL;AACL,EAAAA,eAAA,eAAY;AACZ,EAAAA,eAAA,gBAAa;AACb,EAAAA,eAAA,UAAO;AACP,EAAAA,eAAA,WAAQ;AAMR,EAAAA,eAAA,eAAY;AACZ,EAAAA,eAAA,UAAO;AACP,EAAAA,eAAA,gBAAa;AACb,EAAAA,eAAA,aAAU;AAEV,EAAAA,eAAA,YAAS;AAET,EAAAA,eAAA,iBAAc;AAMd,EAAAA,eAAA,kBAAe;AAcf,EAAAA,eAAA,oBAAiB;AAMjB,EAAAA,eAAA,cAAW;AA3CD,SAAAA;AAAA,GAAA;;;ACoKL,IAAK,mBAAL,kBAAKC,sBAAL;AACL,EAAAA,kBAAA,SAAM;AACN,EAAAA,kBAAA,UAAO;AACP,EAAAA,kBAAA,UAAO;AACP,EAAAA,kBAAA,WAAQ;AACR,EAAAA,kBAAA,aAAU;AACV,EAAAA,kBAAA,kBAAe;AACf,EAAAA,kBAAA,cAAW;AACX,EAAAA,kBAAA,YAAS;AACT,EAAAA,kBAAA,aAAU;AACV,EAAAA,kBAAA,mBAAgB;AAChB,EAAAA,kBAAA,oBAAiB;AACjB,EAAAA,kBAAA,kBAAe;AACf,EAAAA,kBAAA,2BAAwB;AACxB,EAAAA,kBAAA,oBAAiB;AACjB,EAAAA,kBAAA,aAAU;AACV,EAAAA,kBAAA,sBAAmB;AACnB,EAAAA,kBAAA,WAAQ;AACR,EAAAA,kBAAA,2BAAwB;AACxB,EAAAA,kBAAA,WAAQ;AACR,EAAAA,kBAAA,uBAAoB;AACpB,EAAAA,kBAAA,mBAAgB;AAChB,EAAAA,kBAAA,oBAAiB;AACjB,EAAAA,kBAAA,gBAAa;AACb,EAAAA,kBAAA,iBAAc;AACd,EAAAA,kBAAA,iBAAc;AACd,EAAAA,kBAAA,6BAA0B;AA1BhB,SAAAA;AAAA,GAAA;AA6BL,IAAK,sBAAL,kBAAKC,yBAAL;AACL,EAAAA,qBAAA,kBAAe;AACf,EAAAA,qBAAA,aAAU;AACV,EAAAA,qBAAA,cAAW;AACX,EAAAA,qBAAA,cAAW;AACX,EAAAA,qBAAA,iBAAc;AACd,EAAAA,qBAAA,mBAAgB;AAChB,EAAAA,qBAAA,eAAY;AACZ,EAAAA,qBAAA,wBAAqB;AARX,SAAAA;AAAA,GAAA;AAWL,IAAK,yBAAL,kBAAKC,4BAAL;AACL,EAAAA,wBAAA,mBAAgB;AAChB,EAAAA,wBAAA,sBAAmB;AACnB,EAAAA,wBAAA,kBAAe;AACf,EAAAA,wBAAA,qBAAkB;AAClB,EAAAA,wBAAA,kBAAe;AACf,EAAAA,wBAAA,gBAAa;AAEb,EAAAA,wBAAA,uBAAoB;AACpB,EAAAA,wBAAA,iBAAc;AACd,EAAAA,wBAAA,iBAAc;AAEd,EAAAA,wBAAA,iBAAc;AACd,EAAAA,wBAAA,kBAAe;AACf,EAAAA,wBAAA,eAAY;AACZ,EAAAA,wBAAA,eAAY;AACZ,EAAAA,wBAAA,kBAAe;AAEf,EAAAA,wBAAA,qBAAkB;AAClB,EAAAA,wBAAA,sBAAmB;AAEnB,EAAAA,wBAAA,WAAQ;AACR,EAAAA,wBAAA,oBAAiB;AACjB,EAAAA,wBAAA,sBAAmB;AACnB,EAAAA,wBAAA,mBAAgB;AAChB,EAAAA,wBAAA,iBAAc;AACd,EAAAA,wBAAA,iBAAc;AACd,EAAAA,wBAAA,qBAAkB;AAClB,EAAAA,wBAAA,eAAY;AACZ,EAAAA,wBAAA,qBAAkB;AAElB,EAAAA,wBAAA,eAAY;AACZ,EAAAA,wBAAA,mBAAgB;AAChB,EAAAA,wBAAA,oBAAiB;AACjB,EAAAA,wBAAA,oBAAiB;AACjB,EAAAA,wBAAA,uBAAoB;AACpB,EAAAA,wBAAA,eAAY;AACZ,EAAAA,wBAAA,uBAAoB;AACpB,EAAAA,wBAAA,mBAAgB;AAChB,EAAAA,wBAAA,YAAS;AAET,EAAAA,wBAAA,qBAAkB;AAClB,EAAAA,wBAAA,kBAAe;AACf,EAAAA,wBAAA,iBAAc;AAEd,EAAAA,wBAAA,uBAAoB;AA7CV,SAAAA;AAAA,GAAA;","names":["PaymentStatus","ProcessorType","ActiveEntityType","EnvironmentDataKeys","EnvironmentDataSubKeys"]}

package/dist/pos-types/index.mjs

@@ -20,6 +20,7 @@ var ProcessorType = /* @__PURE__ */ ((ProcessorType2) => {
   ProcessorType2["REDEEM"] = "Redeem";
   ProcessorType2["INTEGRATION"] = "Integration";
   ProcessorType2["PAYMENT_LINK"] = "PaymentLink";
+  ProcessorType2["ONLINE_PAYMENT"] = "OnlinePayment";
   ProcessorType2["EXTERNAL"] = "External";
   return ProcessorType2;
 })(ProcessorType || {});