@phpsandbox/sdk 0.0.27 → 0.0.28

package/dist/shell.d.ts

@@ -1,14 +1,30 @@
-import { Action, NotebookInstance } from './index.js';
-export interface ShellEvents {
+import { Action, Disposable, NotebookInstance } from './index.js';
+import type { SpawnOptions } from './terminal.js';
+export interface ShellEventData {
+    'shell.output': {
+        output: string;
+        id: string;
+    };
+}
+type PrefixKey<K extends keyof ShellEventData> = `${K}.${string}`;
+type ShellEventPattern = PrefixKey<keyof ShellEventData>;
+export type ShellEvents = ShellEventData & {
+    [K in ShellEventPattern]: ShellEventData['shell.output'];
+};
+export interface ShellExecInput {
+    command: string | string[];
+    opts?: Omit<SpawnOptions, 'abortSignal'>;
 }
 export interface ShellActions {
-    'shell.exec': Action<{
-        command: string | string;
-    }, {
+    'shell.exec': Action<ShellExecInput, {
         output: string;
         exitCode: number;
     }>;
 }
+export interface ShellExecution {
+    output: ReadableStream<string>;
+    result: Promise<Result>;
+}
 export declare class CommandError extends Error {
     output: string;
     exitCode: number;
@@ -23,7 +39,12 @@ declare class Result {
 export default class Shell {
     protected okra: NotebookInstance;
     constructor(okra: NotebookInstance);
-    exec(command: string | string): Promise<Result>;
+    onOutput(id: string, handler: (data: ShellEvents['shell.output']) => void): void;
+    listen<T extends keyof ShellEvents>(event: T, handler: (data: ShellEvents[T]) => void): Disposable;
+    exec(command: string | string[], opts?: SpawnOptions): Promise<Result>;
+    exec(command: string, args: string[], opts?: SpawnOptions): Promise<Result>;
+    execStream(command: string | string[], opts?: SpawnOptions): ShellExecution;
+    execStream(command: string, args: string[], opts?: SpawnOptions): ShellExecution;
 }
 export {};
 //# sourceMappingURL=shell.d.ts.map

package/dist/shell.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shell.d.ts","sourceRoot":"","sources":["../src/shell.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEtD,MAAM,WAAW,WAAW;CAAG;AAE/B,MAAM,WAAW,YAAY;IAC3B,YAAY,EAAE,MAAM,CAAC;QAAE,OAAO,EAAE,MAAM,GAAC,MAAM,CAAA;KAAE,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACxF;AAED,qBAAa,YAAa,SAAQ,KAAK;IAE5B,MAAM,EAAE,MAAM;IACd,QAAQ,EAAE,MAAM;gBADhB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM;CAI1B;AAED,cAAM,MAAM;IAED,MAAM,EAAE,MAAM;IACd,QAAQ,EAAE,MAAM;gBADhB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM;IAGlB,KAAK;CAOb;AAED,MAAM,CAAC,OAAO,OAAO,KAAK;IACZ,SAAS,CAAC,IAAI,EAAE,gBAAgB;gBAAtB,IAAI,EAAE,gBAAgB;IAE/B,IAAI,CAAC,OAAO,EAAE,MAAM,GAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAK3D"}
+{"version":3,"file":"shell.d.ts","sourceRoot":"","sources":["../src/shell.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAClE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAGlD,MAAM,WAAW,cAAc;IAC7B,cAAc,EAAE;QACd,MAAM,EAAE,MAAM,CAAC;QACf,EAAE,EAAE,MAAM,CAAC;KACZ,CAAC;CACH;AAED,KAAK,SAAS,CAAC,CAAC,SAAS,MAAM,cAAc,IAAI,GAAG,CAAC,IAAI,MAAM,EAAE,CAAC;AAClE,KAAK,iBAAiB,GAAG,SAAS,CAAC,MAAM,cAAc,CAAC,CAAC;AACzD,MAAM,MAAM,WAAW,GAAG,cAAc,GAAG;KACxC,CAAC,IAAI,iBAAiB,GAAG,cAAc,CAAC,cAAc,CAAC;CACzD,CAAC;AAEF,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC3B,IAAI,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,YAAY;IAC3B,YAAY,EAAE,MAAM,CAAC,cAAc,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC5E;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IAC/B,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;CACzB;AAYD,qBAAa,YAAa,SAAQ,KAAK;IAE5B,MAAM,EAAE,MAAM;IACd,QAAQ,EAAE,MAAM;gBADhB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM;CAI1B;AAED,cAAM,MAAM;IAED,MAAM,EAAE,MAAM;IACd,QAAQ,EAAE,MAAM;gBADhB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM;IAGlB,KAAK;CAOb;AAED,MAAM,CAAC,OAAO,OAAO,KAAK;IACZ,SAAS,CAAC,IAAI,EAAE,gBAAgB;gBAAtB,IAAI,EAAE,gBAAgB;IAErC,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,cAAc,CAAC,KAAK,IAAI,GAAG,IAAI;IAIhF,MAAM,CAAC,CAAC,SAAS,MAAM,WAAW,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,UAAU;IAI5F,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,IAAI,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IACtE,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAgBjF,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,IAAI,CAAC,EAAE,YAAY,GAAG,cAAc;IAC3E,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,CAAC,EAAE,YAAY,GAAG,cAAc;CA0ExF"}

package/dist/shell.js

@@ -1,3 +1,12 @@
+import { nanoid } from 'nanoid';
+function resolveExecInput(command, argsOrOpts = [], opts) {
+    const args = Array.isArray(argsOrOpts) ? argsOrOpts : [];
+    const resolvedOpts = Array.isArray(argsOrOpts) ? opts : argsOrOpts;
+    return {
+        command: Array.isArray(command) ? command : args.length > 0 ? [command, ...args] : command,
+        opts: resolvedOpts,
+    };
+}
 export class CommandError extends Error {
     constructor(output, exitCode) {
         super(output);
@@ -21,9 +30,80 @@ export default class Shell {
     constructor(okra) {
         this.okra = okra;
     }
-    async exec(command) {
-        const result = await this.okra.invoke('shell.exec', { command });
+    onOutput(id, handler) {
+        this.okra.listen(`shell.output.${id}`, handler);
+    }
+    listen(event, handler) {
+        return this.okra.listen(event, handler);
+    }
+    async exec(command, argsOrOpts = [], opts) {
+        const input = resolveExecInput(command, argsOrOpts, opts);
+        const { abortSignal, ...payloadOpts } = input.opts ?? {};
+        const result = await this.okra.invoke('shell.exec', {
+            command: input.command,
+            opts: Object.keys(payloadOpts).length > 0 ? payloadOpts : undefined,
+        }, { abortSignal });
         return new Result(result.output, result.exitCode);
     }
+    execStream(command, argsOrOpts = [], opts) {
+        const input = resolveExecInput(command, argsOrOpts, opts);
+        const id = input.opts?.id || nanoid();
+        const disposables = new Set();
+        let controller = null;
+        let closed = false;
+        const dispose = () => {
+            for (const disposable of disposables) {
+                disposable.dispose();
+            }
+            disposables.clear();
+        };
+        const close = () => {
+            if (closed) {
+                return;
+            }
+            closed = true;
+            dispose();
+            if (controller) {
+                try {
+                    controller.close();
+                }
+                catch {
+                    // Ignore close errors after cancellation.
+                }
+            }
+        };
+        const fail = (error) => {
+            if (closed) {
+                return;
+            }
+            closed = true;
+            dispose();
+            if (controller) {
+                controller.error(error);
+            }
+        };
+        const output = new ReadableStream({
+            start: (_controller) => {
+                controller = _controller;
+                disposables.add(this.listen(`shell.output.${id}`, (data) => {
+                    controller?.enqueue(data.output);
+                }));
+            },
+            cancel: () => {
+                closed = true;
+                dispose();
+            },
+        });
+        const result = this.exec(input.command, { ...input.opts, id })
+            .then((response) => {
+            close();
+            return response;
+        })
+            .catch((error) => {
+            fail(error);
+            throw error;
+        });
+        return { output, result };
+    }
 }
 //# sourceMappingURL=shell.js.map

package/dist/shell.js.map

@@ -1 +1 @@
-{"version":3,"file":"shell.js","sourceRoot":"","sources":["../src/shell.ts"],"names":[],"mappings":"AAQA,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,YACS,MAAc,EACd,QAAgB;QAEvB,KAAK,CAAC,MAAM,CAAC,CAAC;QAHP,WAAM,GAAN,MAAM,CAAQ;QACd,aAAQ,GAAR,QAAQ,CAAQ;IAGzB,CAAC;CACF;AAED,MAAM,MAAM;IACV,YACS,MAAc,EACd,QAAgB;QADhB,WAAM,GAAN,MAAM,CAAQ;QACd,aAAQ,GAAR,QAAQ,CAAQ;IACtB,CAAC;IAEG,KAAK;QACV,IAAI,IAAI,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACrD,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED,MAAM,CAAC,OAAO,OAAO,KAAK;IACxB,YAAsB,IAAsB;QAAtB,SAAI,GAAJ,IAAI,CAAkB;IAAG,CAAC;IAEzC,KAAK,CAAC,IAAI,CAAC,OAAsB;QACtC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QAEjE,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC;CACF"}
+{"version":3,"file":"shell.js","sourceRoot":"","sources":["../src/shell.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AA6BhC,SAAS,gBAAgB,CAAC,OAA0B,EAAE,aAAsC,EAAE,EAAE,IAAmB;IACjH,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;IACzD,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;IAEnE,OAAO;QACL,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO;QAC1F,IAAI,EAAE,YAAY;KACnB,CAAC;AACJ,CAAC;AAED,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,YACS,MAAc,EACd,QAAgB;QAEvB,KAAK,CAAC,MAAM,CAAC,CAAC;QAHP,WAAM,GAAN,MAAM,CAAQ;QACd,aAAQ,GAAR,QAAQ,CAAQ;IAGzB,CAAC;CACF;AAED,MAAM,MAAM;IACV,YACS,MAAc,EACd,QAAgB;QADhB,WAAM,GAAN,MAAM,CAAQ;QACd,aAAQ,GAAR,QAAQ,CAAQ;IACtB,CAAC;IAEG,KAAK;QACV,IAAI,IAAI,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACrD,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED,MAAM,CAAC,OAAO,OAAO,KAAK;IACxB,YAAsB,IAAsB;QAAtB,SAAI,GAAJ,IAAI,CAAkB;IAAG,CAAC;IAEzC,QAAQ,CAAC,EAAU,EAAE,OAAoD;QAC9E,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAEM,MAAM,CAA8B,KAAQ,EAAE,OAAuC;QAC1F,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAIM,KAAK,CAAC,IAAI,CAAC,OAA0B,EAAE,aAAsC,EAAE,EAAE,IAAmB;QACzG,MAAM,KAAK,GAAG,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QAC1D,MAAM,EAAE,WAAW,EAAE,GAAG,WAAW,EAAE,GAAG,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;QACzD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CACnC,YAAY,EACZ;YACE,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;SACpE,EACD,EAAE,WAAW,EAAE,CAChB,CAAC;QAEF,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC;IAIM,UAAU,CAAC,OAA0B,EAAE,aAAsC,EAAE,EAAE,IAAmB;QACzG,MAAM,KAAK,GAAG,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QAC1D,MAAM,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,EAAE,IAAI,MAAM,EAAE,CAAC;QACtC,MAAM,WAAW,GAAG,IAAI,GAAG,EAAc,CAAC;QAC1C,IAAI,UAAU,GAAmD,IAAI,CAAC;QACtE,IAAI,MAAM,GAAG,KAAK,CAAC;QAEnB,MAAM,OAAO,GAAG,GAAG,EAAE;YACnB,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;gBACrC,UAAU,CAAC,OAAO,EAAE,CAAC;YACvB,CAAC;YAED,WAAW,CAAC,KAAK,EAAE,CAAC;QACtB,CAAC,CAAC;QAEF,MAAM,KAAK,GAAG,GAAG,EAAE;YACjB,IAAI,MAAM,EAAE,CAAC;gBACX,OAAO;YACT,CAAC;YAED,MAAM,GAAG,IAAI,CAAC;YACd,OAAO,EAAE,CAAC;YAEV,IAAI,UAAU,EAAE,CAAC;gBACf,IAAI,CAAC;oBACH,UAAU,CAAC,KAAK,EAAE,CAAC;gBACrB,CAAC;gBAAC,MAAM,CAAC;oBACP,0CAA0C;gBAC5C,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QAEF,MAAM,IAAI,GAAG,CAAC,KAAc,EAAE,EAAE;YAC9B,IAAI,MAAM,EAAE,CAAC;gBACX,OAAO;YACT,CAAC;YAED,MAAM,GAAG,IAAI,CAAC;YACd,OAAO,EAAE,CAAC;YAEV,IAAI,UAAU,EAAE,CAAC;gBACf,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC,CAAC;QAEF,MAAM,MAAM,GAAG,IAAI,cAAc,CAAS;YACxC,KAAK,EAAE,CAAC,WAAW,EAAE,EAAE;gBACrB,UAAU,GAAG,WAAW,CAAC;gBACzB,WAAW,CAAC,GAAG,CACb,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;oBACzC,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACnC,CAAC,CAAC,CACH,CAAC;YACJ,CAAC;YACD,MAAM,EAAE,GAAG,EAAE;gBACX,MAAM,GAAG,IAAI,CAAC;gBACd,OAAO,EAAE,CAAC;YACZ,CAAC;SACF,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC;aAC3D,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjB,KAAK,EAAE,CAAC;YAER,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,IAAI,CAAC,KAAK,CAAC,CAAC;YACZ,MAAM,KAAK,CAAC;QACd,CAAC,CAAC,CAAC;QAEL,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IAC5B,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phpsandbox/sdk",
-  "version": "0.0.27",
+  "version": "0.0.28",
   "description": "A comprehensive TypeScript SDK for interacting with cloud-based PHP development environments",
   "main": "./dist/index.js",
   "module": "./dist/index.js",