qeai-sdk 2.0.0 → 2.0.2

package/dist/dtos/chain/delete-chain.dto.js

@@ -7,26 +7,26 @@ 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, IsMongoId, IsUUID } from 'class-validator';
+import { IsString, IsMongoId, IsUUID, IsNotEmpty } from "class-validator";
 /**
  * DTO for deleting a chain.
  *
  * Used by the Products microservice to soft-delete chains.
- * Includes chain ID and user who performed the deletion.
+ * Holds the chain unique identifier and the user who performed the deletion.
  *
  * @since 2.0.0
  */
 export class DeleteChainDto {
     /**
-     * Chain ID to delete.
-     * Must be a valid UUID.
+     * Unique identifier of the chain to delete.
+     * Required. Must be a valid UUID format.
      *
      * @example "550e8400-e29b-41d4-a716-446655440000"
      */
-    id;
+    chainId;
     /**
-     * User who deleted the chain.
-     * Must be a valid MongoDB ObjectId.
+     * Unique identifier of the user performing the deletion.
+     * Required. Must be a valid MongoDB ObjectId.
      *
      * @example "507f1f77bcf86cd799439011"
      */
@@ -35,10 +35,12 @@ export class DeleteChainDto {
 __decorate([
     IsString(),
     IsUUID(),
+    IsNotEmpty({ message: 'chainId is required and must be a valid UUID.' }),
     __metadata("design:type", String)
-], DeleteChainDto.prototype, "id", void 0);
+], DeleteChainDto.prototype, "chainId", void 0);
 __decorate([
     IsString(),
-    IsMongoId(),
+    IsMongoId({ message: 'deletedBy must be a valid MongoDB ObjectId.' }),
+    IsNotEmpty({ message: 'deletedBy is required and must be a valid MongoDB ObjectId.' }),
     __metadata("design:type", String)
 ], DeleteChainDto.prototype, "deletedBy", void 0);

package/dist/dtos/chain/index.d.ts

@@ -6,6 +6,6 @@
  *
  * @since 2.0.0
  */
-export * from './create-chain.dto';
-export * from './update-chain.dto';
-export * from './delete-chain.dto';
+export * from './create-chain.dto.js';
+export * from './update-chain.dto.js';
+export * from './delete-chain.dto.js';

package/dist/dtos/chain/index.js

@@ -6,6 +6,6 @@
  *
  * @since 2.0.0
  */
-export * from './create-chain.dto';
-export * from './update-chain.dto';
-export * from './delete-chain.dto';
+export * from './create-chain.dto.js';
+export * from './update-chain.dto.js';
+export * from './delete-chain.dto.js';

package/dist/dtos/chain/update-chain.dto.d.ts

@@ -1,26 +1,60 @@
-declare const UpdateChainDto_base: import("@nestjs/mapped-types").MappedType<Partial<unknown>>;
+import { Currency } from "../../enums/currency.enum.js";
 /**
  * DTO for updating an existing chain.
  *
- * Extends CreateChainDto with all fields optional.
- * Used by the Products microservice to update chain details.
+ * Provides structure and validation for payloads to update a chain (restaurant brand)
+ * in the system. All fields related to chain details are optional to allow partial updates,
+ * but identifiers (chainId, updatedBy) are required for correct auditing and entity targeting.
+ *
+ * Used by the Products microservice to apply modifications to the properties of an existing chain.
  *
  * @since 2.0.0
+ *
+ * @example
+ * {
+ *   "chainId": "550e8400-e29b-41d4-a716-446655440000",
+ *   "name": "McDonald's",
+ *   "currency": "PEN",
+ *   "taxPercent": 8.5,
+ *   "updatedBy": "507f1f77bcf86cd799439011"
+ * }
  */
-export declare class UpdateChainDto extends UpdateChainDto_base {
+export declare class UpdateChainDto {
+    /**
+     * The name of the chain (brand).
+     * Optional. If provided, must have at least 3 characters.
+     *
+     * @example "McDonald's"
+     */
+    name?: string;
+    /**
+     * The currency code for the chain.
+     * Optional. Must be a value from the Currency enum if provided.
+     *
+     * @example Currency.PEN
+     * @default Currency.PEN
+     */
+    currency?: Currency;
+    /**
+     * Global tax percentage applied across the chain.
+     * Optional. Must be a number between 0 and 100 if provided.
+     *
+     * @example 8.5
+     * @default 0.0
+     */
+    taxPercent?: number;
     /**
-     * Chain ID to update.
-     * Must be a valid UUID.
+     * Unique identifier of the chain to update.
+     * Required. Must be a valid UUID string.
      *
      * @example "550e8400-e29b-41d4-a716-446655440000"
      */
-    id?: string;
+    chainId: string;
     /**
-     * User who updated the chain.
-     * Must be a valid MongoDB ObjectId if provided.
+     * Unique identifier of the user performing the update.
+     * Required. Must be a valid MongoDB ObjectId.
      *
      * @example "507f1f77bcf86cd799439011"
      */
-    updatedBy?: string;
+    updatedBy: string;
 }
-export {};

package/dist/dtos/chain/update-chain.dto.js

@@ -7,42 +7,94 @@ 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 { PartialType } from '@nestjs/mapped-types';
-import { IsString, IsOptional, IsMongoId, IsUUID } from 'class-validator';
-import { CreateChainDto } from './create-chain.dto';
+import { IsString, IsOptional, IsMongoId, IsUUID, IsNumber, Max, Min, IsEnum, MinLength, IsNotEmpty, } from "class-validator";
+import { Currency } from "../../enums/currency.enum.js";
 /**
  * DTO for updating an existing chain.
  *
- * Extends CreateChainDto with all fields optional.
- * Used by the Products microservice to update chain details.
+ * Provides structure and validation for payloads to update a chain (restaurant brand)
+ * in the system. All fields related to chain details are optional to allow partial updates,
+ * but identifiers (chainId, updatedBy) are required for correct auditing and entity targeting.
+ *
+ * Used by the Products microservice to apply modifications to the properties of an existing chain.
  *
  * @since 2.0.0
+ *
+ * @example
+ * {
+ *   "chainId": "550e8400-e29b-41d4-a716-446655440000",
+ *   "name": "McDonald's",
+ *   "currency": "PEN",
+ *   "taxPercent": 8.5,
+ *   "updatedBy": "507f1f77bcf86cd799439011"
+ * }
  */
-export class UpdateChainDto extends PartialType(CreateChainDto) {
+export class UpdateChainDto {
+    /**
+     * The name of the chain (brand).
+     * Optional. If provided, must have at least 3 characters.
+     *
+     * @example "McDonald's"
+     */
+    name;
+    /**
+     * The currency code for the chain.
+     * Optional. Must be a value from the Currency enum if provided.
+     *
+     * @example Currency.PEN
+     * @default Currency.PEN
+     */
+    currency = Currency.PEN;
+    /**
+     * Global tax percentage applied across the chain.
+     * Optional. Must be a number between 0 and 100 if provided.
+     *
+     * @example 8.5
+     * @default 0.0
+     */
+    taxPercent = 0.0;
     /**
-     * Chain ID to update.
-     * Must be a valid UUID.
+     * Unique identifier of the chain to update.
+     * Required. Must be a valid UUID string.
      *
      * @example "550e8400-e29b-41d4-a716-446655440000"
      */
-    id;
+    chainId;
     /**
-     * User who updated the chain.
-     * Must be a valid MongoDB ObjectId if provided.
+     * Unique identifier of the user performing the update.
+     * Required. Must be a valid MongoDB ObjectId.
      *
      * @example "507f1f77bcf86cd799439011"
      */
     updatedBy;
 }
 __decorate([
+    IsOptional(),
     IsString(),
-    IsUUID(),
+    MinLength(3, { message: 'Chain name must be at least 3 characters' }),
+    __metadata("design:type", String)
+], UpdateChainDto.prototype, "name", void 0);
+__decorate([
     IsOptional(),
+    IsEnum(Currency, { message: "Currency must be a valid currency code" }),
     __metadata("design:type", String)
-], UpdateChainDto.prototype, "id", void 0);
+], UpdateChainDto.prototype, "currency", void 0);
 __decorate([
-    IsString(),
-    IsMongoId(),
     IsOptional(),
+    IsNumber({}, { message: "Tax percentage must be a number" }),
+    Min(0, { message: "Tax percentage must be at least 0" }),
+    Max(100, { message: "Tax percentage must be at most 100" }),
+    __metadata("design:type", Number)
+], UpdateChainDto.prototype, "taxPercent", void 0);
+__decorate([
+    IsString(),
+    IsUUID(),
+    IsNotEmpty({ message: 'chainId is required and must be a valid UUID.' }),
+    __metadata("design:type", String)
+], UpdateChainDto.prototype, "chainId", 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.' }),
     __metadata("design:type", String)
 ], UpdateChainDto.prototype, "updatedBy", void 0);

package/dist/dtos/common/index.d.ts

@@ -6,4 +6,5 @@
  *
  * @since 2.0.0
  */
-export * from './pagination.dto';
+export * from './pagination.dto.js';
+export * from './search-by-name.dto.js';

package/dist/dtos/common/index.js

@@ -6,4 +6,5 @@
  *
  * @since 2.0.0
  */
-export * from './pagination.dto';
+export * from './pagination.dto.js';
+export * from './search-by-name.dto.js';

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

@@ -0,0 +1,27 @@
+import { PaginationDto } from './pagination.dto.js';
+/**
+ * DTO for searching entities by name.
+ *
+ * This class extends PaginationDto and is designed to be used as a base
+ * DTO for search operations where a search by text (typically a name)
+ * is required. It is used across multiple modules to standardize
+ * search-by-name functionality and provide pagination support.
+ *
+ * @example
+ *   {
+ *     "name": "cheese",
+ *     "page": 1,
+ *     "limit": 10
+ *   }
+ *
+ * @since 2.0.0
+ */
+export declare class SearchByNameDto extends PaginationDto {
+    /**
+     * The search term for the entity name.
+     * Must be a non-empty string.
+     *
+     * @example "vegetarian"
+     */
+    name: string;
+}

package/dist/dtos/{tags → common}/search-by-name.dto.js

@@ -7,20 +7,29 @@ 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 } from 'class-validator';
-import { PaginationDto } from '../common/pagination.dto';
+import { IsNotEmpty, IsString } from 'class-validator';
+import { PaginationDto } from './pagination.dto.js';
 /**
- * DTO for searching tags by name.
+ * DTO for searching entities by name.
  *
- * Extends PaginationDto to include name search functionality.
- * Used by the Products microservice to search tags by name with pagination.
+ * This class extends PaginationDto and is designed to be used as a base
+ * DTO for search operations where a search by text (typically a name)
+ * is required. It is used across multiple modules to standardize
+ * search-by-name functionality and provide pagination support.
+ *
+ * @example
+ *   {
+ *     "name": "cheese",
+ *     "page": 1,
+ *     "limit": 10
+ *   }
  *
  * @since 2.0.0
  */
-export class SearchTagByNameDto extends PaginationDto {
+export class SearchByNameDto extends PaginationDto {
     /**
-     * Search term for tag name.
-     * Must not be empty.
+     * The search term for the entity name.
+     * Must be a non-empty string.
      *
      * @example "vegetarian"
      */
@@ -30,4 +39,4 @@ __decorate([
     IsString(),
     IsNotEmpty({ message: 'Search term is required' }),
     __metadata("design:type", String)
-], SearchTagByNameDto.prototype, "name", void 0);
+], SearchByNameDto.prototype, "name", void 0);

package/dist/dtos/index.d.ts

@@ -14,15 +14,15 @@
  *
  * @since 2.0.0
  */
-export * from "./common";
-export * from "./auth";
-export * from "./orders";
-export * from "./payments";
-export * from "./products";
-export * from "./categories";
-export * from "./restaurants";
-export * from "./chain";
-export * from "./tags";
-export * from "./ingredients";
-export * from "./questions";
-export * from "./translations";
+export * from "./common/index.js";
+export * from "./auth/index.js";
+export * from "./orders/index.js";
+export * from "./payments/index.js";
+export * from "./products/index.js";
+export * from "./categories/index.js";
+export * from "./restaurants/index.js";
+export * from "./chain/index.js";
+export * from "./tags/index.js";
+export * from "./ingredients/index.js";
+export * from "./questions/index.js";
+export * from "./translations/index.js";

package/dist/dtos/index.js

@@ -15,26 +15,26 @@
  * @since 2.0.0
  */
 // Common DTOs
-export * from "./common";
+export * from "./common/index.js";
 // Auth DTOs
-export * from "./auth";
+export * from "./auth/index.js";
 // Order DTOs
-export * from "./orders";
+export * from "./orders/index.js";
 // Payment DTOs
-export * from "./payments";
+export * from "./payments/index.js";
 // Product DTOs
-export * from "./products";
+export * from "./products/index.js";
 // Category DTOs
-export * from "./categories";
+export * from "./categories/index.js";
 // Restaurant DTOs
-export * from "./restaurants";
+export * from "./restaurants/index.js";
 // Chain DTOs
-export * from "./chain";
+export * from "./chain/index.js";
 // Tag DTOs
-export * from "./tags";
+export * from "./tags/index.js";
 // Ingredient DTOs
-export * from "./ingredients";
+export * from "./ingredients/index.js";
 // Question DTOs
-export * from "./questions";
+export * from "./questions/index.js";
 // Translations DTOs
-export * from "./translations";
+export * from "./translations/index.js";

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

@@ -2,27 +2,27 @@
  * DTO for creating a new ingredient.
  *
  * Used by the Products microservice to create new ingredients.
- * Ingredients are used in recipes and inventory management.
+ * Ingredients are utilized in recipes and inventory management.
  *
  * @since 2.0.0
  */
 export declare class CreateIngredientDto {
     /**
-     * Name of the ingredient.
-     * Must not be empty and maximum length of 100 characters.
+     * Ingredient name.
+     * Must not be empty and must have a maximum length of 25 characters.
      *
      * @example "Tomato"
      */
     name: string;
     /**
      * Unit of measurement for the ingredient.
-     * Must not be empty and maximum length of 20 characters.
+     * Must not be empty and must have a maximum length of 12 characters.
      *
      * @example "kg"
      */
     unit: string;
     /**
-     * User who created the ingredient.
+     * User ID of the user who created the ingredient.
      * Must be a valid MongoDB ObjectId.
      *
      * @example "507f1f77bcf86cd799439011"

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

@@ -12,27 +12,27 @@ import { IsString, IsNotEmpty, MaxLength, IsMongoId } from 'class-validator';
  * DTO for creating a new ingredient.
  *
  * Used by the Products microservice to create new ingredients.
- * Ingredients are used in recipes and inventory management.
+ * Ingredients are utilized in recipes and inventory management.
  *
  * @since 2.0.0
  */
 export class CreateIngredientDto {
     /**
-     * Name of the ingredient.
-     * Must not be empty and maximum length of 100 characters.
+     * Ingredient name.
+     * Must not be empty and must have a maximum length of 25 characters.
      *
      * @example "Tomato"
      */
     name;
     /**
      * Unit of measurement for the ingredient.
-     * Must not be empty and maximum length of 20 characters.
+     * Must not be empty and must have a maximum length of 12 characters.
      *
      * @example "kg"
      */
     unit;
     /**
-     * User who created the ingredient.
+     * User ID of the user who created the ingredient.
      * Must be a valid MongoDB ObjectId.
      *
      * @example "507f1f77bcf86cd799439011"
@@ -42,17 +42,18 @@ export class CreateIngredientDto {
 __decorate([
     IsString(),
     IsNotEmpty({ message: 'Ingredient name is required' }),
-    MaxLength(100, { message: 'Ingredient name must be at most 100 characters' }),
+    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(20, { message: 'Unit must be at most 20 characters' }),
+    MaxLength(12, { message: 'Unit must be at most 12 characters' }),
     __metadata("design:type", String)
 ], CreateIngredientDto.prototype, "unit", void 0);
 __decorate([
     IsString(),
-    IsMongoId(),
+    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/delete-ingredient.dto.d.ts

@@ -1,22 +1,29 @@
 /**
  * DTO for deleting an ingredient.
  *
- * Used by the Products microservice to soft-delete ingredients.
- * Includes ingredient ID and user who performed the deletion.
+ * Provides structure and validation for requests to soft-delete ingredients
+ * in the system. Used by the Products microservice to safely remove ingredient records.
+ * Captures which ingredient is being deleted and which user performs the operation for audit purposes.
  *
  * @since 2.0.0
+ *
+ * @example
+ * {
+ *   "ingredientId": "550e8400-e29b-41d4-a716-446655440000",
+ *   "deletedBy": "507f1f77bcf86cd799439011"
+ * }
  */
 export declare class DeleteIngredientDto {
     /**
-     * Ingredient ID to delete.
-     * Must be a valid UUID.
+     * Unique identifier of the ingredient to delete.
+     * Required. Must be a valid UUID string.
      *
      * @example "550e8400-e29b-41d4-a716-446655440000"
      */
-    id: string;
+    ingredientId: string;
     /**
-     * User who deleted the ingredient.
-     * Must be a valid MongoDB ObjectId.
+     * Unique identifier of the user performing the deletion.
+     * Required. Must be a valid MongoDB ObjectId.
      *
      * @example "507f1f77bcf86cd799439011"
      */

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

@@ -7,37 +7,46 @@ 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, IsMongoId, IsUUID } from 'class-validator';
+import { IsString, IsMongoId, IsUUID, IsNotEmpty } from 'class-validator';
 /**
  * DTO for deleting an ingredient.
  *
- * Used by the Products microservice to soft-delete ingredients.
- * Includes ingredient ID and user who performed the deletion.
+ * Provides structure and validation for requests to soft-delete ingredients
+ * in the system. Used by the Products microservice to safely remove ingredient records.
+ * Captures which ingredient is being deleted and which user performs the operation for audit purposes.
  *
  * @since 2.0.0
+ *
+ * @example
+ * {
+ *   "ingredientId": "550e8400-e29b-41d4-a716-446655440000",
+ *   "deletedBy": "507f1f77bcf86cd799439011"
+ * }
  */
 export class DeleteIngredientDto {
     /**
-     * Ingredient ID to delete.
-     * Must be a valid UUID.
+     * Unique identifier of the ingredient to delete.
+     * Required. Must be a valid UUID string.
      *
      * @example "550e8400-e29b-41d4-a716-446655440000"
      */
-    id;
+    ingredientId;
     /**
-     * User who deleted the ingredient.
-     * Must be a valid MongoDB ObjectId.
+     * Unique identifier of the user performing the deletion.
+     * Required. Must be a valid MongoDB ObjectId.
      *
      * @example "507f1f77bcf86cd799439011"
      */
     deletedBy;
 }
 __decorate([
+    IsNotEmpty({ message: 'ingredientId is required and must be a valid UUID.' }),
     IsString(),
     IsUUID(),
     __metadata("design:type", String)
-], DeleteIngredientDto.prototype, "id", void 0);
+], DeleteIngredientDto.prototype, "ingredientId", void 0);
 __decorate([
+    IsNotEmpty({ message: 'deletedBy is required and must be a valid MongoDB ObjectId.' }),
     IsString(),
     IsMongoId(),
     __metadata("design:type", String)

package/dist/dtos/ingredients/index.d.ts

@@ -6,7 +6,6 @@
  *
  * @since 2.0.0
  */
-export * from './create-ingredient.dto';
-export * from './update-ingredient.dto';
-export * from './delete-ingredient.dto';
-export * from './search-by-name.dto';
+export * from './create-ingredient.dto.js';
+export * from './update-ingredient.dto.js';
+export * from './delete-ingredient.dto.js';

package/dist/dtos/ingredients/index.js

@@ -6,7 +6,6 @@
  *
  * @since 2.0.0
  */
-export * from './create-ingredient.dto';
-export * from './update-ingredient.dto';
-export * from './delete-ingredient.dto';
-export * from './search-by-name.dto';
+export * from './create-ingredient.dto.js';
+export * from './update-ingredient.dto.js';
+export * from './delete-ingredient.dto.js';