qeai-sdk 2.0.0

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

@@ -0,0 +1,11 @@
+/**
+ * Category interfaces.
+ *
+ * This module exports interfaces used for category management
+ * in the Products microservice.
+ *
+ * @since 2.0.0
+ */
+export * from './category.interface';
+export * from './category-response.interface';
+export * from './categories-list-response.interface';

package/dist/interfaces/categories/index.js

@@ -0,0 +1,11 @@
+/**
+ * Category interfaces.
+ *
+ * This module exports interfaces used for category management
+ * in the Products microservice.
+ *
+ * @since 2.0.0
+ */
+export * from './category.interface';
+export * from './category-response.interface';
+export * from './categories-list-response.interface';

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

@@ -0,0 +1,16 @@
+import { ApiResponse } from '../common';
+import { Chain } from './chain.interface';
+/**
+ * Chain response interface.
+ *
+ * Represents the response structure for retrieving a single chain resource.
+ * Extends from the generic ApiResponse, encapsulating the chain data.
+ *
+ * @since 2.0.0
+ */
+export interface ChainResponse extends ApiResponse {
+    /**
+     * Chain data payload.
+     */
+    data: Chain;
+}

package/dist/interfaces/chains/chain-response.interface.js

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

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

@@ -0,0 +1,79 @@
+import { Currency } from '../../enums/currency.enum';
+/**
+ * Chain interface.
+ *
+ * Represents a restaurant chain entity.
+ * Chains are the top-level organizational unit that owns multiple restaurants.
+ * Each chain has global configuration like currency and tax percentage.
+ *
+ * @since 2.0.0
+ */
+export interface Chain {
+    /**
+     * Unique identifier of the chain.
+     *
+     * @example "8b3be09d-fff7-4f8e-aa00-9788f6e7e484"
+     */
+    id: string;
+    /**
+     * Chain name.
+     *
+     * @example "McDonald's"
+     * @example "Mar y Tierra"
+     */
+    name: string;
+    /**
+     * Currency code for the chain.
+     * Must be a valid Currency enum value following ISO 4217 format.
+     *
+     * @example Currency.PEN
+     * @example Currency.USD
+     * @example Currency.EUR
+     */
+    currency: Currency;
+    /**
+     * Global tax percentage for the chain.
+     * Applied across all restaurants in the chain.
+     *
+     * @example 8.5
+     * @example 0.0
+     */
+    taxPercent: number;
+    /**
+     * Date and time when the chain was created.
+     *
+     * @example "2024-01-15T10:30:00Z"
+     */
+    createdAt: Date;
+    /**
+     * Date and time when the chain was last updated.
+     *
+     * @example "2024-01-15T11:00:00Z"
+     */
+    updatedAt: Date;
+    /**
+     * Optional date and time when the chain was soft-deleted.
+     *
+     * @example null
+     * @example "2024-01-20T10:30:00Z"
+     */
+    deletedAt: Date | null;
+    /**
+     * Optional identifier of the user who created the chain.
+     *
+     * @example "68fc713cb9a5f6ee8fb7ae4e"
+     */
+    createdBy: string | null;
+    /**
+     * Optional identifier of the user who last updated the chain.
+     *
+     * @example "68fc713cb9a5f6ee8fb7ae4f"
+     */
+    updatedBy: string | null;
+    /**
+     * Optional identifier of the user who deleted the chain.
+     *
+     * @example "68fc713cb9a5f6ee8fb7ae4g"
+     */
+    deletedBy: string | null;
+}

package/dist/interfaces/chains/chain.interface.js

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

package/dist/interfaces/chains/chains-list-response.interface.d.ts

@@ -0,0 +1,17 @@
+import { ApiResponse } from '../common';
+import { PaginationResponse } from '../common/api-pagination-response.interface';
+import { Chain } from './chain.interface';
+/**
+ * Chains list response interface.
+ *
+ * Represents the response structure for retrieving a paginated list of chains.
+ * Extends from the generic ApiResponse and encapsulates a paginated list of chains.
+ *
+ * @since 2.0.0
+ */
+export interface ChainsListResponse extends ApiResponse {
+    /**
+     * Paginated data containing chains.
+     */
+    data: PaginationResponse<Chain>;
+}

package/dist/interfaces/chains/chains-list-response.interface.js

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

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

@@ -0,0 +1,11 @@
+/**
+ * Chain interfaces.
+ *
+ * This module exports interfaces used for chain management
+ * in the Products microservice.
+ *
+ * @since 2.0.0
+ */
+export * from './chain.interface';
+export * from './chain-response.interface';
+export * from './chains-list-response.interface';

package/dist/interfaces/chains/index.js

@@ -0,0 +1,11 @@
+/**
+ * Chain interfaces.
+ *
+ * This module exports interfaces used for chain management
+ * in the Products microservice.
+ *
+ * @since 2.0.0
+ */
+export * from './chain.interface';
+export * from './chain-response.interface';
+export * from './chains-list-response.interface';

package/dist/interfaces/common/api-error-response.interface.d.ts

@@ -0,0 +1,26 @@
+import { ApiResponse } from "./api-response.interface";
+import { AppError } from "./api-error.interface";
+/**
+ * ApiErrorResponse interface.
+ *
+ * Represents the standardized structure for failed API responses in all microservices.
+ *
+ * Extends {@link ApiResponse} and includes an {@link AppError} object describing
+ * the error details for debugging and client feedback.
+ *
+ * @since 2.0.0
+ */
+export interface ApiErrorResponse extends ApiResponse {
+    /**
+     * The error details object that provides information about the error.
+     *
+     * @example
+     * {
+     *   message: "User not found",
+     *   details: { "field": "userId", "error": "Invalid UUID format" },
+     *   context: "UserService",
+     *   timestamp: "2024-01-15T10:30:00Z"
+     * }
+     */
+    error: AppError;
+}

package/dist/interfaces/common/api-error-response.interface.js

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

package/dist/interfaces/common/api-error.interface.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Application error interface.
+ *
+ * Represents a standardized error structure used across all microservices
+ * for consistent error handling and reporting.
+ *
+ * @since 2.0.0
+ */
+export interface AppError {
+    /**
+     * Main error message to display to the client.
+     * Should be user-friendly and descriptive.
+     *
+     * @example "User not found"
+     * @example "Invalid request data"
+     * @example "Payment processing failed"
+     */
+    message: string;
+    /**
+     * Optional additional error details.
+     * Can contain validation errors, nested errors, or additional context.
+     *
+     * @example { "field": "email", "error": "Invalid email format" }
+     * @example ["Error 1", "Error 2"]
+     */
+    details?: Record<string, any> | string[];
+    /**
+     * Optional context information about the service or module
+     * that generated the error.
+     *
+     * @example "AuthService"
+     * @example "OrderController"
+     * @example "PaymentProvider"
+     */
+    context?: string;
+    /**
+     * Timestamp when the error occurred.
+     * ISO 8601 format string.
+     *
+     * @example "2024-01-15T10:30:00Z"
+     */
+    timestamp: string;
+}

package/dist/interfaces/common/api-error.interface.js

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

package/dist/interfaces/common/api-pagination-response.interface.d.ts

@@ -0,0 +1,9 @@
+export interface PaginationResponse<K> {
+    list: K[];
+    meta: Meta;
+}
+export interface Meta {
+    total: number;
+    page: number;
+    lastPage: number;
+}

package/dist/interfaces/common/api-pagination-response.interface.js

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

package/dist/interfaces/common/api-response.interface.d.ts

@@ -0,0 +1,36 @@
+import { HttpStatusCode } from "../../enums/http-status-code.enum";
+import { HttpStatusText } from "../../enums/http-status-text.enum";
+/**
+ * ApiResponse interface.
+ *
+ * Represents a standardized structure for API responses across all microservices,
+ * ensuring consistency for successful or failed requests.
+ *
+ * @since 2.0.0
+ */
+export interface ApiResponse {
+    /**
+     * Indicates whether the API request was successful.
+     *
+     * @example true
+     * @example false
+     */
+    success: boolean;
+    /**
+     * HTTP status code (standard status code for the response).
+     *
+     * @example HttpStatusCode.OK
+     * @example HttpStatusCode.BAD_REQUEST
+     * @example HttpStatusCode.UNAUTHORIZED
+     */
+    statusCode: HttpStatusCode;
+    /**
+     * Textual representation of the HTTP status code.
+     * Used for logging and debugging purposes.
+     *
+     * @example HttpStatusText.OK
+     * @example HttpStatusText.BAD_REQUEST
+     * @example HttpStatusText.UNAUTHORIZED
+     */
+    statusText: HttpStatusText;
+}

package/dist/interfaces/common/api-response.interface.js

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

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

@@ -0,0 +1,13 @@
+/**
+ * Common interfaces used across all microservices.
+ *
+ * This module exports shared interfaces for error handling,
+ * communication patterns, pagination, and other cross-cutting concerns.
+ *
+ * @since 2.0.0
+ */
+export * from './api-error.interface';
+export * from './rpc-error.interface';
+export * from './api-response.interface';
+export * from './api-pagination-response.interface';
+export * from './api-error-response.interface';

package/dist/interfaces/common/index.js

@@ -0,0 +1,13 @@
+/**
+ * Common interfaces used across all microservices.
+ *
+ * This module exports shared interfaces for error handling,
+ * communication patterns, pagination, and other cross-cutting concerns.
+ *
+ * @since 2.0.0
+ */
+export * from './api-error.interface';
+export * from './rpc-error.interface';
+export * from './api-response.interface';
+export * from './api-pagination-response.interface';
+export * from './api-error-response.interface';

package/dist/interfaces/common/rpc-error.interface.d.ts

@@ -0,0 +1,36 @@
+import { HttpStatusCode } from "../../enums/http-status-code.enum";
+/**
+ * RPC (Remote Procedure Call) error interface.
+ *
+ * Represents error structure for inter-service communication
+ * in microservices architecture using message brokers (e.g., NATS).
+ * This interface is used when errors need to be serialized
+ * and transmitted between services.
+ *
+ * @since 2.0.0
+ */
+export interface RpcError {
+    /**
+     * HTTP status code for the error.
+     *
+     * @example HttpStatusCode.NOT_FOUND
+     * @example HttpStatusCode.BAD_REQUEST
+     * @example HttpStatusCode.INTERNAL
+     */
+    status: HttpStatusCode;
+    /**
+     * Error message describing what went wrong.
+     *
+     * @example "Order not found"
+     * @example "Invalid payment method"
+     */
+    message: string;
+    /**
+     * Additional error details.
+     * Can be a string or an object with structured error information.
+     *
+     * @example "Validation failed: email is required"
+     * @example { "field": "email", "constraints": ["isEmail", "isNotEmpty"] }
+     */
+    details: string | Record<string, any>;
+}

package/dist/interfaces/common/rpc-error.interface.js

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

package/dist/interfaces/index.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Centralized interfaces for the QeHay platform.
+ *
+ * This module exports all interfaces organized by domain for use across
+ * all microservices and the client gateway.
+ *
+ * Usage examples:
+ *    - import { AppError, RpcError } from 'looroh-sdk-qhay-interfaces';
+ *    - import { User, PayloadJwt } from 'looroh-sdk-qhay-interfaces';
+ *    - import { OrderItem, OrderWithProducts } from 'looroh-sdk-qhay-interfaces';
+ *    - import { Product, ProductSize } from 'looroh-sdk-qhay-interfaces';
+ *    - import { Chain, Restaurant, Category } from 'looroh-sdk-qhay-interfaces';
+ *
+ * All interfaces are properly documented for API documentation generation
+ * and type safety across the platform.
+ *
+ * @since 2.0.0
+ */
+export * from './common';
+export * from './auth';
+export * from './orders';
+export * from './payments';
+export * from './products';
+export * from './chains';
+export * from './restaurants';
+export * from './categories';
+export * from './tags';
+export * from './ingredients';
+export * from './translations';
+export * from './questions';

package/dist/interfaces/index.js

@@ -0,0 +1,42 @@
+/**
+ * Centralized interfaces for the QeHay platform.
+ *
+ * This module exports all interfaces organized by domain for use across
+ * all microservices and the client gateway.
+ *
+ * Usage examples:
+ *    - import { AppError, RpcError } from 'looroh-sdk-qhay-interfaces';
+ *    - import { User, PayloadJwt } from 'looroh-sdk-qhay-interfaces';
+ *    - import { OrderItem, OrderWithProducts } from 'looroh-sdk-qhay-interfaces';
+ *    - import { Product, ProductSize } from 'looroh-sdk-qhay-interfaces';
+ *    - import { Chain, Restaurant, Category } from 'looroh-sdk-qhay-interfaces';
+ *
+ * All interfaces are properly documented for API documentation generation
+ * and type safety across the platform.
+ *
+ * @since 2.0.0
+ */
+// Common interfaces
+export * from './common';
+// Auth interfaces
+export * from './auth';
+// Order interfaces
+export * from './orders';
+// Payment interfaces
+export * from './payments';
+// Product interfaces
+export * from './products';
+// Chain interfaces
+export * from './chains';
+// Restaurant interfaces
+export * from './restaurants';
+// Category interfaces
+export * from './categories';
+// Tag interfaces
+export * from './tags';
+// Ingredient interfaces
+export * from './ingredients';
+// Translation interfaces
+export * from './translations';
+// Questions interfaces
+export * from './questions';

package/dist/interfaces/ingredients/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.interface';
+export * from './ingredient-response.interface';
+export * from './ingredients-list-response.interface';

package/dist/interfaces/ingredients/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.interface';
+export * from './ingredient-response.interface';
+export * from './ingredients-list-response.interface';

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

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

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

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

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

@@ -0,0 +1,79 @@
+/**
+ * Ingredient interface.
+ *
+ * Represents ingredients used in product recipes.
+ * Ingredients are reusable across multiple products and recipes.
+ * Used for inventory management, cost calculation, and recipe tracking.
+ *
+ * @since 2.0.0
+ */
+export interface Ingredient {
+    /**
+     * Unique identifier of the ingredient.
+     *
+     * @example "880e8400-e29b-41d4-a716-446655440003"
+     */
+    id: string;
+    /**
+     * Name of the ingredient.
+     * Must be unique across all ingredients.
+     *
+     * @example "Tomato"
+     * @example "Cheese"
+     * @example "Beef Patty"
+     */
+    name: string;
+    /**
+     * Unit of measurement for the ingredient.
+     * Used for recipe quantities and inventory tracking.
+     *
+     * @example "grams"
+     * @example "ml"
+     * @example "pieces"
+     */
+    unit: string;
+    /**
+     * Whether the ingredient is active/available.
+     * Determines if the ingredient can be used in recipes.
+     *
+     * @example true
+     * @example false
+     */
+    status: boolean;
+    /**
+     * Date and time when the ingredient was created.
+     *
+     * @example "2024-01-15T10:30:00Z"
+     */
+    createdAt: Date;
+    /**
+     * Date and time when the ingredient was last updated.
+     *
+     * @example "2024-01-15T11:00:00Z"
+     */
+    updatedAt: Date;
+    /**
+     * Optional date and time when the ingredient was soft-deleted.
+     *
+     * @example "2024-01-20T10:30:00Z"
+     */
+    deletedAt?: Date;
+    /**
+     * Optional identifier of the user who created the ingredient.
+     *
+     * @example "507f1f77bcf86cd799439011"
+     */
+    createdBy?: string;
+    /**
+     * Optional identifier of the user who last updated the ingredient.
+     *
+     * @example "507f1f77bcf86cd799439012"
+     */
+    updatedBy?: string;
+    /**
+     * Optional identifier of the user who deleted the ingredient.
+     *
+     * @example "507f1f77bcf86cd799439013"
+     */
+    deletedBy?: string;
+}

package/dist/interfaces/ingredients/ingredient.interface.js

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

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

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

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

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

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

@@ -0,0 +1,14 @@
+/**
+ * Order interfaces.
+ *
+ * This module exports interfaces used for order management
+ * in the Orders microservice.
+ *
+ * @since 2.0.0
+ */
+export * from './order-item.interface';
+export * from './order-with-products.interface';
+export * from './order-created.interface';
+export * from './order-creation-strategy.interface';
+export * from './order.interface';
+export * from './responses';

package/dist/interfaces/orders/index.js

@@ -0,0 +1,15 @@
+/**
+ * Order interfaces.
+ *
+ * This module exports interfaces used for order management
+ * in the Orders microservice.
+ *
+ * @since 2.0.0
+ */
+export * from './order-item.interface';
+export * from './order-with-products.interface';
+export * from './order-created.interface';
+export * from './order-creation-strategy.interface';
+export * from './order.interface';
+// Responses
+export * from './responses';