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

chore: update versions

README.md

@@ -4,11 +4,11 @@
 
 # Nhost
 
-<a href="https://docs.nhost.io/get-started">Quickstart</a>
+<a href="https://docs.nhost.io/#quickstart">Quickstart</a>
 <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
 <a href="http://nhost.io/">Website</a>
 <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-<a href="https://docs.nhost.io/get-started">Docs</a>
+<a href="https://docs.nhost.io">Docs</a>
 <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
 <a href="https://nhost.io/blog">Blog</a>
 <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
@@ -134,13 +134,6 @@ Here are some ways of contributing to making Nhost better:
             <sub><b>Pilou</b></sub>
         </a>
     </td>
-    <td align="center">
-        <a href="https://github.com/szilarddoro">
-            <img src="https://avatars.githubusercontent.com/u/310881?v=4" width="100;" alt="szilarddoro"/>
-            <br />
-            <sub><b>Szilárd Dóró</b></sub>
-        </a>
-    </td>
     <td align="center">
         <a href="https://github.com/elitan">
             <img src="https://avatars.githubusercontent.com/u/331818?v=4" width="100;" alt="elitan"/>
@@ -148,6 +141,13 @@ Here are some ways of contributing to making Nhost better:
             <sub><b>Johan Eliasson</b></sub>
         </a>
     </td>
+    <td align="center">
+        <a href="https://github.com/szilarddoro">
+            <img src="https://avatars.githubusercontent.com/u/310881?v=4" width="100;" alt="szilarddoro"/>
+            <br />
+            <sub><b>Szilárd Dóró</b></sub>
+        </a>
+    </td>
     <td align="center">
         <a href="https://github.com/gdangelo">
             <img src="https://avatars.githubusercontent.com/u/4352286?v=4" width="100;" alt="gdangelo"/>
@@ -327,21 +327,28 @@ Here are some ways of contributing to making Nhost better:
             <sub><b>Jacob Duval</b></sub>
         </a>
     </td>
+    <td align="center">
+        <a href="https://github.com/leothorp">
+            <img src="https://avatars.githubusercontent.com/u/12928449?v=4" width="100;" alt="leothorp"/>
+            <br />
+            <sub><b>Leo Thorp</b></sub>
+        </a>
+    </td>
     <td align="center">
         <a href="https://github.com/MarcelloTheArcane">
             <img src="https://avatars.githubusercontent.com/u/21159570?v=4" width="100;" alt="MarcelloTheArcane"/>
             <br />
             <sub><b>Max Reynolds</b></sub>
         </a>
-    </td>
+    </td></tr>
+<tr>
     <td align="center">
         <a href="https://github.com/ghoshnirmalya">
             <img src="https://avatars.githubusercontent.com/u/6391763?v=4" width="100;" alt="ghoshnirmalya"/>
             <br />
             <sub><b>Nirmalya Ghosh</b></sub>
         </a>
-    </td></tr>
-<tr>
+    </td>
     <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"/>

config/vite.lib.config.js

@@ -53,6 +53,7 @@ export default defineConfig({
         globals: {
           'graphql/language/printer': 'graphql/language/printer',
           '@apollo/client': '@apollo/client',
+          '@apollo/client/core': '@apollo/client/core',
           '@apollo/client/link/context': '@apollo/client/link/context',
           '@apollo/client/link/subscriptions': '@apollo/client/link/subscriptions',
           '@apollo/client/utilities': '@apollo/client/utilities',

docs/docs/get-started/authentication/index.md

@@ -1,125 +0,0 @@
----
-title: 'Authenticate users'
-slug: /get-started/authentication
----
-
-In the previous section, you defined `select` permissions for the `public` role. You will now add `insert` and `select` permissions for authenticated users to secure your app's GraphQL API with authentication.
-
-> Nhost's authentication service lets you deliver frictionless registration and login experiences to your users. We support most social providers and different methods such as email & password and passwordless (magic link).
-
----
-
-## Insert a test user
-
-Manually create a user by going to your app's **Users** tab (top menu) and clicking on **Add User**.
-
-<video width="99%" loop="" muted="" playsInline="" controls="true">
-  <source src="/videos/add-user.mp4" type="video/mp4" />
-</video>
-
-You will now use that newly created user. We'll use this newly created user to make authenticated requests to the GraphQL API.
-
----
-
-## Sign in and query data
-
-Add the following code to sign in the new user and request the list of todos again:
-
-```js
-import { NhostClient } from '@nhost/nhost-js';
-
-const nhost = new NhostClient({
-  backendUrl: 'https://[app-subdomain].nhost.run',
-})(async () => {
-  // Sign in user
-  const signInResponse = await nhost.auth.signIn({
-    email: 'joe@example.com',
-    password: 'securepassword',
-  });
-
-  // Handle sign-in error
-  if (signInResponse.error) {
-    throw signInResponse.error;
-  }
-
-  // Get todos
-  const todos = await nhost.graphql.request(`
-    query {
-      todos {
-        id
-        created_at
-        name
-        is_completed
-      }
-    }
-  `);
-
-  console.log(JSON.stringify(todos.data, null, 2));
-})();
-```
-
-Why is the return value `null`? Because when making GraphQL requests as an authenticated user, the `user` role is assumed.
-
-> For authenticated requests, there is always the option to override the default `user` role with any other valid role.
-
-To prepare our database and GraphQL API to work for signed-in users we need to do two things:
-
-1. Add a `user_id` column to the `todos` table, so we know what todo belongs to which user.
-2. Use the `user` role instead of the `public` role for permissions.
-
-## Add `user_id` column
-
-Before adding the `user_id` column, let's delete all existing todos.
-
-Then add the `user_id` column as a `UUID` type. Make sure that `nullable` is **not** checked. This will ensure that all todos must have a `user_id` value.
-
-At last, we'll create a connection between the `todos` table and the `users` table. For that, we need to do yet another two things:
-
-1. Create a Foreign Key (FK) between `todos` and `auth.users.id`.
-2. Let Hasura track the relationship between the two tables.
-
-<video width="99%" loop="" muted="" playsInline="" controls="true">
-  <source src="/videos/user-id-column.mp4" type="video/mp4" />
-</video>
-
-### Create FK
-
-Create a FK between the `auth.users.id` column and the `public.todos.user_id` column. See video above.
-
-### Track relationship
-
-Click on the `public` schema and track the untracked foreign key relationship. Then click on the `auth` schema and track the relationship again. See video above.
-
-We track these relationships to create the GrpahQL relationships between the `todos` table to the `users` table and the `users` table to the `todos` table.
-
-Ok, our `user_id` column is added and connected correctly. Let's continue with setting permissions for signed-in users.
-
-## Permissions for signed-in users
-
-Let us organize the permissions so it works for signed in users too.
-
-### Remove permissions for the public role
-
-We won't use the `public` role anymore, so let's remove all permission for that role.
-
-![Remove public permissions from Hasura](/img/quick-start/remove-public-permissions.png)
-
-Now we'll add permissions for the `user` role.
-
-> Signed-in users use the `user` role by default
-
-### Insert permission
-
-First, we'll set the **Insert permission**.
-
-A user can only insert `name` because all other columns will be set automatically. More specifically, `user_id` is set to the user's id making the request (`x-hasura-user-id`) and is configured in the `Column presets` section. See the image below.
-
-![User insert permission](/img/quick-start/user-insert-permission.png)
-
-### Select permission
-
-For **Select permission**, set a **custom check** so users can only select todos where `user_id` is the same as their user id. In other words: users are only allowed to select their own todos. See the image below.
-
-![User select permission](/img/quick-start/user-select-permission.png)
-
-Now rerun the app. New todos are inserted, and only todos for the user are fetched and displayed. Your backend is successfully secured!

docs/docs/get-started/cli-workflow/_category_.json

@@ -1,4 +0,0 @@
-{
-  "label": "CLI",
-  "position": 8
-}

docs/docs/get-started/cli-workflow/index.md

@@ -1,33 +0,0 @@
----
-title: 'CLI from Zero to Production'
----
-
-In the previous tutorials, we tested various parts of Nhost, such as:
-
-- Database
-- GraphQL API
-- Permission
-- JavaScript SDK
-- Authentication
-
-All changes we did to our database and API happened directly in production of our Nhost app.
-
-It's not ideal for making changes in production because you might break things, which will affect all users of your app.
-
-Instead, it's recommended to make changes and test your app locally before deploying those changes to production.
-
-To do changes locally, we need to have a complete Nhost app running locally, which the Nhost CLI does.
-
-The Nhost CLI matches your production application in a local environment, this way you can make changes and test your code before deploying your changes to production.
-
-## Recommended workflow with Nhost
-
-1. Develop locally using the Nhost CLI.
-2. Push changes to GitHub.
-3. Nhost automatically applies changes to production.
-
-## What you'll learn in this guide:
-
-- Use the Nhost CLI to create a local environment
-- Connect a GitHub repository with a Nhost app
-- Deploy local changes to production

docs/docs/get-started/cli-workflow/install-cli.md

@@ -1,37 +0,0 @@
----
-title: 'Install the CLI'
----
-
-Install the Nhost CLI using the following command:
-
-```bash
-sudo curl -L https://raw.githubusercontent.com/nhost/cli/main/get.sh | bash
-```
-
-Initialize a new Nhost App locally:
-
-```bash
-nhost init -n "nhost-example-app" && cd nhost-example-app
-```
-
-And initialize the GitHub repository in the same folder:
-
-```bash
-echo "# nhost-example-app" >> README.md
-git init
-git add README.md
-git commit -m "first commit"
-git branch -M main
-git remote add origin https://github.com/[github-username]/nhost-example-app.git
-git push -u origin main
-```
-
-Now go back to the **Nhost Console** and click **Deployments**. You just made a new deployment to your Nhost app!
-
-![Deployments tab](/img/cli-workflow/deployments-tab.png)
-
-If you click on the deployment you can see that nothing was really deployed. That’s because we just made a change to the README file.
-
-![Deployments details](/img/cli-workflow/deployments-details.png)
-
-Let's do some local backend changes!

docs/docs/get-started/cli-workflow/local-changes.mdx

@@ -1,81 +0,0 @@
----
-title: 'Local changes'
----
-
-Start Nhost locally:
-
-```bash
-nhost dev
-```
-
-:::tip
-Make sure you have [Docker](https://www.docker.com/get-started) installed on your computer. It’s required for Nhost to work.
-:::
-
-The `nhost dev` command will automatically start a complete Nhost environment locally on your computer using:
-
-- Postgres
-- Hasura
-- Authentication
-- Storage
-- Serverless Functions
-- Mailhog
-
-You use this local environment to do changes and testing before you deploy your changes to production.
-
-Running `nhost dev` also starts the Hasura Console.
-
-:::tip
-It's important that you use the Hasura Console that is started automatically when you do changes. This way, changes are automatically tracked for you.
-:::
-
-![Hasura Console](/img/cli-workflow/hasura-console.png)
-
-In the Hasura Console, create a new table `customers` with two columns:
-
-- id
-- name
-
-<video
-  src="/videos/cli-workflow/hasura-create-customers-table.mp4"
-  width="100%"
-  controls
-/>
-
-When we created the `customers` table there was also a migration created automatically. The migration was created at under `nhost/migrations/default`.
-
-```bash
-$ ls -la nhost/migrations/default
-total 0
-drwxr-xr-x  3 eli  staff   96 Feb  7 16:19 .
-drwxr-xr-x  3 eli  staff   96 Feb  7 16:19 ..
-drwxr-xr-x  4 eli  staff  128 Feb  7 16:19 1644247179684_create_table_public_customers
-```
-
-This database migration has only been applied locally, meaning, you created the `customers` table locally but it does not (yet) exists in production.
-
-To apply the local change to production we need to commit the changes and push it to GitHub. Nhost will then automatically pick up the change in the repository and apply the changes.
-
-:::tip
-You can commit and push files in another terminal while still having `nhost dev` running.
-:::
-
-```bash
-git add -A
-git commit -m "Initialized Nhost and added a customers table"
-git push
-```
-
-Head over to the **Deployments** tab in the **Nhost console** to see the deployment.
-
-![Deployments tab after changes](/img/cli-workflow/deployments-tab-with-changes.png)
-
-Once the deployment finishes the `customers` table is created in production.
-
-![Customers table in Hasura Console](/img/cli-workflow/hasura-customers-table.png)
-
-We've now completed the recommended workflow with Nhost:
-
-1. Develop locally using the Nhost CLI.
-2. Push changes to GitHub.
-3. Nhost deploys changes to production.

docs/docs/get-started/cli-workflow/metadata-and-serverless-functions.mdx

@@ -1,170 +0,0 @@
----
-title: 'Metadata and Serverless Functions'
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-In the previous section, we only created a new table; `customers`. Using the CLI you can also do changes to other parts of your backend.
-
-There are three things the CLI and the GitHub integration track and applies to production:
-
-1. Database migrations
-2. Hasura Metadata
-3. Serverless Functions
-
-For this section, let's do one change to the Hasura metadata and create one serverless function
-
-### Hasura Metadata
-
-We'll add permissions to the `users` table, making sure users can only see their own data. For this, go to the `auth` schema and click on the `users` table. then click on **Permissions** and enter a new role **user** and create a new **select** permission for that role**.**
-
-Create the permission **with custom check**:
-
-```json
-{
-  "id": {
-    "_eq": "X-Hasura-User-Id"
-  }
-}
-```
-
-Select the following columns:
-
-- id
-- created_at
-- display_name
-- avatar_url
-- email
-
-Then click **Save permissions**.
-
-<video
-  src="/videos/cli-workflow/hasura-user-permissions.mp4"
-  width="100%"
-  controls
-/>
-
-Now, let's do a `git status` again to confirm the permission changes we did was tracked locally in your git repository.
-
-![Git status](/img/cli-workflow/git-status.png)
-
-We can now commit this change:
-
-```bash
-git add -A
-git commit -m "added permission for uses"
-```
-
-Now let's create a serverless function before we push all changes to GitHub so Nhost can deploy our changes.
-
-### Serverless Function
-
-A serverless function is a pieces of code written in JavaScript or TypeScript that take an HTTP request and returns a response.
-
-Here's an example:
-
-```bash
-import { Request, Response } from 'express'
-
-export default (req: Request, res: Response) => {
-  res.status(200).send(`Hello ${req.query.name}!`)
-}
-```
-
-Serverless functions are placed in the `functions/` folder of your repository. Every file will become its own endpoint.
-
-Before we create our serverless function we'll install `express`, which is a requirement for serverless functions to work.
-
-<Tabs>
-  <TabItem value="npm" label="npm" default>
-
-```bash
-npm install express
-npm install -d @types/node @types/express
-```
-
-  </TabItem>
-  <TabItem value="yarn" label="Yarn">
-
-```bash
-yarn add express
-yarn add -D @types/node @types/express
-```
-
-  </TabItem>
-</Tabs>
-
-Then we'll create a file `functions/time.ts`
-
-In the file `time.ts` we'll add the following code to create our serverless function:
-
-```bash
-import { Request, Response } from 'express';
-
-export default (req: Request, res: Response) => {
-  return res
-    .status(200)
-    .send(`Hello ${req.query.name}! It's now: ${new Date().toUTCString()}`);
-};
-```
-
-We can now test the function locally. Locally, the backend URL is `http://localhost:1337`. Functions are under `/v1/functions`. And every function's path and filename becomes an API endpoint.
-
-This means our function `functions/time.ts` is at `http://localhost:1337/v1/functions/time`.
-
-Let's use curl to test our new function:
-
-```bash
-curl http://localhost:1337/v1/functions/time
-Hello undefined! It's now: Sun, 06 Feb 2022 17:44:45 GMT
-```
-
-And with a query parameter with our name:
-
-```bash
-curl http://localhost:1337/v1/functions/time\?name\=Johan
-Hello Johan! It's now: Sun, 06 Feb 2022 17:44:48 GMT
-```
-
-Again, let's use `git status` to see the changes we did to create our serverless function.
-
-Now let's commit the changes and push them to GitHub.
-
-```bash
-git add -A
-git commit -m "added serverless function"
-git push
-```
-
-In the Nhost Console, click on the new deployment to see details.
-
-![Deployments details for function](/img/cli-workflow/details-for-function.png)
-
-After Nhost has finished deploying your changes we can test them in production. First let's confirm that the user permissions are applied.
-
-![Hasura Console permissions table](/img/cli-workflow/hasura-permissions-table.png)
-
-Then, let's confirm that the serverless function was deployed. Again, we'll use curl:
-
-```bash
-curl https://your-backend-url.nhost.run/v1/functions/time\?name\=Johan
-```
-
-![Serverless Function test](/img/cli-workflow/function-test.png)
-
-## Conclusion
-
-In this tutorial we have installed the Nhost CLI and created a local Nhost environment to do local development and testing.
-
-In the local environment we've made changes to our database, to Hasura's metadata and created a serverless function.
-
-We've connected a GitHub repository and pushed our changes to GitHub.
-
-We've seen Nhost automatically deploying our changes and we've verified that the changes were applied.
-
-In summary, we've set up a productive environment using the recommended Nhost workflow:
-
-1. Develop locally using the Nhost CLI.
-2. Push changes to GitHub.
-3. Nhost deploys changes to production.

docs/docs/get-started/cli-workflow/workflow-setup.mdx

@@ -1,31 +0,0 @@
----
-title: 'Workflow setup'
----
-
-What follows is a detailed tutorial on how you setup Nhost for this workflow
-
-### Create Nhost App
-
-Create a **new Nhost app** for this tutorial.
-
-:::tip
-It's important that you create a **new** Nhost app for this guide instead of reusing an old Nhost app because we want to start with a clean Nhost app.
-:::
-
-![Create new app](/img/cli-workflow/create-app.png)
-
-### Create new GitHub Repository
-
-Create a new GitHub repository for your new Nhost app. The repo can be either private or public.
-
-![Create new repo](/img/cli-workflow/create-repo.png)
-
-## Connect GitHub Repository to Nhost App
-
-In the Nhost Console, go to the dashboard of your Nhost app and click **Connect to GitHub**.
-
-<video
-  src="/videos/cli-workflow/connect-github-repo.mp4"
-  width="100%"
-  controls
-/>

docs/docs/get-started/index.md

@@ -1,36 +0,0 @@
----
-title: 'Welcome to Nhost'
-sidebar_position: 1
----
-
-Nhost is an open-source, real-time, server-less backend platform for building reliable apps that scale with your business.
-
----
-
-## Components
-
-Nhost uses an opinionated set of open-source components.
-
-#### Database
-
-Your application gets its own PostgreSQL database, the world's most advanced relational database.
-
-#### GraphQL API
-
-Highly performant and real-time GraphQL API with Hasura.
-
-#### Authentication and storage
-
-User management & file storage seamlessly integrated with Hasura permissions.
-
-#### Serverless functions
-
-JavaScript and TypeScript functions run your custom code in the backend.
-
----
-
-## Get started
-
-Follow our [Quick start](/get-started/quick-start) guide to build your first app.
-
-Check out [Nhost on GitHub](https://github.com/nhost/nhost). Give us a star, and feel free to open a discussion for any feature requests as well.

docs/docs/get-started/quick-start/index.md

@@ -1,36 +0,0 @@
----
-title: 'Create your app'
-sidebar_position: 1
----
-
-Let's create a simple todo-app using Nhost. In a todo-app, a user should be able to create list items for their account (CRUD) and not have anyone else see them (permissions).
-
-To implement this todo-app with Nhost, we'll briefly cover these topics:
-
-- Creating a new app on Nhost
-- Defining a database schema
-- Inserting data
-- Setting permissions
-- Querying data via the GraphQL API
-
-By the end of this quick-start, you will better understand what Nhost is and what it does for you.
-
----
-
-## Log in to Nhost
-
-Go to [app.nhost.io](https://app.nhost.io) and sign up for a new account if you don't have one already.
-
----
-
-## Create app
-
-Press the **"New App"** button on the console's home page. Choose a name and pick the region closest to your users.
-
-You'll be all set with the Default Workspace and the Free plan for now.
-
-![New App](/img/quick-start/new-app.png)
-
-Creating a new app takes around 20 seconds or so. During this time, Nhost sets up your app's entire backend and infrastructure.
-
-Once the setup completes, you'll automatically see the app dashboard, and you're ready to define your app's database schema.

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

@@ -1,110 +0,0 @@
----
-title: 'JavaScript client'
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-In the previous section, you used the Hasura Console to fetch a list of todos. Now, you will write a small JavaScript client to interact and retrieve todos from your Nhost app.
-
-### Frontend frameworks
-
-Nhost is framework-agnostic and works with any frontend you might build. You can also connect to Nhost from your server-side if you wish.
-
-In this guide, we'll keep the example simple. We're not using a frontend framework. In a real-life scenario, you'd probably build a frontend client with a framework such as React, Vue, Svelte or React Native.
-
----
-
-## Setup
-
-:::info
-
-Make sure you have [Node.js](https://nodejs.org) and [npm](https://docs.npmjs.com/getting-started) or [Yarn](https://classic.yarnpkg.com/lang/en/docs/install) installed.
-
-:::
-
-Create a new folder called `nhost-todos`, initialize a new JavaScript app there, and install the Nhost JavaScript SDK:
-
-<Tabs>
-  <TabItem value="npm" label="npm" default>
-
-```bash
-npm init -y
-npm install @nhost/nhost-js graphql
-```
-
-  </TabItem>
-  <TabItem value="yarn" label="Yarn">
-
-```bash
-yarn init -y
-yarn add @nhost/nhost-js graphql
-```
-
-  </TabItem>
-</Tabs>
-
-:::caution attention
-You might have to edit the `package.json` file and add/change the `type` object to `module` (`"type": "module"`).
-:::
-
----
-
-## Initialize Nhost
-
-In the new directory, create a file called `index.js`.
-
-Enter the following code into this file. It will initialize a new `NhostClient` that will interact with your backend:
-
-```js
-import { NhostClient } from '@nhost/nhost-js';
-
-const nhost = new NhostClient({
-  backendUrl: 'https://[app-subdomain].nhost.run', // replace this with the backend URL of your app
-});
-
-console.log(nhost.graphql.getUrl());
-```
-
-Run the code in your terminal. You should see your app's GraphQL endpoint URL:
-
-```bash
-➜ node index.js
-
-https://[app-subdomain].nhost.run/v1/graphql
-```
-
-### Query todos
-
-If you now add the following GraphQL query to the client, let's see what happens when you run the updated version:
-
-```js
-import { NhostClient } from '@nhost/nhost-js';
-
-const nhost = new NhostClient({
-  backendUrl: 'https://[app-subdomain].nhost.run',
-})(async () => {
-  // nhost.graphql.request returns a promise, so we use await here
-  const todos = await nhost.graphql.request(`
-    query {
-      todos {
-        id
-        created_at
-        name
-        is_completed
-      }
-    }
-  `);
-
-  // Print todos to console
-  console.log(JSON.stringify(todos.data, null, 2));
-})();
-```
-
-```bash
-➜ node index.js
-
-null
-```
-
-`null` is printed. Why is that? Let's find out.

docs/docs/get-started/quick-start/permissions.md

@@ -1,53 +0,0 @@
----
-title: 'Set permissions'
----
-
-While using the Hasura Console, you could fetch the todos because the **admin** role is enabled by default but when building your applications with a client, you want to define permissions using **roles** that your users can assume when making requests.
-
-Hasura supports role-based access control. You create rules for each role, table, and operation (select, insert, update and delete) that can check dynamic session variables, like user ID.
-
-## Unauthenticated users
-
-Use the `public` role in permissions when you want some data to be accessed by anyone without being signed in. The `public` role is the default role in all unauthenticated requests.
-
-Generally speaking, the `public` role should not have insert, update or delete permissions defined.
-
-### Setting `public` permissions
-
-In Hasura Console, go to the **Data** tab, click on the **todos** table, then click **Permissions**. Add a new role called `public` and click on **select**. The permission options for the select operation show up below.
-
-Add the following permissions:
-
-![Public role](/img/quick-start/permissions-public-select.png)
-
-Rerun the program. Now you see all todos.
-
-```bash
-➜ node index.js
-
-{
-  "todos": [
-    {
-      "id": "558b9754-bb18-4abd-83d9-e9056934e812",
-      "created_at": "2021-12-01T17:05:09.311362+00:00",
-      "name": "write docs",
-      "is_completed": false
-    },
-    {
-      "id": "480369c8-6f57-4061-bfdf-9ead647e10d3",
-      "created_at": "2021-12-01T17:05:20.5693+00:00",
-      "name": "cook dinner",
-      "is_completed": true
-    }
-  ]
-}
-```
-
----
-
-There are two reasons why the request succeeded:
-
-1. Nhost sets the `public` role for every unauthenticated GraphQL request.
-2. You explicitly defined permissions for the `public` role.
-
-It is essential to understand that Hasura has an **allow nothing by default** policy to ensure that only roles and permissions you define explicitly have access to the GraphQL API.

docs/docs/get-started/quick-start/schema.md

@@ -1,95 +0,0 @@
----
-title: 'Define schema'
----
-
-To implement an app for managing a todo list, let's ensure we have database tables for storing todos and users.
-
----
-
-## Open Hasura Console
-
-Hasura generates real-time GraphQL APIs, but it also provides a web console for manipulating the schema and data of your database.
-
-Go to the **Data** tab on your app's dashboard and select **Open Hasura**. Remember to copy the admin secret.
-
-The Hasura Console of your app's dedicated Hasura instance will open in a new tab. You can use Hasura Console to manage your app's schema, data, permissions, and event triggers.
-
-![Data -> Open Hasura](/img/quick-start/data-tab.png)
-
----
-
-## Users table
-
-You should see all your database tables on the left-hand side of the screen. You should see multiple different **schemas** displayed as folders:
-
-- `public` schema for your app's custom tables
-- `auth` and `storage` schemas for Nhost's user management and file storage
-
-If you open the `auth` schema, you'll see that your app already has a `users` table, so you don't have to create one.
-
-![To store the users, we already have a users table from the auth schema](/img/quick-start/list-of-schemas.png)
-
----
-
-## Create todos table
-
-In Hasura Console, go to the **data** tab, then click **Create Table**. Name this table `todos`.
-
-### Add frequently used columns
-
-`id` and `created_at` columns are standard and can be added with two clicks. Click **Frequently used columns** and create them:
-
-- `id` (UUID)
-- `created_at` (timestamp)
-
-Using frequently used columns ensures the columns get the right name, type, and default value.
-
-![Frequently used columns in the Hasura console](/img/quick-start/frequently-used-columns.png)
-
-### Add custom columns
-
-Add two more columns manually:
-
-- `name` (text)
-- `is_completed` (boolean)
-
-Make sure to set the default value of `is_completed` to `false`.
-
-![Create a table in the Hasura console](/img/quick-start/create-table.png)
-
-This is all we need! A new table will be created when you click **Add Table**.
-
----
-
-## Insert data
-
-Go to the **Insert Row** tab to add some data to your database.
-
-<video width="99%" loop="" muted="" playsInline="" controls="true">
-  <source src="/videos/insert-todos.mp4" type="video/mp4" />
-</video>
-
----
-
-## Query data
-
-Now that we have data in our database, we can retrieve it via a GraphQL API. Go to the **API** tab in the main menu. You can use this view to make GraphQL requests that query or mutate data in your database.
-
-Paste the following GraphQL query into the form and press the "play" button:
-
-```graphql
-query {
-  todos {
-    id
-    created_at
-    name
-    is_completed
-  }
-}
-```
-
-You should see the todos you just inserted show up as output on the right-hand side.
-
-### Admin role
-
-All requests in the Hasura Console use the `admin` role by default. This role has access to all tables and permissions.

docs/docs/get-started/upgrade/index.md

@@ -1,104 +0,0 @@
----
-title: 'Upgrade from v1 to v2'
----
-
-Upgrading from Nhost v1 to v2 requires database schema and Hasura metadata changes.
-
----
-
-## Upgrade Steps
-
-### Create a new Nhost v2 app locally
-
-:::tip
-Make sure you have the [Nhost CLI](/reference/cli) installed
-:::
-
-```bash
-nhost init my-nhost-v2-app
-cd my-nhost-v2-app
-```
-
-### Update config
-
-Update `version: 3` to `version: 2` in `nhost/config.yaml`. This will update Hasura's configuration version, and we need to downgrade the version when we export migrations and metadata.
-
-### Export current migrations and metadata from Nhost v1
-
-Inside the `nhost/` folder of your app, run:
-
-```bash
-hasura migrate create init --from-server --endpoint=[v1-endpoint] --admin-secret=[v1-admin-secret]
-
-hasura metadata export --endpoint=[v1-endpoint] --admin-secret=[v1-admin-secret]
-```
-
-### Update Migrations
-
-Make the following changes manually to your migrations.
-
-:::tip
-The migration file is located at `nhost/migrations/[timestamp]/up.sql`.
-:::
-
-- Add `OR REPLACE` after `CREATE` for the `public.set_current_timestamp_updated_at` function
-- Delete all `auth.*` tables and functions (if any).
-- Delete `public.users` table and everything related to the table such as constraints, triggers, etc.
-- Update FK references from `public.users` to `auth.users` (if any).
-
-### Update Metadata
-
-Make the following changes manually to your metadata.
-
-:::tip
-The metadata is located at `nhost/metadata/tables.yaml`.
-:::
-
-- Delete tracking all tables in the `auth` schema.
-- Delete tracking the `public.users` table.
-- Update all references to `users` from the `public` to `auth` schema.
-
-### Start nhost
-
-Start Nhost locally using the [CLI](/reference/cli). From the root of your app, run:
-
-```bash
-nhost -d
-```
-
-:::tip
-Running Nhost applies your local database migrations and Hasura metadata.
-:::
-
-### Restart Auth and Storage containers
-
-Open Docker UI and restart Hasura Auth and Hasura Storage. Restarting those containers applies new metadata, effectively tracking everything in the `auth` and the `storage` schema.
-
-### Delete migrations and metadata
-
-Delete the local migrations and metadata.
-
-```bash
-rm -rf nhost/migrations nhost/metadata
-```
-
-### Update config (again)
-
-Update `config: 2` to `config: 3` in `nhost/config.yaml`.
-
-### Pull migrations and metadata from our local instance
-
-In the `nhost/` folder, run the following command:
-
-```bash
-hasura migrate create init --from-server --endpoint=http://localhost:[hasura-port] --admin-secret=nhost-admin-secret
-hasura metadata export --endpoint=http://localhost:[hasura-port] --admin-secret=nhost-admin-secret
-```
-
-:::warning
-You cannot use port `1337` in the commands above. You have to use the specific port Hasura uses. Go to the Hasura Console under API and look for the port Hasura is using under GraphQL Endpoint.
-:::
-
-### Done
-
-You now have a Nhost v2 project locally with correct migrations and metadata. Happy hacking!

docs/docs/index.md

@@ -1,35 +0,0 @@
----
-title: 'Welcome to Nhost'
----
-
-Nhost is an open-source, real-time, server-less backend platform for building reliable apps that scale with your business.
-
----
-
-## Components
-
-Nhost uses an opinionated set of open-source components.
-
-#### Database
-
-Your application gets its own PostgreSQL database, the world's most advanced relational database.
-
-#### GraphQL API
-
-Highly performant and real-time GraphQL API with Hasura.
-
-#### Authentication and storage
-
-User management & file storage seamlessly integrated with Hasura permissions.
-
-#### Serverless functions
-
-JavaScript and TypeScript functions run your custom code in the backend.
-
----
-
-## Get started
-
-Follow our [Quick start](/get-started/quick-start) guide to build your first app.
-
-Check out [Nhost on GitHub](https://github.com/nhost/nhost). Give us a star, and feel free to open a discussion for any feature requests as well.

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

@@ -1,67 +0,0 @@
----
-title: 'Event triggers'
-sidebar_position: 2
----
-
-Event triggers are HTTP webhooks that fire on a database event, such as insert, update, or delete. These events are usually a result of GraphQL mutations, but any other database operation will also fire events.
-
-**Example:** Imagine you want to send an email every time a user makes a new order in an e-commerce application. To achieve that, you would create an event trigger on **insert** for the **orders table**. Every time an order is created, an event trigger will send a webhook with the order information, and the webhook can send out an email to the customer.
-
----
-
-## Creating event triggers
-
-Event triggers are managed in Hasura. Go to Hasura, then select **Events** in the main menu and press "Create".
-
-![Creating event trigger in Hasura](/img/platform/hasura-create-event-trigger.png)
-
-Nhost's [environment variables](/platform/environment-variables) can be used in event trigger headers. For example, you can attach `NHOST_WEBHOOK_SECRET` to an outgoing webhook here.
-
----
-
-## Serverless functions
-
-It's a common pattern to write a serverless function to catch a webhook fired by an event. When creating webhooks that are meant for your own serverless functions, use the following URL:
-
-```bash
-https://[app-subdomain].nhost.run/v1/functions/my-endpoint
-```
-
-The environment variable `NHOST_BACKEND_URL` will have the correct value.
-
-```bash
-{{NHOST_BACKEND_URL}}/v1/functions/my-endpoint
-```
-
----
-
-## Security
-
-In your serverless function, you need to make sure the request actually comes from your Hasura instance. To do this, you must do two things:
-
-- Add the header `nhost-webhook-secret` when creating the event in Hasura. Set this to `NHOST_WEBHOOK_SECRET`.
-- Check the header in the serverless function. It should match the environment variable `NHOST_WEBHOOK_SECRET`.
-
-```js
-export default async function handler(req, res) {
-
-  // Check webhook secret to make sure the request is valid
-  if (
-    req.headers['nhost-webhook-secret'] !== process.env.NHOST_WEBHOOK_SECRET
-  ) {
-    return res.status(400).send('Incorrect webhook secret')
-  }
-
-  // Do something
-  // Example:
-  // - Send an email
-  // - Create a subscription in Stripe
-  // - Generate a PDF
-  // - Send a message to Slack or Discord
-  // - Update some data in the database
-
-  console.log(JSON.stringify(req.body, null, 2))
-
-  return res.send('OK')
-}
-```

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

@@ -0,0 +1,88 @@
+---
+title: 'Event triggers'
+sidebar_position: 2
+---
+
+Event Triggers enable you to invoke webhooks when a database event happens. Event Triggers are typically used to do post-processing tasks, using custom backend code, based on database events.
+
+Event Triggers are associated with a specific table in the database the following event types are available:
+
+- **INSERT** - A row is inserted into a table
+- **UPDATE** - A row is updated in a table
+- **DELETE** - A row is deleted from a table
+
+Event Triggers can also be triggered manually in the Hasura Console.
+
+### Example Use Case
+
+Let's say you're building an e-commerce application and you want to send an email to the customer when a new order is placed. Orders are stored in the `orders` table in your database.
+
+To send out an email every time a new order is placed, you create an event trigger that listens for the `INSERT` event on the `orders` table. Now every time an order is placed, the even trigger invokes a webhook with the order information, and the webhook sends out the email.
+
+## Create Event Trigger
+
+Event Triggers are managed in the Hasura Console. Select **Events** in the main menu and click **Create** to add an Event Trigger.
+
+<video width="99%" autoPlay muted loop controls="true">
+  <source src="/videos/hasura-create-event-trigger.mp4" type="video/mp4" />
+</video>
+
+## Event Triggers and Serverless Functions
+
+Event Triggers and [Serverless Functions](/platform/serverless-functions) is a perfect combination to build powerful database-backend logic. Every Serverless Function is exposed as an HTTP endpoint that can be used as a webhook for your Event Triggers.
+
+### Format
+
+When using Serverless Functions as webhooks you should configure the webhook using a combination of environment variables and endpoints like this:
+
+```
+{{NHOST_BACKEND_URL}}/v1/functions/orders-insert-send-email
+```
+
+![as](/img/database/event-triggers/webhook-url-format.png)
+
+The `NHOST_BACKEND_URL` is a [system environment variable](/platform/environment-variables#system-environment-variables) and available in production and in development environments using the [CLI](/platform/cli).
+
+### Security
+
+To make sure incoming requests to your webhook comes from Hasura, and not some malicious third party, you can use a shared webhook secret between Hasura and your webhook handler (e.g. your Serverless Function).
+
+It is recommended to use the `NHOST_WEBHOOK_SECRET`, which is a [system environment variable](/platform/environment-variables#system-environment-variables) and available in production and in development environments using the [CLI](/platform/cli). The `NHOST_WEBHOOK_SECRET` is available both in Hasura and in every Serverless Function.
+
+To set this up is a two-step process:
+
+- Step 1: Add the header `nhost-webhook-secret` with the value `NHOST_WEBHOOK_SECRET` (From env var) when creating the Event Trigger in the Hasura Console.
+
+![as](/img/database/event-triggers/webhook-secret-header.png)
+
+- Step 2: Check the header `nhost-webhook-secret` for incoming requests and make sure the header is the same as the environment variable `NHOST_WEBHOOK_SECRET`.
+
+Here is an example of how to check the header in a Serverless Function:
+
+```js
+export default async function handler(req, res) {
+  // Check header to make sure the request comes from Hasura
+  if (req.headers['nhost-webhook-secret'] !== process.env.NHOST_WEBHOOK_SECRET) {
+    return res.status(400).send('Incorrect webhook secret')
+  }
+
+  // Do something
+  // Example:
+  // - Send an email
+  // - Create a subscription in Stripe
+  // - Generate a PDF
+  // - Send a message to Slack or Discord
+  // - Update some data in the database
+
+  console.log(JSON.stringify(req.body, null, 2))
+
+  return res.send('OK')
+}
+```
+
+The `NHOST_WEBHOOK_SECRET` is a [system environment variable](/platform/environment-variables#system-environment-variables) and available in production and in development environments using the [CLI](/platform/cli).
+
+## Next Steps
+
+- Read the full [Event Triggers documentation from Hasura](https://hasura.io/docs/latest/graphql/core/event-triggers/index/).
+- Learn about the [GraphQL API](/platform/graphql).

docs/docs/platform/database/index.md

@@ -1,48 +0,0 @@
----
-title: 'Database'
-sidebar_position: 1
----
-
-Every Nhost app comes with a Postgres database. Postgres is the world's most advanced open-source relational database and the most popular SQL database among developers. The database is hosted with Amazon RDS.
-
-Tables are managed in the Hasura Console.
-
----
-
-## Creating tables
-
-1. In Hasura Console, go to the **Data** tab, select the **public** schema in the left menu and click **Create Table**
-2. Enter a table name
-3. Add table columns
-4. Add a primary key (usually the ID column)
-5. (Optional) Add foreign keys
-6. (Optional) Add unique keys
-7. Click **Add Table**
-
-When a table is created, the table is created in Postgres and added to your GraphQL API.
-
-#### Schemas
-
-You should use the `public` schema when developing your app. `auth` and `storage` are reserved for system functionality like user and file management. You are allowed to modify permissions for tables in the `auth` and `storage` schemas, however.
-
----
-
-## Modifying table schema
-
-1. In Hasura Console, go to the **Data** tab and click on the table you want to edit in the left menu
-2. Click **Modify**
-3. Modify or add table columns
-
-#### Track foreign-key relations
-
-1. Click on Data in the top menu.
-2. A list of untracked foreign-key relations is presented.
-3. Click Track All (recommended) or click Track for each relationship you want to track.
-
----
-
-## Deleting tables
-
-1. In Hasura Console, go to the **Data** tab and select the table you want to delete in the left menu
-2. Click **Modify**
-3. Scroll to the bottom of the page and click **Delete table** to open the confirmation dialog

docs/docs/platform/database/index.mdx

@@ -0,0 +1,143 @@
+---
+title: 'Database'
+sidebar_position: 1
+---
+
+import Tabs from '@theme/Tabs'
+import TabItem from '@theme/TabItem'
+
+Every Nhost app comes with its own [Postgres database](https://postgres.org/). Postgres is the world's most advanced open-source relational database and it's the most [popular SQL database for developers](https://insights.stackoverflow.com/survey/2021#section-most-loved-dreaded-and-wanted-databases).
+
+:::info
+
+It's currently not possible to connect directly to the Postgres database via a connection string. We're working on making the database available soon. You can follow [this issue on GitHub](https://github.com/nhost/nhost/issues/113).
+
+:::
+
+The database is managed via the Hasura Console where you can manage the database via an intuative UI. You can also use SQL to directly interact with the database via the Hasura Console.
+
+## Hasura Console
+
+Hasura Console is where you manage your database. This is where you create and manage tables, schemas, and data.
+
+Open the Hasura Console by clicking on **Data** in the top menu in the Nhost Dashboard, copy the **admin secret**, and click **Open Hasura**. Use the **admin secret** to sign in.
+
+<video width="99%" autoPlay muted loop controls="true">
+  <source src="/videos/open-hasura-console.mp4" type="video/mp4" />
+</video>
+
+## Schemas
+
+The two schemas `auth` and `storage` are reserved for Nhost Auth and Nhost Storage to work. You're allowed to modify **permissions** and **add relationships**. However, never modify any tables or remove relationships that were added by Nhost inside the `auth` and `storage` schemas.
+
+Generally, you should use the `public` schema when creating and managing your tables for your app. It's also ok to add custom schemas for more advanced usage.
+
+## Create Table
+
+1. In Hasura Console, go to the **Data** tab, select the **public** schema in the left menu and click **Create Table**.
+2. Enter a table name.
+3. Add table columns.
+4. Add a primary key (usually the ID column).
+5. (Optional) Add foreign keys.
+6. (Optional) Add unique keys.
+7. Click **Add Table**.
+
+When a table is created the table is instantly available through the [GraphQL API](/platform/graphql).
+
+Here's an example of how to create a `customers` table:
+
+<Tabs groupId="hasura-console-vs-sql">
+  <TabItem value="hasura-cosnole" label="Hasura Console" default>
+
+<video width="99%" autoPlay muted loop controls="true">
+  <source src="/videos/hasura-create-table.mp4" type="video/mp4" />
+</video>
+
+  </TabItem>
+  <TabItem value="sql" label="SQL">
+
+```sql
+CREATE TABLE "public"."customers" (
+  "id" serial NOT NULL PRIMARY KEY,
+  "name" text NOT NULL
+);
+```
+
+  </TabItem>
+</Tabs>
+
+## Modify Table
+
+1. In Hasura Console, go to the **Data** tab and click on the table you want to edit in the left menu.
+2. Click **Modify**.
+3. Modify or add table columns.
+
+Here's an example of how to modify a `customers` table by adding an `address` column:
+
+<Tabs groupId="hasura-console-vs-sql">
+  <TabItem value="hasura-cosnole" label="Hasura Console" default>
+
+<video width="99%" autoPlay muted loop controls="true">
+  <source src="/videos/hasura-modify-table.mp4" type="video/mp4" />
+</video>
+
+  </TabItem>
+  <TabItem value="sql" label="SQL">
+
+```sql
+ALTER TABLE "public"."customers" ADD COLUMN "address" text;
+```
+
+  </TabItem>
+</Tabs>
+
+## Delete Table
+
+1. In Hasura Console, go to the **Data** tab and select the table you want to delete in the left menu.
+2. Click **Modify**.
+3. Scroll to the bottom of the page and click **Delete table** to open the confirmation dialog.
+4. Type the **name of the table** and click OK.
+
+Here's an example of how to delete a `customers` table:
+
+<Tabs groupId="hasura-console-vs-sql">
+  <TabItem value="hasura-cosnole" label="Hasura Console" default>
+
+<video width="99%" autoPlay muted loop controls="true">
+  <source src="/videos/hasura-delete-table.mp4" type="video/mp4" />
+</video>
+
+  </TabItem>
+  <TabItem value="sql" label="SQL">
+
+```sql
+DROP TABLE "public"."customers";
+```
+
+  </TabItem>
+</Tabs>
+
+## Migrations
+
+To track database changes, use the [Nhost CLI](/platform/cli) to develop locally and use our [GitHub integration](/platform/github-integration) to automatically deploy database migrations live.
+
+1. Develop locally using the Nhost CLI.
+2. Push changes to GitHub.
+3. Nhost automatically deploys changes.
+
+Learn how to [get started with Nhost CLI](/platform/overview/get-started-with-nhost-cli).
+
+## Backups
+
+Databases on [Pro and Enterprise plans](https://nhost.io/pricing) are backed up automatically.
+
+## Best Practices
+
+- Use lower-case names for tables. E.g. `customers` instead of `Customers`.
+- Use plural names for tables. E.g. `customers` instead of `customer`.
+
+## Next Steps
+
+- [Learn PostgreSQL Tutorial - Full Course for Beginners (YouTube)](https://www.youtube.com/watch?v=qw--VYLpxG4).
+- Learn more about how to manage your [Postgres database in Hasura](https://hasura.io/docs/latest/graphql/core/databases/postgres/schema/index/).
+- Learn about the [GraphQL API](/platform/graphql).

docs/docs/platform/overview/_category_.json

@@ -1,5 +1,5 @@
 {
   "label": "Overview",
   "position": 2,
-  "collapsed": false
+  "collapsed": true
 }

docs/docs/platform/quickstarts/vue.mdx

@@ -514,7 +514,7 @@ composable to execute that query when the user submits the form from the profile
 
 ```markup title="src/pages/profile.vue"
 <script setup lang="ts">
-  import { gql } from '@apollo/client'
+  import { gql } from '@apollo/client/core'
   import { useNhostClient, useUserData } from '@nhost/vue'
   import { useMutation } from '@vue/apollo-composable'
   import { ref } from 'vue'
@@ -600,7 +600,7 @@ Finally, to add real-time caching, synchronizing, and updating server state in y
 First add the following GraphQL subscription to retrieve the current user data component:
 
 ```ts title="src/pages/profile.vue"
-import { gql } from '@apollo/client'
+import { gql } from '@apollo/client/core'
 
 const GET_USER_SUBSCRIPTION = gql`
   subscription GetUser($id: uuid!) {
@@ -627,7 +627,7 @@ Finally, we can run our GraphQL subscription using the `useSubscription` composa
 
 ```markup title="src/pages/profile.vue"
 <script setup lang="ts">
-  import { gql } from '@apollo/client'
+  import { gql } from '@apollo/client/core'
   import { useNhostClient, useUserId } from '@nhost/vue'
   import { useMutation, useSubscription } from '@vue/apollo-composable'
   import { computed, ref } from 'vue'

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

@@ -11,6 +11,13 @@ custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-j
 
 Use `nhost.auth.isAuthenticated` to check if the user is authenticated or not.
 
+Note: `nhost.auth.isAuthenticated()` can return `false` for two reasons:
+
+1. The user is not authenticated
+2. The user is not authenticated but _might_ be authenticated soon (loading) because there is a network request in transit.
+
+Use `nhost.auth.getAuthenticationStatus` to get both authentication and loading status.
+
 ```ts
 const isAuthenticated = nhost.auth.isAuthenticated()
 

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

@@ -4,13 +4,16 @@ 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#L493
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L494
 ---
 
 # `getAuthenticationStatus()`
 
 Use `nhost.auth.getAuthenticationStatus` to get the authentication status of the user.
 
+If `isLoading` is `true`, the client doesn't know whether the user is authenticated yet or not
+because some internal authentication network requests have not been resolved yet.
+
 ```ts
 const { isAuthenticated, isLoading } = nhost.auth.getAuthenticationStatus()
 

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

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

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

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

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

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

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

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

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

@@ -4,13 +4,15 @@ 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#L596
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L597
 ---
 
 # `refreshSession()`
 
 Use `nhost.auth.refreshSession` to refresh the session with either the current internal refresh token or an external refresh token.
 
+Note: The Nhost client automatically refreshes the session when the user is authenticated but `nhost.auth.refreshSession` can be useful in some special cases.
+
 ```ts
 // Refresh the session with the the current internal refresh token.
 nhost.auth.refreshToken()

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

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

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

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

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

@@ -43,6 +43,18 @@ When set to true, will automatically refresh token before it expires
 
 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">clientStorageType</span>** <span className="optional-status">optional</span> `ClientStorageType`

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

@@ -39,6 +39,18 @@ Define a way to get information about the refresh token and its exipration date.
 
 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`

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

@@ -11,6 +11,8 @@ custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-storag
 
 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).
 
+If no `bucket` is specified the `default` bucket will be used.
+
 ```ts
 await nhost.storage.upload({ file })
 ```

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

@@ -33,6 +33,18 @@ Define a way to get information about the refresh token and its exipration date.
 
 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`

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

@@ -41,6 +41,18 @@ When set to true, will automatically refresh token before it expires
 
 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">clientStorageType</span>** <span className="optional-status">optional</span> `ClientStorageType`

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

@@ -41,6 +41,18 @@ When set to true, will automatically refresh token before it expires
 
 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">clientStorageType</span>** <span className="optional-status">optional</span> `ClientStorageType`

docs/docs/reference/vue/apollo.mdx

@@ -57,7 +57,7 @@ You can now use all [Apollo Vue composables](https://v4.apollo.vuejs.org/guide-c
 ```html
 <script setup>
   import { useQuery } from '@vue/apollo-composable'
-  import { gql } from '@apollo/client'
+  import { gql } from '@apollo/client/core'
 
   const { loading, result, error } = useQuery(gql`
     query Books {

docs/docusaurus.config.js

@@ -1,8 +1,8 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
 
-const lightCodeTheme = require('prism-react-renderer/themes/github');
-const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+const lightCodeTheme = require('prism-react-renderer/themes/github')
+const darkCodeTheme = require('prism-react-renderer/themes/dracula')
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
@@ -25,7 +25,7 @@ const config = {
       ({
         sitemap: {
           changefreq: 'weekly',
-          priority: 0.5,
+          priority: 0.5
         },
         docs: {
           path: 'docs',
@@ -34,13 +34,13 @@ const config = {
           sidebarPath: require.resolve('./sidebars.js'),
           remarkPlugins: [require('mdx-mermaid')],
           // Please change this to your repo.
-          editUrl: 'https://github.com/nhost/nhost/edit/main/docs/',
+          editUrl: 'https://github.com/nhost/nhost/edit/main/docs/'
         },
         theme: {
-          customCss: require.resolve('./src/css/custom.css'),
-        },
-      }),
-    ],
+          customCss: require.resolve('./src/css/custom.css')
+        }
+      })
+    ]
   ],
 
   themeConfig:
@@ -49,13 +49,13 @@ const config = {
       colorMode: {
         defaultMode: 'light',
         disableSwitch: false,
-        respectPrefersColorScheme: true,
+        respectPrefersColorScheme: true
       },
       metadata: [
         {
           name: 'og:image',
-          content: 'https://docs.nhost.io/img/splash.png',
-        },
+          content: 'https://docs.nhost.io/img/splash.png'
+        }
       ],
       navbar: {
         hideOnScroll: true,
@@ -63,40 +63,34 @@ const config = {
           alt: 'Nhost',
           src: 'img/logo.svg',
           srcDark: 'img/logo-dark.svg',
-          href: 'https://nhost.io',
+          href: 'https://nhost.io'
         },
         items: [
           {
             type: 'doc',
-            docId: 'get-started/index',
+            docId: 'index',
             position: 'left',
-            label: 'Get Started',
-          },
-          {
-            type: 'doc',
-            docId: 'platform/index',
-            position: 'left',
-            label: 'Platform',
+            label: 'Documentation'
           },
           {
             type: 'doc',
             docId: 'reference/index',
             position: 'left',
-            label: 'Reference',
+            label: 'Reference'
           },
           {
             href: 'https://github.com/nhost/nhost',
             className: 'header-github-link',
             position: 'right',
-            'aria-label': 'Github repository',
+            'aria-label': 'Github repository'
           },
           {
             href: 'https://app.nhost.io',
             className: 'header-get-started-link',
             position: 'right',
-            label: 'Get started',
-          },
-        ],
+            label: 'Get started'
+          }
+        ]
       },
       footer: {
         style: 'dark',
@@ -106,88 +100,84 @@ const config = {
             items: [
               {
                 label: 'Product',
-                href: 'https://nhost.io/#product',
+                href: 'https://nhost.io/#product'
               },
               {
                 label: 'Features',
-                href: 'https://nhost.io/#features',
+                href: 'https://nhost.io/#features'
               },
               {
                 label: 'Pricing',
-                href: 'https://nhost.io/pricing',
-              },
-            ],
+                href: 'https://nhost.io/pricing'
+              }
+            ]
           },
           {
             title: 'Docs',
             items: [
               {
-                label: 'Get Started',
-                to: '/get-started',
-              },
-              {
-                label: 'Platform',
-                to: '/platform',
+                label: 'Documentation',
+                to: '/'
               },
               {
                 label: 'Reference',
-                to: '/reference',
-              },
-            ],
+                to: '/reference'
+              }
+            ]
           },
           {
             title: 'Community',
             items: [
               {
                 label: 'GitHub',
-                href: 'https://github.com/nhost/nhost',
+                href: 'https://github.com/nhost/nhost'
               },
               {
                 label: 'Twitter',
-                href: 'https://twitter.com/nhostio',
+                href: 'https://twitter.com/nhostio'
               },
               {
                 label: 'LinkedIn',
-                href: 'https://www.linkedin.com/company/nhost/',
+                href: 'https://www.linkedin.com/company/nhost/'
               },
               {
                 label: 'Discord',
-                href: 'https://discord.com/invite/9V7Qb2U',
-              },
-            ],
+                href: 'https://discord.com/invite/9V7Qb2U'
+              }
+            ]
           },
           {
             title: 'More',
             items: [
               {
                 label: 'Blog',
-                href: 'https://nhost.io/blog',
+                href: 'https://nhost.io/blog'
               },
               {
                 label: 'Privacy Policy',
-                href: 'https://nhost.io/privacy-policy',
+                href: 'https://nhost.io/privacy-policy'
               },
               {
                 label: 'Terms of Service',
-                href: 'https://nhost.io/terms-of-service',
-              },
-            ],
-          },
+                href: 'https://nhost.io/terms-of-service'
+              }
+            ]
+          }
         ],
-        copyright: `Copyright © ${new Date().getFullYear()} <a href="https://nhost.io" target="_blank" rel="noopener noreferrer">Nhost</a>. All rights reserved.`,
+        copyright: `Copyright © ${new Date().getFullYear()} <a href="https://nhost.io" target="_blank" rel="noopener noreferrer">Nhost</a>. All rights reserved.`
       },
       prism: {
         theme: lightCodeTheme,
         darkTheme: darkCodeTheme,
-        defaultLanguage: 'javascript',
+        defaultLanguage: 'javascript'
       },
       algolia: {
         appId: '3A3MJQTKHU',
         apiKey: 'a76361eaed8ebcd4cf5d9ae2f0c9e746',
         indexName: 'nhost',
-        contextualSearch: false,
-      },
-    }),
-};
+        contextualSearch: false
+      }
+    })
+}
 
-module.exports = config;
+module.exports = config

docs/sidebars.js

@@ -3,41 +3,7 @@
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
 const sidebars = {
   defaultSidebar: [
-    'get-started/index',
-    {
-      label: 'Quick Start',
-      type: 'category',
-      collapsed: false,
-      items: [
-        'get-started/quick-start/index',
-        'get-started/quick-start/schema',
-        'get-started/quick-start/javascript-client',
-        'get-started/quick-start/permissions'
-      ]
-    },
-    {
-      label: 'Authentication',
-      type: 'category',
-      items: ['get-started/authentication/index']
-    },
-    {
-      label: 'CLI Workflow',
-      type: 'category',
-      items: [
-        'get-started/cli-workflow/index',
-        'get-started/cli-workflow/workflow-setup',
-        'get-started/cli-workflow/install-cli',
-        'get-started/cli-workflow/local-changes',
-        'get-started/cli-workflow/metadata-and-serverless-functions'
-      ]
-    },
-    {
-      label: 'Upgrade',
-      type: 'category',
-      items: ['get-started/upgrade/index']
-    }
-  ],
-  platformSidebar: [
+    'index',
     {
       type: 'autogenerated',
       dirName: 'platform'

docs/vercel.json

@@ -2,8 +2,28 @@
   "cleanUrls": true,
   "redirects": [
     {
-      "source": "/",
-      "destination": "/get-started",
+      "source": "/get-started/quick-start",
+      "destination": "https://nhost.io/blog/nhost-understanding-the-basics",
+      "permanent": true
+    },
+    {
+      "source": "/get-started/quick-start/:path*",
+      "destination": "https://nhost.io/blog/nhost-understanding-the-basics",
+      "permanent": true
+    },
+    {
+      "source": "/get-started/cli-workflow",
+      "destination": "/platform/overview/get-started-with-nhost-cli",
+      "permanent": true
+    },
+    {
+      "source": "/get-started/cli-workflow/:path*",
+      "destination": "/platform/overview/get-started-with-nhost-cli",
+      "permanent": true
+    },
+    {
+      "source": "get-started/upgrade",
+      "destination": "https://nhost.io/blog/migrate-from-nhost-v1-to-v2",
       "permanent": true
     },
     {

examples/vue-apollo/src/pages/ApolloPage.vue

@@ -15,7 +15,7 @@
 <script lang="ts">
 import { computed, defineComponent } from 'vue'
 
-import { gql } from '@apollo/client'
+import { gql } from '@apollo/client/core'
 import { useAuthenticated } from '@nhost/vue'
 import { useQuery } from '@vue/apollo-composable'
 

examples/vue-quickstart/src/pages/profile.vue

@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import { gql } from '@apollo/client'
+import { gql } from '@apollo/client/core'
 import { useNhostClient, useUserId } from '@nhost/vue'
 import { useMutation, useSubscription } from '@vue/apollo-composable'
 import { computed, ref } from 'vue'

packages/apollo/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @nhost/apollo
 
+## 0.5.8
+
+### Patch Changes
+
+- 097e304f: Import the apollo client from `@apollo/client/core` instead of `@apollo/client`
+  It avoids uncessary dependency to React when not using it e.g. Vue when using bundlers that import the library as a whole.
+
 ## 0.5.7
 
 ### Patch Changes

packages/apollo/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nhost/apollo",
-  "version": "0.5.7",
+  "version": "0.5.8",
   "description": "Nhost Apollo Client library",
   "license": "MIT",
   "keywords": [

packages/apollo/src/index.ts

@@ -7,7 +7,7 @@ import {
   RequestHandler,
   split,
   WatchQueryFetchPolicy
-} from '@apollo/client'
+} from '@apollo/client/core'
 import { setContext } from '@apollo/client/link/context'
 import { GraphQLWsLink } from '@apollo/client/link/subscriptions'
 import { getMainDefinition } from '@apollo/client/utilities'

packages/core/src/types.ts

@@ -22,7 +22,7 @@ export interface AuthOptions {
    *     - `setItem` or `setItemAsync`
    *     - `getItem` or `getItemAsync`
    *     - `removeItem`
-   * - `'capacitor``: `import { Storage } from @capacitor/storage`
+   * - `'capacitor'`: `import { Storage } from @capacitor/storage`
    * - `'expo-secure-store'`: `import * as SecureStore from 'expo-secure-store'`
    */
   clientStorage?: ClientStorage

packages/docgen/src/fragments/CommentFragment.ts

@@ -21,11 +21,13 @@ const excludedTags = ['remarks', 'alias', 'example', 'deprecated', 'docs']
  * @returns Comment documentation fragment
  */
 export const CommentFragment = (
-  { shortText, returns = '', tags }: Comment,
+  { shortText, text, returns = '', tags }: Comment,
   { highlightTitle = false }: CommentFragmentOptions = {}
 ) =>
   `${highlightTitle ? (shortText ? `## ${shortText}` : '') : shortText || ``}
 
+${text || ``}
+
 ${
   tags
     ? tags

packages/docgen/src/types/common.ts

@@ -39,6 +39,7 @@ export type Source = {
 
 export type Comment = {
   shortText?: string
+  text?: string
   returns?: string
   tags?: Array<CommentTag>
 }

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

@@ -430,7 +430,7 @@ export class HasuraAuthClient {
   /**
    * Use `nhost.auth.isAuthenticated` to check if the user is authenticated or not.
    *
-   * Note: `nhsot.auth.isAuthenticated()` can return `false` for two reasons:
+   * Note: `nhost.auth.isAuthenticated()` can return `false` for two reasons:
    * 1. The user is not authenticated
    * 2. The user is not authenticated but _might_ be authenticated soon (loading) because there is a network request in transit.
    *
@@ -473,7 +473,8 @@ export class HasuraAuthClient {
   /**
    * Use `nhost.auth.getAuthenticationStatus` to get the authentication status of the user.
    *
-   * if `isLoading` is `true`, the client does not yet know if the user is authenticated or not because any internal authentication network requests has not yet finished.
+   * If `isLoading` is `true`, the client doesn't know whether the user is authenticated yet or not
+   * because some internal authentication network requests have not been resolved yet.
    *
    * @example
    * ```ts

packages/react-apollo/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @nhost/react-apollo
 
+## 4.2.9
+
+### Patch Changes
+
+- Updated dependencies [097e304f]
+  - @nhost/apollo@0.5.8
+
 ## 4.2.8
 
 ### Patch Changes

packages/react-apollo/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nhost/react-apollo",
-  "version": "4.2.8",
+  "version": "4.2.9",
   "description": "Nhost React Apollo client",
   "license": "MIT",
   "keywords": [