@final-commerce/common 1.1.4-beta.4

package/dist/index.d.mts

@@ -0,0 +1,468 @@
+import { C as CurrencyCode, P as PricingRegionEnum, a as PaymentStateDefinition, F as FulfillmentStateDefinition, b as FinancialInvariant, S as StatePair, c as CrossAxisRule, d as StoredStateConfig, D as DisplayStateRule, e as StateConfig, f as ConfigValidationResult, g as DisplayStateResult, h as Condition, O as OrderContext, i as FailedCondition, T as TransitionConditionSet, j as OrderLikeForContext, k as SplitPayment, l as TransitionRequest, m as TransitionResult, A as AvailableTransition, n as OrderStateWritable, o as PaymentState, p as FulfillmentState, q as OrderLikeForLegacyInference, r as StateConfigFragment, s as FragmentParam, t as ConfigValidationError, u as TransitionBlockedBy } from './interfaces-6GnQyqYd.mjs';
+export { v as AttributeType, w as CONDITION_OPERATORS, x as CompanyType, y as ConditionGroup, z as ConditionOperator, B as ConfigValidationWarning, E as CrossAxisRequires, G as CrossAxisTrigger, H as CustomTableAvailability, I as CustomerPlatform, J as ExtensionCategory, K as FULFILLMENT_STATES, L as FeesCustomBillingStatus, M as FulfillmentTransitionPath, N as InventoryBaseActionEnum, Q as InventoryBaseActionType, R as InventorySpecificActionType, U as InvoiceStatus, V as LibraryItemType, W as MenuProject, X as NonRevenueItemType, Y as OrderLineItem, Z as OrderPaymentMethod, _ as OrderPlatform, $ as OrderRefund, a0 as OwnerType, a1 as PATH_MODES, a2 as PAYMENT_STATES, a3 as PathMode, a4 as PaymentMethod, a5 as PaymentTransitionPath, a6 as Platform, a7 as PreviewImageMode, a8 as PricingLevel, a9 as PricingPlanEnum, aa as ProductStatus, ab as ProductType, ac as PublicationAvailability, ad as PublicationConfig, ae as PublicationStatus, af as ReceiptSendChannel, ag as ReceiptType, ah as ResidualPaymentMethod, ai as ResidualStatus, aj as SplitPaymentPayment, ak as StateDefinition, al as StationStatus, am as StripeStatus, an as TimePeriod, ao as TopMetericsSort, ap as TransitionPath, aq as UserTypes, ar as isConditionOperator, as as isFulfillmentState, at as isPaymentState } from './interfaces-6GnQyqYd.mjs';
+
+declare enum StripeCurrencyCode {
+    USD = "USD",
+    EUR = "EUR",
+    GBP = "GBP",
+    CAD = "CAD",
+    AUD = "AUD",
+    NZD = "NZD",
+    CHF = "CHF",
+    CNY = "CNY",
+    INR = "INR",
+    MXN = "MXN",
+    BRL = "BRL",
+    ZAR = "ZAR",
+    SGD = "SGD",
+    HKD = "HKD",
+    SEK = "SEK",
+    NOK = "NOK",
+    DKK = "DKK",
+    PLN = "PLN",
+    THB = "THB",
+    MYR = "MYR",
+    PHP = "PHP",
+    IDR = "IDR",
+    AED = "AED",
+    SAR = "SAR",
+    ILS = "ILS",
+    TRY = "TRY",
+    RUB = "RUB",
+    JPY = "JPY",
+    KRW = "KRW",
+    VND = "VND",
+    CLP = "CLP",
+    ISK = "ISK",
+    HUF = "HUF",
+    TWD = "TWD",
+    KWD = "KWD",
+    BHD = "BHD",
+    OMR = "OMR",
+    JOD = "JOD",
+    TND = "TND",
+    LYD = "LYD",
+    IQD = "IQD"
+}
+
+interface CurrencyConfig {
+    minorUnits: number;
+    symbol: string;
+    symbolPosition: 'prefix' | 'suffix';
+}
+
+interface Amount {
+    amount: number;
+    currency: CurrencyCode;
+    minorUnits: number;
+}
+
+interface ProductFeeBucket {
+    grossProductFees: number;
+    refundedProductFees: number;
+    netProductFees: number;
+}
+interface CartFeeBucket {
+    grossCartFees: number;
+    refundedCartFees: number;
+    netCartFees: number;
+}
+interface FeesBreakdown {
+    productFee: ProductFeeBucket;
+    cartFee: CartFeeBucket;
+    grossTotal: number;
+    refundTotal: number;
+    netTotal: number;
+    taxableFees?: number;
+    nonTaxableFees?: number;
+    refundedTaxableFees?: number;
+    refundedNonTaxableFees?: number;
+}
+interface ProductDiscountBucket {
+    grossProductDiscounts: number;
+    refundedProductDiscounts: number;
+    netProductDiscounts: number;
+}
+interface CartDiscountBucket {
+    grossCartDiscounts: number;
+    refundedCartDiscounts: number;
+    netCartDiscounts: number;
+}
+interface DiscountsBreakdown {
+    productDiscounts: ProductDiscountBucket;
+    cartDiscounts: CartDiscountBucket;
+    grossTotal: number;
+    refundTotal: number;
+    netTotal: number;
+}
+interface FeesTuple {
+    grossFees: number;
+    refundedFees: number;
+    netFees: number;
+}
+interface DiscountsTuple {
+    grossDiscounts: number;
+    refundedDiscounts: number;
+    netDiscounts: number;
+}
+interface TaxesTuple {
+    grossTaxes: number;
+    refundedTaxes: number;
+    netTaxes: number;
+}
+interface TipsTuple {
+    grossTips: number;
+    refundedTips: number;
+    netTips: number;
+}
+interface CashRoundingTuple {
+    grossCashRounding: number;
+    refundedCashRounding: number;
+    netCashRounding: number;
+}
+interface SalesSummary {
+    grossSales: number;
+    discounts: DiscountsTuple;
+    refundsItems: number;
+    fees: FeesTuple;
+    taxes?: TaxesTuple;
+    totalSales: number;
+    tips: TipsTuple;
+    netLiabilityMovement: number;
+    cashRounding: CashRoundingTuple;
+    totalCollected: number;
+    netSales: number;
+    totalTaxableSales?: number;
+    totalNonTaxableSales?: number;
+}
+interface TaxBreakdownRateEntry {
+    taxRateId: string;
+    name: string;
+    taxTableId?: string;
+    taxTableName?: string;
+    percentage: number;
+    taxableSales: number;
+    tax: number;
+}
+interface TaxBreakdownSubtotal {
+    taxableSales: number;
+    tax: number;
+}
+interface TaxBreakdownSection {
+    entries: TaxBreakdownRateEntry[];
+    total: TaxBreakdownSubtotal;
+}
+interface TaxBreakdown {
+    sales: TaxBreakdownSection;
+    refunds: TaxBreakdownSection;
+    nets: TaxBreakdownSection;
+}
+interface SettlementCardSection {
+    collected: number;
+    refunded: number;
+    net: number;
+    processingFees: number;
+    bankDeposit: number;
+}
+interface SettlementCashSection {
+    collected: number;
+    refunded: number;
+    netCash: number;
+}
+interface SettlementCustomEntry {
+    processor: string;
+    collected: number;
+    refunded: number;
+    customNet: number;
+    processingFees: number;
+    customDeposit: number;
+}
+interface SettlementBreakdown {
+    cards: SettlementCardSection;
+    cash: SettlementCashSection;
+    custom: SettlementCustomEntry[];
+    netToMerchant: number;
+}
+interface RefundsBreakdown {
+    itemsRefunded: number;
+    feesReversed: number;
+    discountsReversed: number;
+    taxRefunded: number;
+    totalRefunded: number;
+    tipsRefunded: number;
+    cashRoundingRefund: number;
+    totalPaidBack: number;
+    totalTaxableRefunded?: number;
+    totalNonTaxableRefunded?: number;
+}
+interface StaffSalesEntry {
+    name: string;
+    orderQty: number;
+    refundQty: number;
+    grossSales: number;
+    refundSales: number;
+    netSales: number;
+}
+interface StaffSales {
+    staffSales: StaffSalesEntry[];
+    grossTotal: number;
+    refundTotal: number;
+    netTotal: number;
+}
+interface TipEntry {
+    tipTo: string;
+    name: string;
+    grossAmount: number;
+    refundAmount: number;
+    netAmount: number;
+}
+interface TipsBreakdown {
+    tips: TipEntry[];
+    grossTotal: number;
+    refundTotal: number;
+    netTotal: number;
+}
+interface CashDrawer {
+    openingCashAmount: number;
+    cashPayments: number;
+    cashRefunds: number;
+    manualCashAddition: number;
+    manualCashRemoval: number;
+    countedCashOverUnder: number;
+    closingCashAmount: number;
+}
+interface EndOfSessionReport {
+    isTaxInclusive: boolean;
+    salesSummary: SalesSummary;
+    taxBreakdown: TaxBreakdown;
+    settlementBreakdown: SettlementBreakdown;
+    refundsBreakdown: RefundsBreakdown;
+    cashDrawer?: CashDrawer;
+    staffSales: StaffSales;
+    discountsBreakdown: DiscountsBreakdown;
+    feesBreakdown: FeesBreakdown;
+    tipsBreakdown?: TipsBreakdown;
+    sessionNumber?: string;
+    stationName?: string;
+    outletName?: string;
+    currency?: string;
+    minorUnits?: number;
+}
+
+declare const CURRENCY_CONFIG: Record<CurrencyCode | string, CurrencyConfig>;
+declare function getCurrencyConfig(currency: CurrencyCode): CurrencyConfig;
+declare function getMinorUnitMultiplier(currency: CurrencyCode): number;
+declare function toMinorUnits(amount: number, currency: CurrencyCode): number;
+declare function fromMinorUnits(minorAmount: number, currency: CurrencyCode): number;
+declare function formatCurrency(minorAmount: number, currency: CurrencyCode, options?: {
+    includeSymbol?: boolean;
+    useGrouping?: boolean;
+}): string;
+declare function addAmounts(a: number, b: number): number;
+declare function subtractAmounts(a: number, b: number): number;
+declare function multiplyAmount(amount: number, multiplier: number): number;
+declare function divideAmount(amount: number, divisor: number): number;
+declare function calculatePercentage(amount: number, percentage: number): number;
+declare function parseAmountToMinorUnits(amountString: string, currency: CurrencyCode): number | null;
+declare function isSupportedCurrency(currency: CurrencyCode): boolean;
+declare function parseCurrencyCode(value: string): CurrencyCode;
+declare function parseStripeCurrencyCode(value: string): StripeCurrencyCode;
+declare function stringifyMinorUnits(minorAmount: number, minorUnits: number): number;
+declare function formatMinorUnitsToString(minorAmount: number, minorUnits: number): string;
+declare function getMinorUnits(currency: CurrencyCode): number;
+declare function createAmount(value: string | number | null | undefined, currency: CurrencyCode): Amount | undefined;
+declare function amountToString(amount: Amount | undefined | null): string;
+
+declare function getPricingRegionFromCountry(countryCode?: string): PricingRegionEnum;
+declare const NORTH_AMERICA: Set<string>;
+declare const EUROPE: Set<string>;
+declare function convertFixedFeeToLocalCurrency(currency: string, region: PricingRegionEnum): number;
+declare function getCountriesByRegion(region: PricingRegionEnum): Set<string>;
+
+declare const REPORT_NEGATE_PATHS: ReadonlySet<string>;
+declare function signReportForDisplay(report: EndOfSessionReport): EndOfSessionReport;
+
+declare function generateMongoID(): string;
+declare function getCurrentISODate(): string;
+declare function normalizeMongoIdString(value: unknown): string | null;
+
+interface StateSchema {
+    readonly paymentStates: readonly PaymentStateDefinition[];
+    readonly fulfillmentStates: readonly FulfillmentStateDefinition[];
+}
+declare function basePaymentDefinitions(): PaymentStateDefinition[];
+declare function baseFulfillmentDefinitions(): FulfillmentStateDefinition[];
+declare const STATE_SCHEMA: Readonly<StateSchema>;
+
+declare const FINANCIAL_INVARIANTS: readonly FinancialInvariant[];
+declare function getFinancialInvariantViolations(from: StatePair | null, to: StatePair): string[];
+declare function violatesFinancialInvariant(from: StatePair | null, to: StatePair): boolean;
+
+declare const DEFAULT_CROSS_AXIS_RULES: readonly CrossAxisRule[];
+
+declare const DEFAULT_DISPLAY_STATE_MAP: readonly DisplayStateRule[];
+declare const DEFAULT_CONFIG: StoredStateConfig;
+declare function buildResolvedConfig(config: StoredStateConfig): StateConfig;
+declare const DEFAULT_RESOLVED_CONFIG: StateConfig;
+
+declare const POS_CROSS_AXIS_RULES: readonly CrossAxisRule[];
+declare const POS_VALID_INITIAL_STATES: readonly StatePair[];
+declare function buildPosPresetConfig(companyId?: string): StoredStateConfig;
+
+declare function validateConfig(config: StateConfig): ConfigValidationResult;
+
+declare function deriveDisplayState(payment: string, fulfillment: string, config: StoredStateConfig): DisplayStateResult;
+declare function displayRuleMatchesPair(rule: DisplayStateRule, payment: string, fulfillment: string): boolean;
+
+declare function evaluateCondition(condition: Condition, context: OrderContext): {
+    ok: boolean;
+    failed?: FailedCondition;
+};
+declare function evaluateConditionSet(set: TransitionConditionSet | undefined, context: OrderContext): {
+    ok: boolean;
+    failedConditions: FailedCondition[];
+};
+declare function conditionSummary(c: Condition): string;
+
+declare function buildOrderContext(order: OrderLikeForContext | null | undefined, extras?: {
+    splitPayment?: SplitPayment;
+}): OrderContext;
+
+declare function crossAxisRuleApplies(rule: CrossAxisRule, from: StatePair | null, to: StatePair): boolean;
+declare function canTransition(request: TransitionRequest): TransitionResult;
+declare function getAvailableTransitions(current: StatePair, config: StateConfig, context: OrderContext): AvailableTransition[];
+
+declare function mapToLegacyStatus(pair: StatePair): string;
+declare function setOrderState(order: OrderStateWritable, paymentState: PaymentState, fulfillmentState: FulfillmentState, config: StoredStateConfig, options?: {
+    includeLegacyStatus?: boolean;
+}): void;
+
+declare function inferStatesFromLegacyStatus(order: OrderLikeForLegacyInference): StatePair;
+
+interface ResolveTemplateResult {
+    fragment: StateConfigFragment;
+    resolvedValues: Record<string, unknown>;
+}
+declare function resolveTemplate(templateJson: string, params: FragmentParam[], values?: Record<string, unknown>): ResolveTemplateResult;
+
+interface FragmentValidationResult {
+    valid: boolean;
+    errors: ConfigValidationError[];
+}
+declare function validateFragmentCompatibility(config: StoredStateConfig, fragment: StateConfigFragment): FragmentValidationResult;
+
+declare function mergeFragment(config: StoredStateConfig, fragment: StateConfigFragment, extensionId: string): StoredStateConfig;
+
+declare function removeFragment(config: StoredStateConfig, extensionId: string): StoredStateConfig;
+
+declare const ORDER_STATE_ACTIONS: {
+    readonly getOrderStateConfig: "getOrderStateConfig";
+    readonly getAvailableTransitions: "getAvailableTransitions";
+    readonly getOrderDisplayState: "getOrderDisplayState";
+    readonly transitionOrderState: "transitionOrderState";
+    readonly getStateConfigFragment: "getStateConfigFragment";
+    readonly saveStateConfigFragment: "saveStateConfigFragment";
+    readonly deleteStateConfigFragment: "deleteStateConfigFragment";
+};
+interface GetOrderStateConfigParams {
+}
+interface GetOrderStateConfigResponse {
+    config: StateConfig;
+}
+interface GetAvailableTransitionsParams {
+    orderId?: string;
+    currentState?: StatePair;
+    skipConditionEvaluation?: boolean;
+}
+interface GetAvailableTransitionsResponse {
+    transitions: AvailableTransition[];
+}
+interface GetOrderDisplayStateParams {
+    orderId?: string;
+    statePair?: StatePair;
+}
+interface GetOrderDisplayStateResponse {
+    display: DisplayStateResult;
+}
+interface TransitionOrderStateParams {
+    orderId: string;
+    to: StatePair;
+}
+interface TransitionOrderStateResponse {
+    success: boolean;
+    order: Record<string, unknown>;
+    result: TransitionResult;
+}
+interface GetStateConfigFragmentParams {
+    extensionId: string;
+}
+interface GetStateConfigFragmentResponse {
+    fragment: StateConfigFragment | null;
+}
+interface SaveStateConfigFragmentParams {
+    extensionId: string;
+    fragment: StateConfigFragment;
+}
+interface SaveStateConfigFragmentResponse {
+    success: boolean;
+    validation?: {
+        valid: boolean;
+        errors: {
+            code: string;
+            message: string;
+            path?: string;
+        }[];
+        warnings: {
+            code: string;
+            message: string;
+            path?: string;
+        }[];
+    };
+}
+interface DeleteStateConfigFragmentParams {
+    extensionId: string;
+}
+interface DeleteStateConfigFragmentResponse {
+    success: boolean;
+}
+
+declare const ORDER_STATE_TOPIC: "order-state";
+declare const ORDER_STATE_EVENTS: {
+    readonly stateTransitionCompleted: "state-transition-completed";
+    readonly stateTransitionBlocked: "state-transition-blocked";
+    readonly configUpdated: "config-updated";
+};
+interface StateTransitionCompletedPayload {
+    orderId: string;
+    from: StatePair;
+    to: StatePair;
+    display: DisplayStateResult;
+    timestamp: string;
+}
+interface StateTransitionBlockedPayload {
+    orderId: string;
+    from: StatePair;
+    attemptedTo: StatePair;
+    blockedBy: TransitionBlockedBy[];
+    timestamp: string;
+}
+interface ConfigUpdatedPayload {
+    companyId: string;
+    configId: string;
+    version: number;
+    timestamp: string;
+}
+type OrderStateEventPayload = StateTransitionCompletedPayload | StateTransitionBlockedPayload | ConfigUpdatedPayload;
+
+interface CurrencyRate {
+    rate: number;
+    country: string;
+}
+declare const REGION_MAPPING: Record<string, PricingRegionEnum>;
+declare const STRIPE_SUPPORTED_COUNTRIES: Set<string>;
+declare const NAFixedRates: Record<string, CurrencyRate>;
+declare const EUFixedRates: Record<string, CurrencyRate>;
+declare const OtherFixedRates: Record<string, CurrencyRate>;
+declare const COUNTRY_CURRENCIES: Record<string, string>;
+
+export { type Amount, AvailableTransition, COUNTRY_CURRENCIES, CURRENCY_CONFIG, type CartDiscountBucket, type CartFeeBucket, type CashDrawer, type CashRoundingTuple, Condition, type ConfigUpdatedPayload, ConfigValidationError, ConfigValidationResult, CrossAxisRule, CurrencyCode, type CurrencyConfig, type CurrencyRate, DEFAULT_CONFIG, DEFAULT_CROSS_AXIS_RULES, DEFAULT_DISPLAY_STATE_MAP, DEFAULT_RESOLVED_CONFIG, type DeleteStateConfigFragmentParams, type DeleteStateConfigFragmentResponse, type DiscountsBreakdown, type DiscountsTuple, DisplayStateResult, DisplayStateRule, EUFixedRates, EUROPE, type EndOfSessionReport, FINANCIAL_INVARIANTS, FailedCondition, type FeesBreakdown, type FeesTuple, FinancialInvariant, FragmentParam, type FragmentValidationResult, FulfillmentState, FulfillmentStateDefinition, type GetAvailableTransitionsParams, type GetAvailableTransitionsResponse, type GetOrderDisplayStateParams, type GetOrderDisplayStateResponse, type GetOrderStateConfigParams, type GetOrderStateConfigResponse, type GetStateConfigFragmentParams, type GetStateConfigFragmentResponse, NAFixedRates, NORTH_AMERICA, ORDER_STATE_ACTIONS, ORDER_STATE_EVENTS, ORDER_STATE_TOPIC, OrderContext, OrderLikeForContext, OrderLikeForLegacyInference, type OrderStateEventPayload, OrderStateWritable, OtherFixedRates, POS_CROSS_AXIS_RULES, POS_VALID_INITIAL_STATES, PaymentState, PaymentStateDefinition, PricingRegionEnum, type ProductDiscountBucket, type ProductFeeBucket, REGION_MAPPING, REPORT_NEGATE_PATHS, type RefundsBreakdown, type ResolveTemplateResult, STATE_SCHEMA, STRIPE_SUPPORTED_COUNTRIES, type SalesSummary, type SaveStateConfigFragmentParams, type SaveStateConfigFragmentResponse, type SettlementBreakdown, type SettlementCardSection, type SettlementCashSection, type SettlementCustomEntry, SplitPayment, type StaffSales, type StaffSalesEntry, StateConfig, StateConfigFragment, StatePair, type StateSchema, type StateTransitionBlockedPayload, type StateTransitionCompletedPayload, StoredStateConfig, StripeCurrencyCode, type TaxBreakdown, type TaxBreakdownRateEntry, type TaxBreakdownSection, type TaxBreakdownSubtotal, type TaxesTuple, type TipEntry, type TipsBreakdown, type TipsTuple, TransitionBlockedBy, TransitionConditionSet, type TransitionOrderStateParams, type TransitionOrderStateResponse, TransitionRequest, TransitionResult, addAmounts, amountToString, baseFulfillmentDefinitions, basePaymentDefinitions, buildOrderContext, buildPosPresetConfig, buildResolvedConfig, calculatePercentage, canTransition, conditionSummary, convertFixedFeeToLocalCurrency, createAmount, crossAxisRuleApplies, deriveDisplayState, displayRuleMatchesPair, divideAmount, evaluateCondition, evaluateConditionSet, formatCurrency, formatMinorUnitsToString, fromMinorUnits, generateMongoID, getAvailableTransitions, getCountriesByRegion, getCurrencyConfig, getCurrentISODate, getFinancialInvariantViolations, getMinorUnitMultiplier, getMinorUnits, getPricingRegionFromCountry, inferStatesFromLegacyStatus, isSupportedCurrency, mapToLegacyStatus, mergeFragment, multiplyAmount, normalizeMongoIdString, parseAmountToMinorUnits, parseCurrencyCode, parseStripeCurrencyCode, removeFragment, resolveTemplate, setOrderState, signReportForDisplay, stringifyMinorUnits, subtractAmounts, toMinorUnits, validateConfig, validateFragmentCompatibility, violatesFinancialInvariant };