@hosterai/types 0.0.1 → 0.0.3

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

@@ -45,4 +45,8 @@ export declare class FieldDto {
      * Error message for the field
      */
     remoteValidationErrorMessage?: MultilangTextDto[];
+    /**
+     * The item attribute is upgradeable
+     */
+    upgradeable: boolean;
 }

package/dist/dtos/field.dto.js

@@ -2,5 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FieldDto = void 0;
 class FieldDto {
+    constructor() {
+        /**
+         * The item attribute is upgradeable
+         */
+        this.upgradeable = false;
+    }
 }
 exports.FieldDto = FieldDto;

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

@@ -6,41 +6,8 @@ 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[];
-}
+import { TabDto } from '../tab.dto';
+import { MenuDto } from '../menu.dto';
 /**
  * DTO for integration information
  * Contains all information related to a service integration
@@ -58,39 +25,117 @@ export declare class InfoDto {
      * 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
-    */
+     * The roles that need to be accepted by the company
+     */
     requiredRoles?: RolesEnum[];
-    unsupportedActions: ActionsEnum[];
+    /**
+     * 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.
+     */
     adminPanel?: {
-        productTabs?: TabDto[];
-        actions?: {
+        /** Tab groups for different admin panel sections in the admin panel. */
+        tabs?: {
+            /** Tabs related to products. */
+            product: TabDto[];
+            /** Tabs related to items. */
+            item: TabDto[];
+            /** Tabs related to clients. */
+            client: TabDto[];
+            /** Tabs related to users. */
+            user: TabDto[];
+            /** Tabs related to orders. */
+            order: TabDto[];
+        };
+        /** Additional actions available in the admin panel. */
+        moreActions?: {
+            /** Actions related to clients. */
             client?: ActionDto[];
+            /** Actions related to items. */
             item?: ActionDto[];
+            /** Actions related to invoices. */
+            invoice?: ActionDto[];
+            /** Actions related to users. */
+            user?: ActionDto[];
+            /** Actions related to orders. */
+            order?: ActionDto[];
         };
+        /** Main menu for the admin panel. Extends TabDto and adds icon information */
         menu?: MenuDto;
-        /**
-        * Option that will appear in the "Settings" section (optional)
-        */
-        settings?: MenuDto;
+        /** Settings menu for the admin panel. Extends TabDto and adds icon information */
+        settings: {
+            label: string;
+            icon: string;
+            descrition: string;
+        } & ({
+            url: string;
+            tabs?: never;
+        } | // If url is provided, tabs should not be present
+        {
+            url?: never;
+            tabs: [TabDto, ...TabDto[]];
+        });
     };
+    /**
+     * Configuration for the client panel.
+     * Contains all UI and action configuration for the client interface.
+     */
     clientPanel?: {
-        productTabs?: TabDto[];
-        actions?: {
+        /** Tab groups for the client panel. */
+        tabs?: {
+            /** Tabs related to items. */
+            item: TabDto[];
+        };
+        /** Additional actions available in the client panel. */
+        moreActions?: {
+            /** Actions related to items. */
             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.
+         */
         menu?: MenuDto;
     };
     /**
      * 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
      */
     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>;
 }
-export {};

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

@@ -1,96 +1,16 @@
 "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() {
+        /**
+         * 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)({ 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/menu.dto.d.ts

@@ -0,0 +1,44 @@
+import { SubmenuDto } from "./tab.dto";
+/**
+ * Base properties shared by all menu items
+ */
+interface BaseMenuDto {
+    /**
+     * The icon to be displayed for the menu item
+     */
+    icon: string;
+    /**
+     * The name to be displayed for the menu item
+     */
+    label: string;
+}
+/**
+ * Menu item with URL (no submenu)
+ */
+export interface MenuDtoWithUrl extends BaseMenuDto {
+    type: 'url';
+    /**
+     * 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;
+    submenu?: never;
+}
+/**
+ * Menu item with submenu (no URL)
+ */
+export interface MenuDtoWithSubmenu extends BaseMenuDto {
+    type: 'submenu';
+    url?: never;
+    /**
+     * 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.
+     */
+    submenu: SubmenuDto[];
+}
+/**
+ * Union type that ensures a menu item has either a URL or a submenu, but never both
+ */
+export type MenuDto = MenuDtoWithUrl | MenuDtoWithSubmenu;
+export {};

package/dist/dtos/menu.dto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,18 @@
+/**
+ * DTO for tabs
+ * Used for defining tabs in the user interface
+ */
+export 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;
+}
+export declare class SubmenuDto extends TabDto {
+}

package/dist/dtos/tab.dto.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubmenuDto = exports.TabDto = void 0;
+/**
+ * DTO for tabs
+ * Used for defining tabs in the user interface
+ */
+class TabDto {
+}
+exports.TabDto = TabDto;
+class SubmenuDto extends TabDto {
+}
+exports.SubmenuDto = SubmenuDto;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hosterai/types",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {