zidane-ui 9.0.4 → 9.1.3

package/src/settings/headless/performance.ts

@@ -1,524 +0,0 @@
-/**
- * Settings › Performance, React-free: what a host measures (processes,
- * threads, IPC channels, slow frames, the GPU), the host member that streams
- * it (`SettingsHost.performance`), the monitor store a view reads, and the
- * formatting and ordering the section and the overlay share.
- *
- * Sampling costs CPU, so a host samples only while something watches:
- * {@link createPerfMonitor}'s `start` opens the watch, its disposer closes it.
- * A view starts it only while it is on screen.
- */
-import { writable, type Readable } from '../../chat/headless/store';
-
-/** What a process is to the app. */
-export type PerfProcessKind = 'main' | 'window' | 'page' | 'gpu' | 'utility' | 'daemon' | 'child' | 'other';
-
-/**
- * Whose cost a process is. `app`: the app's own (its processes, its daemon,
- * the servers and helpers they run). `launched`: what a session's commands, a
- * background task or a terminal started, and everything under it.
- */
-export type PerfOrigin = 'app' | 'launched';
-
-/** CPU and memory, summed. */
-export interface PerfTotals {
-  /** Percent of one core. */
-  cpu: number;
-  /** Resident, bytes. */
-  memory: number;
-}
-
-/** One process of the app, its daemon, or a program either started. */
-export interface PerfProcess {
-  /** The OS process id. */
-  pid: number;
-  /** The process it runs under in the tree shown (`null`: a root). */
-  parent: number | null;
-  /** What it is to the app. */
-  kind: PerfProcessKind;
-  /** A short name. */
-  label: string;
-  /** More: the command line, the service, the page's URL. */
-  detail?: string;
-  /** Whose cost it is. */
-  origin: PerfOrigin;
-  /** CPU over the last interval, percent of one core. */
-  cpu: number;
-  /** Resident memory, bytes. */
-  memory: number;
-  /** An MCP server's process: its server, and whether sessions share it. */
-  mcp?: PerfProcessMcp;
-  /** The session it runs for: a process a session started (a command, a terminal, its own MCP server), or one under it. */
-  session?: PerfProcessSession;
-}
-
-/** The session a process runs for. */
-export interface PerfProcessSession {
-  /** The session's key, as the app names sessions. */
-  id: string;
-  /** Its title; absent while it has none. */
-  title?: string;
-}
-
-/** The MCP server a process runs. */
-export interface PerfProcessMcp {
-  /** The server's name. */
-  name: string;
-  /** One process for every session, or one session's. */
-  shared: boolean;
-  /** Sessions holding it now. */
-  sessions: number;
-}
-
-/** A thread the app can name. */
-export interface PerfThread {
-  /** Unique among the sample's threads. */
-  id: string;
-  /** A short name. */
-  label: string;
-  /** The process it runs in. */
-  pid: number;
-  /** A process's main thread, a worker, a window's renderer, or a renderer's worker. */
-  kind: 'main' | 'worker' | 'renderer' | 'renderer-worker';
-  /** Share of the interval it was busy (0–1). */
-  busy: number;
-  /** JavaScript heap in use, bytes. */
-  heap?: number;
-}
-
-/** `invoke`: a request timed to its answer; `send`: a message to the host; `push`: a message from it. */
-export type PerfChannelDirection = 'invoke' | 'send' | 'push';
-
-/** One message channel's counters. */
-export interface PerfChannel {
-  /** The channel's name. */
-  channel: string;
-  /** Which way its messages go. */
-  direction: PerfChannelDirection;
-  /** Messages since the counters were last reset. */
-  count: number;
-  /** Time they took, summed (invokes: until answered). */
-  totalMs: number;
-  /** The slowest one. */
-  maxMs: number;
-  /** 95th percentile. */
-  p95Ms: number;
-}
-
-/** Where long frames (over 50 ms) spent their time: one script and function, summed. */
-export interface PerfSlowFrame {
-  /** The script (URL) the time was spent in. */
-  source: string;
-  /** The function. */
-  fn: string;
-  /** The window it ran in. */
-  window: string;
-  /** Long frames it was part of. */
-  count: number;
-  /** Time it took in them, summed. */
-  totalMs: number;
-  /** Its longest stretch in one frame. */
-  maxMs: number;
-}
-
-/** The host's event-loop delay over the last interval, ms. */
-export interface PerfLag {
-  /** Median. */
-  p50: number;
-  /** 99th percentile. */
-  p99: number;
-  /** The worst. */
-  max: number;
-}
-
-/** Whole-GPU use: every app's. */
-export interface PerfGpu {
-  /** Percent. */
-  device: number;
-  /** Renderer utilisation, percent, where the GPU reports it. */
-  renderer?: number;
-  /** Tiler utilisation, percent, where the GPU reports it. */
-  tiler?: number;
-  /** In use, bytes. */
-  memory?: number;
-}
-
-/** One sample. */
-export interface PerfSample {
-  /** Epoch ms. */
-  at: number;
-  /** Time since the previous sample, ms. */
-  intervalMs: number;
-  /** Logical cores (100% CPU is one of them). */
-  cores: number;
-  /** The app's processes, its daemon's and their children. */
-  processes: PerfProcess[];
-  /** The threads the app can name. */
-  threads: PerfThread[];
-  /** Message channels, counted since `countersSince`. */
-  channels: PerfChannel[];
-  /** Where long frames spent their time, since `countersSince`. */
-  frames: PerfSlowFrame[];
-  /** Since when the channel and frame counters count (epoch ms). */
-  countersSince: number;
-  /** The host's event-loop delay; `null`: not measured. */
-  lag: PerfLag | null;
-  /** `null`: not measured on this platform. */
-  gpu: PerfGpu | null;
-  /** The app's own processes together (origin `app`). */
-  totals: PerfTotals;
-  /** What sessions and terminals launched, together (origin `launched`). */
-  launched: PerfTotals;
-  /** The monitor's own cost: percent of one core, and the wall time of the commands it ran. */
-  self: { cpu: number; commandMs: number };
-}
-
-/** One OS thread of a process (no name on macOS). */
-export interface PerfOsThread {
-  /** The OS thread id. */
-  id: string;
-  /** Its name, where the OS gives one. */
-  label: string;
-  /** CPU over the last interval, percent of one core. */
-  cpu: number;
-}
-
-/** What a CPU profile records: the host's main process, or this window. */
-export type PerfProfileTarget = 'main' | 'window';
-
-/** A function a profile spent time in. */
-export interface PerfHotFunction {
-  /** The function's name. */
-  fn: string;
-  /** The script it is in. */
-  url: string;
-  /** Its line there. */
-  line: number;
-  /** Time in the function itself, not in what it called. */
-  selfMs: number;
-  /** Of the profile's busy time (0–1). */
-  share: number;
-}
-
-/** A recorded profile, saved where `path` says. */
-export interface PerfProfile {
-  /** The saved `.cpuprofile` file. */
-  path: string;
-  /** What was profiled. */
-  target: PerfProfileTarget;
-  /** How long it recorded. */
-  durationMs: number;
-  /** The functions it spent most time in, most first. */
-  top: PerfHotFunction[];
-}
-
-/** Why a profile wasn't recorded: `busy` (another profile or a debugger holds the target) or `failed`. */
-export interface PerfProfileError {
-  /** Which of the two. */
-  kind: 'busy' | 'failed';
-  /** The error's message, when there is one. */
-  detail?: string;
-}
-
-/** A profile, or why there is none. */
-export type PerfProfileOutcome = { ok: true; profile: PerfProfile } | { ok: false; error: PerfProfileError };
-
-/**
- * Why a host's figures can't be watched: `unavailable` (the host can't say:
- * a server too old for it), `refused` (the connection's token may not:
- * performance needs an admin token), `failed` (anything else, `detail` says).
- */
-export interface PerfWatchError {
-  /** Which of the three. */
-  kind: 'unavailable' | 'refused' | 'failed';
-  /** The error's message, when there is one. */
-  detail?: string;
-}
-
-/** The host's performance figures (Settings › Performance, the overlay). */
-export interface SettingsPerformanceHost {
-  /** The samples held, oldest first. */
-  history(): Promise<readonly PerfSample[]>;
-  /**
-   * Starts sampling (the host samples only while watched) and gets each
-   * sample; `onError` hears why the host can't be watched (at most once per
-   * watch, a sample after it means it recovered). Returns the unsubscribe.
-   */
-  watch(onSample: (sample: PerfSample) => void, onError?: (error: PerfWatchError) => void): () => void;
-  /** A process's OS threads, busiest first. Absent: rows don't expand. */
-  threads?(pid: number): Promise<readonly PerfOsThread[]>;
-  /** Zeroes the channel and frame counters. Absent: the host keeps no such counters (a server): no reset button, no Slow frames or IPC section. */
-  resetCounters?(): Promise<void>;
-  /** Writes a report and resolves where. Absent: no export button. */
-  exportReport?(): Promise<string>;
-  /** Records a CPU profile. Absent: no profile controls. */
-  profile?(target: PerfProfileTarget, seconds: number): Promise<PerfProfileOutcome>;
-}
-
-/** What a monitor holds. */
-export interface PerfMonitorState {
-  /** Oldest first, at most the monitor's capacity. */
-  samples: readonly PerfSample[];
-  /** Why the host can't be watched; `null` while it can (a sample clears it). */
-  error: PerfWatchError | null;
-}
-
-/** A view's window on the host's samples. */
-export interface PerfMonitor extends Readable<PerfMonitorState> {
-  /** Reads the history, then follows new samples; returns the stop. Counted: each start needs its stop. */
-  start(): () => void;
-}
-
-/** Samples kept: 5 minutes at the desktop app's 2 s. */
-export const PERF_HISTORY = 150;
-
-/**
- * Creates a monitor over a host.
- *
- * @param host - The host's performance member.
- * @param capacity - Samples kept.
- */
-export function createPerfMonitor(host: SettingsPerformanceHost, capacity = PERF_HISTORY): PerfMonitor {
-  const state = writable<PerfMonitorState>({ samples: [], error: null });
-  const fail = (error: PerfWatchError) => state.set((prev) => ({ ...prev, error }));
-  const add = (incoming: readonly PerfSample[]) =>
-    state.set((prev) => {
-      let last = prev.samples[prev.samples.length - 1]?.at ?? -Infinity;
-      const fresh: PerfSample[] = [];
-      for (const sample of incoming) {
-        if (sample.at <= last) continue;
-        fresh.push(sample);
-        last = sample.at;
-      }
-      if (fresh.length === 0) return prev;
-      return { samples: [...prev.samples, ...fresh].slice(-capacity), error: null };
-    });
-  let starts = 0;
-  let stop: (() => void) | null = null;
-  return {
-    get: state.get,
-    subscribe: state.subscribe,
-    start() {
-      starts += 1;
-      if (starts === 1) {
-        let live = true;
-        const pending: PerfSample[] = [];
-        let loaded = false;
-        const off = host.watch(
-          (sample) => (loaded ? add([sample]) : pending.push(sample)),
-          (error) => {
-            if (live) fail(error);
-          },
-        );
-        void host.history().then(
-          (history) => {
-            if (!live) return;
-            loaded = true;
-            add([...history, ...pending].sort((a, b) => a.at - b.at));
-          },
-          () => {
-            loaded = true;
-            add(pending);
-          },
-        );
-        stop = () => {
-          live = false;
-          off();
-        };
-      }
-      let stopped = false;
-      return () => {
-        if (stopped) return;
-        stopped = true;
-        starts -= 1;
-        if (starts === 0) {
-          stop?.();
-          stop = null;
-        }
-      };
-    },
-  };
-}
-
-/** A process with its depth in the tree, for an indented list. */
-export interface PerfProcessRow {
-  /** The process. */
-  process: PerfProcess;
-  /** Its depth in the tree (0: a root). */
-  depth: number;
-}
-
-/**
- * The processes as a tree, each parent before its children, siblings busiest first.
- *
- * @param processes - One sample's.
- */
-export function processTree(processes: readonly PerfProcess[]): PerfProcessRow[] {
-  const pids = new Set(processes.map((p) => p.pid));
-  const children = new Map<number | null, PerfProcess[]>();
-  for (const process of processes) {
-    const parent = process.parent !== null && pids.has(process.parent) ? process.parent : null;
-    const list = children.get(parent);
-    if (list) list.push(process);
-    else children.set(parent, [process]);
-  }
-  const out: PerfProcessRow[] = [];
-  const walk = (parent: number | null, depth: number) => {
-    const list = (children.get(parent) ?? []).slice().sort((a, b) => {
-      // The app's main process leads its own tree.
-      if (a.kind === 'main' || b.kind === 'main') return a.kind === 'main' ? -1 : 1;
-      return b.cpu - a.cpu;
-    });
-    for (const process of list) {
-      out.push({ process, depth });
-      if (process.pid !== parent) walk(process.pid, depth + 1);
-    }
-  };
-  walk(null, 0);
-  return out;
-}
-
-/**
- * The processes as two trees, the app's own and what was launched: a
- * launched tree's roots are what a session or a terminal started.
- *
- * @param processes - One sample's.
- */
-export function processGroups(processes: readonly PerfProcess[]): Record<PerfOrigin, PerfProcessRow[]> {
-  return {
-    app: processTree(processes.filter((p) => p.origin === 'app')),
-    launched: processTree(processes.filter((p) => p.origin === 'launched')),
-  };
-}
-
-/** A process with the processes it started, for a tree that opens one level at a time. */
-export interface PerfProcessNode {
-  /** The process. */
-  process: PerfProcess;
-  /** What it started, in {@link processTree}'s order. */
-  children: PerfProcessNode[];
-  /** Every process under it, at any depth. */
-  descendants: number;
-  /** What every process under it uses, summed (its own figures left out). */
-  inside: PerfTotals;
-}
-
-/**
- * Nests {@link processTree}'s rows (each parent before its children).
- *
- * @param rows - One origin's rows, in tree order.
- * @returns The roots.
- */
-export function nestProcesses(rows: readonly PerfProcessRow[]): PerfProcessNode[] {
-  const roots: PerfProcessNode[] = [];
-  // The open path: the last node seen at each depth.
-  const path: PerfProcessNode[] = [];
-  for (const { process, depth } of rows) {
-    const node: PerfProcessNode = { process, children: [], descendants: 0, inside: { cpu: 0, memory: 0 } };
-    path.length = depth;
-    const parent = path[depth - 1];
-    if (parent) parent.children.push(node);
-    else roots.push(node);
-    for (const ancestor of path) {
-      ancestor.descendants += 1;
-      ancestor.inside.cpu += process.cpu;
-      ancestor.inside.memory += process.memory;
-    }
-    path.push(node);
-  }
-  return roots;
-}
-
-/** What one session's processes use. */
-export interface PerfSessionGroup {
-  /** The session's key. */
-  id: string;
-  /** Its title; absent while it has none. */
-  title?: string;
-  /** Its processes as a tree: what the session started, each with what runs under it. */
-  roots: PerfProcessNode[];
-  /** How many processes it has. */
-  count: number;
-  /** What they use together. */
-  totals: PerfTotals;
-}
-
-/**
- * The processes per session, busiest first: each session's own tree.
- *
- * @param processes - One sample's.
- */
-export function sessionGroups(processes: readonly PerfProcess[]): PerfSessionGroup[] {
-  const bySession = new Map<string, { session: PerfProcessSession; processes: PerfProcess[] }>();
-  for (const process of processes) {
-    if (!process.session) continue;
-    const group = bySession.get(process.session.id);
-    if (group) group.processes.push(process);
-    else bySession.set(process.session.id, { session: process.session, processes: [process] });
-  }
-  return [...bySession.values()]
-    .map(({ session, processes: own }) => ({
-      id: session.id,
-      ...(session.title ? { title: session.title } : {}),
-      roots: nestProcesses(processTree(own)),
-      count: own.length,
-      totals: {
-        cpu: own.reduce((sum, p) => sum + p.cpu, 0),
-        memory: own.reduce((sum, p) => sum + p.memory, 0),
-      },
-    }))
-    .sort((a, b) => b.totals.cpu - a.totals.cpu || b.totals.memory - a.totals.memory);
-}
-
-/**
- * Whether a sample holds anything sessions or terminals launched.
- *
- * @param sample - The sample.
- */
-export function hasLaunched(sample: PerfSample): boolean {
-  return sample.processes.some((p) => p.origin === 'launched');
-}
-
-/**
- * One value per sample, for a sparkline.
- *
- * @param samples - Oldest first.
- * @param pick - The value of a sample (`undefined`: a gap, drawn as 0).
- */
-export function perfSeries(samples: readonly PerfSample[], pick: (sample: PerfSample) => number | undefined): number[] {
-  return samples.map((sample) => pick(sample) ?? 0);
-}
-
-/**
- * `12.3%` under 100, `140%` above (several cores).
- *
- * @param value - A percentage.
- */
-export function formatPercent(value: number): string {
-  if (!Number.isFinite(value)) return '–';
-  return value >= 100 || value === 0 ? `${Math.round(value)}%` : `${value.toFixed(1)}%`;
-}
-
-/**
- * `512 KB`, `84 MB`, `1.4 GB`.
- *
- * @param bytes - A size.
- */
-export function formatMemory(bytes: number): string {
-  if (!Number.isFinite(bytes) || bytes < 0) return '–';
-  if (bytes < 1024 * 1024) return `${Math.round(bytes / 1024)} KB`;
-  if (bytes < 1024 ** 3) return `${Math.round(bytes / 1024 ** 2)} MB`;
-  return `${(bytes / 1024 ** 3).toFixed(1)} GB`;
-}
-
-/**
- * `0.4 ms`, `38 ms`, `2.1 s`.
- *
- * @param ms - A duration.
- */
-export function formatDuration(ms: number): string {
-  if (!Number.isFinite(ms)) return '–';
-  if (ms < 10) return `${ms.toFixed(1)} ms`;
-  if (ms < 1000) return `${Math.round(ms)} ms`;
-  return `${(ms / 1000).toFixed(1)} s`;
-}

package/src/settings/headless/providers.ts

@@ -1,117 +0,0 @@
-/**
- * The `SettingsHost` member group of Settings › Accounts: the providers a
- * host's agents sign in to, their stored credentials, keys and browser
- * sign-ins. Optional; an action the group leaves out hides its control.
- * React-free.
- *
- * The list comes as a {@link SettingsResource}, kept current by the host:
- * after an action resolves, the list shows what it did. A rejection is a
- * `SettingsError` (or anything `toSettingsError` wraps), worded by the
- * section's labels.
- */
-import type { SignInFlow } from '../../onboarding/headless/host';
-import type { SettingsResource } from './sections-host';
-
-/** One credential source of a provider. Never a secret. */
-export interface SettingsCredential {
-  /** Where it comes from: a stored API key, an OAuth account, or an environment variable (observed, never stored). */
-  source: 'apikey' | 'oauth' | 'env';
-  /** What to show: the credentials file, an OAuth account's expiry, an env var name. */
-  detail: string;
-  /** The stored credential every reader resolves (`env` never is). */
-  active?: boolean;
-  /** Its key in the credentials store: what `remove`, `rename` and `setPreferred` name. Absent: not stored. */
-  key?: string;
-  /** An OAuth account's name. */
-  label?: string;
-}
-
-/** A configuration field a provider asks for instead of an API key (an endpoint, a project id). */
-export interface SettingsProviderField {
-  /** The field's key in `configure`. */
-  key: string;
-  /** Its caption. */
-  label: string;
-  /** Its placeholder. */
-  placeholder?: string;
-  /** One line under it. */
-  hint?: string;
-  /** Saving needs it. */
-  required?: boolean;
-  /** Typed masked; a blank value keeps the stored one. */
-  secret?: boolean;
-}
-
-/** A provider and its sign-in state, as the host reports it. Never a secret. */
-export interface SettingsProvider {
-  /** Provider key. */
-  key: string;
-  /** Display name. */
-  label: string;
-  /** One line on what it serves and how it signs in. */
-  description?: string;
-  /** The account its browser sign-in uses, for "Sign in with …". Default: `label`. */
-  signInLabel?: string;
-  /** Placeholder of its API key field. */
-  apiKeyPlaceholder?: string;
-  /** Added by an extension of the folder, not built in. */
-  extension?: boolean;
-  /** Some credential source is present. */
-  available: boolean;
-  /** An API key is stored. */
-  hasApiKey: boolean;
-  /** An OAuth account is stored. */
-  hasOAuth: boolean;
-  /** It can sign in with a browser now (with `SettingsProvidersHost.signIn`). */
-  oauth: boolean;
-  /** Its credential sources, stored ones first. */
-  methods: readonly SettingsCredential[];
-  /** Configuration fields it takes instead of an API key. */
-  customFields?: readonly SettingsProviderField[];
-  /** The non-secret field values stored now. */
-  configuredFields?: Readonly<Record<string, string>>;
-}
-
-/** What a browser sign-in is for. */
-export interface SettingsSignInOptions {
-  /** The new account's name (a second account of the provider). */
-  label?: string;
-  /** The stored account it signs in again. */
-  replaceKey?: string;
-}
-
-/** What `setPreferred` promotes: a stored credential by key, or the first stored one of a kind. */
-export type SettingsPreferredCredential = 'apikey' | 'oauth' | { key: string };
-
-/**
- * The providers a host's agents use (Settings › Accounts). `cwd` is the
- * folder whose extension providers count (`''`: built-ins only).
- */
-export interface SettingsProvidersHost {
-  /** The providers and their sign-in state. */
-  list(cwd: string): SettingsResource<readonly SettingsProvider[]>;
-  /** Stores an API key. Absent: no key form. */
-  setApiKey?(cwd: string, provider: string, key: string): Promise<void>;
-  /** Stores a provider's configuration fields. Absent: no configuration form. */
-  configure?(cwd: string, provider: string, fields: Readonly<Record<string, string>>): Promise<void>;
-  /** Removes every stored credential of a provider. Absent: no Clear. */
-  clear?(cwd: string, provider: string): Promise<void>;
-  /** Removes one stored credential (`SettingsCredential.key`). Absent: no Remove. */
-  remove?(cwd: string, provider: string, credential: string): Promise<void>;
-  /** Makes a stored credential the one every reader resolves. Absent: no Use. */
-  setPreferred?(cwd: string, provider: string, target: SettingsPreferredCredential): Promise<void>;
-  /** Renames a stored OAuth account. Absent: no Rename. */
-  rename?(cwd: string, provider: string, credential: string, label: string): Promise<void>;
-  /** Starts a browser sign-in; once it is done, `list` shows the account. Absent: keys only. */
-  signIn?(provider: string, options?: SettingsSignInOptions): SignInFlow;
-}
-
-/**
- * Whether a provider holds more than one stored credential, so there is a
- * choice of which one is in use (the TUI's expandable auth rows).
- *
- * @param provider - The provider.
- */
-export function hasCredentialChoice(provider: Pick<SettingsProvider, 'methods'>): boolean {
-  return provider.methods.filter((method) => method.source !== 'env').length > 1;
-}

package/src/settings/headless/registry.ts

@@ -1,52 +0,0 @@
-/**
- * The settings section registry: the shell (`SettingsShell`) renders the
- * sections an app hands it (the kit's own, the per-device preference
- * sections, an app's desktop-only ones), in order. React-free: `render`
- * returns what the styled shell renders (a ReactNode there), typed
- * `unknown` here.
- *
- * A section's body reads its context through hooks, never through
- * `render` arguments: `useSettingsSection()` (zidane-ui/settings) gives
- * whether it is the open one, the row a deep link or search landed on, and
- * the header slot its actions portal into.
- */
-export interface SettingsSection {
-  /** Stable id: deep links (`initialSection`, `select(id, focus)`) and search results name it. */
-  id: string;
-  /** The nav entry and the header title, already worded by the registrant. */
-  title: string;
-  /** An icon class (UnoCSS icon, e.g. `i-ph-paint-brush`) the nav draws. */
-  icon?: string;
-  /**
-   * The id of the top-level section this one is listed under (indented
-   * beneath it in the nav, e.g. `'interface'` for Appearance). Absent: a
-   * top-level entry.
-   */
-  group?: string;
-  /** Extra words the settings search matches on the section itself. */
-  keywords?: string[];
-  /** Under the title in the header. */
-  description?: string;
-  /**
-   * Search entries for the rows inside the section: each lands on the
-   * section and, with a `key`, on the row carrying `data-setting-focus={key}`.
-   * Absent: the section is found by its title, description and keywords.
-   */
-  search?: readonly SettingsSearchEntry[];
-  /** Keep the body mounted (hidden) after its first visit, so its async state survives switching away. */
-  keepMounted?: boolean;
-  /** The section body. */
-  render: () => unknown;
-}
-
-/** One search entry inside a section. */
-export interface SettingsSearchEntry {
-  /** The result's label. */
-  label: string;
-  /** The result's description. */
-  description: string;
-  /** The row's `data-setting-focus` id the result lands on (and searchable). */
-  key?: string;
-  /** More words it matches. */
-  keywords?: readonly string[];
-}