@hosterai/types 0.0.30 → 0.0.31

package/README.md

@@ -165,6 +165,7 @@ This package includes validation functions that leverage `class-validator` to en
 **Available Validators:**
 
 **Core Validators:**
+
 - `validateActionDto`: Validates UI actions.
 - `validateClientDataDto`: Validates client data.
 - `validateCompanyDataDto`: Validates company data.
@@ -183,24 +184,28 @@ This package includes validation functions that leverage `class-validator` to en
 - `validateInfoDto`: Validates integration info.
 
 **Panel Validators:**
+
 - `validateAdminPanelDto`: Validates admin panel configuration.
 - `validateAdminPanelTabsDto`: Validates admin panel tabs.
 - `validateAdminPanelMoreActionsDto`: Validates admin panel additional actions.
 - `validateClientPanelDto`: Validates client panel configuration.
 
 **Menu & Settings Validators:**
+
 - `validateMenuWithUrlDto`: Validates menu items with direct URLs.
 - `validateMenuWithSubmenuDto`: Validates menu items with submenus.
 - `validateSettingsWithUrlDto`: Validates settings with URL configuration.
 - `validateSettingsWithTabsDto`: Validates settings with tabs configuration.
 
 **Notification Validators:**
+
 - `validateNotificationRequestDto`: Validates the main notification request.
 - `validateNotificationInfoDto`: Validates notification information.
 - `validateEmailReceiverDto`, `validateSmsReceiverDto`, `validatePushReceiverDto`: Validators for notification receivers.
 - `validateEmailSenderDto`, `validateSmsSenderDto`, `validatePushSenderDto`: Validators for notification senders.
 
 **Invoice Validators:**
+
 - `validateInvoiceInfoDto`: Validates invoice integration info.
 - `validateInvoiceContactDataDto`: Validates invoice contact data.
 - `validateInvoiceItemDataDto`: Validates invoice item data.
@@ -208,6 +213,7 @@ This package includes validation functions that leverage `class-validator` to en
 - `validateTransactionDataDto`: Validates transaction data.
 
 **Product Validators:**
+
 - `validateProductInfoDto`: Validates product information.
 - `validateProductCreateRequestDto`: Validates product creation requests.
 - `validateProductDeleteRequestDto`: Validates product deletion requests.
@@ -220,7 +226,6 @@ This package includes validation functions that leverage `class-validator` to en
 - `validateProductDowngradableRequestDto`: Validates product downgradability checks.
 - `validateValidateAttributesRequestDto`: Validates attribute validation requests.
 
-
 ### Custom Decorators
 
 The package includes custom `class-validator` decorators for advanced validation scenarios:

package/dist/decorators/is-e164-validator.spec.d.ts

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

package/dist/decorators/is-e164-validator.spec.js

@@ -0,0 +1,64 @@
+"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 });
+const class_validator_1 = require("class-validator");
+const is_e164_validator_1 = require("./is-e164.validator");
+class TestDto {
+}
+__decorate([
+    (0, is_e164_validator_1.IsE164)(),
+    __metadata("design:type", String)
+], TestDto.prototype, "phone", void 0);
+describe('IsE164', () => {
+    it('should validate canonical E.164 numbers', () => {
+        const dto = new TestDto();
+        dto.phone = '+14155552671';
+        const errors = (0, class_validator_1.validateSync)(dto);
+        expect(errors.length).toBe(0);
+    });
+    it('should validate another canonical E.164 number', () => {
+        const dto = new TestDto();
+        dto.phone = '+306912345678';
+        const errors = (0, class_validator_1.validateSync)(dto);
+        expect(errors.length).toBe(0);
+    });
+    it('should invalidate numbers without leading +', () => {
+        const dto = new TestDto();
+        dto.phone = '14155552671';
+        const errors = (0, class_validator_1.validateSync)(dto);
+        expect(errors.length).toBeGreaterThan(0);
+    });
+    it('should invalidate numbers with spaces or formatting', () => {
+        const dto = new TestDto();
+        dto.phone = '+1 415 555 2671';
+        const errors = (0, class_validator_1.validateSync)(dto);
+        expect(errors.length).toBeGreaterThan(0);
+    });
+    it('should invalidate clearly invalid strings', () => {
+        const dto = new TestDto();
+        dto.phone = 'not-a-phone';
+        const errors = (0, class_validator_1.validateSync)(dto);
+        expect(errors.length).toBeGreaterThan(0);
+    });
+    it('should invalidate non-string values', () => {
+        const dto = new TestDto();
+        // @ts-expect-error -- intentionally wrong type for negative test
+        dto.phone = 14155552671;
+        const errors = (0, class_validator_1.validateSync)(dto);
+        expect(errors.length).toBeGreaterThan(0);
+    });
+    it('should invalidate empty strings', () => {
+        const dto = new TestDto();
+        dto.phone = '';
+        const errors = (0, class_validator_1.validateSync)(dto);
+        expect(errors.length).toBeGreaterThan(0);
+    });
+});

package/dist/decorators/is-e164.validator.d.ts

@@ -0,0 +1,2 @@
+import { ValidationOptions } from 'class-validator';
+export declare function IsE164(validationOptions?: ValidationOptions): (object: object, propertyName: string) => void;

package/dist/decorators/is-e164.validator.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IsE164 = IsE164;
+const class_validator_1 = require("class-validator");
+const libphonenumber_js_1 = require("libphonenumber-js");
+function IsE164(validationOptions) {
+    return function (object, propertyName) {
+        (0, class_validator_1.registerDecorator)({
+            name: 'isE164',
+            target: object.constructor,
+            propertyName: propertyName,
+            options: validationOptions,
+            validator: {
+                validate(value) {
+                    if (typeof value !== 'string')
+                        return false;
+                    if (value.trim().length === 0)
+                        return false;
+                    const parsed = (0, libphonenumber_js_1.parsePhoneNumberFromString)(value);
+                    if (!parsed)
+                        return false;
+                    return parsed.format('E.164') === value;
+                },
+                defaultMessage() {
+                    return '$property must be a valid E.164 phone number (e.g. +14155552671)';
+                },
+            },
+        });
+    };
+}

package/dist/decorators/unique-field-in-array-validator.spec.js

@@ -36,4 +36,18 @@ describe('UniqueFieldInArray', () => {
         const errors = (0, class_validator_1.validateSync)(dto);
         expect(errors.length).toBe(0);
     });
+    it('should support dotted paths for nested fields', () => {
+        class NestedDto {
+        }
+        __decorate([
+            (0, unique_field_in_array_validator_1.UniqueFieldInArray)('nested.id'),
+            __metadata("design:type", Array)
+        ], NestedDto.prototype, "items", void 0);
+        const ok = new NestedDto();
+        ok.items = [{ nested: { id: 1 } }, { nested: { id: 2 } }];
+        expect((0, class_validator_1.validateSync)(ok).length).toBe(0);
+        const bad = new NestedDto();
+        bad.items = [{ nested: { id: 1 } }, { nested: { id: 1 } }];
+        expect((0, class_validator_1.validateSync)(bad).length).toBeGreaterThan(0);
+    });
 });

package/dist/decorators/unique-field-in-array.validator.js

@@ -9,18 +9,32 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UniqueFieldInArrayConstraint = void 0;
 exports.UniqueFieldInArray = UniqueFieldInArray;
 const class_validator_1 = require("class-validator");
+/**
+ * Walk a dotted path (`'a.b.c'`) into an object. Returns undefined if any segment is missing
+ * or if a non-object is encountered before the leaf.
+ */
+function readPath(obj, path) {
+    let current = obj;
+    for (const segment of path.split('.')) {
+        if (current === null || typeof current !== 'object')
+            return undefined;
+        current = current[segment];
+    }
+    return current;
+}
 let UniqueFieldInArrayConstraint = class UniqueFieldInArrayConstraint {
     validate(value, args) {
         if (!Array.isArray(value))
             return true; // Let @IsArray handle wrong type
-        const field = args.constraints[0];
+        const path = args.constraints[0];
         const seen = new Set();
         for (const obj of value) {
-            if (obj && typeof obj === 'object' && obj[field] !== undefined) {
-                if (seen.has(obj[field])) {
+            const fieldValue = readPath(obj, path);
+            if (fieldValue !== undefined) {
+                if (seen.has(fieldValue)) {
                     return false;
                 }
-                seen.add(obj[field]);
+                seen.add(fieldValue);
             }
         }
         return true;

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

@@ -1,7 +1,11 @@
-import { FieldDto } from './field.dto';
+import { AnyFieldDto } from './fields/any-field.dto';
 /**
  * Fields defined by the seller for a product, requested during checkout setup.
  * These fields contain information relevant only to the seller, not to the integration.
+ *
+ * Wraps a concrete field DTO under the nested `field` property — validate the
+ * union separately (see `validateAddonFieldDto`).
  */
-export declare class AddonFieldDto extends FieldDto {
+export declare class AddonFieldDto {
+    field: AnyFieldDto;
 }

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

@@ -1,11 +1,34 @@
 "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.AddonFieldDto = void 0;
-const field_dto_1 = require("./field.dto");
+const class_validator_1 = require("class-validator");
+const class_validator_jsonschema_1 = require("class-validator-jsonschema");
 /**
  * Fields defined by the seller for a product, requested during checkout setup.
  * These fields contain information relevant only to the seller, not to the integration.
+ *
+ * Wraps a concrete field DTO under the nested `field` property — validate the
+ * union separately (see `validateAddonFieldDto`).
  */
-class AddonFieldDto extends field_dto_1.FieldDto {
+class AddonFieldDto {
 }
 exports.AddonFieldDto = AddonFieldDto;
+__decorate([
+    (0, class_validator_1.IsObject)(),
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Field',
+        description: 'The concrete field DTO (discriminated by its `type` literal).',
+        $ref: '#/components/schemas/AnyFieldDto',
+    }),
+    __metadata("design:type", Object)
+], AddonFieldDto.prototype, "field", void 0);

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

@@ -1,19 +1,31 @@
-import { FieldDto } from './field.dto';
-export declare class AttributeFieldDto extends FieldDto {
+import { AnyFieldDto } from './fields/any-field.dto';
+/**
+ * Wraps a concrete field DTO with product-attribute-specific options.
+ *
+ * The underlying field lives under the nested `field` property — its concrete
+ * class is discriminated by `field.type` and must be validated separately
+ * (see `validateAttributeFieldDto`).
+ */
+export declare class AttributeFieldDto {
     /**
-     * Indicates if the field is visible in orders
+     * The concrete field DTO (one of `AnyFieldDto`). Validated separately by
+     * the dispatcher in `validateAttributeFieldDto` since it is a discriminated union.
+     */
+    field: AnyFieldDto;
+    /**
+     * Indicates if the field is visible in orders.
      */
     visibleInOrder?: boolean;
     /**
-     * Indicates if the field is visible in client panel
+     * Indicates if the field is visible in client panel.
      */
     visibleInClientPanel?: boolean;
     /**
-     * Minimum repeats for repeatable fields
+     * Minimum repeats for repeatable fields.
      */
     repeatableMin?: number;
     /**
-     * Maximum repeats for repeatable fields
+     * Maximum repeats for repeatable fields.
      */
     repeatableMax?: number;
 }

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

@@ -12,12 +12,28 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AttributeFieldDto = void 0;
 const class_validator_1 = require("class-validator");
 const class_validator_jsonschema_1 = require("class-validator-jsonschema");
-const field_dto_1 = require("./field.dto");
 const all_or_none_validator_1 = require("../decorators/all-or-none.validator");
 const min_less_or_equal_validator_1 = require("../decorators/min-less-or-equal.validator");
-let AttributeFieldDto = class AttributeFieldDto extends field_dto_1.FieldDto {
+/**
+ * Wraps a concrete field DTO with product-attribute-specific options.
+ *
+ * The underlying field lives under the nested `field` property — its concrete
+ * class is discriminated by `field.type` and must be validated separately
+ * (see `validateAttributeFieldDto`).
+ */
+let AttributeFieldDto = class AttributeFieldDto {
 };
 exports.AttributeFieldDto = AttributeFieldDto;
+__decorate([
+    (0, class_validator_1.IsObject)(),
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Field',
+        description: 'The concrete field DTO (discriminated by its `type` literal).',
+        $ref: '#/components/schemas/AnyFieldDto',
+    }),
+    __metadata("design:type", Object)
+], AttributeFieldDto.prototype, "field", void 0);
 __decorate([
     (0, class_validator_1.IsBoolean)(),
     (0, class_validator_1.IsOptional)(),

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

@@ -0,0 +1,45 @@
+import { MultilangTextDto } from './multilang-text.dto';
+/**
+ * Abstract base shared by every concrete field DTO (TextFieldDto, NumberFieldDto, ...).
+ *
+ * Concrete classes add a string-literal `type` discriminator and a typed `value` plus any
+ * type-specific options (min/max, regex validation for text, etc.).
+ */
+export declare abstract class BaseFieldDto {
+    /**
+     * Unique identifier for the field.
+     */
+    id: string;
+    /**
+     * Multilingual label for the field.
+     */
+    label: MultilangTextDto[];
+    /**
+     * Whether the field is required.
+     */
+    required?: boolean;
+    /**
+     * Whether the field is disabled.
+     */
+    disabled?: boolean;
+    /**
+     * Whether the field is hidden.
+     */
+    hidden?: boolean;
+    /**
+     * Whether remote validation should be triggered.
+     */
+    triggersRemoteValidation?: boolean;
+    /**
+     * Localized error message shown when remote validation fails.
+     */
+    remoteValidationErrorMessage?: MultilangTextDto[];
+    /**
+     * Whether the item attribute is upgradable by the user.
+     */
+    upgradable?: boolean;
+    /**
+     * Whether the item attribute is downgradable by the user.
+     */
+    downgradable?: boolean;
+}

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

@@ -0,0 +1,133 @@
+"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.BaseFieldDto = void 0;
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+const class_validator_jsonschema_1 = require("class-validator-jsonschema");
+const multilang_text_dto_1 = require("./multilang-text.dto");
+/**
+ * Abstract base shared by every concrete field DTO (TextFieldDto, NumberFieldDto, ...).
+ *
+ * Concrete classes add a string-literal `type` discriminator and a typed `value` plus any
+ * type-specific options (min/max, regex validation for text, etc.).
+ */
+class BaseFieldDto {
+    constructor() {
+        /**
+         * Whether the item attribute is upgradable by the user.
+         */
+        this.upgradable = false;
+        /**
+         * Whether the item attribute is downgradable by the user.
+         */
+        this.downgradable = false;
+    }
+}
+exports.BaseFieldDto = BaseFieldDto;
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'ID',
+        description: 'Unique identifier for the field.',
+        type: 'string',
+    }),
+    __metadata("design:type", String)
+], BaseFieldDto.prototype, "id", void 0);
+__decorate([
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    (0, class_transformer_1.Type)(() => multilang_text_dto_1.MultilangTextDto),
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ArrayMinSize)(1),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Label',
+        description: 'Multilingual label for the field.',
+        type: 'array',
+        items: { $ref: '#/components/schemas/MultilangTextDto' },
+    }),
+    __metadata("design:type", Array)
+], BaseFieldDto.prototype, "label", void 0);
+__decorate([
+    (0, class_validator_1.IsBoolean)(),
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Required',
+        description: 'Whether the field is required.',
+        type: 'boolean',
+    }),
+    __metadata("design:type", Boolean)
+], BaseFieldDto.prototype, "required", void 0);
+__decorate([
+    (0, class_validator_1.IsBoolean)(),
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Disabled',
+        description: 'Whether the field is disabled.',
+        type: 'boolean',
+    }),
+    __metadata("design:type", Boolean)
+], BaseFieldDto.prototype, "disabled", void 0);
+__decorate([
+    (0, class_validator_1.IsBoolean)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Hidden',
+        description: 'Whether the field is hidden.',
+        type: 'boolean',
+    }),
+    __metadata("design:type", Boolean)
+], BaseFieldDto.prototype, "hidden", void 0);
+__decorate([
+    (0, class_validator_1.IsBoolean)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Triggers Remote Validation',
+        description: 'Whether remote validation should be triggered for this field.',
+        type: 'boolean',
+    }),
+    __metadata("design:type", Boolean)
+], BaseFieldDto.prototype, "triggersRemoteValidation", void 0);
+__decorate([
+    (0, class_validator_1.ValidateIf)((o) => !!o.triggersRemoteValidation),
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    (0, class_transformer_1.Type)(() => multilang_text_dto_1.MultilangTextDto),
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ArrayMinSize)(1),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Remote Validation Error Message',
+        description: 'Localized error message shown when remote validation fails.',
+        type: 'array',
+        items: { $ref: '#/components/schemas/MultilangTextDto' },
+    }),
+    __metadata("design:type", Array)
+], BaseFieldDto.prototype, "remoteValidationErrorMessage", void 0);
+__decorate([
+    (0, class_validator_1.IsBoolean)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Upgradable',
+        description: 'Whether the item attribute is upgradable by the user.',
+        type: 'boolean',
+    }),
+    __metadata("design:type", Boolean)
+], BaseFieldDto.prototype, "upgradable", void 0);
+__decorate([
+    (0, class_validator_1.IsBoolean)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Downgradable',
+        description: 'Whether the item attribute is downgradable by the user.',
+        type: 'boolean',
+    }),
+    __metadata("design:type", Boolean)
+], BaseFieldDto.prototype, "downgradable", void 0);

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

@@ -1,66 +1,7 @@
-import { FieldTypeEnum } from '../enums/field-type.enum';
-import { MultilangTextDto } from './multilang-text.dto';
-import { FieldOptionDto } from './field-option.dto';
+import { AnyFieldDto } from './fields/any-field.dto';
 /**
- * Data Transfer Object for a form field.
- * This class defines the structure and properties of a single field
- * that can be used in a user interface form.
+ * @deprecated Use a concrete field DTO (`TextFieldDto`, `NumberFieldDto`, ...)
+ * or the `AnyFieldDto` union directly. This alias is kept for one release while
+ * downstream consumers migrate (hoster-ai/api issue #449).
  */
-export declare class FieldDto {
-    /**
-     * ID of action field
-     */
-    id: string;
-    /**
-     * Label of action field
-     */
-    label: MultilangTextDto[];
-    /**
-     * 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 | FieldOptionDto | FieldOptionDto[];
-    /**
-     * Type of the field
-     */
-    type: FieldTypeEnum;
-    /**
-     * Indicates if the field is required
-     */
-    required?: boolean;
-    /**
-     * Indicates if the field is disabled
-     */
-    disabled?: boolean;
-    /**
-     * Indicates if the field is hidden
-     */
-    hidden?: boolean;
-    /**
-     * Regex validation pattern for the field
-     */
-    regexValidation?: string;
-    /**
-     * Error message for the field for supported languages
-     */
-    regexValidationErrorMessage?: MultilangTextDto[];
-    /**
-     * Whether remote validation should be triggered
-     */
-    triggersRemoteValidation?: boolean;
-    /**
-     * Remote validation error message 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;
-    downgradable?: boolean;
-}
+export type FieldDto = AnyFieldDto;