@adobe/exc-app 1.0.5 → 1.0.8

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 (43) hide show
  1. package/RuntimeConfiguration.d.ts +12 -0
  2. package/appapi.d.ts +3 -3
  3. package/appapi.js +2 -2
  4. package/appapi.js.map +1 -1
  5. package/capabilityapi.d.ts +2 -0
  6. package/capabilityapi.js +2 -0
  7. package/capabilityapi.js.map +1 -1
  8. package/component.d.ts +53 -0
  9. package/component.js +72 -0
  10. package/component.js.map +1 -0
  11. package/docs/enums/appapi.appids.md +7 -7
  12. package/docs/enums/network.standardvariables.md +24 -0
  13. package/docs/interfaces/network.datadedupconfig.md +32 -0
  14. package/docs/interfaces/network.dataprefetchcontract.md +129 -0
  15. package/docs/interfaces/network.fetchcondition.md +27 -0
  16. package/docs/interfaces/network.graphqlquery.md +2 -0
  17. package/docs/interfaces/network.networkapi.md +29 -0
  18. package/docs/interfaces/network.prefetchoptions.md +34 -0
  19. package/docs/interfaces/network.querydefinition.md +100 -0
  20. package/docs/interfaces/root.runtimeconfiguration.md +9 -0
  21. package/docs/interfaces/shell.shellinfo.md +7 -0
  22. package/docs/modules/network.md +55 -0
  23. package/ims/ImsProfile.d.ts +1 -0
  24. package/jest.config.js +0 -4
  25. package/network/DataPrefetchContract.d.ts +46 -0
  26. package/network/DataPrefetchContract.js +7 -1
  27. package/network/DataPrefetchContract.js.map +1 -1
  28. package/package.json +3 -4
  29. package/src/Global.d.ts +2 -0
  30. package/src/Global.js.map +1 -1
  31. package/tests/appapi.test.js +0 -4
  32. package/tests/appapi.test.js.map +1 -1
  33. package/tests/component.test.d.ts +1 -0
  34. package/tests/component.test.js +74 -0
  35. package/tests/component.test.js.map +1 -0
  36. package/version.d.ts +1 -1
  37. package/version.js +1 -1
  38. package/coverage/lcov-report/block-navigation.js +0 -79
  39. package/coverage/lcov-report/prettify.js +0 -2
  40. package/coverage/lcov-report/sorter.js +0 -170
  41. package/network/DataContract.d.ts +0 -35
  42. package/network/DataContract.js +0 -3
  43. package/network/DataContract.js.map +0 -1
@@ -130,6 +130,10 @@ export interface RuntimeConfiguration {
130
130
  * List all properties changed in this configuration compared to the previous one sent
131
131
  */
132
132
  changedProperties: (keyof RuntimeConfiguration)[];
133
+ /**
134
+ * Bootstrap data for the component modal.
135
+ */
136
+ componentBootstrapData?: Record<string, any> | undefined;
133
137
  /**
134
138
  * If discovery URL
135
139
  */
@@ -197,6 +201,10 @@ export interface RuntimeConfiguration {
197
201
  * IMS Token
198
202
  */
199
203
  imsToken: string;
204
+ /**
205
+ * If the app/runtime are loaded in a modal.
206
+ */
207
+ inModal?: boolean;
200
208
  /**
201
209
  * Adobe IO gateway URL used as a fallback in GQL call
202
210
  */
@@ -270,6 +278,10 @@ export interface RuntimeConfiguration {
270
278
  */
271
279
  tenantAppId?: string;
272
280
  theme: string;
281
+ /**
282
+ * If the toast quiet mode feature is enabled.
283
+ */
284
+ toastQuietModeEnabled: boolean;
273
285
  /**
274
286
  * XQL gateway used for AEP specific queries
275
287
  */
package/appapi.d.ts CHANGED
@@ -45,6 +45,7 @@ export declare enum AppIds {
45
45
  ADOBE_EXPERIENCE_PLATFORM = "project-m",
46
46
  ADVERTISING_CLOUD = "adcloud",
47
47
  ANALYTICS = "analytics",
48
+ APP_BUILDER_CATALOG = "firefly",
48
49
  ASSETS = "assets",
49
50
  ASSETS_ESSENTIALS = "ddam",
50
51
  AUDIENCE_MANAGER = "audiencemanager",
@@ -67,7 +68,6 @@ export declare enum AppIds {
67
68
  HEADLESS_CMS = "hcms",
68
69
  JOURNEY_OPTIMIZER = "cjm-home",
69
70
  JOURNEY_ORCHESTRATION = "journeys",
70
- LAUNCH_DATA_COLLECTION = "implement",
71
71
  LAUNCH_IMPLEMENT = "implement",
72
72
  LAUNCH_LAUNCH = "launch",
73
73
  MAGENTO_COMMERCE = "magento",
@@ -78,13 +78,13 @@ export declare enum AppIds {
78
78
  PLACES_SERVICE = "places",
79
79
  PRIMETIME = "primetime",
80
80
  PRIVACY_UI = "privacyui",
81
- PROJECT_FIREFLY_APPS = "firefly",
82
81
  PROJECT_HUMMINGBIRD = "hummingbird",
83
82
  PROJECT_SIERRA = "cjm-home",
84
83
  SOFTWARE_DISTRIBUTION = "softwareDistribution",
85
84
  SYSTEM_STATUS = "systemStatus",
86
85
  TARGET = "target",
87
- TRIGGERS = "triggers"
86
+ TRIGGERS = "triggers",
87
+ WORKFRONT = "workfront"
88
88
  }
89
89
  declare type AppId = typeof AppIds[keyof typeof AppIds];
90
90
  export interface AppApi {
package/appapi.js CHANGED
@@ -51,6 +51,7 @@ var AppIds;
51
51
  AppIds["ADOBE_EXPERIENCE_PLATFORM"] = "project-m";
52
52
  AppIds["ADVERTISING_CLOUD"] = "adcloud";
53
53
  AppIds["ANALYTICS"] = "analytics";
54
+ AppIds["APP_BUILDER_CATALOG"] = "firefly";
54
55
  AppIds["ASSETS"] = "assets";
55
56
  AppIds["ASSETS_ESSENTIALS"] = "ddam";
56
57
  AppIds["AUDIENCE_MANAGER"] = "audiencemanager";
@@ -73,7 +74,6 @@ var AppIds;
73
74
  AppIds["HEADLESS_CMS"] = "hcms";
74
75
  AppIds["JOURNEY_OPTIMIZER"] = "cjm-home";
75
76
  AppIds["JOURNEY_ORCHESTRATION"] = "journeys";
76
- AppIds["LAUNCH_DATA_COLLECTION"] = "implement";
77
77
  AppIds["LAUNCH_IMPLEMENT"] = "implement";
78
78
  AppIds["LAUNCH_LAUNCH"] = "launch";
79
79
  AppIds["MAGENTO_COMMERCE"] = "magento";
@@ -84,13 +84,13 @@ var AppIds;
84
84
  AppIds["PLACES_SERVICE"] = "places";
85
85
  AppIds["PRIMETIME"] = "primetime";
86
86
  AppIds["PRIVACY_UI"] = "privacyui";
87
- AppIds["PROJECT_FIREFLY_APPS"] = "firefly";
88
87
  AppIds["PROJECT_HUMMINGBIRD"] = "hummingbird";
89
88
  AppIds["PROJECT_SIERRA"] = "cjm-home";
90
89
  AppIds["SOFTWARE_DISTRIBUTION"] = "softwareDistribution";
91
90
  AppIds["SYSTEM_STATUS"] = "systemStatus";
92
91
  AppIds["TARGET"] = "target";
93
92
  AppIds["TRIGGERS"] = "triggers";
93
+ AppIds["WORKFRONT"] = "workfront";
94
94
  })(AppIds = exports.AppIds || (exports.AppIds = {}));
95
95
  const appapi = {
96
96
  get: params => {
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,MA+CX;AA/CD,WAAY,MAAM;IAChB,yBAAe,CAAA;IACf,wCAA8B,CAAA;IAC9B,oDAA0C,CAAA;IAC1C,iDAAuC,CAAA;IACvC,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,kDAAwC,CAAA;IACxC,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,uCAA6B,CAAA;IAC7B,mCAAyB,CAAA;IACzB,iCAAuB,CAAA;IACvB,kCAAwB,CAAA;IACxB,0CAAgC,CAAA;IAChC,6CAAmC,CAAA;IACnC,qCAA2B,CAAA;IAC3B,wDAA8C,CAAA;IAC9C,wCAA8B,CAAA;IAC9B,2BAAiB,CAAA;IACjB,+BAAqB,CAAA;AACvB,CAAC,EA/CW,MAAM,GAAN,cAAM,KAAN,cAAM,QA+CjB;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"}
1
+ {"version":3,"file":"appapi.js","sourceRoot":"","sources":["appapi.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,yCAAqC;AAiCrC,0DAA0D;AAC1D,IAAY,MA+CX;AA/CD,WAAY,MAAM;IAChB,yBAAe,CAAA;IACf,wCAA8B,CAAA;IAC9B,oDAA0C,CAAA;IAC1C,iDAAuC,CAAA;IACvC,uCAA6B,CAAA;IAC7B,iCAAuB,CAAA;IACvB,yCAA+B,CAAA;IAC/B,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,kDAAwC,CAAA;IACxC,4DAAkD,CAAA;IAClD,gDAAsC,CAAA;IACtC,sDAA4C,CAAA;IAC5C,+BAAqB,CAAA;IACrB,wCAA8B,CAAA;IAC9B,4CAAkC,CAAA;IAClC,wCAA8B,CAAA;IAC9B,kCAAwB,CAAA;IACxB,sCAA4B,CAAA;IAC5B,oCAA0B,CAAA;IAC1B,2BAAiB,CAAA;IACjB,2BAAiB,CAAA;IACjB,uCAA6B,CAAA;IAC7B,mCAAyB,CAAA;IACzB,iCAAuB,CAAA;IACvB,kCAAwB,CAAA;IACxB,6CAAmC,CAAA;IACnC,qCAA2B,CAAA;IAC3B,wDAA8C,CAAA;IAC9C,wCAA8B,CAAA;IAC9B,2BAAiB,CAAA;IACjB,+BAAqB,CAAA;IACrB,iCAAuB,CAAA;AACzB,CAAC,EA/CW,MAAM,GAAN,cAAM,KAAN,cAAM,QA+CjB;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"}
@@ -31,6 +31,7 @@ export declare enum CapabilityNames {
31
31
  COMPONENTS = "Components",
32
32
  CONTROLRULES = "Rules",
33
33
  DASHBOARD = "Dashboards",
34
+ DATACLEANSING = "Data cleansing",
34
35
  DATAFLOW = "Dataflows",
35
36
  DATASET = "Datasets",
36
37
  DATASTREAMS = "Datastreams",
@@ -77,6 +78,7 @@ export declare enum CapabilityIds {
77
78
  COMPONENTS = "components",
78
79
  CONTROLRULES = "controlRules",
79
80
  DASHBOARD = "dashboard",
81
+ DATACLEANSING = "dataCleansing",
80
82
  DATAFLOW = "dataflow",
81
83
  DATASET = "dataset",
82
84
  DATASTREAMS = "datastreams",
package/capabilityapi.js CHANGED
@@ -57,6 +57,7 @@ var CapabilityNames;
57
57
  CapabilityNames["COMPONENTS"] = "Components";
58
58
  CapabilityNames["CONTROLRULES"] = "Rules";
59
59
  CapabilityNames["DASHBOARD"] = "Dashboards";
60
+ CapabilityNames["DATACLEANSING"] = "Data cleansing";
60
61
  CapabilityNames["DATAFLOW"] = "Dataflows";
61
62
  CapabilityNames["DATASET"] = "Datasets";
62
63
  CapabilityNames["DATASTREAMS"] = "Datastreams";
@@ -105,6 +106,7 @@ var CapabilityIds;
105
106
  CapabilityIds["COMPONENTS"] = "components";
106
107
  CapabilityIds["CONTROLRULES"] = "controlRules";
107
108
  CapabilityIds["DASHBOARD"] = "dashboard";
109
+ CapabilityIds["DATACLEANSING"] = "dataCleansing";
108
110
  CapabilityIds["DATAFLOW"] = "dataflow";
109
111
  CapabilityIds["DATASET"] = "dataset";
110
112
  CapabilityIds["DATASTREAMS"] = "datastreams";
@@ -1 +1 @@
1
- {"version":3,"file":"capabilityapi.js","sourceRoot":"","sources":["capabilityapi.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,yCAAqC;AAarC,iDAAiD;AACjD,IAAY,eA6CX;AA7CD,WAAY,eAAe;IACzB,8CAA2B,CAAA;IAC3B,2CAAwB,CAAA;IACxB,mCAAgB,CAAA;IAChB,2DAAwC,CAAA;IACxC,gDAA6B,CAAA;IAC7B,+CAA4B,CAAA;IAC5B,oCAAiB,CAAA;IACjB,0CAAuB,CAAA;IACvB,4CAAyB,CAAA;IACzB,4CAAyB,CAAA;IACzB,yCAAsB,CAAA;IACtB,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,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,wCAAqB,CAAA;IACrB,qCAAkB,CAAA;IAClB,uCAAoB,CAAA;IACpB,wDAAqC,CAAA;IACrC,uCAAoB,CAAA;IACpB,wCAAqB,CAAA;IACrB,qCAAkB,CAAA;IAClB,sDAAmC,CAAA;IACnC,8CAA2B,CAAA;IAC3B,yCAAsB,CAAA;AACxB,CAAC,EA7CW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QA6C1B;AAED,iDAAiD;AACjD,IAAY,aA6CX;AA7CD,WAAY,aAAa;IACvB,kDAAiC,CAAA;IACjC,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,wDAAuC,CAAA;IACvC,8CAA6B,CAAA;IAC7B,4CAA2B,CAAA;IAC3B,kCAAiB,CAAA;IACjB,wCAAuB,CAAA;IACvB,sDAAqC,CAAA;IACrC,0CAAyB,CAAA;IACzB,8CAA6B,CAAA;IAC7B,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,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,oCAAmB,CAAA;IACnB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;IACnB,sDAAqC,CAAA;IACrC,oCAAmB,CAAA;IACnB,sCAAqB,CAAA;IACrB,kCAAiB,CAAA;IACjB,gDAA+B,CAAA;IAC/B,4CAA2B,CAAA;IAC3B,sCAAqB,CAAA;AACvB,CAAC,EA7CW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QA6CxB;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"}
1
+ {"version":3,"file":"capabilityapi.js","sourceRoot":"","sources":["capabilityapi.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,yCAAqC;AAarC,iDAAiD;AACjD,IAAY,eA8CX;AA9CD,WAAY,eAAe;IACzB,8CAA2B,CAAA;IAC3B,2CAAwB,CAAA;IACxB,mCAAgB,CAAA;IAChB,2DAAwC,CAAA;IACxC,gDAA6B,CAAA;IAC7B,+CAA4B,CAAA;IAC5B,oCAAiB,CAAA;IACjB,0CAAuB,CAAA;IACvB,4CAAyB,CAAA;IACzB,4CAAyB,CAAA;IACzB,yCAAsB,CAAA;IACtB,2CAAwB,CAAA;IACxB,mDAAgC,CAAA;IAChC,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,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,wCAAqB,CAAA;IACrB,qCAAkB,CAAA;IAClB,uCAAoB,CAAA;IACpB,wDAAqC,CAAA;IACrC,uCAAoB,CAAA;IACpB,wCAAqB,CAAA;IACrB,qCAAkB,CAAA;IAClB,sDAAmC,CAAA;IACnC,8CAA2B,CAAA;IAC3B,yCAAsB,CAAA;AACxB,CAAC,EA9CW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QA8C1B;AAED,iDAAiD;AACjD,IAAY,aA8CX;AA9CD,WAAY,aAAa;IACvB,kDAAiC,CAAA;IACjC,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,wDAAuC,CAAA;IACvC,8CAA6B,CAAA;IAC7B,4CAA2B,CAAA;IAC3B,kCAAiB,CAAA;IACjB,wCAAuB,CAAA;IACvB,sDAAqC,CAAA;IACrC,0CAAyB,CAAA;IACzB,8CAA6B,CAAA;IAC7B,wCAAuB,CAAA;IACvB,gDAA+B,CAAA;IAC/B,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,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,oCAAmB,CAAA;IACnB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;IACnB,sDAAqC,CAAA;IACrC,oCAAmB,CAAA;IACnB,sCAAqB,CAAA;IACrB,kCAAiB,CAAA;IACjB,gDAA+B,CAAA;IAC/B,4CAA2B,CAAA;IAC3B,sCAAqB,CAAA;AACvB,CAAC,EA9CW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QA8CxB;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/component.d.ts ADDED
@@ -0,0 +1,53 @@
1
+ /*************************************************************************
2
+ * Copyright 2022 Adobe
3
+ * All Rights Reserved.
4
+ *
5
+ * NOTICE: Adobe permits you to use, modify, and distribute this file in
6
+ * accordance with the terms of the Adobe license agreement accompanying
7
+ * it. If you have received this file from a source other than Adobe,
8
+ * then your use, modification, or distribution of it requires the prior
9
+ * written permission of Adobe.
10
+ **************************************************************************/
11
+ export declare enum COMPONENT {
12
+ EMAIL_DESIGNER = "cjm-email-designer"
13
+ }
14
+ /**
15
+ * Defines the data argument that is passed to the open function.
16
+ */
17
+ export interface OpenDataParam {
18
+ componentPath?: string;
19
+ [key: string]: any;
20
+ }
21
+ /**
22
+ * Defines component APIs available to solutions.
23
+ */
24
+ export interface ComponentApi {
25
+ /**
26
+ * Tells the Unified Shell to close the component modal.
27
+ *
28
+ * ```typescript
29
+ * component.close({some: 'data'});
30
+ * ```
31
+ */
32
+ close(data?: any): void;
33
+ /**
34
+ * Tells the calling application if it is loaded as a component.
35
+ *
36
+ * ```typescript
37
+ * component.isComponent();
38
+ * ```
39
+ */
40
+ isComponent(): boolean;
41
+ /**
42
+ * Tells the Unifed Shell to open the specified component within an iframe in
43
+ * a modal. Promise is resolved when the component modal is closed.
44
+ *
45
+ * ```typescript
46
+ * component.open(COMPONENT.EMAIL_DESIGNER, {item: 'value'}).then((data: Record<string, any>) => {
47
+ * // Handle the data
48
+ * });
49
+ */
50
+ open(component: COMPONENT, data?: Record<string, any>): Promise<Record<string, any> | undefined>;
51
+ }
52
+ declare const component: ComponentApi;
53
+ export default component;
package/component.js ADDED
@@ -0,0 +1,72 @@
1
+ "use strict";
2
+ /*************************************************************************
3
+ * Copyright 2022 Adobe
4
+ * All Rights Reserved.
5
+ *
6
+ * NOTICE: Adobe permits you to use, modify, and distribute this file in
7
+ * accordance with the terms of the Adobe license agreement accompanying
8
+ * it. If you have received this file from a source other than Adobe,
9
+ * then your use, modification, or distribution of it requires the prior
10
+ * written permission of Adobe.
11
+ **************************************************************************/
12
+ Object.defineProperty(exports, "__esModule", { value: true });
13
+ exports.COMPONENT = void 0;
14
+ /**
15
+ * APIs that let solutions manage the opening and closing of the component frame modal.
16
+ *
17
+ * ***Import:***
18
+ *
19
+ * ```typescript
20
+ * import component from '@adobe/exc-app/component';
21
+ * ```
22
+ *
23
+ * ***Default export:***
24
+ *
25
+ * [ComponentApi](../interfaces/component.componentapi.md#interface-componentapi)
26
+ *
27
+ * ***Usage:***
28
+ *
29
+ * ```typescript
30
+ * import component from '@adobe/exc-app/component';
31
+ *
32
+ * component.open(COMPONENT.EMAIL_DESIGNER).then((data: Record<string, any>) => {
33
+ * // Handle the data
34
+ * });
35
+ * component.close({some: 'data'});
36
+ * ```
37
+ *
38
+ * Can optionally open the component to a non-default route by including
39
+ * `componentPath` with the bootstrap data argument in the open function. All
40
+ * data passed in this argument will be provided to the component in the READY
41
+ * event in the `componentBootstrapData` property.
42
+ *
43
+ * ```typescript
44
+ * const bootstrapData = {
45
+ * componentPath: '/some/path/in/component',
46
+ * propertyForComponent: 'value'
47
+ * };
48
+ * component.open(COMPONENT.EMAIL_DESIGNER, bootstrapData).then((data: Record<string, any>) => {
49
+ * // Handle the data
50
+ * });
51
+ * ```
52
+ * @packageDocumentation
53
+ * @module component
54
+ */
55
+ const Global_1 = require("./src/Global");
56
+ var COMPONENT;
57
+ (function (COMPONENT) {
58
+ COMPONENT["EMAIL_DESIGNER"] = "cjm-email-designer";
59
+ })(COMPONENT = exports.COMPONENT || (exports.COMPONENT = {}));
60
+ const component = {
61
+ close: (data) => {
62
+ return Global_1.getImpl('component')().close(data);
63
+ },
64
+ isComponent: () => {
65
+ return Global_1.getImpl('component')().isComponent();
66
+ },
67
+ open: (comp, data) => {
68
+ return Global_1.getImpl('component')().open(comp, data);
69
+ }
70
+ };
71
+ exports.default = component;
72
+ //# sourceMappingURL=component.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"component.js","sourceRoot":"","sources":["component.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,yCAAqC;AAErC,IAAY,SAEX;AAFD,WAAY,SAAS;IACnB,kDAAqC,CAAA;AACvC,CAAC,EAFW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAEpB;AA4CD,MAAM,SAAS,GAAG;IAChB,KAAK,EAAE,CAAC,IAAU,EAAE,EAAE;QACpB,OAAO,gBAAO,CAAC,WAAW,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IACD,WAAW,EAAE,GAAG,EAAE;QAChB,OAAO,gBAAO,CAAC,WAAW,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC;IAC9C,CAAC;IACD,IAAI,EAAE,CAAC,IAAe,EAAE,IAAoB,EAAE,EAAE;QAC9C,OAAO,gBAAO,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;CACc,CAAC;AAElB,kBAAe,SAAS,CAAC"}
@@ -36,13 +36,13 @@
36
36
  * [HEADLESS\_CMS](appapi.appids.md#headless_cms)
37
37
  * [JOURNEY\_OPTIMIZER](appapi.appids.md#journey_optimizer)
38
38
  * [JOURNEY\_ORCHESTRATION](appapi.appids.md#journey_orchestration)
39
- * [LAUNCH\_DATA\_COLLECTION](appapi.appids.md#launch_data_collection)
40
39
  * [LAUNCH\_IMPLEMENT](appapi.appids.md#launch_implement)
41
40
  * [LAUNCH\_LAUNCH](appapi.appids.md#launch_launch)
42
41
  * [MAGENTO\_COMMERCE](appapi.appids.md#magento_commerce)
43
42
  * [MARKETO\_ENGAGE](appapi.appids.md#marketo_engage)
44
43
  * [OFFERS](appapi.appids.md#offers)
45
44
  * [PEOPLE](appapi.appids.md#people)
45
+ * [PERMISSIONS](appapi.appids.md#permissions)
46
46
  * [PLACES\_SERVICE](appapi.appids.md#places_service)
47
47
  * [PRIMETIME](appapi.appids.md#primetime)
48
48
  * [PRIVACY\_UI](appapi.appids.md#privacy_ui)
@@ -224,12 +224,6 @@ ___
224
224
 
225
225
  ___
226
226
 
227
- ### LAUNCH\_DATA\_COLLECTION
228
-
229
- • **LAUNCH\_DATA\_COLLECTION**: = "implement"
230
-
231
- ___
232
-
233
227
  ### LAUNCH\_IMPLEMENT
234
228
 
235
229
  • **LAUNCH\_IMPLEMENT**: = "implement"
@@ -266,6 +260,12 @@ ___
266
260
 
267
261
  ___
268
262
 
263
+ ### PERMISSIONS
264
+
265
+ • **PERMISSIONS**: = "permissionsUI"
266
+
267
+ ___
268
+
269
269
  ### PLACES\_SERVICE
270
270
 
271
271
  • **PLACES\_SERVICE**: = "places"
@@ -0,0 +1,24 @@
1
+ **[@adobe/exc-app](../README.md)**
2
+
3
+ > [Globals](../README.md) / [network](../modules/network.md) / StandardVariables
4
+
5
+ # Enumeration: StandardVariables
6
+
7
+ ## Index
8
+
9
+ ### Enumeration members
10
+
11
+ * [ACP\_FD](network.standardvariables.md#acp_fd)
12
+ * [CACHED\_TS](network.standardvariables.md#cached_ts)
13
+
14
+ ## Enumeration members
15
+
16
+ ### ACP\_FD
17
+
18
+ • **ACP\_FD**: = "acpFulfillableData"
19
+
20
+ ___
21
+
22
+ ### CACHED\_TS
23
+
24
+ • **CACHED\_TS**: = "cached.createdAt"
@@ -0,0 +1,32 @@
1
+ **[@adobe/exc-app](../README.md)**
2
+
3
+ > [Globals](../README.md) / [network](../modules/network.md) / DataDedupConfig
4
+
5
+ # Interface: DataDedupConfig
6
+
7
+ ## Hierarchy
8
+
9
+ * **DataDedupConfig**
10
+
11
+ ## Index
12
+
13
+ ### Properties
14
+
15
+ * [arrayElement](network.datadedupconfig.md#arrayelement)
16
+ * [keyField](network.datadedupconfig.md#keyfield)
17
+
18
+ ## Properties
19
+
20
+ ### arrayElement
21
+
22
+ • **arrayElement**: string
23
+
24
+ An array of elements that needs to be merged and deduped across fresh and cached data.
25
+
26
+ ___
27
+
28
+ ### keyField
29
+
30
+ • **keyField**: string
31
+
32
+ A key that will be used to deduplicate the array element.
@@ -0,0 +1,129 @@
1
+ **[@adobe/exc-app](../README.md)**
2
+
3
+ > [Globals](../README.md) / [network](../modules/network.md) / DataPrefetchContract
4
+
5
+ # Interface: DataPrefetchContract<T\>
6
+
7
+ Defines a data contract which will be executed by Unified Shell on behalf ot the requesting application.
8
+
9
+ ## Type parameters
10
+
11
+ Name |
12
+ ------ |
13
+ `T` |
14
+
15
+ ## Hierarchy
16
+
17
+ * **DataPrefetchContract**
18
+
19
+ ## Index
20
+
21
+ ### Properties
22
+
23
+ * [defaultValue](network.dataprefetchcontract.md#defaultvalue)
24
+ * [expiry](network.dataprefetchcontract.md#expiry)
25
+ * [fetchWhen](network.dataprefetchcontract.md#fetchwhen)
26
+ * [gql](network.dataprefetchcontract.md#gql)
27
+ * [isSensitive](network.dataprefetchcontract.md#issensitive)
28
+ * [key](network.dataprefetchcontract.md#key)
29
+ * [refreshData](network.dataprefetchcontract.md#refreshdata)
30
+ * [revalidate](network.dataprefetchcontract.md#revalidate)
31
+ * [scope](network.dataprefetchcontract.md#scope)
32
+ * [shared](network.dataprefetchcontract.md#shared)
33
+
34
+ ## Properties
35
+
36
+ ### defaultValue
37
+
38
+ • **defaultValue**: T
39
+
40
+ Default value to return if the data execution is skipped.
41
+
42
+ ___
43
+
44
+ ### expiry
45
+
46
+ • **expiry**: [CacheExpiry](../modules/cache.md#cacheexpiry)
47
+
48
+ Cache expiry. Can be one of the set values defined by the Cache API, or a numeric cache ttl (in seconds).
49
+
50
+ ___
51
+
52
+ ### fetchWhen
53
+
54
+ • `Optional` **fetchWhen**: [FetchCondition](network.fetchcondition.md)
55
+
56
+ Defines the conditions when certain data can be fetched.
57
+ When conditions are not met, the default value above will be returned (But not cached).
58
+
59
+ ___
60
+
61
+ ### gql
62
+
63
+ • `Optional` **gql**: [QueryDefinition](network.querydefinition.md)
64
+
65
+ GraphQL used to fulfill this data contract.
66
+ Note: Currently GraphQL is the only supported method for data contracts.
67
+
68
+ ___
69
+
70
+ ### isSensitive
71
+
72
+ • **isSensitive**: boolean
73
+
74
+ Is the data sensitive? (PII or other sensitive data).
75
+ Sensitive data can only be cached in the browser's session storage
76
+ Non-sensitive data can be cached in the standard Cache storage.
77
+
78
+ ___
79
+
80
+ ### key
81
+
82
+ • **key**: string
83
+
84
+ Unique key associated with this contract.
85
+ Will be used by the calling application to get access to the data.
86
+
87
+ ___
88
+
89
+ ### refreshData
90
+
91
+ • `Optional` **refreshData**: undefined \| { dedup?: [DataDedupConfig](network.datadedupconfig.md) ; gql?: [QueryDefinition](network.querydefinition.md) ; keepOriginal?: string[] }
92
+
93
+ Defines specific behavior for refresh.
94
+ This is optional, by default refreshing data and fetching new will yield the same results.
95
+
96
+ ___
97
+
98
+ ### revalidate
99
+
100
+ • **revalidate**: { enabled: boolean ; immediate?: undefined \| false \| true ; revalidateAfterSec?: undefined \| number }
101
+
102
+ When true, data will be fetched even when a cache is available.
103
+ In this case, the query will return the cached data and at the same time fetch fresh data from the network.
104
+ (stale-while-revalidate strategy)
105
+
106
+ #### Type declaration:
107
+
108
+ Name | Type | Description |
109
+ ------ | ------ | ------ |
110
+ `enabled` | boolean | When true, data will be fetched even when a cache is available. In this case, the query will return the cached data and at the same time fetch fresh data from the network. (stale-while-revalidate strategy) |
111
+ `immediate?` | undefined \| false \| true | If true, revalidation will be done right away If false, revalidation will be done when the browser is idle (On browsers where requestIdleCallback is supported, otherwise right away) Optional - Defaults to false |
112
+ `revalidateAfterSec?` | undefined \| number | Used in conjunction with revalidate = true. Threshold for revalidating data from the network. When set the query will return the cached data and if the cache is older than the set threshold, fetch fresh data from the network. Optional - Defaults to 0 (immediate) |
113
+
114
+ ___
115
+
116
+ ### scope
117
+
118
+ • **scope**: CacheScope
119
+
120
+ Cache scope as defined by the Cache API.
121
+
122
+ ___
123
+
124
+ ### shared
125
+
126
+ • **shared**: boolean
127
+
128
+ If true, this data will be accessible to all experience cloud applications.
129
+ Otherwise, data will be cached against the requesting application.
@@ -0,0 +1,27 @@
1
+ **[@adobe/exc-app](../README.md)**
2
+
3
+ > [Globals](../README.md) / [network](../modules/network.md) / FetchCondition
4
+
5
+ # Interface: FetchCondition
6
+
7
+ Defines the conditions when certain data can be fetched.
8
+ When conditions are not met, default data will be returned but not cached.
9
+
10
+ ## Hierarchy
11
+
12
+ * **FetchCondition**
13
+
14
+ ## Index
15
+
16
+ ### Properties
17
+
18
+ * [serviceCodes](network.fetchcondition.md#servicecodes)
19
+
20
+ ## Properties
21
+
22
+ ### serviceCodes
23
+
24
+ • `Optional` **serviceCodes**: string \| string[]
25
+
26
+ Service Codes that needs to be present (For the current org) in order to execute the query.
27
+ This is useful when a query only makes sense if a certain product is provisioned for the current user.
@@ -10,6 +10,8 @@ GQL Query containing graphql query and variables.
10
10
 
11
11
  * **GraphQLQuery**
12
12
 
13
+ ↳ [QueryDefinition](network.querydefinition.md)
14
+
13
15
  ## Index
14
16
 
15
17
  ### Properties
@@ -14,6 +14,7 @@
14
14
 
15
15
  * [fetch](network.networkapi.md#fetch)
16
16
  * [getApolloClient](network.networkapi.md#getapolloclient)
17
+ * [getPrefetched](network.networkapi.md#getprefetched)
17
18
  * [query](network.networkapi.md#query)
18
19
 
19
20
  ## Methods
@@ -87,6 +88,34 @@ GraphQL query response
87
88
 
88
89
  ___
89
90
 
91
+ ### getPrefetched
92
+
93
+ ▸ **getPrefetched**<T\>(`key`: string, `options?`: [PrefetchOptions](network.prefetchoptions.md)): Promise<[PrefetchResponse](../modules/network.md#prefetchresponse)<T\>\>
94
+
95
+ Provides an interface for querying known data.
96
+ Data querying and caching are managed in Unified Shell in advance.
97
+
98
+ This is an experimental feature.
99
+
100
+ #### Type parameters:
101
+
102
+ Name |
103
+ ------ |
104
+ `T` |
105
+
106
+ #### Parameters:
107
+
108
+ Name | Type | Description |
109
+ ------ | ------ | ------ |
110
+ `key` | string | Data Contract key |
111
+ `options?` | [PrefetchOptions](network.prefetchoptions.md) | Prefetch options |
112
+
113
+ **Returns:** Promise<[PrefetchResponse](../modules/network.md#prefetchresponse)<T\>\>
114
+
115
+ Promise for the contract execution response
116
+
117
+ ___
118
+
90
119
  ### query
91
120
 
92
121
  ▸ **query**(`request`: [QueryRequest](network.queryrequest.md)): Promise<Response\>
@@ -0,0 +1,34 @@
1
+ **[@adobe/exc-app](../README.md)**
2
+
3
+ > [Globals](../README.md) / [network](../modules/network.md) / PrefetchOptions
4
+
5
+ # Interface: PrefetchOptions
6
+
7
+ Data prefetch options
8
+
9
+ ## Hierarchy
10
+
11
+ * **PrefetchOptions**
12
+
13
+ ## Index
14
+
15
+ ### Properties
16
+
17
+ * [createdAfter](network.prefetchoptions.md#createdafter)
18
+ * [revalidateImmediately](network.prefetchoptions.md#revalidateimmediately)
19
+
20
+ ## Properties
21
+
22
+ ### createdAfter
23
+
24
+ • `Optional` **createdAfter**: undefined \| number
25
+
26
+ Must return recent data - Created after provided time
27
+
28
+ ___
29
+
30
+ ### revalidateImmediately
31
+
32
+ • `Optional` **revalidateImmediately**: undefined \| false \| true
33
+
34
+ If returning cached result, revalidate immediatelly.