@enyo-energy/energy-app-sdk 0.0.147 → 0.0.148

package/dist/cjs/implementations/appliance-command-forecast/appliance-command-forecast-validators.cjs

@@ -9,6 +9,7 @@ exports.validateBatterySchedule = validateBatterySchedule;
 exports.validateHeatpumpSchedule = validateHeatpumpSchedule;
 exports.validateHeatpumpScheduleEntry = validateHeatpumpScheduleEntry;
 const enyo_appliance_command_forecast_js_1 = require("../../types/enyo-appliance-command-forecast.cjs");
+const enyo_data_bus_value_js_1 = require("../../types/enyo-data-bus-value.cjs");
 /**
  * Thrown when a forecast payload passed to one of the validators (or to
  * {@link EnergyAppApplianceEnergyManagerForecast.publishChargerForecast}
@@ -39,6 +40,13 @@ function validateChargerForecast(forecast) {
         throw new ApplianceCommandForecastValidationError('ChargerForecast must be an object.');
     }
     validateMetadata(forecast);
+    if (forecast.chargeMode !== undefined) {
+        const allowedModes = new Set(Object.values(enyo_data_bus_value_js_1.EnyoChargeModeEnum));
+        if (!allowedModes.has(forecast.chargeMode)) {
+            throw new ApplianceCommandForecastValidationError(`ChargerForecast.chargeMode is invalid: ${forecast.chargeMode}. Allowed values: ${Object.values(enyo_data_bus_value_js_1.EnyoChargeModeEnum).join(', ')}.`);
+        }
+    }
+    validateBooleanField(forecast.chargeActive, 'ChargerForecast.chargeActive');
     validateChargerSchedule(forecast.relativeSchedule, forecast.resolution);
 }
 /**

package/dist/cjs/types/enyo-appliance-command-forecast.cjs

@@ -6,7 +6,10 @@
  * apply to its appliances over the upcoming horizon.
  *
  * Three appliance families are supported today:
- *  - **Chargers** — {@link ChargerForecast}: relative phase / power schedule.
+ *  - **Chargers** — {@link ChargerForecast}: relative phase / power schedule
+ *    plus optional {@link ChargerForecast.chargeMode} and
+ *    {@link ChargerForecast.chargeActive} flags describing the strategy the
+ *    plan was built for and whether a charging session is running.
  *  - **Batteries** — {@link BatteryCommandForecast}: either a relative
  *    direction / power schedule, or an explicit "auto" release that hands
  *    control back to the appliance's own logic. Mirrors the

package/dist/cjs/types/enyo-appliance-command-forecast.d.cts

@@ -5,7 +5,10 @@
  * apply to its appliances over the upcoming horizon.
  *
  * Three appliance families are supported today:
- *  - **Chargers** — {@link ChargerForecast}: relative phase / power schedule.
+ *  - **Chargers** — {@link ChargerForecast}: relative phase / power schedule
+ *    plus optional {@link ChargerForecast.chargeMode} and
+ *    {@link ChargerForecast.chargeActive} flags describing the strategy the
+ *    plan was built for and whether a charging session is running.
  *  - **Batteries** — {@link BatteryCommandForecast}: either a relative
  *    direction / power schedule, or an explicit "auto" release that hands
  *    control back to the appliance's own logic. Mirrors the
@@ -25,6 +28,7 @@
  * The transport / fan-out is an internal detail of the runtime SDK and
  * not exposed to apps.
  */
+import { EnyoChargeModeEnum } from './enyo-data-bus-value.cjs';
 /**
  * Optional metadata describing the estimated savings of a forecasted
  * command plan compared to an unmanaged baseline.
@@ -116,6 +120,30 @@ export interface ChargerForecast extends ApplianceForecastMetadata {
      * starting at `seconds = 0`. Must contain at least one entry.
      */
     relativeSchedule: ChargerForecastScheduleEntry[];
+    /**
+     * Charging strategy the plan was built for — `immediate`,
+     * `cost-optimized` or `price-limit`. Uses the same enum as
+     * {@link EnyoCharge.chargeMode} and the command-side
+     * {@link EnyoDataBusStartChargeV1} so the forecasted plan can be
+     * compared 1:1 with the command that will eventually be issued.
+     *
+     * Omit when the publisher does not declare a mode (e.g. an unmanaged
+     * baseline forecast); consumers should not infer a default.
+     */
+    chargeMode?: EnyoChargeModeEnum;
+    /**
+     * Whether a charging session is currently active on the appliance at
+     * the moment this forecast is published.
+     *
+     * - `true` — a session is running; subsequent `powerW = 0` entries
+     *   should be read as "pause while staying connected", not "stop".
+     * - `false` — no session is running; the schedule describes the plan
+     *   the publisher intends to apply once a session starts (or what
+     *   would have been applied had one been running).
+     * - omitted — the publisher cannot determine the session state;
+     *   consumers must not infer one.
+     */
+    chargeActive?: boolean;
 }
 /**
  * Top-level control mode carried by {@link BatteryCommandForecast}.

package/dist/cjs/version.cjs

@@ -9,7 +9,7 @@ exports.getSdkVersion = getSdkVersion;
 /**
  * Current version of the enyo Energy App SDK.
  */
-exports.SDK_VERSION = '0.0.147';
+exports.SDK_VERSION = '0.0.148';
 /**
  * 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 = "0.0.147";
+export declare const SDK_VERSION = "0.0.148";
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/implementations/appliance-command-forecast/appliance-command-forecast-validators.js

@@ -1,4 +1,5 @@
 import { ApplianceForecastResolutionEnum, BatteryCommandForecastDirectionEnum, BatteryCommandForecastModeEnum, } from '../../types/enyo-appliance-command-forecast.js';
+import { EnyoChargeModeEnum } from '../../types/enyo-data-bus-value.js';
 /**
  * Thrown when a forecast payload passed to one of the validators (or to
  * {@link EnergyAppApplianceEnergyManagerForecast.publishChargerForecast}
@@ -28,6 +29,13 @@ export function validateChargerForecast(forecast) {
         throw new ApplianceCommandForecastValidationError('ChargerForecast must be an object.');
     }
     validateMetadata(forecast);
+    if (forecast.chargeMode !== undefined) {
+        const allowedModes = new Set(Object.values(EnyoChargeModeEnum));
+        if (!allowedModes.has(forecast.chargeMode)) {
+            throw new ApplianceCommandForecastValidationError(`ChargerForecast.chargeMode is invalid: ${forecast.chargeMode}. Allowed values: ${Object.values(EnyoChargeModeEnum).join(', ')}.`);
+        }
+    }
+    validateBooleanField(forecast.chargeActive, 'ChargerForecast.chargeActive');
     validateChargerSchedule(forecast.relativeSchedule, forecast.resolution);
 }
 /**

package/dist/types/enyo-appliance-command-forecast.d.ts

@@ -5,7 +5,10 @@
  * apply to its appliances over the upcoming horizon.
  *
  * Three appliance families are supported today:
- *  - **Chargers** — {@link ChargerForecast}: relative phase / power schedule.
+ *  - **Chargers** — {@link ChargerForecast}: relative phase / power schedule
+ *    plus optional {@link ChargerForecast.chargeMode} and
+ *    {@link ChargerForecast.chargeActive} flags describing the strategy the
+ *    plan was built for and whether a charging session is running.
  *  - **Batteries** — {@link BatteryCommandForecast}: either a relative
  *    direction / power schedule, or an explicit "auto" release that hands
  *    control back to the appliance's own logic. Mirrors the
@@ -25,6 +28,7 @@
  * The transport / fan-out is an internal detail of the runtime SDK and
  * not exposed to apps.
  */
+import { EnyoChargeModeEnum } from './enyo-data-bus-value.js';
 /**
  * Optional metadata describing the estimated savings of a forecasted
  * command plan compared to an unmanaged baseline.
@@ -116,6 +120,30 @@ export interface ChargerForecast extends ApplianceForecastMetadata {
      * starting at `seconds = 0`. Must contain at least one entry.
      */
     relativeSchedule: ChargerForecastScheduleEntry[];
+    /**
+     * Charging strategy the plan was built for — `immediate`,
+     * `cost-optimized` or `price-limit`. Uses the same enum as
+     * {@link EnyoCharge.chargeMode} and the command-side
+     * {@link EnyoDataBusStartChargeV1} so the forecasted plan can be
+     * compared 1:1 with the command that will eventually be issued.
+     *
+     * Omit when the publisher does not declare a mode (e.g. an unmanaged
+     * baseline forecast); consumers should not infer a default.
+     */
+    chargeMode?: EnyoChargeModeEnum;
+    /**
+     * Whether a charging session is currently active on the appliance at
+     * the moment this forecast is published.
+     *
+     * - `true` — a session is running; subsequent `powerW = 0` entries
+     *   should be read as "pause while staying connected", not "stop".
+     * - `false` — no session is running; the schedule describes the plan
+     *   the publisher intends to apply once a session starts (or what
+     *   would have been applied had one been running).
+     * - omitted — the publisher cannot determine the session state;
+     *   consumers must not infer one.
+     */
+    chargeActive?: boolean;
 }
 /**
  * Top-level control mode carried by {@link BatteryCommandForecast}.

package/dist/types/enyo-appliance-command-forecast.js

@@ -5,7 +5,10 @@
  * apply to its appliances over the upcoming horizon.
  *
  * Three appliance families are supported today:
- *  - **Chargers** — {@link ChargerForecast}: relative phase / power schedule.
+ *  - **Chargers** — {@link ChargerForecast}: relative phase / power schedule
+ *    plus optional {@link ChargerForecast.chargeMode} and
+ *    {@link ChargerForecast.chargeActive} flags describing the strategy the
+ *    plan was built for and whether a charging session is running.
  *  - **Batteries** — {@link BatteryCommandForecast}: either a relative
  *    direction / power schedule, or an explicit "auto" release that hands
  *    control back to the appliance's own logic. Mirrors the

package/dist/version.d.ts

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export declare const SDK_VERSION = "0.0.147";
+export declare const SDK_VERSION = "0.0.148";
 /**
  * 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.147';
+export const SDK_VERSION = '0.0.148';
 /**
  * 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.147",
+  "version": "0.0.148",
   "description": "enyo Energy App SDK",
   "type": "module",
   "main": "dist/index.js",