@microsoft/teams-js 2.31.0-beta.0 → 2.31.0-beta.2

package/package.json

@@ -1 +1 @@
-{"name":"@microsoft/teams-js","author":"Microsoft Teams","version":"2.31.0-beta.0","description":"Microsoft Client SDK for building app for Microsoft hosts","repository":{"directory":"packages/teams-js","type":"git","url":"https://github.com/OfficeDev/microsoft-teams-library-js"},"main":"./dist/umd/MicrosoftTeams.min.js","typings":"./dist/umd/MicrosoftTeams.d.ts","module":"./dist/esm/packages/teams-js/src/index.js","type":"module","scripts":{"build":"pnpm clean && pnpm lint && pnpm build-rollup && pnpm build-webpack && pnpm docs:validate","build-rollup":"pnpm clean && rollup -c","build-webpack":"webpack","clean":"rimraf ./dist","docs":"pnpm typedoc","docs:validate":"pnpm typedoc --emit none","lint":"pnpm eslint ./src ./test --max-warnings 0 --fix --ext .ts","prettier":"prettier --write '**/*.{ts,js,css,html}'","test":"jest","test:verbose":"pnpm test -- --verbose false --silent false"},"dependencies":{"base64-js":"^1.3.1","debug":"^4.3.3"},"devDependencies":{"@types/debug":"^4.1.7"},"sideEffects":["src/internal/communication.ts","src/internal/nestedAppAuthUtils.ts","src/internal/utils.ts","src/internal/videoEffectsUtils.ts","src/private/constants.ts","src/private/interfaces.ts","src/public/constants.ts","src/public/handlers.ts","src/public/interfaces.ts"],"license":"MIT","files":["dist/**","LICENSE","README.md"]}
+{"name":"@microsoft/teams-js","author":"Microsoft Teams","version":"2.31.0-beta.2","description":"Microsoft Client SDK for building app for Microsoft hosts","repository":{"directory":"packages/teams-js","type":"git","url":"https://github.com/OfficeDev/microsoft-teams-library-js"},"main":"./dist/umd/MicrosoftTeams.min.js","typings":"./dist/umd/MicrosoftTeams.d.ts","module":"./dist/esm/packages/teams-js/src/index.js","scripts":{"build":"pnpm clean && pnpm lint && pnpm build-rollup && pnpm build-webpack && pnpm docs:validate","build-rollup":"pnpm clean && rollup -c","build-webpack":"webpack","clean":"rimraf ./dist","docs":"pnpm typedoc","docs:validate":"pnpm typedoc --emit none","lint":"pnpm eslint ./src ./test --max-warnings 0 --fix --ext .ts","prettier":"prettier --write '**/*.{ts,js,css,html}'","test":"jest","test:verbose":"pnpm test -- --verbose false --silent false"},"dependencies":{"base64-js":"^1.3.1","debug":"^4.3.3"},"devDependencies":{"@types/debug":"^4.1.7"},"sideEffects":["src/internal/communication.ts","src/internal/nestedAppAuthUtils.ts","src/internal/utils.ts","src/internal/videoEffectsUtils.ts","src/private/constants.ts","src/private/interfaces.ts","src/public/constants.ts","src/public/handlers.ts","src/public/interfaces.ts"],"license":"MIT","files":["dist/**","LICENSE","README.md"]}

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

@@ -1,39 +0,0 @@
-import { AppEligibilityInformation } from '../public/interfaces';
-/**
- * @beta
- * @hidden
- * Namespace to delegate copilot app specific APIs
- * @internal
- * Limited to Microsoft-internal use
- */
-export declare namespace copilot {
-    /**
-     * @beta
-     * @hidden
-     * User information required by specific apps
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    namespace eligibility {
-        /**
-         * @hidden
-         * @internal
-         * Limited to Microsoft-internal use
-         * @beta
-         * @returns boolean to represent whether copilot.eligibility capability is supported
-         *
-         * @throws Error if {@linkcode app.initialize} has not successfully completed
-         */
-        function isSupported(): boolean;
-        /**
-         * @hidden
-         * @internal
-         * Limited to Microsoft-internal use
-         * @beta
-         * @returns the copilot eligibility information about the user
-         *
-         * @throws Error if {@linkcode app.initialize} has not successfully completed
-         */
-        function getEligibilityInfo(): Promise<AppEligibilityInformation>;
-    }
-}

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

@@ -1,176 +0,0 @@
-import { TabInstance } from '../public/interfaces';
-/**
- * @hidden
- * @internal
- * @beta
- * 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.
- */
-export declare namespace hostEntity {
-    export 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
-     *
-     * CRUD operations for tabs associated with apps
-     */
-    export namespace tab {
-        /**
-         * Represents information about a static tab instance
-         */
-        interface StaticTabInstance extends TabInstance {
-            tabType: 'StaticTab';
-        }
-        /**
-         * Represents information about a configurable tab instance
-         */
-        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.
-         */
-        type HostEntityTabInstance = StaticTabInstance | ConfigurableTabInstance;
-        /**
-         * Represents all tabs associated with a host entity like chat, channel or meeting
-         */
-        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
-         */
-        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
-         */
-        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
-         */
-        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
-         */
-        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
-         */
-        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
-         */
-        function isSupported(): boolean;
-    }
-    /**
-     * @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 function isSupported(): boolean;
-    export {};
-}

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

@@ -1,107 +0,0 @@
-/**
- * @hidden
- * Namespace to request message ports from the host application.
- *
- * @beta
- *
- * @internal
- * Limited to Microsoft-internal use
- */
-export declare namespace messageChannels {
-    namespace telemetry {
-        /**
-         * @hidden
-         * @beta
-         *
-         * Fetches a MessagePort to batch telemetry through the host's telemetry 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
-         */
-        function getTelemetryPort(): Promise<MessagePort>;
-        /**
-         * @hidden
-         *
-         * @beta
-         *
-         * Checks if the messageChannels.telemetry capability is supported by the host
-         * @returns boolean to represent whether the messageChannels.telemetry capability is supported
-         *
-         * @throws Error if {@linkcode app.initialize} has not successfully completed
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        function isSupported(): boolean;
-        /**
-         * @hidden
-         * Undocumented function used to clear state between unit tests
-         *
-         * @beta
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        function _clearTelemetryPort(): void;
-    }
-    namespace dataLayer {
-        /**
-         * @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
-         */
-        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
-         */
-        function isSupported(): boolean;
-        /**
-         * @hidden
-         * Undocumented function used to clear state between unit tests
-         *
-         * @beta
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        function _clearDataLayerPort(): void;
-    }
-    /**
-     * @hidden
-     *
-     * @beta
-     *
-     * Checks if the messageChannels capability is supported by the host
-     * @returns boolean to represent whether the messageChannels capability is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     *
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    function isSupported(): boolean;
-}

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

@@ -1,116 +0,0 @@
-import { SdkError } from '../public/interfaces';
-import { TeamInstanceParameters, UserJoinedTeamsInformation } from './interfaces';
-export declare namespace teams {
-    enum ChannelType {
-        Regular = 0,
-        Private = 1,
-        Shared = 2
-    }
-    /**
-     * @hidden
-     *
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    interface ChannelInfo {
-        siteUrl: string;
-        objectId: string;
-        folderRelativeUrl: string;
-        displayName: string;
-        channelType: ChannelType;
-    }
-    /**
-     * @hidden
-     * Get a list of channels belong to a Team
-     *
-     * @param groupId - a team's objectId
-     *
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    function getTeamChannels(groupId: string, callback: (error: SdkError, channels: ChannelInfo[]) => void): void;
-    /**
-     * @hidden
-     * Allow 1st party apps to call this function when they receive migrated errors to inform the Hub/Host to refresh the siteurl
-     * when site admin renames siteurl.
-     *
-     * @param threadId - ID of the thread where the app entity will be created; if threadId is not
-     * provided, the threadId from route params will be used.
-     *
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    function refreshSiteUrl(threadId: string, callback: (error: SdkError) => void): void;
-    /**
-     * @hidden
-     *
-     * Checks if teams capability is supported by the host
-     * @returns boolean to represent whether the teams capability is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     *
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    function isSupported(): boolean;
-    /**
-     * @hidden
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    namespace fullTrust {
-        /**
-         * @hidden
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        namespace joinedTeams {
-            /**
-             * @hidden
-             * Allows an app to retrieve information of all user joined teams
-             *
-             * @param teamInstanceParameters - Optional flags that specify whether to scope call to favorite teams
-             * @returns Promise that resolves with information about the user joined teams or rejects with an error when the operation has completed
-             *
-             * @internal
-             * Limited to Microsoft-internal use
-             */
-            function getUserJoinedTeams(teamInstanceParameters?: TeamInstanceParameters): Promise<UserJoinedTeamsInformation>;
-            /**
-             * @hidden
-             *
-             * Checks if teams.fullTrust.joinedTeams capability is supported by the host
-             * @returns boolean to represent whether the teams.fullTrust.joinedTeams capability is supported
-             *
-             * @throws Error if {@linkcode app.initialize} has not successfully completed
-             *
-             * @internal
-             * Limited to Microsoft-internal use
-             */
-            function isSupported(): boolean;
-        }
-        /**
-         * @hidden
-         * Allows an app to get the configuration setting value
-         *
-         * @param key - The key for the config setting
-         * @returns Promise that resolves with the value for the provided configuration setting or rejects with an error when the operation has completed
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        function getConfigSetting(key: string): Promise<string>;
-        /**
-         * @hidden
-         *
-         * Checks if teams.fullTrust capability is supported by the host
-         * @returns boolean to represent whether the teams.fullTrust capability is supported
-         *
-         * @throws Error if {@linkcode app.initialize} has not successfully completed
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        function isSupported(): boolean;
-    }
-}