Merge branch 'main' into lakhveer/eligibility

OfficeDev · Nov 21, 2024 · ad12899 · ad12899
2 parents b867727 + 73a6890
commit ad12899
Show file tree

Hide file tree

Showing 26 changed files with 443 additions and 100 deletions.
diff --git a/apps/teams-test-app/index_cdn.html b/apps/teams-test-app/index_cdn.html
@@ -15,8 +15,8 @@
   <body>
     <noscript>You need to enable JavaScript to run this app.</noscript>
     <script
-      src="https://res.cdn.office.net/teams-js/2.31.0/js/MicrosoftTeams.min.js"
-      integrity="sha384-A2y7iMKbK0AQrgKq1YKcLB8XgtyowB2MPzC40KFfA58nQObf6xU3C5NE0cTcis0V"
+      src="https://res.cdn.office.net/teams-js/2.31.1/js/MicrosoftTeams.min.js"
+      integrity="sha384-ihAqYgEJz9hzEU+HaYodG1aTzjebC/wKXQi1nWKZG7OLAUyOL9ZrzD/SfZu79Jeu"
       crossorigin="anonymous"
     ></script>
     <div id="root"></div>

diff --git a/apps/teams-test-app/package.json b/apps/teams-test-app/package.json
@@ -3,7 +3,7 @@
   "private": true,
   "author": "Microsoft Teams",
   "description": "Teams Test App utilizing Teams JavaScript client SDK to test Hosts",
-  "version": "2.31.0",
+  "version": "2.31.1",
   "scripts": {
     "build": "pnpm build:bundle",
     "build:bundle": "pnpm lint && webpack",

diff --git a/apps/teams-test-app/src/components/OtherAppStateChangeAPIs.tsx b/apps/teams-test-app/src/components/OtherAppStateChangeAPIs.tsx
@@ -1,4 +1,4 @@
-import { otherAppStateChange } from '@microsoft/teams-js';
+import { AppId, otherAppStateChange } from '@microsoft/teams-js';
 import React, { ReactElement } from 'react';
 
 import { ApiWithoutInput } from './utils';
@@ -39,12 +39,23 @@ const UnregisterAppInstallHandler = (): React.ReactElement =>
     },
   });
 
+const NotifyInstallCompletedHandler = (): React.ReactElement =>
+  ApiWithoutInput({
+    name: 'otherAppStateChange_notifyInstallCompleted',
+    title: 'Notify Install Completed',
+    onClick: async () => {
+      otherAppStateChange.notifyInstallCompleted(new AppId('12345'));
+      return 'notified';
+    },
+  });
+
 const OtherAppStateChangedAPIs = (): ReactElement => (
   <>
     <ModuleWrapper title="OtherAppStateChanged">
       <CheckOtherAppStateChangeCapability />
       <RegisterAppInstallHandler />
       <UnregisterAppInstallHandler />
+      <NotifyInstallCompletedHandler />
     </ModuleWrapper>
   </>
 );

diff --git a/apps/teams-test-app/src/components/StoreApis.tsx b/apps/teams-test-app/src/components/StoreApis.tsx
@@ -0,0 +1,61 @@
+import { AppId, store } from '@microsoft/teams-js';
+import { ReactElement } from 'react';
+import React from 'react';
+
+import { ApiWithoutInput, ApiWithTextInput } from './utils';
+import { ModuleWrapper } from './utils/ModuleWrapper';
+
+const StoreAPIs = (): ReactElement => {
+  const CheckStoreCapability = (): ReactElement =>
+    ApiWithoutInput({
+      name: 'checkCapabilityStore',
+      title: 'Check Capability Store',
+      onClick: async () => {
+        if (store.isSupported()) {
+          return 'Store module is supported';
+        } else {
+          return 'Store module is not supported';
+        }
+      },
+    });
+
+  const OpenStore = (): ReactElement =>
+    ApiWithTextInput<{ dialogType: string; appId?: string; collectionId?: string }>({
+      name: 'storeOpen',
+      title: 'Store Open',
+      onClick: {
+        validateInput: (input) => {
+          if (input?.dialogType === undefined) {
+            throw new Error('store type undefined');
+          }
+        },
+        submit: async (input) => {
+          const appId = input.appId === undefined ? undefined : new AppId(input.appId);
+          const openStoreParam = {
+            dialogType: input.dialogType,
+            appId: appId,
+            collectionId: input.collectionId,
+          };
+          // eslint-disable-next-line no-useless-catch
+          try {
+            await store.openStoreExperience(openStoreParam as store.OpenStoreParams);
+            return 'store opened';
+          } catch (e) {
+            throw e;
+          }
+        },
+      },
+      defaultInput: JSON.stringify({
+        dialogType: 'appdetail',
+        appId: '1542629c-01b3-4a6d-8f76-1938b779e48d',
+      }),
+    });
+  return (
+    <ModuleWrapper title="Store">
+      <CheckStoreCapability />
+      <OpenStore />
+    </ModuleWrapper>
+  );
+};
+
+export default StoreAPIs;
diff --git a/apps/teams-test-app/src/pages/TestApp.tsx b/apps/teams-test-app/src/pages/TestApp.tsx
@@ -60,6 +60,7 @@ import SecondaryBrowserAPIs from '../components/SecondaryBrowserAPIs';
 import SharingAPIs from '../components/SharingAPIs';
 import StageViewAPIs from '../components/StageViewAPIs';
 import StageViewSelfAPIs from '../components/StageViewSelfAPIs';
+import StoreAPIs from '../components/StoreApis';
 import TeamsCoreAPIs from '../components/TeamsCoreAPIs';
 import ThirdPartyCloudStorageAPIs from '../components/ThirdPartyCloudStorageAPIs';
 import CookieAccessComponent from '../components/ThirdPatryCookies';
@@ -163,6 +164,7 @@ export const TestApp: React.FC = () => {
       { name: 'VideoAPIs', component: <VideoAPIs /> },
       { name: 'VideoExAPIs', component: <VideoExAPIs /> },
       { name: 'VisualMediaAPIs', component: <VisualMediaAPIs /> },
+      { name: 'StoreAPIs', component: <StoreAPIs /> },
     ],
     [],
   );

diff --git a/apps/typed-dependency-tester/.eslintrc.js b/apps/typed-dependency-tester/.eslintrc.js
diff --git a/apps/typed-dependency-tester/README.md b/apps/typed-dependency-tester/README.md
diff --git a/apps/typed-dependency-tester/package.json b/apps/typed-dependency-tester/package.json
diff --git a/apps/typed-dependency-tester/tsconfig.json b/apps/typed-dependency-tester/tsconfig.json
diff --git a/apps/typed-dependency-tester/tsconfig.strictNullChecks.json b/apps/typed-dependency-tester/tsconfig.strictNullChecks.json
diff --git a/change/@microsoft-teams-js-07829a41-a760-48a1-a793-df938ea61c13.json b/change/@microsoft-teams-js-07829a41-a760-48a1-a793-df938ea61c13.json
@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Added `store` capability that will enable user to open several types of app store dialogs.. The capability is still awaiting support in one or most host applications. To track availability of this capability across different hosts see https://aka.ms/capmatrix",
+  "packageName": "@microsoft/teams-js",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}
diff --git a/change/@microsoft-teams-js-424ccfee-e9f3-4b6b-bf1b-5e861422eb1b.json b/change/@microsoft-teams-js-424ccfee-e9f3-4b6b-bf1b-5e861422eb1b.json
diff --git a/change/@microsoft-teams-js-4a860473-7a5b-481e-890b-4132b304af2e.json b/change/@microsoft-teams-js-4a860473-7a5b-481e-890b-4132b304af2e.json
diff --git a/change/@microsoft-teams-js-818caaaa-86eb-4e3d-a84a-0d61028d0307.json b/change/@microsoft-teams-js-818caaaa-86eb-4e3d-a84a-0d61028d0307.json
diff --git a/change/@microsoft-teams-js-c78bd0b1-8288-4e22-bd89-252a1218ba5d.json b/change/@microsoft-teams-js-c78bd0b1-8288-4e22-bd89-252a1218ba5d.json
@@ -0,0 +1,7 @@
+{
+  "type": "none",
+  "comment": "Released 2.31.1",
+  "packageName": "@microsoft/teams-js",
+  "email": "[email protected]",
+  "dependentChangeType": "none"
+}
diff --git a/change/@microsoft-teams-js-e65fa5c8-93f1-4296-b6e3-c44e178f9fca.json b/change/@microsoft-teams-js-e65fa5c8-93f1-4296-b6e3-c44e178f9fca.json
diff --git a/packages/teams-js/CHANGELOG.md b/packages/teams-js/CHANGELOG.md
@@ -1,9 +1,18 @@
 # Change Log - @microsoft/teams-js
 
-This log was last generated on Wed, 13 Nov 2024 19:22:01 GMT and should not be manually modified.
+This log was last generated on Wed, 20 Nov 2024 19:25:55 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 2.31.1
+
+Wed, 20 Nov 2024 19:25:55 GMT
+
+### Patches
+
+- Fixed a bug causing `buffer` polyfill to stil be included
+- Fixed bugs regarding `EduType`not being exported, and enum typings
+
 ## 2.31.0
 
 Wed, 13 Nov 2024 19:22:01 GMT

diff --git a/packages/teams-js/README.md b/packages/teams-js/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.31.0/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.31.1/js/MicrosoftTeams.min.js) or point your package manager at them.
 
 ## Usage
 
@@ -45,13 +45,13 @@ Reference the library inside of your `.html` page using:
 ```html
 <!-- Microsoft Teams JavaScript API (via CDN) -->
 <script
-  src="https://res.cdn.office.net/teams-js/2.31.0/js/MicrosoftTeams.min.js"
-  integrity="sha384-A2y7iMKbK0AQrgKq1YKcLB8XgtyowB2MPzC40KFfA58nQObf6xU3C5NE0cTcis0V"
+  src="https://res.cdn.office.net/teams-js/2.31.1/js/MicrosoftTeams.min.js"
+  integrity="sha384-ihAqYgEJz9hzEU+HaYodG1aTzjebC/wKXQi1nWKZG7OLAUyOL9ZrzD/SfZu79Jeu"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/[email protected].0/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/[email protected].1/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

diff --git a/packages/teams-js/package.json b/packages/teams-js/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@microsoft/teams-js",
   "author": "Microsoft Teams",
-  "version": "2.31.0",
+  "version": "2.31.1",
   "description": "Microsoft Client SDK for building app for Microsoft hosts",
   "repository": {
     "directory": "packages/teams-js",

diff --git a/packages/teams-js/src/internal/telemetry.ts b/packages/teams-js/src/internal/telemetry.ts
@@ -233,6 +233,7 @@ export const enum ApiName {
   Notifications_ShowNotification = 'notifications.showNotification',
   OtherAppStateChange_Install = 'otherApp.install',
   OtherAppStateChange_UnregisterInstall = 'otherApp.unregisterInstall',
+  OtherAppStateChange_NotifyInstallCompleted = 'otherApp.notifyInstallCompleted',
   Pages_AppButton_OnClick = 'pages.appButton.onClick',
   Pages_AppButton_OnHoverEnter = 'pages.appButton.onHoverEnter',
   Pages_AppButton_OnHoverLeave = 'pages.appButton.onHoverLeave',
@@ -322,6 +323,7 @@ export const enum ApiName {
   Sharing_ShareWebContent = 'sharing.shareWebContent',
   StageView_Open = 'stageView.open',
   StageView_Self_Close = 'stageView.self.close',
+  Store_Open = 'store.open',
   Tasks_StartTask = 'tasks.startTask',
   Tasks_SubmitTask = 'tasks.submitTask',
   Tasks_UpdateTask = 'tasks.updateTask',

diff --git a/packages/teams-js/src/private/index.ts b/packages/teams-js/src/private/index.ts
@@ -38,3 +38,4 @@ export * as appEntity from './appEntity';
 export * as teams from './teams/teams';
 export * as videoEffectsEx from './videoEffectsEx';
 export * as hostEntity from './hostEntity/hostEntity';
+export * as store from './store';
diff --git a/packages/teams-js/src/private/otherAppStateChange.ts b/packages/teams-js/src/private/otherAppStateChange.ts
@@ -10,11 +10,12 @@
  * when another application has been installed.
  */
 
-import { sendMessageToParent } from '../internal/communication';
+import { callFunctionInHost, sendMessageToParent } from '../internal/communication';
 import { registerHandler, removeHandler } from '../internal/handlers';
 import { ensureInitialized } from '../internal/internalAPIs';
 import { ApiName, ApiVersionNumber, getApiVersionTag } from '../internal/telemetry';
 import { isNullOrUndefined } from '../internal/typeCheckUtilities';
+import { AppId } from '../public/appId';
 import { ErrorCode } from '../public/interfaces';
 import { runtime } from '../public/runtime';
 
@@ -112,6 +113,30 @@ export function unregisterAppInstallationHandler(): void {
   removeHandler(ApiName.OtherAppStateChange_Install);
 }
 
+/**
+ * @hidden
+ * @beta
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * This function should be called by the Store App to notify the host that the
+ * app with the given appId has been installed.
+ *
+ * @throws Error if {@link app.initialize} has not successfully completed or if the platform
+ * does not support the otherAppStateChange capability.
+ */
+export function notifyInstallCompleted(appId: AppId): Promise<void> {
+  if (!isSupported()) {
+    throw new Error(ErrorCode.NOT_SUPPORTED_ON_PLATFORM.toString());
+  }
+
+  return callFunctionInHost(
+    ApiName.OtherAppStateChange_NotifyInstallCompleted,
+    [appId.toString()],
+    getApiVersionTag(otherAppStateChangeTelemetryVersionNumber, ApiName.OtherAppStateChange_NotifyInstallCompleted),
+  );
+}
+
 /**
  * Checks if the otherAppStateChange capability is supported by the host
  * @returns boolean to represent whether the otherAppStateChange capability is supported