qeai-sdk 2.0.0 → 2.0.2

package/dist/dtos/ingredients/update-ingredient.dto.d.ts

@@ -1,26 +1,47 @@
-declare const UpdateIngredientDto_base: import("@nestjs/mapped-types").MappedType<Partial<unknown>>;
 /**
  * DTO for updating an existing ingredient.
  *
- * Extends CreateIngredientDto with all fields optional.
- * Used by the Products microservice to update ingredient details.
+ * Provides structure and validation for payloads to update ingredient data within the system.
+ * Permits partial updates: only the provided fields will be updated.
+ * Used by the Products microservice to modify ingredient details.
  *
  * @since 2.0.0
+ *
+ * @example
+ * {
+ *   "ingredientId": "550e8400-e29b-41d4-a716-446655440000",
+ *   "name": "Tomato",
+ *   "unit": "kg",
+ *   "updatedBy": "507f1f77bcf86cd799439011"
+ * }
  */
-export declare class UpdateIngredientDto extends UpdateIngredientDto_base {
+export declare class UpdateIngredientDto {
+    /**
+     * Ingredient name.
+     * Optional. If provided, must be a string with a maximum length of 25 characters.
+     *
+     * @example "Tomato"
+     */
+    name?: string;
+    /**
+     * Unit of measurement for the ingredient.
+     * Optional. If provided, must be a string with a maximum length of 12 characters.
+     *
+     * @example "kg"
+     */
+    unit?: string;
     /**
-     * Ingredient ID to update.
-     * Must be a valid UUID.
+     * Unique identifier of the ingredient to update.
+     * Required. Must be a valid UUID string.
      *
      * @example "550e8400-e29b-41d4-a716-446655440000"
      */
-    id?: string;
+    ingredientId: string;
     /**
-     * User who updated the ingredient.
-     * Must be a valid MongoDB ObjectId if provided.
+     * Unique identifier of the user performing the update.
+     * Required. Must be a valid MongoDB ObjectId.
      *
      * @example "507f1f77bcf86cd799439011"
      */
-    updatedBy?: string;
+    updatedBy: string;
 }
-export {};

package/dist/dtos/ingredients/update-ingredient.dto.js

@@ -7,42 +7,75 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
-import { PartialType } from '@nestjs/mapped-types';
-import { IsString, IsOptional, IsMongoId, IsUUID } from 'class-validator';
-import { CreateIngredientDto } from './create-ingredient.dto';
+import { IsString, IsOptional, IsMongoId, IsUUID, MaxLength, IsNotEmpty, } from "class-validator";
 /**
  * DTO for updating an existing ingredient.
  *
- * Extends CreateIngredientDto with all fields optional.
- * Used by the Products microservice to update ingredient details.
+ * Provides structure and validation for payloads to update ingredient data within the system.
+ * Permits partial updates: only the provided fields will be updated.
+ * Used by the Products microservice to modify ingredient details.
  *
  * @since 2.0.0
+ *
+ * @example
+ * {
+ *   "ingredientId": "550e8400-e29b-41d4-a716-446655440000",
+ *   "name": "Tomato",
+ *   "unit": "kg",
+ *   "updatedBy": "507f1f77bcf86cd799439011"
+ * }
  */
-export class UpdateIngredientDto extends PartialType(CreateIngredientDto) {
+export class UpdateIngredientDto {
     /**
-     * Ingredient ID to update.
-     * Must be a valid UUID.
+     * Ingredient name.
+     * Optional. If provided, must be a string with a maximum length of 25 characters.
+     *
+     * @example "Tomato"
+     */
+    name;
+    /**
+     * Unit of measurement for the ingredient.
+     * Optional. If provided, must be a string with a maximum length of 12 characters.
+     *
+     * @example "kg"
+     */
+    unit;
+    /**
+     * Unique identifier of the ingredient to update.
+     * Required. Must be a valid UUID string.
      *
      * @example "550e8400-e29b-41d4-a716-446655440000"
      */
-    id;
+    ingredientId;
     /**
-     * User who updated the ingredient.
-     * Must be a valid MongoDB ObjectId if provided.
+     * Unique identifier of the user performing the update.
+     * Required. Must be a valid MongoDB ObjectId.
      *
      * @example "507f1f77bcf86cd799439011"
      */
     updatedBy;
 }
 __decorate([
+    IsOptional(),
     IsString(),
-    IsUUID(),
+    MaxLength(25, { message: "Ingredient name must be at most 25 characters" }),
+    __metadata("design:type", String)
+], UpdateIngredientDto.prototype, "name", void 0);
+__decorate([
     IsOptional(),
+    IsString(),
+    MaxLength(12, { message: "Unit must be at most 12 characters" }),
     __metadata("design:type", String)
-], UpdateIngredientDto.prototype, "id", void 0);
+], UpdateIngredientDto.prototype, "unit", void 0);
 __decorate([
     IsString(),
-    IsMongoId(),
-    IsOptional(),
+    IsUUID(),
+    IsNotEmpty({ message: 'ingredientId is required and must be a valid UUID.' }),
+    __metadata("design:type", String)
+], UpdateIngredientDto.prototype, "ingredientId", void 0);
+__decorate([
+    IsString(),
+    IsMongoId({ message: 'updatedBy must be a valid MongoDB ObjectId.' }),
+    IsNotEmpty({ message: 'updatedBy is required and must be a valid MongoDB ObjectId.' }),
     __metadata("design:type", String)
 ], UpdateIngredientDto.prototype, "updatedBy", void 0);

package/dist/dtos/orders/change-order-status.dto.d.ts

@@ -1,25 +1,34 @@
-import { OrderStatus } from '../../enums/order-status.enum';
+import type { OrderStatus } from "../../types/order-status.type.js";
 /**
- * DTO for changing an order's status.
+ * Data Transfer Object (DTO) for changing the status of an order.
  *
- * Used by the Orders microservice to update the status of an existing order.
- * Validates the order ID and new status value.
+ * This DTO is used by the Orders microservice to request a status change for an existing order.
+ * It ensures that the required order identifier and the new order status are both valid.
  *
+ * @class ChangeOrderStatusDto
  * @since 2.0.0
+ *
+ * @example
+ * {
+ *   "orderId": "550e8400-e29b-41d4-a716-446655440000",
+ *   "status": "CONFIRMED"
+ * }
  */
 export declare class ChangeOrderStatusDto {
     /**
-     * Unique identifier of the order to update.
-     * Must be a valid UUID version 4.
+     * Unique identifier of the order whose status is to be updated.
+     * Must be a valid UUID (version 4).
      *
+     * @type {string}
      * @example "550e8400-e29b-41d4-a716-446655440000"
      */
-    id: string;
+    orderId: string;
     /**
-     * New status for the order.
-     * Must be a valid OrderStatus enum value.
+     * New status value to set for the order.
+     * Must be a valid value from the OrderStatus enum.
      *
-     * @example OrderStatus.CONFIRMED
+     * @type {OrderStatus}
+     * @example "CONFIRMED"
      */
     status: OrderStatus;
 }

package/dist/dtos/orders/change-order-status.dto.js

@@ -7,37 +7,50 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
-import { IsEnum, IsUUID } from 'class-validator';
-import { OrderStatus } from '../../enums/order-status.enum';
+import { IsIn, IsNotEmpty, IsString, IsUUID } from "class-validator";
+import { ORDER_STATUS } from "../../types/order-status.type.js";
 /**
- * DTO for changing an order's status.
+ * Data Transfer Object (DTO) for changing the status of an order.
  *
- * Used by the Orders microservice to update the status of an existing order.
- * Validates the order ID and new status value.
+ * This DTO is used by the Orders microservice to request a status change for an existing order.
+ * It ensures that the required order identifier and the new order status are both valid.
  *
+ * @class ChangeOrderStatusDto
  * @since 2.0.0
+ *
+ * @example
+ * {
+ *   "orderId": "550e8400-e29b-41d4-a716-446655440000",
+ *   "status": "CONFIRMED"
+ * }
  */
 export class ChangeOrderStatusDto {
     /**
-     * Unique identifier of the order to update.
-     * Must be a valid UUID version 4.
+     * Unique identifier of the order whose status is to be updated.
+     * Must be a valid UUID (version 4).
      *
+     * @type {string}
      * @example "550e8400-e29b-41d4-a716-446655440000"
      */
-    id;
+    orderId;
     /**
-     * New status for the order.
-     * Must be a valid OrderStatus enum value.
+     * New status value to set for the order.
+     * Must be a valid value from the OrderStatus enum.
      *
-     * @example OrderStatus.CONFIRMED
+     * @type {OrderStatus}
+     * @example "CONFIRMED"
      */
     status;
 }
 __decorate([
-    IsUUID(4, { message: 'Order ID must be a valid UUID' }),
+    IsUUID(4, { message: "orderId must be a valid UUID v4" }),
+    IsString({ message: "orderId must be a string" }),
+    IsNotEmpty({ message: "orderId is required" }),
     __metadata("design:type", String)
-], ChangeOrderStatusDto.prototype, "id", void 0);
+], ChangeOrderStatusDto.prototype, "orderId", void 0);
 __decorate([
-    IsEnum(OrderStatus, { message: 'Status must be a valid order status' }),
+    IsIn(ORDER_STATUS, { message: "status must be a valid order status" }),
+    IsString({ message: "status must be a string" }),
+    IsNotEmpty({ message: "status is required" }),
     __metadata("design:type", String)
 ], ChangeOrderStatusDto.prototype, "status", void 0);

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

@@ -1,62 +1,72 @@
-import { OrderItemDto } from './order-item.dto';
-import { OrderType } from '../../enums/order-type.enum';
+import { OrderItemDto } from './order-item.dto.js';
+import { type OrderMode } from '../../types/order-mode.type.js';
 /**
- * DTO for creating a new order.
+ * Data Transfer Object for creating a new order in QeHay.
  *
- * Used by the Orders microservice to create new orders with items,
- * order type, and optional delivery/pickup information.
- * Validates the order structure and required fields based on order type.
+ * This DTO defines the structure, validation and documentation for the data needed to create a restaurant order.
+ * It supports all main QeHay order flows (DINE_IN, PICKUP, DELIVERY) and enforces minimum business rules at field level.
+ *
+ * Each property is validated and documented for clear API contracts and seamless integration with client apps.
  *
  * @since 2.0.0
  */
 export declare class CreateOrderDto {
     /**
-     * Array of items in the order.
-     * Must contain at least one item.
-     * Each item is validated as an OrderItemDto.
+     * List of items included in the order.
+     * - Must contain at least one item.
+     * - Each element is validated as OrderItemDto.
      *
-     * @example [{ productId: "...", quantity: 2, price: 19.98 }]
+     * @type {OrderItemDto[]}
+     * @example [{ "productId": "651cb9...", "quantity": 2, "price": 19.98 }]
      */
     items: OrderItemDto[];
     /**
-     * Type of order (DINE_IN, PICKUP, or DELIVERY).
-     * Determines the fulfillment flow and required fields.
+     * Type of order (DINE_IN, PICKUP, DELIVERY).
+     * This determines the flow and required additional fields.
      *
-     * @example OrderType.DELIVERY
+     * @type {OrderMode}
+     * @example "DELIVERY"
      */
-    mode: OrderType;
+    mode: OrderMode;
     /**
-     * Optional table identifier for dine-in orders.
-     * Must be at least 2 characters long if provided.
+     * Table identifier for dine-in orders.
+     * - Required for DINE_IN orders.
+     * - Ignored for PICKUP and DELIVERY.
+     * - Must be at least 2 characters if provided.
      *
+     * @type {string}
      * @example "Table 5"
      */
     tableId?: string;
     /**
-     * Optional delivery address for delivery orders.
+     * Delivery address, required when mode is DELIVERY.
      *
+     * @type {string}
      * @example "123 Main St, Downtown"
      */
     deliveryAddress?: string;
     /**
-     * Optional pickup time for pickup orders.
-     * Must be a valid ISO date string if provided.
+     * Scheduled pickup time for pickup orders, as a valid ISO 8601 string.
+     * Only relevant for PICKUP mode.
      *
+     * @type {string}
      * @example "2024-01-15T18:30:00Z"
      */
     pickupTime?: string;
     /**
-     * Payment method identifier.
-     * Required for orders that require payment before confirmation.
+     * Identifier of the payment method selected by the customer.
+     * - Required for orders requiring pre-payment (typically DELIVERY and PICKUP).
      *
+     * @type {string}
      * @example "payment-method-uuid-123"
      */
     paymentMethodId: string;
     /**
-     * Optional user identifier who created the order.
-     * Must be a valid MongoDB ObjectId if provided.
+     * User identifier (MongoDB ObjectId) of the customer who created the order.
+     * - Required. Used for user traceability and order ownership.
      *
+     * @type {string}
      * @example "507f1f77bcf86cd799439011"
      */
-    userId?: string;
+    userId: string;
 }

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

@@ -8,65 +8,75 @@ 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, ArrayMinSize, ValidateNested, IsEnum, IsString, IsOptional, MinLength, IsMongoId, IsNotEmpty, IsDateString, } from 'class-validator';
-import { OrderItemDto } from './order-item.dto';
-import { OrderType } from '../../enums/order-type.enum';
+import { IsArray, ArrayMinSize, ValidateNested, IsString, IsOptional, MinLength, IsMongoId, IsNotEmpty, IsDateString, IsIn, } from 'class-validator';
+import { OrderItemDto } from './order-item.dto.js';
+import { ORDER_MODES } from '../../types/order-mode.type.js';
 /**
- * DTO for creating a new order.
+ * Data Transfer Object for creating a new order in QeHay.
  *
- * Used by the Orders microservice to create new orders with items,
- * order type, and optional delivery/pickup information.
- * Validates the order structure and required fields based on order type.
+ * This DTO defines the structure, validation and documentation for the data needed to create a restaurant order.
+ * It supports all main QeHay order flows (DINE_IN, PICKUP, DELIVERY) and enforces minimum business rules at field level.
+ *
+ * Each property is validated and documented for clear API contracts and seamless integration with client apps.
  *
  * @since 2.0.0
  */
 export class CreateOrderDto {
     /**
-     * Array of items in the order.
-     * Must contain at least one item.
-     * Each item is validated as an OrderItemDto.
+     * List of items included in the order.
+     * - Must contain at least one item.
+     * - Each element is validated as OrderItemDto.
      *
-     * @example [{ productId: "...", quantity: 2, price: 19.98 }]
+     * @type {OrderItemDto[]}
+     * @example [{ "productId": "651cb9...", "quantity": 2, "price": 19.98 }]
      */
     items;
     /**
-     * Type of order (DINE_IN, PICKUP, or DELIVERY).
-     * Determines the fulfillment flow and required fields.
+     * Type of order (DINE_IN, PICKUP, DELIVERY).
+     * This determines the flow and required additional fields.
      *
-     * @example OrderType.DELIVERY
+     * @type {OrderMode}
+     * @example "DELIVERY"
      */
     mode;
     /**
-     * Optional table identifier for dine-in orders.
-     * Must be at least 2 characters long if provided.
+     * Table identifier for dine-in orders.
+     * - Required for DINE_IN orders.
+     * - Ignored for PICKUP and DELIVERY.
+     * - Must be at least 2 characters if provided.
      *
+     * @type {string}
      * @example "Table 5"
      */
     tableId;
     /**
-     * Optional delivery address for delivery orders.
+     * Delivery address, required when mode is DELIVERY.
      *
+     * @type {string}
      * @example "123 Main St, Downtown"
      */
     deliveryAddress;
     /**
-     * Optional pickup time for pickup orders.
-     * Must be a valid ISO date string if provided.
+     * Scheduled pickup time for pickup orders, as a valid ISO 8601 string.
+     * Only relevant for PICKUP mode.
      *
+     * @type {string}
      * @example "2024-01-15T18:30:00Z"
      */
     pickupTime;
     /**
-     * Payment method identifier.
-     * Required for orders that require payment before confirmation.
+     * Identifier of the payment method selected by the customer.
+     * - Required for orders requiring pre-payment (typically DELIVERY and PICKUP).
      *
+     * @type {string}
      * @example "payment-method-uuid-123"
      */
     paymentMethodId;
     /**
-     * Optional user identifier who created the order.
-     * Must be a valid MongoDB ObjectId if provided.
+     * User identifier (MongoDB ObjectId) of the customer who created the order.
+     * - Required. Used for user traceability and order ownership.
      *
+     * @type {string}
      * @example "507f1f77bcf86cd799439011"
      */
     userId;
@@ -79,33 +89,35 @@ __decorate([
     __metadata("design:type", Array)
 ], CreateOrderDto.prototype, "items", void 0);
 __decorate([
-    IsEnum(OrderType, { message: 'Order type must be DINE_IN, PICKUP, or DELIVERY' }),
+    IsIn(ORDER_MODES, { message: 'Order type must be DINE_IN, PICKUP, or DELIVERY' }),
+    IsString({ message: 'Order mode must be a string' }),
+    IsNotEmpty({ message: 'Order mode is required' }),
     __metadata("design:type", String)
 ], CreateOrderDto.prototype, "mode", void 0);
 __decorate([
-    IsString(),
-    MinLength(2),
+    IsString({ message: 'tableId must be a string' }),
+    MinLength(2, { message: 'tableId must be at least 2 characters' }),
     IsOptional(),
     __metadata("design:type", String)
 ], CreateOrderDto.prototype, "tableId", void 0);
 __decorate([
-    IsString(),
+    IsString({ message: 'Delivery address must be a string' }),
     IsOptional(),
     __metadata("design:type", String)
 ], CreateOrderDto.prototype, "deliveryAddress", void 0);
 __decorate([
-    IsDateString(),
+    IsDateString({}, { message: 'pickupTime must be a valid ISO date string' }),
     IsOptional(),
     __metadata("design:type", String)
 ], CreateOrderDto.prototype, "pickupTime", void 0);
 __decorate([
-    IsString(),
+    IsString({ message: 'paymentMethodId must be a string' }),
     IsNotEmpty({ message: 'Payment method ID is required' }),
     __metadata("design:type", String)
 ], CreateOrderDto.prototype, "paymentMethodId", void 0);
 __decorate([
-    IsString(),
-    IsMongoId(),
-    IsOptional(),
+    IsString({ message: 'userId must be a string' }),
+    IsMongoId({ message: 'userId must be a valid MongoDB ObjectId' }),
+    IsNotEmpty({ message: 'userId is required' }),
     __metadata("design:type", String)
 ], CreateOrderDto.prototype, "userId", void 0);

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

@@ -6,9 +6,8 @@
  *
  * @since 2.0.0
  */
-export * from './create-order.dto';
-export * from './update-order.dto';
-export * from './order-item.dto';
-export * from './change-order-status.dto';
-export * from './order-pagination.dto';
-export * from './paid-order.dto';
+export * from './create-order.dto.js';
+export * from './order-item.dto.js';
+export * from './change-order-status.dto.js';
+export * from './order-pagination.dto.js';
+export * from './paid-order.dto.js';

package/dist/dtos/orders/index.js

@@ -6,9 +6,8 @@
  *
  * @since 2.0.0
  */
-export * from './create-order.dto';
-export * from './update-order.dto';
-export * from './order-item.dto';
-export * from './change-order-status.dto';
-export * from './order-pagination.dto';
-export * from './paid-order.dto';
+export * from './create-order.dto.js';
+export * from './order-item.dto.js';
+export * from './change-order-status.dto.js';
+export * from './order-pagination.dto.js';
+export * from './paid-order.dto.js';

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

@@ -1,65 +1,82 @@
 /**
- * DTO for order item information.
+ * Data Transfer Object representing a single item within an order.
  *
- * 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).
+ * Used by QeHay to structure each item the customer wishes to order, including the product, quantity, pricing, variant size,
+ * optional notes, and possible nested (child) items such as combos.
  *
+ * All properties are validated and documented to ensure data integrity and improve maintainability.
+ *
+ * @class OrderItemDto
  * @since 2.0.0
  */
 export declare class OrderItemDto {
     /**
-     * Unique identifier of the product.
-     * Must be a valid UUID.
+     * Unique identifier for the product.
+     * Required.
+     * Must be a valid UUID v4.
      *
+     * @type {string}
      * @example "550e8400-e29b-41d4-a716-446655440000"
      */
     productId: string;
     /**
-     * Optional unique identifier of the product size variant.
-     * Must be a valid UUID if provided.
+     * Optional unique identifier for the product size (variant).
+     * Only set when the selected product has multiple sizes/variants.
+     * Must be a valid UUID v4 if provided.
      *
+     * @type {string}
      * @example "660e8400-e29b-41d4-a716-446655440001"
      */
     productSizeId?: string;
     /**
-     * Optional name of the size variant.
+     * Optional name or label for the product size/variant.
+     * Useful for displaying selected size in the client.
      *
+     * @type {string}
      * @example "Large"
      */
     sizeName?: string;
     /**
-     * Optional price for the size variant.
-     * Must be a positive number if provided.
+     * Optional additional price for the selected size/variant.
+     * If specified, must be a positive number.
      *
+     * @type {number}
      * @example 12.99
      */
     sizePrice?: number;
     /**
-     * Quantity of this item in the order.
-     * Must be a positive number.
+     * Quantity of the ordered product (how many units the customer wants).
+     * Required.
+     * Must be a positive number (greater than zero).
      *
+     * @type {number}
      * @example 2
      */
     quantity: number;
     /**
-     * Unit price for this item.
+     * Unit price for this item (for one product or one variant, without multiplying by quantity).
+     * Required.
      * Must be a positive number.
      *
+     * @type {number}
      * @example 9.99
      */
     price: number;
     /**
-     * Optional notes or special instructions for this item.
+     * Optional notes or special instructions for this item (i.e. "No onions", "Add extra cheese").
+     * Useful for customizations or clarifications by the customer.
+     * Minimum length: 5 characters. Maximum: 200.
      *
+     * @type {string}
      * @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.
+     * Optional array of nested child items (for combos, extras, etc).
+     * Each child item must also be a valid OrderItemDto instance, supporting recursive order nesting.
      *
-     * @example [{ productId: "...", quantity: 1, price: 5.99 }]
+     * @type {OrderItemDto[]}
+     * @example [{ "productId": "...", "quantity": 1, "price": 5.99 }]
      */
     childItems?: OrderItemDto[];
 }