@zenfs/core 0.10.0 → 0.11.1

package/dist/backends/Index.d.ts

@@ -147,11 +147,11 @@ export declare class IndexDirInode<TData> extends IndexInode<TData> {
     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.
+     * @param path 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<TData> | void;
+    remove(path: string): IndexInode<TData> | void;
 }
 declare const IndexFS_base: (abstract new (...args: any[]) => {
     metadata(): import("../filesystem.js").FileSystemMetadata;
@@ -169,7 +169,7 @@ declare const IndexFS_base: (abstract new (...args: any[]) => {
     linkSync(srcpath: string, dstpath: string, cred: Cred): void;
     sync(path: string, data: Uint8Array, stats: Readonly<Stats>): Promise<void>;
     syncSync(path: string, data: Uint8Array, stats: Readonly<Stats>): void;
-    ready(): Promise<any>;
+    ready(): Promise<void>;
     stat(path: string, cred: Cred): Promise<Stats>;
     statSync(path: string, cred: Cred): Stats;
     openFile(path: string, flag: string, cred: Cred): Promise<import("../file.js").File>;

package/dist/backends/Index.js

@@ -287,16 +287,16 @@ export class IndexDirInode extends IndexInode {
     }
     /**
      * Removes the given item from the directory listing.
-     * @param p Name of item to remove from the directory listing.
+     * @param path Name of item to remove from the directory listing.
      * @return Returns the item
      *   removed, or null if the item did not exist.
      */
-    remove(p) {
-        const item = this._listing.get(p);
+    remove(path) {
+        const item = this._listing.get(path);
         if (!item) {
             return;
         }
-        this._listing.delete(p);
+        this._listing.delete(path);
         return item;
     }
 }

package/dist/backends/backend.d.ts

@@ -33,7 +33,7 @@ export interface Backend<FS extends FileSystem = FileSystem, TOptions extends ob
     /**
      * Create a new instance of the backend
      */
-    create(options: TOptions): FS;
+    create(options: TOptions): FS | Promise<FS>;
     /**
      * A name to identify the backend.
      */
@@ -64,7 +64,6 @@ export declare function isBackend(arg: unknown): arg is Backend;
  * @internal
  */
 export declare function checkOptions<T extends Backend>(backend: T, opts: Partial<OptionsOf<T>> & Record<string, unknown>): Promise<void>;
-export declare function createBackend<B extends Backend>(backend: B, options?: Partial<OptionsOf<B>>): Promise<ReturnType<B['create']>>;
 /**
  * Specifies a file system backend type and its options.
  *

package/dist/backends/backend.js

@@ -44,11 +44,6 @@ export async function checkOptions(backend, opts) {
         // Otherwise: All good!
     }
 }
-export async function createBackend(backend, options = {}) {
-    await checkOptions(backend, options);
-    const fs = backend.create(options);
-    return fs.ready();
-}
 /**
  * @internal
  */

package/dist/backends/{Fetch.d.ts → fetch.d.ts}

@@ -41,7 +41,7 @@ export declare class FetchFS extends AsyncIndexFS<Stats> {
     readonly prefixUrl: string;
     protected _init: Promise<void>;
     protected _initialize(index: string | ListingTree): Promise<void>;
-    ready(): Promise<this>;
+    ready(): Promise<void>;
     constructor({ index, baseUrl }: FetchOptions);
     metadata(): FileSystemMetadata;
     empty(): void;
@@ -57,9 +57,9 @@ export declare class FetchFS extends AsyncIndexFS<Stats> {
     /**
      * Asynchronously download the given file.
      */
-    protected _fetchFile(p: string, type: 'buffer'): Promise<Uint8Array>;
-    protected _fetchFile(p: string, type: 'json'): Promise<object>;
-    protected _fetchFile(p: string, type: 'buffer' | 'json'): Promise<object>;
+    protected _fetchFile(path: string, type: 'buffer'): Promise<Uint8Array>;
+    protected _fetchFile(path: string, type: 'json'): Promise<object>;
+    protected _fetchFile(path: string, type: 'buffer' | 'json'): Promise<object>;
     /**
      * Only requests the HEAD content, for the file size.
      */

package/dist/backends/{Fetch.js → fetch.js}

@@ -8,8 +8,8 @@ import { FileIndex, AsyncIndexFS } from './Index.js';
 function convertError(e) {
     throw new ErrnoError(Errno.EIO, e.message);
 }
-async function fetchFile(p, type) {
-    const response = await fetch(p).catch(convertError);
+async function fetchFile(path, type) {
+    const response = await fetch(path).catch(convertError);
     if (!response.ok) {
         throw new ErrnoError(Errno.EIO, 'fetch failed: response returned code ' + response.status);
     }
@@ -27,8 +27,8 @@ async function fetchFile(p, type) {
  * Asynchronously retrieves the size of the given file in bytes.
  * @hidden
  */
-async function fetchSize(p) {
-    const response = await fetch(p, { method: 'HEAD' }).catch(convertError);
+async function fetchSize(path) {
+    const response = await fetch(path, { method: 'HEAD' }).catch(convertError);
     if (!response.ok) {
         throw new ErrnoError(Errno.EIO, 'fetch failed: HEAD response returned code ' + response.status);
     }
@@ -71,7 +71,6 @@ export class FetchFS extends AsyncIndexFS {
     }
     async ready() {
         await this._init;
-        return this;
     }
     constructor({ index = 'index.json', baseUrl = '' }) {
         super({});
@@ -138,8 +137,8 @@ export class FetchFS extends AsyncIndexFS {
         }
         return this.prefixUrl + filePath;
     }
-    _fetchFile(p, type) {
-        return fetchFile(this._getRemotePath(p), type);
+    _fetchFile(path, type) {
+        return fetchFile(this._getRemotePath(path), type);
     }
     /**
      * Only requests the HEAD content, for the file size.

package/dist/backends/{Locked.d.ts → locked.d.ts}

@@ -16,7 +16,7 @@ export declare class LockedFS<FS extends FileSystem> implements FileSystem {
     readonly fs: FS;
     private _mu;
     constructor(fs: FS);
-    ready(): Promise<this>;
+    ready(): Promise<void>;
     metadata(): FileSystemMetadata;
     rename(oldPath: string, newPath: string, cred: Cred): Promise<void>;
     renameSync(oldPath: string, newPath: string, cred: Cred): void;
@@ -26,7 +26,7 @@ export declare class LockedFS<FS extends FileSystem> implements FileSystem {
     openFileSync(path: string, flag: string, cred: Cred): File;
     createFile(path: string, flag: string, mode: number, cred: Cred): Promise<File>;
     createFileSync(path: string, flag: string, mode: number, cred: Cred): File;
-    unlink(p: string, cred: Cred): Promise<void>;
+    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;

package/dist/backends/{Locked.js → locked.js}

@@ -17,7 +17,6 @@ export class LockedFS {
     }
     async ready() {
         await this.fs.ready();
-        return this;
     }
     metadata() {
         return {
@@ -72,10 +71,10 @@ export class LockedFS {
         }
         return this.fs.createFileSync(path, flag, mode, cred);
     }
-    async unlink(p, cred) {
-        await this._mu.lock(p);
-        await this.fs.unlink(p, cred);
-        this._mu.unlock(p);
+    async unlink(path, cred) {
+        await this._mu.lock(path);
+        await this.fs.unlink(path, cred);
+        this._mu.unlock(path);
     }
     unlinkSync(path, cred) {
         if (this._mu.isLocked(path)) {

package/dist/backends/{InMemory.d.ts → memory.d.ts}

@@ -1,17 +1,15 @@
 import type { Ino } from '../inode.js';
-import { SimpleSyncStore, SyncStore, SyncStoreFS, SyncTransaction } from './SyncStore.js';
+import { StoreFS } from './store/fs.js';
+import { SimpleTransaction, type SimpleSyncStore } from './store/simple.js';
 /**
  * A simple in-memory store
  */
-export declare class InMemoryStore implements SyncStore, SimpleSyncStore {
+export declare class InMemoryStore extends Map<Ino, Uint8Array> implements SimpleSyncStore {
     name: string;
-    private store;
     constructor(name?: string);
-    clear(): void;
-    beginTransaction(): SyncTransaction;
-    get(key: Ino): Uint8Array | undefined;
-    put(key: Ino, data: Uint8Array, overwrite: boolean): boolean;
-    remove(key: Ino): void;
+    sync(): Promise<void>;
+    clearSync(): void;
+    transaction(): SimpleTransaction;
 }
 /**
  * A simple in-memory file system backed by an InMemoryStore.
@@ -29,5 +27,5 @@ export declare const InMemory: {
     };
     readonly create: ({ name }: {
         name?: string;
-    }) => SyncStoreFS;
+    }) => StoreFS;
 };

package/dist/backends/memory.js

@@ -0,0 +1,38 @@
+import { StoreFS } from './store/fs.js';
+import { SimpleTransaction } from './store/simple.js';
+/**
+ * A simple in-memory store
+ */
+export class InMemoryStore extends Map {
+    constructor(name = 'tmp') {
+        super();
+        this.name = name;
+    }
+    async sync() { }
+    clearSync() {
+        this.clear();
+    }
+    transaction() {
+        return new SimpleTransaction(this);
+    }
+}
+/**
+ * A simple in-memory file system backed by an InMemoryStore.
+ * Files are not persisted across page loads.
+ */
+export const InMemory = {
+    name: 'InMemory',
+    isAvailable() {
+        return true;
+    },
+    options: {
+        name: {
+            type: 'string',
+            required: false,
+            description: 'The name of the store',
+        },
+    },
+    create({ name }) {
+        return new StoreFS(new InMemoryStore(name));
+    },
+};

package/dist/backends/{Overlay.d.ts → overlay.d.ts}

@@ -1,7 +1,7 @@
 import { FileSystem, FileSystemMetadata } from '../filesystem.js';
 import { File } from '../file.js';
 import { Stats } from '../stats.js';
-import { LockedFS } from './Locked.js';
+import { LockedFS } from './locked.js';
 import { Cred } from '../cred.js';
 /**
  * Configuration options for OverlayFS instances.
@@ -25,7 +25,7 @@ export interface OverlayOptions {
  * @internal
  */
 export declare class UnlockedOverlayFS extends FileSystem {
-    ready(): Promise<this>;
+    ready(): Promise<void>;
     private _writable;
     private _readable;
     private _isInitialized;
@@ -49,22 +49,22 @@ export declare class UnlockedOverlayFS extends FileSystem {
     restoreDeletionLog(log: string, cred: Cred): void;
     rename(oldPath: string, newPath: string, cred: Cred): Promise<void>;
     renameSync(oldPath: string, newPath: string, cred: Cred): void;
-    stat(p: string, cred: Cred): Promise<Stats>;
-    statSync(p: string, cred: Cred): Stats;
+    stat(path: string, cred: Cred): Promise<Stats>;
+    statSync(path: string, cred: Cred): Stats;
     openFile(path: string, flag: string, cred: Cred): Promise<File>;
     openFileSync(path: string, flag: string, cred: Cred): File;
     createFile(path: string, flag: string, mode: number, cred: Cred): Promise<File>;
     createFileSync(path: string, flag: string, mode: number, cred: Cred): File;
     link(srcpath: string, dstpath: string, cred: Cred): Promise<void>;
     linkSync(srcpath: string, dstpath: string, cred: Cred): void;
-    unlink(p: string, cred: Cred): Promise<void>;
-    unlinkSync(p: string, cred: Cred): void;
-    rmdir(p: string, cred: Cred): Promise<void>;
-    rmdirSync(p: string, cred: Cred): void;
-    mkdir(p: string, mode: number, cred: Cred): Promise<void>;
-    mkdirSync(p: string, mode: number, cred: Cred): void;
-    readdir(p: string, cred: Cred): Promise<string[]>;
-    readdirSync(p: string, cred: Cred): string[];
+    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[];
     private deletePath;
     private updateLog;
     private _reparseDeletionLog;
@@ -97,7 +97,6 @@ export declare class UnlockedOverlayFS extends FileSystem {
  * @internal
  */
 export declare class OverlayFS extends LockedFS<UnlockedOverlayFS> {
-    ready(): Promise<this>;
     /**
      * @param options The options to initialize the OverlayFS with
      */