fix: add token property to IAuthenticationManager

packages/arcgis-rest-demographics/test/getGeography.test.ts

@@ -5,6 +5,7 @@ import fetchMock from "fetch-mock";
 import { getGeography } from "../src/getGeography.js";
 
 const MOCK_AUTH = {
+  token: "token",
   getToken() {
     return Promise.resolve("token");
   },

packages/arcgis-rest-demographics/test/queryDemographicData.test.ts

@@ -5,6 +5,7 @@ import fetchMock from "fetch-mock";
 import { queryDemographicData } from "../src/queryDemographicData.js";
 
 const MOCK_AUTH = {
+  token: "token",
   getToken() {
     return Promise.resolve("token");
   },

packages/arcgis-rest-geocoding/test/bulk.test.ts

@@ -20,20 +20,22 @@ const addresses = [
   }
 ];
 
+const MOCK_AUTH = {
+  token: "token",
+  getToken() {
+    return Promise.resolve("token");
+  },
+  portal: "https://mapsdev.arcgis.com"
+};
+
 describe("geocode", () => {
   afterEach(() => {
     fetchMock.restore();
   });
+
   it("should make a bulk geocoding request, even with an unmatchable record", (done) => {
     fetchMock.once("*", GeocodeAddresses);
 
-    const MOCK_AUTH = {
-      getToken() {
-        return Promise.resolve("token");
-      },
-      portal: "https://mapsdev.arcgis.com"
-    };
-
     bulkGeocode({ addresses, authentication: MOCK_AUTH })
       .then((response) => {
         expect(fetchMock.called()).toEqual(true);
@@ -207,13 +209,6 @@ describe("geocode", () => {
   it("should support rawResponse", (done) => {
     fetchMock.once("*", GeocodeAddresses);
 
-    const MOCK_AUTH = {
-      getToken() {
-        return Promise.resolve("token");
-      },
-      portal: "https://mapsdev.arcgis.com"
-    };
-
     bulkGeocode({ addresses, authentication: MOCK_AUTH, rawResponse: true })
       .then((response: any) => {
         expect(fetchMock.called()).toEqual(true);

packages/arcgis-rest-portal/test/groups/get.test.ts

@@ -99,6 +99,7 @@ describe("groups", () => {
 
   describe("authenticted methods", () => {
     const MOCK_AUTH = {
+      token: "token",
       getToken() {
         return Promise.resolve("fake-token");
       },

packages/arcgis-rest-portal/test/groups/search.test.ts

@@ -122,6 +122,7 @@ describe("groups", () => {
 
   describe("authenticted methods", () => {
     const MOCK_AUTH = {
+      token: "token",
       getToken() {
         return Promise.resolve("fake-token");
       },

packages/arcgis-rest-portal/test/users/search.test.ts

@@ -10,6 +10,7 @@ import { UserSearchResponse } from "../mocks/users/user-search.js";
 
 describe("users", () => {
   const MOCK_AUTH = {
+    token: "token",
     getToken() {
       return Promise.resolve("fake-token");
     },

packages/arcgis-rest-portal/test/util/determine-username.test.ts

@@ -16,6 +16,7 @@ describe("determineUsername", () => {
     const requestOptions = {
       username: "c@sey",
       authentication: {
+        token: "fake",
         portal: "https://bar.com/arcgis/sharing/rest",
         username: "bob",
         getUsername: function () {
@@ -34,6 +35,7 @@ describe("determineUsername", () => {
   it("should fallback to the username in the requestOptions authentication", () => {
     const requestOptions = {
       authentication: {
+        token: "fake",
         portal: "https://bar.com/arcgis/sharing/rest",
         username: "bob",
         getUsername: function () {
@@ -52,6 +54,7 @@ describe("determineUsername", () => {
   it("should fallback to getUsername() in the requestOptions authentication", () => {
     const requestOptions = {
       authentication: {
+        token: "fake",
         portal: "https://bar.com/arcgis/sharing/rest",
         getUsername: function () {
           return Promise.resolve("jsmith");

packages/arcgis-rest-portal/test/util/get-portal-settings.test.ts

@@ -13,6 +13,7 @@ describe("portal", () => {
   describe("getPortalSettings", () => {
     // setup an authmgr to use in all these tests
     const MOCK_AUTH = {
+      token: "fake-token",
       getToken() {
         return Promise.resolve("fake-token");
       },

packages/arcgis-rest-portal/test/util/get-portal-url.test.ts

@@ -11,6 +11,7 @@ describe("getPortalUrl", () => {
   it("should use the portal from authorization if passed", () => {
     const requestOptions = {
       authentication: {
+        token: "token",
         portal: "https://foo.com/arcgis/sharing/rest",
         getToken() {
           return Promise.resolve("fake");
@@ -24,6 +25,7 @@ describe("getPortalUrl", () => {
   it("should use the portal in the requestOptions if passed", () => {
     const requestOptions = {
       authentication: {
+        token: "token",
         portal: "https://foo.com/arcgis/sharing/rest",
         getToken() {
           return Promise.resolve("fake");

packages/arcgis-rest-portal/test/util/portal.test.ts

@@ -10,18 +10,20 @@ import {
   SubscriptionInfoResponse
 } from "./../mocks/portal/response.js";
 
+// setup an authmgr to use in all these tests
+const MOCK_AUTH = {
+  token: "fake-token",
+  getToken() {
+    return Promise.resolve("fake-token");
+  },
+  portal: "https://myorg.maps.arcgis.com/sharing/rest"
+};
+
 describe("portal", () => {
   afterEach(() => {
     fetchMock.restore();
   });
   describe("getPortal", () => {
-    // setup an authmgr to use in all these tests
-    const MOCK_AUTH = {
-      getToken() {
-        return Promise.resolve("fake-token");
-      },
-      portal: "https://myorg.maps.arcgis.com/sharing/rest"
-    };
     const MOCK_REQOPTS = {
       authentication: MOCK_AUTH
     };
@@ -60,13 +62,6 @@ describe("portal", () => {
     });
   });
   describe("getSelf", () => {
-    // setup an authmgr to use in all these tests
-    const MOCK_AUTH = {
-      getToken() {
-        return Promise.resolve("fake-token");
-      },
-      portal: "https://myorg.maps.arcgis.com/sharing/rest"
-    };
     const MOCK_REQOPTS = {
       authentication: MOCK_AUTH
     };
@@ -90,13 +85,6 @@ describe("portal", () => {
   });
 
   describe("getSubscriptionInfo", () => {
-    // setup an authmgr to use in all these tests
-    const MOCK_AUTH = {
-      getToken() {
-        return Promise.resolve("fake-token");
-      },
-      portal: "https://myorg.maps.arcgis.com/sharing/rest"
-    };
     const MOCK_REQOPTS = {
       authentication: MOCK_AUTH
     };

packages/arcgis-rest-request/src/ApiKeyManager.ts

@@ -35,6 +35,13 @@ export class ApiKeyManager
 
   private key: string;
 
+  /**
+   * The current API key as a string.
+   */
+  get token() {
+    return this.key;
+  }
+
   /**
    * The preferred method for creating an instance of `ApiKeyManager`.
    */

packages/arcgis-rest-request/src/ApplicationCredentialsManager.ts

@@ -66,10 +66,17 @@ export class ApplicationCredentialsManager
   public portal: string;
   private clientId: string;
   private clientSecret: string;
-  private token: string;
+  private _token: string;
   private expires: Date;
   private duration: number;
 
+  /**
+   * The current token. This may be invalid, expired or `undefined`. To guarantee a valid token, use the {@linkcode ApplicationCredentialsManager.getToken} method instead.
+   */
+  public get token() {
+    return this._token;
+  }
+
   /**
    * Preferred method for creating an `ApplicationCredentialsManager`
    */
@@ -89,7 +96,7 @@ export class ApplicationCredentialsManager
     super(options);
     this.clientId = options.clientId;
     this.clientSecret = options.clientSecret;
-    this.token = options.token;
+    this._token = options.token;
     this.expires = options.expires;
     this.portal = options.portal || "https://www.arcgis.com/sharing/rest";
     this.duration = options.duration || 7200;
@@ -127,7 +134,7 @@ export class ApplicationCredentialsManager
     return fetchToken(`${this.portal}/oauth2/token/`, options)
       .then((response) => {
         this._pendingTokenRequest = null;
-        this.token = response.token;
+        this._token = response.token;
         this.expires = response.expires;
         return response.token;
       })

packages/arcgis-rest-request/src/request.ts

@@ -267,6 +267,7 @@ export function internalRequest(
 
     authentication = {
       portal: "https://www.arcgis.com/sharing/rest",
+      token: rawToken,
       getToken: () => {
         return Promise.resolve(rawToken);
       }

packages/arcgis-rest-request/src/utils/IAuthenticationManager.ts

@@ -20,6 +20,11 @@ export interface IAuthenticationManager {
    */
   portal: string;
 
+  /**
+   * Getter for consistency between ArcGISIdentityManager and older ArcGIS REST JS verisons. This token may be invalid, expired or `undefined`. To guarentee a valid token, use the {@linkcode IAuthenticationManager.getToken} method instead.
+   */
+  get token(): string;
+
   /**
    * Returns the proper token for a given URL and request options.
    * @param url The requested URL.

packages/arcgis-rest-request/test/ApiKey.test.ts

@@ -132,5 +132,15 @@ describe("ApiKeyManager", () => {
           fail(e);
         });
     });
+
+    describe(".token", () => {
+      it("should return the token", () => {
+        const session = ApiKeyManager.fromKey({
+          key: "token"
+        });
+
+        expect(session.token).toEqual("token");
+      });
+    });
   });
 });

packages/arcgis-rest-request/test/request.test.ts

@@ -25,6 +25,14 @@ import {
   isNode
 } from "../../../scripts/test-helpers.js";
 
+const MOCK_AUTH = {
+  token: "token",
+  portal: "https://www.arcgis.com/sharing/rest",
+  getToken() {
+    return Promise.resolve("token");
+  }
+};
+
 describe("request()", () => {
   afterEach(() => {
     fetchMock.restore();
@@ -159,13 +167,6 @@ describe("request()", () => {
   it("should use the `authentication` option to authenticate a request", (done) => {
     fetchMock.once("*", WebMapAsText);
 
-    const MOCK_AUTH = {
-      portal: "https://www.arcgis.com/sharing/rest",
-      getToken() {
-        return Promise.resolve("token");
-      }
-    };
-
     request(
       "https://www.arcgis.com/sharing/rest/content/items/43a8e51789044d9480a20089a84129ad/data",
       {
@@ -189,13 +190,6 @@ describe("request()", () => {
   it("should hide token in POST body in browser environments otherwise it should hide token in `X-ESRI_AUTHORIZATION` header in Node", (done) => {
     fetchMock.once("*", SharingRestInfo);
 
-    const MOCK_AUTH = {
-      portal: "https://www.arcgis.com/sharing/rest",
-      getToken() {
-        return Promise.resolve("token");
-      }
-    };
-
     request("https://www.arcgis.com/sharing/rest/info", {
       authentication: MOCK_AUTH,
       httpMethod: "GET",
@@ -271,13 +265,6 @@ describe("request()", () => {
     fetchMock.once("*", SharingRestInfo);
     const restInfoUrl = "https://www.arcgis.com/sharing/rest/info";
 
-    const MOCK_AUTH = {
-      portal: "https://www.arcgis.com/sharing/rest",
-      getToken() {
-        return Promise.resolve("token");
-      }
-    };
-
     request(restInfoUrl, {
       authentication: MOCK_AUTH,
       httpMethod: "GET",
@@ -459,13 +446,6 @@ describe("request()", () => {
       return;
     });
 
-    const MOCK_AUTH = {
-      portal: "https://www.arcgis.com/sharing/rest",
-      getToken() {
-        return Promise.resolve("token");
-      }
-    };
-
     setDefaultRequestOptions({
       authentication: MOCK_AUTH
     });

packages/arcgis-rest-request/test/utils/ArcGISAuthError.test.ts

@@ -46,10 +46,12 @@ describe("ArcGISRequestError", () => {
 
   describe("retry", () => {
     const MockAuth: {
+      token: string;
       portal: string;
       getToken: any;
       retryHandler: IRetryAuthError;
     } = {
+      token: "token",
       portal: "https://www.arcgis.com/sharing/rest",
       getToken() {
         return Promise.resolve("token");