@enyo-energy/energy-app-sdk 0.0.38 → 0.0.40

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

@@ -18,4 +18,5 @@ var EnergyAppPermissionTypeEnum;
     EnergyAppPermissionTypeEnum["ChargingCard"] = "ChargingCard";
     EnergyAppPermissionTypeEnum["Vehicle"] = "Vehicle";
     EnergyAppPermissionTypeEnum["Charge"] = "Charge";
+    EnergyAppPermissionTypeEnum["SecretManager"] = "SecretManager";
 })(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';
+export type EnergyAppPermissionType = 'RestrictedInternetAccess' | 'NetworkDeviceDiscovery' | 'NetworkDeviceSearch' | 'NetworkDeviceAccess' | 'Modbus' | 'Storage' | 'Appliance' | 'AllAppliances' | 'SendDataBusValues' | 'SubscribeDataBus' | 'SendDataBusCommands' | 'OcppServer' | 'ChargingCard' | 'Vehicle' | 'Charge' | 'SecretManager';
 export declare enum EnergyAppPermissionTypeEnum {
     RestrictedInternetAccess = "RestrictedInternetAccess",
     NetworkDeviceDiscovery = "NetworkDeviceDiscovery",
@@ -14,5 +14,6 @@ export declare enum EnergyAppPermissionTypeEnum {
     OcppServer = "OcppServer",
     ChargingCard = "ChargingCard",
     Vehicle = "Vehicle",
-    Charge = "Charge"
+    Charge = "Charge",
+    SecretManager = "SecretManager"
 }

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

@@ -12,6 +12,7 @@ import { EnergyAppAuthentication } from "./packages/energy-app-authentication.cj
 import { EnergyAppSettings } from "./packages/energy-app-settings.cjs";
 import { EnergyAppElectricityPrices } from "./packages/energy-app-electricity-prices.cjs";
 import { EnergyAppNotification } from "./packages/energy-app-notification.cjs";
+import { EnergyAppSecretManager } from "./packages/energy-app-secret-manager.cjs";
 export declare enum EnergyAppStateEnum {
     Launching = "launching",
     Running = "running",
@@ -64,4 +65,6 @@ export interface EnyoEnergyAppSdk {
     useElectricityPrices: () => EnergyAppElectricityPrices;
     /** Get the Notification API */
     useNotification: () => EnergyAppNotification;
+    /** Get the Secret Manager API */
+    useSecretManager: () => EnergyAppSecretManager;
 }

package/dist/cjs/implementations/appliances/appliance-manager.cjs

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApplianceManager = void 0;
+const index_js_1 = require("../../index.cjs");
 const enyo_appliance_js_1 = require("../../types/enyo-appliance.cjs");
-const identifier_strategies_js_1 = require("./identifier-strategies.cjs");
 /**
  * Manages appliances in the energy system with configurable identification strategies.
  * Provides comprehensive CRUD operations and state management for energy appliances.
@@ -20,62 +20,90 @@ class ApplianceManager {
     constructor(energyApp, config) {
         this.energyApp = energyApp;
         this.config = {
-            identifierStrategy: config?.identifierStrategy ?? new identifier_strategies_js_1.NetworkDeviceIdStrategy(),
+            identifierStrategy: config?.identifierStrategy ?? new index_js_1.SerialNumberStrategy(),
             autoUpdateMetadata: config?.autoUpdateMetadata ?? true,
             enableLogging: config?.enableLogging ?? true,
             defaultConnectionType: config?.defaultConnectionType ?? enyo_appliance_js_1.EnyoApplianceConnectionType.Connector,
-            defaultVendorName: config?.defaultVendorName ?? ''
+            defaultVendorName: config?.defaultVendorName ?? '',
         };
     }
+    /**
+     * initializes a new ApplianceManager instance with async initialization.
+     * This factory method handles cache initialization if configured.
+     * @param energyApp The EnergyApp instance to use for API calls
+     * @param config Configuration options for the manager
+     * @returns Promise that resolves to an initialized ApplianceManager instance
+     */
+    static async initialize(energyApp, config) {
+        const manager = new ApplianceManager(energyApp, config);
+        await manager.refreshCache();
+        return manager;
+    }
     /**
      * Creates or updates an appliance with the given configuration.
-     * @param config The appliance configuration
-     * @param existingApplianceId Optional ID of an existing appliance to update
+     * Automatically detects if an appliance already exists based on the identifier strategy.
+     * @param appliance The appliance configuration
      * @returns The ID of the created or updated appliance
      */
-    async createOrUpdateAppliance(config, existingApplianceId) {
+    async createOrUpdateAppliance(appliance) {
+        // Refresh cache to ensure we have latest appliances
+        await this.refreshCache();
+        // Try to find existing appliance using identifier strategy
+        let existingApplianceId;
+        const identifier = this.config.identifierStrategy.extract(appliance);
+        if (identifier) {
+            const existing = await this.findByIdentifier(identifier);
+            if (existing.length > 0) {
+                existingApplianceId = existing[0].id;
+                if (this.config.enableLogging) {
+                    console.log(`Found existing appliance with ID ${existingApplianceId} for identifier ${identifier}`);
+                }
+            }
+        }
         // Build network device IDs list
-        const networkDeviceIds = config.networkDevices?.map(d => d.id) ?? [];
+        const networkDeviceIds = appliance.networkDevices?.map(d => d.id) ?? [];
         // Merge metadata with defaults
         const metadata = {
             connectionType: this.config.defaultConnectionType,
             state: enyo_appliance_js_1.EnyoApplianceStateEnum.Connected,
-            ...config.metadata
+            ...appliance.metadata
         };
         if (this.config.defaultVendorName && !metadata.vendorName) {
             metadata.vendorName = this.config.defaultVendorName;
         }
         // Build appliance data
         const applianceData = {
-            name: config.name,
-            type: config.type,
+            name: appliance.name,
+            type: appliance.type,
             networkDeviceIds,
             metadata,
-            ...(config.topology && { topology: config.topology })
+            ...(appliance.topology && { topology: appliance.topology }),
+            meter: appliance.meter,
+            heatpump: appliance.heatpump,
+            battery: appliance.battery,
+            charger: appliance.charger,
+            inverter: appliance.inverter,
         };
-        // Add type-specific metadata
-        if (config.typeMetadata) {
-            Object.assign(applianceData, config.typeMetadata);
-        }
         // Save appliance
         const applianceId = await this.energyApp.useAppliances().save(applianceData, existingApplianceId);
         // Update cache
         const savedAppliance = await this.energyApp.useAppliances().getById(applianceId);
         if (savedAppliance) {
-            this.updateCache(savedAppliance, config.networkDevices?.[0]);
+            this.updateCache(savedAppliance);
+        }
+        if (this.config.enableLogging) {
+            console.log(`${existingApplianceId ? 'Updated' : 'Created'} appliance ${applianceId} of type ${appliance.type}`);
         }
-        console.log(`${existingApplianceId ? 'Updated' : 'Created'} appliance ${applianceId} of type ${config.type}`);
         return applianceId;
     }
     /**
      * Updates the internal cache with an appliance.
      * @param appliance The appliance to cache
-     * @param networkDevice Optional network device for identifier extraction
      */
-    updateCache(appliance, networkDevice) {
+    updateCache(appliance) {
         this.applianceCache.set(appliance.id, appliance);
         // Extract identifier
-        const identifier = this.config.identifierStrategy.extract(appliance, networkDevice);
+        const identifier = this.config.identifierStrategy.extract(appliance);
         if (identifier) {
             if (!this.identifierToApplianceId.has(identifier)) {
                 this.identifierToApplianceId.set(identifier, new Set());
@@ -99,7 +127,7 @@ class ApplianceManager {
         for (const appliance of appliances) {
             // Try to get network devices if available
             const networkDevices = await this.getNetworkDevicesForAppliance(appliance);
-            this.updateCache(appliance, networkDevices[0]);
+            this.updateCache(appliance);
         }
     }
     /**
@@ -143,10 +171,10 @@ class ApplianceManager {
         const matches = [];
         for (const appliance of allAppliances) {
             const networkDevices = await this.getNetworkDevicesForAppliance(appliance);
-            const extractedId = this.config.identifierStrategy.extract(appliance, networkDevices[0]);
+            const extractedId = this.config.identifierStrategy.extract(appliance);
             if (extractedId === identifier) {
                 matches.push(appliance);
-                this.updateCache(appliance, networkDevices[0]);
+                this.updateCache(appliance);
             }
         }
         return matches;
@@ -162,7 +190,7 @@ class ApplianceManager {
         for (const strategy of strategies) {
             for (const appliance of allAppliances) {
                 const networkDevices = await this.getNetworkDevicesForAppliance(appliance);
-                const identifier = strategy.extract(appliance, networkDevices[0]);
+                const identifier = strategy.extract(appliance);
                 if (identifier === searchValue) {
                     return {
                         appliance,

package/dist/cjs/implementations/appliances/appliance-manager.d.cts

@@ -1,4 +1,4 @@
-import type { EnergyApp } from "../../index.cjs";
+import { EnergyApp } from "../../index.cjs";
 import type { EnyoNetworkDevice } from "../../types/enyo-network-device.cjs";
 import { EnyoAppliance, EnyoApplianceConnectionType, EnyoApplianceMetadata, EnyoApplianceName, EnyoApplianceStateEnum, EnyoApplianceTopology, EnyoApplianceTypeEnum } from "../../types/enyo-appliance.cjs";
 import type { EnyoChargerApplianceMetadata } from "../../types/enyo-charger-appliance.cjs";
@@ -22,13 +22,11 @@ export interface ApplianceConfig {
     /** Topology information */
     topology?: EnyoApplianceTopology;
     /** Type-specific metadata based on appliance type */
-    typeMetadata?: {
-        meter?: EnyoMeterAppliance;
-        inverter?: EnyoInverterApplianceMetadata;
-        charger?: EnyoChargerApplianceMetadata;
-        heatpump?: EnyoHeatpumpApplianceMetadata;
-        battery?: EnyoBatteryApplianceMetadata;
-    };
+    meter?: EnyoMeterAppliance;
+    inverter?: EnyoInverterApplianceMetadata;
+    charger?: EnyoChargerApplianceMetadata;
+    heatpump?: EnyoHeatpumpApplianceMetadata;
+    battery?: EnyoBatteryApplianceMetadata;
 }
 /**
  * Configuration options for the ApplianceManager.
@@ -64,26 +62,33 @@ export declare class ApplianceManager {
     private energyApp;
     private applianceCache;
     private identifierToApplianceId;
-    private config;
+    protected config: Required<ApplianceManagerConfig>;
     /**
      * Creates a new ApplianceManager instance.
      * @param energyApp The EnergyApp instance to use for API calls
      * @param config Configuration options for the manager
      */
     constructor(energyApp: EnergyApp, config?: ApplianceManagerConfig);
+    /**
+     * initializes a new ApplianceManager instance with async initialization.
+     * This factory method handles cache initialization if configured.
+     * @param energyApp The EnergyApp instance to use for API calls
+     * @param config Configuration options for the manager
+     * @returns Promise that resolves to an initialized ApplianceManager instance
+     */
+    private static initialize;
     /**
      * Creates or updates an appliance with the given configuration.
-     * @param config The appliance configuration
-     * @param existingApplianceId Optional ID of an existing appliance to update
+     * Automatically detects if an appliance already exists based on the identifier strategy.
+     * @param appliance The appliance configuration
      * @returns The ID of the created or updated appliance
      */
-    createOrUpdateAppliance(config: ApplianceConfig, existingApplianceId?: string): Promise<string>;
+    createOrUpdateAppliance(appliance: ApplianceConfig): Promise<string>;
     /**
      * Updates the internal cache with an appliance.
      * @param appliance The appliance to cache
-     * @param networkDevice Optional network device for identifier extraction
      */
-    private updateCache;
+    protected updateCache(appliance: EnyoAppliance): void;
     /**
      * Clears the internal cache.
      */

package/dist/cjs/implementations/appliances/identifier-strategies.cjs

@@ -1,23 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IdentifierStrategyFactory = exports.FallbackIdentifierStrategy = exports.CompositeIdentifierStrategy = exports.CustomMetadataStrategy = exports.SerialNumberStrategy = exports.NetworkDeviceIdStrategy = void 0;
-/**
- * Strategy that uses the network device ID as the identifier.
- * This is the default strategy for most appliances.
- */
-class NetworkDeviceIdStrategy {
-    name = 'networkDeviceId';
-    /**
-     * Extracts the network device ID.
-     * @param appliance The appliance (not used in this strategy)
-     * @param networkDevice The network device to get the ID from
-     * @returns The network device ID or undefined
-     */
-    extract(appliance, networkDevice) {
-        return networkDevice?.id;
-    }
-}
-exports.NetworkDeviceIdStrategy = NetworkDeviceIdStrategy;
+exports.IdentifierStrategyFactory = exports.FallbackIdentifierStrategy = exports.CompositeIdentifierStrategy = exports.CustomMetadataStrategy = exports.SerialNumberStrategy = void 0;
 /**
  * Strategy that uses the appliance's serial number as the identifier.
  * Useful when appliances can move between network devices.
@@ -81,13 +64,12 @@ class CompositeIdentifierStrategy {
     /**
      * Extracts and combines identifiers from multiple strategies.
      * @param appliance The appliance to extract identifiers from
-     * @param networkDevice The network device if available
      * @returns The combined identifier or undefined if any part is missing
      */
-    extract(appliance, networkDevice) {
+    extract(appliance) {
         const parts = [];
         for (const strategy of this.strategies) {
-            const value = strategy.extract(appliance, networkDevice);
+            const value = strategy.extract(appliance);
             if (!value) {
                 return undefined; // All parts must be present
             }
@@ -115,12 +97,11 @@ class FallbackIdentifierStrategy {
     /**
      * Tries strategies in order and returns the first available identifier.
      * @param appliance The appliance to extract identifiers from
-     * @param networkDevice The network device if available
      * @returns The first available identifier or undefined
      */
-    extract(appliance, networkDevice) {
+    extract(appliance) {
         for (const strategy of this.strategies) {
-            const value = strategy.extract(appliance, networkDevice);
+            const value = strategy.extract(appliance);
             if (value) {
                 return value;
             }
@@ -133,12 +114,6 @@ exports.FallbackIdentifierStrategy = FallbackIdentifierStrategy;
  * Factory class for creating common identifier strategies.
  */
 class IdentifierStrategyFactory {
-    /**
-     * Creates the default network device ID strategy.
-     */
-    static networkDeviceId() {
-        return new NetworkDeviceIdStrategy();
-    }
     /**
      * Creates a serial number strategy.
      */
@@ -167,14 +142,5 @@ class IdentifierStrategyFactory {
     static fallback(strategies) {
         return new FallbackIdentifierStrategy(strategies);
     }
-    /**
-     * Creates a strategy that prefers serial number but falls back to network device ID.
-     */
-    static serialNumberOrDeviceId() {
-        return new FallbackIdentifierStrategy([
-            new SerialNumberStrategy(),
-            new NetworkDeviceIdStrategy()
-        ]);
-    }
 }
 exports.IdentifierStrategyFactory = IdentifierStrategyFactory;

package/dist/cjs/implementations/appliances/identifier-strategies.d.cts

@@ -1,5 +1,5 @@
 import type { EnyoAppliance } from "../../types/enyo-appliance.cjs";
-import type { EnyoNetworkDevice } from "../../types/enyo-network-device.cjs";
+import { ApplianceConfig } from "./appliance-manager.cjs";
 /**
  * Strategy interface for extracting unique identifiers from appliances.
  * Allows flexible identification of appliances based on different criteria.
@@ -8,29 +8,14 @@ export interface IdentifierStrategy {
     /**
      * Extract the unique identifier from an appliance or its associated data.
      * @param appliance The appliance to extract the identifier from
-     * @param networkDevice Optional network device associated with the appliance
      * @returns The extracted identifier string, or undefined if not available
      */
-    extract(appliance: Partial<EnyoAppliance>, networkDevice?: EnyoNetworkDevice): string | undefined;
+    extract(appliance: EnyoAppliance | ApplianceConfig): string | undefined;
     /**
      * Name of the strategy for logging and debugging purposes.
      */
     name: string;
 }
-/**
- * Strategy that uses the network device ID as the identifier.
- * This is the default strategy for most appliances.
- */
-export declare class NetworkDeviceIdStrategy implements IdentifierStrategy {
-    name: string;
-    /**
-     * Extracts the network device ID.
-     * @param appliance The appliance (not used in this strategy)
-     * @param networkDevice The network device to get the ID from
-     * @returns The network device ID or undefined
-     */
-    extract(appliance: Partial<EnyoAppliance>, networkDevice?: EnyoNetworkDevice): string | undefined;
-}
 /**
  * Strategy that uses the appliance's serial number as the identifier.
  * Useful when appliances can move between network devices.
@@ -42,7 +27,7 @@ export declare class SerialNumberStrategy implements IdentifierStrategy {
      * @param appliance The appliance to extract the serial number from
      * @returns The serial number or undefined
      */
-    extract(appliance: Partial<EnyoAppliance>): string | undefined;
+    extract(appliance: EnyoAppliance | ApplianceConfig): string | undefined;
 }
 /**
  * Strategy that uses a custom metadata field as the identifier.
@@ -61,7 +46,7 @@ export declare class CustomMetadataStrategy implements IdentifierStrategy {
      * @param appliance The appliance to extract the field from
      * @returns The field value or undefined
      */
-    extract(appliance: Partial<EnyoAppliance>): string | undefined;
+    extract(appliance: EnyoAppliance | ApplianceConfig): string | undefined;
 }
 /**
  * Strategy that combines multiple identifiers to create a composite key.
@@ -80,10 +65,9 @@ export declare class CompositeIdentifierStrategy implements IdentifierStrategy {
     /**
      * Extracts and combines identifiers from multiple strategies.
      * @param appliance The appliance to extract identifiers from
-     * @param networkDevice The network device if available
      * @returns The combined identifier or undefined if any part is missing
      */
-    extract(appliance: Partial<EnyoAppliance>, networkDevice?: EnyoNetworkDevice): string | undefined;
+    extract(appliance: EnyoAppliance | ApplianceConfig): string | undefined;
 }
 /**
  * Strategy that tries multiple strategies in order and uses the first available identifier.
@@ -100,19 +84,14 @@ export declare class FallbackIdentifierStrategy implements IdentifierStrategy {
     /**
      * Tries strategies in order and returns the first available identifier.
      * @param appliance The appliance to extract identifiers from
-     * @param networkDevice The network device if available
      * @returns The first available identifier or undefined
      */
-    extract(appliance: Partial<EnyoAppliance>, networkDevice?: EnyoNetworkDevice): string | undefined;
+    extract(appliance: EnyoAppliance | ApplianceConfig): string | undefined;
 }
 /**
  * Factory class for creating common identifier strategies.
  */
 export declare class IdentifierStrategyFactory {
-    /**
-     * Creates the default network device ID strategy.
-     */
-    static networkDeviceId(): NetworkDeviceIdStrategy;
     /**
      * Creates a serial number strategy.
      */
@@ -133,8 +112,4 @@ export declare class IdentifierStrategyFactory {
      * @param strategies The strategies to try
      */
     static fallback(strategies: IdentifierStrategy[]): FallbackIdentifierStrategy;
-    /**
-     * Creates a strategy that prefers serial number but falls back to network device ID.
-     */
-    static serialNumberOrDeviceId(): FallbackIdentifierStrategy;
 }