@zenfs/core 1.9.5 → 1.10.1

package/dist/internal/index_fs.d.ts

@@ -1,7 +1,7 @@
 import { Stats } from '../stats.js';
 import { type File } from './file.js';
 import { Index } from './file_index.js';
-import { FileSystem, type CreationOptions, type PureCreationOptions } from './filesystem.js';
+import { FileSystem, type CreationOptions, type PureCreationOptions, type UsageInfo } from './filesystem.js';
 import { Inode, type InodeLike } from './inode.js';
 /**
  * A file system that uses an `Index` for metadata.
@@ -11,6 +11,7 @@ import { Inode, type InodeLike } from './inode.js';
 export declare abstract class IndexFS extends FileSystem {
     readonly index: Index;
     constructor(id: number, name: string, index?: Index);
+    usage(): UsageInfo;
     /**
      * @deprecated
      */

package/dist/internal/index_fs.js

@@ -18,6 +18,9 @@ export class IndexFS extends FileSystem {
         super(id, name);
         this.index = index;
     }
+    usage() {
+        return this.index.usage();
+    }
     /* node:coverage disable */
     /**
      * @deprecated

package/dist/internal/inode.d.ts

@@ -21,6 +21,14 @@ export interface InodeLike extends StatsLike<number>, InodeFields {
  * @internal @hidden
  */
 export declare const _inode_fields: readonly ["ino", "data", "size", "mode", "flags", "nlink", "uid", "gid", "atimeMs", "birthtimeMs", "mtimeMs", "ctimeMs"];
+/**
+ * Represents which version of the `Inode` format we are on.
+ * 1. 58 bytes. The first member was called `ino` but used as the ID for data.
+ * 2. 66 bytes. Renamed the first member from `ino` to `data` and added a separate `ino` field
+ * 3. (current) 72 bytes. Changed the ID fields from 64 to 32 bits and added `flags`.
+ * @internal @hidden
+ */
+export declare const _inode_version = 3;
 /**
  * Generic inode definition that can easily be serialized.
  * @category Internals

package/dist/internal/inode.js

@@ -49,6 +49,14 @@ export const rootIno = 0;
  * @internal @hidden
  */
 export const _inode_fields = ['ino', 'data', 'size', 'mode', 'flags', 'nlink', 'uid', 'gid', 'atimeMs', 'birthtimeMs', 'mtimeMs', 'ctimeMs'];
+/**
+ * Represents which version of the `Inode` format we are on.
+ * 1. 58 bytes. The first member was called `ino` but used as the ID for data.
+ * 2. 66 bytes. Renamed the first member from `ino` to `data` and added a separate `ino` field
+ * 3. (current) 72 bytes. Changed the ID fields from 64 to 32 bits and added `flags`.
+ * @internal @hidden
+ */
+export const _inode_version = 3;
 /**
  * Generic inode definition that can easily be serialized.
  * @category Internals

package/dist/internal/log.d.ts

@@ -88,16 +88,17 @@ export declare function log_deprecated(symbol: string): void;
  */
 export declare const formats: {
     /** Format with a timestamp and the level, colorized with ANSI escape codes */
-    readonly ansi_level: (this: void, entry: Entry) => string;
+    readonly ansi_level: (this: void, entry: Entry) => string[];
     /**
      * Format with a timestamp and colorize the message with ANSI escape codes.
      * For EMERG and ALERT, the levels are included
      */
     readonly ansi_message: (this: void, entry: Entry) => string;
-    /** Uncolored format with a timestamp */
+    readonly css_level: (this: void, entry: Entry) => string[];
+    readonly css_message: (this: void, entry: Entry) => string[];
     readonly default: (this: void, entry: Entry) => string;
 };
-export declare function format(entry: Entry): string;
+export declare function format(entry: Entry): string[];
 /** Whether log entries are being recorded */
 export declare let isEnabled: boolean;
 export interface LogConfiguration {
@@ -115,12 +116,12 @@ export interface LogConfiguration {
      * Formats a log entry into a string
      * @default `[${ms / 1000}] ${message}`
      */
-    format?(this: void, entry: Entry): string;
+    format?(this: void, entry: Entry): string | string[];
     /**
      * Outputs a log message
      * @default console.error()
      */
-    output?(this: void, message: string): unknown;
+    output?(this: void, ...message: string[]): unknown;
     /**
      * If set, output() all current entries after `configure` is done
      * @default false

package/dist/internal/log.js

@@ -97,9 +97,16 @@ export function log_deprecated(symbol) {
 function ansi(text, format) {
     return `\x1b[${format}m${text}\x1b[0m`;
 }
-function _prettyMs(entry, useANSI = false) {
+function _prettyMs(entry, style) {
     const text = '[' + (entry.elapsedMs / 1000).toFixed(3).padStart(10) + '] ';
-    return useANSI ? ansi(text, '2;37') : text;
+    switch (style) {
+        case 'ansi':
+            return ansi(text, '2;37');
+        case 'css':
+            return ['%c' + text, 'opacity: 0.8; color: white;'];
+        default:
+            return text;
+    }
 }
 const _ansiLevelColor = {
     [Level.EMERG]: '1;4;37;41',
@@ -121,6 +128,26 @@ const _ansiMessageColor = {
     [Level.INFO]: '37',
     [Level.DEBUG]: '2;37',
 };
+const _cssLevelColor = {
+    [Level.EMERG]: 'font-weight: bold; text-decoration: underline; color: white; background-color: red;',
+    [Level.ALERT]: 'font-weight: bold; color: white; background-color: red;',
+    [Level.CRIT]: 'font-weight: bold; color: magenta;',
+    [Level.ERR]: 'font-weight: bold; color: red;',
+    [Level.WARN]: 'font-weight: bold; color: yellow;',
+    [Level.NOTICE]: 'font-weight: bold; color: cyan;',
+    [Level.INFO]: 'font-weight: bold; color: white;',
+    [Level.DEBUG]: 'opacity: 0.8; color: white;',
+};
+const _cssMessageColor = {
+    [Level.EMERG]: 'font-weight: bold; color: red;',
+    [Level.ALERT]: 'font-weight: bold; color: red;',
+    [Level.CRIT]: 'font-weight: bold; color: red;',
+    [Level.ERR]: 'color: red;',
+    [Level.WARN]: 'color: yellow;',
+    [Level.NOTICE]: 'font-weight: bold; color: white;',
+    [Level.INFO]: 'color: white;',
+    [Level.DEBUG]: 'opacity: 0.8; color: white;',
+};
 /**
  * Various format functions included to make using the logger easier.
  * These are not the only formats you can use.
@@ -129,34 +156,48 @@ export const formats = {
     /** Format with a timestamp and the level, colorized with ANSI escape codes */
     ansi_level(entry) {
         const levelText = ansi(levels[entry.level].toUpperCase(), _ansiLevelColor[entry.level]);
-        return [_prettyMs(entry, true), levelText, entry.message].join(' ');
+        return [_prettyMs(entry, 'ansi'), levelText, entry.message];
     },
     /**
      * Format with a timestamp and colorize the message with ANSI escape codes.
      * For EMERG and ALERT, the levels are included
      */
     ansi_message(entry) {
-        let msg = _prettyMs(entry, true);
+        let msg = _prettyMs(entry, 'ansi');
         const isImportant = entry.level < Level.CRIT;
         if (isImportant)
             msg += ansi(levels[entry.level].toUpperCase(), _ansiLevelColor[entry.level]) + ': ';
         msg += ansi(entry.message, _ansiMessageColor[entry.level]);
         return msg;
     },
-    /** Uncolored format with a timestamp */
+    css_level(entry) {
+        const levelLabel = levels[entry.level].toUpperCase();
+        return [..._prettyMs(entry, 'css'), `%c${levelLabel}%c ${entry.message}`, _cssLevelColor[entry.level], ''];
+    },
+    css_message(entry) {
+        const text = _prettyMs(entry, 'css');
+        const isImportant = entry.level < Level.CRIT;
+        if (isImportant) {
+            const levelLabel = levels[entry.level].toUpperCase();
+            text.push(`%c${levelLabel}%c:`, _cssLevelColor[entry.level], '');
+        }
+        text.push('%c' + entry.message, _cssMessageColor[entry.level]);
+        return text;
+    },
     default(entry) {
         return `[${_prettyMs(entry)}] ${entry.message}`;
     },
 };
 let _format = formats.default;
 export function format(entry) {
-    return _format(entry);
+    const formatted = _format(entry);
+    return Array.isArray(formatted) ? formatted : [formatted];
 }
 let _output = console.error;
 function output(entry) {
     if (entry.level > minLevel)
         return;
-    _output(format(entry));
+    _output(...format(entry));
 }
 let minLevel = Level.ALERT;
 // Configuration

package/dist/stats.js

@@ -233,11 +233,11 @@ export class BigIntStats extends StatsCommon {
  * @internal
  */
 export function isStatsEqual(left, right) {
-    return (left.size == right.size &&
-        +left.atime == +right.atime &&
-        +left.mtime == +right.mtime &&
-        +left.ctime == +right.ctime &&
-        left.mode == right.mode);
+    return (left.size == right.size
+        && +left.atime == +right.atime
+        && +left.mtime == +right.mtime
+        && +left.ctime == +right.ctime
+        && left.mode == right.mode);
 }
 /** @internal */
 export const ZenFsType = 0x7a656e6673; // 'z' 'e' 'n' 'f' 's'

package/dist/vfs/path.js

@@ -338,12 +338,12 @@ export function extname(path) {
             preDotState = -1;
         }
     }
-    if (startDot === -1 ||
-        end === -1 ||
+    if (startDot === -1
+        || end === -1
         // We saw a non-dot character immediately before the dot
-        preDotState === 0 ||
+        || preDotState === 0
         // The (right-most) trimmed path component is exactly '..'
-        (preDotState === 1 && startDot === end - 1 && startDot === startPart + 1)) {
+        || (preDotState === 1 && startDot === end - 1 && startDot === startPart + 1)) {
         return '';
     }
     return path.slice(startDot, end);
@@ -403,11 +403,11 @@ export function parse(path) {
     }
     if (end !== -1) {
         const start = startPart === 0 && isAbsolute ? 1 : startPart;
-        if (startDot === -1 ||
+        if (startDot === -1
             // We saw a non-dot character immediately before the dot
-            preDotState === 0 ||
+            || preDotState === 0
             // The (right-most) trimmed path component is exactly '..'
-            (preDotState === 1 && startDot === end - 1 && startDot === startPart + 1)) {
+            || (preDotState === 1 && startDot === end - 1 && startDot === startPart + 1)) {
             ret.base = ret.name = path.slice(start, end);
         }
         else {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zenfs/core",
-	"version": "1.9.5",
+	"version": "1.10.1",
 	"description": "A filesystem, anywhere",
 	"funding": {
 		"type": "individual",
@@ -70,7 +70,7 @@
 		"buffer": "^6.0.3",
 		"eventemitter3": "^5.0.1",
 		"readable-stream": "^4.5.2",
-		"utilium": "^1.2.10"
+		"utilium": "^1.3.1"
 	},
 	"devDependencies": {
 		"@eslint/js": "^9.8.0",

package/readme.md

@@ -1,7 +1,3 @@
----
-title: Overview
----
-
 # ZenFS
 
 ZenFS is a cross-platform library that emulates the [NodeJS filesystem API](http://nodejs.org/api/fs.html). It works using a system of backends, which are used by ZenFS to store and retrieve data. ZenFS can also integrate with other tools.
@@ -15,6 +11,7 @@ ZenFS is modular and extensible. The core includes some built-in backends:
 - `Fetch`: Downloads files over HTTP with the `fetch` API
 - `Port`: Interacts with a remote over a `MessagePort`-like interface (e.g. a worker)
 - `Passthrough`: Use an existing `node:fs` interface with ZenFS
+- `SingleBuffer`: A backend contained within a single buffer. Can be used for synchronous multi-threaded operations using `SharedArrayBuffer`
 
 ZenFS supports a number of other backends. Many are provided as separate packages under `@zenfs`. More backends can be defined by separate libraries by extending the `FileSystem` class and providing a `Backend` object.
 

package/tests/setup/single-buffer.ts

@@ -0,0 +1,9 @@
+import { SingleBuffer, configureSingle } from '../../dist/index.js';
+import { copySync, data } from '../setup.js';
+
+await configureSingle({
+	backend: SingleBuffer,
+	buffer: new ArrayBuffer(0x100000),
+});
+
+copySync(data);