@trackunit/iris-app-api 1.3.138 → 1.3.141

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 1.3.141 (2025-06-10)
+
+This was a version bump only for iris-app-api to align it with other projects, there were no code changes.
+
+## 1.3.140 (2025-06-10)
+
+This was a version bump only for iris-app-api to align it with other projects, there were no code changes.
+
+## 1.3.139 (2025-06-09)
+
+This was a version bump only for iris-app-api to align it with other projects, there were no code changes.
+
 ## 1.3.138 (2025-06-08)
 
 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.3.138",
+  "version": "1.3.141",
   "license": "SEE LICENSE IN LICENSE.txt",
   "repository": "https://github.com/Trackunit/manager",
   "engines": {

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

@@ -5,8 +5,32 @@ export type WidgetSupportedFilterBars = "CUSTOMERS" | "ASSETS" | "SITES";
 export type WidgetSupportedFilters = WidgetSupportedFilterBars | "TIME_RANGE";
 export declare const widgetTypes: readonly ["KPI", "CHART", "LIST", "MAP", "OTHER"];
 export type WidgetType = (typeof widgetTypes)[number];
+export declare const allAssetFilterKeys: readonly ["search", "siteIds", "groups", "types", "assetType", "brands", "models", "criticality", "activity", "metadataCompleteness", "lastSeen", "followed", "siteType", "ownerAccountIds", "area", "partner", "productionYears", "serviceStatus", "telematicsConnected", "activeFilter", "siteDepotOwnershipIds"];
+export declare const customFieldFilterKey: "customFields";
+export type AssetFilterKeys = typeof allAssetFilterKeys;
+export declare const allAssetFilterKeysWithCustomFields: readonly ["search", "siteIds", "groups", "types", "assetType", "brands", "models", "criticality", "activity", "metadataCompleteness", "lastSeen", "followed", "siteType", "ownerAccountIds", "area", "partner", "productionYears", "serviceStatus", "telematicsConnected", "activeFilter", "siteDepotOwnershipIds", "customFields"];
+export type AssetFilterKeysWithCustomFields = typeof allAssetFilterKeysWithCustomFields;
+export declare const allSiteFilterKeys: readonly ["search", "siteStatus", "siteType"];
+export type SiteFilterKeys = typeof allSiteFilterKeys;
+export declare const allSiteFilterKeysWithCustomFields: readonly ["search", "siteStatus", "siteType", "customFields"];
+export type SiteFilterKeysWithCustomFields = typeof allSiteFilterKeysWithCustomFields;
+export declare const allCustomerFilterKeys: readonly ["search", "customerType", "criticality", "servicePlan"];
+export type CustomerFilterKeys = typeof allCustomerFilterKeys;
+export declare const allCustomerFilterKeysWithCustomFields: readonly ["search", "customerType", "criticality", "servicePlan", "customFields"];
+export type CustomerFilterKeysWithCustomFields = typeof allCustomerFilterKeysWithCustomFields;
+export declare const allTimeRangeFilterKeys: readonly ["ALL"];
+export type TimeRangeFilterKeys = typeof allTimeRangeFilterKeys;
+type FilterConfig<TFilterKeys extends readonly string[]> = {
+    include: TFilterKeys[number][];
+};
+export type SupportedFiltersConfig = {
+    ASSETS?: FilterConfig<AssetFilterKeysWithCustomFields>;
+    SITES?: FilterConfig<SiteFilterKeysWithCustomFields>;
+    CUSTOMERS?: FilterConfig<CustomerFilterKeysWithCustomFields>;
+    TIME_RANGE?: FilterConfig<TimeRangeFilterKeys>;
+};
 /**
- * BETA! DONT USE THIS YET - its under development
+ * BETA! DO NOT USE THIS YET - its under development
  */
 export interface WidgetExtensionManifest extends AbstractExtensionManifest {
     type: "WIDGET_EXTENSION";
@@ -59,5 +83,6 @@ export interface WidgetExtensionManifest extends AbstractExtensionManifest {
     /**
      * The filters that the widget can be filtered by.
      */
-    supportedFilters?: WidgetSupportedFilters[];
+    supportedFilters?: SupportedFiltersConfig;
 }
+export {};

package/src/types/extensions/widgetExtensionManifest.js

@@ -1,5 +1,35 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.widgetTypes = void 0;
+exports.allTimeRangeFilterKeys = exports.allCustomerFilterKeysWithCustomFields = exports.allCustomerFilterKeys = exports.allSiteFilterKeysWithCustomFields = exports.allSiteFilterKeys = exports.allAssetFilterKeysWithCustomFields = exports.customFieldFilterKey = exports.allAssetFilterKeys = exports.widgetTypes = void 0;
 exports.widgetTypes = ["KPI", "CHART", "LIST", "MAP", "OTHER"];
+exports.allAssetFilterKeys = [
+    "search",
+    "siteIds",
+    "groups",
+    "types",
+    "assetType",
+    "brands",
+    "models",
+    "criticality",
+    "activity",
+    "metadataCompleteness",
+    "lastSeen",
+    "followed",
+    "siteType",
+    "ownerAccountIds",
+    "area",
+    "partner",
+    "productionYears",
+    "serviceStatus",
+    "telematicsConnected",
+    "activeFilter",
+    "siteDepotOwnershipIds",
+];
+exports.customFieldFilterKey = "customFields";
+exports.allAssetFilterKeysWithCustomFields = [...exports.allAssetFilterKeys, exports.customFieldFilterKey];
+exports.allSiteFilterKeys = ["search", "siteStatus", "siteType"];
+exports.allSiteFilterKeysWithCustomFields = [...exports.allSiteFilterKeys, exports.customFieldFilterKey];
+exports.allCustomerFilterKeys = ["search", "customerType", "criticality", "servicePlan"];
+exports.allCustomerFilterKeysWithCustomFields = [...exports.allCustomerFilterKeys, exports.customFieldFilterKey];
+exports.allTimeRangeFilterKeys = ["ALL"];
 //# sourceMappingURL=widgetExtensionManifest.js.map

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","sourcesContent":["import { IconByName, IconByPath } from \"../iconImage\";\nimport { AbstractExtensionManifest, TranslationKey, Translations } from \"../irisAppExtensionManifest\";\n\nexport type WidgetSupportedLocations = \"MY_HOME\" | \"SITE_HOME\";\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\n/**\n * BETA! DONT 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 to display on Adding drawer.\n     */\n    description?: string | Translations | TranslationKey;\n  };\n\n  widgetType: WidgetType;\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\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     */\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\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 absolute path to the route of the extension you want to link to.\n     */\n    link: string;\n\n    /**\n     * The powered by image to display in the footer.\n     */\n    poweredByImage?: IconByPath;\n  };\n\n  /**\n   * The locations where the widget can be placed.\n   */\n  supportedLocations: WidgetSupportedLocations[];\n\n  /**\n   * The filters that the widget can be filtered by.\n   */\n  supportedFilters?: WidgetSupportedFilters[];\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,oBAAoB,GAAG,cAAuB,CAAC;AAE/C,QAAA,kCAAkC,GAAG,CAAC,GAAG,0BAAkB,EAAE,4BAAoB,CAAU,CAAC;AAG5F,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\";\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 customFieldFilterKey = \"customFields\" as const;\nexport type AssetFilterKeys = typeof allAssetFilterKeys;\nexport const allAssetFilterKeysWithCustomFields = [...allAssetFilterKeys, 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 readonly string[]> = {\n  include: 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 to display on Adding drawer.\n     */\n    description?: string | Translations | TranslationKey;\n  };\n\n  widgetType: WidgetType;\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\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     */\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\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 absolute path to the route of the extension you want to link to.\n     */\n    link: string;\n\n    /**\n     * The powered by image to display in the footer.\n     */\n    poweredByImage?: IconByPath;\n  };\n\n  /**\n   * The locations where the widget can be placed.\n   */\n  supportedLocations: WidgetSupportedLocations[];\n\n  /**\n   * The filters that the widget can be filtered by.\n   */\n  supportedFilters?: SupportedFiltersConfig;\n}\n"]}