@zenfs/core 0.0.6 → 0.0.8

package/dist/FileIndex.js

@@ -1,5 +1,5 @@
 import { Stats, FileType } from './stats.js';
-import * as path from 'path';
+import * as path from './emulation/path.js';
 /**
  * A simple class for storing a filesystem index. Assumes that all paths passed
  * to it are *absolute* paths.
@@ -219,7 +219,7 @@ export class FileIndex {
      */
     _split_path(p) {
         const dirpath = path.dirname(p);
-        const itemname = p.substr(dirpath.length + (dirpath === '/' ? 0 : 1));
+        const itemname = p.slice(dirpath.length + (dirpath === '/' ? 0 : 1));
         return [dirpath, itemname];
     }
 }

package/dist/backends/AsyncMirror.js

@@ -11,7 +11,7 @@ var _a;
 import { SynchronousFileSystem } from '../filesystem.js';
 import { ApiError, ErrorCode } from '../ApiError.js';
 import { FileFlag, PreloadFile } from '../file.js';
-import * as path from 'path';
+import { join } from '../emulation/path.js';
 import { Cred } from '../cred.js';
 import { CreateBackend } from './backend.js';
 /**
@@ -185,7 +185,7 @@ export class AsyncMirror extends SynchronousFileSystem {
                     }
                     const files = yield this._async.readdir(p, Cred.Root);
                     for (const file of files) {
-                        yield copyItem(path.join(p, file));
+                        yield copyItem(join(p, file));
                     }
                 }), copyFile = (p, mode) => __awaiter(this, void 0, void 0, function* () {
                     const data = yield this._async.readFile(p, null, FileFlag.getFileFlag('r'), Cred.Root);

package/dist/backends/AsyncStore.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import * as path from 'path';
+import { dirname, basename, join, resolve } from '../emulation/path.js';
 import { ApiError, ErrorCode } from '../ApiError.js';
 import { W_OK, R_OK } from '../emulation/constants.js';
 import { PreloadFile, FileFlag } from '../file.js';
@@ -204,7 +204,7 @@ export class AsyncKeyValueFileSystem extends BaseFileSystem {
                 c.removeAll();
             }
             try {
-                const tx = this.store.beginTransaction('readwrite'), oldParent = path.dirname(oldPath), oldName = path.basename(oldPath), newParent = path.dirname(newPath), newName = path.basename(newPath), 
+                const tx = this.store.beginTransaction('readwrite'), oldParent = dirname(oldPath), oldName = basename(oldPath), newParent = dirname(newPath), newName = basename(newPath), 
                 // Remove oldPath from parent's directory listing.
                 oldDirNode = yield this.findINode(tx, oldParent), oldDirList = yield this.getDirListing(tx, oldParent, oldDirNode);
                 if (!oldDirNode.toStats().hasAccess(W_OK, cred)) {
@@ -350,7 +350,7 @@ export class AsyncKeyValueFileSystem extends BaseFileSystem {
             //       update is required.
             const tx = this.store.beginTransaction('readwrite'), 
             // We use the _findInode helper because we actually need the INode id.
-            fileInodeId = yield this._findINode(tx, path.dirname(p), path.basename(p)), fileInode = yield this.getINode(tx, p, fileInodeId), inodeChanged = fileInode.update(stats);
+            fileInodeId = yield this._findINode(tx, dirname(p), basename(p)), fileInode = yield this.getINode(tx, p, fileInodeId), inodeChanged = fileInode.update(stats);
             try {
                 // Sync data.
                 yield tx.put(fileInode.id, data, true);
@@ -393,7 +393,7 @@ export class AsyncKeyValueFileSystem extends BaseFileSystem {
      */
     _findINode(tx, parent, filename, visited = new Set()) {
         return __awaiter(this, void 0, void 0, function* () {
-            const currentPath = path.posix.join(parent, filename);
+            const currentPath = join(parent, filename);
             if (visited.has(currentPath)) {
                 throw new ApiError(ErrorCode.EIO, 'Infinite loop detected while finding inode', currentPath);
             }
@@ -424,7 +424,7 @@ export class AsyncKeyValueFileSystem extends BaseFileSystem {
                         return id;
                     }
                     else {
-                        throw ApiError.ENOENT(path.resolve(parent, filename));
+                        throw ApiError.ENOENT(resolve(parent, filename));
                     }
                 }
             }
@@ -441,7 +441,7 @@ export class AsyncKeyValueFileSystem extends BaseFileSystem {
                     return id;
                 }
                 else {
-                    throw ApiError.ENOENT(path.resolve(parent, filename));
+                    throw ApiError.ENOENT(resolve(parent, filename));
                 }
             }
         });
@@ -453,7 +453,7 @@ export class AsyncKeyValueFileSystem extends BaseFileSystem {
      */
     findINode(tx, p, visited = new Set()) {
         return __awaiter(this, void 0, void 0, function* () {
-            const id = yield this._findINode(tx, path.dirname(p), path.basename(p), visited);
+            const id = yield this._findINode(tx, dirname(p), basename(p), visited);
             return this.getINode(tx, p, id);
         });
     }
@@ -532,7 +532,7 @@ export class AsyncKeyValueFileSystem extends BaseFileSystem {
      */
     commitNewFile(tx, p, type, mode, cred, data) {
         return __awaiter(this, void 0, void 0, function* () {
-            const parentDir = path.dirname(p), fname = path.basename(p), parentNode = yield this.findINode(tx, parentDir), dirListing = yield this.getDirListing(tx, parentDir, parentNode), currTime = new Date().getTime();
+            const parentDir = dirname(p), fname = basename(p), parentNode = yield this.findINode(tx, parentDir), dirListing = yield this.getDirListing(tx, parentDir, parentNode), currTime = new Date().getTime();
             //Check that the creater has correct access
             if (!parentNode.toStats().hasAccess(W_OK, cred)) {
                 throw ApiError.EACCES(p);
@@ -583,7 +583,7 @@ export class AsyncKeyValueFileSystem extends BaseFileSystem {
             if (this._cache) {
                 this._cache.remove(p);
             }
-            const tx = this.store.beginTransaction('readwrite'), parent = path.dirname(p), parentNode = yield this.findINode(tx, parent), parentListing = yield this.getDirListing(tx, parent, parentNode), fileName = path.basename(p);
+            const tx = this.store.beginTransaction('readwrite'), parent = dirname(p), parentNode = yield this.findINode(tx, parent), parentListing = yield this.getDirListing(tx, parent, parentNode), fileName = basename(p);
             if (!parentListing[fileName]) {
                 throw ApiError.ENOENT(p);
             }

package/dist/backends/FolderAdapter.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 var _a;
 import { BaseFileSystem } from '../filesystem.js';
-import * as path from 'path';
+import { relative, join } from '../emulation/path.js';
 import { ApiError } from '../ApiError.js';
 import { Cred } from '../cred.js';
 import { CreateBackend } from './backend.js';
@@ -80,7 +80,7 @@ function translateError(folder, e) {
         const err = e;
         let p = err.path;
         if (p) {
-            p = '/' + path.relative(folder, p);
+            p = '/' + relative(folder, p);
             err.message = err.message.replace(err.path, p);
             err.path = p;
         }
@@ -112,10 +112,10 @@ function wrapFunction(name, wrapFirst, wrapSecond) {
         return function () {
             if (arguments.length > 0) {
                 if (wrapFirst) {
-                    arguments[0] = path.join(this._folder, arguments[0]);
+                    arguments[0] = join(this._folder, arguments[0]);
                 }
                 if (wrapSecond) {
-                    arguments[1] = path.join(this._folder, arguments[1]);
+                    arguments[1] = join(this._folder, arguments[1]);
                 }
                 arguments[arguments.length - 1] = wrapCallback(this._folder, arguments[arguments.length - 1]);
             }
@@ -127,10 +127,10 @@ function wrapFunction(name, wrapFirst, wrapSecond) {
         return function () {
             try {
                 if (wrapFirst) {
-                    arguments[0] = path.join(this._folder, arguments[0]);
+                    arguments[0] = join(this._folder, arguments[0]);
                 }
                 if (wrapSecond) {
-                    arguments[1] = path.join(this._folder, arguments[1]);
+                    arguments[1] = join(this._folder, arguments[1]);
                 }
                 return this._wrapped[name].apply(this._wrapped, arguments);
             }

package/dist/backends/OverlayFS.js

@@ -13,7 +13,7 @@ import { ApiError, ErrorCode } from '../ApiError.js';
 import { FileFlag, ActionType, PreloadFile } from '../file.js';
 import { Stats } from '../stats.js';
 import LockedFS from './Locked.js';
-import * as path from 'path';
+import { resolve, dirname } from '../emulation/path.js';
 import { Cred } from '../cred.js';
 import { CreateBackend } from './backend.js';
 /**
@@ -187,7 +187,7 @@ export class UnlockedOverlayFS extends BaseFileSystem {
                 if (yield this._readable.exists(oldPath, cred)) {
                     for (const name of yield this._readable.readdir(oldPath, cred)) {
                         // Recursion! Should work for any nested files / folders.
-                        yield this.rename(path.resolve(oldPath, name), path.resolve(newPath, name), cred);
+                        yield this.rename(resolve(oldPath, name), resolve(newPath, name), cred);
                     }
                 }
             }
@@ -242,7 +242,7 @@ export class UnlockedOverlayFS extends BaseFileSystem {
             if (this._readable.existsSync(oldPath, cred)) {
                 this._readable.readdirSync(oldPath, cred).forEach(name => {
                     // Recursion! Should work for any nested files / folders.
-                    this.renameSync(path.resolve(oldPath, name), path.resolve(newPath, name), cred);
+                    this.renameSync(resolve(oldPath, name), resolve(newPath, name), cred);
                 });
             }
         }
@@ -622,10 +622,10 @@ export class UnlockedOverlayFS extends BaseFileSystem {
      * should they not exist. Use modes from the read-only storage.
      */
     createParentDirectories(p, cred) {
-        let parent = path.dirname(p), toCreate = [];
+        let parent = dirname(p), toCreate = [];
         while (!this._writable.existsSync(parent, cred)) {
             toCreate.push(parent);
-            parent = path.dirname(parent);
+            parent = dirname(parent);
         }
         toCreate = toCreate.reverse();
         for (const p of toCreate) {
@@ -634,10 +634,10 @@ export class UnlockedOverlayFS extends BaseFileSystem {
     }
     createParentDirectoriesAsync(p, cred) {
         return __awaiter(this, void 0, void 0, function* () {
-            let parent = path.dirname(p), toCreate = [];
+            let parent = dirname(p), toCreate = [];
             while (!(yield this._writable.exists(parent, cred))) {
                 toCreate.push(parent);
-                parent = path.dirname(parent);
+                parent = dirname(parent);
             }
             toCreate = toCreate.reverse();
             for (const p of toCreate) {

package/dist/backends/SyncStore.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" resolution-mode="require"/>
 import { Cred } from '../cred.js';
-import { File, FileFlag, PreloadFile } from '../file.js';
+import { FileFlag, PreloadFile } from '../file.js';
 import { SynchronousFileSystem } from '../filesystem.js';
 import { Stats } from '../stats.js';
 /**
@@ -126,7 +126,7 @@ export interface SyncKeyValueFileSystemOptions {
      */
     supportLinks?: boolean;
 }
-export declare class SyncKeyValueFile extends PreloadFile<SyncKeyValueFileSystem> implements File {
+export declare class SyncKeyValueFile extends PreloadFile<SyncKeyValueFileSystem> {
     constructor(_fs: SyncKeyValueFileSystem, _path: string, _flag: FileFlag, _stat: Stats, contents?: Buffer);
     syncSync(): void;
     closeSync(): void;
@@ -156,8 +156,8 @@ export declare class SyncKeyValueFileSystem extends SynchronousFileSystem {
     accessSync(p: string, mode: number, cred: Cred): void;
     renameSync(oldPath: string, newPath: string, cred: Cred): void;
     statSync(p: string, cred: Cred): Stats;
-    createFileSync(p: string, flag: FileFlag, mode: number, cred: Cred): File;
-    openFileSync(p: string, flag: FileFlag, cred: Cred): File;
+    createFileSync(p: string, flag: FileFlag, mode: number, cred: Cred): SyncKeyValueFile;
+    openFileSync(p: string, flag: FileFlag, cred: Cred): SyncKeyValueFile;
     unlinkSync(p: string, cred: Cred): void;
     rmdirSync(p: string, cred: Cred): void;
     mkdirSync(p: string, mode: number, cred: Cred): void;

package/dist/backends/SyncStore.js

@@ -1,4 +1,4 @@
-import * as path from 'path';
+import { dirname, basename, join, resolve, sep } from '../emulation/path.js';
 import { ApiError, ErrorCode } from '../ApiError.js';
 import { W_OK, R_OK } from '../emulation/constants.js';
 import { FileFlag, PreloadFile } from '../file.js';
@@ -143,7 +143,7 @@ export class SyncKeyValueFileSystem extends SynchronousFileSystem {
         }
     }
     renameSync(oldPath, newPath, cred) {
-        const tx = this.store.beginTransaction('readwrite'), oldParent = path.dirname(oldPath), oldName = path.basename(oldPath), newParent = path.dirname(newPath), newName = path.basename(newPath), 
+        const tx = this.store.beginTransaction('readwrite'), oldParent = dirname(oldPath), oldName = basename(oldPath), newParent = dirname(newPath), newName = basename(newPath), 
         // Remove oldPath from parent's directory listing.
         oldDirNode = this.findINode(tx, oldParent), oldDirList = this.getDirListing(tx, oldParent, oldDirNode);
         if (!oldDirNode.toStats().hasAccess(W_OK, cred)) {
@@ -263,7 +263,7 @@ export class SyncKeyValueFileSystem extends SynchronousFileSystem {
         //       update is required.
         const tx = this.store.beginTransaction('readwrite'), 
         // We use the _findInode helper because we actually need the INode id.
-        fileInodeId = this._findINode(tx, path.dirname(p), path.basename(p)), fileInode = this.getINode(tx, p, fileInodeId), inodeChanged = fileInode.update(stats);
+        fileInodeId = this._findINode(tx, dirname(p), basename(p)), fileInode = this.getINode(tx, p, fileInodeId), inodeChanged = fileInode.update(stats);
         try {
             // Sync data.
             tx.put(fileInode.id, data, true);
@@ -303,7 +303,7 @@ export class SyncKeyValueFileSystem extends SynchronousFileSystem {
      * @return string The ID of the file's inode in the file system.
      */
     _findINode(tx, parent, filename, visited = new Set()) {
-        const currentPath = path.posix.join(parent, filename);
+        const currentPath = join(parent, filename);
         if (visited.has(currentPath)) {
             throw new ApiError(ErrorCode.EIO, 'Infinite loop detected while finding inode', currentPath);
         }
@@ -316,7 +316,7 @@ export class SyncKeyValueFileSystem extends SynchronousFileSystem {
                 return dirList[filename];
             }
             else {
-                throw ApiError.ENOENT(path.resolve(parent, filename));
+                throw ApiError.ENOENT(resolve(parent, filename));
             }
         };
         if (parent === '/') {
@@ -330,7 +330,7 @@ export class SyncKeyValueFileSystem extends SynchronousFileSystem {
             }
         }
         else {
-            return readDirectory(this.getINode(tx, parent + path.sep + filename, this._findINode(tx, path.dirname(parent), path.basename(parent), visited)));
+            return readDirectory(this.getINode(tx, parent + sep + filename, this._findINode(tx, dirname(parent), basename(parent), visited)));
         }
     }
     /**
@@ -340,7 +340,7 @@ export class SyncKeyValueFileSystem extends SynchronousFileSystem {
      * @todo memoize/cache
      */
     findINode(tx, p) {
-        return this.getINode(tx, p, this._findINode(tx, path.dirname(p), path.basename(p)));
+        return this.getINode(tx, p, this._findINode(tx, dirname(p), basename(p)));
     }
     /**
      * Given the ID of a node, retrieves the corresponding Inode.
@@ -400,7 +400,7 @@ export class SyncKeyValueFileSystem extends SynchronousFileSystem {
      * @return The Inode for the new file.
      */
     commitNewFile(tx, p, type, mode, cred, data) {
-        const parentDir = path.dirname(p), fname = path.basename(p), parentNode = this.findINode(tx, parentDir), dirListing = this.getDirListing(tx, parentDir, parentNode), currTime = new Date().getTime();
+        const parentDir = dirname(p), fname = basename(p), parentNode = this.findINode(tx, parentDir), dirListing = this.getDirListing(tx, parentDir, parentNode), currTime = new Date().getTime();
         //Check that the creater has correct access
         if (!parentNode.toStats().hasAccess(0b0100 /* Write */, cred)) {
             throw ApiError.EACCES(p);
@@ -440,7 +440,7 @@ export class SyncKeyValueFileSystem extends SynchronousFileSystem {
      * @todo Update mtime.
      */
     removeEntry(p, isDir, cred) {
-        const tx = this.store.beginTransaction('readwrite'), parent = path.dirname(p), parentNode = this.findINode(tx, parent), parentListing = this.getDirListing(tx, parent, parentNode), fileName = path.basename(p);
+        const tx = this.store.beginTransaction('readwrite'), parent = dirname(p), parentNode = this.findINode(tx, parent), parentListing = this.getDirListing(tx, parent, parentNode), fileName = basename(p);
         if (!parentListing[fileName]) {
             throw ApiError.ENOENT(p);
         }

package/dist/backends/backend.d.ts

@@ -18,9 +18,10 @@ export interface BackendOption<T> {
     description: string;
     /**
      * A custom validation function to check if the option is valid.
-     * Resolves if valid and rejects if not.
+     * When async, resolves if valid and rejects if not.
+     * When sync, it will throw an error if not valid.
      */
-    validator?(opt: T): Promise<void>;
+    validator?(opt: T): void | Promise<void>;
 }
 /**
  * Describes all of the options available in a file system.