fake-node 0.1.1 → 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 speedydelete
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+## fake-node
+
+A version of node that works in the browser.

package/lib/index.d.ts

@@ -0,0 +1,59 @@
+export declare class Process {
+    fakeNode: FakeNode;
+    pid: number;
+    priority: number;
+    uid: number;
+    gid: number;
+    groups: number[];
+    cwd: string;
+    umask: number;
+    argv: string[];
+    argv0: string;
+    execArgv: string[];
+    execArgv0: string;
+    path: string;
+    module: false | string;
+    code: string;
+    constructor(fakeNode: FakeNode, { path, code, module }: {
+        path?: string;
+        code: string;
+        module?: false | string;
+    });
+    get env(): {
+        [key: string]: string;
+    };
+    run(): void;
+}
+export declare class FakeNode {
+    version: string;
+    static nextId: number;
+    id: number;
+    globalName: string;
+    globalenv: {
+        [key: string]: string;
+    };
+    modules: Map<string, unknown>;
+    globals: {
+        [key: string]: unknown;
+    };
+    processes: Map<number, Process>;
+    nextPid: number;
+    window: Window;
+    errorCallbacks: (Function | undefined)[];
+    constructor();
+    require(module: string): unknown;
+    getGlobals(pid: number): object;
+    getenv(pid: number): {
+        [key: string]: string;
+    };
+    run(code: string): void;
+    addModule(name: string, code: string): void;
+    addModuleFromValue(name: string, module: unknown): void;
+    getUserFromUID(uid: number | string): string;
+    getUserFromGID(gid: number | string): string;
+    getUIDFromUser(user: string | number): number;
+    getGIDFromGroup(group: string | number): number;
+    onError(error: Error): void;
+    addErrorCallback(callback: Function): number;
+    removeErrorCallback(callbackID: number): void;
+}

package/{index.js → lib/index.js}

@@ -37,35 +37,48 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FakeNode = exports.Process = void 0;
-const assert_1 = __importDefault(require("assert"));
-const module_buffer = __importStar(require("buffer"));
-// @ts-ignore
-const module_path = __importStar(require("path"));
-const module_punycode = __importStar(require("punycode"));
-const module_querystring = __importStar(require("querystring"));
-// @ts-ignore
-const module_readline = __importStar(require("readline"));
-// @ts-ignore
-const module_stream = __importStar(require("stream"));
-// @ts-ignore
-const module_string_decoder = __importStar(require("string_decoder"));
-const module_test = __importStar(require("test"));
-// @ts-ignore
-const module_url = __importStar(require("url"));
-// @ts-ignore
-const module_util = __importStar(require("util"));
+const module_os = __importStar(require("./os"));
+const module_process = __importStar(require("./process"));
+const module_punycode = __importStar(require("punycode/"));
+const module_querystring = __importStar(require("./querystring"));
 const web_only_globals_json_1 = __importDefault(require("./web_only_globals.json"));
-// todo: properly implement eval
-const ES_GLOBALS = { Infinity, NaN, undefined, eval, isFinite, isNaN, parseFloat, parseInt, decodeURI, decodeURIComponent, encodeURI, encodeURIComponent, escape, unescape, Object, Function, Boolean, Symbol, Error, AggregateError, EvalError, RangeError, ReferenceError, SyntaxError, TypeError, URIError, Number, BigInt, Math, Date, String, RegExp, Array, Int8Array, Uint8Array, Uint8ClampedArray, Int16Array, Uint16Array, Int32Array, Uint32Array, BigInt64Array, BigUint64Array, Float32Array, Float64Array, Map, Set, WeakMap, WeakSet, ArrayBuffer, SharedArrayBuffer, DataView, Atomics, JSON, WeakRef, FinalizationRegistry, Promise, Reflect, Proxy, Intl };
-const NODE_AND_WEB_GLOBALS = { AbortController, Blob, ByteLengthQueuingStrategy, atob, BroadcastChannel, btoa, clearInterval, clearTimeout, CloseEvent, CompressionStream, console, CountQueuingStrategy, Crypto, crypto, CryptoKey, CustomEvent, DecompressionStream, Event, EventSource, EventTarget, fetch, FormData, Headers, localStorage, MessageChannel, MessageEvent, MessagePort, Navigator, navigator, PerformanceEntry, PerformanceMark, PerformanceMeasure, PerformanceObserver, PerformanceObserverEntryList, performance, queueMicrotask, ReadableByteStreamController, Response, Request, sessionStorage, setInterval, setTimeout, Storage, structuredClone, SubtleCrypto, DOMException, TextDecoder, TextDecoderStream, TextEncoder, TextEncoderStream, TransformStreamDefaultController, URL, URLSearchParams, WebAssembly, WebSocket, WritableStream, WritableStreamDefaultController, WritableStreamDefaultWriter };
+const DEFAULT_GLOBALS = Object.defineProperties({}, Object.fromEntries(web_only_globals_json_1.default.map((name) => [name, { get() { throw new ReferenceError(`${name} is not defined`); } }])));
+const BUILTIN_MODULES = [
+    ['os', module_os],
+    ['process', module_process],
+    ['querystring', module_querystring],
+    ['punycode', module_punycode],
+];
+const DEFAULT_ENV = {
+    PATH: '/usr/local/bin:/usr/bin:/bin',
+    SHLVL: '1',
+    SHELL: '/bin/bash',
+    TERM: 'none',
+    PS1: '',
+    PS2: '> ',
+    HISTFILE: '~/.bash_history',
+    EDITOR: 'vim',
+    VISUAL: 'vim',
+    LANG: 'en_US.utf8',
+    HOSTNAME: 'fake-node',
+    TMPDIR: '/tmp',
+};
 class Process {
     fakeNode;
     pid;
+    priority = 0;
+    uid = 0;
+    gid = 0;
+    groups = [];
+    cwd;
+    umask = 0o6440;
     argv = [];
     argv0 = '';
+    execArgv = [];
+    execArgv0 = '/usr/bin/local/node';
+    path;
     module;
     code;
-    path;
     constructor(fakeNode, { path = '', code, module }) {
         this.fakeNode = fakeNode;
         this.pid = fakeNode.nextPid;
@@ -73,12 +86,16 @@ class Process {
         fakeNode.processes.set(this.pid, this);
         this.code = code;
         this.path = path;
+        this.cwd = path.split('/').slice(0, -1).join('/');
         this.module = module ?? false;
     }
+    get env() {
+        return this.fakeNode.getenv(this.pid);
+    }
     run() {
         let code;
         if (this.module) {
-            code = `with(${this.fakeNode.globalName}.getGlobals(${this.pid})){__fakeNode_process__.fakeNode.modules.set('${this.module},(function(){${this.code};return module.exports;})());}`;
+            code = `with(${this.fakeNode.globalName}.getGlobals(${this.pid})){__fakeNode__.modules.set('${this.module},(function(){${this.code};return module.exports;})());}`;
         }
         else {
             code = `with(${this.fakeNode.globalName}.getGlobals(${this.pid})){(function(){${this.code}})();}`;
@@ -90,55 +107,39 @@ class Process {
 }
 exports.Process = Process;
 class FakeNode {
+    version = '0.3.0';
     static nextId = 0;
     id;
     globalName;
+    globalenv = DEFAULT_ENV;
     modules = new Map();
-    builtinModules = new Map([
-        ['assert', assert_1.default],
-        ['buffer', module_buffer],
-        ['path', module_path],
-        ['punycode', module_punycode],
-        ['querystring', module_querystring],
-        ['readline', module_readline],
-        ['stream', module_stream],
-        ['string_decoder', module_string_decoder],
-        ['test', module_test],
-        ['url', module_url],
-        ['util', module_util],
-    ]);
     globals;
     processes = new Map();
     nextPid = 3;
     window = window;
+    errorCallbacks = [];
     constructor() {
         this.id = FakeNode.nextId;
         FakeNode.nextId++;
         this.globalName = '__fakeNode_' + this.id + '__';
         // @ts-ignore
         globalThis[this.globalName] = this;
-        this.globals = { require: this.require, Buffer: module_buffer.Buffer };
-        Object.assign(this.globals, ES_GLOBALS);
-        for (const name of web_only_globals_json_1.default) {
-            Object.defineProperty(this.globals, name, { get: () => { throw new ReferenceError(`${name} is not defined`); } });
+        this.globals = { __fakeNode__: this };
+        Object.assign(this.globals, DEFAULT_GLOBALS);
+        window.addEventListener('error', ({ error }) => this.onError(error));
+        window.addEventListener('unhandledrejection', ({ reason }) => reason instanceof Error ? this.onError(reason) : this.onError(new Error(String(reason))));
+        for (const [name, module] of BUILTIN_MODULES) {
+            this.addModuleFromValue(name, module);
+            this.addModuleFromValue('node:' + name, module);
+            this.addModuleFromValue('fake-node:' + name, module);
         }
-        Object.assign(this.globals, NODE_AND_WEB_GLOBALS);
     }
     require(module) {
-        if (module.startsWith('fake-node:')) {
-            module = module.slice('fake-node:'.length);
-        }
-        else if (module.startsWith('node:')) {
-            module = module.slice('node:'.length);
-        }
         if (this.modules.has(module)) {
             return this.modules.get(module);
         }
-        else if (this.builtinModules.has(module)) {
-            return this.builtinModules.get(module);
-        }
         else {
-            throw new Error(`cannot find module '${name}'`);
+            throw new Error(`cannot find module '${module}'`);
         }
     }
     getGlobals(pid) {
@@ -146,10 +147,12 @@ class FakeNode {
         if (process === undefined) {
             throw new TypeError(`nonexistent PID in FakeNode.getGlobals call: ${pid}. If you do not know why this occured, it is probably a bug in fake-node. Please report it at https://github.com/speedydelete/fake-node/issues.`);
         }
-        let scope = Object.create(this.globals);
+        let scope = {};
+        Object.assign(scope, this.globals);
         scope.global = scope;
         scope.globalThis = scope;
         scope.__fakeNode_process__ = process;
+        scope.require = this.require.bind(this);
         if (process.path !== '') {
             const pathParts = process.path.split('/');
             scope.__dirname = pathParts.slice(0, -1).join('/');
@@ -157,14 +160,76 @@ class FakeNode {
         }
         if (process.module !== false) {
             scope.module = {
-                exports: {}
+                exports: {},
             };
+            // @ts-ignore
             scope.exports = scope.module.exports;
         }
         return scope;
     }
+    getenv(pid) {
+        let env = Object.create(this.globalenv);
+        const process = this.processes.get(pid);
+        if (process === undefined) {
+            throw new TypeError(`invalid PID: ${pid}`);
+        }
+        env.USER = this.getUserFromUID(process.uid);
+        return env;
+    }
     run(code) {
         (new Process(this, { code, path: '/' })).run();
     }
+    addModule(name, code) {
+        (new Process(this, { code, path: '/', module: name })).run();
+    }
+    addModuleFromValue(name, module) {
+        this.modules.set(name, module);
+    }
+    getUserFromUID(uid) {
+        if (typeof uid === 'string') {
+            return uid;
+        }
+        else {
+            return 'root';
+        }
+    }
+    getUserFromGID(gid) {
+        if (typeof gid === 'string') {
+            return gid;
+        }
+        else {
+            return 'root';
+        }
+    }
+    getUIDFromUser(user) {
+        if (typeof user === 'number') {
+            return user;
+        }
+        else {
+            return 0;
+        }
+    }
+    getGIDFromGroup(group) {
+        if (typeof group === 'number') {
+            return group;
+        }
+        else {
+            return 0;
+        }
+    }
+    onError(error) {
+        for (const callback of this.errorCallbacks) {
+            if (callback !== undefined) {
+                callback(error);
+            }
+        }
+    }
+    addErrorCallback(callback) {
+        this.errorCallbacks.push(callback);
+        return this.errorCallbacks.length - 1;
+    }
+    removeErrorCallback(callbackID) {
+        this.errorCallbacks[callbackID] = undefined;
+    }
 }
 exports.FakeNode = FakeNode;

package/lib/os.d.ts

@@ -0,0 +1,191 @@
+export declare const EOL = "\n";
+export declare function availableParallelism(): number;
+export declare function arch(): string;
+declare enum signals {
+    SIGHUP = 1,
+    SIGINT = 2,
+    SIGQUIT = 3,
+    SIGILL = 4,
+    SIGTRAP = 5,
+    SIGABRT = 6,
+    SIGIOT = 6,
+    SIGBUS = 7,
+    SIGFPE = 8,
+    SIGKILL = 9,
+    SIGUSR1 = 10,
+    SIGUSR2 = 11,
+    SIGSEGV = 12,
+    SIGPIPE = 13,
+    SIGALRM = 14,
+    SIGTERM = 15,
+    SIGCHLD = 16,
+    SIGSTKFLT = 17,
+    SIGCONT = 18,
+    SIGSTOP = 19,
+    SIGTSTP = 20,
+    SIGBREAK = 21,
+    SIGTTIN = 22,
+    SIGTTOU = 23,
+    SIGURG = 24,
+    SIGXCPU = 25,
+    SIGXFSZ = 26,
+    SIGVTALRM = 27,
+    SIGPROF = 28,
+    SIGWINCH = 29,
+    SIGIO = 30,
+    SIGPOLL = 30,
+    SIGLOST = 31,
+    SIGPWR = 32,
+    SIGINFO = 32,
+    SIGSYS = 33,
+    SIGUNUSED = 33
+}
+declare enum errno {
+    E2BIG = 0,
+    EACCES = 1,
+    EADDRINUSE = 2,
+    EADDRNONOTAVAIL = 3,
+    EAFNOSUPPORT = 4,
+    EAGAIN = 5,
+    EALREADY = 6,
+    EBADF = 7,
+    EBADMSG = 8,
+    EBUSY = 9,
+    ECANCELED = 10,
+    ECHILD = 11,
+    ECONNABORTED = 12,
+    ECONNREFUSED = 13,
+    ECONNRESET = 14,
+    EDEADLK = 15,
+    EDESTADDRREQ = 16,
+    EDOM = 17,
+    EDQUOT = 18,
+    EEXIST = 19,
+    EFAULT = 20,
+    EFBIG = 21,
+    EHOSTUNREACH = 22,
+    EIDRM = 23,
+    EILSEQ = 24,
+    EINPROGRESS = 25,
+    EINTR = 26,
+    EINVAL = 27,
+    EIO = 28,
+    EISCONN = 29,
+    EISDIR = 30,
+    ELOOP = 31,
+    EMFILE = 32,
+    EMLINK = 33,
+    EMGSIZE = 34,
+    EMULTIHOP = 35,
+    ENAMETOOLONG = 36,
+    ENETDOWN = 37,
+    ENETRESET = 38,
+    ENETUNREACH = 39,
+    ENFILE = 40,
+    ENOBUFS = 41,
+    ENODATA = 42,
+    ENODEV = 43,
+    ENOENT = 44,
+    ENOEXEC = 45,
+    ENOLCK = 46,
+    ENOLINK = 47,
+    ENOMEM = 48,
+    ENOMSG = 49,
+    ENOPROTOOPT = 50,
+    ENOSPC = 51,
+    ENOSR = 52,
+    ENOSTR = 53,
+    ENOSYS = 54,
+    ENOTCONN = 55,
+    ENOTDIR = 56,
+    ENOTEMPTY = 57,
+    ENOTSOCK = 58,
+    ENOTSUP = 59,
+    ENOTTY = 60,
+    ENXIO = 61,
+    EOPNOTSUPP = 62,
+    EOVERFLOW = 63,
+    EPERM = 64,
+    EPIPE = 65,
+    EPROTO = 66,
+    EPROTONOSUPPORT = 67,
+    EPROTOTYPE = 68,
+    ERANGE = 69,
+    EROFS = 70,
+    ESPIPE = 71,
+    ESRCH = 72,
+    ESTALE = 73,
+    ETIME = 74,
+    ETIMEDOUT = 75,
+    ETXTBSY = 76,
+    EWOULDBLOCK = 77,
+    EXDEV = 78
+}
+declare enum dlopen {
+    RTLD_LAZY = 1,
+    RTLD_NOW = 2,
+    RTLD_GLOBAL = 3,
+    RTLD_LOCAL = 4,
+    RTLD_DEEPBIND = 5
+}
+declare enum priority {
+    PRIORITY_LOW = 1,
+    PRIORITY_BELOW_NORMAL = 2,
+    PRIORITY_NORMAL = 3,
+    PRIORITY_ABOVE_NORMAL = 4,
+    PRIORITY_HIGH = 5,
+    PRIORITY_HIGHEST = 6
+}
+export declare const constants: {
+    signals: typeof signals;
+    errno: typeof errno;
+    dlopen: typeof dlopen;
+    priority: typeof priority;
+};
+export declare function cpus(): {
+    model: string;
+    speed: number;
+    times: {
+        user: number;
+        nice: number;
+        sys: number;
+        idle: number;
+        irq: number;
+    };
+}[];
+export declare const devNull = "/dev/null";
+export declare function endianness(): string;
+export declare function freemem(): number;
+export declare function getPriority(pid?: number): number;
+export declare function homedir(): string;
+export declare function hostname(): string;
+export declare function loadavg(): [number, number, number];
+export declare function machine(): string;
+export declare function networkInterfaces(): {
+    [key: string]: {
+        address: string;
+        netmask: string;
+        family: 'IPV4' | 'IPV6';
+        mac: string;
+        internal: boolean;
+        scopeid: number;
+        cidr: string;
+    };
+};
+export declare function platform(): string;
+export declare function release(): string;
+export declare function setPriority(priority: number): void;
+export declare function setPriority(pid: number, priority: number): void;
+export declare function tmpdir(): string;
+export declare function totalmem(): number;
+export declare function type(): string;
+export declare function uptime(): number;
+export declare function userInfo(): {
+    username: string;
+    uid: number;
+    gid: number;
+    shell: string;
+    homedir: string;
+};
+export declare function version(): string;
+export {};