@microsoft/teams-js 2.38.0-beta.0 → 2.39.0

package/dist/umd/MicrosoftTeams.js

@@ -1093,6 +1093,7 @@ __webpack_require__.d(__webpack_exports__, {
   settings: () => (/* reexport */ settings_namespaceObject),
   shareDeepLink: () => (/* reexport */ publicAPIs_shareDeepLink),
   sharing: () => (/* reexport */ sharing_namespaceObject),
+  sidePanelInterfaces: () => (/* reexport */ sidePanelInterfaces_namespaceObject),
   stageView: () => (/* reexport */ stageView_namespaceObject),
   store: () => (/* reexport */ store_namespaceObject),
   tasks: () => (/* reexport */ tasks_namespaceObject),
@@ -1359,12 +1360,36 @@ __webpack_require__.d(eligibility_namespaceObject, {
   isSupported: () => (eligibility_isSupported)
 });
 
+// NAMESPACE OBJECT: ./src/private/copilot/sidePanelInterfaces.ts
+var sidePanelInterfaces_namespaceObject = {};
+__webpack_require__.r(sidePanelInterfaces_namespaceObject);
+__webpack_require__.d(sidePanelInterfaces_namespaceObject, {
+  ContentItemType: () => (ContentItemType),
+  MediaSelectionType: () => (MediaSelectionType),
+  SidePanelErrorCode: () => (SidePanelErrorCode),
+  SidePanelErrorImpl: () => (SidePanelErrorImpl),
+  UserConsent: () => (UserConsent)
+});
+
+// NAMESPACE OBJECT: ./src/private/copilot/sidePanel.ts
+var sidePanel_namespaceObject = {};
+__webpack_require__.r(sidePanel_namespaceObject);
+__webpack_require__.d(sidePanel_namespaceObject, {
+  copilotSidePanelNotSupportedOnPlatformError: () => (copilotSidePanelNotSupportedOnPlatformError),
+  getContent: () => (getContent),
+  isResponseAReportableError: () => (isResponseAReportableError),
+  isSupported: () => (sidePanel_isSupported),
+  preCheckUserConsent: () => (preCheckUserConsent),
+  registerUserActionContentSelect: () => (registerUserActionContentSelect)
+});
+
 // NAMESPACE OBJECT: ./src/private/copilot/copilot.ts
 var copilot_namespaceObject = {};
 __webpack_require__.r(copilot_namespaceObject);
 __webpack_require__.d(copilot_namespaceObject, {
   customTelemetry: () => (customTelemetry_namespaceObject),
-  eligibility: () => (eligibility_namespaceObject)
+  eligibility: () => (eligibility_namespaceObject),
+  sidePanel: () => (sidePanel_namespaceObject)
 });
 
 // NAMESPACE OBJECT: ./src/private/externalAppAuthentication.ts
@@ -1863,7 +1888,7 @@ __webpack_require__.d(search_namespaceObject, {
 var history_namespaceObject = {};
 __webpack_require__.r(history_namespaceObject);
 __webpack_require__.d(history_namespaceObject, {
-  getContent: () => (getContent),
+  getContent: () => (history_getContent),
   isSupported: () => (history_isSupported)
 });
 
@@ -4355,6 +4380,11 @@ const upgradeChain = [
         },
     },
 ];
+/**
+ * This version is for legacy Teams mobile clients that don’t pass a runtime object during initialization.
+ * It’s the minimum version required to support deeply nested app auth.
+ */
+const legacyTeamsMobileVersionForDeeplyNestedAuth = '2.1.2';
 /**
  * This structure is used for versions of Teams that don't pass a runtime object during initialization.
  * Please see the extensive comments in versionAndPlatformAgnosticTeamsRuntimeConfig for more information
@@ -4422,6 +4452,10 @@ const mapTeamsVersionToSupportedCapabilities = {
             hostClientTypes: [HostClientType.android, HostClientType.ios, HostClientType.ipados, HostClientType.visionOS],
         },
     ],
+    '2.1.2': [
+    // isDeeplyNestedAuthSupported: true (based on const legacyTeamsMobileVersionForDeeplyNestedAuth)
+    // for hostClientTypes: [HostClientType.android, HostClientType.ios, HostClientType.ipados, HostClientType.visionOS]
+    ],
 };
 const generateBackCompatRuntimeConfigLogger = runtimeLogger.extend('generateBackCompatRuntimeConfig');
 /**
@@ -4551,7 +4585,7 @@ function isSerializable(arg) {
  * @hidden
  *  Package version.
  */
-const version = "2.38.0-beta.0";
+const version = "2.39.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.
@@ -9384,10 +9418,238 @@ function isEligibilityInfoValid(eligibilityInfo) {
     return true;
 }
 
+;// ./src/private/copilot/sidePanelInterfaces.ts
+/**
+ * @hidden
+ *
+ * Interface for content data
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+var ContentItemType;
+(function (ContentItemType) {
+    ContentItemType["EMAIL"] = "email";
+    ContentItemType["TEXT"] = "text";
+    ContentItemType["MEDIA"] = "media";
+    ContentItemType["CALENDAR_INVITE"] = "calendarInvite";
+    ContentItemType["WEB_PAGE"] = "webPage";
+    ContentItemType["MIXED"] = "mixed";
+})(ContentItemType || (ContentItemType = {}));
+/**
+ * @hidden
+ *
+ * Enum for media selection types
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+var MediaSelectionType;
+(function (MediaSelectionType) {
+    MediaSelectionType["IMAGE"] = "image";
+    MediaSelectionType["AUDIO"] = "audio";
+    MediaSelectionType["VIDEO"] = "video";
+})(MediaSelectionType || (MediaSelectionType = {}));
+/**
+ * @hidden
+ *
+ * Enum representing possible user consent states.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+var UserConsent;
+(function (UserConsent) {
+    UserConsent["Accepted"] = "accepted";
+    UserConsent["NotAccepted"] = "not_accepted";
+})(UserConsent || (UserConsent = {}));
+/**
+ * @hidden
+ *
+ * Type for user action handler functions that receive content data.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+var SidePanelErrorCode;
+(function (SidePanelErrorCode) {
+    SidePanelErrorCode["ConsentNotAccepted"] = "consent_not_accepted";
+    SidePanelErrorCode["PageContentBlockedPolicy"] = "page_content_blocked_policy";
+    SidePanelErrorCode["PageContentBlockedDlp"] = "page_content_blocked_dlp";
+    SidePanelErrorCode["PageContentTypeNotSupportedYet"] = "page_content_type_not_supported_yet";
+    SidePanelErrorCode["PageContentSizeNotSupported"] = "page_content_size_not_supported";
+    SidePanelErrorCode["PageContextChanged"] = "page_context_changed";
+    SidePanelErrorCode["PageContentExtractionFailed"] = "page_content_extraction_failed";
+    SidePanelErrorCode["PageContentSizeNotSupportedPDF"] = "page_content_size_not_supported_pdf";
+    SidePanelErrorCode["NotSupportedOnPlatform"] = "not_supported_on_platform";
+    SidePanelErrorCode["OtherError"] = "other_error";
+})(SidePanelErrorCode || (SidePanelErrorCode = {}));
+/**
+ * @hidden
+ * @beta
+ * Implementation of the SidePanelError interface.
+ * This class extends the built-in Error class and includes an error code.
+ * It is used to represent errors that occur during side panel operations.
+ * The error code can be one of the SidePanelErrorCode values or a general ErrorCode.
+ */
+class SidePanelErrorImpl extends Error {
+    constructor(errorCode, message) {
+        super(message);
+        this.errorCode = errorCode;
+        this.name = 'SidePanelError';
+    }
+}
+
+;// ./src/private/copilot/sidePanel.ts
+/**
+ * @beta
+ * @hidden
+ * User information required by specific apps
+ * @internal
+ * Limited to Microsoft-internal use
+ * @module
+ */
+var sidePanel_awaiter = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+
+
+
+
+
+
+
+
+
+const sidePanel_copilotTelemetryVersionNumber = "v2" /* ApiVersionNumber.V_2 */;
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ * @beta
+ * @returns boolean to represent whether copilot.sidePanel capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ */
+function sidePanel_isSupported() {
+    var _a;
+    return ensureInitialized(runtime) && !!((_a = runtime.supports.copilot) === null || _a === void 0 ? void 0 : _a.sidePanel);
+}
+/**
+ * @beta
+ * @hidden
+ * Determines if the provided error object is an instance of SidePanelError or SdkError.
+ * @internal
+ * Limited to Microsoft-internal use
+ * @param err The error object to check whether it is of SidePanelError type
+ */
+function isResponseAReportableError(err) {
+    if (typeof err !== 'object' || err === null) {
+        return false;
+    }
+    const error = err;
+    return ((Object.values(SidePanelErrorCode).includes(error.errorCode) &&
+        (error.message === undefined || typeof error.message === 'string')) ||
+        isSdkError(err) // If the error is an SdkError, it can be considered a SidePanelError
+    );
+}
+/**
+ * Get user content data from the hub to send to copilot app.
+ *
+ * @returns { Promise<Content> } - promise resolves with a content object containing user content data
+ * @throws { SidePanelError | SdkError } - Throws a SidePanelError or SdkError if host SDK returns an error as a response to this call
+ *
+ * @hidden
+ * @beta
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function getContent(request) {
+    return sidePanel_awaiter(this, void 0, void 0, function* () {
+        ensureInitialized(runtime);
+        const input = request ? [new SerializableContentRequest(request)] : [];
+        return callFunctionInHostAndHandleResponse("copilot.sidePanel.getContent" /* ApiName.Copilot_SidePanel_GetContent */, input, new GetContentResponseHandler(), getApiVersionTag(sidePanel_copilotTelemetryVersionNumber, "copilot.sidePanel.getContent" /* ApiName.Copilot_SidePanel_GetContent */), isResponseAReportableError);
+    });
+}
+/**
+ * When the copilot detects a contextual query it gets the user consent status before making the getContent call.
+ *
+ * @returns { Promise<PreCheckContextResponse> } - promise resolves with a content object containing user content data
+ * @throws { SidePanelError | SdkError } - Throws a SidePanelError or SdkError if host SDK returns an error as a response to this call
+ *
+ * @hidden
+ * @beta
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function preCheckUserConsent() {
+    return sidePanel_awaiter(this, void 0, void 0, function* () {
+        ensureInitialized(runtime);
+        return callFunctionInHostAndHandleResponse("copilot.sidePanel.preCheckUserConsent" /* ApiName.Copilot_SidePanel_PreCheckUserConsent */, [], new PreCheckContextResponseHandler(), getApiVersionTag(sidePanel_copilotTelemetryVersionNumber, "copilot.sidePanel.preCheckUserConsent" /* ApiName.Copilot_SidePanel_PreCheckUserConsent */), isResponseAReportableError);
+    });
+}
+/**
+ * @hidden
+ * @beta
+ * Registers a handler to get updated content data from the hub to send to copilot app.
+ * This handler will be called when the user selects content in the application.
+ * @param handler - The handler for getting user action content select.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function registerUserActionContentSelect(handler) {
+    registerHandlerHelper(getApiVersionTag(sidePanel_copilotTelemetryVersionNumber, "copilot.sidePanel.registerUserActionContentSelect" /* ApiName.Copilot_SidePanel_RegisterUserActionContentSelect */), 'copilot.sidePanel.userActionContentSelect', handler, [FrameContexts.content], () => {
+        if (!sidePanel_isSupported()) {
+            throw copilotSidePanelNotSupportedOnPlatformError;
+        }
+    });
+}
+/**
+ * @hidden
+ * @beta
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * Error thrown when the copilot side panel API is not supported on the current platform.
+ */
+const copilotSidePanelNotSupportedOnPlatformError = new SidePanelErrorImpl(SidePanelErrorCode.NotSupportedOnPlatform, 'This API is not supported on the current platform.');
+class GetContentResponseHandler extends ResponseHandler {
+    validate(response) {
+        return response !== null && typeof response === 'object';
+    }
+    deserialize(response) {
+        return response;
+    }
+}
+class PreCheckContextResponseHandler extends ResponseHandler {
+    validate(response) {
+        return response !== null && typeof response === 'object';
+    }
+    deserialize(response) {
+        return response;
+    }
+}
+class SerializableContentRequest {
+    constructor(contentRequest) {
+        this.contentRequest = contentRequest;
+    }
+    serialize() {
+        return this.contentRequest;
+    }
+}
+
 ;// ./src/private/copilot/copilot.ts
 
 
 
+
 
 ;// ./src/private/externalAppAuthentication.ts
 /**
@@ -13533,6 +13795,8 @@ function serializeValidSize(size) {
 
 
 
+
+
 
 
 
@@ -14982,7 +15246,16 @@ function canParentManageNAATrustedOrigins() {
  */
 function isDeeplyNestedAuthSupported() {
     var _a;
-    return (_a = (ensureInitialized(runtime) && runtime.isDeeplyNestedAuthSupported)) !== null && _a !== void 0 ? _a : false;
+    return ((_a = (ensureInitialized(runtime) &&
+        (runtime.isDeeplyNestedAuthSupported || isDeeplyNestedAuthSupportedForLegacyTeamsMobile()))) !== null && _a !== void 0 ? _a : false);
+}
+function isDeeplyNestedAuthSupportedForLegacyTeamsMobile() {
+    return ensureInitialized(runtime) &&
+        isHostAndroidOrIOSOrIPadOSOrVisionOS() &&
+        runtime.isLegacyTeams &&
+        isCurrentSDKVersionAtLeast(legacyTeamsMobileVersionForDeeplyNestedAuth)
+        ? true
+        : false;
 }
 function isNAAChannelRecommendedForLegacyTeamsMobile() {
     return ensureInitialized(runtime) &&
@@ -16961,7 +17234,7 @@ const sharingTelemetryVersionNumber_v2 = "v2" /* ApiVersionNumber.V_2 */;
  *
  * @beta
  */
-function getContent() {
+function history_getContent() {
     return history_awaiter(this, void 0, void 0, function* () {
         ensureInitialized(runtime, FrameContexts.sidePanel, FrameContexts.meetingStage);
         if (!history_isSupported()) {