@easbot/utils 0.2.5 → 0.2.7

package/dist/index.d.cts

@@ -1,3 +1,4 @@
+import { ChildProcess } from 'node:child_process';
 import z, { z as z$1 } from 'zod';
 export { z } from 'zod';
 import { statSync } from 'node:fs';
@@ -12,7 +13,6 @@ import { ServerType } from '@hono/node-server';
 import { cors } from 'hono/cors';
 export { cors } from 'hono/cors';
 import { GlobOptions } from 'glob';
-import { ChildProcess } from 'node:child_process';
 export { HTTPException } from 'hono/http-exception';
 import { ShellExpression, EasbotShellPromise, EasbotShell } from '@easbot/types';
 export { SSEStreamingApi } from 'hono/streaming';
@@ -69,6 +69,76 @@ declare namespace TruncateContent {
     function formatHint(result: Result): string;
 }
 
+interface ShellItem {
+    path: string;
+    name: string;
+    acceptable: boolean;
+}
+declare namespace Shell {
+    interface Meta {
+        deny?: boolean;
+        login?: boolean;
+        posix?: boolean;
+        ps?: boolean;
+    }
+    interface KillTreeOptions {
+        exited?: () => boolean;
+    }
+    interface SelectOptions {
+        acceptable?: boolean;
+    }
+    function killTree(proc: ChildProcess, opts?: KillTreeOptions): Promise<void>;
+    const defaultPreferred: {
+        (): string | undefined;
+        reset(): void;
+    };
+    const defaultAcceptable: {
+        (): string | undefined;
+        reset(): void;
+    };
+    function gitbash(): string | undefined;
+    function name(file: string): string;
+    function login(file: string): boolean;
+    function posix(file: string): boolean;
+    function ps(file: string): boolean;
+    function args(file: string, command: string, cwd: string): string[];
+    function preferred(configShell?: string): string | undefined;
+    function acceptable(configShell?: string): string | undefined;
+    function reset(): void;
+    function list(): Promise<ShellItem[]>;
+    function metaInfo(file: string): Meta | undefined;
+    function needsShell(command: string): boolean;
+    function platformShells(): string[];
+    function isValid(file: string): boolean;
+    function version(file: string): Promise<string | undefined>;
+    interface RunOptions {
+        cwd?: string;
+        env?: Record<string, string | undefined>;
+        timeout?: number;
+        signal?: AbortSignal;
+        windowsHide?: boolean;
+        shell?: boolean;
+    }
+    interface SpawnOptions extends RunOptions {
+        stdout?: 'pipe' | 'inherit' | 'null';
+        stderr?: 'pipe' | 'inherit' | 'null';
+        stdin?: 'pipe' | 'inherit' | 'null';
+    }
+    function run(shell: string, command: string, options?: RunOptions): Promise<{
+        code: number;
+        stdout: string;
+        stderr: string;
+    }>;
+    function spawn(shell: string, command: string, options?: SpawnOptions): {
+        stdout: any;
+        stderr: any;
+        stdin: any;
+        pid: number;
+        exited: Promise<number>;
+        kill: (signal?: string | number) => boolean;
+    };
+}
+
 declare function formatLocalISO(date: Date | number, includeMilliseconds?: boolean): string;
 declare function formatLocalISOCompact(date: Date | number): string;
 declare function now(): number;
@@ -780,6 +850,8 @@ interface NodeSpawnOptions {
     stdin?: 'pipe' | 'inherit' | 'null';
     signal?: AbortSignal;
     timeout?: number | false;
+    windowsHide?: boolean;
+    shell?: boolean;
 }
 interface NodeSpawnObjectArgs {
     cmd: string[];
@@ -790,6 +862,8 @@ interface NodeSpawnObjectArgs {
     stdin?: 'pipe' | 'inherit' | 'null';
     signal?: AbortSignal;
     timeout?: number | false;
+    windowsHide?: boolean;
+    shell?: boolean;
 }
 interface NodeSpawnResult {
     stdout: stream.Readable;
@@ -832,6 +906,8 @@ declare namespace PKG {
         cwd?: string;
         env?: Record<string, string | undefined>;
         timeout?: number;
+        windowsHide?: boolean;
+        shell?: boolean;
     }): Promise<{
         code: number;
         stdout: string;
@@ -1170,6 +1246,19 @@ declare namespace PackageRegistry {
     function isOutdated(pkg: string, cachedVersion: string, cwd?: string): Promise<boolean>;
 }
 
+interface ParseCommandResult {
+    command: string;
+    args: string[];
+    options?: Record<string, unknown>;
+}
+declare function parseCommand(command: string): string[];
+declare function needsShellExecution(command: string): boolean;
+declare function parseCommandWithOptions(command: string): ParseCommandResult;
+declare function escapeCommandArg(arg: string, platform?: 'windows' | 'unix'): string;
+declare function escapeCommandArgSafe(arg: string, platform?: 'windows' | 'unix'): string;
+declare function detectPlatform(): 'windows' | 'unix';
+declare function joinCommandArgs(command: string, args: string[], platform?: 'windows' | 'unix'): string;
+
 declare namespace Identifier {
     const prefixes: {
         readonly event: "evt";
@@ -1301,48 +1390,6 @@ declare namespace Lock {
     function write(key: string): Promise<Disposable>;
 }
 
-declare namespace Process {
-    type Stdio = 'inherit' | 'pipe' | 'ignore';
-    type Shell = boolean | string;
-    interface Options {
-        cwd?: string;
-        env?: NodeJS.ProcessEnv | null;
-        stdin?: Stdio;
-        stdout?: Stdio;
-        stderr?: Stdio;
-        shell?: Shell;
-        abort?: AbortSignal;
-        kill?: NodeJS.Signals | number;
-        timeout?: number;
-    }
-    interface RunOptions extends Omit<Options, 'stdout' | 'stderr'> {
-        nothrow?: boolean;
-    }
-    interface Result {
-        code: number;
-        stdout: Buffer;
-        stderr: Buffer;
-    }
-    interface TextResult extends Result {
-        text: string;
-    }
-    class RunFailedError extends Error {
-        readonly cmd: string[];
-        readonly code: number;
-        readonly stdout: Buffer;
-        readonly stderr: Buffer;
-        constructor(cmd: string[], code: number, stdout: Buffer, stderr: Buffer);
-    }
-    type Child = ChildProcess & {
-        exited: Promise<number>;
-    };
-    function spawn(cmd: string[], opts?: Options): Child;
-    function run(cmd: string[], opts?: RunOptions): Promise<Result>;
-    function stop(proc: ChildProcess): Promise<void>;
-    function text(cmd: string[], opts?: RunOptions): Promise<TextResult>;
-    function lines(cmd: string[], opts?: RunOptions): Promise<string[]>;
-}
-
 declare function proxied(): boolean;
 
 declare class AsyncQueue<T> implements AsyncIterable<T> {
@@ -1395,4 +1442,4 @@ declare function initLog(options: {
     level?: 'DEBUG' | 'INFO' | 'WARN' | 'ERROR';
 }): Promise<void>;
 
-export { $, Archive, AsyncQueue, Binary, type CodeSpanIndex$1 as CodeSpanIndex, Color, Context, type EasServer, Encode, EventLoop, type FenceSpan$1 as FenceSpan, Filesystem, Fn, type FormatOptions, type GitResult, Glob, Identifier, Ignore, type InlineCodeState$1 as InlineCodeState, Keybind, Lazy, Locale, Lock, Markdown, type MarkdownConfig, type MarkdownIR, type MarkdownLinkSpan, type MarkdownParseOptions, type MarkdownStyle, type MarkdownStyleSpan, type MarkdownTableMode, type MiddlewareDefinition, NamedError, type NodeSpawnObjectArgs, type NodeSpawnOptions, type NodeSpawnResult, type NodeWhichOptions, PKG, PackageRegistry, type ParsedFrontmatter, type ParsedVersion, PkgShell, Process, type RPCMethod, type RenderLink, type RenderOptions, type RouteDefinition, type SSEHandler, Semver, type ServerOptions, Slug, type StreamHandler, type StyleMarker, Token, TruncateContent, type WebSocketHandler, type WebSocketRouteDefinition, Wildcard, abortAfter, abortAfterAny, buildCodeSpanIndex, chunkMarkdownIR, chunkText, chunkTextByBreakResolver, convertMarkdownTables, createInlineCodeState, createPkgShell, createRESTServer, createRPCServer, createServer, createStreamingServer, createWebSocketServer, defer, extractFrontmatter, findFenceSpanAt, findLast, fn, formatDuration, formatLocalISO, formatLocalISOCompact, formatLogTime, formatMarkdown, getDirectory, getFileExtension, getFilename, getFilenameTruncated, getTimezoneOffset, git, iife, initLog, isSafeFenceBreak, lazy, lazyAsync, loadEnv, loadTextFile, loadTextFileAsync, markdownToIR, markdownToIRWithMeta, now, nowLocalISO, parseFenceSpans, parseFrontmatterBlock, parseLocalISO, parseModelId, proxied, readableStreamToText, renderMarkdown, renderMarkdownWithMarkers, retry, scanParenAwareBreakpoints, serializeFrontmatter, shell, signal, startServer, truncateMiddle, updateSchema, whichSync, withTimeout, work };
+export { $, Archive, AsyncQueue, Binary, type CodeSpanIndex$1 as CodeSpanIndex, Color, Context, type EasServer, Encode, EventLoop, type FenceSpan$1 as FenceSpan, Filesystem, Fn, type FormatOptions, type GitResult, Glob, Identifier, Ignore, type InlineCodeState$1 as InlineCodeState, Keybind, Lazy, Locale, Lock, Markdown, type MarkdownConfig, type MarkdownIR, type MarkdownLinkSpan, type MarkdownParseOptions, type MarkdownStyle, type MarkdownStyleSpan, type MarkdownTableMode, type MiddlewareDefinition, NamedError, type NodeSpawnObjectArgs, type NodeSpawnOptions, type NodeSpawnResult, type NodeWhichOptions, PKG, PackageRegistry, type ParseCommandResult, type ParsedFrontmatter, type ParsedVersion, PkgShell, type RPCMethod, type RenderLink, type RenderOptions, type RouteDefinition, type SSEHandler, Semver, type ServerOptions, Shell, Slug, type StreamHandler, type StyleMarker, Token, TruncateContent, type WebSocketHandler, type WebSocketRouteDefinition, Wildcard, abortAfter, abortAfterAny, buildCodeSpanIndex, chunkMarkdownIR, chunkText, chunkTextByBreakResolver, convertMarkdownTables, createInlineCodeState, createPkgShell, createRESTServer, createRPCServer, createServer, createStreamingServer, createWebSocketServer, defer, detectPlatform, escapeCommandArg, escapeCommandArgSafe, extractFrontmatter, findFenceSpanAt, findLast, fn, formatDuration, formatLocalISO, formatLocalISOCompact, formatLogTime, formatMarkdown, getDirectory, getFileExtension, getFilename, getFilenameTruncated, getTimezoneOffset, git, iife, initLog, isSafeFenceBreak, joinCommandArgs, lazy, lazyAsync, loadEnv, loadTextFile, loadTextFileAsync, markdownToIR, markdownToIRWithMeta, needsShellExecution, now, nowLocalISO, parseCommand, parseCommandWithOptions, parseFenceSpans, parseFrontmatterBlock, parseLocalISO, parseModelId, proxied, readableStreamToText, renderMarkdown, renderMarkdownWithMarkers, retry, scanParenAwareBreakpoints, serializeFrontmatter, shell, signal, startServer, truncateMiddle, updateSchema, whichSync, withTimeout, work };

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { ChildProcess } from 'node:child_process';
 import z, { z as z$1 } from 'zod';
 export { z } from 'zod';
 import { statSync } from 'node:fs';
@@ -12,7 +13,6 @@ import { ServerType } from '@hono/node-server';
 import { cors } from 'hono/cors';
 export { cors } from 'hono/cors';
 import { GlobOptions } from 'glob';
-import { ChildProcess } from 'node:child_process';
 export { HTTPException } from 'hono/http-exception';
 import { ShellExpression, EasbotShellPromise, EasbotShell } from '@easbot/types';
 export { SSEStreamingApi } from 'hono/streaming';
@@ -69,6 +69,76 @@ declare namespace TruncateContent {
     function formatHint(result: Result): string;
 }
 
+interface ShellItem {
+    path: string;
+    name: string;
+    acceptable: boolean;
+}
+declare namespace Shell {
+    interface Meta {
+        deny?: boolean;
+        login?: boolean;
+        posix?: boolean;
+        ps?: boolean;
+    }
+    interface KillTreeOptions {
+        exited?: () => boolean;
+    }
+    interface SelectOptions {
+        acceptable?: boolean;
+    }
+    function killTree(proc: ChildProcess, opts?: KillTreeOptions): Promise<void>;
+    const defaultPreferred: {
+        (): string | undefined;
+        reset(): void;
+    };
+    const defaultAcceptable: {
+        (): string | undefined;
+        reset(): void;
+    };
+    function gitbash(): string | undefined;
+    function name(file: string): string;
+    function login(file: string): boolean;
+    function posix(file: string): boolean;
+    function ps(file: string): boolean;
+    function args(file: string, command: string, cwd: string): string[];
+    function preferred(configShell?: string): string | undefined;
+    function acceptable(configShell?: string): string | undefined;
+    function reset(): void;
+    function list(): Promise<ShellItem[]>;
+    function metaInfo(file: string): Meta | undefined;
+    function needsShell(command: string): boolean;
+    function platformShells(): string[];
+    function isValid(file: string): boolean;
+    function version(file: string): Promise<string | undefined>;
+    interface RunOptions {
+        cwd?: string;
+        env?: Record<string, string | undefined>;
+        timeout?: number;
+        signal?: AbortSignal;
+        windowsHide?: boolean;
+        shell?: boolean;
+    }
+    interface SpawnOptions extends RunOptions {
+        stdout?: 'pipe' | 'inherit' | 'null';
+        stderr?: 'pipe' | 'inherit' | 'null';
+        stdin?: 'pipe' | 'inherit' | 'null';
+    }
+    function run(shell: string, command: string, options?: RunOptions): Promise<{
+        code: number;
+        stdout: string;
+        stderr: string;
+    }>;
+    function spawn(shell: string, command: string, options?: SpawnOptions): {
+        stdout: any;
+        stderr: any;
+        stdin: any;
+        pid: number;
+        exited: Promise<number>;
+        kill: (signal?: string | number) => boolean;
+    };
+}
+
 declare function formatLocalISO(date: Date | number, includeMilliseconds?: boolean): string;
 declare function formatLocalISOCompact(date: Date | number): string;
 declare function now(): number;
@@ -780,6 +850,8 @@ interface NodeSpawnOptions {
     stdin?: 'pipe' | 'inherit' | 'null';
     signal?: AbortSignal;
     timeout?: number | false;
+    windowsHide?: boolean;
+    shell?: boolean;
 }
 interface NodeSpawnObjectArgs {
     cmd: string[];
@@ -790,6 +862,8 @@ interface NodeSpawnObjectArgs {
     stdin?: 'pipe' | 'inherit' | 'null';
     signal?: AbortSignal;
     timeout?: number | false;
+    windowsHide?: boolean;
+    shell?: boolean;
 }
 interface NodeSpawnResult {
     stdout: stream.Readable;
@@ -832,6 +906,8 @@ declare namespace PKG {
         cwd?: string;
         env?: Record<string, string | undefined>;
         timeout?: number;
+        windowsHide?: boolean;
+        shell?: boolean;
     }): Promise<{
         code: number;
         stdout: string;
@@ -1170,6 +1246,19 @@ declare namespace PackageRegistry {
     function isOutdated(pkg: string, cachedVersion: string, cwd?: string): Promise<boolean>;
 }
 
+interface ParseCommandResult {
+    command: string;
+    args: string[];
+    options?: Record<string, unknown>;
+}
+declare function parseCommand(command: string): string[];
+declare function needsShellExecution(command: string): boolean;
+declare function parseCommandWithOptions(command: string): ParseCommandResult;
+declare function escapeCommandArg(arg: string, platform?: 'windows' | 'unix'): string;
+declare function escapeCommandArgSafe(arg: string, platform?: 'windows' | 'unix'): string;
+declare function detectPlatform(): 'windows' | 'unix';
+declare function joinCommandArgs(command: string, args: string[], platform?: 'windows' | 'unix'): string;
+
 declare namespace Identifier {
     const prefixes: {
         readonly event: "evt";
@@ -1301,48 +1390,6 @@ declare namespace Lock {
     function write(key: string): Promise<Disposable>;
 }
 
-declare namespace Process {
-    type Stdio = 'inherit' | 'pipe' | 'ignore';
-    type Shell = boolean | string;
-    interface Options {
-        cwd?: string;
-        env?: NodeJS.ProcessEnv | null;
-        stdin?: Stdio;
-        stdout?: Stdio;
-        stderr?: Stdio;
-        shell?: Shell;
-        abort?: AbortSignal;
-        kill?: NodeJS.Signals | number;
-        timeout?: number;
-    }
-    interface RunOptions extends Omit<Options, 'stdout' | 'stderr'> {
-        nothrow?: boolean;
-    }
-    interface Result {
-        code: number;
-        stdout: Buffer;
-        stderr: Buffer;
-    }
-    interface TextResult extends Result {
-        text: string;
-    }
-    class RunFailedError extends Error {
-        readonly cmd: string[];
-        readonly code: number;
-        readonly stdout: Buffer;
-        readonly stderr: Buffer;
-        constructor(cmd: string[], code: number, stdout: Buffer, stderr: Buffer);
-    }
-    type Child = ChildProcess & {
-        exited: Promise<number>;
-    };
-    function spawn(cmd: string[], opts?: Options): Child;
-    function run(cmd: string[], opts?: RunOptions): Promise<Result>;
-    function stop(proc: ChildProcess): Promise<void>;
-    function text(cmd: string[], opts?: RunOptions): Promise<TextResult>;
-    function lines(cmd: string[], opts?: RunOptions): Promise<string[]>;
-}
-
 declare function proxied(): boolean;
 
 declare class AsyncQueue<T> implements AsyncIterable<T> {
@@ -1395,4 +1442,4 @@ declare function initLog(options: {
     level?: 'DEBUG' | 'INFO' | 'WARN' | 'ERROR';
 }): Promise<void>;
 
-export { $, Archive, AsyncQueue, Binary, type CodeSpanIndex$1 as CodeSpanIndex, Color, Context, type EasServer, Encode, EventLoop, type FenceSpan$1 as FenceSpan, Filesystem, Fn, type FormatOptions, type GitResult, Glob, Identifier, Ignore, type InlineCodeState$1 as InlineCodeState, Keybind, Lazy, Locale, Lock, Markdown, type MarkdownConfig, type MarkdownIR, type MarkdownLinkSpan, type MarkdownParseOptions, type MarkdownStyle, type MarkdownStyleSpan, type MarkdownTableMode, type MiddlewareDefinition, NamedError, type NodeSpawnObjectArgs, type NodeSpawnOptions, type NodeSpawnResult, type NodeWhichOptions, PKG, PackageRegistry, type ParsedFrontmatter, type ParsedVersion, PkgShell, Process, type RPCMethod, type RenderLink, type RenderOptions, type RouteDefinition, type SSEHandler, Semver, type ServerOptions, Slug, type StreamHandler, type StyleMarker, Token, TruncateContent, type WebSocketHandler, type WebSocketRouteDefinition, Wildcard, abortAfter, abortAfterAny, buildCodeSpanIndex, chunkMarkdownIR, chunkText, chunkTextByBreakResolver, convertMarkdownTables, createInlineCodeState, createPkgShell, createRESTServer, createRPCServer, createServer, createStreamingServer, createWebSocketServer, defer, extractFrontmatter, findFenceSpanAt, findLast, fn, formatDuration, formatLocalISO, formatLocalISOCompact, formatLogTime, formatMarkdown, getDirectory, getFileExtension, getFilename, getFilenameTruncated, getTimezoneOffset, git, iife, initLog, isSafeFenceBreak, lazy, lazyAsync, loadEnv, loadTextFile, loadTextFileAsync, markdownToIR, markdownToIRWithMeta, now, nowLocalISO, parseFenceSpans, parseFrontmatterBlock, parseLocalISO, parseModelId, proxied, readableStreamToText, renderMarkdown, renderMarkdownWithMarkers, retry, scanParenAwareBreakpoints, serializeFrontmatter, shell, signal, startServer, truncateMiddle, updateSchema, whichSync, withTimeout, work };
+export { $, Archive, AsyncQueue, Binary, type CodeSpanIndex$1 as CodeSpanIndex, Color, Context, type EasServer, Encode, EventLoop, type FenceSpan$1 as FenceSpan, Filesystem, Fn, type FormatOptions, type GitResult, Glob, Identifier, Ignore, type InlineCodeState$1 as InlineCodeState, Keybind, Lazy, Locale, Lock, Markdown, type MarkdownConfig, type MarkdownIR, type MarkdownLinkSpan, type MarkdownParseOptions, type MarkdownStyle, type MarkdownStyleSpan, type MarkdownTableMode, type MiddlewareDefinition, NamedError, type NodeSpawnObjectArgs, type NodeSpawnOptions, type NodeSpawnResult, type NodeWhichOptions, PKG, PackageRegistry, type ParseCommandResult, type ParsedFrontmatter, type ParsedVersion, PkgShell, type RPCMethod, type RenderLink, type RenderOptions, type RouteDefinition, type SSEHandler, Semver, type ServerOptions, Shell, Slug, type StreamHandler, type StyleMarker, Token, TruncateContent, type WebSocketHandler, type WebSocketRouteDefinition, Wildcard, abortAfter, abortAfterAny, buildCodeSpanIndex, chunkMarkdownIR, chunkText, chunkTextByBreakResolver, convertMarkdownTables, createInlineCodeState, createPkgShell, createRESTServer, createRPCServer, createServer, createStreamingServer, createWebSocketServer, defer, detectPlatform, escapeCommandArg, escapeCommandArgSafe, extractFrontmatter, findFenceSpanAt, findLast, fn, formatDuration, formatLocalISO, formatLocalISOCompact, formatLogTime, formatMarkdown, getDirectory, getFileExtension, getFilename, getFilenameTruncated, getTimezoneOffset, git, iife, initLog, isSafeFenceBreak, joinCommandArgs, lazy, lazyAsync, loadEnv, loadTextFile, loadTextFileAsync, markdownToIR, markdownToIRWithMeta, needsShellExecution, now, nowLocalISO, parseCommand, parseCommandWithOptions, parseFenceSpans, parseFrontmatterBlock, parseLocalISO, parseModelId, proxied, readableStreamToText, renderMarkdown, renderMarkdownWithMarkers, retry, scanParenAwareBreakpoints, serializeFrontmatter, shell, signal, startServer, truncateMiddle, updateSchema, whichSync, withTimeout, work };