@hosterai/types 0.0.21 → 0.0.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/README.md +29 -2
  2. package/dist/dtos/field.dto.d.ts +8 -4
  3. package/dist/dtos/field.dto.js +17 -7
  4. package/dist/dtos/info/info-notification.dto.d.ts +5 -0
  5. package/dist/dtos/info/info-notification.dto.js +7 -0
  6. package/dist/dtos/info/info.dto.d.ts +196 -0
  7. package/dist/dtos/info/info.dto.js +278 -0
  8. package/dist/dtos/info.dto.d.ts +2 -0
  9. package/dist/dtos/info.dto.js +17 -0
  10. package/dist/dtos/notification/notification-info.dto.js +7 -3
  11. package/dist/dtos/notification/notification-request.dto.d.ts +20 -0
  12. package/dist/dtos/notification/notification-request.dto.js +31 -0
  13. package/dist/dtos/product/product.interface.d.ts +4 -4
  14. package/dist/dtos/receiver/receiver-email.dto.d.ts +20 -0
  15. package/dist/dtos/receiver/receiver-email.dto.js +39 -0
  16. package/dist/dtos/receiver/receiver-push.dto.d.ts +15 -0
  17. package/dist/dtos/receiver/receiver-push.dto.js +31 -0
  18. package/dist/dtos/receiver/receiver-sms.dto.d.ts +11 -0
  19. package/dist/dtos/receiver/receiver-sms.dto.js +26 -0
  20. package/dist/dtos/request.dto.d.ts +20 -0
  21. package/dist/dtos/request.dto.js +31 -0
  22. package/dist/dtos/requests/validate-attributes-request.dto.d.ts +18 -0
  23. package/dist/dtos/{product/requests/product-upgradeable-request.dto.js → requests/validate-attributes-request.dto.js} +11 -17
  24. package/dist/dtos/responses/validate-attributes-response.dto.d.ts +13 -0
  25. package/dist/dtos/responses/validate-attributes-response.dto.js +11 -0
  26. package/dist/dtos/sender/sender-email.dto.d.ts +25 -0
  27. package/dist/dtos/sender/sender-email.dto.js +46 -0
  28. package/dist/dtos/sender/sender-push.dto.d.ts +31 -0
  29. package/dist/dtos/sender/sender-push.dto.js +50 -0
  30. package/dist/dtos/sender/sender-sms.dto.d.ts +15 -0
  31. package/dist/dtos/sender/sender-sms.dto.js +30 -0
  32. package/dist/enums/actions.enum.d.ts +1 -0
  33. package/dist/enums/actions.enum.js +1 -0
  34. package/dist/enums/message-type.enum.d.ts +5 -0
  35. package/dist/enums/message-type.enum.js +9 -0
  36. package/dist/index.d.ts +2 -4
  37. package/dist/index.js +4 -4
  38. package/dist/openapi/schemas/components.schemas.d.ts +166 -221
  39. package/dist/openapi/schemas/components.schemas.js +549 -600
  40. package/dist/validators/field-validator.spec.js +11 -10
  41. package/dist/validators/product-info-validator.spec.js +18 -13
  42. package/dist/validators/product-validate-attributes-request-validator.d.ts +1 -1
  43. package/dist/validators/product-validate-attributes-request-validator.js +5 -5
  44. package/dist/validators/product-validate-attributes-request-validator.spec.js +3 -3
  45. package/package.json +1 -1
  46. package/dist/dtos/product/requests/product-downgradeable-request.dto.d.ts +0 -18
  47. package/dist/dtos/product/requests/product-downgradeable-request.dto.js +0 -37
  48. package/dist/dtos/product/requests/product-upgradeable-request.dto.d.ts +0 -18
  49. package/dist/dtos/product/responses/product-downgradeable-response.dto.d.ts +0 -22
  50. package/dist/dtos/product/responses/product-downgradeable-response.dto.js +0 -11
  51. package/dist/dtos/product/responses/product-upgradeable-response.dto.d.ts +0 -22
  52. package/dist/dtos/product/responses/product-upgradeable-response.dto.js +0 -11
  53. package/dist/validators/product-downgradeable-request-validator.d.ts +0 -8
  54. package/dist/validators/product-downgradeable-request-validator.js +0 -17
  55. package/dist/validators/product-upgradeable-request-validator.d.ts +0 -8
  56. package/dist/validators/product-upgradeable-request-validator.js +0 -17
package/README.md CHANGED
@@ -27,6 +27,24 @@ or
27
27
  yarn add @hosterai/types
28
28
  ```
29
29
 
30
+ ## Peer Dependencies
31
+
32
+ This package relies on the following peer dependencies. Install them in your project:
33
+
34
+ ```bash
35
+ npm install class-validator class-transformer class-validator-jsonschema reflect-metadata
36
+ # If your project already uses Express, ensure a compatible version is installed
37
+ npm install express
38
+ ```
39
+
40
+ Note:
41
+
42
+ - Import `reflect-metadata` once at the entry point of your application (e.g., `main.ts` or `index.ts`).
43
+
44
+ ```ts
45
+ import 'reflect-metadata';
46
+ ```
47
+
30
48
  ## Core Concepts
31
49
 
32
50
  ### DTOs (Data Transfer Objects)
@@ -114,6 +132,7 @@ This package includes validation functions that leverage `class-validator` to en
114
132
  - `validateJwtDto`: Validates JWT data.
115
133
  - `validateMultilangTextDto`: Validates multilingual text objects.
116
134
  - `validateUnitDto`: Validates billing unit data.
135
+ - `validateAttributesDto`: Validates attributes.
117
136
 
118
137
  **Panel Validators:**
119
138
  - `validateAdminPanelDto`: Validates admin panel configuration.
@@ -143,8 +162,7 @@ This package includes validation functions that leverage `class-validator` to en
143
162
  - `validateProductSuspendRequestDto`: Validates product suspension requests.
144
163
  - `validateProductUnsuspendRequestDto`: Validates product unsuspension requests.
145
164
  - `validateProductUpgradableRequestDto`: Validates product upgradability checks.
146
- - `validateProductDowngradableRequestDto`: Validates product downgradability checks.
147
- - `validateProductValidateAttributesRequestDto`: Validates requests for product attribute validation.
165
+
148
166
 
149
167
  ### Custom Decorators
150
168
 
@@ -167,6 +185,15 @@ Transformer functions for converting plain objects to typed DTOs:
167
185
  - `transformMenu`: Converts plain objects to `MenuDtoWithUrl` or `MenuDtoWithSubmenu` based on the type property.
168
186
  - `transformSettings`: Converts plain objects to `SettingsWithUrlDto` or `SettingsWithTabsDto` based on the presence of url or tabs properties.
169
187
 
188
+ ## Generating JSON Schemas
189
+
190
+ 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.
191
+
192
+ - Script: `npm run build:schemas`
193
+ - Output: `openapi/schemas/components.schemas.ts`
194
+
195
+ 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.
196
+
170
197
  ## Usage Example
171
198
 
172
199
  Here is an example of how to use a DTO and its validator.
@@ -28,8 +28,8 @@ export declare class FieldDto {
28
28
  * Type of the field
29
29
  */
30
30
  type: FieldTypeEnum;
31
- reapetableMin?: number;
32
- reapetableMax?: number;
31
+ repeatableMin?: number;
32
+ repeatableMax?: number;
33
33
  /**
34
34
  * Indicates if the field is required
35
35
  */
@@ -39,9 +39,13 @@ export declare class FieldDto {
39
39
  */
40
40
  disabled: boolean;
41
41
  /**
42
- * Indicates if the field is hidden
42
+ * Indicates if the field is hidden in order
43
43
  */
44
- hidden: boolean;
44
+ visibleInOrder: boolean;
45
+ /**
46
+ * Indicates if the field is visible in client panel
47
+ */
48
+ visibleInClientPanel: boolean;
45
49
  /**
46
50
  * Regex validation pattern for the field
47
51
  */
@@ -103,12 +103,12 @@ __decorate([
103
103
  (0, class_validator_1.IsOptional)(),
104
104
  (0, class_validator_1.IsNumber)(),
105
105
  __metadata("design:type", Number)
106
- ], FieldDto.prototype, "reapetableMin", void 0);
106
+ ], FieldDto.prototype, "repeatableMin", void 0);
107
107
  __decorate([
108
108
  (0, class_validator_1.IsOptional)(),
109
109
  (0, class_validator_1.IsNumber)(),
110
110
  __metadata("design:type", Number)
111
- ], FieldDto.prototype, "reapetableMax", void 0);
111
+ ], FieldDto.prototype, "repeatableMax", void 0);
112
112
  __decorate([
113
113
  (0, class_validator_1.IsBoolean)(),
114
114
  (0, class_validator_1.IsDefined)(),
@@ -133,12 +133,22 @@ __decorate([
133
133
  (0, class_validator_1.IsBoolean)(),
134
134
  (0, class_validator_1.IsDefined)(),
135
135
  (0, class_validator_jsonschema_1.JSONSchema)({
136
- title: 'Hidden',
137
- description: 'Whether the field is hidden.',
136
+ title: 'Visible In Order',
137
+ description: 'Whether the field is visible in order.',
138
138
  type: 'boolean',
139
139
  }),
140
140
  __metadata("design:type", Boolean)
141
- ], FieldDto.prototype, "hidden", void 0);
141
+ ], FieldDto.prototype, "visibleInOrder", void 0);
142
+ __decorate([
143
+ (0, class_validator_1.IsBoolean)(),
144
+ (0, class_validator_1.IsDefined)(),
145
+ (0, class_validator_jsonschema_1.JSONSchema)({
146
+ title: 'Visible In Client Panel',
147
+ description: 'Whether the field is visible in client panel.',
148
+ type: 'boolean',
149
+ }),
150
+ __metadata("design:type", Boolean)
151
+ ], FieldDto.prototype, "visibleInClientPanel", void 0);
142
152
  __decorate([
143
153
  (0, class_validator_1.IsString)(),
144
154
  (0, is_regex_validator_1.IsRegex)(),
@@ -198,6 +208,6 @@ __decorate([
198
208
  __metadata("design:type", Boolean)
199
209
  ], FieldDto.prototype, "upgradable", void 0);
200
210
  exports.FieldDto = FieldDto = __decorate([
201
- (0, all_or_none_validator_1.AllOrNoneProperty)(['reapetableMin', 'reapetableMax']),
202
- (0, min_less_or_equal_validator_1.MinLessOrEqualMaxProperty)(['reapetableMin', 'reapetableMax'])
211
+ (0, all_or_none_validator_1.AllOrNoneProperty)(['repeatableMin', 'repeatableMax']),
212
+ (0, min_less_or_equal_validator_1.MinLessOrEqualMaxProperty)(['repeatableMin', 'repeatableMax'])
203
213
  ], FieldDto);
@@ -0,0 +1,5 @@
1
+ import { MessageTypeEnum } from "../../enums/message-type.enum";
2
+ import { InfoDto } from "./info.dto";
3
+ export declare class InfoNotificationDto extends InfoDto {
4
+ type: MessageTypeEnum;
5
+ }
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.InfoNotificationDto = void 0;
4
+ const info_dto_1 = require("./info.dto");
5
+ class InfoNotificationDto extends info_dto_1.InfoDto {
6
+ }
7
+ exports.InfoNotificationDto = InfoNotificationDto;
@@ -0,0 +1,196 @@
1
+ import { ActionsEnum } from '../../enums/actions.enum';
2
+ import { EventsEnum } from '../../enums/events.enum';
3
+ import { FieldDto } from '../field.dto';
4
+ import { ResponseDataDto } from '../response-data.dto';
5
+ import { UnitDto } from '../unit.dto';
6
+ import { LanguageEnum } from '../../enums/language.enum';
7
+ import { RolesEnum } from '../../enums/roles.enum';
8
+ import { ActionDto } from '../action.dto';
9
+ /**
10
+ * DTO for integration information
11
+ * Contains all information related to a service integration
12
+ */
13
+ export declare class InfoDto {
14
+ /**
15
+ * The title of the integration
16
+ */
17
+ title: string;
18
+ /**
19
+ * The logo of the integration (optional)
20
+ */
21
+ logo?: string;
22
+ /**
23
+ * Description of the integration and its services (optional)
24
+ */
25
+ description?: string;
26
+ /**
27
+ * List of supported languages for the integration.
28
+ */
29
+ supported_languages: LanguageEnum[];
30
+ /**
31
+ * Custom attributes for products.
32
+ */
33
+ product_attributes?: FieldDto[];
34
+ /**
35
+ * Custom attributes for items.
36
+ */
37
+ item_attributes?: FieldDto[];
38
+ /**
39
+ * Events that the integration listens to.
40
+ */
41
+ listen_events?: EventsEnum[];
42
+ /**
43
+ * The roles that need to be accepted by the company
44
+ */
45
+ requiredRoles?: RolesEnum[];
46
+ /**
47
+ * Actions that are not supported by the integration.
48
+ */
49
+ unsupportedActions?: ActionsEnum[];
50
+ /**
51
+ * Configuration for the admin panel.
52
+ */
53
+ adminPanel?: AdminPanelDto;
54
+ /**
55
+ * Configuration for the client panel.
56
+ */
57
+ clientPanel?: ClientPanelDto;
58
+ /**
59
+ * The url for the onboarding process after installation of the integration
60
+ */
61
+ onboardingUrl?: string;
62
+ /**
63
+ * Units for pay-per-use billing.
64
+ */
65
+ payPerUseUnits?: UnitDto[];
66
+ /**
67
+ * Mapping of response data field names.
68
+ */
69
+ responseDataFieldNames?: Record<keyof ResponseDataDto, string>;
70
+ }
71
+ /**
72
+ * DTO for tabs
73
+ * Used for defining tabs in the user interface
74
+ */
75
+ declare class TabDto {
76
+ /**
77
+ * The label displayed on the tab
78
+ */
79
+ label: string;
80
+ /**
81
+ * The URL associated with the tab.
82
+ * The requests coming from the hoster will be signed
83
+ * with jwt, which will contain information about the company
84
+ */
85
+ url: string;
86
+ }
87
+ /**
88
+ * DTO for menu items
89
+ * Extends TabDto and adds icon information
90
+ */
91
+ declare class MenuDto {
92
+ /**
93
+ * The icon to be displayed for the menu item
94
+ */
95
+ icon: string;
96
+ /**
97
+ * The name to be displayed for the menu item
98
+ */
99
+ label: string;
100
+ /**
101
+ * The list of tabs that will appear in the submenu and as a navigation bar above the main content
102
+ * In case of only one tab, there will be neither a submenu nor a navigation bar.
103
+ */
104
+ tabs: TabDto[];
105
+ }
106
+ /**
107
+ * DTO for the tabs in the admin panel.
108
+ */
109
+ declare class AdminPanelTabsDto {
110
+ /**
111
+ * Tabs related to products.
112
+ */
113
+ product: TabDto[];
114
+ /**
115
+ * Tabs related to items.
116
+ */
117
+ item: TabDto[];
118
+ /**
119
+ * Tabs related to clients.
120
+ */
121
+ client: TabDto[];
122
+ /**
123
+ * Tabs related to orders.
124
+ */
125
+ order: TabDto[];
126
+ }
127
+ /**
128
+ * DTO for actions available in a panel.
129
+ */
130
+ declare class PanelActionsDto {
131
+ /**
132
+ * Actions related to clients.
133
+ */
134
+ client?: ActionDto[];
135
+ /**
136
+ * Actions related to items.
137
+ */
138
+ item?: ActionDto[];
139
+ }
140
+ /**
141
+ * DTO for the admin panel configuration.
142
+ */
143
+ declare class AdminPanelDto {
144
+ /**
145
+ * Configuration for the tabs in the admin panel.
146
+ */
147
+ tabs?: AdminPanelTabsDto;
148
+ /**
149
+ * Additional actions available in the admin panel.
150
+ */
151
+ moreActions?: PanelActionsDto;
152
+ /**
153
+ * Main menu for the admin panel.
154
+ */
155
+ menu?: MenuDto;
156
+ /**
157
+ * Settings menu for the admin panel.
158
+ */
159
+ settings?: MenuDto;
160
+ }
161
+ /**
162
+ * DTO for the tabs in the client panel.
163
+ */
164
+ declare class ClientPanelTabsDto {
165
+ /**
166
+ * Tabs related to items.
167
+ */
168
+ item: TabDto[];
169
+ }
170
+ /**
171
+ * DTO for actions available in the client panel.
172
+ */
173
+ declare class ClientPanelActionsDto {
174
+ /**
175
+ * Actions related to items.
176
+ */
177
+ item?: ActionDto[];
178
+ }
179
+ /**
180
+ * DTO for the client panel configuration.
181
+ */
182
+ declare class ClientPanelDto {
183
+ /**
184
+ * Configuration for the tabs in the client panel.
185
+ */
186
+ tabs?: ClientPanelTabsDto;
187
+ /**
188
+ * Additional actions available in the client panel.
189
+ */
190
+ moreActions?: ClientPanelActionsDto;
191
+ /**
192
+ * Main menu for the client panel.
193
+ */
194
+ menu?: MenuDto;
195
+ }
196
+ export {};
@@ -0,0 +1,278 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ 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;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.InfoDto = void 0;
13
+ const class_validator_1 = require("class-validator");
14
+ const class_transformer_1 = require("class-transformer");
15
+ const actions_enum_1 = require("../../enums/actions.enum");
16
+ const events_enum_1 = require("../../enums/events.enum");
17
+ const field_dto_1 = require("../field.dto");
18
+ const unit_dto_1 = require("../unit.dto");
19
+ const language_enum_1 = require("../../enums/language.enum");
20
+ const roles_enum_1 = require("../../enums/roles.enum");
21
+ const action_dto_1 = require("../action.dto");
22
+ /**
23
+ * DTO for integration information
24
+ * Contains all information related to a service integration
25
+ */
26
+ class InfoDto {
27
+ constructor() {
28
+ /**
29
+ * Actions that are not supported by the integration.
30
+ */
31
+ this.unsupportedActions = [];
32
+ }
33
+ }
34
+ exports.InfoDto = InfoDto;
35
+ __decorate([
36
+ (0, class_validator_1.IsString)(),
37
+ (0, class_validator_1.IsNotEmpty)(),
38
+ __metadata("design:type", String)
39
+ ], InfoDto.prototype, "title", void 0);
40
+ __decorate([
41
+ (0, class_validator_1.IsString)(),
42
+ (0, class_validator_1.IsOptional)(),
43
+ __metadata("design:type", String)
44
+ ], InfoDto.prototype, "logo", void 0);
45
+ __decorate([
46
+ (0, class_validator_1.IsString)(),
47
+ (0, class_validator_1.IsOptional)(),
48
+ __metadata("design:type", String)
49
+ ], InfoDto.prototype, "description", void 0);
50
+ __decorate([
51
+ (0, class_validator_1.IsArray)(),
52
+ (0, class_validator_1.IsEnum)(language_enum_1.LanguageEnum, { each: true }),
53
+ __metadata("design:type", Array)
54
+ ], InfoDto.prototype, "supported_languages", void 0);
55
+ __decorate([
56
+ (0, class_validator_1.IsArray)(),
57
+ (0, class_validator_1.ValidateNested)({ each: true }),
58
+ (0, class_transformer_1.Type)(() => field_dto_1.FieldDto),
59
+ (0, class_validator_1.IsOptional)(),
60
+ __metadata("design:type", Array)
61
+ ], InfoDto.prototype, "product_attributes", void 0);
62
+ __decorate([
63
+ (0, class_validator_1.IsArray)(),
64
+ (0, class_validator_1.ValidateNested)({ each: true }),
65
+ (0, class_transformer_1.Type)(() => field_dto_1.FieldDto),
66
+ (0, class_validator_1.IsOptional)(),
67
+ __metadata("design:type", Array)
68
+ ], InfoDto.prototype, "item_attributes", void 0);
69
+ __decorate([
70
+ (0, class_validator_1.IsArray)(),
71
+ (0, class_validator_1.IsEnum)(events_enum_1.EventsEnum, { each: true }),
72
+ (0, class_validator_1.IsOptional)(),
73
+ __metadata("design:type", Array)
74
+ ], InfoDto.prototype, "listen_events", void 0);
75
+ __decorate([
76
+ (0, class_validator_1.IsArray)(),
77
+ (0, class_validator_1.IsEnum)(roles_enum_1.RolesEnum, { each: true }),
78
+ (0, class_validator_1.IsOptional)(),
79
+ __metadata("design:type", Array)
80
+ ], InfoDto.prototype, "requiredRoles", void 0);
81
+ __decorate([
82
+ (0, class_validator_1.IsArray)(),
83
+ (0, class_validator_1.IsEnum)(actions_enum_1.ActionsEnum, { each: true }),
84
+ (0, class_validator_1.IsOptional)(),
85
+ __metadata("design:type", Array)
86
+ ], InfoDto.prototype, "unsupportedActions", void 0);
87
+ __decorate([
88
+ (0, class_validator_1.IsOptional)(),
89
+ (0, class_validator_1.ValidateNested)(),
90
+ (0, class_transformer_1.Type)(() => AdminPanelDto),
91
+ __metadata("design:type", AdminPanelDto)
92
+ ], InfoDto.prototype, "adminPanel", void 0);
93
+ __decorate([
94
+ (0, class_validator_1.IsOptional)(),
95
+ (0, class_validator_1.ValidateNested)(),
96
+ (0, class_transformer_1.Type)(() => ClientPanelDto),
97
+ __metadata("design:type", ClientPanelDto)
98
+ ], InfoDto.prototype, "clientPanel", void 0);
99
+ __decorate([
100
+ (0, class_validator_1.IsOptional)(),
101
+ (0, class_validator_1.IsUrl)(),
102
+ __metadata("design:type", String)
103
+ ], InfoDto.prototype, "onboardingUrl", void 0);
104
+ __decorate([
105
+ (0, class_validator_1.IsArray)(),
106
+ (0, class_validator_1.ValidateNested)({ each: true }),
107
+ (0, class_transformer_1.Type)(() => unit_dto_1.UnitDto),
108
+ (0, class_validator_1.IsOptional)(),
109
+ __metadata("design:type", Array)
110
+ ], InfoDto.prototype, "payPerUseUnits", void 0);
111
+ __decorate([
112
+ (0, class_validator_1.IsObject)(),
113
+ (0, class_validator_1.IsOptional)(),
114
+ __metadata("design:type", Object)
115
+ ], InfoDto.prototype, "responseDataFieldNames", void 0);
116
+ /**
117
+ * DTO for tabs
118
+ * Used for defining tabs in the user interface
119
+ */
120
+ class TabDto {
121
+ }
122
+ __decorate([
123
+ (0, class_validator_1.IsString)(),
124
+ (0, class_validator_1.IsNotEmpty)(),
125
+ __metadata("design:type", String)
126
+ ], TabDto.prototype, "label", void 0);
127
+ __decorate([
128
+ (0, class_validator_1.IsString)(),
129
+ (0, class_validator_1.IsNotEmpty)(),
130
+ (0, class_validator_1.IsUrl)(),
131
+ __metadata("design:type", String)
132
+ ], TabDto.prototype, "url", void 0);
133
+ /**
134
+ * DTO for menu items
135
+ * Extends TabDto and adds icon information
136
+ */
137
+ class MenuDto {
138
+ }
139
+ __decorate([
140
+ (0, class_validator_1.IsString)(),
141
+ (0, class_validator_1.IsNotEmpty)(),
142
+ __metadata("design:type", String)
143
+ ], MenuDto.prototype, "icon", void 0);
144
+ __decorate([
145
+ (0, class_validator_1.IsString)(),
146
+ (0, class_validator_1.IsNotEmpty)(),
147
+ __metadata("design:type", String)
148
+ ], MenuDto.prototype, "label", void 0);
149
+ __decorate([
150
+ (0, class_validator_1.IsArray)(),
151
+ (0, class_validator_1.MinLength)(1),
152
+ (0, class_validator_1.ValidateNested)({ each: true }),
153
+ (0, class_transformer_1.Type)(() => TabDto),
154
+ __metadata("design:type", Array)
155
+ ], MenuDto.prototype, "tabs", void 0);
156
+ /**
157
+ * DTO for the tabs in the admin panel.
158
+ */
159
+ class AdminPanelTabsDto {
160
+ }
161
+ __decorate([
162
+ (0, class_validator_1.IsArray)(),
163
+ (0, class_validator_1.ValidateNested)({ each: true }),
164
+ (0, class_transformer_1.Type)(() => TabDto),
165
+ __metadata("design:type", Array)
166
+ ], AdminPanelTabsDto.prototype, "product", void 0);
167
+ __decorate([
168
+ (0, class_validator_1.IsArray)(),
169
+ (0, class_validator_1.ValidateNested)({ each: true }),
170
+ (0, class_transformer_1.Type)(() => TabDto),
171
+ __metadata("design:type", Array)
172
+ ], AdminPanelTabsDto.prototype, "item", void 0);
173
+ __decorate([
174
+ (0, class_validator_1.IsArray)(),
175
+ (0, class_validator_1.ValidateNested)({ each: true }),
176
+ (0, class_transformer_1.Type)(() => TabDto),
177
+ __metadata("design:type", Array)
178
+ ], AdminPanelTabsDto.prototype, "client", void 0);
179
+ __decorate([
180
+ (0, class_validator_1.IsArray)(),
181
+ (0, class_validator_1.ValidateNested)({ each: true }),
182
+ (0, class_transformer_1.Type)(() => TabDto),
183
+ __metadata("design:type", Array)
184
+ ], AdminPanelTabsDto.prototype, "order", void 0);
185
+ /**
186
+ * DTO for actions available in a panel.
187
+ */
188
+ class PanelActionsDto {
189
+ }
190
+ __decorate([
191
+ (0, class_validator_1.IsArray)(),
192
+ (0, class_validator_1.ValidateNested)({ each: true }),
193
+ (0, class_transformer_1.Type)(() => action_dto_1.ActionDto),
194
+ (0, class_validator_1.IsOptional)(),
195
+ __metadata("design:type", Array)
196
+ ], PanelActionsDto.prototype, "client", void 0);
197
+ __decorate([
198
+ (0, class_validator_1.IsArray)(),
199
+ (0, class_validator_1.ValidateNested)({ each: true }),
200
+ (0, class_transformer_1.Type)(() => action_dto_1.ActionDto),
201
+ (0, class_validator_1.IsOptional)(),
202
+ __metadata("design:type", Array)
203
+ ], PanelActionsDto.prototype, "item", void 0);
204
+ /**
205
+ * DTO for the admin panel configuration.
206
+ */
207
+ class AdminPanelDto {
208
+ }
209
+ __decorate([
210
+ (0, class_validator_1.IsOptional)(),
211
+ (0, class_validator_1.ValidateNested)(),
212
+ (0, class_transformer_1.Type)(() => AdminPanelTabsDto),
213
+ __metadata("design:type", AdminPanelTabsDto)
214
+ ], AdminPanelDto.prototype, "tabs", void 0);
215
+ __decorate([
216
+ (0, class_validator_1.IsOptional)(),
217
+ (0, class_validator_1.ValidateNested)(),
218
+ (0, class_transformer_1.Type)(() => PanelActionsDto),
219
+ __metadata("design:type", PanelActionsDto)
220
+ ], AdminPanelDto.prototype, "moreActions", void 0);
221
+ __decorate([
222
+ (0, class_validator_1.IsOptional)(),
223
+ (0, class_validator_1.ValidateNested)(),
224
+ (0, class_transformer_1.Type)(() => MenuDto),
225
+ __metadata("design:type", MenuDto)
226
+ ], AdminPanelDto.prototype, "menu", void 0);
227
+ __decorate([
228
+ (0, class_validator_1.IsOptional)(),
229
+ (0, class_validator_1.ValidateNested)(),
230
+ (0, class_transformer_1.Type)(() => MenuDto),
231
+ __metadata("design:type", MenuDto)
232
+ ], AdminPanelDto.prototype, "settings", void 0);
233
+ /**
234
+ * DTO for the tabs in the client panel.
235
+ */
236
+ class ClientPanelTabsDto {
237
+ }
238
+ __decorate([
239
+ (0, class_validator_1.IsArray)(),
240
+ (0, class_validator_1.ValidateNested)({ each: true }),
241
+ (0, class_transformer_1.Type)(() => TabDto),
242
+ __metadata("design:type", Array)
243
+ ], ClientPanelTabsDto.prototype, "item", void 0);
244
+ /**
245
+ * DTO for actions available in the client panel.
246
+ */
247
+ class ClientPanelActionsDto {
248
+ }
249
+ __decorate([
250
+ (0, class_validator_1.IsArray)(),
251
+ (0, class_validator_1.ValidateNested)({ each: true }),
252
+ (0, class_transformer_1.Type)(() => action_dto_1.ActionDto),
253
+ (0, class_validator_1.IsOptional)(),
254
+ __metadata("design:type", Array)
255
+ ], ClientPanelActionsDto.prototype, "item", void 0);
256
+ /**
257
+ * DTO for the client panel configuration.
258
+ */
259
+ class ClientPanelDto {
260
+ }
261
+ __decorate([
262
+ (0, class_validator_1.IsOptional)(),
263
+ (0, class_validator_1.ValidateNested)(),
264
+ (0, class_transformer_1.Type)(() => ClientPanelTabsDto),
265
+ __metadata("design:type", ClientPanelTabsDto)
266
+ ], ClientPanelDto.prototype, "tabs", void 0);
267
+ __decorate([
268
+ (0, class_validator_1.IsOptional)(),
269
+ (0, class_validator_1.ValidateNested)(),
270
+ (0, class_transformer_1.Type)(() => ClientPanelActionsDto),
271
+ __metadata("design:type", ClientPanelActionsDto)
272
+ ], ClientPanelDto.prototype, "moreActions", void 0);
273
+ __decorate([
274
+ (0, class_validator_1.IsOptional)(),
275
+ (0, class_validator_1.ValidateNested)(),
276
+ (0, class_transformer_1.Type)(() => MenuDto),
277
+ __metadata("design:type", MenuDto)
278
+ ], ClientPanelDto.prototype, "menu", void 0);
@@ -4,6 +4,7 @@ import { LanguageEnum } from '../enums/language.enum';
4
4
  import { RolesEnum } from '../enums/roles.enum';
5
5
  import { AdminPanelDto } from './admin-panel.dto';
6
6
  import { ClientPanelDto } from './client-panel.dto';
7
+ import { FieldDto } from './field.dto';
7
8
  /**
8
9
  * DTO for integration information.
9
10
  * This is a central DTO that contains all the necessary information
@@ -58,4 +59,5 @@ export declare class InfoDto {
58
59
  * This URL will be displayed in a popup or side sheet with a JWT for authentication.
59
60
  */
60
61
  onboardingUrl?: string;
62
+ setupAttributes?: FieldDto[];
61
63
  }
@@ -22,6 +22,8 @@ const class_transformer_1 = require("class-transformer");
22
22
  const admin_panel_dto_1 = require("./admin-panel.dto");
23
23
  const client_panel_dto_1 = require("./client-panel.dto");
24
24
  const class_validator_jsonschema_1 = require("class-validator-jsonschema");
25
+ const field_dto_1 = require("./field.dto");
26
+ const unique_field_in_array_validator_1 = require("../decorators/unique-field-in-array.validator");
25
27
  /**
26
28
  * DTO for integration information.
27
29
  * This is a central DTO that contains all the necessary information
@@ -157,3 +159,18 @@ __decorate([
157
159
  }),
158
160
  __metadata("design:type", String)
159
161
  ], InfoDto.prototype, "onboardingUrl", void 0);
162
+ __decorate([
163
+ (0, class_validator_1.IsOptional)(),
164
+ (0, class_validator_1.IsArray)(),
165
+ (0, class_validator_1.ArrayMinSize)(1),
166
+ (0, class_validator_1.ValidateNested)({ each: true }),
167
+ (0, class_transformer_1.Type)(() => field_dto_1.FieldDto),
168
+ (0, unique_field_in_array_validator_1.UniqueFieldInArray)('id'),
169
+ (0, class_validator_jsonschema_1.JSONSchema)({
170
+ title: 'Setup Attributes',
171
+ description: 'Configurable attributes that are used in the setup process.',
172
+ type: 'array',
173
+ items: { $ref: '#/components/schemas/FieldDto' }
174
+ }),
175
+ __metadata("design:type", Array)
176
+ ], InfoDto.prototype, "setupAttributes", void 0);
@@ -31,7 +31,7 @@ __decorate([
31
31
  description: 'Notification channel type.',
32
32
  type: 'string',
33
33
  enum: Object.values(notification_message_type_enum_1.NotificationMessageTypeEnum),
34
- example: Object.values(notification_message_type_enum_1.NotificationMessageTypeEnum)[0]
34
+ example: Object.values(notification_message_type_enum_1.NotificationMessageTypeEnum)[0],
35
35
  }),
36
36
  __metadata("design:type", String)
37
37
  ], NotificationInfoDto.prototype, "type", void 0);
@@ -46,8 +46,12 @@ __decorate([
46
46
  type: 'array',
47
47
  items: { $ref: '#/components/schemas/UnitDto' },
48
48
  example: [
49
- { id: 'messages', unitDescription: 'Message sent', intervalDescription: 'Per month' }
50
- ]
49
+ {
50
+ id: 'messages',
51
+ unitDescription: 'Message sent',
52
+ intervalDescription: 'Per month',
53
+ },
54
+ ],
51
55
  }),
52
56
  __metadata("design:type", Array)
53
57
  ], NotificationInfoDto.prototype, "payPerUseUnits", void 0);