Dynamic SPFx Bundling/Loading Web Part Example (#628)

* Updated the api-scopes tutorial sample to SPFx v1.6.0 (#617)

* Dynamic SPFx Bundling Initial Commit

samples/js-dynamic-bundling-libraries/.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/js-dynamic-bundling-libraries/.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/js-dynamic-bundling-libraries/.yo-rc.json

@@ -0,0 +1,11 @@
+{
+  "@microsoft/generator-sharepoint": {
+    "isCreatingSolution": true,
+    "environment": "spo",
+    "version": "1.6.0",
+    "libraryName": "dynamic-bundling",
+    "libraryId": "c40970b0-7ef0-40f2-b03b-718751fbc4b5",
+    "packageManager": "npm",
+    "componentType": "webpart"
+  }
+}

samples/js-dynamic-bundling-libraries/README.md

@@ -0,0 +1,59 @@
+# title of the sample
+
+## Summary
+This sample illustrates how SPFx functionality and packages can be bundled in multiple '.js' files then be dynamically & asynchronously loaded into the page at execution time, such as with a button click.
+
+Pre Button Click:
+![preview](./assets/WebPart-Preview-PreClick.jpg)
+
+Post Button Click that imports jQuery and additional functionality:
+![preview](./assets/WebPart-Preview-PostjQueryClick.jpg)
+
+## Used SharePoint Framework Version 
+![drop](https://img.shields.io/badge/drop-1.6.0-blue.svg)
+
+## Applies to
+
+* [SharePoint Framework](https:/dev.office.com/sharepoint)
+* [Office 365 tenant](https://dev.office.com/sharepoint/docs/spfx/set-up-your-development-environment)
+
+
+## Solution
+
+Solution|Author(s)
+--------|---------
+js-dynamic-bundling-libaries | David Warner II ([@DavidWarnerII](https://twitter.com/davidwarnerii) / [Warner Digital](http://warner.digital))
+
+## Version history
+
+Version|Date|Comments
+-------|----|--------
+1.0|September 21, 2018|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
+- in the command line run:
+  - `npm install`
+  - `gulp serve`
+
+
+
+## Features
+This Web Part illustrates the following concepts on top of the SharePoint Framework:
+
+- How to separate SPFx functionality into multiple bundled files
+- How to asynchronously load the seperate bundled files at execution time
+- Including a library in the separate bundled file.
+
+## Additional Information:
+- [Dynamic loading of packages in SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/dynamic-loading)
+
+- Video Demonstration on using, building and code specifics for the sample web part:<br>   http://warner.digital/dynamic-spfx-package-bundling/ 
+
+<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/readme-template" />

samples/js-dynamic-bundling-libraries/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": {
+    "dynamic-bundling-example-web-part": {
+      "components": [
+        {
+          "entrypoint": "./lib/webparts/dynamicBundlingExample/DynamicBundlingExampleWebPart.js",
+          "manifest": "./src/webparts/dynamicBundlingExample/DynamicBundlingExampleWebPart.manifest.json"
+        }
+      ]
+    }
+  },
+  "externals": {},
+  "localizedResources": {
+    "DynamicBundlingExampleWebPartStrings": "lib/webparts/dynamicBundlingExample/loc/{locale}.js"
+  }
+}

samples/js-dynamic-bundling-libraries/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/js-dynamic-bundling-libraries/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": "dynamic-bundling",
+  "accessKey": "<!-- ACCESS KEY -->"
+}

samples/js-dynamic-bundling-libraries/config/package-solution.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/package-solution.schema.json",
+  "solution": {
+    "name": "dynamic-bundling-client-side-solution",
+    "id": "c40970b0-7ef0-40f2-b03b-718751fbc4b5",
+    "version": "1.0.0.0",
+    "includeClientSideAssets": true
+  },
+  "paths": {
+    "zippedPackage": "solution/dynamic-bundling.sppkg"
+  }
+}

samples/js-dynamic-bundling-libraries/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/js-dynamic-bundling-libraries/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/js-dynamic-bundling-libraries/gulpfile.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const gulp = require('gulp');
+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(gulp);

samples/js-dynamic-bundling-libraries/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "dynamic-bundling",
+  "version": "0.0.1",
+  "private": true,
+  "engines": {
+    "node": ">=0.10.0"
+  },
+  "scripts": {
+    "build": "gulp bundle",
+    "clean": "gulp clean",
+    "test": "gulp test"
+  },
+  "dependencies": {
+    "@microsoft/sp-core-library": "1.6.0",
+    "@microsoft/sp-lodash-subset": "1.6.0",
+    "@microsoft/sp-office-ui-fabric-core": "1.6.0",
+    "@microsoft/sp-webpart-base": "1.6.0",
+    "@types/es6-promise": "0.0.33",
+    "@types/jquery": "^3.3.6",
+    "@types/webpack-env": "1.13.1",
+    "jquery": "^3.3.1"
+  },
+  "devDependencies": {
+    "@microsoft/sp-build-web": "1.6.0",
+    "@microsoft/sp-module-interfaces": "1.6.0",
+    "@microsoft/sp-webpart-workbench": "1.6.0",
+    "tslint-microsoft-contrib": "~5.0.0",
+    "gulp": "~3.9.1",
+    "@types/chai": "3.4.34",
+    "@types/mocha": "2.2.38",
+    "ajv": "~5.2.2"
+  }
+}

samples/js-dynamic-bundling-libraries/src/index.ts

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

samples/js-dynamic-bundling-libraries/src/webparts/dynamicBundlingExample/DynamicBundlingExampleWebPart.manifest.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx/client-side-web-part-manifest.schema.json",
+  "id": "5378270a-cb87-4be2-b3b7-0ddf597fd77d",
+  "alias": "DynamicBundlingExampleWebPart",
+  "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,
+
+  "preconfiguredEntries": [{
+    "groupId": "5c03119e-3074-46fd-976b-c60198311f70", // Other
+    "group": { "default": "Other" },
+    "title": { "default": "Dynamic Bundling Example" },
+    "description": { "default": "Dynamic Bundling Example description" },
+    "officeFabricIconFontName": "Page",
+    "properties": {
+      "description": "Dynamic Bundling Example"
+    }
+  }]
+}

samples/js-dynamic-bundling-libraries/src/webparts/dynamicBundlingExample/DynamicBundlingExampleWebPart.module.scss

@@ -0,0 +1,77 @@
+@import '~@microsoft/sp-office-ui-fabric-core/dist/sass/SPFabricCore.scss';
+
+.dynamicBundlingExample {
+  .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;
+    @include ms-fontColor-white;
+    background-color: $ms-color-themeDark;
+    padding: 20px;
+  }
+
+  .column {
+    @include ms-Grid-col;
+    @include ms-lg10;
+    @include ms-xl8;
+    @include ms-xlPush2;
+    @include ms-lgPush1;
+    width:90% !important;
+  }
+
+  .title {
+    @include ms-font-xl;
+    @include ms-fontColor-white;
+  }
+
+  .subTitle {
+    @include ms-font-l;
+    @include ms-fontColor-white;
+    width:100% !important;
+
+  }
+
+  .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/js-dynamic-bundling-libraries/src/webparts/dynamicBundlingExample/DynamicBundlingExampleWebPart.ts

@@ -0,0 +1,101 @@
+import { Version } from '@microsoft/sp-core-library';
+import {
+  BaseClientSideWebPart,
+  IPropertyPaneConfiguration,
+  PropertyPaneTextField
+} from '@microsoft/sp-webpart-base';
+import { escape } from '@microsoft/sp-lodash-subset';
+
+import styles from './DynamicBundlingExampleWebPart.module.scss';
+import * as strings from 'DynamicBundlingExampleWebPartStrings';
+
+export interface IDynamicBundlingExampleWebPartProps {
+  description: string;
+}
+
+export default class DynamicBundlingExampleWebPart extends BaseClientSideWebPart<IDynamicBundlingExampleWebPartProps> {
+
+  public render(): void {
+    this.domElement.innerHTML = `
+      <div class="${ styles.dynamicBundlingExample }">
+        <div class="${ styles.container }">
+          <div class="${ styles.row }">
+            <div class="${ styles.column }">
+              <span class="${ styles.title }">Dynamic Bundling & Loading of SPFx Packages</span>
+              <p class="${ styles.subTitle }">When the buttons below are clicked, the associated ".ts" file and it's functionality will be loaded.</p>
+              <a id="ImportButton" href="#" class="${ styles.button }">
+                <span class="${ styles.label }">Dynamically Import Functionality</span>
+              </a>
+
+              <a id="ImportButtonJQuery" href="#" class="${ styles.button }">
+                <span class="${ styles.label }">Dynamically Import Functionality w/ jQuery</span>
+              </a>
+            </div>
+            <div class="insertHTML"></div>
+          </div>
+        </div>
+      </div>`;
+      this.setupClickEvent();
+  }
+
+  protected get dataVersion(): Version {
+    return Version.parse('1.0');
+  }
+
+  // Create a click event listener for the ImportButton Anchor element
+  public setupClickEvent(): void {
+    let btn = document.getElementById("ImportButton");
+    btn.addEventListener("click", (e:Event) => this.dynamicallyImportFunctions());
+
+    let btnjQuery = document.getElementById("ImportButtonJQuery");
+    btnjQuery.addEventListener("click", (e:Event) => this.dynamicallyImportFunctionsJQuery());
+  }
+
+  // This will setup the 'DynamicImportedFunctions.ts' to be bundled into a separate .js file.
+  protected async dynamicallyImportFunctions() {
+    const importedTS = await import(
+      './DynamicImportedFunctions'
+    )
+    importedTS.default.executeDynamicLoad();
+  }
+
+  //This will setup the 'DynamicImportedFunctionsJQuery.ts' to be bundled into a separate .js file.
+  protected async dynamicallyImportFunctionsJQuery() {
+    const importedJQueryTS = await import(
+      './DynamicImportedFunctionsJQuery'
+    )
+    importedJQueryTS.default.executeDynamicLoadJQuery();
+    importedJQueryTS.default.addToDOM(this.domElement);
+  }
+
+
+
+
+
+
+
+
+
+
+  protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration {
+    return {
+      pages: [
+        {
+          header: {
+            description: strings.PropertyPaneDescription
+          },
+          groups: [
+            {
+              groupName: strings.BasicGroupName,
+              groupFields: [
+                PropertyPaneTextField('description', {
+                  label: strings.DescriptionFieldLabel
+                })
+              ]
+            }
+          ]
+        }
+      ]
+    };
+  }
+}

samples/js-dynamic-bundling-libraries/src/webparts/dynamicBundlingExample/DynamicImportedFunctions.ts

@@ -0,0 +1,15 @@
+/*
+This file demonstrates how we can separate functionality that might not need to be loaded with the SPFx Web Part or Extension immediately, but be bundled into a separate .js file and loaded dynamically.
+
+This function will write a message to the console when it is dynamcially loaded.
+*/
+
+
+export default class DynamicFunctions {
+    public static executeDynamicLoad():void {
+        console.log('Dynamic Functionality has been imported');
+    }
+
+}
+
+

samples/js-dynamic-bundling-libraries/src/webparts/dynamicBundlingExample/DynamicImportedFunctionsJQuery.scss

@@ -0,0 +1,6 @@
+  .injectedContent {
+    clear:both;
+    padding-top:20px;
+    margin-left:60px;
+    font-size:20px;
+  }

samples/js-dynamic-bundling-libraries/src/webparts/dynamicBundlingExample/DynamicImportedFunctionsJQuery.ts

@@ -0,0 +1,32 @@
+/*
+This file demonstrates how we can separate functionality that might not need to be loaded with the SPFx Web Part or Extension immediately, but be bundled into a separate .js file and loaded dynamically.
+
+We will be bundling jQuery in the imported .ts file.
+This demonstrates how if we have the need to bundle a third party library, such as jQuery, we can delay the loading of it as well as any additional functionality until aboslutely needed.
+
+This example will add a CSS class to the <body> element, write a message to the console and inject some HTML letting us know that jQuery has been loaded.
+*/
+
+import * as $ from 'jquery';
+require('./DynamicImportedFunctionsJQuery.scss');
+
+export default class DynamicFunctionsJQuery {
+    public static executeDynamicLoadJQuery():void {
+        console.log('Dynamic Functionality with jQuery has been imported');
+        $('body').addClass('jQueryImported');
+        
+    }
+
+    public static addToDOM(webpart:HTMLElement){
+        //console.log(webpart);
+        var item = webpart.getElementsByClassName('insertHTML')[0];
+        item.innerHTML = `
+        <div class="injectedContent">
+        <span class="">jQuery has been dynamically imported.</span>
+        </div>
+        `
+    }
+
+}
+
+

samples/js-dynamic-bundling-libraries/src/webparts/dynamicBundlingExample/loc/en-us.js

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

samples/js-dynamic-bundling-libraries/src/webparts/dynamicBundlingExample/loc/mystrings.d.ts

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

samples/js-dynamic-bundling-libraries/tsconfig.json

@@ -0,0 +1,34 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "forceConsistentCasingInFileNames": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "jsx": "react",
+    "declaration": true,
+    "sourceMap": true,
+    "experimentalDecorators": true,
+    "skipLibCheck": true,
+    "outDir": "lib",
+    "typeRoots": [
+      "./node_modules/@types",
+      "./node_modules/@microsoft"
+    ],
+    "types": [
+      "es6-promise",
+      "webpack-env"
+    ],
+    "lib": [
+      "es5",
+      "dom",
+      "es2015.collection"
+    ]
+  },
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "lib"
+  ]
+}

samples/js-dynamic-bundling-libraries/tslint.json

@@ -0,0 +1,32 @@
+{
+  "rulesDirectory": [
+    "tslint-microsoft-contrib"
+  ],
+  "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-use-before-declare": true,
+    "no-with-statement": true,
+    "semicolon": true,
+    "trailing-comma": false,
+    "typedef": false,
+    "typedef-whitespace": false,
+    "use-named-parameter": true,
+    "variable-name": false,
+    "whitespace": false
+  }
+}

tutorials/api-scopes/.yo-rc.json

@@ -1,8 +1,11 @@
 {
   "@microsoft/generator-sharepoint": {
-    "version": "1.4.1",
+    "version": "1.6.0",
     "libraryName": "spfx-api-scopes-tutorial",
     "libraryId": "6b58cc7d-badc-4721-bfe2-9e4d91efd07c",
-    "environment": "spo"
+    "environment": "spo",
+    "isCreatingSolution": true,
+    "packageManager": "npm",
+    "componentType": "webpart"
   }
 }

tutorials/api-scopes/README.md

@@ -16,6 +16,7 @@ This sub folders contains a client-side project that is related to the tutorial
 
 | Version  | Date | Comments |
 | ------------- | ------------- | ------------- |
+| 1.0.0  | August 28th 2018     | Updated sample to SPFx v1.6.0 |
 | 1.0.0  | February 18th 2018   | Initial release |
 
 ## Disclaimer

tutorials/api-scopes/config/config.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://dev.office.com/json-schemas/spfx-build/config.2.0.schema.json",
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/config.2.0.schema.json",
   "version": "2.0",
   "bundles": {
     "graph-consumer-web-part": {

tutorials/api-scopes/config/copy-assets.json

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

tutorials/api-scopes/config/deploy-azure-storage.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://dev.office.com/json-schemas/spfx-build/deploy-azure-storage.schema.json",
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/deploy-azure-storage.schema.json",
   "workingDir": "./temp/deploy/",
   "account": "<!-- STORAGE ACCOUNT NAME -->",
   "container": "spfx-api-scopes-tutorial",

tutorials/api-scopes/config/package-solution.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://dev.office.com/json-schemas/spfx-build/package-solution.schema.json",
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/package-solution.schema.json",
   "solution": {
     "name": "spfx-api-scopes-tutorial-client-side-solution",
     "id": "6b58cc7d-badc-4721-bfe2-9e4d91efd07c",

tutorials/api-scopes/config/serve.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://dev.office.com/json-schemas/core-build/serve.schema.json",
+  "$schema": "https://developer.microsoft.com/json-schemas/core-build/serve.schema.json",
   "port": 4321,
   "https": true,
   "initialPage": "https://localhost:5432/workbench",

tutorials/api-scopes/config/tslint.json

@@ -1,45 +0,0 @@
-{
-  "$schema": "https://dev.office.com/json-schemas/core-build/tslint.schema.json",
-  // Display errors as warnings
-  "displayAsWarning": true,
-  // The TSLint task may have been configured with several custom lint rules
-  // before this config file is read (for example lint rules from the tslint-microsoft-contrib
-  // project). If true, this flag will deactivate any of these rules.
-  "removeExistingRules": true,
-  // When true, the TSLint task is configured with some default TSLint "rules.":
-  "useDefaultConfigAsBase": false,
-  // Since removeExistingRules=true and useDefaultConfigAsBase=false, there will be no lint rules
-  // which are active, other than the list of rules below.
-  "lintConfig": {
-    // Opt-in to Lint rules which help to eliminate bugs in JavaScript
-    "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-case": true,
-      "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-use-before-declare": true,
-      "no-with-statement": true,
-      "semicolon": true,
-      "trailing-comma": false,
-      "typedef": false,
-      "typedef-whitespace": false,
-      "use-named-parameter": true,
-      "valid-typeof": true,
-      "variable-name": false,
-      "whitespace": false
-    }
-  }
-}

tutorials/api-scopes/config/write-manifests.json

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

tutorials/api-scopes/package.json

@@ -11,23 +11,25 @@
     "test": "gulp test"
   },
   "dependencies": {
-    "react": "15.6.2",
-    "react-dom": "15.6.2",
+    "@microsoft/sp-core-library": "1.6.0",
+    "@microsoft/sp-lodash-subset": "1.6.0",
+    "@microsoft/sp-office-ui-fabric-core": "1.6.0",
+    "@microsoft/sp-webpart-base": "1.6.0",
+    "@types/es6-promise": "0.0.33",
     "@types/react": "15.6.6",
     "@types/react-dom": "15.5.6",
-    "@microsoft/sp-core-library": "~1.4.1",
-    "@microsoft/sp-webpart-base": "~1.4.1",
-    "@microsoft/sp-lodash-subset": "~1.4.1",
-    "@microsoft/sp-office-ui-fabric-core": "~1.4.1",
-    "@types/webpack-env": ">=1.12.1 <1.14.0"
+    "@types/webpack-env": "1.13.1",
+    "react": "15.6.2",
+    "react-dom": "15.6.2"
   },
   "devDependencies": {
-    "@microsoft/sp-build-web": "~1.4.1",
-    "@microsoft/sp-module-interfaces": "~1.4.1",
-    "@microsoft/sp-webpart-workbench": "~1.4.1",
+    "@microsoft/sp-build-web": "1.6.0",
+    "@microsoft/sp-module-interfaces": "1.6.0",
+    "@microsoft/sp-webpart-workbench": "1.6.0",
+    "@types/chai": "3.4.34",
+    "@types/mocha": "2.2.38",
+    "ajv": "~5.2.2",
     "gulp": "~3.9.1",
-    "@types/chai": ">=3.4.34 <3.6.0",
-    "@types/mocha": ">=2.2.33 <2.6.0",
-    "ajv": "~5.2.2"
+    "tslint-microsoft-contrib": "5.0.0"
   }
 }

tutorials/api-scopes/src/index.ts

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

tutorials/api-scopes/src/webparts/graphConsumer/GraphConsumerWebPart.manifest.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://dev.office.com/json-schemas/spfx/client-side-web-part-manifest.schema.json",
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx/client-side-web-part-manifest.schema.json",
   "id": "0c2bdcfd-b8ea-474d-acea-a1c17bff2310",
   "alias": "GraphConsumerWebPart",
   "componentType": "WebPart",

tutorials/api-scopes/src/webparts/graphConsumer/components/GraphConsumer.tsx

@@ -18,8 +18,7 @@ import {
   SelectionMode
 } from 'office-ui-fabric-react';
 
-import { AadHttpClient } from "@microsoft/sp-http";
-import { MSGraphClient } from "@microsoft/sp-client-preview";
+import { AadHttpClient, MSGraphClient } from "@microsoft/sp-http";
 
 // Configure the columns for the DetailsList component
 let _usersListColumns = [
@@ -153,17 +152,16 @@ export default class GraphConsumer extends React.Component<IGraphConsumerProps,
     console.log("Using _searchWithAad() method");
 
     // Using Graph here, but any 1st or 3rd party REST API that requires Azure AD auth can be used here.
-    const aadClient: AadHttpClient = new AadHttpClient(
-      this.props.context.serviceScope,
-      "https://graph.microsoft.com"
-    );
-
-    // Search for the users with givenName, surname, or displayName equal to the searchFor value
-    aadClient
-      .get(
-        `https://graph.microsoft.com/v1.0/users?$select=displayName,mail,userPrincipalName&$filter=(givenName%20eq%20'${escape(this.state.searchFor)}')%20or%20(surname%20eq%20'${escape(this.state.searchFor)}')%20or%20(displayName%20eq%20'${escape(this.state.searchFor)}')`,
-        AadHttpClient.configurations.v1
-      )
+    this.props.context.aadHttpClientFactory
+      .getClient("https://graph.microsoft.com")
+      .then((client: AadHttpClient) => {
+        // Search for the users with givenName, surname, or displayName equal to the searchFor value
+        return client
+          .get(
+            `https://graph.microsoft.com/v1.0/users?$select=displayName,mail,userPrincipalName&$filter=(givenName%20eq%20'${escape(this.state.searchFor)}')%20or%20(surname%20eq%20'${escape(this.state.searchFor)}')%20or%20(displayName%20eq%20'${escape(this.state.searchFor)}')`,
+            AadHttpClient.configurations.v1
+          );
+      })
       .then(response => {
         return response.json();
       })
@@ -201,41 +199,41 @@ export default class GraphConsumer extends React.Component<IGraphConsumerProps,
     // Log the current operation
     console.log("Using _searchWithGraph() method");
 
-    const graphClient: MSGraphClient = this.props.context.serviceScope.consume(
-      MSGraphClient.serviceKey
-    );
+    this.props.context.msGraphClientFactory
+      .getClient()
+      .then((client: MSGraphClient) => {
+        // From https://github.com/microsoftgraph/msgraph-sdk-javascript sample
+        client
+          .api("users")
+          .version("v1.0")
+          .select("displayName,mail,userPrincipalName")
+          .filter(`(givenName eq '${escape(this.state.searchFor)}') or (surname eq '${escape(this.state.searchFor)}') or (displayName eq '${escape(this.state.searchFor)}')`)
+          .get((err, res) => {  
 
-    // From https://github.com/microsoftgraph/msgraph-sdk-javascript sample
-    graphClient
-      .api("users")
-      .version("v1.0")
-      .select("displayName,mail,userPrincipalName")
-      .filter(`(givenName eq '${escape(this.state.searchFor)}') or (surname eq '${escape(this.state.searchFor)}') or (displayName eq '${escape(this.state.searchFor)}')`)
-      .get((err, res) => {  
+            if (err) {
+              console.error(err);
+              return;
+            }
 
-        if (err) {
-          console.error(err);
-          return;
-        }
+            // Prepare the output array
+            var users: Array<IUserItem> = new Array<IUserItem>();
 
-        // Prepare the output array
-        var users: Array<IUserItem> = new Array<IUserItem>();
+            // Map the JSON response to the output array
+            res.value.map((item: any) => {
+              users.push( { 
+                displayName: item.displayName,
+                mail: item.mail,
+                userPrincipalName: item.userPrincipalName,
+              });
+            });
 
-        // Map the JSON response to the output array
-        res.value.map((item: any) => {
-          users.push( { 
-            displayName: item.displayName,
-            mail: item.mail,
-            userPrincipalName: item.userPrincipalName,
+            // Update the component state accordingly to the result
+            this.setState(
+              {
+                users: users,
+              }
+            );
           });
-        });
-
-        // Update the component state accordingly to the result
-        this.setState(
-          {
-            users: users,
-          }
-        );
       });
   }
 }

tutorials/api-scopes/tsconfig.json

@@ -2,12 +2,14 @@
   "compilerOptions": {
     "target": "es5",
     "forceConsistentCasingInFileNames": true,
-    "module": "commonjs",
+    "module": "esnext",
     "jsx": "react",
     "declaration": true,
     "sourceMap": true,
     "experimentalDecorators": true,
+    "moduleResolution": "node",
     "skipLibCheck": true,
+    "outDir": "lib",
     "typeRoots": [
       "./node_modules/@types",
       "./node_modules/@microsoft"
@@ -21,5 +23,12 @@
       "dom",
       "es2015.collection"
     ]
-  }
+  },
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "lib"
+  ]
 }

tutorials/api-scopes/tslint.json

@@ -0,0 +1,32 @@
+{
+  "rulesDirectory": [
+    "tslint-microsoft-contrib"
+  ],
+  "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-use-before-declare": true,
+    "no-with-statement": true,
+    "semicolon": true,
+    "trailing-comma": false,
+    "typedef": false,
+    "typedef-whitespace": false,
+    "use-named-parameter": true,
+    "variable-name": false,
+    "whitespace": false
+  }
+}