@merkaly/api 0.12.0 → 0.14.0

package/dist/finance/payment/payment.entity.d.ts

@@ -11,7 +11,7 @@ export declare class FinancePaymentEntity extends AbstractEntity implements ITra
     order: OrderEntity;
     amount: number;
     fee: number;
-    method?: FinancePaymentMethodEnum;
+    method?: FinancePaymentMethodEnum | null;
     status: FinancePaymentStatusEnum;
     history: StatusEntity<FinancePaymentStatusEnum>[];
     readonly number: string;

package/dist/finance/payment/payment.transition.js

@@ -3,7 +3,7 @@ import * as payment_enum_1 from './payment.enum.js';
 
 export class FinancePaymentTransition extends AbstractTransition {
   $states = {
-        [payment_enum_1.FinancePaymentStatusEnum.PENDING]: [payment_enum_1.FinancePaymentStatusEnum.CANCELLED],
+        [payment_enum_1.FinancePaymentStatusEnum.PENDING]: [payment_enum_1.FinancePaymentStatusEnum.PAID, payment_enum_1.FinancePaymentStatusEnum.CANCELLED],
         [payment_enum_1.FinancePaymentStatusEnum.PAID]: [],
         [payment_enum_1.FinancePaymentStatusEnum.CANCELLED]: [],
         [payment_enum_1.FinancePaymentStatusEnum.REFUNDED]: [],

package/dist/integration/supplier/address.d.ts

@@ -0,0 +1,17 @@
+export interface SupplierAddressCity {
+    name: string;
+}
+export interface SupplierAddressState {
+    code: string;
+    name: string;
+    cities: SupplierAddressCity[];
+}
+export interface SupplierAddressStatesResponse {
+    country: string;
+    states: Omit<SupplierAddressState, 'cities'>[];
+}
+export interface SupplierAddressCitiesResponse {
+    country: string;
+    state: string;
+    cities: SupplierAddressCity[];
+}

package/dist/integration/supplier/index.d.ts

@@ -5,3 +5,5 @@ export * from './request.validator';
 export * from './supplier.connection.entity';
 export * from './connection';
 export * from './quote';
+export * from './order';
+export * from './address';

package/dist/integration/supplier/order.d.ts

@@ -0,0 +1,41 @@
+import type { OrderSupplierOrderStatusEnum } from '../../order/purchase';
+export interface SupplierOrderLine {
+    externalProductId: string;
+    externalVariantId: string;
+    quantity: number;
+}
+export interface SupplierOrderRecipient {
+    name: string;
+    email: string;
+    phone: string;
+    document: string;
+    birthday?: string;
+}
+export interface SupplierOrderAddress {
+    postalCode: string;
+    street: string;
+    number: string;
+    complement?: string;
+    district: string;
+    city: string;
+    state: string;
+    country: string;
+}
+export interface SupplierOrderRequest {
+    reference: string;
+    lines: SupplierOrderLine[];
+    recipient: SupplierOrderRecipient;
+    address: SupplierOrderAddress;
+}
+export interface SupplierOrderPlacement {
+    externalOrderIds: string[];
+    status: OrderSupplierOrderStatusEnum;
+    warning?: string;
+}
+export interface SupplierOrderSnapshot {
+    status?: OrderSupplierOrderStatusEnum;
+    rawStatus: string;
+    trackingNumbers: string[];
+    carrier?: string;
+    trackingUrl?: string;
+}

package/dist/order/purchase/index.d.ts

@@ -3,3 +3,6 @@ export * from './purchase.enum';
 export * from './purchase.transition';
 export * from './request.validator';
 export * from './item.request.validator';
+export * from './purchase.supplier.order.entity';
+export * from './supplier.order.enum';
+export * from './supplier.order.request.validator';

package/dist/order/purchase/index.js

@@ -2,3 +2,5 @@ export * from './purchase.enum.js';
 export * from './purchase.transition.js';
 export * from './request.validator.js';
 export * from './item.request.validator.js';
+export * from './supplier.order.enum.js';
+export * from './supplier.order.request.validator.js';

package/dist/order/purchase/purchase.entity.d.ts

@@ -2,9 +2,12 @@ import { ContactVendorEntity } from '../../contact/vendor';
 import { ItemEntity } from '../item';
 import { TransactionEntity } from '../../transaction.entity.js';
 import { OrderPurchaseStatusEnum } from './purchase.enum.js';
+import { OrderPurchaseSupplierOrderEntity } from './purchase.supplier.order.entity.js';
 import type { OrderSaleEntity } from '../sale';
 export declare class OrderPurchaseEntity extends TransactionEntity<OrderPurchaseStatusEnum> {
     vendor?: ContactVendorEntity;
     customerOrder?: OrderSaleEntity;
     items: ItemEntity[];
+    freight?: number;
+    supplierOrder?: OrderPurchaseSupplierOrderEntity;
 }

package/dist/order/purchase/purchase.supplier.order.entity.d.ts

@@ -0,0 +1,24 @@
+import { SupplierProviderEnum } from '../../integration/supplier';
+import { OrderSupplierOrderStatusEnum } from './supplier.order.enum.js';
+export declare class OrderPurchaseSupplierOrderEntity {
+    provider: SupplierProviderEnum;
+    externalOrderIds: string[];
+    reference?: string;
+    status: OrderSupplierOrderStatusEnum;
+    rawStatus?: string;
+    placedAt: Date;
+    syncedAt?: Date;
+    trackingNumbers: string[];
+    carrier?: string;
+    trackingUrl?: string;
+    error?: string;
+}
+export declare const OrderPurchaseSupplierOrderSchema: import("mongoose").Schema<OrderPurchaseSupplierOrderEntity, import("mongoose").Model<OrderPurchaseSupplierOrderEntity, any, any, any, import("mongoose").Document<unknown, any, OrderPurchaseSupplierOrderEntity, any, {}> & OrderPurchaseSupplierOrderEntity & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, OrderPurchaseSupplierOrderEntity, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<OrderPurchaseSupplierOrderEntity>, {}, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & import("mongoose").FlatRecord<OrderPurchaseSupplierOrderEntity> & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}>;

package/dist/order/purchase/supplier.order.enum.d.ts

@@ -0,0 +1,11 @@
+export declare enum OrderSupplierOrderStatusEnum {
+    PLACED = "PLACED",
+    AWAITING_PAYMENT = "AWAITING_PAYMENT",
+    PAID = "PAID",
+    SHIPPED = "SHIPPED",
+    DELIVERED = "DELIVERED",
+    CANCELLED = "CANCELLED",
+    FAILED = "FAILED"
+}
+export declare const SUPPLIER_ORDER_PROGRESS: readonly OrderSupplierOrderStatusEnum[];
+export declare const SUPPLIER_ORDER_SYNCABLE_STATUSES: readonly OrderSupplierOrderStatusEnum[];

package/dist/order/purchase/supplier.order.enum.js

@@ -0,0 +1,23 @@
+export var OrderSupplierOrderStatusEnum;
+(function (OrderSupplierOrderStatusEnum) {
+    OrderSupplierOrderStatusEnum["PLACED"] = "PLACED";
+    OrderSupplierOrderStatusEnum["AWAITING_PAYMENT"] = "AWAITING_PAYMENT";
+    OrderSupplierOrderStatusEnum["PAID"] = "PAID";
+    OrderSupplierOrderStatusEnum["SHIPPED"] = "SHIPPED";
+    OrderSupplierOrderStatusEnum["DELIVERED"] = "DELIVERED";
+    OrderSupplierOrderStatusEnum["CANCELLED"] = "CANCELLED";
+    OrderSupplierOrderStatusEnum["FAILED"] = "FAILED";
+})(OrderSupplierOrderStatusEnum || (OrderSupplierOrderStatusEnum = {}));
+export const SUPPLIER_ORDER_PROGRESS = [
+    OrderSupplierOrderStatusEnum.PLACED,
+    OrderSupplierOrderStatusEnum.AWAITING_PAYMENT,
+    OrderSupplierOrderStatusEnum.PAID,
+    OrderSupplierOrderStatusEnum.SHIPPED,
+    OrderSupplierOrderStatusEnum.DELIVERED,
+];
+export const SUPPLIER_ORDER_SYNCABLE_STATUSES = [
+    OrderSupplierOrderStatusEnum.PLACED,
+    OrderSupplierOrderStatusEnum.AWAITING_PAYMENT,
+    OrderSupplierOrderStatusEnum.PAID,
+    OrderSupplierOrderStatusEnum.SHIPPED,
+];

package/dist/order/purchase/supplier.order.request.validator.d.ts

@@ -0,0 +1,7 @@
+import { AbstractRequestValidator } from '../../abstract.validator.js';
+export declare class PlaceSupplierOrderRequestValidator extends AbstractRequestValidator {
+    recipientBirthday?: string;
+}
+export declare class RegisterSupplierOrderRequestValidator extends AbstractRequestValidator {
+    externalOrderId: string;
+}

package/dist/order/purchase/supplier.order.request.validator.js

@@ -0,0 +1,28 @@
+import 'reflect-metadata';
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import * as class_validator_1 from "class-validator";
+import * as abstract_validator_1 from '../../abstract.validator.js';
+import * as shipping_request_validator_1 from '../sale/index.js';
+export class PlaceSupplierOrderRequestValidator extends abstract_validator_1.AbstractRequestValidator {
+    recipientBirthday;
+}
+__decorate([
+    (0, shipping_request_validator_1.IsBirthday)(),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", String)
+], PlaceSupplierOrderRequestValidator.prototype, "recipientBirthday", void 0);
+export class RegisterSupplierOrderRequestValidator extends abstract_validator_1.AbstractRequestValidator {
+    externalOrderId;
+}
+__decorate([
+    (0, class_validator_1.Matches)(/^\d{6,25}$/, { message: 'externalOrderId must be the numeric supplier order id' }),
+    __metadata("design:type", String)
+], RegisterSupplierOrderRequestValidator.prototype, "externalOrderId", void 0);

package/dist/order/sale/checkout.d.ts

@@ -0,0 +1,27 @@
+export interface CheckoutQuoteShipping {
+    available: boolean;
+    amount: number;
+    method?: string;
+    deliveryDays?: {
+        max?: number;
+        min?: number;
+    };
+    issue?: string;
+}
+export interface CheckoutQuoteItem {
+    product: string;
+    variant: string;
+    quantity: number;
+    unitPrice: number;
+    total: number;
+    shipping: CheckoutQuoteShipping;
+}
+export interface CheckoutQuote {
+    currency: string;
+    available: boolean;
+    issues: string[];
+    items: CheckoutQuoteItem[];
+    subtotal: number;
+    shipping: number;
+    total: number;
+}

package/dist/order/sale/fulfillment.d.ts

@@ -0,0 +1,59 @@
+import type { FinancePaymentStatusEnum } from '../../finance/payment';
+import type { OrderFulfillmentActionEnum, OrderFulfillmentStageEnum, OrderSaleCostSourceEnum, OrderSaleHistoryEventEnum } from './fulfillment.enum.js';
+import type { OrderSupplierOrderStatusEnum } from '../purchase';
+export interface OrderSaleCosts {
+    products: number;
+    freight: number;
+    total: number;
+}
+export interface OrderSaleEstimate extends OrderSaleCosts {
+    profit: number;
+    margin: number | null;
+}
+export interface OrderSaleItemSummary {
+    item: string;
+    variant: string | null;
+    quantity: number;
+    unitPrice: number;
+    unitCost: number;
+    total: number;
+    cost: number;
+    profit: number;
+}
+export interface OrderSaleHistoryEntry {
+    at: string;
+    type: OrderSaleHistoryEventEnum;
+    purchase?: string;
+    status?: OrderSupplierOrderStatusEnum;
+}
+export interface OrderSaleSummary {
+    currency: string;
+    revenue: {
+        subtotal: number;
+        shipping: number;
+        total: number;
+    };
+    costs: OrderSaleCosts & {
+        source: OrderSaleCostSourceEnum;
+    };
+    profit: number;
+    margin: number | null;
+    estimate: OrderSaleEstimate;
+    variance: number | null;
+    items: OrderSaleItemSummary[];
+    history: OrderSaleHistoryEntry[];
+    warnings: string[];
+    payment: {
+        status: FinancePaymentStatusEnum | null;
+    };
+    fulfillment: {
+        stage: OrderFulfillmentStageEnum;
+    };
+    nextActions: OrderFulfillmentActionEnum[];
+}
+export interface OrderBuyerFulfillment {
+    stage: OrderFulfillmentStageEnum;
+    trackingNumbers: string[];
+    carrier?: string;
+    trackingUrl?: string;
+}

package/dist/order/sale/fulfillment.enum.d.ts

@@ -0,0 +1,34 @@
+export declare enum OrderFulfillmentStageEnum {
+    AWAITING_PAYMENT = "AWAITING_PAYMENT",
+    TO_ORDER = "TO_ORDER",
+    ORDERED = "ORDERED",
+    SHIPPED = "SHIPPED",
+    DELIVERED = "DELIVERED",
+    CANCELLED = "CANCELLED"
+}
+export declare enum OrderFulfillmentActionEnum {
+    CONFIRM_PAYMENT = "CONFIRM_PAYMENT",
+    PROCURE = "PROCURE",
+    PLACE_SUPPLIER_ORDER = "PLACE_SUPPLIER_ORDER",
+    PAY_SUPPLIER_ORDER = "PAY_SUPPLIER_ORDER",
+    SYNC_SUPPLIER_ORDER = "SYNC_SUPPLIER_ORDER",
+    NONE = "NONE"
+}
+export declare enum OrderSaleCostSourceEnum {
+    ESTIMATED = "ESTIMATED",
+    CONFIRMED = "CONFIRMED"
+}
+export declare enum OrderSaleHistoryEventEnum {
+    CREATED = "CREATED",
+    PAYMENT_CONFIRMED = "PAYMENT_CONFIRMED",
+    PAYMENT_CANCELLED = "PAYMENT_CANCELLED",
+    PAYMENT_REFUNDED = "PAYMENT_REFUNDED",
+    SALE_IN_PROGRESS = "SALE_IN_PROGRESS",
+    SALE_COMPLETED = "SALE_COMPLETED",
+    SALE_CANCELLED = "SALE_CANCELLED",
+    SALE_RETURNED = "SALE_RETURNED",
+    PURCHASE_CREATED = "PURCHASE_CREATED",
+    PURCHASE_CANCELLED = "PURCHASE_CANCELLED",
+    SUPPLIER_ORDER_PLACED = "SUPPLIER_ORDER_PLACED",
+    SUPPLIER_ORDER_SYNCED = "SUPPLIER_ORDER_SYNCED"
+}

package/dist/order/sale/fulfillment.enum.js

@@ -0,0 +1,38 @@
+export var OrderFulfillmentStageEnum;
+(function (OrderFulfillmentStageEnum) {
+    OrderFulfillmentStageEnum["AWAITING_PAYMENT"] = "AWAITING_PAYMENT";
+    OrderFulfillmentStageEnum["TO_ORDER"] = "TO_ORDER";
+    OrderFulfillmentStageEnum["ORDERED"] = "ORDERED";
+    OrderFulfillmentStageEnum["SHIPPED"] = "SHIPPED";
+    OrderFulfillmentStageEnum["DELIVERED"] = "DELIVERED";
+    OrderFulfillmentStageEnum["CANCELLED"] = "CANCELLED";
+})(OrderFulfillmentStageEnum || (OrderFulfillmentStageEnum = {}));
+export var OrderFulfillmentActionEnum;
+(function (OrderFulfillmentActionEnum) {
+    OrderFulfillmentActionEnum["CONFIRM_PAYMENT"] = "CONFIRM_PAYMENT";
+    OrderFulfillmentActionEnum["PROCURE"] = "PROCURE";
+    OrderFulfillmentActionEnum["PLACE_SUPPLIER_ORDER"] = "PLACE_SUPPLIER_ORDER";
+    OrderFulfillmentActionEnum["PAY_SUPPLIER_ORDER"] = "PAY_SUPPLIER_ORDER";
+    OrderFulfillmentActionEnum["SYNC_SUPPLIER_ORDER"] = "SYNC_SUPPLIER_ORDER";
+    OrderFulfillmentActionEnum["NONE"] = "NONE";
+})(OrderFulfillmentActionEnum || (OrderFulfillmentActionEnum = {}));
+export var OrderSaleCostSourceEnum;
+(function (OrderSaleCostSourceEnum) {
+    OrderSaleCostSourceEnum["ESTIMATED"] = "ESTIMATED";
+    OrderSaleCostSourceEnum["CONFIRMED"] = "CONFIRMED";
+})(OrderSaleCostSourceEnum || (OrderSaleCostSourceEnum = {}));
+export var OrderSaleHistoryEventEnum;
+(function (OrderSaleHistoryEventEnum) {
+    OrderSaleHistoryEventEnum["CREATED"] = "CREATED";
+    OrderSaleHistoryEventEnum["PAYMENT_CONFIRMED"] = "PAYMENT_CONFIRMED";
+    OrderSaleHistoryEventEnum["PAYMENT_CANCELLED"] = "PAYMENT_CANCELLED";
+    OrderSaleHistoryEventEnum["PAYMENT_REFUNDED"] = "PAYMENT_REFUNDED";
+    OrderSaleHistoryEventEnum["SALE_IN_PROGRESS"] = "SALE_IN_PROGRESS";
+    OrderSaleHistoryEventEnum["SALE_COMPLETED"] = "SALE_COMPLETED";
+    OrderSaleHistoryEventEnum["SALE_CANCELLED"] = "SALE_CANCELLED";
+    OrderSaleHistoryEventEnum["SALE_RETURNED"] = "SALE_RETURNED";
+    OrderSaleHistoryEventEnum["PURCHASE_CREATED"] = "PURCHASE_CREATED";
+    OrderSaleHistoryEventEnum["PURCHASE_CANCELLED"] = "PURCHASE_CANCELLED";
+    OrderSaleHistoryEventEnum["SUPPLIER_ORDER_PLACED"] = "SUPPLIER_ORDER_PLACED";
+    OrderSaleHistoryEventEnum["SUPPLIER_ORDER_SYNCED"] = "SUPPLIER_ORDER_SYNCED";
+})(OrderSaleHistoryEventEnum || (OrderSaleHistoryEventEnum = {}));

package/dist/order/sale/index.d.ts

@@ -7,4 +7,10 @@ export * from './item.request.validator';
 export * from './procurement';
 export * from './procurement.request.validator';
 export * from './shipping.request.validator';
+export * from './shipping.update.request.validator';
 export * from './checkout.request.validator';
+export * from './payment.confirm.request.validator';
+export * from './fulfillment.enum';
+export * from './fulfillment';
+export * from './quote.request.validator';
+export * from './checkout';

package/dist/order/sale/index.js

@@ -4,4 +4,8 @@ export * from './request.validator.js';
 export * from './item.request.validator.js';
 export * from './procurement.request.validator.js';
 export * from './shipping.request.validator.js';
+export * from './shipping.update.request.validator.js';
 export * from './checkout.request.validator.js';
+export * from './payment.confirm.request.validator.js';
+export * from './fulfillment.enum.js';
+export * from './quote.request.validator.js';

package/dist/order/sale/payment.confirm.request.validator.d.ts

@@ -0,0 +1,5 @@
+import { FinancePaymentMethodEnum } from '../../finance/payment';
+import { AbstractRequestValidator } from '../../abstract.validator.js';
+export declare class ConfirmSalePaymentRequestValidator extends AbstractRequestValidator {
+    method: FinancePaymentMethodEnum;
+}

package/dist/order/sale/payment.confirm.request.validator.js

@@ -0,0 +1,21 @@
+import 'reflect-metadata';
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import * as class_validator_1 from "class-validator";
+import * as payment_enum_1 from '../../finance/payment/index.js';
+import * as abstract_validator_1 from '../../abstract.validator.js';
+export class ConfirmSalePaymentRequestValidator extends abstract_validator_1.AbstractRequestValidator {
+    method;
+}
+__decorate([
+    (0, class_validator_1.IsEnum)(payment_enum_1.FinancePaymentMethodEnum),
+    (0, class_validator_1.IsDefined)(),
+    __metadata("design:type", String)
+], ConfirmSalePaymentRequestValidator.prototype, "method", void 0);

package/dist/order/sale/procurement.d.ts

@@ -26,6 +26,7 @@ export interface ProcurementGroup {
     items: ProcurementLine[];
     totals: {
         retail: number;
+        shipping: number;
         cost: number;
         freight: number;
         margin: number;

package/dist/order/sale/quote.request.validator.d.ts

@@ -0,0 +1,10 @@
+import { AbstractRequestValidator } from '../../abstract.validator.js';
+import { CheckoutItemRequestValidator } from './checkout.request.validator.js';
+export declare class CheckoutQuoteDestinationRequestValidator extends AbstractRequestValidator {
+    postalCode: string;
+    country: string;
+}
+export declare class CheckoutQuoteRequestValidator extends AbstractRequestValidator {
+    items: CheckoutItemRequestValidator[];
+    destination: CheckoutQuoteDestinationRequestValidator;
+}

package/dist/order/sale/quote.request.validator.js

@@ -0,0 +1,47 @@
+import 'reflect-metadata';
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import * as class_transformer_1 from "class-transformer";
+import * as class_validator_1 from "class-validator";
+import * as abstract_validator_1 from '../../abstract.validator.js';
+import * as checkout_request_validator_1 from './checkout.request.validator.js';
+export class CheckoutQuoteDestinationRequestValidator extends abstract_validator_1.AbstractRequestValidator {
+    postalCode;
+    country;
+}
+__decorate([
+    (0, class_validator_1.Matches)(/^\d{8}$/, { message: '$property must be a CEP with 8 digits' }),
+    (0, class_transformer_1.Transform)(({ value }) => (typeof value === 'string' ? value.replace(/\D/g, '') : value)),
+    __metadata("design:type", String)
+], CheckoutQuoteDestinationRequestValidator.prototype, "postalCode", void 0);
+__decorate([
+    (0, class_validator_1.IsISO31661Alpha2)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_transformer_1.Transform)(({ value }) => (typeof value === 'string' ? value.trim().toUpperCase() : value)),
+    __metadata("design:type", String)
+], CheckoutQuoteDestinationRequestValidator.prototype, "country", void 0);
+export class CheckoutQuoteRequestValidator extends abstract_validator_1.AbstractRequestValidator {
+    items = [];
+    destination = new CheckoutQuoteDestinationRequestValidator();
+}
+__decorate([
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ArrayNotEmpty)(),
+    (0, class_validator_1.ArrayMaxSize)(50),
+    (0, class_transformer_1.Type)(() => checkout_request_validator_1.CheckoutItemRequestValidator),
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    __metadata("design:type", Array)
+], CheckoutQuoteRequestValidator.prototype, "items", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_transformer_1.Type)(() => CheckoutQuoteDestinationRequestValidator),
+    (0, class_validator_1.ValidateNested)(),
+    __metadata("design:type", Object)
+], CheckoutQuoteRequestValidator.prototype, "destination", void 0);

package/dist/order/sale/sale.shipping.entity.d.ts

@@ -1,10 +1,12 @@
+import { Schema as MongoSchema } from 'mongoose';
 export declare class OrderSaleShippingRecipientEntity {
     name: string;
     email: string;
     phone: string;
     document: string;
+    birthday?: string;
 }
-export declare const OrderSaleShippingRecipientSchema: import("mongoose").Schema<OrderSaleShippingRecipientEntity, import("mongoose").Model<OrderSaleShippingRecipientEntity, any, any, any, import("mongoose").Document<unknown, any, OrderSaleShippingRecipientEntity, any, {}> & OrderSaleShippingRecipientEntity & {
+export declare const OrderSaleShippingRecipientSchema: MongoSchema<OrderSaleShippingRecipientEntity, import("mongoose").Model<OrderSaleShippingRecipientEntity, any, any, any, import("mongoose").Document<unknown, any, OrderSaleShippingRecipientEntity, any, {}> & OrderSaleShippingRecipientEntity & {
     _id: import("mongoose").Types.ObjectId;
 } & {
     __v: number;
@@ -23,7 +25,7 @@ export declare class OrderSaleShippingAddressEntity {
     state: string;
     country: string;
 }
-export declare const OrderSaleShippingAddressSchema: import("mongoose").Schema<OrderSaleShippingAddressEntity, import("mongoose").Model<OrderSaleShippingAddressEntity, any, any, any, import("mongoose").Document<unknown, any, OrderSaleShippingAddressEntity, any, {}> & OrderSaleShippingAddressEntity & {
+export declare const OrderSaleShippingAddressSchema: MongoSchema<OrderSaleShippingAddressEntity, import("mongoose").Model<OrderSaleShippingAddressEntity, any, any, any, import("mongoose").Document<unknown, any, OrderSaleShippingAddressEntity, any, {}> & OrderSaleShippingAddressEntity & {
     _id: import("mongoose").Types.ObjectId;
 } & {
     __v: number;
@@ -32,11 +34,42 @@ export declare const OrderSaleShippingAddressSchema: import("mongoose").Schema<O
 } & {
     __v: number;
 }>;
+export declare class OrderSaleShippingDaysEntity {
+    min?: number;
+    max?: number;
+}
+export declare const OrderSaleShippingDaysSchema: MongoSchema<OrderSaleShippingDaysEntity, import("mongoose").Model<OrderSaleShippingDaysEntity, any, any, any, import("mongoose").Document<unknown, any, OrderSaleShippingDaysEntity, any, {}> & OrderSaleShippingDaysEntity & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, OrderSaleShippingDaysEntity, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<OrderSaleShippingDaysEntity>, {}, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & import("mongoose").FlatRecord<OrderSaleShippingDaysEntity> & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}>;
+export declare class OrderSaleShippingLineEntity {
+    variant: string;
+    amount: number;
+    method?: string;
+    deliveryDays?: OrderSaleShippingDaysEntity;
+}
+export declare const OrderSaleShippingLineSchema: MongoSchema<OrderSaleShippingLineEntity, import("mongoose").Model<OrderSaleShippingLineEntity, any, any, any, import("mongoose").Document<unknown, any, OrderSaleShippingLineEntity, any, {}> & OrderSaleShippingLineEntity & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, OrderSaleShippingLineEntity, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<OrderSaleShippingLineEntity>, {}, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & import("mongoose").FlatRecord<OrderSaleShippingLineEntity> & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}>;
 export declare class OrderSaleShippingEntity {
     recipient: OrderSaleShippingRecipientEntity;
     address: OrderSaleShippingAddressEntity;
+    fee?: number;
+    quotedAt?: Date;
+    lines?: OrderSaleShippingLineEntity[];
 }
-export declare const OrderSaleShippingSchema: import("mongoose").Schema<OrderSaleShippingEntity, import("mongoose").Model<OrderSaleShippingEntity, any, any, any, import("mongoose").Document<unknown, any, OrderSaleShippingEntity, any, {}> & OrderSaleShippingEntity & {
+export declare const OrderSaleShippingSchema: MongoSchema<OrderSaleShippingEntity, import("mongoose").Model<OrderSaleShippingEntity, any, any, any, import("mongoose").Document<unknown, any, OrderSaleShippingEntity, any, {}> & OrderSaleShippingEntity & {
     _id: import("mongoose").Types.ObjectId;
 } & {
     __v: number;

package/dist/order/sale/sale.transition.js

@@ -3,8 +3,8 @@ import * as sale_enum_1 from './sale.enum.js';
 
 export class OrderSaleTransition extends AbstractTransition {
   $states = {
-        [sale_enum_1.OrderSaleStatusEnum.OPEN]: [],
-        [sale_enum_1.OrderSaleStatusEnum.IN_PROGRESS]: [],
+        [sale_enum_1.OrderSaleStatusEnum.OPEN]: [sale_enum_1.OrderSaleStatusEnum.IN_PROGRESS, sale_enum_1.OrderSaleStatusEnum.CANCELLED],
+        [sale_enum_1.OrderSaleStatusEnum.IN_PROGRESS]: [sale_enum_1.OrderSaleStatusEnum.COMPLETED, sale_enum_1.OrderSaleStatusEnum.CANCELLED],
         [sale_enum_1.OrderSaleStatusEnum.COMPLETED]: [],
         [sale_enum_1.OrderSaleStatusEnum.CANCELLED]: [],
         [sale_enum_1.OrderSaleStatusEnum.RETURNED]: [],

package/dist/order/sale/shipping.request.validator.d.ts

@@ -1,12 +1,29 @@
 import { AbstractRequestValidator } from '../../abstract.validator.js';
 import type { OrderSaleShippingEntity } from './sale.shipping.entity.js';
 export declare const BRAZIL_STATES: string[];
+export declare const trim: ({ value }: {
+    value: unknown;
+}) => unknown;
+export declare const digits: ({ value }: {
+    value: unknown;
+}) => unknown;
+export declare const upper: ({ value }: {
+    value: unknown;
+}) => unknown;
 export declare function isCpf(value: unknown): boolean;
+export declare function IsCpf(): PropertyDecorator;
+export declare const BIRTHDAY_MIN_AGE = 16;
+export declare const BIRTHDAY_MAX_AGE = 120;
+export declare function isBirthday(value: unknown, today?: Date): boolean;
+export declare function IsBirthday(): PropertyDecorator;
+export declare const FULL_NAME_MESSAGE = "recipient.name must be the full name as registered in the CPF";
+export declare function isFullName(value: unknown): boolean;
 export declare class SaleShippingRecipientRequestValidator extends AbstractRequestValidator {
     name: string;
     email: string;
     phone: string;
     document: string;
+    birthday?: string;
 }
 export declare class SaleShippingAddressRequestValidator extends AbstractRequestValidator {
     postalCode: string;

package/dist/order/sale/shipping.request.validator.js

@@ -40,7 +40,7 @@ export const BRAZIL_STATES = [
     'SP',
     'TO',
 ];
-const trim = ({ value }) => (typeof value === 'string' ? value.trim() : value);
+const trim = ({ value }) => typeof value === 'string' ? value.trim() : value;
 const digits = ({ value }) => typeof value === 'string' ? value.replace(/\D/g, '') : value;
 const upper = ({ value }) => typeof value === 'string' ? value.trim().toUpperCase() : value;
 export function isCpf(value) {
@@ -56,7 +56,7 @@ export function isCpf(value) {
     };
     return digit(9) === Number(value[9]) && digit(10) === Number(value[10]);
 }
-function IsCpf() {
+export function IsCpf() {
     return (0, class_validator_1.ValidateBy)({
         name: 'isCpf',
         validator: {
@@ -65,11 +65,67 @@ function IsCpf() {
         },
     });
 }
+export const BIRTHDAY_MIN_AGE = 16;
+export const BIRTHDAY_MAX_AGE = 120;
+export function isBirthday(value, today = new Date()) {
+    const [, y, m, d] = (typeof value === 'string' && value.match(/^(\d{4})-(\d{2})-(\d{2})$/)) || [];
+    if (!y)
+        return false;
+    const [year, month, day] = [Number(y), Number(m), Number(d)];
+    const date = new Date(Date.UTC(year, month - 1, day));
+    if (date.getUTCFullYear() !== year ||
+        date.getUTCMonth() !== month - 1 ||
+        date.getUTCDate() !== day) {
+        return false;
+    }
+    const birthdayPassed = today.getUTCMonth() > month - 1 ||
+        (today.getUTCMonth() === month - 1 && today.getUTCDate() >= day);
+    const age = today.getUTCFullYear() - year - (birthdayPassed ? 0 : 1);
+    return age >= BIRTHDAY_MIN_AGE && age <= BIRTHDAY_MAX_AGE;
+}
+export function IsBirthday() {
+    return (0, class_validator_1.ValidateBy)({
+        name: 'isBirthday',
+        validator: {
+            defaultMessage: () => `$property must be a real date (YYYY-MM-DD) of someone aged ${BIRTHDAY_MIN_AGE} to ${BIRTHDAY_MAX_AGE}`,
+            validate: (value) => isBirthday(value),
+        },
+    });
+}
+function BirthdayForBrazil() {
+    return (0, class_validator_1.ValidateBy)({
+        name: 'birthdayForBrazil',
+        validator: {
+            defaultMessage: () => 'recipient.birthday is required for deliveries to Brazil',
+            validate: (recipient, args) => {
+                const { address } = args.object;
+                return address?.country !== 'BR' || Boolean(recipient?.birthday);
+            },
+        },
+    });
+}
+export const FULL_NAME_MESSAGE = 'recipient.name must be the full name as registered in the CPF';
+export function isFullName(value) {
+    return typeof value === 'string' && value.trim().split(/\s+/).filter(Boolean).length >= 2;
+}
+function FullNameForBrazil() {
+    return (0, class_validator_1.ValidateBy)({
+        name: 'fullNameForBrazil',
+        validator: {
+            defaultMessage: () => FULL_NAME_MESSAGE,
+            validate: (recipient, args) => {
+                const { address } = args.object;
+                return address?.country !== 'BR' || isFullName(recipient?.name);
+            },
+        },
+    });
+}
 export class SaleShippingRecipientRequestValidator extends abstract_validator_1.AbstractRequestValidator {
     name;
     email;
     phone;
     document;
+    birthday;
 }
 __decorate([
     (0, class_validator_1.IsString)(),
@@ -93,6 +149,12 @@ __decorate([
     (0, class_transformer_1.Transform)(digits),
     __metadata("design:type", String)
 ], SaleShippingRecipientRequestValidator.prototype, "document", void 0);
+__decorate([
+    IsBirthday(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_transformer_1.Transform)(trim),
+    __metadata("design:type", String)
+], SaleShippingRecipientRequestValidator.prototype, "birthday", void 0);
 export class SaleShippingAddressRequestValidator extends abstract_validator_1.AbstractRequestValidator {
     postalCode;
     street;
@@ -164,6 +226,8 @@ export class SaleShippingRequestValidator extends abstract_validator_1.AbstractR
 }
 __decorate([
     (0, class_validator_1.IsDefined)(),
+    BirthdayForBrazil(),
+    FullNameForBrazil(),
     (0, class_transformer_1.Type)(() => SaleShippingRecipientRequestValidator),
     (0, class_validator_1.ValidateNested)(),
     __metadata("design:type", Object)

package/dist/order/sale/shipping.update.request.validator.d.ts

@@ -0,0 +1,22 @@
+import { AbstractRequestValidator } from '../../abstract.validator.js';
+export declare class UpdateSaleShippingRecipientRequestValidator extends AbstractRequestValidator {
+    name?: string;
+    email?: string;
+    phone?: string;
+    document?: string;
+    birthday?: string;
+}
+export declare class UpdateSaleShippingAddressRequestValidator extends AbstractRequestValidator {
+    postalCode?: string;
+    street?: string;
+    number?: string;
+    complement?: string | null;
+    district?: string;
+    city?: string;
+    state?: string;
+}
+export declare class UpdateSaleShippingRequestValidator extends AbstractRequestValidator {
+    recipient?: UpdateSaleShippingRecipientRequestValidator;
+    address?: UpdateSaleShippingAddressRequestValidator;
+    updateCustomer?: boolean;
+}

package/dist/order/sale/shipping.update.request.validator.js

@@ -0,0 +1,139 @@
+import 'reflect-metadata';
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import * as class_transformer_1 from "class-transformer";
+import * as class_validator_1 from "class-validator";
+import * as abstract_validator_1 from '../../abstract.validator.js';
+import * as shipping_request_validator_1 from './shipping.request.validator.js';
+const Sent = () => (0, class_validator_1.ValidateIf)((_, value) => value !== undefined);
+const optionalText = ({ value }) => {
+    if (value === null)
+        return null;
+    if (typeof value !== 'string')
+        return value;
+    return value.trim() || null;
+};
+export class UpdateSaleShippingRecipientRequestValidator extends abstract_validator_1.AbstractRequestValidator {
+    name;
+    email;
+    phone;
+    document;
+    birthday;
+}
+__decorate([
+    Sent(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.Length)(2, 120),
+    (0, class_transformer_1.Transform)(shipping_request_validator_1.trim),
+    __metadata("design:type", String)
+], UpdateSaleShippingRecipientRequestValidator.prototype, "name", void 0);
+__decorate([
+    Sent(),
+    (0, class_validator_1.IsEmail)(),
+    (0, class_validator_1.Length)(3, 254),
+    (0, class_transformer_1.Transform)(({ value }) => (typeof value === 'string' ? value.trim().toLowerCase() : value)),
+    __metadata("design:type", String)
+], UpdateSaleShippingRecipientRequestValidator.prototype, "email", void 0);
+__decorate([
+    Sent(),
+    (0, class_validator_1.Matches)(/^(55)?\d{10,11}$/, { message: '$property must be a Brazilian phone with area code' }),
+    (0, class_transformer_1.Transform)(shipping_request_validator_1.digits),
+    __metadata("design:type", String)
+], UpdateSaleShippingRecipientRequestValidator.prototype, "phone", void 0);
+__decorate([
+    Sent(),
+    (0, shipping_request_validator_1.IsCpf)(),
+    (0, class_transformer_1.Transform)(shipping_request_validator_1.digits),
+    __metadata("design:type", String)
+], UpdateSaleShippingRecipientRequestValidator.prototype, "document", void 0);
+__decorate([
+    Sent(),
+    (0, shipping_request_validator_1.IsBirthday)(),
+    (0, class_transformer_1.Transform)(shipping_request_validator_1.trim),
+    __metadata("design:type", String)
+], UpdateSaleShippingRecipientRequestValidator.prototype, "birthday", void 0);
+export class UpdateSaleShippingAddressRequestValidator extends abstract_validator_1.AbstractRequestValidator {
+    postalCode;
+    street;
+    number;
+    complement;
+    district;
+    city;
+    state;
+}
+__decorate([
+    Sent(),
+    (0, class_validator_1.Matches)(/^\d{8}$/, { message: '$property must be a CEP with 8 digits' }),
+    (0, class_transformer_1.Transform)(shipping_request_validator_1.digits),
+    __metadata("design:type", String)
+], UpdateSaleShippingAddressRequestValidator.prototype, "postalCode", void 0);
+__decorate([
+    Sent(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.Length)(2, 200),
+    (0, class_transformer_1.Transform)(shipping_request_validator_1.trim),
+    __metadata("design:type", String)
+], UpdateSaleShippingAddressRequestValidator.prototype, "street", void 0);
+__decorate([
+    Sent(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.Length)(1, 20),
+    (0, class_transformer_1.Transform)(shipping_request_validator_1.trim),
+    __metadata("design:type", String)
+], UpdateSaleShippingAddressRequestValidator.prototype, "number", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.Length)(0, 120),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_transformer_1.Transform)(optionalText),
+    __metadata("design:type", String)
+], UpdateSaleShippingAddressRequestValidator.prototype, "complement", void 0);
+__decorate([
+    Sent(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.Length)(2, 120),
+    (0, class_transformer_1.Transform)(shipping_request_validator_1.trim),
+    __metadata("design:type", String)
+], UpdateSaleShippingAddressRequestValidator.prototype, "district", void 0);
+__decorate([
+    Sent(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.Length)(2, 120),
+    (0, class_transformer_1.Transform)(shipping_request_validator_1.trim),
+    __metadata("design:type", String)
+], UpdateSaleShippingAddressRequestValidator.prototype, "city", void 0);
+__decorate([
+    Sent(),
+    (0, class_validator_1.IsIn)(shipping_request_validator_1.BRAZIL_STATES, { message: '$property must be a Brazilian UF' }),
+    (0, class_transformer_1.Transform)(shipping_request_validator_1.upper),
+    __metadata("design:type", String)
+], UpdateSaleShippingAddressRequestValidator.prototype, "state", void 0);
+export class UpdateSaleShippingRequestValidator extends abstract_validator_1.AbstractRequestValidator {
+    recipient;
+    address;
+    updateCustomer;
+}
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_transformer_1.Type)(() => UpdateSaleShippingRecipientRequestValidator),
+    (0, class_validator_1.ValidateNested)(),
+    __metadata("design:type", UpdateSaleShippingRecipientRequestValidator)
+], UpdateSaleShippingRequestValidator.prototype, "recipient", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_transformer_1.Type)(() => UpdateSaleShippingAddressRequestValidator),
+    (0, class_validator_1.ValidateNested)(),
+    __metadata("design:type", UpdateSaleShippingAddressRequestValidator)
+], UpdateSaleShippingRequestValidator.prototype, "address", void 0);
+__decorate([
+    (0, class_validator_1.IsBoolean)(),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Boolean)
+], UpdateSaleShippingRequestValidator.prototype, "updateCustomer", void 0);

package/dist/transaction.entity.d.ts

@@ -16,6 +16,7 @@ export declare class TransactionEntity<S extends string> extends AbstractEntity
     items: ItemEntity[];
     readonly number: string;
     readonly pricing: {
+        shipping: number;
         subtotal: number;
         total: number;
         units: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@merkaly/api",
-  "version": "0.12.0",
+  "version": "0.14.0",
   "type": "module",
   "description": "Shared TypeScript interfaces and enums for Merkaly API",
   "repository": {