@retaila/shared-types 1.1.29 → 1.1.31

package/dist/index.d.mts

@@ -49,6 +49,7 @@ interface Media {
 declare enum MediaType {
     IMAGE = "IMAGE",
     VIDEO = "VIDEO",
+    FAVICON = "FAVICON",
     DOCUMENT = "DOCUMENT",
     AUDIO = "AUDIO",
     ARCHIVE = "ARCHIVE",
@@ -75,6 +76,7 @@ declare function getCurrencySymbol(currencyCode: Currency): string;
 interface Account {
     id: string;
     name: string;
+    slug: string;
     address?: string;
     logoId?: string;
     currency: string;
@@ -534,6 +536,104 @@ type Fulfillment = {
     deletedAt?: Date;
 };
 
+declare enum PaymentStatus {
+    PENDING = "PENDING",// Pendiente
+    PREAUTHORIZED = "PREAUTHORIZED",
+    APPROVED = "APPROVED",// Pago aprobado online
+    PAID = "PAID",// Pago realizado por redes fisicas
+    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",// Pago reembolsado
+    ERROR = "ERROR"
+}
+declare enum PaymentMethodType {
+    BANK_TRANSFER = "BANK_TRANSFER",
+    CREDIT_CARD = "CREDIT_CARD",
+    DEBIT_CARD = "DEBIT_CARD",
+    MERCADOPAGO = "MERCADOPAGO",
+    PHYSICAL = "PHYSICAL",
+    INTERNATIONAL = "INTERNATIONAL",
+    PAYPAL = "PAYPAL",
+    CASH = "CASH",
+    OTHER = "OTHER"
+}
+interface Payment {
+    id: string;
+    accountId: string;
+    orderId: string;
+    invoiceId?: string;
+    gatewayPaymentId?: string;
+    referenceCode?: string;
+    paymentMethodType?: PaymentMethodType;
+    currency: Currency;
+    amount: number;
+    amountReceived: number;
+    amountRefunded: number;
+    paidAt?: string | Date;
+    refundedAt?: string | Date;
+    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;
+}
+type PaymentProviderKey = 'MERCADOPAGO' | 'MANUAL';
+interface PaymentProviderContext {
+    data: Record<string, unknown>;
+}
+interface PaymentProviderInitInput {
+    data: Record<string, any>;
+}
+interface PaymentProviderInitOutput {
+    data: Record<string, any>;
+    status: PaymentStatus;
+}
+interface PaymentProviderCaptureInput {
+    data: Record<string, any>;
+}
+interface PaymentProviderCaptureOutput {
+    data: Record<string, any>;
+}
+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>;
+    paymentDetails: {
+        method?: string;
+        last4?: string;
+    };
+}
+interface WebhookPayload {
+    provider: string;
+    accountId: string;
+    payload: {
+        query: Record<string, unknown>;
+        body: Record<string, unknown>;
+        headers: Record<string, unknown>;
+    };
+}
+interface PaymentProviderAdapter {
+    readonly key: PaymentProviderKey;
+    initPayment(input: PaymentProviderInitInput): Promise<PaymentProviderInitOutput>;
+    capture(input: PaymentProviderCaptureInput): Promise<PaymentProviderCaptureOutput>;
+    refund(input: PaymentProviderRefundInput): Promise<PaymentProviderRefundOutput>;
+    processWebhook(input: WebhookPayload['payload']): Promise<PaymentProviderWebhookResult>;
+}
+
+declare function getPaymentStatusInfo(status: PaymentStatus): StatusInfo;
+
 /**
  * Entidad Order
  * Define la orden de compra de un cliente en el sitio web.
@@ -649,6 +749,21 @@ interface OrderItemSnapshot {
     variantName?: string;
     media?: Media[];
 }
+type StatusByType = {
+    order: OrderStatus;
+    fulfillment: FulfillmentStatus;
+    payment: PaymentStatus;
+};
+type StatusFlow<T extends keyof StatusByType = keyof StatusByType> = {
+    type: T;
+    status: StatusByType[T];
+    doneAt: Date | null;
+};
+type NextStatusAction<T extends keyof StatusByType = keyof StatusByType> = {
+    type: T;
+    status: StatusByType[T];
+    text: string;
+};
 
 interface OrderCreateFromCartDto {
     cartId: string;
@@ -814,6 +929,7 @@ interface CartItem {
 }
 interface CartItemAttributeDetail {
     name: string;
+    alias: string;
     value: string;
     type?: string;
 }
@@ -835,100 +951,6 @@ declare enum CartDeliveryType {
     PICKUP = "pickup"
 }
 
-declare enum PaymentStatus {
-    PENDING = "PENDING",// Pendiente
-    PREAUTHORIZED = "PREAUTHORIZED",
-    APPROVED = "APPROVED",// Pago aprobado online
-    PAID = "PAID",// Pago realizado por redes fisicas
-    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",// Pago reembolsado
-    ERROR = "ERROR"
-}
-declare enum PaymentMethodType {
-    BANK_TRANSFER = "BANK_TRANSFER",
-    CREDIT_CARD = "CREDIT_CARD",
-    DEBIT_CARD = "DEBIT_CARD",
-    MERCADOPAGO = "MERCADOPAGO",
-    PHYSICAL = "PHYSICAL",
-    INTERNATIONAL = "INTERNATIONAL",
-    PAYPAL = "PAYPAL",
-    CASH = "CASH",
-    OTHER = "OTHER"
-}
-interface Payment {
-    id: string;
-    accountId: string;
-    orderId: string;
-    invoiceId?: string;
-    gatewayPaymentId?: string;
-    referenceCode?: string;
-    paymentMethodType?: PaymentMethodType;
-    currency: Currency;
-    amount: number;
-    amountReceived: number;
-    amountRefunded: number;
-    paidAt?: string | Date;
-    refundedAt?: string | Date;
-    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;
-}
-type PaymentProviderKey = 'MERCADOPAGO' | 'MANUAL';
-interface PaymentProviderContext {
-    data: Record<string, unknown>;
-}
-interface PaymentProviderInitInput {
-    data: Record<string, any>;
-}
-interface PaymentProviderInitOutput {
-    data: Record<string, any>;
-    status: PaymentStatus;
-}
-interface PaymentProviderCaptureInput {
-    data: Record<string, any>;
-}
-interface PaymentProviderCaptureOutput {
-    data: Record<string, any>;
-}
-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;
-    payload: {
-        query: Record<string, unknown>;
-        body: Record<string, unknown>;
-        headers: Record<string, unknown>;
-    };
-}
-interface PaymentProviderAdapter {
-    readonly key: PaymentProviderKey;
-    initPayment(input: PaymentProviderInitInput): Promise<PaymentProviderInitOutput>;
-    capture(input: PaymentProviderCaptureInput): Promise<PaymentProviderCaptureOutput>;
-    refund(input: PaymentProviderRefundInput): Promise<PaymentProviderRefundOutput>;
-    processWebhook(input: WebhookPayload['payload']): Promise<PaymentProviderWebhookResult>;
-}
-
-declare function getPaymentStatusInfo(status: PaymentStatus): StatusInfo;
-
 /**
  * Entidad ProductAttribute
  * Define los atributos disponibles que se pueden asignar a las variantes de producto (ej. Color, Talla).
@@ -1168,4 +1190,103 @@ type CreateFulfillmentDto = {
     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 PaymentProviderCaptureInput, type PaymentProviderCaptureOutput, 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, getPaymentStatusInfo, getProductStatusInfo };
+declare function getFulfillmentStatusInfo(status: FulfillmentStatus): StatusInfo;
+
+/**
+ * Entidad StoreCustomization
+ * Configuración de la tienda
+ */
+
+interface StoreCustomization {
+    id: string;
+    accountId: string;
+    layout: {
+        components: StoreCustomizationLayoutComponent[];
+    };
+    pages: StoreCustomizationPage[];
+    theme: {
+        colors: StoreCustomizationThemeColors;
+        typography: StoreCustomizationThemeTypography;
+        buttons: StoreCustomizationThemeButtons;
+    };
+    seo: StoreCustomizationSeo;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt?: Date | null;
+}
+interface StoreCustomizationLayoutComponent {
+    id: string;
+    type: string;
+    name: string;
+    version: string;
+    settings: StoreCustomizationComponentSettings;
+}
+interface StoreCustomizationPageComponent {
+    id: string;
+    type: string;
+    name: string;
+    version: string;
+    settings: StoreCustomizationComponentSettings;
+}
+interface StoreCustomizationPage {
+    id: string;
+    name: string;
+    path: string;
+    components: StoreCustomizationPageComponent[];
+}
+interface StoreCustomizationComponentSettings {
+    [key: string]: any;
+}
+interface StoreCustomizationThemeColors {
+    background: {
+        backgroundColor: string;
+    };
+    text: {
+        titleTextColor: string;
+        bodyTextColor: string;
+    };
+    theme: {
+        primaryColor: string;
+        secondaryColor: string;
+    };
+}
+interface StoreCustomizationThemeTypography {
+    headings: {
+        fontFamily: string;
+        fontSizeBase: number;
+        fontUppercase: boolean;
+    };
+    body: {
+        fontFamily: string;
+        fontSizeBase: number;
+        fontUppercase: boolean;
+    };
+}
+interface ButtonStyle {
+    backgroundColor: string;
+    textColor: string;
+    borderColor: string;
+    borderRadius: number;
+    shadow: string;
+    hoverBackgroundColor: string;
+    hoverTextColor: string;
+    hoverBorderColor: string;
+    hoverEffect: string;
+}
+interface StoreCustomizationThemeButtons {
+    primary: ButtonStyle;
+    secondary: ButtonStyle;
+    success: ButtonStyle;
+    danger: ButtonStyle;
+}
+interface StoreCustomizationSeo {
+    pageTitle: string;
+    pageDescription: string;
+    pageKeywords: string;
+    pageImageId?: string | null;
+    pageImage?: Media | null;
+    faviconId?: string | null;
+    favicon?: Media | null;
+}
+
+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 ButtonStyle, 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 NextStatusAction, type Order, type OrderCreateFromCartDto, OrderDeliveryType, type OrderItem, type OrderItemSnapshot, OrderPaymentStatus, OrderSource, OrderStatus, type Payment, PaymentMethodType, type PaymentProviderAdapter, type PaymentProviderCaptureInput, type PaymentProviderCaptureOutput, 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 StatusFlow, type StoreBanner, StoreBannerStatus, type StoreCustomization, type StoreCustomizationComponentSettings, type StoreCustomizationLayoutComponent, type StoreCustomizationPage, type StoreCustomizationPageComponent, type StoreCustomizationSeo, type StoreCustomizationThemeButtons, type StoreCustomizationThemeColors, type StoreCustomizationThemeTypography, type StorePage, StorePageStatus, StorePageType, type SupportConversation, SupportConversationChannel, type SupportConversationMessage, SupportConversationMessageAiAnalysisStatus, SupportConversationMessageDeliveryStatus, SupportConversationMessageDirection, SupportConversationMessageSenderType, SupportConversationPriority, SupportConversationStatus, SupportConversationVisibility, type ThemeConfig, type WebhookPayload, getCurrencySymbol, getFulfillmentStatusInfo, getOrderStatusInfo, getPaymentStatusInfo, getProductStatusInfo };