@zenfs/core 0.4.2 → 0.5.0

package/dist/config.js

@@ -1,5 +1,4 @@
 import { isBackend, resolveBackendConfig } from './backends/backend.js';
-import { Cred } from './cred.js';
 import * as fs from './emulation/index.js';
 import { setCred } from './emulation/shared.js';
 import { FileSystem } from './filesystem.js';
@@ -7,7 +6,7 @@ import { FileSystem } from './filesystem.js';
  * Initializes ZenFS with the given file systems.
  */
 export function initialize(mounts, uid = 0, gid = 0) {
-    setCred(new Cred(uid, gid, uid, gid, uid, gid));
+    setCred({ uid, gid, suid: uid, sgid: gid, euid: uid, egid: gid });
     fs.initialize(mounts);
 }
 /**

package/dist/cred.d.ts

@@ -2,13 +2,12 @@
  * Credentials used for various operations.
  * Similar to Linux's cred struct. See https://github.com/torvalds/linux/blob/master/include/linux/cred.h
  */
-export declare class Cred {
+export interface Cred {
     uid: number;
     gid: number;
     suid: number;
     sgid: number;
     euid: number;
     egid: number;
-    constructor(uid: number, gid: number, suid: number, sgid: number, euid: number, egid: number);
-    static Root: Cred;
 }
+export declare const rootCred: Cred;

package/dist/cred.js

@@ -1,15 +1,8 @@
-/**
- * Credentials used for various operations.
- * Similar to Linux's cred struct. See https://github.com/torvalds/linux/blob/master/include/linux/cred.h
- */
-export class Cred {
-    constructor(uid, gid, suid, sgid, euid, egid) {
-        this.uid = uid;
-        this.gid = gid;
-        this.suid = suid;
-        this.sgid = sgid;
-        this.euid = euid;
-        this.egid = egid;
-    }
-}
-Cred.Root = new Cred(0, 0, 0, 0, 0, 0);
+export const rootCred = {
+    uid: 0,
+    gid: 0,
+    suid: 0,
+    sgid: 0,
+    euid: 0,
+    egid: 0,
+};

package/dist/emulation/promises.js

@@ -1,6 +1,6 @@
 import { ApiError, ErrorCode } from '../ApiError.js';
 export * as constants from './constants.js';
-import { ActionType, FileFlag } from '../file.js';
+import { ActionType, isReadable, isWriteable, isAppendable, parseFlag, pathExistsAction, pathNotExistsAction } from '../file.js';
 import { normalizePath, normalizeMode, getFdForFile, normalizeOptions, fd2file, fdMap, normalizeTime, cred, nop, resolveFS, fixError, mounts } from './shared.js';
 import { BigIntStats, FileType } from '../stats.js';
 import { decode, encode } from '../utils.js';
@@ -248,9 +248,9 @@ unlink;
  * @internal
  */
 async function _open(_path, _flag, _mode = 0o644, resolveSymlinks) {
-    const path = normalizePath(_path), mode = normalizeMode(_mode, 0o644), flag = FileFlag.Get(_flag);
+    const path = normalizePath(_path), mode = normalizeMode(_mode, 0o644), flag = parseFlag(_flag);
     try {
-        switch (flag.pathExistsAction()) {
+        switch (pathExistsAction(flag)) {
             case ActionType.THROW:
                 throw ApiError.EEXIST(path);
             case ActionType.TRUNCATE:
@@ -275,7 +275,7 @@ async function _open(_path, _flag, _mode = 0o644, resolveSymlinks) {
         }
     }
     catch (e) {
-        switch (flag.pathNotExistsAction()) {
+        switch (pathNotExistsAction(flag)) {
             case ActionType.CREATE:
                 // Ensure parent exists.
                 const parentStats = await doOp('stat', resolveSymlinks, dirname(path), cred);
@@ -327,8 +327,8 @@ async function _readFile(fname, flag, resolveSymlinks) {
 }
 export async function readFile(filename, _options) {
     const options = normalizeOptions(_options, null, 'r', null);
-    const flag = FileFlag.Get(options.flag);
-    if (!flag.isReadable()) {
+    const flag = parseFlag(options.flag);
+    if (!isReadable(flag)) {
         throw new ApiError(ErrorCode.EINVAL, 'Flag passed must allow for reading.');
     }
     const data = await _readFile(filename, options.flag, true);
@@ -363,8 +363,8 @@ async function _writeFile(fname, data, flag, mode, resolveSymlinks) {
  */
 export async function writeFile(filename, data, _options) {
     const options = normalizeOptions(_options, 'utf8', 'w', 0o644);
-    const flag = FileFlag.Get(options.flag);
-    if (!flag.isWriteable()) {
+    const flag = parseFlag(options.flag);
+    if (!isWriteable(flag)) {
         throw new ApiError(ErrorCode.EINVAL, 'Flag passed must allow for writing.');
     }
     if (typeof data != 'string' && !options.encoding) {
@@ -399,8 +399,8 @@ async function _appendFile(fname, data, flag, mode, resolveSymlinks) {
  */
 export async function appendFile(filename, data, _options) {
     const options = normalizeOptions(_options, 'utf8', 'a', 0o644);
-    const flag = FileFlag.Get(options.flag);
-    if (!flag.isAppendable()) {
+    const flag = parseFlag(options.flag);
+    if (!isAppendable(flag)) {
         throw new ApiError(ErrorCode.EINVAL, 'Flag passed to appendFile must allow for appending.');
     }
     if (typeof data != 'string' && !options.encoding) {

package/dist/emulation/shared.js

@@ -1,7 +1,7 @@
 // Utilities and shared data
 import { resolve } from './path.js';
 import { ApiError, ErrorCode } from '../ApiError.js';
-import { Cred } from '../cred.js';
+import { rootCred } from '../cred.js';
 import { InMemory } from '../backends/InMemory.js';
 /**
  * converts Date or number to a integer UNIX timestamp
@@ -109,7 +109,7 @@ export function nop() {
     // do nothing
 }
 // credentials
-export let cred = Cred.Root;
+export let cred = rootCred;
 export function setCred(val) {
     cred = val;
 }

package/dist/emulation/sync.js

@@ -1,5 +1,5 @@
 import { ApiError, ErrorCode } from '../ApiError.js';
-import { ActionType, FileFlag } from '../file.js';
+import { ActionType, isAppendable, isReadable, isWriteable, parseFlag, pathExistsAction, pathNotExistsAction } from '../file.js';
 import { BigIntStats, FileType } from '../stats.js';
 import { normalizePath, cred, getFdForFile, normalizeMode, normalizeOptions, fdMap, fd2file, normalizeTime, resolveFS, fixError, mounts, } from './shared.js';
 import { decode, encode } from '../utils.js';
@@ -92,7 +92,7 @@ export function unlinkSync(path) {
 }
 unlinkSync;
 function _openSync(_path, _flag, _mode, resolveSymlinks) {
-    const path = normalizePath(_path), mode = normalizeMode(_mode, 0o644), flag = FileFlag.Get(_flag);
+    const path = normalizePath(_path), mode = normalizeMode(_mode, 0o644), flag = parseFlag(_flag);
     // Check if the path exists, and is a file.
     let stats;
     try {
@@ -100,7 +100,7 @@ function _openSync(_path, _flag, _mode, resolveSymlinks) {
     }
     catch (e) {
         // File does not exist.
-        switch (flag.pathNotExistsAction()) {
+        switch (pathNotExistsAction(flag)) {
             case ActionType.CREATE:
                 // Ensure parent exists.
                 const parentStats = doOp('statSync', resolveSymlinks, dirname(path), cred);
@@ -118,7 +118,7 @@ function _openSync(_path, _flag, _mode, resolveSymlinks) {
         throw ApiError.EACCES(path);
     }
     // File exists.
-    switch (flag.pathExistsAction()) {
+    switch (pathExistsAction(flag)) {
         case ActionType.THROW:
             throw ApiError.EEXIST(path);
         case ActionType.TRUNCATE:
@@ -176,8 +176,8 @@ function _readFileSync(fname, flag, resolveSymlinks) {
 }
 export function readFileSync(filename, arg2 = {}) {
     const options = normalizeOptions(arg2, null, 'r', 0o644);
-    const flag = FileFlag.Get(options.flag);
-    if (!flag.isReadable()) {
+    const flag = parseFlag(options.flag);
+    if (!isReadable(flag)) {
         throw new ApiError(ErrorCode.EINVAL, 'Flag passed to readFile must allow for reading.');
     }
     const data = _readFileSync(filename, options.flag, true);
@@ -201,8 +201,8 @@ function _writeFileSync(fname, data, flag, mode, resolveSymlinks) {
 }
 export function writeFileSync(filename, data, _options) {
     const options = normalizeOptions(_options, 'utf8', 'w', 0o644);
-    const flag = FileFlag.Get(options.flag);
-    if (!flag.isWriteable()) {
+    const flag = parseFlag(options.flag);
+    if (!isWriteable(flag)) {
         throw new ApiError(ErrorCode.EINVAL, 'Flag passed to writeFile must allow for writing.');
     }
     if (typeof data != 'string' && !options.encoding) {
@@ -230,8 +230,8 @@ function _appendFileSync(fname, data, flag, mode, resolveSymlinks) {
 }
 export function appendFileSync(filename, data, arg3) {
     const options = normalizeOptions(arg3, 'utf8', 'a', 0o644);
-    const flag = FileFlag.Get(options.flag);
-    if (!flag.isAppendable()) {
+    const flag = parseFlag(options.flag);
+    if (!isAppendable(flag)) {
         throw new ApiError(ErrorCode.EINVAL, 'Flag passed to appendFile must allow for appending.');
     }
     if (typeof data != 'string' && !options.encoding) {

package/dist/file.d.ts

@@ -26,102 +26,18 @@ export declare enum ActionType {
     TRUNCATE = 2,
     CREATE = 3
 }
-/**
- * Represents one of the following file flags. A convenience object.
- *
- * - r: 	Open file for reading. An exception occurs if the file does not exist.
- * - r+: 	Open file for reading and writing. An exception occurs if the file does not exist.
- * - rs: 	Open file for reading in synchronous mode. Instructs the filesystem to not cache writes.
- * - rs+: 	Open file for reading and writing, and opens the file in synchronous mode.
- * - w: 	Open file for writing. The file is created (if it does not exist) or truncated (if it exists).
- * - wx: 	Like 'w' but opens the file in exclusive mode.
- * - w+: 	Open file for reading and writing. The file is created (if it does not exist) or truncated (if it exists).
- * - wx+: 	Like 'w+' but opens the file in exclusive mode.
- * - a: 	Open file for appending. The file is created if it does not exist.
- * - ax: 	Like 'a' but opens the file in exclusive mode.
- * - a+: 	Open file for reading and appending. The file is created if it does not exist.
- * - ax+: 	Like 'a+' but opens the file in exclusive mode.
- *
- * Exclusive mode ensures that the file path is newly created.
- */
-export declare class FileFlag {
-    /**
-     * Contains cached FileMode instances.
-     */
-    protected static cache: Map<string | number, FileFlag>;
-    /**
-     * Array of valid mode strings.
-     */
-    protected static validStrings: string[];
-    /**
-     * Get an object representing the given file flag.
-     * @param flag The string or number representing the flag
-     * @return The FileFlag object representing the flag
-     * @throw when the flag string is invalid
-     */
-    static Get(flag: string | number): FileFlag;
-    protected _flag: string;
-    /**
-     * @param flag The string or number representing the flag
-     * @throw when the flag is invalid
-     */
-    protected constructor(flag: string | number);
-    /**
-     * @param flag The number representing the flag
-     * @returns The string representing the flag
-     * @throws when the flag number is invalid
-     */
-    static StringOf(flag: number): string;
-    /**
-     * @param flag The string representing the flag
-     * @returns The number representing the flag
-     * @throws when the flag string is invalid
-     */
-    static NumberOf(flag: string): number;
-    /**
-     * Get the underlying flag string for this flag.
-     */
-    toString(): string;
-    /**
-     * Get the equivalent mode (0b0xxx: read, write, execute)
-     * Note: Execute will always be 0
-     */
-    get mode(): number;
-    /**
-     * Returns true if the file is readable.
-     */
-    isReadable(): boolean;
-    /**
-     * Returns true if the file is writeable.
-     */
-    isWriteable(): boolean;
-    /**
-     * Returns true if the file mode should truncate.
-     */
-    isTruncating(): boolean;
-    /**
-     * Returns true if the file is appendable.
-     */
-    isAppendable(): boolean;
-    /**
-     * Returns true if the file is open in synchronous mode.
-     */
-    isSynchronous(): boolean;
-    /**
-     * Returns true if the file is open in exclusive mode.
-     */
-    isExclusive(): boolean;
-    /**
-     * Returns one of the static fields on this object that indicates the
-     * appropriate response to the path existing.
-     */
-    pathExistsAction(): ActionType;
-    /**
-     * Returns one of the static fields on this object that indicates the
-     * appropriate response to the path not existing.
-     */
-    pathNotExistsAction(): ActionType;
-}
+export declare function parseFlag(flag: string | number): string;
+export declare function flagToString(flag: number): string;
+export declare function flagToNumber(flag: string): number;
+export declare function flagToMode(flag: string): number;
+export declare function isReadable(flag: string): boolean;
+export declare function isWriteable(flag: string): boolean;
+export declare function isTruncating(flag: string): boolean;
+export declare function isAppendable(flag: string): boolean;
+export declare function isSynchronous(flag: string): boolean;
+export declare function isExclusive(flag: string): boolean;
+export declare function pathExistsAction(flag: string): ActionType;
+export declare function pathNotExistsAction(flag: string): ActionType;
 export declare abstract class File {
     /**
      * Get the current file position.
@@ -281,7 +197,7 @@ export declare abstract class PreloadFile<FS extends FileSystem> extends File {
      * Path to the file
      */
     readonly path: string;
-    readonly flag: FileFlag;
+    readonly flag: string;
     readonly stats: Stats;
     protected _buffer: Uint8Array;
     protected _position: number;
@@ -306,7 +222,7 @@ export declare abstract class PreloadFile<FS extends FileSystem> extends File {
     /**
      * Path to the file
      */
-    path: string, flag: FileFlag, stats: Stats, _buffer?: Uint8Array);
+    path: string, flag: string, stats: Stats, _buffer?: Uint8Array);
     /**
      * Get the underlying buffer for this file. Mutating not recommended and will mess up dirty tracking.
      */
@@ -434,7 +350,7 @@ export declare abstract class PreloadFile<FS extends FileSystem> extends File {
  * For synchronous file systems
  */
 export declare class SyncFile<FS extends FileSystem> extends PreloadFile<FS> {
-    constructor(_fs: FS, _path: string, _flag: FileFlag, _stat: Stats, contents?: Uint8Array);
+    constructor(_fs: FS, _path: string, _flag: string, _stat: Stats, contents?: Uint8Array);
     sync(): Promise<void>;
     syncSync(): void;
     close(): Promise<void>;
@@ -444,7 +360,7 @@ export declare class SyncFile<FS extends FileSystem> extends PreloadFile<FS> {
  * For the filesystems which do not sync to anything..
  */
 export declare class NoSyncFile<T extends FileSystem> extends PreloadFile<T> {
-    constructor(_fs: T, _path: string, _flag: FileFlag, _stat: Stats, contents?: Uint8Array);
+    constructor(_fs: T, _path: string, _flag: string, _stat: Stats, contents?: Uint8Array);
     /**
      * Asynchronous sync. Doesn't do anything, simply calls the cb.
      */