@microsoft/teams-js 2.4.2-beta.1 → 2.4.2

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.4.1/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.4.2/js/MicrosoftTeams.min.js) or point your package manager at them.
 
 ## Usage
 
@@ -45,13 +45,13 @@ Reference the SDK inside of your `.html` page using:
 ```html
 <!-- Microsoft Teams JavaScript API (via CDN) -->
 <script
-  src="https://res.cdn.office.net/teams-js/2.4.1/js/MicrosoftTeams.min.js"
-  integrity="sha384-f54aC8b3HUFudeEk+QUkv5RpZUpPr2g7TdP4+jnDAMoJSmt+PbMdUV+zGTYCQY1c"
+  src="https://res.cdn.office.net/teams-js/2.4.2/js/MicrosoftTeams.min.js"
+  integrity="sha384-M1BiuUWGXFEu6jscBr/dyRZl4uojmiT5eMSu50lpG3eUyacKjwXE0eWRa2ZIdOmQ"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.4.1/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.4.2/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>
@@ -69,6 +69,10 @@ Stay tuned for examples coming soon.
 
 The [Teams Test App](https://aka.ms/teams-test-app) is used to validate the Teams client SDK APIs.
 
+## Troubleshooting
+
+If the CDN hash value on the npm page is out of date please refer to [here] (https://github.com/OfficeDev/microsoft-teams-library-js/blob/main/packages/teams-js/README.md) for an up to date version. If you notice this problem, please report that issue to us in [GitHub Issues] (https://github.com/OfficeDev/microsoft-teams-library-js/issues)
+
 ## Contributing
 
 Please be sure to check out the [Contributor's guide](../../CONTRIBUTING.md) for crucial steps.

package/dist/MicrosoftTeams.d.ts

@@ -3499,7 +3499,7 @@ export namespace app {
                     */
                 reason: FailedReason;
                 /**
-                    * This property is currently unused.
+                    * A message that describes the failure
                     */
                 message?: string;
         }
@@ -4073,10 +4073,8 @@ export namespace dialog {
                     */
                 err?: string;
                 /**
-                    * Value provided in the `result` parameter by the dialog when the {@linkcode submit} function
-                    * was called.
-                    * If the dialog was closed by the user without submitting (e.g., using a control in the corner
-                    * of the dialog), this value will be `undefined` here.
+                    * Result value that the dialog is submitted with using {@linkcode submit} function
+                    *
                     */
                 result?: string | object;
         }
@@ -6368,7 +6366,7 @@ export namespace stageView {
         function isSupported(): boolean;
 }
 
-export const version = "ERROR: This value should be replaced by webpack!";
+export const version: string;
 
 /**
     * Contains functionality to allow web apps to store data in webview cache
@@ -6897,198 +6895,3 @@ export namespace tasks {
         function getDefaultSizeIfNotProvided(taskInfo: TaskInfo): TaskInfo;
 }
 
-/**
-    * @hidden
-    * Allowed roles during a meeting.
-    *
-    * @beta
-    */
-export enum UserMeetingRole {
-        guest = "Guest",
-        attendee = "Attendee",
-        presenter = "Presenter",
-        organizer = "Organizer"
-}
-/**
-    * @hidden
-    * State of the current Live Share sessions backing fluid container.
-    *
-    * @beta
-    */
-export enum ContainerState {
-        /**
-            * The call to `LiveShareHost.setContainerId()` successfully created the container mapping
-            * for the current Live Share session.
-            */
-        added = "Added",
-        /**
-            * A container mapping for the current Live Share Session already exists and should be used
-            * when joining the sessions Fluid container.
-            */
-        alreadyExists = "AlreadyExists",
-        /**
-            * The call to `LiveShareHost.setContainerId()` failed to create the container mapping due to
-            * another client having already set the container ID for the current Live Share session.
-            */
-        conflict = "Conflict",
-        /**
-            * A container mapping for the current Live Share session doesn't exist yet.
-            */
-        notFound = "NotFound"
-}
-/**
-    * @hidden
-    * Returned from `LiveShareHost.get/setFluidContainerId()` to specify the container mapping for the
-    * current Live Share session.
-    *
-    * @beta
-    */
-export interface IFluidContainerInfo {
-        /**
-            * State of the containerId mapping.
-            */
-        containerState: ContainerState;
-        /**
-            * ID of the container to join for the meeting. Undefined if the container hasn't been
-            * created yet.
-            */
-        containerId: string | undefined;
-        /**
-            * If true, the local client should create the container and then save the created containers
-            * ID to the mapping service.
-            */
-        shouldCreate: boolean;
-        /**
-            * If `containerId` is undefined and `shouldCreate` is false, the container isn't ready but
-            * another client is creating it. The local client should wait the specified amount of time and
-            * then ask for the container info again.
-            */
-        retryAfter: number;
-}
-/**
-    * @hidden
-    * Returned from `LiveShareHost.getNtpTime()` to specify the global timestamp for the current
-    * Live Share session.
-    *
-    * @beta
-    */
-export interface INtpTimeInfo {
-        /**
-            * ISO 8601 formatted server time. For example: '2019-09-07T15:50-04:00'
-            */
-        ntpTime: string;
-        /**
-            * Server time expressed as the number of milliseconds since the ECMAScript epoch.
-            */
-        ntpTimeInUTC: number;
-}
-/**
-    * @hidden
-    * Returned from `LiveShareHost.getFluidTenantInfo()` to specify the Fluid service to use for the
-    * current Live Share session.
-    *
-    * @beta
-    */
-export interface IFluidTenantInfo {
-        /**
-            * The Fluid Tenant ID Live Share should use.
-            */
-        tenantId: string;
-        /**
-            * The Fluid service endpoint Live Share should use.
-            */
-        serviceEndpoint?: string;
-        /**
-            * @deprecated
-            * As of Fluid 1.0 this configuration information has been deprecated in favor of
-            * `serviceEndpoint`.
-            */
-        ordererEndpoint: string;
-        /**
-            * @deprecated
-            * As of Fluid 1.0 this configuration information has been deprecated in favor of
-            * `serviceEndpoint`.
-            */
-        storageEndpoint: string;
-}
-/**
-    * Live Share host implementation for O365 and Teams clients.
-    *
-    * @beta
-    */
-export class LiveShareHost {
-        /**
-            * @hidden
-            * Returns the Fluid Tenant connection info for user's current context.
-            *
-            * @beta
-            */
-        getFluidTenantInfo(): Promise<IFluidTenantInfo>;
-        /**
-            * @hidden
-            * Returns the fluid access token for mapped container Id.
-            *
-            * @param containerId Fluid's container Id for the request. Undefined for new containers.
-            * @returns token for connecting to Fluid's session.
-            *
-            * @beta
-            */
-        getFluidToken(containerId?: string): Promise<string>;
-        /**
-            * @hidden
-            * Returns the ID of the fluid container associated with the user's current context.
-            *
-            * @beta
-            */
-        getFluidContainerId(): Promise<IFluidContainerInfo>;
-        /**
-            * @hidden
-            * Sets the ID of the fluid container associated with the current context.
-            *
-            * @remarks
-            * If this returns false, the client should delete the container they created and then call
-            * `getFluidContainerId()` to get the ID of the container being used.
-            * @param containerId ID of the fluid container the client created.
-            * @returns A data structure with a `containerState` indicating the success or failure of the request.
-            *
-            * @beta
-            */
-        setFluidContainerId(containerId: string): Promise<IFluidContainerInfo>;
-        /**
-            * @hidden
-            * Returns the shared clock server's current time.
-            *
-            * @beta
-            */
-        getNtpTime(): Promise<INtpTimeInfo>;
-        /**
-            * @hidden
-            * Associates the fluid client ID with a set of user roles.
-            *
-            * @param clientId The ID for the current user's Fluid client. Changes on reconnects.
-            * @returns The roles for the current user.
-            *
-            * @beta
-            */
-        registerClientId(clientId: string): Promise<UserMeetingRole[]>;
-        /**
-            * @hidden
-            * Returns the roles associated with a client ID.
-            *
-            * @param clientId The Client ID the message was received from.
-            * @returns The roles for a given client. Returns `undefined` if the client ID hasn't been registered yet.
-            *
-            * @beta
-            */
-        getClientRoles(clientId: string): Promise<UserMeetingRole[] | undefined>;
-        /**
-            * Returns a host instance for the client that can be passed to the `LiveShareClient` class.
-            *
-            * @remarks
-            * The application must first be initialized and may only be called from `meetingStage` or `sidePanel` contexts.
-            *
-            * @beta
-            */
-        static create(): LiveShareHost;
-}
-

package/dist/MicrosoftTeams.js

@@ -1046,20 +1046,17 @@ __webpack_require__.d(__webpack_exports__, {
   "ActionObjectType": () => (/* reexport */ ActionObjectType),
   "ChannelType": () => (/* reexport */ ChannelType),
   "ChildAppWindow": () => (/* reexport */ ChildAppWindow),
-  "ContainerState": () => (/* reexport */ ContainerState),
   "DialogDimension": () => (/* reexport */ DialogDimension),
   "ErrorCode": () => (/* reexport */ ErrorCode),
   "FileOpenPreference": () => (/* reexport */ FileOpenPreference),
   "FrameContexts": () => (/* reexport */ FrameContexts),
   "HostClientType": () => (/* reexport */ HostClientType),
   "HostName": () => (/* reexport */ HostName),
-  "LiveShareHost": () => (/* reexport */ LiveShareHost),
   "NotificationTypes": () => (/* reexport */ NotificationTypes),
   "ParentAppWindow": () => (/* reexport */ ParentAppWindow),
   "SecondaryM365ContentIdName": () => (/* reexport */ SecondaryM365ContentIdName),
   "TaskModuleDimension": () => (/* reexport */ TaskModuleDimension),
   "TeamType": () => (/* reexport */ TeamType),
-  "UserMeetingRole": () => (/* reexport */ UserMeetingRole),
   "UserSettingTypes": () => (/* reexport */ UserSettingTypes),
   "UserTeamRole": () => (/* reexport */ UserTeamRole),
   "ViewerActionTypes": () => (/* reexport */ ViewerActionTypes),
@@ -1133,7 +1130,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/public/version.ts
-var version = "2.4.2-beta.1";
+var version = "2.4.2";
 
 ;// CONCATENATED MODULE: ./src/internal/globalVars.ts
 var GlobalVars = /** @class */ (function () {
@@ -8251,175 +8248,6 @@ var tasks;
     tasks.getDefaultSizeIfNotProvided = getDefaultSizeIfNotProvided;
 })(tasks || (tasks = {}));
 
-;// CONCATENATED MODULE: ./src/public/liveShareHost.ts
-
-
-
-/**
- * @hidden
- * Allowed roles during a meeting.
- *
- * @beta
- */
-var UserMeetingRole;
-(function (UserMeetingRole) {
-    UserMeetingRole["guest"] = "Guest";
-    UserMeetingRole["attendee"] = "Attendee";
-    UserMeetingRole["presenter"] = "Presenter";
-    UserMeetingRole["organizer"] = "Organizer";
-})(UserMeetingRole || (UserMeetingRole = {}));
-/**
- * @hidden
- * State of the current Live Share sessions backing fluid container.
- *
- * @beta
- */
-var ContainerState;
-(function (ContainerState) {
-    /**
-     * The call to `LiveShareHost.setContainerId()` successfully created the container mapping
-     * for the current Live Share session.
-     */
-    ContainerState["added"] = "Added";
-    /**
-     * A container mapping for the current Live Share Session already exists and should be used
-     * when joining the sessions Fluid container.
-     */
-    ContainerState["alreadyExists"] = "AlreadyExists";
-    /**
-     * The call to `LiveShareHost.setContainerId()` failed to create the container mapping due to
-     * another client having already set the container ID for the current Live Share session.
-     */
-    ContainerState["conflict"] = "Conflict";
-    /**
-     * A container mapping for the current Live Share session doesn't exist yet.
-     */
-    ContainerState["notFound"] = "NotFound";
-})(ContainerState || (ContainerState = {}));
-/**
- * Live Share host implementation for O365 and Teams clients.
- *
- * @beta
- */
-var LiveShareHost = /** @class */ (function () {
-    function LiveShareHost() {
-    }
-    /**
-     * @hidden
-     * Returns the Fluid Tenant connection info for user's current context.
-     *
-     * @beta
-     */
-    LiveShareHost.prototype.getFluidTenantInfo = function () {
-        return new Promise(function (resolve) {
-            ensureInitialized(FrameContexts.meetingStage, FrameContexts.sidePanel);
-            resolve(sendAndHandleSdkError('interactive.getFluidTenantInfo'));
-        });
-    };
-    /**
-     * @hidden
-     * Returns the fluid access token for mapped container Id.
-     *
-     * @param containerId Fluid's container Id for the request. Undefined for new containers.
-     * @returns token for connecting to Fluid's session.
-     *
-     * @beta
-     */
-    LiveShareHost.prototype.getFluidToken = function (containerId) {
-        return new Promise(function (resolve) {
-            ensureInitialized(FrameContexts.meetingStage, FrameContexts.sidePanel);
-            // eslint-disable-next-line strict-null-checks/all
-            resolve(sendAndHandleSdkError('interactive.getFluidToken', containerId));
-        });
-    };
-    /**
-     * @hidden
-     * Returns the ID of the fluid container associated with the user's current context.
-     *
-     * @beta
-     */
-    LiveShareHost.prototype.getFluidContainerId = function () {
-        return new Promise(function (resolve) {
-            ensureInitialized(FrameContexts.meetingStage, FrameContexts.sidePanel);
-            resolve(sendAndHandleSdkError('interactive.getFluidContainerId'));
-        });
-    };
-    /**
-     * @hidden
-     * Sets the ID of the fluid container associated with the current context.
-     *
-     * @remarks
-     * If this returns false, the client should delete the container they created and then call
-     * `getFluidContainerId()` to get the ID of the container being used.
-     * @param containerId ID of the fluid container the client created.
-     * @returns A data structure with a `containerState` indicating the success or failure of the request.
-     *
-     * @beta
-     */
-    LiveShareHost.prototype.setFluidContainerId = function (containerId) {
-        return new Promise(function (resolve) {
-            ensureInitialized(FrameContexts.meetingStage, FrameContexts.sidePanel);
-            resolve(sendAndHandleSdkError('interactive.setFluidContainerId', containerId));
-        });
-    };
-    /**
-     * @hidden
-     * Returns the shared clock server's current time.
-     *
-     * @beta
-     */
-    LiveShareHost.prototype.getNtpTime = function () {
-        return new Promise(function (resolve) {
-            ensureInitialized(FrameContexts.meetingStage, FrameContexts.sidePanel);
-            resolve(sendAndHandleSdkError('interactive.getNtpTime'));
-        });
-    };
-    /**
-     * @hidden
-     * Associates the fluid client ID with a set of user roles.
-     *
-     * @param clientId The ID for the current user's Fluid client. Changes on reconnects.
-     * @returns The roles for the current user.
-     *
-     * @beta
-     */
-    LiveShareHost.prototype.registerClientId = function (clientId) {
-        return new Promise(function (resolve) {
-            ensureInitialized(FrameContexts.meetingStage, FrameContexts.sidePanel);
-            resolve(sendAndHandleSdkError('interactive.registerClientId', clientId));
-        });
-    };
-    /**
-     * @hidden
-     * Returns the roles associated with a client ID.
-     *
-     * @param clientId The Client ID the message was received from.
-     * @returns The roles for a given client. Returns `undefined` if the client ID hasn't been registered yet.
-     *
-     * @beta
-     */
-    LiveShareHost.prototype.getClientRoles = function (clientId) {
-        return new Promise(function (resolve) {
-            ensureInitialized(FrameContexts.meetingStage, FrameContexts.sidePanel);
-            resolve(sendAndHandleSdkError('interactive.getClientRoles', clientId));
-        });
-    };
-    /**
-     * Returns a host instance for the client that can be passed to the `LiveShareClient` class.
-     *
-     * @remarks
-     * The application must first be initialized and may only be called from `meetingStage` or `sidePanel` contexts.
-     *
-     * @beta
-     */
-    LiveShareHost.create = function () {
-        ensureInitialized(FrameContexts.meetingStage, FrameContexts.sidePanel);
-        return new LiveShareHost();
-    };
-    return LiveShareHost;
-}());
-
-
 ;// CONCATENATED MODULE: ./src/public/index.ts
 
 
@@ -8452,7 +8280,6 @@ var LiveShareHost = /** @class */ (function () {
 
 
 
-