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

chore: update versions

.config/.eslintrc

@@ -1,50 +0,0 @@
-{
-  "env": {
-    "browser": true,
-    "es6": true,
-    "node": true
-  },
-  "ignorePatterns": ["**/dist", "**/build", "**/.next"],
-  "extends": ["react-app", "plugin:react/recommended", "plugin:react-hooks/recommended"],
-  "parserOptions": {
-    // "project": "./tsconfig.json"
-    "project": ["packages/*/tsconfig.json", "examples/*/tsconfig.json"]
-  },
-  "plugins": ["react", "@typescript-eslint", "react-hooks", "simple-import-sort"],
-  "rules": {
-    "no-use-before-define": "off",
-    "simple-import-sort/exports": "error",
-
-    "simple-import-sort/imports": [
-      "error",
-      {
-        "groups": [
-          // Node.js builtins. You could also generate this regex if you use a `.js` config.
-          // For example: `^(${require("module").builtinModules.join("|")})(/|$)`
-          [
-            "^(assert|buffer|child_process|cluster|console|constants|crypto|dgram|dns|domain|events|fs|http|https|module|net|os|path|punycode|querystring|readline|repl|stream|string_decoder|sys|timers|tls|tty|url|util|vm|zlib|freelist|v8|process|async_hooks|http2|perf_hooks)(/.*|$)"
-          ],
-          // Packages
-          ["^\\w"],
-          // Internal packages.
-          ["^(@|config/)(/*|$)"],
-          // Side effect imports.
-          ["^\\u0000"],
-          // Parent imports. Put `..` last.
-          ["^\\.\\.(?!/?$)", "^\\.\\./?$"],
-          // Other relative imports. Put same-folder imports and `.` last.
-          ["^\\./(?=.*/)(?!/?$)", "^\\.(?!/?$)", "^\\./?$"],
-          // Style imports.
-          ["^.+\\.s?css$"]
-        ]
-      }
-    ],
-    "import/no-anonymous-default-export": [
-      "error",
-      {
-        "allowArrowFunction": true,
-        "allowAnonymousFunction": true
-      }
-    ]
-  }
-}

.config/esbuild.lib.js

@@ -1,30 +0,0 @@
-const esbuild = require('esbuild')
-
-// Automatically exclude all node_modules from the bundled version
-const { nodeExternalsPlugin } = require('esbuild-node-externals')
-esbuild
-  .build({
-    entryPoints: ['./src/index.ts'],
-    outfile: 'dist/index.cjs.js',
-    bundle: true,
-    minify: true,
-    platform: 'node',
-    format: 'cjs',
-    sourcemap: true,
-    target: 'node14',
-    plugins: [nodeExternalsPlugin()]
-  })
-  .catch(() => process.exit(1))
-
-esbuild
-  .build({
-    entryPoints: ['./src/index.ts'],
-    outfile: 'dist/index.es.js',
-    bundle: true,
-    minify: true,
-    platform: 'browser',
-    format: 'esm',
-    sourcemap: true,
-    target: 'es2019'
-  })
-  .catch(() => process.exit(1))

.config/jest.config.js

@@ -1,7 +0,0 @@
-const base = require('./jest.config.base.js')
-
-module.exports = {
-  ...base,
-  projects: ['<rootDir>/packages/*/jest.config.js'],
-  coverageDirectory: '<rootDir>/coverage/'
-}

.config/vite.lib.react.js

@@ -1,50 +0,0 @@
-import fs from 'fs'
-import path from 'path'
-
-import { defineConfig } from 'vite'
-import dts from 'vite-plugin-dts'
-import tsconfigPaths from 'vite-tsconfig-paths'
-
-import react from '@vitejs/plugin-react'
-
-const PWD = process.env.PWD
-const pkg = require(path.join(PWD, 'package.json'))
-
-const tsEntry = path.resolve(PWD, 'src/index.ts')
-const entry = fs.existsSync(tsEntry) ? tsEntry : tsEntry.replace('.ts', '.tsx')
-
-/**
- * @type {import('vite').UserConfig}
- */
-export default defineConfig({
-  plugins: [
-    react(),
-    tsconfigPaths(),
-    dts({
-      exclude: ['**/*.spec.ts', '**/*.test.ts', '**/tests/**'],
-      afterBuild: () => {
-        const types = fs.readdirSync(path.join(PWD, 'dist/src'))
-        types.forEach((file) => {
-          fs.renameSync(path.join(PWD, 'dist/src', file), path.join(PWD, 'dist', file))
-        })
-        fs.rmdirSync(path.join(PWD, 'dist/src'))
-      }
-    })
-  ],
-  build: {
-    lib: {
-      entry,
-      name: pkg.name,
-      fileName: 'index'
-    },
-    rollupOptions: {
-      external: ['react', '@nhost/react'],
-      output: {
-        globals: {
-          react: 'react',
-          '@nhost/react': '@nhost/react'
-        }
-      }
-    }
-  }
-})

.github/workflows/changesets.yaml

@@ -9,6 +9,7 @@ on:
       - 'examples/**'
       - 'assets/**'
       - '**.md'
+      - '!.changeset/**'
       - 'LICENSE'
 
 jobs:

.gitignore

@@ -19,6 +19,7 @@ logs/
 # Directories
 coverage/
 dist/
+umd/
 lib/
 node_modules/
 tmp/
@@ -32,16 +33,15 @@ tmp/
 *.map
 todo.md
 
-# Generated configs 
+# Config files that are not part of the repository root anymore. Should be removed in the future.
 /.eslintignore
-/.eslintrc
-/.prettierignore
-/prettier.config.js
+/.eslintrc*
 /vite.*.js
 /jest.*.js
+/*tsconfig*.json
 /esbuild.*.js
 
-!.config/**
+!config/**
 
 *.tsbuildinfo
 

.lintstagedrc.json

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

.prettierrc.js

@@ -11,6 +11,11 @@ module.exports = {
   tabWidth: 2,
   trailingComma: 'none',
   useTabs: false,
+  // TODO: add import sort configuration to match ESLint rules
+  // plugins: ['./node_modules/@trivago/prettier-plugin-sort-imports'],
+  // importOrderSeparation: true,
+  // importOrderSortSpecifiers: true
+  plugins: [],
   overrides: [
     {
       files: ['*.json', '*.yaml'],
@@ -18,7 +23,5 @@ module.exports = {
         useTabs: false
       }
     }
-  ],
-  importOrderSeparation: true,
-  importOrderSortSpecifiers: true
+  ]
 }

DEVELOPERS.md

@@ -2,15 +2,17 @@
 
 ## Requirements
 
-- We use [pnpm](https://pnpm.io/) as a package manager to fasten development and builds, and as a backbone to our monorepo. You have to make sure it is installed in your machine. There are [multiple ways to install it](https://pnpm.io/installation), but the easiest way is with `npm`:
+- We use [pnpm](https://pnpm.io/) as a package manager to speed up development and builds, and as a basis for our monorepo. You need to make sure it's installed on your machine. There are [several ways to install it](https://pnpm.io/installation), but the easiest way is with `npm`:
 
 ```sh
-npm install -g pnpm
+$ npm install -g pnpm
 ```
 
-- Our tests and examples are using the Nhost CLI to run the backend services locally. You can follow the instructions to install it in [our documentation](https://docs.nhost.io/get-started/cli-workflow/install-cli)
+- Our tests and examples use the Nhost CLI, to run the backend services locally. You can follow the installation instructions in [our documentation](https://docs.nhost.io/get-started/cli-workflow/install-cli).
 
-## Getting things ready
+## Get started
+
+### Installation
 
 First, clone this repository:
 
@@ -21,57 +23,74 @@ git clone https://github.com/nhost/nhost
 Then, install the dependencies with `pnpm`:
 
 ```sh
-cd nhost
-pnpm install
+$ cd nhost
+$ pnpm install
 ```
 
-## Starting development from an example
+### Development
 
-Let's follow the instructions to start [react-apollo example](https://github.com/nhost/nhost/blob/main/examples/react-apollo/README.md).
+Although package references are correctly updated on the fly for TypeScript, example projects won't
+see the changes because they are depending on the build output. To fix this, you can run packages
+in development mode.
 
-## Running the documentation website locally
-
-The easier way to contribute to our documentation is to move to the `docs` folder and follow the [instructions to start local development](https://github.com/nhost/nhost/blob/main/docs/README.md):
+Running packages in development mode is as simple as:
 
 ```sh
-cd docs
-# not necessary step if you've done this step already anywhere in the repository
-pnpm install
-pnpm start
+$ pnpm dev
 ```
 
-## Testing
+Our packages are linked together using [PNPM's workspace](https://pnpm.io/workspaces) feature. Vite automatically detects changes in the dependencies and rebuilds everything, so that the changes are immediately reflected in the other packages.
 
-In order to run tests, the Nhost testing backend should run locally. You can start it in from a separate terminal:
+### Use examples
+
+Examples are a great way to test your changes in practice. Make sure you've `pnpm dev` running in your terminal and then run an example.
+
+Let's follow the instructions to run [react-apollo example](https://github.com/nhost/nhost/blob/main/examples/react-apollo/README.md).
+
+## Run the documentation website locally
+
+The easier way to contribute to our documentation is to go to the `docs` folder and follow the [instructions to start local development](https://github.com/nhost/nhost/blob/main/docs/README.md):
 
 ```sh
-cd examples/testing-project
-nhost -d
+$ cd docs
+# not necessary if you've already done this step somewhere in the repository
+$ pnpm install
+$ pnpm start
 ```
 
-Once Nhost started locally, you can run the tests from the root folder of the repository with the following command:
+## Run test suites
+
+In order to run tests, the Nhost testing backend should be running locally. You can run it from a separate terminal:
 
 ```sh
-pnpm test
+$ cd examples/testing-project
+$ nhost -d
+```
+
+Once Nhost is started locally, you can run the tests with the following command from the repository root:
+
+```sh
+$ pnpm test
 ```
 
 ## Changesets
 
-If you made some changes in the packages, you will have to describe these changes so they will be taken into account in the next release.
-We are using [changesets](https://github.com/changesets/changesets) to support our version/publish workflows. When submitting a pull request, a bot will check if some changesets are present, and if not, will guide you to add them.
+If you've made changes to the packages, you must describe those changes so that they can be reflected in the next release.
+We use [changesets](https://github.com/changesets/changesets) to support our versioning and release workflows. When you submit a pull request, a bot checks if some changesets are present, and if not, it directs you to add them.
 
-The most comprehensive way to add a changeset is to run the following command from the root directory of the repository:
+The most comprehensive way to add a changeset is to run the following command in the repository root:
 
 ```sh
-pnpm changeset
+$ pnpm changeset
 ```
 
-This will generate a file in the `.changeset` directory. You can edit it to give further details about the change you just made.
-You can have a look at the changesets documentation on [how to add a changeset](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md)
+This will create a file in the `.changeset` directory. You can edit it to give more details about the change you just made.
 
-## Commiting changes
+You can take a look at the changeset documentation: [How to add a changeset](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md).
 
-You may notice `git commit` takes a few seconds to run. We set a commit hook that scan the changes in the code, automatically generates the documentation from the inline [TSDoc](https://tsdoc.org/) annotations, and add these generated documentation files to the commit. They will automatically update the [reference documentation](https://docs.nhost.io/reference).
+## Committing changes
+
+You'll notice that `git commit` takes a few seconds to run. We set a commit hook that scans the changes in the code, automatically generates documentation from the inline [TSDoc](https://tsdoc.org/) annotations, and adds these generated documentation files to the commit. They automatically update the [reference documentation](https://docs.nhost.io/reference).
 
 <!-- ## Good practices
 - lint

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>
@@ -148,6 +148,13 @@ Here are some ways of contributing to making Nhost better:
             <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"/>
+            <br />
+            <sub><b>Grégory D'Angelo</b></sub>
+        </a>
+    </td>
     <td align="center">
         <a href="https://github.com/nunopato">
             <img src="https://avatars.githubusercontent.com/u/1523504?v=4" width="100;" alt="nunopato"/>
@@ -161,15 +168,15 @@ Here are some ways of contributing to making Nhost better:
             <br />
             <sub><b>Subha Das</b></sub>
         </a>
-    </td>
+    </td></tr>
+<tr>
     <td align="center">
         <a href="https://github.com/guicurcio">
             <img src="https://avatars.githubusercontent.com/u/20285232?v=4" width="100;" alt="guicurcio"/>
             <br />
             <sub><b>Guido Curcio</b></sub>
         </a>
-    </td></tr>
-<tr>
+    </td>
     <td align="center">
         <a href="https://github.com/sebagudelo">
             <img src="https://avatars.githubusercontent.com/u/43288271?v=4" width="100;" alt="sebagudelo"/>
@@ -184,13 +191,6 @@ Here are some ways of contributing to making Nhost better:
             <sub><b>Mrinal Wahal</b></sub>
         </a>
     </td>
-    <td align="center">
-        <a href="https://github.com/gdangelo">
-            <img src="https://avatars.githubusercontent.com/u/4352286?v=4" width="100;" alt="gdangelo"/>
-            <br />
-            <sub><b>Grégory D'Angelo</b></sub>
-        </a>
-    </td>
     <td align="center">
         <a href="https://github.com/FuzzyReason">
             <img src="https://avatars.githubusercontent.com/u/62517920?v=4" width="100;" alt="FuzzyReason"/>
@@ -299,6 +299,13 @@ Here are some ways of contributing to making Nhost better:
         </a>
     </td></tr>
 <tr>
+    <td align="center">
+        <a href="https://github.com/gaurav1999">
+            <img src="https://avatars.githubusercontent.com/u/20752142?v=4" width="100;" alt="gaurav1999"/>
+            <br />
+            <sub><b>Gaurav Agrawal</b></sub>
+        </a>
+    </td>
     <td align="center">
         <a href="https://github.com/alveshelio">
             <img src="https://avatars.githubusercontent.com/u/8176422?v=4" width="100;" alt="alveshelio"/>
@@ -320,6 +327,21 @@ 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></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"/>

config/.eslint.base.js

@@ -0,0 +1,64 @@
+module.exports = {
+  env: {
+    browser: true,
+    es6: true,
+    node: true
+  },
+  ignorePatterns: [
+    'dist',
+    'umd',
+    'build',
+    '.next',
+    'node_modules',
+    'tsup.config.ts',
+    '__tests__',
+    '__mocks__',
+    '*.test.ts',
+    '*.test.tsx',
+    '*.spec.ts',
+    '*.spec.tsx',
+    'tests/**/*.ts',
+    'tests/**/*.d.ts'
+  ],
+  plugins: ['@typescript-eslint', 'simple-import-sort'],
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module'
+  },
+  rules: {
+    'react/prop-types': 'off',
+    'no-use-before-define': 'off',
+    'simple-import-sort/exports': 'error',
+    'simple-import-sort/imports': [
+      'error',
+      {
+        groups: [
+          // Node.js builtins. You could also generate this regex if you use a `.js` config.
+          // For example: `^(${require("module").builtinModules.join("|")})(/|$)`
+          [
+            '^(assert|buffer|child_process|cluster|console|constants|crypto|dgram|dns|domain|events|fs|http|https|module|net|os|path|punycode|querystring|readline|repl|stream|string_decoder|sys|timers|tls|tty|url|util|vm|zlib|freelist|v8|process|async_hooks|http2|perf_hooks)(/.*|$)'
+          ],
+          // Packages
+          ['^\\w'],
+          // Internal packages.
+          ['^(@|config/)(/*|$)'],
+          // Side effect imports.
+          ['^\\u0000'],
+          // Parent imports. Put `..` last.
+          ['^\\.\\.(?!/?$)', '^\\.\\./?$'],
+          // Other relative imports. Put same-folder imports and `.` last.
+          ['^\\./(?=.*/)(?!/?$)', '^\\.(?!/?$)', '^\\./?$'],
+          // Style imports.
+          ['^.+\\.s?css$']
+        ]
+      }
+    ],
+    'import/no-anonymous-default-export': [
+      'error',
+      {
+        allowArrowFunction: true,
+        allowAnonymousFunction: true
+      }
+    ]
+  }
+}

config/.eslintrc.js

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

config/.eslintrc.vue.js

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

config/jest.config.base.js

@@ -7,7 +7,6 @@ module.exports = {
   testRegex: '(/tests/.*.(test|spec)).(jsx?|tsx?)$',
   moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
   collectCoverage: true,
-  // coveragePathIgnorePatterns: ['(tests/.*.mock).(jsx?|tsx?)$'],
   verbose: true,
   testTimeout: 30000,
   globals: {

config/jest.config.js

@@ -0,0 +1,15 @@
+module.exports = {
+  rootDir: process.cwd(),
+  preset: 'ts-jest',
+  collectCoverage: true,
+  coverageProvider: 'v8',
+  coverageDirectory: '<rootDir>/coverage',
+  clearMocks: true,
+  verbose: true,
+  testTimeout: 30000,
+  globals: {
+    'ts-jest': {
+      isolatedModules: true
+    }
+  }
+}

config/react-library.tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "React Library",
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "jsx": "preserve"
+  }
+}

config/tsconfig.base.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Default",
+  "compilerOptions": {
+    "composite": false,
+    "declaration": true,
+    "declarationMap": true,
+    "strict": true,
+    "isolatedModules": true,
+    "forceConsistentCasingInFileNames": true,
+    "allowSyntheticDefaultImports": true,
+    "skipLibCheck": true,
+    "moduleResolution": "node",
+    "target": "ES6",
+    "module": "CommonJS",
+    "lib": [
+      "es5",
+      "dom",
+      "es2015.promise",
+      "es2015.symbol",
+      "es2015.iterable",
+      "es2015.collection",
+      "es2015.symbol.wellknown",
+      "es2015.core",
+      "es2017.object",
+      "es2017.string"
+    ],
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "sourceMap": true,
+    "types": ["node"],
+    "typeRoots": [
+      "./node_modules/@types", "**/*/dist", "**/*/build", "**/*/.next", "**/*/umd"
+    ],
+    "paths": {
+      "@nhost/apollo": ["../packages/apollo/src/index.ts"],
+      "@nhost/core": ["../packages/core/src/index.ts"],
+      "@nhost/docgen": ["../packages/docgen/src/index.ts"],
+      "@nhost/hasura-auth-js": ["../packages/hasura-auth-js/src/index.ts"],
+      "@nhost/hasura-storage-js": ["../packages/hasura-storage-js/src/index.ts"],
+      "@nhost/nextjs": ["../packages/nextjs/src/index.ts"],
+      "@nhost/nhost-js": ["../packages/nhost-js/src/index.ts"],
+      "@nhost/react": ["../packages/react/src/index.ts"],
+      "@nhost/react-apollo": ["../packages/react-apollo/src/index.ts"],
+      "@nhost/react-auth": ["../packages/react-auth/src/index.ts"],
+      "@nhost/vue": ["../packages/vue/src/index.ts"]
+    }
+  },
+  "exclude": [
+    "node_modules",
+    "**/*/dist",
+    "**/*/build",
+    "**/*/.next",
+    "**/*/__tests__",
+    "**/*/__mocks__"
+  ]
+}

config/vite.lib.config.js

@@ -0,0 +1,72 @@
+import fs from 'fs'
+import path from 'path'
+
+import { defineConfig } from 'vite'
+import dts from 'vite-plugin-dts'
+import tsconfigPaths from 'vite-tsconfig-paths'
+
+const PWD = process.env.PWD
+const pkg = require(path.join(PWD, 'package.json'))
+
+const tsEntry = path.resolve(PWD, 'src/index.ts')
+const entry = fs.existsSync(tsEntry) ? tsEntry : tsEntry.replace('.ts', '.tsx')
+
+const deps = [...Object.keys(Object.assign({}, pkg.peerDependencies, pkg.dependencies))]
+
+export default defineConfig({
+  optimizeDeps: {
+    include: ['react/jsx-runtime']
+  },
+  plugins: [
+    tsconfigPaths(),
+    dts({
+      exclude: ['**/*.spec.ts', '**/*.test.ts', '**/tests/**'],
+      afterBuild: () => {
+        const types = fs.readdirSync(path.join(PWD, 'dist/src'))
+        types.forEach((file) => {
+          fs.renameSync(path.join(PWD, 'dist/src', file), path.join(PWD, 'dist', file))
+        })
+        fs.rmdirSync(path.join(PWD, 'dist/src'))
+      }
+    })
+  ],
+  test: {
+    globals: true,
+    environment: 'jsdom',
+    reporters: 'verbose',
+    include: [`${PWD}/src/**/*.{spec,test}.{ts,tsx}`, `${PWD}/tests/**/*.{spec,test}.{ts,tsx}`],
+    // Note: temporarily disabled threads, because of a bug in vitest
+    // https://github.com/vitest-dev/vitest/issues/1171
+    threads: false
+  },
+  build: {
+    sourcemap: true,
+    lib: {
+      entry,
+      name: pkg.name,
+      fileName: 'index',
+      formats: ['cjs', 'es']
+    },
+    rollupOptions: {
+      external: (id) => deps.some((dep) => id.startsWith(dep)),
+      output: {
+        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',
+          'graphql-ws': 'graphql-ws',
+          xstate: 'xstate',
+          axios: 'axios',
+          'js-cookie': 'Cookies',
+          react: 'React',
+          'react-dom': 'ReactDOM',
+          'react/jsx-runtime': '_jsx',
+          '@nhost/react': '@nhost/react'
+        }
+      }
+    }
+  }
+})

config/vite.lib.dev.config.js

@@ -0,0 +1,13 @@
+import { defineConfig } from 'vite'
+
+import viteLibConfig from './vite.lib.config'
+
+export default defineConfig({
+  ...viteLibConfig,
+  build: {
+    ...viteLibConfig.build,
+    watch: {
+      buildDelay: 500
+    }
+  }
+})

config/vite.lib.umd.config.js

@@ -0,0 +1,42 @@
+import fs from 'fs'
+import path from 'path'
+
+import { defineConfig } from 'vite'
+import dts from 'vite-plugin-dts'
+import tsconfigPaths from 'vite-tsconfig-paths'
+
+import baseLibConfig from './vite.lib.config'
+
+const PWD = process.env.PWD
+const pkg = require(path.join(PWD, 'package.json'))
+
+const deps = [...Object.keys(Object.assign({}, pkg.peerDependencies))]
+
+export default defineConfig({
+  plugins: [
+    tsconfigPaths(),
+    dts({
+      exclude: ['**/*.spec.ts', '**/*.test.ts', '**/tests/**'],
+      afterBuild: () => {
+        const types = fs.readdirSync(path.join(PWD, 'umd/src'))
+        types.forEach((file) => {
+          fs.renameSync(path.join(PWD, 'umd/src', file), path.join(PWD, 'umd', file))
+        })
+        fs.rmdirSync(path.join(PWD, 'umd/src'))
+      }
+    })
+  ],
+  build: {
+    ...(baseLibConfig.build || {}),
+    outDir: 'umd',
+    lib: {
+      ...(baseLibConfig.build?.lib || {}),
+      fileName: pkg.name.replace(/@nhost\//g, ''),
+      formats: ['umd']
+    },
+    rollupOptions: {
+      ...(baseLibConfig.build?.rollupOptions || {}),
+      external: (id) => deps.some((dep) => id.startsWith(dep))
+    }
+  }
+})

config/vite.react.config.js

@@ -0,0 +1,10 @@
+import { defineConfig } from 'vite'
+
+import react from '@vitejs/plugin-react'
+
+import baseLibConfig from './vite.lib.config'
+
+export default defineConfig({
+  ...baseLibConfig,
+  plugins: [react(), ...baseLibConfig.plugins]
+})

config/vite.react.dev.config.js

@@ -0,0 +1,13 @@
+import { defineConfig } from 'vite'
+
+import viteReactConfig from './vite.react.config'
+
+export default defineConfig({
+  ...viteReactConfig,
+  build: {
+    ...viteReactConfig.build,
+    watch: {
+      buildDelay: 500
+    }
+  }
+})

config/vite.react.umd.config.js

@@ -0,0 +1,45 @@
+import fs from 'fs'
+import path from 'path'
+
+import { defineConfig } from 'vite'
+import dts from 'vite-plugin-dts'
+import tsconfigPaths from 'vite-tsconfig-paths'
+
+import react from '@vitejs/plugin-react'
+
+import baseLibConfig from './vite.lib.config'
+
+const PWD = process.env.PWD
+const pkg = require(path.join(PWD, 'package.json'))
+
+const deps = [...Object.keys(Object.assign({}, pkg.peerDependencies))]
+
+export default defineConfig({
+  plugins: [
+    react(),
+    tsconfigPaths(),
+    dts({
+      exclude: ['**/*.spec.ts', '**/*.test.ts', '**/tests/**'],
+      afterBuild: () => {
+        const types = fs.readdirSync(path.join(PWD, 'umd/src'))
+        types.forEach((file) => {
+          fs.renameSync(path.join(PWD, 'umd/src', file), path.join(PWD, 'umd', file))
+        })
+        fs.rmdirSync(path.join(PWD, 'umd/src'))
+      }
+    })
+  ],
+  build: {
+    ...(baseLibConfig.build || {}),
+    outDir: 'umd',
+    lib: {
+      ...(baseLibConfig.build?.lib || {}),
+      fileName: pkg.name.replace(/@nhost\//g, ''),
+      formats: ['umd']
+    },
+    rollupOptions: {
+      ...(baseLibConfig.build?.rollupOptions || {}),
+      external: (id) => deps.some((dep) => id.startsWith(dep))
+    }
+  }
+})

config/vite.vue.config.js

@@ -0,0 +1,10 @@
+import { defineConfig } from 'vite'
+
+import vue from '@vitejs/plugin-vue'
+
+import baseLibConfig from './vite.lib.config'
+
+export default defineConfig({
+  ...baseLibConfig,
+  plugins: [vue(), ...baseLibConfig.plugins]
+})

config/vite.vue.dev.config.js

@@ -0,0 +1,13 @@
+import { defineConfig } from 'vite'
+
+import viteVueConfig from './vite.vue.config'
+
+export default defineConfig({
+  ...viteVueConfig,
+  build: {
+    ...viteVueConfig.build,
+    watch: {
+      buildDelay: 500
+    }
+  }
+})

config/vite.vue.umd.config.js

@@ -0,0 +1,45 @@
+import fs from 'fs'
+import path from 'path'
+
+import { defineConfig } from 'vite'
+import dts from 'vite-plugin-dts'
+import tsconfigPaths from 'vite-tsconfig-paths'
+
+import vue from '@vitejs/plugin-vue'
+
+import baseLibConfig from './vite.lib.config'
+
+const PWD = process.env.PWD
+const pkg = require(path.join(PWD, 'package.json'))
+
+const deps = [...Object.keys(Object.assign({}, pkg.peerDependencies))]
+
+export default defineConfig({
+  plugins: [
+    vue(),
+    tsconfigPaths(),
+    dts({
+      exclude: ['**/*.spec.ts', '**/*.test.ts', '**/tests/**'],
+      afterBuild: () => {
+        const types = fs.readdirSync(path.join(PWD, 'umd/src'))
+        types.forEach((file) => {
+          fs.renameSync(path.join(PWD, 'umd/src', file), path.join(PWD, 'umd', file))
+        })
+        fs.rmdirSync(path.join(PWD, 'umd/src'))
+      }
+    })
+  ],
+  build: {
+    ...(baseLibConfig.build || {}),
+    outDir: 'umd',
+    lib: {
+      ...(baseLibConfig.build?.lib || {}),
+      fileName: pkg.name.replace(/@nhost\//g, ''),
+      formats: ['umd']
+    },
+    rollupOptions: {
+      ...(baseLibConfig.build?.rollupOptions || {}),
+      external: (id) => deps.some((dep) => id.startsWith(dep))
+    }
+  }
+})

docs/.prettierrc.json

@@ -1,11 +0,0 @@
-{
-  "singleQuote": true,
-  "printWidth": 80,
-  "tabWidth": 2,
-  "useTabs": false,
-  "trailingComma": "all",
-  "bracketSpacing": true,
-  "bracketSameLine": false,
-  "endOfLine": "auto",
-  "semi": true
-}

docs/CHANGELOG.md

@@ -0,0 +1,9 @@
+# @nhost/docs
+
+## 0.0.1
+
+### Patch Changes
+
+- 584976d: - publishable directory structure changes (ESM, CJS and UMD included in the output)
+  - build system improvements
+  - fixed some bundling concerns (https://github.com/nhost/nhost/issues/428)

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/index.mdx

@@ -16,6 +16,7 @@ Get started quickly by following one of our quickstart guides:
 
 - [Next.js](/platform/quickstarts/nextjs)
 - [React](/platform/quickstarts/react)
+- [Vue](/platform/quickstarts/vue)
 
 ## Products and features
 

docs/docs/platform/authentication/user-management.md

@@ -17,6 +17,7 @@ query {
     id
     displayName
     email
+    metadata
   }
 }
 ```
@@ -29,6 +30,7 @@ query {
     id
     displayName
     email
+    metadata
   }
 }
 ```
@@ -85,3 +87,8 @@ await nhost.graphql.request(
 ```
 
 If the request is not part of the user's roles, the request will fail.
+
+---
+## Metadata
+
+Custom additional user information stored in the `metadata` column. Can be any JSON object.

docs/docs/platform/cli.md

@@ -1,88 +0,0 @@
----
-title: 'CLI'
-sidebar_position: 11
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-Nhost CLI lets you run Nhost's development environment locally on macOS, Linux and Windows.
-
----
-
-## Installation
-
-Download and install Nhost CLI for your platform by running this command in your terminal:
-
-```bash
-sudo curl -L https://raw.githubusercontent.com/nhost/cli/main/get.sh | bash
-```
-
-### Dependencies
-
-- [Git](https://git-scm.com/downloads) must be installed on your system
-- [Docker](https://www.docker.com/get-started) must be installed and running when using Nhost CLI
-
-### Function runtimes
-
-To run serverless functions locally, you must have the appropriate runtimes installed on your machine:
-
-- JavaScript and TypeScript functions: `Node.js 14.*`
-
-For Node.js, you will also need to have [express](https://www.npmjs.com/package/express) installed in your repository:
-
-<Tabs>
-  <TabItem value="npm" label="npm" default>
-
-```bash
-npm install --save-dev express @types/express
-```
-
-  </TabItem>
-  <TabItem value="yarn" label="Yarn">
-
-```bash
-yarn add -D express @types/express
-```
-
-  </TabItem>
-</Tabs>
-
-[Read more about runtimes](/platform/serverless-functions)
-
----
-
-## Windows support
-
-If you have Windows Subsystem for Linux and `curl` in your Windows environment, you run the command following the instructions above. It will download the `.exe` binary to your current working directory.
-
-If you do not have the above dependencies, download and install the latest release manually from [GitHub releases](https://github.com/nhost/cli/releases).
-
----
-
-## Apple silicon (M1)
-
-As of late 2021, Hasura does not yet have an M1 optimized version for their GraphQL engine, which Nhost depends on.
-
-If you have a MacBook with an M1 chip, the CLI will automatically change the image used in `nhost/config.yaml` of your app:
-
-```yml
-services:
-  hasura:
-    image: fedormelexin/graphql-engine-arm64
-```
-
-This will run the Hasura GraphQL engine using Rosetta on your machine until an M1 optimized image is launched.
-
----
-
-## Upgrading
-
-If you already Nhost CLI installed, you can upgrade your installation:
-
-```bash
-# sudo permissions needed
-sudo nhost upgrade
-```
-
-The `upgrade` command was added in `0.5.0`.

docs/docs/platform/cli.mdx

@@ -0,0 +1,80 @@
+---
+title: 'CLI'
+sidebar_position: 11
+---
+
+import Tabs from '@theme/Tabs'
+import TabItem from '@theme/TabItem'
+
+Nhost CLI, or `nhost`, is a command-line interface that lets you run and manage Nhost apps locally on Mac, Linux and Windows (WSL2).
+
+This means you get a full-featured Nhost app running locally on your machine:
+
+- Postgres Database
+- Hasura GraphQL API
+- Hasura Console
+- Auth
+- Storage
+- Serverless Functions
+
+This way, you can develop and test local changes before you deploy them live. The CLI automatically tracks:
+
+- Postgres database migrations
+- Hasura metadata
+- Serverless functions
+
+It's recommended to commit and push changes to GitHub and use the [GitHub integration](/platform/github-integration) for Nhost to automatically deploy those changes live.
+
+## Installation
+
+To download and install Nhost CLI, run the following command:
+
+```bash
+sudo curl -L https://raw.githubusercontent.com/nhost/cli/main/get.sh | bash
+```
+
+### Dependencies
+
+The following dependencies are required:
+
+- [Git](https://git-scm.com/downloads)
+- [Docker](https://www.docker.com/get-started) (must be running while using the CLI)
+
+## Get started
+
+Start by authenticating yourself to Nhost Cloud:
+
+```
+nhost login
+```
+
+Once signed in, you can list all your Nhost apps using:
+
+```
+nhost list
+```
+
+Let's start by initializing a remote Nhost app locally with the following command:
+
+```
+nhost init --remote
+```
+
+Pick a Nhost app to use then change the directory once the app initialization is completed:
+
+```
+cd my_test_app
+```
+
+Then start the Nhost app locally:
+
+```
+nhost up
+```
+
+Hasura Console starts automatically and your Nhost app is running locally with the backend URL: `http://localhost:1337`.
+
+## What's next?
+
+- Read our in-depth guide on [Get started with Nhost CLI](/platform/overview/get-started-with-nhost-cli)
+- [CLI commands reference](/reference/cli)

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/overview/architecture.md

@@ -23,7 +23,6 @@ Data is stored in Postgres and files are stored in S3.
 The open source tools used for the full Nhost stack are:
 
 - Database: [Postgres](https://www.postgresql.org/)
-- S3: [Minio](https://github.com/minio/minio)
 - GraphQL: [Hasura](https://github.com/hasura/graphql-engine)
 - Authentication: [Hasura Auth](https://github.com/nhost/hasura-auth)
 - Storage: [Hasura Storage](https://github.com/nhost/hasura-storage)

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

@@ -0,0 +1,425 @@
+---
+title: 'Get Started with Nhost CLI'
+sidebar_position: 2
+---
+
+# Get started with Nhost CLI
+
+Nhost's command-line interface (CLI) lets you run a complete Nhost development
+environment locally with the following services: PostgreSQL database, Hasura,
+Authentication, Storage (MinIO), Serverless Functions, and Emails (Mailhog).
+
+## Installation
+
+### Install the binary globally
+
+To install **Nhost CLI**, run this command from any directory in your terminal:
+
+```bash
+sudo curl -L https://raw.githubusercontent.com/nhost/cli/main/get.sh | bash
+```
+
+On **MacOS and Linux**, this will install the **Nhost CLI** in `/usr/local/bin`.
+
+If you'd prefer to install to a different location other than `/usr/local/bin`,
+set the `INSTALL_PATH` variable accordingly:
+
+```bash
+sudo curl -L https://raw.githubusercontent.com/nhost/cli/main/get.sh | INSTALL_PATH=$HOME/bin bash
+```
+
+On **Windows**, this will download and extract the binary `nhost.exe` available
+under `Assets` of the latest release from the GitHub release page:
+https://github.com/nhost/cli/releases.
+
+You can move the executable to a different location and add the path to the
+environment variable `PATH` to make `nhost` accessible globally.
+
+Finally, you can check that everything has been successfully installed by
+typing:
+
+```bash
+nhost version
+```
+
+![Nhost CLI Version](/img/architecture/cli/cli-installed.png)
+
+### (Optional) Add shell completion
+
+To add command auto-completion in the shell, you can run the following command:
+
+```bash
+nhost completion [shell]
+```
+
+This will generate the autocompletion script for `nhost` for the specified shell
+(bash, fish, PowerShell, or zsh).
+
+## Prerequisites
+
+### Dependencies
+
+Before using the **Nhost CLI**, make sure you have the following dependencies
+installed on your local machine:
+
+- [Git](https://git-scm.com/downloads)
+- [Docker](https://www.docker.com/get-started)
+
+:::caution
+Docker must be running while using Nhost CLI.
+:::
+
+### Nhost CLI login
+
+After installing **Nhost CLI**, you can log in to your Nhost account by running
+the following command:
+
+```bash
+nhost login
+```
+
+This will display a prompt for you to enter your Nhost account credentials
+(email/password).
+
+:::info
+You can create a Nhost account here: [https://app.nhost.io](https://app.nhost.io/).
+:::
+
+![Nhost CLI Login](/img/architecture/cli/cli-login.png)
+
+After successfully logging in, you are authorized to manage your Nhost projects
+using the Nhost CLI.
+
+You can also log out at any time by running:
+
+```bash
+nhost logout
+```
+
+## Set up your project
+
+### 1. Create a new Nhost app
+
+import CreateApp from '@site/src/components/create-nhost-app.mdx';
+
+<CreateApp />
+
+### 2. Create a new GitHub Repository
+
+A typical workflow would also include creating a Github repository for your
+Nhost project. It will facilitate your development workflow since Nhost can
+integrate with Github to enable continuous deployment.
+
+So, go to your Github account and
+[create a new repository](https://github.com/new). You can make your repository
+either public or private.
+
+![Create GitHub Repo](/img/architecture/cli/create-github-repo.png)
+
+### 3. Connect Nhost project to Github
+
+Finally, connect your Github repository to your Nhost project. Doing so will
+enable Nhost to deploy new versions of your project when you push automatically
+commits to your connected Git repository.
+
+1. From your project workspace, click **Connect to Github**.
+
+![Connect to GitHub](/img/architecture/cli/connect-repo-step-1.png)
+
+2. **Install the Nhost app** on your Github account.
+
+![Connect to GitHub](/img/architecture/cli/connect-repo-step-2.png)
+
+3. **Connect** your Github repository.
+
+![Connect to GitHub](/img/architecture/cli/connect-repo-step-3.png)
+
+## Develop locally
+
+## 1. Initialize your Nhost app
+
+**Nhost CLI** brings the functionality of your Nhost production environment
+directly to your local machine.
+
+It provides Docker containers to run the backend services that match your
+production application in a local environment. That way, you can make changes
+and test your code locally before deploying those changes to production.
+
+You can either initialize a blank Nhost app locally to start from scratch by
+running the following command:
+
+```bash
+nhost init -n my-nhost-app
+```
+
+And then link it to a remote app from your Nhost workspace in `app.nhost.io` by
+running the `link` command and selecting the corresponding app from the prompt:
+
+```bash
+nhost link
+```
+
+Or you can directly initialize a local Nhost app from one of your existing
+production apps by specifying the `--remote` flag:
+
+```bash
+nhost init --remote -n my-nhost-app
+```
+
+It will also prompt you to choose the remote app you'd like to use to initialize
+your local Nhost development environment.
+
+![Select app](/img/architecture/cli/cli-select-app.png)
+
+The `init` command creates the Nhost app inside your current working directory
+within a `nhost/` folder.
+
+```
+my-nhost-app/
+  └─ nhost/
+      ├─ config.yaml
+      ├─ emails/
+      ├─ metadata/
+      ├─ migrations/
+      └─ seeds/
+```
+
+Finally, make sure to link your current working directory to your GitHub
+repository:
+
+```bash
+echo "# my-nhost-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]/my-nhost-app.git
+git push -u origin main
+```
+
+## 2. Start a local development environment
+
+To start a local development environment for your Nhost app, run the following
+command:
+
+```bash
+nhost dev
+```
+
+:::caution
+Make sure [Docker](https://www.docker.com/get-started) is up and running. It’s required for Nhost to work.
+:::
+
+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 try out the API.
+
+The Hasura console should open automatically at
+[http://localhost:1337](http://localhost:1337/).
+
+![Hasura Console](/img/architecture/cli/hasura-console.png)
+
+## 3. Make changes
+
+There are three things the Nhost CLI and the GitHub integration track and apply
+to production:
+
+- Database migrations
+- Hasura Metadata
+- Serverless Functions
+
+:::caution
+Settings in `nhost/config.yaml` are not being applied to production. They only work locally for now.
+:::
+
+### Database migrations
+
+Database changes are tracked and managed through migrations.
+
+:::tip
+It's important that you use the Hasura console to make database changes. Indeed, with the Hasura console, DB migration files are generated incrementally to track changes automatically for you.
+:::
+
+To demonstrate how to make database changes, let's create a new table called
+`messages`, with the following columns:
+
+- `id` (type UUID and default `gen_random_uuid()`),
+- `text` (type Text),
+- `authorId` (type UUID),
+- `createdAt` (type Timestamp and default `now()`)
+
+In the Hasura console, head over to the **data** tab section and click on the
+PostgreSQL database (from the left side navigation) that Nhost provides us.
+
+Click on the **public** schema and the **Create Table** button.
+
+![Create Table](/img/architecture/cli/create-table-step-1.png)
+
+Then, enter the values for creating the `messages` table as mentioned above.
+Also, specify the `id` column as the primary key of the table, and link the
+`authorId` column to the `users.id` column using a foreign key to link the
+`users` and `messages` tables together.
+
+![Create Table](/img/architecture/cli/create-table-step-2.png)
+
+Next, click on the **Add Table** button to create the table.
+
+Finally, check out the `migrations/` folder in your project directory. A
+migration file has been created automatically to reflect our database changes
+and track the new table creation.
+
+The migration was created under `nhost/migrations/default`:
+
+```bash
+$ ls -la nhost/migrations/default
+total 0
+drwxr-xr-x  3 user  staff   96 Apr 27 17:06 .
+drwxr-xr-x  3 user  staff   96 Apr 27 17:06 ..
+drwxr-xr-x  4 user  staff  128 Apr 27 17:06 1651071963431_create_table_public_messages
+```
+
+However, note that this database migration has only been applied locally. In
+other words, the `messages` table does not (yet) exists in production.
+
+To apply the local changes to production, check out the
+[Deploy your project](#deploy-your-project) section below.
+
+### Hasura metadata
+
+In addition to database schema changes, Nhost also tracks Hasura metadata.
+
+The Hasura metadata track all the actions performed on the console, like
+tracking tables/views/functions, creating relationships, configuring
+permissions, creating event triggers, and remote schemas.
+
+To demonstrate it, let's add a new permission to our `messages` table for the
+`user` role on the `insert` operation. That permission will allow users to
+create new messages.
+
+So, open the permissions tab for the `messages` table, type in `user` in the
+role cell, and click the edit icon on the `insert` operation:
+
+![Create Table](/img/architecture/cli/permissions-1.png)
+
+To restrict the users to create new messages only for themselves, specify an
+`_eq` condition between the `authorId` and the `X-Hasura-User-ID` session
+variable, which is passed with each request.
+
+![Create Table](/img/architecture/cli/permissions-2.png)
+
+Then, select the columns the users can define through the GraphQL API, set the
+value for the `authorId` column to be equal to the `X-Hasura-User-ID` session
+variable, and click **Save Permissions**.
+
+![Create Table](/img/architecture/cli/permissions-3.png)
+
+Finally, check out the `metadata/` folder in your project directory to confirm
+that the permission changes we did were tracked locally in your git repository.
+
+In our case, those changes should be tracked in
+`nhost/metadata/databases/default/tables/public_messages.yaml`:
+
+```yaml title="nhost/metadata/databases/default/tables/public_messages.yaml"
+table:
+  name: messages
+  schema: public
+insert_permissions:
+  - permission:
+      backend_only: false
+      check:
+        authorId:
+          _eq: X-Hasura-User-Id
+      columns:
+        - text
+      set:
+        authorId: x-hasura-User-Id
+    role: user
+```
+
+### Serverless functions
+
+Now let's create a serverless function before we push all changes to GitHub so
+Nhost can deploy them to production.
+
+For this guide, let's create a simple serverless function that will return the
+current date-time when called.
+
+First, make sure to install `express`, which is required for serverless
+functions to work.
+
+```bash
+npm install express
+npm install -d @types/node @types/express
+```
+
+Then, create a new file named `time.ts` inside the `functions/` folder of your
+working directory, and paste the following code:
+
+```ts title="functions/time.ts"
+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()}`)
+}
+```
+
+Every JavaScript and TypeScript file inside the `functions/` folder becomes an
+API endpoint.
+
+Locally, the base URL for the serverless functions is
+`http://localhost:1337/v1/functions`. Then, the endpoint for each function is
+determined by its filename or the name of its dedicated parent directory.
+
+For example, the endpoint for our function is
+`http://localhost:1337/v1/functions/time`.
+
+```bash
+curl http://localhost:1337/v1/functions/time\?name\=Greg
+Hello Greg! It's now: Wed, 27 Apr 2022 18:52:12 GMT
+```
+
+## Deploy your project
+
+To deploy your local changes to production, you can commit and push them to
+GitHub. As a result, Nhost will automatically pick up the changes in your
+repository and apply them to your associated remote Nhost project.
+
+:::caution
+Make sure to [connect your Github repository](#3-connect-nhost-project-to-Github) to your Nhost project first.
+:::
+
+```bash
+git add -A
+git commit -m "commit message"
+git push
+```
+
+To check out your deployment, head over to the **Deployments** tab in your
+[Nhost dashboard](https://app.nhost.io).
+
+![Deployments](/img/architecture/cli/deployments.png)
+
+## Get help
+
+To get usage tips and learn more about available commands from within Nhost CLI,
+run the following:
+
+```shell
+nhost help
+```
+
+For more information about a specific command, run the command with the `--help`
+flag:
+
+```
+nhost init --help
+```
+
+If you have additional questions or ideas for new features, you can
+[start an issue](https://github.com/nhost/cli/issues) or
+[a new discussion](https://github.com/nhost/cli/discussions/new) on Nhost CLI’s
+open-source repository. You can also
+[chat with our team](https://discord.com/invite/9V7Qb2U) on Discord.
+
+We’d love to hear from you!

docs/docs/platform/quickstarts/nextjs.md

@@ -1,8 +0,0 @@
----
-title: 'Quickstart: Next.js'
-sidebar_position: 2
----
-
-## Introduction
-
-This is a quickstart guide for React with Nhost.

docs/docs/platform/quickstarts/nextjs.mdx

@@ -0,0 +1,699 @@
+---
+title: 'Quickstart: Next.js'
+sidebar_position: 2
+---
+
+import Tabs from '@theme/Tabs'
+import TabItem from '@theme/TabItem'
+
+# Quickstart: Next.js
+
+## Introduction
+
+This quickstart guide provides the steps you need to build a simple Next.js app
+powered by Nhost for the backend. It includes:
+
+- Database: [PostgreSQL](https://www.postgresql.org/)
+- Instant GraphQL API: [Hasura](https://hasura.io/)
+- Authentication: [Hasura Auth](https://github.com/nhost/hasura-auth/)
+- Storage: [Hasura Storage](https://hub.docker.com/r/nhost/hasura-storage)
+
+By the end of this guide, you'll have a full-stack app that allows users to log
+in to access a protected dashboard and update their profile information.
+
+## Prerequisites
+
+Before getting started, let's make sure that your development environment is
+ready.
+
+You'll need **Node.js** version 12 or later: [install it from here](https://nodejs.org/en/).
+
+## Project setup
+
+### Create a new Nhost app
+
+import CreateApp from '@site/src/components/create-nhost-app.mdx'
+
+<CreateApp />
+
+:::info
+You can also connect your Nhost app to a GitHub repository. When you do this, any updates you push to your code will automatically be deployed. [Learn more](https://docs.nhost.io/platform/github-integration).
+:::
+
+## Initialize the app
+
+### Create a Next.js app
+
+The simplest way to create a new Next.js application is by using the tool called
+`create-next-app`, which bootstraps a Next.js app for you without the hassle of
+configuring everything yourself.
+
+So, open your terminal, and run the following command:
+
+```bash
+npx create-next-app my-nhost-app --example "https://github.com/nhost/quickstart-nextjs"
+```
+
+:::info
+This command uses an [existing template](https://github.com/nhost/quickstart-nextjs), through the `--example` flag, which already contains the React components and pages we'll use for this guide.
+:::
+
+You can now `cd` into your project directory:
+
+```bash
+cd my-nhost-app
+```
+
+And run the development server with the following command:
+
+<Tabs groupId="package-manager">
+  <TabItem value="npm" label="npm" default>
+
+```bash
+npm run dev
+```
+
+  </TabItem>
+  <TabItem value="yarn" label="Yarn">
+
+```bash
+yarn dev
+```
+
+  </TabItem>
+</Tabs>
+
+If everything is working fine, your Next.js development server should be running
+on port 3000. Open [http://localhost:3000](http://localhost:3000) from your
+browser to check this out.
+
+### Configure Nhost with Next.js
+
+To work with Nhost from within our Next.js app, we'll use the
+[Next.js SDK](https://github.com/nhost/nhost/tree/main/packages/nextjs) provided
+by Nhost. It's a wrapper around the
+[Nhost React SDK](https://github.com/nhost/nhost/tree/main/packages/react) which
+gives us a way to interact with our Nhost backend using React hooks.
+
+You can install the Nhost Next.js SDK with:
+
+<Tabs groupId="package-manager">
+  <TabItem value="npm" label="npm" default>
+
+```bash
+npm install @nhost/react @nhost/nextjs graphql
+```
+
+  </TabItem>
+  <TabItem value="yarn" label="Yarn">
+
+```bash
+yarn add @nhost/react @nhost/nextjs graphql
+```
+
+  </TabItem>
+</Tabs>
+
+Next, open your `_app.js` file as we'll now configure Nhost inside our app.
+
+The Nhost Next.js SDK comes with a React provider named `NhostNextProvider` that
+makes the authentication state and all the provided React hooks available in our
+application.
+
+Use the following code to instantiate a new Nhost client and link it to your
+Nhost backend:
+
+```jsx title="pages/_app.js"
+import { UserProvider } from '../UserProvider';
+// highlight-start
+import { NhostNextProvider, NhostClient } from '@nhost/nextjs';
+// highlight-end
+
+// highlight-start
+const nhost = new NhostClient({
+  backendUrl: process.env.NEXT_PUBLIC_NHOST_BACKEND_URL || '',
+});
+// highlight-end
+
+function MyApp({ Component, pageProps }) {
+  return (
+    {/* highlight-next-line */}
+    <NhostNextProvider nhost={nhost} initial={pageProps.nhostSession}>
+      <UserProvider>
+        {/* ... */}
+      </UserProvider>
+    {/* highlight-next-line */}
+    </NhostNextProvider>
+  );
+}
+```
+
+Finally, make sure to create an environment variable named
+`NEXT_PUBLIC_NHOST_BACKEND_URL` to store your Nhost backend URL:
+
+```yaml title=".env.development"
+NEXT_PUBLIC_NHOST_BACKEND_URL=YOUR_NHOST_BACKEND_URL
+```
+
+You can find your Nhost backend URL for your project from [your dashboard](https://app.nhost.io) as shown below:
+
+![Nhost Backend URL](/img/quickstarts/app-dashboard.png)
+
+:::caution
+Don't forget to restart your Next.js server after saving your `.env.development`
+file to load your new environment variable.
+:::
+
+## Build the app
+
+### Add authentication
+
+#### 1. Sign-up
+
+The next step is to allow our users to authenticate into our application.
+Let's start with implementing the sign-up process.
+
+For that, we'll use the `useSignUpEmailPassword` hook provided by the Nhost
+Next.js SDK within our `SignUp` component.
+
+So, open up the corresponding file from your project, and use the following
+code:
+
+```jsx title="components/SignUp.js"
+import styles from '../styles/components/SignUp.module.css'
+import { useState } from 'react'
+import { useRouter } from 'next/router'
+import { useSignUpEmailPassword } from '@nhost/nextjs'
+import Link from 'next/link'
+import Image from 'next/image'
+import Input from './Input'
+import Spinner from './Spinner'
+
+const SignUp = () => {
+  const [firstName, setFirstName] = useState('')
+  const [lastName, setLastName] = useState('')
+  const [email, setEmail] = useState('')
+  const [password, setPassword] = useState('')
+
+  const router = useRouter()
+
+  const { signUpEmailPassword, isLoading, isSuccess, needsEmailVerification, isError, error } =
+    useSignUpEmailPassword()
+
+  const handleOnSubmit = async (e) => {
+    e.preventDefault()
+
+    await signUpEmailPassword(email, password, {
+      displayName: `${firstName} ${lastName}`.trim(),
+      metadata: {
+        firstName,
+        lastName
+      }
+    })
+  }
+
+  if (isSuccess) {
+    router.push('/')
+    return null
+  }
+
+  const disableForm = isLoading || needsEmailVerification
+
+  return (
+    <div className={styles.container}>
+      <div className={styles.card}>
+        <div className={styles['logo-wrapper']}>
+          <Image src="/logo.svg" alt="logo" layout="fill" objectFit="contain" />
+        </div>
+
+        {needsEmailVerification ? (
+          <p className={styles['verification-text']}>
+            Please check your mailbox and follow the verification link to verify your email.
+          </p>
+        ) : (
+          <form onSubmit={handleOnSubmit} className={styles.form}>
+            <div className={styles['input-group']}>
+              <Input
+                label="First name"
+                value={firstName}
+                onChange={(e) => setFirstName(e.target.value)}
+                disabled={disableForm}
+                required
+              />
+              <Input
+                label="Last name"
+                value={lastName}
+                onChange={(e) => setLastName(e.target.value)}
+                disabled={disableForm}
+                required
+              />
+            </div>
+            <Input
+              type="email"
+              label="Email address"
+              value={email}
+              onChange={(e) => setEmail(e.target.value)}
+              disabled={disableForm}
+              required
+            />
+            <Input
+              type="password"
+              label="Create password"
+              value={password}
+              onChange={(e) => setPassword(e.target.value)}
+              disabled={disableForm}
+              required
+            />
+
+            <button type="submit" disabled={disableForm} className={styles.button}>
+              {isLoading ? <Spinner size="sm" /> : 'Create account'}
+            </button>
+
+            {isError ? <p className={styles['error-text']}>{error?.message}</p> : null}
+          </form>
+        )}
+      </div>
+
+      <p className={styles.text}>
+        Already have an account?{' '}
+        <Link href="/sign-in">
+          <a className={styles.link}>Sign in</a>
+        </Link>
+      </p>
+    </div>
+  )
+}
+
+export default SignUp
+```
+
+By default, the user must verify his email address before fully signing up. You can change this setting from your Nhost dashboard.
+
+#### 2. Sign-in
+
+Now that new users can sign up for our application, let's see how to allow
+existing users to sign in with email and password.
+
+For that, we will use the Nhost hook named `useSignInEmailPassword` inside our
+`SignIn` component the same way we did with our `SignUp` component. So, here's
+what your component should look like after applying the changes for the sign-in
+logic:
+
+```jsx title="components/SignIn.js"
+import styles from '../styles/components/SignIn.module.css'
+import { useState } from 'react'
+import { useRouter } from 'next/router'
+import { useSignInEmailPassword } from '@nhost/nextjs'
+import Link from 'next/link'
+import Image from 'next/image'
+import Input from './Input'
+import Spinner from './Spinner'
+
+const SignIn = () => {
+  const [email, setEmail] = useState('')
+  const [password, setPassword] = useState('')
+
+  const router = useRouter()
+
+  const { signInEmailPassword, isLoading, isSuccess, needsEmailVerification, isError, error } =
+    useSignInEmailPassword()
+
+  const handleOnSubmit = async (e) => {
+    e.preventDefault()
+    await signInEmailPassword(email, password)
+  }
+
+  if (isSuccess) {
+    router.push('/')
+    return null
+  }
+
+  const disableForm = isLoading || needsEmailVerification
+
+  return (
+    <div className={styles.container}>
+      <div className={styles.card}>
+        <div className={styles['logo-wrapper']}>
+          <Image src="/logo.svg" alt="logo" layout="fill" objectFit="contain" />
+        </div>
+
+        {needsEmailVerification ? (
+          <p className={styles['verification-text']}>
+            Please check your mailbox and follow the verification link to verify your email.
+          </p>
+        ) : (
+          <>
+            <form onSubmit={handleOnSubmit} className={styles.form}>
+              <Input
+                type="email"
+                label="Email address"
+                value={email}
+                onChange={(e) => setEmail(e.target.value)}
+                disabled={disableForm}
+                required
+              />
+              <Input
+                type="password"
+                label="Password"
+                value={password}
+                onChange={(e) => setPassword(e.target.value)}
+                disabled={disableForm}
+                required
+              />
+
+              <button type="submit" disabled={disableForm} className={styles.button}>
+                {isLoading ? <Spinner size="sm" /> : 'Sign in'}
+              </button>
+
+              {isError ? <p className={styles['error-text']}>{error?.message}</p> : null}
+            </form>
+          </>
+        )}
+      </div>
+
+      <p className={styles.text}>
+        No account yet?{' '}
+        <Link href="/sign-up">
+          <a className={styles.link}>Sign up</a>
+        </Link>
+      </p>
+    </div>
+  )
+}
+
+export default SignIn
+```
+
+#### 3. Sign-out
+
+Finally, to allow the users to sign out from the app, we can use the Nhost
+`useSignOut` hook:
+
+```jsx title="components/Layout.js"
+import { useSignOut } from '@nhost/nextjs'
+
+const Layout = ({ children = null }) => {
+  const { signOut } = useSignOut()
+
+  const menuItems = [
+    //..
+    {
+      label: 'Logout',
+      onClick: signOut,
+      icon: LogoutIcon
+    }
+  ]
+
+  //...
+}
+```
+
+### Protect routes
+
+Now that we have implemented authentication, we can easily decide who can access
+certain parts of our application.
+
+In our case, we'll only allow authenticated users to have access to the `/` and
+`/profile` routes. All the other users should be redirected to the `/sign-in`
+page if they try to access those routes.
+
+To do so, we can check the authentication status of the current user using the
+Nhost SDK by creating a
+[high-order component](https://reactjs.org/docs/higher-order-components.html):
+
+```jsx title="withAuth.js"
+import styles from './styles/pages/ProtectedRoute.module.css'
+import { useRouter } from 'next/router'
+import { useAuthenticationStatus } from '@nhost/nextjs'
+import Spinner from './components/Spinner'
+
+export default function withAuth(Component) {
+  return function AuthProtected(props) {
+    const router = useRouter()
+    const { isLoading, isAuthenticated } = useAuthenticationStatus()
+
+    if (isLoading) {
+      return (
+        <div className={styles.container}>
+          <Spinner />
+        </div>
+      )
+    }
+
+    if (!isAuthenticated) {
+      router.push('/sign-in')
+      return null
+    }
+
+    return <Component {...props} />
+  }
+}
+```
+
+Then, wrap our Next.js pages, `index.js` and `profile.js`, with it:
+
+<Tabs
+defaultValue="index"
+values={[
+  {label: 'pages/index.js', value: 'index'},
+  {label: 'pages/profile.js', value: 'profile'},
+]}>
+<TabItem value="index">
+
+```js
+import withAuth from '../withAuth'
+
+const Home = () => {
+  //...
+}
+
+export default withAuth(Home)
+```
+
+</TabItem>
+<TabItem value="profile">
+
+```js
+import withAuth from '../withAuth'
+
+const Profile = () => {
+  //...
+}
+
+export default withAuth(Profile)
+```
+
+</TabItem>
+</Tabs>
+
+### Retrieve user data
+
+Finally, let's display the information of the authenticated user throughout his
+dashboard to make the app more personalized.
+
+Getting the current authenticated user data is quite easy. We
+can use the `useUserData` hook provided by Nhost to do it.
+
+So, open the `UserProvider.js` file and use this hook like so:
+
+```js
+import React, { useContext } from 'react'
+// highlight-next-line
+import { useUserData } from '@nhost/nextjs'
+
+const UserContext = React.createContext(null)
+
+export function UserProvider({ children = null }) {
+  // highlight-next-line
+  const user = useUserData()
+  return <UserContext.Provider value={{ user }}>{children}</UserContext.Provider>
+}
+
+export function useUserContext() {
+  return useContext(UserContext)
+}
+```
+
+That's it! The JSX code for rendering the user data (email, display name, etc.)
+is already included in your components as part of the example repository you've
+bootstrapped at the beginning of this guide.
+
+### Update user data
+
+Nhost provides a GraphQL API through Hasura so that we can query and mutate our
+data instantly.
+
+In this tutorial, we'll use the
+[Apollo GraphQL client](https://www.apollographql.com/) for interacting with
+this GraphQL API.
+
+So, start by installing the following dependencies:
+
+<Tabs groupId="package-manager">
+  <TabItem value="npm" label="npm" default>
+
+```bash
+npm install @nhost/react-apollo @apollo/client
+```
+
+  </TabItem>
+  <TabItem value="yarn" label="Yarn">
+
+```bash
+yarn add @nhost/react-apollo @apollo/client
+```
+
+  </TabItem>
+</Tabs>
+
+Then, add the `NhostApolloProvider` from `@nhost/react-apollo` into your
+`_app_.js` file.
+
+```jsx title="pages/_app.js"
+import { NhostApolloProvider } from '@nhost/react-apollo'
+
+function MyApp({ Component, pageProps }) {
+  return (
+    <NhostNextProvider nhost={nhost} initial={pageProps.nhostSession}>
+      <NhostApolloProvider nhost={nhost}>{/* ... */}</NhostApolloProvider>
+    </NhostNextProvider>
+  )
+}
+```
+
+From there, we can construct our GraphQL query and use the Apollo `useMutation`
+hook to execute that query when the user submits the form from the profile page:
+
+```js title="pages/profile.js"
+import { gql, useMutation } from '@apollo/client'
+import { toast } from 'react-hot-toast'
+
+const UPDATE_USER_MUTATION = gql`
+  mutation ($id: uuid!, $displayName: String!, $metadata: jsonb) {
+    updateUser(pk_columns: { id: $id }, _set: { displayName: $displayName, metadata: $metadata }) {
+      id
+      displayName
+      metadata
+    }
+  }
+`
+
+const Profile = () => {
+  const [mutateUser, { loading: updatingProfile }] = useMutation(UPDATE_USER_MUTATION)
+
+  const updateUserProfile = async (e) => {
+    e.preventDefault()
+
+    try {
+      await mutateUser({
+        variables: {
+          id: user.id,
+          displayName: `${firstName} ${lastName}`.trim(),
+          metadata: {
+            firstName,
+            lastName
+          }
+        }
+      })
+      toast.success('Updated successfully', { id: 'updateProfile' })
+    } catch (error) {
+      toast.error('Unable to update profile', { id: 'updateProfile' })
+    }
+  }
+
+  //...
+}
+```
+
+Finally, since Hasura has an **allow nothing by default** policy, and we haven't
+set any permissions yet, our GraphQL mutations would fail.
+
+So, open the Hasura console from the **Data** tab of your project from [your Nhost dashboard](https://app.nhost.io/). Then, go to the **permissions** tab of the `users` table, type in `user` in the role
+cell, and click the edit icon on the `select` operation:
+
+![Hasura users permissions](/img/quickstarts/hasura-permissions-1.png)
+
+To restrict the user to read his data only, specify a condition with the
+user's ID and the `X-Hasura-User-ID` session variable, which is passed with each
+requests.
+
+![Hasura users permissions](/img/quickstarts/hasura-permissions-2.png)
+
+Next, select the columns you'd like the users to have access to, and click
+**Save Permissions**.
+
+![Hasura users permissions](/img/quickstarts/hasura-permissions-3.png)
+
+Repeat the same steps on the `update` operation for the `user` role to allow
+users to update their `displayName` and `metadata` only.
+
+Finally, to add caching, synchronizing, and updating server state in your Next.js app, let's refactor the user data fetching by using the Apollo client and our GraphQL API instead.
+
+So, first add the following GraphQL query to retrieve the current user data from the `UserProvider.js` file:
+
+```js title="UserProvider.js"
+import { gql } from '@apollo/client'
+
+const GET_USER_QUERY = gql`
+  query GetUser($id: uuid!) {
+    user(id: $id) {
+      id
+      email
+      displayName
+      metadata
+      avatarUrl
+    }
+  }
+`
+
+export function UserProvider() {
+  //...
+}
+```
+
+Then, replace the `useUserData` hook with the `useUserId` hook to retrieve the current user's ID only.
+
+```js title="UserProvider.js"
+import { useUserId } from '@nhost/nextjs'
+
+export function UserProvider() {
+  const id = useUserId()
+  //...
+}
+```
+
+Finally, we can run our GraphQL query using the `useQuery` hook and the current user's ID.
+
+```jsx title="UserProvider.js"
+// highlight-next-line
+import { gql, useQuery } from '@apollo/client'
+
+export function UserProvider({ children = null }) {
+  const id = useUserId()
+  // highlight-start
+  const { loading, error, data } = useQuery(GET_USER_QUERY, {
+    variables: { id }
+  })
+  const user = data?.user
+  // highlight-end
+
+  // highlight-start
+  if (error) {
+    return <p>Something went wrong. Try to refresh the page.</p>
+  }
+  if (loading) {
+    return null
+  }
+  // highlight-end
+
+  return <UserContext.Provider value={{ user }}>{children}</UserContext.Provider>
+}
+```
+
+You now have a fully functional Next.js application. Congratulations!
+
+## Next Steps
+
+- Did you enjoy Nhost? Give us a star ⭐ on [Github](https://github.com/nhost/nhost). Thank you!
+- Check out our more in-depth [examples](https://github.com/nhost/nhost/tree/main/examples).
+- Build your next app with [Nhost](https://app.nhost.io/)!

docs/docs/platform/quickstarts/react.md

@@ -1,8 +0,0 @@
----
-title: 'Quickstart: React'
-sidebar_position: 1
----
-
-## Introduction
-
-This is a quickstart guide for React with Nhost.

docs/docs/platform/quickstarts/react.mdx

@@ -0,0 +1,672 @@
+---
+title: 'Quickstart: React'
+sidebar_position: 1
+---
+
+import Tabs from '@theme/Tabs'
+import TabItem from '@theme/TabItem'
+
+# Quickstart: React
+
+## Introduction
+
+This quickstart guide provides the steps you need to build a simple React app
+powered by Nhost for the backend. It includes:
+
+- Database: [PostgreSQL](https://www.postgresql.org/)
+- Instant GraphQL API: [Hasura](https://hasura.io/)
+- Authentication: [Hasura Auth](https://github.com/nhost/hasura-auth/)
+- Storage: [Hasura Storage](https://hub.docker.com/r/nhost/hasura-storage)
+
+By the end of this guide, you'll have a full-stack app that allows users to log
+in to access a protected dashboard and update their profile information.
+
+## Prerequisites
+
+Before getting started, let's make sure that your development environment is
+ready.
+
+You'll need **Node.js** version 14 or later: [install it from here](https://nodejs.org/en/).
+
+## Project setup
+
+### Create a new Nhost app
+
+import CreateApp from '@site/src/components/create-nhost-app.mdx'
+
+<CreateApp />
+:::info
+You can also connect your Nhost app to a GitHub repository. When you do this, any updates you push to your code will automatically be deployed. [Learn more](https://docs.nhost.io/platform/github-integration).
+:::
+
+## Initialize the app
+
+### Create a React app
+
+The simplest way to create a new React application is by using the tool called
+`create-react-app`, which bootstraps a React app for you without the hassle of
+configuring everything yourself.
+
+So, open your terminal, and run the following command:
+
+```bash
+npx create-react-app my-nhost-app --template nhost-quickstart
+```
+
+:::info
+This command uses an [existing template](https://github.com/nhost/cra-template-nhost-quickstart), through the `--template` flag, which already contains the React components and pages we'll use for this guide.
+:::
+
+You can now `cd` into your project directory:
+
+```bash
+cd my-nhost-app
+```
+
+And run the development server with the following command:
+
+<Tabs groupId="package-manager">
+  <TabItem value="npm" label="npm" default>
+
+```bash
+npm start
+```
+
+  </TabItem>
+  <TabItem value="yarn" label="Yarn">
+
+```bash
+yarn start
+```
+
+  </TabItem>
+</Tabs>
+
+If everything is working fine, your React development server should be running
+on port 3000. Open [http://localhost:3000](http://localhost:3000) from your
+browser to check this out.
+
+### Configure Nhost with React
+
+To work with Nhost from within our React app, we'll use the
+[React SDK](https://github.com/nhost/nhost/tree/main/packages/react) provided
+by Nhost. It's a wrapper around the
+[Nhost JavaScript SDK](https://github.com/nhost/nhost/tree/main/packages/nhost-js) which
+gives us a way to interact with our Nhost backend using React hooks.
+
+You can install the Nhost React SDK with:
+
+<Tabs groupId="package-manager">
+  <TabItem value="npm" label="npm" default>
+
+```bash
+npm install @nhost/react graphql
+```
+
+  </TabItem>
+  <TabItem value="yarn" label="Yarn">
+
+```bash
+yarn add @nhost/react graphql
+```
+
+  </TabItem>
+</Tabs>
+
+Next, open your `App.js` file as we'll now configure Nhost inside our app.
+
+The Nhost React SDK comes with a React provider named `NhostReactProvider` that
+makes the authentication state and all the provided React hooks available in our
+application.
+
+Use the following code to instantiate a new Nhost client and link it to your
+Nhost backend:
+
+```jsx title="src/App.js"
+import { NhostClient, NhostReactProvider } from '@nhost/react'
+
+const nhost = new NhostClient({
+  backendUrl: process.env.REACT_APP_NHOST_BACKEND_URL || ''
+})
+
+function App() {
+  return (
+    <NhostReactProvider nhost={nhost}>
+      <BrowserRouter>{/* ... */}</BrowserRouter>
+    </NhostReactProvider>
+  )
+}
+
+export default App
+```
+
+Finally, make sure to create an environment variable named
+`REACT_APP_NHOST_BACKEND_URL` to store your Nhost backend URL:
+
+```yaml title=".env.local"
+REACT_APP_NHOST_BACKEND_URL=YOUR_NHOST_BACKEND_URL
+```
+
+You can find your Nhost backend URL for your project from [your dashboard](https://app.nhost.io) as shown below:
+
+![Nhost Backend URL](/img/quickstarts/app-dashboard.png)
+
+:::caution
+Don't forget to restart your React server after saving your `.env.local`
+file to load your new environment variable.
+:::
+
+## Build the app
+
+### Add authentication
+
+#### 1. Sign-up
+
+The next step is to allow our users to authenticate into our application.
+Let's start with implementing the sign-up process.
+
+For that, we'll use the `useSignUpEmailPassword` hook provided by the Nhost
+React SDK within our `SignUp` component.
+
+So, open up the corresponding file from your project, and use the following
+code:
+
+```jsx title="src/components/SignUp.js"
+import styles from '../styles/components/SignUp.module.css'
+import { useState } from 'react'
+import { useSignUpEmailPassword } from '@nhost/react'
+import { Link, Navigate } from 'react-router-dom'
+import Input from './Input'
+import Spinner from './Spinner'
+
+const SignUp = () => {
+  const [firstName, setFirstName] = useState('')
+  const [lastName, setLastName] = useState('')
+  const [email, setEmail] = useState('')
+  const [password, setPassword] = useState('')
+
+  const { signUpEmailPassword, isLoading, isSuccess, needsEmailVerification, isError, error } =
+    useSignUpEmailPassword()
+
+  const handleOnSubmit = (e) => {
+    e.preventDefault()
+
+    signUpEmailPassword(email, password, {
+      displayName: `${firstName} ${lastName}`.trim(),
+      metadata: {
+        firstName,
+        lastName
+      }
+    })
+  }
+
+  if (isSuccess) {
+    return <Navigate to="/" replace={true} />
+  }
+
+  const disableForm = isLoading || needsEmailVerification
+
+  return (
+    <div className={styles.container}>
+      <div className={styles.card}>
+        <div className={styles['logo-wrapper']}>
+          <img src={process.env.PUBLIC_URL + 'logo.svg'} alt="logo" />
+        </div>
+
+        {needsEmailVerification ? (
+          <p className={styles['verification-text']}>
+            Please check your mailbox and follow the verification link to verify your email.
+          </p>
+        ) : (
+          <form onSubmit={handleOnSubmit} className={styles.form}>
+            <div className={styles['input-group']}>
+              <Input
+                label="First name"
+                value={firstName}
+                onChange={(e) => setFirstName(e.target.value)}
+                disabled={disableForm}
+                required
+              />
+              <Input
+                label="Last name"
+                value={lastName}
+                onChange={(e) => setLastName(e.target.value)}
+                disabled={disableForm}
+                required
+              />
+            </div>
+            <Input
+              type="email"
+              label="Email address"
+              value={email}
+              onChange={(e) => setEmail(e.target.value)}
+              disabled={disableForm}
+              required
+            />
+            <Input
+              type="password"
+              label="Create password"
+              value={password}
+              onChange={(e) => setPassword(e.target.value)}
+              disabled={disableForm}
+              required
+            />
+
+            <button type="submit" disabled={disableForm} className={styles.button}>
+              {isLoading ? <Spinner size="sm" /> : 'Create account'}
+            </button>
+
+            {isError ? <p className={styles['error-text']}>{error?.message}</p> : null}
+          </form>
+        )}
+      </div>
+
+      <p className={styles.text}>
+        Already have an account?{' '}
+        <Link to="/sign-in" className={styles.link}>
+          Sign in
+        </Link>
+      </p>
+    </div>
+  )
+}
+
+export default SignUp
+```
+
+By default, the user must verify his email address before fully signing up. You can change this setting from your Nhost dashboard.
+
+#### 2. Sign-in
+
+Now that new users can sign up for our application, let's see how to allow
+existing users to sign in with email and password.
+
+For that, we will use the Nhost hook named `useSignInEmailPassword` inside our
+`SignIn` component the same way we did with our `SignUp` component. So, here's
+what your component should look like after applying the changes for the sign-in
+logic:
+
+```jsx title="src/components/SignIn.js"
+import styles from '../styles/components/SignIn.module.css'
+import { useState } from 'react'
+import { useSignInEmailPassword } from '@nhost/react'
+import { Link, Navigate } from 'react-router-dom'
+import Input from './Input'
+import Spinner from './Spinner'
+
+const SignIn = () => {
+  const [email, setEmail] = useState('')
+  const [password, setPassword] = useState('')
+
+  const { signInEmailPassword, isLoading, isSuccess, needsEmailVerification, isError, error } =
+    useSignInEmailPassword()
+
+  const handleOnSubmit = (e) => {
+    e.preventDefault()
+    signInEmailPassword(email, password)
+  }
+
+  if (isSuccess) {
+    return <Navigate to="/" replace={true} />
+  }
+
+  const disableForm = isLoading || needsEmailVerification
+
+  return (
+    <div className={styles.container}>
+      <div className={styles.card}>
+        <div className={styles['logo-wrapper']}>
+          <img src={process.env.PUBLIC_URL + 'logo.svg'} alt="logo" />
+        </div>
+
+        {needsEmailVerification ? (
+          <p className={styles['verification-text']}>
+            Please check your mailbox and follow the verification link to verify your email.
+          </p>
+        ) : (
+          <form onSubmit={handleOnSubmit} className={styles.form}>
+            <Input
+              type="email"
+              label="Email address"
+              value={email}
+              onChange={(e) => setEmail(e.target.value)}
+              disabled={disableForm}
+              required
+            />
+            <Input
+              type="password"
+              label="Password"
+              value={password}
+              onChange={(e) => setPassword(e.target.value)}
+              disabled={disableForm}
+              required
+            />
+
+            <button type="submit" disabled={disableForm} className={styles.button}>
+              {isLoading ? <Spinner size="sm" /> : 'Sign in'}
+            </button>
+
+            {isError ? <p className={styles['error-text']}>{error?.message}</p> : null}
+          </form>
+        )}
+      </div>
+
+      <p className={styles.text}>
+        No account yet?{' '}
+        <Link to="/sign-up" className={styles.link}>
+          Sign up
+        </Link>
+      </p>
+    </div>
+  )
+}
+
+export default SignIn
+```
+
+#### 3. Sign-out
+
+Finally, to allow the users to sign out from the app, we can use the Nhost
+`useSignOut` hook:
+
+```jsx title="src/components/Layout.js"
+import { useSignOut } from '@nhost/react'
+
+const Layout = () => {
+  const { signOut } = useSignOut()
+
+  const menuItems = [
+    //..
+    {
+      label: 'Logout',
+      onClick: signOut,
+      icon: LogoutIcon
+    }
+  ]
+
+  //...
+}
+```
+
+### Protect routes
+
+Now that we have implemented authentication, we can easily decide who can access
+certain parts of our application.
+
+In our case, we'll only allow authenticated users to have access to the `/` and
+`/profile` routes. All the other users should be redirected to the `/sign-in`
+page if they try to access those routes.
+
+To do so, we can create a wrapper component (`ProtectedRoute`) to check the authentication status of the current user using the Nhost SDK:
+
+```jsx title="src/components/ProtectedRoute.js"
+import styles from '../styles/components/ProtectedRoute.module.css'
+import { useAuthenticationStatus } from '@nhost/react'
+import { Navigate, useLocation } from 'react-router-dom'
+import Spinner from './Spinner'
+
+const ProtectedRoute = ({ children }) => {
+  const { isAuthenticated, isLoading } = useAuthenticationStatus()
+  const location = useLocation()
+
+  if (isLoading) {
+    return (
+      <div className={styles.container}>
+        <Spinner />
+      </div>
+    )
+  }
+
+  if (!isAuthenticated) {
+    return <Navigate to="/sign-in" state={{ from: location }} replace />
+  }
+
+  return children
+}
+
+export default ProtectedRoute
+```
+
+Then, we can use a [layout route](https://reactrouter.com/docs/en/v6/getting-started/concepts#layout-routes) in our `App.js` file, to wrap the `ProtectedRoute` component around the routes we want to protect:
+
+```jsx title="src/App.js"
+import ProtectedRoute from './components/ProtectedRoute'
+
+function App() {
+  return (
+    <NhostReactProvider nhost={nhost}>
+      <BrowserRouter>
+        <Routes>
+          <Route path="sign-up" element={<SignUp />} />
+          <Route path="sign-in" element={<SignIn />} />
+          <Route
+            path="/"
+            // highlight-start
+            element={
+              <ProtectedRoute>
+                <Layout />
+              </ProtectedRoute>
+            }
+            // highlight-end
+          >
+            <Route index element={<Dashboard />} />
+            <Route path="profile" element={<Profile />} />
+          </Route>
+        </Routes>
+      </BrowserRouter>
+    </NhostReactProvider>
+  )
+}
+```
+
+### Retrieve user data
+
+Finally, let's display the information of the authenticated user throughout his
+dashboard to make the app more personalized.
+
+Getting the current authenticated user data is quite easy. Indeed, we
+can use the `useUserData` hook provided by Nhost to do it.
+
+So, open the `components/Layout.js` file and use this hook like so:
+
+```js
+import { useUserData } from '@nhost/react'
+
+const Layout = () => {
+  const user = useUserData()
+  //...
+}
+```
+
+That's it! The JSX code for rendering the user data (email, display name, etc.)
+is already included in your components as part of the template you've
+bootstraped at the beginning of this guide.
+
+### Update user data
+
+Nhost provides a GraphQL API through Hasura so that we can query and mutate our
+data instantly.
+
+In this tutorial, we'll use the
+[Apollo GraphQL client](https://www.apollographql.com/) for interacting with
+this GraphQL API.
+
+So, start by installing the following dependencies:
+
+<Tabs groupId="package-manager">
+  <TabItem value="npm" label="npm" default>
+
+```bash
+npm install @nhost/react-apollo @apollo/client
+```
+
+  </TabItem>
+  <TabItem value="yarn" label="Yarn">
+
+```bash
+yarn add @nhost/react-apollo @apollo/client
+```
+
+  </TabItem>
+</Tabs>
+
+Then, add the `NhostApolloProvider` from `@nhost/react-apollo` into your
+`App.js` file.
+
+```jsx title="src/App.js"
+import { NhostApolloProvider } from '@nhost/react-apollo'
+
+function App() {
+  return (
+    <NhostReactProvider nhost={nhost}>
+      <NhostApolloProvider nhost={nhost}>{/* ... */}</NhostApolloProvider>
+    </NhostReactProvider>
+  )
+}
+```
+
+From there, we can construct our GraphQL query and use the Apollo `useMutation`
+hook to execute that query when the user submits the form from the profile page:
+
+```js title="src/pages/Profile.js"
+import { gql, useMutation } from '@apollo/client'
+import { toast } from 'react-hot-toast'
+
+const UPDATE_USER_MUTATION = gql`
+  mutation ($id: uuid!, $displayName: String!, $metadata: jsonb) {
+    updateUser(pk_columns: { id: $id }, _set: { displayName: $displayName, metadata: $metadata }) {
+      id
+      displayName
+      metadata
+    }
+  }
+`
+
+const Profile = () => {
+  const [mutateUser, { loading: updatingProfile }] = useMutation(UPDATE_USER_MUTATION)
+
+  const updateUserProfile = async (e) => {
+    e.preventDefault()
+
+    try {
+      await mutateUser({
+        variables: {
+          id: user.id,
+          displayName: `${firstName} ${lastName}`.trim(),
+          metadata: {
+            firstName,
+            lastName
+          }
+        }
+      })
+      toast.success('Updated successfully', { id: 'updateProfile' })
+    } catch (error) {
+      toast.error('Unable to update profile', { id: 'updateProfile' })
+    }
+  }
+
+  //...
+}
+```
+
+Finally, since Hasura has an **allow nothing by default** policy, and we haven't
+set any permissions yet, our GraphQL mutations would fail.
+
+So, open the Hasura console from the **Data** tab of your project from [your Nhost dashboard](https://app.nhost.io/). Then, go to the **permissions** tab of the `users` table, type in `user` in the role
+cell, and click the edit icon on the `select` operation:
+
+![Hasura users permissions](/img/quickstarts/hasura-permissions-1.png)
+
+To restrict the user to read his own data only, specify a condition with the
+user's ID and the `X-Hasura-User-ID` session variable, which is passed with each
+requests.
+
+![Hasura users permissions](/img/quickstarts/hasura-permissions-2.png)
+
+Next, select the columns you'd like the users to have access to, and click
+**Save Permissions**.
+
+![Hasura users permissions](/img/quickstarts/hasura-permissions-3.png)
+
+Repeat the same steps on the `update` operation for the `user` role to allow
+users to update their `displayName` and `metadata` only.
+
+Finally, to add caching, synchronizing, and updating server state in your React app, let's refactor the user data fetching using the Apollo client and our GraphQL API instead.
+
+So, first add the following GraphQL query to retrieve the current user data from the `Layout` component:
+
+```js title="src/components/Layout.js"
+import { gql } from '@apollo/client'
+
+const GET_USER_QUERY = gql`
+  query GetUser($id: uuid!) {
+    user(id: $id) {
+      id
+      email
+      displayName
+      metadata
+      avatarUrl
+    }
+  }
+`
+
+const Layout = () => {
+  //...
+}
+```
+
+Then, replace the `useUserData` hook with the `useUserId` hook to retrieve the current user's ID.
+
+```js title="src/components/Layout.js"
+import { useUserId } from '@nhost/react'
+
+const Layout = () => {
+  const id = useUserId()
+  //...
+}
+```
+
+Finally, we can run our GraphQL query using the `useQuery` hook and the current user's ID.
+
+```jsx title="src/components/Layout.js"
+// highlight-next-line
+import { gql, useQuery } from '@apollo/client'
+
+const Layout = () => {
+  const id = useUserId()
+  // highlight-start
+  const { loading, error, data } = useQuery(GET_USER_QUERY, {
+    variables: { id }
+  })
+  const user = data?.user
+  // highlight-end
+
+  //...
+
+  return (
+    <div>
+      <header>{/* ... */}</header>
+
+      <main className={styles.main}>
+        <div className={styles['main-container']}>
+          {/* highlight-start */}
+          {error ? (
+            <p>Something went wrong. Try to refresh the page.</p>
+          ) : !loading ? (
+            <Outlet context={{ user }} />
+          ) : null}
+          {/* highlight-end */}
+        </div>
+      </main>
+    </div>
+  )
+}
+```
+
+You now have a fully functional React application. Congratulations!
+
+## Next Steps
+
+- Did you enjoy Nhost? Give us a star ⭐ on [Github](https://github.com/nhost/nhost). Thank you!
+- Check out our more in-depth [examples](https://github.com/nhost/nhost/tree/main/examples).
+- Build your next app with [Nhost](https://app.nhost.io/)!

docs/docs/platform/quickstarts/vue.mdx

@@ -0,0 +1,713 @@
+---
+title: 'Quickstart: Vue'
+sidebar_position: 3
+---
+
+import Tabs from '@theme/Tabs'
+import TabItem from '@theme/TabItem'
+
+# Quickstart: Vue
+
+## Introduction
+
+This quickstart guide provides the steps you need to build a simple Vue app
+powered by Nhost for the backend. It includes:
+
+- Database: [PostgreSQL](https://www.postgresql.org/)
+- Instant GraphQL API: [Hasura](https://hasura.io/)
+- Authentication: [Hasura Auth](https://github.com/nhost/hasura-auth/)
+- Storage: [Hasura Storage](https://hub.docker.com/r/nhost/hasura-storage)
+
+By the end of this guide, you'll have a full-stack app that allows users to log
+in to access a protected dashboard and update their profile information.
+
+:::tip
+You can see the result of this quickstart [in our main repository](https://github.com/nhost/nhost/tree/main/examples/vue-quickstart).
+
+You can also preview it in the browser: [![StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/nhost/nhost/tree/main/examples/vue-quickstart)
+:::
+
+## Prerequisites
+
+Before getting started, let's make sure that your development environment is
+ready.
+
+You'll need **Node.js** version 14 or later: [install it from here](https://nodejs.org/en/).
+
+## Project setup
+
+### Create a new Nhost app
+
+import CreateApp from '@site/src/components/create-nhost-app.mdx'
+
+<CreateApp />
+
+:::info
+You can also connect your Nhost app to a GitHub repository. When you do this, any updates you push to your code will automatically be deployed. [Learn more](https://docs.nhost.io/platform/github-integration).
+:::
+
+## Initialize the app
+
+### Create a Vue app
+
+We will use a simple adaptation of [Vitesse Lite](https://github.com/antfu/vitesse-lite), a ready-to-deploy Vite template by Anthony Fu. We can scaffold it with [degit](https://github.com/Rich-Harris/degit).
+
+Open your terminal, and run the following command:
+
+```bash
+npx degit nhost/vue-quickstart my-nhost-app
+```
+
+You can now go into your project directory, install dependencies, and start the development server:
+
+<Tabs groupId="package-manager">
+  <TabItem value="npm" label="npm" default>
+
+```bash
+cd my-nhost-app
+npm install
+npm dev
+```
+
+  </TabItem>
+  <TabItem value="yarn" label="Yarn">
+
+```bash
+cd my-nhost-app
+yarn
+yarn dev
+```
+
+  </TabItem>
+  <TabItem value="pnpm" label="pnpm">
+
+```bash
+cd my-nhost-app
+pnpm install
+pnpm dev
+```
+
+  </TabItem>
+</Tabs>
+
+If everything is working fine, your Vue development server should be running
+on port 3000. Open [http://localhost:3000](http://localhost:3000) from your
+browser to check this out.
+
+### Configure Nhost with Vue
+
+To work with Nhost from within our Vue app, we'll use the
+[Vue SDK](https://github.com/nhost/nhost/tree/main/packages/react) provided
+by Nhost. It's a wrapper around the
+[Nhost JavaScript SDK](https://github.com/nhost/nhost/tree/main/packages/nhost-js) which
+gives us a way to interact with our Nhost backend using Vue composables.
+
+You can install the Nhost Vue SDK with:
+
+<Tabs groupId="package-manager">
+  <TabItem value="npm" label="npm" default>
+
+```bash
+npm install @nhost/vue graphql
+```
+
+  </TabItem>
+  <TabItem value="yarn" label="Yarn">
+
+```bash
+yarn add @nhost/vue graphql
+```
+
+  </TabItem>
+  <TabItem value="pnpm" label="pnpm">
+
+```bash
+pnpm add @nhost/vue graphql
+```
+
+  </TabItem>
+</Tabs>
+
+Next, open your `src/main.ts` file as we'll now configure Nhost inside our app.
+
+The Nhost Vue SDK comes with a `NhostClient` that can be loaded into the Vue application as a plugin.
+It makes the authentication state and all the provided Vue composables available in our
+application.
+
+Use the following code to instantiate a new Nhost client and link it to your
+Nhost backend:
+
+```tsx title="src/main.ts"
+import { createApp } from 'vue'
+import { createRouter, createWebHistory } from 'vue-router'
+import routes from 'virtual:generated-pages'
+// highlight-start
+import { NhostClient } from '@nhost/vue'
+// highlight-end
+import App from './App.vue'
+
+import '@unocss/reset/tailwind.css'
+import './styles/main.css'
+import 'uno.css'
+
+// highlight-start
+const nhost = new NhostClient({
+  backendUrl: import.meta.env.VITE_NHOST_URL
+})
+// highlight-end
+
+const app = createApp(App)
+const router = createRouter({
+  history: createWebHistory(import.meta.env.BASE_URL),
+  routes
+})
+app
+  .use(router)
+  // highlight-start
+  .use(nhost)
+// highlight-end
+app.mount('#app')
+```
+
+Finally, make sure to create an environment variable named
+`VITE_NHOST_URL` to store your Nhost backend URL:
+
+```bash title=".env"
+VITE_NHOST_URL=YOUR_NHOST_BACKEND_URL
+```
+
+You can find your Nhost backend URL for your project from [your dashboard](https://app.nhost.io) as shown below:
+
+![Nhost Backend URL](/img/quickstarts/app-dashboard.png)
+
+## Build the app
+
+### Add authentication
+
+#### 1. Sign-up
+
+The next step is to allow our users to authenticate into our application.
+Let's start with implementing the sign-up process.
+
+For that, we'll use the `useSignUpEmailPassword` composable provided by the Nhost
+Vue SDK within a `/sign-up` page.
+
+Let's create a new page in your project using the following code:
+
+```markup title="src/pages/sign-up.vue"
+<script setup lang="ts">
+  import { ref } from 'vue'
+  import { useSignUpEmailPassword } from '@nhost/vue'
+  import { useRouter } from 'vue-router'
+
+  const { signUpEmailPassword, needsEmailVerification } = useSignUpEmailPassword()
+  const router = useRouter()
+  const firstName = ref('')
+  const lastName = ref('')
+  const email = ref('')
+  const password = ref('')
+  const handleSubmit = async (event: Event) => {
+    event.preventDefault()
+    const { isSuccess } = await signUpEmailPassword(email, password, {
+      metadata: { firstName, lastName }
+    })
+    if (isSuccess) router.push('/')
+  }
+</script>
+
+<template>
+  <p v-if="needsEmailVerification">
+    Please check your mailbox and follow the verification link to verify your email.
+  </p>
+
+  <form v-else @submit="handleSubmit">
+    <input v-model="firstName" placeholder="First name" class="input" /><br />
+    <input v-model="lastName" placeholder="Last name" class="input" /><br />
+    <input v-model="email" type="email" placeholder="Email" class="input" /><br />
+    <input v-model="password" type="password" placeholder="Password" class="input" /><br />
+
+    <button class="btn-submit" type="submit">Sign up</button>
+  </form>
+</template>
+```
+
+#### 2. Sign-in
+
+Now that new users can sign up for our application, let's see how to allow
+existing users to sign in with email and password.
+
+For that, we will use the Nhost composable named `useSignInEmailPassword` inside a new
+`sign-in` page the same way we did with our `sign-up` page. Let's create a `src/pages/sign-in.vue` component:
+
+```markup title="src/pages/sign-in.vue"
+<script setup lang="ts">
+  import { ref } from 'vue'
+  import { useSignInEmailPassword } from '@nhost/vue'
+  import { useRouter } from 'vue-router'
+  const { signInEmailPassword, needsEmailVerification } = useSignInEmailPassword()
+  const router = useRouter()
+  const email = ref('')
+  const password = ref('')
+  const handleSubmit = async (event: Event) => {
+    event.preventDefault()
+    const { isSuccess } = await signInEmailPassword(email, password)
+    if (isSuccess) router.push('/')
+  }
+</script>
+
+<template>
+  <p v-if="needsEmailVerification">
+    Your email is not yet verified. Please check your mailbox and follow the verification link
+    finish registration.
+  </p>
+
+  <form v-else @submit="handleSubmit">
+    <input v-model="email" type="email" placeholder="Email" class="input" /><br />
+    <input v-model="password" type="password" placeholder="Password" class="input" /><br />
+
+    <button class="btn-submit" type="submit">Sign in</button>
+    <p>No account yet? <router-link to="/sign-up"> Sign up </router-link></p>
+  </form>
+</template>
+```
+
+#### 3. Home page
+
+Let's also add links to sign up and sign in in our index page.
+
+```markup title="src/pages/index.vue"
+<template>
+  <div>
+    <div i-carbon-home text-4xl inline-block />
+    <p>Nhost with Vue</p>
+    <p>
+      <em text-sm op75>Quickstart</em>
+    </p>
+    <div py-4 />
+    <router-link class="btn" to="/sign-up"> Sign Up </router-link><br />
+    <router-link class="btn" to="/sign-in"> Sign In </router-link>
+  </div>
+</template>
+```
+
+#### 4. Sign-out
+
+Finally, to allow the users to sign out from the app, we can use the Nhost
+`useSignOut` composable. We'll also use `useAuthenticationStatus` to show the button only when the user is authenticated:
+
+```markup title="src/components/Footer.vue"
+<script setup lang="ts">
+  import { useRouter } from 'vue-router'
+  import { useAuthenticated, useSignOut } from '@nhost/vue'
+  import { isDark, toggleDark } from '~/composables'
+  const isAuthenticated = useAuthenticated()
+  const { signOut } = useSignOut()
+  const router = useRouter()
+  const handleSignOut = () => {
+    signOut()
+    router.push('/')
+  }
+</script>
+
+<template>
+  <nav text-xl mt-6 inline-flex gap-2>
+    <button class="icon-btn !outline-none" @click="toggleDark()">
+      <div v-if="isDark" i-carbon-moon />
+      <div v-else i-carbon-sun />
+    </button>
+
+    <button v-if="isAuthenticated" class="icon-btn !outline-none" @click="handleSignOut">
+      <div i-carbon-logout />
+    </button>
+  </nav>
+</template>
+```
+
+### Protect routes
+
+Now that we have implemented authentication, we can easily decide who can access
+certain parts of our application.
+
+Let's create a profile page that will be only accessible to authenticated users. If an unauthenticated user attempts to load it, it will redirect them to the `/sign-up` page:
+
+```markup title="src/pages/profile.vue"
+<template>
+  <div>
+    <div i-carbon-home text-4xl inline-block />
+    <p>Profile page</p>
+  </div>
+</template>
+```
+
+Then, we can use a [beforeEach navigation guqes](https://router.vuejs.org/guide/advanced/navigation-guards.html#global-before-guards) in our `main.ts` file:
+
+```tsx title="src/main.ts"
+import { createApp } from 'vue'
+import { createRouter, createWebHistory } from 'vue-router'
+import routes from 'virtual:generated-pages'
+import { NhostClient } from '@nhost/vue'
+import App from './App.vue'
+
+import '@unocss/reset/tailwind.css'
+import './styles/main.css'
+import 'uno.css'
+
+const nhost = new NhostClient({
+  backendUrl: import.meta.env.VITE_NHOST_URL
+})
+
+const app = createApp(App)
+const router = createRouter({
+  history: createWebHistory(import.meta.env.BASE_URL),
+  routes
+})
+
+// highlight-start
+router.beforeEach(async (to) => {
+  if (to.path === '/profile' && !(await nhost.auth.isAuthenticatedAsync())) {
+    return '/sign-in'
+  }
+  return true
+})
+// highlight-end
+
+app.use(router).use(nhost)
+app.mount('#app')
+```
+
+Let's finally add a link to the profile page in the index page `/`:
+
+```markup title="src/pages/index.vue"
+<template>
+  <div>
+    <div i-carbon-home text-4xl inline-block />
+    <p>Nhost with Vue</p>
+    <p>
+      <em text-sm op75>Quickstart</em>
+    </p>
+    <div py-4 />
+    <!-- highlight-start -->
+    <router-link class="btn" to="/profile"> Profile </router-link><br />
+    <!-- highlight-end -->
+    <router-link class="btn" to="/sign-up"> Sign Up </router-link><br />
+    <router-link class="btn" to="/sign-in"> Sign In </router-link>
+  </div>
+</template>
+```
+
+### Retrieve user data
+
+Finally, let's display the information of the authenticated user throughout his
+dashboard to make the app more personalized.
+
+Getting the current authenticated user data is quite easy. Indeed, we
+can use the `useUserData` composable provided by Nhost to do it. When the user is authenticated, it returns the information fetched from the `users` table, such as the display name, the email, or the user's roles. This composable returns `null` until the user is effectively authenticated.
+
+Let's update the profile page to use it:
+
+```markup title="src/pages/profile.vue"
+<!-- highlight-start -->
+<script setup lang="ts">
+  import { useUserData } from '@nhost/vue'
+  const user = useUserData()
+</script>
+<!-- highlight-end -->
+<template>
+  <div>
+    <div i-carbon-home text-4xl inline-block />
+    <p>Profile page</p>
+    <p>
+      <em text-sm op75>Quickstart</em>
+    </p>
+    <!-- highlight-start -->
+    <div v-if="user" py-4>
+      <p>Hello, {{ user?.displayName }}. Your email is {{ user?.email }}.</p>
+      <!-- highlight-end -->
+    </div>
+  </div>
+</template>
+```
+
+### Update user data
+
+Nhost provides a GraphQL API through Hasura so that we can query and mutate our
+data instantly.
+
+In this tutorial, we'll use [Vue Apollo v4](https://v4.apollo.vuejs.org) for interacting with
+this GraphQL API. Nhost comes with a custom Apollo client that syncs the Apollo client with the authentication status of your users.
+
+So, start by installing the following dependencies:
+
+<Tabs groupId="package-manager">
+  <TabItem value="npm" label="npm" default>
+
+```bash
+npm install @nhost/apollo @apollo/client graphql graphql-tag @vue/apollo-composable
+```
+
+  </TabItem>
+  <TabItem value="yarn" label="Yarn">
+
+```bash
+yarn add @nhost/apollo @apollo/client graphql graphql-tag @vue/apollo-composable
+```
+
+  </TabItem>
+  <TabItem value="pnpm" label="pnpm">
+
+```bash
+pnpm add @nhost/apollo @apollo/client graphql graphql-tag @vue/apollo-composable
+```
+
+  </TabItem>
+</Tabs>
+
+Then, create the Apollo client in your `src/main.ts` file, and provide it to your Vue app:
+
+```tsx title="src/main.ts"
+import { createApp } from 'vue'
+import { createRouter, createWebHistory } from 'vue-router'
+import routes from 'virtual:generated-pages'
+import { NhostClient } from '@nhost/vue'
+// highlight-start
+import { createApolloClient } from '@nhost/apollo'
+import { DefaultApolloClient } from '@vue/apollo-composable'
+// highlight-end
+import App from './App.vue'
+
+import '@unocss/reset/tailwind.css'
+import './styles/main.css'
+import 'uno.css'
+
+const nhost = new NhostClient({
+  backendUrl: import.meta.env.VITE_NHOST_URL
+})
+
+const app = createApp(App)
+const router = createRouter({
+  history: createWebHistory(import.meta.env.BASE_URL),
+  routes
+})
+
+router.beforeEach(async (to) => {
+  if (to.path === '/profile' && !(await nhost.auth.isAuthenticatedAsync())) {
+    return '/sign-in'
+  }
+  return true
+})
+
+// highlight-start
+const apolloClient = createApolloClient({ nhost })
+// highlight-end
+
+app
+  .use(router)
+  .use(nhost)
+  // highlight-start
+  .provide(DefaultApolloClient, apolloClient)
+  // highlight-end
+  .mount('#app')
+```
+
+From there, we can construct our GraphQL query and use the Apollo `useMutation`
+composable to execute that query when the user submits the form from the profile page:
+
+```markup title="src/pages/profile.vue"
+<script setup lang="ts">
+  import { gql } from '@apollo/client/core'
+  import { useNhostClient, useUserData } from '@nhost/vue'
+  import { useMutation } from '@vue/apollo-composable'
+  import { ref } from 'vue'
+  const user = useUserData()
+  const { nhost } = useNhostClient()
+  const UPDATE_USER_MUTATION = gql`
+    mutation ($id: uuid!, $displayName: String!, $metadata: jsonb) {
+      updateUser(
+        pk_columns: { id: $id }
+        _set: { displayName: $displayName, metadata: $metadata }
+      ) {
+        id
+        displayName
+        metadata
+      }
+    }
+  `
+  const firstName = ref('')
+  const lastName = ref('')
+  const { mutate, loading, error } = useMutation(UPDATE_USER_MUTATION)
+
+  const updateUserProfile = async (event: Event) => {
+    event.preventDefault()
+    if (user.value) {
+      await mutate({
+        id: user.value.id,
+        displayName: `${firstName.value} ${lastName.value}`.trim(),
+        metadata: {
+          firstName: firstName.value,
+          lastName: lastName.value
+        }
+      })
+      await client.auth.refreshSession()
+    }
+  }
+</script>
+
+<template>
+  <div>
+    <div i-carbon-home text-4xl inline-block />
+    <p>Profile page</p>
+    <p>
+      <em text-sm op75>Quickstart</em>
+    </p>
+    <div v-if="user" py-4>
+      <p>Hello, {{ user?.displayName }}. Your email is {{ user?.email }}.</p>
+      <form @submit="updateUserProfile">
+        <input v-model="firstName" placeholder="First name" class="input" /><br />
+        <input v-model="lastName" placeholder="Last name" class="input" /><br />
+        <button className="m-3 text-sm btn" :disabled="loading">Save</button>
+        <div v-if="error">{{ error.message }}</div>
+      </form>
+    </div>
+  </div>
+</template>
+```
+
+:::tip
+You probably have noticed that we are calling `client.auth.refreshSession()` after we updated the user using the GraphQL mutation. The Nhost client only extracts user information from the access token (JWT), that is kept in memory and refreshed every 15 minutes. As user information has been updated, we force an access token refresh so it is kept up to date.
+:::
+
+Finally, since Hasura has an **allow nothing by default** policy, and we haven't
+set any permissions yet, our GraphQL mutations would fail.
+
+So, open the Hasura console from the **Data** tab of your project from [your Nhost dashboard](https://app.nhost.io/). Then, go to the **permissions** tab of the `users` table, type in `user` in the role cell, and click the edit icon on the `select` operation:
+
+![Hasura users permissions](/img/quickstarts/hasura-permissions-1.png)
+
+To restrict the user to read his own data only, specify a condition with the user's ID and the `X-Hasura-User-ID` session variable, which is passed with each requests.
+
+![Hasura users permissions](/img/quickstarts/hasura-permissions-2.png)
+
+Next, select the columns you'd like the users to have access to, and click
+**Save Permissions**.
+
+![Hasura users permissions](/img/quickstarts/hasura-permissions-3.png)
+
+Repeat the same steps on the `update` operation for the `user` role to allow
+users to update their `displayName` and `metadata` only.
+
+Finally, to add real-time caching, synchronizing, and updating server state in your Vue app, let's refactor the user data fetching using the Apollo client and our GraphQL API instead.
+
+First add the following GraphQL subscription to retrieve the current user data component:
+
+```ts title="src/pages/profile.vue"
+import { gql } from '@apollo/client/core'
+
+const GET_USER_SUBSCRIPTION = gql`
+  subscription GetUser($id: uuid!) {
+    user(id: $id) {
+      id
+      email
+      displayName
+      metadata
+      avatarUrl
+    }
+  }
+`
+```
+
+Then, replace the `useUserData` composable with the `useUserId` composable to retrieve the current user's ID.
+
+```ts title="src/pages/profile.vue"
+import { useUserId } from '@nhost/vue'
+
+const id = useUserId()
+```
+
+Finally, we can run our GraphQL subscription using the `useSubscription` composable and the current user's ID. Here is the full `profile.vue` page:
+
+```markup title="src/pages/profile.vue"
+<script setup lang="ts">
+  import { gql } from '@apollo/client/core'
+  import { useNhostClient, useUserId } from '@nhost/vue'
+  import { useMutation, useSubscription } from '@vue/apollo-composable'
+  import { computed, ref } from 'vue'
+
+  const { nhost } = useNhostClient()
+  const GET_USER_SUBSCRIPTION = gql`
+    subscription GetUser($id: uuid!) {
+      user(id: $id) {
+        id
+        email
+        displayName
+        metadata
+        avatarUrl
+      }
+    }
+  `
+  const id = useUserId()
+
+  const { result } = useSubscription(
+    GET_USER_SUBSCRIPTION,
+    computed(() => ({ id: id.value }))
+  )
+  const user = computed(() => result.value?.user)
+
+  const UPDATE_USER_MUTATION = gql`
+    mutation ($id: uuid!, $displayName: String!, $metadata: jsonb) {
+      updateUser(
+        pk_columns: { id: $id }
+        _set: { displayName: $displayName, metadata: $metadata }
+      ) {
+        id
+        displayName
+        metadata
+      }
+    }
+  `
+  const firstName = ref('')
+  const lastName = ref('')
+  const { mutate, loading, error } = useMutation(UPDATE_USER_MUTATION)
+
+  const updateUserProfile = async (event: Event) => {
+    event.preventDefault()
+    if (user.value) {
+      await mutate({
+        id: user.value.id,
+        displayName: `${firstName.value} ${lastName.value}`.trim(),
+        metadata: {
+          firstName: firstName.value,
+          lastName: lastName.value
+        }
+      })
+      await nhost.auth.refreshSession()
+    }
+  }
+</script>
+
+<template>
+  <div>
+    <div i-carbon-home text-4xl inline-block />
+    <p>Profile page</p>
+    <p>
+      <em text-sm op75>Quickstart</em>
+    </p>
+    <div v-if="user" py-4>
+      <p>Hello, {{ user.displayName }}. Your email is {{ user.email }}.</p>
+      <form @submit="updateUserProfile">
+        <input v-model="firstName" placeholder="First name" class="input" /><br />
+        <input v-model="lastName" placeholder="Last name" class="input" /><br />
+        <button className="m-3 text-sm btn" :disabled="loading">Save</button>
+        <div v-if="error">{{ error.message }}</div>
+      </form>
+    </div>
+  </div>
+</template>
+```
+
+You now have a fully functional Vue application. Congratulations!
+
+## Next Steps
+
+- Did you enjoy Nhost? Give us a star ⭐ on [Github](https://github.com/nhost/nhost). Thank you!
+- Check out our more in-depth [examples](https://github.com/nhost/nhost/tree/main/examples).
+- Build your next app with [Nhost](https://app.nhost.io/)!

docs/docs/platform/serverless-functions.mdx

@@ -0,0 +1,105 @@
+---
+title: 'Serverless Functions'
+sidebar_position: 8
+---
+
+import Tabs from '@theme/Tabs'
+import TabItem from '@theme/TabItem'
+
+With Nhost, you can deploy Serverless Functions to execute custom code. Each serverless function is its HTTP endpoint.
+
+Serverless functions can be used to handle [event triggers](/platform/database/event-triggers), form submission, integrations (e.g. Stripe, Slack, etc), and more.
+
+---
+
+## Creating a Serverless Function
+
+Every `.js` (JavaScript) and `.ts` (TypeScript) file in the `functions/` folder of your Nhost app is its own serverless function.
+
+<Tabs groupId="language">
+  <TabItem value="ts" label="TypeScript" default>
+
+```ts title=functions/test.ts
+import { Request, Response } from 'express'
+
+export default (req: Request, res: Response) => {
+  res.status(200).send(`Hello ${req.query.name}!`)
+}
+```
+
+:::info
+
+You **MUST** install `express` locally in the base directory of your Nhost app.
+
+```bash
+npm install -d express @types/express
+# or yarn
+yarn add -d express @types/express
+```
+
+:::
+
+  </TabItem>
+  <TabItem value="js" label="JavaScript">
+
+```js title=functions/test.js
+export default (req, res) => {
+  res.status(200).send(`Hello ${req.query.name}!`)
+}
+```
+
+:::info
+
+You **MUST** install `express` locally in the base directory of your Nhost app.
+
+```bash
+npm install -d express
+# or yarn
+yarn add -d express
+```
+
+:::
+
+  </TabItem>
+</Tabs>
+
+## Deploying Serverless Functions
+
+Serverless functions are automatically deployed using Nhost's [GitHub integration](/platform/github-integration).
+
+You can prepend files and folders with an underscore (`_`) to prevent them from being treated as serverless functions and be turned into HTTP endpoints. This is useful if you have, for example, a utils file (`functions/_utils.js`) or a utils folder (`functions/_utils/[multiple-files].js`).
+
+## Routing
+
+HTTP endpoints are automatically generated based on the file structure inside `functions/`.
+
+Here's an example of four serverless functions with their files and their HTTP endpoints:
+
+| File                        | HTTP Endpoint                                                 |
+| --------------------------- | ------------------------------------------------------------- |
+| `functions/index.js`        | `https://[app-subdomain].nhost.run/v1/functions/`             |
+| `functions/users/index.ts`  | `https://[app-subdomain].nhost.run/v1/functions/users`        |
+| `functions/users/active.ts` | `https://[app-subdomain].nhost.run/v1/functions/users/active` |
+| `functions/my-copmany.js`   | `https://[app-subdomain].nhost.run/v1/functions/my-company`   |
+
+---
+
+## Environment Variables
+
+[Environment variables](/platform/environment-variables) are available inside your serverless functions. Both in production and when running Nhost locally using the [Nhost CLI](/platform/cli).
+
+## Billing
+
+Serverless functions are billed per GB-sec or GB-hour. 1 GB-hour is 3600 GB-seconds.
+
+1 GB-sec is 1 function with 1 GB of RAM running for 1 second. If 1 function with 1 GB of RAM runs for 3600 seconds, that's the equivalent of 1 GB-hour.
+
+All serverless functions in production are running with 128 MB of RAM.
+
+## Node Version
+
+All serverless functions in production are running Node.js version 14.x.
+
+## Regions
+
+Serverless Functions are always deployed to the same region as your app.

docs/docs/platform/serverless-functions/_category_.json

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

docs/docs/platform/serverless-functions/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/serverless-functions/index.md

@@ -1,62 +0,0 @@
----
-title: 'Serverless Functions'
-sidebar_position: 1
----
-
-Nhost gives you the option to run serverless functions on the following runtimes:
-
-- `Node.js 14` (Both JavaScript and Typescript)
-
----
-
-## Creating functions
-
-Every `.js` and `.ts` file in the `functions/` folder of your Nhost app will be exposed as an HTTP endpoint. You have to
-
-```js
-// In functions/hello/[name].js
-export default (req, res) => {
-  res.status(200).send(`Hello ${req.query.name}!`);
-};
-```
-
-Or, if you prefer TypeScript:
-
-```ts
-// In functions/hello/[name].ts
-import { Request, Response } from 'express';
-
-export default (req: Request, res: Response) => {
-  res.status(200).send(`Hello ${req.query.name}!`);
-};
-```
-
----
-
-## Routing
-
-HTTP endpoints are automatically generated based on the file structure under `functions/`.
-
-As such, given this file structure:
-
-```text
-functions/index.js
-functions/users/index.ts
-functions/active.ts
-functions/my-company.js
-```
-
-The following endpoints will be available:
-
-- https://yourappid.nhost.run/v1/functions/ from `functions/index.js`.
-- https://yourappid.nhost.run/v1/functions/users from `functions/users/index.ts`.
-- https://yourappid.nhost.run/v1/functions/users/active from `functions/users/active.ts`.
-- https://yourappid.nhost.run/v1/functions/my-company from `functions/my-company.js`.
-
-If you've used Netlify or Vercel, this routing logic will be familiar to you.
-
----
-
-## Infrastructure
-
-Serverless Functions are deployed to AWS Lambda in the same region as your app.

docs/docs/platform/storage.md

@@ -1,5 +1,6 @@
 ---
 title: 'Storage'
+sidebar_position: 7
 ---
 
 Nhost stores and serves files of any type in your backend.

docs/docs/platform/storage/_category_.json

@@ -1,4 +0,0 @@
-{
-  "label": "Storage",
-  "position": 7
-}

docs/docs/reference/cli/_category_.json

@@ -1,5 +0,0 @@
-{
-  "label": "CLI",
-  "position": 4,
-  "link": { "type": "generated-index", "slug": "/reference/cli" }
-}

docs/docs/reference/cli/down.mdx

@@ -0,0 +1,16 @@
+---
+title: 'down'
+sidebar_position: 3
+---
+
+Delete all containers created by `nhost up`
+
+```bash
+nhost down
+```
+
+To delete all containers **and the local database**, append `--data` to the command.
+
+```bash
+nhost down --data
+```

docs/docs/reference/cli/global-flags.mdx

@@ -0,0 +1,22 @@
+---
+title: 'Global Flags'
+sidebar_position: 9
+---
+
+### `--debug`, `-d`
+
+Turn on debug output.
+
+```bash
+nhost up --debug
+nhost init -d
+```
+
+### `--log-file`, `-f`
+
+Save output to a given file.
+
+```bash
+nhost up -d --log-file some-file.txt
+nhost logs -f some-file.txt
+```

docs/docs/reference/cli/index.mdx

@@ -0,0 +1,6 @@
+---
+title: 'CLI'
+sidebar_position: 1
+---
+
+This section is a reference for the commands available in the [Nhost CLI](/platform/cli).

docs/docs/reference/cli/init.mdx

@@ -0,0 +1,18 @@
+---
+title: 'init'
+sidebar_position: 1
+---
+
+Intialize a local Nhost app in the current working directory.
+
+```
+nhost init
+```
+
+If you already have a Nhost app in Nhost Cloud you can use that app as a starting point by appending `--remote` to the command.
+
+This will pull the database migrations and Hasura metadata from the Nhost Cloud app locally for you to use as a starting point.
+
+```
+nhost init --remote
+```

docs/docs/reference/cli/link.mdx

@@ -0,0 +1,10 @@
+---
+title: 'link'
+sidebar_position: 4
+---
+
+Link the local Nhost app in your working directory to an app in Nhost Cloud.
+
+```bash
+nhost link
+```

docs/docs/reference/cli/list.mdx

@@ -0,0 +1,10 @@
+---
+title: 'list'
+sidebar_position: 7
+---
+
+List all your Nhost apps in Nhost Cloud.
+
+```bash
+nhost list
+```

docs/docs/reference/cli/login.mdx

@@ -0,0 +1,10 @@
+---
+title: 'login'
+sidebar_position: 5
+---
+
+Authenticate the CLI with your Nhost user.
+
+```bash
+nhost login
+```

docs/docs/reference/cli/logout.mdx

@@ -0,0 +1,10 @@
+---
+title: 'logout'
+sidebar_position: 6
+---
+
+Remove authentication for the CLI.
+
+```bash
+nhost logout
+```

docs/docs/reference/cli/logs.mdx

@@ -0,0 +1,10 @@
+---
+title: 'logs'
+sidebar_position: 9
+---
+
+Output logs of any service container
+
+```bash
+nhost logs
+```

docs/docs/reference/cli/nhost-cli.md

@@ -1,97 +0,0 @@
----
-title: 'Nhost CLI'
----
-
-Run `nhost help` in your terminal to get a detailed listing of all available commands.
-
----
-
-## `nhost`
-
-Run the Nhost development environment. If the current directory has not been initialized as an Nhost app, `nhost` will run you through the initialization.
-
-```bash
-nhost
-```
-
-### Frontend templates
-
-The `nhost` command will offer you the option of cloning frontend templates for framework of your choice (Nuxt, Next.js, React).
-
-The frontend template will be cloned in the `web/` directory of your app root. It will have the Nhost SDK preinstalled and configured.
-
----
-
-## `nhost dev`
-
-Launch the development environment for your app.
-
-```bash
-nhost dev
-```
-
-To trace all output and debug issues, run `nhost dev --debug`.
-
-```bash
-nhost dev --debug
-```
-
----
-
-## `nhost init`
-
-Intialize a blank local app in current working directory:
-
-```bash
-nhost init
-```
-
-Or clone an existing app from [nhost.io](https://nhost.io):
-
-```bash
-nhost init --remote
-```
-
----
-
-## `nhost link`
-
-Link the local Nhost app in your working directory to [nhost.io](https://nhost.io).
-
-```bash
-nhost link
-```
-
----
-
-## `nhost logs`
-
-Check real-time logs of any service container
-
-You can run this command in parallel, while your local environment is already running. Use `-f` to save output to a file.
-
-```bash
-nhost logs
-```
-
----
-
-## Global flags
-
-Turn on debug output.
-
-#### `--debug`, `-d`
-
-```bash
-nhost dev --debug
-nhost init -d
-```
-
-#### `--log-file`, `-f`
-
-Save output to a given file.
-
-```bash
-nhost dev -d --log-file some-file.txt
-nhost logs -f some-file.txt
-```

docs/docs/reference/cli/up.mdx

@@ -0,0 +1,14 @@
+---
+title: 'up'
+sidebar_position: 2
+---
+
+Launch the development environment for your app. Once the environment is up, the command will:
+
+- Apply database migrations.
+- Apply the Hasura metadata.
+- Apply seed data.
+
+```bash
+nhost up
+```

docs/docs/reference/cli/upgrade.mdx

@@ -0,0 +1,10 @@
+---
+title: 'upgrade'
+sidebar_position: 8
+---
+
+Upgrade the CLI to the latest version.
+
+```bash
+nhost upgrade
+```

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

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

@@ -3,18 +3,19 @@
 title: signIn()
 sidebar_label: signIn()
 slug: /reference/javascript/auth/sign-in
-description: Use `signIn` to sign in users using email and password, passwordless (email or sms) or an external provider. `signIn` can be used 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#L166
+description: Use `nhost.auth.signIn` to sign in a user using email and password, passwordless (email or sms) or an external provider. `signIn` can be used to sign in a user in various ways depending on the parameters.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L144
 ---
 
 # `signIn()`
 
-Use `signIn` to sign in users using email and password, passwordless
-(email or sms) or an external provider.
-`signIn` can be used in various ways depending on the parameters.
+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.
 
 ```ts
-signIn({ email, password })
+nhost.auth.signIn({
+  email: 'joe@example.com',
+  password: 'secret-password'
+})
 ```
 
 ## Parameters
@@ -27,28 +28,33 @@ signIn({ email, password })
 
 ## Examples
 
-### Sign in with email and password
+### Sign in a user using email and password
 
 ```ts
-signIn({ email, password })
+nhost.auth.signIn({
+  email: 'joe@example.com',
+  password: 'secret-password'
+})
 ```
 
-### Sign in with an external provider (e.g: Google or Facebook)
+### Sign in a user using an OAuth provider (e.g: Google or Facebook)
 
 ```ts
-signIn({ provider })
+nhost.auth.signIn({ provider: 'google' })
 ```
 
-### Passwordless sign in with email (magic link)
+### Sign in a user using passwordless email (Magic Link)
 
 ```ts
-signIn({ email }) // [step 1/2] Passwordless sign in with Email (Magic Link)
-signIn({ email, otp }) // [step 2/2] Finish passwordless sign in with email (OTP)
+nhost.auth.signIn({ email: 'joe@example.com' })
 ```
 
-### Passwordless sign in with SMS
+### Sign in a user using passwordless SMS
 
 ```ts
-signIn({ phoneNumber }) // [step 1/2] Passwordless sign in with SMS
-signIn({ phoneNumber, otp }) // [step 2/2] Finish passwordless sign in with SMS (OTP)
+// [step 1/2] Passwordless sign in using SMS
+nhost.auth.signIn({ phoneNumber: '001122334455' })
+
+// [step 2/2] Finish passwordless sign in using SMS (OTP)
+nhost.auth.signIn({ phoneNumber: '001122334455', otp: '123456' })
 ```

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

@@ -3,16 +3,16 @@
 title: signOut()
 sidebar_label: signOut()
 slug: /reference/javascript/auth/sign-out
-description: Use `signOut` to sign out a user
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L315
+description: Use `nhost.auth.signOut` to sign out the user.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L256
 ---
 
 # `signOut()`
 
-Use `signOut` to sign out a user
+Use `nhost.auth.signOut` to sign out the user.
 
 ```ts
-signOut()
+nhost.auth.signOut()
 ```
 
 ## Parameters
@@ -22,3 +22,17 @@ signOut()
 **<span className="parameter-name">params</span>** <span className="optional-status">optional</span> `{ all: boolean }`
 
 ---
+
+## Examples
+
+### Sign out the user from current device
+
+```ts
+nhost.auth.signOut()
+```
+
+### Sign out the user from all decvices
+
+```ts
+nhost.auth.signOut({ all: true })
+```

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

@@ -3,16 +3,16 @@
 title: resetPassword()
 sidebar_label: resetPassword()
 slug: /reference/javascript/auth/reset-password
-description: Use `resetPassword` to reset a user's password.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L342
+description: Use `nhost.auth.resetPassword` to reset the password for a user. This will send a reset-password link in an email to the user. When the user clicks the reset-password link the user is automatically signed-in. Once signed-in, the user can change their password using `nhost.auth.changePassword()`.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L272
 ---
 
 # `resetPassword()`
 
-Use `resetPassword` to reset a user's password.
+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()`.
 
 ```ts
-auth.resetPassword({ email })
+nhost.auth.resetPassword({ email: 'joe@example.com' })
 ```
 
 ## Parameters

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

@@ -3,26 +3,26 @@
 title: changePassword()
 sidebar_label: changePassword()
 slug: /reference/javascript/auth/change-password
-description: Use `changePassword` to change a user's password.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L367
+description: Use `nhost.auth.changePassword` to change the password for the user. The old password is not needed.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L288
 ---
 
 # `changePassword()`
 
-Use `changePassword` to change a user's password.
+Use `nhost.auth.changePassword` to change the password for the user. The old password is not needed.
 
 ```ts
-auth.changePassword({ newPassword })
+nhost.auth.changePassword({ newPassword: 'new-secret-password' })
 ```
 
 ## Parameters
 
 ---
 
-**<span className="parameter-name">params</span>** <span className="optional-status">required</span> [`ChangePasswordParams`](/reference/docgen/javascript/auth/types/change-password-params)
+**<span className="parameter-name">\_\_namedParameters</span>** <span className="optional-status">required</span> [`ChangePasswordParams`](/reference/docgen/javascript/auth/types/change-password-params)
 
-| Property                                                                                       | Type     | Required | Notes |
-| :--------------------------------------------------------------------------------------------- | :------- | :------: | :---- |
-| <span className="parameter-name"><span className="light-grey">params.</span>newPassword</span> | `string` |    ✔️    |       |
+| Property                                                                                                    | Type     | Required | Notes |
+| :---------------------------------------------------------------------------------------------------------- | :------- | :------: | :---- |
+| <span className="parameter-name"><span className="light-grey">\_\_namedParameters.</span>newPassword</span> | `string` |    ✔️    |       |
 
 ---

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

@@ -3,28 +3,27 @@
 title: sendVerificationEmail()
 sidebar_label: sendVerificationEmail()
 slug: /reference/javascript/auth/send-verification-email
-description: Use `sendVerificationEmail` to send a verification email to the specified email.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L393
+description: Use `nhost.auth.sendVerificationEmail` to send a verification email to the specified email. The email contains a verification-email link. When the user clicks the verification-email link their email is verified.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L304
 ---
 
 # `sendVerificationEmail()`
 
-Use `sendVerificationEmail` to send a verification email
-to the specified email.
+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.
 
 ```ts
-auth.sendVerificationEmail({ email })
+nhost.auth.sendVerificationEmail({ email: 'joe@example.com' })
 ```
 
 ## Parameters
 
 ---
 
-**<span className="parameter-name">params</span>** <span className="optional-status">required</span> [`SendVerificationEmailParams`](/reference/docgen/javascript/auth/types/send-verification-email-params)
+**<span className="parameter-name">\_\_namedParameters</span>** <span className="optional-status">required</span> [`SendVerificationEmailParams`](/reference/docgen/javascript/auth/types/send-verification-email-params)
 
-| Property                                                                                   | Type             | Required | Notes |
-| :----------------------------------------------------------------------------------------- | :--------------- | :------: | :---- |
-| <span className="parameter-name"><span className="light-grey">params.</span>email</span>   | `string`         |    ✔️    |       |
-| <span className="parameter-name"><span className="light-grey">params.</span>options</span> | `RedirectOption` |          |       |
+| Property                                                                                                | Type             | Required | Notes |
+| :------------------------------------------------------------------------------------------------------ | :--------------- | :------: | :---- |
+| <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> | `RedirectOption` |          |       |
 
 ---

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

@@ -3,16 +3,16 @@
 title: changeEmail()
 sidebar_label: changeEmail()
 slug: /reference/javascript/auth/change-email
-description: Use `changeEmail` to change a user's email
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L420
+description: Use `nhost.auth.changeEmail` to change a user's email. This will send a confirm-email-change link in an email to the new email. Once the user clicks on the confirm-email-change link the email will be change to the new email.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L323
 ---
 
 # `changeEmail()`
 
-Use `changeEmail` to change a user's email
+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.
 
 ```ts
-auth.changeEmail({ newEmail })
+nhost.auth.changeEmail({ newEmail: 'doe@example.com' })
 ```
 
 ## Parameters

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

@@ -3,16 +3,19 @@
 title: deanonymize()
 sidebar_label: deanonymize()
 slug: /reference/javascript/auth/deanonymize
-description: Use `deanonymize` to deanonymize a user
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L445
+description: Use `nhost.auth.deanonymize` to deanonymize a user.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L339
 ---
 
 # `deanonymize()`
 
-Use `deanonymize` to deanonymize a user
+Use `nhost.auth.deanonymize` to deanonymize a user.
 
 ```ts
-auth.deanonymize({ signInMethod: 'email-password', email })
+nhost.auth.deanonymize({
+  signInMethod: 'email-password',
+  email: 'joe@example.com'
+})
 ```
 
 ## Parameters

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

@@ -3,17 +3,18 @@
 title: onTokenChanged()
 sidebar_label: onTokenChanged()
 slug: /reference/javascript/auth/on-token-changed
-description: Use `onTokenChanged` to add a custom function that will trigger whenever the access and refresh token is changed.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L479
+description: Use `nhost.auth.onTokenChanged` to add a custom function that runs every time the access or refresh token is changed.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L373
 ---
 
 # `onTokenChanged()`
 
-Use `onTokenChanged` to add a custom function that will trigger whenever
-the access and refresh token is changed.
+Use `nhost.auth.onTokenChanged` to add a custom function that runs every time the access or refresh token is changed.
 
 ```ts
-auth.onTokenChanged(() => console.log('access token changed'))
+nhost.auth.onTokenChanged(() =>
+  console.log('The access and refresh token has changed')
+)
 ```
 
 ## Parameters

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

@@ -3,20 +3,18 @@
 title: onAuthStateChanged()
 sidebar_label: onAuthStateChanged()
 slug: /reference/javascript/auth/on-auth-state-changed
-description: Use `onAuthStateChanged` to add a custom function that will trigger whenever the state of the user changed. Ex from signed in to signed out or vice versa.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L516
+description: Use `nhost.auth.onAuthStateChanged` to add a custom function that runs every time the authentication status of the user changes. E.g. add a custom function that runs every time the authentication status changes from signed-in to signed-out.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L408
 ---
 
 # `onAuthStateChanged()`
 
-Use `onAuthStateChanged` to add a custom function that will trigger
-whenever the state of the user changed. Ex from signed in to signed out or
-vice versa.
+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.
 
 ```ts
-auth.onAuthStateChanged((event, session) => {
+nhost.auth.onAuthStateChanged((event, session) => {
   console.log(
-    `Auth state changed. State is now ${event} with session: ${session}`
+    `The auth state has changed. State is now ${event} with session: ${session}`
   )
 })
 ```

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

@@ -3,18 +3,25 @@
 title: isAuthenticated()
 sidebar_label: isAuthenticated()
 slug: /reference/javascript/auth/is-authenticated
-description: Use `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#L556
+description: Use `nhost.auth.isAuthenticated` to check if the user is authenticated or not.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L450
 ---
 
 # `isAuthenticated()`
 
-Use `isAuthenticated` to check if the user is authenticated or not.
+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  = auth.isAuthenticated();
+const isAuthenticated = nhost.auth.isAuthenticated()
 
-if (authenticated) {
-  console.log('User is authenticated');
+if (isAuthenticated) {
+  console.log('User is authenticated')
 }
 ```

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

@@ -3,18 +3,18 @@
 title: isAuthenticatedAsync()
 sidebar_label: isAuthenticatedAsync()
 slug: /reference/javascript/auth/is-authenticated-async
-description: Use `isAuthenticatedAsync` to wait and 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#L574
+description: Use `nhost.auth.isAuthenticatedAsync` to wait (await) for any internal authentication network requests to finish and then return the authentication status.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L468
 ---
 
 # `isAuthenticatedAsync()`
 
-Use `isAuthenticatedAsync` to wait and check if the user is authenticated or not.
+Use `nhost.auth.isAuthenticatedAsync` to wait (await) for any internal authentication network requests to finish and then return the authentication status.
 
 ```ts
-const isAuthenticated  = awiat auth.isAuthenticatedAsync();
+const isAuthenticated = await nhost.auth.isAuthenticatedAsync()
 
 if (isAuthenticated) {
-  console.log('User is authenticated');
+  console.log('User is authenticated')
 }
 ```

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

@@ -3,16 +3,19 @@
 title: getAuthenticationStatus()
 sidebar_label: getAuthenticationStatus()
 slug: /reference/javascript/auth/get-authentication-status
-description: Use `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#L601
+description: Use `nhost.auth.getAuthenticationStatus` to get the authentication status of the user.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L494
 ---
 
 # `getAuthenticationStatus()`
 
-Use `getAuthenticationStatus` to get the authentication status of the user.
+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 } = auth.getAuthenticationStatus()
+const { isAuthenticated, isLoading } = nhost.auth.getAuthenticationStatus()
 
 if (isLoading) {
   console.log('Loading...')

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

@@ -3,14 +3,14 @@
 title: getAccessToken()
 sidebar_label: getAccessToken()
 slug: /reference/javascript/auth/get-access-token
-description: Use `getAccessToken` to get the logged in user's access token.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L629
+description: Use `nhost.auth.getAccessToken` to get the access token of the user.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L524
 ---
 
 # `getAccessToken()`
 
-Use `getAccessToken` to get the logged in user's access token.
+Use `nhost.auth.getAccessToken` to get the access token of the user.
 
 ```ts
-const accessToken = auth.getAccessToken()
+const accessToken = nhost.auth.getAccessToken()
 ```

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

@@ -1,15 +0,0 @@
----
-# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
-title: getJWTToken()
-sidebar_label: getJWTToken()
-slug: /reference/javascript/auth/get-jwt-token
-sidebar_class_name: deprecated
-description: No description provided.
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L615
----
-
-# `getJWTToken()`
-
-:::caution Deprecated
-Use `getAccessToken()` instead.
-:::

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

@@ -3,14 +3,18 @@
 title: getDecodedAccessToken()
 sidebar_label: getDecodedAccessToken()
 slug: /reference/javascript/auth/get-decoded-access-token
-description: Decode the current decoded access token (JWT), or return `null` if the user is not authenticated (no token)
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L637
+description: Use `nhost.auth.getDecodedAccessToken` to get the decoded access token of the user.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L539
 ---
 
 # `getDecodedAccessToken()`
 
-Decode the current decoded access token (JWT), or return `null` if the user is not authenticated (no token)
+Use `nhost.auth.getDecodedAccessToken` to get the decoded access token of the user.
 
 **`@see`**
 
-{@link https://hasura.io/docs/latest/graphql/core/auth/authentication/jwt/|Hasura documentation}
+{@link https://hasura.io/docs/latest/graphql/core/auth/authentication/jwt/| Hasura documentation}
+
+```ts
+const decodedAccessToken = nhost.auth.getDecodedAccessToken()
+```

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

@@ -0,0 +1,20 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: getHasuraClaims()
+sidebar_label: getHasuraClaims()
+slug: /reference/javascript/auth/get-hasura-claims
+description: Use `nhost.auth.getHasuraClaims` to get the Hasura claims of the user.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L556
+---
+
+# `getHasuraClaims()`
+
+Use `nhost.auth.getHasuraClaims` to get the Hasura claims of the user.
+
+**`@see`**
+
+{@link https://hasura.io/docs/latest/graphql/core/auth/authentication/jwt/| Hasura documentation}
+
+```ts
+const hasuraClaims = nhost.auth.getHasuraClaims()
+```

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

@@ -0,0 +1,31 @@
+---
+# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
+title: getHasuraClaim()
+sidebar_label: getHasuraClaim()
+slug: /reference/javascript/auth/get-hasura-claim
+description: Use `nhost.auth.getHasuraClaim` to get the value of a specific Hasura claim of the user.
+custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L574
+---
+
+# `getHasuraClaim()`
+
+Use `nhost.auth.getHasuraClaim` to get the value of a specific Hasura claim of the user.
+
+**`@see`**
+
+{@link https://hasura.io/docs/latest/graphql/core/auth/authentication/jwt/| Hasura documentation}
+
+```ts
+// if `x-hasura-company-id` exists as a custom claim
+const companyId = nhost.auth.getHsauraClaim('company-id')
+```
+
+## Parameters
+
+---
+
+**<span className="parameter-name">name</span>** <span className="optional-status">required</span> `string`
+
+Name of the variable. You don't have to specify `x-hasura-`.
+
+---

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

@@ -1,16 +0,0 @@
----
-# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
-title: getHasuraClaims()
-sidebar_label: getHasuraClaims()
-slug: /reference/javascript/auth/get-hasura-claims
-description: Decode the Hasura claims from the current access token (JWT) located in the `https://hasura.io/jwt/claims` namespace, or return `null` if the user is not authenticated (no token)
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L647
----
-
-# `getHasuraClaims()`
-
-Decode the Hasura claims from the current access token (JWT) located in the `https://hasura.io/jwt/claims` namespace, or return `null` if the user is not authenticated (no token)
-
-**`@see`**
-
-{@link https://hasura.io/docs/latest/graphql/core/auth/authentication/jwt/|Hasura documentation}

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

@@ -1,27 +0,0 @@
----
-# ⚠️ AUTO-GENERATED CONTENT. DO NOT EDIT THIS FILE DIRECTLY! ⚠️
-title: getHasuraClaim()
-sidebar_label: getHasuraClaim()
-slug: /reference/javascript/auth/get-hasura-claim
-description: Get the value of a given Hasura claim in the current access token (JWT). Returns null if the user is not authenticated, or if the claim is not in the token. Return `null` if the user is not authenticated (no token)
-custom_edit_url: https://github.com/nhost/nhost/edit/main/packages/hasura-auth-js/src/hasura-auth-client.ts#L657
----
-
-# `getHasuraClaim()`
-
-Get the value of a given Hasura claim in the current access token (JWT). Returns null if the user is not authenticated, or if the claim is not in the token.
-Return `null` if the user is not authenticated (no token)
-
-**`@see`**
-
-{@link https://hasura.io/docs/latest/graphql/core/auth/authentication/jwt/|Hasura documentation}
-
-## Parameters
-
----
-
-**<span className="parameter-name">name</span>** <span className="optional-status">required</span> `string`
-
-name of the variable. Automatically adds the `x-hasura-` prefix if it is missing
-
----