opfs-worker 1.1.0 → 1.2.0

package/dist/facade.d.ts

@@ -0,0 +1,141 @@
+import type { DirentData, Encoding, FileOpenOptions, FileStat, OPFSOptions, RenameOptions, WatchOptions } from './types';
+/**
+ * Facade class that provides a clean interface for communicating with the OPFS worker
+ * while hiding Comlink implementation details.
+ */
+export declare class OPFSFileSystem {
+    #private;
+    constructor(options?: OPFSOptions);
+    /**
+     * Update configuration options
+     */
+    setOptions(options: OPFSOptions): Promise<void>;
+    /**
+     * Get a complete index of all files and directories in the file system
+     */
+    index(): Promise<Map<string, FileStat>>;
+    /**
+     * Read a file from the file system
+     */
+    readFile(path: string, encoding: 'binary'): Promise<Uint8Array>;
+    readFile(path: string, encoding: Encoding): Promise<string>;
+    readFile(path: string, encoding?: Encoding | 'binary'): Promise<string | Uint8Array>;
+    /**
+     * Write data to a file
+     */
+    writeFile(path: string, data: string | Uint8Array | ArrayBuffer, encoding?: Encoding): Promise<void>;
+    /**
+     * Append data to a file
+     */
+    appendFile(path: string, data: string | Uint8Array | ArrayBuffer, encoding?: Encoding): Promise<void>;
+    /**
+     * Create a directory
+     */
+    mkdir(path: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+    /**
+     * Get file or directory statistics
+     */
+    stat(path: string): Promise<FileStat>;
+    /**
+     * Read a directory's contents
+     */
+    readDir(path: string): Promise<DirentData[]>;
+    /**
+     * Check if a file or directory exists
+     */
+    exists(path: string): Promise<boolean>;
+    /**
+     * Clear all contents of a directory without removing the directory itself
+     */
+    clear(path?: string): Promise<void>;
+    /**
+     * Remove files and directories
+     */
+    remove(path: string, options?: {
+        recursive?: boolean;
+        force?: boolean;
+    }): Promise<void>;
+    /**
+     * Resolve a path to an absolute path
+     */
+    realpath(path: string): Promise<string>;
+    /**
+     * Rename a file or directory
+     */
+    rename(oldPath: string, newPath: string, options?: RenameOptions): Promise<void>;
+    /**
+     * Copy files and directories
+     */
+    copy(source: string, destination: string, options?: {
+        recursive?: boolean;
+        overwrite?: boolean;
+    }): Promise<void>;
+    /**
+     * Start watching a file or directory for changes
+     */
+    watch(path: string, options?: WatchOptions): () => void;
+    /**
+     * Stop watching a previously watched path
+     */
+    unwatch(path: string): void;
+    /**
+     * Open a file and return a file descriptor
+     */
+    open(path: string, options?: FileOpenOptions): Promise<number>;
+    /**
+     * Close a file descriptor
+     */
+    close(fd: number): Promise<void>;
+    /**
+     * Read data from a file descriptor
+     *
+     * This method requires special handling due to Comlink transfer requirements.
+     * The buffer is transferred to the worker and back, so the original buffer
+     * becomes unusable after the call.
+     */
+    read(fd: number, buffer: Uint8Array, offset: number, length: number, position?: number | null | undefined): Promise<{
+        bytesRead: number;
+        buffer: Uint8Array;
+    }>;
+    /**
+     * Write data to a file descriptor
+     */
+    write(fd: number, buffer: Uint8Array, offset?: number, length?: number, position?: number | null | undefined, emitEvent?: boolean): Promise<number>;
+    /**
+     * Get file status information by file descriptor
+     */
+    fstat(fd: number): Promise<FileStat>;
+    /**
+     * Truncate file to specified size
+     */
+    ftruncate(fd: number, size?: number): Promise<void>;
+    /**
+     * Synchronize file data to storage (fsync equivalent)
+     */
+    fsync(fd: number): Promise<void>;
+    /**
+     * Dispose of resources and clean up the file system instance
+     */
+    dispose(): void;
+    /**
+     * Synchronize the file system with external data
+     */
+    sync(entries: [string, string | Uint8Array | Blob][], options?: {
+        cleanBefore?: boolean;
+    }): Promise<void>;
+    /**
+     * Read a file as text with automatic encoding detection
+     */
+    readText(path: string, encoding?: Encoding): Promise<string>;
+    /**
+     * Write text to a file with specified encoding
+     */
+    writeText(path: string, text: string, encoding?: Encoding): Promise<void>;
+    /**
+     * Append text to a file with specified encoding
+     */
+    appendText(path: string, text: string, encoding?: Encoding): Promise<void>;
+}
+//# sourceMappingURL=facade.d.ts.map

package/dist/facade.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"facade.d.ts","sourceRoot":"","sources":["../src/facade.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACR,UAAU,EACV,QAAQ,EACR,eAAe,EACf,QAAQ,EACR,WAAW,EAEX,aAAa,EACb,YAAY,EACf,MAAM,SAAS,CAAC;AAEjB;;;GAGG;AACH,qBAAa,cAAc;;gBAGX,OAAO,CAAC,EAAE,WAAW;IAiBjC;;OAEG;IACG,UAAU,CAAC,OAAO,EAAE,WAAW;IAIrC;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAI7C;;OAEG;IACG,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC;IAC/D,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC;IAC3D,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAC,MAAM,GAAG,UAAU,CAAC;IAiB1F;;OAEG;IACG,SAAS,CACX,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,EACvC,QAAQ,CAAC,EAAE,QAAQ,GACpB,OAAO,CAAC,IAAI,CAAC;IAchB;;OAEG;IACG,UAAU,CACZ,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,EACvC,QAAQ,CAAC,EAAE,QAAQ,GACpB,OAAO,CAAC,IAAI,CAAC;IAchB;;OAEG;IACG,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3E;;OAEG;IACG,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI3C;;OAEG;IACG,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAIlD;;OAEG;IACG,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5C;;OAEG;IACG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzC;;OAEG;IACG,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7F;;OAEG;IACG,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI7C;;OAEG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAItF;;OAEG;IACG,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAItH;;OAEG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,MAAM,IAAI;IAMvD;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM;IAIpB;;OAEG;IACG,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAIpE;;OAEG;IACG,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAItC;;;;;;OAMG;IACG,IAAI,CACN,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GACrC,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,UAAU,CAAA;KAAE,CAAC;IAkBrD;;OAEG;IACG,KAAK,CACP,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,UAAU,EAClB,MAAM,CAAC,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EACpC,SAAS,CAAC,EAAE,OAAO,GACpB,OAAO,CAAC,MAAM,CAAC;IAIlB;;OAEG;IACG,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI1C;;OAEG;IACG,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzD;;OAEG;IACG,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAItC;;OAEG;IACH,OAAO;IAIP;;OAEG;IACG,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/G;;OAEG;IACG,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,GAAE,QAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;IAM3E;;OAEG;IACG,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,GAAE,QAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMxF;;OAEG;IACG,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,GAAE,QAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;CAK5F"}