@agent-api/sdk 1.0.6 → 1.1.0

package/dist/local/core.d.ts

@@ -0,0 +1,382 @@
+import type { LocalSkillDirectoryOptions } from "../local-skills.js";
+import type { LocalSkillDescriptor } from "../types/skills.js";
+export interface LocalAppDirs {
+    home: string;
+    data: string;
+    config: string;
+    cache: string;
+    logs: string;
+    temp: string;
+}
+export interface LocalRuntimeOptions {
+    appName: string;
+    appAuthor?: string;
+    baseDir?: string;
+    dirs?: Partial<Omit<LocalAppDirs, "home">>;
+    env?: Record<string, string | undefined>;
+    platform?: NodeJS.Platform;
+}
+export interface LocalFileStoreOptions {
+    label?: string;
+}
+export declare class LocalError extends Error {
+    readonly code: string;
+    readonly path?: string;
+    constructor(code: string, message: string, options?: {
+        path?: string;
+        cause?: unknown;
+    });
+}
+export declare class LocalPathError extends LocalError {
+    constructor(message: string, path?: string);
+}
+export declare class LocalIgnoredPathError extends LocalError {
+    constructor(path: string);
+}
+export declare class LocalFileTooLargeError extends LocalError {
+    constructor(path: string);
+}
+export declare class LocalNotTextFileError extends LocalError {
+    constructor(path: string);
+}
+export declare class LocalConfigError extends LocalError {
+    constructor(message: string, path?: string);
+}
+export type LocalFileType = "file" | "directory" | "symlink" | "other";
+export interface LocalFileStat {
+    path: string;
+    fullPath: string;
+    type: LocalFileType;
+    size: number;
+    modifiedAt: Date;
+}
+export interface LocalListOptions {
+    recursive?: boolean;
+    includeDirectories?: boolean;
+    maxDepth?: number;
+    ignore?: Array<string | RegExp | ((relativePath: string) => boolean)>;
+}
+export type LocalIgnoreRule = NonNullable<LocalListOptions["ignore"]>[number];
+export interface LocalEntry {
+    path: string;
+    is_dir: boolean;
+    size: number;
+    modified_at_unix?: number;
+}
+export interface LocalEntryList {
+    object: "list";
+    entries: LocalEntry[];
+}
+export interface LocalSearchEntriesParams {
+    query: string;
+    path?: string;
+    limit?: number;
+}
+export interface LocalReadFileParams {
+    maxBytes?: number;
+    format?: "text";
+}
+export interface LocalReadFileRawParams {
+    maxBytes?: number;
+    format: "raw";
+}
+export interface LocalFileDeliver {
+    path: string;
+    encoding: "text" | "base64";
+    mime_type: string;
+    size: number;
+    truncated: boolean;
+    content?: string;
+    content_base64?: string;
+}
+export interface LocalFileRaw {
+    path: string;
+    size: number;
+    truncated: boolean;
+    content: Uint8Array;
+    content_type?: string;
+}
+export interface LocalFileWrite {
+    path: string;
+    size: number;
+}
+export interface LocalPathDelete {
+    path: string;
+    recursive: boolean;
+}
+export interface LocalReadLinesParams {
+    startLine: number;
+    endLine?: number;
+    maxBytes?: number;
+}
+export interface LocalFileLines {
+    path: string;
+    start_line: number;
+    end_line: number;
+    total_lines: number;
+    lines: string[];
+    file_truncated: boolean;
+    size: number;
+}
+export interface LocalPatchLinesParams {
+    startLine: number;
+    endLine?: number;
+    replacement?: string;
+    maxBytes?: number;
+}
+export interface LocalFileLinesPatch {
+    path: string;
+    start_line: number;
+    end_line: number;
+    total_lines: number;
+    size: number;
+}
+export interface LocalGrepParams {
+    pattern: string;
+    path?: string;
+    limit?: number;
+    maxFiles?: number;
+    maxBytesPerFile?: number;
+    maxLineLength?: number;
+    ignore?: LocalListOptions["ignore"];
+}
+export interface LocalGrepMatch {
+    path: string;
+    line_number: number;
+    line: string;
+}
+export interface LocalGrepResponse {
+    object: "list";
+    matches: LocalGrepMatch[];
+    files_scanned: number;
+    scan_truncated: boolean;
+}
+export interface LocalSummarizeParams {
+    path?: string;
+    maxFiles?: number;
+    maxPreviews?: number;
+    previewBytes?: number;
+    topPaths?: number;
+    ignore?: LocalListOptions["ignore"];
+}
+export interface LocalSummaryPreview {
+    path: string;
+    size: number;
+    preview: string;
+    preview_truncated?: boolean;
+}
+export interface LocalSummary {
+    summary_path: string;
+    file_count: number;
+    total_bytes: number;
+    top_paths_by_size: string[];
+    text_previews: LocalSummaryPreview[];
+    generated_at_unix: number;
+    scan_truncated: boolean;
+}
+export interface LocalWorkspaceOptions {
+    name?: string;
+    metadata?: Record<string, unknown>;
+    trusted?: boolean;
+    ignore?: LocalIgnoreRule[];
+    gitignore?: boolean;
+    maxFileBytes?: number;
+}
+export interface LocalWorkspaceSnapshotParams {
+    path?: string;
+    hash?: boolean;
+    maxBytesPerFile?: number;
+}
+export interface LocalWorkspaceSnapshotFile {
+    path: string;
+    size: number;
+    modified_at_unix?: number;
+    sha256?: string;
+}
+export interface LocalWorkspaceSnapshot {
+    root: string;
+    name: string;
+    generated_at_unix: number;
+    files: LocalWorkspaceSnapshotFile[];
+}
+export interface LocalWorkspaceDiff {
+    added: LocalWorkspaceSnapshotFile[];
+    modified: Array<{
+        before: LocalWorkspaceSnapshotFile;
+        after: LocalWorkspaceSnapshotFile;
+    }>;
+    deleted: LocalWorkspaceSnapshotFile[];
+    unchanged: LocalWorkspaceSnapshotFile[];
+}
+export interface LocalLinePatchPreview {
+    path: string;
+    start_line: number;
+    end_line: number;
+    total_lines: number;
+    before: string[];
+    after: string[];
+}
+export interface LocalWorkspaceLineEdit {
+    path: string;
+    startLine: number;
+    endLine?: number;
+    replacement?: string;
+    expectedSha256?: string;
+}
+export interface LocalWorkspaceEditPlan {
+    edits: LocalWorkspaceLineEdit[];
+    previews: LocalLinePatchPreview[];
+}
+export interface LocalWorkspaceEditResult {
+    applied: LocalFileLinesPatch[];
+    backups: Array<{
+        path: string;
+        content: string;
+    }>;
+}
+export type LocalPathSensitivity = "normal" | "sensitive" | "secret";
+export interface LocalPathSensitivityInfo {
+    path: string;
+    sensitivity: LocalPathSensitivity;
+    reason?: string;
+}
+export interface LocalWorkspaceWatchEvent {
+    type: "change" | "rename";
+    path: string;
+}
+export interface LocalWorkspaceWatcher {
+    close(): void;
+}
+export interface LocalSkillDiscoveryOptions extends LocalSkillDirectoryOptions {
+    roots?: string[];
+    recursive?: boolean;
+    maxDepth?: number;
+}
+export interface LocalRuntime {
+    appName: string;
+    dirs: LocalAppDirs;
+    files: LocalFileStore;
+    data: LocalFileStore;
+    cache: LocalFileStore;
+    logs: LocalFileStore;
+    temp: LocalFileStore;
+    config: LocalConfigStore;
+    skills: LocalSkillStore;
+    workspaces: LocalWorkspaceManager;
+    workspace(root: string, options?: LocalWorkspaceOptions): LocalWorkspace;
+    ensure(): Promise<void>;
+}
+export declare function createLocalRuntime(options: LocalRuntimeOptions): LocalRuntime;
+export declare function localAppDirs(options: LocalRuntimeOptions): LocalAppDirs;
+export declare class LocalFileStore {
+    readonly root: string;
+    readonly label: string;
+    constructor(root: string, options?: LocalFileStoreOptions);
+    child(relativePath: string, options?: LocalFileStoreOptions): LocalFileStore;
+    ensure(): Promise<void>;
+    resolvePath(relativePath?: string): string;
+    relativePath(fullPath: string): string;
+    exists(relativePath?: string): Promise<boolean>;
+    stat(relativePath?: string): Promise<LocalFileStat>;
+    mkdir(relativePath?: string): Promise<string>;
+    list(relativePath?: string, options?: LocalListOptions): Promise<LocalFileStat[]>;
+    listEntries(relativePath?: string, options?: LocalListOptions): Promise<LocalEntryList>;
+    searchEntries(params: LocalSearchEntriesParams): Promise<LocalEntryList>;
+    readText(relativePath: string): Promise<string>;
+    readJSON<T = unknown>(relativePath: string): Promise<T>;
+    readBytes(relativePath: string): Promise<Uint8Array>;
+    readFile(relativePath: string, params: LocalReadFileRawParams): Promise<LocalFileRaw>;
+    readFile(relativePath: string, params?: LocalReadFileParams): Promise<LocalFileDeliver>;
+    writeText(relativePath: string, content: string, options?: {
+        atomic?: boolean;
+    }): Promise<string>;
+    writeJSON(relativePath: string, value: unknown, options?: {
+        pretty?: boolean;
+        atomic?: boolean;
+    }): Promise<string>;
+    writeBytes(relativePath: string, content: Uint8Array, options?: {
+        atomic?: boolean;
+    }): Promise<string>;
+    writeFile(relativePath: string, content: string | Uint8Array, options?: {
+        atomic?: boolean;
+    }): Promise<LocalFileWrite>;
+    remove(relativePath: string): Promise<void>;
+    deletePath(relativePath: string): Promise<LocalPathDelete>;
+    createDirectory(relativePath?: string): Promise<{
+        path: string;
+    }>;
+    copy(fromRelativePath: string, toRelativePath: string): Promise<string>;
+    readLines(relativePath: string, params: LocalReadLinesParams): Promise<LocalFileLines>;
+    patchLines(relativePath: string, params: LocalPatchLinesParams): Promise<LocalFileLinesPatch>;
+    grep(params: LocalGrepParams): Promise<LocalGrepResponse>;
+    summarize(params?: LocalSummarizeParams): Promise<LocalSummary>;
+    private walk;
+}
+export declare class LocalConfigStore {
+    readonly files: LocalFileStore;
+    constructor(files: LocalFileStore);
+    read<T = Record<string, unknown>>(name?: string, fallback?: T): Promise<T>;
+    write(name: string, value: unknown): Promise<string>;
+    get<T = unknown>(name: string, key: string, fallback?: T): Promise<T>;
+    set(name: string, key: string, value: unknown): Promise<string>;
+    delete(name: string, key: string): Promise<string>;
+    private readRecord;
+}
+export declare class LocalWorkspaceManager {
+    open(root: string, options?: LocalWorkspaceOptions): LocalWorkspace;
+}
+export declare class LocalWorkspace {
+    readonly root: string;
+    readonly name: string;
+    readonly metadata: Record<string, unknown>;
+    readonly trusted: boolean;
+    readonly files: LocalFileStore;
+    readonly ignore: LocalIgnoreRule[];
+    readonly gitignore: boolean;
+    readonly maxFileBytes: number;
+    constructor(root: string, options?: LocalWorkspaceOptions);
+    ensure(): Promise<void>;
+    loadIgnoreFiles(files?: string[]): Promise<LocalIgnoreRule[]>;
+    child(relativePath: string, options?: LocalWorkspaceOptions): LocalWorkspace;
+    resolvePath(relativePath?: string): string;
+    list(relativePath?: string, options?: LocalListOptions): Promise<LocalFileStat[]>;
+    listEntries(relativePath?: string, options?: LocalListOptions): Promise<LocalEntryList>;
+    searchEntries(params: LocalSearchEntriesParams): Promise<LocalEntryList>;
+    readFile(relativePath: string, params: LocalReadFileRawParams): Promise<LocalFileRaw>;
+    readFile(relativePath: string, params?: LocalReadFileParams): Promise<LocalFileDeliver>;
+    writeFile(relativePath: string, content: string | Uint8Array, options?: {
+        atomic?: boolean;
+    }): Promise<LocalFileWrite>;
+    readText(relativePath: string): Promise<string>;
+    writeText(relativePath: string, content: string, options?: {
+        atomic?: boolean;
+    }): Promise<string>;
+    deletePath(relativePath: string): Promise<LocalPathDelete>;
+    createDirectory(relativePath?: string): Promise<{
+        path: string;
+    }>;
+    readLines(relativePath: string, params: LocalReadLinesParams): Promise<LocalFileLines>;
+    previewPatchLines(relativePath: string, params: LocalPatchLinesParams): Promise<LocalLinePatchPreview>;
+    patchLines(relativePath: string, params: LocalPatchLinesParams): Promise<LocalFileLinesPatch>;
+    previewEdits(edits: LocalWorkspaceLineEdit[]): Promise<LocalWorkspaceEditPlan>;
+    applyEdits(edits: LocalWorkspaceLineEdit[]): Promise<LocalWorkspaceEditResult>;
+    classifyPath(relativePath: string): LocalPathSensitivityInfo;
+    grep(params: LocalGrepParams): Promise<LocalGrepResponse>;
+    summarize(params?: LocalSummarizeParams): Promise<LocalSummary>;
+    snapshot(params?: LocalWorkspaceSnapshotParams): Promise<LocalWorkspaceSnapshot>;
+    diff(before: LocalWorkspaceSnapshot, after: LocalWorkspaceSnapshot): LocalWorkspaceDiff;
+    watch(onEvent: (event: LocalWorkspaceWatchEvent) => void, options?: {
+        recursive?: boolean;
+    }): LocalWorkspaceWatcher;
+    private scopedListOptions;
+    private mergeIgnore;
+    private assertAllowed;
+    private assertExpectedHash;
+}
+export declare class LocalSkillStore {
+    readonly files: LocalFileStore;
+    constructor(files: LocalFileStore);
+    fromDirectory(rootDir: string, options?: LocalSkillDirectoryOptions): Promise<LocalSkillDescriptor>;
+    discover(options?: LocalSkillDiscoveryOptions): Promise<LocalSkillDescriptor[]>;
+}
+export declare function classifyLocalPathSensitivity(relativePath: string): LocalPathSensitivityInfo;