@archildata/just-bash 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,185 @@
+import * as _archil_node from '@archil/node';
+import { ArchilClient, UnixUser } from '@archil/node';
+
+/**
+ * Archil filesystem adapter for just-bash
+ *
+ * Implements the IFileSystem interface from just-bash using the ArchilClient
+ * from @archil/node for direct protocol access to Archil distributed filesystems.
+ */
+
+type BufferEncoding = "utf8" | "utf-8" | "ascii" | "binary" | "base64" | "hex" | "latin1";
+type FileContent = string | Uint8Array;
+interface FsStat {
+    isFile(): boolean;
+    isDirectory(): boolean;
+    isSymlink(): boolean;
+    mode: number;
+    size: number;
+    mtimeMs: number;
+    atimeMs: number;
+    ctimeMs: number;
+    birthtimeMs: number;
+}
+interface DirentEntry {
+    name: string;
+    isFile(): boolean;
+    isDirectory(): boolean;
+    isSymlink(): boolean;
+}
+interface IFileSystem {
+    readFile(path: string, encoding?: BufferEncoding): Promise<string>;
+    readFileBuffer(path: string): Promise<Uint8Array>;
+    readdir(path: string): Promise<string[]>;
+    readdirWithFileTypes?(path: string): Promise<DirentEntry[]>;
+    stat(path: string): Promise<FsStat>;
+    lstat(path: string): Promise<FsStat>;
+    exists(path: string): Promise<boolean>;
+    readlink(path: string): Promise<string>;
+    realpath(path: string): Promise<string>;
+    writeFile(path: string, content: FileContent): Promise<void>;
+    appendFile(path: string, content: FileContent): Promise<void>;
+    mkdir(path: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+    rm(path: string, options?: {
+        recursive?: boolean;
+        force?: boolean;
+    }): Promise<void>;
+    cp(src: string, dest: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+    mv(src: string, dest: string): Promise<void>;
+    symlink(target: string, path: string): Promise<void>;
+    link(existingPath: string, newPath: string): Promise<void>;
+    chmod(path: string, mode: number): Promise<void>;
+    utimes(path: string, atime: number, mtime: number): Promise<void>;
+    resolvePath(base: string, ...paths: string[]): string;
+    getAllPaths?(): Promise<string[]>;
+}
+/**
+ * ArchilFs implements the just-bash IFileSystem interface using Archil protocol.
+ *
+ * This adapter provides:
+ * - Path-to-inode resolution with caching
+ * - Full filesystem operations via Archil protocol
+ * - Optional user context for permission checks
+ *
+ * @example
+ * ```typescript
+ * import { ArchilClient } from '@archil/node';
+ * import { ArchilFs } from '@archil/just-bash';
+ *
+ * const client = await ArchilClient.connectAuthenticated({
+ *   mountServer: 'mount.archil.com:443',
+ *   mountName: 'myaccount/mydisk',
+ * });
+ *
+ * const fs = new ArchilFs(client);
+ *
+ * // Use with just-bash
+ * import { Bash } from 'just-bash';
+ * const bash = new Bash({ fs });
+ * await bash.run('ls -la /');
+ * ```
+ */
+declare class ArchilFs implements IFileSystem {
+    private client;
+    private inodeCache;
+    private user?;
+    private rootInodeId;
+    /**
+     * Create a new ArchilFs adapter
+     *
+     * @param client - Connected ArchilClient instance
+     * @param options - Optional configuration
+     * @param options.user - Unix user context for permission checks
+     */
+    constructor(client: ArchilClient, options?: {
+        user?: UnixUser;
+    });
+    /**
+     * Normalize a path (remove . and .., ensure leading /)
+     */
+    private normalizePath;
+    /**
+     * Resolve a path to its inode ID, walking the directory tree
+     */
+    private resolve;
+    /**
+     * Resolve parent directory and get child name
+     */
+    private resolveParent;
+    /**
+     * Invalidate cache entries for a path and its descendants
+     */
+    private invalidateCache;
+    /**
+     * Convert InodeAttributes to FsStat
+     */
+    private toStat;
+    resolvePath(base: string, ...paths: string[]): string;
+    readFile(path: string, encoding?: BufferEncoding): Promise<string>;
+    readFileBuffer(path: string): Promise<Uint8Array>;
+    readdir(path: string): Promise<string[]>;
+    readdirWithFileTypes(path: string): Promise<DirentEntry[]>;
+    stat(path: string): Promise<FsStat>;
+    lstat(path: string): Promise<FsStat>;
+    exists(path: string): Promise<boolean>;
+    readlink(path: string): Promise<string>;
+    realpath(path: string): Promise<string>;
+    writeFile(path: string, content: FileContent): Promise<void>;
+    appendFile(path: string, content: FileContent): Promise<void>;
+    mkdir(path: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+    private mkdirSingle;
+    rm(path: string, options?: {
+        recursive?: boolean;
+        force?: boolean;
+    }): Promise<void>;
+    cp(src: string, dest: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+    mv(src: string, dest: string): Promise<void>;
+    symlink(target: string, path: string): Promise<void>;
+    link(existingPath: string, newPath: string): Promise<void>;
+    chmod(path: string, mode: number): Promise<void>;
+    utimes(path: string, atime: number, mtime: number): Promise<void>;
+    getAllPaths(): Promise<string[]>;
+    /**
+     * Clear the inode cache
+     */
+    clearCache(): void;
+    /**
+     * Get cache statistics
+     */
+    getCacheStats(): {
+        size: number;
+        paths: string[];
+    };
+}
+
+/**
+ * Create an ArchilFs instance from an existing client
+ *
+ * This is a convenience function for creating the filesystem adapter.
+ *
+ * @param client - Connected ArchilClient instance
+ * @param options - Optional configuration
+ * @returns Configured ArchilFs instance
+ *
+ * @example
+ * ```typescript
+ * import { ArchilClient } from '@archil/node';
+ * import { createArchilFs } from '@archil/just-bash';
+ *
+ * const client = await ArchilClient.connectAuthenticated({...});
+ * const fs = createArchilFs(client, { user: { uid: 1000, gid: 1000 } });
+ * ```
+ */
+declare function createArchilFs(client: _archil_node.ArchilClient, options?: {
+    user?: _archil_node.UnixUser;
+}): ArchilFs;
+
+export { ArchilFs, type BufferEncoding, type DirentEntry, type FileContent, type FsStat, type IFileSystem, createArchilFs };

package/dist/index.d.ts

@@ -0,0 +1,171 @@
+import * as _archildata_client from '@archildata/client';
+import { ArchilClient, UnixUser } from '@archildata/client';
+
+/**
+ * Archil filesystem adapter for just-bash
+ *
+ * Implements the IFileSystem interface from just-bash using the ArchilClient
+ * from @archildata/client for direct protocol access to Archil distributed filesystems.
+ */
+
+type BufferEncoding = "utf8" | "utf-8" | "ascii" | "binary" | "base64" | "hex" | "latin1";
+type FileContent = string | Uint8Array;
+interface FsStat {
+    isFile: boolean;
+    isDirectory: boolean;
+    isSymlink: boolean;
+    mode: number;
+    size: number;
+    mtime: Date;
+}
+interface DirentEntry {
+    name: string;
+    isFile: boolean;
+    isDirectory: boolean;
+    isSymlink: boolean;
+}
+interface IFileSystem {
+    readFile(path: string, encoding?: BufferEncoding): Promise<string>;
+    readFileBuffer(path: string): Promise<Uint8Array>;
+    readdir(path: string): Promise<string[]>;
+    readdirWithFileTypes?(path: string): Promise<DirentEntry[]>;
+    stat(path: string): Promise<FsStat>;
+    lstat(path: string): Promise<FsStat>;
+    exists(path: string): Promise<boolean>;
+    readlink(path: string): Promise<string>;
+    realpath(path: string): Promise<string>;
+    writeFile(path: string, content: FileContent): Promise<void>;
+    appendFile(path: string, content: FileContent): Promise<void>;
+    mkdir(path: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+    rm(path: string, options?: {
+        recursive?: boolean;
+        force?: boolean;
+    }): Promise<void>;
+    cp(src: string, dest: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+    mv(src: string, dest: string): Promise<void>;
+    symlink(target: string, path: string): Promise<void>;
+    link(existingPath: string, newPath: string): Promise<void>;
+    chmod(path: string, mode: number): Promise<void>;
+    utimes(path: string, atime: number, mtime: number): Promise<void>;
+    resolvePath(base: string, ...paths: string[]): string;
+    getAllPaths?(): Promise<string[]>;
+}
+/**
+ * ArchilFs implements the just-bash IFileSystem interface using Archil protocol.
+ *
+ * This adapter provides:
+ * - Path-to-inode resolution
+ * - Full filesystem operations via Archil protocol
+ * - Optional user context for permission checks
+ *
+ * @example
+ * ```typescript
+ * import { ArchilClient } from '@archildata/client';
+ * import { ArchilFs } from '@archildata/just-bash';
+ *
+ * const client = await ArchilClient.connect({
+ *   region: 'aws-us-east-1',
+ *   diskName: 'myaccount/mydisk',
+ *   authToken: 'adt_xxx',
+ * });
+ *
+ * const fs = new ArchilFs(client);
+ *
+ * // Use with just-bash
+ * import { Bash } from 'just-bash';
+ * const bash = new Bash({ fs });
+ * await bash.run('ls -la /');
+ * ```
+ */
+declare class ArchilFs implements IFileSystem {
+    private client;
+    private user?;
+    private rootInodeId;
+    /**
+     * Create a new ArchilFs adapter
+     *
+     * @param client - Connected ArchilClient instance
+     * @param options - Optional configuration
+     * @param options.user - Unix user context for permission checks
+     */
+    constructor(client: ArchilClient, options?: {
+        user?: UnixUser;
+    });
+    /**
+     * Normalize a path (remove . and .., ensure leading /)
+     */
+    private normalizePath;
+    /**
+     * Resolve a path to its inode ID, walking the directory tree
+     */
+    private resolve;
+    /**
+     * Resolve parent directory and get child name
+     */
+    private resolveParent;
+    /**
+     * Convert InodeAttributes to FsStat
+     */
+    private toStat;
+    resolvePath(base: string, ...paths: string[]): string;
+    readFile(path: string, encoding?: BufferEncoding): Promise<string>;
+    readFileBuffer(path: string): Promise<Uint8Array>;
+    readdir(path: string): Promise<string[]>;
+    readdirWithFileTypes(path: string): Promise<DirentEntry[]>;
+    stat(path: string): Promise<FsStat>;
+    lstat(path: string): Promise<FsStat>;
+    exists(path: string): Promise<boolean>;
+    readlink(path: string): Promise<string>;
+    realpath(path: string): Promise<string>;
+    writeFile(path: string, content: FileContent): Promise<void>;
+    appendFile(path: string, content: FileContent): Promise<void>;
+    mkdir(path: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+    private mkdirSingle;
+    rm(path: string, options?: {
+        recursive?: boolean;
+        force?: boolean;
+    }): Promise<void>;
+    cp(src: string, dest: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+    mv(src: string, dest: string): Promise<void>;
+    symlink(target: string, path: string): Promise<void>;
+    link(existingPath: string, newPath: string): Promise<void>;
+    chmod(path: string, mode: number): Promise<void>;
+    utimes(path: string, atime: number, mtime: number): Promise<void>;
+    getAllPaths(): Promise<string[]>;
+    /**
+     * Resolve a path to its inode ID (public wrapper for delegation operations)
+     */
+    resolveInodeId(path: string): Promise<number>;
+}
+
+/**
+ * Create an ArchilFs instance from an existing client
+ *
+ * This is a convenience function for creating the filesystem adapter.
+ *
+ * @param client - Connected ArchilClient instance
+ * @param options - Optional configuration
+ * @returns Configured ArchilFs instance
+ *
+ * @example
+ * ```typescript
+ * import { ArchilClient } from '@archildata/client';
+ * import { createArchilFs } from '@archildata/just-bash';
+ *
+ * const client = await ArchilClient.connectAuthenticated({...});
+ * const fs = createArchilFs(client, { user: { uid: 1000, gid: 1000 } });
+ * ```
+ */
+declare function createArchilFs(client: _archildata_client.ArchilClient, options?: {
+    user?: _archildata_client.UnixUser;
+}): ArchilFs;
+
+export { ArchilFs, type BufferEncoding, type DirentEntry, type FileContent, type FsStat, type IFileSystem, createArchilFs };