add addScopes

CHANGELOG.md

@@ -1,5 +1,9 @@
 # @oslojs/oauth2
 
+## 0.3.0
+
+- [Breaking] Remove `setScopes()` and rename `appendScopes()` to `addScopes()`
+
 ## 0.2.0
 
 - [Breaking] Remove APIs for sending requests

docs/pages/examples/authorization-code.md

@@ -20,20 +20,13 @@ const state = generateState();
 const url = new AuthorizationCodeAuthorizationURL(authorizationEndpoint, clientId);
 url.setRedirectURI("https://my-app.com/login/callback");
 url.setState(state);
-url.setScopes("user", "profile");
+url.addScopes("user", "profile");
 
 const redirectLocation = url.toString();
 
 // Store state as cookie or in session.
 ```
 
-Use `appendScopes()` to append new scopes to existing ones.
-
-```ts
-url.appendScopes("user");
-url.appendScopes("profile");
-```
-
 ## Validation authorization code
 
 Create a new [`AuthorizationCodeTokenRequestContext`](/reference/main/AuthorizationCodeTokenRequestContext) and send a request to the token endpoint using the context's method, body (`application/x-www-form-urlencoded`), and headers.

docs/pages/examples/device-authorization.md

@@ -20,7 +20,7 @@ import {
 
 const context = new DeviceAuthorizationRequestContext();
 context.authenticateWithHTTPBasicAuth(clientId, clientPassword);
-context.setScopes("profile", "email");
+context.addScopes("profile", "email");
 
 const body = new URLSearchParams();
 for (const [key, value] of context.body.entries()) {
@@ -54,13 +54,6 @@ context.authenticateWithRequestBody(clientId, clientSecret);
 context.setClientId(clientId);
 ```
 
-Use `appendScopes()` instead of `setScopes()` to append new scopes to existing ones.
-
-```ts
-url.appendScopes("user");
-url.appendScopes("profile");
-```
-
 ## Validate device code
 
 Create a new [`DeviceAuthorizationTokenRequestContext`](/reference/main/DeviceAuthorizationTokenRequestContext) and send a request to the token endpoint using the context's method, body (`application/x-www-form-urlencoded`), and headers.

docs/pages/reference/main/AuthorizationCodeAuthorizationURL/addScopes.md

@@ -0,0 +1,24 @@
+---
+title: "AuthorizationCodeAuthorizationURL.addScopes()"
+---
+
+# AuthorizationCodeAuthorizationURL.addScopes()
+
+Appends scopes to the `scope` parameter.
+
+## Definition
+
+```ts
+function addScopes(...scopes: string[]): void;
+```
+
+### Parameters
+
+- `scopes`
+
+## Example
+
+```ts
+url.addScopes("profile", "email");
+url.addScopes("openid");
+```

docs/pages/reference/main/AuthorizationCodeAuthorizationURL/index.md

@@ -23,11 +23,10 @@ function constructor(authorizationEndpoint: string, clientId: string): this;
 
 See also [`URL` methods](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams#instance_methods).
 
-- [`appendScopes()`](/reference/main/AuthorizationCodeAuthorizationURL/appendScopes)
+- [`addScopes()`](/reference/main/AuthorizationCodeAuthorizationURL/addScopes)
 - [`setPlainCodeChallenge()`](/reference/main/AuthorizationCodeAuthorizationURL/setPlainCodeChallenge)
 - [`setRedirectURI()`](/reference/main/AuthorizationCodeAuthorizationURL/setRedirectURI)
 - [`setS256CodeChallenge()`](/reference/main/AuthorizationCodeAuthorizationURL/setS256CodeChallenge)
-- [`setScopes()`](/reference/main/AuthorizationCodeAuthorizationURL/setScopes)
 - [`setState()`](/reference/main/AuthorizationCodeAuthorizationURL/setState)
 
 ## Properties

docs/pages/reference/main/DeviceAuthorizationRequestContext/addScopes.md

@@ -0,0 +1,24 @@
+---
+title: "DeviceAuthorizationRequestContext.addScopes()"
+---
+
+# DeviceAuthorizationRequestContext.addScopes()
+
+Appends scopes to the `scope` parameter.
+
+## Definition
+
+```ts
+function addScopes(...scopes: string[]): void;
+```
+
+### Parameters
+
+- `scopes`
+
+## Example
+
+```ts
+context.addScopes("profile", "email");
+context.addScopes("admin");
+```

docs/pages/reference/main/DeviceAuthorizationRequestContext/index.md

@@ -26,8 +26,7 @@ function constructor(): this;
 - [`OAuth2RequestContext.authenticateWithRequestBody()`](/reference/main/OAuth2RequestContext/authenticateWithRequestBody)
 - [`OAuth2RequestContext.setClientId()`](/reference/main/OAuth2RequestContext/setClientId)
 
-- [`appendScopes()`](/reference/main/DeviceAuthorizationRequestContext/appendScopes)
-- [`setScopes()`](/reference/main/DeviceAuthorizationRequestContext/setScopes)
+- [`addScopes()`](/reference/main/DeviceAuthorizationRequestContext/addScopes)
 
 ## Properties
 

docs/pages/reference/main/RefreshRequestContext/addScopes.md

@@ -0,0 +1,24 @@
+---
+title: "RefreshRequestContext.addScopes()"
+---
+
+# RefreshRequestContext.addScopes()
+
+Appends scopes to the `scope` parameter.
+
+## Definition
+
+```ts
+function addScopes(...scopes: string[]): void;
+```
+
+### Parameters
+
+- `scopes`
+
+## Example
+
+```ts
+context.addScopes("profile", "email");
+context.addScopes("admin");
+```

docs/pages/reference/main/RefreshRequestContext/index.md

@@ -32,8 +32,7 @@ function constructor(refreshToken: string): this;
 - [`OAuth2RequestContext.authenticateWithRequestBody()`](/reference/main/OAuth2RequestContext/authenticateWithRequestBody)
 - [`OAuth2RequestContext.setClientId()`](/reference/main/OAuth2RequestContext/setClientId)
 
-- [`appendScopes()`](/reference/main/RefreshRequestContext/appendScopes)
-- [`setScopes()`](/reference/main/RefreshRequestContext/setScopes)
+- [`addScopes()`](/reference/main/RefreshRequestContext/addScopes)
 
 ## Properties
 

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@oslojs/oauth2",
 	"type": "module",
-	"version": "0.2.0",
+	"version": "0.3.0",
 	"description": "A runtime-agnostic OAuth 2.0 library",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

src/authorization-code.ts

@@ -13,11 +13,7 @@ export class AuthorizationCodeAuthorizationURL extends URL {
 		this.searchParams.set("redirect_uri", redirectURI);
 	}
 
-	public setScopes(...scopes: string[]): void {
-		this.searchParams.set("scope", scopes.join(" "));
-	}
-
-	public appendScopes(...scopes: string[]): void {
+	public addScopes(...scopes: string[]): void {
 		if (scopes.length < 1) {
 			return;
 		}

src/device-authorization.ts

@@ -5,11 +5,7 @@ export class DeviceAuthorizationRequestContext extends OAuth2RequestContext {
 		super("POST");
 	}
 
-	public setScopes(...scopes: string[]): void {
-		this.body.set("scope", scopes.join(" "));
-	}
-
-	public appendScopes(...scopes: string[]): void {
+	public addScopes(...scopes: string[]): void {
 		if (scopes.length < 1) {
 			return;
 		}

src/refresh-token.ts

@@ -7,11 +7,7 @@ export class RefreshRequestContext extends OAuth2RequestContext {
 		this.body.set("refresh_token", refreshToken);
 	}
 
-	public setScopes(...scopes: string[]): void {
-		this.body.set("scope", scopes.join(" "));
-	}
-
-	public appendScopes(...scopes: string[]): void {
+	public addScopes(...scopes: string[]): void {
 		if (scopes.length < 1) {
 			return;
 		}