BREAKING: remove OAuth2ClientConfig.defaults

README.md

@@ -40,9 +40,7 @@ const oauth2Client = new OAuth2Client({
   authorizationEndpointUri: "https://github.com/login/oauth/authorize",
   tokenUri: "https://github.com/login/oauth/access_token",
   redirectUri: "http://localhost:8000/oauth2/callback",
-  defaults: {
-    scope: "read:user",
-  },
+  scope: "read:user",
 });
 
 type AppState = {

examples/http.ts

@@ -13,9 +13,7 @@ const oauth2Client = new OAuth2Client({
   authorizationEndpointUri: "https://github.com/login/oauth/authorize",
   tokenUri: "https://github.com/login/oauth/access_token",
   redirectUri: "http://localhost:8000/oauth2/callback",
-  defaults: {
-    scope: "read:user",
-  },
+  scope: "read:user",
 });
 
 /** This is where we'll store our state and PKCE codeVerifiers */

examples/oak.ts

@@ -11,9 +11,7 @@ const oauth2Client = new OAuth2Client({
   authorizationEndpointUri: "https://github.com/login/oauth/authorize",
   tokenUri: "https://github.com/login/oauth/access_token",
   redirectUri: "http://localhost:8000/oauth2/callback",
-  defaults: {
-    scope: "read:user",
-  },
+  scope: "read:user",
 });
 
 type AppState = {

src/authorization_code_grant.ts

@@ -102,7 +102,7 @@ export class AuthorizationCodeGrant extends OAuth2GrantBase {
     if (typeof this.client.config.redirectUri === "string") {
       params.set("redirect_uri", this.client.config.redirectUri);
     }
-    const scope = options.scope ?? this.client.config.defaults?.scope;
+    const scope = options.scope ?? this.client.config.scope;
     if (scope) {
       params.set("scope", Array.isArray(scope) ? scope.join(" ") : scope);
     }
@@ -191,7 +191,7 @@ export class AuthorizationCodeGrant extends OAuth2GrantBase {
     const state = params.get("state");
     const stateValidator = options.stateValidator ||
       (options.state && ((s) => s === options.state)) ||
-      this.client.config.defaults?.stateValidator;
+      this.client.config.stateValidator;
 
     if (stateValidator && !await stateValidator(state)) {
       if (state === null) {

src/authorization_code_grant_test.ts

@@ -148,7 +148,7 @@ Deno.test("AuthorizationCodeGrant.getAuthorizationUri works with redirectUri and
 
 Deno.test("AuthorizationCodeGrant.getAuthorizationUri uses default scopes if no scope was specified", async () => {
   const { uri, codeVerifier } = await getOAuth2Client({
-    defaults: { scope: ["default", "scopes"] },
+    scope: ["default", "scopes"],
   }).code.getAuthorizationUri();
 
   const codeChallenge = uri.searchParams.get("code_challenge");
@@ -164,7 +164,7 @@ Deno.test("AuthorizationCodeGrant.getAuthorizationUri uses default scopes if no
 
 Deno.test("AuthorizationCodeGrant.getAuthorizationUri uses specified scopes over default scopes", async () => {
   const { uri, codeVerifier } = await getOAuth2Client({
-    defaults: { scope: ["default", "scopes"] },
+    scope: ["default", "scopes"],
   }).code.getAuthorizationUri({
     scope: "notDefault",
   });
@@ -257,21 +257,19 @@ Deno.test("AuthorizationCodeGrant.getAuthorizationUri works with redirectUri and
 
 Deno.test("AuthorizationCodeGrant.getAuthorizationUri uses default scopes if no scope was specified with PKCE disabled", async () => {
   assertMatchesUrl(
-    (await getOAuth2Client({
-      defaults: { scope: ["default", "scopes"] },
-    }).code.getAuthorizationUri({ disablePkce: true })).uri,
+    (await getOAuth2Client({ scope: ["default", "scopes"] }).code
+      .getAuthorizationUri({ disablePkce: true })).uri,
     "https://auth.server/auth?response_type=code&client_id=clientId&scope=default+scopes",
   );
 });
 
 Deno.test("AuthorizationCodeGrant.getAuthorizationUri uses specified scopes over default scopes with PKCE disabled", async () => {
   assertMatchesUrl(
-    (await getOAuth2Client({
-      defaults: { scope: ["default", "scopes"] },
-    }).code.getAuthorizationUri({
-      scope: "notDefault",
-      disablePkce: true,
-    })).uri,
+    (await getOAuth2Client({ scope: ["default", "scopes"] }).code
+      .getAuthorizationUri({
+        scope: "notDefault",
+        disablePkce: true,
+      })).uri,
     "https://auth.server/auth?response_type=code&client_id=clientId&scope=notDefault",
   );
 });
@@ -756,15 +754,13 @@ Deno.test("AuthorizationCodeGrant.getToken uses the default request options", as
   const { request } = await mockATResponse(
     () =>
       getOAuth2Client({
-        defaults: {
-          requestOptions: {
-            headers: {
-              "User-Agent": "Custom User Agent",
-              "Content-Type": "application/json",
-            },
-            urlParams: { "custom-url-param": "value" },
-            body: { "custom-body-param": "value" },
+        requestOptions: {
+          headers: {
+            "User-Agent": "Custom User Agent",
+            "Content-Type": "application/json",
           },
+          urlParams: { "custom-url-param": "value" },
+          body: { "custom-body-param": "value" },
         },
       }).code.getToken(buildAccessTokenCallback({
         params: { code: "authCode" },
@@ -781,15 +777,13 @@ Deno.test("AuthorizationCodeGrant.getToken uses the passed request options over
   const { request } = await mockATResponse(
     () =>
       getOAuth2Client({
-        defaults: {
-          requestOptions: {
-            headers: {
-              "User-Agent": "Custom User Agent",
-              "Content-Type": "application/json",
-            },
-            urlParams: { "custom-url-param": "value" },
-            body: { "custom-body-param": "value" },
+        requestOptions: {
+          headers: {
+            "User-Agent": "Custom User Agent",
+            "Content-Type": "application/json",
           },
+          urlParams: { "custom-url-param": "value" },
+          body: { "custom-body-param": "value" },
         },
       }).code.getToken(
         buildAccessTokenCallback({
@@ -819,11 +813,11 @@ Deno.test("AuthorizationCodeGrant.getToken uses the default state validator if n
 
   await mockATResponse(
     () =>
-      getOAuth2Client({
-        defaults: { stateValidator: defaultValidator },
-      }).code.getToken(buildAccessTokenCallback({
-        params: { code: "authCode", state: "some_state" },
-      })),
+      getOAuth2Client({ stateValidator: defaultValidator }).code.getToken(
+        buildAccessTokenCallback({
+          params: { code: "authCode", state: "some_state" },
+        }),
+      ),
   );
 
   assertSpyCall(defaultValidator, 0, { args: ["some_state"], returned: true });
@@ -835,11 +829,11 @@ Deno.test("AuthorizationCodeGrant.getToken supports async default state validato
 
   await mockATResponse(
     () =>
-      getOAuth2Client({
-        defaults: { stateValidator: defaultValidator },
-      }).code.getToken(buildAccessTokenCallback({
-        params: { code: "authCode", state: "some_state" },
-      })),
+      getOAuth2Client({ stateValidator: defaultValidator }).code.getToken(
+        buildAccessTokenCallback({
+          params: { code: "authCode", state: "some_state" },
+        }),
+      ),
   );
 
   assertSpyCallAsync(defaultValidator, 0, {
@@ -855,9 +849,7 @@ Deno.test("AuthorizationCodeGrant.getToken uses the passed state validator over
 
   await mockATResponse(
     () =>
-      getOAuth2Client({
-        defaults: { stateValidator: defaultValidator },
-      }).code.getToken(
+      getOAuth2Client({ stateValidator: defaultValidator }).code.getToken(
         buildAccessTokenCallback({
           params: { code: "authCode", state: "some_state" },
         }),
@@ -876,9 +868,7 @@ Deno.test("AuthorizationCodeGrant.getToken uses the passed state validator over
 
   await mockATResponse(
     () =>
-      getOAuth2Client({
-        defaults: { stateValidator: defaultValidator },
-      }).code.getToken(
+      getOAuth2Client({ stateValidator: defaultValidator }).code.getToken(
         buildAccessTokenCallback({
           params: { code: "authCode", state: "some_state" },
         }),

src/client_credentials_grant.ts

@@ -56,7 +56,7 @@ export class ClientCredentialsGrant extends OAuth2GrantBase {
       "Authorization": `Basic ${btoa(`${clientId}:${clientSecret}`)}`,
     };
 
-    const scope = options.scope ?? this.client.config.defaults?.scope;
+    const scope = options.scope ?? this.client.config.scope;
     if (scope) {
       if (Array.isArray(scope)) {
         body.scope = scope.join(" ");

src/client_credentials_grant_test.ts

@@ -294,7 +294,7 @@ Deno.test("ClientCredentialsGrant.getToken includes default scopes in the token
     () =>
       getOAuth2Client({
         clientSecret: "secret",
-        defaults: { scope: ["default", "scopes"] },
+        scope: ["default", "scopes"],
       }).clientCredentials.getToken(),
   );
 
@@ -319,7 +319,7 @@ Deno.test("ClientCredentialsGrant.getToken does not include default scopes in th
     () =>
       getOAuth2Client({
         clientSecret: "secret",
-        defaults: { scope: ["default", "scopes"] },
+        scope: ["default", "scopes"],
       }).clientCredentials.getToken({ scope: "notDefault" }),
   );
 
@@ -344,15 +344,14 @@ Deno.test("ClientCredentialsGrant.getToken uses the default request options", as
     () =>
       getOAuth2Client({
         clientSecret: "secret",
-        defaults: {
-          requestOptions: {
-            headers: {
-              "User-Agent": "Custom User Agent",
-              "Content-Type": "application/json",
-            },
-            urlParams: { "custom-url-param": "value" },
-            body: { "custom-body-param": "value" },
+
+        requestOptions: {
+          headers: {
+            "User-Agent": "Custom User Agent",
+            "Content-Type": "application/json",
           },
+          urlParams: { "custom-url-param": "value" },
+          body: { "custom-body-param": "value" },
         },
       }).clientCredentials.getToken(),
   );
@@ -368,15 +367,13 @@ Deno.test("ClientCredentialsGrant.getToken uses the passed request options over
     () =>
       getOAuth2Client({
         clientSecret: "secret",
-        defaults: {
-          requestOptions: {
-            headers: {
-              "User-Agent": "Custom User Agent",
-              "Content-Type": "application/json",
-            },
-            urlParams: { "custom-url-param": "value" },
-            body: { "custom-body-param": "value" },
+        requestOptions: {
+          headers: {
+            "User-Agent": "Custom User Agent",
+            "Content-Type": "application/json",
           },
+          urlParams: { "custom-url-param": "value" },
+          body: { "custom-body-param": "value" },
         },
       }).clientCredentials.getToken({
         requestOptions: {

src/grant_base.ts

@@ -27,7 +27,7 @@ export abstract class OAuth2GrantBase {
   ): Request {
     const url = this.toUrl(baseUrl);
 
-    const clientDefaults = this.client.config.defaults?.requestOptions;
+    const clientDefaults = this.client.config.requestOptions;
 
     const urlParams: Record<string, string> = {
       ...(clientDefaults?.urlParams),
@@ -61,7 +61,7 @@ export abstract class OAuth2GrantBase {
   }
 
   protected toUrl(url: string | URL): URL {
-    if (typeof (url) === "string") {
+    if (typeof url === "string") {
       return new URL(url, "http://example.com");
     }
     return url;

src/grant_base_test.ts

@@ -39,23 +39,21 @@ Deno.test("OAuth2GrantBase.buildRequest works without optional parameters", asyn
 
 Deno.test("OAuth2GrantBase.buildRequest works with overrideOptions set", async () => {
   const req = getGrantBase({
-    defaults: {
-      requestOptions: {
-        body: {
-          default1: "default",
-          default2: "default",
-          default3: "default",
-        },
-        headers: {
-          "default-header1": "default",
-          "default-header2": "default",
-          "default-header3": "default",
-        },
-        urlParams: {
-          "defaultParam1": "default",
-          "defaultParam2": "default",
-          "defaultParam3": "default",
-        },
+    requestOptions: {
+      body: {
+        default1: "default",
+        default2: "default",
+        default3: "default",
+      },
+      headers: {
+        "default-header1": "default",
+        "default-header2": "default",
+        "default-header3": "default",
+      },
+      urlParams: {
+        "defaultParam1": "default",
+        "defaultParam2": "default",
+        "defaultParam3": "default",
       },
     },
   }).buildRequest("https://auth.server/req", {

src/implicit_grant.ts

@@ -52,7 +52,7 @@ export class ImplicitGrant extends OAuth2GrantBase {
     if (typeof this.client.config.redirectUri === "string") {
       params.set("redirect_uri", this.client.config.redirectUri);
     }
-    const scope = options.scope ?? this.client.config.defaults?.scope;
+    const scope = options.scope ?? this.client.config.scope;
     if (scope) {
       params.set("scope", Array.isArray(scope) ? scope.join(" ") : scope);
     }
@@ -115,7 +115,7 @@ export class ImplicitGrant extends OAuth2GrantBase {
     const state = params.get("state");
     const stateValidator = options.stateValidator ||
       (options.state && ((s) => s === options.state)) ||
-      this.client.config.defaults?.stateValidator;
+      this.client.config.stateValidator;
 
     const tokens: Tokens = {
       accessToken,