@microsoft/teams-js 2.24.0-beta.1 → 2.24.0

package/README.md

@@ -24,7 +24,7 @@ To install the stable [version](https://learn.microsoft.com/javascript/api/overv
 
 ### Production
 
-You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.23.0/js/MicrosoftTeams.min.js) or point your package manager at them.
+You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.24.0/js/MicrosoftTeams.min.js) or point your package manager at them.
 
 ## Usage
 
@@ -45,13 +45,13 @@ Reference the library inside of your `.html` page using:
 ```html
 <!-- Microsoft Teams JavaScript API (via CDN) -->
 <script
-  src="https://res.cdn.office.net/teams-js/2.23.0/js/MicrosoftTeams.min.js"
-  integrity="sha384-08XJvrutoSVYTA8PQeUgetTKn8B7JE73C5BdAfWnHZ5WnSFFQO6g1FGmSqxsrAzb"
+  src="https://res.cdn.office.net/teams-js/2.24.0/js/MicrosoftTeams.min.js"
+  integrity="sha384-79NK4sbfVpgLoDFqyfj18/S1Uj8jhLBeRGvKO1Cqw5634RznExQ90myY/qV/0gsN"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.23.0/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.24.0/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

package/dist/MicrosoftTeams.d.ts

@@ -4358,13 +4358,22 @@ export interface ResumeContext {
         /**
             * The content URL that is requested to be loaded
             */
-        contentUrl: string;
+        contentUrl: URL;
 }
 /**
     * @deprecated
     * As of 2.14.1, please use {@link ResumeContext} instead.
     */
-export type LoadContext = ResumeContext;
+export interface LoadContext {
+        /**
+            * The entity that is requested to be loaded
+            */
+        entityId: string;
+        /**
+            * The content URL that is requested to be loaded
+            */
+        contentUrl: string;
+}
 /** Represents information about a frame within a tab or dialog module. */
 export interface FrameInfo {
         /**
@@ -5074,7 +5083,7 @@ export namespace app {
                     *
                     * @returns void
                     */
-                type registerBeforeSuspendOrTerminateHandlerFunctionType = () => void;
+                type registerBeforeSuspendOrTerminateHandlerFunctionType = () => Promise<void>;
                 /**
                     * Registers a handler to be called before the page is suspended or terminated. Once a user navigates away from an app,
                     * the handler will be invoked. App developers can use this handler to save unsaved data, pause sync calls etc.

package/dist/MicrosoftTeams.js

@@ -3395,7 +3395,7 @@ const _minRuntimeConfigToUninitialize = {
  * @hidden
  *  Package version.
  */
-const version = "2.24.0-beta.1";
+const version = "2.24.0";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -6196,6 +6196,15 @@ var pages;
 
 ;// CONCATENATED MODULE: ./src/internal/handlers.ts
 /* eslint-disable @typescript-eslint/ban-types */
+var handlers_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());
+    });
+};
 
 
 
@@ -6364,17 +6373,31 @@ function handlers_registerOnLoadHandler(apiVersionTag, handler) {
  * @internal
  * Limited to Microsoft-internal use
  */
-function handleLoad(context) {
+function handleLoad(loadContext) {
+    const resumeContext = convertToResumeContext(loadContext);
     if (HandlersPrivate.resumeHandler) {
-        HandlersPrivate.resumeHandler(context);
+        HandlersPrivate.resumeHandler(resumeContext);
+        if (Communication.childWindow) {
+            sendMessageEventToChild('load', [resumeContext]);
+        }
     }
     else if (HandlersPrivate.loadHandler) {
-        HandlersPrivate.loadHandler(context);
-    }
-    if (Communication.childWindow) {
-        sendMessageEventToChild('load', [context]);
+        HandlersPrivate.loadHandler(loadContext);
+        if (Communication.childWindow) {
+            sendMessageEventToChild('load', [loadContext]);
+        }
     }
 }
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function convertToResumeContext(context) {
+    return {
+        entityId: context.entityId,
+        contentUrl: new URL(context.contentUrl),
+    };
+}
 /**
  * @internal
  * Limited to Microsoft-internal use
@@ -6390,26 +6413,28 @@ function handlers_registerBeforeUnloadHandler(apiVersionTag, handler) {
  * Limited to Microsoft-internal use
  */
 function handleBeforeUnload() {
-    const readyToUnload = () => {
-        sendMessageToParent(getApiVersionTag("v2" /* ApiVersionNumber.V_2 */, "handleBeforeUnload" /* ApiName.HandleBeforeUnload */), 'readyToUnload', []);
-    };
-    if (HandlersPrivate.beforeSuspendOrTerminateHandler) {
-        HandlersPrivate.beforeSuspendOrTerminateHandler();
-        if (Communication.childWindow) {
-            sendMessageEventToChild('beforeUnload');
-        }
-        else {
-            readyToUnload();
-        }
-    }
-    else if (!HandlersPrivate.beforeUnloadHandler || !HandlersPrivate.beforeUnloadHandler(readyToUnload)) {
-        if (Communication.childWindow) {
-            sendMessageEventToChild('beforeUnload');
+    return handlers_awaiter(this, void 0, void 0, function* () {
+        const readyToUnload = () => {
+            sendMessageToParent(getApiVersionTag("v2" /* ApiVersionNumber.V_2 */, "handleBeforeUnload" /* ApiName.HandleBeforeUnload */), 'readyToUnload', []);
+        };
+        if (HandlersPrivate.beforeSuspendOrTerminateHandler) {
+            yield HandlersPrivate.beforeSuspendOrTerminateHandler();
+            if (Communication.childWindow) {
+                sendMessageEventToChild('beforeUnload');
+            }
+            else {
+                readyToUnload();
+            }
         }
-        else {
-            readyToUnload();
+        else if (!HandlersPrivate.beforeUnloadHandler || !HandlersPrivate.beforeUnloadHandler(readyToUnload)) {
+            if (Communication.childWindow) {
+                sendMessageEventToChild('beforeUnload');
+            }
+            else {
+                readyToUnload();
+            }
         }
-    }
+    });
 }
 /**
  * @internal