@microsoft/teams-js 2.54.0-beta.0 → 2.55.0

package/README.md

@@ -24,7 +24,7 @@ To install the stable [version](https://learn.microsoft.com/javascript/api/overv
 
 ### Production
 
-You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.54.0/js/MicrosoftTeams.min.js) or point your package manager at them.
+You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.55.0/js/MicrosoftTeams.min.js) or point your package manager at them.
 
 ## Usage
 
@@ -45,13 +45,13 @@ Reference the library inside of your `.html` page using:
 ```html
 <!-- Microsoft Teams JavaScript API (via CDN) -->
 <script
-  src="https://res.cdn.office.net/teams-js/2.54.0/js/MicrosoftTeams.min.js"
-  integrity="sha384-PIuQ2V7hlz4b1x3G1mPCYYZiWTjxzRTL6bf547xR9ARsAeNv2DAzti86LQnFCwlo"
+  src="https://res.cdn.office.net/teams-js/2.55.0/js/MicrosoftTeams.min.js"
+  integrity="sha384-qOOENVJGWr7UF7wvgyycjvq3sZen4SEYQwZMKqpquvV/PNMtSJb3VGZ/sAIKsZDw"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.54.0/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.55.0/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

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

@@ -8,6 +8,12 @@
  * @module
  */
 import { ChatMembersInformation } from './interfaces';
+/**
+ * @hidden
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 export interface OpenConversationRequest {
     /**
      * @hidden
@@ -141,6 +147,7 @@ export declare function closeConversation(): void;
  */
 export declare function getChatMembers(): Promise<ChatMembersInformation>;
 /**
+ * @hidden
  * Checks if the conversations capability is supported by the host
  * @returns boolean to represent whether conversations capability is supported
  *

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

@@ -51,7 +51,12 @@ export declare function getContent(request?: ContentRequest): Promise<Content>;
  * Limited to Microsoft-internal use
  */
 export declare function preCheckUserConsent(request?: UserConsentRequest): Promise<PreCheckContextResponse>;
-/** Register user action content select handler function type */
+/**
+ * @hidden
+ * Register user action content select handler function type
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 export type userActionHandlerType = (selectedContent: Content) => void;
 /**
  * @hidden

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

@@ -60,6 +60,12 @@ export interface DraftEmailContent extends BaseEmailContent {
     savedTime?: Date;
     composeType?: 'new' | 'reply' | 'replyAll' | 'forward';
 }
+/**
+ * @hidden
+ * Union type for usage elsewhere
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 export type EmailContent = ServerEmailContent | DraftEmailContent;
 /**
  * @hidden

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

@@ -275,6 +275,12 @@ export type AttachmentLayout = 'grid' | 'list';
 export type ComposeResultTypes = 'auth' | 'config' | 'message' | 'result' | 'silentAuth';
 /*********** END RESPONSE TYPE ************/
 /*********** BEGIN ERROR TYPE ***********/
+/**
+ * @hidden
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 export interface InvokeError {
     errorCode: InvokeErrorCode;
     message?: string;
@@ -394,6 +400,12 @@ export interface ConnectorParameters {
     /** Optional parameters for the OAuth sign-in window. */
     windowParameters?: OauthWindowProperties;
 }
+/**
+ * @hidden
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 export declare class SerializableConnectorParameters implements ISerializable {
     private param;
     constructor(param: ConnectorParameters);

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

@@ -8,6 +8,11 @@
  * 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';
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 export declare enum AppTypes {
     edu = "EDU",
     /**
@@ -26,13 +31,19 @@ interface TeamsEntityId {
     threadId: string;
 }
 /**
+ * @hidden
  * Id of message in which channel meeting is created
+ * @internal
+ * Limited to Microsoft-internal use
  */
 export interface TeamsChannelMeetingEntityIds extends TeamsEntityId {
     parentMessageId: string;
 }
 /**
+ * @hidden
  * Id of the host entity
+ * @internal
+ * Limited to Microsoft-internal use
  */
 export type HostEntityIds = TeamsEntityId | TeamsChannelMeetingEntityIds;
 /**

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

@@ -10,23 +10,35 @@
 import { TabInstance } from '../../public/interfaces';
 import { AppTypes, HostEntityIds } from './hostEntity';
 /**
+ * @hidden
  * Represents information about a static tab instance
+ * @internal
+ * Limited to Microsoft-internal use
  */
 export interface StaticTabInstance extends TabInstance {
     tabType: 'StaticTab';
 }
 /**
+ * @hidden
  * Represents information about a configurable tab instance
+ * @internal
+ * Limited to Microsoft-internal use
  */
 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.
+ * @hidden
+ * Represents information about a tab instance associated with a host entity like chat, channel or meeting. Can be a configurable tab or static tab.
+ * @internal
+ * Limited to Microsoft-internal use
  */
 export type HostEntityTabInstance = StaticTabInstance | ConfigurableTabInstance;
 /**
+ * @hidden
  * Represents all tabs associated with a host entity like chat, channel or meeting
+ * @internal
+ * Limited to Microsoft-internal use
  */
 export interface HostEntityTabInstances {
     allTabs: HostEntityTabInstance[];

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

@@ -84,6 +84,7 @@ export declare function unregisterAppInstallationHandler(): void;
  */
 export declare function notifyInstallCompleted(appId: AppId): Promise<void>;
 /**
+ * @hidden
  * Checks if the otherAppStateChange capability is supported by the host
  * @returns boolean to represent whether the otherAppStateChange capability is supported
  *

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

@@ -1,4 +1,12 @@
 import { FilePreviewParameters, UserSettingTypes } from './interfaces';
+/**
+ * @hidden
+ * Upload a custom App manifest directly to both team and personal scopes.
+ * This method works just for the first party Apps.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 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.

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

@@ -120,6 +120,7 @@ export declare function openInContextStore(params: OpenInContextStoreParams | un
  */
 export declare function openSpecificStore(params: OpenSpecificStoreParams): Promise<void>;
 /**
+ * @hidden
  * Checks if the store capability is supported by the host
  * @returns boolean to represent whether the store capability is supported
  *

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

@@ -8,6 +8,11 @@
  */
 import { SdkError } from '../../public/interfaces';
 import * as fullTrust from './fullTrust/fullTrust';
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 export declare enum ChannelType {
     Regular = 0,
     Private = 1,

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

@@ -8,6 +8,11 @@
  */
 import { DefaultVideoEffectCallBack as VideoEffectCallBack } from '../internal/videoEffectsUtils';
 import * as videoEffects from '../public/videoEffects';
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 export declare const frameProcessingTimeoutInMs = 2000;
 /**
  * @hidden

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

@@ -1,20 +1,56 @@
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ * @module
+ */
 import { RenderingSurfaces } from '../../public';
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 export interface ISecurityPolicy {
     connectDomains?: string[];
     resourceDomains?: string[];
     isTrusted?: boolean;
 }
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 export type Theme = 'light' | 'dark';
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 export type SafeAreaInsets = {
     top: number;
     bottom: number;
     left: number;
     right: number;
 };
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 export type SafeArea = {
     insets: SafeAreaInsets;
 };
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 export type DeviceType = 'mobile' | 'tablet' | 'desktop' | 'unknown';
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 export type UserAgent = {
     device: {
         type: DeviceType;
@@ -25,7 +61,10 @@ export type UserAgent = {
     };
 };
 /**
+ * @hidden
  * Options for requesting a modal dialog
+ * @internal
+ * Limited to Microsoft-internal use
  */
 export interface IModalOptions {
     /** Unique identifier for the modal */
@@ -40,23 +79,49 @@ export interface IModalOptions {
     height?: number;
 }
 /**
+ * @hidden
  * Response from requesting a modal dialog
+ * @internal
+ * Limited to Microsoft-internal use
  */
 export interface IModalResponse {
     /** A DOM element representing the modal's root */
     modalElement: HTMLElement;
 }
-/** Declare generic JSON - serializable structure */
+/**
+ * @hidden
+ * Declare generic JSON - serializable structure
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 export interface JSONObject {
     [key: string]: JSONValue;
 }
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 export interface JSONArray extends Array<JSONValue> {
 }
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 export type JSONValue = string | number | boolean | null | JSONObject | JSONArray;
-/** Display mode */
+/**
+ * @hidden
+ * Display mode
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 export type DisplayMode = 'pip' | 'inline' | 'fullscreen';
 /**
+ * @hidden
  * MCP-compatible tool input structure following OpenAI MCP server specification
+ * @internal
+ * Limited to Microsoft-internal use
  */
 export interface IToolInput {
     /** The name of the tool to call */
@@ -65,7 +130,10 @@ export interface IToolInput {
     arguments?: Record<string, unknown>;
 }
 /**
+ * @hidden
  * MCP-compatible tool output structure matching exact MCP schema
+ * @internal
+ * Limited to Microsoft-internal use
  */
 export interface IToolOutput {
     /** Whether the tool call resulted in an error */
@@ -96,7 +164,10 @@ export interface IToolOutput {
     _meta?: Record<string, unknown>;
 }
 /**
+ * @hidden
  * Widget context similar to IWidgetHost structure - simplified for widget rendering
+ * @internal
+ * Limited to Microsoft-internal use
  */
 export interface IWidgetContext {
     /** Unique identifier for the widget instance */

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

@@ -17,6 +17,12 @@ import { DisplayMode, IModalOptions, IModalResponse, IToolInput, IToolOutput, JS
  * @throws Error if {@linkcode app.initialize} has not successfully completed
  */
 export declare function isSupported(): boolean;
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ * @beta
+ */
 export declare function callTool(widgetId: string, input: IToolInput): Promise<IToolOutput>;
 /**
  * @beta
@@ -86,7 +92,12 @@ export declare function setWidgetState(widgetId: string, state: JSONValue): Prom
 export declare function openExternal(widgetId: string, payload: {
     href: string;
 }): void;
-/** Modal close handler function type */
+/**
+ * @hidden
+ * Modal close handler function type
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 export type ModalCloseHandlerType = (modalId: string) => void;
 /**
  * @hidden

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

@@ -538,6 +538,26 @@ export declare function getFrameContext(): FrameContexts | undefined;
  * @returns Promise that will be fulfilled when initialization has completed, or rejected if the initialization fails or times out
  */
 export declare function initialize(validMessageOrigins?: string[]): Promise<void>;
+/**
+ * Returns the immediate parent origin when this app is running inside an iframe.
+ *
+ * @remarks
+ * This helper is useful for scenarios where the app must explicitly trust the hosting parent origin during
+ * {@link initialize} by passing `[origin]` as `validMessageOrigins`.
+ *
+ * If no parent origin can be determined, this function returns `null`.
+ *
+ * @example
+ * ```typescript
+ * import { app } from '@microsoft/teams-js';
+ *
+ * const parentOrigin = app.getImmediateParentOrigin();
+ * await app.initialize(parentOrigin ? [parentOrigin] : undefined);
+ * ```
+ *
+ * @returns The immediate parent origin, or `null` when unavailable.
+ */
+export declare function getImmediateParentOrigin(): string | null;
 /**
  * @hidden
  * Undocumented function used to set a mock window for unit tests

package/dist/esm/packages/teams-js/src/public/app/app.js

@@ -1 +1 @@
-import{appInitializeHelper as e,notifyAppLoadedHelper as i,notifySuccessHelper as t,notifyFailureHelper as n,notifyExpectedFailureHelper as a,registerOnThemeChangeHandlerHelper as o,registerOnContextChangeHandlerHelper as s,openLinkHelper as r}from"../../internal/appHelpers.js";import{uninitializeCommunication as l,sendAndUnwrap as m,Communication as d}from"../../internal/communication.js";import{GlobalVars as p}from"../../internal/globalVars.js";import{uninitializeHandlers as c,registerHostToAppPerformanceMetricsHandler as u}from"../../internal/handlers.js";import{ensureInitializeCalled as f}from"../../internal/internalAPIs.js";import{getLogger as h,getApiVersionTag as g}from"../../internal/telemetry.js";import{inServerSideRenderingEnvironment as I}from"../../internal/utils.js";import{AppId as y}from"../appId.js";import{HostClientType as S,HostName as T}from"../constants.js";import{version as C}from"../version.js";import*as v from"./lifecycle.js";export{v as lifecycle};import{_clearTelemetryPort as P}from"../../private/messageChannels/telemetry.js";import{_clearDataLayerPort as j}from"../../private/messageChannels/dataLayer.js";const w="v2",O=h("app"),N={AppLoaded:"appInitialization.appLoaded",Success:"appInitialization.success",Failure:"appInitialization.failure",ExpectedFailure:"appInitialization.expectedFailure"};var F,b;function x(){return p.initializeCompleted}function A(){return p.frameContext}function L(i){return e(g(w,"app.initialize"),i)}function z(e){d.currentWindow=e}function D(){p.initializeCalled&&(c(),p.initializeCalled=!1,p.initializeCompleted=!1,p.initializePromise=void 0,p.additionalValidOrigins=[],p.frameContext=void 0,p.hostClientType=void 0,p.isFramelessWindow=!1,P(),j(),l())}function k(){return new Promise(e=>{f(),e(m(g(w,"app.getContext"),"getContext"))}).then(e=>function(e){var i;const t={actionInfo:e.actionInfo,app:{locale:e.locale,sessionId:e.appSessionId?e.appSessionId:"",theme:e.theme?e.theme:"default",iconPositionVertical:e.appIconPosition,osLocaleInfo:e.osLocaleInfo,messageId:e.messageId,parentMessageId:e.parentMessageId,userClickTime:e.userClickTime,userClickTimeV2:e.userClickTimeV2,userFileOpenPreference:e.userFileOpenPreference,host:{name:e.hostName?e.hostName:T.teams,clientType:e.hostClientType?e.hostClientType:S.web,features:e.hostFeatures,sessionId:e.sessionId?e.sessionId:"",ringId:e.ringId,ancestors:e.hostAncestors},appLaunchId:e.appLaunchId,appId:e.appId?new y(e.appId):void 0,manifestVersion:e.manifestVersion},page:{id:e.entityId,frameContext:e.frameContext?e.frameContext:p.frameContext,renderingSurface:e.renderingSurface?e.renderingSurface:void 0,subPageId:e.subEntityId,isFullScreen:e.isFullScreen,isMultiWindow:e.isMultiWindow,isBackgroundLoad:e.isBackgroundLoad,sourceOrigin:e.sourceOrigin},user:{id:null!==(i=e.userObjectId)&&void 0!==i?i:"",displayName:e.userDisplayName,isCallingAllowed:e.isCallingAllowed,isPSTNCallingAllowed:e.isPSTNCallingAllowed,licenseType:e.userLicenseType,loginHint:e.loginHint,userPrincipalName:e.userPrincipalName,tenant:e.tid?{id:e.tid,teamsSku:e.tenantSKU}:void 0},channel:e.channelId?{id:e.channelId,displayName:e.channelName,relativeUrl:e.channelRelativeUrl,membershipType:e.channelType,defaultOneNoteSectionId:e.defaultOneNoteSectionId,ownerGroupId:e.hostTeamGroupId,ownerTenantId:e.hostTeamTenantId}:void 0,chat:e.chatId?{id:e.chatId}:void 0,meeting:e.meetingId?{id:e.meetingId}:void 0,sharepoint:e.sharepoint,team:e.teamId?{internalId:e.teamId,displayName:e.teamName,type:e.teamType,groupId:e.groupId,templateId:e.teamTemplateId,isArchived:e.isTeamArchived,userRole:e.userTeamRole}:void 0,sharePointSite:e.teamSiteUrl||e.teamSiteDomain||e.teamSitePath||e.mySitePath||e.mySiteDomain?{teamSiteUrl:e.teamSiteUrl,teamSiteDomain:e.teamSiteDomain,teamSitePath:e.teamSitePath,teamSiteId:e.teamSiteId,mySitePath:e.mySitePath,mySiteDomain:e.mySiteDomain}:void 0,dialogParameters:e.dialogParameters||{}};return t}(e))}function H(){f(),i(g(w,"app.notifyAppLoaded"))}function U(){return t(g(w,"app.notifySuccess"))}function V(e){f(),n(g(w,"app.notifyFailure"),e)}function E(e){f(),a(g(w,"app.notifyExpectedFailure"),e)}function M(e){o(g(w,"app.registerOnThemeChangeHandler"),e)}function W(e){s(g(w,"app.registerOnContextChangeHandler"),e)}function B(e){u(e)}function R(e){return r(g(w,"app.openLink"),e)}!function(e){e.AuthFailed="AuthFailed",e.Timeout="Timeout",e.Other="Other"}(F||(F={})),function(e){e.PermissionError="PermissionError",e.NotFound="NotFound",e.Throttling="Throttling",e.Offline="Offline",e.Other="Other"}(b||(b={})),O("teamsjs instance is version %s, starting at %s UTC (%s local)",C,(new Date).toISOString(),(new Date).toLocaleString()),function(){if(I())return;const e=document.getElementsByTagName("script"),i=e&&e[e.length-1]&&e[e.length-1].src,t="Today, teamsjs can only be used from a single script or you may see undefined behavior. This log line is used to help detect cases where teamsjs is loaded multiple times -- it is always written. The presence of the log itself does not indicate a multi-load situation, but multiples of these log lines will. If you would like to use teamjs from more than one script at the same time, please open an issue at https://github.com/OfficeDev/microsoft-teams-library-js/issues";i&&0!==i.length?O("teamsjs is being used from %s. %s",i,t):O("teamsjs is being used from a script tag embedded directly in your html. %s",t)}();export{b as ExpectedFailureReason,F as FailedReason,N as Messages,z as _initialize,D as _uninitialize,k as getContext,A as getFrameContext,L as initialize,x as isInitialized,H as notifyAppLoaded,E as notifyExpectedFailure,V as notifyFailure,U as notifySuccess,R as openLink,B as registerHostToAppPerformanceMetricsHandler,W as registerOnContextChangeHandler,M as registerOnThemeChangeHandler};
+import{appInitializeHelper as e,notifyAppLoadedHelper as i,notifySuccessHelper as t,notifyFailureHelper as n,notifyExpectedFailureHelper as a,registerOnThemeChangeHandlerHelper as o,registerOnContextChangeHandlerHelper as r,openLinkHelper as s}from"../../internal/appHelpers.js";import{uninitializeCommunication as l,sendAndUnwrap as m,Communication as d}from"../../internal/communication.js";import{GlobalVars as p}from"../../internal/globalVars.js";import{uninitializeHandlers as u,registerHostToAppPerformanceMetricsHandler as c}from"../../internal/handlers.js";import{ensureInitializeCalled as f}from"../../internal/internalAPIs.js";import{getLogger as h,getApiVersionTag as g}from"../../internal/telemetry.js";import{inServerSideRenderingEnvironment as I}from"../../internal/utils.js";import{AppId as y}from"../appId.js";import{HostClientType as S,HostName as T}from"../constants.js";import{version as v}from"../version.js";import*as C from"./lifecycle.js";export{C as lifecycle};import{_clearTelemetryPort as w}from"../../private/messageChannels/telemetry.js";import{_clearDataLayerPort as P}from"../../private/messageChannels/dataLayer.js";const j="v2",O=h("app"),N={AppLoaded:"appInitialization.appLoaded",Success:"appInitialization.success",Failure:"appInitialization.failure",ExpectedFailure:"appInitialization.expectedFailure"};var F,b;function x(){return p.initializeCompleted}function L(){return p.frameContext}function A(i){return e(g(j,"app.initialize"),i)}function z(){var e,i;if(I())return null;const t=null!==(e=d.currentWindow)&&void 0!==e?e:window;if(t.parent===t)return null;const n=t.location.ancestorOrigins,a=null==n?void 0:n.item(0);if(a)return a;const o=null===(i=t.document)||void 0===i?void 0:i.referrer;if(!o)return null;try{const e=new URL(o).origin;return e===t.location.origin?null:e}catch(e){return null}}function D(e){d.currentWindow=e}function k(){p.initializeCalled&&(u(),p.initializeCalled=!1,p.initializeCompleted=!1,p.initializePromise=void 0,p.additionalValidOrigins=[],p.frameContext=void 0,p.hostClientType=void 0,p.isFramelessWindow=!1,w(),P(),l())}function U(){return new Promise(e=>{f(),e(m(g(j,"app.getContext"),"getContext"))}).then(e=>function(e){var i;const t={actionInfo:e.actionInfo,app:{locale:e.locale,sessionId:e.appSessionId?e.appSessionId:"",theme:e.theme?e.theme:"default",iconPositionVertical:e.appIconPosition,osLocaleInfo:e.osLocaleInfo,messageId:e.messageId,parentMessageId:e.parentMessageId,userClickTime:e.userClickTime,userClickTimeV2:e.userClickTimeV2,userFileOpenPreference:e.userFileOpenPreference,host:{name:e.hostName?e.hostName:T.teams,clientType:e.hostClientType?e.hostClientType:S.web,features:e.hostFeatures,sessionId:e.sessionId?e.sessionId:"",ringId:e.ringId,ancestors:e.hostAncestors},appLaunchId:e.appLaunchId,appId:e.appId?new y(e.appId):void 0,manifestVersion:e.manifestVersion},page:{id:e.entityId,frameContext:e.frameContext?e.frameContext:p.frameContext,renderingSurface:e.renderingSurface?e.renderingSurface:void 0,subPageId:e.subEntityId,isFullScreen:e.isFullScreen,isMultiWindow:e.isMultiWindow,isBackgroundLoad:e.isBackgroundLoad,sourceOrigin:e.sourceOrigin},user:{id:null!==(i=e.userObjectId)&&void 0!==i?i:"",displayName:e.userDisplayName,isCallingAllowed:e.isCallingAllowed,isPSTNCallingAllowed:e.isPSTNCallingAllowed,licenseType:e.userLicenseType,loginHint:e.loginHint,userPrincipalName:e.userPrincipalName,tenant:e.tid?{id:e.tid,teamsSku:e.tenantSKU}:void 0},channel:e.channelId?{id:e.channelId,displayName:e.channelName,relativeUrl:e.channelRelativeUrl,membershipType:e.channelType,defaultOneNoteSectionId:e.defaultOneNoteSectionId,ownerGroupId:e.hostTeamGroupId,ownerTenantId:e.hostTeamTenantId}:void 0,chat:e.chatId?{id:e.chatId}:void 0,meeting:e.meetingId?{id:e.meetingId}:void 0,sharepoint:e.sharepoint,team:e.teamId?{internalId:e.teamId,displayName:e.teamName,type:e.teamType,groupId:e.groupId,templateId:e.teamTemplateId,isArchived:e.isTeamArchived,userRole:e.userTeamRole}:void 0,sharePointSite:e.teamSiteUrl||e.teamSiteDomain||e.teamSitePath||e.mySitePath||e.mySiteDomain?{teamSiteUrl:e.teamSiteUrl,teamSiteDomain:e.teamSiteDomain,teamSitePath:e.teamSitePath,teamSiteId:e.teamSiteId,mySitePath:e.mySitePath,mySiteDomain:e.mySiteDomain}:void 0,dialogParameters:e.dialogParameters||{}};return t}(e))}function H(){f(),i(g(j,"app.notifyAppLoaded"))}function V(){return t(g(j,"app.notifySuccess"))}function E(e){f(),n(g(j,"app.notifyFailure"),e)}function M(e){f(),a(g(j,"app.notifyExpectedFailure"),e)}function W(e){o(g(j,"app.registerOnThemeChangeHandler"),e)}function R(e){r(g(j,"app.registerOnContextChangeHandler"),e)}function B(e){c(e)}function G(e){return s(g(j,"app.openLink"),e)}!function(e){e.AuthFailed="AuthFailed",e.Timeout="Timeout",e.Other="Other"}(F||(F={})),function(e){e.PermissionError="PermissionError",e.NotFound="NotFound",e.Throttling="Throttling",e.Offline="Offline",e.Other="Other"}(b||(b={})),O("teamsjs instance is version %s, starting at %s UTC (%s local)",v,(new Date).toISOString(),(new Date).toLocaleString()),function(){if(I())return;const e=document.getElementsByTagName("script"),i=e&&e[e.length-1]&&e[e.length-1].src,t="Today, teamsjs can only be used from a single script or you may see undefined behavior. This log line is used to help detect cases where teamsjs is loaded multiple times -- it is always written. The presence of the log itself does not indicate a multi-load situation, but multiples of these log lines will. If you would like to use teamjs from more than one script at the same time, please open an issue at https://github.com/OfficeDev/microsoft-teams-library-js/issues";i&&0!==i.length?O("teamsjs is being used from %s. %s",i,t):O("teamsjs is being used from a script tag embedded directly in your html. %s",t)}();export{b as ExpectedFailureReason,F as FailedReason,N as Messages,D as _initialize,k as _uninitialize,U as getContext,L as getFrameContext,z as getImmediateParentOrigin,A as initialize,x as isInitialized,H as notifyAppLoaded,M as notifyExpectedFailure,E as notifyFailure,V as notifySuccess,G as openLink,B as registerHostToAppPerformanceMetricsHandler,R as registerOnContextChangeHandler,W as registerOnThemeChangeHandler};

package/dist/esm/packages/teams-js/src/public/version.js

@@ -1 +1 @@
-const t="2.54.0-beta.0";export{t as version};
+const o="2.55.0";export{o as version};

package/dist/umd/MicrosoftTeams.js

@@ -1151,6 +1151,7 @@ __webpack_require__.d(app_namespaceObject, {
   _uninitialize: () => (_uninitialize),
   getContext: () => (getContext),
   getFrameContext: () => (getFrameContext),
+  getImmediateParentOrigin: () => (getImmediateParentOrigin),
   initialize: () => (initialize),
   isInitialized: () => (isInitialized),
   lifecycle: () => (lifecycle_namespaceObject),
@@ -4694,7 +4695,7 @@ function isSerializable(arg) {
  * @hidden
  *  Package version.
  */
-const version = "2.54.0-beta.0";
+const version = "2.55.0";
 
 ;// ./src/public/featureFlags.ts
 // All build feature flags are defined inside this object. Any build feature flag must have its own unique getter and setter function. This pattern allows for client apps to treeshake unused code and avoid including code guarded by this feature flags in the final bundle. If this property isn't desired, use the below runtime feature flags object.
@@ -5533,6 +5534,56 @@ logWhereTeamsJsIsBeingUsed();
 function initialize(validMessageOrigins) {
     return appInitializeHelper(getApiVersionTag(appTelemetryVersionNumber, "app.initialize" /* ApiName.App_Initialize */), validMessageOrigins);
 }
+/**
+ * Returns the immediate parent origin when this app is running inside an iframe.
+ *
+ * @remarks
+ * This helper is useful for scenarios where the app must explicitly trust the hosting parent origin during
+ * {@link initialize} by passing `[origin]` as `validMessageOrigins`.
+ *
+ * If no parent origin can be determined, this function returns `null`.
+ *
+ * @example
+ * ```typescript
+ * import { app } from '@microsoft/teams-js';
+ *
+ * const parentOrigin = app.getImmediateParentOrigin();
+ * await app.initialize(parentOrigin ? [parentOrigin] : undefined);
+ * ```
+ *
+ * @returns The immediate parent origin, or `null` when unavailable.
+ */
+function getImmediateParentOrigin() {
+    var _a, _b;
+    if (inServerSideRenderingEnvironment()) {
+        return null;
+    }
+    const currentWindow = (_a = Communication.currentWindow) !== null && _a !== void 0 ? _a : window;
+    if (currentWindow.parent === currentWindow) {
+        return null;
+    }
+    const ancestorOrigins = currentWindow.location.ancestorOrigins;
+    const immediateAncestorOrigin = ancestorOrigins === null || ancestorOrigins === void 0 ? void 0 : ancestorOrigins.item(0);
+    if (immediateAncestorOrigin) {
+        return immediateAncestorOrigin;
+    }
+    const referrer = (_b = currentWindow.document) === null || _b === void 0 ? void 0 : _b.referrer;
+    if (!referrer) {
+        return null;
+    }
+    try {
+        const referrerOrigin = new URL(referrer).origin;
+        // `document.referrer` can point to this iframe's prior URL after in-frame redirects.
+        // Returning self-origin as the parent would be incorrect; treat this as unavailable.
+        if (referrerOrigin === currentWindow.location.origin) {
+            return null;
+        }
+        return referrerOrigin;
+    }
+    catch (_c) {
+        return null;
+    }
+}
 /**
  * @hidden
  * Undocumented function used to set a mock window for unit tests
@@ -9326,6 +9377,7 @@ var UserSettingTypes;
 
 
 
+const privateAPIsTelemetryVersionNumber = "v1" /* ApiVersionNumber.V_1 */;
 /**
  * @hidden
  * Upload a custom App manifest directly to both team and personal scopes.
@@ -9333,10 +9385,7 @@ var UserSettingTypes;
  *
  * @internal
  * Limited to Microsoft-internal use
- *
- * v1 APIs telemetry file: All of APIs in this capability file should send out API version v1 ONLY
  */
-const privateAPIsTelemetryVersionNumber = "v1" /* ApiVersionNumber.V_1 */;
 function uploadCustomApp(manifestBlob, onComplete) {
     ensureInitialized(runtime);
     sendMessageToParent(getApiVersionTag(privateAPIsTelemetryVersionNumber, "uploadCustomApp" /* ApiName.PrivateAPIs_UploadCustomApp */), 'uploadCustomApp', [manifestBlob], onComplete ? onComplete : getGenericOnCompleteHandler());
@@ -9591,6 +9640,7 @@ function getChatMembers() {
     });
 }
 /**
+ * @hidden
  * Checks if the conversations capability is supported by the host
  * @returns boolean to represent whether conversations capability is supported
  *
@@ -10461,6 +10511,12 @@ function authenticateWithPowerPlatformConnectorPlugins(titleId, signInUrl, oauth
         }
     });
 }
+/**
+ * @hidden
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 class SerializableConnectorParameters {
     constructor(param) {
         this.param = param;
@@ -12252,6 +12308,7 @@ function notifyInstallCompleted(appId) {
     return callFunctionInHost("otherApp.notifyInstallCompleted" /* ApiName.OtherAppStateChange_NotifyInstallCompleted */, [appId.toString()], getApiVersionTag(otherAppStateChangeTelemetryVersionNumber, "otherApp.notifyInstallCompleted" /* ApiName.OtherAppStateChange_NotifyInstallCompleted */));
 }
 /**
+ * @hidden
  * Checks if the otherAppStateChange capability is supported by the host
  * @returns boolean to represent whether the otherAppStateChange capability is supported
  *
@@ -12856,6 +12913,11 @@ function fullTrust_fullTrust_isSupported() {
  * v1 APIs telemetry file: All of APIs in this capability file should send out API version v1 ONLY
  */
 const teams_teamsTelemetryVersionNumber = "v1" /* ApiVersionNumber.V_1 */;
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 var teams_ChannelType;
 (function (ChannelType) {
     ChannelType[ChannelType["Regular"] = 0] = "Regular";
@@ -13869,6 +13931,11 @@ var videoEffectsEx_awaiter = (undefined && undefined.__awaiter) || function (thi
  * v2 APIs telemetry file: All of APIs in this capability file should send out API version v2 ONLY
  */
 const videoEffectsExTelemetryVersionNumber = "v2" /* ApiVersionNumber.V_2 */;
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 const frameProcessingTimeoutInMs = 2000;
 const videoEffectsEx_videoPerformanceMonitor = inServerSideRenderingEnvironment()
     ? undefined
@@ -14342,6 +14409,11 @@ function validateTab(tab) {
 
 
 
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 var AppTypes;
 (function (AppTypes) {
     AppTypes["edu"] = "EDU";
@@ -14459,6 +14531,7 @@ function openSpecificStore(params) {
     });
 }
 /**
+ * @hidden
  * Checks if the store capability is supported by the host
  * @returns boolean to represent whether the store capability is supported
  *
@@ -14526,6 +14599,12 @@ const widgetHostingLogger = getLogger('widgetHosting');
 function widgetHosting_isSupported() {
     return ensureInitialized(runtime) && !!runtime.supports.widgetHosting;
 }
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ * @beta
+ */
 function callTool(widgetId, input) {
     return widgetHosting_awaiter(this, void 0, void 0, function* () {
         ensureInitializeCalled();