Merge pull request #487 from nhost/changeset-release/main

chore: update versions

.config/prettier.config.js

@@ -18,5 +18,7 @@ module.exports = {
         useTabs: false
       }
     }
-  ]
+  ],
+  importOrderSeparation: true,
+  importOrderSortSpecifiers: true
 }

.github/CODEOWNERS

@@ -2,6 +2,7 @@
 # https://help.github.com/en/articles/about-code-owners
 
 /packages                                @plmercereau
+/packages/docgen                         @szilarddoro
 /.github/workflows                       @plmercereau
 /docs/                                   @guicurcio
 /examples/                               @plmercereau @guicurcio @FuzzyReason

.gitignore

@@ -15,7 +15,6 @@ logs/
 /.vscode/
 .eslintcache
 .yarnclean
-.husky
 
 # Directories
 coverage/
@@ -50,4 +49,8 @@ todo.md
 .netlify
 .monorepo-example
 
-.next
+.next
+
+# TypeDoc output
+
+.docgen

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

.lintstagedrc.json

@@ -0,0 +1,6 @@
+{
+  "packages/(docgen|hasura-auth-js|hasura-storage-js|nextjs|nhost-js|react|core)/src/**/*.{js,ts,jsx,tsx}": [
+    "pnpm docgen",
+    "git add docs"
+  ]
+}

README.md

@@ -20,7 +20,7 @@
   <hr />
 </div>
 
-**Nhost is a open-source GraphQL backend,** built with the following things in mind:
+**Nhost is an open-source GraphQL backend,** built with the following things in mind:
 
 - Open-Source
 - Developer Productivity
@@ -98,7 +98,7 @@ Nhost is frontend agnostic, which means Nhost works with all frontend frameworks
 
 Nhost libraries and tools
 
-- [JavaScript/TypeScript SDK](https://docs.nhost.io/reference/sdk)
+- [JavaScript/TypeScript SDK](https://docs.nhost.io/reference/javascript)
 - [Dart and Flutter SDK](https://github.com/nhost/nhost-dart)
 - [Nhost CLI](https://docs.nhost.io/reference/cli)
 - [Nhost React](https://docs.nhost.io/reference/react)
@@ -213,6 +213,13 @@ Here are some ways of contributing to making Nhost better:
         </a>
     </td></tr>
 <tr>
+    <td align="center">
+        <a href="https://github.com/dbarrosop">
+            <img src="https://avatars.githubusercontent.com/u/6246622?v=4" width="100;" alt="dbarrosop"/>
+            <br />
+            <sub><b>David Barroso</b></sub>
+        </a>
+    </td>
     <td align="center">
         <a href="https://github.com/hajek-raven">
             <img src="https://avatars.githubusercontent.com/u/7288737?v=4" width="100;" alt="hajek-raven"/>
@@ -234,13 +241,21 @@ Here are some ways of contributing to making Nhost better:
             <sub><b>Mustafa Hanif</b></sub>
         </a>
     </td>
+    <td align="center">
+        <a href="https://github.com/timpratim">
+            <img src="https://avatars.githubusercontent.com/u/32492961?v=4" width="100;" alt="timpratim"/>
+            <br />
+            <sub><b>Pratim</b></sub>
+        </a>
+    </td>
     <td align="center">
         <a href="https://github.com/Savinvadim1312">
             <img src="https://avatars.githubusercontent.com/u/16936043?v=4" width="100;" alt="Savinvadim1312"/>
             <br />
             <sub><b>Savin Vadim</b></sub>
         </a>
-    </td>
+    </td></tr>
+<tr>
     <td align="center">
         <a href="https://github.com/ahmic">
             <img src="https://avatars.githubusercontent.com/u/13452362?v=4" width="100;" alt="ahmic"/>
@@ -254,8 +269,7 @@ Here are some ways of contributing to making Nhost better:
             <br />
             <sub><b>Anders Kjær Damgaard</b></sub>
         </a>
-    </td></tr>
-<tr>
+    </td>
     <td align="center">
         <a href="https://github.com/rustyb">
             <img src="https://avatars.githubusercontent.com/u/53086?v=4" width="100;" alt="rustyb"/>
@@ -283,7 +297,8 @@ Here are some ways of contributing to making Nhost better:
             <br />
             <sub><b>Helio Alves</b></sub>
         </a>
-    </td>
+    </td></tr>
+<tr>
     <td align="center">
         <a href="https://github.com/nkhdo">
             <img src="https://avatars.githubusercontent.com/u/26102306?v=4" width="100;" alt="nkhdo"/>
@@ -291,20 +306,19 @@ Here are some ways of contributing to making Nhost better:
             <sub><b>Hoang Do</b></sub>
         </a>
     </td>
+    <td align="center">
+        <a href="https://github.com/jladuval">
+            <img src="https://avatars.githubusercontent.com/u/1935359?v=4" width="100;" alt="jladuval"/>
+            <br />
+            <sub><b>Jacob Duval</b></sub>
+        </a>
+    </td>
     <td align="center">
         <a href="https://github.com/ghoshnirmalya">
             <img src="https://avatars.githubusercontent.com/u/6391763?v=4" width="100;" alt="ghoshnirmalya"/>
             <br />
             <sub><b>Nirmalya Ghosh</b></sub>
         </a>
-    </td></tr>
-<tr>
-    <td align="center">
-        <a href="https://github.com/timpratim">
-            <img src="https://avatars.githubusercontent.com/u/32492961?v=4" width="100;" alt="timpratim"/>
-            <br />
-            <sub><b>Pratim</b></sub>
-        </a>
     </td>
     <td align="center">
         <a href="https://github.com/quentin-decre">

docs/docs/get-started/cli-workflow/metadata-and-serverless-functions.mdx

@@ -2,6 +2,9 @@
 title: 'Metadata and Serverless Functions'
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 In the previous section, we only created a new table; `customers`. Using the CLI you can also do changes to other parts of your backend.
 
 There are three things the CLI and the GitHub integration track and applies to production:
@@ -73,20 +76,25 @@ Serverless functions are placed in the `functions/` folder of your repository. E
 
 Before we create our serverless function we'll install `express`, which is a requirement for serverless functions to work.
 
+<Tabs>
+  <TabItem value="npm" label="npm" default>
+
 ```bash
 npm install express
-# or with yarn
-yarn add express
+npm install -d @types/node @types/express
 ```
 
-We'll use TypeScript so we'll install two type definitions too:
+  </TabItem>
+  <TabItem value="yarn" label="Yarn">
 
 ```bash
-npm install -d @types/node @types/express
-# or with yarn
+yarn add express
 yarn add -D @types/node @types/express
 ```
 
+  </TabItem>
+</Tabs>
+
 Then we'll create a file `functions/time.ts`
 
 In the file `time.ts` we'll add the following code to create our serverless function:

docs/docs/get-started/quick-start/javascript-client.md

@@ -2,6 +2,9 @@
 title: 'JavaScript client'
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 In the previous section, you used the Hasura Console to fetch a list of todos. Now, you will write a small JavaScript client to interact and retrieve todos from your Nhost app.
 
 ### Frontend frameworks
@@ -14,40 +17,36 @@ In this guide, we'll keep the example simple. We're not using a frontend framewo
 
 ## Setup
 
-> Make sure you have [Node.js](https://nodejs.org) and [npm](https://docs.npmjs.com/getting-started) installed.
+:::info
 
-Create a new folder called `nhost-todos`, and initialize a new JavaScript app there:
+Make sure you have [Node.js](https://nodejs.org) and [npm](https://docs.npmjs.com/getting-started) or [Yarn](https://classic.yarnpkg.com/lang/en/docs/install) installed.
 
-Using npm package manager
+:::
+
+Create a new folder called `nhost-todos`, initialize a new JavaScript app there, and install the Nhost JavaScript SDK:
+
+<Tabs>
+  <TabItem value="npm" label="npm" default>
 
 ```bash
 npm init -y
+yarn add @nhost/nhost-js graphql
 ```
 
-or
-
-Using Yarn package manager
+  </TabItem>
+  <TabItem value="yarn" label="Yarn">
 
 ```bash
 yarn init -y
+npm install @nhost/nhost-js graphql
 ```
 
-> You might have to edit the `package.json` file and add/change the `type` object to `module` (`"type": "module"`).
+  </TabItem>
+</Tabs>
 
-Install Nhost JavaScript SDK:
-
-Using npm package manager
-
-```bash
-npm install @nhost/nhost-js
-```
-
-or
-Using Yarn package manager
-
-```bash
-yarn add @nhost/nhost-js
-```
+:::caution attention
+You might have to edit the `package.json` file and add/change the `type` object to `module` (`"type": "module"`).
+:::
 
 ---
 

docs/docs/get-started/quick-start/permissions.md

@@ -2,7 +2,7 @@
 title: 'Set permissions'
 ---
 
-In the previous section, you could fetch the todos because the **admin** role is enabled by default when using Hasura Console. When building your applications, you want to define permissions using **roles** that your users can assume when making requests.
+While using the Hasura Console, you could fetch the todos because the **admin** role is enabled by default but when building your applications with a client, you want to define permissions using **roles** that your users can assume when making requests.
 
 Hasura supports role-based access control. You create rules for each role, table, and operation (select, insert, update and delete) that can check dynamic session variables, like user ID.
 

docs/docs/platform/authentication/index.md

@@ -9,7 +9,7 @@ Nhost provides a ready-to-use authentication service, integrated with Nhost Java
 
 ## Getting Started
 
-Sign up a user with the [Nhost JavaScript SDK](/reference/sdk):
+Sign up a user with the [Nhost JavaScript SDK](/reference/javascript):
 
 ```js
 import { NhostClient } from '@nhost/nhost-js';
@@ -48,7 +48,7 @@ query {
 
 Nhost authentication uses two tokens: Access tokens and refresh tokens.
 
-[Nhost JavaScript SDK](/reference/sdk) automatically handles access and refresh tokens.
+[Nhost JavaScript SDK](/reference/javascript) automatically handles access and refresh tokens.
 
 ### Access tokens
 

docs/docs/platform/authentication/oauth-providers/facebook.mdx

@@ -58,7 +58,7 @@ To make sure we can fetch all user data (email, profile picture and name). For t
 
 ## Sign In users in your app
 
-Use the [Nhost JavaScript client](/reference/sdk) to sign in users in your app:
+Use the [Nhost JavaScript client](/reference/javascript) to sign in users in your app:
 
 ```js
 nhost.auth.signIn({

docs/docs/platform/authentication/oauth-providers/github.mdx

@@ -43,7 +43,7 @@ Follow this guide to sign in users with GitHub with your Nhost App.
 
 ## Sign In users in your app
 
-Use the [Nhost JavaScript client](/reference/sdk) to sign in users in your app:
+Use the [Nhost JavaScript client](/reference/javascript) to sign in users in your app:
 
 ```js
 nhost.auth.signIn({

docs/docs/platform/authentication/oauth-providers/index.md

@@ -23,7 +23,7 @@ You need to set client ID and client secret for each provider that you want to e
 
 ## Implementing sign-in experience
 
-Use the [Nhost JavaScript SDK](/reference/sdk) and the `signIn()` method to implement social sign-in in your app,
+Use the [Nhost JavaScript SDK](/reference/javascript) and the `signIn()` method to implement social sign-in in your app,
 
 Here's an example of how to implement sign-in with GitHub:
 

docs/docs/platform/authentication/oauth-providers/linkedin.mdx

@@ -50,7 +50,7 @@ Follow this guide to sign in users with LinkedIn with your Nhost App.
 
 ## Sign In users in your app
 
-Use the [Nhost JavaScript client](/reference/sdk) to sign in users in your app:
+Use the [Nhost JavaScript client](/reference/javascript) to sign in users in your app:
 
 ```js
 nhost.auth.signIn({

docs/docs/platform/authentication/oauth-providers/spotify.mdx

@@ -43,7 +43,7 @@ Follow this guide to sign in users with Spotify with your Nhost App.
 
 ## Sign In users in your app
 
-Use the [Nhost JavaScript client](/reference/sdk) to sign in users in your app:
+Use the [Nhost JavaScript client](/reference/javascript) to sign in users in your app:
 
 ```js
 nhost.auth.signIn({

docs/docs/platform/graphql/index.md

@@ -20,7 +20,7 @@ To interact with the GraphQL API it's recommended to use a GraphQL client:
 - [React Query](https://react-query.tanstack.com/graphql)
 - [SWR](https://swr.vercel.app/docs/data-fetching#graphql)
 
-It's also possible to use the built-in [GraphQL client](/reference/sdk/graphql) in the Nhost JavaScript client.
+It's also possible to use the built-in [GraphQL client](/reference/javascript/nhost-js/graphql) in the Nhost JavaScript client.
 
 ---
 

docs/docs/platform/nhost/local-development.md

@@ -3,6 +3,9 @@ title: 'Nhost CLI'
 sidebar_position: 3
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 Nhost CLI lets you run Nhost's development environment locally on macOS, Linux and Windows.
 
 ---
@@ -28,10 +31,23 @@ To run serverless functions locally, you must have the appropriate runtimes inst
 
 For Node.js, you will also need to have [express](https://www.npmjs.com/package/express) installed in your repository:
 
+<Tabs>
+  <TabItem value="npm" label="npm" default>
+
 ```bash
 npm install --save-dev express @types/express
 ```
 
+  </TabItem>
+  <TabItem value="yarn" label="Yarn">
+
+```bash
+yarn add -D express @types/express
+```
+
+  </TabItem>
+</Tabs>
+
 [Read more about runtimes](/platform/serverless-functions)
 
 ---

docs/docs/platform/serverless-functions/event-triggers.md

@@ -29,6 +29,10 @@ https://[app-subdomain].nhost.run/v1/functions/my-endpoint
 
 The environment variable `NHOST_BACKEND_URL` will have the correct value.
 
+```bash
+{{NHOST_BACKEND_URL}}/v1/functions/my-endpoint
+```
+
 ---
 
 ## Security

docs/docs/reference/docgen/javascript/auth/_category_.json

@@ -0,0 +1,3 @@
+{
+  "label": "Auth"
+}

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/01-sign-up.mdx

@@ -0,0 +1,29 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: signUp()
+sidebar_label: signUp()
+slug: /reference/javascript/auth/sign-up
+description: Use `signUp` to sign up users using email an password.
+---
+
+# `signUp()`
+
+Use `signUp` to sign up users using email an password.
+
+```ts
+auth.signIn({ email, password }) // email password
+```
+
+## Parameters
+
+---
+
+**<span className="parameter-name">params</span>** <span className="optional-status">required</span> [`SignUpEmailPasswordParams`](/reference/docgen/javascript/auth/types/sign-up-email-password-params)
+
+| Property                                                                                    | Type            | Required | Notes |
+| :------------------------------------------------------------------------------------------ | :-------------- | :------: | :---- |
+| <span className="parameter-name"><span className="light-grey">params.</span>password</span> | `string`        |    ✔️    |       |
+| <span className="parameter-name"><span className="light-grey">params.</span>email</span>    | `string`        |    ✔️    |       |
+| <span className="parameter-name"><span className="light-grey">params.</span>options</span>  | `SignUpOptions` |          |       |
+
+---

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/02-sign-in.mdx

@@ -0,0 +1,53 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: signIn()
+sidebar_label: signIn()
+slug: /reference/javascript/auth/sign-in
+description: Use `signIn` to sign in users using email and password, passwordless (email or sms) or an external provider. `signIn` can be used in various ways depending on the parameters.
+---
+
+# `signIn()`
+
+Use `signIn` to sign in users using email and password, passwordless
+(email or sms) or an external provider.
+`signIn` can be used in various ways depending on the parameters.
+
+```ts
+signIn({ email, password })
+```
+
+## Parameters
+
+---
+
+**<span className="parameter-name">params</span>** <span className="optional-status">required</span> [`SignInParams`](/reference/docgen/javascript/auth/types/sign-in-params)
+
+---
+
+## Examples
+
+### Sign in with email and password
+
+```ts
+signIn({ email, password })
+```
+
+### Sign in with an external provider (e.g: Google or Facebook)
+
+```ts
+signIn({ provider })
+```
+
+### Passwordless sign in with email (magic link)
+
+```ts
+signIn({ email }) // [step 1/2] Passwordless sign in with Email (Magic Link)
+signIn({ email, otp }) // [step 2/2] Finish passwordless sign in with email (OTP)
+```
+
+### Passwordless sign in with SMS
+
+```ts
+signIn({ phoneNumber }) // [step 1/2] Passwordless sign in with SMS
+signIn({ phoneNumber, otp }) // [step 2/2] Finish passwordless sign in with SMS (OTP)
+```

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/03-sign-out.mdx

@@ -0,0 +1,23 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: signOut()
+sidebar_label: signOut()
+slug: /reference/javascript/auth/sign-out
+description: Use `signOut` to sign out a user
+---
+
+# `signOut()`
+
+Use `signOut` to sign out a user
+
+```ts
+signOut()
+```
+
+## Parameters
+
+---
+
+**<span className="parameter-name">params</span>** <span className="optional-status">optional</span> `{ all: boolean }`
+
+---

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/04-reset-password.mdx

@@ -0,0 +1,28 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: resetPassword()
+sidebar_label: resetPassword()
+slug: /reference/javascript/auth/reset-password
+description: Use `resetPassword` to reset a user's password.
+---
+
+# `resetPassword()`
+
+Use `resetPassword` to reset a user's password.
+
+```ts
+auth.resetPassword({ email })
+```
+
+## Parameters
+
+---
+
+**<span className="parameter-name">\_\_namedParameters</span>** <span className="optional-status">required</span> [`ResetPasswordParams`](/reference/docgen/javascript/auth/types/reset-password-params)
+
+| Property                                                                                                | Type             | Required | Notes |
+| :------------------------------------------------------------------------------------------------------ | :--------------- | :------: | :---- |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>email</span>   | `string`         |    ✔️    |       |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>options</span> | `RedirectOption` |          |       |
+
+---

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/05-change-password.mdx

@@ -0,0 +1,27 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: changePassword()
+sidebar_label: changePassword()
+slug: /reference/javascript/auth/change-password
+description: Use `changePassword` to change a user's password.
+---
+
+# `changePassword()`
+
+Use `changePassword` to change a user's password.
+
+```ts
+auth.changePassword({ newPassword })
+```
+
+## Parameters
+
+---
+
+**<span className="parameter-name">params</span>** <span className="optional-status">required</span> [`ChangePasswordParams`](/reference/docgen/javascript/auth/types/change-password-params)
+
+| Property                                                                                       | Type     | Required | Notes |
+| :--------------------------------------------------------------------------------------------- | :------- | :------: | :---- |
+| <span className="parameter-name"><span className="light-grey">params.</span>newPassword</span> | `string` |    ✔️    |       |
+
+---

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/06-send-verification-email.mdx

@@ -0,0 +1,29 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: sendVerificationEmail()
+sidebar_label: sendVerificationEmail()
+slug: /reference/javascript/auth/send-verification-email
+description: Use `sendVerificationEmail` to send a verification email to the specified email.
+---
+
+# `sendVerificationEmail()`
+
+Use `sendVerificationEmail` to send a verification email
+to the specified email.
+
+```ts
+auth.sendVerificationEmail({ email })
+```
+
+## Parameters
+
+---
+
+**<span className="parameter-name">params</span>** <span className="optional-status">required</span> [`SendVerificationEmailParams`](/reference/docgen/javascript/auth/types/send-verification-email-params)
+
+| Property                                                                                   | Type             | Required | Notes |
+| :----------------------------------------------------------------------------------------- | :--------------- | :------: | :---- |
+| <span className="parameter-name"><span className="light-grey">params.</span>email</span>   | `string`         |    ✔️    |       |
+| <span className="parameter-name"><span className="light-grey">params.</span>options</span> | `RedirectOption` |          |       |
+
+---

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/07-change-email.mdx

@@ -0,0 +1,28 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: changeEmail()
+sidebar_label: changeEmail()
+slug: /reference/javascript/auth/change-email
+description: Use `changeEmail` to change a user's email
+---
+
+# `changeEmail()`
+
+Use `changeEmail` to change a user's email
+
+```ts
+auth.changeEmail({ newEmail })
+```
+
+## Parameters
+
+---
+
+**<span className="parameter-name">\_\_namedParameters</span>** <span className="optional-status">required</span> [`ChangeEmailParams`](/reference/docgen/javascript/auth/types/change-email-params)
+
+| Property                                                                                                 | Type             | Required | Notes |
+| :------------------------------------------------------------------------------------------------------- | :--------------- | :------: | :---- |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>newEmail</span> | `string`         |    ✔️    |       |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>options</span>  | `RedirectOption` |          |       |
+
+---

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/08-deanonymize.mdx

@@ -0,0 +1,32 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: deanonymize()
+sidebar_label: deanonymize()
+slug: /reference/javascript/auth/deanonymize
+description: Use `deanonymize` to deanonymize a user
+---
+
+# `deanonymize()`
+
+Use `deanonymize` to deanonymize a user
+
+```ts
+auth.deanonymize({ signInMethod: 'email-password', email })
+```
+
+## Parameters
+
+---
+
+**<span className="parameter-name">params</span>** <span className="optional-status">required</span> [`DeanonymizeParams`](/reference/docgen/javascript/auth/types/deanonymize-params)
+
+| Property                                                                                        | Type                                   | Required | Notes |
+| :---------------------------------------------------------------------------------------------- | :------------------------------------- | :------: | :---- |
+| <span className="parameter-name"><span className="light-grey">params.</span>email</span>        | `string`                               |    ✔️    |       |
+| <span className="parameter-name"><span className="light-grey">params.</span>signInMethod</span> | `"email-password"` \| `"passwordless"` |    ✔️    |       |
+| <span className="parameter-name"><span className="light-grey">params.</span>allowedRoles</span> | `Array<string>`                        |          |       |
+| <span className="parameter-name"><span className="light-grey">params.</span>defaultRole</span>  | `string`                               |          |       |
+| <span className="parameter-name"><span className="light-grey">params.</span>connection</span>   | `"email"` \| `"sms"`                   |          |       |
+| <span className="parameter-name"><span className="light-grey">params.</span>password</span>     | `string`                               |          |       |
+
+---

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/09-on-token-changed.mdx

@@ -0,0 +1,24 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: onTokenChanged()
+sidebar_label: onTokenChanged()
+slug: /reference/javascript/auth/on-token-changed
+description: Use `onTokenChanged` to add a custom function that will trigger whenever the access and refresh token is changed.
+---
+
+# `onTokenChanged()`
+
+Use `onTokenChanged` to add a custom function that will trigger whenever
+the access and refresh token is changed.
+
+```ts
+auth.onTokenChanged(() => console.log('access token changed'))
+```
+
+## Parameters
+
+---
+
+**<span className="parameter-name">fn</span>** <span className="optional-status">required</span> [`OnTokenChangedFunction`](/reference/docgen/javascript/auth/types/on-token-changed-function)
+
+---

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/10-on-auth-state-changed.mdx

@@ -0,0 +1,29 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: onAuthStateChanged()
+sidebar_label: onAuthStateChanged()
+slug: /reference/javascript/auth/on-auth-state-changed
+description: Use `onAuthStateChanged` to add a custom function that will trigger whenever the state of the user changed. Ex from signed in to signed out or vice versa.
+---
+
+# `onAuthStateChanged()`
+
+Use `onAuthStateChanged` to add a custom function that will trigger
+whenever the state of the user changed. Ex from signed in to signed out or
+vice versa.
+
+```ts
+auth.onAuthStateChanged((event, session) => {
+  console.log(
+    `Auth state changed. State is now ${event} with session: ${session}`
+  )
+})
+```
+
+## Parameters
+
+---
+
+**<span className="parameter-name">fn</span>** <span className="optional-status">required</span> [`AuthChangedFunction`](/reference/docgen/javascript/auth/types/auth-changed-function)
+
+---

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/11-is-authenticated.mdx

@@ -0,0 +1,19 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: isAuthenticated()
+sidebar_label: isAuthenticated()
+slug: /reference/javascript/auth/is-authenticated
+description: Use `isAuthenticated` to check if the user is authenticated or not.
+---
+
+# `isAuthenticated()`
+
+Use `isAuthenticated` to check if the user is authenticated or not.
+
+```ts
+const  = auth.isAuthenticated();
+
+if (authenticated) {
+  console.log('User is authenticated');
+}
+```

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/12-is-authenticated-async.mdx

@@ -0,0 +1,19 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: isAuthenticatedAsync()
+sidebar_label: isAuthenticatedAsync()
+slug: /reference/javascript/auth/is-authenticated-async
+description: Use `isAuthenticatedAsync` to wait and check if the user is authenticated or not.
+---
+
+# `isAuthenticatedAsync()`
+
+Use `isAuthenticatedAsync` to wait and check if the user is authenticated or not.
+
+```ts
+const isAuthenticated  = awiat auth.isAuthenticatedAsync();
+
+if (isAuthenticated) {
+  console.log('User is authenticated');
+}
+```

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/13-get-authentication-status.mdx

@@ -0,0 +1,23 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: getAuthenticationStatus()
+sidebar_label: getAuthenticationStatus()
+slug: /reference/javascript/auth/get-authentication-status
+description: Use `getAuthenticationStatus` to get the authentication status of the user.
+---
+
+# `getAuthenticationStatus()`
+
+Use `getAuthenticationStatus` to get the authentication status of the user.
+
+```ts
+const { isAuthenticated, isLoading } = auth.getAuthenticationStatus()
+
+if (isLoading) {
+  console.log('Loading...')
+}
+
+if (isAuthenticated) {
+  console.log('User is authenticated')
+}
+```

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/14-get-jwt-token.mdx

@@ -0,0 +1,14 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: getJWTToken()
+sidebar_label: getJWTToken()
+slug: /reference/javascript/auth/get-jwt-token
+sidebar_class_name: deprecated
+description: No description provided.
+---
+
+# `getJWTToken()`
+
+:::caution Deprecated
+Use `getAccessToken()` instead.
+:::

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/15-get-access-token.mdx

@@ -0,0 +1,15 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: getAccessToken()
+sidebar_label: getAccessToken()
+slug: /reference/javascript/auth/get-access-token
+description: Use `getAccessToken` to get the logged in user's access token.
+---
+
+# `getAccessToken()`
+
+Use `getAccessToken` to get the logged in user's access token.
+
+```ts
+const accessToken = auth.getAccessToken()
+```

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/16-get-decoded-access-token.mdx

@@ -0,0 +1,15 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: getDecodedAccessToken()
+sidebar_label: getDecodedAccessToken()
+slug: /reference/javascript/auth/get-decoded-access-token
+description: Decode the current decoded access token (JWT), or return `null` if the user is not authenticated (no token)
+---
+
+# `getDecodedAccessToken()`
+
+Decode the current decoded access token (JWT), or return `null` if the user is not authenticated (no token)
+
+**`@see`**
+
+{@link https://hasura.io/docs/latest/graphql/core/auth/authentication/jwt/|Hasura documentation}

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/17-get-hasura-claims.mdx

@@ -0,0 +1,15 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: getHasuraClaims()
+sidebar_label: getHasuraClaims()
+slug: /reference/javascript/auth/get-hasura-claims
+description: Decode the Hasura claims from the current access token (JWT) located in the `https://hasura.io/jwt/claims` namespace, or return `null` if the user is not authenticated (no token)
+---
+
+# `getHasuraClaims()`
+
+Decode the Hasura claims from the current access token (JWT) located in the `https://hasura.io/jwt/claims` namespace, or return `null` if the user is not authenticated (no token)
+
+**`@see`**
+
+{@link https://hasura.io/docs/latest/graphql/core/auth/authentication/jwt/|Hasura documentation}

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/18-get-hasura-claim.mdx

@@ -0,0 +1,26 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: getHasuraClaim()
+sidebar_label: getHasuraClaim()
+slug: /reference/javascript/auth/get-hasura-claim
+description: Get the value of a given Hasura claim in the current access token (JWT). Returns null if the user is not authenticated, or if the claim is not in the token. Return `null` if the user is not authenticated (no token)
+---
+
+# `getHasuraClaim()`
+
+Get the value of a given Hasura claim in the current access token (JWT). Returns null if the user is not authenticated, or if the claim is not in the token.
+Return `null` if the user is not authenticated (no token)
+
+**`@see`**
+
+{@link https://hasura.io/docs/latest/graphql/core/auth/authentication/jwt/|Hasura documentation}
+
+## Parameters
+
+---
+
+**<span className="parameter-name">name</span>** <span className="optional-status">required</span> `string`
+
+name of the variable. Automatically adds the `x-hasura-` prefix if it is missing
+
+---

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/19-refresh-session.mdx

@@ -0,0 +1,25 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: refreshSession()
+sidebar_label: refreshSession()
+slug: /reference/javascript/auth/refresh-session
+description: Use `refreshSession()` to refresh the current session or refresh the session with an provided `refreshToken`.
+---
+
+# `refreshSession()`
+
+Use `refreshSession()` to refresh the current session or refresh the
+session with an provided `refreshToken`.
+
+```ts
+refreshToken()
+refreshToken(refreshToken)
+```
+
+## Parameters
+
+---
+
+**<span className="parameter-name">refreshToken</span>** <span className="optional-status">optional</span> `string`
+
+---

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/20-get-session.mdx

@@ -0,0 +1,15 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: getSession()
+sidebar_label: getSession()
+slug: /reference/javascript/auth/get-session
+description: Use `getSession()` to get the current session.
+---
+
+# `getSession()`
+
+Use `getSession()` to get the current session.
+
+```ts
+const session = getSession()
+```

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/21-get-user.mdx

@@ -0,0 +1,15 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: getUser()
+sidebar_label: getUser()
+slug: /reference/javascript/auth/get-user
+description: Use `getUser()` to get the current user.
+---
+
+# `getUser()`
+
+Use `getUser()` to get the current user.
+
+```ts
+const user = getUser()
+```

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/index.mdx

@@ -0,0 +1,31 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: HasuraAuthClient
+sidebar_label: Auth
+description: No description provided.
+slug: /reference/javascript/auth
+---
+
+# `HasuraAuthClient`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">\_\_namedParameters</span>** <span className="optional-status">required</span> [`NhostAuthConstructorParams`](/reference/docgen/javascript/auth/types/nhost-auth-constructor-params)
+
+| Property                                                                                                                                                                                                                                          | Type                                                                               | Required | Notes                                                                                                             |
+| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------- | :------: | :---------------------------------------------------------------------------------------------------------------- |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>url</span>                                                                                                                                               | `string`                                                                           |    ✔️    |                                                                                                                   |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>Client</span>                                                                                                                                            | `AuthClient`                                                                       |          |                                                                                                                   |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>start</span>                                                                                                                                             | `boolean`                                                                          |          |                                                                                                                   |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>autoSignIn</span>                                                                                                                                        | `boolean`                                                                          |          | When set to true, will parse the url on startup to check if it contains a refresh token to start the session with |
+| <span className="parameter-name deprecated"><span className="light-grey">\_\_namedParameters.</span>autoLogin</span> <span className="deprecation-sign" title="use autoSignIn instead">⚠️</span>                                                  | `boolean`                                                                          |          |                                                                                                                   |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>autoRefreshToken</span>                                                                                                                                  | `boolean`                                                                          |          | When set to true, will automatically refresh token before it expires                                              |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>clientStorageSetter</span>                                                                                                                               | [`StorageSetter`](/reference/docgen/javascript/auth/types/storage-setter)          |          | Define a way to set information about the refresh token and its exipration date                                   |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>clientStorageGetter</span>                                                                                                                               | [`StorageGetter`](/reference/docgen/javascript/auth/types/storage-getter)          |          | Define a way to get information about the refresh token and its exipration date                                   |
+| <span className="parameter-name deprecated"><span className="light-grey">\_\_namedParameters.</span>clientStorageType</span> <span className="deprecation-sign" title="Use clientStorageGetter and clientStorageSetter options instead">⚠️</span> | [`ClientStorageType`](/reference/docgen/javascript/auth/types/client-storage-type) |          |                                                                                                                   |
+| <span className="parameter-name deprecated"><span className="light-grey">\_\_namedParameters.</span>clientStorage</span> <span className="deprecation-sign" title="Use clientStorageGetter and clientStorageSetter options instead">⚠️</span>     | [`ClientStorage`](/reference/docgen/javascript/auth/types/client-storage)          |          |                                                                                                                   |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>refreshIntervalTime</span>                                                                                                                               | `number`                                                                           |          | Time interval until token refreshes, in seconds                                                                   |
+
+---

docs/docs/reference/docgen/javascript/auth/types/_category_.json

@@ -0,0 +1,9 @@
+{
+  "label": "Types",
+  "position": 1,
+  "className": "hidden",
+  "link": {
+    "type": "generated-index",
+    "slug": "/reference/docgen/javascript/auth/types"
+  }
+}

docs/docs/reference/docgen/javascript/auth/types/api-change-email-response.mdx

@@ -0,0 +1,17 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiChangeEmailResponse
+sidebar_label: ApiChangeEmailResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `ApiChangeEmailResponse`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">error</span>** <span className="optional-status">required</span> `null` | [`ApiError`](/reference/docgen/javascript/auth/types/api-error)
+
+---

docs/docs/reference/docgen/javascript/auth/types/api-change-password-response.mdx

@@ -0,0 +1,17 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiChangePasswordResponse
+sidebar_label: ApiChangePasswordResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `ApiChangePasswordResponse`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">error</span>** <span className="optional-status">required</span> `null` | [`ApiError`](/reference/docgen/javascript/auth/types/api-error)
+
+---

docs/docs/reference/docgen/javascript/auth/types/api-deanonymize-response.mdx

@@ -0,0 +1,17 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiDeanonymizeResponse
+sidebar_label: ApiDeanonymizeResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `ApiDeanonymizeResponse`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">error</span>** <span className="optional-status">required</span> `null` | [`ApiError`](/reference/docgen/javascript/auth/types/api-error)
+
+---

docs/docs/reference/docgen/javascript/auth/types/api-error.mdx

@@ -0,0 +1,21 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiError
+sidebar_label: ApiError
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `ApiError`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">message</span>** <span className="optional-status">required</span> `string`
+
+---
+
+**<span className="parameter-name">status</span>** <span className="optional-status">required</span> `number`
+
+---

docs/docs/reference/docgen/javascript/auth/types/api-refresh-token-response.mdx

@@ -0,0 +1,15 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiRefreshTokenResponse
+sidebar_label: ApiRefreshTokenResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `ApiRefreshTokenResponse`
+
+```ts
+type ApiRefreshTokenResponse =
+  | { session: null; error: ApiError }
+  | { session: Session; error: null }
+```

docs/docs/reference/docgen/javascript/auth/types/api-reset-password-response.mdx

@@ -0,0 +1,17 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiResetPasswordResponse
+sidebar_label: ApiResetPasswordResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `ApiResetPasswordResponse`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">error</span>** <span className="optional-status">required</span> `null` | [`ApiError`](/reference/docgen/javascript/auth/types/api-error)
+
+---

docs/docs/reference/docgen/javascript/auth/types/api-send-verification-email-response.mdx

@@ -0,0 +1,17 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiSendVerificationEmailResponse
+sidebar_label: ApiSendVerificationEmailResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `ApiSendVerificationEmailResponse`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">error</span>** <span className="optional-status">required</span> `null` | [`ApiError`](/reference/docgen/javascript/auth/types/api-error)
+
+---

docs/docs/reference/docgen/javascript/auth/types/api-sign-in-data.mdx

@@ -0,0 +1,28 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiSignInData
+sidebar_label: ApiSignInData
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `ApiSignInData`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">session</span>** <span className="optional-status">required</span> [`Session`](/reference/docgen/javascript/auth/types/session)
+
+| Property                                                                                                 | Type                                                             | Required | Notes |
+| :------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------- | :------: | :---- |
+| <span className="parameter-name"><span className="light-grey">session.</span>user</span>                 | `null` \| [`User`](/reference/docgen/javascript/auth/types/user) |    ✔️    |       |
+| <span className="parameter-name"><span className="light-grey">session.</span>refreshToken</span>         | `string`                                                         |    ✔️    |       |
+| <span className="parameter-name"><span className="light-grey">session.</span>accessTokenExpiresIn</span> | `number`                                                         |    ✔️    |       |
+| <span className="parameter-name"><span className="light-grey">session.</span>accessToken</span>          | `string`                                                         |    ✔️    |       |
+
+---
+
+**<span className="parameter-name">mfa</span>** <span className="optional-status">required</span> `null` | [`Mfa`](/reference/docgen/javascript/auth/types/mfa)
+
+---

docs/docs/reference/docgen/javascript/auth/types/api-sign-in-response.mdx

@@ -0,0 +1,15 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiSignInResponse
+sidebar_label: ApiSignInResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `ApiSignInResponse`
+
+```ts
+type ApiSignInResponse =
+  | { data: ApiSignInData; error: null }
+  | { data: null; error: ApiError }
+```

docs/docs/reference/docgen/javascript/auth/types/api-sign-out-response.mdx

@@ -0,0 +1,17 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiSignOutResponse
+sidebar_label: ApiSignOutResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `ApiSignOutResponse`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">error</span>** <span className="optional-status">required</span> `null` | [`ApiError`](/reference/docgen/javascript/auth/types/api-error)
+
+---

docs/docs/reference/docgen/javascript/auth/types/api-sign-up-email-password-response.mdx

@@ -0,0 +1,15 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiSignUpEmailPasswordResponse
+sidebar_label: ApiSignUpEmailPasswordResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `ApiSignUpEmailPasswordResponse`
+
+```ts
+type ApiSignUpEmailPasswordResponse =
+  | { session: null; error: ApiError }
+  | { session: Session; error: null }
+```

docs/docs/reference/docgen/javascript/auth/types/auth-change-event.mdx

@@ -0,0 +1,13 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: AuthChangeEvent
+sidebar_label: AuthChangeEvent
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `AuthChangeEvent`
+
+```ts
+type AuthChangeEvent = 'SIGNED_IN' | 'SIGNED_OUT'
+```

docs/docs/reference/docgen/javascript/auth/types/auth-changed-function.mdx

@@ -0,0 +1,16 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: AuthChangedFunction
+sidebar_label: AuthChangedFunction
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `AuthChangedFunction`
+
+```ts
+type AuthChangedFunction = () => (
+  event: AuthChangeEvent,
+  session: Session | null
+) => void
+```

docs/docs/reference/docgen/javascript/auth/types/change-email-params.mdx

@@ -0,0 +1,21 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ChangeEmailParams
+sidebar_label: ChangeEmailParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `ChangeEmailParams`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">newEmail</span>** <span className="optional-status">required</span> `string`
+
+---
+
+**<span className="parameter-name">options</span>** <span className="optional-status">optional</span> `RedirectOption`
+
+---

docs/docs/reference/docgen/javascript/auth/types/change-password-params.mdx

@@ -0,0 +1,17 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ChangePasswordParams
+sidebar_label: ChangePasswordParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `ChangePasswordParams`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">newPassword</span>** <span className="optional-status">required</span> `string`
+
+---

docs/docs/reference/docgen/javascript/auth/types/client-storage-type.mdx

@@ -0,0 +1,19 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ClientStorageType
+sidebar_label: ClientStorageType
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `ClientStorageType`
+
+```ts
+type ClientStorageType =
+  | 'capacitor'
+  | 'custom'
+  | 'expo-secure-storage'
+  | 'localStorage'
+  | 'react-native'
+  | 'web'
+```

docs/docs/reference/docgen/javascript/auth/types/client-storage.mdx

@@ -0,0 +1,49 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ClientStorage
+sidebar_label: ClientStorage
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `ClientStorage`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">deleteItemAsync</span>** <span className="optional-status">optional</span> `(key: string) => void`
+
+---
+
+**<span className="parameter-name">getItemAsync</span>** <span className="optional-status">optional</span> `(key: string) => any`
+
+---
+
+**<span className="parameter-name">setItemAsync</span>** <span className="optional-status">optional</span> `(key: string, value: string) => void`
+
+---
+
+**<span className="parameter-name">remove</span>** <span className="optional-status">optional</span> `(options: { key: string }) => void`
+
+---
+
+**<span className="parameter-name">get</span>** <span className="optional-status">optional</span> `(options: { key: string }) => any`
+
+---
+
+**<span className="parameter-name">set</span>** <span className="optional-status">optional</span> `(options: { key: string, value: string }) => void`
+
+---
+
+**<span className="parameter-name">removeItem</span>** <span className="optional-status">optional</span> `(key: string) => void`
+
+---
+
+**<span className="parameter-name">getItem</span>** <span className="optional-status">optional</span> `(key: string) => any`
+
+---
+
+**<span className="parameter-name">setItem</span>** <span className="optional-status">optional</span> `(_key: string, _value: string) => void`
+
+---

docs/docs/reference/docgen/javascript/auth/types/deanonymize-params.mdx

@@ -0,0 +1,37 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: DeanonymizeParams
+sidebar_label: DeanonymizeParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `DeanonymizeParams`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">email</span>** <span className="optional-status">required</span> `string`
+
+---
+
+**<span className="parameter-name">signInMethod</span>** <span className="optional-status">required</span> `"email-password"` | `"passwordless"`
+
+---
+
+**<span className="parameter-name">allowedRoles</span>** <span className="optional-status">optional</span> `Array<string>`
+
+---
+
+**<span className="parameter-name">defaultRole</span>** <span className="optional-status">optional</span> `string`
+
+---
+
+**<span className="parameter-name">connection</span>** <span className="optional-status">optional</span> `"email"` | `"sms"`
+
+---
+
+**<span className="parameter-name">password</span>** <span className="optional-status">optional</span> `string`
+
+---

docs/docs/reference/docgen/javascript/auth/types/headers.mdx

@@ -0,0 +1,17 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: Headers
+sidebar_label: Headers
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `Headers`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">Authorization</span>** <span className="optional-status">optional</span> `string`
+
+---

docs/docs/reference/docgen/javascript/auth/types/login-data.mdx

@@ -0,0 +1,21 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: LoginData
+sidebar_label: LoginData
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `LoginData`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">mfa</span>** <span className="optional-status">optional</span> `boolean`
+
+---
+
+**<span className="parameter-name">ticket</span>** <span className="optional-status">optional</span> `string`
+
+---

docs/docs/reference/docgen/javascript/auth/types/mfa.mdx

@@ -0,0 +1,17 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: Mfa
+sidebar_label: Mfa
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `Mfa`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">ticket</span>** <span className="optional-status">required</span> `string`
+
+---

docs/docs/reference/docgen/javascript/auth/types/nhost-auth-constructor-params.mdx

@@ -0,0 +1,91 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: NhostAuthConstructorParams
+sidebar_label: NhostAuthConstructorParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `NhostAuthConstructorParams`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">url</span>** <span className="optional-status">required</span> `string`
+
+---
+
+**<span className="parameter-name">Client</span>** <span className="optional-status">optional</span> `AuthClient`
+
+---
+
+**<span className="parameter-name">start</span>** <span className="optional-status">optional</span> `boolean`
+
+---
+
+**<span className="parameter-name">autoSignIn</span>** <span className="optional-status">optional</span> `boolean`
+
+When set to true, will parse the url on startup to check if it contains a refresh token to start the session with
+
+---
+
+**<span className="parameter-name deprecated">autoLogin</span>** <span className="optional-status">optional</span> `boolean`
+
+:::caution Deprecated
+use autoSignIn instead
+:::
+
+---
+
+**<span className="parameter-name">autoRefreshToken</span>** <span className="optional-status">optional</span> `boolean`
+
+When set to true, will automatically refresh token before it expires
+
+---
+
+**<span className="parameter-name">clientStorageSetter</span>** <span className="optional-status">optional</span> [`StorageSetter`](/reference/docgen/javascript/auth/types/storage-setter)
+
+Define a way to set information about the refresh token and its exipration date
+
+---
+
+**<span className="parameter-name">clientStorageGetter</span>** <span className="optional-status">optional</span> [`StorageGetter`](/reference/docgen/javascript/auth/types/storage-getter)
+
+Define a way to get information about the refresh token and its exipration date
+
+---
+
+**<span className="parameter-name deprecated">clientStorageType</span>** <span className="optional-status">optional</span> [`ClientStorageType`](/reference/docgen/javascript/auth/types/client-storage-type)
+
+:::caution Deprecated
+Use clientStorageGetter and clientStorageSetter options instead
+:::
+
+---
+
+**<span className="parameter-name deprecated">clientStorage</span>** <span className="optional-status">optional</span> [`ClientStorage`](/reference/docgen/javascript/auth/types/client-storage)
+
+:::caution Deprecated
+Use clientStorageGetter and clientStorageSetter options instead
+:::
+
+| Property                                                                                                  | Type                                                | Required | Notes |
+| :-------------------------------------------------------------------------------------------------------- | :-------------------------------------------------- | :------: | :---- |
+| <span className="parameter-name"><span className="light-grey">clientStorage.</span>deleteItemAsync</span> | `(key: string) => void`                             |          |       |
+| <span className="parameter-name"><span className="light-grey">clientStorage.</span>getItemAsync</span>    | `(key: string) => any`                              |          |       |
+| <span className="parameter-name"><span className="light-grey">clientStorage.</span>setItemAsync</span>    | `(key: string, value: string) => void`              |          |       |
+| <span className="parameter-name"><span className="light-grey">clientStorage.</span>remove</span>          | `(options: { key: string }) => void`                |          |       |
+| <span className="parameter-name"><span className="light-grey">clientStorage.</span>get</span>             | `(options: { key: string }) => any`                 |          |       |
+| <span className="parameter-name"><span className="light-grey">clientStorage.</span>set</span>             | `(options: { key: string, value: string }) => void` |          |       |
+| <span className="parameter-name"><span className="light-grey">clientStorage.</span>removeItem</span>      | `(key: string) => void`                             |          |       |
+| <span className="parameter-name"><span className="light-grey">clientStorage.</span>getItem</span>         | `(key: string) => any`                              |          |       |
+| <span className="parameter-name"><span className="light-grey">clientStorage.</span>setItem</span>         | `(_key: string, _value: string) => void`            |          |       |
+
+---
+
+**<span className="parameter-name">refreshIntervalTime</span>** <span className="optional-status">optional</span> `number`
+
+Time interval until token refreshes, in seconds
+
+---

docs/docs/reference/docgen/javascript/auth/types/on-token-changed-function.mdx

@@ -0,0 +1,13 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: OnTokenChangedFunction
+sidebar_label: OnTokenChangedFunction
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `OnTokenChangedFunction`
+
+```ts
+type OnTokenChangedFunction = () => (session: Session | null) => void
+```

docs/docs/reference/docgen/javascript/auth/types/provider.mdx

@@ -0,0 +1,24 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: Provider
+sidebar_label: Provider
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `Provider`
+
+```ts
+type Provider =
+  | 'apple'
+  | 'facebook'
+  | 'github'
+  | 'google'
+  | 'linkedin'
+  | 'spotify'
+  | 'twitter'
+  | 'windowslive'
+  | 'strava'
+  | 'gitlab'
+  | 'bitbucket'
+```

docs/docs/reference/docgen/javascript/auth/types/reset-password-params.mdx

@@ -0,0 +1,21 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ResetPasswordParams
+sidebar_label: ResetPasswordParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `ResetPasswordParams`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">email</span>** <span className="optional-status">required</span> `string`
+
+---
+
+**<span className="parameter-name">options</span>** <span className="optional-status">optional</span> `RedirectOption`
+
+---

docs/docs/reference/docgen/javascript/auth/types/send-verification-email-params.mdx

@@ -0,0 +1,21 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SendVerificationEmailParams
+sidebar_label: SendVerificationEmailParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `SendVerificationEmailParams`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">email</span>** <span className="optional-status">required</span> `string`
+
+---
+
+**<span className="parameter-name">options</span>** <span className="optional-status">optional</span> `RedirectOption`
+
+---

docs/docs/reference/docgen/javascript/auth/types/session.mdx

@@ -0,0 +1,29 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: Session
+sidebar_label: Session
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `Session`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">accessToken</span>** <span className="optional-status">required</span> `string`
+
+---
+
+**<span className="parameter-name">accessTokenExpiresIn</span>** <span className="optional-status">required</span> `number`
+
+---
+
+**<span className="parameter-name">refreshToken</span>** <span className="optional-status">required</span> `string`
+
+---
+
+**<span className="parameter-name">user</span>** <span className="optional-status">required</span> `null` | [`User`](/reference/docgen/javascript/auth/types/user)
+
+---

docs/docs/reference/docgen/javascript/auth/types/sign-in-email-password-params.mdx

@@ -0,0 +1,21 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignInEmailPasswordParams
+sidebar_label: SignInEmailPasswordParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `SignInEmailPasswordParams`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">email</span>** <span className="optional-status">required</span> `string`
+
+---
+
+**<span className="parameter-name">password</span>** <span className="optional-status">required</span> `string`
+
+---

docs/docs/reference/docgen/javascript/auth/types/sign-in-params.mdx

@@ -0,0 +1,18 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignInParams
+sidebar_label: SignInParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `SignInParams`
+
+```ts
+type SignInParams =
+  | SignInEmailPasswordParams
+  | SignInPasswordlessEmailParams
+  | SignInPasswordlessSmsOtpParams
+  | SignInPasswordlessSmsParams
+  | SignInWithProviderOptions
+```

docs/docs/reference/docgen/javascript/auth/types/sign-in-passwordless-email-params.mdx

@@ -0,0 +1,21 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignInPasswordlessEmailParams
+sidebar_label: SignInPasswordlessEmailParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `SignInPasswordlessEmailParams`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">email</span>** <span className="optional-status">required</span> `string`
+
+---
+
+**<span className="parameter-name">options</span>** <span className="optional-status">optional</span> `PasswordlessOptions`
+
+---

docs/docs/reference/docgen/javascript/auth/types/sign-in-passwordless-sms-otp-params.mdx

@@ -0,0 +1,21 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignInPasswordlessSmsOtpParams
+sidebar_label: SignInPasswordlessSmsOtpParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `SignInPasswordlessSmsOtpParams`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">phoneNumber</span>** <span className="optional-status">required</span> `string`
+
+---
+
+**<span className="parameter-name">otp</span>** <span className="optional-status">required</span> `string`
+
+---

docs/docs/reference/docgen/javascript/auth/types/sign-in-passwordless-sms-params.mdx

@@ -0,0 +1,21 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignInPasswordlessSmsParams
+sidebar_label: SignInPasswordlessSmsParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `SignInPasswordlessSmsParams`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">phoneNumber</span>** <span className="optional-status">required</span> `string`
+
+---
+
+**<span className="parameter-name">options</span>** <span className="optional-status">optional</span> `PasswordlessOptions`
+
+---

docs/docs/reference/docgen/javascript/auth/types/sign-in-reponse.mdx

@@ -0,0 +1,33 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignInReponse
+sidebar_label: SignInReponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `SignInReponse`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">session</span>** <span className="optional-status">required</span> `null` | [`Session`](/reference/docgen/javascript/auth/types/session)
+
+---
+
+**<span className="parameter-name">error</span>** <span className="optional-status">required</span> `null` | [`ApiError`](/reference/docgen/javascript/auth/types/api-error)
+
+---
+
+**<span className="parameter-name">mfa</span>** <span className="optional-status">optional</span> `{ enabled: boolean, ticket: string }`
+
+---
+
+**<span className="parameter-name">providerUrl</span>** <span className="optional-status">optional</span> `string`
+
+---
+
+**<span className="parameter-name">provider</span>** <span className="optional-status">optional</span> `string`
+
+---

docs/docs/reference/docgen/javascript/auth/types/sign-in-with-provider-options.mdx

@@ -0,0 +1,21 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignInWithProviderOptions
+sidebar_label: SignInWithProviderOptions
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `SignInWithProviderOptions`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">provider</span>** <span className="optional-status">required</span> [`Provider`](/reference/docgen/javascript/auth/types/provider)
+
+---
+
+**<span className="parameter-name">options</span>** <span className="optional-status">optional</span> `ProviderOptions`
+
+---

docs/docs/reference/docgen/javascript/auth/types/sign-up-email-password-params.mdx

@@ -0,0 +1,25 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignUpEmailPasswordParams
+sidebar_label: SignUpEmailPasswordParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `SignUpEmailPasswordParams`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">password</span>** <span className="optional-status">required</span> `string`
+
+---
+
+**<span className="parameter-name">email</span>** <span className="optional-status">required</span> `string`
+
+---
+
+**<span className="parameter-name">options</span>** <span className="optional-status">optional</span> `SignUpOptions`
+
+---

docs/docs/reference/docgen/javascript/auth/types/sign-up-params.mdx

@@ -0,0 +1,9 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignUpParams
+sidebar_label: SignUpParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `SignUpParams`

docs/docs/reference/docgen/javascript/auth/types/sign-up-response.mdx

@@ -0,0 +1,15 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignUpResponse
+sidebar_label: SignUpResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `SignUpResponse`
+
+```ts
+type SignUpResponse =
+  | { session: null; error: ApiError }
+  | { session: Session | null; error: null }
+```

docs/docs/reference/docgen/javascript/auth/types/storage-getter.mdx

@@ -0,0 +1,15 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: StorageGetter
+sidebar_label: StorageGetter
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `StorageGetter`
+
+```ts
+type StorageGetter = () => (
+  key: string
+) => string | null | Promise<string | null>
+```

docs/docs/reference/docgen/javascript/auth/types/storage-setter.mdx

@@ -0,0 +1,16 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: StorageSetter
+sidebar_label: StorageSetter
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `StorageSetter`
+
+```ts
+type StorageSetter = () => (
+  key: string,
+  value: string | null
+) => void | Promise<void>
+```

docs/docs/reference/docgen/javascript/auth/types/user.mdx

@@ -0,0 +1,93 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: User
+sidebar_label: User
+description: User information
+displayed_sidebar: referenceSidebar
+---
+
+# `User`
+
+User information
+
+## Parameters
+
+---
+
+**<span className="parameter-name">id</span>** <span className="optional-status">required</span> `string`
+
+User's unique identifier (uuid)
+
+---
+
+**<span className="parameter-name">createdAt</span>** <span className="optional-status">required</span> `string`
+
+The date-time when the user has been created
+
+---
+
+**<span className="parameter-name">displayName</span>** <span className="optional-status">required</span> `string`
+
+User's display name
+
+---
+
+**<span className="parameter-name">avatarUrl</span>** <span className="optional-status">required</span> `string`
+
+The URL to the user's profile picture
+
+---
+
+**<span className="parameter-name">locale</span>** <span className="optional-status">required</span> `string`
+
+The locale of the user, as a two-characters string
+
+---
+
+**<span className="parameter-name">email</span>** <span className="optional-status">optional</span> `string`
+
+User's email address
+
+---
+
+**<span className="parameter-name">isAnonymous</span>** <span className="optional-status">required</span> `boolean`
+
+Whether or not the user is anonymous
+
+---
+
+**<span className="parameter-name">defaultRole</span>** <span className="optional-status">required</span> `string`
+
+The default role of the user
+
+---
+
+**<span className="parameter-name">roles</span>** <span className="optional-status">required</span> `Array<string>`
+
+The roles assigned to the user
+
+---
+
+**<span className="parameter-name">metadata</span>** <span className="optional-status">required</span> `Record<string, unknown>`
+
+Additional attributes used for user information
+
+---
+
+**<span className="parameter-name">emailVerified</span>** <span className="optional-status">required</span> `boolean`
+
+Is `true` if the user email has not been verified
+
+---
+
+**<span className="parameter-name">phoneNumber</span>** <span className="optional-status">required</span> `null` | `string`
+
+---
+
+**<span className="parameter-name">phoneNumberVerified</span>** <span className="optional-status">required</span> `boolean`
+
+---
+
+**<span className="parameter-name">activeMfaType</span>** <span className="optional-status">required</span> `null` | `"totp"`
+
+---

docs/docs/reference/docgen/javascript/nhost-js/_category_.json

@@ -0,0 +1,3 @@
+{
+  "label": "Nhost JS"
+}

docs/docs/reference/docgen/javascript/nhost-js/content/create-client.mdx

@@ -0,0 +1,31 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: createClient()
+sidebar_label: createClient()
+slug: /reference/javascript/nhost-js/create-client
+description: No description provided.
+---
+
+# `createClient()`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">config</span>** <span className="optional-status">required</span> [`NhostClientConstructorParams`](/reference/docgen/javascript/nhost-js/types/nhost-client-constructor-params)
+
+| Property                                                                                                                                                                                                                             | Type                | Required | Notes                                                                                                             |
+| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------ | :------: | :---------------------------------------------------------------------------------------------------------------- |
+| <span className="parameter-name"><span className="light-grey">config.</span>backendUrl</span>                                                                                                                                        | `string`            |    ✔️    | Nhost backend URL.                                                                                                |
+| <span className="parameter-name"><span className="light-grey">config.</span>refreshIntervalTime</span>                                                                                                                               | `number`            |          | Time interval until token refreshes, in seconds                                                                   |
+| <span className="parameter-name deprecated"><span className="light-grey">config.</span>clientStorage</span> <span className="deprecation-sign" title="Use clientStorageGetter and clientStorageSetter options instead">⚠️</span>     | `ClientStorage`     |          |                                                                                                                   |
+| <span className="parameter-name deprecated"><span className="light-grey">config.</span>clientStorageType</span> <span className="deprecation-sign" title="Use clientStorageGetter and clientStorageSetter options instead">⚠️</span> | `ClientStorageType` |          |                                                                                                                   |
+| <span className="parameter-name"><span className="light-grey">config.</span>clientStorageGetter</span>                                                                                                                               | `StorageGetter`     |          | Define a way to get information about the refresh token and its exipration date                                   |
+| <span className="parameter-name"><span className="light-grey">config.</span>clientStorageSetter</span>                                                                                                                               | `StorageSetter`     |          | Define a way to set information about the refresh token and its exipration date                                   |
+| <span className="parameter-name"><span className="light-grey">config.</span>autoRefreshToken</span>                                                                                                                                  | `boolean`           |          | When set to true, will automatically refresh token before it expires                                              |
+| <span className="parameter-name deprecated"><span className="light-grey">config.</span>autoLogin</span> <span className="deprecation-sign" title="use autoSignIn instead">⚠️</span>                                                  | `boolean`           |          |                                                                                                                   |
+| <span className="parameter-name"><span className="light-grey">config.</span>autoSignIn</span>                                                                                                                                        | `boolean`           |          | When set to true, will parse the url on startup to check if it contains a refresh token to start the session with |
+| <span className="parameter-name"><span className="light-grey">config.</span>start</span>                                                                                                                                             | `boolean`           |          |                                                                                                                   |
+| <span className="parameter-name"><span className="light-grey">config.</span>Client</span>                                                                                                                                            | `AuthClient`        |          |                                                                                                                   |
+
+---

docs/docs/reference/docgen/javascript/nhost-js/content/nhost-client/index.mdx

@@ -0,0 +1,33 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: NhostClient
+sidebar_label: NhostClient
+description: No description provided.
+slug: /reference/javascript/nhost-js/nhost-client
+---
+
+# `NhostClient`
+
+Nhost Client
+
+## Parameters
+
+---
+
+**<span className="parameter-name">\_\_namedParameters</span>** <span className="optional-status">required</span> [`NhostClientConstructorParams`](/reference/docgen/javascript/nhost-js/types/nhost-client-constructor-params)
+
+| Property                                                                                                                                                                                                                                          | Type                | Required | Notes                                                                                                             |
+| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------ | :------: | :---------------------------------------------------------------------------------------------------------------- |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>backendUrl</span>                                                                                                                                        | `string`            |    ✔️    | Nhost backend URL.                                                                                                |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>Client</span>                                                                                                                                            | `AuthClient`        |          |                                                                                                                   |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>start</span>                                                                                                                                             | `boolean`           |          |                                                                                                                   |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>autoSignIn</span>                                                                                                                                        | `boolean`           |          | When set to true, will parse the url on startup to check if it contains a refresh token to start the session with |
+| <span className="parameter-name deprecated"><span className="light-grey">\_\_namedParameters.</span>autoLogin</span> <span className="deprecation-sign" title="use autoSignIn instead">⚠️</span>                                                  | `boolean`           |          |                                                                                                                   |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>autoRefreshToken</span>                                                                                                                                  | `boolean`           |          | When set to true, will automatically refresh token before it expires                                              |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>clientStorageSetter</span>                                                                                                                               | `StorageSetter`     |          | Define a way to set information about the refresh token and its exipration date                                   |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>clientStorageGetter</span>                                                                                                                               | `StorageGetter`     |          | Define a way to get information about the refresh token and its exipration date                                   |
+| <span className="parameter-name deprecated"><span className="light-grey">\_\_namedParameters.</span>clientStorageType</span> <span className="deprecation-sign" title="Use clientStorageGetter and clientStorageSetter options instead">⚠️</span> | `ClientStorageType` |          |                                                                                                                   |
+| <span className="parameter-name deprecated"><span className="light-grey">\_\_namedParameters.</span>clientStorage</span> <span className="deprecation-sign" title="Use clientStorageGetter and clientStorageSetter options instead">⚠️</span>     | `ClientStorage`     |          |                                                                                                                   |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>refreshIntervalTime</span>                                                                                                                               | `number`            |          | Time interval until token refreshes, in seconds                                                                   |
+
+---

docs/docs/reference/docgen/javascript/nhost-js/content/nhost-functions-client/content/01-call.mdx

@@ -0,0 +1,25 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: call()
+sidebar_label: call()
+slug: /reference/javascript/nhost-js/functions/call
+description: No description provided.
+---
+
+# `call()`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">url</span>** <span className="optional-status">required</span> `string`
+
+---
+
+**<span className="parameter-name">data</span>** <span className="optional-status">required</span> `D`
+
+---
+
+**<span className="parameter-name">config</span>** <span className="optional-status">optional</span> `AxiosRequestConfig<any>`
+
+---

docs/docs/reference/docgen/javascript/nhost-js/content/nhost-functions-client/content/02-set-access-token.mdx

@@ -0,0 +1,17 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: setAccessToken()
+sidebar_label: setAccessToken()
+slug: /reference/javascript/nhost-js/functions/set-access-token
+description: No description provided.
+---
+
+# `setAccessToken()`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">accessToken</span>** <span className="optional-status">required</span> `undefined` | `string`
+
+---

docs/docs/reference/docgen/javascript/nhost-js/content/nhost-functions-client/index.mdx

@@ -0,0 +1,21 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: NhostFunctionsClient
+sidebar_label: Functions
+description: No description provided.
+slug: /reference/javascript/nhost-js/functions
+---
+
+# `NhostFunctionsClient`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">params</span>** <span className="optional-status">required</span> [`NhostFunctionsConstructorParams`](/reference/docgen/javascript/nhost-js/types/nhost-functions-constructor-params)
+
+| Property                                                                               | Type     | Required | Notes |
+| :------------------------------------------------------------------------------------- | :------- | :------: | :---- |
+| <span className="parameter-name"><span className="light-grey">params.</span>url</span> | `string` |    ✔️    |       |
+
+---

docs/docs/reference/docgen/javascript/nhost-js/content/nhost-graphql-client/content/01-request.mdx

@@ -0,0 +1,25 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: request()
+sidebar_label: request()
+slug: /reference/javascript/nhost-js/graphql/request
+description: No description provided.
+---
+
+# `request()`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">document</span>** <span className="optional-status">required</span> `string` | `DocumentNode`
+
+---
+
+**<span className="parameter-name">variables</span>** <span className="optional-status">optional</span> `V`
+
+---
+
+**<span className="parameter-name">config</span>** <span className="optional-status">optional</span> `AxiosRequestConfig<any>`
+
+---

docs/docs/reference/docgen/javascript/nhost-js/content/nhost-graphql-client/content/02-get-url.mdx

@@ -0,0 +1,9 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: getUrl()
+sidebar_label: getUrl()
+slug: /reference/javascript/nhost-js/graphql/get-url
+description: No description provided.
+---
+
+# `getUrl()`

docs/docs/reference/docgen/javascript/nhost-js/content/nhost-graphql-client/content/03-set-access-token.mdx

@@ -0,0 +1,17 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: setAccessToken()
+sidebar_label: setAccessToken()
+slug: /reference/javascript/nhost-js/graphql/set-access-token
+description: No description provided.
+---
+
+# `setAccessToken()`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">accessToken</span>** <span className="optional-status">required</span> `undefined` | `string`
+
+---

docs/docs/reference/docgen/javascript/nhost-js/content/nhost-graphql-client/index.mdx

@@ -0,0 +1,21 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: NhostGraphqlClient
+sidebar_label: GraphQL
+description: No description provided.
+slug: /reference/javascript/nhost-js/graphql
+---
+
+# `NhostGraphqlClient`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">params</span>** <span className="optional-status">required</span> [`NhostGraphqlConstructorParams`](/reference/docgen/javascript/nhost-js/types/nhost-graphql-constructor-params)
+
+| Property                                                                               | Type     | Required | Notes |
+| :------------------------------------------------------------------------------------- | :------- | :------: | :---- |
+| <span className="parameter-name"><span className="light-grey">params.</span>url</span> | `string` |    ✔️    |       |
+
+---

docs/docs/reference/docgen/javascript/nhost-js/types/_category_.json

@@ -0,0 +1,9 @@
+{
+  "label": "Types",
+  "position": 1,
+  "className": "hidden",
+  "link": {
+    "type": "generated-index",
+    "slug": "/reference/docgen/javascript/nhost-js/types"
+  }
+}

docs/docs/reference/docgen/javascript/nhost-js/types/nhost-client-constructor-params.mdx

@@ -0,0 +1,81 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: NhostClientConstructorParams
+sidebar_label: NhostClientConstructorParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `NhostClientConstructorParams`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">backendUrl</span>** <span className="optional-status">required</span> `string`
+
+Nhost backend URL.
+
+---
+
+**<span className="parameter-name">refreshIntervalTime</span>** <span className="optional-status">optional</span> `number`
+
+Time interval until token refreshes, in seconds
+
+---
+
+**<span className="parameter-name deprecated">clientStorage</span>** <span className="optional-status">optional</span> `ClientStorage`
+
+:::caution Deprecated
+Use clientStorageGetter and clientStorageSetter options instead
+:::
+
+---
+
+**<span className="parameter-name deprecated">clientStorageType</span>** <span className="optional-status">optional</span> `ClientStorageType`
+
+:::caution Deprecated
+Use clientStorageGetter and clientStorageSetter options instead
+:::
+
+---
+
+**<span className="parameter-name">clientStorageGetter</span>** <span className="optional-status">optional</span> `StorageGetter`
+
+Define a way to get information about the refresh token and its exipration date
+
+---
+
+**<span className="parameter-name">clientStorageSetter</span>** <span className="optional-status">optional</span> `StorageSetter`
+
+Define a way to set information about the refresh token and its exipration date
+
+---
+
+**<span className="parameter-name">autoRefreshToken</span>** <span className="optional-status">optional</span> `boolean`
+
+When set to true, will automatically refresh token before it expires
+
+---
+
+**<span className="parameter-name deprecated">autoLogin</span>** <span className="optional-status">optional</span> `boolean`
+
+:::caution Deprecated
+use autoSignIn instead
+:::
+
+---
+
+**<span className="parameter-name">autoSignIn</span>** <span className="optional-status">optional</span> `boolean`
+
+When set to true, will parse the url on startup to check if it contains a refresh token to start the session with
+
+---
+
+**<span className="parameter-name">start</span>** <span className="optional-status">optional</span> `boolean`
+
+---
+
+**<span className="parameter-name">Client</span>** <span className="optional-status">optional</span> `AuthClient`
+
+---

docs/docs/reference/docgen/javascript/nhost-js/types/nhost-functions-constructor-params.mdx

@@ -0,0 +1,17 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: NhostFunctionsConstructorParams
+sidebar_label: NhostFunctionsConstructorParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `NhostFunctionsConstructorParams`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">url</span>** <span className="optional-status">required</span> `string`
+
+---

docs/docs/reference/docgen/javascript/nhost-js/types/nhost-graphql-constructor-params.mdx

@@ -0,0 +1,17 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: NhostGraphqlConstructorParams
+sidebar_label: NhostGraphqlConstructorParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+---
+
+# `NhostGraphqlConstructorParams`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">url</span>** <span className="optional-status">required</span> `string`
+
+---

docs/docs/reference/docgen/javascript/storage/_category_.json

@@ -0,0 +1,3 @@
+{
+  "label": "Storage"
+}

docs/docs/reference/docgen/javascript/storage/content/hasura-storage-client/content/01-upload.mdx

@@ -0,0 +1,30 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: upload()
+sidebar_label: upload()
+slug: /reference/javascript/storage/upload
+description: Use `.upload` to upload a file.
+---
+
+# `upload()`
+
+Use `.upload` to upload a file.
+
+```ts
+storage.upload({ file })
+```
+
+## Parameters
+
+---
+
+**<span className="parameter-name">params</span>** <span className="optional-status">required</span> [`StorageUploadParams`](/reference/docgen/javascript/storage/types/storage-upload-params)
+
+| Property                                                                                    | Type     | Required | Notes |
+| :------------------------------------------------------------------------------------------ | :------- | :------: | :---- |
+| <span className="parameter-name"><span className="light-grey">params.</span>file</span>     | `File`   |    ✔️    |       |
+| <span className="parameter-name"><span className="light-grey">params.</span>bucketId</span> | `string` |          |       |
+| <span className="parameter-name"><span className="light-grey">params.</span>name</span>     | `string` |          |       |
+| <span className="parameter-name"><span className="light-grey">params.</span>id</span>       | `string` |          |       |
+
+---

docs/docs/reference/docgen/javascript/storage/content/hasura-storage-client/content/02-get-url.mdx

@@ -0,0 +1,26 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: getUrl()
+sidebar_label: getUrl()
+slug: /reference/javascript/storage/get-url
+sidebar_class_name: deprecated
+description: No description provided.
+---
+
+# `getUrl()`
+
+:::caution Deprecated
+use `.getPublicUrl` instead
+:::
+
+## Parameters
+
+---
+
+**<span className="parameter-name">params</span>** <span className="optional-status">required</span> [`StorageGetUrlParams`](/reference/docgen/javascript/storage/types/storage-get-url-params)
+
+| Property                                                                                  | Type     | Required | Notes |
+| :---------------------------------------------------------------------------------------- | :------- | :------: | :---- |
+| <span className="parameter-name"><span className="light-grey">params.</span>fileId</span> | `string` |    ✔️    |       |
+
+---