Merge pull request #1826 from sebastienlevert/sebastienlevert/react-graph-latest-client

samples/react-graph-mgt-client/.editorconfig

@@ -0,0 +1,25 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+
+[*]
+
+# change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# we recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[{package,bower}.json]
+indent_style = space
+indent_size = 2

samples/react-graph-mgt-client/.gitignore

@@ -0,0 +1,32 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Dependency directories
+node_modules
+
+# Build generated files
+dist
+lib
+solution
+temp
+*.sppkg
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# OSX
+.DS_Store
+
+# Visual Studio files
+.ntvs_analysis.dat
+.vs
+bin
+obj
+
+# Resx Generated Code
+*.resx.ts
+
+# Styles Generated Code
+*.scss.ts

samples/react-graph-mgt-client/.yo-rc.json

@@ -0,0 +1,12 @@
+{
+  "@microsoft/generator-sharepoint": {
+    "isCreatingSolution": true,
+    "environment": "spo",
+    "version": "1.11.0",
+    "libraryName": "react-graph-mgt-client",
+    "libraryId": "8548b10e-1f21-4797-ae74-279081454b9f",
+    "packageManager": "npm",
+    "isDomainIsolated": false,
+    "componentType": "webpart"
+  }
+}

samples/react-graph-mgt-client/README.md

@@ -0,0 +1,104 @@
+---
+page_type: sample
+products:
+  - office-sp
+  - sharepoint
+  - microsoft-graph
+languages:
+  - javascript
+  - typescript
+extensions:
+  contentType: samples
+  technologies:
+    - SharePoint Framework
+    - Microsoft Graph
+  platforms:
+    - React
+  createdDate: 2021-04-18T19:43:46.356Z
+---
+
+# react-graph-mgt-client
+
+## Summary
+
+This is a sample web part developed using React Framework that showcases how to use the latest `microsoft-graph-client` in order to do advanced configuration of the Microsoft Graph client. This enables scenarios like throttling management, Chaos management and a lot more!
+
+![Demo of the Graph Client using the MGT providers](./assets/DemoGraphClient.gif)
+
+## Used SharePoint Framework Version
+
+![version](https://img.shields.io/badge/version-1.11-green.svg)
+
+## Applies to
+
+- [SharePoint Framework](https://aka.ms/spfx)
+- [Microsoft 365 tenant](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant)
+
+> Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/o365devprogram)
+
+## Prerequisites
+
+In the `package-solution.json` file, ensure that the scopes are available for the calls you want to do on Microsoft Graph.
+
+```json
+"webApiPermissionRequests": [
+      {
+        "resource": "Microsoft Graph",
+        "scope": "User.Read.All"
+      },
+      {
+        "resource": "Microsoft Graph",
+        "scope": "Calendars.Read"
+      }
+    ],
+```
+
+## Solution
+
+Solution|Author(s)
+--------|---------
+react-graph-mgt-client | [Sébastien Levert](https://www.linkedin.com/in/sebastienlevert), Microsoft ([@sebastienlevert](https://twitter.com/sebastienlevert))
+
+## Version history
+
+Version|Date|Comments
+-------|----|--------
+1.0|April 18, 2021|Initial release
+
+## Disclaimer
+
+**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
+
+---
+
+## Minimal Path to Awesome
+
+- Clone this repository
+- Ensure that you are at the solution folder
+- in the command-line run:
+  - **npm install**
+  - **gulp bundle**
+  - **gulp package-solution**
+- Deploy the generated *.sppkg to your App Catalog
+- Approve the Microsoft Graph scopes
+- in the command-line run:
+  - **gulp serve**
+
+
+## Features
+
+This sample illustrates how to leverage the Microsoft Graph Toolkit providers to extend the experience of using the `microsoft-graph-client` in SharePoint Framework and overcomes some of its current limitations.
+
+This sample illustrates the following concepts:
+
+- Adding MGT providers to an existing SPFx solution
+- Replace Microsoft Graph calls built using the integrated Microsoft Graph client
+- Use the latest and greatest Microsoft Graph client in order to have more power over your calls
+
+## References
+
+- [Getting started with SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant)
+- [Building for Microsoft teams](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/build-for-teams-overview)
+- [Use Microsoft Graph in your solution](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/using-microsoft-graph-apis)
+- [Publish SharePoint Framework applications to the Marketplace](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/publish-to-marketplace-overview)
+- [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - Guidance, tooling, samples and open-source controls for your Microsoft 365 development

samples/react-graph-mgt-client/config/config.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/config.2.0.schema.json",
+  "version": "2.0",
+  "bundles": {
+    "graph-latest-client-web-part": {
+      "components": [
+        {
+          "entrypoint": "./lib/webparts/graphClient/GraphClientWebPart.js",
+          "manifest": "./src/webparts/graphClient/GraphClientWebPart.manifest.json"
+        }
+      ]
+    }
+  },
+  "externals": {},
+  "localizedResources": {
+    "GraphClientWebPartStrings": "lib/webparts/graphClient/loc/{locale}.js"
+  }
+}

samples/react-graph-mgt-client/config/copy-assets.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/copy-assets.schema.json",
+  "deployCdnPath": "temp/deploy"
+}

samples/react-graph-mgt-client/config/deploy-azure-storage.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/deploy-azure-storage.schema.json",
+  "workingDir": "./temp/deploy/",
+  "account": "<!-- STORAGE ACCOUNT NAME -->",
+  "container": "react-graph-mgt-client",
+  "accessKey": "<!-- ACCESS KEY -->"
+}

samples/react-graph-mgt-client/config/package-solution.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/package-solution.schema.json",
+  "solution": {
+    "name": "react-graph-mgt-client-client-side-solution",
+    "id": "8548b10e-1f21-4797-ae74-279081454b9f",
+    "version": "1.0.0.0",
+    "includeClientSideAssets": true,
+    "skipFeatureDeployment": true,
+    "isDomainIsolated": false,
+    "webApiPermissionRequests": [
+      {
+        "resource": "Microsoft Graph",
+        "scope": "User.Read.All"
+      },
+      {
+        "resource": "Microsoft Graph",
+        "scope": "Calendars.Read"
+      }
+    ],
+    "developer": {
+      "name": "",
+      "websiteUrl": "",
+      "privacyUrl": "",
+      "termsOfUseUrl": "",
+      "mpnId": ""
+    }
+  },
+  "paths": {
+    "zippedPackage": "solution/react-graph-mgt-client.sppkg"
+  }
+}

samples/react-graph-mgt-client/config/serve.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/core-build/serve.schema.json",
+  "port": 4321,
+  "https": true,
+  "initialPage": "https://localhost:5432/workbench",
+  "api": {
+    "port": 5432,
+    "entryPath": "node_modules/@microsoft/sp-webpart-workbench/lib/api/"
+  }
+}

samples/react-graph-mgt-client/config/write-manifests.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/write-manifests.schema.json",
+  "cdnBasePath": "<!-- PATH TO CDN -->"
+}

samples/react-graph-mgt-client/gulpfile.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const build = require('@microsoft/sp-build-web');
+
+build.addSuppression(`Warning - [sass] The local CSS class 'ms-Grid' is not camelCase and will not be type-safe.`);
+
+build.initialize(require('gulp'));

samples/react-graph-mgt-client/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "react-graph-mgt-client",
+  "version": "0.0.1",
+  "private": true,
+  "main": "lib/index.js",
+  "engines": {
+    "node": ">=0.10.0"
+  },
+  "scripts": {
+    "build": "gulp bundle",
+    "clean": "gulp clean",
+    "test": "gulp test"
+  },
+  "dependencies": {
+    "@microsoft/mgt-element": "^2.1.0",
+    "@microsoft/mgt-sharepoint-provider": "^2.1.0",
+    "@microsoft/microsoft-graph-client": "^2.2.1",
+    "@microsoft/sp-core-library": "1.11.0",
+    "@microsoft/sp-lodash-subset": "1.11.0",
+    "@microsoft/sp-office-ui-fabric-core": "1.11.0",
+    "@microsoft/sp-property-pane": "1.11.0",
+    "@microsoft/sp-webpart-base": "1.11.0",
+    "@monaco-editor/react": "^4.1.1",
+    "office-ui-fabric-react": "6.214.0",
+    "react": "16.8.5",
+    "react-dom": "16.8.5"
+  },
+  "devDependencies": {
+    "@microsoft/rush-stack-compiler-3.3": "0.3.5",
+    "@microsoft/rush-stack-compiler-3.7": "^0.6.43",
+    "@microsoft/sp-build-web": "1.11.0",
+    "@microsoft/sp-module-interfaces": "1.11.0",
+    "@microsoft/sp-tslint-rules": "1.11.0",
+    "@microsoft/sp-webpart-workbench": "1.11.0",
+    "@types/chai": "3.4.34",
+    "@types/es6-promise": "0.0.33",
+    "@types/mocha": "2.2.38",
+    "@types/react": "16.8.8",
+    "@types/react-dom": "16.8.3",
+    "@types/webpack-env": "1.13.1",
+    "ajv": "~5.2.2",
+    "gulp": "~3.9.1",
+    "typescript": "^3.7.7"
+  }
+}

samples/react-graph-mgt-client/src/index.ts

@@ -0,0 +1 @@
+// A file is required to be in the root of the /src directory by the TypeScript compiler

samples/react-graph-mgt-client/src/webparts/graphClient/GraphClientWebPart.manifest.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx/client-side-web-part-manifest.schema.json",
+  "id": "aaa33b68-65d0-4403-bbe4-1cb21cc1936b",
+  "alias": "GraphClientWebPart",
+  "componentType": "WebPart",
+
+  // The "*" signifies that the version should be taken from the package.json
+  "version": "*",
+  "manifestVersion": 2,
+
+  // If true, the component can only be installed on sites where Custom Script is allowed.
+  // Components that allow authors to embed arbitrary script code should set this to true.
+  // https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f
+  "requiresCustomScript": false,
+  "supportedHosts": ["SharePointWebPart"],
+
+  "preconfiguredEntries": [{
+    "groupId": "5c03119e-3074-46fd-976b-c60198311f70", // Other
+    "group": { "default": "Other" },
+    "title": { "default": "GraphClient" },
+    "description": { "default": "GraphClient description" },
+    "officeFabricIconFontName": "Page",
+    "properties": {
+      "description": "GraphClient"
+    }
+  }]
+}

samples/react-graph-mgt-client/src/webparts/graphClient/GraphClientWebPart.ts

@@ -0,0 +1,53 @@
+import * as React from 'react';
+import * as ReactDom from 'react-dom';
+import { Version } from '@microsoft/sp-core-library';
+import {
+  IPropertyPaneConfiguration,
+} from '@microsoft/sp-property-pane';
+import { BaseClientSideWebPart } from '@microsoft/sp-webpart-base';
+
+import GraphClient from './components/GraphClient';
+import { IGraphClientProps } from './components/IGraphClientProps';
+
+// Importing MGT in the Web Part
+import { SharePointProvider } from '@microsoft/mgt-sharepoint-provider';
+import { Providers } from '@microsoft/mgt-element';
+
+export interface IGraphLatestClientWebPartProps {
+  description: string;
+}
+
+export default class GraphLatestClientWebPart extends BaseClientSideWebPart<IGraphLatestClientWebPartProps> {
+
+  public render(): void {
+    const element: React.ReactElement<IGraphClientProps> = React.createElement(
+      GraphClient,
+      {
+        description: this.properties.description
+      }
+    );
+
+    ReactDom.render(element, this.domElement);
+  }
+
+  /**
+   * Assign a new SharePoint provider to the MGT providers
+   */
+  protected async onInit() {
+    Providers.globalProvider = new SharePointProvider(this.context);
+  }
+
+  protected onDispose(): void {
+    ReactDom.unmountComponentAtNode(this.domElement);
+  }
+
+  protected get dataVersion(): Version {
+    return Version.parse('1.0');
+  }
+
+  protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration {
+    return {
+      pages: []
+    };
+  }
+}

samples/react-graph-mgt-client/src/webparts/graphClient/components/GraphClient.module.scss

@@ -0,0 +1,98 @@
+@import '~office-ui-fabric-react/dist/sass/References.scss';
+
+.graphLatestClient {
+  .container {
+    max-width: 700px;
+    margin: 0px auto;
+    box-shadow: 0 2px 4px 0 rgba(0, 0, 0, 0.2), 0 25px 50px 0 rgba(0, 0, 0, 0.1);
+  }
+
+  .row {
+    @include ms-Grid-row;
+    margin-bottom: 15px;
+
+    .col2 {
+      @include ms-Grid-col;
+      @include ms-sm2;
+    }
+
+    .col4 {
+      @include ms-Grid-col;
+      @include ms-sm4;
+    }
+
+    .col8 {
+      @include ms-Grid-col;
+      @include ms-sm8;
+    }
+
+    .col10 {
+      @include ms-Grid-col;
+      @include ms-sm10;
+    }
+  }
+
+  .spinner {
+    display: inline-block;
+    margin-left: 15px;
+    margin-top: 0px;
+  }
+
+  .column {
+    @include ms-Grid-col;
+    @include ms-lg10;
+    @include ms-xl8;
+    @include ms-xlPush2;
+    @include ms-lgPush1;
+  }
+
+  .title {
+    @include ms-font-xl;
+    @include ms-fontColor-white;
+  }
+
+  .subTitle {
+    @include ms-font-l;
+    @include ms-fontColor-white;
+  }
+
+  .description {
+    @include ms-font-l;
+    @include ms-fontColor-white;
+  }
+
+  .button {
+    // Our button
+    text-decoration: none;
+    height: 32px;
+
+    // Primary Button
+    min-width: 80px;
+    background-color: $ms-color-themePrimary;
+    border-color: $ms-color-themePrimary;
+    color: $ms-color-white;
+
+    // Basic Button
+    outline: transparent;
+    position: relative;
+    font-family: "Segoe UI WestEuropean","Segoe UI",-apple-system,BlinkMacSystemFont,Roboto,"Helvetica Neue",sans-serif;
+    -webkit-font-smoothing: antialiased;
+    font-size: $ms-font-size-m;
+    font-weight: $ms-font-weight-regular;
+    border-width: 0;
+    text-align: center;
+    cursor: pointer;
+    display: inline-block;
+    padding: 0 16px;
+
+    .label {
+      font-weight: $ms-font-weight-semibold;
+      font-size: $ms-font-size-m;
+      height: 32px;
+      line-height: 32px;
+      margin: 0 4px;
+      vertical-align: top;
+      display: inline-block;
+    }
+  }
+}

samples/react-graph-mgt-client/src/webparts/graphClient/components/GraphClient.tsx

@@ -0,0 +1,84 @@
+import * as React from 'react';
+import styles from './GraphClient.module.scss';
+import { IGraphClientProps } from './IGraphClientProps';
+import { Providers } from '@microsoft/mgt-element';
+import { RetryHandlerOptions } from '@microsoft/microsoft-graph-client';
+import Editor from '@monaco-editor/react';
+import { TextField } from 'office-ui-fabric-react/lib/TextField';
+import { DefaultButton } from 'office-ui-fabric-react/lib/Button';
+import { Spinner, SpinnerSize } from 'office-ui-fabric-react/lib/Spinner';
+
+export interface IGraphClientState {
+  response: any;
+  apiUrl: string;
+  loading: boolean;
+}
+
+export default class GraphClient extends React.Component<IGraphClientProps, IGraphClientState> {
+  constructor(props: IGraphClientProps) {
+    super(props);
+
+    this.state = {
+      response: null,
+      apiUrl: '',
+      loading: false
+    };
+  }
+  
+  public render(): React.ReactElement<IGraphClientProps> {
+    return (
+      <div className={ styles.graphLatestClient }>
+        <div className={styles.row}>  
+          <div className={styles.col8}>
+            <TextField
+              placeholder="Specify your query"
+              value={this.state.apiUrl}
+              onChanged={this._apiUrlChanged}
+              onKeyUp={(e: React.KeyboardEvent<any>) => e.key === 'Enter' && this._runQuery()}
+            />
+          </div>
+          <div className={styles.col4}>
+            <DefaultButton
+              primary={true}
+              onClick={this._runQuery}
+              style={{ width: '100%' }}
+              disabled={this.state.loading}>
+              Run query
+              {this.state.loading && (
+                <>
+                  <Spinner className={styles.spinner} size={SpinnerSize.xSmall} />
+                </>
+              )}
+            </DefaultButton>
+          </div>
+        </div>       
+        <Editor height="600px" theme="vs-dark" defaultLanguage="json" value={this.state.response ? JSON.stringify(this.state.response, null, 2) : ''} />
+      </div>
+    );
+  }
+
+  /**
+   * Event handler for api URL change
+   */
+   private _apiUrlChanged = (val: string) => {
+    this.setState({
+      apiUrl: val,
+    });
+  }
+
+  private _runQuery = async () => {
+    this.setState({
+      response: null,
+      loading: true
+    });
+
+    const data = await Providers.globalProvider.graph.api("/me/events").middlewareOptions([new RetryHandlerOptions(5, 10)]).get();
+
+    if(data && data.value && data.value.length > 0) {
+      this.setState({
+        response: data,
+        loading: false
+      });      
+    }
+  }
+}

samples/react-graph-mgt-client/src/webparts/graphClient/components/IGraphClientProps.ts

@@ -0,0 +1,3 @@
+export interface IGraphClientProps {
+  description: string;
+}

samples/react-graph-mgt-client/src/webparts/graphClient/loc/en-us.js

@@ -0,0 +1,7 @@
+define([], function() {
+  return {
+    "PropertyPaneDescription": "Description",
+    "BasicGroupName": "Group Name",
+    "DescriptionFieldLabel": "Description Field"
+  }
+});

samples/react-graph-mgt-client/src/webparts/graphClient/loc/mystrings.d.ts

@@ -0,0 +1,10 @@
+declare interface IGraphClientWebPartStrings {
+  PropertyPaneDescription: string;
+  BasicGroupName: string;
+  DescriptionFieldLabel: string;
+}
+
+declare module 'GraphClientWebPartStrings' {
+  const strings: IGraphClientWebPartStrings;
+  export = strings;
+}

samples/react-graph-mgt-client/tsconfig.json

@@ -0,0 +1,39 @@
+{
+  "extends": "./node_modules/@microsoft/rush-stack-compiler-3.7/includes/tsconfig-web.json",
+  "compilerOptions": {
+    "target": "es5",
+    "forceConsistentCasingInFileNames": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "jsx": "react",
+    "declaration": true,
+    "sourceMap": true,
+    "experimentalDecorators": true,
+    "skipLibCheck": true,
+    "outDir": "lib",
+    "inlineSources": false,
+    "strictNullChecks": false,
+    "noUnusedLocals": false,
+    "typeRoots": [
+      "./node_modules/@types",
+      "./node_modules/@microsoft"
+    ],
+    "types": [
+      "es6-promise",
+      "webpack-env"
+    ],
+    "lib": [
+      "es5",
+      "dom",
+      "es2015.collection"
+    ]
+  },
+  "include": [
+    "src/**/*.ts",
+    "src/**/*.tsx"
+  ],
+  "exclude": [
+    "node_modules",
+    "lib"
+  ]
+}

samples/react-graph-mgt-client/tslint.json

@@ -0,0 +1,29 @@
+{
+  "extends": "@microsoft/sp-tslint-rules/base-tslint.json",
+  "rules": {
+    "class-name": false,
+    "export-name": false,
+    "forin": false,
+    "label-position": false,
+    "member-access": true,
+    "no-arg": false,
+    "no-console": false,
+    "no-construct": false,
+    "no-duplicate-variable": true,
+    "no-eval": false,
+    "no-function-expression": true,
+    "no-internal-module": true,
+    "no-shadowed-variable": true,
+    "no-switch-case-fall-through": true,
+    "no-unnecessary-semicolons": true,
+    "no-unused-expression": true,
+    "no-with-statement": true,
+    "semicolon": true,
+    "trailing-comma": false,
+    "typedef": false,
+    "typedef-whitespace": false,
+    "use-named-parameter": true,
+    "variable-name": false,
+    "whitespace": false
+  }
+}