@fas-core/shared-types 1.0.53 → 1.0.74

package/dist/index.d.mts

@@ -62,15 +62,26 @@ interface IPrice {
 }
 interface ILinePricing {
     quantity: number;
+    baseUnitPrice?: number;
     unitPrice: number;
     totalAmount: number;
     currencyCode: string;
 }
+interface IAppliedFee {
+    name: string;
+    amount: number;
+    description?: string;
+    pricingType?: "PERCENTAGE" | "FIXED";
+    value?: number;
+    appliesTo?: "SUBTOTAL" | "TOTAL";
+}
 interface ISummaryPricing {
     subTotalAmount: number;
     discountAmount: number;
     taxAmount: number;
     shippingAmount: number;
+    feesAmount?: number;
+    appliedFees?: IAppliedFee[];
     totalAmount: number;
     currencyCode: string;
 }
@@ -133,6 +144,7 @@ interface IStore extends BaseEntity {
     slug: string;
     domain: string;
     isPrimarySite: boolean;
+    parent?: IStore | string | null;
     currencies: ICurrency[];
     defaultCurrency: ICurrency;
     settings: IStoreSettings;
@@ -178,7 +190,8 @@ interface ICategory extends BaseEntity {
     slug: string;
     description: string;
     parent: ICategory;
-    store: IStore;
+    stores: (IStore | string)[];
+    childOnly?: boolean;
     image: string;
     sortOrder: number;
     status: boolean;
@@ -192,7 +205,7 @@ interface IStock extends BaseEntity {
     sku: string;
     product: IProduct;
     variant?: IVariant | null;
-    store: IStore;
+    store?: IStore | string | null;
     quantity: number;
     reserved: number;
     available: number;
@@ -200,11 +213,8 @@ interface IStock extends BaseEntity {
     lowStockThreshold: number;
 }
 
-/** Out-of-stock selling policy for a product/variant. */
 declare const InventoryPolicyEnum: {
-    /** Hard-stop at available stock (no oversell). */
     readonly DENY: "deny";
-    /** Allow backorder / oversell past available stock. */
     readonly CONTINUE: "continue";
 };
 type InventoryPolicy = (typeof InventoryPolicyEnum)[keyof typeof InventoryPolicyEnum];
@@ -217,7 +227,8 @@ interface IProductVariantFields {
     quantity: number;
     inventoryPolicy: InventoryPolicy;
     brand: IBrand;
-    store: IStore;
+    stores: (IStore | string)[];
+    childOnly?: boolean;
     stock: IStock;
     category: ICategory;
     categories: ICategory[];
@@ -284,21 +295,16 @@ interface IVariant extends BaseEntity, IProductVariantFields {
     variantOptionMode?: VariantOptionMode;
 }
 
-/**
- * A globally-defined relation group: named buckets that products assign SKUs
- * into. `addable` distinguishes groups whose items can be added to the order
- * (Accessories, Tool Kits, Parts) from display-only cross-sell (Similar Products).
- */
 interface IRelationGroup extends BaseEntity {
     name: string;
     key: string;
     description: string;
+    stores: (IStore | string)[];
     addable: boolean;
     sortOrder: number;
     isVisible: boolean;
     status: boolean;
 }
-/** Per-product assignment of SKUs into a relation group (referenced by group key). */
 interface IProductRelationGroup {
     group: string;
     skus: string[];
@@ -347,10 +353,20 @@ declare const PaymentMethodEnum: {
     readonly STRIPE: "STRIPE";
     readonly CHECK: "CHECK";
     readonly APPLE_PAY: "APPLE_PAY";
+    readonly PURCHASE_ORDER: "PURCHASE_ORDER";
 };
 type PaymentMethodEnum = (typeof PaymentMethodEnum)[keyof typeof PaymentMethodEnum];
-declare const PAYMENT_METHOD_VALUES: ("CREDIT_CARD" | "PAYPAL" | "STRIPE" | "CHECK" | "APPLE_PAY")[];
+declare const PAYMENT_METHOD_VALUES: ("CREDIT_CARD" | "PAYPAL" | "STRIPE" | "CHECK" | "APPLE_PAY" | "PURCHASE_ORDER")[];
 declare const paymentMethodColorMap: Record<PaymentMethodEnum, string>;
+declare const PaymentGatewayEnum: {
+    readonly STRIPE: "STRIPE";
+    readonly PAYPAL: "PAYPAL";
+    readonly BRAINTREE: "BRAINTREE";
+    readonly MANUAL: "MANUAL";
+};
+type PaymentGatewayEnum = (typeof PaymentGatewayEnum)[keyof typeof PaymentGatewayEnum];
+declare const PAYMENT_GATEWAY_VALUES: ("MANUAL" | "PAYPAL" | "STRIPE" | "BRAINTREE")[];
+declare const paymentGatewayColorMap: Record<PaymentGatewayEnum, string>;
 declare const TransactionTypeEnum: {
     readonly ORDER: "ORDER";
     readonly REFUND: "REFUND";
@@ -365,6 +381,7 @@ interface ITransactionBase extends BaseEntity {
     amount: number;
     status: PaymentStatusEnum;
     paymentMethod: PaymentMethodEnum;
+    gateway?: PaymentGatewayEnum;
     gatewayId?: string;
     metaData?: Metadata;
     comment?: string;
@@ -407,6 +424,12 @@ interface IOrder extends BaseEntity {
     status: OrderStatusEnum;
     paymentStatus: PaymentStatusEnum;
     paymentMethod: PaymentMethodEnum;
+    paymentGateway?: PaymentGatewayEnum;
+    shippingAddress: IAddress;
+    billingAddress: IAddress;
+    shippingMethod?: string;
+    acceptedTermsAt?: Date;
+    customerNote?: string;
     metaData: Metadata;
     orderTransactions: IOrderTransaction[];
     refundTransactions: IRefundTransaction[];
@@ -536,11 +559,17 @@ interface IProductTechnicalSpecTable extends BaseEntity {
     status: boolean;
 }
 
-type PricingType = "PERCENTAGE" | "FIXED";
+declare const PricingTypeEnum: {
+    readonly PERCENTAGE: "PERCENTAGE";
+    readonly FIXED: "FIXED";
+};
+type PricingType = (typeof PricingTypeEnum)[keyof typeof PricingTypeEnum];
+declare const PRICING_TYPE_VALUES: ("PERCENTAGE" | "FIXED")[];
 interface IAddonConfig extends BaseEntity {
     name: string;
     key: string;
     description: string;
+    stores: (IStore | string)[];
     price: number;
     pricingType: PricingType;
     quantity: number;
@@ -559,74 +588,141 @@ interface IAddonGroup extends BaseEntity {
     status: boolean;
 }
 
+declare const FeeAppliesToEnum: {
+    readonly SUBTOTAL: "SUBTOTAL";
+    readonly TOTAL: "TOTAL";
+};
+type FeeAppliesToEnum = (typeof FeeAppliesToEnum)[keyof typeof FeeAppliesToEnum];
+declare const FEE_APPLIES_TO_VALUES: ("SUBTOTAL" | "TOTAL")[];
+interface IStoreFee extends BaseEntity {
+    stores: (IStore | string)[];
+    name: string;
+    key: string;
+    description?: string;
+    pricingType: PricingType;
+    value: number;
+    appliesTo: FeeAppliesToEnum;
+    enabled: boolean;
+    isVisible: boolean;
+    sortOrder: number;
+    status: boolean;
+}
+
+declare const EmailTemplateEventEnum: {
+    readonly ORDER_RECEIVED: "ORDER_RECEIVED";
+    readonly ORDER_CANCELLED: "ORDER_CANCELLED";
+    readonly WELCOME: "WELCOME";
+    readonly PASSWORD_RESET: "PASSWORD_RESET";
+    readonly QUOTE: "QUOTE";
+    readonly INVOICE: "INVOICE";
+    readonly PROMOTIONAL: "PROMOTIONAL";
+    readonly CONTACT_US: "CONTACT_US";
+    readonly NOTIFICATION: "NOTIFICATION";
+};
+type EmailTemplateEventEnum = (typeof EmailTemplateEventEnum)[keyof typeof EmailTemplateEventEnum];
+declare const EMAIL_TEMPLATE_EVENT_VALUES: ("ORDER_RECEIVED" | "ORDER_CANCELLED" | "WELCOME" | "PASSWORD_RESET" | "QUOTE" | "INVOICE" | "PROMOTIONAL" | "CONTACT_US" | "NOTIFICATION")[];
+interface IEmailTemplate extends BaseEntity {
+    stores: (IStore | string)[];
+    name: string;
+    key: string;
+    event: EmailTemplateEventEnum;
+    subject: string;
+    headerHtml: string;
+    bodyHtml: string;
+    footerHtml: string;
+    variables: string[];
+    isVisible: boolean;
+    status: boolean;
+}
+
 type RedirectTargetType = "product" | "variant" | "category" | "url";
-/** An old→new URL redirect for safe site migration (many old paths → one target). */
+interface IRedirectSuggestion {
+    targetType: RedirectTargetType;
+    targetRef?: string | null;
+    targetUrl?: string | null;
+    slug?: string;
+    name?: string;
+    score: number;
+}
 interface IRedirect extends BaseEntity {
     fromPath: string;
     targetType: RedirectTargetType;
-    /** Catalog reference id when targetType is product/variant/category. */
     targetRef?: string | null;
-    /** Raw destination path/URL when targetType is "url". */
     targetUrl?: string | null;
+    stores: (IStore | string)[];
     statusCode: number;
-    /** Append the incoming query string to the destination. */
     preserveQuery: boolean;
     status: boolean;
     hits: number;
     lastHitAt?: Date | null;
 }
-/** A captured 404 (unmatched path) surfaced in admin to find missing redirects. */
 interface IUnmatched404 extends BaseEntity {
     path: string;
     count: number;
     lastSeenAt: Date;
     referrer?: string | null;
     resolved: boolean;
+    stores?: (IStore | string)[];
+    suggestions?: IRedirectSuggestion[];
 }
 
-/**
- * Normalizes a URL or path into a canonical, lookup-stable path so old-site URLs
- * match reliably regardless of how they were entered (full URL, casing, trailing
- * slash, query/hash, encoding). Shared by the backend (storing `fromPath`) and
- * the storefront proxy (matching incoming paths) so the two can never drift.
- *
- * Examples:
- *   "https://old.com/Shop/Item/?x=1#a" -> "/shop/item"
- *   "Foo//Bar/"                        -> "/foo/bar"
- *   ""                                 -> "/"
- */
 declare const normalizePath: (input: string) => string;
 
-/**
- * Canonical cart pricing primitives, shared by the backend (authoritative —
- * what the customer is charged) and the storefront configurator (live preview)
- * so the two engines can never drift by a cent. Pure functions, no IO.
- *
- * Money is rounded to 2 decimals with a `Number.EPSILON` nudge so exact
- * half-cent boundaries (e.g. 1.005) round half-up consistently across engines.
- */
-/** Rounds a monetary amount to 2 decimals (half-up, float-noise-safe). */
 declare const roundMoney: (amount: number) => number;
-/** Clamps a requested quantity to a valid line quantity (integer >= 1). */
+declare const formatMoney: (value: number, currencyCode?: string) => string;
 declare const normalizeLineQuantity: (quantity: number) => number;
-/** A single add-on priced against a base unit (selection resolved to its values). */
 interface AddonAmountInput {
     price: number;
     pricingType: PricingType;
     quantity: number;
 }
-/**
- * One add-on's per-(base-)unit contribution, **rounded to a cent**: a FIXED
- * add-on contributes its price; a PERCENTAGE add-on contributes that percent of
- * the base unit price — each times the add-on's own quantity.
- *
- * Per-add-on rounding is the canon (not rounding the summed total once), so each
- * add-on's displayed price is exactly what it adds to the line.
- */
 declare const addonUnitAmount: (addon: AddonAmountInput, baseUnitPrice: number) => number;
-/** Total add-on contribution per base unit: per-add-on rounding, then summed. */
 declare const addonsUnitAmount: (addons: AddonAmountInput[], baseUnitPrice: number) => number;
 
+declare const OrderLogTypeEnum: {
+    readonly ORDER_PLACED: "ORDER_PLACED";
+    readonly PAYMENT_PENDING: "PAYMENT_PENDING";
+    readonly PAYMENT_SUCCEEDED: "PAYMENT_SUCCEEDED";
+    readonly PAYMENT_FAILED: "PAYMENT_FAILED";
+    readonly PAYMENT_CANCELLED: "PAYMENT_CANCELLED";
+    readonly ORDER_STATUS: "ORDER_STATUS";
+    readonly REFUND: "REFUND";
+    readonly EMAIL: "EMAIL";
+    readonly NOTE: "NOTE";
+};
+type OrderLogTypeEnum = (typeof OrderLogTypeEnum)[keyof typeof OrderLogTypeEnum];
+declare const ORDER_LOG_TYPE_VALUES: ("REFUND" | "ORDER_PLACED" | "PAYMENT_PENDING" | "PAYMENT_SUCCEEDED" | "PAYMENT_FAILED" | "PAYMENT_CANCELLED" | "ORDER_STATUS" | "EMAIL" | "NOTE")[];
+declare const orderLogTypeColorMap: Record<OrderLogTypeEnum, string>;
+interface IOrderLog extends BaseEntity {
+    order: IOrder | string;
+    type: OrderLogTypeEnum;
+    message: string;
+    actor?: string;
+    meta?: Metadata;
+}
+
+declare const PaymentLinkStatusEnum: {
+    readonly PENDING: "PENDING";
+    readonly PAID: "PAID";
+    readonly EXPIRED: "EXPIRED";
+    readonly CANCELLED: "CANCELLED";
+};
+type PaymentLinkStatusEnum = (typeof PaymentLinkStatusEnum)[keyof typeof PaymentLinkStatusEnum];
+declare const PAYMENT_LINK_STATUS_VALUES: ("PENDING" | "CANCELLED" | "PAID" | "EXPIRED")[];
+declare const paymentLinkStatusColorMap: Record<PaymentLinkStatusEnum, string>;
+interface IPaymentLink extends BaseEntity {
+    order: IOrder | string;
+    token: string;
+    amount: number;
+    currencyCode: string;
+    gateway: PaymentGatewayEnum;
+    status: PaymentLinkStatusEnum;
+    expiresAt?: string | Date;
+    paidAt?: string | Date;
+    transaction?: string;
+    createdBy?: string;
+}
+
 interface ICartItem extends BaseEntity {
     cart: ICart;
     product: IProduct;
@@ -645,4 +741,73 @@ interface ICart extends BaseEntity {
     pricing: ISummaryPricing;
 }
 
-export { ADMIN_ROLES, type AddonAmountInput, type ApiResponse, type BaseEntity, DiscountTypeEnum, type IAddonConfig, type IAddonGroup, type IAddress, type IAdmin, type IAdminCreate, type IAdminRoleType, type IAdminSafe, type IAdminUpdate, type IBrand, type ICart, type ICartItem, type ICategory, type ICompliance, type IContact, type IContent, type ICountry, type ICoupon, type ICurrency, type ICustomer, type IDiscountType, type IDocumentation, type IKeyValue, type ILinePricing, type IMediaAsset, INVENTORY_POLICY_VALUES, type IOrder, type IOrderItem, type IOrderTransaction, type IPrice, type IProduct, type IProductOptionGroup, type IProductOptionValue, type IProductRelationGroup, type IProductTechnicalSpec, type IProductTechnicalSpecTable, type IProductVariantFields, type IProductVariantOptionGroup, type IProductVariantOptionMatrix, type IProductVariantOptionValue, type IRedirect, type IRefundTransaction, type IRelationGroup, type ISEOMetaData, type IShipping, type IState, type IStock, type IStore, type IStoreSettings, type ISummaryPricing, type ITechSpec, type ITechnicalSpecColumn, type ITechnicalSpecGroup, type ITransactionBase, type IUnmatched404, type IVariant, type IVariantOptionSelection, type InventoryPolicy, InventoryPolicyEnum, type Metadata, ORDER_STATUS_VALUES, OrderStatusEnum, PAYMENT_METHOD_VALUES, PAYMENT_STATUS_VALUES, type Paginated, PaymentMethodEnum, PaymentStatusEnum, type PricingType, type ProductVariantType, type RedirectTargetType, type SoftDeleteFilter, type StockStatus, TRANSACTION_TYPE_VALUES, TransactionTypeEnum, type VariantOptionMode, addonUnitAmount, addonsUnitAmount, normalizeLineQuantity, normalizePath, paymentMethodColorMap, paymentStatusColorMap, roundMoney, statusColors, typeColorMap };
+interface CheckoutAddressInput {
+    addressLine1: string;
+    addressLine2?: string;
+    city: string;
+    zipCode: string;
+    firstName: string;
+    lastName: string;
+    email: string;
+    phoneNumber: string;
+    state?: string;
+    country?: string;
+}
+interface CheckoutPayload {
+    store: string;
+    email: string;
+    shippingAddress: CheckoutAddressInput;
+    useSameAddress: boolean;
+    billingAddress?: CheckoutAddressInput;
+    paymentMethod: PaymentMethodEnum;
+    paymentGateway: PaymentGatewayEnum;
+    shippingMethod?: string;
+    acceptedTerms: boolean;
+    customerNote?: string;
+}
+interface CheckoutResult {
+    order: IOrder;
+    redirectUrl?: string;
+    clientToken?: string;
+}
+
+declare const ProductEventTypeEnum: {
+    readonly VIEW: "view";
+    readonly ADD_TO_CART: "add_to_cart";
+    readonly PURCHASE: "purchase";
+};
+type ProductEventTypeEnum = (typeof ProductEventTypeEnum)[keyof typeof ProductEventTypeEnum];
+declare const PRODUCT_EVENT_TYPE_VALUES: ("view" | "add_to_cart" | "purchase")[];
+interface IProductDailyStat extends BaseEntity {
+    product: IProduct | string;
+    store?: IStore | string | null;
+    date: string;
+    views: number;
+    addToCarts: number;
+    purchases: number;
+    revenue: number;
+}
+
+declare const NotificationTypeEnum: {
+    readonly ORDER_RECEIVED: "ORDER_RECEIVED";
+    readonly PAYMENT_SUCCEEDED: "PAYMENT_SUCCEEDED";
+    readonly PAYMENT_FAILED: "PAYMENT_FAILED";
+    readonly REFUND: "REFUND";
+    readonly ORDER_CANCELLED: "ORDER_CANCELLED";
+    readonly ORDER_STATUS: "ORDER_STATUS";
+};
+type NotificationTypeEnum = (typeof NotificationTypeEnum)[keyof typeof NotificationTypeEnum];
+declare const NOTIFICATION_TYPE_VALUES: ("REFUND" | "ORDER_RECEIVED" | "ORDER_CANCELLED" | "PAYMENT_SUCCEEDED" | "PAYMENT_FAILED" | "ORDER_STATUS")[];
+declare const notificationTypeColorMap: Record<NotificationTypeEnum, string>;
+interface INotification extends BaseEntity {
+    type: NotificationTypeEnum;
+    title: string;
+    message: string;
+    order?: IOrder | string | null;
+    store?: IStore | string | null;
+    read: boolean;
+    readAt?: Date | null;
+    meta?: Metadata;
+}
+
+export { ADMIN_ROLES, type AddonAmountInput, type ApiResponse, type BaseEntity, type CheckoutAddressInput, type CheckoutPayload, type CheckoutResult, DiscountTypeEnum, EMAIL_TEMPLATE_EVENT_VALUES, EmailTemplateEventEnum, FEE_APPLIES_TO_VALUES, FeeAppliesToEnum, type IAddonConfig, type IAddonGroup, type IAddress, type IAdmin, type IAdminCreate, type IAdminRoleType, type IAdminSafe, type IAdminUpdate, type IAppliedFee, type IBrand, type ICart, type ICartItem, type ICategory, type ICompliance, type IContact, type IContent, type ICountry, type ICoupon, type ICurrency, type ICustomer, type IDiscountType, type IDocumentation, type IEmailTemplate, type IKeyValue, type ILinePricing, type IMediaAsset, INVENTORY_POLICY_VALUES, type INotification, type IOrder, type IOrderItem, type IOrderLog, type IOrderTransaction, type IPaymentLink, type IPrice, type IProduct, type IProductDailyStat, type IProductOptionGroup, type IProductOptionValue, type IProductRelationGroup, type IProductTechnicalSpec, type IProductTechnicalSpecTable, type IProductVariantFields, type IProductVariantOptionGroup, type IProductVariantOptionMatrix, type IProductVariantOptionValue, type IRedirect, type IRedirectSuggestion, type IRefundTransaction, type IRelationGroup, type ISEOMetaData, type IShipping, type IState, type IStock, type IStore, type IStoreFee, type IStoreSettings, type ISummaryPricing, type ITechSpec, type ITechnicalSpecColumn, type ITechnicalSpecGroup, type ITransactionBase, type IUnmatched404, type IVariant, type IVariantOptionSelection, type InventoryPolicy, InventoryPolicyEnum, type Metadata, NOTIFICATION_TYPE_VALUES, NotificationTypeEnum, ORDER_LOG_TYPE_VALUES, ORDER_STATUS_VALUES, OrderLogTypeEnum, OrderStatusEnum, PAYMENT_GATEWAY_VALUES, PAYMENT_LINK_STATUS_VALUES, PAYMENT_METHOD_VALUES, PAYMENT_STATUS_VALUES, PRICING_TYPE_VALUES, PRODUCT_EVENT_TYPE_VALUES, type Paginated, PaymentGatewayEnum, PaymentLinkStatusEnum, PaymentMethodEnum, PaymentStatusEnum, type PricingType, PricingTypeEnum, ProductEventTypeEnum, type ProductVariantType, type RedirectTargetType, type SoftDeleteFilter, type StockStatus, TRANSACTION_TYPE_VALUES, TransactionTypeEnum, type VariantOptionMode, addonUnitAmount, addonsUnitAmount, formatMoney, normalizeLineQuantity, normalizePath, notificationTypeColorMap, orderLogTypeColorMap, paymentGatewayColorMap, paymentLinkStatusColorMap, paymentMethodColorMap, paymentStatusColorMap, roundMoney, statusColors, typeColorMap };