@final-commerce/common 2.0.2 → 2.0.3

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

@@ -1,5 +1,3 @@
-import { R as InventorySpecificActionType, H as CustomTableAvailability, v as AttributeType, $ as OwnerType, W as NonRevenueItemType, C as CurrencyCode, a5 as Platform, a9 as ProductStatus, a4 as PaymentTransitionPath, M as FulfillmentTransitionPath, a2 as PathMode, c as CrossAxisRule, T as TransitionConditionSet, S as StatePair, D as DisplayStateRule, u as TransitionBlockedBy, aj as StationStatus, ao as UserTypes, o as PaymentState, p as FulfillmentState, aa as ProductType } from '../interfaces-DIX_ROSP.mjs';
-
 type Enrich<TBase, TEnrichment> = Omit<TBase, keyof TEnrichment> & TEnrichment;
 
 interface BaseDocument {
@@ -215,6 +213,230 @@ interface RefundDiscount {
     itemDiscounts?: RefundItemDiscount[];
 }
 
+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 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 StationStatus {
+    IN_USE = "IN_USE",
+    AVAILABLE = "AVAILABLE"
+}
+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 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 NonRevenueItemType {
+    GIFT_CARD = "gift-card"
+}
+
+declare enum ProductType {
+    SIMPLE = "simple",
+    VARIABLE = "variable"
+}
+declare enum ProductStatus {
+    ACTIVE = "active",
+    INACTIVE = "inactive",
+    DRAFT = "draft"
+}
+
 interface RefundLineItem {
     taxes?: OrderTax[];
     discount?: RefundDiscount;
@@ -629,6 +851,74 @@ interface Transaction extends BaseEntity {
     minorUnits?: number;
 }
 
+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';
+interface StatePair {
+    payment: PaymentState;
+    fulfillment: FulfillmentState;
+}
+type ConditionOperator = 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'notIn' | 'isEmpty' | 'isNotEmpty';
+type PathMode = 'strict' | 'permissive';
+
+interface PaymentTransitionPath {
+    from: PaymentState;
+    to: PaymentState;
+    conditionSetId?: string;
+    _sourceExtensionId?: string;
+}
+interface FulfillmentTransitionPath {
+    from: FulfillmentState;
+    to: FulfillmentState;
+    conditionSetId?: string;
+    _sourceExtensionId?: string;
+}
+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 DisplayStateRule {
+    paymentState?: PaymentState | PaymentState[];
+    fulfillmentState?: FulfillmentState | FulfillmentState[];
+    label: string;
+    color?: string;
+    icon?: string;
+    _sourceExtensionId?: string;
+}
+type TransitionBlockedBy = 'financial_invariant' | 'cross_axis_rule' | 'path' | 'condition';
+
 interface OrderStateConfig extends BaseEntity {
     version: number;
     name: string;

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

@@ -1,5 +1,3 @@
-import { R as InventorySpecificActionType, H as CustomTableAvailability, v as AttributeType, $ as OwnerType, W as NonRevenueItemType, C as CurrencyCode, a5 as Platform, a9 as ProductStatus, a4 as PaymentTransitionPath, M as FulfillmentTransitionPath, a2 as PathMode, c as CrossAxisRule, T as TransitionConditionSet, S as StatePair, D as DisplayStateRule, u as TransitionBlockedBy, aj as StationStatus, ao as UserTypes, o as PaymentState, p as FulfillmentState, aa as ProductType } from '../interfaces-DIX_ROSP.js';
-
 type Enrich<TBase, TEnrichment> = Omit<TBase, keyof TEnrichment> & TEnrichment;
 
 interface BaseDocument {
@@ -215,6 +213,230 @@ interface RefundDiscount {
     itemDiscounts?: RefundItemDiscount[];
 }
 
+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 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 StationStatus {
+    IN_USE = "IN_USE",
+    AVAILABLE = "AVAILABLE"
+}
+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 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 NonRevenueItemType {
+    GIFT_CARD = "gift-card"
+}
+
+declare enum ProductType {
+    SIMPLE = "simple",
+    VARIABLE = "variable"
+}
+declare enum ProductStatus {
+    ACTIVE = "active",
+    INACTIVE = "inactive",
+    DRAFT = "draft"
+}
+
 interface RefundLineItem {
     taxes?: OrderTax[];
     discount?: RefundDiscount;
@@ -629,6 +851,74 @@ interface Transaction extends BaseEntity {
     minorUnits?: number;
 }
 
+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';
+interface StatePair {
+    payment: PaymentState;
+    fulfillment: FulfillmentState;
+}
+type ConditionOperator = 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'notIn' | 'isEmpty' | 'isNotEmpty';
+type PathMode = 'strict' | 'permissive';
+
+interface PaymentTransitionPath {
+    from: PaymentState;
+    to: PaymentState;
+    conditionSetId?: string;
+    _sourceExtensionId?: string;
+}
+interface FulfillmentTransitionPath {
+    from: FulfillmentState;
+    to: FulfillmentState;
+    conditionSetId?: string;
+    _sourceExtensionId?: string;
+}
+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 DisplayStateRule {
+    paymentState?: PaymentState | PaymentState[];
+    fulfillmentState?: FulfillmentState | FulfillmentState[];
+    label: string;
+    color?: string;
+    icon?: string;
+    _sourceExtensionId?: string;
+}
+type TransitionBlockedBy = 'financial_invariant' | 'cross_axis_rule' | 'path' | 'condition';
+
 interface OrderStateConfig extends BaseEntity {
     version: number;
     name: string;

package/dist/pos-types/index.js

@@ -17,15 +17,15 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // pos-types/index.ts
-var pos_types_exports = {};
-__export(pos_types_exports, {
+var index_exports = {};
+__export(index_exports, {
   ActiveEntityType: () => ActiveEntityType,
   EnvironmentDataKeys: () => EnvironmentDataKeys,
   EnvironmentDataSubKeys: () => EnvironmentDataSubKeys,
   PaymentStatus: () => PaymentStatus,
   ProcessorType: () => ProcessorType
 });
-module.exports = __toCommonJS(pos_types_exports);
+module.exports = __toCommonJS(index_exports);
 
 // pos-types/active/PaymentStatus.ts
 var PaymentStatus = /* @__PURE__ */ ((PaymentStatus2) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@final-commerce/common",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "Shared utilities, types, constants, and engineering governance configs for the Final Commerce platform.",
   "homepage": "https://github.com/Final-Commerce/common#readme",
   "bugs": {
@@ -12,7 +12,6 @@
   },
   "author": "Final-Commerce",
   "publishConfig": {
-    "registry": "https://us-npm.pkg.dev/final-preproduction/npm/",
     "access": "public"
   },
   "engines": {
@@ -156,5 +155,6 @@
     "eslint-plugin-react-refresh": {
       "optional": true
     }
-  }
+  },
+  "prettier": "@final-commerce/common/prettier"
 }