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

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

@@ -1,5 +1,10 @@
 import { EnyoPackageConfigurationTranslatedValue } from "./enyo-settings.js";
 export type EnyoAuthenticationType = 'apiKey' | 'oauth' | 'usernamePassword';
+/**
+ * Indicates whether the authentication request should be presented to the user
+ * before or after the onboarding guide. When omitted, the host decides the default ordering.
+ */
+export type EnyoAuthenticationOnboardingOrder = 'before-onboarding' | 'after-onboarding';
 /**
  * Represents an additional custom field for authentication forms.
  * Allows developers to add extra input fields beyond the standard username/password or API key.
@@ -66,6 +71,11 @@ export interface EnyoAuthentication {
     oneTimeAuthentication: boolean;
     /** Optional appliance ID. If provided, authentication is for specific appliance. If omitted, authentication is for the whole package */
     applianceId?: string;
+    /**
+     * Optional ordering hint indicating whether this authentication request should be
+     * presented before or after the onboarding guide. When omitted, the host decides the default.
+     */
+    onboardingOrder?: EnyoAuthenticationOnboardingOrder;
 }
 export interface EnyoApiKeyAuthenticationResponse {
     apiKey: string;

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

@@ -1,3 +1,4 @@
+import { EnyoChargeModeEnum } from "./enyo-data-bus-value.js";
 /**
  * Status of a charging session
  */
@@ -65,6 +66,10 @@ export interface EnyoCharge {
     numberOfPhases: number;
     /** Active charging schedule entries, if smart charging is in use */
     schedule?: EnyoChargeScheduleEntry[];
+    /** Charging mode applied to this session (e.g. immediate, cost-optimized, price-limit) */
+    chargeMode?: EnyoChargeModeEnum;
+    /** Target completion time for the charging session as an ISO 8601 timestamp */
+    completeAtIsoTimestamp?: string;
 }
 /**
  * Represents a single entry in a charging schedule.

package/dist/types/enyo-data-bus-value.d.ts

@@ -330,7 +330,8 @@ export interface EnyoDataBusApplianceFlexibilityAnnouncementV1 extends EnyoDataB
  * changes. At least one of `state` or `status` should be set; both may be
  * provided together if they change in the same event. `errorCodes` carries
  * vendor- or protocol-specific codes that explain a transition into a
- * `faulted` status.
+ * `warning` or `faulted` status; each entry's `severity` field indicates
+ * which.
  */
 export interface EnyoDataBusApplianceStateUpdateV1 extends EnyoDataBusMessage {
     type: 'message';
@@ -345,9 +346,10 @@ export interface EnyoDataBusApplianceStateUpdateV1 extends EnyoDataBusMessage {
         /**
          * Optional vendor- or protocol-specific error codes that explain the
          * current status. Each entry carries the raw code and may include
-         * pre-translated messages for UI display. Typically populated when
-         * transitioning into `faulted`; omitted or empty when there is
-         * nothing to report.
+         * pre-translated messages for UI display, plus an optional `severity`
+         * (`'error'` or `'warning'`). Typically populated when transitioning
+         * into `warning` or `faulted`; omitted or empty when there is nothing
+         * to report.
          */
         errorCodes?: EnyoApplianceErrorCode[];
     };

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

@@ -9,6 +9,19 @@ export interface EnyoOnboardingTranslatedContent {
     /** The translated text value */
     value: string;
 }
+/**
+ * Enum representing the lifecycle category of an onboarding guide.
+ * Used to distinguish guides that perform different roles, e.g. initial
+ * configuration of a package vs. adding or reconnecting a single device.
+ */
+export declare enum EnyoOnboardingGuideCategory {
+    /** Initial package configuration — shown when EnergyAppStateEnum is 'configuration-required' */
+    InitialSetup = "initial-setup",
+    /** Guide for adding a new device to an already-configured package */
+    AddNewDevice = "add-new-device",
+    /** Guide for reconnecting an existing device that has lost its connection */
+    ReconnectDevice = "reconnect-device"
+}
 /**
  * Enum representing the type of content an onboarding section displays.
  */
@@ -125,6 +138,12 @@ export interface EnyoOnboardingGuide {
     description?: EnyoOnboardingTranslatedContent[];
     /** Optional appliance ID if this guide is associated with an appliance */
     applianceId?: string;
+    /**
+     * Optional lifecycle category for this guide.
+     * Allows hosts to render category-specific entry points (e.g. "Add new device" buttons).
+     * Defaults to InitialSetup semantics when omitted, for backwards compatibility.
+     */
+    category?: EnyoOnboardingGuideCategory;
     /** Ordered array of steps in the onboarding flow */
     steps: EnyoOnboardingStep[];
 }

package/dist/types/enyo-onboarding.js

@@ -1,3 +1,17 @@
+/**
+ * Enum representing the lifecycle category of an onboarding guide.
+ * Used to distinguish guides that perform different roles, e.g. initial
+ * configuration of a package vs. adding or reconnecting a single device.
+ */
+export var EnyoOnboardingGuideCategory;
+(function (EnyoOnboardingGuideCategory) {
+    /** Initial package configuration — shown when EnergyAppStateEnum is 'configuration-required' */
+    EnyoOnboardingGuideCategory["InitialSetup"] = "initial-setup";
+    /** Guide for adding a new device to an already-configured package */
+    EnyoOnboardingGuideCategory["AddNewDevice"] = "add-new-device";
+    /** Guide for reconnecting an existing device that has lost its connection */
+    EnyoOnboardingGuideCategory["ReconnectDevice"] = "reconnect-device";
+})(EnyoOnboardingGuideCategory || (EnyoOnboardingGuideCategory = {}));
 /**
  * Enum representing the type of content an onboarding section displays.
  */

package/dist/types/enyo-retry-manager.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Lifecycle state of a single retryable instance tracked by {@link RetryManager}.
+ */
+export declare enum RetryState {
+    /** Registered but no attempt has run yet (or the instance was reset). */
+    Idle = "idle",
+    /** An attempt is currently executing. */
+    Running = "running",
+    /** The previous attempt failed and the manager is sleeping before the next one. */
+    Waiting = "waiting",
+    /** The most recent attempt succeeded. */
+    Succeeded = "succeeded",
+    /** All attempts have been used (or the error was non-retryable). */
+    Exhausted = "exhausted"
+}
+/**
+ * Backoff curve used to compute the delay between retry attempts.
+ *
+ * The same shape covers fixed, linear and exponential strategies so callers
+ * configure backoff with plain data instead of constructing strategy classes.
+ */
+export interface BackoffConfig {
+    /** Backoff curve. `exponential` is the typical default for network I/O. */
+    type: 'fixed' | 'linear' | 'exponential';
+    /** Base delay for the first retry, in milliseconds. Must be `>= 0`. */
+    initialMs: number;
+    /** Optional upper bound (ms) applied after the curve and before jitter. */
+    maxMs?: number;
+    /** Growth factor for `exponential`. Defaults to `2`. Must be `>= 1`. */
+    factor?: number;
+    /**
+     * Random jitter ratio in `[0, 1]`. `0.2` means the final delay is uniformly
+     * distributed in `[delay * 0.8, delay * 1.2]`. Defaults to `0`.
+     */
+    jitter?: number;
+}
+/**
+ * Per-instance retry policy. Registered with {@link RetryManager.register}.
+ */
+export interface RetryPolicy {
+    /** Total attempts allowed including the first call. Use `Infinity` for endless retry. */
+    maxAttempts: number;
+    /** Backoff curve applied between attempts. */
+    backoff: BackoffConfig;
+    /**
+     * Predicate consulted after each failure. Returning `false` short-circuits
+     * to {@link RetryState.Exhausted} without further retries (e.g. for auth or 4xx errors).
+     * Defaults to "always retryable".
+     */
+    isRetryable?: (error: unknown) => boolean;
+}
+/**
+ * Snapshot of a single instance's current retry state.
+ */
+export interface RetryStatus {
+    /** Identifier the instance was registered under. */
+    id: string;
+    /** Current lifecycle state. */
+    state: RetryState;
+    /** Number of attempts that have started so far in the current cycle. */
+    attempts: number;
+    /** Error from the most recent failed attempt, if any. */
+    lastError?: unknown;
+    /** Delay (ms) the manager is sleeping for, set only while `state === Waiting`. */
+    nextDelayMs?: number;
+}
+/**
+ * Listener invoked on every state transition for any registered instance.
+ *
+ * @param status Snapshot of the instance immediately after the transition.
+ */
+export type RetryStateListener = (status: RetryStatus) => void;

package/dist/types/enyo-retry-manager.js

@@ -0,0 +1,16 @@
+/**
+ * Lifecycle state of a single retryable instance tracked by {@link RetryManager}.
+ */
+export var RetryState;
+(function (RetryState) {
+    /** Registered but no attempt has run yet (or the instance was reset). */
+    RetryState["Idle"] = "idle";
+    /** An attempt is currently executing. */
+    RetryState["Running"] = "running";
+    /** The previous attempt failed and the manager is sleeping before the next one. */
+    RetryState["Waiting"] = "waiting";
+    /** The most recent attempt succeeded. */
+    RetryState["Succeeded"] = "succeeded";
+    /** All attempts have been used (or the error was non-retryable). */
+    RetryState["Exhausted"] = "exhausted";
+})(RetryState || (RetryState = {}));

package/dist/version.d.ts

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export declare const SDK_VERSION = "0.0.113";
+export declare const SDK_VERSION = "0.0.115";
 /**
  * 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 = '0.0.113';
+export const SDK_VERSION = '0.0.115';
 /**
  * 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": "0.0.113",
+  "version": "0.0.115",
   "description": "enyo Energy App SDK",
   "type": "module",
   "main": "dist/index.js",
@@ -8,7 +8,9 @@
   "scripts": {
     "extract-version": "node scripts/extract-version.js",
     "build": "npm run extract-version && duel",
-    "prepublishOnly": "npm run extract-version && npm run build"
+    "prepublishOnly": "npm run extract-version && npm run build",
+    "test": "vitest run",
+    "test:watch": "vitest"
   },
   "files": [
     "dist",
@@ -34,7 +36,8 @@
     "@knighted/duel": "^2.1.4",
     "@types/express": "^5.0.3",
     "@types/node": "^24.0.13",
-    "typescript": "^5.8.3"
+    "typescript": "^5.8.3",
+    "vitest": "^2.1.9"
   },
   "dependencies": {},
   "volta": {