@enyo-energy/energy-app-sdk 0.0.118 → 0.0.119

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

@@ -1,4 +1,4 @@
-import { MqttConnectOptions, MqttExternalConnectOptions, MqttConnectionStatus, MqttSubscribeOptions, MqttPublishOptions, MqttMessage } from "../types/enyo-mqtt.cjs";
+import { MqttConnectOptions, MqttExternalConnectOptions, MqttConnectionStatus, MqttSubscribeOptions, MqttPublishOptions, MqttMessage, EnyoMqttAvailableConnectionDetails } from "../types/enyo-mqtt.cjs";
 /**
  * Interface for MQTT communication in enyo packages.
  * Provides MQTT client functionality with support for both the SDK-provided
@@ -59,6 +59,26 @@ export interface EnergyAppMqtt {
      * ```
      */
     connect: (options: MqttExternalConnectOptions) => Promise<EnergyAppMqttClient>;
+    /**
+     * Get connection details for MQTT brokers exposed to the energy app.
+     * Currently returns details for the SDK-provided local MQTT broker so callers
+     * can connect with their own MQTT client implementation when {@link connectInternal}
+     * is not suitable (e.g. bridging to another runtime, configuring a third-party
+     * library, or providing the broker address to an external process).
+     *
+     * Mirrors the OCPP `getAvailableConnectionDetails` API.
+     *
+     * @returns A map of available broker connection details, keyed by scope (e.g. `local`).
+     *
+     * @example
+     * ```typescript
+     * const details = await mqtt.getAvailableConnectionDetails();
+     * if (details.local) {
+     *     console.log(`Local broker available at ${details.local.url}`);
+     * }
+     * ```
+     */
+    getAvailableConnectionDetails: () => Promise<EnyoMqttAvailableConnectionDetails>;
 }
 /**
  * Represents an active MQTT client connection.

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

@@ -106,6 +106,8 @@ var EnyoChargeModeEnum;
     EnyoChargeModeEnum["CostOptimized"] = "cost-optimized";
     /** Optimize charging schedule for a maximum price limit, for example 7 ct grid or pv production */
     EnyoChargeModeEnum["PriceLimit"] = "price-limit";
+    /** Charge only from PV surplus, using excess solar production that would otherwise be fed into the grid */
+    EnyoChargeModeEnum["PvSurplus"] = "pv-surplus";
 })(EnyoChargeModeEnum || (exports.EnyoChargeModeEnum = EnyoChargeModeEnum = {}));
 var EnyoDataBusMessageEnum;
 (function (EnyoDataBusMessageEnum) {

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

@@ -122,7 +122,9 @@ export declare enum EnyoChargeModeEnum {
     /** Optimize charging schedule for lowest cost */
     CostOptimized = "cost-optimized",
     /** Optimize charging schedule for a maximum price limit, for example 7 ct grid or pv production */
-    PriceLimit = "price-limit"
+    PriceLimit = "price-limit",
+    /** Charge only from PV surplus, using excess solar production that would otherwise be fed into the grid */
+    PvSurplus = "pv-surplus"
 }
 export interface EnyoAggregatedStateApplianceValues {
     gridPowerW?: number;

package/dist/cjs/types/enyo-mqtt.d.cts

@@ -84,6 +84,34 @@ export interface MqttPublishOptions {
     /** Whether the broker should retain this message as the last known value for the topic (default: false) */
     retain?: boolean;
 }
+/**
+ * Connection details for an MQTT broker exposed to the energy app.
+ * Returned by {@link EnergyAppMqtt.getAvailableConnectionDetails} so callers can
+ * connect to the broker using their own MQTT client implementation if needed.
+ */
+export interface EnyoMqttAvailableConnectionDetail {
+    /** Fully qualified broker URL including protocol and port (e.g. "mqtt://127.0.0.1:1883" or "mqtts://broker.local:8883") */
+    url: string;
+    /** Broker hostname or IP address (e.g. "127.0.0.1") */
+    host: string;
+    /** Broker TCP port (e.g. 1883 for plain, 8883 for TLS) */
+    port: number;
+    /** Whether the broker requires a TLS/SSL connection */
+    secure: boolean;
+    /** Username for broker authentication, if required */
+    username?: string;
+    /** Password for broker authentication, if required */
+    password?: string;
+}
+/**
+ * Map of available MQTT broker connection details by scope.
+ * Mirrors the structure of OCPP available connection details so callers can
+ * uniformly discover broker endpoints exposed by the runtime.
+ */
+export interface EnyoMqttAvailableConnectionDetails {
+    /** Connection details for the SDK-provided local MQTT broker, when available */
+    local?: EnyoMqttAvailableConnectionDetail;
+}
 /**
  * Represents an incoming MQTT message received on a subscribed topic.
  */

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

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

@@ -1,4 +1,4 @@
-import { MqttConnectOptions, MqttExternalConnectOptions, MqttConnectionStatus, MqttSubscribeOptions, MqttPublishOptions, MqttMessage } from "../types/enyo-mqtt.js";
+import { MqttConnectOptions, MqttExternalConnectOptions, MqttConnectionStatus, MqttSubscribeOptions, MqttPublishOptions, MqttMessage, EnyoMqttAvailableConnectionDetails } from "../types/enyo-mqtt.js";
 /**
  * Interface for MQTT communication in enyo packages.
  * Provides MQTT client functionality with support for both the SDK-provided
@@ -59,6 +59,26 @@ export interface EnergyAppMqtt {
      * ```
      */
     connect: (options: MqttExternalConnectOptions) => Promise<EnergyAppMqttClient>;
+    /**
+     * Get connection details for MQTT brokers exposed to the energy app.
+     * Currently returns details for the SDK-provided local MQTT broker so callers
+     * can connect with their own MQTT client implementation when {@link connectInternal}
+     * is not suitable (e.g. bridging to another runtime, configuring a third-party
+     * library, or providing the broker address to an external process).
+     *
+     * Mirrors the OCPP `getAvailableConnectionDetails` API.
+     *
+     * @returns A map of available broker connection details, keyed by scope (e.g. `local`).
+     *
+     * @example
+     * ```typescript
+     * const details = await mqtt.getAvailableConnectionDetails();
+     * if (details.local) {
+     *     console.log(`Local broker available at ${details.local.url}`);
+     * }
+     * ```
+     */
+    getAvailableConnectionDetails: () => Promise<EnyoMqttAvailableConnectionDetails>;
 }
 /**
  * Represents an active MQTT client connection.

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

@@ -122,7 +122,9 @@ export declare enum EnyoChargeModeEnum {
     /** Optimize charging schedule for lowest cost */
     CostOptimized = "cost-optimized",
     /** Optimize charging schedule for a maximum price limit, for example 7 ct grid or pv production */
-    PriceLimit = "price-limit"
+    PriceLimit = "price-limit",
+    /** Charge only from PV surplus, using excess solar production that would otherwise be fed into the grid */
+    PvSurplus = "pv-surplus"
 }
 export interface EnyoAggregatedStateApplianceValues {
     gridPowerW?: number;

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

@@ -103,6 +103,8 @@ export var EnyoChargeModeEnum;
     EnyoChargeModeEnum["CostOptimized"] = "cost-optimized";
     /** Optimize charging schedule for a maximum price limit, for example 7 ct grid or pv production */
     EnyoChargeModeEnum["PriceLimit"] = "price-limit";
+    /** Charge only from PV surplus, using excess solar production that would otherwise be fed into the grid */
+    EnyoChargeModeEnum["PvSurplus"] = "pv-surplus";
 })(EnyoChargeModeEnum || (EnyoChargeModeEnum = {}));
 export var EnyoDataBusMessageEnum;
 (function (EnyoDataBusMessageEnum) {

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

@@ -84,6 +84,34 @@ export interface MqttPublishOptions {
     /** Whether the broker should retain this message as the last known value for the topic (default: false) */
     retain?: boolean;
 }
+/**
+ * Connection details for an MQTT broker exposed to the energy app.
+ * Returned by {@link EnergyAppMqtt.getAvailableConnectionDetails} so callers can
+ * connect to the broker using their own MQTT client implementation if needed.
+ */
+export interface EnyoMqttAvailableConnectionDetail {
+    /** Fully qualified broker URL including protocol and port (e.g. "mqtt://127.0.0.1:1883" or "mqtts://broker.local:8883") */
+    url: string;
+    /** Broker hostname or IP address (e.g. "127.0.0.1") */
+    host: string;
+    /** Broker TCP port (e.g. 1883 for plain, 8883 for TLS) */
+    port: number;
+    /** Whether the broker requires a TLS/SSL connection */
+    secure: boolean;
+    /** Username for broker authentication, if required */
+    username?: string;
+    /** Password for broker authentication, if required */
+    password?: string;
+}
+/**
+ * Map of available MQTT broker connection details by scope.
+ * Mirrors the structure of OCPP available connection details so callers can
+ * uniformly discover broker endpoints exposed by the runtime.
+ */
+export interface EnyoMqttAvailableConnectionDetails {
+    /** Connection details for the SDK-provided local MQTT broker, when available */
+    local?: EnyoMqttAvailableConnectionDetail;
+}
 /**
  * Represents an incoming MQTT message received on a subscribed topic.
  */

package/dist/version.d.ts

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