qeai-sdk 2.0.1 → 2.0.2

package/dist/dtos/payments/create-payment-audit-dynamo.dto.js

@@ -0,0 +1,81 @@
+export class CreatePaymentAuditDynamoDto {
+    /**
+     * Unique identifier for the audited transaction.
+     * Should be globally unique per transaction.
+     *
+     * @example "txn_123abc456"
+     */
+    transactionId;
+    /**
+     * ISO 8601 timestamp indicating when the payment event occurred.
+     *
+     * @example "2024-06-01T12:00:00.000Z"
+     */
+    timestamp;
+    /**
+     * Unique identifier of the related order.
+     *
+     * @example "order_789xyz"
+     */
+    orderId;
+    /**
+     * Name of the payment provider (e.g., "stripe", "culqi").
+     *
+     * @example "stripe"
+     */
+    provider;
+    /**
+     * Name or path of the API endpoint called (e.g., "/charges").
+     *
+     * @example "/charges"
+     */
+    endpoint;
+    /**
+     * HTTP method used for the audited request.
+     *
+     * @example "POST"
+     */
+    method;
+    /**
+     * HTTP response status code from the provider (e.g., 200, 500).
+     *
+     * @example 200
+     */
+    statusCode;
+    /**
+     * Status of the operation/audit (e.g., "success", "error").
+     *
+     * @example "success"
+     */
+    status;
+    /**
+     * Processing time for the audited action, in milliseconds.
+     *
+     * @example 845
+     */
+    durationMs;
+    /**
+     * (Optional) IP address from which the request originated.
+     *
+     * @example "192.168.0.1"
+     */
+    ipAddress;
+    /**
+     * URL of the external log or audit file, if available (e.g., S3 presigned url).
+     *
+     * @example "https://s3.amazonaws.com/bucket/audit/txn_123.json"
+     */
+    logUrl;
+    /**
+     * ISO 8601 timestamp indicating when the audit record was created.
+     *
+     * @example "2024-06-01T12:01:00.000Z"
+     */
+    createdAt;
+    /**
+     * ISO 8601 timestamp indicating the last update to the audit record.
+     *
+     * @example "2024-06-01T12:05:30.000Z"
+     */
+    updatedAt;
+}

package/dist/dtos/payments/create-payment-audit-s3.dto.d.ts

@@ -0,0 +1,81 @@
+/**
+ * DTO for storing payment audit records in S3.
+ *
+ * Encapsulates all relevant information of a payment transaction
+ * to be stored in S3 for logging, compliance, and traceability.
+ *
+ * Follows Clean Code, SOLID, and best practices for maintainability and extensibility.
+ *
+ * @since 2.0.0
+ */
+export declare class CreatePaymentAudiS3tDto {
+    /**
+     * Unique identifier for the audited transaction.
+     * Should be globally unique per transaction.
+     *
+     * @example "txn_123abc456"
+     */
+    transactionId: string;
+    /**
+     * Unique identifier of the associated order.
+     *
+     * @example "order_789xyz"
+     */
+    orderId: string;
+    /**
+     * Name of the payment provider (e.g., "stripe", "culqi").
+     *
+     * @example "stripe"
+     */
+    provider: string;
+    /**
+     * API endpoint called during the payment operation (e.g., "/charges").
+     *
+     * @example "/charges"
+     */
+    endpoint: string;
+    /**
+     * HTTP method used (e.g., "POST", "GET").
+     *
+     * @example "POST"
+     */
+    method: string;
+    /**
+     * HTTP response status code from the provider (e.g., 200, 500).
+     *
+     * @example 200
+     */
+    statusCode: number;
+    /**
+     * Status of the audited operation (e.g., "success", "error").
+     *
+     * @example "success"
+     */
+    status: string;
+    /**
+     * Total execution time of the audited operation, in milliseconds.
+     *
+     * @example 523
+     */
+    durationMs: number;
+    /**
+     * (Optional) IP address from which the request originated.
+     *
+     * @example "192.168.1.10"
+     */
+    ipAddress?: string;
+    /**
+     * Payload sent in the audited request.
+     * Must be a serializable object.
+     *
+     * @example { amount: 19.99, currency: "PEN" }
+     */
+    requestBody: Record<string, any>;
+    /**
+     * Payload received in the audited response.
+     * Must be a serializable object.
+     *
+     * @example { providerResponse: ..., result: ... }
+     */
+    responseBody: Record<string, any>;
+}

package/dist/dtos/payments/create-payment-audit-s3.dto.js

@@ -0,0 +1,81 @@
+/**
+ * DTO for storing payment audit records in S3.
+ *
+ * Encapsulates all relevant information of a payment transaction
+ * to be stored in S3 for logging, compliance, and traceability.
+ *
+ * Follows Clean Code, SOLID, and best practices for maintainability and extensibility.
+ *
+ * @since 2.0.0
+ */
+export class CreatePaymentAudiS3tDto {
+    /**
+     * Unique identifier for the audited transaction.
+     * Should be globally unique per transaction.
+     *
+     * @example "txn_123abc456"
+     */
+    transactionId;
+    /**
+     * Unique identifier of the associated order.
+     *
+     * @example "order_789xyz"
+     */
+    orderId;
+    /**
+     * Name of the payment provider (e.g., "stripe", "culqi").
+     *
+     * @example "stripe"
+     */
+    provider;
+    /**
+     * API endpoint called during the payment operation (e.g., "/charges").
+     *
+     * @example "/charges"
+     */
+    endpoint;
+    /**
+     * HTTP method used (e.g., "POST", "GET").
+     *
+     * @example "POST"
+     */
+    method;
+    /**
+     * HTTP response status code from the provider (e.g., 200, 500).
+     *
+     * @example 200
+     */
+    statusCode;
+    /**
+     * Status of the audited operation (e.g., "success", "error").
+     *
+     * @example "success"
+     */
+    status;
+    /**
+     * Total execution time of the audited operation, in milliseconds.
+     *
+     * @example 523
+     */
+    durationMs;
+    /**
+     * (Optional) IP address from which the request originated.
+     *
+     * @example "192.168.1.10"
+     */
+    ipAddress;
+    /**
+     * Payload sent in the audited request.
+     * Must be a serializable object.
+     *
+     * @example { amount: 19.99, currency: "PEN" }
+     */
+    requestBody;
+    /**
+     * Payload received in the audited response.
+     * Must be a serializable object.
+     *
+     * @example { providerResponse: ..., result: ... }
+     */
+    responseBody;
+}

package/dist/dtos/payments/index.d.ts

@@ -9,3 +9,5 @@
 export * from './payment-session.dto.js';
 export * from './payment-session-item.dto.js';
 export * from './webhook-data.dto.js';
+export * from './create-payment-audit-dynamo.dto.js';
+export * from './create-payment-audit-s3.dto.js';

package/dist/dtos/payments/index.js

@@ -9,3 +9,5 @@
 export * from './payment-session.dto.js';
 export * from './payment-session-item.dto.js';
 export * from './webhook-data.dto.js';
+export * from './create-payment-audit-dynamo.dto.js';
+export * from './create-payment-audit-s3.dto.js';

package/dist/dtos/payments/payment-session-item.dto.d.ts

@@ -20,14 +20,14 @@ export declare class PaymentSessionItemDto {
      *
      * @example "Large"
      */
-    sizeName?: string;
+    sizeName?: string | null;
     /**
      * Optional price for the size variant.
      * Must be a positive number if provided.
      *
      * @example 12.99
      */
-    sizePrice?: number;
+    sizePrice?: number | null;
     /**
      * Name of the product/item.
      *
@@ -53,13 +53,13 @@ export declare class PaymentSessionItemDto {
      *
      * @example "No onions, extra cheese"
      */
-    notes?: string;
+    notes?: string | null;
     /**
      * Optional status of this item.
      *
      * @example "pending"
      */
-    itemStatus?: string;
+    itemStatus?: string | null;
     /**
      * Optional array of child items (for nested structures like combo meals).
      * Each child item is validated as a PaymentSessionItemDto.

package/dist/dtos/payments/payment-session-item.dto.js

@@ -80,6 +80,7 @@ export class PaymentSessionItemDto {
     childItems;
 }
 __decorate([
+    IsNotEmpty(),
     IsString(),
     IsUUID(),
     __metadata("design:type", String)
@@ -87,13 +88,13 @@ __decorate([
 __decorate([
     IsOptional(),
     IsString(),
-    __metadata("design:type", String)
+    __metadata("design:type", Object)
 ], PaymentSessionItemDto.prototype, "sizeName", void 0);
 __decorate([
     IsOptional(),
     IsNumber(),
     IsPositive(),
-    __metadata("design:type", Number)
+    __metadata("design:type", Object)
 ], PaymentSessionItemDto.prototype, "sizePrice", void 0);
 __decorate([
     IsString(),
@@ -103,22 +104,24 @@ __decorate([
 __decorate([
     IsNumber(),
     IsPositive(),
+    IsNotEmpty(),
     __metadata("design:type", Number)
 ], PaymentSessionItemDto.prototype, "quantity", void 0);
 __decorate([
     IsNumber(),
     IsPositive(),
+    IsNotEmpty(),
     __metadata("design:type", Number)
 ], PaymentSessionItemDto.prototype, "price", void 0);
 __decorate([
     IsOptional(),
     IsString(),
-    __metadata("design:type", String)
+    __metadata("design:type", Object)
 ], PaymentSessionItemDto.prototype, "notes", void 0);
 __decorate([
     IsOptional(),
     IsString(),
-    __metadata("design:type", String)
+    __metadata("design:type", Object)
 ], PaymentSessionItemDto.prototype, "itemStatus", void 0);
 __decorate([
     IsOptional(),

package/dist/dtos/payments/webhook-data.dto.d.ts

@@ -35,5 +35,5 @@ export declare class WebhookDataDto {
      *
      * @example { "x-stripe-signature": "t=1234567890,v1=abc123..." }
      */
-    headers?: Record<string, string>;
+    headers?: Record<string, string | string[] | undefined>;
 }

package/dist/dtos/payments/webhook-data.dto.js

@@ -49,6 +49,7 @@ export class WebhookDataDto {
 }
 __decorate([
     IsString(),
+    IsNotEmpty(),
     __metadata("design:type", String)
 ], WebhookDataDto.prototype, "rawBody", void 0);
 __decorate([

package/dist/dtos/products/create-product.dto.d.ts

@@ -50,5 +50,5 @@ export declare class CreateProductDto {
      *
      * @example "507f1f77bcf86cd799439011"
      */
-    createdBy?: string;
+    createdBy: string;
 }

package/dist/dtos/products/create-product.dto.js

@@ -79,6 +79,7 @@ __decorate([
     __metadata("design:type", String)
 ], CreateProductDto.prototype, "description", void 0);
 __decorate([
+    IsNotEmpty(),
     IsNumber({
         maxDecimalPlaces: 4,
     }, { message: 'Base price must be a number with maximum 4 decimal places' }),
@@ -94,6 +95,6 @@ __decorate([
 __decorate([
     IsString(),
     IsMongoId(),
-    IsOptional(),
+    IsNotEmpty(),
     __metadata("design:type", String)
 ], CreateProductDto.prototype, "createdBy", void 0);

package/dist/dtos/products/delete-product.dto.d.ts

@@ -13,7 +13,7 @@ export declare class DeleteProductDto {
      *
      * @example "550e8400-e29b-41d4-a716-446655440000"
      */
-    id: string;
+    productId: string;
     /**
      * User who deleted the product.
      * Must be a valid MongoDB ObjectId.

package/dist/dtos/products/delete-product.dto.js

@@ -7,7 +7,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
-import { IsMongoId, IsString, IsUUID } from 'class-validator';
+import { IsMongoId, IsNotEmpty, IsString, IsUUID } from 'class-validator';
 /**
  * DTO for deleting a product.
  *
@@ -23,7 +23,7 @@ export class DeleteProductDto {
      *
      * @example "550e8400-e29b-41d4-a716-446655440000"
      */
-    id;
+    productId;
     /**
      * User who deleted the product.
      * Must be a valid MongoDB ObjectId.
@@ -35,10 +35,12 @@ export class DeleteProductDto {
 __decorate([
     IsString(),
     IsUUID(),
+    IsNotEmpty(),
     __metadata("design:type", String)
-], DeleteProductDto.prototype, "id", void 0);
+], DeleteProductDto.prototype, "productId", void 0);
 __decorate([
     IsString(),
     IsMongoId(),
+    IsNotEmpty(),
     __metadata("design:type", String)
 ], DeleteProductDto.prototype, "deletedBy", void 0);

package/dist/dtos/products/submodules/product-image/bulk-create-product-image.dto.d.ts

@@ -1,4 +1,4 @@
-import { CreateProductImageDto } from './create-product-image.dto.js';
+import { CreateProductImageDto } from "./create-product-image.dto.js";
 /**
  * DTO for bulk creating product images.
  *
@@ -14,7 +14,7 @@ export declare class BulkCreateProductImageDto {
      *
      * @example "550e8400-e29b-41d4-a716-446655440000"
      */
-    productId?: string;
+    productId: string;
     /**
      * Array of images to create.
      * Must contain at least one image.
@@ -22,5 +22,5 @@ export declare class BulkCreateProductImageDto {
      *
      * @example [{ url: "https://example.com/image1.jpg", isPrimary: true }]
      */
-    images: CreateProductImageDto[];
+    images: Omit<CreateProductImageDto, "productId">[];
 }

package/dist/dtos/products/submodules/product-image/bulk-create-product-image.dto.js

@@ -7,9 +7,9 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
-import { IsString, IsArray, ValidateNested, ArrayMinSize, IsOptional, IsUUID, } from 'class-validator';
-import { Type } from 'class-transformer';
-import { CreateProductImageDto } from './create-product-image.dto.js';
+import { IsString, IsNotEmpty, IsArray, ValidateNested, ArrayMinSize, IsUUID, } from "class-validator";
+import { Type } from "class-transformer";
+import { CreateProductImageDto } from "./create-product-image.dto.js";
 /**
  * DTO for bulk creating product images.
  *
@@ -37,13 +37,13 @@ export class BulkCreateProductImageDto {
 }
 __decorate([
     IsString(),
-    IsOptional(),
+    IsNotEmpty(),
     IsUUID(),
     __metadata("design:type", String)
 ], BulkCreateProductImageDto.prototype, "productId", void 0);
 __decorate([
     IsArray(),
-    ArrayMinSize(1, { message: 'At least one image is required' }),
+    ArrayMinSize(1, { message: "At least one image is required" }),
     ValidateNested({ each: true }),
     Type(() => CreateProductImageDto),
     __metadata("design:type", Array)

package/dist/dtos/products/submodules/product-image/create-product-image.dto.d.ts

@@ -13,7 +13,7 @@ export declare class CreateProductImageDto {
      *
      * @example "550e8400-e29b-41d4-a716-446655440000"
      */
-    productId?: string;
+    productId: string;
     /**
      * Image URL.
      * Must be a valid URL format and not be empty.

package/dist/dtos/products/submodules/product-image/create-product-image.dto.js

@@ -7,7 +7,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
-import { IsString, IsNotEmpty, IsOptional, IsBoolean, IsUrl, IsUUID } from 'class-validator';
+import { IsString, IsNotEmpty, IsOptional, IsBoolean, IsUrl, IsUUID, } from "class-validator";
 /**
  * DTO for creating a new product image.
  *
@@ -42,14 +42,14 @@ export class CreateProductImageDto {
 }
 __decorate([
     IsString(),
-    IsOptional(),
+    IsNotEmpty(),
     IsUUID(),
     __metadata("design:type", String)
 ], CreateProductImageDto.prototype, "productId", void 0);
 __decorate([
     IsString(),
-    IsNotEmpty({ message: 'Image URL is required' }),
-    IsUrl({}, { message: 'Image URL must be a valid URL' }),
+    IsNotEmpty({ message: "Image URL is required" }),
+    IsUrl({}, { message: "Image URL must be a valid URL" }),
     __metadata("design:type", String)
 ], CreateProductImageDto.prototype, "url", void 0);
 __decorate([

package/dist/dtos/products/submodules/product-image/update-product-image.dto.d.ts

@@ -13,7 +13,7 @@ export declare class UpdateProductImageDto {
      *
      * @example "770e8400-e29b-41d4-a716-446655440003"
      */
-    id?: string;
+    productImageId: string;
     /**
      * Optional image URL.
      * Must be a valid URL format if provided.

package/dist/dtos/products/submodules/product-image/update-product-image.dto.js

@@ -7,7 +7,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
-import { IsString, IsOptional, IsBoolean, IsUrl, IsUUID } from 'class-validator';
+import { IsString, IsOptional, IsBoolean, IsUrl, IsUUID, IsNotEmpty } from 'class-validator';
 /**
  * DTO for updating an existing product image.
  *
@@ -23,7 +23,7 @@ export class UpdateProductImageDto {
      *
      * @example "770e8400-e29b-41d4-a716-446655440003"
      */
-    id;
+    productImageId;
     /**
      * Optional image URL.
      * Must be a valid URL format if provided.
@@ -39,11 +39,11 @@ export class UpdateProductImageDto {
     isPrimary;
 }
 __decorate([
+    IsNotEmpty(),
     IsString(),
-    IsOptional(),
     IsUUID(),
     __metadata("design:type", String)
-], UpdateProductImageDto.prototype, "id", void 0);
+], UpdateProductImageDto.prototype, "productImageId", void 0);
 __decorate([
     IsOptional(),
     IsString(),

package/dist/dtos/products/submodules/product-question/create-product-question.dto.d.ts

@@ -1,4 +1,4 @@
-import { QuestionProductType } from '../../../../enums/question-product-type.enum.js';
+import { QuestionProductType } from "../../../../enums/question-product-type.enum.js";
 /**
  * DTO for creating a new product-question relationship.
  *
@@ -14,7 +14,7 @@ export declare class CreateProductQuestionDto {
      *
      * @example "550e8400-e29b-41d4-a716-446655440000"
      */
-    productId?: string;
+    productId: string;
     /**
      * Unique identifier of the question.
      * Must be a valid UUID and not be empty.

package/dist/dtos/products/submodules/product-question/create-product-question.dto.js

@@ -7,9 +7,9 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
-import { IsString, IsNotEmpty, IsOptional, IsInt, IsEnum, Min, IsUUID } from 'class-validator';
-import { Type } from 'class-transformer';
-import { QuestionProductType } from '../../../../enums/question-product-type.enum.js';
+import { IsString, IsNotEmpty, IsOptional, IsInt, IsEnum, Min, IsUUID, } from "class-validator";
+import { Type } from "class-transformer";
+import { QuestionProductType } from "../../../../enums/question-product-type.enum.js";
 /**
  * DTO for creating a new product-question relationship.
  *
@@ -52,25 +52,25 @@ export class CreateProductQuestionDto {
 __decorate([
     IsUUID(),
     IsString(),
-    IsOptional(),
+    IsNotEmpty(),
     __metadata("design:type", String)
 ], CreateProductQuestionDto.prototype, "productId", void 0);
 __decorate([
     IsUUID(),
     IsString(),
-    IsNotEmpty({ message: 'Question ID is required' }),
+    IsNotEmpty({ message: "Question ID is required" }),
     __metadata("design:type", String)
 ], CreateProductQuestionDto.prototype, "questionId", void 0);
 __decorate([
     IsOptional(),
-    IsInt({ message: 'Position must be an integer' }),
-    Min(0, { message: 'Position must be at least 0' }),
+    IsInt({ message: "Position must be an integer" }),
+    Min(0, { message: "Position must be at least 0" }),
     Type(() => Number),
     __metadata("design:type", Number)
 ], CreateProductQuestionDto.prototype, "position", void 0);
 __decorate([
     IsEnum(QuestionProductType, {
-        message: 'Item type must be either QUESTION or ANSWER',
+        message: "Item type must be either QUESTION or ANSWER",
     }),
     __metadata("design:type", String)
 ], CreateProductQuestionDto.prototype, "itemType", void 0);

package/dist/dtos/products/submodules/product-question/replace-by-product-id.dto.d.ts

@@ -23,5 +23,5 @@ export declare class ReplaceProductQuestionsByProductIdDto {
      *
      * @example [{ questionId: "...", position: 1, itemType: QuestionProductType.QUESTION }]
      */
-    questions: CreateProductQuestionDto[];
+    questions: Omit<CreateProductQuestionDto, 'productId'>[];
 }

package/dist/dtos/products/submodules/product-question/update-product-question.dto.d.ts

@@ -14,7 +14,7 @@ export declare class UpdateProductQuestionDto {
      *
      * @example "aa0e8400-e29b-41d4-a716-446655440006"
      */
-    id?: string;
+    productQuestionId: string;
     /**
      * Optional position/order of the question.
      * Used to control the display order. Must be a non-negative integer if provided.

package/dist/dtos/products/submodules/product-question/update-product-question.dto.js

@@ -7,7 +7,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
-import { IsString, IsOptional, IsInt, IsEnum, Min, IsUUID } from 'class-validator';
+import { IsString, IsOptional, IsInt, IsEnum, Min, IsUUID, IsNotEmpty } from 'class-validator';
 import { Type } from 'class-transformer';
 import { QuestionProductType } from '../../../../enums/question-product-type.enum.js';
 /**
@@ -25,7 +25,7 @@ export class UpdateProductQuestionDto {
      *
      * @example "aa0e8400-e29b-41d4-a716-446655440006"
      */
-    id;
+    productQuestionId;
     /**
      * Optional position/order of the question.
      * Used to control the display order. Must be a non-negative integer if provided.
@@ -43,10 +43,10 @@ export class UpdateProductQuestionDto {
 }
 __decorate([
     IsString(),
-    IsOptional(),
+    IsNotEmpty(),
     IsUUID(),
     __metadata("design:type", String)
-], UpdateProductQuestionDto.prototype, "id", void 0);
+], UpdateProductQuestionDto.prototype, "productQuestionId", void 0);
 __decorate([
     IsOptional(),
     IsInt({ message: 'Position must be an integer' }),