@easonwumac/computer-linker 0.1.2

package/dist/workspace-operations.d.ts

@@ -0,0 +1,170 @@
+import { type AuditEventInput } from "./audit.js";
+import { type CapabilityName, type CapabilityPolicy } from "./capability-policy.js";
+import { type PathPermissions } from "./permissions.js";
+import { WorkspaceRegistry, type Workspace } from "./workspaces.js";
+export declare const workspaceOperationNames: readonly ["stat", "list", "list_details", "explain_operation", "tree", "instructions", "agent_skills", "coding_context", "project_overview", "history", "history_insight", "change_summary", "repo_status", "git_changes", "git_diff", "git_log", "git_show", "git_stage", "git_unstage", "git_commit", "git_worktree_list", "git_worktree_create", "read", "read_many", "write", "create_file", "write_if_unchanged", "edit", "patch", "mkdir", "delete", "move", "find_files", "search_text", "search_symbols", "package_run", "package_start", "command", "process_start", "process_list", "process_read", "process_stop", "codex_start", "codex", "codex_plan", "codex_review", "codex_fix", "codex_test", "codex_continue", "codex_runs", "screen_list", "screen_capture", "screen_capture_window", "screen_capture_process", "batch"];
+export type WorkspaceOperationName = typeof workspaceOperationNames[number];
+export interface WorkspaceOperationCatalogEntry {
+    operation: WorkspaceOperationName;
+    permission: "read" | "write" | "shell" | "codex" | "screen" | "mixed";
+    description: string;
+    requiredFields: string[];
+    optionalFields: string[];
+    example: WorkspaceOperationInput;
+}
+export type WorkspaceOperationBoundary = "workspace-path-enforced" | "workspace-scoped-metadata" | "workspace-cwd-only" | "mixed";
+export interface WorkspaceOperationSafetyEntry {
+    operation: WorkspaceOperationName;
+    permission: WorkspaceOperationCatalogEntry["permission"];
+    boundary: WorkspaceOperationBoundary;
+    note: string;
+}
+export interface WorkspaceOperationSchema {
+    requiredFields: string[];
+    optionalFields: string[];
+    example: WorkspaceOperationInput;
+}
+export type WorkspaceOperationRunner = (registry: WorkspaceRegistry, workspace: Workspace, input: WorkspaceOperationInput) => Promise<unknown>;
+export interface WorkspaceOperationRunRegistration {
+    type: "workspace-operation-dispatch";
+    handler: "runWorkspaceOperation" | "runFileSearchOperation" | "runMetadataOperation" | "runCodexOperation" | "runScreenOperation";
+    execute: WorkspaceOperationRunner;
+}
+export interface WorkspaceOperationAuditRegistration {
+    eventType: "tool_call";
+    fields: "workspaceOperationAuditFields";
+    redactions: string[];
+}
+export interface WorkspaceOperationInput {
+    operation: WorkspaceOperationName;
+    operationName?: string;
+    path?: string;
+    paths?: string[];
+    content?: string;
+    patch?: string;
+    oldText?: string;
+    newText?: string;
+    fromPath?: string;
+    toPath?: string;
+    recursive?: boolean;
+    pattern?: string;
+    query?: string;
+    glob?: string;
+    fixedStrings?: boolean;
+    caseSensitive?: boolean;
+    maxResults?: number;
+    view?: string;
+    beforeContext?: number;
+    afterContext?: number;
+    maxDepth?: number;
+    maxEntries?: number;
+    startLine?: number;
+    lineCount?: number;
+    includeFiles?: boolean;
+    maxBytes?: number;
+    includeDiff?: boolean;
+    staged?: boolean;
+    expectedSha256?: string;
+    message?: string;
+    ref?: string;
+    script?: string;
+    scriptArgs?: string[];
+    branch?: string;
+    startPoint?: string;
+    command?: string;
+    processId?: string;
+    signal?: string;
+    prompt?: string;
+    workflowId?: string;
+    format?: string;
+    returnMode?: string;
+    maxWidth?: number;
+    maxHeight?: number;
+    workingDirectory?: string;
+    timeoutSeconds?: number;
+    maxOutputBytes?: number;
+    operations?: WorkspaceOperationInput[];
+    continueOnError?: boolean;
+}
+export interface WorkspaceOperationEnvelope {
+    operation?: WorkspaceOperationName;
+    op?: WorkspaceOperationName;
+    target?: string;
+    input?: Record<string, unknown>;
+    options?: Record<string, unknown>;
+}
+export interface ProcessResult {
+    exitCode: number | null;
+    signal?: string;
+    timedOut: boolean;
+    stdout: string;
+    stderr: string;
+    stdoutTruncated?: boolean;
+    stderrTruncated?: boolean;
+}
+export declare const workspaceOperationCatalog: WorkspaceOperationCatalogEntry[];
+export declare const workspaceOperationSafety: WorkspaceOperationSafetyEntry[];
+export type WorkspaceOperationCategory = "metadata" | "files" | "search" | "coding" | "git" | "package" | "process" | "codex" | "screen" | "batch";
+export interface WorkspaceOperationRegistryEntry extends WorkspaceOperationCatalogEntry {
+    name: WorkspaceOperationName;
+    category: WorkspaceOperationCategory;
+    boundary: WorkspaceOperationBoundary;
+    schema: WorkspaceOperationSchema;
+    run: WorkspaceOperationRunRegistration;
+    audit: WorkspaceOperationAuditRegistration;
+    safetyNote: string;
+    capabilities: CapabilityName[];
+    limits?: Partial<CapabilityPolicy["limits"]>;
+}
+export interface PublicWorkspaceOperationRunRegistration {
+    type: WorkspaceOperationRunRegistration["type"];
+    handler: WorkspaceOperationRunRegistration["handler"];
+}
+export type PublicWorkspaceOperationRegistryEntry = Omit<WorkspaceOperationRegistryEntry, "run"> & {
+    run: PublicWorkspaceOperationRunRegistration;
+};
+export interface WorkspaceOperationContract {
+    version: 1;
+    mcp: {
+        tool: "workspace_operation";
+        requiredFields: ["workspaceId", "op"];
+    };
+    jsonApi: {
+        endpoint: "POST /api/v1/control";
+        action: "operation";
+        requiredFields: ["action", "workspace", "op"];
+    };
+    envelope: {
+        workspace: string;
+        op: WorkspaceOperationName;
+        target?: string;
+        input: Record<string, unknown>;
+        options: Record<string, unknown>;
+    };
+    targetMapping: Record<string, string>;
+    guidance: string[];
+}
+export interface WorkspaceOperationRegistrationInput {
+    name: WorkspaceOperationName;
+    category: WorkspaceOperationCategory;
+    permission: WorkspaceOperationCatalogEntry["permission"];
+    boundary: WorkspaceOperationBoundary;
+    schema: WorkspaceOperationSchema;
+    run: WorkspaceOperationRunRegistration;
+    audit: WorkspaceOperationAuditRegistration;
+    description: string;
+    safetyNote: string;
+    capabilities: CapabilityName[];
+    limits?: Partial<CapabilityPolicy["limits"]>;
+}
+export declare function registerOperation(input: WorkspaceOperationRegistrationInput): WorkspaceOperationRegistryEntry;
+export declare function buildWorkspaceOperationRegistry(catalog?: readonly WorkspaceOperationCatalogEntry[]): WorkspaceOperationRegistryEntry[];
+export declare const workspaceOperationRegistry: WorkspaceOperationRegistryEntry[];
+export declare function publicWorkspaceOperationRegistry(registry?: readonly WorkspaceOperationRegistryEntry[]): PublicWorkspaceOperationRegistryEntry[];
+export declare const workspaceOperationContract: WorkspaceOperationContract;
+export declare const workspaceOperationRegistryByName: Map<"read" | "write" | "codex" | "stat" | "list" | "list_details" | "explain_operation" | "tree" | "instructions" | "agent_skills" | "coding_context" | "project_overview" | "history" | "history_insight" | "change_summary" | "repo_status" | "git_changes" | "git_diff" | "git_log" | "git_show" | "git_stage" | "git_unstage" | "git_commit" | "git_worktree_list" | "git_worktree_create" | "read_many" | "create_file" | "write_if_unchanged" | "edit" | "patch" | "mkdir" | "delete" | "move" | "find_files" | "search_text" | "search_symbols" | "package_run" | "package_start" | "command" | "process_start" | "process_list" | "process_read" | "process_stop" | "codex_start" | "codex_plan" | "codex_review" | "codex_fix" | "codex_test" | "codex_continue" | "codex_runs" | "screen_list" | "screen_capture" | "screen_capture_window" | "screen_capture_process" | "batch", WorkspaceOperationRegistryEntry>;
+export declare function workspaceOperationEntry(operation: WorkspaceOperationName): WorkspaceOperationRegistryEntry;
+export declare function allowedWorkspaceOperations(permissions: PathPermissions): WorkspaceOperationName[];
+export declare function normalizeWorkspaceOperationInput(body: Record<string, unknown>): WorkspaceOperationInput;
+export declare function runWorkspaceOperation(registry: WorkspaceRegistry, workspace: Workspace, input: WorkspaceOperationInput): Promise<unknown>;
+export declare function workspaceOperationAuditFields(input: WorkspaceOperationInput): Partial<AuditEventInput>;