@trackunit/iris-app-api 1.6.19 → 1.6.22

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 1.6.22 (2025-09-02)
+
+This was a version bump only for iris-app-api to align it with other projects, there were no code changes.
+
+## 1.6.21 (2025-09-02)
+
+This was a version bump only for iris-app-api to align it with other projects, there were no code changes.
+
+## 1.6.20 (2025-09-01)
+
+This was a version bump only for iris-app-api to align it with other projects, there were no code changes.
+
 ## 1.6.19 (2025-08-28)
 
 This was a version bump only for iris-app-api to align it with other projects, there were no code changes.

package/package.json

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

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

@@ -1,4 +1,4 @@
-import { IconByName, IconByPath } from "../iconImage";
+import { IconByName, IconByPath, ImageByPath } from "../iconImage";
 import { AbstractExtensionManifest, TranslationKey, Translations } from "../irisAppExtensionManifest";
 export type WidgetSupportedLocations = "MY_HOME" | "SITE_HOME" | "PLAYGROUND";
 export type WidgetSupportedFilterBars = "CUSTOMERS" | "ASSETS" | "SITES";
@@ -88,9 +88,10 @@ export interface WidgetExtensionManifest extends AbstractExtensionManifest {
          */
         link: string;
         /**
-         * A logo can be displayed in the footer to show that the widget is powered by an entity. You can use an SVG logo.
+         * A logo can be displayed in the footer to show that the widget is powered by an entity. You can use an SVG logo, and provide background and foreground colors.
+         * You can also use a SVG, PNG, JPEG or JPG logo directly max size 150x16px.
          */
-        poweredByImage?: IconByPath;
+        poweredByImage?: ImageByPath;
     };
     /**
      * The locations where the widget can be placed. Choose between My Home, Site Home and Playground.

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

@@ -1 +1 @@
-{"version":3,"file":"widgetExtensionManifest.js","sourceRoot":"","sources":["../../../../../../../libs/iris-app-sdk/iris-app-api/src/types/extensions/widgetExtensionManifest.ts"],"names":[],"mappings":";;;AASa,QAAA,WAAW,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAU,CAAC;AAIhE,QAAA,kBAAkB,GAAG;IAChC,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,OAAO;IACP,WAAW;IACX,QAAQ;IACR,QAAQ;IACR,aAAa;IACb,UAAU;IACV,sBAAsB;IACtB,UAAU;IACV,UAAU;IACV,UAAU;IACV,iBAAiB;IACjB,MAAM;IACN,SAAS;IACT,iBAAiB;IACjB,eAAe;IACf,qBAAqB;IACrB,cAAc;IACd,uBAAuB;CACf,CAAC;AAEE,QAAA,8BAA8B,GAAG;IAC5C,GAAG,0BAAkB;IACrB,aAAa;IACb,gBAAgB;IAChB,2BAA2B;IAC3B,6BAA6B;IAC7B,6CAA6C;CAC9C,CAAC;AACW,QAAA,oBAAoB,GAAG,cAAuB,CAAC;AAK/C,QAAA,kCAAkC,GAAG,CAAC,GAAG,sCAA8B,EAAE,4BAAoB,CAAU,CAAC;AAGxG,QAAA,iBAAiB,GAAG,CAAC,QAAQ,EAAE,YAAY,EAAE,UAAU,CAAU,CAAC;AAElE,QAAA,iCAAiC,GAAG,CAAC,GAAG,yBAAiB,EAAE,4BAAoB,CAAU,CAAC;AAG1F,QAAA,qBAAqB,GAAG,CAAC,QAAQ,EAAE,cAAc,EAAE,aAAa,EAAE,aAAa,CAAU,CAAC;AAE1F,QAAA,qCAAqC,GAAG,CAAC,GAAG,6BAAqB,EAAE,4BAAoB,CAAU,CAAC;AAGlG,QAAA,sBAAsB,GAAG,CAAC,KAAK,CAAU,CAAC","sourcesContent":["import { IconByName, IconByPath } from \"../iconImage\";\nimport { AbstractExtensionManifest, TranslationKey, Translations } from \"../irisAppExtensionManifest\";\n\nexport type WidgetSupportedLocations = \"MY_HOME\" | \"SITE_HOME\" | \"PLAYGROUND\";\n\nexport type WidgetSupportedFilterBars = \"CUSTOMERS\" | \"ASSETS\" | \"SITES\";\n\nexport type WidgetSupportedFilters = WidgetSupportedFilterBars | \"TIME_RANGE\";\n\nexport const widgetTypes = [\"KPI\", \"CHART\", \"LIST\", \"MAP\", \"OTHER\"] as const;\n\nexport type WidgetType = (typeof widgetTypes)[number];\n\nexport const allAssetFilterKeys = [\n  \"search\",\n  \"siteIds\",\n  \"groups\",\n  \"types\",\n  \"assetType\",\n  \"brands\",\n  \"models\",\n  \"criticality\",\n  \"activity\",\n  \"metadataCompleteness\",\n  \"lastSeen\",\n  \"followed\",\n  \"siteType\",\n  \"ownerAccountIds\",\n  \"area\",\n  \"partner\",\n  \"productionYears\",\n  \"serviceStatus\",\n  \"telematicsConnected\",\n  \"activeFilter\",\n  \"siteDepotOwnershipIds\",\n] as const;\n\nexport const allAssetFilterKeysWithCustomer = [\n  ...allAssetFilterKeys,\n  \"customerIds\",\n  \"rentalStatuses\",\n  \"rentalContractOrderNumber\",\n  \"rentalContractReferenceCode\",\n  \"rentalContractReferenceCodeDescriptionQuery\",\n];\nexport const customFieldFilterKey = \"customFields\" as const;\nexport type AssetFilterKeys = typeof allAssetFilterKeys;\n\nexport type AssetFilterKeysWithCustomer = typeof allAssetFilterKeysWithCustomer;\n\nexport const allAssetFilterKeysWithCustomFields = [...allAssetFilterKeysWithCustomer, customFieldFilterKey] as const;\nexport type AssetFilterKeysWithCustomFields = typeof allAssetFilterKeysWithCustomFields;\n\nexport const allSiteFilterKeys = [\"search\", \"siteStatus\", \"siteType\"] as const;\nexport type SiteFilterKeys = typeof allSiteFilterKeys;\nexport const allSiteFilterKeysWithCustomFields = [...allSiteFilterKeys, customFieldFilterKey] as const;\nexport type SiteFilterKeysWithCustomFields = typeof allSiteFilterKeysWithCustomFields;\n\nexport const allCustomerFilterKeys = [\"search\", \"customerType\", \"criticality\", \"servicePlan\"] as const;\nexport type CustomerFilterKeys = typeof allCustomerFilterKeys;\nexport const allCustomerFilterKeysWithCustomFields = [...allCustomerFilterKeys, customFieldFilterKey] as const;\nexport type CustomerFilterKeysWithCustomFields = typeof allCustomerFilterKeysWithCustomFields;\n\nexport const allTimeRangeFilterKeys = [\"ALL\"] as const;\nexport type TimeRangeFilterKeys = typeof allTimeRangeFilterKeys;\n\ntype FilterConfig<TFilterKeys extends ReadonlyArray<string>> = {\n  include: Array<TFilterKeys[number]>;\n};\n\nexport type SupportedFiltersConfig = {\n  ASSETS?: FilterConfig<AssetFilterKeysWithCustomFields>;\n  SITES?: FilterConfig<SiteFilterKeysWithCustomFields>;\n  CUSTOMERS?: FilterConfig<CustomerFilterKeysWithCustomFields>;\n  TIME_RANGE?: FilterConfig<TimeRangeFilterKeys>;\n};\n\n/**\n * BETA! DO NOT USE THIS YET - its under development\n */\nexport interface WidgetExtensionManifest extends AbstractExtensionManifest {\n  type: \"WIDGET_EXTENSION\";\n\n  preview?: {\n    /**\n     * The description of the widget will be displayed in the drawer for adding widgets.\n     */\n    description?: string | Translations | TranslationKey;\n  };\n\n  /**\n   * The widget type is used for filtering the widgets in the drawer.\n   */\n  widgetType: WidgetType;\n\n  /**\n   * Each widget must have one fixed size.\n   * Standard widgets are 2x2.\n   * Smaller widgets can be either 1x1 or 2x1.\n   * It is not recommended to create widgets that are larger than 2x2 by default.\n   * If a widget needs to support multiple sizes, create a separate widget for each size.\n   * Use `allowFullWidth: true` to let users expand the widget across the full width of the screen.\n   * This is generally recommended only for charts and maps where a larger display improves usability.\n   */\n  size: {\n    default: {\n      width: 1 | 2 | 3 | 4 | 5 | 6;\n      height: 1 | 2 | 3 | 4 | 5 | 6;\n    };\n    allowFullWidth?: boolean;\n  };\n\n  header: {\n    /**\n     * The name of the widget to display in the header. Do not place date ranges or fixed filters in the name. It is used for finding the widget in the drawer.\n     * Widgets sized 1x1 do not show the name in the header, but it is still visible in the drawer.\n     */\n    name: string | Translations | TranslationKey;\n\n    /**\n     * The image of the widget to display in the header, if not it will default to the icon of the manifest.\n     * Most standard widgets use icons, but you can use an SVG logo instead.\n     */\n    image?: IconByName | IconByPath;\n\n    /**\n     * If true, a button will be on the header and an editDialog from the src folder of this extension will be loaded to allow users to configure the widget.\n     */\n    hasEditDialog?: boolean;\n  };\n\n  footer?: {\n    /**\n     * The link description to display in the footer, if not it will default to localized version of 'See full details'.\n     */\n    linkDescription?: string | Translations | TranslationKey;\n\n    /**\n     * The link to display in the footer. The link is fixed and will always point to the same route.\n     */\n    link: string;\n\n    /**\n     * A logo can be displayed in the footer to show that the widget is powered by an entity. You can use an SVG logo.\n     */\n    poweredByImage?: IconByPath;\n  };\n\n  /**\n   * The locations where the widget can be placed. Choose between My Home, Site Home and Playground.\n   */\n  supportedLocations: Array<WidgetSupportedLocations>;\n\n  /**\n   * The filters that the widget can be filtered by. To support a date range filter, add \"TIME_RANGE\" to the list. The date range will be displayed separately in the menu.\n   * If you would like to lock the filters to a specific value, you can do so by adding the filter to the list and setting the value to the filter.\n   */\n  supportedFilters?: SupportedFiltersConfig;\n}\n"]}
+{"version":3,"file":"widgetExtensionManifest.js","sourceRoot":"","sources":["../../../../../../../libs/iris-app-sdk/iris-app-api/src/types/extensions/widgetExtensionManifest.ts"],"names":[],"mappings":";;;AASa,QAAA,WAAW,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAU,CAAC;AAIhE,QAAA,kBAAkB,GAAG;IAChC,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,OAAO;IACP,WAAW;IACX,QAAQ;IACR,QAAQ;IACR,aAAa;IACb,UAAU;IACV,sBAAsB;IACtB,UAAU;IACV,UAAU;IACV,UAAU;IACV,iBAAiB;IACjB,MAAM;IACN,SAAS;IACT,iBAAiB;IACjB,eAAe;IACf,qBAAqB;IACrB,cAAc;IACd,uBAAuB;CACf,CAAC;AAEE,QAAA,8BAA8B,GAAG;IAC5C,GAAG,0BAAkB;IACrB,aAAa;IACb,gBAAgB;IAChB,2BAA2B;IAC3B,6BAA6B;IAC7B,6CAA6C;CAC9C,CAAC;AACW,QAAA,oBAAoB,GAAG,cAAuB,CAAC;AAK/C,QAAA,kCAAkC,GAAG,CAAC,GAAG,sCAA8B,EAAE,4BAAoB,CAAU,CAAC;AAGxG,QAAA,iBAAiB,GAAG,CAAC,QAAQ,EAAE,YAAY,EAAE,UAAU,CAAU,CAAC;AAElE,QAAA,iCAAiC,GAAG,CAAC,GAAG,yBAAiB,EAAE,4BAAoB,CAAU,CAAC;AAG1F,QAAA,qBAAqB,GAAG,CAAC,QAAQ,EAAE,cAAc,EAAE,aAAa,EAAE,aAAa,CAAU,CAAC;AAE1F,QAAA,qCAAqC,GAAG,CAAC,GAAG,6BAAqB,EAAE,4BAAoB,CAAU,CAAC;AAGlG,QAAA,sBAAsB,GAAG,CAAC,KAAK,CAAU,CAAC","sourcesContent":["import { IconByName, IconByPath, ImageByPath } from \"../iconImage\";\nimport { AbstractExtensionManifest, TranslationKey, Translations } from \"../irisAppExtensionManifest\";\n\nexport type WidgetSupportedLocations = \"MY_HOME\" | \"SITE_HOME\" | \"PLAYGROUND\";\n\nexport type WidgetSupportedFilterBars = \"CUSTOMERS\" | \"ASSETS\" | \"SITES\";\n\nexport type WidgetSupportedFilters = WidgetSupportedFilterBars | \"TIME_RANGE\";\n\nexport const widgetTypes = [\"KPI\", \"CHART\", \"LIST\", \"MAP\", \"OTHER\"] as const;\n\nexport type WidgetType = (typeof widgetTypes)[number];\n\nexport const allAssetFilterKeys = [\n  \"search\",\n  \"siteIds\",\n  \"groups\",\n  \"types\",\n  \"assetType\",\n  \"brands\",\n  \"models\",\n  \"criticality\",\n  \"activity\",\n  \"metadataCompleteness\",\n  \"lastSeen\",\n  \"followed\",\n  \"siteType\",\n  \"ownerAccountIds\",\n  \"area\",\n  \"partner\",\n  \"productionYears\",\n  \"serviceStatus\",\n  \"telematicsConnected\",\n  \"activeFilter\",\n  \"siteDepotOwnershipIds\",\n] as const;\n\nexport const allAssetFilterKeysWithCustomer = [\n  ...allAssetFilterKeys,\n  \"customerIds\",\n  \"rentalStatuses\",\n  \"rentalContractOrderNumber\",\n  \"rentalContractReferenceCode\",\n  \"rentalContractReferenceCodeDescriptionQuery\",\n];\nexport const customFieldFilterKey = \"customFields\" as const;\nexport type AssetFilterKeys = typeof allAssetFilterKeys;\n\nexport type AssetFilterKeysWithCustomer = typeof allAssetFilterKeysWithCustomer;\n\nexport const allAssetFilterKeysWithCustomFields = [...allAssetFilterKeysWithCustomer, customFieldFilterKey] as const;\nexport type AssetFilterKeysWithCustomFields = typeof allAssetFilterKeysWithCustomFields;\n\nexport const allSiteFilterKeys = [\"search\", \"siteStatus\", \"siteType\"] as const;\nexport type SiteFilterKeys = typeof allSiteFilterKeys;\nexport const allSiteFilterKeysWithCustomFields = [...allSiteFilterKeys, customFieldFilterKey] as const;\nexport type SiteFilterKeysWithCustomFields = typeof allSiteFilterKeysWithCustomFields;\n\nexport const allCustomerFilterKeys = [\"search\", \"customerType\", \"criticality\", \"servicePlan\"] as const;\nexport type CustomerFilterKeys = typeof allCustomerFilterKeys;\nexport const allCustomerFilterKeysWithCustomFields = [...allCustomerFilterKeys, customFieldFilterKey] as const;\nexport type CustomerFilterKeysWithCustomFields = typeof allCustomerFilterKeysWithCustomFields;\n\nexport const allTimeRangeFilterKeys = [\"ALL\"] as const;\nexport type TimeRangeFilterKeys = typeof allTimeRangeFilterKeys;\n\ntype FilterConfig<TFilterKeys extends ReadonlyArray<string>> = {\n  include: Array<TFilterKeys[number]>;\n};\n\nexport type SupportedFiltersConfig = {\n  ASSETS?: FilterConfig<AssetFilterKeysWithCustomFields>;\n  SITES?: FilterConfig<SiteFilterKeysWithCustomFields>;\n  CUSTOMERS?: FilterConfig<CustomerFilterKeysWithCustomFields>;\n  TIME_RANGE?: FilterConfig<TimeRangeFilterKeys>;\n};\n\n/**\n * BETA! DO NOT USE THIS YET - its under development\n */\nexport interface WidgetExtensionManifest extends AbstractExtensionManifest {\n  type: \"WIDGET_EXTENSION\";\n\n  preview?: {\n    /**\n     * The description of the widget will be displayed in the drawer for adding widgets.\n     */\n    description?: string | Translations | TranslationKey;\n  };\n\n  /**\n   * The widget type is used for filtering the widgets in the drawer.\n   */\n  widgetType: WidgetType;\n\n  /**\n   * Each widget must have one fixed size.\n   * Standard widgets are 2x2.\n   * Smaller widgets can be either 1x1 or 2x1.\n   * It is not recommended to create widgets that are larger than 2x2 by default.\n   * If a widget needs to support multiple sizes, create a separate widget for each size.\n   * Use `allowFullWidth: true` to let users expand the widget across the full width of the screen.\n   * This is generally recommended only for charts and maps where a larger display improves usability.\n   */\n  size: {\n    default: {\n      width: 1 | 2 | 3 | 4 | 5 | 6;\n      height: 1 | 2 | 3 | 4 | 5 | 6;\n    };\n    allowFullWidth?: boolean;\n  };\n\n  header: {\n    /**\n     * The name of the widget to display in the header. Do not place date ranges or fixed filters in the name. It is used for finding the widget in the drawer.\n     * Widgets sized 1x1 do not show the name in the header, but it is still visible in the drawer.\n     */\n    name: string | Translations | TranslationKey;\n\n    /**\n     * The image of the widget to display in the header, if not it will default to the icon of the manifest.\n     * Most standard widgets use icons, but you can use an SVG logo instead.\n     */\n    image?: IconByName | IconByPath;\n\n    /**\n     * If true, a button will be on the header and an editDialog from the src folder of this extension will be loaded to allow users to configure the widget.\n     */\n    hasEditDialog?: boolean;\n  };\n\n  footer?: {\n    /**\n     * The link description to display in the footer, if not it will default to localized version of 'See full details'.\n     */\n    linkDescription?: string | Translations | TranslationKey;\n\n    /**\n     * The link to display in the footer. The link is fixed and will always point to the same route.\n     */\n    link: string;\n\n    /**\n     * A logo can be displayed in the footer to show that the widget is powered by an entity. You can use an SVG logo, and provide background and foreground colors.\n     * You can also use a SVG, PNG, JPEG or JPG logo directly max size 150x16px.\n     */\n    poweredByImage?: ImageByPath;\n  };\n\n  /**\n   * The locations where the widget can be placed. Choose between My Home, Site Home and Playground.\n   */\n  supportedLocations: Array<WidgetSupportedLocations>;\n\n  /**\n   * The filters that the widget can be filtered by. To support a date range filter, add \"TIME_RANGE\" to the list. The date range will be displayed separately in the menu.\n   * If you would like to lock the filters to a specific value, you can do so by adding the filter to the list and setting the value to the filter.\n   */\n  supportedFilters?: SupportedFiltersConfig;\n}\n"]}

package/src/types/iconImage.d.ts

@@ -2,6 +2,8 @@ import { IconName } from "./icons.generated";
 type HexColor = `#${string}`;
 type RgbColor = `rgb(${number},${number},${number})`;
 export type SvgImagePath = `${string}.svg`;
+export type PngImagePath = `${string}.png`;
+export type JpegImagePath = `${string}.jpeg` | `${string}.jpg`;
 /**
  *  Checks if the value is a valid hex color
  */
@@ -36,6 +38,15 @@ export type IconByPath = {
      */
     path: SvgImagePath;
 } & Colorable;
+export type ImageByPath = {
+    /**
+     * Path relative to the projects src folder defined in the extensions sourceRoot
+     * Supports png, jpeg, jpg and svg files.
+     *
+     * @example "assets/icon1.png" or "assets/icon2.jpeg" or "assets/icon3.jpg" or "assets/icon4.svg"
+     */
+    path: PngImagePath | JpegImagePath | SvgImagePath;
+};
 export type IconByName = {
     /**
      * Name of the icon from the Iris Icons package
@@ -51,6 +62,34 @@ export type IconByName = {
  * @returns {boolean} True if value is an IconImage
  */
 export declare const isIconByPath: (value: unknown) => value is IconByPath;
+/**
+ * Checks if value is a ImageByPath
+ *
+ * @param value - The value to check
+ * @returns {boolean} True if value is a ImageByPath
+ */
+export declare const isImageByPath: (value: unknown) => value is ImageByPath;
+/**
+ * Checks if the path is a svg path
+ *
+ * @param path - The path to check
+ * @returns {boolean} True if the path is a svg path
+ */
+export declare const isSvgPath: (path: string | undefined | null) => path is SvgImagePath;
+/**
+ * Checks if the path is a png path
+ *
+ * @param path - The path to check
+ * @returns {boolean} True if the path is a png path
+ */
+export declare const isPngPath: (path: string | undefined | null) => path is PngImagePath;
+/**
+ * Checks if the path is a jpeg or jpg path
+ *
+ * @param path - The path to check
+ * @returns {boolean} True if the path is a jpeg or jpg path
+ */
+export declare const isJpgOrJpegPath: (path: string | undefined | null) => path is JpegImagePath;
 /**
  * Checks if value is an IconByName
  *

package/src/types/iconImage.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isIconByName = exports.isIconByPath = exports.isRgbColor = exports.isHexColor = void 0;
+exports.isIconByName = exports.isJpgOrJpegPath = exports.isPngPath = exports.isSvgPath = exports.isImageByPath = exports.isIconByPath = exports.isRgbColor = exports.isHexColor = void 0;
 /**
  *  Checks if the value is a valid hex color
  */
@@ -24,9 +24,66 @@ exports.isRgbColor = isRgbColor;
  * @returns {boolean} True if value is an IconImage
  */
 const isIconByPath = (value) => {
-    return typeof value === "object" && value !== null && "path" in value;
+    return (typeof value === "object" &&
+        value !== null &&
+        "path" in value &&
+        typeof value.path === "string" &&
+        value.path.endsWith(".svg"));
 };
 exports.isIconByPath = isIconByPath;
+/**
+ * Checks if value is a ImageByPath
+ *
+ * @param value - The value to check
+ * @returns {boolean} True if value is a ImageByPath
+ */
+const isImageByPath = (value) => {
+    return (typeof value === "object" &&
+        value !== null &&
+        "path" in value &&
+        typeof value.path === "string" &&
+        ((0, exports.isPngPath)(value.path) || (0, exports.isJpgOrJpegPath)(value.path) || (0, exports.isSvgPath)(value.path)));
+};
+exports.isImageByPath = isImageByPath;
+/**
+ * Checks if the path is a svg path
+ *
+ * @param path - The path to check
+ * @returns {boolean} True if the path is a svg path
+ */
+const isSvgPath = (path) => {
+    if (path === undefined || path === null) {
+        return false;
+    }
+    return path.endsWith(".svg");
+};
+exports.isSvgPath = isSvgPath;
+/**
+ * Checks if the path is a png path
+ *
+ * @param path - The path to check
+ * @returns {boolean} True if the path is a png path
+ */
+const isPngPath = (path) => {
+    if (path === undefined || path === null) {
+        return false;
+    }
+    return path.endsWith(".png");
+};
+exports.isPngPath = isPngPath;
+/**
+ * Checks if the path is a jpeg or jpg path
+ *
+ * @param path - The path to check
+ * @returns {boolean} True if the path is a jpeg or jpg path
+ */
+const isJpgOrJpegPath = (path) => {
+    if (path === undefined || path === null) {
+        return false;
+    }
+    return path.endsWith(".jpeg") || path.endsWith(".jpg");
+};
+exports.isJpgOrJpegPath = isJpgOrJpegPath;
 /**
  * Checks if value is an IconByName
  *

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":";;;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"]}
+{"version":3,"file":"iconImage.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/iconImage.ts"],"names":[],"mappings":";;;AASA;;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;AAmDF;;;;;GAKG;AACI,MAAM,YAAY,GAAG,CAAC,KAAc,EAAuB,EAAE;IAClE,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,MAAM,IAAI,KAAK;QACf,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;QAC9B,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAC5B,CAAC;AACJ,CAAC,CAAC;AARW,QAAA,YAAY,gBAQvB;AAEF;;;;;GAKG;AACI,MAAM,aAAa,GAAG,CAAC,KAAc,EAAwB,EAAE;IACpE,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,MAAM,IAAI,KAAK;QACf,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;QAC9B,CAAC,IAAA,iBAAS,EAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAA,uBAAe,EAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAA,iBAAS,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAChF,CAAC;AACJ,CAAC,CAAC;AARW,QAAA,aAAa,iBAQxB;AAEF;;;;;GAKG;AACI,MAAM,SAAS,GAAG,CAAC,IAA+B,EAAwB,EAAE;IACjF,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC/B,CAAC,CAAC;AALW,QAAA,SAAS,aAKpB;AAEF;;;;;GAKG;AACI,MAAM,SAAS,GAAG,CAAC,IAA+B,EAAwB,EAAE;IACjF,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC/B,CAAC,CAAC;AALW,QAAA,SAAS,aAKpB;AAEF;;;;;GAKG;AACI,MAAM,eAAe,GAAG,CAAC,IAA+B,EAAyB,EAAE;IACxF,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACzD,CAAC,CAAC;AALW,QAAA,eAAe,mBAK1B;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})`;\n\nexport type SvgImagePath = `${string}.svg`;\nexport type PngImagePath = `${string}.png`;\nexport type JpegImagePath = `${string}.jpeg` | `${string}.jpg`;\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 ImageByPath = {\n  /**\n   * Path relative to the projects src folder defined in the extensions sourceRoot\n   * Supports png, jpeg, jpg and svg files.\n   *\n   * @example \"assets/icon1.png\" or \"assets/icon2.jpeg\" or \"assets/icon3.jpg\" or \"assets/icon4.svg\"\n   */\n  path: PngImagePath | JpegImagePath | SvgImagePath;\n};\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 (\n    typeof value === \"object\" &&\n    value !== null &&\n    \"path\" in value &&\n    typeof value.path === \"string\" &&\n    value.path.endsWith(\".svg\")\n  );\n};\n\n/**\n * Checks if value is a ImageByPath\n *\n * @param value - The value to check\n * @returns {boolean} True if value is a ImageByPath\n */\nexport const isImageByPath = (value: unknown): value is ImageByPath => {\n  return (\n    typeof value === \"object\" &&\n    value !== null &&\n    \"path\" in value &&\n    typeof value.path === \"string\" &&\n    (isPngPath(value.path) || isJpgOrJpegPath(value.path) || isSvgPath(value.path))\n  );\n};\n\n/**\n * Checks if the path is a svg path\n *\n * @param path - The path to check\n * @returns {boolean} True if the path is a svg path\n */\nexport const isSvgPath = (path: string | undefined | null): path is SvgImagePath => {\n  if (path === undefined || path === null) {\n    return false;\n  }\n  return path.endsWith(\".svg\");\n};\n\n/**\n * Checks if the path is a png path\n *\n * @param path - The path to check\n * @returns {boolean} True if the path is a png path\n */\nexport const isPngPath = (path: string | undefined | null): path is PngImagePath => {\n  if (path === undefined || path === null) {\n    return false;\n  }\n  return path.endsWith(\".png\");\n};\n\n/**\n * Checks if the path is a jpeg or jpg path\n *\n * @param path - The path to check\n * @returns {boolean} True if the path is a jpeg or jpg path\n */\nexport const isJpgOrJpegPath = (path: string | undefined | null): path is JpegImagePath => {\n  if (path === undefined || path === null) {\n    return false;\n  }\n  return path.endsWith(\".jpeg\") || path.endsWith(\".jpg\");\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"]}