@adobe/exc-app 1.5.3 → 1.5.5

package/capabilityapi.js

@@ -0,0 +1,235 @@
+"use strict";
+/*************************************************************************
+ * Copyright 2021 Adobe
+ * All Rights Reserved.
+ *
+ * NOTICE: Adobe permits you to use, modify, and distribute this file in
+ * accordance with the terms of the Adobe license agreement accompanying
+ * it. If you have received this file from a source other than Adobe,
+ * then your use, modification, or distribution of it requires the prior
+ * written permission of Adobe.
+ **************************************************************************/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CapabilityIds = exports.CapabilityNames = void 0;
+/**
+ * API to request capability icons by id (or secondarily by display name).
+ *
+ * ***Import:***
+ *
+ * ```typescript
+ * import capabilityApi from '@adobe/exc-app/capabilityapi';
+ * ```
+ *
+ * ***Default export:***
+ *
+ * [CapabilityApi](../interfaces/capability.capabilityapi.md#interface-capabilityapi)
+ *
+ * ***Usage:***
+ * These APIs return promises, not properties, and will need to be
+ * asynchronously loaded by calling `get`.
+ *
+ * ```typescript
+ * const [home, assets, offer] = await Promise.all([
+ *   capabilityApi.get('home'),
+ *   capabilityApi.get('assets'),
+ *   capabilityApi.get('offer')
+ * ]);
+ *
+ * ```
+ *
+ * API for fetching capability icon data.
+ * @packageDocumentation
+ * @module capabilityapi
+ */
+const Global_1 = require("./src/Global");
+// This list is dynamically generated in preBuild
+var CapabilityNames;
+(function (CapabilityNames) {
+    CapabilityNames["ACCOUNTPROFILE"] = "Profiles";
+    CapabilityNames["ACCOUNTSEGMENTS"] = "Segments";
+    CapabilityNames["ADMIN"] = "Configurations";
+    CapabilityNames["ALERT"] = "Alerts";
+    CapabilityNames["AMMHARMONIZATION"] = "Harmonized datasets";
+    CapabilityNames["AMMHOME"] = "Overview";
+    CapabilityNames["AMMMODELS"] = "Models";
+    CapabilityNames["AMMPLANS"] = "Plans";
+    CapabilityNames["APPCONFIGURATIONS"] = "App Configurations";
+    CapabilityNames["APPLICATIONS"] = "Applications";
+    CapabilityNames["APPSURFACES"] = "App Surfaces";
+    CapabilityNames["ASSETS"] = "Assets";
+    CapabilityNames["ASSURANCE"] = "Assurance";
+    CapabilityNames["CAMPAIGNS"] = "Campaigns";
+    CapabilityNames["CHANNELREPORTING"] = "Reports";
+    CapabilityNames["CLIENTPROPERTIES"] = "Tags";
+    CapabilityNames["COMPONENTS"] = "Components";
+    CapabilityNames["CONTENTTEMPLATES"] = "Content Templates";
+    CapabilityNames["CONTROLRULES"] = "Rules";
+    CapabilityNames["DASHBOARD"] = "Dashboards";
+    CapabilityNames["DATACLEANSING"] = "Data Hygiene";
+    CapabilityNames["DATACOLLECTIONMONITORING"] = "Monitoring";
+    CapabilityNames["DATAFLOW"] = "Dataflows";
+    CapabilityNames["DATASET"] = "Datasets";
+    CapabilityNames["DATASTREAMS"] = "Datastreams";
+    CapabilityNames["DATASTREAMSBETA"] = "Datastreams (Beta)";
+    CapabilityNames["DECISIONCONFIGURATION"] = "Configuration";
+    CapabilityNames["DECISIONITEMS"] = "Items";
+    CapabilityNames["DESTINATION"] = "Destinations";
+    CapabilityNames["FRAGMENTS"] = "Fragments";
+    CapabilityNames["GENSTUDIOASSETS"] = "Assets";
+    CapabilityNames["HOME"] = "Home";
+    CapabilityNames["IDENTITIES"] = "Identities";
+    CapabilityNames["IDENTITY"] = "Identities";
+    CapabilityNames["INITIATIVES"] = "Initiatives";
+    CapabilityNames["JOURNEYS"] = "Journeys";
+    CapabilityNames["LANDINGPAGES"] = "Landing pages";
+    CapabilityNames["LICENSEUSAGE"] = "License Usage";
+    CapabilityNames["MARKETINGCAMPAIGN"] = "Marketing Campaigns";
+    CapabilityNames["MESSAGES"] = "Messages";
+    CapabilityNames["MODEL"] = "Models";
+    CapabilityNames["MODELMANAGEMENT"] = "Model Management";
+    CapabilityNames["MONITORING"] = "Monitoring";
+    CapabilityNames["NOTEBOOK"] = "Notebooks";
+    CapabilityNames["OFFER"] = "Offers";
+    CapabilityNames["OFFERACTIVITY"] = "Components";
+    CapabilityNames["OPTIMIZATIONMETRICS"] = "Optimization metrics";
+    CapabilityNames["ORIONASSETS"] = "Assets";
+    CapabilityNames["ORIONCAMPAIGNS"] = "Campaigns";
+    CapabilityNames["ORIONHOME"] = "Home";
+    CapabilityNames["ORIONJOURNEYS"] = "Journeys";
+    CapabilityNames["ORIONPROJECTS"] = "Projects";
+    CapabilityNames["ORIONSCHEMAS"] = "Schemas";
+    CapabilityNames["ORIONSEGMENTAUDIENCE"] = "Audiences";
+    CapabilityNames["PERMISSIONSUI"] = "Permissions";
+    CapabilityNames["PLACES"] = "Places";
+    CapabilityNames["PLATFORMUIENCRYPTION"] = "Encryption";
+    CapabilityNames["PLAYBOOKS"] = "Playbooks";
+    CapabilityNames["POLICY"] = "Policies";
+    CapabilityNames["PRIVACYAUDIT"] = "Audits";
+    CapabilityNames["PRIVACYCONSOLE"] = "Privacy Console";
+    CapabilityNames["PROFILE"] = "Profiles";
+    CapabilityNames["PROSPECTAUDIENCE"] = "Audiences";
+    CapabilityNames["PROSPECTPROFILE"] = "Profiles";
+    CapabilityNames["QUERY"] = "Queries";
+    CapabilityNames["REPORT"] = "Reports";
+    CapabilityNames["REQUEST"] = "Requests";
+    CapabilityNames["SANDBOX"] = "Sandboxes";
+    CapabilityNames["SAPPHIREACCOUNTAUDIENCE"] = "Account Audiences";
+    CapabilityNames["SAPPHIREACCOUNTJOURNEY"] = "Account Journeys";
+    CapabilityNames["SAPPHIREBUYINGGROUPTEMPLATES"] = "Buying Group Templates";
+    CapabilityNames["SAPPHIREEMAILTEMPLATES"] = "Templates";
+    CapabilityNames["SAPPHIREINSIGHTSDASHBOARD"] = "Dashboard";
+    CapabilityNames["SAPPHIREMARKETOASSETS"] = "Assets";
+    CapabilityNames["SCENARIO"] = "Scenarios";
+    CapabilityNames["SCHEMA"] = "Schemas";
+    CapabilityNames["SEGMENT"] = "Segments";
+    CapabilityNames["SEGMENTAUDIENCE"] = "Audiences";
+    CapabilityNames["SERVERPROPERTIES"] = "Event Forwarding";
+    CapabilityNames["SERVICE"] = "Services";
+    CapabilityNames["SETTINGS"] = "Channels";
+    CapabilityNames["SOURCE"] = "Sources";
+    CapabilityNames["SUBSCRIPTIONS"] = "Subscription list";
+    CapabilityNames["TRANSLATIONPROJECTS"] = "Translation projects";
+    CapabilityNames["TRANSLATIONSERVICEADMIN"] = "Translations";
+    CapabilityNames["UNIFIEDTAGS"] = "Tags";
+    CapabilityNames["UNIFIEDTAGSBETA"] = "Tags (Beta)";
+    CapabilityNames["WORKFLOW"] = "Workflows";
+})(CapabilityNames = exports.CapabilityNames || (exports.CapabilityNames = {}));
+// This list is dynamically generated in preBuild
+var CapabilityIds;
+(function (CapabilityIds) {
+    CapabilityIds["ACCOUNTPROFILE"] = "accountProfile";
+    CapabilityIds["ACCOUNTSEGMENTS"] = "accountSegments";
+    CapabilityIds["ADMIN"] = "admin";
+    CapabilityIds["ALERT"] = "alert";
+    CapabilityIds["AMMHARMONIZATION"] = "ammharmonization";
+    CapabilityIds["AMMHOME"] = "ammhome";
+    CapabilityIds["AMMMODELS"] = "ammmodels";
+    CapabilityIds["AMMPLANS"] = "ammplans";
+    CapabilityIds["APPCONFIGURATIONS"] = "appconfigurations";
+    CapabilityIds["APPLICATIONS"] = "applications";
+    CapabilityIds["APPSURFACES"] = "appsurfaces";
+    CapabilityIds["ASSETS"] = "assets";
+    CapabilityIds["ASSURANCE"] = "assurance";
+    CapabilityIds["CAMPAIGNS"] = "campaigns";
+    CapabilityIds["CHANNELREPORTING"] = "channelReporting";
+    CapabilityIds["CLIENTPROPERTIES"] = "clientproperties";
+    CapabilityIds["COMPONENTS"] = "components";
+    CapabilityIds["CONTENTTEMPLATES"] = "contentTemplates";
+    CapabilityIds["CONTROLRULES"] = "controlRules";
+    CapabilityIds["DASHBOARD"] = "dashboard";
+    CapabilityIds["DATACLEANSING"] = "dataCleansing";
+    CapabilityIds["DATACOLLECTIONMONITORING"] = "datacollectionmonitoring";
+    CapabilityIds["DATAFLOW"] = "dataflow";
+    CapabilityIds["DATASET"] = "dataset";
+    CapabilityIds["DATASTREAMS"] = "datastreams";
+    CapabilityIds["DATASTREAMSBETA"] = "datastreamsbeta";
+    CapabilityIds["DECISIONCONFIGURATION"] = "decisionConfiguration";
+    CapabilityIds["DECISIONITEMS"] = "decisionItems";
+    CapabilityIds["DESTINATION"] = "destination";
+    CapabilityIds["FRAGMENTS"] = "fragments";
+    CapabilityIds["GENSTUDIOASSETS"] = "genStudioAssets";
+    CapabilityIds["HOME"] = "home";
+    CapabilityIds["IDENTITIES"] = "identities";
+    CapabilityIds["IDENTITY"] = "identity";
+    CapabilityIds["INITIATIVES"] = "initiatives";
+    CapabilityIds["JOURNEYS"] = "journeys";
+    CapabilityIds["LANDINGPAGES"] = "landingPages";
+    CapabilityIds["LICENSEUSAGE"] = "licenseUsage";
+    CapabilityIds["MARKETINGCAMPAIGN"] = "marketingCampaign";
+    CapabilityIds["MESSAGES"] = "messages";
+    CapabilityIds["MODEL"] = "model";
+    CapabilityIds["MODELMANAGEMENT"] = "modelmanagement";
+    CapabilityIds["MONITORING"] = "monitoring";
+    CapabilityIds["NOTEBOOK"] = "notebook";
+    CapabilityIds["OFFER"] = "offer";
+    CapabilityIds["OFFERACTIVITY"] = "offeractivity";
+    CapabilityIds["OPTIMIZATIONMETRICS"] = "optimizationMetrics";
+    CapabilityIds["ORIONASSETS"] = "orionAssets";
+    CapabilityIds["ORIONCAMPAIGNS"] = "orionCampaigns";
+    CapabilityIds["ORIONHOME"] = "orionHome";
+    CapabilityIds["ORIONJOURNEYS"] = "orionJourneys";
+    CapabilityIds["ORIONPROJECTS"] = "orionProjects";
+    CapabilityIds["ORIONSCHEMAS"] = "orionSchemas";
+    CapabilityIds["ORIONSEGMENTAUDIENCE"] = "orionSegmentAudience";
+    CapabilityIds["PERMISSIONSUI"] = "permissionsUI";
+    CapabilityIds["PLACES"] = "places";
+    CapabilityIds["PLATFORMUIENCRYPTION"] = "platformUIEncryption";
+    CapabilityIds["PLAYBOOKS"] = "playbooks";
+    CapabilityIds["POLICY"] = "policy";
+    CapabilityIds["PRIVACYAUDIT"] = "privacyAudit";
+    CapabilityIds["PRIVACYCONSOLE"] = "privacyConsole";
+    CapabilityIds["PROFILE"] = "profile";
+    CapabilityIds["PROSPECTAUDIENCE"] = "prospectAudience";
+    CapabilityIds["PROSPECTPROFILE"] = "prospectProfile";
+    CapabilityIds["QUERY"] = "query";
+    CapabilityIds["REPORT"] = "report";
+    CapabilityIds["REQUEST"] = "request";
+    CapabilityIds["SANDBOX"] = "sandbox";
+    CapabilityIds["SAPPHIREACCOUNTAUDIENCE"] = "sapphireAccountAudience";
+    CapabilityIds["SAPPHIREACCOUNTJOURNEY"] = "sapphireAccountJourney";
+    CapabilityIds["SAPPHIREBUYINGGROUPTEMPLATES"] = "sapphireBuyingGroupTemplates";
+    CapabilityIds["SAPPHIREEMAILTEMPLATES"] = "sapphireEmailTemplates";
+    CapabilityIds["SAPPHIREINSIGHTSDASHBOARD"] = "sapphireInsightsDashboard";
+    CapabilityIds["SAPPHIREMARKETOASSETS"] = "sapphireMarketoAssets";
+    CapabilityIds["SCENARIO"] = "scenario";
+    CapabilityIds["SCHEMA"] = "schema";
+    CapabilityIds["SEGMENT"] = "segment";
+    CapabilityIds["SEGMENTAUDIENCE"] = "segmentAudience";
+    CapabilityIds["SERVERPROPERTIES"] = "serverproperties";
+    CapabilityIds["SERVICE"] = "service";
+    CapabilityIds["SETTINGS"] = "settings";
+    CapabilityIds["SOURCE"] = "source";
+    CapabilityIds["SUBSCRIPTIONS"] = "subscriptions";
+    CapabilityIds["TRANSLATIONPROJECTS"] = "translationProjects";
+    CapabilityIds["TRANSLATIONSERVICEADMIN"] = "translationServiceAdmin";
+    CapabilityIds["UNIFIEDTAGS"] = "unifiedTags";
+    CapabilityIds["UNIFIEDTAGSBETA"] = "unifiedTagsBeta";
+    CapabilityIds["WORKFLOW"] = "workflow";
+})(CapabilityIds = exports.CapabilityIds || (exports.CapabilityIds = {}));
+const capabilityapi = {
+    get: params => {
+        return (0, Global_1.getImpl)('capabilityApi')().get(params);
+    }
+};
+exports.default = capabilityapi;
+//# sourceMappingURL=capabilityapi.js.map

package/capabilityapi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"capabilityapi.js","sourceRoot":"","sources":["capabilityapi.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,yCAAqC;AAarC,iDAAiD;AACjD,IAAY,eAyFX;AAzFD,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,6CAA0B,CAAA;IAC1B,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,yCAAsB,CAAA;IACtB,+CAA4B,CAAA;IAC5B,qCAAkB,CAAA;IAClB,6CAA0B,CAAA;IAC1B,6CAA0B,CAAA;IAC1B,2CAAwB,CAAA;IACxB,qDAAkC,CAAA;IAClC,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,8DAA2C,CAAA;IAC3C,0EAAuD,CAAA;IACvD,uDAAoC,CAAA;IACpC,0DAAuC,CAAA;IACvC,mDAAgC,CAAA;IAChC,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,EAzFW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAyF1B;AAED,iDAAiD;AACjD,IAAY,aAyFX;AAzFD,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,oDAAmC,CAAA;IACnC,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,4CAA2B,CAAA;IAC3B,kDAAiC,CAAA;IACjC,wCAAuB,CAAA;IACvB,gDAA+B,CAAA;IAC/B,gDAA+B,CAAA;IAC/B,8CAA6B,CAAA;IAC7B,8DAA6C,CAAA;IAC7C,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,kEAAiD,CAAA;IACjD,8EAA6D,CAAA;IAC7D,kEAAiD,CAAA;IACjD,wEAAuD,CAAA;IACvD,gEAA+C,CAAA;IAC/C,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,EAzFW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAyFxB;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"}

package/interframe.d.ts

@@ -29,6 +29,15 @@ export declare enum InterFrameError {
     TARGET_NOT_FOUND = "TARGET_NOT_FOUND",
     UNKNOWN_ERROR = "ERROR"
 }
+/**
+ * Extensible list of action types that have automatic shell handlers.
+ */
+export declare enum InterFrameActionType {
+    /**
+     * Used to get and send context information between app and rail frames that will be included with messages in AI Assistant.
+     */
+    APP_CONTEXT = "APP_CONTEXT"
+}
 /**
  * Inter-frame request message.
  * Used when one frame (app or rail) needs to send a message to another frame.
@@ -43,7 +52,7 @@ export interface InterFrameRequest {
     /**
      * Data accompanying the action to be sent and emitted.
      */
-    data: any;
+    data: Record<string, any>;
     requestId: string;
     source: FrameTarget;
     target: FrameTarget;
@@ -53,10 +62,10 @@ export interface InterFrameRequest {
  * Sent back to the requesting frame with results or errors.
  */
 export interface InterFrameResponse {
-    data?: any;
+    data?: Record<string, any>;
     error?: {
         code: string;
-        details?: any;
+        details?: Record<string, any>;
         message: string;
     };
     requestId: string;
@@ -112,8 +121,8 @@ export interface ResponseCallbacks {
     sendError: (error: {
         code: string;
         message: string;
-        details?: any;
-    } | any) => void;
+        details?: Record<string, any>;
+    }) => void;
     /**
      * Send a progress update.
      */

package/interframe.js

@@ -10,7 +10,7 @@
  * written permission of Adobe.
  **************************************************************************/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InterFrameError = exports.InterFrameMessageType = exports.InterFrameResponseStatus = exports.InterFrameTarget = exports.FrameTarget = void 0;
+exports.InterFrameActionType = exports.InterFrameError = exports.InterFrameMessageType = exports.InterFrameResponseStatus = exports.InterFrameTarget = exports.FrameTarget = void 0;
 /**
  * APIs for inter-frame communication between app and rail iframes.
  *
@@ -70,6 +70,16 @@ var InterFrameError;
     InterFrameError["TARGET_NOT_FOUND"] = "TARGET_NOT_FOUND";
     InterFrameError["UNKNOWN_ERROR"] = "ERROR";
 })(InterFrameError || (exports.InterFrameError = InterFrameError = {}));
+/**
+ * Extensible list of action types that have automatic shell handlers.
+ */
+var InterFrameActionType;
+(function (InterFrameActionType) {
+    /**
+     * Used to get and send context information between app and rail frames that will be included with messages in AI Assistant.
+     */
+    InterFrameActionType["APP_CONTEXT"] = "APP_CONTEXT";
+})(InterFrameActionType || (exports.InterFrameActionType = InterFrameActionType = {}));
 const interFrame = {
     emit: (type, evt) => {
         return (0, Global_1.getImpl)('interFrame')().emit(type, evt);

package/interframe.js.map

@@ -1 +1 @@
-{"version":3,"file":"interframe.js","sourceRoot":"","sources":["interframe.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,yCAAqC;AAErC,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,0BAAW,CAAA;IACX,4BAAa,CAAA;AACf,CAAC,EAHW,WAAW,2BAAX,WAAW,QAGtB;AAED,oCAAoC;AACvB,QAAA,gBAAgB,GAAG,WAAW,CAAC;AAE5C,IAAY,wBAKX;AALD,WAAY,wBAAwB;IAClC,uDAA2B,CAAA;IAC3B,mDAAuB,CAAA;IACvB,6CAAiB,CAAA;IACjB,yDAA6B,CAAA;AAC/B,CAAC,EALW,wBAAwB,wCAAxB,wBAAwB,QAKnC;AAED,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC/B,4EAAmD,CAAA;IACnD,oEAA2C,CAAA;IAC3C,sEAA6C,CAAA;AAC/C,CAAC,EAJW,qBAAqB,qCAArB,qBAAqB,QAIhC;AAED,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,4CAAyB,CAAA;IACzB,wDAAqC,CAAA;IACrC,0CAAuB,CAAA;AACzB,CAAC,EAJW,eAAe,+BAAf,eAAe,QAI1B;AAoKD,MAAM,UAAU,GAAG;IACjB,IAAI,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;QAClB,OAAO,IAAA,gBAAO,EAAC,YAAY,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACjD,CAAC;IACD,GAAG,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;QACrB,OAAO,IAAA,gBAAO,EAAC,YAAY,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IACD,EAAE,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;QACpB,OAAO,IAAA,gBAAO,EAAC,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IACD,IAAI,EAAE,CAAC,MAAc,EAAE,SAAyB,EAAE,IAAU,EAAE,MAAoB,EAAE,EAAE;QACpF,OAAO,IAAA,gBAAO,EAAC,YAAY,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;CACe,CAAC;AAEnB,kBAAe,UAAU,CAAC"}
+{"version":3,"file":"interframe.js","sourceRoot":"","sources":["interframe.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,yCAAqC;AAErC,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,0BAAW,CAAA;IACX,4BAAa,CAAA;AACf,CAAC,EAHW,WAAW,2BAAX,WAAW,QAGtB;AAED,oCAAoC;AACvB,QAAA,gBAAgB,GAAG,WAAW,CAAC;AAE5C,IAAY,wBAKX;AALD,WAAY,wBAAwB;IAClC,uDAA2B,CAAA;IAC3B,mDAAuB,CAAA;IACvB,6CAAiB,CAAA;IACjB,yDAA6B,CAAA;AAC/B,CAAC,EALW,wBAAwB,wCAAxB,wBAAwB,QAKnC;AAED,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC/B,4EAAmD,CAAA;IACnD,oEAA2C,CAAA;IAC3C,sEAA6C,CAAA;AAC/C,CAAC,EAJW,qBAAqB,qCAArB,qBAAqB,QAIhC;AAED,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,4CAAyB,CAAA;IACzB,wDAAqC,CAAA;IACrC,0CAAuB,CAAA;AACzB,CAAC,EAJW,eAAe,+BAAf,eAAe,QAI1B;AAED;;GAEG;AACH,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B;;OAEG;IACH,mDAA2B,CAAA;AAC7B,CAAC,EALW,oBAAoB,oCAApB,oBAAoB,QAK/B;AAoKD,MAAM,UAAU,GAAG;IACjB,IAAI,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;QAClB,OAAO,IAAA,gBAAO,EAAC,YAAY,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACjD,CAAC;IACD,GAAG,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;QACrB,OAAO,IAAA,gBAAO,EAAC,YAAY,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IACD,EAAE,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;QACpB,OAAO,IAAA,gBAAO,EAAC,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IACD,IAAI,EAAE,CAAC,MAAc,EAAE,SAAyB,EAAE,IAAU,EAAE,MAAoB,EAAE,EAAE;QACpF,OAAO,IAAA,gBAAO,EAAC,YAAY,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;CACe,CAAC;AAEnB,kBAAe,UAAU,CAAC"}

package/network.d.ts

@@ -51,7 +51,6 @@
  * @packageDocumentation
  * @module network
  */
-import type { APIMode } from './RuntimeConfiguration';
 import type { ApolloClient, ApolloClientOptions, ApolloLink, HttpLink, InMemoryCacheConfig, NormalizedCacheObject } from '@apollo/client';
 import { CacheEntry } from './cache';
 import type { gql } from 'graphql-tag';
@@ -61,11 +60,17 @@ import type { Sandbox } from './appcontext';
  */
 export declare const DEFAULT_STATUS_CODES_TO_RETRY: number[];
 export type GraphQLRegion = 'va7' | 'aus5' | 'nld2' | 'va6';
+export type APIMode = 'io' | 'afd';
 export interface FetchOptions {
     /**
      * A boolean value indicating whether to add Authentication token, API Key to the request.
      */
     auth?: 'Header' | 'Body';
+    /**
+     * Whether the region lock on requests should be bypassed and the provided URL
+     * should be used exclusively.
+     */
+    bypassRegionLock?: boolean;
     /**
      * Number indicating how many fetch attempts should be made using exponential backoff.
      */
@@ -94,11 +99,7 @@ export interface FetchOptions {
 /**
  * @ignore
  */
-export interface Configuration {
-    /**
-     * Unified Shell API Gateway URL
-     */
-    apiGatewayUrl: string;
+export interface Configuration extends BaseNetworkConfig {
     /**
      * API Key that will be added to x-api-key on requests
      */
@@ -107,58 +108,30 @@ export interface Configuration {
      * appId from solution route config
      */
     appId: string;
-    /**
-     * Should API calls go directly to IO or accelerated via AFD/AWS (Default 'afd')
-     */
-    apiMode?: APIMode;
     /**
      * IMS Client ID
      */
     imsClientId?: string;
     /**
-     * IMS Token
+     * IMS org id
      */
-    imsToken: string;
+    imsOrg?: string;
     /**
-     * Is the org an AWS org
+     * IMS Token
      */
-    isAWSOrg?: boolean;
+    imsToken: string;
     /**
      * metricsAppId from solution route config
      */
     metricsAppId?: string;
-    /**
-     * Ims Org Region
-     */
-    orgRegion?: string;
-    /**
-     * @deprecated tenantAppId from solution route config
-     */
-    tenantAppId?: string;
-    /**
-     * IMS org id
-     */
-    imsOrg?: string;
     /**
      * Current sandbox object
      */
     sandbox?: Sandbox;
     /**
-     * Adobe IO gateway URL used as a fallback in GQL call
-     */
-    ioGatewayUrl?: string;
-    /**
-     * Map of Adobe IO region specific endpoints.
-     */
-    ioRegionSpecificMap?: Record<string, string>;
-    /**
-     * Clients can pass in their local GQL endpoint
-     */
-    gqlEndpoint?: string;
-    /**
-     * XQL gateway used for AEP specific queries
+     * @deprecated tenantAppId from solution route config
      */
-    xqlGatewayUrl?: string;
+    tenantAppId?: string;
 }
 /**
  * GQL Query containing graphql query and variables.
@@ -276,6 +249,11 @@ export interface QueryRequest {
      * Overwrite config.appId until federation is out. This allow scenario where sharing components that are linked to their own tenants.
      */
     appId?: string;
+    /**
+     * Whether the region lock on requests should be bypassed and the provided URL
+     * should be used exclusively.
+     */
+    bypassRegionLock?: boolean;
     /**
      * Data containing single or multiple GQL queries.
      *
@@ -400,6 +378,103 @@ export declare enum FetchScope {
      */
     SANDBOX_PLUS = "SANDBOX_PLUS"
 }
+/**
+ * The network configuration properties that are defined in Unified Shell, are
+ * mostly made available to the network API through the RuntimeConfiguration
+ * object so requests can be made to the correct place.
+ */
+export interface BaseNetworkConfig {
+    /**
+     * Unified Shell API Gateway URL
+     */
+    apiGatewayUrl: string;
+    /**
+     * Should API calls go directly to IO or accelerated via AFD/AWS (Default 'afd')
+     */
+    apiMode: APIMode;
+    /**
+     * Clients can pass in their local GQL endpoint
+     */
+    gqlEndpoint?: string;
+    /**
+     * Adobe IO gateway URL used as a fallback in GQL call
+     */
+    ioGatewayUrl: string;
+    /**
+     * Map of Adobe Io region specific endpoints.
+     */
+    ioRegionSpecificMap: Record<string, string>;
+    /**
+     * Whether the current region, if any, is locked.
+     */
+    isRegionLocked: boolean;
+    /**
+     * Region assigned to the IMS org, assigned to the AEP product.
+     */
+    orgRegion?: string;
+    /**
+     * Settings-specific IO gateway URL
+     */
+    settingsIoGatewayUrl: string;
+    /**
+     * XQL gateway used for AEP specific queries
+     */
+    xqlGatewayUrl: string;
+    /**
+     * Map of XQL region specific endpoints.
+     */
+    xqlRegionSpecificMap: Record<string, string>;
+}
+export interface FetchConfig extends BaseNetworkConfig {
+    apiKey: string;
+    appId: string;
+    imsOrg: string;
+    imsToken: string;
+    sandbox: Sandbox;
+}
+export interface GraphQLConfig extends BaseNetworkConfig {
+    appId: string;
+}
+/**
+ * Input properties for the getRegionEndpoint function.
+ */
+export interface RegionalEndpointInput {
+    /**
+     * For requests that should bypass the CDN if they are not regional.
+     */
+    bypassCDN?: boolean;
+    /**
+     * Current Adobe.io endpoint used that should be region-adjusted.
+     */
+    ioEndpoint?: string;
+    /**
+     * Service type to get the regional endpoint for. One of GRAPHQL, IO, XQL.
+     */
+    type: ServiceType;
+}
+/**
+ * Result of the getRegionEndpoint function.
+ */
+export interface RegionalEndpointResult {
+    /**
+     * Whether the endpoint was adjusted for region.
+     */
+    adjusted: boolean;
+    /**
+     * Endpoint that has possibly been adjusted. Will only be undefined if an
+     * invalid type was passed in.
+     */
+    endpoint?: string;
+}
+/**
+ * Service type enum.
+ */
+export declare enum ServiceType {
+    GRAPHQL = "GRAPHQL",
+    IO = "IO",
+    SETTINGS = "SETTINGS",
+    XQL = "XQL"
+}
 /**
  * Defines the object containing any custom settings that you want to apply to the request. You can
  * also additionally specify the 'auth' parameter to automatically set the Authentication, API key in Headers/Query params.
@@ -467,6 +542,33 @@ export interface NetworkApi {
      * @returns Promise for the contract execution response
      */
     getPrefetched<T>(key: string, options?: PrefetchOptions): Promise<PrefetchResponse<T>>;
+    /**
+     * Provides an interface for requesting a region-adjusted endpoint for a
+     * specific service type. This uses the region associated with the currently
+     * enabled IMS organization, via the Platform region property. If this value
+     * is not available, the default endpoint will be returned.
+     *
+     * ***Example:***
+     *
+     * ```typescript
+     * // Requests the region-adjusted endpoint for GraphQL
+     * getRegionEndpoint({type: ServiceType.GRAPHQL});
+     *
+     * // Requests the region-adjusted endpoint for Adobe.io
+     * getRegionEndpoint({type: ServiceType.IO});
+     *
+     * // Requests the region-adjusted endpoint for XQL
+     * getRegionEndpoint({type: ServiceType.XQL});
+     *
+     * // Requests the region-adjusted endpoint for Adobe.io, but provides the
+     * // current Adobe.io endpoint, which will be modified accordingly.
+     * // Note: This only works on supported Adobe.io tenants.
+     * getRegionEndpoint({endpoint: 'https://experience.adobe.io/some/path', type: ServiceType.IO});
+     * ```
+     * @param input Endpoint options.
+     * @returns The region-adjusted endpoint for the service.
+     */
+    getRegionEndpoint(input: RegionalEndpointInput): RegionalEndpointResult;
     /**
      * Provides an interface for querying resources via GraphqQL.
      * In order to consume query, please make sure the respective query resolver is
@@ -567,6 +669,33 @@ export declare function fetch(input: RequestInfo, init?: FetchInit): Promise<Res
  * @returns Promise for the contract execution response
  */
 export declare function getPrefetched<T>(key: string, options?: PrefetchOptions): Promise<PrefetchResponse<T>>;
+/**
+ * Provides an interface for requesting a region-adjusted endpoint for a
+ * specific service type. This uses the region associated with the currently
+ * enabled IMS organization, via the Platform region property. If this value
+ * is not available, the default endpoint will be returned.
+ *
+ * ***Example:***
+ *
+ * ```typescript
+ * // Requests the region-adjusted endpoint for GraphQL
+ * getRegionEndpoint({type: ServiceType.GRAPHQL});
+ *
+ * // Requests the region-adjusted endpoint for Adobe.io
+ * getRegionEndpoint({type: ServiceType.IO});
+ *
+ * // Requests the region-adjusted endpoint for XQL
+ * getRegionEndpoint({type: ServiceType.XQL});
+ *
+ * // Requests the region-adjusted endpoint for Adobe.io, but provides the
+ * // current Adobe.io endpoint, which will be modified accordingly.
+ * // Note: This only works on supported Adobe.io tenants.
+ * getRegionEndpoint({endpoint: 'https://experience.adobe.io/some/path', type: ServiceType.IO});
+ * ```
+ * @param input Endpoint options.
+ * @returns The region-adjusted endpoint for the service.
+ */
+export declare function getRegionEndpoint(input: RegionalEndpointInput): RegionalEndpointResult;
 /**
  * Provides an interface for querying resources via GraphqQL.
  * In order to consume query, please make sure the respective query resolver is

package/network.js

@@ -10,9 +10,10 @@
  * written permission of Adobe.
  **************************************************************************/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FetchScope = exports.ROUTING = exports.DEFAULT_STATUS_CODES_TO_RETRY = void 0;
+exports.ServiceType = exports.FetchScope = exports.ROUTING = exports.DEFAULT_STATUS_CODES_TO_RETRY = void 0;
 exports.fetch = fetch;
 exports.getPrefetched = getPrefetched;
+exports.getRegionEndpoint = getRegionEndpoint;
 exports.query = query;
 exports.getApolloClient = getApolloClient;
 exports.createApolloClient = createApolloClient;
@@ -78,6 +79,16 @@ var FetchScope;
      */
     FetchScope["SANDBOX_PLUS"] = "SANDBOX_PLUS";
 })(FetchScope || (exports.FetchScope = FetchScope = {}));
+/**
+ * Service type enum.
+ */
+var ServiceType;
+(function (ServiceType) {
+    ServiceType["GRAPHQL"] = "GRAPHQL";
+    ServiceType["IO"] = "IO";
+    ServiceType["SETTINGS"] = "SETTINGS";
+    ServiceType["XQL"] = "XQL";
+})(ServiceType || (exports.ServiceType = ServiceType = {}));
 /**
  * Provides an interface for fetching resources powered by the global 'fetch' API.
  *
@@ -119,6 +130,35 @@ function fetch(input, init) {
 function getPrefetched(key, options) {
     return (0, Global_1.getImpl)('network').getPrefetched(key, options);
 }
+/**
+ * Provides an interface for requesting a region-adjusted endpoint for a
+ * specific service type. This uses the region associated with the currently
+ * enabled IMS organization, via the Platform region property. If this value
+ * is not available, the default endpoint will be returned.
+ *
+ * ***Example:***
+ *
+ * ```typescript
+ * // Requests the region-adjusted endpoint for GraphQL
+ * getRegionEndpoint({type: ServiceType.GRAPHQL});
+ *
+ * // Requests the region-adjusted endpoint for Adobe.io
+ * getRegionEndpoint({type: ServiceType.IO});
+ *
+ * // Requests the region-adjusted endpoint for XQL
+ * getRegionEndpoint({type: ServiceType.XQL});
+ *
+ * // Requests the region-adjusted endpoint for Adobe.io, but provides the
+ * // current Adobe.io endpoint, which will be modified accordingly.
+ * // Note: This only works on supported Adobe.io tenants.
+ * getRegionEndpoint({endpoint: 'https://experience.adobe.io/some/path', type: ServiceType.IO});
+ * ```
+ * @param input Endpoint options.
+ * @returns The region-adjusted endpoint for the service.
+ */
+function getRegionEndpoint(input) {
+    return (0, Global_1.getImpl)('network').getRegionEndpoint(input);
+}
 /**
  * Provides an interface for querying resources via GraphqQL.
  * In order to consume query, please make sure the respective query resolver is