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

chore: update versions

.github/workflows/changesets.yaml

@@ -5,7 +5,6 @@ on:
     branches: [main]
     paths-ignore:
       - 'docs/**'
-      - 'templates/**'
       - 'examples/**'
       - 'assets/**'
       - '**.md'

.github/workflows/tests.yaml

@@ -5,7 +5,6 @@ on:
     branches: [main]
     paths-ignore:
       - 'docs/**'
-      - 'templates/**'
       - 'assets/**'
       - '**.md'
       - 'LICENSE'
@@ -14,7 +13,6 @@ on:
     types: [opened, synchronize]
     paths-ignore:
       - 'docs/**'
-      - 'templates/**'
       - 'assets/**'
       - '**.md'
       - 'LICENSE'

README.md

@@ -87,12 +87,12 @@ await nhost.graphql.request(`{
 Nhost is frontend agnostic, which means Nhost works with all frontend frameworks.
 
 <div align="center">
-  <a href="https://github.com/nhost/nhost/tree/main/templates/web/nextjs-apollo"><img src="assets/nextjs.svg"/></a>
+  <a href="https://docs.nhost.io/platform/quickstarts/nextjs"><img src="assets/nextjs.svg"/></a>
-  <a href="https://github.com/nhost/nhost/tree/main/examples/nuxt-apollo"><img src="assets/nuxtjs.svg"/></a>
+  <a href="https://docs.nhost.io/reference/javascript"><img src="assets/nuxtjs.svg"/></a>
-  <a href="https://github.com/nhost/nhost/tree/main/templates/web/react-apollo"><img src="assets/react.svg"/></a>
+  <a href="https://docs.nhost.io/platform/quickstarts/react"><img src="assets/react.svg"/></a>
-  <img src="assets/react-native.svg"/>
+  <a href="https://docs.nhost.io/reference/javascript"><img src="assets/react-native.svg"/></a>
-  <a href="https://github.com/nhost/nhost/tree/main/packages/nhost-js"><img src="assets/svelte.svg"/></a>
+  <a href="https://docs.nhost.io/reference/javascript"><img src="assets/svelte.svg"/></a>
-  <a href="https://github.com/nhost/nhost/tree/main/packages/nhost-js"><img src="assets/vuejs.svg"/></a>
+  <a href="https://docs.nhost.io/platform/quickstarts/vue"><img src="assets/vuejs.svg"/></a>
 </div>
 
 # Resources
@@ -383,14 +383,21 @@ 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/eltociear">
+            <img src="https://avatars.githubusercontent.com/u/22633385?v=4" width="100;" alt="eltociear"/>
+            <br />
+            <sub><b>Ikko Ashimine</b></sub>
+        </a>
+    </td></tr>
+<tr>
     <td align="center">
         <a href="https://github.com/jladuval">
             <img src="https://avatars.githubusercontent.com/u/1935359?v=4" width="100;" alt="jladuval"/>
             <br />
             <sub><b>Jacob Duval</b></sub>
         </a>
-    </td></tr>
+    </td>
-<tr>
     <td align="center">
         <a href="https://github.com/kylehayes">
             <img src="https://avatars.githubusercontent.com/u/509932?v=4" width="100;" alt="kylehayes"/>
@@ -425,15 +432,15 @@ Here are some ways of contributing to making Nhost better:
             <br />
             <sub><b>Nacho Aldama</b></sub>
         </a>
-    </td>
+    </td></tr>
+<tr>
     <td align="center">
         <a href="https://github.com/ghoshnirmalya">
             <img src="https://avatars.githubusercontent.com/u/6391763?v=4" width="100;" alt="ghoshnirmalya"/>
             <br />
             <sub><b>Nirmalya Ghosh</b></sub>
         </a>
-    </td></tr>
+    </td>
-<tr>
     <td align="center">
         <a href="https://github.com/quentin-decre">
             <img src="https://avatars.githubusercontent.com/u/1137511?v=4" width="100;" alt="quentin-decre"/>

docs/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @nhost/docs
 
+## 0.0.3
+
+### Patch Changes
+
+- eb46f7d8: Use port 1337 if no port is specified when using "localhost" as `subdomain`.
+
 ## 0.0.2
 
 ### Patch Changes

docs/docs/platform/authentication/users.mdx

@@ -39,7 +39,7 @@ query {
 
 Users should be created using the sign-up or sign-in flows as described under [sign-in methods](/platform/authentication/sign-in-methods).
 
-- **Never** create users directly via GraphQL or database.
+- **Never** create users directly via GraphQL or database, unless you [import users](#import-users) from an external system.
 - **Never** modify the `auth.users` table.
 - **Never** modify the GraphQL root queries or fields for any of the tables in the `auth` schema.
 
@@ -136,3 +136,31 @@ await nhost.auth.signUp({
   }
 })
 ```
+
+## Import Users
+
+If you have users in a different system, you can import them into Nhost. When importing users you should insert the users directly into the database instead of using the authentication endpoints (`/signup/email-password`).
+
+It's possible to insert users via GraphQL or SQL.
+
+### GraphQL
+
+Make a GraphQL request to insert a user like this:
+
+```graphql
+mutation insertUser($user: users_insert_input!) {
+  insertUser(object: $user) {
+    id
+  }
+}
+```
+
+### SQL
+
+Connect directly to the database and insert a user like this:
+
+```sql
+INSERT INTO auth.users (id, email, display_name, password_hash, ..) VALUES ('<user-id>', '<email>', '<display-name>', '<password-hash>', ..);
+```
+
+User passwords are hashed using [bcrypt](https://en.wikipedia.org/wiki/Bcrypt) in Nhost.

docs/docs/platform/cli.mdx

@@ -79,17 +79,17 @@ Then start the Nhost project locally:
 nhost up
 ```
 
-Hasura Console starts automatically and your Nhost project is running locally with the backend URL: `http://localhost:1337`.
+Hasura Console starts automatically and your Nhost project is running locally.
 
 ## Subdomain and Region
 
-Use `localhost:1337` as the `subdomain`, and skip `region` when using the CLI and the [JavaScript SDK](/reference/javascript):
+Use `localhost` as the `subdomain`, and skip `region` when using the CLI and the [JavaScript SDK](/reference/javascript):
 
 ```
 import { NhostClient } from '@nhost/nhost-js'
 
 const nhost = new NhostClient({
-  subdomain: 'localhost:1337',
+  subdomain: 'localhost',
 })
 ```
 
@@ -97,12 +97,22 @@ const nhost = new NhostClient({
 
 During local development with the CLI, all transactional emails from Authentication are sent to a local Mailhog instance, instead of to the recipient's email address. You'll see an address where after starting [`nhost up`](/reference/cli/up) where all emails are sent to.
 
-For the example below, all emails are accessable at `http://localhost:8839`.
+For the example below, all emails are accessible at `http://localhost:8025`.
 
 ```bash
 $ nhost up
-✔ Your app is running at http://localhost:1337 (Ctrl+C to stop)
+URLs:
-ℹ Emails will be sent to http://localhost:8839
+- Postgres:         postgres://postgres:postgres@localhost:5432/postgres
+- GraphQL:          http://localhost:1337/v1/graphql
+- Auth:             http://localhost:1337/v1/auth
+- Storage:          http://localhost:1337/v1/storage
+- Functions:        http://localhost:1337/v1/functions
+
+- Hasura console:  http://localhost:9695
+- Mailhog:         http://localhost:8025
+
+- subdomain:       localhost
+- region:          (empty)
 ```
 
 ## What's next?

docs/docs/platform/overview/get-started-with-nhost-cli.mdx

@@ -198,7 +198,7 @@ Running this command will start up all the backend services provided by Nhost.
 It also runs a webserver to serve the Hasura Console for the GraphQL Engine so
 you can manage the database and test the GraphQL API.
 
-The Hasura Console opens automatically at [http://localhost:1337](http://localhost:1337/).
+The Hasura Console opens automatically at [http://localhost:9695](http://localhost:9695/).
 
 ![Hasura Console](/img/architecture/cli/hasura-console.png)
 

docs/docs/reference/cli/init.mdx

@@ -3,7 +3,7 @@ title: 'init'
 sidebar_position: 1
 ---
 
-Intialize a local Nhost project in the current working directory.
+Initialize a local Nhost project in the current working directory.
 
 ```
 nhost init

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

@@ -4,7 +4,7 @@ title: signUp()
 sidebar_label: signUp()
 slug: /reference/javascript/auth/sign-up
 description: Use `nhost.auth.signUp` to sign up a user using email and password. If you want to sign up a user using passwordless email (Magic Link), SMS, or an OAuth provider, use the `signIn` function instead.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L103
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L107
 ---
 
 # `signUp()`
@@ -22,12 +22,6 @@ nhost.auth.signUp({
 
 ---
 
-**<span className="parameter-name">\_\_namedParameters</span>** <span className="optional-status">required</span> [`SignUpEmailPasswordParams`](/reference/docgen/javascript/auth/types/sign-up-email-password-params)
+**<span className="parameter-name">params</span>** <span className="optional-status">required</span> [`SignUpParams`](/reference/docgen/javascript/auth/types/sign-up-params)
-
-| Property                                                                                                 | Type            | Required | Notes |
-| :------------------------------------------------------------------------------------------------------- | :-------------- | :------: | :---- |
-| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>password</span> | `string`        |    ✔️    |       |
-| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>email</span>    | `string`        |    ✔️    |       |
-| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>options</span>  | `SignUpOptions` |          |       |
 
 ---

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

@@ -4,7 +4,7 @@ title: signIn()
 sidebar_label: signIn()
 slug: /reference/javascript/auth/sign-in
 description: Use `nhost.auth.signIn` to sign in a user using email and password, passwordless (email or sms) or an external provider. `signIn` can be used to sign in a user in various ways depending on the parameters.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L146
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L156
 ---
 
 # `signIn()`

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

@@ -4,7 +4,7 @@ title: signOut()
 sidebar_label: signOut()
 slug: /reference/javascript/auth/sign-out
 description: Use `nhost.auth.signOut` to sign out the user.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L231
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L252
 ---
 
 # `signOut()`

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

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

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

@@ -4,7 +4,7 @@ title: changePassword()
 sidebar_label: changePassword()
 slug: /reference/javascript/auth/change-password
 description: Use `nhost.auth.changePassword` to change the password for the signed-in user. The old password is not needed. In case the user is not signed-in, a password reset ticket needs to be provided.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L263
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L284
 ---
 
 # `changePassword()`

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

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

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

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

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

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

docs/docs/reference/docgen/javascript/auth/content/hasura-auth-client/content/09-add-security-key.mdx

@@ -0,0 +1,22 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: addSecurityKey()
+sidebar_label: addSecurityKey()
+slug: /reference/javascript/auth/add-security-key
+description: Use `nhost.auth.addSecurityKey to add a security key to the user, using the WebAuthn API.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L376
+---
+
+# `addSecurityKey()`
+
+Use `nhost.auth.addSecurityKey to add a security key to the user, using the WebAuthn API.
+
+## Parameters
+
+---
+
+**<span className="parameter-name">nickname</span>** <span className="optional-status">optional</span> `string`
+
+optional human-readable nickname for the security key
+
+---

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

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

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

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

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

@@ -4,7 +4,7 @@ title: isAuthenticated()
 sidebar_label: isAuthenticated()
 slug: /reference/javascript/auth/is-authenticated
 description: Use `nhost.auth.isAuthenticated` to check if the user is authenticated or not.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L434
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L471
 ---
 
 # `isAuthenticated()`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -4,7 +4,7 @@ title: HasuraAuthClient
 sidebar_label: Auth
 description: No description provided.
 slug: /reference/javascript/auth
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L60
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L64
 ---
 
 # `HasuraAuthClient`

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

@@ -1,18 +0,0 @@
----
-# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
-title: ApiChangeEmailResponse
-sidebar_label: ApiChangeEmailResponse
-description: No description provided.
-displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L182
----
-
-# `ApiChangeEmailResponse`
-
-## Parameters
-
----
-
-**<span className="parameter-name">error</span>** <span className="optional-status">required</span> `null` | `ErrorPayload`
-
----

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

@@ -1,18 +0,0 @@
----
-# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
-title: ApiChangePasswordResponse
-sidebar_label: ApiChangePasswordResponse
-description: No description provided.
-displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L174
----
-
-# `ApiChangePasswordResponse`
-
-## Parameters
-
----
-
-**<span className="parameter-name">error</span>** <span className="optional-status">required</span> `null` | `ErrorPayload`
-
----

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

@@ -1,18 +0,0 @@
----
-# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
-title: ApiDeanonymizeResponse
-sidebar_label: ApiDeanonymizeResponse
-description: No description provided.
-displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L186
----
-
-# `ApiDeanonymizeResponse`
-
-## Parameters
-
----
-
-**<span className="parameter-name">error</span>** <span className="optional-status">required</span> `null` | `ErrorPayload`
-
----

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

@@ -1,16 +0,0 @@
----
-# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
-title: ApiRefreshTokenResponse
-sidebar_label: ApiRefreshTokenResponse
-description: No description provided.
-displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L162
----
-
-# `ApiRefreshTokenResponse`
-
-```ts
-type ApiRefreshTokenResponse =
-  | { session: null; error: ErrorPayload }
-  | { session: Session; error: null }
-```

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

@@ -1,18 +0,0 @@
----
-# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
-title: ApiResetPasswordResponse
-sidebar_label: ApiResetPasswordResponse
-description: No description provided.
-displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L170
----
-
-# `ApiResetPasswordResponse`
-
-## Parameters
-
----
-
-**<span className="parameter-name">error</span>** <span className="optional-status">required</span> `null` | `ErrorPayload`
-
----

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

@@ -1,18 +0,0 @@
----
-# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
-title: ApiSendVerificationEmailResponse
-sidebar_label: ApiSendVerificationEmailResponse
-description: No description provided.
-displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L178
----
-
-# `ApiSendVerificationEmailResponse`
-
-## Parameters
-
----
-
-**<span className="parameter-name">error</span>** <span className="optional-status">required</span> `null` | `ErrorPayload`
-
----

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

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

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

@@ -1,16 +0,0 @@
----
-# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
-title: ApiSignInResponse
-sidebar_label: ApiSignInResponse
-description: No description provided.
-displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L155
----
-
-# `ApiSignInResponse`
-
-```ts
-type ApiSignInResponse =
-  | { data: ApiSignInData; error: null }
-  | { data: null; error: ErrorPayload }
-```

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

@@ -1,18 +0,0 @@
----
-# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
-title: ApiSignOutResponse
-sidebar_label: ApiSignOutResponse
-description: No description provided.
-displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L166
----
-
-# `ApiSignOutResponse`
-
-## Parameters
-
----
-
-**<span className="parameter-name">error</span>** <span className="optional-status">required</span> `null` | `ErrorPayload`
-
----

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

@@ -1,16 +0,0 @@
----
-# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
-title: ApiSignUpEmailPasswordResponse
-sidebar_label: ApiSignUpEmailPasswordResponse
-description: No description provided.
-displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L147
----
-
-# `ApiSignUpEmailPasswordResponse`
-
-```ts
-type ApiSignUpEmailPasswordResponse =
-  | { session: null; error: ErrorPayload }
-  | { session: Session; error: null }
-```

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

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

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

@@ -4,7 +4,7 @@ title: AuthChangedFunction
 sidebar_label: AuthChangedFunction
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L137
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L120
 ---
 
 # `AuthChangedFunction`
@@ -12,6 +12,6 @@ custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-j
 ```ts
 type AuthChangedFunction = () => (
   event: AuthChangeEvent,
-  session: Session | null
+  session: NhostSession | null
 ) => void
 ```

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

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

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

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

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

@@ -1,18 +1,18 @@
 ---
 # ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
-title: Mfa
+title: CommonSignUpParams
-sidebar_label: Mfa
+sidebar_label: CommonSignUpParams
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L143
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L25
 ---
 
-# `Mfa`
+# `CommonSignUpParams`
 
 ## Parameters
 
 ---
 
-**<span className="parameter-name">ticket</span>** <span className="optional-status">required</span> `string`
+**<span className="parameter-name">options</span>** <span className="optional-status">optional</span> `SignUpOptions`
 
 ---

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

@@ -4,14 +4,14 @@ title: DeanonymizeParams
 sidebar_label: DeanonymizeParams
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L111
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L104
 ---
 
 # `DeanonymizeParams`
 
 ```ts
 type DeanonymizeParams =
-  | ({ signInMethod: 'email-password' } & SignUpParams)
+  | ({ signInMethod: 'email-password' } & SignUpEmailPasswordParams)
   | ({
       signInMethod: 'passwordless'
       connection: 'email'

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

@@ -1,18 +0,0 @@
----
-# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
-title: Headers
-sidebar_label: Headers
-description: No description provided.
-displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L140
----
-
-# `Headers`
-
-## Parameters
-
----
-
-**<span className="parameter-name">Authorization</span>** <span className="optional-status">optional</span> `string`
-
----

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

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

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

@@ -4,11 +4,11 @@ title: OnTokenChangedFunction
 sidebar_label: OnTokenChangedFunction
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L139
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L122
 ---
 
 # `OnTokenChangedFunction`
 
 ```ts
-type OnTokenChangedFunction = () => (session: Session | null) => void
+type OnTokenChangedFunction = () => (session: NhostSession | null) => void
 ```

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

@@ -4,7 +4,7 @@ title: Provider
 sidebar_label: Provider
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/core/src/types.ts#L140
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/core/src/types.ts#L153
 ---
 
 # `Provider`
@@ -24,4 +24,5 @@ type Provider =
   | 'bitbucket'
   | 'discord'
   | 'twitch'
+  | 'workos'
 ```

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

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

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

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

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

@@ -1,30 +0,0 @@
----
-# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
-title: Session
-sidebar_label: Session
-description: No description provided.
-displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L23
----
-
-# `Session`
-
-## Parameters
-
----
-
-**<span className="parameter-name">accessToken</span>** <span className="optional-status">required</span> `string`
-
----
-
-**<span className="parameter-name">accessTokenExpiresIn</span>** <span className="optional-status">required</span> `number`
-
----
-
-**<span className="parameter-name">refreshToken</span>** <span className="optional-status">required</span> `string`
-
----
-
-**<span className="parameter-name">user</span>** <span className="optional-status">required</span> `null` | [`User`](/reference/docgen/javascript/auth/types/user)
-
----

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

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

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

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

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

@@ -4,7 +4,7 @@ title: SignInParams
 sidebar_label: SignInParams
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L83
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L75
 ---
 
 # `SignInParams`
@@ -14,6 +14,7 @@ type SignInParams =
   | SignInEmailPasswordParams
   | SignInEmailPasswordOtpParams
   | SignInPasswordlessEmailParams
+  | SignInPasswordlessSecurityKeyParams
   | SignInPasswordlessSmsOtpParams
   | SignInPasswordlessSmsParams
   | SignInWithProviderOptions

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

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

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

@@ -0,0 +1,22 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignInPasswordlessSecurityKeyParams
+sidebar_label: SignInPasswordlessSecurityKeyParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L56
+---
+
+# `SignInPasswordlessSecurityKeyParams`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">email</span>** <span className="optional-status">required</span> `string`
+
+---
+
+**<span className="parameter-name">securityKey</span>** <span className="optional-status">required</span> `"true"`
+
+---

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

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

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

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

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

@@ -1,34 +0,0 @@
----
-# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
-title: SignInReponse
-sidebar_label: SignInReponse
-description: No description provided.
-displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L124
----
-
-# `SignInReponse`
-
-## Parameters
-
----
-
-**<span className="parameter-name">session</span>** <span className="optional-status">required</span> `null` | [`Session`](/reference/docgen/javascript/auth/types/session)
-
----
-
-**<span className="parameter-name">error</span>** <span className="optional-status">required</span> `null` | `ErrorPayload`
-
----
-
-**<span className="parameter-name">mfa</span>** <span className="optional-status">optional</span> `{ enabled: boolean, ticket: string }`
-
----
-
-**<span className="parameter-name">providerUrl</span>** <span className="optional-status">optional</span> `string`
-
----
-
-**<span className="parameter-name">provider</span>** <span className="optional-status">optional</span> `string`
-
----

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

@@ -1,34 +0,0 @@
----
-# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
-title: SignInResponse
-sidebar_label: SignInResponse
-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#L45
----
-
-# `SignInResponse`
-
-## Parameters
-
----
-
-**<span className="parameter-name">session</span>** <span className="optional-status">required</span> `null` | [`Session`](/reference/docgen/javascript/auth/types/session)
-
----
-
-**<span className="parameter-name">mfa</span>** <span className="optional-status">required</span> `null` | `{ ticket: string }`
-
----
-
-**<span className="parameter-name">error</span>** <span className="optional-status">required</span> `null` | `ErrorPayload`
-
----
-
-**<span className="parameter-name">providerUrl</span>** <span className="optional-status">optional</span> `string`
-
----
-
-**<span className="parameter-name">provider</span>** <span className="optional-status">optional</span> `string`
-
----

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

@@ -4,19 +4,13 @@ title: SignInWithProviderOptions
 sidebar_label: SignInWithProviderOptions
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L78
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L71
 ---
 
 # `SignInWithProviderOptions`
 
-## Parameters
+```ts
-
+type SignInWithProviderOptions =
----
+  | { provider: Exclude<Provider, 'workos'>; options: CommonProviderOptions }
-
+  | { provider: 'workos'; options: WorkOsOptions }
-**<span className="parameter-name">provider</span>** <span className="optional-status">required</span> [`Provider`](/reference/docgen/javascript/auth/types/provider)
+```
-
----
-
-**<span className="parameter-name">options</span>** <span className="optional-status">optional</span> `ProviderOptions`
-
----

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

@@ -4,7 +4,7 @@ title: SignUpEmailPasswordParams
 sidebar_label: SignUpEmailPasswordParams
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L31
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L29
 ---
 
 # `SignUpEmailPasswordParams`
@@ -13,7 +13,7 @@ custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-j
 
 ---
 
-**<span className="parameter-name">password</span>** <span className="optional-status">required</span> `string`
+**<span className="parameter-name">options</span>** <span className="optional-status">optional</span> `SignUpOptions`
 
 ---
 
@@ -21,6 +21,6 @@ custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-j
 
 ---
 
-**<span className="parameter-name">options</span>** <span className="optional-status">optional</span> `SignUpOptions`
+**<span className="parameter-name">password</span>** <span className="optional-status">required</span> `string`
 
 ---

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

@@ -4,7 +4,11 @@ title: SignUpParams
 sidebar_label: SignUpParams
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L37
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L40
 ---
 
 # `SignUpParams`
+
+```ts
+type SignUpParams = SignUpEmailPasswordParams | SignUpSecurityKeyParams
+```

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

@@ -1,16 +0,0 @@
----
-# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
-title: SignUpResponse
-sidebar_label: SignUpResponse
-description: No description provided.
-displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/utils/types.ts#L39
----
-
-# `SignUpResponse`
-
-```ts
-type SignUpResponse =
-  | { session: null; error: ErrorPayload }
-  | { session: Session | null; error: null }
-```

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

@@ -0,0 +1,26 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: SignUpSecurityKeyParams
+sidebar_label: SignUpSecurityKeyParams
+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#L34
+---
+
+# `SignUpSecurityKeyParams`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">email</span>** <span className="optional-status">required</span> `string`
+
+---
+
+**<span className="parameter-name">options</span>** <span className="optional-status">optional</span> `SignUpSecurityKeyOptions`
+
+---
+
+**<span className="parameter-name">securityKey</span>** <span className="optional-status">required</span> `"true"`
+
+---

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

@@ -4,7 +4,7 @@ title: User
 sidebar_label: User
 description: User information
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/core/src/types.ts#L93
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/core/src/types.ts#L106
 ---
 
 # `User`

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

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

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

@@ -3,25 +3,25 @@
 title: upload()
 sidebar_label: upload()
 slug: /reference/javascript/storage/upload
-description: Use `nhost.storage.upload` to upload a file. The `file` must be of type [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File).
+description: Use `nhost.storage.upload` to upload a file.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/hasura-storage-client.ts#L52
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/hasura-storage-client.ts#L76
 ---
 
 # `upload()`
 
-Use `nhost.storage.upload` to upload a file. The `file` must be of type [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File).
+## Overload 1 of 2
 
-If no `bucket` is specified the `default` bucket will be used.
+Use `nhost.storage.upload` to upload a file.
 
-```ts
+It's possible to use [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) or [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) to upload a file. The `File` instance is only available in the browser while `FormData` with [`form-data`](https://www.npmjs.com/package/form-data) works both in the browser and in NodeJS (server).
-await nhost.storage.upload({ file })
-```
 
-## Parameters
+If no `bucketId` is specified the bucket `default` is used.
+
+### Parameters
 
 ---
 
-**<span className="parameter-name">params</span>** <span className="optional-status">required</span> [`StorageUploadParams`](/reference/docgen/javascript/storage/types/storage-upload-params)
+**<span className="parameter-name">params</span>** <span className="optional-status">required</span> [`StorageUploadFileParams`](/reference/docgen/javascript/storage/types/storage-upload-file-params)
 
 | Property                                                                                    | Type     | Required | Notes |
 | :------------------------------------------------------------------------------------------ | :------- | :------: | :---- |
@@ -32,12 +32,44 @@ await nhost.storage.upload({ file })
 
 ---
 
-## Examples
+### Examples
+
+Upload a file from a browser using `File`.
 
 ```ts
 await nhost.storage.upload({ file })
 ```
 
+Upload a file from a browser using `File` to a specific Bucket.
+
 ```ts
 await nhost.storage.upload({ file, bucketId: '<Bucket-ID>' })
 ```
+
+Upload a file from a server using `FormData` with [`form-data`](https://www.npmjs.com/package/form-data).
+
+```ts
+const fd = new FormData()
+fd.append('file', fs.createReadStream('./tests/assets/sample.pdf'))
+
+await storage.upload({
+  formData: fd
+})
+```
+
+## Overload 2 of 2
+
+### Parameters
+
+---
+
+**<span className="parameter-name">params</span>** <span className="optional-status">required</span> [`StorageUploadFormDataParams`](/reference/docgen/javascript/storage/types/storage-upload-form-data-params)
+
+| Property                                                                                    | Type       | Required | Notes |
+| :------------------------------------------------------------------------------------------ | :--------- | :------: | :---- |
+| <span className="parameter-name"><span className="light-grey">params.</span>formData</span> | `FormData` |    ✔️    |       |
+| <span className="parameter-name"><span className="light-grey">params.</span>bucketId</span> | `string`   |          |       |
+| <span className="parameter-name"><span className="light-grey">params.</span>name</span>     | `string`   |          |       |
+| <span className="parameter-name"><span className="light-grey">params.</span>id</span>       | `string`   |          |       |
+
+---

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

@@ -5,7 +5,7 @@ sidebar_label: getUrl()
 slug: /reference/javascript/storage/get-url
 sidebar_class_name: deprecated
 description: No description provided.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/hasura-storage-client.ts#L74
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/hasura-storage-client.ts#L106
 ---
 
 # `getUrl()`

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -27,6 +27,6 @@ custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storag
 
 ---
 
-**<span className="parameter-name">params</span>** <span className="optional-status">required</span> `Partial<StorageUploadParams>`
+**<span className="parameter-name">params</span>** <span className="optional-status">required</span> `Partial<StorageUploadFileParams>`
 
 ---

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

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

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

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

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

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

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

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

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

@@ -4,7 +4,7 @@ title: ApiUploadParams
 sidebar_label: ApiUploadParams
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/utils/types.ts#L50
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/utils/types.ts#L65
 ---
 
 # `ApiUploadParams`
@@ -13,7 +13,7 @@ custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storag
 
 ---
 
-**<span className="parameter-name">file</span>** <span className="optional-status">required</span> `FormData`
+**<span className="parameter-name">formData</span>** <span className="optional-status">required</span> `FormData`
 
 ---
 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,30 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: StorageUploadFileParams
+sidebar_label: StorageUploadFileParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/utils/types.ts#L13
+---
+
+# `StorageUploadFileParams`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">file</span>** <span className="optional-status">required</span> `File`
+
+---
+
+**<span className="parameter-name">bucketId</span>** <span className="optional-status">optional</span> `string`
+
+---
+
+**<span className="parameter-name">name</span>** <span className="optional-status">optional</span> `string`
+
+---
+
+**<span className="parameter-name">id</span>** <span className="optional-status">optional</span> `string`
+
+---

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

@@ -0,0 +1,30 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: StorageUploadFormDataParams
+sidebar_label: StorageUploadFormDataParams
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/utils/types.ts#L21
+---
+
+# `StorageUploadFormDataParams`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">formData</span>** <span className="optional-status">required</span> `FormData`
+
+---
+
+**<span className="parameter-name">bucketId</span>** <span className="optional-status">optional</span> `string`
+
+---
+
+**<span className="parameter-name">name</span>** <span className="optional-status">optional</span> `string`
+
+---
+
+**<span className="parameter-name">id</span>** <span className="optional-status">optional</span> `string`
+
+---

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

@@ -4,27 +4,11 @@ title: StorageUploadParams
 sidebar_label: StorageUploadParams
 description: No description provided.
 displayed_sidebar: referenceSidebar
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/utils/types.ts#L9
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storage-js/src/packages/hasura-storage-js/src/utils/types.ts#L29
 ---
 
 # `StorageUploadParams`
 
-## Parameters
+```ts
-
+type StorageUploadParams = StorageUploadFileParams | StorageUploadFormDataParams
----
+```
-
-**<span className="parameter-name">file</span>** <span className="optional-status">required</span> `File`
-
----
-
-**<span className="parameter-name">bucketId</span>** <span className="optional-status">optional</span> `string`
-
----
-
-**<span className="parameter-name">name</span>** <span className="optional-status">optional</span> `string`
-
----
-
-**<span className="parameter-name">id</span>** <span className="optional-status">optional</span> `string`
-
----

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

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

docs/docs/reference/docgen/javascript/storage/types/upload-headers.mdx

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

docs/docs/reference/docgen/nextjs/content/use-add-security-key.mdx

@@ -0,0 +1,22 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: useAddSecurityKey()
+sidebar_label: useAddSecurityKey()
+slug: /reference/nextjs/use-add-security-key
+description: Use the hook `useAddSecurityKey` to add a WebAuthn security key.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/useAddSecurityKey.ts#L45
+---
+
+# `useAddSecurityKey()`
+
+Use the hook `useAddSecurityKey` to add a WebAuthn security key.
+
+```tsx
+const { add, isLoading, isSuccess, isError, error } = useAddSecurityKey()
+
+const handleFormSubmit = async (e) => {
+  e.preventDefault()
+
+  await add('key nickname')
+}
+```

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

@@ -0,0 +1,31 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: useSignInEmailSecurityKey()
+sidebar_label: useSignInEmailSecurityKey()
+slug: /reference/nextjs/use-sign-in-email-security-key
+description: Use the hook `useSignInEmailSecurityKey` to sign in a user using their email and a security key using the WebAuthn API.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/useSignInEmailSecurityKey.ts#L41
+---
+
+# `useSignInEmailSecurityKey()`
+
+Use the hook `useSignInEmailSecurityKey` to sign in a user using their email and a security key using the WebAuthn API.
+
+```tsx
+const {
+  signInEmailSecurityKey,
+  needsEmailVerification,
+  isLoading,
+  isSuccess,
+  isError,
+  error
+} = useSignInEmailSecurityKey()
+
+console.log({ needsEmailVerification, isLoading, isSuccess, isError, error })
+
+const handleFormSubmit = async (e) => {
+  e.preventDefault()
+
+  await signInEmailSecurityKey('joe@example.com')
+}
+```

docs/docs/reference/docgen/nextjs/content/use-sign-up-email-security-key-email.mdx

@@ -0,0 +1,39 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: useSignUpEmailSecurityKeyEmail()
+sidebar_label: useSignUpEmailSecurityKeyEmail()
+slug: /reference/nextjs/use-sign-up-email-security-key-email
+description: Use the hook `useSignUpEmailSecurityKey` to sign up a user with security key and an email using the WebAuthn API.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/useSignUpEmailSecurityKey.ts#L43
+---
+
+# `useSignUpEmailSecurityKeyEmail()`
+
+Use the hook `useSignUpEmailSecurityKey` to sign up a user with security key and an email using the WebAuthn API.
+
+```tsx
+const {
+  signUpEmailSecurityKey,
+  needsEmailVerification,
+  isLoading,
+  isSuccess,
+  isError,
+  error
+} = useSignUpEmailSecurityKey()
+
+console.log({ needsEmailVerification, isLoading, isSuccess, isError, error })
+
+const handleFormSubmit = async (e) => {
+  e.preventDefault()
+
+  await signUpEmailSecurityKey('joe@example.com')
+}
+```
+
+## Parameters
+
+---
+
+**<span className="parameter-name">options</span>** <span className="optional-status">optional</span> `SignUpSecurityKeyOptions`
+
+---

docs/docs/reference/docgen/nextjs/types/add-securit-key-hook-result.mdx

@@ -0,0 +1,44 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: AddSecuritKeyHookResult
+sidebar_label: AddSecuritKeyHookResult
+description: No description provided.
+displayed_sidebar: referenceSidebar
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/react/src/useAddSecurityKey.ts#L20
+---
+
+# `AddSecuritKeyHookResult`
+
+## Parameters
+
+---
+
+**<span className="parameter-name">isError</span>** <span className="optional-status">required</span> `boolean`
+
+**`@returns`**
+
+`true` if an error occurred
+
+**`@depreacted`**
+
+use `!isSuccess` or `!!error` instead
+
+---
+
+**<span className="parameter-name">error</span>** <span className="optional-status">required</span> `null` | `ErrorPayload`
+
+Provides details about the error
+
+---
+
+**<span className="parameter-name">isSuccess</span>** <span className="optional-status">required</span> `boolean`
+
+Returns `true` if the action is successful.
+
+---
+
+**<span className="parameter-name">add</span>** <span className="optional-status">required</span> `AddSecurityKeyHandler`
+
+Add a security key to the current user with the WebAuthn API
+
+---

docs/docs/reference/docgen/nextjs/types/file-upload-hook-result.mdx

@@ -67,11 +67,11 @@ Returns the name of the file.
 
 ---
 
-**<span className="parameter-name">add</span>** <span className="optional-status">required</span> `(params: StorageUploadParams) => void`
+**<span className="parameter-name">add</span>** <span className="optional-status">required</span> `(params: StorageUploadFileParams) => void`
 
 ---
 
-**<span className="parameter-name">upload</span>** <span className="optional-status">required</span> `(params: Partial<StorageUploadParams>) => Promise<UploadFileHandlerResult>`
+**<span className="parameter-name">upload</span>** <span className="optional-status">required</span> `(params: Partial<StorageUploadFileParams>) => Promise<UploadFileHandlerResult>`
 
 ---