@osqd/bothandlerjs 0.3.0 → 0.5.0

package/dist/dashboard/client/stream.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Closes the stream, keeping everything the page has drawn.
+ *
+ * Reconnecting resumes from where this left off: the server is told the last id seen and
+ * sends only what was missed, so suspending across a route change costs a reconnect rather
+ * than a reload.
+ */
+export declare function suspendStream(): void;
+export declare function connectStream(): void;
+/**
+ * A first fetch, so the page has counters before the stream opens — and so a browser
+ * with `EventSource` blocked still shows something useful.
+ */
+export declare function loadInitialSnapshot(): Promise<void>;

package/dist/dashboard/client/tester.d.ts

@@ -0,0 +1 @@
+export declare function initTester(): void;

package/dist/dashboard/client/types.d.ts

@@ -0,0 +1,69 @@
+import type { DashboardEntry, DashboardSections, DashboardSnapshot, PolicyDocument, PolicyPreview } from "../types.js";
+export type { DashboardChange, DashboardEntry, DashboardEvidence, DashboardNotice, DashboardSections, DashboardSnapshot, PolicyDocument, PolicyPreview } from "../types.js";
+/** What the server stamps into the page for the client to read at start-up. */
+export interface Boot {
+    /** The mount prefix, or `""` at the root. Every request the page makes is relative to it. */
+    base: string;
+    title: string;
+    allowReset: boolean;
+    allowEdit: boolean;
+    allowGuardEdit: boolean;
+    allowActing: boolean;
+    peers: ReadonlyArray<{
+        label: string;
+        href: string;
+    }>;
+    sections: Required<DashboardSections>;
+    links: ReadonlyArray<{
+        label: string;
+        href: string;
+    }>;
+}
+/**
+ * One feed entry, plus what the page knows about it that the server does not.
+ *
+ * A wrapper rather than extra fields on the entry, for two reasons. The entry is a
+ * copy of what the server sent and anything added to it would end up in a replay line
+ * or a corpus case; and `rev` has to survive being compared against a rendered row,
+ * which is a question about this page rather than about the request.
+ */
+export interface Row {
+    entry: DashboardEntry;
+    /**
+     * Bumped whenever the entry changes, which is how the feed knows a rendered row is
+     * stale. A request is written twice — once when it is assessed, again when the
+     * decision lands — and only the second write should cost a rebuild.
+     */
+    rev: number;
+    /** The searchable text, built on demand and thrown away when the entry changes. */
+    text?: string | undefined;
+}
+/** The views, in the order the tab strip and the digit shortcuts use. */
+export type TabName = "live" | "actors" | "stats" | "policy";
+export interface Preview extends PolicyPreview {
+}
+export interface Policy extends PolicyDocument {
+}
+export interface Snapshot extends DashboardSnapshot {
+}
+/**
+ * One row of the Actors screen.
+ *
+ * Here rather than in `registry.ts`, which renders it: this is plain data, and the store
+ * holds a list of it. A pure module importing a type from a module that speaks DOM pulls
+ * that module into every program the pure one appears in — which is how a Node-side test
+ * of the store came to fail on `HTMLInputElement`.
+ */
+export interface ActorRow {
+    key: string;
+    requests: number;
+    recentRate: number;
+    distinctPaths: number;
+    distinctUserAgents: number;
+    cadenceCv: number | undefined;
+    priorConfirmations: number;
+    unsolvedChallenges: number;
+    cleared: boolean;
+    firstSeen: number;
+    lastSeen: number;
+}