@enyo-energy/energy-app-sdk 0.0.99 → 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 +24 -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 +24 -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.
@@ -73,7 +90,7 @@ export interface EnyoPackageConfigurationSetting {
73
90
  /** internal name of the setting - must be unique */
74
91
  name: string;
75
92
  /** the type of the setting */
76
- type: 'text' | 'select' | 'float' | 'integer' | 'checkbox' | 'time';
93
+ type: 'text' | 'select' | 'float' | 'integer' | 'checkbox' | 'time' | 'priority';
77
94
  /** if the setting is required */
78
95
  required: boolean;
79
96
  /** The displayed name of the field */
@@ -92,6 +109,8 @@ export interface EnyoPackageConfigurationSetting {
92
109
  textOptions?: EnyoPackageConfigurationSettingTextOptions;
93
110
  /** Optional configuration for time-type settings. Values are in "HH:mm" format. */
94
111
  timeOptions?: EnyoPackageConfigurationSettingTimeOptions;
112
+ /** Optional configuration for priority-type settings, defining the available priority options with order indices */
113
+ priorityOptions?: EnyoPackageConfigurationSettingPriorityOption[];
95
114
  }
96
115
  /**
97
116
  * Represents a change event when a setting value is modified.
@@ -131,8 +150,8 @@ export interface EnyoSettingConfigWithValue extends EnyoSettingConfigWithId {
131
150
  export interface EnyoPackageConfigurationSettingGroup {
132
151
  /** Internal name of the group - must be unique */
133
152
  groupName: string;
134
- /** Translated caption displayed as the group heading */
135
- caption: EnyoPackageConfigurationTranslatedValue[];
153
+ /** Optional translated caption displayed as the group heading */
154
+ caption?: EnyoPackageConfigurationTranslatedValue[];
136
155
  /** The settings belonging to this group (1 or more) */
137
156
  settings: EnyoPackageConfigurationSetting[];
138
157
  }
@@ -143,8 +162,8 @@ export interface EnyoPackageConfigurationSettingGroup {
143
162
  export interface EnyoSettingGroupWithValues {
144
163
  /** Internal name of the group */
145
164
  groupName: string;
146
- /** Translated caption displayed as the group heading */
147
- caption: EnyoPackageConfigurationTranslatedValue[];
165
+ /** Optional translated caption displayed as the group heading */
166
+ caption?: EnyoPackageConfigurationTranslatedValue[];
148
167
  /** The settings belonging to this group, including IDs and current values */
149
168
  settings: EnyoSettingConfigWithValue[];
150
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.99';
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.99";
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.
@@ -73,7 +90,7 @@ export interface EnyoPackageConfigurationSetting {
73
90
  /** internal name of the setting - must be unique */
74
91
  name: string;
75
92
  /** the type of the setting */
76
- type: 'text' | 'select' | 'float' | 'integer' | 'checkbox' | 'time';
93
+ type: 'text' | 'select' | 'float' | 'integer' | 'checkbox' | 'time' | 'priority';
77
94
  /** if the setting is required */
78
95
  required: boolean;
79
96
  /** The displayed name of the field */
@@ -92,6 +109,8 @@ export interface EnyoPackageConfigurationSetting {
92
109
  textOptions?: EnyoPackageConfigurationSettingTextOptions;
93
110
  /** Optional configuration for time-type settings. Values are in "HH:mm" format. */
94
111
  timeOptions?: EnyoPackageConfigurationSettingTimeOptions;
112
+ /** Optional configuration for priority-type settings, defining the available priority options with order indices */
113
+ priorityOptions?: EnyoPackageConfigurationSettingPriorityOption[];
95
114
  }
96
115
  /**
97
116
  * Represents a change event when a setting value is modified.
@@ -131,8 +150,8 @@ export interface EnyoSettingConfigWithValue extends EnyoSettingConfigWithId {
131
150
  export interface EnyoPackageConfigurationSettingGroup {
132
151
  /** Internal name of the group - must be unique */
133
152
  groupName: string;
134
- /** Translated caption displayed as the group heading */
135
- caption: EnyoPackageConfigurationTranslatedValue[];
153
+ /** Optional translated caption displayed as the group heading */
154
+ caption?: EnyoPackageConfigurationTranslatedValue[];
136
155
  /** The settings belonging to this group (1 or more) */
137
156
  settings: EnyoPackageConfigurationSetting[];
138
157
  }
@@ -143,8 +162,8 @@ export interface EnyoPackageConfigurationSettingGroup {
143
162
  export interface EnyoSettingGroupWithValues {
144
163
  /** Internal name of the group */
145
164
  groupName: string;
146
- /** Translated caption displayed as the group heading */
147
- caption: EnyoPackageConfigurationTranslatedValue[];
165
+ /** Optional translated caption displayed as the group heading */
166
+ caption?: EnyoPackageConfigurationTranslatedValue[];
148
167
  /** The settings belonging to this group, including IDs and current values */
149
168
  settings: EnyoSettingConfigWithValue[];
150
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.99";
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.99';
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.99",
3
+ "version": "0.0.100",
4
4
  "description": "enyo Energy App SDK",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",