@aigne/afs-git 1.0.0

package/lib/dts/index.d.ts

@@ -0,0 +1,129 @@
+import type { AFSAccessMode, AFSDeleteOptions, AFSDeleteResult, AFSListOptions, AFSListResult, AFSModule, AFSModuleLoadParams, AFSReadOptions, AFSReadResult, AFSRenameOptions, AFSSearchOptions, AFSSearchResult, AFSWriteEntryPayload, AFSWriteOptions, AFSWriteResult } from "@aigne/afs";
+import { z } from "zod";
+export interface AFSGitOptions {
+    name?: string;
+    repoPath: string;
+    description?: string;
+    branches?: string[];
+    /**
+     * Access mode for this module.
+     * - "readonly": Only read operations are allowed, uses git commands (no worktree)
+     * - "readwrite": All operations are allowed, creates worktrees as needed
+     * @default "readonly"
+     */
+    accessMode?: AFSAccessMode;
+    /**
+     * Automatically commit changes after write operations
+     * @default false
+     */
+    autoCommit?: boolean;
+    /**
+     * Author information for commits when autoCommit is enabled
+     */
+    commitAuthor?: {
+        name: string;
+        email: string;
+    };
+}
+export declare class AFSGit implements AFSModule {
+    options: AFSGitOptions & {
+        cwd?: string;
+    };
+    static schema(): z.ZodObject<{
+        name: z.ZodType<string | undefined, z.ZodTypeDef, string | undefined>;
+        repoPath: z.ZodString;
+        description: z.ZodType<string | undefined, z.ZodTypeDef, string | undefined>;
+        branches: z.ZodType<string[] | undefined, z.ZodTypeDef, string[] | undefined>;
+        accessMode: z.ZodType<"readonly" | "readwrite" | undefined, z.ZodTypeDef, "readonly" | "readwrite" | undefined>;
+        autoCommit: z.ZodType<boolean | undefined, z.ZodTypeDef, boolean | undefined>;
+        commitAuthor: z.ZodType<{
+            name: string;
+            email: string;
+        } | undefined, z.ZodTypeDef, {
+            name: string;
+            email: string;
+        } | undefined>;
+    }, "strip", z.ZodTypeAny, {
+        repoPath: string;
+        name?: string | undefined;
+        description?: string | undefined;
+        branches?: string[] | undefined;
+        accessMode?: "readonly" | "readwrite" | undefined;
+        autoCommit?: boolean | undefined;
+        commitAuthor?: {
+            name: string;
+            email: string;
+        } | undefined;
+    }, {
+        repoPath: string;
+        name?: string | undefined;
+        description?: string | undefined;
+        branches?: string[] | undefined;
+        accessMode?: "readonly" | "readwrite" | undefined;
+        autoCommit?: boolean | undefined;
+        commitAuthor?: {
+            name: string;
+            email: string;
+        } | undefined;
+    }>;
+    static load({ filepath, parsed }: AFSModuleLoadParams): Promise<AFSGit>;
+    private git;
+    private tempBase;
+    private worktrees;
+    private repoHash;
+    constructor(options: AFSGitOptions & {
+        cwd?: string;
+    });
+    name: string;
+    description?: string;
+    accessMode: AFSAccessMode;
+    /**
+     * Parse AFS path into branch and file path
+     * Branch names may contain slashes and are encoded with ~ in paths
+     * Examples:
+     *   "/" -> { branch: undefined, filePath: "" }
+     *   "/main" -> { branch: "main", filePath: "" }
+     *   "/feature~new-feature" -> { branch: "feature/new-feature", filePath: "" }
+     *   "/main/src/index.ts" -> { branch: "main", filePath: "src/index.ts" }
+     */
+    private parsePath;
+    /**
+     * Detect MIME type based on file extension
+     */
+    private getMimeType;
+    /**
+     * Check if file is likely binary based on extension
+     */
+    private isBinaryFile;
+    /**
+     * Get list of available branches
+     */
+    private getBranches;
+    /**
+     * Ensure worktree exists for a branch (lazy creation)
+     */
+    private ensureWorktree;
+    /**
+     * List files using git ls-tree (no worktree needed)
+     */
+    private listWithGitLsTree;
+    /**
+     * Build AFS path with encoded branch name
+     * Branch names with slashes are encoded by replacing / with ~
+     * @param branch Branch name (may contain slashes)
+     * @param filePath File path within branch
+     */
+    private buildPath;
+    list(path: string, options?: AFSListOptions): Promise<AFSListResult>;
+    read(path: string, _options?: AFSReadOptions): Promise<AFSReadResult>;
+    write(path: string, entry: AFSWriteEntryPayload, options?: AFSWriteOptions): Promise<AFSWriteResult>;
+    delete(path: string, options?: AFSDeleteOptions): Promise<AFSDeleteResult>;
+    rename(oldPath: string, newPath: string, options?: AFSRenameOptions): Promise<{
+        message?: string;
+    }>;
+    search(path: string, query: string, options?: AFSSearchOptions): Promise<AFSSearchResult>;
+    /**
+     * Cleanup all worktrees (useful when unmounting)
+     */
+    cleanup(): Promise<void>;
+}

package/lib/esm/index.d.ts

@@ -0,0 +1,129 @@
+import type { AFSAccessMode, AFSDeleteOptions, AFSDeleteResult, AFSListOptions, AFSListResult, AFSModule, AFSModuleLoadParams, AFSReadOptions, AFSReadResult, AFSRenameOptions, AFSSearchOptions, AFSSearchResult, AFSWriteEntryPayload, AFSWriteOptions, AFSWriteResult } from "@aigne/afs";
+import { z } from "zod";
+export interface AFSGitOptions {
+    name?: string;
+    repoPath: string;
+    description?: string;
+    branches?: string[];
+    /**
+     * Access mode for this module.
+     * - "readonly": Only read operations are allowed, uses git commands (no worktree)
+     * - "readwrite": All operations are allowed, creates worktrees as needed
+     * @default "readonly"
+     */
+    accessMode?: AFSAccessMode;
+    /**
+     * Automatically commit changes after write operations
+     * @default false
+     */
+    autoCommit?: boolean;
+    /**
+     * Author information for commits when autoCommit is enabled
+     */
+    commitAuthor?: {
+        name: string;
+        email: string;
+    };
+}
+export declare class AFSGit implements AFSModule {
+    options: AFSGitOptions & {
+        cwd?: string;
+    };
+    static schema(): z.ZodObject<{
+        name: z.ZodType<string | undefined, z.ZodTypeDef, string | undefined>;
+        repoPath: z.ZodString;
+        description: z.ZodType<string | undefined, z.ZodTypeDef, string | undefined>;
+        branches: z.ZodType<string[] | undefined, z.ZodTypeDef, string[] | undefined>;
+        accessMode: z.ZodType<"readonly" | "readwrite" | undefined, z.ZodTypeDef, "readonly" | "readwrite" | undefined>;
+        autoCommit: z.ZodType<boolean | undefined, z.ZodTypeDef, boolean | undefined>;
+        commitAuthor: z.ZodType<{
+            name: string;
+            email: string;
+        } | undefined, z.ZodTypeDef, {
+            name: string;
+            email: string;
+        } | undefined>;
+    }, "strip", z.ZodTypeAny, {
+        repoPath: string;
+        name?: string | undefined;
+        description?: string | undefined;
+        branches?: string[] | undefined;
+        accessMode?: "readonly" | "readwrite" | undefined;
+        autoCommit?: boolean | undefined;
+        commitAuthor?: {
+            name: string;
+            email: string;
+        } | undefined;
+    }, {
+        repoPath: string;
+        name?: string | undefined;
+        description?: string | undefined;
+        branches?: string[] | undefined;
+        accessMode?: "readonly" | "readwrite" | undefined;
+        autoCommit?: boolean | undefined;
+        commitAuthor?: {
+            name: string;
+            email: string;
+        } | undefined;
+    }>;
+    static load({ filepath, parsed }: AFSModuleLoadParams): Promise<AFSGit>;
+    private git;
+    private tempBase;
+    private worktrees;
+    private repoHash;
+    constructor(options: AFSGitOptions & {
+        cwd?: string;
+    });
+    name: string;
+    description?: string;
+    accessMode: AFSAccessMode;
+    /**
+     * Parse AFS path into branch and file path
+     * Branch names may contain slashes and are encoded with ~ in paths
+     * Examples:
+     *   "/" -> { branch: undefined, filePath: "" }
+     *   "/main" -> { branch: "main", filePath: "" }
+     *   "/feature~new-feature" -> { branch: "feature/new-feature", filePath: "" }
+     *   "/main/src/index.ts" -> { branch: "main", filePath: "src/index.ts" }
+     */
+    private parsePath;
+    /**
+     * Detect MIME type based on file extension
+     */
+    private getMimeType;
+    /**
+     * Check if file is likely binary based on extension
+     */
+    private isBinaryFile;
+    /**
+     * Get list of available branches
+     */
+    private getBranches;
+    /**
+     * Ensure worktree exists for a branch (lazy creation)
+     */
+    private ensureWorktree;
+    /**
+     * List files using git ls-tree (no worktree needed)
+     */
+    private listWithGitLsTree;
+    /**
+     * Build AFS path with encoded branch name
+     * Branch names with slashes are encoded by replacing / with ~
+     * @param branch Branch name (may contain slashes)
+     * @param filePath File path within branch
+     */
+    private buildPath;
+    list(path: string, options?: AFSListOptions): Promise<AFSListResult>;
+    read(path: string, _options?: AFSReadOptions): Promise<AFSReadResult>;
+    write(path: string, entry: AFSWriteEntryPayload, options?: AFSWriteOptions): Promise<AFSWriteResult>;
+    delete(path: string, options?: AFSDeleteOptions): Promise<AFSDeleteResult>;
+    rename(oldPath: string, newPath: string, options?: AFSRenameOptions): Promise<{
+        message?: string;
+    }>;
+    search(path: string, query: string, options?: AFSSearchOptions): Promise<AFSSearchResult>;
+    /**
+     * Cleanup all worktrees (useful when unmounting)
+     */
+    cleanup(): Promise<void>;
+}