@zenfs/core 1.7.2 → 1.8.0

package/dist/backends/store/fs.d.ts

@@ -1,19 +1,22 @@
 import type { File } from '../../file.js';
-import { FileSystem, type FileSystemMetadata } from '../../filesystem.js';
-import { Inode } from './inode.js';
-import type { Stats } from '../../stats.js';
+import type { CreationOptions, FileSystemMetadata, PureCreationOptions } from '../../filesystem.js';
+import { FileSystem } from '../../filesystem.js';
+import type { FileType, Stats } from '../../stats.js';
+import { Index } from './file_index.js';
+import { Inode, type InodeLike } from './inode.js';
 import type { Store, Transaction } from './store.js';
 /**
  * A file system which uses a key-value store.
  *
  * We use a unique ID for each node in the file system. The root node has a fixed ID.
- * @todo Introduce Node ID caching.
- * @todo Check modes.
+ *
+ * @todo Introduce Node ID caching?
+ * @todo Check modes?
  * @internal
  */
 export declare class StoreFS<T extends Store = Store> extends FileSystem {
-    protected store: T;
-    private _initialized;
+    protected readonly store: T;
+    protected _initialized: boolean;
     ready(): Promise<void>;
     constructor(store: T);
     metadata(): FileSystemMetadata;
@@ -27,6 +30,18 @@ export declare class StoreFS<T extends Store = Store> extends FileSystem {
      * @deprecated
      */
     emptySync(): void;
+    /**
+     * Load an index into the StoreFS.
+     * You *must* manually add non-directory files
+     */
+    loadIndex(index: Index): Promise<void>;
+    /**
+     * Load an index into the StoreFS.
+     * You *must* manually add non-directory files
+     */
+    loadIndexSync(index: Index): void;
+    createIndex(): Promise<Index>;
+    createIndexSync(): Index;
     /**
      * @todo Make rename compatible with the cache.
      */
@@ -34,30 +49,50 @@ export declare class StoreFS<T extends Store = Store> extends FileSystem {
     renameSync(oldPath: string, newPath: string): void;
     stat(path: string): Promise<Stats>;
     statSync(path: string): Stats;
-    createFile(path: string, flag: string, mode: number): Promise<File>;
-    createFileSync(path: string, flag: string, mode: number): File;
+    createFile(path: string, flag: string, mode: number, options: CreationOptions): Promise<File>;
+    createFileSync(path: string, flag: string, mode: number, options: CreationOptions): File;
     openFile(path: string, flag: string): Promise<File>;
     openFileSync(path: string, flag: string): File;
     unlink(path: string): Promise<void>;
     unlinkSync(path: string): void;
     rmdir(path: string): Promise<void>;
     rmdirSync(path: string): void;
-    mkdir(path: string, mode: number): Promise<void>;
-    mkdirSync(path: string, mode: number): void;
+    mkdir(path: string, mode: number, options: CreationOptions): Promise<void>;
+    mkdirSync(path: string, mode: number, options: CreationOptions): void;
     readdir(path: string): Promise<string[]>;
     readdirSync(path: string): string[];
     /**
      * Updated the inode and data node at `path`
      * @todo Ensure mtime updates properly, and use that to determine if a data update is required.
      */
-    sync(path: string, data: Uint8Array, stats: Readonly<Stats>): Promise<void>;
+    sync(path: string, data?: Uint8Array, metadata?: Readonly<InodeLike>): Promise<void>;
     /**
      * Updated the inode and data node at `path`
      * @todo Ensure mtime updates properly, and use that to determine if a data update is required.
      */
-    syncSync(path: string, data: Uint8Array, stats: Readonly<Stats>): void;
+    syncSync(path: string, data?: Uint8Array, metadata?: Readonly<InodeLike>): void;
     link(target: string, link: string): Promise<void>;
     linkSync(target: string, link: string): void;
+    /**
+     * Used by lazy file
+     * @internal
+     */
+    read(path: string, offset: number, length: number): Promise<Uint8Array>;
+    /**
+     * Used by lazy file
+     * @internal
+     */
+    readSync(path: string, offset: number, length: number): Uint8Array;
+    /**
+     * Used by lazy file
+     * @internal
+     */
+    write(path: string, data: Uint8Array, offset: number): Promise<void>;
+    /**
+     * Used by lazy file
+     * @internal
+     */
+    writeSync(path: string, data: Uint8Array, offset: number): void;
     /**
      * Checks if the root directory exists. Creates it if it doesn't.
      */
@@ -80,7 +115,7 @@ export declare class StoreFS<T extends Store = Store> extends FileSystem {
      *   the parent.
      * @return string The ID of the file's inode in the file system.
      */
-    protected _findInodeSync(tx: Transaction, path: string, syscall: string, visited?: Set<string>): bigint;
+    private _findInodeSync;
     /**
      * Finds the Inode of `path`.
      * @param path The path to look up.
@@ -94,31 +129,17 @@ export declare class StoreFS<T extends Store = Store> extends FileSystem {
      * @todo memoize/cache
      */
     protected findInodeSync(tx: Transaction, path: string, syscall: string, visited?: Set<string>): Inode;
-    /**
-     * Given an ID, retrieves the corresponding data.
-     * @param tx The transaction to use.
-     * @param path The corresponding path to the file (used for error messages).
-     * @param id The ID to look up.
-     */
-    private get;
-    /**
-     * Given an ID, retrieves the corresponding data.
-     * @param tx The transaction to use.
-     * @param path The corresponding path to the file (used for error messages).
-     * @param id The ID to look up.
-     */
-    private getSync;
     /**
      * Adds a new node under a random ID. Retries before giving up in
      * the exceedingly unlikely chance that we try to reuse a random id.
      */
-    private allocNew;
+    protected allocNew(tx: Transaction, path: string, syscall: string): Promise<number>;
     /**
      * Creates a new node under a random ID. Retries before giving up in
      * the exceedingly unlikely chance that we try to reuse a random id.
      * @return The ino that the data was stored under.
      */
-    private allocNewSync;
+    protected allocNewSync(tx: Transaction, path: string, syscall: string): number;
     /**
      * Commits a new file (well, a FILE or a DIRECTORY) to the file system with `mode`.
      * Note: This will commit the transaction.
@@ -127,7 +148,7 @@ export declare class StoreFS<T extends Store = Store> extends FileSystem {
      * @param mode The mode to create the new file with.
      * @param data The data to store at the file's data node.
      */
-    private commitNew;
+    protected commitNew(path: string, type: FileType, options: PureCreationOptions, data: Uint8Array, syscall: string): Promise<Inode>;
     /**
      * Commits a new file (well, a FILE or a DIRECTORY) to the file system with `mode`.
      * Note: This will commit the transaction.
@@ -137,19 +158,19 @@ export declare class StoreFS<T extends Store = Store> extends FileSystem {
      * @param data The data to store at the file's data node.
      * @return The Inode for the new file.
      */
-    private commitNewSync;
+    protected commitNewSync(path: string, type: FileType, options: PureCreationOptions, data: Uint8Array, syscall: string): Inode;
     /**
      * Remove all traces of `path` from the file system.
      * @param path The path to remove from the file system.
      * @param isDir Does the path belong to a directory, or a file?
      * @todo Update mtime.
      */
-    private remove;
+    protected remove(path: string, isDir: boolean, syscall: string): Promise<void>;
     /**
      * Remove all traces of `path` from the file system.
      * @param path The path to remove from the file system.
      * @param isDir Does the path belong to a directory, or a file?
      * @todo Update mtime.
      */
-    private removeSync;
+    protected removeSync(path: string, isDir: boolean, syscall: string): void;
 }