@trackunit/iris-app-api 1.3.97 → 1.3.101

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,19 @@
1
+ ## 1.3.101 (2025-05-09)
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.100 (2025-05-08)
6
+
7
+ This was a version bump only for iris-app-api to align it with other projects, there were no code changes.
8
+
9
+ ## 1.3.99 (2025-05-08)
10
+
11
+ This was a version bump only for iris-app-api to align it with other projects, there were no code changes.
12
+
13
+ ## 1.3.98 (2025-05-07)
14
+
15
+ This was a version bump only for iris-app-api to align it with other projects, there were no code changes.
16
+
1
17
  ## 1.3.97 (2025-05-06)
2
18
 
3
19
  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.97",
3
+ "version": "1.3.101",
4
4
  "license": "SEE LICENSE IN LICENSE.txt",
5
5
  "repository": "https://github.com/Trackunit/manager",
6
6
  "engines": {
@@ -1,25 +1,5 @@
1
1
  import { IconByName, IconByPath } from "../iconImage";
2
2
  import { AbstractExtensionManifest, TranslationKey, Translations } from "../irisAppExtensionManifest";
3
- export type WidgetBreakpointTypes = "sm" | "lg";
4
- export declare const widgetBreakpointTypes: WidgetBreakpointTypes[];
5
- export interface WidgetGridOptions {
6
- /**
7
- * Minimum width in grid units.
8
- */
9
- minW?: number | undefined;
10
- /**
11
- * Maximum width in grid units.
12
- */
13
- maxW?: number | undefined;
14
- /**
15
- * Minimum height in grid units.
16
- */
17
- minH?: number | undefined;
18
- /**
19
- * Maximum height in grid units.
20
- */
21
- maxH?: number | undefined;
22
- }
23
3
  export type WidgetSupportedLocations = "MY_HOME" | "SITE_HOME";
24
4
  export type WidgetSupportedFilters = "CUSTOMERS" | "ASSETS" | "SITES" | "TIME_RANGE";
25
5
  /**
@@ -27,6 +7,14 @@ export type WidgetSupportedFilters = "CUSTOMERS" | "ASSETS" | "SITES" | "TIME_RA
27
7
  */
28
8
  export interface WidgetExtensionManifest extends AbstractExtensionManifest {
29
9
  type: "WIDGET_EXTENSION";
10
+ widgetType: "KPI" | "CHART" | "LIST" | "MAP" | "OTHER";
11
+ size: {
12
+ default: {
13
+ width: 1 | 2 | 3 | 4 | 5 | 6;
14
+ height: 1 | 2 | 3 | 4 | 5 | 6;
15
+ };
16
+ allowFullWidth?: boolean;
17
+ };
30
18
  header: {
31
19
  /**
32
20
  * The name of the widget to display in the header
@@ -63,8 +51,4 @@ export interface WidgetExtensionManifest extends AbstractExtensionManifest {
63
51
  * The filters that the widget can be filtered by.
64
52
  */
65
53
  supportedFilters?: WidgetSupportedFilters[];
66
- /**
67
- * The grid options for the widget.
68
- */
69
- gridOptions?: WidgetGridOptions;
70
54
  }
@@ -1,5 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.widgetBreakpointTypes = void 0;
4
- exports.widgetBreakpointTypes = ["sm", "lg"];
5
3
  //# 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":";;;AAIa,QAAA,qBAAqB,GAA4B,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC","sourcesContent":["import { IconByName, IconByPath } from \"../iconImage\";\nimport { AbstractExtensionManifest, TranslationKey, Translations } from \"../irisAppExtensionManifest\";\n\nexport type WidgetBreakpointTypes = \"sm\" | \"lg\";\nexport const widgetBreakpointTypes: WidgetBreakpointTypes[] = [\"sm\", \"lg\"];\n\nexport interface WidgetGridOptions {\n /**\n * Minimum width in grid units.\n */\n minW?: number | undefined;\n\n /**\n * Maximum width in grid units.\n */\n maxW?: number | undefined;\n\n /**\n * Minimum height in grid units.\n */\n minH?: number | undefined;\n\n /**\n * Maximum height in grid units.\n */\n maxH?: number | undefined;\n}\n\nexport type WidgetSupportedLocations = \"MY_HOME\" | \"SITE_HOME\";\n\nexport type WidgetSupportedFilters = \"CUSTOMERS\" | \"ASSETS\" | \"SITES\" | \"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 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 /**\n * The grid options for the widget.\n */\n gridOptions?: WidgetGridOptions;\n}\n"]}
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 WidgetSupportedFilters = \"CUSTOMERS\" | \"ASSETS\" | \"SITES\" | \"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"]}