@final-commerce/common 2.5.1-preprod.3 → 2.6.0-staging.1

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

@@ -138,24 +138,6 @@ interface OrderPosData {
     employee?: string;
 }
 
-interface OrderAssignedUser {
-    userId: string;
-    assignedAt: string;
-}
-
-interface OrderInCart {
-    active: boolean;
-    stationId: string | null;
-    since: string;
-}
-
-interface OrderCustomStatus {
-    id: string;
-    label: string;
-    setAt: string;
-    setBy: string | null;
-}
-
 interface OrderLineItemDiscount {
     itemDiscounts?: PriceModifierDetail[];
     cartDiscount?: PriceModifierDetail;
@@ -174,6 +156,27 @@ interface OrderLineItemModifier {
     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;
@@ -198,6 +201,7 @@ interface OrderLineItem {
     discount?: OrderLineItemDiscount;
     fee?: OrderLineItemFee;
     modifiers?: OrderLineItemModifier[];
+    components?: OrderLineItemComponent[];
     lineNetWithFees?: number;
     metadata?: Metadata[];
     stock?: number;
@@ -449,8 +453,7 @@ declare enum InventorySpecificActionType {
     APPLIED_FROM_WOO = "APPLIED_FROM_WOO",
     PO_RECEIVED = "PO_RECEIVED",
     EXTERNAL_SALE = "EXTERNAL_SALE",
-    EXTERNAL_RESTOCK = "EXTERNAL_RESTOCK",
-    CUSTOM = "CUSTOM"
+    EXTERNAL_RESTOCK = "EXTERNAL_RESTOCK"
 }
 declare enum UserTypes {
     COMPANY_OWNER = "owner",
@@ -478,7 +481,8 @@ declare enum NonRevenueItemType {
 declare enum ProductType {
     SIMPLE = "simple",
     VARIABLE = "variable",
-    BOOKING = "booking"
+    BOOKING = "booking",
+    COMPOSITE = "composite"
 }
 declare enum ProductStatus {
     ACTIVE = "active",
@@ -525,6 +529,7 @@ interface RefundLineItem {
     discount?: RefundDiscount;
     fee?: OrderLineItemFee;
     modifiers?: OrderLineItemModifier[];
+    components?: OrderLineItemComponent[];
     lineNetWithFees?: number;
     quantity?: number;
     stockQuantity?: number;
@@ -648,6 +653,8 @@ interface OrderReservation {
     startAt: string;
     endAt: string;
     bufferEndAt: string;
+    lineItemInternalId?: string;
+    componentIndex?: number;
     override?: boolean;
     overriddenBy?: string | null;
 }
@@ -860,10 +867,6 @@ interface Order extends BaseEntity {
     cartFees?: OrderCartFee[];
     paymentMethods: OrderPaymentMethod[];
     posData?: OrderPosData;
-    assignedUser?: OrderAssignedUser | null;
-    orderType?: string | null;
-    inCart?: OrderInCart;
-    customStatus?: OrderCustomStatus | null;
     metadata?: Metadata[];
     notes: OrderNote$1[];
     billing?: Address$1;
@@ -1451,6 +1454,7 @@ interface LineItem {
     discount: DiscountLineItem;
     fee: FeeLineItem;
     modifiers?: OrderLineItemModifier[];
+    components?: OrderLineItemComponent[];
     totalTax: number;
     total: number;
     lineNetWithFees: number;
@@ -1563,6 +1567,7 @@ interface RefundedLineItem {
     images?: string[];
     fee: FeeLineItem;
     modifiers?: OrderLineItemModifier[];
+    components?: OrderLineItemComponent[];
 }
 interface RefundItem {
     lineItems: RefundedLineItem[];
@@ -1657,6 +1662,145 @@ interface CartLineModifier {
     unitPrice: number;
     quantity: number;
     taxTableId?: string;
+    componentIndex?: number;
+}
+
+interface MeasurementUnit {
+    unitId: string;
+    companyId: string | null;
+    familyId: string;
+    name: string;
+    abbreviation: string;
+    ratioToBase: number;
+    precision: number;
+    systemKey?: string;
+    sellable?: false;
+}
+
+interface Inventory {
+    warehouse: string;
+    outletId: string;
+    stock?: number | null;
+}
+interface ProductVariant {
+    sku: string;
+    price: number;
+    salePrice: number;
+    isOnSale: boolean;
+    barcode?: string;
+    costPrice?: number;
+    manageStock: boolean;
+    externalId: string;
+    inventory?: Inventory[];
+    allowBackorder?: boolean;
+    images?: string[];
+    attributes: {
+        name: string;
+        value?: string;
+    }[];
+    metadata?: {
+        key: string;
+        value: string;
+    }[];
+    _id: string;
+    isDeleted?: boolean;
+    currency?: CurrencyCode;
+    minorUnits?: number;
+    unitId?: string;
+    unit?: MeasurementUnit;
+    stockVariantId?: string;
+}
+interface FullProduct {
+    _id: string;
+    companyId?: string;
+    externalId: string;
+    taxTable: string;
+    name: string;
+    description?: string;
+    shortDescription?: string;
+    images?: string[];
+    categories: {
+        name: string;
+        externalId: string;
+    }[];
+    attributes: {
+        name: string;
+        values: string[];
+    }[];
+    tags?: string[];
+    supplier?: string;
+    sku?: string;
+    productType: ProductType;
+    bookingRulesId?: string;
+    composite?: Composite | null;
+    variants: ProductVariant[];
+    defaultVariantId?: string;
+    modifiers?: ResolvedModifier[];
+    minPrice?: number;
+    maxPrice?: number;
+    price?: number;
+    status?: string;
+    isDeleted?: boolean;
+    currency?: CurrencyCode;
+    minorUnits?: number;
+    createdAt?: string;
+    updatedAt?: string;
+}
+type ActiveFullProduct = FullProduct;
+
+type CompositeItemUnavailable = 'deleted' | 'inactive' | 'hidden' | 'empty' | 'out_of_stock' | 'by_date' | 'fully_booked' | 'marked_sold_out';
+interface CompositeChoice {
+    productId: string;
+    variantId: string;
+    name: string;
+    attributes: ProductVariant['attributes'];
+    modifiers?: ResolvedModifier[];
+    stockLeft?: number;
+    unit?: MeasurementUnit;
+}
+interface CompositeItem {
+    _id: string;
+    variantId: string | null;
+    categoryId: string | null;
+    name: string;
+    extraCharge: number;
+    quantity: number;
+    cost: number;
+    unavailable: CompositeItemUnavailable | null;
+    choices: CompositeChoice[];
+}
+interface CompositePart {
+    _id: string;
+    name: string | null;
+    required: boolean;
+    min: number;
+    max: number;
+    items: CompositeItem[];
+    defaultPick: Pick<CompositePick, 'itemId' | 'variantId'> | null;
+}
+interface Composite {
+    available: boolean;
+    basePrice: number | null;
+    fromPrice: number | null;
+    parts: CompositePart[];
+}
+interface CompositePick {
+    itemId: string;
+    variantId: string;
+    quantity?: number;
+    modifiers?: ModifierSelection[];
+}
+interface CartLineComponent {
+    partName?: string;
+    productId: string;
+    variantId: string;
+    name: string;
+    attributes?: ProductVariant['attributes'];
+    quantity: number;
+    unitPrice: number;
+    taxTableId?: string;
+    unit?: MeasurementUnit;
+    stockVariantId?: string;
 }
 
 interface Discount {
@@ -1673,18 +1817,6 @@ interface CustomFee {
     taxRateId?: string;
 }
 
-interface MeasurementUnit {
-    unitId: string;
-    companyId: string | null;
-    familyId: string;
-    name: string;
-    abbreviation: string;
-    ratioToBase: number;
-    precision: number;
-    systemKey?: string;
-    sellable?: false;
-}
-
 interface ActiveProduct {
     id: string;
     internalId: string;
@@ -1708,6 +1840,7 @@ interface ActiveProduct {
     fees?: CustomFee[];
     modifierSelections?: ModifierSelection[];
     modifiers?: CartLineModifier[];
+    components?: CartLineComponent[];
     currency?: CurrencyCode;
     minorUnits?: number;
     isUnlimited?: boolean;
@@ -1784,76 +1917,6 @@ interface ActiveCompany {
     settings?: unknown;
 }
 
-interface Inventory {
-    warehouse: string;
-    outletId: string;
-    stock?: number | null;
-}
-interface ProductVariant {
-    sku: string;
-    price: number;
-    salePrice: number;
-    isOnSale: boolean;
-    barcode?: string;
-    costPrice?: number;
-    manageStock: boolean;
-    externalId: string;
-    inventory?: Inventory[];
-    allowBackorder?: boolean;
-    images?: string[];
-    attributes: {
-        name: string;
-        value?: string;
-    }[];
-    metadata?: {
-        key: string;
-        value: string;
-    }[];
-    _id: string;
-    isDeleted?: boolean;
-    currency?: CurrencyCode;
-    minorUnits?: number;
-    unitId?: string;
-    unit?: MeasurementUnit;
-    stockVariantId?: string;
-}
-interface FullProduct {
-    _id: string;
-    companyId?: string;
-    externalId: string;
-    taxTable: string;
-    name: string;
-    description?: string;
-    shortDescription?: string;
-    images?: string[];
-    categories: {
-        name: string;
-        externalId: string;
-    }[];
-    attributes: {
-        name: string;
-        values: string[];
-    }[];
-    tags?: string[];
-    supplier?: string;
-    sku?: string;
-    productType: ProductType;
-    bookingRulesId?: string;
-    variants: ProductVariant[];
-    defaultVariantId?: string;
-    modifiers?: ResolvedModifier[];
-    minPrice?: number;
-    maxPrice?: number;
-    price?: number;
-    status?: string;
-    isDeleted?: boolean;
-    currency?: CurrencyCode;
-    minorUnits?: number;
-    createdAt?: string;
-    updatedAt?: string;
-}
-type ActiveFullProduct = FullProduct;
-
 interface BookingSlotResource {
     resourceId: string;
     name: string;
@@ -1943,8 +2006,7 @@ declare enum ProcessorType {
     VENDARA = "Vendara",
     REDEEM = "Redeem",
     INTEGRATION = "Integration",
-    PAYMENT_LINK = "PaymentLink",
-    EXTERNAL = "External"
+    PAYMENT_LINK = "PaymentLink"
 }
 
 interface PrinterDetails {
@@ -2078,6 +2140,7 @@ interface ProdModifierBreakdown {
     tax: number;
     taxTableId?: string;
     taxes?: OrderTax[];
+    componentIndex?: number;
 }
 interface ProductTaxDetails {
     tax: number;
@@ -2331,11 +2394,7 @@ interface ReaderAvailability {
     bluetooth: boolean;
     unreferencedRefund?: boolean;
 }
-type CashDrawerPolicy = 'everySale' | 'never';
-interface PrinterSettings {
-    cashDrawer: CashDrawerPolicy;
-}
-type ServiceChannelMessageType = 'POSBRAIN_READY' | 'HOST_HELLO' | 'SERVICE_INIT' | 'BOOTSTRAP' | 'TOKEN_REFRESH' | 'SELECTION' | 'HOST_SHUTDOWN' | 'READER_CAPABILITIES' | 'PRINTER_SETTINGS' | 'RUNTIME_READY' | 'HOST_NAVIGATE' | 'SYNC_PROGRESS' | 'DEVICE_OP_REQUEST' | 'DEVICE_OP_RESPONSE' | 'PUBSUB_TOPICS_REQUEST' | 'PUBSUB_TOPICS_LIST' | 'PUBSUB_SUBSCRIBE' | 'PUBSUB_UNSUBSCRIBE' | 'PUBSUB_EVENT';
+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';
 }
@@ -2356,7 +2415,6 @@ interface BootstrapMessage {
         apiUrl?: string;
     };
     paymentProvider?: PaymentProcessor;
-    printerSettings?: PrinterSettings | null;
 }
 interface TokenRefreshMessage {
     type: 'TOKEN_REFRESH';
@@ -2373,10 +2431,6 @@ interface ReaderCapabilitiesMessage {
     type: 'READER_CAPABILITIES';
     readerCapabilities: ReaderCapabilities;
 }
-interface PrinterSettingsMessage {
-    type: 'PRINTER_SETTINGS';
-    printerSettings: PrinterSettings;
-}
 interface RuntimeReadyMessage {
     type: 'RUNTIME_READY';
 }
@@ -2439,6 +2493,6 @@ interface PubsubEventMessage {
     type: 'PUBSUB_EVENT';
     event: TopicEventWire;
 }
-type ServiceChannelMessage = PosBrainReadyMessage | HostHelloMessage | ServiceInitMessage | BootstrapMessage | TokenRefreshMessage | SelectionMessage | HostShutdownMessage | ReaderCapabilitiesMessage | PrinterSettingsMessage | RuntimeReadyMessage | HostNavigateMessage | SyncProgressMessage | DeviceOpRequestMessage | DeviceOpResponseMessage | PubsubTopicsRequestMessage | PubsubTopicsListMessage | PubsubSubscribeMessage | 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 CartLineModifier, type CartReservation, type CashDrawerPolicy, 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 OrderAssignedUser, type OrderCartDiscount, type OrderCartFee, type OrderCustomSale, type OrderCustomSaleDiscount, type OrderCustomSaleFee, type OrderCustomStatus, type OrderInCart, type OrderLineItem, 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 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 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 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 OrderCartDiscount, type OrderCartFee, type OrderCustomSale, type OrderCustomSaleDiscount, type OrderCustomSaleFee, 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, 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 };