qeai-sdk 2.0.0

package/dist/enums/translation-entity-type.enum.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Enumerates the supported entity types subject to translation within the QeHay platform.
+ *
+ * @enum TranslationEntityType
+ * @since 2.0.0
+ *
+ * @description
+ * This enum defines the different entity types that can have localized (translated) fields.
+ * It is used across the platform to identify which model or resource is being translated,
+ * ensuring consistent referencing in translation tables, API contracts, and UI elements.
+ * Extend this enum as new entities require localization.
+ *
+ * @remarks
+ * Synchronize this enum with database schemas and frontend localization management.
+ *
+ * @property CATEGORY   Represents a product or menu category requiring translation.
+ * @property PRODUCT    Represents a product entity (e.g., menu item) requiring translation.
+ * @property QUESTION   Represents an FAQ, feedback, or custom question requiring translation.
+ *
+ * @example
+ * ```
+ * import { TranslationEntityType } from './translation-entity-type.enum';
+ *
+ * function isProductTranslation(entityType: TranslationEntityType): boolean {
+ *   return entityType === TranslationEntityType.PRODUCT;
+ * }
+ * ```
+ */
+export declare enum TranslationEntityType {
+    /**
+     * Represents a category entity that can be translated.
+     */
+    CATEGORY = "categoryId",
+    /**
+     * Represents a product entity (e.g., a dish or item) that can be translated.
+     */
+    PRODUCT = "productId",
+    /**
+     * Represents a question entity subject to translation (e.g., FAQ or form question).
+     */
+    QUESTION = "questionId"
+}

package/dist/enums/translation-entity-type.enum.js

@@ -0,0 +1,43 @@
+/**
+ * Enumerates the supported entity types subject to translation within the QeHay platform.
+ *
+ * @enum TranslationEntityType
+ * @since 2.0.0
+ *
+ * @description
+ * This enum defines the different entity types that can have localized (translated) fields.
+ * It is used across the platform to identify which model or resource is being translated,
+ * ensuring consistent referencing in translation tables, API contracts, and UI elements.
+ * Extend this enum as new entities require localization.
+ *
+ * @remarks
+ * Synchronize this enum with database schemas and frontend localization management.
+ *
+ * @property CATEGORY   Represents a product or menu category requiring translation.
+ * @property PRODUCT    Represents a product entity (e.g., menu item) requiring translation.
+ * @property QUESTION   Represents an FAQ, feedback, or custom question requiring translation.
+ *
+ * @example
+ * ```
+ * import { TranslationEntityType } from './translation-entity-type.enum';
+ *
+ * function isProductTranslation(entityType: TranslationEntityType): boolean {
+ *   return entityType === TranslationEntityType.PRODUCT;
+ * }
+ * ```
+ */
+export var TranslationEntityType;
+(function (TranslationEntityType) {
+    /**
+     * Represents a category entity that can be translated.
+     */
+    TranslationEntityType["CATEGORY"] = "categoryId";
+    /**
+     * Represents a product entity (e.g., a dish or item) that can be translated.
+     */
+    TranslationEntityType["PRODUCT"] = "productId";
+    /**
+     * Represents a question entity subject to translation (e.g., FAQ or form question).
+     */
+    TranslationEntityType["QUESTION"] = "questionId";
+})(TranslationEntityType || (TranslationEntityType = {}));

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './enums';
+export * from './constants';
+export * from './dtos';
+export * from './interfaces';
+export * from './types';

package/dist/index.js

@@ -0,0 +1,5 @@
+export * from './enums';
+export * from './constants';
+export * from './dtos';
+export * from './interfaces';
+export * from './types';

package/dist/interfaces/auth/access-token.interface.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Access token interface.
+ *
+ * Represents the access token response structure
+ * returned after successful authentication.
+ *
+ * @since 2.0.0
+ */
+export interface AccessToken {
+    /**
+     * JWT access token string.
+     * Used for authenticating API requests.
+     *
+     * @example "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
+     */
+    accessToken: string;
+    /**
+     * Access token expiration time in seconds.
+     *
+     * @example 3600 (1 hour)
+     * @example 86400 (24 hours)
+     */
+    accessTokenExpiresIn: number;
+}

package/dist/interfaces/auth/access-token.interface.js

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

package/dist/interfaces/auth/access-user.interface.d.ts

@@ -0,0 +1,17 @@
+import { FullToken } from './full-token.interface';
+import { User } from './user.interface';
+/**
+ * Access user interface.
+ *
+ * Represents user information along with authentication tokens.
+ * Used when returning user data after successful authentication
+ * or token refresh.
+ *
+ * @since 2.0.0
+ */
+export interface AccessUser extends FullToken {
+    /**
+     * User information without sensitive data.
+     */
+    user: User;
+}

package/dist/interfaces/auth/access-user.interface.js

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

package/dist/interfaces/auth/account.interface.d.ts

@@ -0,0 +1,85 @@
+import { AuthProvider } from '../../enums/auth-provider.enum';
+/**
+ * Account interface.
+ *
+ * Represents user authentication credentials and provider information.
+ * Users can have multiple accounts (one per authentication provider).
+ * Used for managing user authentication across different providers.
+ *
+ * @since 2.0.0
+ */
+export interface Account {
+    /**
+     * Unique identifier of the account.
+     *
+     * @example "507f1f77bcf86cd799439011"
+     */
+    id: string;
+    /**
+     * Unique identifier of the user this account belongs to.
+     *
+     * @example "507f1f77bcf86cd799439010"
+     */
+    userId: string;
+    /**
+     * Email address associated with this account.
+     *
+     * @example "user@example.com"
+     */
+    email: string;
+    /**
+     * Optional password hash for local authentication.
+     * Null for OAuth providers (Google, Facebook, Apple).
+     *
+     * @example "hashed_password_string"
+     * @example null
+     */
+    passwordHash?: string;
+    /**
+     * Authentication provider for this account.
+     *
+     * @example AuthProvider.LOCAL
+     * @example AuthProvider.GOOGLE
+     * @example AuthProvider.FACEBOOK
+     */
+    provider: AuthProvider;
+    /**
+     * Optional provider-specific user identifier.
+     * Used for OAuth providers (e.g., Google's 'sub', Facebook's user ID).
+     * Null for local accounts.
+     *
+     * @example "google_user_sub_123456789"
+     * @example null
+     */
+    providerId?: string;
+    /**
+     * Optional OAuth access token.
+     * Used for OAuth providers to make authenticated requests.
+     * Null for local accounts.
+     *
+     * @example "ya29.a0AfH6SMB..."
+     * @example null
+     */
+    accessToken?: string;
+    /**
+     * Optional OAuth refresh token.
+     * Used for OAuth providers to obtain new access tokens.
+     * Null for local accounts.
+     *
+     * @example "1//0gXpJ..."
+     * @example null
+     */
+    refreshToken?: string;
+    /**
+     * Date and time when the account was created.
+     *
+     * @example "2024-01-15T10:30:00Z"
+     */
+    createdAt: Date;
+    /**
+     * Date and time when the account was last updated.
+     *
+     * @example "2024-01-15T11:00:00Z"
+     */
+    updatedAt: Date;
+}

package/dist/interfaces/auth/account.interface.js

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

package/dist/interfaces/auth/full-token.interface.d.ts

@@ -0,0 +1,12 @@
+import { AccessToken } from './access-token.interface';
+import { RefreshToken } from './refresh-token.interface';
+/**
+ * Full token interface.
+ *
+ * Represents the complete token response containing both
+ * access and refresh tokens after successful authentication.
+ *
+ * @since 2.0.0
+ */
+export interface FullToken extends AccessToken, RefreshToken {
+}

package/dist/interfaces/auth/full-token.interface.js

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

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

@@ -0,0 +1,17 @@
+/**
+ * Authentication interfaces.
+ *
+ * This module exports interfaces used for authentication and authorization
+ * in the Auth microservice and across the platform.
+ *
+ * @since 2.0.0
+ */
+export * from "./account.interface";
+export * from "./user.interface";
+export * from "./payload-jwt.interface";
+export * from "./access-token.interface";
+export * from "./refresh-token.interface";
+export * from "./full-token.interface";
+export * from "./access-user.interface";
+export * from "./validate-user.interface";
+export * from "./responses";

package/dist/interfaces/auth/index.js

@@ -0,0 +1,18 @@
+/**
+ * Authentication interfaces.
+ *
+ * This module exports interfaces used for authentication and authorization
+ * in the Auth microservice and across the platform.
+ *
+ * @since 2.0.0
+ */
+export * from "./account.interface";
+export * from "./user.interface";
+export * from "./payload-jwt.interface";
+export * from "./access-token.interface";
+export * from "./refresh-token.interface";
+export * from "./full-token.interface";
+export * from "./access-user.interface";
+export * from "./validate-user.interface";
+// Responses
+export * from "./responses";

package/dist/interfaces/auth/payload-jwt.interface.d.ts

@@ -0,0 +1,39 @@
+import { AuthProvider } from '../../enums/auth-provider.enum';
+import { Role } from '../../enums/role.enum';
+/**
+ * JWT payload interface.
+ *
+ * Represents the data structure encoded in JWT tokens
+ * used for authentication and authorization across microservices.
+ *
+ * @since 2.0.0
+ */
+export interface PayloadJwt {
+    /**
+     * Subject identifier (typically the user ID).
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    sub: string;
+    /**
+     * User's email address.
+     *
+     * @example "user@example.com"
+     */
+    email: string;
+    /**
+     * Array of user roles for authorization.
+     *
+     * @example [Role.CONSUMER, Role.ADMIN]
+     * @example [Role.WAITER]
+     */
+    roles: Role[];
+    /**
+     * Authentication provider used by the user.
+     *
+     * @example AuthProvider.LOCAL
+     * @example AuthProvider.GOOGLE
+     * @example AuthProvider.FACEBOOK
+     */
+    provider: AuthProvider;
+}

package/dist/interfaces/auth/payload-jwt.interface.js

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

package/dist/interfaces/auth/refresh-token.interface.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Refresh token interface.
+ *
+ * Represents the refresh token response structure
+ * used to obtain new access tokens.
+ *
+ * @since 2.0.0
+ */
+export interface RefreshToken {
+    /**
+     * JWT refresh token string.
+     * Used to obtain new access tokens when they expire.
+     *
+     * @example "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
+     */
+    refreshToken: string;
+    /**
+     * Refresh token expiration time in seconds.
+     * Typically longer than access token expiration.
+     *
+     * @example 604800 (7 days)
+     * @example 2592000 (30 days)
+     */
+    refreshTokenExpiresIn: number;
+}

package/dist/interfaces/auth/refresh-token.interface.js

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

package/dist/interfaces/auth/responses/auth-response.interface.d.ts

@@ -0,0 +1,37 @@
+import { ApiResponse } from "../../common";
+import { FullToken } from "../full-token.interface";
+import { User } from "../user.interface";
+/**
+ * AuthResponse interface returned upon successful authentication.
+ *
+ * Extends ApiResponse to provide standard API response fields, and
+ * includes the login-specific data containing tokens and the authenticated user.
+ *
+ * @extends ApiResponse
+ * @since 2.0.0
+ */
+export interface AuthResponse extends ApiResponse {
+    /**
+     * Data object containing authentication tokens and user information.
+     *
+     * @type {AuthResponseData}
+     */
+    data: AuthResponseData;
+}
+/**
+ * AuthResponseData interface containing user's authentication tokens and profile data.
+ *
+ * Extends FullToken to include access and refresh tokens, and
+ * includes the authenticated user's public profile.
+ *
+ * @extends FullToken
+ * @since 2.0.0
+ */
+export interface AuthResponseData extends FullToken {
+    /**
+     * Authenticated user information.
+     *
+     * @type {User}
+     */
+    user: User;
+}

package/dist/interfaces/auth/responses/auth-response.interface.js

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

package/dist/interfaces/auth/responses/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./auth-response.interface";
+export * from "./refresh-token-response.interface";

package/dist/interfaces/auth/responses/index.js

@@ -0,0 +1,2 @@
+export * from "./auth-response.interface";
+export * from "./refresh-token-response.interface";

package/dist/interfaces/auth/responses/refresh-token-response.interface.d.ts

@@ -0,0 +1,29 @@
+import { ApiResponse } from "../../common";
+import { AccessToken } from "../access-token.interface";
+/**
+ * Interface for the response returned when a refresh token is exchanged for a new access token.
+ *
+ * Extends ApiResponse to provide standardized API metadata,
+ * and returns the new access token in the data property.
+ *
+ * @extends ApiResponse
+ * @since 2.0.0
+ */
+export interface RefreshTokenResponse extends ApiResponse {
+    /**
+     * Contains the new access token issued after refreshing.
+     *
+     * @type {RefreshTokenResponseData}
+     */
+    data: RefreshTokenResponseData;
+}
+/**
+ * Payload object containing the newly issued access token.
+ *
+ * Extends AccessToken, which includes the JWT and its expiration time.
+ *
+ * @extends AccessToken
+ * @since 2.0.0
+ */
+export interface RefreshTokenResponseData extends AccessToken {
+}

package/dist/interfaces/auth/responses/refresh-token-response.interface.js

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

package/dist/interfaces/auth/user.interface.d.ts

@@ -0,0 +1,53 @@
+import { AuthProvider } from '../../enums/auth-provider.enum';
+import { Role } from '../../enums/role.enum';
+/**
+ * User interface representing user information.
+ *
+ * Used across authentication and authorization modules
+ * to represent user data without sensitive information.
+ *
+ * @since 2.0.0
+ */
+export interface User {
+    /**
+     * Unique identifier of the user.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    id: string;
+    /**
+     * User's email address.
+     *
+     * @example "user@example.com"
+     */
+    email: string;
+    /**
+     * User's full name.
+     *
+     * @example "John Doe"
+     */
+    name: string;
+    /**
+     * Optional URL to user's avatar image.
+     *
+     * @example "https://example.com/avatars/user123.jpg"
+     */
+    avatarUrl?: string;
+    /**
+     * Array of user roles for authorization.
+     * Users can have multiple roles simultaneously.
+     *
+     * @example [Role.CONSUMER]
+     * @example [Role.WAITER, Role.ADMIN]
+     */
+    roles: Role[];
+    /**
+     * Authentication provider used by the user.
+     *
+     * @example AuthProvider.LOCAL
+     * @example AuthProvider.GOOGLE
+     * @example AuthProvider.FACEBOOK
+     * @example AuthProvider.APPLE
+     */
+    provider: AuthProvider;
+}

package/dist/interfaces/auth/user.interface.js

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

package/dist/interfaces/auth/validate-user.interface.d.ts

@@ -0,0 +1,36 @@
+import { Account } from './account.interface';
+import { User } from './user.interface';
+/**
+ * Validate user interface.
+ *
+ * Represents user information including associated accounts.
+ * Used during user validation processes in authentication flows.
+ * Extends the User interface to include authentication credentials.
+ *
+ * @since 2.0.0
+ */
+export interface ValidateUser extends User {
+    /**
+     * Array of user accounts (authentication credentials).
+     * Users can have multiple accounts (one per authentication provider).
+     * Includes password hashes and provider information.
+     */
+    Accounts: Account[];
+}
+/**
+ * Validate user interface without password information.
+ *
+ * Represents user information with accounts but excludes
+ * sensitive password hash data for safe data transfer.
+ * Used when returning user data that should not expose passwords.
+ *
+ * @since 2.0.0
+ */
+export interface ValidateUserWithoutPassword extends User {
+    /**
+     * Array of user accounts without password hashes.
+     * Safe for client-side use or logging.
+     * All other account information is preserved.
+     */
+    Accounts: Omit<Account, 'passwordHash'>[];
+}

package/dist/interfaces/auth/validate-user.interface.js

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

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

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

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

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

package/dist/interfaces/categories/category-response.interface.d.ts

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

package/dist/interfaces/categories/category-response.interface.js

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

package/dist/interfaces/categories/category.interface.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Category interface.
+ *
+ * Represents a product category used for organizing products in menus.
+ * Categories help customers navigate menus and group related products.
+ * Categories can have translations for multi-language support.
+ *
+ * @since 2.0.0
+ */
+export interface Category {
+    /**
+     * Unique identifier of the category.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
+    id: string;
+    /**
+     * Category name.
+     *
+     * @example "Beverages"
+     * @example "Main Courses"
+     * @example "Desserts"
+     */
+    name: string;
+    /**
+     * Optional category description.
+     *
+     * @example "All types of drinks and beverages"
+     * @example "Delicious main dishes and entrees"
+     */
+    description?: string;
+    /**
+     * Category status (active/inactive).
+     * Determines if the category is visible in menus.
+     *
+     * @example true
+     * @example false
+     */
+    status: boolean;
+    /**
+     * Date and time when the category was created.
+     *
+     * @example "2024-01-15T10:30:00Z"
+     */
+    createdAt: Date;
+    /**
+     * Date and time when the category was last updated.
+     *
+     * @example "2024-01-15T11:00:00Z"
+     */
+    updatedAt: Date;
+    /**
+     * Optional date and time when the category was soft-deleted.
+     *
+     * @example "2024-01-20T10:30:00Z"
+     */
+    deletedAt?: Date;
+    /**
+     * Optional identifier of the user who created the category.
+     *
+     * @example "507f1f77bcf86cd799439011"
+     */
+    createdBy?: string;
+    /**
+     * Optional identifier of the user who last updated the category.
+     *
+     * @example "507f1f77bcf86cd799439012"
+     */
+    updatedBy?: string;
+    /**
+     * Optional identifier of the user who deleted the category.
+     *
+     * @example "507f1f77bcf86cd799439013"
+     */
+    deletedBy?: string;
+}

package/dist/interfaces/categories/category.interface.js

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