@enyo-energy/energy-app-sdk 0.0.57 → 0.0.58

package/README.md

@@ -123,6 +123,8 @@ import {
 const packageDef = defineEnergyAppPackage({
     version: '1',
     packageName: 'solar-optimizer',
+    // Optional: Internal documentation for developers (not shown to users)
+    internalDescription: 'This app optimizes solar energy production using weather forecasts and AI predictions.',
     logo: './assets/logo.png',
     categories: [
         EnergyAppPackageCategory.Inverter,
@@ -142,12 +144,15 @@ const packageDef = defineEnergyAppPackage({
             description: 'Erweiterte Solarenergie-Optimierung mit KI-gesteuerten Vorhersagen und Echtzeitanpassungen.'
         }
     ],
+    // Permissions can be objects with internal comments (recommended for documentation)
     permissions: [
-        EnergyAppPermissionTypeEnum.Modbus,
-        EnergyAppPermissionTypeEnum.SendDataBusValues,
-        EnergyAppPermissionTypeEnum.SubscribeDataBus,
-        EnergyAppPermissionTypeEnum.Storage
+        { permission: EnergyAppPermissionTypeEnum.Modbus, internalComment: 'Required to read inverter registers via Modbus TCP' },
+        { permission: EnergyAppPermissionTypeEnum.SendDataBusValues, internalComment: 'Used to publish inverter power values to the data bus' },
+        { permission: EnergyAppPermissionTypeEnum.SubscribeDataBus, internalComment: 'Listens for battery state updates' },
+        { permission: EnergyAppPermissionTypeEnum.Storage, internalComment: 'Stores configuration and historical optimization data' }
     ],
+    // Note: Simple permission types are also supported for backwards compatibility:
+    // permissions: [EnergyAppPermissionTypeEnum.Modbus, EnergyAppPermissionTypeEnum.Storage]
     options: {
         restrictedInternetAccess: {
             origins: ['api.weather.com', 'solar-forecasting.com']

package/dist/cjs/energy-app-package-definition.d.cts

@@ -89,6 +89,16 @@ export interface EnergyAppPackageStoreEntry {
     /** Detailed description of the package functionality */
     description: string;
 }
+/**
+ * Defines a permission entry for an Energy App package.
+ * Contains the permission type and an internal comment explaining its usage.
+ */
+export interface EnergyAppPackagePermission {
+    /** The permission type required by the package */
+    permission: EnergyAppPermissionType;
+    /** Internal documentation describing what this permission is used for */
+    internalComment: string;
+}
 /**
  * Complete definition for a enyo Energy App package.
  * This interface defines all the metadata, permissions, and configuration
@@ -99,14 +109,16 @@ export interface EnergyAppPackageDefinition {
     version: '1';
     /** Unique identifier for the package */
     packageName: string;
+    /** Internal documentation describing the concept and purpose of this energy app (optional) */
+    internalDescription?: string;
     /** Optional path to the logo */
     logo?: string;
     /** Categories that this package belongs to */
     categories: EnergyAppPackageCategory[];
     /** Localized store information for different languages */
     storeEntry: EnergyAppPackageStoreEntry[];
-    /** Required permissions for this package to function */
-    permissions: EnergyAppPermissionType[];
+    /** Required permissions for this package to function. Can be simple permission types or objects with internal comments */
+    permissions: (EnergyAppPermissionType | EnergyAppPackagePermission)[];
     /** Optional configuration settings */
     options?: EnergyAppPackageOptions;
     /** The version of the enyo SDK used to build this package (automatically injected) */

package/dist/cjs/energy-app-permission.type.cjs

@@ -21,4 +21,6 @@ var EnergyAppPermissionTypeEnum;
     EnergyAppPermissionTypeEnum["SecretManager"] = "SecretManager";
     EnergyAppPermissionTypeEnum["LocationZipCode"] = "LocationZipCode";
     EnergyAppPermissionTypeEnum["LocationCoordinates"] = "LocationCoordinates";
+    EnergyAppPermissionTypeEnum["Timeseries"] = "Timeseries";
+    EnergyAppPermissionTypeEnum["EnergyManagerInfo"] = "EnergyManagerInfo";
 })(EnergyAppPermissionTypeEnum || (exports.EnergyAppPermissionTypeEnum = EnergyAppPermissionTypeEnum = {}));

package/dist/cjs/energy-app-permission.type.d.cts

@@ -1,4 +1,4 @@
-export type EnergyAppPermissionType = 'RestrictedInternetAccess' | 'NetworkDeviceDiscovery' | 'NetworkDeviceSearch' | 'NetworkDeviceAccess' | 'Modbus' | 'Storage' | 'Appliance' | 'AllAppliances' | 'SendDataBusValues' | 'SubscribeDataBus' | 'SendDataBusCommands' | 'OcppServer' | 'ChargingCard' | 'Vehicle' | 'Charge' | 'SecretManager' | 'LocationZipCode' | 'LocationCoordinates';
+export type EnergyAppPermissionType = 'RestrictedInternetAccess' | 'NetworkDeviceDiscovery' | 'NetworkDeviceSearch' | 'NetworkDeviceAccess' | 'Modbus' | 'Storage' | 'Appliance' | 'AllAppliances' | 'SendDataBusValues' | 'SubscribeDataBus' | 'SendDataBusCommands' | 'OcppServer' | 'ChargingCard' | 'Vehicle' | 'Charge' | 'SecretManager' | 'LocationZipCode' | 'LocationCoordinates' | 'Timeseries' | 'EnergyManagerInfo';
 export declare enum EnergyAppPermissionTypeEnum {
     RestrictedInternetAccess = "RestrictedInternetAccess",
     NetworkDeviceDiscovery = "NetworkDeviceDiscovery",
@@ -17,5 +17,7 @@ export declare enum EnergyAppPermissionTypeEnum {
     Charge = "Charge",
     SecretManager = "SecretManager",
     LocationZipCode = "LocationZipCode",
-    LocationCoordinates = "LocationCoordinates"
+    LocationCoordinates = "LocationCoordinates",
+    Timeseries = "Timeseries",
+    EnergyManagerInfo = "EnergyManagerInfo"
 }

package/dist/cjs/enyo-energy-app-sdk.d.cts

@@ -15,7 +15,9 @@ import { EnergyAppNotification } from "./packages/energy-app-notification.cjs";
 import { EnergyAppSecretManager } from "./packages/energy-app-secret-manager.cjs";
 import { EnergyAppLocation } from "./packages/energy-app-location.cjs";
 import { EnergyAppOnboarding } from "./packages/energy-app-onboarding.cjs";
+import { EnergyAppTimeseries } from "./packages/energy-app-timeseries.cjs";
 import { EnyoPackageChannel } from "./enyo-package-channel.cjs";
+import { EnergyAppEnergyManager } from "./packages/energy-app-energy-manager.cjs";
 export declare enum EnergyAppStateEnum {
     Launching = "launching",
     Running = "running",
@@ -74,4 +76,8 @@ export interface EnyoEnergyAppSdk {
     useLocation: () => EnergyAppLocation;
     /** Get the Onboarding API */
     useOnboarding: () => EnergyAppOnboarding;
+    /** Get the Timeseries API for querying historical energy data */
+    useTimeseries: () => EnergyAppTimeseries;
+    /** Get the Energy Manager API for retrieving energy manager info and capabilities */
+    useEnergyManager: () => EnergyAppEnergyManager;
 }

package/dist/cjs/index.cjs

@@ -31,6 +31,9 @@ __exportStar(require("./types/enyo-location.cjs"), exports);
 __exportStar(require("./implementations/appliances/appliance-manager.cjs"), exports);
 __exportStar(require("./implementations/appliances/identifier-strategies.cjs"), exports);
 __exportStar(require("./enyo-package-channel.cjs"), exports);
+__exportStar(require("./types/enyo-timeseries.cjs"), exports);
+__exportStar(require("./types/enyo-energy-manager.cjs"), exports);
+__exportStar(require("./packages/energy-app-energy-manager.cjs"), exports);
 class EnergyApp {
     energyAppSdk;
     constructor() {
@@ -127,6 +130,23 @@ class EnergyApp {
     useLocation() {
         return this.energyAppSdk.useLocation();
     }
+    /**
+     * Gets the Timeseries API for querying historical energy data.
+     * Provides methods to retrieve aggregated timeseries data with 15-minute bucket granularity
+     * for various energy metrics including PV production, battery state, meter values, and grid power.
+     * @returns The Timeseries API instance
+     */
+    useTimeseries() {
+        return this.energyAppSdk.useTimeseries();
+    }
+    /**
+     * Gets the Energy Manager API for retrieving information about the active energy manager.
+     * Provides methods to check the current energy manager and its supported features.
+     * @returns The Energy Manager API instance
+     */
+    useEnergyManager() {
+        return this.energyAppSdk.useEnergyManager();
+    }
     /**
      * Gets the current SDK version.
      * @returns The semantic version string of the SDK

package/dist/cjs/index.d.cts

@@ -16,7 +16,9 @@ import { EnergyAppNotification } from "./packages/energy-app-notification.cjs";
 import { EnergyAppSecretManager } from "./packages/energy-app-secret-manager.cjs";
 import { EnergyAppLocation } from "./packages/energy-app-location.cjs";
 import { EnergyAppOnboarding } from "./packages/energy-app-onboarding.cjs";
+import { EnergyAppTimeseries } from "./packages/energy-app-timeseries.cjs";
 import { EnyoPackageChannel } from "./enyo-package-channel.cjs";
+import { EnergyAppEnergyManager } from "./packages/energy-app-energy-manager.cjs";
 export * from './energy-app-package-definition.cjs';
 export * from './version.cjs';
 export * from './implementations/ocpp/ocpp16.cjs';
@@ -32,6 +34,9 @@ export * from './types/enyo-location.cjs';
 export * from './implementations/appliances/appliance-manager.cjs';
 export * from './implementations/appliances/identifier-strategies.cjs';
 export * from './enyo-package-channel.cjs';
+export * from './types/enyo-timeseries.cjs';
+export * from './types/enyo-energy-manager.cjs';
+export * from './packages/energy-app-energy-manager.cjs';
 export declare class EnergyApp implements EnyoEnergyAppSdk {
     private readonly energyAppSdk;
     constructor();
@@ -67,6 +72,19 @@ export declare class EnergyApp implements EnyoEnergyAppSdk {
      * @returns The Location API instance
      */
     useLocation(): EnergyAppLocation;
+    /**
+     * Gets the Timeseries API for querying historical energy data.
+     * Provides methods to retrieve aggregated timeseries data with 15-minute bucket granularity
+     * for various energy metrics including PV production, battery state, meter values, and grid power.
+     * @returns The Timeseries API instance
+     */
+    useTimeseries(): EnergyAppTimeseries;
+    /**
+     * Gets the Energy Manager API for retrieving information about the active energy manager.
+     * Provides methods to check the current energy manager and its supported features.
+     * @returns The Energy Manager API instance
+     */
+    useEnergyManager(): EnergyAppEnergyManager;
     /**
      * Gets the current SDK version.
      * @returns The semantic version string of the SDK

package/dist/cjs/packages/energy-app-energy-manager.cjs

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/packages/energy-app-energy-manager.d.cts

@@ -0,0 +1,24 @@
+import { EnergyManagerInfo } from "../types/enyo-energy-manager.cjs";
+/**
+ * Interface for retrieving energy manager information and capabilities.
+ * The energy manager is responsible for optimizing energy usage across appliances.
+ */
+export interface EnergyAppEnergyManager {
+    /**
+     * Gets information about the currently active energy manager.
+     * Returns null if no energy manager is configured.
+     *
+     * @returns Promise resolving to energy manager info or null if no energy manager is configured
+     *
+     * @example
+     * ```typescript
+     * const energyManager = energyApp.useEnergyManager();
+     * const info = await energyManager.getEnergyManagerInfo();
+     * if (info) {
+     *     console.log(`Energy Manager: ${info.name}`);
+     *     console.log(`Features: ${info.features.join(', ')}`);
+     * }
+     * ```
+     */
+    getEnergyManagerInfo(): Promise<EnergyManagerInfo | null>;
+}

package/dist/cjs/packages/energy-app-timeseries.cjs

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/packages/energy-app-timeseries.d.cts

@@ -0,0 +1,124 @@
+import { DataBusMessageQueryRequest, DataBusMessageQueryResponse, PvProductionTimeseriesRequest, PvProductionTimeseriesResponse, BatterySocTimeseriesRequest, BatterySocTimeseriesResponse, BatteryPowerTimeseriesRequest, BatteryPowerTimeseriesResponse, MeterValuesTimeseriesRequest, MeterValuesTimeseriesResponse, GridPowerTimeseriesRequest, GridPowerTimeseriesResponse } from "../types/enyo-timeseries.cjs";
+/**
+ * Interface for querying historical energy data with 15-minute bucket granularity.
+ * Provides methods to retrieve aggregated timeseries data for various energy metrics
+ * including PV production, battery state, meter values, and grid power.
+ *
+ * All aggregated methods return data in 15-minute buckets aligned to clock time
+ * (:00, :15, :30, :45). Power values (W) represent time-weighted averages within
+ * each bucket, while energy values (Wh) represent cumulative sums.
+ *
+ * Date ranges use inclusive start and exclusive end timestamps.
+ */
+export interface EnergyAppTimeseries {
+    /**
+     * Queries raw data bus messages for a specific appliance.
+     * Supports pagination and filtering by message type.
+     *
+     * @param request - The query parameters including appliance ID, date range, and optional filters
+     * @returns Promise resolving to the matching messages with pagination metadata
+     *
+     * @example
+     * ```typescript
+     * const response = await timeseries.queryDataBusMessages({
+     *     applianceId: 'inverter-001',
+     *     startDateIso: '2024-01-01T00:00:00Z',
+     *     endDateIso: '2024-01-02T00:00:00Z',
+     *     messageTypes: [EnyoDataBusMessageEnum.InverterValuesUpdateV1],
+     *     limit: 100
+     * });
+     * ```
+     */
+    queryDataBusMessages(request: DataBusMessageQueryRequest): Promise<DataBusMessageQueryResponse>;
+    /**
+     * Retrieves PV production timeseries data aggregated in 15-minute buckets.
+     * Returns both instantaneous power (W) and cumulative energy (Wh) values.
+     *
+     * @param request - The query parameters including date range and optional appliance filter
+     * @returns Promise resolving to PV production entries and total production
+     *
+     * @example
+     * ```typescript
+     * const response = await timeseries.getPvProductionTimeseries({
+     *     startDateIso: '2024-01-01T00:00:00Z',
+     *     endDateIso: '2024-01-02T00:00:00Z'
+     * });
+     * console.log(`Total production: ${response.totalPvProductionWh} Wh`);
+     * ```
+     */
+    getPvProductionTimeseries(request: PvProductionTimeseriesRequest): Promise<PvProductionTimeseriesResponse>;
+    /**
+     * Retrieves battery state of charge (SOC) timeseries data aggregated in 15-minute buckets.
+     * Returns average, minimum, and maximum SOC values for each bucket.
+     *
+     * @param request - The query parameters including date range and optional appliance filter
+     * @returns Promise resolving to battery SOC entries and overall average SOC
+     *
+     * @example
+     * ```typescript
+     * const response = await timeseries.getBatterySocTimeseries({
+     *     startDateIso: '2024-01-01T00:00:00Z',
+     *     endDateIso: '2024-01-02T00:00:00Z',
+     *     applianceIds: ['battery-001']
+     * });
+     * console.log(`Average SOC: ${response.averageSoC}%`);
+     * ```
+     */
+    getBatterySocTimeseries(request: BatterySocTimeseriesRequest): Promise<BatterySocTimeseriesResponse>;
+    /**
+     * Retrieves battery power timeseries data aggregated in 15-minute buckets.
+     * Positive values indicate discharge (consumption from battery),
+     * negative values indicate charge (energy into battery).
+     *
+     * @param request - The query parameters including date range and optional appliance filter
+     * @returns Promise resolving to battery power entries with total charge and discharge amounts
+     *
+     * @example
+     * ```typescript
+     * const response = await timeseries.getBatteryPowerTimeseries({
+     *     startDateIso: '2024-01-01T00:00:00Z',
+     *     endDateIso: '2024-01-02T00:00:00Z'
+     * });
+     * console.log(`Total discharged: ${response.totalDischargeWh} Wh`);
+     * console.log(`Total charged: ${response.totalChargeWh} Wh`);
+     * ```
+     */
+    getBatteryPowerTimeseries(request: BatteryPowerTimeseriesRequest): Promise<BatteryPowerTimeseriesResponse>;
+    /**
+     * Retrieves meter values timeseries data aggregated in 15-minute buckets.
+     * Returns grid consumption and feed-in energy values.
+     *
+     * @param request - The query parameters including date range and optional appliance filter
+     * @returns Promise resolving to meter value entries with total consumption and feed-in
+     *
+     * @example
+     * ```typescript
+     * const response = await timeseries.getMeterValuesTimeseries({
+     *     startDateIso: '2024-01-01T00:00:00Z',
+     *     endDateIso: '2024-01-02T00:00:00Z'
+     * });
+     * console.log(`Grid consumption: ${response.totalGridConsumptionWh} Wh`);
+     * console.log(`Grid feed-in: ${response.totalGridFeedInWh} Wh`);
+     * ```
+     */
+    getMeterValuesTimeseries(request: MeterValuesTimeseriesRequest): Promise<MeterValuesTimeseriesResponse>;
+    /**
+     * Retrieves grid power timeseries data aggregated in 15-minute buckets.
+     * Positive values indicate import (consumption from grid),
+     * negative values indicate export (feed-in to grid).
+     *
+     * @param request - The query parameters including date range and optional appliance filter
+     * @returns Promise resolving to grid power entries with total import and export amounts
+     *
+     * @example
+     * ```typescript
+     * const response = await timeseries.getGridPowerTimeseries({
+     *     startDateIso: '2024-01-01T00:00:00Z',
+     *     endDateIso: '2024-01-02T00:00:00Z'
+     * });
+     * console.log(`Total imported: ${response.totalImportWh} Wh`);
+     * console.log(`Total exported: ${response.totalExportWh} Wh`);
+     * ```
+     */
+    getGridPowerTimeseries(request: GridPowerTimeseriesRequest): Promise<GridPowerTimeseriesResponse>;
+}

package/dist/cjs/types/enyo-charger-appliance.cjs

@@ -5,6 +5,7 @@ var EnyoChargerApplianceStatusEnum;
 (function (EnyoChargerApplianceStatusEnum) {
     EnyoChargerApplianceStatusEnum["Available"] = "Available";
     EnyoChargerApplianceStatusEnum["Occupied"] = "Occupied";
+    EnyoChargerApplianceStatusEnum["Charging"] = "Charging";
     EnyoChargerApplianceStatusEnum["Suspended"] = "Suspended";
     EnyoChargerApplianceStatusEnum["Finishing"] = "Finishing";
     EnyoChargerApplianceStatusEnum["Reserved"] = "Reserved";

package/dist/cjs/types/enyo-charger-appliance.d.cts

@@ -1,6 +1,7 @@
 export declare enum EnyoChargerApplianceStatusEnum {
     Available = "Available",
     Occupied = "Occupied",
+    Charging = "Charging",
     Suspended = "Suspended",
     Finishing = "Finishing",
     Reserved = "Reserved",

package/dist/cjs/types/enyo-data-bus-value.cjs

@@ -103,4 +103,6 @@ var EnyoDataBusMessageEnum;
     EnyoDataBusMessageEnum["EnergyTariffUpdateV1"] = "EnergyTariffUpdateV1";
     EnyoDataBusMessageEnum["ChargeFinishedV1"] = "ChargeFinishedV1";
     EnyoDataBusMessageEnum["ChargerStatusChangedV1"] = "ChargerStatusChangedV1";
+    EnyoDataBusMessageEnum["RequestPreviewChargingScheduleV1"] = "RequestPreviewChargingScheduleV1";
+    EnyoDataBusMessageEnum["PreviewChargingScheduleResponseV1"] = "PreviewChargingScheduleResponseV1";
 })(EnyoDataBusMessageEnum || (exports.EnyoDataBusMessageEnum = EnyoDataBusMessageEnum = {}));

package/dist/cjs/types/enyo-data-bus-value.d.cts

@@ -2,7 +2,8 @@ import { EnyoApplianceStateEnum, EnyoApplianceTypeEnum } from "./enyo-appliance.
 import { EnyoSourceEnum } from "./enyo-source.enum.cjs";
 import { EnergyTariffInfo } from "./enyo-energy-tariff.cjs";
 import { EnyoOcppRelativeSchedule } from "./enyo-ocpp.cjs";
-import { GenericChargePointStatus } from "../implementations/ocpp/ocpp-common.cjs";
+import { EnyoChargerApplianceStatusEnum } from "./enyo-charger-appliance.cjs";
+import { PreviewChargingSchedule, PreviewChargingScheduleCostComparison, PreviewChargingScheduleUnavailableReasonEnum } from "./enyo-energy-manager.cjs";
 export declare enum EnyoBatteryStateEnum {
     Off = "off",
     Empty = "empty",
@@ -135,7 +136,9 @@ export declare enum EnyoDataBusMessageEnum {
     AggregatedStateUpdateV1 = "AggregatedStateUpdateV1",
     EnergyTariffUpdateV1 = "EnergyTariffUpdateV1",
     ChargeFinishedV1 = "ChargeFinishedV1",
-    ChargerStatusChangedV1 = "ChargerStatusChangedV1"
+    ChargerStatusChangedV1 = "ChargerStatusChangedV1",
+    RequestPreviewChargingScheduleV1 = "RequestPreviewChargingScheduleV1",
+    PreviewChargingScheduleResponseV1 = "PreviewChargingScheduleResponseV1"
 }
 export type EnyoDataBusMessageResolution = '10s' | '30s' | '1m' | '15m' | '1h' | '1d' | 'dynamic';
 export interface EnyoDataBusMessage {
@@ -287,6 +290,10 @@ export interface EnyoDataBusChargingStartedV1 extends EnyoDataBusMessage {
         transactionId: string;
         /** used charging card */
         chargingCardId?: string;
+        /** The charge mode of the started charge. If initiated by wallbox, use either user settings or immediate as default */
+        chargeMode: EnyoChargeModeEnum;
+        /** ISO timestamp for target completion time (optional) */
+        completeChargeAtIso?: string;
         /** vehicle that's charging */
         vehicleId?: string;
         /** Meter reading at session start in Watt hours */
@@ -497,6 +504,7 @@ export interface EnyoDataBusChargeFinishedV1 extends EnyoDataBusMessage {
         chargeId: string;
         /** OCPP transaction identifier for the charging session */
         transactionId: string;
+        numberOfPhases?: number;
         /** ID of the vehicle that was charged (optional) */
         vehicleId?: string;
         /** ID of the charging card used for this session (optional) */
@@ -520,8 +528,52 @@ export interface EnyoDataBusChargerStatusChangedV1 extends EnyoDataBusMessage {
     applianceId: string;
     data: {
         /** Current OCPP status of the charger */
-        status: GenericChargePointStatus;
+        status: EnyoChargerApplianceStatusEnum;
         /** Connector ID on the charge point (optional, for multi-connector chargers) */
         connectorId?: number;
     };
 }
+/**
+ * Request message to get a preview of the optimized charging schedule.
+ * Sent when user wants to see the charging plan before starting.
+ */
+export interface EnyoDataBusRequestPreviewChargingScheduleV1 extends EnyoDataBusMessage {
+    type: 'message';
+    message: EnyoDataBusMessageEnum.RequestPreviewChargingScheduleV1;
+    data: {
+        /** ID of the appliance (charger) to get preview for */
+        applianceId: string;
+        /** Unique request identifier for correlating the response */
+        requestId: string;
+        /** Target energy to be delivered in Wh (optional) */
+        targetEnergyWh?: number;
+        /** Target completion time as ISO timestamp (optional) */
+        completeByIso?: string;
+        /** Charger max power setting in Watts for cost comparison (optional) */
+        chargerMaxPowerW?: number;
+        /** Whether to include cost comparison in response */
+        includeCostComparison?: boolean;
+    };
+}
+/**
+ * Response message containing the preview charging schedule or indicating unavailability.
+ * Sent by energy manager if available, or by device core if not.
+ */
+export interface EnyoDataBusPreviewChargingScheduleResponseV1 extends EnyoDataBusMessage {
+    type: 'message';
+    message: EnyoDataBusMessageEnum.PreviewChargingScheduleResponseV1;
+    data: {
+        /** The request ID this response corresponds to */
+        requestId: string;
+        /** ID of the appliance this schedule is for */
+        applianceId: string;
+        /** Whether a preview charging schedule is available */
+        available: boolean;
+        /** The preview charging schedule (only present if available=true) */
+        schedule?: PreviewChargingSchedule;
+        /** Cost comparison data (only present if requested and available) */
+        costComparison?: PreviewChargingScheduleCostComparison;
+        /** Reason why preview is not available (only present if available=false) */
+        unavailableReason?: PreviewChargingScheduleUnavailableReasonEnum;
+    };
+}

package/dist/cjs/types/enyo-energy-manager.cjs

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PreviewChargingScheduleUnavailableReasonEnum = exports.EnergyManagerFeatureEnum = void 0;
+/**
+ * Enum of available energy manager features.
+ * Used to check if a specific feature is supported by the current energy manager.
+ */
+var EnergyManagerFeatureEnum;
+(function (EnergyManagerFeatureEnum) {
+    /** The energy manager supports generating preview charge schedules */
+    EnergyManagerFeatureEnum["PreviewChargeSchedule"] = "preview-charge-schedule";
+})(EnergyManagerFeatureEnum || (exports.EnergyManagerFeatureEnum = EnergyManagerFeatureEnum = {}));
+/**
+ * Reason why a preview charging schedule is not available.
+ * Returned when a preview charging schedule request cannot be fulfilled.
+ */
+var PreviewChargingScheduleUnavailableReasonEnum;
+(function (PreviewChargingScheduleUnavailableReasonEnum) {
+    /** No energy manager is configured in the system */
+    PreviewChargingScheduleUnavailableReasonEnum["NoEnergyManager"] = "no-energy-manager";
+    /** No electricity tariff data available for cost optimization */
+    PreviewChargingScheduleUnavailableReasonEnum["NoTariffData"] = "no-tariff-data";
+    /** The requested appliance was not found */
+    PreviewChargingScheduleUnavailableReasonEnum["ApplianceNotFound"] = "appliance-not-found";
+    /** The energy manager does not support the preview schedule feature */
+    PreviewChargingScheduleUnavailableReasonEnum["FeatureNotSupported"] = "feature-not-supported";
+})(PreviewChargingScheduleUnavailableReasonEnum || (exports.PreviewChargingScheduleUnavailableReasonEnum = PreviewChargingScheduleUnavailableReasonEnum = {}));

package/dist/cjs/types/enyo-energy-manager.d.cts

@@ -0,0 +1,72 @@
+/**
+ * Enum of available energy manager features.
+ * Used to check if a specific feature is supported by the current energy manager.
+ */
+export declare enum EnergyManagerFeatureEnum {
+    /** The energy manager supports generating preview charge schedules */
+    PreviewChargeSchedule = "preview-charge-schedule"
+}
+/**
+ * Reason why a preview charging schedule is not available.
+ * Returned when a preview charging schedule request cannot be fulfilled.
+ */
+export declare enum PreviewChargingScheduleUnavailableReasonEnum {
+    /** No energy manager is configured in the system */
+    NoEnergyManager = "no-energy-manager",
+    /** No electricity tariff data available for cost optimization */
+    NoTariffData = "no-tariff-data",
+    /** The requested appliance was not found */
+    ApplianceNotFound = "appliance-not-found",
+    /** The energy manager does not support the preview schedule feature */
+    FeatureNotSupported = "feature-not-supported"
+}
+/**
+ * Information about the current energy manager.
+ * Describes the active energy manager and its capabilities.
+ */
+export interface EnergyManagerInfo {
+    /** Unique identifier of the energy manager package */
+    packageId: string;
+    /** Display name of the energy manager */
+    name: string;
+    /** Array of supported features */
+    features: EnergyManagerFeatureEnum[];
+}
+/**
+ * A single entry in the charging schedule.
+ * Defines a time period with a specific charging power limit.
+ */
+export interface PreviewChargingScheduleEntry {
+    /** ISO timestamp for when this schedule entry starts */
+    startIso: string;
+    /** ISO timestamp for when this schedule entry ends */
+    endIso: string;
+    /** Charging power limit in Watts for this period */
+    chargingPowerW: number;
+}
+/**
+ * Complete preview charging schedule with timing information.
+ * Represents an optimized charging plan with detailed time slots.
+ */
+export interface PreviewChargingSchedule {
+    /** Array of schedule entries defining the optimized charging plan */
+    entries: PreviewChargingScheduleEntry[];
+    /** Total energy to be delivered in Wh */
+    totalEnergyWh: number;
+    /** Estimated completion time as ISO timestamp */
+    estimatedCompletionIso: string;
+}
+/**
+ * Cost comparison between optimized and immediate charging.
+ * Shows potential savings from using an optimized charging schedule.
+ */
+export interface PreviewChargingScheduleCostComparison {
+    /** Estimated cost for the optimized schedule in cents */
+    optimizedCostCents: number;
+    /** Estimated cost for immediate charging at max power in cents */
+    immediateCostCents: number;
+    /** Savings achieved by using the optimized schedule in cents */
+    savingsCents: number;
+    /** Currency code (e.g., 'EUR') */
+    currency: string;
+}

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });