@enyo-energy/energy-app-sdk 0.0.98 → 0.0.100

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.
Files changed (9) hide show
  1. package/dist/cjs/types/enyo-diagnostics.d.cts +2 -0
  2. package/dist/cjs/types/enyo-settings.d.cts +41 -5
  3. package/dist/cjs/version.cjs +1 -1
  4. package/dist/cjs/version.d.cts +1 -1
  5. package/dist/types/enyo-diagnostics.d.ts +2 -0
  6. package/dist/types/enyo-settings.d.ts +41 -5
  7. package/dist/version.d.ts +1 -1
  8. package/dist/version.js +1 -1
  9. package/package.json +1 -1
package/dist/cjs/types/enyo-diagnostics.d.cts CHANGED
@@ -216,4 +216,6 @@ export interface EnyoDiagnosticsControlPlan {
216
216
  totalGridImportKwh: number;
217
217
  /** Total estimated grid export in kWh. */
218
218
  totalGridExportKwh: number;
219
+ /** Total estimated savings in EUR. */
220
+ totalEstimatedSavingsEur?: number;
219
221
  }
package/dist/cjs/types/enyo-settings.d.cts CHANGED
@@ -15,6 +15,23 @@ export interface EnyoPackageConfigurationSettingSelectOption {
15
15
  value: string;
16
16
  /** The displayed name of the option */
17
17
  optionName: EnyoPackageConfigurationTranslatedValue[];
18
+ /** Optional description providing additional context for this option */
19
+ optionDescription?: EnyoPackageConfigurationTranslatedValue[];
20
+ }
21
+ /**
22
+ * Represents an option in a priority-type setting field.
23
+ * Priority options are similar to select options but include an order index
24
+ * to define the relative priority of each option.
25
+ */
26
+ export interface EnyoPackageConfigurationSettingPriorityOption {
27
+ /** The underlying value of this priority option */
28
+ value: string;
29
+ /** Translated caption displayed for this option */
30
+ caption: EnyoPackageConfigurationTranslatedValue[];
31
+ /** Optional translated description providing additional context for this option */
32
+ description?: EnyoPackageConfigurationTranslatedValue[];
33
+ /** The order/priority index of this option */
34
+ orderIndex: number;
18
35
  }
19
36
  /**
20
37
  * Display option for select-type settings.
@@ -27,6 +44,21 @@ export type EnyoSelectDisplayOption = 'dropdown' | 'radioButtons';
27
44
  * - `stepper`: renders as a stepper control with +/- buttons
28
45
  */
29
46
  export type EnyoFloatDisplayOption = 'stepper';
47
+ /**
48
+ * Step option for time-type settings, defining the interval between selectable time values.
49
+ * - `'15min'`: 15-minute intervals (e.g., 00:00, 00:15, 00:30, ...)
50
+ * - `'30min'`: 30-minute intervals (e.g., 00:00, 00:30, 01:00, ...)
51
+ * - `'1hour'`: 1-hour intervals (e.g., 00:00, 01:00, 02:00, ...)
52
+ */
53
+ export type EnyoTimeStepOption = '15min' | '30min' | '1hour';
54
+ /**
55
+ * Configuration options for time-type settings.
56
+ * Time values are represented in "HH:mm" format (e.g., "08:00", "14:30").
57
+ */
58
+ export interface EnyoPackageConfigurationSettingTimeOptions {
59
+ /** The step interval between selectable time values */
60
+ stepOption: EnyoTimeStepOption;
61
+ }
30
62
  /**
31
63
  * Configuration options for float-type settings.
32
64
  */
@@ -58,7 +90,7 @@ export interface EnyoPackageConfigurationSetting {
58
90
  /** internal name of the setting - must be unique */
59
91
  name: string;
60
92
  /** the type of the setting */
61
- type: 'text' | 'select' | 'float' | 'integer' | 'checkbox';
93
+ type: 'text' | 'select' | 'float' | 'integer' | 'checkbox' | 'time' | 'priority';
62
94
  /** if the setting is required */
63
95
  required: boolean;
64
96
  /** The displayed name of the field */
@@ -75,6 +107,10 @@ export interface EnyoPackageConfigurationSetting {
75
107
  floatOptions?: EnyoPackageConfigurationSettingFloatOptions;
76
108
  integerOptions?: EnyoPackageConfigurationSettingIntegerOptions;
77
109
  textOptions?: EnyoPackageConfigurationSettingTextOptions;
110
+ /** Optional configuration for time-type settings. Values are in "HH:mm" format. */
111
+ timeOptions?: EnyoPackageConfigurationSettingTimeOptions;
112
+ /** Optional configuration for priority-type settings, defining the available priority options with order indices */
113
+ priorityOptions?: EnyoPackageConfigurationSettingPriorityOption[];
78
114
  }
79
115
  /**
80
116
  * Represents a change event when a setting value is modified.
@@ -114,8 +150,8 @@ export interface EnyoSettingConfigWithValue extends EnyoSettingConfigWithId {
114
150
  export interface EnyoPackageConfigurationSettingGroup {
115
151
  /** Internal name of the group - must be unique */
116
152
  groupName: string;
117
- /** Translated caption displayed as the group heading */
118
- caption: EnyoPackageConfigurationTranslatedValue[];
153
+ /** Optional translated caption displayed as the group heading */
154
+ caption?: EnyoPackageConfigurationTranslatedValue[];
119
155
  /** The settings belonging to this group (1 or more) */
120
156
  settings: EnyoPackageConfigurationSetting[];
121
157
  }
@@ -126,8 +162,8 @@ export interface EnyoPackageConfigurationSettingGroup {
126
162
  export interface EnyoSettingGroupWithValues {
127
163
  /** Internal name of the group */
128
164
  groupName: string;
129
- /** Translated caption displayed as the group heading */
130
- caption: EnyoPackageConfigurationTranslatedValue[];
165
+ /** Optional translated caption displayed as the group heading */
166
+ caption?: EnyoPackageConfigurationTranslatedValue[];
131
167
  /** The settings belonging to this group, including IDs and current values */
132
168
  settings: EnyoSettingConfigWithValue[];
133
169
  }
package/dist/cjs/version.cjs CHANGED
@@ -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.98';
12
+ exports.SDK_VERSION = '0.0.100';
13
13
  /**
14
14
  * Gets the current SDK version.
15
15
  * @returns The semantic version string of the SDK
package/dist/cjs/version.d.cts 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.98";
8
+ export declare const SDK_VERSION = "0.0.100";
9
9
  /**
10
10
  * Gets the current SDK version.
11
11
  * @returns The semantic version string of the SDK
package/dist/types/enyo-diagnostics.d.ts CHANGED
@@ -216,4 +216,6 @@ export interface EnyoDiagnosticsControlPlan {
216
216
  totalGridImportKwh: number;
217
217
  /** Total estimated grid export in kWh. */
218
218
  totalGridExportKwh: number;
219
+ /** Total estimated savings in EUR. */
220
+ totalEstimatedSavingsEur?: number;
219
221
  }
package/dist/types/enyo-settings.d.ts CHANGED
@@ -15,6 +15,23 @@ export interface EnyoPackageConfigurationSettingSelectOption {
15
15
  value: string;
16
16
  /** The displayed name of the option */
17
17
  optionName: EnyoPackageConfigurationTranslatedValue[];
18
+ /** Optional description providing additional context for this option */
19
+ optionDescription?: EnyoPackageConfigurationTranslatedValue[];
20
+ }
21
+ /**
22
+ * Represents an option in a priority-type setting field.
23
+ * Priority options are similar to select options but include an order index
24
+ * to define the relative priority of each option.
25
+ */
26
+ export interface EnyoPackageConfigurationSettingPriorityOption {
27
+ /** The underlying value of this priority option */
28
+ value: string;
29
+ /** Translated caption displayed for this option */
30
+ caption: EnyoPackageConfigurationTranslatedValue[];
31
+ /** Optional translated description providing additional context for this option */
32
+ description?: EnyoPackageConfigurationTranslatedValue[];
33
+ /** The order/priority index of this option */
34
+ orderIndex: number;
18
35
  }
19
36
  /**
20
37
  * Display option for select-type settings.
@@ -27,6 +44,21 @@ export type EnyoSelectDisplayOption = 'dropdown' | 'radioButtons';
27
44
  * - `stepper`: renders as a stepper control with +/- buttons
28
45
  */
29
46
  export type EnyoFloatDisplayOption = 'stepper';
47
+ /**
48
+ * Step option for time-type settings, defining the interval between selectable time values.
49
+ * - `'15min'`: 15-minute intervals (e.g., 00:00, 00:15, 00:30, ...)
50
+ * - `'30min'`: 30-minute intervals (e.g., 00:00, 00:30, 01:00, ...)
51
+ * - `'1hour'`: 1-hour intervals (e.g., 00:00, 01:00, 02:00, ...)
52
+ */
53
+ export type EnyoTimeStepOption = '15min' | '30min' | '1hour';
54
+ /**
55
+ * Configuration options for time-type settings.
56
+ * Time values are represented in "HH:mm" format (e.g., "08:00", "14:30").
57
+ */
58
+ export interface EnyoPackageConfigurationSettingTimeOptions {
59
+ /** The step interval between selectable time values */
60
+ stepOption: EnyoTimeStepOption;
61
+ }
30
62
  /**
31
63
  * Configuration options for float-type settings.
32
64
  */
@@ -58,7 +90,7 @@ export interface EnyoPackageConfigurationSetting {
58
90
  /** internal name of the setting - must be unique */
59
91
  name: string;
60
92
  /** the type of the setting */
61
- type: 'text' | 'select' | 'float' | 'integer' | 'checkbox';
93
+ type: 'text' | 'select' | 'float' | 'integer' | 'checkbox' | 'time' | 'priority';
62
94
  /** if the setting is required */
63
95
  required: boolean;
64
96
  /** The displayed name of the field */
@@ -75,6 +107,10 @@ export interface EnyoPackageConfigurationSetting {
75
107
  floatOptions?: EnyoPackageConfigurationSettingFloatOptions;
76
108
  integerOptions?: EnyoPackageConfigurationSettingIntegerOptions;
77
109
  textOptions?: EnyoPackageConfigurationSettingTextOptions;
110
+ /** Optional configuration for time-type settings. Values are in "HH:mm" format. */
111
+ timeOptions?: EnyoPackageConfigurationSettingTimeOptions;
112
+ /** Optional configuration for priority-type settings, defining the available priority options with order indices */
113
+ priorityOptions?: EnyoPackageConfigurationSettingPriorityOption[];
78
114
  }
79
115
  /**
80
116
  * Represents a change event when a setting value is modified.
@@ -114,8 +150,8 @@ export interface EnyoSettingConfigWithValue extends EnyoSettingConfigWithId {
114
150
  export interface EnyoPackageConfigurationSettingGroup {
115
151
  /** Internal name of the group - must be unique */
116
152
  groupName: string;
117
- /** Translated caption displayed as the group heading */
118
- caption: EnyoPackageConfigurationTranslatedValue[];
153
+ /** Optional translated caption displayed as the group heading */
154
+ caption?: EnyoPackageConfigurationTranslatedValue[];
119
155
  /** The settings belonging to this group (1 or more) */
120
156
  settings: EnyoPackageConfigurationSetting[];
121
157
  }
@@ -126,8 +162,8 @@ export interface EnyoPackageConfigurationSettingGroup {
126
162
  export interface EnyoSettingGroupWithValues {
127
163
  /** Internal name of the group */
128
164
  groupName: string;
129
- /** Translated caption displayed as the group heading */
130
- caption: EnyoPackageConfigurationTranslatedValue[];
165
+ /** Optional translated caption displayed as the group heading */
166
+ caption?: EnyoPackageConfigurationTranslatedValue[];
131
167
  /** The settings belonging to this group, including IDs and current values */
132
168
  settings: EnyoSettingConfigWithValue[];
133
169
  }
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.98";
8
+ export declare const SDK_VERSION = "0.0.100";
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.98';
8
+ export const SDK_VERSION = '0.0.100';
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.98",
3
+ "version": "0.0.100",
4
4
  "description": "enyo Energy App SDK",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",