qeai-sdk 2.0.1 → 2.0.3

package/dist/interfaces/auth/account.interface.d.ts

@@ -34,7 +34,7 @@ export interface Account {
      * @example "hashed_password_string"
      * @example null
      */
-    passwordHash?: string;
+    passwordHash?: string | null;
     /**
      * Authentication provider for this account.
      *
@@ -51,7 +51,7 @@ export interface Account {
      * @example "google_user_sub_123456789"
      * @example null
      */
-    providerId?: string;
+    providerId?: string | null;
     /**
      * Optional OAuth access token.
      * Used for OAuth providers to make authenticated requests.
@@ -60,7 +60,7 @@ export interface Account {
      * @example "ya29.a0AfH6SMB..."
      * @example null
      */
-    accessToken?: string;
+    accessToken?: string | null;
     /**
      * Optional OAuth refresh token.
      * Used for OAuth providers to obtain new access tokens.
@@ -69,7 +69,7 @@ export interface Account {
      * @example "1//0gXpJ..."
      * @example null
      */
-    refreshToken?: string;
+    refreshToken?: string | null;
     /**
      * Date and time when the account was created.
      *

package/dist/interfaces/auth/user.interface.d.ts

@@ -32,7 +32,7 @@ export interface User {
      *
      * @example "https://example.com/avatars/user123.jpg"
      */
-    avatarUrl?: string;
+    avatarUrl?: string | null;
     /**
      * Array of user roles for authorization.
      * Users can have multiple roles simultaneously.

package/dist/interfaces/categories/category.interface.d.ts

@@ -28,7 +28,7 @@ export interface Category {
      * @example "All types of drinks and beverages"
      * @example "Delicious main dishes and entrees"
      */
-    description?: string;
+    description?: string | null;
     /**
      * Category status (active/inactive).
      * Determines if the category is visible in menus.
@@ -54,23 +54,23 @@ export interface Category {
      *
      * @example "2024-01-20T10:30:00Z"
      */
-    deletedAt?: Date;
+    deletedAt?: Date | null;
     /**
      * Optional identifier of the user who created the category.
      *
      * @example "507f1f77bcf86cd799439011"
      */
-    createdBy?: string;
+    createdBy?: string | null;
     /**
      * Optional identifier of the user who last updated the category.
      *
      * @example "507f1f77bcf86cd799439012"
      */
-    updatedBy?: string;
+    updatedBy?: string | null;
     /**
      * Optional identifier of the user who deleted the category.
      *
      * @example "507f1f77bcf86cd799439013"
      */
-    deletedBy?: string;
+    deletedBy?: string | null;
 }

package/dist/interfaces/chains/chain.interface.d.ts

@@ -1,4 +1,4 @@
-import { Currency } from '../../enums/currency.enum.js';
+import { CurrencyCode } from "../../types";
 /**
  * Chain interface.
  *
@@ -30,7 +30,7 @@ export interface Chain {
      * @example Currency.USD
      * @example Currency.EUR
      */
-    currency: Currency;
+    currency: CurrencyCode;
     /**
      * Global tax percentage for the chain.
      * Applied across all restaurants in the chain.

package/dist/interfaces/ingredients/ingredient.interface.d.ts

@@ -57,23 +57,23 @@ export interface Ingredient {
      *
      * @example "2024-01-20T10:30:00Z"
      */
-    deletedAt?: Date;
+    deletedAt?: Date | null;
     /**
      * Optional identifier of the user who created the ingredient.
      *
      * @example "507f1f77bcf86cd799439011"
      */
-    createdBy?: string;
+    createdBy?: string | null;
     /**
      * Optional identifier of the user who last updated the ingredient.
      *
      * @example "507f1f77bcf86cd799439012"
      */
-    updatedBy?: string;
+    updatedBy?: string | null;
     /**
      * Optional identifier of the user who deleted the ingredient.
      *
      * @example "507f1f77bcf86cd799439013"
      */
-    deletedBy?: string;
+    deletedBy?: string | null;
 }

package/dist/interfaces/orders/order-item.interface.d.ts

@@ -19,13 +19,13 @@ export interface OrderItem {
      * @example "Large"
      * @example "Medium"
      */
-    sizeName?: string;
+    sizeName?: string | null;
     /**
      * Optional price for the size variant.
      *
      * @example 12.99
      */
-    sizePrice?: number;
+    sizePrice?: number | null;
     /**
      * Current status of the order item.
      *
@@ -39,7 +39,7 @@ export interface OrderItem {
      *
      * @example "No onions, extra cheese"
      */
-    notes?: string;
+    notes?: string | null;
     /**
      * Unit price for this item.
      *
@@ -66,5 +66,5 @@ export interface OrderItem {
      * @default []
      * @example [ { name: "Coke", quantity: 1, ... }, { name: "Fries", quantity: 1, ... } ]
      */
-    childItems: OrderItem[];
+    childItems?: OrderItem[] | null;
 }

package/dist/interfaces/orders/order.interface.d.ts

@@ -1,5 +1,5 @@
-import { OrderStatus } from '../../enums/index.js';
-import { OrderMode } from '../../types/index.js';
+import { OrderStatus } from "../../types/index.js";
+import { OrderMode } from "../../types/index.js";
 /**
  * Represents a restaurant order within the QeHay system.
  * Each order includes its metadata, payment information, state, and fulfillment mode.
@@ -53,7 +53,7 @@ export interface Order {
      * @example "2024-01-15T18:30:00Z"
      * @example null
      */
-    paidAt?: Date;
+    paidAt?: Date | null;
     /**
      * Payment transaction or charge identifier from the payment provider (if paid).
      * May be null if the order is unpaid or if the payment method does not provide an external reference.
@@ -61,7 +61,7 @@ export interface Order {
      * @example "ch_1234567890abcdef"
      * @example null
      */
-    paymentChargeId?: string;
+    paymentChargeId?: string | null;
     /**
      * For dine-in orders, this indicates the table number assigned.
      * For pickup or delivery orders, this will be null.
@@ -69,7 +69,7 @@ export interface Order {
      * @example "Table 5"
      * @example null
      */
-    tableNumber?: string;
+    tableNumber?: string | null;
     /**
      * For pickup orders, this indicates the scheduled pick-up time.
      * For dine-in or delivery orders, this field will be null.
@@ -77,7 +77,7 @@ export interface Order {
      * @example "2024-01-15T18:30:00Z"
      * @example null
      */
-    pickupTime?: Date;
+    pickupTime?: Date | null;
     /**
      * For delivery orders, this contains the delivery address.
      * For dine-in or pickup, this will be null.
@@ -85,20 +85,20 @@ export interface Order {
      * @example "123 Main St, Downtown"
      * @example null
      */
-    deliveryAddress?: string;
+    deliveryAddress?: string | null;
     /**
      * Unique identifier of the customer who placed the order.
      *
      * @example "550e8400-e29b-41d4-a716-446655440000"
      */
-    customerId: string;
+    customerId?: string | null;
     /**
      * Identifier for the selected payment method.
      * Can reference either a saved method or a one-time use token depending on the payment provider.
      *
      * @example "payment-method-uuid-123"
      */
-    paymentMethodId: string;
+    paymentMethodId?: string | null;
     /**
      * Timestamp for when the order was created in the system.
      *

package/dist/interfaces/products/product.interface.d.ts

@@ -1,6 +1,8 @@
-import { ProductSize, ProductImage, ProductTag, ProductSchedule, ProductRecipe } from './index.js';
-import { ProductStatus } from '../../enums/product-status.enum.js';
+import { ProductSize, ProductImage, ProductSchedule, ProductRecipe } from './index.js';
+import { ProductStatus } from '../../types/product-status.type.js';
 import { Translation } from '../translations/translation.interface.js';
+import { Tag } from '../tags/tag.interface.js';
+import { Question } from '../questions/question.interface.js';
 /**
  * Product interface.
  *
@@ -23,7 +25,7 @@ export interface Product {
      *
      * @example "PROD-001"
      */
-    sku?: string;
+    sku?: string | null;
     /**
      * Product name.
      *
@@ -35,7 +37,7 @@ export interface Product {
      *
      * @example "Two all-beef patties, special sauce, lettuce, cheese, pickles, onions on a sesame seed bun"
      */
-    description?: string;
+    description?: string | null;
     /**
      * Product base price.
      *
@@ -67,19 +69,20 @@ export interface Product {
      *
      * @example "2024-01-20T10:30:00Z"
      */
-    deletedAt?: Date;
+    deletedAt?: Date | null;
     /**
      * Optional identifier of the user who created the product.
      *
      * @example "507f1f77bcf86cd799439011"
      */
-    createdBy?: string;
+    createdBy?: string | null;
     /**
      * Optional identifier of the user who last updated the product.
      *
      * @example "507f1f77bcf86cd799439012"
      */
-    updatedBy?: string;
+    updatedBy?: string | null;
+    questions?: Question[];
     /**
      * Optional array of product size variants.
      * Loaded when product is fetched with size relations.
@@ -99,7 +102,7 @@ export interface Product {
      * Optional array of product tags.
      * Loaded when product is fetched with tag relations.
      */
-    tags?: ProductTag[];
+    tags?: Tag[];
     /**
      * Optional array of product availability schedules.
      * Loaded when product is fetched with schedule relations.

package/dist/interfaces/products/response/sub-resources/create-tag-response.interface.d.ts

@@ -1,4 +1,4 @@
 import { Tag } from "../../../tags/index.js";
 import { SubResourceResponse } from "./sub-resource-response.interface.js";
-export interface CreateTagResponse extends SubResourceResponse<Omit<Tag, "createdAt" | "updatedAt" | "deletedAt">, "tag"> {
+export interface CreateTagResponse extends SubResourceResponse<Omit<Tag, "createdAt" | "updatedAt" | "deletedAt" | "createdBy" | "updatedBy" | "deletedBy">, "tag"> {
 }

package/dist/interfaces/products/response/sub-resources/recipe-relationship.interface.d.ts

@@ -1,9 +1,7 @@
 import { Ingredient } from "../../../ingredients/index.js";
 export interface RecipeRelationship {
-    message: string;
     id: string;
     quantity: number;
-    productId: string;
     unit: string;
     ingredient: Omit<Ingredient, "createdAt" | "updatedAt" | "deletedAt">;
 }

package/dist/interfaces/questions/question.interface.d.ts

@@ -1,15 +1,17 @@
+import { Product } from "../products/product.interface.js";
 export interface Question {
     id: string;
     name: string;
     required: boolean;
-    min?: number;
-    max?: number;
+    min?: number | null;
+    max?: number | null;
     type: string;
     isActive: boolean;
+    answers?: Product[];
     createdAt: Date;
     updatedAt: Date;
-    deletedAt?: Date;
-    createdBy: string;
-    updatedBy?: string;
-    deletedBy?: string;
+    deletedAt?: Date | null;
+    createdBy?: string | null;
+    updatedBy?: string | null;
+    deletedBy?: string | null;
 }

package/dist/interfaces/restaurants/restaurant.interface.d.ts

@@ -33,14 +33,14 @@ export interface Restaurant {
      * @example "La planicie"
      * @example "123 Main St, Downtown"
      */
-    address?: string;
+    address?: string | null;
     /**
      * Optional restaurant phone number.
      *
      * @example "903406229"
      * @example "+1-555-0123"
      */
-    phone?: string;
+    phone?: string | null;
     /**
      * Optional restaurant timezone.
      * Used for scheduling and availability calculations.
@@ -48,7 +48,7 @@ export interface Restaurant {
      * @example "America/Lima"
      * @example "America/New_York"
      */
-    timezone?: string;
+    timezone?: string | null;
     /**
      * Restaurant status (active/inactive).
      * Determines if the restaurant is operational.
@@ -74,23 +74,23 @@ export interface Restaurant {
      *
      * @example "2025-11-20T10:30:00Z"
      */
-    deletedAt?: Date;
+    deletedAt?: Date | null;
     /**
      * Optional identifier of the user who created the restaurant.
      *
      * @example "68fc713cb9a5f6ee8fb7ae4e"
      */
-    createdBy?: string;
+    createdBy?: string | null;
     /**
      * Optional identifier of the user who last updated the restaurant.
      *
      * @example "68fc713cb9a5f6ee8fb7ae4f"
      */
-    updatedBy?: string;
+    updatedBy?: string | null;
     /**
      * Optional identifier of the user who deleted the restaurant.
      *
      * @example "68fc713cb9a5f6ee8fb7ae4g"
      */
-    deletedBy?: string;
+    deletedBy?: string | null;
 }

package/dist/interfaces/translations/translation.interface.d.ts

@@ -37,7 +37,7 @@ export interface Translation {
      *
      * @example "Dos hamburguesas de carne, salsa especial, lechuga, queso, pepinillos, cebollas en pan de sésamo"
      */
-    description?: string;
+    description?: string | null;
     /**
      * Optional unique identifier of the category this translation belongs to.
      * Null if this translation is for a product or question.
@@ -45,7 +45,7 @@ export interface Translation {
      * @example "550e8400-e29b-41d4-a716-446655440000"
      * @example null
      */
-    categoryId?: string;
+    categoryId?: string | null;
     /**
      * Optional unique identifier of the product this translation belongs to.
      * Null if this translation is for a category or question.
@@ -53,7 +53,7 @@ export interface Translation {
      * @example "660e8400-e29b-41d4-a716-446655440001"
      * @example null
      */
-    productId?: string;
+    productId?: string | null;
     /**
      * Optional unique identifier of the question this translation belongs to.
      * Null if this translation is for a category or product.
@@ -61,7 +61,7 @@ export interface Translation {
      * @example "770e8400-e29b-41d4-a716-446655440002"
      * @example null
      */
-    questionId?: string;
+    questionId?: string | null;
     /**
      * Date and time when the translation was created.
      *

package/dist/types/currency.type.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Currency code constants for the QeHay platform.
+ *
+ * This array contains all possible currency codes supported for transactions and financial records.
+ * Acts as the single source of truth for currency values across client, waiter, kitchen, and admin modules.
+ *
+ * - PEN: Peruvian Sol
+ * - USD: United States Dollar
+ * - EUR: Euro
+ * - BRL: Brazilian Real
+ * - COP: Colombian Peso
+ * - CLP: Chilean Peso
+ * - MXN: Mexican Peso
+ * - ARS: Argentine Peso
+ *
+ * @since 2.0.0
+ */
+export declare const CURRENCIES: readonly ["PEN", "USD"];
+/**
+ * Type representing all supported currency codes within the QeHay platform.
+ * @see CURRENCIES
+ *
+ * @example CurrencyCode.PEN
+ * @example CurrencyCode.USD
+ */
+export type CurrencyCode = (typeof CURRENCIES)[number];

package/dist/types/currency.type.js

@@ -0,0 +1,18 @@
+/**
+ * Currency code constants for the QeHay platform.
+ *
+ * This array contains all possible currency codes supported for transactions and financial records.
+ * Acts as the single source of truth for currency values across client, waiter, kitchen, and admin modules.
+ *
+ * - PEN: Peruvian Sol
+ * - USD: United States Dollar
+ * - EUR: Euro
+ * - BRL: Brazilian Real
+ * - COP: Colombian Peso
+ * - CLP: Chilean Peso
+ * - MXN: Mexican Peso
+ * - ARS: Argentine Peso
+ *
+ * @since 2.0.0
+ */
+export const CURRENCIES = ["PEN", "USD"];

package/dist/types/index.d.ts

@@ -1 +1,4 @@
 export * from './order-mode.type.js';
+export * from './order-status.type.js';
+export * from "./currency.type.js";
+export * from "./product-status.type.js";

package/dist/types/index.js

@@ -1 +1,4 @@
 export * from './order-mode.type.js';
+export * from './order-status.type.js';
+export * from "./currency.type.js";
+export * from "./product-status.type.js";

package/dist/types/order-mode.type.d.ts

@@ -1,7 +1,9 @@
 /**
- * OrderMode type.
+ * Order mode constants for the QeHay platform.
  *
- * Represents the available modes for creating an order in the QeHay ecosystem.
+ * This array contains all possible order modes for order creation in QeHay.
+ * Acts as the single source of truth for order mode values across client, waiter,
+ * kitchen, and admin modules.
  *
  * - DINE_IN: The order is placed within the restaurant. The order is created in a "CREATED" state,
  *            and a QR code is generated for the waiter to scan and confirm the order.
@@ -11,4 +13,11 @@
  *
  * @since 2.0.0
  */
-export type OrderMode = 'DINE_IN' | 'DELIVERY' | 'PICKUP';
+export declare const ORDER_MODES: readonly ["DINE_IN", "DELIVERY", "PICKUP"];
+/**
+ * Type representing all possible modes for an order within the QeHay platform.
+ * @see ORDER_MODES
+ *
+ * @example OrderMode.DINE_IN
+ */
+export type OrderMode = (typeof ORDER_MODES)[number];

package/dist/types/order-mode.type.js

@@ -1 +1,16 @@
-export {};
+/**
+ * Order mode constants for the QeHay platform.
+ *
+ * This array contains all possible order modes for order creation in QeHay.
+ * Acts as the single source of truth for order mode values across client, waiter,
+ * kitchen, and admin modules.
+ *
+ * - DINE_IN: The order is placed within the restaurant. The order is created in a "CREATED" state,
+ *            and a QR code is generated for the waiter to scan and confirm the order.
+ * - DELIVERY: The order is placed for home delivery. The order is created in a "CREATED" state,
+ *             payment is processed, and the order transitions to "CONFIRMED".
+ * - PICKUP: The order is placed for pickup at the restaurant. Follows the DELIVERY flow regarding state and payment.
+ *
+ * @since 2.0.0
+ */
+export const ORDER_MODES = ["DINE_IN", "DELIVERY", "PICKUP"];

package/dist/types/order-status.type.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Order status constants for QeHay platform.
+ *
+ * This array contains all possible states that an order can have within the QeHay ecosystem.
+ * It is the single source of truth for order statuses used across modules:
+ * - Cliente, mozo, cocina y administración.
+ * - Lógica de negocio (backends y microservicios)
+ * - Manejo de estados en UI (apps, web, admin)
+ * - Auditoría y event sourcing (DynamoDB, colas)
+ *
+ * @remarks
+ * Only extend if the QeHay workflow adds new explicit steps.
+ * Not to be used for payment or inventory status.
+ *
+ * @since 2.0.0
+ */
+export declare const ORDER_STATUS: readonly ["CREATED", "PENDING_CONFIRMATION", "CONFIRMED", "COOKING", "READY", "SERVED", "READY_FOR_PICKUP", "READY_FOR_DELIVERY", "DELIVERED", "PICKED_UP", "COMPLETED", "CANCELLED"];
+/**
+ * Type representing all possible statuses for an order within the QeHay platform.
+ * @see ORDER_STATUS
+ */
+export type OrderStatus = (typeof ORDER_STATUS)[number];

package/dist/{enums/order-status.enum.d.ts → types/order-status.type.js}

@@ -1,68 +1,67 @@
 /**
- * Enumerates all possible statuses for an order within the QeHay platform.
+ * Order status constants for 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)
+ * This array contains all possible states that an order can have within the QeHay ecosystem.
+ * It is the single source of truth for order statuses used across modules:
+ * - Cliente, mozo, cocina y administración.
+ * - Lógica de negocio (backends y microservicios)
+ * - Manejo de estados en UI (apps, web, admin)
+ * - Auditoría y event sourcing (DynamoDB, colas)
  *
  * @remarks
- * - Extend only if QeHay supports new workflow steps as needed.
- * - This enum is NOT for payment or inventory status.
+ * Only extend if the QeHay workflow adds new explicit steps.
+ * Not to be used for payment or inventory status.
+ *
+ * @since 2.0.0
  */
-export declare enum OrderStatus {
+export const ORDER_STATUS = [
     /**
      * 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",
+    "CREATED",
     /**
      * The order is awaiting confirmation (e.g., by waiter for in-dinner).
      */
-    PENDING_CONFIRMATION = "PENDING_CONFIRMATION",
+    "PENDING_CONFIRMATION",
     /**
      * The order was confirmed for preparation (either by payment or by waiter).
      */
-    CONFIRMED = "CONFIRMED",
+    "CONFIRMED",
     /**
      * The order is currently being prepared/cooked by the kitchen.
      */
-    COOKING = "COOKING",
+    "COOKING",
     /**
      * The order is ready and waiting for further action (serving, pickup, or delivery).
      */
-    READY = "READY",
+    "READY",
     /**
      * The order has been served to the table (for dine-in).
      */
-    SERVED = "SERVED",
+    "SERVED",
     /**
      * The order is ready for the customer to pick up at the venue.
      */
-    READY_FOR_PICKUP = "READY_FOR_PICKUP",
+    "READY_FOR_PICKUP",
     /**
      * The order is ready for delivery (awaiting delivery person pickup).
      */
-    READY_FOR_DELIVERY = "READY_FOR_DELIVERY",
+    "READY_FOR_DELIVERY",
     /**
      * The order has been delivered to the customer (for delivery).
      */
-    DELIVERED = "DELIVERED",
+    "DELIVERED",
     /**
      * The order has been picked up by the customer (for takeaway).
      */
-    PICKED_UP = "PICKED_UP",
+    "PICKED_UP",
     /**
      * The entire order process has been completed and closed.
      */
-    COMPLETED = "COMPLETED",
+    "COMPLETED",
     /**
      * The order was cancelled before completion (by user or staff).
      */
-    CANCELLED = "CANCELLED"
-}
+    "CANCELLED",
+];

package/dist/types/product-status.type.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 declare const PRODUCT_STATUS: readonly ["ACTIVE", "INACTIVE", "OUT_OF_STOCK"];
+/**
+ * Type representing all possible product statuses within the QeHay platform.
+ * @see PRODUCT_STATUS
+ *
+ * @example
+ * import { ProductStatus } from './product-status.enum';
+ *
+ * function isAvailable(status: ProductStatus): boolean {
+ *   return status === 'ACTIVE';
+ * }
+ */
+export type ProductStatus = (typeof PRODUCT_STATUS)[number];