@enyo-energy/energy-app-sdk 1.51.0 → 1.53.0

package/dist/cjs/types/enyo-authentication.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EnyoAuthenticationStateEnum = exports.EnyoOauthRedirectUrlPatternEnum = void 0;
+exports.EnyoAuthenticationStateEnum = exports.ENYO_AUTHENTICATION_MAX_TIMEOUT_MS = exports.ENYO_AUTHENTICATION_DEFAULT_TIMEOUT_MS = exports.EnyoOauthRedirectUrlPatternEnum = void 0;
 /**
  * How the host encodes the pending request into the enyo callback URL it hands
  * out as {@link EnyoOauthAuthenticationStart.enyoRedirectUrl}.
@@ -27,6 +27,10 @@ var EnyoOauthRedirectUrlPatternEnum;
      */
     EnyoOauthRedirectUrlPatternEnum["PathSegment"] = "path-segment";
 })(EnyoOauthRedirectUrlPatternEnum || (exports.EnyoOauthRedirectUrlPatternEnum = EnyoOauthRedirectUrlPatternEnum = {}));
+/** Default value of {@link EnyoAuthentication.timeoutMs} when it is omitted: 10 seconds. */
+exports.ENYO_AUTHENTICATION_DEFAULT_TIMEOUT_MS = 10 * 1000;
+/** Largest allowed value of {@link EnyoAuthentication.timeoutMs}: 2 minutes. */
+exports.ENYO_AUTHENTICATION_MAX_TIMEOUT_MS = 2 * 60 * 1000;
 var EnyoAuthenticationStateEnum;
 (function (EnyoAuthenticationStateEnum) {
     EnyoAuthenticationStateEnum["Authenticated"] = "Authenticated";

package/dist/cjs/types/enyo-authentication.d.cts

@@ -185,7 +185,23 @@ export interface EnyoAuthentication {
      * host keeps its default behaviour and may skip the step.
      */
     authenticationRequired?: boolean;
+    /**
+     * How long the host waits, in milliseconds, for the package to answer the
+     * submitted credentials, i.e. for the listener registered with
+     * `listenForAuthenticationResponse` to resolve its {@link EnyoAuthenticateState}.
+     *
+     * Raise it for vendors whose login round-trip is slow (cloud logins, devices
+     * that have to be woken up first). When omitted, the host uses
+     * {@link ENYO_AUTHENTICATION_DEFAULT_TIMEOUT_MS} (10 seconds). Values above
+     * {@link ENYO_AUTHENTICATION_MAX_TIMEOUT_MS} (2 minutes) are not allowed and
+     * are capped by the host.
+     */
+    timeoutMs?: number;
 }
+/** Default value of {@link EnyoAuthentication.timeoutMs} when it is omitted: 10 seconds. */
+export declare const ENYO_AUTHENTICATION_DEFAULT_TIMEOUT_MS: number;
+/** Largest allowed value of {@link EnyoAuthentication.timeoutMs}: 2 minutes. */
+export declare const ENYO_AUTHENTICATION_MAX_TIMEOUT_MS: number;
 export interface EnyoApiKeyAuthenticationResponse {
     apiKey: string;
     /** Values submitted for additional fields, keyed by fieldName */

package/dist/cjs/types/enyo-charge.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EnyoChargeStatus = exports.EnyoChargeVehicleAssignmentEnum = void 0;
+exports.EnyoChargeStatus = exports.EnyoChargePriceLimitSourceEnum = exports.EnyoChargeVehicleAssignmentEnum = void 0;
 /**
  * Where the vehicle on a charging session came from.
  *
@@ -22,6 +22,27 @@ var EnyoChargeVehicleAssignmentEnum;
      */
     EnyoChargeVehicleAssignmentEnum["Unknown"] = "unknown";
 })(EnyoChargeVehicleAssignmentEnum || (exports.EnyoChargeVehicleAssignmentEnum = EnyoChargeVehicleAssignmentEnum = {}));
+/**
+ * Where the price ceiling that governed a charging session was configured.
+ *
+ * A session's ceiling is resolved from the most specific place that has one,
+ * and the history needs to say which one won — "why did my car wait?" has a
+ * different fix depending on whether the limit sits on the car, the wallbox or
+ * the energy manager.
+ */
+var EnyoChargePriceLimitSourceEnum;
+(function (EnyoChargePriceLimitSourceEnum) {
+    /** The ceiling configured on the vehicle (`EnyoVehicle.priceLimitMode` and its values). */
+    EnyoChargePriceLimitSourceEnum["Vehicle"] = "vehicle";
+    /** The ceiling configured on the wallbox (charger appliance) handling the session. */
+    EnyoChargePriceLimitSourceEnum["Wallbox"] = "wallbox";
+    /**
+     * The ceiling set by the energy manager — its house-wide setting
+     * (`EnergyManagerSettingEnum.PriceLimitMode` and its values) or one the
+     * energy manager chose itself.
+     */
+    EnyoChargePriceLimitSourceEnum["EnergyManager"] = "energy-manager";
+})(EnyoChargePriceLimitSourceEnum || (exports.EnyoChargePriceLimitSourceEnum = EnyoChargePriceLimitSourceEnum = {}));
 /**
  * Status of a charging session
  */

package/dist/cjs/types/enyo-charge.d.cts

@@ -19,6 +19,26 @@ export declare enum EnyoChargeVehicleAssignmentEnum {
      */
     Unknown = "unknown"
 }
+/**
+ * Where the price ceiling that governed a charging session was configured.
+ *
+ * A session's ceiling is resolved from the most specific place that has one,
+ * and the history needs to say which one won — "why did my car wait?" has a
+ * different fix depending on whether the limit sits on the car, the wallbox or
+ * the energy manager.
+ */
+export declare enum EnyoChargePriceLimitSourceEnum {
+    /** The ceiling configured on the vehicle (`EnyoVehicle.priceLimitMode` and its values). */
+    Vehicle = "vehicle",
+    /** The ceiling configured on the wallbox (charger appliance) handling the session. */
+    Wallbox = "wallbox",
+    /**
+     * The ceiling set by the energy manager — its house-wide setting
+     * (`EnergyManagerSettingEnum.PriceLimitMode` and its values) or one the
+     * energy manager chose itself.
+     */
+    EnergyManager = "energy-manager"
+}
 /**
  * Status of a charging session
  */
@@ -176,11 +196,37 @@ export interface EnyoCharge {
      * session was allowed to import in, in percent. Only meaningful while
      * {@link priceLimitMode} is {@link EnyoPriceLimitModeEnum.CheapestShare}.
      *
-     * Note this records the *setting*, not the price threshold it resolved to:
-     * that threshold moved as prices published, so it is not a property of the
-     * session.
+     * Note this records the *setting*, not the price threshold it resolved to;
+     * that threshold is {@link effectivePriceLimitCtPerKwh}.
      */
     priceLimitSharePercent?: number;
+    /**
+     * Where the ceiling described by {@link priceLimitMode} came from — the
+     * vehicle, the wallbox or the energy manager. See
+     * {@link EnyoChargePriceLimitSourceEnum}.
+     *
+     * Omitted when there was no ceiling, and on sessions recorded before the
+     * source was tracked.
+     */
+    priceLimitSource?: EnyoChargePriceLimitSourceEnum;
+    /**
+     * The price ceiling actually applied, in **cents per kWh** (`25` is
+     * 25 ct/kWh) — the absolute threshold above which the session did not
+     * import, whichever way the ceiling was expressed.
+     *
+     * Under {@link EnyoPriceLimitModeEnum.CtPerKwh} it equals
+     * {@link priceLimitCtPerKwh}. Under
+     * {@link EnyoPriceLimitModeEnum.CheapestShare} it is the threshold the
+     * share resolved to against the known prices; that threshold moves as
+     * later prices publish, so on a running session this is the latest
+     * resolution and may change with each update.
+     *
+     * Cents, like the other ceiling fields — divide by 100 before comparing it
+     * with EUR/kWh price fields such as
+     * {@link EnyoDiagnosticsActionReason.electricityPricePerKwh}. Negative
+     * values are legal. Omitted when there was no ceiling.
+     */
+    effectivePriceLimitCtPerKwh?: number;
     /**
      * How this session found its vehicle — see
      * {@link EnyoChargeVehicleAssignmentEnum}. Absent on sessions recorded

package/dist/cjs/version.cjs

@@ -9,7 +9,7 @@ exports.getSdkVersion = getSdkVersion;
 /**
  * Current version of the enyo Energy App SDK.
  */
-exports.SDK_VERSION = '1.51.0';
+exports.SDK_VERSION = '1.53.0';
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/cjs/version.d.cts

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export declare const SDK_VERSION = "1.51.0";
+export declare const SDK_VERSION = "1.53.0";
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/types/enyo-authentication.d.ts

@@ -185,7 +185,23 @@ export interface EnyoAuthentication {
      * host keeps its default behaviour and may skip the step.
      */
     authenticationRequired?: boolean;
+    /**
+     * How long the host waits, in milliseconds, for the package to answer the
+     * submitted credentials, i.e. for the listener registered with
+     * `listenForAuthenticationResponse` to resolve its {@link EnyoAuthenticateState}.
+     *
+     * Raise it for vendors whose login round-trip is slow (cloud logins, devices
+     * that have to be woken up first). When omitted, the host uses
+     * {@link ENYO_AUTHENTICATION_DEFAULT_TIMEOUT_MS} (10 seconds). Values above
+     * {@link ENYO_AUTHENTICATION_MAX_TIMEOUT_MS} (2 minutes) are not allowed and
+     * are capped by the host.
+     */
+    timeoutMs?: number;
 }
+/** Default value of {@link EnyoAuthentication.timeoutMs} when it is omitted: 10 seconds. */
+export declare const ENYO_AUTHENTICATION_DEFAULT_TIMEOUT_MS: number;
+/** Largest allowed value of {@link EnyoAuthentication.timeoutMs}: 2 minutes. */
+export declare const ENYO_AUTHENTICATION_MAX_TIMEOUT_MS: number;
 export interface EnyoApiKeyAuthenticationResponse {
     apiKey: string;
     /** Values submitted for additional fields, keyed by fieldName */

package/dist/types/enyo-authentication.js

@@ -24,6 +24,10 @@ export var EnyoOauthRedirectUrlPatternEnum;
      */
     EnyoOauthRedirectUrlPatternEnum["PathSegment"] = "path-segment";
 })(EnyoOauthRedirectUrlPatternEnum || (EnyoOauthRedirectUrlPatternEnum = {}));
+/** Default value of {@link EnyoAuthentication.timeoutMs} when it is omitted: 10 seconds. */
+export const ENYO_AUTHENTICATION_DEFAULT_TIMEOUT_MS = 10 * 1000;
+/** Largest allowed value of {@link EnyoAuthentication.timeoutMs}: 2 minutes. */
+export const ENYO_AUTHENTICATION_MAX_TIMEOUT_MS = 2 * 60 * 1000;
 export var EnyoAuthenticationStateEnum;
 (function (EnyoAuthenticationStateEnum) {
     EnyoAuthenticationStateEnum["Authenticated"] = "Authenticated";

package/dist/types/enyo-charge.d.ts

@@ -19,6 +19,26 @@ export declare enum EnyoChargeVehicleAssignmentEnum {
      */
     Unknown = "unknown"
 }
+/**
+ * Where the price ceiling that governed a charging session was configured.
+ *
+ * A session's ceiling is resolved from the most specific place that has one,
+ * and the history needs to say which one won — "why did my car wait?" has a
+ * different fix depending on whether the limit sits on the car, the wallbox or
+ * the energy manager.
+ */
+export declare enum EnyoChargePriceLimitSourceEnum {
+    /** The ceiling configured on the vehicle (`EnyoVehicle.priceLimitMode` and its values). */
+    Vehicle = "vehicle",
+    /** The ceiling configured on the wallbox (charger appliance) handling the session. */
+    Wallbox = "wallbox",
+    /**
+     * The ceiling set by the energy manager — its house-wide setting
+     * (`EnergyManagerSettingEnum.PriceLimitMode` and its values) or one the
+     * energy manager chose itself.
+     */
+    EnergyManager = "energy-manager"
+}
 /**
  * Status of a charging session
  */
@@ -176,11 +196,37 @@ export interface EnyoCharge {
      * session was allowed to import in, in percent. Only meaningful while
      * {@link priceLimitMode} is {@link EnyoPriceLimitModeEnum.CheapestShare}.
      *
-     * Note this records the *setting*, not the price threshold it resolved to:
-     * that threshold moved as prices published, so it is not a property of the
-     * session.
+     * Note this records the *setting*, not the price threshold it resolved to;
+     * that threshold is {@link effectivePriceLimitCtPerKwh}.
      */
     priceLimitSharePercent?: number;
+    /**
+     * Where the ceiling described by {@link priceLimitMode} came from — the
+     * vehicle, the wallbox or the energy manager. See
+     * {@link EnyoChargePriceLimitSourceEnum}.
+     *
+     * Omitted when there was no ceiling, and on sessions recorded before the
+     * source was tracked.
+     */
+    priceLimitSource?: EnyoChargePriceLimitSourceEnum;
+    /**
+     * The price ceiling actually applied, in **cents per kWh** (`25` is
+     * 25 ct/kWh) — the absolute threshold above which the session did not
+     * import, whichever way the ceiling was expressed.
+     *
+     * Under {@link EnyoPriceLimitModeEnum.CtPerKwh} it equals
+     * {@link priceLimitCtPerKwh}. Under
+     * {@link EnyoPriceLimitModeEnum.CheapestShare} it is the threshold the
+     * share resolved to against the known prices; that threshold moves as
+     * later prices publish, so on a running session this is the latest
+     * resolution and may change with each update.
+     *
+     * Cents, like the other ceiling fields — divide by 100 before comparing it
+     * with EUR/kWh price fields such as
+     * {@link EnyoDiagnosticsActionReason.electricityPricePerKwh}. Negative
+     * values are legal. Omitted when there was no ceiling.
+     */
+    effectivePriceLimitCtPerKwh?: number;
     /**
      * How this session found its vehicle — see
      * {@link EnyoChargeVehicleAssignmentEnum}. Absent on sessions recorded

package/dist/types/enyo-charge.js

@@ -19,6 +19,27 @@ export var EnyoChargeVehicleAssignmentEnum;
      */
     EnyoChargeVehicleAssignmentEnum["Unknown"] = "unknown";
 })(EnyoChargeVehicleAssignmentEnum || (EnyoChargeVehicleAssignmentEnum = {}));
+/**
+ * Where the price ceiling that governed a charging session was configured.
+ *
+ * A session's ceiling is resolved from the most specific place that has one,
+ * and the history needs to say which one won — "why did my car wait?" has a
+ * different fix depending on whether the limit sits on the car, the wallbox or
+ * the energy manager.
+ */
+export var EnyoChargePriceLimitSourceEnum;
+(function (EnyoChargePriceLimitSourceEnum) {
+    /** The ceiling configured on the vehicle (`EnyoVehicle.priceLimitMode` and its values). */
+    EnyoChargePriceLimitSourceEnum["Vehicle"] = "vehicle";
+    /** The ceiling configured on the wallbox (charger appliance) handling the session. */
+    EnyoChargePriceLimitSourceEnum["Wallbox"] = "wallbox";
+    /**
+     * The ceiling set by the energy manager — its house-wide setting
+     * (`EnergyManagerSettingEnum.PriceLimitMode` and its values) or one the
+     * energy manager chose itself.
+     */
+    EnyoChargePriceLimitSourceEnum["EnergyManager"] = "energy-manager";
+})(EnyoChargePriceLimitSourceEnum || (EnyoChargePriceLimitSourceEnum = {}));
 /**
  * Status of a charging session
  */

package/dist/version.d.ts

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export declare const SDK_VERSION = "1.51.0";
+export declare const SDK_VERSION = "1.53.0";
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/version.js

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export const SDK_VERSION = '1.51.0';
+export const SDK_VERSION = '1.53.0';
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@enyo-energy/energy-app-sdk",
-  "version": "1.51.0",
+  "version": "1.53.0",
   "description": "enyo Energy App SDK",
   "type": "module",
   "main": "dist/index.js",