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

chore: update versions

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">
@@ -257,6 +262,13 @@ Here are some ways of contributing to making Nhost better:
         </a>
     </td></tr>
 <tr>
+    <td align="center">
+        <a href="https://github.com/MelodicCrypter">
+            <img src="https://avatars.githubusercontent.com/u/18341500?v=4" width="100;" alt="MelodicCrypter"/>
+            <br />
+            <sub><b>Hugh Caluscusin</b></sub>
+        </a>
+    </td>
     <td align="center">
         <a href="https://github.com/jerryjappinen">
             <img src="https://avatars.githubusercontent.com/u/1101002?v=4" width="100;" alt="jerryjappinen"/>
@@ -291,15 +303,15 @@ Here are some ways of contributing to making Nhost better:
             <br />
             <sub><b>Muttenzer</b></sub>
         </a>
-    </td>
+    </td></tr>
+<tr>
     <td align="center">
         <a href="https://github.com/ahmic">
             <img src="https://avatars.githubusercontent.com/u/13452362?v=4" width="100;" alt="ahmic"/>
             <br />
             <sub><b>Amir Ahmic</b></sub>
         </a>
-    </td></tr>
-<tr>
+    </td>
     <td align="center">
         <a href="https://github.com/akd-io">
             <img src="https://avatars.githubusercontent.com/u/30059155?v=4" width="100;" alt="akd-io"/>
@@ -334,15 +346,15 @@ 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"/>
             <br />
             <sub><b>Helio Alves</b></sub>
         </a>
-    </td></tr>
-<tr>
+    </td>
     <td align="center">
         <a href="https://github.com/nkhdo">
             <img src="https://avatars.githubusercontent.com/u/26102306?v=4" width="100;" alt="nkhdo"/>
@@ -350,13 +362,6 @@ Here are some ways of contributing to making Nhost better:
             <sub><b>Hoang Do</b></sub>
         </a>
     </td>
-    <td align="center">
-        <a href="https://github.com/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">
             <img src="https://avatars.githubusercontent.com/u/1935359?v=4" width="100;" alt="jladuval"/>

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

@@ -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/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/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/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/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/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/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
-}
-```

docs/docs/reference/index.md

@@ -34,12 +34,3 @@ In this section:
 ### Nhost CLI
 
 - [CLI overview](/reference/cli)
-
-### Hasura Auth
-
-- [Overview](/reference/hasura-auth)
-- [Installation](/reference/hasura-auth/installation)
-- [Configuration](/reference/hasura-auth/configuration)
-- [Environment variables](/reference/hasura-auth/environment-variables)
-- [Schema](/reference/hasura-auth/schema)
-- [API](/reference/hasura-auth/api-reference)

docs/docs/reference/javascript/index.mdx

@@ -42,7 +42,8 @@ Initialize a single `nhost` instance using your Nhost backend URL:
 import { NhostClient } from '@nhost/nhost-js'
 
 const nhost = new NhostClient({
-  backendUrl: '<Your Nhost Backend URL>'
+  subdomain: '<your-subdomain>',
+  region: '<your-region>'
 })
 ```
 

docs/docs/reference/nextjs/index.mdx

@@ -39,7 +39,8 @@ import type { AppProps } from 'next/app'
 import { NhostClient, NhostNextProvider } from '@nhost/nextjs'
 
 const nhost = new NhostClient({
-  backendUrl: '<Your Nhost Backend URL>'
+  subdomain: '<your-subdomain>',
+  region: '<your-region>'
 })
 
 function MyApp({ Component, pageProps }: AppProps) {
@@ -139,7 +140,8 @@ import { NhostClient, NhostNextProvider } from '@nhost/nextjs'
 import { NhostApolloProvider } from '@nhost/react-apollo'
 
 const nhost = new NhostClient({
-  backendUrl: '<Your Nhost Backend URL>'
+  subdomain: '<your-subdomain>',
+  region: '<your-region>'
 })
 
 function MyApp({ Component, pageProps }: AppProps) {

docs/docs/reference/react/index.mdx

@@ -36,7 +36,8 @@ After installation, initialize a single Nhost Client (`nhost`) under `src/lib/nh
 ```jsx title=src/lib/nhost.js
 import { NhostClient } from '@nhost/react'
 const nhost = new NhostClient({
-  backendUrl: '<Your Nhost Backend URL>'
+  subdomain: '<your-subdomain>',
+  region: '<your-region>'
 })
 export { nhost }
 ```
@@ -63,8 +64,6 @@ ReactDOM.render(
 export { nhost }
 ```
 
-
-
 :::info
 
 The `nhost` instance created with the `NhostClient` above is the same as the [JavaScript Nhost client](/reference/javascript).

docs/docs/reference/react/protecting-routes.mdx

@@ -74,7 +74,8 @@ Where `nhost` comes from `lib/nhost.js` like this:
 import { NhostClient } from '@nhost/react'
 
 const nhost = new NhostClient({
-  backendUrl: '<Your Nhost Backend URL>'
+  subdomain: '<your-subdomain>',
+  region: '<your-region>'
 })
 
 export { nhost }

docs/docs/reference/vue/apollo.mdx

@@ -40,7 +40,8 @@ import { DefaultApolloClient } from '@vue/apollo-composable'
 import App from './App.vue'
 
 const nhost = new NhostClient({
-  backendUrl: import.meta.env.VITE_NHOST_URL
+  subdomain: '<your-subdomain>',
+  region: '<your-region>'
 })
 
 const apolloClient = createApolloClient({ nhost })

docs/docs/reference/vue/index.mdx

@@ -40,7 +40,8 @@ import { NhostClient } from '@nhost/vue'
 import App from './App.vue'
 
 const nhost = new NhostClient({
-  backendUrl: '<Your Nhost Backend URL>'
+  subdomain: '<your-subdomain>',
+  region: '<your-region>'
 })
 
 createApp(App).use(nhost).mount('#app')

docs/docs/reference/vue/protecting-routes.mdx

@@ -20,7 +20,8 @@ import { NhostClient } from '@nhost/vue'
 import App from './App.vue'
 
 const nhost = new NhostClient({
-  backendUrl: '<Your Nhost Backend URL>'
+  subdomain: '<your-subdomain>',
+  region: '<your-region>'
 })
 
 const router = createRouter({

docs/docusaurus.config.js

@@ -26,7 +26,7 @@ const config = {
   favicon: 'img/favicon.png',
   organizationName: 'nhost',
   projectName: 'docs',
-  plugins: [require.resolve("docusaurus-plugin-image-zoom")],
+  plugins: [require.resolve('docusaurus-plugin-image-zoom')],
   presets: [
     [
       'classic',
@@ -179,7 +179,7 @@ const config = {
         appId: '3A3MJQTKHU',
         apiKey: 'a76361eaed8ebcd4cf5d9ae2f0c9e746',
         indexName: 'nhost',
-        contextualSearch: false
+        contextualSearch: true
       },
       zoom: {
         selector: '.markdown :not(em) > img',

docs/package.json

@@ -25,13 +25,11 @@
     "mermaid": "^8.14.0",
     "prism-react-renderer": "^1.3.1",
     "react": "^17.0.2",
-    "react-dom": "^17.0.2",
-    "swagger-ui-react": "^4.10.3"
+    "react-dom": "^17.0.2"
   },
   "devDependencies": {
     "@docusaurus/module-type-aliases": "2.0.0-beta.20",
     "@tsconfig/docusaurus": "^1.0.5",
-    "@types/swagger-ui-react": "^4.1.1",
     "typescript": "^4.6.3"
   },
   "browserslist": {

docs/sidebars.js

@@ -142,18 +142,6 @@ const sidebars = {
         'reference/cli/logs',
         'reference/cli/global-flags'
       ]
-    },
-    {
-      type: 'category',
-      label: 'Hasura Auth',
-      link: { type: 'doc', id: 'reference/hasura-auth/index' },
-      items: [
-        'reference/hasura-auth/installation',
-        'reference/hasura-auth/configuration',
-        'reference/hasura-auth/environment-variables',
-        'reference/hasura-auth/schema',
-        'reference/hasura-auth/api-reference'
-      ]
     }
   ]
 }

docs/src/components/Swagger.tsx

@@ -1,40 +0,0 @@
-import SwaggerUI from 'swagger-ui-react';
-import React from 'react';
-import 'swagger-ui-react/swagger-ui.css';
-
-const OperationsLayout = (props) => {
-  const { getComponent } = props;
-  const Operations = getComponent('operations', true);
-  let SvgAssets = getComponent('SvgAssets');
-
-  return (
-    <div className="swagger-ui">
-      <SvgAssets />
-      <Operations />
-    </div>
-  );
-};
-
-const OperationsLayoutPlugin = () => ({
-  components: {
-    OperationsLayout,
-  },
-});
-
-type SwaggerProps = {
-  /**
-   * OpenAPI specification.
-   */
-  spec: string;
-};
-
-export function Swagger({ spec }: SwaggerProps) {
-  return (
-    <SwaggerUI
-      url={`/openapi/${spec}`}
-      plugins={[OperationsLayoutPlugin]}
-      layout="OperationsLayout"
-      supportedSubmitMethods={[]}
-    />
-  );
-}

docs/vercel.json

@@ -40,6 +40,16 @@
       "source": "/reference/react/hooks",
       "destination": "/reference/react",
       "permanent": true
+    },
+    {
+      "source": "/reference/hasura-auth",
+      "destination": "https://github.com/nhost/hasura-auth",
+      "permanent": true
+    },
+    {
+      "source": "/reference/hasura-auth/:path*",
+      "destination": "https://github.com/nhost/hasura-auth",
+      "permanent": true
     }
   ]
 }

examples/nextjs/nhost/config.yaml

@@ -3,11 +3,13 @@ services:
   mailhog:
     port: 8025
   hasura:
-    version: v2.2.0
+    version: v2.8.0
     environment:
       hasura_graphql_enable_remote_schema_permissions: false
   auth:
-    version: 0.7.1
+    version: 0.9.1
+  storage:
+    version: 0.2.2
 auth:
   access_control:
     email:

examples/react-apollo-crm/nhost/config.yaml

@@ -1,8 +1,13 @@
 metadata_directory: metadata
 services:
   hasura:
+    version: v2.8.0
     environment:
       hasura_graphql_enable_remote_schema_permissions: true
+  auth:
+    version: 0.9.1
+  storage:
+    version: 0.2.2
 auth:
   access_control:
     email:

examples/react-apollo/nhost/config.yaml

@@ -3,13 +3,13 @@ services:
   mailhog:
     port: 8025
   hasura:
-    version: v2.7.0
+    version: v2.8.0
     environment:
       hasura_graphql_enable_remote_schema_permissions: false
   auth:
-    version: 0.9.0
+    version: 0.9.1
   storage:
-    version: 0.2.1
+    version: 0.2.2
 auth:
   access_control:
     email:

examples/react-apollo/nhost/metadata/actions.graphql

@@ -0,0 +1,2 @@
+
+

examples/react-apollo/nhost/metadata/databases/default/tables/public_todos.yaml

@@ -28,7 +28,6 @@ object_relationships:
     foreign_key_constraint_on: user_id
 insert_permissions:
 - permission:
-    backend_only: false
     check: {}
     columns:
     - contents
@@ -37,7 +36,6 @@ insert_permissions:
       user_id: x-hasura-user-id
   role: anonymous
 - permission:
-    backend_only: false
     check: {}
     columns:
     - contents
@@ -93,11 +91,13 @@ update_permissions:
   role: user
 delete_permissions:
 - permission:
+    backend_only: false
     filter:
       user_id:
         _eq: X-Hasura-User-Id
   role: anonymous
 - permission:
+    backend_only: false
     filter:
       user_id:
         _eq: X-Hasura-User-Id

examples/react-apollo/src/components/AuthLink.tsx

@@ -1,38 +1,41 @@
 import { Link } from 'react-router-dom'
 
-import { Button, ButtonVariant } from '@mantine/core'
+import { Button, ButtonProps, SharedButtonProps } from '@mantine/core'
 
-const AuthLink: React.FC<{
-  icon?: React.ReactNode
-  link: string
-  color?: string
-  children?: React.ReactNode
-  variant?: ButtonVariant
-}> = ({ icon, color, link, variant, children }) => {
-  return (
-    <Button
-      role="button"
-      component={Link}
-      fullWidth
-      radius="sm"
-      variant={variant}
-      to={link}
-      leftIcon={icon}
-      styles={(theme) => ({
-        root: {
-          backgroundColor: color,
-          '&:hover': {
-            backgroundColor: color && theme.fn.darken(color, 0.05)
-          }
-        },
-
-        leftIcon: {
-          marginRight: 15
+const AuthButton: <C = 'button'>(props: ButtonProps<C>) => React.ReactElement = ({
+  color,
+  ...rest
+}) => (
+  <Button
+    role="button"
+    fullWidth
+    radius="sm"
+    styles={(theme) => ({
+      root: {
+        backgroundColor: color,
+        '&:hover': {
+          backgroundColor: color && theme.fn.darken(color, 0.05)
         }
-      })}
-    >
-      {children}
-    </Button>
+      },
+
+      leftIcon: {
+        marginRight: 15
+      }
+    })}
+    {...rest}
+  />
+)
+
+const AuthLink: React.FC<
+  SharedButtonProps & {
+    link: string
+  }
+> = ({ link, ...rest }) => {
+  const isExternal = link.startsWith('http://') || link.startsWith('https://')
+  return isExternal ? (
+    <AuthButton component={'a'} href={link} {...rest} />
+  ) : (
+    <AuthButton component={Link} to={link} {...rest} />
   )
 }
 

examples/react-apollo/src/components/OauthLinks.tsx

@@ -8,13 +8,13 @@ export default function OauthLinks() {
   const { github, google, facebook } = useProviderLink()
   return (
     <>
-      <AuthLink icon={<FaGithub />} link={github} color="#333">
+      <AuthLink leftIcon={<FaGithub />} link={github} color="#333">
         Continue with GitHub
       </AuthLink>
-      <AuthLink icon={<FaGoogle />} link={google} color="#de5246">
+      <AuthLink leftIcon={<FaGoogle />} link={google} color="#de5246">
         Continue with Google
       </AuthLink>
-      <AuthLink icon={<FaFacebook />} link={facebook} color="#3b5998">
+      <AuthLink leftIcon={<FaFacebook />} link={facebook} color="#3b5998">
         Continue with Facebook
       </AuthLink>
     </>

examples/react-apollo/src/sign-in/index.tsx

@@ -16,7 +16,7 @@ const Index: React.FC = () => (
   <>
     <OAuthLinks />
     <Divider my="sm" />
-    <AuthLink icon={<FaLock />} variant="outline" link="/sign-in/email-passwordless">
+    <AuthLink leftIcon={<FaLock />} variant="outline" link="/sign-in/email-passwordless">
       Continue with passwordless email
     </AuthLink>
     <AuthLink variant="subtle" link="/sign-in/email-password">

examples/react-apollo/src/sign-up/index.tsx

@@ -21,7 +21,7 @@ const Index: React.FC = () => {
           <Divider my="sm" />
         </>
       )}
-      <AuthLink icon={<FaLock />} variant="outline" link="/sign-up/email-passwordless">
+      <AuthLink leftIcon={<FaLock />} variant="outline" link="/sign-up/email-passwordless">
         Continue with passwordless email
       </AuthLink>
       <AuthLink variant="subtle" link="/sign-up/email-password">

examples/vue-apollo/nhost/config.yaml

@@ -3,11 +3,13 @@ services:
   mailhog:
     port: 8025
   hasura:
-    version: v2.2.0
+    version: v2.8.0
     environment:
       hasura_graphql_enable_remote_schema_permissions: false
   auth:
-    version: 0.7.1
+    version: 0.9.1
+  storage:
+    version: 0.2.2
 auth:
   access_control:
     email:

packages/apollo/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @nhost/apollo
 
+## 0.5.18
+
+### Patch Changes
+
+- dbc10e62: fixed `exports` field to support imports in a server-side environment
+- Updated dependencies [dbc10e62]
+  - @nhost/nhost-js@1.4.2
+
+## 0.5.17
+
+### Patch Changes
+
+- Updated dependencies [b8f4b75b]
+  - @nhost/nhost-js@1.4.1
+
 ## 0.5.16
 
 ### Patch Changes

packages/apollo/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nhost/apollo",
-  "version": "0.5.16",
+  "version": "0.5.18",
   "description": "Nhost Apollo Client library",
   "license": "MIT",
   "keywords": [
@@ -32,7 +32,10 @@
   ],
   "exports": {
     ".": {
-      "import": "./dist/index.esm.js",
+      "import": {
+        "node": "./dist/index.cjs.js",
+        "default": "./dist/index.esm.js"
+      },
       "require": "./dist/index.cjs.js"
     }
   },

packages/core/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @nhost/core
 
+## 0.7.2
+
+### Patch Changes
+
+- dbc10e62: fixed `exports` field to support imports in a server-side environment
+
 ## 0.7.1
 
 ### Patch Changes

packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nhost/core",
-  "version": "0.7.1",
+  "version": "0.7.2",
   "description": "Nhost core client library",
   "license": "MIT",
   "keywords": [
@@ -31,7 +31,10 @@
   ],
   "exports": {
     ".": {
-      "import": "./dist/index.esm.js",
+      "import": {
+        "node": "./dist/index.cjs.js",
+        "default": "./dist/index.esm.js"
+      },
       "require": "./dist/index.cjs.js"
     }
   },

packages/hasura-auth-js/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @nhost/hasura-auth-js
 
+## 1.3.1
+
+### Patch Changes
+
+- dbc10e62: fixed `exports` field to support imports in a server-side environment
+- Updated dependencies [dbc10e62]
+  - @nhost/core@0.7.2
+
 ## 1.3.0
 
 ### Minor Changes

packages/hasura-auth-js/nhost/config.yaml

@@ -3,13 +3,13 @@ services:
   mailhog:
     port: 8025
   hasura:
-    version: v2.7.0
+    version: v2.8.0
     environment:
       hasura_graphql_enable_remote_schema_permissions: false
   auth:
-    version: 0.9.0
+    version: 0.9.1
   storage:
-    version: 0.2.1
+    version: 0.2.2
 auth:
   access_control:
     email:

packages/hasura-auth-js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nhost/hasura-auth-js",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Hasura-auth client",
   "license": "MIT",
   "keywords": [
@@ -30,7 +30,10 @@
   ],
   "exports": {
     ".": {
-      "import": "./dist/index.esm.js",
+      "import": {
+        "node": "./dist/index.cjs.js",
+        "default": "./dist/index.esm.js"
+      },
       "require": "./dist/index.cjs.js"
     }
   },

packages/hasura-auth-js/src/hasura-auth-client.ts

@@ -220,7 +220,7 @@ export class HasuraAuthClient {
    * ```
    *
    * @example
-   * ### Sign out the user from all decvices
+   * ### Sign out the user from all devices
    * ```ts
    * nhost.auth.signOut({all: true})
    * ```

packages/hasura-storage-js/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @nhost/hasura-storage-js
 
+## 0.3.4
+
+### Patch Changes
+
+- dbc10e62: fixed `exports` field to support imports in a server-side environment
+
 ## 0.3.3
 
 ### Patch Changes

packages/hasura-storage-js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nhost/hasura-storage-js",
-  "version": "0.3.3",
+  "version": "0.3.4",
   "description": "Hasura-storage client",
   "license": "MIT",
   "keywords": [
@@ -28,7 +28,10 @@
   ],
   "exports": {
     ".": {
-      "import": "./dist/index.esm.js",
+      "import": {
+        "node": "./dist/index.cjs.js",
+        "default": "./dist/index.esm.js"
+      },
       "require": "./dist/index.cjs.js"
     }
   },

packages/nextjs/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @nhost/nextjs
 
+## 1.4.2
+
+### Patch Changes
+
+- dbc10e62: fixed `exports` field to support imports in a server-side environment
+- Updated dependencies [dbc10e62]
+  - @nhost/core@0.7.2
+  - @nhost/nhost-js@1.4.2
+  - @nhost/react@0.9.2
+
+## 1.4.1
+
+### Patch Changes
+
+- Updated dependencies [b8f4b75b]
+  - @nhost/nhost-js@1.4.1
+  - @nhost/react@0.9.1
+
 ## 1.4.0
 
 ### Patch Changes

packages/nextjs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nhost/nextjs",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "description": "Nhost NextJS library",
   "license": "MIT",
   "keywords": [
@@ -34,7 +34,10 @@
   ],
   "exports": {
     ".": {
-      "import": "./dist/index.esm.js",
+      "import": {
+        "node": "./dist/index.cjs.js",
+        "default": "./dist/index.esm.js"
+      },
       "require": "./dist/index.cjs.js"
     }
   },

packages/nextjs/src/index.ts

@@ -1,4 +1,9 @@
-import { NhostClient as VanillaNhostClient, NhostClientConstructorParams } from '@nhost/nhost-js'
+import {
+  BackendUrl,
+  NhostAuthConstructorParams,
+  NhostClient as VanillaNhostClient,
+  Subdomain
+} from '@nhost/nhost-js'
 
 export * from './create-server-side-client'
 export * from './get-session'
@@ -9,10 +14,18 @@ export { NhostReactProvider as NhostNextProvider } from '@nhost/react'
 const isBrowser = typeof window !== 'undefined'
 
 export interface NhostNextClientConstructorParams
-  extends Omit<
-    NhostClientConstructorParams,
-    'start' | 'clientStorage' | 'clientStorageType' | 'clientStorageGetter' | 'clientStorageSetter'
-  > {}
+  extends Partial<BackendUrl>,
+    Partial<Subdomain>,
+    Omit<
+      NhostAuthConstructorParams,
+      | 'url'
+      | 'start'
+      | 'client'
+      | 'clientStorage'
+      | 'clientStorageType'
+      | 'clientStorageGetter'
+      | 'clientStorageSetter'
+    > {}
 
 export class NhostClient extends VanillaNhostClient {
   constructor(params: NhostNextClientConstructorParams) {

packages/nhost-js/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @nhost/nhost-js
 
+## 1.4.2
+
+### Patch Changes
+
+- dbc10e62: fixed `exports` field to support imports in a server-side environment
+- Updated dependencies [dbc10e62]
+  - @nhost/hasura-auth-js@1.3.1
+  - @nhost/hasura-storage-js@0.3.4
+
+## 1.4.1
+
+### Patch Changes
+
+- b8f4b75b: Introduce `subdomain` and `region` alongside `backendUrl`.
+
+  `backendUrl` should now be used only for self-hosting. `subdomain` and `region` should be used when interacting with the hosted Nhost platform.
+
 ## 1.4.0
 
 ### Minor Changes

packages/nhost-js/README.md

@@ -28,7 +28,7 @@ yarn add @nhost/nhost-js
 import { NhostClient } from '@nhost/nhost-js'
 
 const nhost = new NhostClient({
-  backendUrl: 'https://xxx.nhost.run'
+  backendUrl: 'https://subdomain.nhost.run'
 })
 ```
 

packages/nhost-js/nhost/config.yaml

@@ -3,13 +3,13 @@ services:
   mailhog:
     port: 8025
   hasura:
-    version: v2.7.0
+    version: v2.8.0
     environment:
       hasura_graphql_enable_remote_schema_permissions: false
   auth:
-    version: 0.9.0
+    version: 0.9.1
   storage:
-    version: 0.2.1
+    version: 0.2.2
 auth:
   access_control:
     email:

packages/nhost-js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nhost/nhost-js",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "description": "Nhost JavaScript SDK",
   "license": "MIT",
   "keywords": [
@@ -31,7 +31,10 @@
   ],
   "exports": {
     ".": {
-      "import": "./dist/index.esm.js",
+      "import": {
+        "node": "./dist/index.cjs.js",
+        "default": "./dist/index.esm.js"
+      },
       "require": "./dist/index.cjs.js"
     }
   },

packages/nhost-js/src/clients/functions.ts

@@ -1,6 +1,6 @@
 import axios, { AxiosInstance, AxiosRequestConfig, AxiosRequestHeaders, AxiosResponse } from 'axios'
 
-import { FunctionCallResponse } from '../types'
+import { FunctionCallResponse } from '../utils/types'
 export interface NhostFunctionsConstructorParams {
   /**
    * Serverless Functions endpoint.

packages/nhost-js/src/clients/graphql.ts

@@ -1,7 +1,7 @@
 import axios, { AxiosInstance, AxiosRequestConfig, AxiosRequestHeaders } from 'axios'
 import { DocumentNode, print } from 'graphql'
 
-import { GraphqlRequestResponse, GraphqlResponse } from '../types'
+import { GraphqlRequestResponse, GraphqlResponse } from '../utils/types'
 
 export interface NhostGraphqlConstructorParams {
   /**

packages/nhost-js/src/core/index.ts

@@ -1 +1,2 @@
+export type { NhostClientConstructorParams } from '../utils/types'
 export * from './nhost-client'

packages/nhost-js/src/core/nhost-client.ts

@@ -1,20 +1,10 @@
-import { HasuraAuthClient, NhostAuthConstructorParams } from '@nhost/hasura-auth-js'
+import { HasuraAuthClient } from '@nhost/hasura-auth-js'
 import { HasuraStorageClient } from '@nhost/hasura-storage-js'
 
 import { NhostFunctionsClient } from '../clients/functions'
 import { NhostGraphqlClient } from '../clients/graphql'
-
-export interface NhostClientConstructorParams extends Omit<NhostAuthConstructorParams, 'url'> {
-  /**
-   * Nhost backend URL.
-   */
-  backendUrl: string
-  /**
-   * Admin secret. When set, it is sent as an `x-hasura-admin-secret` header for all
-   * GraphQL, Storage, and Serverless Functions requests.
-   */
-  adminSecret?: string
-}
+import { urlFromParams } from '../utils/helpers'
+import { NhostClientConstructorParams } from '../utils/types'
 
 export class NhostClient {
   auth: HasuraAuthClient
@@ -27,12 +17,13 @@ export class NhostClient {
    * Nhost Client
    *
    * @example
-   * const nhost = new NhostClient({ url });
+   * ```ts
+   * const nhost = new NhostClient({ subdomain, region });
+   * ```
    *
    * @docs https://docs.nhost.io/reference/javascript
    */
   constructor({
-    backendUrl,
     refreshIntervalTime,
     clientStorageGetter,
     clientStorageSetter,
@@ -42,11 +33,11 @@ export class NhostClient {
     autoSignIn,
     adminSecret,
     devTools,
-    start = true
+    start = true,
+    ...urlParams
   }: NhostClientConstructorParams) {
-    if (!backendUrl) throw new Error('Please specify a `backendUrl`. Docs: [todo]!')
     this.auth = new HasuraAuthClient({
-      url: `${backendUrl}/v1/auth`,
+      url: urlFromParams(urlParams, 'auth'),
       refreshIntervalTime,
       clientStorageGetter,
       clientStorageSetter,
@@ -58,17 +49,17 @@ export class NhostClient {
     })
 
     this.storage = new HasuraStorageClient({
-      url: `${backendUrl}/v1/storage`,
+      url: urlFromParams(urlParams, 'storage'),
       adminSecret
     })
 
     this.functions = new NhostFunctionsClient({
-      url: `${backendUrl}/v1/functions`,
+      url: urlFromParams(urlParams, 'functions'),
       adminSecret
     })
 
     this.graphql = new NhostGraphqlClient({
-      url: `${backendUrl}/v1/graphql`,
+      url: urlFromParams(urlParams, 'graphql'),
       adminSecret
     })
 

packages/nhost-js/src/index.ts

@@ -1,7 +1,9 @@
-import { NhostClient, NhostClientConstructorParams } from './core'
+import { NhostClientConstructorParams } from './utils/types'
+import { NhostClient } from './core'
 
 const createClient = (config: NhostClientConstructorParams) => new NhostClient(config)
 
 export * from './clients'
 export * from './core'
+export * from './utils/types'
 export { createClient }

packages/nhost-js/src/types.ts

@@ -1,26 +0,0 @@
-import type { AxiosResponse } from 'axios'
-
-export type GraphqlRequestResponse<T = unknown> =
-  | {
-      data: null
-      error: Error | object | object[]
-    }
-  | {
-      data: T
-      error: null
-    }
-
-export type FunctionCallResponse<T = unknown> =
-  | {
-      res: AxiosResponse<T>
-      error: null
-    }
-  | {
-      res: null
-      error: Error
-    }
-
-export interface GraphqlResponse<T = object> {
-  errors?: object[]
-  data?: T
-}

packages/nhost-js/src/utils/helpers.ts

@@ -0,0 +1,30 @@
+import { NhostClientConstructorParams } from './types'
+
+const LOCALHOST = /^localhost(:\d+)*$/
+
+/**
+ * `backendUrl` should now be used only when self-hosting
+ * `subdomain` and `region` should be used instead when using the Nhost platform
+ * `
+ * @param backendOrSubdomain
+ * @param service
+ * @returns
+ */
+export function urlFromParams(
+  backendOrSubdomain: Pick<NhostClientConstructorParams, 'region' | 'subdomain' | 'backendUrl'>,
+  service: string
+) {
+  if ('backendUrl' in backendOrSubdomain) {
+    return `${backendOrSubdomain.backendUrl}/v1/${service}`
+  }
+
+  if (backendOrSubdomain.subdomain !== undefined && backendOrSubdomain.subdomain.match(LOCALHOST)) {
+    return `http://${backendOrSubdomain.subdomain}/v1/${service}`
+  }
+
+  if (!('region' in backendOrSubdomain)) {
+    throw new Error('A region must be specified when using a `subdomain` other than "localhost".')
+  }
+
+  return `https://${backendOrSubdomain.subdomain}.${service}.${backendOrSubdomain.region}.nhost.run/v1`
+}

packages/nhost-js/src/utils/types.ts

@@ -0,0 +1,70 @@
+import type { AxiosResponse } from 'axios'
+
+import { NhostAuthConstructorParams } from '@nhost/hasura-auth-js'
+
+export type { NhostAuthConstructorParams }
+
+export type BackendUrl = {
+  /**
+   * Nhost backend URL
+   * Should only be used when self-hosting
+   */
+  backendUrl: string
+  /**
+   * When set, the admin secret is sent as a header, `x-hasura-admin-secret`,
+   * for all requests to GraphQL, Storage, and Functions.
+   */
+  adminSecret?: string
+}
+
+export type Subdomain = {
+  /**
+   * App subdomain (e.g, ieingiwnginwnfnegqwvdqwdwq)
+   * Should be used when using the Nhost platform
+   * Use "localhost" in development
+   */
+  subdomain: string
+
+  /**
+   * App region (e.g., eu-central-1)
+   * Not required in development (when `subdomain` is "localhost")
+   */
+  region?: string
+  /**
+   * When set, the admin secret is sent as a header, `x-hasura-admin-secret`,
+   * for all requests to GraphQL, Storage, and Functions.
+   */
+  adminSecret?: string
+}
+
+export type BackendOrSubdomain = BackendUrl | Subdomain
+
+export interface NhostClientConstructorParams
+  extends Partial<BackendUrl>,
+    Partial<Subdomain>,
+    Omit<NhostAuthConstructorParams, 'url'> {}
+
+export type GraphqlRequestResponse<T = unknown> =
+  | {
+      data: null
+      error: Error | object | object[]
+    }
+  | {
+      data: T
+      error: null
+    }
+
+export type FunctionCallResponse<T = unknown> =
+  | {
+      res: AxiosResponse<T>
+      error: null
+    }
+  | {
+      res: null
+      error: Error
+    }
+
+export interface GraphqlResponse<T = object> {
+  errors?: object[]
+  data?: T
+}

packages/nhost-js/tests/utils.test.ts

@@ -0,0 +1,45 @@
+import { urlFromParams } from '../src/utils/helpers'
+
+describe('urlFromParams', () => {
+  describe('using backendUrl', () => {
+    it('should return its value concatenated with "/v1/auth"', async () => {
+      const url = urlFromParams({ backendUrl: 'http://localhost' }, 'auth')
+
+      expect(url).toBe('http://localhost/v1/auth')
+    })
+
+    it('should return its value concatenated with "/v1/storage"', async () => {
+      const url = urlFromParams({ backendUrl: 'http://localhost:1337' }, 'storage')
+
+      expect(url).toBe('http://localhost:1337/v1/storage')
+    })
+  })
+
+  describe('using subdomain', () => {
+    describe('with an actual subdomain and region', () => {
+      it('should return the appropriate url', async () => {
+        const url = urlFromParams({ subdomain: 'myawesomedomain', region: 'eu-central-1' }, 'auth')
+
+        expect(url).toBe('https://myawesomedomain.auth.eu-central-1.nhost.run/v1')
+      })
+    })
+    
+    it('Missing region with subdomain should throw error', async () => {
+      expect(() => {
+        urlFromParams({ subdomain: 'myawesomedomain' }, 'auth')
+      }).toThrow('A region must be specified when using a `subdomain` other than "localhost".')
+    })
+
+    it('should return "http://localhost/v1/auth" when passed "localhost" and "auth"', async () => {
+      const url = urlFromParams({ subdomain: 'localhost' }, 'auth')
+
+      expect(url).toBe('http://localhost/v1/auth')
+    })
+
+    it('should return "http://localhost:1337/v1/storage" when passed "localhost:1337" and "storage"', async () => {
+      const url = urlFromParams({ subdomain: 'localhost:1337' }, 'storage')
+
+      expect(url).toBe('http://localhost:1337/v1/storage')
+    })
+  })
+})

packages/react-apollo/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @nhost/react-apollo
 
+## 4.4.2
+
+### Patch Changes
+
+- dbc10e62: fixed `exports` field to support imports in a server-side environment
+- Updated dependencies [dbc10e62]
+  - @nhost/apollo@0.5.18
+  - @nhost/react@0.9.2
+
+## 4.4.1
+
+### Patch Changes
+
+- @nhost/apollo@0.5.17
+- @nhost/react@0.9.1
+
 ## 4.4.0
 
 ### Patch Changes

packages/react-apollo/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nhost/react-apollo",
-  "version": "4.4.0",
+  "version": "4.4.2",
   "description": "Nhost React Apollo client",
   "license": "MIT",
   "keywords": [
@@ -33,7 +33,10 @@
   ],
   "exports": {
     ".": {
-      "import": "./dist/index.esm.js",
+      "import": {
+        "node": "./dist/index.cjs.js",
+        "default": "./dist/index.esm.js"
+      },
       "require": "./dist/index.cjs.js"
     }
   },

packages/react-auth/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @nhost/react-auth
 
+## 3.2.2
+
+### Patch Changes
+
+- dbc10e62: fixed `exports` field to support imports in a server-side environment
+- Updated dependencies [dbc10e62]
+  - @nhost/hasura-auth-js@1.3.1
+  - @nhost/react@0.9.2
+
+## 3.2.1
+
+### Patch Changes
+
+- @nhost/react@0.9.1
+
 ## 3.2.0
 
 ### Patch Changes

packages/react-auth/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nhost/react-auth",
-  "version": "3.2.0",
+  "version": "3.2.2",
   "description": "Nhost React client",
   "license": "MIT",
   "keywords": [
@@ -32,7 +32,10 @@
   ],
   "exports": {
     ".": {
-      "import": "./dist/index.esm.js",
+      "import": {
+        "node": "./dist/index.cjs.js",
+        "default": "./dist/index.esm.js"
+      },
       "require": "./dist/index.cjs.js"
     }
   },

packages/react/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @nhost/react
 
+## 0.9.2
+
+### Patch Changes
+
+- dbc10e62: fixed `exports` field to support imports in a server-side environment
+- Updated dependencies [dbc10e62]
+  - @nhost/core@0.7.2
+  - @nhost/nhost-js@1.4.2
+
+## 0.9.1
+
+### Patch Changes
+
+- Updated dependencies [b8f4b75b]
+  - @nhost/nhost-js@1.4.1
+
 ## 0.9.0
 
 ### Minor Changes

packages/react/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nhost/react",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "description": "Nhost React library",
   "license": "MIT",
   "keywords": [
@@ -32,7 +32,10 @@
   ],
   "exports": {
     ".": {
-      "import": "./dist/index.esm.js",
+      "import": {
+        "node": "./dist/index.cjs.js",
+        "default": "./dist/index.esm.js"
+      },
       "require": "./dist/index.cjs.js"
     }
   },

packages/react/src/client.ts

@@ -1,7 +1,11 @@
-import { NhostClient as VanillaClient, NhostClientConstructorParams } from '@nhost/nhost-js'
+import { Subdomain } from '@nhost/nhost-js'
+import { BackendUrl } from '@nhost/nhost-js'
+import { NhostAuthConstructorParams, NhostClient as VanillaClient } from '@nhost/nhost-js'
 
 export interface NhostReactClientConstructorParams
-  extends Omit<NhostClientConstructorParams, 'start' | 'client'> {}
+  extends Partial<BackendUrl>,
+    Partial<Subdomain>,
+    Omit<NhostAuthConstructorParams, 'url' | 'start' | 'client'> {}
 
 export class NhostClient extends VanillaClient {
   constructor(params: NhostReactClientConstructorParams) {

packages/vue/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @nhost/vue
 
+## 0.3.2
+
+### Patch Changes
+
+- dbc10e62: fixed `exports` field to support imports in a server-side environment
+- Updated dependencies [dbc10e62]
+  - @nhost/core@0.7.2
+  - @nhost/nhost-js@1.4.2
+
+## 0.3.1
+
+### Patch Changes
+
+- Updated dependencies [b8f4b75b]
+  - @nhost/nhost-js@1.4.1
+
 ## 0.3.0
 
 ### Minor Changes

packages/vue/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nhost/vue",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "Nhost Vue library",
   "license": "MIT",
   "keywords": [
@@ -32,7 +32,10 @@
   ],
   "exports": {
     ".": {
-      "import": "./dist/index.esm.js",
+      "import": {
+        "node": "./dist/index.cjs.js",
+        "default": "./dist/index.esm.js"
+      },
       "require": "./dist/index.cjs.js"
     }
   },

packages/vue/src/client.ts

@@ -1,11 +1,19 @@
 import { App, getCurrentInstance } from 'vue'
 import { Router } from 'vue-router'
 
-import { NhostClient as VanillaClient, NhostClientConstructorParams } from '@nhost/nhost-js'
+import {
+  BackendUrl,
+  NhostAuthConstructorParams,
+  NhostClient as VanillaClient,
+  Subdomain
+} from '@nhost/nhost-js'
 
 import { DefaultNhostClient } from './useNhostClient'
+
 export interface NhostVueClientConstructorParams
-  extends Omit<NhostClientConstructorParams, 'start' | 'client'> {}
+  extends Partial<BackendUrl>,
+    Partial<Subdomain>,
+    Omit<NhostAuthConstructorParams, 'url' | 'start' | 'client'> {}
 
 export class NhostClient extends VanillaClient {
   constructor(params: NhostVueClientConstructorParams) {