@hosterai/types 0.0.13 → 0.0.15

package/README.md

@@ -1,5 +1,11 @@
 # @hosterai/types
 
+This package contains the core types for the Hoster AI platform.
+
+## Files
+
+- `llm.txt`: Contains a list of large language models.
+
 [![NPM Version](https://img.shields.io/npm/v/@hosterai/types.svg)](https://www.npmjs.com/package/@hosterai/types)
 [![NPM Downloads](https://img.shields.io/npm/dm/@hosterai/types.svg)](https://www.npmjs.com/package/@hosterai/types)
 [![Build Status](https://github.com/HosterAI/types/actions/workflows/ci.yml/badge.svg)](https://github.com/HosterAI/types/actions/workflows/ci.yml)
@@ -36,6 +42,7 @@ DTOs define the shape of data that is exchanged between different parts of the s
 - `company-data.dto.ts`: Holds all the relevant data for a company.
 - `error-response.dto.ts`: Defines the structure for error responses.
 - `field.dto.ts`: Represents a generic field for forms or dynamic data.
+- `field-option.dto.ts`: Represents options for form fields (used for checkboxes, radioboxes, and selects).
 - `info.dto.ts`: Contains all necessary information for a service integration.
 - `jwt.dto.ts`: DTOs related to JSON Web Tokens.
 - `menu.dto.ts`: Defines the structure for menu items.
@@ -72,7 +79,7 @@ Enums provide a set of named constants for common types, preventing errors with
 
 **Key Enums:**
 
-- `ActionsEnum`: Defines possible actions.
+- `ProductActionsEnum`: Defines possible actions.
 - `CountryEnum`: A list of all countries.
 - `DurationEnum`: Defines billing durations (e.g., `MONTHLY`, `YEARLY`).
 - `EventsEnum`: Defines triggerable events.

package/dist/dtos/field-option.dto.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Data Transfer Object for field options.
+ * This class defines the structure and properties of a field option
+ * that can be used in form fields.
+ */
+export declare class FieldOptionDto {
+    /**
+     * Key of the field option
+     */
+    key: string;
+    /**
+     * Value of the field option
+     */
+    value: string;
+    /**
+     * Indicates if the field option is disabled
+     */
+    disabled?: boolean;
+}

package/dist/dtos/field-option.dto.js

@@ -0,0 +1,42 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldOptionDto = void 0;
+const class_validator_1 = require("class-validator");
+/**
+ * Data Transfer Object for field options.
+ * This class defines the structure and properties of a field option
+ * that can be used in form fields.
+ */
+class FieldOptionDto {
+    constructor() {
+        /**
+         * Indicates if the field option is disabled
+         */
+        this.disabled = false;
+    }
+}
+exports.FieldOptionDto = FieldOptionDto;
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsDefined)(),
+    __metadata("design:type", String)
+], FieldOptionDto.prototype, "key", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsDefined)(),
+    __metadata("design:type", String)
+], FieldOptionDto.prototype, "value", void 0);
+__decorate([
+    (0, class_validator_1.IsBoolean)(),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Boolean)
+], FieldOptionDto.prototype, "disabled", void 0);

package/dist/dtos/field.dto.d.ts

@@ -1,5 +1,6 @@
 import { FieldTypeEnum } from '../enums/field-type.enum';
 import { MultilangTextDto } from './multilang-text.dto';
+import { FieldOptionDto } from './field-option.dto';
 /**
  * Data Transfer Object for a form field.
  * This class defines the structure and properties of a single field
@@ -15,11 +16,16 @@ export declare class FieldDto {
      */
     label: MultilangTextDto[];
     /**
-     * Value of action field
+     * Value of the field.
+     *
+     * String is when it is input, text area
+     * Number is when it is number
+     * FieldOptionDto is when it is checkbox
+     * FieldOptionDto[] is when it is radioboxes or select
      */
-    value: string | number | Record<string, unknown>;
+    value: string | number | FieldOptionDto | FieldOptionDto[];
     /**
-     * Type of label
+     * Type of the field
      */
     type: FieldTypeEnum;
     /**
@@ -43,15 +49,17 @@ export declare class FieldDto {
      */
     regexValidationErrorMessage?: MultilangTextDto[];
     /**
-     * Indicates if the field has remote validation
+     * Indicates if the field triggers remote validation
      */
-    remoteValidation?: boolean;
+    triggersRemoteValidation?: boolean;
     /**
-     * Error message for the field
+     * Error message for the field for supported languages
      */
     remoteValidationErrorMessage?: MultilangTextDto[];
     /**
-     * The item attribute is upgradeable
+     * The item attribute is upgradable
+     * If the user has the permission to upgrade the item from his panel
+     * TODO: Let's see if this approach is the best way for the user to upgrade their item
      */
-    upgradeable: boolean;
+    upgradable: boolean;
 }

package/dist/dtos/field.dto.js

@@ -22,9 +22,15 @@ const multilang_text_dto_1 = require("./multilang-text.dto");
 class FieldDto {
     constructor() {
         /**
-         * The item attribute is upgradeable
+         * Indicates if the field triggers remote validation
          */
-        this.upgradeable = false;
+        this.triggersRemoteValidation = false;
+        /**
+         * The item attribute is upgradable
+         * If the user has the permission to upgrade the item from his panel
+         * TODO: Let's see if this approach is the best way for the user to upgrade their item
+         */
+        this.upgradable = false;
     }
 }
 exports.FieldDto = FieldDto;
@@ -74,7 +80,7 @@ __decorate([
     (0, class_validator_1.IsBoolean)(),
     (0, class_validator_1.IsOptional)(),
     __metadata("design:type", Boolean)
-], FieldDto.prototype, "remoteValidation", void 0);
+], FieldDto.prototype, "triggersRemoteValidation", void 0);
 __decorate([
     (0, class_validator_1.ValidateNested)({ each: true }),
     (0, class_transformer_1.Type)(() => multilang_text_dto_1.MultilangTextDto),
@@ -84,4 +90,4 @@ __decorate([
 __decorate([
     (0, class_validator_1.IsBoolean)(),
     __metadata("design:type", Boolean)
-], FieldDto.prototype, "upgradeable", void 0);
+], FieldDto.prototype, "upgradable", void 0);

package/dist/dtos/info.dto.d.ts

@@ -1,4 +1,4 @@
-import { ActionsEnum } from '../enums/actions.enum';
+import { ProductActionsEnum } from '../enums/actions.enum';
 import { EventsEnum } from '../enums/events.enum';
 import { LanguageEnum } from '../enums/language.enum';
 import { RolesEnum } from '../enums/roles.enum';
@@ -34,7 +34,7 @@ export declare class InfoDto {
     /**
      * A list of actions that are supported by this integration.
      */
-    supportedActions?: ActionsEnum[];
+    supportedActions?: ProductActionsEnum[];
     /**
      * A list of events that the integration listens to.
      * This allows the integration to react to specific events in the system.

package/dist/dtos/product/product.interface.d.ts

@@ -1,4 +1,3 @@
-import { Request } from 'express';
 import { JwtDto } from '../jwt.dto';
 import { ProductInfoResponseDto } from './responses/product-info-response.dto';
 import { ErrorResponseDto } from '../error-response.dto';
@@ -11,18 +10,19 @@ import { ProductUpgradeRequestDto } from './requests/product-upgrade-request.dto
 import { ProductDowngradeRequestDto } from './requests/product-downgrade-request.dto';
 import { ProductSuspendRequestDto } from './requests/product-suspend-request.dto';
 import { ProductUnsuspendRequestDto } from './requests/product-unsuspend-request.dto';
-import { ProductUpgradeableRequestDto } from './requests/product-upgradeable-request.dto';
-import { ProductDowngradableRequestDto } from './requests/product-downgradeable-request.dto';
+import { ProductUpgradableRequestDto } from './requests/product-upgradable-request.dto';
+import { ProductDowngradableRequestDto } from './requests/product-downgradable-request.dto';
 import { ProductDowngradeResponseDto } from './responses/product-downgrade-response.dto';
-import { ProductUpgradeableResponseDto } from './responses/product-upgradeable-response.dto';
+import { ProductUpgradableResponseDto } from './responses/product-upgradable-response.dto';
 import { ProductSuspendResponseDto } from './responses/product-suspend-response.dto';
 import { ProductUnsuspendResponseDto } from './responses/product-unsuspend-response.dto';
-import { ProductDowngradeableResponseDto } from './responses/product-downgradeable-response.dto';
+import { ProductDowngradableResponseDto } from './responses/product-downgradable-response.dto';
 import { ProductDeleteResponseDto } from './responses/product-delete-response.dto';
 import { ProductDeleteRequestDto } from './requests/product-delete-request.dto';
 import { ProductValidateAttributesRequestDto } from './requests/product-validate-attributes-request.dto';
 import { ProductValidateAttributesResponseDto } from './responses/product-validate-attributes-response.dto';
 import { SetupStatusResponseDto } from '../setup-status-response.dto';
+import { CompanyDataDto } from '../company-data.dto';
 export interface ProductControllerInterface {
     info(request: Request & JwtDto): ProductInfoResponseDto | ErrorResponseDto;
     create(requestBody: ProductCreateRequestDto & JwtDto): Promise<ProductCreateResponseDto>;
@@ -31,14 +31,12 @@ export interface ProductControllerInterface {
     downgrade(requestBody: ProductDowngradeRequestDto & JwtDto): Promise<ProductDowngradeResponseDto>;
     suspend(requestBody: ProductSuspendRequestDto & JwtDto): Promise<ProductSuspendResponseDto>;
     unsuspend(requestBody: ProductUnsuspendRequestDto & JwtDto): Promise<ProductUnsuspendResponseDto>;
-    upgradeable(requestBody: ProductUpgradeableRequestDto & JwtDto): Promise<ProductUpgradeableResponseDto>;
-    downgradeable(requestBody: ProductDowngradableRequestDto & JwtDto): Promise<ProductDowngradeableResponseDto>;
+    upgradable(requestBody: ProductUpgradableRequestDto & JwtDto): Promise<ProductUpgradableResponseDto>;
+    downgradeable(requestBody: ProductDowngradableRequestDto & JwtDto): Promise<ProductDowngradableResponseDto>;
     delete(requestBody: ProductDeleteRequestDto & JwtDto): Promise<ProductDeleteResponseDto>;
     validateProductAttributes(requestBody: ProductValidateAttributesRequestDto): Promise<ProductValidateAttributesResponseDto | ErrorResponseDto>;
     validateItemAttributes(requestBody: ProductValidateAttributesRequestDto): Promise<ProductValidateAttributesResponseDto | ErrorResponseDto>;
     setupStatus(): Promise<SetupStatusResponseDto>;
-    install(request: Request & JwtDto): Promise<null | ErrorResponseDto>;
-    uninstall(request: Request & JwtDto, requestBody: {
-        companyId: string;
-    }): Promise<null | ErrorResponseDto>;
+    install(requestBody: CompanyDataDto & JwtDto): Promise<null | ErrorResponseDto>;
+    uninstall(requestBody: JwtDto): Promise<null | ErrorResponseDto>;
 }

package/dist/dtos/product/requests/item-validate-attributes-request.dto.d.ts

@@ -0,0 +1,23 @@
+import { ProductItemDataDto } from '../product-item-data.dto';
+/**
+ * Represents a request to validate item attributes.
+ * This DTO is used when a client needs to check the validity of a set of attribute values
+ * before proceeding with an action, such as creating or updating an item.
+ */
+export declare class ItemValidateAttributesRequestDto {
+    /**
+     * The product data of the item.
+     */
+    productData: ProductItemDataDto;
+    /**
+     * The key of the attribute that triggered the validation.
+     * This helps the server understand the context of the validation request,
+     * especially in cases where validation rules are interdependent.
+     */
+    triggeredByKey: string;
+    /**
+     * A record of attribute values to be validated.
+     * The keys are the attribute identifiers, and the values are the data to be checked.
+     */
+    attributeValues: Record<string, unknown>;
+}

package/dist/dtos/product/requests/item-validate-attributes-request.dto.js

@@ -0,0 +1,39 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ItemValidateAttributesRequestDto = void 0;
+const class_validator_1 = require("class-validator");
+const product_item_data_dto_1 = require("../product-item-data.dto");
+const class_transformer_1 = require("class-transformer");
+/**
+ * Represents a request to validate item attributes.
+ * This DTO is used when a client needs to check the validity of a set of attribute values
+ * before proceeding with an action, such as creating or updating an item.
+ */
+class ItemValidateAttributesRequestDto {
+}
+exports.ItemValidateAttributesRequestDto = ItemValidateAttributesRequestDto;
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_transformer_1.Type)(() => product_item_data_dto_1.ProductItemDataDto),
+    (0, class_validator_1.ValidateNested)(),
+    __metadata("design:type", product_item_data_dto_1.ProductItemDataDto)
+], ItemValidateAttributesRequestDto.prototype, "productData", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], ItemValidateAttributesRequestDto.prototype, "triggeredByKey", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsObject)(),
+    __metadata("design:type", Object)
+], ItemValidateAttributesRequestDto.prototype, "attributeValues", void 0);

package/dist/dtos/product/requests/product-downgradable-request.dto.d.ts

@@ -0,0 +1,18 @@
+import { ProductItemDataDto } from '../product-item-data.dto';
+import { ClientDataDto } from '../../client-data.dto';
+/**
+ * Represents a request to check if a product item is downgradable.
+ * This DTO contains all the necessary information for the check.
+ */
+export declare class ProductDowngradableRequestDto {
+    /**
+     * The client's data.
+     * This object holds all the relevant information about the client initiating the request.
+     */
+    clientData: ClientDataDto;
+    /**
+     * The data of the product item to be checked.
+     * This object contains the specific details of the product instance being evaluated.
+     */
+    itemData: ProductItemDataDto;
+}

package/dist/dtos/product/requests/product-downgradable-request.dto.js

@@ -0,0 +1,37 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductDowngradableRequestDto = void 0;
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+const product_item_data_dto_1 = require("../product-item-data.dto");
+const client_data_dto_1 = require("../../client-data.dto");
+/**
+ * Represents a request to check if a product item is downgradable.
+ * This DTO contains all the necessary information for the check.
+ */
+class ProductDowngradableRequestDto {
+}
+exports.ProductDowngradableRequestDto = ProductDowngradableRequestDto;
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsObject)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => client_data_dto_1.ClientDataDto),
+    __metadata("design:type", client_data_dto_1.ClientDataDto)
+], ProductDowngradableRequestDto.prototype, "clientData", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsObject)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => product_item_data_dto_1.ProductItemDataDto),
+    __metadata("design:type", product_item_data_dto_1.ProductItemDataDto)
+], ProductDowngradableRequestDto.prototype, "itemData", void 0);

package/dist/dtos/product/requests/product-upgradable-request.dto.d.ts

@@ -0,0 +1,18 @@
+import { ProductItemDataDto } from '../product-item-data.dto';
+import { ClientDataDto } from '../../client-data.dto';
+/**
+ * Represents a request to check if a product item is upgradable.
+ * This DTO contains all the necessary information for the check.
+ */
+export declare class ProductUpgradableRequestDto {
+    /**
+     * The client's data.
+     * This object holds all the relevant information about the client initiating the request.
+     */
+    clientData: ClientDataDto;
+    /**
+     * The data of the product item to be checked.
+     * This object contains the specific details of the product instance being evaluated.
+     */
+    itemData: ProductItemDataDto;
+}

package/dist/dtos/product/requests/product-upgradable-request.dto.js

@@ -0,0 +1,37 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductUpgradableRequestDto = void 0;
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+const product_item_data_dto_1 = require("../product-item-data.dto");
+const client_data_dto_1 = require("../../client-data.dto");
+/**
+ * Represents a request to check if a product item is upgradable.
+ * This DTO contains all the necessary information for the check.
+ */
+class ProductUpgradableRequestDto {
+}
+exports.ProductUpgradableRequestDto = ProductUpgradableRequestDto;
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsObject)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => client_data_dto_1.ClientDataDto),
+    __metadata("design:type", client_data_dto_1.ClientDataDto)
+], ProductUpgradableRequestDto.prototype, "clientData", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsObject)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => product_item_data_dto_1.ProductItemDataDto),
+    __metadata("design:type", product_item_data_dto_1.ProductItemDataDto)
+], ProductUpgradableRequestDto.prototype, "itemData", void 0);

package/dist/dtos/product/requests/product-validate-attributes-request.dto.d.ts

@@ -14,5 +14,5 @@ export declare class ProductValidateAttributesRequestDto {
      * A record of attribute values to be validated.
      * The keys are the attribute identifiers, and the values are the data to be checked.
      */
-    values: Record<string, unknown>;
+    attributeValues: Record<string, unknown>;
 }

package/dist/dtos/product/requests/product-validate-attributes-request.dto.js

@@ -28,4 +28,4 @@ __decorate([
     (0, class_validator_1.IsDefined)(),
     (0, class_validator_1.IsObject)(),
     __metadata("design:type", Object)
-], ProductValidateAttributesRequestDto.prototype, "values", void 0);
+], ProductValidateAttributesRequestDto.prototype, "attributeValues", void 0);

package/dist/dtos/product/responses/item-validate-attributes-response.dto.d.ts

@@ -0,0 +1,13 @@
+import { BaseResponse } from '../../base-response.dto';
+import { FieldDto } from '../../field.dto';
+/**
+ * Represents the response from validating item attributes.
+ * Contains the list of attributes that have been validated.
+ */
+export declare class ItemValidateAttributesResponseDto extends BaseResponse {
+    /**
+     * An array of field DTOs representing the validated attributes.
+     * Each `FieldDto` contains details about a single attribute.
+     */
+    validatedAttributes: FieldDto[];
+}

package/dist/dtos/product/responses/item-validate-attributes-response.dto.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ItemValidateAttributesResponseDto = void 0;
+const base_response_dto_1 = require("../../base-response.dto");
+/**
+ * Represents the response from validating item attributes.
+ * Contains the list of attributes that have been validated.
+ */
+class ItemValidateAttributesResponseDto extends base_response_dto_1.BaseResponse {
+}
+exports.ItemValidateAttributesResponseDto = ItemValidateAttributesResponseDto;

package/dist/dtos/product/responses/product-downgradable-response.dto.d.ts

@@ -0,0 +1,22 @@
+import { ResponseStatusEnum } from '../../../enums/response-status.enum';
+import { BaseResponse } from '../../base-response.dto';
+/**
+ * Represents the response for a product Downgradable check.
+ * It indicates whether a product item is Downgradable and may contain additional data.
+ */
+export declare class ProductDowngradableResponseDto extends BaseResponse {
+    /**
+     * The status of the response, indicating success or failure.
+     */
+    status: ResponseStatusEnum;
+    /**
+     * The unique identifier of the product item being checked.
+     */
+    itemId: string;
+    /**
+     * Optional data associated with the Downgradable check.
+     * Can contain details about available downgrades or reasons for failure.
+     * @optional
+     */
+    data?: Record<string, unknown>;
+}

package/dist/dtos/product/responses/product-downgradable-response.dto.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductDowngradableResponseDto = void 0;
+const base_response_dto_1 = require("../../base-response.dto");
+/**
+ * Represents the response for a product Downgradable check.
+ * It indicates whether a product item is Downgradable and may contain additional data.
+ */
+class ProductDowngradableResponseDto extends base_response_dto_1.BaseResponse {
+}
+exports.ProductDowngradableResponseDto = ProductDowngradableResponseDto;

package/dist/dtos/product/responses/product-upgradable-response.dto.d.ts

@@ -0,0 +1,22 @@
+import { ResponseStatusEnum } from '../../../enums/response-status.enum';
+import { BaseResponse } from '../../base-response.dto';
+/**
+ * Represents the response for a product upgradable check.
+ * It indicates whether a product item is upgradable and may contain additional data.
+ */
+export declare class ProductUpgradableResponseDto extends BaseResponse {
+    /**
+     * The status of the response, indicating success or failure.
+     */
+    status: ResponseStatusEnum;
+    /**
+     * The unique identifier of the product item being checked.
+     */
+    itemId: string;
+    /**
+     * Optional data associated with the upgradable check.
+     * Can contain details about available upgrades or reasons for failure.
+     * @optional
+     */
+    data?: Record<string, unknown>;
+}

package/dist/dtos/product/responses/product-upgradable-response.dto.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductUpgradableResponseDto = void 0;
+const base_response_dto_1 = require("../../base-response.dto");
+/**
+ * Represents the response for a product upgradable check.
+ * It indicates whether a product item is upgradable and may contain additional data.
+ */
+class ProductUpgradableResponseDto extends base_response_dto_1.BaseResponse {
+}
+exports.ProductUpgradableResponseDto = ProductUpgradableResponseDto;

package/dist/enums/actions.enum.d.ts

@@ -1,9 +1,9 @@
-export declare enum ActionsEnum {
-    CREATE = "CREATE",
-    RENEW = "RENEW",
-    UPGRADE = "UPGRADE",
-    DOWNGRADE = "DOWNGRADE",
-    SUSPEND = "SUSPEND",
-    UNSUSPEND = "UNSUSPEND",
-    DELETE = "DELETE"
+export declare enum ProductActionsEnum {
+    CREATE = "create",
+    RENEW = "renew",
+    UPGRADE = "upgrade",
+    DOWNGRADE = "downgrade",
+    SUSPEND = "suspend",
+    UNSUSPEND = "unsuspend",
+    DELETE = "delete"
 }

package/dist/enums/actions.enum.js

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ActionsEnum = void 0;
-var ActionsEnum;
-(function (ActionsEnum) {
+exports.ProductActionsEnum = void 0;
+var ProductActionsEnum;
+(function (ProductActionsEnum) {
     // Product Integration
-    ActionsEnum["CREATE"] = "CREATE";
-    ActionsEnum["RENEW"] = "RENEW";
-    ActionsEnum["UPGRADE"] = "UPGRADE";
-    ActionsEnum["DOWNGRADE"] = "DOWNGRADE";
-    ActionsEnum["SUSPEND"] = "SUSPEND";
-    ActionsEnum["UNSUSPEND"] = "UNSUSPEND";
-    ActionsEnum["DELETE"] = "DELETE";
-})(ActionsEnum || (exports.ActionsEnum = ActionsEnum = {}));
+    ProductActionsEnum["CREATE"] = "create";
+    ProductActionsEnum["RENEW"] = "renew";
+    ProductActionsEnum["UPGRADE"] = "upgrade";
+    ProductActionsEnum["DOWNGRADE"] = "downgrade";
+    ProductActionsEnum["SUSPEND"] = "suspend";
+    ProductActionsEnum["UNSUSPEND"] = "unsuspend";
+    ProductActionsEnum["DELETE"] = "delete";
+})(ProductActionsEnum || (exports.ProductActionsEnum = ProductActionsEnum = {}));

package/dist/enums/events.enum.d.ts

@@ -79,14 +79,15 @@ export declare enum EventsEnum {
     ADDON_CREATED = "addon/created",
     ADDON_UPDATED = "addon/updated",
     ADDON_DELETED = "addon/deleted",
-    PAYMENT_CREATED = "payment/created",
-    PAYMENT_CANCELED = "payment/canceled",
-    PAYMENT_FAILED = "payment/failed",
-    PAYMENT_SUBSCRIBED = "payment/subscribed",
-    PAYMENT_UNSUBSCRIBED = "payment/unsubscribed",
-    PAYMENT_UPDATED = "payment/updated",
-    PAYMENT_DELETED = "payment/deleted",
-    PAYMENT_COMPLETED = "payment/completed",
+    TRANSACTION_CREATED = "transaction/created",
+    TRANSACTION_CANCELED = "transaction/canceled",
+    TRANSACTION_FAILED = "transaction/failed",
+    TRANSACTION_SUBSCRIBED = "transaction/subscribed",
+    TRANSACTION_UNSUBSCRIBED = "transaction/unsubscribed",
+    TRANSACTION_UPDATED = "transaction/updated",
+    TRANSACTION_DELETED = "transaction/deleted",
+    TRANSACTION_COMPLETED = "transaction/completed",
+    TRANSACTION_REFUNDED = "transaction/refunded",
     TEMPLATE_CREATED = "template/created",
     TEMPLATE_UPDATED = "template/updated",
     TEMPLATE_DELETED = "template/deleted",

package/dist/enums/events.enum.js

@@ -83,14 +83,15 @@ var EventsEnum;
     EventsEnum["ADDON_CREATED"] = "addon/created";
     EventsEnum["ADDON_UPDATED"] = "addon/updated";
     EventsEnum["ADDON_DELETED"] = "addon/deleted";
-    EventsEnum["PAYMENT_CREATED"] = "payment/created";
-    EventsEnum["PAYMENT_CANCELED"] = "payment/canceled";
-    EventsEnum["PAYMENT_FAILED"] = "payment/failed";
-    EventsEnum["PAYMENT_SUBSCRIBED"] = "payment/subscribed";
-    EventsEnum["PAYMENT_UNSUBSCRIBED"] = "payment/unsubscribed";
-    EventsEnum["PAYMENT_UPDATED"] = "payment/updated";
-    EventsEnum["PAYMENT_DELETED"] = "payment/deleted";
-    EventsEnum["PAYMENT_COMPLETED"] = "payment/completed";
+    EventsEnum["TRANSACTION_CREATED"] = "transaction/created";
+    EventsEnum["TRANSACTION_CANCELED"] = "transaction/canceled";
+    EventsEnum["TRANSACTION_FAILED"] = "transaction/failed";
+    EventsEnum["TRANSACTION_SUBSCRIBED"] = "transaction/subscribed";
+    EventsEnum["TRANSACTION_UNSUBSCRIBED"] = "transaction/unsubscribed";
+    EventsEnum["TRANSACTION_UPDATED"] = "transaction/updated";
+    EventsEnum["TRANSACTION_DELETED"] = "transaction/deleted";
+    EventsEnum["TRANSACTION_COMPLETED"] = "transaction/completed";
+    EventsEnum["TRANSACTION_REFUNDED"] = "transaction/refunded";
     EventsEnum["TEMPLATE_CREATED"] = "template/created";
     EventsEnum["TEMPLATE_UPDATED"] = "template/updated";
     EventsEnum["TEMPLATE_DELETED"] = "template/deleted";

package/dist/index.d.ts

@@ -6,6 +6,7 @@ export * from './dtos/client-data.dto';
 export * from './dtos/company-data.dto';
 export * from './dtos/error-response.dto';
 export * from './dtos/field.dto';
+export * from './dtos/field-option.dto';
 export * from './dtos/info.dto';
 export * from './dtos/jwt.dto';
 export * from './dtos/menu.dto';
@@ -30,24 +31,26 @@ export * from './dtos/product/product-item-data.dto';
 export * from './dtos/product/requests/product-create-request.dto';
 export * from './dtos/product/requests/product-delete-request.dto';
 export * from './dtos/product/requests/product-downgrade-request.dto';
-export * from './dtos/product/requests/product-downgradeable-request.dto';
+export * from './dtos/product/requests/product-downgradable-request.dto';
 export * from './dtos/product/requests/product-renew-request.dto';
 export * from './dtos/product/requests/product-suspend-request.dto';
 export * from './dtos/product/requests/product-unsuspend-request.dto';
 export * from './dtos/product/requests/product-upgrade-request.dto';
-export * from './dtos/product/requests/product-upgradeable-request.dto';
+export * from './dtos/product/requests/product-upgradable-request.dto';
 export * from './dtos/product/requests/product-validate-attributes-request.dto';
+export * from './dtos/product/requests/item-validate-attributes-request.dto';
 export * from './dtos/product/responses/product-create-response.dto';
 export * from './dtos/product/responses/product-delete-response.dto';
 export * from './dtos/product/responses/product-downgrade-response.dto';
-export * from './dtos/product/responses/product-downgradeable-response.dto';
+export * from './dtos/product/responses/product-downgradable-response.dto';
 export * from './dtos/product/responses/product-info-response.dto';
 export * from './dtos/product/responses/product-renew-response.dto';
 export * from './dtos/product/responses/product-suspend-response.dto';
 export * from './dtos/product/responses/product-unsuspend-response.dto';
 export * from './dtos/product/responses/product-upgrade-response.dto';
-export * from './dtos/product/responses/product-upgradeable-response.dto';
+export * from './dtos/product/responses/product-upgradable-response.dto';
 export * from './dtos/product/responses/product-validate-attributes-response.dto';
+export * from './dtos/product/responses/item-validate-attributes-response.dto';
 export * from './enums/actions.enum';
 export * from './enums/country.enum';
 export * from './enums/duration.enum';
@@ -75,11 +78,11 @@ export * from './validators/client-data-validator';
 export * from './validators/product-create-request-validator';
 export * from './validators/product-delete-request-validator';
 export * from './validators/product-downgrade-request-validator';
-export * from './validators/product-downgradeable-request-validator';
+export * from './validators/product-downgradable-request-validator';
 export * from './validators/product-renew-request-validator';
 export * from './validators/product-suspend-request-validator';
 export * from './validators/product-unsuspend-request-validator';
 export * from './validators/product-upgrade-request-validator';
-export * from './validators/product-upgradeable-request-validator';
+export * from './validators/product-upgradable-request-validator';
 export * from './validators/product-validate-attributes-request-validator';
 export * from './dtos/product/product.interface';

package/dist/index.js

@@ -23,6 +23,7 @@ __exportStar(require("./dtos/client-data.dto"), exports);
 __exportStar(require("./dtos/company-data.dto"), exports);
 __exportStar(require("./dtos/error-response.dto"), exports);
 __exportStar(require("./dtos/field.dto"), exports);
+__exportStar(require("./dtos/field-option.dto"), exports);
 __exportStar(require("./dtos/info.dto"), exports);
 __exportStar(require("./dtos/jwt.dto"), exports);
 __exportStar(require("./dtos/menu.dto"), exports);
@@ -50,25 +51,27 @@ __exportStar(require("./dtos/product/product-item-data.dto"), exports);
 __exportStar(require("./dtos/product/requests/product-create-request.dto"), exports);
 __exportStar(require("./dtos/product/requests/product-delete-request.dto"), exports);
 __exportStar(require("./dtos/product/requests/product-downgrade-request.dto"), exports);
-__exportStar(require("./dtos/product/requests/product-downgradeable-request.dto"), exports);
+__exportStar(require("./dtos/product/requests/product-downgradable-request.dto"), exports);
 __exportStar(require("./dtos/product/requests/product-renew-request.dto"), exports);
 __exportStar(require("./dtos/product/requests/product-suspend-request.dto"), exports);
 __exportStar(require("./dtos/product/requests/product-unsuspend-request.dto"), exports);
 __exportStar(require("./dtos/product/requests/product-upgrade-request.dto"), exports);
-__exportStar(require("./dtos/product/requests/product-upgradeable-request.dto"), exports);
+__exportStar(require("./dtos/product/requests/product-upgradable-request.dto"), exports);
 __exportStar(require("./dtos/product/requests/product-validate-attributes-request.dto"), exports);
+__exportStar(require("./dtos/product/requests/item-validate-attributes-request.dto"), exports);
 // Product Responses
 __exportStar(require("./dtos/product/responses/product-create-response.dto"), exports);
 __exportStar(require("./dtos/product/responses/product-delete-response.dto"), exports);
 __exportStar(require("./dtos/product/responses/product-downgrade-response.dto"), exports);
-__exportStar(require("./dtos/product/responses/product-downgradeable-response.dto"), exports);
+__exportStar(require("./dtos/product/responses/product-downgradable-response.dto"), exports);
 __exportStar(require("./dtos/product/responses/product-info-response.dto"), exports);
 __exportStar(require("./dtos/product/responses/product-renew-response.dto"), exports);
 __exportStar(require("./dtos/product/responses/product-suspend-response.dto"), exports);
 __exportStar(require("./dtos/product/responses/product-unsuspend-response.dto"), exports);
 __exportStar(require("./dtos/product/responses/product-upgrade-response.dto"), exports);
-__exportStar(require("./dtos/product/responses/product-upgradeable-response.dto"), exports);
+__exportStar(require("./dtos/product/responses/product-upgradable-response.dto"), exports);
 __exportStar(require("./dtos/product/responses/product-validate-attributes-response.dto"), exports);
+__exportStar(require("./dtos/product/responses/item-validate-attributes-response.dto"), exports);
 // Enums
 __exportStar(require("./enums/actions.enum"), exports);
 __exportStar(require("./enums/country.enum"), exports);
@@ -98,12 +101,12 @@ __exportStar(require("./validators/client-data-validator"), exports);
 __exportStar(require("./validators/product-create-request-validator"), exports);
 __exportStar(require("./validators/product-delete-request-validator"), exports);
 __exportStar(require("./validators/product-downgrade-request-validator"), exports);
-__exportStar(require("./validators/product-downgradeable-request-validator"), exports);
+__exportStar(require("./validators/product-downgradable-request-validator"), exports);
 __exportStar(require("./validators/product-renew-request-validator"), exports);
 __exportStar(require("./validators/product-suspend-request-validator"), exports);
 __exportStar(require("./validators/product-unsuspend-request-validator"), exports);
 __exportStar(require("./validators/product-upgrade-request-validator"), exports);
-__exportStar(require("./validators/product-upgradeable-request-validator"), exports);
+__exportStar(require("./validators/product-upgradable-request-validator"), exports);
 __exportStar(require("./validators/product-validate-attributes-request-validator"), exports);
 // Interfaces
 __exportStar(require("./dtos/product/product.interface"), exports);

package/dist/validators/product-downgradable-request-validator.d.ts

@@ -0,0 +1,8 @@
+import { ValidationError } from 'class-validator';
+/**
+ * Validates a product downgradable request object.
+ *
+ * @param {Record<string, unknown>} plainObject - The plain object to validate.
+ * @returns {Promise<ValidationError[]>} - A promise that resolves with an array of validation errors.
+ */
+export declare const validateProductDowngradableRequestDto: (plainObject: Record<string, unknown>) => Promise<ValidationError[]>;

package/dist/validators/product-downgradable-request-validator.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateProductDowngradableRequestDto = void 0;
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+const product_downgradable_request_dto_1 = require("../dtos/product/requests/product-downgradable-request.dto");
+/**
+ * Validates a product downgradable request object.
+ *
+ * @param {Record<string, unknown>} plainObject - The plain object to validate.
+ * @returns {Promise<ValidationError[]>} - A promise that resolves with an array of validation errors.
+ */
+const validateProductDowngradableRequestDto = async (plainObject) => {
+    const request = (0, class_transformer_1.plainToInstance)(product_downgradable_request_dto_1.ProductDowngradableRequestDto, plainObject);
+    return await (0, class_validator_1.validate)(request);
+};
+exports.validateProductDowngradableRequestDto = validateProductDowngradableRequestDto;

package/dist/validators/product-downgradeable-request-validator.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateProductDowngradableRequestDto = void 0;
 const class_validator_1 = require("class-validator");
 const class_transformer_1 = require("class-transformer");
-const product_downgradeable_request_dto_1 = require("../dtos/product/requests/product-downgradeable-request.dto");
+const product_downgradable_request_dto_1 = require("../dtos/product/requests/product-downgradable-request.dto");
 /**
  * Validates a product downgradable request object.
  *
@@ -11,7 +11,7 @@ const product_downgradeable_request_dto_1 = require("../dtos/product/requests/pr
  * @returns {Promise<ValidationError[]>} - A promise that resolves with an array of validation errors.
  */
 const validateProductDowngradableRequestDto = async (plainObject) => {
-    const request = (0, class_transformer_1.plainToInstance)(product_downgradeable_request_dto_1.ProductDowngradableRequestDto, plainObject);
+    const request = (0, class_transformer_1.plainToInstance)(product_downgradable_request_dto_1.ProductDowngradableRequestDto, plainObject);
     return await (0, class_validator_1.validate)(request);
 };
 exports.validateProductDowngradableRequestDto = validateProductDowngradableRequestDto;

package/dist/validators/product-upgradable-request-validator.d.ts

@@ -0,0 +1,8 @@
+import { ValidationError } from 'class-validator';
+/**
+ * Validates a product upgradable request object.
+ *
+ * @param {Record<string, unknown>} plainObject - The plain object to validate.
+ * @returns {Promise<ValidationError[]>} - A promise that resolves with an array of validation errors.
+ */
+export declare const validateProductUpgradableRequestDto: (plainObject: Record<string, unknown>) => Promise<ValidationError[]>;

package/dist/validators/product-upgradable-request-validator.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateProductUpgradableRequestDto = void 0;
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+const product_upgradable_request_dto_1 = require("../dtos/product/requests/product-upgradable-request.dto");
+/**
+ * Validates a product upgradable request object.
+ *
+ * @param {Record<string, unknown>} plainObject - The plain object to validate.
+ * @returns {Promise<ValidationError[]>} - A promise that resolves with an array of validation errors.
+ */
+const validateProductUpgradableRequestDto = async (plainObject) => {
+    const request = (0, class_transformer_1.plainToInstance)(product_upgradable_request_dto_1.ProductUpgradableRequestDto, plainObject);
+    return await (0, class_validator_1.validate)(request);
+};
+exports.validateProductUpgradableRequestDto = validateProductUpgradableRequestDto;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@hosterai/types",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc",
     "test": "jest",
     "coverage": "jest --coverage",
-    "lint": "eslint . --ext .ts",
+    "lint": "eslint . --ext .ts --fix",
     "format": "prettier --write .",
     "release": "npm run build && npm publish --access public"
   },
@@ -15,6 +15,10 @@
   "author": "",
   "license": "MIT",
   "description": "",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hoster-ai/types.git"
+  },
   "devDependencies": {
     "@types/express": "^5.0.3",
     "@types/fs-extra": "^11.0.4",
@@ -37,7 +41,7 @@
   "peerDependencies": {
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.2",
-    "express": "^5.1.0",
+    "express": "^4.0.0 || ^5.0.0",
     "reflect-metadata": "^0.2.2"
   },
   "files": [