From c03430d4d5b93d983c9cab39117a5623113425e8 Mon Sep 17 00:00:00 2001
From: john gravois <jgravois@esri.com>
Date: Tue, 12 Jun 2018 17:32:05 -0700
Subject: [PATCH] feat(auth): add getCredential() method to UserSession for
 jsapi

AFFECTS PACKAGES:
@esri/arcgis-rest-auth

ISSUES CLOSED: #208
---
 demos/feature-service-browser/index.html      |   6 +-
 demos/geocoder-browser/index.html             |   6 +-
 demos/jsapi-integration/README.md             |   8 +
 demos/jsapi-integration/index.html            |  82 ++++++++
 demos/jsapi-integration/package-lock.json     | 184 ++++++++++++++++++
 demos/jsapi-integration/package.json          |  19 ++
 docs/acetate.config.js                        |   3 +-
 docs/src/guides/amd-requirejs-dojo.md         |  31 +++
 docs/src/guides/from-a-cdn.md                 |   2 +-
 packages/arcgis-rest-auth/src/UserSession.ts  |  23 ++-
 .../arcgis-rest-auth/test/UserSession.test.ts |  30 ++-
 11 files changed, 384 insertions(+), 10 deletions(-)
 create mode 100644 demos/jsapi-integration/README.md
 create mode 100644 demos/jsapi-integration/index.html
 create mode 100644 demos/jsapi-integration/package-lock.json
 create mode 100644 demos/jsapi-integration/package.json

diff --git a/demos/feature-service-browser/index.html b/demos/feature-service-browser/index.html
index 6a761197bc..4bc03100d3 100644
--- a/demos/feature-service-browser/index.html
+++ b/demos/feature-service-browser/index.html
@@ -57,8 +57,8 @@ <h1>query features!</h1>
 </div>
 
 <!-- load arcgis rest libraries -->
-<script src="node_modules/@esri/arcgis-rest-request/dist/umd/arcgis-rest-request.umd.js"></script>
-<script src="node_modules/@esri/arcgis-rest-feature-service/dist/umd/arcgis-rest-feature-service.umd.js"></script>
+<script src="node_modules/@esri/arcgis-rest-request/dist/umd/request.umd.js"></script>
+<script src="node_modules/@esri/arcgis-rest-feature-service/dist/umd/feature-service.umd.js"></script>
 
 <script>
   // respond when a user fills out the query form and
@@ -114,7 +114,7 @@ <h1>query features!</h1>
     // show/hide additional messages
     var suggestedTermsMessageDisplay = recordCount > 0 ? 'none' : 'block';
     var additionalRowsMessageDisplay = response.exceededTransferLimit ? 'block' : 'none';
-    document.getElementById('suggestedTermsMessage').style.display = suggestedTermsMessageDisplay;      
+    document.getElementById('suggestedTermsMessage').style.display = suggestedTermsMessageDisplay;
     document.getElementById('additionalRowsMessage').style.display = additionalRowsMessageDisplay;
   }
 </script>
diff --git a/demos/geocoder-browser/index.html b/demos/geocoder-browser/index.html
index 59217d4ec8..05c31169b1 100644
--- a/demos/geocoder-browser/index.html
+++ b/demos/geocoder-browser/index.html
@@ -43,9 +43,9 @@ <h1>get to geocodin!</h1>
 </div>
 
 <script src="config.js"></script>
-<script src="node_modules/@esri/arcgis-rest-request/dist/umd/arcgis-rest-request.umd.js"></script>
-<script src="node_modules/@esri/arcgis-rest-auth/dist/umd/arcgis-rest-auth.umd.js"></script>
-<script src="node_modules/@esri/arcgis-rest-geocoder/dist/umd/arcgis-rest-geocoder.umd.js"></script>
+<script src="node_modules/@esri/arcgis-rest-request/dist/umd/request.umd.js"></script>
+<script src="node_modules/@esri/arcgis-rest-auth/dist/umd/auth.umd.js"></script>
+<script src="node_modules/@esri/arcgis-rest-geocoder/dist/umd/geocoder.umd.js"></script>
 
 <script>
 var auth;
diff --git a/demos/jsapi-integration/README.md b/demos/jsapi-integration/README.md
new file mode 100644
index 0000000000..c9ac394f06
--- /dev/null
+++ b/demos/jsapi-integration/README.md
@@ -0,0 +1,8 @@
+# Passing authentication to the JSAPI
+
+This demo shows how to pass an authenticated session from `arcgis-rest-js` to the ArcGIS API for JavaScript.
+
+## Running this demo
+1. Run `npm run bootstrap` in the repository's root directory.
+1. Run `npm start` to spin up the development server.
+1. Visit [http://localhost:8080](http://localhost:8080).
diff --git a/demos/jsapi-integration/index.html b/demos/jsapi-integration/index.html
new file mode 100644
index 0000000000..9dd766a877
--- /dev/null
+++ b/demos/jsapi-integration/index.html
@@ -0,0 +1,82 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no">
+  <title>Share auth between rest-js and the jsapi</title>
+
+  <style>
+    html,
+    body,
+    #viewDiv {
+      padding: 0;
+      margin: 0;
+      height: 100%;
+      width: 100%;
+    }
+  </style>
+
+  <link rel="stylesheet" href="https://js.arcgis.com/4.7/esri/css/main.css">
+
+  <script>
+    dojoConfig = {
+        paths: {
+          "@esri/arcgis-rest-request": "/node_modules/@esri/arcgis-rest-request/dist/umd/request.umd",
+          "@esri/arcgis-rest-auth": "/node_modules/@esri/arcgis-rest-auth/dist/umd/auth.umd",
+          "@esri/arcgis-rest-items": "/node_modules/@esri/arcgis-rest-items/dist/umd/items.umd"
+        }
+    };
+  </script>
+
+  <script src="https://js.arcgis.com/4.7/"></script>
+  <script>
+    require([
+      "@esri/arcgis-rest-request",
+      "@esri/arcgis-rest-auth",
+      "@esri/arcgis-rest-items",
+      "esri/identity/IdentityManager",
+      "esri/views/MapView",
+      "esri/WebMap",
+      "dojo/domReady!"
+    ], function(
+      arcgis, arcgisAuth, arcgisItems, esriId, MapView, WebMap
+    ) {
+
+      // private item
+      // https://geosaurus.maps.arcgis.com/home/item.html?id=728043ac6a574a00b8f1cd5ee0eae8cd
+      const itemId = "728043ac6a574a00b8f1cd5ee0eae8cd";
+
+      // canned username/password from
+      // https://developers.arcgis.com/python/sample-notebooks/chennai-floods-analysis/
+      const session = new arcgisAuth.UserSession({
+        username: "arcgis_python",
+        password: "P@ssword123"
+      });
+
+      // fetch the private item's data, not just the metadata
+      arcgisItems.getItemData(itemId, { authentication: session })
+        .then(response => {
+          // pass the authenticated session over to the JSAPI Identity Manager
+          esriId.registerToken(session.getCredential());
+
+          // dig the webmap id out of the response
+          var webmap = new WebMap({
+            portalItem: {
+              id: response.map.itemId
+            }
+          });
+
+          // and pass it to the map view
+          var view = new MapView({
+            map: webmap,
+            container: "viewDiv"
+          });
+        });
+    });
+  </script>
+</head>
+
+<body>
+  <div id="viewDiv"></div>
+</body>
+</html>
\ No newline at end of file
diff --git a/demos/jsapi-integration/package-lock.json b/demos/jsapi-integration/package-lock.json
new file mode 100644
index 0000000000..a24be9aad0
--- /dev/null
+++ b/demos/jsapi-integration/package-lock.json
@@ -0,0 +1,184 @@
+{
+	"requires": true,
+	"lockfileVersion": 1,
+	"dependencies": {
+		"async": {
+			"version": "1.5.2",
+			"resolved": "https://registry.npmjs.org/async/-/async-1.5.2.tgz",
+			"integrity": "sha1-7GphrlZIDAw8skHJVhjiCJL5Zyo="
+		},
+		"colors": {
+			"version": "1.0.3",
+			"resolved": "https://registry.npmjs.org/colors/-/colors-1.0.3.tgz",
+			"integrity": "sha1-BDP0TYCWgP3rYO0mDxsMJi6CpAs="
+		},
+		"corser": {
+			"version": "2.0.1",
+			"resolved": "https://registry.npmjs.org/corser/-/corser-2.0.1.tgz",
+			"integrity": "sha1-jtolLsqrWEDc2XXOuQ2TcMgZ/4c="
+		},
+		"debug": {
+			"version": "2.6.8",
+			"resolved": "https://registry.npmjs.org/debug/-/debug-2.6.8.tgz",
+			"integrity": "sha1-5zFTHKLt4n0YgiJCfaF4IdaP9Pw=",
+			"requires": {
+				"ms": "2.0.0"
+			}
+		},
+		"eventemitter3": {
+			"version": "3.1.0",
+			"resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-3.1.0.tgz",
+			"integrity": "sha512-ivIvhpq/Y0uSjcHDcOIccjmYjGLcP09MFGE7ysAwkAvkXfpZlC985pH2/ui64DKazbTW/4kN3yqozUxlXzI6cA=="
+		},
+		"follow-redirects": {
+			"version": "1.5.0",
+			"resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.5.0.tgz",
+			"integrity": "sha512-fdrt472/9qQ6Kgjvb935ig6vJCuofpBUD14f9Vb+SLlm7xIe4Qva5gey8EKtv8lp7ahE1wilg3xL1znpVGtZIA==",
+			"requires": {
+				"debug": "^3.1.0"
+			},
+			"dependencies": {
+				"debug": {
+					"version": "3.1.0",
+					"resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz",
+					"integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==",
+					"requires": {
+						"ms": "2.0.0"
+					}
+				}
+			}
+		},
+		"he": {
+			"version": "1.1.1",
+			"resolved": "https://registry.npmjs.org/he/-/he-1.1.1.tgz",
+			"integrity": "sha1-k0EP0hsAlzUVH4howvJx80J+I/0="
+		},
+		"http-proxy": {
+			"version": "1.17.0",
+			"resolved": "https://registry.npmjs.org/http-proxy/-/http-proxy-1.17.0.tgz",
+			"integrity": "sha512-Taqn+3nNvYRfJ3bGvKfBSRwy1v6eePlm3oc/aWVxZp57DQr5Eq3xhKJi7Z4hZpS8PC3H4qI+Yly5EmFacGuA/g==",
+			"requires": {
+				"eventemitter3": "^3.0.0",
+				"follow-redirects": "^1.0.0",
+				"requires-port": "^1.0.0"
+			}
+		},
+		"http-server": {
+			"version": "0.11.1",
+			"resolved": "https://registry.npmjs.org/http-server/-/http-server-0.11.1.tgz",
+			"integrity": "sha512-6JeGDGoujJLmhjiRGlt8yK8Z9Kl0vnl/dQoQZlc4oeqaUoAKQg94NILLfrY3oWzSyFaQCVNTcKE5PZ3cH8VP9w==",
+			"requires": {
+				"colors": "1.0.3",
+				"corser": "~2.0.0",
+				"ecstatic": "^3.0.0",
+				"http-proxy": "^1.8.1",
+				"opener": "~1.4.0",
+				"optimist": "0.6.x",
+				"portfinder": "^1.0.13",
+				"union": "~0.4.3"
+			},
+			"dependencies": {
+				"ecstatic": {
+					"version": "3.2.0",
+					"resolved": "https://registry.npmjs.org/ecstatic/-/ecstatic-3.2.0.tgz",
+					"integrity": "sha512-Goilx/2cfU9vvfQjgtNgc2VmJAD8CasQ6rZDqCd2u4Hsyd/qFET6nBf60jiHodevR3nl3IGzNKtrzPXWP88utQ==",
+					"requires": {
+						"he": "^1.1.1",
+						"mime": "^1.4.1",
+						"minimist": "^1.1.0",
+						"url-join": "^2.0.2"
+					}
+				}
+			}
+		},
+		"mime": {
+			"version": "1.6.0",
+			"resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz",
+			"integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg=="
+		},
+		"minimist": {
+			"version": "1.2.0",
+			"resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.0.tgz",
+			"integrity": "sha1-o1AIsg9BOD7sH7kU9M1d95omQoQ="
+		},
+		"mkdirp": {
+			"version": "0.5.1",
+			"resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.1.tgz",
+			"integrity": "sha1-MAV0OOrGz3+MR2fzhkjWaX11yQM=",
+			"requires": {
+				"minimist": "0.0.8"
+			},
+			"dependencies": {
+				"minimist": {
+					"version": "0.0.8",
+					"resolved": "https://registry.npmjs.org/minimist/-/minimist-0.0.8.tgz",
+					"integrity": "sha1-hX/Kv8M5fSYluCKCYuhqp6ARsF0="
+				}
+			}
+		},
+		"ms": {
+			"version": "2.0.0",
+			"resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
+			"integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g="
+		},
+		"opener": {
+			"version": "1.4.3",
+			"resolved": "https://registry.npmjs.org/opener/-/opener-1.4.3.tgz",
+			"integrity": "sha1-XG2ixdflgx6P+jlklQ+NZnSskLg="
+		},
+		"optimist": {
+			"version": "0.6.1",
+			"resolved": "https://registry.npmjs.org/optimist/-/optimist-0.6.1.tgz",
+			"integrity": "sha1-2j6nRob6IaGaERwybpDrFaAZZoY=",
+			"requires": {
+				"minimist": "~0.0.1",
+				"wordwrap": "~0.0.2"
+			},
+			"dependencies": {
+				"minimist": {
+					"version": "0.0.10",
+					"resolved": "https://registry.npmjs.org/minimist/-/minimist-0.0.10.tgz",
+					"integrity": "sha1-3j+YVD2/lggr5IrRoMfNqDYwHc8="
+				}
+			}
+		},
+		"portfinder": {
+			"version": "1.0.13",
+			"resolved": "https://registry.npmjs.org/portfinder/-/portfinder-1.0.13.tgz",
+			"integrity": "sha1-uzLs2HwnEErm7kS1o8y/Drsa7ek=",
+			"requires": {
+				"async": "^1.5.2",
+				"debug": "^2.2.0",
+				"mkdirp": "0.5.x"
+			}
+		},
+		"qs": {
+			"version": "2.3.3",
+			"resolved": "https://registry.npmjs.org/qs/-/qs-2.3.3.tgz",
+			"integrity": "sha1-6eha2+ddoLvkyOBHaghikPhjtAQ="
+		},
+		"requires-port": {
+			"version": "1.0.0",
+			"resolved": "https://registry.npmjs.org/requires-port/-/requires-port-1.0.0.tgz",
+			"integrity": "sha1-kl0mAdOaxIXgkc8NpcbmlNw9yv8="
+		},
+		"union": {
+			"version": "0.4.6",
+			"resolved": "https://registry.npmjs.org/union/-/union-0.4.6.tgz",
+			"integrity": "sha1-GY+9rrolTniLDvy2MLwR8kopWeA=",
+			"requires": {
+				"qs": "~2.3.3"
+			}
+		},
+		"url-join": {
+			"version": "2.0.5",
+			"resolved": "https://registry.npmjs.org/url-join/-/url-join-2.0.5.tgz",
+			"integrity": "sha1-WvIvGMBSoACkjXuCxenC4v7tpyg="
+		},
+		"wordwrap": {
+			"version": "0.0.3",
+			"resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-0.0.3.tgz",
+			"integrity": "sha1-o9XabNXAvAAI03I0u68b7WMFkQc="
+		}
+	}
+}
diff --git a/demos/jsapi-integration/package.json b/demos/jsapi-integration/package.json
new file mode 100644
index 0000000000..89871229ad
--- /dev/null
+++ b/demos/jsapi-integration/package.json
@@ -0,0 +1,19 @@
+{
+  "name": "@esri/jsapi-integration",
+  "version": "1.4.0",
+  "private": true,
+  "description": "to do",
+  "author": "",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@esri/arcgis-rest-auth": "^1.4.0",
+    "@esri/arcgis-rest-request": "^1.4.0",
+    "@esri/arcgis-rest-items": "^1.4.0"
+  },
+  "devDependencies": {
+    "http-server": "*"
+  },
+  "scripts": {
+    "start": "http-server ."
+  }
+}
diff --git a/docs/acetate.config.js b/docs/acetate.config.js
index 03456acc25..4d4c7fcabc 100644
--- a/docs/acetate.config.js
+++ b/docs/acetate.config.js
@@ -196,10 +196,11 @@ module.exports = function(acetate) {
     return inspect(obj, { depth: 3 });
   });
 
+  // without the '.js' on the end, for the benefit of the AMD sample
   acetate.helper("cdnUrl", function(context, package) {
     return `https://unpkg.com/${
       package.name
-    }@${package.version}/dist/umd/${package.name.replace("@esri/arcgis-rest-", "")}.umd.js`;
+    }@${package.version}/dist/umd/${package.name.replace("@esri/arcgis-rest-", "")}.umd`;
   });
 
   acetate.helper("npmInstallCmd", function(context, package) {
diff --git a/docs/src/guides/amd-requirejs-dojo.md b/docs/src/guides/amd-requirejs-dojo.md
index 109a7a24b8..c050e15b62 100644
--- a/docs/src/guides/amd-requirejs-dojo.md
+++ b/docs/src/guides/amd-requirejs-dojo.md
@@ -7,3 +7,34 @@ group: 1-get-started
 ---
 
 # Get Started with ArcGIS REST JS and AMD
+
+```html
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width">
+  <title>ArcGIS REST JS - AMD</title>
+</head>
+<body>
+  Open your console to see the demo.
+</body>
+  <!-- require polyfills for fetch and Promise from https://polyfill.io -->
+  <script src="https://cdn.polyfill.io/v2/polyfill.js?features=es5,Promise,fetch"></script>
+  <script>
+    dojoConfig = {
+        paths: {
+          "@esri/arcgis-rest-request": "{% cdnUrl data.typedoc | findPackage('@esri/arcgis-rest-request') %}"
+        }
+    };
+  </script>
+  <script src="https:////ajax.googleapis.com/ajax/libs/dojo/1.10.4/dojo/dojo.js"></script>
+  <script>
+    require(["@esri/arcgis-rest-request"], function(arcgis) {
+      arcgis.request("https://www.arcgis.com/sharing/rest/info").then(response => {
+        console.log(response);
+      });
+    });
+  </script>
+</html>
+```
\ No newline at end of file
diff --git a/docs/src/guides/from-a-cdn.md b/docs/src/guides/from-a-cdn.md
index 13dc0158cd..d23ac50c1f 100644
--- a/docs/src/guides/from-a-cdn.md
+++ b/docs/src/guides/from-a-cdn.md
@@ -25,7 +25,7 @@ ArcGIS REST JS is hosted on [unpkg](https://unpkg.com/). You can find URLs for i
   <script src="https://cdn.polyfill.io/v2/polyfill.js?features=es5,Promise,fetch"></script>
 
   <!-- require ArcGIS REST JS libraries from https://unpkg.com -->
-  <script src="{% cdnUrl data.typedoc | findPackage('@esri/arcgis-rest-request') %}"></script>
+  <script src="{% cdnUrl data.typedoc | findPackage('@esri/arcgis-rest-request') %}.js"></script>
 
   <script>
     // when including ArcGIS REST JS all exports are available from an arcgisRest global
diff --git a/packages/arcgis-rest-auth/src/UserSession.ts b/packages/arcgis-rest-auth/src/UserSession.ts
index cf031e1626..de7d5ecdfe 100644
--- a/packages/arcgis-rest-auth/src/UserSession.ts
+++ b/packages/arcgis-rest-auth/src/UserSession.ts
@@ -5,7 +5,6 @@ import * as http from "http";
 import {
   request,
   ArcGISAuthError,
-  ArcGISRequestError,
   IAuthenticationManager
 } from "@esri/arcgis-rest-request";
 import { generateToken } from "./generate-token";
@@ -23,6 +22,17 @@ interface IDeferred<T> {
   reject: (v: any) => void;
 }
 
+/**
+ * Represents a [credential]((https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html)) object used to access a secure ArcGIS resource.
+ */
+export interface ICredential {
+  expires: number;
+  server: string;
+  ssl: boolean;
+  token: string;
+  userId: string;
+}
+
 function defer<T>(): IDeferred<T> {
   const deferred: any = {
     promise: null,
@@ -510,6 +520,17 @@ export class UserSession implements IAuthenticationManager {
     });
   }
 
+  // returns authentication in a format useable in the [ArcGIS API for JavaScript](https://developers.arcgis.com/javascript/)
+  getCredential(): ICredential {
+    return {
+      expires: this.tokenExpires.getTime(),
+      server: this.portal,
+      ssl: true,
+      token: this.token,
+      userId: this.username
+    };
+  }
+
   /**
    * Returns information about the currently logged in [user](https://developers.arcgis.com/rest/users-groups-and-items/user.htm). Subsequent calls will *not* result in additional web traffic.
    *
diff --git a/packages/arcgis-rest-auth/test/UserSession.test.ts b/packages/arcgis-rest-auth/test/UserSession.test.ts
index 7e56914e72..1102aa0c02 100644
--- a/packages/arcgis-rest-auth/test/UserSession.test.ts
+++ b/packages/arcgis-rest-auth/test/UserSession.test.ts
@@ -1,4 +1,5 @@
-import { UserSession, IFetchTokenResponse } from "../src/index";
+import { UserSession } from "../src/index";
+import { ICredential } from "../src/UserSession";
 
 import {
   ArcGISRequestError,
@@ -702,4 +703,31 @@ describe("UserSession", () => {
       });
     });
   });
+
+  describe(".getCredential()", () => {
+    const MOCK_CREDENTIAL: ICredential = {
+      expires: TOMORROW.getTime(),
+      server: "https://www.arcgis.com/sharing/rest",
+      ssl: true,
+      token: "token",
+      userId: "jsmith"
+    };
+
+    it("should cache metadata about the user", () => {
+      const session = new UserSession({
+        clientId: "clientId",
+        redirectUri: "https://example-app.com/redirect-uri",
+        token: "token",
+        tokenExpires: TOMORROW,
+        refreshToken: "refreshToken",
+        refreshTokenExpires: TOMORROW,
+        refreshTokenTTL: 1440,
+        username: "jsmith",
+        password: "123456"
+      });
+
+      const creds = session.getCredential();
+      expect(creds).toEqual(MOCK_CREDENTIAL);
+    });
+  });
 });