pty-shell 1.0.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 xiaobaidadada
+
+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,30 @@
+# pty-shell
+This is a virtual PTY shell that can be used to filter or log executable commands. It can also be used in a browser environment. Currently, it does not support features like piping. It supports the use of `node-pty`. For more usage examples, you can refer to the code in the [filecat](https://github.com/xiaobaidadada/filecat) project.
+It needs to be used in combination with projects similar to xterm.js.
+这是一个虚拟的pty shell ，可以用来过滤或者记录可执行命令， 并可以用于浏览器环境， 目前并不支持管道等功能，支持使用 node-pty ，更多使用例子目前可以参考 filecat(https://github.com/xiaobaidadada/filecat)项目中的代码 。 
+需要配合  xterm.js 类似的项目组合使用
+# Sample Example
+```js
+import {PtyShell} from "pty-shell";
+
+const ptyShell = new PtyShell({
+    cols: 200,
+    rows: 300,
+    cwd: __dirname,
+    node_pty:undefined,
+    node_pty_shell_list: [],
+    env:{},
+    on_call:(data)=>{
+        console.log(data)
+    }
+});
+ptyShell.write("cd .. \r");
+
+```
+
+# supports
+1. commands auto-completion 
+2. command and parameter interception and filtering
+3. browser environment
+4. use node-pty 
+5. operations such as command, select all, move, select, etc., similar to those in PowerShell.

package/dist/index.d.ts

@@ -0,0 +1,134 @@
+/**
+ * 有一些子进程 必须要 pty 环境 这里是没有办法的
+ * 一个标准的 pty 需要具备以下功能：
+ * 输入输出流：处理标准输入、标准输出和标准错误。
+ * 环境和工作目录管理：设置子进程的环境变量和工作目录。
+ * 终端特性：模拟终端的大小、信号和模式。
+ * 子进程管理：启动和管理子进程，处理进程的退出状态。
+ * 读取输出与写入输入：捕获输出并发送输入，模拟用户交互。
+ * 信号和控制字符支持：处理回车、换行等控制字符，并支持信号转发。
+ */
+export declare enum exec_type {
+    not = -1,// 不能执行
+    auto_child_process = 0,// 使用内置子线程执行(除了cd命令)
+    not_pty = 1,// 使用node_pty 执行(前提是传入了 node_pty)
+    continue = 2
+}
+export declare enum exec_cmd_type {
+    copy_text = 0
+}
+interface prompt_call_result {
+    char_num: number;
+    str: string;
+}
+interface PtyShellUserMethod {
+    on_call: (data: string) => void;
+    on_control_cmd: (type: exec_cmd_type, data?: string) => void;
+    on_prompt_call: (cwd: string) => prompt_call_result;
+    on_child_kill?: (code: number, pid: number) => void;
+    check_exe_cmd?: (cmd_exe: string, params: string[]) => Promise<exec_type>;
+    cmd_params_auto_completion: (param_word: string) => string;
+    cmd_exe_auto_completion?: (cmd_exe_word: string) => string;
+}
+interface Param extends Partial<PtyShellUserMethod> {
+    cwd: string;
+    not_use_node_pre_cmd_exec?: boolean;
+    node_pty?: any;
+    cols?: number;
+    rows?: number;
+    env?: any;
+    node_pty_shell_list?: string[];
+}
+type CmdHandler = (params: string[], send_prompt?: (data: string) => void) => void;
+export declare class PtyShell implements PtyShellUserMethod {
+    rows: number;
+    cols: number;
+    cwd: string;
+    env: {};
+    constructor(param: Param);
+    cmd_params_auto_completion(param_str: any): string | undefined;
+    cmd_exe_auto_completion: any;
+    on_prompt_call: (cwd: any) => {
+        str: string;
+        char_num: number;
+    };
+    on_call: (data: string) => void;
+    on_control_cmd: (type: exec_cmd_type, data?: string) => void;
+    on_child_kill?: (code: number, pid?: number) => void;
+    check_exe_cmd: any;
+    private cmd_set;
+    private shell_set;
+    private node_require;
+    private not_use_node_pre_cmd_exec;
+    private cmd_exec_map;
+    private prompt_call_len;
+    private is_running;
+    private child_now_line;
+    private word_detection;
+    private node_pty;
+    private child;
+    private is_pty;
+    private line;
+    private line_index;
+    private select_line;
+    private select_start;
+    private select_end;
+    private history_line;
+    private history_line_index;
+    /**
+     * public method
+     */
+    reset_option(param: Param): void;
+    add_cmd_handle(exe_cmd: string, handle: CmdHandler): void;
+    close(): void;
+    kill(): void;
+    /**
+     *  处理字符串内容工具函数 防止输出的时候 在尾部单词截断
+     * @param str
+     */
+    cols_handle(str: string): string;
+    /**
+     * 向pty写入数据
+     * @param data
+     */
+    write(data: string): Promise<void>;
+    /**
+     *  static method
+     */
+    static isFullCharWidth(char: any): boolean;
+    static readFullCharIndex(str: string, start_index: number, len: number): number;
+    static get_full_char_num(str: string): number;
+    /**
+     * private method
+     */
+    private get raw_prompt();
+    private get enter_prompt();
+    private clear_line;
+    private get is_line_end();
+    private insert_line;
+    private close_child;
+    private next_not_enter;
+    private send_and_enter;
+    private update_line;
+    private cancel_selected;
+    private get line_char_index();
+    private ctrl_exec;
+    private push_history_line;
+    private exec_end_call;
+    private parse_exec;
+    private multiple_line;
+    private spawn_write;
+    private spawn;
+    private exec_cmd;
+    private get_exec;
+    get_last_word_cmd_or_param(line: any, now_index: any): {
+        word: string;
+        is_exe: boolean;
+    };
+    private is_empty;
+    private get_enter_index;
+    private get_enter_line;
+    private removeCharacterAt;
+    private delete_all_enter;
+}
+export {};