@zenfs/core 0.0.11 → 0.0.12

package/dist/emulation/promises.js

@@ -12,7 +12,7 @@ import * as constants from './constants.js';
 export { constants };
 import { FileFlag } from '../file.js';
 import { normalizePath, normalizeMode, getFdForFile, normalizeOptions, fd2file, fdMap, normalizeTime, cred, nop, resolveFS, fixError, mounts } from './shared.js';
-import { encode } from '../utils.js';
+import { decode, encode } from '../utils.js';
 /**
  * Utility for FS ops. It handles
  * - path normalization (for the first parameter to the FS op)
@@ -148,7 +148,14 @@ export function readFile(filename, arg2 = {}) {
         if (!flag.isReadable()) {
             throw new ApiError(ErrorCode.EINVAL, 'Flag passed to readFile must allow for reading.');
         }
-        return doOp('readFile', true, filename, options.encoding, flag, cred);
+        const data = yield doOp('readFile', true, filename, flag, cred);
+        switch (options.encoding) {
+            case 'utf8':
+            case 'utf-8':
+                return decode(data);
+            default:
+                return data;
+        }
     });
 }
 export function writeFile(filename, data, arg3) {
@@ -158,7 +165,11 @@ export function writeFile(filename, data, arg3) {
         if (!flag.isWriteable()) {
             throw new ApiError(ErrorCode.EINVAL, 'Flag passed to writeFile must allow for writing.');
         }
-        return doOp('writeFile', true, filename, data, options.encoding, flag, options.mode, cred);
+        if (typeof data != 'string' && !options.encoding) {
+            throw new ApiError(ErrorCode.EINVAL, 'Encoding not specified');
+        }
+        const encodedData = typeof data == 'string' ? encode(data) : data;
+        return doOp('writeFile', true, filename, encodedData, flag, options.mode, cred);
     });
 }
 export function appendFile(filename, data, arg3) {
@@ -168,7 +179,11 @@ export function appendFile(filename, data, arg3) {
         if (!flag.isAppendable()) {
             throw new ApiError(ErrorCode.EINVAL, 'Flag passed to appendFile must allow for appending.');
         }
-        return doOp('appendFile', true, filename, data, options.encoding, flag, options.mode, cred);
+        if (typeof data != 'string' && !options.encoding) {
+            throw new ApiError(ErrorCode.EINVAL, 'Encoding not specified');
+        }
+        const encodedData = typeof data == 'string' ? encode(data) : data;
+        return doOp('appendFile', true, filename, encodedData, flag, options.mode, cred);
     });
 }
 // FILE DESCRIPTOR METHODS

package/dist/emulation/sync.js

@@ -1,7 +1,7 @@
 import { ApiError, ErrorCode } from '../ApiError.js';
 import { FileFlag } from '../file.js';
 import { normalizePath, cred, getFdForFile, normalizeMode, normalizeOptions, fdMap, fd2file, normalizeTime, resolveFS, fixError, mounts } from './shared.js';
-import { encode } from '../utils.js';
+import { decode, encode } from '../utils.js';
 function doOp(...[name, resolveSymlinks, path, ...args]) {
     path = normalizePath(path);
     const { fs, path: resolvedPath } = resolveFS(resolveSymlinks && existsSync(path) ? realpathSync(path) : path);
@@ -107,7 +107,14 @@ export function readFileSync(filename, arg2 = {}) {
     if (!flag.isReadable()) {
         throw new ApiError(ErrorCode.EINVAL, 'Flag passed to readFile must allow for reading.');
     }
-    return doOp('readFileSync', true, filename, options.encoding, flag, cred);
+    const data = doOp('readFileSync', true, filename, flag, cred);
+    switch (options.encoding) {
+        case 'utf8':
+        case 'utf-8':
+            return decode(data);
+        default:
+            return data;
+    }
 }
 export function writeFileSync(filename, data, arg3) {
     const options = normalizeOptions(arg3, 'utf8', 'w', 0o644);
@@ -115,7 +122,11 @@ export function writeFileSync(filename, data, arg3) {
     if (!flag.isWriteable()) {
         throw new ApiError(ErrorCode.EINVAL, 'Flag passed to writeFile must allow for writing.');
     }
-    return doOp('writeFileSync', true, filename, data, options.encoding, flag, options.mode, cred);
+    if (typeof data != 'string' && !options.encoding) {
+        throw new ApiError(ErrorCode.EINVAL, 'Encoding not specified');
+    }
+    const encodedData = typeof data == 'string' ? encode(data) : data;
+    return doOp('writeFileSync', true, filename, encodedData, flag, options.mode, cred);
 }
 export function appendFileSync(filename, data, arg3) {
     const options = normalizeOptions(arg3, 'utf8', 'a', 0o644);
@@ -123,7 +134,11 @@ export function appendFileSync(filename, data, arg3) {
     if (!flag.isAppendable()) {
         throw new ApiError(ErrorCode.EINVAL, 'Flag passed to appendFile must allow for appending.');
     }
-    return doOp('appendFileSync', true, filename, data, options.encoding, flag, options.mode, cred);
+    if (typeof data != 'string' && !options.encoding) {
+        throw new ApiError(ErrorCode.EINVAL, 'Encoding not specified');
+    }
+    const encodedData = typeof data == 'string' ? encode(data) : data;
+    return doOp('appendFileSync', true, filename, encodedData, flag, options.mode, cred);
 }
 /**
  * Synchronous `fstat`.

package/dist/filesystem.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 import { ApiError } from './ApiError.js';
 import { Stats } from './stats.js';
 import { File, FileFlag } from './file.js';
@@ -179,43 +178,36 @@ export declare abstract class FileSystem {
     abstract truncateSync(p: string, len: number, cred: Cred): void;
     /**
      * Asynchronously reads the entire contents of a file.
-     * @param encoding If non-null, the file's contents should be decoded
-     *   into a string using that encoding. Otherwise, if encoding is null, fetch
-     *   the file's contents as a Uint8Array.
-     * If no encoding is specified, then the raw buffer is returned.
      */
-    abstract readFile(fname: string, encoding: BufferEncoding | null, flag: FileFlag, cred: Cred): Promise<FileContents>;
+    abstract readFile(fname: string, flag: FileFlag, cred: Cred): Promise<Uint8Array>;
     /**
      * Synchronously reads the entire contents of a file.
-     * @param encoding If non-null, the file's contents should be decoded
-     *   into a string using that encoding. Otherwise, if encoding is null, fetch
-     *   the file's contents as a Uint8Array.
      */
-    abstract readFileSync(fname: string, encoding: BufferEncoding | null, flag: FileFlag, cred: Cred): FileContents;
+    abstract readFileSync(fname: string, flag: FileFlag, cred: Cred): Uint8Array;
     /**
      * Asynchronously writes data to a file, replacing the file
      * if it already exists.
      *
      * The encoding option is ignored if data is a buffer.
      */
-    abstract writeFile(fname: string, data: FileContents, encoding: BufferEncoding | null, flag: FileFlag, mode: number, cred: Cred): Promise<void>;
+    abstract writeFile(fname: string, data: Uint8Array, flag: FileFlag, mode: number, cred: Cred): Promise<void>;
     /**
      * Synchronously writes data to a file, replacing the file
      * if it already exists.
      *
      * The encoding option is ignored if data is a buffer.
      */
-    abstract writeFileSync(fname: string, data: FileContents, encoding: BufferEncoding | null, flag: FileFlag, mode: number, cred: Cred): void;
+    abstract writeFileSync(fname: string, data: Uint8Array, flag: FileFlag, mode: number, cred: Cred): void;
     /**
      * Asynchronously append data to a file, creating the file if
      * it not yet exists.
      */
-    abstract appendFile(fname: string, data: FileContents, encoding: BufferEncoding | null, flag: FileFlag, mode: number, cred: Cred): Promise<void>;
+    abstract appendFile(fname: string, data: Uint8Array, flag: FileFlag, mode: number, cred: Cred): Promise<void>;
     /**
      * Synchronously append data to a file, creating the file if
      * it not yet exists.
      */
-    abstract appendFileSync(fname: string, data: FileContents, encoding: BufferEncoding | null, flag: FileFlag, mode: number, cred: Cred): void;
+    abstract appendFileSync(fname: string, data: Uint8Array, flag: FileFlag, mode: number, cred: Cred): void;
     /**
      * Asynchronous `chmod`.
      */
@@ -326,12 +318,12 @@ export declare class BaseFileSystem extends FileSystem {
     realpathSync(p: string, cred: Cred): string;
     truncate(p: string, len: number, cred: Cred): Promise<void>;
     truncateSync(p: string, len: number, cred: Cred): void;
-    readFile(fname: string, encoding: BufferEncoding | null, flag: FileFlag, cred: Cred): Promise<FileContents>;
-    readFileSync(fname: string, encoding: BufferEncoding | null, flag: FileFlag, cred: Cred): FileContents;
-    writeFile(fname: string, data: FileContents, encoding: BufferEncoding | null, flag: FileFlag, mode: number, cred: Cred): Promise<void>;
-    writeFileSync(fname: string, data: FileContents, encoding: BufferEncoding | null, flag: FileFlag, mode: number, cred: Cred): void;
-    appendFile(fname: string, data: FileContents, encoding: BufferEncoding | null, flag: FileFlag, mode: number, cred: Cred): Promise<void>;
-    appendFileSync(fname: string, data: FileContents, encoding: BufferEncoding | null, flag: FileFlag, mode: number, cred: Cred): void;
+    readFile(fname: string, flag: FileFlag, cred: Cred): Promise<Uint8Array>;
+    readFileSync(fname: string, flag: FileFlag, cred: Cred): Uint8Array;
+    writeFile(fname: string, data: Uint8Array, flag: FileFlag, mode: number, cred: Cred): Promise<void>;
+    writeFileSync(fname: string, data: Uint8Array, flag: FileFlag, mode: number, cred: Cred): void;
+    appendFile(fname: string, data: Uint8Array, flag: FileFlag, mode: number, cred: Cred): Promise<void>;
+    appendFileSync(fname: string, data: Uint8Array, flag: FileFlag, mode: number, cred: Cred): void;
     chmod(p: string, mode: number, cred: Cred): Promise<void>;
     chmodSync(p: string, mode: number, cred: Cred): void;
     chown(p: string, new_uid: number, new_gid: number, cred: Cred): Promise<void>;

package/dist/filesystem.js

@@ -13,7 +13,7 @@ var _a;
 import { ApiError, ErrorCode } from './ApiError.js';
 import { FileFlag, ActionType } from './file.js';
 import * as path from './emulation/path.js';
-import { decode, encode } from './utils.js';
+import { encode } from './utils.js';
 /**
  * Structure for a filesystem. **All** ZenFS FileSystems must implement
  * this.
@@ -317,7 +317,7 @@ export class BaseFileSystem extends FileSystem {
             fd.closeSync();
         }
     }
-    readFile(fname, encoding, flag, cred) {
+    readFile(fname, flag, cred) {
         return __awaiter(this, void 0, void 0, function* () {
             // Get file.
             const fd = yield this.open(fname, flag, 0o644, cred);
@@ -327,17 +327,14 @@ export class BaseFileSystem extends FileSystem {
                 const buf = new Uint8Array(stat.size);
                 yield fd.read(buf, 0, stat.size, 0);
                 yield fd.close();
-                if (encoding === null) {
-                    return buf;
-                }
-                return decode(buf);
+                return buf;
             }
             finally {
                 yield fd.close();
             }
         });
     }
-    readFileSync(fname, encoding, flag, cred) {
+    readFileSync(fname, flag, cred) {
         // Get file.
         const fd = this.openSync(fname, flag, 0o644, cred);
         try {
@@ -346,16 +343,13 @@ export class BaseFileSystem extends FileSystem {
             const buf = new Uint8Array(stat.size);
             fd.readSync(buf, 0, stat.size, 0);
             fd.closeSync();
-            if (encoding === null) {
-                return buf;
-            }
-            return decode(buf);
+            return buf;
         }
         finally {
             fd.closeSync();
         }
     }
-    writeFile(fname, data, encoding, flag, mode, cred) {
+    writeFile(fname, data, flag, mode, cred) {
         return __awaiter(this, void 0, void 0, function* () {
             // Get file.
             const fd = yield this.open(fname, flag, mode, cred);
@@ -371,7 +365,7 @@ export class BaseFileSystem extends FileSystem {
             }
         });
     }
-    writeFileSync(fname, data, encoding, flag, mode, cred) {
+    writeFileSync(fname, data, flag, mode, cred) {
         // Get file.
         const fd = this.openSync(fname, flag, mode, cred);
         try {
@@ -385,7 +379,7 @@ export class BaseFileSystem extends FileSystem {
             fd.closeSync();
         }
     }
-    appendFile(fname, data, encoding, flag, mode, cred) {
+    appendFile(fname, data, flag, mode, cred) {
         return __awaiter(this, void 0, void 0, function* () {
             const fd = yield this.open(fname, flag, mode, cred);
             try {
@@ -399,7 +393,7 @@ export class BaseFileSystem extends FileSystem {
             }
         });
     }
-    appendFileSync(fname, data, encoding, flag, mode, cred) {
+    appendFileSync(fname, data, flag, mode, cred) {
         const fd = this.openSync(fname, flag, mode, cred);
         try {
             if (typeof data === 'string') {

package/dist/utils.d.ts

@@ -5,6 +5,7 @@
 import { FileSystem } from './filesystem.js';
 import { Cred } from './cred.js';
 import type { BaseBackendConstructor } from './backends/backend.js';
+import type { TextEncoder as TextEncoderType, TextDecoder as TextDecoderType } from 'node:util';
 /**
  * Synchronous recursive makedir.
  * @internal
@@ -30,12 +31,13 @@ export declare const setImmediate: (callback: () => unknown) => void;
  * @internal
  */
 export declare const ROOT_NODE_ID: string;
-export declare const encode: (input?: string) => Uint8Array;
-export declare const decode: (input?: ArrayBuffer | NodeJS.ArrayBufferView, options?: {
-    stream?: boolean;
-}) => string;
+declare const textEncoder: TextEncoderType;
+export declare const encode: typeof textEncoder.encode;
+declare const textDecoder: TextDecoderType;
+export declare const decode: typeof textDecoder.decode;
 /**
  * Generates a random ID.
  * @internal
  */
 export declare function randomUUID(): string;
+export {};

package/dist/utils.js

@@ -212,8 +212,10 @@ export const setImmediate = typeof globalThis.setImmediate == 'function' ? globa
  * @internal
  */
 export const ROOT_NODE_ID = '/';
-export const encode = new globalThis.TextEncoder().encode;
-export const decode = new globalThis.TextDecoder().decode;
+const textEncoder = new globalThis.TextEncoder();
+export const encode = textEncoder.encode.bind(textEncoder);
+const textDecoder = new globalThis.TextDecoder();
+export const decode = textDecoder.decode.bind(textDecoder);
 /**
  * Generates a random ID.
  * @internal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zenfs/core",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "description": "A filesystem in your browser",
   "main": "dist/index.js",
   "types": "dist",