@zenfs/core 1.4.3 → 1.5.1

package/dist/context.d.ts

@@ -1,8 +1,5 @@
-import { type ExtractProperties } from 'utilium';
 import { type CredentialInit, type Credentials } from './credentials.js';
 import * as fs from './emulation/index.js';
-type Fn_FS = Omit<ExtractProperties<typeof fs, (...args: any[]) => any>, 'mountObject'>;
-type Fn_Promises = ExtractProperties<typeof fs.promises, (...args: any[]) => any>;
 /**
  * Represents some context used for FS operations
  * @experimental
@@ -20,8 +17,8 @@ export type V_Context = void | (Partial<FSContext> & object);
  * Allows you to restrict operations to a specific root path and set of credentials.
  * @experimental
  */
-export interface BoundContext extends Fn_FS, FSContext {
-    promises: Fn_Promises;
+export interface BoundContext extends FSContext {
+    fs: typeof fs;
 }
 /**
  * Allows you to restrict operations to a specific root path and set of credentials.
@@ -29,4 +26,3 @@ export interface BoundContext extends Fn_FS, FSContext {
  * @experimental
  */
 export declare function bindContext(root: string, credentials?: CredentialInit): BoundContext;
-export {};

package/dist/context.js

@@ -19,5 +19,5 @@ export function bindContext(root, credentials = structuredClone(defaultCredentia
     };
     const fn_fs = _bindFunctions(fs, ctx);
     const fn_promises = _bindFunctions(fs.promises, ctx);
-    return { ...ctx, ...fn_fs, promises: fn_promises };
+    return { ...ctx, fs: { ...fs, ...fn_fs, promises: { ...fs.promises, ...fn_promises } } };
 }

package/dist/emulation/dir.d.ts

@@ -19,7 +19,7 @@ export declare class Dirent implements _Dirent {
 /**
  * A class representing a directory stream.
  */
-export declare class Dir implements _Dir {
+export declare class Dir implements _Dir, AsyncIterator<Dirent> {
     readonly path: string;
     protected readonly context: V_Context;
     protected closed: boolean;
@@ -55,5 +55,6 @@ export declare class Dir implements _Dir {
     /**
      * Asynchronously iterates over the directory via `readdir(3)` until all entries have been read.
      */
-    [Symbol.asyncIterator](): AsyncIterableIterator<Dirent>;
+    [Symbol.asyncIterator](): this;
+    [Symbol.asyncDispose](): Promise<void>;
 }

package/dist/emulation/dir.js

@@ -102,4 +102,7 @@ export class Dir {
     [Symbol.asyncIterator]() {
         return this;
     }
+    [Symbol.asyncDispose]() {
+        return Promise.resolve();
+    }
 }

package/dist/emulation/streams.d.ts

@@ -3,6 +3,7 @@ import { Readable, Writable } from 'readable-stream';
 import type { Callback } from '../utils.js';
 export declare class ReadStream extends Readable implements Node.ReadStream {
     close(callback?: Callback): void;
+    wrap(oldStream: NodeJS.ReadableStream): this;
     bytesRead: number;
     path: string | Buffer;
     pending: boolean;

package/dist/emulation/streams.js

@@ -11,6 +11,10 @@ export class ReadStream extends Readable {
             callback(new ErrnoError(Errno.EIO, err.toString()));
         }
     }
+    wrap(oldStream) {
+        super.wrap(oldStream);
+        return this;
+    }
 }
 export class WriteStream extends Writable {
     close(callback = () => null) {

package/dist/file.d.ts

@@ -21,14 +21,14 @@ export declare abstract class File<FS extends FileSystem = FileSystem> {
      * @internal
      * The file system that created the file
      */
-    fs: FileSystem;
+    fs: FS;
     readonly path: string;
     constructor(
     /**
      * @internal
      * The file system that created the file
      */
-    fs: FileSystem, path: string);
+    fs: FS, path: string);
     /**
      * Get the current file position.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zenfs/core",
-	"version": "1.4.3",
+	"version": "1.5.1",
 	"description": "A filesystem, anywhere",
 	"funding": {
 		"type": "individual",
@@ -21,7 +21,6 @@
 		"dist",
 		"tests",
 		"license.md",
-		"tsconfig.json",
 		"eslint.shared.js"
 	],
 	"type": "module",
@@ -87,7 +86,6 @@
 		"prettier": "^3.2.5",
 		"tsx": "^4.19.1",
 		"typedoc": "^0.27.1",
-		"typedoc-plugin-remove-references": "^0.0.6",
 		"typescript": "^5.7.2",
 		"typescript-eslint": "^8.16.0"
 	}

package/readme.md

@@ -162,7 +162,7 @@ await configure({
 
 fs.writeFileSync('/dev/null', 'Some data to be discarded');
 
-const randomData = new Unit8Array(100);
+const randomData = new Uint8Array(100);
 
 const random = fs.openSync('/dev/random', 'r');
 fs.readSync(random, randomData);

package/tests/common/context.test.ts

@@ -4,7 +4,7 @@ import { bindContext } from '../../dist/context.js';
 import * as fs from '../../dist/emulation/index.js';
 
 fs.mkdirSync('/new_root');
-const c_fs = bindContext('/new_root');
+const { fs: c_fs } = bindContext('/new_root');
 
 suite('Context', () => {
 	test('create a file', () => {

package/tests/setup/context.ts

@@ -4,6 +4,6 @@ import { copy, data } from '../setup.js';
 
 _fs.mkdirSync('/new_root');
 
-export const fs = bindContext('/new_root');
+export const { fs } = bindContext('/new_root');
 
 copy(data, fs);

package/tests/setup.ts

@@ -1,7 +1,6 @@
 import { join, relative } from 'node:path';
 import { statSync, readFileSync, readdirSync, existsSync, mkdirSync } from 'node:fs';
 import { fs as _fs } from '../dist/index.js';
-import type { BoundContext } from '../dist/context.js';
 
 export const data = join(import.meta.dirname, 'data');
 
@@ -11,7 +10,7 @@ if (!existsSync(tmp)) {
 	mkdirSync(tmp);
 }
 
-export function copy(_path: string, fs: typeof _fs | BoundContext = _fs) {
+export function copy(_path: string, fs: typeof _fs = _fs) {
 	const path = relative(data, _path) || '/';
 	const stats = statSync(_path);
 

package/tsconfig.json

@@ -1,19 +0,0 @@
-{
-	"compilerOptions": {
-		"module": "NodeNext",
-		"target": "ES2020",
-		"outDir": "dist",
-		"lib": ["ESNext", "ESNext.Disposable"],
-		"moduleResolution": "NodeNext",
-		"declaration": true,
-		"strict": true
-	},
-	"include": ["src/**/*.ts"],
-	"exclude": ["node_modules"],
-	"typedocOptions": {
-		"entryPoints": ["./src/index.ts"],
-		"out": "docs",
-		"name": "ZenFS",
-		"plugin": ["typedoc-plugin-remove-references"]
-	}
-}