@lydell/node-pty 1.1.0 → 1.2.0-beta.2

package/LICENSE

@@ -1,52 +1,6 @@
-Copyright (c) 2012-2015, Christopher Jeffrey (https://github.com/chjj/)
-
-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.
-
-
-
-The MIT License (MIT)
-
-Copyright (c) 2016, Daniel Imms (http://www.growingwiththeweb.com)
-
-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.
-
-
-
 MIT License
 
-Copyright (c) 2018 - present Microsoft Corporation
+Copyright (c) 2026 Simon Lydell
 
 All rights reserved.
 

package/README.md

@@ -1,9 +1,18 @@
 # @lydell/node-pty
 
-Fork of [microsoft/node-pty](https://github.com/microsoft/node-pty) with prebuilt binaries.
+Smaller distribution of [microsoft/node-pty](https://github.com/microsoft/node-pty).
 
-- Only supports platforms with prebuilt binaries. (Never builds with node-gyp at install.)
-- Removed support for old versions of Windows. (Removed winpty, only supports conpty.)
+- microsoft/node-pty ships with prebuilt binaries for multiple platforms. @lydell/node-pty only installs the prebuilt binaries needed for the current platform (depends on your package manager).
+- microsoft/node-pty supports compiling using node-gyp on unsupported platforms, which requires more source files. @lydell/node-pty only works on platforms with prebuilt binaries and never calls node-gyp.
+- microsoft/node-pty ships with unneeded files, such as source code TypeScript files, source maps and test files. @lydell/node-pty removes those.
+- microsoft/node-pty is about 60 MiB. @lydell/node-pty is less than 1 MiB on macOS and Linux, and around 30 MiB on Windows.
+
+@lydell/node-pty is built like this:
+
+1. Download the original node-pty npm package.
+2. Make one copy of it per supported platform.
+3. For each copy, only include relevant files.
+4. Make the @lydell/node-pty wrapper package, which depends on all the platform-specific packages using `"optionalDependencies"` in package.json, allowing package managers to only install the platform-specific package matching the current platform. The wrapper package only re-exports everything from the correct platform-specific package.
 
 ## pty.js
 
@@ -17,15 +26,15 @@ Copyright (c) 2018, Microsoft Corporation (MIT License).
 
 ## Version
 
-@lydell/node-pty@1.1.0 is based on node-pty@1.1.0-beta14 (commit [efbf8ebbe7b09351548fa0a4ed07b36c5d2e539b](https://github.com/microsoft/node-pty/commit/efbf8ebbe7b09351548fa0a4ed07b36c5d2e539b)).
+@lydell/node-pty@1.2.0-beta.2 is based on node-pty@1.2.0-beta.2.
 
 ## Prebuilt binaries
 
 This package includes prebuilt binaries for the following platforms and architectures:
 
-- macOS x86_64 (darwin-x64)
 - macOS ARM64 (darwin-arm64)
+- macOS x86_64 (darwin-x64)
+- Linux ARM64 (linux-arm64)
 - Linux x86_64 (linux-x64)
-- Linux ARM64 (linux-arm64) (not tested)
-- Windows x86_64 (win32-x64)
-- Windows ARM64 (win32-arm64) (not tested)
+- Windows ARM64 (win32-arm64)
+- Windows x86_64 (win32-x64)

package/index.js

@@ -1,44 +1,41 @@
-"use strict";
-/**
- * Copyright (c) 2012-2015, Christopher Jeffrey, Peter Sunde (MIT License)
- * Copyright (c) 2016, Daniel Imms (MIT License).
- * Copyright (c) 2018, Microsoft Corporation (MIT License).
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-var terminalCtor;
-if (process.platform === 'win32') {
-    terminalCtor = require('./windowsTerminal').WindowsTerminal;
+const PACKAGE_NAME = `@lydell/node-pty-${process.platform}-${process.arch}`;
+
+const help = `
+This can happen if you use the "--omit=optional" (or "--no-optional") npm flag.
+The "optionalDependencies" package.json feature is used to install the correct
+binary executable for your current platform. Remove that flag to use @lydell/node-pty.
+
+This can also happen if the "node_modules" folder was copied between two operating systems
+that need different binaries - including "virtual" operating systems like Docker and WSL.
+If so, try installing with npm rather than copying "node_modules".
+`.trim();
+
+function requirePlatformSpecificPackage() {
+  try {
+    return require(PACKAGE_NAME);
+  } catch (error) {
+    if (error && error.code === "MODULE_NOT_FOUND") {
+      const optionalDependencies = getOptionalDependencies();
+      throw new Error(
+        optionalDependencies === undefined
+          ? `The @lydell/node-pty package could not find the platform-specific package: ${PACKAGE_NAME}\n\n${help}\n\nYour platform (${process.platform}-${process.arch}) might not be supported.`
+          : PACKAGE_NAME in optionalDependencies
+          ? `The @lydell/node-pty package supports your platform (${process.platform}-${process.arch}), but it could not find the platform-specific package for it: ${PACKAGE_NAME}\n\n${help}`
+          : `The @lydell/node-pty package currently does not support your platform: ${process.platform}-${process.arch}`,
+        { cause: error }
+      );
+    } else {
+      throw error;
+    }
+  }
 }
-else {
-    terminalCtor = require('./unixTerminal').UnixTerminal;
+
+function getOptionalDependencies() {
+  try {
+    return require("./package.json").optionalDependencies;
+  } catch (_error) {
+    return undefined;
+  }
 }
-/**
- * Forks a process as a pseudoterminal.
- * @param file The file to launch.
- * @param args The file's arguments as argv (string[]) or in a pre-escaped
- * CommandLine format (string). Note that the CommandLine option is only
- * available on Windows and is expected to be escaped properly.
- * @param options The options of the terminal.
- * @throws When the file passed to spawn with does not exists.
- * @see CommandLineToArgvW https://msdn.microsoft.com/en-us/library/windows/desktop/bb776391(v=vs.85).aspx
- * @see Parsing C++ Comamnd-Line Arguments https://msdn.microsoft.com/en-us/library/17w5ykft.aspx
- * @see GetCommandLine https://msdn.microsoft.com/en-us/library/windows/desktop/ms683156.aspx
- */
-function spawn(file, args, opt) {
-    return new terminalCtor(file, args, opt);
-}
-exports.spawn = spawn;
-/** @deprecated */
-function fork(file, args, opt) {
-    return new terminalCtor(file, args, opt);
-}
-exports.fork = fork;
-/** @deprecated */
-function createTerminal(file, args, opt) {
-    return new terminalCtor(file, args, opt);
-}
-exports.createTerminal = createTerminal;
-function open(options) {
-    return terminalCtor.open(options);
-}
-exports.open = open;
+
+module.exports = requirePlatformSpecificPackage();

package/node-pty.d.ts

@@ -3,7 +3,7 @@
  * Copyright (c) 2018, Microsoft Corporation (MIT License).
  */
 
-declare module "@lydell/node-pty" {
+declare module '@lydell/node-pty' {
   /**
    * Forks a process as a pseudoterminal.
    * @param file The file to launch.
@@ -86,6 +86,23 @@ declare module "@lydell/node-pty" {
   }
 
   export interface IWindowsPtyForkOptions extends IBasePtyForkOptions {
+    /**
+     * Whether to use the ConPTY system on Windows. When this is not set, ConPTY will be used when
+     * the Windows build number is >= 18309 (instead of winpty). Note that ConPTY is available from
+     * build 17134 but is too unstable to enable by default.
+     *
+     * This setting does nothing on non-Windows.
+     */
+    useConpty?: boolean;
+
+    /**
+     * (EXPERIMENTAL)
+     *
+     * Whether to use the conpty.dll shipped with the node-pty package instead of the one built into
+     * Windows. Defaults to false.
+     */
+    useConptyDll?: boolean;
+
     /**
      * Whether to use PSEUDOCONSOLE_INHERIT_CURSOR in conpty.
      * @see https://docs.microsoft.com/en-us/windows/console/createpseudoconsole
@@ -94,7 +111,7 @@ declare module "@lydell/node-pty" {
   }
 
   /**
-   * An interface representing a pseudoterminal.
+   * An interface representing a pseudoterminal, on Windows this is emulated via the winpty library.
    */
   export interface IPty {
     /**
@@ -156,7 +173,7 @@ declare module "@lydell/node-pty" {
      * Writes data to the pty.
      * @param data The data to write.
      */
-    write(data: string): void;
+    write(data: string | Buffer): void;
 
     /**
      * Kills the pty.

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@lydell/node-pty",
-  "description": "node-pty with prebuilt binaries",
+  "description": "Smaller distribution of node-pty.",
   "author": "Simon Lydell",
-  "version": "1.1.0",
+  "version": "1.2.0-beta.2",
   "license": "MIT",
-  "main": "./index.js",
+  "type": "commonjs",
+  "exports": "./index.js",
   "types": "./node-pty.d.ts",
   "repository": {
     "type": "git",
@@ -21,11 +22,11 @@
     "prebuilt"
   ],
   "optionalDependencies": {
-    "@lydell/node-pty-darwin-x64": "1.1.0",
-    "@lydell/node-pty-darwin-arm64": "1.1.0",
-    "@lydell/node-pty-linux-x64": "1.1.0",
-    "@lydell/node-pty-linux-arm64": "1.1.0",
-    "@lydell/node-pty-win32-x64": "1.1.0",
-    "@lydell/node-pty-win32-arm64": "1.1.0"
+    "@lydell/node-pty-darwin-arm64": "1.2.0-beta.2",
+    "@lydell/node-pty-darwin-x64": "1.2.0-beta.2",
+    "@lydell/node-pty-linux-arm64": "1.2.0-beta.2",
+    "@lydell/node-pty-linux-x64": "1.2.0-beta.2",
+    "@lydell/node-pty-win32-arm64": "1.2.0-beta.2",
+    "@lydell/node-pty-win32-x64": "1.2.0-beta.2"
   }
 }

package/conpty_console_list_agent.js

@@ -1,13 +0,0 @@
-"use strict";
-/**
- * Copyright (c) 2019, Microsoft Corporation (MIT License).
- *
- * This module fetches the console process list for a particular PID. It must be
- * called from a different process (child_process.fork) as there can only be a
- * single console attached to a process.
- */
-var getConsoleProcessList = require("@lydell/node-pty-" + process.platform + "-" + process.arch + "/conpty_console_list.node").getConsoleProcessList;
-var shellPid = parseInt(process.argv[2], 10);
-var consoleProcessList = getConsoleProcessList(shellPid);
-process.send({ consoleProcessList: consoleProcessList });
-process.exit(0);

package/eventEmitter2.js

@@ -1,45 +0,0 @@
-"use strict";
-/**
- * Copyright (c) 2019, Microsoft Corporation (MIT License).
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-var EventEmitter2 = /** @class */ (function () {
-    function EventEmitter2() {
-        this._listeners = [];
-    }
-    Object.defineProperty(EventEmitter2.prototype, "event", {
-        get: function () {
-            var _this = this;
-            if (!this._event) {
-                this._event = function (listener) {
-                    _this._listeners.push(listener);
-                    var disposable = {
-                        dispose: function () {
-                            for (var i = 0; i < _this._listeners.length; i++) {
-                                if (_this._listeners[i] === listener) {
-                                    _this._listeners.splice(i, 1);
-                                    return;
-                                }
-                            }
-                        }
-                    };
-                    return disposable;
-                };
-            }
-            return this._event;
-        },
-        enumerable: true,
-        configurable: true
-    });
-    EventEmitter2.prototype.fire = function (data) {
-        var queue = [];
-        for (var i = 0; i < this._listeners.length; i++) {
-            queue.push(this._listeners[i]);
-        }
-        for (var i = 0; i < queue.length; i++) {
-            queue[i].call(undefined, data);
-        }
-    };
-    return EventEmitter2;
-}());
-exports.EventEmitter2 = EventEmitter2;

package/interfaces.js

@@ -1,6 +0,0 @@
-"use strict";
-/**
- * Copyright (c) 2016, Daniel Imms (MIT License).
- * Copyright (c) 2018, Microsoft Corporation (MIT License).
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/requireBinary.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var PACKAGE_NAME = "@lydell/node-pty-" + process.platform + "-" + process.arch;
-var help = "\nThis can happen if you use the \"--omit=optional\" (or \"--no-optional\") npm flag.\nThe \"optionalDependencies\" package.json feature is used to install the correct\nbinary executable for your current platform. Remove that flag to use @lydell/node-pty.\n\nThis can also happen if the \"node_modules\" folder was copied between two operating systems\nthat need different binaries - including \"virtual\" operating systems like Docker and WSL.\nIf so, try installing with npm rather than copying \"node_modules\".\n".trim();
-function requireBinary(file) {
-    try {
-        return require(PACKAGE_NAME + "/" + file);
-    }
-    catch (error) {
-        if (error && error.code === 'MODULE_NOT_FOUND') {
-            var optionalDependencies = getOptionalDependencies();
-            throw new Error(optionalDependencies === undefined
-                ? "The @lydell/node-pty package could not find the binary package: " + PACKAGE_NAME + "/" + file + "\n\n" + help + "\n\nYour platform (" + process.platform + "-" + process.arch + ") might not be supported."
-                : PACKAGE_NAME in optionalDependencies
-                    ? "The @lydell/node-pty package supports your platform (" + process.platform + "-" + process.arch + "), but it could not find the binary package for it: " + PACKAGE_NAME + "/" + file + "\n\n" + help
-                    : "The @lydell/node-pty package currently does not support your platform: " + process.platform + "-" + process.arch, 
-            // @ts-ignore: The TypeScript setup does not seem to support cause.
-            { cause: error });
-        }
-        else {
-            throw error;
-        }
-    }
-}
-exports.requireBinary = requireBinary;
-function getOptionalDependencies() {
-    try {
-        return require('./package.json').optionalDependencies;
-    }
-    catch (_error) {
-        return undefined;
-    }
-}

package/shared/conout.js

@@ -1,9 +0,0 @@
-"use strict";
-/**
- * Copyright (c) 2020, Microsoft Corporation (MIT License).
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-function getWorkerPipeName(conoutPipeName) {
-    return conoutPipeName + "-worker";
-}
-exports.getWorkerPipeName = getWorkerPipeName;

package/terminal.js

@@ -1,188 +0,0 @@
-"use strict";
-/**
- * Copyright (c) 2012-2015, Christopher Jeffrey (MIT License)
- * Copyright (c) 2016, Daniel Imms (MIT License).
- * Copyright (c) 2018, Microsoft Corporation (MIT License).
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-var events_1 = require("events");
-var eventEmitter2_1 = require("./eventEmitter2");
-exports.DEFAULT_COLS = 80;
-exports.DEFAULT_ROWS = 24;
-/**
- * Default messages to indicate PAUSE/RESUME for automatic flow control.
- * To avoid conflicts with rebound XON/XOFF control codes (such as on-my-zsh),
- * the sequences can be customized in `IPtyForkOptions`.
- */
-var FLOW_CONTROL_PAUSE = '\x13'; // defaults to XOFF
-var FLOW_CONTROL_RESUME = '\x11'; // defaults to XON
-var Terminal = /** @class */ (function () {
-    function Terminal(opt) {
-        this._pid = 0;
-        this._fd = 0;
-        this._cols = 0;
-        this._rows = 0;
-        this._readable = false;
-        this._writable = false;
-        this._onData = new eventEmitter2_1.EventEmitter2();
-        this._onExit = new eventEmitter2_1.EventEmitter2();
-        // for 'close'
-        this._internalee = new events_1.EventEmitter();
-        // setup flow control handling
-        this.handleFlowControl = !!(opt === null || opt === void 0 ? void 0 : opt.handleFlowControl);
-        this._flowControlPause = (opt === null || opt === void 0 ? void 0 : opt.flowControlPause) || FLOW_CONTROL_PAUSE;
-        this._flowControlResume = (opt === null || opt === void 0 ? void 0 : opt.flowControlResume) || FLOW_CONTROL_RESUME;
-        if (!opt) {
-            return;
-        }
-        // Do basic type checks here in case node-pty is being used within JavaScript. If the wrong
-        // types go through to the C++ side it can lead to hard to diagnose exceptions.
-        this._checkType('name', opt.name ? opt.name : undefined, 'string');
-        this._checkType('cols', opt.cols ? opt.cols : undefined, 'number');
-        this._checkType('rows', opt.rows ? opt.rows : undefined, 'number');
-        this._checkType('cwd', opt.cwd ? opt.cwd : undefined, 'string');
-        this._checkType('env', opt.env ? opt.env : undefined, 'object');
-        this._checkType('uid', opt.uid ? opt.uid : undefined, 'number');
-        this._checkType('gid', opt.gid ? opt.gid : undefined, 'number');
-        this._checkType('encoding', opt.encoding ? opt.encoding : undefined, 'string');
-    }
-    Object.defineProperty(Terminal.prototype, "onData", {
-        get: function () { return this._onData.event; },
-        enumerable: true,
-        configurable: true
-    });
-    Object.defineProperty(Terminal.prototype, "onExit", {
-        get: function () { return this._onExit.event; },
-        enumerable: true,
-        configurable: true
-    });
-    Object.defineProperty(Terminal.prototype, "pid", {
-        get: function () { return this._pid; },
-        enumerable: true,
-        configurable: true
-    });
-    Object.defineProperty(Terminal.prototype, "cols", {
-        get: function () { return this._cols; },
-        enumerable: true,
-        configurable: true
-    });
-    Object.defineProperty(Terminal.prototype, "rows", {
-        get: function () { return this._rows; },
-        enumerable: true,
-        configurable: true
-    });
-    Terminal.prototype.write = function (data) {
-        if (this.handleFlowControl) {
-            // PAUSE/RESUME messages are not forwarded to the pty
-            if (data === this._flowControlPause) {
-                this.pause();
-                return;
-            }
-            if (data === this._flowControlResume) {
-                this.resume();
-                return;
-            }
-        }
-        // everything else goes to the real pty
-        this._write(data);
-    };
-    Terminal.prototype._forwardEvents = function () {
-        var _this = this;
-        this.on('data', function (e) { return _this._onData.fire(e); });
-        this.on('exit', function (exitCode, signal) { return _this._onExit.fire({ exitCode: exitCode, signal: signal }); });
-    };
-    Terminal.prototype._checkType = function (name, value, type, allowArray) {
-        if (allowArray === void 0) { allowArray = false; }
-        if (value === undefined) {
-            return;
-        }
-        if (allowArray) {
-            if (Array.isArray(value)) {
-                value.forEach(function (v, i) {
-                    if (typeof v !== type) {
-                        throw new Error(name + "[" + i + "] must be a " + type + " (not a " + typeof v[i] + ")");
-                    }
-                });
-                return;
-            }
-        }
-        if (typeof value !== type) {
-            throw new Error(name + " must be a " + type + " (not a " + typeof value + ")");
-        }
-    };
-    /** See net.Socket.end */
-    Terminal.prototype.end = function (data) {
-        this._socket.end(data);
-    };
-    /** See stream.Readable.pipe */
-    Terminal.prototype.pipe = function (dest, options) {
-        return this._socket.pipe(dest, options);
-    };
-    /** See net.Socket.pause */
-    Terminal.prototype.pause = function () {
-        return this._socket.pause();
-    };
-    /** See net.Socket.resume */
-    Terminal.prototype.resume = function () {
-        return this._socket.resume();
-    };
-    /** See net.Socket.setEncoding */
-    Terminal.prototype.setEncoding = function (encoding) {
-        if (this._socket._decoder) {
-            delete this._socket._decoder;
-        }
-        if (encoding) {
-            this._socket.setEncoding(encoding);
-        }
-    };
-    Terminal.prototype.addListener = function (eventName, listener) { this.on(eventName, listener); };
-    Terminal.prototype.on = function (eventName, listener) {
-        if (eventName === 'close') {
-            this._internalee.on('close', listener);
-            return;
-        }
-        this._socket.on(eventName, listener);
-    };
-    Terminal.prototype.emit = function (eventName) {
-        var args = [];
-        for (var _i = 1; _i < arguments.length; _i++) {
-            args[_i - 1] = arguments[_i];
-        }
-        if (eventName === 'close') {
-            return this._internalee.emit.apply(this._internalee, arguments);
-        }
-        return this._socket.emit.apply(this._socket, arguments);
-    };
-    Terminal.prototype.listeners = function (eventName) {
-        return this._socket.listeners(eventName);
-    };
-    Terminal.prototype.removeListener = function (eventName, listener) {
-        this._socket.removeListener(eventName, listener);
-    };
-    Terminal.prototype.removeAllListeners = function (eventName) {
-        this._socket.removeAllListeners(eventName);
-    };
-    Terminal.prototype.once = function (eventName, listener) {
-        this._socket.once(eventName, listener);
-    };
-    Terminal.prototype._close = function () {
-        this._socket.readable = false;
-        this.write = function () { };
-        this.end = function () { };
-        this._writable = false;
-        this._readable = false;
-    };
-    Terminal.prototype._parseEnv = function (env) {
-        var keys = Object.keys(env || {});
-        var pairs = [];
-        for (var i = 0; i < keys.length; i++) {
-            if (keys[i] === undefined) {
-                continue;
-            }
-            pairs.push(keys[i] + '=' + env[keys[i]]);
-        }
-        return pairs;
-    };
-    return Terminal;
-}());
-exports.Terminal = Terminal;

package/types.js

@@ -1,6 +0,0 @@
-"use strict";
-/**
- * Copyright (c) 2017, Daniel Imms (MIT License).
- * Copyright (c) 2018, Microsoft Corporation (MIT License).
- */
-Object.defineProperty(exports, "__esModule", { value: true });