@enyo-energy/energy-app-sdk 1.14.0 → 1.15.0

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

@@ -211,7 +211,7 @@ class ApplianceManager {
             airConditioning: appliance.airConditioning,
             heatingRod: appliance.heatingRod,
             smartPlug: appliance.smartPlug,
-            // Conditionally spread the two optional top-level fields that are NOT
+            // Conditionally spread the optional top-level fields that are NOT
             // covered by MERGEABLE_METADATA_KEYS. If they were always materialized
             // as explicit keys, an omitted (undefined) value would clobber the
             // stored value during mergeApplianceData's `{...existing, ...update}`
@@ -219,6 +219,7 @@ class ApplianceManager {
             // while dropping omitted fields so the existing value is preserved.
             ...(appliance.cloudPackageId !== undefined && { cloudPackageId: appliance.cloudPackageId }),
             ...(appliance.availableFeatures !== undefined && { availableFeatures: appliance.availableFeatures }),
+            ...(appliance.compatibilityModes !== undefined && { compatibilityModes: appliance.compatibilityModes }),
         };
         let applianceData = newApplianceData;
         if (existingApplianceId) {

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

@@ -65,6 +65,13 @@ export interface ApplianceConfig {
     heatingRod?: EnyoHeatingRodApplianceMetadata;
     smartPlug?: EnyoSmartPlugApplianceMetadata;
     availableFeatures?: EnyoApplianceAvailableFeaturesEnum[];
+    /**
+     * Optional vendor- or integration-specific compatibility modes. Forwarded to
+     * {@link EnyoAppliance.compatibilityModes} when the appliance is created or
+     * updated. Omit to keep the stored value on an update; pass an explicit `[]`
+     * to clear it.
+     */
+    compatibilityModes?: string[];
     /**
      * Optional identifier of the cloud-deployed energy app package that manages
      * this appliance. Forwarded to {@link EnyoAppliance.cloudPackageId} when the
@@ -443,6 +450,11 @@ export interface PartialEnyoAppliance {
     smartPlug?: Partial<EnyoSmartPlugApplianceMetadata>;
     /** Optional custom name for the appliance, defined by the user */
     customName?: string;
+    /**
+     * Optional list of vendor- or integration-specific compatibility modes that
+     * are active for this appliance. Mirrors {@link EnyoAppliance.compatibilityModes}.
+     */
+    compatibilityModes?: string[];
     /**
      * Optional identifier of the cloud-deployed energy app package that manages
      * this appliance. Mirrors {@link EnyoAppliance.cloudPackageId}.

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

@@ -54,7 +54,8 @@ class InMemoryApplianceManager extends appliance_manager_js_1.ApplianceManager {
         };
         // Build the incoming appliance data covering every ApplianceConfig field.
         // The two optional top-level fields that are NOT shallow-merged by
-        // mergeApplianceData (`cloudPackageId`, `availableFeatures`) are only
+        // mergeApplianceData (`cloudPackageId`, `availableFeatures`,
+        // `compatibilityModes`) are only
         // materialized when provided so an omitted value cannot clobber the stored
         // one during an update; pass an explicit value (e.g. `[]`) to clear them.
         const newApplianceData = {
@@ -73,6 +74,7 @@ class InMemoryApplianceManager extends appliance_manager_js_1.ApplianceManager {
             heatingRod: appliance.heatingRod,
             ...(appliance.cloudPackageId !== undefined && { cloudPackageId: appliance.cloudPackageId }),
             ...(appliance.availableFeatures !== undefined && { availableFeatures: appliance.availableFeatures }),
+            ...(appliance.compatibilityModes !== undefined && { compatibilityModes: appliance.compatibilityModes }),
         };
         // On update, merge onto the stored appliance so type-specific metadata and
         // top-level fields that were not supplied in this call are preserved.

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

@@ -277,6 +277,14 @@ export interface EnyoAppliance {
     smartPlug?: EnyoSmartPlugApplianceMetadata;
     /** Optional custom name for the appliance, defined by the user */
     customName?: string;
+    /**
+     * Optional list of vendor- or integration-specific compatibility modes that
+     * are active for this appliance. Each entry is a free-form, non-localized
+     * identifier describing a behavioural deviation the appliance requires
+     * (e.g. a firmware quirk workaround or a legacy protocol dialect).
+     * Consumers that do not know a given mode should ignore it.
+     */
+    compatibilityModes?: string[];
     /**
      * Optional identifier of the cloud-deployed energy app package that manages
      * this appliance. Set when the appliance is provisioned and operated by a

package/dist/cjs/version.cjs

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

package/dist/implementations/appliances/appliance-manager.d.ts

@@ -65,6 +65,13 @@ export interface ApplianceConfig {
     heatingRod?: EnyoHeatingRodApplianceMetadata;
     smartPlug?: EnyoSmartPlugApplianceMetadata;
     availableFeatures?: EnyoApplianceAvailableFeaturesEnum[];
+    /**
+     * Optional vendor- or integration-specific compatibility modes. Forwarded to
+     * {@link EnyoAppliance.compatibilityModes} when the appliance is created or
+     * updated. Omit to keep the stored value on an update; pass an explicit `[]`
+     * to clear it.
+     */
+    compatibilityModes?: string[];
     /**
      * Optional identifier of the cloud-deployed energy app package that manages
      * this appliance. Forwarded to {@link EnyoAppliance.cloudPackageId} when the
@@ -443,6 +450,11 @@ export interface PartialEnyoAppliance {
     smartPlug?: Partial<EnyoSmartPlugApplianceMetadata>;
     /** Optional custom name for the appliance, defined by the user */
     customName?: string;
+    /**
+     * Optional list of vendor- or integration-specific compatibility modes that
+     * are active for this appliance. Mirrors {@link EnyoAppliance.compatibilityModes}.
+     */
+    compatibilityModes?: string[];
     /**
      * Optional identifier of the cloud-deployed energy app package that manages
      * this appliance. Mirrors {@link EnyoAppliance.cloudPackageId}.

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

@@ -205,7 +205,7 @@ export class ApplianceManager {
             airConditioning: appliance.airConditioning,
             heatingRod: appliance.heatingRod,
             smartPlug: appliance.smartPlug,
-            // Conditionally spread the two optional top-level fields that are NOT
+            // Conditionally spread the optional top-level fields that are NOT
             // covered by MERGEABLE_METADATA_KEYS. If they were always materialized
             // as explicit keys, an omitted (undefined) value would clobber the
             // stored value during mergeApplianceData's `{...existing, ...update}`
@@ -213,6 +213,7 @@ export class ApplianceManager {
             // while dropping omitted fields so the existing value is preserved.
             ...(appliance.cloudPackageId !== undefined && { cloudPackageId: appliance.cloudPackageId }),
             ...(appliance.availableFeatures !== undefined && { availableFeatures: appliance.availableFeatures }),
+            ...(appliance.compatibilityModes !== undefined && { compatibilityModes: appliance.compatibilityModes }),
         };
         let applianceData = newApplianceData;
         if (existingApplianceId) {

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

@@ -51,7 +51,8 @@ export class InMemoryApplianceManager extends ApplianceManager {
         };
         // Build the incoming appliance data covering every ApplianceConfig field.
         // The two optional top-level fields that are NOT shallow-merged by
-        // mergeApplianceData (`cloudPackageId`, `availableFeatures`) are only
+        // mergeApplianceData (`cloudPackageId`, `availableFeatures`,
+        // `compatibilityModes`) are only
         // materialized when provided so an omitted value cannot clobber the stored
         // one during an update; pass an explicit value (e.g. `[]`) to clear them.
         const newApplianceData = {
@@ -70,6 +71,7 @@ export class InMemoryApplianceManager extends ApplianceManager {
             heatingRod: appliance.heatingRod,
             ...(appliance.cloudPackageId !== undefined && { cloudPackageId: appliance.cloudPackageId }),
             ...(appliance.availableFeatures !== undefined && { availableFeatures: appliance.availableFeatures }),
+            ...(appliance.compatibilityModes !== undefined && { compatibilityModes: appliance.compatibilityModes }),
         };
         // On update, merge onto the stored appliance so type-specific metadata and
         // top-level fields that were not supplied in this call are preserved.

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

@@ -277,6 +277,14 @@ export interface EnyoAppliance {
     smartPlug?: EnyoSmartPlugApplianceMetadata;
     /** Optional custom name for the appliance, defined by the user */
     customName?: string;
+    /**
+     * Optional list of vendor- or integration-specific compatibility modes that
+     * are active for this appliance. Each entry is a free-form, non-localized
+     * identifier describing a behavioural deviation the appliance requires
+     * (e.g. a firmware quirk workaround or a legacy protocol dialect).
+     * Consumers that do not know a given mode should ignore it.
+     */
+    compatibilityModes?: string[];
     /**
      * Optional identifier of the cloud-deployed energy app package that manages
      * this appliance. Set when the appliance is provisioned and operated by a

package/dist/version.d.ts

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