@phpsandbox/sdk 0.1.2 → 0.1.4

package/dist/filesystem.d.ts

@@ -68,6 +68,9 @@ export interface FileListOptions {
 export interface FileTailOptions {
     lines?: number;
 }
+export interface FileFollowOptions extends FileTailOptions {
+    signal?: AbortSignal;
+}
 export interface FileLineRange {
     start: number;
     end: number;
@@ -403,6 +406,14 @@ export interface FilesystemActions {
     'fs.cancelRead': Action<{
         id: string;
     }, boolean>;
+    'fs.follow': Action<{
+        id: string;
+        path: string;
+        lines: number;
+    }, boolean>;
+    'fs.cancelFollow': Action<{
+        id: string;
+    }, boolean>;
     'fs.writeStream': Action<{
         id: string;
         path: string;
@@ -471,6 +482,10 @@ interface FilesystemEventData {
         id: string;
         data: Uint8Array;
     };
+    'fs.follow': {
+        id: string;
+        data: Uint8Array;
+    };
 }
 type PrefixKey<K extends keyof FilesystemEventData> = `${K}.${string}`;
 export type FilesystemEvents = FilesystemEventData & {
@@ -505,6 +520,7 @@ export declare class Filesystem {
     readText(path: string): Promise<string>;
     readLines(path: string, range: FileLineRange): Promise<FileLineRangeResult>;
     readStream(path: string): ReadableStream<Uint8Array>;
+    follow(path: string, options?: FileFollowOptions): ReadableStream<Uint8Array>;
     find(query: string, options?: Partial<FileSearchOptions>): Promise<FileResult[]>;
     search(query: TextSearchQuery, options?: Partial<TextSearchOptions>, onMatch?: (result: TextSearchResult | false) => boolean | Promise<boolean> | void | Promise<void>): Promise<[boolean, TextSearchMatch[]]>;
     tail(path: string, options?: FileTailOptions): Promise<string>;

package/dist/filesystem.js

@@ -1,3 +1,4 @@
+import { UnsupportedRuntimeTransportError } from './errors/index.js';
 import { ErrorEvent } from './types.js';
 import { nanoid } from 'nanoid';
 export var FileType;
@@ -204,6 +205,77 @@ export class Filesystem {
             },
         });
     }
+    follow(path, options = {}) {
+        if (this.okra.runtimeTransport === 'rest') {
+            return new ReadableStream({
+                start(controller) {
+                    controller.error(new UnsupportedRuntimeTransportError('Following files requires the realtime transport.'));
+                },
+            });
+        }
+        const id = nanoid();
+        let disposable = null;
+        let abort = null;
+        let started = false;
+        let closed = false;
+        const stop = async () => {
+            if (closed) {
+                return;
+            }
+            closed = true;
+            disposable?.dispose();
+            disposable = null;
+            if (abort && options.signal) {
+                options.signal.removeEventListener('abort', abort);
+            }
+            abort = null;
+            if (started) {
+                await this.okra.invoke('fs.cancelFollow', { id }).catch(() => false);
+            }
+        };
+        return new ReadableStream({
+            start: (controller) => {
+                disposable = this.okra.listen(`fs.follow.${id}`, (event) => {
+                    if (!closed) {
+                        controller.enqueue(event.data);
+                    }
+                });
+                if (options.signal) {
+                    abort = () => {
+                        void stop().finally(() => controller.error(options.signal?.reason ?? new Error('Aborted')));
+                    };
+                    if (options.signal.aborted) {
+                        abort();
+                        return;
+                    }
+                    options.signal.addEventListener('abort', abort, { once: true });
+                }
+                started = true;
+                void this.okra.invoke('fs.follow', { id, path, lines: options.lines ?? 10 }).then(() => {
+                    if (!closed) {
+                        closed = true;
+                        disposable?.dispose();
+                        if (abort && options.signal) {
+                            options.signal.removeEventListener('abort', abort);
+                        }
+                        abort = null;
+                        controller.close();
+                    }
+                }).catch((error) => {
+                    if (!closed) {
+                        closed = true;
+                        disposable?.dispose();
+                        if (abort && options.signal) {
+                            options.signal.removeEventListener('abort', abort);
+                        }
+                        abort = null;
+                        controller.error(error);
+                    }
+                });
+            },
+            cancel: stop,
+        });
+    }
     find(query, options = {
         useIgnoreFiles: false,
         followSymlinks: false,

package/package.json

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