Skip to content

Commit

Permalink
chore: update documentation website
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonraimondi authored Apr 8, 2024
1 parent 0b112f7 commit 06478be
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 25 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ Out of the box it supports the following grants:

Adapters are included for the following frameworks:

- [Express](https://jasonraimondi.github.io/ts-oauth2-server/adapters/#express)
- [Fastify](https://jasonraimondi.github.io/ts-oauth2-server/adapters/#fastify)
- [Express](https://tsoauth2server.com/adapters/#express)
- [Fastify](https://tsoauth2server.com/adapters/#fastify)

Example implementations:

Expand All @@ -39,7 +39,7 @@ The included adapters are just helper functions, really any framework should be

## Getting Started

Save some eye strain, **use the [documentation site](https://jasonraimondi.github.io/ts-oauth2-server/)**
Save some eye strain, **use the [documentation site](https://tsoauth2server.com/)**

### Install

Expand Down Expand Up @@ -171,33 +171,33 @@ authorizationServer.enableGrantTypes(

There are a few repositories you are going to need to implement in order to create an `AuthorizationServer`.

[Auth Code Repository](https://jasonraimondi.github.io/ts-oauth2-server/repositories/#auth-code-repository)
[Auth Code Repository](https://tsoauth2server.com/repositories/#auth-code-repository)

[Client Repository](https://jasonraimondi.github.io/ts-oauth2-server/repositories/#client-repository)
[Client Repository](https://tsoauth2server.com/repositories/#client-repository)

[Scope Repository](https://jasonraimondi.github.io/ts-oauth2-server/repositories/#scope-repository)
[Scope Repository](https://tsoauth2server.com/repositories/#scope-repository)

[Token Repository](https://jasonraimondi.github.io/ts-oauth2-server/repositories/#token-repository)
[Token Repository](https://tsoauth2server.com/repositories/#token-repository)

[User Repository](https://jasonraimondi.github.io/ts-oauth2-server/repositories/#user-repository)
[User Repository](https://tsoauth2server.com/repositories/#user-repository)

### Entities

And a few entities.

[Auth Code Entity](https://jasonraimondi.github.io/ts-oauth2-server/entities/#auth-code-entity)
[Auth Code Entity](https://tsoauth2server.com/entities/#auth-code-entity)

[Client Entity](https://jasonraimondi.github.io/ts-oauth2-server/entities/#client-entity)
[Client Entity](https://tsoauth2server.com/entities/#client-entity)

[Scope Entity](https://jasonraimondi.github.io/ts-oauth2-server/entities/#scope-entity)
[Scope Entity](https://tsoauth2server.com/entities/#scope-entity)

[Token Entity](https://jasonraimondi.github.io/ts-oauth2-server/entities/#token-entity)
[Token Entity](https://tsoauth2server.com/entities/#token-entity)

[User Entity](https://jasonraimondi.github.io/ts-oauth2-server/entities/#user-entity)
[User Entity](https://tsoauth2server.com/entities/#user-entity)

## Grants

Grants are different ways a [client](https://jasonraimondi.github.io/ts-oauth2-server/glossary/README.md#client) can obtain an `access_token` that will authorize it to use the [resource server](https://jasonraimondi.github.io/ts-oauth2-server/glossary/README.md#resource-server).
Grants are different ways a [client](https://tsoauth2server.com/glossary/README.md#client) can obtain an `access_token` that will authorize it to use the [resource server](https://tsoauth2server.com/glossary/README.md#resource-server).

### Which Grant?

Expand Down Expand Up @@ -248,7 +248,7 @@ Deciding which grant to use depends on the type of client the end user will be u

### Client Credentials Grant

[Full Docs](https://jasonraimondi.github.io/ts-oauth2-server/grants/client_credentials.html)
[Full Docs](https://tsoauth2server.com/grants/client_credentials.html)

When applications request an access token to access their own resources, not on behalf of a user.

Expand Down Expand Up @@ -425,7 +425,7 @@ app.post("/token/revoke", async (req: Express.Request, res: Express.Response) =>
## Migration Guide

- [v1 to v2](https://github.com/jasonraimondi/ts-oauth2-server/releases/tag/v2.0.0)
- [v2 to v3](https://jasonraimondi.github.io/ts-oauth2-server/migration/v2_to_v3.html)
- [v2 to v3](https://tsoauth2server.com/migration/v2_to_v3.html)

## Thanks

Expand Down
4 changes: 2 additions & 2 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ export default defineConfig({
title: "@jmondi/oauth2-server",
description:
"A standards compliant implementation of an OAuth 2.0 authorization server for Node that utilizes JWT and Proof Key for Code Exchange (PKCE), written in TypeScript. ",
base: "/ts-oauth2-server/",
base: "/",
markdown: {
toc: {
listClass: "table-of-contents",
Expand All @@ -14,7 +14,7 @@ export default defineConfig({
[
"script",
{
"data-domain": "jasonraimondi.github.io/ts-oauth2-server",
"data-domain": "tsoauth2server.com",
src: "https://plausible.io/js/script.js",
defer: "true",
},
Expand Down
2 changes: 1 addition & 1 deletion docs/entities/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ type CodeChallengeMethod = "S256" | "plain";
## Token Entity

The access and refresh token that can be used to authenticate into the resource server.
The `originatingAuthCodeId` will be present only for tokens originating from the authorization code grant; see the `revokeDescendantsOf()` method on the [Token Repository](https://jasonraimondi.github.io/ts-oauth2-server/repositories/#token-repository) for its significance.
The `originatingAuthCodeId` will be present only for tokens originating from the authorization code grant; see the `revokeDescendantsOf()` method on the [Token Repository](https://tsoauth2server.com/repositories/#token-repository) for its significance.

```typescript
interface OAuthToken {
Expand Down
10 changes: 5 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Requires `node >= 16`

Out of the box it supports the following grants:

- [Authorization code grant](https://jasonraimondi.github.io/ts-oauth2-server/grants/authorization_code.html)
- [Client credentials grant](https://jasonraimondi.github.io/ts-oauth2-server/grants/client_credentials.html)
- [Refresh grant](https://jasonraimondi.github.io/ts-oauth2-server/grants/refresh_token.html)
- [Implicit grant](https://jasonraimondi.github.io/ts-oauth2-server/grants/implicit.html) // not recommended
- [Resource owner password credentials grant](https://jasonraimondi.github.io/ts-oauth2-server/grants/password.html) // not recommended
- [Authorization code grant](https://tsoauth2server.com/grants/authorization_code.html)
- [Client credentials grant](https://tsoauth2server.com/grants/client_credentials.html)
- [Refresh grant](https://tsoauth2server.com/grants/refresh_token.html)
- [Implicit grant](https://tsoauth2server.com/grants/implicit.html) // not recommended
- [Resource owner password credentials grant](https://tsoauth2server.com/grants/password.html) // not recommended

The following RFCs are implemented:

Expand Down
2 changes: 1 addition & 1 deletion src/authorization_server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import { DEFAULT_AUTHORIZATION_SERVER_OPTIONS } from "./options.js";
import { ProcessTokenExchangeFn, TokenExchangeGrant } from "./grants/token_exchange.grant.js";

/**
* @see https://jasonraimondi.github.io/ts-oauth2-server/configuration/
* @see https://tsoauth2server.com/configuration/
*/
export interface AuthorizationServerOptions {
// @see https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.5
Expand Down

0 comments on commit 06478be

Please sign in to comment.