@jevelin/bridge 2.53.0

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

@@ -0,0 +1,48 @@
+/**
+ * @beta
+ * @hidden
+ * Module to delegate adaptive card action for Custom Engine Agent execution to the host
+ * @internal
+ * Limited to Microsoft-internal use
+ * @module
+ */
+import { AppId } from '../public';
+import * as externalAppCardActions from './externalAppCardActions';
+/**
+ * @beta
+ * @hidden
+ * Delegates an Adaptive Card Action.OpenUrl request to the host for the application with the provided app ID.
+ * @internal
+ * Limited to Microsoft-internal use
+ * @param appId ID of the application the request is intended for. This must be a UUID
+ * @param conversationId To tell the bot what conversation the calls are coming from
+ * @param url The URL to open
+ * @throws Error if the response has not successfully completed
+ * @returns Promise that resolves to ActionOpenUrlType indicating the type of URL that was opened on success and rejects with ActionOpenUrlError if the request fails
+ */
+export declare function processActionOpenUrl(appId: AppId, conversationId: string, url: URL): Promise<externalAppCardActions.ActionOpenUrlType>;
+/**
+ * @beta
+ * @hidden
+ * Delegates an Adaptive Card Action.Submit request to the host for the application with the provided app ID
+ * @internal
+ * Limited to Microsoft-internal use
+ * @param appId ID of the application the request is intended for. This must be a UUID
+ * @param conversationId To tell the bot what conversation the calls are coming from
+ * @param actionSubmitPayload The Adaptive Card Action.Submit payload
+ * @throws Error if host notifies of an error
+ * @returns Promise that resolves when the request is completed and rejects with ActionSubmitError if the request fails
+ */
+export declare function processActionSubmit(appId: AppId, conversationId: string, actionSubmitPayload: externalAppCardActions.IAdaptiveCardActionSubmit): Promise<void>;
+/**
+ * @beta
+ * @hidden
+ * Checks if the externalAppCardActionsForCEA capability is supported by the host
+ * @returns boolean to represent whether externalAppCardActions 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/externalAppCardActionsForDA.d.ts

@@ -0,0 +1,75 @@
+/**
+ * @beta
+ * @hidden
+ * Module to delegate adaptive card action for Declarative Agents execution to the host
+ * @internal
+ * Limited to Microsoft-internal use
+ * @module
+ */
+import { DialogSize } from '../public';
+import { AppId } from '../public';
+import { ISerializable } from '../public/serializable.interface';
+import { UUID } from '../public/uuidObject';
+/**
+ * @beta
+ * @hidden
+ * Base interface for Dialog Information.
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @param title The title of the dialog.
+ * @param size The size of the dialog.
+ */
+export interface IDialogActionBase {
+    title: string;
+    size: DialogSize;
+}
+/**
+ * @beta
+ * @hidden
+ * Interface to define the Dialog info for Adaptive Card Action.OpenUrlDialog request.
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @param url The URL to open in the dialog.
+ */
+export interface IActionOpenUrlDialogInfo extends IDialogActionBase {
+    url: URL;
+}
+/**
+ * @beta
+ * @hidden
+ * Delegates an Adaptive Card Action.OpenUrlDialog request to the host for the application with the provided app ID
+ * @internal
+ * Limited to Microsoft-internal use
+ * @param appId ID of the application the request is intended for. This must be a UUID
+ * @param actionOpenUrlDialogInfo Information required to open the URL dialog
+ * @param traceId The trace identifier used for monitoring and live site investigations
+ * @returns Promise that resolves when the request is completed and rejects with ExternalAppError if the request fails
+ */
+export declare function processActionOpenUrlDialog(appId: AppId, actionOpenUrlDialogInfo: IActionOpenUrlDialogInfo, traceId: UUID): Promise<void>;
+/**
+ * @beta
+ * @hidden
+ * Checks if the externalAppCardActions capability is supported by the host
+ * @returns boolean to represent whether externalAppCardActions capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function isSupported(): boolean;
+/**
+ * @beta
+ * @hidden
+ * Serializable class for ActionOpenUrlDialogInfo to send info to the host
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare class SerializableActionOpenUrlDialogInfo implements ISerializable {
+    private info;
+    constructor(info: IActionOpenUrlDialogInfo);
+    serialize(): object;
+}

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

@@ -0,0 +1,122 @@
+/**
+ * @hidden
+ * Module to delegate the ActionCommand to the host
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @beta
+ * @module
+ */
+import { ExternalAppErrorCode } from './constants';
+import * as externalAppAuthentication from './externalAppAuthentication';
+/**
+ * @hidden
+ * The payload of IActionCommandResponse
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @beta
+ */
+export type IActionCommandResponse = ITextActionCommandResponse | ICardActionCommandResponse;
+/**
+ * @hidden
+ * The payload of IBaseActionCommandResponse
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @beta
+ */
+export interface IBaseActionCommandResponse {
+    taskModuleClosedReason: TaskModuleClosedReason;
+}
+/**
+ * @hidden
+ * The text result type
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @beta
+ */
+export interface ITextActionCommandResponse extends IBaseActionCommandResponse {
+    resultType: 'text';
+    text: string | undefined;
+}
+/**
+ * @hidden
+ * The card result type
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @beta
+ */
+export interface ICardActionCommandResponse extends IBaseActionCommandResponse {
+    resultType: 'card';
+    attachmentLayout: externalAppAuthentication.AttachmentLayout;
+    attachments: externalAppAuthentication.QueryMessageExtensionAttachment[];
+}
+/**
+ * @hidden
+ * The result type for the ActionCommandResultType
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @beta
+ */
+export type ActionCommandResultType = 'card' | 'text';
+/**
+ * @hidden
+ * The reason for the TaskModuleClosedReason
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @beta
+ */
+export type TaskModuleClosedReason = 'Done' | 'CancelledByUser';
+/**
+ *
+ * @hidden
+ * Error that can be thrown from IExternalAppCommandsService.processActionCommand
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @beta
+ */
+export interface ActionCommandError {
+    errorCode: ExternalAppErrorCode;
+    message?: string;
+}
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ * @hidden
+ * This API delegates an ActionCommand request to the host for the application with the provided following parameters:
+ *
+ * @param appId ID of the application the request is intended for. This must be a UUID
+ * @param commandId extensibilityProvider use this ID to look up the command declared by ActionME
+ * @param extractedParameters are the key-value pairs that the dialog will be prepopulated with
+ *
+ * @returns Promise that resolves with the {@link IActionCommandResponse} when the request is completed and rejects with {@link ActionCommandError} if the request fails
+ *
+ * @beta
+ */
+export declare function processActionCommand(appId: string, commandId: string, extractedParameters: Record<string, string>): Promise<IActionCommandResponse>;
+/**
+ * @hidden
+ * Checks if the externalAppCommands capability is supported by the host
+ * @returns boolean to represent whether externalAppCommands capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @beta
+ */
+export declare function isSupported(): boolean;

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

@@ -0,0 +1,19 @@
+import { ExternalAppErrorCode } from './constants';
+/**
+ * @hidden
+ * Error object that can be thrown from externalAppCommands, externalAppCardCommands and other external app APIs
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface ExternalAppError {
+    errorCode: ExternalAppErrorCode;
+    message?: string;
+}
+/**
+ * @hidden
+ * Determines if the provided error object is an instance of ExternalAppError
+ * @internal
+ * Limited to Microsoft-internal use
+ * @param err The error object to check whether it is of ExternalAppError type
+ */
+export declare function isExternalAppError(err: unknown): err is ExternalAppError;