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

package/CHANGELOG.md

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

package/package.json

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

package/src/types/EventEnrichment.d.ts

@@ -106,8 +106,9 @@ export interface TargetData {
  */
 export interface TargetDataAttributes {
     targetName: string;
-    targetType: "String" | "Number";
+    targetType: "String" | "Number" | "Array" | "Object";
     targetFormat?: "EpochMs" | "EpochS" | "Iso8601";
     fallbackSourceName?: string;
+    data?: TargetData;
 }
 export {};

package/src/types/EventEnrichment.js.map

@@ -1 +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"]}
+{"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\" | \"Array\" | \"Object\";\n  targetFormat?: \"EpochMs\" | \"EpochS\" | \"Iso8601\";\n  fallbackSourceName?: string;\n  data?: TargetData;\n}\n"]}