From a528b228da07ddd71d4e7779437651e653910c6c Mon Sep 17 00:00:00 2001
From: Nikitha Chettiar <nikithauc@gmail.com>
Date: Tue, 23 Feb 2021 00:36:29 -0800
Subject: [PATCH 1/4] Create publishing.md

---
 design/publishing.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 design/publishing.md

diff --git a/design/publishing.md b/design/publishing.md
new file mode 100644
index 000000000..e4d145d1a
--- /dev/null
+++ b/design/publishing.md
@@ -0,0 +1,36 @@
+This design document focuses on the following - 
+1. Separate entry points for node and browser.
+2. Specifying the browser field in package.json
+3. Changes in the bundling process
+
+Terms -
+
+bundler - Module bundlers are tools frontend developers used to bundle JavaScript modules into a single JavaScript files that can be executed in the browser.
+
+package.json fields - 
+* main - The main field is a module ID that is the primary entry point to your program. Points to the CJS modules.
+
+* module - The module field is not an official npm feature but a common convention among bundlers to designate how to import an ESM version of a library. Points to the ES modules.
+
+* browser - If your module is meant to be used client-side the browser field should be used instead of the main field.
+
+Current set up -
+
+1. 
+                        TypeScript Source Code
+                                / \
+                      Transpiles into JavaScript 
+                               /   \
+                     CJS module     ES modules
+2. main - `lib/src/index.js`
+   module - `lib/src/es/index.js`
+
+3. Rollup bundling output
+* graph-js-sdk.js - IIFE bundled file. This file can be directly used in the browser with a `<script>` tag.
+* graph-es-sdk.js - ES bundled file.
+4. Entry point for rollup - `lib/es/browser/index.js`.
+5. 
+
+Upcoming changes - 
+
+1. Bundle the authproviders serately as they are optional.

From 7ac914bc3545fbf55f8be25aee21b5d4a7a97792 Mon Sep 17 00:00:00 2001
From: Nikitha Chettiar <nikithauc@gmail.com>
Date: Tue, 23 Feb 2021 12:20:58 -0800
Subject: [PATCH 2/4] Update publishing.md

---
 design/publishing.md | 35 +++++++++++++++++++++++++++--------
 1 file changed, 27 insertions(+), 8 deletions(-)

diff --git a/design/publishing.md b/design/publishing.md
index e4d145d1a..40f0939eb 100644
--- a/design/publishing.md
+++ b/design/publishing.md
@@ -1,9 +1,9 @@
-This design document focuses on the following - 
+##### This design document focuses on the following - 
 1. Separate entry points for node and browser.
 2. Specifying the browser field in package.json
 3. Changes in the bundling process
 
-Terms -
+##### Terms -
 
 bundler - Module bundlers are tools frontend developers used to bundle JavaScript modules into a single JavaScript files that can be executed in the browser.
 
@@ -14,7 +14,7 @@ package.json fields -
 
 * browser - If your module is meant to be used client-side the browser field should be used instead of the main field.
 
-Current set up -
+##### Current set up -
 
 1. 
                         TypeScript Source Code
@@ -26,11 +26,30 @@ Current set up -
    module - `lib/src/es/index.js`
 
 3. Rollup bundling output
-* graph-js-sdk.js - IIFE bundled file. This file can be directly used in the browser with a `<script>` tag.
+* graph-js-sdk.js - IIFE bundled minified file. This file can be directly used in the browser with a `<script>` tag.
 * graph-es-sdk.js - ES bundled file.
 4. Entry point for rollup - `lib/es/browser/index.js`.
-5. 
 
-Upcoming changes - 
-
-1. Bundle the authproviders serately as they are optional.
+##### Difference between src/index.js and src/browser/index.js
+1. src/browser/index.js does not export  'RedirectHandler' and 'RedirectHandlerOptions'. Redirection is handled by the browser.
+2.  src/index.js  exports-> src/ImplicitMsalProvider and src/browser/index.js exports src/browser/ImplicitMsalProvider.
+3. Only difference in the implementation is that src/browser/ImplicitMsalProvider does not import or require 'msal' dependency.
+
+Presently, some browser applications importing the npm package like Graph Explorer use lib/es/src/index.js and not the browser/index.js.
+
+##### Upcoming changes - 
+
+1. Use the browser field for the following -
+
+* We currently have two entry files, src/index.ts and src/browser/index.ts.
+Use the browser field to indicate the browser entry point.
+Example -
+"browser":
+{ "lib/es/index.node.js": "lib/es/index.browser.js" }
+Currently, we have the main and "module field in the package.json. This will remain the same.
+2. Better way to handle environment specific implementation. For example, using the browser field we can indicate as follows -
+"browser":
+{ "stream": "stream-browserify" } 
+3. Maintain a separate entry point for the rollup process. 
+4. Continue rolling up the src/browser/ImplicitMsalProvider as we currently do and not introduce breaking changes here as we are planning to deprecate this.
+5. Bundle the authproviders separately as they are optional.

From 39f52b053aaa48565437b4be52f3e04d57bfe5d2 Mon Sep 17 00:00:00 2001
From: Nikitha Chettiar <nikithauc@gmail.com>
Date: Sun, 28 Feb 2021 23:38:50 -0800
Subject: [PATCH 3/4] Update publishing.md

---
 design/publishing.md | 58 +++++++++++++++++++++++++++-----------------
 1 file changed, 36 insertions(+), 22 deletions(-)

diff --git a/design/publishing.md b/design/publishing.md
index 40f0939eb..6c0d87ca4 100644
--- a/design/publishing.md
+++ b/design/publishing.md
@@ -1,18 +1,20 @@
 ##### This design document focuses on the following - 
 1. Separate entry points for node and browser.
-2. Specifying the browser field in package.json
-3. Changes in the bundling process
+2. Specifying the browser field in package.json.
+3. Changes in the bundling process.
 
 ##### Terms -
 
-bundler - Module bundlers are tools frontend developers used to bundle JavaScript modules into a single JavaScript files that can be executed in the browser.
+* bundler - Module bundlers are tools frontend developers used to bundle JavaScript modules into a single JavaScript files that can be executed in the browser.
 
-package.json fields - 
-* main - The main field is a module ID that is the primary entry point to your program. Points to the CJS modules.
+* rollup - rollup.js is the module bundler that the JS SDK uses. 
 
-* module - The module field is not an official npm feature but a common convention among bundlers to designate how to import an ESM version of a library. Points to the ES modules.
+* package.json fields - 
+  * main - The main field is a module ID that is the primary entry point to your program. Points to the CJS modules.
 
-* browser - If your module is meant to be used client-side the browser field should be used instead of the main field.
+  * module - The module field is not an official npm feature but a common convention among bundlers to designate how to import an ESM version of a library. Points to the ES modules.
+
+  * browser - If the module is meant to be used client-side, the browser field should be used instead of the main field.
 
 ##### Current set up -
 
@@ -20,36 +22,48 @@ package.json fields -
                         TypeScript Source Code
                                 / \
                       Transpiles into JavaScript 
+                             'lib' folder
                                /   \
                      CJS module     ES modules
 2. main - `lib/src/index.js`
-   module - `lib/src/es/index.js`
+   module - `lib/es/src/index.js`
 
 3. Rollup bundling output
-* graph-js-sdk.js - IIFE bundled minified file. This file can be directly used in the browser with a `<script>` tag.
-* graph-es-sdk.js - ES bundled file.
-4. Entry point for rollup - `lib/es/browser/index.js`.
+* `graph-js-sdk.js` - Bundled and minified file in IIFE format. This file can be directly used in the browser with a `<script>` tag.
+* `graph-es-sdk.js` - Bundled filein ES format.
+4. Entry point for rollup - `lib/es/src/browser/index.js`.
 
 ##### Difference between src/index.js and src/browser/index.js
-1. src/browser/index.js does not export  'RedirectHandler' and 'RedirectHandlerOptions'. Redirection is handled by the browser.
-2.  src/index.js  exports-> src/ImplicitMsalProvider and src/browser/index.js exports src/browser/ImplicitMsalProvider.
-3. Only difference in the implementation is that src/browser/ImplicitMsalProvider does not import or require 'msal' dependency.
+1. `src/browser/index.js` does not export  `RedirectHandler` and `RedirectHandlerOptions`. Redirection is handled by the browser.
+2. `src/browser/index.js` exports `src/browser/ImplicitMsalProvider`.
+3. `src/browser/ImplicitMsalProvider` does not import or require 'msal' dependency. While, 
+`src/ImplicitMsalProvider` imports or requires 'msal' in the implementation. 
+4. My assumtion is that `src/browser/ImplicitMsalProvider` is implemented specifically for the rollup process and to skip the rollup external dependency while using `graph-js-sdk.js` in the browser.
 
-Presently, some browser applications importing the npm package like Graph Explorer use lib/es/src/index.js and not the browser/index.js.
+Note - Browser applications using the ES modules from the npm package of the JS SDK refer to the `module` entry point - `lib/es/src/index.js`(not the browser entry point). Example - Graph Explorer.
 
 ##### Upcoming changes - 
 
 1. Use the browser field for the following -
 
-* We currently have two entry files, src/index.ts and src/browser/index.ts.
+* We currently have two entry files, `src/index` and `src/browser/index`.
 Use the browser field to indicate the browser entry point.
 Example -
 "browser":
-{ "lib/es/index.node.js": "lib/es/index.browser.js" }
+{ "lib/es/src/index.js": "lib/es/src/browser/index.js" }
 Currently, we have the main and "module field in the package.json. This will remain the same.
-2. Better way to handle environment specific implementation. For example, using the browser field we can indicate as follows -
+* Better way to handle environment specific implementation. For example, using the `browser` field we can indicate as follows -
 "browser":
-{ "stream": "stream-browserify" } 
-3. Maintain a separate entry point for the rollup process. 
-4. Continue rolling up the src/browser/ImplicitMsalProvider as we currently do and not introduce breaking changes here as we are planning to deprecate this.
-5. Bundle the authproviders separately as they are optional.
+{ "stream": "stream-browserify",
+  "Feature-Node.js": "Feature-Browser.js"
+} 
+
+
+2. Remove  export of `src/browser/ImplicitMsalProvider` from `src/browser/index`.
+* Till `ImplicitMsalProvider` is maintained in the repo, maintain a separate entry point say `rollup-index` for the rollup process which exports  `src/browser/index` and `src/browser/ImplicitMsalProvider`. 
+* Continue rolling up the `src/browser/ImplicitMsalProvider` as we currently do and not introduce breaking changes here as we are planning to deprecate this.
+* Remove the separate entry point once `ImplicitMsalProvider` is removed and use the browser entry point for roll up thereafter. The goal is to maintain a consistent entry point or usage for browser applications using the JS SDK and the rollup/bundling process. 
+
+3. Bundle the authproviders separately as they are optional.
+
+4. Stop bundling in ES format, that is remove `graph-es-sdk.js` as the ES modules are being shipped. 

From 647c3294bebfed53cdfe559dbfb33d70216f8be3 Mon Sep 17 00:00:00 2001
From: Nikitha Chettiar <nikithauc@gmail.com>
Date: Thu, 4 Mar 2021 00:50:55 -0800
Subject: [PATCH 4/4] Format errors

---
 design/publishing.md | 22 +++++++++++++---------
 1 file changed, 13 insertions(+), 9 deletions(-)

diff --git a/design/publishing.md b/design/publishing.md
index 6c0d87ca4..685dc46dd 100644
--- a/design/publishing.md
+++ b/design/publishing.md
@@ -30,7 +30,7 @@
 
 3. Rollup bundling output
 * `graph-js-sdk.js` - Bundled and minified file in IIFE format. This file can be directly used in the browser with a `<script>` tag.
-* `graph-es-sdk.js` - Bundled filein ES format.
+* `graph-es-sdk.js` - Bundled file in ES format.
 4. Entry point for rollup - `lib/es/src/browser/index.js`.
 
 ##### Difference between src/index.js and src/browser/index.js
@@ -46,22 +46,26 @@ Note - Browser applications using the ES modules from the npm package of the JS
 
 1. Use the browser field for the following -
 
-* We currently have two entry files, `src/index` and `src/browser/index`.
+* The Graph JS SDK currently has two entry files, `src/index` and `src/browser/index`.
 Use the browser field to indicate the browser entry point.
 Example -
+```json
 "browser":
 { "lib/es/src/index.js": "lib/es/src/browser/index.js" }
-Currently, we have the main and "module field in the package.json. This will remain the same.
-* Better way to handle environment specific implementation. For example, using the `browser` field we can indicate as follows -
+```
+Currently, the main and "module field in the package.json. This will remain the same.
+* Better way to handle environment specific implementation. For example, using the `browser` field as follows -
 "browser":
-{ "stream": "stream-browserify",
-  "Feature-Node.js": "Feature-Browser.js"
+```json
+{ 
+ "stream": "stream-browserify",
+ "Feature-Node.js": "Feature-Browser.js"
 } 
-
+```
 
 2. Remove  export of `src/browser/ImplicitMsalProvider` from `src/browser/index`.
-* Till `ImplicitMsalProvider` is maintained in the repo, maintain a separate entry point say `rollup-index` for the rollup process which exports  `src/browser/index` and `src/browser/ImplicitMsalProvider`. 
-* Continue rolling up the `src/browser/ImplicitMsalProvider` as we currently do and not introduce breaking changes here as we are planning to deprecate this.
+* Till `ImplicitMsalProvider` is maintained in the repo, maintain a separate entry point say `rollup-index` for the rollup process which exports `src/browser/index` and `src/browser/ImplicitMsalProvider`. 
+* Continue rolling up the `src/browser/ImplicitMsalProvider` as it is currently done and not introduce breaking changes here as it is going to be deprecated.
 * Remove the separate entry point once `ImplicitMsalProvider` is removed and use the browser entry point for roll up thereafter. The goal is to maintain a consistent entry point or usage for browser applications using the JS SDK and the rollup/bundling process. 
 
 3. Bundle the authproviders separately as they are optional.