@trackunit/iris-app-oem-api 0.0.124 → 0.0.125
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
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
|
|
4
4
|
|
|
5
|
+
## [0.0.125](https://github.com/Trackunit/manager/compare/iris-app-oem-api/0.0.124...iris-app-oem-api/0.0.125) (2024-12-04)
|
|
6
|
+
|
|
5
7
|
## [0.0.124](https://github.com/Trackunit/manager/compare/iris-app-oem-api/0.0.123...iris-app-oem-api/0.0.124) (2024-12-02)
|
|
6
8
|
|
|
7
9
|
### Dependency Updates
|
package/package.json
CHANGED
|
@@ -1,5 +1,27 @@
|
|
|
1
1
|
import { IrisAppManifest } from "@trackunit/iris-app-api";
|
|
2
2
|
export interface IrisAppOemManifest extends IrisAppManifest {
|
|
3
|
+
/**
|
|
4
|
+
* OEM specific configuration.
|
|
5
|
+
*/
|
|
6
|
+
oem?: {
|
|
7
|
+
/**
|
|
8
|
+
* Name is brand used/filled out then the asset needs to match the filled out property.
|
|
9
|
+
* The brand of the OEM to own these specifications. Used to determine which assets to apply to.
|
|
10
|
+
*/
|
|
11
|
+
name: string;
|
|
12
|
+
/**
|
|
13
|
+
* Type of OEM. e.g.: EngineOem, MachineOem, ToolOem
|
|
14
|
+
*/
|
|
15
|
+
type: "EngineOem" | "MachineOem" | "ToolOem";
|
|
16
|
+
/**
|
|
17
|
+
* Event enrichment configuration.
|
|
18
|
+
*/
|
|
19
|
+
eventEnrichment?: EventEnrichment;
|
|
20
|
+
/**
|
|
21
|
+
* OEM Branding, where logos and color will be added for branding.
|
|
22
|
+
*/
|
|
23
|
+
branding?: Branding;
|
|
24
|
+
};
|
|
3
25
|
/**
|
|
4
26
|
* OEM Branding, where logos and color will be added for branding.
|
|
5
27
|
*/
|
|
@@ -37,7 +59,7 @@ export interface Branding {
|
|
|
37
59
|
assetBannerPath?: string;
|
|
38
60
|
/**
|
|
39
61
|
* Color will be applied to banner and also will used as brand theme color.
|
|
40
|
-
* It will be a hex code.
|
|
62
|
+
* It will be a hex code. e.g.: '#FF0000'.
|
|
41
63
|
*/
|
|
42
64
|
color?: string;
|
|
43
65
|
/**
|
|
@@ -57,4 +79,67 @@ export interface Branding {
|
|
|
57
79
|
[key: string]: string;
|
|
58
80
|
};
|
|
59
81
|
}
|
|
82
|
+
interface TargetData {
|
|
83
|
+
[sourceName: string]: {
|
|
84
|
+
targetName: string;
|
|
85
|
+
targetType: "String" | "Number";
|
|
86
|
+
targetFormat?: "EpochMs" | "EpochS" | "Iso8601";
|
|
87
|
+
fallbackSourceName?: string;
|
|
88
|
+
};
|
|
89
|
+
}
|
|
90
|
+
export interface EventEnrichment {
|
|
91
|
+
auth: {
|
|
92
|
+
/**
|
|
93
|
+
* URL to the auth endpoint.
|
|
94
|
+
*/
|
|
95
|
+
url: string;
|
|
96
|
+
/**
|
|
97
|
+
* Type of authorization protocol. e.g.: Basic, OAuth2
|
|
98
|
+
*/
|
|
99
|
+
type: "Basic" | "OAuth2";
|
|
100
|
+
};
|
|
101
|
+
fault: {
|
|
102
|
+
/**
|
|
103
|
+
* URL to deliver the fault details.
|
|
104
|
+
*/
|
|
105
|
+
url: string;
|
|
106
|
+
/**
|
|
107
|
+
* List of fault codes that the OEM app is interested in.
|
|
108
|
+
*/
|
|
109
|
+
sourceAddresses: number[];
|
|
110
|
+
/**
|
|
111
|
+
* Connecting specific data points to their intended targets or fields.
|
|
112
|
+
*/
|
|
113
|
+
data: TargetData;
|
|
114
|
+
};
|
|
115
|
+
assetRegistration: {
|
|
116
|
+
/**
|
|
117
|
+
* URL to the asset registration endpoint.
|
|
118
|
+
*/
|
|
119
|
+
url: string;
|
|
120
|
+
/**
|
|
121
|
+
* Connecting specific data points to their intended targets or fields.
|
|
122
|
+
*/
|
|
123
|
+
data: TargetData;
|
|
124
|
+
};
|
|
125
|
+
heartbeat: {
|
|
126
|
+
/**
|
|
127
|
+
* URL to the heartbeat endpoint.
|
|
128
|
+
*/
|
|
129
|
+
url: string;
|
|
130
|
+
/**
|
|
131
|
+
* Frequency of the heartbeat.
|
|
132
|
+
*/
|
|
133
|
+
frequency: "PT15M" | "PT1H" | "P1D";
|
|
134
|
+
/**
|
|
135
|
+
* Max number of elements when batching.
|
|
136
|
+
*/
|
|
137
|
+
batchSize?: number;
|
|
138
|
+
/**
|
|
139
|
+
* Connecting specific data points to their intended targets or fields.
|
|
140
|
+
*/
|
|
141
|
+
data: TargetData;
|
|
142
|
+
};
|
|
143
|
+
}
|
|
60
144
|
export type PublicIrisAppOemManifest = Omit<IrisAppOemManifest, "dependencies" | "devDependencies" | "installation">;
|
|
145
|
+
export {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"irisAppOemManifest.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-oem-api/src/types/irisAppOemManifest.ts"],"names":[],"mappings":"","sourcesContent":["import { IrisAppManifest } from \"@trackunit/iris-app-api\";\n\nexport interface IrisAppOemManifest extends IrisAppManifest {\n /**\n * OEM Branding, where logos and color will be added for branding.\n */\n oemBranding?: Branding;\n}\n\nexport interface Branding {\n /**\n * Conditions for the OEM app to be shown.\n */\n conditions: {\n /**\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 * Brand used/filled out then the asset needs to match the filled out property.\n */\n brand: string;\n /**\n * Indicates if the asset is licensed by OEM\n */\n oemLicensedOnly?: boolean;\n };\n /**\n * Path to an image in the assets folder of the app.\n * The image will be shown as brand logo.\n * The image will be shown as fleet list logo of an OEM asset.\n * Example: typing \"MyImage.png\" here, will show the file \"apps/my-app/assets/MyImage.png\"\n */\n logoPath?: string;\n /**\n * Path to an image in the assets folder of the app.\n * The image will be shown as banner of an OEM asset.\n * Example: typing \"MyImage.png\" here, will show the file \"apps/my-app/assets/MyImage.png\"\n */\n assetBannerPath?: string;\n /**\n * Color will be applied to banner and also will used as brand theme color.\n * It will be a hex code.
|
|
1
|
+
{"version":3,"file":"irisAppOemManifest.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-oem-api/src/types/irisAppOemManifest.ts"],"names":[],"mappings":"","sourcesContent":["import { IrisAppManifest } from \"@trackunit/iris-app-api\";\n\nexport interface IrisAppOemManifest extends IrisAppManifest {\n /**\n * OEM specific configuration.\n */\n oem?: {\n /**\n * Name is brand used/filled out then the asset needs to match the filled out property.\n * The brand of the OEM to own these specifications. Used to determine which assets to apply to.\n */\n name: string;\n /**\n * Type of OEM. e.g.: EngineOem, MachineOem, ToolOem\n */\n type: \"EngineOem\" | \"MachineOem\" | \"ToolOem\";\n /**\n * Event enrichment configuration.\n */\n eventEnrichment?: EventEnrichment;\n /**\n * OEM Branding, where logos and color will be added for branding.\n */\n branding?: Branding;\n };\n /**\n * OEM Branding, where logos and color will be added for branding.\n */\n oemBranding?: Branding;\n}\n\nexport interface Branding {\n /**\n * Conditions for the OEM app to be shown.\n */\n conditions: {\n /**\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 * Brand used/filled out then the asset needs to match the filled out property.\n */\n brand: string;\n /**\n * Indicates if the asset is licensed by OEM\n */\n oemLicensedOnly?: boolean;\n };\n /**\n * Path to an image in the assets folder of the app.\n * The image will be shown as brand logo.\n * The image will be shown as fleet list logo of an OEM asset.\n * Example: typing \"MyImage.png\" here, will show the file \"apps/my-app/assets/MyImage.png\"\n */\n logoPath?: string;\n /**\n * Path to an image in the assets folder of the app.\n * The image will be shown as banner of an OEM asset.\n * Example: typing \"MyImage.png\" here, will show the file \"apps/my-app/assets/MyImage.png\"\n */\n assetBannerPath?: string;\n /**\n * Color will be applied to banner and also will used as brand theme color.\n * It will be a hex code. e.g.: '#FF0000'.\n */\n color?: string;\n /**\n * Path to an image in the assets folder of the app.\n * The image will be shown in the Events and Insights tab in Asset home.\n * Example: typing \"MyImage.png\" here, will show the file \"apps/my-app/assets/MyImage.png\"\n */\n platformLogoPath?: string;\n /**\n * List of model images.\n * Key will be the model name.\n * Value will be path to an image in the assets folder of the app.\n * The image will be shown as the model image in Asset home.\n * Example: typing \"MyImage.png\" here, will show the file \"apps/my-app/assets/MyImage.png\"\n */\n modelImages?: { [key: string]: string };\n}\n\ninterface TargetData {\n [sourceName: string]: {\n targetName: string;\n targetType: \"String\" | \"Number\";\n targetFormat?: \"EpochMs\" | \"EpochS\" | \"Iso8601\";\n fallbackSourceName?: string;\n };\n}\n\nexport interface EventEnrichment {\n auth: {\n /**\n * URL to the auth endpoint.\n */\n url: string;\n /**\n * Type of authorization protocol. e.g.: Basic, OAuth2\n */\n type: \"Basic\" | \"OAuth2\";\n };\n fault: {\n /**\n * URL to deliver the fault details.\n */\n url: string;\n /**\n * List of fault codes that the OEM app is interested in.\n */\n sourceAddresses: number[];\n /**\n * Connecting specific data points to their intended targets or fields.\n */\n data: TargetData;\n };\n assetRegistration: {\n /**\n * URL to the asset registration endpoint.\n */\n url: string;\n /**\n * Connecting specific data points to their intended targets or fields.\n */\n data: TargetData;\n };\n heartbeat: {\n /**\n * URL to the heartbeat endpoint.\n */\n url: string;\n /**\n * Frequency of the heartbeat.\n */\n frequency: \"PT15M\" | \"PT1H\" | \"P1D\";\n /**\n * Max number of elements when batching.\n */\n batchSize?: number;\n /**\n * Connecting specific data points to their intended targets or fields.\n */\n data: TargetData;\n };\n}\n\nexport type PublicIrisAppOemManifest = Omit<IrisAppOemManifest, \"dependencies\" | \"devDependencies\" | \"installation\">;\n"]}
|