qeai-sdk 2.0.0

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

@@ -0,0 +1,68 @@
+/**
+ * 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 declare enum OrderStatus {
+    /**
+     * The order has been created but not yet confirmed by the waiter or payment.
+     * This is the initial state for all new orders.
+     */
+    CREATED = "CREATED",
+    /**
+     * The order is awaiting confirmation (e.g., by waiter for in-dinner).
+     */
+    PENDING_CONFIRMATION = "PENDING_CONFIRMATION",
+    /**
+     * The order was confirmed for preparation (either by payment or by waiter).
+     */
+    CONFIRMED = "CONFIRMED",
+    /**
+     * The order is currently being prepared/cooked by the kitchen.
+     */
+    COOKING = "COOKING",
+    /**
+     * The order is ready and waiting for further action (serving, pickup, or delivery).
+     */
+    READY = "READY",
+    /**
+     * The order has been served to the table (for dine-in).
+     */
+    SERVED = "SERVED",
+    /**
+     * The order is ready for the customer to pick up at the venue.
+     */
+    READY_FOR_PICKUP = "READY_FOR_PICKUP",
+    /**
+     * The order is ready for delivery (awaiting delivery person pickup).
+     */
+    READY_FOR_DELIVERY = "READY_FOR_DELIVERY",
+    /**
+     * The order has been delivered to the customer (for delivery).
+     */
+    DELIVERED = "DELIVERED",
+    /**
+     * The order has been picked up by the customer (for takeaway).
+     */
+    PICKED_UP = "PICKED_UP",
+    /**
+     * The entire order process has been completed and closed.
+     */
+    COMPLETED = "COMPLETED",
+    /**
+     * The order was cancelled before completion (by user or staff).
+     */
+    CANCELLED = "CANCELLED"
+}

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

@@ -0,0 +1,69 @@
+/**
+ * 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

@@ -0,0 +1,45 @@
+/**
+ * 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

@@ -0,0 +1,46 @@
+/**
+ * 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

@@ -0,0 +1,55 @@
+/**
+ * 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

@@ -0,0 +1,56 @@
+/**
+ * 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 = {}));

package/dist/enums/question-product-type.enum.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Enumerates the available types for product-related questions within the QeHay platform.
+ *
+ * @enum QuestionProductType
+ * @since 2.0.0
+ *
+ * @description
+ * This enum standardizes the classification of questions associated with products,
+ * distinguishing between queries posed by users and their respective answers.
+ * Use this to tag, filter, or process Q&A flows within ordering, product details, or support features.
+ *
+ * @remarks
+ * - Use for consistent identification in data storage, frontend UI, and API contracts related to product Q&A.
+ * - If new content types are added (e.g., suggestion, review), extend this enum accordingly.
+ *
+ * @property ANSWER    Represents an answer to a previously posed question.
+ * @property QUESTION  Represents a question related to a product.
+ *
+ * @example
+ * ```
+ * import { QuestionProductType } from './question-product-type.enum';
+ *
+ * function isQuestion(type: QuestionProductType): boolean {
+ *   return type === QuestionProductType.QUESTION;
+ * }
+ * ```
+ */
+export declare enum QuestionProductType {
+    /**
+     * Represents an answer to a product-related question.
+     */
+    ANSWER = "ANSWER",
+    /**
+     * Represents a question related to a product.
+     */
+    QUESTION = "QUESTION"
+}

package/dist/enums/question-product-type.enum.js

@@ -0,0 +1,38 @@
+/**
+ * Enumerates the available types for product-related questions within the QeHay platform.
+ *
+ * @enum QuestionProductType
+ * @since 2.0.0
+ *
+ * @description
+ * This enum standardizes the classification of questions associated with products,
+ * distinguishing between queries posed by users and their respective answers.
+ * Use this to tag, filter, or process Q&A flows within ordering, product details, or support features.
+ *
+ * @remarks
+ * - Use for consistent identification in data storage, frontend UI, and API contracts related to product Q&A.
+ * - If new content types are added (e.g., suggestion, review), extend this enum accordingly.
+ *
+ * @property ANSWER    Represents an answer to a previously posed question.
+ * @property QUESTION  Represents a question related to a product.
+ *
+ * @example
+ * ```
+ * import { QuestionProductType } from './question-product-type.enum';
+ *
+ * function isQuestion(type: QuestionProductType): boolean {
+ *   return type === QuestionProductType.QUESTION;
+ * }
+ * ```
+ */
+export var QuestionProductType;
+(function (QuestionProductType) {
+    /**
+     * Represents an answer to a product-related question.
+     */
+    QuestionProductType["ANSWER"] = "ANSWER";
+    /**
+     * Represents a question related to a product.
+     */
+    QuestionProductType["QUESTION"] = "QUESTION";
+})(QuestionProductType || (QuestionProductType = {}));

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

@@ -0,0 +1,52 @@
+/**
+ * Enumerates the supported types of questions for forms, surveys, and guided workflows within the QeHay platform.
+ *
+ * @enum QuestionType
+ * @since 2.0.0
+ *
+ * @description
+ * This enum standardizes the formats in which users can register their responses when interacting with
+ * menu items, feedback forms, order customizations, or any Q&A/dialog flow that requires structured input.
+ * Keep this enum synchronized with the definition present in the Prisma schema and across all data integrations.
+ *
+ * @remarks
+ * Extend this enum consistently across all modules (frontend, backend, data) if new question/answer types are required.
+ * Used throughout the platform to ensure consistency in UI components and API contracts.
+ *
+ * @property SINGLE_CHOICE      A question with only one selectable answer.
+ * @property MULTIPLE_CHOICE    A question allowing multiple answers to be selected.
+ * @property TEXT               A question expecting a free-text (open) response.
+ * @property NUMBER             A question expecting a numeric value.
+ * @property BOOLEAN            A question expecting a true/false or yes/no response.
+ *
+ * @example
+ * ```
+ * import { QuestionType } from './question-type.enum';
+ *
+ * function supportsMultipleAnswers(type: QuestionType): boolean {
+ *   return type === QuestionType.MULTIPLE_CHOICE;
+ * }
+ * ```
+ */
+export declare enum QuestionType {
+    /**
+     * A question with only one selectable answer.
+     */
+    SINGLE_CHOICE = "SINGLE_CHOICE",
+    /**
+     * A question allowing multiple answers to be selected.
+     */
+    MULTIPLE_CHOICE = "MULTIPLE_CHOICE",
+    /**
+     * A question expecting a free-text (open) response.
+     */
+    TEXT = "TEXT",
+    /**
+     * A question expecting a numeric value.
+     */
+    NUMBER = "NUMBER",
+    /**
+     * A question expecting a true/false or yes/no response.
+     */
+    BOOLEAN = "BOOLEAN"
+}

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

@@ -0,0 +1,53 @@
+/**
+ * Enumerates the supported types of questions for forms, surveys, and guided workflows within the QeHay platform.
+ *
+ * @enum QuestionType
+ * @since 2.0.0
+ *
+ * @description
+ * This enum standardizes the formats in which users can register their responses when interacting with
+ * menu items, feedback forms, order customizations, or any Q&A/dialog flow that requires structured input.
+ * Keep this enum synchronized with the definition present in the Prisma schema and across all data integrations.
+ *
+ * @remarks
+ * Extend this enum consistently across all modules (frontend, backend, data) if new question/answer types are required.
+ * Used throughout the platform to ensure consistency in UI components and API contracts.
+ *
+ * @property SINGLE_CHOICE      A question with only one selectable answer.
+ * @property MULTIPLE_CHOICE    A question allowing multiple answers to be selected.
+ * @property TEXT               A question expecting a free-text (open) response.
+ * @property NUMBER             A question expecting a numeric value.
+ * @property BOOLEAN            A question expecting a true/false or yes/no response.
+ *
+ * @example
+ * ```
+ * import { QuestionType } from './question-type.enum';
+ *
+ * function supportsMultipleAnswers(type: QuestionType): boolean {
+ *   return type === QuestionType.MULTIPLE_CHOICE;
+ * }
+ * ```
+ */
+export var QuestionType;
+(function (QuestionType) {
+    /**
+     * A question with only one selectable answer.
+     */
+    QuestionType["SINGLE_CHOICE"] = "SINGLE_CHOICE";
+    /**
+     * A question allowing multiple answers to be selected.
+     */
+    QuestionType["MULTIPLE_CHOICE"] = "MULTIPLE_CHOICE";
+    /**
+     * A question expecting a free-text (open) response.
+     */
+    QuestionType["TEXT"] = "TEXT";
+    /**
+     * A question expecting a numeric value.
+     */
+    QuestionType["NUMBER"] = "NUMBER";
+    /**
+     * A question expecting a true/false or yes/no response.
+     */
+    QuestionType["BOOLEAN"] = "BOOLEAN";
+})(QuestionType || (QuestionType = {}));

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

@@ -0,0 +1,67 @@
+/**
+ * Enumerates all possible user roles within the QeHay platform.
+ *
+ * @enum Role
+ * @since 2.0.0
+ *
+ * @description
+ * This enum standardizes role representation across all modules (client, mozo, cocina, administración).
+ * It supports multi-role assignment, allowing users to have multiple roles simultaneously.
+ * Roles define what actions a user can perform and what modules they can access.
+ *
+ * @remarks
+ * - Users can have multiple roles (array of roles).
+ * - Default role for new users is CONSUMER.
+ * - Roles are used for authorization and access control.
+ *
+ * @property CONSUMER  Regular customer/consumer role. Can place orders and manage their account.
+ * @property WAITER    Waiter/mozo role. Can scan QR codes, confirm orders, and manage tables.
+ * @property COOK      Kitchen staff role. Can view and update order status in the kitchen module.
+ * @property ADMIN     Administrator role. Full access to all modules and administrative functions.
+ *
+ * @example
+ * ```
+ * import { Role } from './role.enum';
+ *
+ * function hasAdminAccess(roles: Role[]): boolean {
+ *   return roles.includes(Role.ADMIN);
+ * }
+ * ```
+ */
+export declare enum Role {
+    /**
+     * Regular customer/consumer role.
+     * Default role for new users.
+     * Can place orders, view order history, and manage personal account.
+     *
+     * @example Role.CONSUMER
+     */
+    CONSUMER = "CONSUMER",
+    /**
+     * Waiter/mozo role.
+     * For restaurant staff who serve customers.
+     * Can scan QR codes, confirm orders, and manage table assignments.
+     * Access to mozo (waiter) module with offline capabilities.
+     *
+     * @example Role.WAITER
+     */
+    WAITER = "WAITER",
+    /**
+     * Kitchen staff/cook role.
+     * For kitchen staff who prepare orders.
+     * Can view orders, update cooking status, and mark orders as ready.
+     * Access to cocina (kitchen) module with offline capabilities.
+     *
+     * @example Role.COOK
+     */
+    COOK = "COOK",
+    /**
+     * Administrator role.
+     * Full system access including inventory management, menu configuration,
+     * user management, and all administrative functions.
+     * Access to administración (administration) module.
+     *
+     * @example Role.ADMIN
+     */
+    ADMIN = "ADMIN"
+}

package/dist/enums/role.enum.js

@@ -0,0 +1,68 @@
+/**
+ * Enumerates all possible user roles within the QeHay platform.
+ *
+ * @enum Role
+ * @since 2.0.0
+ *
+ * @description
+ * This enum standardizes role representation across all modules (client, mozo, cocina, administración).
+ * It supports multi-role assignment, allowing users to have multiple roles simultaneously.
+ * Roles define what actions a user can perform and what modules they can access.
+ *
+ * @remarks
+ * - Users can have multiple roles (array of roles).
+ * - Default role for new users is CONSUMER.
+ * - Roles are used for authorization and access control.
+ *
+ * @property CONSUMER  Regular customer/consumer role. Can place orders and manage their account.
+ * @property WAITER    Waiter/mozo role. Can scan QR codes, confirm orders, and manage tables.
+ * @property COOK      Kitchen staff role. Can view and update order status in the kitchen module.
+ * @property ADMIN     Administrator role. Full access to all modules and administrative functions.
+ *
+ * @example
+ * ```
+ * import { Role } from './role.enum';
+ *
+ * function hasAdminAccess(roles: Role[]): boolean {
+ *   return roles.includes(Role.ADMIN);
+ * }
+ * ```
+ */
+export var Role;
+(function (Role) {
+    /**
+     * Regular customer/consumer role.
+     * Default role for new users.
+     * Can place orders, view order history, and manage personal account.
+     *
+     * @example Role.CONSUMER
+     */
+    Role["CONSUMER"] = "CONSUMER";
+    /**
+     * Waiter/mozo role.
+     * For restaurant staff who serve customers.
+     * Can scan QR codes, confirm orders, and manage table assignments.
+     * Access to mozo (waiter) module with offline capabilities.
+     *
+     * @example Role.WAITER
+     */
+    Role["WAITER"] = "WAITER";
+    /**
+     * Kitchen staff/cook role.
+     * For kitchen staff who prepare orders.
+     * Can view orders, update cooking status, and mark orders as ready.
+     * Access to cocina (kitchen) module with offline capabilities.
+     *
+     * @example Role.COOK
+     */
+    Role["COOK"] = "COOK";
+    /**
+     * Administrator role.
+     * Full system access including inventory management, menu configuration,
+     * user management, and all administrative functions.
+     * Access to administración (administration) module.
+     *
+     * @example Role.ADMIN
+     */
+    Role["ADMIN"] = "ADMIN";
+})(Role || (Role = {}));