@microsoft/teams-js 2.5.0-beta.0 → 2.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,14 +1,14 @@
1
- # Microsoft Teams JavaScript client SDK
1
+ # Microsoft Teams JavaScript client library
2
2
 
3
- Welcome to the Teams JavaScript client SDK! For breaking changes, please refer to our [changelog](./CHANGELOG.md) in the current `<root>/packages/teams-js` directory.
3
+ Welcome to the Teams JavaScript client library! For breaking changes, please refer to our [changelog](./CHANGELOG.md) in the current `<root>/packages/teams-js` directory.
4
4
 
5
- This JavaScript library is part of the [Microsoft Teams developer platform](https://learn.microsoft.com/microsoftteams/platform/). See full [SDK reference documentation](https://learn.microsoft.com/javascript/api/overview/msteams-client?view=msteams-client-js-latest).
5
+ This JavaScript library is part of the [Microsoft Teams developer platform](https://learn.microsoft.com/microsoftteams/platform/). See full [library reference documentation](https://learn.microsoft.com/javascript/api/overview/msteams-client?view=msteams-client-js-latest).
6
6
 
7
7
  ## Getting Started
8
8
 
9
9
  See [instructions](../../README.md#Getting-Started) in the monorepo root for how to clone and build the repository.
10
10
 
11
- Whenever building or testing the Teams client SDK, you can run `yarn build` or `yarn test` from the packages/teams-js directory.
11
+ Whenever building or testing the Teams client library, you can run `yarn build` or `yarn test` from the packages/teams-js directory.
12
12
 
13
13
  ## Installation
14
14
 
@@ -24,7 +24,7 @@ To install the stable [version](https://learn.microsoft.com/javascript/api/overv
24
24
 
25
25
  ### Production
26
26
 
27
- You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.4.2/js/MicrosoftTeams.min.js) or point your package manager at them.
27
+ You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.5.0/js/MicrosoftTeams.min.js) or point your package manager at them.
28
28
 
29
29
  ## Usage
30
30
 
@@ -40,18 +40,18 @@ import { app } from '@microsoft/teams-js';
40
40
 
41
41
  ### As a script tag
42
42
 
43
- Reference the SDK inside of your `.html` page using:
43
+ Reference the library inside of your `.html` page using:
44
44
 
45
45
  ```html
46
46
  <!-- Microsoft Teams JavaScript API (via CDN) -->
47
47
  <script
48
- src="https://res.cdn.office.net/teams-js/2.4.2/js/MicrosoftTeams.min.js"
49
- integrity="sha384-M1BiuUWGXFEu6jscBr/dyRZl4uojmiT5eMSu50lpG3eUyacKjwXE0eWRa2ZIdOmQ"
48
+ src="https://res.cdn.office.net/teams-js/2.5.0/js/MicrosoftTeams.min.js"
49
+ integrity="sha384-0lOzlvRkoNWAcLkbUTuao6TaDa7zI7v+q2PUAm3lrMxUp43PFwf2kaQu7FYT9fjS"
50
50
  crossorigin="anonymous"
51
51
  ></script>
52
52
 
53
53
  <!-- Microsoft Teams JavaScript API (via npm) -->
54
- <script src="node_modules/@microsoft/teams-js@2.4.2/dist/MicrosoftTeams.min.js"></script>
54
+ <script src="node_modules/@microsoft/teams-js@2.5.0/dist/MicrosoftTeams.min.js"></script>
55
55
 
56
56
  <!-- Microsoft Teams JavaScript API (via local) -->
57
57
  <script src="MicrosoftTeams.min.js"></script>
@@ -59,7 +59,7 @@ Reference the SDK inside of your `.html` page using:
59
59
 
60
60
  ### Dependencies
61
61
 
62
- Teams client SDK depends on [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) type. If you support older browsers and devices which may not yet provide it natively (e.g. IE 11), you need to provide a global polyfill, such as [es6-promise](https://www.npmjs.com/package/es6-promise), in your bundled application. If you're using a script tag to reference the Teams client SDK, you need to make sure the polyfill is included and initialized before the Teams client SDK is.
62
+ Teams client library depends on [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) type. If you support older browsers and devices which may not yet provide it natively (e.g. IE 11), you need to provide a global polyfill, such as [es6-promise](https://www.npmjs.com/package/es6-promise), in your bundled application. If you're using a script tag to reference the Teams client library, you need to make sure the polyfill is included and initialized before the Teams client library is initialized.
63
63
 
64
64
  ## Examples
65
65
 
@@ -67,7 +67,7 @@ Stay tuned for examples coming soon.
67
67
 
68
68
  ## Testing
69
69
 
70
- The [Teams Test App](https://aka.ms/teams-test-app) is used to validate the Teams client SDK APIs.
70
+ The [Teams Test App](https://aka.ms/teams-test-app) is used to validate the Teams client library APIs.
71
71
 
72
72
  ## Troubleshooting
73
73
 
@@ -6140,6 +6140,21 @@ export namespace profile {
6140
6140
  */
6141
6141
  function isSupported(): boolean;
6142
6142
  }
6143
+ /**
6144
+ * Internal representation of a DOMRect suitable for sending via postMessage.
6145
+ */
6146
+ export type Rectangle = {
6147
+ x: number;
6148
+ y: number;
6149
+ width: number;
6150
+ height: number;
6151
+ };
6152
+ export interface ShowProfileRequestInternal {
6153
+ modality?: profile.Modality;
6154
+ persona: profile.Persona;
6155
+ targetRectangle: Rectangle;
6156
+ triggerType: profile.TriggerType;
6157
+ }
6143
6158
 
6144
6159
  /**
6145
6160
  * Namespace to video extensibility of the SDK
@@ -1133,7 +1133,7 @@ __webpack_require__.d(__webpack_exports__, {
1133
1133
  });
1134
1134
 
1135
1135
  ;// CONCATENATED MODULE: ./src/public/version.ts
1136
- var version = "2.5.0-beta.0";
1136
+ var version = "2.5.0";
1137
1137
 
1138
1138
  ;// CONCATENATED MODULE: ./src/internal/globalVars.ts
1139
1139
  var GlobalVars = /** @class */ (function () {
@@ -1480,6 +1480,8 @@ var validOrigins = [
1480
1480
  'outlook-sdf.office.com',
1481
1481
  'outlook.office365.com',
1482
1482
  'outlook-sdf.office365.com',
1483
+ 'outlook.live.com',
1484
+ 'outlook-sdf.live.com',
1483
1485
  '*.teams.microsoft.com',
1484
1486
  '*.www.office.com',
1485
1487
  'www.office.com',
@@ -7115,6 +7117,10 @@ var profile;
7115
7117
  });
7116
7118
  }
7117
7119
  profile.showProfile = showProfile;
7120
+ /**
7121
+ * An internal representation of the showProfile parameters suitable for sending via postMessage.
7122
+ * The hub expects to receive an object of this type.
7123
+ */
7118
7124
  /**
7119
7125
  * Checks if the profile capability is supported by the host
7120
7126
  *