Compare commits

..

39 Commits

Author SHA1 Message Date
github-actions[bot]
7f72aadff9 release(packages/nhost-js): 4.1.0 (#3586)
Co-authored-by: dbarrosop <dbarrosop@users.noreply.github.com>
2025-11-04 16:21:25 +01:00
github-actions[bot]
8faf9565bb release(services/storage): 0.9.0 (#3654)
Co-authored-by: dbarrosop <dbarrosop@users.noreply.github.com>
2025-11-04 16:21:16 +01:00
github-actions[bot]
7ac3f12852 release(services/auth): 0.43.0 (#3667)
Co-authored-by: dbarrosop <dbarrosop@users.noreply.github.com>
2025-11-04 16:21:10 +01:00
David Barroso
184a3ed190 feat(internal/lib): common oapi middleware for go services (#3663) 2025-11-04 16:17:41 +01:00
David Barroso
372c4e32d4 fix(ci): match the version exactly to avoid matching on pre-releases (#3666) 2025-11-04 15:54:01 +01:00
David Barroso
a68d261d8e fix(nhost-js): improvements to Session guard to avoid conflict with ProviderSession (#3662) 2025-11-04 10:53:37 +01:00
David Barroso
55bda3f56b fix(auth): dont mutate client URL (#3660) 2025-11-03 10:56:14 +01:00
David Barroso
2311e1dd77 feat(auth): if the callback state is wrong send back to the redirectTo as provider_state (#3649) 2025-10-31 12:13:35 +01:00
David Barroso
824ee142c4 chore(nixops): set system libraries consistently on darwin (#3656) 2025-10-31 11:06:38 +01:00
David Barroso
c662d063a7 chore(nixops): bump go to 1.25.3 and nixpkgs due to CVEs (#3652) 2025-10-30 16:37:52 +01:00
David Barroso
b518132349 chore(nhost-js): regenerate types (#3648) 2025-10-29 12:50:22 +01:00
David BM
b677d3768f fix(dashboard): update SQL editor to use correct hasura migrations API URL (#3645) 2025-10-28 15:58:25 +01:00
David Barroso
51ec151752 feat(auth): added endpoints to retrieve and refresh oauth2 providers' tokens (#3614) 2025-10-28 12:50:30 +01:00
David Barroso
223322d654 fix(ci): run pull_request_target workflows against PR (#3646) 2025-10-28 11:51:55 +01:00
David Barroso
add2c20c95 chore(nixops): bump nhost-cli (#3641) 2025-10-28 10:05:47 +01:00
github-actions[bot]
961bc5feea release(cli): 1.34.4 (#3644)
Co-authored-by: dbarrosop <dbarrosop@users.noreply.github.com>
2025-10-28 09:46:18 +01:00
David Barroso
0ca89974b9 fix(cli): update NEXT_PUBLIC_NHOST_HASURA_MIGRATIONS_API_URL correctly (#3643) 2025-10-28 09:44:14 +01:00
github-actions[bot]
e8d52859a3 release(cli): 1.34.3 (#3624)
Co-authored-by: dbarrosop <dbarrosop@users.noreply.github.com>
2025-10-27 16:05:01 +01:00
David Barroso
67740ebe3d chore(cli): bump nhost/dashboard to 2.40.0 (#3629)
Co-authored-by: dbarrosop <dbarrosop@users.noreply.github.com>
2025-10-27 16:03:07 +01:00
github-actions[bot]
d6f7b01aee release(dashboard): 2.40.0 (#3631)
Co-authored-by: dbarrosop <dbarrosop@users.noreply.github.com>
2025-10-27 15:23:14 +01:00
dependabot[bot]
0fc65df78d chore(ci): bump actions/upload-artifact from 4 to 5 (#3638)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-10-27 09:50:12 +01:00
dependabot[bot]
52e3db7f61 chore(ci): bump actions/download-artifact from 5 to 6 (#3639)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-10-27 08:51:05 +01:00
David Barroso
235449d68c chore(docs): update guidelines on the use of AI for contributions (#3637) 2025-10-27 08:46:10 +01:00
Jason Overmier
323834d212 feat(dashboard): allow configuring CSP header (#3627)
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: David Barroso <dbarrosop@dravetech.com>
2025-10-23 12:05:04 +02:00
David Barroso
f7bd250f73 chore(ci): changed pull_request to pull_request_target for access to secrets (#3632) 2025-10-23 11:15:29 +02:00
David BM
579f9dbf31 chore(dashboard): various improvements to support ticket page (#3630)
Co-authored-by: robertkasza <robert.kasza@bishop-co.com>
2025-10-23 09:38:45 +02:00
github-actions[bot]
9f2b93d44b release(dashboard): 2.39.0 (#3600)
Co-authored-by: dbarrosop <dbarrosop@users.noreply.github.com>
2025-10-22 10:59:29 +02:00
David Barroso
1aeef26ec6 feat(dashboard): move zendesk request to API route (#3628) 2025-10-22 10:54:42 +02:00
David Barroso
749bb4e637 feat(nhost-js): added various middlewares to work with headers and customizable createNhostClient (#3612) 2025-10-22 10:32:23 +02:00
David Barroso
accabc83f7 chore(cli): update schema (#3622) 2025-10-21 16:53:07 +02:00
David Barroso
8c127d7b6b chore(docs): fix broken link in openapi spec and minor mistakes in postmark integration info (#3621) 2025-10-21 12:32:44 +02:00
David BM
f9c614ef99 chore(deps): update Vite to address security advisory (#3620) 2025-10-21 12:18:29 +02:00
David Barroso
1d183f7fc4 feat(auth): encrypt TOTP secret (#3619) 2025-10-21 09:04:31 +02:00
github-actions[bot]
46e740f060 release(cli): 1.34.2 (#3603)
Co-authored-by: dbarrosop <dbarrosop@users.noreply.github.com>
2025-10-20 14:30:47 +02:00
David Barroso
0d30ab4eec chore(cli): update schema (#3613) 2025-10-20 14:27:49 +02:00
github-actions[bot]
d5fd3cb59c release(services/auth): 0.42.4 (#3618)
Co-authored-by: dbarrosop <dbarrosop@users.noreply.github.com>
2025-10-20 13:25:21 +02:00
David Barroso
f36d360b9e fix(auth): apply relationships on new projects (#3617) 2025-10-20 13:23:33 +02:00
github-actions[bot]
61af5087fd release(services/auth): 0.42.3 (#3608)
Co-authored-by: dbarrosop <dbarrosop@users.noreply.github.com>
2025-10-20 12:42:03 +02:00
David Barroso
7429d8ae3f fix(auth): always apply expected metadata (#3616) 2025-10-20 12:37:52 +02:00
294 changed files with 9926 additions and 5751 deletions

View File

@@ -7,6 +7,8 @@ assignees: ''
---
> **Note:** Bug reports that are clearly AI-generated will not be accepted and will be closed immediately. Please write your bug report in your own words.
**Describe the bug**
A clear and concise description of what the bug is.

View File

@@ -7,6 +7,8 @@ assignees: ''
---
> **Note:** Feature requests that are clearly AI-generated will not be accepted and will be closed immediately. Please write your feature request in your own words.
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

View File

@@ -8,6 +8,8 @@
--- Delete everything below this line before submitting your PR ---
> **Note on AI-assisted contributions:** Contributions with the help of AI are permitted, but you are ultimately responsible for the quality of your submission and for ensuring it follows our contributing guidelines. **The PR description must be written in your own words and be clear and concise**. Please ensure you remove any superfluous code comments introduced by AI tools before submitting. PRs that clearly violate this rule will be closed without further review.
### PR title format
The PR title must follow the following pattern:
@@ -30,6 +32,7 @@ Where `PKG` is:
- `deps`: For changes to dependencies
- `docs`: For changes to the documentation
- `examples`: For changes to the examples
- `internal/lib`: For changes to Nhost's common libraries (internal)
- `mintlify-openapi`: For changes to the Mintlify OpenAPI tool
- `nhost-js`: For changes to the Nhost JavaScript SDK
- `nixops`: For changes to the NixOps

View File

@@ -17,7 +17,7 @@ runs:
# Define valid types and packages
VALID_TYPES="feat|fix|chore"
VALID_PKGS="auth|ci|cli|codegen|dashboard|deps|docs|examples|mintlify-openapi|nhost-js|nixops|storage"
VALID_PKGS="auth|ci|cli|codegen|dashboard|deps|docs|examples|internal\/lib|mintlify-openapi|nhost-js|nixops|storage"
# Check if title matches the pattern TYPE(PKG): SUMMARY
if [[ ! "$PR_TITLE" =~ ^(${VALID_TYPES})\((${VALID_PKGS})\):\ .+ ]]; then

View File

@@ -1,8 +1,7 @@
---
name: "auth: check and build"
on:
# pull_request_target:
pull_request:
pull_request_target:
paths:
- '.github/workflows/auth_checks.yaml'
- '.github/workflows/wf_check.yaml'
@@ -18,6 +17,7 @@ on:
- '.golangci.yaml'
- 'go.mod'
- 'go.sum'
- 'internal/lib/**'
- 'vendor/**'
# auth
@@ -49,7 +49,7 @@ jobs:
with:
NAME: auth
PATH: services/auth
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
secrets:
AWS_ACCOUNT_ID: ${{ secrets.AWS_PRODUCTION_CORE_ACCOUNT_ID }}
@@ -64,7 +64,7 @@ jobs:
with:
NAME: auth
PATH: services/auth
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
VERSION: 0.0.0-dev # we use a fixed version here to avoid unnecessary rebuilds
DOCKER: true
secrets:

View File

@@ -40,7 +40,7 @@ jobs:
cd ${{ matrix.project }}
TAG_NAME=$(make release-tag-name)
VERSION=$(nix develop .\#cliff -c make changelog-next-version)
if git tag | grep -q "$TAG_NAME@$VERSION"; then
if git tag | grep -qx "$TAG_NAME@$VERSION"; then
echo "Tag $TAG_NAME@$VERSION already exists, skipping release preparation"
else
echo "Tag $TAG_NAME@$VERSION does not exist, proceeding with release preparation"

View File

@@ -1,8 +1,7 @@
---
name: "cli: check and build"
on:
# pull_request_target:
pull_request:
pull_request_target:
paths:
- '.github/workflows/cli_checks.yaml'
- '.github/workflows/wf_check.yaml'
@@ -50,7 +49,7 @@ jobs:
with:
NAME: cli
PATH: cli
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
secrets:
AWS_ACCOUNT_ID: ${{ secrets.AWS_PRODUCTION_CORE_ACCOUNT_ID }}
@@ -65,7 +64,7 @@ jobs:
with:
NAME: cli
PATH: cli
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
VERSION: 0.0.0-dev # we use a fixed version here to avoid unnecessary rebuilds
DOCKER: true
secrets:
@@ -81,7 +80,7 @@ jobs:
with:
NAME: cli
PATH: cli
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
secrets:
AWS_ACCOUNT_ID: ${{ secrets.AWS_PRODUCTION_CORE_ACCOUNT_ID }}

View File

@@ -63,7 +63,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: "Get artifacts"
uses: actions/download-artifact@v5
uses: actions/download-artifact@v6
with:
path: ~/artifacts

View File

@@ -1,8 +1,7 @@
---
name: "codegen: check and build"
on:
# pull_request_target:
pull_request:
pull_request_target:
paths:
- '.github/workflows/wf_check.yaml'
- '.github/workflows/codegen_checks.yaml'
@@ -48,7 +47,7 @@ jobs:
with:
NAME: codegen
PATH: tools/codegen
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
secrets:
AWS_ACCOUNT_ID: ${{ secrets.AWS_PRODUCTION_CORE_ACCOUNT_ID }}
@@ -62,7 +61,7 @@ jobs:
with:
NAME: codegen
PATH: tools/codegen
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
VERSION: 0.0.0-dev # we use a fixed version here to avoid unnecessary rebuilds
DOCKER: false
secrets:

View File

@@ -1,7 +1,7 @@
---
name: "dashboard: check and build"
on:
pull_request:
pull_request_target:
paths:
- '.github/workflows/wf_build_artifacts.yaml'
- '.github/workflows/wf_check.yaml'
@@ -54,7 +54,7 @@ jobs:
- check-permissions
with:
NAME: dashboard
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
ENVIRONMENT: preview
secrets:
AWS_ACCOUNT_ID: ${{ secrets.AWS_PRODUCTION_CORE_ACCOUNT_ID }}
@@ -73,7 +73,7 @@ jobs:
with:
NAME: dashboard
PATH: dashboard
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
VERSION: 0.0.0-dev # we use a fixed version here to avoid unnecessary rebuilds
DOCKER: true
OS_MATRIX: '["blacksmith-2vcpu-ubuntu-2404"]'
@@ -91,7 +91,7 @@ jobs:
with:
NAME: dashboard
PATH: dashboard
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
secrets:
AWS_ACCOUNT_ID: ${{ secrets.AWS_PRODUCTION_CORE_ACCOUNT_ID }}
NIX_CACHE_PUB_KEY: ${{ secrets.NIX_CACHE_PUB_KEY }}
@@ -107,7 +107,7 @@ jobs:
with:
NAME: dashboard
PATH: dashboard
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
NHOST_TEST_DASHBOARD_URL: ${{ needs.deploy-vercel.outputs.preview-url }}
NHOST_TEST_PROJECT_NAME: ${{ vars.NHOST_TEST_PROJECT_NAME }}
NHOST_TEST_ORGANIZATION_NAME: ${{ vars.NHOST_TEST_ORGANIZATION_NAME }}

View File

@@ -148,7 +148,7 @@ jobs:
rm playwright-report.tar.gz
- name: Upload encrypted Playwright report
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v5
if: failure()
with:
name: encrypted-playwright-report-${{ github.run_id }}

View File

@@ -1,7 +1,7 @@
---
name: "docs: check and build"
on:
pull_request:
pull_request_target:
paths:
- '.github/workflows/wf_check.yaml'
- '.github/workflows/dashboard_checks.yaml'
@@ -62,7 +62,7 @@ jobs:
with:
NAME: docs
PATH: docs
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
secrets:
AWS_ACCOUNT_ID: ${{ secrets.AWS_PRODUCTION_CORE_ACCOUNT_ID }}
NIX_CACHE_PUB_KEY: ${{ secrets.NIX_CACHE_PUB_KEY }}

View File

@@ -1,8 +1,7 @@
---
name: "examples/demos: check and build"
on:
# pull_request_target:
pull_request:
pull_request_target:
paths:
- '.github/workflows/wf_check.yaml'
- '.github/workflows/examples_demos_checks.yaml'
@@ -64,7 +63,7 @@ jobs:
with:
NAME: demos
PATH: examples/demos
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
secrets:
AWS_ACCOUNT_ID: ${{ secrets.AWS_PRODUCTION_CORE_ACCOUNT_ID }}
@@ -78,7 +77,7 @@ jobs:
with:
NAME: demos
PATH: examples/demos
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
VERSION: 0.0.0-dev # we use a fixed version here to avoid unnecessary rebuilds
DOCKER: false
OS_MATRIX: '["blacksmith-2vcpu-ubuntu-2404"]'

View File

@@ -1,8 +1,7 @@
---
name: "examples/guides: check and build"
on:
# pull_request_target:
pull_request:
pull_request_target:
paths:
- '.github/workflows/wf_check.yaml'
- '.github/workflows/examples_guides_checks.yaml'
@@ -64,7 +63,7 @@ jobs:
with:
NAME: guides
PATH: examples/guides
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
secrets:
AWS_ACCOUNT_ID: ${{ secrets.AWS_PRODUCTION_CORE_ACCOUNT_ID }}
@@ -78,7 +77,7 @@ jobs:
with:
NAME: guides
PATH: examples/guides
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
VERSION: 0.0.0-dev # we use a fixed version here to avoid unnecessary rebuilds
DOCKER: false
OS_MATRIX: '["blacksmith-2vcpu-ubuntu-2404"]'

View File

@@ -1,8 +1,7 @@
---
name: "examples/tutorials: check and build"
on:
# pull_request_target:
pull_request:
pull_request_target:
paths:
- '.github/workflows/wf_check.yaml'
- '.github/workflows/examples_tutorials_checks.yaml'
@@ -64,7 +63,7 @@ jobs:
with:
NAME: tutorials
PATH: examples/tutorials
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
secrets:
AWS_ACCOUNT_ID: ${{ secrets.AWS_PRODUCTION_CORE_ACCOUNT_ID }}
@@ -78,7 +77,7 @@ jobs:
with:
NAME: tutorials
PATH: examples/tutorials
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
VERSION: 0.0.0-dev # we use a fixed version here to avoid unnecessary rebuilds
DOCKER: false
OS_MATRIX: '["blacksmith-2vcpu-ubuntu-2404"]'

View File

@@ -1,7 +1,7 @@
---
name: "gen: AI review"
on:
pull_request:
pull_request_target:
types: [opened, reopened, ready_for_review]
issue_comment:
jobs:

View File

@@ -1,8 +1,7 @@
---
name: "nhost-js: check and build"
on:
# pull_request_target:
pull_request:
pull_request_target:
paths:
- '.github/workflows/wf_check.yaml'
- '.github/workflows/nhost-js_checks.yaml'
@@ -65,7 +64,7 @@ jobs:
with:
NAME: nhost-js
PATH: packages/nhost-js
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
secrets:
AWS_ACCOUNT_ID: ${{ secrets.AWS_PRODUCTION_CORE_ACCOUNT_ID }}
@@ -79,7 +78,7 @@ jobs:
with:
NAME: nhost-js
PATH: packages/nhost-js
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
VERSION: 0.0.0-dev # we use a fixed version here to avoid unnecessary rebuilds
DOCKER: false
secrets:

View File

@@ -1,8 +1,7 @@
---
name: "nixops: check and build"
on:
# pull_request_target:
pull_request:
pull_request_target:
paths:
- '.github/workflows/wf_check.yaml'
- '.github/workflows/nixops_checks.yaml'
@@ -40,7 +39,7 @@ jobs:
with:
NAME: nixops
PATH: nixops
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
secrets:
AWS_ACCOUNT_ID: ${{ secrets.AWS_PRODUCTION_CORE_ACCOUNT_ID }}
@@ -54,7 +53,7 @@ jobs:
with:
NAME: nixops
PATH: nixops
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
VERSION: 0.0.0-dev # we use a fixed version here to avoid unnecessary rebuilds
DOCKER: true
secrets:

View File

@@ -1,8 +1,7 @@
---
name: "storage: check and build"
on:
# pull_request_target:
pull_request:
pull_request_target:
paths:
- '.github/workflows/storage_checks.yaml'
- '.github/workflows/wf_check.yaml'
@@ -18,6 +17,7 @@ on:
- '.golangci.yaml'
- 'go.mod'
- 'go.sum'
- 'internal/lib/**'
- 'vendor/**'
# storage
@@ -49,7 +49,7 @@ jobs:
with:
NAME: storage
PATH: services/storage
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
secrets:
AWS_ACCOUNT_ID: ${{ secrets.AWS_PRODUCTION_CORE_ACCOUNT_ID }}
@@ -64,7 +64,7 @@ jobs:
with:
NAME: storage
PATH: services/storage
GIT_REF: ${{ github.sha }}
GIT_REF: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
VERSION: 0.0.0-dev # we use a fixed version here to avoid unnecessary rebuilds
DOCKER: true
secrets:

View File

@@ -85,7 +85,7 @@ jobs:
zip -r result.zip result
- name: "Push artifact to artifact repository"
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v5
with:
name: ${{ inputs.NAME }}-artifact-${{ steps.vars.outputs.ARCH }}-${{ steps.vars.outputs.VERSION }}
path: ${{ inputs.PATH }}/result.zip
@@ -100,7 +100,7 @@ jobs:
if: ${{ ( inputs.DOCKER ) }}
- name: "Push docker image to artifact repository"
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v5
with:
name: ${{ inputs.NAME }}-docker-image-${{ steps.vars.outputs.ARCH }}-${{ steps.vars.outputs.VERSION }}
path: ${{ inputs.PATH }}/result

View File

@@ -44,7 +44,7 @@ jobs:
echo "VERSION=$(make get-version VER=${{ inputs.VERSION }})" >> $GITHUB_OUTPUT
- name: "Get artifacts"
uses: actions/download-artifact@v5
uses: actions/download-artifact@v6
with:
path: ~/artifacts

View File

@@ -55,7 +55,7 @@ jobs:
echo "VERSION=$(make get-version VER=${{ inputs.VERSION }})" >> $GITHUB_OUTPUT
- name: "Get artifacts"
uses: actions/download-artifact@v5
uses: actions/download-artifact@v6
with:
path: ~/artifacts

View File

@@ -16,6 +16,15 @@ Contributions are made to Nhost repos via Issues and Pull Requests (PRs). A few
- We work hard to make sure issues are handled on time, but it could take a while to investigate the root cause depending on the impact. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking.
- If you've never contributed before, see [the first-timer's guide](https://github.com/firstcontributions/first-contributions) for resources and tips on getting started.
### AI-Assisted Contributions
We have specific policies regarding AI-assisted contributions:
- **Issues**: Bug reports and feature requests that are clearly AI-generated will not be accepted and will be closed immediately. Please write your issues in your own words to ensure they are clear, specific, and contain the necessary context.
- **Pull Requests**: Contributions with the help of AI are permitted, but you are ultimately responsible for the quality of your submission and for ensuring it follows our contributing guidelines. The PR description must be written in your own words. Additionally, please remove any superfluous code comments introduced by AI tools before submitting. PRs that clearly violate this rule will be closed without further review.
In all cases, contributors must ensure their submissions are thoughtful, well-tested, and meet the project's quality standards.
### Issues
Issues should be used to report problems with Nhost, request a new feature, or discuss potential changes before a PR is created.

View File

@@ -3,6 +3,7 @@
"$schema": "https://github.com/IBM/audit-ci/raw/main/docs/schema.json",
"moderate": true,
"allowlist": [
"GHSA-9965-vmph-33xx" // https://github.com/advisories/GHSA-9965-vmph-33xx Update package once have a fix
"GHSA-9965-vmph-33xx", // https://github.com/advisories/GHSA-9965-vmph-33xx Update package once have a fix
"GHSA-7mvr-c777-76hp" // https://github.com/advisories/GHSA-7mvr-c777-76hp Update package once Nix side is also updated
]
}

View File

@@ -2,6 +2,26 @@
All notable changes to this project will be documented in this file.
## [cli@1.34.4] - 2025-10-28
### 🐛 Bug Fixes
- *(cli)* Update NEXT_PUBLIC_NHOST_HASURA_MIGRATIONS_API_URL correctly (#3643)
## [cli@1.34.3] - 2025-10-27
### ⚙️ Miscellaneous Tasks
- *(cli)* Update schema (#3622)
- *(cli)* Bump nhost/dashboard to 2.40.0 (#3629)
## [cli@1.34.2] - 2025-10-20
### ⚙️ Miscellaneous Tasks
- *(cli)* Minor fix to download script when specifying version (#3602)
- *(cli)* Update schema (#3613)
## [cli@1.34.1] - 2025-10-13
### 🐛 Bug Fixes

View File

@@ -56,7 +56,7 @@ func CommandCloud() *cli.Command {
&cli.StringFlag{ //nolint:exhaustruct
Name: flagDashboardVersion,
Usage: "Dashboard version to use",
Value: "nhost/dashboard:2.38.4",
Value: "nhost/dashboard:2.40.0",
Sources: cli.EnvVars("NHOST_DASHBOARD_VERSION"),
},
&cli.StringFlag{ //nolint:exhaustruct

View File

@@ -111,7 +111,7 @@ func CommandUp() *cli.Command { //nolint:funlen
&cli.StringFlag{ //nolint:exhaustruct
Name: flagDashboardVersion,
Usage: "Dashboard version to use",
Value: "nhost/dashboard:2.38.4",
Value: "nhost/dashboard:2.40.0",
Sources: cli.EnvVars("NHOST_DASHBOARD_VERSION"),
},
&cli.StringFlag{ //nolint:exhaustruct

View File

@@ -56,6 +56,7 @@ func auth( //nolint:funlen
false,
false,
"00000000-0000-0000-0000-000000000000",
"5181f67e2844e4b60d571fa346cac9c37fc00d1ff519212eae6cead138e639ba",
)
if err != nil {
return nil, fmt.Errorf("failed to get hasura env vars: %w", err)

View File

@@ -33,6 +33,7 @@ func expectedAuth() *Service {
"AUTH_DISABLE_SIGNUP": "false",
"AUTH_EMAIL_PASSWORDLESS_ENABLED": "true",
"AUTH_EMAIL_SIGNIN_EMAIL_VERIFIED_REQUIRED": "true",
"AUTH_ENCRYPTION_KEY": "5181f67e2844e4b60d571fa346cac9c37fc00d1ff519212eae6cead138e639ba",
"AUTH_GRAVATAR_DEFAULT": "gravatarDefault",
"AUTH_GRAVATAR_ENABLED": "true",
"AUTH_GRAVATAR_RATING": "gravatarRating",

View File

@@ -344,7 +344,7 @@ func dashboard(
subdomain, "hasura", httpPort, useTLS,
) + "/console",
"NEXT_PUBLIC_NHOST_HASURA_MIGRATIONS_API_URL": URL(
subdomain, "hasura", httpPort, useTLS),
subdomain, "hasura", httpPort, useTLS) + "/apis/migrate",
"NEXT_PUBLIC_NHOST_STORAGE_URL": URL(
subdomain, "storage", httpPort, useTLS) + "/v1",
},

View File

@@ -1,6 +1,6 @@
// Package auth provides primitives to interact with the openapi HTTP API.
//
// Code generated by github.com/oapi-codegen/oapi-codegen/v2 version 2.4.1 DO NOT EDIT.
// Code generated by github.com/oapi-codegen/oapi-codegen/v2 version 2.5.0 DO NOT EDIT.
package auth
import (

View File

@@ -1,6 +1,6 @@
// Package graphql provides primitives to interact with the openapi HTTP API.
//
// Code generated by github.com/oapi-codegen/oapi-codegen/v2 version 2.4.1 DO NOT EDIT.
// Code generated by github.com/oapi-codegen/oapi-codegen/v2 version 2.5.0 DO NOT EDIT.
package graphql
import (

View File

@@ -148,7 +148,7 @@ import (
#Hasura: {
// Version of hasura, you can see available versions in the URL below:
// https://hub.docker.com/r/hasura/graphql-engine/tags
version: string | *"v2.46.0-ce"
version: string | *"v2.48.5-ce"
// JWT Secrets configuration
jwtSecrets: [#JWTSecret]
@@ -223,7 +223,7 @@ import (
// Releases:
//
// https://github.com/nhost/hasura-storage/releases
version: string | *"0.7.2"
version: string | *"0.8.2"
// Networking (custom domains at the moment) are not allowed as we need to do further
// configurations in the CDN. We will enable it again in the future.
@@ -311,7 +311,7 @@ import (
// Releases:
//
// https://github.com/nhost/hasura-auth/releases
version: string | *"0.38.1"
version: string | *"0.42.4"
// Resources for the service
resources?: #Resources
@@ -651,6 +651,9 @@ import (
iops: uint32 | *3000
tput: uint32 | *125
}
encryptColumnKey?: string & =~"^[0-9a-fA-F]{64}$" // 32 bytes hex-encoded key
oldEncryptColumnKey?: string & =~"^[0-9a-fA-F]{64}$" // for key rotation
}
persistentVolumesEncrypted: bool | *false

View File

@@ -70,18 +70,28 @@ type ConfigAIUpdateInput struct {
WebhookSecret *string `json:"webhookSecret,omitempty"`
}
// Configuration for auth service
// You can find more information about the configuration here:
// https://github.com/nhost/hasura-auth/blob/main/docs/environment-variables.md
type ConfigAuth struct {
ElevatedPrivileges *ConfigAuthElevatedPrivileges `json:"elevatedPrivileges,omitempty"`
Method *ConfigAuthMethod `json:"method,omitempty"`
Misc *ConfigAuthMisc `json:"misc,omitempty"`
RateLimit *ConfigAuthRateLimit `json:"rateLimit,omitempty"`
Redirections *ConfigAuthRedirections `json:"redirections,omitempty"`
Resources *ConfigResources `json:"resources,omitempty"`
Session *ConfigAuthSession `json:"session,omitempty"`
SignUp *ConfigAuthSignUp `json:"signUp,omitempty"`
Totp *ConfigAuthTotp `json:"totp,omitempty"`
User *ConfigAuthUser `json:"user,omitempty"`
Version *string `json:"version,omitempty"`
// Resources for the service
Resources *ConfigResources `json:"resources,omitempty"`
Session *ConfigAuthSession `json:"session,omitempty"`
SignUp *ConfigAuthSignUp `json:"signUp,omitempty"`
Totp *ConfigAuthTotp `json:"totp,omitempty"`
User *ConfigAuthUser `json:"user,omitempty"`
// Version of auth, you can see available versions in the URL below:
// https://hub.docker.com/r/nhost/hasura-auth/tags
//
// Releases:
//
// https://github.com/nhost/hasura-auth/releases
Version *string `json:"version,omitempty"`
}
type ConfigAuthElevatedPrivileges struct {
@@ -111,9 +121,11 @@ type ConfigAuthMethodAnonymousUpdateInput struct {
}
type ConfigAuthMethodEmailPassword struct {
EmailVerificationRequired *bool `json:"emailVerificationRequired,omitempty"`
HibpEnabled *bool `json:"hibpEnabled,omitempty"`
PasswordMinLength *uint32 `json:"passwordMinLength,omitempty"`
EmailVerificationRequired *bool `json:"emailVerificationRequired,omitempty"`
// Disabling email+password sign in is not implmented yet
// enabled: bool | *true
HibpEnabled *bool `json:"hibpEnabled,omitempty"`
PasswordMinLength *uint32 `json:"passwordMinLength,omitempty"`
}
type ConfigAuthMethodEmailPasswordUpdateInput struct {
@@ -335,8 +347,10 @@ type ConfigAuthRateLimitUpdateInput struct {
}
type ConfigAuthRedirections struct {
// AUTH_ACCESS_CONTROL_ALLOWED_REDIRECT_URLS
AllowedUrls []string `json:"allowedUrls,omitempty"`
ClientURL *string `json:"clientUrl,omitempty"`
// AUTH_CLIENT_URL
ClientURL *string `json:"clientUrl,omitempty"`
}
type ConfigAuthRedirectionsUpdateInput struct {
@@ -350,8 +364,10 @@ type ConfigAuthSession struct {
}
type ConfigAuthSessionAccessToken struct {
// AUTH_JWT_CUSTOM_CLAIMS
CustomClaims []*ConfigAuthsessionaccessTokenCustomClaims `json:"customClaims,omitempty"`
ExpiresIn *uint32 `json:"expiresIn,omitempty"`
// AUTH_ACCESS_TOKEN_EXPIRES_IN
ExpiresIn *uint32 `json:"expiresIn,omitempty"`
}
type ConfigAuthSessionAccessTokenUpdateInput struct {
@@ -360,6 +376,7 @@ type ConfigAuthSessionAccessTokenUpdateInput struct {
}
type ConfigAuthSessionRefreshToken struct {
// AUTH_REFRESH_TOKEN_EXPIRES_IN
ExpiresIn *uint32 `json:"expiresIn,omitempty"`
}
@@ -373,9 +390,11 @@ type ConfigAuthSessionUpdateInput struct {
}
type ConfigAuthSignUp struct {
DisableNewUsers *bool `json:"disableNewUsers,omitempty"`
Enabled *bool `json:"enabled,omitempty"`
Turnstile *ConfigAuthSignUpTurnstile `json:"turnstile,omitempty"`
// AUTH_DISABLE_NEW_USERS
DisableNewUsers *bool `json:"disableNewUsers,omitempty"`
// Inverse of AUTH_DISABLE_SIGNUP
Enabled *bool `json:"enabled,omitempty"`
Turnstile *ConfigAuthSignUpTurnstile `json:"turnstile,omitempty"`
}
type ConfigAuthSignUpTurnstile struct {
@@ -425,12 +444,16 @@ type ConfigAuthUser struct {
}
type ConfigAuthUserEmail struct {
// AUTH_ACCESS_CONTROL_ALLOWED_EMAILS
Allowed []string `json:"allowed,omitempty"`
// AUTH_ACCESS_CONTROL_BLOCKED_EMAILS
Blocked []string `json:"blocked,omitempty"`
}
type ConfigAuthUserEmailDomains struct {
// AUTH_ACCESS_CONTROL_ALLOWED_EMAIL_DOMAINS
Allowed []string `json:"allowed,omitempty"`
// AUTH_ACCESS_CONTROL_BLOCKED_EMAIL_DOMAINS
Blocked []string `json:"blocked,omitempty"`
}
@@ -446,6 +469,7 @@ type ConfigAuthUserEmailUpdateInput struct {
type ConfigAuthUserGravatar struct {
Default *string `json:"default,omitempty"`
// AUTH_GRAVATAR_ENABLED
Enabled *bool `json:"enabled,omitempty"`
Rating *string `json:"rating,omitempty"`
}
@@ -457,8 +481,10 @@ type ConfigAuthUserGravatarUpdateInput struct {
}
type ConfigAuthUserLocale struct {
// AUTH_LOCALE_ALLOWED_LOCALES
Allowed []string `json:"allowed,omitempty"`
Default *string `json:"default,omitempty"`
// AUTH_LOCALE_DEFAULT
Default *string `json:"default,omitempty"`
}
type ConfigAuthUserLocaleUpdateInput struct {
@@ -467,8 +493,10 @@ type ConfigAuthUserLocaleUpdateInput struct {
}
type ConfigAuthUserRoles struct {
// AUTH_USER_DEFAULT_ALLOWED_ROLES
Allowed []string `json:"allowed,omitempty"`
Default *string `json:"default,omitempty"`
// AUTH_USER_DEFAULT_ROLE
Default *string `json:"default,omitempty"`
}
type ConfigAuthUserRolesUpdateInput struct {
@@ -484,6 +512,7 @@ type ConfigAuthUserUpdateInput struct {
Roles *ConfigAuthUserRolesUpdateInput `json:"roles,omitempty"`
}
// AUTH_JWT_CUSTOM_CLAIMS
type ConfigAuthsessionaccessTokenCustomClaims struct {
Default *string `json:"default,omitempty"`
Key string `json:"key"`
@@ -522,8 +551,11 @@ type ConfigClaimMapUpdateInput struct {
Value *string `json:"value,omitempty"`
}
// Resource configuration for a service
type ConfigComputeResources struct {
CPU uint32 `json:"cpu"`
// milicpus, 1000 milicpus = 1 cpu
CPU uint32 `json:"cpu"`
// MiB: 128MiB to 30GiB
Memory uint32 `json:"memory"`
}
@@ -537,17 +569,28 @@ type ConfigComputeResourcesUpdateInput struct {
Memory *uint32 `json:"memory,omitempty"`
}
// main entrypoint to the configuration
type ConfigConfig struct {
Ai *ConfigAi `json:"ai,omitempty"`
Auth *ConfigAuth `json:"auth,omitempty"`
Functions *ConfigFunctions `json:"functions,omitempty"`
Global *ConfigGlobal `json:"global,omitempty"`
Graphql *ConfigGraphql `json:"graphql,omitempty"`
Hasura *ConfigHasura `json:"hasura"`
// Configuration for graphite service
Ai *ConfigAi `json:"ai,omitempty"`
// Configuration for auth service
Auth *ConfigAuth `json:"auth,omitempty"`
// Configuration for functions service
Functions *ConfigFunctions `json:"functions,omitempty"`
// Global configuration that applies to all services
Global *ConfigGlobal `json:"global,omitempty"`
// Advanced configuration for GraphQL
Graphql *ConfigGraphql `json:"graphql,omitempty"`
// Configuration for hasura
Hasura *ConfigHasura `json:"hasura"`
// Configuration for observability service
Observability *ConfigObservability `json:"observability"`
Postgres *ConfigPostgres `json:"postgres"`
Provider *ConfigProvider `json:"provider,omitempty"`
Storage *ConfigStorage `json:"storage,omitempty"`
// Configuration for postgres service
Postgres *ConfigPostgres `json:"postgres"`
// Configuration for third party providers like SMTP, SMS, etc.
Provider *ConfigProvider `json:"provider,omitempty"`
// Configuration for storage service
Storage *ConfigStorage `json:"storage,omitempty"`
}
type ConfigConfigUpdateInput struct {
@@ -564,7 +607,8 @@ type ConfigConfigUpdateInput struct {
}
type ConfigEnvironmentVariable struct {
Name string `json:"name"`
Name string `json:"name"`
// Value of the environment variable
Value string `json:"value"`
}
@@ -578,6 +622,7 @@ type ConfigEnvironmentVariableUpdateInput struct {
Value *string `json:"value,omitempty"`
}
// Configuration for functions service
type ConfigFunctions struct {
Node *ConfigFunctionsNode `json:"node,omitempty"`
RateLimit *ConfigRateLimit `json:"rateLimit,omitempty"`
@@ -606,12 +651,15 @@ type ConfigFunctionsUpdateInput struct {
Resources *ConfigFunctionsResourcesUpdateInput `json:"resources,omitempty"`
}
// Global configuration that applies to all services
type ConfigGlobal struct {
// User-defined environment variables that are spread over all services
Environment []*ConfigGlobalEnvironmentVariable `json:"environment,omitempty"`
}
type ConfigGlobalEnvironmentVariable struct {
Name string `json:"name"`
Name string `json:"name"`
// Value of the environment variable
Value string `json:"value"`
}
@@ -768,23 +816,34 @@ type ConfigGraphqlUpdateInput struct {
Security *ConfigGraphqlSecurityUpdateInput `json:"security,omitempty"`
}
// Configuration for hasura service
type ConfigHasura struct {
AdminSecret string `json:"adminSecret"`
AuthHook *ConfigHasuraAuthHook `json:"authHook,omitempty"`
Events *ConfigHasuraEvents `json:"events,omitempty"`
JwtSecrets []*ConfigJWTSecret `json:"jwtSecrets,omitempty"`
Logs *ConfigHasuraLogs `json:"logs,omitempty"`
RateLimit *ConfigRateLimit `json:"rateLimit,omitempty"`
Resources *ConfigResources `json:"resources,omitempty"`
Settings *ConfigHasuraSettings `json:"settings,omitempty"`
Version *string `json:"version,omitempty"`
WebhookSecret string `json:"webhookSecret"`
// Admin secret
AdminSecret string `json:"adminSecret"`
AuthHook *ConfigHasuraAuthHook `json:"authHook,omitempty"`
Events *ConfigHasuraEvents `json:"events,omitempty"`
// JWT Secrets configuration
JwtSecrets []*ConfigJWTSecret `json:"jwtSecrets,omitempty"`
Logs *ConfigHasuraLogs `json:"logs,omitempty"`
RateLimit *ConfigRateLimit `json:"rateLimit,omitempty"`
// Resources for the service
Resources *ConfigResources `json:"resources,omitempty"`
// Configuration for hasura services
// Reference: https://hasura.io/docs/latest/deployment/graphql-engine-flags/reference/
Settings *ConfigHasuraSettings `json:"settings,omitempty"`
// Version of hasura, you can see available versions in the URL below:
// https://hub.docker.com/r/hasura/graphql-engine/tags
Version *string `json:"version,omitempty"`
// Webhook secret
WebhookSecret string `json:"webhookSecret"`
}
type ConfigHasuraAuthHook struct {
Mode *string `json:"mode,omitempty"`
SendRequestBody *bool `json:"sendRequestBody,omitempty"`
URL string `json:"url"`
Mode *string `json:"mode,omitempty"`
// HASURA_GRAPHQL_AUTH_HOOK_SEND_REQUEST_BODY
SendRequestBody *bool `json:"sendRequestBody,omitempty"`
// HASURA_GRAPHQL_AUTH_HOOK
URL string `json:"url"`
}
type ConfigHasuraAuthHookUpdateInput struct {
@@ -794,6 +853,7 @@ type ConfigHasuraAuthHookUpdateInput struct {
}
type ConfigHasuraEvents struct {
// HASURA_GRAPHQL_EVENTS_HTTP_POOL_SIZE
HTTPPoolSize *uint32 `json:"httpPoolSize,omitempty"`
}
@@ -809,16 +869,27 @@ type ConfigHasuraLogsUpdateInput struct {
Level *string `json:"level,omitempty"`
}
// Configuration for hasura services
// Reference: https://hasura.io/docs/latest/deployment/graphql-engine-flags/reference/
type ConfigHasuraSettings struct {
CorsDomain []string `json:"corsDomain,omitempty"`
DevMode *bool `json:"devMode,omitempty"`
EnableAllowList *bool `json:"enableAllowList,omitempty"`
EnableConsole *bool `json:"enableConsole,omitempty"`
EnableRemoteSchemaPermissions *bool `json:"enableRemoteSchemaPermissions,omitempty"`
EnabledAPIs []string `json:"enabledAPIs,omitempty"`
InferFunctionPermissions *bool `json:"inferFunctionPermissions,omitempty"`
LiveQueriesMultiplexedRefetchInterval *uint32 `json:"liveQueriesMultiplexedRefetchInterval,omitempty"`
StringifyNumericTypes *bool `json:"stringifyNumericTypes,omitempty"`
// HASURA_GRAPHQL_CORS_DOMAIN
CorsDomain []string `json:"corsDomain,omitempty"`
// HASURA_GRAPHQL_DEV_MODE
DevMode *bool `json:"devMode,omitempty"`
// HASURA_GRAPHQL_ENABLE_ALLOWLIST
EnableAllowList *bool `json:"enableAllowList,omitempty"`
// HASURA_GRAPHQL_ENABLE_CONSOLE
EnableConsole *bool `json:"enableConsole,omitempty"`
// HASURA_GRAPHQL_ENABLE_REMOTE_SCHEMA_PERMISSIONS
EnableRemoteSchemaPermissions *bool `json:"enableRemoteSchemaPermissions,omitempty"`
// HASURA_GRAPHQL_ENABLED_APIS
EnabledAPIs []string `json:"enabledAPIs,omitempty"`
// HASURA_GRAPHQL_INFER_FUNCTION_PERMISSIONS
InferFunctionPermissions *bool `json:"inferFunctionPermissions,omitempty"`
// HASURA_GRAPHQL_LIVE_QUERIES_MULTIPLEXED_REFETCH_INTERVAL
LiveQueriesMultiplexedRefetchInterval *uint32 `json:"liveQueriesMultiplexedRefetchInterval,omitempty"`
// HASURA_GRAPHQL_STRINGIFY_NUMERIC_TYPES
StringifyNumericTypes *bool `json:"stringifyNumericTypes,omitempty"`
}
type ConfigHasuraSettingsUpdateInput struct {
@@ -891,6 +962,7 @@ type ConfigIngressUpdateInput struct {
TLS *ConfigIngressTLSUpdateInput `json:"tls,omitempty"`
}
// See https://hasura.io/docs/latest/auth/authentication/jwt/
type ConfigJWTSecret struct {
AllowedSkew *uint32 `json:"allowed_skew,omitempty"`
Audience *string `json:"audience,omitempty"`
@@ -939,11 +1011,15 @@ type ConfigObservabilityUpdateInput struct {
Grafana *ConfigGrafanaUpdateInput `json:"grafana,omitempty"`
}
// Configuration for postgres service
type ConfigPostgres struct {
Pitr *ConfigPostgresPitr `json:"pitr,omitempty"`
Pitr *ConfigPostgresPitr `json:"pitr,omitempty"`
// Resources for the service
Resources *ConfigPostgresResources `json:"resources"`
Settings *ConfigPostgresSettings `json:"settings,omitempty"`
Version *string `json:"version,omitempty"`
// Version of postgres, you can see available versions in the URL below:
// https://hub.docker.com/r/nhost/postgres/tags
Version *string `json:"version,omitempty"`
}
type ConfigPostgresPitr struct {
@@ -954,6 +1030,7 @@ type ConfigPostgresPitrUpdateInput struct {
Retention *uint32 `json:"retention,omitempty"`
}
// Resources for the service
type ConfigPostgresResources struct {
Compute *ConfigResourcesCompute `json:"compute,omitempty"`
EnablePublicAccess *bool `json:"enablePublicAccess,omitempty"`
@@ -1060,15 +1137,19 @@ type ConfigRateLimitUpdateInput struct {
Limit *uint32 `json:"limit,omitempty"`
}
// Resource configuration for a service
type ConfigResources struct {
Autoscaler *ConfigAutoscaler `json:"autoscaler,omitempty"`
Compute *ConfigResourcesCompute `json:"compute,omitempty"`
Networking *ConfigNetworking `json:"networking,omitempty"`
Replicas *uint32 `json:"replicas,omitempty"`
// Number of replicas for a service
Replicas *uint32 `json:"replicas,omitempty"`
}
type ConfigResourcesCompute struct {
CPU uint32 `json:"cpu"`
// milicpus, 1000 milicpus = 1 cpu
CPU uint32 `json:"cpu"`
// MiB: 128MiB to 30GiB
Memory uint32 `json:"memory"`
}
@@ -1120,7 +1201,8 @@ type ConfigRunServiceConfigWithID struct {
}
type ConfigRunServiceImage struct {
Image string `json:"image"`
Image string `json:"image"`
// content of "auths", i.e., { "auths": $THIS }
PullCredentials *string `json:"pullCredentials,omitempty"`
}
@@ -1158,11 +1240,13 @@ type ConfigRunServicePortUpdateInput struct {
Type *string `json:"type,omitempty"`
}
// Resource configuration for a service
type ConfigRunServiceResources struct {
Autoscaler *ConfigAutoscaler `json:"autoscaler,omitempty"`
Compute *ConfigComputeResources `json:"compute"`
Replicas uint32 `json:"replicas"`
Storage []*ConfigRunServiceResourcesStorage `json:"storage,omitempty"`
Autoscaler *ConfigAutoscaler `json:"autoscaler,omitempty"`
Compute *ConfigComputeResources `json:"compute"`
// Number of replicas for a service
Replicas uint32 `json:"replicas"`
Storage []*ConfigRunServiceResourcesStorage `json:"storage,omitempty"`
}
type ConfigRunServiceResourcesInsertInput struct {
@@ -1173,9 +1257,11 @@ type ConfigRunServiceResourcesInsertInput struct {
}
type ConfigRunServiceResourcesStorage struct {
// GiB
Capacity uint32 `json:"capacity"`
Name string `json:"name"`
Path string `json:"path"`
// name of the volume, changing it will cause data loss
Name string `json:"name"`
Path string `json:"path"`
}
type ConfigRunServiceResourcesStorageInsertInput struct {
@@ -1259,11 +1345,20 @@ type ConfigStandardOauthProviderWithScopeUpdateInput struct {
Scope []string `json:"scope,omitempty"`
}
// Configuration for storage service
type ConfigStorage struct {
Antivirus *ConfigStorageAntivirus `json:"antivirus,omitempty"`
RateLimit *ConfigRateLimit `json:"rateLimit,omitempty"`
Resources *ConfigResources `json:"resources,omitempty"`
Version *string `json:"version,omitempty"`
// Networking (custom domains at the moment) are not allowed as we need to do further
// configurations in the CDN. We will enable it again in the future.
Resources *ConfigResources `json:"resources,omitempty"`
// Version of storage service, you can see available versions in the URL below:
// https://hub.docker.com/r/nhost/hasura-storage/tags
//
// Releases:
//
// https://github.com/nhost/hasura-storage/releases
Version *string `json:"version,omitempty"`
}
type ConfigStorageAntivirus struct {
@@ -1301,6 +1396,8 @@ type ConfigSystemConfigAuthEmailTemplates struct {
}
type ConfigSystemConfigGraphql struct {
// manually enable graphi on a per-service basis
// by default it follows the plan
FeatureAdvancedGraphql *bool `json:"featureAdvancedGraphql,omitempty"`
}
@@ -1718,7 +1815,8 @@ type Apps struct {
AppStates []*AppStateHistory `json:"appStates"`
AutomaticDeploys bool `json:"automaticDeploys"`
// An array relationship
Backups []*Backups `json:"backups"`
Backups []*Backups `json:"backups"`
// main entrypoint to the configuration
Config *ConfigConfig `json:"config,omitempty"`
CreatedAt time.Time `json:"createdAt"`
// An object relationship
@@ -2725,6 +2823,7 @@ type Deployments struct {
CommitSha string `json:"commitSHA"`
CommitUserAvatarURL *string `json:"commitUserAvatarUrl,omitempty"`
CommitUserName *string `json:"commitUserName,omitempty"`
CreatedAt time.Time `json:"createdAt"`
DeploymentEndedAt *time.Time `json:"deploymentEndedAt,omitempty"`
// An array relationship
DeploymentLogs []*DeploymentLogs `json:"deploymentLogs"`
@@ -2767,6 +2866,7 @@ type DeploymentsBoolExp struct {
CommitSha *StringComparisonExp `json:"commitSHA,omitempty"`
CommitUserAvatarURL *StringComparisonExp `json:"commitUserAvatarUrl,omitempty"`
CommitUserName *StringComparisonExp `json:"commitUserName,omitempty"`
CreatedAt *TimestamptzComparisonExp `json:"createdAt,omitempty"`
DeploymentEndedAt *TimestamptzComparisonExp `json:"deploymentEndedAt,omitempty"`
DeploymentLogs *DeploymentLogsBoolExp `json:"deploymentLogs,omitempty"`
DeploymentStartedAt *TimestamptzComparisonExp `json:"deploymentStartedAt,omitempty"`
@@ -2801,6 +2901,7 @@ type DeploymentsMaxOrderBy struct {
CommitSha *OrderBy `json:"commitSHA,omitempty"`
CommitUserAvatarURL *OrderBy `json:"commitUserAvatarUrl,omitempty"`
CommitUserName *OrderBy `json:"commitUserName,omitempty"`
CreatedAt *OrderBy `json:"createdAt,omitempty"`
DeploymentEndedAt *OrderBy `json:"deploymentEndedAt,omitempty"`
DeploymentStartedAt *OrderBy `json:"deploymentStartedAt,omitempty"`
DeploymentStatus *OrderBy `json:"deploymentStatus,omitempty"`
@@ -2823,6 +2924,7 @@ type DeploymentsMinOrderBy struct {
CommitSha *OrderBy `json:"commitSHA,omitempty"`
CommitUserAvatarURL *OrderBy `json:"commitUserAvatarUrl,omitempty"`
CommitUserName *OrderBy `json:"commitUserName,omitempty"`
CreatedAt *OrderBy `json:"createdAt,omitempty"`
DeploymentEndedAt *OrderBy `json:"deploymentEndedAt,omitempty"`
DeploymentStartedAt *OrderBy `json:"deploymentStartedAt,omitempty"`
DeploymentStatus *OrderBy `json:"deploymentStatus,omitempty"`
@@ -2861,6 +2963,7 @@ type DeploymentsOrderBy struct {
CommitSha *OrderBy `json:"commitSHA,omitempty"`
CommitUserAvatarURL *OrderBy `json:"commitUserAvatarUrl,omitempty"`
CommitUserName *OrderBy `json:"commitUserName,omitempty"`
CreatedAt *OrderBy `json:"createdAt,omitempty"`
DeploymentEndedAt *OrderBy `json:"deploymentEndedAt,omitempty"`
DeploymentLogsAggregate *DeploymentLogsAggregateOrderBy `json:"deploymentLogs_aggregate,omitempty"`
DeploymentStartedAt *OrderBy `json:"deploymentStartedAt,omitempty"`
@@ -2892,6 +2995,7 @@ type DeploymentsStreamCursorValueInput struct {
CommitSha *string `json:"commitSHA,omitempty"`
CommitUserAvatarURL *string `json:"commitUserAvatarUrl,omitempty"`
CommitUserName *string `json:"commitUserName,omitempty"`
CreatedAt *time.Time `json:"createdAt,omitempty"`
DeploymentEndedAt *time.Time `json:"deploymentEndedAt,omitempty"`
DeploymentStartedAt *time.Time `json:"deploymentStartedAt,omitempty"`
DeploymentStatus *string `json:"deploymentStatus,omitempty"`
@@ -6885,6 +6989,8 @@ const (
// column name
DeploymentsSelectColumnCommitUserName DeploymentsSelectColumn = "commitUserName"
// column name
DeploymentsSelectColumnCreatedAt DeploymentsSelectColumn = "createdAt"
// column name
DeploymentsSelectColumnDeploymentEndedAt DeploymentsSelectColumn = "deploymentEndedAt"
// column name
DeploymentsSelectColumnDeploymentStartedAt DeploymentsSelectColumn = "deploymentStartedAt"
@@ -6918,6 +7024,7 @@ var AllDeploymentsSelectColumn = []DeploymentsSelectColumn{
DeploymentsSelectColumnCommitSha,
DeploymentsSelectColumnCommitUserAvatarURL,
DeploymentsSelectColumnCommitUserName,
DeploymentsSelectColumnCreatedAt,
DeploymentsSelectColumnDeploymentEndedAt,
DeploymentsSelectColumnDeploymentStartedAt,
DeploymentsSelectColumnDeploymentStatus,
@@ -6935,7 +7042,7 @@ var AllDeploymentsSelectColumn = []DeploymentsSelectColumn{
func (e DeploymentsSelectColumn) IsValid() bool {
switch e {
case DeploymentsSelectColumnAppID, DeploymentsSelectColumnCommitMessage, DeploymentsSelectColumnCommitSha, DeploymentsSelectColumnCommitUserAvatarURL, DeploymentsSelectColumnCommitUserName, DeploymentsSelectColumnDeploymentEndedAt, DeploymentsSelectColumnDeploymentStartedAt, DeploymentsSelectColumnDeploymentStatus, DeploymentsSelectColumnFunctionsEndedAt, DeploymentsSelectColumnFunctionsStartedAt, DeploymentsSelectColumnFunctionsStatus, DeploymentsSelectColumnID, DeploymentsSelectColumnMetadataEndedAt, DeploymentsSelectColumnMetadataStartedAt, DeploymentsSelectColumnMetadataStatus, DeploymentsSelectColumnMigrationsEndedAt, DeploymentsSelectColumnMigrationsStartedAt, DeploymentsSelectColumnMigrationsStatus:
case DeploymentsSelectColumnAppID, DeploymentsSelectColumnCommitMessage, DeploymentsSelectColumnCommitSha, DeploymentsSelectColumnCommitUserAvatarURL, DeploymentsSelectColumnCommitUserName, DeploymentsSelectColumnCreatedAt, DeploymentsSelectColumnDeploymentEndedAt, DeploymentsSelectColumnDeploymentStartedAt, DeploymentsSelectColumnDeploymentStatus, DeploymentsSelectColumnFunctionsEndedAt, DeploymentsSelectColumnFunctionsStartedAt, DeploymentsSelectColumnFunctionsStatus, DeploymentsSelectColumnID, DeploymentsSelectColumnMetadataEndedAt, DeploymentsSelectColumnMetadataStartedAt, DeploymentsSelectColumnMetadataStatus, DeploymentsSelectColumnMigrationsEndedAt, DeploymentsSelectColumnMigrationsStartedAt, DeploymentsSelectColumnMigrationsStatus:
return true
}
return false

View File

@@ -3,12 +3,13 @@ NEXT_PUBLIC_ENV=dev
NEXT_PUBLIC_NHOST_PLATFORM=false
# Environment Variables for Self Hosting and Local Development
NEXT_PUBLIC_NHOST_AUTH_URL=https://local.auth.nhost.local.run/v1
NEXT_PUBLIC_NHOST_AUTH_URL=https://local.auth.local.nhost.run/v1
NEXT_PUBLIC_NHOST_CONFIGSERVER_URL=https://local.dashboard.local.nhost.run/v1/configserver/graphql
NEXT_PUBLIC_NHOST_FUNCTIONS_URL=https://local.functions.local.nhost.run/v1
NEXT_PUBLIC_NHOST_GRAPHQL_URL=https://local.graphql.local.nhost.run/v1
NEXT_PUBLIC_NHOST_STORAGE_URL=https://local.storage.local.nhost.run/v1
NEXT_PUBLIC_NHOST_HASURA_CONSOLE_URL=https://local.hasura.local.nhost.run
NEXT_PUBLIC_NHOST_HASURA_MIGRATIONS_API_URL=https://local.hasura.local.nhost.run/v1/migrations
NEXT_PUBLIC_NHOST_HASURA_CONSOLE_URL=https://local.hasura.local.nhost.run/console
NEXT_PUBLIC_NHOST_HASURA_MIGRATIONS_API_URL=https://local.hasura.local.nhost.run/apis/migrate
NEXT_PUBLIC_NHOST_HASURA_API_URL=https://local.hasura.local.nhost.run
# Environment Variables when running the Nhost Dashboard against the Nhost Backend
@@ -18,13 +19,13 @@ NEXT_PUBLIC_ANALYTICS_WRITE_KEY=<analytics_write_key>
NEXT_PUBLIC_SEGMENT_CDN_URL=<segment_cdn_url>
NEXT_PUBLIC_NHOST_BRAGI_WEBSOCKET=<nhost_bragi_websocket>
NEXT_PUBLIC_ZENDESK_URL=
NEXT_PUBLIC_ZENDESK_API_KEY=
NEXT_PUBLIC_ZENDESK_USER_EMAIL=
NEXT_ZENDESK_URL=
NEXT_ZENDESK_API_KEY=
NEXT_ZENDESK_USER_EMAIL=
CODEGEN_GRAPHQL_URL=https://local.graphql.local.nhost.run/v1
CODEGEN_HASURA_ADMIN_SECRET=nhost-admin-secret
NEXT_PUBLIC_TURNSTILE_SITE_KEY=FIXME
NEXT_PUBLIC_SOC2_REPORT_FILE_ID=
NEXT_PUBLIC_SOC2_REPORT_FILE_ID=

View File

@@ -2,6 +2,34 @@
All notable changes to this project will be documented in this file.
## [@nhost/dashboard@2.40.0] - 2025-10-27
### 🚀 Features
- *(dashboard)* Allow configuring CSP header (#3627)
### ⚙️ Miscellaneous Tasks
- *(dashboard)* Various improvements to support ticket page (#3630)
## [@nhost/dashboard@2.39.0] - 2025-10-22
### 🚀 Features
- *(dashboard)* Move zendesk request to API route (#3628)
### 🐛 Bug Fixes
- *(dashboard)* Fix flaky e2e tests (#3536)
- *(dashboard)* Run audit and lint in dashboard (#3578)
### ⚙️ Miscellaneous Tasks
- *(dashboard)* Cleanup e2e remote schemas test before run (#3581)
## [@nhost/dashboard@2.38.4] - 2025-10-09
### 🐛 Bug Fixes

View File

@@ -82,6 +82,15 @@ This will connect the Nhost Dashboard to your locally running Nhost backend.
| `NEXT_PUBLIC_NHOST_HASURA_MIGRATIONS_API_URL` | The URL of Hasura's Migrations service. When working locally, point it to the Migrations service started by the CLI. |
| `NEXT_PUBLIC_NHOST_HASURA_API_URL` | The URL of Hasura's Schema and Metadata API. When working locally, point it to the Schema and Metadata API started by the CLI. When self-hosting, point it to the self-hosted Schema and Metadata API. |
### Content Security Policy (CSP) Configuration
The dashboard supports build-time CSP configuration to enable self-hosted deployments on custom domains.
| Name | Description |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `CSP_MODE` | Controls CSP behavior. Options: `nhost` (default, uses Nhost Cloud CSP), `disabled` (no CSP headers), `custom` (use custom CSP via `CSP_HEADER`). For self-hosted deployments on custom domains, set to `disabled` or `custom`. |
| `CSP_HEADER` | Custom Content Security Policy header value. Only used when `CSP_MODE=custom`. Should be a complete CSP string (e.g., `default-src 'self'; script-src 'self' 'unsafe-eval'; ...`). |
### Other Environment Variables
| Name | Description |

View File

@@ -4,21 +4,31 @@ const withBundleAnalyzer = require('@next/bundle-analyzer')({
});
const { version } = require('./package.json');
const cspHeader = `
default-src 'self' *.nhost.run wss://*.nhost.run nhost.run wss://nhost.run;
script-src 'self' 'unsafe-eval' cdn.segment.com js.stripe.com challenges.cloudflare.com googletagmanager.com;
connect-src 'self' *.nhost.run wss://*.nhost.run nhost.run wss://nhost.run discord.com api.segment.io api.segment.com cdn.segment.com nhost.zendesk.com;
style-src 'self' 'unsafe-inline';
img-src 'self' blob: data: github.com avatars.githubusercontent.com s.gravatar.com *.nhost.run nhost.run;
font-src 'self' data:;
object-src 'none';
base-uri 'self';
form-action 'self';
frame-ancestors 'none';
frame-src 'self' js.stripe.com challenges.cloudflare.com;
block-all-mixed-content;
upgrade-insecure-requests;
`;
function getCspHeader() {
switch (process.env.CSP_MODE) {
case 'disabled':
return null;
case 'custom':
return process.env.CSP_HEADER || null;
case 'nhost':
default:
return [
"default-src 'self' *.nhost.run wss://*.nhost.run nhost.run wss://nhost.run",
"script-src 'self' 'unsafe-eval' cdn.segment.com js.stripe.com challenges.cloudflare.com googletagmanager.com",
"connect-src 'self' *.nhost.run wss://*.nhost.run nhost.run wss://nhost.run discord.com api.segment.io api.segment.com cdn.segment.com nhost.zendesk.com",
"style-src 'self' 'unsafe-inline'",
"img-src 'self' blob: data: github.com avatars.githubusercontent.com s.gravatar.com *.nhost.run nhost.run",
"font-src 'self' data:",
"object-src 'none'",
"base-uri 'self'",
"form-action 'self'",
"frame-ancestors 'none'",
"frame-src 'self' js.stripe.com challenges.cloudflare.com",
"block-all-mixed-content",
"upgrade-insecure-requests",
].join('; ') + ';';
}
}
module.exports = withBundleAnalyzer({
reactStrictMode: false,
@@ -34,13 +44,19 @@ module.exports = withBundleAnalyzer({
dirs: ['src'],
},
async headers() {
const cspHeader = getCspHeader();
if (!cspHeader) {
return []; // No CSP headers
}
return [
{
source: '/(.*)',
source: '/:path*',
headers: [
{
key: 'Content-Security-Policy',
value: cspHeader.replace(/\s+/g, ' ').trim(),
value: cspHeader,
},
{
key: 'X-Frame-Options',

View File

@@ -196,7 +196,7 @@
"tailwindcss": "^3.4.12",
"ts-node": "^10.9.2",
"tsconfig-paths-webpack-plugin": "^4.1.0",
"vite": "^5.4.20",
"vite": "^5.4.21",
"vite-tsconfig-paths": "^4.3.2",
"vitest": "^3.2.4"
},

View File

@@ -415,7 +415,7 @@ importers:
version: 6.21.0(eslint@8.57.0)(typescript@5.8.3)
'@vitejs/plugin-react':
specifier: ^4.7.0
version: 4.7.0(vite@5.4.20(@types/node@20.14.8)(terser@5.44.0))
version: 4.7.0(vite@5.4.21(@types/node@20.14.8)(terser@5.44.0))
'@vitest/coverage-v8':
specifier: ^3.2.4
version: 3.2.4(vitest@3.2.4(@types/debug@4.1.12)(@types/node@20.14.8)(jsdom@22.1.0)(msw@2.11.4(@types/node@20.14.8)(typescript@5.8.3))(terser@5.44.0))
@@ -525,11 +525,11 @@ importers:
specifier: ^4.1.0
version: 4.2.0
vite:
specifier: ^5.4.20
version: 5.4.20(@types/node@20.14.8)(terser@5.44.0)
specifier: ^5.4.21
version: 5.4.21(@types/node@20.14.8)(terser@5.44.0)
vite-tsconfig-paths:
specifier: ^4.3.2
version: 4.3.2(typescript@5.8.3)(vite@5.4.20(@types/node@20.14.8)(terser@5.44.0))
version: 4.3.2(typescript@5.8.3)(vite@5.4.21(@types/node@20.14.8)(terser@5.44.0))
vitest:
specifier: ^3.2.4
version: 3.2.4(@types/debug@4.1.12)(@types/node@20.14.8)(jsdom@22.1.0)(msw@2.11.4(@types/node@20.14.8)(typescript@5.8.3))(terser@5.44.0)
@@ -8576,13 +8576,13 @@ packages:
vite-tsconfig-paths@4.3.2:
resolution: {integrity: sha512-0Vd/a6po6Q+86rPlntHye7F31zA2URZMbH8M3saAZ/xR9QoGN/L21bxEGfXdWmFdNkqPpRdxFT7nmNe12e9/uA==}
peerDependencies:
vite: '*'
vite: '>=4.5.14'
peerDependenciesMeta:
vite:
optional: true
vite@5.4.20:
resolution: {integrity: sha512-j3lYzGC3P+B5Yfy/pfKNgVEg4+UtcIJcVRt2cDjIOmhLourAqPqf8P7acgxeiSgUB7E3p2P8/3gNIgDLpwzs4g==}
vite@5.4.21:
resolution: {integrity: sha512-o5a9xKjbtuhY6Bi5S3+HvbRERmouabWbyUcpXXUA1u+GNUKoROi9byOJ8M0nHbHYHkYICiMlqxkg1KkYmm25Sw==}
engines: {node: ^18.0.0 || >=20.0.0}
hasBin: true
peerDependencies:
@@ -13299,7 +13299,7 @@ snapshots:
'@ungap/structured-clone@1.2.0': {}
'@vitejs/plugin-react@4.7.0(vite@5.4.20(@types/node@20.14.8)(terser@5.44.0))':
'@vitejs/plugin-react@4.7.0(vite@5.4.21(@types/node@20.14.8)(terser@5.44.0))':
dependencies:
'@babel/core': 7.28.4
'@babel/plugin-transform-react-jsx-self': 7.27.1(@babel/core@7.28.4)
@@ -13307,7 +13307,7 @@ snapshots:
'@rolldown/pluginutils': 1.0.0-beta.27
'@types/babel__core': 7.20.5
react-refresh: 0.17.0
vite: 5.4.20(@types/node@20.14.8)(terser@5.44.0)
vite: 5.4.21(@types/node@20.14.8)(terser@5.44.0)
transitivePeerDependencies:
- supports-color
@@ -13338,14 +13338,14 @@ snapshots:
chai: 5.3.3
tinyrainbow: 2.0.0
'@vitest/mocker@3.2.4(msw@2.11.4(@types/node@20.14.8)(typescript@5.8.3))(vite@5.4.20(@types/node@20.14.8)(terser@5.44.0))':
'@vitest/mocker@3.2.4(msw@2.11.4(@types/node@20.14.8)(typescript@5.8.3))(vite@5.4.21(@types/node@20.14.8)(terser@5.44.0))':
dependencies:
'@vitest/spy': 3.2.4
estree-walker: 3.0.3
magic-string: 0.30.19
optionalDependencies:
msw: 2.11.4(@types/node@20.14.8)(typescript@5.8.3)
vite: 5.4.20(@types/node@20.14.8)(terser@5.44.0)
vite: 5.4.21(@types/node@20.14.8)(terser@5.44.0)
'@vitest/pretty-format@3.2.4':
dependencies:
@@ -18484,7 +18484,7 @@ snapshots:
debug: 4.4.3
es-module-lexer: 1.7.0
pathe: 2.0.3
vite: 5.4.20(@types/node@20.14.8)(terser@5.44.0)
vite: 5.4.21(@types/node@20.14.8)(terser@5.44.0)
transitivePeerDependencies:
- '@types/node'
- less
@@ -18496,18 +18496,18 @@ snapshots:
- supports-color
- terser
vite-tsconfig-paths@4.3.2(typescript@5.8.3)(vite@5.4.20(@types/node@20.14.8)(terser@5.44.0)):
vite-tsconfig-paths@4.3.2(typescript@5.8.3)(vite@5.4.21(@types/node@20.14.8)(terser@5.44.0)):
dependencies:
debug: 4.4.1
globrex: 0.1.2
tsconfck: 3.1.6(typescript@5.8.3)
optionalDependencies:
vite: 5.4.20(@types/node@20.14.8)(terser@5.44.0)
vite: 5.4.21(@types/node@20.14.8)(terser@5.44.0)
transitivePeerDependencies:
- supports-color
- typescript
vite@5.4.20(@types/node@20.14.8)(terser@5.44.0):
vite@5.4.21(@types/node@20.14.8)(terser@5.44.0):
dependencies:
esbuild: 0.25.10
postcss: 8.5.3
@@ -18521,7 +18521,7 @@ snapshots:
dependencies:
'@types/chai': 5.2.2
'@vitest/expect': 3.2.4
'@vitest/mocker': 3.2.4(msw@2.11.4(@types/node@20.14.8)(typescript@5.8.3))(vite@5.4.20(@types/node@20.14.8)(terser@5.44.0))
'@vitest/mocker': 3.2.4(msw@2.11.4(@types/node@20.14.8)(typescript@5.8.3))(vite@5.4.21(@types/node@20.14.8)(terser@5.44.0))
'@vitest/pretty-format': 3.2.4
'@vitest/runner': 3.2.4
'@vitest/snapshot': 3.2.4
@@ -18539,7 +18539,7 @@ snapshots:
tinyglobby: 0.2.15
tinypool: 1.1.1
tinyrainbow: 2.0.0
vite: 5.4.20(@types/node@20.14.8)(terser@5.44.0)
vite: 5.4.21(@types/node@20.14.8)(terser@5.44.0)
vite-node: 3.2.4(@types/node@20.14.8)(terser@5.44.0)
why-is-node-running: 2.3.0
optionalDependencies:

View File

@@ -166,6 +166,12 @@ rec {
'';
};
packageWithDisabledCSP = package.overrideAttrs (oldAttrs: {
configurePhase = oldAttrs.configurePhase + ''
export CSP_MODE=disabled
'';
});
dockerImage = pkgs.runCommand "image-as-dir" { } ''
${(nix2containerPkgs.nix2container.buildImage {
inherit name created;
@@ -175,7 +181,7 @@ rec {
copyToRoot = pkgs.buildEnv {
name = "image";
paths = [
package
packageWithDisabledCSP
(pkgs.writeTextFile {
name = "tmp-file";
text = ''

View File

@@ -127,14 +127,14 @@ export default function AuthenticatedLayout({
className="relative flex h-full flex-row overflow-hidden"
ref={setMainNavContainer}
>
{mainNavPinned && isMdOrLarger && <PinnedMainNav />}
{withMainNav && mainNavPinned && isMdOrLarger && <PinnedMainNav />}
<div
className={cn('relative flex h-full w-full flex-row bg-accent', {
'overflow-x-auto': mainNavPinned && isMdOrLarger && withMainNav,
})}
>
{(!mainNavPinned || !isMdOrLarger) && (
{withMainNav && (!mainNavPinned || !isMdOrLarger) && (
<div className="flex h-full w-6 justify-center">
<MainNav container={mainNavContainer} />
</div>

View File

@@ -176,7 +176,7 @@ export default function AppleProviderSettings() {
loading: formState.isSubmitting,
},
}}
docsLink="https://docs.nhost.io/products/auth/social/sign-in-apple"
docsLink="https://docs.nhost.io/products/auth/providers/sign-in-apple"
docsTitle="how to sign in users with Apple"
icon={
theme.palette.mode === 'dark'

View File

@@ -141,7 +141,7 @@ export default function DiscordProviderSettings() {
loading: formState.isSubmitting,
},
}}
docsLink="https://docs.nhost.io/products/auth/social/sign-in-discord"
docsLink="https://docs.nhost.io/products/auth/providers/sign-in-discord"
docsTitle="how to sign in users with Discord"
icon="/assets/brands/discord.svg"
switchId="enabled"

View File

@@ -142,7 +142,7 @@ export default function FacebookProviderSettings() {
loading: formState.isSubmitting,
},
}}
docsLink="https://docs.nhost.io/products/auth/social/sign-in-facebook"
docsLink="https://docs.nhost.io/products/auth/providers/sign-in-facebook"
docsTitle="how to sign in users with Facebook"
icon="/assets/brands/facebook.svg"
switchId="enabled"

View File

@@ -144,7 +144,7 @@ export default function GitHubProviderSettings() {
loading: formState.isSubmitting,
},
}}
docsLink="https://docs.nhost.io/products/auth/social/sign-in-github"
docsLink="https://docs.nhost.io/products/auth/providers/sign-in-github"
docsTitle="how to sign in users with GitHub"
icon={
theme.palette.mode === 'dark'

View File

@@ -162,7 +162,7 @@ export default function GoogleProviderSettings() {
loading: formState.isSubmitting,
},
}}
docsLink="https://docs.nhost.io/products/auth/social/sign-in-google"
docsLink="https://docs.nhost.io/products/auth/providers/sign-in-google"
docsTitle="how to sign in users with Google"
icon="/assets/brands/google.svg"
switchId="enabled"

View File

@@ -142,7 +142,7 @@ export default function LinkedInProviderSettings() {
loading: formState.isSubmitting,
},
}}
docsLink="https://docs.nhost.io/products/auth/social/sign-in-linkedin"
docsLink="https://docs.nhost.io/products/auth/providers/sign-in-linkedin"
docsTitle="how to sign in users with LinkedIn"
icon="/assets/brands/linkedin.svg"
switchId="enabled"

View File

@@ -142,7 +142,7 @@ export default function SpotifyProviderSettings() {
loading: formState.isSubmitting,
},
}}
docsLink="https://docs.nhost.io/products/auth/social/sign-in-spotify"
docsLink="https://docs.nhost.io/products/auth/providers/sign-in-spotify"
docsTitle="how to sign in users with Spotify"
icon="/assets/brands/spotify.svg"
switchId="enabled"

View File

@@ -144,7 +144,7 @@ export default function TwitchProviderSettings() {
loading: formState.isSubmitting,
},
}}
docsLink="https://docs.nhost.io/products/auth/social/sign-in-twitch"
docsLink="https://docs.nhost.io/products/auth/providers/sign-in-twitch"
docsTitle="how to sign in users with Twitch"
icon={
theme.palette.mode === 'dark'

View File

@@ -177,7 +177,7 @@ export default function WorkOsProviderSettings() {
loading: formState.isSubmitting,
},
}}
docsLink="https://docs.nhost.io/products/auth/social/sign-in-workos"
docsLink="https://docs.nhost.io/products/auth/providers/sign-in-workos"
docsTitle="how to sign in users with WorkOS"
icon="/assets/brands/workos.svg"
switchId="enabled"

View File

@@ -3,7 +3,7 @@ import { generateAppServiceUrl } from '@/features/orgs/projects/common/utils/gen
import { useDatabaseQuery } from '@/features/orgs/projects/database/dataGrid/hooks/useDatabaseQuery';
import { useProject } from '@/features/orgs/projects/hooks/useProject';
import { getToastStyleProps } from '@/utils/constants/settings';
import { getHasuraAdminSecret } from '@/utils/env';
import { getHasuraAdminSecret, getHasuraMigrationsApiUrl } from '@/utils/env';
import { parseIdentifiersFromSQL } from '@/utils/sql';
import { useRouter } from 'next/router';
import { useState } from 'react';
@@ -53,7 +53,10 @@ export default function useRunSQL(
isCascade: boolean,
) => {
try {
const migrationApiResponse = await fetch(`${appUrl}/apis/migrate`, {
const url = isPlatform
? `${appUrl}/apis/migrate`
: getHasuraMigrationsApiUrl();
const migrationApiResponse = await fetch(url, {
method: 'POST',
headers: { 'x-hasura-admin-secret': adminSecret },
body: JSON.stringify({

View File

@@ -0,0 +1,165 @@
import { nhostRoutesClient } from '@/utils/nhost';
import type { NextApiRequest, NextApiResponse } from 'next';
export type CreateTicketRequest = {
project: string;
services: Array<{ label: string; value: string }>;
priority: string;
subject: string;
description: string;
userName: string;
userEmail: string;
};
export type CreateTicketResponse = {
success: boolean;
error?: string;
};
type GetProjectResponse = {
apps: Array<{
id: string;
}>;
};
export default async function handler(
req: NextApiRequest,
res: NextApiResponse<CreateTicketResponse>,
) {
if (req.method !== 'POST') {
return res
.status(405)
.json({ success: false, error: 'Method not allowed' });
}
try {
const {
project,
services,
priority,
subject,
description,
userName,
userEmail,
} = req.body as CreateTicketRequest;
// Validate required environment variables
if (
!process.env.NEXT_ZENDESK_USER_EMAIL ||
!process.env.NEXT_ZENDESK_API_KEY ||
!process.env.NEXT_ZENDESK_URL
) {
return res.status(500).json({
success: false,
error: 'Zendesk configuration is missing',
});
}
// Validate required fields
if (
!project ||
!services ||
!priority ||
!subject ||
!description ||
!userName ||
!userEmail
) {
return res.status(400).json({
success: false,
error: 'Missing required fields',
});
}
const token = req.headers.authorization?.split(' ')[1];
try {
// we use this to verify the owner of the JWT token has access to the project
const resp = await nhostRoutesClient.graphql.request<GetProjectResponse>(
{
query: `query GetProject($subdomain: String!){
apps(where: {subdomain: {_eq: $subdomain}}) {
id
}
}`,
variables: {
subdomain: project,
},
},
{
headers: {
Authorization: `Bearer ${token}`,
},
},
);
if (resp.body.data?.apps.length !== 1) {
return res.status(400).json({
success: false,
error: 'Invalid project subdomain',
});
}
} catch (error) {
return res.status(400).json({
success: false,
error: 'Invalid project subdomain',
});
}
const auth = btoa(
`${process.env.NEXT_ZENDESK_USER_EMAIL}/token:${process.env.NEXT_ZENDESK_API_KEY}`,
);
const response = await fetch(
`${process.env.NEXT_ZENDESK_URL}/api/v2/requests.json`,
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: `Basic ${auth}`,
},
body: JSON.stringify({
request: {
subject,
comment: {
body: description,
},
priority,
requester: {
name: userName,
email: userEmail,
},
custom_fields: [
// these custom field IDs come from zendesk
{
id: 19502784542098,
value: project,
},
{
id: 19922709880978,
value: services.map((service) => service.value?.toLowerCase()),
},
],
},
}),
},
);
if (!response.ok) {
const errorText = await response.text();
console.error('Zendesk API error:', errorText);
return res.status(response.status).json({
success: false,
error: `Failed to create ticket: ${response.statusText}`,
});
}
return res.status(200).json({ success: true });
} catch (error) {
console.error('Error creating ticket:', error);
return res.status(500).json({
success: false,
error: 'An unexpected error occurred',
});
}
}

View File

@@ -12,7 +12,9 @@ function SupportPage() {
return (
<Box className="h-full overflow-auto pb-4">
<Box className="flex w-full justify-start border-b-1 px-4 py-3">
<Logo className="w-6 cursor-pointer" />
<Link href="https://app.nhost.io" rel="noopener noreferrer">
<Logo className="w-6" />
</Link>
</Box>
<div className="flex flex-col items-center justify-center">

View File

@@ -5,11 +5,11 @@ import { AuthenticatedLayout } from '@/components/layout/AuthenticatedLayout';
import { Box } from '@/components/ui/v2/Box';
import { Button } from '@/components/ui/v2/Button';
import { Divider } from '@/components/ui/v2/Divider';
import { EnvelopeIcon } from '@/components/ui/v2/icons/EnvelopeIcon';
import { Input, inputClasses } from '@/components/ui/v2/Input';
import { Option } from '@/components/ui/v2/Option';
import { Text } from '@/components/ui/v2/Text';
import { execPromiseWithErrorToast } from '@/features/orgs/utils/execPromiseWithErrorToast';
import { useAccessToken } from '@/hooks/useAccessToken';
import { useUserData } from '@/hooks/useUserData';
import {
useGetOrganizationsQuery,
@@ -17,6 +17,7 @@ import {
} from '@/utils/__generated__/graphql';
import { yupResolver } from '@hookform/resolvers/yup';
import { styled } from '@mui/material';
import { Mail } from 'lucide-react';
import { type ReactElement } from 'react';
import { FormProvider, useForm } from 'react-hook-form';
import * as Yup from 'yup';
@@ -27,7 +28,7 @@ type Organization = Omit<
>;
const validationSchema = Yup.object({
organization: Yup.string().label('Organization'),
organization: Yup.string().label('Organization').required(),
project: Yup.string().label('Project').required(),
services: Yup.array()
.of(Yup.object({ label: Yup.string(), value: Yup.string() }))
@@ -36,7 +37,6 @@ const validationSchema = Yup.object({
priority: Yup.string().label('Priority').required(),
subject: Yup.string().label('Subject').required(),
description: Yup.string().label('Description').required(),
ccs: Yup.string().label('CCs').optional(),
});
export type CreateTicketFormValues = Yup.InferType<typeof validationSchema>;
@@ -58,7 +58,6 @@ function TicketPage() {
priority: '',
subject: '',
description: '',
ccs: '',
},
resolver: yupResolver(validationSchema),
});
@@ -71,6 +70,7 @@ function TicketPage() {
const selectedOrganization = watch('organization');
const user = useUserData();
const token = useAccessToken();
const { data: organizationsData } = useGetOrganizationsQuery({
variables: {
@@ -91,56 +91,32 @@ function TicketPage() {
};
const handleSubmit = async (formValues: CreateTicketFormValues) => {
const { project, services, priority, subject, description, ccs } =
formValues;
const auth = btoa(
`${process.env.NEXT_PUBLIC_ZENDESK_USER_EMAIL}/token:${process.env.NEXT_PUBLIC_ZENDESK_API_KEY}`,
);
const emails = ccs
?.replace(/ /g, '')
.split(',')
.map((email) => ({ user_email: email }));
const { project, services, priority, subject, description } = formValues;
await execPromiseWithErrorToast(
async () => {
await fetch(
`${process.env.NEXT_PUBLIC_ZENDESK_URL}/api/v2/requests.json`,
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: `Basic ${auth}`,
},
body: JSON.stringify({
request: {
subject,
comment: {
body: description,
},
priority,
requester: {
name: user?.displayName,
email: user?.email,
},
email_ccs: emails,
custom_fields: [
// these custom field IDs come from zendesk
{
id: 19502784542098,
value: project,
},
{
id: 19922709880978,
value: services.map((service) =>
service.value?.toLowerCase(),
),
},
],
},
}),
const response = await fetch('/api/support/create-ticket', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: `Bearer ${token}`,
},
);
body: JSON.stringify({
project,
services,
priority,
subject,
description,
userName: user?.displayName,
userEmail: user?.email,
}),
});
if (!response.ok) {
const error = await response.json();
throw new Error(error.error || 'Failed to create ticket');
}
form.reset();
},
{
@@ -191,7 +167,7 @@ function TicketPage() {
>
{organizations.map((organization) => (
<Option
key={organization.name}
key={organization.id}
value={organization.id}
label={organization.name}
>
@@ -261,6 +237,8 @@ function TicketPage() {
slotProps={{
root: { className: 'grid grid-flow-col gap-1 mb-4' },
}}
error={!!errors.priority}
helperText={errors.priority?.message}
renderValue={(option) => (
<span className="inline-grid grid-flow-col items-center gap-2">
{option?.label}
@@ -310,7 +288,6 @@ function TicketPage() {
label="Subject"
placeholder="Summary of the problem you are experiencing"
fullWidth
autoFocus
inputProps={{ min: 2, max: 128 }}
error={!!errors.subject}
helperText={errors.subject?.message}
@@ -330,31 +307,16 @@ function TicketPage() {
helperText={errors.description?.message}
/>
<Divider />
<Text className="mt-4 font-bold">Notifications</Text>
<StyledInput
{...register('ccs')}
id="ccs"
label="CCs"
placeholder="Comma separated list of emails you want to share this ticket with."
fullWidth
inputProps={{ min: 2, max: 128 }}
error={!!errors.ccs}
helperText={errors.ccs?.message}
/>
<Box className="ml-auto flex w-80 flex-col gap-4">
<Box className="ml-auto flex flex-col gap-4 lg:w-80">
<Text color="secondary" className="text-right text-sm">
We will contact you at <strong>{user?.email}</strong>
</Text>
<Button
variant="outlined"
className="hover:!bg-white hover:!bg-opacity-10 focus:ring-0"
className="text-base hover:!bg-white hover:!bg-opacity-10 focus:ring-0"
size="large"
type="submit"
startIcon={<EnvelopeIcon />}
startIcon={<Mail className="size-4" />}
disabled={isSubmitting}
loading={isSubmitting}
>
@@ -373,7 +335,7 @@ function TicketPage() {
TicketPage.getLayout = function getLayout(page: ReactElement) {
return (
<AuthenticatedLayout title="Help & Support | Nhost">
<AuthenticatedLayout title="Help & Support | Nhost" withMainNav={false}>
{page}
</AuthenticatedLayout>
);

View File

@@ -4,7 +4,7 @@ import {
getGraphqlServiceUrl,
getStorageServiceUrl,
} from '@/utils/env';
import { createClient } from '@nhost/nhost-js';
import { createClient, createNhostClient } from '@nhost/nhost-js';
import { type Session, type SessionStorageBackend } from '@nhost/nhost-js/session';
const nhost = createClient({
@@ -14,6 +14,13 @@ const nhost = createClient({
storageUrl: getStorageServiceUrl(),
});
const nhostRoutesClient = createNhostClient({
authUrl: getAuthServiceUrl(),
graphqlUrl: getGraphqlServiceUrl(),
functionsUrl: getFunctionsServiceUrl(),
storageUrl: getStorageServiceUrl(),
});
export class DummySessionStorage implements SessionStorageBackend {
private session: Session | null = null;
@@ -41,4 +48,5 @@ export class DummySessionStorage implements SessionStorageBackend {
}
}
export { nhostRoutesClient };
export default nhost;

View File

@@ -122,29 +122,37 @@
"group": "Sign In Methods",
"pages": [
{
"group": "Social Providers",
"group": "Providers",
"icon": "at",
"pages": [
"products/auth/social/sign-in-apple",
"products/auth/social/sign-in-azuread",
"products/auth/social/sign-in-discord",
"products/auth/social/sign-in-entraid",
"products/auth/social/sign-in-facebook",
"products/auth/social/sign-in-github",
"products/auth/social/sign-in-google",
"products/auth/social/sign-in-linkedin",
"products/auth/social/sign-in-spotify",
"products/auth/social/sign-in-twitch",
"products/auth/social/sign-in-workos"
"products/auth/providers/overview",
"products/auth/providers/tokens",
"products/auth/providers/connect",
"products/auth/providers/idtokens",
{
"group": "Configuration",
"icon": "gear",
"pages": [
"products/auth/providers/sign-in-apple",
"products/auth/providers/sign-in-azuread",
"products/auth/providers/sign-in-discord",
"products/auth/providers/sign-in-entraid",
"products/auth/providers/sign-in-facebook",
"products/auth/providers/sign-in-github",
"products/auth/providers/sign-in-google",
"products/auth/providers/sign-in-linkedin",
"products/auth/providers/sign-in-spotify",
"products/auth/providers/sign-in-twitch",
"products/auth/providers/sign-in-workos"
]
}
]
},
"/products/auth/social-connect",
"/products/auth/sign-in-email-password",
"/products/auth/sign-in-otp",
"/products/auth/sign-in-magic-link",
"/products/auth/sign-in-sms-otp",
"/products/auth/webauthn",
"/products/auth/idtokens"
"/products/auth/webauthn"
]
},
{
@@ -152,7 +160,6 @@
"icon": "diagram-project",
"pages": [
"/products/auth/workflows/email-password",
"/products/auth/workflows/oauth-providers",
"/products/auth/workflows/passwordless-email",
"/products/auth/workflows/passwordless-sms",
"/products/auth/workflows/webauthn",
@@ -352,6 +359,7 @@
"reference/auth/post-signin-pat",
"reference/auth/get-signin-provider-{provider}",
"reference/auth/get-signin-provider-{provider}-callback",
"reference/auth/get-signin-provider-{provider}-callback-tokens",
"reference/auth/post-signin-provider-{provider}-callback",
"reference/auth/post-signin-webauthn",
"reference/auth/post-signin-webauthn-verify",
@@ -360,6 +368,7 @@
"reference/auth/post-signup-webauthn",
"reference/auth/post-signup-webauthn-verify",
"reference/auth/post-token",
"reference/auth/post-token-provider-{provider}",
"reference/auth/post-token-verify",
"reference/auth/get-user",
"reference/auth/post-user-deanonymize",
@@ -704,6 +713,20 @@
}
]
},
"redirects": [
{
"source": "/products/auth/social/:slug*",
"destination": "/products/auth/providers/:slug*"
},
{
"source": "/products/auth/social-connect",
"destination": "products/auth/providers/connect"
},
{
"source": "/products/auth/idtokens",
"destination": "products/auth/providers/idtokens"
}
],
"logo": {
"light": "/images/logo/light.svg",
"dark": "/images/logo/dark.svg"

View File

@@ -62,6 +62,7 @@ function build_typedoc() {
function build_cli_docs() {
echo "⚒️⚒️⚒️ Building CLI documentation..."
cli docs > reference/cli/commands.mdx
cat reference/cli/commands.mdx
}
build_openapi

View File

Before

Width:  |  Height:  |  Size: 245 KiB

After

Width:  |  Height:  |  Size: 245 KiB

View File

@@ -120,21 +120,26 @@ sender = 'myapp@mydomain.com'
It is very important that the `host` is set exactly to `postmark`.
</Warning>
2. In postmark you need to create thre templates for each locale with the following alias:
2. In postmark you need to create three templates for each locale with the following alias:
- $locale.email-change
- $locale.email-confirm-change
- $locale.email-verify
- $locale.password-reset
For instance:
- en.email-change
- en.email-confirm-change
- en.email-verify
- en.password-reset
- se.email-change
- se.email-confirm-change
- se.email-verify
- se.password-reset
Additionally, if you want to use the passwordless sign-in or OTP sign-in emails, you need to create the following templates as well:
- $locale.signin-passwordless
- $locale.signin-otp
After these two steps have been completed, the Auth service will leverage these templates instead of the ones described in the previous section.
<Note>

View File

@@ -19,7 +19,7 @@ Nhost Auth is a ready-to-use authentication service seamlessly integrated with t
</Card>
<Card title="Security Keys (WebAuthn)" icon="square-5" href="/products/auth/webauthn">
</Card>
<Card title="ID Tokens" icon="square-6" href="/products/auth/idtokens">
<Card title="ID Tokens" icon="square-6" href="/products/auth/providers/idtokens">
</Card>
<Card title="Elevated Permissions" icon="square-7" href="/products/auth/elevated-permissions">
</Card>
@@ -28,24 +28,24 @@ Nhost Auth is a ready-to-use authentication service seamlessly integrated with t
### OAuth Providers
<CardGroup cols={4}>
<Card title="Apple" icon="apple" href="/products/auth/social/sign-in-apple">
<Card title="Apple" icon="apple" href="/products/auth/providers/sign-in-apple">
</Card>
<Card title="Discord" icon="discord" href="/products/auth/social/sign-in-discord">
<Card title="Discord" icon="discord" href="/products/auth/providers/sign-in-discord">
</Card>
<Card title="Entra ID" icon="microsoft" href="/products/auth/social/sign-in-entraid">
<Card title="Entra ID" icon="microsoft" href="/products/auth/providers/sign-in-entraid">
</Card>
<Card title="Facebook" icon="facebook" href="/products/auth/social/sign-in-facebook">
<Card title="Facebook" icon="facebook" href="/products/auth/providers/sign-in-facebook">
</Card>
<Card title="GitHub" icon="github" href="/products/auth/social/sign-in-github">
<Card title="GitHub" icon="github" href="/products/auth/providers/sign-in-github">
</Card>
<Card title="Google" icon="google" href="/products/auth/social/sign-in-google">
<Card title="Google" icon="google" href="/products/auth/providers/sign-in-google">
</Card>
<Card title="Linkedin" icon="linkedin" href="/products/auth/social/sign-in-linkedin">
<Card title="Linkedin" icon="linkedin" href="/products/auth/providers/sign-in-linkedin">
</Card>
<Card title="Spotify" icon="spotify" href="/products/auth/social/sign-in-spotify">
<Card title="Spotify" icon="spotify" href="/products/auth/providers/sign-in-spotify">
</Card>
<Card title="Twitch" icon="twitch" href="/products/auth/social/sign-in-twitch">
<Card title="Twitch" icon="twitch" href="/products/auth/providers/sign-in-twitch">
</Card>
<Card title="WorkOS" icon="square-9" href="/products/auth/social/sign-in-workos">
<Card title="WorkOS" icon="square-9" href="/products/auth/providers/sign-in-workos">
</Card>
</CardGroup>

View File

@@ -0,0 +1,41 @@
---
title: Connecting existing users
sidebarTitle: Connecting existing users
description: Connect a provider to existing user accounts
icon: link
---
With the provider connect feature, users can link configured providers with their account, regardless of the initial sign-up method. It enables users to link different providers to their accounts, even if the email addresses do not match (e.g., linking a GitHub profile to an account registered with a different email). This feature offers flexibility, allowing users to streamline their login process by connecting multiple authentication methods.
To add a provider authentication method to an existing user you need to call the url `https://${subdomain}.auth.${region}.nhost.run/v1/signin/provider/${provider}?connect=${jwt}`. This is very easy to achieve with our SDK:
``` js
nhost.auth.connectProvider({
provider: 'github'
})
```
<Note>
Keep in mind that as we need a `JWT` the user needs to be logged in.
</Note>
## Viewing and Deleting Provider Authentication Mechanisms
If you want to allow your users to view and/or delete provider authentication mechanisms, you can provide the necessary permissions to the table `auth.user_providers` (i.e. `select` and/or `delete`) and then use the appropriate GraphQL query. For example, the following permissions should allow users to list their own providers:
![provider connect permissions](/images/auth/provider-connect-permissions.png)
Using the following GraphQL query:
``` js
const { error, data } = await nhost.graphql.request(
gql`
query getAuthUserProviders {
authUserProviders {
id
providerId
}
}
`,
)
```

View File

@@ -13,7 +13,9 @@ ID tokens serve as a secure proof that a user has already been authenticated by
## Usage
To use ID tokens, you need to configure supported identity providers (currently [apple](/products/auth/social/sign-in-apple) and [google](/products/auth/social/sign-in-google)) and make sure the `audience` is set correctly.
<Note>
To use ID tokens, you need to configure supported identity providers (currently [apple](/products/auth/providers/sign-in-apple) and [google](/products/auth/providers/sign-in-google)) and make sure the `audience` is set correctly.
</Note>
### Sign in
@@ -41,7 +43,7 @@ Once everything is configured you can use an ID token to authenticate users with
### Link Provider to existing user
Similarly to the [Social Connect](/products/auth/social-connect) feature, you can link an identity provider to an existing user:
Similarly to the [Provider Connect](/products/auth/providers/connect) feature, you can link an identity provider to an existing user:
<Tabs>
<Tab title="javascript">
@@ -69,10 +71,4 @@ Below you can find some examples on how to extract an ID Token from various iden
### React Native
#### Apple
For an example on how to authenticate using "Sign in with Apple" on iOS using React Native you can refer to our [sample component](https://github.com/nhost/nhost/blob/main/examples/react_native/src/components/SignInWithAppleButton.tsx).
#### Google
For an example on how to authenticate using "Sign in with Google" on Android using React Native you can refer to our [sample component](https://github.com/nhost/nhost/blob/main/examples/react_native/src/components/SignInWithGoogleButton.tsx).
Please, refer to our [React Native Tutorial](/getting-started/tutorials/reactnative/1-introduction) on how to implement Sign in with Apple and Google Sign-In in your React Native app.

View File

@@ -0,0 +1,61 @@
---
title: Overview
sidebarTitle: Overview
description: Learn how OAuth2 authentication works with Nhost
icon: at
---
OAuth2 providers allow users to sign in to your Nhost application using their existing accounts from popular services like Google, GitHub, Apple, and many others. This eliminates the need for users to create and remember new credentials while providing a secure authentication method.
## How OAuth2 Authentication Works
When a user authenticates with an OAuth2 provider through Nhost, the following workflow occurs:
```mermaid
sequenceDiagram
autonumber
actor U as User
participant A as Auth
participant P as Oauth Provider
participant F as Frontend
U->>+A: HTTP GET /signin/provider/{provider}
A->>+P: Provider's authentication
deactivate A
P->>-A: HTTP GET /signin/provider/{provider}/callback
activate A
opt No user found
A->>A: Create user
end
A->>A: Flag user email as verified
A->>+F: HTTP redirect with refresh token
deactivate A
F->>-U: HTTP OK response
opt
U->>+A: HTTP POST /token
A->>-U: HTTP OK response
Note left of A: Refresh token + access token
end
```
<Snippet file="workflows/oauth-providers.mdx" />
### The Authentication Flow
1. **Initiation**: The user starts the authentication process by making a request to `/signin/provider/{provider}` (e.g., `/signin/provider/google`)
2. **Provider Authentication**: Auth redirects the user to the OAuth2 provider's authentication page where they log in and grant permissions
3. **Callback**: After successful authentication, the provider redirects back to Auth at `/signin/provider/{provider}/callback` with an authorization code
4. **User Management**: Auth processes the callback:
- If this is a new user, a user account is automatically created
- The user's email is flagged as verified (since the OAuth2 provider has already verified it)
5. **Token Issuance**: The user is redirected back to your frontend application with a refresh token
## Benefits of OAuth2 Authentication
- **Improved User Experience**: Users can sign in with accounts they already have
- **Enhanced Security**: No need to manage passwords; authentication is handled by established providers
- **Verified Emails**: Email addresses are automatically verified through the OAuth2 provider
- **Reduced Registration Friction**: Faster onboarding with one-click sign-in

View File

@@ -1,7 +1,7 @@
---
title: Sign In with WorkOS
description: Follow this guide to sign in users with WorkOS.
icon: workos
icon: W
---

View File

@@ -0,0 +1,137 @@
---
title: OAuth Provider Access Tokens
sidebarTitle: Tokens
description: Access and refresh OAuth provider tokens to interact with external APIs
icon: key
---
When users authenticate with OAuth providers through Nhost, you can access the provider's access and refresh tokens. This enables your application to make API calls directly to external services (like Google Drive, GitHub repositories, or Spotify playlists) on behalf of your users.
## How Provider Token Management Works
After a user completes OAuth authentication, you can retrieve and manage the provider's tokens to interact with their external accounts:
```mermaid
sequenceDiagram
autonumber
actor U as User
participant F as Frontend
participant A as Auth
participant P as OAuth Provider
Note over U,P: Initial OAuth Sign-In
U->>+F: Complete OAuth sign-in
F->>+A: GET /signin/provider/{provider}/callback/tokens
Note right of A: Bearer token required
A->>A: Retrieve stored provider session
A->>-F: Provider tokens (access, refresh, expiresIn)
F->>F: Store tokens securely
deactivate F
Note over U,P: Using Provider Access Token
U->>+F: Request action requiring provider API
F->>+P: API call with provider access token
P->>-F: API response
F->>-U: Result
Note over U,P: Refreshing Expired Token
F->>F: Detect token expiration
F->>+A: POST /token/provider/{provider}
Note right of A: Include refresh token
A->>+P: Request new access token
P->>-A: New access token (+ optional new refresh token)
A->>-F: Updated tokens
F->>F: Update stored tokens
```
### The Token Flow
1. **OAuth Completion**: After the user successfully authenticates with an OAuth provider, they are redirected back to your application
2. **Token Retrieval**: Your frontend immediately calls `/signin/provider/{provider}/callback/tokens` with the user's Nhost authentication token to retrieve the provider's tokens
3. **Secure Storage**: The provider's access token, refresh token, and expiration time are stored securely in your application
4. **Provider API Calls**: Your application uses the provider's access token to make API calls to the external service on behalf of the user
5. **Token Refresh**: When the access token expires, your application uses the refresh token to obtain a new access token without requiring the user to re-authenticate
## Retrieving Provider Tokens
After a successful OAuth sign-in, retrieve the provider's session to access their tokens.
```javascript
import { createClient } from '@nhost/nhost-js'
const nhost = createClient({
subdomain: 'myapp',
region: 'us-east-1'
})
// Immediately after OAuth callback completes
const resp = await nhost.auth.getProviderTokens('google')
// Store tokens securely
localStorage.setItem('google_access_token', resp.body.accessToken)
if (resp.body.refreshToken) {
localStorage.setItem('google_refresh_token', resp.body.refreshToken)
}
// Use provider token to call Google APIs
const userInfo = await fetch('https://www.googleapis.com/oauth2/v2/userinfo', {
headers: {
'Authorization': `Bearer ${resp.body.accessToken}`
}
})
```
**Important Notes:**
- This method must be called **immediately** after the OAuth callback completes
- The provider session is stored temporarily and is cleared during this call
- Subsequent calls will fail without re-authenticating with the provider
- Requires the user to be authenticated with Nhost
## Refreshing Provider Tokens
Provider access tokens typically expire after a short period (often 1 hour). Use the refresh token to obtain a new access token without user interaction.
```javascript
import { createClient } from '@nhost/nhost-js'
const nhost = createClient({
subdomain: 'myapp',
region: 'us-east-1'
})
// Retrieve stored refresh token
const storedRefreshToken = localStorage.getItem('google_refresh_token')
// Refresh the provider tokens
const resp = await nhost.auth.refreshProviderToken('google', {
refreshToken: storedRefreshToken
})
// Update stored tokens
localStorage.setItem('google_access_token', resp.body.accessToken)
if (resp.body.refreshToken) {
// Some providers rotate refresh tokens
localStorage.setItem('google_refresh_token', resp.body.refreshToken)
}
```
**Important Notes:**
- Some providers (like Google) rotate refresh tokens, returning a new one in the response
- Always update your stored refresh token with the new value if provided
- Token refresh can fail if the user revokes access or the refresh token expires
- Handle these cases by prompting the user to re-authenticate
## Best Practices
**Immediate Retrieval** - Call the tokens endpoint immediately after OAuth callback to prevent session loss
**Secure Storage** - Store provider tokens in secure storage appropriate for your platform (encrypted storage for mobile, httpOnly cookies or secure localStorage for web)
**Proactive Refresh** - Use the `expiresIn` value to refresh tokens before they expire, preventing API call failures
**Handle Rotation** - Always update your stored refresh token when a new one is returned, as some providers invalidate old refresh tokens
**Graceful Errors** - Handle token refresh failures by prompting users to re-authenticate, as they may have revoked access through the provider's settings
**Token Isolation** - Store tokens per provider and per user to support multiple OAuth connections

View File

@@ -1,43 +0,0 @@
---
title: Social Provider Connect
sidebarTitle: Social Provider Connect
description: Add social sign in mechanism to existing users
icon: link
---
With the social provider connect feature, users can link their social authentication method to their account, regardless of the initial sign-up method. It enables users to link different social authentication providers to their accounts, even if the email addresses do not match (e.g., linking a GitHub profile to an account registered with a different email). This feature offers flexibility, allowing users to streamline their login process by connecting multiple authentication methods.
To add a social authentication method to an existing user you need to call the url `https://${subdomain}.auth.${region}.nhost.run/v1/signin/provider/${provider}?connect=${jwt}`. This is very easy to achieve with our SDK:
``` js
nhost.auth.connectProvider({
provider: 'github'
})
```
In addition, hooks for react, vue and other frameworks may be provided. Check our [reference](/reference/overview#client-libraries) documentation for more details.
<Note>
Keep in mind that as we need a `JWT` the user needs to be logged in.
</Note>
## Viewing and Deleting Social Provider Authentication Mechanisms
If you want to allow your users to view and/or delete social provider authentication mechanisms, you can provide the necessary permissions to the table `auth.user_providers` (i.e. `select` and/or `delete`) and then use the appropriate GraphQL query. For example, the following permissions should allow users to list their own social providers:
![social connect permissions](/images/auth/social-connect-permissions.png)
Using the following GraphQL query:
``` js
const { error, data } = await nhost.graphql.request(
gql`
query getAuthUserProviders {
authUserProviders {
id
providerId
}
}
`,
)
```

View File

@@ -1,25 +0,0 @@
```mermaid
sequenceDiagram
autonumber
actor U as User
participant A as Hasura Auth
participant P as Oauth Provider
participant F as Frontend
U->>+A: HTTP GET /signin/provider/{provider}
A->>+P: Provider's authentication
deactivate A
P->>-A: HTTP GET /signin/provider/{provider}/callback
activate A
opt No user found
A->>A: Create user
end
A->>A: Flag user email as verified
A->>+F: HTTP redirect with refresh token
deactivate A
F->>-U: HTTP OK response
opt
U->>+A: HTTP POST /token
A->>-U: HTTP OK response
Note left of A: Refresh token + access token
end
```

View File

@@ -592,6 +592,12 @@ paths:
If set, this means that the user is already authenticated and wants to link their account. This needs to be a valid JWT access token.
schema:
type: string
- name: state
in: query
required: false
description: Opaque state value to be returned by the provider
schema:
type: string
responses:
"302":
@@ -738,6 +744,31 @@ paths:
$ref: "#/components/schemas/ErrorResponse"
description: "An error occurred while processing the request"
/signin/provider/{provider}/callback/tokens:
get:
summary: Retrieve OAuth2 provider tokens from callback
description: After successful OAuth2 authentication, retrieve the provider session containing access token, refresh token, and expiration information for the specified provider. To ensure the data isn't stale this endpoint must be called immediately after the OAuth callback to obtain the tokens. The session is cleared from the database during this call, so subsequent calls will fail without going through the sign-in flow again. It is the user's responsibility to store the session safely (e.g., in browser local storage).
operationId: getProviderTokens
tags:
- authentication
security:
- BearerAuth: []
parameters:
- $ref: "#/components/parameters/SignInProvider"
responses:
"200":
description: Successfully retrieved provider session
content:
application/json:
schema:
$ref: "#/components/schemas/ProviderSession"
default:
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: "An error occurred while processing the request"
/signin/webauthn:
post:
summary: Sign in with Webauthn
@@ -954,6 +985,38 @@ paths:
$ref: "#/components/schemas/ErrorResponse"
description: "An error occurred while processing the request"
/token/provider/{provider}:
post:
summary: Refresh OAuth2 provider tokens
description: Refresh the OAuth2 provider access token using a valid refresh token. Returns a new provider session with updated access token, refresh token (if rotated by provider), and expiration information. This endpoint allows maintaining long-lived access to provider APIs without requiring the user to re-authenticate.
operationId: refreshProviderToken
tags:
- authentication
security:
- BearerAuth: []
parameters:
- $ref: "#/components/parameters/SignInProvider"
requestBody:
description: Provider refresh token to exchange for a new access token
content:
application/json:
schema:
$ref: "#/components/schemas/RefreshProviderTokenRequest"
required: true
responses:
"200":
description: Successfully refreshed provider tokens
content:
application/json:
schema:
$ref: "#/components/schemas/ProviderSession"
default:
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: "An error occurred while processing the request"
/token/verify:
post:
summary: Verify JWT token
@@ -1308,7 +1371,7 @@ components:
BearerAuthElevated:
type: http
scheme: bearer
description: "Bearer authentication that requires elevated permissions. Used for sensitive operations that may require additional security measures such as recent authentication. For details see https://docs.nhost.io/guides/auth/elevated-permissions"
description: "Bearer authentication that requires elevated permissions. Used for sensitive operations that may require additional security measures such as recent authentication. For details see https://docs.nhost.io/products/auth/elevated-permissions"
schemas:
AttestationFormat:
@@ -1814,6 +1877,46 @@ components:
required:
- challenge
ProviderSession:
type: object
description: "OAuth2 provider session containing access and refresh tokens"
additionalProperties: false
properties:
accessToken:
type: string
description: "OAuth2 provider access token for API calls"
example: "ya29.a0AfH6SMBx..."
expiresIn:
type: integer
description: "Number of seconds until the access token expires"
example: 3599
expiresAt:
type: string
format: date-time
description: "Timestamp when the access token expires"
example: "2024-12-31T23:59:59Z"
refreshToken:
type: string
nullable: true
description: "OAuth2 provider refresh token for obtaining new access tokens (if provided by the provider)"
example: "1//0gK8..."
required:
- accessToken
- expiresIn
- expiresAt
RefreshProviderTokenRequest:
type: object
description: "Request to refresh OAuth2 provider tokens"
additionalProperties: false
properties:
refreshToken:
type: string
description: "OAuth2 provider refresh token obtained from previous authentication"
example: "1//0gK8..."
required:
- refreshToken
RefreshTokenRequest:
type: object
description: "Request to refresh an access token"
@@ -2512,7 +2615,6 @@ components:
- facebook
- windowslive
- twitter
deprecated: true
TicketQuery:
in: query

View File

@@ -0,0 +1,5 @@
---
title: "getProviderTokens"
openapi: get /signin/provider/{provider}/callback/tokens
sidebarTitle: /signin/provider/{provider}/callback/tokens
---

View File

@@ -0,0 +1,5 @@
---
title: "refreshProviderToken"
openapi: post /token/provider/{provider}
sidebarTitle: /token/provider/{provider}
---

View File

@@ -254,7 +254,7 @@ Start local development environment
**--ca-certificates**="": Mounts and everrides path to CA certificates in the containers
**--dashboard-version**="": Dashboard version to use (default: nhost/dashboard:2.38.4)
**--dashboard-version**="": Dashboard version to use (default: nhost/dashboard:2.40.0)
**--disable-tls**: Disable TLS
@@ -284,7 +284,7 @@ Start local development environment connected to an Nhost Cloud project (BETA)
**--ca-certificates**="": Mounts and everrides path to CA certificates in the containers
**--dashboard-version**="": Dashboard version to use (default: nhost/dashboard:2.38.4)
**--dashboard-version**="": Dashboard version to use (default: nhost/dashboard:2.40.0)
**--disable-tls**: Disable TLS

View File

@@ -468,6 +468,30 @@ This method may return different T based on the response code:
`Promise`&lt;[`FetchResponse`](./fetch#fetchresponse)&lt;[`JWKSet`](#jwkset)&gt;&gt;
#### getProviderTokens()
```ts
getProviderTokens(provider: SignInProvider, options?: RequestInit): Promise<FetchResponse<ProviderSession>>;
```
Summary: Retrieve OAuth2 provider tokens from callback
After successful OAuth2 authentication, retrieve the provider session containing access token, refresh token, and expiration information for the specified provider. To ensure the data isn't stale this endpoint must be called immediately after the OAuth callback to obtain the tokens. The session is cleared from the database during this call, so subsequent calls will fail without going through the sign-in flow again. It is the user's responsibility to store the session safely (e.g., in browser local storage).
This method may return different T based on the response code:
- 200: ProviderSession
##### Parameters
| Parameter | Type |
| ---------- | ----------------------------------- |
| `provider` | [`SignInProvider`](#signinprovider) |
| `options?` | `RequestInit` |
##### Returns
`Promise`&lt;[`FetchResponse`](./fetch#fetchresponse)&lt;[`ProviderSession`](#providersession)&gt;&gt;
#### getUser()
```ts
@@ -602,6 +626,34 @@ Add a middleware function to the fetch chain
`void`
#### refreshProviderToken()
```ts
refreshProviderToken(
provider: SignInProvider,
body: RefreshProviderTokenRequest,
options?: RequestInit): Promise<FetchResponse<ProviderSession>>;
```
Summary: Refresh OAuth2 provider tokens
Refresh the OAuth2 provider access token using a valid refresh token. Returns a new provider session with updated access token, refresh token (if rotated by provider), and expiration information. This endpoint allows maintaining long-lived access to provider APIs without requiring the user to re-authenticate.
This method may return different T based on the response code:
- 200: ProviderSession
##### Parameters
| Parameter | Type |
| ---------- | ------------------------------------------------------------- |
| `provider` | [`SignInProvider`](#signinprovider) |
| `body` | [`RefreshProviderTokenRequest`](#refreshprovidertokenrequest) |
| `options?` | `RequestInit` |
##### Returns
`Promise`&lt;[`FetchResponse`](./fetch#fetchresponse)&lt;[`ProviderSession`](#providersession)&gt;&gt;
#### refreshToken()
```ts
@@ -1605,6 +1657,54 @@ Format - uri
---
## ProviderSession
OAuth2 provider session containing access and refresh tokens
### Properties
#### accessToken
```ts
accessToken: string
```
(`string`) - OAuth2 provider access token for API calls
- Example - `"ya29.a0AfH6SMBx..."`
#### expiresAt
```ts
expiresAt: string
```
(`string`) - Timestamp when the access token expires
- Example - `"2024-12-31T23:59:59Z"`
- Format - date-time
#### expiresIn
```ts
expiresIn: number
```
(`number`) - Number of seconds until the access token expires
- Example - `3599`
#### refreshToken?
```ts
optional refreshToken: string;
```
OAuth2 provider refresh token for obtaining new access tokens (if provided by the provider)
Example - `"1//0gK8..."`
---
## PublicKeyCredentialCreationOptions
### Properties
@@ -1795,6 +1895,24 @@ A requirement for user verification for the operation
---
## RefreshProviderTokenRequest
Request to refresh OAuth2 provider tokens
### Properties
#### refreshToken
```ts
refreshToken: string
```
(`string`) - OAuth2 provider refresh token obtained from previous authentication
- Example - `"1//0gK8..."`
---
## RefreshTokenRequest
Request to refresh an access token
@@ -2295,6 +2413,14 @@ optional redirectTo: string;
URI to redirect to
#### state?
```ts
optional state: string;
```
Opaque state value to be returned by the provider
---
## SignInWebauthnRequest

View File

@@ -69,6 +69,51 @@ Error.constructor
# Interfaces
## AdminSessionOptions
Configuration options for admin session middleware
### Properties
#### adminSecret
```ts
adminSecret: string
```
Hasura admin secret for elevated permissions (sets x-hasura-admin-secret header)
#### role?
```ts
optional role: string;
```
Hasura role to use for the request (sets x-hasura-role header)
#### sessionVariables?
```ts
optional sessionVariables: Record<string, string>;
```
Additional Hasura session variables to attach to requests.
Keys will be automatically prefixed with 'x-hasura-' if not already present.
##### Example
```ts
{
'user-id': '123',
'org-id': '456'
}
// Results in headers:
// x-hasura-user-id: 123
// x-hasura-org-id: 456
```
---
## FetchResponse&lt;T&gt;
Interface representing a structured API response.
@@ -301,3 +346,151 @@ that create or invalidate sessions.
[`ChainFunction`](#chainfunction)
A middleware function that can be used in the fetch chain
---
## withAdminSessionMiddleware()
```ts
function withAdminSessionMiddleware(options: AdminSessionOptions): ChainFunction
```
Creates a fetch middleware that attaches the Hasura admin secret and optional session variables to requests.
This middleware:
1. Sets the x-hasura-admin-secret header, which grants full admin access to Hasura
2. Optionally sets the x-hasura-role header if a role is provided
3. Optionally sets additional x-hasura-\* headers for custom session variables
**Security Warning**: Never use this middleware in client-side code or expose
the admin secret to end users. Admin secrets grant unrestricted access to your
entire database. This should only be used in trusted server-side environments.
The middleware preserves request-specific headers when they conflict with the
admin session configuration.
### Parameters
| Parameter | Type | Description |
| --------- | --------------------------------------------- | ------------------------------------------------------------------------- |
| `options` | [`AdminSessionOptions`](#adminsessionoptions) | Admin session options including admin secret, role, and session variables |
### Returns
[`ChainFunction`](#chainfunction)
A middleware function that can be used in the fetch chain
### Example
```ts
// Create middleware with admin secret only
const adminMiddleware = withAdminSessionMiddleware({
adminSecret: process.env.NHOST_ADMIN_SECRET
})
// Create middleware with admin secret and role
const adminUserMiddleware = withAdminSessionMiddleware({
adminSecret: process.env.NHOST_ADMIN_SECRET,
role: 'user'
})
// Create middleware with admin secret, role, and custom session variables
const fullMiddleware = withAdminSessionMiddleware({
adminSecret: process.env.NHOST_ADMIN_SECRET,
role: 'user',
sessionVariables: {
'user-id': '123',
'org-id': '456'
}
})
// Use with createCustomClient for an admin client
const adminClient = createCustomClient({
subdomain: 'myproject',
region: 'eu-central-1',
chainFunctions: [adminMiddleware]
})
```
---
## withHeadersMiddleware()
```ts
function withHeadersMiddleware(defaultHeaders: HeadersInit): ChainFunction
```
Creates a fetch middleware that attaches default headers to requests.
This middleware:
1. Merges default headers with request-specific headers
2. Preserves request-specific headers when they conflict with defaults
The middleware ensures consistent headers across requests while allowing
individual requests to override defaults as needed.
### Parameters
| Parameter | Type | Description |
| ---------------- | ------------- | ----------------------------------------- |
| `defaultHeaders` | `HeadersInit` | Default headers to attach to all requests |
### Returns
[`ChainFunction`](#chainfunction)
A middleware function that can be used in the fetch chain
---
## withRoleMiddleware()
```ts
function withRoleMiddleware(role: string): ChainFunction
```
Creates a fetch middleware that sets the Hasura role header.
This middleware sets the x-hasura-role header for all requests, allowing
you to specify which role's permissions should be used. This works with
authenticated sessions where the user has access to the specified role.
Unlike `withAdminSessionMiddleware`, this does not bypass permission rules
but instead uses the permission rules defined for the specified role.
The middleware preserves request-specific headers when they conflict with
the role configuration.
### Parameters
| Parameter | Type | Description |
| --------- | -------- | ----------------------------------- |
| `role` | `string` | The Hasura role to use for requests |
### Returns
[`ChainFunction`](#chainfunction)
A middleware function that can be used in the fetch chain
### Example
```ts
// Use with createClient to default all requests to a specific role
const nhost = createClient({
subdomain: 'myproject',
region: 'eu-central-1',
chainFunctions: [withRoleMiddleware('moderator')]
})
// Use with createServerClient for server-side requests
const serverNhost = createServerClient({
subdomain: 'myproject',
region: 'eu-central-1',
storage: myServerStorage,
chainFunctions: [withRoleMiddleware('moderator')]
})
```

View File

@@ -54,7 +54,7 @@ console.log(JSON.stringify(uplFilesResp, null, 2))
// "updatedAt": "2025-05-09T17:26:04.589692+00:00",
// "isUploaded": true,
// "mimeType": "text/plain",
// "uploadedByUserId": "",
// "uploadedByUserId": "3357aada-b6c7-4af1-9655-1307ca2883a2",
// "metadata": null
// },
// {
@@ -67,7 +67,7 @@ console.log(JSON.stringify(uplFilesResp, null, 2))
// "updatedAt": "2025-05-09T17:26:04.596831+00:00",
// "isUploaded": true,
// "mimeType": "text/plain",
// "uploadedByUserId": "",
// "uploadedByUserId": "3357aada-b6c7-4af1-9655-1307ca2883a2",
// "metadata": null
// }
// ]
@@ -125,6 +125,77 @@ console.log(JSON.stringify(funcResp.body, null, 2))
// }
```
## Creating an admin client
You can also create an admin client if needed. This client will have admin access to the database
and will bypass permissions. Additionally, it can impersonate users and set any role or session
variable.
IMPORTANT!!! Keep your admin secret safe and never expose it in client-side code.
```ts
const nhost = createNhostClient({
subdomain,
region,
configure: [
withAdminSession({
adminSecret: 'nhost-admin-secret',
role: 'user',
sessionVariables: {
'user-id': '54058C42-51F7-4B37-8B69-C89A841D2221'
}
})
]
})
// upload a couple of files
const uplFilesResp = await nhost.storage.uploadFiles({
'file[]': [
new File(['test1'], 'file-1', { type: 'text/plain' }),
new File(['test2 is larger'], 'file-2', { type: 'text/plain' })
]
})
console.log(JSON.stringify(uplFilesResp, null, 2))
// {
// "data": {
// "processedFiles": [
// {
// "id": "c0e83185-0ce5-435c-bd46-9841adc30699",
// "name": "file-1",
// "size": 5,
// "bucketId": "default",
// "etag": "\"5a105e8b9d40e1329780d62ea2265d8a\"",
// "createdAt": "2025-05-09T17:26:04.579839+00:00",
// "updatedAt": "2025-05-09T17:26:04.589692+00:00",
// "isUploaded": true,
// "mimeType": "text/plain",
// "uploadedByUserId": "54058c42-51f7-4b37-8b69-c89a841d2221",
// "metadata": null
// },
// {
// "id": "3f189004-21fd-42d0-be1d-1ead021ab167",
// "name": "file-2",
// "size": 15,
// "bucketId": "default",
// "etag": "\"302e888c5e289fe6b02115b748771ee9\"",
// "createdAt": "2025-05-09T17:26:04.59245+00:00",
// "updatedAt": "2025-05-09T17:26:04.596831+00:00",
// "isUploaded": true,
// "mimeType": "text/plain",
// "uploadedByUserId": "54058c42-51f7-4b37-8b69-c89a841d2221",
// "metadata": null
// }
// ]
// },
// "status": 201,
// "headers": {
// "content-length": "644",
// "content-type": "application/json; charset=utf-8",
// "date": "Fri, 09 May 2025 17:26:04 GMT"
// }
// }
```
# Interfaces
## NhostClient
@@ -287,6 +358,15 @@ optional authUrl: string;
Complete base URL for the auth service (overrides subdomain/region)
#### configure?
```ts
optional configure: ClientConfigurationFn[];
```
Configuration functions to be applied to the client after initialization.
These functions receive all clients and can attach middleware or perform other setup.
#### functionsUrl?
```ts
@@ -360,6 +440,19 @@ Complete base URL for the auth service (overrides subdomain/region)
[`NhostClientOptions`](#nhostclientoptions).[`authUrl`](#authurl)
#### configure?
```ts
optional configure: ClientConfigurationFn[];
```
Configuration functions to be applied to the client after initialization.
These functions receive all clients and can attach middleware or perform other setup.
##### Inherited from
[`NhostClientOptions`](#nhostclientoptions).[`configure`](#configure)
#### functionsUrl?
```ts
@@ -434,6 +527,55 @@ Nhost project subdomain (e.g., 'abcdefgh'). Used to construct the base URL for s
[`NhostClientOptions`](#nhostclientoptions).[`subdomain`](#subdomain)
# Type Aliases
## ClientConfigurationFn()
```ts
type ClientConfigurationFn = (clients: object) => void
```
Configuration function that receives all clients and can configure them
(e.g., by attaching middleware, setting up interceptors, etc.)
### Parameters
| Parameter | Type |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clients` | \{ `auth`: [`Client`](./auth#client); `functions`: [`Client`](./functions#client); `graphql`: [`Client`](./graphql#client); `sessionStorage`: [`SessionStorage`](./session#sessionstorage); `storage`: [`Client`](./storage#client); \} |
| `clients.auth` | [`Client`](./auth#client) |
| `clients.functions` | [`Client`](./functions#client) |
| `clients.graphql` | [`Client`](./graphql#client) |
| `clients.sessionStorage` | [`SessionStorage`](./session#sessionstorage) |
| `clients.storage` | [`Client`](./storage#client) |
### Returns
`void`
# Variables
## withClientSideSessionMiddleware
```ts
const withClientSideSessionMiddleware: ClientConfigurationFn
```
Built-in configuration for client-side applications.
Includes automatic session refresh, token attachment, and session updates.
---
## withServerSideSessionMiddleware
```ts
const withServerSideSessionMiddleware: ClientConfigurationFn
```
Built-in configuration for server-side applications.
Includes token attachment and session updates, but NOT automatic session refresh
to prevent race conditions in server contexts.
# Functions
## createClient()
@@ -495,6 +637,72 @@ const nhost = createClient({
secure: import.meta.env.ENVIRONMENT === 'production'
})
})
// Create client with additional custom middleware
const nhost = createClient({
subdomain: 'abcdefgh',
region: 'eu-central-1',
configure: [customLoggingMiddleware]
})
```
---
## createNhostClient()
```ts
function createNhostClient(options: NhostClientOptions): NhostClient
```
Creates and configures a new Nhost client instance with custom configuration.
This is the main factory function for creating Nhost clients. It instantiates
all service clients (auth, storage, graphql, functions) and applies the provided
configuration functions to set up middleware and other customizations.
### Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------------- | ------------------------------------ |
| `options` | [`NhostClientOptions`](#nhostclientoptions) | Configuration options for the client |
### Returns
[`NhostClient`](#nhostclient)
A configured Nhost client
### Example
```ts
// Create a basic client with no middleware
const nhost = createNhostClient({
subdomain: 'abcdefgh',
region: 'eu-central-1',
configure: []
})
// Create a client with custom configuration
const nhost = createNhostClient({
subdomain: 'abcdefgh',
region: 'eu-central-1',
configure: [withClientSideSessionMiddleware, withChainFunctions([customLoggingMiddleware])]
})
// Create an admin client
const nhost = createNhostClient({
subdomain,
region,
configure: [
withAdminSession({
adminSecret: 'nhost-admin-secret',
role: 'user',
sessionVariables: {
'user-id': '54058C42-51F7-4B37-8B69-C89A841D2221'
}
})
]
})
```
---
@@ -623,6 +831,14 @@ const nhostClientFromCookies = (req: Request) => {
}
})
}
// Example with additional custom middleware
const nhost = createServerClient({
region: process.env['NHOST_REGION'] || 'local',
subdomain: process.env['NHOST_SUBDOMAIN'] || 'local',
storage: myStorage,
configure: [customLoggingMiddleware]
})
```
---
@@ -631,7 +847,7 @@ const nhostClientFromCookies = (req: Request) => {
```ts
function generateServiceUrl(
serviceType: 'storage' | 'auth' | 'graphql' | 'functions',
serviceType: 'auth' | 'storage' | 'graphql' | 'functions',
subdomain?: string,
region?: string,
customUrl?: string
@@ -644,7 +860,7 @@ Generates a base URL for a Nhost service based on configuration
| Parameter | Type | Description |
| ------------- | ------------------------------------------------------- | --------------------------------------------------- |
| `serviceType` | `"storage"` \| `"auth"` \| `"graphql"` \| `"functions"` | Type of service (auth, storage, graphql, functions) |
| `serviceType` | `"auth"` \| `"storage"` \| `"graphql"` \| `"functions"` | Type of service (auth, storage, graphql, functions) |
| `subdomain?` | `string` | Nhost project subdomain |
| `region?` | `string` | Nhost region |
| `customUrl?` | `string` | Custom URL override if provided |
@@ -654,3 +870,29 @@ Generates a base URL for a Nhost service based on configuration
`string`
The base URL for the service
---
## withAdminSession()
```ts
function withAdminSession(adminSession: AdminSessionOptions): ClientConfigurationFn
```
Configuration for admin clients with elevated privileges.
Applies admin session middleware to storage, graphql, and functions clients only.
**Security Warning**: Never use this in client-side code. Admin secrets grant
unrestricted access to your entire database.
### Parameters
| Parameter | Type | Description |
| -------------- | ------------------------------------------------------ | ------------------------------------------------------------------------- |
| `adminSession` | [`AdminSessionOptions`](./fetch#adminsessionoptions) | Admin session options including admin secret, role, and session variables |
### Returns
[`ClientConfigurationFn`](#clientconfigurationfn)
Configuration function that sets up admin middleware

View File

@@ -454,7 +454,7 @@ Example - `"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."`
##### Inherited from
[`Session`](./auth#session).[`accessToken`](./auth#accesstoken)
[`Session`](./auth#session).[`accessToken`](./auth#accesstoken-1)
#### accessTokenExpiresIn
@@ -490,7 +490,7 @@ Pattern - \b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b
##### Inherited from
[`Session`](./auth#session).[`refreshToken`](./auth#refreshtoken-3)
[`Session`](./auth#session).[`refreshToken`](./auth#refreshtoken-5)
#### refreshTokenId

View File

@@ -1,70 +0,0 @@
table:
name: attachments
schema: public
configuration:
column_config:
task_id:
custom_name: taskID
custom_column_names:
task_id: taskID
custom_root_fields:
delete: deleteAttachments
delete_by_pk: deleteAttachment
insert: insertAttachments
insert_one: insertAttachment
select: attachments
select_aggregate: attachmentsAggregate
select_by_pk: attachment
select_stream: attachmentsStream
update: updateAttachments
update_by_pk: updateAttachment
update_many: updateAttachmentsMany
object_relationships:
- name: file
using:
foreign_key_constraint_on: file_id
- name: task
using:
foreign_key_constraint_on: task_id
insert_permissions:
- role: user
permission:
check:
_and:
- file:
uploaded_by_user_id:
_eq: X-Hasura-User-Id
- task:
user_id:
_eq: X-Hasura-User-Id
columns:
- file_id
- task_id
comment: ""
select_permissions:
- role: user
permission:
columns:
- file_id
- task_id
filter:
_and:
- file:
uploaded_by_user_id:
_eq: X-Hasura-User-Id
- task:
user_id:
_eq: X-Hasura-User-Id
comment: ""
delete_permissions:
- role: user
permission:
filter:
_and:
- file:
uploaded_by_user_id:
_eq: X-Hasura-User-Id
- task:
user_id:
_eq: X-Hasura-User-Id
comment: ""

View File

@@ -1,86 +0,0 @@
table:
name: comments
schema: public
configuration:
column_config:
comment:
custom_name: comment
created_at:
custom_name: createdAt
id:
custom_name: id
ninja_turtle_id:
custom_name: ninjaTurtleId
updated_at:
custom_name: updatedAt
user_id:
custom_name: userId
custom_column_names:
comment: comment
created_at: createdAt
id: id
ninja_turtle_id: ninjaTurtleId
updated_at: updatedAt
user_id: userId
custom_name: comments
custom_root_fields:
delete: deleteComments
delete_by_pk: deleteComment
insert: insertComments
insert_one: insertComment
select: comments
select_aggregate: commentsAggregate
select_by_pk: comment
select_stream: commentsStream
update: updateComments
update_by_pk: updateComment
update_many: updateCommentsMany
object_relationships:
- name: ninjaTurtle
using:
foreign_key_constraint_on: ninja_turtle_id
- name: user
using:
foreign_key_constraint_on: user_id
insert_permissions:
- role: user
permission:
check:
user_id:
_eq: X-Hasura-User-Id
set:
user_id: x-hasura-User-Id
columns:
- ninja_turtle_id
- comment
comment: Allow users to add comments, automatically setting their user_id
select_permissions:
- role: user
permission:
columns:
- id
- created_at
- updated_at
- ninja_turtle_id
- comment
- user_id
filter: {}
allow_aggregations: true
comment: Allow users to view all comments
update_permissions:
- role: user
permission:
columns:
- comment
filter:
user_id:
_eq: X-Hasura-User-Id
check: {}
comment: Allow users to update only their own comments
delete_permissions:
- role: user
permission:
filter:
user_id:
_eq: X-Hasura-User-Id
comment: Allow users to delete only their own comments

View File

@@ -1,16 +0,0 @@
table:
name: movies
schema: public
select_permissions:
- role: public
permission:
columns:
- id
- title
- director
- release_year
- genre
- rating
- created_at
- updated_at
filter: {}

View File

@@ -1,50 +0,0 @@
table:
name: ninja_turtles
schema: public
configuration:
column_config:
created_at:
custom_name: createdAt
id:
custom_name: id
name:
custom_name: name
updated_at:
custom_name: updatedAt
custom_column_names:
created_at: createdAt
id: id
name: name
updated_at: updatedAt
custom_name: ninjaTurtles
custom_root_fields:
delete: deleteNinjaTurtles
delete_by_pk: deleteNinjaTurtle
insert: insertNinjaTurtles
insert_one: insertNinjaTurtle
select: ninjaTurtles
select_aggregate: ninjaTurtlesAggregate
select_by_pk: ninjaTurtle
select_stream: ninjaTurtlesStream
update: updateNinjaTurtles
update_by_pk: updateNinjaTurtle
update_many: updateNinjaTurtlesMany
array_relationships:
- name: comments
using:
foreign_key_constraint_on:
column: ninja_turtle_id
table:
name: comments
schema: public
select_permissions:
- role: user
permission:
columns:
- created_at
- description
- id
- name
- updated_at
filter: {}
comment: ""

View File

@@ -1,74 +0,0 @@
table:
name: tasks
schema: public
configuration:
column_config:
created_at:
custom_name: createdAt
updated_at:
custom_name: updatedAt
user_id:
custom_name: userID
custom_column_names:
created_at: createdAt
updated_at: updatedAt
user_id: userID
custom_root_fields:
delete: deleteTasks
delete_by_pk: deleteTask
insert: insertTasks
insert_one: insertTask
select: tasks
select_aggregate: tasksAggregate
select_by_pk: task
select_stream: tasksStream
update: updateTasks
update_by_pk: updateTask
update_many: updateTasksMany
insert_permissions:
- role: user
permission:
check:
user_id:
_eq: X-Hasura-User-Id
set:
user_id: x-hasura-User-Id
columns:
- completed
- description
- title
comment: ""
select_permissions:
- role: user
permission:
columns:
- completed
- description
- title
- created_at
- updated_at
- id
- user_id
filter:
user_id:
_eq: X-Hasura-User-Id
comment: ""
update_permissions:
- role: user
permission:
columns:
- completed
- description
- title
filter: {}
check:
user_id:
_eq: X-Hasura-User-Id
comment: ""
delete_permissions:
- role: user
permission:
filter:
user_id:
_eq: X-Hasura-User-Id
comment: ""

View File

@@ -0,0 +1,47 @@
table:
name: todos
schema: public
insert_permissions:
- role: user
permission:
check: {}
set:
user_id: X-Hasura-User-Id
columns:
- created_at
- updated_at
- title
- details
- completed
- user_id
select_permissions:
- role: user
permission:
columns:
- id
- created_at
- updated_at
- title
- details
- completed
- user_id
filter:
user_id:
_eq: X-Hasura-User-Id
update_permissions:
- role: user
permission:
columns:
- title
- details
- completed
filter:
user_id:
_eq: X-Hasura-User-Id
check: null
delete_permissions:
- role: user
permission:
filter:
user_id:
_eq: X-Hasura-User-Id

View File

@@ -57,7 +57,7 @@ insert_permissions:
permission:
check:
bucket_id:
_eq: personal
_eq: default
set:
uploaded_by_user_id: X-Hasura-User-Id
columns:
@@ -84,7 +84,7 @@ select_permissions:
filter:
_and:
- bucket_id:
_eq: personal
_eq: default
- uploaded_by_user_id:
_eq: X-Hasura-User-Id
delete_permissions:

View File

@@ -1,18 +0,0 @@
CREATE TABLE "public"."tasks" ("id" uuid NOT NULL DEFAULT gen_random_uuid(), "created_at" timestamptz NOT NULL DEFAULT now(), "updated_at" timestamptz NOT NULL DEFAULT now(), "title" text NOT NULL, "description" text NOT NULL, "completed" boolean NOT NULL DEFAULT false, "user_id" uuid NOT NULL, PRIMARY KEY ("id") , FOREIGN KEY ("user_id") REFERENCES "auth"."users"("id") ON UPDATE cascade ON DELETE cascade);
CREATE OR REPLACE FUNCTION "public"."set_current_timestamp_updated_at"()
RETURNS TRIGGER AS $$
DECLARE
_new record;
BEGIN
_new := NEW;
_new."updated_at" = NOW();
RETURN _new;
END;
$$ LANGUAGE plpgsql;
CREATE TRIGGER "set_public_tasks_updated_at"
BEFORE UPDATE ON "public"."tasks"
FOR EACH ROW
EXECUTE PROCEDURE "public"."set_current_timestamp_updated_at"();
COMMENT ON TRIGGER "set_public_tasks_updated_at" ON "public"."tasks"
IS 'trigger to set value of column "updated_at" to current timestamp on row update';
CREATE EXTENSION IF NOT EXISTS pgcrypto;

Some files were not shown because too many files have changed in this diff Show More