qeai-sdk 2.0.0

package/dist/dtos/index.js

@@ -0,0 +1,40 @@
+/**
+ * Centralized DTOs for the QeHay platform.
+ *
+ * This module exports all DTOs organized by domain for use across
+ * all microservices and the client gateway.
+ *
+ * Usage examples:
+ *    - import { CreateOrderDto, OrderItemDto } from 'looroh-sdk-qhay-interfaces';
+ *    - import { CreateProductDto, UpdateProductDto } from 'looroh-sdk-qhay-interfaces';
+ *    - import { PaymentSessionDto } from 'looroh-sdk-qhay-interfaces';
+ *
+ * All DTOs include validation decorators from class-validator and
+ * are properly documented for API documentation generation.
+ *
+ * @since 2.0.0
+ */
+// Common DTOs
+export * from "./common";
+// Auth DTOs
+export * from "./auth";
+// Order DTOs
+export * from "./orders";
+// Payment DTOs
+export * from "./payments";
+// Product DTOs
+export * from "./products";
+// Category DTOs
+export * from "./categories";
+// Restaurant DTOs
+export * from "./restaurants";
+// Chain DTOs
+export * from "./chain";
+// Tag DTOs
+export * from "./tags";
+// Ingredient DTOs
+export * from "./ingredients";
+// Question DTOs
+export * from "./questions";
+// Translations DTOs
+export * from "./translations";

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

@@ -0,0 +1,31 @@
+/**
+ * DTO for creating a new ingredient.
+ *
+ * Used by the Products microservice to create new ingredients.
+ * Ingredients are used 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.
+     *
+     * @example "Tomato"
+     */
+    name: string;
+    /**
+     * Unit of measurement for the ingredient.
+     * Must not be empty and maximum length of 20 characters.
+     *
+     * @example "kg"
+     */
+    unit: string;
+    /**
+     * User who created the ingredient.
+     * Must be a valid MongoDB ObjectId.
+     *
+     * @example "507f1f77bcf86cd799439011"
+     */
+    createdBy: string;
+}

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

@@ -0,0 +1,58 @@
+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, 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.
+ *
+ * @since 2.0.0
+ */
+export class CreateIngredientDto {
+    /**
+     * Name of the ingredient.
+     * Must not be empty and maximum length of 100 characters.
+     *
+     * @example "Tomato"
+     */
+    name;
+    /**
+     * Unit of measurement for the ingredient.
+     * Must not be empty and maximum length of 20 characters.
+     *
+     * @example "kg"
+     */
+    unit;
+    /**
+     * User who created the ingredient.
+     * Must be a valid MongoDB ObjectId.
+     *
+     * @example "507f1f77bcf86cd799439011"
+     */
+    createdBy;
+}
+__decorate([
+    IsString(),
+    IsNotEmpty({ message: 'Ingredient name is required' }),
+    MaxLength(100, { message: 'Ingredient name must be at most 100 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' }),
+    __metadata("design:type", String)
+], CreateIngredientDto.prototype, "unit", void 0);
+__decorate([
+    IsString(),
+    IsMongoId(),
+    __metadata("design:type", String)
+], CreateIngredientDto.prototype, "createdBy", void 0);

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

@@ -0,0 +1,24 @@
+/**
+ * DTO for deleting an ingredient.
+ *
+ * Used by the Products microservice to soft-delete ingredients.
+ * Includes ingredient ID and user who performed the deletion.
+ *
+ * @since 2.0.0
+ */
+export declare class DeleteIngredientDto {
+    /**
+     * Ingredient ID to delete.
+     * Must be a valid UUID.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    id: string;
+    /**
+     * User who deleted the ingredient.
+     * Must be a valid MongoDB ObjectId.
+     *
+     * @example "507f1f77bcf86cd799439011"
+     */
+    deletedBy: string;
+}

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

@@ -0,0 +1,44 @@
+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, IsMongoId, IsUUID } 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.
+ *
+ * @since 2.0.0
+ */
+export class DeleteIngredientDto {
+    /**
+     * Ingredient ID to delete.
+     * Must be a valid UUID.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    id;
+    /**
+     * User who deleted the ingredient.
+     * Must be a valid MongoDB ObjectId.
+     *
+     * @example "507f1f77bcf86cd799439011"
+     */
+    deletedBy;
+}
+__decorate([
+    IsString(),
+    IsUUID(),
+    __metadata("design:type", String)
+], DeleteIngredientDto.prototype, "id", void 0);
+__decorate([
+    IsString(),
+    IsMongoId(),
+    __metadata("design:type", String)
+], DeleteIngredientDto.prototype, "deletedBy", void 0);

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

@@ -0,0 +1,12 @@
+/**
+ * Ingredient DTOs.
+ *
+ * This module exports DTOs used for ingredient management
+ * in the Products microservice.
+ *
+ * @since 2.0.0
+ */
+export * from './create-ingredient.dto';
+export * from './update-ingredient.dto';
+export * from './delete-ingredient.dto';
+export * from './search-by-name.dto';

package/dist/dtos/ingredients/index.js

@@ -0,0 +1,12 @@
+/**
+ * Ingredient DTOs.
+ *
+ * This module exports DTOs used for ingredient management
+ * in the Products microservice.
+ *
+ * @since 2.0.0
+ */
+export * from './create-ingredient.dto';
+export * from './update-ingredient.dto';
+export * from './delete-ingredient.dto';
+export * from './search-by-name.dto';

package/dist/dtos/ingredients/search-by-name.dto.d.ts

@@ -0,0 +1,18 @@
+import { PaginationDto } from '../common/pagination.dto';
+/**
+ * DTO for searching ingredients by name.
+ *
+ * Extends PaginationDto to include name search functionality.
+ * Used by the Products microservice to search ingredients by name with pagination.
+ *
+ * @since 2.0.0
+ */
+export declare class SearchIngredientByNameDto extends PaginationDto {
+    /**
+     * Search term for ingredient name.
+     * Must not be empty.
+     *
+     * @example "tomato"
+     */
+    name: string;
+}

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

@@ -0,0 +1,33 @@
+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, IsNotEmpty } from 'class-validator';
+import { PaginationDto } from '../common/pagination.dto';
+/**
+ * DTO for searching ingredients by name.
+ *
+ * Extends PaginationDto to include name search functionality.
+ * Used by the Products microservice to search ingredients by name with pagination.
+ *
+ * @since 2.0.0
+ */
+export class SearchIngredientByNameDto extends PaginationDto {
+    /**
+     * Search term for ingredient name.
+     * Must not be empty.
+     *
+     * @example "tomato"
+     */
+    name;
+}
+__decorate([
+    IsString(),
+    IsNotEmpty({ message: 'Search term is required' }),
+    __metadata("design:type", String)
+], SearchIngredientByNameDto.prototype, "name", void 0);

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

@@ -0,0 +1,26 @@
+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.
+ *
+ * @since 2.0.0
+ */
+export declare class UpdateIngredientDto extends UpdateIngredientDto_base {
+    /**
+     * Ingredient ID to update.
+     * Must be a valid UUID.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    id?: string;
+    /**
+     * User who updated the ingredient.
+     * Must be a valid MongoDB ObjectId if provided.
+     *
+     * @example "507f1f77bcf86cd799439011"
+     */
+    updatedBy?: string;
+}
+export {};

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

@@ -0,0 +1,48 @@
+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 { PartialType } from '@nestjs/mapped-types';
+import { IsString, IsOptional, IsMongoId, IsUUID } from 'class-validator';
+import { CreateIngredientDto } from './create-ingredient.dto';
+/**
+ * DTO for updating an existing ingredient.
+ *
+ * Extends CreateIngredientDto with all fields optional.
+ * Used by the Products microservice to update ingredient details.
+ *
+ * @since 2.0.0
+ */
+export class UpdateIngredientDto extends PartialType(CreateIngredientDto) {
+    /**
+     * Ingredient ID to update.
+     * Must be a valid UUID.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    id;
+    /**
+     * User who updated the ingredient.
+     * Must be a valid MongoDB ObjectId if provided.
+     *
+     * @example "507f1f77bcf86cd799439011"
+     */
+    updatedBy;
+}
+__decorate([
+    IsString(),
+    IsUUID(),
+    IsOptional(),
+    __metadata("design:type", String)
+], UpdateIngredientDto.prototype, "id", void 0);
+__decorate([
+    IsString(),
+    IsMongoId(),
+    IsOptional(),
+    __metadata("design:type", String)
+], UpdateIngredientDto.prototype, "updatedBy", void 0);

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

@@ -0,0 +1,25 @@
+import { OrderStatus } from '../../enums/order-status.enum';
+/**
+ * DTO for changing an order's status.
+ *
+ * Used by the Orders microservice to update the status of an existing order.
+ * Validates the order ID and new status value.
+ *
+ * @since 2.0.0
+ */
+export declare class ChangeOrderStatusDto {
+    /**
+     * Unique identifier of the order to update.
+     * Must be a valid UUID version 4.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    id: string;
+    /**
+     * New status for the order.
+     * Must be a valid OrderStatus enum value.
+     *
+     * @example OrderStatus.CONFIRMED
+     */
+    status: OrderStatus;
+}

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

@@ -0,0 +1,43 @@
+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, IsUUID } from 'class-validator';
+import { OrderStatus } from '../../enums/order-status.enum';
+/**
+ * DTO for changing an order's status.
+ *
+ * Used by the Orders microservice to update the status of an existing order.
+ * Validates the order ID and new status value.
+ *
+ * @since 2.0.0
+ */
+export class ChangeOrderStatusDto {
+    /**
+     * Unique identifier of the order to update.
+     * Must be a valid UUID version 4.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    id;
+    /**
+     * New status for the order.
+     * Must be a valid OrderStatus enum value.
+     *
+     * @example OrderStatus.CONFIRMED
+     */
+    status;
+}
+__decorate([
+    IsUUID(4, { message: 'Order ID must be a valid UUID' }),
+    __metadata("design:type", String)
+], ChangeOrderStatusDto.prototype, "id", void 0);
+__decorate([
+    IsEnum(OrderStatus, { message: 'Status must be a valid order status' }),
+    __metadata("design:type", String)
+], ChangeOrderStatusDto.prototype, "status", void 0);

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

@@ -0,0 +1,62 @@
+import { OrderItemDto } from './order-item.dto';
+import { OrderType } from '../../enums/order-type.enum';
+/**
+ * DTO for creating a new order.
+ *
+ * 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.
+ *
+ * @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.
+     *
+     * @example [{ productId: "...", quantity: 2, price: 19.98 }]
+     */
+    items: OrderItemDto[];
+    /**
+     * Type of order (DINE_IN, PICKUP, or DELIVERY).
+     * Determines the fulfillment flow and required fields.
+     *
+     * @example OrderType.DELIVERY
+     */
+    mode: OrderType;
+    /**
+     * Optional table identifier for dine-in orders.
+     * Must be at least 2 characters long if provided.
+     *
+     * @example "Table 5"
+     */
+    tableId?: string;
+    /**
+     * Optional delivery address for delivery orders.
+     *
+     * @example "123 Main St, Downtown"
+     */
+    deliveryAddress?: string;
+    /**
+     * Optional pickup time for pickup orders.
+     * Must be a valid ISO date string if provided.
+     *
+     * @example "2024-01-15T18:30:00Z"
+     */
+    pickupTime?: string;
+    /**
+     * Payment method identifier.
+     * Required for orders that require payment before confirmation.
+     *
+     * @example "payment-method-uuid-123"
+     */
+    paymentMethodId: string;
+    /**
+     * Optional user identifier who created the order.
+     * Must be a valid MongoDB ObjectId if provided.
+     *
+     * @example "507f1f77bcf86cd799439011"
+     */
+    userId?: string;
+}

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

@@ -0,0 +1,111 @@
+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, 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';
+/**
+ * DTO for creating a new order.
+ *
+ * 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.
+ *
+ * @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.
+     *
+     * @example [{ productId: "...", quantity: 2, price: 19.98 }]
+     */
+    items;
+    /**
+     * Type of order (DINE_IN, PICKUP, or DELIVERY).
+     * Determines the fulfillment flow and required fields.
+     *
+     * @example OrderType.DELIVERY
+     */
+    mode;
+    /**
+     * Optional table identifier for dine-in orders.
+     * Must be at least 2 characters long if provided.
+     *
+     * @example "Table 5"
+     */
+    tableId;
+    /**
+     * Optional delivery address for delivery orders.
+     *
+     * @example "123 Main St, Downtown"
+     */
+    deliveryAddress;
+    /**
+     * Optional pickup time for pickup orders.
+     * Must be a valid ISO date string if provided.
+     *
+     * @example "2024-01-15T18:30:00Z"
+     */
+    pickupTime;
+    /**
+     * Payment method identifier.
+     * Required for orders that require payment before confirmation.
+     *
+     * @example "payment-method-uuid-123"
+     */
+    paymentMethodId;
+    /**
+     * Optional user identifier who created the order.
+     * Must be a valid MongoDB ObjectId if provided.
+     *
+     * @example "507f1f77bcf86cd799439011"
+     */
+    userId;
+}
+__decorate([
+    IsArray(),
+    ArrayMinSize(1, { message: 'Order must contain at least one item' }),
+    ValidateNested({ each: true }),
+    Type(() => OrderItemDto),
+    __metadata("design:type", Array)
+], CreateOrderDto.prototype, "items", void 0);
+__decorate([
+    IsEnum(OrderType, { message: 'Order type must be DINE_IN, PICKUP, or DELIVERY' }),
+    __metadata("design:type", String)
+], CreateOrderDto.prototype, "mode", void 0);
+__decorate([
+    IsString(),
+    MinLength(2),
+    IsOptional(),
+    __metadata("design:type", String)
+], CreateOrderDto.prototype, "tableId", void 0);
+__decorate([
+    IsString(),
+    IsOptional(),
+    __metadata("design:type", String)
+], CreateOrderDto.prototype, "deliveryAddress", void 0);
+__decorate([
+    IsDateString(),
+    IsOptional(),
+    __metadata("design:type", String)
+], CreateOrderDto.prototype, "pickupTime", void 0);
+__decorate([
+    IsString(),
+    IsNotEmpty({ message: 'Payment method ID is required' }),
+    __metadata("design:type", String)
+], CreateOrderDto.prototype, "paymentMethodId", void 0);
+__decorate([
+    IsString(),
+    IsMongoId(),
+    IsOptional(),
+    __metadata("design:type", String)
+], CreateOrderDto.prototype, "userId", void 0);

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

@@ -0,0 +1,14 @@
+/**
+ * Order DTOs.
+ *
+ * This module exports DTOs used for order management
+ * in the Orders microservice and Client Gateway.
+ *
+ * @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';

package/dist/dtos/orders/index.js

@@ -0,0 +1,14 @@
+/**
+ * Order DTOs.
+ *
+ * This module exports DTOs used for order management
+ * in the Orders microservice and Client Gateway.
+ *
+ * @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';