@microsoft/teams-js 2.47.1 → 2.48.0-beta.0

package/dist/umd/MicrosoftTeams.js

@@ -1107,7 +1107,8 @@ __webpack_require__.d(__webpack_exports__, {
   videoEffects: () => (/* reexport */ videoEffects_namespaceObject),
   videoEffectsEx: () => (/* reexport */ videoEffectsEx_namespaceObject),
   visualMedia: () => (/* reexport */ visualMedia_namespaceObject),
-  webStorage: () => (/* reexport */ webStorage_namespaceObject)
+  webStorage: () => (/* reexport */ webStorage_namespaceObject),
+  widgetHosting: () => (/* reexport */ widgetHosting_namespaceObject)
 });
 
 // NAMESPACE OBJECT: ./src/private/messageChannels/telemetry.ts
@@ -1156,6 +1157,7 @@ __webpack_require__.d(app_namespaceObject, {
   notifySuccess: () => (notifySuccess),
   openLink: () => (openLink),
   registerHostToAppPerformanceMetricsHandler: () => (registerHostToAppPerformanceMetricsHandler),
+  registerOnContextChangeHandler: () => (registerOnContextChangeHandler),
   registerOnThemeChangeHandler: () => (registerOnThemeChangeHandler)
 });
 
@@ -1672,6 +1674,22 @@ __webpack_require__.d(store_namespaceObject, {
   openSpecificStore: () => (openSpecificStore)
 });
 
+// NAMESPACE OBJECT: ./src/private/widgetHosting/widgetHosting.ts
+var widgetHosting_namespaceObject = {};
+__webpack_require__.r(widgetHosting_namespaceObject);
+__webpack_require__.d(widgetHosting_namespaceObject, {
+  callTool: () => (callTool),
+  contentSizeChanged: () => (contentSizeChanged),
+  isSupported: () => (widgetHosting_isSupported),
+  notifyIntrinsicHeight: () => (notifyIntrinsicHeight),
+  openExternal: () => (openExternal),
+  registerModalCloseHandler: () => (registerModalCloseHandler),
+  requestDisplayMode: () => (requestDisplayMode),
+  requestModal: () => (requestModal),
+  sendFollowUpMessage: () => (sendFollowUpMessage),
+  setWidgetState: () => (setWidgetState)
+});
+
 // NAMESPACE OBJECT: ./src/public/authentication.ts
 var authentication_namespaceObject = {};
 __webpack_require__.r(authentication_namespaceObject);
@@ -2268,7 +2286,7 @@ var ClipboardSupportedMimeType;
 })(ClipboardSupportedMimeType || (ClipboardSupportedMimeType = {}));
 
 ;// ./src/artifactsForCDN/validDomains.json
-const validDomains_namespaceObject = /*#__PURE__*/JSON.parse('{"validOrigins":["teams.microsoft.com","teams.microsoft.us","gov.teams.microsoft.us","dod.teams.microsoft.us","int.teams.microsoft.com","outlook.office.com","outlook-sdf.office.com","outlook.office365.com","outlook-sdf.office365.com","outlook.office365.us","outlook-dod.office365.us","webmail.apps.mil","outlook.live.com","outlook-sdf.live.com","teams.live.com","local.teams.live.com","local.teams.live.com:8080","local.teams.office.com","local.teams.office.com:8080","devspaces.skype.com","*.www.office.com","www.office.com","word.office.com","excel.office.com","powerpoint.office.com","www.officeppe.com","*.www.microsoft365.com","www.microsoft365.com","bing.com","edgeservices.bing.com","work.bing.com","www.bing.com","www.staging-bing-int.com","*.cloud.microsoft","*.m365.cloud.microsoft","*.outlook.cloud.microsoft","chatuxmanager.svc.cloud.microsoft","copilot.microsoft.com","windows.msn.com","fa000000125.resources.office.net","fa000000129.resources.office.net","fa000000124.resources.office.net","fa000000128.resources.office.net","fa000000136.resources.office.net","fa000000125.officeapps.live.com","fa000000129.officeapps.live.com","fa000000124.officeapps.live.com","fa000000128.officeapps.live.com"]}');
+const validDomains_namespaceObject = /*#__PURE__*/JSON.parse('{"validOrigins":["teams.microsoft.com","teams.microsoft.us","gov.teams.microsoft.us","dod.teams.microsoft.us","int.teams.microsoft.com","outlook.office.com","outlook-sdf.office.com","outlook.office365.com","outlook-sdf.office365.com","outlook.office365.us","outlook-dod.office365.us","webmail.apps.mil","outlook.live.com","outlook-sdf.live.com","teams.live.com","local.teams.live.com","local.teams.live.com:8080","local.teams.office.com","local.teams.office.com:8080","devspaces.skype.com","*.www.office.com","www.office.com","word.office.com","excel.office.com","powerpoint.office.com","www.officeppe.com","*.www.microsoft365.com","www.microsoft365.com","bing.com","edgeservices.bing.com","work.bing.com","www.bing.com","www.staging-bing-int.com","*.cloud.microsoft","*.m365.cloud.microsoft","*.outlook.cloud.microsoft","chatuxmanager.svc.cloud.microsoft","copilot.microsoft.com","windows.msn.com","fa000000125.resources.office.net","fa000000129.resources.office.net","fa000000124.resources.office.net","fa000000128.resources.office.net","fa000000136.resources.office.net","fa000000125.officeapps.live.com","fa000000129.officeapps.live.com","fa000000124.officeapps.live.com","fa000000128.officeapps.live.com","fa000000136.mro1cdnstorage.public.onecdn.static.microsoft","substrate-msb-bizchatvnext-service.sdf01.substrate-msb-bingatwork.eastus2-sdf.cosmic-ppe.office.net","office-home-m365copilotapp.wus2sdf1.office-home-m365copilotapp.westus2-sdf.cosmic-ppe.office.net","office-home-m365copilotapp.wus2test1.office-home-m365copilotapp.westus2-test.cosmic-int.office.net","m365copilotapp.svc.cloud.microsoft","m365copilotapp.svc.cloud.dev.microsoft","ffc-copilot.officeapps.live.com","m365.cloud.dev.microsoft","m365.cloud.dev.microsoft:3001"]}');
 var artifactsForCDN_validDomains_namespaceObject = /*#__PURE__*/__webpack_require__.t(validDomains_namespaceObject, 2);
 ;// ./src/internal/constants.ts
 
@@ -4650,7 +4668,7 @@ function isSerializable(arg) {
  * @hidden
  *  Package version.
  */
-const version = "2.47.1";
+const version = "2.48.0-beta.0";
 
 ;// ./src/public/featureFlags.ts
 // All build feature flags are defined inside this object. Any build feature flag must have its own unique getter and setter function. This pattern allows for client apps to treeshake unused code and avoid including code guarded by this feature flags in the final bundle. If this property isn't desired, use the below runtime feature flags object.
@@ -5469,6 +5487,17 @@ function notifyExpectedFailure(expectedFailureRequest) {
 function registerOnThemeChangeHandler(handler) {
     registerOnThemeChangeHandlerHelper(getApiVersionTag(appTelemetryVersionNumber, "app.registerOnThemeChangeHandler" /* ApiName.App_RegisterOnThemeChangeHandler */), handler);
 }
+/**
+ * Registers a handler for content (context) changes.
+ *
+ * @remarks
+ * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+ *
+ * @param handler - The handler to invoke when the app's content context changes.
+ */
+function registerOnContextChangeHandler(handler) {
+    registerOnContextChangeHandlerHelper(getApiVersionTag(appTelemetryVersionNumber, "app.registerOnContextChangeHandler" /* ApiName.App_RegisterOnContextChangeHandler */), handler);
+}
 /**
  * Registers a function for handling data of host to app message delay.
  *
@@ -5542,6 +5571,7 @@ function transformLegacyContextToAppContext(legacyContext) {
                 clientType: legacyContext.hostClientType ? legacyContext.hostClientType : HostClientType.web,
                 sessionId: legacyContext.sessionId ? legacyContext.sessionId : '',
                 ringId: legacyContext.ringId,
+                ancestors: legacyContext.hostAncestors,
             },
             appLaunchId: legacyContext.appLaunchId,
             appId: legacyContext.appId ? new AppId(legacyContext.appId) : undefined,
@@ -6687,6 +6717,10 @@ function registerOnThemeChangeHandlerHelper(apiVersionTag, handler) {
     !isNullOrUndefined(handler) && ensureInitializeCalled();
     handlers_registerOnThemeChangeHandler(apiVersionTag, handler);
 }
+function registerOnContextChangeHandlerHelper(apiVersionTag, handler) {
+    !isNullOrUndefined(handler) && ensureInitializeCalled();
+    handlers_registerOnContextChangeHandler(apiVersionTag, handler);
+}
 function openLinkHelper(apiVersionTag, deepLink) {
     return new Promise((resolve) => {
         ensureInitialized(runtime, FrameContexts.content, FrameContexts.sidePanel, FrameContexts.settings, FrameContexts.task, FrameContexts.stage, FrameContexts.meetingStage);
@@ -7576,15 +7610,15 @@ class HandlersPrivate {
     /**
      * @internal
      * Limited to Microsoft-internal use
-     * Uninitializes the handlers.
+     * Uninitialize the handlers.
      */
     static uninitializeHandlers() {
         HandlersPrivate.handlers = {};
         HandlersPrivate.themeChangeHandler = null;
-        HandlersPrivate.loadHandler = null;
         HandlersPrivate.beforeUnloadHandler = null;
         HandlersPrivate.beforeSuspendOrTerminateHandler = null;
         HandlersPrivate.resumeHandler = null;
+        HandlersPrivate.contextChangeHandler = null;
     }
 }
 HandlersPrivate.handlers = {};
@@ -7600,6 +7634,7 @@ HandlersPrivate.beforeUnloadHandler = null;
 HandlersPrivate.beforeSuspendOrTerminateHandler = null;
 HandlersPrivate.resumeHandler = null;
 HandlersPrivate.hostToAppPerformanceMetricsHandler = null;
+HandlersPrivate.contextChangeHandler = null;
 /**
  * @internal
  * Limited to Microsoft-internal use
@@ -7691,6 +7726,14 @@ function handlers_registerOnThemeChangeHandler(apiVersionTag, handler) {
     HandlersPrivate.themeChangeHandler = handler;
     !isNullOrUndefined(handler) && sendMessageToParent(apiVersionTag, 'registerHandler', ['themeChange']);
 }
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function handlers_registerOnContextChangeHandler(apiVersionTag, handler) {
+    HandlersPrivate.contextChangeHandler = handler;
+    !isNullOrUndefined(handler) && sendMessageToParent(apiVersionTag, 'registerHandler', ['contextChange']);
+}
 /**
  * @internal
  * Limited to Microsoft-internal use
@@ -14133,6 +14176,315 @@ function serializeValidSize(size) {
     return JSON.stringify(size);
 }
 
+;// ./src/private/widgetHosting/widgetHosting.ts
+/**
+ * @beta
+ * @hidden
+ * User information required by specific apps
+ * @internal
+ * Limited to Microsoft-internal use
+ * @module
+ */
+var widgetHosting_awaiter = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+
+
+
+
+
+
+
+const widgetHostingVersionNumber = "v1" /* ApiVersionNumber.V_1 */; // TODO: Ask Kangxuan for this version number
+const widgetHostingLogger = getLogger('widgetHosting');
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ * @beta
+ * @returns boolean to represent whether widgetHosting capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ */
+function widgetHosting_isSupported() {
+    return ensureInitialized(runtime) && !!runtime.supports.widgetHosting;
+}
+function callTool(widgetId, input) {
+    return widgetHosting_awaiter(this, void 0, void 0, function* () {
+        ensureInitializeCalled();
+        widgetHostingLogger('Calling tool with widgetId and input: ', { widgetId, input });
+        return callFunctionInHostAndHandleResponse("widgetHosting.callTool" /* ApiName.WidgetHosting_CallTool */, [new SerializableToolInput(widgetId, input)], new CallToolResponseHandler(), getApiVersionTag(widgetHostingVersionNumber, "widgetHosting.callTool" /* ApiName.WidgetHosting_CallTool */), isSdkError);
+    });
+}
+/**
+ * @beta
+ * @hidden
+ * Sends a follow-up message to the host
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function sendFollowUpMessage(widgetId, args) {
+    return widgetHosting_awaiter(this, void 0, void 0, function* () {
+        ensureInitializeCalled();
+        widgetHostingLogger('Sending follow-up message with widgetId and prompt: ', { widgetId, prompt: args.prompt });
+        return callFunctionInHost("widgetHosting.sendFollowUpMessage" /* ApiName.WidgetHosting_SendFollowUpMessage */, [new SerializableFollowUpMessageArgs(widgetId, args)], getApiVersionTag(widgetHostingVersionNumber, "widgetHosting.sendFollowUpMessage" /* ApiName.WidgetHosting_SendFollowUpMessage */));
+    });
+}
+/**
+ * @beta
+ * @hidden
+ * Requests a specific display mode for the widget
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function requestDisplayMode(widgetId, args) {
+    return widgetHosting_awaiter(this, void 0, void 0, function* () {
+        ensureInitializeCalled();
+        widgetHostingLogger('Requesting display mode with widgetId: ', { widgetId, mode: args.mode });
+        return callFunctionInHost("widgetHosting.requestDisplayMode" /* ApiName.WidgetHosting_RequestDisplayMode */, [new SerializableDisplayModeArgs(widgetId, args)], getApiVersionTag(widgetHostingVersionNumber, "widgetHosting.requestDisplayMode" /* ApiName.WidgetHosting_RequestDisplayMode */));
+    });
+}
+/**
+ * @beta
+ * @hidden
+ * Requests a modal dialog to be displayed
+ * @internal
+ * Limited to Microsoft-internal use
+ * @param widgetId - The unique identifier for the widget
+ * @param options - Configuration options for the modal
+ * @returns A DOM element representing the modal's root
+ */
+function requestModal(widgetId, options) {
+    return widgetHosting_awaiter(this, void 0, void 0, function* () {
+        ensureInitializeCalled();
+        widgetHostingLogger('Requesting modal with widgetId and options: ', { widgetId, options });
+        return callFunctionInHostAndHandleResponse("widgetHosting.requestModal" /* ApiName.WidgetHosting_RequestModal */, [new SerializableModalOptions(widgetId, options)], new RequestModalResponseHandler(), getApiVersionTag(widgetHostingVersionNumber, "widgetHosting.requestModal" /* ApiName.WidgetHosting_RequestModal */), isSdkError);
+    });
+}
+/**
+ * @beta
+ * @hidden
+ * Notifies the host about the intrinsic height of the widget content
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function notifyIntrinsicHeight(widgetId, height) {
+    ensureInitializeCalled();
+    widgetHostingLogger('Notifying intrinsic height with widgetId: ', { widgetId, height });
+    callFunctionInHost("widgetHosting.notifyIntrinsicHeight" /* ApiName.WidgetHosting_NotifyIntrinsicHeight */, [new SerializableIntrinsicHeightArgs(widgetId, height)], getApiVersionTag(widgetHostingVersionNumber, "widgetHosting.notifyIntrinsicHeight" /* ApiName.WidgetHosting_NotifyIntrinsicHeight */));
+}
+/**
+ * @beta
+ * @hidden
+ * Notifies the host about content size changes
+ * @internal
+ * Limited to Microsoft-internal use
+ * @param widgetId - The unique identifier for the widget
+ * @param width - The width of the content in pixels
+ * @param height - The height of the content in pixels
+ */
+function contentSizeChanged(widgetId, width, height) {
+    ensureInitializeCalled();
+    widgetHostingLogger('Content size changed with widgetId: ', { widgetId, width, height });
+    callFunctionInHost("widgetHosting.contentSizeChanged" /* ApiName.WidgetHosting_ContentSizeChanged */, [new SerializableContentSizeArgs(widgetId, width, height)], getApiVersionTag(widgetHostingVersionNumber, "widgetHosting.contentSizeChanged" /* ApiName.WidgetHosting_ContentSizeChanged */));
+}
+/**
+ * @beta
+ * @hidden
+ * Sets the widget state
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function setWidgetState(widgetId, state) {
+    return widgetHosting_awaiter(this, void 0, void 0, function* () {
+        ensureInitializeCalled();
+        widgetHostingLogger('Setting widget state with widgetId: ', { widgetId, state });
+        return callFunctionInHost("widgetHosting.setWidgetState" /* ApiName.WidgetHosting_SetWidgetState */, [new SerializableWidgetState(widgetId, state)], getApiVersionTag(widgetHostingVersionNumber, "widgetHosting.setWidgetState" /* ApiName.WidgetHosting_SetWidgetState */));
+    });
+}
+/**
+ * @beta
+ * @hidden
+ * Opens an external URL
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function openExternal(widgetId, payload) {
+    ensureInitializeCalled();
+    widgetHostingLogger('Opening external URL with widgetId: ', { widgetId, href: payload.href });
+    callFunctionInHost("widgetHosting.openExternal" /* ApiName.WidgetHosting_OpenExternal */, [new SerializableOpenExternalArgs(widgetId, payload)], getApiVersionTag(widgetHostingVersionNumber, "widgetHosting.openExternal" /* ApiName.WidgetHosting_OpenExternal */));
+}
+/**
+ * @hidden
+ * @beta
+ * Registers a handler to be called when a modal is closed.
+ * This handler will be called when the user closes a modal or when .close() is invoked.
+ * @param handler - The handler for modal close events.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function registerModalCloseHandler(handler) {
+    registerHandlerHelper(getApiVersionTag(widgetHostingVersionNumber, "widgetHosting.registerModalCloseHandler" /* ApiName.WidgetHosting_RegisterModalCloseHandler */), 'widgetHosting.closeWidgetModal', handler, [], () => {
+        if (!widgetHosting_isSupported()) {
+            throw new Error('Widget Hosting is not supported on this platform');
+        }
+    });
+}
+class CallToolResponseHandler extends ResponseHandler {
+    validate(response) {
+        return response !== null && typeof response === 'object';
+    }
+    deserialize(response) {
+        return response;
+    }
+}
+class RequestModalResponseHandler extends ResponseHandler {
+    validate(response) {
+        return response !== null && typeof response === 'object';
+    }
+    deserialize(response) {
+        return response;
+    }
+}
+/**
+ * Serializable wrapper for IToolInput to enable host communication
+ */
+class SerializableToolInput {
+    constructor(widgetId, toolInput) {
+        this.widgetId = widgetId;
+        this.toolInput = toolInput;
+    }
+    /**
+     * Serializes the tool input to a JSON-compliant format for host communication.
+     * @returns JSON representation of the tool input.
+     */
+    serialize() {
+        return {
+            widgetId: this.widgetId,
+            name: this.toolInput.name,
+            arguments: this.toolInput.arguments,
+        };
+    }
+}
+/**
+ * Serializable wrapper for follow-up message arguments
+ */
+class SerializableFollowUpMessageArgs {
+    constructor(widgetId, args) {
+        this.widgetId = widgetId;
+        this.args = args;
+    }
+    serialize() {
+        return {
+            widgetId: this.widgetId,
+            prompt: this.args.prompt,
+        };
+    }
+}
+/**
+ * Serializable wrapper for display mode arguments
+ */
+class SerializableDisplayModeArgs {
+    constructor(widgetId, args) {
+        this.widgetId = widgetId;
+        this.args = args;
+    }
+    serialize() {
+        return {
+            widgetId: this.widgetId,
+            mode: this.args.mode,
+        };
+    }
+}
+/**
+ * Serializable wrapper for external URL arguments
+ */
+class SerializableOpenExternalArgs {
+    constructor(widgetId, payload) {
+        this.widgetId = widgetId;
+        this.payload = payload;
+    }
+    serialize() {
+        return {
+            widgetId: this.widgetId,
+            href: this.payload.href,
+        };
+    }
+}
+/**
+ * Serializable wrapper for widget state
+ */
+class SerializableWidgetState {
+    constructor(widgetId, state) {
+        this.widgetId = widgetId;
+        this.state = state;
+    }
+    serialize() {
+        return {
+            widgetId: this.widgetId,
+            state: this.state,
+        };
+    }
+}
+/**
+ * Serializable wrapper for intrinsic height arguments
+ */
+class SerializableIntrinsicHeightArgs {
+    constructor(widgetId, height) {
+        this.widgetId = widgetId;
+        this.height = height;
+    }
+    serialize() {
+        return {
+            widgetId: this.widgetId,
+            height: this.height,
+        };
+    }
+}
+/**
+ * Serializable wrapper for modal options
+ */
+class SerializableModalOptions {
+    constructor(widgetId, options) {
+        this.widgetId = widgetId;
+        this.options = options;
+    }
+    serialize() {
+        return {
+            widgetId: this.widgetId,
+            id: this.options.id,
+            title: this.options.title,
+            content: this.options.content,
+            width: this.options.width,
+            height: this.options.height,
+        };
+    }
+}
+/**
+ * Serializable wrapper for content size arguments
+ */
+class SerializableContentSizeArgs {
+    constructor(widgetId, width, height) {
+        this.widgetId = widgetId;
+        this.width = width;
+        this.height = height;
+    }
+    serialize() {
+        return {
+            widgetId: this.widgetId,
+            width: this.width,
+            height: this.height,
+        };
+    }
+}
+
 ;// ./src/private/index.ts
 
 
@@ -14178,6 +14530,8 @@ function serializeValidSize(size) {
 
 
 
+
+