@cueai/omni-reader-mcp 1.0.2 → 1.1.0

package/dist/operation-manager.d.ts

@@ -0,0 +1,75 @@
+import type { ArtifactReadResult, LocalResult } from "./artifact-store.js";
+import type { CubeGrantClient } from "./cube-client.js";
+import type { IiisClient, ResultRetentionSink } from "./iiis-client.js";
+import type { JournalPatch, JournalRecord, JournalState, OperationJournal } from "./operation-journal.js";
+import { type OpenAllowedFileOptions, type OpenedAllowedFile } from "./path-security.js";
+import type { RemoteOmniClient } from "./remote-client.js";
+import type { ParseResult } from "./result-contract.js";
+export interface SubmitOperationInput {
+    readonly sourceKind: "local" | "url";
+    readonly sourceFacts: Readonly<Record<string, unknown>>;
+    readonly clientRequestId: string;
+    readonly signal?: AbortSignal;
+    readonly context?: unknown;
+}
+export interface OperationDriverUpdate {
+    readonly state: JournalState;
+    readonly patch?: JournalPatch;
+    readonly result?: ParseResult;
+}
+export interface OperationExecutionCompletion {
+    readonly update: OperationDriverUpdate;
+    readonly result: ParseResult;
+}
+export interface OperationExecution {
+    readonly initial: OperationDriverUpdate;
+    readonly completed: Promise<OperationExecutionCompletion>;
+    snapshot(): OperationDriverUpdate;
+    cancel(): void | Promise<void>;
+}
+export type OperationDriverStart = OperationDriverUpdate | OperationExecution;
+export interface OperationManagerDriver {
+    create(input: SubmitOperationInput, requestHash: string, signal: AbortSignal): Promise<OperationDriverStart>;
+    resume?(record: JournalRecord, input: SubmitOperationInput, signal: AbortSignal): Promise<OperationDriverStart | void>;
+    status?(record: JournalRecord, waitMs: number | undefined, signal: AbortSignal): Promise<OperationDriverStart | void>;
+    cancel?(record: JournalRecord, signal: AbortSignal): Promise<OperationDriverUpdate | void>;
+    result?(record: JournalRecord, signal: AbortSignal): Promise<ParseResult | void>;
+}
+export interface OperationManagerOptions {
+    readonly journal: Pick<OperationJournal, "beginIntent" | "transition" | "loadByRequestId" | "loadByOperationId" | "loadLatestByRequestHash" | "loadLatestBySourceLocatorHash" | "listRecoverable">;
+    readonly driver: OperationManagerDriver;
+    readonly now?: () => number;
+    readonly sleep?: (milliseconds: number) => Promise<void>;
+}
+export declare function operationRequestHash(input: Pick<SubmitOperationInput, "sourceKind" | "sourceFacts">): string;
+export declare class OperationManager {
+    #private;
+    constructor(options: OperationManagerOptions);
+    submit(input: SubmitOperationInput): Promise<JournalRecord>;
+    submitResult(input: SubmitOperationInput, foregroundBudgetMs?: number): Promise<ParseResult>;
+    statusResult(operationId: string, waitMs?: number, signal?: AbortSignal): Promise<ParseResult>;
+    cancelResult(operationId: string, signal?: AbortSignal): Promise<ParseResult>;
+    status(operationId: string, waitMs?: number, signal?: AbortSignal): Promise<JournalRecord>;
+    cancel(operationId: string, signal?: AbortSignal): Promise<JournalRecord>;
+}
+interface LocalRetention extends ResultRetentionSink {
+    result(): LocalResult;
+}
+interface LocalArtifactStore {
+    createRetention(): LocalRetention;
+    read(resultId: string, cursor?: string, maxBytes?: number): Promise<ArtifactReadResult>;
+}
+export interface LocalParseOperationManagerOptions {
+    readonly journal: OperationJournal;
+    readonly workspace: string;
+    readonly extraRoots?: readonly string[];
+    readonly cubeClient: Pick<CubeGrantClient, "createGrant">;
+    readonly iiisClient: Pick<IiisClient, "uploadAndWait" | "recoverAndWait" | "inspectOperation" | "downloadResult" | "ack"> & Partial<Pick<IiisClient, "cancelOperation">>;
+    readonly artifactStore: LocalArtifactStore;
+    readonly remoteClient?: RemoteOmniClient;
+    readonly openFile?: (localPath: string, options: OpenAllowedFileOptions) => Promise<OpenedAllowedFile>;
+    readonly now?: () => Date;
+    readonly sleep?: (milliseconds: number) => Promise<void>;
+}
+export declare function createLocalParseOperationManager(options: LocalParseOperationManagerOptions): OperationManager;
+export {};