@adobe/exc-app 1.5.3 → 1.5.5

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.
@@ -11,6 +11,7 @@
11
11
  import type { ActiveProductContext, ImsProfile } from './ims/ImsProfile';
12
12
  import type { AIApplicationId } from './ai';
13
13
  import type { AppParent } from '@adobe/exc-app/appapi';
14
+ import type { BaseNetworkConfig } from '@adobe/exc-app/network';
14
15
  import type { Collaborator, Instance } from './user';
15
16
  import type { ConsentPermissions } from './consent';
16
17
  import type MetricsConfiguration from './metrics/Configuration';
@@ -26,7 +27,6 @@ export interface UserRoles {
26
27
  roleJobFunction: Record<string, boolean>;
27
28
  rolePlatformObjective: Record<string, boolean | string>;
28
29
  }
29
- export type APIMode = 'io' | 'afd';
30
30
  export type AppParentConfig = AppParent | 'component' | undefined;
31
31
  /**
32
32
  * Gainsight Interface
@@ -199,7 +199,7 @@ export interface NestedAppConfig extends AnalyticsConfiguration {
199
199
  /**
200
200
  * External Runtime Configuration Interface
201
201
  */
202
- export interface RuntimeConfiguration {
202
+ export interface RuntimeConfiguration extends BaseNetworkConfig {
203
203
  /**
204
204
  * Active product context - Used by Adobe Analytics to determine login company
205
205
  */
@@ -213,18 +213,10 @@ export interface RuntimeConfiguration {
213
213
  * OMEGA Launch script properties
214
214
  */
215
215
  analytics?: AnalyticsConfiguration;
216
- /**
217
- * Unified Shell API Gateway URL
218
- */
219
- apiGatewayUrl: string;
220
216
  /**
221
217
  * API Key that will be added to x-api-key on requests
222
218
  */
223
219
  apiKey: string;
224
- /**
225
- * Should API calls go directly to IO or accelerated via AFD/AWS (Default 'afd')
226
- */
227
- apiMode?: APIMode;
228
220
  /**
229
221
  * App Container
230
222
  */
@@ -301,10 +293,6 @@ export interface RuntimeConfiguration {
301
293
  * Denotes the global consent path or legacy consent path
302
294
  */
303
295
  globalConsentEnabled: boolean;
304
- /**
305
- * Clients can pass in their local GQL endpoint
306
- */
307
- gqlEndpoint?: string;
308
296
  /**
309
297
  * Solution History type
310
298
  */
@@ -361,22 +349,10 @@ export interface RuntimeConfiguration {
361
349
  * Current commerce instance
362
350
  */
363
351
  instance?: Instance;
364
- /**
365
- * Adobe IO gateway URL used as a fallback in GQL call
366
- */
367
- ioGatewayUrl?: string;
368
- /**
369
- * Map of Adobe Io region specific endpoints.
370
- */
371
- ioRegionSpecificMap?: Record<string, string>;
372
352
  /**
373
353
  * Is the configuration for the AI Panel iframe
374
354
  */
375
355
  isAIPanel: boolean;
376
- /**
377
- * Is the org an AWS org
378
- */
379
- isAWSOrg?: boolean;
380
356
  /**
381
357
  * Is the next generation AI Assistant enabled
382
358
  */
@@ -414,9 +390,9 @@ export interface RuntimeConfiguration {
414
390
  */
415
391
  nestedApps?: Record<string, NestedAppConfig>;
416
392
  /**
417
- * imsOrg - region
393
+ * The document title of the page.
418
394
  */
419
- orgRegion?: string;
395
+ pageName?: string;
420
396
  /**
421
397
  * The current page URL. This field represents the full URL of the page as seen by the user,
422
398
  * Developers should use this field when they need to access or record the exact location
@@ -513,6 +489,9 @@ export interface RuntimeConfiguration {
513
489
  * @deprecated Solution GraphQL tenantAppId
514
490
  */
515
491
  tenantAppId?: string;
492
+ /**
493
+ * spectrum--darkest or spectrum--lightest
494
+ */
516
495
  theme: string;
517
496
  /**
518
497
  * If the toast quiet mode feature is enabled.
@@ -530,8 +509,4 @@ export interface RuntimeConfiguration {
530
509
  * User's consent permissions
531
510
  */
532
511
  userConsentPermissions?: ConsentPermissions;
533
- /**
534
- * XQL gateway used for AEP specific queries
535
- */
536
- xqlGatewayUrl?: string;
537
512
  }
@@ -1 +1 @@
1
- {"version":3,"file":"RuntimeConfiguration.js","sourceRoot":"","sources":["RuntimeConfiguration.ts"],"names":[],"mappings":";;;AAsBA,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,6CAA2B,CAAA;IAC3B,2CAAyB,CAAA;IACzB,+CAA6B,CAAA;AAC/B,CAAC,EAJW,cAAc,8BAAd,cAAc,QAIzB"}
1
+ {"version":3,"file":"RuntimeConfiguration.js","sourceRoot":"","sources":["RuntimeConfiguration.ts"],"names":[],"mappings":";;;AAuBA,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,6CAA2B,CAAA;IAC3B,2CAAyB,CAAA;IACzB,+CAA6B,CAAA;AAC/B,CAAC,EAJW,cAAc,8BAAd,cAAc,QAIzB"}
package/ai.d.ts CHANGED
@@ -161,6 +161,10 @@ export interface AIMessagePayload {
161
161
  /**
162
162
  * The payload data of the custom event.
163
163
  */
164
+ conversationId?: string;
165
+ /**
166
+ * The id of the conversation to open
167
+ */
164
168
  data?: any;
165
169
  /**
166
170
  * Whether the user has permission to use the AI Assistant.
@@ -207,18 +211,33 @@ export interface AIContext {
207
211
  export declare enum AIApplicationId {
208
212
  AEM = "aem",
209
213
  AEP = "aep",
214
+ ARION = "arion",
210
215
  CJA = "cja",
211
216
  CJM = "cjm",
212
217
  DATACOLLECTION = "datacollection",
213
218
  GENSTUDIO = "genstudio",
214
219
  IVO = "ivo-ui",
215
- SAPPHIRE = "sapphire"
220
+ MARKETOENGAGE = "marketoengage",
221
+ SAPPHIRE = "sapphire",
222
+ TARGET = "target",
223
+ WORKFRONT = "workfront"
216
224
  }
217
225
  export interface AppContext {
218
226
  mainAppAgentApplicationId?: AIApplicationId;
219
227
  mainAppId: string;
220
228
  mainAppRoot: string;
221
229
  }
230
+ /**
231
+ * Options to open the AI chat side rail.
232
+ * @param conversationId - The id of the conversation to open
233
+ * @param query - The query to send to the AI
234
+ * @param shouldSubmit - Whether to submit the query automatically
235
+ */
236
+ export interface OpenChatProps {
237
+ conversationId?: string;
238
+ query?: string;
239
+ shouldSubmit?: boolean;
240
+ }
222
241
  interface AIMessageEvent {
223
242
  BUTTON_ACTIVE: AIMessagePayload;
224
243
  BUTTON_VISIBLE: AIMessagePayload;
@@ -291,18 +310,24 @@ export interface AIApi extends EventEmitter<AIMessageEvent> {
291
310
  */
292
311
  onContextRequest: (callback: () => Promise<AIContext>) => void;
293
312
  /**
294
- * Opens the chat side rail with an optional pre-populated query.
295
- * By default, the query is automatically submitted. This can be overwritten by setting
296
- * the shouldSubmit parameter to false.
313
+ * Opens the chat side rail with optional query, submit behavior, or conversation to load.
314
+ * backward-compatible signatures:
315
+ * - ai.openChat(query?: string, shouldSubmit?: boolean): void;
316
+ * - ai.openChat(props: OpenChatProps): void;
297
317
  *
298
318
  * ***Example:***
299
319
  *
300
320
  * ```typescript
301
- * ai.openChat('How do I create a new project?'); // Automatically submits the query
302
- * ai.openChat('How do I create a new project?', false); // Populates the chat input but does not auto submit
321
+ * ai.openChat('How do I create a new project?');
322
+ * ai.openChat('How do I create a new project?', false);
323
+ * ai.openChat({ query: 'How do I create a new project?' });
324
+ * ai.openChat({ query: 'How do I create a new project?', shouldSubmit: false });
325
+ * ai.openChat({ conversationId: 'conv-123' });
326
+ * ai.openChat({ conversationId: 'conv-123', query: 'How do I create a new project?' });
303
327
  * ```
304
328
  */
305
- openChat: (query?: string, shouldSubmit?: boolean) => void;
329
+ openChat(query?: string, shouldSubmit?: boolean): void;
330
+ openChat(props: OpenChatProps): void;
306
331
  /**
307
332
  * Send a message to the AI chat.
308
333
  *
package/ai.js CHANGED
@@ -35,12 +35,16 @@ var AIApplicationId;
35
35
  (function (AIApplicationId) {
36
36
  AIApplicationId["AEM"] = "aem";
37
37
  AIApplicationId["AEP"] = "aep";
38
+ AIApplicationId["ARION"] = "arion";
38
39
  AIApplicationId["CJA"] = "cja";
39
40
  AIApplicationId["CJM"] = "cjm";
40
41
  AIApplicationId["DATACOLLECTION"] = "datacollection";
41
42
  AIApplicationId["GENSTUDIO"] = "genstudio";
42
43
  AIApplicationId["IVO"] = "ivo-ui";
44
+ AIApplicationId["MARKETOENGAGE"] = "marketoengage";
43
45
  AIApplicationId["SAPPHIRE"] = "sapphire";
46
+ AIApplicationId["TARGET"] = "target";
47
+ AIApplicationId["WORKFRONT"] = "workfront";
44
48
  })(AIApplicationId || (exports.AIApplicationId = AIApplicationId = {}));
45
49
  const ai = {
46
50
  appContext: () => {
@@ -64,8 +68,9 @@ const ai = {
64
68
  onContextRequest: (callback) => {
65
69
  return (0, Global_1.getImpl)('ai')().onContextRequest(callback);
66
70
  },
67
- openChat: (query) => {
68
- return (0, Global_1.getImpl)('ai')().openChat(query);
71
+ openChat: (queryOrProps, shouldSubmit) => {
72
+ const impl = (0, Global_1.getImpl)('ai')();
73
+ return impl.openChat(queryOrProps, shouldSubmit);
69
74
  },
70
75
  sendMessage: (payload) => {
71
76
  return (0, Global_1.getImpl)('ai')().sendMessage(payload);
package/ai.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ai.js","sourceRoot":"","sources":["ai.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAQ5E,yCAAqC;AA+HrC,IAAY,aAcX;AAdD,WAAY,aAAa;IACvB,gDAA+B,CAAA;IAC/B,kDAAiC,CAAA;IACjC,gCAAe,CAAA;IACf,oCAAmB,CAAA;IACnB,sDAAqC,CAAA;IACrC,gCAAe,CAAA;IACf,8BAAa,CAAA;IACb,0DAAyC,CAAA;IACzC,8BAAa,CAAA;IACb,gCAAe,CAAA;IACf,sCAAqB,CAAA;IACrB,4DAA2C,CAAA;IAC3C,4CAA2B,CAAA;AAC7B,CAAC,EAdW,aAAa,6BAAb,aAAa,QAcxB;AA4DD;;GAEG;AACH,IAAY,eASX;AATD,WAAY,eAAe;IACzB,8BAAW,CAAA;IACX,8BAAW,CAAA;IACX,8BAAW,CAAA;IACX,8BAAW,CAAA;IACX,oDAAiC,CAAA;IACjC,0CAAuB,CAAA;IACvB,iCAAc,CAAA;IACd,wCAAqB,CAAA;AACvB,CAAC,EATW,eAAe,+BAAf,eAAe,QAS1B;AAsLD,MAAM,EAAE,GAAG;IACT,UAAU,EAAE,GAAG,EAAE;QACf,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC;IACtC,CAAC;IACD,SAAS,EAAE,GAAG,EAAE;QACd,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC;IACrC,CAAC;IACD,IAAI,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;QAClB,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACzC,CAAC;IACD,uBAAuB,EAAE,GAAG,EAAE;QAC5B,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,uBAAuB,EAAE,CAAC;IACnD,CAAC;IACD,GAAG,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;QACrB,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IACD,EAAE,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;QACpB,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3C,CAAC;IACD,gBAAgB,EAAE,CAAC,QAAkC,EAAE,EAAE;QACvD,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC;IACD,QAAQ,EAAE,CAAC,KAAc,EAAE,EAAE;QAC3B,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IACD,WAAW,EAAE,CAAC,OAAyB,EAAE,EAAE;QACzC,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC;IACD,qBAAqB,EAAE,CAAC,QAAoB,EAAE,EAAE;QAC9C,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IACD,iBAAiB,EAAE,CAAC,aAAsB,EAAE,EAAE;QAC5C,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;IAC1D,CAAC;IACD,aAAa,EAAE,CAAC,WAAqB,EAAE,EAAE;QACvC,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;IACpD,CAAC;IACD,SAAS,EAAE,CAAC,OAAe,EAAE,OAAqB,EAAE,EAAE;QACpD,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IACD,kBAAkB,EAAE,CAAC,MAAe,EAAE,EAAE;QACtC,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IACD,mBAAmB,EAAE,CAAC,OAAgB,EAAE,EAAE;QACxC,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;IACD,WAAW,EAAE,CAAC,MAAe,EAAE,EAAE;QAC/B,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;CACO,CAAC;AAEX,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,SAAS,EAAE;IACnC,GAAG,EAAE,GAA0B,EAAE;QAC/B,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC;IACjC,CAAC;IACD,GAAG,EAAE,CAAC,KAA4B,EAAE,EAAE;QACpC,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,OAAO,GAAG,KAAK,CAAC;IAClC,CAAC;CACF,CAAC,CAAC;AAEH,kBAAe,EAAE,CAAC"}
1
+ {"version":3,"file":"ai.js","sourceRoot":"","sources":["ai.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAQ5E,yCAAqC;AA+HrC,IAAY,aAcX;AAdD,WAAY,aAAa;IACvB,gDAA+B,CAAA;IAC/B,kDAAiC,CAAA;IACjC,gCAAe,CAAA;IACf,oCAAmB,CAAA;IACnB,sDAAqC,CAAA;IACrC,gCAAe,CAAA;IACf,8BAAa,CAAA;IACb,0DAAyC,CAAA;IACzC,8BAAa,CAAA;IACb,gCAAe,CAAA;IACf,sCAAqB,CAAA;IACrB,4DAA2C,CAAA;IAC3C,4CAA2B,CAAA;AAC7B,CAAC,EAdW,aAAa,6BAAb,aAAa,QAcxB;AAgED;;GAEG;AACH,IAAY,eAaX;AAbD,WAAY,eAAe;IACzB,8BAAW,CAAA;IACX,8BAAW,CAAA;IACX,kCAAe,CAAA;IACf,8BAAW,CAAA;IACX,8BAAW,CAAA;IACX,oDAAiC,CAAA;IACjC,0CAAuB,CAAA;IACvB,iCAAc,CAAA;IACd,kDAA+B,CAAA;IAC/B,wCAAqB,CAAA;IACrB,oCAAiB,CAAA;IACjB,0CAAuB,CAAA;AACzB,CAAC,EAbW,eAAe,+BAAf,eAAe,QAa1B;AAwMD,MAAM,EAAE,GAAG;IACT,UAAU,EAAE,GAAG,EAAE;QACf,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC;IACtC,CAAC;IACD,SAAS,EAAE,GAAG,EAAE;QACd,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC;IACrC,CAAC;IACD,IAAI,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;QAClB,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACzC,CAAC;IACD,uBAAuB,EAAE,GAAG,EAAE;QAC5B,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,uBAAuB,EAAE,CAAC;IACnD,CAAC;IACD,GAAG,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;QACrB,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IACD,EAAE,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;QACpB,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3C,CAAC;IACD,gBAAgB,EAAE,CAAC,QAAkC,EAAE,EAAE;QACvD,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC;IACD,QAAQ,EAAE,CAAC,YAAqC,EAAE,YAAsB,EAAE,EAAE;QAC1E,MAAM,IAAI,GAAG,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAqE,CAAC;QAChG,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;IACnD,CAAC;IACD,WAAW,EAAE,CAAC,OAAyB,EAAE,EAAE;QACzC,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC;IACD,qBAAqB,EAAE,CAAC,QAAoB,EAAE,EAAE;QAC9C,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IACD,iBAAiB,EAAE,CAAC,aAAsB,EAAE,EAAE;QAC5C,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;IAC1D,CAAC;IACD,aAAa,EAAE,CAAC,WAAqB,EAAE,EAAE;QACvC,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;IACpD,CAAC;IACD,SAAS,EAAE,CAAC,OAAe,EAAE,OAAqB,EAAE,EAAE;QACpD,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IACD,kBAAkB,EAAE,CAAC,MAAe,EAAE,EAAE;QACtC,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IACD,mBAAmB,EAAE,CAAC,OAAgB,EAAE,EAAE;QACxC,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;IACD,WAAW,EAAE,CAAC,MAAe,EAAE,EAAE;QAC/B,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;CACO,CAAC;AAEX,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,SAAS,EAAE;IACnC,GAAG,EAAE,GAA0B,EAAE;QAC/B,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC;IACjC,CAAC;IACD,GAAG,EAAE,CAAC,KAA4B,EAAE,EAAE;QACpC,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,OAAO,GAAG,KAAK,CAAC;IAClC,CAAC;CACF,CAAC,CAAC;AAEH,kBAAe,EAAE,CAAC"}
package/appapi.d.ts CHANGED
@@ -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
- export type AppParent = 'AEP' | 'AGENTCOMPOSER' | 'AICAGENTS' | 'AICAIA' | 'ARION' | 'CO' | 'CJM' | 'DC' | 'FLOODGATE' | 'GENSTUDIO' | 'ORION' | 'SAPPHIRE' | 'TARGET';
11
+ export type AppParent = 'AEP' | 'AGENTCOMPOSER' | 'AICAGENTS' | 'AICAIA' | 'ARION' | 'CO' | 'CJM' | 'DC' | 'FALCO' | 'FLOODGATE' | 'GENSTUDIO' | 'ORION' | 'SAPPHIRE' | 'TARGET';
12
12
  export interface AppResponse {
13
13
  /**
14
14
  * Specifies the Adobe brand icon to use.
@@ -49,7 +49,6 @@ export declare enum AppIds {
49
49
  ADOBE_EXPERIENCE_CLOUD_GRIFFON = "griffon",
50
50
  ADVERTISING_CLOUD = "advertising-ssc",
51
51
  ADVERTISING_SEARCH_SOCIAL_COMMERCE = "advertising-ssc",
52
- AGENT_SCHEDULER = "aiComposer-agents",
53
52
  ANALYTICS = "analytics",
54
53
  APP_BUILDER_CATALOG = "firefly",
55
54
  ASSETS_ESSENTIALS = "ddam",
@@ -90,6 +89,7 @@ export declare enum AppIds {
90
89
  JOURNEY_OPTIMIZER_B2B_EDITION = "sapphireHome",
91
90
  JOURNEY_ORCHESTRATION = "journeysNextAdmin",
92
91
  LAUNCH_IMPLEMENT = "implement",
92
+ LLM_OPTIMIZER = "llmOptimizer",
93
93
  MANAGED_SERVICES = "ivo-ui",
94
94
  MARKETO = "marketo",
95
95
  MARKETO_ENGAGE = "marketoEngage",
@@ -101,7 +101,6 @@ export declare enum AppIds {
101
101
  PERMISSIONS = "permissionsUI",
102
102
  PRIVACY_SERVICE = "privacyui",
103
103
  PROJECT_HUMMINGBIRD = "hummingbird",
104
- PROJECT_PANGEA = "usage-metrics",
105
104
  PROJECT_SIERRA = "cjm-home",
106
105
  REAL_TIME_CDP_COLLABORATION = "agoraUI",
107
106
  RTCDP_COLLABORATION = "agoraUI",
@@ -112,6 +111,7 @@ export declare enum AppIds {
112
111
  SYSTEM_STATUS = "systemStatus",
113
112
  TARGET = "target",
114
113
  TRIGGERS = "triggers",
114
+ UNIFIED_METRIC_CONTRACT_INSIGHTS = "usage-metrics",
115
115
  WORKFRONT = "workfront",
116
116
  WORKFRONT_FUSION = "fusion"
117
117
  }
package/appapi.js CHANGED
@@ -50,7 +50,6 @@ var AppIds;
50
50
  AppIds["ADOBE_EXPERIENCE_CLOUD_GRIFFON"] = "griffon";
51
51
  AppIds["ADVERTISING_CLOUD"] = "advertising-ssc";
52
52
  AppIds["ADVERTISING_SEARCH_SOCIAL_COMMERCE"] = "advertising-ssc";
53
- AppIds["AGENT_SCHEDULER"] = "aiComposer-agents";
54
53
  AppIds["ANALYTICS"] = "analytics";
55
54
  AppIds["APP_BUILDER_CATALOG"] = "firefly";
56
55
  AppIds["ASSETS_ESSENTIALS"] = "ddam";
@@ -91,6 +90,7 @@ var AppIds;
91
90
  AppIds["JOURNEY_OPTIMIZER_B2B_EDITION"] = "sapphireHome";
92
91
  AppIds["JOURNEY_ORCHESTRATION"] = "journeysNextAdmin";
93
92
  AppIds["LAUNCH_IMPLEMENT"] = "implement";
93
+ AppIds["LLM_OPTIMIZER"] = "llmOptimizer";
94
94
  AppIds["MANAGED_SERVICES"] = "ivo-ui";
95
95
  AppIds["MARKETO"] = "marketo";
96
96
  AppIds["MARKETO_ENGAGE"] = "marketoEngage";
@@ -102,7 +102,6 @@ var AppIds;
102
102
  AppIds["PERMISSIONS"] = "permissionsUI";
103
103
  AppIds["PRIVACY_SERVICE"] = "privacyui";
104
104
  AppIds["PROJECT_HUMMINGBIRD"] = "hummingbird";
105
- AppIds["PROJECT_PANGEA"] = "usage-metrics";
106
105
  AppIds["PROJECT_SIERRA"] = "cjm-home";
107
106
  AppIds["REAL_TIME_CDP_COLLABORATION"] = "agoraUI";
108
107
  AppIds["RTCDP_COLLABORATION"] = "agoraUI";
@@ -113,6 +112,7 @@ var AppIds;
113
112
  AppIds["SYSTEM_STATUS"] = "systemStatus";
114
113
  AppIds["TARGET"] = "target";
115
114
  AppIds["TRIGGERS"] = "triggers";
115
+ AppIds["UNIFIED_METRIC_CONTRACT_INSIGHTS"] = "usage-metrics";
116
116
  AppIds["WORKFRONT"] = "workfront";
117
117
  AppIds["WORKFRONT_FUSION"] = "fusion";
118
118
  })(AppIds || (exports.AppIds = AppIds = {}));
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;AAuCrC,0DAA0D;AAC1D,IAAY,MAuEX;AAvED,WAAY,MAAM;IAChB,yBAAe,CAAA;IACf,wCAA8B,CAAA;IAC9B,oDAA0C,CAAA;IAC1C,+CAAqC,CAAA;IACrC,gEAAsD,CAAA;IACtD,+CAAqC,CAAA;IACrC,iCAAuB,CAAA;IACvB,yCAA+B,CAAA;IAC/B,oCAA0B,CAAA;IAC1B,4CAAkC,CAAA;IAClC,8CAAoC,CAAA;IACpC,sCAA4B,CAAA;IAC5B,6CAAmC,CAAA;IACnC,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,0CAAgC,CAAA;IAChC,mCAAyB,CAAA;IACzB,6DAAmD,CAAA;IACnD,wCAA8B,CAAA;IAC9B,0DAAgD,CAAA;IAChD,kDAAwC,CAAA;IACxC,kDAAwC,CAAA;IACxC,sCAA4B,CAAA;IAC5B,+BAAqB,CAAA;IACrB,sCAA4B,CAAA;IAC5B,4CAAkC,CAAA;IAClC,sFAA4E,CAAA;IAC5E,4EAAkE,CAAA;IAClE,kDAAwC,CAAA;IACxC,kDAAwC,CAAA;IACxC,0DAAgD,CAAA;IAChD,4DAAkD,CAAA;IAClD,4DAAkD,CAAA;IAClD,4CAAkC,CAAA;IAClC,8DAAoD,CAAA;IACpD,8DAAoD,CAAA;IACpD,gDAAsC,CAAA;IACtC,sDAA4C,CAAA;IAC5C,4EAAkE,CAAA;IAClE,6CAAmC,CAAA;IACnC,iCAAuB,CAAA;IACvB,+BAAqB,CAAA;IACrB,wCAA8B,CAAA;IAC9B,wDAA8C,CAAA;IAC9C,qDAA2C,CAAA;IAC3C,wCAA8B,CAAA;IAC9B,qCAA2B,CAAA;IAC3B,6BAAmB,CAAA;IACnB,0CAAgC,CAAA;IAChC,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,2BAAiB,CAAA;IACjB,oEAA0D,CAAA;IAC1D,mCAAyB,CAAA;IACzB,uCAA6B,CAAA;IAC7B,uCAA6B,CAAA;IAC7B,6CAAmC,CAAA;IACnC,0CAAgC,CAAA;IAChC,qCAA2B,CAAA;IAC3B,iDAAuC,CAAA;IACvC,yCAA+B,CAAA;IAC/B,uCAA6B,CAAA;IAC7B,qDAA2C,CAAA;IAC3C,wDAA8C,CAAA;IAC9C,mCAAyB,CAAA;IACzB,wCAA8B,CAAA;IAC9B,2BAAiB,CAAA;IACjB,+BAAqB,CAAA;IACrB,iCAAuB,CAAA;IACvB,qCAA2B,CAAA;AAC7B,CAAC,EAvEW,MAAM,sBAAN,MAAM,QAuEjB;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;AAuCrC,0DAA0D;AAC1D,IAAY,MAuEX;AAvED,WAAY,MAAM;IAChB,yBAAe,CAAA;IACf,wCAA8B,CAAA;IAC9B,oDAA0C,CAAA;IAC1C,+CAAqC,CAAA;IACrC,gEAAsD,CAAA;IACtD,iCAAuB,CAAA;IACvB,yCAA+B,CAAA;IAC/B,oCAA0B,CAAA;IAC1B,4CAAkC,CAAA;IAClC,8CAAoC,CAAA;IACpC,sCAA4B,CAAA;IAC5B,6CAAmC,CAAA;IACnC,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,0CAAgC,CAAA;IAChC,mCAAyB,CAAA;IACzB,6DAAmD,CAAA;IACnD,wCAA8B,CAAA;IAC9B,0DAAgD,CAAA;IAChD,kDAAwC,CAAA;IACxC,kDAAwC,CAAA;IACxC,sCAA4B,CAAA;IAC5B,+BAAqB,CAAA;IACrB,sCAA4B,CAAA;IAC5B,4CAAkC,CAAA;IAClC,sFAA4E,CAAA;IAC5E,4EAAkE,CAAA;IAClE,kDAAwC,CAAA;IACxC,kDAAwC,CAAA;IACxC,0DAAgD,CAAA;IAChD,4DAAkD,CAAA;IAClD,4DAAkD,CAAA;IAClD,4CAAkC,CAAA;IAClC,8DAAoD,CAAA;IACpD,8DAAoD,CAAA;IACpD,gDAAsC,CAAA;IACtC,sDAA4C,CAAA;IAC5C,4EAAkE,CAAA;IAClE,6CAAmC,CAAA;IACnC,iCAAuB,CAAA;IACvB,+BAAqB,CAAA;IACrB,wCAA8B,CAAA;IAC9B,wDAA8C,CAAA;IAC9C,qDAA2C,CAAA;IAC3C,wCAA8B,CAAA;IAC9B,wCAA8B,CAAA;IAC9B,qCAA2B,CAAA;IAC3B,6BAAmB,CAAA;IACnB,0CAAgC,CAAA;IAChC,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,2BAAiB,CAAA;IACjB,oEAA0D,CAAA;IAC1D,mCAAyB,CAAA;IACzB,uCAA6B,CAAA;IAC7B,uCAA6B,CAAA;IAC7B,6CAAmC,CAAA;IACnC,qCAA2B,CAAA;IAC3B,iDAAuC,CAAA;IACvC,yCAA+B,CAAA;IAC/B,uCAA6B,CAAA;IAC7B,qDAA2C,CAAA;IAC3C,wDAA8C,CAAA;IAC9C,mCAAyB,CAAA;IACzB,wCAA8B,CAAA;IAC9B,2BAAiB,CAAA;IACjB,+BAAqB,CAAA;IACrB,4DAAkD,CAAA;IAClD,iCAAuB,CAAA;IACvB,qCAA2B,CAAA;AAC7B,CAAC,EAvEW,MAAM,sBAAN,MAAM,QAuEjB;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"}
@@ -0,0 +1,209 @@
1
+ /*************************************************************************
2
+ * Copyright 2021 Adobe
3
+ * All Rights Reserved.
4
+ *
5
+ * NOTICE: Adobe permits you to use, modify, and distribute this file in
6
+ * accordance with the terms of the Adobe license agreement accompanying
7
+ * it. If you have received this file from a source other than Adobe,
8
+ * then your use, modification, or distribution of it requires the prior
9
+ * written permission of Adobe.
10
+ **************************************************************************/
11
+ export interface CapabilityResponse {
12
+ /**
13
+ * Unique key to identify the capability.
14
+ */
15
+ capabilityId: string;
16
+ /**
17
+ * A URL to fetch the capability's icon.
18
+ */
19
+ iconUrl: string;
20
+ }
21
+ export declare enum CapabilityNames {
22
+ ACCOUNTPROFILE = "Profiles",
23
+ ACCOUNTSEGMENTS = "Segments",
24
+ ADMIN = "Configurations",
25
+ ALERT = "Alerts",
26
+ AMMHARMONIZATION = "Harmonized datasets",
27
+ AMMHOME = "Overview",
28
+ AMMMODELS = "Models",
29
+ AMMPLANS = "Plans",
30
+ APPCONFIGURATIONS = "App Configurations",
31
+ APPLICATIONS = "Applications",
32
+ APPSURFACES = "App Surfaces",
33
+ ASSETS = "Assets",
34
+ ASSURANCE = "Assurance",
35
+ CAMPAIGNS = "Campaigns",
36
+ CHANNELREPORTING = "Reports",
37
+ CLIENTPROPERTIES = "Tags",
38
+ COMPONENTS = "Components",
39
+ CONTENTTEMPLATES = "Content Templates",
40
+ CONTROLRULES = "Rules",
41
+ DASHBOARD = "Dashboards",
42
+ DATACLEANSING = "Data Hygiene",
43
+ DATACOLLECTIONMONITORING = "Monitoring",
44
+ DATAFLOW = "Dataflows",
45
+ DATASET = "Datasets",
46
+ DATASTREAMS = "Datastreams",
47
+ DATASTREAMSBETA = "Datastreams (Beta)",
48
+ DECISIONCONFIGURATION = "Configuration",
49
+ DECISIONITEMS = "Items",
50
+ DESTINATION = "Destinations",
51
+ FRAGMENTS = "Fragments",
52
+ GENSTUDIOASSETS = "Assets",
53
+ HOME = "Home",
54
+ IDENTITIES = "Identities",
55
+ IDENTITY = "Identities",
56
+ INITIATIVES = "Initiatives",
57
+ JOURNEYS = "Journeys",
58
+ LANDINGPAGES = "Landing pages",
59
+ LICENSEUSAGE = "License Usage",
60
+ MARKETINGCAMPAIGN = "Marketing Campaigns",
61
+ MESSAGES = "Messages",
62
+ MODEL = "Models",
63
+ MODELMANAGEMENT = "Model Management",
64
+ MONITORING = "Monitoring",
65
+ NOTEBOOK = "Notebooks",
66
+ OFFER = "Offers",
67
+ OFFERACTIVITY = "Components",
68
+ OPTIMIZATIONMETRICS = "Optimization metrics",
69
+ ORIONASSETS = "Assets",
70
+ ORIONCAMPAIGNS = "Campaigns",
71
+ ORIONHOME = "Home",
72
+ ORIONJOURNEYS = "Journeys",
73
+ ORIONPROJECTS = "Projects",
74
+ ORIONSCHEMAS = "Schemas",
75
+ ORIONSEGMENTAUDIENCE = "Audiences",
76
+ PERMISSIONSUI = "Permissions",
77
+ PLACES = "Places",
78
+ PLATFORMUIENCRYPTION = "Encryption",
79
+ PLAYBOOKS = "Playbooks",
80
+ POLICY = "Policies",
81
+ PRIVACYAUDIT = "Audits",
82
+ PRIVACYCONSOLE = "Privacy Console",
83
+ PROFILE = "Profiles",
84
+ PROSPECTAUDIENCE = "Audiences",
85
+ PROSPECTPROFILE = "Profiles",
86
+ QUERY = "Queries",
87
+ REPORT = "Reports",
88
+ REQUEST = "Requests",
89
+ SANDBOX = "Sandboxes",
90
+ SAPPHIREACCOUNTAUDIENCE = "Account Audiences",
91
+ SAPPHIREACCOUNTJOURNEY = "Account Journeys",
92
+ SAPPHIREBUYINGGROUPTEMPLATES = "Buying Group Templates",
93
+ SAPPHIREEMAILTEMPLATES = "Templates",
94
+ SAPPHIREINSIGHTSDASHBOARD = "Dashboard",
95
+ SAPPHIREMARKETOASSETS = "Assets",
96
+ SCENARIO = "Scenarios",
97
+ SCHEMA = "Schemas",
98
+ SEGMENT = "Segments",
99
+ SEGMENTAUDIENCE = "Audiences",
100
+ SERVERPROPERTIES = "Event Forwarding",
101
+ SERVICE = "Services",
102
+ SETTINGS = "Channels",
103
+ SOURCE = "Sources",
104
+ SUBSCRIPTIONS = "Subscription list",
105
+ TRANSLATIONPROJECTS = "Translation projects",
106
+ TRANSLATIONSERVICEADMIN = "Translations",
107
+ UNIFIEDTAGS = "Tags",
108
+ UNIFIEDTAGSBETA = "Tags (Beta)",
109
+ WORKFLOW = "Workflows"
110
+ }
111
+ export declare enum CapabilityIds {
112
+ ACCOUNTPROFILE = "accountProfile",
113
+ ACCOUNTSEGMENTS = "accountSegments",
114
+ ADMIN = "admin",
115
+ ALERT = "alert",
116
+ AMMHARMONIZATION = "ammharmonization",
117
+ AMMHOME = "ammhome",
118
+ AMMMODELS = "ammmodels",
119
+ AMMPLANS = "ammplans",
120
+ APPCONFIGURATIONS = "appconfigurations",
121
+ APPLICATIONS = "applications",
122
+ APPSURFACES = "appsurfaces",
123
+ ASSETS = "assets",
124
+ ASSURANCE = "assurance",
125
+ CAMPAIGNS = "campaigns",
126
+ CHANNELREPORTING = "channelReporting",
127
+ CLIENTPROPERTIES = "clientproperties",
128
+ COMPONENTS = "components",
129
+ CONTENTTEMPLATES = "contentTemplates",
130
+ CONTROLRULES = "controlRules",
131
+ DASHBOARD = "dashboard",
132
+ DATACLEANSING = "dataCleansing",
133
+ DATACOLLECTIONMONITORING = "datacollectionmonitoring",
134
+ DATAFLOW = "dataflow",
135
+ DATASET = "dataset",
136
+ DATASTREAMS = "datastreams",
137
+ DATASTREAMSBETA = "datastreamsbeta",
138
+ DECISIONCONFIGURATION = "decisionConfiguration",
139
+ DECISIONITEMS = "decisionItems",
140
+ DESTINATION = "destination",
141
+ FRAGMENTS = "fragments",
142
+ GENSTUDIOASSETS = "genStudioAssets",
143
+ HOME = "home",
144
+ IDENTITIES = "identities",
145
+ IDENTITY = "identity",
146
+ INITIATIVES = "initiatives",
147
+ JOURNEYS = "journeys",
148
+ LANDINGPAGES = "landingPages",
149
+ LICENSEUSAGE = "licenseUsage",
150
+ MARKETINGCAMPAIGN = "marketingCampaign",
151
+ MESSAGES = "messages",
152
+ MODEL = "model",
153
+ MODELMANAGEMENT = "modelmanagement",
154
+ MONITORING = "monitoring",
155
+ NOTEBOOK = "notebook",
156
+ OFFER = "offer",
157
+ OFFERACTIVITY = "offeractivity",
158
+ OPTIMIZATIONMETRICS = "optimizationMetrics",
159
+ ORIONASSETS = "orionAssets",
160
+ ORIONCAMPAIGNS = "orionCampaigns",
161
+ ORIONHOME = "orionHome",
162
+ ORIONJOURNEYS = "orionJourneys",
163
+ ORIONPROJECTS = "orionProjects",
164
+ ORIONSCHEMAS = "orionSchemas",
165
+ ORIONSEGMENTAUDIENCE = "orionSegmentAudience",
166
+ PERMISSIONSUI = "permissionsUI",
167
+ PLACES = "places",
168
+ PLATFORMUIENCRYPTION = "platformUIEncryption",
169
+ PLAYBOOKS = "playbooks",
170
+ POLICY = "policy",
171
+ PRIVACYAUDIT = "privacyAudit",
172
+ PRIVACYCONSOLE = "privacyConsole",
173
+ PROFILE = "profile",
174
+ PROSPECTAUDIENCE = "prospectAudience",
175
+ PROSPECTPROFILE = "prospectProfile",
176
+ QUERY = "query",
177
+ REPORT = "report",
178
+ REQUEST = "request",
179
+ SANDBOX = "sandbox",
180
+ SAPPHIREACCOUNTAUDIENCE = "sapphireAccountAudience",
181
+ SAPPHIREACCOUNTJOURNEY = "sapphireAccountJourney",
182
+ SAPPHIREBUYINGGROUPTEMPLATES = "sapphireBuyingGroupTemplates",
183
+ SAPPHIREEMAILTEMPLATES = "sapphireEmailTemplates",
184
+ SAPPHIREINSIGHTSDASHBOARD = "sapphireInsightsDashboard",
185
+ SAPPHIREMARKETOASSETS = "sapphireMarketoAssets",
186
+ SCENARIO = "scenario",
187
+ SCHEMA = "schema",
188
+ SEGMENT = "segment",
189
+ SEGMENTAUDIENCE = "segmentAudience",
190
+ SERVERPROPERTIES = "serverproperties",
191
+ SERVICE = "service",
192
+ SETTINGS = "settings",
193
+ SOURCE = "source",
194
+ SUBSCRIPTIONS = "subscriptions",
195
+ TRANSLATIONPROJECTS = "translationProjects",
196
+ TRANSLATIONSERVICEADMIN = "translationServiceAdmin",
197
+ UNIFIEDTAGS = "unifiedTags",
198
+ UNIFIEDTAGSBETA = "unifiedTagsBeta",
199
+ WORKFLOW = "workflow"
200
+ }
201
+ export interface CapabilityApi {
202
+ /**
203
+ * Gets the specified icon.
204
+ * @param icon The name of the capability, solution, or other to get an icon for.
205
+ */
206
+ get(capability: CapabilityNames | CapabilityIds): Promise<CapabilityResponse>;
207
+ }
208
+ declare const capabilityapi: CapabilityApi;
209
+ export default capabilityapi;