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

package/dist/esm/packages/teams-js/dts/private/hostEntity/hostEntity.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @hidden
+ * @internal
+ * @beta
+ * @module
+ * Limited to Microsoft-internal use
+ *
+ * This capability allows an app to associate apps with a host entity, such as a Teams channel or chat, and configure them as needed.
+ */
+import * as tab from './tab';
+export declare enum AppTypes {
+    edu = "EDU"
+}
+/**
+ * Id of the teams entity like channel, chat
+ */
+interface TeamsEntityId {
+    threadId: string;
+}
+/**
+ * Id of message in which channel meeting is created
+ */
+export interface TeamsChannelMeetingEntityIds extends TeamsEntityId {
+    parentMessageId: string;
+}
+/**
+ * Id of the host entity
+ */
+export type HostEntityIds = TeamsEntityId | TeamsChannelMeetingEntityIds;
+/**
+ * @hidden
+ * @internal
+ * @beta
+ * Limited to Microsoft-internal use
+ *
+ * Checks if the hostEntity capability is supported by the host
+ * @returns boolean to represent whether the hostEntity capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ */
+export declare function isSupported(): boolean;
+export { tab };

package/dist/esm/packages/teams-js/dts/private/hostEntity/tab.d.ts

@@ -0,0 +1,134 @@
+/**
+ * @hidden
+ * @internal
+ * @beta
+ * @module
+ * Limited to Microsoft-internal use
+ *
+ * CRUD operations for tabs associated with apps
+ */
+import { TabInstance } from '../../public/interfaces';
+import { AppTypes, HostEntityIds } from './hostEntity';
+/**
+ * Represents information about a static tab instance
+ */
+export interface StaticTabInstance extends TabInstance {
+    tabType: 'StaticTab';
+}
+/**
+ * Represents information about a configurable tab instance
+ */
+export interface ConfigurableTabInstance extends TabInstance {
+    tabType: 'ConfigurableTab';
+}
+/**
+ * Represents information about a tab instance associated with a host entity like chat, channel or meeting. Cab be a configurable tab or static tab.
+ */
+export type HostEntityTabInstance = StaticTabInstance | ConfigurableTabInstance;
+/**
+ * Represents all tabs associated with a host entity like chat, channel or meeting
+ */
+export interface HostEntityTabInstances {
+    allTabs: HostEntityTabInstance[];
+}
+/**
+ * @hidden
+ * @internal
+ * @beta
+ * Limited to Microsoft-internal use
+ *
+ * Launches host-owned UI that lets a user select an app, installs it if required,
+ * runs through app configuration if required, and then associates the app with the threadId provided
+ *
+ * @param hostEntityIds Ids of the host entity like channel, chat or meeting
+ *
+ * @param appTypes What type of applications to show the user. If EDU is passed as appType, only apps supported by EDU tenant are shown.
+ * If no value is passed, all apps are shown.
+ *
+ * @returns The HostEntityTabInstance of the newly associated app
+ *
+ * @throws Error if host does not support this capability, library as not been initialized successfully, input parameters are invalid, user cancels operation or installing
+ * or configuring or adding tab fails
+ */
+export declare function addAndConfigure(hostEntityIds: HostEntityIds, appTypes?: AppTypes[]): Promise<HostEntityTabInstance>;
+/**
+ * @hidden
+ * @internal
+ * @beta
+ * Limited to Microsoft-internal use
+ *
+ * Returns all tab instances associated with a host entity
+ *
+ * @param hostEntityIds Ids of the host entity like channel, chat or meeting
+ *
+ * @returns Object with array of HostEntityTabInstance's associated with a host entity
+ *
+ * @throws Error if host does not support this capability, library as not been initialized successfully, input parameters are invalid or fetching tabs fails
+ */
+export declare function getAll(hostEntityIds: HostEntityIds): Promise<HostEntityTabInstances>;
+/**
+ * @hidden
+ * @internal
+ * @beta
+ * Limited to Microsoft-internal use
+ *
+ * Launches host-owned UI that lets a user re-configure the contentUrl of the tab
+ *
+ * @param tab Configurable tab instance that needs to be updated
+ *
+ * @param hostEntityIds Ids of the host entity like channel, chat or meeting
+ *
+ * @returns The HostEntityTabInstance of the updated tab
+ *
+ * @throws Error if host does not support this capability, library as not been initialized successfully, input parameters are invalid, user cancels operation,
+ * re-configuring tab fails or if tab is a static tab
+ */
+export declare function reconfigure(tab: ConfigurableTabInstance, hostEntityIds: HostEntityIds): Promise<ConfigurableTabInstance>;
+/**
+ * @hidden
+ * @internal
+ * @beta
+ * Limited to Microsoft-internal use
+ *
+ * Launches host-owned UI that lets a user rename the tab
+ *
+ * @param tab Configurable tab instance that needs to be updated
+ *
+ * @param hostEntityIds Ids of the host entity like channel, chat or meeting
+ *
+ * @returns The HostEntityTabInstance of the updated tab
+ *
+ * @throws Error if host does not support this capability, library as not been initialized successfully, input parameters are invalid, user cancels operation,
+ * re-naming tab fails or if tab is a static tab
+ */
+export declare function rename(tab: ConfigurableTabInstance, hostEntityIds: HostEntityIds): Promise<ConfigurableTabInstance>;
+/**
+ * @hidden
+ * @internal
+ * @beta
+ * Limited to Microsoft-internal use
+ *
+ * Launches host-owned UI that lets a user remove the tab
+ *
+ * @param tab tab instance that needs to be updated. Can be static tab or configurable tab.
+ *
+ * @param hostEntityIds Ids of the host entity like channel, chat or meeting
+ *
+ * @returns Boolean. Returns true if removing tab was successful
+ *
+ * @throws Error if host does not support this capability, library as not been initialized successfully, input parameters are invalid, user cancels operation or
+ * removing tab fails
+ */
+export declare function remove(tab: HostEntityTabInstance, hostEntityIds: HostEntityIds): Promise<boolean>;
+/**
+ * @hidden
+ * @internal
+ * @beta
+ * Limited to Microsoft-internal use
+ *
+ * Checks if the hostEntity.tab capability is supported by the host
+ * @returns boolean to represent whether the histEntity and hostEntity.tab capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ */
+export declare function isSupported(): boolean;

package/dist/esm/packages/teams-js/dts/private/index.d.ts

@@ -1,20 +1,21 @@
-export { logs } from './logs';
+export * as logs from './logs';
 export { ChatMembersInformation, FilePreviewParameters, NotificationTypes, ShowNotificationParameters, TeamInstanceParameters, ThreadMember, UserJoinedTeamsInformation, ViewerActionTypes, UserSettingTypes, } from './interfaces';
 export { sendCustomMessage, sendCustomEvent, registerCustomHandler, uploadCustomApp, registerUserSettingsChangeHandler, openFilePreview, } from './privateAPIs';
-export { conversations, OpenConversationRequest } from './conversations';
-export { copilot } from './copilot';
-export { externalAppAuthentication } from './externalAppAuthentication';
-export { externalAppAuthenticationForCEA } from './externalAppAuthenticationForCEA';
-export { externalAppCardActions } from './externalAppCardActions';
-export { externalAppCardActionsForCEA } from './externalAppCardActionsForCEA';
-export { externalAppCommands } from './externalAppCommands';
-export { files } from './files';
-export { meetingRoom } from './meetingRoom';
-export { messageChannels } from './messageChannels';
-export { notifications } from './notifications';
-export { otherAppStateChange } from './otherAppStateChange';
-export { remoteCamera } from './remoteCamera';
-export { appEntity } from './appEntity';
-export { teams } from './teams';
-export { videoEffectsEx } from './videoEffectsEx';
-export { hostEntity } from './hostEntity';
+export * as conversations from './conversations';
+export { OpenConversationRequest } from './conversations';
+export * as copilot from './copilot/copilot';
+export * as externalAppAuthentication from './externalAppAuthentication';
+export * as externalAppAuthenticationForCEA from './externalAppAuthenticationForCEA';
+export * as externalAppCardActions from './externalAppCardActions';
+export * as externalAppCardActionsForCEA from './externalAppCardActionsForCEA';
+export * as externalAppCommands from './externalAppCommands';
+export * as files from './files';
+export * as meetingRoom from './meetingRoom';
+export * as messageChannels from './messageChannels/messageChannels';
+export * as notifications from './notifications';
+export * as otherAppStateChange from './otherAppStateChange';
+export * as remoteCamera from './remoteCamera';
+export * as appEntity from './appEntity';
+export * as teams from './teams/teams';
+export * as videoEffectsEx from './videoEffectsEx';
+export * as hostEntity from './hostEntity/hostEntity';

package/dist/esm/packages/teams-js/dts/private/logs.d.ts

@@ -1,25 +1,31 @@
-export declare namespace logs {
-    /**
-     * @hidden
-     *
-     * Registers a handler for getting app log
-     *
-     * @param handler - The handler to invoke to get the app log
-     *
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    function registerGetLogHandler(handler: () => string): void;
-    /**
-     * @hidden
-     *
-     * Checks if the logs capability is supported by the host
-     * @returns boolean to represent whether the logs capability is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     *
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    function isSupported(): boolean;
-}
+/**
+ * @hidden
+ * Module to interact with the logging part of the SDK.
+ * This object is used to send the app logs on demand to the host client
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+/**
+ * @hidden
+ *
+ * Registers a handler for getting app log
+ *
+ * @param handler - The handler to invoke to get the app log
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function registerGetLogHandler(handler: () => string): void;
+/**
+ * @hidden
+ *
+ * Checks if the logs capability is supported by the host
+ * @returns boolean to represent whether the logs capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function isSupported(): boolean;

package/dist/esm/packages/teams-js/dts/private/meetingRoom.d.ts

@@ -1,203 +1,208 @@
-export declare namespace meetingRoom {
+/**
+ * @hidden
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ * @module
+ */
+/**
+ * @hidden
+ *
+ * Data structure to represent a meeting room.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface MeetingRoomInfo {
     /**
      * @hidden
-     *
-     * Data structure to represent a meeting room.
+     * Endpoint id of the meeting room.
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    export interface MeetingRoomInfo {
-        /**
-         * @hidden
-         * Endpoint id of the meeting room.
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        endpointId: string;
-        /**
-         * @hidden
-         * Device name of the meeting room.
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        deviceName: string;
-        /**
-         * @hidden
-         * Client type of the meeting room.
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        clientType: string;
-        /**
-         * @hidden
-         * Client version of the meeting room.
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        clientVersion: string;
-    }
+    endpointId: string;
     /**
      * @hidden
-     * Type of Media control capabilities of a meeting room.
+     * Device name of the meeting room.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
      */
-    type MediaControls = 'toggleMute' | 'toggleCamera' | 'toggleCaptions' | 'volume';
+    deviceName: string;
     /**
      * @hidden
-     * Types of Stage Layout control capabilities of a meeting room.
+     * Client type of the meeting room.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
      */
-    type StageLayoutControls = 'showVideoGallery' | 'showContent' | 'showVideoGalleryAndContent' | 'showLargeGallery' | 'showTogether';
+    clientType: string;
     /**
      * @hidden
-     * Types of Meeting Control capabilities of a meeting room.
+     * Client version of the meeting room.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
      */
-    type MeetingControls = 'leaveMeeting';
+    clientVersion: string;
+}
+/**
+ * @hidden
+ * Type of Media control capabilities of a meeting room.
+ */
+type MediaControls = 'toggleMute' | 'toggleCamera' | 'toggleCaptions' | 'volume';
+/**
+ * @hidden
+ * Types of Stage Layout control capabilities of a meeting room.
+ */
+type StageLayoutControls = 'showVideoGallery' | 'showContent' | 'showVideoGalleryAndContent' | 'showLargeGallery' | 'showTogether';
+/**
+ * @hidden
+ * Types of Meeting Control capabilities of a meeting room.
+ */
+type MeetingControls = 'leaveMeeting';
+/**
+ * @hidden
+ * Types of Stage Layout State of a meeting room.
+ */
+type StageLayoutStates = 'Gallery' | 'Content + gallery' | 'Content' | 'Large gallery' | 'Together mode';
+/**
+ * @hidden
+ * Data structure to represent capabilities of a meeting room.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface MeetingRoomCapability {
     /**
      * @hidden
-     * Types of Stage Layout State of a meeting room.
+     * Media control capabilities, value can be "toggleMute", "toggleCamera", "toggleCaptions", "volume".
+     *
+     * @internal
+     * Limited to Microsoft-internal use
      */
-    type StageLayoutStates = 'Gallery' | 'Content + gallery' | 'Content' | 'Large gallery' | 'Together mode';
+    mediaControls: MediaControls[];
     /**
      * @hidden
-     * Data structure to represent capabilities of a meeting room.
+     * Main stage layout control capabilities, value can be "showVideoGallery", "showContent", "showVideoGalleryAndContent", "showLargeGallery", "showTogether".
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    export interface MeetingRoomCapability {
-        /**
-         * @hidden
-         * Media control capabilities, value can be "toggleMute", "toggleCamera", "toggleCaptions", "volume".
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        mediaControls: MediaControls[];
-        /**
-         * @hidden
-         * Main stage layout control capabilities, value can be "showVideoGallery", "showContent", "showVideoGalleryAndContent", "showLargeGallery", "showTogether".
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        stageLayoutControls: StageLayoutControls[];
-        /**
-         * @hidden
-         * Meeting control capabilities, value can be "leaveMeeting".
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        meetingControls: MeetingControls[];
-    }
+    stageLayoutControls: StageLayoutControls[];
     /**
      * @hidden
-     * Data structure to represent states of a meeting room.
+     * Meeting control capabilities, value can be "leaveMeeting".
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    export interface MeetingRoomState {
-        /**
-         * @hidden
-         * Current mute state, true: mute, false: unmute.
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        toggleMute: boolean;
-        /**
-         * @hidden
-         * Current camera state, true: camera on, false: camera off.
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        toggleCamera: boolean;
-        /**
-         * @hidden
-         * Current captions state, true: captions on, false: captions off.
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        toggleCaptions: boolean;
-        /**
-         * @hidden
-         * Current main stage layout state, value can be one of "Gallery", "Content + gallery", "Content", "Large gallery" and "Together mode".
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        stageLayout: StageLayoutStates;
-        /**
-         * @hidden
-         * Current leaveMeeting state, true: leave, false: no-op.
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        leaveMeeting: boolean;
-    }
+    meetingControls: MeetingControls[];
+}
+/**
+ * @hidden
+ * Data structure to represent states of a meeting room.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface MeetingRoomState {
     /**
      * @hidden
-     * Fetch the meeting room info that paired with current client.
-     *
-     * @returns Promise resolved with meeting room info or rejected with SdkError value
+     * Current mute state, true: mute, false: unmute.
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    export function getPairedMeetingRoomInfo(): Promise<MeetingRoomInfo>;
+    toggleMute: boolean;
     /**
      * @hidden
-     * Send a command to paired meeting room.
-     *
-     * @param commandName The command name.
-     * @returns Promise resolved upon completion or rejected with SdkError value
+     * Current camera state, true: camera on, false: camera off.
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    export function sendCommandToPairedMeetingRoom(commandName: string): Promise<void>;
+    toggleCamera: boolean;
     /**
      * @hidden
-     * Registers a handler for meeting room capabilities update.
-     * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
-     *
-     * @param handler The handler to invoke when the capabilities of meeting room update.
+     * Current captions state, true: captions on, false: captions off.
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    export function registerMeetingRoomCapabilitiesUpdateHandler(handler: (capabilities: MeetingRoomCapability) => void): void;
+    toggleCaptions: boolean;
     /**
      * @hidden
-     * Hide from docs
-     * Registers a handler for meeting room states update.
-     * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
-     *
-     * @param handler The handler to invoke when the states of meeting room update.
+     * Current main stage layout state, value can be one of "Gallery", "Content + gallery", "Content", "Large gallery" and "Together mode".
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    export function registerMeetingRoomStatesUpdateHandler(handler: (states: MeetingRoomState) => void): void;
+    stageLayout: StageLayoutStates;
     /**
      * @hidden
-     *
-     * Checks if the meetingRoom capability is supported by the host
-     * @returns boolean to represent whether the meetingRoom capability is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
+     * Current leaveMeeting state, true: leave, false: no-op.
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    export function isSupported(): boolean;
-    export {};
+    leaveMeeting: boolean;
 }
+/**
+ * @hidden
+ * Fetch the meeting room info that paired with current client.
+ *
+ * @returns Promise resolved with meeting room info or rejected with SdkError value
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function getPairedMeetingRoomInfo(): Promise<MeetingRoomInfo>;
+/**
+ * @hidden
+ * Send a command to paired meeting room.
+ *
+ * @param commandName The command name.
+ * @returns Promise resolved upon completion or rejected with SdkError value
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function sendCommandToPairedMeetingRoom(commandName: string): Promise<void>;
+/**
+ * @hidden
+ * Registers a handler for meeting room capabilities update.
+ * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+ *
+ * @param handler The handler to invoke when the capabilities of meeting room update.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function registerMeetingRoomCapabilitiesUpdateHandler(handler: (capabilities: MeetingRoomCapability) => void): void;
+/**
+ * @hidden
+ * Hide from docs
+ * Registers a handler for meeting room states update.
+ * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+ *
+ * @param handler The handler to invoke when the states of meeting room update.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function registerMeetingRoomStatesUpdateHandler(handler: (states: MeetingRoomState) => void): void;
+/**
+ * @hidden
+ *
+ * Checks if the meetingRoom capability is supported by the host
+ * @returns boolean to represent whether the meetingRoom capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function isSupported(): boolean;
+export {};

package/dist/esm/packages/teams-js/dts/private/messageChannels/dataLayer.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @hidden
+ * @beta
+ *
+ * Fetches a MessagePort to allow access to the host's data layer worker.
+ * The port is cached once received, so subsequent calls return the same port.
+ * @returns MessagePort.
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed,
+ * if the host does not support the feature, or if the port request is rejected.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function getDataLayerPort(): Promise<MessagePort>;
+/**
+ * @hidden
+ *
+ * @beta
+ *
+ * Checks if the messageChannels.dataLayer capability is supported by the host
+ * @returns boolean to represent whether the messageChannels.dataLayer capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function isSupported(): boolean;
+/**
+ * @hidden
+ * Undocumented function used to clear state between unit tests
+ *
+ * @beta
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function _clearDataLayerPort(): void;