Arctic v2

.github/workflows/publish.yaml

@@ -9,6 +9,7 @@ permissions:
 env:
   AURI_GITHUB_TOKEN: ${{secrets.AURI_GITHUB_TOKEN}}
   NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN}}
+  CLOUDFLARE_API_TOKEN: ${{secrets.CLOUDFLARE_API_TOKEN_V2}}
 
 jobs:
   publish-package:
@@ -75,3 +76,29 @@ jobs:
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v1
+
+  publish-v2-docs:
+    name: Publish v2 docs
+    runs-on: ubuntu-latest
+    needs: check-changesets
+    if: needs.check-changesets.check-changesets.outputs.changesets == 0 && github.ref_name == 'v2'
+    steps:
+      - name: setup actions
+        uses: actions/checkout@v3
+      - name: setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.5.1
+          registry-url: https://registry.npmjs.org
+      - name: install malta
+        working-directory: docs
+        run: |
+          curl -o malta.tgz -L https://github.com/pilcrowonpaper/malta/releases/latest/download/linux-amd64.tgz
+          tar -xvzf malta.tgz
+      - name: build
+        working-directory: docs
+        run: ./linux-amd64/malta build
+      - name: install wrangler
+        run: npm i -g wrangler
+      - name: deploy
+        run: wrangler pages deploy docs/dist --project-name arctic-v2 --branch main

CHANGELOG.md

@@ -1,140 +1,57 @@
 # arctic
 
-## 1.9.1
+## 2.0.0-next.6
 
-### Patch changes
+## Major changes
 
-- Fix: Remove new lines when parsing Apple certificate ([#139](https://github.com/pilcrowOnPaper/arctic/pull/139))
+- Remove `OAuth2Tokens.refreshTokenExpiresInSeconds()` and `OAuth2Tokens.refreshTokenExpiresAt()`
 
-## 1.9.0
+## 2.0.0-next.5
 
-### Minor changes
+## Minor changes
 
-- Added Authentik auth provider ([#120](https://github.com/pilcrowOnPaper/arctic/pull/120))
+- Export `decodeIdToken()`
 
-## 1.8.1
+## 2.0.0-next.4
 
-### Patch changes
+## Patch changes
 
-- Fix Slack provider ([#122](https://github.com/pilcrowOnPaper/arctic/pull/122))
-- Fix Okta provider ([#124](https://github.com/pilcrowOnPaper/arctic/pull/124))
+- Fix `createAuthorizationURL()` methods.
 
-## 1.8.0
+## 2.0.0-next.2
 
-### Minor changes
+## Major changes
 
-- Feat: Add `idToken` to the return value of LinkedIn's `validateAuthorizationCode(code: string)` ([#105](https://github.com/pilcrowOnPaper/arctic/pull/105))
-- Feat: Add Tiltify provider. ([#118](https://github.com/pilcrowOnPaper/arctic/pull/118))
+- Update `createAuthorizationURL()` provider methods
+- Remove `SlackApp` and `SlackOpenID`
 
-### Patch changes
+## 2.0.0-next.1
 
-- Fix: Make `refreshToken` optional for the return value of LinkedIn's `validateAuthorizationCode(code: string)` ([#105](https://github.com/pilcrowOnPaper/arctic/pull/105))
+## Minor changes
 
-## 1.7.0
+- Add KeyCloak provider
 
-### Minor changes
+## Patch changes
 
-- Add Shikimori provider. ([#95](https://github.com/pilcrowOnPaper/arctic/pull/95))
-- Feat: add 42 school provider ([#109](https://github.com/pilcrowOnPaper/arctic/pull/109))
+- Fix token endpoint initialization in `Salesforce` provider
 
-## 1.6.2
+## 2.0.0-next.0
 
-### Patch changes
+## Major changes
 
-- Use HTTP basic auth for sending client credentials if supported ([#113](https://github.com/pilcrowOnPaper/arctic/pull/113))
+- `createAuthorizationURL()` no longer returns a `Promise`
+- `validateAuthorizationCode()` and `refreshAccessToken()` returns `OAuth2Tokens`
+- `validateAuthorizationCode()` and `refreshAccessToken()` can throw one of `OAuth2RequestError`, `ArcticFetchError`, or `Error`
+- Scopes are no longer set by default, including `openid` and those required by the provider
+- Updated parameters for `Apple`, `GitHub`, `GitLab`, `MicrosoftEntraId`, `MyAnimeList`, `Okta`, `Osu`, and `Salesforce`
+- Removed `options.scope` parameter from `createAuthorizationURL()`
+- Removed `OAuth2Provider` and `OAuth2ProviderWithPKCE`
+- Replace `Slack` with `SlackApp` and `SlackOpenID`
+- Remove `Keycloak`
 
-## 1.6.1
+## Minor changes
 
-### Patch changes
-
-- Fix Roblox provider and reverted API changes introduced in 1.6.0 ([#111](https://github.com/pilcrowOnPaper/arctic/pull/111))
-
-## 1.6.0
-
-### Minor changes
-
-- Add Intuit provider. ([#97](https://github.com/pilcrowOnPaper/arctic/pull/97))
-
-### Patch changes
-
-- Fix Roblox provider (see docs for API changes) ([#110](https://github.com/pilcrowOnPaper/arctic/pull/110))
-
-## 1.5.0
-
-### Minor changes
-
-- Add AniList provider. ([#92](https://github.com/pilcrowOnPaper/arctic/pull/92))
-
-## 1.4.0
-
-### Minor changes
-
-- Add MyAnimeList provider. ([#89](https://github.com/pilcrowOnPaper/arctic/pull/89))
-- Add Roblox provider. ([#88](https://github.com/pilcrowOnPaper/arctic/pull/88))
-- Add VK provider. ([#88](https://github.com/pilcrowOnPaper/arctic/pull/88))
-
-### Patch changes
-
-- Update dependencies. ([#89](https://github.com/pilcrowOnPaper/arctic/pull/89))
-
-## 1.3.0
-
-### Minor changes
-
-- Add Yandex provider. ([#85](https://github.com/pilcrowOnPaper/arctic/pull/85))
-- Feat: Add support for Github Enterprise Server to `GitHub` Provider ([#77](https://github.com/pilcrowOnPaper/arctic/pull/77))
-
-## 1.2.1
-
-### Patch changes
-
-- Move `auri` to dev dependencies. ([#75](https://github.com/pilcrowOnPaper/arctic/pull/75))
-
-## 1.2.0
-
-### Minor changes
-
-- Add Dribbble provider ([#69](https://github.com/pilcrowOnPaper/arctic/pull/69))
-
-### Patch changes
-
-- Fix: Export GitLab provider ([#73](https://github.com/pilcrowOnPaper/arctic/pull/73))
-
-## 1.1.6
-
-### Patch changes
-
-- Fix Atlassian refresh token method ([#67](https://github.com/pilcrowOnPaper/arctic/pull/67))
-
-## 1.1.5
-
-### Patch changes
-
-- Fix: Fix wrong refresh token expiration date in Keycloak provider ([#65](https://github.com/pilcrowOnPaper/arctic/pull/65))
-
-## 1.1.4
-
-### Patch changes
-
-- Fix: Fix spotify provider refresh token not being passed the credentials ([#60](https://github.com/pilcrowOnPaper/arctic/pull/60))
-
-## 1.1.3
-
-### Patch changes
-
-- Fix: Use request body for sending credentials in Dropbox provider ([#55](https://github.com/pilcrowOnPaper/arctic/pull/55))
-
-## 1.1.0
-
-- Add Patreon provider [#46](https://github.com/pilcrowOnPaper/arctic/pull/46)
-- Add Amazon Cognito provider [#47](https://github.com/pilcrowOnPaper/arctic/pull/47)
-- Add Strava provider [#48](https://github.com/pilcrowOnPaper/arctic/pull/48)
-- Add osu! provider [#49](https://github.com/pilcrowOnPaper/arctic/pull/49)
-- Add Zoom provider [#50](https://github.com/pilcrowOnPaper/arctic/pull/50)
-- Add Linear provider [#51](https://github.com/pilcrowOnPaper/arctic/pull/51)
-- Add Coinbase provider [#52](https://github.com/pilcrowOnPaper/arctic/pull/52)
-- Add WorkOS provider [#53](https://github.com/pilcrowOnPaper/arctic/pull/53)
-
-## 1.0.1
-
-- Fix Atlassian provider
+- Add `refreshAccessToken()` to `GitHub`
+- `createAuthorizationURL()` returns `AuthorizationCodeAuthorizationURL`
+- Add `decodeIdToken()`
+- Add token revocation API

README.md

@@ -1,23 +1,27 @@
 # Arctic
 
-Arctic is an OAuth 2.0 library for JavaScript/TypeScript that supports numerous providers. It's light weight, fully-typed, and runtime-agnostic. [Read the documentation →](https://arctic.js.org)
+Arctic is a collection of OAuth 2.0 clients for popular providers. It only supports the authorization code grant type and intended to be used server-side. Built on top of the Fetch API, it's light weight, fully-typed, and runtime-agnostic.
+
+```
+npm install arctic@next
+```
 
 ```ts
 import { GitHub, generateState } from "arctic";
 
 const github = new GitHub(clientId, clientSecret);
 
 const state = generateState();
-const authorizationURL = await github.createAuthorizationURL(state, {
-	scopes: ["user:email"]
-});
+const scopes = ["user:email"];
+const authorizationURL = github.createAuthorizationURL(state, scopes);
+
+// ...
 
 const tokens = await github.validateAuthorizationCode(code);
+const accessToken = tokens.accessToken();
 ```
 
-For a flexible OAuth 2.0 client, see [`oslo/oauth2`](http://github.com/pilcrowonpaper/oslo).
-
-> Arctic only supports providers that strictly follow the OAuth 2.0 spec (including PKCE).
+> Arctic only supports providers that follow the OAuth 2.0 spec (including PKCE and token revocation).
 
 ## Semver
 
@@ -40,12 +44,11 @@ Arctic does not strictly follow semantic versioning. While we aim to only introd
 - Dropbox
 - Facebook
 - Figma
-- Github
+- GitHub
 - GitLab
 - Google
 - Intuit
 - Kakao
-- Keycloak
 - Lichess
 - Line
 - Linear

docs/malta.config.json

@@ -1,15 +1,16 @@
 {
 	"name": "Arctic",
-	"description": "Arctic is a library that provides OAuth 2.0 clients for major providers.",
+	"description": "Arctic is a collection of OAuth 2.0 clients for popular providers.",
 	"domain": "https://arctic.js.org",
 	"twitter": "@pilcrowonpaper",
+	"asset_hashing": true,
 	"sidebar": [
 		{
 			"title": "Guides",
 			"pages": [
 				["OAuth 2.0", "/guides/oauth2"],
 				["OAuth 2.0 with PKCE", "/guides/oauth2-pkce"],
-				["OpenID Connect", "/guides/oidc"]
+				["Migrate to v2", "/guides/migrate-v2"]
 			]
 		},
 		{
@@ -35,7 +36,7 @@
 				["Google", "/providers/google"],
 				["Intuit", "/providers/intuit"],
 				["Kakao", "/providers/kakao"],
-				["Keycloak", "/providers/keycloak"],
+				["KeyCloak", "/providers/keycloak"],
 				["Lichess", "/providers/lichess"],
 				["Line", "/providers/line"],
 				["Linear", "/providers/linear"],
@@ -50,7 +51,7 @@
 				["Roblox", "/providers/roblox"],
 				["Salesforce", "/providers/salesforce"],
 				["Shikimori", "/providers/shikimori"],
-				["Slack", "/providers/slack"],
+				["Slack", "/providers/slack-openid"],
 				["Spotify", "/providers/spotify"],
 				["Strava", "/providers/strava"],
 				["Tiltify", "/providers/tiltify"],
@@ -64,6 +65,10 @@
 				["Zoom", "/providers/zoom"]
 			]
 		},
+		{
+			"title": "API reference",
+			"pages": [["arctic", "/reference/main"]]
+		},
 		{
 			"title": "Links",
 			"pages": [