@trackunit/iris-app-api 0.2.2 → 0.2.4

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [0.2.4](https://github.com/Trackunit/manager/compare/iris-app-api/0.2.3...iris-app-api/0.2.4) (2024-09-16)
+
+## [0.2.3](https://github.com/Trackunit/manager/compare/iris-app-api/0.2.2...iris-app-api/0.2.3) (2024-09-11)
+
 ## [0.2.2](https://github.com/Trackunit/manager/compare/iris-app-api/0.2.1...iris-app-api/0.2.2) (2024-09-09)
 
 ## [0.2.1](https://github.com/Trackunit/manager/compare/iris-app-api/0.2.0...iris-app-api/0.2.1) (2024-09-05)

package/package.json

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

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

@@ -1,4 +1,4 @@
-import { IconByName, IconImage } from "../iconImage";
+import { IconByName, IconByPath } from "../iconImage";
 import { AbstractExtensionManifest, RegExpType, TranslationKey, Translations } from "../irisAppExtensionManifest";
 import { AccountScope } from "../scopes";
 export interface FleetExtensionManifest extends AbstractExtensionManifest {
@@ -21,8 +21,20 @@ export interface FleetExtensionManifest extends AbstractExtensionManifest {
         scopes?: AccountScope | AccountScope[];
     };
     menuItem: {
+        /**
+         * The name used in the menu item.
+         */
         name: string | Translations | TranslationKey;
+        /**
+         * The icon used in the menu item.
+         *
+         * @deprecated please use image instead.
+         */
         icon: string;
-        image?: IconByName | IconImage;
+        image?: IconByName | IconByPath;
+        /**
+         * Description of the menu item, used in the 'Applications' menu.
+         */
+        description?: string | Translations | TranslationKey;
     };
 }

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

@@ -1 +1 @@
-{"version":3,"file":"fleetExtensionManifest.js","sourceRoot":"","sources":["../../../../../../../libs/iris-app-sdk/iris-app-api/src/types/extensions/fleetExtensionManifest.ts"],"names":[],"mappings":"","sourcesContent":["import { IconByName, IconImage } from \"../iconImage\";\nimport { AbstractExtensionManifest, RegExpType, TranslationKey, Translations } from \"../irisAppExtensionManifest\";\nimport { AccountScope } from \"../scopes\";\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 scopes is used/filled out then the fleet extension will be shown if the user has the required scope.\n   * - If more scopes are used/filled out then the fleet extension will be shown if the user has one of the required scopes.\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 | RegExpType)[] | string | RegExpType;\n    brand?: (string | RegExpType)[] | string | RegExpType;\n    scopes?: AccountScope | AccountScope[];\n  };\n\n  menuItem: {\n    name: string | Translations | TranslationKey;\n    icon: string;\n    image?: IconByName | IconImage;\n  };\n}\n"]}
+{"version":3,"file":"fleetExtensionManifest.js","sourceRoot":"","sources":["../../../../../../../libs/iris-app-sdk/iris-app-api/src/types/extensions/fleetExtensionManifest.ts"],"names":[],"mappings":"","sourcesContent":["import { IconByName, IconByPath } from \"../iconImage\";\nimport { AbstractExtensionManifest, RegExpType, TranslationKey, Translations } from \"../irisAppExtensionManifest\";\nimport { AccountScope } from \"../scopes\";\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 scopes is used/filled out then the fleet extension will be shown if the user has the required scope.\n   * - If more scopes are used/filled out then the fleet extension will be shown if the user has one of the required scopes.\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 | RegExpType)[] | string | RegExpType;\n    brand?: (string | RegExpType)[] | string | RegExpType;\n    scopes?: AccountScope | AccountScope[];\n  };\n\n  menuItem: {\n    /**\n     * The name used in the menu item.\n     */\n    name: string | Translations | TranslationKey;\n    /**\n     * The icon used in the menu item.\n     *\n     * @deprecated please use image instead.\n     */\n    icon: string;\n    image?: IconByName | IconByPath;\n\n    /**\n     * Description of the menu item, used in the 'Applications' menu.\n     */\n    description?: string | Translations | TranslationKey;\n  };\n}\n"]}

package/src/types/iconImage.d.ts

@@ -1,6 +1,7 @@
 import { IconName } from "./icons.generated";
 type HexColor = `#${string}`;
 type RgbColor = `rgb(${number},${number},${number})`;
+export type SvgImagePath = `${string}.svg`;
 /**
  *  Checks if the value is a valid hex color
  */
@@ -10,37 +11,51 @@ export declare const isHexColor: (color: any) => color is HexColor;
  */
 export declare const isRgbColor: (color: any) => color is RgbColor;
 export type Color = HexColor | RgbColor;
-export type IconImage = {
+export type Colorable = {
     /**
-     * Path relative to the projects src folder defined in the extensions sourceRoot
+     * Color of the background for the icon
+     * Supports hex or rgb
      *
-     * @example "assets/icon.svg"
+     * @example "#ff0000" or "rgb(255,0,0)"
      */
-    path: string;
-    color?: Color;
-};
-export type IconByName = {
-    name: IconName;
+    background?: Color;
     /**
-     * Color of the background for the icon
+     * Color of the foreground for the icon
      * Supports hex or rgb
      *
      * @example "#ff0000" or "rgb(255,0,0)"
      */
-    color?: Color;
+    foreground?: Color;
 };
+export type IconByPath = {
+    /**
+     * Path relative to the projects src folder defined in the extensions sourceRoot
+     * ONLY supports svg files since we replace the color in the svg file at runtime.
+     *
+     * @example "assets/icon.svg"
+     */
+    path: SvgImagePath;
+} & Colorable;
+export type IconByName = {
+    /**
+     * Name of the icon from the Iris Icons package
+     *
+     * @example "MapMarkerPointSquare"
+     */
+    name: IconName;
+} & Colorable;
 /**
  * Checks if value is an IconImage
  *
  * @param value - The value to check
- * @returns - True if value is an IconImage
+ * @returns {boolean} True if value is an IconImage
  */
-export declare const isIconImage: (value: unknown) => value is IconImage;
+export declare const isIconByPath: (value: unknown) => value is IconByPath;
 /**
  * Checks if value is an IconByName
  *
  * @param value - The value to check
- * @returns - True if value is an IconByName
+ * @returns {boolean}- True if value is an IconByName
  */
 export declare const isIconByName: (value: unknown) => value is IconByName;
 export {};

package/src/types/iconImage.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isIconByName = exports.isIconImage = exports.isRgbColor = exports.isHexColor = void 0;
+exports.isIconByName = exports.isIconByPath = exports.isRgbColor = exports.isHexColor = void 0;
 /**
  *  Checks if the value is a valid hex color
  */
@@ -21,20 +21,20 @@ exports.isRgbColor = isRgbColor;
  * Checks if value is an IconImage
  *
  * @param value - The value to check
- * @returns - True if value is an IconImage
+ * @returns {boolean} True if value is an IconImage
  */
-const isIconImage = (value) => {
-    return !!(value === null || value === void 0 ? void 0 : value.path);
+const isIconByPath = (value) => {
+    return typeof value === "object" && value !== null && "path" in value;
 };
-exports.isIconImage = isIconImage;
+exports.isIconByPath = isIconByPath;
 /**
  * Checks if value is an IconByName
  *
  * @param value - The value to check
- * @returns - True if value is an IconByName
+ * @returns {boolean}- True if value is an IconByName
  */
 const isIconByName = (value) => {
-    return !!(value === null || value === void 0 ? void 0 : value.name);
+    return typeof value === "object" && value !== null && "name" in value;
 };
 exports.isIconByName = isIconByName;
 //# sourceMappingURL=iconImage.js.map

package/src/types/iconImage.js.map

@@ -1 +1 @@
-{"version":3,"file":"iconImage.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/iconImage.ts"],"names":[],"mappings":";;;AAKA;;GAEG;AACH,8DAA8D;AACvD,MAAM,UAAU,GAAG,CAAC,KAAU,EAAqB,EAAE;IAC1D,OAAO,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACxE,CAAC,CAAC;AAFW,QAAA,UAAU,cAErB;AAEF;;GAEG;AACH,8DAA8D;AACvD,MAAM,UAAU,GAAG,CAAC,KAAU,EAAqB,EAAE;IAC1D,OAAO,mCAAmC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACzD,CAAC,CAAC;AAFW,QAAA,UAAU,cAErB;AAyBF;;;;;GAKG;AACI,MAAM,WAAW,GAAG,CAAC,KAAc,EAAsB,EAAE;IAChE,OAAO,CAAC,CAAC,CAAC,KAA+B,aAA/B,KAAK,uBAAL,KAAK,CAA4B,IAAI,CAAA,CAAC;AAClD,CAAC,CAAC;AAFW,QAAA,WAAW,eAEtB;AAEF;;;;;GAKG;AACI,MAAM,YAAY,GAAG,CAAC,KAAc,EAAuB,EAAE;IAClE,OAAO,CAAC,CAAC,CAAC,KAAgC,aAAhC,KAAK,uBAAL,KAAK,CAA6B,IAAI,CAAA,CAAC;AACnD,CAAC,CAAC;AAFW,QAAA,YAAY,gBAEvB","sourcesContent":["import { IconName } from \"./icons.generated\";\n\ntype HexColor = `#${string}`;\ntype RgbColor = `rgb(${number},${number},${number})`;\n\n/**\n *  Checks if the value is a valid hex color\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport const isHexColor = (color: any): color is HexColor => {\n  return /^#[0-9A-F]{6}$/i.test(color) || /^#[0-9A-F]{3}$/i.test(color);\n};\n\n/**\n *  Checks if the value is a valid rgb color\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport const isRgbColor = (color: any): color is RgbColor => {\n  return /^rgb\\(\\d{1,3},\\d{1,3},\\d{1,3}\\)$/i.test(color);\n};\n\nexport type Color = HexColor | RgbColor;\n\nexport type IconImage = {\n  /**\n   * Path relative to the projects src folder defined in the extensions sourceRoot\n   *\n   * @example \"assets/icon.svg\"\n   */\n  path: string;\n  color?: Color;\n};\n\nexport type IconByName = {\n  name: IconName;\n  /**\n   * Color of the background for the icon\n   * Supports hex or rgb\n   *\n   * @example \"#ff0000\" or \"rgb(255,0,0)\"\n   */\n  color?: Color;\n};\n\n/**\n * Checks if value is an IconImage\n *\n * @param value - The value to check\n * @returns - True if value is an IconImage\n */\nexport const isIconImage = (value: unknown): value is IconImage => {\n  return !!(value as IconImage | undefined)?.path;\n};\n\n/**\n * Checks if value is an IconByName\n *\n * @param value - The value to check\n * @returns - True if value is an IconByName\n */\nexport const isIconByName = (value: unknown): value is IconByName => {\n  return !!(value as IconByName | undefined)?.name;\n};\n"]}
+{"version":3,"file":"iconImage.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/iconImage.ts"],"names":[],"mappings":";;;AAMA;;GAEG;AACH,8DAA8D;AACvD,MAAM,UAAU,GAAG,CAAC,KAAU,EAAqB,EAAE;IAC1D,OAAO,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACxE,CAAC,CAAC;AAFW,QAAA,UAAU,cAErB;AAEF;;GAEG;AACH,8DAA8D;AACvD,MAAM,UAAU,GAAG,CAAC,KAAU,EAAqB,EAAE;IAC1D,OAAO,mCAAmC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACzD,CAAC,CAAC;AAFW,QAAA,UAAU,cAErB;AAyCF;;;;;GAKG;AACI,MAAM,YAAY,GAAG,CAAC,KAAc,EAAuB,EAAE;IAClE,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,MAAM,IAAI,KAAK,CAAC;AACxE,CAAC,CAAC;AAFW,QAAA,YAAY,gBAEvB;AAEF;;;;;GAKG;AACI,MAAM,YAAY,GAAG,CAAC,KAAc,EAAuB,EAAE;IAClE,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,MAAM,IAAI,KAAK,CAAC;AACxE,CAAC,CAAC;AAFW,QAAA,YAAY,gBAEvB","sourcesContent":["import { IconName } from \"./icons.generated\";\n\ntype HexColor = `#${string}`;\ntype RgbColor = `rgb(${number},${number},${number})`;\nexport type SvgImagePath = `${string}.svg`;\n\n/**\n *  Checks if the value is a valid hex color\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport const isHexColor = (color: any): color is HexColor => {\n  return /^#[0-9A-F]{6}$/i.test(color) || /^#[0-9A-F]{3}$/i.test(color);\n};\n\n/**\n *  Checks if the value is a valid rgb color\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport const isRgbColor = (color: any): color is RgbColor => {\n  return /^rgb\\(\\d{1,3},\\d{1,3},\\d{1,3}\\)$/i.test(color);\n};\n\nexport type Color = HexColor | RgbColor;\n\nexport type Colorable = {\n  /**\n   * Color of the background for the icon\n   * Supports hex or rgb\n   *\n   * @example \"#ff0000\" or \"rgb(255,0,0)\"\n   */\n  background?: Color;\n\n  /**\n   * Color of the foreground for the icon\n   * Supports hex or rgb\n   *\n   * @example \"#ff0000\" or \"rgb(255,0,0)\"\n   */\n  foreground?: Color;\n};\n\nexport type IconByPath = {\n  /**\n   * Path relative to the projects src folder defined in the extensions sourceRoot\n   * ONLY supports svg files since we replace the color in the svg file at runtime.\n   *\n   * @example \"assets/icon.svg\"\n   */\n  path: SvgImagePath;\n} & Colorable;\n\nexport type IconByName = {\n  /**\n   * Name of the icon from the Iris Icons package\n   *\n   * @example \"MapMarkerPointSquare\"\n   */\n  name: IconName;\n} & Colorable;\n\n/**\n * Checks if value is an IconImage\n *\n * @param value - The value to check\n * @returns {boolean} True if value is an IconImage\n */\nexport const isIconByPath = (value: unknown): value is IconByPath => {\n  return typeof value === \"object\" && value !== null && \"path\" in value;\n};\n\n/**\n * Checks if value is an IconByName\n *\n * @param value - The value to check\n * @returns {boolean}- True if value is an IconByName\n */\nexport const isIconByName = (value: unknown): value is IconByName => {\n  return typeof value === \"object\" && value !== null && \"name\" in value;\n};\n"]}