@hosterai/types 0.0.21 → 0.0.22

package/README.md

@@ -27,6 +27,24 @@ or
 yarn add @hosterai/types
 ```
 
+## Peer Dependencies
+
+This package relies on the following peer dependencies. Install them in your project:
+
+```bash
+npm install class-validator class-transformer class-validator-jsonschema reflect-metadata
+# If your project already uses Express, ensure a compatible version is installed
+npm install express
+```
+
+Note:
+
+- Import `reflect-metadata` once at the entry point of your application (e.g., `main.ts` or `index.ts`).
+
+```ts
+import 'reflect-metadata';
+```
+
 ## Core Concepts
 
 ### DTOs (Data Transfer Objects)
@@ -167,6 +185,15 @@ Transformer functions for converting plain objects to typed DTOs:
 - `transformMenu`: Converts plain objects to `MenuDtoWithUrl` or `MenuDtoWithSubmenu` based on the type property.
 - `transformSettings`: Converts plain objects to `SettingsWithUrlDto` or `SettingsWithTabsDto` based on the presence of url or tabs properties.
 
+## Generating JSON Schemas
+
+This package can generate JSON Schemas for all DTOs using the `class-validator-jsonschema` integration. The generated schemas are used in OpenAPI and other tooling.
+
+- Script: `npm run build:schemas`
+- Output: `openapi/schemas/components.schemas.ts`
+
+During packaging, schemas are built automatically via the `prepack` script. Run the command locally whenever you change DTOs or validators and want to refresh the schemas.
+
 ## Usage Example
 
 Here is an example of how to use a DTO and its validator.

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

@@ -28,8 +28,8 @@ export declare class FieldDto {
      * Type of the field
      */
     type: FieldTypeEnum;
-    reapetableMin?: number;
-    reapetableMax?: number;
+    repeatableMin?: number;
+    repeatableMax?: number;
     /**
      * Indicates if the field is required
      */
@@ -39,9 +39,13 @@ export declare class FieldDto {
      */
     disabled: boolean;
     /**
-     * Indicates if the field is hidden
+     * Indicates if the field is hidden in order
      */
-    hidden: boolean;
+    visibleInOrder: boolean;
+    /**
+     * Indicates if the field is visible in client panel
+     */
+    visibleInClientPanel: boolean;
     /**
      * Regex validation pattern for the field
      */

package/dist/dtos/field.dto.js

@@ -103,12 +103,12 @@ __decorate([
     (0, class_validator_1.IsOptional)(),
     (0, class_validator_1.IsNumber)(),
     __metadata("design:type", Number)
-], FieldDto.prototype, "reapetableMin", void 0);
+], FieldDto.prototype, "repeatableMin", void 0);
 __decorate([
     (0, class_validator_1.IsOptional)(),
     (0, class_validator_1.IsNumber)(),
     __metadata("design:type", Number)
-], FieldDto.prototype, "reapetableMax", void 0);
+], FieldDto.prototype, "repeatableMax", void 0);
 __decorate([
     (0, class_validator_1.IsBoolean)(),
     (0, class_validator_1.IsDefined)(),
@@ -133,12 +133,22 @@ __decorate([
     (0, class_validator_1.IsBoolean)(),
     (0, class_validator_1.IsDefined)(),
     (0, class_validator_jsonschema_1.JSONSchema)({
-        title: 'Hidden',
-        description: 'Whether the field is hidden.',
+        title: 'Visible In Order',
+        description: 'Whether the field is visible in order.',
         type: 'boolean',
     }),
     __metadata("design:type", Boolean)
-], FieldDto.prototype, "hidden", void 0);
+], FieldDto.prototype, "visibleInOrder", void 0);
+__decorate([
+    (0, class_validator_1.IsBoolean)(),
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Visible In Client Panel',
+        description: 'Whether the field is visible in client panel.',
+        type: 'boolean',
+    }),
+    __metadata("design:type", Boolean)
+], FieldDto.prototype, "visibleInClientPanel", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, is_regex_validator_1.IsRegex)(),
@@ -198,6 +208,6 @@ __decorate([
     __metadata("design:type", Boolean)
 ], FieldDto.prototype, "upgradable", void 0);
 exports.FieldDto = FieldDto = __decorate([
-    (0, all_or_none_validator_1.AllOrNoneProperty)(['reapetableMin', 'reapetableMax']),
-    (0, min_less_or_equal_validator_1.MinLessOrEqualMaxProperty)(['reapetableMin', 'reapetableMax'])
+    (0, all_or_none_validator_1.AllOrNoneProperty)(['repeatableMin', 'repeatableMax']),
+    (0, min_less_or_equal_validator_1.MinLessOrEqualMaxProperty)(['repeatableMin', 'repeatableMax'])
 ], FieldDto);

package/dist/dtos/notification/notification-info.dto.js

@@ -31,7 +31,7 @@ __decorate([
         description: 'Notification channel type.',
         type: 'string',
         enum: Object.values(notification_message_type_enum_1.NotificationMessageTypeEnum),
-        example: Object.values(notification_message_type_enum_1.NotificationMessageTypeEnum)[0]
+        example: Object.values(notification_message_type_enum_1.NotificationMessageTypeEnum)[0],
     }),
     __metadata("design:type", String)
 ], NotificationInfoDto.prototype, "type", void 0);
@@ -46,8 +46,12 @@ __decorate([
         type: 'array',
         items: { $ref: '#/components/schemas/UnitDto' },
         example: [
-            { id: 'messages', unitDescription: 'Message sent', intervalDescription: 'Per month' }
-        ]
+            {
+                id: 'messages',
+                unitDescription: 'Message sent',
+                intervalDescription: 'Per month',
+            },
+        ],
     }),
     __metadata("design:type", Array)
 ], NotificationInfoDto.prototype, "payPerUseUnits", void 0);

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

@@ -4,6 +4,7 @@ export declare enum ActionsEnum {
     UPGRADE = "upgrade",
     DOWNGRADE = "downgrade",
     TRANSFER = "transfer",
+    TRADE = "trade",
     SUSPEND = "suspend",
     UNSUSPEND = "unsuspend",
     DELETE = "delete"

package/dist/enums/actions.enum.js

@@ -8,6 +8,7 @@ var ActionsEnum;
     ActionsEnum["UPGRADE"] = "upgrade";
     ActionsEnum["DOWNGRADE"] = "downgrade";
     ActionsEnum["TRANSFER"] = "transfer";
+    ActionsEnum["TRADE"] = "trade";
     ActionsEnum["SUSPEND"] = "suspend";
     ActionsEnum["UNSUSPEND"] = "unsuspend";
     ActionsEnum["DELETE"] = "delete";

package/dist/openapi/schemas/components.schemas.d.ts

@@ -495,7 +495,7 @@ export declare const ComponentsSchemas: {
             };
             readonly supportedActions: {
                 readonly items: {
-                    readonly enum: readonly ["create", "renew", "upgrade", "downgrade", "transfer", "suspend", "unsuspend", "delete"];
+                    readonly enum: readonly ["create", "renew", "upgrade", "downgrade", "transfer", "trade", "suspend", "unsuspend", "delete"];
                     readonly type: "string";
                 };
                 readonly type: "array";
@@ -642,7 +642,7 @@ export declare const ComponentsSchemas: {
             };
             readonly supportedActions: {
                 readonly items: {
-                    readonly enum: readonly ["create", "renew", "upgrade", "downgrade", "transfer", "suspend", "unsuspend", "delete"];
+                    readonly enum: readonly ["create", "renew", "upgrade", "downgrade", "transfer", "trade", "suspend", "unsuspend", "delete"];
                     readonly type: "string";
                 };
                 readonly type: "array";
@@ -787,10 +787,10 @@ export declare const ComponentsSchemas: {
                 readonly title: "Field Type";
                 readonly description: "Type of the field.";
             };
-            readonly reapetableMin: {
+            readonly repeatableMin: {
                 readonly type: "number";
             };
-            readonly reapetableMax: {
+            readonly repeatableMax: {
                 readonly type: "number";
             };
             readonly required: {
@@ -809,13 +809,21 @@ export declare const ComponentsSchemas: {
                 readonly title: "Disabled";
                 readonly description: "Whether the field is disabled.";
             };
-            readonly hidden: {
+            readonly visibleInOrder: {
                 readonly not: {
                     readonly type: "null";
                 };
                 readonly type: "boolean";
-                readonly title: "Hidden";
-                readonly description: "Whether the field is hidden.";
+                readonly title: "Visible In Order";
+                readonly description: "Whether the field is visible in order.";
+            };
+            readonly visibleInClientPanel: {
+                readonly not: {
+                    readonly type: "null";
+                };
+                readonly type: "boolean";
+                readonly title: "Visible In Client Panel";
+                readonly description: "Whether the field is visible in client panel.";
             };
             readonly regexValidation: {
                 readonly type: "string";
@@ -854,7 +862,7 @@ export declare const ComponentsSchemas: {
             };
         };
         readonly type: "object";
-        readonly required: readonly ["id", "label", "value", "type", "required", "disabled", "hidden", "upgradable"];
+        readonly required: readonly ["id", "label", "value", "type", "required", "disabled", "visibleInOrder", "visibleInClientPanel", "upgradable"];
     };
     readonly ProductInfoDto: {
         readonly properties: {
@@ -938,7 +946,7 @@ export declare const ComponentsSchemas: {
             };
             readonly supportedActions: {
                 readonly items: {
-                    readonly enum: readonly ["create", "renew", "upgrade", "downgrade", "transfer", "suspend", "unsuspend", "delete"];
+                    readonly enum: readonly ["create", "renew", "upgrade", "downgrade", "transfer", "trade", "suspend", "unsuspend", "delete"];
                     readonly type: "string";
                 };
                 readonly type: "array";

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

@@ -747,6 +747,7 @@ exports.ComponentsSchemas = {
                         "upgrade",
                         "downgrade",
                         "transfer",
+                        "trade",
                         "suspend",
                         "unsuspend",
                         "delete"
@@ -1332,6 +1333,7 @@ exports.ComponentsSchemas = {
                         "upgrade",
                         "downgrade",
                         "transfer",
+                        "trade",
                         "suspend",
                         "unsuspend",
                         "delete"
@@ -1918,10 +1920,10 @@ exports.ComponentsSchemas = {
                 "title": "Field Type",
                 "description": "Type of the field."
             },
-            "reapetableMin": {
+            "repeatableMin": {
                 "type": "number"
             },
-            "reapetableMax": {
+            "repeatableMax": {
                 "type": "number"
             },
             "required": {
@@ -1940,13 +1942,21 @@ exports.ComponentsSchemas = {
                 "title": "Disabled",
                 "description": "Whether the field is disabled."
             },
-            "hidden": {
+            "visibleInOrder": {
                 "not": {
                     "type": "null"
                 },
                 "type": "boolean",
-                "title": "Hidden",
-                "description": "Whether the field is hidden."
+                "title": "Visible In Order",
+                "description": "Whether the field is visible in order."
+            },
+            "visibleInClientPanel": {
+                "not": {
+                    "type": "null"
+                },
+                "type": "boolean",
+                "title": "Visible In Client Panel",
+                "description": "Whether the field is visible in client panel."
             },
             "regexValidation": {
                 "type": "string",
@@ -1992,7 +2002,8 @@ exports.ComponentsSchemas = {
             "type",
             "required",
             "disabled",
-            "hidden",
+            "visibleInOrder",
+            "visibleInClientPanel",
             "upgradable"
         ]
     },
@@ -2273,6 +2284,7 @@ exports.ComponentsSchemas = {
                         "upgrade",
                         "downgrade",
                         "transfer",
+                        "trade",
                         "suspend",
                         "unsuspend",
                         "delete"

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

@@ -11,7 +11,8 @@ const baseValidDto = {
     type: field_type_enum_1.FieldTypeEnum.TEXT_BOX,
     required: true,
     disabled: false,
-    hidden: false,
+    visibleInOrder: false,
+    visibleInClientPanel: false,
     upgradable: false,
 };
 describe('FieldDto Validator', () => {
@@ -31,7 +32,7 @@ describe('FieldDto Validator', () => {
     describe('Missing required fields', () => {
         it('should return errors for all missing required fields (except upgradable)', () => {
             const errors = (0, field_validator_1.validateFieldDto)({});
-            const requiredProps = ['id', 'label', 'value', 'type', 'required', 'disabled', 'hidden'];
+            const requiredProps = ['id', 'label', 'value', 'type', 'required', 'disabled', 'visibleInOrder', 'visibleInClientPanel'];
             for (const prop of requiredProps) {
                 expect(errors.some(e => e.property === prop)).toBe(true);
             }
@@ -74,26 +75,26 @@ describe('FieldDto Validator', () => {
         });
     });
     describe('Repeatable constraints (AllOrNone and Min<=Max)', () => {
-        it('should fail when only reapetableMin is present', () => {
-            const dto = { ...baseValidDto, reapetableMin: 1 };
+        it('should fail when only repeatableMin is present', () => {
+            const dto = { ...baseValidDto, repeatableMin: 1 };
             const errors = (0, field_validator_1.validateFieldDto)(dto);
             expect(errors.length).toBeGreaterThan(0);
             // Class-level error; ensure at least one constraint exists
             expect(errors.some(e => e.constraints && (e.constraints['AllOrNone'] || Object.values(e.constraints).some(msg => msg.includes('All of'))))).toBe(true);
         });
-        it('should fail when only reapetableMax is present', () => {
-            const dto = { ...baseValidDto, reapetableMax: 2 };
+        it('should fail when only repeatableMax is present', () => {
+            const dto = { ...baseValidDto, repeatableMax: 2 };
             const errors = (0, field_validator_1.validateFieldDto)(dto);
             expect(errors.length).toBeGreaterThan(0);
             expect(errors.some(e => e.constraints && (e.constraints['AllOrNone'] || Object.values(e.constraints).some(msg => msg.includes('All of'))))).toBe(true);
         });
-        it('should pass when both present and reapetableMin <= reapetableMax', () => {
-            const dto = { ...baseValidDto, reapetableMin: 1, reapetableMax: 2 };
+        it('should pass when both present and repeatableMin <= repeatableMax', () => {
+            const dto = { ...baseValidDto, repeatableMin: 1, repeatableMax: 2 };
             const errors = (0, field_validator_1.validateFieldDto)(dto);
             expect(errors).toHaveLength(0);
         });
-        it('should fail when both present and reapetableMin > reapetableMax', () => {
-            const dto = { ...baseValidDto, reapetableMin: 3, reapetableMax: 2 };
+        it('should fail when both present and repeatableMin > repeatableMax', () => {
+            const dto = { ...baseValidDto, repeatableMin: 3, repeatableMax: 2 };
             const errors = (0, field_validator_1.validateFieldDto)(dto);
             expect(errors.length).toBeGreaterThan(0);
             expect(errors.some(e => e.constraints && (e.constraints['MinLessOrEqualMax'] || Object.values(e.constraints).some(msg => msg.includes('must be less than or equal'))))).toBe(true);

package/dist/validators/product-info-validator.spec.js

@@ -14,7 +14,8 @@ describe('ProductInfoDto Validator', () => {
         type: field_type_enum_1.FieldTypeEnum.TEXT_BOX,
         required: false,
         disabled: false,
-        hidden: false,
+        visibleInOrder: false,
+        visibleInClientPanel: true,
         upgradable: false
     };
     const invalidField = {
@@ -170,7 +171,7 @@ describe('ProductInfoDto Validator', () => {
         });
     });
     describe('FieldDto class-level constraints inside ProductInfoDto', () => {
-        it('fails when a FieldDto has only reapetableMin (AllOrNone)', () => {
+        it('fails when a FieldDto has only repeatableMin (AllOrNone)', () => {
             const fieldWithOnlyMin = {
                 id: 'f1',
                 label: [{ language: language_enum_1.LanguageEnum.EN, text: 'label' }],
@@ -178,9 +179,10 @@ describe('ProductInfoDto Validator', () => {
                 type: field_type_enum_1.FieldTypeEnum.TEXT_BOX,
                 required: false,
                 disabled: false,
-                hidden: false,
+                visibleInOrder: false,
+                visibleInClientPanel: true,
                 upgradable: false,
-                reapetableMin: 1,
+                repeatableMin: 1,
             };
             const dto = {
                 title: 'Test',
@@ -191,7 +193,7 @@ describe('ProductInfoDto Validator', () => {
             const errors = (0, product_info_validator_1.validateProductInfoDto)(dto);
             expect(errors.length).toBeGreaterThan(0);
         });
-        it('fails when a FieldDto has only reapetableMax (AllOrNone)', () => {
+        it('fails when a FieldDto has only repeatableMax (AllOrNone)', () => {
             const fieldWithOnlyMax = {
                 id: 'f2',
                 label: [{ language: language_enum_1.LanguageEnum.EN, text: 'label' }],
@@ -199,9 +201,10 @@ describe('ProductInfoDto Validator', () => {
                 type: field_type_enum_1.FieldTypeEnum.TEXT_BOX,
                 required: false,
                 disabled: false,
-                hidden: false,
+                visibleInOrder: false,
+                visibleInClientPanel: true,
                 upgradable: false,
-                reapetableMax: 2,
+                repeatableMax: 2,
             };
             const dto = {
                 title: 'Test',
@@ -220,10 +223,11 @@ describe('ProductInfoDto Validator', () => {
                 type: field_type_enum_1.FieldTypeEnum.TEXT_BOX,
                 required: false,
                 disabled: false,
-                hidden: false,
+                visibleInOrder: false,
+                visibleInClientPanel: true,
                 upgradable: false,
-                reapetableMin: 1,
-                reapetableMax: 2,
+                repeatableMin: 1,
+                repeatableMax: 2,
             };
             const dto = {
                 title: 'Test',
@@ -241,10 +245,11 @@ describe('ProductInfoDto Validator', () => {
                 type: field_type_enum_1.FieldTypeEnum.TEXT_BOX,
                 required: false,
                 disabled: false,
-                hidden: false,
+                visibleInOrder: false,
+                visibleInClientPanel: true,
                 upgradable: false,
-                reapetableMin: 5,
-                reapetableMax: 2,
+                repeatableMin: 5,
+                repeatableMax: 2,
             };
             const dto = {
                 title: 'Test',

package/package.json

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