@trackunit/iris-app-oem-api 0.0.124 → 0.0.126

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [0.0.126](https://github.com/Trackunit/manager/compare/iris-app-oem-api/0.0.125...iris-app-oem-api/0.0.126) (2024-12-09)
+
+## [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)
+
 ## [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)
 
 ### Dependency Updates

package/package.json

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

package/src/types/Branding.d.ts

@@ -0,0 +1,52 @@
+export interface Branding {
+    /**
+     * Conditions for the OEM app to be shown.
+     */
+    conditions: {
+        /**
+         * It is case insensitive so does not matter how you write the brand.
+         *  brand: "trackunit" and brand: "Trackunit" will be the same.
+         *
+         * Brand used/filled out then the asset needs to match the filled out property.
+         */
+        brand: string;
+        /**
+         * Indicates if the asset is licensed by OEM
+         */
+        oemLicensedOnly?: boolean;
+    };
+    /**
+     * Path to an image in the assets folder of the app.
+     * The image will be shown as brand logo.
+     * The image will be shown as fleet list logo of an OEM asset.
+     * Example: typing "MyImage.png" here, will show the file "apps/my-app/assets/MyImage.png"
+     */
+    logoPath?: string;
+    /**
+     * Path to an image in the assets folder of the app.
+     * The image will be shown as banner of an OEM asset.
+     * Example: typing "MyImage.png" here, will show the file "apps/my-app/assets/MyImage.png"
+     */
+    assetBannerPath?: string;
+    /**
+     * Color will be applied to banner and also will used as brand theme color.
+     * It will be a hex code. e.g.: '#FF0000'.
+     */
+    color?: string;
+    /**
+     * Path to an image in the assets folder of the app.
+     * The image will be shown in the Events and Insights tab in Asset home.
+     * Example: typing "MyImage.png" here, will show the file "apps/my-app/assets/MyImage.png"
+     */
+    platformLogoPath?: string;
+    /**
+     * List of model images.
+     * Key will be the model name.
+     * Value will be path to an image in the assets folder of the app.
+     * The image will be shown as the model image in Asset home.
+     * Example: typing "MyImage.png" here, will show the file "apps/my-app/assets/MyImage.png"
+     */
+    modelImages?: {
+        [key: string]: string;
+    };
+}

package/src/types/Branding.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Branding.js.map

package/src/types/Branding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Branding.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-oem-api/src/types/Branding.ts"],"names":[],"mappings":"","sourcesContent":["export 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"]}

package/src/types/EventEnrichment.d.ts

@@ -0,0 +1,113 @@
+/**
+ * Configuration for enriching events.
+ */
+export interface EventEnrichment {
+    /**
+     * Configuration for asset registration.
+     */
+    assetRegistration: AssetRegistrationConfiguration;
+    auth: AuthConfiguration;
+    /**
+     * Configuration for handling fault details.
+     * */
+    fault: FaultConfiguration;
+    /**
+     * Configuration for heartbeats.
+     */
+    heartbeat: HeartbeatConfiguration;
+}
+/**
+ * Configuration for asset registration.
+ */
+export interface AssetRegistrationConfiguration extends ApiRequestConfig {
+    /**
+     * Connecting specific data points to their intended targets or fields.
+     */
+    data: TargetData;
+}
+/**
+ * Authentication configuration for event enrichment.
+ */
+export interface AuthConfiguration extends ApiRequestConfig {
+    /**
+     * Type of authorization protocol. e.g.: Basic, OAuth2
+     */
+    type: "Basic" | "OAuth2";
+}
+/**
+ * Configuration for handling fault details.
+ */
+export interface FaultConfiguration extends ApiRequestConfig {
+    /**
+     * List of fault codes that the OEM app is interested in.
+     */
+    sourceAddresses: number[];
+    /**
+     * Max number of elements when batching.
+     */
+    batchSize?: number;
+    /**
+     * Connecting specific data points to their intended targets or fields.
+     */
+    data: TargetData;
+}
+/**
+ * Configuration for heartbeats.
+ */
+export interface HeartbeatConfiguration extends ApiRequestConfig {
+    /**
+     * Frequency of the heartbeat.
+     */
+    frequency: "PT15M" | "PT1H" | "P1D";
+    /**
+     * Max number of elements when batching.
+     */
+    batchSize?: number;
+    /**
+     * Connecting specific data points to their intended targets or fields.
+     */
+    data: TargetData;
+}
+/**
+ * Common configuration for API requests.
+ */
+export interface ApiRequestConfig {
+    /**
+     * Headers with which to build the request.
+     */
+    headers?: HeadersMap;
+    /**
+     * Body parameters with which to build the request.
+     */
+    bodyParams?: Record<string, string>;
+    /**
+     * URL for the API endpoint.
+     */
+    url: string;
+}
+/**
+ * Mapping of HTTP header keys to values.
+ */
+type HeadersMap = {
+    [key in HeaderKey]: "application/x-www-form-urlencoded" | "application/json" | "multipart/form-data";
+};
+/**
+ * HTTP header keys. More can be added as a union.
+ */
+type HeaderKey = "Content-Type";
+/**
+ * Node attribute. With recursion, together, they allow the backend to dynamically build a payload that supports arrays and objects.
+ */
+export interface TargetData {
+    [sourceName: string]: TargetDataAttributes;
+}
+/**
+ * Attributes for target data mapping.
+ */
+export interface TargetDataAttributes {
+    targetName: string;
+    targetType: "String" | "Number";
+    targetFormat?: "EpochMs" | "EpochS" | "Iso8601";
+    fallbackSourceName?: string;
+}
+export {};

package/src/types/EventEnrichment.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=EventEnrichment.js.map

package/src/types/EventEnrichment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventEnrichment.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-oem-api/src/types/EventEnrichment.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Configuration for enriching events.\n */\nexport interface EventEnrichment {\n  /**\n   * Configuration for asset registration.\n   */\n  assetRegistration: AssetRegistrationConfiguration;\n  /*\n   * Authentication configuration for event enrichment.\n   */\n  auth: AuthConfiguration;\n  /**\n   * Configuration for handling fault details.\n   * */\n  fault: FaultConfiguration;\n  /**\n   * Configuration for heartbeats.\n   */\n  heartbeat: HeartbeatConfiguration;\n}\n\n/**\n * Configuration for asset registration.\n */\nexport interface AssetRegistrationConfiguration extends ApiRequestConfig {\n  /**\n   * Connecting specific data points to their intended targets or fields.\n   */\n  data: TargetData;\n}\n\n/**\n * Authentication configuration for event enrichment.\n */\nexport interface AuthConfiguration extends ApiRequestConfig {\n  /**\n   * Type of authorization protocol. e.g.: Basic, OAuth2\n   */\n  type: \"Basic\" | \"OAuth2\";\n}\n\n/**\n * Configuration for handling fault details.\n */\nexport interface FaultConfiguration extends ApiRequestConfig {\n  /**\n   * List of fault codes that the OEM app is interested in.\n   */\n  sourceAddresses: number[];\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/**\n * Configuration for heartbeats.\n */\nexport interface HeartbeatConfiguration extends ApiRequestConfig {\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/**\n * Common configuration for API requests.\n */\nexport interface ApiRequestConfig {\n  /**\n   * Headers with which to build the request.\n   */\n  headers?: HeadersMap;\n  /**\n   * Body parameters with which to build the request.\n   */\n  bodyParams?: Record<string, string>;\n  /**\n   * URL for the API endpoint.\n   */\n  url: string;\n}\n\n/**\n * Mapping of HTTP header keys to values.\n */\ntype HeadersMap = {\n  [key in HeaderKey]: \"application/x-www-form-urlencoded\" | \"application/json\" | \"multipart/form-data\";\n};\n\n/**\n * HTTP header keys. More can be added as a union.\n */\ntype HeaderKey = \"Content-Type\";\n\n/**\n * Node attribute. With recursion, together, they allow the backend to dynamically build a payload that supports arrays and objects.\n */\nexport interface TargetData {\n  [sourceName: string]: TargetDataAttributes;\n}\n\n/**\n * Attributes for target data mapping.\n */\nexport interface TargetDataAttributes {\n  targetName: string;\n  targetType: \"String\" | \"Number\";\n  targetFormat?: \"EpochMs\" | \"EpochS\" | \"Iso8601\";\n  fallbackSourceName?: string;\n}\n"]}

package/src/types/irisAppOemManifest.d.ts

@@ -1,60 +1,38 @@
 import { IrisAppManifest } from "@trackunit/iris-app-api";
+import { Branding } from "./Branding";
+import { EventEnrichment } from "./EventEnrichment";
 export interface IrisAppOemManifest extends IrisAppManifest {
+    /**
+     * OEM specific configuration.
+     */
+    oem?: OemConfiguration;
     /**
      * OEM Branding, where logos and color will be added for branding.
+     *
+     * @deprecated Use oem.branding instead.
      */
     oemBranding?: Branding;
 }
-export interface Branding {
-    /**
-     * Conditions for the OEM app to be shown.
-     */
-    conditions: {
-        /**
-         * It is case insensitive so does not matter how you write the brand.
-         *  brand: "trackunit" and brand: "Trackunit" will be the same.
-         *
-         * Brand used/filled out then the asset needs to match the filled out property.
-         */
-        brand: string;
-        /**
-         * Indicates if the asset is licensed by OEM
-         */
-        oemLicensedOnly?: boolean;
-    };
+/**
+ * Configuration specific to OEMs.
+ */
+export interface OemConfiguration {
     /**
-     * Path to an image in the assets folder of the app.
-     * The image will be shown as brand logo.
-     * The image will be shown as fleet list logo of an OEM asset.
-     * Example: typing "MyImage.png" here, will show the file "apps/my-app/assets/MyImage.png"
+     * Name is brand used/filled out then the asset needs to match the filled out property.
+     * The brand of the OEM to own these specifications. Used to determine which assets to apply to.
      */
-    logoPath?: string;
+    name: string;
     /**
-     * Path to an image in the assets folder of the app.
-     * The image will be shown as banner of an OEM asset.
-     * Example: typing "MyImage.png" here, will show the file "apps/my-app/assets/MyImage.png"
+     * Type of OEM. e.g.: EngineOem, MachineOem, ToolOem
      */
-    assetBannerPath?: string;
+    type: "EngineOem" | "MachineOem" | "ToolOem";
     /**
-     * Color will be applied to banner and also will used as brand theme color.
-     * It will be a hex code. eg: '#FF0000'.
+     * Event enrichment configuration.
      */
-    color?: string;
+    eventEnrichment?: EventEnrichment;
     /**
-     * Path to an image in the assets folder of the app.
-     * The image will be shown in the Events and Insights tab in Asset home.
-     * Example: typing "MyImage.png" here, will show the file "apps/my-app/assets/MyImage.png"
-     */
-    platformLogoPath?: string;
-    /**
-     * List of model images.
-     * Key will be the model name.
-     * Value will be path to an image in the assets folder of the app.
-     * The image will be shown as the model image in Asset home.
-     * Example: typing "MyImage.png" here, will show the file "apps/my-app/assets/MyImage.png"
+     * OEM Branding, where logos and color will be added for branding.
      */
-    modelImages?: {
-        [key: string]: string;
-    };
+    branding?: Branding;
 }
 export type PublicIrisAppOemManifest = Omit<IrisAppOemManifest, "dependencies" | "devDependencies" | "installation">;

package/src/types/irisAppOemManifest.js.map

@@ -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. eg: '#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\nexport type PublicIrisAppOemManifest = Omit<IrisAppOemManifest, \"dependencies\" | \"devDependencies\" | \"installation\">;\n"]}
+{"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\";\nimport { Branding } from \"./Branding\";\nimport { EventEnrichment } from \"./EventEnrichment\";\n\nexport interface IrisAppOemManifest extends IrisAppManifest {\n  /**\n   * OEM specific configuration.\n   */\n  oem?: OemConfiguration;\n  /**\n   * OEM Branding, where logos and color will be added for branding.\n   *\n   * @deprecated Use oem.branding instead.\n   */\n  oemBranding?: Branding;\n}\n\n/**\n * Configuration specific to OEMs.\n */\nexport interface OemConfiguration {\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\nexport type PublicIrisAppOemManifest = Omit<IrisAppOemManifest, \"dependencies\" | \"devDependencies\" | \"installation\">;\n"]}