Merge pull request #227 from Esri/feat/more-cred

feat(auth): toCredential/fromCredential
Esri · Jun 19, 2018 · 1ca31f7 · 1ca31f7
2 parents 106c7b3 + ea64da9
commit 1ca31f7
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 5 deletions.
diff --git a/packages/arcgis-rest-auth/src/UserSession.ts b/packages/arcgis-rest-auth/src/UserSession.ts
@@ -520,8 +520,37 @@ export class UserSession implements IAuthenticationManager {
     });
   }
 
-  // returns authentication in a format useable in the [ArcGIS API for JavaScript](https://developers.arcgis.com/javascript/)
-  getCredential(): ICredential {
+  /**
+   * Translates authentication from the format used in the [ArcGIS API for JavaScript](https://developers.arcgis.com/javascript/).
+   *
+   * ```js
+   * UserSession.fromCredential({
+   *   userId: "jsmith",
+   *   token: "secret"
+   * });
+   * ```
+   *
+   * @returns UserSession
+   */
+  static fromCredential(credential: ICredential) {
+    return new UserSession({
+      portal: credential.server,
+      token: credential.token,
+      username: credential.userId,
+      tokenExpires: new Date(credential.expires)
+    });
+  }
+
+  /**
+   * Returns authentication in a format useable in the [ArcGIS API for JavaScript](https://developers.arcgis.com/javascript/).
+   *
+   * ```js
+   * esriId.registerToken(session.toCredential());
+   * ```
+   *
+   * @returns ICredential
+   */
+  toCredential(): ICredential {
     return {
       expires: this.tokenExpires.getTime(),
       server: this.portal,

diff --git a/packages/arcgis-rest-auth/test/UserSession.test.ts b/packages/arcgis-rest-auth/test/UserSession.test.ts
@@ -704,7 +704,7 @@ describe("UserSession", () => {
     });
   });
 
-  describe(".getCredential()", () => {
+  describe("to/fromCredential()", () => {
     const MOCK_CREDENTIAL: ICredential = {
       expires: TOMORROW.getTime(),
       server: "https://www.arcgis.com/sharing/rest",
@@ -713,7 +713,7 @@ describe("UserSession", () => {
       userId: "jsmith"
     };
 
-    it("should cache metadata about the user", () => {
+    it("should create a credential object from a session", () => {
       const session = new UserSession({
         clientId: "clientId",
         redirectUri: "https://example-app.com/redirect-uri",
@@ -726,8 +726,16 @@ describe("UserSession", () => {
         password: "123456"
       });
 
-      const creds = session.getCredential();
+      const creds = session.toCredential();
       expect(creds).toEqual(MOCK_CREDENTIAL);
     });
+
+    it("should create a UserSession from a credential", () => {
+      const session = UserSession.fromCredential(MOCK_CREDENTIAL);
+      expect(session.username).toEqual("jsmith");
+      expect(session.portal).toEqual("https://www.arcgis.com/sharing/rest");
+      expect(session.token).toEqual("token");
+      expect(session.tokenExpires).toEqual(new Date(TOMORROW));
+    });
   });
 });