@scp-dev/hub 0.1.0 → 0.1.1

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Envelope, RelayCore, CoreOptions, EndpointRow, PolicySubject, ScopeSubject, ScopeNode, ScopeDirection, Admission, MessageRow, EndpointView, ScopeCap, ScopeEntry, Claim, SendParams, SendResult, EndpointKind, Presence, StatusState, Sql, CrossAccountLink, XDelivered, XListed, XRelease } from '@scp-dev/core';
+import { Envelope, RelayCore, CoreOptions, EndpointRow, PolicySubject, ScopeSubject, ScopeNode, ScopeDirection, Admission, MessageRow, EndpointView, ScopeCap, ScopeEntry, Claim, SendParams, SendResult, EndpointKind, Presence, StatusState, Sql, CrossAccountLink, XDelivered, XListed, ActivityRow, XRelease } from '@scp-dev/core';
 
 type RelayAuth = Envelope["from"]["auth"];
 /** a machine name: one relay host of an account */
@@ -397,6 +397,15 @@ interface HubConn {
     /** whether a human client said a terminal is attached */
     tty?: boolean;
 }
+/** a bound machine, or a revoked token's name kept as a tombstone */
+interface MachineRow {
+    name: string;
+    kind: string;
+    online: boolean;
+    bridge: boolean;
+    created_at: string | null;
+    last_seen: string | null;
+}
 interface HubSocket {
     conn: HubConn;
     send(text: string): void;
@@ -574,6 +583,12 @@ declare class RelayHub {
     /** machines a live connection holds */
     private liveMachines;
     /** bindings, then names a revoke left behind (kind `revoked`) */
+    /** a read-only view of the account for a dashboard: its machines, listed endpoints and latest activity */
+    overview(activity?: number): {
+        machines: MachineRow[];
+        endpoints: EndpointView[];
+        activity: ActivityRow[];
+    };
     private machineList;
     /** only the token the machine is bound to, a full login of the member who bound it, or an admin may release it (or a revoked token's name) */
     private releaseMachine;
@@ -599,4 +614,4 @@ declare class RelayHub {
     xnotice(endpoint: string, text: string): void;
 }
 
-export { type Delivery, FederatedCore, type FederatedOptions, HUB_LIMITS, type HubAuth, type HubConn, type HubDeps, type HubGrant, type HubLimits, type HubRole, type HubSocket, MACHINE_NAME, type MirrorCaps, type MirrorChange, type MirrorRules, type MirrorScope, type MirrorView, type RelayAuth, RelayHub, type RemoteView, type XEndpoint };
+export { type Delivery, FederatedCore, type FederatedOptions, HUB_LIMITS, type HubAuth, type HubConn, type HubDeps, type HubGrant, type HubLimits, type HubRole, type HubSocket, MACHINE_NAME, type MachineRow, type MirrorCaps, type MirrorChange, type MirrorRules, type MirrorScope, type MirrorView, type RelayAuth, RelayHub, type RemoteView, type XEndpoint };

package/dist/index.js

@@ -2721,6 +2721,11 @@ var RelayHub = class _RelayHub {
     return live;
   }
   /** bindings, then names a revoke left behind (kind `revoked`) */
+  /** a read-only view of the account for a dashboard: its machines, listed endpoints and latest activity */
+  overview(activity = 20) {
+    const { endpoints, activity: rows } = this.relay.snapshot({ activity });
+    return { machines: this.machineList(), endpoints, activity: rows };
+  }
   machineList() {
     const sockets = this.deps.sockets().filter((s) => !this.gone.has(s.conn.id));
     const bound = this.deps.sql.all(`SELECT name, kind, created_at, last_seen FROM machines ORDER BY name`).map((row) => ({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scp-dev/hub",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Swarm Communication Protocol federation and account hub: mirrored endpoints across machines, bridges, direct clients and cross-account delivery.",
   "license": "Apache-2.0",
   "homepage": "https://scp.dev",
@@ -29,7 +29,7 @@
     "typecheck": "tsc -p ."
   },
   "dependencies": {
-    "@scp-dev/core": "0.1.0"
+    "@scp-dev/core": "0.1.1"
   },
   "devDependencies": {
     "tsup": "^8.5.1"

package/src/hub.ts

@@ -1,4 +1,5 @@
 import {
+  type ActivityRow,
   allowlisted,
   CAPABILITIES,
   CLI_NAME,
@@ -81,6 +82,16 @@ export interface HubConn {
   tty?: boolean
 }
 
+/** a bound machine, or a revoked token's name kept as a tombstone */
+export interface MachineRow {
+  name: string
+  kind: string
+  online: boolean
+  bridge: boolean
+  created_at: string | null
+  last_seen: string | null
+}
+
 export interface HubSocket {
   conn: HubConn
   send(text: string): void
@@ -1442,7 +1453,13 @@ export class RelayHub {
   }
 
   /** bindings, then names a revoke left behind (kind `revoked`) */
-  private machineList(): { name: string; kind: string; online: boolean; bridge: boolean; created_at: string | null; last_seen: string | null }[] {
+  /** a read-only view of the account for a dashboard: its machines, listed endpoints and latest activity */
+  overview(activity = 20): { machines: MachineRow[]; endpoints: EndpointView[]; activity: ActivityRow[] } {
+    const { endpoints, activity: rows } = this.relay.snapshot({ activity })
+    return { machines: this.machineList(), endpoints, activity: rows }
+  }
+
+  private machineList(): MachineRow[] {
     const sockets = this.deps.sockets().filter((s) => !this.gone.has(s.conn.id))
     const bound = this.deps.sql
       .all<{ name: string; kind: string; created_at: number; last_seen: number | null }>(`SELECT name, kind, created_at, last_seen FROM machines ORDER BY name`)

package/src/index.ts

@@ -12,4 +12,15 @@ export {
   type RemoteView,
   type XEndpoint,
 } from "./federation"
-export { HUB_LIMITS, RelayHub, type HubAuth, type HubConn, type HubDeps, type HubGrant, type HubLimits, type HubRole, type HubSocket } from "./hub"
+export {
+  HUB_LIMITS,
+  RelayHub,
+  type HubAuth,
+  type HubConn,
+  type HubDeps,
+  type HubGrant,
+  type HubLimits,
+  type HubRole,
+  type HubSocket,
+  type MachineRow,
+} from "./hub"