@hosterai/types 0.0.12 → 0.0.14

package/README.md

@@ -1,5 +1,11 @@
 # @hosterai/types
 
+This package contains the core types for the Hoster AI platform.
+
+## Files
+
+- `llm.txt`: Contains a list of large language models.
+
 [![NPM Version](https://img.shields.io/npm/v/@hosterai/types.svg)](https://www.npmjs.com/package/@hosterai/types)
 [![NPM Downloads](https://img.shields.io/npm/dm/@hosterai/types.svg)](https://www.npmjs.com/package/@hosterai/types)
 [![Build Status](https://github.com/HosterAI/types/actions/workflows/ci.yml/badge.svg)](https://github.com/HosterAI/types/actions/workflows/ci.yml)
@@ -36,6 +42,7 @@ DTOs define the shape of data that is exchanged between different parts of the s
 - `company-data.dto.ts`: Holds all the relevant data for a company.
 - `error-response.dto.ts`: Defines the structure for error responses.
 - `field.dto.ts`: Represents a generic field for forms or dynamic data.
+- `field-option.dto.ts`: Represents options for form fields (used for checkboxes, radioboxes, and selects).
 - `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.
@@ -72,7 +79,7 @@ Enums provide a set of named constants for common types, preventing errors with
 
 **Key Enums:**
 
-- `ActionsEnum`: Defines possible actions.
+- `ProductActionsEnum`: Defines possible actions.
 - `CountryEnum`: A list of all countries.
 - `DurationEnum`: Defines billing durations (e.g., `MONTHLY`, `YEARLY`).
 - `EventsEnum`: Defines triggerable events.

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
@@ -46,7 +51,7 @@ export declare class FieldDto {
      */
     remoteValidationErrorMessage?: MultilangTextDto[];
     /**
-     * The item attribute is upgradeable
+     * The item attribute is upgradable
      */
-    upgradeable: boolean;
+    upgradable: boolean;
 }

package/dist/dtos/field.dto.js

@@ -14,12 +14,17 @@ 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() {
         /**
-         * The item attribute is upgradeable
+         * The item attribute is upgradable
          */
-        this.upgradeable = false;
+        this.upgradable = false;
     }
 }
 exports.FieldDto = FieldDto;
@@ -79,4 +84,4 @@ __decorate([
 __decorate([
     (0, class_validator_1.IsBoolean)(),
     __metadata("design:type", Boolean)
-], FieldDto.prototype, "upgradeable", void 0);
+], FieldDto.prototype, "upgradable", void 0);

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

@@ -1,91 +1,100 @@
 import { ActionsEnum } from '../enums/actions.enum';
 import { EventsEnum } from '../enums/events.enum';
-import { FieldDto } from './field.dto';
-import { ResponseDataDto } from './response-data.dto';
-import { UnitDto } from './unit.dto';
 import { LanguageEnum } from '../enums/language.enum';
 import { RolesEnum } from '../enums/roles.enum';
 import { ActionDto } from './action.dto';
 import { TabDto } from './tab.dto';
 import { MenuDtoWithSubmenu, MenuDtoWithUrl } from './menu.dto';
 /**
- * DTO for integration information
- * Contains all information related to a service integration
+ * DTO for integration information.
+ * This is a central DTO that contains all the necessary information
+ * for a service integration, including UI configuration, supported features,
+ * and billing details.
  */
 export declare class InfoDto {
     /**
-     * The title of the integration
+     * The display title of the integration.
+     * @example "My Awesome Integration"
      */
     title: string;
     /**
-     * The logo of the integration (optional)
+     * The URL of the integration's logo.
+     * @example "https://example.com/logo.png"
      */
     logo?: string;
     /**
-     * Description of the integration and its services (optional)
+     * A brief description of the integration and its services.
+     * @example "This integration provides a set of tools for managing your products."
      */
     description?: string;
     /**
-     * List of supported languages for the integration.
+     * A list of languages supported by the integration.
      */
-    supported_languages: LanguageEnum[];
+    supportedLanguages: LanguageEnum[];
     /**
-     * Custom attributes for products.
+     * A list of actions that are supported by this integration.
      */
-    product_attributes?: FieldDto[];
+    supportedActions?: ActionsEnum[];
     /**
-     * Custom attributes for items.
+     * A list of events that the integration listens to.
+     * This allows the integration to react to specific events in the system.
      */
-    item_attributes?: FieldDto[];
+    listenEvents?: EventsEnum[];
     /**
-     * Events that the integration listens to.
-     */
-    listen_events?: EventsEnum[];
-    /**
-     * The roles that need to be accepted by the company
+     * A list of roles that the company needs to accept for this integration to function correctly.
      */
     requiredRoles?: RolesEnum[];
-    /**
-     * Actions that are not supported by the integration.
-     */
-    unsupportedActions?: ActionsEnum[];
     /**
      * Configuration for the admin panel.
-     * Contains all UI and action configuration for the admin interface.
+     * This section defines the entire user interface for the integration's admin panel.
      */
     adminPanel?: {
-        /** Tab groups for different admin panel sections in the admin panel. */
+        /**
+         * Defines the tab structure for different sections of the admin panel.
+         * Each property represents a section (e.g., product, item) and contains an array of TabDto objects.
+         */
         tabs?: {
-            /** Tabs related to products. */
+            /** Tabs for the product management section. */
             product: TabDto[];
-            /** Tabs related to items. */
+            /** Tabs for the item management section. */
             item: TabDto[];
-            /** Tabs related to clients. */
+            /** Tabs for the client management section. */
             client: TabDto[];
-            /** Tabs related to users. */
+            /** Tabs for the user management section. */
             user: TabDto[];
-            /** Tabs related to orders. */
+            /** Tabs for the order management section. */
             order: TabDto[];
         };
-        /** Additional actions available in the admin panel. */
+        /**
+         * Defines additional actions that can be performed in different sections of the admin panel.
+         */
         moreActions?: {
-            /** Actions related to clients. */
+            /** Actions available in the client management section. */
             client?: ActionDto[];
-            /** Actions related to items. */
+            /** Actions available in the item management section. */
             item?: ActionDto[];
-            /** Actions related to invoices. */
+            /** Actions available in the invoice management section. */
             invoice?: ActionDto[];
-            /** Actions related to users. */
+            /** Actions available in the user management section. */
             user?: ActionDto[];
-            /** Actions related to orders. */
+            /** Actions available in the order management section. */
             order?: ActionDto[];
         };
-        /** Main menu for the admin panel. Extends TabDto and adds icon information */
+        /**
+         * The main menu for the admin panel.
+         * This can be a simple menu with a URL or a menu with submenus.
+         */
         menu?: MenuDtoWithSubmenu | MenuDtoWithUrl;
+        /**
+         * Configuration for the integration's settings page.
+         */
         settings?: {
+            /** The label for the settings page. */
             label: string;
+            /** The icon for the settings page. */
             icon: string;
-            description: string;
+            /** A description of the settings page. */
+            descrition: string;
         } & ({
             url: string;
             tabs?: never;
@@ -96,44 +105,32 @@ export declare class InfoDto {
     };
     /**
      * Configuration for the client panel.
-     * Contains all UI and action configuration for the client interface.
+     * This section defines the user interface for the integration's client-facing panel.
      */
     clientPanel?: {
-        /** Tab groups for the client panel. */
+        /**
+         * Defines the tab structure for the client panel.
+         */
         tabs?: {
-            /** Tabs related to items. */
+            /** Tabs for the item management section. */
             item: TabDto[];
         };
-        /** Additional actions available in the client panel. */
+        /**
+         * Defines additional actions that can be performed in the client panel.
+         */
         moreActions?: {
-            /** Actions related to items. */
+            /** Actions available in the item management section. */
             item?: ActionDto[];
         };
-        /** Main menu for the client panel.
-         * Each menu must have at least one TabDto.
-         * If there are no submenus, the label of the TabDto will be displayed in the panel.
-         * If there are submenus, the label of the MenuDto and the TabDtos of the MenuDto will be displayed in the panel.
-         * The TabDtos of the MenuDto will be the submenus of the MenuDto.
+        /**
+         * The main menu for the client panel.
+         * This can be a simple menu with a URL or a menu with submenus.
          */
         menu?: MenuDtoWithSubmenu | MenuDtoWithUrl;
     };
     /**
-     * The url for the onboarding process after installation of the integration
-     * Will be displayed either as a popup or as a side sheet containing an iframe
-     * with this url and the jwt in the url
+     * The URL for the onboarding process after the integration is installed.
+     * This URL will be displayed in a popup or side sheet with a JWT for authentication.
      */
     onboardingUrl?: string;
-    /**
-     * Units for pay-per-use billing.
-     * e.g. id: ram, unitDescription: MB, intervalDescription: month
-     * With the above in the admin the administrator will be able to set a price for
-     * MB per month (the id is the unit's unique identifier)
-     */
-    payPerUseUnits?: UnitDto[];
-    /**
-     * Here we need to specify the fields (keys) that a successful create will return
-     * In other words, we want to know the information that a successful create will
-     * return, before the create is executed
-     */
-    responseDataFieldNames?: Record<keyof ResponseDataDto, string>;
 }