@trackunit/iris-app-api 0.0.103 → 0.0.105

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [0.0.105](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.104...iris-app-api/0.0.105) (2023-07-17)
+
+## [0.0.104](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.103...iris-app-api/0.0.104) (2023-07-17)
+
 ## [0.0.103](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.2-alpha-mta.0...iris-app-api/0.0.103) (2023-07-03)
 
 ## [0.0.102](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.101...iris-app-api/0.0.102) (2023-06-20)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/iris-app-api",
-  "version": "0.0.103",
+  "version": "0.0.105",
   "license": "SEE LICENSE IN LICENSE.txt",
   "repository": "https://github.com/Trackunit/manager",
   "engines": {

package/src/types/extensions/adminExtensionManifest.d.ts

@@ -0,0 +1,17 @@
+import { AbstractExtensionManifest, RequiredPermission, TranslationKey, Translations } from "../irisAppExtensionManifest";
+export interface AdminExtensionManifest extends AbstractExtensionManifest {
+    type: "ADMIN_EXTENSION";
+    /**
+     * Conditions for the admin extension to be shown.
+     *
+     * Its doing OR between the conditions of the same type:
+     * - If only 1 requiredPermission is used/filled out then the admin home extension will be shown if user has the required permission.
+     * - If more requiredPermission are used/filled out then the admin home extension will be shown for all assets that the user has one of the required permission for.
+     */
+    conditions?: {
+        requiredPermission?: RequiredPermission | RequiredPermission[];
+    };
+    menuItem: {
+        name: string | Translations | TranslationKey;
+    };
+}

package/src/types/extensions/adminExtensionManifest.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=adminExtensionManifest.js.map

package/src/types/extensions/adminExtensionManifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adminExtensionManifest.js","sourceRoot":"","sources":["../../../../../../../libs/iris-app-sdk/iris-app-api/src/types/extensions/adminExtensionManifest.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  AbstractExtensionManifest,\n  RequiredPermission,\n  TranslationKey,\n  Translations,\n} from \"../irisAppExtensionManifest\";\n\nexport interface AdminExtensionManifest extends AbstractExtensionManifest {\n  type: \"ADMIN_EXTENSION\";\n\n  /**\n   * Conditions for the admin extension to be shown.\n   *\n   * Its doing OR between the conditions of the same type:\n   * - If only 1 requiredPermission is used/filled out then the admin home extension will be shown if user has the required permission.\n   * - If more requiredPermission are used/filled out then the admin home extension will be shown for all assets that the user has one of the required permission for.\n   */\n  conditions?: {\n    requiredPermission?: RequiredPermission | RequiredPermission[];\n  };\n\n  menuItem: {\n    name: string | Translations | TranslationKey;\n  };\n}\n"]}

package/src/types/extensions/assetHomeExtensionManifest.d.ts

@@ -0,0 +1,24 @@
+import { AbstractExtensionManifest, RequiredPermission, TranslationKey, Translations } from "../irisAppExtensionManifest";
+export interface AssetHomeExtensionManifest extends AbstractExtensionManifest {
+    type: "ASSET_HOME_EXTENSION";
+    /**
+     * Conditions for the asset home extension to be shown.
+     * model and brand is case insensitive so does not matter how you write the brand.
+     *  brand: "trackunit" and brand: "Trackunit" will be the same.
+     *
+     * Its doing AND between the conditions types and OR between the conditions of the same type:
+     * - If both model and brand are used/filled out then asset needs to match both model and brand.
+     * - If only brand or model is used/filled out then the asset needs to match the filled out property.
+     * - If only requiredPermissions is used/filled out then the asset home extension will be shown for all assets that the user has the required permission for.
+     * - If more requiredPermissions are used/filled out then the asset home extension will be shown for all assets that the user has one of the required permission for.
+     * - If no conditions are used/filled out then the asset home extension will be shown for all assets.
+     */
+    conditions?: {
+        model?: string[] | string;
+        brand?: string[] | string;
+        requiredPermission?: RequiredPermission | RequiredPermission[];
+    };
+    menuItem: {
+        name: string | Translations | TranslationKey;
+    };
+}

package/src/types/extensions/assetHomeExtensionManifest.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=assetHomeExtensionManifest.js.map

package/src/types/extensions/assetHomeExtensionManifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assetHomeExtensionManifest.js","sourceRoot":"","sources":["../../../../../../../libs/iris-app-sdk/iris-app-api/src/types/extensions/assetHomeExtensionManifest.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  AbstractExtensionManifest,\n  RequiredPermission,\n  TranslationKey,\n  Translations,\n} from \"../irisAppExtensionManifest\";\n\nexport interface AssetHomeExtensionManifest extends AbstractExtensionManifest {\n  type: \"ASSET_HOME_EXTENSION\";\n  /**\n   * Conditions for the asset home extension to be shown.\n   * model and brand is case insensitive so does not matter how you write the brand.\n   *  brand: \"trackunit\" and brand: \"Trackunit\" will be the same.\n   *\n   * Its doing AND between the conditions types and OR between the conditions of the same type:\n   * - If both model and brand are used/filled out then asset needs to match both model and brand.\n   * - If only brand or model is used/filled out then the asset needs to match the filled out property.\n   * - If only requiredPermissions is used/filled out then the asset home extension will be shown for all assets that the user has the required permission for.\n   * - If more requiredPermissions are used/filled out then the asset home extension will be shown for all assets that the user has one of the required permission for.\n   * - If no conditions are used/filled out then the asset home extension will be shown for all assets.\n   */\n  conditions?: {\n    model?: string[] | string;\n    brand?: string[] | string;\n    requiredPermission?: RequiredPermission | RequiredPermission[];\n  };\n  menuItem: {\n    name: string | Translations | TranslationKey;\n  };\n}\n"]}

package/src/types/extensions/fleetExtensionManifest.d.ts

@@ -0,0 +1,25 @@
+import { AbstractExtensionManifest, RequiredPermission, TranslationKey, Translations } from "../irisAppExtensionManifest";
+export interface FleetExtensionManifest extends AbstractExtensionManifest {
+    type: "FLEET_EXTENSION";
+    /**
+     * Conditions for the fleet extension to be shown.
+     * It is case insensitive so does not matter how you write the brand.
+     *  brand: "trackunit" and brand: "Trackunit" will be the same.
+     *
+     * Its doing AND between the conditions types and OR between the conditions of the same type:
+     * - If both model and brand are used/filled out then asset needs to match both model and brand.
+     * - If only brand or model is used/filled out then the asset needs to match the filled out property.
+     * - If only requiredPermission is used/filled out then the fleet extension will be shown if the user has the required permission.
+     * - If more requiredPermissions are used/filled out then the fleet extension will be shown if the user has one of the required permissions.
+     * - If no conditions are used/filled out then the asset home extension will be shown for all assets.
+     */
+    conditions?: {
+        model?: string[] | string;
+        brand?: string[] | string;
+        requiredPermission?: RequiredPermission | RequiredPermission[];
+    };
+    menuItem: {
+        name: string | Translations | TranslationKey;
+        icon: string;
+    };
+}

package/src/types/extensions/fleetExtensionManifest.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=fleetExtensionManifest.js.map

package/src/types/extensions/fleetExtensionManifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fleetExtensionManifest.js","sourceRoot":"","sources":["../../../../../../../libs/iris-app-sdk/iris-app-api/src/types/extensions/fleetExtensionManifest.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  AbstractExtensionManifest,\n  RequiredPermission,\n  TranslationKey,\n  Translations,\n} from \"../irisAppExtensionManifest\";\n\nexport interface FleetExtensionManifest extends AbstractExtensionManifest {\n  type: \"FLEET_EXTENSION\";\n\n  /**\n   * Conditions for the fleet extension to be shown.\n   * It is case insensitive so does not matter how you write the brand.\n   *  brand: \"trackunit\" and brand: \"Trackunit\" will be the same.\n   *\n   * Its doing AND between the conditions types and OR between the conditions of the same type:\n   * - If both model and brand are used/filled out then asset needs to match both model and brand.\n   * - If only brand or model is used/filled out then the asset needs to match the filled out property.\n   * - If only requiredPermission is used/filled out then the fleet extension will be shown if the user has the required permission.\n   * - If more requiredPermissions are used/filled out then the fleet extension will be shown if the user has one of the required permissions.\n   * - If no conditions are used/filled out then the asset home extension will be shown for all assets.\n   */\n  conditions?: {\n    model?: string[] | string;\n    brand?: string[] | string;\n    requiredPermission?: RequiredPermission | RequiredPermission[];\n  };\n  menuItem: {\n    name: string | Translations | TranslationKey;\n    icon: string;\n  };\n}\n"]}

package/src/types/extensions/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./adminExtensionManifest";
+export * from "./assetHomeExtensionManifest";
+export * from "./fleetExtensionManifest";
+export * from "./irisAppSettingsExtensionManifest";
+export * from "./reportExtensionManifest";
+export * from "./siteHomeExtensionManifest";

package/src/types/extensions/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./adminExtensionManifest"), exports);
+tslib_1.__exportStar(require("./assetHomeExtensionManifest"), exports);
+tslib_1.__exportStar(require("./fleetExtensionManifest"), exports);
+tslib_1.__exportStar(require("./irisAppSettingsExtensionManifest"), exports);
+tslib_1.__exportStar(require("./reportExtensionManifest"), exports);
+tslib_1.__exportStar(require("./siteHomeExtensionManifest"), exports);
+//# sourceMappingURL=index.js.map

package/src/types/extensions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../libs/iris-app-sdk/iris-app-api/src/types/extensions/index.ts"],"names":[],"mappings":";;;AAAA,mEAAyC;AACzC,uEAA6C;AAC7C,mEAAyC;AACzC,6EAAmD;AACnD,oEAA0C;AAC1C,sEAA4C","sourcesContent":["export * from \"./adminExtensionManifest\";\nexport * from \"./assetHomeExtensionManifest\";\nexport * from \"./fleetExtensionManifest\";\nexport * from \"./irisAppSettingsExtensionManifest\";\nexport * from \"./reportExtensionManifest\";\nexport * from \"./siteHomeExtensionManifest\";\n"]}

package/src/types/extensions/irisAppSettingsExtensionManifest.d.ts

@@ -0,0 +1,4 @@
+import { AbstractExtensionManifest } from "../irisAppExtensionManifest";
+export interface IrisAppSettingsExtensionManifest extends AbstractExtensionManifest {
+    type: "IRIS_APP_SETTINGS_EXTENSION";
+}

package/src/types/extensions/irisAppSettingsExtensionManifest.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=irisAppSettingsExtensionManifest.js.map

package/src/types/extensions/irisAppSettingsExtensionManifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"irisAppSettingsExtensionManifest.js","sourceRoot":"","sources":["../../../../../../../libs/iris-app-sdk/iris-app-api/src/types/extensions/irisAppSettingsExtensionManifest.ts"],"names":[],"mappings":"","sourcesContent":["import { AbstractExtensionManifest } from \"../irisAppExtensionManifest\";\n\nexport interface IrisAppSettingsExtensionManifest extends AbstractExtensionManifest {\n  type: \"IRIS_APP_SETTINGS_EXTENSION\";\n}\n"]}

package/src/types/extensions/reportExtensionManifest.d.ts

@@ -0,0 +1,19 @@
+import { AbstractExtensionManifest, TranslationKey, Translations } from "../irisAppExtensionManifest";
+export interface ReportExtensionManifest extends AbstractExtensionManifest {
+    type: "REPORT_EXTENSION";
+    menuItem: {
+        /**
+         * Title of the card in manager
+         */
+        name: string | Translations | TranslationKey;
+        /**
+         * Subtitle of the card in manager
+         */
+        description: string | Translations | TranslationKey;
+        /**
+         * Icon of the card in manager, must use icons from:
+         * https://apps.dev.iris.trackunit.com/storybook/?path=/docs/components-icon--default
+         */
+        icon: string;
+    };
+}

package/src/types/extensions/reportExtensionManifest.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=reportExtensionManifest.js.map

package/src/types/extensions/reportExtensionManifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reportExtensionManifest.js","sourceRoot":"","sources":["../../../../../../../libs/iris-app-sdk/iris-app-api/src/types/extensions/reportExtensionManifest.ts"],"names":[],"mappings":"","sourcesContent":["import { AbstractExtensionManifest, TranslationKey, Translations } from \"../irisAppExtensionManifest\";\n\nexport interface ReportExtensionManifest extends AbstractExtensionManifest {\n  type: \"REPORT_EXTENSION\";\n\n  menuItem: {\n    /**\n     * Title of the card in manager\n     */\n    name: string | Translations | TranslationKey;\n\n    /**\n     * Subtitle of the card in manager\n     */\n    description: string | Translations | TranslationKey;\n\n    /**\n     * Icon of the card in manager, must use icons from:\n     * https://apps.dev.iris.trackunit.com/storybook/?path=/docs/components-icon--default\n     */\n    icon: string;\n  };\n}\n"]}

package/src/types/extensions/siteHomeExtensionManifest.d.ts

@@ -0,0 +1,18 @@
+import { AbstractExtensionManifest, RequiredPermission, TranslationKey, Translations } from "../irisAppExtensionManifest";
+export interface SiteHomeExtensionManifest extends AbstractExtensionManifest {
+    type: "SITE_HOME_EXTENSION";
+    /**
+     * Conditions for the site home extension to be shown.
+     *
+     * Its doing AND between the conditions types and OR between the conditions of the same type:
+     * - If only requiredPermission is used/filled out then the site home extension will be shown for all sites that the user has the required permission for.
+     * - If more requiredPermission are used/filled out then the site home extension will be shown for all sites that the user has one of the required permission for.
+     * - If no conditions are used/filled out then the site home extension will be shown for all sites.
+     */
+    conditions?: {
+        requiredPermission?: RequiredPermission | RequiredPermission[];
+    };
+    menuItem: {
+        name: string | Translations | TranslationKey;
+    };
+}

package/src/types/extensions/siteHomeExtensionManifest.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=siteHomeExtensionManifest.js.map

package/src/types/extensions/siteHomeExtensionManifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"siteHomeExtensionManifest.js","sourceRoot":"","sources":["../../../../../../../libs/iris-app-sdk/iris-app-api/src/types/extensions/siteHomeExtensionManifest.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  AbstractExtensionManifest,\n  RequiredPermission,\n  TranslationKey,\n  Translations,\n} from \"../irisAppExtensionManifest\";\n\nexport interface SiteHomeExtensionManifest extends AbstractExtensionManifest {\n  type: \"SITE_HOME_EXTENSION\";\n\n  /**\n   * Conditions for the site home extension to be shown.\n   *\n   * Its doing AND between the conditions types and OR between the conditions of the same type:\n   * - If only requiredPermission is used/filled out then the site home extension will be shown for all sites that the user has the required permission for.\n   * - If more requiredPermission are used/filled out then the site home extension will be shown for all sites that the user has one of the required permission for.\n   * - If no conditions are used/filled out then the site home extension will be shown for all sites.\n   */\n  conditions?: {\n    requiredPermission?: RequiredPermission | RequiredPermission[];\n  };\n\n  menuItem: {\n    name: string | Translations | TranslationKey;\n  };\n}\n"]}

package/src/types/index.d.ts

@@ -1,5 +1,11 @@
 export * from "./defaultValidHosts";
+export * from "./extensions";
 export * from "./irisAppCspInput";
+export * from "./irisAppCustomFields";
+export * from "./irisAppExtensionManifest";
+export * from "./irisAppInstallationConfig";
 export * from "./irisAppManifest";
+export * from "./irisAppMarketplace";
 export * from "./mocks";
 export * from "./modulefederation";
+export * from "./subscriptionPackages";

package/src/types/index.js

@@ -2,8 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./defaultValidHosts"), exports);
+tslib_1.__exportStar(require("./extensions"), exports);
 tslib_1.__exportStar(require("./irisAppCspInput"), exports);
+tslib_1.__exportStar(require("./irisAppCustomFields"), exports);
+tslib_1.__exportStar(require("./irisAppExtensionManifest"), exports);
+tslib_1.__exportStar(require("./irisAppInstallationConfig"), exports);
 tslib_1.__exportStar(require("./irisAppManifest"), exports);
+tslib_1.__exportStar(require("./irisAppMarketplace"), exports);
 tslib_1.__exportStar(require("./mocks"), exports);
 tslib_1.__exportStar(require("./modulefederation"), exports);
+tslib_1.__exportStar(require("./subscriptionPackages"), exports);
 //# sourceMappingURL=index.js.map

package/src/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/index.ts"],"names":[],"mappings":";;;AAAA,8DAAoC;AACpC,4DAAkC;AAClC,4DAAkC;AAClC,kDAAwB;AACxB,6DAAmC","sourcesContent":["export * from \"./defaultValidHosts\";\nexport * from \"./irisAppCspInput\";\nexport * from \"./irisAppManifest\";\nexport * from \"./mocks\";\nexport * from \"./modulefederation\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/index.ts"],"names":[],"mappings":";;;AAAA,8DAAoC;AACpC,uDAA6B;AAC7B,4DAAkC;AAClC,gEAAsC;AACtC,qEAA2C;AAC3C,sEAA4C;AAC5C,4DAAkC;AAClC,+DAAqC;AACrC,kDAAwB;AACxB,6DAAmC;AACnC,iEAAuC","sourcesContent":["export * from \"./defaultValidHosts\";\nexport * from \"./extensions\";\nexport * from \"./irisAppCspInput\";\nexport * from \"./irisAppCustomFields\";\nexport * from \"./irisAppExtensionManifest\";\nexport * from \"./irisAppInstallationConfig\";\nexport * from \"./irisAppManifest\";\nexport * from \"./irisAppMarketplace\";\nexport * from \"./mocks\";\nexport * from \"./modulefederation\";\nexport * from \"./subscriptionPackages\";\n"]}

package/src/types/irisAppCustomFields.d.ts

@@ -0,0 +1,125 @@
+export declare type CustomFieldDefinitionType = "STRING" | "NUMBER" | "DATE" | "BOOLEAN" | "DROPDOWN" | "EMAIL" | "PHONE_NUMBER" | "WEB_ADDRESS";
+export declare type EntityType = "ASSET" | "ACCOUNT" | "SITE" | "GROUP";
+export interface AbstractCustomFieldDefinition {
+    /**
+     * The key is the name you use to get the custom field.
+     */
+    key: string;
+    /**
+     * The type of the entity to attach this custom field on.
+     */
+    entityType: EntityType;
+    /**
+     * The human readable translation of the key. So what the end customer will see.
+     */
+    title: string;
+    /**
+     * Should this be visible in the generic UI in Manager.
+     */
+    uiVisible?: boolean;
+    /**
+     * Should this be editable in the generic UI in Manager. This does not mean you cannot change it inside a app.
+     */
+    uiEditable?: boolean;
+    /**
+     * The type of this custom field definition
+     */
+    type: CustomFieldDefinitionType;
+}
+export interface StringFieldDefinition extends AbstractCustomFieldDefinition {
+    type: "STRING";
+    minimumLength?: number;
+    maximumLength?: number;
+    pattern?: string;
+    defaultStringValue?: string;
+}
+export interface EmailFieldDefinition extends AbstractCustomFieldDefinition {
+    type: "EMAIL";
+    defaultStringValue?: string;
+}
+export interface WebAddressFieldDefinition extends AbstractCustomFieldDefinition {
+    type: "WEB_ADDRESS";
+    defaultStringValue?: string;
+}
+export interface PhoneNumberFieldDefinition extends AbstractCustomFieldDefinition {
+    type: "PHONE_NUMBER";
+    defaultStringValue?: string;
+}
+export interface BooleanFieldDefinition extends AbstractCustomFieldDefinition {
+    type: "BOOLEAN";
+    defaultBooleanValue?: boolean;
+}
+export interface DateFieldDefinition extends AbstractCustomFieldDefinition {
+    type: "DATE";
+    defaultDateValue?: string;
+}
+export interface DropDownFieldDefinition extends AbstractCustomFieldDefinition {
+    type: "DROPDOWN";
+    defaultStringArrayValue?: string[];
+    multiSelect?: boolean;
+    allValues?: string[];
+    /**
+     * Map from old values not in {@link allValues} to new values. Used for updating existing data when changing
+     * the drop down options.
+     */
+    valueReplacements?: Record<string, string>;
+}
+export declare enum UnitUs {
+    "mi" = "mi",
+    "yd" = "yd",
+    "ft" = "ft",
+    "in" = "in",
+    "ac" = "ac",
+    "ha" = "ha",
+    "ft_2" = "ft\u00B2",
+    "gal" = "gal",
+    "ft_3" = "ft\u00B3",
+    "ton_us" = "ton_us",
+    "lb" = "lb",
+    "oz" = "oz",
+    "mph" = "mph",
+    "lb_h" = "lb/h",
+    "lb_s" = "lb/s"
+}
+export declare enum UnitSi {
+    "km" = "km",
+    "m" = "m",
+    "cm" = "cm",
+    "mm" = "mm",
+    "l" = "l",
+    "kg" = "kg",
+    "g" = "g",
+    "ton" = "ton",
+    "N" = "N",
+    "kW" = "kW",
+    "W" = "W",
+    "kWh" = "kWh",
+    "kPa" = "kPa",
+    "Pa" = "Pa",
+    "bar" = "bar",
+    "m_s" = "m/s",
+    "kg_h" = "kg/h",
+    "kg_s" = "kg/s",
+    "km_h" = "km/h",
+    "km_2" = "km\u00B2",
+    "m_2" = "m\u00B2",
+    "m_3" = "m\u00B3",
+    "m_s_2" = "m/s\u00B2",
+    "h" = "h"
+}
+export interface DecimalNumberFieldDefinition extends AbstractCustomFieldDefinition {
+    type: "NUMBER";
+    defaultNumberValue?: number;
+    minimum?: number;
+    maximum?: number;
+    unitSi?: UnitSi;
+    unitUs?: UnitUs;
+    isInteger: false;
+}
+export interface IntegerNumberFieldDefinition extends AbstractCustomFieldDefinition {
+    type: "NUMBER";
+    defaultNumberValue?: number;
+    minimum?: number;
+    maximum?: number;
+    isInteger: true;
+}

package/src/types/irisAppCustomFields.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnitSi = exports.UnitUs = void 0;
+var UnitUs;
+(function (UnitUs) {
+    UnitUs["mi"] = "mi";
+    UnitUs["yd"] = "yd";
+    UnitUs["ft"] = "ft";
+    UnitUs["in"] = "in";
+    UnitUs["ac"] = "ac";
+    UnitUs["ha"] = "ha";
+    UnitUs["ft_2"] = "ft\u00B2";
+    UnitUs["gal"] = "gal";
+    UnitUs["ft_3"] = "ft\u00B3";
+    UnitUs["ton_us"] = "ton_us";
+    UnitUs["lb"] = "lb";
+    UnitUs["oz"] = "oz";
+    UnitUs["mph"] = "mph";
+    UnitUs["lb_h"] = "lb/h";
+    UnitUs["lb_s"] = "lb/s";
+})(UnitUs || (exports.UnitUs = UnitUs = {}));
+var UnitSi;
+(function (UnitSi) {
+    UnitSi["km"] = "km";
+    UnitSi["m"] = "m";
+    UnitSi["cm"] = "cm";
+    UnitSi["mm"] = "mm";
+    UnitSi["l"] = "l";
+    UnitSi["kg"] = "kg";
+    UnitSi["g"] = "g";
+    UnitSi["ton"] = "ton";
+    UnitSi["N"] = "N";
+    UnitSi["kW"] = "kW";
+    UnitSi["W"] = "W";
+    UnitSi["kWh"] = "kWh";
+    UnitSi["kPa"] = "kPa";
+    UnitSi["Pa"] = "Pa";
+    UnitSi["bar"] = "bar";
+    UnitSi["m_s"] = "m/s";
+    UnitSi["kg_h"] = "kg/h";
+    UnitSi["kg_s"] = "kg/s";
+    UnitSi["km_h"] = "km/h";
+    UnitSi["km_2"] = "km\u00B2";
+    UnitSi["m_2"] = "m\u00B2";
+    UnitSi["m_3"] = "m\u00B3";
+    UnitSi["m_s_2"] = "m/s\u00B2";
+    UnitSi["h"] = "h";
+})(UnitSi || (exports.UnitSi = UnitSi = {}));
+//# sourceMappingURL=irisAppCustomFields.js.map

package/src/types/irisAppCustomFields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"irisAppCustomFields.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/irisAppCustomFields.ts"],"names":[],"mappings":";;;AAwFA,IAAY,MAgBX;AAhBD,WAAY,MAAM;IAChB,mBAAW,CAAA;IACX,mBAAW,CAAA;IACX,mBAAW,CAAA;IACX,mBAAW,CAAA;IACX,mBAAW,CAAA;IACX,mBAAW,CAAA;IACX,2BAAc,CAAA;IACd,qBAAa,CAAA;IACb,2BAAc,CAAA;IACd,2BAAmB,CAAA;IACnB,mBAAW,CAAA;IACX,mBAAW,CAAA;IACX,qBAAa,CAAA;IACb,uBAAe,CAAA;IACf,uBAAe,CAAA;AACjB,CAAC,EAhBW,MAAM,sBAAN,MAAM,QAgBjB;AAED,IAAY,MAyBX;AAzBD,WAAY,MAAM;IAChB,mBAAW,CAAA;IACX,iBAAS,CAAA;IACT,mBAAW,CAAA;IACX,mBAAW,CAAA;IACX,iBAAS,CAAA;IACT,mBAAW,CAAA;IACX,iBAAS,CAAA;IACT,qBAAa,CAAA;IACb,iBAAS,CAAA;IACT,mBAAW,CAAA;IACX,iBAAS,CAAA;IACT,qBAAa,CAAA;IACb,qBAAa,CAAA;IACb,mBAAW,CAAA;IACX,qBAAa,CAAA;IACb,qBAAa,CAAA;IACb,uBAAe,CAAA;IACf,uBAAe,CAAA;IACf,uBAAe,CAAA;IACf,2BAAc,CAAA;IACd,yBAAY,CAAA;IACZ,yBAAY,CAAA;IACZ,6BAAgB,CAAA;IAChB,iBAAS,CAAA;AACX,CAAC,EAzBW,MAAM,sBAAN,MAAM,QAyBjB","sourcesContent":["export declare type CustomFieldDefinitionType =\n  | \"STRING\"\n  | \"NUMBER\"\n  | \"DATE\"\n  | \"BOOLEAN\"\n  | \"DROPDOWN\"\n  | \"EMAIL\"\n  | \"PHONE_NUMBER\"\n  | \"WEB_ADDRESS\";\n\nexport declare type EntityType = \"ASSET\" | \"ACCOUNT\" | \"SITE\" | \"GROUP\";\n\nexport interface AbstractCustomFieldDefinition {\n  /**\n   * The key is the name you use to get the custom field.\n   */\n  key: string;\n\n  /**\n   * The type of the entity to attach this custom field on.\n   */\n  entityType: EntityType;\n\n  /**\n   * The human readable translation of the key. So what the end customer will see.\n   */\n  title: string;\n\n  /**\n   * Should this be visible in the generic UI in Manager.\n   */\n  uiVisible?: boolean;\n\n  /**\n   * Should this be editable in the generic UI in Manager. This does not mean you cannot change it inside a app.\n   */\n  uiEditable?: boolean;\n\n  /**\n   * The type of this custom field definition\n   */\n  type: CustomFieldDefinitionType;\n}\n\nexport interface StringFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"STRING\";\n  minimumLength?: number;\n  maximumLength?: number;\n  pattern?: string;\n  defaultStringValue?: string;\n}\n\nexport interface EmailFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"EMAIL\";\n  defaultStringValue?: string;\n}\n\nexport interface WebAddressFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"WEB_ADDRESS\";\n  defaultStringValue?: string;\n}\n\nexport interface PhoneNumberFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"PHONE_NUMBER\";\n  defaultStringValue?: string;\n}\nexport interface BooleanFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"BOOLEAN\";\n  defaultBooleanValue?: boolean;\n}\n\nexport interface DateFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"DATE\";\n  defaultDateValue?: string;\n}\n\nexport interface DropDownFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"DROPDOWN\";\n  defaultStringArrayValue?: string[];\n  multiSelect?: boolean;\n  allValues?: string[];\n  /**\n   * Map from old values not in {@link allValues} to new values. Used for updating existing data when changing\n   * the drop down options.\n   */\n  valueReplacements?: Record<string, string>;\n}\n\nexport enum UnitUs {\n  \"mi\" = \"mi\",\n  \"yd\" = \"yd\",\n  \"ft\" = \"ft\",\n  \"in\" = \"in\",\n  \"ac\" = \"ac\",\n  \"ha\" = \"ha\",\n  \"ft_2\" = \"ft²\",\n  \"gal\" = \"gal\",\n  \"ft_3\" = \"ft³\",\n  \"ton_us\" = \"ton_us\",\n  \"lb\" = \"lb\",\n  \"oz\" = \"oz\",\n  \"mph\" = \"mph\",\n  \"lb_h\" = \"lb/h\",\n  \"lb_s\" = \"lb/s\",\n}\n\nexport enum UnitSi {\n  \"km\" = \"km\",\n  \"m\" = \"m\",\n  \"cm\" = \"cm\",\n  \"mm\" = \"mm\",\n  \"l\" = \"l\",\n  \"kg\" = \"kg\",\n  \"g\" = \"g\",\n  \"ton\" = \"ton\",\n  \"N\" = \"N\",\n  \"kW\" = \"kW\",\n  \"W\" = \"W\",\n  \"kWh\" = \"kWh\",\n  \"kPa\" = \"kPa\",\n  \"Pa\" = \"Pa\",\n  \"bar\" = \"bar\",\n  \"m_s\" = \"m/s\",\n  \"kg_h\" = \"kg/h\",\n  \"kg_s\" = \"kg/s\",\n  \"km_h\" = \"km/h\",\n  \"km_2\" = \"km²\",\n  \"m_2\" = \"m²\",\n  \"m_3\" = \"m³\",\n  \"m_s_2\" = \"m/s²\",\n  \"h\" = \"h\",\n}\nexport interface DecimalNumberFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"NUMBER\";\n  defaultNumberValue?: number;\n\n  minimum?: number;\n  maximum?: number;\n\n  unitSi?: UnitSi;\n  unitUs?: UnitUs;\n\n  isInteger: false;\n}\n\nexport interface IntegerNumberFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"NUMBER\";\n  defaultNumberValue?: number;\n\n  minimum?: number;\n  maximum?: number;\n\n  isInteger: true;\n}\n"]}

package/src/types/irisAppExtensionManifest.d.ts

@@ -0,0 +1,52 @@
+export declare type IrisAppExtensionType = "REPORT_EXTENSION" | "IRIS_APP_SETTINGS_EXTENSION" | "ADMIN_EXTENSION" | "FLEET_EXTENSION" | "ASSET_HOME_EXTENSION" | "SITE_HOME_EXTENSION";
+export interface RequiredPermission {
+    /**
+     *  The type of entity that the permission is required for.
+     */
+    entityType: "ACCOUNT";
+    /**
+     * The permission that is required for the app extension to be visible.
+     */
+    permission: string;
+}
+export interface AbstractExtensionManifest {
+    /** The id of the app extension, will be part of the URL in the manager */
+    id: string;
+    /**
+     * The path to the main entry point for the extension.
+     *
+     * @default "index.tsx"
+     */
+    main?: string;
+    /**
+     * The relative path from the NX workspace to this projects source Root.
+     */
+    sourceRoot: string;
+    /** The type of the app extension */
+    type: IrisAppExtensionType;
+}
+export interface Translations {
+    en: string;
+    da?: string;
+    de?: string;
+    cs?: string;
+    nl?: string;
+    fr?: string;
+    fi?: string;
+    hu?: string;
+    it?: string;
+    nb?: string;
+    pl?: string;
+    pt?: string;
+    ru?: string;
+    ro?: string;
+    es?: string;
+    sv?: string;
+    ja?: string;
+    th?: string;
+}
+export declare const languageKeys: readonly ["en", "da", "de", "cs", "nl", "fr", "fi", "hu", "it", "nb", "pl", "pt", "ru", "ro", "es", "sv", "ja", "th"];
+export type TranslationLanguageKeys = (typeof languageKeys)[number];
+export interface TranslationKey {
+    key: string;
+}

package/src/types/irisAppExtensionManifest.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.languageKeys = void 0;
+exports.languageKeys = [
+    "en",
+    "da",
+    "de",
+    "cs",
+    "nl",
+    "fr",
+    "fi",
+    "hu",
+    "it",
+    "nb",
+    "pl",
+    "pt",
+    "ru",
+    "ro",
+    "es",
+    "sv",
+    "ja",
+    "th",
+];
+//# sourceMappingURL=irisAppExtensionManifest.js.map

package/src/types/irisAppExtensionManifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"irisAppExtensionManifest.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/irisAppExtensionManifest.ts"],"names":[],"mappings":";;;AA6Da,QAAA,YAAY,GAAG;IAC1B,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;CACI,CAAC","sourcesContent":["export declare type IrisAppExtensionType =\n  | \"REPORT_EXTENSION\"\n  | \"IRIS_APP_SETTINGS_EXTENSION\"\n  | \"ADMIN_EXTENSION\"\n  | \"FLEET_EXTENSION\"\n  | \"ASSET_HOME_EXTENSION\"\n  | \"SITE_HOME_EXTENSION\";\n\nexport interface RequiredPermission {\n  /**\n   *  The type of entity that the permission is required for.\n   */\n  entityType: \"ACCOUNT\";\n\n  /**\n   * The permission that is required for the app extension to be visible.\n   */\n  permission: string;\n}\n\nexport interface AbstractExtensionManifest {\n  /** The id of the app extension, will be part of the URL in the manager */\n  id: string;\n\n  /**\n   * The path to the main entry point for the extension.\n   *\n   * @default \"index.tsx\"\n   */\n  main?: string;\n\n  /**\n   * The relative path from the NX workspace to this projects source Root.\n   */\n  sourceRoot: string;\n\n  /** The type of the app extension */\n  type: IrisAppExtensionType;\n}\n\nexport interface Translations {\n  en: string;\n  da?: string;\n  de?: string;\n  cs?: string;\n  nl?: string;\n  fr?: string;\n  fi?: string;\n  hu?: string;\n  it?: string;\n  nb?: string;\n  pl?: string;\n  pt?: string;\n  ru?: string;\n  ro?: string;\n  es?: string;\n  sv?: string;\n  ja?: string;\n  th?: string;\n}\n\nexport const languageKeys = [\n  \"en\",\n  \"da\",\n  \"de\",\n  \"cs\",\n  \"nl\",\n  \"fr\",\n  \"fi\",\n  \"hu\",\n  \"it\",\n  \"nb\",\n  \"pl\",\n  \"pt\",\n  \"ru\",\n  \"ro\",\n  \"es\",\n  \"sv\",\n  \"ja\",\n  \"th\",\n] as const;\n\nexport type TranslationLanguageKeys = (typeof languageKeys)[number];\n\nexport interface TranslationKey {\n  key: string;\n}\n"]}

package/src/types/irisAppInstallationConfig.d.ts

@@ -0,0 +1,24 @@
+import { SubscriptionPackage } from "./subscriptionPackages";
+export type InstallationPolicy = "PERMANENT" | "PREINSTALLED" | "ON_DEMAND" | "ON_DEMAND_REQUIRES_APPROVAL" | "PREINSTALLED_REQUIRES_APPROVAL";
+export interface InstallationConfig {
+    /**
+     * Installation policy for the app.
+     *
+     * - `PERMANENT`: Always installed and cannot be removed by the end customer.
+     * - `PREINSTALLED`: Initially installed and can be removed by the end customer.
+     * - `ON_DEMAND`: Available to be installed and removed by the end customer.
+     * - `ON_DEMAND_REQUIRES_APPROVAL`: Requires approval by the Trackunit billing team before the end customer can install it. Behaves like 'ON_DEMAND' after receiving approval.
+     * - `PREINSTALLED_REQUIRES_APPROVAL`: Requires approval by the Trackunit billing team and installs automatically once approved. Behaves like 'PREINSTALLED' after receiving approval.
+     *
+     * All policies will take into consideration both `accountIds` and `subscriptionPlan`.
+     */
+    policy: InstallationPolicy;
+    /**
+     * List of account IDs that can install this Iris App or `"ALL_ACCOUNTS"` if available for all customers.
+     */
+    accountIds: "ALL_ACCOUNTS" | string[];
+    /**
+     * List of pricing plans the Iris App is available at or `"ALL_PLANS"` if available in all plans.
+     */
+    pricingPlans: "ALL_PLANS" | SubscriptionPackage[];
+}

package/src/types/irisAppInstallationConfig.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=irisAppInstallationConfig.js.map

package/src/types/irisAppInstallationConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"irisAppInstallationConfig.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/irisAppInstallationConfig.ts"],"names":[],"mappings":"","sourcesContent":["import { SubscriptionPackage } from \"./subscriptionPackages\";\n\nexport type InstallationPolicy =\n  | \"PERMANENT\"\n  | \"PREINSTALLED\"\n  | \"ON_DEMAND\"\n  | \"ON_DEMAND_REQUIRES_APPROVAL\"\n  | \"PREINSTALLED_REQUIRES_APPROVAL\";\n\nexport interface InstallationConfig {\n  /**\n   * Installation policy for the app.\n   *\n   * - `PERMANENT`: Always installed and cannot be removed by the end customer.\n   * - `PREINSTALLED`: Initially installed and can be removed by the end customer.\n   * - `ON_DEMAND`: Available to be installed and removed by the end customer.\n   * - `ON_DEMAND_REQUIRES_APPROVAL`: Requires approval by the Trackunit billing team before the end customer can install it. Behaves like 'ON_DEMAND' after receiving approval.\n   * - `PREINSTALLED_REQUIRES_APPROVAL`: Requires approval by the Trackunit billing team and installs automatically once approved. Behaves like 'PREINSTALLED' after receiving approval.\n   *\n   * All policies will take into consideration both `accountIds` and `subscriptionPlan`.\n   */\n  policy: InstallationPolicy;\n  /**\n   * List of account IDs that can install this Iris App or `\"ALL_ACCOUNTS\"` if available for all customers.\n   */\n  accountIds: \"ALL_ACCOUNTS\" | string[];\n  /**\n   * List of pricing plans the Iris App is available at or `\"ALL_PLANS\"` if available in all plans.\n   */\n  pricingPlans: \"ALL_PLANS\" | SubscriptionPackage[];\n}\n"]}