@adobe/exc-app 1.0.2 → 1.0.4-beta2

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 (52) hide show
  1. package/RuntimeConfiguration.d.ts +8 -0
  2. package/appapi.d.ts +1 -0
  3. package/appapi.js +1 -0
  4. package/appapi.js.map +1 -1
  5. package/cache.d.ts +132 -0
  6. package/cache.js +132 -0
  7. package/cache.js.map +1 -0
  8. package/capabilityapi.d.ts +2 -0
  9. package/capabilityapi.js +2 -0
  10. package/capabilityapi.js.map +1 -1
  11. package/docs/README.md +1 -0
  12. package/docs/enums/capabilityapi.capabilityids.md +7 -0
  13. package/docs/enums/capabilityapi.capabilitynames.md +7 -0
  14. package/docs/interfaces/cache.cacheapi.md +81 -0
  15. package/docs/interfaces/cache.cacheparameters.md +36 -0
  16. package/docs/interfaces/cache.cachesetparameters.md +65 -0
  17. package/docs/interfaces/network.apolloclientoptions.md +7 -0
  18. package/docs/interfaces/root.modules.md +7 -0
  19. package/docs/interfaces/root.runtimeconfiguration.md +9 -0
  20. package/docs/modules/cache.md +85 -0
  21. package/network/DataContract.d.ts +35 -0
  22. package/network/DataContract.js +3 -0
  23. package/network/DataContract.js.map +1 -0
  24. package/network/DataPrefetchContract.d.ts +110 -0
  25. package/network/DataPrefetchContract.js +3 -0
  26. package/network/DataPrefetchContract.js.map +1 -0
  27. package/network.d.ts +21 -0
  28. package/network.js +14 -1
  29. package/network.js.map +1 -1
  30. package/package.json +1 -1
  31. package/settings.js +2 -6
  32. package/settings.js.map +1 -1
  33. package/shell.d.ts +2 -0
  34. package/shell.js.map +1 -1
  35. package/src/Global.d.ts +2 -0
  36. package/src/Global.js.map +1 -1
  37. package/tests/cache.test.d.ts +1 -0
  38. package/tests/cache.test.js +66 -0
  39. package/tests/cache.test.js.map +1 -0
  40. package/tests/network.test.d.ts +1 -0
  41. package/tests/network.test.js +77 -0
  42. package/tests/network.test.js.map +1 -0
  43. package/tests/permissions.test.js +1 -5
  44. package/tests/permissions.test.js.map +1 -1
  45. package/tests/pulse.test.js +23 -11
  46. package/tests/pulse.test.js.map +1 -1
  47. package/tests/session.test.d.ts +1 -0
  48. package/tests/session.test.js +64 -0
  49. package/tests/session.test.js.map +1 -0
  50. package/version.d.ts +1 -1
  51. package/version.js +1 -1
  52. package/version.js.map +1 -1
@@ -114,10 +114,18 @@ export interface RuntimeConfiguration {
114
114
  * Solution iframe src url
115
115
  */
116
116
  baseFrameUrl: string;
117
+ /**
118
+ * Base path of the baseUrl property, without tenant or URL context.
119
+ */
120
+ basePath: string;
117
121
  /**
118
122
  * Base URL
119
123
  */
120
124
  baseUrl: string;
125
+ /**
126
+ * Environment specific CDN string.
127
+ */
128
+ cdn: string;
121
129
  /**
122
130
  * List all properties changed in this configuration compared to the previous one sent
123
131
  */
package/appapi.d.ts CHANGED
@@ -74,6 +74,7 @@ export declare enum AppIds {
74
74
  MARKETO_ENGAGE = "marketo",
75
75
  OFFERS = "offers",
76
76
  PEOPLE = "people",
77
+ PERMISSIONS = "permissionsUI",
77
78
  PLACES_SERVICE = "places",
78
79
  PRIMETIME = "primetime",
79
80
  PRIVACY_UI = "privacyui",
package/appapi.js CHANGED
@@ -80,6 +80,7 @@ var AppIds;
80
80
  AppIds["MARKETO_ENGAGE"] = "marketo";
81
81
  AppIds["OFFERS"] = "offers";
82
82
  AppIds["PEOPLE"] = "people";
83
+ AppIds["PERMISSIONS"] = "permissionsUI";
83
84
  AppIds["PLACES_SERVICE"] = "places";
84
85
  AppIds["PRIMETIME"] = "primetime";
85
86
  AppIds["PRIVACY_UI"] = "privacyui";
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,MA8CX;AA9CD,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,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,EA9CW,MAAM,GAAN,cAAM,KAAN,cAAM,QA8CjB;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,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"}
package/cache.d.ts ADDED
@@ -0,0 +1,132 @@
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
+ /**
12
+ * @ignore
13
+ */
14
+ export declare enum CacheScope {
15
+ /**
16
+ * Default - Same as USER
17
+ */
18
+ DEFAULT = "user",
19
+ /**
20
+ * Cache data at the IMS Org level.
21
+ */
22
+ ORG = "org",
23
+ /**
24
+ * Cache data at the AEP Sandbox level.
25
+ */
26
+ SANDBOX = "sandbox",
27
+ /**
28
+ * Cache data at the Sub Org level.
29
+ */
30
+ SUBORG = "suborg",
31
+ /**
32
+ * Cache data at the user level.
33
+ */
34
+ USER = "user"
35
+ }
36
+ /**
37
+ * @ignore
38
+ */
39
+ export declare enum CacheTTL {
40
+ /**
41
+ * Disable caching for this value.
42
+ */
43
+ DONT_CACHE = 0,
44
+ /**
45
+ * Cache data for the duration of the current IMS session only
46
+ * Data will not be available once the user has logged in again.
47
+ */
48
+ IMS_SESSION = -1,
49
+ /**
50
+ * Default - One week
51
+ */
52
+ DEFAULT = 604800,
53
+ /**
54
+ * Cache data for an hour.
55
+ */
56
+ HOUR = 3600,
57
+ /**
58
+ * Cache data for a day.
59
+ */
60
+ DAY = 86400,
61
+ /**
62
+ * Cache data for a week.
63
+ */
64
+ WEEK = 604800,
65
+ /**
66
+ * Cache data for a month (30 days actual).
67
+ */
68
+ MONTH = 2592000
69
+ }
70
+ export declare type CacheExpiry = CacheTTL | number;
71
+ /**
72
+ * Input parameters for the Cache get and delete APIs.
73
+ */
74
+ export interface CacheParameters {
75
+ /**
76
+ * Cache key.
77
+ */
78
+ key: string;
79
+ /**
80
+ * Cache scope (Optional - Defaults to user).
81
+ */
82
+ scope?: CacheScope;
83
+ }
84
+ /**
85
+ * Input parameters for the Cache set API.
86
+ */
87
+ export interface CacheSetParameters<T> extends CacheParameters {
88
+ /**
89
+ * Cache expiry. Can be one of the set values defined by CacheTTL, or a numeric cache ttl (in seconds).
90
+ * Optional - Defaults to one week.
91
+ */
92
+ expiry?: CacheExpiry;
93
+ /**
94
+ * Data to cache. Data must be serializable (JSON).
95
+ */
96
+ value: T;
97
+ }
98
+ /**
99
+ * Cache entry (Returned by the get API).
100
+ */
101
+ export declare type CacheEntry<T> = {
102
+ createdAt: number;
103
+ key: string;
104
+ value: T;
105
+ } & ({
106
+ expiresAt: number;
107
+ } | {
108
+ expireBySession: true;
109
+ });
110
+ /**
111
+ * APIs for managing a client side persisted cache.
112
+ */
113
+ export interface CacheApi {
114
+ /**
115
+ * Deletes a value from the cache (If available).
116
+ * @param params Parameters used to identify the cached item to delete.
117
+ */
118
+ delete(params: CacheParameters): Promise<void>;
119
+ /**
120
+ * Gets a value from the cache if one is available.
121
+ * @param params Parameters used to identify the cached item to retrieve.
122
+ * @returns A promise that resolves to the specified value, or undefined if none exist.
123
+ */
124
+ get<T>(params: CacheParameters): Promise<CacheEntry<T> | undefined>;
125
+ /**
126
+ * Stores a value in the cache.
127
+ * @param params Parameters used to identify the cached item to store and control its TTL.
128
+ */
129
+ set<T>(params: CacheSetParameters<T>): Promise<void>;
130
+ }
131
+ declare const cache: CacheApi;
132
+ export default cache;
package/cache.js ADDED
@@ -0,0 +1,132 @@
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.CacheTTL = exports.CacheScope = void 0;
14
+ /**
15
+ * APIs for managing a client side persisted cache.
16
+ * Unified Shell will store the data against its own domain, which allows data caching
17
+ * even when the actual app runs on a domain which is 3rd party to Unified Shell's.
18
+ *
19
+ * For example, the API will work in Chrome incognito when Unified Shell runs on an adobe.com domain
20
+ * and the embedded applications run on the adobe.net domain.
21
+ *
22
+ * These APIs utilizes the [Browser Cache API](https://developer.mozilla.org/en-US/docs/Web/API/Cache) under the hood and are all run asynchronously.
23
+ *
24
+ * If migrating from Local Storage to Cache API, make sure all the app logic is async first.
25
+ *
26
+ * NOTE: This API should not be used to cache any PII data to comply with Adobe privacy policies.
27
+ *
28
+ * To consume this API, add the following import to your code.
29
+ *
30
+ * ```typescript
31
+ * import cache from '@adobe/exc-app/cache';
32
+ * ```
33
+ *
34
+ * The default export is an object of type [CacheAPI](../interfaces/_cache_.cacheapi.md)
35
+ *
36
+ * API reference: [scroll down](#index)
37
+ *
38
+ * ### Sample code
39
+ *
40
+ * ```typescript
41
+ * import cache, {CacheTTL, CacheScope} from '@adobe/exc-app/cache';
42
+ *
43
+ * // By default, cached data is tied to the user and cached for a week.
44
+ * await cache.set<MyType>({key: 'some-cache-key', value: myTypeInstance});
45
+ *
46
+ * // Both scope and expiry can be adjusted.
47
+ * await cache.set<MyType>({key: 'some-cache-key', value: myTypeInstance, expiry: CacheTTL.DAY, scope: CacheScope.ORG});
48
+ *
49
+ * // It is also possible to bind cache data to the current IMS session, it will expire when the user logs out.
50
+ * await cache.set<MyType>({key: 'some-cache-key', value: myTypeInstance, expiry: CacheTTL.IMS_SESSION});
51
+ *
52
+ * // Cache get
53
+ * const myData: MyType = await cache.get<MyType>({key: 'some-cache-key'});
54
+ *
55
+ * // Get scope must be identical to the scope used for set - Always use the same scope for both.
56
+ * const myData2: MyType = await cache.get<MyType>({key: 'some-cache-key', scope: CacheScope.ORG});
57
+ *
58
+ * // Cache delete.
59
+ * await cache.delete({key: 'some-cache-key'});
60
+ * ```
61
+ * @packageDocumentation
62
+ * @module cache
63
+ */
64
+ const Global_1 = require("./src/Global");
65
+ /**
66
+ * @ignore
67
+ */
68
+ var CacheScope;
69
+ (function (CacheScope) {
70
+ /**
71
+ * Default - Same as USER
72
+ */
73
+ CacheScope["DEFAULT"] = "user";
74
+ /**
75
+ * Cache data at the IMS Org level.
76
+ */
77
+ CacheScope["ORG"] = "org";
78
+ /**
79
+ * Cache data at the AEP Sandbox level.
80
+ */
81
+ CacheScope["SANDBOX"] = "sandbox";
82
+ /**
83
+ * Cache data at the Sub Org level.
84
+ */
85
+ CacheScope["SUBORG"] = "suborg";
86
+ /**
87
+ * Cache data at the user level.
88
+ */
89
+ CacheScope["USER"] = "user";
90
+ })(CacheScope = exports.CacheScope || (exports.CacheScope = {}));
91
+ /**
92
+ * @ignore
93
+ */
94
+ var CacheTTL;
95
+ (function (CacheTTL) {
96
+ /**
97
+ * Disable caching for this value.
98
+ */
99
+ CacheTTL[CacheTTL["DONT_CACHE"] = 0] = "DONT_CACHE";
100
+ /**
101
+ * Cache data for the duration of the current IMS session only
102
+ * Data will not be available once the user has logged in again.
103
+ */
104
+ CacheTTL[CacheTTL["IMS_SESSION"] = -1] = "IMS_SESSION";
105
+ /**
106
+ * Default - One week
107
+ */
108
+ CacheTTL[CacheTTL["DEFAULT"] = 604800] = "DEFAULT";
109
+ /**
110
+ * Cache data for an hour.
111
+ */
112
+ CacheTTL[CacheTTL["HOUR"] = 3600] = "HOUR";
113
+ /**
114
+ * Cache data for a day.
115
+ */
116
+ CacheTTL[CacheTTL["DAY"] = 86400] = "DAY";
117
+ /**
118
+ * Cache data for a week.
119
+ */
120
+ CacheTTL[CacheTTL["WEEK"] = 604800] = "WEEK";
121
+ /**
122
+ * Cache data for a month (30 days actual).
123
+ */
124
+ CacheTTL[CacheTTL["MONTH"] = 2592000] = "MONTH";
125
+ })(CacheTTL = exports.CacheTTL || (exports.CacheTTL = {}));
126
+ const cache = {
127
+ delete: params => Global_1.getImpl('cache')().delete(params),
128
+ get: params => Global_1.getImpl('cache')().get(params),
129
+ set: params => Global_1.getImpl('cache')().set(params)
130
+ };
131
+ exports.default = cache;
132
+ //# sourceMappingURL=cache.js.map
package/cache.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cache.js","sourceRoot":"","sources":["cache.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AAEH,yCAAqC;AAErC;;GAEG;AACH,IAAY,UAqBX;AArBD,WAAY,UAAU;IACpB;;OAEG;IACH,8BAAgB,CAAA;IAChB;;OAEG;IACH,yBAAW,CAAA;IACX;;OAEG;IACH,iCAAmB,CAAA;IACnB;;OAEG;IACH,+BAAiB,CAAA;IACjB;;OAEG;IACH,2BAAa,CAAA;AACf,CAAC,EArBW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAqBrB;AAED;;GAEG;AACH,IAAY,QA8BX;AA9BD,WAAY,QAAQ;IAClB;;OAEG;IACH,mDAAc,CAAA;IACd;;;OAGG;IACH,sDAAgB,CAAA;IAChB;;OAEG;IACH,kDAAuB,CAAA;IACvB;;OAEG;IACH,0CAAW,CAAA;IACX;;OAEG;IACH,yCAAe,CAAA;IACf;;OAEG;IACH,4CAAoB,CAAA;IACpB;;OAEG;IACH,+CAAsB,CAAA;AACxB,CAAC,EA9BW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QA8BnB;AAiED,MAAM,KAAK,GAAa;IACtB,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,gBAAO,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC;IACnD,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,gBAAO,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC;IAC7C,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,gBAAO,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC;CAC9C,CAAC;AAEF,kBAAe,KAAK,CAAC"}
@@ -61,6 +61,7 @@ export declare enum CapabilityNames {
61
61
  SETTINGS = "Channels",
62
62
  SOURCE = "Sources",
63
63
  SUBSCRIPTIONS = "Subscription list",
64
+ UNIFIEDTAGS = "UnifiedTags",
64
65
  WORKFLOW = "Workflows"
65
66
  }
66
67
  export declare enum CapabilityIds {
@@ -106,6 +107,7 @@ export declare enum CapabilityIds {
106
107
  SETTINGS = "settings",
107
108
  SOURCE = "source",
108
109
  SUBSCRIPTIONS = "subscriptions",
110
+ UNIFIEDTAGS = "unifiedTags",
109
111
  WORKFLOW = "workflow"
110
112
  }
111
113
  export interface CapabilityApi {
package/capabilityapi.js CHANGED
@@ -87,6 +87,7 @@ var CapabilityNames;
87
87
  CapabilityNames["SETTINGS"] = "Channels";
88
88
  CapabilityNames["SOURCE"] = "Sources";
89
89
  CapabilityNames["SUBSCRIPTIONS"] = "Subscription list";
90
+ CapabilityNames["UNIFIEDTAGS"] = "UnifiedTags";
90
91
  CapabilityNames["WORKFLOW"] = "Workflows";
91
92
  })(CapabilityNames = exports.CapabilityNames || (exports.CapabilityNames = {}));
92
93
  // This list is dynamically generated in preBuild
@@ -134,6 +135,7 @@ var CapabilityIds;
134
135
  CapabilityIds["SETTINGS"] = "settings";
135
136
  CapabilityIds["SOURCE"] = "source";
136
137
  CapabilityIds["SUBSCRIPTIONS"] = "subscriptions";
138
+ CapabilityIds["UNIFIEDTAGS"] = "unifiedTags";
137
139
  CapabilityIds["WORKFLOW"] = "workflow";
138
140
  })(CapabilityIds = exports.CapabilityIds || (exports.CapabilityIds = {}));
139
141
  const capabilityapi = {
@@ -1 +1 @@
1
- {"version":3,"file":"capabilityapi.js","sourceRoot":"","sources":["capabilityapi.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,yCAAqC;AAarC,iDAAiD;AACjD,IAAY,eA4CX;AA5CD,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,yCAAsB,CAAA;AACxB,CAAC,EA5CW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QA4C1B;AAED,iDAAiD;AACjD,IAAY,aA4CX;AA5CD,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,sCAAqB,CAAA;AACvB,CAAC,EA5CW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QA4CxB;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,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"}
package/docs/README.md CHANGED
@@ -9,6 +9,7 @@
9
9
  ### Modules
10
10
 
11
11
  * [appapi](modules/appapi.md)
12
+ * [cache](modules/cache.md)
12
13
  * [capabilityapi](modules/capabilityapi.md)
13
14
  * [helpCenter](modules/helpcenter.md)
14
15
  * [ims](modules/ims.md)
@@ -50,6 +50,7 @@
50
50
  * [SETTINGS](capabilityapi.capabilityids.md#settings)
51
51
  * [SOURCE](capabilityapi.capabilityids.md#source)
52
52
  * [SUBSCRIPTIONS](capabilityapi.capabilityids.md#subscriptions)
53
+ * [UNIFIEDTAGS](capabilityapi.capabilityids.md#unifiedtags)
53
54
  * [WORKFLOW](capabilityapi.capabilityids.md#workflow)
54
55
 
55
56
  ## Enumeration members
@@ -306,6 +307,12 @@ ___
306
307
 
307
308
  ___
308
309
 
310
+ ### UNIFIEDTAGS
311
+
312
+ • **UNIFIEDTAGS**: = "unifiedTags"
313
+
314
+ ___
315
+
309
316
  ### WORKFLOW
310
317
 
311
318
  • **WORKFLOW**: = "workflow"
@@ -50,6 +50,7 @@
50
50
  * [SETTINGS](capabilityapi.capabilitynames.md#settings)
51
51
  * [SOURCE](capabilityapi.capabilitynames.md#source)
52
52
  * [SUBSCRIPTIONS](capabilityapi.capabilitynames.md#subscriptions)
53
+ * [UNIFIEDTAGS](capabilityapi.capabilitynames.md#unifiedtags)
53
54
  * [WORKFLOW](capabilityapi.capabilitynames.md#workflow)
54
55
 
55
56
  ## Enumeration members
@@ -306,6 +307,12 @@ ___
306
307
 
307
308
  ___
308
309
 
310
+ ### UNIFIEDTAGS
311
+
312
+ • **UNIFIEDTAGS**: = "UnifiedTags"
313
+
314
+ ___
315
+
309
316
  ### WORKFLOW
310
317
 
311
318
  • **WORKFLOW**: = "Workflows"
@@ -0,0 +1,81 @@
1
+ **[@adobe/exc-app](../README.md)**
2
+
3
+ > [Globals](../README.md) / [cache](../modules/cache.md) / CacheApi
4
+
5
+ # Interface: CacheApi
6
+
7
+ APIs for managing a client side persisted cache.
8
+
9
+ ## Hierarchy
10
+
11
+ * **CacheApi**
12
+
13
+ ## Index
14
+
15
+ ### Methods
16
+
17
+ * [delete](cache.cacheapi.md#delete)
18
+ * [get](cache.cacheapi.md#get)
19
+ * [set](cache.cacheapi.md#set)
20
+
21
+ ## Methods
22
+
23
+ ### delete
24
+
25
+ ▸ **delete**(`params`: [CacheParameters](cache.cacheparameters.md)): Promise<void\>
26
+
27
+ Deletes a value from the cache (If available).
28
+
29
+ #### Parameters:
30
+
31
+ Name | Type | Description |
32
+ ------ | ------ | ------ |
33
+ `params` | [CacheParameters](cache.cacheparameters.md) | Parameters used to identify the cached item to delete. |
34
+
35
+ **Returns:** Promise<void\>
36
+
37
+ ___
38
+
39
+ ### get
40
+
41
+ ▸ **get**<T\>(`params`: [CacheParameters](cache.cacheparameters.md)): Promise<[CacheEntry](../modules/cache.md#cacheentry)<T\> \| undefined\>
42
+
43
+ Gets a value from the cache if one is available.
44
+
45
+ #### Type parameters:
46
+
47
+ Name |
48
+ ------ |
49
+ `T` |
50
+
51
+ #### Parameters:
52
+
53
+ Name | Type | Description |
54
+ ------ | ------ | ------ |
55
+ `params` | [CacheParameters](cache.cacheparameters.md) | Parameters used to identify the cached item to retrieve. |
56
+
57
+ **Returns:** Promise<[CacheEntry](../modules/cache.md#cacheentry)<T\> \| undefined\>
58
+
59
+ A promise that resolves to the specified value, or undefined if none exist.
60
+
61
+ ___
62
+
63
+ ### set
64
+
65
+ ▸ **set**<T\>(`params`: [CacheSetParameters](cache.cachesetparameters.md)<T\>): Promise<void\>
66
+
67
+ Stores a value in the cache.
68
+
69
+ #### Type parameters:
70
+
71
+ Name |
72
+ ------ |
73
+ `T` |
74
+
75
+ #### Parameters:
76
+
77
+ Name | Type | Description |
78
+ ------ | ------ | ------ |
79
+ `params` | [CacheSetParameters](cache.cachesetparameters.md)<T\> | Parameters used to identify the cached item to store and control its TTL. |
80
+
81
+ **Returns:** Promise<void\>
@@ -0,0 +1,36 @@
1
+ **[@adobe/exc-app](../README.md)**
2
+
3
+ > [Globals](../README.md) / [cache](../modules/cache.md) / CacheParameters
4
+
5
+ # Interface: CacheParameters
6
+
7
+ Input parameters for the Cache get and delete APIs.
8
+
9
+ ## Hierarchy
10
+
11
+ * **CacheParameters**
12
+
13
+ ↳ [CacheSetParameters](cache.cachesetparameters.md)
14
+
15
+ ## Index
16
+
17
+ ### Properties
18
+
19
+ * [key](cache.cacheparameters.md#key)
20
+ * [scope](cache.cacheparameters.md#scope)
21
+
22
+ ## Properties
23
+
24
+ ### key
25
+
26
+ • **key**: string
27
+
28
+ Cache key.
29
+
30
+ ___
31
+
32
+ ### scope
33
+
34
+ • `Optional` **scope**: CacheScope
35
+
36
+ Cache scope (Optional - Defaults to user).
@@ -0,0 +1,65 @@
1
+ **[@adobe/exc-app](../README.md)**
2
+
3
+ > [Globals](../README.md) / [cache](../modules/cache.md) / CacheSetParameters
4
+
5
+ # Interface: CacheSetParameters<T\>
6
+
7
+ Input parameters for the Cache set API.
8
+
9
+ ## Type parameters
10
+
11
+ Name |
12
+ ------ |
13
+ `T` |
14
+
15
+ ## Hierarchy
16
+
17
+ * [CacheParameters](cache.cacheparameters.md)
18
+
19
+ ↳ **CacheSetParameters**
20
+
21
+ ## Index
22
+
23
+ ### Properties
24
+
25
+ * [expiry](cache.cachesetparameters.md#expiry)
26
+ * [key](cache.cachesetparameters.md#key)
27
+ * [scope](cache.cachesetparameters.md#scope)
28
+ * [value](cache.cachesetparameters.md#value)
29
+
30
+ ## Properties
31
+
32
+ ### expiry
33
+
34
+ • `Optional` **expiry**: [CacheExpiry](../modules/cache.md#cacheexpiry)
35
+
36
+ Cache expiry. Can be one of the set values defined by CacheTTL, or a numeric cache ttl (in seconds).
37
+ Optional - Defaults to one week.
38
+
39
+ ___
40
+
41
+ ### key
42
+
43
+ • **key**: string
44
+
45
+ *Inherited from [CacheParameters](cache.cacheparameters.md).[key](cache.cacheparameters.md#key)*
46
+
47
+ Cache key.
48
+
49
+ ___
50
+
51
+ ### scope
52
+
53
+ • `Optional` **scope**: CacheScope
54
+
55
+ *Inherited from [CacheParameters](cache.cacheparameters.md).[scope](cache.cacheparameters.md#scope)*
56
+
57
+ Cache scope (Optional - Defaults to user).
58
+
59
+ ___
60
+
61
+ ### value
62
+
63
+ • **value**: T
64
+
65
+ Data to cache. Data must be serializable (JSON).
@@ -15,6 +15,7 @@
15
15
  * [cacheOptions](network.apolloclientoptions.md#cacheoptions)
16
16
  * [connectToDevTools](network.apolloclientoptions.md#connecttodevtools)
17
17
  * [inputApolloLink](network.apolloclientoptions.md#inputapollolink)
18
+ * [xql](network.apolloclientoptions.md#xql)
18
19
 
19
20
  ## Properties
20
21
 
@@ -33,3 +34,9 @@ ___
33
34
  ### inputApolloLink
34
35
 
35
36
  • `Optional` **inputApolloLink**: ApolloLink
37
+
38
+ ___
39
+
40
+ ### xql
41
+
42
+ • `Optional` **xql**: undefined \| false \| true
@@ -13,6 +13,7 @@
13
13
  ### Properties
14
14
 
15
15
  * [appApi](root.modules.md#appapi)
16
+ * [cache](root.modules.md#cache)
16
17
  * [capabilityApi](root.modules.md#capabilityapi)
17
18
  * [default](root.modules.md#default)
18
19
  * [helpCenter](root.modules.md#helpcenter)
@@ -42,6 +43,12 @@
42
43
 
43
44
  ___
44
45
 
46
+ ### cache
47
+
48
+ • `Readonly` **cache**: () => [CacheApi](cache.cacheapi.md)
49
+
50
+ ___
51
+
45
52
  ### capabilityApi
46
53
 
47
54
  • `Readonly` **capabilityApi**: () => [CapabilityApi](capabilityapi.capabilityapi-1.md)
@@ -19,6 +19,7 @@ External Runtime Configuration Interface
19
19
  * [appContainer](root.runtimeconfiguration.md#appcontainer)
20
20
  * [appId](root.runtimeconfiguration.md#appid)
21
21
  * [baseFrameUrl](root.runtimeconfiguration.md#baseframeurl)
22
+ * [basePath](root.runtimeconfiguration.md#basepath)
22
23
  * [baseUrl](root.runtimeconfiguration.md#baseurl)
23
24
  * [changedProperties](root.runtimeconfiguration.md#changedproperties)
24
25
  * [discovery](root.runtimeconfiguration.md#discovery)
@@ -100,6 +101,14 @@ Solution iframe src url
100
101
 
101
102
  ___
102
103
 
104
+ ### basePath
105
+
106
+ • **basePath**: string
107
+
108
+ Base path of the baseUrl property, without tenant or URL context.
109
+
110
+ ___
111
+
103
112
  ### baseUrl
104
113
 
105
114
  • **baseUrl**: string