qeai-sdk 2.0.0

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

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

package/dist/interfaces/translations/index.js

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

package/dist/interfaces/translations/translation-response.interface.d.ts

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

package/dist/interfaces/translations/translation-response.interface.js

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

package/dist/interfaces/translations/translation.interface.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Translation interface.
+ *
+ * Represents translations for products, categories, and questions.
+ * Supports multi-language content by providing localized names and descriptions.
+ * Uses polymorphic relationships to support different entity types.
+ *
+ * @since 2.0.0
+ */
+export interface Translation {
+    /**
+     * Unique identifier of the translation.
+     *
+     * @example "770e8400-e29b-41d4-a716-446655440002"
+     */
+    id: string;
+    /**
+     * Language code (ISO 639-1 or similar).
+     * Used to identify the target language for the translation.
+     *
+     * @example "en"
+     * @example "es"
+     * @example "fr"
+     */
+    languageCode: string;
+    /**
+     * Translated name.
+     * The localized name for the entity (product, category, or question).
+     *
+     * @example "Gran Mac" (Spanish translation of "Big Mac")
+     * @example "Bebidas" (Spanish translation of "Beverages")
+     */
+    name: string;
+    /**
+     * Optional translated description.
+     * The localized description for the entity.
+     *
+     * @example "Dos hamburguesas de carne, salsa especial, lechuga, queso, pepinillos, cebollas en pan de sésamo"
+     */
+    description?: string;
+    /**
+     * Optional unique identifier of the category this translation belongs to.
+     * Null if this translation is for a product or question.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     * @example null
+     */
+    categoryId?: string;
+    /**
+     * Optional unique identifier of the product this translation belongs to.
+     * Null if this translation is for a category or question.
+     *
+     * @example "660e8400-e29b-41d4-a716-446655440001"
+     * @example null
+     */
+    productId?: string;
+    /**
+     * Optional unique identifier of the question this translation belongs to.
+     * Null if this translation is for a category or product.
+     *
+     * @example "770e8400-e29b-41d4-a716-446655440002"
+     * @example null
+     */
+    questionId?: string;
+    /**
+     * Date and time when the translation was created.
+     *
+     * @example "2024-01-15T10:30:00Z"
+     */
+    createdAt: Date;
+    /**
+     * Date and time when the translation was last updated.
+     *
+     * @example "2024-01-15T11:00:00Z"
+     */
+    updatedAt: Date;
+}

package/dist/interfaces/translations/translation.interface.js

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

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

@@ -0,0 +1,16 @@
+import { ApiResponse } from '../common';
+import { Translation } from './translation.interface';
+/**
+ * Translations list response interface.
+ *
+ * Represents the response structure for retrieving a paginated list of translations.
+ * Extends from the generic ApiResponse and encapsulates a paginated list of translations.
+ *
+ * @since 2.0.0
+ */
+export interface TranslationsListResponse extends ApiResponse {
+    /**
+     * Paginated data containing translations.
+     */
+    data: Translation[];
+}

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

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

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from './order-mode.type';

package/dist/types/index.js

@@ -0,0 +1 @@
+export * from './order-mode.type';

package/dist/types/order-mode.type.d.ts

@@ -0,0 +1,14 @@
+/**
+ * OrderMode type.
+ *
+ * Represents the available modes for creating an order in the QeHay ecosystem.
+ *
+ * - DINE_IN: The order is placed within the restaurant. The order is created in a "CREATED" state,
+ *            and a QR code is generated for the waiter to scan and confirm the order.
+ * - DELIVERY: The order is placed for home delivery. The order is created in a "CREATED" state,
+ *             payment is processed, and the order transitions to "CONFIRMED".
+ * - PICKUP: The order is placed for pickup at the restaurant. Follows the DELIVERY flow regarding state and payment.
+ *
+ * @since 2.0.0
+ */
+export type OrderMode = 'DINE_IN' | 'DELIVERY' | 'PICKUP';

package/dist/types/order-mode.type.js

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

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "qeai-sdk",
+  "version": "2.0.0",
+  "description": "In this version we have added the interfaces for the qhay sdk",
+  "main": "dist/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "check-types": "tsc",
+    "package": "rm -rf dist/ && tsc"
+  },
+  "dependencies": {
+    "@nestjs/mapped-types": "^2.1.0",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.2",
+    "reflect-metadata": "^0.2.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/looroh/LOOROH_SDK.git"
+  },
+  "author": "looroh",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/looroh/LOOROH_SDK/issues"
+  },
+  "homepage": "https://github.com/looroh/LOOROH_SDK#readme"
+}

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "preserveConstEnums": true,
+    "allowJs": false,
+    "sourceMap": false,
+    "module": "ESNext",
+    "strict": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "strictPropertyInitialization": false,
+    // "rootDir": "./src",
+    "outDir": "./dist",
+    "declaration": true,
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true
+    // "noEmit": true,
+  },
+  "exclude": ["node_modules", "**/*.test.ts", ".eslintrc.cjs"],
+  "references": [{ "path": "./tsconfig.node.json" }]
+}

package/tsconfig.node.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "module": "ESNext",
+    "moduleResolution": "Node",
+    "allowSyntheticDefaultImports": true
+  },
+  "include": []
+}