qeai-sdk 2.0.1 → 2.0.3

package/dist/types/product-status.type.js

@@ -0,0 +1,17 @@
+/**
+ * Product status code constants for the QeHay platform.
+ *
+ * This array contains all possible status codes supported for products and inventory management.
+ * Serves as a single source of truth for product availability across client, waiter, kitchen, and admin modules.
+ *
+ * - ACTIVE: Product is active and available for ordering.
+ * - INACTIVE: Product is inactive and not available for ordering.
+ * - OUT_OF_STOCK: Product is temporarily out of stock and cannot be ordered.
+ *
+ * @since 2.0.0
+ */
+export const PRODUCT_STATUS = [
+    'ACTIVE',
+    'INACTIVE',
+    'OUT_OF_STOCK',
+];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qeai-sdk",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "description": "In this version we have added the interfaces for the qhay sdk",
   "main": "dist/index.js",
   "scripts": {

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

@@ -1,18 +0,0 @@
-import { PaginationDto } from '../common/pagination.dto.js';
-/**
- * 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

@@ -1,33 +0,0 @@
-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.js';
-/**
- * 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/products/submodules/product-tag/create-product-tag.dto.d.ts

@@ -1,24 +0,0 @@
-/**
- * DTO for creating a product-tag relationship.
- *
- * Used by the Products microservice to associate a tag with a product.
- * Establishes a many-to-many relationship between products and tags.
- *
- * @since 2.0.0
- */
-export declare class CreateProductTagDto {
-    /**
-     * Unique identifier of the product.
-     * Must not be empty.
-     *
-     * @example "550e8400-e29b-41d4-a716-446655440000"
-     */
-    productId: string;
-    /**
-     * Unique identifier of the tag.
-     * Must not be empty.
-     *
-     * @example "660e8400-e29b-41d4-a716-446655440001"
-     */
-    tagId: string;
-}

package/dist/dtos/products/submodules/product-tag/create-product-tag.dto.js

@@ -1,46 +0,0 @@
-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, IsUUID } from 'class-validator';
-/**
- * DTO for creating a product-tag relationship.
- *
- * Used by the Products microservice to associate a tag with a product.
- * Establishes a many-to-many relationship between products and tags.
- *
- * @since 2.0.0
- */
-export class CreateProductTagDto {
-    /**
-     * Unique identifier of the product.
-     * Must not be empty.
-     *
-     * @example "550e8400-e29b-41d4-a716-446655440000"
-     */
-    productId;
-    /**
-     * Unique identifier of the tag.
-     * Must not be empty.
-     *
-     * @example "660e8400-e29b-41d4-a716-446655440001"
-     */
-    tagId;
-}
-__decorate([
-    IsString(),
-    IsNotEmpty({ message: 'Product ID is required' }),
-    IsUUID(),
-    __metadata("design:type", String)
-], CreateProductTagDto.prototype, "productId", void 0);
-__decorate([
-    IsString(),
-    IsNotEmpty({ message: 'Tag ID is required' }),
-    IsUUID(),
-    __metadata("design:type", String)
-], CreateProductTagDto.prototype, "tagId", void 0);

package/dist/dtos/products/submodules/product-tag/find-product-tag.dto.d.ts

@@ -1,24 +0,0 @@
-/**
- * DTO for finding a product-tag relationship by IDs.
- *
- * Used by the Products microservice to retrieve a specific
- * product-tag relationship using product and tag identifiers.
- *
- * @since 2.0.0
- */
-export declare class FindProductTagDto {
-    /**
-     * Unique identifier of the product.
-     * Must not be empty and must be a valid UUID.
-     *
-     * @example "550e8400-e29b-41d4-a716-446655440000"
-     */
-    productId: string;
-    /**
-     * Unique identifier of the tag.
-     * Must not be empty and must be a valid UUID.
-     *
-     * @example "660e8400-e29b-41d4-a716-446655440001"
-     */
-    tagId: string;
-}

package/dist/dtos/products/submodules/product-tag/find-product-tag.dto.js

@@ -1,46 +0,0 @@
-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, IsUUID } from 'class-validator';
-/**
- * DTO for finding a product-tag relationship by IDs.
- *
- * Used by the Products microservice to retrieve a specific
- * product-tag relationship using product and tag identifiers.
- *
- * @since 2.0.0
- */
-export class FindProductTagDto {
-    /**
-     * Unique identifier of the product.
-     * Must not be empty and must be a valid UUID.
-     *
-     * @example "550e8400-e29b-41d4-a716-446655440000"
-     */
-    productId;
-    /**
-     * Unique identifier of the tag.
-     * Must not be empty and must be a valid UUID.
-     *
-     * @example "660e8400-e29b-41d4-a716-446655440001"
-     */
-    tagId;
-}
-__decorate([
-    IsString(),
-    IsNotEmpty({ message: 'Product ID is required' }),
-    IsUUID(),
-    __metadata("design:type", String)
-], FindProductTagDto.prototype, "productId", void 0);
-__decorate([
-    IsString(),
-    IsNotEmpty({ message: 'Tag ID is required' }),
-    IsUUID(),
-    __metadata("design:type", String)
-], FindProductTagDto.prototype, "tagId", void 0);

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

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

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

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

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

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

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

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

package/dist/enums/currency.enum.d.ts

@@ -1,21 +0,0 @@
-/**
- * Enumerates all supported currency codes for transactions and financial records across the QeHay platform.
- *
- * @enum Currency
- * @since 2.0.0
- *
- * @remarks
- * This enum adheres to the ISO 4217 international standard for currency codes.
- * It ensures consistent and type-safe usage of currency identifiers throughout the system.
- * Extend this enumeration when adding support for new currencies across product, payment, or report modules.
- */
-export declare enum Currency {
-    PEN = "PEN",// Peruvian Sol
-    USD = "USD",// United States Dollar
-    EUR = "EUR",// Euro
-    BRL = "BRL",// Brazilian Real
-    COP = "COP",// Colombian Peso
-    CLP = "CLP",// Chilean Peso
-    MXN = "MXN",// Mexican Peso
-    ARS = "ARS"
-}

package/dist/enums/currency.enum.js

@@ -1,22 +0,0 @@
-/**
- * Enumerates all supported currency codes for transactions and financial records across the QeHay platform.
- *
- * @enum Currency
- * @since 2.0.0
- *
- * @remarks
- * This enum adheres to the ISO 4217 international standard for currency codes.
- * It ensures consistent and type-safe usage of currency identifiers throughout the system.
- * Extend this enumeration when adding support for new currencies across product, payment, or report modules.
- */
-export var Currency;
-(function (Currency) {
-    Currency["PEN"] = "PEN";
-    Currency["USD"] = "USD";
-    Currency["EUR"] = "EUR";
-    Currency["BRL"] = "BRL";
-    Currency["COP"] = "COP";
-    Currency["CLP"] = "CLP";
-    Currency["MXN"] = "MXN";
-    Currency["ARS"] = "ARS";
-})(Currency || (Currency = {}));

package/dist/enums/order-status.enum.js

@@ -1,69 +0,0 @@
-/**
- * Enumerates all possible statuses for an order within the QeHay platform.
- *
- * @enum OrderStatus
- * @since 2.0.0
- *
- * @description
- * This enum standardizes order status representation across all modules (client, mozo, cocina, administración).
- * It supports state transitions from creation through delivery or cancellation, ensuring consistency for:
- * - Business logic processing (backends and microservices)
- * - UI state handling (apps, web, admin)
- * - Event sourcing and auditing (DynamoDB, queues)
- *
- * @remarks
- * - Extend only if QeHay supports new workflow steps as needed.
- * - This enum is NOT for payment or inventory status.
- */
-export var OrderStatus;
-(function (OrderStatus) {
-    /**
-     * The order has been created but not yet confirmed by the waiter or payment.
-     * This is the initial state for all new orders.
-     */
-    OrderStatus["CREATED"] = "CREATED";
-    /**
-     * The order is awaiting confirmation (e.g., by waiter for in-dinner).
-     */
-    OrderStatus["PENDING_CONFIRMATION"] = "PENDING_CONFIRMATION";
-    /**
-     * The order was confirmed for preparation (either by payment or by waiter).
-     */
-    OrderStatus["CONFIRMED"] = "CONFIRMED";
-    /**
-     * The order is currently being prepared/cooked by the kitchen.
-     */
-    OrderStatus["COOKING"] = "COOKING";
-    /**
-     * The order is ready and waiting for further action (serving, pickup, or delivery).
-     */
-    OrderStatus["READY"] = "READY";
-    /**
-     * The order has been served to the table (for dine-in).
-     */
-    OrderStatus["SERVED"] = "SERVED";
-    /**
-     * The order is ready for the customer to pick up at the venue.
-     */
-    OrderStatus["READY_FOR_PICKUP"] = "READY_FOR_PICKUP";
-    /**
-     * The order is ready for delivery (awaiting delivery person pickup).
-     */
-    OrderStatus["READY_FOR_DELIVERY"] = "READY_FOR_DELIVERY";
-    /**
-     * The order has been delivered to the customer (for delivery).
-     */
-    OrderStatus["DELIVERED"] = "DELIVERED";
-    /**
-     * The order has been picked up by the customer (for takeaway).
-     */
-    OrderStatus["PICKED_UP"] = "PICKED_UP";
-    /**
-     * The entire order process has been completed and closed.
-     */
-    OrderStatus["COMPLETED"] = "COMPLETED";
-    /**
-     * The order was cancelled before completion (by user or staff).
-     */
-    OrderStatus["CANCELLED"] = "CANCELLED";
-})(OrderStatus || (OrderStatus = {}));

package/dist/enums/order-type.enum.d.ts

@@ -1,45 +0,0 @@
-/**
- * Enumerates all possible order types within the QeHay platform.
- *
- * @enum OrderType
- * @since 2.0.0
- *
- * @description
- * This enum standardizes the representation of order modalities across all modules (client, mozo, cocina, administración).
- * Use this to determine business logic, UI flows, and validations according to the intended order fulfillment type.
- *
- * @remarks
- * - Always use this enum for serialization, communication, and API contracts related to order creation or querying.
- * - Maps directly to the "OrderType" in database schema and cross-service contracts.
- * - Extend cautiously if QeHay enables new ways to fulfil an order.
- *
- * @property DINE_IN   Order to be consumed at the restaurant. Initiated by the client, confirmed by the waiter with a QR scan.
- * @property PICKUP    Order prepared for collection by the customer at the restaurant.
- * @property DELIVERY  Order delivered to the customer at a specified address.
- *
- * @example
- * ```
- * import { OrderType } from './order-type.enum';
- *
- * function isLocalOrder(type: OrderType): boolean {
- *   return type === OrderType.DINE_IN || type === OrderType.PICKUP;
- * }
- * ```
- */
-export declare enum OrderType {
-    /**
-     * Order to be consumed at the restaurant (in-dinner, mesa).
-     * Created by the client, confirmed by waiter after QR scan.
-     */
-    DINE_IN = "DINE_IN",
-    /**
-     * Order will be picked up by the customer at the venue.
-     * Created by client, paid online, prepared for takeaway.
-     */
-    PICKUP = "PICKUP",
-    /**
-     * Order will be delivered to the customer at their specified location.
-     * Created and paid online, handed to delivery when ready.
-     */
-    DELIVERY = "DELIVERY"
-}

package/dist/enums/order-type.enum.js

@@ -1,46 +0,0 @@
-/**
- * Enumerates all possible order types within the QeHay platform.
- *
- * @enum OrderType
- * @since 2.0.0
- *
- * @description
- * This enum standardizes the representation of order modalities across all modules (client, mozo, cocina, administración).
- * Use this to determine business logic, UI flows, and validations according to the intended order fulfillment type.
- *
- * @remarks
- * - Always use this enum for serialization, communication, and API contracts related to order creation or querying.
- * - Maps directly to the "OrderType" in database schema and cross-service contracts.
- * - Extend cautiously if QeHay enables new ways to fulfil an order.
- *
- * @property DINE_IN   Order to be consumed at the restaurant. Initiated by the client, confirmed by the waiter with a QR scan.
- * @property PICKUP    Order prepared for collection by the customer at the restaurant.
- * @property DELIVERY  Order delivered to the customer at a specified address.
- *
- * @example
- * ```
- * import { OrderType } from './order-type.enum';
- *
- * function isLocalOrder(type: OrderType): boolean {
- *   return type === OrderType.DINE_IN || type === OrderType.PICKUP;
- * }
- * ```
- */
-export var OrderType;
-(function (OrderType) {
-    /**
-     * Order to be consumed at the restaurant (in-dinner, mesa).
-     * Created by the client, confirmed by waiter after QR scan.
-     */
-    OrderType["DINE_IN"] = "DINE_IN";
-    /**
-     * Order will be picked up by the customer at the venue.
-     * Created by client, paid online, prepared for takeaway.
-     */
-    OrderType["PICKUP"] = "PICKUP";
-    /**
-     * Order will be delivered to the customer at their specified location.
-     * Created and paid online, handed to delivery when ready.
-     */
-    OrderType["DELIVERY"] = "DELIVERY";
-})(OrderType || (OrderType = {}));

package/dist/enums/product-status.enum.d.ts

@@ -1,55 +0,0 @@
-/**
- * Enumerates all possible statuses for a product within the QeHay platform.
- *
- * @enum ProductStatus
- * @since 2.0.0
- *
- * @description
- * This enum standardizes product status representation across all modules.
- * It defines the availability and operational state of products,
- * used for inventory management, ordering, and display logic.
- *
- * @remarks
- * - Used in both DTOs and interfaces for consistency.
- * - Status affects product visibility and orderability.
- * - Products can transition between statuses based on stock and availability.
- *
- * @property ACTIVE      Product is active and available for ordering.
- * @property INACTIVE    Product is inactive and not available for ordering.
- * @property OUT_OF_STOCK Product is temporarily out of stock.
- *
- * @example
- * ```
- * import { ProductStatus } from './product-status.enum';
- *
- * function isAvailable(status: ProductStatus): boolean {
- *   return status === ProductStatus.ACTIVE;
- * }
- * ```
- */
-export declare enum ProductStatus {
-    /**
-     * Product is active and available for ordering.
-     * This is the default status for new products.
-     * Product appears in menus and can be ordered.
-     *
-     * @example ProductStatus.ACTIVE
-     */
-    ACTIVE = "ACTIVE",
-    /**
-     * Product is inactive and not available for ordering.
-     * Product does not appear in menus and cannot be ordered.
-     * Used for temporarily disabled products or seasonal items.
-     *
-     * @example ProductStatus.INACTIVE
-     */
-    INACTIVE = "INACTIVE",
-    /**
-     * Product is temporarily out of stock.
-     * Product may appear in menus but cannot be ordered.
-     * Used when product is unavailable but expected to return.
-     *
-     * @example ProductStatus.OUT_OF_STOCK
-     */
-    OUT_OF_STOCK = "OUT_OF_STOCK"
-}

package/dist/enums/product-status.enum.js

@@ -1,56 +0,0 @@
-/**
- * Enumerates all possible statuses for a product within the QeHay platform.
- *
- * @enum ProductStatus
- * @since 2.0.0
- *
- * @description
- * This enum standardizes product status representation across all modules.
- * It defines the availability and operational state of products,
- * used for inventory management, ordering, and display logic.
- *
- * @remarks
- * - Used in both DTOs and interfaces for consistency.
- * - Status affects product visibility and orderability.
- * - Products can transition between statuses based on stock and availability.
- *
- * @property ACTIVE      Product is active and available for ordering.
- * @property INACTIVE    Product is inactive and not available for ordering.
- * @property OUT_OF_STOCK Product is temporarily out of stock.
- *
- * @example
- * ```
- * import { ProductStatus } from './product-status.enum';
- *
- * function isAvailable(status: ProductStatus): boolean {
- *   return status === ProductStatus.ACTIVE;
- * }
- * ```
- */
-export var ProductStatus;
-(function (ProductStatus) {
-    /**
-     * Product is active and available for ordering.
-     * This is the default status for new products.
-     * Product appears in menus and can be ordered.
-     *
-     * @example ProductStatus.ACTIVE
-     */
-    ProductStatus["ACTIVE"] = "ACTIVE";
-    /**
-     * Product is inactive and not available for ordering.
-     * Product does not appear in menus and cannot be ordered.
-     * Used for temporarily disabled products or seasonal items.
-     *
-     * @example ProductStatus.INACTIVE
-     */
-    ProductStatus["INACTIVE"] = "INACTIVE";
-    /**
-     * Product is temporarily out of stock.
-     * Product may appear in menus but cannot be ordered.
-     * Used when product is unavailable but expected to return.
-     *
-     * @example ProductStatus.OUT_OF_STOCK
-     */
-    ProductStatus["OUT_OF_STOCK"] = "OUT_OF_STOCK";
-})(ProductStatus || (ProductStatus = {}));