@adobe/exc-app 1.2.10 → 1.3.1

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 (47) hide show
  1. package/.eslintrc.js +18 -3
  2. package/RuntimeConfiguration.d.ts +16 -0
  3. package/appapi.d.ts +4 -0
  4. package/appapi.js +4 -0
  5. package/appapi.js.map +1 -1
  6. package/build/preBuild.js +3 -1
  7. package/cache.js +1 -1
  8. package/cache.js.map +1 -1
  9. package/capabilityapi.d.ts +4 -0
  10. package/capabilityapi.js +4 -0
  11. package/capabilityapi.js.map +1 -1
  12. package/docs/interfaces/network.graphqlquery.md +4 -4
  13. package/docs/interfaces/network.networkapi.md +7 -7
  14. package/docs/interfaces/network.querydefinition.md +4 -4
  15. package/docs/interfaces/network.queryrequest.md +3 -3
  16. package/docs/interfaces/topbar.topbarapi.md +10 -2
  17. package/docs/interfaces/topbar.topbarapiproperties.md +26 -3
  18. package/docs/modules/network.md +10 -10
  19. package/featureflags.d.ts +20 -3
  20. package/featureflags.js +13 -0
  21. package/featureflags.js.map +1 -1
  22. package/metrics/Configuration.d.ts +1 -1
  23. package/network.d.ts +65 -30
  24. package/network.js +12 -8
  25. package/network.js.map +1 -1
  26. package/package.json +10 -9
  27. package/page.d.ts +10 -0
  28. package/page.js +12 -1
  29. package/page.js.map +1 -1
  30. package/sidenav.d.ts +8 -0
  31. package/sidenav.js.map +1 -1
  32. package/tests/appapi.test.js +4 -4
  33. package/tests/appapi.test.js.map +1 -1
  34. package/tests/capabilityapi.test.js +6 -6
  35. package/tests/capabilityapi.test.js.map +1 -1
  36. package/tests/featureflags.test.js +18 -0
  37. package/tests/featureflags.test.js.map +1 -1
  38. package/tests/network.test.js +10 -0
  39. package/tests/network.test.js.map +1 -1
  40. package/topbar.d.ts +46 -2
  41. package/topbar.js +19 -0
  42. package/topbar.js.map +1 -1
  43. package/user.d.ts +3 -1
  44. package/user.js.map +1 -1
  45. package/version.d.ts +1 -1
  46. package/version.js +1 -1
  47. package/version.js.map +1 -1
package/.eslintrc.js CHANGED
@@ -16,8 +16,8 @@ let rulesDirPlugin = require('eslint-plugin-rulesdir');
16
16
  rulesDirPlugin.RULES_DIR = path.join(__dirname, 'bin');
17
17
 
18
18
  module.exports = {
19
- plugins: ['header', 'import', 'jsdoc', 'prettier', 'rulesdir', '@typescript-eslint'],
20
19
  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
20
+ plugins: ['header', 'import', 'jsdoc', 'prettier', 'rulesdir', '@typescript-eslint'],
21
21
  parser: '@typescript-eslint/parser',
22
22
  parserOptions: {
23
23
  sourceType: 'module'
@@ -35,6 +35,17 @@ module.exports = {
35
35
  }
36
36
  }
37
37
  },
38
+ overrides: [
39
+ {
40
+ files: [
41
+ 'appapi.ts',
42
+ 'capabilityapi.ts'
43
+ ],
44
+ rules: {
45
+ '@typescript-eslint/no-duplicate-enum-values': 'OFF'
46
+ }
47
+ }
48
+ ],
38
49
  rules: {
39
50
  'comma-dangle': ERROR,
40
51
  'comma-spacing': ERROR,
@@ -66,6 +77,12 @@ module.exports = {
66
77
  'object-shorthand': [ERROR, 'properties'],
67
78
  'quote-props': [ERROR, 'as-needed'],
68
79
  quotes: [ERROR, 'single', {allowTemplateLiterals: true}],
80
+ 'no-restricted-imports': [ERROR, {
81
+ patterns: [{
82
+ group: ['@exc/**'],
83
+ message: 'Dont do that please'
84
+ }]
85
+ }],
69
86
  'sort-keys': [ERROR, 'asc', {caseSensitive: false}],
70
87
  'space-before-blocks': ERROR,
71
88
  'space-infix-ops': ERROR,
@@ -73,14 +90,12 @@ module.exports = {
73
90
 
74
91
  // JSDoc
75
92
  "jsdoc/check-alignment": ERROR,
76
- "jsdoc/check-examples": ERROR,
77
93
  "jsdoc/check-indentation": ERROR,
78
94
  "jsdoc/check-param-names": ERROR,
79
95
  "jsdoc/check-property-names": ERROR,
80
96
  "jsdoc/check-syntax": ERROR,
81
97
  "jsdoc/check-tag-names": [ERROR, {definedTags: ['category', 'packageDocumentation', 'preferred']}],
82
98
  "jsdoc/empty-tags": ERROR,
83
- "jsdoc/newline-after-description": [ERROR, 'never'],
84
99
  "jsdoc/no-types": ERROR,
85
100
  "jsdoc/require-description-complete-sentence": OFF, // WARN,
86
101
  "jsdoc/require-description": ERROR,
@@ -35,6 +35,11 @@ export interface Gainsight {
35
35
  * Unified Shell environment.
36
36
  */
37
37
  environment: string;
38
+ /**
39
+ * Is product key different from parent? This is used in Data Collection when Gainsight
40
+ * is initialized.
41
+ */
42
+ isKeyDifferentFromParent?: boolean;
38
43
  /**
39
44
  * OMEGA suite ID.
40
45
  */
@@ -202,6 +207,13 @@ export interface AnalyticsConfiguration {
202
207
  }
203
208
  export interface NestedAppConfig extends AnalyticsConfiguration {
204
209
  appId: string;
210
+ gainsight?: {
211
+ productKey: string;
212
+ triggers?: {
213
+ fulfillableItems: string[];
214
+ serviceCode: string;
215
+ };
216
+ };
205
217
  }
206
218
  /**
207
219
  * External Runtime Configuration Interface
@@ -231,6 +243,10 @@ export interface RuntimeConfiguration {
231
243
  * Solution appId
232
244
  */
233
245
  appId: string;
246
+ /**
247
+ * User's avatar url
248
+ */
249
+ avatar: string;
234
250
  /**
235
251
  * Solution iframe src url
236
252
  */
package/appapi.d.ts CHANGED
@@ -52,6 +52,7 @@ export declare enum AppIds {
52
52
  CAMPAIGN_CONTROL_PANEL = "accp",
53
53
  CLOUD_MANAGER = "cloudManagerUi",
54
54
  COMMERCE = "commerceInstanceDiscovery",
55
+ CONTENT_HUB = "contentHub",
55
56
  CONVERSATIONAL_EXPERIENCE = "conversationalexperience",
56
57
  CUSTOMER_JOURNEY_ANALYTICS = "platformAnalytics",
57
58
  CUSTOMER_JOURNEY_MANAGEMENT = "cjm-home",
@@ -60,6 +61,7 @@ export declare enum AppIds {
60
61
  EXCHANGE = "exchange",
61
62
  EXPERIENCE_CLOUD = "landing",
62
63
  EXPERIENCE_MANAGER = "experienceManagerUI",
64
+ EXPERIENCE_MANAGER_AEMGENERATEVARIATIONS = "aemGenerateVariations",
63
65
  EXPERIENCE_MANAGER_AEMSHELL = "aemshell",
64
66
  EXPERIENCE_MANAGER_AEMXMNGR = "aemxmngr",
65
67
  EXPERIENCE_MANAGER_AEM_CF_ADMIN = "aem-cf-admin",
@@ -82,7 +84,9 @@ export declare enum AppIds {
82
84
  PRIMETIME = "primetime",
83
85
  PRIVACY_UI = "privacyui",
84
86
  PROJECT_HUMMINGBIRD = "hummingbird",
87
+ PROJECT_SAPPHIRE = "sapphireUI",
85
88
  PROJECT_SIERRA = "cjm-home",
89
+ SEARCH_SOCIAL_COMMERCE = "advertising-ssc",
86
90
  SOFTWARE_DISTRIBUTION = "softwareDistribution",
87
91
  SYSTEM_STATUS = "systemStatus",
88
92
  TARGET = "target",
package/appapi.js CHANGED
@@ -58,6 +58,7 @@ var AppIds;
58
58
  AppIds["CAMPAIGN_CONTROL_PANEL"] = "accp";
59
59
  AppIds["CLOUD_MANAGER"] = "cloudManagerUi";
60
60
  AppIds["COMMERCE"] = "commerceInstanceDiscovery";
61
+ AppIds["CONTENT_HUB"] = "contentHub";
61
62
  AppIds["CONVERSATIONAL_EXPERIENCE"] = "conversationalexperience";
62
63
  AppIds["CUSTOMER_JOURNEY_ANALYTICS"] = "platformAnalytics";
63
64
  AppIds["CUSTOMER_JOURNEY_MANAGEMENT"] = "cjm-home";
@@ -66,6 +67,7 @@ var AppIds;
66
67
  AppIds["EXCHANGE"] = "exchange";
67
68
  AppIds["EXPERIENCE_CLOUD"] = "landing";
68
69
  AppIds["EXPERIENCE_MANAGER"] = "experienceManagerUI";
70
+ AppIds["EXPERIENCE_MANAGER_AEMGENERATEVARIATIONS"] = "aemGenerateVariations";
69
71
  AppIds["EXPERIENCE_MANAGER_AEMSHELL"] = "aemshell";
70
72
  AppIds["EXPERIENCE_MANAGER_AEMXMNGR"] = "aemxmngr";
71
73
  AppIds["EXPERIENCE_MANAGER_AEM_CF_ADMIN"] = "aem-cf-admin";
@@ -88,7 +90,9 @@ var AppIds;
88
90
  AppIds["PRIMETIME"] = "primetime";
89
91
  AppIds["PRIVACY_UI"] = "privacyui";
90
92
  AppIds["PROJECT_HUMMINGBIRD"] = "hummingbird";
93
+ AppIds["PROJECT_SAPPHIRE"] = "sapphireUI";
91
94
  AppIds["PROJECT_SIERRA"] = "cjm-home";
95
+ AppIds["SEARCH_SOCIAL_COMMERCE"] = "advertising-ssc";
92
96
  AppIds["SOFTWARE_DISTRIBUTION"] = "softwareDistribution";
93
97
  AppIds["SYSTEM_STATUS"] = "systemStatus";
94
98
  AppIds["TARGET"] = "target";
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,MAmDX;AAnDD,WAAY,MAAM;IAChB,yBAAe,CAAA;IACf,wCAA8B,CAAA;IAC9B,oDAA0C,CAAA;IAC1C,uCAA6B,CAAA;IAC7B,iCAAuB,CAAA;IACvB,yCAA+B,CAAA;IAC/B,2BAAiB,CAAA;IACjB,oCAA0B,CAAA;IAC1B,8CAAoC,CAAA;IACpC,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,0CAAgC,CAAA;IAChC,gDAAsC,CAAA;IACtC,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,kDAAwC,CAAA;IACxC,0DAAgD,CAAA;IAChD,4DAAkD,CAAA;IAClD,4DAAkD,CAAA;IAClD,4CAAkC,CAAA;IAClC,gDAAsC,CAAA;IACtC,sDAA4C,CAAA;IAC5C,+BAAqB,CAAA;IACrB,wCAA8B,CAAA;IAC9B,4CAAkC,CAAA;IAClC,wCAA8B,CAAA;IAC9B,6BAAmB,CAAA;IACnB,0CAAgC,CAAA;IAChC,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,2BAAiB,CAAA;IACjB,2BAAiB,CAAA;IACjB,uCAA6B,CAAA;IAC7B,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;IACvB,qCAA2B,CAAA;AAC7B,CAAC,EAnDW,MAAM,GAAN,cAAM,KAAN,cAAM,QAmDjB;AAWD,MAAM,MAAM,GAAW;IACrB,GAAG,EAAE,MAAM,CAAC,EAAE;QACZ,OAAO,IAAA,gBAAO,EAAC,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,MAuDX;AAvDD,WAAY,MAAM;IAChB,yBAAe,CAAA;IACf,wCAA8B,CAAA;IAC9B,oDAA0C,CAAA;IAC1C,uCAA6B,CAAA;IAC7B,iCAAuB,CAAA;IACvB,yCAA+B,CAAA;IAC/B,2BAAiB,CAAA;IACjB,oCAA0B,CAAA;IAC1B,8CAAoC,CAAA;IACpC,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,0CAAgC,CAAA;IAChC,gDAAsC,CAAA;IACtC,oCAA0B,CAAA;IAC1B,gEAAsD,CAAA;IACtD,0DAAgD,CAAA;IAChD,kDAAwC,CAAA;IACxC,kDAAwC,CAAA;IACxC,sCAA4B,CAAA;IAC5B,+BAAqB,CAAA;IACrB,sCAA4B,CAAA;IAC5B,oDAA0C,CAAA;IAC1C,4EAAkE,CAAA;IAClE,kDAAwC,CAAA;IACxC,kDAAwC,CAAA;IACxC,0DAAgD,CAAA;IAChD,4DAAkD,CAAA;IAClD,4DAAkD,CAAA;IAClD,4CAAkC,CAAA;IAClC,gDAAsC,CAAA;IACtC,sDAA4C,CAAA;IAC5C,+BAAqB,CAAA;IACrB,wCAA8B,CAAA;IAC9B,4CAAkC,CAAA;IAClC,wCAA8B,CAAA;IAC9B,6BAAmB,CAAA;IACnB,0CAAgC,CAAA;IAChC,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,2BAAiB,CAAA;IACjB,2BAAiB,CAAA;IACjB,uCAA6B,CAAA;IAC7B,iCAAuB,CAAA;IACvB,kCAAwB,CAAA;IACxB,6CAAmC,CAAA;IACnC,yCAA+B,CAAA;IAC/B,qCAA2B,CAAA;IAC3B,oDAA0C,CAAA;IAC1C,wDAA8C,CAAA;IAC9C,wCAA8B,CAAA;IAC9B,2BAAiB,CAAA;IACjB,+BAAqB,CAAA;IACrB,iCAAuB,CAAA;IACvB,qCAA2B,CAAA;AAC7B,CAAC,EAvDW,MAAM,GAAN,cAAM,KAAN,cAAM,QAuDjB;AAWD,MAAM,MAAM,GAAW;IACrB,GAAG,EAAE,MAAM,CAAC,EAAE;QACZ,OAAO,IAAA,gBAAO,EAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;CACF,CAAC;AAEF,kBAAe,MAAM,CAAC"}
package/build/preBuild.js CHANGED
@@ -45,10 +45,12 @@ const DEFAULT_APP_IDS = {
45
45
 
46
46
  function updateName(name) {
47
47
  return name.toUpperCase()
48
+ .replace(/[,&]/g, '')
48
49
  .split(' ')
49
50
  .join('_')
50
51
  .replace(/-/g, '_')
51
- .replace('_/_', '_');
52
+ .replace('_/_', '_')
53
+ .replace(/__/g, '_');
52
54
  }
53
55
 
54
56
  // Launch has two apps with the name Launch but they have unique appIds
package/cache.js CHANGED
@@ -86,7 +86,7 @@ var CacheScope;
86
86
  /**
87
87
  * Cache data at the user level.
88
88
  */
89
- CacheScope["USER"] = "user";
89
+ CacheScope["USER"] = "user"; // eslint-disable-line @typescript-eslint/no-duplicate-enum-values
90
90
  })(CacheScope = exports.CacheScope || (exports.CacheScope = {}));
91
91
  /**
92
92
  * @ignore
package/cache.js.map CHANGED
@@ -1 +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;AAsED,MAAM,KAAK,GAAa;IACtB,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,IAAA,gBAAO,EAAC,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC;IACnD,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,IAAA,gBAAO,EAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC;IAC7C,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,IAAA,gBAAO,EAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC;CAC9C,CAAC;AAEF,kBAAe,KAAK,CAAC"}
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,CAAC,kEAAkE;AAClF,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;AAsED,MAAM,KAAK,GAAa;IACtB,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,IAAA,gBAAO,EAAC,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC;IACnD,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,IAAA,gBAAO,EAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC;IAC7C,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,IAAA,gBAAO,EAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC;CAC9C,CAAC;AAEF,kBAAe,KAAK,CAAC"}
@@ -64,6 +64,7 @@ export declare enum CapabilityNames {
64
64
  NOTEBOOK = "Notebooks",
65
65
  OFFER = "Offers",
66
66
  OFFERACTIVITY = "Components",
67
+ OPTIMIZATIONMETRICS = "Optimization metrics",
67
68
  PERMISSIONSUI = "Permissions",
68
69
  PLACES = "Places",
69
70
  PLATFORMUIENCRYPTION = "Encryption",
@@ -78,6 +79,7 @@ export declare enum CapabilityNames {
78
79
  REPORT = "Reports",
79
80
  REQUEST = "Requests",
80
81
  SANDBOX = "Sandboxes",
82
+ SAPPHIREACCOUNTAUDIENCE = "Account Audiences",
81
83
  SCENARIO = "Scenarios",
82
84
  SCHEMA = "Schemas",
83
85
  SEGMENT = "Segments",
@@ -139,6 +141,7 @@ export declare enum CapabilityIds {
139
141
  NOTEBOOK = "notebook",
140
142
  OFFER = "offer",
141
143
  OFFERACTIVITY = "offeractivity",
144
+ OPTIMIZATIONMETRICS = "optimizationMetrics",
142
145
  PERMISSIONSUI = "permissionsUI",
143
146
  PLACES = "places",
144
147
  PLATFORMUIENCRYPTION = "platformUIEncryption",
@@ -153,6 +156,7 @@ export declare enum CapabilityIds {
153
156
  REPORT = "report",
154
157
  REQUEST = "request",
155
158
  SANDBOX = "sandbox",
159
+ SAPPHIREACCOUNTAUDIENCE = "sapphireAccountAudience",
156
160
  SCENARIO = "scenario",
157
161
  SCHEMA = "schema",
158
162
  SEGMENT = "segment",
package/capabilityapi.js CHANGED
@@ -90,6 +90,7 @@ var CapabilityNames;
90
90
  CapabilityNames["NOTEBOOK"] = "Notebooks";
91
91
  CapabilityNames["OFFER"] = "Offers";
92
92
  CapabilityNames["OFFERACTIVITY"] = "Components";
93
+ CapabilityNames["OPTIMIZATIONMETRICS"] = "Optimization metrics";
93
94
  CapabilityNames["PERMISSIONSUI"] = "Permissions";
94
95
  CapabilityNames["PLACES"] = "Places";
95
96
  CapabilityNames["PLATFORMUIENCRYPTION"] = "Encryption";
@@ -104,6 +105,7 @@ var CapabilityNames;
104
105
  CapabilityNames["REPORT"] = "Reports";
105
106
  CapabilityNames["REQUEST"] = "Requests";
106
107
  CapabilityNames["SANDBOX"] = "Sandboxes";
108
+ CapabilityNames["SAPPHIREACCOUNTAUDIENCE"] = "Account Audiences";
107
109
  CapabilityNames["SCENARIO"] = "Scenarios";
108
110
  CapabilityNames["SCHEMA"] = "Schemas";
109
111
  CapabilityNames["SEGMENT"] = "Segments";
@@ -167,6 +169,7 @@ var CapabilityIds;
167
169
  CapabilityIds["NOTEBOOK"] = "notebook";
168
170
  CapabilityIds["OFFER"] = "offer";
169
171
  CapabilityIds["OFFERACTIVITY"] = "offeractivity";
172
+ CapabilityIds["OPTIMIZATIONMETRICS"] = "optimizationMetrics";
170
173
  CapabilityIds["PERMISSIONSUI"] = "permissionsUI";
171
174
  CapabilityIds["PLACES"] = "places";
172
175
  CapabilityIds["PLATFORMUIENCRYPTION"] = "platformUIEncryption";
@@ -181,6 +184,7 @@ var CapabilityIds;
181
184
  CapabilityIds["REPORT"] = "report";
182
185
  CapabilityIds["REQUEST"] = "request";
183
186
  CapabilityIds["SANDBOX"] = "sandbox";
187
+ CapabilityIds["SAPPHIREACCOUNTAUDIENCE"] = "sapphireAccountAudience";
184
188
  CapabilityIds["SCENARIO"] = "scenario";
185
189
  CapabilityIds["SCHEMA"] = "schema";
186
190
  CapabilityIds["SEGMENT"] = "segment";
@@ -1 +1 @@
1
- {"version":3,"file":"capabilityapi.js","sourceRoot":"","sources":["capabilityapi.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,yCAAqC;AAarC,iDAAiD;AACjD,IAAY,eA0EX;AA1ED,WAAY,eAAe;IACzB,8CAA2B,CAAA;IAC3B,+CAA4B,CAAA;IAC5B,2CAAwB,CAAA;IACxB,mCAAgB,CAAA;IAChB,2DAAwC,CAAA;IACxC,uCAAoB,CAAA;IACpB,uCAAoB,CAAA;IACpB,qCAAkB,CAAA;IAClB,2DAAwC,CAAA;IACxC,gDAA6B,CAAA;IAC7B,+CAA4B,CAAA;IAC5B,oCAAiB,CAAA;IACjB,0CAAuB,CAAA;IACvB,0CAAuB,CAAA;IACvB,+CAA4B,CAAA;IAC5B,4CAAyB,CAAA;IACzB,4CAAyB,CAAA;IACzB,yDAAsC,CAAA;IACtC,yCAAsB,CAAA;IACtB,2CAAwB,CAAA;IACxB,iDAA8B,CAAA;IAC9B,0DAAuC,CAAA;IACvC,yCAAsB,CAAA;IACtB,uCAAoB,CAAA;IACpB,8CAA2B,CAAA;IAC3B,yDAAsC,CAAA;IACtC,0DAAuC,CAAA;IACvC,0CAAuB,CAAA;IACvB,+CAA4B,CAAA;IAC5B,0CAAuB,CAAA;IACvB,gCAAa,CAAA;IACb,4CAAyB,CAAA;IACzB,0CAAuB,CAAA;IACvB,8CAA2B,CAAA;IAC3B,wCAAqB,CAAA;IACrB,iDAA8B,CAAA;IAC9B,iDAA8B,CAAA;IAC9B,4DAAyC,CAAA;IACzC,wCAAqB,CAAA;IACrB,mCAAgB,CAAA;IAChB,uDAAoC,CAAA;IACpC,4CAAyB,CAAA;IACzB,yCAAsB,CAAA;IACtB,mCAAgB,CAAA;IAChB,+CAA4B,CAAA;IAC5B,gDAA6B,CAAA;IAC7B,oCAAiB,CAAA;IACjB,sDAAmC,CAAA;IACnC,0CAAuB,CAAA;IACvB,sCAAmB,CAAA;IACnB,0CAAuB,CAAA;IACvB,qDAAkC,CAAA;IAClC,uCAAoB,CAAA;IACpB,iDAA8B,CAAA;IAC9B,+CAA4B,CAAA;IAC5B,oCAAiB,CAAA;IACjB,qCAAkB,CAAA;IAClB,uCAAoB,CAAA;IACpB,wCAAqB,CAAA;IACrB,yCAAsB,CAAA;IACtB,qCAAkB,CAAA;IAClB,uCAAoB,CAAA;IACpB,gDAA6B,CAAA;IAC7B,wDAAqC,CAAA;IACrC,uCAAoB,CAAA;IACpB,wCAAqB,CAAA;IACrB,qCAAkB,CAAA;IAClB,sDAAmC,CAAA;IACnC,+DAA4C,CAAA;IAC5C,2DAAwC,CAAA;IACxC,uCAAoB,CAAA;IACpB,kDAA+B,CAAA;IAC/B,yCAAsB,CAAA;AACxB,CAAC,EA1EW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QA0E1B;AAED,iDAAiD;AACjD,IAAY,aA0EX;AA1ED,WAAY,aAAa;IACvB,kDAAiC,CAAA;IACjC,oDAAmC,CAAA;IACnC,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,sDAAqC,CAAA;IACrC,oCAAmB,CAAA;IACnB,wCAAuB,CAAA;IACvB,sCAAqB,CAAA;IACrB,wDAAuC,CAAA;IACvC,8CAA6B,CAAA;IAC7B,4CAA2B,CAAA;IAC3B,kCAAiB,CAAA;IACjB,wCAAuB,CAAA;IACvB,wCAAuB,CAAA;IACvB,sDAAqC,CAAA;IACrC,sDAAqC,CAAA;IACrC,0CAAyB,CAAA;IACzB,sDAAqC,CAAA;IACrC,8CAA6B,CAAA;IAC7B,wCAAuB,CAAA;IACvB,gDAA+B,CAAA;IAC/B,sEAAqD,CAAA;IACrD,sCAAqB,CAAA;IACrB,oCAAmB,CAAA;IACnB,4CAA2B,CAAA;IAC3B,oDAAmC,CAAA;IACnC,gEAA+C,CAAA;IAC/C,gDAA+B,CAAA;IAC/B,4CAA2B,CAAA;IAC3B,wCAAuB,CAAA;IACvB,8BAAa,CAAA;IACb,0CAAyB,CAAA;IACzB,sCAAqB,CAAA;IACrB,4CAA2B,CAAA;IAC3B,sCAAqB,CAAA;IACrB,8CAA6B,CAAA;IAC7B,8CAA6B,CAAA;IAC7B,wDAAuC,CAAA;IACvC,sCAAqB,CAAA;IACrB,gCAAe,CAAA;IACf,oDAAmC,CAAA;IACnC,0CAAyB,CAAA;IACzB,sCAAqB,CAAA;IACrB,gCAAe,CAAA;IACf,gDAA+B,CAAA;IAC/B,gDAA+B,CAAA;IAC/B,kCAAiB,CAAA;IACjB,8DAA6C,CAAA;IAC7C,wCAAuB,CAAA;IACvB,kCAAiB,CAAA;IACjB,8CAA6B,CAAA;IAC7B,kDAAiC,CAAA;IACjC,oCAAmB,CAAA;IACnB,sDAAqC,CAAA;IACrC,oDAAmC,CAAA;IACnC,gCAAe,CAAA;IACf,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;IACnB,oCAAmB,CAAA;IACnB,sCAAqB,CAAA;IACrB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;IACnB,oDAAmC,CAAA;IACnC,sDAAqC,CAAA;IACrC,oCAAmB,CAAA;IACnB,sCAAqB,CAAA;IACrB,kCAAiB,CAAA;IACjB,gDAA+B,CAAA;IAC/B,4DAA2C,CAAA;IAC3C,oEAAmD,CAAA;IACnD,4CAA2B,CAAA;IAC3B,oDAAmC,CAAA;IACnC,sCAAqB,CAAA;AACvB,CAAC,EA1EW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QA0ExB;AAUD,MAAM,aAAa,GAAG;IACpB,GAAG,EAAE,MAAM,CAAC,EAAE;QACZ,OAAO,IAAA,gBAAO,EAAC,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,eA4EX;AA5ED,WAAY,eAAe;IACzB,8CAA2B,CAAA;IAC3B,+CAA4B,CAAA;IAC5B,2CAAwB,CAAA;IACxB,mCAAgB,CAAA;IAChB,2DAAwC,CAAA;IACxC,uCAAoB,CAAA;IACpB,uCAAoB,CAAA;IACpB,qCAAkB,CAAA;IAClB,2DAAwC,CAAA;IACxC,gDAA6B,CAAA;IAC7B,+CAA4B,CAAA;IAC5B,oCAAiB,CAAA;IACjB,0CAAuB,CAAA;IACvB,0CAAuB,CAAA;IACvB,+CAA4B,CAAA;IAC5B,4CAAyB,CAAA;IACzB,4CAAyB,CAAA;IACzB,yDAAsC,CAAA;IACtC,yCAAsB,CAAA;IACtB,2CAAwB,CAAA;IACxB,iDAA8B,CAAA;IAC9B,0DAAuC,CAAA;IACvC,yCAAsB,CAAA;IACtB,uCAAoB,CAAA;IACpB,8CAA2B,CAAA;IAC3B,yDAAsC,CAAA;IACtC,0DAAuC,CAAA;IACvC,0CAAuB,CAAA;IACvB,+CAA4B,CAAA;IAC5B,0CAAuB,CAAA;IACvB,gCAAa,CAAA;IACb,4CAAyB,CAAA;IACzB,0CAAuB,CAAA;IACvB,8CAA2B,CAAA;IAC3B,wCAAqB,CAAA;IACrB,iDAA8B,CAAA;IAC9B,iDAA8B,CAAA;IAC9B,4DAAyC,CAAA;IACzC,wCAAqB,CAAA;IACrB,mCAAgB,CAAA;IAChB,uDAAoC,CAAA;IACpC,4CAAyB,CAAA;IACzB,yCAAsB,CAAA;IACtB,mCAAgB,CAAA;IAChB,+CAA4B,CAAA;IAC5B,+DAA4C,CAAA;IAC5C,gDAA6B,CAAA;IAC7B,oCAAiB,CAAA;IACjB,sDAAmC,CAAA;IACnC,0CAAuB,CAAA;IACvB,sCAAmB,CAAA;IACnB,0CAAuB,CAAA;IACvB,qDAAkC,CAAA;IAClC,uCAAoB,CAAA;IACpB,iDAA8B,CAAA;IAC9B,+CAA4B,CAAA;IAC5B,oCAAiB,CAAA;IACjB,qCAAkB,CAAA;IAClB,uCAAoB,CAAA;IACpB,wCAAqB,CAAA;IACrB,gEAA6C,CAAA;IAC7C,yCAAsB,CAAA;IACtB,qCAAkB,CAAA;IAClB,uCAAoB,CAAA;IACpB,gDAA6B,CAAA;IAC7B,wDAAqC,CAAA;IACrC,uCAAoB,CAAA;IACpB,wCAAqB,CAAA;IACrB,qCAAkB,CAAA;IAClB,sDAAmC,CAAA;IACnC,+DAA4C,CAAA;IAC5C,2DAAwC,CAAA;IACxC,uCAAoB,CAAA;IACpB,kDAA+B,CAAA;IAC/B,yCAAsB,CAAA;AACxB,CAAC,EA5EW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QA4E1B;AAED,iDAAiD;AACjD,IAAY,aA4EX;AA5ED,WAAY,aAAa;IACvB,kDAAiC,CAAA;IACjC,oDAAmC,CAAA;IACnC,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,sDAAqC,CAAA;IACrC,oCAAmB,CAAA;IACnB,wCAAuB,CAAA;IACvB,sCAAqB,CAAA;IACrB,wDAAuC,CAAA;IACvC,8CAA6B,CAAA;IAC7B,4CAA2B,CAAA;IAC3B,kCAAiB,CAAA;IACjB,wCAAuB,CAAA;IACvB,wCAAuB,CAAA;IACvB,sDAAqC,CAAA;IACrC,sDAAqC,CAAA;IACrC,0CAAyB,CAAA;IACzB,sDAAqC,CAAA;IACrC,8CAA6B,CAAA;IAC7B,wCAAuB,CAAA;IACvB,gDAA+B,CAAA;IAC/B,sEAAqD,CAAA;IACrD,sCAAqB,CAAA;IACrB,oCAAmB,CAAA;IACnB,4CAA2B,CAAA;IAC3B,oDAAmC,CAAA;IACnC,gEAA+C,CAAA;IAC/C,gDAA+B,CAAA;IAC/B,4CAA2B,CAAA;IAC3B,wCAAuB,CAAA;IACvB,8BAAa,CAAA;IACb,0CAAyB,CAAA;IACzB,sCAAqB,CAAA;IACrB,4CAA2B,CAAA;IAC3B,sCAAqB,CAAA;IACrB,8CAA6B,CAAA;IAC7B,8CAA6B,CAAA;IAC7B,wDAAuC,CAAA;IACvC,sCAAqB,CAAA;IACrB,gCAAe,CAAA;IACf,oDAAmC,CAAA;IACnC,0CAAyB,CAAA;IACzB,sCAAqB,CAAA;IACrB,gCAAe,CAAA;IACf,gDAA+B,CAAA;IAC/B,4DAA2C,CAAA;IAC3C,gDAA+B,CAAA;IAC/B,kCAAiB,CAAA;IACjB,8DAA6C,CAAA;IAC7C,wCAAuB,CAAA;IACvB,kCAAiB,CAAA;IACjB,8CAA6B,CAAA;IAC7B,kDAAiC,CAAA;IACjC,oCAAmB,CAAA;IACnB,sDAAqC,CAAA;IACrC,oDAAmC,CAAA;IACnC,gCAAe,CAAA;IACf,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;IACnB,oCAAmB,CAAA;IACnB,oEAAmD,CAAA;IACnD,sCAAqB,CAAA;IACrB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;IACnB,oDAAmC,CAAA;IACnC,sDAAqC,CAAA;IACrC,oCAAmB,CAAA;IACnB,sCAAqB,CAAA;IACrB,kCAAiB,CAAA;IACjB,gDAA+B,CAAA;IAC/B,4DAA2C,CAAA;IAC3C,oEAAmD,CAAA;IACnD,4CAA2B,CAAA;IAC3B,oDAAmC,CAAA;IACnC,sCAAqB,CAAA;AACvB,CAAC,EA5EW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QA4ExB;AAUD,MAAM,aAAa,GAAG;IACpB,GAAG,EAAE,MAAM,CAAC,EAAE;QACZ,OAAO,IAAA,gBAAO,EAAC,eAAe,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAChD,CAAC;CACe,CAAC;AAEnB,kBAAe,aAAa,CAAC"}
@@ -31,16 +31,16 @@ GQL Query.
31
31
 
32
32
  ```typescript
33
33
  {query: `
34
- query userBehanceQuery($userId: String!, $apiKey: String!) {
35
- userBehance(userId: $userId, apiKey: $apiKey) {
34
+ query PPSQuery($userId: String!, $apiKey: String!) {
35
+ getPPSProfile(userId: $userId, apiKey: $apiKey) {
36
36
  images
37
37
  }
38
38
  }`
39
39
  };
40
40
 
41
41
  {query: `
42
- query userBehanceQuery {
43
- userBehance(userId: "123@AdobeID", apiKey: "test-app") {
42
+ query PPSQuery {
43
+ getPPSProfile(userId: "123@AdobeID", apiKey: "test-app") {
44
44
  images
45
45
  }
46
46
  }`
@@ -127,23 +127,23 @@ available in the GraphQL Service.
127
127
  ***Example:***
128
128
 
129
129
  ```typescript
130
- const BEHANCE_QUERY = `
131
- query userBehanceQuery($userId: String!, $apiKey: String!) {
132
- userBehance(userId: $userId, apiKey: $apiKey) {
130
+ const PPS_QUERY = `
131
+ query PPSQuery($userId: String!, $apiKey: String!) {
132
+ getPPSProfile(userId: $userId, apiKey: $apiKey) {
133
133
  images
134
134
  }
135
135
  }`;
136
136
 
137
137
  // queries the respective resource via GraphQL and returns HTTP Response {ok: true, status: 200, ...}
138
- query({data: {query: BEHANCE_QUERY, variables: {
138
+ query({data: {query: PPS_QUERY, variables: {
139
139
  userId: '123@AdobeID',
140
140
  apiKey: 'test-app',
141
- }}, operationName: 'BehanceAvatar'});
141
+ }}, operationName: 'PPSAvatar'});
142
142
 
143
143
  // queries the respective resource via GraphQL and returns HTTP Response {ok: true, status: 200, ...}
144
144
  query({data: {query: `
145
- query userBehanceQuery {
146
- userBehance(userId: "123@AdobeID", apiKey: "test-app") {
145
+ query PPSQuery {
146
+ getPPSProfile(userId: "123@AdobeID", apiKey: "test-app") {
147
147
  images
148
148
  }
149
149
  }`
@@ -63,16 +63,16 @@ GQL Query.
63
63
 
64
64
  ```typescript
65
65
  {query: `
66
- query userBehanceQuery($userId: String!, $apiKey: String!) {
67
- userBehance(userId: $userId, apiKey: $apiKey) {
66
+ query PPSQuery($userId: String!, $apiKey: String!) {
67
+ getPPSProfile(userId: $userId, apiKey: $apiKey) {
68
68
  images
69
69
  }
70
70
  }`
71
71
  };
72
72
 
73
73
  {query: `
74
- query userBehanceQuery {
75
- userBehance(userId: "123@AdobeID", apiKey: "test-app") {
74
+ query PPSQuery {
75
+ getPPSProfile(userId: "123@AdobeID", apiKey: "test-app") {
76
76
  images
77
77
  }
78
78
  }`
@@ -58,8 +58,8 @@ Data containing single or multiple GQL queries.
58
58
  ```typescript
59
59
  {data: {
60
60
  query: `
61
- query userBehanceQuery($userId: String!, $apiKey: String!) {
62
- userBehance(userId: $userId, apiKey: $apiKey) {
61
+ query PPSQuery($userId: String!, $apiKey: String!) {
62
+ getPPSProfile(userId: $userId, apiKey: $apiKey) {
63
63
  images
64
64
  }
65
65
  }`,
@@ -98,7 +98,7 @@ Query ID- To analyze a query's metrics & performance.
98
98
  ***Example:***
99
99
 
100
100
  ```typescript
101
- {operationName: 'BehanceAvatar'}
101
+ {operationName: 'PPSAvatar'}
102
102
  ```
103
103
 
104
104
  ___
@@ -30,16 +30,24 @@ Defines page-level APIs available to solutions.
30
30
 
31
31
  ### customEnvLabel
32
32
 
33
- • **customEnvLabel**: string
33
+ • **customEnvLabel**: string | Array<string | CustomLabelDesc> | null
34
34
 
35
35
  *Inherited from [TopbarApiProperties](topbar.topbarapiproperties.md).[customEnvLabel](topbar.topbarapiproperties.md#customenvlabel)*
36
36
 
37
- Gets or sets a custom environment label in the shell.
37
+ Gets or sets a custom environment label in the shell. Values can be a simple string or
38
+ a `CustomLabelDesc` with `type` and `value` keys. The default label `type` is 'ENVIRONMENT'.
39
+ Specifying a `CustomRelease` option as the `value` is required when `type` is
40
+ `CustomLabelType.RELEASE`. Only one CustomLabelType.RELEASE type can be rendered in the header
41
+ and only for solutions that are in GA release.
38
42
 
39
43
  ***Example:***
44
+ import {CustomLabelType, CustomRelease} from '@adobe/exc-app/topbar';
40
45
 
41
46
  ```typescript
42
47
  topbar.customEnvLabel = 'Beta';
48
+ topbar.customEnvLabel = ['Beta', 'Test'];
49
+ topbar.custonEnvLabel = [{type: CustomLabelType.ENVIRONMENT, value: 'Test'}];
50
+ topbar.customEnvLabel = ['Beta', {type: CustomLabelType.RELEASE, value: CustomRelease.TRIAL}];
43
51
  ```
44
52
 
45
53
  ___
@@ -22,16 +22,39 @@
22
22
 
23
23
  ### customEnvLabel
24
24
 
25
- • **customEnvLabel**: string
25
+ • **customEnvLabel**: string | Array<string | CustomLabelDesc> | null
26
26
 
27
- Gets or sets a custom environment label in the shell.
27
+ Gets or sets a custom environment label in the shell. Values can be a simple string or
28
+ a `CustomLabelDesc` with `type` and `value` keys. The default label `type` is 'ENVIRONMENT'.
29
+ Specifying a `CustomRelease` option as the `value` is required when `type` is
30
+ `CustomLabelType.RELEASE`. Only one CustomLabelType.RELEASE type can be rendered in the header
31
+ and only for solutions that are in GA release.
28
32
 
29
33
  ***Example:***
34
+ import {CustomLabelType, CustomRelease} from '@adobe/exc-app/topbar';
30
35
 
31
36
  ```typescript
32
37
  topbar.customEnvLabel = 'Beta';
38
+ topbar.customEnvLabel = ['Beta', 'Test'];
39
+ topbar.custonEnvLabel = [{type: CustomLabelType.ENVIRONMENT, value: 'Test'}];
40
+ topbar.customEnvLabel = ['Beta', {type: CustomLabelType.RELEASE, value: CustomRelease.TRIAL}];
33
41
  ```
34
-
42
+ /**
43
+ * Gets or sets a custom environment label in the shell. Values can be a simple string or
44
+ * an `CustomLabelDesc` with `type` and `value` keys. The default `type` is 'ENVIRONMENT'. `value` can be any
45
+ * string but when set to an `CustomRelease` option, will benefit from internationalization.
46
+ *
47
+ * ***Example:***
48
+ * import {CustomLabelType} from '@adobe/exc-app/topbar';
49
+ *
50
+ * ```typescript
51
+ * topbar.customEnvLabel = 'Beta';
52
+ * topbar.customEnvLabel = ['Beta', 'Test'];
53
+ * topbar.custonEnvLabel = {type: CustomLabelType.RELEASE, value: CustomRelease.TRIAL};
54
+ * topbar.customEnvLabel = ['Beta', {type: CustomLabelType.RELEASE, value: CustomRelease.TRIAL}];
55
+ * ```
56
+ */
57
+ customEnvLabel: string | Array<string | CustomLabelDesc>;
35
58
  ___
36
59
 
37
60
  ### solution
@@ -29,8 +29,8 @@ const fetchResponse = await fetch('https://localhost', {auth: 'Header', method:
29
29
  const queryResponse = await query({
30
30
  data: {
31
31
  query: `
32
- query userBehanceQuery($userId: String!, $apiKey: String!) {
33
- userBehance(userId: $userId, apiKey: $apiKey) {
32
+ query PPSQuery($userId: String!, $apiKey: String!) {
33
+ getPPSProfile(userId: $userId, apiKey: $apiKey) {
34
34
  images
35
35
  }
36
36
  }`,
@@ -39,7 +39,7 @@ const queryResponse = await query({
39
39
  userId: '123@AdobeID'
40
40
  }
41
41
  },
42
- operationName: 'BehanceAvatar'
42
+ operationName: 'PPSAvatar'
43
43
  });
44
44
 
45
45
  ```
@@ -240,23 +240,23 @@ available in the GraphQL Service.
240
240
  ***Example:***
241
241
 
242
242
  ```typescript
243
- const BEHANCE_QUERY = `
244
- query userBehanceQuery($userId: String!, $apiKey: String!) {
245
- userBehance(userId: $userId, apiKey: $apiKey) {
243
+ const PPS_QUERY = `
244
+ query PPSQuery($userId: String!, $apiKey: String!) {
245
+ getPPSProfile(userId: $userId, apiKey: $apiKey) {
246
246
  images
247
247
  }
248
248
  }`;
249
249
 
250
250
  // queries the respective resource via GraphQL and returns HTTP Response {ok: true, status: 200, ...}
251
- query({data: {query: BEHANCE_QUERY, variables: {
251
+ query({data: {query: PPS_QUERY, variables: {
252
252
  userId: '123@AdobeID',
253
253
  apiKey: 'test-app',
254
- }}, operationName: 'BehanceAvatar'});
254
+ }}, operationName: 'PPSAvatar'});
255
255
 
256
256
  // queries the respective resource via GraphQL and returns HTTP Response {ok: true, status: 200, ...}
257
257
  query({data: {query: `
258
- query userBehanceQuery {
259
- userBehance(userId: "123@AdobeID", apiKey: "test-app") {
258
+ query PPSQuery {
259
+ getPPSProfile(userId: "123@AdobeID", apiKey: "test-app") {
260
260
  images
261
261
  }
262
262
  }`
package/featureflags.d.ts CHANGED
@@ -20,6 +20,23 @@ export interface FlattenedFeatureFlag {
20
20
  export interface FeatureFlagsResponse {
21
21
  [projectId: string]: FlattenedFeatureFlag;
22
22
  }
23
+ /**
24
+ * The additional context options that can be optionally included.
25
+ * For example, include a sandbox for an API call from an app that isn't
26
+ * configured with a sandbox.
27
+ * If you require additional support for context options not listed here,
28
+ * please reach out to the Unified Shell team.
29
+ */
30
+ export interface SandboxOptions {
31
+ name: string;
32
+ }
33
+ /**
34
+ * The data object when the projects and options are sent as a message through the API.
35
+ */
36
+ export interface GetFlagsWithOptions {
37
+ projectIds: string[];
38
+ sandbox?: SandboxOptions;
39
+ }
23
40
  /**
24
41
  * The input parameters for the feature flags API.
25
42
  * This should be a list of LaunchDarkly project ids to get.
@@ -27,7 +44,7 @@ export interface FeatureFlagsResponse {
27
44
  * documentation site:
28
45
  * https://git.corp.adobe.com/pages/exc/unified-shell-docs/docs/intro
29
46
  */
30
- export type ProjectIds = string[];
47
+ export type ProjectIds = string[] | GetFlagsWithOptions;
31
48
  /**
32
49
  * APIs to get featureFlags.
33
50
  */
@@ -37,10 +54,10 @@ export interface FeatureFlagsApi {
37
54
  * You'll find a list of allowed projectIds in the
38
55
  * documentation site:
39
56
  * https://git.corp.adobe.com/pages/exc/unified-shell-docs/docs/intro
40
- * @param params ProjectIds used to identify feature flags to retrieve.
57
+ * @param projectIds ProjectIds used to identify feature flags to retrieve.
41
58
  * @returns A promise for the feature flags.
42
59
  */
43
- get(params?: ProjectIds): Promise<FeatureFlagsResponse>;
60
+ get(projectIds: ProjectIds): Promise<FeatureFlagsResponse>;
44
61
  }
45
62
  declare const featureFlags: FeatureFlagsApi;
46
63
  export default featureFlags;
package/featureflags.js CHANGED
@@ -36,6 +36,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
36
36
  * import featureFlags from '@adobe/exc-app/featureflags';
37
37
  *
38
38
  * const featureFlags = await featureFlags.get(['*']);
39
+ *
40
+ * ```
41
+ * In some cases you may want to include context options that are not already
42
+ * included in the current app's active context. For example, requesting feature
43
+ * flags for a project that uses sandboxes from an app that does not.
44
+ *
45
+ * To include options in the request, pass an object with projectIds and the context options.
46
+ *
47
+ * ```typescript
48
+ * import featureFlags from '@adobe/exc-app/featureflags';
49
+ *
50
+ * const sandbox = {name: 'name'};
51
+ * const featureFlags = await featureFlags.get({projectsIds: ['cjm'], sandbox});
39
52
  * ```
40
53
  *
41
54
  * API for fetching app data.
@@ -1 +1 @@
1
- {"version":3,"file":"featureflags.js","sourceRoot":"","sources":["featureflags.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,yCAAqC;AAwCrC,MAAM,YAAY,GAAoB;IACpC,GAAG,EAAE,CAAC,MAAkB,EAAE,EAAE;QAC1B,OAAO,IAAA,gBAAO,EAAC,cAAc,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC;CACF,CAAC;AAEF,kBAAe,YAAY,CAAC"}
1
+ {"version":3,"file":"featureflags.js","sourceRoot":"","sources":["featureflags.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AAEH,yCAAqC;AA4DrC,MAAM,YAAY,GAAoB;IACpC,GAAG,EAAE,CAAC,MAAkB,EAAE,EAAE;QAC1B,OAAO,IAAA,gBAAO,EAAC,cAAc,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC;CACF,CAAC;AAEF,kBAAe,YAAY,CAAC"}
@@ -8,7 +8,7 @@
8
8
  * then your use, modification, or distribution of it requires the prior
9
9
  * written permission of Adobe.
10
10
  **************************************************************************/
11
- import type { RELEASE_TYPE } from '@exc/core/src/models/Solution';
11
+ import { RELEASE_TYPE } from '../page';
12
12
  /**
13
13
  * @ignore
14
14
  */