qeai-sdk 2.0.5 → 2.0.6

package/dist/constants/index.d.ts

@@ -15,17 +15,18 @@
  *
  * @since 2.0.0
  */
-export * from './auth-commands.constant.js';
-export * from './category-commands.constant.js';
-export * from './chain-commands.constant.js';
-export * from './ingredient-commands.constant.js';
-export * from './order-commands.constant.js';
-export * from './payment-commands.constant.js';
-export * from './payment-events.constant.js';
-export * from './product-commands.constant.js';
-export * from './product-events.constant.js';
-export * from './question-commands.constant.js';
-export * from './restaurant-commands.constant.js';
-export * from './tag-commands.constant.js';
-export * from './translation-commands.constant.js';
-export * from './services-config.constant.js';
+export * from "./auth-commands.constant.js";
+export * from "./category-commands.constant.js";
+export * from "./chain-commands.constant.js";
+export * from "./ingredient-commands.constant.js";
+export * from "./order-commands.constant.js";
+export * from "./payment-commands.constant.js";
+export * from "./payment-events.constant.js";
+export * from "./product-commands.constant.js";
+export * from "./product-events.constant.js";
+export * from "./question-commands.constant.js";
+export * from "./restaurant-commands.constant.js";
+export * from "./tag-commands.constant.js";
+export * from "./translation-commands.constant.js";
+export * from "./services-config.constant.js";
+export * from "./inventory-commands.constant.js";

package/dist/constants/index.js

@@ -16,28 +16,30 @@
  * @since 2.0.0
  */
 // Auth commands
-export * from './auth-commands.constant.js';
+export * from "./auth-commands.constant.js";
 // Category commands
-export * from './category-commands.constant.js';
+export * from "./category-commands.constant.js";
 // Chain commands
-export * from './chain-commands.constant.js';
+export * from "./chain-commands.constant.js";
 // Ingredient commands
-export * from './ingredient-commands.constant.js';
+export * from "./ingredient-commands.constant.js";
 // Order commands
-export * from './order-commands.constant.js';
+export * from "./order-commands.constant.js";
 // Payment commands and events
-export * from './payment-commands.constant.js';
-export * from './payment-events.constant.js';
+export * from "./payment-commands.constant.js";
+export * from "./payment-events.constant.js";
 // Product commands and events
-export * from './product-commands.constant.js';
-export * from './product-events.constant.js';
+export * from "./product-commands.constant.js";
+export * from "./product-events.constant.js";
 // Question commands
-export * from './question-commands.constant.js';
+export * from "./question-commands.constant.js";
 // Restaurant commands
-export * from './restaurant-commands.constant.js';
+export * from "./restaurant-commands.constant.js";
 // Tag commands
-export * from './tag-commands.constant.js';
+export * from "./tag-commands.constant.js";
 // Translation commands
-export * from './translation-commands.constant.js';
+export * from "./translation-commands.constant.js";
 // Services config
-export * from './services-config.constant.js';
+export * from "./services-config.constant.js";
+// Inventory commands
+export * from "./inventory-commands.constant.js";

package/dist/constants/inventory-commands.constant.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Inventory service command subjects.
+ *
+ * Centralized constant with all subject/message keys
+ * for commands between client(s) and the Inventory microservice.
+ * Each key corresponds to a MessagePattern handled by the microservice.
+ *
+ * Naming conventions:
+ *  - Keys use SCREAMING_SNAKE_CASE.
+ *  - Subject values use kebab-case between dots, matching the inventory domain.
+ *
+ * Usage examples:
+ *    - INVENTORY_COMMANDS.SET_INGREDIENT_INVENTORY: Subject to set inventory for an ingredient.
+ *    - INVENTORY_COMMANDS.ADJUST_INGREDIENT_INVENTORY: Subject to adjust inventory for an ingredient.
+ *    - INVENTORY_COMMANDS.GET_INGREDIENT_INVENTORY: Subject to retrieve ingredient inventory for a restaurant.
+ *
+ * Centralizing these values ensures consistency, discoverability,
+ * and maintainability across the codebase.
+ *
+ * @since 2.0.0
+ */
+export declare const INVENTORY_COMMANDS: {
+    /** Set the inventory value of an ingredient for a restaurant */
+    readonly SET_INGREDIENT_INVENTORY: "inventory.set-ingredient-inventory";
+    /** Adjust (increment or decrement) the inventory for a restaurant's ingredient */
+    readonly ADJUST_INGREDIENT_INVENTORY: "inventory.adjust-ingredient-inventory";
+    /** Retrieve the current inventory of a specific ingredient for a restaurant */
+    readonly GET_INGREDIENT_INVENTORY: "inventory.get-ingredient-inventory";
+    /** Retrieve all ingredients' inventories for a restaurant (with optional pagination) */
+    readonly GET_ALL_INGREDIENT_INVENTORIES: "inventory.get-all-ingredient-inventories";
+};

package/dist/constants/inventory-commands.constant.js

@@ -0,0 +1,31 @@
+/**
+ * Inventory service command subjects.
+ *
+ * Centralized constant with all subject/message keys
+ * for commands between client(s) and the Inventory microservice.
+ * Each key corresponds to a MessagePattern handled by the microservice.
+ *
+ * Naming conventions:
+ *  - Keys use SCREAMING_SNAKE_CASE.
+ *  - Subject values use kebab-case between dots, matching the inventory domain.
+ *
+ * Usage examples:
+ *    - INVENTORY_COMMANDS.SET_INGREDIENT_INVENTORY: Subject to set inventory for an ingredient.
+ *    - INVENTORY_COMMANDS.ADJUST_INGREDIENT_INVENTORY: Subject to adjust inventory for an ingredient.
+ *    - INVENTORY_COMMANDS.GET_INGREDIENT_INVENTORY: Subject to retrieve ingredient inventory for a restaurant.
+ *
+ * Centralizing these values ensures consistency, discoverability,
+ * and maintainability across the codebase.
+ *
+ * @since 2.0.0
+ */
+export const INVENTORY_COMMANDS = {
+    /** Set the inventory value of an ingredient for a restaurant */
+    SET_INGREDIENT_INVENTORY: "inventory.set-ingredient-inventory",
+    /** Adjust (increment or decrement) the inventory for a restaurant's ingredient */
+    ADJUST_INGREDIENT_INVENTORY: "inventory.adjust-ingredient-inventory",
+    /** Retrieve the current inventory of a specific ingredient for a restaurant */
+    GET_INGREDIENT_INVENTORY: "inventory.get-ingredient-inventory",
+    /** Retrieve all ingredients' inventories for a restaurant (with optional pagination) */
+    GET_ALL_INGREDIENT_INVENTORIES: "inventory.get-all-ingredient-inventories",
+};

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

@@ -1,3 +1,4 @@
+import { type IngredientUnit } from "../../types/ingredient-unit.type";
 /**
  * DTO for creating a new ingredient.
  *
@@ -16,11 +17,11 @@ export declare class CreateIngredientDto {
     name: string;
     /**
      * Unit of measurement for the ingredient.
-     * Must not be empty and must have a maximum length of 12 characters.
+     * Must be one of the allowed units defined in INGREDIENT_UNITS.
      *
-     * @example "kg"
+     * @example "GRAM"
      */
-    unit: string;
+    unit: IngredientUnit;
     /**
      * User ID of the user who created the ingredient.
      * Must be a valid MongoDB ObjectId.

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

@@ -7,7 +7,8 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
-import { IsString, IsNotEmpty, MaxLength, IsMongoId } from 'class-validator';
+import { IsString, IsNotEmpty, MaxLength, IsMongoId, IsIn, } from "class-validator";
+import { INGREDIENT_UNITS, } from "../../types/ingredient-unit.type";
 /**
  * DTO for creating a new ingredient.
  *
@@ -26,9 +27,9 @@ export class CreateIngredientDto {
     name;
     /**
      * Unit of measurement for the ingredient.
-     * Must not be empty and must have a maximum length of 12 characters.
+     * Must be one of the allowed units defined in INGREDIENT_UNITS.
      *
-     * @example "kg"
+     * @example "GRAM"
      */
     unit;
     /**
@@ -41,19 +42,23 @@ export class CreateIngredientDto {
 }
 __decorate([
     IsString(),
-    IsNotEmpty({ message: 'Ingredient name is required' }),
-    MaxLength(25, { message: 'Ingredient name must be at most 25 characters' }),
+    IsNotEmpty({ message: "Ingredient name is required" }),
+    MaxLength(25, { message: "Ingredient name must be at most 25 characters" }),
     __metadata("design:type", String)
 ], CreateIngredientDto.prototype, "name", void 0);
 __decorate([
     IsString(),
-    IsNotEmpty({ message: 'Unit is required' }),
-    MaxLength(12, { message: 'Unit must be at most 12 characters' }),
+    IsNotEmpty({ message: "Unit is required" }),
+    IsIn(INGREDIENT_UNITS, {
+        message: `Unit must be one of: ${INGREDIENT_UNITS.join(", ")}`,
+    }),
     __metadata("design:type", String)
 ], CreateIngredientDto.prototype, "unit", void 0);
 __decorate([
     IsString(),
-    IsMongoId({ message: 'createdBy must be a valid MongoDB ObjectId' }),
-    IsNotEmpty({ message: 'createdBy is required and must be a valid MongoDB ObjectId' }),
+    IsMongoId({ message: "createdBy must be a valid MongoDB ObjectId" }),
+    IsNotEmpty({
+        message: "createdBy is required and must be a valid MongoDB ObjectId",
+    }),
     __metadata("design:type", String)
 ], CreateIngredientDto.prototype, "createdBy", void 0);

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

@@ -1,3 +1,4 @@
+import { type IngredientUnit } from "../../types/ingredient-unit.type";
 /**
  * DTO for updating an existing ingredient.
  *
@@ -11,7 +12,7 @@
  * {
  *   "ingredientId": "550e8400-e29b-41d4-a716-446655440000",
  *   "name": "Tomato",
- *   "unit": "kg",
+ *   "unit": "GRAM",
  *   "updatedBy": "507f1f77bcf86cd799439011"
  * }
  */
@@ -25,11 +26,11 @@ export declare class UpdateIngredientDto {
     name?: string;
     /**
      * Unit of measurement for the ingredient.
-     * Optional. If provided, must be a string with a maximum length of 12 characters.
+     * Optional. If provided, must be one of the allowed units defined in INGREDIENT_UNITS.
      *
-     * @example "kg"
+     * @example "GRAM"
      */
-    unit?: string;
+    unit?: IngredientUnit;
     /**
      * Unique identifier of the ingredient to update.
      * Required. Must be a valid UUID string.

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

@@ -7,7 +7,8 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
-import { IsString, IsOptional, IsMongoId, IsUUID, MaxLength, IsNotEmpty, } from "class-validator";
+import { IsString, IsOptional, IsMongoId, IsUUID, MaxLength, IsNotEmpty, IsIn, } from "class-validator";
+import { INGREDIENT_UNITS, } from "../../types/ingredient-unit.type";
 /**
  * DTO for updating an existing ingredient.
  *
@@ -21,7 +22,7 @@ import { IsString, IsOptional, IsMongoId, IsUUID, MaxLength, IsNotEmpty, } from
  * {
  *   "ingredientId": "550e8400-e29b-41d4-a716-446655440000",
  *   "name": "Tomato",
- *   "unit": "kg",
+ *   "unit": "GRAM",
  *   "updatedBy": "507f1f77bcf86cd799439011"
  * }
  */
@@ -35,9 +36,9 @@ export class UpdateIngredientDto {
     name;
     /**
      * Unit of measurement for the ingredient.
-     * Optional. If provided, must be a string with a maximum length of 12 characters.
+     * Optional. If provided, must be one of the allowed units defined in INGREDIENT_UNITS.
      *
-     * @example "kg"
+     * @example "GRAM"
      */
     unit;
     /**
@@ -64,18 +65,22 @@ __decorate([
 __decorate([
     IsOptional(),
     IsString(),
-    MaxLength(12, { message: "Unit must be at most 12 characters" }),
+    IsIn(INGREDIENT_UNITS, {
+        message: `Unit must be one of: ${INGREDIENT_UNITS.join(", ")}`,
+    }),
     __metadata("design:type", String)
 ], UpdateIngredientDto.prototype, "unit", void 0);
 __decorate([
     IsString(),
     IsUUID(),
-    IsNotEmpty({ message: 'ingredientId is required and must be a valid UUID.' }),
+    IsNotEmpty({ message: "ingredientId is required and must be a valid UUID." }),
     __metadata("design:type", String)
 ], UpdateIngredientDto.prototype, "ingredientId", void 0);
 __decorate([
     IsString(),
-    IsMongoId({ message: 'updatedBy must be a valid MongoDB ObjectId.' }),
-    IsNotEmpty({ message: 'updatedBy is required and must be a valid MongoDB ObjectId.' }),
+    IsMongoId({ message: "updatedBy must be a valid MongoDB ObjectId." }),
+    IsNotEmpty({
+        message: "updatedBy is required and must be a valid MongoDB ObjectId.",
+    }),
     __metadata("design:type", String)
 ], UpdateIngredientDto.prototype, "updatedBy", void 0);

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

@@ -1,3 +1,4 @@
+import { IngredientUnit } from "../../types";
 /**
  * Ingredient interface.
  *
@@ -31,7 +32,7 @@ export interface Ingredient {
      * @example "ml"
      * @example "pieces"
      */
-    unit: string;
+    unit: IngredientUnit;
     /**
      * Whether the ingredient is active/available.
      * Determines if the ingredient can be used in recipes.

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

@@ -1,4 +1,5 @@
-import { Ingredient } from '../ingredients/ingredient.interface.js';
+import { IngredientUnit } from "../../types/ingredient-unit.type.js";
+import { Ingredient } from "../ingredients/ingredient.interface.js";
 /**
  * Product recipe interface.
  *
@@ -46,5 +47,5 @@ export interface ProductRecipe {
      * @example "ml"
      * @example "pieces"
      */
-    unit: string;
+    unit: IngredientUnit;
 }

package/dist/types/index.d.ts

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

package/dist/types/index.js

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

package/dist/types/ingredient-unit.type.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Ingredient unit constants for the QeHay platform.
+ *
+ * This array defines all possible measurement units supported for ingredients in recipes, inventory,
+ * and menu composition. It acts as the single source of truth for unit values across all modules
+ * (client, waiter, kitchen, admin).
+ *
+ * - GRAM: Gramo
+ * - KILOGRAM: Kilogramo
+ * - MILLILITER: Mililitro
+ * - LITER: Litro
+ * - UNIT: Unidad (pieza/entero)
+ * - TABLESPOON: Cucharada
+ * - TEASPOON: Cucharadita
+ *
+ * @since 2.0.0
+ */
+export declare const INGREDIENT_UNITS: readonly ["GRAM", "KILOGRAM", "MILLILITER", "LITER", "PIECE", "UNIT", "TEASPOON", "TABLESPOON", "CUP", "OUNCE", "POUND"];
+/**
+ * Type representing all supported ingredient units within the QeHay platform.
+ * @see INGREDIENT_UNITS
+ *
+ * @example IngredientUnit.GRAM
+ * @example IngredientUnit.LITER
+ */
+export type IngredientUnit = (typeof INGREDIENT_UNITS)[number];

package/dist/types/ingredient-unit.type.js

@@ -0,0 +1,30 @@
+/**
+ * Ingredient unit constants for the QeHay platform.
+ *
+ * This array defines all possible measurement units supported for ingredients in recipes, inventory,
+ * and menu composition. It acts as the single source of truth for unit values across all modules
+ * (client, waiter, kitchen, admin).
+ *
+ * - GRAM: Gramo
+ * - KILOGRAM: Kilogramo
+ * - MILLILITER: Mililitro
+ * - LITER: Litro
+ * - UNIT: Unidad (pieza/entero)
+ * - TABLESPOON: Cucharada
+ * - TEASPOON: Cucharadita
+ *
+ * @since 2.0.0
+ */
+export const INGREDIENT_UNITS = [
+    "GRAM",
+    "KILOGRAM",
+    "MILLILITER",
+    "LITER",
+    "PIECE",
+    "UNIT",
+    "TEASPOON",
+    "TABLESPOON",
+    "CUP",
+    "OUNCE",
+    "POUND",
+];

package/package.json

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