@retaila/shared-types 1.1.21 → 1.1.23

package/dist/index.d.ts

@@ -356,6 +356,184 @@ interface CustomerUpsertDto {
     phone?: Phone;
 }
 
+interface StatusInfo {
+    text: string;
+    class: string;
+    actionText?: string;
+}
+
+/**
+ * Entidad StandardCategory
+ * Define las categorías estándar de productos.
+ * Estas categorías estan pensadas para unificar o agrupar productos de diferentes cuentas.
+ */
+interface StandardCategory {
+    id: string;
+    parentId?: string;
+    name: string;
+    slug: string;
+    description?: string;
+    imageId?: string | null;
+    order: number;
+    status: StandardCategoryStatus;
+    metadata?: {
+        icon?: string;
+        displayInMenu?: boolean;
+        seoTitle?: string;
+        seoDescription?: string;
+        attributes?: string[];
+    };
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt?: Date | null;
+    children: StandardCategory[];
+    parent: StandardCategory | null;
+}
+declare enum StandardCategoryStatus {
+    ACTIVE = "ACTIVE",
+    INACTIVE = "INACTIVE"
+}
+
+/**
+ * Entidad ProductCategory
+ * Define las categorías de productos.
+ * Soporta una estructura jerárquica (categorías y subcategorías) mediante el campo parentId.
+ * Cada categoría debe estar asociada a una categoría estándar del sistema.
+ */
+interface ProductCategory {
+    id: string;
+    accountId: string;
+    parentId?: string;
+    standardCategoryId: string;
+    name: string;
+    slug: string;
+    description?: string;
+    imageId?: string | null;
+    order: number;
+    isFeatured: boolean;
+    status: ProductCategoryStatus;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt?: Date | null;
+    children: ProductCategory[];
+    parent: ProductCategory | null;
+    standardCategory: StandardCategory;
+}
+declare enum ProductCategoryStatus {
+    ACTIVE = "ACTIVE",
+    INACTIVE = "INACTIVE"
+}
+
+/**
+ * Entidad Product
+ * Representa un producto vendible en la tienda. Es la entidad base que puede tener múltiples variantes.
+ */
+interface Product {
+    id: string;
+    accountId: string;
+    code: string;
+    brandId?: string | null;
+    supplierId?: string | null;
+    productType: ProductType;
+    sku?: string | null;
+    barcode?: string | null;
+    name: string;
+    slug: string;
+    description?: string | null;
+    isFeatured: boolean;
+    allowBackorder: boolean;
+    weight?: number | null;
+    weightUnit?: string | null;
+    height?: number | null;
+    width?: number | null;
+    depth?: number | null;
+    dimensionUnit?: string | null;
+    shippingLeadTime?: string | null;
+    status: ProductStatus;
+    statusInfo?: StatusInfo;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt?: Date | null;
+    media?: Media[];
+    variants?: ProductVariant[];
+    categories?: ProductCategory[];
+}
+declare enum ProductStatus {
+    ACTIVE = "ACTIVE",// Available for sale
+    INACTIVE = "INACTIVE",// Not visible/purchasable
+    ARCHIVED = "ARCHIVED",// Not visible, kept for records
+    DRAFT = "DRAFT"
+}
+declare enum ProductType {
+    SIMPLE = "SIMPLE",// Product without variants (may have a default hidden variant)
+    VARIABLE = "VARIABLE",// Product with distinct variants (color, size, etc.)
+    BUNDLE = "BUNDLE",// A package of other products/variants
+    GIFT_CARD = "GIFT_CARD"
+}
+interface ProductVariant {
+    id: string;
+    accountId: string;
+    productId: string;
+    sku?: string | null;
+    barcode?: string | null;
+    currency: string;
+    price: number;
+    compareAtPrice?: number;
+    allowBackorder?: boolean;
+    stock: number;
+    weight?: number | null;
+    weightUnit?: string | null;
+    height?: number | null;
+    width?: number | null;
+    depth?: number | null;
+    dimensionUnit?: string | null;
+    shippingLeadTime?: string | null;
+    order: number;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt?: Date;
+}
+
+declare function getProductStatusInfo(status: ProductStatus): StatusInfo;
+
+type FulfillmentItem = {
+    id: string;
+    fulfillmentId: string;
+    orderItemId: string;
+    quantity: number;
+};
+
+type CreateFulfillmentItemDto = {
+    orderItemId: string;
+    quantity: string;
+};
+
+declare enum FulfillmentStatus {
+    PENDING = "pending",
+    PACKED = "packed",
+    SHIPPED = "shipped",
+    DELIVERED = "delivered",
+    CANCELLED = "cancelled"
+}
+type Fulfillment = {
+    id: string;
+    accountId: string;
+    orderId: string;
+    accountBranchId: string;
+    carrier: string;
+    trackingNumber: string | null;
+    items: FulfillmentItem[];
+    status: FulfillmentStatus;
+    data: Record<string, unknown> | null;
+    packedAt: Date | null;
+    shippedAt: Date | null;
+    deliveredAt: Date | null;
+    cancelledAt: Date | null;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt?: Date;
+};
+
 /**
  * Entidad Order
  * Define la orden de compra de un cliente en el sitio web.
@@ -376,6 +554,7 @@ interface Order {
     paymentMethodIntegrationId?: string;
     billingInformation?: any;
     currency: Currency;
+    currencySymbol?: string;
     subtotalPrice: number;
     totalDiscounts: number;
     totalShippingPrice: number;
@@ -384,8 +563,9 @@ interface Order {
     totalPrice: number;
     totalRefunded: number;
     status: OrderStatus;
+    statusInfo?: StatusInfo;
     paymentStatus: OrderPaymentStatus;
-    fulfillmentStatus: OrderFulfillmentStatus;
+    fulfillmentStatus: FulfillmentStatus;
     statusHistory?: StatusChangeHistory[];
     customerNote?: string;
     internalNote?: string;
@@ -401,6 +581,8 @@ interface Order {
     customer?: Customer | null;
     paymentMethodIntegration?: AccountIntegration | null;
     accountDomain?: AccountDomain;
+    statusChangeNext?: OrderStatus;
+    statusChangeAllowed?: OrderStatus[];
 }
 interface OrderItem {
     id: string;
@@ -412,6 +594,7 @@ interface OrderItem {
     productName: string;
     variantName?: string;
     currency: Currency;
+    currencySymbol?: string;
     unitPrice: number;
     totalDiscount: number;
     totalPrice: number;
@@ -423,6 +606,8 @@ interface OrderItem {
     taxName?: string;
     createdAt: Date;
     updatedAt: Date;
+    productSnapshot?: OrderItemSnapshot;
+    product?: Product;
 }
 declare enum OrderStatus {
     PENDING = "PENDING",// Order placed, awaiting payment confirmation
@@ -442,11 +627,6 @@ declare enum OrderPaymentStatus {
     REFUNDED = "REFUNDED",
     PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED"
 }
-declare enum OrderFulfillmentStatus {
-    PENDING = "PENDING",
-    PARTIAL = "PARTIAL",
-    FULFILLED = "FULFILLED"
-}
 declare enum OrderSource {
     WEB = "WEB",
     POS = "POS",
@@ -463,6 +643,12 @@ interface StatusChangeHistory {
     userId?: string;
     metadata?: Record<string, any>;
 }
+interface OrderItemSnapshot {
+    sku?: string;
+    productName: string;
+    variantName?: string;
+    media?: Media[];
+}
 
 interface OrderCreateFromCartDto {
     cartId: string;
@@ -473,6 +659,8 @@ interface AdminOrderStatusChangeDto {
     status: OrderStatus;
 }
 
+declare function getOrderStatusInfo(status: OrderStatus): StatusInfo;
+
 /**
  * Add an item to the cart
 */
@@ -586,6 +774,12 @@ interface Cart {
     subtotal: number;
     total: number;
     deliveryType: CartDeliveryType;
+    deliveryFirstName?: string;
+    deliveryLastName?: string;
+    deliveryAddress?: string;
+    deliveryPhone?: string;
+    deliveryOptionId?: string;
+    pickupBranchId?: string;
     itemCount: number;
     createdAt: Date;
     updatedAt: Date;
@@ -602,8 +796,8 @@ interface Cart {
     totalTax?: number;
     totalPrice?: number;
     taxDetails?: any;
-    customer?: Customer | null;
-    accountDomain?: AccountDomain;
+    customer?: Partial<Customer> | null;
+    accountDomain?: Partial<AccountDomain> | null;
 }
 interface CartItem {
     id: string;
@@ -637,7 +831,7 @@ declare enum CartSource {
     API = "API"
 }
 declare enum CartDeliveryType {
-    DELIVERY = "delivery",
+    SHIPPING = "shipping",
     PICKUP = "pickup"
 }
 
@@ -649,7 +843,8 @@ declare enum PaymentStatus {
     REJECTED = "REJECTED",// Pago rechazado
     REFUND_IN_PROCESS = "REFUND_IN_PROCESS",// En proceso de reembolso con la plataforma de pagos
     PARTIAL_REFUND = "PARTIAL_REFUND",// Pago parcialmente reembolsado
-    REFUNDED = "REFUNDED"
+    REFUNDED = "REFUNDED",// Pago reembolsado
+    ERROR = "ERROR"
 }
 declare enum PaymentMethodType {
     BANK_TRANSFER = "BANK_TRANSFER",
@@ -679,77 +874,54 @@ interface Payment {
     status: PaymentStatus;
     cardBrand?: string;
     cardLast4?: string;
+    data?: Record<string, unknown>;
     metadata?: Record<string, any>;
     demo: boolean;
     createdAt: string | Date;
     updatedAt: string | Date;
     deletedAt?: string | Date;
 }
-
-/**
- * Entidad Product
- * Representa un producto vendible en la tienda. Es la entidad base que puede tener múltiples variantes.
- */
-interface Product {
-    id: string;
-    accountId: string;
-    code: string;
-    brandId?: string | null;
-    supplierId?: string | null;
-    productType: ProductType;
-    sku?: string | null;
-    barcode?: string | null;
-    name: string;
-    slug: string;
-    description?: string | null;
-    isFeatured: boolean;
-    allowBackorder: boolean;
-    weight?: number | null;
-    weightUnit?: string | null;
-    height?: number | null;
-    width?: number | null;
-    depth?: number | null;
-    dimensionUnit?: string | null;
-    shippingLeadTime?: string | null;
-    status: ProductStatus;
-    createdAt: Date;
-    updatedAt: Date;
-    deletedAt?: Date | null;
+type PaymentProviderKey = 'MERCADOPAGO';
+interface PaymentProviderContext {
+    db: unknown;
+    accountIntegrationId: string;
+    providerKey: PaymentProviderKey;
+    environment: 'PRODUCTION' | 'DEVELOPMENT';
+    credentials: Record<string, any>;
 }
-declare enum ProductStatus {
-    ACTIVE = "ACTIVE",// Available for sale
-    INACTIVE = "INACTIVE",// Not visible/purchasable
-    ARCHIVED = "ARCHIVED",// Not visible, kept for records
-    DRAFT = "DRAFT"
+interface PaymentProviderInitInput {
+    data: Record<string, any>;
 }
-declare enum ProductType {
-    SIMPLE = "SIMPLE",// Product without variants (may have a default hidden variant)
-    VARIABLE = "VARIABLE",// Product with distinct variants (color, size, etc.)
-    BUNDLE = "BUNDLE",// A package of other products/variants
-    GIFT_CARD = "GIFT_CARD"
+interface PaymentProviderInitOutput {
+    data: Record<string, any>;
+    status: PaymentStatus;
 }
-interface ProductVariant {
-    id: string;
+interface PaymentProviderRefundInput {
+    amount: number;
+    data: Record<string, any>;
+}
+interface PaymentProviderRefundOutput {
+    data: Record<string, any>;
+}
+interface PaymentProviderWebhookResult {
+    order_code: string | null;
+    status: PaymentStatus;
+    data: Record<string, unknown>;
+}
+interface WebhookPayload {
+    provider: string;
     accountId: string;
-    productId: string;
-    sku?: string | null;
-    barcode?: string | null;
-    currency: string;
-    price: number;
-    compareAtPrice?: number;
-    allowBackorder?: boolean;
-    stock: number;
-    weight?: number | null;
-    weightUnit?: string | null;
-    height?: number | null;
-    width?: number | null;
-    depth?: number | null;
-    dimensionUnit?: string | null;
-    shippingLeadTime?: string | null;
-    order: number;
-    createdAt: Date;
-    updatedAt: Date;
-    deletedAt?: Date;
+    payload: {
+        query: Record<string, unknown>;
+        body: Record<string, unknown>;
+        headers: Record<string, unknown>;
+    };
+}
+interface PaymentProviderAdapter {
+    readonly key: PaymentProviderKey;
+    initPayment(input: PaymentProviderInitInput): Promise<PaymentProviderInitOutput>;
+    refund(input: PaymentProviderRefundInput): Promise<PaymentProviderRefundOutput>;
+    processWebhook(input: WebhookPayload['payload']): Promise<PaymentProviderWebhookResult>;
 }
 
 /**
@@ -757,6 +929,7 @@ interface ProductVariant {
  * Define los atributos disponibles que se pueden asignar a las variantes de producto (ej. Color, Talla).
  * Especifica el nombre y tipo del atributo para ayudar en la representación y filtrado.
  */
+
 interface ProductAttribute {
     id: string;
     accountId: string;
@@ -770,6 +943,12 @@ interface ProductAttribute {
     createdAt: Date;
     updatedAt: Date;
     deletedAt?: Date | null;
+    productCategories: ProductCategory[];
+    productCategoryLinks: Array<{
+        categoryId: string;
+        isRequired: boolean;
+        displayOrder: number;
+    }>;
     options: ProductAttributeOption[];
     displayOrder: number;
 }
@@ -800,68 +979,6 @@ interface ProductAttributeOption {
     count: number;
 }
 
-/**
- * Entidad StandardCategory
- * Define las categorías estándar de productos.
- * Estas categorías estan pensadas para unificar o agrupar productos de diferentes cuentas.
- */
-interface StandardCategory {
-    id: string;
-    parentId?: string;
-    name: string;
-    slug: string;
-    description?: string;
-    imageId?: string | null;
-    order: number;
-    status: StandardCategoryStatus;
-    metadata?: {
-        icon?: string;
-        displayInMenu?: boolean;
-        seoTitle?: string;
-        seoDescription?: string;
-        attributes?: string[];
-    };
-    createdAt: Date;
-    updatedAt: Date;
-    deletedAt?: Date | null;
-    children: StandardCategory[];
-    parent: StandardCategory | null;
-}
-declare enum StandardCategoryStatus {
-    ACTIVE = "ACTIVE",
-    INACTIVE = "INACTIVE"
-}
-
-/**
- * Entidad ProductCategory
- * Define las categorías de productos.
- * Soporta una estructura jerárquica (categorías y subcategorías) mediante el campo parentId.
- * Cada categoría debe estar asociada a una categoría estándar del sistema.
- */
-interface ProductCategory {
-    id: string;
-    accountId: string;
-    parentId?: string;
-    standardCategoryId: string;
-    name: string;
-    slug: string;
-    description?: string;
-    imageId?: string | null;
-    order: number;
-    isFeatured: boolean;
-    status: ProductCategoryStatus;
-    createdAt: Date;
-    updatedAt: Date;
-    deletedAt?: Date | null;
-    children: ProductCategory[];
-    parent: ProductCategory | null;
-    standardCategory: StandardCategory;
-}
-declare enum ProductCategoryStatus {
-    ACTIVE = "ACTIVE",
-    INACTIVE = "INACTIVE"
-}
-
 /**
  * Entidad StoreBanner
  * Banners para la portada de la web de la tienda
@@ -929,8 +1046,121 @@ declare enum StorePageType {
 
 declare enum PubSubTopics {
     ORDER_PLACED = "order-placed",
+    ORDER_CONFIRMED = "order-confirmed",
+    ORDER_PROCESSING = "order-processing",
+    ORDER_PROCESSED = "order-processed",
+    ORDER_COMPLETED = "order-completed",
     PAYMENT_PAID = "payment-paid",
     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, CartDeliveryType, 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 };
+declare enum SupportConversationChannel {
+    WEB = "WEB",
+    EMAIL = "EMAIL",
+    WHATSAPP = "WHATSAPP"
+}
+declare enum SupportConversationVisibility {
+    INTERNAL = "INTERNAL",
+    MERCHANT = "MERCHANT"
+}
+declare enum SupportConversationPriority {
+    LOW = "LOW",
+    MEDIUM = "MEDIUM",
+    HIGH = "HIGH",
+    URGENT = "URGENT"
+}
+declare enum SupportConversationStatus {
+    OPEN = "OPEN",
+    CLOSED = "CLOSED",
+    PENDING = "PENDING"
+}
+declare enum SupportConversationMessageDeliveryStatus {
+    QUEUED = "QUEUED",
+    SENT = "SENT",
+    DELIVERED = "DELIVERED",
+    READ = "READ",
+    FAILED = "FAILED"
+}
+declare enum SupportConversationMessageAiAnalysisStatus {
+    PENDING = "PENDING",
+    PROCESSING = "PROCESSING",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED"
+}
+declare enum SupportConversationMessageDirection {
+    INBOUND = "INBOUND",
+    OUTBOUND = "OUTBOUND"
+}
+declare enum SupportConversationMessageSenderType {
+    CUSTOMER = "CUSTOMER",
+    ACCOUNT_USER = "ACCOUNT_USER",
+    ANONYMOUS = "ANONYMOUS",
+    SYSTEM = "SYSTEM",
+    AI = "AI"
+}
+interface SupportConversation {
+    id: string;
+    accountId: string;
+    subject?: string | null;
+    channel: SupportConversationChannel;
+    assigneeId?: string | null;
+    visibility: SupportConversationVisibility;
+    priority: SupportConversationPriority;
+    requiresMerchantAction: boolean;
+    requiresInternalAction: boolean;
+    customerId?: string | null;
+    customerName?: string | null;
+    customerLastname?: string | null;
+    customerEmail?: string | null;
+    customerPhone?: string | null;
+    status: SupportConversationStatus;
+    lastMessageAt?: Date | null;
+    unreadForAgent: number;
+    unreadForCustomer: number;
+    metadata?: Object | null;
+    aiSuggestion?: Object | null;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt?: Date | null;
+    account: Account;
+    customer: Customer | null;
+    messages: SupportConversationMessage[];
+}
+interface SupportConversationMessage {
+    id: string;
+    accountId: string;
+    conversationId: string;
+    direction: SupportConversationMessageDirection;
+    senderType: SupportConversationMessageSenderType;
+    senderId?: string | null;
+    body: string;
+    isAiGenerated: boolean;
+    isSystem: boolean;
+    deliveryStatus: SupportConversationMessageDeliveryStatus;
+    requiresAiAnalysis: boolean;
+    aiAnalysisStatus: SupportConversationMessageAiAnalysisStatus;
+    aiAnalyzedAt?: Date | null;
+    externalMessageId?: string | null;
+    externalThreadId?: string | null;
+    attachments?: Array<{
+        url: string;
+        type?: string;
+        name?: string;
+        sizeBytes?: number;
+    }>;
+    metadata?: Object | null;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt?: Date | null;
+}
+
+type CreateFulfillmentDto = {
+    accountId: string;
+    orderId: string;
+    accountBranchId: string;
+    carrier: string;
+    items: CreateFulfillmentItemDto[];
+    data?: Record<string, unknown>;
+};
+
+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, CartDeliveryType, type CartItem, type CartItemAddDto, type CartItemAttributeDetail, CartItemErrorCode, type CartItemRemoveDto, type CartItemUpdateDto, type CartItemValidation, CartSource, CartStatus, type CartUpdateDto, type CreateFulfillmentDto, Currency, type Customer, CustomerStatus, type CustomerUpsertDto, type Fulfillment, FulfillmentStatus, type Integration, IntegrationCategory, IntegrationStatus, type MapPosition, type Media, MediaType, type Order, type OrderCreateFromCartDto, OrderDeliveryType, type OrderItem, type OrderItemSnapshot, OrderPaymentStatus, OrderSource, OrderStatus, type Payment, PaymentMethodType, type PaymentProviderAdapter, type PaymentProviderContext, type PaymentProviderInitInput, type PaymentProviderInitOutput, type PaymentProviderKey, type PaymentProviderRefundInput, type PaymentProviderRefundOutput, type PaymentProviderWebhookResult, 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 SupportConversation, SupportConversationChannel, type SupportConversationMessage, SupportConversationMessageAiAnalysisStatus, SupportConversationMessageDeliveryStatus, SupportConversationMessageDirection, SupportConversationMessageSenderType, SupportConversationPriority, SupportConversationStatus, SupportConversationVisibility, type ThemeConfig, type WebhookPayload, getCurrencySymbol, getOrderStatusInfo, getProductStatusInfo };