feat(sdk): @punktfunk/host — the Effect TypeScript SDK (M3)
apple / swift (push) Successful in 1m15s
apple / screenshots (push) Successful in 4m21s
ci / web (push) Successful in 52s
ci / docs-site (push) Successful in 1m0s
android / android (push) Has been cancelled
arch / build-publish (push) Has been cancelled
ci / rust (push) Has been cancelled
ci / bench (push) Has been cancelled
deb / build-publish (push) Has been cancelled
decky / build-publish (push) Has been cancelled
docker / build-push (--build-arg FEDORA_VERSION=44, ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora44-rpm) (push) Successful in 18s
docker / build-push (., web/Dockerfile, punktfunk-web) (push) Successful in 15s
docker / build-push (ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora-rpm) (push) Successful in 14s
docker / build-push (ci, ci/rust-ci.Dockerfile, punktfunk-rust-ci) (push) Successful in 16s
docker / build-push (docs-site, docs-site/Dockerfile, punktfunk-docs) (push) Successful in 13s
rpm / build-publish (44, fedora-44, punktfunk-fedora44-rpm) (push) Successful in 14m56s
rpm / build-publish (43, bazzite, punktfunk-fedora-rpm) (push) Successful in 19m42s
docker / deploy-docs (push) Successful in 26s
apple / swift (push) Successful in 1m15s
apple / screenshots (push) Successful in 4m21s
ci / web (push) Successful in 52s
ci / docs-site (push) Successful in 1m0s
android / android (push) Has been cancelled
arch / build-publish (push) Has been cancelled
ci / rust (push) Has been cancelled
ci / bench (push) Has been cancelled
deb / build-publish (push) Has been cancelled
decky / build-publish (push) Has been cancelled
docker / build-push (--build-arg FEDORA_VERSION=44, ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora44-rpm) (push) Successful in 18s
docker / build-push (., web/Dockerfile, punktfunk-web) (push) Successful in 15s
docker / build-push (ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora-rpm) (push) Successful in 14s
docker / build-push (ci, ci/rust-ci.Dockerfile, punktfunk-rust-ci) (push) Successful in 16s
docker / build-push (docs-site, docs-site/Dockerfile, punktfunk-docs) (push) Successful in 13s
rpm / build-publish (44, fedora-44, punktfunk-fedora44-rpm) (push) Successful in 14m56s
rpm / build-publish (43, bazzite, punktfunk-fedora-rpm) (push) Successful in 19m42s
docker / deploy-docs (push) Successful in 26s
New top-level sdk/ package (RFC §7): a typed management-API client plus the lifecycle event stream, built on Effect, two surfaces over one core: - @punktfunk/host — the Promise facade front door: connect() resolves URL/token/TLS pin from the host's own files (zero config on the box), fails fast on bad credentials, pf.events.on() with typed callbacks (exact kinds, domain.* prefixes, "*", "dropped", "unknown"), pf.request() for the REST surface. Effect never required. - @punktfunk/host/effect — the PunktfunkHost service + PunktfunkHostLive layer, Stream-based events()/eventsRaw(), typed errors (AuthError | ApiError | TransportError | VersionSkew — a 2xx that fails its schema is a typed skew, not undefined later), and every wire shape as an effect/Schema: REST generated via orval client:'effect' from api/openapi.json (S3 spike: works well; the text/event-stream payload is out of its reach), events hand-mirrored from the host's snapshot-tested wire format as a kind-discriminated union. One reconnecting SSE core under both surfaces: spec-shaped parser, exponential+jittered backoff (capped, resets after a healthy connection), Last-Event-ID resume, 401 terminal. Default is LIVE tail only — a fresh notify script must not re-fire on the host's replayed ring (since: 0 opts into full replay). TLS: the pin trusts exactly the host's self-signed identity cert (chain-verified; hostname check waived — the cert is deliberately CN-only for fingerprint pinning). Bun via fetch tls, Node via an undici dispatcher (optionalDependency). definePlugin() accepts both main shapes (async fn | Effect requiring PunktfunkHost). Examples in both styles; README carries the compat contract + systemd/Task Scheduler templates. 11 bun tests green (wire decode against the Rust snapshot strings, SSE parser/reconnect/Last-Event-ID/401, both surfaces vs a mock host). Live-verified against a real host on Bun AND Node through the pinned loopback hop: connect → REST mutate → live event received → resume cursor advanced; a wrong CA is rejected. npm publish + CI wiring deferred (npm org = RFC open question 1). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
+160
@@ -0,0 +1,160 @@
|
||||
// The lifecycle-event wire schemas (RFC §4/§7) — hand-written as a discriminated union on
|
||||
// `kind` for precise types and decode errors. The REST surface is generated (./gen/schemas.ts);
|
||||
// the event stream's `text/event-stream` payload is not expressible there, and the host's
|
||||
// Rust-side JSON snapshot tests (crates/punktfunk-host/src/events.rs) are the wire's source of
|
||||
// truth — this file mirrors them. Additive-only within `schema: 1`: decoding tolerates unknown
|
||||
// keys (Effect's default), and an unknown `kind` surfaces on the raw channel, never a throw.
|
||||
import { Schema as S } from "effect";
|
||||
|
||||
export const Plane = S.Literal("native", "gamestream");
|
||||
export type Plane = S.Schema.Type<typeof Plane>;
|
||||
|
||||
export const DisconnectReason = S.Literal("quit", "timeout", "error");
|
||||
export type DisconnectReason = S.Schema.Type<typeof DisconnectReason>;
|
||||
|
||||
export const ClientRef = S.Struct({
|
||||
name: S.String,
|
||||
fingerprint: S.optional(S.String),
|
||||
plane: Plane,
|
||||
});
|
||||
export type ClientRef = S.Schema.Type<typeof ClientRef>;
|
||||
|
||||
export const SessionRef = S.Struct({
|
||||
id: S.Number,
|
||||
client: S.String,
|
||||
mode: S.String,
|
||||
hdr: S.Boolean,
|
||||
});
|
||||
export type SessionRef = S.Schema.Type<typeof SessionRef>;
|
||||
|
||||
export const StreamRef = S.Struct({
|
||||
mode: S.String,
|
||||
hdr: S.Boolean,
|
||||
client: S.String,
|
||||
app: S.optional(S.String),
|
||||
plane: Plane,
|
||||
});
|
||||
export type StreamRef = S.Schema.Type<typeof StreamRef>;
|
||||
|
||||
export const DeviceRef = S.Struct({
|
||||
name: S.String,
|
||||
fingerprint: S.String,
|
||||
plane: Plane,
|
||||
});
|
||||
export type DeviceRef = S.Schema.Type<typeof DeviceRef>;
|
||||
|
||||
/** The `{seq, ts_ms, schema}` envelope every event carries. */
|
||||
const envelope = {
|
||||
seq: S.Number,
|
||||
ts_ms: S.Number,
|
||||
schema: S.Number,
|
||||
} as const;
|
||||
|
||||
export const ClientConnected = S.Struct({
|
||||
...envelope,
|
||||
kind: S.Literal("client.connected"),
|
||||
client: ClientRef,
|
||||
});
|
||||
export const ClientDisconnected = S.Struct({
|
||||
...envelope,
|
||||
kind: S.Literal("client.disconnected"),
|
||||
client: ClientRef,
|
||||
reason: DisconnectReason,
|
||||
});
|
||||
export const SessionStarted = S.Struct({
|
||||
...envelope,
|
||||
kind: S.Literal("session.started"),
|
||||
session: SessionRef,
|
||||
});
|
||||
export const SessionEnded = S.Struct({
|
||||
...envelope,
|
||||
kind: S.Literal("session.ended"),
|
||||
session: SessionRef,
|
||||
});
|
||||
export const StreamStarted = S.Struct({
|
||||
...envelope,
|
||||
kind: S.Literal("stream.started"),
|
||||
stream: StreamRef,
|
||||
});
|
||||
export const StreamStopped = S.Struct({
|
||||
...envelope,
|
||||
kind: S.Literal("stream.stopped"),
|
||||
stream: StreamRef,
|
||||
});
|
||||
export const PairingPending = S.Struct({
|
||||
...envelope,
|
||||
kind: S.Literal("pairing.pending"),
|
||||
device: DeviceRef,
|
||||
});
|
||||
export const PairingCompleted = S.Struct({
|
||||
...envelope,
|
||||
kind: S.Literal("pairing.completed"),
|
||||
device: DeviceRef,
|
||||
});
|
||||
export const PairingDenied = S.Struct({
|
||||
...envelope,
|
||||
kind: S.Literal("pairing.denied"),
|
||||
device: DeviceRef,
|
||||
});
|
||||
export const DisplayCreated = S.Struct({
|
||||
...envelope,
|
||||
kind: S.Literal("display.created"),
|
||||
backend: S.String,
|
||||
mode: S.String,
|
||||
});
|
||||
export const DisplayReleased = S.Struct({
|
||||
...envelope,
|
||||
kind: S.Literal("display.released"),
|
||||
count: S.Number,
|
||||
});
|
||||
export const LibraryChanged = S.Struct({
|
||||
...envelope,
|
||||
kind: S.Literal("library.changed"),
|
||||
source: S.String,
|
||||
});
|
||||
export const HostStarted = S.Struct({
|
||||
...envelope,
|
||||
kind: S.Literal("host.started"),
|
||||
version: S.String,
|
||||
gamestream: S.Boolean,
|
||||
});
|
||||
export const HostStopping = S.Struct({
|
||||
...envelope,
|
||||
kind: S.Literal("host.stopping"),
|
||||
});
|
||||
|
||||
/** Every known lifecycle event — discriminated on `kind`. */
|
||||
export const HostEvent = S.Union(
|
||||
ClientConnected,
|
||||
ClientDisconnected,
|
||||
SessionStarted,
|
||||
SessionEnded,
|
||||
StreamStarted,
|
||||
StreamStopped,
|
||||
PairingPending,
|
||||
PairingCompleted,
|
||||
PairingDenied,
|
||||
DisplayCreated,
|
||||
DisplayReleased,
|
||||
LibraryChanged,
|
||||
HostStarted,
|
||||
HostStopping,
|
||||
);
|
||||
export type HostEvent = S.Schema.Type<typeof HostEvent>;
|
||||
|
||||
/** The known event kinds (for filters and the facade's `on()`). */
|
||||
export type HostEventKind = HostEvent["kind"];
|
||||
|
||||
/** Narrow a HostEvent by kind: `EventOf<"stream.started">`. */
|
||||
export type EventOf<K extends HostEventKind> = Extract<HostEvent, { kind: K }>;
|
||||
|
||||
export const decodeHostEvent = S.decodeUnknownEither(HostEvent);
|
||||
|
||||
/**
|
||||
* Does `pattern` select `kind`? Exact kinds (`stream.started`) or `domain.*` prefixes on the
|
||||
* dot boundary — the same vocabulary as the host's SSE `?kinds=` filter and hooks `on:` field.
|
||||
*/
|
||||
export const kindMatches = (pattern: string, kind: string): boolean =>
|
||||
pattern.endsWith(".*")
|
||||
? kind.startsWith(pattern.slice(0, -1)) // "stream.*" → prefix "stream."
|
||||
: pattern === kind;
|
||||
Reference in New Issue
Block a user