Skip to content

Commit

Permalink
Merge branch 'main' into user/hangyin/openstore
Browse files Browse the repository at this point in the history
  • Loading branch information
TrevorJoelHarris authored Nov 21, 2024
2 parents f238ddb + 8d2d55b commit de9401c
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 44 deletions.
12 changes: 11 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
{
"cSpell.words": ["adal", "frameless", "ipados", "teamsjs", "teamspace", "uninitialize", "xvfb"],
"cSpell.words": [
"adal",
"frameless",
"ipados",
"parentless",
"Subcapability",
"teamsjs",
"teamspace",
"uninitialize",
"xvfb"
],
"editor.defaultFormatter": "esbenp.prettier-vscode",
"eslint.workingDirectories": [
"./apps/ssr-test-app/",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "Removed `@beta` tag from all functions on `dialog` capability (and all subcapabilities)",
"packageName": "@microsoft/teams-js",
"email": "36546967+AE-MS@users.noreply.github.com",
"dependentChangeType": "patch"
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

/**
* Subcapability for interacting with adaptive card dialogs
* @beta
* @module
*/

Expand All @@ -25,8 +24,6 @@ import * as bot from './bot';
*
* @param adaptiveCardDialogInfo - An object containing the parameters of the dialog module {@link AdaptiveCardDialogInfo}.
* @param submitHandler - Handler that triggers when a dialog fires an [Action.Submit](https://adaptivecards.io/explorer/Action.Submit.html) or when the user closes the dialog.
*
* @beta
*/
export function open(adaptiveCardDialogInfo: AdaptiveCardDialogInfo, submitHandler?: DialogSubmitHandler): void {
ensureInitialized(runtime, FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
Expand All @@ -50,8 +47,6 @@ export function open(adaptiveCardDialogInfo: AdaptiveCardDialogInfo, submitHandl
* @returns boolean to represent whether dialog.adaptiveCard module is supported
*
* @throws Error if {@linkcode app.initialize} has not successfully completed
*
* @beta
*/
export function isSupported(): boolean {
const isAdaptiveCardVersionSupported =
Expand Down
5 changes: 0 additions & 5 deletions packages/teams-js/src/public/dialog/adaptiveCard/bot.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/**
* Module for interaction with adaptive card dialogs that need to communicate with the bot framework
*
* @beta
* @module
*/

Expand All @@ -23,8 +22,6 @@ import { DialogSubmitHandler } from '../dialog';
*
* @param botAdaptiveCardDialogInfo - An object containing the parameters of the dialog module including completionBotId.
* @param submitHandler - Handler that triggers when the dialog has been submitted or closed.
*
* @beta
*/
export function open(botAdaptiveCardDialogInfo: BotAdaptiveCardDialogInfo, submitHandler?: DialogSubmitHandler): void {
ensureInitialized(runtime, FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
Expand All @@ -50,8 +47,6 @@ export function open(botAdaptiveCardDialogInfo: BotAdaptiveCardDialogInfo, submi
* @returns boolean to represent whether dialog.adaptiveCard.bot is supported
*
* @throws Error if {@linkcode app.initialize} has not successfully completed
*
* @beta
*/
export function isSupported(): boolean {
const isAdaptiveCardVersionSupported =
Expand Down
8 changes: 0 additions & 8 deletions packages/teams-js/src/public/dialog/dialog.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
* @remarks Note that dialogs were previously called "task modules". While they have been renamed for clarity, the functionality has been maintained.
* For more details, see [Dialogs](https://learn.microsoft.com/microsoftteams/platform/task-modules-and-cards/what-are-task-modules)
*
* @beta
* @module
*/

Expand All @@ -29,8 +28,6 @@ import * as url from './url/url';

/**
* Data Structure to represent the SDK response when dialog closes
*
* @beta
*/
export interface ISdkResponse {
/**
Expand All @@ -49,7 +46,6 @@ export interface ISdkResponse {

/**
* Handler used to receive and process messages sent between a dialog and the app that launched it
* @beta
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export type PostMessageChannel = (message: any) => void;
Expand All @@ -59,8 +55,6 @@ export type PostMessageChannel = (message: any) => void;
* or an error if the dialog was closed by the user.
*
* @see {@linkcode ISdkResponse}
*
* @beta
*/
export type DialogSubmitHandler = (result: ISdkResponse) => void;

Expand All @@ -72,8 +66,6 @@ export type DialogSubmitHandler = (result: ISdkResponse) => void;
* Function is called during app initialization
* @internal
* Limited to Microsoft-internal use
*
* @beta
*/
export function initialize(): void {
registerHandler(
Expand Down
5 changes: 0 additions & 5 deletions packages/teams-js/src/public/dialog/update.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/**
* Module to update the dialog
*
* @beta
* @module
*/

Expand All @@ -15,8 +14,6 @@ import { runtime } from '../runtime';
* Update dimensions - height/width of a dialog.
*
* @param dimensions - An object containing width and height properties.
*
* @beta
*/
export function resize(dimensions: DialogSize): void {
updateResizeHelper(getApiVersionTag(dialogTelemetryVersionNumber, ApiName.Dialog_Update_Resize), dimensions);
Expand All @@ -27,8 +24,6 @@ export function resize(dimensions: DialogSize): void {
* @returns boolean to represent whether dialog.update capabilty is supported
*
* @throws Error if {@linkcode app.initialize} has not successfully completed
*
* @beta
*/
export function isSupported(): boolean {
return ensureInitialized(runtime) && runtime.supports.dialog
Expand Down
5 changes: 0 additions & 5 deletions packages/teams-js/src/public/dialog/url/bot.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/**
* Module to open a dialog that sends results to the bot framework
*
* @beta
* @module
*/

Expand All @@ -20,8 +19,6 @@ import { DialogSubmitHandler, PostMessageChannel } from '../dialog';
* @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
*
* @returns a function that can be used to send messages to the dialog.
*
* @beta
*/
export function open(
botUrlDialogInfo: BotUrlDialogInfo,
Expand All @@ -42,8 +39,6 @@ export function open(
* @returns boolean to represent whether dialog.url.bot is supported
*
* @throws Error if {@linkcode app.initialize} has not successfully completed
*
* @beta
*/
export function isSupported(): boolean {
return (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* @remarks
* Note that dialog can be invoked from parentless scenarios e.g. Search Message Extensions. The subcapability `parentCommunication` is not supported in such scenarios.
*
* @beta
* @module
*/

Expand All @@ -24,8 +23,6 @@ import { PostMessageChannel } from '../dialog';
* This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
*
* @param message - The message to send to the parent
*
* @beta
*/
export function sendMessageToParentFromDialog(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
Expand All @@ -50,8 +47,6 @@ export function sendMessageToParentFromDialog(
* Send message to the dialog from the parent
*
* @param message - The message to send
*
* @beta
*/
export function sendMessageToDialog(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
Expand All @@ -76,8 +71,6 @@ export function sendMessageToDialog(
* This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
*
* @param listener - The listener that will be triggered.
*
* @beta
*/
export function registerOnMessageFromParent(listener: PostMessageChannel): void {
ensureInitialized(runtime, FrameContexts.task);
Expand Down Expand Up @@ -110,8 +103,6 @@ export function registerOnMessageFromParent(listener: PostMessageChannel): void
* @returns boolean to represent whether dialog.url.parentCommunication capability is supported
*
* @throws Error if {@linkcode app.initialize} has not successfully completed
*
* @beta
*/
export function isSupported(): boolean {
return ensureInitialized(runtime) && !!runtime.supports.dialog?.url?.parentCommunication;
Expand Down
6 changes: 0 additions & 6 deletions packages/teams-js/src/public/dialog/url/url.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ import * as parentCommunication from './parentCommunication';
* @param urlDialogInfo - An object containing the parameters of the dialog module.
* @param submitHandler - Handler that triggers when a dialog calls the {@linkcode submit} function or when the user closes the dialog.
* @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
*
* @beta
*/
export function open(
urlDialogInfo: UrlDialogInfo,
Expand All @@ -45,8 +43,6 @@ export function open(
* If this function is called from a dialog while {@link M365ContentAction} is set in the context object by the host, result will be ignored
*
* @param appIds - Valid application(s) that can receive the result of the submitted dialogs. Specifying this parameter helps prevent malicious apps from retrieving the dialog result. Multiple app IDs can be specified because a web app from a single underlying domain can power multiple apps across different environments and branding schemes.
*
* @beta
*/
export function submit(result?: string | object, appIds?: string | string[]): void {
urlSubmitHelper(getApiVersionTag(dialogTelemetryVersionNumber, ApiName.Dialog_Url_Submit), result, appIds);
Expand All @@ -58,8 +54,6 @@ export function submit(result?: string | object, appIds?: string | string[]): vo
* @returns boolean to represent whether dialog.url module is supported
*
* @throws Error if {@linkcode app.initialize} has not successfully completed
*
* @beta
*/
export function isSupported(): boolean {
return ensureInitialized(runtime) && (runtime.supports.dialog && runtime.supports.dialog.url) !== undefined;
Expand Down

0 comments on commit de9401c

Please sign in to comment.