Files
Shade/packages/shade-widgets
Sterister 0bdf9e859c
Some checks failed
Test / test (push) Has been cancelled
Docker build and publish / docker (push) Has been cancelled
Publish / publish (push) Has been cancelled
release(v4.0.2): consumer-strict reader-shape fixes
4.0.1's typecheck gate compiled each package internally against
lib: ["ES2022"]. That doesn't catch types that only fail when
*consumer* code (lib: ["DOM"] + exactOptionalPropertyTypes) tries to
assign a native browser type into one of our locally-defined narrower
types. Dispatch hit one such case in @shade/files inline-threshold.ts.

This release adds a tests/consumer-strict/ smoke project to the
pre-publish gate. It compiles a tiny "as if I were a downstream app"
TS file against:

  lib: ["ES2022", "DOM", "DOM.Iterable"]
  types: ["bun-types"]
  exactOptionalPropertyTypes: true
  strict: true
  paths → packages/*/src/index.ts

scripts/typecheck-all.ts now runs the smoke after per-package checks.
Both must pass before publish:dry / publish:all proceeds.

### Fixed
- @shade/files inline-threshold.ts: MinimalReader<T> rewritten as the
  explicit disjoint union { done:false, value:T } | { done:true,
  value?: T | undefined } that's assignable from every native reader
  shape (bun, DOM, node:stream/web). Fixes the
  "ReadableStreamReadResult is not assignable" Dispatch reported.
- @shade/files streams-bridge (client + server): stash setTimeout
  return in a local before .unref?.() via { unref?: () => void } cast.
  Fluent .unref?.() failed under lib: ["DOM"] (setTimeout returns
  number there).
- @shade/sdk background.ts: same setInterval .unref?.() fix.

Wire-compatible. No API shape changed.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-03 19:51:46 +02:00
..

@shade/widgets

Embeddable React widgets for live Shade observability. Drop them into any React dashboard (Nova, Orchestrator, your own apps) to show what's happening in your Shade deployment.

Install

bun add @shade/widgets react react-dom

Quick start

import { ShadeProvider, IdentityCard, SessionList, RecentActivity } from '@shade/widgets';

function MyDashboard() {
  return (
    <ShadeProvider
      observerUrl="https://shade.example.com/shade-observer"
      token={process.env.SHADE_TOKEN!}
    >
      <IdentityCard />
      <SessionList />
      <RecentActivity />
    </ShadeProvider>
  );
}

You need a running @shade/observer endpoint for the widgets to talk to.

Components

Component Description
<IdentityCard /> Your fingerprint, registration ID, init/rotation timestamps
<SessionList /> Active Shade sessions with per-session message counts and DH ratchet steps
<PrekeyStock lowThreshold={5} /> Gauge of remaining one-time prekeys with low-stock warning
<RecentActivity limit={50} /> Live SSE feed of events flowing through the system
<ServerStatus /> Prekey server stats (registered identities, fetches, replenishes, rate limits)
<FingerprintCompare /> Paste a safety number to verify it matches your identity
<WidgetCatalog /> Meta-widget letting users pick which widgets to display

Letting users pick widgets

<ShadeProvider observerUrl="..." token="...">
  <WidgetCatalog
    available={['identity', 'sessions', 'prekeys', 'activity', 'server']}
    defaultLayout={['identity', 'sessions', 'activity']}
  />
</ShadeProvider>

User selections persist to localStorage. Pass onLayoutChange to override with your own persistence.

Theming

<ShadeProvider observerUrl="..." token="..." themeMode="auto">

Modes: dark (default), light, auto (matches prefers-color-scheme).

Each widget renders self-contained CSS via inline styles — no Tailwind, no external CSS file, no conflicts with your host app.

Hooks

For custom layouts, use the underlying hooks directly:

import { useShadeState, useShadeEvents } from '@shade/widgets';

function CustomWidget() {
  const { state, loading } = useShadeState();
  const { events, connected } = useShadeEvents();
  // ... render whatever you want
}

Polling interval

Default poll for /api/state is 5 seconds. Override:

<ShadeProvider observerUrl="..." token="..." pollIntervalMs={2000}>

The SSE event stream updates instantly regardless of poll interval.