qeai-sdk 2.0.1 → 2.0.2

package/dist/dtos/common/search-by-name.dto.js

@@ -9,11 +9,34 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 import { IsNotEmpty, IsString } from 'class-validator';
 import { PaginationDto } from './pagination.dto.js';
+/**
+ * DTO for searching entities by name.
+ *
+ * This class extends PaginationDto and is designed to be used as a base
+ * DTO for search operations where a search by text (typically a name)
+ * is required. It is used across multiple modules to standardize
+ * search-by-name functionality and provide pagination support.
+ *
+ * @example
+ *   {
+ *     "name": "cheese",
+ *     "page": 1,
+ *     "limit": 10
+ *   }
+ *
+ * @since 2.0.0
+ */
 export class SearchByNameDto extends PaginationDto {
+    /**
+     * The search term for the entity name.
+     * Must be a non-empty string.
+     *
+     * @example "vegetarian"
+     */
     name;
 }
 __decorate([
     IsString(),
-    IsNotEmpty(),
+    IsNotEmpty({ message: 'Search term is required' }),
     __metadata("design:type", String)
 ], SearchByNameDto.prototype, "name", void 0);

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

@@ -2,27 +2,27 @@
  * DTO for creating a new ingredient.
  *
  * Used by the Products microservice to create new ingredients.
- * Ingredients are used in recipes and inventory management.
+ * Ingredients are utilized in recipes and inventory management.
  *
  * @since 2.0.0
  */
 export declare class CreateIngredientDto {
     /**
-     * Name of the ingredient.
-     * Must not be empty and maximum length of 100 characters.
+     * Ingredient name.
+     * Must not be empty and must have a maximum length of 25 characters.
      *
      * @example "Tomato"
      */
     name: string;
     /**
      * Unit of measurement for the ingredient.
-     * Must not be empty and maximum length of 20 characters.
+     * Must not be empty and must have a maximum length of 12 characters.
      *
      * @example "kg"
      */
     unit: string;
     /**
-     * User who created the ingredient.
+     * User ID of the user who created the ingredient.
      * Must be a valid MongoDB ObjectId.
      *
      * @example "507f1f77bcf86cd799439011"

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

@@ -12,27 +12,27 @@ import { IsString, IsNotEmpty, MaxLength, IsMongoId } from 'class-validator';
  * DTO for creating a new ingredient.
  *
  * Used by the Products microservice to create new ingredients.
- * Ingredients are used in recipes and inventory management.
+ * Ingredients are utilized in recipes and inventory management.
  *
  * @since 2.0.0
  */
 export class CreateIngredientDto {
     /**
-     * Name of the ingredient.
-     * Must not be empty and maximum length of 100 characters.
+     * Ingredient name.
+     * Must not be empty and must have a maximum length of 25 characters.
      *
      * @example "Tomato"
      */
     name;
     /**
      * Unit of measurement for the ingredient.
-     * Must not be empty and maximum length of 20 characters.
+     * Must not be empty and must have a maximum length of 12 characters.
      *
      * @example "kg"
      */
     unit;
     /**
-     * User who created the ingredient.
+     * User ID of the user who created the ingredient.
      * Must be a valid MongoDB ObjectId.
      *
      * @example "507f1f77bcf86cd799439011"
@@ -42,17 +42,18 @@ export class CreateIngredientDto {
 __decorate([
     IsString(),
     IsNotEmpty({ message: 'Ingredient name is required' }),
-    MaxLength(100, { message: 'Ingredient name must be at most 100 characters' }),
+    MaxLength(25, { message: 'Ingredient name must be at most 25 characters' }),
     __metadata("design:type", String)
 ], CreateIngredientDto.prototype, "name", void 0);
 __decorate([
     IsString(),
     IsNotEmpty({ message: 'Unit is required' }),
-    MaxLength(20, { message: 'Unit must be at most 20 characters' }),
+    MaxLength(12, { message: 'Unit must be at most 12 characters' }),
     __metadata("design:type", String)
 ], CreateIngredientDto.prototype, "unit", void 0);
 __decorate([
     IsString(),
-    IsMongoId(),
+    IsMongoId({ message: 'createdBy must be a valid MongoDB ObjectId' }),
+    IsNotEmpty({ message: 'createdBy is required and must be a valid MongoDB ObjectId' }),
     __metadata("design:type", String)
 ], CreateIngredientDto.prototype, "createdBy", void 0);

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

@@ -1,22 +1,29 @@
 /**
  * DTO for deleting an ingredient.
  *
- * Used by the Products microservice to soft-delete ingredients.
- * Includes ingredient ID and user who performed the deletion.
+ * Provides structure and validation for requests to soft-delete ingredients
+ * in the system. Used by the Products microservice to safely remove ingredient records.
+ * Captures which ingredient is being deleted and which user performs the operation for audit purposes.
  *
  * @since 2.0.0
+ *
+ * @example
+ * {
+ *   "ingredientId": "550e8400-e29b-41d4-a716-446655440000",
+ *   "deletedBy": "507f1f77bcf86cd799439011"
+ * }
  */
 export declare class DeleteIngredientDto {
     /**
-     * Ingredient ID to delete.
-     * Must be a valid UUID.
+     * Unique identifier of the ingredient to delete.
+     * Required. Must be a valid UUID string.
      *
      * @example "550e8400-e29b-41d4-a716-446655440000"
      */
-    id: string;
+    ingredientId: string;
     /**
-     * User who deleted the ingredient.
-     * Must be a valid MongoDB ObjectId.
+     * Unique identifier of the user performing the deletion.
+     * Required. Must be a valid MongoDB ObjectId.
      *
      * @example "507f1f77bcf86cd799439011"
      */

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

@@ -7,37 +7,46 @@ 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 { IsString, IsMongoId, IsUUID } from 'class-validator';
+import { IsString, IsMongoId, IsUUID, IsNotEmpty } from 'class-validator';
 /**
  * DTO for deleting an ingredient.
  *
- * Used by the Products microservice to soft-delete ingredients.
- * Includes ingredient ID and user who performed the deletion.
+ * Provides structure and validation for requests to soft-delete ingredients
+ * in the system. Used by the Products microservice to safely remove ingredient records.
+ * Captures which ingredient is being deleted and which user performs the operation for audit purposes.
  *
  * @since 2.0.0
+ *
+ * @example
+ * {
+ *   "ingredientId": "550e8400-e29b-41d4-a716-446655440000",
+ *   "deletedBy": "507f1f77bcf86cd799439011"
+ * }
  */
 export class DeleteIngredientDto {
     /**
-     * Ingredient ID to delete.
-     * Must be a valid UUID.
+     * Unique identifier of the ingredient to delete.
+     * Required. Must be a valid UUID string.
      *
      * @example "550e8400-e29b-41d4-a716-446655440000"
      */
-    id;
+    ingredientId;
     /**
-     * User who deleted the ingredient.
-     * Must be a valid MongoDB ObjectId.
+     * Unique identifier of the user performing the deletion.
+     * Required. Must be a valid MongoDB ObjectId.
      *
      * @example "507f1f77bcf86cd799439011"
      */
     deletedBy;
 }
 __decorate([
+    IsNotEmpty({ message: 'ingredientId is required and must be a valid UUID.' }),
     IsString(),
     IsUUID(),
     __metadata("design:type", String)
-], DeleteIngredientDto.prototype, "id", void 0);
+], DeleteIngredientDto.prototype, "ingredientId", void 0);
 __decorate([
+    IsNotEmpty({ message: 'deletedBy is required and must be a valid MongoDB ObjectId.' }),
     IsString(),
     IsMongoId(),
     __metadata("design:type", String)

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

@@ -9,4 +9,3 @@
 export * from './create-ingredient.dto.js';
 export * from './update-ingredient.dto.js';
 export * from './delete-ingredient.dto.js';
-export * from './search-by-name.dto.js';

package/dist/dtos/ingredients/index.js

@@ -9,4 +9,3 @@
 export * from './create-ingredient.dto.js';
 export * from './update-ingredient.dto.js';
 export * from './delete-ingredient.dto.js';
-export * from './search-by-name.dto.js';

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

@@ -1,38 +1,47 @@
 /**
  * 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 {
     /**
-     * Name of the ingredient.
-     * Must not be empty and maximum length of 100 characters.
+     * 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.
-     * Must not be empty and maximum length of 20 characters.
+     * 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;
 }

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

@@ -7,66 +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 { IsString, IsOptional, IsMongoId, IsUUID, MaxLength, } from "class-validator";
+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 {
     /**
-     * Name of the ingredient.
-     * Must not be empty and maximum length of 100 characters.
+     * 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.
-     * Must not be empty and maximum length of 20 characters.
+     * Optional. If provided, must be a string with a maximum length of 12 characters.
      *
      * @example "kg"
      */
     unit;
     /**
-     * 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;
+    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([
-    IsString(),
-    MaxLength(100, { message: "Ingredient name must be at most 100 characters" }),
     IsOptional(),
+    IsString(),
+    MaxLength(25, { message: "Ingredient name must be at most 25 characters" }),
     __metadata("design:type", String)
 ], UpdateIngredientDto.prototype, "name", void 0);
 __decorate([
-    IsString(),
-    MaxLength(20, { message: "Unit must be at most 20 characters" }),
     IsOptional(),
+    IsString(),
+    MaxLength(12, { message: "Unit must be at most 12 characters" }),
     __metadata("design:type", String)
 ], UpdateIngredientDto.prototype, "unit", void 0);
 __decorate([
     IsString(),
     IsUUID(),
-    IsOptional(),
+    IsNotEmpty({ message: 'ingredientId is required and must be a valid UUID.' }),
     __metadata("design:type", String)
-], UpdateIngredientDto.prototype, "id", void 0);
+], UpdateIngredientDto.prototype, "ingredientId", void 0);
 __decorate([
     IsString(),
-    IsMongoId(),
-    IsOptional(),
+    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.js';
+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.js';
+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.js';
-import { OrderType } from '../../enums/order-type.enum.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;
 }