@enyo-energy/energy-app-sdk 0.0.160 → 0.0.162

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

@@ -144,7 +144,6 @@ export interface EnergyAppPackagePermission {
 }
 /**
  * A specific device model supported by an Energy App package.
- * Used inside {@link EnergyAppPackageCompatibilityVendor.models} to enumerate
  * the concrete models the package has been verified to work with.
  */
 export interface EnergyAppPackageCompatibilityModel {
@@ -171,11 +170,6 @@ export interface EnergyAppPackageCompatibilityModel {
 export interface EnergyAppPackageCompatibilityVendor {
     /** Human-readable vendor name (e.g. "SolarEdge", "Fronius") */
     vendorName: string;
-    /**
-     * Optional vendor logo path, mirroring the package-level `logo` field.
-     * Useful when the host wants to render a vendor list in the store.
-     */
-    logo?: string;
     /** Models from this vendor that the package supports */
     models: EnergyAppPackageCompatibilityModel[];
 }
@@ -206,13 +200,13 @@ export interface EnergyAppPackageDefinition {
     /** If the energy app should be visible in the enyo store. Default is true*/
     showInStore?: boolean;
     /**
-     * Optional declaration of vendors and models this package is compatible with.
+     * declaration of vendors and models this package is compatible with.
      * Each entry pairs a vendor with the concrete models the package supports,
      * allowing the enyo Store and onboarding flows to surface accurate
      * compatibility information to users. Omit when the package targets a
      * single vendor implicitly or has no fixed compatibility surface.
      */
-    compatibility?: EnergyAppPackageCompatibilityVendor[];
+    compatibility: EnergyAppPackageCompatibilityVendor[];
 }
 /**
  * Defines an Energy App package with automatic SDK version injection.

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

@@ -215,9 +215,6 @@ class ApplianceManager {
         // returns the new appliance without racing the appliance-updated
         // listener (which may fire on a later microtask).
         await this.primeCacheFromSdk(applianceId);
-        if (this.config.enableLogging) {
-            console.debug(`${existingApplianceId ? 'Updated' : 'Created'} appliance ${applianceId} of type ${appliance.type}`);
-        }
         return applianceId;
     }
     /**
@@ -278,18 +275,12 @@ class ApplianceManager {
         const updatedListenerId = applianceService.listenForApplianceUpdated((appliance) => {
             if (this.disposed)
                 return;
-            if (this.config.enableLogging) {
-                console.debug(`Appliance updated event received for ${appliance.id}`);
-            }
             this.updateCache(appliance);
         });
         this.listenerIds.push(updatedListenerId);
         const removedListenerId = applianceService.listenForApplianceRemoved((applianceId) => {
             if (this.disposed)
                 return;
-            if (this.config.enableLogging) {
-                console.debug(`Appliance removed event received for ${applianceId}`);
-            }
             this.removeFromCache(applianceId);
         });
         this.listenerIds.push(removedListenerId);
@@ -469,9 +460,6 @@ class ApplianceManager {
         };
         await this.energyApp.useAppliances().save(updated, applianceId);
         await this.primeCacheFromSdk(applianceId);
-        if (this.config.enableLogging) {
-            console.debug(`Updated appliance ${applianceId} state to ${state}`);
-        }
     }
     /**
      * Patches an appliance with the provided attributes via {@link mergeApplianceData}.
@@ -491,9 +479,6 @@ class ApplianceManager {
         const updated = this.mergeApplianceData(appliance, attributes);
         await this.energyApp.useAppliances().save(updated, applianceId);
         await this.primeCacheFromSdk(applianceId);
-        if (this.config.enableLogging) {
-            console.debug(`Updated appliance ${applianceId}`);
-        }
     }
     /**
      * Refetches an appliance from the SDK and reflects the result in the
@@ -517,9 +502,6 @@ class ApplianceManager {
     async removeAppliance(applianceId) {
         this.throwIfDisposed();
         await this.energyApp.useAppliances().removeById(applianceId);
-        if (this.config.enableLogging) {
-            console.debug(`Removed appliance ${applianceId}`);
-        }
     }
     /**
      * Removes every appliance matching the given identifier. Per-appliance
@@ -600,9 +582,6 @@ class ApplianceManager {
                 failed.push(update.applianceId);
             }
         }
-        if (this.config.enableLogging) {
-            console.debug(`Bulk update completed: ${succeeded.length} succeeded, ${failed.length} failed`);
-        }
         return { succeeded, failed };
     }
     /**
@@ -625,9 +604,6 @@ class ApplianceManager {
     async setIdentifierStrategy(strategy, rebuildCache) {
         this.throwIfDisposed();
         this.config.identifierStrategy = strategy;
-        if (this.config.enableLogging) {
-            console.debug(`Changed identifier strategy to: ${strategy.name}`);
-        }
         if (rebuildCache) {
             await this.refreshCache();
             return;
@@ -663,9 +639,6 @@ class ApplianceManager {
         }
         this.listenerIds = [];
         this.clearCache();
-        if (this.config.enableLogging) {
-            console.debug('ApplianceManager disposed');
-        }
     }
     /**
      * Throws {@link ApplianceManagerDisposedError} if {@link dispose} has been

package/dist/cjs/packages/eebus/eebus-device-management.d.cts

@@ -1,4 +1,13 @@
 import { EebusConnectionStatusEnum, EebusDevice, EebusDiscoveredDevice, EebusPeerManufacturerData } from '../../types/enyo-eebus.cjs';
+/**
+ * Options controlling how an active SHIP connection is established via
+ * {@link EebusDeviceManagement.connect}.
+ */
+export interface EebusConnectOptions {
+    /** Advertised heartbeat timeout (seconds, sent as `PT{n}S`) passed to
+     *  `EebusService.connect` for the gateway. Defaults to **4** (PT4S). */
+    heartbeatTimeoutSeconds?: number;
+}
 /**
  * SHIP-level device lifecycle management for EEbus devices.
  *
@@ -13,7 +22,7 @@ import { EebusConnectionStatusEnum, EebusDevice, EebusDiscoveredDevice, EebusPee
  *
  * const discovered = await eebus.devices.getDiscoveredDevices();
  * const device = await eebus.devices.pairDevice(discovered[0].ski);
- * await eebus.devices.connect(device.ski);
+ * await eebus.devices.connect(device.ski, {heartbeatTimeoutSeconds: 4});
  *
  * const listenerId = eebus.devices.listenForConnectionStatusChange((ski, status) => {
  *   console.log(`${ski} → ${status}`);
@@ -49,8 +58,10 @@ export interface EebusDeviceManagement {
      * Establish an active SHIP connection to an already-paired device.
      * The device must have been previously paired via {@link pairDevice}.
      * @param ski Subject Key Identifier of the device to connect to
+     * @param options Connection options, e.g. the advertised heartbeat timeout.
+     *                See {@link EebusConnectOptions}.
      */
-    connect: (ski: string) => Promise<void>;
+    connect: (ski: string, options: EebusConnectOptions) => Promise<void>;
     /**
      * Safely disconnect from a currently connected device.
      * @param ski Subject Key Identifier of the device to disconnect from

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

@@ -3,7 +3,7 @@ import { EebusFeatureCatalog } from './eebus-feature-catalog.cjs';
 import { EebusIdentityService } from './eebus-identity-service.cjs';
 import { EebusSpineLowLevel } from './eebus-spine-low-level.cjs';
 import { EebusUseCaseRegistry } from './eebus-use-case-registry.cjs';
-export { EebusDeviceManagement } from './eebus-device-management.cjs';
+export { EebusDeviceManagement, EebusConnectOptions } from './eebus-device-management.cjs';
 export { EebusFeatureCatalog, EebusFeatureAddressMatch, EebusFindFeatureForClientOptions, } from './eebus-feature-catalog.cjs';
 export { EebusIdentityService } from './eebus-identity-service.cjs';
 export { EebusSpineLowLevel } from './eebus-spine-low-level.cjs';
@@ -47,7 +47,7 @@ export { EebusVapdClient, VapdClientOptions } from './eebus-vapd-client.cjs';
  * // 1. SHIP — pair and connect
  * const [discovered] = await eebus.devices.getDiscoveredDevices();
  * const device = await eebus.devices.pairDevice(discovered.ski);
- * await eebus.devices.connect(device.ski);
+ * await eebus.devices.connect(device.ski, {heartbeatTimeoutSeconds: 4});
  *
  * // 2. NID — read identity and watch for changes
  * const identity = await eebus.identity.get(device.ski);

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.160';
+exports.SDK_VERSION = '0.0.162';
 /**
  * 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.160";
+export declare const SDK_VERSION = "0.0.162";
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/energy-app-package-definition.d.ts

@@ -144,7 +144,6 @@ export interface EnergyAppPackagePermission {
 }
 /**
  * A specific device model supported by an Energy App package.
- * Used inside {@link EnergyAppPackageCompatibilityVendor.models} to enumerate
  * the concrete models the package has been verified to work with.
  */
 export interface EnergyAppPackageCompatibilityModel {
@@ -171,11 +170,6 @@ export interface EnergyAppPackageCompatibilityModel {
 export interface EnergyAppPackageCompatibilityVendor {
     /** Human-readable vendor name (e.g. "SolarEdge", "Fronius") */
     vendorName: string;
-    /**
-     * Optional vendor logo path, mirroring the package-level `logo` field.
-     * Useful when the host wants to render a vendor list in the store.
-     */
-    logo?: string;
     /** Models from this vendor that the package supports */
     models: EnergyAppPackageCompatibilityModel[];
 }
@@ -206,13 +200,13 @@ export interface EnergyAppPackageDefinition {
     /** If the energy app should be visible in the enyo store. Default is true*/
     showInStore?: boolean;
     /**
-     * Optional declaration of vendors and models this package is compatible with.
+     * declaration of vendors and models this package is compatible with.
      * Each entry pairs a vendor with the concrete models the package supports,
      * allowing the enyo Store and onboarding flows to surface accurate
      * compatibility information to users. Omit when the package targets a
      * single vendor implicitly or has no fixed compatibility surface.
      */
-    compatibility?: EnergyAppPackageCompatibilityVendor[];
+    compatibility: EnergyAppPackageCompatibilityVendor[];
 }
 /**
  * Defines an Energy App package with automatic SDK version injection.

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

@@ -209,9 +209,6 @@ export class ApplianceManager {
         // returns the new appliance without racing the appliance-updated
         // listener (which may fire on a later microtask).
         await this.primeCacheFromSdk(applianceId);
-        if (this.config.enableLogging) {
-            console.debug(`${existingApplianceId ? 'Updated' : 'Created'} appliance ${applianceId} of type ${appliance.type}`);
-        }
         return applianceId;
     }
     /**
@@ -272,18 +269,12 @@ export class ApplianceManager {
         const updatedListenerId = applianceService.listenForApplianceUpdated((appliance) => {
             if (this.disposed)
                 return;
-            if (this.config.enableLogging) {
-                console.debug(`Appliance updated event received for ${appliance.id}`);
-            }
             this.updateCache(appliance);
         });
         this.listenerIds.push(updatedListenerId);
         const removedListenerId = applianceService.listenForApplianceRemoved((applianceId) => {
             if (this.disposed)
                 return;
-            if (this.config.enableLogging) {
-                console.debug(`Appliance removed event received for ${applianceId}`);
-            }
             this.removeFromCache(applianceId);
         });
         this.listenerIds.push(removedListenerId);
@@ -463,9 +454,6 @@ export class ApplianceManager {
         };
         await this.energyApp.useAppliances().save(updated, applianceId);
         await this.primeCacheFromSdk(applianceId);
-        if (this.config.enableLogging) {
-            console.debug(`Updated appliance ${applianceId} state to ${state}`);
-        }
     }
     /**
      * Patches an appliance with the provided attributes via {@link mergeApplianceData}.
@@ -485,9 +473,6 @@ export class ApplianceManager {
         const updated = this.mergeApplianceData(appliance, attributes);
         await this.energyApp.useAppliances().save(updated, applianceId);
         await this.primeCacheFromSdk(applianceId);
-        if (this.config.enableLogging) {
-            console.debug(`Updated appliance ${applianceId}`);
-        }
     }
     /**
      * Refetches an appliance from the SDK and reflects the result in the
@@ -511,9 +496,6 @@ export class ApplianceManager {
     async removeAppliance(applianceId) {
         this.throwIfDisposed();
         await this.energyApp.useAppliances().removeById(applianceId);
-        if (this.config.enableLogging) {
-            console.debug(`Removed appliance ${applianceId}`);
-        }
     }
     /**
      * Removes every appliance matching the given identifier. Per-appliance
@@ -594,9 +576,6 @@ export class ApplianceManager {
                 failed.push(update.applianceId);
             }
         }
-        if (this.config.enableLogging) {
-            console.debug(`Bulk update completed: ${succeeded.length} succeeded, ${failed.length} failed`);
-        }
         return { succeeded, failed };
     }
     /**
@@ -619,9 +598,6 @@ export class ApplianceManager {
     async setIdentifierStrategy(strategy, rebuildCache) {
         this.throwIfDisposed();
         this.config.identifierStrategy = strategy;
-        if (this.config.enableLogging) {
-            console.debug(`Changed identifier strategy to: ${strategy.name}`);
-        }
         if (rebuildCache) {
             await this.refreshCache();
             return;
@@ -657,9 +633,6 @@ export class ApplianceManager {
         }
         this.listenerIds = [];
         this.clearCache();
-        if (this.config.enableLogging) {
-            console.debug('ApplianceManager disposed');
-        }
     }
     /**
      * Throws {@link ApplianceManagerDisposedError} if {@link dispose} has been

package/dist/packages/eebus/eebus-device-management.d.ts

@@ -1,4 +1,13 @@
 import { EebusConnectionStatusEnum, EebusDevice, EebusDiscoveredDevice, EebusPeerManufacturerData } from '../../types/enyo-eebus.js';
+/**
+ * Options controlling how an active SHIP connection is established via
+ * {@link EebusDeviceManagement.connect}.
+ */
+export interface EebusConnectOptions {
+    /** Advertised heartbeat timeout (seconds, sent as `PT{n}S`) passed to
+     *  `EebusService.connect` for the gateway. Defaults to **4** (PT4S). */
+    heartbeatTimeoutSeconds?: number;
+}
 /**
  * SHIP-level device lifecycle management for EEbus devices.
  *
@@ -13,7 +22,7 @@ import { EebusConnectionStatusEnum, EebusDevice, EebusDiscoveredDevice, EebusPee
  *
  * const discovered = await eebus.devices.getDiscoveredDevices();
  * const device = await eebus.devices.pairDevice(discovered[0].ski);
- * await eebus.devices.connect(device.ski);
+ * await eebus.devices.connect(device.ski, {heartbeatTimeoutSeconds: 4});
  *
  * const listenerId = eebus.devices.listenForConnectionStatusChange((ski, status) => {
  *   console.log(`${ski} → ${status}`);
@@ -49,8 +58,10 @@ export interface EebusDeviceManagement {
      * Establish an active SHIP connection to an already-paired device.
      * The device must have been previously paired via {@link pairDevice}.
      * @param ski Subject Key Identifier of the device to connect to
+     * @param options Connection options, e.g. the advertised heartbeat timeout.
+     *                See {@link EebusConnectOptions}.
      */
-    connect: (ski: string) => Promise<void>;
+    connect: (ski: string, options: EebusConnectOptions) => Promise<void>;
     /**
      * Safely disconnect from a currently connected device.
      * @param ski Subject Key Identifier of the device to disconnect from

package/dist/packages/eebus/energy-app-eebus.d.ts

@@ -3,7 +3,7 @@ import { EebusFeatureCatalog } from './eebus-feature-catalog.js';
 import { EebusIdentityService } from './eebus-identity-service.js';
 import { EebusSpineLowLevel } from './eebus-spine-low-level.js';
 import { EebusUseCaseRegistry } from './eebus-use-case-registry.js';
-export { EebusDeviceManagement } from './eebus-device-management.js';
+export { EebusDeviceManagement, EebusConnectOptions } from './eebus-device-management.js';
 export { EebusFeatureCatalog, EebusFeatureAddressMatch, EebusFindFeatureForClientOptions, } from './eebus-feature-catalog.js';
 export { EebusIdentityService } from './eebus-identity-service.js';
 export { EebusSpineLowLevel } from './eebus-spine-low-level.js';
@@ -47,7 +47,7 @@ export { EebusVapdClient, VapdClientOptions } from './eebus-vapd-client.js';
  * // 1. SHIP — pair and connect
  * const [discovered] = await eebus.devices.getDiscoveredDevices();
  * const device = await eebus.devices.pairDevice(discovered.ski);
- * await eebus.devices.connect(device.ski);
+ * await eebus.devices.connect(device.ski, {heartbeatTimeoutSeconds: 4});
  *
  * // 2. NID — read identity and watch for changes
  * const identity = await eebus.identity.get(device.ski);

package/dist/version.d.ts

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