qeai-sdk 2.0.0

package/dist/interfaces/payments/payment-succeeded-payload.interface.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Payment succeeded payload interface.
+ *
+ * Represents the payload structure when a payment is successfully processed.
+ * Used for event notifications and order status updates.
+ *
+ * @since 2.0.0
+ */
+export interface PaymentSucceededPayload {
+    /**
+     * Payment charge identifier from the payment provider.
+     *
+     * @example "ch_1234567890abcdef"
+     * @example "pay_abc123def456"
+     */
+    paymentChargeId: string;
+    /**
+     * Unique identifier of the paid order.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    orderId: string;
+    /**
+     * URL to the payment receipt.
+     *
+     * @example "https://payments.example.com/receipts/receipt_123456"
+     */
+    receiptUrl: string;
+}

package/dist/interfaces/payments/payment-succeeded-payload.interface.js

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

package/dist/interfaces/payments/responses/payment-callback-response.interface.d.ts

@@ -0,0 +1,8 @@
+import { ApiResponse } from "../../common";
+export interface PaymentCallbackResponse extends ApiResponse {
+    data: PaymentCallbackResponseData;
+}
+export interface PaymentCallbackResponseData {
+    ok: boolean;
+    message: string;
+}

package/dist/interfaces/payments/responses/payment-callback-response.interface.js

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

package/dist/interfaces/payments/stripe-session-response.interface.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Payment session response interface.
+ *
+ * Represents the response structure after creating a payment session.
+ * Contains URLs for payment completion and cancellation.
+ *
+ * @since 2.0.0
+ */
+export interface StripeSessionResponse {
+    /**
+     * URL to redirect user if payment is cancelled.
+     *
+     * @example "https://example.com/checkout/cancel"
+     */
+    cancelUrl: string;
+    /**
+     * URL to redirect user after successful payment.
+     *
+     * @example "https://example.com/checkout/success"
+     */
+    successUrl: string;
+    /**
+     * URL to the payment checkout page.
+     * User should be redirected here to complete payment.
+     *
+     * @example "https://checkout.stripe.com/pay/cs_..."
+     */
+    url: string;
+}

package/dist/interfaces/payments/stripe-session-response.interface.js

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

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

@@ -0,0 +1,16 @@
+/**
+ * Product interfaces.
+ *
+ * This module exports interfaces used for product management,
+ * product relations, and product submodules in the Products microservice.
+ *
+ * @since 2.0.0
+ */
+export * from './product.interface';
+export * from './product-size.interface';
+export * from './product-translation.interface';
+export * from './product-recipe.interface';
+export * from './product-schedule.interface';
+export * from './product-image.interface';
+export * from './product-tag.interface';
+export * from './response';

package/dist/interfaces/products/index.js

@@ -0,0 +1,17 @@
+/**
+ * Product interfaces.
+ *
+ * This module exports interfaces used for product management,
+ * product relations, and product submodules in the Products microservice.
+ *
+ * @since 2.0.0
+ */
+export * from './product.interface';
+export * from './product-size.interface';
+export * from './product-translation.interface';
+export * from './product-recipe.interface';
+export * from './product-schedule.interface';
+export * from './product-image.interface';
+export * from './product-tag.interface';
+//Responses
+export * from './response';

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

@@ -0,0 +1,55 @@
+/**
+ * Product image interface.
+ *
+ * Represents images associated with products.
+ * Products can have multiple images, with one marked as primary
+ * for display purposes.
+ *
+ * @since 2.0.0
+ */
+export interface ProductImage {
+    /**
+     * Unique identifier of the image.
+     *
+     * @example "cc0e8400-e29b-41d4-a716-446655440007"
+     */
+    id: string;
+    /**
+     * Unique identifier of the product.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    productId: string;
+    /**
+     * URL of the image.
+     *
+     * @example "https://example.com/images/products/big-mac.jpg"
+     */
+    url: string;
+    /**
+     * Whether this is the primary image for the product.
+     * Only one image per product should be primary.
+     *
+     * @example true
+     * @example false
+     */
+    isPrimary: boolean;
+    /**
+     * Date and time when the image was created.
+     *
+     * @example "2024-01-15T10:30:00Z"
+     */
+    createdAt: Date;
+    /**
+     * Date and time when the image was last updated.
+     *
+     * @example "2024-01-15T11:00:00Z"
+     */
+    updatedAt: Date;
+    /**
+     * Optional date and time when the image was soft-deleted.
+     *
+     * @example "2024-01-20T10:30:00Z"
+     */
+    deletedAt?: Date;
+}

package/dist/interfaces/products/product-image.interface.js

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

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

@@ -0,0 +1,50 @@
+import { Ingredient } from '../ingredients/ingredient.interface';
+/**
+ * Product recipe interface.
+ *
+ * Represents the relationship between products and ingredients,
+ * defining how much of each ingredient is needed to prepare a product.
+ * Used for recipe management, cost calculation, and inventory tracking.
+ *
+ * @since 2.0.0
+ */
+export interface ProductRecipe {
+    /**
+     * Unique identifier of the recipe entry.
+     *
+     * @example "990e8400-e29b-41d4-a716-446655440004"
+     */
+    id: string;
+    /**
+     * Unique identifier of the product.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    productId: string;
+    /**
+     * Unique identifier of the ingredient.
+     *
+     * @example "880e8400-e29b-41d4-a716-446655440003"
+     */
+    ingredientId: string;
+    /**
+     * Optional ingredient object (loaded when fetched with relations).
+     * Contains full ingredient details.
+     */
+    ingredient?: Ingredient;
+    /**
+     * Quantity of the ingredient needed.
+     *
+     * @example 200
+     * @example 50.5
+     */
+    quantity: number;
+    /**
+     * Unit of measurement for the quantity.
+     *
+     * @example "grams"
+     * @example "ml"
+     * @example "pieces"
+     */
+    unit: string;
+}

package/dist/interfaces/products/product-recipe.interface.js

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

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

@@ -0,0 +1,45 @@
+/**
+ * Product schedule interface.
+ *
+ * Represents time-based product availability schedules.
+ * Defines when a product is available for ordering during the week.
+ * Used to handle time-restricted products or special availability hours.
+ *
+ * @since 2.0.0
+ */
+export interface ProductSchedule {
+    /**
+     * Unique identifier of the schedule entry.
+     *
+     * @example "bb0e8400-e29b-41d4-a716-446655440006"
+     */
+    id: string;
+    /**
+     * Unique identifier of the product.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    productId: string;
+    /**
+     * Day of week (0-6, where 0 is Sunday and 6 is Saturday).
+     * Alternative: 1-7 where 1 is Monday and 7 is Sunday.
+     *
+     * @example 1 (Monday)
+     * @example 5 (Friday)
+     */
+    dayOfWeek: number;
+    /**
+     * Start time in HH:MM format (24-hour format).
+     *
+     * @example "09:00"
+     * @example "18:00"
+     */
+    startTime: string;
+    /**
+     * End time in HH:MM format (24-hour format).
+     *
+     * @example "22:00"
+     * @example "23:59"
+     */
+    endTime: string;
+}

package/dist/interfaces/products/product-schedule.interface.js

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

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

@@ -0,0 +1,62 @@
+/**
+ * Product size interface.
+ *
+ * Represents different size variants of a product (e.g., Small, Medium, Large).
+ * Each size variant can have its own price and availability status.
+ *
+ * @since 2.0.0
+ */
+export interface ProductSize {
+    /**
+     * Unique identifier of the size variant.
+     *
+     * @example "660e8400-e29b-41d4-a716-446655440001"
+     */
+    id: string;
+    /**
+     * Unique identifier of the product this size belongs to.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    productId: string;
+    /**
+     * Name of the size variant.
+     *
+     * @example "Large"
+     * @example "Medium"
+     * @example "Small"
+     */
+    name: string;
+    /**
+     * Price for this size variant.
+     *
+     * @example 12.99
+     * @example 9.99
+     */
+    price: number;
+    /**
+     * Whether this size variant is active/available.
+     *
+     * @example true
+     * @example false
+     */
+    status: boolean;
+    /**
+     * Date and time when the size variant was created.
+     *
+     * @example "2024-01-15T10:30:00Z"
+     */
+    createdAt: Date;
+    /**
+     * Date and time when the size variant was last updated.
+     *
+     * @example "2024-01-15T11:00:00Z"
+     */
+    updatedAt: Date;
+    /**
+     * Optional date and time when the size variant was soft-deleted.
+     *
+     * @example "2024-01-20T10:30:00Z"
+     */
+    deletedAt?: Date;
+}

package/dist/interfaces/products/product-size.interface.js

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

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

@@ -0,0 +1,28 @@
+import { Tag } from '../tags/tag.interface';
+/**
+ * Product tag interface.
+ *
+ * Represents the many-to-many relationship between products and tags.
+ * Allows products to have multiple tags for categorization and searchability.
+ *
+ * @since 2.0.0
+ */
+export interface ProductTag {
+    /**
+     * Unique identifier of the product.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    productId: string;
+    /**
+     * Unique identifier of the tag.
+     *
+     * @example "aa0e8400-e29b-41d4-a716-446655440005"
+     */
+    tagId: string;
+    /**
+     * Optional tag object (loaded when fetched with relations).
+     * Contains full tag details.
+     */
+    tag?: Tag;
+}

package/dist/interfaces/products/product-tag.interface.js

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

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

@@ -0,0 +1,43 @@
+/**
+ * Product translation interface.
+ *
+ * Represents multi-language support for products.
+ * Allows products to have different names and descriptions
+ * in different languages.
+ *
+ * @since 2.0.0
+ */
+export interface ProductTranslation {
+    /**
+     * Unique identifier of the translation.
+     *
+     * @example "770e8400-e29b-41d4-a716-446655440002"
+     */
+    id: string;
+    /**
+     * Unique identifier of the product this translation belongs to.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    productId: string;
+    /**
+     * Language code (ISO 639-1 or similar).
+     *
+     * @example "en"
+     * @example "es"
+     * @example "fr"
+     */
+    languageCode: string;
+    /**
+     * Translated product name.
+     *
+     * @example "Gran Mac" (Spanish translation of "Big Mac")
+     */
+    name: string;
+    /**
+     * Optional translated product description.
+     *
+     * @example "Dos hamburguesas de carne, salsa especial, lechuga, queso, pepinillos, cebollas en pan de sésamo"
+     */
+    description?: string;
+}

package/dist/interfaces/products/product-translation.interface.js

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

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

@@ -0,0 +1,113 @@
+import { ProductSize, ProductImage, ProductTag, ProductSchedule, ProductRecipe } from './';
+import { ProductStatus } from '../../enums/product-status.enum';
+import { Translation } from '../translations/translation.interface';
+/**
+ * Product interface.
+ *
+ * Represents the canonical product data structure with all
+ * associated relations (sizes, translations, images, tags, schedules, recipes).
+ * This is the main product entity used across the platform.
+ *
+ * @since 2.0.0
+ */
+export interface Product {
+    /**
+     * Unique identifier of the product.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    id: string;
+    /**
+     * Optional product SKU (Stock Keeping Unit).
+     * Used for inventory management and identification.
+     *
+     * @example "PROD-001"
+     */
+    sku?: string;
+    /**
+     * Product name.
+     *
+     * @example "Big Mac"
+     */
+    name: string;
+    /**
+     * Optional product description.
+     *
+     * @example "Two all-beef patties, special sauce, lettuce, cheese, pickles, onions on a sesame seed bun"
+     */
+    description?: string;
+    /**
+     * Product base price.
+     *
+     * @example 5.99
+     */
+    basePrice: number;
+    /**
+     * Product status.
+     *
+     * @example ProductStatus.ACTIVE
+     * @example ProductStatus.INACTIVE
+     * @example ProductStatus.OUT_OF_STOCK
+     */
+    status: ProductStatus;
+    /**
+     * Date and time when the product was created.
+     *
+     * @example "2024-01-15T10:30:00Z"
+     */
+    createdAt: Date;
+    /**
+     * Date and time when the product was last updated.
+     *
+     * @example "2024-01-15T11:00:00Z"
+     */
+    updatedAt: Date;
+    /**
+     * Optional date and time when the product was soft-deleted.
+     *
+     * @example "2024-01-20T10:30:00Z"
+     */
+    deletedAt?: Date;
+    /**
+     * Optional identifier of the user who created the product.
+     *
+     * @example "507f1f77bcf86cd799439011"
+     */
+    createdBy?: string;
+    /**
+     * Optional identifier of the user who last updated the product.
+     *
+     * @example "507f1f77bcf86cd799439012"
+     */
+    updatedBy?: string;
+    /**
+     * Optional array of product size variants.
+     * Loaded when product is fetched with size relations.
+     */
+    sizes?: ProductSize[];
+    /**
+     * Optional array of product translations.
+     * Loaded when product is fetched with translation relations.
+     */
+    translations?: Translation[];
+    /**
+     * Optional array of product images.
+     * Loaded when product is fetched with image relations.
+     */
+    images?: ProductImage[];
+    /**
+     * Optional array of product tags.
+     * Loaded when product is fetched with tag relations.
+     */
+    tags?: ProductTag[];
+    /**
+     * Optional array of product availability schedules.
+     * Loaded when product is fetched with schedule relations.
+     */
+    schedules?: ProductSchedule[];
+    /**
+     * Optional array of product recipe entries.
+     * Loaded when product is fetched with recipe relations.
+     */
+    recipe?: ProductRecipe[];
+}

package/dist/interfaces/products/product.interface.js

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

package/dist/interfaces/products/response/complete-product-response.interface.d.ts

@@ -0,0 +1,5 @@
+import { ApiResponse } from "../../common";
+import { Product } from "../product.interface";
+export interface CompleteProductResponse extends ApiResponse {
+    data: Product;
+}

package/dist/interfaces/products/response/complete-product-response.interface.js

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

package/dist/interfaces/products/response/index.d.ts

@@ -0,0 +1,6 @@
+export * from './complete-product-response.interface';
+export * from './product-response.interface';
+export * from './sub-resources/sub-resource-response.interface';
+export * from './products-list-response.interface';
+export * from './simple-product-response.interface';
+export * from './sub-resources';

package/dist/interfaces/products/response/index.js

@@ -0,0 +1,6 @@
+export * from './complete-product-response.interface';
+export * from './product-response.interface';
+export * from './sub-resources/sub-resource-response.interface';
+export * from './products-list-response.interface';
+export * from './simple-product-response.interface';
+export * from './sub-resources';

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

@@ -0,0 +1,5 @@
+import { ApiResponse } from "../../common";
+import { SimpleProductResponse } from "./simple-product-response.interface";
+export interface ProductResponse extends ApiResponse {
+    data: SimpleProductResponse;
+}

package/dist/interfaces/products/response/product-response.interface.js

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

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

@@ -0,0 +1,6 @@
+import { ApiResponse } from "../../common";
+import { PaginationResponse } from "../../common/api-pagination-response.interface";
+import { SimpleProductResponse } from "./simple-product-response.interface";
+export interface ProductsListResponse extends ApiResponse {
+    data: PaginationResponse<SimpleProductResponse>;
+}

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

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

package/dist/interfaces/products/response/simple-product-response.interface.d.ts

@@ -0,0 +1,3 @@
+import { Product } from "../product.interface";
+export interface SimpleProductResponse extends Omit<Product, "sizes" | "translations" | "images" | "tags" | "schedules" | "recipe"> {
+}

package/dist/interfaces/products/response/simple-product-response.interface.js

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

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

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

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

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

package/dist/interfaces/products/response/sub-resources/delete-sub-resource-response.interface.d.ts

@@ -0,0 +1,9 @@
+import { ApiResponse } from "../../../common";
+export interface DeleteSubResourceResponse extends ApiResponse {
+    data: DeleteSubResourceResponse;
+}
+export interface DeleteSubResourceResponseData {
+    message: string;
+    productId: string;
+    deletedCount: number;
+}

package/dist/interfaces/products/response/sub-resources/delete-sub-resource-response.interface.js

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

package/dist/interfaces/products/response/sub-resources/find-product-image-response.interface.d.ts

@@ -0,0 +1,4 @@
+import { ProductImage } from "../../product-image.interface";
+import { FindSubResourceResponse } from "./find-sub-resource-response.interface";
+export interface FindProductImageResponse extends FindSubResourceResponse<Omit<ProductImage, "productId" | "createdAt" | "updatedAt" | "deletedAt">> {
+}

package/dist/interfaces/products/response/sub-resources/find-product-image-response.interface.js

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

package/dist/interfaces/products/response/sub-resources/find-product-question-response.interface.d.ts

@@ -0,0 +1,4 @@
+import { FindSubResourceResponse } from "./find-sub-resource-response.interface";
+import { QuestionRelationship } from "./question-relationship.interface";
+export interface FindProductQuestionResponse extends FindSubResourceResponse<QuestionRelationship> {
+}

package/dist/interfaces/products/response/sub-resources/find-product-question-response.interface.js

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

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

@@ -0,0 +1,4 @@
+import { FindSubResourceResponse } from "./find-sub-resource-response.interface";
+import { RecipeRelationship } from "./recipe-relationship.interface";
+export interface FindProductRecipeResponse extends FindSubResourceResponse<RecipeRelationship> {
+}

package/dist/interfaces/products/response/sub-resources/find-product-recipe-response.interface.js

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

package/dist/interfaces/products/response/sub-resources/find-product-schedule-response.interface.d.ts

@@ -0,0 +1,4 @@
+import { ProductSchedule } from "../../product-schedule.interface";
+import { FindSubResourceResponse } from "./find-sub-resource-response.interface";
+export interface FindProductScheduleResponse extends FindSubResourceResponse<ProductSchedule> {
+}

package/dist/interfaces/products/response/sub-resources/find-product-schedule-response.interface.js

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

package/dist/interfaces/products/response/sub-resources/find-product-size-response.interface.d.ts

@@ -0,0 +1,4 @@
+import { ProductSize } from "../../product-size.interface";
+import { FindSubResourceResponse } from "./find-sub-resource-response.interface";
+export interface FindProductSizeResponse extends FindSubResourceResponse<Omit<ProductSize, "productId" | "createdAt" | "updatedAt" | "deletedAt">> {
+}