@enyo-energy/energy-app-sdk 0.0.97 → 0.0.99

package/dist/cjs/index.cjs

@@ -24,6 +24,7 @@ __exportStar(require("./implementations/ocpp/ocpp201.cjs"), exports);
 __exportStar(require("./implementations/ocpp/ocpp-common.cjs"), exports);
 __exportStar(require("./types/enyo-authentication.cjs"), exports);
 __exportStar(require("./types/enyo-settings.cjs"), exports);
+__exportStar(require("./packages/energy-app-settings.cjs"), exports);
 __exportStar(require("./types/enyo-energy-prices.cjs"), exports);
 __exportStar(require("./types/enyo-notification.cjs"), exports);
 __exportStar(require("./types/enyo-secret-manager.cjs"), exports);

package/dist/cjs/index.d.cts

@@ -37,6 +37,7 @@ export * from './implementations/ocpp/ocpp201.cjs';
 export * from './implementations/ocpp/ocpp-common.cjs';
 export * from './types/enyo-authentication.cjs';
 export * from './types/enyo-settings.cjs';
+export * from './packages/energy-app-settings.cjs';
 export * from './types/enyo-energy-prices.cjs';
 export * from './types/enyo-notification.cjs';
 export * from './types/enyo-secret-manager.cjs';

package/dist/cjs/packages/energy-app-settings.d.cts

@@ -1,4 +1,4 @@
-import { EnyoPackageConfigurationSetting, EnyoSettingsChangeListener, EnyoSettingConfigWithValue } from "../types/enyo-settings.cjs";
+import { EnyoPackageConfigurationSetting, EnyoPackageConfigurationSettingGroup, EnyoSettingsChangeListener, EnyoSettingConfigWithValue, EnyoSettingGroupWithValues } from "../types/enyo-settings.cjs";
 /**
  * Interface for managing Energy App settings configuration for appliances or the entire package.
  * Provides methods to add, remove, and modify settings, as well as listen for changes.
@@ -44,4 +44,27 @@ export interface EnergyAppSettings {
      * @returns Promise that resolves to an array of all settings with their IDs and current values
      */
     getSettingsConfig(): Promise<EnyoSettingConfigWithValue[]>;
+    /**
+     * Adds a group of related settings to the Energy App.
+     * The group organizes multiple settings under a common heading with a translated caption.
+     * Each group must have a unique groupName. Settings within the group follow the same rules
+     * as individual settings (unique names, optional appliance scoping).
+     *
+     * @param group - The setting group configuration including group name, caption, and 1-n settings
+     * @returns Promise that resolves when the setting group is successfully added
+     */
+    addSettingGroup(group: EnyoPackageConfigurationSettingGroup): Promise<void>;
+    /**
+     * Removes a setting group and all its contained settings from the Energy App.
+     *
+     * @param groupName - The unique name of the group to remove
+     * @returns Promise that resolves when the group is successfully removed
+     */
+    removeSettingGroup(groupName: string): Promise<void>;
+    /**
+     * Retrieves all currently configured setting groups with their settings' unique identifiers and current values.
+     *
+     * @returns Promise that resolves to an array of all setting groups with their settings including IDs and current values
+     */
+    getSettingGroups(): Promise<EnyoSettingGroupWithValues[]>;
 }

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

@@ -16,14 +16,52 @@ export interface EnyoPackageConfigurationSettingSelectOption {
     /** The displayed name of the option */
     optionName: EnyoPackageConfigurationTranslatedValue[];
 }
+/**
+ * Display option for select-type settings.
+ * - `dropdown`: renders as a dropdown/select element
+ * - `radioButtons`: renders as radio button group
+ */
+export type EnyoSelectDisplayOption = 'dropdown' | 'radioButtons';
+/**
+ * Display option for float-type settings.
+ * - `stepper`: renders as a stepper control with +/- buttons
+ */
+export type EnyoFloatDisplayOption = 'stepper';
+/**
+ * Step option for time-type settings, defining the interval between selectable time values.
+ * - `'15min'`: 15-minute intervals (e.g., 00:00, 00:15, 00:30, ...)
+ * - `'30min'`: 30-minute intervals (e.g., 00:00, 00:30, 01:00, ...)
+ * - `'1hour'`: 1-hour intervals (e.g., 00:00, 01:00, 02:00, ...)
+ */
+export type EnyoTimeStepOption = '15min' | '30min' | '1hour';
+/**
+ * Configuration options for time-type settings.
+ * Time values are represented in "HH:mm" format (e.g., "08:00", "14:30").
+ */
+export interface EnyoPackageConfigurationSettingTimeOptions {
+    /** The step interval between selectable time values */
+    stepOption: EnyoTimeStepOption;
+}
+/**
+ * Configuration options for float-type settings.
+ */
 export interface EnyoPackageConfigurationSettingFloatOptions {
     maxValue?: number;
     minValue?: number;
     step?: number;
+    /** Optional display option for the float input. Use 'stepper' to render a +/- button control. */
+    displayOption?: EnyoFloatDisplayOption;
+    /** Optional unit suffix displayed next to the value (e.g., "ct/kWh") */
+    suffix?: string;
 }
+/**
+ * Configuration options for integer-type settings.
+ */
 export interface EnyoPackageConfigurationSettingIntegerOptions {
     maxValue?: number;
     minValue?: number;
+    /** Optional unit suffix displayed next to the value (e.g., "ct/kWh") */
+    suffix?: string;
 }
 export interface EnyoPackageConfigurationSettingTextOptions {
     maxLength?: number;
@@ -35,7 +73,7 @@ export interface EnyoPackageConfigurationSetting {
     /** internal name of the setting - must be unique */
     name: string;
     /** the type of the setting */
-    type: 'text' | 'select' | 'float' | 'integer' | 'checkbox';
+    type: 'text' | 'select' | 'float' | 'integer' | 'checkbox' | 'time';
     /** if the setting is required */
     required: boolean;
     /** The displayed name of the field */
@@ -47,9 +85,13 @@ export interface EnyoPackageConfigurationSetting {
     /** Optional appliance ID. If provided, setting is for specific appliance. If omitted, setting is for the whole package */
     applianceId?: string;
     selectOptions?: EnyoPackageConfigurationSettingSelectOption[];
+    /** Optional display option for select-type settings. Defaults to 'dropdown' if not specified. */
+    selectDisplayOption?: EnyoSelectDisplayOption;
     floatOptions?: EnyoPackageConfigurationSettingFloatOptions;
     integerOptions?: EnyoPackageConfigurationSettingIntegerOptions;
     textOptions?: EnyoPackageConfigurationSettingTextOptions;
+    /** Optional configuration for time-type settings. Values are in "HH:mm" format. */
+    timeOptions?: EnyoPackageConfigurationSettingTimeOptions;
 }
 /**
  * Represents a change event when a setting value is modified.
@@ -82,3 +124,27 @@ export interface EnyoSettingConfigWithValue extends EnyoSettingConfigWithId {
     /** Current value of the setting (if set) */
     currentValue?: string;
 }
+/**
+ * Represents a group of related settings with a name and translated caption.
+ * Groups allow organizing multiple settings under a common heading in the UI.
+ */
+export interface EnyoPackageConfigurationSettingGroup {
+    /** Internal name of the group - must be unique */
+    groupName: string;
+    /** Translated caption displayed as the group heading */
+    caption: EnyoPackageConfigurationTranslatedValue[];
+    /** The settings belonging to this group (1 or more) */
+    settings: EnyoPackageConfigurationSetting[];
+}
+/**
+ * Represents a setting group with resolved setting values.
+ * Used when retrieving groups including their current persisted values and IDs.
+ */
+export interface EnyoSettingGroupWithValues {
+    /** Internal name of the group */
+    groupName: string;
+    /** Translated caption displayed as the group heading */
+    caption: EnyoPackageConfigurationTranslatedValue[];
+    /** The settings belonging to this group, including IDs and current values */
+    settings: EnyoSettingConfigWithValue[];
+}

package/dist/cjs/version.cjs

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

package/dist/index.d.ts

@@ -37,6 +37,7 @@ export * from './implementations/ocpp/ocpp201.js';
 export * from './implementations/ocpp/ocpp-common.js';
 export * from './types/enyo-authentication.js';
 export * from './types/enyo-settings.js';
+export * from './packages/energy-app-settings.js';
 export * from './types/enyo-energy-prices.js';
 export * from './types/enyo-notification.js';
 export * from './types/enyo-secret-manager.js';

package/dist/index.js

@@ -7,6 +7,7 @@ export * from './implementations/ocpp/ocpp201.js';
 export * from './implementations/ocpp/ocpp-common.js';
 export * from './types/enyo-authentication.js';
 export * from './types/enyo-settings.js';
+export * from './packages/energy-app-settings.js';
 export * from './types/enyo-energy-prices.js';
 export * from './types/enyo-notification.js';
 export * from './types/enyo-secret-manager.js';

package/dist/packages/energy-app-settings.d.ts

@@ -1,4 +1,4 @@
-import { EnyoPackageConfigurationSetting, EnyoSettingsChangeListener, EnyoSettingConfigWithValue } from "../types/enyo-settings.js";
+import { EnyoPackageConfigurationSetting, EnyoPackageConfigurationSettingGroup, EnyoSettingsChangeListener, EnyoSettingConfigWithValue, EnyoSettingGroupWithValues } from "../types/enyo-settings.js";
 /**
  * Interface for managing Energy App settings configuration for appliances or the entire package.
  * Provides methods to add, remove, and modify settings, as well as listen for changes.
@@ -44,4 +44,27 @@ export interface EnergyAppSettings {
      * @returns Promise that resolves to an array of all settings with their IDs and current values
      */
     getSettingsConfig(): Promise<EnyoSettingConfigWithValue[]>;
+    /**
+     * Adds a group of related settings to the Energy App.
+     * The group organizes multiple settings under a common heading with a translated caption.
+     * Each group must have a unique groupName. Settings within the group follow the same rules
+     * as individual settings (unique names, optional appliance scoping).
+     *
+     * @param group - The setting group configuration including group name, caption, and 1-n settings
+     * @returns Promise that resolves when the setting group is successfully added
+     */
+    addSettingGroup(group: EnyoPackageConfigurationSettingGroup): Promise<void>;
+    /**
+     * Removes a setting group and all its contained settings from the Energy App.
+     *
+     * @param groupName - The unique name of the group to remove
+     * @returns Promise that resolves when the group is successfully removed
+     */
+    removeSettingGroup(groupName: string): Promise<void>;
+    /**
+     * Retrieves all currently configured setting groups with their settings' unique identifiers and current values.
+     *
+     * @returns Promise that resolves to an array of all setting groups with their settings including IDs and current values
+     */
+    getSettingGroups(): Promise<EnyoSettingGroupWithValues[]>;
 }

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

@@ -16,14 +16,52 @@ export interface EnyoPackageConfigurationSettingSelectOption {
     /** The displayed name of the option */
     optionName: EnyoPackageConfigurationTranslatedValue[];
 }
+/**
+ * Display option for select-type settings.
+ * - `dropdown`: renders as a dropdown/select element
+ * - `radioButtons`: renders as radio button group
+ */
+export type EnyoSelectDisplayOption = 'dropdown' | 'radioButtons';
+/**
+ * Display option for float-type settings.
+ * - `stepper`: renders as a stepper control with +/- buttons
+ */
+export type EnyoFloatDisplayOption = 'stepper';
+/**
+ * Step option for time-type settings, defining the interval between selectable time values.
+ * - `'15min'`: 15-minute intervals (e.g., 00:00, 00:15, 00:30, ...)
+ * - `'30min'`: 30-minute intervals (e.g., 00:00, 00:30, 01:00, ...)
+ * - `'1hour'`: 1-hour intervals (e.g., 00:00, 01:00, 02:00, ...)
+ */
+export type EnyoTimeStepOption = '15min' | '30min' | '1hour';
+/**
+ * Configuration options for time-type settings.
+ * Time values are represented in "HH:mm" format (e.g., "08:00", "14:30").
+ */
+export interface EnyoPackageConfigurationSettingTimeOptions {
+    /** The step interval between selectable time values */
+    stepOption: EnyoTimeStepOption;
+}
+/**
+ * Configuration options for float-type settings.
+ */
 export interface EnyoPackageConfigurationSettingFloatOptions {
     maxValue?: number;
     minValue?: number;
     step?: number;
+    /** Optional display option for the float input. Use 'stepper' to render a +/- button control. */
+    displayOption?: EnyoFloatDisplayOption;
+    /** Optional unit suffix displayed next to the value (e.g., "ct/kWh") */
+    suffix?: string;
 }
+/**
+ * Configuration options for integer-type settings.
+ */
 export interface EnyoPackageConfigurationSettingIntegerOptions {
     maxValue?: number;
     minValue?: number;
+    /** Optional unit suffix displayed next to the value (e.g., "ct/kWh") */
+    suffix?: string;
 }
 export interface EnyoPackageConfigurationSettingTextOptions {
     maxLength?: number;
@@ -35,7 +73,7 @@ export interface EnyoPackageConfigurationSetting {
     /** internal name of the setting - must be unique */
     name: string;
     /** the type of the setting */
-    type: 'text' | 'select' | 'float' | 'integer' | 'checkbox';
+    type: 'text' | 'select' | 'float' | 'integer' | 'checkbox' | 'time';
     /** if the setting is required */
     required: boolean;
     /** The displayed name of the field */
@@ -47,9 +85,13 @@ export interface EnyoPackageConfigurationSetting {
     /** Optional appliance ID. If provided, setting is for specific appliance. If omitted, setting is for the whole package */
     applianceId?: string;
     selectOptions?: EnyoPackageConfigurationSettingSelectOption[];
+    /** Optional display option for select-type settings. Defaults to 'dropdown' if not specified. */
+    selectDisplayOption?: EnyoSelectDisplayOption;
     floatOptions?: EnyoPackageConfigurationSettingFloatOptions;
     integerOptions?: EnyoPackageConfigurationSettingIntegerOptions;
     textOptions?: EnyoPackageConfigurationSettingTextOptions;
+    /** Optional configuration for time-type settings. Values are in "HH:mm" format. */
+    timeOptions?: EnyoPackageConfigurationSettingTimeOptions;
 }
 /**
  * Represents a change event when a setting value is modified.
@@ -82,3 +124,27 @@ export interface EnyoSettingConfigWithValue extends EnyoSettingConfigWithId {
     /** Current value of the setting (if set) */
     currentValue?: string;
 }
+/**
+ * Represents a group of related settings with a name and translated caption.
+ * Groups allow organizing multiple settings under a common heading in the UI.
+ */
+export interface EnyoPackageConfigurationSettingGroup {
+    /** Internal name of the group - must be unique */
+    groupName: string;
+    /** Translated caption displayed as the group heading */
+    caption: EnyoPackageConfigurationTranslatedValue[];
+    /** The settings belonging to this group (1 or more) */
+    settings: EnyoPackageConfigurationSetting[];
+}
+/**
+ * Represents a setting group with resolved setting values.
+ * Used when retrieving groups including their current persisted values and IDs.
+ */
+export interface EnyoSettingGroupWithValues {
+    /** Internal name of the group */
+    groupName: string;
+    /** Translated caption displayed as the group heading */
+    caption: EnyoPackageConfigurationTranslatedValue[];
+    /** The settings belonging to this group, including IDs and current values */
+    settings: EnyoSettingConfigWithValue[];
+}

package/dist/version.d.ts

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