@jevelin/bridge 2.53.0

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

@@ -0,0 +1,187 @@
+/**
+ * Module to interact with the menu-specific part of the SDK.
+ * This object is used to show View Configuration, Action Menu and Navigation Bar Menu.
+ * @module
+ */
+/**
+ * @hidden
+ * Represents information about item in View Configuration.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface ViewConfiguration {
+    /**
+     * @hidden
+     * Unique identifier of view.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    id: string;
+    /**
+     * @hidden
+     * Display title of the view.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    title: string;
+    /**
+     * @hidden
+     * Additional information for accessibility.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    contentDescription?: string;
+}
+/**
+ * Defines how a menu item should appear in the NavBar.
+ */
+export declare enum DisplayMode {
+    /**
+     * Only place this item in the NavBar if there's room for it.
+     * If there's no room, item is shown in the overflow menu.
+     */
+    ifRoom = 0,
+    /**
+     * Never place this item in the NavBar.
+     * The item would always be shown in NavBar's overflow menu.
+     */
+    overflowOnly = 1
+}
+/**
+ * @hidden
+ * Represents information about menu item for Action Menu and Navigation Bar Menu.
+ */
+export declare class MenuItem {
+    /**
+     * @hidden
+     * Unique identifier for the menu item.
+     */
+    id: string;
+    /**
+     * @hidden
+     * Display title of the menu item.
+     */
+    title: string;
+    /**
+     * @hidden
+     * Display icon of the menu item. The icon value must be a string having SVG icon content.
+     */
+    icon: string;
+    /**
+     * @hidden
+     * Selected state display icon of the menu item. The icon value must be a string having SVG icon content.
+     */
+    iconSelected?: string;
+    /**
+     * @hidden
+     * Additional information for accessibility.
+     */
+    contentDescription?: string;
+    /**
+     * @hidden
+     * State of the menu item
+     */
+    enabled: boolean;
+    /**
+     * @hidden
+     * Interface to show list of items on selection of menu item.
+     */
+    viewData?: ViewData;
+    /**
+     * @hidden
+     * Whether the menu item is selected or not
+     */
+    selected: boolean;
+    /**
+     * The Display Mode of the menu item.
+     * Default Behaviour would be DisplayMode.ifRoom if null.
+     * Refer {@link DisplayMode}
+     */
+    displayMode?: DisplayMode;
+}
+/**
+ * @hidden
+ * Represents information about view to show on Navigation Bar Menu item selection
+ */
+export interface ViewData {
+    /**
+     * @hidden
+     * Display header title of the item list.
+     */
+    listTitle?: string;
+    /**
+     * @hidden
+     * Type of the menu item.
+     */
+    listType: MenuListType;
+    /**
+     * @hidden
+     * Array of MenuItem. Icon value will be required for all items in the list.
+     */
+    listItems: MenuItem[];
+}
+/**
+ * @hidden
+ * Represents information about type of list to display in Navigation Bar Menu.
+ */
+export declare enum MenuListType {
+    dropDown = "dropDown",
+    popOver = "popOver"
+}
+/**
+ * @hidden
+ * Register navBarMenuItemPress, actionMenuItemPress, setModuleView handlers.
+ *
+ * @internal
+ * Limited to Microsoft-internal use.
+ */
+export declare function initialize(): void;
+/**
+ * @hidden
+ * Registers list of view configurations and it's handler.
+ * Handler is responsible for listening selection of View Configuration.
+ *
+ * @param viewConfig - List of view configurations. Minimum 1 value is required.
+ * @param handler - The handler to invoke when the user selects view configuration.
+ */
+export declare function setUpViews(viewConfig: ViewConfiguration[], handler: (id: string) => boolean): void;
+/**
+ * @hidden
+ * Used to set menu items on the Navigation Bar. If icon is available, icon will be shown, otherwise title will be shown.
+ *
+ * @param items List of MenuItems for Navigation Bar Menu.
+ * @param handler The handler to invoke when the user selects menu item.
+ */
+export declare function setNavBarMenu(items: MenuItem[], handler: (id: string) => boolean): void;
+/** Parameters used to create an action menu within an app */
+export interface ActionMenuParameters {
+    /**
+     * @hidden
+     * Display title for Action Menu
+     */
+    title: string;
+    /**
+     * @hidden
+     * List of MenuItems for Action Menu
+     */
+    items: MenuItem[];
+}
+/**
+ * @hidden
+ * Used to show Action Menu.
+ *
+ * @param params - Parameters for Menu Parameters
+ * @param handler - The handler to invoke when the user selects menu item.
+ */
+export declare function showActionMenu(params: ActionMenuParameters, handler: (id: string) => boolean): void;
+/**
+ * Checks if the menus capability is supported by the host
+ * @returns boolean to represent whether the menus 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/public/monetization.d.ts

@@ -0,0 +1,64 @@
+/**
+ * @hidden
+ * Hidden from Docs
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ * @module
+ */
+import { SdkError } from './interfaces';
+/**
+ * @hidden
+ * Data structure to represent a subscription plan.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface PlanInfo {
+    /**
+     * @hidden
+     * plan id
+     */
+    planId: string;
+    /**
+     * @hidden
+     * term of the plan
+     */
+    term: string;
+}
+/**
+ * @hidden
+ * Open dialog to start user's purchase experience
+ *
+ * @param planInfo optional parameter. It contains info of the subscription plan pushed to users.
+ * error can either contain an error of type SdkError, incase of an error, or null when get is successful
+ * @returns Promise that will be resolved when the operation has completed or rejected with SdkError value
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function openPurchaseExperience(planInfo?: PlanInfo): Promise<void>;
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, please use {@link monetization.openPurchaseExperience monetization.openPurchaseExperience(planInfo?: PlanInfo): Promise\<void\>} instead.
+ *
+ * @hidden
+ * Open dialog to start user's purchase experience
+ *
+ * @param callback Callback contains 1 parameters, error.
+ * @param planInfo optional parameter. It contains info of the subscription plan pushed to users.
+ * error can either contain an error of type SdkError, incase of an error, or null when get is successful
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function openPurchaseExperience(callback: (error: SdkError | null) => void, planInfo?: PlanInfo): void;
+/**
+ * @hidden
+ *
+ * Checks if the monetization capability is supported by the host
+ * @returns boolean to represent whether the monetization 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/public/navigation.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Navigation specific part of the SDK.
+ * @module
+ */
+import { TabInstance } from './interfaces';
+/** Navigation on complete handler function type */
+export type onCompleteHandlerFunctionType = (status: boolean, reason?: string) => void;
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, please use {@link pages.returnFocus pages.returnFocus(navigateForward?: boolean): void} instead.
+ *
+ * Return focus to the main Teams app. Will focus search bar if navigating foward and app bar if navigating back.
+ *
+ * @param navigateForward - Determines the direction to focus in teams app.
+ */
+export declare function returnFocus(navigateForward?: boolean): void;
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, please use {@link pages.tabs.navigateToTab pages.tabs.navigateToTab(tabInstance: TabInstance): Promise\<void\>} instead.
+ *
+ * Navigates the Microsoft Teams app to the specified tab instance.
+ *
+ * @param tabInstance - The tab instance to navigate to.
+ * @param onComplete - The callback to invoke when the action is complete.
+ */
+export declare function navigateToTab(tabInstance: TabInstance, onComplete?: onCompleteHandlerFunctionType): void;
+/**
+ * @deprecated
+ * As of 2.0.0, this API is deprecated and can be replaced by the standard JavaScript
+ * API, window.location.href, when navigating the app to a new cross-domain URL. Any URL
+ * that is redirected to must be listed in the validDomains block of the manifest. Please
+ * remove any calls to this API.
+ * @param url - The URL to navigate the frame to.
+ * @param onComplete - The callback to invoke when the action is complete.
+ */
+export declare function navigateCrossDomain(url: string, onComplete?: onCompleteHandlerFunctionType): void;
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, please use {@link pages.backStack.navigateBack pages.backStack.navigateBack(): Promise\<void\>} instead.
+ *
+ * Navigates back in the Teams client.
+ * See registerBackButtonHandler for more information on when it's appropriate to use this method.
+ *
+ * @param onComplete - The callback to invoke when the action is complete.
+ */
+export declare function navigateBack(onComplete?: onCompleteHandlerFunctionType): void;

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

@@ -0,0 +1,64 @@
+/**
+ * Checks if MSAL-NAA channel recommended by the host
+ * @returns true if host is recommending NAA channel and false otherwise
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ */
+export declare function isNAAChannelRecommended(): boolean;
+/**
+ * Gets the origin of the parent window if available.
+ * This will be the top-level origin in the case of a parent app.
+ * It is used to pass to the embedded child app to initialize the Nested App Auth bridge.
+
+ * @returns The origin string if available, otherwise null
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @beta
+ */
+export declare function getParentOrigin(): string | null;
+/**
+ * Checks if the parent has the capability to manage its list of trusted child origins
+ * for Nested App Auth (NAA).
+ *
+ * @returns true if parent can manage NAA TrustedOrigins, false otherwise
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @beta
+ */
+export declare function canParentManageNAATrustedOrigins(): boolean;
+/**
+ * Checks if NAA deeply nested scenario supported by the host
+ * @returns true if host supports
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @beta
+ */
+export declare function isDeeplyNestedAuthSupported(): boolean;
+/**
+ * Registers the origins of child apps as trusted for Nested App Auth (NAA).
+ *
+ * This allows a top-level parent app to specify which child app origins are considered trusted
+ *
+ * @param appOrigins - An array of child app origins to trust (must be a non-empty array).
+ * @returns A Promise resolving with the result of the action.
+ * @throws Error if called from a non-top-level parent or if parameters are invalid.
+ *
+ * @beta
+ */
+export declare function addNAATrustedOrigins(appOrigins: string[]): Promise<string>;
+/**
+ * Removes previously trusted child app origins from Nested App Auth (NAA).
+ *
+ * The specified origins will no longer be considered trusted.
+ *
+ * @param appOrigins - An array of child app origins to remove from the trusted list (must be a non-empty array).
+ * @returns A Promise resolving with the result of the action.
+ * @throws Error if called from a non-top-level parent or if parameters are invalid.
+ *
+ * @beta
+ */
+export declare function deleteNAATrustedOrigins(appOrigins: string[]): Promise<string>;

package/dist/esm/packages/teams-js/dts/public/offlineStorage/drafts.d.ts

@@ -0,0 +1,104 @@
+/**
+ * Module for managing client-owned draft records in offline storage.
+ * Drafts are records created locally that have not yet been submitted for synchronization.
+ *
+ * @beta
+ * @module
+ */
+import { OfflineRecord, PaginatedResult, QueryOptions } from './offlineStorage';
+/**
+ * Result returned when a new draft record is created.
+ * @beta
+ */
+export interface DraftCreateResult {
+    /** The generated unique identifier for the created draft record. */
+    id: string;
+}
+/**
+ * Creates a new draft record in offline storage
+ *
+ * @param schemaId - The schema identifier for this record
+ * @param data - The record data conforming to the schema definition
+ * @returns A promise that resolves to an object containing the generated record id
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ * @throws Error if the offlineStorage capability is not supported
+ *
+ * @beta
+ */
+export declare function create(schemaId: string, data: Record<string, unknown>): Promise<DraftCreateResult>;
+/**
+ * Updates an existing draft record
+ *
+ * @param schemaId - The schema identifier for this record
+ * @param id - The unique identifier of the draft to update
+ * @param data - Partial record data to merge into the existing draft
+ * @returns A promise that resolves when the update is complete
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ * @throws Error if the offlineStorage capability is not supported
+ *
+ * @beta
+ */
+export declare function update(schemaId: string, id: string, data: Partial<Record<string, unknown>>): Promise<void>;
+/**
+ * Retrieves a single draft record by its identifier
+ *
+ * @param schemaId - The schema identifier for this record
+ * @param id - The unique identifier of the draft to retrieve
+ * @returns A promise that resolves to the draft record
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ * @throws Error if the offlineStorage capability is not supported
+ *
+ * @beta
+ */
+export declare function get(schemaId: string, id: string): Promise<OfflineRecord>;
+/**
+ * Queries draft records with optional filtering and pagination
+ *
+ * @param schemaId - The schema identifier to query
+ * @param options - Optional query parameters including filters, sorting, and pagination
+ * @returns A promise that resolves to a paginated result set
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ * @throws Error if the offlineStorage capability is not supported
+ *
+ * @beta
+ */
+export declare function query(schemaId: string, options?: QueryOptions): Promise<PaginatedResult>;
+/**
+ * Deletes a draft record from offline storage
+ *
+ * @param schemaId - The schema identifier for this record
+ * @param id - The unique identifier of the draft to delete
+ * @returns A promise that resolves when the deletion is complete
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ * @throws Error if the offlineStorage capability is not supported
+ *
+ * @beta
+ */
+export declare function remove(schemaId: string, id: string): Promise<void>;
+/**
+ * Submits a draft record for synchronization, moving it to the outbox
+ *
+ * @param schemaId - The schema identifier for this record
+ * @param id - The unique identifier of the draft to submit
+ * @returns A promise that resolves when the record has been moved to the outbox
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ * @throws Error if the offlineStorage capability is not supported
+ *
+ * @beta
+ */
+export declare function submit(schemaId: string, id: string): Promise<void>;
+/**
+ * Checks if the offlineStorage.drafts capability is supported by the host
+ * @returns boolean to represent whether the offlineStorage.drafts capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @beta
+ */
+export declare function isSupported(): boolean;

package/dist/esm/packages/teams-js/dts/public/offlineStorage/inbox.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Module for managing server-owned inbox records in offline storage.
+ * Inbox records are received from the server and are read-only on the client.
+ *
+ * @beta
+ * @module
+ */
+import { OfflineRecord, PaginatedResult, QueryOptions } from './offlineStorage';
+/**
+ * Handler invoked when new records arrive in the inbox from the server
+ *
+ * @beta
+ */
+export type InboxUpdateHandler = (schemaId: string, records: OfflineRecord[]) => void;
+/**
+ * Retrieves a single inbox record by its identifier
+ *
+ * @param schemaId - The schema identifier for this record
+ * @param id - The unique identifier of the inbox record to retrieve
+ * @returns A promise that resolves to the inbox record
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ * @throws Error if the offlineStorage capability is not supported
+ *
+ * @beta
+ */
+export declare function get(schemaId: string, id: string): Promise<OfflineRecord>;
+/**
+ * Queries inbox records with optional filtering and pagination
+ *
+ * @param schemaId - The schema identifier to query
+ * @param options - Optional query parameters including filters, sorting, and pagination
+ * @returns A promise that resolves to a paginated result set
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ * @throws Error if the offlineStorage capability is not supported
+ *
+ * @beta
+ */
+export declare function query(schemaId: string, options?: QueryOptions): Promise<PaginatedResult>;
+/**
+ * Returns the count of inbox records for a given schema, optionally filtered
+ *
+ * @param schemaId - The schema identifier to count records for
+ * @param options - Optional query filters
+ * @returns A promise that resolves to the number of matching inbox records
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ * @throws Error if the offlineStorage capability is not supported
+ *
+ * @beta
+ */
+export declare function getCount(schemaId: string, options?: QueryOptions): Promise<number>;
+/**
+ * Marks one or more inbox records as read
+ *
+ * @param schemaId - The schema identifier for the records
+ * @param ids - Array of record identifiers to mark as read
+ * @returns A promise that resolves when the operation is complete
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ * @throws Error if the offlineStorage capability is not supported
+ *
+ * @beta
+ */
+export declare function markAsRead(schemaId: string, ids: string[]): Promise<void>;
+/**
+ * Registers a handler to be called when new records arrive in the inbox
+ *
+ * @param handler - The handler function to invoke when inbox updates arrive
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ * @throws Error if the offlineStorage capability is not supported
+ *
+ * @beta
+ */
+export declare function registerOnUpdateHandler(handler: InboxUpdateHandler): void;
+/**
+ * Checks if the offlineStorage.inbox capability is supported by the host
+ * @returns boolean to represent whether the offlineStorage.inbox capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @beta
+ */
+export declare function isSupported(): boolean;