@adobe/exc-app 1.4.7 → 1.4.9

package/RuntimeConfiguration.d.ts

@@ -9,9 +9,9 @@
  * written permission of Adobe.
  **************************************************************************/
 import type { ActiveProductContext, ImsProfile } from './ims/ImsProfile';
+import type { Collaborator, Sandbox } from './user';
 import type { ConsentPermissions } from './consent';
 import type MetricsConfiguration from './metrics/Configuration';
-import type { Sandbox } from './user';
 export interface UserRoles {
     roleJobFunction: Record<string, boolean>;
     rolePlatformObjective: Record<string, boolean | string>;
@@ -143,6 +143,28 @@ export interface ImsInfo {
      */
     tenant?: string;
 }
+type FulfillableDataItem = Record<string, string>;
+/**
+ * Processed ImsOrg Data Interface
+ */
+export interface ProcessedImsOrg {
+    /**
+     * Map of service codes to fulfillable data for the current ImsOrg.
+     */
+    fulfillableData: Record<string, FulfillableDataItem[]>;
+    /**
+     * Map of service codes to fulfillable items for the current ImsOrg.
+     */
+    fulfillableItems: Record<string, string[]>;
+    /**
+     * Service codes attached to the current ImsOrg.
+     */
+    serviceCodes: string[];
+    /**
+     * Map of service codes to sub service codes for the current ImsOrg.
+     */
+    subServiceCodes: Record<string, string[]>;
+}
 /**
  * User SubOrg Interface
  */
@@ -260,6 +282,10 @@ export interface RuntimeConfiguration {
      * List all properties changed in this configuration compared to the previous one sent
      */
     changedProperties: (keyof RuntimeConfiguration)[];
+    /**
+     * Current Agora Collaborator
+     */
+    collaborator?: Collaborator;
     /**
      * Bootstrap data for the component modal.
      */
@@ -356,6 +382,10 @@ export interface RuntimeConfiguration {
      * Is the org an AWS org
      */
     isAWSOrg?: boolean;
+    /**
+     * Flag to know that the S2 design language is being used.
+     */
+    isS2Enabled: boolean;
     /**
      * Last recorded recent timestamp
      */
@@ -396,6 +426,10 @@ export interface RuntimeConfiguration {
      * List of languages from user's preferences
      */
     preferredLanguages?: string[];
+    /**
+     * Processed ImsOrg Data
+     */
+    processedImsOrg?: ProcessedImsOrg;
     /**
      * Current Sandbox
      */
@@ -412,6 +446,10 @@ export interface RuntimeConfiguration {
      * Is Side Nav collapsed?
      */
     shellSideNavCollapsed?: boolean;
+    /**
+     * Is the Side Nav custom button in use?
+     */
+    shellSideNavCustomButton?: boolean;
     /**
      * Is Side Nav enabled?
      */
@@ -420,6 +458,10 @@ export interface RuntimeConfiguration {
      * Side Nav width
      */
     shellSideNavWidth: number;
+    /**
+     * Is the window small? (Are the sidenav/AI Assistant in overlay state?)
+     */
+    smallWindow?: boolean;
     /**
      * Source environment
      */
@@ -428,6 +470,10 @@ export interface RuntimeConfiguration {
      * SPA pipeline app id
      */
     spaAppId?: string;
+    /**
+     * Is Spinner on Change enabled for app
+     */
+    spinnerOnChange?: boolean;
     /**
      * Sub Org
      */
@@ -445,6 +491,10 @@ export interface RuntimeConfiguration {
      * If the toast quiet mode feature is enabled.
      */
     toastQuietModeEnabled: boolean;
+    /**
+     * List of current user orgs collaborator instances
+     */
+    userCollaborators?: Collaborator[];
     /**
      * User's consent permissions
      */
@@ -454,3 +504,4 @@ export interface RuntimeConfiguration {
      */
     xqlGatewayUrl?: string;
 }
+export {};

package/agreements.d.ts

@@ -13,6 +13,10 @@ export declare enum AGREEMENT_TYPE {
     BETA = "BETA",
     GENSTUDIO = "GENSTUDIO"
 }
+export declare enum GLOBAL_AGREEMENTS {
+    AI_ASSISTANT = "gen-ai-ga-agreement",
+    AI_GENERAL = "gen-ai-general-agreement"
+}
 export interface AgreementKeyOptions {
     /**
      * True if the same key will be used in multiple places to show the same agreement.
@@ -24,7 +28,7 @@ export interface AgreementOptions extends AgreementKeyOptions {
     /**
      * Feature name of the agreement that will be used in the default dialog text.
      */
-    feature: string;
+    feature?: string;
     /**
      * If the agreement is actionable.
      */
@@ -50,7 +54,7 @@ export interface AgreementResponse {
     /**
      * Date of last action (accept or reject)
      */
-    date: string;
+    date: number;
 }
 export declare enum OPERATIONS {
     CLEAR = "clear",
@@ -66,13 +70,13 @@ export interface AgreementsApi {
      * @param key Application defined key to map results in settings
      * @returns A promise containing true if the setting was cleared and false if an error occurred.
      */
-    clearResponse(key: string, options?: AgreementKeyOptions): Promise<boolean>;
+    clearResponse(key: string | GLOBAL_AGREEMENTS, options?: AgreementKeyOptions): Promise<boolean>;
     /**
      * Returns the users agreement response from settings, but does not show the modal in either response case.
      * @param key Application defined key to map results in settings
      * @returns A promise containing the users response if one exists in settings
      */
-    getResponse(key: string, options?: AgreementKeyOptions): Promise<AgreementResponse>;
+    getResponse(key: string | GLOBAL_AGREEMENTS, options?: AgreementKeyOptions): Promise<AgreementResponse>;
     /**
      * Shows a beta agreement dialog to the user. Using the key parameter, checks in settings if the user has accepted the agreement and
      * shows the dialog to the user if they have.
@@ -80,7 +84,7 @@ export interface AgreementsApi {
      * @param options List of configurable options such as agreement type and feature name
      * @returns A promise that is fulfilled once the user takes action from within the dialog (or immediately with the settings response if the user has already accepted the agreement)
      */
-    showAgreement(key: string, options: AgreementOptions): Promise<AgreementResponse>;
+    showAgreement(key: string | GLOBAL_AGREEMENTS, options?: AgreementOptions): Promise<AgreementResponse>;
 }
 declare const agreements: AgreementsApi;
 export default agreements;

package/agreements.js

@@ -10,7 +10,7 @@
  * written permission of Adobe.
  **************************************************************************/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OPERATIONS = exports.AGREEMENT_TYPE = void 0;
+exports.OPERATIONS = exports.GLOBAL_AGREEMENTS = exports.AGREEMENT_TYPE = void 0;
 /**
  * The Agreements API allows an application to display an agreement modal which will block the user from using the feature until accepted.
  *
@@ -57,6 +57,11 @@ var AGREEMENT_TYPE;
     AGREEMENT_TYPE["BETA"] = "BETA";
     AGREEMENT_TYPE["GENSTUDIO"] = "GENSTUDIO";
 })(AGREEMENT_TYPE || (exports.AGREEMENT_TYPE = AGREEMENT_TYPE = {}));
+var GLOBAL_AGREEMENTS;
+(function (GLOBAL_AGREEMENTS) {
+    GLOBAL_AGREEMENTS["AI_ASSISTANT"] = "gen-ai-ga-agreement";
+    GLOBAL_AGREEMENTS["AI_GENERAL"] = "gen-ai-general-agreement";
+})(GLOBAL_AGREEMENTS || (exports.GLOBAL_AGREEMENTS = GLOBAL_AGREEMENTS = {}));
 var OPERATIONS;
 (function (OPERATIONS) {
     OPERATIONS["CLEAR"] = "clear";

package/agreements.js.map

@@ -1 +1 @@
-{"version":3,"file":"agreements.js","sourceRoot":"","sources":["agreements.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,yCAAqC;AAErC,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,2BAAS,CAAA;IACT,+BAAa,CAAA;IACb,yCAAuB,CAAA;AACzB,CAAC,EAJW,cAAc,8BAAd,cAAc,QAIzB;AA4CD,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,6BAAe,CAAA;IACf,yBAAW,CAAA;IACX,2BAAa,CAAA;AACf,CAAC,EAJW,UAAU,0BAAV,UAAU,QAIrB;AA8BD,MAAM,UAAU,GAAkB;IAChC,aAAa,EAAE,CAAC,GAAW,EAAE,OAA6B,EAAE,EAAE,CAAC,IAAA,gBAAO,EAAC,YAAY,CAAC,EAAE,CAAC,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC;IAClH,WAAW,EAAE,CAAC,GAAW,EAAE,OAA6B,EAAE,EAAE,CAAC,IAAA,gBAAO,EAAC,YAAY,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC;IAC9G,aAAa,EAAE,CAAC,GAAW,EAAE,OAAyB,EAAE,EAAE,CAAC,IAAA,gBAAO,EAAC,YAAY,CAAC,EAAE,CAAC,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC;CAC/G,CAAC;AAEF,kBAAe,UAAU,CAAC"}
+{"version":3,"file":"agreements.js","sourceRoot":"","sources":["agreements.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,yCAAqC;AAErC,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,2BAAS,CAAA;IACT,+BAAa,CAAA;IACb,yCAAuB,CAAA;AACzB,CAAC,EAJW,cAAc,8BAAd,cAAc,QAIzB;AAED,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,yDAAoC,CAAA;IACpC,4DAAuC,CAAA;AACzC,CAAC,EAHW,iBAAiB,iCAAjB,iBAAiB,QAG5B;AA4CD,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,6BAAe,CAAA;IACf,yBAAW,CAAA;IACX,2BAAa,CAAA;AACf,CAAC,EAJW,UAAU,0BAAV,UAAU,QAIrB;AA8BD,MAAM,UAAU,GAAkB;IAChC,aAAa,EAAE,CAAC,GAA+B,EAAE,OAA6B,EAAE,EAAE,CAAC,IAAA,gBAAO,EAAC,YAAY,CAAC,EAAE,CAAC,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC;IACtI,WAAW,EAAE,CAAC,GAA+B,EAAE,OAA6B,EAAE,EAAE,CAAC,IAAA,gBAAO,EAAC,YAAY,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC;IAClI,aAAa,EAAE,CAAC,GAA+B,EAAE,OAA0B,EAAE,EAAE,CAAC,IAAA,gBAAO,EAAC,YAAY,CAAC,EAAE,CAAC,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC;CACpI,CAAC;AAEF,kBAAe,UAAU,CAAC"}

package/ai.d.ts

@@ -32,6 +32,7 @@ export interface Source {
 export interface SuccessResponse {
     answer: string;
     chatId: string;
+    oosConfidence?: 'high' | 'low';
     interactionId: string;
     internalErrorCode?: string;
     prompts: Prompt[];
@@ -39,12 +40,39 @@ export interface SuccessResponse {
     sources: Source[];
     promptSuggestions: string[];
     clarifications?: {
-        message?: string;
-        questions: string[];
-    };
+        label: string;
+        value: string;
+    }[];
+    promptSuggestionsWithPlaceholders?: QuerySuggestion[];
     reportingDataDefinition?: any;
     usageInsights: string;
     visualizations: any[];
+    capability: string;
+    request: {
+        message: string;
+    };
+    uiComponent?: any;
+}
+export interface TemplatePlaceholder {
+    length: number;
+    rawPlaceholder?: string;
+    raw_placeholder?: string;
+    placeholderText?: string;
+    placeholder_text?: string;
+    placeholderType?: string;
+    placeholder_type?: string;
+    displayAttribute?: string;
+    display_attribute?: string;
+    startPosition?: number;
+    start_position?: number;
+}
+export interface QuerySuggestion {
+    suggestion: string;
+    tags: Record<string, string>;
+    placeholders: TemplatePlaceholder[];
+    itemId?: string;
+    item_id?: string;
+    id?: string;
 }
 export interface UserActionResponse {
     action: string;
@@ -62,6 +90,7 @@ export interface ErrorResponse {
     message?: string;
     requestId?: string;
     status: number;
+    uiComponent: any;
 }
 export type Response = SuccessResponse | UserActionResponse | SystemResponse | ErrorResponse;
 export declare enum AIMessageType {
@@ -74,7 +103,8 @@ export declare enum AIMessageType {
     OPEN = "OPEN",
     QUERY = "QUERY",
     RESPONSE = "RESPONSE",
-    USER_ACTION = "USER_ACTION"
+    USER_ACTION = "USER_ACTION",
+    SET_USER_PERMISSION = "SET_USER_PERMISSION"
 }
 export interface AIMessagePayload {
     /**
@@ -89,6 +119,10 @@ export interface AIMessagePayload {
      * The context for the AI chat.
      */
     context?: AIContext;
+    /**
+     * Whether the user has permission to use the AI Assistant.
+     */
+    hasPermission?: boolean;
     /**
      * The permissions required to enable the AI UI.
      */
@@ -178,6 +212,11 @@ export interface AIApi extends EventEmitter<AIMessageEvent> {
      * ```
      */
     sendMessage: (payload: AIMessagePayload) => void;
+    /**
+     * Sets the user has permission flag for the given application, org, and sandbox.
+     * @param hasPermission Whether the user has permission to use the AI Assistant feature.
+     */
+    setUserPermission: (hasPermission: boolean) => void;
     /**
      * Send a message to Unified Shell to show the Assistant. This includes
      * permissions that Unified Shell will validate to determine for access.

package/ai.js

@@ -24,6 +24,7 @@ var AIMessageType;
     AIMessageType["QUERY"] = "QUERY";
     AIMessageType["RESPONSE"] = "RESPONSE";
     AIMessageType["USER_ACTION"] = "USER_ACTION";
+    AIMessageType["SET_USER_PERMISSION"] = "SET_USER_PERMISSION";
 })(AIMessageType || (exports.AIMessageType = AIMessageType = {}));
 const ai = {
     closeChat: () => {
@@ -47,6 +48,9 @@ const ai = {
     sendMessage: (payload) => {
         return (0, Global_1.getImpl)('ai')().sendMessage(payload);
     },
+    setUserPermission: (hasPermission) => {
+        return (0, Global_1.getImpl)('ai')().setUserPermission(hasPermission);
+    },
     showAssistant: (permissions) => {
         return (0, Global_1.getImpl)('ai')().showAssistant(permissions);
     },

package/ai.js.map

@@ -1 +1 @@
-{"version":3,"file":"ai.js","sourceRoot":"","sources":["ai.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAQ5E,yCAAqC;AAwDrC,IAAY,aAWX;AAXD,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,gCAAe,CAAA;IACf,sCAAqB,CAAA;IACrB,4CAA2B,CAAA;AAC7B,CAAC,EAXW,aAAa,6BAAb,aAAa,QAWxB;AAiJD,MAAM,EAAE,GAAG;IACT,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,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,aAAa,EAAE,CAAC,WAAqB,EAAE,EAAE;QACvC,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;IACpD,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;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"}
+{"version":3,"file":"ai.js","sourceRoot":"","sources":["ai.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAQ5E,yCAAqC;AAuFrC,IAAY,aAYX;AAZD,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,gCAAe,CAAA;IACf,sCAAqB,CAAA;IACrB,4CAA2B,CAAA;IAC3B,4DAA2C,CAAA;AAC7C,CAAC,EAZW,aAAa,6BAAb,aAAa,QAYxB;AA2JD,MAAM,EAAE,GAAG;IACT,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,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,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,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;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

@@ -43,11 +43,13 @@ export declare enum AppIds {
     ADMIN_CONSOLE = "adminconsole",
     ADOBE_EXPERIENCE_CLOUD_GRIFFON = "griffon",
     ADVERTISING_CLOUD = "advertising-ssc",
+    ADVERTISING_SEARCH_SOCIAL_COMMERCE = "advertising-ssc",
     ANALYTICS = "analytics",
     APP_BUILDER_CATALOG = "firefly",
     ASSETS = "assets",
     ASSETS_ESSENTIALS = "ddam",
     AUDIENCE_MANAGER = "audiencemanager",
+    BRANDS = "brandIntelligence",
     CAMPAIGN = "campaignLaunch",
     CAMPAIGN_CONTROL_PANEL = "accp",
     CLOUD_MANAGER = "cloudManagerUi",
@@ -72,6 +74,7 @@ export declare enum AppIds {
     EXPERIENCE_MANAGER_SCREENS = "screens",
     EXPERIENCE_PLATFORM = "experiencePlatformUI",
     GENSTUDIO = "GenStudio",
+    GROWTH_CATALYST = "growth-catalyst-home",
     HEADLESS_CMS = "hcms",
     JOURNEY_OPTIMIZER = "cjm-home",
     JOURNEY_OPTIMIZER_B2B_EDITION = "sapphireHome",
@@ -88,7 +91,7 @@ export declare enum AppIds {
     PRIVACY_UI = "privacyui",
     PROJECT_HUMMINGBIRD = "hummingbird",
     PROJECT_SIERRA = "cjm-home",
-    SEARCH_SOCIAL_COMMERCE = "advertising-ssc",
+    RTCDP_COLLABORATION = "agoraUI",
     SOFTWARE_DISTRIBUTION = "softwareDistribution",
     SYSTEM_STATUS = "systemStatus",
     TARGET = "target",

package/appapi.js

@@ -49,11 +49,13 @@ var AppIds;
     AppIds["ADMIN_CONSOLE"] = "adminconsole";
     AppIds["ADOBE_EXPERIENCE_CLOUD_GRIFFON"] = "griffon";
     AppIds["ADVERTISING_CLOUD"] = "advertising-ssc";
+    AppIds["ADVERTISING_SEARCH_SOCIAL_COMMERCE"] = "advertising-ssc";
     AppIds["ANALYTICS"] = "analytics";
     AppIds["APP_BUILDER_CATALOG"] = "firefly";
     AppIds["ASSETS"] = "assets";
     AppIds["ASSETS_ESSENTIALS"] = "ddam";
     AppIds["AUDIENCE_MANAGER"] = "audiencemanager";
+    AppIds["BRANDS"] = "brandIntelligence";
     AppIds["CAMPAIGN"] = "campaignLaunch";
     AppIds["CAMPAIGN_CONTROL_PANEL"] = "accp";
     AppIds["CLOUD_MANAGER"] = "cloudManagerUi";
@@ -78,6 +80,7 @@ var AppIds;
     AppIds["EXPERIENCE_MANAGER_SCREENS"] = "screens";
     AppIds["EXPERIENCE_PLATFORM"] = "experiencePlatformUI";
     AppIds["GENSTUDIO"] = "GenStudio";
+    AppIds["GROWTH_CATALYST"] = "growth-catalyst-home";
     AppIds["HEADLESS_CMS"] = "hcms";
     AppIds["JOURNEY_OPTIMIZER"] = "cjm-home";
     AppIds["JOURNEY_OPTIMIZER_B2B_EDITION"] = "sapphireHome";
@@ -94,7 +97,7 @@ var AppIds;
     AppIds["PRIVACY_UI"] = "privacyui";
     AppIds["PROJECT_HUMMINGBIRD"] = "hummingbird";
     AppIds["PROJECT_SIERRA"] = "cjm-home";
-    AppIds["SEARCH_SOCIAL_COMMERCE"] = "advertising-ssc";
+    AppIds["RTCDP_COLLABORATION"] = "agoraUI";
     AppIds["SOFTWARE_DISTRIBUTION"] = "softwareDistribution";
     AppIds["SYSTEM_STATUS"] = "systemStatus";
     AppIds["TARGET"] = "target";

package/appapi.js.map

@@ -1 +1 @@
-{"version":3,"file":"appapi.js","sourceRoot":"","sources":["appapi.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,yCAAqC;AAiCrC,0DAA0D;AAC1D,IAAY,MAyDX;AAzDD,WAAY,MAAM;IAChB,yBAAe,CAAA;IACf,wCAA8B,CAAA;IAC9B,oDAA0C,CAAA;IAC1C,+CAAqC,CAAA;IACrC,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,0DAAgD,CAAA;IAChD,kDAAwC,CAAA;IACxC,kDAAwC,CAAA;IACxC,sCAA4B,CAAA;IAC5B,+BAAqB,CAAA;IACrB,sCAA4B,CAAA;IAC5B,oDAA0C,CAAA;IAC1C,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,iCAAuB,CAAA;IACvB,+BAAqB,CAAA;IACrB,wCAA8B,CAAA;IAC9B,wDAA8C,CAAA;IAC9C,qDAA2C,CAAA;IAC3C,wCAA8B,CAAA;IAC9B,6BAAmB,CAAA;IACnB,0CAAgC,CAAA;IAChC,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,2BAAiB,CAAA;IACjB,oEAA0D,CAAA;IAC1D,2BAAiB,CAAA;IACjB,uCAA6B,CAAA;IAC7B,kCAAwB,CAAA;IACxB,6CAAmC,CAAA;IACnC,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,EAzDW,MAAM,sBAAN,MAAM,QAyDjB;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"}
+{"version":3,"file":"appapi.js","sourceRoot":"","sources":["appapi.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,yCAAqC;AAiCrC,0DAA0D;AAC1D,IAAY,MA4DX;AA5DD,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,2BAAiB,CAAA;IACjB,oCAA0B,CAAA;IAC1B,8CAAoC,CAAA;IACpC,sCAA4B,CAAA;IAC5B,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,0CAAgC,CAAA;IAChC,gDAAsC,CAAA;IACtC,0DAAgD,CAAA;IAChD,kDAAwC,CAAA;IACxC,kDAAwC,CAAA;IACxC,sCAA4B,CAAA;IAC5B,+BAAqB,CAAA;IACrB,sCAA4B,CAAA;IAC5B,oDAA0C,CAAA;IAC1C,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,iCAAuB,CAAA;IACvB,kDAAwC,CAAA;IACxC,+BAAqB,CAAA;IACrB,wCAA8B,CAAA;IAC9B,wDAA8C,CAAA;IAC9C,qDAA2C,CAAA;IAC3C,wCAA8B,CAAA;IAC9B,6BAAmB,CAAA;IACnB,0CAAgC,CAAA;IAChC,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,2BAAiB,CAAA;IACjB,oEAA0D,CAAA;IAC1D,2BAAiB,CAAA;IACjB,uCAA6B,CAAA;IAC7B,kCAAwB,CAAA;IACxB,6CAAmC,CAAA;IACnC,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,wDAA8C,CAAA;IAC9C,wCAA8B,CAAA;IAC9B,2BAAiB,CAAA;IACjB,+BAAqB,CAAA;IACrB,iCAAuB,CAAA;IACvB,qCAA2B,CAAA;AAC7B,CAAC,EA5DW,MAAM,sBAAN,MAAM,QA4DjB;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/cache.d.ts

@@ -71,7 +71,7 @@ export type CacheExpiry = CacheTTL | number;
 /**
  * Input parameters for the Cache get and delete APIs.
  */
-export interface CacheParameters {
+export interface CacheParameters extends CacheStoreParameters {
     /**
      * Cache key.
      */
@@ -80,6 +80,11 @@ export interface CacheParameters {
      * Cache scope (Optional - Defaults to user).
      */
     scope?: CacheScope;
+}
+/**
+ * Input parameters for bare bones Cache API
+ */
+export interface CacheStoreParameters {
     /**
      * Shared Cache name.
      * Calling app must be allowlisted by Unified Shell to access this cache.
@@ -100,6 +105,12 @@ export interface CacheSetParameters<T> extends CacheParameters {
      */
     value: T;
 }
+export declare enum CacheMethod {
+    DELETE = "DELETE",
+    GET = "GET",
+    LIST_KEYS = "LIST_KEYS",
+    POST = "POST"
+}
 /**
  * Cache entry (Returned by the get API).
  */
@@ -127,6 +138,10 @@ export interface CacheApi {
      * @returns A promise that resolves to the specified value, or undefined if none exist.
      */
     get<T>(params: CacheParameters): Promise<CacheEntry<T> | undefined>;
+    /**
+     * Returns an array of strings representing the keys of the Cache.
+     */
+    keys(params?: CacheStoreParameters): Promise<string[]>;
     /**
      * Stores a value in the cache.
      * @param params Parameters used to identify the cached item to store and control its TTL.

package/cache.js

@@ -10,7 +10,7 @@
  * written permission of Adobe.
  **************************************************************************/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CacheTTL = exports.CacheScope = void 0;
+exports.CacheMethod = exports.CacheTTL = exports.CacheScope = void 0;
 /**
  * APIs for managing a client side persisted cache.
  * Unified Shell will store the data against its own domain, which allows data caching
@@ -123,9 +123,17 @@ var CacheTTL;
      */
     CacheTTL[CacheTTL["MONTH"] = 2592000] = "MONTH";
 })(CacheTTL || (exports.CacheTTL = CacheTTL = {}));
+var CacheMethod;
+(function (CacheMethod) {
+    CacheMethod["DELETE"] = "DELETE";
+    CacheMethod["GET"] = "GET";
+    CacheMethod["LIST_KEYS"] = "LIST_KEYS";
+    CacheMethod["POST"] = "POST";
+})(CacheMethod || (exports.CacheMethod = CacheMethod = {}));
 const cache = {
     delete: params => (0, Global_1.getImpl)('cache')().delete(params),
     get: params => (0, Global_1.getImpl)('cache')().get(params),
+    keys: (params = {}) => (0, Global_1.getImpl)('cache')().keys(params),
     set: params => (0, Global_1.getImpl)('cache')().set(params)
 };
 exports.default = cache;

package/cache.js.map

@@ -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,CAAC,kEAAkE;AAClF,CAAC,EArBW,UAAU,0BAAV,UAAU,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,wBAAR,QAAQ,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"}
+{"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,0BAAV,UAAU,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,wBAAR,QAAQ,QA8BnB;AA4CD,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,gCAAiB,CAAA;IACjB,0BAAW,CAAA;IACX,sCAAuB,CAAA;IACvB,4BAAa,CAAA;AACf,CAAC,EALW,WAAW,2BAAX,WAAW,QAKtB;AAwCD,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,IAAI,EAAE,CAAC,MAAM,GAAG,EAAE,EAAE,EAAE,CAAC,IAAA,gBAAO,EAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;IACtD,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,IAAA,gBAAO,EAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC;CAC9C,CAAC;AAEF,kBAAe,KAAK,CAAC"}

package/consent.d.ts

@@ -1,6 +1,6 @@
 export interface ConsentPermissions {
-    adbepersonalizedpromotions: boolean;
-    adbepersonalizedrecommendations: boolean;
+    adbepersonalizedpromotions?: boolean;
+    adbepersonalizedrecommendations?: boolean;
     adobeUsageDataCollection: boolean;
     communitiesPromotions: boolean;
     communitiesRecommendations: boolean;

package/docs/modules/cache.md

@@ -44,6 +44,9 @@ await cache.set<MyType>({key: 'some-cache-key', value: myTypeInstance, expiry: C
 // Cache get
 const myData: MyType = await cache.get<MyType>({key: 'some-cache-key'});
 
+// Get cache keys; Returns an array of strings representing the keys of the Cache.
+const cacheKeys: string[] = await cache.keys();
+
 // Get scope must be identical to the scope used for set - Always use the same scope for both.
 const myData2: MyType = await cache.get<MyType>({key: 'some-cache-key', scope: CacheScope.ORG});
 

package/helpcenter.d.ts

@@ -51,10 +51,6 @@ export interface HelpCenterConfig {
          */
         label: string;
     }>;
-    /**
-     * If the solution wants to simulate "Frequently asked questions", it can provide them as an array of strings. These appear as the user starts typing in the Search field.
-     */
-    questions?: Array<string>;
 }
 export interface HelpCenterOpenConfig {
     /**

package/helpcenter.js.map

@@ -1 +1 @@
-{"version":3,"file":"helpcenter.js","sourceRoot":"","sources":["helpcenter.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;4EAS4E;AAC5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,yCAAqC;AAgJrC,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,8BAAe,CAAA;IACf,4BAAa,CAAA;AACf,CAAC,EAHW,WAAW,2BAAX,WAAW,QAGtB;AAuID,MAAM,UAAU,GAAG,IAAA,gBAAO,EAAC,YAAY,EAAE;IACvC,CAAC,WAAW,EAAE,IAAI,CAAC;IACnB,CAAC,YAAY,EAAE,IAAI,CAAC;IACpB,CAAC,mBAAmB,EAAE,IAAI,CAAC;IAC3B,CAAC,QAAQ,CAAC;IACV,CAAC,MAAM,EAAE,IAAI,CAAC;IACd,CAAC,oBAAoB,EAAE,IAAI,CAAC;CAC7B,CAAC,CAAC;AAEH,kBAAe,UAAU,CAAC"}
+{"version":3,"file":"helpcenter.js","sourceRoot":"","sources":["helpcenter.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;4EAS4E;AAC5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,yCAAqC;AA4IrC,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,8BAAe,CAAA;IACf,4BAAa,CAAA;AACf,CAAC,EAHW,WAAW,2BAAX,WAAW,QAGtB;AAuID,MAAM,UAAU,GAAG,IAAA,gBAAO,EAAC,YAAY,EAAE;IACvC,CAAC,WAAW,EAAE,IAAI,CAAC;IACnB,CAAC,YAAY,EAAE,IAAI,CAAC;IACpB,CAAC,mBAAmB,EAAE,IAAI,CAAC;IAC3B,CAAC,QAAQ,CAAC;IACV,CAAC,MAAM,EAAE,IAAI,CAAC;IACd,CAAC,oBAAoB,EAAE,IAAI,CAAC;CAC7B,CAAC,CAAC;AAEH,kBAAe,UAAU,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/exc-app",
-  "version": "1.4.7",
+  "version": "1.4.9",
   "main": "index.js",
   "source": "index.ts",
   "scripts": {

package/page.d.ts

@@ -33,6 +33,16 @@ export interface BlockNavigationOptions {
     onOrgChangeOnly: boolean;
 }
 export interface ObjectWithPath {
+    /**
+     * Optional collaborator id to be added to URL path.
+     *
+     * ***Example:***
+     *
+     * ```typescript
+     * {path: '/abc', collaborator: 'id1234'}
+     * ```
+     */
+    collaborator?: string;
     /**
      * Optional organization name to be added to URL path. This can be in the form of a tenant or an organization string.
      *
@@ -251,6 +261,32 @@ export declare enum THUNDERBIRD {
     SRC_DOC = 1,
     SERVICE_WORKER = 2
 }
+/**
+ * Defines the types of url contexts that can be used in the shell URL.
+ */
+export declare enum UrlContextKey {
+    COLLABORATOR = "collaborator",
+    SANDBOX = "sandbox",
+    SUBORG = "subOrg"
+}
+export interface UrlContextUpdate {
+    /**
+     * Payload for updating a context in the url
+     *
+     * ***Example:***
+     * import {CollaboratorType} from '@adobe/exc-app/user';
+     * import {UrlContextKey} from '@adobe/exc-app/page';
+     *
+     * ```typescript
+     * page.updateUrlContext({contextKey: UrlContextKey.COLLABORATOR});
+     * ```
+     */
+    /**
+     * Identifies which context value is being updated
+     * Currently support only exists for collaborator
+     */
+    contextKey: Omit<UrlContextKey, UrlContextKey.SANDBOX | UrlContextKey.SUBORG>;
+}
 export interface LoadTimesMetrics {
     'first-contentful-paint'?: number;
     'first-paint'?: number;
@@ -396,6 +432,7 @@ export interface PageApi extends PageApiProperties {
      * page.done();
      * ```
      * @returns A promise that resolves with the performance metrics of this page load.
+     * done should only be called once. Ignored when called twice.
      */
     done(): Promise<PerformanceRecord>;
     /**
@@ -586,6 +623,10 @@ export interface PageApi extends PageApiProperties {
      * @param enable Whether to enable or disable the auto detection for this `type`.
      */
     toggleAutoDetect(type: ObservableType, enable: boolean): Promise<void>;
+    /**
+     * Allows an app to update context data options in the url.
+     */
+    updateUrlContext: (payload: UrlContextUpdate) => void;
 }
 declare const page: PageApi;
 export default page;

package/page.js

@@ -10,7 +10,7 @@
  * written permission of Adobe.
  **************************************************************************/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.THUNDERBIRD = exports.SRC_DOC = exports.RELEASE_TYPE = exports.RELEASE_SCOPE = exports.ObservableType = void 0;
+exports.UrlContextKey = exports.THUNDERBIRD = exports.SRC_DOC = exports.RELEASE_TYPE = exports.RELEASE_SCOPE = exports.ObservableType = void 0;
 /**
  * APIs that let solutions interact with the main page and personalize it, e.g. setting the title,
  * favicon, refreshing the solution iframe, etc.
@@ -89,6 +89,15 @@ var THUNDERBIRD;
     THUNDERBIRD[THUNDERBIRD["SRC_DOC"] = 1] = "SRC_DOC";
     THUNDERBIRD[THUNDERBIRD["SERVICE_WORKER"] = 2] = "SERVICE_WORKER";
 })(THUNDERBIRD || (exports.THUNDERBIRD = THUNDERBIRD = {}));
+/**
+ * Defines the types of url contexts that can be used in the shell URL.
+ */
+var UrlContextKey;
+(function (UrlContextKey) {
+    UrlContextKey["COLLABORATOR"] = "collaborator";
+    UrlContextKey["SANDBOX"] = "sandbox";
+    UrlContextKey["SUBORG"] = "subOrg";
+})(UrlContextKey || (exports.UrlContextKey = UrlContextKey = {}));
 const page = (0, Global_1.connect)('page', [
     ['afterPrintHandler'],
     ['appContainer'],
@@ -114,7 +123,8 @@ const page = (0, Global_1.connect)('page', [
     ['spinner'],
     ['title'],
     ['toggleAutoDetect'],
-    ['unloadPromptMessage']
+    ['unloadPromptMessage'],
+    ['updateUrlContext', true]
 ]);
 exports.default = page;
 //# sourceMappingURL=page.js.map

package/page.js.map

@@ -1 +1 @@
-{"version":3,"file":"page.js","sourceRoot":"","sources":["page.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH,yCAAqC;AA+NrC,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,iCAAe,CAAA;IACf,qCAAmB,CAAA;AACrB,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB;AAED;;GAEG;AACH,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,kCAAiB,CAAA;IACjB,8BAAa,CAAA;AACf,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB;AAED;;GAEG;AACH,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,+BAAe,CAAA;IACf,6BAAa,CAAA;IACb,yBAAS,CAAA;AACX,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB;AAED;;GAEG;AACH,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,6CAAQ,CAAA;IACR,qCAAI,CAAA;IACJ,6CAAQ,CAAA,CAAA,6DAA6D;AACvE,CAAC,EAJW,OAAO,uBAAP,OAAO,QAIlB;AAED,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,2CAAG,CAAA;IACH,mDAAO,CAAA;IACP,iEAAc,CAAA;AAChB,CAAC,EAJW,WAAW,2BAAX,WAAW,QAItB;AAsWD,MAAM,IAAI,GAAG,IAAA,gBAAO,EAAC,MAAM,EAAE;IAC3B,CAAC,mBAAmB,CAAC;IACrB,CAAC,cAAc,CAAC;IAChB,CAAC,oBAAoB,CAAC;IACtB,CAAC,iBAAiB,EAAE,IAAI,CAAC;IACzB,CAAC,gBAAgB,EAAE,IAAI,CAAC;IACxB,CAAC,MAAM,EAAE,IAAI,CAAC;IACd,CAAC,kBAAkB,EAAE,IAAI,CAAC;IAC1B,CAAC,wBAAwB,CAAC;IAC1B,CAAC,6BAA6B,CAAC;IAC/B,CAAC,SAAS,CAAC;IACX,CAAC,cAAc,EAAE,IAAI,CAAC;IACtB,CAAC,OAAO,CAAC;IACT,CAAC,iBAAiB,CAAC;IACnB,CAAC,UAAU,EAAE,IAAI,CAAC;IAClB,CAAC,cAAc,EAAE,IAAI,CAAC;IACtB,CAAC,sBAAsB,CAAC;IACxB,CAAC,OAAO,EAAE,IAAI,CAAC;IACf,CAAC,eAAe,EAAE,IAAI,CAAC;IACvB,CAAC,eAAe,EAAE,IAAI,CAAC;IACvB,CAAC,wBAAwB,CAAC;IAC1B,CAAC,6BAA6B,CAAC;IAC/B,CAAC,SAAS,CAAC;IACX,CAAC,OAAO,CAAC;IACT,CAAC,kBAAkB,CAAC;IACpB,CAAC,qBAAqB,CAAC;CACxB,CAAC,CAAC;AAEH,kBAAe,IAAI,CAAC"}
+{"version":3,"file":"page.js","sourceRoot":"","sources":["page.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH,yCAAqC;AAyOrC,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,iCAAe,CAAA;IACf,qCAAmB,CAAA;AACrB,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB;AAED;;GAEG;AACH,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,kCAAiB,CAAA;IACjB,8BAAa,CAAA;AACf,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB;AAED;;GAEG;AACH,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,+BAAe,CAAA;IACf,6BAAa,CAAA;IACb,yBAAS,CAAA;AACX,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB;AAED;;GAEG;AACH,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,6CAAQ,CAAA;IACR,qCAAI,CAAA;IACJ,6CAAQ,CAAA,CAAA,6DAA6D;AACvE,CAAC,EAJW,OAAO,uBAAP,OAAO,QAIlB;AAED,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,2CAAG,CAAA;IACH,mDAAO,CAAA;IACP,iEAAc,CAAA;AAChB,CAAC,EAJW,WAAW,2BAAX,WAAW,QAItB;AAED;;GAEG;AACH,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,8CAA6B,CAAA;IAC7B,oCAAmB,CAAA;IACnB,kCAAiB,CAAA;AACnB,CAAC,EAJW,aAAa,6BAAb,aAAa,QAIxB;AA8XD,MAAM,IAAI,GAAG,IAAA,gBAAO,EAAC,MAAM,EAAE;IAC3B,CAAC,mBAAmB,CAAC;IACrB,CAAC,cAAc,CAAC;IAChB,CAAC,oBAAoB,CAAC;IACtB,CAAC,iBAAiB,EAAE,IAAI,CAAC;IACzB,CAAC,gBAAgB,EAAE,IAAI,CAAC;IACxB,CAAC,MAAM,EAAE,IAAI,CAAC;IACd,CAAC,kBAAkB,EAAE,IAAI,CAAC;IAC1B,CAAC,wBAAwB,CAAC;IAC1B,CAAC,6BAA6B,CAAC;IAC/B,CAAC,SAAS,CAAC;IACX,CAAC,cAAc,EAAE,IAAI,CAAC;IACtB,CAAC,OAAO,CAAC;IACT,CAAC,iBAAiB,CAAC;IACnB,CAAC,UAAU,EAAE,IAAI,CAAC;IAClB,CAAC,cAAc,EAAE,IAAI,CAAC;IACtB,CAAC,sBAAsB,CAAC;IACxB,CAAC,OAAO,EAAE,IAAI,CAAC;IACf,CAAC,eAAe,EAAE,IAAI,CAAC;IACvB,CAAC,eAAe,EAAE,IAAI,CAAC;IACvB,CAAC,wBAAwB,CAAC;IAC1B,CAAC,6BAA6B,CAAC;IAC/B,CAAC,SAAS,CAAC;IACX,CAAC,OAAO,CAAC;IACT,CAAC,kBAAkB,CAAC;IACpB,CAAC,qBAAqB,CAAC;IACvB,CAAC,kBAAkB,EAAE,IAAI,CAAC;CAC3B,CAAC,CAAC;AAEH,kBAAe,IAAI,CAAC"}

package/src/Global.d.ts

@@ -72,6 +72,7 @@ export interface Modules extends CommonModules {
 type Global = typeof window & {
     readonly 'exc-module-runtime': Modules & {
         'exc-app-version'?: string;
+        isNested?: boolean;
     };
     EXC_MR_READY?: (() => void) & {
         autoDelete?: boolean;

package/src/Global.js.map

@@ -1 +1 @@
-{"version":3,"file":"Global.js","sourceRoot":"","sources":["Global.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;AA+E5E,0BAMC;AASD,0BAoBC;AAzCD;;;;;GAKG;AACH,SAAgB,OAAO,CAA0B,UAAa;IAC5D,MAAM,GAAG,GAAI,MAAiB,CAAC,oBAAoB,CAAC,CAAC;IACrD,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CAAC,+CAA+C,UAAU,IAAI,CAAC,CAAC;IACjF,CAAC;IACD,OAAO,GAAG,CAAC,UAAU,CAAC,CAAC;AACzB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,OAAO,CAA0B,OAAU,EAAE,UAA0C;IACrG,MAAM,GAAG,GAAG,EAAgB,CAAC;IAC7B,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QAC3B,MAAM,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAC/B,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YACf,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,GAAG,IAAW,EAAE,EAAE;gBACrC,OAAQ,OAAO,CAAC,OAAO,CAAC,CAAC,WAAW,CAAS,CAAC,GAAG,IAAI,CAAC,CAAC;YACzD,CAAC,CAAQ,CAAC;QACZ,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,WAAW,EAAE;gBACtC,GAAG,EAAE,GAAG,EAAE;oBACR,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC,CAAC;gBACvC,CAAC;gBACD,GAAG,EAAE,KAAK,CAAC,EAAE;oBACX,OAAO,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC;gBACxC,CAAC;aACF,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACb,CAAC;AAED,kBAAgB,MAAiB,CAAC"}
+{"version":3,"file":"Global.js","sourceRoot":"","sources":["Global.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;AAgF5E,0BAMC;AASD,0BAoBC;AAzCD;;;;;GAKG;AACH,SAAgB,OAAO,CAA0B,UAAa;IAC5D,MAAM,GAAG,GAAI,MAAiB,CAAC,oBAAoB,CAAC,CAAC;IACrD,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CAAC,+CAA+C,UAAU,IAAI,CAAC,CAAC;IACjF,CAAC;IACD,OAAO,GAAG,CAAC,UAAU,CAAC,CAAC;AACzB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,OAAO,CAA0B,OAAU,EAAE,UAA0C;IACrG,MAAM,GAAG,GAAG,EAAgB,CAAC;IAC7B,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QAC3B,MAAM,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAC/B,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YACf,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,GAAG,IAAW,EAAE,EAAE;gBACrC,OAAQ,OAAO,CAAC,OAAO,CAAC,CAAC,WAAW,CAAS,CAAC,GAAG,IAAI,CAAC,CAAC;YACzD,CAAC,CAAQ,CAAC;QACZ,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,WAAW,EAAE;gBACtC,GAAG,EAAE,GAAG,EAAE;oBACR,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC,CAAC;gBACvC,CAAC;gBACD,GAAG,EAAE,KAAK,CAAC,EAAE;oBACX,OAAO,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC;gBACxC,CAAC;aACF,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACb,CAAC;AAED,kBAAgB,MAAiB,CAAC"}