{ "package": "@arki/dot", "version": "0.7.0", "entries": [ { "subpath": ".", "name": "ActionDiagnostic", "kind": "type", "signature": "export type ActionDiagnostic = { id: string; plugin: string; binding: string; /** The action's summary, when it has one (post-boot, as completed by `$describeAction`). */ summary?: string; /** Structural configure-phase health only; not runtime liveness. */ status: Extract; issues: DiagnosticIssue[]; };", "jsdocSummary": "" }, { "subpath": ".", "name": "ActionDirection", "kind": "type", "signature": "export type ActionDirection = 'in' | 'out';", "jsdocSummary": "Direction of a boundary interaction, viewed from the app." }, { "subpath": ".", "name": "ActionManifest", "kind": "type", "signature": "export type ActionManifest = { /** Stable identifier, e.g. `orders.list` or `orders.created.consume`. */ id: string; plugin: string; /** Adapter-owned binding name: `http`, `queue`, `cli`, `cron`, etc. */ binding: string; /** `in` = world invokes/feeds the app; `out` = app emits. */ direction: ActionDirection; /** Display-only address printed by `dot explain`. */ address?: string; /** Human summary rendered into explain output and projected documents. */ summary?: string; /** Adapter-owned, JSON-serializable detail. Opaque to the kernel. */ meta?: Readonly; /** Optional adapter-owned identifier+version for the meta layout. */ metaSchema?: string; };", "jsdocSummary": "Something the app does at a boundary — universal, serializable, tiny." }, { "subpath": ".", "name": "ActionSource", "kind": "type", "signature": "export type ActionSource = ActionDeclaration | { toDotAction(): ActionDeclaration; };", "jsdocSummary": "Structural protocol for adapter-owned declarations." }, { "subpath": ".", "name": "AnyPlugin", "kind": "type", "signature": "export type AnyPlugin = Plugin;", "jsdocSummary": "Internal type alias used by the kernel to erase plugin service generics." }, { "subpath": ".", "name": "AuthoredPlugin", "kind": "type", "signature": "export type AuthoredPlugin = Omit, 'logging' | 'factories' | 'hooks'> & LoggingSlot & FactoryContract> & { readonly factories: { readonly [Key in keyof Values]: (ctx: never) => Values[Key]; }; readonly hooks: PhaseHooks & { readonly boot?: (ctx: CtxOf & Provides & KernelCtx) => MaybePromise; }; };", "jsdocSummary": "Authored plugins retain the callbacks that own their runtime failures." }, { "subpath": ".", "name": "bootTestApp", "kind": "function", "signature": "export declare function bootTestApp(plugins?: TPlugins & TestAppGuard, options?: TestAppOptions): Promise, PluginCloseFailure, PluginOpenFailure, PluginPhaseFailures> | Failure<\"async.cancelled\", undefined> | Failure<\"async.deadline\", undefined> | Failure<\"failure.unexpected_defect\", undefined> | Exclude[\"configure\"], void> | Exclude[\"close\"], void>, void> | Exclude[\"open\"], void>, void> | Exclude infer Value ? Value : never : never : never; }, Hooks extends { readonly boot?: (...args: never[]) => infer Boot; } ? Awaited : never> : import(\"./plugin-contract.js\").EmptyOwnership : never : never)[\"close\"], void>, void> | Exclude infer Value ? Value : never : never : never; }, Hooks extends { readonly boot?: (...args: never[]) => infer Boot; } ? Awaited : never> : import(\"./plugin-contract.js\").EmptyOwnership : never : never)[\"open\"], void>, void> | Exclude infer Result; } ? Result : never : never : never) extends infer T_5 ? T_5 extends (TPlugins[number] extends infer T_4 ? T_4 extends TPlugins[number] ? T_4 extends { readonly logging?: (...args: never[]) => infer Result; } ? Result : never : never : never) ? T_5 extends Record<\"close\", infer Callback extends (...args: never[]) => unknown> ? Extract>, Failure> : never : never : never, void>, void> | Exclude infer Result; } ? Result : never : never : never, Failure>, void>, void> | import(\"@arki/async\").ScopeAggregate | PluginOpenFailure | import(\"@arki/async\").SupervisorFailure, PluginCloseFailure | import(\"@arki/async\").SupervisorFailure> | import(\"@arki/async\").ScopeAggregate[\"close\"], void> | Exclude[\"open\"], void> | Exclude<(TPlugins[number] extends infer T_3 ? T_3 extends TPlugins[number] ? T_3 extends { readonly factories: infer Factories; readonly hooks: infer Hooks; } ? InferredOwnership<{ [Key in keyof Factories]: Factories[Key] extends infer T_4 ? T_4 extends Factories[Key] ? T_4 extends (...args: never[]) => infer Value ? Value : never : never : never; }, Hooks extends { readonly boot?: (...args: never[]) => infer Boot; } ? Awaited : never> : import(\"./plugin-contract.js\").EmptyOwnership : never : never)[\"close\"], void> | Exclude<(TPlugins[number] extends infer T_3 ? T_3 extends TPlugins[number] ? T_3 extends { readonly factories: infer Factories; readonly hooks: infer Hooks; } ? InferredOwnership<{ [Key in keyof Factories]: Factories[Key] extends infer T_4 ? T_4 extends Factories[Key] ? T_4 extends (...args: never[]) => infer Value ? Value : never : never : never; }, Hooks extends { readonly boot?: (...args: never[]) => infer Boot; } ? Awaited : never> : import(\"./plugin-contract.js\").EmptyOwnership : never : never)[\"open\"], void> | Exclude<(TPlugins[number] extends infer T_4 ? T_4 extends TPlugins[number] ? T_4 extends { readonly logging?: (...args: never[]) => infer Result; } ? Result : never : never : never) extends infer T_5 ? T_5 extends (TPlugins[number] extends infer T_4 ? T_4 extends TPlugins[number] ? T_4 extends { readonly logging?: (...args: never[]) => infer Result; } ? Result : never : never : never) ? T_5 extends Record<\"close\", infer Callback extends (...args: never[]) => unknown> ? Extract>, Failure> : never : never : never, void> | Exclude infer Result; } ? Result : never : never : never, Failure>, void> | import(\"@arki/async\").SupervisorFailure | import(\"@arki/async\").ScopeAggregate | PluginOpenFailure | import(\"@arki/async\").SupervisorFailure, PluginCloseFailure | import(\"@arki/async\").SupervisorFailure>, PluginPhaseFailures[\"dispose\"] | (Failure<\"async.cancelled\", undefined> | Failure<\"async.deadline\", undefined> | Failure<\"failure.unexpected_defect\", undefined> | Exclude[\"close\"], void> | Exclude<(TPlugins[number] extends infer T_3 ? T_3 extends TPlugins[number] ? T_3 extends { readonly factories: infer Factories; readonly hooks: infer Hooks; } ? InferredOwnership<{ [Key in keyof Factories]: Factories[Key] extends infer T_4 ? T_4 extends Factories[Key] ? T_4 extends (...args: never[]) => infer Value ? Value : never : never : never; }, Hooks extends { readonly boot?: (...args: never[]) => infer Boot; } ? Awaited : never> : import(\"./plugin-contract.js\").EmptyOwnership : never : never)[\"close\"], void> | Exclude<(TPlugins[number] extends infer T_4 ? T_4 extends TPlugins[number] ? T_4 extends { readonly logging?: (...args: never[]) => infer Result; } ? Result : never : never : never) extends infer T_5 ? T_5 extends (TPlugins[number] extends infer T_4 ? T_4 extends TPlugins[number] ? T_4 extends { readonly logging?: (...args: never[]) => infer Result; } ? Result : never : never : never) ? T_5 extends Record<\"close\", infer Callback extends (...args: never[]) => unknown> ? Extract>, Failure> : never : never : never, void> | import(\"@arki/async\").ScopeAggregate | import(\"@arki/async\").SupervisorFailure, PluginCloseFailure | import(\"@arki/async\").SupervisorFailure>)>>;", "jsdocSummary": "Build and boot an app, returning declared ownership failures to its caller." }, { "subpath": ".", "name": "CtxOf", "kind": "type", "signature": "export type CtxOf = { [K in keyof S]: WitnessContext; };", "jsdocSummary": "Local-alias view of a needs shape — what lifecycle hooks destructure. `{ cache: Token }` → `{ cache: KV }`. `{ search: service.lazy() }` → `{ search: Lazy }`." }, { "subpath": ".", "name": "defineApp", "kind": "function", "signature": "export declare function defineApp(name: string, options?: { version?: string; config?: Readonly>; /** * In-process lifecycle observers, registered before the first phase * fires. Required if you want to see `configure`-phase events — after * configure runs, observers can be added post-hoc via * `configured.subscribe(...)` or `app.subscribe(...)`. */ observers?: readonly DotLifecycleObserver[]; /** * Watchdog budget (ms) for each async hook invocation (`boot`, `start`, * `stop`, `dispose` — `configure` is sync). A hook exceeding the budget * fails with `ARKI_DOT_E015` naming the plugin and hook, and the * kernel applies its normal failure rules (boot rollback, teardown * aggregation). The hook's promise itself cannot be cancelled — the * watchdog makes the hang *visible*, it does not kill it. Default: * no watchdog. */ hookTimeoutMs?: number; clock?: Clock; }): DotAppBuilder;", "jsdocSummary": "Create a new DOT app builder." }, { "subpath": ".", "name": "DependencyEdge", "kind": "type", "signature": "export type DependencyEdge = { from: string; to: string; kind: DependencyEdgeKind; /** * The capability (wire key) the edge carries. Set on edges the kernel * derives before boot from a feature's static `provides`. */ key?: string; };", "jsdocSummary": "Directed edge in the plugin dependency graph." }, { "subpath": ".", "name": "DependencyEdgeKind", "kind": "type", "signature": "export type DependencyEdgeKind = 'requires' | 'provides' | 'uses';", "jsdocSummary": "Kind of dependency edge between two plugins." }, { "subpath": ".", "name": "DiagnosticIssue", "kind": "type", "signature": "export type DiagnosticIssue = { /** Stable machine-readable code, e.g. `ARKI_DOT_E003`. */ code: string; severity: DiagnosticSeverity; plugin?: string; message: string; /** Human-readable remediation: what the developer should do. */ remediation: string; /** Link to the relevant docs page for this issue. */ docsUrl: string; metadata?: Record; };", "jsdocSummary": "Single structured issue surfaced by the kernel or by a plugin." }, { "subpath": ".", "name": "DiagnosticSeverity", "kind": "type", "signature": "export type DiagnosticSeverity = 'info' | 'warning' | 'error';", "jsdocSummary": "Severity of a single diagnostic issue." }, { "subpath": ".", "name": "DiagnosticStatus", "kind": "type", "signature": "export type DiagnosticStatus = 'ok' | 'degraded' | 'failed' | 'skipped' | 'missing';", "jsdocSummary": "Status of a plugin/action/service/lifecycle entry." }, { "subpath": ".", "name": "DOT_LIFECYCLE_HOOKS", "kind": "variable", "signature": "export declare const DOT_LIFECYCLE_HOOKS: readonly DotLifecycleHook[];", "jsdocSummary": "The complete set of lifecycle hooks in execution order. `stop` and `dispose` run in reverse declaration order across plugins, but the sequence of hooks themselves is always `configure -> boot -> start -> stop -> dispose`." }, { "subpath": ".", "name": "DOT_MANIFEST_ERROR_CODE", "kind": "variable", "signature": "export declare const DOT_MANIFEST_ERROR_CODE = \"ARKI_DOT_E032\";", "jsdocSummary": "Code of {@link DotManifestError}." }, { "subpath": ".", "name": "DotApp", "kind": "type", "signature": "export type DotApp = { /** App name (passed to `defineApp`). */ readonly name: string; /** Current lifecycle state. */ readonly state: DotLifecycleState; /** * Services published by booted plugins, keyed by wire key. * Empty before `boot()` succeeds. */ readonly services: TServices; /** Declarative manifest — describes the static shape of the app. */ readonly manifest: DotAppManifest; /** Point-in-time diagnostics snapshot. Re-computed on every access. */ readonly diagnostics: DotDiagnosticsSnapshot; /** * Start active work. Boots first if app is `defined` or `configured`. * Idempotent while `started`. Returns a defect if the app is `failed` or `disposed`. */ start(): Promise>; /** * Stop active work. Keeps booted resources for later cleanup. * Idempotent while not `started`. */ stop(): Promise>; /** * Release booted resources. Runs stop() first if `started`. * Idempotent while `disposed`. */ dispose(): Promise>; /** * Register an in-process lifecycle observer. Returns an unsubscribe * function. Observers added here see events from this point onward — * pass observers through `defineApp(name, { observers })` to catch * `configure`-phase events too. */ subscribe(observer: DotLifecycleObserver): () => void; /** * Render the recorded lifecycle as an ASCII waterfall. Reads from * the current `diagnostics` snapshot — call after `boot()` / * `dispose()` / a failure to see the full picture. */ timeline(): string; };", "jsdocSummary": "Public DotApp surface. The internal `DotAppImpl` implements this; consumers see only these members." }, { "subpath": ".", "name": "DotAppBuilder", "kind": "type", "signature": "export type DotAppBuilder = Pick, keyof Builder>;", "jsdocSummary": "Builder produced by `defineApp(name)`. The app reads as a hexagon:" }, { "subpath": ".", "name": "DotAppConfigured", "kind": "type", "signature": "export type DotAppConfigured = { readonly name: string; readonly state: DotLifecycleState; readonly manifest: DotAppManifest; readonly diagnostics: DotDiagnosticsSnapshot; /** Continue the lifecycle. */ boot(): Promise | Exclude, void>>; start(): Promise | Exclude, void>>; /** See {@link DotApp.subscribe}. */ subscribe(observer: DotLifecycleObserver): () => void; /** See {@link DotApp.timeline}. */ timeline(): string; };", "jsdocSummary": "Intermediate type after `configure()` but before `boot()`. Exposes the manifest and diagnostics already, but no `services` yet." }, { "subpath": ".", "name": "DotAppLifecycle", "kind": "type", "signature": "export type DotAppLifecycle = Pick, 'configure' | 'boot' | 'start'>;", "jsdocSummary": "Lifecycle entry points every builder phase shares." }, { "subpath": ".", "name": "DotAppManifest", "kind": "type", "signature": "export type DotAppManifest = { /** Manifest schema version. 2 = actions/projections era. */ manifestVersion: 2; app: { name: string; version?: string; }; plugins: PluginManifest[]; actions: ActionManifest[]; services: ServiceManifest[]; lifecycle: LifecycleManifest[]; dependencies: DependencyEdge[]; projections: ProjectionManifest[]; };", "jsdocSummary": "Top-level manifest describing the static shape of a DOT app." }, { "subpath": ".", "name": "DotConfigureContext", "kind": "type", "signature": "export type DotConfigureContext = { /** Custom telemetry scoped to this plugin, sharing its active configure span. */ readonly $telemetry: DotTelemetry; pluginName: string; /** App name. */ appName: string; /** * Register a service this plugin publishes, for manifest/diagnostics * purposes. Registration is metadata-only — the actual service instance * is returned from its `provides` factory. */ registerService(name: string, kind: ServiceKind): void; /** Register an action this plugin contributes at an app boundary. */ registerAction(action: ActionDeclaration): void; /** Register a projection renderer this plugin contributes. */ registerProjection(projection: ProjectionDeclaration): void; /** * Replace the `summary` of an action already registered. Same ownership * rule as `$describeAction` (see {@link KernelCtx}); in `configure` it sees * the actions of plugins mounted earlier. */ describeAction(actionId: string, patch: { readonly summary: string; }): void; /** @deprecated Use `registerAction`; removed in DOT 0.5.0. */ registerRoute(route: LegacyRouteDeclaration): void; /** Mark the plugin as participating in a lifecycle hook. */ registerLifecycleHook(hook: 'configure' | 'boot' | 'start' | 'stop' | 'dispose'): void; /** Append `provides` capability strings (informational, manifest-only). */ declareProvides(...capabilities: string[]): void; };", "jsdocSummary": "" }, { "subpath": ".", "name": "DotDiagnosticsSnapshot", "kind": "type", "signature": "export type DotDiagnosticsSnapshot = { /** Diagnostic snapshot schema version. 2 = actions/projections era. */ snapshotVersion: 2; /** ISO-8601 timestamp at which the snapshot was generated. */ generatedAt: string; app: { name: string; state: DotLifecycleState; }; plugins: PluginDiagnostic[]; actions: ActionDiagnostic[]; services: ServiceDiagnostic[]; lifecycle: LifecycleDiagnostic[]; issues: DiagnosticIssue[]; };", "jsdocSummary": "Single point-in-time diagnostic snapshot of a DotApp." }, { "subpath": ".", "name": "DotLifecycleError", "kind": "class", "signature": "export declare class DotLifecycleError extends Error { readonly code: DotLifecycleErrorCodeValue; /** One-sentence guidance on how to fix the problem. Same shape as `DotPluginError.remediation`. */ readonly remediation: string; /** Documentation page that explains this error. */ readonly docsUrl: string; readonly phase: DotLifecycleHook; readonly plugin?: string; readonly cause?: unknown; readonly failures?: readonly DotLifecyclePluginFailure[]; constructor(args: { code: DotLifecycleErrorCodeValue; phase: DotLifecycleHook; message: string; /** Overrides the stock remediation for this code. */ remediation?: string; plugin?: string; cause?: unknown; failures?: readonly DotLifecyclePluginFailure[]; }); }", "jsdocSummary": "Structured error thrown for any lifecycle failure or misuse." }, { "subpath": ".", "name": "DotLifecycleErrorCode", "kind": "variable", "signature": "export declare const DotLifecycleErrorCode: { /** * A `configure` hook attempted async work (returned a Promise). * @fix Make `configure` synchronous and move async work to `boot`. * @verify dot explain --json | jq -e .ok */ readonly ConfigureAsync: 'ARKI_DOT_E001'; /** * A `configure` hook threw. * @fix Fix the plugin's config or its `configure` hook, then build a new app. * @verify dot explain --json | jq -e .ok */ readonly ConfigureFailed: 'ARKI_DOT_E002'; /** * A `boot` hook threw. * @fix Read `cause` and `plugin`, then fix that plugin's `boot` hook or the service it opens. * @verify dot doctor --json | jq -e .ok */ readonly BootFailed: 'ARKI_DOT_E003'; /** * A `start` hook threw. * @fix Read `cause` and `plugin`, then fix that plugin's `start` hook. * @verify bun run test */ readonly StartFailed: 'ARKI_DOT_E004'; /** * One or more `stop` hooks threw — aggregate. * @fix Read `failures`: each entry names the plugin whose `stop` hook threw. * @verify bun run test */ readonly StopFailed: 'ARKI_DOT_E005'; /** * One or more `dispose` hooks threw — aggregate. * @fix Read `failures`: each entry names the plugin whose `dispose` hook threw. * @verify dot doctor --json | jq -e .ok */ readonly DisposeFailed: 'ARKI_DOT_E006'; /** * Caller tried to reuse the app after dispose. * @fix Build a fresh app instance; a disposed app cannot run again. * @verify bun run test */ readonly ReuseAfterDispose: 'ARKI_DOT_E007'; /** * Caller tried to reuse the app after a failed lifecycle. * @fix Build a fresh app instance; a failed app cannot run again. * @verify bun run test */ readonly ReuseAfterFailure: 'ARKI_DOT_E008'; /** * Plugin registered twice. * @fix Remove the second `.use()` of this plugin, or `rename` it to run two copies. * @verify dot explain --json | jq -e .ok */ readonly DuplicatePlugin: 'ARKI_DOT_E011'; /** * A plugin's `needs` entry has no provider among earlier-booted plugins. * @fix Mount a plugin that provides the needed key before its consumer. * @verify dot doctor --json | jq -e .ok */ readonly UnsatisfiedNeed: 'ARKI_DOT_E012'; /** * A plugin published a wire key that an earlier plugin already provides. * @fix Give one of the two providers a different key with `rename`. * @verify dot doctor --json | jq -e .ok */ readonly ServiceCollision: 'ARKI_DOT_E013'; /** * A needs alias, publish key, or rename target uses the reserved `$` prefix. * @fix Rename the key; names starting with `$` belong to the kernel. * @verify dot explain --json | jq -e .ok */ readonly ReservedServiceKey: 'ARKI_DOT_E014'; /** * A lifecycle hook exceeded the app's `hookTimeoutMs` watchdog. * @fix Pass the hook's `$signal` to its I/O, or raise `hookTimeoutMs` with a reason. * @verify dot doctor --json | jq -e .ok */ readonly HookTimeout: 'ARKI_DOT_E015'; /** * Two actions in the same binding use the same id. * @fix Give each action in a binding its own id. * @verify dot explain --json | jq -e .ok */ readonly DuplicateAction: 'ARKI_DOT_E016'; /** * Action metadata is not JSON-round-trip safe. * @fix Keep action `meta` plain JSON: no functions, Dates, Maps or cycles. * @verify dot explain --json | jq -e .ok */ readonly ActionMetaNotJson: 'ARKI_DOT_E017'; /** * More than one plugin fills the logging slot. * @fix Keep one `log()` plugin in the app. * @verify dot explain --json | jq -e .ok */ readonly DuplicateLogging: 'ARKI_DOT_E018'; /** * Static capability needs form a ring: a feature's need comes back around to itself. * @fix Move the shared piece into a third unit that both sides need. * @verify dot explain --json | jq -e .ok */ readonly CapabilityRing: 'ARKI_DOT_E019'; /** * A feature needs a capability whose (static) provider is mounted after it. * @fix Mount the provider before the unit that needs it; the message names both positions. * @verify dot explain --json | jq -e .ok */ readonly ProviderMountedLater: 'ARKI_DOT_E020'; /** * `$describeAction` named an action the calling plugin may not amend (unknown id, or not its own). * @fix Describe only actions the calling plugin declared or owns. * @verify dot explain --json | jq -e .ok */ readonly ActionNotAmendable: 'ARKI_DOT_E021'; };", "jsdocSummary": "Stable error codes for every failure the kernel throws, `ARKI_DOT_E001`.. Codes are never renumbered and never reused (E009 and E010 are retired). E001-E021 are lifecycle failures; E022-E031 are feature-composition failures (see `FEATURE_ERROR_CODES`); E032 is non-JSON manifest data." }, { "subpath": ".", "name": "DotLifecycleErrorCodeValue", "kind": "type", "signature": "export type DotLifecycleErrorCodeValue = (typeof DotLifecycleErrorCode)[keyof typeof DotLifecycleErrorCode];", "jsdocSummary": "" }, { "subpath": ".", "name": "DotLifecycleEvent", "kind": "type", "signature": "export type DotLifecycleEvent = DotPhaseLifecycleEvent | DotPluginHookLifecycleEvent;", "jsdocSummary": "The single fan-out event type emitted by the kernel to every registered observer. Discriminated by `kind`:" }, { "subpath": ".", "name": "DotLifecycleEventStatus", "kind": "type", "signature": "export type DotLifecycleEventStatus = 'starting' | 'completed' | 'failed';", "jsdocSummary": "Possible event statuses. See {@link DotLifecycleEvent}." }, { "subpath": ".", "name": "DotLifecycleHook", "kind": "type", "signature": "export type DotLifecycleHook = 'configure' | 'boot' | 'start' | 'stop' | 'dispose';", "jsdocSummary": "Identifier of a single hook in the DOT lifecycle." }, { "subpath": ".", "name": "DotLifecycleObserver", "kind": "type", "signature": "export type DotLifecycleObserver = (event: DotLifecycleEvent) => void;", "jsdocSummary": "Observer function signature. Synchronous by contract — observers MUST NOT block the lifecycle. If a long-running side effect is needed (e.g. shipping events to a remote sink), the observer should buffer the event and process it on a separate cadence." }, { "subpath": ".", "name": "DotLifecyclePluginFailure", "kind": "type", "signature": "export type DotLifecyclePluginFailure = { plugin: string; phase: DotLifecycleHook; error: unknown; };", "jsdocSummary": "Single plugin failure inside an aggregate lifecycle error (stop/dispose)." }, { "subpath": ".", "name": "DotLifecycleState", "kind": "type", "signature": "export type DotLifecycleState = 'defined' | 'configured' | 'booted' | 'started' | 'stopped' | 'disposed' | 'failed';", "jsdocSummary": "Macro-states the DotApp can occupy." }, { "subpath": ".", "name": "DotLoggingContext", "kind": "type", "signature": "export type DotLoggingContext = { /** App name (passed to `defineApp`). */ readonly appName: string; };", "jsdocSummary": "What the kernel passes to a plugin's `logging` factory." }, { "subpath": ".", "name": "DotLoggingHandle", "kind": "type", "signature": "export type DotLoggingHandle = { close(): MaybePromise; };", "jsdocSummary": "What a `logging` factory returns. The kernel closes it after the app's last lifecycle record." }, { "subpath": ".", "name": "DotManifestError", "kind": "class", "signature": "export declare class DotManifestError extends TypeError { readonly code = \"ARKI_DOT_E032\"; readonly remediation = \"Pass plain JSON only: no functions, Dates, Maps, class instances, undefined fields, NaN or cycles.\"; readonly docsUrl: string; constructor(message: string, options?: { readonly cause?: unknown; }); }", "jsdocSummary": "Manifest metadata that is not plain JSON. A `TypeError`, so existing `instanceof TypeError` checks still match." }, { "subpath": ".", "name": "DotPhaseLifecycleEvent", "kind": "type", "signature": "export type DotPhaseLifecycleEvent = { readonly kind: 'phase'; /** The phase the event belongs to. */ readonly phase: DotLifecycleHook; readonly status: DotLifecycleEventStatus; /** App name (so multiplexed observers can disambiguate). */ readonly appName: string; /** Wall-clock duration in milliseconds. Present on `completed` / `failed`. */ readonly durationMs?: number; /** The error value, if `status === 'failed'`. */ readonly error?: unknown; /** Wall-clock timestamp in ms-since-epoch (`Date.now()` semantics). */ readonly timestamp: number; };", "jsdocSummary": "Boundary of a top-level lifecycle phase." }, { "subpath": ".", "name": "DotPluginError", "kind": "class", "signature": "export declare class DotPluginError extends Error { /** Stable error code, e.g. `ARKI_KV_PLUGIN_E001`. */ readonly code: string; /** One-sentence guidance on how to fix the underlying problem. */ readonly remediation: string; /** URL of the documentation page that explains this error. */ readonly docsUrl: string; constructor(args: { readonly code: string; readonly message: string; readonly remediation: string; readonly docsUrl: string; }); }", "jsdocSummary": "Stable error thrown by DOT plugin adapters." }, { "subpath": ".", "name": "DotPluginHookLifecycleEvent", "kind": "type", "signature": "export type DotPluginHookLifecycleEvent = { readonly kind: 'plugin-hook'; /** The phase the hook belongs to. */ readonly phase: DotLifecycleHook; /** The plugin whose hook is being executed. */ readonly plugin: string; /** Topological order of the plugin within the phase (0-based). */ readonly order: number; readonly status: DotLifecycleEventStatus; readonly appName: string; readonly durationMs?: number; readonly error?: unknown; readonly timestamp: number; };", "jsdocSummary": "Boundary of a single plugin's hook execution." }, { "subpath": ".", "name": "DotPluginRole", "kind": "type", "signature": "export type DotPluginRole = 'feature' | 'driving';", "jsdocSummary": "See {@link Plugin.role}." }, { "subpath": ".", "name": "DotServeBuilder", "kind": "type", "signature": "export type DotServeBuilder = Pick, keyof DotAppLifecycle | 'serve' | 'entrypoints'>;", "jsdocSummary": "Builder after `.features()` or `.serve()` — only driving adapters remain. Driven adapters (`.use`) cannot follow the domain: infrastructure never depends on a feature." }, { "subpath": ".", "name": "DotTelemetry", "kind": "type", "signature": "export type DotTelemetry = ReturnType;", "jsdocSummary": "The inferred custom instrumentation surface, shared by all plugin and feature contexts." }, { "subpath": ".", "name": "EmptyOwnership", "kind": "type", "signature": "export type EmptyOwnership = { readonly open: never; readonly close: never; };", "jsdocSummary": "A unit with no declared construction or cleanup refusals." }, { "subpath": ".", "name": "EmptyPhases", "kind": "type", "signature": "export type EmptyPhases = { readonly [Phase in keyof PluginPhases]: never; };", "jsdocSummary": "No declared hook failures." }, { "subpath": ".", "name": "EmptyShape", "kind": "type", "signature": "export type EmptyShape = {};", "jsdocSummary": "" }, { "subpath": ".", "name": "FactoryContract", "kind": "type", "signature": "export type FactoryContract = { readonly [FactoryContractSym]?: Values; };", "jsdocSummary": "The successful outputs that minted a unit's handles; failures stay inferred from the live callbacks." }, { "subpath": ".", "name": "FactoryContractOf", "kind": "type", "signature": "export type FactoryContractOf

= FactoryContract

? Values : never>;", "jsdocSummary": "Preserve the original factory contract while projecting a unit's wiring." }, { "subpath": ".", "name": "fake", "kind": "function", "signature": "export declare function fake>(handle: Handle, value: Value): Omit>>, EmptyShape, string, InferredOwnership>, void>>, \"hooks\"> & { readonly hooks: EmptyShape; };", "jsdocSummary": "A plugin that provides one fake under a real handle's wire key — for app-level tests that mount the real features against fakes:" }, { "subpath": ".", "name": "FeatureUnits", "kind": "type", "signature": "export type FeatureUnits = number extends TFeatures['length'] ? readonly AnyPlugin[] : FlattenUnits;", "jsdocSummary": "Every kernel unit a feature list mounts, flattened in order — what `.features()` checks with the `UseAllGuard`. A non-tuple list stays an array, so the guard asks for a tuple." }, { "subpath": ".", "name": "Handle", "kind": "type", "signature": "export type Handle = Token & { readonly provider: O; /** The lazy-lifting form of the same handle (the `service.lazy` of handles). */ readonly lazy: LazyHandle; };", "jsdocSummary": "A capability handle: a token on the wire key `K`, stamped with the name of the unit that provides it. `plugin()` and `feature()` mint one per `provides` key, so a consumer names the capability in its `needs` (`needs: { db: database.provides.db }`) and never restates the type — the Drizzle `references(() => table.column)` of services. Identity is the wire key, not the object: the kernel resolves by `key`." }, { "subpath": ".", "name": "Handles", "kind": "type", "signature": "export type Handles = { readonly [K in keyof TProvides & string]: Handle; };", "jsdocSummary": "One handle per published key — what `plugin.provides` holds." }, { "subpath": ".", "name": "hookSignals", "kind": "function", "signature": "export declare function hookSignals(app: Disposable, options?: HookSignalsOptions): () => void;", "jsdocSummary": "Wire termination signals to `app.dispose()`. Returns an unhook function that removes the handlers without disposing — call it if the app is torn down through another path first." }, { "subpath": ".", "name": "HookSignalsOptions", "kind": "type", "signature": "export type HookSignalsOptions = { /** Signals to intercept. Default: `['SIGTERM', 'SIGINT']`. */ readonly signals?: readonly string[]; /** * Maximum time the drain (`dispose()`) may take before the process is * terminated anyway. Default: 10 000 ms. */ readonly timeoutMs?: number; /** Test seam — a process-like target. Default: the global `process`, when the runtime has one. */ readonly proc?: SignalTarget; };", "jsdocSummary": "" }, { "subpath": ".", "name": "InferredOwnership", "kind": "type", "signature": "export type InferredOwnership = { readonly open: ProviderOpen | Extract | EntriesFailure, 'open'> | EntriesFailure, 'run'>; readonly close: ProviderClose | EntriesFailure, 'close'> | EntriesFailure, 'run'>; };", "jsdocSummary": "" }, { "subpath": ".", "name": "InferredPhases", "kind": "type", "signature": "export type InferredPhases = { readonly [Phase in keyof PluginPhases]: Extract; };", "jsdocSummary": "Derive phase failures from callback results." }, { "subpath": ".", "name": "initPlugins", "kind": "variable", "signature": "export declare const initPlugins: { context(): { create(): InitPluginsFactory; }; };", "jsdocSummary": "" }, { "subpath": ".", "name": "InitPluginsFactory", "kind": "type", "signature": "export type InitPluginsFactory = ReturnType>;", "jsdocSummary": "" }, { "subpath": ".", "name": "isLazy", "kind": "function", "signature": "export declare function isLazy(value: unknown): value is PublishedLazy;", "jsdocSummary": "Detect a published lazy handle without claiming its cleanup is infallible." }, { "subpath": ".", "name": "JsonObject", "kind": "type", "signature": "export type JsonObject = Record;", "jsdocSummary": "JSON-serializable object used for adapter-owned manifest metadata." }, { "subpath": ".", "name": "JsonValue", "kind": "type", "signature": "export type JsonValue = string | number | boolean | null | JsonValue[] | { [key: string]: JsonValue; };", "jsdocSummary": "JSON-serializable value — the manifest's currency." }, { "subpath": ".", "name": "KernelCtx", "kind": "type", "signature": "export type KernelCtx = { /** App name (passed to `defineApp`). */ readonly $app: string; /** This plugin's name. */ readonly $plugin: string; /** Custom spans, events, metrics and correlated logs scoped to this mounted plugin or feature. */ readonly $telemetry: DotTelemetry; /** Read-only runtime config bag from `defineApp(name, { config })`. */ readonly $config: Readonly>; /** * Aborts when this hook exceeds `defineApp(name, { hookTimeoutMs })`; the * reason is the `ARKI_DOT_E015` error. Pass it to the hook's I/O * (`fetch`, a driver's connect, `sleep`) so a hung hook stops instead of * running on after the kernel gave up on it. One signal per hook call. */ readonly $signal: AbortSignal; /** * Complete an action's `summary` once the plugin's services exist (a * `provides` factory, `boot`, `start`, ...). `dot explain` stays static; * the post-boot `app.manifest` and `dot doctor` show the new text. * * A plugin may amend an action it declared, or an action in a binding it * registered a projection for (an adapter completing the actions of the * features it serves). Anything else throws `ARKI_DOT_E021`. */ readonly $describeAction: (actionId: string, patch: { readonly summary: string; }) => void; };", "jsdocSummary": "Kernel-supplied context keys, present in every service-carrying hook context. The `$` prefix is a reserved namespace: `plugin()` rejects `$`-prefixed needs aliases and publish keys at compile time (via {@link NoReservedKeys}) and the kernel enforces it at runtime (`ARKI_DOT_E014`), so these keys can never be shadowed." }, { "subpath": ".", "name": "lazy", "kind": "function", "signature": "export declare function lazy(init: Initializer & TypedOutput, options?: LazyOptions): { [LazyTag]: true; get: () => Promise | Failure<\"failure.unexpected_defect\", undefined>>; readonly initialized: boolean; peek(): Exclude, Failure> | undefined; dispose(): Promise | Extract>, Failure> | Extract>, Failure> | undefined>; };", "jsdocSummary": "Own a service initialized on first use. Concurrent gets share an attempt; returned failures and defects are retried only by a later get. Cleanup receives successful services only. Disposal closes admission immediately, waits for a pending attempt, and caches its complete typed outcome." }, { "subpath": ".", "name": "Lazy", "kind": "type", "signature": "export type Lazy = ReturnType>;", "jsdocSummary": "A service handle derived from its callback outputs. `Lazy` includes the canonical closed/defect outcomes; providers with other declared failures keep their inferred handle type, or supply their original callback output types." }, { "subpath": ".", "name": "LazyClosed", "kind": "variable", "signature": "export declare const LazyClosed: import(\"@arki/failure\").FailureDefinition<\"dot.lazy_closed\", undefined>;", "jsdocSummary": "An operation tried to initialize a service after its owner closed admission." }, { "subpath": ".", "name": "LazyHandle", "kind": "type", "signature": "export type LazyHandle = Token & LazyService & { readonly provider: O; };", "jsdocSummary": "A handle that always delivers a `Lazy`, whether the provider is eager or lazy — `needs: { db: database.provides.db.lazy }`." }, { "subpath": ".", "name": "lazyOf", "kind": "function", "signature": "export declare function lazyOf(value: Awaited): { [LazyTag]: true; get(): Promise | Awaited>>; readonly initialized: boolean; peek(): Exclude, Failure> | undefined; dispose(): Promise; };", "jsdocSummary": "Borrow an already available service without initializing or owning it. A failure is returned by get and is never marked initialized." }, { "subpath": ".", "name": "LazyService", "kind": "type", "signature": "export type LazyService = Service> & { readonly lazy: true; readonly [LazyInner]?: T; };", "jsdocSummary": "A lazy-lifting witness (create via {@link service.lazy}). The consumer always receives a `Lazy` handle, regardless of whether the provider published a plain `T` (the kernel lifts it into a pre-initialized handle) or a `Lazy` (passed through). This decouples consumers from the provider's eager-vs-lazy strategy." }, { "subpath": ".", "name": "LifecycleDiagnostic", "kind": "type", "signature": "export type LifecycleDiagnostic = { plugin: string; hook: DotLifecycleHook; state: DotLifecycleState; /** 0-based topological order of this plugin within the hook pass. */ order: number; /** Wall-clock duration of the hook call, in milliseconds. */ durationMs?: number; issues: DiagnosticIssue[]; };", "jsdocSummary": "" }, { "subpath": ".", "name": "LifecycleManifest", "kind": "type", "signature": "export type LifecycleManifest = { plugin: string; hooks: readonly DotLifecycleHook[]; };", "jsdocSummary": "Which lifecycle hooks a plugin participates in." }, { "subpath": ".", "name": "LoggingSlot", "kind": "type", "signature": "export type LoggingSlot = { readonly logging?: (ctx: DotLoggingContext) => Result; };", "jsdocSummary": "The actual logging callback remains the source of activation and cleanup failures." }, { "subpath": ".", "name": "MergePhases", "kind": "type", "signature": "export type MergePhases = { readonly [Phase in keyof PluginPhases]: Left[Phase] | Right[Phase]; };", "jsdocSummary": "Combine failure channels when appending a unit to an app." }, { "subpath": ".", "name": "NeedsShape", "kind": "type", "signature": "export type NeedsShape = Record>;", "jsdocSummary": "A `needs` declaration: local alias → witness (anonymous or token)." }, { "subpath": ".", "name": "NoReservedKeys", "kind": "type", "signature": "export type NoReservedKeys = Readonly>;", "jsdocSummary": "No `$`-prefixed keys — that prefix is the kernel context namespace ({@link KernelCtx}). Used as a constraint on needs shapes and provides records: a matching key makes the property type `never`, which no witness or service value satisfies, so the violation errors at the exact offending property. The kernel re-validates at runtime with `ARKI_DOT_E014` for paths the constraint cannot see (renames, erased plugins)." }, { "subpath": ".", "name": "NormalizeProvides", "kind": "type", "signature": "export type NormalizeProvides = [TP] extends [never] ? EmptyShape : TP;", "jsdocSummary": "A plugin whose `boot` always throws infers `TProvides = never`, which would poison both the collision check (`keyof never` matches everything) and the accumulated record (`TAvail & never` = `never`). Such a plugin provides nothing — normalize to the empty shape." }, { "subpath": ".", "name": "PhaseHooks", "kind": "type", "signature": "export type PhaseHooks = { readonly configure?: (ctx: DotConfigureContext) => Returns['configure']; readonly start?: (ctx: Context) => MaybePromise; readonly stop?: (ctx: Context) => MaybePromise; readonly dispose?: (ctx: Context) => MaybePromise; };", "jsdocSummary": "Lifecycle callbacks sharing a context, with concrete results per phase." }, { "subpath": ".", "name": "plugin", "kind": "function", "signature": "export declare function plugin(def: PluginDefinition>, ..._guard: BootGuard>): AuthoredPlugin, ProvidedValues, TShape, TName, TProvides, EmptyPhases, DotLoggingHandle, TBoot>; ; export declare function plugin>(def: PluginDefinition, ..._guard: BootGuard>): AuthoredPlugin, ProvidedValues, TShape, TName, TProvides, InferredPhases<{ configure: TConfigure; start: TStart; stop: TStop; dispose: TDispose; }>, TLogging, TBoot>;", "jsdocSummary": "" }, { "subpath": ".", "name": "Plugin", "kind": "type", "signature": "export type Plugin = { readonly runtime: PluginRuntime; readonly [OwnershipSym]?: TOwnership; /** Unique identifier for this plugin within the app. */ readonly name: string; /** Runtime needs shape (local alias → witness). */ readonly needs: NeedsShape; readonly actions: readonly ActionSource[]; /** Mount-time renames: publish key → new wire key (see {@link rename}). */ readonly renames: Readonly>; /** * Where the app builder mounted this plugin in the hexagon: `feature` * (`.features()`) or `driving` (`.serve()`). Absent for `.use()` — a * driven adapter, or any plugin in an app that never calls `.features()`. */ readonly role?: DotPluginRole; /** * One typed handle per published wire key, known before boot. The kernel * checks ordering and rings at configure time from these keys, and * `dot explain` draws the edges without booting. `rename()` rebuilds * them on the new keys. */ readonly provides: Handles; /** The `provides` factories, keyed by publish key (before renames). The kernel runs them in key order at boot. */ readonly factories: AnyFactories; /** * The logging slot. At most one plugin per app fills it. The kernel activates * it during boot, before provider construction, and closes it after owned * plugin cleanup. Configure never activates logging. */ readonly logging?: (ctx: DotLoggingContext) => DotLoggingHandle | TOwnership['open']; readonly hooks: PhaseHooks & { readonly boot?: (ctx: never) => unknown; }; readonly [NeedsSym]?: TNeeds; readonly [ProvidesSym]?: TProvides; readonly [ProviderIdentitySym]?: TShape; };", "jsdocSummary": "" }, { "subpath": ".", "name": "PluginCloseFailure", "kind": "type", "signature": "export type PluginCloseFailure

= PluginPreparation

['close'] | SourceOwnership

['close'] | CallbackFailure, 'close'>;", "jsdocSummary": "" }, { "subpath": ".", "name": "PluginDiagnostic", "kind": "type", "signature": "export type PluginDiagnostic = { plugin: string; status: Extract; issues: DiagnosticIssue[]; };", "jsdocSummary": "" }, { "subpath": ".", "name": "PluginFactoryGuard", "kind": "type", "signature": "export type PluginFactoryGuard

= [FactoryContractError

] extends [never] ? [] : [error: FactoryContractError

];", "jsdocSummary": "Validate replaceable factories against the handles their original definitions minted." }, { "subpath": ".", "name": "PluginManifest", "kind": "type", "signature": "export type PluginManifest = { name: string; /** Hexagon role from the app builder — see `Plugin.role`. */ role?: DotPluginRole; dependencies: readonly string[]; provides: readonly string[]; };", "jsdocSummary": "Single plugin's declarative metadata." }, { "subpath": ".", "name": "PluginNeeds", "kind": "type", "signature": "export type PluginNeeds

= P extends AnyPlugin ? NonNullable : never;", "jsdocSummary": "Extract a plugin's (wire-keyed) needs record." }, { "subpath": ".", "name": "PluginOpenFailure", "kind": "type", "signature": "export type PluginOpenFailure

= PluginPreparation

['open'] | SourceOwnership

['open'] | Extract, Failure>;", "jsdocSummary": "" }, { "subpath": ".", "name": "PluginOwnership", "kind": "type", "signature": "export type PluginOwnership = { readonly open: Failure; readonly close: Failure; };", "jsdocSummary": "Exact failures owned by a plugin's construction and release callbacks." }, { "subpath": ".", "name": "PluginPhaseFailures", "kind": "type", "signature": "export type PluginPhaseFailures

= P extends { readonly hooks: infer Hooks; } ? { readonly [Phase in keyof PluginPhases]: PhaseFailure; } : EmptyPhases;", "jsdocSummary": "Infer each phase from the actual hooks, including spread replacements." }, { "subpath": ".", "name": "PluginPhases", "kind": "type", "signature": "export type PluginPhases = { readonly configure: Failure; readonly start: Failure; readonly stop: Failure; readonly dispose: Failure; };", "jsdocSummary": "Constraint for the four lifecycle failure channels; infer concrete channels from a plugin." }, { "subpath": ".", "name": "PluginPreparation", "kind": "type", "signature": "export type PluginPreparation

= P extends { readonly [OwnershipSym]?: infer Owned extends PluginOwnership; } ? Owned : EmptyOwnership;", "jsdocSummary": "Failures owned by the runtime's feature preparation, independent of replaceable callbacks." }, { "subpath": ".", "name": "PluginProvides", "kind": "type", "signature": "export type PluginProvides

= P extends AnyPlugin ? NonNullable : never;", "jsdocSummary": "Extract a plugin's (wire-keyed) provides record." }, { "subpath": ".", "name": "PluginSourceGuard", "kind": "type", "signature": "export type PluginSourceGuard

= [FactoryContractError

| SourceBootError

] extends [never] ? [] : [error: FactoryContractError

| SourceBootError

];", "jsdocSummary": "Validate the live factories and boot callback before mounting a unit." }, { "subpath": ".", "name": "ProjectionManifest", "kind": "type", "signature": "export type ProjectionManifest = { /** Document format key matched by `dot explain --as `. */ format: string; /** Binding this projection primarily renders. Informational. */ binding: string; /** Import specifier for the projection module. */ module: string; /** Plugin that registered this projection. */ plugin: string; };", "jsdocSummary": "Registered projection renderer for an adapter-owned document format." }, { "subpath": ".", "name": "provide", "kind": "function", "signature": "export declare function provide(tok: Token, value: T): Record;", "jsdocSummary": "A record holding one value under a token's wire key, typed by the token's literal key: `provide(Db, handle)` is `{ 'arki.db': DbHandle }`." }, { "subpath": ".", "name": "Provided", "kind": "type", "signature": "export type Provided = H extends Service ? T : never;", "jsdocSummary": "The value type behind a handle — for the one alias an app names (`type Db = Provided`)." }, { "subpath": ".", "name": "ProvidedValue", "kind": "type", "signature": "export type ProvidedValue = Value extends ResourceEntry | Failure ? Value extends ResourceEntry ? Value extends { readonly open: infer Open extends (...args: never[]) => unknown; } ? SuccessOf : never : never : Value;", "jsdocSummary": "" }, { "subpath": ".", "name": "ProvidedValues", "kind": "type", "signature": "export type ProvidedValues = { [Name in keyof Values]: ProvidedValue>; };", "jsdocSummary": "" }, { "subpath": ".", "name": "ProvidesFactories", "kind": "type", "signature": "export type ProvidesFactories = { readonly [K in keyof TProvides]: (services: CtxOf & KernelCtx) => TProvides[K] & NoInfer>; };", "jsdocSummary": "Infer raw factory returns once, including Promise wrappers. Explicit TProvides annotations describe those raw returns, not the resolved services. Services and ownership resolve promises through their shared projections." }, { "subpath": ".", "name": "rename", "kind": "function", "signature": "export declare function rename

]?: string; }, const TNewName extends string = PluginOwner

>(p: P & { readonly runtime: PluginRuntime; readonly [OwnershipSym]?: TOwnership; }, map: M, newName?: TNewName): Omit, RenamedProvides, M>, PluginProviderIdentities

, TNewName, TOwnership, PluginPhaseFailures

>, 'hooks' | 'logging' | 'factories'> & Pick & FactoryContractOf

;", "jsdocSummary": "Mount-time rename. `rename(dbPlugin, { db: 'reportsDb' }, 'reports-db')` publishes the same service under a different wire key, retyped accordingly — the way to mount a second instance of an adapter without a key collision. Renames compose: renaming an already-renamed key rewrites the earlier entry." }, { "subpath": ".", "name": "RenamedProvides", "kind": "type", "signature": "export type RenamedProvides = { [K in keyof TP as K extends keyof M ? (M[K] extends string ? M[K] : K) : K]: TP[K]; };", "jsdocSummary": "Rename a plugin's published wire keys — the multi-instance primitive." }, { "subpath": ".", "name": "renderTimeline", "kind": "function", "signature": "export declare function renderTimeline(snapshot: DotDiagnosticsSnapshot, opts?: RenderTimelineOptions): string;", "jsdocSummary": "Render the snapshot's lifecycle records as a per-phase waterfall. Pure — no IO. Caller is responsible for printing the result." }, { "subpath": ".", "name": "RenderTimelineOptions", "kind": "type", "signature": "export type RenderTimelineOptions = { /** Maximum bar width in characters (default `50`). */ readonly barWidth?: number; /** * When `true`, also emit any plugin's diagnostic `issues[]` underneath * the bar so failure reasons are visible in the timeline view. * Default `true`. */ readonly showIssues?: boolean; };", "jsdocSummary": "" }, { "subpath": ".", "name": "service", "kind": "variable", "signature": "export declare const service: (() => Service) & { readonly lazy: () => LazyService; };", "jsdocSummary": "Create an app-local (anonymous) service witness for a `needs` shape." }, { "subpath": ".", "name": "Service", "kind": "type", "signature": "export type Service = { readonly [TypeOf]?: T; };", "jsdocSummary": "Phantom type witness for a service. Carries `T` at the type level only — the runtime value is an empty object." }, { "subpath": ".", "name": "ServiceDiagnostic", "kind": "type", "signature": "export type ServiceDiagnostic = { service: string; plugin: string; status: Extract; issues: DiagnosticIssue[]; };", "jsdocSummary": "" }, { "subpath": ".", "name": "ServiceKind", "kind": "type", "signature": "export type ServiceKind = 'env' | 'db' | 'kv' | 'queue' | 'auth' | 'email' | 'logger' | 'event-store' | 'message-bus' | 'custom';", "jsdocSummary": "Kind of service that a plugin can publish." }, { "subpath": ".", "name": "ServiceManifest", "kind": "type", "signature": "export type ServiceManifest = { name: string; plugin: string; kind: ServiceKind; };", "jsdocSummary": "Single service published by a plugin." }, { "subpath": ".", "name": "ServiceRecord", "kind": "type", "signature": "export type ServiceRecord = Record;", "jsdocSummary": "Record of wire-keyed services." }, { "subpath": ".", "name": "SignalTarget", "kind": "type", "signature": "export type SignalTarget = { readonly pid: number; once(event: string, listener: () => void): unknown; off(event: string, listener: () => void): unknown; kill(pid: number, signal?: string): unknown; };", "jsdocSummary": "The slice of `process` the signal hook touches. Injectable so tests can drive signals through a fake without terminating the test runner — defaults to the real `process`." }, { "subpath": ".", "name": "telemetryFor", "kind": "function", "signature": "export declare function telemetryFor(owner: { readonly name: string; } | { readonly $plugin: string; }): { /** Observe a custom operation, retaining its exact return value, promise and failure identity. */ span(name: string, run: () => Value, options?: SpanOptions): Value; /** Annotate the active operation without adding a span. Explicit attributes only. */ event(name: string, attributes?: Attributes): void; /** Create a counter. Keep explicit dimensions bounded; do not include user IDs or payloads. */ counter(name: string, options?: MetricOptions): { add(value: number, attributes?: Attributes): void; }; /** Create a histogram with the same identity and context as this scope. */ histogram(name: string, options?: MetricOptions): { record(value: number, attributes?: Attributes): void; }; /** Write through the app's logging setup with the active trace stamped on the record. */ log(level: LevelInput, template: string, fields?: Fields): void; };", "jsdocSummary": "Scope custom instrumentation from an existing plugin, feature or hook context. App-owned OTel providers supply tracing; without an SDK every call is safe. Use a new span only for a new operational boundary, not one already instrumented." }, { "subpath": ".", "name": "testApp", "kind": "function", "signature": "export declare function testApp(plugins?: TPlugins & TestAppGuard, options?: TestAppOptions): import(\"./define-app.js\").DotAppBuilder, PluginOpenFailure, PluginCloseFailure, PluginPhaseFailures>;", "jsdocSummary": "Build a DOT app builder pre-populated with the given plugins, ready to `.configure()`, `.boot()` or `.start()` from a test. The services are read off the plugins — `testApp([database]).boot()` gives `app.services.db` — and a tuple that would not mount (a need before its provider, a wire key provided twice) is a compile error on the argument." }, { "subpath": ".", "name": "TestAppOptions", "kind": "type", "signature": "export type TestAppOptions = { /** App name used in the manifest. Defaults to `'test-app'`. */ name?: string; /** Runtime config bag exposed to hooks as `$config`. */ config?: Readonly>; };", "jsdocSummary": "" }, { "subpath": ".", "name": "testPlugin", "kind": "function", "signature": "export declare function testPlugin(plugin: P & ListGuard>, options?: TestAppOptions): TestPluginBuilder, PluginProvides

, PluginOpenFailure

, PluginCloseFailure

, EmptyShape, PluginPhaseFailures

>;", "jsdocSummary": "Unit-test a single plugin with **typed overrides** — the compile-checked counterpart to {@link testApp}'s erased arrays." }, { "subpath": ".", "name": "TestPluginBuilder", "kind": "type", "signature": "export type TestPluginBuilder = { /** * Satisfy one need directly with a fake. Token form — the token names * the wire key and carries the type: * * ```ts * testPlugin(reports).provide(Db, fakeDb) * ``` */ provide(token: Token, value: T): TestPluginBuilder, TServices & Readonly>, TOpen, TClose, TFakes & Readonly>, TPhases>; /** * Satisfy one need directly with a fake. Key form — for anonymous * `service()` needs, where the wire key is the property name: * * ```ts * testPlugin(billing).provide('db', fakeDb) * ``` */ provide(key: K, value: T): TestPluginBuilder, TServices & Readonly>, TOpen, TClose, TFakes & Readonly>, TPhases>; /** Boot the plugin against the provided fakes. Compile error until every need is provided. */ boot(this: BootReady>): ReturnType['boot']>; /** Boot + start. Same guard as {@link TestPluginBuilder.boot}. */ start(this: BootReady>): ReturnType['start']>; };", "jsdocSummary": "" }, { "subpath": ".", "name": "toJsonObject", "kind": "function", "signature": "export declare function toJsonObject(value: unknown): JsonObject;", "jsdocSummary": "Validate and narrow unknown adapter data into manifest JSON metadata." }, { "subpath": ".", "name": "token", "kind": "function", "signature": "export declare function token(): (key: K) => Token;", "jsdocSummary": "Create a token. Curried so `T` is explicit while `K` is inferred as a literal: `const Db = token()('arki.db')`." }, { "subpath": ".", "name": "Token", "kind": "type", "signature": "export type Token = Service & { readonly key: K; /** Derive a token for an additional instance of the same contract. */ instance(name: N): Token; };", "jsdocSummary": "Shared, named witness — a cross-package service contract. The `key` is the wire name used for satisfaction checks and runtime lookup; the local property name in a `needs` shape becomes a free-choice alias." }, { "subpath": ".", "name": "UseAllAvail", "kind": "type", "signature": "export type UseAllAvail = UseAllState['avail'];", "jsdocSummary": "" }, { "subpath": ".", "name": "UseAllGuard", "kind": "type", "signature": "export type UseAllGuard = [ UseAllState['error'] ] extends [never] ? UseAllTupleGuard : [error: UseAllState['error']];", "jsdocSummary": "" }, { "subpath": ".", "name": "UseGuard", "kind": "type", "signature": "export type UseGuard = PluginSourceGuard extends [] ? string extends keyof TAvail ? [] : [TAvail] extends [TNeeds] ? [keyof TAvail & keyof TProvides] extends [never] ? [] : [error: CollisionError] : [error: NeedsError] : PluginSourceGuard;", "jsdocSummary": "One unit's wiring check. Satisfied → `[]`; violated → `[error]` with the diagnostic as the error type. `ListGuard` turns it into a type on the argument itself, so the call site fails on the plugin with the `DOT:` label in the message (not with \"Expected 2 arguments, but got 1\"). The open record (`DotAppBuilder`, the erased builder a runtime-built plugin list gives) has nothing to check: the kernel checks it at boot." }, { "subpath": ".", "name": "WireNeeds", "kind": "type", "signature": "export type WireNeeds = { [K in keyof S as S[K] extends { readonly key: infer WK extends string; } ? WK : K]: S[K] extends Service ? T : never; };", "jsdocSummary": "Wire-key view of a needs shape — what the app builder checks satisfaction against. Tokens contribute their owned key; anonymous witnesses contribute the property name. `{ cache: Token }` → `{ 'arki.kv': KV }`." }, { "subpath": "./action", "name": "action", "kind": "function", "signature": "export declare function action(options: ActionOptions): Readonly<{ id: string; summary?: string; input: Input; output: Output; policy: Readonly<{ principal: 'optional' | 'required'; approval: 'none' | 'required'; retry: 'never' | 'idempotent'; exposure: readonly string[]; }>; failures: readonly [...Readonly, FailureDefinition<\"schema.invalid_input\", StandardSchemaV1>, FailureDefinition<\"schema.validator_defect\", undefined>, FailureDefinition<\"async.cancelled\", undefined>, FailureDefinition<\"async.deadline\", undefined>, FailureDefinition<\"failure.unexpected_defect\", undefined>, FailureDefinition<\"async.scope_failed\", StandardSchemaV1>, FailureDefinition<\"dot.action_not_exposed\", undefined>, FailureDefinition<\"dot.action_principal_required\", undefined>, FailureDefinition<\"dot.action_approval_required\", undefined>]; toDotAction(): ActionDeclaration; }>;", "jsdocSummary": "Define a reusable action without importing server services or an implementation. It implements Dot's existing ActionSource protocol; no second registry is needed." }, { "subpath": "./action", "name": "Action", "kind": "type", "signature": "export type Action = ReturnType>;", "jsdocSummary": "The descriptor's members are inferred from action(), not restated." }, { "subpath": "./action", "name": "ACTION_FAILURES", "kind": "variable", "signature": "export declare const ACTION_FAILURES: readonly [FailureDefinition<\"schema.invalid_input\", StandardSchemaV1>, FailureDefinition<\"schema.validator_defect\", undefined>, FailureDefinition<\"async.cancelled\", undefined>, FailureDefinition<\"async.deadline\", undefined>, FailureDefinition<\"failure.unexpected_defect\", undefined>, FailureDefinition<\"async.scope_failed\", StandardSchemaV1>, FailureDefinition<\"dot.action_not_exposed\", undefined>, FailureDefinition<\"dot.action_principal_required\", undefined>, FailureDefinition<\"dot.action_approval_required\", undefined>];", "jsdocSummary": "Failures owned by execution rather than the business implementation." }, { "subpath": "./action", "name": "ActionApprovalRequired", "kind": "variable", "signature": "export declare const ActionApprovalRequired: FailureDefinition<\"dot.action_approval_required\", undefined>;", "jsdocSummary": "Approval must be verified for this invocation, not inferred from another exposure." }, { "subpath": "./action", "name": "ActionFailureDefinition", "kind": "type", "signature": "export type ActionFailureDefinition = Pick & ((...args: never[]) => Failure);", "jsdocSummary": "Canonical definitions are shared with errorMap(), HTTP routes and JSON revival." }, { "subpath": "./action", "name": "ActionNotExposed", "kind": "variable", "signature": "export declare const ActionNotExposed: FailureDefinition<\"dot.action_not_exposed\", undefined>;", "jsdocSummary": "An adapter may call only an explicitly exposed boundary." }, { "subpath": "./action", "name": "ActionOptions", "kind": "type", "signature": "export type ActionOptions = { readonly id: string; readonly summary?: string; readonly input: Input; readonly output: Output; readonly failures: Definitions; readonly policy: ActionPolicy; };", "jsdocSummary": "The action's only authoring source. Its implementation is bound separately on the server." }, { "subpath": "./action", "name": "ActionPolicy", "kind": "type", "signature": "export type ActionPolicy = { readonly exposure: readonly string[]; readonly principal: 'optional' | 'required'; readonly approval: 'none' | 'required'; /** Metadata for an explicit retry owner; execution never retries implicitly. */ readonly retry: 'never' | 'idempotent'; };", "jsdocSummary": "Minimum authority is shared by every exposure, including internal jobs." }, { "subpath": "./action", "name": "ActionPrincipalRequired", "kind": "variable", "signature": "export declare const ActionPrincipalRequired: FailureDefinition<\"dot.action_principal_required\", undefined>;", "jsdocSummary": "The adapter must authenticate its caller before invoking this action." }, { "subpath": "./cli", "name": "AppImportFailed", "kind": "variable", "signature": "export declare const AppImportFailed: import(\"@arki/failure\").FailureDefinition<\"dot.app_import_failed\", StandardSchemaV1>;", "jsdocSummary": "Importing the app file threw, or its exported factory did." }, { "subpath": "./cli", "name": "AppInvalidExport", "kind": "variable", "signature": "export declare const AppInvalidExport: import(\"@arki/failure\").FailureDefinition<\"dot.app_invalid_export\", StandardSchemaV1>;", "jsdocSummary": "The app file loaded, but no export is a DOT app, or several are and none is `default` or `app`." }, { "subpath": "./cli", "name": "AppLifecycleFailed", "kind": "variable", "signature": "export declare const AppLifecycleFailed: import(\"@arki/failure\").FailureDefinition<\"dot.app_lifecycle_failed\", StandardSchemaV1>;", "jsdocSummary": "`configure` threw while the CLI prepared the app." }, { "subpath": "./cli", "name": "AppNotFound", "kind": "variable", "signature": "export declare const AppNotFound: import(\"@arki/failure\").FailureDefinition<\"dot.app_not_found\", StandardSchemaV1>;", "jsdocSummary": "No app file at the default paths and no `--app`." }, { "subpath": "./cli", "name": "DEV_STATE_PATH", "kind": "variable", "signature": "export declare const DEV_STATE_PATH = \".local/dot/dev.json\";", "jsdocSummary": "Where the state file lives, relative to the project directory." }, { "subpath": "./cli", "name": "DevAlreadyRunning", "kind": "variable", "signature": "export declare const DevAlreadyRunning: import(\"@arki/failure\").FailureDefinition<\"dot.dev_already_running\", StandardSchemaV1>;", "jsdocSummary": "Another `dot dev` is alive in this project: its pid is in the state file." }, { "subpath": "./cli", "name": "DevAppStarted", "kind": "variable", "signature": "export declare const DevAppStarted: import(\"@arki/failure\").FailureDefinition<\"dot.dev_app_started\", StandardSchemaV1>;", "jsdocSummary": "The app export is already configured, booted or started: `dot dev` cannot own its lifecycle." }, { "subpath": "./cli", "name": "DevDbUnreachable", "kind": "variable", "signature": "export declare const DevDbUnreachable: import(\"@arki/failure\").FailureDefinition<\"dot.dev_db_unreachable\", StandardSchemaV1>;", "jsdocSummary": "`dot dev` found no Postgres to talk to: no URL, a bad URL, or a closed port it could not start." }, { "subpath": "./cli", "name": "DevEvent", "kind": "type", "signature": "export type DevEvent = z.infer;", "jsdocSummary": "One `dot dev` event." }, { "subpath": "./cli", "name": "devEventSchema", "kind": "variable", "signature": "export declare const devEventSchema: StandardSchemaV1;", "jsdocSummary": "Parses a `DevEvent` (Standard Schema: no validator library in the public type)." }, { "subpath": "./cli", "name": "DevPortInUse", "kind": "variable", "signature": "export declare const DevPortInUse: import(\"@arki/failure\").FailureDefinition<\"dot.dev_port_in_use\", StandardSchemaV1>;", "jsdocSummary": "Something already listens on the app port, so the runner would not get it." }, { "subpath": "./cli", "name": "DevPreflightFailed", "kind": "variable", "signature": "export declare const DevPreflightFailed: import(\"@arki/failure\").FailureDefinition<\"dot.dev_preflight_failed\", StandardSchemaV1>;", "jsdocSummary": "The preflight process did not report a result: a crash, a hang past the timeout, or output that is not its report. Never a pass." }, { "subpath": "./cli", "name": "DevRemoteDbRefused", "kind": "variable", "signature": "export declare const DevRemoteDbRefused: import(\"@arki/failure\").FailureDefinition<\"dot.dev_remote_db_refused\", StandardSchemaV1>;", "jsdocSummary": "The database is neither on this machine nor a compose service: `dot dev` would migrate it on boot." }, { "subpath": "./cli", "name": "DevResult", "kind": "type", "signature": "export type DevResult = { readonly items: DevEvent[]; };", "jsdocSummary": "What `dot dev` succeeds with: every event, so `--output ndjson` prints one per line." }, { "subpath": "./cli", "name": "DevRunnerFailed", "kind": "variable", "signature": "export declare const DevRunnerFailed: import(\"@arki/failure\").FailureDefinition<\"dot.dev_runner_failed\", StandardSchemaV1>;", "jsdocSummary": "The app runner (`vite dev`, `--run`, or `dot _serve`) could not be started." }, { "subpath": "./cli", "name": "DevState", "kind": "type", "signature": "export type DevState = z.infer;", "jsdocSummary": "The content of `dev.json`." }, { "subpath": "./cli", "name": "devStateSchema", "kind": "variable", "signature": "export declare const devStateSchema: StandardSchemaV1;", "jsdocSummary": "Parses `dev.json` (Standard Schema: no validator library in the public type)." }, { "subpath": "./cli", "name": "DoctorFailed", "kind": "variable", "signature": "export declare const DoctorFailed: import(\"@arki/failure\").FailureDefinition<\"dot.doctor_failed\", StandardSchemaV1>;", "jsdocSummary": "`doctor` found error-severity issues. The data is the whole report: `.error.data.plugins[]`." }, { "subpath": "./cli", "name": "DoctorOptions", "kind": "type", "signature": "export type DoctorOptions = { /** Also check that an OpenTelemetry SDK is registered; a missing one is a warning issue. */ readonly observability?: boolean | undefined; /** Return the observed plugin graph as Mermaid source instead of the diagnostics. */ readonly graph?: boolean | undefined; /** * Called with the booted app before it is disposed, when boot succeeded. * `dot dev` reads what the preflight boot published here (the * `migrations` service of `dbMigrations`). */ readonly onBooted?: ((app: DotApp, Failure, Failure, PluginPhases>) => void) | undefined; };", "jsdocSummary": "" }, { "subpath": "./cli", "name": "DoctorReport", "kind": "type", "signature": "export type DoctorReport = DotDiagnosticsSnapshot & { readonly status: DoctorStatus; };", "jsdocSummary": "What `dot doctor` returns: the diagnostics snapshot and its verdict." }, { "subpath": "./cli", "name": "DoctorStatus", "kind": "type", "signature": "export type DoctorStatus = 'success' | 'warning' | 'failure';", "jsdocSummary": "`doctor`'s verdict: the worst severity among all the snapshot's issues." }, { "subpath": "./cli", "name": "DotNewOperation", "kind": "type", "signature": "export type DotNewOperation = { readonly path: string; readonly action: FileOperation['action']; readonly contentHash: string; readonly contentBytes: number; readonly reason: string; };", "jsdocSummary": "One file `dot new` plans or writes, as printed in `.data.operations[]`." }, { "subpath": "./cli", "name": "DotNewResult", "kind": "type", "signature": "export type DotNewResult = { readonly app: { readonly name: string; readonly target: string; }; readonly operations: readonly DotNewOperation[]; /** The commands to run next, from the directory `dot new` ran in. */ readonly nextSteps: readonly string[]; };", "jsdocSummary": "What `dot new` returns: the same shape for `--dry-run` and a real run." }, { "subpath": "./cli", "name": "ExplainData", "kind": "type", "signature": "export type ExplainData = DotAppManifest | GraphData | ProjectionData;", "jsdocSummary": "What `dot explain` returns: the manifest, or the `--graph` / `--as` payload." }, { "subpath": "./cli", "name": "ExplainOptions", "kind": "type", "signature": "export type ExplainOptions = { /** Return the plugin graph as Mermaid source instead of the manifest. */ readonly graph?: boolean | undefined; /** Return the document of this registered projection format instead of the manifest. */ readonly as?: string | undefined; /** Replace the projection module for this run (`--as` only). */ readonly module?: string | undefined; /** The app file: projection modules resolve relative to it. Defaults to the cwd. */ readonly appFilePath?: string | undefined; };", "jsdocSummary": "" }, { "subpath": "./cli", "name": "GraphData", "kind": "type", "signature": "export type GraphData = { format: 'mermaid'; /** Mermaid `flowchart` source. */ source: string; };", "jsdocSummary": "The `data` of `--graph`: Mermaid source." }, { "subpath": "./cli", "name": "ObservabilityNoSdk", "kind": "variable", "signature": "export declare const ObservabilityNoSdk: import(\"@arki/failure\").FailureDefinition<\"dot.observability_no_sdk\", undefined>;", "jsdocSummary": "`doctor --observability` found no OpenTelemetry SDK. Reported as a warning issue in the snapshot, not returned." }, { "subpath": "./cli", "name": "PreflightFailed", "kind": "variable", "signature": "export declare const PreflightFailed: import(\"@arki/failure\").FailureDefinition<\"dot.preflight_failed\", import(\"zod\").ZodObject<{ app: import(\"zod\").ZodNullable>; migrations: import(\"zod\").ZodNullable>; report: import(\"zod\").ZodNullable; plugins: import(\"zod\").ZodArray>; }, import(\"zod/v4/core\").$loose>>; actions: import(\"zod\").ZodArray>; }, import(\"zod/v4/core\").$loose>>; services: import(\"zod\").ZodArray>; }, import(\"zod/v4/core\").$loose>>; lifecycle: import(\"zod\").ZodArray>; }, import(\"zod/v4/core\").$loose>>; issues: import(\"zod\").ZodArray>; }, import(\"zod/v4/core\").$loose>>; failure: import(\"zod\").ZodNullable>; }, import(\"zod/v4/core\").$strip>>;", "jsdocSummary": "A managed preflight reported a lifecycle failure, retaining the complete report." }, { "subpath": "./cli", "name": "program", "kind": "variable", "signature": "export declare const program: import(\"@arki/cli\").Program;", "jsdocSummary": "The `dot` program. `program.main(argv, io)` runs one command line without touching the process." }, { "subpath": "./cli", "name": "ProjectionConflict", "kind": "variable", "signature": "export declare const ProjectionConflict: import(\"@arki/failure\").FailureDefinition<\"dot.projection_conflict\", StandardSchemaV1>;", "jsdocSummary": "Two plugins register different modules for one projection format." }, { "subpath": "./cli", "name": "ProjectionData", "kind": "type", "signature": "export type ProjectionData = { format: string; document: JsonValue; };", "jsdocSummary": "The `data` of `explain --as`: the format and the document `project(manifest)` returned." }, { "subpath": "./cli", "name": "ProjectionExecutionFailed", "kind": "variable", "signature": "export declare const ProjectionExecutionFailed: import(\"@arki/failure\").FailureDefinition<\"dot.projection_execution_failed\", StandardSchemaV1>;", "jsdocSummary": "`project(manifest)` threw or returned output that does not survive a JSON round trip." }, { "subpath": "./cli", "name": "ProjectionImportFailed", "kind": "variable", "signature": "export declare const ProjectionImportFailed: import(\"@arki/failure\").FailureDefinition<\"dot.projection_import_failed\", StandardSchemaV1>;", "jsdocSummary": "The projection module could not be resolved or imported, or exports no `project(manifest)`." }, { "subpath": "./cli", "name": "ProjectionNotFound", "kind": "variable", "signature": "export declare const ProjectionNotFound: import(\"@arki/failure\").FailureDefinition<\"dot.projection_not_found\", StandardSchemaV1>;", "jsdocSummary": "No plugin registers the `--as` format." }, { "subpath": "./cli", "name": "runDev", "kind": "function", "signature": "export declare function runDev(options: RunDevOptions): Promise;", "jsdocSummary": "Run one `dot dev` session. Returns every event, or the failure that stopped it before the runner ran (discovery, `dev.json`, db, preflight, runner). Failures after the start are printed and the session waits for a change." }, { "subpath": "./cli", "name": "RunDevOptions", "kind": "type", "signature": "export type RunDevOptions = { /** App file (default: discovery's search list). */ readonly app?: string | undefined; readonly cwd?: string | undefined; readonly db: DbChoice; /** Accept a database that is neither local nor a compose service. Boot migrates it. */ readonly allowRemoteDb: boolean; readonly port: number; readonly consolePort: number; /** Hand `CONSOLE_PORT` to the runner and announce the console URL once it appears in `dev.json`. */ readonly console: boolean; /** Open the console URL in the browser when it appears. */ readonly open: boolean; /** Stop after the preflight: no runner. */ readonly once: boolean; /** A shell command line that serves the app, instead of Vite or `dot _serve`. */ readonly run?: string | undefined; readonly ui: Ui; readonly mode: Mode; /** Aborting it ends the session: the runner is stopped, `dev.json` removed. */ readonly signal: AbortSignal; /** Sees every event as it happens; the result lists them all at the end. */ readonly onEvent?: ((event: DevEvent) => void) | undefined; /** The process env, merged over `.env`. Default `process.env`. */ readonly env?: Readonly> | undefined; readonly exec?: Exec | undefined; readonly probe?: Probe | undefined; readonly lookup?: Lookup | undefined; /** How to start the `dot` CLI for `_serve`: the program, then its entry script. Default: this runtime and this CLI. */ readonly cliEntry?: readonly [string, ...string[]] | undefined; /** Where keys are read from in a text-mode terminal. Default `process.stdin`. */ readonly stdin?: KeyInput | undefined; readonly openUrl?: ((url: string) => void) | undefined; /** How long the runner gets between SIGTERM and SIGKILL. Default 10 s. */ readonly stopGraceMs?: number | undefined; /** How long one preflight process may run before it is killed and the preflight fails. Default 120 s. */ readonly preflightTimeoutMs?: number | undefined; };", "jsdocSummary": "" }, { "subpath": "./cli", "name": "runDoctor", "kind": "function", "signature": "export declare function runDoctor(discovered: DiscoveredApp, opts?: DoctorOptions): Promise;", "jsdocSummary": "Run `doctor` on a discovered app. The CLI owns boot and dispose only when it receives a builder or a configured app; an already-booted app is read and left to its caller. With `graph`, a boot that throws returns `dot.doctor_failed` with the diagnostics, not the graph." }, { "subpath": "./cli", "name": "runExplain", "kind": "function", "signature": "export declare function runExplain(discovered: DiscoveredApp, opts?: ExplainOptions): Promise;", "jsdocSummary": "Explain a discovered app. A builder is configured, never booted; a configured or booted app is read as is." }, { "subpath": "./cli", "name": "runNew", "kind": "function", "signature": "export declare function runNew(opts: RunNewOptions): Promise;", "jsdocSummary": "Run `dot new`: plan, then write unless `dryRun`. Returns `{ app, operations }` or a failure: `cli.invalid_input` (name, template), `dot.target_not_empty`, `dot.template_missing`, `dot.write_failed`. Prints nothing." }, { "subpath": "./cli", "name": "RunNewOptions", "kind": "type", "signature": "export type RunNewOptions = { /** Application name (becomes `package.json#name`). */ readonly name: string; /** * Working directory for resolving `--target`. Defaults to * `process.cwd()` when omitted. */ readonly cwd?: string; /** * Target directory; resolved against `cwd`. Defaults to `` * under `cwd`. The directory is created if missing. */ readonly target?: string; /** Package manager hint surfaced in README/AGENTS.md. Defaults to `bun`. */ readonly pm?: PackageManager; /** * Bundled template to scaffold (`stack` or `minimal`). Defaults to * {@link DEFAULT_TEMPLATE}. Any other value fails with `cli.invalid_input`. */ readonly template?: string; /** When true, only plan operations — write nothing. */ readonly dryRun?: boolean; /** When true, overwrite existing files in the target dir. */ readonly force?: boolean; /** * Override template root. Used by tests; production callers should * leave this undefined so the bundled `templates/app-