Merge pull request #491 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"
+  ]
+}

CONTRIBUTING.md

@@ -24,6 +24,8 @@ If you find an Issue that addresses the problem you're having, please add your r
 
 ### Pull Requests
 
+Please have a look at our [developers guide](https://github.com/nhost/nhost/blob/main/DEVELOPERS.md) to start coding!
+
 PRs to our libraries are always welcome and can be a quick way to get your fix or improvement slated for the next release. In general, PRs should:
 
 - Only fix/add the functionality in question **OR** address wide-spread whitespace/style issues, not both.

DEVELOPERS.md

@@ -0,0 +1,79 @@
+# Developer guide
+
+## Requirements
+
+- We use [pnpm](https://pnpm.io/) as a package manager to fasten development and builds, and as a backbone to our monorepo. You have to make sure it is installed in your machine. There are [multiple ways to install it](https://pnpm.io/installation), but the easiest way is with `npm`:
+
+```sh
+npm install -g pnpm
+```
+
+- Our tests and examples are using the Nhost CLI to run the backend services locally. You can follow the instructions to install it in [our documentation](https://docs.nhost.io/get-started/cli-workflow/install-cli)
+
+## Getting things ready
+
+First, clone this repository:
+
+```sh
+git clone https://github.com/nhost/nhost
+```
+
+Then, install the dependencies with `pnpm`:
+
+```sh
+cd nhost
+pnpm install
+```
+
+## Starting development from an example
+
+Let's follow the instructions to start [react-apollo example](https://github.com/nhost/nhost/blob/main/examples/react-apollo/README.md).
+
+## Running the documentation website locally
+
+The easier way to contribute to our documentation is to move to the `docs` folder and follow the [instructions to start local development](https://github.com/nhost/nhost/blob/main/docs/README.md):
+
+```sh
+cd docs
+# not necessary step if you've done this step already anywhere in the repository
+pnpm install
+pnpm start
+```
+
+## Testing
+
+In order to run tests, the Nhost testing backend should run locally. You can start it in from a separate terminal:
+
+```sh
+cd examples/testing-project
+nhost -d
+```
+
+Once Nhost started locally, you can run the tests from the root folder of the repository with the following command:
+
+```sh
+pnpm test
+```
+
+## Changesets
+
+If you made some changes in the packages, you will have to describe these changes so they will be taken into account in the next release.
+We are using [changesets](https://github.com/changesets/changesets) to support our version/publish workflows. When submitting a pull request, a bot will check if some changesets are present, and if not, will guide you to add them.
+
+The most comprehensive way to add a changeset is to run the following command from the root directory of the repository:
+
+```sh
+pnpm changeset
+```
+
+This will generate a file in the `.changeset` directory. You can edit it to give further details about the change you just made.
+You can have a look at the changesets documentation on [how to add a changeset](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md)
+
+## Commiting changes
+
+You may notice `git commit` takes a few seconds to run. We set a commit hook that scan the changes in the code, automatically generates the documentation from the inline [TSDoc](https://tsdoc.org/) annotations, and add these generated documentation files to the commit. They will automatically update the [reference documentation](https://docs.nhost.io/reference).
+
+<!-- ## Good practices
+- lint
+- prettier
+- documentation -->

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)
@@ -120,7 +120,7 @@ Here are some ways of contributing to making Nhost better:
 
 - **[Try out Nhost](https://docs.nhost.io/get-started/quick-start)**, and think of ways to make the service better. Let us know here on GitHub.
 - Join our [Discord](https://discord.com/invite/9V7Qb2U) and connect with other members to share and learn from.
-- Send a pull request to any of our [open source repositories](https://github.com/nhost) on Github. Check our [contribution guide](https://github.com/nhost/nhost/blob/main/CONTRIBUTING.md) for more details about how to contribute. We're looking forward to your contribution!
+- Send a pull request to any of our [open source repositories](https://github.com/nhost) on Github. Check our [contribution guide](https://github.com/nhost/nhost/blob/main/CONTRIBUTING.md) and our [developers guide](https://github.com/nhost/nhost/blob/main/DEVELOPERS.md) for more details about how to contribute. We're looking forward to your contribution!
 
 ### Contributors
 
@@ -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"/>
@@ -220,6 +227,13 @@ Here are some ways of contributing to making Nhost better:
             <sub><b>Filip Hájek</b></sub>
         </a>
     </td>
+    <td align="center">
+        <a href="https://github.com/GavanWilhite">
+            <img src="https://avatars.githubusercontent.com/u/2085119?v=4" width="100;" alt="GavanWilhite"/>
+            <br />
+            <sub><b>Gavan Wilhite</b></sub>
+        </a>
+    </td>
     <td align="center">
         <a href="https://github.com/jerryjappinen">
             <img src="https://avatars.githubusercontent.com/u/1101002?v=4" width="100;" alt="jerryjappinen"/>
@@ -234,6 +248,14 @@ 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></tr>
+<tr>
     <td align="center">
         <a href="https://github.com/Savinvadim1312">
             <img src="https://avatars.githubusercontent.com/u/16936043?v=4" width="100;" alt="Savinvadim1312"/>
@@ -254,8 +276,14 @@ 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/heygambo">
+            <img src="https://avatars.githubusercontent.com/u/449438?v=4" width="100;" alt="heygambo"/>
+            <br />
+            <sub><b>Christian Gambardella</b></sub>
+        </a>
+    </td>
     <td align="center">
         <a href="https://github.com/rustyb">
             <img src="https://avatars.githubusercontent.com/u/53086?v=4" width="100;" alt="rustyb"/>
@@ -269,14 +297,8 @@ Here are some ways of contributing to making Nhost better:
             <br />
             <sub><b>Dominic Garms</b></sub>
         </a>
-    </td>
-    <td align="center">
-        <a href="https://github.com/GavanWilhite">
-            <img src="https://avatars.githubusercontent.com/u/2085119?v=4" width="100;" alt="GavanWilhite"/>
-            <br />
-            <sub><b>Gavan Wilhite</b></sub>
-        </a>
-    </td>
+    </td></tr>
+<tr>
     <td align="center">
         <a href="https://github.com/alveshelio">
             <img src="https://avatars.githubusercontent.com/u/8176422?v=4" width="100;" alt="alveshelio"/>
@@ -291,20 +313,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/authentication/index.md

@@ -3,7 +3,7 @@ title: 'Authenticate users'
 slug: /get-started/authentication
 ---
 
-You defined `select` permissions for the `public` role in the previous section. You will now add `insert` and `create` permissions for authenticated users to secure your app's GraphQL API with authentication.
+In the previous section, you defined `select` permissions for the `public` role. You will now add `insert` and `select` permissions for authenticated users to secure your app's GraphQL API with authentication.
 
 > Nhost's authentication service lets you deliver frictionless registration and login experiences to your users. We support most social providers and different methods such as email & password and passwordless (magic link).
 
@@ -13,13 +13,15 @@ You defined `select` permissions for the `public` role in the previous section.
 
 Manually create a user by going to your app's **Users** tab (top menu) and clicking on **Add User**.
 
-![Add user](/img/quick-start/add-user.gif)
+<video width="99%" loop="" muted="" playsInline="" controls="true">
+  <source src="/videos/add-user.mp4" type="video/mp4" />
+</video>
 
-You will now use that newly created user to make authenticated requests to the API.
+You will now use that newly created user. We'll use this newly created user to make authenticated requests to the GraphQL API.
 
 ---
 
-## Authenticate and query data
+## Sign in and query data
 
 Add the following code to sign in the new user and request the list of todos again:
 
@@ -60,9 +62,41 @@ Why is the return value `null`? Because when making GraphQL requests as an authe
 
 > For authenticated requests, there is always the option to override the default `user` role with any other valid role.
 
----
+To prepare our database and GraphQL API to work for signed-in users we need to do two things:
 
-## Permissions for users
+1. Add a `user_id` column to the `todos` table, so we know what todo belongs to which user.
+2. Use the `user` role instead of the `public` role for permissions.
+
+## Add `user_id` column
+
+Before adding the `user_id` column, let's delete all existing todos.
+
+Then add the `user_id` column as a `UUID` type. Make sure that `nullable` is **not** checked. This will ensure that all todos must have a `user_id` value.
+
+At last, we'll create a connection between the `todos` table and the `users` table. For that, we need to do yet another two things:
+
+1. Create a Foreign Key (FK) between `todos` and `auth.users.id`.
+2. Let Hasura track the relationship between the two tables.
+
+<video width="99%" loop="" muted="" playsInline="" controls="true">
+  <source src="/videos/user-id-column.mp4" type="video/mp4" />
+</video>
+
+### Create FK
+
+Create a FK between the `auth.users.id` column and the `public.todos.user_id` column. See video above.
+
+### Track relationship
+
+Click on the `public` schema and track the untracked foreign key relationship. Then click on the `auth` schema and track the relationship again. See video above.
+
+We track these relationships to create the GrpahQL relationships between the `todos` table to the `users` table and the `users` table to the `todos` table.
+
+Ok, our `user_id` column is added and connected correctly. Let's continue with setting permissions for signed-in users.
+
+## Permissions for signed-in users
+
+Let us organize the permissions so it works for signed in users too.
 
 ### Remove permissions for the public role
 
@@ -72,7 +106,7 @@ We won't use the `public` role anymore, so let's remove all permission for that
 
 Now we'll add permissions for the `user` role.
 
-> All logged-in users have the `user` role.
+> Signed-in users use the `user` role by default
 
 ### Insert permission
 

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

@@ -30,7 +30,7 @@ Create a new folder called `nhost-todos`, initialize a new JavaScript app there,
 
 ```bash
 npm init -y
-yarn add @nhost/nhost-js graphql
+npm install @nhost/nhost-js graphql
 ```
 
   </TabItem>
@@ -38,7 +38,7 @@ yarn add @nhost/nhost-js graphql
 
 ```bash
 yarn init -y
-npm install @nhost/nhost-js graphql
+yarn add @nhost/nhost-js graphql
 ```
 
   </TabItem>

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/get-started/quick-start/schema.md

@@ -65,7 +65,9 @@ This is all we need! A new table will be created when you click **Add Table**.
 
 Go to the **Insert Row** tab to add some data to your database.
 
-![Inserting todos](/img/quick-start/insert-todos.gif)
+<video width="99%" loop="" muted="" playsInline="" controls="true">
+  <source src="/videos/insert-todos.mp4" type="video/mp4" />
+</video>
 
 ---
 

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/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,30 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L106
+---
+
+# `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,54 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L166
+---
+
+# `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,24 @@
+---
+# ⚠️ 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
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L315
+---
+
+# `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,29 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L342
+---
+
+# `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,28 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L367
+---
+
+# `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,30 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L393
+---
+
+# `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,29 @@
+---
+# ⚠️ 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
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L420
+---
+
+# `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,33 @@
+---
+# ⚠️ 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
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L445
+---
+
+# `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,25 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L479
+---
+
+# `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,30 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L516
+---
+
+# `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,20 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L556
+---
+
+# `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,20 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L574
+---
+
+# `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,24 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L601
+---
+
+# `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,15 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L615
+---
+
+# `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,16 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L629
+---
+
+# `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,16 @@
+---
+# ⚠️ 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)
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L637
+---
+
+# `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,16 @@
+---
+# ⚠️ 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)
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L647
+---
+
+# `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,27 @@
+---
+# ⚠️ 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)
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L657
+---
+
+# `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,26 @@
+---
+# ⚠️ 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`.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L676
+---
+
+# `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,16 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L719
+---
+
+# `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,16 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L734
+---
+
+# `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
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L64
+---
+
+# `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 deprecated"><span className="light-grey">\_\_namedParameters.</span>autoLogin</span> <span className="deprecation-sign" title="@alias autoSignIn - use autoSignIn instead">⚠️</span>              | `boolean`                                                                 |          |                                                                                                                   |
+| <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"><span className="light-grey">\_\_namedParameters.</span>autoRefreshToken</span>                                                                                                                  | `boolean`                                                                 |          | When set to true, will automatically refresh token before it expires                                              |
+| <span className="parameter-name deprecated"><span className="light-grey">\_\_namedParameters.</span>clientStorageSetter</span> <span className="deprecation-sign" title="Use clientStorage / clientStorageType instead">⚠️</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 deprecated"><span className="light-grey">\_\_namedParameters.</span>clientStorageGetter</span> <span className="deprecation-sign" title="Use clientStorage / clientStorageType instead">⚠️</span> | [`StorageGetter`](/reference/docgen/javascript/auth/types/storage-getter) |          |                                                                                                                   |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>clientStorage</span>                                                                                                                     | `ClientStorage`                                                           |          | Object where the refresh token will be persisted and read locally.                                                |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>clientStorageType</span>                                                                                                                 | `ClientStorageType`                                                       |          | Define a way to get information about the refresh token and its exipration date.                                  |
+| <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,18 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiChangeEmailResponse
+sidebar_label: ApiChangeEmailResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L170
+---
+
+# `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,18 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiChangePasswordResponse
+sidebar_label: ApiChangePasswordResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L162
+---
+
+# `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,18 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiDeanonymizeResponse
+sidebar_label: ApiDeanonymizeResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L174
+---
+
+# `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,22 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiError
+sidebar_label: ApiError
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L27
+---
+
+# `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,16 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiRefreshTokenResponse
+sidebar_label: ApiRefreshTokenResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L150
+---
+
+# `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,18 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiResetPasswordResponse
+sidebar_label: ApiResetPasswordResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L158
+---
+
+# `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,18 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiSendVerificationEmailResponse
+sidebar_label: ApiSendVerificationEmailResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L166
+---
+
+# `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,29 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiSignInData
+sidebar_label: ApiSignInData
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L139
+---
+
+# `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,16 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiSignInResponse
+sidebar_label: ApiSignInResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L143
+---
+
+# `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,18 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiSignOutResponse
+sidebar_label: ApiSignOutResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L154
+---
+
+# `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,16 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ApiSignUpEmailPasswordResponse
+sidebar_label: ApiSignUpEmailPasswordResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L135
+---
+
+# `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,14 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: AuthChangeEvent
+sidebar_label: AuthChangeEvent
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L117
+---
+
+# `AuthChangeEvent`
+
+```ts
+type AuthChangeEvent = 'SIGNED_IN' | 'SIGNED_OUT'
+```

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

@@ -0,0 +1,17 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: AuthChangedFunction
+sidebar_label: AuthChangedFunction
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L119
+---
+
+# `AuthChangedFunction`
+
+```ts
+type AuthChangedFunction = () => (
+  event: AuthChangeEvent,
+  session: Session | null
+) => void
+```

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

@@ -0,0 +1,22 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ChangeEmailParams
+sidebar_label: ChangeEmailParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L91
+---
+
+# `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,18 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ChangePasswordParams
+sidebar_label: ChangePasswordParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L82
+---
+
+# `ChangePasswordParams`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">newPassword</span>** <span className="optional-status">required</span> `string`
+
+---

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

@@ -0,0 +1,38 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: DeanonymizeParams
+sidebar_label: DeanonymizeParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L97
+---
+
+# `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,18 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: Headers
+sidebar_label: Headers
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L128
+---
+
+# `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,22 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: LoginData
+sidebar_label: LoginData
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L123
+---
+
+# `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,18 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: Mfa
+sidebar_label: Mfa
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L131
+---
+
+# `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,82 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: NhostAuthConstructorParams
+sidebar_label: NhostAuthConstructorParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L14
+---
+
+# `NhostAuthConstructorParams`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">url</span>** <span className="optional-status">required</span> `string`
+
+---
+
+**<span className="parameter-name deprecated">autoLogin</span>** <span className="optional-status">optional</span> `boolean`
+
+:::caution Deprecated
+@alias autoSignIn - use autoSignIn instead
+:::
+
+---
+
+**<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">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">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.
+
+:::caution Deprecated
+Use clientStorage / clientStorageType instead
+:::
+
+---
+
+**<span className="parameter-name deprecated">clientStorageGetter</span>** <span className="optional-status">optional</span> [`StorageGetter`](/reference/docgen/javascript/auth/types/storage-getter)
+
+:::caution Deprecated
+Use clientStorage / clientStorageType instead
+:::
+
+---
+
+**<span className="parameter-name">clientStorage</span>** <span className="optional-status">optional</span> `ClientStorage`
+
+Object where the refresh token will be persisted and read locally.
+
+---
+
+**<span className="parameter-name">clientStorageType</span>** <span className="optional-status">optional</span> `ClientStorageType`
+
+Define a way to get information about the refresh token and its exipration date.
+
+**`@default`**
+
+`web`
+
+---
+
+**<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,14 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: OnTokenChangedFunction
+sidebar_label: OnTokenChangedFunction
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L121
+---
+
+# `OnTokenChangedFunction`
+
+```ts
+type OnTokenChangedFunction = () => (session: Session | null) => void
+```

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

@@ -0,0 +1,25 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: Provider
+sidebar_label: Provider
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/core/src/types.ts#L138
+---
+
+# `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,22 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: ResetPasswordParams
+sidebar_label: ResetPasswordParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L77
+---
+
+# `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,22 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SendVerificationEmailParams
+sidebar_label: SendVerificationEmailParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L86
+---
+
+# `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,30 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: Session
+sidebar_label: Session
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L21
+---
+
+# `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,22 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignInEmailPasswordParams
+sidebar_label: SignInEmailPasswordParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L46
+---
+
+# `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,19 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignInParams
+sidebar_label: SignInParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L70
+---
+
+# `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,22 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignInPasswordlessEmailParams
+sidebar_label: SignInPasswordlessEmailParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L51
+---
+
+# `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,22 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignInPasswordlessSmsOtpParams
+sidebar_label: SignInPasswordlessSmsOtpParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L61
+---
+
+# `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,22 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignInPasswordlessSmsParams
+sidebar_label: SignInPasswordlessSmsParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L56
+---
+
+# `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,34 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignInReponse
+sidebar_label: SignInReponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L106
+---
+
+# `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,22 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignInWithProviderOptions
+sidebar_label: SignInWithProviderOptions
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L65
+---
+
+# `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,26 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignUpEmailPasswordParams
+sidebar_label: SignUpEmailPasswordParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L33
+---
+
+# `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,10 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignUpParams
+sidebar_label: SignUpParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L39
+---
+
+# `SignUpParams`

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

@@ -0,0 +1,16 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignUpResponse
+sidebar_label: SignUpResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L41
+---
+
+# `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,16 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: StorageGetter
+sidebar_label: StorageGetter
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/core/src/storage.ts#L4
+---
+
+# `StorageGetter`
+
+```ts
+type StorageGetter = () => (
+  key: string
+) => string | null | Promise<string | null>
+```

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

@@ -0,0 +1,17 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: StorageSetter
+sidebar_label: StorageSetter
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/core/src/storage.ts#L5
+---
+
+# `StorageSetter`
+
+```ts
+type StorageSetter = () => (
+  key: string,
+  value: string | null
+) => void | Promise<void>
+```

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

@@ -0,0 +1,94 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: User
+sidebar_label: User
+description: User information
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/core/src/types.ts#L91
+---
+
+# `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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/index.ts#L3
+---
+
+# `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"><span className="light-grey">config.</span>clientStorageType</span>                                                                                                                 | `ClientStorageType` |          | Define a way to get information about the refresh token and its exipration date.                                  |
+| <span className="parameter-name"><span className="light-grey">config.</span>clientStorage</span>                                                                                                                     | `ClientStorage`     |          | Object where the refresh token will be persisted and read locally.                                                |
+| <span className="parameter-name deprecated"><span className="light-grey">config.</span>clientStorageGetter</span> <span className="deprecation-sign" title="Use clientStorage / clientStorageType instead">⚠️</span> | `StorageGetter`     |          |                                                                                                                   |
+| <span className="parameter-name deprecated"><span className="light-grey">config.</span>clientStorageSetter</span> <span className="deprecation-sign" title="Use clientStorage / clientStorageType instead">⚠️</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"><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 deprecated"><span className="light-grey">config.</span>autoLogin</span> <span className="deprecation-sign" title="@alias autoSignIn - use autoSignIn instead">⚠️</span>              | `boolean`           |          |                                                                                                                   |
+
+---

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
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/core/nhost-client.ts#L14
+---
+
+# `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 deprecated"><span className="light-grey">\_\_namedParameters.</span>autoLogin</span> <span className="deprecation-sign" title="@alias autoSignIn - use autoSignIn instead">⚠️</span>              | `boolean`           |          |                                                                                                                   |
+| <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"><span className="light-grey">\_\_namedParameters.</span>autoRefreshToken</span>                                                                                                                  | `boolean`           |          | When set to true, will automatically refresh token before it expires                                              |
+| <span className="parameter-name deprecated"><span className="light-grey">\_\_namedParameters.</span>clientStorageSetter</span> <span className="deprecation-sign" title="Use clientStorage / clientStorageType instead">⚠️</span> | `StorageSetter`     |          | Define a way to set information about the refresh token and its exipration date.                                  |
+| <span className="parameter-name deprecated"><span className="light-grey">\_\_namedParameters.</span>clientStorageGetter</span> <span className="deprecation-sign" title="Use clientStorage / clientStorageType instead">⚠️</span> | `StorageGetter`     |          |                                                                                                                   |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>clientStorage</span>                                                                                                                     | `ClientStorage`     |          | Object where the refresh token will be persisted and read locally.                                                |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>clientStorageType</span>                                                                                                                 | `ClientStorageType` |          | Define a way to get information about the refresh token and its exipration date.                                  |
+| <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,26 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/clients/functions.ts#L24
+---
+
+# `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,18 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/clients/functions.ts#L53
+---
+
+# `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,22 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: NhostFunctionsClient
+sidebar_label: Functions
+description: No description provided.
+slug: /reference/javascript/nhost-js/functions
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/clients/functions.ts#L11
+---
+
+# `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,26 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/clients/graphql.ts#L29
+---
+
+# `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,10 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/clients/graphql.ts#L82
+---
+
+# `getUrl()`

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

@@ -0,0 +1,18 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/clients/graphql.ts#L86
+---
+
+# `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,22 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: NhostGraphqlClient
+sidebar_label: GraphQL
+description: No description provided.
+slug: /reference/javascript/nhost-js/graphql
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/clients/graphql.ts#L14
+---
+
+# `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,84 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: NhostClientConstructorParams
+sidebar_label: NhostClientConstructorParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/core/nhost-client.ts#L7
+---
+
+# `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">clientStorageType</span>** <span className="optional-status">optional</span> `ClientStorageType`
+
+Define a way to get information about the refresh token and its exipration date.
+
+**`@default`**
+
+`web`
+
+---
+
+**<span className="parameter-name">clientStorage</span>** <span className="optional-status">optional</span> `ClientStorage`
+
+Object where the refresh token will be persisted and read locally.
+
+---
+
+**<span className="parameter-name deprecated">clientStorageGetter</span>** <span className="optional-status">optional</span> `StorageGetter`
+
+:::caution Deprecated
+Use clientStorage / clientStorageType instead
+:::
+
+---
+
+**<span className="parameter-name deprecated">clientStorageSetter</span>** <span className="optional-status">optional</span> `StorageSetter`
+
+Define a way to set information about the refresh token and its exipration date.
+
+:::caution Deprecated
+Use clientStorage / clientStorageType 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">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 deprecated">autoLogin</span>** <span className="optional-status">optional</span> `boolean`
+
+:::caution Deprecated
+@alias autoSignIn - use autoSignIn instead
+:::
+
+---

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

@@ -0,0 +1,18 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: NhostFunctionsConstructorParams
+sidebar_label: NhostFunctionsConstructorParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/clients/functions.ts#L4
+---
+
+# `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,18 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: NhostGraphqlConstructorParams
+sidebar_label: NhostGraphqlConstructorParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/clients/graphql.ts#L7
+---
+
+# `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,31 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-client.ts#L32
+---
+
+# `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,27 @@
+---
+# ⚠️ 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.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-client.ts#L54
+---
+
+# `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` |    ✔️    |       |
+
+---