@enyo-energy/energy-app-sdk 0.0.112 → 0.0.113

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.
@@ -38,6 +38,30 @@ export declare enum EnyoApplianceStatusEnum {
38
38
  /** Appliance has reported an internal fault */
39
39
  Faulted = "faulted"
40
40
  }
41
+ /**
42
+ * Translated, human-readable message for an appliance error code.
43
+ * Producers should emit at most one entry per supported language.
44
+ */
45
+ export interface EnyoApplianceErrorMessage {
46
+ /** Language code for this translation */
47
+ language: EnergyAppPackageLanguage;
48
+ /** Localized message describing the error to end users */
49
+ message: string;
50
+ }
51
+ /**
52
+ * Vendor- or protocol-specific error reported by an appliance, optionally
53
+ * accompanied by translated human-readable messages. The `code` is the
54
+ * machine-readable identifier (stable, non-localized); `messages` is an
55
+ * optional set of pre-translated descriptions intended for UI display.
56
+ * Consumers should fall back to rendering `code` when no `messages` entry
57
+ * matches their locale.
58
+ */
59
+ export interface EnyoApplianceErrorCode {
60
+ /** Machine-readable, vendor- or protocol-specific error code */
61
+ code: string;
62
+ /** Optional translated messages explaining the error */
63
+ messages?: EnyoApplianceErrorMessage[];
64
+ }
41
65
  export interface EnyoApplianceNetworkMetadata {
42
66
  /** If the appliance is connected via cellular network, you can put the imsi here*/
43
67
  imsi?: string;
@@ -1,4 +1,4 @@
1
- import { EnyoApplianceStateEnum, EnyoApplianceStatusEnum, EnyoApplianceTypeEnum } from "./enyo-appliance.cjs";
1
+ import { EnyoApplianceErrorCode, EnyoApplianceStateEnum, EnyoApplianceStatusEnum, EnyoApplianceTypeEnum } from "./enyo-appliance.cjs";
2
2
  import { EnyoSourceEnum } from "./enyo-source.enum.cjs";
3
3
  import { EnyoOcppRelativeSchedule } from "./enyo-ocpp.cjs";
4
4
  import { EnyoChargerApplianceStatusEnum } from "./enyo-charger-appliance.cjs";
@@ -344,10 +344,12 @@ export interface EnyoDataBusApplianceStateUpdateV1 extends EnyoDataBusMessage {
344
344
  status?: EnyoApplianceStatusEnum;
345
345
  /**
346
346
  * Optional vendor- or protocol-specific error codes that explain the
347
- * current status. Typically populated when transitioning into
348
- * `faulted`; omitted or empty when there is nothing to report.
347
+ * current status. Each entry carries the raw code and may include
348
+ * pre-translated messages for UI display. Typically populated when
349
+ * transitioning into `faulted`; omitted or empty when there is
350
+ * nothing to report.
349
351
  */
350
- errorCodes?: string[];
352
+ errorCodes?: EnyoApplianceErrorCode[];
351
353
  };
352
354
  }
353
355
  export interface EnyoDataBusChargingStartedV1 extends EnyoDataBusMessage {
@@ -9,7 +9,7 @@ exports.getSdkVersion = getSdkVersion;
9
9
  /**
10
10
  * Current version of the enyo Energy App SDK.
11
11
  */
12
- exports.SDK_VERSION = '0.0.112';
12
+ exports.SDK_VERSION = '0.0.113';
13
13
  /**
14
14
  * Gets the current SDK version.
15
15
  * @returns The semantic version string of the SDK
@@ -5,7 +5,7 @@
5
5
  /**
6
6
  * Current version of the enyo Energy App SDK.
7
7
  */
8
- export declare const SDK_VERSION = "0.0.112";
8
+ export declare const SDK_VERSION = "0.0.113";
9
9
  /**
10
10
  * Gets the current SDK version.
11
11
  * @returns The semantic version string of the SDK
@@ -38,6 +38,30 @@ export declare enum EnyoApplianceStatusEnum {
38
38
  /** Appliance has reported an internal fault */
39
39
  Faulted = "faulted"
40
40
  }
41
+ /**
42
+ * Translated, human-readable message for an appliance error code.
43
+ * Producers should emit at most one entry per supported language.
44
+ */
45
+ export interface EnyoApplianceErrorMessage {
46
+ /** Language code for this translation */
47
+ language: EnergyAppPackageLanguage;
48
+ /** Localized message describing the error to end users */
49
+ message: string;
50
+ }
51
+ /**
52
+ * Vendor- or protocol-specific error reported by an appliance, optionally
53
+ * accompanied by translated human-readable messages. The `code` is the
54
+ * machine-readable identifier (stable, non-localized); `messages` is an
55
+ * optional set of pre-translated descriptions intended for UI display.
56
+ * Consumers should fall back to rendering `code` when no `messages` entry
57
+ * matches their locale.
58
+ */
59
+ export interface EnyoApplianceErrorCode {
60
+ /** Machine-readable, vendor- or protocol-specific error code */
61
+ code: string;
62
+ /** Optional translated messages explaining the error */
63
+ messages?: EnyoApplianceErrorMessage[];
64
+ }
41
65
  export interface EnyoApplianceNetworkMetadata {
42
66
  /** If the appliance is connected via cellular network, you can put the imsi here*/
43
67
  imsi?: string;
@@ -1,4 +1,4 @@
1
- import { EnyoApplianceStateEnum, EnyoApplianceStatusEnum, EnyoApplianceTypeEnum } from "./enyo-appliance.js";
1
+ import { EnyoApplianceErrorCode, EnyoApplianceStateEnum, EnyoApplianceStatusEnum, EnyoApplianceTypeEnum } from "./enyo-appliance.js";
2
2
  import { EnyoSourceEnum } from "./enyo-source.enum.js";
3
3
  import { EnyoOcppRelativeSchedule } from "./enyo-ocpp.js";
4
4
  import { EnyoChargerApplianceStatusEnum } from "./enyo-charger-appliance.js";
@@ -344,10 +344,12 @@ export interface EnyoDataBusApplianceStateUpdateV1 extends EnyoDataBusMessage {
344
344
  status?: EnyoApplianceStatusEnum;
345
345
  /**
346
346
  * Optional vendor- or protocol-specific error codes that explain the
347
- * current status. Typically populated when transitioning into
348
- * `faulted`; omitted or empty when there is nothing to report.
347
+ * current status. Each entry carries the raw code and may include
348
+ * pre-translated messages for UI display. Typically populated when
349
+ * transitioning into `faulted`; omitted or empty when there is
350
+ * nothing to report.
349
351
  */
350
- errorCodes?: string[];
352
+ errorCodes?: EnyoApplianceErrorCode[];
351
353
  };
352
354
  }
353
355
  export interface EnyoDataBusChargingStartedV1 extends EnyoDataBusMessage {
package/dist/version.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
  /**
6
6
  * Current version of the enyo Energy App SDK.
7
7
  */
8
- export declare const SDK_VERSION = "0.0.112";
8
+ export declare const SDK_VERSION = "0.0.113";
9
9
  /**
10
10
  * Gets the current SDK version.
11
11
  * @returns The semantic version string of the SDK
package/dist/version.js CHANGED
@@ -5,7 +5,7 @@
5
5
  /**
6
6
  * Current version of the enyo Energy App SDK.
7
7
  */
8
- export const SDK_VERSION = '0.0.112';
8
+ export const SDK_VERSION = '0.0.113';
9
9
  /**
10
10
  * Gets the current SDK version.
11
11
  * @returns The semantic version string of the SDK
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@enyo-energy/energy-app-sdk",
3
- "version": "0.0.112",
3
+ "version": "0.0.113",
4
4
  "description": "enyo Energy App SDK",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",