@zenfs/core 0.10.0 → 0.11.0

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

@@ -0,0 +1,169 @@
+import type { Cred } from '../../cred.js';
+import { PreloadFile } from '../../file.js';
+import { FileSystem, type FileSystemMetadata } from '../../filesystem.js';
+import { type Ino, Inode } from '../../inode.js';
+import { type Stats, FileType } from '../../stats.js';
+import type { Store, Transaction } from './store.js';
+/**
+ * A synchronous key-value file system. Uses a SyncStore to store the data.
+ *
+ * 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.
+ * @internal
+ */
+export declare class StoreFS extends FileSystem {
+    private $store;
+    protected get store(): Store;
+    protected _store?: Store;
+    private _initialized;
+    ready(): Promise<void>;
+    constructor($store: Store | Promise<Store>);
+    metadata(): FileSystemMetadata;
+    /**
+     * Delete all contents stored in the file system.
+     */
+    empty(): Promise<void>;
+    /**
+     * Delete all contents stored in the file system.
+     */
+    emptySync(): void;
+    /**
+     * @todo Make rename compatible with the cache.
+     */
+    rename(oldPath: string, newPath: string, cred: Cred): Promise<void>;
+    renameSync(oldPath: string, newPath: string, cred: Cred): void;
+    stat(path: string, cred: Cred): Promise<Stats>;
+    statSync(path: string, cred: Cred): Stats;
+    createFile(path: string, flag: string, mode: number, cred: Cred): Promise<PreloadFile<this>>;
+    createFileSync(path: string, flag: string, mode: number, cred: Cred): PreloadFile<this>;
+    openFile(path: string, flag: string, cred: Cred): Promise<PreloadFile<this>>;
+    openFileSync(path: string, flag: string, cred: Cred): PreloadFile<this>;
+    unlink(path: string, cred: Cred): Promise<void>;
+    unlinkSync(path: string, cred: Cred): void;
+    rmdir(path: string, cred: Cred): Promise<void>;
+    rmdirSync(path: string, cred: Cred): void;
+    mkdir(path: string, mode: number, cred: Cred): Promise<void>;
+    mkdirSync(path: string, mode: number, cred: Cred): void;
+    readdir(path: string, cred: Cred): Promise<string[]>;
+    readdirSync(path: string, cred: Cred): string[];
+    /**
+     * Updated the inode and data node at the given 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>;
+    /**
+     * Updated the inode and data node at the given 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;
+    link(existing: string, newpath: string, cred: Cred): Promise<void>;
+    linkSync(existing: string, newpath: string, cred: Cred): void;
+    /**
+     * Checks if the root directory exists. Creates it if it doesn't.
+     */
+    private makeRootDirectory;
+    /**
+     * Checks if the root directory exists. Creates it if it doesn't.
+     */
+    protected makeRootDirectorySync(): void;
+    /**
+     * Helper function for findINode.
+     * @param parent The parent directory of the file we are attempting to find.
+     * @param filename The filename of the inode we are attempting to find, minus
+     *   the parent.
+     */
+    private _findINode;
+    /**
+     * Helper function for findINode.
+     * @param parent The parent directory of the file we are attempting to find.
+     * @param filename The filename of the inode we are attempting to find, minus
+     *   the parent.
+     * @return string The ID of the file's inode in the file system.
+     */
+    protected _findINodeSync(tx: Transaction, parent: string, filename: string, visited?: Set<string>): Ino;
+    /**
+     * Finds the Inode of the given path.
+     * @param path The path to look up.
+     * @todo memoize/cache
+     */
+    private findINode;
+    /**
+     * Finds the Inode of the given path.
+     * @param path The path to look up.
+     * @return The Inode of the path p.
+     * @todo memoize/cache
+     */
+    protected findINodeSync(tx: Transaction, path: string, visited?: Set<string>): Inode;
+    /**
+     * Given the ID of a node, retrieves the corresponding Inode.
+     * @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 getINode;
+    /**
+     * Given the ID of a node, retrieves the corresponding Inode.
+     * @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.
+     */
+    protected getINodeSync(tx: Transaction, id: Ino, path: string): Inode;
+    /**
+     * Given the Inode of a directory, retrieves the corresponding directory
+     * listing.
+     */
+    private getDirListing;
+    /**
+     * Given the Inode of a directory, retrieves the corresponding directory listing.
+     */
+    protected getDirListingSync(tx: Transaction, inode: Inode, p?: string): {
+        [fileName: string]: Ino;
+    };
+    /**
+     * Adds a new node under a random ID. Retries before giving up in
+     * the exceedingly unlikely chance that we try to reuse a random ino.
+     */
+    private addNew;
+    /**
+     * Creates a new node under a random ID. Retries before giving up in
+     * the exceedingly unlikely chance that we try to reuse a random ino.
+     * @return The ino that the data was stored under.
+     */
+    protected addNewSync(tx: Transaction, data: Uint8Array, path: string): Ino;
+    /**
+     * Commits a new file (well, a FILE or a DIRECTORY) to the file system with
+     * the given mode.
+     * Note: This will commit the transaction.
+     * @param path The path to the new file.
+     * @param type The type of the new file.
+     * @param mode The mode to create the new file with.
+     * @param cred The UID/GID to create the file with
+     * @param data The data to store at the file's data node.
+     */
+    private commitNew;
+    /**
+     * Commits a new file (well, a FILE or a DIRECTORY) to the file system with the given mode.
+     * Note: This will commit the transaction.
+     * @param path The path to the new file.
+     * @param type The type of the new file.
+     * @param mode The mode to create the new file with.
+     * @param data The data to store at the file's data node.
+     * @return The Inode for the new file.
+     */
+    protected commitNewSync(path: string, type: FileType, mode: number, cred: Cred, data?: Uint8Array): Inode;
+    /**
+     * Remove all traces of the given 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;
+    /**
+     * Remove all traces of the given 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.
+     */
+    protected removeSync(path: string, isDir: boolean, cred: Cred): void;
+}