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

chore: update versions

.github/actions/install-dependencies/action.yaml

@@ -0,0 +1,17 @@
+name: Install Node and package dependencies
+description: 'Install Node dependencies with pnpm'
+runs:
+  using: 'composite'
+  steps:
+    - uses: pnpm/action-setup@v2.2.1
+      with:
+        version: 6.32.14
+    - name: Use Node.js 16
+      uses: actions/setup-node@v2
+      with:
+        node-version: 16
+        cache: 'pnpm'
+    # * Install package dependencies. As cache is enabled, it will cache/restore downloaded files
+    - shell: bash
+      name: Install packages
+      run: pnpm install --frozen-lockfile

.github/workflows/tests.yaml

@@ -1,8 +1,4 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-# Poached from https://github.com/hayes/pothos/tree/main/.github/workflows, thanks to the original author
-
-name: Node.js CI
+name: Tests
 
 on:
   push:
@@ -10,61 +6,112 @@ on:
     paths-ignore:
       - 'docs/**'
       - 'templates/**'
-      - 'examples/**'
       - 'assets/**'
       - '**.md'
       - 'LICENSE'
   pull_request:
     branches: [main]
+    types: [opened, synchronize]
     paths-ignore:
       - 'docs/**'
       - 'templates/**'
-      - 'examples/**'
       - 'assets/**'
       - '**.md'
       - 'LICENSE'
 
+env:
+  TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
+  TURBO_TEAM: nhost
 jobs:
   build:
+    name: Build @nhost packages
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [14, 16]
     steps:
       - uses: actions/checkout@v2
-
-      - name: Install nhost CLI
-        run: curl -L https://raw.githubusercontent.com/nhost/cli/main/get.sh | bash
-
-      - name: Start Nhost Backend
+      # * Install Node and dependencies. Package downloads will be cached for the next jobs.
+      - name: Install Node and dependencies
+        uses: ./.github/actions/install-dependencies
+      # * Build all Nhost packages as they are all supposed to be tested.
+      # * They will be reused through the Turborepo cache
+      - name: Build packages
+        run: pnpm build
+      # * List packagesthat has an `e2e` script, except the root, and return an array of their name and path
+      - name: List examples with an e2e script
+        id: set-matrix
         run: |
-          cp -R examples/testing-project /tmp/
-          cd /tmp/testing-project
-          nhost dev &
-
-      - uses: pnpm/action-setup@v2.2.1
+          PACKAGES=$(pnpm recursive list --depth -1 --parseable --filter=!nhost-root \
+            | xargs -I@ jq "if (.scripts.e2e | length) != 0  then {name: .name, path: \"@\"} else null end" @/package.json \
+            | awk "!/null/" \
+            | jq -c --slurp)
+          echo "::set-output name=matrix::$PACKAGES"
+    outputs:
+      matrix: ${{ steps.set-matrix.outputs.matrix }}
+  e2e:
+    name: 'e2e: ${{ matrix.package.name }}'
+    needs: build
+    strategy:
+      # * Don't cancel other matrices when one fails
+      fail-fast: false
+      matrix:
+        package: ${{ fromJson(needs.build.outputs.matrix) }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      # * Install Nhost CLI if a `nhost/config.yaml` file is found
+      - name: Install Nhost CLI
+        if: hashFiles(format('{0}/nhost/config.yaml', matrix.package.path)) != ''
+        run: curl -L https://raw.githubusercontent.com/nhost/cli/main/get.sh | bash
+      # * Install Node and dependencies. Package dependencies won't be downloaded again as they have been cached by the `build` job.
+      - name: Install Node and dependencies
+        uses: ./.github/actions/install-dependencies
+      # * 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:
-          version: 6.32.3
-
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+          name: cypress-${{ steps.file-name.outputs.fileName }}
+          path: |
+            ${{format('{0}/cypress/screenshots/**', matrix.package.path)}}
+            ${{format('{0}/cypress/videos/**', matrix.package.path)}}
+  unit:
+    name: Unit tests
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      # * Install Node and dependencies. Package dependencies won't be downloaded again as they have been cached by the `build` job.
+      - name: Install Node and dependencies
+        uses: ./.github/actions/install-dependencies
+      # * Run every `test` script in the workspace . Dependencies build is cached by Turborepo
+      - name: Run unit tests
+        run: pnpm run test
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2
         with:
-          node-version: ${{ matrix.node-version }}
-          cache: 'pnpm'
-
-      - name: Cache turbo
-        uses: actions/cache@v2
-        with:
-          path: ./node_modules/.cache/turbo
-          key: turbo-${{ github.job }}-${{ github.ref_name }}-${{ github.sha }}
-          restore-keys: |
-            turbo-${{ github.job }}-${{ github.ref_name }}-
-
-      - name: Install dependencies
-        run: pnpm install
-
-      - name: Wait for Nhost
-        run: pnpm run wait
-
-      - name: Build, tests and lint
-        run: pnpm run ci
+          files: '**/coverage/coverage-final.json'
+          name: codecov-umbrella
+      - name: Create summary
+        run: |
+          echo '### Code coverage' >> $GITHUB_STEP_SUMMARY
+          echo 'Visit [codecov](https://app.codecov.io/gh/nhost/nhost/) to see the code coverage reports' >> $GITHUB_STEP_SUMMARY
+  lint:
+    name: Lint
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      # * Install Node and dependencies. Package dependencies won't be downloaded again as they have been cached by the `build` job.
+      - name: Install Node and dependencies
+        uses: ./.github/actions/install-dependencies
+      # * Run every `lint` script in the workspace . Dependencies build is cached by Turborepo
+      - name: Lint
+        run: pnpm run lint

.gitignore

@@ -53,4 +53,7 @@ todo.md
 
 # TypeDoc output
 
-.docgen
+.docgen
+
+# Nhost CLI data
+.nhost

DEVELOPERS.md

@@ -60,19 +60,24 @@ $ pnpm start
 
 ## Run test suites
 
-In order to run tests, the Nhost testing backend should be running locally. You can run it from a separate terminal:
+### Unit tests
 
-```sh
-$ cd examples/testing-project
-$ nhost -d
-```
-
-Once Nhost is started locally, you can run the tests with the following command from the repository root:
+You can run the unit tests with the following command from the repository root:
 
 ```sh
 $ pnpm test
 ```
 
+### End-to-end tests
+
+Each package that defines end-to-end tests embeds their own Nhost configuration, that will be automatically when running the tests. As a result, you must make sure you are not running the Nhost CLI before running the tests.
+
+You can run the e2e tests with the following command from the repository root:
+
+```sh
+$ pnpm e2e
+```
+
 ## Changesets
 
 If you've made changes to the packages, you must describe those changes so that they can be reflected in the next release.

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:
@@ -163,20 +168,20 @@ 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/subatuba21">
-            <img src="https://avatars.githubusercontent.com/u/34824571?v=4" width="100;" alt="subatuba21"/>
-            <br />
-            <sub><b>Subha Das</b></sub>
-        </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></tr>
+<tr>
+    <td align="center">
+        <a href="https://github.com/subatuba21">
+            <img src="https://avatars.githubusercontent.com/u/34824571?v=4" width="100;" alt="subatuba21"/>
+            <br />
+            <sub><b>Subha Das</b></sub>
+        </a>
     </td>
     <td align="center">
         <a href="https://github.com/sebagudelo">
@@ -192,6 +197,13 @@ Here are some ways of contributing to making Nhost better:
             <sub><b>Mrinal Wahal</b></sub>
         </a>
     </td>
+    <td align="center">
+        <a href="https://github.com/timpratim">
+            <img src="https://avatars.githubusercontent.com/u/32492961?v=4" width="100;" alt="timpratim"/>
+            <br />
+            <sub><b>Pratim</b></sub>
+        </a>
+    </td>
     <td align="center">
         <a href="https://github.com/FuzzyReason">
             <img src="https://avatars.githubusercontent.com/u/62517920?v=4" width="100;" alt="FuzzyReason"/>
@@ -205,15 +217,15 @@ Here are some ways of contributing to making Nhost better:
             <br />
             <sub><b>Macmac49</b></sub>
         </a>
-    </td>
+    </td></tr>
+<tr>
     <td align="center">
         <a href="https://github.com/subhendukundu">
             <img src="https://avatars.githubusercontent.com/u/20059141?v=4" width="100;" alt="subhendukundu"/>
             <br />
             <sub><b>Subhendu Kundu</b></sub>
         </a>
-    </td></tr>
-<tr>
+    </td>
     <td align="center">
         <a href="https://github.com/heygambo">
             <img src="https://avatars.githubusercontent.com/u/449438?v=4" width="100;" alt="heygambo"/>
@@ -248,6 +260,14 @@ Here are some ways of contributing to making Nhost better:
             <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">
@@ -255,8 +275,7 @@ Here are some ways of contributing to making Nhost better:
             <br />
             <sub><b>Jerry Jäppinen</b></sub>
         </a>
-    </td></tr>
-<tr>
+    </td>
     <td align="center">
         <a href="https://github.com/mustafa-hanif">
             <img src="https://avatars.githubusercontent.com/u/30019262?v=4" width="100;" alt="mustafa-hanif"/>
@@ -271,13 +290,6 @@ Here are some ways of contributing to making Nhost better:
             <sub><b>Nicolas Bourdin</b></sub>
         </a>
     </td>
-    <td align="center">
-        <a href="https://github.com/timpratim">
-            <img src="https://avatars.githubusercontent.com/u/32492961?v=4" width="100;" alt="timpratim"/>
-            <br />
-            <sub><b>Pratim</b></sub>
-        </a>
-    </td>
     <td align="center">
         <a href="https://github.com/Savinvadim1312">
             <img src="https://avatars.githubusercontent.com/u/16936043?v=4" width="100;" alt="Savinvadim1312"/>
@@ -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,7 +389,8 @@ Here are some ways of contributing to making Nhost better:
             <br />
             <sub><b>Max Reynolds</b></sub>
         </a>
-    </td>
+    </td></tr>
+<tr>
     <td align="center">
         <a href="https://github.com/ghoshnirmalya">
             <img src="https://avatars.githubusercontent.com/u/6391763?v=4" width="100;" alt="ghoshnirmalya"/>
@@ -384,8 +404,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"/>

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'

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/vite.lib.config.js

@@ -34,7 +34,11 @@ export default defineConfig({
     include: [`${PWD}/src/**/*.{spec,test}.{ts,tsx}`, `${PWD}/tests/**/*.{spec,test}.{ts,tsx}`],
     // Note: temporarily disabled threads, because of a bug in vitest
     // https://github.com/vitest-dev/vitest/issues/1171
-    threads: false
+    threads: false,
+    coverage: {
+      enabled: process.env.CI === 'true',
+      reporter: ['json']
+    }
   },
   build: {
     sourcemap: true,

docs/docs/platform/authentication/sign-in-methods/1-email-password.mdx

@@ -22,7 +22,7 @@ await nhost.auth.signUp({
 })
 ```
 
-If you've turned on email verification in your app's **login settings**, a user will be sent a verification email upon signup. The user must click the verification link in the email before they can sign in.
+If you've turned on email verification in your app's **Authentication Settings**, a user will be sent a verification email upon signup. The user must click the verification link in the email before they can sign in.
 
 ## Sign In
 
@@ -39,6 +39,6 @@ await nhost.auth.signIn({
 
 ## Verified Emails
 
-You can decide if only verified emails should be able to sign in or not. Modify the **Only allow login for verified emails.** setting in the **Login Settings** section under **Users** in your Nhost app.
+You can decide if only verified emails should be able to sign in or not. Modify the **Only allow login for verified emails.** setting in the **Authentication Settings** section under **Users** in your Nhost app.
 
 An email-verification email is automatically sent to the user during sign-up if your app only allows to sign in users with verified emails. You can also manually send the verification email to the user using [`nhost.auth.sendVerificationEmail()`](/reference/javascript/auth/send-verification-email).

docs/docs/platform/authentication/sign-in-methods/2-magic-link.mdx

@@ -11,7 +11,7 @@ The Magic Link sign-in method enables you to sign in users to your app using an
 
 ## Setup
 
-Enable the Magic Link sign-in method in the Nhost dashboard under **Users** -> **Login settings** -> **Magic Link**.
+Enable the Magic Link sign-in method in the Nhost dashboard under **Users** -> **Authentication Settings** -> **Magic Link**.
 
 ![Magic Link Setup with Nhost](/img/platform/authentication/sign-in-methods/magic-link/magic-link-setup.png)
 
@@ -30,4 +30,4 @@ nhost.auth.signIn({
 })
 ```
 
-If you want to change the email for your magic link emails, you can do so by changing the [email templates](/platform/authentication/email-templates).
+If you want to change the email for your magic link emails, you can do so by changing the [email templates](/platform/authentication/email-templates).

docs/docs/platform/authentication/sign-in-methods/3-phone-number.mdx

@@ -11,7 +11,7 @@ Follow this guide to sign in users with a phone number (SMS).
 
 You need a [Twilio account](https://www.twilio.com/try-twilio) to use this feature because all SMS are sent through Twilio.
 
-Enable the Phone Number (SMS) sign-in method in the Nhost dashboard under **Users** -> **Login settings** -> **Passwordless SMS**.
+Enable the Phone Number (SMS) sign-in method in the Nhost dashboard under **Users** -> **Authentication Settings** -> **Passwordless SMS**.
 
 You need to insert the following settings in the Nhost dashboard from Twilio:
 
@@ -19,11 +19,10 @@ You need to insert the following settings in the Nhost dashboard from Twilio:
 - Auth Token
 - Messaging Service SID (or a Twilio phone number)
 
-<video width="99%" autoPlay muted loop controls="true" style={{marginBottom: '15px'}}>
+<video width="99%" autoPlay muted loop controls="true" style={{ marginBottom: '15px' }}>
   <source src="/videos/enable-sms-sign-in.mp4" type="video/mp4" />
 </video>
 
-
 ## Sign In
 
 To sign in users with a phone number is a two-step process:
@@ -53,7 +52,6 @@ Phone numbers should start with `+` (not `00`) to follow the [E.164 formatting s
 
 :::
 
-
 ## Other SMS Providers
 
-We only support Twilio for now. If you want support for another SMS provider, please create an issue on [GitHub](https://github.com/nhost/nhost).
+We only support Twilio for now. If you want support for another SMS provider, please create an issue on [GitHub](https://github.com/nhost/nhost).

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

@@ -17,7 +17,7 @@ Nhost Authentication support the following sign-in methods:
 
 ## Enabling Social Sign-In Provider
 
-To start with social sign-in, select your app in Nhost Console and go to **Users** → **Login settings**.
+To start with social sign-in, select your app in Nhost Console and go to **Users** → **Authentication Settings**.
 
 You need to set the Client ID and Client Secret for each provider that you want to enable.
 
@@ -33,7 +33,7 @@ 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** → **Login settings** → **Client URL**.
+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**.
 
 ## Provider OAuth scopes
 

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

@@ -41,6 +41,12 @@ The following dependencies are required:
 - [Git](https://git-scm.com/downloads)
 - [Docker](https://www.docker.com/get-started) (must be running while using the CLI)
 
+:::info
+
+Make sure you have the correct permissions for Docker so you don't have to run Docker with `sudo`. See ["Post-installation steps for Linux"](https://docs.docker.com/engine/install/linux-postinstall/) from Docker's documentation.
+
+:::
+
 ## Get started
 
 Start by authenticating yourself to Nhost Cloud:
@@ -75,6 +81,18 @@ nhost up
 
 Hasura Console starts automatically and your Nhost app is running locally with the backend URL: `http://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.
+
+For the example below, all emails are accessable at `http://localhost:8839`.
+
+```bash
+$ nhost up
+✔ Your app is running at http://localhost:1337 (Ctrl+C to stop)
+ℹ Emails will be sent to http://localhost:8839
+```
+
 ## What's next?
 
 - Read our in-depth guide on [Get started with Nhost CLI](/platform/overview/get-started-with-nhost-cli)

docs/docs/platform/database/event-triggers.mdx

@@ -18,7 +18,7 @@ Event Triggers can also be triggered manually in the Hasura Console.
 
 Let's say you're building an e-commerce application and you want to send an email to the customer when a new order is placed. Orders are stored in the `orders` table in your database.
 
-To send out an email every time a new order is placed, you create an event trigger that listens for the `INSERT` event on the `orders` table. Now every time an order is placed, the even trigger invokes a webhook with the order information, and the webhook sends out the email.
+To send out an email every time a new order is placed, you create an event trigger that listens for the `INSERT` event on the `orders` table. Now every time an order is placed, the event trigger invokes a webhook with the order information, and the webhook sends out the email.
 
 ## Create Event Trigger
 

docs/docs/platform/database/index.mdx

@@ -15,13 +15,16 @@ It's currently not possible to connect directly to the Postgres database via a c
 
 :::
 
-The database is managed via the Hasura Console where you can manage the database via an intuative UI. You can also use SQL to directly interact with the database via the Hasura Console.
+The database is managed via the Hasura Console where you can manage the database via an intuitive UI. You can also use SQL to directly interact with the database via the Hasura Console.
 
 ## Hasura Console
 
 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" />

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/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#L102
 ---
 
 # `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#L145
 ---
 
 # `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#L256
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L230
 ---
 
 # `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#L272
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L246
 ---
 
 # `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#L288
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L262
 ---
 
 # `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#L304
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L278
 ---
 
 # `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#L323
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L297
 ---
 
 # `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#L339
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L313
 ---
 
 # `deanonymize()`
@@ -24,13 +24,4 @@ nhost.auth.deanonymize({
 
 **<span className="parameter-name">params</span>** <span className="optional-status">required</span> [`DeanonymizeParams`](/reference/docgen/javascript/auth/types/deanonymize-params)
 
-| Property                                                                                        | Type                                   | Required | Notes |
-| :---------------------------------------------------------------------------------------------- | :------------------------------------- | :------: | :---- |
-| <span className="parameter-name"><span className="light-grey">params.</span>email</span>        | `string`                               |    ✔️    |       |
-| <span className="parameter-name"><span className="light-grey">params.</span>signInMethod</span> | `"email-password"` \| `"passwordless"` |    ✔️    |       |
-| <span className="parameter-name"><span className="light-grey">params.</span>allowedRoles</span> | `Array<string>`                        |          |       |
-| <span className="parameter-name"><span className="light-grey">params.</span>defaultRole</span>  | `string`                               |          |       |
-| <span className="parameter-name"><span className="light-grey">params.</span>connection</span>   | `"email"` \| `"sms"`                   |          |       |
-| <span className="parameter-name"><span className="light-grey">params.</span>password</span>     | `string`                               |          |       |
-
 ---

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

@@ -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#L373
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L356
 ---
 
 # `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#L408
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L391
 ---
 
 # `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#L450
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L433
 ---
 
 # `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#L468
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L451
 ---
 
 # `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#L494
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L477
 ---
 
 # `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#L524
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L507
 ---
 
 # `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#L539
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L522
 ---
 
 # `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#L556
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L539
 ---
 
 # `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#L574
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L557
 ---
 
 # `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#L597
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L580
 ---
 
 # `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#L641
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L624
 ---
 
 # `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#L656
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L639
 ---
 
 # `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/api-change-email-response.mdx

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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#L125
+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#L127
+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,35 +4,20 @@ 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#L105
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L110
 ---
 
 # `DeanonymizeParams`
 
-## Parameters
-
----
-
-**<span className="parameter-name">email</span>** <span className="optional-status">required</span> `string`
-
----
-
-**<span className="parameter-name">signInMethod</span>** <span className="optional-status">required</span> `"email-password"` | `"passwordless"`
-
----
-
-**<span className="parameter-name">allowedRoles</span>** <span className="optional-status">optional</span> `Array<string>`
-
----
-
-**<span className="parameter-name">defaultRole</span>** <span className="optional-status">optional</span> `string`
-
----
-
-**<span className="parameter-name">connection</span>** <span className="optional-status">optional</span> `"email"` | `"sms"`
-
----
-
-**<span className="parameter-name">password</span>** <span className="optional-status">optional</span> `string`
-
----
+```ts
+type DeanonymizeParams =
+  | ({ signInMethod: 'email-password' } & SignUpParams)
+  | ({
+      signInMethod: 'passwordless'
+      connection: 'email'
+    } & SignInPasswordlessEmailParams)
+  | ({
+      signInMethod: 'passwordless'
+      connection: 'sms'
+    } & SignInPasswordlessSmsParams)
+```

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

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

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

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

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#L129
+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/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#L131
+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#L114
+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#L9
 ---
 
 # `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/nextjs/content/nhost-client/index.mdx

@@ -4,7 +4,7 @@ title: NhostClient
 sidebar_label: NhostClient
 description: No description provided.
 slug: /reference/nextjs/nhost-client
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nextjs/src/index.ts#L17
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nextjs/src/index.ts#L30
 ---
 
 # `NhostClient`
@@ -15,13 +15,15 @@ custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nextjs/src/in
 
 **<span className="parameter-name">params</span>** <span className="optional-status">required</span> [`NhostNextClientConstructorParams`](/reference/docgen/nextjs/types/nhost-next-client-constructor-params)
 
-| Property                                                                                               | Type      | Required | Notes                                                                                                                                |
-| :----------------------------------------------------------------------------------------------------- | :-------- | :------: | :----------------------------------------------------------------------------------------------------------------------------------- |
-| <span className="parameter-name"><span className="light-grey">params.</span>backendUrl</span>          | `string`  |    ✔️    | Nhost backend URL.                                                                                                                   |
-| <span className="parameter-name"><span className="light-grey">params.</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">params.</span>devTools</span>            | `boolean` |          | Activate devTools e.g. the ability to connect to the xstate inspector                                                                |
-| <span className="parameter-name"><span className="light-grey">params.</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">params.</span>autoRefreshToken</span>    | `boolean` |          | When set to true, will automatically refresh token before it expires                                                                 |
-| <span className="parameter-name"><span className="light-grey">params.</span>refreshIntervalTime</span> | `number`  |          | Time interval until token refreshes, in seconds                                                                                      |
+| Property                                                                                               | Type      | Required | Notes                                                                                                                         |
+| :----------------------------------------------------------------------------------------------------- | :-------- | :------: | :---------------------------------------------------------------------------------------------------------------------------- |
+| <span className="parameter-name"><span className="light-grey">params.</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">params.</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">params.</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">params.</span>backendUrl</span>          | `string`  |          | Nhost backend URL Should only be used when self-hosting                                                                       |
+| <span className="parameter-name"><span className="light-grey">params.</span>devTools</span>            | `boolean` |          | Activate devTools e.g. the ability to connect to the xstate inspector                                                         |
+| <span className="parameter-name"><span className="light-grey">params.</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">params.</span>autoRefreshToken</span>    | `boolean` |          | When set to true, will automatically refresh token before it expires                                                          |
+| <span className="parameter-name"><span className="light-grey">params.</span>refreshIntervalTime</span> | `number`  |          | Time interval until token refreshes, in seconds                                                                               |
 
 ---

docs/docs/reference/docgen/nextjs/content/use-sign-in-anonymous.mdx

@@ -3,8 +3,26 @@
 title: useSignInAnonymous()
 sidebar_label: useSignInAnonymous()
 slug: /reference/nextjs/use-sign-in-anonymous
-description: No description provided.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/useSignInAnonymous.ts#L9
+description: Use the hook `useSignInAnonymous` to sign in a user anonymously.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/useSignInAnonymous.ts#L27
 ---
 
 # `useSignInAnonymous()`
+
+Use the hook `useSignInAnonymous` to sign in a user anonymously.
+
+As a result, the user will have the `anonymous` role and subsequent set of permissions.
+The user can then be converted to a regular user at a later stage using email+password sign-up, passwordless email (magic link), or passwordless SMS.
+
+```tsx
+const { signInAnonymous, isLoading, isSuccess, isError, error } =
+  useSignInAnonymous()
+
+console.log({ isLoading, isSuccess, isError, error })
+
+const handleFormSubmit = async (e) => {
+  e.preventDefault()
+
+  await signInAnonymous()
+}
+```

docs/docs/reference/docgen/nextjs/content/use-sign-in-email-password.mdx

@@ -4,7 +4,7 @@ title: useSignInEmailPassword()
 sidebar_label: useSignInEmailPassword()
 slug: /reference/nextjs/use-sign-in-email-password
 description: Use the hook `useSignInEmailPassword` to sign in a user using email and password.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/useSignInEmailPassword.ts#L49
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/useSignInEmailPassword.ts#L54
 ---
 
 # `useSignInEmailPassword()`

docs/docs/reference/docgen/nextjs/types/nhost-next-client-constructor-params.mdx

@@ -4,7 +4,7 @@ title: NhostNextClientConstructorParams
 sidebar_label: NhostNextClientConstructorParams
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nextjs/src/index.ts#L11
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nextjs/src/index.ts#L16
 ---
 
 # `NhostNextClientConstructorParams`
@@ -13,16 +13,32 @@ custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/nextjs/src/in
 
 ---
 
-**<span className="parameter-name">backendUrl</span>** <span className="optional-status">required</span> `string`
+**<span className="parameter-name">region</span>** <span className="optional-status">optional</span> `string`
 
-Nhost backend URL.
+App region (e.g., eu-central-1)
+Not required in development (when `subdomain` is "localhost")
+
+---
+
+**<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">adminSecret</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.
+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">backendUrl</span>** <span className="optional-status">optional</span> `string`
+
+Nhost backend URL
+Should only be used when self-hosting
 
 ---
 

docs/docs/reference/docgen/nextjs/types/nhost-react-client-constructor-params.mdx

@@ -4,7 +4,7 @@ title: NhostReactClientConstructorParams
 sidebar_label: NhostReactClientConstructorParams
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/client.ts#L3
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/client.ts#L5
 ---
 
 # `NhostReactClientConstructorParams`
@@ -65,15 +65,31 @@ Activate devTools e.g. the ability to connect to the xstate inspector
 
 ---
 
-**<span className="parameter-name">backendUrl</span>** <span className="optional-status">required</span> `string`
+**<span className="parameter-name">backendUrl</span>** <span className="optional-status">optional</span> `string`
 
-Nhost backend URL.
+Nhost backend URL
+Should only be used when self-hosting
 
 ---
 
 **<span className="parameter-name">adminSecret</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.
+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/nextjs/types/sign-in-email-password-hook-result.mdx

@@ -4,7 +4,7 @@ title: SignInEmailPasswordHookResult
 sidebar_label: SignInEmailPasswordHookResult
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/useSignInEmailPassword.ts#L19
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/useSignInEmailPassword.ts#L24
 ---
 
 # `SignInEmailPasswordHookResult`

docs/docs/reference/docgen/react/content/nhost-client/index.mdx

@@ -4,7 +4,7 @@ title: NhostClient
 sidebar_label: NhostClient
 description: No description provided.
 slug: /reference/react/nhost-client
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/client.ts#L6
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/client.ts#L10
 ---
 
 # `NhostClient`
@@ -15,15 +15,17 @@ custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/cli
 
 **<span className="parameter-name">params</span>** <span className="optional-status">required</span> [`NhostReactClientConstructorParams`](/reference/docgen/react/types/nhost-react-client-constructor-params)
 
-| Property                                                                                               | Type                | Required | Notes                                                                                                                                |
-| :----------------------------------------------------------------------------------------------------- | :------------------ | :------: | :----------------------------------------------------------------------------------------------------------------------------------- |
-| <span className="parameter-name"><span className="light-grey">params.</span>backendUrl</span>          | `string`            |    ✔️    | Nhost backend URL.                                                                                                                   |
-| <span className="parameter-name"><span className="light-grey">params.</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">params.</span>devTools</span>            | `boolean`           |          | Activate devTools e.g. the ability to connect to the xstate inspector                                                                |
-| <span className="parameter-name"><span className="light-grey">params.</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">params.</span>autoRefreshToken</span>    | `boolean`           |          | When set to true, will automatically refresh token before it expires                                                                 |
-| <span className="parameter-name"><span className="light-grey">params.</span>clientStorage</span>       | `ClientStorage`     |          | Object where the refresh token will be persisted and read locally.                                                                   |
-| <span className="parameter-name"><span className="light-grey">params.</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">params.</span>refreshIntervalTime</span> | `number`            |          | Time interval until token refreshes, in seconds                                                                                      |
+| Property                                                                                               | Type                | Required | Notes                                                                                                                         |
+| :----------------------------------------------------------------------------------------------------- | :------------------ | :------: | :---------------------------------------------------------------------------------------------------------------------------- |
+| <span className="parameter-name"><span className="light-grey">params.</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">params.</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">params.</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">params.</span>backendUrl</span>          | `string`            |          | Nhost backend URL Should only be used when self-hosting                                                                       |
+| <span className="parameter-name"><span className="light-grey">params.</span>devTools</span>            | `boolean`           |          | Activate devTools e.g. the ability to connect to the xstate inspector                                                         |
+| <span className="parameter-name"><span className="light-grey">params.</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">params.</span>autoRefreshToken</span>    | `boolean`           |          | When set to true, will automatically refresh token before it expires                                                          |
+| <span className="parameter-name"><span className="light-grey">params.</span>clientStorage</span>       | `ClientStorage`     |          | Object where the refresh token will be persisted and read locally.                                                            |
+| <span className="parameter-name"><span className="light-grey">params.</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">params.</span>refreshIntervalTime</span> | `number`            |          | Time interval until token refreshes, in seconds                                                                               |
 
 ---

docs/docs/reference/docgen/react/content/use-sign-in-anonymous.mdx

@@ -3,8 +3,26 @@
 title: useSignInAnonymous()
 sidebar_label: useSignInAnonymous()
 slug: /reference/react/use-sign-in-anonymous
-description: No description provided.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/useSignInAnonymous.ts#L9
+description: Use the hook `useSignInAnonymous` to sign in a user anonymously.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/useSignInAnonymous.ts#L27
 ---
 
 # `useSignInAnonymous()`
+
+Use the hook `useSignInAnonymous` to sign in a user anonymously.
+
+As a result, the user will have the `anonymous` role and subsequent set of permissions.
+The user can then be converted to a regular user at a later stage using email+password sign-up, passwordless email (magic link), or passwordless SMS.
+
+```tsx
+const { signInAnonymous, isLoading, isSuccess, isError, error } =
+  useSignInAnonymous()
+
+console.log({ isLoading, isSuccess, isError, error })
+
+const handleFormSubmit = async (e) => {
+  e.preventDefault()
+
+  await signInAnonymous()
+}
+```

docs/docs/reference/docgen/react/content/use-sign-in-email-password.mdx

@@ -4,7 +4,7 @@ title: useSignInEmailPassword()
 sidebar_label: useSignInEmailPassword()
 slug: /reference/react/use-sign-in-email-password
 description: Use the hook `useSignInEmailPassword` to sign in a user using email and password.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/useSignInEmailPassword.ts#L49
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/useSignInEmailPassword.ts#L54
 ---
 
 # `useSignInEmailPassword()`

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

@@ -4,7 +4,7 @@ title: NhostReactClientConstructorParams
 sidebar_label: NhostReactClientConstructorParams
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/client.ts#L3
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/client.ts#L5
 ---
 
 # `NhostReactClientConstructorParams`
@@ -13,16 +13,32 @@ custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/cli
 
 ---
 
-**<span className="parameter-name">backendUrl</span>** <span className="optional-status">required</span> `string`
+**<span className="parameter-name">region</span>** <span className="optional-status">optional</span> `string`
 
-Nhost backend URL.
+App region (e.g., eu-central-1)
+Not required in development (when `subdomain` is "localhost")
+
+---
+
+**<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">adminSecret</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.
+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">backendUrl</span>** <span className="optional-status">optional</span> `string`
+
+Nhost backend URL
+Should only be used when self-hosting
 
 ---
 

docs/docs/reference/docgen/react/types/sign-in-email-password-hook-result.mdx

@@ -4,7 +4,7 @@ title: SignInEmailPasswordHookResult
 sidebar_label: SignInEmailPasswordHookResult
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/useSignInEmailPassword.ts#L19
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/useSignInEmailPassword.ts#L24
 ---
 
 # `SignInEmailPasswordHookResult`

docs/docs/reference/docgen/vue/content/nhost-client/index.mdx

@@ -4,7 +4,7 @@ title: NhostClient
 sidebar_label: NhostClient
 description: No description provided.
 slug: /reference/vue/nhost-client
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/vue/src/client.ts#L10
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/vue/src/client.ts#L18
 ---
 
 # `NhostClient`
@@ -15,15 +15,17 @@ custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/vue/src/clien
 
 **<span className="parameter-name">params</span>** <span className="optional-status">required</span> [`NhostVueClientConstructorParams`](/reference/docgen/vue/types/nhost-vue-client-constructor-params)
 
-| Property                                                                                               | Type                | Required | Notes                                                                                                                                |
-| :----------------------------------------------------------------------------------------------------- | :------------------ | :------: | :----------------------------------------------------------------------------------------------------------------------------------- |
-| <span className="parameter-name"><span className="light-grey">params.</span>backendUrl</span>          | `string`            |    ✔️    | Nhost backend URL.                                                                                                                   |
-| <span className="parameter-name"><span className="light-grey">params.</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">params.</span>devTools</span>            | `boolean`           |          | Activate devTools e.g. the ability to connect to the xstate inspector                                                                |
-| <span className="parameter-name"><span className="light-grey">params.</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">params.</span>autoRefreshToken</span>    | `boolean`           |          | When set to true, will automatically refresh token before it expires                                                                 |
-| <span className="parameter-name"><span className="light-grey">params.</span>clientStorage</span>       | `ClientStorage`     |          | Object where the refresh token will be persisted and read locally.                                                                   |
-| <span className="parameter-name"><span className="light-grey">params.</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">params.</span>refreshIntervalTime</span> | `number`            |          | Time interval until token refreshes, in seconds                                                                                      |
+| Property                                                                                               | Type                | Required | Notes                                                                                                                         |
+| :----------------------------------------------------------------------------------------------------- | :------------------ | :------: | :---------------------------------------------------------------------------------------------------------------------------- |
+| <span className="parameter-name"><span className="light-grey">params.</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">params.</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">params.</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">params.</span>backendUrl</span>          | `string`            |          | Nhost backend URL Should only be used when self-hosting                                                                       |
+| <span className="parameter-name"><span className="light-grey">params.</span>devTools</span>            | `boolean`           |          | Activate devTools e.g. the ability to connect to the xstate inspector                                                         |
+| <span className="parameter-name"><span className="light-grey">params.</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">params.</span>autoRefreshToken</span>    | `boolean`           |          | When set to true, will automatically refresh token before it expires                                                          |
+| <span className="parameter-name"><span className="light-grey">params.</span>clientStorage</span>       | `ClientStorage`     |          | Object where the refresh token will be persisted and read locally.                                                            |
+| <span className="parameter-name"><span className="light-grey">params.</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">params.</span>refreshIntervalTime</span> | `number`            |          | Time interval until token refreshes, in seconds                                                                               |
 
 ---

docs/docs/reference/docgen/vue/content/use-reset-password.mdx

@@ -12,7 +12,9 @@ custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/vue/src/useRe
 Use the composable `useResetPassword` to reset the password for a user. This will send a reset password link in an email to the user. When the user clicks on the reset-password link the user is automatically signed in and can change their password using the composable `useChangePassword`.
 
 ```tsx
-const { resetPassword, isLoading, isSent, isError, error } = useResetPassword()
+const { resetPassword, isLoading, isSent, isError, error } = useResetPassword({
+  redirectTo: 'http://localhost:3000/settings/change-password'
+})
 
 watchEffect(() => {
   console.log(isLoading.value, isSent.value, isError.value, error.value)
@@ -21,9 +23,7 @@ watchEffect(() => {
 const handleFormSubmit = async (e) => {
   e.preventDefault()
 
-  await resetPassword('joe@example.com', {
-    redirectTo: 'http://localhost:3000/settings/change-password'
-  })
+  await resetPassword('joe@example.com')
 }
 ```
 

docs/docs/reference/docgen/vue/content/use-sign-in-anonymous.mdx

@@ -0,0 +1,30 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: useSignInAnonymous()
+sidebar_label: useSignInAnonymous()
+slug: /reference/vue/use-sign-in-anonymous
+description: Use the composable `useSignInAnonymous` to sign in a user anonymously.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/vue/src/useSignInAnonymous.ts#L31
+---
+
+# `useSignInAnonymous()`
+
+Use the composable `useSignInAnonymous` to sign in a user anonymously.
+
+As a result, the user will have the `anonymous` role and subsequent set of permissions.
+The user can then be converted to a regular user at a later stage using email+password sign-up, passwordless email (magic link), or passwordless SMS.
+
+```tsx
+const { signInAnonymous, isLoading, isSuccess, isError, error } =
+  useSignInAnonymous()
+
+watchEffect(() => {
+  console.log(isLoading.value, isSuccess.value, isError.value, error.value)
+})
+
+const handleFormSubmit = async (e) => {
+  e.preventDefault()
+
+  await signInAnonymous()
+}
+```

docs/docs/reference/docgen/vue/content/use-sign-in-email-password.mdx

@@ -4,7 +4,7 @@ title: useSignInEmailPassword()
 sidebar_label: useSignInEmailPassword()
 slug: /reference/vue/use-sign-in-email-password
 description: Use the composable `useSignInEmailPassword` to sign in a user using email and password.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/vue/src/useSignInEmailPassword.ts#L44
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/vue/src/useSignInEmailPassword.ts#L46
 ---
 
 # `useSignInEmailPassword()`

docs/docs/reference/docgen/vue/content/use-sign-out.mdx

@@ -4,9 +4,20 @@ title: useSignOut()
 sidebar_label: useSignOut()
 slug: /reference/vue/use-sign-out
 description: Use the composable `useSignOut` to sign out the user.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/vue/src/useSignOut.ts#L14
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/vue/src/useSignOut.ts#L27
 ---
 
 # `useSignOut()`
 
 Use the composable `useSignOut` to sign out the user.
+
+```jsx
+import { useSignOut } from '@nhost/vue'
+
+const { signOut, isSuccess } = useSignOut()
+
+const handleSignOut = async (e) => {
+  e.preventDefault()
+  await signOut()
+}
+```

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

@@ -4,7 +4,7 @@ title: NhostVueClientConstructorParams
 sidebar_label: NhostVueClientConstructorParams
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/vue/src/client.ts#L7
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/vue/src/client.ts#L13
 ---
 
 # `NhostVueClientConstructorParams`
@@ -13,16 +13,32 @@ custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/vue/src/clien
 
 ---
 
-**<span className="parameter-name">backendUrl</span>** <span className="optional-status">required</span> `string`
+**<span className="parameter-name">region</span>** <span className="optional-status">optional</span> `string`
 
-Nhost backend URL.
+App region (e.g., eu-central-1)
+Not required in development (when `subdomain` is "localhost")
+
+---
+
+**<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">adminSecret</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.
+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">backendUrl</span>** <span className="optional-status">optional</span> `string`
+
+Nhost backend URL
+Should only be used when self-hosting
 
 ---
 

docs/docs/reference/hasura-auth/_category_.json

@@ -1,4 +0,0 @@
-{
-  "label": "Hasura Auth",
-  "position": 5
-}

docs/docs/reference/hasura-auth/api-reference.mdx

@@ -1,8 +0,0 @@
----
-title: 'API Reference'
-sidebar_position: 5
----
-
-import { Swagger } from '@site/src/components/Swagger';
-
-<Swagger spec="hasura-auth.json" />

docs/docs/reference/hasura-auth/configuration.md

@@ -1,222 +0,0 @@
----
-title: Configuration
-sidebar_position: 2
----
-
-## Email configuration
-
-Hasura Auth automatically sends transactional emails to manage the following operations:
-
-- Sign up
-- Password reset
-- Email change
-- Passwordless with emails
-
-### SMTP settings
-
-```bash
-AUTH_SMTP_HOST=smtp.example.com
-AUTH_SMTP_PORT=1025
-AUTH_SMTP_USER=user
-AUTH_SMTP_PASS=password
-AUTH_SMTP_SENDER=hasura-auth@example.com
-```
-
-See the [environment variables](/reference/hasura-auth/environment-variables) for additional information about how to connnect to an SMTP server.
-
-### Email templates
-
-You can create your own templates to customize the emails that will be sent to the users. You can have a look at the [official email templates](https://github.com/nhost/hasura-auth/tree/main/email-templates) to understand how they are structured.
-
-#### With Docker
-
-When using Docker, you can mount your own email templates from the local file system. You can have a look at this [docker-compose example](https://github.com/nhost/hasura-auth/blob/16df3e84b6c9a4f888b2ff07bd85afc34f8ed051/docker-compose-example.yaml#L41) to see how to set it up.
-
-#### Remote email templates
-
-When running Hasura Auth in its own infrastructure, it is possible to mount a volume with custom `email-templates` directory. However, in some cases, we may want to fetch templates from an external HTTP endpoint. Hence the introduction of a new `AUTH_EMAIL_TEMPLATE_FETCH_URL` environment variable:
-
-```bash
-AUTH_EMAIL_TEMPLATE_FETCH_URL=https://github.com/nhost/nhost/tree/custom-email-templates-example/examples/custom-email-templates
-```
-
-In the above example, on every email creation, the server will use this URL to fetch its templates, depending on the locale, email type and field.
-
-For instance, the template for english verification email body will the fetched in [https://raw.githubusercontent.com/nhost/nhost/main/examples/custom-email-templates/en/email-verify/body.html](https://raw.githubusercontent.com/nhost/nhost/main/examples/custom-email-templates/en/email-verify/body.html).
-
-See the [example in the main nhost/nhost repository](https://github.com/nhost/nhost/tree/main/examples/custom-email-templates).
-
-The context variables in email templates have been simplified: the `${link}` variable contains the entire redirection url the recipient needs to follow.
-
----
-
-## Redirections
-
-Some authentication operations redirects the users to the frontend application:
-
-- After an OAuth provider completes or fails authentication, the user is redirected to the frontend
-- Every email sent to the user (passwordless with email, password/email change, password reset) contains a link, that redirects the user to the frontend
-
-In order to achieve that, you need to set the `AUTH_CLIENT_URL` environment variable, for instance:
-
-```bash
-AUTH_CLIENT_URL=https://my-app.vercel.com
-```
-
----
-
-## Email + password authentication
-
-### Email checks
-
-You can specify a list of allowed emails or domains with `AUTH_ACCESS_CONTROL_ALLOWED_EMAILS` and `AUTH_ACCESS_CONTROL_ALLOWED_EMAIL_DOMAINS`.
-
-As an example, the following environment variables will only allow `@nhost.io`, `@example.com` and `bob@smith.com` to register to the application:
-
-```bash
-AUTH_ACCESS_CONTROL_ALLOWED_EMAILS=bob@smith.com
-AUTH_ACCESS_CONTROL_ALLOWED_EMAIL_DOMAINS=nhost.io,example.com
-```
-
-In the above example, users with the following emails would be able to register `bob@smith.com`, `emma@example.com`, `john@nhost.io`, whereas `mary@firebase.com` won't.
-
-Similarly, it is possible to provide a list of forbidden emails or domains with `AUTH_ACCESS_CONTROL_BLOCKED_EMAILS` and `AUTH_ACCESS_CONTROL_BLOCKED_EMAIL_DOMAINS`.
-
-### Password checks
-
-Hasura auth does not accepts passwords with less than three characters. This limit can be changed in changing the `AUTH_PASSWORD_MIN_LENGTH` environment variable.
-
-It is also possible to only allow [passwords that have not been pwned](https://haveibeenpwned.com/) in setting `AUTH_PASSWORD_HIBP_ENABLED` to `true`.
-
-<!-- TODO ### Change -->
-<!-- TODO ### Reset email -->
-
-<!-- TODO ### Reset password -->
-
-<!-- ---
-TODO ## Anonymous users -->
-
----
-
-## Multi-factor authentication
-
-Hasura Auth supports different types of Multi-Factor Authentication (MFA): passwordless with emails (magic links), passwordless with SMS, and Time-based one-time passwords.
-
-### Passwordless with emails (magic links)
-
-Hasura Auth supports email [passwordless authentication](https://en.wikipedia.org/wiki/Passwordless_authentication). It requires [SMTP](#email-configuration) to be configured properly.
-
-Set `AUTH_EMAIL_PASSWORDLESS_ENABLED` to `true` to enable passwordless authentication.
-
-<!-- TODO ### Passwordless with SMS -->
-
-### Time-based one-time password (TOTP)
-
-It is possible to add a step to authentication with email and password authentication. Once users registered, they can activate MFA TOTP:
-
-1. Users generate a QR Code, that is then scanned in an authentication app such as [Authy](https://authy.com/) or [Google Authenticator](https://en.wikipedia.org/wiki/Google_Authenticator).
-2. They then send the TOTP code to Hasura Auth. MFA is now activated
-3. Next time they authenticate, Hasura Auth will first expect their email and password, but then, instead of completing authentication, Hasura Auth will expect the TOTP in order to return the refresh and the access tokens.
-
-In order for users to be able to activate MFA TOTP, `AUTH_MFA_ENABLED` must be set to `true`.
-
-<!-- ---
-
-TODO ## OAuth authentication -->
-
----
-
-## Gravatar
-
-Hasura Auth stores the avatar URL of users in `auth.users.avatar_url`. By default, it will look for the Gravatar linked to the email, and store it into this field.
-It is possible to deactivate the use of Gravatar in setting the `AUTH_GRAVATAR_ENABLED` environment variable to `false`.
-
----
-
-## Extending user schema
-
-Adding columns to the user tables may be tempting. However, all the tables and columns have a specific purpose, and changing the structure of the `auth` schema will very likely end in breaking the functionning of Hasura Auth. It's, therefore, **highly recommended** not to modify the database schema for any tables in the `auth` schema.
-
-Instead, we recommend adding extra user information in the following ways:
-
-- to store information in the `auth.users.metadata` column
-- to store information in a separate table located in the `public` PostgreSQL schema, and to point to `auth.users.id` through a foreign key.
-
-### `metadata` user field
-
-The `auth.users.metadata` field is a JSON column, that can be used as an option on registration:
-
-```json
-{
-  "email": "bob@bob.com",
-  "passord": "12345678",
-  "options": {
-    "metadata": {
-      "first_name": "Bob"
-    }
-  }
-}
-```
-
-### Additional user information in the `public` schema
-
-As previously explained, the alteration of the `auth` schema may seriously hamper the functionning of Hasura Auth. The `metadata` field in the `auth.users` table may tackle some use cases, but in some other cases, we want to keep a certain level of structure in the way data is structured.
-
-In that case, it is possible to create a dedicated table in the `public` schema, with a `user_id` foreign key column that would point to the `auth.users.id` column. It is then possible to add an Hasura object relationship that would join the two tables together.
-
-<!-- TODO hooks on the metadata field -->
-
----
-
-## Custom Hasura JWT claims
-
-Hasura comes with a [powerful authorisation system](https://hasura.io/docs/latest/graphql/core/auth/authorization/index.html). Hasura Auth is already configured to add `x-hasura-user-id`, `x-hasura-allowed-roles`, and `x-hasura-user-isAnonymous` to the JSON Web Tokens it generates.
-
-In Hasura Auth, it is possible to define custom claims to add to the JWT, so they can be used by Hasura to determine the permissions of the received GraphQL operation.
-
-Each custom claim is defined by a pair of a key and a value:
-
-- The key determines the name of the claim, prefixed by `x-hasura`. For instance, `organisation-id` will become `x-hasura-organisation-id`.
-- The value is a representation of the path to look at to determine the value of the claim. For instance `profile.organisation.id` will look for the `user.profile` Hasura relationship, and the `profile.organisation` Hasura relationship. Array values are transformed into Postgres syntax so Hasura can interpret them. See the official Hasura documentation to understand the [session variables format](https://hasura.io/docs/latest/graphql/core/auth/authorization/roles-variables.html#format-of-session-variables).
-
-```bash
-AUTH_JWT_CUSTOM_CLAIMS={"organisation-id":"profile.organisation.id", "project-ids":"profile.contributesTo.project.id"}
-```
-
-Will automatically generate and fetch the following GraphQL query:
-
-```graphql
-{
-  user(id: "<user-id>") {
-    profile {
-      organisation {
-        id
-      }
-      contributesTo {
-        project {
-          id
-        }
-      }
-    }
-  }
-}
-```
-
-It will then use the same expressions e.g. `profile.contributesTo.project.id` to evaluate the result with [JSONata](https://jsonata.org/), and possibly transform arrays into Hasura-readable, PostgreSQL arrays.Finally, it adds the custom claims to the JWT in the `https://hasura.io/jwt/claims` namespace:
-
-```json
-{
-  "https://hasura.io/jwt/claims": {
-    "x-hasura-organisation-id": "8bdc4f57-7d64-4146-a663-6bcb05ea2ac1",
-    "x-hasura-project-ids": "{\"3af1b33f-fd0f-425e-92e2-0db09c8b2e29\",\"979cb94c-d873-4d5b-8ee0-74527428f58f\"}",
-    "x-hasura-allowed-roles": [ "me", "user" ],
-    "x-hasura-default-role": "user",
-    "x-hasura-user-id": "121bbea4-908e-4540-ac5d-52c7f6f93bec",
-    "x-hasura-user-isAnonymous": "false"
-  }
-  "sub": "f8776768-4bbd-46f8-bae1-3c40da4a89ff",
-  "iss": "hasura-auth",
-  "iat": 1643040189,
-  "exp": 1643041089
-}
-```

docs/docs/reference/hasura-auth/environment-variables.md

@@ -1,107 +0,0 @@
----
-title: Environment variables
-sidebar_position: 3
----
-
-## General environment variables
-
-| Name (a star**\*** means the variable is required) | Description                                                                                                                                                                                            | Default value                |
-| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------- |
-| HASURA_GRAPHQL_JWT_SECRET**\***                    | Key used for generating JWTs. Must be `HMAC-SHA`-based and the same as configured in Hasura. [More info](https://hasura.io/docs/latest/graphql/core/auth/authentication/jwt.html#running-with-jwt)     |                              |
-| HASURA_GRAPHQL_DATABASE_URL**\***                  | [PostgreSQL connection URI](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING). Required to inject the `auth` schema into the database.                                      |                              |
-| HASURA_GRAPHQL_GRAPHQL_URL**\***                   | Hasura GraphQL endpoint. Required to manipulate account data. For instance: `https://graphql-engine:8080/v1/graphql`                                                                                   |                              |
-| HASURA_GRAPHQL_ADMIN_SECRET**\***                  | Hasura GraphQL Admin Secret. Required to manipulate account data.                                                                                                                                      |                              |
-| AUTH_HOST                                          | Server host. This option is available until Hasura-auth `v0.6.0`. [Docs](http://expressjs.com/en/5x/api.html#app.listen)                                                                               | `0.0.0.0`                    |
-| AUTH_PORT                                          | Server port. [Docs](http://expressjs.com/en/5x/api.html#app.listen)                                                                                                                                    | `4000`                       |
-| AUTH_SERVER_URL                                    | Server URL of where Hasura Backend Plus is running. This value is to used as a callback in email templates and for the OAuth authentication process.                                                   |                              |
-| AUTH_CLIENT_URL                                    | URL of your frontend application. Used to redirect users to the right page once actions based on emails or OAuth succeed.                                                                              |                              |
-| AUTH_SMTP_HOST                                     | SMTP server hostname used for sending emails                                                                                                                                                           |                              |
-| AUTH_SMTP_PORT                                     | SMTP port                                                                                                                                                                                              | `587`                        |
-| AUTH_SMTP_USER                                     | Username to use to authenticate on the SMTP server                                                                                                                                                     |                              |
-| AUTH_SMTP_PASS                                     | Password to use to authenticate on the SMTP server                                                                                                                                                     |                              |
-| AUTH_SMTP_SENDER                                   | Email to use in the `From` field of the email                                                                                                                                                          |                              |
-| AUTH_SMTP_AUTH_METHOD                              | SMTP authentication method                                                                                                                                                                             | `PLAIN`                      |
-| AUTH_SMTP_SECURE                                   | Enables SSL. [More info](https://nodemailer.com/smtp/#tls-options).                                                                                                                                    | `false`                      |
-| AUTH_GRAVATAR_ENABLED                              |                                                                                                                                                                                                        | `true`                       |
-| AUTH_GRAVATAR_DEFAULT                              |                                                                                                                                                                                                        | `blank`                      |
-| AUTH_GRAVATAR_RATING                               |                                                                                                                                                                                                        | `g`                          |
-| AUTH_ANONYMOUS_USERS_ENABLED                       | Enables users to register as an anonymous user.                                                                                                                                                        | `false`                      |
-| AUTH_DISABLE_NEW_USERS                             | If set, new users will be disabled after finishing registration and won't be able to connect.                                                                                                          | `false`                      |
-| AUTH_ACCESS_CONTROL_ALLOWED_EMAILS                 | Comma-separated list of emails that are allowed to register.                                                                                                                                           |                              |
-| AUTH_ACCESS_CONTROL_ALLOWED_EMAIL_DOMAINS          | Comma-separated list of email domains that are allowed to register. If `ALLOWED_EMAIL_DOMAINS` is `tesla.com,ikea.se`, only emails from tesla.com and ikea.se would be allowed to register an account. | `` (allow all email domains) |
-| AUTH_ACCESS_CONTROL_BLOCKED_EMAILS                 | Comma-separated list of emails that cannot register.                                                                                                                                                   |                              |
-| AUTH_ACCESS_CONTROL_BLOCKED_EMAIL_DOMAINS          | Comma-separated list of email domains that cannot register.                                                                                                                                            |                              |
-| AUTH_PASSWORD_MIN_LENGTH                           | Minimum password length.                                                                                                                                                                               | `3`                          |
-| AUTH_PASSWORD_HIBP_ENABLED                         | User's password is checked against [Pwned Passwords](https://haveibeenpwned.com/Passwords).                                                                                                            | `false`                      |
-| AUTH_USER_DEFAULT_ROLE                             | Default user role for registered users.                                                                                                                                                                | `user`                       |
-| AUTH_USER_DEFAULT_ALLOWED_ROLES                    | Comma-separated list of default allowed user roles.                                                                                                                                                    | `me,$AUTH_USER_DEFAULT_ROLE` |
-| AUTH_LOCALE_DEFAULT                                |                                                                                                                                                                                                        | `en`                         |
-| AUTH_LOCALE_ALLOWED_LOCALES                        |                                                                                                                                                                                                        | `en`                         |
-| AUTH_EMAIL_PASSWORDLESS_ENABLED                    | Enables passwordless authentication by email. The SMTP server must then be configured.                                                                                                                 | `false`                      |
-| AUTH_SMS_PASSWORDLESS_ENABLED                      | Enables passwordless authentication by SMS. An SMS provider must then be configured.                                                                                                                   | `false`                      |
-| AUTH_SMS_PROVIDER                                  | SMS provider name. Only `twilio` is possible as an option for now.                                                                                                                                     |                              |
-| AUTH_SMS_TWILIO_ACCOUNT_SID                        |                                                                                                                                                                                                        |                              |
-| AUTH_SMS_TWILIO_AUTH_TOKEN                         |                                                                                                                                                                                                        |                              |
-| AUTH_SMS_TWILIO_MESSAGING_SERVICE_ID               |                                                                                                                                                                                                        |                              |
-| AUTH_EMAIL_SIGNIN_EMAIL_VERIFIED_REQUIRED          | When enabled, any email-based authentication requires emails to be verified by a link sent to this email.                                                                                              | `true`                       |
-| AUTH_ACCESS_CONTROL_ALLOWED_REDIRECT_URLS          |                                                                                                                                                                                                        |                              |
-| AUTH_MFA_ENABLED                                   | Enables users to use Multi Factor Authentication.                                                                                                                                                      | `false`                      |
-| AUTH_MFA_TOTP_ISSUER                               | The name of the One Time Password (OTP) issuer. Probably your app's name.                                                                                                                              | `hasura-auth`                |
-| AUTH_ACCESS_TOKEN_EXPIRES_IN                       | Number of seconds before the access token (JWT) expires.                                                                                                                                               | `900`(15 minutes)            |
-| AUTH_REFRESH_TOKEN_EXPIRES_IN                      | Number of seconds before the refresh token expires.                                                                                                                                                    | `2592000` (30 days)          |
-| AUTH_EMAIL_TEMPLATE_FETCH_URL                      |                                                                                                                                                                                                        |                              |
-| AUTH_JWT_CUSTOM_CLAIMS                             |                                                                                                                                                                                                        |                              |
-
-## OAuth environment variables
-
-| Name (a star**\*** means the variable is required when the provider is enabled) | Default value                       |
-| ------------------------------------------------------------------------------- | ----------------------------------- |
-| AUTH_PROVIDER_GITHUB_ENABLED                                                    | `false`                             |
-| AUTH_PROVIDER_GITHUB_CLIENT_ID**\***                                            |                                     |
-| AUTH_PROVIDER_GITHUB_CLIENT_SECRET**\***                                        |                                     |
-| AUTH_PROVIDER_GITHUB_AUTHORIZATION_URL                                          |                                     |
-| AUTH_PROVIDER_GITHUB_TOKEN_URL                                                  |                                     |
-| AUTH_PROVIDER_GITHUB_USER_PROFILE_URL                                           |                                     |
-| AUTH_PROVIDER_GITHUB_SCOPE                                                      | `user:email `                       |
-| AUTH_PROVIDER_GOOGLE_ENABLED                                                    | `false`                             |
-| AUTH_PROVIDER_GOOGLE_CLIENT_ID**\***                                            |                                     |
-| AUTH_PROVIDER_GOOGLE_CLIENT_SECRET**\***                                        |                                     |
-| AUTH_PROVIDER_GOOGLE_SCOPE                                                      | `email,profile`                     |
-| AUTH_PROVIDER_FACEBOOK_ENABLED                                                  | `false`                             |
-| AUTH_PROVIDER_FACEBOOK_CLIENT_ID**\***                                          |                                     |
-| AUTH_PROVIDER_FACEBOOK_CLIENT_SECRET**\***                                      |                                     |
-| AUTH_PROVIDER_FACEBOOK_PROFILE_FIELDS                                           | `email,photos,displayName`          |
-| AUTH_PROVIDER_FACEBOOK_SCOPE                                                    | `email`                             |
-| AUTH_PROVIDER_TWITTER_ENABLED                                                   | `false`                             |
-| AUTH_PROVIDER_TWITTER_CONSUMER_KEY**\***                                        |                                     |
-| AUTH_PROVIDER_TWITTER_CONSUMER_SECRET**\***                                     |                                     |
-| AUTH_PROVIDER_LINKEDIN_ENABLED                                                  |                                     |
-| AUTH_PROVIDER_LINKEDIN_CLIENT_ID**\***                                          |                                     |
-| AUTH_PROVIDER_LINKEDIN_CLIENT_SECRET**\***                                      |                                     |
-| AUTH_PROVIDER_LINKEDIN_SCOPE                                                    | `r_emailaddress,r_liteprofile`      |
-| AUTH_PROVIDER_APPLE_ENABLED                                                     | `false`                             |
-| AUTH_PROVIDER_APPLE_CLIENT_ID**\***                                             |                                     |
-| AUTH_PROVIDER_APPLE_TEAM_ID**\***                                               |                                     |
-| AUTH_PROVIDER_APPLE_KEY_ID**\***                                                |                                     |
-| AUTH_PROVIDER_APPLE_PRIVATE_KEY**\***                                           | Base64 format                       |
-| AUTH_PROVIDER_APPLE_SCOPE                                                       | `name,email`                        |
-| AUTH_PROVIDER_WINDOWS_LIVE_ENABLED                                              | `false`                             |
-| AUTH_PROVIDER_WINDOWS_LIVE_CLIENT_ID**\***                                      |                                     |
-| AUTH_PROVIDER_WINDOWS_LIVE_CLIENT_SECRET**\***                                  |                                     |
-| AUTH_PROVIDER_WINDOWS_LIVE_SCOPE                                                | `wl.basic,wl.emails`                |
-| AUTH_PROVIDER_SPOTIFY_ENABLED                                                   | `false`                             |
-| AUTH_PROVIDER_SPOTIFY_CLIENT_ID**\***                                           |                                     |
-| AUTH_PROVIDER_SPOTIFY_CLIENT_SECRET**\***                                       |                                     |
-| AUTH_PROVIDER_SPOTIFY_SCOPE                                                     | `user-read-email,user-read-private` |
-| AUTH_PROVIDER_GITLAB_ENABLED                                                    | `false`                             |
-| AUTH_PROVIDER_GITLAB_CLIENT_ID**\***                                            |                                     |
-| AUTH_PROVIDER_GITLAB_CLIENT_SECRET**\***                                        |                                     |
-| AUTH_PROVIDER_GITLAB_BASE_URL                                                   |                                     |
-| AUTH_PROVIDER_GITLAB_SCOPE                                                      | `read_user`                         |
-| AUTH_PROVIDER_BITBUCKET_ENABLED                                                 | `false`                             |
-| AUTH_PROVIDER_BITBUCKET_CLIENT_ID**\***                                         |                                     |
-| AUTH_PROVIDER_BITBUCKET_CLIENT_SECRET**\***                                     |                                     |
-| AUTH_PROVIDER_STRAVA_ENABLED                                                    | `false`                             |
-| AUTH_PROVIDER_STRAVA_CLIENT_ID**\***                                            |                                     |
-| AUTH_PROVIDER_STRAVA_CLIENT_SECRET**\***                                        |                                     |
-| AUTH_PROVIDER_STRAVA_SCOPE                                                      | `profile:read_all`                  |

docs/docs/reference/hasura-auth/index.md

@@ -1,41 +0,0 @@
----
-title: 'Overview'
----
-
-Hasura Auth handles **authentication** for [Hasura](https://github.com/hasura/graphql-engine).
-
-Hasura Auth runs in a separate Docker container alongside Postgres and Hasura.
-
-## Features
-
-- 🧑‍🤝‍🧑 Users are stored in Postgres and accessed via GraphQL
-- 🔑 Multiple sign-in methods
-- ✨ Integrates with GraphQL and Hasura Permissions
-- 🔐 JWT tokens and Refresh Tokens.
-- 📧 Emails sent on various operations
-<!-- - ✅ Optional checking for Pwned Passwords. -->
-- 🛡️ Two-factor authentication support.
-- 👨‍💻 Written 100% in TypeScript.
-
-### Authentication methods
-
-- **Email and Password**: simple email and password method.
-- **Email**, also called **passwordless email** or **magic link**.
-- **SMS**, also called **passwordless sms**.
-- **Anonymous**: sign in users without any method. Anonymous users can be
-  converted to _regular_ users at a later stage.
-- **OAuth providers**: Facebook, Google, GitHub, Twitter, Apple, LinkedIn, Windows Live, Spotify, Strave, GitLab, BitBucket
-
-## Integration with Hasura
-
-Hasura Auth's final purpose is to securely provide a JSON Web Token that can be added as an authorization header to GraphQL operation sent to Hasura.
-Hasura auth automatically generates and manages two kinds of tokens:
-
-- An access token (JWT), that will be used to authenticate the GraphQL operations in Hasura, and that has a limited expiration limit (15 minutes by default)
-- A refresh token, that is used to ask Hasura Auth for a new access token, and that can be consummed only once.
-
-Access tokens generated by Hasura Auth contains information and user id, its default role, and the roles they actually have. In addition, it is possible since version `0.2.0` to extend JWT claims with custom information such as organisation or project ownership, so your application can leverage the capabilities of the [Hasura permissions layer](https://hasura.io/docs/latest/graphql/core/auth/authorization/index.html).
-
-<!-- - Users and accounts are saved in the database. -->
-
-You can read further information about JWT and Hasura in the [official Hasura documentation](https://hasura.io/docs/latest/graphql/core/auth/authentication/jwt.html).

docs/docs/reference/hasura-auth/installation.md

@@ -1,25 +0,0 @@
----
-title: Installation
-sidebar_position: 1
----
-
-Hasura Auth runs in a container alongside Postgres and Hasura.
-
-## Nhost (recommended)
-
-The recommended way to start using Hasura Auth is by using Nhost. With Nhost, you will get a complete backend ready in seconds with Hasura, authentication, storage and serverless functions.
-
-Go to [Nhost](https://nhost.io) and start building your app now.
-
-## Docker-compose
-
-```sh
-git clone https://github.com/nhost/hasura-auth.git
-cd hasura-auth
-cp .env.example .env
-docker-compose -f docker-compose-example.yaml up
-```
-
-Hasura Auth comes with plenty of options. They are explained in the [configuration section](/reference/hasura-auth/configuration).
-
-If you are already familiar with the application, you can also have a look at the [environment variables](/reference/hasura-auth/environment-variables) that can be passed on to your docker container.

docs/docs/reference/hasura-auth/schema.md

@@ -1,86 +0,0 @@
----
-title: 'Schema'
-sidebar_position: 4
----
-
-Hasura Auth stores all its data in a dedicated `auth` PostgreSQL schema. When Hasura Auth starts, it checks if the `auth` schema exists, then automatically syncs the following tables and their corresponding Hasura metadata:
-
-```mermaid
-erDiagram
-migrations {
-    integer id PK
-    varchar name
-    varchar hash
-    timestamp executed_at "CURRENT_TIMESTAMP"
-}
-
-users ||--o{ user_roles : roles
-user_roles }o--|| roles: role
-users }o--|| roles: role
-users ||--o{ refresh_tokens: refreshTokens
-users ||--o{ user_providers: provider
-providers ||--o{ user_providers: user
-
-provider_requests {
-    uuid id PK "gen_random_uuid()"
-    test redirect_url
-}
-
-
-refresh_tokens {
-    uuid refresh_token PK
-    uuid user_id FK
-    timestamptz created_at "now()"
-    timestamptz expires_at
-}
-
-providers {
-    text id PK
-}
-user_providers {
-    uuid id PK "gen_random_uuid()"
-    timestamptz created_at "now()"
-    timestamptz updated_at "now()"
-    uuid user_id FK
-    text access_token
-    text refresh_token
-    text provider_id FK
-    text provider_user_id
-}
-user_roles {
-    uuid id PK "gen_random_uuid()"
-    timestamptz created_at "now()"
-    uuid user_id FK
-    text role FK
-}
-users {
-    uuid id PK "gen_random_uuid()"
-    timestamptz created_at "now()"
-    timestamptz updated_at "now()"
-    timestamptz last_seen "nullable"
-    boolean disabled "false"
-    text display_name "''"
-    text avatar_url "''"
-    varchar locale
-    email email "nullable"
-    text phone_number "nullable"
-    text password_hash "nullable"
-    boolean email_verified "false"
-    boolean phone_number_verified "false"
-    email new_email "nullable"
-    text otp_method_last_used "nullable"
-    text otp_hash "nullable"
-    timestamptz opt_hash_expires_at "now()"
-    text default_role FK "user"
-    boolean is_anonymous "false"
-    text totp_secret "nullable"
-    text active_mfa_type "nullable"
-    text ticket "nullable"
-    timestamptz ticket_expires_at "now()"
-    jsonb metadata "nullable"
-}
-
-roles {
-    text roles PK
-}
-```