@merkaly/api 0.13.0 → 0.14.0

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

@@ -6,3 +6,4 @@ export * from './supplier.connection.entity';
 export * from './connection';
 export * from './quote';
 export * from './order';
+export * from './address';

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

@@ -1,5 +1,31 @@
 import type { FinancePaymentStatusEnum } from '../../finance/payment';
-import type { OrderFulfillmentActionEnum, OrderFulfillmentStageEnum } from './fulfillment.enum.js';
+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: {
@@ -7,13 +33,16 @@ export interface OrderSaleSummary {
         shipping: number;
         total: number;
     };
-    costs: {
-        products: number;
-        freight: 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;
     };
@@ -21,9 +50,6 @@ export interface OrderSaleSummary {
         stage: OrderFulfillmentStageEnum;
     };
     nextActions: OrderFulfillmentActionEnum[];
-    supplierOrdering: {
-        enabled: boolean;
-    };
 }
 export interface OrderBuyerFulfillment {
     stage: OrderFulfillmentStageEnum;

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

@@ -10,8 +10,25 @@ export declare enum OrderFulfillmentActionEnum {
     CONFIRM_PAYMENT = "CONFIRM_PAYMENT",
     PROCURE = "PROCURE",
     PLACE_SUPPLIER_ORDER = "PLACE_SUPPLIER_ORDER",
-    REGISTER_SUPPLIER_ORDER = "REGISTER_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

@@ -12,8 +12,27 @@ export var OrderFulfillmentActionEnum;
     OrderFulfillmentActionEnum["CONFIRM_PAYMENT"] = "CONFIRM_PAYMENT";
     OrderFulfillmentActionEnum["PROCURE"] = "PROCURE";
     OrderFulfillmentActionEnum["PLACE_SUPPLIER_ORDER"] = "PLACE_SUPPLIER_ORDER";
-    OrderFulfillmentActionEnum["REGISTER_SUPPLIER_ORDER"] = "REGISTER_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,6 +7,7 @@ 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';

package/dist/order/sale/index.js

@@ -4,6 +4,7 @@ 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';

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/shipping.request.validator.d.ts

@@ -1,11 +1,23 @@
 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;

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: {
@@ -104,6 +104,22 @@ function BirthdayForBrazil() {
         },
     });
 }
+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;
@@ -211,6 +227,7 @@ 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/package.json

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