@hosterai/types 0.0.26 → 0.0.28

package/dist/openapi/schemas/components.schemas.js

@@ -6,7 +6,9 @@ exports.ComponentsSchemas = {
         "properties": {
             "name": {
                 "minLength": 1,
-                "type": "string"
+                "type": "string",
+                "title": "Name",
+                "description": "Country name."
             },
             "code": {
                 "enum": [
@@ -260,10 +262,14 @@ exports.ComponentsSchemas = {
                     "TO",
                     "TT"
                 ],
-                "type": "string"
+                "type": "string",
+                "title": "Code",
+                "description": "Country code."
             },
             "isEurope": {
-                "type": "boolean"
+                "type": "boolean",
+                "title": "Is Europe",
+                "description": "Whether the country is in Europe."
             }
         },
         "type": "object",
@@ -941,11 +947,15 @@ exports.ComponentsSchemas = {
                     "ZA",
                     "ZU"
                 ],
-                "type": "string"
+                "type": "string",
+                "title": "Language",
+                "description": "The language of the text."
             },
             "text": {
                 "minLength": 1,
-                "type": "string"
+                "type": "string",
+                "title": "Text",
+                "description": "The text content in the specified language."
             }
         },
         "type": "object",
@@ -1039,6 +1049,14 @@ exports.ComponentsSchemas = {
                 "title": "Required",
                 "description": "Whether the field is required."
             },
+            "disabled": {
+                "type": "boolean",
+                "title": "Disabled",
+                "description": "Whether the field is disabled."
+            },
+            "hidden": {
+                "type": "boolean"
+            },
             "regexValidation": {
                 "type": "string",
                 "title": "Regex Validation",
@@ -1049,10 +1067,23 @@ exports.ComponentsSchemas = {
                 "items": {
                     "$ref": "#/components/schemas/MultilangTextDto"
                 },
+                "minItems": 1,
                 "type": "array",
                 "title": "Regex Validation Error Message",
                 "description": "Localized error message shown when regex validation fails."
             },
+            "triggersRemoteValidation": {
+                "type": "boolean"
+            },
+            "remoteValidationErrorMessage": {
+                "items": {
+                    "$ref": "#/components/schemas/MultilangTextDto"
+                },
+                "minItems": 1,
+                "type": "array",
+                "title": "Remote Validation Error Message",
+                "description": "Localized error message shown when remote validation fails."
+            },
             "upgradable": {
                 "type": "boolean",
                 "title": "Upgradable",
@@ -1071,8 +1102,7 @@ exports.ComponentsSchemas = {
             "value",
             "type",
             "required",
-            "upgradable",
-            "downgradable"
+            "disabled"
         ]
     },
     "InfoDto": {
@@ -1295,49 +1325,6 @@ exports.ComponentsSchemas = {
                     "EN"
                 ]
             },
-            "supportedTypes": {
-                "items": {
-                    "enum": [
-                        "create",
-                        "renew",
-                        "upgrade",
-                        "downgrade",
-                        "transfer",
-                        "trade",
-                        "suspend",
-                        "unsuspend",
-                        "delete"
-                    ],
-                    "type": "string"
-                },
-                "type": "array",
-                "title": "Supported Actions",
-                "description": "Actions supported by this integration.",
-                "oneOf": [
-                    {
-                        "type": "string",
-                        "enum": [
-                            "create",
-                            "renew",
-                            "upgrade",
-                            "downgrade",
-                            "transfer",
-                            "trade",
-                            "suspend",
-                            "unsuspend",
-                            "delete"
-                        ]
-                    },
-                    {
-                        "type": "string",
-                        "enum": [
-                            "invoice",
-                            "credit-note",
-                            "proforma"
-                        ]
-                    }
-                ]
-            },
             "listenEvents": {
                 "items": {
                     "enum": [
@@ -1512,6 +1499,9 @@ exports.ComponentsSchemas = {
                         "item/activated",
                         "item/set-inactive",
                         "item/processed",
+                        "item/refund-requested",
+                        "item/refund-accepted",
+                        "item/refund-rejected",
                         "order/paid",
                         "test",
                         "dead-lettering",
@@ -1899,49 +1889,6 @@ exports.ComponentsSchemas = {
                     "EN"
                 ]
             },
-            "supportedTypes": {
-                "items": {
-                    "enum": [
-                        "create",
-                        "renew",
-                        "upgrade",
-                        "downgrade",
-                        "transfer",
-                        "trade",
-                        "suspend",
-                        "unsuspend",
-                        "delete"
-                    ],
-                    "type": "string"
-                },
-                "type": "array",
-                "title": "Supported Actions",
-                "description": "Actions supported by this integration.",
-                "oneOf": [
-                    {
-                        "type": "string",
-                        "enum": [
-                            "create",
-                            "renew",
-                            "upgrade",
-                            "downgrade",
-                            "transfer",
-                            "trade",
-                            "suspend",
-                            "unsuspend",
-                            "delete"
-                        ]
-                    },
-                    {
-                        "type": "string",
-                        "enum": [
-                            "invoice",
-                            "credit-note",
-                            "proforma"
-                        ]
-                    }
-                ]
-            },
             "listenEvents": {
                 "items": {
                     "enum": [
@@ -2116,6 +2063,9 @@ exports.ComponentsSchemas = {
                         "item/activated",
                         "item/set-inactive",
                         "item/processed",
+                        "item/refund-requested",
+                        "item/refund-accepted",
+                        "item/refund-rejected",
                         "order/paid",
                         "test",
                         "dead-lettering",
@@ -2227,11 +2177,148 @@ exports.ComponentsSchemas = {
             "supportedLanguages"
         ]
     },
+    "AttributeFieldDto": {
+        "properties": {
+            "visibleInOrder": {
+                "type": "boolean",
+                "title": "Visible In Order",
+                "description": "Whether the field is visible in order view."
+            },
+            "visibleInClientPanel": {
+                "type": "boolean",
+                "title": "Visible In Client Panel",
+                "description": "Whether the field is visible in the client panel."
+            },
+            "repeatableMin": {
+                "type": "number",
+                "title": "Repeatable Min",
+                "description": "Minimum repeats for repeatable fields."
+            },
+            "repeatableMax": {
+                "type": "number",
+                "title": "Repeatable Max",
+                "description": "Maximum repeats for repeatable fields."
+            },
+            "id": {
+                "type": "string",
+                "title": "ID",
+                "description": "Unique identifier for the field."
+            },
+            "label": {
+                "items": {
+                    "$ref": "#/components/schemas/MultilangTextDto"
+                },
+                "minItems": 1,
+                "type": "array",
+                "title": "Label",
+                "description": "Multilingual label for the field."
+            },
+            "value": {
+                "title": "Value",
+                "description": "Value of the field. String/Number, or FieldOptionDto/FieldOptionDto[] depending on type.",
+                "oneOf": [
+                    {
+                        "title": "String",
+                        "type": "string"
+                    },
+                    {
+                        "title": "Number",
+                        "type": "number"
+                    },
+                    {
+                        "title": "Option",
+                        "$ref": "#/components/schemas/FieldOptionDto"
+                    },
+                    {
+                        "title": "Options Array",
+                        "type": "array",
+                        "items": {
+                            "$ref": "#/components/schemas/FieldOptionDto"
+                        }
+                    }
+                ]
+            },
+            "type": {
+                "enum": [
+                    "TEXT_BOX",
+                    "TEXT_AREA",
+                    "SELECT",
+                    "MULTI_SELECT",
+                    "DESCRIPTION",
+                    "RADIO_BOX",
+                    "CHECKBOX",
+                    "SLIDER"
+                ],
+                "type": "string",
+                "title": "Field Type",
+                "description": "Type of the field."
+            },
+            "required": {
+                "type": "boolean",
+                "title": "Required",
+                "description": "Whether the field is required."
+            },
+            "disabled": {
+                "type": "boolean",
+                "title": "Disabled",
+                "description": "Whether the field is disabled."
+            },
+            "hidden": {
+                "type": "boolean"
+            },
+            "regexValidation": {
+                "type": "string",
+                "title": "Regex Validation",
+                "description": "Optional regex to validate input.",
+                "example": "^[A-Za-z0-9_-]+$"
+            },
+            "regexValidationErrorMessage": {
+                "items": {
+                    "$ref": "#/components/schemas/MultilangTextDto"
+                },
+                "minItems": 1,
+                "type": "array",
+                "title": "Regex Validation Error Message",
+                "description": "Localized error message shown when regex validation fails."
+            },
+            "triggersRemoteValidation": {
+                "type": "boolean"
+            },
+            "remoteValidationErrorMessage": {
+                "items": {
+                    "$ref": "#/components/schemas/MultilangTextDto"
+                },
+                "minItems": 1,
+                "type": "array",
+                "title": "Remote Validation Error Message",
+                "description": "Localized error message shown when remote validation fails."
+            },
+            "upgradable": {
+                "type": "boolean",
+                "title": "Upgradable",
+                "description": "Whether the item attribute is upgradable by the user."
+            },
+            "downgradable": {
+                "type": "boolean",
+                "title": "Downgradable",
+                "description": "Whether the item attribute is downgradable by the user."
+            }
+        },
+        "type": "object",
+        "required": [
+            "id",
+            "label",
+            "value",
+            "type",
+            "required",
+            "disabled"
+        ]
+    },
     "ProductInfoDto": {
         "properties": {
             "productAttributes": {
                 "items": {
-                    "$ref": "#/components/schemas/FieldDto"
+                    "$ref": "#/components/schemas/AttributeFieldDto"
                 },
                 "type": "array",
                 "minItems": 1,
@@ -2240,7 +2327,7 @@ exports.ComponentsSchemas = {
             },
             "itemAttributes": {
                 "items": {
-                    "$ref": "#/components/schemas/FieldDto"
+                    "$ref": "#/components/schemas/AttributeFieldDto"
                 },
                 "type": "array",
                 "minItems": 1,
@@ -2275,7 +2362,7 @@ exports.ComponentsSchemas = {
                     "status_text": "status"
                 }
             },
-            "supportedTypes": {
+            "supportedActions": {
                 "items": {
                     "enum": [
                         "create",
@@ -2687,6 +2774,9 @@ exports.ComponentsSchemas = {
                         "item/activated",
                         "item/set-inactive",
                         "item/processed",
+                        "item/refund-requested",
+                        "item/refund-accepted",
+                        "item/refund-rejected",
                         "order/paid",
                         "test",
                         "dead-lettering",
@@ -2793,6 +2883,7 @@ exports.ComponentsSchemas = {
         },
         "type": "object",
         "required": [
+            "supportedActions",
             "title",
             "supportedLanguages"
         ]

package/dist/validators/addon-field-validator.d.ts

@@ -0,0 +1,9 @@
+import { ValidationError } from 'class-validator';
+/**
+ * Validates an AddonFieldDto object.
+ * Since AddonFieldDto is an empty subclass of FieldDto, this delegates to validateFieldDto.
+ *
+ * @param data The object to validate as an AddonFieldDto.
+ * @returns An array of validation errors, empty if validation succeeds.
+ */
+export declare function validateAddonFieldDto(data: object): ValidationError[];

package/dist/validators/addon-field-validator.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateAddonFieldDto = validateAddonFieldDto;
+const field_validator_1 = require("./field-validator");
+/**
+ * Validates an AddonFieldDto object.
+ * Since AddonFieldDto is an empty subclass of FieldDto, this delegates to validateFieldDto.
+ *
+ * @param data The object to validate as an AddonFieldDto.
+ * @returns An array of validation errors, empty if validation succeeds.
+ */
+function validateAddonFieldDto(data) {
+    return (0, field_validator_1.validateFieldDto)(data);
+}

package/dist/validators/addon-field-validator.spec.d.ts

@@ -0,0 +1 @@
+import 'reflect-metadata';

package/dist/validators/addon-field-validator.spec.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("reflect-metadata");
+const addon_field_validator_1 = require("./addon-field-validator");
+const field_type_enum_1 = require("../enums/field-type.enum");
+const language_enum_1 = require("../enums/language.enum");
+const baseValidDto = {
+    id: 'addon-1',
+    label: [{ language: language_enum_1.LanguageEnum.ENGLISH, text: 'Addon Field' }],
+    value: 'test-value',
+    type: field_type_enum_1.FieldTypeEnum.TEXT_BOX,
+    required: true,
+    disabled: false,
+    upgradable: false,
+};
+describe('AddonFieldDto Validator', () => {
+    describe('Valid cases', () => {
+        it('should return no errors for a valid DTO', () => {
+            expect((0, addon_field_validator_1.validateAddonFieldDto)(baseValidDto)).toHaveLength(0);
+        });
+    });
+    describe('Missing required fields', () => {
+        it('should return errors when all fields are missing', () => {
+            const errors = (0, addon_field_validator_1.validateAddonFieldDto)({});
+            const requiredProps = ['id', 'label', 'value', 'type', 'required', 'disabled'];
+            for (const prop of requiredProps) {
+                expect(errors.some(e => e.property === prop)).toBe(true);
+            }
+        });
+    });
+    describe('Invalid field values', () => {
+        it('should return error for invalid type enum', () => {
+            const dto = { ...baseValidDto, type: 'not-a-valid-type' };
+            const errors = (0, addon_field_validator_1.validateAddonFieldDto)(dto);
+            expect(errors.some(e => e.property === 'type')).toBe(true);
+        });
+    });
+});

package/dist/validators/attachment-validator.d.ts

@@ -0,0 +1,8 @@
+import { ValidationError } from 'class-validator';
+/**
+ * Validates an AttachmentDto object using class-validator decorators.
+ *
+ * @param data The object to validate as an AttachmentDto.
+ * @returns An array of validation errors, empty if validation succeeds.
+ */
+export declare function validateAttachmentDto(data: object): ValidationError[];

package/dist/validators/attachment-validator.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateAttachmentDto = validateAttachmentDto;
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+const attachment_dto_1 = require("../dtos/attachment.dto");
+/**
+ * Validates an AttachmentDto object using class-validator decorators.
+ *
+ * @param data The object to validate as an AttachmentDto.
+ * @returns An array of validation errors, empty if validation succeeds.
+ */
+function validateAttachmentDto(data) {
+    const dto = (0, class_transformer_1.plainToInstance)(attachment_dto_1.AttachmentDto, data);
+    const errors = (0, class_validator_1.validateSync)(dto);
+    return errors;
+}

package/dist/validators/attachment-validator.spec.d.ts

@@ -0,0 +1 @@
+import 'reflect-metadata';

package/dist/validators/attachment-validator.spec.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("reflect-metadata");
+const attachment_validator_1 = require("./attachment-validator");
+const baseValidDto = {
+    filename: 'document.pdf',
+    content: 'SGVsbG8gV29ybGQ=', // "Hello World" in base64
+};
+describe('AttachmentDto Validator', () => {
+    describe('Valid cases', () => {
+        it('should return no errors for a valid DTO', () => {
+            expect((0, attachment_validator_1.validateAttachmentDto)(baseValidDto)).toHaveLength(0);
+        });
+        it('should return no errors with optional contentType', () => {
+            const dto = { ...baseValidDto, contentType: 'application/pdf' };
+            expect((0, attachment_validator_1.validateAttachmentDto)(dto)).toHaveLength(0);
+        });
+    });
+    describe('Missing required fields', () => {
+        it('should return errors when all fields are missing', () => {
+            const errors = (0, attachment_validator_1.validateAttachmentDto)({});
+            expect(errors.some(e => e.property === 'filename')).toBe(true);
+            expect(errors.some(e => e.property === 'content')).toBe(true);
+        });
+        it('should return error when filename is missing', () => {
+            const dto = { content: 'SGVsbG8=' };
+            const errors = (0, attachment_validator_1.validateAttachmentDto)(dto);
+            expect(errors.some(e => e.property === 'filename')).toBe(true);
+        });
+        it('should return error when content is missing', () => {
+            const dto = { filename: 'test.pdf' };
+            const errors = (0, attachment_validator_1.validateAttachmentDto)(dto);
+            expect(errors.some(e => e.property === 'content')).toBe(true);
+        });
+    });
+    describe('Invalid field values', () => {
+        it('should return error for empty filename', () => {
+            const dto = { ...baseValidDto, filename: '' };
+            const errors = (0, attachment_validator_1.validateAttachmentDto)(dto);
+            expect(errors.some(e => e.property === 'filename')).toBe(true);
+        });
+        it('should return error for empty content', () => {
+            const dto = { ...baseValidDto, content: '' };
+            const errors = (0, attachment_validator_1.validateAttachmentDto)(dto);
+            expect(errors.some(e => e.property === 'content')).toBe(true);
+        });
+        it('should return error for non-base64 content', () => {
+            const dto = { ...baseValidDto, content: 'not-valid-base64!!!' };
+            const errors = (0, attachment_validator_1.validateAttachmentDto)(dto);
+            expect(errors.some(e => e.property === 'content')).toBe(true);
+        });
+        it('should return error for non-string contentType', () => {
+            const dto = { ...baseValidDto, contentType: 123 };
+            const errors = (0, attachment_validator_1.validateAttachmentDto)(dto);
+            expect(errors.some(e => e.property === 'contentType')).toBe(true);
+        });
+    });
+});

package/dist/validators/attribute-field-validator.d.ts

@@ -0,0 +1,8 @@
+import { ValidationError } from 'class-validator';
+/**
+ * Validates an AttributeFieldDto object using class-validator decorators.
+ *
+ * @param data The object to validate as an AttributeFieldDto.
+ * @returns An array of validation errors, empty if validation succeeds.
+ */
+export declare function validateAttributeFieldDto(data: object): ValidationError[];

package/dist/validators/attribute-field-validator.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateAttributeFieldDto = validateAttributeFieldDto;
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+const attribute_field_dto_1 = require("../dtos/attribute-field.dto");
+/**
+ * Validates an AttributeFieldDto object using class-validator decorators.
+ *
+ * @param data The object to validate as an AttributeFieldDto.
+ * @returns An array of validation errors, empty if validation succeeds.
+ */
+function validateAttributeFieldDto(data) {
+    const dto = (0, class_transformer_1.plainToInstance)(attribute_field_dto_1.AttributeFieldDto, data);
+    const errors = (0, class_validator_1.validateSync)(dto);
+    return errors;
+}

package/dist/validators/attribute-field-validator.spec.d.ts

@@ -0,0 +1 @@
+import 'reflect-metadata';

package/dist/validators/attribute-field-validator.spec.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("reflect-metadata");
+const attribute_field_validator_1 = require("./attribute-field-validator");
+const field_type_enum_1 = require("../enums/field-type.enum");
+const language_enum_1 = require("../enums/language.enum");
+const baseValidDto = {
+    id: 'attr-1',
+    label: [{ language: language_enum_1.LanguageEnum.ENGLISH, text: 'CPU Cores' }],
+    value: '4',
+    type: field_type_enum_1.FieldTypeEnum.TEXT_BOX,
+    required: true,
+    disabled: false,
+    upgradable: false,
+};
+describe('AttributeFieldDto Validator', () => {
+    describe('Valid cases', () => {
+        it('should return no errors for a valid DTO (inherited fields only)', () => {
+            expect((0, attribute_field_validator_1.validateAttributeFieldDto)(baseValidDto)).toHaveLength(0);
+        });
+        it('should return no errors with optional visibleInOrder and visibleInClientPanel', () => {
+            const dto = { ...baseValidDto, visibleInOrder: true, visibleInClientPanel: false };
+            expect((0, attribute_field_validator_1.validateAttributeFieldDto)(dto)).toHaveLength(0);
+        });
+        it('should return no errors with both repeatableMin and repeatableMax', () => {
+            const dto = { ...baseValidDto, repeatableMin: 1, repeatableMax: 5 };
+            expect((0, attribute_field_validator_1.validateAttributeFieldDto)(dto)).toHaveLength(0);
+        });
+        it('should return no errors when repeatableMin equals repeatableMax', () => {
+            const dto = { ...baseValidDto, repeatableMin: 3, repeatableMax: 3 };
+            expect((0, attribute_field_validator_1.validateAttributeFieldDto)(dto)).toHaveLength(0);
+        });
+    });
+    describe('AllOrNone constraint on repeatableMin/repeatableMax', () => {
+        it('should return error when only repeatableMin is provided', () => {
+            const dto = { ...baseValidDto, repeatableMin: 1 };
+            const errors = (0, attribute_field_validator_1.validateAttributeFieldDto)(dto);
+            expect(errors.length).toBeGreaterThan(0);
+        });
+        it('should return error when only repeatableMax is provided', () => {
+            const dto = { ...baseValidDto, repeatableMax: 5 };
+            const errors = (0, attribute_field_validator_1.validateAttributeFieldDto)(dto);
+            expect(errors.length).toBeGreaterThan(0);
+        });
+    });
+    describe('MinLessOrEqual constraint on repeatableMin/repeatableMax', () => {
+        it('should return error when repeatableMin is greater than repeatableMax', () => {
+            const dto = { ...baseValidDto, repeatableMin: 10, repeatableMax: 5 };
+            const errors = (0, attribute_field_validator_1.validateAttributeFieldDto)(dto);
+            expect(errors.length).toBeGreaterThan(0);
+        });
+    });
+    describe('Invalid field values', () => {
+        it('should return error for non-boolean visibleInOrder', () => {
+            const dto = { ...baseValidDto, visibleInOrder: 'yes' };
+            const errors = (0, attribute_field_validator_1.validateAttributeFieldDto)(dto);
+            expect(errors.some(e => e.property === 'visibleInOrder')).toBe(true);
+        });
+        it('should return error for non-boolean visibleInClientPanel', () => {
+            const dto = { ...baseValidDto, visibleInClientPanel: 1 };
+            const errors = (0, attribute_field_validator_1.validateAttributeFieldDto)(dto);
+            expect(errors.some(e => e.property === 'visibleInClientPanel')).toBe(true);
+        });
+        it('should return error for non-number repeatableMin', () => {
+            const dto = { ...baseValidDto, repeatableMin: 'one', repeatableMax: 5 };
+            const errors = (0, attribute_field_validator_1.validateAttributeFieldDto)(dto);
+            expect(errors.some(e => e.property === 'repeatableMin')).toBe(true);
+        });
+        it('should return error for non-number repeatableMax', () => {
+            const dto = { ...baseValidDto, repeatableMin: 1, repeatableMax: 'five' };
+            const errors = (0, attribute_field_validator_1.validateAttributeFieldDto)(dto);
+            expect(errors.some(e => e.property === 'repeatableMax')).toBe(true);
+        });
+    });
+    describe('Inherited FieldDto validation', () => {
+        it('should return errors when inherited required fields are missing', () => {
+            const errors = (0, attribute_field_validator_1.validateAttributeFieldDto)({});
+            const requiredProps = ['id', 'label', 'value', 'type', 'required', 'disabled'];
+            for (const prop of requiredProps) {
+                expect(errors.some(e => e.property === prop)).toBe(true);
+            }
+        });
+    });
+});