@enyo-energy/energy-app-sdk 1.7.0 → 1.8.0

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

@@ -261,6 +261,18 @@ export interface EnergyAppPackageCompatibilityVendor {
     vendorName: string;
     /** Models from this vendor that the package supports */
     models: EnergyAppPackageCompatibilityModel[];
+    /**
+     * Marks this package as the default Energy App for the vendor when no
+     * concrete model has been selected.
+     *
+     * During onboarding a user may only know the manufacturer of their device,
+     * not its exact model. When several packages declare compatibility with the
+     * same vendor, the one flagged with `default: true` is the app the enyo
+     * Store and onboarding flows pick in that case. Set it on at most one
+     * package per vendor; omit it (or set `false`) when the package should only
+     * be offered for an explicitly selected model.
+     */
+    defaultEnergyApp?: boolean;
 }
 /**
  * A file published together with an Energy App package and served publicly

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

@@ -24,7 +24,9 @@ var EnyoApplianceStateEnum;
  * which describes connectivity. `Healthy` means the appliance is operating
  * normally; `Warning` means a non-blocking issue has been reported (the
  * appliance is still functional but should be inspected); `Faulted` means it
- * has reported an internal error and may need attention. Vendor- or
+ * has reported an internal error and may need attention; `Deactivated` means
+ * the appliance has been intentionally switched off from energy management and
+ * is neither monitored nor controlled until it is reactivated. Vendor- or
  * protocol-specific details should be conveyed via accompanying error codes.
  */
 var EnyoApplianceStatusEnum;
@@ -35,6 +37,12 @@ var EnyoApplianceStatusEnum;
     EnyoApplianceStatusEnum["Warning"] = "warning";
     /** Appliance has reported an internal fault */
     EnyoApplianceStatusEnum["Faulted"] = "faulted";
+    /**
+     * Appliance has been intentionally deactivated and is excluded from energy
+     * management. It is not controlled and its health is not evaluated until it
+     * is reactivated.
+     */
+    EnyoApplianceStatusEnum["Deactivated"] = "deactivated";
 })(EnyoApplianceStatusEnum || (exports.EnyoApplianceStatusEnum = EnyoApplianceStatusEnum = {}));
 var EnyoApplianceConnectionType;
 (function (EnyoApplianceConnectionType) {

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

@@ -33,7 +33,9 @@ export declare enum EnyoApplianceStateEnum {
  * which describes connectivity. `Healthy` means the appliance is operating
  * normally; `Warning` means a non-blocking issue has been reported (the
  * appliance is still functional but should be inspected); `Faulted` means it
- * has reported an internal error and may need attention. Vendor- or
+ * has reported an internal error and may need attention; `Deactivated` means
+ * the appliance has been intentionally switched off from energy management and
+ * is neither monitored nor controlled until it is reactivated. Vendor- or
  * protocol-specific details should be conveyed via accompanying error codes.
  */
 export declare enum EnyoApplianceStatusEnum {
@@ -42,7 +44,13 @@ export declare enum EnyoApplianceStatusEnum {
     /** Appliance is operating but has reported a non-blocking issue that should be inspected */
     Warning = "warning",
     /** Appliance has reported an internal fault */
-    Faulted = "faulted"
+    Faulted = "faulted",
+    /**
+     * Appliance has been intentionally deactivated and is excluded from energy
+     * management. It is not controlled and its health is not evaluated until it
+     * is reactivated.
+     */
+    Deactivated = "deactivated"
 }
 /**
  * Severity classification for an {@link EnyoApplianceErrorCode}.
@@ -175,7 +183,7 @@ export interface EnyoApplianceMetadata {
     ipAddress?: string;
     /** Connection state */
     state?: EnyoApplianceStateEnum;
-    /** Health status of the appliance (e.g. healthy or faulted) */
+    /** Health status of the appliance (e.g. healthy, faulted or deactivated) */
     status?: EnyoApplianceStatusEnum;
     network?: EnyoApplianceNetworkMetadata;
     modbus?: EnyoApplianceModbusMetadata;

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

@@ -593,7 +593,8 @@ export interface EnyoDataBusApplianceFlexibilityAnnouncementV1 extends EnyoDataB
  * provided together if they change in the same event. `errorCodes` carries
  * vendor- or protocol-specific codes that explain a transition into a
  * `warning` or `faulted` status; each entry's `severity` field indicates
- * which.
+ * which. A transition into `deactivated` is intentional and normally carries
+ * no error codes.
  */
 export interface EnyoDataBusApplianceStateUpdateV1 extends EnyoDataBusMessage {
     type: 'message';

package/dist/cjs/types/enyo-onboarding-v2.d.cts

@@ -20,7 +20,7 @@
  * (`../implementations/onboarding-v2/onboarding-v2-validators.ts`) to fail fast
  * before publishing.
  */
-import type { EnyoOnboardingGuideCategory, EnyoOnboardingTranslatedContent } from './enyo-onboarding.cjs';
+import type { EnyoOnboardingTranslatedContent } from './enyo-onboarding.cjs';
 /**
  * The situation a flow starts from. A vendor/model can have up to one guide per
  * variant; a branch can jump into another variant's flow
@@ -1067,21 +1067,6 @@ export interface EnyoOnboardingV2Guide {
     title: EnyoOnboardingTranslatedContent[];
     /** Which start situation this guide covers. */
     startVariant: EnyoOnboardingV2StartVariant;
-    /**
-     * The lifecycle role this guide plays, which decides where the host offers
-     * it (an "add new device" entry point, the configuration-required prompt).
-     *
-     * Distinct from {@link startVariant}, which describes the *situation the
-     * flow starts from* (device not found, found but unconfigured, …). This says
-     * *why the installer is here at all*: configuring the package for the first
-     * time is a different entry point from adding a second device to a package
-     * that already works, even when both start from `device-not-found`.
-     *
-     * Shared with the v1 model rather than restated as a v2 enum — the category
-     * is a property of a guide's role, not of the authoring model. Defaults to
-     * {@link EnyoOnboardingGuideCategory.InitialSetup} semantics when omitted.
-     */
-    category?: EnyoOnboardingGuideCategory;
     /**
      * Whether the host runs its local network scan before entering this guide.
      *

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

@@ -6,11 +6,9 @@ exports.EnyoOnboardingSectionType = exports.EnyoOnboardingGuideCategory = void 0
  * Used to distinguish guides that perform different roles, e.g. initial
  * configuration of a package vs. adding or reconnecting a single device.
  *
- * Shared by both onboarding models — v2 guides set it through
- * {@link EnyoOnboardingV2Guide.category} — in the same way both reuse
- * {@link EnyoOnboardingTranslatedContent}. Not deprecated with the rest of v1:
- * the category is a property of a guide's role, not of the authoring model it
- * was written in.
+ * @deprecated Superseded by the v2 graph model. Author guides with
+ * {@link EnyoOnboardingV2Guide} via `defineOnboardingGuideV2()`. v1 is retained
+ * for backward compatibility and will be removed in a future major.
  */
 var EnyoOnboardingGuideCategory;
 (function (EnyoOnboardingGuideCategory) {

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

@@ -14,11 +14,9 @@ export interface EnyoOnboardingTranslatedContent {
  * Used to distinguish guides that perform different roles, e.g. initial
  * configuration of a package vs. adding or reconnecting a single device.
  *
- * Shared by both onboarding models — v2 guides set it through
- * {@link EnyoOnboardingV2Guide.category} — in the same way both reuse
- * {@link EnyoOnboardingTranslatedContent}. Not deprecated with the rest of v1:
- * the category is a property of a guide's role, not of the authoring model it
- * was written in.
+ * @deprecated Superseded by the v2 graph model. Author guides with
+ * {@link EnyoOnboardingV2Guide} via `defineOnboardingGuideV2()`. v1 is retained
+ * for backward compatibility and will be removed in a future major.
  */
 export declare enum EnyoOnboardingGuideCategory {
     /** Initial package configuration — shown when EnergyAppStateEnum is 'configuration-required' */

package/dist/cjs/version.cjs

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

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

@@ -261,6 +261,18 @@ export interface EnergyAppPackageCompatibilityVendor {
     vendorName: string;
     /** Models from this vendor that the package supports */
     models: EnergyAppPackageCompatibilityModel[];
+    /**
+     * Marks this package as the default Energy App for the vendor when no
+     * concrete model has been selected.
+     *
+     * During onboarding a user may only know the manufacturer of their device,
+     * not its exact model. When several packages declare compatibility with the
+     * same vendor, the one flagged with `default: true` is the app the enyo
+     * Store and onboarding flows pick in that case. Set it on at most one
+     * package per vendor; omit it (or set `false`) when the package should only
+     * be offered for an explicitly selected model.
+     */
+    defaultEnergyApp?: boolean;
 }
 /**
  * A file published together with an Energy App package and served publicly

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

@@ -33,7 +33,9 @@ export declare enum EnyoApplianceStateEnum {
  * which describes connectivity. `Healthy` means the appliance is operating
  * normally; `Warning` means a non-blocking issue has been reported (the
  * appliance is still functional but should be inspected); `Faulted` means it
- * has reported an internal error and may need attention. Vendor- or
+ * has reported an internal error and may need attention; `Deactivated` means
+ * the appliance has been intentionally switched off from energy management and
+ * is neither monitored nor controlled until it is reactivated. Vendor- or
  * protocol-specific details should be conveyed via accompanying error codes.
  */
 export declare enum EnyoApplianceStatusEnum {
@@ -42,7 +44,13 @@ export declare enum EnyoApplianceStatusEnum {
     /** Appliance is operating but has reported a non-blocking issue that should be inspected */
     Warning = "warning",
     /** Appliance has reported an internal fault */
-    Faulted = "faulted"
+    Faulted = "faulted",
+    /**
+     * Appliance has been intentionally deactivated and is excluded from energy
+     * management. It is not controlled and its health is not evaluated until it
+     * is reactivated.
+     */
+    Deactivated = "deactivated"
 }
 /**
  * Severity classification for an {@link EnyoApplianceErrorCode}.
@@ -175,7 +183,7 @@ export interface EnyoApplianceMetadata {
     ipAddress?: string;
     /** Connection state */
     state?: EnyoApplianceStateEnum;
-    /** Health status of the appliance (e.g. healthy or faulted) */
+    /** Health status of the appliance (e.g. healthy, faulted or deactivated) */
     status?: EnyoApplianceStatusEnum;
     network?: EnyoApplianceNetworkMetadata;
     modbus?: EnyoApplianceModbusMetadata;

package/dist/types/enyo-appliance.js

@@ -21,7 +21,9 @@ export var EnyoApplianceStateEnum;
  * which describes connectivity. `Healthy` means the appliance is operating
  * normally; `Warning` means a non-blocking issue has been reported (the
  * appliance is still functional but should be inspected); `Faulted` means it
- * has reported an internal error and may need attention. Vendor- or
+ * has reported an internal error and may need attention; `Deactivated` means
+ * the appliance has been intentionally switched off from energy management and
+ * is neither monitored nor controlled until it is reactivated. Vendor- or
  * protocol-specific details should be conveyed via accompanying error codes.
  */
 export var EnyoApplianceStatusEnum;
@@ -32,6 +34,12 @@ export var EnyoApplianceStatusEnum;
     EnyoApplianceStatusEnum["Warning"] = "warning";
     /** Appliance has reported an internal fault */
     EnyoApplianceStatusEnum["Faulted"] = "faulted";
+    /**
+     * Appliance has been intentionally deactivated and is excluded from energy
+     * management. It is not controlled and its health is not evaluated until it
+     * is reactivated.
+     */
+    EnyoApplianceStatusEnum["Deactivated"] = "deactivated";
 })(EnyoApplianceStatusEnum || (EnyoApplianceStatusEnum = {}));
 export var EnyoApplianceConnectionType;
 (function (EnyoApplianceConnectionType) {

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

@@ -593,7 +593,8 @@ export interface EnyoDataBusApplianceFlexibilityAnnouncementV1 extends EnyoDataB
  * provided together if they change in the same event. `errorCodes` carries
  * vendor- or protocol-specific codes that explain a transition into a
  * `warning` or `faulted` status; each entry's `severity` field indicates
- * which.
+ * which. A transition into `deactivated` is intentional and normally carries
+ * no error codes.
  */
 export interface EnyoDataBusApplianceStateUpdateV1 extends EnyoDataBusMessage {
     type: 'message';

package/dist/types/enyo-onboarding-v2.d.ts

@@ -20,7 +20,7 @@
  * (`../implementations/onboarding-v2/onboarding-v2-validators.ts`) to fail fast
  * before publishing.
  */
-import type { EnyoOnboardingGuideCategory, EnyoOnboardingTranslatedContent } from './enyo-onboarding.js';
+import type { EnyoOnboardingTranslatedContent } from './enyo-onboarding.js';
 /**
  * The situation a flow starts from. A vendor/model can have up to one guide per
  * variant; a branch can jump into another variant's flow
@@ -1067,21 +1067,6 @@ export interface EnyoOnboardingV2Guide {
     title: EnyoOnboardingTranslatedContent[];
     /** Which start situation this guide covers. */
     startVariant: EnyoOnboardingV2StartVariant;
-    /**
-     * The lifecycle role this guide plays, which decides where the host offers
-     * it (an "add new device" entry point, the configuration-required prompt).
-     *
-     * Distinct from {@link startVariant}, which describes the *situation the
-     * flow starts from* (device not found, found but unconfigured, …). This says
-     * *why the installer is here at all*: configuring the package for the first
-     * time is a different entry point from adding a second device to a package
-     * that already works, even when both start from `device-not-found`.
-     *
-     * Shared with the v1 model rather than restated as a v2 enum — the category
-     * is a property of a guide's role, not of the authoring model. Defaults to
-     * {@link EnyoOnboardingGuideCategory.InitialSetup} semantics when omitted.
-     */
-    category?: EnyoOnboardingGuideCategory;
     /**
      * Whether the host runs its local network scan before entering this guide.
      *

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

@@ -14,11 +14,9 @@ export interface EnyoOnboardingTranslatedContent {
  * Used to distinguish guides that perform different roles, e.g. initial
  * configuration of a package vs. adding or reconnecting a single device.
  *
- * Shared by both onboarding models — v2 guides set it through
- * {@link EnyoOnboardingV2Guide.category} — in the same way both reuse
- * {@link EnyoOnboardingTranslatedContent}. Not deprecated with the rest of v1:
- * the category is a property of a guide's role, not of the authoring model it
- * was written in.
+ * @deprecated Superseded by the v2 graph model. Author guides with
+ * {@link EnyoOnboardingV2Guide} via `defineOnboardingGuideV2()`. v1 is retained
+ * for backward compatibility and will be removed in a future major.
  */
 export declare enum EnyoOnboardingGuideCategory {
     /** Initial package configuration — shown when EnergyAppStateEnum is 'configuration-required' */

package/dist/types/enyo-onboarding.js

@@ -3,11 +3,9 @@
  * Used to distinguish guides that perform different roles, e.g. initial
  * configuration of a package vs. adding or reconnecting a single device.
  *
- * Shared by both onboarding models — v2 guides set it through
- * {@link EnyoOnboardingV2Guide.category} — in the same way both reuse
- * {@link EnyoOnboardingTranslatedContent}. Not deprecated with the rest of v1:
- * the category is a property of a guide's role, not of the authoring model it
- * was written in.
+ * @deprecated Superseded by the v2 graph model. Author guides with
+ * {@link EnyoOnboardingV2Guide} via `defineOnboardingGuideV2()`. v1 is retained
+ * for backward compatibility and will be removed in a future major.
  */
 export var EnyoOnboardingGuideCategory;
 (function (EnyoOnboardingGuideCategory) {

package/dist/version.d.ts

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