@microsoft/teams-js 2.50.0 → 2.51.0

package/dist/umd/MicrosoftTeams.js

@@ -1070,6 +1070,7 @@ __webpack_require__.d(__webpack_exports__, {
   overwriteFeatureFlagsState: () => (/* reexport */ overwriteFeatureFlagsState),
   pages: () => (/* reexport */ pages_namespaceObject),
   people: () => (/* reexport */ people_namespaceObject),
+  plugins: () => (/* reexport */ plugins_namespaceObject),
   print: () => (/* reexport */ publicAPIs_print),
   profile: () => (/* reexport */ profile_namespaceObject),
   registerAppButtonClickHandler: () => (/* reexport */ registerAppButtonClickHandler),
@@ -1562,6 +1563,15 @@ __webpack_require__.d(otherAppStateChange_namespaceObject, {
   unregisterAppInstallationHandler: () => (unregisterAppInstallationHandler)
 });
 
+// NAMESPACE OBJECT: ./src/private/plugins.ts
+var plugins_namespaceObject = {};
+__webpack_require__.r(plugins_namespaceObject);
+__webpack_require__.d(plugins_namespaceObject, {
+  isSupported: () => (plugins_isSupported),
+  registerPluginMessage: () => (registerPluginMessage),
+  sendPluginMessage: () => (sendPluginMessage)
+});
+
 // NAMESPACE OBJECT: ./src/private/remoteCamera.ts
 var remoteCamera_namespaceObject = {};
 __webpack_require__.r(remoteCamera_namespaceObject);
@@ -4669,7 +4679,7 @@ function isSerializable(arg) {
  * @hidden
  *  Package version.
  */
-const version = "2.50.0";
+const version = "2.51.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.
@@ -4959,8 +4969,10 @@ function ensureInitialized(runtime, ...expectedFrameContexts) {
             }
         }
         if (!found) {
-            throw new Error(`This call is only allowed in following contexts: ${JSON.stringify(expectedFrameContexts)}. ` +
-                `Current context: "${GlobalVars.frameContext}".`);
+            const errorMessage = `This call is only allowed in following contexts: ${JSON.stringify(expectedFrameContexts)}. ` +
+                `Current context: "${GlobalVars.frameContext}".`;
+            ensureInitializedLogger(errorMessage);
+            throw new Error(errorMessage);
         }
     }
     return isRuntimeInitialized(runtime);
@@ -5679,6 +5691,7 @@ function transformLegacyContextToAppContext(legacyContext) {
             host: {
                 name: legacyContext.hostName ? legacyContext.hostName : HostName.teams,
                 clientType: legacyContext.hostClientType ? legacyContext.hostClientType : HostClientType.web,
+                features: legacyContext.hostFeatures,
                 sessionId: legacyContext.sessionId ? legacyContext.sessionId : '',
                 ringId: legacyContext.ringId,
                 ancestors: legacyContext.hostAncestors,
@@ -9301,6 +9314,8 @@ function uploadCustomApp(manifestBlob, onComplete) {
     sendMessageToParent(getApiVersionTag(privateAPIsTelemetryVersionNumber, "uploadCustomApp" /* ApiName.PrivateAPIs_UploadCustomApp */), 'uploadCustomApp', [manifestBlob], onComplete ? onComplete : getGenericOnCompleteHandler());
 }
 /**
+ * @deprecated Use {@link plugins.sendPluginMessage} with {@link plugins.registerPluginMessage} and a correlationId-based response pattern.
+ *
  * @hidden
  * Sends a custom action MessageRequest to host or parent window
  *
@@ -9309,6 +9324,39 @@ function uploadCustomApp(manifestBlob, onComplete) {
  * @param callback - Optionally specify a callback to receive response parameters from the parent
  * @returns id of sent message
  *
+ * @remarks
+ * Prefer the plugin event model for new development. In that model, send a request message
+ * with a unique `correlationId` and listen for a response event with the same `correlationId`.
+ *
+ * Example:
+ * ```ts
+ * // Request side
+ * const correlationId = crypto.randomUUID();
+ *
+ * plugins.registerPluginMessage((message) => {
+ *   if (message.func !== 'example.customAction.response') {
+ *     return;
+ *   }
+ *   if (message.correlationId !== correlationId) {
+ *     return;
+ *   }
+ *
+ *   // This is the response for the request above.
+ *   const response = message.args;
+ *   console.log('Received response', response);
+ * });
+ *
+ * await plugins.sendPluginMessage({
+ *   func: 'example.customAction.request',
+ *   args: { itemId: '12345' },
+ *   correlationId,
+ * });
+ *
+ * // Host side contract example (conceptual):
+ * // On receiving example.customAction.request, send back
+ * // example.customAction.response with the same correlationId.
+ * ```
+ *
  * @internal
  * Limited to Microsoft-internal use
  */
@@ -9395,6 +9443,8 @@ function openFilePreview(filePreviewParameters) {
         filePreviewParameters.messageId,
         filePreviewParameters.callerInfo,
         filePreviewParameters.atpData,
+        filePreviewParameters.shareUrl,
+        filePreviewParameters.replyChainId,
     ];
     sendMessageToParent(getApiVersionTag(privateAPIsTelemetryVersionNumber, "openFilePreview" /* ApiName.PrivateAPIs_OpenFilePreview */), 'openFilePreview', params);
 }
@@ -12185,6 +12235,122 @@ function otherAppStateChange_isSupported() {
     return ensureInitialized(runtime) && runtime.supports.otherAppStateChange ? true : false;
 }
 
+;// ./src/private/plugins.ts
+var plugins_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 pluginTelemetryVersionNumber = "v2" /* ApiVersionNumber.V_2 */;
+/**
+ * Indicates whether the plugin capability is available in the current host.
+ *
+ * @remarks
+ * This API validates SDK initialization and then checks runtime capability flags
+ * for `supports.plugins`.
+ *
+ * @returns `true` if the host reports plugin support; otherwise `false`.
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed.
+ *
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ * @beta
+ */
+function plugins_isSupported() {
+    return ensureInitialized(runtime) && !!runtime.supports.plugins;
+}
+/**
+ * Sends a plugin message to the host.
+ *
+ * @remarks
+ * The message payload is serialized before transmission to the host.
+ * All payload data must be JSON-safe (see {@link JsonValue}).
+ *
+ * @returns A promise that resolves when the host acknowledges the message.
+ *
+ * @throws Error if SDK initialization has not completed, if the host returns
+ * an error response, or if `func` is missing.
+ *
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ * @beta
+ */
+function sendPluginMessage(message) {
+    return plugins_awaiter(this, void 0, void 0, function* () {
+        ensureInitialized(runtime);
+        if (!message.func) {
+            throw new Error('func is required in PluginMessage.');
+        }
+        return callFunctionInHost("plugins.sendMessage" /* ApiName.Plugins_SendMessage */, [new SerializablePluginMessage(message)], getApiVersionTag(pluginTelemetryVersionNumber, "plugins.sendMessage" /* ApiName.Plugins_SendMessage */));
+    });
+}
+/**
+ * Registers a handler to receive plugin messages from the host.
+ *
+ * @remarks
+ * This API registers the callback under the `plugin.receiveMessage` handler name.
+ * When the host dispatches a plugin message, the supplied handler is invoked with
+ * the received JSON payload.
+ *
+ * @param handler - Callback invoked for each incoming plugin message payload.
+ *
+ * @throws Error if plugin messaging is not supported by the current host.
+ *
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ * @beta
+ */
+function registerPluginMessage(handler) {
+    registerHandlerHelper(getApiVersionTag(pluginTelemetryVersionNumber, "plugins.receiveMessage" /* ApiName.Plugins_ReceiveMessage */), "plugins.receiveMessage" /* ApiName.Plugins_ReceiveMessage */, (...incoming) => {
+        handler(normalizePluginInboundMessage(incoming));
+    }, Object.values(FrameContexts), () => {
+        if (!plugins_isSupported()) {
+            throw new Error('Receiving plugin messages is not supported in the current host.');
+        }
+    });
+}
+class SerializablePluginMessage {
+    constructor(message) {
+        this.message = message;
+    }
+    serialize() {
+        return this.message;
+    }
+}
+function normalizePluginInboundMessage(incoming) {
+    // New envelope format: { func, args, correlationId?, schemaVersion? }
+    if (incoming.length === 1 && isPluginInboundMessage(incoming[0])) {
+        return incoming[0];
+    }
+    const [func, args, correlationId] = incoming;
+    return {
+        func: typeof func === 'string' ? func : String(func !== null && func !== void 0 ? func : ''),
+        args: args,
+        correlationId: typeof correlationId === 'string' ? correlationId : undefined,
+    };
+}
+function isPluginInboundMessage(value) {
+    if (!value || typeof value !== 'object') {
+        return false;
+    }
+    const message = value;
+    return typeof message.func === 'string';
+}
+
 ;// ./src/private/remoteCamera.ts
 /**
  * @hidden
@@ -14649,6 +14815,8 @@ class SerializableContentSizeArgs {
 
 
 
+
+