@jevelin/bridge 2.53.0

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

@@ -0,0 +1,208 @@
+/**
+ * @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
+     * 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;
+}
+/**
+ * @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
+     * 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[];
+}
+/**
+ * @hidden
+ * Data structure to represent states of a meeting room.
+ *
+ * @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;
+}
+/**
+ * @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;

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

@@ -0,0 +1,28 @@
+/**
+ * @hidden
+ * Module to request message ports from the host application.
+ *
+ * @beta
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @module
+ */
+import * as dataLayer from './dataLayer';
+import * as telemetry from './telemetry';
+/**
+ * @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
+ */
+export declare function isSupported(): boolean;
+export { dataLayer, telemetry };

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

@@ -0,0 +1,39 @@
+/**
+ * @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
+ */
+export declare 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
+ */
+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 _clearTelemetryPort(): void;

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

@@ -0,0 +1,32 @@
+/**
+ * @beta
+ * @hidden
+ * Local version of the Nested App Auth Bridge module.
+ *
+ * This version is specific to this standalone module and is not tied to the overall TeamsJS SDK version.
+ * It allows developers to track changes within this module and handle version-based compatibility if needed.
+ *
+ * While not strictly required today, having a version provides flexibility for future updates,
+ * especially if breaking changes are introduced later.
+ *
+ * Example:
+ *   if (nestedAppAuthBridge.version.startsWith('1.')) {
+ *     // Safe to use with current logic
+ *   }
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare const version = "1.0.1";
+/**
+ * @beta
+ * @hidden
+ * Initializes the Nested App Auth Bridge.
+ * @param window The window object where the bridge will be attached.
+ * @param topOrigin The origin of the top-level frame.
+ * @param enableLogging - Optional flag to enable internal debug and error logging. Defaults to false.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function initialize(window: Window | null, topOrigin: string, enableLogging?: boolean): void;

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

@@ -0,0 +1,32 @@
+/**
+ * @hidden
+ * Hidden from Docs
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ * @module
+ */
+import { ShowNotificationParameters } from './interfaces';
+/**
+ * @hidden
+ * display notification API.
+ *
+ * @param message - Notification message.
+ * @param notificationType - Notification type
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function showNotification(showNotificationParameters: ShowNotificationParameters): void;
+/**
+ * @hidden
+ *
+ * Checks if the notifications capability is supported by the host
+ * @returns boolean to represent whether the notifications 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/otherAppStateChange.d.ts

@@ -0,0 +1,94 @@
+/**
+ * @module
+ * @hidden
+ * @internal
+ * @beta
+ * Limited to Microsoft-internal use
+ *
+ * This capability contains the APIs for handling events that happen to other applications on the host
+ * *while* the developer's application is running. For example, if the developer wants to be notified
+ * when another application has been installed.
+ */
+import { AppId } from '../public/appId';
+/**
+ * @hidden
+ * @beta
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * Represent an event that has happened with other number of applications installed on this host.
+ * (e.g. a new app has been installed)
+ */
+export interface OtherAppStateChangeEvent {
+    /** An array of app ids that this event applies to */
+    appIds: string[];
+}
+/**
+ * @hidden
+ * @beta
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * A function handler that will be called whenever an event happens with some number of applications installed on this host.
+ */
+export type OtherAppStateChangeEventHandler = (event: OtherAppStateChangeEvent) => void;
+/**
+ * @hidden
+ * @beta
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * This function allows an app to register a handler that will receive whenever other applications are installed
+ * on the host while the developer's application is running.
+ *
+ * @param appInstallHandler - This handler will be called whenever apps are installed on the host.
+ *
+ * @throws Error if {@link app.initialize} has not successfully completed, if the platform
+ * does not support the otherAppStateChange capability, or if a valid handler is not passed to the function.
+ *
+ * @example
+ * ``` ts
+ * if (otherAppStateChange.isSupported()) {
+ *  otherAppStateChange.registerAppInstallationHandler((event: otherAppStateChange.OtherAppStateChangeEvent) => {
+ *    // code to handle the event goes here
+ *  });
+ * }
+ * ```
+ */
+export declare function registerAppInstallationHandler(appInstallHandler: OtherAppStateChangeEventHandler): void;
+/**
+ * @hidden
+ * @beta
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * This function can be called so that the handler passed to {@link registerAppInstallationHandler}
+ * will no longer receive app installation events. If this is called before registering a handler
+ * it will have no effect.
+ *
+ * @throws Error if {@link app.initialize} has not successfully completed or if the platform
+ * does not support the otherAppStateChange capability.
+ */
+export declare function unregisterAppInstallationHandler(): void;
+/**
+ * @hidden
+ * @beta
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * This function should be called by the Store App to notify the host that the
+ * app with the given appId has been installed.
+ *
+ * @throws Error if {@link app.initialize} has not successfully completed or if the platform
+ * does not support the otherAppStateChange capability.
+ */
+export declare function notifyInstallCompleted(appId: AppId): Promise<void>;
+/**
+ * Checks if the otherAppStateChange capability is supported by the host
+ * @returns boolean to represent whether the otherAppStateChange capability is supported
+ *
+ * @throws Error if {@link app.initialize} has not successfully completed
+ *
+ * @beta
+ */
+export declare function isSupported(): boolean;

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

@@ -0,0 +1,94 @@
+import { SimpleType } from '../internal/responseHandler';
+/**
+ * The type of arguments that can be passed in a {@link PluginMessage}.
+ *
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ * @beta
+ */
+export type PluginMessageArg = SimpleType;
+/**
+ * Indicates whether the plugin capability is available in the current host.
+ *
+ * @remarks
+ * This API validates SDK initialization and then checks runtime capability flags
+ * for `supports.plugins`.
+ *
+ * @returns `true` if the host reports plugin support; otherwise `false`.
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed.
+ *
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ * @beta
+ */
+export declare function isSupported(): boolean;
+/**
+ * Canonical message envelope used for plugin send/receive operations.
+ *
+ * @remarks
+ * Messages are used to communicate between plugin and host.
+ *
+ * @property func - Function/event name for the message.
+ * @property args - Optional JSON payload.
+ * @property correlationId - Optional ID for request/response correlation.
+ *
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ * @beta
+ */
+export type PluginMessage = {
+    func: string;
+    args?: PluginMessageArg;
+    correlationId?: string;
+};
+/**
+ * Sends a plugin message to the host.
+ *
+ * @remarks
+ * The message payload is serialized before transmission to the host.
+ * All payload data must be JSON-safe (see {@link JsonValue}).
+ *
+ * @returns A promise that resolves when the host acknowledges the message.
+ *
+ * @throws Error if SDK initialization has not completed, if the host returns
+ * an error response, or if `func` is missing.
+ *
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ * @beta
+ */
+export declare function sendPluginMessage(message: PluginMessage): Promise<void>;
+/**
+ * Handler signature for incoming plugin messages.
+ *
+ * @param message - Normalized plugin message envelope.
+ *
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ * @beta
+ */
+export type ReceiveMessageHandler = (message: PluginMessage) => void;
+/**
+ * Registers a handler to receive plugin messages from the host.
+ *
+ * @remarks
+ * This API registers the callback under the `plugin.receiveMessage` handler name.
+ * When the host dispatches a plugin message, the supplied handler is invoked with
+ * the received JSON payload.
+ *
+ * @param handler - Callback invoked for each incoming plugin message payload.
+ *
+ * @throws Error if plugin messaging is not supported by the current host.
+ *
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ * @beta
+ */
+export declare function registerPluginMessage(handler: ReceiveMessageHandler): void;

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

@@ -0,0 +1,94 @@
+import { FilePreviewParameters, UserSettingTypes } from './interfaces';
+export declare function uploadCustomApp(manifestBlob: Blob, onComplete?: (status: boolean, reason?: string) => void): void;
+/**
+ * @deprecated Use {@link plugins.sendPluginMessage} with {@link plugins.registerPluginMessage} and a correlationId-based response pattern.
+ *
+ * @hidden
+ * Sends a custom action MessageRequest to host or parent window
+ *
+ * @param actionName - Specifies name of the custom action to be sent
+ * @param args - Specifies additional arguments passed to the action
+ * @param callback - Optionally specify a callback to receive response parameters from the parent
+ * @returns id of sent message
+ *
+ * @remarks
+ * Prefer the plugin event model for new development. In that model, send a request message
+ * with a unique `correlationId` and listen for a response event with the same `correlationId`.
+ *
+ * Example:
+ * ```ts
+ * // Request side
+ * const correlationId = crypto.randomUUID();
+ *
+ * plugins.registerPluginMessage((message) => {
+ *   if (message.func !== 'example.customAction.response') {
+ *     return;
+ *   }
+ *   if (message.correlationId !== correlationId) {
+ *     return;
+ *   }
+ *
+ *   // This is the response for the request above.
+ *   const response = message.args;
+ *   console.log('Received response', response);
+ * });
+ *
+ * await plugins.sendPluginMessage({
+ *   func: 'example.customAction.request',
+ *   args: { itemId: '12345' },
+ *   correlationId,
+ * });
+ *
+ * // Host side contract example (conceptual):
+ * // On receiving example.customAction.request, send back
+ * // example.customAction.response with the same correlationId.
+ * ```
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function sendCustomMessage(actionName: string, args?: any[], callback?: (...args: any[]) => void): void;
+/**
+ * @hidden
+ * Sends a custom action MessageEvent to a child iframe/window.
+ *
+ * @param actionName - Specifies name of the custom action to be sent
+ * @param args - Specifies additional arguments passed to the action
+ * @returns id of sent message
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function sendCustomEvent(actionName: string, args?: any[]): void;
+/**
+ * @hidden
+ * Adds a handler for an action sent by a child window or parent window
+ *
+ * @param actionName - Specifies name of the action message to handle
+ * @param customHandler - The callback to invoke when the action message is received. The return value is sent to the child
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function registerCustomHandler(actionName: string, customHandler: (...args: any[]) => any[]): void;
+/**
+ * @hidden
+ * register a handler to be called when a user setting changes. The changed setting type & value is provided in the callback.
+ *
+ * @param settingTypes - List of user setting changes to subscribe
+ * @param handler - When a subscribed setting is updated this handler is called
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function registerUserSettingsChangeHandler(settingTypes: UserSettingTypes[], handler: (settingType: UserSettingTypes, value: any) => void): void;
+/**
+ * @hidden
+ * Opens a client-friendly preview of the specified file.
+ *
+ * @param file - The file to preview.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function openFilePreview(filePreviewParameters: FilePreviewParameters): void;