@enyo-energy/energy-app-sdk 0.0.94 → 0.0.95
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.
- package/dist/cjs/types/enyo-onboarding.cjs +2 -0
- package/dist/cjs/types/enyo-onboarding.d.cts +25 -1
- package/dist/cjs/version.cjs +1 -1
- package/dist/cjs/version.d.cts +1 -1
- package/dist/types/enyo-onboarding.d.ts +25 -1
- package/dist/types/enyo-onboarding.js +2 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
|
@@ -16,4 +16,6 @@ var EnyoOnboardingSectionType;
|
|
|
16
16
|
EnyoOnboardingSectionType["Credentials"] = "credentials";
|
|
17
17
|
/** A clickable URL section */
|
|
18
18
|
EnyoOnboardingSectionType["Url"] = "url";
|
|
19
|
+
/** A dropdown/select section */
|
|
20
|
+
EnyoOnboardingSectionType["Select"] = "select";
|
|
19
21
|
})(EnyoOnboardingSectionType || (exports.EnyoOnboardingSectionType = EnyoOnboardingSectionType = {}));
|
|
@@ -22,7 +22,9 @@ export declare enum EnyoOnboardingSectionType {
|
|
|
22
22
|
/** A credentials display section */
|
|
23
23
|
Credentials = "credentials",
|
|
24
24
|
/** A clickable URL section */
|
|
25
|
-
Url = "url"
|
|
25
|
+
Url = "url",
|
|
26
|
+
/** A dropdown/select section */
|
|
27
|
+
Select = "select"
|
|
26
28
|
}
|
|
27
29
|
/**
|
|
28
30
|
* Represents a password input configuration within an onboarding section.
|
|
@@ -51,6 +53,26 @@ export interface EnyoOnboardingSectionUrl {
|
|
|
51
53
|
/** The URL value to display and link to */
|
|
52
54
|
url: string;
|
|
53
55
|
}
|
|
56
|
+
/**
|
|
57
|
+
* Represents a single option in a select/dropdown onboarding section.
|
|
58
|
+
*/
|
|
59
|
+
export interface EnyoOnboardingSectionSelectOption {
|
|
60
|
+
/** The internal value of this option */
|
|
61
|
+
value: string;
|
|
62
|
+
/** The displayed name of the option, translated for different languages */
|
|
63
|
+
optionName: EnyoOnboardingTranslatedContent[];
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Represents a select/dropdown configuration within an onboarding section.
|
|
67
|
+
*/
|
|
68
|
+
export interface EnyoOnboardingSectionSelect {
|
|
69
|
+
/** Translated title/label for the select field */
|
|
70
|
+
title: EnyoOnboardingTranslatedContent[];
|
|
71
|
+
/** The field name used when submitting the selected value */
|
|
72
|
+
fieldName: string;
|
|
73
|
+
/** Available options for the dropdown */
|
|
74
|
+
options: EnyoOnboardingSectionSelectOption[];
|
|
75
|
+
}
|
|
54
76
|
/**
|
|
55
77
|
* Represents a content section within an onboarding step.
|
|
56
78
|
* Each section has a heading and content body, both with translations.
|
|
@@ -71,6 +93,8 @@ export interface EnyoOnboardingSection {
|
|
|
71
93
|
credentials?: EnyoOnboardingSectionCredential[];
|
|
72
94
|
/** Optional URL configuration, used when type is 'url' */
|
|
73
95
|
url?: EnyoOnboardingSectionUrl;
|
|
96
|
+
/** Optional select/dropdown configuration, used when type is 'select' */
|
|
97
|
+
select?: EnyoOnboardingSectionSelect;
|
|
74
98
|
}
|
|
75
99
|
/**
|
|
76
100
|
* Represents a single step in the onboarding guide.
|
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.
|
|
12
|
+
exports.SDK_VERSION = '0.0.95';
|
|
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
|
@@ -22,7 +22,9 @@ export declare enum EnyoOnboardingSectionType {
|
|
|
22
22
|
/** A credentials display section */
|
|
23
23
|
Credentials = "credentials",
|
|
24
24
|
/** A clickable URL section */
|
|
25
|
-
Url = "url"
|
|
25
|
+
Url = "url",
|
|
26
|
+
/** A dropdown/select section */
|
|
27
|
+
Select = "select"
|
|
26
28
|
}
|
|
27
29
|
/**
|
|
28
30
|
* Represents a password input configuration within an onboarding section.
|
|
@@ -51,6 +53,26 @@ export interface EnyoOnboardingSectionUrl {
|
|
|
51
53
|
/** The URL value to display and link to */
|
|
52
54
|
url: string;
|
|
53
55
|
}
|
|
56
|
+
/**
|
|
57
|
+
* Represents a single option in a select/dropdown onboarding section.
|
|
58
|
+
*/
|
|
59
|
+
export interface EnyoOnboardingSectionSelectOption {
|
|
60
|
+
/** The internal value of this option */
|
|
61
|
+
value: string;
|
|
62
|
+
/** The displayed name of the option, translated for different languages */
|
|
63
|
+
optionName: EnyoOnboardingTranslatedContent[];
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Represents a select/dropdown configuration within an onboarding section.
|
|
67
|
+
*/
|
|
68
|
+
export interface EnyoOnboardingSectionSelect {
|
|
69
|
+
/** Translated title/label for the select field */
|
|
70
|
+
title: EnyoOnboardingTranslatedContent[];
|
|
71
|
+
/** The field name used when submitting the selected value */
|
|
72
|
+
fieldName: string;
|
|
73
|
+
/** Available options for the dropdown */
|
|
74
|
+
options: EnyoOnboardingSectionSelectOption[];
|
|
75
|
+
}
|
|
54
76
|
/**
|
|
55
77
|
* Represents a content section within an onboarding step.
|
|
56
78
|
* Each section has a heading and content body, both with translations.
|
|
@@ -71,6 +93,8 @@ export interface EnyoOnboardingSection {
|
|
|
71
93
|
credentials?: EnyoOnboardingSectionCredential[];
|
|
72
94
|
/** Optional URL configuration, used when type is 'url' */
|
|
73
95
|
url?: EnyoOnboardingSectionUrl;
|
|
96
|
+
/** Optional select/dropdown configuration, used when type is 'select' */
|
|
97
|
+
select?: EnyoOnboardingSectionSelect;
|
|
74
98
|
}
|
|
75
99
|
/**
|
|
76
100
|
* Represents a single step in the onboarding guide.
|
|
@@ -13,4 +13,6 @@ export var EnyoOnboardingSectionType;
|
|
|
13
13
|
EnyoOnboardingSectionType["Credentials"] = "credentials";
|
|
14
14
|
/** A clickable URL section */
|
|
15
15
|
EnyoOnboardingSectionType["Url"] = "url";
|
|
16
|
+
/** A dropdown/select section */
|
|
17
|
+
EnyoOnboardingSectionType["Select"] = "select";
|
|
16
18
|
})(EnyoOnboardingSectionType || (EnyoOnboardingSectionType = {}));
|
package/dist/version.d.ts
CHANGED
package/dist/version.js
CHANGED