@final-commerce/common 2.3.0-staging.7 → 2.3.1

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

@@ -78,6 +78,9 @@ interface OrderSummary {
     cartFeesTotal?: number;
     taxableFeesTotal?: number;
     nonTaxableFeesTotal?: number;
+    modifiersTotal?: number;
+    taxableModifiersTotal?: number;
+    nonTaxableModifiersTotal?: number;
     totalTaxableSales?: number;
     totalNonTaxableSales?: number;
     tipTotal?: number;
@@ -143,6 +146,17 @@ 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[];
+}
 interface OrderLineItem {
     id?: string;
     productId?: string;
@@ -165,6 +179,7 @@ interface OrderLineItem {
     taxes?: OrderTax[];
     discount?: OrderLineItemDiscount;
     fee?: OrderLineItemFee;
+    modifiers?: OrderLineItemModifier[];
     lineNetWithFees?: number;
     metadata?: Metadata[];
     stock?: number;
@@ -443,8 +458,7 @@ declare enum NonRevenueItemType {
 
 declare enum ProductType {
     SIMPLE = "simple",
-    VARIABLE = "variable",
-    BOOKING = "booking"
+    VARIABLE = "variable"
 }
 declare enum ProductStatus {
     ACTIVE = "active",
@@ -458,38 +472,11 @@ declare enum PaymentProcessor {
     EXTERNAL = "external"
 }
 
-declare enum BookingType {
-    RENTAL = "rental",
-    APPOINTMENT = "appointment",
-    OVERNIGHT = "overnight",
-    GROUP = "group"
-}
-declare enum BookingRatePeriod {
-    SLOT = "slot",
-    DAY = "day",
-    NIGHT = "night",
-    WEEK = "week",
-    MONTH = "month"
-}
-declare enum BookingResourceKind {
-    ASSET = "asset",
-    ROOM = "room",
-    PROPERTY = "property",
-    SPACE = "space",
-    STAFF = "staff",
-    TABLE = "table"
-}
-declare enum ReservationStatus {
-    HELD = "held",
-    CONFIRMED = "confirmed",
-    CANCELLED = "cancelled",
-    EXPIRED = "expired"
-}
-
 interface RefundLineItem {
     taxes?: OrderTax[];
     discount?: RefundDiscount;
     fee?: OrderLineItemFee;
+    modifiers?: OrderLineItemModifier[];
     lineNetWithFees?: number;
     quantity?: number;
     stockQuantity?: number;
@@ -549,6 +536,9 @@ interface RefundSummary {
     cartFeesTotal?: number;
     taxableFeesTotal?: number;
     nonTaxableFeesTotal?: number;
+    modifiersTotal?: number;
+    taxableModifiersTotal?: number;
+    nonTaxableModifiersTotal?: number;
     totalTaxableSales?: number;
     totalNonTaxableSales?: number;
     tipTotal?: number;
@@ -588,31 +578,6 @@ interface TransactionPaymentData {
     chargeId?: string;
 }
 
-interface OrderReservation {
-    internalId: string;
-    bookingId?: string;
-    productId: string;
-    variantId?: string | null;
-    resourceId: string;
-    name: string;
-    resourceName?: string;
-    price: number;
-    quantity?: number;
-    fulfilledQuantity?: number;
-    returnedQuantity?: number;
-    taxes?: OrderTax[];
-    discount?: OrderLineItemDiscount;
-    fee?: OrderLineItemFee;
-    totalTax?: number;
-    total: number;
-    taxTableId?: string;
-    startAt: string;
-    endAt: string;
-    bufferEndAt: string;
-    override?: boolean;
-    overriddenBy?: string | null;
-}
-
 interface Attribute extends BaseEntity {
     optionName: string;
     sortingOrder: number;
@@ -828,7 +793,6 @@ interface Order extends BaseEntity {
     lineItems: Partial<OrderLineItem>[];
     customSales?: OrderCustomSale[];
     nonRevenueItems?: NonRevenueItem$1[];
-    reservations?: OrderReservation[];
     refund?: OrderRefund[];
     minorUnits?: number;
 }
@@ -877,6 +841,7 @@ interface Product extends BaseEntity {
     maxPrice?: number;
     supplier?: string;
     taxTable?: string | null;
+    defaultVariantId?: string;
     categories?: string[];
     outlets?: string[];
     currency?: CurrencyCode;
@@ -1165,22 +1130,6 @@ interface Variant extends BaseEntity {
     stockVariantId?: string;
 }
 
-interface Tax {
-    id: string;
-    name: string;
-    percentage: number;
-    amount: number;
-    taxableAmount?: number;
-    taxTableName: string;
-    taxTableId: string;
-    compounding?: boolean;
-    priority?: number;
-}
-interface Tip {
-    amount: number;
-    percentage: number;
-}
-
 interface Address {
     firstName: string;
     lastName: string;
@@ -1242,7 +1191,6 @@ interface ActiveOutlet {
     taxId: string;
     postCode?: string;
     name?: string;
-    timeZone?: string;
     stripe?: {
         locationId: string;
     };
@@ -1373,6 +1321,22 @@ interface PosDataItem {
     };
 }
 
+interface Tax {
+    id: string;
+    name: string;
+    percentage: number;
+    amount: number;
+    taxableAmount?: number;
+    taxTableName: string;
+    taxTableId: string;
+    compounding?: boolean;
+    priority?: number;
+}
+interface Tip {
+    amount: number;
+    percentage: number;
+}
+
 interface DiscountDetail {
     percentage: number;
     amount: number;
@@ -1406,6 +1370,7 @@ interface LineItem {
     taxes: Tax[];
     discount: DiscountLineItem;
     fee: FeeLineItem;
+    modifiers?: OrderLineItemModifier[];
     totalTax: number;
     total: number;
     lineNetWithFees: number;
@@ -1479,6 +1444,9 @@ interface Summary {
     cartFeesTotal?: number;
     taxableFeesTotal?: number;
     nonTaxableFeesTotal?: number;
+    modifiersTotal?: number;
+    taxableModifiersTotal?: number;
+    nonTaxableModifiersTotal?: number;
     totalTaxableSales?: number;
     totalNonTaxableSales?: number;
     tipTotal?: number;
@@ -1514,11 +1482,11 @@ interface RefundedLineItem {
     description?: string;
     images?: string[];
     fee: FeeLineItem;
+    modifiers?: OrderLineItemModifier[];
 }
 interface RefundItem {
     lineItems: RefundedLineItem[];
     customSales: RefundedCustomSale[];
-    reservations?: OrderReservation[];
     cartFees: CartFeeItem[];
     tips: RefundedTipPayment[];
     refundedBy: string;
@@ -1531,9 +1499,6 @@ interface RefundItem {
     minorUnits?: number;
 }
 
-type ActiveOrderReservation = Omit<OrderReservation, 'taxes'> & {
-    taxes?: Tax[];
-};
 type ActiveOrder = Enrich<Order, {
     _id: string;
     id?: string;
@@ -1557,7 +1522,6 @@ type ActiveOrder = Enrich<Order, {
     shipping: Address | null;
     lineItems: LineItem[];
     customSales: CustomSale[];
-    reservations?: ActiveOrderReservation[];
     nonRevenueItems?: NonRevenueItem[];
     refund?: RefundItem[];
     signature?: string | null;
@@ -1570,6 +1534,46 @@ type ActiveOrder = Enrich<Order, {
     station?: ActiveStation;
 }>;
 
+type ModifierSelectionType = 'single' | 'multiple' | 'quantity';
+interface ResolvedModifierChoice {
+    _id: string;
+    name: string;
+    price: number;
+    isDefault?: boolean;
+    defaultQuantity?: number;
+    unavailableOutletIds?: string[];
+    sortOrder: number;
+}
+interface ResolvedModifier {
+    _id: string;
+    name: string;
+    selectionType: ModifierSelectionType;
+    allowQuantity?: boolean;
+    required: boolean;
+    min?: number | null;
+    max?: number | null;
+    sortOrder: number;
+    choices: ResolvedModifierChoice[];
+}
+interface ModifierChoiceSelection {
+    choiceId: string;
+    quantity: number;
+}
+interface ModifierSelection {
+    modifierId: string;
+    choices: ModifierChoiceSelection[];
+}
+interface CartLineModifier {
+    modifierId: string;
+    modifierName: string;
+    choiceId: string;
+    choiceName: string;
+    label?: string;
+    unitPrice: number;
+    quantity: number;
+    taxTableId?: string;
+}
+
 interface Discount {
     value: number;
     label?: string;
@@ -1617,6 +1621,8 @@ interface ActiveProduct {
     stock: number;
     allowBackOrder?: boolean;
     fees?: CustomFee[];
+    modifierSelections?: ModifierSelection[];
+    modifiers?: CartLineModifier[];
     currency?: CurrencyCode;
     minorUnits?: number;
     isUnlimited?: boolean;
@@ -1628,13 +1634,6 @@ interface ActiveProduct {
     productType?: ProductType;
 }
 
-interface CartReservation extends OrderReservation {
-    bookingId: string;
-    expiresAt?: string;
-    discounts?: Discount[];
-    fees?: CustomFee[];
-}
-
 interface ActiveCustomSales {
     id: string;
     name: string;
@@ -1659,13 +1658,11 @@ interface ActiveCart {
     taxes?: Tax[];
     total: number;
     subtotal: number;
-    itemCount?: number;
     discount?: Discount;
     customFee?: CustomFee[];
     products: ActiveProduct[];
     customSales?: ActiveCustomSales[];
     nonRevenueItems?: NonRevenueItem[];
-    reservations?: CartReservation[];
     remainingBalance?: number;
     amountToBeCharged: number;
     customer?: Partial<ActiveCustomer | null> | null;
@@ -1747,8 +1744,9 @@ interface FullProduct {
     supplier?: string;
     sku?: string;
     productType: ProductType;
-    bookingRulesId?: string;
     variants: ProductVariant[];
+    defaultVariantId?: string;
+    modifiers?: ResolvedModifier[];
     minPrice?: number;
     maxPrice?: number;
     price?: number;
@@ -1761,61 +1759,6 @@ interface FullProduct {
 }
 type ActiveFullProduct = FullProduct;
 
-interface BookingSlotResource {
-    resourceId: string;
-    name: string;
-    capacity: number;
-    booked: number;
-    free: number;
-}
-interface BookingSlot {
-    startAt: string;
-    endAt: string;
-    bufferEndAt: string;
-    canStart: boolean;
-    capacity: number;
-    booked: number;
-    free: number;
-    resources: BookingSlotResource[];
-}
-interface BookingAvailability {
-    productId: string;
-    bookingRulesId: string;
-    bookingType: BookingType;
-    ratePeriod: BookingRatePeriod;
-    minimumToRun?: number;
-    minStay?: number;
-    maxStay?: number;
-    bookableUntil?: string;
-    beyondWindow?: boolean;
-    slots: BookingSlot[];
-}
-interface BookingResource {
-    id: string;
-    name: string;
-    kind: BookingResourceKind;
-    tag?: string;
-}
-interface Booking {
-    id: string;
-    productId: string;
-    resourceId: string;
-    variantId?: string;
-    startAt: string;
-    endAt: string;
-    bufferEndAt: string;
-    status: ReservationStatus;
-    expiresAt?: string;
-    orderId?: string;
-    customerId?: string;
-    productName?: string;
-    resourceName?: string;
-    customerName?: string;
-    outletId?: string;
-    outletName?: string;
-    timeZone?: string;
-}
-
 interface ActiveSession {
     id: string;
     stationId: string;
@@ -1968,6 +1911,19 @@ interface ProdFeeBreakdown {
     taxRateId?: string;
     applyTaxes: boolean;
 }
+interface ProdModifierBreakdown {
+    modifierId: string;
+    modifierName: string;
+    choiceId: string;
+    choiceName: string;
+    label?: string;
+    unitPrice: number;
+    quantity: number;
+    amount: number;
+    tax: number;
+    taxTableId?: string;
+    taxes?: OrderTax[];
+}
 interface ProductTaxDetails {
     tax: number;
     prodDiscount: number;
@@ -1996,6 +1952,9 @@ interface ProductTaxDetails {
     prodDiscounts?: ProdDiscountBreakdown[];
     fees?: ProdFeeBreakdown[];
     lineNetWithFees?: number;
+    modifierDisplay?: number;
+    modifierTax?: number;
+    modifiers?: ProdModifierBreakdown[];
 }
 interface CustomSaleDetails {
     tax: number;
@@ -2318,4 +2277,4 @@ interface PubsubEventMessage {
 }
 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 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 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 CartReservation, 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 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, ProcessorType, type ProdDiscountBreakdown, type ProdFeeBreakdown, 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 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 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 CartLineModifier, 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 ModifierChoiceSelection, type ModifierSelection, type ModifierSelectionType, type NonRevenueItem, type Note, type Order, type OrderCartDiscount, type OrderCartFee, type OrderCustomSale, type OrderCustomSaleDiscount, type OrderCustomSaleFee, type OrderLineItem, type OrderLineItemDiscount, type OrderLineItemFee, type OrderLineItemModifier, 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 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 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 };