tsdoc client

Author: jayair

packages/openauth/src/client.ts

@@ -301,10 +301,21 @@ export interface Client {
    * For SPA sites, the code is passed in through the URL hash.
    * :::
    *
-   * This returns the access and refresh tokens. Or an error if something went wrong.
+   * This returns the access and refresh tokens. Or if it fails it returns an error that you can
+   * handle depending on the error.
    *
    * ```ts
-   * if (exchanged.err) throw new Error(exchanged.err)
+   * import { InvalidAuthorizationCodeError } from "@openauthjs/openauth/error"
+   *
+   * if (exchanged.err) {
+   *   if (exchanged.err instanceof InvalidAuthorizationCodeError) {
+   *     // handle invalid code error
+   *   }
+   *   else {
+   *     // handle other errors
+   *   }
+   * }
+   *
    * const { access, refresh } = exchanged.tokens
    * ```
    *

packages/openauth/src/error.ts

@@ -1,3 +1,6 @@
+/**
+ * The OAuth server returned an error.
+ */
 export class OauthError extends Error {
   constructor(
     public error:
@@ -14,6 +17,9 @@ export class OauthError extends Error {
   }
 }
 
+/**
+ * The `provider` needs to be passed in.
+ */
 export class MissingProviderError extends OauthError {
   constructor() {
     super(
@@ -23,12 +29,18 @@ export class MissingProviderError extends OauthError {
   }
 }
 
+/**
+ * The given parameter is missing.
+ */
 export class MissingParameterError extends OauthError {
   constructor(public parameter: string) {
     super("invalid_request", "Missing parameter: " + parameter)
   }
 }
 
+/**
+ * The given client is not authorized to use the redirect URI that was passed in.
+ */
 export class UnauthorizedClientError extends OauthError {
   constructor(
     public clientID: string,
@@ -41,6 +53,12 @@ export class UnauthorizedClientError extends OauthError {
   }
 }
 
+/**
+ * The browser was in an unknown state.
+ *
+ * This can happen when certain cookies have expired. Or the browser was switched in the middle
+ * of the authentication flow.
+ */
 export class UnknownStateError extends Error {
   constructor() {
     super(
@@ -49,24 +67,36 @@ export class UnknownStateError extends Error {
   }
 }
 
+/**
+ * The given subject is invalid.
+ */
 export class InvalidSubjectError extends Error {
   constructor() {
     super("Invalid subject")
   }
 }
 
+/**
+ * The given refresh token is invalid.
+ */
 export class InvalidRefreshTokenError extends Error {
   constructor() {
     super("Invalid refresh token")
   }
 }
 
+/**
+ * The given access token is invalid.
+ */
 export class InvalidAccessTokenError extends Error {
   constructor() {
     super("Invalid access token")
   }
 }
 
+/**
+ * The given authorization code is invalid.
+ */
 export class InvalidAuthorizationCodeError extends Error {
   constructor() {
     super("Invalid authorization code")

www/src/content/docs/docs/authorizer.mdx

@@ -159,15 +159,19 @@ The interface for the success responder.
 ## Errors
 ### InvalidAccessTokenError
 <Segment>
+The given access token is invalid.
 </Segment>
 ### InvalidAuthorizationCodeError
 <Segment>
+The given authorization code is invalid.
 </Segment>
 ### InvalidRefreshTokenError
 <Segment>
+The given refresh token is invalid.
 </Segment>
 ### InvalidSubjectError
 <Segment>
+The given subject is invalid.
 </Segment>
 ### MissingParameterError
 <Segment>
@@ -183,5 +187,9 @@ The interface for the success responder.
 </Segment>
 ### UnknownStateError
 <Segment>
+The browser was in an unknown state.
+
+This can happen when certain cookies have expired. Or the browser was switched in the middle
+of the authentication flow.
 </Segment>
 </div>

www/src/content/docs/docs/storage/cloudflare.mdx

@@ -40,12 +40,27 @@ CloudflareStorage(options)
 </Section>
 <Section type="parameters">
 #### Parameters
-- <p><code class="key">options</code> <code class="type">CloudflareStorageOptions</code></p>
+- <p><code class="key">options</code> [<code class="type">CloudflareStorageOptions</code>](#cloudflarestorageoptions)</p>
 The config for the adapter.
 </Section>
 <InlineSection>
 **Returns** <code class="type">StorageAdapter</code>
 </InlineSection>
 Creates a Cloudflare KV store.
 </Segment>
+## CloudflareStorageOptions
+<Segment>
+<Section type="parameters">
+- <p>[<code class="key">namespace</code>](#cloudflarestorageoptions.namespace) <code class="type">KVNamespace</code></p>
+</Section>
+Configure the DynamoDB table that's created.
+</Segment>
+<NestedTitle id="cloudflarestorageoptions.namespace" Tag="h4" parent="CloudflareStorageOptions.">namespace</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="type">KVNamespace</code>
+</InlineSection>
+</Section>
+</Segment>
 </div>