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. -->
121 lines
4.6 KiB
TypeScript
121 lines
4.6 KiB
TypeScript
import * as parser from "@babel/parser";
|
|
import * as t from "@babel/types";
|
|
import { isValidConfig, normalize } from "./config/format";
|
|
|
|
export const showOnboardingHexclaveConfigValue = "show-onboarding";
|
|
|
|
const DEFAULT_CONFIG_IMPORT_PACKAGE = "@hexclave/js";
|
|
|
|
/**
|
|
* Renders a config object into the source text of a `stack.config.ts` file.
|
|
*
|
|
* Browser-safe: kept here (next to `parseHexclaveConfigFileContent`) instead of in
|
|
* `config-rendering.ts` so dashboard client code can render config files
|
|
* without pulling in `fs` / `path`.
|
|
*/
|
|
export function renderConfigFileContent(config: unknown, importPackage?: string): string {
|
|
if (!isValidConfig(config)) {
|
|
throw new Error("Invalid config: expected a plain object.");
|
|
}
|
|
|
|
const droppedKeys: string[] = [];
|
|
const normalizedConfig = normalize(config, {
|
|
onDotIntoNonObject: "ignore",
|
|
onDotIntoNull: "empty-object",
|
|
droppedKeys,
|
|
});
|
|
if (droppedKeys.length > 0) {
|
|
throw new Error(`Config has conflicting keys that would be dropped during normalization: ${droppedKeys.map(k => JSON.stringify(k)).join(", ")}`);
|
|
}
|
|
const pkg = importPackage ?? DEFAULT_CONFIG_IMPORT_PACKAGE;
|
|
const importLine = `import type { HexclaveConfig } from "${pkg}";`;
|
|
return `${importLine}\n\nexport const config: HexclaveConfig = ${JSON.stringify(normalizedConfig, null, 2)};\n`;
|
|
}
|
|
|
|
type ParsedStackConfig = Record<string, unknown> | typeof showOnboardingHexclaveConfigValue;
|
|
|
|
function unwrapStaticConfigExpression(expression: t.Expression): t.Expression {
|
|
if (
|
|
t.isTSAsExpression(expression)
|
|
|| t.isTSSatisfiesExpression(expression)
|
|
|| t.isTSTypeAssertion(expression)
|
|
|| t.isTSNonNullExpression(expression)
|
|
) {
|
|
return unwrapStaticConfigExpression(expression.expression);
|
|
}
|
|
return expression;
|
|
}
|
|
|
|
function evaluateStaticConfigExpression(expression: t.Expression): unknown {
|
|
const unwrapped = unwrapStaticConfigExpression(expression);
|
|
if (t.isStringLiteral(unwrapped)) return unwrapped.value;
|
|
if (t.isBooleanLiteral(unwrapped)) return unwrapped.value;
|
|
if (t.isNumericLiteral(unwrapped)) return unwrapped.value;
|
|
if (t.isNullLiteral(unwrapped)) return null;
|
|
if (t.isIdentifier(unwrapped) && unwrapped.name === "undefined") return undefined;
|
|
if (t.isUnaryExpression(unwrapped) && unwrapped.operator === "-" && t.isNumericLiteral(unwrapped.argument)) {
|
|
return -unwrapped.argument.value;
|
|
}
|
|
if (t.isArrayExpression(unwrapped)) {
|
|
return unwrapped.elements.map((element) => {
|
|
if (element == null || t.isSpreadElement(element)) {
|
|
throw new Error("Config arrays cannot contain holes or spreads.");
|
|
}
|
|
return evaluateStaticConfigExpression(element);
|
|
});
|
|
}
|
|
if (t.isObjectExpression(unwrapped)) {
|
|
const result: Record<string, unknown> = {};
|
|
for (const property of unwrapped.properties) {
|
|
if (t.isSpreadElement(property)) {
|
|
throw new Error("Config objects cannot contain spreads.");
|
|
}
|
|
if (property.computed) {
|
|
throw new Error("Config object keys cannot be computed.");
|
|
}
|
|
const key = t.isIdentifier(property.key)
|
|
? property.key.name
|
|
: t.isStringLiteral(property.key) || t.isNumericLiteral(property.key)
|
|
? String(property.key.value)
|
|
: null;
|
|
if (key == null) {
|
|
throw new Error("Unsupported config object key.");
|
|
}
|
|
if (t.isObjectMethod(property)) {
|
|
throw new Error("Config objects cannot contain methods.");
|
|
}
|
|
if (!t.isExpression(property.value)) {
|
|
throw new Error("Unsupported config object value.");
|
|
}
|
|
result[key] = evaluateStaticConfigExpression(property.value);
|
|
}
|
|
return result;
|
|
}
|
|
throw new Error(`Unsupported config expression: ${unwrapped.type}`);
|
|
}
|
|
|
|
export function parseHexclaveConfigFileContent(content: string, filePath: string): ParsedStackConfig {
|
|
if (content.trim() === "") return {};
|
|
const ast = parser.parse(content, {
|
|
sourceType: "module",
|
|
plugins: ["typescript"],
|
|
});
|
|
|
|
for (const statement of ast.program.body) {
|
|
if (!t.isExportNamedDeclaration(statement) || !t.isVariableDeclaration(statement.declaration)) {
|
|
continue;
|
|
}
|
|
for (const declaration of statement.declaration.declarations) {
|
|
if (!t.isIdentifier(declaration.id) || declaration.id.name !== "config") {
|
|
continue;
|
|
}
|
|
if (declaration.init == null || !t.isExpression(declaration.init)) {
|
|
throw new Error(`Config export in ${filePath} must have an initializer.`);
|
|
}
|
|
return evaluateStaticConfigExpression(declaration.init) as ParsedStackConfig;
|
|
}
|
|
}
|
|
|
|
throw new Error(`Invalid config in ${filePath}. The file must export a plain \`config\` object or "show-onboarding".`);
|
|
}
|