@hosterai/types 0.0.1

package/README.md

@@ -0,0 +1,115 @@
+# Multi-Language DTO & Enum Generator
+
+This project provides tools to automatically generate Data Transfer Objects (DTOs) and Enums in multiple programming languages from TypeScript definitions. This ensures consistency across different services that might be implemented in different programming languages.
+
+## Supported Languages
+
+| Language   | Status      | Generator Script       |
+|------------|-------------|------------------------|
+| Go         | ✅ Complete | `generate-golang.ts`   |
+| Python     | ✅ Complete | `generate-python.ts`   |
+| C#         | ✅ Complete | `generate-csharp.ts`   |
+| Java       | ✅ Complete | `generate-java.ts`     |
+| PHP        | ✅ Complete | `generate-php.ts`      |
+| Ruby       | ✅ Complete | `generate-ruby.ts`     |
+| Rust       | ✅ Complete | `generate-rust.ts`     |
+| Swift      | ✅ Complete | `generate-swift.ts`    |
+| Kotlin     | ✅ Complete | `generate-kotlin.ts`   |
+
+## Usage
+
+**Important:** Before generating code for any language, you must first generate the JSON schemas by running:
+```bash
+npm run generate:schemas
+```
+
+### Generate Code for All Supported Languages
+
+```bash
+npm run generate -- all
+```
+
+### Generate Code for a Specific Language
+
+```bash
+npm run generate -- <language>
+```
+
+For example:
+```bash
+npm run generate -- golang
+npm run generate -- python
+npm run generate -- csharp
+npm run generate -- java
+```
+
+## Project Structure
+
+- `/dtos/` - TypeScript DTO definitions
+- `/enums/` - TypeScript Enum definitions
+- `/generated/` - Output directory for generated code
+  - `/golang/` - Generated Go code
+  - `/python/` - Generated Python code
+  - `/csharp/` - Generated C# code
+  - `/java/` - Generated Java code
+  - ... (other languages as implemented)
+
+
+## Core DTOs
+
+This section describes some of the core Data Transfer Objects available in this project.
+
+### `ActionDto`
+
+The `ActionDto` defines the structure for an action that can be performed, typically represented as a button or link in a UI.
+
+-   `icon`: (string) The CSS class or identifier for the icon to be displayed.
+-   `label`: (string, optional) The text label for the action.
+-   `openMethod`: (string) Specifies how the action should be executed. Possible values are:
+    -   `"ajax_call"`: Perform an AJAX request.
+    -   `"small_iframe"`: Open in a small iframe.
+    -   `"medium_iframe"`: Open in a medium-sized iframe.
+    -   `"large_iframe"`: Open in a large iframe.
+-   `url`: (string) The URL or endpoint for the action.
+
+## Implementation Details
+
+### Go Implementation
+
+- Uses JSON Schema as an intermediate format
+- Converts TypeScript definitions to Go structs with proper JSON tags
+- Handles optional fields and type conversions
+
+### Python Implementation
+
+- Generates Python dataclasses with type hints
+- Handles optional fields with Union types
+- Properly converts TypeScript types to Python equivalents
+
+### C# Implementation
+
+- Generates C# classes with properties
+- Includes proper JSON attributes for serialization/deserialization
+- Handles nullable types appropriately
+
+### Java Implementation
+
+- Generates Java classes with Lombok annotations to reduce boilerplate
+- Includes Jackson annotations for JSON serialization/deserialization
+- Handles type conversions and optionals
+
+## Adding a New Language Generator
+
+To implement a generator for a new language:
+
+1. Create a new script (e.g., `generate-newlang.ts`) in the project root
+2. Implement the translation from TypeScript to the target language
+3. Ensure the generator follows the pattern of existing implementations
+4. Update the language entry in the `LANGUAGES` object in `generate.ts`
+
+## Dependencies
+
+- `typescript-json-schema`: For generating JSON Schema from TypeScript definitions
+- `quicktype`: For generating code from JSON Schema
+- `fs-extra`: For file system operations
+- `glob`: For file pattern matching

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

@@ -0,0 +1,16 @@
+import { OpenMethodEnum } from "../enums/open-method.enum";
+export declare class ActionDto {
+    /**
+     * The icon of the action.
+     */
+    icon: string;
+    /**
+     * The label of the action (optional).
+     */
+    label?: string;
+    openMethod: OpenMethodEnum;
+    /**
+     * The link of the action.
+     */
+    url: string;
+}

package/dist/dtos/action.dto.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionDto = void 0;
+class ActionDto {
+}
+exports.ActionDto = ActionDto;

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

@@ -0,0 +1,18 @@
+/**
+ * DTO for file attachments
+ * Used for sending attached files with emails
+ */
+export declare class AttachmentDto {
+    /**
+     * The name of the attached file
+     */
+    filename: string;
+    /**
+     * The content of the file in Base64 encoding
+     */
+    content: string;
+    /**
+     * The content type of the file (MIME type)
+     */
+    contentType?: string;
+}

package/dist/dtos/attachment.dto.js

@@ -0,0 +1,36 @@
+"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.AttachmentDto = void 0;
+const class_validator_1 = require("class-validator");
+/**
+ * DTO for file attachments
+ * Used for sending attached files with emails
+ */
+class AttachmentDto {
+}
+exports.AttachmentDto = AttachmentDto;
+__decorate([
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], AttachmentDto.prototype, "filename", void 0);
+__decorate([
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsBase64)(),
+    __metadata("design:type", String)
+], AttachmentDto.prototype, "content", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], AttachmentDto.prototype, "contentType", void 0);

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

@@ -0,0 +1,14 @@
+/**
+ * Base response class
+ * Used as a foundation for all API responses
+ */
+export declare class BaseResponse {
+    /**
+     * Response code
+     */
+    code: number;
+    /**
+     * Response message
+     */
+    message: string;
+}

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

@@ -0,0 +1,30 @@
+"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.BaseResponse = void 0;
+const class_validator_1 = require("class-validator");
+/**
+ * Base response class
+ * Used as a foundation for all API responses
+ */
+class BaseResponse {
+}
+exports.BaseResponse = BaseResponse;
+__decorate([
+    (0, class_validator_1.IsNumber)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", Number)
+], BaseResponse.prototype, "code", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", String)
+], BaseResponse.prototype, "message", void 0);

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

@@ -0,0 +1,22 @@
+import { CountryEnum } from "../enums/country.enum";
+import { LanguageEnum } from "../enums/language.enum";
+export declare class CompanyDataDto {
+    id: string;
+    name: string;
+    emails: string[];
+    invoiceEmail: string;
+    privacyPolicyUrl: string;
+    defaultLanguage: LanguageEnum;
+    languages: LanguageEnum[];
+    telephone: string;
+    mobile?: string;
+    address1: string;
+    address2?: string;
+    address3?: string;
+    postcode: string;
+    city: string;
+    country: CountryEnum;
+    state?: string;
+    vat?: string;
+    taxOffice?: string;
+}

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

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompanyDataDto = void 0;
+class CompanyDataDto {
+}
+exports.CompanyDataDto = CompanyDataDto;

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

@@ -0,0 +1,16 @@
+/**
+ * DTO for error response
+ * Used to return error information to the client
+ */
+export declare class ErrorResponseDto {
+    /**
+     * Unique error identifier
+     * Used for error reporting and tracking
+     */
+    code: string;
+    /**
+     * Array or text with error messages
+     * May contain one or more messages describing the error
+     */
+    errors?: string[] | string;
+}

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

@@ -0,0 +1,31 @@
+"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.ErrorResponseDto = void 0;
+const class_validator_1 = require("class-validator");
+/**
+ * DTO for error response
+ * Used to return error information to the client
+ */
+class ErrorResponseDto {
+}
+exports.ErrorResponseDto = ErrorResponseDto;
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", String)
+], ErrorResponseDto.prototype, "code", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.IsString)({ each: true }),
+    __metadata("design:type", Object)
+], ErrorResponseDto.prototype, "errors", void 0);

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

@@ -0,0 +1,48 @@
+import { FieldTypeEnum } from "../enums/field-type.enum";
+import { MultilangTextDto } from "./multilang-text.dto";
+export declare class FieldDto {
+    /**
+     * ID of action field
+     */
+    id: string;
+    /**
+     * Label of action field
+     */
+    label: MultilangTextDto[];
+    /**
+     * Value of action field
+     */
+    value: string | number | Record<string, any>;
+    /**
+     * Type of label
+     */
+    type: FieldTypeEnum;
+    /**
+     * Indicates if the field is required
+     */
+    required: boolean;
+    /**
+     * Indicates if the field is disabled
+     */
+    disabled: boolean;
+    /**
+     * Indicates if the field is hidden
+     */
+    hidden: boolean;
+    /**
+     * Regex validation pattern for the field
+     */
+    regexValidation?: string;
+    /**
+     * Error message for the field for supported languages
+     */
+    regexValidationErrorMessage?: MultilangTextDto[];
+    /**
+     * Indicates if the field has remote validation
+     */
+    remoteValidation?: boolean;
+    /**
+     * Error message for the field
+     */
+    remoteValidationErrorMessage?: MultilangTextDto[];
+}

package/dist/dtos/field.dto.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldDto = void 0;
+class FieldDto {
+}
+exports.FieldDto = FieldDto;

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

@@ -0,0 +1,5 @@
+import { MessageTypeEnum } from "../../enums/message-type.enum";
+import { InfoDto } from "./info.dto";
+export declare class InfoNotificationDto extends InfoDto {
+    type: MessageTypeEnum;
+}

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

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InfoNotificationDto = void 0;
+const info_dto_1 = require("./info.dto");
+class InfoNotificationDto extends info_dto_1.InfoDto {
+}
+exports.InfoNotificationDto = InfoNotificationDto;

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

@@ -0,0 +1,96 @@
+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';
+/**
+ * DTO for tabs
+ * Used for defining tabs in the user interface
+ */
+declare class TabDto {
+    /**
+     * The label displayed on the tab
+     */
+    label: string;
+    /**
+     * The URL associated with the tab.
+     * The requests coming from the hoster will be signed
+     * with jwt, which will contain information about the company
+     */
+    url: string;
+}
+/**
+ * DTO for menu items
+ * Extends TabDto and adds icon information
+ */
+declare class MenuDto {
+    /**
+     * The icon to be displayed for the menu item
+     */
+    icon: string;
+    /**
+     * The name to be displayed for the menu item
+     */
+    label: string;
+    /**
+     * The list of tabs that will appear in the submenu and as a navigation bar above the main content
+     * In case of only one tab, there will be neither a submenu nor a navigation bar.
+     */
+    tabs: TabDto[];
+}
+/**
+ * DTO for integration information
+ * Contains all information related to a service integration
+ */
+export declare class InfoDto {
+    /**
+     * The title of the integration
+     */
+    title: string;
+    /**
+     * The logo of the integration (optional)
+     */
+    logo?: string;
+    /**
+     * Description of the integration and its services (optional)
+     */
+    description?: string;
+    supported_languages: LanguageEnum[];
+    product_attributes?: FieldDto[];
+    item_attributes?: FieldDto[];
+    listen_events?: EventsEnum[];
+    /**
+    * The roles that need to be accepted by the company
+    */
+    requiredRoles?: RolesEnum[];
+    unsupportedActions: ActionsEnum[];
+    adminPanel?: {
+        productTabs?: TabDto[];
+        actions?: {
+            client?: ActionDto[];
+            item?: ActionDto[];
+        };
+        menu?: MenuDto;
+        /**
+        * Option that will appear in the "Settings" section (optional)
+        */
+        settings?: MenuDto;
+    };
+    clientPanel?: {
+        productTabs?: TabDto[];
+        actions?: {
+            item?: ActionDto[];
+        };
+        menu?: MenuDto;
+    };
+    /**
+     * The url for the onboarding process after installation of the integration
+     */
+    onboardingUrl?: string;
+    payPerUseUnits?: UnitDto[];
+    responseDataFieldNames?: Record<keyof ResponseDataDto, string>;
+}
+export {};

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

@@ -0,0 +1,96 @@
+"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.InfoDto = void 0;
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+const language_enum_1 = require("../../enums/language.enum");
+const roles_enum_1 = require("../../enums/roles.enum");
+/**
+ * DTO for tabs
+ * Used for defining tabs in the user interface
+ */
+class TabDto {
+}
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", String)
+], TabDto.prototype, "label", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.IsUrl)(),
+    __metadata("design:type", String)
+], TabDto.prototype, "url", void 0);
+/**
+ * DTO for menu items
+ * Extends TabDto and adds icon information
+ */
+class MenuDto {
+}
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", String)
+], MenuDto.prototype, "icon", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", String)
+], MenuDto.prototype, "label", void 0);
+__decorate([
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.MinLength)(1),
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    (0, class_transformer_1.Type)(() => TabDto),
+    __metadata("design:type", Array)
+], MenuDto.prototype, "tabs", void 0);
+/**
+ * DTO for integration information
+ * Contains all information related to a service integration
+ */
+class InfoDto {
+    constructor() {
+        this.unsupportedActions = [];
+    }
+}
+exports.InfoDto = InfoDto;
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", String)
+], InfoDto.prototype, "title", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", String)
+], InfoDto.prototype, "logo", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", String)
+], InfoDto.prototype, "description", void 0);
+__decorate([
+    (0, class_validator_1.IsArray)({ each: true }),
+    (0, class_validator_1.IsEnum)(language_enum_1.LanguageEnum),
+    __metadata("design:type", Array)
+], InfoDto.prototype, "supported_languages", void 0);
+__decorate([
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.IsEnum)(roles_enum_1.RolesEnum, { each: true }),
+    __metadata("design:type", Array)
+], InfoDto.prototype, "requiredRoles", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsUrl)(),
+    __metadata("design:type", String)
+], InfoDto.prototype, "onboardingUrl", void 0);

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

@@ -0,0 +1,30 @@
+import { RolesEnum } from "../enums/roles.enum";
+/**
+ * DTO for JWT payload
+ * Used for user authentication and authorization
+ */
+export declare class JwtDto {
+    /**
+     * User information contained in the JWT token
+     * Includes user and company identifiers, admin rights
+     * and optional sender details
+     */
+    jwt: {
+        /**
+         * Integration identifier
+         */
+        integrationId: string;
+        /**
+         * Unique user identifier that triggers the API call (only the /send method will not contain userId).
+         */
+        userId?: string;
+        /**
+         * Unique company identifier
+         */
+        companyId: string;
+        /**
+         * The roles accepted by the company for this integration
+         */
+        acceptedRoles: RolesEnum[];
+    };
+}

package/dist/dtos/jwt.dto.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JwtDto = void 0;
+/**
+ * DTO for JWT payload
+ * Used for user authentication and authorization
+ */
+class JwtDto {
+}
+exports.JwtDto = JwtDto;

package/dist/dtos/multilang-text.dto.d.ts

@@ -0,0 +1,5 @@
+import { LanguageEnum } from "../enums/language.enum";
+export declare class MultilangTextDto {
+    language: LanguageEnum;
+    text: string;
+}

package/dist/dtos/multilang-text.dto.js

@@ -0,0 +1,27 @@
+"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.MultilangTextDto = void 0;
+const class_validator_1 = require("class-validator");
+const language_enum_1 = require("../enums/language.enum");
+class MultilangTextDto {
+}
+exports.MultilangTextDto = MultilangTextDto;
+__decorate([
+    (0, class_validator_1.IsEnum)(language_enum_1.LanguageEnum),
+    (0, class_validator_1.IsDefined)(),
+    __metadata("design:type", String)
+], MultilangTextDto.prototype, "language", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsDefined)(),
+    __metadata("design:type", String)
+], MultilangTextDto.prototype, "text", void 0);