mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-21 21:09:49 +08:00
## Stack Auth → Hexclave rename — PR 5 (internal symbols, paths,
packages, brand strings)
PR 5 finishes the **internal / non-wire** half of the Stack→Hexclave
rename. It only touches things where nothing outside the repo depends on
the exact name: internal symbols, file/dir names, the
`@stackframe/template` package, and residual brand strings. Plan +
progress are in `HEXCLAVE-RENAME-PR5-PLAN.md`.
Every step was verified green (`pnpm typecheck` + `pnpm lint`, 28/28)
and committed as its own checkpoint, then a fan-out of review agents
audited all commits and the findings were fixed.
### What changed
- **Internal symbols** (`@hexclave/shared`, `packages/template`, apps):
`stack*`/`Stack*` → `hexclave*`/`Hexclave*` — incl.
`stackGlobalsSymbol`, the `_Stack*AppImpl` classes,
`stackAppInternalsSymbol`, `StackContext`, `getStackStripe`, etc. The
`stack*App` local-variable convention
(`stackServerApp`/`stackClientApp`/…) was renamed across 175
source/example/doc files.
- **File renames**: `hexclave-handler/provider/context.tsx`,
`backend/hexclave.tsx`, `internal-tool/hexclave.ts`,
`hexclave-app-internals.ts`.
- **Directory renames**: `lib/hexclave-app`, `hexclave-companion`,
`[...hexclave]` route segment, `skills/hexclave`,
`dashboard/src/hexclave`, and the package dirs
**`packages/{next,shared,ui,sc,cli}`** (dropping the `stack-` prefix to
match the `@hexclave/*` npm names).
- **Packages**: `@stackframe/template` → `@hexclave/template`; **deleted
`packages/init-stack`** (onboarding lives in `@hexclave/cli init`; the
published npm package is untouched).
- **Brand strings**: reworded `Stack Auth`/`Stack dashboard` prose in
code + docs-mintlify, renamed `hexclave-app.mdx`/`use-hexclave-app.mdx`
with redirects, regenerated OpenAPI, updated coupled e2e assertions;
`doctor`/`init` now prefer `hexclave.config.ts`.
### Intentionally kept (verified, not oversights)
Wire/compat identifiers (`x-stack-*` headers, `stack-*` cookies,
`STACK_*` env names, `*.stack-auth.com`, `stackauth_`, `ask_stack_auth`,
query params), public `Stack*` SDK aliases, crypto/JWT/vault
domain-separation tags, `*-brand-sentinel`s, the
`Symbol.for("StackAuth--…")` string, `_stack_sync_metadata`, Postgres
`stackframe` / docker image names, the `stack-auth-logo*.svg` (used by
the rebrand modal), and `migration.mdx` / "formerly known as Stack Auth"
notes. False positives (Phosphor `StackIcon`/`StackSimple`, `TanStack`,
`OrbStack`, `stackable`/`Stacked` charts) left alone.
### Review pass
Six review agents audited all commits. Found + fixed one real bug — a
build script (`bundle-type-definitions.ts`) hardcoded the old
`lib/stack-app` glob path (not an import, so typecheck/lint were blind),
silently emptying the dashboard AI type bundle — plus stale comments, a
dead CI env var, and stale `.gitignore`/`.dockerignore` entries.
Cross-cutting audit confirmed **zero wire-compat identifiers were
accidentally renamed**.
### ⚠️ Verification note
`typecheck` + `lint` are fully green locally. The **e2e suite was not
run** (needs a live backend+DB), so the brand-string assertion +
OpenAPI-regen changes are verified by grep/codegen only — please let CI
exercise e2e to confirm.
### Base-branch note
This branch was forked from the local-only `cl/friendly-lewin-72293f`
(not on origin, no separate PR), so this PR against `dev` also carries
that branch's ~11 preceding Hexclave-rename commits (config-file rename,
env-var dual-read, AI setup-prompt rebrand). If those should land
separately, re-parent before merge.
<!-- This is an auto-generated description by cubic. -->
---
## Summary by cubic
Finishes the internal Stack Auth → Hexclave rename and cleans up
remaining stragglers, including dev-tool and prompt copy. All changes
are internal-only; public/wire APIs remain unchanged. Re-merged `dev`
and resolved the payments create-purchase-url conflict.
- **Refactors**
- Internal symbols: stack*/Stack* → hexclave*/Hexclave* (e.g.,
`getHexclaveServerApp` via `@/hexclave`, `getHexclaveStripe`,
`hexclaveAppInternalsSymbol`, `hexclaveSchemaInfo`, Prisma
`__hexclave_*`, `data-hexclave-handler-page`, Stripe mock
`hexclavePortPrefix`).
- Files/dirs: moved to `lib/hexclave-app`; handler route
`[...hexclave]`; backend entry `src/hexclave.tsx`; dashboard internals
`hexclave-app-internals`; companion `hexclave-companion`; dropped
`stack-` prefix across package dirs
(`packages/{shared,ui,sc,cli,next}`); workflows/emulator paths now
`packages/cli`; Quetzal codegen env at `packages/next/.env.local`.
- Packages/docs: `@stackframe/template` → `@hexclave/template`; removed
`packages/init-stack`; regenerated OpenAPI and updated docs
slugs/redirects for hexclave-app/use-hexclave-app.
- Brand strings/prompts: reworded remaining “Stack” dashboard strings to
Hexclave; updated dev-tool copy and prompts; `doctor/init` now prefer
`hexclave.config.ts`. Kept all wire-compat identifiers and public
aliases (`x-stack-*`, `stack-*` cookies, `STACK_*` env,
`*.stack-auth.com`, `Stack*` SDK names).
- Rebased/merged onto latest `dev`: retained `@hexclave/template`, kept
`src` in published files, refreshed setup-prompt imports and docs JSON,
adopted 1.0.5 version bumps, and re-merged `dev` again (resolved
`create-purchase-url` with `getHexclaveStripe`).
- **Bug Fixes**
- Restored dashboard AI type bundle by pointing the glob to
`packages/template/src/lib/hexclave-app`.
- Addressed rename leftovers: updated lingering `@/stack` imports and
CSS selector, fixed schema/meta and port-prefix expansions, and aligned
emulator commands to `packages/cli`.
- CI/build: removed a dead env var and stale ignore entries; fixed
Docker by renaming `STACK_SKIP_TEMPLATE_GENERATION` →
`HEXCLAVE_SKIP_TEMPLATE_GENERATION`.
<sup>Written for commit 3c1af3bff3.
Summary will update on new commits.</sup>
<a
href="https://cubic.dev/pr/hexclave/hexclave/pull/1547?utm_source=github"
target="_blank" rel="noopener noreferrer"
data-no-image-dialog="true"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cubic.dev/buttons/review-in-cubic-dark.svg"><source
media="(prefers-color-scheme: light)"
srcset="https://cubic.dev/buttons/review-in-cubic-light.svg"><img
alt="Review in cubic"
src="https://cubic.dev/buttons/review-in-cubic-dark.svg"></picture></a>
<!-- End of auto-generated description by cubic. -->
168 lines
5.6 KiB
Plaintext
168 lines
5.6 KiB
Plaintext
---
|
|
title: Supabase
|
|
description: Integrate Hexclave with Supabase RLS
|
|
---
|
|
|
|
This guide shows how to integrate Hexclave with Supabase row level security (RLS).
|
|
|
|
<Info>
|
|
This guide only focuses on the RLS/JWT integration and does not sync user data between Supabase and Stack. You should use [webhooks](/guides/apps/webhooks/overview) to achieve data sync.
|
|
</Info>
|
|
|
|
## Setup
|
|
|
|
Let's create a sample table and some RLS policies to demonstrate how to integrate Hexclave with Supabase RLS. You can apply the same logic to your own tables and policies.
|
|
|
|
<Steps>
|
|
<Step title="Setup Supabase">
|
|
First, let's create a Supabase project, then go to the [SQL Editor](https://supabase.com/dashboard/project/_/sql/new) and create a new table with some sample data and RLS policies.
|
|
|
|
```sql title="Supabase SQL Editor"
|
|
-- Create the 'data' table
|
|
CREATE TABLE data (
|
|
id bigint PRIMARY KEY,
|
|
text text NOT NULL,
|
|
user_id UUID
|
|
);
|
|
|
|
-- Insert sample data
|
|
INSERT INTO data (id, text, user_id) VALUES
|
|
(1, 'Everyone can see this', NULL),
|
|
(2, 'Only authenticated users can see this', NULL),
|
|
(3, 'Only user with specific id can see this', NULL);
|
|
|
|
-- Enable Row Level Security
|
|
ALTER TABLE data ENABLE ROW LEVEL SECURITY;
|
|
|
|
-- Allow everyone to read the first row
|
|
CREATE POLICY "Public read" ON "public"."data" TO public
|
|
USING (id = 1);
|
|
|
|
-- Allow authenticated users to read the second row
|
|
CREATE POLICY "Authenticated access" ON "public"."data" TO authenticated
|
|
USING (id = 2);
|
|
|
|
-- Allow only the owner of the row to read it
|
|
CREATE POLICY "User access" ON "public"."data" TO authenticated
|
|
USING (id = 3 AND auth.uid() = user_id);
|
|
```
|
|
</Step>
|
|
|
|
<Step title="Setup a new Next.js project">
|
|
Now let's create a new Next.js project and install Hexclave and Supabase client. (more details on [Next.js setup](https://nextjs.org/docs/getting-started/installation), [Hexclave setup](/guides/getting-started/setup), and [Supabase setup](https://supabase.com/docs/guides/getting-started/quickstarts/nextjs))
|
|
|
|
```bash title="Terminal"
|
|
npx create-next-app@latest -e with-supabase stack-supabase
|
|
cd stack-supabase
|
|
npx @hexclave/cli@latest init
|
|
```
|
|
|
|
Now copy the environment variables from the Supabase dashboard to the `.env.local` file:
|
|
|
|
- `NEXT_PUBLIC_SUPABASE_URL`
|
|
- `NEXT_PUBLIC_SUPABASE_ANON_KEY`
|
|
- `SUPABASE_JWT_SECRET`
|
|
|
|
Copy environment variables from the Hexclave dashboard to the `.env.local` file.
|
|
|
|
- `NEXT_PUBLIC_HEXCLAVE_PROJECT_ID`
|
|
- `NEXT_PUBLIC_HEXCLAVE_PUBLISHABLE_CLIENT_KEY`
|
|
- `HEXCLAVE_SECRET_SERVER_KEY`
|
|
</Step>
|
|
|
|
<Step title="Set up Supabase client">
|
|
Now let's create a server action that mints a supabase JWT with the Hexclave user ID if the user is authenticated.
|
|
|
|
```tsx title="/utils/actions.ts"
|
|
'use server';
|
|
|
|
import { hexclaveServerApp } from "@/hexclave/server";
|
|
import * as jose from "jose";
|
|
|
|
export const getSupabaseJwt = async () => {
|
|
const user = await hexclaveServerApp.getUser();
|
|
|
|
if (!user) {
|
|
return null;
|
|
}
|
|
|
|
const token = await new jose.SignJWT({
|
|
sub: user.id,
|
|
role: "authenticated",
|
|
})
|
|
.setProtectedHeader({ alg: "HS256" })
|
|
.setIssuedAt()
|
|
.setExpirationTime('1h')
|
|
.sign(new TextEncoder().encode(process.env.SUPABASE_JWT_SECRET));
|
|
|
|
return token;
|
|
};
|
|
```
|
|
|
|
And now create a helper function to create a Supabase client with the JWT signed by the server action
|
|
|
|
```tsx title="/utils/supabase-client.ts"
|
|
import { createBrowserClient } from "@supabase/ssr";
|
|
import { getSupabaseJwt } from "./actions";
|
|
|
|
export const createSupabaseClient = () => {
|
|
return createBrowserClient(
|
|
process.env.NEXT_PUBLIC_SUPABASE_URL!,
|
|
process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!,
|
|
{ accessToken: async () => await getSupabaseJwt() || "" }
|
|
);
|
|
}
|
|
```
|
|
</Step>
|
|
|
|
<Step title="Fetch data from Supabase">
|
|
Let's create an example page that fetches data from Supabase and displays it.
|
|
|
|
```tsx title="/app/page.tsx"
|
|
'use client';
|
|
|
|
import { createSupabaseClient } from "@/utils/supabase-client";
|
|
import { useHexclaveApp, useUser } from "@hexclave/next";
|
|
import Link from "next/link";
|
|
import { useEffect, useState } from "react";
|
|
|
|
export default function Page() {
|
|
const app = useHexclaveApp();
|
|
const user = useUser();
|
|
const supabase = createSupabaseClient();
|
|
const [data, setData] = useState<null | any[]>(null);
|
|
|
|
useEffect(() => {
|
|
supabase.from("data").select().then(({ data }) => setData(data ?? []));
|
|
}, []);
|
|
|
|
const listContent = data === null ?
|
|
<p>Loading...</p> :
|
|
data.length === 0 ?
|
|
<p>No notes found</p> :
|
|
data.map((note) => <li key={note.id}>{note.text}</li>);
|
|
|
|
return (
|
|
<div>
|
|
{
|
|
user ?
|
|
<>
|
|
<p>You are signed in</p>
|
|
<p>User ID: {user.id}</p>
|
|
<Link href={app.urls.signOut}>Sign Out</Link>
|
|
</> :
|
|
<Link href={app.urls.signIn}>Sign In</Link>
|
|
}
|
|
<h3>Supabase data</h3>
|
|
<ul>{listContent}</ul>
|
|
</div>
|
|
)
|
|
}
|
|
```
|
|
|
|
Now you should be able to compare the data you can view with an anonymous user, an authenticated user. You can also add your user Id to the row 3 of the Supabase table, and you should be able to see the row if and only if you are signed in with that user.
|
|
</Step>
|
|
</Steps>
|
|
|
|
You can find the full example [here on GitHub](https://github.com/hexclave/hexclave/tree/main/examples/supabase).
|