gitx.do 0.0.3 → 0.1.1

package/dist/cli/fsx-cli-adapter.d.ts

@@ -0,0 +1,359 @@
+/**
+ * @fileoverview FSx CLI Adapter for Git Repository Operations
+ *
+ * This module provides a CLI adapter that uses the FSxStorageAdapter for Git
+ * repository operations. It bridges the CLI interface (FSAdapter-compatible)
+ * with the fsx-backed storage, allowing the CLI to work with any fsx storage.
+ *
+ * **Features**:
+ * - Compatible with FSAdapter interface from fs-adapter.ts
+ * - Uses FSxStorageAdapter for underlying storage operations
+ * - Provides object retrieval, ref resolution, and listing operations
+ * - Handles both loose objects and references
+ *
+ * **Note**: Pack file operations are not implemented as fsx uses CAS storage.
+ * For pack file reading, use the standard fs-adapter.ts instead.
+ *
+ * @module cli/fsx-cli-adapter
+ *
+ * @example
+ * ```typescript
+ * import { createFSxCLIAdapter } from './fsx-cli-adapter'
+ *
+ * const adapter = await createFSxCLIAdapter('/path/to/repo')
+ * const head = await adapter.getHead()
+ * const commit = await adapter.getObject(head.target)
+ * ```
+ */
+import type { ObjectType } from '../types/objects';
+/**
+ * Type of git reference.
+ */
+export type FSRefType = 'direct' | 'symbolic';
+/**
+ * A git reference.
+ */
+export interface FSRef {
+    /** Full ref name (e.g., 'refs/heads/main') */
+    name: string;
+    /** Target - SHA (direct) or ref name (symbolic) */
+    target: string;
+    /** Type of reference */
+    type: FSRefType;
+}
+/**
+ * A stored git object with metadata.
+ */
+export interface FSObject {
+    /** SHA-1 hash of the object */
+    sha: string;
+    /** Object type: blob, tree, commit, tag */
+    type: ObjectType;
+    /** Size of the object data in bytes */
+    size: number;
+    /** Raw object data (uncompressed) */
+    data: Uint8Array;
+    /** Source location: 'loose' or 'pack' */
+    source: 'loose' | 'pack';
+    /** If from a pack, the pack file name */
+    packFile?: string;
+}
+/**
+ * Resolved reference with SHA.
+ */
+export interface FSResolvedRef {
+    /** The original ref */
+    ref: FSRef;
+    /** Final SHA after resolving symbolic refs */
+    sha: string;
+    /** Chain of refs followed */
+    chain: FSRef[];
+}
+/**
+ * A single entry in the git index (staging area).
+ */
+export interface IndexEntry {
+    /** File path relative to repo root */
+    path: string;
+    /** SHA of the blob */
+    sha: string;
+    /** File mode */
+    mode: number;
+    /** File size */
+    size: number;
+    /** Modification time */
+    mtime: Date;
+    /** Creation time */
+    ctime: Date;
+    /** Stage number (0 for normal, 1-3 for conflicts) */
+    stage: number;
+    /** Various flags */
+    flags: {
+        assumeValid: boolean;
+        extended: boolean;
+        skipWorktree: boolean;
+        intentToAdd: boolean;
+    };
+}
+/**
+ * Tree entry from a tree object.
+ */
+export interface TreeEntry {
+    /** File/directory mode */
+    mode: number;
+    /** Name of the entry */
+    name: string;
+    /** SHA-1 hash of the referenced object */
+    sha: string;
+    /** Whether this is a tree (directory) or blob (file) */
+    type: 'tree' | 'blob';
+}
+/**
+ * Parsed commit object.
+ */
+export interface ParsedCommit {
+    /** Tree SHA referenced by this commit */
+    tree: string;
+    /** Parent commit SHAs */
+    parents: string[];
+    /** Author information */
+    author: {
+        name: string;
+        email: string;
+        timestamp: number;
+        timezone: string;
+    };
+    /** Committer information */
+    committer: {
+        name: string;
+        email: string;
+        timestamp: number;
+        timezone: string;
+    };
+    /** Commit message */
+    message: string;
+    /** GPG signature if present */
+    gpgSig?: string;
+}
+/**
+ * Error codes for FSx CLI adapter operations.
+ */
+export type FSxCLIAdapterErrorCode = 'NOT_A_GIT_REPO' | 'OBJECT_NOT_FOUND' | 'REF_NOT_FOUND' | 'CORRUPT_OBJECT' | 'INVALID_SHA' | 'READ_ERROR' | 'NOT_IMPLEMENTED';
+/**
+ * Error thrown by FSx CLI adapter operations.
+ */
+export declare class FSxCLIAdapterError extends Error {
+    readonly code: FSxCLIAdapterErrorCode;
+    readonly path?: string | undefined;
+    constructor(message: string, code: FSxCLIAdapterErrorCode, path?: string | undefined);
+}
+/**
+ * CLI adapter that uses fsx for Git repository operations.
+ *
+ * @description
+ * This adapter wraps FSxStorageAdapter to provide a CLI-friendly interface
+ * compatible with the FSAdapter interface from fs-adapter.ts. It allows
+ * the CLI to work with any fsx-backed storage.
+ *
+ * @example
+ * ```typescript
+ * const adapter = await createFSxCLIAdapter('/path/to/repo')
+ *
+ * // Get HEAD reference
+ * const head = await adapter.getHead()
+ *
+ * // Resolve to SHA
+ * const resolved = await adapter.resolveRef('HEAD')
+ * console.log(`Current commit: ${resolved.sha}`)
+ *
+ * // Get commit object
+ * const commit = await adapter.getCommit(resolved.sha)
+ * console.log(`Message: ${commit.message}`)
+ * ```
+ */
+export declare class FSxCLIAdapter {
+    private backend;
+    private gitDir;
+    private repoPath;
+    /**
+     * Create a new FSxCLIAdapter.
+     *
+     * @param repoPath - Path to the repository root
+     * @param options - Optional configuration
+     */
+    constructor(repoPath: string, options?: {
+        gitDir?: string;
+    });
+    /**
+     * Get a git object by its SHA.
+     *
+     * @param sha - 40-character SHA-1 hash
+     * @returns The object if found, null otherwise
+     */
+    getObject(sha: string): Promise<FSObject | null>;
+    /**
+     * Check if an object exists.
+     *
+     * @param sha - 40-character SHA-1 hash
+     * @returns true if the object exists
+     */
+    hasObject(sha: string): Promise<boolean>;
+    /**
+     * Get object type without loading full data.
+     *
+     * @param sha - 40-character SHA-1 hash
+     * @returns The object type if found, null otherwise
+     */
+    getObjectType(sha: string): Promise<ObjectType | null>;
+    /**
+     * Get object size without loading full data.
+     *
+     * @param sha - 40-character SHA-1 hash
+     * @returns The object size in bytes if found, null otherwise
+     */
+    getObjectSize(sha: string): Promise<number | null>;
+    /**
+     * Read a blob object's content.
+     *
+     * @param sha - 40-character SHA-1 hash of a blob
+     * @returns The blob content as Uint8Array
+     */
+    readBlob(sha: string): Promise<Uint8Array>;
+    /**
+     * Read a tree object's entries.
+     *
+     * @param sha - 40-character SHA-1 hash of a tree
+     * @returns Array of tree entries
+     */
+    readTree(sha: string): Promise<TreeEntry[]>;
+    /**
+     * Get a parsed commit object.
+     *
+     * @param sha - 40-character SHA-1 hash of a commit
+     * @returns Parsed commit object
+     */
+    getCommit(sha: string): Promise<ParsedCommit>;
+    /**
+     * Get HEAD reference.
+     *
+     * @returns HEAD reference (symbolic or direct), or null if not found
+     */
+    getHead(): Promise<FSRef | null>;
+    /**
+     * Get a reference by name.
+     *
+     * @param name - Full ref name (e.g., 'refs/heads/main', 'HEAD')
+     * @returns The ref if found, null otherwise
+     */
+    getRef(name: string): Promise<FSRef | null>;
+    /**
+     * Resolve a reference to its final SHA.
+     *
+     * @param name - Ref name to resolve
+     * @returns Resolved ref with SHA and resolution chain, or null if not found
+     */
+    resolveRef(name: string): Promise<FSResolvedRef | null>;
+    /**
+     * Check if HEAD is detached (pointing directly to a SHA).
+     *
+     * @returns true if HEAD points directly to a SHA
+     */
+    isHeadDetached(): Promise<boolean>;
+    /**
+     * List all branches.
+     *
+     * @returns Array of branch names (without 'refs/heads/' prefix)
+     */
+    listBranches(): Promise<string[]>;
+    /**
+     * List all tags.
+     *
+     * @returns Array of tag names (without 'refs/tags/' prefix)
+     */
+    listTags(): Promise<string[]>;
+    /**
+     * List all refs matching an optional prefix.
+     *
+     * @param prefix - Optional prefix to filter refs
+     * @returns Array of refs
+     */
+    listRefs(prefix?: string): Promise<FSRef[]>;
+    /**
+     * Get the repository path.
+     */
+    getRepoPath(): string;
+    /**
+     * Get the git directory path.
+     */
+    getGitDir(): string;
+    /**
+     * Check if this is a valid git repository.
+     *
+     * @returns true if valid git repository structure exists
+     */
+    isGitRepository(): Promise<boolean>;
+    /**
+     * Get repository description.
+     *
+     * @returns Contents of .git/description file, or null
+     */
+    getDescription(): Promise<string | null>;
+    /**
+     * Get index entries.
+     *
+     * @description Index operations are not implemented in the fsx adapter.
+     * Use the standard fs-adapter for index operations.
+     */
+    getIndexEntries(): Promise<IndexEntry[]>;
+    /**
+     * List pack files.
+     *
+     * @description Pack file operations are not implemented in the fsx adapter.
+     * fsx uses CAS storage instead of pack files.
+     */
+    listPackFiles(): Promise<string[]>;
+}
+/**
+ * Check if a directory is a git repository.
+ *
+ * @description Validates whether the given path is a valid git repository
+ * by checking for the presence of .git directory and required git files.
+ *
+ * @param repoPath - Path to check
+ * @returns true if the path is a valid git repository
+ *
+ * @example
+ * ```typescript
+ * if (await isGitRepository('/path/to/repo')) {
+ *   console.log('Valid git repository')
+ * }
+ * ```
+ */
+export declare function isGitRepository(repoPath: string): Promise<boolean>;
+/**
+ * Create an FSx CLI adapter for a local git repository.
+ *
+ * @description Factory function that creates an FSxCLIAdapter for a git repository.
+ * Uses fsx storage backend for all operations.
+ *
+ * @param repoPath - Path to the repository root
+ * @param options - Optional configuration
+ * @returns A fully initialized FSxCLIAdapter instance
+ *
+ * @throws {FSxCLIAdapterError} With code 'NOT_A_GIT_REPO' if the path is not a valid git repository
+ *
+ * @example
+ * ```typescript
+ * // Create adapter for a regular repository
+ * const adapter = await createFSxCLIAdapter('/path/to/repo')
+ *
+ * // Create adapter with custom git directory
+ * const adapter = await createFSxCLIAdapter('/path/to/repo', {
+ *   gitDir: '/path/to/custom/.git'
+ * })
+ * ```
+ */
+export declare function createFSxCLIAdapter(repoPath: string, options?: {
+    gitDir?: string;
+}): Promise<FSxCLIAdapter>;
+//# sourceMappingURL=fsx-cli-adapter.d.ts.map

package/dist/cli/fsx-cli-adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fsx-cli-adapter.d.ts","sourceRoot":"","sources":["../../src/cli/fsx-cli-adapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAMH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAMlD;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,UAAU,CAAA;AAE7C;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAA;IACZ,mDAAmD;IACnD,MAAM,EAAE,MAAM,CAAA;IACd,wBAAwB;IACxB,IAAI,EAAE,SAAS,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,+BAA+B;IAC/B,GAAG,EAAE,MAAM,CAAA;IACX,2CAA2C;IAC3C,IAAI,EAAE,UAAU,CAAA;IAChB,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAA;IACZ,qCAAqC;IACrC,IAAI,EAAE,UAAU,CAAA;IAChB,yCAAyC;IACzC,MAAM,EAAE,OAAO,GAAG,MAAM,CAAA;IACxB,yCAAyC;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,uBAAuB;IACvB,GAAG,EAAE,KAAK,CAAA;IACV,8CAA8C;IAC9C,GAAG,EAAE,MAAM,CAAA;IACX,6BAA6B;IAC7B,KAAK,EAAE,KAAK,EAAE,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,sBAAsB;IACtB,GAAG,EAAE,MAAM,CAAA;IACX,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,wBAAwB;IACxB,KAAK,EAAE,IAAI,CAAA;IACX,oBAAoB;IACpB,KAAK,EAAE,IAAI,CAAA;IACX,qDAAqD;IACrD,KAAK,EAAE,MAAM,CAAA;IACb,oBAAoB;IACpB,KAAK,EAAE;QACL,WAAW,EAAE,OAAO,CAAA;QACpB,QAAQ,EAAE,OAAO,CAAA;QACjB,YAAY,EAAE,OAAO,CAAA;QACrB,WAAW,EAAE,OAAO,CAAA;KACrB,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,0CAA0C;IAC1C,GAAG,EAAE,MAAM,CAAA;IACX,wDAAwD;IACxD,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAA;IACZ,yBAAyB;IACzB,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,yBAAyB;IACzB,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAA;QACZ,KAAK,EAAE,MAAM,CAAA;QACb,SAAS,EAAE,MAAM,CAAA;QACjB,QAAQ,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,4BAA4B;IAC5B,SAAS,EAAE;QACT,IAAI,EAAE,MAAM,CAAA;QACZ,KAAK,EAAE,MAAM,CAAA;QACb,SAAS,EAAE,MAAM,CAAA;QACjB,QAAQ,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,qBAAqB;IACrB,OAAO,EAAE,MAAM,CAAA;IACf,+BAA+B;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAMD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,gBAAgB,GAChB,kBAAkB,GAClB,eAAe,GACf,gBAAgB,GAChB,aAAa,GACb,YAAY,GACZ,iBAAiB,CAAA;AAErB;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,KAAK;aAGzB,IAAI,EAAE,sBAAsB;aAC5B,IAAI,CAAC,EAAE,MAAM;gBAF7B,OAAO,EAAE,MAAM,EACC,IAAI,EAAE,sBAAsB,EAC5B,IAAI,CAAC,EAAE,MAAM,YAAA;CAKhC;AAwID;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,OAAO,CAAgB;IAC/B,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,QAAQ,CAAQ;IAExB;;;;;OAKG;gBACS,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;IAU3D;;;;;OAKG;IACG,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAyBtD;;;;;OAKG;IACG,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAO9C;;;;;OAKG;IACG,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAK5D;;;;;OAKG;IACG,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAKxD;;;;;OAKG;IACG,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAWhD;;;;;OAKG;IACG,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAWjD;;;;;OAKG;IACG,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAenD;;;;OAIG;IACG,OAAO,IAAI,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAYtC;;;;;OAKG;IACG,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAYjD;;;;;OAKG;IACG,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IA8B7D;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC;IAKxC;;;;OAIG;IACG,YAAY,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAKvC;;;;OAIG;IACG,QAAQ,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAKnC;;;;;OAKG;IACG,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAajD;;OAEG;IACH,WAAW,IAAI,MAAM;IAIrB;;OAEG;IACH,SAAS,IAAI,MAAM;IAInB;;;;OAIG;IACG,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC;IAOzC;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAY9C;;;;;OAKG;IACG,eAAe,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAW9C;;;;;OAKG;IACG,aAAa,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;CAIzC;AAMD;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CA6BxE;AAkBD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,mBAAmB,CACvC,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAC5B,OAAO,CAAC,aAAa,CAAC,CAwExB"}