@zhin.js/plugin-runtime 1.1.20 → 1.1.21

package/lib/plugin-console-rpc.d.ts

@@ -20,9 +20,11 @@ import type { JsonValue } from './persistent-state.js';
  */
 export type PluginConsoleRpcJson = JsonValue;
 export type PluginConsoleRpcInput = Readonly<Record<string, JsonValue>>;
-export interface PluginConsoleRpcCall {
+export interface PluginConsoleRpcCall<TConfig = Record<string, unknown>> {
     /** Aborted when the Host request times out. Long work must observe it. */
     readonly signal: AbortSignal;
+    /** Validated plugin configuration for this generation, when available. */
+    readonly config?: TConfig;
     /** Authenticated operation view; no snapshot, configuration, resource or private resolver access. */
     readonly runtime?: Readonly<{
         owner: PluginId;
@@ -33,7 +35,10 @@ export interface PluginConsoleRpcCall {
     /** Framework-only request-local notification before a validated durable mutation begins. */
     commitStarted?(): void;
 }
-export interface PluginConsoleRpcMethod<TInput = PluginConsoleRpcInput> {
+export type PluginConsoleRpcCallContext<TMethods = Record<string, unknown>, TKey extends keyof TMethods = keyof TMethods, TConfig = Record<string, unknown>> = PluginConsoleRpcCall<TConfig> & {
+    readonly method?: TKey;
+};
+export interface PluginConsoleRpcMethod<TInput = PluginConsoleRpcInput, TConfig = Record<string, unknown>> {
     /** Local name of a Page owned by the same plugin (`pages/<page>/index.tsx`). Its access rules apply. */
     readonly page?: string;
     /** Extra permissions on top of the page's own requirements. */
@@ -49,26 +54,29 @@ export interface PluginConsoleRpcMethod<TInput = PluginConsoleRpcInput> {
      * Return a small, user-facing JSON shape. Never return raw log records, prompts, chat lines,
      * secrets or exception text: the Console shows this to ordinary users.
      */
-    handler(input: TInput, call: PluginConsoleRpcCall): JsonValue | Promise<JsonValue>;
+    handler(input: TInput, call: PluginConsoleRpcCall<TConfig>): JsonValue | Promise<JsonValue>;
 }
-export interface PluginConsoleRpcStatus extends PluginConsoleRpcMethod<PluginConsoleRpcInput> {
+export interface PluginConsoleRpcStatus<TConfig = Record<string, unknown>> extends PluginConsoleRpcMethod<PluginConsoleRpcInput, TConfig> {
     /** Allow the demo-scope Console token to read this status. Default `false`. */
     readonly demo?: boolean;
 }
-export interface PluginConsoleRpcDefinition {
+export interface PluginConsoleRpcDefinition<TConfig = Record<string, unknown>> {
     /** Read-only status for the plugin's Console page(s): `plugin.<pluginId>.status`. */
-    readonly status?: PluginConsoleRpcStatus;
+    readonly status?: PluginConsoleRpcStatus<TConfig>;
     /**
      * Extra read-only views beside `status`: `plugin.<pluginId>.<name>`. Same access rules as
      * `status`; use them when one plugin backs several pages with different permissions.
      */
-    readonly queries?: Readonly<Record<string, PluginConsoleRpcStatus>>;
+    readonly queries?: Readonly<Record<string, PluginConsoleRpcStatus<TConfig>>>;
     /**
      * Limited, named actions: `plugin.<pluginId>.<name>`. Non-admin tokens may run one only when the
      * action declares its own requirements and the token holds them (plus the page's); otherwise
      * admin-only.
      */
-    readonly actions?: Readonly<Record<string, PluginConsoleRpcMethod>>;
+    readonly actions?: Readonly<Record<string, PluginConsoleRpcMethod<PluginConsoleRpcInput, TConfig>>>;
+}
+export interface PluginConsoleRpcDefiner<TConfig = Record<string, unknown>> {
+    (definition: PluginConsoleRpcDefinition<TConfig>): PluginConsoleRpc;
 }
 export interface NormalizedPluginConsoleRpcMethod {
     readonly page?: string;
@@ -93,4 +101,7 @@ export declare class PluginConsoleRpcError extends Error {
 export declare const pluginConsoleRpcToken: import("./token.js").Token<PluginConsoleRpc>;
 export declare const PLUGIN_CONSOLE_RPC_STATUS = "status";
 /** Validates and freezes a plugin's Console RPC surface. Throws on invalid names at setup time. */
-export declare function definePluginConsoleRpc(definition: PluginConsoleRpcDefinition): PluginConsoleRpc;
+export declare function definePluginConsoleRpc<TConfig = Record<string, unknown>>(definition: PluginConsoleRpcDefinition<TConfig>): PluginConsoleRpc;
+export declare namespace definePluginConsoleRpc {
+    var withConfig: <TConfig = Record<string, unknown>>() => PluginConsoleRpcDefiner<TConfig>;
+}

package/lib/plugin-console-rpc.js

@@ -42,6 +42,13 @@ export function definePluginConsoleRpc(definition) {
         get [generationAdmissionSource]() { return gates; },
     });
 }
+/**
+ * Fix the plugin config type first, then define the Console RPC surface:
+ * `definePluginConsoleRpc.withConfig<MyConfig>()({ status: { handler(_input, call) { ... } } })`
+ */
+definePluginConsoleRpc.withConfig = function withConfig() {
+    return (definition) => definePluginConsoleRpc(definition);
+};
 function normalizeMethod(name, method, demo, readOnly) {
     if (!method || typeof method.handler !== 'function') {
         throw new TypeError(`Plugin Console RPC ${name} must have a handler`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhin.js/plugin-runtime",
-  "version": "1.1.20",
+  "version": "1.1.21",
   "description": "Zero-dependency Plugin tree, Scope and atomic generation runtime for Zhin",
   "type": "module",
   "main": "./lib/index.js",