@poe-platform/safe-bash 0.1.630 → 0.1.631

package/dist/safe-bash/shell/input.d.ts

@@ -1,6 +1,22 @@
 import type { ByteSource, CommandInput, FileStat, FileSystem, InvocationCleanup } from "../contracts/index.js";
 import { Budget } from "./runtime.js";
-import { type ShellValue, type ValueAllocation } from "../contracts/value.js";
+import type { ShellValue, ValueAllocation } from "../contracts/value.js";
+import type { CommandContext } from "../contracts/command.js";
+import { type CommandFileDescriptor } from "../contracts/filesystem-descriptor.js";
+import type { ShellReadProbe } from "./extensions.js";
+export interface PreparedShellInput {
+    readonly source: ByteSource;
+    readonly options: Pick<ShellInputOptions, "provenance" | "poll" | "eof" | "descriptor"> & InputProvenance;
+    close(): Promise<void>;
+}
+export declare function inputBufferUsage(budget: Budget): Readonly<{
+    bytes: number;
+    buffers: number;
+}>;
+export declare function prepareBytesInput(value: string | Uint8Array, budget: Budget): PreparedShellInput;
+export declare function prepareFileInput(context: Pick<CommandContext, "fs" | "signal"> & Required<Pick<CommandContext, "registerCleanup">> & {
+    readonly cleanupFailurePrioritySignal?: AbortSignal | undefined;
+}, path: string, budget: Budget, inputProfile?: Pick<FileSystem, "readStream" | "capabilities">, admittedStat?: FileStat): Promise<PreparedShellInput>;
 type InputProvenance = Pick<CommandInput, "stat" | "seek"> & {
     readonly readChunk?: (maxBytes?: number) => Promise<IteratorResult<Uint8Array>>;
 };
@@ -8,28 +24,65 @@ export declare function fileInput(fs: FileSystem, path: string, maxBytes: number
     stat: FileStat;
     registerCleanup: (cleanup: InvocationCleanup) => void;
 }): Promise<ByteSource & InputProvenance>;
+export type InputReadiness = "ready" | "eof" | "blocked" | "unknown";
+export interface InputClock {
+    now(): number;
+    schedule(delayMs: number, expire: () => void): () => void;
+}
+export interface ShellInputOptions {
+    readonly descriptor?: CommandFileDescriptor;
+    readonly provenance?: "regular" | "stream" | "unknown";
+    readonly eof?: "terminal" | "retryable";
+    readonly poll?: () => InputReadiness;
+    readonly clock?: InputClock;
+}
+export interface ReadLineOptions {
+    readonly count?: number;
+    readonly delimiter?: number;
+    readonly byteCount?: boolean;
+    readonly exact?: boolean;
+    readonly timeoutMs?: number;
+}
+export interface ReadField {
+    readonly start: number;
+    readonly end: number;
+    readonly value: ShellValue;
+}
+export interface ReadLine {
+    readonly value: string;
+    readonly shellValue: ShellValue;
+    readonly escaped: ReadonlySet<number>;
+    readonly escapedByteOffsets: readonly number[];
+    readonly terminated: boolean;
+    readonly reason: "delimiter" | "count" | "eof" | "timeout";
+    fields(ifs: ShellValue, maximum?: number): Promise<readonly ReadField[]>;
+    release(): Promise<void>;
+}
+export interface RawRecordOptions {
+    readonly delimiter?: number;
+}
+export interface RawRecord {
+    readonly shellValue: ShellValue;
+    readonly reason: "delimiter" | "eof";
+    release(): Promise<void>;
+}
 export declare class ShellInput implements ByteSource, CommandInput {
     #private;
     readonly budget: Budget;
+    readonly descriptor: CommandFileDescriptor | undefined;
     readonly signal: AbortSignal;
     readonly stat?: FileStat;
     readonly seek?: NonNullable<CommandInput["seek"]>;
-    constructor(source: ByteSource, budget: Budget, signal?: AbortSignal, provenance?: InputProvenance);
+    constructor(source: ByteSource, budget: Budget, signal?: AbortSignal, options?: ShellInputOptions & InputProvenance);
+    get bufferedBytes(): number;
+    readiness(): InputReadiness;
+    probeRead(): ShellReadProbe;
     get position(): number;
     read(maxBytes: number, callerSignal: AbortSignal): Promise<IteratorResult<Uint8Array>>;
     next(): Promise<IteratorResult<Uint8Array>>;
     [Symbol.asyncIterator](): AsyncIterableIterator<Uint8Array>;
     sourceLine(): Promise<Uint8Array | undefined>;
-    line(raw: boolean, options?: {
-        count?: number;
-        delimiter?: number;
-        byteCount?: boolean;
-        exact?: boolean;
-    }): Promise<{
-        value: string;
-        escaped: ReadonlySet<number>;
-        terminated: boolean;
-    }>;
+    record(options?: RawRecordOptions): Promise<RawRecord>;
     /** Select uses read's escape rules without projecting raw REPLY bytes to text. */
     selectLine(allocation: ValueAllocation): Promise<{
         value: ShellValue;
@@ -39,8 +92,7 @@ export declare class ShellInput implements ByteSource, CommandInput {
         value: ShellValue;
         present: boolean;
     }>;
-    private readBounded;
-    private readLine;
+    line(raw: boolean, options?: ReadLineOptions): Promise<ReadLine>;
     close(): Promise<void>;
 }
 export {};

package/dist/safe-bash/shell/input.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"input.d.ts","sourceRoot":"","sources":["../../src/shell/input.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAkB,QAAQ,EAAE,UAAU,EAA0B,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAEvJ,OAAO,EAAE,MAAM,EAAiB,MAAM,cAAc,CAAC;AACrD,OAAO,EAA0C,KAAK,UAAU,EAAE,KAAK,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAEtH,KAAK,eAAe,GAAG,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG;IAC3D,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC;CACjF,CAAC;AAEF,wBAAsB,SAAS,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,YAAY,GAAE,IAAI,CAAC,UAAU,EAAE,YAAY,GAAG,cAAc,CAAM,EAAE,SAAS,CAAC,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,eAAe,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,CAAA;CAAE,GAAG,OAAO,CAAC,UAAU,GAAG,eAAe,CAAC,CAwIrS;AAyHD,qBAAa,UAAW,YAAW,UAAU,EAAE,YAAY;;IAUzB,QAAQ,CAAC,MAAM,EAAE,MAAM;IALvD,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAC7B,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;gBAGtC,MAAM,EAAE,UAAU,EAAW,MAAM,EAAE,MAAM,EAAE,MAAM,cAAgB,EAAE,UAAU,GAAE,eAAoB;IAejH,IAAI,QAAQ,IAAI,MAAM,CAAkC;IAExD,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAoDtF,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAQ3C,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,qBAAqB,CAAC,UAAU,CAAC;IAI3D,UAAU,IAAI,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IA4B7C,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QAAC,UAAU,EAAE,OAAO,CAAA;KAAE,CAAC;IAIzL,kFAAkF;IAClF,UAAU,CAAC,UAAU,EAAE,eAAe,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,UAAU,CAAC;QAAC,UAAU,EAAE,OAAO,CAAA;KAAE,CAAC;IA4C5F,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,eAAe,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,UAAU,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;YA8CjH,WAAW;YAiEX,QAAQ;IAqDtB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAOvB"}
+{"version":3,"file":"input.d.ts","sourceRoot":"","sources":["../../src/shell/input.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAkB,QAAQ,EAAE,UAAU,EAA0B,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAEvJ,OAAO,EAAE,MAAM,EAAiB,MAAM,cAAc,CAAC;AAErD,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAoB,MAAM,uBAAuB,CAAC;AAE3F,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAmB,KAAK,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AACpG,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEtD,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,YAAY,GAAG,MAAM,GAAG,KAAK,GAAG,YAAY,CAAC,GAAG,eAAe,CAAC;IAC1G,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAKD,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC,CAK7F;AA2BD,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,kBAAkB,CAuChG;AAED,wBAAsB,gBAAgB,CACpC,OAAO,EAAE,IAAI,CAAC,cAAc,EAAE,IAAI,GAAG,QAAQ,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC,GAC9F;IAAE,QAAQ,CAAC,4BAA4B,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;CAAE,EACvE,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,YAAY,GAAE,IAAI,CAAC,UAAU,EAAE,YAAY,GAAG,cAAc,CAAc,EAC1E,YAAY,CAAC,EAAE,QAAQ,GACtB,OAAO,CAAC,kBAAkB,CAAC,CA8J7B;AAED,KAAK,eAAe,GAAG,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG;IAC3D,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC;CACjF,CAAC;AAEF,wBAAsB,SAAS,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,YAAY,GAAE,IAAI,CAAC,UAAU,EAAE,YAAY,GAAG,cAAc,CAAM,EAAE,SAAS,CAAC,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,eAAe,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,CAAA;CAAE,GAAG,OAAO,CAAC,UAAU,GAAG,eAAe,CAAC,CAwIrS;AAED,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,KAAK,GAAG,SAAS,GAAG,SAAS,CAAC;AAErE,MAAM,WAAW,UAAU;IACzB,GAAG,IAAI,MAAM,CAAC;IACd,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC;CAC3D;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,UAAU,CAAC,EAAE,qBAAqB,CAAC;IAC5C,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;IACvD,QAAQ,CAAC,GAAG,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IACxC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,cAAc,CAAC;IACrC,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC;CAC7B;AA+ND,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;CAC5B;AAED,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IACtC,QAAQ,CAAC,kBAAkB,EAAE,SAAS,MAAM,EAAE,CAAC;IAC/C,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC;IAC3D,MAAM,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,SAAS,EAAE,CAAC,CAAC;IACzE,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1B;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,QAAQ,CAAC,MAAM,EAAE,WAAW,GAAG,KAAK,CAAC;IACrC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1B;AA8CD,qBAAa,UAAW,YAAW,UAAU,EAAE,YAAY;;IAYzB,QAAQ,CAAC,MAAM,EAAE,MAAM;IAXvD,QAAQ,CAAC,UAAU,EAAE,qBAAqB,GAAG,SAAS,CAAC;IAKvD,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAE7B,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;gBAGtC,MAAM,EAAE,UAAU,EAAW,MAAM,EAAE,MAAM,EAAE,MAAM,cAAgB,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,eAAe;IAkB9H,IAAI,aAAa,IAAI,MAAM,CAG1B;IAED,SAAS,IAAI,cAAc;IAO3B,SAAS,IAAI,cAAc;IAO3B,IAAI,QAAQ,IAAI,MAAM,CAAkC;IAExD,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAoDtF,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAS3C,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,qBAAqB,CAAC,UAAU,CAAC;IAI3D,UAAU,IAAI,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IA4BvC,MAAM,CAAC,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,SAAS,CAAC;IA8DhE,kFAAkF;IAClF,UAAU,CAAC,UAAU,EAAE,eAAe,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,UAAU,CAAC;QAAC,UAAU,EAAE,OAAO,CAAA;KAAE,CAAC;IA4C5F,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,eAAe,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,UAAU,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IA8CzH,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,GAAE,eAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAgP1E,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CASvB"}