@trackunit/iris-app-oem-api 1.12.1 → 1.12.2

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.12.2 (2026-03-04)
+
+### 🧱 Updated Dependencies
+
+- Updated iris-app-api to 1.14.53
+
 ## 1.12.1 (2026-03-04)
 
 ### 🧱 Updated Dependencies

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@trackunit/iris-app-oem-api",
-  "version": "1.12.1",
+  "version": "1.12.2",
   "license": "SEE LICENSE IN LICENSE.txt",
   "repository": "https://github.com/Trackunit/manager",
   "engines": {
     "node": ">=24.x"
   },
   "dependencies": {
-    "@trackunit/iris-app-api": "1.14.52",
+    "@trackunit/iris-app-api": "1.14.53",
     "tslib": "^2.6.2"
   },
   "types": "./src/index.d.ts",

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../libs/iris-app-sdk/iris-app-oem-api/src/index.ts"],"names":[],"mappings":";;;AAAA,qEAA2C","sourcesContent":["export * from \"./types/irisAppOemManifest\";\n"]}

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 AssetBranding {\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     * @deprecated Use oem.name instead.\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\nexport interface EngineBranding {\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   * Additional properties are not allowed in EngineBranding.\n   */\n  conditions?: never;\n  assetBannerPath?: never;\n  platformLogoPath?: never;\n  color?: never;\n  oemLicensedOnly?: never;\n}\n"]}

package/src/types/FaultEnrichment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FaultEnrichment.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-oem-api/src/types/FaultEnrichment.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Configuration for enriching events.\n */\nexport interface FaultEnrichment {\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 code.\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: Array<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  [KeyHeader 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\" | \"Array\" | \"Object\";\n  targetFormat?: \"EpochMs\" | \"EpochS\" | \"Iso8601\" | \"Empty\" | \"LowerCase\" | \"Null\" | \"UpperCase\";\n  fallbackSourceName?: string;\n  data?: TargetData;\n}\n"]}

package/src/types/irisAppOemManifest.js.map

@@ -0,0 +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\";\nimport { AssetBranding, EngineBranding } from \"./Branding\";\nimport { FaultEnrichment } from \"./FaultEnrichment\";\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?: AssetBranding | EngineBranding;\n}\n\n/**\n * Common properties for OEM configuration.\n */\ninterface CommonOemConfiguration {\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   * Event enrichment configuration.\n   */\n  faultEnrichment?: FaultEnrichment;\n}\n\n/**\n * Configuration specific to OEMs.\n */\nexport type OemConfiguration =\n  | (CommonOemConfiguration & {\n      /**\n       * Type of OEM. e.g.: EngineOem, MachineOem\n       */\n      type: \"EngineOem\";\n\n      /**\n       * OEM Branding, where logos and color will be added for branding.\n       * Conditionally set to EngineBranding or AssetBranding based on the type.\n       */\n      branding?: EngineBranding;\n    })\n  | (CommonOemConfiguration & {\n      /**\n       * Type of OEM. e.g.: EngineOem, MachineOem\n       */\n      type: \"MachineOem\";\n\n      /**\n       * OEM Branding, where logos and color will be added for branding.\n       * Conditionally set to EngineBranding or AssetBranding based on the type.\n       */\n      branding?: AssetBranding;\n    });\n\nexport type PublicIrisAppOemManifest = Omit<IrisAppOemManifest, \"dependencies\" | \"devDependencies\" | \"installation\">;\n"]}