@final-commerce/common 1.1.4-beta.4 → 1.1.4-beta.5

package/dist/interfaces-6GnQyqYd.d.mts

@@ -1,598 +0,0 @@
-declare enum CurrencyCode {
-    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",
-    HTG = "HTG",
-    BND = "BND",
-    CRC = "CRC",
-    BDT = "BDT",
-    UAH = "UAH",
-    NGN = "NGN",
-    AFN = "AFN",
-    ALL = "ALL",
-    AMD = "AMD",
-    ANG = "ANG",
-    AOA = "AOA",
-    ARS = "ARS",
-    AWG = "AWG",
-    AZN = "AZN",
-    BAM = "BAM",
-    BBD = "BBD",
-    BGN = "BGN",
-    BMD = "BMD",
-    BOB = "BOB",
-    BSD = "BSD",
-    BTN = "BTN",
-    BWP = "BWP",
-    BYN = "BYN",
-    BZD = "BZD",
-    COP = "COP",
-    CZK = "CZK",
-    DOP = "DOP",
-    DZD = "DZD",
-    EGP = "EGP",
-    ETB = "ETB",
-    FJD = "FJD",
-    GEL = "GEL",
-    GHS = "GHS",
-    GTQ = "GTQ",
-    GYD = "GYD",
-    HNL = "HNL",
-    IRR = "IRR",
-    JMD = "JMD",
-    KES = "KES",
-    KGS = "KGS",
-    KHR = "KHR",
-    KYD = "KYD",
-    KZT = "KZT",
-    LAK = "LAK",
-    LBP = "LBP",
-    LKR = "LKR",
-    MAD = "MAD",
-    MDL = "MDL",
-    MKD = "MKD",
-    MMK = "MMK",
-    MNT = "MNT",
-    MOP = "MOP",
-    MUR = "MUR",
-    MVR = "MVR",
-    MZN = "MZN",
-    NAD = "NAD",
-    NIO = "NIO",
-    NPR = "NPR",
-    PAB = "PAB",
-    PEN = "PEN",
-    PGK = "PGK",
-    PKR = "PKR",
-    QAR = "QAR",
-    RON = "RON",
-    RSD = "RSD",
-    SBD = "SBD",
-    SRD = "SRD",
-    SYP = "SYP",
-    TJS = "TJS",
-    TMT = "TMT",
-    TOP = "TOP",
-    TTD = "TTD",
-    TZS = "TZS",
-    UYU = "UYU",
-    UZS = "UZS",
-    VES = "VES",
-    WST = "WST",
-    XCD = "XCD",
-    YER = "YER",
-    ZMW = "ZMW",
-    CDF = "CDF",
-    CUP = "CUP",
-    ERN = "ERN",
-    FKP = "FKP",
-    GIP = "GIP",
-    GMD = "GMD",
-    KPW = "KPW",
-    LRD = "LRD",
-    LSL = "LSL",
-    MGA = "MGA",
-    MWK = "MWK",
-    SCR = "SCR",
-    SDG = "SDG",
-    SHP = "SHP",
-    SLE = "SLE",
-    SOS = "SOS",
-    SSP = "SSP",
-    STN = "STN",
-    SZL = "SZL",
-    VED = "VED",
-    XCG = "XCG",
-    JPY = "JPY",
-    KRW = "KRW",
-    VND = "VND",
-    CLP = "CLP",
-    ISK = "ISK",
-    HUF = "HUF",
-    TWD = "TWD",
-    GNF = "GNF",
-    BIF = "BIF",
-    DJF = "DJF",
-    KMF = "KMF",
-    PYG = "PYG",
-    RWF = "RWF",
-    UGX = "UGX",
-    VUV = "VUV",
-    XAF = "XAF",
-    XOF = "XOF",
-    XPF = "XPF",
-    KWD = "KWD",
-    BHD = "BHD",
-    OMR = "OMR",
-    JOD = "JOD",
-    TND = "TND",
-    LYD = "LYD",
-    IQD = "IQD"
-}
-
-declare enum TimePeriod {
-    TODAY = "today",
-    THIS_WEEK = "this week",
-    THIS_MONTH = "this month",
-    THIS_YEAR = "this year",
-    All_TIME = "all_time"
-}
-declare enum TopMetericsSort {
-    TOTAL_PAYMENT_VOLUME = "totalPaymentVolume",
-    TOTAL_TRANSACTION = "totalTransaction"
-}
-declare enum CompanyType {
-    COMPANY = "company",
-    ROOT = "root",
-    ORGANIZATION = "organization"
-}
-declare enum CustomTableAvailability {
-    PUBLIC = "public",
-    ORGANIZATION = "organization"
-}
-declare enum AttributeType {
-    STRING = "string",
-    NUMBER = "number",
-    BOOLEAN = "boolean",
-    DATE = "date",
-    JSON_STRING = "json-string"
-}
-declare enum Platform {
-    WOO_COMMERCE = "woo-commerce",
-    SHOPIFY = "shopify",
-    OLIVER = "oliver",
-    STANDALONE = "standalone"
-}
-declare enum OrderPlatform {
-    POS = "in-store",
-    WOO_COMMERCE = "woo-commerce"
-}
-declare enum CustomerPlatform {
-    POS = "in-store",
-    WOO_COMMERCE = "woo-commerce"
-}
-declare enum StationStatus {
-    IN_USE = "IN_USE",
-    AVAILABLE = "AVAILABLE"
-}
-declare enum InventoryBaseActionEnum {
-    ADD = "ADD",
-    REMOVE = "REMOVE",
-    RECOUNT = "RECOUNT",
-    SKIP = "SKIP"
-}
-type InventoryBaseActionType = `${InventoryBaseActionEnum}`;
-declare enum InventorySpecificActionType {
-    STOCK_RECEIVED = "STOCK_RECEIVED",
-    INVENTORY_RECOUNT = "INVENTORY_RECOUNT",
-    DAMAGE = "DAMAGE",
-    THEFT = "THEFT",
-    LOSS = "LOSS",
-    RESTOCK_RETURN = "RESTOCK_RETURN",
-    REFUND_RESTOCK_RETURN = "REFUND_RESTOCK_RETURN",
-    REFUND_DAMAGE = "REFUND_DAMAGE",
-    SALE = "SALE",
-    TRANSFER = "TRANSFER",
-    BULK_RECOUNT = "BULK_RECOUNT",
-    APPLIED_FROM_WOO = "APPLIED_FROM_WOO"
-}
-declare enum ExtensionCategory {
-    SYNC = "sync",
-    PAYMENT = "payment",
-    HUB = "hub",
-    BUILDER = "builder"
-}
-declare enum FeesCustomBillingStatus {
-    UNPAID = "unpaid",
-    PAID = "paid",
-    OPEN = "open"
-}
-declare enum PricingPlanEnum {
-    DEFAULT = "default",
-    MINIMUM = "minimum",
-    ORGANIZATION = "organization",
-    PLAN = "plan",
-    COMPANY = "company"
-}
-declare enum PricingLevel {
-    ORG = "org",
-    PLAN = "plan",
-    DEFAULT = "default",
-    MINIMUM = "minimum"
-}
-declare enum PricingRegionEnum {
-    EUROPE = "europe",
-    OTHER = "others",
-    NORTH_AMERICA = "northAmerica"
-}
-declare enum MenuProject {
-    MANAGE = "Manage",
-    SCALE = "Scale",
-    BUILD = "Build",
-    PAY = "Pay",
-    RUN = "Run"
-}
-declare enum UserTypes {
-    COMPANY_OWNER = "owner",
-    ORG_USER = "organization_user",
-    ORG_OWNER = "organization_owner",
-    FINAL_USER = "final_user",
-    FINAL_OWNER = "final_owner",
-    EMPLOYEE = "employee",
-    SUPER_ADMIN = "super_admin",
-    MANAGER = "manager",
-    ADMIN = "admin",
-    ASSISTANT_MANAGER = "assistant",
-    CASHIER = "cashier",
-    RESELLER = "reseller"
-}
-declare enum OwnerType {
-    API_KEY = "api-key",
-    ORGANIZATION = "organization",
-    COMPANY = "company"
-}
-declare enum PublicationAvailability {
-    GLOBAL = "global",
-    PRIVATE = "private"
-}
-declare enum PublicationStatus {
-    APPROVED = "approved",
-    REJECTED = "rejected",
-    PENDING = "pending",
-    NOT_APPLICABLE = "not_applicable"
-}
-interface PublicationConfig {
-    availability: PublicationAvailability;
-    status: PublicationStatus;
-}
-declare enum ResidualStatus {
-    PAID = "paid",
-    DUE = "due",
-    ACCRUING = "accruing"
-}
-declare enum PreviewImageMode {
-    STATIC = "static",
-    DYNAMIC = "dynamic"
-}
-declare enum LibraryItemType {
-    FLOW = "flow",
-    PAGE = "page",
-    COMPOSITION = "composition",
-    LAYOUT = "layout"
-}
-declare enum ResidualPaymentMethod {
-    CHEQUE = "cheque"
-}
-declare enum PaymentMethod {
-    CUSTOM = "Custom",
-    CASH = "Cash",
-    TERMINAL = "Terminal",
-    CLOUD = "Cloud",
-    BLUETOOTH = "Bluetooth"
-}
-declare enum NonRevenueItemType {
-    GIFT_CARD = "gift-card"
-}
-declare enum ReceiptSendChannel {
-    EMAIL = "email",
-    TEXT = "text"
-}
-declare enum ReceiptType {
-    ORDER = "order",
-    REFUND = "refund"
-}
-declare enum StripeStatus {
-    ACTIVE = "active",
-    INACTIVE = "inactive",
-    PAYMENT_METHOD_REQUIRED = "payment_method_required",
-    PAYMENT_METHOD_ADDED = "payment_method_added"
-}
-declare enum InvoiceStatus {
-    PAID = "paid",
-    PENDING = "pending",
-    EXPIRED = "expired"
-}
-
-declare enum ProductType {
-    SIMPLE = "simple",
-    VARIABLE = "variable"
-}
-declare enum ProductStatus {
-    ACTIVE = "active",
-    INACTIVE = "inactive",
-    DRAFT = "draft"
-}
-
-type PaymentState = 'unpaid' | 'payment_pending' | 'partially_paid' | 'paid' | 'partially_refunded' | 'refunded' | 'voided';
-type FulfillmentState = 'draft' | 'pending' | 'on_hold' | 'in_progress' | 'fulfilled' | 'partially_fulfilled' | 'returned' | 'partially_returned' | 'cancelled';
-declare const PAYMENT_STATES: readonly PaymentState[];
-declare const FULFILLMENT_STATES: readonly FulfillmentState[];
-declare function isPaymentState(value: string): value is PaymentState;
-declare function isFulfillmentState(value: string): value is FulfillmentState;
-interface StatePair {
-    payment: PaymentState;
-    fulfillment: FulfillmentState;
-}
-type ConditionOperator = 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'notIn' | 'isEmpty' | 'isNotEmpty';
-declare const CONDITION_OPERATORS: readonly ConditionOperator[];
-declare function isConditionOperator(value: string): value is ConditionOperator;
-type PathMode = 'strict' | 'permissive';
-declare const PATH_MODES: readonly PathMode[];
-
-interface OrderPaymentMethod {
-    id?: string;
-    amount?: number;
-    [key: string]: unknown;
-}
-interface OrderRefund {
-    id?: string;
-    quantity?: number;
-    [key: string]: unknown;
-}
-interface OrderLineItem {
-    id?: string;
-    quantity?: number;
-    fulfilledQuantity?: number;
-    returnedQuantity?: number;
-    [key: string]: unknown;
-}
-interface SplitPaymentPayment {
-    amount?: number;
-    [key: string]: unknown;
-}
-interface SplitPayment {
-    payments: SplitPaymentPayment[];
-    amountRemaining: number;
-}
-interface OrderContext {
-    order: {
-        total: number;
-        balance: number;
-        paymentMethods: OrderPaymentMethod[];
-        refunds: OrderRefund[];
-        lineItems: OrderLineItem[];
-    };
-    computed: {
-        balance: number;
-        isFullyPaid: boolean;
-        hasPartialPayments: boolean;
-        totalPaid: number;
-        totalRefunded: number;
-        itemCount: number;
-        fulfilledItemCount: number;
-        returnedItemCount: number;
-        isFullyReturned: boolean;
-        hasPartialReturns: boolean;
-    };
-    splitPayment?: SplitPayment;
-}
-interface PaymentStateDefinition {
-    id: PaymentState;
-    label: string;
-    isBase: boolean;
-    isTerminal: boolean;
-    color?: string;
-    icon?: string;
-}
-interface FulfillmentStateDefinition {
-    id: FulfillmentState;
-    label: string;
-    isBase: boolean;
-    isTerminal: boolean;
-    color?: string;
-    icon?: string;
-}
-type StateDefinition = PaymentStateDefinition | FulfillmentStateDefinition;
-interface PaymentTransitionPath {
-    from: PaymentState;
-    to: PaymentState;
-    conditionSetId?: string;
-    _sourceExtensionId?: string;
-}
-interface FulfillmentTransitionPath {
-    from: FulfillmentState;
-    to: FulfillmentState;
-    conditionSetId?: string;
-    _sourceExtensionId?: string;
-}
-type TransitionPath = PaymentTransitionPath | FulfillmentTransitionPath;
-interface Condition {
-    field: string;
-    operator: ConditionOperator;
-    value: unknown;
-}
-interface ConditionGroup {
-    conditions: Condition[];
-}
-interface TransitionConditionSet {
-    id: string;
-    label: string;
-    groups: ConditionGroup[];
-    _sourceExtensionId?: string;
-}
-type CrossAxisTrigger = {
-    axis: 'payment';
-    to: PaymentState | PaymentState[];
-} | {
-    axis: 'fulfillment';
-    to: FulfillmentState | FulfillmentState[];
-};
-type CrossAxisRequires = {
-    axis: 'payment';
-    states: PaymentState[];
-} | {
-    axis: 'fulfillment';
-    states: FulfillmentState[];
-};
-interface CrossAxisRule {
-    id: string;
-    label: string;
-    description?: string;
-    enabled: boolean;
-    trigger: CrossAxisTrigger;
-    requires: CrossAxisRequires;
-    _sourceExtensionId?: string;
-}
-interface FinancialInvariant {
-    id: string;
-    description: string;
-    check: (from: StatePair | null, to: StatePair) => boolean;
-}
-interface DisplayStateRule {
-    paymentState?: PaymentState | PaymentState[];
-    fulfillmentState?: FulfillmentState | FulfillmentState[];
-    label: string;
-    color?: string;
-    icon?: string;
-    _sourceExtensionId?: string;
-}
-interface DisplayStateResult {
-    label: string;
-    color?: string;
-    icon?: string;
-}
-interface OrderStateWritable {
-    paymentState?: PaymentState;
-    fulfillmentState?: FulfillmentState;
-    displayState?: string;
-    status?: string;
-}
-interface OrderLikeForContext {
-    total?: number;
-    balance?: number;
-    paymentMethods?: OrderPaymentMethod[];
-    refunds?: OrderRefund[];
-    refund?: OrderRefund[];
-    lineItems?: OrderLineItem[];
-}
-interface OrderLikeForLegacyInference extends OrderLikeForContext {
-    status?: string;
-}
-interface StoredStateConfig {
-    _id: string;
-    companyId: string;
-    version: number;
-    name: string;
-    isDefault: boolean;
-    paymentPaths: PaymentTransitionPath[];
-    fulfillmentPaths: FulfillmentTransitionPath[];
-    paymentPathMode: PathMode;
-    fulfillmentPathMode: PathMode;
-    crossAxisRules: CrossAxisRule[];
-    transitionConditions: TransitionConditionSet[];
-    validInitialStates: StatePair[];
-    displayStateMap: DisplayStateRule[];
-    createdAt: Date;
-    updatedAt: Date;
-}
-interface StateConfig extends StoredStateConfig {
-    readonly paymentStates: readonly PaymentStateDefinition[];
-    readonly fulfillmentStates: readonly FulfillmentStateDefinition[];
-}
-interface TransitionRequest {
-    from: StatePair | null;
-    to: StatePair;
-    config: StateConfig;
-    context: OrderContext;
-    skipConditionEvaluation?: boolean;
-}
-type TransitionBlockedBy = 'financial_invariant' | 'cross_axis_rule' | 'path' | 'condition';
-interface FailedCondition {
-    field: string;
-    operator: ConditionOperator;
-    value: unknown;
-    reason?: string;
-}
-interface TransitionResult {
-    allowed: boolean;
-    blockedBy?: TransitionBlockedBy;
-    guard?: string;
-    reason?: string;
-    failedConditions?: FailedCondition[];
-}
-interface AvailableTransition {
-    to: StatePair;
-    displayLabel: string;
-    conditions: {
-        met: boolean;
-        description: string;
-    }[];
-}
-interface ConfigValidationError {
-    code: string;
-    message: string;
-    path?: string;
-}
-interface ConfigValidationWarning {
-    code: string;
-    message: string;
-    path?: string;
-}
-interface ConfigValidationResult {
-    valid: boolean;
-    errors: ConfigValidationError[];
-    warnings: ConfigValidationWarning[];
-}
-interface StateConfigFragment {
-    paymentPaths?: PaymentTransitionPath[];
-    fulfillmentPaths?: FulfillmentTransitionPath[];
-    crossAxisRules?: CrossAxisRule[];
-    transitionConditions?: TransitionConditionSet[];
-    validInitialStates?: StatePair[];
-    displayStateMap?: DisplayStateRule[];
-}
-interface FragmentParam {
-    key: string;
-    label: string;
-    type: 'string' | 'number' | 'boolean';
-    default: unknown;
-    min?: number;
-    max?: number;
-    options?: string[];
-}
-
-export { type OrderRefund as $, type AvailableTransition as A, type ConfigValidationWarning as B, CurrencyCode as C, type DisplayStateRule as D, type CrossAxisRequires as E, type FulfillmentStateDefinition as F, type CrossAxisTrigger as G, CustomTableAvailability as H, CustomerPlatform as I, ExtensionCategory as J, FULFILLMENT_STATES as K, FeesCustomBillingStatus as L, type FulfillmentTransitionPath as M, InventoryBaseActionEnum as N, type OrderContext as O, PricingRegionEnum as P, type InventoryBaseActionType as Q, InventorySpecificActionType as R, type StatePair as S, type TransitionConditionSet as T, InvoiceStatus as U, LibraryItemType as V, MenuProject as W, NonRevenueItemType as X, type OrderLineItem as Y, type OrderPaymentMethod as Z, OrderPlatform as _, type PaymentStateDefinition as a, OwnerType as a0, PATH_MODES as a1, PAYMENT_STATES as a2, type PathMode as a3, PaymentMethod as a4, type PaymentTransitionPath as a5, Platform as a6, PreviewImageMode as a7, PricingLevel as a8, PricingPlanEnum as a9, ProductStatus as aa, ProductType as ab, PublicationAvailability as ac, type PublicationConfig as ad, PublicationStatus as ae, ReceiptSendChannel as af, ReceiptType as ag, ResidualPaymentMethod as ah, ResidualStatus as ai, type SplitPaymentPayment as aj, type StateDefinition as ak, StationStatus as al, StripeStatus as am, TimePeriod as an, TopMetericsSort as ao, type TransitionPath as ap, UserTypes as aq, isConditionOperator as ar, isFulfillmentState as as, isPaymentState as at, type FinancialInvariant as b, type CrossAxisRule as c, type StoredStateConfig as d, type StateConfig as e, type ConfigValidationResult as f, type DisplayStateResult as g, type Condition as h, type FailedCondition as i, type OrderLikeForContext as j, type SplitPayment as k, type TransitionRequest as l, type TransitionResult as m, type OrderStateWritable as n, type PaymentState as o, type FulfillmentState as p, type OrderLikeForLegacyInference as q, type StateConfigFragment as r, type FragmentParam as s, type ConfigValidationError as t, type TransitionBlockedBy as u, AttributeType as v, CONDITION_OPERATORS as w, CompanyType as x, type ConditionGroup as y, type ConditionOperator as z };