@shade/observer (4.8.4)

Published 2026-05-08 16:33:14 +02:00 by Stian

Set up this registry in your project .npmrc file:

@shade:registry=

To install the package using npm, run the following command:

npm install @shade/observer@4.8.4

or add it to the package.json file:

"@shade/observer": "4.8.4"

For more information on the npm registry, see the documentation.

@shade/observer

Live observability backend for Shade — exposes a snapshot endpoint, an SSE event stream, and serves the bundled dashboard SPA.

Install

bun add @shade/observer @shade/server @shade/core

Usage

import { createObserver } from '@shade/observer';
import { ShadeEventEmitter, ShadeSessionManager } from '@shade/core';
import { PrekeyServerEvents, createPrekeyServer } from '@shade/server';

// 1. Create event emitters
const clientEvents = new ShadeEventEmitter();
const serverEvents = new PrekeyServerEvents();

// 2. Wire them into your session manager and prekey server
const manager = new ShadeSessionManager(crypto, storage, { events: clientEvents });
const prekeyServer = createPrekeyServer({ crypto, events: serverEvents });

// 3. Create the observer
const observer = createObserver({
  token: process.env.SHADE_OBSERVER_TOKEN!,
  clientEvents,
  serverEvents,
});

// 4. Mount or serve standalone
import { Hono } from 'hono';
const app = new Hono();
app.route('/shade-observer', observer);

Bun.serve({ port: 3900, fetch: app.fetch });

After this, visit http://localhost:3900/shade-observer/dashboard/ and enter your bearer token to see the dashboard.

Endpoints

Method	Path	Auth	Description
GET	`/api/state`	Bearer	Current snapshot (identity, sessions, prekeys, server stats)
GET	`/api/events`	Bearer (or `?token=`)	SSE stream of live events
GET	`/dashboard/`	None	Bundled web UI
GET	`/health`	None	Liveness check

Configuration

Env var	Required	Description
`SHADE_OBSERVER_TOKEN`	Yes	Bearer token (min 16 chars). Refuses to start if shorter.

The token is checked with constant-time comparison.

Security notes

Event payloads contain NO key material, plaintext, or signatures — only structural facts (counters, addresses, short hashes for display).
The observer is intended for internal/debugging use. Put it behind a reverse proxy and authenticate access.
The dashboard stores the bearer token in localStorage for convenience. Don't load the dashboard on shared computers.

Dependencies

ID	Version
@shade/core	^4.8.4
@shade/server	^4.8.4
hono	^4.12.12

Development Dependencies

ID	Version
@shade/crypto-web	workspace:*

Details

npm

2026-05-08 16:33:14 +02:00

6.8 KiB

Assets (1)

observer-4.8.4.tgz 6.8 KiB

Versions (29) View all

4.11.1

2026-05-21

4.11.0

2026-05-15

4.10.0

2026-05-09

4.9.0

2026-05-09

4.8.5

2026-05-08