@trackunit/iris-app-api 0.0.1-alpha-afcc978985.0

package/CHANGELOG.md

@@ -0,0 +1,54 @@
+# Changelog
+
+This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
+
+### [0.0.1-alpha-afcc978985.0](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.55...iris-app-api/0.0.1-alpha-afcc978985.0) (2022-11-04)
+
+### [0.0.55](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.54...iris-app-api/0.0.55) (2022-11-01)
+
+### [0.0.54](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.53...iris-app-api/0.0.54) (2022-10-27)
+
+### [0.0.53](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.52...iris-app-api/0.0.53) (2022-10-13)
+
+### [0.0.52](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.51...iris-app-api/0.0.52) (2022-10-06)
+
+### [0.0.51](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.50...iris-app-api/0.0.51) (2022-10-03)
+
+### [0.0.50](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.49...iris-app-api/0.0.50) (2022-09-26)
+
+### [0.0.49](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.48...iris-app-api/0.0.49) (2022-09-16)
+
+### [0.0.48](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.47...iris-app-api/0.0.48) (2022-09-15)
+
+### [0.0.47](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.46...iris-app-api/0.0.47) (2022-09-12)
+
+### [0.0.46](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.45...iris-app-api/0.0.46) (2022-09-12)
+
+
+### Reverts
+
+* Revert "ci: bump iris-app-api to 0.0.46-alpha-61732b8ce.0 [skip ci]" ([f5ae87d](https://github.com/Trackunit/manager/commit/f5ae87d93fe21d80bcaf6ed3c3dee4269ca3cbfe))
+
+### [0.0.45](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.44...iris-app-api/0.0.45) (2022-08-25)
+
+### [0.0.44](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.43...iris-app-api/0.0.44) (2022-08-17)
+
+### [0.0.43](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.42...iris-app-api/0.0.43) (2022-08-12)
+
+### [0.0.42](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.41...iris-app-api/0.0.42) (2022-08-05)
+
+### [0.0.41](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.40...iris-app-api/0.0.41) (2022-07-29)
+
+### [0.0.40](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.39...iris-app-api/0.0.40) (2022-07-29)
+
+### [0.0.39](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.38...iris-app-api/0.0.39) (2022-07-05)
+
+### [0.0.38](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.37...iris-app-api/0.0.38) (2022-06-28)
+
+### [0.0.37](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.36...iris-app-api/0.0.37) (2022-06-27)
+
+### [0.0.36](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.35...iris-app-api/0.0.36) (2022-06-26)
+
+### [0.0.35](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.34...iris-app-api/0.0.35) (2022-06-23)
+
+### [0.0.34](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.33...iris-app-api/0.0.34) (2022-06-20)

package/README.md

@@ -0,0 +1,19 @@
+> **⚠️ Beta**
+>
+> This is a beta version and subject to change without notice.
+
+# Trackunit Iris App API
+The `@trackunit/iris-app-api` package is a small package containing reusable types for the Trackunit Iris App SDK.
+
+Trackunit Iris Apps are used by external developers to integrate custom functionality into [the Trackunit Manager platform](https://www.trackunit.com/services/manager/).  
+
+For more info and a full guide on Iris App SDK Development, please visit our [Developer Hub](https://developers.trackunit.com/).
+
+## Basic Usage
+This package is not meant for isolated usage but is a part of the [`@trackunit/iris-app`](https://www.npmjs.com/package/@trackunit/iris-app) package.
+
+## Trackunit
+This package was developed by Trackunit ApS.
+Trackunit is the leading SaaS-based IoT solution for the construction industry, offering an ecosystem of hardware, fleet management software & telematics.
+
+![The Trackunit logo](https://trackunit.com/wp-content/uploads/2022/03/top-logo.svg)

package/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@trackunit/iris-app-api",
+  "version": "0.0.1-alpha-afcc978985.0",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "repository": "https://github.com/Trackunit/manager",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "dependencies": {
+    "tslib": "^2.4.0"
+  },
+  "peerDependencies": {}
+}

package/src/index.d.ts

@@ -0,0 +1 @@
+export * from "./types";

package/src/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../libs/iris-app-sdk/iris-app-api/src/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB","sourcesContent":["export * from \"./types\";\n"]}

package/src/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./irisAppManifest";
+export * from "./modulefederation";

package/src/types/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./irisAppManifest"), exports);
+tslib_1.__exportStar(require("./modulefederation"), exports);
+//# sourceMappingURL=index.js.map

package/src/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/index.ts"],"names":[],"mappings":";;;AAAA,4DAAkC;AAClC,6DAAmC","sourcesContent":["export * from \"./irisAppManifest\";\nexport * from \"./modulefederation\";\n"]}

package/src/types/irisAppManifest.d.ts

@@ -0,0 +1,377 @@
+export interface IrisAppManifest {
+    /**
+     * A spec version for the manifest.
+     * This should not be changed manually.
+     */
+    specVersion: "1.0";
+    /**
+     * The name of the exposed module from module federation build into the remoteEntry.js.
+     */
+    moduleFederationName: string;
+    /**
+     * A configuration object for handling scoped token acquisition.
+     */
+    consentConfig?: ConsentConfig;
+    /**
+     * Activation mode means:
+     * - Enabled means its enabled on the subscription when this Iris app is approved.
+     * - Visible means it will be visible to the customer to choose for them selves to enable/disable it.
+     *
+     * - FORCE_ENABLE then it can not be removed by the end customer, and will be installed based on the selected subscription package.
+     * - DEFAULT_ENABLE means it will be enabled when a customer activates a new subscription package.
+     * - ALWAYS_VISIBLE then it will always be visible for all customers.
+     * - CONTROLLED_VISIBILITY then it will be controlled by the team that activates the subscription package for the customer.
+     *
+     * - All modes will take into consideration both validForAccountIds and marketplace.allowForPackage
+     */
+    activationMode: "FORCE_ENABLE" | "DEFAULT_ENABLE" | "ALWAYS_VISIBLE" | "CONTROLLED_VISIBILITY";
+    /**
+     * A list of any external domains that the Tile needs to communicate with.
+     */
+    validDomains: string[];
+    /**
+     * A list of any account ids that can enable this Tile, or empty array if available for all customers.
+     */
+    validForAccountIds: "ALL_ACCOUNTS" | string[];
+    /**
+     * A configuration object for the Marketplace entry
+     */
+    marketplace: Marketplace;
+    /**
+     * A full list of runtime dependencies for the Tile.
+     * Used for performance optimization and security scans.
+     */
+    dependencies: Dependencies;
+    /**
+     * A full list of dev dependencies for the Tile.
+     * Used for security scans.
+     */
+    devDependencies: Dependencies;
+    /**
+     * A list of extensions to the UI that this app manifest exposes
+     */
+    extensions: IrisAppExtension[];
+    /**
+     * A list of custom field definitions.
+     */
+    customFieldDefinitions?: CustomFieldDefinition[];
+}
+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 translationKeys: string[];
+export interface TranslationKey {
+    key: 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 declare type CustomFieldDefinitionType = "STRING" | "NUMBER" | "DATE" | "BOOLEAN" | "DROPDOWN" | "EMAIL" | "PHONE_NUMBER" | "WEB_ADDRESS";
+export declare type EntityType = "ASSET" | "ACCOUNT";
+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[];
+    dropDownValueReplacements: 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"
+}
+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;
+    unitSi: never;
+    unitUs: never;
+}
+export declare type CustomFieldDefinition = BooleanFieldDefinition | DecimalNumberFieldDefinition | IntegerNumberFieldDefinition | DateFieldDefinition | DropDownFieldDefinition | StringFieldDefinition | EmailFieldDefinition | PhoneNumberFieldDefinition | WebAddressFieldDefinition;
+export interface AssetHomeExtensionManifest extends AbstractExtensionManifest {
+    type: "ASSET_HOME_EXTENSION";
+    /**
+     * Conditions for the asset home app 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.
+     *
+     * 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.
+     **/
+    conditions?: {
+        model?: string[] | string;
+        brand?: string[] | string;
+    };
+    menuItem: {
+        name: string | Translations | TranslationKey;
+    };
+}
+export interface FleetExtensionManifest extends AbstractExtensionManifest {
+    type: "FLEET_EXTENSION";
+    /**
+     * Conditions for the asset home app 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.
+     *
+     * 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.
+     **/
+    conditions?: {
+        model?: string[] | string;
+        brand?: string[] | string;
+    };
+    menuItem: {
+        name: string | Translations | TranslationKey;
+        icon: string;
+    };
+}
+export interface AdminExtensionManifest extends AbstractExtensionManifest {
+    type: "ADMIN_EXTENSION";
+    menuItem: {
+        name: string | Translations | TranslationKey;
+    };
+}
+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;
+    };
+}
+export declare type IrisAppExtension = AssetHomeExtensionManifest | AdminExtensionManifest | FleetExtensionManifest | ReportExtensionManifest;
+export interface ConsentConfig {
+    /**
+     * The application type. Should be one of WEB or BROWSER.
+     */
+    applicationType: string;
+    /**
+     * List of scopes required by the application.
+     */
+    scopes: string[];
+    /**
+     * List of redirect URIs to be used when returning an authorization code.
+     */
+    redirectUris?: string[];
+}
+/**
+ * An image that should be shown in the marketplace for this app.
+ */
+export interface MarketplaceAssetImage {
+    /**
+     * The type of the Asset
+     */
+    type: "IMAGE";
+    /**
+     * A Path to an image in the assets folder of the app.
+     * Example: typing "MyImage.png" here, will show the file "apps/my-app/assets/MyImage.png"
+     */
+    path: string;
+}
+/**
+ * A video that should be shown in the marketplace for this app.
+ */
+export interface MarketplaceAssetVideo {
+    /**
+     * The type of the Asset
+     */
+    type: "VIDEO";
+    /**
+     * An url for a youtube video.
+     */
+    url: string;
+}
+/**
+ * A video or image that should be shown in the marketplace for this app.
+ */
+export declare type MarketplaceAsset = MarketplaceAssetImage | MarketplaceAssetVideo;
+/**
+ * An object of data used when the app is displayed in the marketplace
+ */
+export interface Marketplace {
+    /**
+     * Name used for the marketplace.
+     */
+    name: string;
+    /**
+     * A short summary used for the card on marketplace.
+     * For longer description add a description.md file in the /assets/ folder of the app, and set the fullDescriptionPath.
+     */
+    description: string;
+    /**
+     * The path to the markdown file for the description.
+     */
+    fullDescriptionPath: string;
+    /**
+     * Path to an image in the assets folder of the app.
+     * The image will be shown in the marketplace.
+     * Example: typing "MyImage.png" here, will show the file "apps/my-app/assets/MyImage.png"
+     */
+    logoPath?: string;
+    /**
+     * Tags used for describing the marketplace.
+     */
+    tags: string[];
+    /**
+     * Assets (images and videos) used for the marketplace.
+     */
+    assets?: MarketplaceAsset[];
+    /**
+     * Defines what subscription packages the Tile is available at.
+     */
+    allowForPackage: SubscriptionPackage[];
+    /**
+     * Homepage of the company building the app for the marketplace.
+     */
+    homePageUrl?: string;
+    /**
+     * The direct support page for this app.
+     */
+    supportUrl?: string;
+}
+export declare type SubscriptionPackage = "VIEW" | "COLLECT" | "INSIGHT" | "EXPLORE_FLEET_OWNER" | "EVOLVE_FLEET_OWNER" | "EXPAND_FLEET_OWNER" | "EXPLORE_OEM" | "EVOLVE_OEM" | "EXPAND_OEM";
+export declare type IrisAppExtensionType = "REPORT_EXTENSION" | "ADMIN_EXTENSION" | "FLEET_EXTENSION" | "ASSET_HOME_EXTENSION";
+interface Dependencies {
+    [packageName: string]: string;
+}
+export {};

package/src/types/irisAppManifest.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnitSi = exports.UnitUs = exports.translationKeys = void 0;
+exports.translationKeys = [
+    "en",
+    "da",
+    "de",
+    "cs",
+    "nl",
+    "fr",
+    "fi",
+    "hu",
+    "it",
+    "nb",
+    "pl",
+    "pt",
+    "ru",
+    "ro",
+    "es",
+    "sv",
+    "ja",
+    "th",
+];
+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 || (exports.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 = exports.UnitSi || (exports.UnitSi = {}));
+//# sourceMappingURL=irisAppManifest.js.map

package/src/types/irisAppManifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"irisAppManifest.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/irisAppManifest.ts"],"names":[],"mappings":";;;AAqFa,QAAA,eAAe,GAAG;IAC7B,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;CACL,CAAC;AA4GF,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,GAAN,cAAM,KAAN,cAAM,QAgBjB;AAED,IAAY,MAwBX;AAxBD,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;AAClB,CAAC,EAxBW,MAAM,GAAN,cAAM,KAAN,cAAM,QAwBjB","sourcesContent":["export interface IrisAppManifest {\n  /**\n   * A spec version for the manifest.\n   * This should not be changed manually.\n   */\n  specVersion: \"1.0\";\n  /**\n   * The name of the exposed module from module federation build into the remoteEntry.js.\n   */\n  moduleFederationName: string;\n  /**\n   * A configuration object for handling scoped token acquisition.\n   */\n  consentConfig?: ConsentConfig;\n\n  /**\n   * Activation mode means:\n   * - Enabled means its enabled on the subscription when this Iris app is approved.\n   * - Visible means it will be visible to the customer to choose for them selves to enable/disable it.\n   *\n   * - FORCE_ENABLE then it can not be removed by the end customer, and will be installed based on the selected subscription package.\n   * - DEFAULT_ENABLE means it will be enabled when a customer activates a new subscription package.\n   * - ALWAYS_VISIBLE then it will always be visible for all customers.\n   * - CONTROLLED_VISIBILITY then it will be controlled by the team that activates the subscription package for the customer.\n   *\n   * - All modes will take into consideration both validForAccountIds and marketplace.allowForPackage\n   */\n  activationMode: \"FORCE_ENABLE\" | \"DEFAULT_ENABLE\" | \"ALWAYS_VISIBLE\" | \"CONTROLLED_VISIBILITY\";\n\n  /**\n   * A list of any external domains that the Tile needs to communicate with.\n   */\n  validDomains: string[];\n  /**\n   * A list of any account ids that can enable this Tile, or empty array if available for all customers.\n   */\n  validForAccountIds: \"ALL_ACCOUNTS\" | string[];\n  /**\n   * A configuration object for the Marketplace entry\n   */\n  marketplace: Marketplace;\n  /**\n   * A full list of runtime dependencies for the Tile.\n   * Used for performance optimization and security scans.\n   */\n  dependencies: Dependencies;\n\n  /**\n   * A full list of dev dependencies for the Tile.\n   * Used for security scans.\n   */\n  devDependencies: Dependencies;\n\n  /**\n   * A list of extensions to the UI that this app manifest exposes\n   */\n  extensions: IrisAppExtension[];\n\n  /**\n   * A list of custom field definitions.\n   */\n  customFieldDefinitions?: CustomFieldDefinition[];\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 translationKeys = [\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];\n\nexport interface TranslationKey {\n  key: string;\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   * @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 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\";\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  dropDownValueReplacements: 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}\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  unitSi: never;\n  unitUs: never;\n}\n\nexport declare type CustomFieldDefinition =\n  | BooleanFieldDefinition\n  | DecimalNumberFieldDefinition\n  | IntegerNumberFieldDefinition\n  | DateFieldDefinition\n  | DropDownFieldDefinition\n  | StringFieldDefinition\n  | EmailFieldDefinition\n  | PhoneNumberFieldDefinition\n  | WebAddressFieldDefinition;\n\nexport interface AssetHomeExtensionManifest extends AbstractExtensionManifest {\n  type: \"ASSET_HOME_EXTENSION\";\n  /**\n   * Conditions for the asset home app 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   * 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   **/\n  conditions?: {\n    model?: string[] | string;\n    brand?: string[] | string;\n  };\n  menuItem: {\n    name: string | Translations | TranslationKey;\n  };\n}\nexport interface FleetExtensionManifest extends AbstractExtensionManifest {\n  type: \"FLEET_EXTENSION\";\n\n  /**\n   * Conditions for the asset home app 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   * 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   **/\n  conditions?: {\n    model?: string[] | string;\n    brand?: string[] | string;\n  };\n  menuItem: {\n    name: string | Translations | TranslationKey;\n    icon: string;\n  };\n}\n\nexport interface AdminExtensionManifest extends AbstractExtensionManifest {\n  type: \"ADMIN_EXTENSION\";\n\n  menuItem: {\n    name: string | Translations | TranslationKey;\n  };\n}\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}\nexport declare type IrisAppExtension =\n  | AssetHomeExtensionManifest\n  | AdminExtensionManifest\n  | FleetExtensionManifest\n  | ReportExtensionManifest;\nexport interface ConsentConfig {\n  /**\n   * The application type. Should be one of WEB or BROWSER.\n   */\n  applicationType: string;\n  /**\n   * List of scopes required by the application.\n   */\n  scopes: string[];\n  /**\n   * List of redirect URIs to be used when returning an authorization code.\n   */\n  redirectUris?: string[];\n}\n\n/**\n * An image that should be shown in the marketplace for this app.\n */\nexport interface MarketplaceAssetImage {\n  /**\n   * The type of the Asset\n   */\n  type: \"IMAGE\";\n  /**\n   * A Path to an image in the assets folder of the app.\n   * Example: typing \"MyImage.png\" here, will show the file \"apps/my-app/assets/MyImage.png\"\n   */\n  path: string;\n}\n\n/**\n * A video that should be shown in the marketplace for this app.\n */\nexport interface MarketplaceAssetVideo {\n  /**\n   * The type of the Asset\n   */\n  type: \"VIDEO\";\n  /**\n   * An url for a youtube video.\n   */\n  url: string;\n}\n\n/**\n * A video or image that should be shown in the marketplace for this app.\n */\nexport type MarketplaceAsset = MarketplaceAssetImage | MarketplaceAssetVideo;\n\n/**\n * An object of data used when the app is displayed in the marketplace\n */\nexport interface Marketplace {\n  /**\n   * Name used for the marketplace.\n   */\n  name: string;\n\n  /**\n   * A short summary used for the card on marketplace.\n   * For longer description add a description.md file in the /assets/ folder of the app, and set the fullDescriptionPath.\n   */\n  description: string;\n\n  /**\n   * The path to the markdown file for the description.\n   */\n  fullDescriptionPath: string;\n\n  /**\n   * Path to an image in the assets folder of the app.\n   * The image will be shown in the marketplace.\n   * Example: typing \"MyImage.png\" here, will show the file \"apps/my-app/assets/MyImage.png\"\n   */\n  logoPath?: string;\n  /**\n   * Tags used for describing the marketplace.\n   */\n  tags: string[];\n  /**\n   * Assets (images and videos) used for the marketplace.\n   */\n  assets?: MarketplaceAsset[];\n  /**\n   * Defines what subscription packages the Tile is available at.\n   */\n  allowForPackage: SubscriptionPackage[];\n  /**\n   * Homepage of the company building the app for the marketplace.\n   */\n  homePageUrl?: string;\n  /**\n   * The direct support page for this app.\n   */\n  supportUrl?: string;\n}\nexport declare type SubscriptionPackage =\n  | \"VIEW\"\n  | \"COLLECT\"\n  | \"INSIGHT\"\n  | \"EXPLORE_FLEET_OWNER\"\n  | \"EVOLVE_FLEET_OWNER\"\n  | \"EXPAND_FLEET_OWNER\"\n  | \"EXPLORE_OEM\"\n  | \"EVOLVE_OEM\"\n  | \"EXPAND_OEM\";\nexport declare type IrisAppExtensionType =\n  | \"REPORT_EXTENSION\"\n  | \"ADMIN_EXTENSION\"\n  | \"FLEET_EXTENSION\"\n  | \"ASSET_HOME_EXTENSION\";\ninterface Dependencies {\n  [packageName: string]: string;\n}\nexport {};\n"]}

package/src/types/modulefederation.d.ts

@@ -0,0 +1,92 @@
+/**
+ * Modules that should be shared in the share scope. When provided, property names are used to match requested modules in this compilation.
+ */
+export declare type Shared = (SharedItem | SharedObject)[] | SharedObject;
+/**
+ * A module that should be shared in the share scope.
+ */
+export declare type SharedItem = string;
+/**
+ * Modules that should be shared in the share scope. Property names are used to match requested modules in this compilation. Relative requests are resolved, module requests are matched unresolved, absolute paths will match resolved requests. A trailing slash will match all requests with this prefix. In this case shareKey must also have a trailing slash.
+ */
+export interface SharedObject {
+    /**
+     * Modules that should be shared in the share scope.
+     */
+    [k: string]: SharedConfig | SharedItem;
+}
+/**
+ * Advanced configuration for modules that should be shared in the share scope.
+ */
+export interface SharedConfig {
+    /**
+     * Include the provided and fallback module directly instead behind an async request. This allows to use this shared module in initial load too. All possible shared modules need to be eager too.
+     */
+    eager?: boolean;
+    /**
+     * Provided module that should be provided to share scope. Also acts as fallback module if no shared module is found in share scope or version isn't valid. Defaults to the property name.
+     */
+    import?: false | SharedItem;
+    /**
+     * Package name to determine required version from description file. This is only needed when package name can't be automatically determined from request.
+     */
+    packageName?: string;
+    /**
+     * Version requirement from module in share scope.
+     */
+    requiredVersion?: false | string;
+    /**
+     * Module is looked up under this key from the share scope.
+     */
+    shareKey?: string;
+    /**
+     * Share scope name.
+     */
+    shareScope?: string;
+    /**
+     * Allow only a single version of the shared module in share scope (disabled by default).
+     */
+    singleton?: boolean;
+    /**
+     * Do not accept shared module if version is not valid (defaults to yes, if local fallback module is available and shared module is not a singleton, otherwise no, has no effect if there is no required version specified).
+     */
+    strictVersion?: boolean;
+    /**
+     * Version of the provided module. Will replace lower matching versions, but not higher.
+     */
+    version?: false | string;
+}
+/**
+ * Modules that should be exposed by this container. When provided, property name is used as public name, otherwise public name is automatically inferred from request.
+ */
+export declare type Exposes = (ExposesItem | ExposesObject)[] | ExposesObject;
+/**
+ * Module that should be exposed by this container.
+ */
+export declare type ExposesItem = string;
+/**
+ * Modules that should be exposed by this container.
+ */
+export declare type ExposesItems = ExposesItem[];
+/**
+ * Modules that should be exposed by this container. Property names are used as public paths.
+ */
+export interface ExposesObject {
+    /**
+     * Modules that should be exposed by this container.
+     */
+    [k: string]: ExposesConfig | ExposesItem | ExposesItems;
+}
+/**
+ * Advanced configuration for modules that should be exposed by this container.
+ */
+export interface ExposesConfig {
+    /**
+     * Request to a module that should be exposed by this container.
+     */
+    import: ExposesItem | ExposesItems;
+    /**
+     * Custom chunk name for the exposed module.
+     */
+    name?: string;
+}

package/src/types/modulefederation.js

@@ -0,0 +1,4 @@
+"use strict";
+// Source: https://github.com/webpack/webpack/blob/1c9b1b7a2136d4d9a27352fdbdf389490cca6460/declarations/plugins/container/ModuleFederationPlugin.d.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=modulefederation.js.map

package/src/types/modulefederation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modulefederation.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/modulefederation.ts"],"names":[],"mappings":";AAAA,sJAAsJ","sourcesContent":["// Source: https://github.com/webpack/webpack/blob/1c9b1b7a2136d4d9a27352fdbdf389490cca6460/declarations/plugins/container/ModuleFederationPlugin.d.ts\n\n/**\n * Modules that should be shared in the share scope. When provided, property names are used to match requested modules in this compilation.\n */\nexport type Shared = (SharedItem | SharedObject)[] | SharedObject;\n\n/**\n * A module that should be shared in the share scope.\n */\nexport type SharedItem = string;\n\n/**\n * Modules that should be shared in the share scope. Property names are used to match requested modules in this compilation. Relative requests are resolved, module requests are matched unresolved, absolute paths will match resolved requests. A trailing slash will match all requests with this prefix. In this case shareKey must also have a trailing slash.\n */\nexport interface SharedObject {\n  /**\n   * Modules that should be shared in the share scope.\n   */\n  [k: string]: SharedConfig | SharedItem;\n}\n\n/**\n * Advanced configuration for modules that should be shared in the share scope.\n */\nexport interface SharedConfig {\n  /**\n   * Include the provided and fallback module directly instead behind an async request. This allows to use this shared module in initial load too. All possible shared modules need to be eager too.\n   */\n  eager?: boolean;\n  /**\n   * Provided module that should be provided to share scope. Also acts as fallback module if no shared module is found in share scope or version isn't valid. Defaults to the property name.\n   */\n  import?: false | SharedItem;\n  /**\n   * Package name to determine required version from description file. This is only needed when package name can't be automatically determined from request.\n   */\n  packageName?: string;\n  /**\n   * Version requirement from module in share scope.\n   */\n  requiredVersion?: false | string;\n  /**\n   * Module is looked up under this key from the share scope.\n   */\n  shareKey?: string;\n  /**\n   * Share scope name.\n   */\n  shareScope?: string;\n  /**\n   * Allow only a single version of the shared module in share scope (disabled by default).\n   */\n  singleton?: boolean;\n  /**\n   * Do not accept shared module if version is not valid (defaults to yes, if local fallback module is available and shared module is not a singleton, otherwise no, has no effect if there is no required version specified).\n   */\n  strictVersion?: boolean;\n  /**\n   * Version of the provided module. Will replace lower matching versions, but not higher.\n   */\n  version?: false | string;\n}\n\n/**\n * Modules that should be exposed by this container. When provided, property name is used as public name, otherwise public name is automatically inferred from request.\n */\nexport type Exposes = (ExposesItem | ExposesObject)[] | ExposesObject;\n/**\n * Module that should be exposed by this container.\n */\nexport type ExposesItem = string;\n/**\n * Modules that should be exposed by this container.\n */\nexport type ExposesItems = ExposesItem[];\n\n/**\n * Modules that should be exposed by this container. Property names are used as public paths.\n */\nexport interface ExposesObject {\n  /**\n   * Modules that should be exposed by this container.\n   */\n  [k: string]: ExposesConfig | ExposesItem | ExposesItems;\n}\n/**\n * Advanced configuration for modules that should be exposed by this container.\n */\nexport interface ExposesConfig {\n  /**\n   * Request to a module that should be exposed by this container.\n   */\n  import: ExposesItem | ExposesItems;\n  /**\n   * Custom chunk name for the exposed module.\n   */\n  name?: string;\n}\n"]}