@hosterai/types 0.0.1 → 0.0.2

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

@@ -8,9 +8,16 @@ export declare class ActionDto {
      * The label of the action (optional).
      */
     label?: string;
+    /**
+     * Defines how the URL will open when the user clicks on it
+     * AJAX_CALL: Makes an AJAX call and displays the response to the user
+     * SMALL_IFRAME: Opens the URL in a small side sheet
+     * MEDIUM_IFRAME: Opens the URL in a medium side sheet
+     * LARGE_IFRAME: Opens the URL in a large side sheet
+     */
     openMethod: OpenMethodEnum;
     /**
-     * The link of the action.
+     * The URL that will open when the user clicks on it
      */
     url: string;
 }

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

@@ -6,6 +6,68 @@ import { UnitDto } from '../unit.dto';
 import { LanguageEnum } from '../../enums/language.enum';
 import { RolesEnum } from '../../enums/roles.enum';
 import { ActionDto } from '../action.dto';
+/**
+ * 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;
+    /**
+     * List of supported languages for the integration.
+     */
+    supported_languages: LanguageEnum[];
+    /**
+     * Custom attributes for products.
+     */
+    product_attributes?: FieldDto[];
+    /**
+     * Custom attributes for items.
+     */
+    item_attributes?: FieldDto[];
+    /**
+     * Events that the integration listens to.
+     */
+    listen_events?: EventsEnum[];
+    /**
+     * The roles that need to be accepted by the company
+     */
+    requiredRoles?: RolesEnum[];
+    /**
+     * Actions that are not supported by the integration.
+     */
+    unsupportedActions?: ActionsEnum[];
+    /**
+     * Configuration for the admin panel.
+     */
+    adminPanel?: AdminPanelDto;
+    /**
+     * Configuration for the client panel.
+     */
+    clientPanel?: ClientPanelDto;
+    /**
+     * The url for the onboarding process after installation of the integration
+     */
+    onboardingUrl?: string;
+    /**
+     * Units for pay-per-use billing.
+     */
+    payPerUseUnits?: UnitDto[];
+    /**
+     * Mapping of response data field names.
+     */
+    responseDataFieldNames?: Record<keyof ResponseDataDto, string>;
+}
 /**
  * DTO for tabs
  * Used for defining tabs in the user interface
@@ -42,55 +104,93 @@ declare class MenuDto {
     tabs: TabDto[];
 }
 /**
- * DTO for integration information
- * Contains all information related to a service integration
+ * DTO for the tabs in the admin panel.
  */
-export declare class InfoDto {
+declare class AdminPanelTabsDto {
     /**
-     * The title of the integration
+     * Tabs related to products.
      */
-    title: string;
+    product: TabDto[];
     /**
-     * The logo of the integration (optional)
+     * Tabs related to items.
      */
-    logo?: string;
+    item: TabDto[];
     /**
-     * Description of the integration and its services (optional)
+     * Tabs related to clients.
      */
-    description?: string;
-    supported_languages: LanguageEnum[];
-    product_attributes?: FieldDto[];
-    item_attributes?: FieldDto[];
-    listen_events?: EventsEnum[];
+    client: TabDto[];
     /**
-    * 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;
-    };
+     * Tabs related to orders.
+     */
+    order: TabDto[];
+}
+/**
+ * DTO for actions available in a panel.
+ */
+declare class PanelActionsDto {
     /**
-     * The url for the onboarding process after installation of the integration
+     * Actions related to clients.
      */
-    onboardingUrl?: string;
-    payPerUseUnits?: UnitDto[];
-    responseDataFieldNames?: Record<keyof ResponseDataDto, string>;
+    client?: ActionDto[];
+    /**
+     * Actions related to items.
+     */
+    item?: ActionDto[];
+}
+/**
+ * DTO for the admin panel configuration.
+ */
+declare class AdminPanelDto {
+    /**
+     * Configuration for the tabs in the admin panel.
+     */
+    tabs?: AdminPanelTabsDto;
+    /**
+     * Additional actions available in the admin panel.
+     */
+    moreActions?: PanelActionsDto;
+    /**
+     * Main menu for the admin panel.
+     */
+    menu?: MenuDto;
+    /**
+     * Settings menu for the admin panel.
+     */
+    settings?: MenuDto;
+}
+/**
+ * DTO for the tabs in the client panel.
+ */
+declare class ClientPanelTabsDto {
+    /**
+     * Tabs related to items.
+     */
+    item: TabDto[];
+}
+/**
+ * DTO for actions available in the client panel.
+ */
+declare class ClientPanelActionsDto {
+    /**
+     * Actions related to items.
+     */
+    item?: ActionDto[];
+}
+/**
+ * DTO for the client panel configuration.
+ */
+declare class ClientPanelDto {
+    /**
+     * Configuration for the tabs in the client panel.
+     */
+    tabs?: ClientPanelTabsDto;
+    /**
+     * Additional actions available in the client panel.
+     */
+    moreActions?: ClientPanelActionsDto;
+    /**
+     * Main menu for the client panel.
+     */
+    menu?: MenuDto;
 }
 export {};

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

@@ -12,8 +12,107 @@ 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 actions_enum_1 = require("../../enums/actions.enum");
+const events_enum_1 = require("../../enums/events.enum");
+const field_dto_1 = require("../field.dto");
+const unit_dto_1 = require("../unit.dto");
 const language_enum_1 = require("../../enums/language.enum");
 const roles_enum_1 = require("../../enums/roles.enum");
+const action_dto_1 = require("../action.dto");
+/**
+ * DTO for integration information
+ * Contains all information related to a service integration
+ */
+class InfoDto {
+    constructor() {
+        /**
+         * Actions that are not supported by the integration.
+         */
+        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)(),
+    (0, class_validator_1.IsEnum)(language_enum_1.LanguageEnum, { each: true }),
+    __metadata("design:type", Array)
+], InfoDto.prototype, "supported_languages", void 0);
+__decorate([
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    (0, class_transformer_1.Type)(() => field_dto_1.FieldDto),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Array)
+], InfoDto.prototype, "product_attributes", void 0);
+__decorate([
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    (0, class_transformer_1.Type)(() => field_dto_1.FieldDto),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Array)
+], InfoDto.prototype, "item_attributes", void 0);
+__decorate([
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.IsEnum)(events_enum_1.EventsEnum, { each: true }),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Array)
+], InfoDto.prototype, "listen_events", void 0);
+__decorate([
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.IsEnum)(roles_enum_1.RolesEnum, { each: true }),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Array)
+], InfoDto.prototype, "requiredRoles", void 0);
+__decorate([
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.IsEnum)(actions_enum_1.ActionsEnum, { each: true }),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Array)
+], InfoDto.prototype, "unsupportedActions", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => AdminPanelDto),
+    __metadata("design:type", AdminPanelDto)
+], InfoDto.prototype, "adminPanel", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => ClientPanelDto),
+    __metadata("design:type", ClientPanelDto)
+], InfoDto.prototype, "clientPanel", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsUrl)(),
+    __metadata("design:type", String)
+], InfoDto.prototype, "onboardingUrl", void 0);
+__decorate([
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    (0, class_transformer_1.Type)(() => unit_dto_1.UnitDto),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Array)
+], InfoDto.prototype, "payPerUseUnits", void 0);
+__decorate([
+    (0, class_validator_1.IsObject)(),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Object)
+], InfoDto.prototype, "responseDataFieldNames", void 0);
 /**
  * DTO for tabs
  * Used for defining tabs in the user interface
@@ -55,42 +154,125 @@ __decorate([
     __metadata("design:type", Array)
 ], MenuDto.prototype, "tabs", void 0);
 /**
- * DTO for integration information
- * Contains all information related to a service integration
+ * DTO for the tabs in the admin panel.
  */
-class InfoDto {
-    constructor() {
-        this.unsupportedActions = [];
-    }
+class AdminPanelTabsDto {
 }
-exports.InfoDto = InfoDto;
 __decorate([
-    (0, class_validator_1.IsString)(),
-    (0, class_validator_1.IsNotEmpty)(),
-    __metadata("design:type", String)
-], InfoDto.prototype, "title", void 0);
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    (0, class_transformer_1.Type)(() => TabDto),
+    __metadata("design:type", Array)
+], AdminPanelTabsDto.prototype, "product", void 0);
 __decorate([
-    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    (0, class_transformer_1.Type)(() => TabDto),
+    __metadata("design:type", Array)
+], AdminPanelTabsDto.prototype, "item", void 0);
+__decorate([
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    (0, class_transformer_1.Type)(() => TabDto),
+    __metadata("design:type", Array)
+], AdminPanelTabsDto.prototype, "client", void 0);
+__decorate([
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    (0, class_transformer_1.Type)(() => TabDto),
+    __metadata("design:type", Array)
+], AdminPanelTabsDto.prototype, "order", void 0);
+/**
+ * DTO for actions available in a panel.
+ */
+class PanelActionsDto {
+}
+__decorate([
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    (0, class_transformer_1.Type)(() => action_dto_1.ActionDto),
     (0, class_validator_1.IsOptional)(),
-    __metadata("design:type", String)
-], InfoDto.prototype, "logo", void 0);
+    __metadata("design:type", Array)
+], PanelActionsDto.prototype, "client", void 0);
 __decorate([
-    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    (0, class_transformer_1.Type)(() => action_dto_1.ActionDto),
     (0, class_validator_1.IsOptional)(),
-    __metadata("design:type", String)
-], InfoDto.prototype, "description", void 0);
+    __metadata("design:type", Array)
+], PanelActionsDto.prototype, "item", void 0);
+/**
+ * DTO for the admin panel configuration.
+ */
+class AdminPanelDto {
+}
 __decorate([
-    (0, class_validator_1.IsArray)({ each: true }),
-    (0, class_validator_1.IsEnum)(language_enum_1.LanguageEnum),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => AdminPanelTabsDto),
+    __metadata("design:type", AdminPanelTabsDto)
+], AdminPanelDto.prototype, "tabs", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => PanelActionsDto),
+    __metadata("design:type", PanelActionsDto)
+], AdminPanelDto.prototype, "moreActions", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => MenuDto),
+    __metadata("design:type", MenuDto)
+], AdminPanelDto.prototype, "menu", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => MenuDto),
+    __metadata("design:type", MenuDto)
+], AdminPanelDto.prototype, "settings", void 0);
+/**
+ * DTO for the tabs in the client panel.
+ */
+class ClientPanelTabsDto {
+}
+__decorate([
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    (0, class_transformer_1.Type)(() => TabDto),
     __metadata("design:type", Array)
-], InfoDto.prototype, "supported_languages", void 0);
+], ClientPanelTabsDto.prototype, "item", void 0);
+/**
+ * DTO for actions available in the client panel.
+ */
+class ClientPanelActionsDto {
+}
 __decorate([
     (0, class_validator_1.IsArray)(),
-    (0, class_validator_1.IsEnum)(roles_enum_1.RolesEnum, { each: true }),
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    (0, class_transformer_1.Type)(() => action_dto_1.ActionDto),
+    (0, class_validator_1.IsOptional)(),
     __metadata("design:type", Array)
-], InfoDto.prototype, "requiredRoles", void 0);
+], ClientPanelActionsDto.prototype, "item", void 0);
+/**
+ * DTO for the client panel configuration.
+ */
+class ClientPanelDto {
+}
 __decorate([
     (0, class_validator_1.IsOptional)(),
-    (0, class_validator_1.IsUrl)(),
-    __metadata("design:type", String)
-], InfoDto.prototype, "onboardingUrl", void 0);
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => ClientPanelTabsDto),
+    __metadata("design:type", ClientPanelTabsDto)
+], ClientPanelDto.prototype, "tabs", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => ClientPanelActionsDto),
+    __metadata("design:type", ClientPanelActionsDto)
+], ClientPanelDto.prototype, "moreActions", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => MenuDto),
+    __metadata("design:type", MenuDto)
+], ClientPanelDto.prototype, "menu", void 0);

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@hosterai/types",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "generate:schemas": "./generators/generate-schemas.sh && ./generators/post-process-schemas.js",
     "generate": "./generators/generate.ts",
     "generate:all": "./generators/generate.ts all",
-    "build": "tsc"
+    "build": "tsc",
+    "publish": "npm run build && npm publish"
   },
   "keywords": [],
   "author": "",