@zhin.js/host-http 1.0.0

package/lib/console-rpc.d.ts

@@ -0,0 +1,98 @@
+import type { AuthScope } from './token-registry.js';
+import type { DatabaseHostConsole } from '@zhin.js/plugin-runtime';
+import { type ConsoleRpcExtendedCtx } from './console-rpc-extended.js';
+export type RuntimeConsoleRpcMessage = {
+    readonly type?: unknown;
+    readonly requestId?: unknown;
+    readonly [key: string]: unknown;
+};
+export type RuntimeConsoleRpcReply = Record<string, unknown>;
+export type RuntimeConsolePage = {
+    readonly id: string;
+    readonly localName: string;
+    readonly title: string;
+    readonly route: string;
+    readonly module: string;
+    readonly order: number;
+    readonly hash: string;
+};
+export type RuntimeConsoleRpcContext = {
+    readonly authScope: AuthScope;
+    listPages(): Promise<readonly RuntimeConsolePage[]>;
+    /** Optional project config accessors for read-only config RPCs. */
+    readConfigYaml?(): Promise<string>;
+    listPluginKeys?(): Promise<readonly string[]>;
+    readConfigDocument?(): Promise<Record<string, unknown>>;
+    /**
+     * Full-scope write: replace project config file contents (YAML or JSON text).
+     * Runtime Host does not hot-reload the process — callers should restart.
+     */
+    writeConfigYaml?(yaml: string): Promise<void>;
+    /**
+     * Full-scope write: set `document[pluginName] = data` and persist.
+     * Returns whether a process restart is required (always true without ConfigFeature).
+     */
+    setConfigKey?(pluginName: string, data: unknown): Promise<{
+        restartRequired: boolean;
+    }>;
+    /** Project file manager (allowlisted paths under project root). */
+    listProjectFiles?(): Promise<readonly unknown[]>;
+    readProjectFile?(filePath: string): Promise<{
+        content: string;
+        size: number;
+    }>;
+    saveProjectFile?(filePath: string, content: string): Promise<void>;
+    listEnvFiles?(): Promise<readonly {
+        name: string;
+        exists: boolean;
+    }[]>;
+    readEnvFile?(filename: string): Promise<string>;
+    writeEnvFile?(filename: string, content: string): Promise<void>;
+    /** Optional schema accessors (plugin schema.json / Runtime schema registry). */
+    getSchema?(pluginName?: string): Promise<unknown>;
+    getAllSchemas?(): Promise<Record<string, unknown>>;
+    /** Optional Adapter endpoint Console surface (Sandbox / Remote Console). */
+    listEndpoints?(): Promise<readonly RuntimeEndpointSummary[]>;
+    getEndpoint?(adapter: string, endpointId: string): Promise<RuntimeEndpointSummary | null>;
+    sendEndpointMessage?(input: RuntimeEndpointSendInput): Promise<{
+        messageId: string;
+    }>;
+    /** Optional Database host surface (CLI wires DatabaseHost from plugin-runtime). */
+    dbInfo?(): Promise<RuntimeDatabaseInfo> | RuntimeDatabaseInfo;
+    dbTables?(): Promise<readonly string[]> | readonly string[];
+    database?: DatabaseHostConsole;
+    /** Full-scope: request process restart (CLI daemon watches exit code). */
+    requestRestart?(): Promise<void> | void;
+    /** Extended RPC surface（cron/schedule、endpoint 社交/inbox），fullScope 由 authScope 推导。 */
+    extended?: Omit<ConsoleRpcExtendedCtx, 'fullScope'>;
+};
+export type RuntimeEndpointPhase = 'pending' | 'starting' | 'online' | 'failed' | 'unconfigured';
+export type RuntimeEndpointSummary = {
+    readonly name: string;
+    readonly adapter: string;
+    readonly connected: boolean;
+    readonly status: 'online' | 'offline';
+    readonly phase?: RuntimeEndpointPhase;
+    readonly pendingLogin?: boolean;
+};
+export type RuntimeDatabaseInfo = {
+    readonly dialect: string | null;
+    readonly connected: boolean;
+    readonly tables: number;
+};
+export type RuntimeEndpointSendInput = {
+    readonly adapter: string;
+    readonly endpointId: string;
+    readonly channelId: string;
+    readonly channelType: string;
+    readonly content: unknown;
+    readonly parent?: {
+        type?: string;
+        id?: string;
+        name?: string;
+    };
+};
+export declare function pickRpcReply(message: RuntimeConsoleRpcMessage, payloads: readonly RuntimeConsoleRpcReply[]): RuntimeConsoleRpcReply | null;
+export declare function dispatchRuntimeConsoleRpc(message: RuntimeConsoleRpcMessage, ctx: RuntimeConsoleRpcContext): Promise<RuntimeConsoleRpcReply[]>;
+/** HTTP paths under apiBase that demo scope may call (ADR 0016). */
+export declare function isDemoHttpAllowed(method: string, pathname: string, apiBase: string): boolean;