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

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

@@ -0,0 +1,54 @@
+/**
+ * This class is used to monitor the performance of video processing, and report performance events.
+ */
+export declare class VideoPerformanceMonitor {
+    private reportPerformanceEvent;
+    private static readonly distributionBinSize;
+    private static readonly calculateFPSInterval;
+    private isFirstFrameProcessed;
+    private applyingEffect?;
+    private appliedEffect?;
+    private frameProcessTimeLimit;
+    private gettingTextureStreamStartedAt;
+    private currentStreamId;
+    private frameProcessingStartedAt;
+    private frameProcessingTimeCost;
+    private processedFrameCount;
+    private performanceStatistics;
+    constructor(reportPerformanceEvent: (apiVersionTag: string, actionName: string, args: unknown[]) => void);
+    /**
+     * Start to check frame processing time intervally
+     * and report performance event if the average frame processing time is too long.
+     */
+    startMonitorSlowFrameProcessing(): void;
+    /**
+     * Define the time limit of frame processing.
+     * When the average frame processing time is longer than the time limit, a "video.performance.frameProcessingSlow" event will be reported.
+     * @param timeLimit
+     */
+    setFrameProcessTimeLimit(timeLimit: number): void;
+    /**
+     * Call this function when the app starts to switch to the new video effect
+     */
+    reportApplyingVideoEffect(effectId: string, effectParam?: string): void;
+    /**
+     * Call this function when the new video effect is ready
+     */
+    reportVideoEffectChanged(effectId: string, effectParam?: string): void;
+    /**
+     * Call this function when the app starts to process a video frame
+     */
+    reportStartFrameProcessing(frameWidth: number, frameHeight: number): void;
+    /**
+     * Call this function when the app finishes successfully processing a video frame
+     */
+    reportFrameProcessed(): void;
+    /**
+     * Call this function when the app starts to get the texture stream
+     */
+    reportGettingTextureStream(streamId: string): void;
+    /**
+     * Call this function when the app finishes successfully getting the texture stream
+     */
+    reportTextureStreamAcquired(): void;
+}

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

@@ -0,0 +1,49 @@
+export type VideoPerformanceStatisticsResult = {
+    effectId: string;
+    effectParam?: string;
+    frameWidth: number;
+    frameHeight: number;
+    /**
+     * The duration in milliseconds that the data were collected
+     */
+    duration: number;
+    /**
+     * The number of frames that were processed in the duration
+     */
+    sampleCount: number;
+    /**
+     * An array that presents counts of frames that were finished in n milliseconds:
+     * distributionBins[frameProcessingDurationInMs]=frameCount.
+     * For example, distributionBins[10] = 5 means that 5 frames were processed in 10 milliseconds.
+     */
+    distributionBins: Uint32Array;
+};
+export declare class VideoPerformanceStatistics {
+    /**
+     * Function to report the statistics result
+     */
+    private reportStatisticsResult;
+    private static readonly initialSessionTimeoutInMs;
+    private static readonly maxSessionTimeoutInMs;
+    private currentSession;
+    private frameProcessingStartedAt;
+    private distributionBins;
+    private sampleCount;
+    private timeoutId;
+    constructor(distributionBinSize: number, 
+    /**
+     * Function to report the statistics result
+     */
+    reportStatisticsResult: (result: VideoPerformanceStatisticsResult) => void);
+    /**
+     * Call this function before processing every frame
+     */
+    processStarts(effectId: string, frameWidth: number, frameHeight: number, effectParam?: string): void;
+    processEnds(): void;
+    private getStatistics;
+    private start;
+    private suitableForThisSession;
+    private reportAndResetSession;
+    private resetCurrentSession;
+    private getNextTimeout;
+}

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

@@ -0,0 +1,89 @@
+import { SdkError } from '../public/interfaces';
+/**
+ * @hidden
+ * Namespace to interact with the application entities specific part of the SDK.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare namespace appEntity {
+    /**
+     * @hidden
+     *
+     * Information on an app entity
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    interface AppEntity {
+        /**
+         * @hidden
+         * ID of the application
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        appId: string;
+        /**
+         * @hidden
+         * URL for the application's icon
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        appIconUrl: string;
+        /**
+         * @hidden
+         * Content URL for the app entity
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        contentUrl: string;
+        /**
+         * @hidden
+         * The display name for the app entity
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        displayName: string;
+        /**
+         * @hidden
+         * Website URL for the app entity. It is meant to be opened by the user in a browser.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        websiteUrl: string;
+    }
+    /**
+     * @hidden
+     * 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 application categories that will be displayed in the opened tab gallery
+     * @param subEntityId An object that will be made available to the application being configured
+     *                      through the Context's subEntityId field.
+     * @param callback Callback that will be triggered once the app entity information is available.
+     *                 The callback takes two arguments: an SdkError in case something happened (i.e.
+     *                 no permissions to execute the API) and the app entity configuration, if available
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function selectAppEntity(threadId: string, categories: string[], subEntityId: string, callback: (sdkError?: SdkError, appEntity?: AppEntity) => void): void;
+    /**
+     * @hidden
+     *
+     * Checks if the appEntity capability is supported by the host
+     * @returns boolean to represent whether the appEntity 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/constants.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @hidden
+ * Error codes that can be thrown from externalAppCommands and externalAppCardCommands Action Submit specifically
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare enum ExternalAppErrorCode {
+    INTERNAL_ERROR = "INTERNAL_ERROR"
+}

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

@@ -0,0 +1,152 @@
+import { ChatMembersInformation } from './interfaces';
+export interface OpenConversationRequest {
+    /**
+     * @hidden
+     * The Id of the subEntity where the conversation is taking place
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    subEntityId: string;
+    /**
+     * @hidden
+     * The title of the conversation
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    title: string;
+    /**
+     * @hidden
+     * The Id of the conversation. This is optional and should be specified whenever a previous conversation about a specific sub-entity has already been started before
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    conversationId?: string;
+    /**
+     * @hidden
+     * The Id of the channel. This is optional and should be specified whenever a conversation is started or opened in a personal app scope
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    channelId?: string;
+    /**
+     * @hidden
+     * The entity Id of the tab
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    entityId: string;
+    /**
+     * @hidden
+     * A function that is called once the conversation Id has been created
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    onStartConversation?: (conversationResponse: ConversationResponse) => void;
+    /**
+     * @hidden
+     * A function that is called if the pane is closed
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    onCloseConversation?: (conversationResponse: ConversationResponse) => void;
+}
+/**
+ * @hidden
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface ConversationResponse {
+    /**
+     * @hidden
+     *
+     * Limited to Microsoft-internal use
+     * The Id of the subEntity where the conversation is taking place
+     */
+    subEntityId: string;
+    /**
+     * @hidden
+     * The Id of the conversation. This is optional and should be specified whenever a previous conversation about a specific sub-entity has already been started before
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    conversationId?: string;
+    /**
+     * @hidden
+     * The Id of the channel. This is optional and should be specified whenever a conversation is started or opened in a personal app scope
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    channelId?: string;
+    /**
+     * @hidden
+     * The entity Id of the tab
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    entityId?: string;
+}
+/**
+ * @hidden
+ * Namespace to interact with the conversational subEntities inside the tab
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare namespace conversations {
+    /**
+     * @hidden
+     * Hide from docs
+     * --------------
+     * Allows the user to start or continue a conversation with each subentity inside the tab
+     *
+     * @returns Promise resolved upon completion
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function openConversation(openConversationRequest: OpenConversationRequest): Promise<void>;
+    /**
+     * @hidden
+     *
+     * Allows the user to close the conversation in the right pane
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function closeConversation(): void;
+    /**
+     * @hidden
+     * Hide from docs
+     * ------
+     * Allows retrieval of information for all chat members.
+     * NOTE: This value should be used only as a hint as to who the members are
+     * and never as proof of membership in case your app is being hosted by a malicious party.
+     *
+     * @returns Promise resolved with information on all chat members
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function getChatMembers(): Promise<ChatMembersInformation>;
+    /**
+     * Checks if the conversations capability is supported by the host
+     * @returns boolean to represent whether conversations 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/copilot.d.ts

@@ -0,0 +1,39 @@
+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>;
+    }
+}