@trackunit/iris-app-api 1.3.129 → 1.3.131

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,3 +1,11 @@
1
+ ## 1.3.131 (2025-05-28)
2
+
3
+ This was a version bump only for iris-app-api to align it with other projects, there were no code changes.
4
+
5
+ ## 1.3.130 (2025-05-28)
6
+
7
+ This was a version bump only for iris-app-api to align it with other projects, there were no code changes.
8
+
1
9
  ## 1.3.129 (2025-05-28)
2
10
 
3
11
  This was a version bump only for iris-app-api to align it with other projects, there were no code changes.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@trackunit/iris-app-api",
3
- "version": "1.3.129",
3
+ "version": "1.3.131",
4
4
  "license": "SEE LICENSE IN LICENSE.txt",
5
5
  "repository": "https://github.com/Trackunit/manager",
6
6
  "engines": {
@@ -3,12 +3,20 @@ import { AbstractExtensionManifest, TranslationKey, Translations } from "../iris
3
3
  export type WidgetSupportedLocations = "MY_HOME" | "SITE_HOME";
4
4
  export type WidgetSupportedFilterBars = "CUSTOMERS" | "ASSETS" | "SITES";
5
5
  export type WidgetSupportedFilters = WidgetSupportedFilterBars | "TIME_RANGE";
6
+ export declare const widgetTypes: readonly ["KPI", "CHART", "LIST", "MAP", "OTHER"];
7
+ export type WidgetType = (typeof widgetTypes)[number];
6
8
  /**
7
9
  * BETA! DONT USE THIS YET - its under development
8
10
  */
9
11
  export interface WidgetExtensionManifest extends AbstractExtensionManifest {
10
12
  type: "WIDGET_EXTENSION";
11
- widgetType: "KPI" | "CHART" | "LIST" | "MAP" | "OTHER";
13
+ preview?: {
14
+ /**
15
+ * The description of the widget to display on Adding drawer.
16
+ */
17
+ description?: string | Translations | TranslationKey;
18
+ };
19
+ widgetType: WidgetType;
12
20
  size: {
13
21
  default: {
14
22
  width: 1 | 2 | 3 | 4 | 5 | 6;
@@ -1,3 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.widgetTypes = void 0;
4
+ exports.widgetTypes = ["KPI", "CHART", "LIST", "MAP", "OTHER"];
3
5
  //# sourceMappingURL=widgetExtensionManifest.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"widgetExtensionManifest.js","sourceRoot":"","sources":["../../../../../../../libs/iris-app-sdk/iris-app-api/src/types/extensions/widgetExtensionManifest.ts"],"names":[],"mappings":"","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\n/**\n * BETA! DONT USE THIS YET - its under development\n */\nexport interface WidgetExtensionManifest extends AbstractExtensionManifest {\n type: \"WIDGET_EXTENSION\";\n\n widgetType: \"KPI\" | \"CHART\" | \"LIST\" | \"MAP\" | \"OTHER\";\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"]}
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"]}