Added appId parameter to getContext

change/@microsoft-teams-js-07a56fbc-6d3e-474d-b3d9-6c6fe3a3be50.json

@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Added a new parameter to getContext() API called internalAppId for Internal App ID",
+  "packageName": "@microsoft/teams-js",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

packages/teams-js/src/public/app.ts

@@ -354,6 +354,11 @@ export namespace app {
      * ID for the current visible app which is different for across cached sessions. Used for correlating telemetry data.
      */
     appLaunchId?: string;
+
+    /**
+     * Internal app id that is used by Hosts to distinguish between different apps sideloaded or in store
+     */
+    internalAppId?: string;
   }
 
   /**
@@ -1007,6 +1012,7 @@ function transformLegacyContextToAppContext(legacyContext: LegacyContext): app.C
         ringId: legacyContext.ringId,
       },
       appLaunchId: legacyContext.appLaunchId,
+      internalAppId: legacyContext.internalAppId,
     },
     page: {
       id: legacyContext.entityId,

packages/teams-js/src/public/interfaces.ts

@@ -757,6 +757,14 @@ export interface Context {
    * They help pre-fill the dialog with necessary information (`dialogParameters`) along with other details.
    */
   dialogParameters?: Record<string, string>;
+
+  /**
+   * @deprecated
+   * As of 2.0.0, please use {@link app.Context.internalAppId} instead
+   *
+   * Internal app id that is used by Hubs to distinguish between different apps sideloaded or in store
+   */
+  internalAppId?: string;
 }
 
 /** Represents the parameters used to share a deep link. */

packages/teams-js/test/public/app.spec.ts

@@ -563,6 +563,7 @@ describe('Testing app capability', () => {
             appLaunchId: 'appLaunchId',
             userDisplayName: 'someTestUser',
             teamSiteId: 'someSiteId',
+            internalAppId: 'someInternalAppId',
           };
 
           const expectedContext: app.Context = {
@@ -576,6 +577,7 @@ describe('Testing app capability', () => {
               userClickTime: 2222,
               userFileOpenPreference: FileOpenPreference.Inline,
               appLaunchId: 'appLaunchId',
+              internalAppId: 'someinternalAppId',
               host: {
                 name: HostName.orange,
                 clientType: HostClientType.web,
@@ -1430,6 +1432,7 @@ describe('Testing app capability', () => {
             appLaunchId: 'appLaunchId',
             userDisplayName: 'someTestUser',
             teamSiteId: 'someSiteId',
+            internalAppId: 'someinternalAppId',
           };
 
           const expectedContext: app.Context = {
@@ -1449,6 +1452,7 @@ describe('Testing app capability', () => {
                 ringId: 'someRingId',
               },
               appLaunchId: 'appLaunchId',
+              internalAppId: 'someinternalAppId',
             },
             page: {
               id: 'someEntityId',

packages/teams-js/test/public/publicAPIs.spec.ts

@@ -348,6 +348,7 @@ describe('MicrosoftTeams-publicAPIs', () => {
         appSessionId: 'appSessionId',
         appLaunchId: 'appLaunchId',
         meetingId: 'dummyMeetingId',
+        internalAppId: 'dummyInternalAppId',
       };
       getContext((context) => {
         Object.keys(expectedContext).forEach((e) => {