@adobe/exc-app 0.2.44-test → 0.2.44
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/appapi.d.ts +1 -0
- package/appapi.js +1 -0
- package/appapi.js.map +1 -1
- package/appapi.ts +1 -0
- package/build/preBuild.js +1 -0
- package/capabilityapi.d.ts +6 -0
- package/capabilityapi.js +6 -0
- package/capabilityapi.js.map +1 -1
- package/capabilityapi.ts +6 -0
- package/docs/README.md +1 -1
- package/docs/enums/capabilityapi.capabilityids.md +14 -0
- package/docs/enums/capabilityapi.capabilitynames.md +14 -0
- package/docs/interfaces/appapi.appapi-1.md +2 -2
- package/docs/interfaces/capabilityapi.capabilityapi-1.md +2 -2
- package/docs/interfaces/helpcenter.helpcenterconfig.md +4 -4
- package/docs/interfaces/metrics.analytics.md +6 -6
- package/docs/interfaces/metrics.metrics-1.md +2 -2
- package/docs/interfaces/metrics.metricsapi.md +2 -2
- package/docs/interfaces/network.apolloclientoptions.md +35 -0
- package/docs/interfaces/network.defaultmetadata.md +1 -1
- package/docs/interfaces/network.graphqlquery.md +1 -1
- package/docs/interfaces/network.networkapi.md +37 -4
- package/docs/interfaces/network.queryrequest.md +1 -1
- package/docs/interfaces/page.callback.md +21 -0
- package/docs/interfaces/page.pageapi.md +82 -5
- package/docs/interfaces/permissions.permissionsapi.md +2 -2
- package/docs/interfaces/permissions.permissionsresponse.md +1 -1
- package/docs/interfaces/pulse.pulseapi.md +38 -2
- package/docs/interfaces/pulse.pulsebuttonconfig.md +32 -0
- package/docs/interfaces/pulse.pulsenotification.md +2 -2
- package/docs/interfaces/root.modules.md +161 -0
- package/docs/interfaces/root.runtime.md +102 -0
- package/docs/interfaces/root.runtimeconfiguration.md +392 -0
- package/docs/interfaces/session.sessionapi.md +6 -6
- package/docs/interfaces/settings.parameters.md +1 -1
- package/docs/interfaces/settings.settingsapi.md +6 -6
- package/docs/interfaces/settings.settingsresponse.md +1 -1
- package/docs/interfaces/shell.shellapi.md +6 -6
- package/docs/interfaces/shell.shellinfo.md +1 -1
- package/docs/interfaces/user.imsinfo.md +1 -1
- package/docs/interfaces/user.userapi.md +6 -6
- package/docs/interfaces/user.userinfo.md +2 -2
- package/docs/modules/metrics.md +39 -8
- package/docs/modules/network.md +38 -4
- package/docs/modules/page.md +1 -0
- package/docs/modules/pulse.md +1 -0
- package/docs/modules/root.md +88 -0
- package/internal.d.ts +27 -0
- package/internal.js +12 -0
- package/internal.js.map +1 -1
- package/internal.ts +39 -0
- package/package.json +4 -4
- package/page.d.ts +3 -1
- package/page.js.map +1 -1
- package/page.ts +3 -1
- package/pulse.d.ts +22 -0
- package/pulse.js +6 -0
- package/pulse.js.map +1 -1
- package/pulse.ts +32 -0
- package/tests/pulse.test.js +3 -1
- package/tests/pulse.test.js.map +1 -1
- package/tests/pulse.test.ts +3 -1
- package/coverage/lcov-report/block-navigation.js +0 -79
- package/coverage/lcov-report/prettify.js +0 -2
- package/coverage/lcov-report/sorter.js +0 -170
package/appapi.d.ts
CHANGED
|
@@ -55,6 +55,7 @@ export declare enum AppIds {
|
|
|
55
55
|
CUSTOMER_JOURNEY_ANALYTICS = "platformAnalytics",
|
|
56
56
|
CUSTOMER_JOURNEY_MANAGEMENT = "cjm-home",
|
|
57
57
|
DATA_COLLECTION = "launchDataCollection",
|
|
58
|
+
DYNAMIC_CHAT = "hummingbird",
|
|
58
59
|
EXCHANGE = "exchange",
|
|
59
60
|
EXPERIENCE_CLOUD = "landing",
|
|
60
61
|
EXPERIENCE_MANAGER = "experienceManagerUI",
|
package/appapi.js
CHANGED
|
@@ -61,6 +61,7 @@ var AppIds;
|
|
|
61
61
|
AppIds["CUSTOMER_JOURNEY_ANALYTICS"] = "platformAnalytics";
|
|
62
62
|
AppIds["CUSTOMER_JOURNEY_MANAGEMENT"] = "cjm-home";
|
|
63
63
|
AppIds["DATA_COLLECTION"] = "launchDataCollection";
|
|
64
|
+
AppIds["DYNAMIC_CHAT"] = "hummingbird";
|
|
64
65
|
AppIds["EXCHANGE"] = "exchange";
|
|
65
66
|
AppIds["EXPERIENCE_CLOUD"] = "landing";
|
|
66
67
|
AppIds["EXPERIENCE_MANAGER"] = "experienceManagerUI";
|
package/appapi.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"appapi.js","sourceRoot":"","sources":["appapi.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,yCAAqC;AAiCrC,0DAA0D;AAC1D,IAAY,
|
|
1
|
+
{"version":3,"file":"appapi.js","sourceRoot":"","sources":["appapi.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,yCAAqC;AAiCrC,0DAA0D;AAC1D,IAAY,MA6CX;AA7CD,WAAY,MAAM;IAChB,yBAAe,CAAA;IACf,wCAA8B,CAAA;IAC9B,oDAA0C,CAAA;IAC1C,uCAA6B,CAAA;IAC7B,iCAAuB,CAAA;IACvB,2BAAiB,CAAA;IACjB,oCAA0B,CAAA;IAC1B,8CAAoC,CAAA;IACpC,6BAAmB,CAAA;IACnB,0BAAgB,CAAA;IAChB,yCAA+B,CAAA;IAC/B,0CAAgC,CAAA;IAChC,gEAAsD,CAAA;IACtD,0DAAgD,CAAA;IAChD,kDAAwC,CAAA;IACxC,kDAAwC,CAAA;IACxC,sCAA4B,CAAA;IAC5B,+BAAqB,CAAA;IACrB,sCAA4B,CAAA;IAC5B,oDAA0C,CAAA;IAC1C,4DAAkD,CAAA;IAClD,gDAAsC,CAAA;IACtC,sDAA4C,CAAA;IAC5C,+BAAqB,CAAA;IACrB,wCAA8B,CAAA;IAC9B,4CAAkC,CAAA;IAClC,8CAAoC,CAAA;IACpC,wCAA8B,CAAA;IAC9B,kCAAwB,CAAA;IACxB,sCAA4B,CAAA;IAC5B,oCAA0B,CAAA;IAC1B,2BAAiB,CAAA;IACjB,2BAAiB,CAAA;IACjB,mCAAyB,CAAA;IACzB,iCAAuB,CAAA;IACvB,kCAAwB,CAAA;IACxB,0CAAgC,CAAA;IAChC,6CAAmC,CAAA;IACnC,qCAA2B,CAAA;IAC3B,qDAA2C,CAAA;IAC3C,wDAA8C,CAAA;IAC9C,wCAA8B,CAAA;IAC9B,2BAAiB,CAAA;IACjB,+BAAqB,CAAA;AACvB,CAAC,EA7CW,MAAM,GAAN,cAAM,KAAN,cAAM,QA6CjB;AAWD,MAAM,MAAM,GAAW;IACrB,GAAG,EAAE,MAAM,CAAC,EAAE;QACZ,OAAO,gBAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;CACF,CAAC;AAEF,kBAAe,MAAM,CAAC"}
|
package/appapi.ts
CHANGED
|
@@ -91,6 +91,7 @@ export enum AppIds {
|
|
|
91
91
|
CUSTOMER_JOURNEY_ANALYTICS = 'platformAnalytics',
|
|
92
92
|
CUSTOMER_JOURNEY_MANAGEMENT = 'cjm-home',
|
|
93
93
|
DATA_COLLECTION = 'launchDataCollection',
|
|
94
|
+
DYNAMIC_CHAT = 'hummingbird',
|
|
94
95
|
EXCHANGE = 'exchange',
|
|
95
96
|
EXPERIENCE_CLOUD = 'landing',
|
|
96
97
|
EXPERIENCE_MANAGER = 'experienceManagerUI',
|
package/build/preBuild.js
CHANGED
|
@@ -22,6 +22,7 @@ const capabilities = require('../../core/src/services/CapabilityConstants/capabi
|
|
|
22
22
|
const DEFAULT_APP_IDS = {
|
|
23
23
|
CUSTOMER_JOURNEY_MANAGEMENT: 'cjm-home',
|
|
24
24
|
LAUNCH_IMPLEMENT: 'implement',
|
|
25
|
+
PROJECT_HUMMINGBIRD: 'hummingbird',
|
|
25
26
|
PROJECT_SIERRA: 'cjm-home'
|
|
26
27
|
};
|
|
27
28
|
|
package/capabilityapi.d.ts
CHANGED
|
@@ -24,6 +24,7 @@ export declare enum CapabilityNames {
|
|
|
24
24
|
ALERT = "Alerts",
|
|
25
25
|
APPCONFIGURATIONS = "App Configurations",
|
|
26
26
|
APPLICATIONS = "Applications",
|
|
27
|
+
APPSURFACES = "App Surfaces",
|
|
27
28
|
ASSETS = "Assets",
|
|
28
29
|
CLIENTPROPERTIES = "Tags",
|
|
29
30
|
COMPONENTS = "Components",
|
|
@@ -31,6 +32,7 @@ export declare enum CapabilityNames {
|
|
|
31
32
|
DATAFLOW = "Dataflows",
|
|
32
33
|
DATASET = "Datasets",
|
|
33
34
|
DATASTREAMS = "Datastreams",
|
|
35
|
+
DATASTREAMSBETA = "Datastreams (Beta)",
|
|
34
36
|
DESTINATION = "Destinations",
|
|
35
37
|
HOME = "Home",
|
|
36
38
|
IDENTITIES = "Identities",
|
|
@@ -48,6 +50,7 @@ export declare enum CapabilityNames {
|
|
|
48
50
|
PROFILE = "Profiles",
|
|
49
51
|
QUERY = "Queries",
|
|
50
52
|
REQUEST = "Requests",
|
|
53
|
+
RULESPOLICIES = "Rules & policies",
|
|
51
54
|
SANDBOX = "Sandboxes",
|
|
52
55
|
SCHEMA = "Schemas",
|
|
53
56
|
SEGMENT = "Segments",
|
|
@@ -63,6 +66,7 @@ export declare enum CapabilityIds {
|
|
|
63
66
|
ALERT = "alert",
|
|
64
67
|
APPCONFIGURATIONS = "appconfigurations",
|
|
65
68
|
APPLICATIONS = "applications",
|
|
69
|
+
APPSURFACES = "appsurfaces",
|
|
66
70
|
ASSETS = "assets",
|
|
67
71
|
CLIENTPROPERTIES = "clientproperties",
|
|
68
72
|
COMPONENTS = "components",
|
|
@@ -70,6 +74,7 @@ export declare enum CapabilityIds {
|
|
|
70
74
|
DATAFLOW = "dataflow",
|
|
71
75
|
DATASET = "dataset",
|
|
72
76
|
DATASTREAMS = "datastreams",
|
|
77
|
+
DATASTREAMSBETA = "datastreamsbeta",
|
|
73
78
|
DESTINATION = "destination",
|
|
74
79
|
HOME = "home",
|
|
75
80
|
IDENTITIES = "identities",
|
|
@@ -87,6 +92,7 @@ export declare enum CapabilityIds {
|
|
|
87
92
|
PROFILE = "profile",
|
|
88
93
|
QUERY = "query",
|
|
89
94
|
REQUEST = "request",
|
|
95
|
+
RULESPOLICIES = "rulesPolicies",
|
|
90
96
|
SANDBOX = "sandbox",
|
|
91
97
|
SCHEMA = "schema",
|
|
92
98
|
SEGMENT = "segment",
|
package/capabilityapi.js
CHANGED
|
@@ -50,6 +50,7 @@ var CapabilityNames;
|
|
|
50
50
|
CapabilityNames["ALERT"] = "Alerts";
|
|
51
51
|
CapabilityNames["APPCONFIGURATIONS"] = "App Configurations";
|
|
52
52
|
CapabilityNames["APPLICATIONS"] = "Applications";
|
|
53
|
+
CapabilityNames["APPSURFACES"] = "App Surfaces";
|
|
53
54
|
CapabilityNames["ASSETS"] = "Assets";
|
|
54
55
|
CapabilityNames["CLIENTPROPERTIES"] = "Tags";
|
|
55
56
|
CapabilityNames["COMPONENTS"] = "Components";
|
|
@@ -57,6 +58,7 @@ var CapabilityNames;
|
|
|
57
58
|
CapabilityNames["DATAFLOW"] = "Dataflows";
|
|
58
59
|
CapabilityNames["DATASET"] = "Datasets";
|
|
59
60
|
CapabilityNames["DATASTREAMS"] = "Datastreams";
|
|
61
|
+
CapabilityNames["DATASTREAMSBETA"] = "Datastreams (Beta)";
|
|
60
62
|
CapabilityNames["DESTINATION"] = "Destinations";
|
|
61
63
|
CapabilityNames["HOME"] = "Home";
|
|
62
64
|
CapabilityNames["IDENTITIES"] = "Identities";
|
|
@@ -74,6 +76,7 @@ var CapabilityNames;
|
|
|
74
76
|
CapabilityNames["PROFILE"] = "Profiles";
|
|
75
77
|
CapabilityNames["QUERY"] = "Queries";
|
|
76
78
|
CapabilityNames["REQUEST"] = "Requests";
|
|
79
|
+
CapabilityNames["RULESPOLICIES"] = "Rules & policies";
|
|
77
80
|
CapabilityNames["SANDBOX"] = "Sandboxes";
|
|
78
81
|
CapabilityNames["SCHEMA"] = "Schemas";
|
|
79
82
|
CapabilityNames["SEGMENT"] = "Segments";
|
|
@@ -91,6 +94,7 @@ var CapabilityIds;
|
|
|
91
94
|
CapabilityIds["ALERT"] = "alert";
|
|
92
95
|
CapabilityIds["APPCONFIGURATIONS"] = "appconfigurations";
|
|
93
96
|
CapabilityIds["APPLICATIONS"] = "applications";
|
|
97
|
+
CapabilityIds["APPSURFACES"] = "appsurfaces";
|
|
94
98
|
CapabilityIds["ASSETS"] = "assets";
|
|
95
99
|
CapabilityIds["CLIENTPROPERTIES"] = "clientproperties";
|
|
96
100
|
CapabilityIds["COMPONENTS"] = "components";
|
|
@@ -98,6 +102,7 @@ var CapabilityIds;
|
|
|
98
102
|
CapabilityIds["DATAFLOW"] = "dataflow";
|
|
99
103
|
CapabilityIds["DATASET"] = "dataset";
|
|
100
104
|
CapabilityIds["DATASTREAMS"] = "datastreams";
|
|
105
|
+
CapabilityIds["DATASTREAMSBETA"] = "datastreamsbeta";
|
|
101
106
|
CapabilityIds["DESTINATION"] = "destination";
|
|
102
107
|
CapabilityIds["HOME"] = "home";
|
|
103
108
|
CapabilityIds["IDENTITIES"] = "identities";
|
|
@@ -115,6 +120,7 @@ var CapabilityIds;
|
|
|
115
120
|
CapabilityIds["PROFILE"] = "profile";
|
|
116
121
|
CapabilityIds["QUERY"] = "query";
|
|
117
122
|
CapabilityIds["REQUEST"] = "request";
|
|
123
|
+
CapabilityIds["RULESPOLICIES"] = "rulesPolicies";
|
|
118
124
|
CapabilityIds["SANDBOX"] = "sandbox";
|
|
119
125
|
CapabilityIds["SCHEMA"] = "schema";
|
|
120
126
|
CapabilityIds["SEGMENT"] = "segment";
|
package/capabilityapi.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"capabilityapi.js","sourceRoot":"","sources":["capabilityapi.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,yCAAqC;AAarC,iDAAiD;AACjD,IAAY,
|
|
1
|
+
{"version":3,"file":"capabilityapi.js","sourceRoot":"","sources":["capabilityapi.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,yCAAqC;AAarC,iDAAiD;AACjD,IAAY,eAyCX;AAzCD,WAAY,eAAe;IACzB,8CAA2B,CAAA;IAC3B,2CAAwB,CAAA;IACxB,mCAAgB,CAAA;IAChB,2DAAwC,CAAA;IACxC,gDAA6B,CAAA;IAC7B,+CAA4B,CAAA;IAC5B,oCAAiB,CAAA;IACjB,4CAAyB,CAAA;IACzB,4CAAyB,CAAA;IACzB,2CAAwB,CAAA;IACxB,yCAAsB,CAAA;IACtB,uCAAoB,CAAA;IACpB,8CAA2B,CAAA;IAC3B,yDAAsC,CAAA;IACtC,+CAA4B,CAAA;IAC5B,gCAAa,CAAA;IACb,4CAAyB,CAAA;IACzB,0CAAuB,CAAA;IACvB,wCAAqB,CAAA;IACrB,iDAA8B,CAAA;IAC9B,wCAAqB,CAAA;IACrB,mCAAgB,CAAA;IAChB,4CAAyB,CAAA;IACzB,yCAAsB,CAAA;IACtB,mCAAgB,CAAA;IAChB,+CAA4B,CAAA;IAC5B,sCAAmB,CAAA;IACnB,0CAAuB,CAAA;IACvB,uCAAoB,CAAA;IACpB,oCAAiB,CAAA;IACjB,uCAAoB,CAAA;IACpB,qDAAkC,CAAA;IAClC,wCAAqB,CAAA;IACrB,qCAAkB,CAAA;IAClB,uCAAoB,CAAA;IACpB,wDAAqC,CAAA;IACrC,uCAAoB,CAAA;IACpB,wCAAqB,CAAA;IACrB,qCAAkB,CAAA;IAClB,yCAAsB,CAAA;AACxB,CAAC,EAzCW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAyC1B;AAED,iDAAiD;AACjD,IAAY,aAyCX;AAzCD,WAAY,aAAa;IACvB,kDAAiC,CAAA;IACjC,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,wDAAuC,CAAA;IACvC,8CAA6B,CAAA;IAC7B,4CAA2B,CAAA;IAC3B,kCAAiB,CAAA;IACjB,sDAAqC,CAAA;IACrC,0CAAyB,CAAA;IACzB,wCAAuB,CAAA;IACvB,sCAAqB,CAAA;IACrB,oCAAmB,CAAA;IACnB,4CAA2B,CAAA;IAC3B,oDAAmC,CAAA;IACnC,4CAA2B,CAAA;IAC3B,8BAAa,CAAA;IACb,0CAAyB,CAAA;IACzB,sCAAqB,CAAA;IACrB,sCAAqB,CAAA;IACrB,8CAA6B,CAAA;IAC7B,sCAAqB,CAAA;IACrB,gCAAe,CAAA;IACf,0CAAyB,CAAA;IACzB,sCAAqB,CAAA;IACrB,gCAAe,CAAA;IACf,gDAA+B,CAAA;IAC/B,kCAAiB,CAAA;IACjB,8CAA6B,CAAA;IAC7B,oCAAmB,CAAA;IACnB,gCAAe,CAAA;IACf,oCAAmB,CAAA;IACnB,gDAA+B,CAAA;IAC/B,oCAAmB,CAAA;IACnB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;IACnB,sDAAqC,CAAA;IACrC,oCAAmB,CAAA;IACnB,sCAAqB,CAAA;IACrB,kCAAiB,CAAA;IACjB,sCAAqB,CAAA;AACvB,CAAC,EAzCW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAyCxB;AAUD,MAAM,aAAa,GAAG;IACpB,GAAG,EAAE,MAAM,CAAC,EAAE;QACZ,OAAO,gBAAO,CAAC,eAAe,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAChD,CAAC;CACe,CAAC;AAEnB,kBAAe,aAAa,CAAC"}
|
package/capabilityapi.ts
CHANGED
|
@@ -60,6 +60,7 @@ export enum CapabilityNames {
|
|
|
60
60
|
ALERT = 'Alerts',
|
|
61
61
|
APPCONFIGURATIONS = 'App Configurations',
|
|
62
62
|
APPLICATIONS = 'Applications',
|
|
63
|
+
APPSURFACES = 'App Surfaces',
|
|
63
64
|
ASSETS = 'Assets',
|
|
64
65
|
CLIENTPROPERTIES = 'Tags',
|
|
65
66
|
COMPONENTS = 'Components',
|
|
@@ -67,6 +68,7 @@ export enum CapabilityNames {
|
|
|
67
68
|
DATAFLOW = 'Dataflows',
|
|
68
69
|
DATASET = 'Datasets',
|
|
69
70
|
DATASTREAMS = 'Datastreams',
|
|
71
|
+
DATASTREAMSBETA = 'Datastreams (Beta)',
|
|
70
72
|
DESTINATION = 'Destinations',
|
|
71
73
|
HOME = 'Home',
|
|
72
74
|
IDENTITIES = 'Identities',
|
|
@@ -84,6 +86,7 @@ export enum CapabilityNames {
|
|
|
84
86
|
PROFILE = 'Profiles',
|
|
85
87
|
QUERY = 'Queries',
|
|
86
88
|
REQUEST = 'Requests',
|
|
89
|
+
RULESPOLICIES = 'Rules & policies',
|
|
87
90
|
SANDBOX = 'Sandboxes',
|
|
88
91
|
SCHEMA = 'Schemas',
|
|
89
92
|
SEGMENT = 'Segments',
|
|
@@ -101,6 +104,7 @@ export enum CapabilityIds {
|
|
|
101
104
|
ALERT = 'alert',
|
|
102
105
|
APPCONFIGURATIONS = 'appconfigurations',
|
|
103
106
|
APPLICATIONS = 'applications',
|
|
107
|
+
APPSURFACES = 'appsurfaces',
|
|
104
108
|
ASSETS = 'assets',
|
|
105
109
|
CLIENTPROPERTIES = 'clientproperties',
|
|
106
110
|
COMPONENTS = 'components',
|
|
@@ -108,6 +112,7 @@ export enum CapabilityIds {
|
|
|
108
112
|
DATAFLOW = 'dataflow',
|
|
109
113
|
DATASET = 'dataset',
|
|
110
114
|
DATASTREAMS = 'datastreams',
|
|
115
|
+
DATASTREAMSBETA = 'datastreamsbeta',
|
|
111
116
|
DESTINATION = 'destination',
|
|
112
117
|
HOME = 'home',
|
|
113
118
|
IDENTITIES = 'identities',
|
|
@@ -125,6 +130,7 @@ export enum CapabilityIds {
|
|
|
125
130
|
PROFILE = 'profile',
|
|
126
131
|
QUERY = 'query',
|
|
127
132
|
REQUEST = 'request',
|
|
133
|
+
RULESPOLICIES = 'rulesPolicies',
|
|
128
134
|
SANDBOX = 'sandbox',
|
|
129
135
|
SCHEMA = 'schema',
|
|
130
136
|
SEGMENT = 'segment',
|
package/docs/README.md
CHANGED
|
@@ -8,7 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
### Modules
|
|
10
10
|
|
|
11
|
-
* [](modules/reflection-936.md)
|
|
12
11
|
* [appapi](modules/appapi.md)
|
|
13
12
|
* [capabilityapi](modules/capabilityapi.md)
|
|
14
13
|
* [helpCenter](modules/helpcenter.md)
|
|
@@ -18,6 +17,7 @@
|
|
|
18
17
|
* [page](modules/page.md)
|
|
19
18
|
* [permissions](modules/permissions.md)
|
|
20
19
|
* [pulse](modules/pulse.md)
|
|
20
|
+
* [root](modules/root.md)
|
|
21
21
|
* [session](modules/session.md)
|
|
22
22
|
* [settings](modules/settings.md)
|
|
23
23
|
* [shell](modules/shell.md)
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
* [ALERT](capabilityapi.capabilityids.md#alert)
|
|
14
14
|
* [APPCONFIGURATIONS](capabilityapi.capabilityids.md#appconfigurations)
|
|
15
15
|
* [APPLICATIONS](capabilityapi.capabilityids.md#applications)
|
|
16
|
+
* [APPSURFACES](capabilityapi.capabilityids.md#appsurfaces)
|
|
16
17
|
* [ASSETS](capabilityapi.capabilityids.md#assets)
|
|
17
18
|
* [CLIENTPROPERTIES](capabilityapi.capabilityids.md#clientproperties)
|
|
18
19
|
* [COMPONENTS](capabilityapi.capabilityids.md#components)
|
|
@@ -20,6 +21,7 @@
|
|
|
20
21
|
* [DATAFLOW](capabilityapi.capabilityids.md#dataflow)
|
|
21
22
|
* [DATASET](capabilityapi.capabilityids.md#dataset)
|
|
22
23
|
* [DATASTREAMS](capabilityapi.capabilityids.md#datastreams)
|
|
24
|
+
* [DATASTREAMSBETA](capabilityapi.capabilityids.md#datastreamsbeta)
|
|
23
25
|
* [DESTINATION](capabilityapi.capabilityids.md#destination)
|
|
24
26
|
* [HOME](capabilityapi.capabilityids.md#home)
|
|
25
27
|
* [IDENTITIES](capabilityapi.capabilityids.md#identities)
|
|
@@ -78,6 +80,12 @@ ___
|
|
|
78
80
|
|
|
79
81
|
___
|
|
80
82
|
|
|
83
|
+
### APPSURFACES
|
|
84
|
+
|
|
85
|
+
• **APPSURFACES**: = "appsurfaces"
|
|
86
|
+
|
|
87
|
+
___
|
|
88
|
+
|
|
81
89
|
### ASSETS
|
|
82
90
|
|
|
83
91
|
• **ASSETS**: = "assets"
|
|
@@ -120,6 +128,12 @@ ___
|
|
|
120
128
|
|
|
121
129
|
___
|
|
122
130
|
|
|
131
|
+
### DATASTREAMSBETA
|
|
132
|
+
|
|
133
|
+
• **DATASTREAMSBETA**: = "datastreamsbeta"
|
|
134
|
+
|
|
135
|
+
___
|
|
136
|
+
|
|
123
137
|
### DESTINATION
|
|
124
138
|
|
|
125
139
|
• **DESTINATION**: = "destination"
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
* [ALERT](capabilityapi.capabilitynames.md#alert)
|
|
14
14
|
* [APPCONFIGURATIONS](capabilityapi.capabilitynames.md#appconfigurations)
|
|
15
15
|
* [APPLICATIONS](capabilityapi.capabilitynames.md#applications)
|
|
16
|
+
* [APPSURFACES](capabilityapi.capabilitynames.md#appsurfaces)
|
|
16
17
|
* [ASSETS](capabilityapi.capabilitynames.md#assets)
|
|
17
18
|
* [CLIENTPROPERTIES](capabilityapi.capabilitynames.md#clientproperties)
|
|
18
19
|
* [COMPONENTS](capabilityapi.capabilitynames.md#components)
|
|
@@ -20,6 +21,7 @@
|
|
|
20
21
|
* [DATAFLOW](capabilityapi.capabilitynames.md#dataflow)
|
|
21
22
|
* [DATASET](capabilityapi.capabilitynames.md#dataset)
|
|
22
23
|
* [DATASTREAMS](capabilityapi.capabilitynames.md#datastreams)
|
|
24
|
+
* [DATASTREAMSBETA](capabilityapi.capabilitynames.md#datastreamsbeta)
|
|
23
25
|
* [DESTINATION](capabilityapi.capabilitynames.md#destination)
|
|
24
26
|
* [HOME](capabilityapi.capabilitynames.md#home)
|
|
25
27
|
* [IDENTITIES](capabilityapi.capabilitynames.md#identities)
|
|
@@ -78,6 +80,12 @@ ___
|
|
|
78
80
|
|
|
79
81
|
___
|
|
80
82
|
|
|
83
|
+
### APPSURFACES
|
|
84
|
+
|
|
85
|
+
• **APPSURFACES**: = "App Surfaces"
|
|
86
|
+
|
|
87
|
+
___
|
|
88
|
+
|
|
81
89
|
### ASSETS
|
|
82
90
|
|
|
83
91
|
• **ASSETS**: = "Assets"
|
|
@@ -120,6 +128,12 @@ ___
|
|
|
120
128
|
|
|
121
129
|
___
|
|
122
130
|
|
|
131
|
+
### DATASTREAMSBETA
|
|
132
|
+
|
|
133
|
+
• **DATASTREAMSBETA**: = "Datastreams (Beta)"
|
|
134
|
+
|
|
135
|
+
___
|
|
136
|
+
|
|
123
137
|
### DESTINATION
|
|
124
138
|
|
|
125
139
|
• **DESTINATION**: = "Destinations"
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
|
|
19
19
|
### get
|
|
20
20
|
|
|
21
|
-
▸ **get**(`appId`: AppId): Promise
|
|
21
|
+
▸ **get**(`appId`: AppId): Promise<[AppResponse](appapi.appresponse.md)\>
|
|
22
22
|
|
|
23
23
|
API to fetch metadata for one app by appId
|
|
24
24
|
|
|
@@ -28,4 +28,4 @@ Name | Type |
|
|
|
28
28
|
------ | ------ |
|
|
29
29
|
`appId` | AppId |
|
|
30
30
|
|
|
31
|
-
**Returns:** Promise
|
|
31
|
+
**Returns:** Promise<[AppResponse](appapi.appresponse.md)\>
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
|
|
19
19
|
### get
|
|
20
20
|
|
|
21
|
-
▸ **get**(`capability`: [CapabilityNames](../enums/capabilityapi.capabilitynames.md) \| [CapabilityIds](../enums/capabilityapi.capabilityids.md)): Promise
|
|
21
|
+
▸ **get**(`capability`: [CapabilityNames](../enums/capabilityapi.capabilitynames.md) \| [CapabilityIds](../enums/capabilityapi.capabilityids.md)): Promise<[CapabilityResponse](capabilityapi.capabilityresponse.md)\>
|
|
22
22
|
|
|
23
23
|
Gets the specified icon.
|
|
24
24
|
|
|
@@ -28,4 +28,4 @@ Name | Type |
|
|
|
28
28
|
------ | ------ |
|
|
29
29
|
`capability` | [CapabilityNames](../enums/capabilityapi.capabilitynames.md) \| [CapabilityIds](../enums/capabilityapi.capabilityids.md) |
|
|
30
30
|
|
|
31
|
-
**Returns:** Promise
|
|
31
|
+
**Returns:** Promise<[CapabilityResponse](capabilityapi.capabilityresponse.md)\>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
### featured
|
|
23
23
|
|
|
24
|
-
• `Optional` **featured**: Array
|
|
24
|
+
• `Optional` **featured**: Array<{ href: string ; label: string ; path: string \| Array<string\> }\>
|
|
25
25
|
|
|
26
26
|
Adds help links to the *featured* section of the help center.
|
|
27
27
|
|
|
@@ -29,7 +29,7 @@ ___
|
|
|
29
29
|
|
|
30
30
|
### questions
|
|
31
31
|
|
|
32
|
-
• `Optional` **questions**: Array
|
|
32
|
+
• `Optional` **questions**: Array<string\>
|
|
33
33
|
|
|
34
34
|
If the solution wants to simulate "Frequently asked questions", it can provide them as an array of strings. These appear as the user starts typing in the Search field.
|
|
35
35
|
|
|
@@ -37,7 +37,7 @@ ___
|
|
|
37
37
|
|
|
38
38
|
### recommendations
|
|
39
39
|
|
|
40
|
-
• `Optional` **recommendations**: undefined \| { enabled: boolean ; terms: Array
|
|
40
|
+
• `Optional` **recommendations**: undefined \| { enabled: boolean ; terms: Array<{ path: string ; term: string }\> }
|
|
41
41
|
|
|
42
42
|
Customizes *for you* section of the help center.
|
|
43
43
|
|
|
@@ -45,6 +45,6 @@ ___
|
|
|
45
45
|
|
|
46
46
|
### resources
|
|
47
47
|
|
|
48
|
-
• `Optional` **resources**: Array
|
|
48
|
+
• `Optional` **resources**: Array<{ href: string ; label: string }\>
|
|
49
49
|
|
|
50
50
|
Overrides default links present in *resources* section. Product owners are advised to supply custom resources links to ensure greater relevance.
|
|
@@ -50,7 +50,7 @@ ___
|
|
|
50
50
|
|
|
51
51
|
### trackEvent
|
|
52
52
|
|
|
53
|
-
▸ **trackEvent**(`eventData`: Record
|
|
53
|
+
▸ **trackEvent**(`eventData`: Record<string, any\>): void
|
|
54
54
|
|
|
55
55
|
Set `window.digialData.eventData` to the specified input and record an Analytics record.
|
|
56
56
|
|
|
@@ -58,7 +58,7 @@ Set `window.digialData.eventData` to the specified input and record an Analytics
|
|
|
58
58
|
|
|
59
59
|
Name | Type |
|
|
60
60
|
------ | ------ |
|
|
61
|
-
`eventData` | Record
|
|
61
|
+
`eventData` | Record<string, any\> |
|
|
62
62
|
|
|
63
63
|
**Returns:** void
|
|
64
64
|
|
|
@@ -66,7 +66,7 @@ ___
|
|
|
66
66
|
|
|
67
67
|
### trackPage
|
|
68
68
|
|
|
69
|
-
▸ **trackPage**(`pageData`: Record
|
|
69
|
+
▸ **trackPage**(`pageData`: Record<string, any\>): void
|
|
70
70
|
|
|
71
71
|
Set `window.digialData.pageData` to the specified input and record an Analytics record.
|
|
72
72
|
|
|
@@ -74,7 +74,7 @@ Set `window.digialData.pageData` to the specified input and record an Analytics
|
|
|
74
74
|
|
|
75
75
|
Name | Type | Description |
|
|
76
76
|
------ | ------ | ------ |
|
|
77
|
-
`pageData` | Record
|
|
77
|
+
`pageData` | Record<string, any\> | The object to assign to `window.digitalData.pageData`. |
|
|
78
78
|
|
|
79
79
|
**Returns:** void
|
|
80
80
|
|
|
@@ -82,7 +82,7 @@ ___
|
|
|
82
82
|
|
|
83
83
|
### trackUser
|
|
84
84
|
|
|
85
|
-
▸ **trackUser**(`userData`: Record
|
|
85
|
+
▸ **trackUser**(`userData`: Record<string, any\>): void
|
|
86
86
|
|
|
87
87
|
Set `window.digialData.userData` to the specified input and record an Analytics record.
|
|
88
88
|
|
|
@@ -90,6 +90,6 @@ Set `window.digialData.userData` to the specified input and record an Analytics
|
|
|
90
90
|
|
|
91
91
|
Name | Type | Description |
|
|
92
92
|
------ | ------ | ------ |
|
|
93
|
-
`userData` | Record
|
|
93
|
+
`userData` | Record<string, any\> | The object to assign to `window.digitalData.userData`. |
|
|
94
94
|
|
|
95
95
|
**Returns:** void
|
|
@@ -33,7 +33,7 @@ Defines metrics APIs.
|
|
|
33
33
|
|
|
34
34
|
### analytics
|
|
35
35
|
|
|
36
|
-
• **analytics**: Readonly
|
|
36
|
+
• **analytics**: Readonly<[Analytics](metrics.analytics.md)\>
|
|
37
37
|
|
|
38
38
|
The Analytics APIs are designed to mirror the Omega APIs, enabling an Analtyics record to be
|
|
39
39
|
remotely stored which simulatenously captures additional context provided by the Metrics system
|
|
@@ -51,7 +51,7 @@ ___
|
|
|
51
51
|
|
|
52
52
|
### history
|
|
53
53
|
|
|
54
|
-
• **history**: Readonly
|
|
54
|
+
• **history**: Readonly<[History](metrics.history.md)\>
|
|
55
55
|
|
|
56
56
|
The History APIs are designed to mirror browser history management. Calling a Metrics history
|
|
57
57
|
API is recommended either immediately before or after a call to window history, and will record
|
|
@@ -20,7 +20,7 @@ Defines the metrics API.
|
|
|
20
20
|
|
|
21
21
|
### create
|
|
22
22
|
|
|
23
|
-
▸ **create**(`name`: string): Readonly
|
|
23
|
+
▸ **create**(`name`: string): Readonly<[Metrics](metrics.metrics-1.md)\>
|
|
24
24
|
|
|
25
25
|
Creates a metrics instance for the specified component to log entries and events.
|
|
26
26
|
|
|
@@ -30,4 +30,4 @@ Name | Type | Description |
|
|
|
30
30
|
------ | ------ | ------ |
|
|
31
31
|
`name` | string | The name of the component. |
|
|
32
32
|
|
|
33
|
-
**Returns:** Readonly
|
|
33
|
+
**Returns:** Readonly<[Metrics](metrics.metrics-1.md)\>
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
**[@adobe/exc-app](../README.md)**
|
|
2
|
+
|
|
3
|
+
> [Globals](../README.md) / [network](../modules/network.md) / ApolloClientOptions
|
|
4
|
+
|
|
5
|
+
# Interface: ApolloClientOptions
|
|
6
|
+
|
|
7
|
+
## Hierarchy
|
|
8
|
+
|
|
9
|
+
* **ApolloClientOptions**
|
|
10
|
+
|
|
11
|
+
## Index
|
|
12
|
+
|
|
13
|
+
### Properties
|
|
14
|
+
|
|
15
|
+
* [cacheOptions](network.apolloclientoptions.md#cacheoptions)
|
|
16
|
+
* [connectToDevTools](network.apolloclientoptions.md#connecttodevtools)
|
|
17
|
+
* [inputApolloLink](network.apolloclientoptions.md#inputapollolink)
|
|
18
|
+
|
|
19
|
+
## Properties
|
|
20
|
+
|
|
21
|
+
### cacheOptions
|
|
22
|
+
|
|
23
|
+
• `Optional` **cacheOptions**: InMemoryCacheConfig
|
|
24
|
+
|
|
25
|
+
___
|
|
26
|
+
|
|
27
|
+
### connectToDevTools
|
|
28
|
+
|
|
29
|
+
• `Optional` **connectToDevTools**: undefined \| false \| true
|
|
30
|
+
|
|
31
|
+
___
|
|
32
|
+
|
|
33
|
+
### inputApolloLink
|
|
34
|
+
|
|
35
|
+
• `Optional` **inputApolloLink**: ApolloLink
|
|
@@ -13,13 +13,14 @@
|
|
|
13
13
|
### Methods
|
|
14
14
|
|
|
15
15
|
* [fetch](network.networkapi.md#fetch)
|
|
16
|
+
* [getApolloClient](network.networkapi.md#getapolloclient)
|
|
16
17
|
* [query](network.networkapi.md#query)
|
|
17
18
|
|
|
18
19
|
## Methods
|
|
19
20
|
|
|
20
21
|
### fetch
|
|
21
22
|
|
|
22
|
-
▸ **fetch**(`input`: RequestInfo, `init?`: [FetchInit](../modules/network.md#fetchinit)): Promise
|
|
23
|
+
▸ **fetch**(`input`: RequestInfo, `init?`: [FetchInit](../modules/network.md#fetchinit)): Promise<Response\>
|
|
23
24
|
|
|
24
25
|
Provides an interface for fetching resources powered by the global 'fetch' API.
|
|
25
26
|
|
|
@@ -48,15 +49,47 @@ Name | Type | Description |
|
|
|
48
49
|
`input` | RequestInfo | The resource that you wish to fetch. It can either be the URL of the resource you want to fetch or a Request object. |
|
|
49
50
|
`init?` | [FetchInit](../modules/network.md#fetchinit) | An object containing any custom settings that you want to apply to the request. |
|
|
50
51
|
|
|
51
|
-
**Returns:** Promise
|
|
52
|
+
**Returns:** Promise<Response\>
|
|
52
53
|
|
|
53
54
|
The promise for the response to the fetch operation.
|
|
54
55
|
|
|
55
56
|
___
|
|
56
57
|
|
|
58
|
+
### getApolloClient
|
|
59
|
+
|
|
60
|
+
▸ **getApolloClient**(`options?`: [ApolloClientOptions](network.apolloclientoptions.md)): Promise<{ apolloClient: ApolloClient<InMemoryCache\> ; gql: *typeof* gql }\>
|
|
61
|
+
|
|
62
|
+
Provides an interface for querying resources via GraphqQL using ApolloClient
|
|
63
|
+
***Example***
|
|
64
|
+
```typescript
|
|
65
|
+
const apolloClientModule = await getApolloClient();
|
|
66
|
+
const apolloClient = apolloClientModule.apolloClient;
|
|
67
|
+
const gql = apolloClientModule.gql;
|
|
68
|
+
const result = await apolloClient.query({
|
|
69
|
+
query: gql`query user {
|
|
70
|
+
id
|
|
71
|
+
name
|
|
72
|
+
}`,
|
|
73
|
+
variables : {}
|
|
74
|
+
});
|
|
75
|
+
console.log(result.data);
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
#### Parameters:
|
|
79
|
+
|
|
80
|
+
Name | Type | Description |
|
|
81
|
+
------ | ------ | ------ |
|
|
82
|
+
`options?` | [ApolloClientOptions](network.apolloclientoptions.md) | Configuration to create ApolloClient instance |
|
|
83
|
+
|
|
84
|
+
**Returns:** Promise<{ apolloClient: ApolloClient<InMemoryCache\> ; gql: *typeof* gql }\>
|
|
85
|
+
|
|
86
|
+
GraphQL query response
|
|
87
|
+
|
|
88
|
+
___
|
|
89
|
+
|
|
57
90
|
### query
|
|
58
91
|
|
|
59
|
-
▸ **query**(`request`: [QueryRequest](network.queryrequest.md)): Promise
|
|
92
|
+
▸ **query**(`request`: [QueryRequest](network.queryrequest.md)): Promise<Response\>
|
|
60
93
|
|
|
61
94
|
Provides an interface for querying resources via GraphqQL.
|
|
62
95
|
In order to consume query, please make sure the respective query resolver is
|
|
@@ -94,6 +127,6 @@ Name | Type | Description |
|
|
|
94
127
|
------ | ------ | ------ |
|
|
95
128
|
`request` | [QueryRequest](network.queryrequest.md) | Query request containing desired GQL Query. |
|
|
96
129
|
|
|
97
|
-
**Returns:** Promise
|
|
130
|
+
**Returns:** Promise<Response\>
|
|
98
131
|
|
|
99
132
|
The promise for the response to the query operation.
|
|
@@ -37,7 +37,7 @@ ___
|
|
|
37
37
|
|
|
38
38
|
### data
|
|
39
39
|
|
|
40
|
-
• **data**: [GraphQLQuery](network.graphqlquery.md) \| Array
|
|
40
|
+
• **data**: [GraphQLQuery](network.graphqlquery.md) \| Array<[GraphQLQuery](network.graphqlquery.md)\>
|
|
41
41
|
|
|
42
42
|
Data containing single or multiple GQL queries.
|
|
43
43
|
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
**[@adobe/exc-app](../README.md)**
|
|
2
|
+
|
|
3
|
+
> [Globals](../README.md) / [page](../modules/page.md) / Callback
|
|
4
|
+
|
|
5
|
+
# Interface: Callback
|
|
6
|
+
|
|
7
|
+
## Hierarchy
|
|
8
|
+
|
|
9
|
+
* **Callback**
|
|
10
|
+
|
|
11
|
+
## Callable
|
|
12
|
+
|
|
13
|
+
▸ (`value?`: any): void
|
|
14
|
+
|
|
15
|
+
#### Parameters:
|
|
16
|
+
|
|
17
|
+
Name | Type |
|
|
18
|
+
------ | ------ |
|
|
19
|
+
`value?` | any |
|
|
20
|
+
|
|
21
|
+
**Returns:** void
|