qeai-sdk 2.0.0

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

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

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

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

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

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

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

@@ -0,0 +1,4 @@
+import { ApiResponse } from "../../../common";
+export interface FindSubResourceResponse<K> extends ApiResponse {
+    data: K;
+}

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

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

package/dist/interfaces/products/response/sub-resources/index.d.ts

@@ -0,0 +1,25 @@
+export * from "./find-product-image-response.interface";
+export * from "./find-product-question-response.interface";
+export * from "./find-product-recipe-response.interface";
+export * from "./find-product-schedule-response.interface";
+export * from "./find-product-size-response.interface";
+export * from "./find-product-tag-response.interface";
+export * from "./find-sub-resource-response.interface";
+export * from "./list-product-images-response.interface";
+export * from "./list-product-questions-response.interface";
+export * from "./list-product-recipes-response.interface";
+export * from "./list-product-schedules-response.interface";
+export * from "./list-product-sizes-response.interface";
+export * from "./list-sub-resource-response.interface";
+export * from "./create-tag-response.interface";
+export * from "./delete-sub-resource-response.interface";
+export * from "./write-image-response.interface";
+export * from "./write-question-product-response.interface";
+export * from "./write-recipe-response.interface";
+export * from "./write-schedule-response.interface";
+export * from "./write-size-response.interface";
+export * from "./product-schedule-availability.interface";
+export * from "./question-relationship.interface";
+export * from "./recipe-relationship.interface";
+export * from "./replace-sub-products-response.interface";
+export * from "./sub-resource-response.interface";

package/dist/interfaces/products/response/sub-resources/index.js

@@ -0,0 +1,25 @@
+export * from "./find-product-image-response.interface";
+export * from "./find-product-question-response.interface";
+export * from "./find-product-recipe-response.interface";
+export * from "./find-product-schedule-response.interface";
+export * from "./find-product-size-response.interface";
+export * from "./find-product-tag-response.interface";
+export * from "./find-sub-resource-response.interface";
+export * from "./list-product-images-response.interface";
+export * from "./list-product-questions-response.interface";
+export * from "./list-product-recipes-response.interface";
+export * from "./list-product-schedules-response.interface";
+export * from "./list-product-sizes-response.interface";
+export * from "./list-sub-resource-response.interface";
+export * from "./create-tag-response.interface";
+export * from "./delete-sub-resource-response.interface";
+export * from "./write-image-response.interface";
+export * from "./write-question-product-response.interface";
+export * from "./write-recipe-response.interface";
+export * from "./write-schedule-response.interface";
+export * from "./write-size-response.interface";
+export * from "./product-schedule-availability.interface";
+export * from "./question-relationship.interface";
+export * from "./recipe-relationship.interface";
+export * from "./replace-sub-products-response.interface";
+export * from "./sub-resource-response.interface";

package/dist/interfaces/products/response/sub-resources/list-product-images-response.interface.d.ts

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

package/dist/interfaces/products/response/sub-resources/list-product-images-response.interface.js

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

package/dist/interfaces/products/response/sub-resources/list-product-questions-response.interface.d.ts

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

package/dist/interfaces/products/response/sub-resources/list-product-questions-response.interface.js

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

package/dist/interfaces/products/response/sub-resources/list-product-recipes-response.interface.d.ts

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

package/dist/interfaces/products/response/sub-resources/list-product-recipes-response.interface.js

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

package/dist/interfaces/products/response/sub-resources/list-product-schedules-response.interface.d.ts

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

package/dist/interfaces/products/response/sub-resources/list-product-schedules-response.interface.js

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

package/dist/interfaces/products/response/sub-resources/list-product-sizes-response.interface.d.ts

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

package/dist/interfaces/products/response/sub-resources/list-product-sizes-response.interface.js

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

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

@@ -0,0 +1,8 @@
+import { ApiResponse } from "../../../common";
+export interface ListSubResourceResponse<K = ListSubResourceResponseData> extends ApiResponse {
+    data: K[];
+}
+export interface ListSubResourceResponseData {
+    id: string;
+    name: string;
+}

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

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

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

@@ -0,0 +1,7 @@
+import { ApiResponse } from "../../../common";
+export interface ProductScheduleAvailability extends ApiResponse {
+    data: ProductScheduleAvailabilityData;
+}
+export interface ProductScheduleAvailabilityData {
+    isAvailable: boolean;
+}

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

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

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

@@ -0,0 +1,7 @@
+import { Question } from "../../../questions/question.interface";
+export interface QuestionRelationship {
+    id: string;
+    position: number;
+    itemType: string;
+    question: Omit<Question, "createdAt" | "updatedAt" | "deletedAt" | "createdBy" | "updatedBy" | "deletedBy">;
+}

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

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

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

@@ -0,0 +1,9 @@
+import { Ingredient } from "../../../ingredients";
+export interface RecipeRelationship {
+    message: string;
+    id: string;
+    quantity: number;
+    productId: string;
+    unit: string;
+    ingredient: Omit<Ingredient, "createdAt" | "updatedAt" | "deletedAt">;
+}

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

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

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

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

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

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

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

@@ -0,0 +1,10 @@
+import { ApiResponse } from "../../../common";
+export interface SubResourceResponse<K, Key extends string> extends ApiResponse {
+    data: SubResourceResponseData<K, Key>;
+}
+export type SubResourceResponseData<K, Key extends string> = {
+    message: string;
+    productId: string;
+} & {
+    [P in Key]: K;
+};

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

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

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

@@ -0,0 +1,12 @@
+import { ProductImage } from "../../product-image.interface";
+import { SubResourceResponse } from "./sub-resource-response.interface";
+/**
+ * CreateImageResponse interface.
+ *
+ * Represents the response after creating a product image sub-resource.
+ * Omits fields that are not relevant in the response context.
+ *
+ * @since 2.0.0
+ */
+export interface WriteImageResponse extends SubResourceResponse<Omit<ProductImage, "productId" | "createdAt" | "updatedAt" | "deletedAt">, "image"> {
+}

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,4 @@
+import { ProductSchedule } from "../../product-schedule.interface";
+import { SubResourceResponse } from "./sub-resource-response.interface";
+export interface WriteScheduleResponse extends SubResourceResponse<Omit<ProductSchedule, "productId">, "schedule"> {
+}

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

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

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

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

package/dist/interfaces/products/response/sub-resources/write-size-response.interface.js

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

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

@@ -0,0 +1,3 @@
+export * from "./question.interface";
+export * from "./question-response.interface";
+export * from "./questions-list-response.interface";

package/dist/interfaces/questions/index.js

@@ -0,0 +1,3 @@
+export * from "./question.interface";
+export * from "./question-response.interface";
+export * from "./questions-list-response.interface";

package/dist/interfaces/questions/question-response.interface.d.ts

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

package/dist/interfaces/questions/question-response.interface.js

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

package/dist/interfaces/questions/question.interface.d.ts

@@ -0,0 +1,15 @@
+export interface Question {
+    id: string;
+    name: string;
+    required: boolean;
+    min?: number;
+    max?: number;
+    type: string;
+    isActive: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt?: Date;
+    createdBy: string;
+    updatedBy?: string;
+    deletedBy?: string;
+}

package/dist/interfaces/questions/question.interface.js

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

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

@@ -0,0 +1,17 @@
+import { ApiResponse } from '../common';
+import { PaginationResponse } from '../common/api-pagination-response.interface';
+import { Question } from './question.interface';
+/**
+ * Questions list response interface.
+ *
+ * Represents the response structure for retrieving a paginated list of Questions.
+ * Extends from the generic ApiResponse and encapsulates a paginated list of Questions.
+ *
+ * @since 2.0.0
+ */
+export interface QuestionsListResponse extends ApiResponse {
+    /**
+     * Paginated data containing Questions.
+     */
+    data: PaginationResponse<Question> | Question[];
+}

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

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

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

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

package/dist/interfaces/restaurants/index.js

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

package/dist/interfaces/restaurants/restaurant-response.interface.d.ts

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

package/dist/interfaces/restaurants/restaurant-response.interface.js

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

package/dist/interfaces/restaurants/restaurant.interface.d.ts

@@ -0,0 +1,96 @@
+/**
+ * Restaurant interface.
+ *
+ * Represents a restaurant entity belonging to a chain.
+ * Restaurants are physical locations where orders are prepared and served.
+ * Each restaurant can have its own menus, inventory, and configuration.
+ *
+ * @since 2.0.0
+ */
+export interface Restaurant {
+    /**
+     * Unique identifier of the restaurant.
+     *
+     * @example "65e107cf-2f5d-47e9-862a-4e43ab864c99"
+     */
+    id: string;
+    /**
+     * Unique identifier of the chain this restaurant belongs to.
+     *
+     * @example "8b3be09d-fff7-4f8e-aa00-9788f6e7e484"
+     */
+    chainId: string;
+    /**
+     * Restaurant name.
+     *
+     * @example "Mar y Tierra"
+     * @example "McDonald's Downtown"
+     */
+    name: string;
+    /**
+     * Optional restaurant address.
+     *
+     * @example "La planicie"
+     * @example "123 Main St, Downtown"
+     */
+    address?: string;
+    /**
+     * Optional restaurant phone number.
+     *
+     * @example "903406229"
+     * @example "+1-555-0123"
+     */
+    phone?: string;
+    /**
+     * Optional restaurant timezone.
+     * Used for scheduling and availability calculations.
+     *
+     * @example "America/Lima"
+     * @example "America/New_York"
+     */
+    timezone?: string;
+    /**
+     * Restaurant status (active/inactive).
+     * Determines if the restaurant is operational.
+     *
+     * @example true
+     * @example false
+     */
+    status: boolean;
+    /**
+     * Date and time when the restaurant was created.
+     *
+     * @example "2025-11-07T16:17:27.237Z"
+     */
+    createdAt: Date;
+    /**
+     * Date and time when the restaurant was last updated.
+     *
+     * @example "2025-11-07T16:20:00.000Z"
+     */
+    updatedAt: Date;
+    /**
+     * Optional date and time when the restaurant was soft-deleted.
+     *
+     * @example "2025-11-20T10:30:00Z"
+     */
+    deletedAt?: Date;
+    /**
+     * Optional identifier of the user who created the restaurant.
+     *
+     * @example "68fc713cb9a5f6ee8fb7ae4e"
+     */
+    createdBy?: string;
+    /**
+     * Optional identifier of the user who last updated the restaurant.
+     *
+     * @example "68fc713cb9a5f6ee8fb7ae4f"
+     */
+    updatedBy?: string;
+    /**
+     * Optional identifier of the user who deleted the restaurant.
+     *
+     * @example "68fc713cb9a5f6ee8fb7ae4g"
+     */
+    deletedBy?: string;
+}

package/dist/interfaces/restaurants/restaurant.interface.js

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

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

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

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

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

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

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

package/dist/interfaces/tags/index.js

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

package/dist/interfaces/tags/tag-response.interface.d.ts

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

package/dist/interfaces/tags/tag-response.interface.js

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

package/dist/interfaces/tags/tag.interface.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Tag interface.
+ *
+ * Represents tags used for product categorization and searchability.
+ * Tags are reusable across multiple products (many-to-many relationship).
+ * Tags help customers find products by characteristics (e.g., vegetarian, spicy, gluten-free).
+ *
+ * @since 2.0.0
+ */
+export interface Tag {
+    /**
+     * Unique identifier of the tag.
+     *
+     * @example "aa0e8400-e29b-41d4-a716-446655440005"
+     */
+    id: string;
+    /**
+     * Tag name.
+     * Must be unique across all tags.
+     *
+     * @example "vegetarian"
+     * @example "spicy"
+     * @example "gluten-free"
+     * @example "beverage"
+     */
+    name: string;
+    /**
+     * Date and time when the tag was created.
+     *
+     * @example "2024-01-15T10:30:00Z"
+     */
+    createdAt: Date;
+    /**
+     * Date and time when the tag was last updated.
+     *
+     * @example "2024-01-15T11:00:00Z"
+     */
+    updatedAt: Date;
+    /**
+     * Optional date and time when the tag was soft-deleted.
+     *
+     * @example null
+     * @example "2024-01-20T10:30:00Z"
+     */
+    deletedAt: Date | null;
+    /**
+     * Optional identifier of the user who created the tag.
+     *
+     * @example "507f1f77bcf86cd799439011"
+     */
+    createdBy: string | null;
+    /**
+     * Optional identifier of the user who last updated the tag.
+     *
+     * @example "507f1f77bcf86cd799439012"
+     */
+    updatedBy: string | null;
+    /**
+     * Optional identifier of the user who deleted the tag.
+     *
+     * @example "507f1f77bcf86cd799439013"
+     */
+    deletedBy: string | null;
+}

package/dist/interfaces/tags/tag.interface.js

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

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

@@ -0,0 +1,17 @@
+import { ApiResponse } from '../common';
+import { PaginationResponse } from '../common/api-pagination-response.interface';
+import { Tag } from './tag.interface';
+/**
+ * Tags list response interface.
+ *
+ * Represents the response structure for retrieving a paginated list of tags.
+ * Extends from the generic ApiResponse and encapsulates a paginated list of tags.
+ *
+ * @since 2.0.0
+ */
+export interface TagsListResponse extends ApiResponse {
+    /**
+     * Paginated data containing tags.
+     */
+    data: PaginationResponse<Tag> | Tag[];
+}

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

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