@hosterai/types 0.0.11 → 0.0.13

package/README.md

@@ -29,28 +29,29 @@ DTOs define the shape of data that is exchanged between different parts of the s
 
 **Available DTOs:**
 
-- `action.dto.ts`: Defines the structure for an action, including icon, label, URL, and how it opens.
+- `action.dto.ts`: Defines the structure for a UI action.
 - `attachment.dto.ts`: Represents a file attachment.
 - `base-response.dto.ts`: A base structure for API responses.
+- `client-data.dto.ts`: Defines the data structure for a client.
 - `company-data.dto.ts`: Holds all the relevant data for a company.
-- `error-response.dto.ts`: Defines the structure for error responses from the API.
-- `field.dto.ts`: Represents a generic field, likely for forms or dynamic data display.
-- `info.dto.ts`: Contains all the necessary information for a service integration.
-- `jwt.dto.ts`: DTOs related to JSON Web Tokens (authentication).
+- `error-response.dto.ts`: Defines the structure for error responses.
+- `field.dto.ts`: Represents a generic field for forms or dynamic data.
+- `info.dto.ts`: Contains all necessary information for a service integration.
+- `jwt.dto.ts`: DTOs related to JSON Web Tokens.
 - `menu.dto.ts`: Defines the structure for menu items.
 - `multilang-text.dto.ts`: A DTO for handling text in multiple languages.
 - `response-data.dto.ts`: A generic wrapper for response data.
 - `setup-status-response.dto.ts`: DTO for returning the setup status.
 - `success-response.dto.ts`: Defines the structure for successful API responses.
 - `tab.dto.ts`: Represents a tab in a user interface.
-- `submenu.dto.ts`: Represents a submenu item, extending the `TabDto`.
+- `submenu.dto.ts`: Represents a submenu item.
 - `task-response.dto.ts`: DTO for responses related to background tasks.
 - `unit.dto.ts`: Represents a unit for pay-per-use billing.
 
 **Notification DTOs:**
 
 - `notification/notification-info.dto.ts`: Contains detailed information about a notification.
-- `notification/notification-request.dto.ts`: The primary DTO for requesting a new notification.
+- `notification/notification-send-request.dto.ts`: The primary DTO for requesting a new notification.
 - `notification/receiver/receiver-email.dto.ts`: Defines the receiver for an email notification.
 - `notification/receiver/receiver-push.dto.ts`: Defines the receiver for a push notification.
 - `notification/receiver/receiver-sms.dto.ts`: Defines the receiver for an SMS notification.
@@ -58,25 +59,38 @@ DTOs define the shape of data that is exchanged between different parts of the s
 - `notification/sender/sender-push.dto.ts`: Defines the sender for a push notification.
 - `notification/sender/sender-sms.dto.ts`: Defines the sender for an SMS notification.
 
+**Product DTOs:**
+
+- `product/product-info.dto.ts`: Contains detailed information about a product.
+- `product/product-item-data.dto.ts`: Represents the data of a specific product item.
+- `product/requests/*`: DTOs for product-related requests (create, delete, upgrade, etc.).
+- `product/responses/*`: DTOs for product-related responses.
+
 ### Enums
 
-Enums provide a set of named constants for common types, such as roles, languages, or notification types, preventing common errors with magic strings.
+Enums provide a set of named constants for common types, preventing errors with magic strings.
 
 **Key Enums:**
 
-- `ActionsEnum`: Defines the possible actions that can be performed.
+- `ActionsEnum`: Defines possible actions.
 - `CountryEnum`: A list of all countries.
-- `EventsEnum`: Defines the events that can be triggered.
-- `FieldTypeEnum`: Defines the types of fields that can be used.
+- `DurationEnum`: Defines billing durations (e.g., `MONTHLY`, `YEARLY`).
+- `EventsEnum`: Defines triggerable events.
+- `FieldTypeEnum`: Defines types of fields.
 - `LanguageEnum`: A list of supported languages.
-- `NotificationMessageTypeEnum`: Defines the type of notification (e.g., `EMAIL`, `SMS`, `PUSH`).
+- `NotificationMessageTypeEnum`: Defines the type of notification (e.g., `EMAIL`, `SMS`).
 - `OpenMethodEnum`: Defines how an action's URL should be opened.
-- `RolesEnum`: Defines user roles within the system.
+- `ResponseStatusEnum`: Defines the status of a response (e.g., `COMPLETED`, `FAILED`).
+- `RolesEnum`: Defines user roles.
 - `SetupStatusEnum`: Defines the status of a setup process.
 
+### Interfaces
+
+- `product/product.interface.ts`: Defines the contract for a product module.
+
 ### Validators
 
-This package includes validation functions that leverage `class-validator` and `class-transformer` to ensure that incoming data conforms to the DTO definitions. To use the validators, you must have `reflect-metadata` imported in your project's entry file.
+This package includes validation functions that leverage `class-validator` to ensure that incoming data conforms to the DTO definitions.
 
 **Available Validators:**
 
@@ -91,45 +105,45 @@ This package includes validation functions that leverage `class-validator` and `
 
 ## Usage Example
 
-Here is an example of how to use the `NotificationRequestDto` and its validator.
+Here is an example of how to use a DTO and its validator.
 
 First, import the necessary DTO, Enum, and validator function:
 
 ```typescript
 import {
-  NotificationRequestDto,
-  NotificationMessageTypeEnum,
-  validateNotificationRequestDto,
+  ProductCreateRequestDto,
+  ClientDataDto,
+  ProductItemDataDto,
+  DurationEnum,
+  validateProductCreateRequestDto, // Assuming a validator exists
 } from '@hosterai/types';
 
-// 1. Create a notification request object
-const notification: NotificationRequestDto = {
-  notificationId: 'user-welcome-email-01',
-  messageType: NotificationMessageTypeEnum.EMAIL,
-  sender: {
-    email: 'no-reply@hoster.ai',
-    name: 'HosterAI Team',
-  },
-  receiver: {
-    email: 'new-user@example.com',
+// 1. Create a request object
+const request: ProductCreateRequestDto = {
+  clientData: {
+    // ... client data
   },
-  // Optional template data
-  templateData: {
-    username: 'JohnDoe',
-    welcome_url: 'https://app.hoster.ai/welcome',
+  itemData: {
+    itemId: 'item-123',
+    productAttributes: {
+      // ... product attributes
+    },
+    itemAttributes: {
+      // ... item attributes
+    },
+    duration: DurationEnum.MONTHLY,
   },
 };
 
 // 2. Validate the object
-const errors = validateNotificationRequestDto(notification);
+// const errors = validateProductCreateRequestDto(request);
 
 // 3. Check for errors
-if (errors.length > 0) {
-  console.error('Validation failed:', errors);
-} else {
-  console.log('Validation successful! Ready to send.');
-  // Proceed to send the notification...
-}
+// if (errors.length > 0) {
+//   console.error('Validation failed:', errors);
+// } else {
+//   console.log('Validation successful!');
+// }
 ```
 
 ## Building from Source

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

@@ -1,16 +1,34 @@
 import { OpenMethodEnum } from '../enums/open-method.enum';
+/**
+ * Defines the structure for a UI action.
+ * @example
+ * {
+ *  "icon": "add",
+ *  "label": "Create New",
+ *  "openMethod": "ajax_call",
+ *  "url": "/api/create"
+ * }
+ */
 export declare class ActionDto {
     /**
-     * The icon of the action.
+     * The name of the icon to display for the action.
+     * @example "add"
      */
     icon: string;
     /**
-     * The label of the action (optional).
+     * The text label for the action.
+     * @optional
+     * @example "Create New"
      */
     label?: string;
+    /**
+     * The method by which the action's URL should be opened.
+     * @see OpenMethodEnum
+     */
     openMethod: OpenMethodEnum;
     /**
-     * The link of the action.
+     * The URL to navigate to when the action is triggered.
+     * @example "/api/create"
      */
     url: string;
 }

package/dist/dtos/action.dto.js

@@ -12,6 +12,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActionDto = void 0;
 const class_validator_1 = require("class-validator");
 const open_method_enum_1 = require("../enums/open-method.enum");
+/**
+ * Defines the structure for a UI action.
+ * @example
+ * {
+ *  "icon": "add",
+ *  "label": "Create New",
+ *  "openMethod": "ajax_call",
+ *  "url": "/api/create"
+ * }
+ */
 class ActionDto {
 }
 exports.ActionDto = ActionDto;

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

@@ -10,7 +10,7 @@ export declare class AttachmentDto {
     /**
      * The content of the file in Base64 encoding
      */
-    content: Buffer;
+    content: string;
     /**
      * The content type of the file (MIME type)
      */

package/dist/dtos/attachment.dto.js

@@ -27,7 +27,7 @@ __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsBase64)(),
-    __metadata("design:type", Buffer)
+    __metadata("design:type", String)
 ], AttachmentDto.prototype, "content", void 0);
 __decorate([
     (0, class_validator_1.IsOptional)(),

package/dist/dtos/client-data.dto.d.ts

@@ -0,0 +1,65 @@
+import { CountryEnum } from '../enums/country.enum';
+/**
+ * Defines the data structure for a client.
+ * This object is used to transfer client data between different parts of the application.
+ */
+export declare class ClientDataDto {
+    /**
+     * Email of the user
+     */
+    email: string;
+    /**
+     * First name of the user
+     */
+    firstName: string;
+    /**
+     * Last name of the user
+     */
+    lastName: string;
+    /**
+     * Telephone number of the user
+     */
+    telephone: string;
+    /**
+     * Mobile number of the user
+     */
+    mobile?: string;
+    /**
+     * Address line 1 of the user
+     */
+    address1: string;
+    /**
+     * Address line 2 of the user
+     */
+    address2?: string;
+    /**
+     * Address line 3 of the user
+     */
+    address3?: string;
+    /**
+     * Postal code of the user
+     */
+    postcode: string;
+    /**
+     * City of the user
+     */
+    city: string;
+    /**
+     * Country code of the user
+     */
+    country: CountryEnum;
+    /**
+     * State of the user
+     */
+    state?: string;
+    /**
+     * VAT number of the user
+     * @optional
+     */
+    vat?: string;
+    /**
+     * Tax office of the user
+     * @optional
+     */
+    taxOffice?: string;
+}

package/dist/dtos/client-data.dto.js

@@ -0,0 +1,106 @@
+"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.ClientDataDto = void 0;
+const class_validator_1 = require("class-validator");
+const country_enum_1 = require("../enums/country.enum");
+/**
+ * Defines the data structure for a client.
+ * This object is used to transfer client data between different parts of the application.
+ */
+class ClientDataDto {
+}
+exports.ClientDataDto = ClientDataDto;
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsEmail)(),
+    __metadata("design:type", String)
+], ClientDataDto.prototype, "email", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], ClientDataDto.prototype, "firstName", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], ClientDataDto.prototype, "lastName", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsPhoneNumber)(),
+    __metadata("design:type", String)
+], ClientDataDto.prototype, "telephone", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsPhoneNumber)(),
+    __metadata("design:type", String)
+], ClientDataDto.prototype, "mobile", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.MinLength)(1),
+    (0, class_validator_1.MaxLength)(250),
+    __metadata("design:type", String)
+], ClientDataDto.prototype, "address1", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.MinLength)(0),
+    (0, class_validator_1.MaxLength)(250),
+    __metadata("design:type", String)
+], ClientDataDto.prototype, "address2", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.MinLength)(0),
+    (0, class_validator_1.MaxLength)(250),
+    __metadata("design:type", String)
+], ClientDataDto.prototype, "address3", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.MinLength)(1),
+    (0, class_validator_1.MaxLength)(16),
+    __metadata("design:type", String)
+], ClientDataDto.prototype, "postcode", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.MinLength)(1),
+    (0, class_validator_1.MaxLength)(250),
+    __metadata("design:type", String)
+], ClientDataDto.prototype, "city", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.IsEnum)(country_enum_1.CountryEnum),
+    __metadata("design:type", String)
+], ClientDataDto.prototype, "country", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.MinLength)(0),
+    (0, class_validator_1.MaxLength)(250),
+    __metadata("design:type", String)
+], ClientDataDto.prototype, "state", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], ClientDataDto.prototype, "vat", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], ClientDataDto.prototype, "taxOffice", void 0);

package/dist/dtos/company-data.dto.d.ts

@@ -1,22 +1,79 @@
 import { CountryEnum } from '../enums/country.enum';
 import { LanguageEnum } from '../enums/language.enum';
+/**
+ * Data Transfer Object for company data.
+ */
 export declare class CompanyDataDto {
+    /**
+     * The unique identifier for the company.
+     */
     id: string;
+    /**
+     * The name of the company.
+     */
     name: string;
+    /**
+     * An array of email addresses associated with the company.
+     */
     emails: string[];
+    /**
+     * The email address used for invoicing.
+     */
     invoiceEmail: string;
+    /**
+     * The URL for the company's privacy policy.
+     */
     privacyPolicyUrl: string;
+    /**
+     * The default language for the company.
+     */
     defaultLanguage: LanguageEnum;
+    /**
+     * An array of supported languages for the company.
+     */
     languages: LanguageEnum[];
+    /**
+     * The primary telephone number for the company.
+     */
     telephone: string;
+    /**
+     * The mobile phone number for the company (optional).
+     */
     mobile?: string;
+    /**
+     * The first line of the company's address.
+     */
     address1: string;
+    /**
+     * The second line of the company's address (optional).
+     */
     address2?: string;
+    /**
+     * The third line of the company's address (optional).
+     */
     address3?: string;
+    /**
+     * The postal code for the company's address.
+     */
     postcode: string;
+    /**
+     * The city for the company's address.
+     */
     city: string;
+    /**
+     * The country for the company's address.
+     */
     country: CountryEnum;
+    /**
+     * The state or province for the company's address (optional).
+     */
     state?: string;
+    /**
+     * The VAT number for the company (optional).
+     */
     vat?: string;
+    /**
+     * The tax office for the company (optional).
+     */
     taxOffice?: string;
 }

package/dist/dtos/company-data.dto.js

@@ -13,6 +13,9 @@ exports.CompanyDataDto = void 0;
 const class_validator_1 = require("class-validator");
 const country_enum_1 = require("../enums/country.enum");
 const language_enum_1 = require("../enums/language.enum");
+/**
+ * Data Transfer Object for company data.
+ */
 class CompanyDataDto {
 }
 exports.CompanyDataDto = CompanyDataDto;
@@ -49,11 +52,11 @@ __decorate([
     __metadata("design:type", Array)
 ], CompanyDataDto.prototype, "languages", void 0);
 __decorate([
-    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsPhoneNumber)(),
     __metadata("design:type", String)
 ], CompanyDataDto.prototype, "telephone", void 0);
 __decorate([
-    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsPhoneNumber)(),
     (0, class_validator_1.IsOptional)(),
     __metadata("design:type", String)
 ], CompanyDataDto.prototype, "mobile", void 0);

package/dist/dtos/error-response.dto.d.ts

@@ -1,16 +1,18 @@
 /**
- * DTO for error response
- * Used to return error information to the client
+ * DTO for error response.
+ * Used to return detailed error information to the client.
  */
 export declare class ErrorResponseDto {
     /**
-     * Unique error identifier
-     * Used for error reporting and tracking
+     * A unique and specific error code for programmatic error handling.
+     * @example 400
      */
     code: number;
     /**
-     * Array or text with error messages
-     * May contain one or more messages describing the error
+     * A developer-friendly error message or an array of messages.
+     * This can be a single string for a general error, or an array for multiple validation errors.
+     * @example "Validation failed"
+     * @example ["email must be an email", "password must be at least 8 characters"]
      */
     errors?: string[] | string;
 }

package/dist/dtos/error-response.dto.js

@@ -12,8 +12,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ErrorResponseDto = void 0;
 const class_validator_1 = require("class-validator");
 /**
- * DTO for error response
- * Used to return error information to the client
+ * DTO for error response.
+ * Used to return detailed error information to the client.
  */
 class ErrorResponseDto {
 }

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

@@ -1,5 +1,10 @@
 import { FieldTypeEnum } from '../enums/field-type.enum';
 import { MultilangTextDto } from './multilang-text.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.
+ */
 export declare class FieldDto {
     /**
      * ID of action field

package/dist/dtos/field.dto.js

@@ -14,6 +14,11 @@ const class_validator_1 = require("class-validator");
 const class_transformer_1 = require("class-transformer");
 const field_type_enum_1 = require("../enums/field-type.enum");
 const multilang_text_dto_1 = require("./multilang-text.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.
+ */
 class FieldDto {
     constructor() {
         /**