qeai-sdk 2.0.0

package/dist/dtos/orders/order-item.dto.d.ts

@@ -0,0 +1,65 @@
+/**
+ * DTO for order item information.
+ *
+ * Represents a single item in an order with its product details,
+ * size (if applicable), quantity, price, and optional notes or child items.
+ * Supports nested items for complex order structures (e.g., combo meals).
+ *
+ * @since 2.0.0
+ */
+export declare class OrderItemDto {
+    /**
+     * Unique identifier of the product.
+     * Must be a valid UUID.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    productId: string;
+    /**
+     * Optional unique identifier of the product size variant.
+     * Must be a valid UUID if provided.
+     *
+     * @example "660e8400-e29b-41d4-a716-446655440001"
+     */
+    productSizeId?: string;
+    /**
+     * Optional name of the size variant.
+     *
+     * @example "Large"
+     */
+    sizeName?: string;
+    /**
+     * Optional price for the size variant.
+     * Must be a positive number if provided.
+     *
+     * @example 12.99
+     */
+    sizePrice?: number;
+    /**
+     * Quantity of this item in the order.
+     * Must be a positive number.
+     *
+     * @example 2
+     */
+    quantity: number;
+    /**
+     * Unit price for this item.
+     * Must be a positive number.
+     *
+     * @example 9.99
+     */
+    price: number;
+    /**
+     * Optional notes or special instructions for this item.
+     *
+     * @example "No onions, extra cheese"
+     */
+    notes?: string;
+    /**
+     * Optional array of child items (for nested structures like combo meals).
+     * Each child item is validated as an OrderItemDto.
+     *
+     * @example [{ productId: "...", quantity: 1, price: 5.99 }]
+     */
+    childItems?: OrderItemDto[];
+}

package/dist/dtos/orders/order-item.dto.js

@@ -0,0 +1,120 @@
+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 { Type } from 'class-transformer';
+import { IsArray, IsNumber, IsOptional, IsPositive, IsString, IsUUID, ValidateNested, } from 'class-validator';
+/**
+ * DTO for order item information.
+ *
+ * Represents a single item in an order with its product details,
+ * size (if applicable), quantity, price, and optional notes or child items.
+ * Supports nested items for complex order structures (e.g., combo meals).
+ *
+ * @since 2.0.0
+ */
+export class OrderItemDto {
+    /**
+     * Unique identifier of the product.
+     * Must be a valid UUID.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    productId;
+    /**
+     * Optional unique identifier of the product size variant.
+     * Must be a valid UUID if provided.
+     *
+     * @example "660e8400-e29b-41d4-a716-446655440001"
+     */
+    productSizeId;
+    /**
+     * Optional name of the size variant.
+     *
+     * @example "Large"
+     */
+    sizeName;
+    /**
+     * Optional price for the size variant.
+     * Must be a positive number if provided.
+     *
+     * @example 12.99
+     */
+    sizePrice;
+    /**
+     * Quantity of this item in the order.
+     * Must be a positive number.
+     *
+     * @example 2
+     */
+    quantity;
+    /**
+     * Unit price for this item.
+     * Must be a positive number.
+     *
+     * @example 9.99
+     */
+    price;
+    /**
+     * Optional notes or special instructions for this item.
+     *
+     * @example "No onions, extra cheese"
+     */
+    notes;
+    /**
+     * Optional array of child items (for nested structures like combo meals).
+     * Each child item is validated as an OrderItemDto.
+     *
+     * @example [{ productId: "...", quantity: 1, price: 5.99 }]
+     */
+    childItems;
+}
+__decorate([
+    IsString(),
+    IsUUID(),
+    __metadata("design:type", String)
+], OrderItemDto.prototype, "productId", void 0);
+__decorate([
+    IsString(),
+    IsOptional(),
+    IsUUID(),
+    __metadata("design:type", String)
+], OrderItemDto.prototype, "productSizeId", void 0);
+__decorate([
+    IsString(),
+    IsOptional(),
+    __metadata("design:type", String)
+], OrderItemDto.prototype, "sizeName", void 0);
+__decorate([
+    IsNumber(),
+    IsOptional(),
+    IsPositive(),
+    __metadata("design:type", Number)
+], OrderItemDto.prototype, "sizePrice", void 0);
+__decorate([
+    IsNumber(),
+    IsPositive(),
+    __metadata("design:type", Number)
+], OrderItemDto.prototype, "quantity", void 0);
+__decorate([
+    IsNumber(),
+    IsPositive(),
+    __metadata("design:type", Number)
+], OrderItemDto.prototype, "price", void 0);
+__decorate([
+    IsString(),
+    IsOptional(),
+    __metadata("design:type", String)
+], OrderItemDto.prototype, "notes", void 0);
+__decorate([
+    IsArray(),
+    IsOptional(),
+    ValidateNested({ each: true }),
+    Type(() => OrderItemDto),
+    __metadata("design:type", Array)
+], OrderItemDto.prototype, "childItems", void 0);

package/dist/dtos/orders/order-pagination.dto.d.ts

@@ -0,0 +1,19 @@
+import { OrderStatus } from '../../enums/order-status.enum';
+import { PaginationDto } from '../common/pagination.dto';
+/**
+ * DTO for paginated order queries with optional status filter.
+ *
+ * Extends PaginationDto to include optional filtering by order status.
+ * Used by the Orders microservice to retrieve orders with pagination and filtering.
+ *
+ * @since 2.0.0
+ */
+export declare class OrderPaginationDto extends PaginationDto {
+    /**
+     * Optional order status to filter results.
+     * Must be a valid OrderStatus enum value if provided.
+     *
+     * @example OrderStatus.CONFIRMED
+     */
+    status?: OrderStatus;
+}

package/dist/dtos/orders/order-pagination.dto.js

@@ -0,0 +1,34 @@
+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 { IsEnum, IsOptional } from 'class-validator';
+import { OrderStatus } from '../../enums/order-status.enum';
+import { PaginationDto } from '../common/pagination.dto';
+/**
+ * DTO for paginated order queries with optional status filter.
+ *
+ * Extends PaginationDto to include optional filtering by order status.
+ * Used by the Orders microservice to retrieve orders with pagination and filtering.
+ *
+ * @since 2.0.0
+ */
+export class OrderPaginationDto extends PaginationDto {
+    /**
+     * Optional order status to filter results.
+     * Must be a valid OrderStatus enum value if provided.
+     *
+     * @example OrderStatus.CONFIRMED
+     */
+    status;
+}
+__decorate([
+    IsOptional(),
+    IsEnum(OrderStatus, { message: 'Status must be a valid order status' }),
+    __metadata("design:type", String)
+], OrderPaginationDto.prototype, "status", void 0);

package/dist/dtos/orders/paid-order.dto.d.ts

@@ -0,0 +1,30 @@
+/**
+ * DTO for paid order information.
+ *
+ * Represents order payment confirmation data after a successful payment.
+ * Used by the Orders microservice to update order payment status.
+ *
+ * @since 2.0.0
+ */
+export declare class PaidOrderDto {
+    /**
+     * Payment charge identifier from the payment provider.
+     *
+     * @example "ch_1234567890abcdef"
+     */
+    paymentChargeId: string;
+    /**
+     * Unique identifier of the paid order.
+     * Must be a valid UUID.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    orderId: string;
+    /**
+     * URL to the payment receipt.
+     * Must be a valid URL format.
+     *
+     * @example "https://payments.example.com/receipts/receipt_123456"
+     */
+    receiptUrl: string;
+}

package/dist/dtos/orders/paid-order.dto.js

@@ -0,0 +1,54 @@
+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 { IsString, IsUrl, IsUUID } from 'class-validator';
+/**
+ * DTO for paid order information.
+ *
+ * Represents order payment confirmation data after a successful payment.
+ * Used by the Orders microservice to update order payment status.
+ *
+ * @since 2.0.0
+ */
+export class PaidOrderDto {
+    /**
+     * Payment charge identifier from the payment provider.
+     *
+     * @example "ch_1234567890abcdef"
+     */
+    paymentChargeId;
+    /**
+     * Unique identifier of the paid order.
+     * Must be a valid UUID.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    orderId;
+    /**
+     * URL to the payment receipt.
+     * Must be a valid URL format.
+     *
+     * @example "https://payments.example.com/receipts/receipt_123456"
+     */
+    receiptUrl;
+}
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], PaidOrderDto.prototype, "paymentChargeId", void 0);
+__decorate([
+    IsString(),
+    IsUUID(),
+    __metadata("design:type", String)
+], PaidOrderDto.prototype, "orderId", void 0);
+__decorate([
+    IsString(),
+    IsUrl(),
+    __metadata("design:type", String)
+], PaidOrderDto.prototype, "receiptUrl", void 0);

package/dist/dtos/orders/update-order.dto.d.ts

@@ -0,0 +1,13 @@
+declare const UpdateOrderDto_base: import("@nestjs/mapped-types").MappedType<Partial<unknown>>;
+/**
+ * DTO for updating an existing order.
+ *
+ * Extends CreateOrderDto with all fields optional.
+ * Used by the Orders microservice to update order details.
+ * Only provided fields will be updated.
+ *
+ * @since 2.0.0
+ */
+export declare class UpdateOrderDto extends UpdateOrderDto_base {
+}
+export {};

package/dist/dtos/orders/update-order.dto.js

@@ -0,0 +1,13 @@
+import { PartialType } from '@nestjs/mapped-types';
+import { CreateOrderDto } from './create-order.dto';
+/**
+ * DTO for updating an existing order.
+ *
+ * Extends CreateOrderDto with all fields optional.
+ * Used by the Orders microservice to update order details.
+ * Only provided fields will be updated.
+ *
+ * @since 2.0.0
+ */
+export class UpdateOrderDto extends PartialType(CreateOrderDto) {
+}

package/dist/dtos/payments/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Payment DTOs.
+ *
+ * This module exports DTOs used for payment processing
+ * in the Payments microservice and Client Gateway.
+ *
+ * @since 2.0.0
+ */
+export * from './payment-session.dto';
+export * from './payment-session-item.dto';
+export * from './webhook-data.dto';

package/dist/dtos/payments/index.js

@@ -0,0 +1,11 @@
+/**
+ * Payment DTOs.
+ *
+ * This module exports DTOs used for payment processing
+ * in the Payments microservice and Client Gateway.
+ *
+ * @since 2.0.0
+ */
+export * from './payment-session.dto';
+export * from './payment-session-item.dto';
+export * from './webhook-data.dto';

package/dist/dtos/payments/payment-session-item.dto.d.ts

@@ -0,0 +1,70 @@
+/**
+ * DTO for payment session item information.
+ *
+ * Represents a single product or line item in a payment session.
+ * Used by the Payments microservice to create payment sessions with itemized details.
+ * Supports nested items for complex order structures.
+ *
+ * @since 2.0.0
+ */
+export declare class PaymentSessionItemDto {
+    /**
+     * Unique identifier of the product.
+     * Must be a valid UUID.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    productId: string;
+    /**
+     * Optional name of the size variant.
+     *
+     * @example "Large"
+     */
+    sizeName?: string;
+    /**
+     * Optional price for the size variant.
+     * Must be a positive number if provided.
+     *
+     * @example 12.99
+     */
+    sizePrice?: number;
+    /**
+     * Name of the product/item.
+     *
+     * @example "Big Mac"
+     */
+    name: string;
+    /**
+     * Quantity of this item.
+     * Must be a positive number.
+     *
+     * @example 2
+     */
+    quantity: number;
+    /**
+     * Unit price for this item.
+     * Must be a positive number.
+     *
+     * @example 9.99
+     */
+    price: number;
+    /**
+     * Optional notes or special instructions for this item.
+     *
+     * @example "No onions, extra cheese"
+     */
+    notes?: string;
+    /**
+     * Optional status of this item.
+     *
+     * @example "pending"
+     */
+    itemStatus?: string;
+    /**
+     * Optional array of child items (for nested structures like combo meals).
+     * Each child item is validated as a PaymentSessionItemDto.
+     *
+     * @example [{ productId: "...", quantity: 1, price: 5.99 }]
+     */
+    childItems?: PaymentSessionItemDto[];
+}

package/dist/dtos/payments/payment-session-item.dto.js

@@ -0,0 +1,129 @@
+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 { Type } from 'class-transformer';
+import { IsString, IsNotEmpty, IsNumber, IsPositive, IsOptional, ValidateNested, IsArray, IsUUID, } from 'class-validator';
+/**
+ * DTO for payment session item information.
+ *
+ * Represents a single product or line item in a payment session.
+ * Used by the Payments microservice to create payment sessions with itemized details.
+ * Supports nested items for complex order structures.
+ *
+ * @since 2.0.0
+ */
+export class PaymentSessionItemDto {
+    /**
+     * Unique identifier of the product.
+     * Must be a valid UUID.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    productId;
+    /**
+     * Optional name of the size variant.
+     *
+     * @example "Large"
+     */
+    sizeName;
+    /**
+     * Optional price for the size variant.
+     * Must be a positive number if provided.
+     *
+     * @example 12.99
+     */
+    sizePrice;
+    /**
+     * Name of the product/item.
+     *
+     * @example "Big Mac"
+     */
+    name;
+    /**
+     * Quantity of this item.
+     * Must be a positive number.
+     *
+     * @example 2
+     */
+    quantity;
+    /**
+     * Unit price for this item.
+     * Must be a positive number.
+     *
+     * @example 9.99
+     */
+    price;
+    /**
+     * Optional notes or special instructions for this item.
+     *
+     * @example "No onions, extra cheese"
+     */
+    notes;
+    /**
+     * Optional status of this item.
+     *
+     * @example "pending"
+     */
+    itemStatus;
+    /**
+     * Optional array of child items (for nested structures like combo meals).
+     * Each child item is validated as a PaymentSessionItemDto.
+     *
+     * @example [{ productId: "...", quantity: 1, price: 5.99 }]
+     */
+    childItems;
+}
+__decorate([
+    IsString(),
+    IsUUID(),
+    __metadata("design:type", String)
+], PaymentSessionItemDto.prototype, "productId", void 0);
+__decorate([
+    IsOptional(),
+    IsString(),
+    __metadata("design:type", String)
+], PaymentSessionItemDto.prototype, "sizeName", void 0);
+__decorate([
+    IsOptional(),
+    IsNumber(),
+    IsPositive(),
+    __metadata("design:type", Number)
+], PaymentSessionItemDto.prototype, "sizePrice", void 0);
+__decorate([
+    IsString(),
+    IsNotEmpty(),
+    __metadata("design:type", String)
+], PaymentSessionItemDto.prototype, "name", void 0);
+__decorate([
+    IsNumber(),
+    IsPositive(),
+    __metadata("design:type", Number)
+], PaymentSessionItemDto.prototype, "quantity", void 0);
+__decorate([
+    IsNumber(),
+    IsPositive(),
+    __metadata("design:type", Number)
+], PaymentSessionItemDto.prototype, "price", void 0);
+__decorate([
+    IsOptional(),
+    IsString(),
+    __metadata("design:type", String)
+], PaymentSessionItemDto.prototype, "notes", void 0);
+__decorate([
+    IsOptional(),
+    IsString(),
+    __metadata("design:type", String)
+], PaymentSessionItemDto.prototype, "itemStatus", void 0);
+__decorate([
+    IsOptional(),
+    IsArray(),
+    ValidateNested({ each: true }),
+    Type(() => PaymentSessionItemDto),
+    __metadata("design:type", Array)
+], PaymentSessionItemDto.prototype, "childItems", void 0);

package/dist/dtos/payments/payment-session.dto.d.ts

@@ -0,0 +1,63 @@
+import { PaymentSessionItemDto } from './payment-session-item.dto';
+/**
+ * DTO for creating a payment session.
+ *
+ * Used by the Payments microservice to create payment sessions
+ * with order details, payment method, and customer information.
+ * This DTO is sent to payment providers (e.g., Stripe) to initiate payment.
+ *
+ * @since 2.0.0
+ */
+export declare class PaymentSessionDto {
+    /**
+     * Unique identifier of the order being paid.
+     * Must not be empty.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    orderId: string;
+    /**
+     * Optional currency code for the payment.
+     * Should follow ISO 4217 format (e.g., USD, PEN, EUR).
+     *
+     * @example "PEN"
+     * @default "PEN"
+     */
+    currency?: string;
+    /**
+     * Payment method identifier.
+     * Must not be empty.
+     *
+     * @example "payment-method-uuid-123"
+     */
+    paymentMethodId: string;
+    /**
+     * Optional customer email address.
+     * Must be a valid email format if provided.
+     *
+     * @example "customer@example.com"
+     */
+    customerEmail?: string;
+    /**
+     * Optional token identifier for saved payment methods.
+     *
+     * @example "token-uuid-123"
+     */
+    tokenId?: string;
+    /**
+     * Optional total amount for the payment.
+     * Must be a positive number if provided.
+     * If not provided, the total will be calculated from items.
+     *
+     * @example 29.99
+     */
+    totalAmount?: number;
+    /**
+     * Array of items in the payment session.
+     * Must contain at least one item.
+     * Each item is validated as a PaymentSessionItemDto.
+     *
+     * @example [{ productId: "...", name: "Big Mac", quantity: 2, price: 19.98 }]
+     */
+    items: PaymentSessionItemDto[];
+}