@microsoft/teams-js 2.26.0 → 2.27.0-beta.0

package/dist/MicrosoftTeams.d.ts

@@ -488,6 +488,45 @@ export namespace conversations {
         function isSupported(): boolean;
 }
 
+/**
+    * @beta
+    * @hidden
+    * Namespace to delegate copilot app specific APIs
+    * @internal
+    * Limited to Microsoft-internal use
+    */
+export namespace copilot {
+        /**
+            * @beta
+            * @hidden
+            * User information required by specific apps
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        namespace eligibility {
+                /**
+                    * @hidden
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    * @beta
+                    * @returns boolean to represent whether copilot.eligibility capability is supported
+                    *
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed
+                    */
+                function isSupported(): boolean;
+                /**
+                    * @hidden
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    * @beta
+                    * @returns the copilot eligibility information about the user
+                    *
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed
+                    */
+                function getEligibilityInfo(): AppEligibilityInformation;
+        }
+}
+
 /**
     * @hidden
     * Namespace to delegate authentication and message extension requests to the host
@@ -4501,6 +4540,7 @@ export enum DevicePermission {
 /** @hidden */
 export interface HostVersionsInfo {
         adaptiveCardSchemaVersion?: AdaptiveCardVersion;
+        appEligibilityInformation?: AppEligibilityInformation;
 }
 /**
     * Represents the major and minor versions of the Adaptive Card schema in the current host
@@ -4511,6 +4551,146 @@ export interface AdaptiveCardVersion {
         /** Represents the minor version number. */
         minorVersion: number;
 }
+/**
+    * @hidden
+    * Eligibility Information for the app user.
+    *
+    * @beta
+    */
+export interface AppEligibilityInformation {
+        /**
+            * Describes the user’s age group, which can have implications on which product they are able to use.
+            */
+        ageGroup: LegalAgeGroupClassification | null;
+        /**
+            * Describes the user’s chat experience based on their eligible licenses & their tenant’s eligible licenses.
+            * A user will be in at most one cohort.
+            */
+        cohort: Cohort | null;
+        /**
+            * Indicates that the user is eligible for Microsoft Entra ID Authenticated Copilot experience.
+            */
+        isCopilotEligible: boolean;
+        /**
+            * Implementation may change to be based on tenant-home region rather than IP.
+            */
+        isCopilotEnabledRegion: boolean;
+        /**
+            * Indicates if the tenant admin has opted the user out of Copilot.
+            */
+        isOptedOutByAdmin: boolean;
+        /**
+            * Education Eligibility Information for the app user
+            */
+        userClassification: UserClassification;
+}
+/**
+    * @hidden
+    *
+    * @beta
+    */
+export interface UserClassificationWithEduType {
+        /**
+            * For EDU tenants only. Indicates if the tenant is higher ed or K12.
+            */
+        eduType: EduType;
+        /**
+            * Describes additional traits of the user that contribute to FRE experience, etc.
+            */
+        persona: Persona.Faculty | Persona.Student;
+}
+/**
+    * @hidden
+    *
+    * @beta
+    */
+export interface UserClassificationWithOtherType {
+        persona: Persona.Other;
+}
+/**
+    * @hidden
+    *
+    * @beta
+    */
+export type UserClassification = UserClassificationWithEduType | UserClassificationWithOtherType;
+/**
+    * @hidden
+    *
+    * @beta
+    */
+export enum Cohort {
+        BCAIS = "bcais",
+        BCWAF = "bcwaf",
+        BCWBF = "bcwbf"
+}
+/**
+    * @hidden
+    *
+    * @beta
+    */
+export enum Persona {
+        /**
+            * User has a faculty license
+            */
+        Faculty = "faculty",
+        /**
+            * User has a student license
+            */
+        Student = "student",
+        /**
+            * When user is not a faculty or student
+            */
+        Other = "other"
+}
+/**
+    * @hidden
+    *
+    * @beta
+    */
+export enum LegalAgeGroupClassification {
+        /**
+            * The user is considered an adult based on the age-related regulations of their country or region.
+            */
+        Adult = "adult",
+        /**
+            * The user is a minor but is from a country or region that has no age-related regulations.
+            */
+        MinorNoParentalConsentRequired = "minorNoParentalConsentRequired",
+        /**
+            * Reserved for future use
+            */
+        MinorWithoutParentalConsent = "minorWithoutParentalConsent",
+        /**
+            * The user is considered a minor based on the age-related regulations of their country or region, and the administrator
+            * of the account obtained appropriate consent from a parent or guardian.
+            */
+        MinorWithParentalConsent = "minorWithParentalConsent",
+        /**
+            * The user is from a country or region that has additional age-related regulations, such as the United States,
+            * United Kingdom, European Union, or South Korea, and the user's age is between a minor and an adult age
+            * (as stipulated based on country or region). Generally, this means that teenagers are considered as notAdult in regulated countries.
+            */
+        NonAdult = "nonAdult"
+}
+/**
+    * @hidden
+    *
+    * @beta
+    */
+export enum EduType {
+        /**
+            * User is from a tenant labeled as “HigherEd”
+            */
+        HigherEducation = "higherEducation",
+        /**
+            * User is from a tenant labeled as “K12”
+            */
+        K12 = "k12",
+        /**
+            * User is from a tenant labeled as “Others” (e.g. research institutions)
+            */
+        Other = "other"
+}
 /**
     * Currently supported Mime type
     */
@@ -9111,6 +9291,7 @@ export namespace webStorage {
             */
         function isSupported(): boolean;
 }
+export function clearWebStorageCachedHostNameForTests(): void;
 
 /**
     * Used to interact with call functionality, including starting calls with other users.

package/dist/MicrosoftTeams.js

@@ -1019,6 +1019,7 @@ __webpack_require__.d(__webpack_exports__, {
   chat: () => (/* reexport */ chat),
   clipboard: () => (/* reexport */ clipboard),
   conversations: () => (/* reexport */ conversations),
+  copilot: () => (/* reexport */ copilot),
   dialog: () => (/* reexport */ dialog),
   enablePrintCapability: () => (/* reexport */ enablePrintCapability),
   executeDeepLink: () => (/* reexport */ executeDeepLink),
@@ -2376,6 +2377,89 @@ var DevicePermission;
     DevicePermission["GeoLocation"] = "geolocation";
     DevicePermission["Media"] = "media";
 })(DevicePermission || (DevicePermission = {}));
+/**
+ * @hidden
+ *
+ * @beta
+ */
+var Cohort;
+(function (Cohort) {
+    Cohort["BCAIS"] = "bcais";
+    Cohort["BCWAF"] = "bcwaf";
+    Cohort["BCWBF"] = "bcwbf";
+})(Cohort || (Cohort = {}));
+/**
+ * @hidden
+ *
+ * @beta
+ */
+var Persona;
+(function (Persona) {
+    /**
+     * User has a faculty license
+     */
+    Persona["Faculty"] = "faculty";
+    /**
+     * User has a student license
+     */
+    Persona["Student"] = "student";
+    /**
+     * When user is not a faculty or student
+     */
+    Persona["Other"] = "other";
+})(Persona || (Persona = {}));
+/**
+ * @hidden
+ *
+ * @beta
+ */
+// https://learn.microsoft.com/en-us/graph/api/resources/user?view=graph-rest-1.0#legalagegroupclassification-values
+var LegalAgeGroupClassification;
+(function (LegalAgeGroupClassification) {
+    /**
+     * The user is considered an adult based on the age-related regulations of their country or region.
+     */
+    LegalAgeGroupClassification["Adult"] = "adult";
+    /**
+     * The user is a minor but is from a country or region that has no age-related regulations.
+     */
+    LegalAgeGroupClassification["MinorNoParentalConsentRequired"] = "minorNoParentalConsentRequired";
+    /**
+     * Reserved for future use
+     */
+    LegalAgeGroupClassification["MinorWithoutParentalConsent"] = "minorWithoutParentalConsent";
+    /**
+     * The user is considered a minor based on the age-related regulations of their country or region, and the administrator
+     * of the account obtained appropriate consent from a parent or guardian.
+     */
+    LegalAgeGroupClassification["MinorWithParentalConsent"] = "minorWithParentalConsent";
+    /**
+     * The user is from a country or region that has additional age-related regulations, such as the United States,
+     * United Kingdom, European Union, or South Korea, and the user's age is between a minor and an adult age
+     * (as stipulated based on country or region). Generally, this means that teenagers are considered as notAdult in regulated countries.
+     */
+    LegalAgeGroupClassification["NonAdult"] = "nonAdult";
+})(LegalAgeGroupClassification || (LegalAgeGroupClassification = {}));
+/**
+ * @hidden
+ *
+ * @beta
+ */
+var EduType;
+(function (EduType) {
+    /**
+     * User is from a tenant labeled as “HigherEd”
+     */
+    EduType["HigherEducation"] = "higherEducation";
+    /**
+     * User is from a tenant labeled as “K12”
+     */
+    EduType["K12"] = "k12";
+    /**
+     * User is from a tenant labeled as “Others” (e.g. research institutions)
+     */
+    EduType["Other"] = "other";
+})(EduType || (EduType = {}));
 /**
  * Currently supported Mime type
  */
@@ -3087,6 +3171,26 @@ function isRuntimeInitialized(runtime) {
     }
 }
 let runtime = _uninitializedRuntime;
+/**
+ * This object is used as the default runtime for versions of Teams which don't pass a runtime object during
+ * initialization. If the host DOES pass a runtime object during init, then this object is not used.
+ *
+ * In practice, this is used in Teams V1 and ALL versions of Teams mobile since they are the only hosts
+ * that don't pass a runtime object during initialization (since they don't use the host SDK).
+ *
+ * If there are certain versions of Teams V1 or Teams mobile which support a capability but not ALL
+ * versions, then you should modify the mapTeamsVersionToSupportedCapabilities structure for that purpose. That
+ * structure allows you to specify particular versions on particular platforms that support certain capabilities.
+ * This structure is version agnostic.
+ *
+ * In practice, if you are adding a new capability, you are likely only to need to update mapTeamsVersionToSupportedCapabilities
+ * and NOT this structure, as this structure is effectively only used for capabilities that have existed "forever."
+ *
+ * Remember that everything here all still ONLY applies to versions of Teams that don't pass a runtime object during
+ * initialization -- if they do, then neither this object nor the mapTeamsVersionToSupportedCapabilities structure is
+ * used -- all runtime capabilities are dynamically discovered at runtime in the case where the runtime object is passed
+ * during initialization.
+ */
 const versionAndPlatformAgnosticTeamsRuntimeConfig = {
     apiVersion: 4,
     isNAAChannelRecommended: false,
@@ -3225,6 +3329,11 @@ const upgradeChain = [
         },
     },
 ];
+/**
+ * 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
+ * on when and how to use this structure.
+ */
 const mapTeamsVersionToSupportedCapabilities = {
     // 1.0.0 just signifies "these capabilities have practically always been supported." For some of these
     // we don't know what the real first version that supported them was -- but it was long enough ago that
@@ -3395,7 +3504,7 @@ const _minRuntimeConfigToUninitialize = {
  * @hidden
  *  Package version.
  */
-const version = "2.26.0";
+const version = "2.27.0-beta.0";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -7818,6 +7927,62 @@ var conversations;
     conversations.isSupported = isSupported;
 })(conversations || (conversations = {}));
 
+;// CONCATENATED MODULE: ./src/private/copilot.ts
+
+
+
+/**
+ * @beta
+ * @hidden
+ * Namespace to delegate copilot app specific APIs
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+var copilot;
+(function (copilot) {
+    /**
+     * @beta
+     * @hidden
+     * User information required by specific apps
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    let eligibility;
+    (function (eligibility) {
+        /**
+         * @hidden
+         * @internal
+         * Limited to Microsoft-internal use
+         * @beta
+         * @returns boolean to represent whether copilot.eligibility capability is supported
+         *
+         * @throws Error if {@linkcode app.initialize} has not successfully completed
+         */
+        function isSupported() {
+            var _a;
+            return ensureInitialized(runtime) && !!((_a = runtime.hostVersionsInfo) === null || _a === void 0 ? void 0 : _a.appEligibilityInformation);
+        }
+        eligibility.isSupported = isSupported;
+        /**
+         * @hidden
+         * @internal
+         * Limited to Microsoft-internal use
+         * @beta
+         * @returns the copilot eligibility information about the user
+         *
+         * @throws Error if {@linkcode app.initialize} has not successfully completed
+         */
+        function getEligibilityInfo() {
+            ensureInitialized(runtime);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
+            return runtime.hostVersionsInfo.appEligibilityInformation;
+        }
+        eligibility.getEligibilityInfo = getEligibilityInfo;
+    })(eligibility = copilot.eligibility || (copilot.eligibility = {}));
+})(copilot || (copilot = {}));
+
 ;// CONCATENATED MODULE: ./src/private/externalAppAuthentication.ts
 
 
@@ -10812,6 +10977,7 @@ var videoEffectsEx;
 
 
 
+
 
 ;// CONCATENATED MODULE: ./src/internal/deepLinkConstants.ts
 /**
@@ -14251,6 +14417,8 @@ var webStorage_awaiter = (undefined && undefined.__awaiter) || function (thisArg
 
 
 
+
+
 /**
  * Contains functionality enabling apps to query properties about how the host manages web storage (`Window.LocalStorage`)
  *
@@ -14273,10 +14441,33 @@ var webStorage;
             if (!isSupported()) {
                 throw errorNotSupportedOnPlatform;
             }
+            if (runtime.isLegacyTeams &&
+                (GlobalVars.hostClientType === HostClientType.android ||
+                    GlobalVars.hostClientType === HostClientType.ios ||
+                    GlobalVars.hostClientType === HostClientType.ipados) &&
+                (yield getHostName()) === HostName.teams) {
+                // On Teams Mobile, they haven't yet implemented this capability. However, for compatibility reasons, we need
+                // to act as if they do. If they did implement it, they would return true, so that's what we do here.
+                // Getting Teams Mobile to implement this is a work-in-progress. Once they do implement it, we can remove this
+                // whole if-block. Until then, we cannot send the message to them because they will not understand it.
+                // Once they do implement it, this if-block will automatically not apply because runtime.isLegacyTeams will no
+                // longer be true. So, we don't need to worry about removing this if block "at the right time". We can
+                // just keep it here until Teams Mobile implements this capability and uses the host SDK everywhere, at which
+                // point we can remove this whole if-block at our leisure.
+                return true;
+            }
             return yield sendAndUnwrap(getApiVersionTag("v2" /* ApiVersionNumber.V_2 */, "webStorage.isWebStorageClearedOnUserLogOut" /* ApiName.WebStorage_IsWebStorageClearedOnUserLogOut */), "webStorage.isWebStorageClearedOnUserLogOut" /* ApiName.WebStorage_IsWebStorageClearedOnUserLogOut */);
         });
     }
     webStorage.isWebStorageClearedOnUserLogOut = isWebStorageClearedOnUserLogOut;
+    function getHostName() {
+        return webStorage_awaiter(this, void 0, void 0, function* () {
+            if (cachedHostName === null) {
+                cachedHostName = (yield app.getContext()).app.host.name;
+            }
+            return cachedHostName;
+        });
+    }
     /**
      * Checks if webStorage capability is supported by the host
      * @returns boolean to represent whether the webStorage capability is supported
@@ -14290,6 +14481,12 @@ var webStorage;
     }
     webStorage.isSupported = isSupported;
 })(webStorage || (webStorage = {}));
+// It is safe to cache the host name because the host cannot change at runtime
+let cachedHostName = null;
+// ...except during unit tests, where we will change it at runtime regularly for testing purposes
+function clearWebStorageCachedHostNameForTests() {
+    cachedHostName = null;
+}
 
 ;// CONCATENATED MODULE: ./src/public/call.ts