@zenfs/core 0.1.0 → 0.2.0

package/dist/ApiError.d.ts

@@ -5,20 +5,65 @@
  * @url http://www.gnu.org/software/libc/manual/html_node/Error-Codes.html
  */
 export declare enum ErrorCode {
+    /**
+     * Operation not permitted
+     */
     EPERM = 1,
+    /**
+     * No such file or directory
+     */
     ENOENT = 2,
+    /**
+     * Input/output error
+     */
     EIO = 5,
+    /**
+     * Bad file descriptor
+     */
     EBADF = 9,
+    /**
+     * Permission denied
+     */
     EACCES = 13,
+    /**
+     * Resource busy or locked
+     */
     EBUSY = 16,
+    /**
+     * File exists
+     */
     EEXIST = 17,
+    /**
+     * File is not a directory
+     */
     ENOTDIR = 20,
+    /**
+     * File is a directory
+     */
     EISDIR = 21,
+    /**
+     * Invalid argument
+     */
     EINVAL = 22,
+    /**
+     * File is too big
+     */
     EFBIG = 27,
+    /**
+     * No space left on disk
+     */
     ENOSPC = 28,
+    /**
+     * Cannot modify a read-only file system
+     */
     EROFS = 30,
+    /**
+     * Directory is not empty
+     */
     ENOTEMPTY = 39,
+    /**
+     * Operation is not supported
+     */
     ENOTSUP = 95
 }
 /**
@@ -40,12 +85,10 @@ interface ApiErrorJSON {
  * call to the ZenFS API.
  */
 export declare class ApiError extends Error implements NodeJS.ErrnoException {
+    errno: ErrorCode;
+    path?: string;
     static fromJSON(json: ApiErrorJSON): ApiError;
-    /**
-     * Creates an ApiError object from a buffer.
-     */
-    static Derserialize(data: ArrayBufferLike | ArrayBufferView, i?: number): ApiError;
-    static FileError(code: ErrorCode, p: string): ApiError;
+    static OnPath(code: ErrorCode, path: string): ApiError;
     static EACCES(path: string): ApiError;
     static ENOENT(path: string): ApiError;
     static EEXIST(path: string): ApiError;
@@ -53,9 +96,7 @@ export declare class ApiError extends Error implements NodeJS.ErrnoException {
     static ENOTDIR(path: string): ApiError;
     static EPERM(path: string): ApiError;
     static ENOTEMPTY(path: string): ApiError;
-    errno: ErrorCode;
     code: string;
-    path?: string;
     syscall: string;
     stack?: string;
     /**
@@ -66,18 +107,14 @@ export declare class ApiError extends Error implements NodeJS.ErrnoException {
      * what Node returns.
      * @constructor ApiError
      * @param type The type of the error.
-     * @param [message] A descriptive error message.
+     * @param message A descriptive error message.
      */
-    constructor(type: ErrorCode, message?: string, path?: string);
+    constructor(errno: ErrorCode, message?: string, path?: string);
     /**
      * @return A friendly error message.
      */
     toString(): string;
-    toJSON(): any;
-    /**
-     * Writes the API error into a buffer.
-     */
-    serialize(data?: ArrayBufferLike | ArrayBufferView, i?: number): Uint8Array;
+    toJSON(): ApiErrorJSON;
     /**
      * The size of the API error in buffer-form in bytes.
      */

package/dist/ApiError.js

@@ -1,4 +1,3 @@
-import { decode, encode } from './utils.js';
 /**
  * Standard libc error codes. More will be added to this enum and ErrorStrings as they are
  * needed.
@@ -6,20 +5,65 @@ import { decode, encode } from './utils.js';
  */
 export var ErrorCode;
 (function (ErrorCode) {
+    /**
+     * Operation not permitted
+     */
     ErrorCode[ErrorCode["EPERM"] = 1] = "EPERM";
+    /**
+     * No such file or directory
+     */
     ErrorCode[ErrorCode["ENOENT"] = 2] = "ENOENT";
+    /**
+     * Input/output error
+     */
     ErrorCode[ErrorCode["EIO"] = 5] = "EIO";
+    /**
+     * Bad file descriptor
+     */
     ErrorCode[ErrorCode["EBADF"] = 9] = "EBADF";
+    /**
+     * Permission denied
+     */
     ErrorCode[ErrorCode["EACCES"] = 13] = "EACCES";
+    /**
+     * Resource busy or locked
+     */
     ErrorCode[ErrorCode["EBUSY"] = 16] = "EBUSY";
+    /**
+     * File exists
+     */
     ErrorCode[ErrorCode["EEXIST"] = 17] = "EEXIST";
+    /**
+     * File is not a directory
+     */
     ErrorCode[ErrorCode["ENOTDIR"] = 20] = "ENOTDIR";
+    /**
+     * File is a directory
+     */
     ErrorCode[ErrorCode["EISDIR"] = 21] = "EISDIR";
+    /**
+     * Invalid argument
+     */
     ErrorCode[ErrorCode["EINVAL"] = 22] = "EINVAL";
+    /**
+     * File is too big
+     */
     ErrorCode[ErrorCode["EFBIG"] = 27] = "EFBIG";
+    /**
+     * No space left on disk
+     */
     ErrorCode[ErrorCode["ENOSPC"] = 28] = "ENOSPC";
+    /**
+     * Cannot modify a read-only file system
+     */
     ErrorCode[ErrorCode["EROFS"] = 30] = "EROFS";
+    /**
+     * Directory is not empty
+     */
     ErrorCode[ErrorCode["ENOTEMPTY"] = 39] = "ENOTEMPTY";
+    /**
+     * Operation is not supported
+     */
     ErrorCode[ErrorCode["ENOTSUP"] = 95] = "ENOTSUP";
 })(ErrorCode = ErrorCode || (ErrorCode = {}));
 /**
@@ -54,37 +98,29 @@ export class ApiError extends Error {
         err.stack = json.stack;
         return err;
     }
-    /**
-     * Creates an ApiError object from a buffer.
-     */
-    static Derserialize(data, i = 0) {
-        const view = new DataView('buffer' in data ? data.buffer : data);
-        const dataText = decode(view.buffer.slice(i + 4, i + 4 + view.getUint32(i, true)));
-        return ApiError.fromJSON(JSON.parse(dataText));
-    }
-    static FileError(code, p) {
-        return new ApiError(code, ErrorStrings[code], p);
+    static OnPath(code, path) {
+        return new ApiError(code, ErrorStrings[code], path);
     }
     static EACCES(path) {
-        return this.FileError(ErrorCode.EACCES, path);
+        return this.OnPath(ErrorCode.EACCES, path);
     }
     static ENOENT(path) {
-        return this.FileError(ErrorCode.ENOENT, path);
+        return this.OnPath(ErrorCode.ENOENT, path);
     }
     static EEXIST(path) {
-        return this.FileError(ErrorCode.EEXIST, path);
+        return this.OnPath(ErrorCode.EEXIST, path);
     }
     static EISDIR(path) {
-        return this.FileError(ErrorCode.EISDIR, path);
+        return this.OnPath(ErrorCode.EISDIR, path);
     }
     static ENOTDIR(path) {
-        return this.FileError(ErrorCode.ENOTDIR, path);
+        return this.OnPath(ErrorCode.ENOTDIR, path);
     }
     static EPERM(path) {
-        return this.FileError(ErrorCode.EPERM, path);
+        return this.OnPath(ErrorCode.EPERM, path);
     }
     static ENOTEMPTY(path) {
-        return this.FileError(ErrorCode.ENOTEMPTY, path);
+        return this.OnPath(ErrorCode.ENOTEMPTY, path);
     }
     /**
      * Represents a ZenFS error. Passed back to applications after a failed
@@ -94,16 +130,16 @@ export class ApiError extends Error {
      * what Node returns.
      * @constructor ApiError
      * @param type The type of the error.
-     * @param [message] A descriptive error message.
+     * @param message A descriptive error message.
      */
-    constructor(type, message = ErrorStrings[type], path) {
+    constructor(errno, message = ErrorStrings[errno], path) {
         super(message);
+        this.errno = errno;
+        this.path = path;
         // Unsupported.
         this.syscall = '';
-        this.errno = type;
-        this.code = ErrorCode[type];
-        this.path = path;
-        this.message = `Error: ${this.code}: ${message}${this.path ? `, '${this.path}'` : ''}`;
+        this.code = ErrorCode[errno];
+        this.message = `${this.code}: ${message}${this.path ? `, '${this.path}'` : ''}`;
     }
     /**
      * @return A friendly error message.
@@ -120,16 +156,6 @@ export class ApiError extends Error {
             message: this.message,
         };
     }
-    /**
-     * Writes the API error into a buffer.
-     */
-    serialize(data = new Uint8Array(this.bufferSize()), i = 0) {
-        const view = new DataView('buffer' in data ? data.buffer : data), buffer = new Uint8Array(view.buffer);
-        const newData = encode(JSON.stringify(this.toJSON()));
-        buffer.set(newData);
-        view.setUint32(i, newData.byteLength, true);
-        return buffer;
-    }
     /**
      * The size of the API error in buffer-form in bytes.
      */

package/dist/FileIndex.d.ts

@@ -1,4 +1,7 @@
 import { Stats } from './stats.js';
+type ListingTree = {
+    [key: string]: ListingTree | null;
+};
 /**
  * A simple class for storing a filesystem index. Assumes that all paths passed
  * to it are *absolute* paths.
@@ -9,11 +12,11 @@ import { Stats } from './stats.js';
 export declare class FileIndex<T> {
     /**
      * Static method for constructing indices from a JSON listing.
-     * @param listing Directory listing generated by tools/XHRIndexer.coffee
+     * @param listing Directory listing generated by tools
      * @return A new FileIndex object.
      */
-    static fromListing<T>(listing: any): FileIndex<T>;
-    private _index;
+    static fromListing<T>(listing: ListingTree): FileIndex<T>;
+    protected _index: Map<string, IndexDirInode<T>>;
     /**
      * Constructs a new FileIndex.
      */
@@ -21,7 +24,7 @@ export declare class FileIndex<T> {
     /**
      * Runs the given function over all files in the index.
      */
-    fileIterator<T>(cb: (file: T | null) => void): void;
+    forEachFile(cb: (file?: T) => void): void;
     /**
      * Adds the given absolute path to the index if it is not already in the index.
      * Creates any needed parent directories.
@@ -34,7 +37,7 @@ export declare class FileIndex<T> {
      * @todo If adding fails and implicitly creates directories, we do not clean up
      *   the new empty directories.
      */
-    addPath(path: string, inode: IndexInode): boolean;
+    addPath(path: string, inode: IndexInode<T>): 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).
@@ -48,13 +51,13 @@ export declare class FileIndex<T> {
      * @todo If adding fails and implicitly creates directories, we do not clean up
      *   the new empty directories.
      */
-    addPathFast(path: string, inode: IndexInode): boolean;
+    addPathFast(path: string, inode: IndexInode<T>): boolean;
     /**
      * Removes the given path. Can be a file or a directory.
      * @return The removed item,
      *   or null if it did not exist.
      */
-    removePath(path: string): IndexInode | null;
+    removePath(path: string): IndexInode<T> | 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.
@@ -64,56 +67,49 @@ export declare class FileIndex<T> {
      * Returns the inode of the given item.
      * @return Returns null if the item does not exist.
      */
-    getInode(path: string): IndexInode | null;
+    getInode(path: string): IndexInode<T> | null;
     /**
      * Split into a (directory path, item name) pair
      */
-    private _split_path;
+    protected splitPath(p: string): string[];
 }
 /**
  * Generic interface for file/directory inodes.
  * Note that Stats objects are what we use for file inodes.
  */
-export interface IndexInode {
-    isFile(): boolean;
-    isDir(): boolean;
-    toStats(): Stats;
+export declare abstract class IndexInode<T> {
+    data?: T;
+    constructor(data?: T);
+    abstract isFile(): boolean;
+    abstract isDir(): boolean;
+    abstract toStats(): Stats;
 }
 /**
  * Inode for a file. Stores an arbitrary (filesystem-specific) data payload.
  */
-export declare class IndexFileInode<T> implements IndexInode {
-    private data;
-    constructor(data: T);
+export declare class IndexFileInode<T> extends IndexInode<T> {
     isFile(): boolean;
     isDir(): boolean;
-    getData(): T;
-    setData(data: T): void;
     toStats(): Stats;
 }
 /**
  * Inode for a directory. Currently only contains the directory listing.
  */
-export declare class IndexDirInode<T> implements IndexInode {
-    private data;
-    private _ls;
+export declare class IndexDirInode<T> extends IndexInode<T> {
     /**
-     * Constructs an inode for a directory.
+     * @internal
      */
-    constructor(data?: T | null);
+    _listing: Map<string, IndexInode<T>>;
     isFile(): boolean;
     isDir(): boolean;
-    getData(): T | null;
     /**
      * Return a Stats object for this inode.
-     * @todo Should probably remove this at some point. This isn't the
-     *       responsibility of the FileIndex.
+     * @todo Should probably remove this at some point. This isn't the responsibility of the FileIndex.
      */
-    getStats(): Stats;
+    get stats(): Stats;
     /**
      * Alias of getStats()
-     * @todo Remove this at some point. This isn't the
-     *       responsibility of the FileIndex.
+     * @todo Remove this at some point. This isn't the responsibility of the FileIndex.
      */
     toStats(): Stats;
     /**
@@ -121,12 +117,12 @@ export declare class IndexDirInode<T> implements IndexInode {
      * relative to the directory's path.
      * @return The directory listing for this directory.
      */
-    getListing(): string[];
+    get listing(): string[];
     /**
      * Returns the inode for the indicated item, or null if it does not exist.
      * @param p Name of item in this directory.
      */
-    getItem(p: string): IndexInode | null;
+    get(p: string): IndexInode<T> | 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.
@@ -135,20 +131,21 @@ export declare class IndexDirInode<T> implements IndexInode {
      *   item to add to the directory inode.
      * @return True if it was added, false if it already existed.
      */
-    addItem(p: string, inode: IndexInode): boolean;
+    add(p: string, inode: IndexInode<T>): 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.
      */
-    remItem(p: string): IndexInode | null;
+    remove(p: string): IndexInode<T> | null;
 }
 /**
  * @hidden
  */
-export declare function isIndexFileInode<T>(inode: IndexInode | null): inode is IndexFileInode<T>;
+export declare function isIndexFileInode<T>(inode?: IndexInode<T>): inode is IndexFileInode<T>;
 /**
  * @hidden
  */
-export declare function isIndexDirInode<T>(inode: IndexInode | null): inode is IndexDirInode<T>;
+export declare function isIndexDirInode<T>(inode?: IndexInode<T>): inode is IndexDirInode<T>;
+export {};