@hosterai/types 0.0.14 → 0.0.15

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 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
      */
     upgradable: boolean;
 }

package/dist/dtos/field.dto.js

@@ -21,8 +21,14 @@ const multilang_text_dto_1 = require("./multilang-text.dto");
  */
 class FieldDto {
     constructor() {
+        /**
+         * Indicates if the field triggers remote validation
+         */
+        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;
     }
@@ -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),

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';
@@ -23,6 +22,7 @@ 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>;
@@ -32,13 +32,11 @@ export interface ProductControllerInterface {
     suspend(requestBody: ProductSuspendRequestDto & JwtDto): Promise<ProductSuspendResponseDto>;
     unsuspend(requestBody: ProductUnsuspendRequestDto & JwtDto): Promise<ProductUnsuspendResponseDto>;
     upgradable(requestBody: ProductUpgradableRequestDto & JwtDto): Promise<ProductUpgradableResponseDto>;
-    Downgradable(requestBody: ProductDowngradableRequestDto & JwtDto): Promise<ProductDowngradableResponseDto>;
+    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-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/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/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';
@@ -37,6 +38,7 @@ export * from './dtos/product/requests/product-unsuspend-request.dto';
 export * from './dtos/product/requests/product-upgrade-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';
@@ -48,6 +50,7 @@ export * from './dtos/product/responses/product-unsuspend-response.dto';
 export * from './dtos/product/responses/product-upgrade-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';

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);
@@ -57,6 +58,7 @@ __exportStar(require("./dtos/product/requests/product-unsuspend-request.dto"), e
 __exportStar(require("./dtos/product/requests/product-upgrade-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);
@@ -69,6 +71,7 @@ __exportStar(require("./dtos/product/responses/product-unsuspend-response.dto"),
 __exportStar(require("./dtos/product/responses/product-upgrade-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);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hosterai/types",
-  "version": "0.0.14",
+  "version": "0.0.15",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {