Merge pull request Azure-Samples#9 from Azure-Samples/add-graph-sdk

adding graph sdk to sample 2-1

Author: derisen

.gitignore

@@ -111,4 +111,7 @@ obj/
 .vs
 
 # VS Code cache
-.vscode
+.vscode
+
+# NPM cache
+package-lock.json

1-Authentication/1-sign-in/SPA/package.json

@@ -37,7 +37,7 @@
  "codelyzer": "^6.0.0",
  "jasmine-core": "~3.6.0",
  "jasmine-spec-reporter": "~5.0.0",
- "karma": "~5.1.0",
+ "karma": "^6.3.2",
  "karma-chrome-launcher": "~3.1.0",
  "karma-coverage": "~2.0.3",
  "karma-jasmine": "~4.0.0",

1-Authentication/2-sign-in-b2c/SPA/package.json

@@ -37,7 +37,7 @@
  "codelyzer": "^6.0.0",
  "jasmine-core": "~3.6.0",
  "jasmine-spec-reporter": "~5.0.0",
- "karma": "~5.1.0",
+ "karma": "^6.3.2",
  "karma-chrome-launcher": "~3.1.0",
  "karma-coverage": "~2.0.3",
  "karma-jasmine": "~4.0.0",

2-Authorization-I/1-call-graph/README.md

@@ -15,7 +15,7 @@
 
 ## Overview
 
-This sample demonstrates an Angular single-page application (SPA) that lets users sign-in with Azure Active Directory (Azure AD) using the [Microsoft Authentication Library for Angular](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/lib/msal-angular) (MSAL Angular).
+This sample demonstrates an Angular single-page application (SPA) that lets users sign-in with Azure Active Directory (Azure AD) using the [Microsoft Authentication Library for Angular](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/lib/msal-angular) (MSAL Angular). In addition, this sample also demonstrates how to use [Microsoft Graph JavaScript SDK](https://github.com/microsoftgraph/msgraph-sdk-javascript) client with MSAL as authentication provider to call the Graph API.
 
 Here you'll learn about [Access Tokens](https://docs.microsoft.com/azure/active-directory/develop/access-tokens), [acquiring a token](https://docs.microsoft.com/azure/active-directory/develop/scenario-spa-acquire-token), [calling a protected web API](https://docs.microsoft.com/azure/active-directory/develop/scenario-spa-call-api), as well as [Dynamic Scopes and Incremental Consent](https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent), **silent token acquisition**, **working with multiple resources** and more.
 
@@ -28,11 +28,12 @@ Here you'll learn about [Access Tokens](https://docs.microsoft.com/azure/active-
 
 ## Contents
 
-| File/folder | Description |
-|---------------------------------|-----------------------------------------------------------|
-| `src/app/auth-config.ts` | Authentication parameters reside here. |
-| `src/app/app.module.ts` | MSAL-Angular configuration parameters reside here. |
-| `src/app/app-routing.module.ts` | Configure your MSAL-Guard here. |
+| File/folder | Description |
+|---------------------------------|-----------------------------------------------------------------------|
+| `src/app/auth-config.ts` | Authentication parameters reside here. |
+| `src/app/app.module.ts` | MSAL-Angular configuration parameters reside here. |
+| `src/app/app-routing.module.ts` | Configure your MSAL-Guard here. |
+| `src/app/graph.service.ts` | Instantiates Graph SDK client using a custom authentication provider. |
 
 ## Prerequisites
 
@@ -299,6 +300,118 @@ In the code snippet above, the user will be prompted for consent once they authe
 
 Clients should treat access tokens as opaque strings, as the contents of the token are intended for the **resource only** (such as a web API or Microsoft Graph). For validation and debugging purposes, developers can decode **JWT**s (*JSON Web Tokens*) using a site like [jwt.ms](https://jwt.ms).
 
+### Calling the Microsoft Graph API
+
+[Microsoft Graph JavaScript SDK](https://github.com/microsoftgraph/msgraph-sdk-javascript) provides various utility methods to query the Graph API. While the SDK has a default authentication provider that can be used in basic scenarios, it can also be extended to use with a custom authentication provider such as MSAL. To do so, we will initialize the Graph SDK client with [clientOptions](https://github.com/microsoftgraph/msgraph-sdk-javascript/blob/dev/docs/CreatingClientInstance.md) method, which contains an `authProvider` object of class **MyAuthenticationProvider** that handles the token acquisition process for the client. We offer this as a service to other components as shown below:
+
+```typescript
+export class GraphService {
+
+ constructor(private authService: MsalService) { }
+
+ getGraphClient = (providerOptions: ProviderOptions) => {
+
+ /**
+ * Pass the instance as authProvider in ClientOptions to instantiate the Client which will create and set the default middleware chain.
+ * For more information, visit: https://github.com/microsoftgraph/msgraph-sdk-javascript/blob/dev/docs/CreatingClientInstance.md
+ */
+ let clientOptions = {
+ authProvider: new MyAuthenticationProvider(providerOptions, this.authService),
+ };
+
+ const graphClient = Client.initWithMiddleware(clientOptions);
+
+ return graphClient;
+ }
+}
+```
+
+**MyAuthenticationProvider** class needs to implement the [IAuthenticationProvider](https://github.com/microsoftgraph/msgraph-sdk-javascript/blob/dev/src/IAuthenticationProvider.ts) interface, which can be done as shown below:
+
+```typescript
+class MyAuthenticationProvider implements AuthenticationProvider {
+
+ account;
+ scopes;
+ interactionType;
+
+ constructor(providerOptions: ProviderOptions, private authService: MsalService) {
+ this.account = providerOptions.account;
+ this.scopes = providerOptions.scopes;
+ this.interactionType = providerOptions.interactionType;
+ }
+
+ /**
+ * This method will get called before every request to the ms graph server
+ * This should return a Promise that resolves to an accessToken (in case of success) or rejects with error (in case of failure)
+ * Basically this method will contain the implementation for getting and refreshing accessTokens
+ */
+ getAccessToken(): Promise<string> {
+ return new Promise(async (resolve, reject) => {
+ let response: AuthenticationResult;
+
+ try {
+ response = await this.authService.instance.acquireTokenSilent({
+ account: this.account,
+ scopes: this.scopes
+ });
+
+ if (response.accessToken) {
+ resolve(response.accessToken);
+ } else {
+ reject(Error('Failed to acquire an access token'));
+ }
+ } catch (error) {
+ // in case if silent token acquisition fails, fallback to an interactive method
+ if (error instanceof InteractionRequiredAuthError) {
+ switch (this.interactionType) {
+ case InteractionType.Popup:
+ response = await this.authService.instance.acquireTokenPopup({
+ scopes: this.scopes
+ });
+
+ if (response.accessToken) {
+ resolve(response.accessToken);
+ } else {
+ reject(Error('Failed to acquire an access token'));
+ }
+ break;
+
+ case InteractionType.Redirect:
+ this.authService.instance.acquireTokenRedirect({
+ scopes: this.scopes
+ });
+ break;
+
+ default:
+ break;
+ }
+ }
+ }
+ });
+ }
+}
+```
+
+See [graph.service.ts](./SPA/src/app/graph.service.ts). The Graph client then can be used in your components as shown below:
+
+```typescript
+ const providerOptions: ProviderOptions = {
+ account: this.authService.instance.getActiveAccount()!, 
+ scopes: protectedResources.graphMe.scopes, 
+ interactionType: InteractionType.Popup
+ };
+
+ this.graphService.getGraphClient(providerOptions)
+ .api('/me').get()
+ .then((profileResponse: ProfileType) => {
+ // do something with response
+ })
+ .catch((error) => {
+ // handle errors
+ });
+```
+
 ## More information
 
 - [Microsoft identity platform (Azure Active Directory for developers)](https://docs.microsoft.com/azure/active-directory/develop/)
@@ -331,4 +444,4 @@ To provide feedback on or suggest features for Azure Active Directory, visit [Us
 
 If you'd like to contribute to this sample, see [CONTRIBUTING.MD](/CONTRIBUTING.md).
 
-This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

2-Authorization-I/1-call-graph/Readme-incremental.md

@@ -14,7 +14,7 @@
 
 ## Overview
 
-This sample demonstrates an Angular single-page application (SPA) that lets users sign-in with Azure Active Directory (Azure AD) using the [Microsoft Authentication Library for Angular](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/lib/msal-angular) (MSAL Angular).
+This sample demonstrates an Angular single-page application (SPA) that lets users sign-in with Azure Active Directory (Azure AD) using the [Microsoft Authentication Library for Angular](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/lib/msal-angular) (MSAL Angular). In addition, this sample also demonstrates how to use [Microsoft Graph JavaScript SDK](https://github.com/microsoftgraph/msgraph-sdk-javascript) client with a MSAL as authentication provider to call the Graph API.
 
 Here you'll learn about [Access Tokens](https://docs.microsoft.com/azure/active-directory/develop/access-tokens), [acquiring a token](https://docs.microsoft.com/azure/active-directory/develop/scenario-spa-acquire-token), [calling a protected web API](https://docs.microsoft.com/azure/active-directory/develop/scenario-spa-call-api), as well as [Dynamic Scopes and Incremental Consent](https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent), **silent token acquisition**, **working with multiple resources** and more.
 
@@ -27,11 +27,12 @@ Here you'll learn about [Access Tokens](https://docs.microsoft.com/azure/active-
 
 ## Contents
 
-| File/folder | Description |
-|---------------------------------|-----------------------------------------------------------|
-| `src/app/auth-config.ts` | Authentication parameters reside here. |
-| `src/app/app.module.ts` | MSAL-Angular configuration parameters reside here. |
-| `src/app/app-routing.module.ts` | Configure your MSAL-Guard here. |
+| File/folder | Description |
+|---------------------------------|-----------------------------------------------------------------------|
+| `src/app/auth-config.ts` | Authentication parameters reside here. |
+| `src/app/app.module.ts` | MSAL-Angular configuration parameters reside here. |
+| `src/app/app-routing.module.ts` | Configure your MSAL-Guard here. |
+| `src/app/graph.service.ts` | Instantiates Graph SDK client using a custom authentication provider. |
 
 ## Setup
 
@@ -267,6 +268,118 @@ In the code snippet above, the user will be prompted for consent once they authe
 
 Clients should treat access tokens as opaque strings, as the contents of the token are intended for the **resource only** (such as a web API or Microsoft Graph). For validation and debugging purposes, developers can decode **JWT**s (*JSON Web Tokens*) using a site like [jwt.ms](https://jwt.ms).
 
+### Calling the Microsoft Graph API
+
+[Microsoft Graph JavaScript SDK](https://github.com/microsoftgraph/msgraph-sdk-javascript) provides various utility methods to query the Graph API. While the SDK has a default authentication provider that can be used in basic scenarios, it can also be extended to use with a custom authentication provider such as MSAL. To do so, we will initialize the Graph SDK client with [clientOptions](https://github.com/microsoftgraph/msgraph-sdk-javascript/blob/dev/docs/CreatingClientInstance.md) method, which contains an `authProvider` object of class **MyAuthenticationProvider** that handles the token acquisition process for the client. We offer this as a service to other components as shown below:
+
+```typescript
+export class GraphService {
+
+ constructor(private authService: MsalService) { }
+
+ getGraphClient = (providerOptions: ProviderOptions) => {
+
+ /**
+ * Pass the instance as authProvider in ClientOptions to instantiate the Client which will create and set the default middleware chain.
+ * For more information, visit: https://github.com/microsoftgraph/msgraph-sdk-javascript/blob/dev/docs/CreatingClientInstance.md
+ */
+ let clientOptions = {
+ authProvider: new MyAuthenticationProvider(providerOptions, this.authService, this.msalBroadcastService),
+ };
+
+ const graphClient = Client.initWithMiddleware(clientOptions);
+
+ return graphClient;
+ }
+}
+```
+
+**MyAuthenticationProvider** class needs to implement the [IAuthenticationProvider](https://github.com/microsoftgraph/msgraph-sdk-javascript/blob/dev/src/IAuthenticationProvider.ts) interface, which can be done as shown below:
+
+```typescript
+class MyAuthenticationProvider implements AuthenticationProvider {
+
+ account;
+ scopes;
+ interactionType;
+
+ constructor(providerOptions: ProviderOptions, private authService: MsalService) {
+ this.account = providerOptions.account;
+ this.scopes = providerOptions.scopes;
+ this.interactionType = providerOptions.interactionType;
+ }
+
+ /**
+ * This method will get called before every request to the ms graph server
+ * This should return a Promise that resolves to an accessToken (in case of success) or rejects with error (in case of failure)
+ * Basically this method will contain the implementation for getting and refreshing accessTokens
+ */
+ getAccessToken(): Promise<string> {
+ return new Promise(async (resolve, reject) => {
+ let response: AuthenticationResult;
+
+ try {
+ response = await this.authService.instance.acquireTokenSilent({
+ account: this.account,
+ scopes: this.scopes
+ });
+
+ if (response.accessToken) {
+ resolve(response.accessToken);
+ } else {
+ reject(Error('Failed to acquire an access token'));
+ }
+ } catch (error) {
+ // in case if silent token acquisition fails, fallback to an interactive method
+ if (error instanceof InteractionRequiredAuthError) {
+ switch (this.interactionType) {
+ case InteractionType.Popup:
+ response = await this.authService.instance.acquireTokenPopup({
+ scopes: this.scopes
+ });
+
+ if (response.accessToken) {
+ resolve(response.accessToken);
+ } else {
+ reject(Error('Failed to acquire an access token'));
+ }
+ break;
+
+ case InteractionType.Redirect:
+ this.authService.instance.acquireTokenRedirect({
+ scopes: this.scopes
+ });
+ break;
+
+ default:
+ break;
+ }
+ }
+ }
+ });
+ }
+}
+```
+
+See [graph.service.ts](./SPA/src/app/graph.service.ts). The Graph client then can be used in your components as shown below:
+
+```typescript
+ const providerOptions: ProviderOptions = {
+ account: this.authService.instance.getActiveAccount()!, 
+ scopes: protectedResources.graphMe.scopes, 
+ interactionType: InteractionType.Popup
+ };
+
+ this.graphService.getGraphClient(providerOptions)
+ .api('/me').get()
+ .then((profileResponse: ProfileType) => {
+ // do something with response
+ })
+ .catch((error) => {
+ // handle errors
+ });
+```
+
 ## Next Tutorial
 
 Continue with the next tutorial: [Protect and call a web API](../../3-Authorization-II/1-call-api/README-incremental.md).
@@ -303,4 +416,4 @@ To provide feedback on or suggest features for Azure Active Directory, visit [Us
 
 If you'd like to contribute to this sample, see [CONTRIBUTING.MD](/CONTRIBUTING.md).
 
-This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

2-Authorization-I/1-call-graph/SPA/package.json

@@ -22,6 +22,7 @@
  "@angular/router": "~11.0.0",
  "@azure/msal-angular": "^2.0.0",
  "@azure/msal-browser": "^2.14.2",
+ "@microsoft/microsoft-graph-client": "^2.2.1",
  "core-js": "^3.8.0",
  "rxjs": "~6.6.0",
  "tslib": "^2.0.0",
@@ -36,7 +37,7 @@
  "codelyzer": "^6.0.0",
  "jasmine-core": "~3.6.0",
  "jasmine-spec-reporter": "~5.0.0",
- "karma": "~5.1.0",
+ "karma": "^6.3.2",
  "karma-chrome-launcher": "~3.1.0",
  "karma-coverage": "~2.0.3",
  "karma-jasmine": "~4.0.0",