@adobe/exc-app 1.0.0 → 1.0.3
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/RuntimeConfiguration.d.ts +4 -0
- package/appapi.d.ts +1 -0
- package/appapi.js +1 -0
- package/appapi.js.map +1 -1
- package/cache.d.ts +128 -0
- package/cache.js +128 -0
- package/cache.js.map +1 -0
- package/capabilityapi.d.ts +4 -0
- package/capabilityapi.js +4 -0
- package/capabilityapi.js.map +1 -1
- package/docs/README.md +1 -0
- package/docs/enums/appapi.appids.md +7 -0
- package/docs/enums/capabilityapi.capabilityids.md +14 -0
- package/docs/enums/capabilityapi.capabilitynames.md +14 -0
- package/docs/enums/network.routing.md +21 -1
- package/docs/interfaces/cache.cacheapi.md +81 -0
- package/docs/interfaces/cache.cacheparameters.md +36 -0
- package/docs/interfaces/cache.cachesetparameters.md +65 -0
- package/docs/interfaces/network.apolloclientoptions.md +7 -0
- package/docs/interfaces/network.queryrequest.md +9 -0
- package/docs/interfaces/root.modules.md +7 -0
- package/docs/interfaces/root.runtimeconfiguration.md +9 -0
- package/docs/modules/cache.md +85 -0
- package/docs/modules/network.md +7 -0
- package/network.d.ts +18 -1
- package/network.js +11 -0
- package/network.js.map +1 -1
- package/package.json +4 -4
- package/settings.js +2 -6
- package/settings.js.map +1 -1
- package/src/Global.d.ts +2 -0
- package/src/Global.js.map +1 -1
- package/tests/cache.test.d.ts +1 -0
- package/tests/cache.test.js +66 -0
- package/tests/cache.test.js.map +1 -0
- package/tests/permissions.test.js +1 -5
- package/tests/permissions.test.js.map +1 -1
- package/tests/pulse.test.js +23 -11
- package/tests/pulse.test.js.map +1 -1
- package/tests/session.test.d.ts +1 -0
- package/tests/session.test.js +64 -0
- package/tests/session.test.js.map +1 -0
- package/version.d.ts +1 -1
- package/version.js +1 -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
package/appapi.js
CHANGED
|
@@ -48,6 +48,7 @@ var AppIds;
|
|
|
48
48
|
AppIds["ADMIN"] = "admin";
|
|
49
49
|
AppIds["ADMIN_CONSOLE"] = "adminconsole";
|
|
50
50
|
AppIds["ADOBE_EXPERIENCE_CLOUD_GRIFFON"] = "griffon";
|
|
51
|
+
AppIds["ADOBE_EXPERIENCE_PLATFORM"] = "project-m";
|
|
51
52
|
AppIds["ADVERTISING_CLOUD"] = "adcloud";
|
|
52
53
|
AppIds["ANALYTICS"] = "analytics";
|
|
53
54
|
AppIds["ASSETS"] = "assets";
|
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,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"}
|
package/cache.d.ts
ADDED
|
@@ -0,0 +1,128 @@
|
|
|
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
|
+
* Cache data for the duration of the current IMS session only
|
|
42
|
+
* Data will not be available once the user has logged in again.
|
|
43
|
+
*/
|
|
44
|
+
IMS_SESSION = -1,
|
|
45
|
+
/**
|
|
46
|
+
* Default - One week
|
|
47
|
+
*/
|
|
48
|
+
DEFAULT = 604800,
|
|
49
|
+
/**
|
|
50
|
+
* Cache data for an hour.
|
|
51
|
+
*/
|
|
52
|
+
HOUR = 3600,
|
|
53
|
+
/**
|
|
54
|
+
* Cache data for a day.
|
|
55
|
+
*/
|
|
56
|
+
DAY = 86400,
|
|
57
|
+
/**
|
|
58
|
+
* Cache data for a week.
|
|
59
|
+
*/
|
|
60
|
+
WEEK = 604800,
|
|
61
|
+
/**
|
|
62
|
+
* Cache data for a month (30 days actual).
|
|
63
|
+
*/
|
|
64
|
+
MONTH = 2592000
|
|
65
|
+
}
|
|
66
|
+
export declare type CacheExpiry = CacheTTL | number;
|
|
67
|
+
/**
|
|
68
|
+
* Input parameters for the Cache get and delete APIs.
|
|
69
|
+
*/
|
|
70
|
+
export interface CacheParameters {
|
|
71
|
+
/**
|
|
72
|
+
* Cache key.
|
|
73
|
+
*/
|
|
74
|
+
key: string;
|
|
75
|
+
/**
|
|
76
|
+
* Cache scope (Optional - Defaults to user).
|
|
77
|
+
*/
|
|
78
|
+
scope?: CacheScope;
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* Input parameters for the Cache set API.
|
|
82
|
+
*/
|
|
83
|
+
export interface CacheSetParameters<T> extends CacheParameters {
|
|
84
|
+
/**
|
|
85
|
+
* Cache expiry. Can be one of the set values defined by CacheTTL, or a numeric cache ttl (in seconds).
|
|
86
|
+
* Optional - Defaults to one week.
|
|
87
|
+
*/
|
|
88
|
+
expiry?: CacheExpiry;
|
|
89
|
+
/**
|
|
90
|
+
* Data to cache. Data must be serializable (JSON).
|
|
91
|
+
*/
|
|
92
|
+
value: T;
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* Cache entry (Returned by the get API).
|
|
96
|
+
*/
|
|
97
|
+
export declare type CacheEntry<T> = {
|
|
98
|
+
createdAt: number;
|
|
99
|
+
key: string;
|
|
100
|
+
value: T;
|
|
101
|
+
} & ({
|
|
102
|
+
expiresAt: number;
|
|
103
|
+
} | {
|
|
104
|
+
expireBySession: true;
|
|
105
|
+
});
|
|
106
|
+
/**
|
|
107
|
+
* APIs for managing a client side persisted cache.
|
|
108
|
+
*/
|
|
109
|
+
export interface CacheApi {
|
|
110
|
+
/**
|
|
111
|
+
* Deletes a value from the cache (If available).
|
|
112
|
+
* @param params Parameters used to identify the cached item to delete.
|
|
113
|
+
*/
|
|
114
|
+
delete(params: CacheParameters): Promise<void>;
|
|
115
|
+
/**
|
|
116
|
+
* Gets a value from the cache if one is available.
|
|
117
|
+
* @param params Parameters used to identify the cached item to retrieve.
|
|
118
|
+
* @returns A promise that resolves to the specified value, or undefined if none exist.
|
|
119
|
+
*/
|
|
120
|
+
get<T>(params: CacheParameters): Promise<CacheEntry<T> | undefined>;
|
|
121
|
+
/**
|
|
122
|
+
* Stores a value in the cache.
|
|
123
|
+
* @param params Parameters used to identify the cached item to store and control its TTL.
|
|
124
|
+
*/
|
|
125
|
+
set<T>(params: CacheSetParameters<T>): Promise<void>;
|
|
126
|
+
}
|
|
127
|
+
declare const cache: CacheApi;
|
|
128
|
+
export default cache;
|
package/cache.js
ADDED
|
@@ -0,0 +1,128 @@
|
|
|
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
|
+
* Cache data for the duration of the current IMS session only
|
|
98
|
+
* Data will not be available once the user has logged in again.
|
|
99
|
+
*/
|
|
100
|
+
CacheTTL[CacheTTL["IMS_SESSION"] = -1] = "IMS_SESSION";
|
|
101
|
+
/**
|
|
102
|
+
* Default - One week
|
|
103
|
+
*/
|
|
104
|
+
CacheTTL[CacheTTL["DEFAULT"] = 604800] = "DEFAULT";
|
|
105
|
+
/**
|
|
106
|
+
* Cache data for an hour.
|
|
107
|
+
*/
|
|
108
|
+
CacheTTL[CacheTTL["HOUR"] = 3600] = "HOUR";
|
|
109
|
+
/**
|
|
110
|
+
* Cache data for a day.
|
|
111
|
+
*/
|
|
112
|
+
CacheTTL[CacheTTL["DAY"] = 86400] = "DAY";
|
|
113
|
+
/**
|
|
114
|
+
* Cache data for a week.
|
|
115
|
+
*/
|
|
116
|
+
CacheTTL[CacheTTL["WEEK"] = 604800] = "WEEK";
|
|
117
|
+
/**
|
|
118
|
+
* Cache data for a month (30 days actual).
|
|
119
|
+
*/
|
|
120
|
+
CacheTTL[CacheTTL["MONTH"] = 2592000] = "MONTH";
|
|
121
|
+
})(CacheTTL = exports.CacheTTL || (exports.CacheTTL = {}));
|
|
122
|
+
const cache = {
|
|
123
|
+
delete: params => Global_1.getImpl('cache')().delete(params),
|
|
124
|
+
get: params => Global_1.getImpl('cache')().get(params),
|
|
125
|
+
set: params => Global_1.getImpl('cache')().set(params)
|
|
126
|
+
};
|
|
127
|
+
exports.default = cache;
|
|
128
|
+
//# 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,QA0BX;AA1BD,WAAY,QAAQ;IAClB;;;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,EA1BW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QA0BnB;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"}
|
package/capabilityapi.d.ts
CHANGED
|
@@ -26,6 +26,7 @@ export declare enum CapabilityNames {
|
|
|
26
26
|
APPLICATIONS = "Applications",
|
|
27
27
|
APPSURFACES = "App Surfaces",
|
|
28
28
|
ASSETS = "Assets",
|
|
29
|
+
CAMPAIGNS = "Campaigns",
|
|
29
30
|
CLIENTPROPERTIES = "Tags",
|
|
30
31
|
COMPONENTS = "Components",
|
|
31
32
|
CONTROLRULES = "Rules",
|
|
@@ -60,6 +61,7 @@ export declare enum CapabilityNames {
|
|
|
60
61
|
SETTINGS = "Channels",
|
|
61
62
|
SOURCE = "Sources",
|
|
62
63
|
SUBSCRIPTIONS = "Subscription list",
|
|
64
|
+
UNIFIEDTAGS = "UnifiedTags",
|
|
63
65
|
WORKFLOW = "Workflows"
|
|
64
66
|
}
|
|
65
67
|
export declare enum CapabilityIds {
|
|
@@ -70,6 +72,7 @@ export declare enum CapabilityIds {
|
|
|
70
72
|
APPLICATIONS = "applications",
|
|
71
73
|
APPSURFACES = "appsurfaces",
|
|
72
74
|
ASSETS = "assets",
|
|
75
|
+
CAMPAIGNS = "campaigns",
|
|
73
76
|
CLIENTPROPERTIES = "clientproperties",
|
|
74
77
|
COMPONENTS = "components",
|
|
75
78
|
CONTROLRULES = "controlRules",
|
|
@@ -104,6 +107,7 @@ export declare enum CapabilityIds {
|
|
|
104
107
|
SETTINGS = "settings",
|
|
105
108
|
SOURCE = "source",
|
|
106
109
|
SUBSCRIPTIONS = "subscriptions",
|
|
110
|
+
UNIFIEDTAGS = "unifiedTags",
|
|
107
111
|
WORKFLOW = "workflow"
|
|
108
112
|
}
|
|
109
113
|
export interface CapabilityApi {
|
package/capabilityapi.js
CHANGED
|
@@ -52,6 +52,7 @@ var CapabilityNames;
|
|
|
52
52
|
CapabilityNames["APPLICATIONS"] = "Applications";
|
|
53
53
|
CapabilityNames["APPSURFACES"] = "App Surfaces";
|
|
54
54
|
CapabilityNames["ASSETS"] = "Assets";
|
|
55
|
+
CapabilityNames["CAMPAIGNS"] = "Campaigns";
|
|
55
56
|
CapabilityNames["CLIENTPROPERTIES"] = "Tags";
|
|
56
57
|
CapabilityNames["COMPONENTS"] = "Components";
|
|
57
58
|
CapabilityNames["CONTROLRULES"] = "Rules";
|
|
@@ -86,6 +87,7 @@ var CapabilityNames;
|
|
|
86
87
|
CapabilityNames["SETTINGS"] = "Channels";
|
|
87
88
|
CapabilityNames["SOURCE"] = "Sources";
|
|
88
89
|
CapabilityNames["SUBSCRIPTIONS"] = "Subscription list";
|
|
90
|
+
CapabilityNames["UNIFIEDTAGS"] = "UnifiedTags";
|
|
89
91
|
CapabilityNames["WORKFLOW"] = "Workflows";
|
|
90
92
|
})(CapabilityNames = exports.CapabilityNames || (exports.CapabilityNames = {}));
|
|
91
93
|
// This list is dynamically generated in preBuild
|
|
@@ -98,6 +100,7 @@ var CapabilityIds;
|
|
|
98
100
|
CapabilityIds["APPLICATIONS"] = "applications";
|
|
99
101
|
CapabilityIds["APPSURFACES"] = "appsurfaces";
|
|
100
102
|
CapabilityIds["ASSETS"] = "assets";
|
|
103
|
+
CapabilityIds["CAMPAIGNS"] = "campaigns";
|
|
101
104
|
CapabilityIds["CLIENTPROPERTIES"] = "clientproperties";
|
|
102
105
|
CapabilityIds["COMPONENTS"] = "components";
|
|
103
106
|
CapabilityIds["CONTROLRULES"] = "controlRules";
|
|
@@ -132,6 +135,7 @@ var CapabilityIds;
|
|
|
132
135
|
CapabilityIds["SETTINGS"] = "settings";
|
|
133
136
|
CapabilityIds["SOURCE"] = "source";
|
|
134
137
|
CapabilityIds["SUBSCRIPTIONS"] = "subscriptions";
|
|
138
|
+
CapabilityIds["UNIFIEDTAGS"] = "unifiedTags";
|
|
135
139
|
CapabilityIds["WORKFLOW"] = "workflow";
|
|
136
140
|
})(CapabilityIds = exports.CapabilityIds || (exports.CapabilityIds = {}));
|
|
137
141
|
const capabilityapi = {
|
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,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
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
* [ADMIN](appapi.appids.md#admin)
|
|
12
12
|
* [ADMIN\_CONSOLE](appapi.appids.md#admin_console)
|
|
13
13
|
* [ADOBE\_EXPERIENCE\_CLOUD\_GRIFFON](appapi.appids.md#adobe_experience_cloud_griffon)
|
|
14
|
+
* [ADOBE\_EXPERIENCE\_PLATFORM](appapi.appids.md#adobe_experience_platform)
|
|
14
15
|
* [ADVERTISING\_CLOUD](appapi.appids.md#advertising_cloud)
|
|
15
16
|
* [ANALYTICS](appapi.appids.md#analytics)
|
|
16
17
|
* [ASSETS](appapi.appids.md#assets)
|
|
@@ -73,6 +74,12 @@ ___
|
|
|
73
74
|
|
|
74
75
|
___
|
|
75
76
|
|
|
77
|
+
### ADOBE\_EXPERIENCE\_PLATFORM
|
|
78
|
+
|
|
79
|
+
• **ADOBE\_EXPERIENCE\_PLATFORM**: = "project-m"
|
|
80
|
+
|
|
81
|
+
___
|
|
82
|
+
|
|
76
83
|
### ADVERTISING\_CLOUD
|
|
77
84
|
|
|
78
85
|
• **ADVERTISING\_CLOUD**: = "adcloud"
|
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
* [APPLICATIONS](capabilityapi.capabilityids.md#applications)
|
|
16
16
|
* [APPSURFACES](capabilityapi.capabilityids.md#appsurfaces)
|
|
17
17
|
* [ASSETS](capabilityapi.capabilityids.md#assets)
|
|
18
|
+
* [CAMPAIGNS](capabilityapi.capabilityids.md#campaigns)
|
|
18
19
|
* [CLIENTPROPERTIES](capabilityapi.capabilityids.md#clientproperties)
|
|
19
20
|
* [COMPONENTS](capabilityapi.capabilityids.md#components)
|
|
20
21
|
* [CONTROLRULES](capabilityapi.capabilityids.md#controlrules)
|
|
@@ -49,6 +50,7 @@
|
|
|
49
50
|
* [SETTINGS](capabilityapi.capabilityids.md#settings)
|
|
50
51
|
* [SOURCE](capabilityapi.capabilityids.md#source)
|
|
51
52
|
* [SUBSCRIPTIONS](capabilityapi.capabilityids.md#subscriptions)
|
|
53
|
+
* [UNIFIEDTAGS](capabilityapi.capabilityids.md#unifiedtags)
|
|
52
54
|
* [WORKFLOW](capabilityapi.capabilityids.md#workflow)
|
|
53
55
|
|
|
54
56
|
## Enumeration members
|
|
@@ -95,6 +97,12 @@ ___
|
|
|
95
97
|
|
|
96
98
|
___
|
|
97
99
|
|
|
100
|
+
### CAMPAIGNS
|
|
101
|
+
|
|
102
|
+
• **CAMPAIGNS**: = "campaigns"
|
|
103
|
+
|
|
104
|
+
___
|
|
105
|
+
|
|
98
106
|
### CLIENTPROPERTIES
|
|
99
107
|
|
|
100
108
|
• **CLIENTPROPERTIES**: = "clientproperties"
|
|
@@ -299,6 +307,12 @@ ___
|
|
|
299
307
|
|
|
300
308
|
___
|
|
301
309
|
|
|
310
|
+
### UNIFIEDTAGS
|
|
311
|
+
|
|
312
|
+
• **UNIFIEDTAGS**: = "unifiedTags"
|
|
313
|
+
|
|
314
|
+
___
|
|
315
|
+
|
|
302
316
|
### WORKFLOW
|
|
303
317
|
|
|
304
318
|
• **WORKFLOW**: = "workflow"
|
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
* [APPLICATIONS](capabilityapi.capabilitynames.md#applications)
|
|
16
16
|
* [APPSURFACES](capabilityapi.capabilitynames.md#appsurfaces)
|
|
17
17
|
* [ASSETS](capabilityapi.capabilitynames.md#assets)
|
|
18
|
+
* [CAMPAIGNS](capabilityapi.capabilitynames.md#campaigns)
|
|
18
19
|
* [CLIENTPROPERTIES](capabilityapi.capabilitynames.md#clientproperties)
|
|
19
20
|
* [COMPONENTS](capabilityapi.capabilitynames.md#components)
|
|
20
21
|
* [CONTROLRULES](capabilityapi.capabilitynames.md#controlrules)
|
|
@@ -49,6 +50,7 @@
|
|
|
49
50
|
* [SETTINGS](capabilityapi.capabilitynames.md#settings)
|
|
50
51
|
* [SOURCE](capabilityapi.capabilitynames.md#source)
|
|
51
52
|
* [SUBSCRIPTIONS](capabilityapi.capabilitynames.md#subscriptions)
|
|
53
|
+
* [UNIFIEDTAGS](capabilityapi.capabilitynames.md#unifiedtags)
|
|
52
54
|
* [WORKFLOW](capabilityapi.capabilitynames.md#workflow)
|
|
53
55
|
|
|
54
56
|
## Enumeration members
|
|
@@ -95,6 +97,12 @@ ___
|
|
|
95
97
|
|
|
96
98
|
___
|
|
97
99
|
|
|
100
|
+
### CAMPAIGNS
|
|
101
|
+
|
|
102
|
+
• **CAMPAIGNS**: = "Campaigns"
|
|
103
|
+
|
|
104
|
+
___
|
|
105
|
+
|
|
98
106
|
### CLIENTPROPERTIES
|
|
99
107
|
|
|
100
108
|
• **CLIENTPROPERTIES**: = "Tags"
|
|
@@ -299,6 +307,12 @@ ___
|
|
|
299
307
|
|
|
300
308
|
___
|
|
301
309
|
|
|
310
|
+
### UNIFIEDTAGS
|
|
311
|
+
|
|
312
|
+
• **UNIFIEDTAGS**: = "UnifiedTags"
|
|
313
|
+
|
|
314
|
+
___
|
|
315
|
+
|
|
302
316
|
### WORKFLOW
|
|
303
317
|
|
|
304
318
|
• **WORKFLOW**: = "Workflows"
|
|
@@ -9,9 +9,29 @@
|
|
|
9
9
|
### Enumeration members
|
|
10
10
|
|
|
11
11
|
* [AEP\_PROFILE\_BASED](network.routing.md#aep_profile_based)
|
|
12
|
+
* [DEFAULT](network.routing.md#default)
|
|
13
|
+
* [REGION\_BASED\_PER\_QUERY](network.routing.md#region_based_per_query)
|
|
12
14
|
|
|
13
15
|
## Enumeration members
|
|
14
16
|
|
|
15
17
|
### AEP\_PROFILE\_BASED
|
|
16
18
|
|
|
17
|
-
• **AEP\_PROFILE\_BASED**:
|
|
19
|
+
• **AEP\_PROFILE\_BASED**:
|
|
20
|
+
|
|
21
|
+
Route by the AEP region found in the user profile
|
|
22
|
+
|
|
23
|
+
___
|
|
24
|
+
|
|
25
|
+
### DEFAULT
|
|
26
|
+
|
|
27
|
+
• **DEFAULT**:
|
|
28
|
+
|
|
29
|
+
Default routing - Latency based.
|
|
30
|
+
|
|
31
|
+
___
|
|
32
|
+
|
|
33
|
+
### REGION\_BASED\_PER\_QUERY
|
|
34
|
+
|
|
35
|
+
• **REGION\_BASED\_PER\_QUERY**:
|
|
36
|
+
|
|
37
|
+
Specify region in query (Client Side routing)
|
|
@@ -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).
|