@dcasegr/skein 0.0.0-stage → 0.1.1

package/dist/host/cli.d.ts

@@ -0,0 +1,57 @@
+#!/usr/bin/env -S node --experimental-strip-types --no-warnings
+import { DEFAULT_IMAGE } from "./boot.ts";
+import type { Server } from "node:http";
+import type { Store } from "../runtime/store.ts";
+import { homeOf as homeOfVars } from "./hostenv.ts";
+import { Router, type RouterOptions } from "./router.ts";
+import { HostDb, type InstanceRow } from "./instances.ts";
+export interface Env {
+    vars: Record<string, string | undefined>;
+    out(line: string): void;
+    err(line: string): void;
+    /** Tests: a row's store, instead of opening its file read-only. */
+    store?(row: InstanceRow): Store | undefined;
+}
+export declare const homeOf: typeof homeOfVars;
+export declare function main(argv: string[], given: Env): Promise<number>;
+/** The network the whole host runs on (SKEIN_NETWORK, default main): a network fact, written as every genesis's `defaults.walletNetwork`. */
+export declare const NETWORKS: readonly ["main", "test", "regtest"];
+export declare function hostNetwork(v: Env["vars"]): string;
+/**
+ * An instance's origin here (router.ts originOf): its front door, its
+ * messagebox — SKEIN_INSTANCE_ORIGIN (default http://{handle}.localhost:{port})
+ * on SKEIN_ROUTER_PORT (default 8100).
+ */
+export declare function originOf(vars: Env["vars"], handle: string): string;
+/** The onboarding app's config at the host skein's birth (#142), from the settings: domain, origin, name, note. */
+export declare function onboardConfig(v: Env["vars"]): Record<string, Record<string, unknown>>;
+export interface RunOptions {
+    /** The router's options beyond what the environment gives (tests). */
+    router?: Partial<RouterOptions>;
+    /** false: no host skein on the first run (tests that make their own). */
+    firstRun?: boolean;
+}
+export interface Host {
+    router: Router;
+    /** The messagebox (router) port and the host page's. */
+    messagebox?: number;
+    server?: Server;
+    port?: number;
+    stop(): Promise<void>;
+}
+/** The default image (#89): one genesis for everyone, no owner in it, a claim row (boot.ts). */
+export { DEFAULT_IMAGE };
+/**
+ * `skein-host run`: the router (router.ts) on SKEIN_ROUTER_PORT (default
+ * 8100, the messagebox URL clients already use), every enabled row hydrated
+ * once at start (stopped only past SKEIN_IDLE_MS), and the host page and roster on
+ * SKEIN_HOST_PORT. A skein's explorer is its own (`/explore`, its owner's),
+ * read by the management site (shruggr/skein-site, #92).
+ */
+export declare function runHost(db: HostDb, env: Env, o?: RunOptions): Promise<Host>;
+/**
+ * The host's SQLite database for new instances (the settled split, 2026-10-31): SKEIN_STORE_SQLITE, else
+ * $SKEIN_HOME/store.sqlite when this installation has no native kernel binary (the npm package ships the
+ * wasm kernel only) and no other shared store is named; else none (a native kernel per instance store).
+ */
+export declare function sqliteStoreOf(v: Record<string, string | undefined>, home: string): string | undefined;