qeai-sdk 2.0.4 → 2.0.5

package/dist/dtos/categories/create-category.dto.js

@@ -7,7 +7,7 @@ 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, IsBoolean, IsNotEmpty, MinLength, MaxLength, IsUUID } from 'class-validator';
+import { IsString, IsOptional, IsBoolean, IsMongoId, IsNotEmpty, MinLength, MaxLength } from 'class-validator';
 /**
  * DTO for creating a new category.
  *
@@ -66,7 +66,7 @@ __decorate([
 ], CreateCategoryDto.prototype, "status", void 0);
 __decorate([
     IsString(),
-    IsUUID(),
+    IsMongoId(),
     IsNotEmpty(),
     __metadata("design:type", String)
 ], CreateCategoryDto.prototype, "createdBy", void 0);

package/dist/dtos/inventory/adjust-ingredient-inventory.dto.d.ts

@@ -0,0 +1,50 @@
+/**
+ * DTO for adjusting the inventory level of an ingredient by a delta value.
+ *
+ * This DTO is used when incrementing or decrementing the quantity of a specific
+ * ingredient in a restaurant's inventory (e.g., by usage, restock, waste, etc.).
+ *
+ * @property restaurantId - The restaurant's unique identifier (UUID v4).
+ * @property ingredientId - The ingredient's unique identifier (UUID v4).
+ * @property delta - The quantity change to apply (positive or negative, can be fractional).
+ * @property reason - The reason for this inventory adjustment (required, e.g., "usage", "restock").
+ * @property actor - The actor performing the adjustment; must match
+ *                   "user:<uuid>", "ms:<serviceName>", or "job:<jobName>".
+ *
+ * @example
+ * {
+ *   restaurantId: "a1c7c3da-abcd-4312-b843-0fe7c44253a5",
+ *   ingredientId: "b8e3ffcb-3029-4ed6-8c0d-43edf8fc542d",
+ *   delta: -200.5,
+ *   reason: "usage",
+ *   actor: "user:aaaabbbb-cccc-dddd-eeee-ffffffffffff"
+ * }
+ *
+ * @since 2.0.0
+ */
+export declare class AdjustIngredientInventoryDto {
+    /**
+     * The restaurant's unique identifier (UUID v4).
+     */
+    restaurantId: string;
+    /**
+     * The ingredient's unique identifier (UUID v4).
+     */
+    ingredientId: string;
+    /**
+     * The quantity change to apply (positive for additions, negative for deductions).
+     * Can be negative or positive, nonzero. Zero deltas are ignored by business logic.
+     */
+    delta: number;
+    /**
+     * The reason for this inventory adjustment (usage, restock, correction, waste, etc.).
+     */
+    reason: string;
+    /**
+     * The actor performing the adjustment; must match:
+     *   - user:<uuid>
+     *   - ms:<serviceName>
+     *   - job:<jobName>
+     */
+    actor: string;
+}

package/dist/dtos/inventory/adjust-ingredient-inventory.dto.js

@@ -0,0 +1,86 @@
+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, IsUUID, IsNumber, IsNotEmpty, Matches, } from "class-validator";
+/**
+ * DTO for adjusting the inventory level of an ingredient by a delta value.
+ *
+ * This DTO is used when incrementing or decrementing the quantity of a specific
+ * ingredient in a restaurant's inventory (e.g., by usage, restock, waste, etc.).
+ *
+ * @property restaurantId - The restaurant's unique identifier (UUID v4).
+ * @property ingredientId - The ingredient's unique identifier (UUID v4).
+ * @property delta - The quantity change to apply (positive or negative, can be fractional).
+ * @property reason - The reason for this inventory adjustment (required, e.g., "usage", "restock").
+ * @property actor - The actor performing the adjustment; must match
+ *                   "user:<uuid>", "ms:<serviceName>", or "job:<jobName>".
+ *
+ * @example
+ * {
+ *   restaurantId: "a1c7c3da-abcd-4312-b843-0fe7c44253a5",
+ *   ingredientId: "b8e3ffcb-3029-4ed6-8c0d-43edf8fc542d",
+ *   delta: -200.5,
+ *   reason: "usage",
+ *   actor: "user:aaaabbbb-cccc-dddd-eeee-ffffffffffff"
+ * }
+ *
+ * @since 2.0.0
+ */
+export class AdjustIngredientInventoryDto {
+    /**
+     * The restaurant's unique identifier (UUID v4).
+     */
+    restaurantId;
+    /**
+     * The ingredient's unique identifier (UUID v4).
+     */
+    ingredientId;
+    /**
+     * The quantity change to apply (positive for additions, negative for deductions).
+     * Can be negative or positive, nonzero. Zero deltas are ignored by business logic.
+     */
+    delta;
+    /**
+     * The reason for this inventory adjustment (usage, restock, correction, waste, etc.).
+     */
+    reason;
+    /**
+     * The actor performing the adjustment; must match:
+     *   - user:<uuid>
+     *   - ms:<serviceName>
+     *   - job:<jobName>
+     */
+    actor;
+}
+__decorate([
+    IsString(),
+    IsUUID("4", { message: "restaurantId must be a valid UUID v4" }),
+    __metadata("design:type", String)
+], AdjustIngredientInventoryDto.prototype, "restaurantId", void 0);
+__decorate([
+    IsString(),
+    IsUUID("4", { message: "ingredientId must be a valid UUID v4" }),
+    __metadata("design:type", String)
+], AdjustIngredientInventoryDto.prototype, "ingredientId", void 0);
+__decorate([
+    IsNumber({}, { message: "delta must be a number" }),
+    __metadata("design:type", Number)
+], AdjustIngredientInventoryDto.prototype, "delta", void 0);
+__decorate([
+    IsString(),
+    IsNotEmpty({ message: "reason must be specified" }),
+    __metadata("design:type", String)
+], AdjustIngredientInventoryDto.prototype, "reason", void 0);
+__decorate([
+    IsString(),
+    Matches(/^(user:[0-9a-fA-F\-]{36}|ms:[a-zA-Z0-9_\-]+|job:[a-zA-Z0-9_\-]+)$/, {
+        message: 'actor must be in the format "user:<uuid>", "ms:<serviceName>" or "job:<jobName>"',
+    }),
+    __metadata("design:type", String)
+], AdjustIngredientInventoryDto.prototype, "actor", void 0);

package/dist/dtos/inventory/set-ingredient-inventory.dto.d.ts

@@ -0,0 +1,40 @@
+/**
+ * DTO for updating an ingredient's inventory for a specific restaurant.
+ *
+ * @property restaurantId - The unique identifier of the restaurant (UUID).
+ * @property ingredientId - The unique identifier of the ingredient (UUID).
+ * @property quantity - The new quantity to set in the inventory (must be positive and greater than 0).
+ * @property actor - The actor performing the update; must match "user:<uuid>", "ms:<serviceName>", or "job:<jobName>".
+ *
+ * @example
+ * {
+ *   restaurantId: "f354c5cd-31a7-4e9d-aef6-7b1c8e393d57",
+ *   ingredientId: "dbb6bafd-8d22-45b9-9efb-af3fa0cfe245",
+ *   quantity: 10.5,
+ *   actor: "user:7cf5d452-0838-46c0-bbb2-94d22e9f2a79"
+ * }
+ *
+ * @since 2.0.0
+ */
+export declare class SetIngredientInventoryDto {
+    /**
+     * The unique identifier for the restaurant (UUID).
+     */
+    restaurantId: string;
+    /**
+     * The unique identifier for the ingredient (UUID).
+     */
+    ingredientId: string;
+    /**
+     * The quantity to update in the inventory (must be positive and greater than 0).
+     */
+    quantity: number;
+    /**
+     * The actor performing the update.
+     * Accepted formats:
+     *   - user:<uuid>
+     *   - ms:<serviceName>
+     *   - job:<jobName>
+     */
+    actor: string;
+}

package/dist/dtos/inventory/set-ingredient-inventory.dto.js

@@ -0,0 +1,72 @@
+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, IsUUID, IsNumber, Min, Matches } from "class-validator";
+/**
+ * DTO for updating an ingredient's inventory for a specific restaurant.
+ *
+ * @property restaurantId - The unique identifier of the restaurant (UUID).
+ * @property ingredientId - The unique identifier of the ingredient (UUID).
+ * @property quantity - The new quantity to set in the inventory (must be positive and greater than 0).
+ * @property actor - The actor performing the update; must match "user:<uuid>", "ms:<serviceName>", or "job:<jobName>".
+ *
+ * @example
+ * {
+ *   restaurantId: "f354c5cd-31a7-4e9d-aef6-7b1c8e393d57",
+ *   ingredientId: "dbb6bafd-8d22-45b9-9efb-af3fa0cfe245",
+ *   quantity: 10.5,
+ *   actor: "user:7cf5d452-0838-46c0-bbb2-94d22e9f2a79"
+ * }
+ *
+ * @since 2.0.0
+ */
+export class SetIngredientInventoryDto {
+    /**
+     * The unique identifier for the restaurant (UUID).
+     */
+    restaurantId;
+    /**
+     * The unique identifier for the ingredient (UUID).
+     */
+    ingredientId;
+    /**
+     * The quantity to update in the inventory (must be positive and greater than 0).
+     */
+    quantity;
+    /**
+     * The actor performing the update.
+     * Accepted formats:
+     *   - user:<uuid>
+     *   - ms:<serviceName>
+     *   - job:<jobName>
+     */
+    actor;
+}
+__decorate([
+    IsString(),
+    IsUUID("4", { message: "restaurantId must be a valid UUID v4" }),
+    __metadata("design:type", String)
+], SetIngredientInventoryDto.prototype, "restaurantId", void 0);
+__decorate([
+    IsString(),
+    IsUUID("4", { message: "ingredientId must be a valid UUID v4" }),
+    __metadata("design:type", String)
+], SetIngredientInventoryDto.prototype, "ingredientId", void 0);
+__decorate([
+    IsNumber(),
+    Min(1, { message: "quantity must be a number greater than 0" }),
+    __metadata("design:type", Number)
+], SetIngredientInventoryDto.prototype, "quantity", void 0);
+__decorate([
+    IsString(),
+    Matches(/^(user:[0-9a-fA-F\-]{36}|ms:[a-zA-Z0-9_\-]+|job:[a-zA-Z0-9_\-]+)$/, {
+        message: 'actor must be in the format "user:<uuid>", "ms:<serviceName>" or "job:<jobName>"',
+    }),
+    __metadata("design:type", String)
+], SetIngredientInventoryDto.prototype, "actor", void 0);

package/dist/interfaces/inventory/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Ingredient interfaces.
+ *
+ * This module exports interfaces used for ingredient management
+ * in the Products microservice.
+ *
+ * @since 2.0.0
+ */
+export * from "./ingredient-inventory.interface.js";
+export * from "./ingredient-inventory-response.interface.js";
+export * from "./ingredients-inventory-list-response.interface.js";

package/dist/interfaces/inventory/index.js

@@ -0,0 +1,11 @@
+/**
+ * Ingredient interfaces.
+ *
+ * This module exports interfaces used for ingredient management
+ * in the Products microservice.
+ *
+ * @since 2.0.0
+ */
+export * from "./ingredient-inventory.interface.js";
+export * from "./ingredient-inventory-response.interface.js";
+export * from "./ingredients-inventory-list-response.interface.js";

package/dist/interfaces/inventory/ingredient-inventory-response.interface.d.ts

@@ -0,0 +1,16 @@
+import { ApiResponse } from "../common/index.js";
+import { IngredientInventory } from "./ingredient-inventory.interface.js";
+/**
+ * Ingredient inventory response interface.
+ *
+ * Represents the response structure for retrieving a single ingredient inventory resource.
+ * Extends from the generic ApiResponse, encapsulating the ingredient inventory data.
+ *
+ * @since 2.0.0
+ */
+export interface IngredientInventoryResponse extends ApiResponse {
+    /**
+     * Ingredient inventory data payload.
+     */
+    data: IngredientInventory;
+}

package/dist/interfaces/inventory/ingredient-inventory-response.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/inventory/ingredient-inventory.interface.d.ts

@@ -0,0 +1,35 @@
+import { Ingredient } from "../ingredients";
+import { Restaurant } from "../restaurants";
+/**
+ * IngredientInventory represents the inventory of a specific ingredient in a restaurant,
+ * including current quantity and optional low stock limit.
+ *
+ * This interface maps to the IngredientInventory model in Prisma schema.
+ *
+ * @property id - Unique identifier for the inventory record (UUID).
+ * @property restaurantId - Identifier of the restaurant to which the inventory belongs (UUID).
+ * @property ingredientId - Identifier of the ingredient (UUID).
+ * @property quantity - Current available quantity in the ingredient's base unit.
+ * @property lowStockLimit - (Optional) Threshold that indicates when stock is considered low.
+ * @property createdAt - Date and time when the inventory record was created.
+ * @property updatedAt - Date and time when the inventory record was last updated.
+ * @property createdBy - (Optional) User/service/job that created the record.
+ * @property updatedBy - (Optional) User/service/job that last updated the record.
+ */
+export interface IngredientInventory {
+    id: string;
+    restaurantId: string;
+    ingredientId: string;
+    quantity: number;
+    lowStockLimit?: number;
+    createdAt: Date;
+    updatedAt: Date;
+    createdBy?: string;
+    updatedBy?: string;
+}
+export interface IngredientInventoryExpandRestaurant extends IngredientInventory {
+    restaurant: Restaurant;
+}
+export interface IngredientInventoryExpandIngredient extends IngredientInventory {
+    ingredient: Ingredient;
+}

package/dist/interfaces/inventory/ingredient-inventory.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/inventory/ingredients-inventory-list-response.interface.d.ts

@@ -0,0 +1,17 @@
+import { ApiResponse } from "../common/index.js";
+import { PaginationResponse } from "../common/api-pagination-response.interface.js";
+import { IngredientInventory } from "./ingredient-inventory.interface.js";
+/**
+ * Ingredients inventory list response interface.
+ *
+ * Represents the response structure for retrieving a paginated list of ingredients inventory.
+ * Extends from the generic ApiResponse and encapsulates a paginated list of ingredients inventory.
+ *
+ * @since 2.0.0
+ */
+export interface IngredientsInventoryListResponse extends ApiResponse {
+    /**
+     * Paginated data containing ingredients.
+     */
+    data: PaginationResponse<IngredientInventory>;
+}

package/dist/interfaces/inventory/ingredients-inventory-list-response.interface.js

@@ -0,0 +1 @@
+export {};

package/package.json

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