API method signature refactor

packages/arcgis-rest-auth/src/ApplicationSession.ts

@@ -2,7 +2,7 @@
  * Apache-2.0 */
 
 import { IAuthenticationManager } from "@esri/arcgis-rest-request";
-import { fetchToken } from "./fetchToken";
+import { fetchToken } from "./fetch-token";
 
 export interface IApplicationSessionOptions {
   /**

packages/arcgis-rest-auth/src/UserSession.ts

@@ -8,8 +8,8 @@ import {
   ArcGISRequestError,
   IAuthenticationManager
 } from "@esri/arcgis-rest-request";
-import { generateToken } from "./generateToken";
-import { fetchToken, IFetchTokenResponse } from "./fetchToken";
+import { generateToken } from "./generate-token";
+import { fetchToken, IFetchTokenResponse } from "./fetch-token";
 
 /**
  * Internal utility for resolving a Promise from outside its constructor.

packages/arcgis-rest-auth/src/authenticated-request-options.ts

@@ -0,0 +1,18 @@
+import { ApplicationSession } from "./ApplicationSession";
+import { UserSession } from "./UserSession";
+
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+
+/**
+ * Used internally by packages for requests that require user authentication.
+ */
+export interface IAuthenticatedRequestOptions extends IRequestOptions {
+  authentication: UserSession | ApplicationSession;
+}
+
+/**
+ * Used internally by packages for requests that require authentication.
+ */
+export interface IUserRequestOptions extends IRequestOptions {
+  authentication: UserSession;
+}

packages/arcgis-rest-auth/src/fetchToken.ts → packages/arcgis-rest-auth/src/fetch-token.ts

@@ -34,9 +34,11 @@ export interface IFetchTokenResponse {
 
 export function fetchToken(
   url: string,
-  params: IFetchTokenParams
+  options: IFetchTokenParams
 ): Promise<IFetchTokenResponse> {
-  return request(url, params).then((response: IFetchTokenRawResponse) => {
+  return request(url, {
+    params: options
+  }).then((response: IFetchTokenRawResponse) => {
     const r: IFetchTokenResponse = {
       token: response.access_token,
       username: response.username,

packages/arcgis-rest-auth/src/generateToken.ts → packages/arcgis-rest-auth/src/generate-token.ts

@@ -32,5 +32,5 @@ export function generateToken(
     params.referer = "@esri.arcgis-rest-auth";
   }
 
-  return request(url, params);
+  return request(url, { params });
 }

packages/arcgis-rest-auth/src/index.ts

@@ -1,4 +1,5 @@
 export * from "./ApplicationSession";
 export * from "./UserSession";
-export * from "./fetchToken";
-export * from "./generateToken";
+export * from "./fetch-token";
+export * from "./generate-token";
+export * from "./authenticated-request-options";

packages/arcgis-rest-auth/test/fetchToken.test.ts

@@ -4,16 +4,6 @@ import { fetchToken } from "../src/index";
 const TOKEN_URL = "https://www.arcgis.com/sharing/rest/oauth2/token";
 
 describe("fetchToken()", () => {
-  let paramsSpy: jasmine.Spy;
-
-  beforeEach(() => {
-    paramsSpy = spyOn(FormData.prototype, "append").and.callThrough();
-  });
-
-  afterAll(() => {
-    paramsSpy.calls.reset();
-  });
-
   afterEach(fetchMock.restore);
 
   it("should request a token with `client_credentials`, `client_id` and `client_secret`", done => {
@@ -28,15 +18,14 @@ describe("fetchToken()", () => {
       grant_type: "client_credentials"
     })
       .then(response => {
-        const [url]: [string, RequestInit] = fetchMock.lastCall(TOKEN_URL);
-        expect(url).toEqual(TOKEN_URL);
-        expect(paramsSpy).toHaveBeenCalledWith("f", "json");
-        expect(paramsSpy).toHaveBeenCalledWith("client_id", "clientId");
-        expect(paramsSpy).toHaveBeenCalledWith("client_secret", "clientSecret");
-        expect(paramsSpy).toHaveBeenCalledWith(
-          "grant_type",
-          "client_credentials"
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall(
+          TOKEN_URL
         );
+        expect(url).toEqual(TOKEN_URL);
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain("client_id=clientId");
+        expect(options.body).toContain("client_secret=clientSecret");
+        expect(options.body).toContain("grant_type=client_credentials");
         expect(response.token).toEqual("token");
         expect(response.expires).toBeGreaterThan(Date.now());
         done();
@@ -61,20 +50,19 @@ describe("fetchToken()", () => {
       grant_type: "authorization_code"
     })
       .then(response => {
-        const [url]: [string, RequestInit] = fetchMock.lastCall(TOKEN_URL);
-        expect(url).toEqual(TOKEN_URL);
-        expect(paramsSpy).toHaveBeenCalledWith("f", "json");
-
-        expect(paramsSpy).toHaveBeenCalledWith("client_id", "clientId");
-        expect(paramsSpy).toHaveBeenCalledWith(
-          "redirect_uri",
-          "https://example-app.com/redirect-uri"
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall(
+          TOKEN_URL
         );
-        expect(paramsSpy).toHaveBeenCalledWith(
-          "grant_type",
-          "authorization_code"
+        expect(url).toEqual(TOKEN_URL);
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain("client_id=clientId");
+        expect(options.body).toContain(
+          `redirect_uri=${encodeURIComponent(
+            "https://example-app.com/redirect-uri"
+          )}`
         );
-        expect(paramsSpy).toHaveBeenCalledWith("code", "authorizationCode");
+        expect(options.body).toContain("grant_type=authorization_code");
+        expect(options.body).toContain("code=authorizationCode");
         expect(response.token).toEqual("token");
         expect(response.refreshToken).toEqual("refreshToken");
         expect(response.username).toEqual("Casey");

packages/arcgis-rest-auth/test/generateToken.test.ts

@@ -5,16 +5,6 @@ import { TOMORROW } from "./utils";
 const TOKEN_URL = "https://www.arcgis.com/sharing/rest/generateToken";
 
 describe("generateToken()", () => {
-  let paramsSpy: jasmine.Spy;
-
-  beforeEach(() => {
-    paramsSpy = spyOn(FormData.prototype, "append").and.callThrough();
-  });
-
-  afterAll(() => {
-    paramsSpy.calls.reset();
-  });
-
   afterEach(fetchMock.restore);
 
   it("should generate a token for a username and password", done => {
@@ -28,11 +18,13 @@ describe("generateToken()", () => {
       password: "Jones"
     })
       .then(response => {
-        const [url]: [string, RequestInit] = fetchMock.lastCall(TOKEN_URL);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall(
+          TOKEN_URL
+        );
         expect(url).toEqual(TOKEN_URL);
-        expect(paramsSpy).toHaveBeenCalledWith("f", "json");
-        expect(paramsSpy).toHaveBeenCalledWith("username", "Casey");
-        expect(paramsSpy).toHaveBeenCalledWith("password", "Jones");
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain("username=Casey");
+        expect(options.body).toContain("password=Jones");
         expect(response.token).toEqual("token");
         expect(response.expires).toEqual(TOMORROW.getTime());
         done();