@microsoft/teams-js 2.0.0-beta.5-dev.5 → 2.0.0-beta.5-dev.8

package/dist/MicrosoftTeams.d.ts

@@ -1653,6 +1653,7 @@ export enum ChannelType {
         Private = "Private",
         Shared = "Shared"
 }
+export const errorNotSupportedOnPlatform: string;
 
 /**
     * Represents information about tabs for an app
@@ -2085,6 +2086,26 @@ export interface Context {
             */
         mySitePath?: string;
 }
+export interface ShareDeepLinkParameters {
+        /**
+            * The developer-defined unique ID for the sub-page to which this deep link points in the current page.
+            * This field should be used to restore to a specific state within a page, such as scrolling to or activating a specific piece of content.
+            */
+        subPageId: string;
+        /**
+            * The label for the sub-page that should be displayed when the deep link is rendered in a client.
+            */
+        subPageLabel: string;
+        /**
+            * The fallback URL to which to navigate the user if the client cannot render the page.
+            * This URL should lead directly to the sub-entity.
+            */
+        subPageWebUrl?: string;
+}
+/**
+    * @deprecated
+    * As of 2.0.0-beta.5, please use {@link ShareDeepLinkParameters} instead.
+    */
 export interface DeepLinkParameters {
         /**
             * The developer-defined unique ID for the sub-entity to which this deep link points in the current entity.
@@ -2972,7 +2993,7 @@ export namespace pages {
             *
             * @param deepLinkParameters - ID and label for the link and fallback URL.
             */
-        function shareDeepLink(deepLinkParameters: DeepLinkParameters): void;
+        function shareDeepLink(deepLinkParameters: ShareDeepLinkParameters): void;
         /**
             * Registers a handler for changes from or to full-screen view for a tab.
             * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.

package/dist/MicrosoftTeams.js

@@ -1121,7 +1121,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = "2.0.0-beta.5-dev.5";
+var version = "2.0.0-beta.5-dev.8";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -1265,6 +1265,81 @@ var GlobalVars = /** @class */ (function () {
 }());
 
 
+;// CONCATENATED MODULE: ./src/public/interfaces.ts
+/* eslint-disable @typescript-eslint/no-explicit-any*/
+/**
+ * Allowed user file open preferences
+ */
+var FileOpenPreference;
+(function (FileOpenPreference) {
+    FileOpenPreference["Inline"] = "inline";
+    FileOpenPreference["Desktop"] = "desktop";
+    FileOpenPreference["Web"] = "web";
+})(FileOpenPreference || (FileOpenPreference = {}));
+var ErrorCode;
+(function (ErrorCode) {
+    /**
+     * API not supported in the current platform.
+     */
+    ErrorCode[ErrorCode["NOT_SUPPORTED_ON_PLATFORM"] = 100] = "NOT_SUPPORTED_ON_PLATFORM";
+    /**
+     * Internal error encountered while performing the required operation.
+     */
+    ErrorCode[ErrorCode["INTERNAL_ERROR"] = 500] = "INTERNAL_ERROR";
+    /**
+     * API is not supported in the current context
+     */
+    ErrorCode[ErrorCode["NOT_SUPPORTED_IN_CURRENT_CONTEXT"] = 501] = "NOT_SUPPORTED_IN_CURRENT_CONTEXT";
+    /**
+    Permissions denied by user
+    */
+    ErrorCode[ErrorCode["PERMISSION_DENIED"] = 1000] = "PERMISSION_DENIED";
+    /**
+     * Network issue
+     */
+    ErrorCode[ErrorCode["NETWORK_ERROR"] = 2000] = "NETWORK_ERROR";
+    /**
+     * Underlying hardware doesn't support the capability
+     */
+    ErrorCode[ErrorCode["NO_HW_SUPPORT"] = 3000] = "NO_HW_SUPPORT";
+    /**
+     * One or more arguments are invalid
+     */
+    ErrorCode[ErrorCode["INVALID_ARGUMENTS"] = 4000] = "INVALID_ARGUMENTS";
+    /**
+     * User is not authorized for this operation
+     */
+    ErrorCode[ErrorCode["UNAUTHORIZED_USER_OPERATION"] = 5000] = "UNAUTHORIZED_USER_OPERATION";
+    /**
+     * Could not complete the operation due to insufficient resources
+     */
+    ErrorCode[ErrorCode["INSUFFICIENT_RESOURCES"] = 6000] = "INSUFFICIENT_RESOURCES";
+    /**
+     * Platform throttled the request because of API was invoked too frequently
+     */
+    ErrorCode[ErrorCode["THROTTLE"] = 7000] = "THROTTLE";
+    /**
+     * User aborted the operation
+     */
+    ErrorCode[ErrorCode["USER_ABORT"] = 8000] = "USER_ABORT";
+    /**
+     * Could not complete the operation in the given time interval
+     */
+    ErrorCode[ErrorCode["OPERATION_TIMED_OUT"] = 8001] = "OPERATION_TIMED_OUT";
+    /**
+     * Platform code is old and doesn't implement this API
+     */
+    ErrorCode[ErrorCode["OLD_PLATFORM"] = 9000] = "OLD_PLATFORM";
+    /**
+     * The file specified was not found on the given location
+     */
+    ErrorCode[ErrorCode["FILE_NOT_FOUND"] = 404] = "FILE_NOT_FOUND";
+    /**
+     * The return value is too big and has exceeded our size boundries
+     */
+    ErrorCode[ErrorCode["SIZE_EXCEEDED"] = 10000] = "SIZE_EXCEEDED";
+})(ErrorCode || (ErrorCode = {}));
+
 ;// CONCATENATED MODULE: ./src/public/constants.ts
 var HostClientType;
 (function (HostClientType) {
@@ -1332,6 +1407,7 @@ var DialogDimension;
     DialogDimension["Medium"] = "medium";
     DialogDimension["Small"] = "small";
 })(DialogDimension || (DialogDimension = {}));
+
 /**
  * @deprecated
  * As of 2.0.0-beta.1, please use {@link DialogDimension} instead.
@@ -1347,81 +1423,7 @@ var ChannelType;
     ChannelType["Private"] = "Private";
     ChannelType["Shared"] = "Shared";
 })(ChannelType || (ChannelType = {}));
-
-;// CONCATENATED MODULE: ./src/public/interfaces.ts
-/* eslint-disable @typescript-eslint/no-explicit-any*/
-/**
- * Allowed user file open preferences
- */
-var FileOpenPreference;
-(function (FileOpenPreference) {
-    FileOpenPreference["Inline"] = "inline";
-    FileOpenPreference["Desktop"] = "desktop";
-    FileOpenPreference["Web"] = "web";
-})(FileOpenPreference || (FileOpenPreference = {}));
-var ErrorCode;
-(function (ErrorCode) {
-    /**
-     * API not supported in the current platform.
-     */
-    ErrorCode[ErrorCode["NOT_SUPPORTED_ON_PLATFORM"] = 100] = "NOT_SUPPORTED_ON_PLATFORM";
-    /**
-     * Internal error encountered while performing the required operation.
-     */
-    ErrorCode[ErrorCode["INTERNAL_ERROR"] = 500] = "INTERNAL_ERROR";
-    /**
-     * API is not supported in the current context
-     */
-    ErrorCode[ErrorCode["NOT_SUPPORTED_IN_CURRENT_CONTEXT"] = 501] = "NOT_SUPPORTED_IN_CURRENT_CONTEXT";
-    /**
-    Permissions denied by user
-    */
-    ErrorCode[ErrorCode["PERMISSION_DENIED"] = 1000] = "PERMISSION_DENIED";
-    /**
-     * Network issue
-     */
-    ErrorCode[ErrorCode["NETWORK_ERROR"] = 2000] = "NETWORK_ERROR";
-    /**
-     * Underlying hardware doesn't support the capability
-     */
-    ErrorCode[ErrorCode["NO_HW_SUPPORT"] = 3000] = "NO_HW_SUPPORT";
-    /**
-     * One or more arguments are invalid
-     */
-    ErrorCode[ErrorCode["INVALID_ARGUMENTS"] = 4000] = "INVALID_ARGUMENTS";
-    /**
-     * User is not authorized for this operation
-     */
-    ErrorCode[ErrorCode["UNAUTHORIZED_USER_OPERATION"] = 5000] = "UNAUTHORIZED_USER_OPERATION";
-    /**
-     * Could not complete the operation due to insufficient resources
-     */
-    ErrorCode[ErrorCode["INSUFFICIENT_RESOURCES"] = 6000] = "INSUFFICIENT_RESOURCES";
-    /**
-     * Platform throttled the request because of API was invoked too frequently
-     */
-    ErrorCode[ErrorCode["THROTTLE"] = 7000] = "THROTTLE";
-    /**
-     * User aborted the operation
-     */
-    ErrorCode[ErrorCode["USER_ABORT"] = 8000] = "USER_ABORT";
-    /**
-     * Could not complete the operation in the given time interval
-     */
-    ErrorCode[ErrorCode["OPERATION_TIMED_OUT"] = 8001] = "OPERATION_TIMED_OUT";
-    /**
-     * Platform code is old and doesn't implement this API
-     */
-    ErrorCode[ErrorCode["OLD_PLATFORM"] = 9000] = "OLD_PLATFORM";
-    /**
-     * The file specified was not found on the given location
-     */
-    ErrorCode[ErrorCode["FILE_NOT_FOUND"] = 404] = "FILE_NOT_FOUND";
-    /**
-     * The return value is too big and has exceeded our size boundries
-     */
-    ErrorCode[ErrorCode["SIZE_EXCEEDED"] = 10000] = "SIZE_EXCEEDED";
-})(ErrorCode || (ErrorCode = {}));
+var errorNotSupportedOnPlatform = JSON.stringify({ errorCode: ErrorCode.NOT_SUPPORTED_ON_PLATFORM });
 
 // EXTERNAL MODULE: ../../node_modules/uuid/index.js
 var uuid = __webpack_require__(22);
@@ -3142,9 +3144,9 @@ var pages;
     function shareDeepLink(deepLinkParameters) {
         ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
         sendMessageToParent('shareDeepLink', [
-            deepLinkParameters.subEntityId,
-            deepLinkParameters.subEntityLabel,
-            deepLinkParameters.subEntityWebUrl,
+            deepLinkParameters.subPageId,
+            deepLinkParameters.subPageLabel,
+            deepLinkParameters.subPageWebUrl,
         ]);
     }
     pages.shareDeepLink = shareDeepLink;
@@ -4164,6 +4166,9 @@ var conversations;
     function openConversation(openConversationRequest) {
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw new Error(errorNotSupportedOnPlatform);
+            }
             var sendPromise = sendAndHandleStatusAndReason('conversations.openConversation', {
                 title: openConversationRequest.title,
                 subEntityId: openConversationRequest.subEntityId,
@@ -4203,6 +4208,9 @@ var conversations;
      */
     function closeConversation() {
         ensureInitialized(FrameContexts.content);
+        if (!isSupported()) {
+            throw new Error(errorNotSupportedOnPlatform);
+        }
         sendMessageToParent('conversations.closeConversation');
         removeHandler('startConversation');
         removeHandler('closeConversation');
@@ -4223,6 +4231,9 @@ var conversations;
     function getChatMembers() {
         return new Promise(function (resolve) {
             ensureInitialized();
+            if (!isSupported()) {
+                throw new Error(errorNotSupportedOnPlatform);
+            }
             resolve(sendAndUnwrap('getChatMembers'));
         });
     }
@@ -4303,6 +4314,9 @@ var chat;
     function openChat(openChatRequest) {
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw new Error(errorNotSupportedOnPlatform);
+            }
             if (runtime.isLegacyTeams) {
                 resolve(sendAndHandleStatusAndReason('executeDeepLink', createTeamsDeepLinkForChat([openChatRequest.user], undefined /*topic*/, openChatRequest.message)));
             }
@@ -4339,6 +4353,9 @@ var chat;
             }
             else {
                 ensureInitialized(FrameContexts.content);
+                if (!isSupported()) {
+                    throw new Error(errorNotSupportedOnPlatform);
+                }
                 if (runtime.isLegacyTeams) {
                     resolve(sendAndHandleStatusAndReason('executeDeepLink', createTeamsDeepLinkForChat(openChatRequest.users, openChatRequest.topic, openChatRequest.message)));
                 }
@@ -6206,7 +6223,11 @@ function getMruTabInstances(callback, tabInstanceParameters) {
  * @param deepLinkParameters - ID and label for the link and fallback URL.
  */
 function shareDeepLink(deepLinkParameters) {
-    pages.shareDeepLink(deepLinkParameters);
+    pages.shareDeepLink({
+        subPageId: deepLinkParameters.subEntityId,
+        subPageLabel: deepLinkParameters.subEntityLabel,
+        subPageWebUrl: deepLinkParameters.subEntityWebUrl,
+    });
 }
 /**
  * @deprecated
@@ -6666,6 +6687,7 @@ var tasks;
 
 
 
+
 /**
  * @hidden
  * Hide from docs
@@ -6753,6 +6775,9 @@ var files;
     function getCloudStorageFolders(channelId) {
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw new Error(errorNotSupportedOnPlatform);
+            }
             if (!channelId || channelId.length === 0) {
                 throw new Error('[files.getCloudStorageFolders] channelId name cannot be null or empty');
             }
@@ -6770,6 +6795,9 @@ var files;
     function addCloudStorageFolder(channelId) {
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw new Error(errorNotSupportedOnPlatform);
+            }
             if (!channelId || channelId.length === 0) {
                 throw new Error('[files.addCloudStorageFolder] channelId name cannot be null or empty');
             }
@@ -6796,6 +6824,9 @@ var files;
     function deleteCloudStorageFolder(channelId, folderToDelete) {
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw new Error(errorNotSupportedOnPlatform);
+            }
             if (!channelId) {
                 throw new Error('[files.deleteCloudStorageFolder] channelId name cannot be null or empty');
             }
@@ -6818,6 +6849,9 @@ var files;
     function getCloudStorageFolderContents(folder, providerCode) {
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw new Error(errorNotSupportedOnPlatform);
+            }
             if (!folder || !providerCode) {
                 throw new Error('[files.getCloudStorageFolderContents] folder/providerCode name cannot be null or empty');
             }
@@ -6840,6 +6874,9 @@ var files;
      */
     function openCloudStorageFile(file, providerCode, fileOpenPreference) {
         ensureInitialized(FrameContexts.content);
+        if (!isSupported()) {
+            throw new Error(errorNotSupportedOnPlatform);
+        }
         if (!file || !providerCode) {
             throw new Error('[files.openCloudStorageFile] file/providerCode cannot be null or empty');
         }
@@ -6859,6 +6896,9 @@ var files;
      */
     function openFilePreview(filePreviewParameters) {
         ensureInitialized(FrameContexts.content);
+        if (!isSupported()) {
+            throw new Error(errorNotSupportedOnPlatform);
+        }
         var params = [
             filePreviewParameters.entityId,
             filePreviewParameters.title,
@@ -6889,6 +6929,9 @@ var files;
         if (excludeAddedProviders === void 0) { excludeAddedProviders = false; }
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw new Error(errorNotSupportedOnPlatform);
+            }
             resolve(sendAndHandleSdkError('files.getExternalProviders', excludeAddedProviders));
         });
     }
@@ -6902,6 +6945,9 @@ var files;
         if (isMove === void 0) { isMove = false; }
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw new Error(errorNotSupportedOnPlatform);
+            }
             if (!selectedFiles || selectedFiles.length === 0) {
                 throw new Error('[files.copyMoveFiles] selectedFiles cannot be null or empty');
             }
@@ -6924,6 +6970,9 @@ var files;
     files_1.isSupported = isSupported;
     function getFileDownloads(callback) {
         ensureInitialized(FrameContexts.content);
+        if (!isSupported()) {
+            throw new Error(errorNotSupportedOnPlatform);
+        }
         var wrappedFunction = function () {
             return new Promise(function (resolve) { return resolve(sendAndHandleSdkError('files.getFileDownloads', [])); });
         };
@@ -6941,6 +6990,9 @@ var files;
     function openDownloadFolder(fileObjectId, callback) {
         if (fileObjectId === void 0) { fileObjectId = undefined; }
         ensureInitialized(FrameContexts.content);
+        if (!isSupported()) {
+            throw new Error(errorNotSupportedOnPlatform);
+        }
         if (!callback) {
             throw new Error('[files.openDownloadFolder] Callback cannot be null');
         }