@zenfs/core 0.7.10 → 0.8.0

package/dist/FileIndex.d.ts

@@ -11,10 +11,10 @@ export type ListingTree = {
 /**
  * @internal
  */
-export interface ListingQueueNode<T> {
+export interface ListingQueueNode<TData> {
     pwd: string;
     tree: ListingTree;
-    parent: IndexDirInode<T>;
+    parent: IndexDirInode<TData>;
 }
 /**
  * A simple class for storing a filesystem index. Assumes that all paths passed
@@ -25,19 +25,19 @@ export interface ListingQueueNode<T> {
  *
  * @internal
  */
-export declare class FileIndex<T> {
+export declare class FileIndex<TData> {
     /**
      * Static method for constructing indices from a JSON listing.
      * @param listing Directory listing generated by tools
      * @return A new FileIndex object.
      */
     static FromListing<T>(listing: ListingTree): FileIndex<T>;
-    protected _index: Map<string, IndexDirInode<T>>;
+    protected _index: Map<string, IndexDirInode<TData>>;
     /**
      * Constructs a new FileIndex.
      */
     constructor();
-    files(): IndexFileInode<T>[];
+    files(): IndexFileInode<TData>[];
     /**
      * Adds the given absolute path to the index if it is not already in the index.
      * Creates any needed parent directories.
@@ -50,7 +50,7 @@ export declare class FileIndex<T> {
      * @todo If adding fails and implicitly creates directories, we do not clean up
      *   the new empty directories.
      */
-    add(path: string, inode: IndexInode<T>): boolean;
+    add(path: string, inode: IndexInode<TData>): boolean;
     /**
      * Adds the given absolute path to the index if it is not already in the index.
      * The path is added without special treatment (no joining of adjacent separators, etc).
@@ -62,13 +62,13 @@ export declare class FileIndex<T> {
      *   different).
      * @todo If adding fails and implicitly creates directories, we do not clean up the new empty directories.
      */
-    addFast(path: string, inode: IndexInode<T>): boolean;
+    addFast(path: string, inode: IndexInode<TData>): boolean;
     /**
      * Removes the given path. Can be a file or a directory.
      * @return The removed item,
      *   or null if it did not exist.
      */
-    remove(path: string): IndexInode<T> | null;
+    remove(path: string): IndexInode<TData> | null;
     /**
      * Retrieves the directory listing of the given path.
      * @return An array of files in the given path, or 'null' if it does not exist.
@@ -78,29 +78,29 @@ export declare class FileIndex<T> {
      * Returns the inode of the given item.
      * @return Returns null if the item does not exist.
      */
-    get(path: string): IndexInode<T> | null;
+    get(path: string): IndexInode<TData> | null;
 }
 /**
  * Generic interface for file/directory inodes.
  * Note that Stats objects are what we use for file inodes.
  */
-export declare abstract class IndexInode<T> {
-    data?: T;
-    constructor(data?: T);
+export declare abstract class IndexInode<TData> {
+    data?: TData;
+    constructor(data?: TData);
     /**
      * Whether this inode is for a file
      */
-    abstract isFile(): this is IndexFileInode<T>;
+    abstract isFile(): this is IndexFileInode<TData>;
     /**
      * Whether this inode is for a directory
      */
-    abstract isDirectory(): this is IndexDirInode<T>;
+    abstract isDirectory(): this is IndexDirInode<TData>;
     abstract toStats(): Stats;
 }
 /**
  * Inode for a file. Stores an arbitrary (filesystem-specific) data payload.
  */
-export declare class IndexFileInode<T> extends IndexInode<T> {
+export declare class IndexFileInode<TData> extends IndexInode<TData> {
     isFile(): boolean;
     isDirectory(): boolean;
     toStats(): Stats;
@@ -108,11 +108,11 @@ export declare class IndexFileInode<T> extends IndexInode<T> {
 /**
  * Inode for a directory. Currently only contains the directory listing.
  */
-export declare class IndexDirInode<T> extends IndexInode<T> {
+export declare class IndexDirInode<TData> extends IndexInode<TData> {
     /**
      * @internal
      */
-    _listing: Map<string, IndexInode<T>>;
+    _listing: Map<string, IndexInode<TData>>;
     isFile(): boolean;
     isDirectory(): boolean;
     /**
@@ -135,7 +135,7 @@ export declare class IndexDirInode<T> extends IndexInode<T> {
      * Returns the inode for the indicated item, or null if it does not exist.
      * @param path Name of item in this directory.
      */
-    get(path: string): IndexInode<T> | null;
+    get(path: string): IndexInode<TData> | null;
     /**
      * Add the given item to the directory listing. Note that the given inode is
      * not copied, and will be mutated by the DirInode if it is a DirInode.
@@ -144,16 +144,16 @@ export declare class IndexDirInode<T> extends IndexInode<T> {
      *   item to add to the directory inode.
      * @return True if it was added, false if it already existed.
      */
-    add(path: string, inode: IndexInode<T>): boolean;
+    add(path: string, inode: IndexInode<TData>): boolean;
     /**
      * Removes the given item from the directory listing.
      * @param p Name of item to remove from the directory listing.
      * @return Returns the item
      *   removed, or null if the item did not exist.
      */
-    remove(p: string): IndexInode<T> | null;
+    remove(p: string): IndexInode<TData> | null;
 }
-declare const FileIndexFS_base: (abstract new (...args: any[]) => {
+declare const IndexFS_base: (abstract new (...args: any[]) => {
     metadata(): import("./filesystem.js").FileSystemMetadata;
     rename(oldPath: string, newPath: string, cred: Cred): Promise<void>;
     renameSync(oldPath: string, newPath: string, cred: Cred): void;
@@ -179,8 +179,8 @@ declare const FileIndexFS_base: (abstract new (...args: any[]) => {
     exists(path: string, cred: Cred): Promise<boolean>;
     existsSync(path: string, cred: Cred): boolean;
 }) & typeof FileSystem;
-export declare abstract class FileIndexFS<TIndex> extends FileIndexFS_base {
-    protected _index: FileIndex<TIndex>;
+export declare abstract class IndexFS<TData> extends IndexFS_base {
+    protected _index: FileIndex<TData>;
     constructor(index: ListingTree);
     stat(path: string): Promise<Stats>;
     statSync(path: string): Stats;
@@ -188,44 +188,16 @@ export declare abstract class FileIndexFS<TIndex> extends FileIndexFS_base {
     openFileSync(path: string, flag: string, cred: Cred): NoSyncFile<this>;
     readdir(path: string): Promise<string[]>;
     readdirSync(path: string): string[];
-    protected abstract statFileInode(inode: IndexFileInode<TIndex>, path: string): Promise<Stats>;
-    protected abstract statFileInodeSync(inode: IndexFileInode<TIndex>, path: string): Stats;
-    protected abstract openFileInode(inode: IndexFileInode<TIndex>, path: string, flag: string): Promise<NoSyncFile<this>>;
-    protected abstract openFileInodeSync(inode: IndexFileInode<TIndex>, path: string, flag: string): NoSyncFile<this>;
+    protected abstract statFileInode(inode: IndexFileInode<TData>, path: string): Promise<Stats>;
+    protected abstract statFileInodeSync(inode: IndexFileInode<TData>, path: string): Stats;
+    protected abstract openFileInode(inode: IndexFileInode<TData>, path: string, flag: string): Promise<NoSyncFile<this>>;
+    protected abstract openFileInodeSync(inode: IndexFileInode<TData>, path: string, flag: string): NoSyncFile<this>;
 }
-export declare abstract class SyncFileIndexFS<TIndex> extends FileIndexFS<TIndex> {
-    protected statFileInode(inode: IndexFileInode<TIndex>, path: string): Promise<Stats>;
-    protected openFileInode(inode: IndexFileInode<TIndex>, path: string, flag: string): Promise<NoSyncFile<this>>;
+export declare abstract class SyncIndexFS<TData> extends IndexFS<TData> {
+    protected statFileInode(inode: IndexFileInode<TData>, path: string): Promise<Stats>;
+    protected openFileInode(inode: IndexFileInode<TData>, path: string, flag: string): Promise<NoSyncFile<this>>;
 }
-declare const AsyncFileIndexFS_base: (abstract new (...args: any[]) => {
-    _sync: FileSystem;
-    metadata(): import("./filesystem.js").FileSystemMetadata;
-    ready(): Promise<any>;
-    renameSync(oldPath: string, newPath: string, cred: Cred): void;
-    statSync(path: string, cred: Cred): Stats;
-    createFileSync(path: string, flag: string, mode: number, cred: Cred): import("./file.js").File;
-    openFileSync(path: string, flag: string, cred: Cred): import("./file.js").File;
-    unlinkSync(path: string, cred: Cred): void;
-    rmdirSync(path: string, cred: Cred): void;
-    mkdirSync(path: string, mode: number, cred: Cred): void;
-    readdirSync(path: string, cred: Cred): string[];
-    linkSync(srcpath: string, dstpath: string, cred: Cred): void;
-    syncSync(path: string, data: Uint8Array, stats: Readonly<Stats>): void;
-    rename(oldPath: string, newPath: string, cred: Cred): Promise<void>;
-    stat(path: string, cred: Cred): Promise<Stats>;
-    openFile(path: string, flag: string, cred: Cred): Promise<import("./file.js").File>;
-    createFile(path: string, flag: string, mode: number, cred: Cred): Promise<import("./file.js").File>;
-    unlink(path: string, cred: Cred): Promise<void>;
-    rmdir(path: string, cred: Cred): Promise<void>;
-    mkdir(path: string, mode: number, cred: Cred): Promise<void>;
-    readdir(path: string, cred: Cred): Promise<string[]>;
-    exists(path: string, cred: Cred): Promise<boolean>;
-    existsSync(path: string, cred: Cred): boolean;
-    link(srcpath: string, dstpath: string, cred: Cred): Promise<void>;
-    sync(path: string, data: Uint8Array, stats: Readonly<Stats>): Promise<void>;
-}) & (abstract new (index: ListingTree) => FileIndexFS<unknown>);
-export declare abstract class AsyncFileIndexFS<TIndex> extends AsyncFileIndexFS_base {
-    _index: FileIndex<TIndex>;
+export declare abstract class AsyncIndexFS<TData> extends IndexFS<TData> {
     protected statFileInodeSync(): Stats;
     protected openFileInodeSync(): NoSyncFile<this>;
 }

package/dist/FileIndex.js

@@ -1,7 +1,7 @@
 import { ApiError, ErrorCode } from './ApiError.js';
 import { basename, dirname, join } from './emulation/path.js';
 import { NoSyncFile, flagToMode, isWriteable } from './file.js';
-import { FileSystem, Async, Readonly } from './filesystem.js';
+import { FileSystem, Readonly } from './filesystem.js';
 import { FileType, Stats } from './stats.js';
 /**
  * A simple class for storing a filesystem index. Assumes that all paths passed
@@ -298,7 +298,7 @@ export class IndexDirInode extends IndexInode {
         return item;
     }
 }
-export class FileIndexFS extends Readonly(FileSystem) {
+export class IndexFS extends Readonly(FileSystem) {
     constructor(index) {
         super();
         this._index = FileIndex.FromListing(index);
@@ -340,7 +340,7 @@ export class FileIndexFS extends Readonly(FileSystem) {
             throw ApiError.With('ENOENT', path, 'openFile');
         }
         if (!inode.toStats().hasAccess(flagToMode(flag), cred)) {
-            throw ApiError.With('EACCESS', path, 'openFile');
+            throw ApiError.With('EACCES', path, 'openFile');
         }
         if (inode.isDirectory()) {
             const stats = inode.stats;
@@ -390,7 +390,7 @@ export class FileIndexFS extends Readonly(FileSystem) {
         throw ApiError.With('ENOTDIR', path, 'readdirSync');
     }
 }
-export class SyncFileIndexFS extends FileIndexFS {
+export class SyncIndexFS extends IndexFS {
     async statFileInode(inode, path) {
         return this.statFileInodeSync(inode, path);
     }
@@ -398,7 +398,7 @@ export class SyncFileIndexFS extends FileIndexFS {
         return this.openFileInodeSync(inode, path, flag);
     }
 }
-export class AsyncFileIndexFS extends Async((FileIndexFS)) {
+export class AsyncIndexFS extends IndexFS {
     statFileInodeSync() {
         throw new ApiError(ErrorCode.ENOTSUP);
     }

package/dist/backends/AsyncStore.d.ts

@@ -83,8 +83,14 @@ declare const AsyncStoreFS_base: (abstract new (...args: any[]) => {
     rename(oldPath: string, newPath: string, cred: Cred): Promise<void>;
     stat(path: string, cred: Cred): Promise<Stats>;
     openFile(path: string, flag: string, cred: Cred): Promise<import("../file.js").File>;
-    createFile(path: string, flag: string, mode: number, cred: Cred): Promise<import("../file.js").File>;
-    unlink(path: string, cred: Cred): Promise<void>;
+    createFile(path: string, flag: string, mode: number, cred: Cred): Promise<import("../file.js").File>; /**
+     * Promise that resolves to the store
+     */
+    unlink(path: string, cred: Cred): Promise<void>; /**
+     * An asynchronous file system which uses an async store to store its data.
+     * @see AsyncStore
+     * @internal
+     */
     rmdir(path: string, cred: Cred): Promise<void>;
     mkdir(path: string, mode: number, cred: Cred): Promise<void>;
     readdir(path: string, cred: Cred): Promise<string[]>;

package/dist/backends/Overlay.js

@@ -46,7 +46,6 @@ export class UnlockedOverlayFS extends FileSystem {
         return {
             ...super.metadata(),
             name: OverlayFS.name,
-            supportsProperties: this._readable.metadata().supportsProperties && this._writable.metadata().supportsProperties,
         };
     }
     getOverlayedFileSystems() {

package/dist/backends/backend.d.ts

@@ -1,5 +1,5 @@
+import type { RequiredKeys } from 'utilium';
 import { FileSystem } from '../filesystem.js';
-import { type RequiredKeys } from '../utils.js';
 type OptionType = 'string' | 'number' | 'bigint' | 'boolean' | 'symbol' | 'undefined' | 'object' | 'function';
 /**
  * Resolves the type of Backend.options from the options interface