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

chore: update versions

.github/workflows/tests.yaml

@@ -67,12 +67,18 @@ jobs:
       # * Run the `ci` script of the current package of the matrix. Dependencies build is cached by Turborepo
       - name: Run e2e test
         run: pnpm run e2e -- --filter="${{ matrix.package.name }}"
+      - id: file-name
+        if: ${{ failure() }}
+        name: Tranform package name into a valid file name
+        run: |
+          PACKAGE_FILE_NAME=$(echo "${{ matrix.package.name }}" | sed 's/@//g; s/\//-/g')
+          echo "::set-output name=fileName::$PACKAGE_FILE_NAME"
       # * Run this step only if the previous step failed, and some Cypress screenshots/videos exist
       - name: Upload Cypress videos and screenshots
         if: ${{ failure() && hashFiles(format('{0}/cypress/screenshots/**', matrix.package.path), format('{0}/cypress/videos/**', matrix.package.path)) != ''}}
         uses: actions/upload-artifact@v3
         with:
-          name: cypress-${{ matrix.package.name }}
+          name: cypress-${{ steps.file-name.outputs.fileName }}
           path: |
             ${{format('{0}/cypress/screenshots/**', matrix.package.path)}}
             ${{format('{0}/cypress/videos/**', matrix.package.path)}}

.husky/pre-commit

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

.lintstagedrc.json

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

README.md

@@ -12,7 +12,7 @@
 <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
 <a href="https://nhost.io/blog">Blog</a>
 <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-<a href="https://twitter.com/nhostio">Twitter</a>
+<a href="https://twitter.com/nhost">Twitter</a>
 <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
 <a href="https://nhost.io/discord">Discord</a>
 <br />
@@ -32,7 +32,7 @@ Nhost consists of open source software:
 - Database: [PostgreSQL](https://www.postgresql.org/)
 - Instant GraphQL API: [Hasura](https://hasura.io/)
 - Authentication: [Hasura Auth](https://github.com/nhost/hasura-auth/)
-- Storage: [Hasura Storage](https://hub.docker.com/r/nhost/hasura-storage)
+- Storage: [Hasura Storage](https://github.com/nhost/hasura-storage)
 - Serverless Functions: Node.js (JavaScript and TypeScript)
 - [Nhost CLI](https://docs.nhost.io/reference/cli) for local development
 
@@ -67,7 +67,8 @@ Install the `@nhost/nhost-js` package and start build your app:
 import { NhostClient } from '@nhost/nhost-js'
 
 const nhost = new NhostClient({
-  backendUrl: 'https://awesome-app.nhost.run'
+  subdomain: '<your-subdomain>',
+  region: '<your-region>'
 })
 
 await nhost.auth.signIn({ email: 'elon@musk.com', password: 'spaceX' })
@@ -115,6 +116,10 @@ Also, follow Nhost on [GitHub Discussions](https://github.com/nhost/nhost/discus
 
 This repository, and most of our other open source projects, are licensed under the MIT license.
 
+<a href="https://runacap.com/ross-index/q1-2022/" target="_blank" rel="noopener">
+    <img style="width: 260px; height: 56px" src="https://runacap.com/wp-content/uploads/2022/06/ROSS_badge_black_Q1_2022.svg" alt="ROSS Index - Fastest Growing Open-Source Startups in Q1 2022 | Runa Capital" width="260" height="56" />
+</a>
+
 ### How to contribute
 
 Here are some ways of contributing to making Nhost better:
@@ -142,13 +147,6 @@ Here are some ways of contributing to making Nhost better:
             <sub><b>Johan Eliasson</b></sub>
         </a>
     </td>
-    <td align="center">
-        <a href="https://github.com/szilarddoro">
-            <img src="https://avatars.githubusercontent.com/u/310881?v=4" width="100;" alt="szilarddoro"/>
-            <br />
-            <sub><b>Szilárd Dóró</b></sub>
-        </a>
-    </td>
     <td align="center">
         <a href="https://github.com/gdangelo">
             <img src="https://avatars.githubusercontent.com/u/4352286?v=4" width="100;" alt="gdangelo"/>
@@ -163,6 +161,13 @@ Here are some ways of contributing to making Nhost better:
             <sub><b>Nuno Pato</b></sub>
         </a>
     </td>
+    <td align="center">
+        <a href="https://github.com/guicurcio">
+            <img src="https://avatars.githubusercontent.com/u/20285232?v=4" width="100;" alt="guicurcio"/>
+            <br />
+            <sub><b>Guido Curcio</b></sub>
+        </a>
+    </td>
     <td align="center">
         <a href="https://github.com/subatuba21">
             <img src="https://avatars.githubusercontent.com/u/34824571?v=4" width="100;" alt="subatuba21"/>
@@ -171,13 +176,6 @@ Here are some ways of contributing to making Nhost better:
         </a>
     </td></tr>
 <tr>
-    <td align="center">
-        <a href="https://github.com/guicurcio">
-            <img src="https://avatars.githubusercontent.com/u/20285232?v=4" width="100;" alt="guicurcio"/>
-            <br />
-            <sub><b>Guido Curcio</b></sub>
-        </a>
-    </td>
     <td align="center">
         <a href="https://github.com/sebagudelo">
             <img src="https://avatars.githubusercontent.com/u/43288271?v=4" width="100;" alt="sebagudelo"/>
@@ -199,21 +197,35 @@ Here are some ways of contributing to making Nhost better:
             <sub><b>Pratim</b></sub>
         </a>
     </td>
+    <td align="center">
+        <a href="https://github.com/szilarddoro">
+            <img src="https://avatars.githubusercontent.com/u/310881?v=4" width="100;" alt="szilarddoro"/>
+            <br />
+            <sub><b>Szilárd Dóró</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/FuzzyReason">
             <img src="https://avatars.githubusercontent.com/u/62517920?v=4" width="100;" alt="FuzzyReason"/>
             <br />
             <sub><b>Vadim Smirnov</b></sub>
         </a>
-    </td>
+    </td></tr>
+<tr>
     <td align="center">
         <a href="https://github.com/macmac49">
             <img src="https://avatars.githubusercontent.com/u/831190?v=4" width="100;" alt="macmac49"/>
             <br />
             <sub><b>Macmac49</b></sub>
         </a>
-    </td></tr>
-<tr>
+    </td>
     <td align="center">
         <a href="https://github.com/subhendukundu">
             <img src="https://avatars.githubusercontent.com/u/20059141?v=4" width="100;" alt="subhendukundu"/>
@@ -248,15 +260,15 @@ Here are some ways of contributing to making Nhost better:
             <br />
             <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></tr>
 <tr>
+    <td align="center">
+        <a href="https://github.com/MelodicCrypter">
+            <img src="https://avatars.githubusercontent.com/u/18341500?v=4" width="100;" alt="MelodicCrypter"/>
+            <br />
+            <sub><b>Hugh Caluscusin</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"/>
@@ -285,6 +297,14 @@ Here are some ways of contributing to making Nhost better:
             <sub><b>Savin Vadim</b></sub>
         </a>
     </td>
+    <td align="center">
+        <a href="https://github.com/muttenzer">
+            <img src="https://avatars.githubusercontent.com/u/49474412?v=4" width="100;" alt="muttenzer"/>
+            <br />
+            <sub><b>Muttenzer</b></sub>
+        </a>
+    </td></tr>
+<tr>
     <td align="center">
         <a href="https://github.com/ahmic">
             <img src="https://avatars.githubusercontent.com/u/13452362?v=4" width="100;" alt="ahmic"/>
@@ -298,8 +318,7 @@ Here are some ways of contributing to making Nhost better:
             <br />
             <sub><b>Anders Kjær Damgaard</b></sub>
         </a>
-    </td></tr>
-<tr>
+    </td>
     <td align="center">
         <a href="https://github.com/Sonichigo">
             <img src="https://avatars.githubusercontent.com/u/53110238?v=4" width="100;" alt="Sonichigo"/>
@@ -327,7 +346,8 @@ Here are some ways of contributing to making Nhost better:
             <br />
             <sub><b>Gaurav Agrawal</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"/>
@@ -341,14 +361,6 @@ Here are some ways of contributing to making Nhost better:
             <br />
             <sub><b>Hoang Do</b></sub>
         </a>
-    </td></tr>
-<tr>
-    <td align="center">
-        <a href="https://github.com/MelodicCrypter">
-            <img src="https://avatars.githubusercontent.com/u/18341500?v=4" width="100;" alt="MelodicCrypter"/>
-            <br />
-            <sub><b>Hugh Caluscusin</b></sub>
-        </a>
     </td>
     <td align="center">
         <a href="https://github.com/jladuval">
@@ -357,6 +369,13 @@ Here are some ways of contributing to making Nhost better:
             <sub><b>Jacob Duval</b></sub>
         </a>
     </td>
+    <td align="center">
+        <a href="https://github.com/kylehayes">
+            <img src="https://avatars.githubusercontent.com/u/509932?v=4" width="100;" alt="kylehayes"/>
+            <br />
+            <sub><b>Kyle Hayes</b></sub>
+        </a>
+    </td>
     <td align="center">
         <a href="https://github.com/leothorp">
             <img src="https://avatars.githubusercontent.com/u/12928449?v=4" width="100;" alt="leothorp"/>
@@ -370,6 +389,14 @@ Here are some ways of contributing to making Nhost better:
             <br />
             <sub><b>Max Reynolds</b></sub>
         </a>
+    </td></tr>
+<tr>
+    <td align="center">
+        <a href="https://github.com/nachoaldamav">
+            <img src="https://avatars.githubusercontent.com/u/22749943?v=4" width="100;" alt="nachoaldamav"/>
+            <br />
+            <sub><b>Nacho Aldama</b></sub>
+        </a>
     </td>
     <td align="center">
         <a href="https://github.com/ghoshnirmalya">
@@ -384,8 +411,7 @@ Here are some ways of contributing to making Nhost better:
             <br />
             <sub><b>Quentin Decré</b></sub>
         </a>
-    </td></tr>
-<tr>
+    </td>
     <td align="center">
         <a href="https://github.com/atapas">
             <img src="https://avatars.githubusercontent.com/u/3633137?v=4" width="100;" alt="atapas"/>
@@ -393,6 +419,13 @@ Here are some ways of contributing to making Nhost better:
             <sub><b>Tapas Adhikary</b></sub>
         </a>
     </td>
+    <td align="center">
+        <a href="https://github.com/uulwake">
+            <img src="https://avatars.githubusercontent.com/u/22399181?v=4" width="100;" alt="uulwake"/>
+            <br />
+            <sub><b>Ulrich Wake</b></sub>
+        </a>
+    </td>
     <td align="center">
         <a href="https://github.com/komninoschat">
             <img src="https://avatars.githubusercontent.com/u/29049104?v=4" width="100;" alt="komninoschat"/>

config/.eslint.base.js

@@ -20,7 +20,8 @@ module.exports = {
     'tests/**/*.ts',
     'tests/**/*.d.ts'
   ],
-  plugins: ['@typescript-eslint', 'simple-import-sort'],
+  plugins: ['@typescript-eslint', 'simple-import-sort', 'cypress'],
+  extends: ['plugin:cypress/recommended'],
   parserOptions: {
     ecmaVersion: 2020,
     sourceType: 'module'
@@ -60,13 +61,5 @@ module.exports = {
         allowAnonymousFunction: true
       }
     ]
-  },
-  overrides: [
-    {
-      files: ['*.test.js', '*.spec.js', '*.test.ts', '*.spec.ts', '*.cy.js', '*.cy.ts'],
-      rules: {
-        '@typescript-eslint/no-unused-expressions': 'off'
-      }
-    }
-  ]
+  }
 }

config/.eslintrc.js

@@ -1,6 +1,12 @@
 const base = require('./.eslint.base')
 module.exports = {
   ...base,
-  extends: ['react-app', 'plugin:react/recommended', 'plugin:react-hooks/recommended'],
+  extends: [
+    ...base.extends,
+    'react-app',
+    'plugin:react/recommended',
+    'plugin:react-hooks/recommended',
+    'plugin:react/jsx-runtime'
+  ],
   plugins: [...base.plugins, 'react', 'react-hooks']
 }

config/.eslintrc.vue.js

@@ -1,7 +1,7 @@
 const base = require('./.eslint.base')
 module.exports = {
   ...base,
-  extends: ['plugin:import/recommended', 'plugin:import/typescript'],
+  extends: [...base.extends, 'plugin:import/recommended', 'plugin:import/typescript'],
   parser: 'vue-eslint-parser',
   parserOptions: {
     ...base.parserOptions,

config/.husky/pre-commit

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

config/.lintstagedrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+  'packages/(docgen|hasura-auth-js|hasura-storage-js|nextjs|nhost-js|react|core|vue)/src/**/*.{js,ts,jsx,tsx}':
+    ['pnpm docgen', 'git add docs'],
+  '(nhost-cloud.yaml|**/nhost/config.yaml)': () => [
+    'pnpm sync-versions',
+    "git add ':(glob)**/nhost/config.yaml'"
+  ]
+}

docs/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @nhost/docs
 
+## 0.0.2
+
+### Patch Changes
+
+- 747aa969: fix: added twitch and discord as provider
+
 ## 0.0.1
 
 ### Patch Changes

docs/docs/platform/authentication/sign-in-methods/4-apple.mdx

@@ -0,0 +1,98 @@
+---
+title: Sign In with Apple
+sidebar_label: Apple
+slug: /platform/authentication/sign-in-with-apple
+image: /img/og/platform/sign-in-with-apple.png
+---
+
+Follow this guide to sign in users with Apple with your Nhost App.
+
+<p align="center">
+  <img
+    alt="Apple Sign In Preview"
+    src="/img/social-providers/apple-preview.svg"
+    width={480}
+    height={267}
+  />
+</p>
+
+## Create Apple Developer Account
+
+- Click on "Account" in the top menu.
+- Create a new [Apple Developer account](https://developer.apple.com) if you don't have one already and sign in to the Apple Developer platform.
+
+## Get an App ID
+
+- Go to the [Apple Developer Dashboard](https://developer.apple.com/account/).
+- Click on **Certificates, IDs & Profiles** in the left menu.
+- Click on **Identifiers** in the left menu.
+- Click on the "+" button in the header next to "Identifiers".
+- Select **App IDs** and click **Continue**.
+- Select type **App** and click **Continue**.
+- Fill in the App information:
+
+  - Description.
+  - Bundle ID (ex. io.nhost.app or com.your-startup.app).
+  - Scroll down and check **Sign In With Apple**.
+  - Click **Continue** in the top right corner.
+  - Click **Register** in the top right corner.
+
+- Click on the newly created app to see **Team ID**.
+
+- **Team ID**: Copy and paste the **Team ID** to your Nhost OAuth settings for Apple.
+
+## Get a Service ID
+
+- Go to the [Apple Developer Dashboard](https://developer.apple.com/account/).
+- Click on **Certificates, IDs & Profiles** in the left menu.
+- Click on **Identifiers** in the left menu.
+- Click on **Certificates, IDs & Profiles** in the left menu.
+- Click on **Identifiers** in the left menu.
+- Click on the "+" button in the header next to "Identifiers".
+- Select **Service IDs** and click **Continue**.
+
+- Fill in the Service information:
+
+  - Description.
+  - Identifier (Service ID) (ex. _service_.io.nhost.app or _service_.com.your-startup.app). Notice you can't use the same identifier as for the app so we recommend adding "service" at the beginning if the identifier.
+  - **Service ID**: Copy and paste the **Identifier (Service ID)** to your Nhost OAuth settings for Apple.
+  - Click **Continue** in the top right corner.
+  - Click **Register** in the top right corner.
+
+- Click on the newly created service in the list of Identifiers.
+- Click the checkbox to enable "Sign in with Apple".
+- Click **Configure** next to "Sign in with Apple".
+- Make sure your newly created Bundle ID is selected under Primary App ID.
+- Add your base auth domain under "Domains and Subdomains". E.g. `<subdomain>.nhost.run`.
+- Add the full callback URL under "Return URLs". E.g. `https://<subdomain>.nhost.run/v1/auth/signin/provider/apple/callback`.
+- Click **Next**.
+- Click **Done**.
+- Click **Continue** in the top right corner.
+- Click **Save** in the top right corner.
+
+## Generate Key
+
+- Go to the [Apple Developer Dashboard](https://developer.apple.com/account/).
+- Click on **Certificates, IDs & Profiles** in the left menu.
+- Click on **Keys** in the left menu.
+- Click on **Create a key**.
+- Fill in a name for your key.
+- Click the checkbox to enable "Sign in with Apple".
+- Click **Configure** next to "Sign in with Apple".
+- Select your newly created App ID in the dropdown selector.
+- Click **Save** in the top right corner.
+- Click **Continue** in the top right corner.
+- Click **Register** in the top right corner.
+- **Key ID**: Copy and paste the **Key ID** to your Nhost OAuth settings for Apple.
+- Click **Download** to download the key to your computer.
+- **Private Key**: Copy and paste the content of the downloaded key to your Nhost OAuth settings for Apple.
+
+## Sign In Users
+
+Use the [Nhost JavaScript client](/reference/javascript) to sign in users in your app:
+
+```js
+nhost.auth.signIn({
+  provider: 'apple'
+})
+```

docs/docs/platform/authentication/sign-in-methods/4-discord.mdx

@@ -0,0 +1,45 @@
+---
+title: Sign In with Discord
+sidebar_label: Discord
+slug: /platform/authentication/sign-in-with-discord
+image: /img/og/platform/sign-in-with-discord.png
+---
+
+Follow this guide to sign in users with Discord with your Nhost App.
+
+<p align="center">
+  <img
+    alt="Discord Sign In Preview"
+    src="/img/social-providers/discord-preview.svg"
+    width={480}
+    height={267}
+  />
+</p>
+
+## Create Discord Account
+
+- Create a new [Discord account](https://discord.com/) if you don't have one already.
+
+## Create Discord App
+
+- Sign in to the [Discord Developer Portal](https://discord.com/developers/applications).
+- Click on **New Application** in the top right corner.
+- Fill in the name of your Discord Application and click **Create**.
+- Click on **OAuth2** settings in the left menu.
+- Copy the **Client ID** and paste it into your Nhost OAuth settings for Discord.
+- Click on **Reset Secret**.
+- Click **Yes, do it** to generate a new secret.
+- Copy the **Client Secret** and paste it into your Nhost OAuth settings for Discord.
+- Click on **Add Redirect**.
+- Copy and paste the callback URL from your Nhost OAuth settings for Discord to the input field in the Discord Developer portal.
+- Click **Save Changes** to save the added callback URL.
+
+## Sign In Users
+
+Use the [Nhost JavaScript client](/reference/javascript) to sign in users in your app:
+
+```js
+nhost.auth.signIn({
+  provider: 'discord'
+})
+```

docs/docs/platform/authentication/sign-in-methods/4-twitch.mdx

@@ -0,0 +1,47 @@
+---
+title: Sign In with Twitch
+sidebar_label: Twitch
+slug: /platform/authentication/sign-in-with-twitch
+image: /img/og/platform/sign-in-with-twitch.png
+---
+
+Follow this guide to sign in users with Twitch with your Nhost App.
+
+<p align="center">
+  <img
+    alt="Twitch Sign In Preview"
+    src="/img/social-providers/twitch-preview.svg"
+    width={480}
+    height={267}
+  />
+</p>
+
+## Create Twitch Account
+
+- Create a new [Twitch account](https://twitch.tv/) if you don't have one already.
+
+## Create Twitch App
+
+- Sign in to the [Twitch Developer Console](https://dev.twitch.tv/console).
+- Click on **Register Your Application**.
+- Fill in a **Twitch application name**.
+- Copy and paste the callback URL from your Nhost OAuth settings for Twitch to the input field under **OAuth Redirect URLs** and click **Add** to the right of the input field.
+- Select an application **Category**. E.g. _Application Integration_.
+- Click **Create**.
+
+## Get Twitch Appplication Client ID and Client Secret
+
+- Click on **Manage** on your newly created Twitch application.
+- Copy the **Client ID** and paste it into your Nhost OAuth settings for Twitch.
+- Click on **New Secret** to generate a new client secret.
+- Copy the **Client Secret** and paste it into your Nhost OAuth settings for Twitch.
+
+## Sign In Users
+
+Use the [Nhost JavaScript client](/reference/javascript) to sign in users in your app:
+
+```js
+nhost.auth.signIn({
+  provider: 'twitch'
+})
+```

docs/docs/platform/authentication/sign-in-methods/index.md

@@ -35,6 +35,18 @@ nhost.auth.signIn({
 
 Users are redirected to your Nhost app's **client URL** by default. By default, your Nhost app's client URL is set to `http://localhost:3000`. You can change the value of your client URL in the Nhost console by going to **Users** → **Authentication Settings** → **Client URL**.
 
+
+Here is an example of how to redirect to another host or path:
+
+```js
+nhost.auth.signIn({
+  provider: '<provider>'
+  options: {
+    redirectTo: "<host>/<slug>" // Example: "https://example.com/dashboard"
+  },
+})
+```
+
 ## Provider OAuth scopes
 
 Scopes are a mechanism in OAuth to allow or limit an application's access to a user's account.

docs/docs/platform/authentication/users.mdx

@@ -60,11 +60,35 @@ The default role is used when no role is specified in the GraphQL request. By de
 
 ### Allowed Roles
 
+Allowed roles are roles the user is allowed to use when making a GraphQL request. Usually you would change the role from `user` (the default role) to some other role because you want Hasura to use a different role to resolve permissions for a particular GraphQL request.
+
 By default, users have two allowed roles:
 
 - `user`
 - `me`
 
+You can manage what allowed roles users should get when they sign up under **Users** -> **Roles & Permissions**.
+
+:::info
+
+You must also add the roles manually to the `auth.roles` table.
+
+:::
+
+It's also possible to give users a subset of allowed roles during signup.
+
+**Example:** Only give the `user` role (without the `me` role) for the user's allowed roles:
+
+```js
+await nhost.auth.signUp({
+  email: 'joe@example.com',
+  password: 'secret-password'
+  options: {
+    allowedRoles: ['user']
+  }
+})
+```
+
 ### Public Role
 
 The `public` role is used to resolve GraphQL permissions for unauthenticated users.

docs/docs/platform/cli.mdx

@@ -81,6 +81,18 @@ nhost up
 
 Hasura Console starts automatically and your Nhost app is running locally with the backend URL: `http://localhost:1337`.
 
+## Subdomain and Region
+
+Use `localhost:1337` as the `subdomain`, and skip `region` when using the CLI and the [JavaScript SDK](/reference/javascript):
+
+```
+import { NhostClient } from '@nhost/nhost-js'
+
+const nhost = new NhostClient({
+  subdomain: 'localhost:1337',
+})
+```
+
 ## Emails
 
 During local development with the CLI, all transactional emails from Authentication are sent to a local Mailhog instance, instead of to the recipient's email address. You'll see an address where after starting [`nhost up`](/reference/cli/up) where all emails are sent to.

docs/docs/platform/database/index.mdx

@@ -21,7 +21,10 @@ The database is managed via the Hasura Console where you can manage the database
 
 Hasura Console is where you manage your database. This is where you create and manage tables, schemas, and data.
 
-Open the Hasura Console by clicking on **Data** in the top menu in the Nhost Dashboard, copy the **admin secret**, and click **Open Hasura**. Use the **admin secret** to sign in.
+1. Open the Hasura Console by clicking on **GraphQL** in the top menu in the Nhost Dashboard.
+2. Click **Open Hasura Console** at the top right of the page.
+3. Copy the **admin secret**, and click **Open Hasura**.
+4. Use the **admin secret** to sign in.
 
 <video width="99%" autoPlay muted loop controls="true">
   <source src="/videos/open-hasura-console.mp4" type="video/mp4" />
@@ -128,6 +131,21 @@ To track database changes, use the [Nhost CLI](/platform/cli) to develop locally
 
 Learn how to [get started with Nhost CLI](/platform/overview/get-started-with-nhost-cli).
 
+## Seed Data
+
+Seed data is a way of automatically adding data to your database using SQL when a new environment is created. This is, for the moment, only applicable when you're using the [Nhost CLI](/platform/cli) to develop locally. When you're running `nhost up` for the first time, seed data is added.
+
+In the future, seed data will also be added to new preview environments.
+
+Seed data should be located in `nhost/seeds/default/` and are executed in alphabetical order.
+
+**Example:** Two seed scripts with countries and products.
+
+```text
+nhost/seeds/default/001-countries.sql
+nhost/seeds/default/002-products.sql
+```
+
 ## Backups
 
 Databases on [Pro and Enterprise plans](https://nhost.io/pricing) are backed up automatically.

docs/docs/platform/graphql/permissions.md

@@ -54,6 +54,18 @@ query {
 }
 ```
 
+### Local Custom Permission Variables
+
+To use custom permission variables locally, add your claims to the `config.yml` as following:
+
+```
+auth:
+  jwt:
+    custom_claims: '{"organisation-id":"profile.organisation.id"}'
+```
+
+Your custom claim will be automatically prefixed with `x-hasura-`, therefore, the example above results in a custom permission variable named `x-hasura-organisation-id`.
+
 ## Roles
 
 Every GraphQL request is resolved based on a **single role**. Roles are added in the Hasura Console when selecting a table and clicking **Permisisons**.

docs/docs/platform/quickstarts/nextjs.mdx

@@ -132,7 +132,8 @@ import { NhostNextProvider, NhostClient } from '@nhost/nextjs';
 
 // highlight-start
 const nhost = new NhostClient({
-  backendUrl: process.env.NEXT_PUBLIC_NHOST_BACKEND_URL || '',
+  subdomain: process.env.NEXT_PUBLIC_NHOST_SUBDOMAIN || '',
+  region: process.env.NEXT_PUBLIC_NHOST_REGION || ''
 });
 // highlight-end
 
@@ -149,16 +150,16 @@ function MyApp({ Component, pageProps }) {
 }
 ```
 
-Finally, make sure to create an environment variable named
-`NEXT_PUBLIC_NHOST_BACKEND_URL` to store your Nhost backend URL:
+Finally, store the environment variables for `subdomain` and `region` in `.env.development`:
 
 ```yaml title=".env.development"
-NEXT_PUBLIC_NHOST_BACKEND_URL=YOUR_NHOST_BACKEND_URL
+NEXT_PUBLIC_NHOST_SUBDOMAIN=YOUR_NHOST_APP_SUBDOMAIN
+NEXT_PUBLIC_NHOST_REGION=YOUR_NHOST_APP_REGION
 ```
 
-You can find your Nhost backend URL for your project from [your dashboard](https://app.nhost.io) as shown below:
+You find your Nhost app's subdomain and region in [the app dashboard](https://app.nhost.io):
 
-![Nhost Backend URL](/img/quickstarts/app-dashboard.png)
+![Nhost App Dashboard](/img/quickstarts/app-dashboard.png)
 
 :::caution
 Don't forget to restart your Next.js server after saving your `.env.development`

docs/docs/platform/quickstarts/react.mdx

@@ -128,7 +128,8 @@ Nhost backend:
 import { NhostClient, NhostReactProvider } from '@nhost/react'
 
 const nhost = new NhostClient({
-  backendUrl: process.env.REACT_APP_NHOST_BACKEND_URL || ''
+  subdomain: process.env.REACT_APP_NHOST_SUBDOMAIN,
+  region: process.env.REACT_APP_NHOST_REGION
 })
 
 function App() {
@@ -143,15 +144,16 @@ export default App
 ```
 
 Finally, make sure to create an environment variable named
-`REACT_APP_NHOST_BACKEND_URL` to store your Nhost backend URL:
+`REACT_APP_NHOST_SUBDOMAIN` and `REACT_APP_NHOST_REGION` to store your Nhost domain details:
 
 ```yaml title=".env.local"
-REACT_APP_NHOST_BACKEND_URL=YOUR_NHOST_BACKEND_URL
+REACT_APP_NHOST_SUBDOMAIN=YOUR_NHOST_APP_SUBDOMAIN
+REACT_APP_NHOST_REGION=YOUR_NHOST_APP_REGION
 ```
 
-You can find your Nhost backend URL for your project from [your dashboard](https://app.nhost.io) as shown below:
+You find your Nhost app's subdomain and region in [the app dashboard](https://app.nhost.io):
 
-![Nhost Backend URL](/img/quickstarts/app-dashboard.png)
+![Nhost App Dashboard](/img/quickstarts/app-dashboard.png)
 
 :::caution
 Don't forget to restart your React server after saving your `.env.local`

docs/docs/platform/quickstarts/redwoodjs.mdx

@@ -136,7 +136,8 @@ import { NhostClient } from '@nhost/nhost-js'
 
 // highlight-start
 const nhostClient = new NhostClient({
-  backendUrl: process.env.NHOST_BACKEND_URL
+  subdomain: process.env.NHOST_SUBDOMAIN
+  region: process.env.NHOST_REGION
 })
 // highlight-end
 
@@ -175,16 +176,16 @@ const App = () => (
 
 That prop avoids having an additional request to fetch the current user.
 
-Next, make sure to create an environment variable named
-`NHOST_BACKEND_URL` to store your Nhost backend URL:
+Next, store the environment variables for `subdomain` and `region` in `.env`:
 
 ```yaml title=".env"
-NHOST_BACKEND_URL=YOUR_NHOST_BACKEND_URL
+NHOST_SUBDOMAIN=YOUR_NHOST_APP_SUBDOMAIN
+NHOST_REGION=YOUR_NHOST_APP_REGION
 ```
 
-You can find your Nhost backend URL for your project from [your dashboard](https://app.nhost.io) as shown below:
+You find your Nhost app's subdomain and region in [the app dashboard](https://app.nhost.io):
 
-![Nhost Backend URL](/img/quickstarts/app-dashboard.png)
+![Nhost App Dashboard](/img/quickstarts/app-dashboard.png)
 
 Finally, we need to customize the GraphQL Endpoint for our RedwoodJS app. Indeed, by default, RedwoodJS provides a built-in GraphQL server under the `api` side. However, as we already have our own GraphQL server through Nhost and Hasura, we do not need it.
 
@@ -194,7 +195,7 @@ So, open the RedwoodJS configuration file, `redwood.toml`, and change the GraphQ
 [web]
   apiUrl = "/.redwood/functions"
   # highlight-next-line
-  apiGraphQLUrl = "${NHOST_BACKEND_URL}/v1/graphql"
+  apiGraphQLUrl = "https://${NHOST_SUBDOMAIN}.graphql.${NHOST_REGION}.nhost.run/v1"
 ```
 
 :::caution

docs/docs/platform/quickstarts/vue.mdx

@@ -153,7 +153,8 @@ import 'uno.css'
 
 // highlight-start
 const nhost = new NhostClient({
-  backendUrl: import.meta.env.VITE_NHOST_URL
+  subdomain: import.meta.env.VITE_NHOST_SUBDOMAIN
+  region: import.meta.env.VITE_NHOST_REGION
 })
 // highlight-end
 
@@ -170,16 +171,16 @@ app
 app.mount('#app')
 ```
 
-Finally, make sure to create an environment variable named
-`VITE_NHOST_URL` to store your Nhost backend URL:
+Finally, store the environment variables for `subdomain` and `region` in `.env`:
 
-```bash title=".env"
-VITE_NHOST_URL=YOUR_NHOST_BACKEND_URL
+```yaml title=".env.development"
+VITE_NHOST_SUBDOMAIN=YOUR_NHOST_APP_SUBDOMAIN
+VITE_NHOST_REGION=YOUR_NHOST_APP_REGION
 ```
 
-You can find your Nhost backend URL for your project from [your dashboard](https://app.nhost.io) as shown below:
+You find your Nhost app's subdomain and region in [the app dashboard](https://app.nhost.io):
 
-![Nhost Backend URL](/img/quickstarts/app-dashboard.png)
+![Nhost App Dashboard](/img/quickstarts/app-dashboard.png)
 
 ## Build the app
 

docs/docs/reference/cli/up.mdx

@@ -7,7 +7,7 @@ Launch the development environment for your app. Once the environment is up, the
 
 - Apply database migrations.
 - Apply the Hasura metadata.
-- Apply seed data.
+- Apply [seed data](/platform/database#seed-data).
 
 ```bash
 nhost up

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

@@ -4,7 +4,7 @@ title: signUp()
 sidebar_label: signUp()
 slug: /reference/javascript/auth/sign-up
 description: Use `nhost.auth.signUp` to sign up a user using email and password. If you want to sign up a user using passwordless email (Magic Link), SMS, or an OAuth provider, use the `signIn` function instead.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L101
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L103
 ---
 
 # `signUp()`

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

@@ -4,7 +4,7 @@ title: signIn()
 sidebar_label: signIn()
 slug: /reference/javascript/auth/sign-in
 description: Use `nhost.auth.signIn` to sign in a user using email and password, passwordless (email or sms) or an external provider. `signIn` can be used to sign in a user 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#L144
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L146
 ---
 
 # `signIn()`

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

@@ -4,7 +4,7 @@ title: signOut()
 sidebar_label: signOut()
 slug: /reference/javascript/auth/sign-out
 description: Use `nhost.auth.signOut` to sign out the user.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L222
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L231
 ---
 
 # `signOut()`
@@ -31,7 +31,7 @@ nhost.auth.signOut()
 nhost.auth.signOut()
 ```
 
-### Sign out the user from all decvices
+### Sign out the user from all devices
 
 ```ts
 nhost.auth.signOut({ all: true })

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

@@ -4,7 +4,7 @@ title: resetPassword()
 sidebar_label: resetPassword()
 slug: /reference/javascript/auth/reset-password
 description: Use `nhost.auth.resetPassword` to reset the password for a user. This will send a reset-password link in an email to the user. When the user clicks the reset-password link the user is automatically signed-in. Once signed-in, the user can change their password using `nhost.auth.changePassword()`.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L238
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L247
 ---
 
 # `resetPassword()`

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

@@ -4,7 +4,7 @@ title: changePassword()
 sidebar_label: changePassword()
 slug: /reference/javascript/auth/change-password
 description: Use `nhost.auth.changePassword` to change the password for the user. The old password is not needed.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L254
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L263
 ---
 
 # `changePassword()`

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

@@ -4,7 +4,7 @@ title: sendVerificationEmail()
 sidebar_label: sendVerificationEmail()
 slug: /reference/javascript/auth/send-verification-email
 description: Use `nhost.auth.sendVerificationEmail` to send a verification email to the specified email. The email contains a verification-email link. When the user clicks the verification-email link their email is verified.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L270
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L279
 ---
 
 # `sendVerificationEmail()`

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

@@ -4,7 +4,7 @@ title: changeEmail()
 sidebar_label: changeEmail()
 slug: /reference/javascript/auth/change-email
 description: Use `nhost.auth.changeEmail` to change a user's email. This will send a confirm-email-change link in an email to the new email. Once the user clicks on the confirm-email-change link the email will be change to the new email.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L289
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L298
 ---
 
 # `changeEmail()`

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

@@ -4,7 +4,7 @@ title: deanonymize()
 sidebar_label: deanonymize()
 slug: /reference/javascript/auth/deanonymize
 description: Use `nhost.auth.deanonymize` to deanonymize a user.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L305
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L314
 ---
 
 # `deanonymize()`

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

@@ -4,7 +4,7 @@ title: onTokenChanged()
 sidebar_label: onTokenChanged()
 slug: /reference/javascript/auth/on-token-changed
 description: Use `nhost.auth.onTokenChanged` to add a custom function that runs every time the access or refresh token is changed.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L348
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L357
 ---
 
 # `onTokenChanged()`

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

@@ -4,7 +4,7 @@ title: onAuthStateChanged()
 sidebar_label: onAuthStateChanged()
 slug: /reference/javascript/auth/on-auth-state-changed
 description: Use `nhost.auth.onAuthStateChanged` to add a custom function that runs every time the authentication status of the user changes. E.g. add a custom function that runs every time the authentication status changes from signed-in to signed-out.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L383
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L392
 ---
 
 # `onAuthStateChanged()`

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

@@ -4,7 +4,7 @@ title: isAuthenticated()
 sidebar_label: isAuthenticated()
 slug: /reference/javascript/auth/is-authenticated
 description: Use `nhost.auth.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#L425
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L434
 ---
 
 # `isAuthenticated()`

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

@@ -4,7 +4,7 @@ title: isAuthenticatedAsync()
 sidebar_label: isAuthenticatedAsync()
 slug: /reference/javascript/auth/is-authenticated-async
 description: Use `nhost.auth.isAuthenticatedAsync` to wait (await) for any internal authentication network requests to finish and then return the authentication status.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L443
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L452
 ---
 
 # `isAuthenticatedAsync()`

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

@@ -4,7 +4,7 @@ title: getAuthenticationStatus()
 sidebar_label: getAuthenticationStatus()
 slug: /reference/javascript/auth/get-authentication-status
 description: Use `nhost.auth.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#L469
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L478
 ---
 
 # `getAuthenticationStatus()`

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

@@ -4,7 +4,7 @@ title: getAccessToken()
 sidebar_label: getAccessToken()
 slug: /reference/javascript/auth/get-access-token
 description: Use `nhost.auth.getAccessToken` to get the access token of the user.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L499
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L508
 ---
 
 # `getAccessToken()`

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

@@ -4,7 +4,7 @@ title: getDecodedAccessToken()
 sidebar_label: getDecodedAccessToken()
 slug: /reference/javascript/auth/get-decoded-access-token
 description: Use `nhost.auth.getDecodedAccessToken` to get the decoded access token of the user.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L514
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L523
 ---
 
 # `getDecodedAccessToken()`

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

@@ -4,7 +4,7 @@ title: getHasuraClaims()
 sidebar_label: getHasuraClaims()
 slug: /reference/javascript/auth/get-hasura-claims
 description: Use `nhost.auth.getHasuraClaims` to get the Hasura claims of the user.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L531
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L540
 ---
 
 # `getHasuraClaims()`

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

@@ -4,7 +4,7 @@ title: getHasuraClaim()
 sidebar_label: getHasuraClaim()
 slug: /reference/javascript/auth/get-hasura-claim
 description: Use `nhost.auth.getHasuraClaim` to get the value of a specific Hasura claim of the user.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L549
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L558
 ---
 
 # `getHasuraClaim()`

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

@@ -4,7 +4,7 @@ title: refreshSession()
 sidebar_label: refreshSession()
 slug: /reference/javascript/auth/refresh-session
 description: Use `nhost.auth.refreshSession` to refresh the session with either the current internal refresh token or an external refresh token.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L572
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L581
 ---
 
 # `refreshSession()`

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

@@ -4,7 +4,7 @@ title: getSession()
 sidebar_label: getSession()
 slug: /reference/javascript/auth/get-session
 description: Use `nhost.auth.getSession()` to get the session of the user.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L616
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L625
 ---
 
 # `getSession()`

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

@@ -4,7 +4,7 @@ title: getUser()
 sidebar_label: getUser()
 slug: /reference/javascript/auth/get-user
 description: Use `nhost.auth.getUser()` to get the signed-in user.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L631
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L640
 ---
 
 # `getUser()`

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

@@ -4,7 +4,7 @@ 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#L59
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L60
 ---
 
 # `HasuraAuthClient`

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

@@ -4,7 +4,7 @@ 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#L128
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L134
 ---
 
 # `AuthChangeEvent`

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

@@ -4,7 +4,7 @@ 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#L130
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L136
 ---
 
 # `AuthChangedFunction`

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

@@ -4,7 +4,7 @@ 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#L99
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L105
 ---
 
 # `ChangeEmailParams`

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

@@ -4,7 +4,7 @@ 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#L90
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L96
 ---
 
 # `ChangePasswordParams`

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

@@ -4,7 +4,7 @@ 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#L104
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L110
 ---
 
 # `DeanonymizeParams`

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

@@ -4,7 +4,7 @@ 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#L132
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L138
 ---
 
 # `OnTokenChangedFunction`

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

@@ -22,4 +22,6 @@ type Provider =
   | 'strava'
   | 'gitlab'
   | 'bitbucket'
+  | 'discord'
+  | 'twitch'
 ```

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

@@ -4,7 +4,7 @@ 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#L85
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L91
 ---
 
 # `ResetPasswordParams`

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

@@ -4,7 +4,7 @@ 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#L94
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L100
 ---
 
 # `SendVerificationEmailParams`

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

@@ -1,19 +1,19 @@
 ---
 # ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
-title: LoginData
-sidebar_label: LoginData
+title: SignInEmailPasswordOtpParams
+sidebar_label: SignInEmailPasswordOtpParams
 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#L134
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L59
 ---
 
-# `LoginData`
+# `SignInEmailPasswordOtpParams`
 
 ## Parameters
 
 ---
 
-**<span className="parameter-name">mfa</span>** <span className="optional-status">optional</span> `boolean`
+**<span className="parameter-name">otp</span>** <span className="optional-status">required</span> `string`
 
 ---
 

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

@@ -4,7 +4,7 @@ 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#L78
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L83
 ---
 
 # `SignInParams`
@@ -12,6 +12,7 @@ custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-j
 ```ts
 type SignInParams =
   | SignInEmailPasswordParams
+  | SignInEmailPasswordOtpParams
   | SignInPasswordlessEmailParams
   | SignInPasswordlessSmsOtpParams
   | SignInPasswordlessSmsParams

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

@@ -4,7 +4,7 @@ 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#L59
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L64
 ---
 
 # `SignInPasswordlessEmailParams`

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

@@ -4,7 +4,7 @@ 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#L69
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L74
 ---
 
 # `SignInPasswordlessSmsOtpParams`

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

@@ -4,7 +4,7 @@ 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#L64
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L69
 ---
 
 # `SignInPasswordlessSmsParams`

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

@@ -4,7 +4,7 @@ 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#L117
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L123
 ---
 
 # `SignInReponse`

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

@@ -4,7 +4,7 @@ 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#L73
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L78
 ---
 
 # `SignInWithProviderOptions`

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

@@ -4,7 +4,7 @@ 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
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/index.ts#L4
 ---
 
 # `createClient()`
@@ -15,16 +15,18 @@ custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/
 
 **<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"><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>devTools</span>            | `boolean`           |          | Activate devTools e.g. the ability to connect to the xstate inspector                                                                |
-| <span className="parameter-name"><span className="light-grey">config.</span>start</span>               | `boolean`           |          |                                                                                                                                      |
-| <span className="parameter-name"><span className="light-grey">config.</span>adminSecret</span>         | `string`            |          | Admin secret. When set, it is sent as an `x-hasura-admin-secret` header for all GraphQL, Storage, and Serverless Functions requests. |
+| Property                                                                                               | Type                | Required | Notes                                                                                                                         |
+| :----------------------------------------------------------------------------------------------------- | :------------------ | :------: | :---------------------------------------------------------------------------------------------------------------------------- |
+| <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"><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>devTools</span>            | `boolean`           |          | Activate devTools e.g. the ability to connect to the xstate inspector                                                         |
+| <span className="parameter-name"><span className="light-grey">config.</span>start</span>               | `boolean`           |          |                                                                                                                               |
+| <span className="parameter-name"><span className="light-grey">config.</span>backendUrl</span>          | `string`            |          | Nhost backend URL Should only be used when self-hosting                                                                       |
+| <span className="parameter-name"><span className="light-grey">config.</span>adminSecret</span>         | `string`            |          | When set, the admin secret is sent as a header, `x-hasura-admin-secret`, for all requests to GraphQL, Storage, and Functions. |
+| <span className="parameter-name"><span className="light-grey">config.</span>subdomain</span>           | `string`            |          | App subdomain (e.g, ieingiwnginwnfnegqwvdqwdwq) Should be used when using the Nhost platform Use "localhost" in development   |
+| <span className="parameter-name"><span className="light-grey">config.</span>region</span>              | `string`            |          | App region (e.g., eu-central-1) Not required in development (when `subdomain` is "localhost")                                 |
 
 ---

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

@@ -4,29 +4,35 @@ 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#L19
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/core/nhost-client.ts#L8
 ---
 
 # `NhostClient`
 
 Nhost Client
 
+```ts
+const nhost = new NhostClient({ subdomain, region })
+```
+
 ## Parameters
 
 ---
 
 **<span className="parameter-name">\_\_namedParameters</span>** <span className="optional-status">required</span> [`NhostClientConstructorParams`](/reference/docgen/javascript/nhost-js/types/nhost-client-constructor-params)
 
-| Property                                                                                                            | Type                | Required | Notes                                                                                                                                |
-| :------------------------------------------------------------------------------------------------------------------ | :------------------ | :------: | :----------------------------------------------------------------------------------------------------------------------------------- |
-| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>backendUrl</span>          | `string`            |    ✔️    | Nhost backend URL.                                                                                                                   |
-| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>adminSecret</span>         | `string`            |          | Admin secret. When set, it is sent as an `x-hasura-admin-secret` header for all GraphQL, Storage, and Serverless Functions requests. |
-| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>start</span>               | `boolean`           |          |                                                                                                                                      |
-| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>devTools</span>            | `boolean`           |          | Activate devTools e.g. the ability to connect to the xstate inspector                                                                |
-| <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"><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                                                                                      |
+| Property                                                                                                            | Type                | Required | Notes                                                                                                                         |
+| :------------------------------------------------------------------------------------------------------------------ | :------------------ | :------: | :---------------------------------------------------------------------------------------------------------------------------- |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>region</span>              | `string`            |          | App region (e.g., eu-central-1) Not required in development (when `subdomain` is "localhost")                                 |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>subdomain</span>           | `string`            |          | App subdomain (e.g, ieingiwnginwnfnegqwvdqwdwq) Should be used when using the Nhost platform Use "localhost" in development   |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>adminSecret</span>         | `string`            |          | When set, the admin secret is sent as a header, `x-hasura-admin-secret`, for all requests to GraphQL, Storage, and Functions. |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>backendUrl</span>          | `string`            |          | Nhost backend URL Should only be used when self-hosting                                                                       |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>start</span>               | `boolean`           |          |                                                                                                                               |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>devTools</span>            | `boolean`           |          | Activate devTools e.g. the ability to connect to the xstate inspector                                                         |
+| <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"><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/types/backend-or-subdomain.mdx

@@ -0,0 +1,14 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: BackendOrSubdomain
+sidebar_label: BackendOrSubdomain
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/utils/types.ts#L40
+---
+
+# `BackendOrSubdomain`
+
+```ts
+type BackendOrSubdomain = BackendUrl | Subdomain
+```

docs/docs/reference/docgen/javascript/nhost-js/types/backend-url.mdx

@@ -0,0 +1,14 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: BackendUrl
+sidebar_label: BackendUrl
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/utils/types.ts#L7
+---
+
+# `BackendUrl`
+
+```ts
+type BackendUrl = () => { backendUrl: string; adminSecret: string }
+```

docs/docs/reference/docgen/javascript/nhost-js/types/function-call-response.mdx

@@ -0,0 +1,16 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: FunctionCallResponse
+sidebar_label: FunctionCallResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/utils/types.ts#L57
+---
+
+# `FunctionCallResponse`
+
+```ts
+type FunctionCallResponse =
+  | { res: AxiosResponse<T>; error: null }
+  | { res: null; error: Error }
+```

docs/docs/reference/docgen/javascript/nhost-js/types/graphql-request-response.mdx

@@ -0,0 +1,16 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: GraphqlRequestResponse
+sidebar_label: GraphqlRequestResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/utils/types.ts#L47
+---
+
+# `GraphqlRequestResponse`
+
+```ts
+type GraphqlRequestResponse =
+  | { data: null; error: Error | object | Array<object> }
+  | { data: T; error: null }
+```

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

@@ -0,0 +1,22 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: GraphqlResponse
+sidebar_label: GraphqlResponse
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/utils/types.ts#L67
+---
+
+# `GraphqlResponse`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">errors</span>** <span className="optional-status">optional</span> `Array<object>`
+
+---
+
+**<span className="parameter-name">data</span>** <span className="optional-status">optional</span> `T`
+
+---

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

@@ -0,0 +1,74 @@
+---
+# ⚠️ 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#L15
+---
+
+# `NhostAuthConstructorParams`
+
+## Parameters
+
+---
+
+**<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.
+
+Recommended values:
+
+- `'web'` and `'cookies'`: no value is required
+- `'react-native'`: `import Storage from @react-native-async-storage/async-storage`
+- `'cookies'`: `localStorage`
+- `'custom'`: an object that defines the following methods:
+  - `setItem` or `setItemAsync`
+  - `getItem` or `getItemAsync`
+  - `removeItem`
+- `'capacitor'`: `import { Storage } from @capacitor/storage`
+- `'expo-secure-store'`: `import * as SecureStore from 'expo-secure-store'`
+
+---
+
+**<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">devTools</span>** <span className="optional-status">optional</span> `boolean`
+
+Activate devTools e.g. the ability to connect to the xstate inspector
+
+---
+
+**<span className="parameter-name">url</span>** <span className="optional-status">required</span> `string`
+
+---
+
+**<span className="parameter-name">start</span>** <span className="optional-status">optional</span> `boolean`
+
+---

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

@@ -4,7 +4,7 @@ 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
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/utils/types.ts#L42
 ---
 
 # `NhostClientConstructorParams`
@@ -13,12 +13,6 @@ custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/
 
 ---
 
-**<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
@@ -75,9 +69,31 @@ Activate devTools e.g. the ability to connect to the xstate inspector
 
 ---
 
-**<span className="parameter-name">adminSecret</span>** <span className="optional-status">optional</span> `string`
+**<span className="parameter-name">backendUrl</span>** <span className="optional-status">optional</span> `string`
 
-Admin secret. When set, it is sent as an `x-hasura-admin-secret` header for all
-GraphQL, Storage, and Serverless Functions requests.
+Nhost backend URL
+Should only be used when self-hosting
+
+---
+
+**<span className="parameter-name">adminSecret</span>** <span className="optional-status">optional</span> `string`
+
+When set, the admin secret is sent as a header, `x-hasura-admin-secret`,
+for all requests to GraphQL, Storage, and Functions.
+
+---
+
+**<span className="parameter-name">subdomain</span>** <span className="optional-status">optional</span> `string`
+
+App subdomain (e.g, ieingiwnginwnfnegqwvdqwdwq)
+Should be used when using the Nhost platform
+Use "localhost" in development
+
+---
+
+**<span className="parameter-name">region</span>** <span className="optional-status">optional</span> `string`
+
+App region (e.g., eu-central-1)
+Not required in development (when `subdomain` is "localhost")
 
 ---

docs/docs/reference/docgen/javascript/nhost-js/types/subdomain.mdx

@@ -0,0 +1,18 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: Subdomain
+sidebar_label: Subdomain
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nhost-js/src/utils/types.ts#L20
+---
+
+# `Subdomain`
+
+```ts
+type Subdomain = () => {
+  subdomain: string
+  region: string
+  adminSecret: string
+}
+```

docs/docs/reference/docgen/javascript/storage/content/create-file-upload-machine.mdx

@@ -0,0 +1,10 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: createFileUploadMachine()
+sidebar_label: createFileUploadMachine()
+slug: /reference/javascript/storage/create-file-upload-machine
+description: No description provided.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/machines/file-upload.ts#L36
+---
+
+# `createFileUploadMachine()`

docs/docs/reference/docgen/javascript/storage/content/create-multiple-files-upload-machine.mdx

@@ -0,0 +1,10 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: createMultipleFilesUploadMachine()
+sidebar_label: createMultipleFilesUploadMachine()
+slug: /reference/javascript/storage/create-multiple-files-upload-machine
+description: No description provided.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/machines/multiple-files-upload.ts#L37
+---
+
+# `createMultipleFilesUploadMachine()`

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

@@ -4,7 +4,7 @@ title: upload()
 sidebar_label: upload()
 slug: /reference/javascript/storage/upload
 description: Use `nhost.storage.upload` to upload a file. The `file` must be of type [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File).
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/hasura-storage-client.ts#L52
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/hasura-storage-client.ts#L52
 ---
 
 # `upload()`

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

@@ -5,7 +5,7 @@ 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-js/src/hasura-storage-client.ts#L74
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/hasura-storage-client.ts#L74
 ---
 
 # `getUrl()`

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

@@ -4,7 +4,7 @@ title: getPublicUrl()
 sidebar_label: getPublicUrl()
 slug: /reference/javascript/storage/get-public-url
 description: Use `nhost.storage.getPublicUrl` to get the public URL of a file. The public URL can be used for un-authenticated users to access files. To access public files the `public` role must have permissions to select the file in the `storage.files` table.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/hasura-storage-client.ts#L88
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/hasura-storage-client.ts#L88
 ---
 
 # `getPublicUrl()`

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

@@ -4,7 +4,7 @@ title: getPresignedUrl()
 sidebar_label: getPresignedUrl()
 slug: /reference/javascript/storage/get-presigned-url
 description: Use `nhost.storage.getPresignedUrl` to get a presigned URL of a file. To get a presigned URL the user must have permission to select the file in the `storage.files` table.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/hasura-storage-client.ts#L110
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/hasura-storage-client.ts#L110
 ---
 
 # `getPresignedUrl()`

docs/docs/reference/docgen/javascript/storage/content/hasura-storage-client/content/05-delete.mdx

@@ -4,7 +4,7 @@ title: delete()
 sidebar_label: delete()
 slug: /reference/javascript/storage/delete
 description: Use `nhost.storage.delete` to delete a file. To delete a file the user must have permissions to delete the file in the `storage.files` table. Deleting the file using `nhost.storage.delete()` will delete both the file and its metadata.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/hasura-storage-client.ts#L135
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/hasura-storage-client.ts#L135
 ---
 
 # `delete()`

docs/docs/reference/docgen/javascript/storage/content/hasura-storage-client/content/06-set-access-token.mdx

@@ -4,7 +4,7 @@ title: setAccessToken()
 sidebar_label: setAccessToken()
 slug: /reference/javascript/storage/set-access-token
 description: Use `nhost.storage.setAccessToken` to a set an access token to be used in subsequent storage requests. Note that if you're signin in users with `nhost.auth.signIn()` the access token will be set automatically.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/hasura-storage-client.ts#L156
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/hasura-storage-client.ts#L156
 ---
 
 # `setAccessToken()`

docs/docs/reference/docgen/javascript/storage/content/hasura-storage-client/content/07-set-admin-secret.mdx

@@ -4,7 +4,7 @@ title: setAdminSecret()
 sidebar_label: setAdminSecret()
 slug: /reference/javascript/storage/set-admin-secret
 description: Use `nhost.storage.adminSecret` to set the admin secret to be used for subsequent storage requests. This is useful if you want to run storage in "admin mode".
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/hasura-storage-client.ts#L174
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/hasura-storage-client.ts#L174
 ---
 
 # `setAdminSecret()`

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

@@ -4,7 +4,7 @@ title: HasuraStorageClient
 sidebar_label: Storage
 description: No description provided.
 slug: /reference/javascript/storage
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/hasura-storage-client.ts#L25
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/hasura-storage-client.ts#L25
 ---
 
 # `HasuraStorageClient`

docs/docs/reference/docgen/javascript/storage/content/upload-file-promise.mdx

@@ -0,0 +1,32 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: uploadFilePromise()
+sidebar_label: uploadFilePromise()
+slug: /reference/javascript/storage/upload-file-promise
+description: No description provided.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/promises/file-upload.ts#L40
+---
+
+# `uploadFilePromise()`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">nhost</span>** <span className="optional-status">required</span> [`NhostClientReturnType`](/reference/docgen/javascript/storage/types/nhost-client-return-type)
+
+| Property                                                                                      | Type               | Required | Notes |
+| :-------------------------------------------------------------------------------------------- | :----------------- | :------: | :---- |
+| <span className="parameter-name"><span className="light-grey">nhost.</span>storage</span>     | `{ url: string }`  |    ✔️    |       |
+| <span className="parameter-name"><span className="light-grey">nhost.</span>auth</span>        | `HasuraAuthClient` |    ✔️    |       |
+| <span className="parameter-name"><span className="light-grey">nhost.</span>adminSecret</span> | `string`           |          |       |
+
+---
+
+**<span className="parameter-name">interpreter</span>** <span className="optional-status">required</span> `ActorRefWithDeprecatedState<FileUploadContext, { type: "ADD", file: File, id: string, bucketId: string, name: string } | { type: "UPLOAD", url: string, file: File, id: string, bucketId: string, name: string, accessToken: string, adminSecret: string } | { type: "UPLOAD_PROGRESS", progress: number, loaded: number, additions: number } | { type: "UPLOAD_DONE", id: string, bucketId: string } | { type: "UPLOAD_ERROR", error: ErrorPayload } | { type: "CANCEL" } | { type: "DESTROY" }, { value: any, context: FileUploadContext }, ResolveTypegenMeta<Typegen0, { type: "ADD", file: File, id: string, bucketId: string, name: string } | { type: "UPLOAD", url: string, file: File, id: string, bucketId: string, name: string, accessToken: string, adminSecret: string } | { type: "UPLOAD_PROGRESS", progress: number, loaded: number, additions: number } | { type: "UPLOAD_DONE", id: string, bucketId: string } | { type: "UPLOAD_ERROR", error: ErrorPayload } | { type: "CANCEL" } | { type: "DESTROY" }, BaseActionObject, ServiceMap>>` | `Interpreter<FileUploadContext, any, { type: "ADD", file: File, id: string, bucketId: string, name: string } | { type: "UPLOAD", url: string, file: File, id: string, bucketId: string, name: string, accessToken: string, adminSecret: string } | { type: "UPLOAD_PROGRESS", progress: number, loaded: number, additions: number } | { type: "UPLOAD_DONE", id: string, bucketId: string } | { type: "UPLOAD_ERROR", error: ErrorPayload } | { type: "CANCEL" } | { type: "DESTROY" }, { value: any, context: FileUploadContext }, ResolveTypegenMeta<Typegen0, { type: "ADD", file: File, id: string, bucketId: string, name: string } | { type: "UPLOAD", url: string, file: File, id: string, bucketId: string, name: string, accessToken: string, adminSecret: string } | { type: "UPLOAD_PROGRESS", progress: number, loaded: number, additions: number } | { type: "UPLOAD_DONE", id: string, bucketId: string } | { type: "UPLOAD_ERROR", error: ErrorPayload } | { type: "CANCEL" } | { type: "DESTROY" }, BaseActionObject, ServiceMap>>`
+
+---
+
+**<span className="parameter-name">params</span>** <span className="optional-status">required</span> `Partial<StorageUploadParams>`
+
+---

docs/docs/reference/docgen/javascript/storage/content/upload-multiple-files-promise.mdx

@@ -0,0 +1,37 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: uploadMultipleFilesPromise()
+sidebar_label: uploadMultipleFilesPromise()
+slug: /reference/javascript/storage/upload-multiple-files-promise
+description: No description provided.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/promises/multiple-files-upload.ts#L46
+---
+
+# `uploadMultipleFilesPromise()`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">nhost</span>** <span className="optional-status">required</span> [`NhostClientReturnType`](/reference/docgen/javascript/storage/types/nhost-client-return-type)
+
+| Property                                                                                      | Type               | Required | Notes |
+| :-------------------------------------------------------------------------------------------- | :----------------- | :------: | :---- |
+| <span className="parameter-name"><span className="light-grey">nhost.</span>auth</span>        | `HasuraAuthClient` |    ✔️    |       |
+| <span className="parameter-name"><span className="light-grey">nhost.</span>storage</span>     | `{ url: string }`  |    ✔️    |       |
+| <span className="parameter-name"><span className="light-grey">nhost.</span>adminSecret</span> | `string`           |          |       |
+
+---
+
+**<span className="parameter-name">service</span>** <span className="optional-status">required</span> `Interpreter<MultipleFilesUploadContext, any, { type: "ADD", files: AnyFileList, bucketId: string } | { type: "UPLOAD", url: string, files: AnyFileList, bucketId: string, accessToken: string, adminSecret: string } | { type: "UPLOAD_PROGRESS", additions: number } | { type: "UPLOAD_DONE" } | { type: "UPLOAD_ERROR" } | { type: "CANCEL" } | { type: "REMOVE" } | { type: "CLEAR" }, { value: any, context: MultipleFilesUploadContext }, ResolveTypegenMeta<Typegen0, { type: "ADD", files: AnyFileList, bucketId: string } | { type: "UPLOAD", url: string, files: AnyFileList, bucketId: string, accessToken: string, adminSecret: string } | { type: "UPLOAD_PROGRESS", additions: number } | { type: "UPLOAD_DONE" } | { type: "UPLOAD_ERROR" } | { type: "CANCEL" } | { type: "REMOVE" } | { type: "CLEAR" }, BaseActionObject, ServiceMap>>`
+
+---
+
+**<span className="parameter-name">params</span>** <span className="optional-status">optional</span> [`UploadMultipleFilesActionParams`](/reference/docgen/javascript/storage/types/upload-multiple-files-action-params)
+
+| Property                                                                                    | Type                                                                      | Required | Notes |
+| :------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------ | :------: | :---- |
+| <span className="parameter-name"><span className="light-grey">params.</span>bucketId</span> | `string`                                                                  |          |       |
+| <span className="parameter-name"><span className="light-grey">params.</span>files</span>    | [`AnyFileList`](/reference/docgen/javascript/storage/types/any-file-list) |          |       |
+
+---

docs/docs/reference/docgen/javascript/storage/types/any-file-list.mdx

@@ -0,0 +1,14 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: AnyFileList
+sidebar_label: AnyFileList
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/machines/multiple-files-upload.ts#L9
+---
+
+# `AnyFileList`
+
+```ts
+type AnyFileList = File | Array<File> | FileList
+```

docs/docs/reference/docgen/javascript/storage/types/api-delete-params.mdx

@@ -4,7 +4,7 @@ title: ApiDeleteParams
 sidebar_label: ApiDeleteParams
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/utils/types.ts#L61
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/utils/types.ts#L69
 ---
 
 # `ApiDeleteParams`

docs/docs/reference/docgen/javascript/storage/types/api-delete-response.mdx

@@ -4,7 +4,7 @@ title: ApiDeleteResponse
 sidebar_label: ApiDeleteResponse
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/utils/types.ts#L65
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/utils/types.ts#L73
 ---
 
 # `ApiDeleteResponse`

docs/docs/reference/docgen/javascript/storage/types/api-get-presigned-url-params.mdx

@@ -4,7 +4,7 @@ title: ApiGetPresignedUrlParams
 sidebar_label: ApiGetPresignedUrlParams
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/utils/types.ts#L53
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/utils/types.ts#L61
 ---
 
 # `ApiGetPresignedUrlParams`

docs/docs/reference/docgen/javascript/storage/types/api-get-presigned-url-response.mdx

@@ -4,7 +4,7 @@ title: ApiGetPresignedUrlResponse
 sidebar_label: ApiGetPresignedUrlResponse
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/utils/types.ts#L57
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/utils/types.ts#L65
 ---
 
 # `ApiGetPresignedUrlResponse`

docs/docs/reference/docgen/javascript/storage/types/api-upload-params.mdx

@@ -4,7 +4,7 @@ title: ApiUploadParams
 sidebar_label: ApiUploadParams
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/utils/types.ts#L42
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/utils/types.ts#L50
 ---
 
 # `ApiUploadParams`

docs/docs/reference/docgen/javascript/storage/types/api-upload-response.mdx

@@ -4,7 +4,7 @@ title: ApiUploadResponse
 sidebar_label: ApiUploadResponse
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/utils/types.ts#L49
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/utils/types.ts#L57
 ---
 
 # `ApiUploadResponse`

docs/docs/reference/docgen/javascript/storage/types/file-item-ref.mdx

@@ -0,0 +1,10 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: FileItemRef
+sidebar_label: FileItemRef
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/machines/multiple-files-upload.ts#L7
+---
+
+# `FileItemRef`

docs/docs/reference/docgen/javascript/storage/types/file-upload-context.mdx

@@ -0,0 +1,21 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: FileUploadContext
+sidebar_label: FileUploadContext
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/machines/file-upload.ts#L6
+---
+
+# `FileUploadContext`
+
+```ts
+type FileUploadContext = () => {
+  progress: number | null
+  loaded: number
+  error: ErrorPayload | null
+  id: string
+  bucketId: string
+  file: File
+}
+```

docs/docs/reference/docgen/javascript/storage/types/file-upload-events.mdx

@@ -0,0 +1,35 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: FileUploadEvents
+sidebar_label: FileUploadEvents
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/machines/file-upload.ts#L15
+---
+
+# `FileUploadEvents`
+
+```ts
+type FileUploadEvents =
+  | { type: 'ADD'; file: File; id: string; bucketId: string; name: string }
+  | {
+      type: 'UPLOAD'
+      url: string
+      file: File
+      id: string
+      bucketId: string
+      name: string
+      accessToken: string
+      adminSecret: string
+    }
+  | {
+      type: 'UPLOAD_PROGRESS'
+      progress: number
+      loaded: number
+      additions: number
+    }
+  | { type: 'UPLOAD_DONE'; id: string; bucketId: string }
+  | { type: 'UPLOAD_ERROR'; error: ErrorPayload }
+  | { type: 'CANCEL' }
+  | { type: 'DESTROY' }
+```

docs/docs/reference/docgen/javascript/storage/types/file-upload-machine.mdx

@@ -0,0 +1,10 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: FileUploadMachine
+sidebar_label: FileUploadMachine
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/machines/file-upload.ts#L35
+---
+
+# `FileUploadMachine`

docs/docs/reference/docgen/javascript/storage/types/file-upload-state.mdx

@@ -0,0 +1,68 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: FileUploadState
+sidebar_label: FileUploadState
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/promises/file-upload.ts#L38
+---
+
+# `FileUploadState`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">isError</span>** <span className="optional-status">required</span> `boolean`
+
+**`@returns`**
+
+`true` if an error occurred
+
+**`@depreacted`**
+
+use `!isSuccess` or `!!error` instead
+
+---
+
+**<span className="parameter-name">error</span>** <span className="optional-status">required</span> `null` | `ErrorPayload`
+
+Provides details about the error
+
+---
+
+**<span className="parameter-name">isUploading</span>** <span className="optional-status">required</span> `boolean`
+
+Returns `true` when the file is being uploaded.
+
+---
+
+**<span className="parameter-name">progress</span>** <span className="optional-status">required</span> `null` | `number`
+
+Returns the progress of the upload, from 0 to 100. Returns null if the upload has not started yet.
+
+---
+
+**<span className="parameter-name">isUploaded</span>** <span className="optional-status">required</span> `boolean`
+
+Returns `true` when the file has been successfully uploaded.
+
+---
+
+**<span className="parameter-name">id</span>** <span className="optional-status">optional</span> `string`
+
+Returns the id of the file.
+
+---
+
+**<span className="parameter-name">bucketId</span>** <span className="optional-status">optional</span> `string`
+
+Returns the bucket id.
+
+---
+
+**<span className="parameter-name">name</span>** <span className="optional-status">optional</span> `string`
+
+Returns the name of the file.
+
+---