2026-04-10 17:51:29 +02:00
|
|
|
import type { Sql } from 'postgres';
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Auto-create all Shade tables if they don't exist.
|
|
|
|
|
*
|
|
|
|
|
* Called on PostgresStorage / PostgresPrekeyStore construction.
|
|
|
|
|
* Uses raw SQL (not Drizzle migrations) for zero-config deployment.
|
|
|
|
|
*
|
|
|
|
|
* All tables prefixed with `shade_` to avoid collisions when sharing
|
|
|
|
|
* a PostgreSQL instance with another project.
|
|
|
|
|
*/
|
|
|
|
|
export async function ensureClientTables(sql: Sql): Promise<void> {
|
|
|
|
|
await sql`
|
|
|
|
|
CREATE TABLE IF NOT EXISTS shade_identity (
|
|
|
|
|
id INTEGER PRIMARY KEY CHECK (id = 1),
|
|
|
|
|
signing_public_key TEXT NOT NULL,
|
|
|
|
|
signing_private_key TEXT NOT NULL,
|
|
|
|
|
dh_public_key TEXT NOT NULL,
|
|
|
|
|
dh_private_key TEXT NOT NULL
|
|
|
|
|
)
|
|
|
|
|
`;
|
|
|
|
|
await sql`
|
|
|
|
|
CREATE TABLE IF NOT EXISTS shade_config (
|
|
|
|
|
key TEXT PRIMARY KEY,
|
|
|
|
|
value TEXT NOT NULL
|
|
|
|
|
)
|
|
|
|
|
`;
|
|
|
|
|
await sql`
|
|
|
|
|
CREATE TABLE IF NOT EXISTS shade_signed_prekeys (
|
|
|
|
|
key_id INTEGER PRIMARY KEY,
|
|
|
|
|
data_json TEXT NOT NULL
|
|
|
|
|
)
|
|
|
|
|
`;
|
|
|
|
|
await sql`
|
|
|
|
|
CREATE TABLE IF NOT EXISTS shade_one_time_prekeys (
|
|
|
|
|
key_id INTEGER PRIMARY KEY,
|
|
|
|
|
data_json TEXT NOT NULL
|
|
|
|
|
)
|
|
|
|
|
`;
|
|
|
|
|
await sql`
|
|
|
|
|
CREATE TABLE IF NOT EXISTS shade_sessions (
|
|
|
|
|
address TEXT PRIMARY KEY,
|
|
|
|
|
state_json TEXT NOT NULL
|
|
|
|
|
)
|
|
|
|
|
`;
|
|
|
|
|
await sql`
|
|
|
|
|
CREATE TABLE IF NOT EXISTS shade_trusted_identities (
|
|
|
|
|
address TEXT PRIMARY KEY,
|
|
|
|
|
identity_key TEXT NOT NULL
|
|
|
|
|
)
|
|
|
|
|
`;
|
|
|
|
|
await sql`
|
|
|
|
|
CREATE TABLE IF NOT EXISTS shade_retired_identities (
|
|
|
|
|
id SERIAL PRIMARY KEY,
|
|
|
|
|
data_json TEXT NOT NULL,
|
|
|
|
|
retired_at BIGINT NOT NULL
|
|
|
|
|
)
|
|
|
|
|
`;
|
|
|
|
|
await sql`
|
|
|
|
|
CREATE INDEX IF NOT EXISTS shade_retired_at_idx ON shade_retired_identities(retired_at)
|
|
|
|
|
`;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export async function ensurePrekeyServerTables(sql: Sql): Promise<void> {
|
|
|
|
|
await sql`
|
|
|
|
|
CREATE TABLE IF NOT EXISTS shade_server_identities (
|
|
|
|
|
address TEXT PRIMARY KEY,
|
|
|
|
|
identity_signing_key TEXT NOT NULL,
|
feat(container): M-Box 1-8 — stack-agnostic standalone Docker container
Shade now ships as a self-contained Docker image. Deploy one container
per project, any stack (Bun, Python, Go, Rust, Kotlin) can talk to it via
plain HTTP. Zero coupling to consumer codebases.
M-Box 1: Stale identity cleanup API
- touchIdentity + purgeStaleIdentities on PrekeyStore interface
- Implemented for Memory, SQLite, and Postgres backends
- SQLite adds last_activity_at column with migration ALTER for existing DBs
- Postgres adds the same via raw SQL with IF NOT EXISTS guards
- Routes call touchIdentity on register, bundle fetch, replenish
- 4 new tests for the cleanup API
M-Box 2: Stale cleanup background task
- StaleCleanupTask runs purge on startup + every 24h (configurable)
- Reads SHADE_STALE_DAYS (default 30) and SHADE_CLEANUP_INTERVAL_HOURS
- Wired into standalone.ts, stopped on graceful shutdown
- 5 new tests for the task
M-Box 3: Observer baked into the container
- standalone.ts conditionally mounts @shade/observer at /shade-observer
when SHADE_OBSERVER_TOKEN is set (and >= 16 chars)
- Shared PrekeyServerEvents emitter feeds both routes and observer
- @shade/observer added as optional dependency of @shade/server
M-Box 4: Dockerfile with dashboard build
- Multi-stage build: oven/bun:1 builder → oven/bun:1-alpine runtime
- COPY packages/ wholesale so workspace lockfile resolves cleanly
- RUN bun run build inside shade-dashboard → dist/ → observer/dist/
- Non-root shade user, /data volume, healthcheck, env defaults
- Final image: 260 MB
M-Box 5: OpenAPI spec for stack-agnostic clients
- packages/shade-server/openapi.yaml documents all 9 endpoints with
request/response schemas, security (Ed25519 signatures + bearer token)
- createOpenApiRoutes serves /openapi.yaml and /docs (Redoc viewer)
- Any language can generate a client with openapi-generator
M-Box 6: Docker CI pipeline
- .gitea/workflows/docker.yml builds + pushes on git tag v*
- scripts/build-docker.ts for local builds, supports --push with GITEA_TOKEN
- Root package.json: build:docker, publish:docker scripts
M-Box 7: Deployment documentation
- packages/shade-server/README rewritten: 5-line quickstart with the image
- docs/DEPLOYMENT.md: full reference, env vars, backup, Dokploy, PG setup
- examples/05-dokploy-deployment/docker-compose.yml updated to pull
published image (gt.zyon.no/stian/shade-prekey:latest)
- Root README deployment section rewritten
M-Box 8: End-to-end verification
- Image builds locally (bun run build:docker)
- /health, /openapi.yaml, /docs, /metrics, /shade-observer all respond
- 401 without observer token, 200 with
- Real SDK client round-trip: Alice → container → Bob → reply → Alice
- Persistence: identity + prekeys survive container restart (count 20→18
as expected from two bundle fetches)
285 tests passing, 0 failures.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-11 14:29:00 +02:00
|
|
|
identity_dh_key TEXT NOT NULL,
|
|
|
|
|
last_activity_at BIGINT NOT NULL DEFAULT 0
|
2026-04-10 17:51:29 +02:00
|
|
|
)
|
|
|
|
|
`;
|
feat(container): M-Box 1-8 — stack-agnostic standalone Docker container
Shade now ships as a self-contained Docker image. Deploy one container
per project, any stack (Bun, Python, Go, Rust, Kotlin) can talk to it via
plain HTTP. Zero coupling to consumer codebases.
M-Box 1: Stale identity cleanup API
- touchIdentity + purgeStaleIdentities on PrekeyStore interface
- Implemented for Memory, SQLite, and Postgres backends
- SQLite adds last_activity_at column with migration ALTER for existing DBs
- Postgres adds the same via raw SQL with IF NOT EXISTS guards
- Routes call touchIdentity on register, bundle fetch, replenish
- 4 new tests for the cleanup API
M-Box 2: Stale cleanup background task
- StaleCleanupTask runs purge on startup + every 24h (configurable)
- Reads SHADE_STALE_DAYS (default 30) and SHADE_CLEANUP_INTERVAL_HOURS
- Wired into standalone.ts, stopped on graceful shutdown
- 5 new tests for the task
M-Box 3: Observer baked into the container
- standalone.ts conditionally mounts @shade/observer at /shade-observer
when SHADE_OBSERVER_TOKEN is set (and >= 16 chars)
- Shared PrekeyServerEvents emitter feeds both routes and observer
- @shade/observer added as optional dependency of @shade/server
M-Box 4: Dockerfile with dashboard build
- Multi-stage build: oven/bun:1 builder → oven/bun:1-alpine runtime
- COPY packages/ wholesale so workspace lockfile resolves cleanly
- RUN bun run build inside shade-dashboard → dist/ → observer/dist/
- Non-root shade user, /data volume, healthcheck, env defaults
- Final image: 260 MB
M-Box 5: OpenAPI spec for stack-agnostic clients
- packages/shade-server/openapi.yaml documents all 9 endpoints with
request/response schemas, security (Ed25519 signatures + bearer token)
- createOpenApiRoutes serves /openapi.yaml and /docs (Redoc viewer)
- Any language can generate a client with openapi-generator
M-Box 6: Docker CI pipeline
- .gitea/workflows/docker.yml builds + pushes on git tag v*
- scripts/build-docker.ts for local builds, supports --push with GITEA_TOKEN
- Root package.json: build:docker, publish:docker scripts
M-Box 7: Deployment documentation
- packages/shade-server/README rewritten: 5-line quickstart with the image
- docs/DEPLOYMENT.md: full reference, env vars, backup, Dokploy, PG setup
- examples/05-dokploy-deployment/docker-compose.yml updated to pull
published image (gt.zyon.no/stian/shade-prekey:latest)
- Root README deployment section rewritten
M-Box 8: End-to-end verification
- Image builds locally (bun run build:docker)
- /health, /openapi.yaml, /docs, /metrics, /shade-observer all respond
- 401 without observer token, 200 with
- Real SDK client round-trip: Alice → container → Bob → reply → Alice
- Persistence: identity + prekeys survive container restart (count 20→18
as expected from two bundle fetches)
285 tests passing, 0 failures.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-11 14:29:00 +02:00
|
|
|
// Migrate existing deployments (no-op if column exists)
|
|
|
|
|
await sql`
|
|
|
|
|
ALTER TABLE shade_server_identities
|
|
|
|
|
ADD COLUMN IF NOT EXISTS last_activity_at BIGINT NOT NULL DEFAULT 0
|
|
|
|
|
`;
|
|
|
|
|
await sql`
|
|
|
|
|
CREATE INDEX IF NOT EXISTS shade_server_identities_activity_idx
|
|
|
|
|
ON shade_server_identities(last_activity_at)
|
|
|
|
|
`;
|
2026-04-10 17:51:29 +02:00
|
|
|
await sql`
|
|
|
|
|
CREATE TABLE IF NOT EXISTS shade_server_signed_prekeys (
|
|
|
|
|
address TEXT PRIMARY KEY,
|
|
|
|
|
key_id INTEGER NOT NULL,
|
|
|
|
|
public_key TEXT NOT NULL,
|
|
|
|
|
signature TEXT NOT NULL
|
|
|
|
|
)
|
|
|
|
|
`;
|
|
|
|
|
await sql`
|
|
|
|
|
CREATE TABLE IF NOT EXISTS shade_server_one_time_prekeys (
|
|
|
|
|
id SERIAL PRIMARY KEY,
|
|
|
|
|
address TEXT NOT NULL,
|
|
|
|
|
key_id INTEGER NOT NULL,
|
|
|
|
|
public_key TEXT NOT NULL
|
|
|
|
|
)
|
|
|
|
|
`;
|
|
|
|
|
await sql`
|
|
|
|
|
CREATE INDEX IF NOT EXISTS shade_server_otp_address_idx ON shade_server_one_time_prekeys(address)
|
|
|
|
|
`;
|
|
|
|
|
}
|