zidane-ui 9.1.1 → 9.1.4

package/src/machines/headless/host.ts

@@ -1,381 +0,0 @@
-/**
- * The contract between the machines components and an app: which agent hosts
- * the app talks to (This computer, the saved zidane-servers, or the one server
- * that serves a web app) and how they are, the machines a server holds, this
- * computer lent to a server, a server's self-update and its client tokens, and
- * the desktop app's local daemon.
- *
- * The desktop app implements it over IPC, `createServerMachinesHost`
- * (`zidane-ui/adapters`) over zidane-server, `createFixtureMachinesHost`
- * (`zidane-ui/machines/testing`) in memory.
- *
- * If the host leaves out a member, its UI does not show: without `retry` the
- * offline banner has no Retry button, without `tokens` there is no token list,
- * without `daemon` there is no daemon menu. `permitted`, when present, narrows
- * what the members may do right now (a token's scope): a control whose action
- * is not permitted hides, a read that is not permitted says so.
- */
-import type {
-  DaemonHealth,
-  HostCapabilities,
-  MachineInfo,
-  MachineLinksStatus,
-  ServerUpdateStatus,
-} from 'zidane/chat/pure';
-import type { ClientScope } from 'zidane/ipc';
-
-import type { HostProviderAuth } from 'zidane/ipc';
-
-import type { HostView } from '../../chat/headless/hosts';
-import type { Readable } from '../../chat/headless/store';
-import type { SignInFlow } from '../../onboarding/headless/host';
-import type { MachinesPresence } from './presence';
-import type { HostSyncPatch, HostSyncRead, HostSyncState, SyncStatus } from './sync';
-
-export type { DaemonHealth, HostCapabilities, HostProviderAuth, MachineInfo, MachineLinksStatus, ServerUpdateStatus };
-
-/** One agent host as the machines components show it: This computer or a server. */
-export interface HostSummary extends HostView {
-  /** The server's own name, when it differs from the saved one. */
-  serverName?: string;
-  /** The zidane version the server runs. */
-  serverVersion?: string;
-  /** When the server was saved, epoch ms. */
-  addedAt?: number;
-  /** When the app last connected to it, epoch ms. */
-  lastConnectedAt?: number;
-  /** The server lends itself as a machine (`allowAsMachine`). */
-  machineServe?: boolean;
-  /** The scope this app's token has there. Absent: every method (the user's own computer). */
-  scope?: ClientScope;
-  /** When the server process started, epoch ms. */
-  startedAt?: number;
-}
-
-/** The hosts the app knows. */
-export interface HostsState {
-  /** More than This computer may show (the desktop app's Remote hosts setting). `false`: the single-host view. */
-  enabled: boolean;
-  /** This computer first (when the app has one), then the servers. */
-  hosts: readonly HostSummary[];
-}
-
-/** A registry refusal's code: what is wrong with a server's URL, token or name, or why it did not answer. */
-export type HostCheckError =
-  | 'invalid-url'
-  | 'invalid-token'
-  | 'invalid-name'
-  | 'auth'
-  | 'unreachable'
-  | 'tls'
-  | 'protocol'
-  | 'identity'
-  | 'unknown-host'
-  | 'disabled'
-  | 'unknown';
-
-/** A test, an add or a rename, answered as data. `message` is the backend's own words. */
-export type HostCheckResult =
-  | { ok: true; name: string; serverVersion?: string; latencyMs?: number; host?: HostSummary }
-  | { ok: false; error: HostCheckError; message: string };
-
-/** A machine link action's outcome. `needsToken`: the server could not mint a machine token, paste one. */
-export type MachineActionResult =
-  { ok: true; links: MachineLinksStatus } | { ok: false; message: string; needsToken?: boolean };
-
-/** What went wrong, for the UI to word through its labels. `detail` is the backend's own message. */
-export interface MachinesError {
-  /** Which action failed. */
-  kind: 'read' | 'update' | 'forget' | 'remove' | 'tokens' | 'daemon' | 'sync' | 'invite';
-  /** The backend's message, shown as is by the default labels. */
-  detail: string;
-  /** The token's scope does not reach the action (the server answered Forbidden). */
-  forbidden?: boolean;
-}
-
-/** A one-time machine join code (`tokens.machineInvite`): a new machine runs `zidane machine setup --join <join>`. */
-export interface MachineInvite {
-  /** The join code (`K7Q2-9XPM`). */
-  code: string;
-  /** When the code stops working, epoch ms. It works once before then. */
-  expiresAt: number;
-  /** The join string: the main server's URL and the code (`wss://box.example#K7Q2-9XPM`). */
-  join: string;
-}
-
-/** One server's machines as last read. */
-export interface MachineListState {
-  /** `idle` before the first read; `loading` while one is in flight; `ready` or `error` after. */
-  status: 'idle' | 'loading' | 'ready' | 'error';
-  /** The machines from the last read that succeeded (empty until one did). */
-  machines: readonly MachineInfo[];
-  /** Why the last read failed. */
-  error: MachinesError | null;
-}
-
-/** One server's machines, kept current while subscribed (a machine coming online or going offline re-reads). */
-export interface MachineList {
-  /** The list as last read. */
-  state: Readable<MachineListState>;
-  /** Reads it again. Never rejects: a failure lands in `state.error`. */
-  refresh(): Promise<void>;
-}
-
-/** The saved servers as the registry lists them, with the dates the live statuses lack. */
-export interface SavedHostsState {
-  /** `idle` before the first read; `loading` while one is in flight; `ready` or `error` after. */
-  status: 'idle' | 'loading' | 'ready' | 'error';
-  /** The hosts from the last read that succeeded (`addedAt`, `lastConnectedAt`); empty until one did. */
-  hosts: readonly HostSummary[];
-  /** Why the last read failed. */
-  error: MachinesError | null;
-}
-
-/** The saved-server registry, kept current while subscribed. */
-export interface SavedHosts {
-  /** The registry as last read. */
-  state: Readable<SavedHostsState>;
-  /** Reads it again (after an add, rename or remove). Never rejects. */
-  refresh(): Promise<void>;
-}
-
-/**
- * Settings sync from this computer to a server, and the server's own record. Every action rejects with a
- * {@link MachinesError} (`sync`).
- */
-export interface HostSync {
-  /** This computer's sync to `hostId`, kept current. Absent: no Sync section (the app is not a syncing device). */
-  state?(hostId: string): HostSyncRead<HostSyncState>;
-  /** Changes the mode, the categories or the opted-in keys. Absent: the section is read-only. */
-  configure?(hostId: string, patch: HostSyncPatch): Promise<void>;
-  /** Pushes now. Absent: no Push now. */
-  push?(hostId: string): Promise<void>;
-  /** Makes this computer the server's source instead of another device. Absent: no Take over. */
-  takeOver?(hostId: string): Promise<void>;
-  /** The server's sync record (who syncs there, overrides), kept current: the markers in its Settings. */
-  status(hostId: string): HostSyncRead<SyncStatus>;
-  /** Drops an override on the server, so sync writes that field again. Absent: no Sync again. */
-  reset?(hostId: string, field: string): Promise<void>;
-  /** The server's providers (`auth.status`), never a secret. Absent: the accounts list shows this computer's side alone. */
-  providers?(hostId: string): Promise<readonly HostProviderAuth[]>;
-}
-
-/** What a sign-in on a server is for: a provider, or an MCP server of its catalog (in `cwd`'s project). */
-export type HostSignInTarget = { provider: string } | { mcpServer: string; cwd?: string };
-
-/** The machines servers hold. */
-export interface MachinesDirectory {
-  /** `hostId`'s machines. The same id answers the same list. */
-  list(hostId: string): MachineList;
-  /** The names of the machines last heard online, from every host (a session paused on one shows a banner until it is back). */
-  online: Readable<ReadonlySet<string>>;
-  /** Makes `hostId` forget a machine. Rejects with a {@link MachinesError}. Absent: no forget button. */
-  forget?(hostId: string, machineId: string): Promise<void>;
-  /**
-   * Creates a one-time join code on `hostId` for a new machine (`name`: the machine's name there). Rejects with a
-   * {@link MachinesError} (`invite`, `forbidden` below an admin token). Absent: no Add a machine.
-   */
-  invite?(hostId: string, options?: { name?: string; ttlMs?: number }): Promise<MachineInvite>;
-}
-
-/** This computer's machine links: shared with servers (it is their machine), and servers used as machines. */
-export interface MachineLinks {
-  /** The links as last heard. */
-  state: Readable<MachineLinksStatus>;
-  /** Reads them again. Never rejects. */
-  refresh(): Promise<void>;
-  /** Shares this computer with `hostId` under `name`, in `roots`; `token` when the server asked for one. Absent: no share. */
-  shareStart?(hostId: string, name: string, roots: readonly string[], token?: string): Promise<MachineActionResult>;
-  /** Stops sharing this computer with `hostId`. */
-  shareStop?(hostId: string): Promise<MachineActionResult>;
-  /** Starts or stops using `hostId` as a machine. Absent: no use button. */
-  useServer?(hostId: string, enabled: boolean): Promise<MachineActionResult>;
-}
-
-/** A server's self-update. Every method rejects with a {@link MachinesError}. */
-export interface ServerUpdates {
-  /** Where `hostId`'s self-update stands; `null` from a server that predates it. */
-  status(hostId: string): Promise<ServerUpdateStatus | null>;
-  /** Checks for a release now. Absent: no Check now. */
-  check?(hostId: string): Promise<ServerUpdateStatus>;
-  /** Installs the ready or waiting release now. Absent: no Install now. */
-  install?(hostId: string): Promise<ServerUpdateStatus>;
-  /** Turns the self-update on or off. Absent: no Turn on / off. */
-  configure?(hostId: string, enabled: boolean): Promise<ServerUpdateStatus>;
-}
-
-/** A token's scope on a server: a client scope, or `machine` (it lends a computer). */
-export type ServerTokenScope = ClientScope | 'machine';
-
-/** A server's client token as listed: never its secret. */
-export interface ServerToken {
-  /** Stable id (`tok_…`). */
-  id: string;
-  /** The name it was created with, such as the device it is for. */
-  name: string;
-  /** What it may do. */
-  scope: ServerTokenScope;
-  /** When it was created, epoch ms. */
-  createdAt: number;
-  /** When it last opened a connection, epoch ms. */
-  lastUsedAt?: number;
-  /** When it was revoked, epoch ms. Absent: live. */
-  revokedAt?: number;
-  /** When it stops working, epoch ms. Absent: never. */
-  expiresAt?: number;
-}
-
-/** A server's client tokens. Every method rejects with a {@link MachinesError}. */
-export interface ServerTokens {
-  /** `hostId`'s tokens, revoked ones included. */
-  list(hostId: string): Promise<readonly ServerToken[]>;
-  /** Creates a token; the answer carries its secret, shown once. Absent: no create form. */
-  create?(hostId: string, name: string, scope: ServerTokenScope): Promise<ServerToken & { token: string }>;
-  /** Revokes a token. Absent: no revoke buttons. */
-  revoke?(hostId: string, id: string): Promise<void>;
-  /** Calls `listener` when `hostId`'s tokens changed elsewhere (another page, a pairing, the CLI). Returns the unsubscribe. Absent: the list is read when shown and after its own changes. */
-  onChanged?(hostId: string, listener: () => void): () => void;
-}
-
-/** The desktop app's local daemon, as `daemon:status` reports it. */
-export interface DaemonStatus {
-  /** Daemon mode is on. */
-  enabled: boolean;
-  /** Where the connection is. */
-  state: 'connected' | 'connecting' | 'refused' | 'unreachable' | 'disabled';
-  /** The daemon's socket. */
-  socketPath: string;
-  /** This window's side of the handshake. */
-  window: { protocolVersion: number; buildId: string };
-  /** From the handshake, also reported by a daemon that refused it. */
-  daemon?: {
-    pid: number;
-    protocolVersion: number;
-    codeVersion?: string;
-    buildId?: string;
-    startedAt: number;
-    retiring?: boolean;
-  };
-  /** Why the daemon refused this window. */
-  refused?: { message: string; direction: 'daemon-newer' | 'daemon-older' | 'unknown' };
-  /** Why it is unreachable. */
-  error?: string;
-  /** The sessions the daemon holds (connected only). */
-  sessions?: ReadonlyArray<{ sessionId: string; running: boolean; waitingForYou: boolean; windows: number }>;
-}
-
-/** The desktop app's local daemon: its health, status and recovery actions. */
-export interface DaemonControl {
-  /** The connection's health, for the orb. */
-  health: Readable<DaemonHealth>;
-  /** Reads the status; `null` when it can't be read. */
-  status(): Promise<DaemonStatus | null>;
-  /** Reconnects now. Absent: no Reconnect now. */
-  reconnect?(): Promise<DaemonStatus>;
-  /** Restarts the daemon after its runs (`force`: now). Absent: no restart. */
-  restart?(force: boolean): Promise<{ deferred?: boolean }>;
-  /** Stops a session's run, or `'all'` of them (answers how many). Absent: no Stop. */
-  stopRun?(target: string): Promise<number | void>;
-  /** Relaunches the app (the daemon runs newer code). Absent: no Relaunch. */
-  relaunchApp?(): Promise<void>;
-}
-
-/** An action `permitted` may withhold. */
-export type MachinesAction =
-  | 'machines.list'
-  | 'machines.forget'
-  | 'machines.invite'
-  | 'update.status'
-  | 'update.manage'
-  | 'tokens.list'
-  | 'tokens.manage';
-
-/** What the machines components read and the actions they send. */
-export interface MachinesHost {
-  /** The hosts the app knows and their connection. Absent: no host list. */
-  hosts?: Readable<HostsState>;
-  /** Reads the hosts again (after a setting changed). */
-  refreshHosts?(): Promise<void>;
-  /** Reconnects to a server now instead of at the next backoff. Absent: no Retry. */
-  retry?(hostId: string): Promise<void>;
-  /** Tests a saved server, or a URL and token before saving. Absent: no Test. */
-  testHost?(target: { id: string } | { url: string; token: string }): Promise<HostCheckResult>;
-  /** Saves a server after checking it. Absent: no add form. */
-  addHost?(input: { url: string; token: string; name?: string }): Promise<HostCheckResult>;
-  /** Renames a saved server. Absent: no Rename. */
-  renameHost?(id: string, name: string): Promise<HostCheckResult>;
-  /** Moves a saved server to a new URL with its saved token, once the same server answers there. Absent: no Change URL. */
-  setHostUrl?(id: string, url: string): Promise<HostCheckResult>;
-  /** Removes a saved server and its token. Rejects with a {@link MachinesError}. Absent: no Remove. */
-  removeHost?(id: string): Promise<void>;
-  /** The saved-server registry with its dates. Absent: the hosts list shows the live statuses alone. */
-  savedHosts?: SavedHosts;
-  /** Settings sync to a server and the server's record. Absent: no Sync section, no markers. */
-  sync?: HostSync;
-  /**
-   * Starts a browser sign-in whose tokens stay on `hostId` (the browser opens here); `onDone` runs once the server
-   * stored them. Absent: no "Sign in there".
-   */
-  signIn?(hostId: string, target: HostSignInTarget, onDone?: () => void): SignInFlow;
-  /** The machines servers hold. Absent: no machine list. */
-  machines?: MachinesDirectory;
-  /** This computer's machine links. Absent: no share or use rows. */
-  links?: MachineLinks;
-  /** Picks a folder to share (the native dialog). Absent: no Add a folder. */
-  pickFolder?(): Promise<string | null>;
-  /** A server's self-update. Absent: no update section. */
-  updates?: ServerUpdates;
-  /** A server's client tokens. Absent: no token list. */
-  tokens?: ServerTokens;
-  /** The local daemon. Absent: no daemon menu. */
-  daemon?: DaemonControl;
-  /**
-   * What a host can do (OS, tools on PATH, sandbox, environment kinds, what it allows, disk); `refresh` probes again
-   * instead of the backend's short cache. Rejects with a {@link MachinesError} (`read`). Absent: no capabilities.
-   */
-  capabilities?(hostId: string, options?: { refresh?: boolean }): Promise<HostCapabilities>;
-  /** Live per-session presence (attached windows, runs, waiting on you). Absent: no presence on the rows. */
-  presence?: MachinesPresence;
-  /** What the members may do right now; `null` while that is not known (not connected). Absent: everything they offer. */
-  permitted?: Readable<ReadonlySet<MachinesAction> | null>;
-}
-
-/**
- * A {@link MachinesError} from whatever a backend threw.
- *
- * @param kind - The action that failed.
- * @param error - What the backend threw or rejected with.
- */
-export function machinesError(kind: MachinesError['kind'], error: unknown): MachinesError {
-  if (isMachinesError(error)) return error;
-  const detail = error instanceof Error ? error.message : typeof error === 'string' ? error : String(error);
-  return { kind, detail };
-}
-
-/**
- * Whether a value is a {@link MachinesError}.
- *
- * @param value - Anything a host rejected with.
- */
-export function isMachinesError(value: unknown): value is MachinesError {
-  return (
-    typeof value === 'object' &&
-    value !== null &&
-    typeof (value as MachinesError).kind === 'string' &&
-    typeof (value as MachinesError).detail === 'string'
-  );
-}
-
-/**
- * Whether `permitted` lets an action through: always without the store (`undefined`), never while it is not known (`null`).
- *
- * @param permitted - The host's `permitted` value (`undefined` when the host has no such store).
- * @param action - The action.
- */
-export function isPermitted(
-  permitted: ReadonlySet<MachinesAction> | null | undefined,
-  action: MachinesAction,
-): boolean {
-  if (permitted === undefined) return true;
-  return permitted !== null && permitted.has(action);
-}

package/src/machines/headless/index.ts

@@ -1,13 +0,0 @@
-/**
- * `zidane-ui/machines/headless`: the React-free half of the machines area.
- * The `MachinesHost` seam, the stores every host builds (`lazyReadable`,
- * `createMachineLists`, `createOnlineMachines`), the wording helpers and the
- * labels.
- */
-export * from './host';
-export * from './stores';
-export * from './presence';
-export * from './sync';
-export * from './messages';
-export * from './labels';
-export * from './settings-focus';