@retaila/shared-types 1.1.6 → 1.1.8

package/dist/index.d.mts

@@ -187,6 +187,7 @@ interface AccountIntegration {
     updatedAt: Date;
     deletedAt?: Date | null;
     integration: Integration;
+    settings: Record<string, any>;
 }
 
 /**
@@ -319,6 +320,42 @@ declare enum AccountDomainStatus {
     INACTIVE = "INACTIVE"
 }
 
+/**
+ * Entidad Customer
+ * Cliente de la tienda
+*/
+
+interface Customer {
+    id: string;
+    accountId: string;
+    firstName?: string;
+    lastName?: string;
+    email: string;
+    phone?: Phone;
+    status: CustomerStatus;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt?: Date | null;
+}
+declare enum CustomerStatus {
+    ACTIVE = "ACTIVE",
+    INACTIVE = "INACTIVE",
+    BLACKLISTED = "BLACKLISTED",// e.g., for fraudulent activity
+    PENDING = "PENDING"
+}
+
+/**
+ * Register or update a customer
+ */
+interface CustomerUpsertDto {
+    id?: string;
+    accountId: string;
+    firstName?: string;
+    lastName?: string;
+    email: string;
+    phone?: Phone;
+}
+
 /**
  * Entidad Order
  * Define la orden de compra de un cliente en el sitio web.
@@ -353,6 +390,7 @@ interface Order {
     customerNote?: string;
     internalNote?: string;
     source: OrderSource;
+    sourceAccountDomainId?: string;
     demo: boolean;
     createdAt: Date;
     updatedAt: Date;
@@ -360,6 +398,9 @@ interface Order {
     cancelReason?: string;
     deletedAt?: Date;
     items?: OrderItem[];
+    customer?: Customer | null;
+    paymentMethodIntegration?: AccountIntegration | null;
+    accountDomain?: AccountDomain;
 }
 interface OrderItem {
     id: string;
@@ -432,7 +473,170 @@ interface AdminOrderStatusChangeDto {
     status: OrderStatus;
 }
 
-declare enum TransactionStatus {
+/**
+ * Add an item to the cart
+*/
+interface CartItemAddDto {
+    cartId: string;
+    productId: string;
+    variantId?: string;
+    quantity: number;
+    attributes?: {
+        [key: string]: string | number;
+    };
+    userEmail?: string;
+    userId?: string;
+}
+/**
+ * Update an item in the cart
+ */
+interface CartItemUpdateDto {
+    cartId: string;
+    itemId: string;
+    quantity: number;
+}
+/**
+ * Remove an item from the cart
+ */
+interface CartItemRemoveDto {
+    cartId: string;
+    itemId: string;
+}
+interface CartUpdateDto {
+    cartId: string;
+    source: OrderSource;
+    sourceUrl?: string;
+    customer: {
+        email: string;
+    };
+    delivery: {
+        type: 'shipping' | 'pickup';
+        deliveryOptionId?: string;
+        pickupBranchId?: string;
+        firstname: string;
+        lastname: string;
+        phone: {
+            countryCode: string;
+            national: string;
+            international: string;
+            type: string;
+            validated: boolean;
+        };
+        address: {
+            country: string;
+            department: string;
+            locality: string;
+            street: string;
+            complement?: string;
+            notes?: string;
+            postalCode: string;
+            mapPosition: {
+                lat: number;
+                lng: number;
+            };
+        };
+    };
+    billing: {
+        name: string;
+        address: string;
+        city: string;
+        department: string;
+    };
+}
+/**
+ * Confirm a cart
+ */
+interface CartConfirmDto {
+    cartId: string;
+}
+/**
+ * Validation information for a cart item
+ */
+interface CartItemValidation {
+    hasIssues: boolean;
+    issues: string[];
+    errorCode?: CartItemErrorCode;
+    currentPrice?: number;
+    availableStock?: number;
+    isProductActive?: boolean;
+}
+/**
+ * Error codes for cart items
+ */
+declare enum CartItemErrorCode {
+    PRICE_INCREASED = "PRICE_INCREASED",// Precio aumentó
+    PRICE_DECREASED = "PRICE_DECREASED",// Precio disminuyó  
+    PRODUCT_INACTIVE = "PRODUCT_INACTIVE",// Producto ya no está disponible
+    STOCK_INSUFFICIENT = "STOCK_INSUFFICIENT",// Stock insuficiente (hay algo disponible)
+    STOCK_UNAVAILABLE = "STOCK_UNAVAILABLE",// Sin stock (0 disponible)
+    VALIDATION_ERROR = "VALIDATION_ERROR"
+}
+
+/**
+ * Entidad Cart
+ * Define el carrito de compras de un cliente en el sitio web.
+ */
+interface Cart {
+    id: string;
+    code: string;
+    customerId?: string;
+    sessionId?: string;
+    items: CartItem[];
+    subtotal: number;
+    total: number;
+    currency: string;
+    itemCount: number;
+    createdAt: Date;
+    updatedAt: Date;
+    status: CartStatus;
+    source: CartSource;
+    sourceAccountDomainId?: string;
+    recoveryToken?: string;
+    customerNote?: string;
+    hasIssues: boolean;
+    issuesCount: number;
+    subtotalPrice?: number;
+    totalDiscounts?: number;
+    totalShippingPrice?: number;
+    totalTax?: number;
+    totalPrice?: number;
+    taxDetails?: any;
+    customer?: Customer | null;
+    accountDomain?: AccountDomain;
+}
+interface CartItem {
+    id: string;
+    productId: string;
+    productVariantId: string;
+    name: string;
+    unitPrice: number;
+    quantity: number;
+    image?: string;
+    thumbnailUrl?: string;
+    sku?: string;
+    attributeDetails: CartItemAttributeDetail[];
+    validation?: CartItemValidation;
+}
+interface CartItemAttributeDetail {
+    name: string;
+    value: string;
+    type?: string;
+}
+declare enum CartStatus {
+    ACTIVE = "ACTIVE",
+    LOCKED = "LOCKED",
+    EXPIRED = "EXPIRED",
+    CONVERTED = "CONVERTED",
+    ABANDONED = "ABANDONED",
+    MERGED = "MERGED"
+}
+declare enum CartSource {
+    WEB = "WEB",
+    POS = "POS",
+    API = "API"
+}
+
+declare enum PaymentStatus {
     PENDING = "PENDING",// Pendiente
     PREAUTHORIZED = "PREAUTHORIZED",
     APPROVED = "APPROVED",// Pago aprobado online
@@ -467,12 +671,10 @@ interface Payment {
     amountRefunded: number;
     paidAt?: string | Date;
     refundedAt?: string | Date;
-    status: TransactionStatus;
+    status: PaymentStatus;
     cardBrand?: string;
     cardLast4?: string;
-    gatewayProvider?: string;
-    gatewayMetadata?: Record<string, any>;
-    paymentRedirectUrl?: string;
+    metadata?: Record<string, any>;
     demo: boolean;
     createdAt: string | Date;
     updatedAt: string | Date;
@@ -720,164 +922,9 @@ declare enum StorePageType {
     OTHER = "OTHER"
 }
 
-/**
- * Add an item to the cart
-*/
-interface CartItemAddDto {
-    cartId: string;
-    productId: string;
-    variantId?: string;
-    quantity: number;
-    attributes?: {
-        [key: string]: string | number;
-    };
-    userEmail?: string;
-    userId?: string;
-}
-/**
- * Update an item in the cart
- */
-interface CartItemUpdateDto {
-    cartId: string;
-    itemId: string;
-    quantity: number;
-}
-/**
- * Remove an item from the cart
- */
-interface CartItemRemoveDto {
-    cartId: string;
-    itemId: string;
-}
-interface CartUpdateDto {
-    cartId: string;
-    customer: {
-        email: string;
-    };
-    delivery: {
-        type: 'shipping' | 'pickup';
-        deliveryOptionId?: string;
-        pickupBranchId?: string;
-        firstname: string;
-        lastname: string;
-        phone: {
-            countryCode: string;
-            national: string;
-            international: string;
-            type: string;
-            validated: boolean;
-        };
-        address: {
-            country: string;
-            department: string;
-            locality: string;
-            street: string;
-            complement?: string;
-            notes?: string;
-            postalCode: string;
-            mapPosition: {
-                lat: number;
-                lng: number;
-            };
-        };
-    };
-    billing: {
-        name: string;
-        address: string;
-        city: string;
-        department: string;
-    };
-}
-/**
- * Confirm a cart
- */
-interface CartConfirmDto {
-    cartId: string;
-}
-/**
- * Validation information for a cart item
- */
-interface CartItemValidation {
-    hasIssues: boolean;
-    issues: string[];
-    errorCode?: CartItemErrorCode;
-    currentPrice?: number;
-    availableStock?: number;
-    isProductActive?: boolean;
-}
-/**
- * Error codes for cart items
- */
-declare enum CartItemErrorCode {
-    PRICE_INCREASED = "PRICE_INCREASED",// Precio aumentó
-    PRICE_DECREASED = "PRICE_DECREASED",// Precio disminuyó  
-    PRODUCT_INACTIVE = "PRODUCT_INACTIVE",// Producto ya no está disponible
-    STOCK_INSUFFICIENT = "STOCK_INSUFFICIENT",// Stock insuficiente (hay algo disponible)
-    STOCK_UNAVAILABLE = "STOCK_UNAVAILABLE",// Sin stock (0 disponible)
-    VALIDATION_ERROR = "VALIDATION_ERROR"
-}
-
-/**
- * Entidad Cart
- * Define el carrito de compras de un cliente en el sitio web.
- */
-interface Cart {
-    id: string;
-    code: string;
-    customerId?: string;
-    sessionId?: string;
-    items: CartItem[];
-    subtotal: number;
-    total: number;
-    currency: string;
-    itemCount: number;
-    createdAt: Date;
-    updatedAt: Date;
-    status: CartStatus;
-    source: CartSource;
-    recoveryToken?: string;
-    userEmail?: string;
-    userId?: string;
-    customerNote?: string;
-    hasIssues: boolean;
-    issuesCount: number;
-    subtotalPrice?: number;
-    totalDiscounts?: number;
-    totalShippingPrice?: number;
-    totalTax?: number;
-    totalPrice?: number;
-    taxDetails?: any;
-}
-interface CartItem {
-    id: string;
-    productId: string;
-    productVariantId: string;
-    name: string;
-    unitPrice: number;
-    quantity: number;
-    image?: string;
-    thumbnailUrl?: string;
-    sku?: string;
-    attributeDetails: CartItemAttributeDetail[];
-    validation?: CartItemValidation;
-}
-interface CartItemAttributeDetail {
-    name: string;
-    value: string;
-    type?: string;
-}
-declare enum CartStatus {
-    ACTIVE = "ACTIVE",
-    LOCKED = "LOCKED",
-    EXPIRED = "EXPIRED",
-    CONVERTED = "CONVERTED",
-    ABANDONED = "ABANDONED",
-    MERGED = "MERGED"
-}
-declare enum CartSource {
-    WEB = "WEB",
-    POS = "POS",
-    API = "API"
+declare enum PubSubTopics {
+    ORDER_PLACED = "order-placed",
+    NOTIFICATION_CREATED = "notification-created"
 }
 
-export { type Account, type AccountBranch, type AccountBranchSchedule, AccountBranchScheduleDay, AccountBranchScheduleStatus, AccountBranchStatus, type AccountDeliveryOption, type AccountDeliveryOptionCalculatedCost, AccountDeliveryOptionPriceLogic, AccountDeliveryOptionStatus, type AccountDeliveryOptionZone, AccountDeliveryOptionZoneStatus, type AccountDomain, AccountDomainStatus, type AccountIntegration, type AccountIntegrationConfigDTO, AccountIntegrationConnectionStatus, AccountIntegrationEnvironment, AccountIntegrationStatus, AccountStatus, type Address, type AdminOrderStatusChangeDto, type BaseEntity, type BaseEntityWithAccount, type BaseEntityWithAccountAndUser, type BaseEntityWithUser, type Cart, type CartConfirmDto, type CartItem, type CartItemAddDto, type CartItemAttributeDetail, CartItemErrorCode, type CartItemRemoveDto, type CartItemUpdateDto, type CartItemValidation, CartSource, CartStatus, type CartUpdateDto, Currency, type Integration, IntegrationCategory, IntegrationStatus, type MapPosition, type Media, MediaType, type Order, type OrderCreateFromCartDto, OrderDeliveryType, OrderFulfillmentStatus, type OrderItem, OrderPaymentStatus, OrderSource, OrderStatus, type Payment, PaymentMethodType, type Phone, type Product, type ProductAttribute, type ProductAttributeOption, ProductAttributeStatus, ProductAttributeType, type ProductCategory, ProductCategoryStatus, ProductStatus, ProductType, type ProductVariant, type StandardCategory, StandardCategoryStatus, type StatusChangeHistory, type StoreBanner, StoreBannerStatus, type StorePage, StorePageStatus, StorePageType, type ThemeConfig, TransactionStatus, getCurrencySymbol };
+export { type Account, type AccountBranch, type AccountBranchSchedule, AccountBranchScheduleDay, AccountBranchScheduleStatus, AccountBranchStatus, type AccountDeliveryOption, type AccountDeliveryOptionCalculatedCost, AccountDeliveryOptionPriceLogic, AccountDeliveryOptionStatus, type AccountDeliveryOptionZone, AccountDeliveryOptionZoneStatus, type AccountDomain, AccountDomainStatus, type AccountIntegration, type AccountIntegrationConfigDTO, AccountIntegrationConnectionStatus, AccountIntegrationEnvironment, AccountIntegrationStatus, AccountStatus, type Address, type AdminOrderStatusChangeDto, type BaseEntity, type BaseEntityWithAccount, type BaseEntityWithAccountAndUser, type BaseEntityWithUser, type Cart, type CartConfirmDto, type CartItem, type CartItemAddDto, type CartItemAttributeDetail, CartItemErrorCode, type CartItemRemoveDto, type CartItemUpdateDto, type CartItemValidation, CartSource, CartStatus, type CartUpdateDto, Currency, type Customer, CustomerStatus, type CustomerUpsertDto, type Integration, IntegrationCategory, IntegrationStatus, type MapPosition, type Media, MediaType, type Order, type OrderCreateFromCartDto, OrderDeliveryType, OrderFulfillmentStatus, type OrderItem, OrderPaymentStatus, OrderSource, OrderStatus, type Payment, PaymentMethodType, PaymentStatus, type Phone, type Product, type ProductAttribute, type ProductAttributeOption, ProductAttributeStatus, ProductAttributeType, type ProductCategory, ProductCategoryStatus, ProductStatus, ProductType, type ProductVariant, PubSubTopics, type StandardCategory, StandardCategoryStatus, type StatusChangeHistory, type StoreBanner, StoreBannerStatus, type StorePage, StorePageStatus, StorePageType, type ThemeConfig, getCurrencySymbol };