mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-04 21:04:37 +08:00
c14a9dd3d0
## 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. -->
311 lines
8.8 KiB
JSON
311 lines
8.8 KiB
JSON
{
|
|
"$schema": "https://mintlify.com/docs.json",
|
|
"name": "Hexclave Documentation",
|
|
"theme": "mint",
|
|
"logo": {
|
|
"dark": "/images/logo-dark.svg",
|
|
"light": "/images/logo-light.svg"
|
|
},
|
|
"favicon": "/images/favicon.ico",
|
|
"colors": {
|
|
"primary": "#6b5df7",
|
|
"light": "#8b7cf9",
|
|
"dark": "#6b5df7"
|
|
},
|
|
"background": {
|
|
"color": {
|
|
"dark": "#09090b"
|
|
}
|
|
},
|
|
"contextual": {
|
|
"options": [
|
|
"copy",
|
|
"view",
|
|
"assistant",
|
|
"chatgpt",
|
|
"claude",
|
|
"perplexity",
|
|
"grok",
|
|
"aistudio",
|
|
"devin",
|
|
"windsurf",
|
|
"mcp",
|
|
"cursor",
|
|
"vscode",
|
|
"devin-mcp"
|
|
]
|
|
},
|
|
"fonts": {
|
|
"heading": {
|
|
"family": "Geist",
|
|
"weight": 500
|
|
},
|
|
"body": {
|
|
"family": "Geist",
|
|
"weight": 400
|
|
}
|
|
},
|
|
"navbar": {
|
|
"links": [
|
|
{
|
|
"type": "github",
|
|
"href": "https://github.com/hexclave/hexclave"
|
|
}
|
|
],
|
|
"primary": {
|
|
"type": "button",
|
|
"label": "Dashboard",
|
|
"href": "https://app.hexclave.com"
|
|
}
|
|
},
|
|
"navigation": {
|
|
"tabs": [
|
|
{
|
|
"tab": "Documentation",
|
|
"pages": [
|
|
"index",
|
|
{
|
|
"group": "Getting Started",
|
|
"pages": [
|
|
"guides/getting-started/setup",
|
|
"guides/getting-started/user-fundamentals",
|
|
"guides/getting-started/ai-integration"
|
|
]
|
|
},
|
|
{
|
|
"group": "Going Further",
|
|
"pages": [
|
|
"guides/going-further/cli",
|
|
"guides/going-further/local-vs-cloud-dashboard",
|
|
"guides/going-further/hexclave-config"
|
|
]
|
|
},
|
|
{
|
|
"group": "Apps",
|
|
"pages": [
|
|
{
|
|
"group": "Authentication",
|
|
"icon": "/images/app-icons/authentication.svg",
|
|
"pages": [
|
|
"guides/apps/authentication/overview",
|
|
"guides/apps/authentication/user-onboarding",
|
|
"guides/apps/authentication/restricted-users",
|
|
"guides/apps/authentication/connected-accounts",
|
|
"guides/apps/authentication/jwts",
|
|
"guides/apps/authentication/sign-up-rules",
|
|
"guides/apps/authentication/cli-authentication",
|
|
{
|
|
"group": "All Auth Providers",
|
|
"root": "guides/apps/authentication/auth-providers",
|
|
"pages": [
|
|
"guides/apps/authentication/auth-providers/apple",
|
|
"guides/apps/authentication/auth-providers/bitbucket",
|
|
"guides/apps/authentication/auth-providers/discord",
|
|
"guides/apps/authentication/auth-providers/facebook",
|
|
"guides/apps/authentication/auth-providers/github",
|
|
"guides/apps/authentication/auth-providers/gitlab",
|
|
"guides/apps/authentication/auth-providers/google",
|
|
"guides/apps/authentication/auth-providers/linkedin",
|
|
"guides/apps/authentication/auth-providers/microsoft",
|
|
"guides/apps/authentication/auth-providers/passkey",
|
|
"guides/apps/authentication/auth-providers/spotify",
|
|
"guides/apps/authentication/auth-providers/twitch",
|
|
"guides/apps/authentication/auth-providers/two-factor-auth",
|
|
"guides/apps/authentication/auth-providers/x-twitter"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"guides/apps/emails/overview",
|
|
"guides/apps/payments/overview",
|
|
"guides/apps/analytics/overview",
|
|
{
|
|
"group": "Teams",
|
|
"icon": "/images/app-icons/teams.svg",
|
|
"pages": [
|
|
"guides/apps/teams/overview",
|
|
"guides/apps/teams/team-selection"
|
|
]
|
|
},
|
|
"guides/apps/fraud-protection/overview",
|
|
"guides/apps/rbac/overview",
|
|
"guides/apps/api-keys/overview",
|
|
"guides/apps/data-vault/overview",
|
|
"guides/apps/webhooks/overview",
|
|
"guides/apps/launch-checklist/overview"
|
|
]
|
|
},
|
|
{
|
|
"group": "Integrations",
|
|
"pages": [
|
|
"guides/integrations/tanstack-start/overview",
|
|
"guides/integrations/supabase/overview",
|
|
"guides/integrations/convex/overview",
|
|
"guides/integrations/vercel/overview"
|
|
]
|
|
},
|
|
{
|
|
"group": "Other",
|
|
"pages": [
|
|
"guides/other/self-host",
|
|
"guides/other/known-errors",
|
|
"migration",
|
|
{
|
|
"group": "Tutorials",
|
|
"pages": [
|
|
"guides/other/tutorials/build-a-saas-with-hexclave",
|
|
"guides/other/tutorials/build-a-team-based-app",
|
|
"guides/other/tutorials/ship-production-ready-auth"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "SDK Reference",
|
|
"pages": [
|
|
"sdk/overview",
|
|
{
|
|
"group": "Objects",
|
|
"pages": ["sdk/objects/hexclave-app"]
|
|
},
|
|
{
|
|
"group": "Types",
|
|
"pages": [
|
|
"sdk/types/user",
|
|
"sdk/types/team",
|
|
"sdk/types/team-user",
|
|
"sdk/types/team-permission",
|
|
"sdk/types/team-profile",
|
|
"sdk/types/contact-channel",
|
|
"sdk/types/email",
|
|
"sdk/types/api-key",
|
|
"sdk/types/project",
|
|
"sdk/types/connected-account",
|
|
"sdk/types/item",
|
|
"sdk/types/customer"
|
|
]
|
|
},
|
|
{
|
|
"group": "Hooks",
|
|
"pages": ["sdk/hooks/use-hexclave-app", "sdk/hooks/use-user"]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "REST API",
|
|
"pages": [
|
|
"api/overview",
|
|
{
|
|
"group": "Client API",
|
|
"openapi": {
|
|
"source": "openapi/client.json",
|
|
"directory": "api/client"
|
|
}
|
|
},
|
|
{
|
|
"group": "Server API",
|
|
"openapi": {
|
|
"source": "openapi/server.json",
|
|
"directory": "api/server"
|
|
}
|
|
},
|
|
{
|
|
"group": "Admin API",
|
|
"openapi": {
|
|
"source": "openapi/admin.json",
|
|
"directory": "api/admin",
|
|
"hidden": "true"
|
|
}
|
|
},
|
|
{
|
|
"group": "Webhooks",
|
|
"openapi": {
|
|
"source": "openapi/webhooks.json",
|
|
"directory": "api/webhooks"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"footer": {
|
|
"socials": {
|
|
"x": "https://x.com/hexclave",
|
|
"github": "https://github.com/hexclave/hexclave",
|
|
"discord": "https://discord.hexclave.com"
|
|
}
|
|
},
|
|
"seo": {
|
|
"metatags": {
|
|
"robots": "noindex"
|
|
}
|
|
},
|
|
"settings": {
|
|
"customScripts": ["/apps-sidebar-filter.js", "/code-language-labels.js"]
|
|
},
|
|
"redirects": [
|
|
{
|
|
"source": "/sdk/objects/stack-app",
|
|
"destination": "/sdk/objects/hexclave-app"
|
|
},
|
|
{
|
|
"source": "/sdk/hooks/use-stack-app",
|
|
"destination": "/sdk/hooks/use-hexclave-app"
|
|
},
|
|
{
|
|
"source": "/rest-api/overview",
|
|
"destination": "/api/overview"
|
|
},
|
|
{
|
|
"source": "/getting-started/setup",
|
|
"destination": "/guides/getting-started/setup"
|
|
},
|
|
{
|
|
"source": "/docs/getting-started/setup",
|
|
"destination": "/guides/getting-started/setup"
|
|
},
|
|
{
|
|
"source": "/docs/next/getting-started/setup",
|
|
"destination": "/guides/getting-started/setup"
|
|
},
|
|
{
|
|
"source": "/docs/sdk",
|
|
"destination": "/sdk/overview"
|
|
},
|
|
{
|
|
"source": "/docs/apps/analytics",
|
|
"destination": "/guides/apps/analytics/overview"
|
|
},
|
|
{
|
|
"source": "/docs/apps/api-keys",
|
|
"destination": "/guides/apps/api-keys/overview"
|
|
},
|
|
{
|
|
"source": "/docs/others/convex",
|
|
"destination": "/guides/integrations/convex/overview"
|
|
},
|
|
{
|
|
"source": "/docs/concepts/teams",
|
|
"destination": "/guides/apps/teams/overview"
|
|
},
|
|
{
|
|
"source": "/docs/concepts/custom-user-data",
|
|
"destination": "/guides/getting-started/user-fundamentals#custom-metadata"
|
|
},
|
|
{
|
|
"source": "/guides/going-further/user-metadata",
|
|
"destination": "/guides/getting-started/user-fundamentals#custom-metadata"
|
|
},
|
|
{
|
|
"source": "/others/js-client",
|
|
"destination": "/sdk/objects/hexclave-app"
|
|
},
|
|
{
|
|
"source": "/guides/going-further/stack-app",
|
|
"destination": "/sdk/objects/hexclave-app"
|
|
}
|
|
]
|
|
}
|