@trackunit/iris-app-oem-api 1.3.147 → 1.3.149-alpha-bd113689dde.0
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
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@trackunit/iris-app-oem-api",
|
|
3
|
-
"version": "1.3.
|
|
3
|
+
"version": "1.3.149-alpha-bd113689dde.0",
|
|
4
4
|
"license": "SEE LICENSE IN LICENSE.txt",
|
|
5
5
|
"repository": "https://github.com/Trackunit/manager",
|
|
6
6
|
"engines": {
|
|
7
7
|
"node": ">=22.x"
|
|
8
8
|
},
|
|
9
9
|
"dependencies": {
|
|
10
|
-
"@trackunit/iris-app-api": "1.3.
|
|
10
|
+
"@trackunit/iris-app-api": "1.3.149-alpha-bd113689dde.0",
|
|
11
11
|
"tslib": "^2.6.2"
|
|
12
12
|
},
|
|
13
13
|
"types": "./src/index.d.ts",
|
|
@@ -1 +1 @@
|
|
|
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: number
|
|
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 [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"]}
|