@mearl/client 2.20.6 → 2.21.0

package/dist/pluginTaskManager.d.ts

@@ -0,0 +1,92 @@
+import type { PluginModelCatalog } from './pluginModelCatalog.js';
+import type { PluginStateManager } from './pluginStateManager.js';
+import type { PluginPageManager } from './pluginPageManager.js';
+import type { PluginStateDeclaration } from './generated-plugin-state.js';
+import type { PluginTaskCheckpoint, PluginTaskRecoveryContext, PluginTaskRecoveryDeclaration } from './generated-plugin-recovery.js';
+import { executeRegisteredPlugin } from './pluginExecutor.js';
+import { capturePluginRevision } from './pluginRevision.js';
+import type { PluginRevision } from './pluginRevision.js';
+import { PluginTaskStore } from './pluginTaskStore.js';
+import type { PluginTask, PluginTaskStartResult, PluginTaskListResult } from './generated-plugin-tasks.js';
+import type { PluginTaskScope, PluginTaskStartRequest, PluginTaskResumeRequest } from './pluginTaskProtocol.js';
+import type { PluginInvocationIdentity } from './generated-plugin-execution.js';
+import type { PluginPageTarget } from './generated-plugin-pages.js';
+import type { PluginOptions } from './plugin.js';
+import type { PluginPageBinding } from './generated-plugin-pages.js';
+import type { PluginPageRuntime } from './generated-plugin-pages.js';
+export interface PluginTaskBridge {
+    id: string;
+    scope: PluginTaskScope;
+    invoke(action: string, payload: Record<string, unknown>, options: PluginOptions): Promise<unknown>;
+}
+export interface PluginTaskManagerOptions {
+    store?: PluginTaskStore;
+    captureRevision?: typeof capturePluginRevision;
+    execute?: typeof executeRegisteredPlugin;
+    workerPath?: string;
+    concurrency?: number;
+    modelConcurrency?: number;
+}
+export interface PluginTaskServices {
+    state: PluginStateManager['call'];
+    page: PluginPageManager['call'];
+    listModels: PluginModelCatalog['list'];
+    model?: (owner: string, ...args: Parameters<typeof executeRegisteredPlugin>) => ReturnType<typeof executeRegisteredPlugin>;
+    releaseModels?: (owner: string) => Promise<void>;
+}
+export declare class PluginTaskManager {
+    private readonly configuration;
+    private readonly services?;
+    readonly host: import("./generated-plugin-execution.js").PluginExecutionHost;
+    readonly store: PluginTaskStore;
+    private readonly changes;
+    private readonly queue;
+    private readonly running;
+    private readonly resuming;
+    private readonly activeChildren;
+    private closed;
+    private readonly maintenance;
+    private descriptionsRunning;
+    private readonly descriptions;
+    private descriptionBytes;
+    private readonly revisionPins;
+    private readonly recoveries;
+    pinRevision(revision: PluginRevision): () => void;
+    describeRevision(revision: PluginRevision, signal: AbortSignal, options?: {
+        cache?: boolean;
+    }): Promise<{
+        pageRuntime?: PluginPageRuntime;
+        stateStorage?: PluginStateDeclaration;
+        taskRecovery?: PluginTaskRecoveryDeclaration;
+    }>;
+    constructor(configuration?: PluginTaskManagerOptions, services?: PluginTaskServices | undefined);
+    private authorize;
+    get(taskId: string, scope: PluginTaskScope): PluginTask;
+    list(scope: PluginTaskScope, activeOnly?: boolean, cursor?: string, limit?: number): PluginTaskListResult;
+    start(request: PluginTaskStartRequest, bridge: PluginTaskBridge, binding?: {
+        revision: PluginRevision;
+        guard?: () => Promise<void>;
+        page?: PluginPageBinding;
+        parentTaskId?: string;
+        parentIdentity?: PluginInvocationIdentity;
+        documentTarget?: PluginPageTarget;
+        recovery?: PluginTaskRecoveryContext;
+        recoveryRequestHash?: string;
+    } | undefined): PluginTaskStartResult;
+    checkpoint(taskId: string, scope: PluginTaskScope): PluginTaskCheckpoint | null;
+    resume(request: PluginTaskResumeRequest, bridge: PluginTaskBridge): Promise<PluginTaskStartResult>;
+    private resumeAttempt;
+    private assertExecutionTreeStopped;
+    cancel(taskId: string, scope: PluginTaskScope): PluginTask;
+    events(taskId: string, scope: PluginTaskScope, cursor: number, waitMs?: number, signal?: AbortSignal): Promise<import("./generated-plugin-tasks.js").PluginTaskEvents>;
+    resultChunk(taskId: string, scope: PluginTaskScope, index: number): import("./generated-plugin-tasks.js").PluginTaskResultChunk;
+    private update;
+    private drain;
+    private execute;
+    private assertRouting;
+    assertChildBudget(parent: string): void;
+    awaitChild(parent: string, child: string, scope: PluginTaskScope, signal: AbortSignal, onProgress?: (progress: NonNullable<PluginTask['progress']>) => void): Promise<unknown>;
+    private stopChildren;
+    private waitResult;
+    close(): Promise<void>;
+}