@enyo-energy/energy-app-sdk 0.0.66 → 0.0.67

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -591,14 +591,24 @@ export interface EnyoDataBusPreviewChargingScheduleResponseV1 extends EnyoDataBu
591
591
  requestId: string;
592
592
  /** Whether a preview charging schedule is available */
593
593
  available: boolean;
594
- /** The preview charging schedule (only present if available=true) */
595
- schedule?: PreviewChargingSchedule;
596
- /** Cost comparison data (only present if requested and available) */
597
- costComparison?: PreviewChargingScheduleCostComparison;
594
+ /** Preview charging schedule and cost comparison per charging mode. Each entry's costComparison compares against immediate charging. Only present if available=true. */
595
+ chargingModeResults?: PreviewChargingScheduleModeResult[];
598
596
  /** Reason why preview is not available (only present if available=false) */
599
597
  unavailableReason?: PreviewChargingScheduleUnavailableReasonEnum;
600
598
  };
601
599
  }
600
+ /**
601
+ * Result for a single charging mode in a preview charging schedule response.
602
+ * Contains the schedule and optional cost comparison for one specific charging mode.
603
+ */
604
+ export interface PreviewChargingScheduleModeResult {
605
+ /** The charging mode this result represents */
606
+ chargeMode: EnyoChargeModeEnum;
607
+ /** The preview charging schedule for this mode */
608
+ schedule: PreviewChargingSchedule;
609
+ /** Cost comparison of this mode vs immediate charging (only present if cost data is available) */
610
+ costComparison?: PreviewChargingScheduleCostComparison;
611
+ }
602
612
  /**
603
613
  * Message for delivering PV production forecast data.
604
614
  * Contains forecasted power and energy values in 15-minute intervals.
@@ -16,6 +16,18 @@ export interface EnyoPackageConfigurationSettingSelectOption {
16
16
  /** The displayed name of the option */
17
17
  optionName: EnyoPackageConfigurationTranslatedValue[];
18
18
  }
19
+ export interface EnyoPackageConfigurationSettingFloatOptions {
20
+ maxValue?: number;
21
+ minValue?: number;
22
+ step?: number;
23
+ }
24
+ export interface EnyoPackageConfigurationSettingIntegerOptions {
25
+ maxValue?: number;
26
+ minValue?: number;
27
+ }
28
+ export interface EnyoPackageConfigurationSettingTextOptions {
29
+ maxLength?: number;
30
+ }
19
31
  /**
20
32
  * Represents a single configuration setting for an Energy App package.
21
33
  */
@@ -23,7 +35,7 @@ export interface EnyoPackageConfigurationSetting {
23
35
  /** internal name of the setting - must be unique */
24
36
  name: string;
25
37
  /** the type of the setting */
26
- type: 'text' | 'select';
38
+ type: 'text' | 'select' | 'float' | 'integer' | 'checkbox';
27
39
  /** if the setting is required */
28
40
  required: boolean;
29
41
  /** The displayed name of the field */
@@ -35,11 +47,9 @@ export interface EnyoPackageConfigurationSetting {
35
47
  /** Optional appliance ID. If provided, setting is for specific appliance. If omitted, setting is for the whole package */
36
48
  applianceId?: string;
37
49
  selectOptions?: EnyoPackageConfigurationSettingSelectOption[];
38
- }
39
- /**
40
- * Configuration container for Energy App package settings.
41
- */
42
- export interface EnyoPackageConfiguration {
50
+ floatOptions?: EnyoPackageConfigurationSettingFloatOptions;
51
+ integerOptions?: EnyoPackageConfigurationSettingIntegerOptions;
52
+ textOptions?: EnyoPackageConfigurationSettingTextOptions;
43
53
  }
44
54
  /**
45
55
  * Represents a change event when a setting value is modified.
@@ -9,7 +9,7 @@ exports.getSdkVersion = getSdkVersion;
9
9
  /**
10
10
  * Current version of the enyo Energy App SDK.
11
11
  */
12
- exports.SDK_VERSION = '0.0.66';
12
+ exports.SDK_VERSION = '0.0.67';
13
13
  /**
14
14
  * Gets the current SDK version.
15
15
  * @returns The semantic version string of the SDK
@@ -5,7 +5,7 @@
5
5
  /**
6
6
  * Current version of the enyo Energy App SDK.
7
7
  */
8
- export declare const SDK_VERSION = "0.0.66";
8
+ export declare const SDK_VERSION = "0.0.67";
9
9
  /**
10
10
  * Gets the current SDK version.
11
11
  * @returns The semantic version string of the SDK
@@ -591,14 +591,24 @@ export interface EnyoDataBusPreviewChargingScheduleResponseV1 extends EnyoDataBu
591
591
  requestId: string;
592
592
  /** Whether a preview charging schedule is available */
593
593
  available: boolean;
594
- /** The preview charging schedule (only present if available=true) */
595
- schedule?: PreviewChargingSchedule;
596
- /** Cost comparison data (only present if requested and available) */
597
- costComparison?: PreviewChargingScheduleCostComparison;
594
+ /** Preview charging schedule and cost comparison per charging mode. Each entry's costComparison compares against immediate charging. Only present if available=true. */
595
+ chargingModeResults?: PreviewChargingScheduleModeResult[];
598
596
  /** Reason why preview is not available (only present if available=false) */
599
597
  unavailableReason?: PreviewChargingScheduleUnavailableReasonEnum;
600
598
  };
601
599
  }
600
+ /**
601
+ * Result for a single charging mode in a preview charging schedule response.
602
+ * Contains the schedule and optional cost comparison for one specific charging mode.
603
+ */
604
+ export interface PreviewChargingScheduleModeResult {
605
+ /** The charging mode this result represents */
606
+ chargeMode: EnyoChargeModeEnum;
607
+ /** The preview charging schedule for this mode */
608
+ schedule: PreviewChargingSchedule;
609
+ /** Cost comparison of this mode vs immediate charging (only present if cost data is available) */
610
+ costComparison?: PreviewChargingScheduleCostComparison;
611
+ }
602
612
  /**
603
613
  * Message for delivering PV production forecast data.
604
614
  * Contains forecasted power and energy values in 15-minute intervals.
@@ -16,6 +16,18 @@ export interface EnyoPackageConfigurationSettingSelectOption {
16
16
  /** The displayed name of the option */
17
17
  optionName: EnyoPackageConfigurationTranslatedValue[];
18
18
  }
19
+ export interface EnyoPackageConfigurationSettingFloatOptions {
20
+ maxValue?: number;
21
+ minValue?: number;
22
+ step?: number;
23
+ }
24
+ export interface EnyoPackageConfigurationSettingIntegerOptions {
25
+ maxValue?: number;
26
+ minValue?: number;
27
+ }
28
+ export interface EnyoPackageConfigurationSettingTextOptions {
29
+ maxLength?: number;
30
+ }
19
31
  /**
20
32
  * Represents a single configuration setting for an Energy App package.
21
33
  */
@@ -23,7 +35,7 @@ export interface EnyoPackageConfigurationSetting {
23
35
  /** internal name of the setting - must be unique */
24
36
  name: string;
25
37
  /** the type of the setting */
26
- type: 'text' | 'select';
38
+ type: 'text' | 'select' | 'float' | 'integer' | 'checkbox';
27
39
  /** if the setting is required */
28
40
  required: boolean;
29
41
  /** The displayed name of the field */
@@ -35,11 +47,9 @@ export interface EnyoPackageConfigurationSetting {
35
47
  /** Optional appliance ID. If provided, setting is for specific appliance. If omitted, setting is for the whole package */
36
48
  applianceId?: string;
37
49
  selectOptions?: EnyoPackageConfigurationSettingSelectOption[];
38
- }
39
- /**
40
- * Configuration container for Energy App package settings.
41
- */
42
- export interface EnyoPackageConfiguration {
50
+ floatOptions?: EnyoPackageConfigurationSettingFloatOptions;
51
+ integerOptions?: EnyoPackageConfigurationSettingIntegerOptions;
52
+ textOptions?: EnyoPackageConfigurationSettingTextOptions;
43
53
  }
44
54
  /**
45
55
  * Represents a change event when a setting value is modified.
package/dist/version.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
  /**
6
6
  * Current version of the enyo Energy App SDK.
7
7
  */
8
- export declare const SDK_VERSION = "0.0.66";
8
+ export declare const SDK_VERSION = "0.0.67";
9
9
  /**
10
10
  * Gets the current SDK version.
11
11
  * @returns The semantic version string of the SDK
package/dist/version.js CHANGED
@@ -5,7 +5,7 @@
5
5
  /**
6
6
  * Current version of the enyo Energy App SDK.
7
7
  */
8
- export const SDK_VERSION = '0.0.66';
8
+ export const SDK_VERSION = '0.0.67';
9
9
  /**
10
10
  * Gets the current SDK version.
11
11
  * @returns The semantic version string of the SDK
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@enyo-energy/energy-app-sdk",
3
- "version": "0.0.66",
3
+ "version": "0.0.67",
4
4
  "description": "enyo Energy App SDK",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",