@tallyui/pos 3.2.1 → 3.4.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ReactNode } from 'react';
-import { Money, TaxRounding, TallyConnector, SyncContext, StoreSettingsChoice, StoreSettings, StoreSettingsChoices, ProductTraits, PaymentMethodKind, CommandServerRefs, CommandWarning, CommandError, ServerCapabilities, OrderCreateEnvelope, RegisterCommandType, RegisterCommandResult, VariantSummary, TraitContext, CommandResult, AnyCommandEnvelope, CommandEnvelope, OrderCreatePayload, RegisterCommandEnvelope } from '@tallyui/core';
+import { Money, TaxRounding, StoreSettings, TallyConnector, SyncContext, StoreSettingsChoice, StoreSettingsChoices, ProductTraits, OrderCreateLine, PaymentMethodKind, CommandServerRefs, CommandWarning, CommandError, ServerCapabilities, OrderCreateEnvelope, RegisterCommandType, RegisterCommandResult, VariantSummary, TraitContext, CommandResult, AnyCommandEnvelope, CommandEnvelope, OrderCreatePayload, RegisterCommandEnvelope } from '@tallyui/core';
 export { getProductStock, withStockOverlay } from '@tallyui/core';
 export { countFresh, readFresh, watchFresh } from '@tallyui/core/rxdb';
 import * as rxdb from 'rxdb';
@@ -97,6 +97,7 @@ interface RateTaxLine {
 }
 type TaxedLine = {
     netMinor: number;
+    netMicros?: string;
     discountMinor?: number;
     taxInclusive: boolean;
     taxLines: readonly {
@@ -117,12 +118,18 @@ type TaxedLine = {
  */
 declare function taxLinesByRate(lines: readonly TaxedLine[], orderTaxMinor: number, taxLabels?: Record<number, string>, rounding?: TaxRounding): RateTaxLine[];
 
+type WooRate = NonNullable<StoreSettings['taxRates']>[string][number];
 /** Tax rates as integer parts per million (19% = 190000). */
 type TaxRateMap = {
     default: number;
     [taxClass: string]: number;
 };
 interface TaxContext {
+    shippingTaxClass?: string;
+    taxClassSlugs?: readonly string[];
+    getTaxRates?(taxClass?: string, options?: {
+        shipping?: boolean;
+    }): readonly WooRate[];
     /** Tax rate for a tax class as integer parts per million (19% = 190000); the default class when omitted or unknown. */
     getTaxRatePpm(taxClass?: string): number;
     /** The backend's name for that class's rate, when mapped: a `per_rate_group_items` store groups by name and value (#287). */
@@ -133,7 +140,8 @@ interface TaxContext {
 }
 
 declare const taxLogger: Logger;
-interface TaxProviderProps {
+interface TaxProviderProps extends Pick<StoreSettings, 'taxRoundAtSubtotal' | 'shippingTaxClass' | 'taxClassSlugs'> {
+    taxRates?: StoreSettings['taxRates'];
     ratesPpm: Record<string, number>;
     pricesIncludeTax: boolean;
     /** `ServerCapabilities.taxRounding` (#287); a change restarts an idle sale under it. */
@@ -142,7 +150,7 @@ interface TaxProviderProps {
     rateCodes?: Record<string, string>;
     children: ReactNode;
 }
-declare function TaxProvider({ ratesPpm, pricesIncludeTax, rounding, rateCodes, children }: TaxProviderProps): react_jsx_runtime.JSX.Element;
+declare function TaxProvider({ ratesPpm, pricesIncludeTax, rounding, rateCodes, taxRates, shippingTaxClass, taxClassSlugs, children }: TaxProviderProps): react_jsx_runtime.JSX.Element;
 declare function useTax(): TaxContext;
 
 type StoreSettingsResolution = {
@@ -307,6 +315,10 @@ interface DisplayLine {
 }
 interface LineItem {
     id: string;
+    taxClass?: string;
+    /** WooCommerce's stored net at rounding precision, in integer micro-minor units, and its rounded gross. */
+    netMicros?: string;
+    totalMinor?: number;
     custom?: true;
     taxStatus?: 'none';
     productId: string;
@@ -328,13 +340,15 @@ interface LineItem {
 }
 interface ChargeLine {
     id: string;
+    netMicros?: string;
+    totalMinor?: number;
     name: string;
     amountMinor: number;
     taxClass?: string;
     taxStatus: 'taxable' | 'none';
     taxLines: LineItem['taxLines'];
     netMinor: number;
-    taxMicros: number;
+    taxMicros: string;
 }
 interface FeeLine extends ChargeLine {
 }
@@ -349,6 +363,8 @@ interface ChargeInput {
 }
 interface LineTaxLine {
     code?: string;
+    rateId?: number;
+    compound?: boolean;
     ratePpm: number;
     taxMicros: string;
 }
@@ -632,6 +648,8 @@ interface PosOrderLine {
     id: string;
     productId: string;
     variantId?: string;
+    custom?: OrderCreateLine['custom'];
+    taxStatus?: 'taxable' | 'none';
     name: string;
     sku: string;
     quantity: number;
@@ -639,6 +657,7 @@ interface PosOrderLine {
     /** Line discounts plus the allocated order-discount share, in the line's own tax mode (ADR-062). */
     discountMinor: number;
     netMinor: number;
+    netMicros?: string;
     taxLines: Array<{
         code?: string;
         ratePpm: number;
@@ -663,6 +682,8 @@ interface PosOrder {
     currency: string;
     pricesIncludeTax: boolean;
     lines: PosOrderLine[];
+    fees?: FeeLine[];
+    shipping?: ShippingLine[];
     subtotalMinor: number;
     discountMinor: number;
     taxMinor: number;
@@ -690,9 +711,9 @@ interface PosOrder {
      * The order.create version every attempt under this `commandId` goes out at: the outbox records it before the first
      * send, and lowers it only on a downgrade (ADR-065 amendment). Absent means not sent yet (or requeued).
      */
-    sentVersion?: 1 | 2 | 3 | 4;
+    sentVersion?: 1 | 2 | 3 | 4 | 5;
     /** The version first tried, before the downgrade (the order's audit). */
-    downgradedFrom?: 1 | 2 | 3 | 4;
+    downgradedFrom?: 1 | 2 | 3 | 4 | 5;
     /** ADR-065: the receipt's display figures, in integer minor units of `currency` at `exponent`. */
     display?: DisplayTotals & {
         currency: string;
@@ -776,6 +797,9 @@ declare function toOrderCreateEnvelope(order: PosOrder, deviceId: string, attemp
  * nothing else. Its migration sets it on every older row. It is one-way like version 5.
  * Version 7 adds `saleId`, the sale order's id (ADR-072; never sent), and changes nothing else. Its migration is the
  * identity: older orders have no `saleId`. It is one-way like version 6.
+ * Version 8 adds fees, shipping, custom lines (ADR-075) and the woocommerce tax rounding (ADR-076), and changes nothing else.
+ * It also stores the WooCommerce 6dp net (`netMicros`) under the woocommerce rounding (ADR-076 amendment).
+ * Its migration is the identity. It is one-way like version 7.
  */
 declare const posOrderSchema: RxJsonSchema<PosOrder>;
 /**
@@ -1935,6 +1959,9 @@ declare function useSale(settings: Pick<StoreSettings, 'currency'>, opts: {
     stage: SaleStage;
     error: string | null;
     idle: boolean;
+    /** The store's capabilities as passed in: a component offers fees, shipping and custom lines
+     * only when `orderCreate >= 5`, and their tax status and class only as `lineTax` allows. */
+    capabilities: ServerCapabilities | undefined;
     /** A completion is pending (see `complete()`): the sale is locked, and the UI offers Retry. */
     saving: boolean;
     /** The failed save's order is confirmed stored (see `isStored`): the UI also offers Continue (`continueSale()`). */
@@ -2053,6 +2080,13 @@ declare class CartError extends Error {
 }
 declare function addEntryToCart<Doc>(builder: OrderBuilder, entry: CatalogueEntry<Doc>, traits: ProductTraits<Doc>, currency: string): string;
 
+/** Local-only context for a transport (ADR-076 amendment 1): never serialised, never part of a payload. */
+interface OrderTransportContext {
+    /** The stored (frozen) order of each envelope in the batch, keyed by the envelope's `id` (its commandId). */
+    local: {
+        orders: ReadonlyMap<string, PosOrder>;
+    };
+}
 type TransportOutcome = {
     kind: 'results';
     results: CommandResult[];
@@ -2071,7 +2105,7 @@ type TransportOutcome = {
     retryAfterMs?: number;
 };
 interface CommandTransport<E extends AnyCommandEnvelope = CommandEnvelope<OrderCreatePayload>> {
-    send(batch: E[]): Promise<TransportOutcome>;
+    send(batch: E[], context?: OrderTransportContext): Promise<TransportOutcome>;
 }
 interface OutboxState {
     pending: number;
@@ -2415,4 +2449,4 @@ declare function planLegs(plan: TenderPlan, rowsSinceFrom: {
     };
 };
 
-export { type Actor, type AddLineInput, type AppliedDiscount, type BackendNotFound, type BasketLine, CartError, type CashMovement, type CashMovementCollection, type CatalogueEntry, type ChargeInput, type ChargeLine, type Closure, type ClosureCollection, type ClosureContext, type ClosureScope, type CommandTransport, type Correction, CurrencyProvider, type CurrencyProviderProps, type CustomerSummary, DISCOUNTS_UNSUPPORTED, type Discount, type DisplayLine, type DisplayTotals, type FeeLine, type FinalizeOptions, type HttpTransportOptions, type LedgerRow, type LineItem, type LineTaxLine, type LogEntry, type LogLevel, type LogSink, type Logger, MAX_TENDER_MINOR, MICROS_PER_MINOR, type Movement$1 as Movement, type MovementType, type Order, type OrderBuilder, type OrderBuilderOptions, OrderContentMismatchError, type OrderManager, type OrderManagerOptions, type OrderOutbox, type OrderOutboxOptions, type OrderTaxTotals, type OutboxState, type ParkedOrderSummary, type Payment, type PaymentMethod, type PaymentTransport, type PlanLeg, type PosOrder, type PosOrderLine, type PosOrderLocalWarning, PosOrderOpenClosedError, type PosOrderPayment, type PosOrderServerFailures, type PosOrderSyncStatus, type RateTaxLine, type ReceiptConfig, type ReceiptData, type ReceiptLineItem, type RecordedFigures, RegisterApprovalRequiredError, type RegisterBucket, RegisterCloseIncompleteError, type RegisterCommand, type RegisterCommandCollection, type RegisterCounters, type RegisterDocument, type RegisterFact, type RegisterHost, RegisterIdInvalidError, RegisterMovementAmountError, RegisterMovementReasonError, RegisterMovementStrandedError, type RegisterOutbox, type RegisterOutboxOptions, type RegisterSession, RegisterSessionAlreadyOpenError, RegisterSessionClosedError, type RegisterSessionCollection, RegisterSessionRequiredError, type RegisterStore, RegisterTenderInProgressError, type Repository, type ResolveStoreSettingsOptions, SALE_SAVING, type SaleStage, type SentOrder, type ShippingLine, type SplitTab, type StoreSettingsResolution, type StoreSettingsState, TAX_ROUNDING_MIXED_NOTE, type TaxContext, type TaxLineInput, TaxProvider, type TaxProviderProps, type TaxRateMap, type TenderAction, type TenderKey, type TenderLineId, type TenderPlan, type TenderState, type TenderView, type TransportOutcome, UnsupportedOrderVersionError, type UseOrderOutboxOptions, type UseOrderOutboxResult, type UseRegisterOutboxOptions, type UseRegisterOutboxResult, type UseRegisterSessionOptions, activePlan, addEntryToCart, addPosOrderCollection, advancePerpetual, allocateOrderDiscount, appliedMinor, backToSelling, bindRegister, buildClosureDocument, buildReceiptData, buildXReportDocument, callbackSink, cashMovementSchema, catalogueEntries, changeMinor, clampClosureScope, closeNeedsApproval, closeSession, closureCommand, closureSchema, computeOrderTax, consoleSink, countVariance, createBackendNotFound, createHttpCommandTransport, createLogger, createOrderBuilder, createOrderManager, createOrderOutbox, createRegisterOutbox, createRepository, denominationTotal, denominations, deriveExpected, deriveSettled, ensureRegister, evenSplitShareMinor, exportCsv, finalizeOrder, findEntryByCode, formatClosureDate, getBoundRegisterId, getDeviceId, initTenderState, initialTenderState, isServerDecimal, labelKeys, minorToDecimal, mintClosureNumber, mintUuid, movementCommand, movementFieldError, needsAttention, nextSaleCounter, normalizeAmount, observeRegister$, openSession, openSessionSelector, orderDraftSchema, outboxLogger, overThreshold, parkedOrderSummaries$, parseMinor, planLegs, posOrderCollection, posOrderSchema, posOrdersLogger, quickTenderedAmounts, ratePpmFromPercent, readBoundRegister, readRegister, reconcileRegisterCommands, recordMovement, recordRegisterFact, registerCommandCollection, registerCommandSchema, registerCommandsLogger, registerFactsLogger, registerSessionCollection, registerSessionSchema, requireOpenSession, resolveStoreSettings, restoreOrderDraft, roundMicrosToMinor, saleLogger, sameSale, searchProducts, selectClosureRows, sessionOpenCommand, sessionTransitionCommand, stampSession, startCounting, stockOverlay$, stockOverlayAsOf$, taxFiguresForBasket, taxLinesByRate, taxLogger, taxMicros, taxProviderProps, tenderReducer, toOrderCreateEnvelope, unbindRegister, useCurrencyCode, useCurrencyFormatter, useOrderOutbox, useParkedSales, useRegisterOutbox, useRegisterSession, useSale, useStoreSettings, useTax, uuidv7, validAmount, varianceText, variantPriceLabel, voidMovement, withPricingContext, writeClosure, writeOrderDraft };
+export { type Actor, type AddLineInput, type AppliedDiscount, type BackendNotFound, type BasketLine, CartError, type CashMovement, type CashMovementCollection, type CatalogueEntry, type ChargeInput, type ChargeLine, type Closure, type ClosureCollection, type ClosureContext, type ClosureScope, type CommandTransport, type Correction, CurrencyProvider, type CurrencyProviderProps, type CustomerSummary, DISCOUNTS_UNSUPPORTED, type Discount, type DisplayLine, type DisplayTotals, type FeeLine, type FinalizeOptions, type HttpTransportOptions, type LedgerRow, type LineItem, type LineTaxLine, type LogEntry, type LogLevel, type LogSink, type Logger, MAX_TENDER_MINOR, MICROS_PER_MINOR, type Movement$1 as Movement, type MovementType, type Order, type OrderBuilder, type OrderBuilderOptions, OrderContentMismatchError, type OrderManager, type OrderManagerOptions, type OrderOutbox, type OrderOutboxOptions, type OrderTaxTotals, type OrderTransportContext, type OutboxState, type ParkedOrderSummary, type Payment, type PaymentMethod, type PaymentTransport, type PlanLeg, type PosOrder, type PosOrderLine, type PosOrderLocalWarning, PosOrderOpenClosedError, type PosOrderPayment, type PosOrderServerFailures, type PosOrderSyncStatus, type RateTaxLine, type ReceiptConfig, type ReceiptData, type ReceiptLineItem, type RecordedFigures, RegisterApprovalRequiredError, type RegisterBucket, RegisterCloseIncompleteError, type RegisterCommand, type RegisterCommandCollection, type RegisterCounters, type RegisterDocument, type RegisterFact, type RegisterHost, RegisterIdInvalidError, RegisterMovementAmountError, RegisterMovementReasonError, RegisterMovementStrandedError, type RegisterOutbox, type RegisterOutboxOptions, type RegisterSession, RegisterSessionAlreadyOpenError, RegisterSessionClosedError, type RegisterSessionCollection, RegisterSessionRequiredError, type RegisterStore, RegisterTenderInProgressError, type Repository, type ResolveStoreSettingsOptions, SALE_SAVING, type SaleStage, type SentOrder, type ShippingLine, type SplitTab, type StoreSettingsResolution, type StoreSettingsState, TAX_ROUNDING_MIXED_NOTE, type TaxContext, type TaxLineInput, TaxProvider, type TaxProviderProps, type TaxRateMap, type TenderAction, type TenderKey, type TenderLineId, type TenderPlan, type TenderState, type TenderView, type TransportOutcome, UnsupportedOrderVersionError, type UseOrderOutboxOptions, type UseOrderOutboxResult, type UseRegisterOutboxOptions, type UseRegisterOutboxResult, type UseRegisterSessionOptions, activePlan, addEntryToCart, addPosOrderCollection, advancePerpetual, allocateOrderDiscount, appliedMinor, backToSelling, bindRegister, buildClosureDocument, buildReceiptData, buildXReportDocument, callbackSink, cashMovementSchema, catalogueEntries, changeMinor, clampClosureScope, closeNeedsApproval, closeSession, closureCommand, closureSchema, computeOrderTax, consoleSink, countVariance, createBackendNotFound, createHttpCommandTransport, createLogger, createOrderBuilder, createOrderManager, createOrderOutbox, createRegisterOutbox, createRepository, denominationTotal, denominations, deriveExpected, deriveSettled, ensureRegister, evenSplitShareMinor, exportCsv, finalizeOrder, findEntryByCode, formatClosureDate, getBoundRegisterId, getDeviceId, initTenderState, initialTenderState, isServerDecimal, labelKeys, minorToDecimal, mintClosureNumber, mintUuid, movementCommand, movementFieldError, needsAttention, nextSaleCounter, normalizeAmount, observeRegister$, openSession, openSessionSelector, orderDraftSchema, outboxLogger, overThreshold, parkedOrderSummaries$, parseMinor, planLegs, posOrderCollection, posOrderSchema, posOrdersLogger, quickTenderedAmounts, ratePpmFromPercent, readBoundRegister, readRegister, reconcileRegisterCommands, recordMovement, recordRegisterFact, registerCommandCollection, registerCommandSchema, registerCommandsLogger, registerFactsLogger, registerSessionCollection, registerSessionSchema, requireOpenSession, resolveStoreSettings, restoreOrderDraft, roundMicrosToMinor, saleLogger, sameSale, searchProducts, selectClosureRows, sessionOpenCommand, sessionTransitionCommand, stampSession, startCounting, stockOverlay$, stockOverlayAsOf$, taxFiguresForBasket, taxLinesByRate, taxLogger, taxMicros, taxProviderProps, tenderReducer, toOrderCreateEnvelope, unbindRegister, useCurrencyCode, useCurrencyFormatter, useOrderOutbox, useParkedSales, useRegisterOutbox, useRegisterSession, useSale, useStoreSettings, useTax, uuidv7, validAmount, varianceText, variantPriceLabel, voidMovement, withPricingContext, writeClosure, writeOrderDraft };