@microsoft/teams-js 1.10.1-dev.0 → 1.10.1-dev.1

package/dts/index.d.ts

@@ -0,0 +1,2 @@
+export * from './private/index';
+export * from './public/index';

package/dts/internal/communication.d.ts

@@ -0,0 +1,23 @@
+export declare class Communication {
+    static currentWindow: Window | any;
+    static parentOrigin: string;
+    static parentWindow: Window | any;
+    static childWindow: Window;
+    static childOrigin: string;
+}
+export declare function initializeCommunication(callback: Function, validMessageOrigins: string[] | undefined): void;
+export declare function uninitializeCommunication(): void;
+/**
+ * Send a message to parent. Uses nativeInterface on mobile to communicate with parent context
+ */
+export declare function sendMessageToParent(actionName: string, callback?: Function): void;
+/**
+ * Send a message to parent. Uses nativeInterface on mobile to communicate with parent context
+ */
+export declare function sendMessageToParent(actionName: string, args: any[], callback?: Function): void;
+export declare function waitForMessageQueue(targetWindow: Window, callback: () => void): void;
+/**
+ * Send a custom message object that can be sent to child window,
+ * instead of a response message to a child
+ */
+export declare function sendMessageEventToChild(actionName: string, args?: any[]): void;

package/dts/internal/constants.d.ts

@@ -0,0 +1,42 @@
+export declare const version = "1.10.1-dev.1";
+/**
+ * This is the SDK version when all SDK APIs started to check platform compatibility for the APIs.
+ */
+export declare const defaultSDKVersionForCompatCheck = "1.6.0";
+/**
+ * Minimum required client supported version for {@link getUserJoinedTeams} to be supported on {@link HostClientType.android}
+ */
+export declare const getUserJoinedTeamsSupportedAndroidClientVersion = "2.0.1";
+/**
+ * This is the SDK version when location APIs (getLocation and showLocation) are supported.
+ */
+export declare const locationAPIsRequiredVersion = "1.9.0";
+/**
+ * This is the SDK version when people picker API is supported on mobile.
+ */
+export declare const peoplePickerRequiredVersion = "2.0.0";
+/**
+ * This is the SDK version when captureImage API is supported on mobile.
+ */
+export declare const captureImageMobileSupportVersion = "1.7.0";
+/**
+ * This is the SDK version when media APIs are supported on all three platforms ios, android and web.
+ */
+export declare const mediaAPISupportVersion = "1.8.0";
+/**
+ * This is the SDK version when getMedia API is supported via Callbacks on all three platforms ios, android and web.
+ */
+export declare const getMediaCallbackSupportVersion = "2.0.0";
+/**
+ * This is the SDK version when scanBarCode API is supported on mobile.
+ */
+export declare const scanBarCodeAPIMobileSupportVersion = "1.9.0";
+/**
+ * List of supported Host origins
+ */
+export declare const validOrigins: string[];
+export declare const validOriginRegExp: RegExp;
+/**
+ * USer specified message origins should satisfy this test
+ */
+export declare const userOriginUrlValidationRegExp: RegExp;

package/dts/internal/globalVars.d.ts

@@ -0,0 +1,15 @@
+import { FrameContexts } from '../public';
+export declare class GlobalVars {
+    static initializeCalled: boolean;
+    static initializeCompleted: boolean;
+    static additionalValidOrigins: string[];
+    static additionalValidOriginsRegexp: RegExp;
+    static initializeCallbacks: {
+        (): void;
+    }[];
+    static isFramelessWindow: boolean;
+    static frameContext: FrameContexts;
+    static hostClientType: string;
+    static clientSupportedSDKVersion: string;
+    static printCapabilityEnabled: boolean;
+}

package/dts/internal/handlers.d.ts

@@ -0,0 +1,10 @@
+import { LoadContext } from '../public';
+export declare function initializeHandlers(): void;
+export declare function callHandler(name: string, args?: any[]): [true, any] | [false, undefined];
+export declare function registerHandler(name: string, handler: Function, sendMessage?: boolean, args?: any[]): void;
+export declare function removeHandler(name: string): void;
+export declare function registerOnThemeChangeHandler(handler: (theme: string) => void): void;
+export declare function handleThemeChange(theme: string): void;
+export declare function registerBackButtonHandler(handler: () => boolean): void;
+export declare function registerOnLoadHandler(handler: (context: LoadContext) => void): void;
+export declare function registerBeforeUnloadHandler(handler: (readyToUnload: () => void) => boolean): void;

package/dts/internal/interfaces.d.ts

@@ -0,0 +1,44 @@
+/**
+ * @private
+ * Hide from docs
+ * Shim in definitions used for browser-compat
+ */
+export interface DOMMessageEvent {
+    origin?: any;
+    source?: any;
+    data?: any;
+    originalEvent: DOMMessageEvent;
+}
+/**
+ * @private
+ * Hide from docs
+ */
+export interface TeamsNativeClient {
+    framelessPostMessage(msg: string): void;
+}
+/**
+ * @private
+ * Hide from docs
+ */
+export interface ExtendedWindow extends Window {
+    nativeInterface: TeamsNativeClient;
+    onNativeMessage(evt: DOMMessageEvent): void;
+}
+export interface MessageRequest {
+    id?: number;
+    func: string;
+    timestamp?: number;
+    args?: any[];
+}
+export interface MessageResponse {
+    id: number;
+    args?: any[];
+    isPartialResponse?: boolean;
+}
+/**
+ * Meant for Message objects that are sent to children without id
+ */
+export interface DOMMessageEvent {
+    func: string;
+    args?: any[];
+}

package/dts/internal/internalAPIs.d.ts

@@ -0,0 +1,12 @@
+export declare function ensureInitialized(...expectedFrameContexts: string[]): void;
+/**
+ * Checks whether the platform has knowledge of this API by doing a comparison
+ * on API required version and platform supported version of the SDK
+ * @param requiredVersion SDK version required by the API
+ */
+export declare function isAPISupportedByPlatform(requiredVersion?: string): boolean;
+/**
+ * Processes the valid origins specifuied by the user, de-duplicates and converts them into a regexp
+ * which is used later for message source/origin validation
+ */
+export declare function processAdditionalValidOrigins(validMessageOrigins: string[]): void;

package/dts/internal/mediaUtil.d.ts

@@ -0,0 +1,31 @@
+import { people } from '../public/people';
+import { media } from '../public/media';
+/**
+ * Helper function to create a blob from media chunks based on their sequence
+ */
+export declare function createFile(assembleAttachment: media.AssembleAttachment[], mimeType: string): Blob;
+/**
+ * Helper function to convert Media chunks into another object type which can be later assemebled
+ * Converts base 64 encoded string to byte array and then into an array of blobs
+ */
+export declare function decodeAttachment(attachment: media.MediaChunk, mimeType: string): media.AssembleAttachment;
+/**
+ * Returns true if the mediaInput params are valid and false otherwise
+ */
+export declare function validateSelectMediaInputs(mediaInputs: media.MediaInputs): boolean;
+/**
+ * Returns true if the get Media params are valid and false otherwise
+ */
+export declare function validateGetMediaInputs(mimeType: string, format: media.FileFormat, content: string): boolean;
+/**
+ * Returns true if the view images param is valid and false otherwise
+ */
+export declare function validateViewImagesInput(uriList: media.ImageUri[]): boolean;
+/**
+ * Returns true if the scan barcode param is valid and false otherwise
+ */
+export declare function validateScanBarCodeInput(barCodeConfig: media.BarCodeConfig): boolean;
+/**
+ * Returns true if the people picker params are valid and false otherwise
+ */
+export declare function validatePeoplePickerInput(peoplePickerInputs: people.PeoplePickerInputs): boolean;

package/dts/internal/utils.d.ts

@@ -0,0 +1,22 @@
+export declare function generateRegExpFromUrls(urls: string[]): RegExp;
+export declare function getGenericOnCompleteHandler(errorMessage?: string): (success: boolean, reason?: string) => void;
+/**
+ * Compares SDK versions.
+ * @param v1 first version
+ * @param v2 second version
+ * returns NaN in case inputs are not in right format
+ *         -1 if v1 < v2
+ *          1 if v1 > v2
+ *          0 otherwise
+ * For example,
+ *    compareSDKVersions('1.2', '1.2.0') returns 0
+ *    compareSDKVersions('1.2a', '1.2b') returns NaN
+ *    compareSDKVersions('1.2', '1.3') returns -1
+ *    compareSDKVersions('2.0', '1.3.2') returns 1
+ *    compareSDKVersions('2.0', 2.0) returns NaN
+ */
+export declare function compareSDKVersions(v1: string, v2: string): number;
+/**
+ * Generates a GUID
+ */
+export declare function generateGUID(): string;

package/dts/private/appEntity.d.ts

@@ -0,0 +1,49 @@
+import { SdkError } from '../public';
+/**
+ * Namespace to interact with the application entities specific part of the SDK.
+ *
+ * @private
+ * Hide from docs
+ */
+export declare namespace appEntity {
+    /**
+     * @private
+     * Hide from docs
+     * --------
+     * Information on an app entity
+     */
+    interface AppEntity {
+        /**
+         * App ID of the application
+         */
+        appId: string;
+        /**
+         * URL for the application's icon
+         */
+        appIconUrl: string;
+        /**
+         * Content URL for the app entity
+         */
+        contentUrl: string;
+        /**
+         * The display name for the app entity
+         */
+        displayName: string;
+        /**
+         * Website URL for the app entity. It is meant to be opened by the user in a browser.
+         */
+        websiteUrl: string;
+    }
+    /**
+     * @private
+     * Hide from docs
+     *
+     * Open the Tab Gallery and retrieve the app entity
+     * @param threadId ID of the thread where the app entity will be created
+     * @param categories A list of app categories that will be displayed in the open tab gallery
+     * @param callback Callback that will be triggered once the app entity information is available.
+     *                 The callback takes two arguments: the app entity configuration, if available and
+     *                 an optional SdkError in case something happened (i.e. the window was closed)
+     */
+    function selectAppEntity(threadId: string, categories: string[], callback: (appEntity: AppEntity, sdkError?: SdkError) => void): void;
+}

package/dts/private/bot.d.ts

@@ -0,0 +1,77 @@
+/**
+ * @private
+ * Namespace to interact with bots using the SDK.
+ */
+export declare namespace bot {
+    /**
+     * @private
+     * Hide from docs until release.
+     * ------
+     * Sends query to bot in order to retrieve data.
+     * @param botRequest query to send to bot.
+     * @param onSuccess callback to invoke when data is retrieved from bot
+     * @param onError callback to invoke should an error occur
+     */
+    function sendQuery(botRequest: QueryRequest, onSuccess?: (data: QueryResponse) => void, onError?: (error: string) => void): void;
+    /**
+     * @private
+     * Hide from docs until release.
+     * -----
+     * Retrieves list of support commands from bot
+     * @param onSuccess callback to invoke when data is retrieved from bot
+     * @param onError callback to invoke should an error occur
+     */
+    function getSupportedCommands(onSuccess?: (response: Command[]) => void, onError?: (error: string) => void): void;
+    /**
+     * @private
+     * Hide from docs until release.
+     * -----
+     * Authenticates a user for json tab
+     * @param authRequest callback to invoke when data is retrieved from bot
+     * @param onSuccess callback to invoke when user is authenticated
+     * @param onError callback to invoke should an error occur
+     */
+    function authenticate(authRequest: AuthQueryRequest, onSuccess?: (results: Results) => void, onError?: (error: string) => void): void;
+    interface QueryRequest {
+        /**
+         * Query to search for
+         */
+        query: string;
+        commandId?: string;
+        option?: {
+            skip: number;
+            count: number;
+        };
+    }
+    interface QueryResponse {
+        data: Results | Auth;
+        type: ResponseType;
+    }
+    interface Results {
+        attachments: Attachment[];
+        layout: any;
+        botId: string;
+    }
+    interface Auth {
+        url: string;
+        title: string;
+    }
+    interface AuthQueryRequest extends QueryRequest {
+        url: string;
+    }
+    interface Attachment {
+        card: any;
+        previewCard: any;
+        previewRawPayload: any;
+        rawPayload: any;
+    }
+    interface Command {
+        title: string;
+        id: string;
+        initialRun: boolean;
+    }
+    enum ResponseType {
+        Results = "Results",
+        Auth = "Auth"
+    }
+}

package/dts/private/conversations.d.ts

@@ -0,0 +1,20 @@
+import { OpenConversationRequest } from '../public/interfaces';
+/**
+ * Namespace to interact with the conversational subEntities inside the tab
+ */
+export declare namespace conversations {
+    /**
+     * @private
+     * Hide from docs
+     * --------------
+     * Allows the user to start or continue a conversation with each subentity inside the tab
+     */
+    function openConversation(openConversationRequest: OpenConversationRequest): void;
+    /**
+     * @private
+     * Hide from docs
+     * --------------
+     * Allows the user to close the conversation in the right pane
+     */
+    function closeConversation(): void;
+}

package/dts/private/files.d.ts

@@ -0,0 +1,169 @@
+import { FileOpenPreference, SdkError } from '../public';
+/**
+ * Namespace to interact with the files specific part of the SDK.
+ *
+ * @private
+ * Hide from docs
+ */
+export declare namespace files {
+    /**
+     * @private
+     * Hide from docs
+     *
+     * Cloud storage providers registered with Microsoft Teams
+     */
+    enum CloudStorageProvider {
+        Dropbox = "DROPBOX",
+        Box = "BOX",
+        Sharefile = "SHAREFILE",
+        GoogleDrive = "GOOGLEDRIVE",
+        Egnyte = "EGNYTE"
+    }
+    /**
+     * @private
+     * Hide from docs
+     *
+     * Cloud storage provider integration type
+     */
+    enum CloudStorageProviderType {
+        Sharepoint = 0,
+        WopiIntegration = 1,
+        Google = 2
+    }
+    /**
+     * @private
+     * Hide from docs
+     *
+     * Cloud storage folder interface
+     */
+    interface CloudStorageFolder {
+        /**
+         * ID of the cloud storage folder
+         */
+        id: string;
+        /**
+         * Display Name/Title of the cloud storage folder
+         */
+        title: string;
+        /**
+         * ID of the cloud storage folder in the provider
+         */
+        folderId: string;
+        /**
+         * Type of the cloud storage folder provider integration
+         */
+        providerType: CloudStorageProviderType;
+        /**
+         * Code of the supported cloud storage folder provider
+         */
+        providerCode: CloudStorageProvider;
+        /**
+         * Display name of the owner of the cloud storage folder provider
+         */
+        ownerDisplayName: string;
+        /**
+         * Sharepoint specific siteURL of the folder
+         */
+        siteUrl?: string;
+        /**
+         * Sharepoint specific serverRelativeUrl of the folder
+         */
+        serverRelativeUrl?: string;
+        /**
+         * Sharepoint specific libraryType of the folder
+         */
+        libraryType?: string;
+        /**
+         * Sharepoint specific accessType of the folder
+         */
+        accessType?: string;
+    }
+    /**
+     * @private
+     * Hide from docs
+     *
+     * Cloud storage item interface
+     */
+    interface CloudStorageFolderItem {
+        /**
+         * ID of the item in the provider
+         */
+        id: string;
+        /**
+         * Display name/title
+         */
+        title: string;
+        /**
+         * Key to differentiate files and subdirectory
+         */
+        isSubdirectory: boolean;
+        /**
+         * File extension
+         */
+        type: string;
+        /**
+         * Last modifed time of the item
+         */
+        lastModifiedTime: string;
+        /**
+         * Display size of the items in bytes
+         */
+        size: number;
+        /**
+         * URL of the file
+         */
+        objectUrl: string;
+        /**
+         * Temporary access token for the item
+         */
+        accessToken?: string;
+    }
+    /**
+     * @private
+     * Hide from docs
+     *
+     * Gets a list of cloud storage folders added to the channel
+     * @param channelId ID of the channel whose cloud storage folders should be retrieved
+     * @param callback Callback that will be triggered post folders load
+     */
+    function getCloudStorageFolders(channelId: string, callback: (error: SdkError, folders: CloudStorageFolder[]) => void): void;
+    /**
+     * @private
+     * Hide from docs
+     *
+     * Initiates the add cloud storage folder flow
+     * @param channelId ID of the channel to add cloud storage folder
+     * @param callback Callback that will be triggered post add folder flow is compelete
+     */
+    function addCloudStorageFolder(channelId: string, callback: (error: SdkError, isFolderAdded: boolean, folders: CloudStorageFolder[]) => void): void;
+    /**
+     * @private
+     * Hide from docs
+     *
+     * Deletes a cloud storage folder from channel
+     * @param channelId ID of the channel where folder is to be deleted
+     * @param folderToDelete cloud storage folder to be deleted
+     * @param callback Callback that will be triggered post delete
+     */
+    function deleteCloudStorageFolder(channelId: string, folderToDelete: CloudStorageFolder, callback: (error: SdkError, isFolderDeleted: boolean) => void): void;
+    /**
+     * @private
+     * Hide from docs
+     *
+     * Fetches the contents of a Cloud storage folder (CloudStorageFolder) / sub directory
+     * @param folder Cloud storage folder (CloudStorageFolder) / sub directory (CloudStorageFolderItem)
+     * @param providerCode Code of the cloud storage folder provider
+     * @param callback Callback that will be triggered post contents are loaded
+     */
+    function getCloudStorageFolderContents(folder: CloudStorageFolder | CloudStorageFolderItem, providerCode: CloudStorageProvider, callback: (error: SdkError, items: CloudStorageFolderItem[]) => void): void;
+    /**
+     * @private
+     * Hide from docs
+     *
+     * Open a cloud storage file in teams
+     * @param file cloud storage file that should be opened
+     * @param providerCode Code of the cloud storage folder provider
+     * @param fileOpenPreference Whether file should be opened in web/inline
+     */
+    function openCloudStorageFile(file: CloudStorageFolderItem, providerCode: CloudStorageProvider, fileOpenPreference?: FileOpenPreference.Web | FileOpenPreference.Inline): void;
+}

package/dts/private/index.d.ts

@@ -0,0 +1,10 @@
+export { bot } from './bot';
+export { menus } from './menus';
+export { logs } from './logs';
+export { ChatMembersInformation, FilePreviewParameters, NotificationTypes, ShowNotificationParameters, TeamInstanceParameters, ThreadMember, UserJoinedTeamsInformation, ViewerActionTypes, UserSettingTypes, } from './interfaces';
+export { enterFullscreen, exitFullscreen, getChatMembers, getConfigSetting, getUserJoinedTeams, openFilePreview, sendCustomMessage, showNotification, sendCustomEvent, registerCustomHandler, uploadCustomApp, registerUserSettingsChangeHandler, } from './privateAPIs';
+export { conversations } from './conversations';
+export { meetingRoom } from './meetingRoom';
+export { remoteCamera } from './remoteCamera';
+export { files } from './files';
+export { appEntity } from './appEntity';

package/dts/private/interfaces.d.ts

@@ -0,0 +1,141 @@
+import { FileOpenPreference, TeamInformation } from '../public/interfaces';
+/**
+ * @private
+ * Hide from docs
+ * --------
+ * Information about all members in a chat
+ */
+export interface ChatMembersInformation {
+    members: ThreadMember[];
+}
+/**
+ * @private
+ * Hide from docs
+ * --------
+ * Information about a chat member
+ */
+export interface ThreadMember {
+    /**
+     * The member's user principal name in the current tenant.
+     */
+    upn: string;
+}
+export declare enum NotificationTypes {
+    fileDownloadStart = "fileDownloadStart",
+    fileDownloadComplete = "fileDownloadComplete"
+}
+export interface ShowNotificationParameters {
+    message: string;
+    notificationType: NotificationTypes;
+}
+/**
+ * @private
+ * Hide from docs.
+ * ------
+ */
+export declare enum ViewerActionTypes {
+    view = "view",
+    edit = "edit",
+    editNew = "editNew"
+}
+/**
+ * * @private
+ * Hide from docs.
+ * ------
+ * User setting changes that can be subscribed to,
+ */
+export declare enum UserSettingTypes {
+    /**
+     * Use this key to subscribe to changes in user's file open preference
+     */
+    fileOpenPreference = "fileOpenPreference",
+    /**
+     * Use this key to subscribe to theme changes
+     */
+    theme = "theme"
+}
+/**
+ * @private
+ * Hide from docs.
+ * ------
+ */
+export interface FilePreviewParameters {
+    /**
+     * The developer-defined unique ID for the file.
+     */
+    entityId: string;
+    /**
+     * The display name of the file.
+     */
+    title: string;
+    /**
+     * An optional description of the file.
+     */
+    description?: string;
+    /**
+     * The file extension; e.g. pptx, docx, etc.
+     */
+    type: string;
+    /**
+     * A url to the source of the file, used to open the content in the user's default browser
+     */
+    objectUrl: string;
+    /**
+     * Optional; an alternate self-authenticating url used to preview the file in Mobile clients and offer it for download by the user
+     */
+    downloadUrl?: string;
+    /**
+     * Optional; an alternate url optimized for previewing the file in Teams web and desktop clients
+     */
+    webPreviewUrl?: string;
+    /**
+     * Optional; an alternate url that allows editing of the file in Teams web and desktop clients
+     */
+    webEditUrl?: string;
+    /**
+     * Optional; the base url of the site where the file is hosted
+     */
+    baseUrl?: string;
+    /**
+     * Deprecated; prefer using viewerAction instead
+     * Optional; indicates whether the file should be opened in edit mode
+     */
+    editFile?: boolean;
+    /**
+     * Optional; the developer-defined unique ID for the sub-entity to return to when the file stage closes.
+     * This field should be used to restore to a specific state within an entity, such as scrolling to or activating a specific piece of content.
+     */
+    subEntityId?: string;
+    /**
+     * Optional; indicates the mode in which file should be opened. Takes precedence over edit mode.
+     */
+    viewerAction?: ViewerActionTypes;
+    /**
+     * Optional; indicates how user prefers to open the file
+     */
+    fileOpenPreference?: FileOpenPreference;
+}
+/**
+ * @private
+ * Hide from docs
+ * --------
+ * Query parameters used when fetching team information
+ */
+export interface TeamInstanceParameters {
+    /**
+     * Flag allowing to select favorite teams only
+     */
+    favoriteTeamsOnly?: boolean;
+}
+/**
+ * @private
+ * Hide from docs
+ * --------
+ * Information on userJoined Teams
+ */
+export interface UserJoinedTeamsInformation {
+    /**
+     * List of team information
+     */
+    userJoinedTeams: TeamInformation[];
+}