@phpsandbox/sdk 0.0.51 → 0.0.53

package/dist/filesystem.d.ts

@@ -250,7 +250,7 @@ interface RelativePattern {
      */
     readonly pattern: string;
 }
-interface WatchOptionsWithoutCorrelation {
+export interface WatchOptionsWithoutCorrelation {
     /**
      * Set to `true` to watch for changes recursively in a folder
      * and all of its children.
@@ -281,7 +281,7 @@ interface WatchOptionsWithoutCorrelation {
      */
     filter?: FileChangeFilter;
 }
-interface WatchOptions extends WatchOptionsWithoutCorrelation {
+export interface WatchOptions extends WatchOptionsWithoutCorrelation {
     /**
      * If provided, file change events from the watcher that
      * are a result of this watch request will carry the same
@@ -289,7 +289,7 @@ interface WatchOptions extends WatchOptionsWithoutCorrelation {
      */
     readonly correlationId?: number;
 }
-declare const enum FileChangeFilter {
+export declare enum FileChangeFilter {
     UPDATED = 2,
     ADDED = 4,
     DELETED = 8
@@ -442,10 +442,10 @@ export declare class FilesystemError extends ErrorEvent {
     constructor(inner: ErrorEvent, name: FilesystemErrorType);
 }
 declare class FilesystemSubscription {
-    private path;
-    private okra;
     private disposable;
-    constructor(path: string, okra: NotebookInstance, disposable: Disposable);
+    private onDispose;
+    private disposed;
+    constructor(disposable: Disposable, onDispose: () => void);
     dispose(): void;
 }
 export declare class Filesystem {
@@ -480,4 +480,3 @@ export declare class Filesystem {
     protected handleError(e: unknown): never;
 }
 export {};
-//# sourceMappingURL=filesystem.d.ts.map

package/dist/filesystem.js

@@ -23,6 +23,12 @@ export var FileType;
      */
     FileType[FileType["SymbolicLink"] = 64] = "SymbolicLink";
 })(FileType || (FileType = {}));
+export var FileChangeFilter;
+(function (FileChangeFilter) {
+    FileChangeFilter[FileChangeFilter["UPDATED"] = 2] = "UPDATED";
+    FileChangeFilter[FileChangeFilter["ADDED"] = 4] = "ADDED";
+    FileChangeFilter[FileChangeFilter["DELETED"] = 8] = "DELETED";
+})(FileChangeFilter || (FileChangeFilter = {}));
 /**
  * Possible changes that can occur to a file.
  */
@@ -48,14 +54,18 @@ export class FilesystemError extends ErrorEvent {
     }
 }
 class FilesystemSubscription {
-    constructor(path, okra, disposable) {
-        this.path = path;
-        this.okra = okra;
+    constructor(disposable, onDispose) {
         this.disposable = disposable;
+        this.onDispose = onDispose;
+        this.disposed = false;
     }
     dispose() {
-        this.okra.invoke('fs.unwatch', { path: this.path });
+        if (this.disposed) {
+            return;
+        }
+        this.disposed = true;
         this.disposable.dispose();
+        this.onDispose();
     }
 }
 export class Filesystem {
@@ -66,8 +76,8 @@ export class Filesystem {
     }
     watchOkraConnection() {
         this.okra.onDidConnect(() => {
-            for (const { path, options, onDidChange } of this.watches.values()) {
-                this.watch(path, options, onDidChange);
+            for (const { path, options } of this.watches.values()) {
+                void this.okra.invoke('fs.watch', { path, options }).catch(() => { });
             }
         });
     }
@@ -85,7 +95,7 @@ export class Filesystem {
     }) {
         return this.okra.invoke('fs.find', {
             query,
-            options: Object.assign(options, {
+            options: {
                 includes: [],
                 excludes: [
                     '**/storage',
@@ -103,7 +113,8 @@ export class Filesystem {
                 followSymlinks: false,
                 useGlobalIgnoreFiles: false,
                 useParentIgnoreFiles: false,
-            }),
+                ...options,
+            },
         });
     }
     search(query, options, onMatch) {
@@ -214,12 +225,23 @@ export class Filesystem {
         const wrappedDisposable = {
             dispose: () => {
                 disposable.dispose();
-                this.okra.invoke('fs.unwatch', { path });
+                void this.okra.invoke('fs.unwatch', { path }).catch(() => { });
             },
         };
-        const subscription = new FilesystemSubscription(path, this.okra, wrappedDisposable);
+        const subscription = new FilesystemSubscription(wrappedDisposable, () => {
+            const watch = this.watches.get(path);
+            if (watch?.onDidChange === onDidChange) {
+                this.watches.delete(path);
+            }
+        });
         this.watches.set(path, { options, path, onDidChange });
-        return this.okra.invoke('fs.watch', { path, options }).then(() => subscription);
+        return this.okra
+            .invoke('fs.watch', { path, options })
+            .then(() => subscription)
+            .catch((error) => {
+            subscription.dispose();
+            throw error;
+        });
     }
     exists(path) {
         return this.stat(path)
@@ -230,14 +252,15 @@ export class Filesystem {
         const id = nanoid();
         const stream = !!chunk;
         const chunks = [];
-        this.okra.listen(`fs.download.${id}`, stream
+        const disposable = this.okra.listen(`fs.download.${id}`, stream
             ? chunk
             : (data) => {
                 chunks.push(data);
             });
         return this.okra
             .invoke('fs.download', { id, exclude, include })
-            .then(() => new Blob(chunks, { type: 'application/octet-stream' }));
+            .then(() => new Blob(chunks, { type: 'application/octet-stream' }))
+            .finally(() => disposable.dispose());
     }
     tree(path = '/') {
         return this.okra.invoke('fs.tree', { path });
@@ -249,4 +272,3 @@ export class Filesystem {
         throw e;
     }
 }
-//# sourceMappingURL=filesystem.js.map

package/dist/git.d.ts

@@ -63,13 +63,24 @@ export interface GitConflict {
     status: string;
     markers?: number;
 }
-export interface GitDiffInput {
-    url?: string;
+type GitRemoteSource = {
+    url: string;
+    notebookId?: never;
+    target?: never;
+} | {
+    notebookId: string;
+    url?: never;
+    target?: never;
+} | {
+    target: string;
+    url?: never;
+    notebookId?: never;
+};
+export type GitDiffInput = GitRemoteSource & {
     token?: string;
     ref?: string;
     base?: string;
-    target?: string;
-}
+};
 export interface GitDiffPreview {
     status: 'ready' | 'unrelated';
     message?: string;
@@ -82,15 +93,13 @@ export interface GitDiffPreview {
     ahead: number;
     behind: number;
 }
-export interface GitMergeInput {
-    url?: string;
+export type GitMergeInput = GitRemoteSource & {
     token?: string;
     ref?: string;
-    target?: string;
     expectedBaseRef?: string;
     author?: string;
     message?: string;
-}
+};
 export type GitMergeResult = {
     status: 'merged';
     message: string;
@@ -188,5 +197,7 @@ export default class Git {
     credentials(): Promise<GitCredentials>;
     restore(ref: string): Promise<GitRef>;
     status(): Promise<GitStatus>;
+    private normalizeRemoteInput;
+    private gitUrlForNotebook;
 }
-//# sourceMappingURL=git.d.ts.map
+export {};

package/dist/git.js

@@ -15,10 +15,10 @@ export default class Git {
         return this.okra.invoke('git.log', { ref });
     }
     diff(input) {
-        return this.okra.invoke('git.diff', input);
+        return this.okra.invoke('git.diff', this.normalizeRemoteInput(input));
     }
     merge(input) {
-        return this.okra.invoke('git.merge', input);
+        return this.okra.invoke('git.merge', this.normalizeRemoteInput(input));
     }
     conflicts() {
         return this.okra.invoke('git.conflicts', {});
@@ -50,5 +50,33 @@ export default class Git {
     status() {
         return this.okra.invoke('git.status', {});
     }
+    normalizeRemoteInput(input) {
+        if (input.notebookId === undefined) {
+            return input;
+        }
+        const notebookId = input.notebookId.trim();
+        if (!notebookId) {
+            throw new Error("'notebookId' cannot be empty.");
+        }
+        if (input.url?.trim()) {
+            throw new Error("Pass either 'url' or 'notebookId', not both.");
+        }
+        if (input.target?.trim()) {
+            throw new Error("Pass either 'target' or 'notebookId', not both.");
+        }
+        const { notebookId: _notebookId, ...payload } = input;
+        return {
+            ...payload,
+            url: this.gitUrlForNotebook(notebookId),
+        };
+    }
+    gitUrlForNotebook(notebookId) {
+        const url = new URL(this.okra.data.gitUrl);
+        url.username = '';
+        url.password = '';
+        url.pathname = `/${encodeURIComponent(notebookId)}.git`;
+        url.search = '';
+        url.hash = '';
+        return url.toString();
+    }
 }
-//# sourceMappingURL=git.js.map

package/dist/index.d.ts

@@ -226,7 +226,7 @@ export interface PHPSandboxClientOptions {
     startClosed?: boolean;
     telemetry?: Set<TelemetryFeature>;
     fetch?: typeof globalThis.fetch;
-    webSocket?: typeof globalThis['WebSocket'];
+    webSocket?: unknown;
 }
 export declare class Client {
     readonly notebook: NotebookApi;
@@ -323,9 +323,11 @@ export declare class NotebookInstance {
     send<T extends keyof Invokable>(action: T, data?: Invokable[T]['args']): boolean;
     ping(): Promise<"pong">;
     listen<T extends keyof Events>(event: T, handler: (data: Events[T]) => void): Disposable;
+    listen(event: string, handler: (data: unknown) => void): Disposable;
     dispose(): void;
     connected(): Promise<NotebookInstance>;
     whenConnected(): Promise<NotebookInstance>;
+    private waitForSocketConnection;
     private watchConnection;
     onDidConnect(handler: () => void): Disposable;
     onDidDisconnect(handler: () => void): Disposable;
@@ -365,4 +367,3 @@ export declare class NotebookMail {
     get(hash: string): Promise<NotebookMailData>;
     delete(hash: string): Promise<void>;
 }
-//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -111,12 +111,20 @@ export class NotebookApi {
         return instance;
     }
 }
+function normalizeApiBaseUrl(url) {
+    const baseUrl = new URL(url);
+    const pathname = baseUrl.pathname.replace(/\/+$/, '');
+    baseUrl.pathname = pathname === '' || pathname === '/' ? '/v1/' : `${pathname}/`;
+    baseUrl.search = '';
+    baseUrl.hash = '';
+    return baseUrl.toString();
+}
 export class Client {
     constructor(token, url = 'https://api.phpsandbox.io/v1', options = {}) {
         this.fetch = globalThis.fetch;
         this.notebook = new NotebookApi(this);
         this.options = Object.assign({ startClosed: true }, options);
-        this.baseUrl = url;
+        this.baseUrl = normalizeApiBaseUrl(url);
         if (options.fetch) {
             this.fetch = options.fetch;
         }
@@ -130,16 +138,16 @@ export class Client {
         return this.makeRequest('GET', path);
     }
     post(path, body) {
-        return this.makeRequest('POST', path, { body: body ? JSON.stringify(body) : undefined });
+        return this.makeRequest('POST', path, { body: body === undefined ? undefined : JSON.stringify(body) });
     }
     delete(path) {
         return this.makeRequest('DELETE', path);
     }
     put(path, body) {
-        return this.makeRequest('PUT', path, { body: body ? JSON.stringify(body) : undefined });
+        return this.makeRequest('PUT', path, { body: body === undefined ? undefined : JSON.stringify(body) });
     }
     async makeRequest(method, path, init) {
-        const response = await this.fetch(new Request(new URL(`v1/${path.replace(/^\//, '')}`, this.baseUrl), {
+        const response = await this.fetch(new Request(new URL(path.replace(/^\//, ''), this.baseUrl), {
             method,
             ...init,
             headers: this.headers,
@@ -318,25 +326,12 @@ export class NotebookInstance {
         !this.socket.isClosed && this.socket.disconnect();
     }
     connected() {
-        const terminalError = this.socket.getTerminalError();
-        if (terminalError) {
-            return Promise.reject(terminalError);
-        }
-        if (this.socket.isConnected) {
-            return Promise.resolve(this);
-        }
-        return new Promise((resolve, reject) => {
-            try {
-                this.socket.onDidConnect(() => resolve(this));
-                this.socket.onDidClose(() => reject(new Error('Connection closed')));
-                this.socket.onDidBootError((error) => reject(error));
-            }
-            catch (e) {
-                reject(e);
-            }
-        });
+        return this.waitForSocketConnection({ rejectOnClose: true });
     }
     whenConnected() {
+        return this.waitForSocketConnection({ rejectOnClose: false });
+    }
+    waitForSocketConnection(options) {
         const terminalError = this.socket.getTerminalError();
         if (terminalError) {
             return Promise.reject(terminalError);
@@ -345,12 +340,31 @@ export class NotebookInstance {
             return Promise.resolve(this);
         }
         return new Promise((resolve, reject) => {
+            const disposables = [];
+            let settled = false;
+            const cleanup = () => {
+                for (const disposable of disposables) {
+                    disposable.dispose();
+                }
+                disposables.length = 0;
+            };
+            const settle = (callback) => {
+                if (settled) {
+                    return;
+                }
+                settled = true;
+                cleanup();
+                callback();
+            };
             try {
-                this.socket.onDidConnect(() => resolve(this));
-                this.socket.onDidBootError((error) => reject(error));
+                disposables.push(this.socket.onDidConnect(() => settle(() => resolve(this))));
+                if (options.rejectOnClose) {
+                    disposables.push(this.socket.onDidClose(() => settle(() => reject(new Error('Connection closed')))));
+                }
+                disposables.push(this.socket.onDidBootError((error) => settle(() => reject(error))));
             }
             catch (e) {
-                reject(e);
+                settle(() => reject(e));
             }
         });
     }
@@ -511,4 +525,3 @@ function formatQueryString(params) {
     const query = searchParams.toString();
     return query === '' ? '' : `?${query}`;
 }
-//# sourceMappingURL=index.js.map

package/dist/laravel.d.ts

@@ -14,10 +14,9 @@ export interface LaravelActions {
     'laravel.maintenance.info': Action<{}, Down>;
     'laravel.maintenance.toggle': Action<Down | {}, Down>;
 }
-export default class Lravel {
+export default class Laravel {
     protected okra: NotebookInstance;
     constructor(okra: NotebookInstance);
     maintenanceInfo(): Promise<Down>;
     toggleMaintenance(down: Down | {}): Promise<Down>;
 }
-//# sourceMappingURL=laravel.d.ts.map

package/dist/laravel.js

@@ -1,4 +1,4 @@
-export default class Lravel {
+export default class Laravel {
     constructor(okra) {
         this.okra = okra;
     }
@@ -9,4 +9,3 @@ export default class Lravel {
         return this.okra.invoke('laravel.maintenance.toggle', down);
     }
 }
-//# sourceMappingURL=laravel.js.map

package/dist/log.d.ts

@@ -1,4 +1,4 @@
-import { NotebookInstance } from './index.js';
+import { Disposable, NotebookInstance } from './index.js';
 export interface LogEvents {
     'notebook.log': string;
 }
@@ -7,7 +7,6 @@ export interface LogActions {
 export default class Log {
     protected okra: NotebookInstance;
     constructor(okra: NotebookInstance);
-    stream(fn: (data: string) => void): import("./types.js").Disposable;
-    listen<T extends keyof LogEvents>(event: T, handler: (data: LogEvents[T]) => void): void;
+    stream(fn: (data: string) => void): Disposable;
+    listen<T extends keyof LogEvents>(event: T, handler: (data: LogEvents[T]) => void): Disposable;
 }
-//# sourceMappingURL=log.d.ts.map

package/dist/log.js

@@ -6,7 +6,6 @@ export default class Log {
         return this.okra.listen('notebook.log', fn);
     }
     listen(event, handler) {
-        this.okra.listen(event, handler);
+        return this.okra.listen(event, handler);
     }
 }
-//# sourceMappingURL=log.js.map

package/dist/lsp.d.ts

@@ -1,4 +1,4 @@
-import { Action, NotebookInstance } from './index.js';
+import { Action, Disposable, NotebookInstance } from './index.js';
 export interface LspActions {
     'lsp.message': Action<{
         message: string;
@@ -29,11 +29,11 @@ export default class Lsp {
     protected okra: NotebookInstance;
     constructor(okra: NotebookInstance);
     message(id: string, message: string): Promise<void>;
-    listen<T extends keyof LspEventData>(id: string, event: T, cb: (data: LspEventData[T]) => void): void;
-    onClose(id: string, cb: (code: number, reason: string) => void): void;
-    onError(id: string, cb: (message: string) => void): void;
-    onClientDisconnect(cb: (code: number, message: string) => void): void;
-    onResponse(id: string, cb: (data: string) => void): void;
+    listen<T extends keyof LspEventData>(id: string, event: T, cb: (data: LspEventData[T]) => void): Disposable;
+    onClose(id: string, cb: (code: number, reason: string) => void): Disposable;
+    onError(id: string, cb: (message: string) => void): Disposable;
+    onClientDisconnect(cb: (code: number, message: string) => void): Disposable;
+    onResponse(id: string, cb: (data: string) => void): Disposable;
     close(id: string): Promise<void>;
     start(id: string): Promise<void>;
     connection(id: string): LspConnection;
@@ -44,14 +44,13 @@ export declare class LspConnection {
     private readonly lsp;
     constructor(id: string, lsp: Lsp);
     send(content: string): Promise<void>;
-    onMessage(cb: (data: string) => void): void;
-    onError(cb: (message: string) => void): void;
-    onClose(cb: (code: number, reason: string) => void): void;
+    onMessage(cb: (data: string) => void): Disposable;
+    onError(cb: (message: string) => void): Disposable;
+    onClose(cb: (code: number, reason: string) => void): Disposable;
     dispose(): void;
     start(): void;
-    onClientDisconnect(cb: (code: number, message: string) => void): void;
+    onClientDisconnect(cb: (code: number, message: string) => void): Disposable;
     whenSocketConnected(): Promise<NotebookInstance>;
     static create(id: string, lsp: Lsp): LspConnection;
 }
 export {};
-//# sourceMappingURL=lsp.d.ts.map

package/dist/lsp.js

@@ -6,19 +6,19 @@ export default class Lsp {
         return this.okra.invoke('lsp.message', { id, message });
     }
     listen(id, event, cb) {
-        this.okra.listen(`${event}.${id}`, (e) => cb(e));
+        return this.okra.listen(`${event}.${id}`, (e) => cb(e));
     }
     onClose(id, cb) {
-        this.listen(id, 'lsp.closed', (e) => cb(e.code, e.reason));
+        return this.listen(id, 'lsp.closed', (e) => cb(e.code, e.reason));
     }
     onError(id, cb) {
-        this.listen(id, 'lsp.error', (e) => cb(e.message));
+        return this.listen(id, 'lsp.error', (e) => cb(e.message));
     }
     onClientDisconnect(cb) {
-        this.okra.onDidDisconnect(() => cb(1000, 'OKRA DISCONNECTED'));
+        return this.okra.onDidDisconnect(() => cb(1000, 'OKRA DISCONNECTED'));
     }
     onResponse(id, cb) {
-        this.listen(id, 'lsp.response', (e) => cb(JSON.stringify(e)));
+        return this.listen(id, 'lsp.response', (e) => cb(JSON.stringify(e)));
     }
     close(id) {
         return this.okra.invoke('lsp.close', { id });
@@ -42,13 +42,13 @@ export class LspConnection {
         return this.lsp.message(this.id, content);
     }
     onMessage(cb) {
-        this.lsp.onResponse(this.id, cb);
+        return this.lsp.onResponse(this.id, cb);
     }
     onError(cb) {
-        this.lsp.onError(this.id, cb);
+        return this.lsp.onError(this.id, cb);
     }
     onClose(cb) {
-        this.lsp.onClose(this.id, cb);
+        return this.lsp.onClose(this.id, cb);
     }
     dispose() {
         this.lsp.close(this.id);
@@ -57,7 +57,7 @@ export class LspConnection {
         this.lsp.start(this.id);
     }
     onClientDisconnect(cb) {
-        this.lsp.onClientDisconnect(cb);
+        return this.lsp.onClientDisconnect(cb);
     }
     whenSocketConnected() {
         return this.lsp.whenSocketConnected();
@@ -66,4 +66,3 @@ export class LspConnection {
         return new LspConnection(id, lsp);
     }
 }
-//# sourceMappingURL=lsp.js.map

package/dist/repl.d.ts

@@ -1,4 +1,4 @@
-import { Action, NotebookInstance } from './index.js';
+import { Action, Disposable, NotebookInstance } from './index.js';
 interface ReplOption {
     prependWith?: string;
     appendWith?: string;
@@ -34,8 +34,7 @@ export default class Repl {
     stop(): Promise<void>;
     start(): Promise<void>;
     resize(cols: number, rows: number): Promise<void>;
-    listen<T extends keyof ReplEvents>(event: T, handler: (data: ReplEvents[T]) => void): void;
-    onOutput(handler: (data: ReplEvents['repl.output']) => void): void;
+    listen<T extends keyof ReplEvents>(event: T, handler: (data: ReplEvents[T]) => void): Disposable;
+    onOutput(handler: (data: ReplEvents['repl.output']) => void): Disposable;
 }
 export {};
-//# sourceMappingURL=repl.d.ts.map

package/dist/repl.js

@@ -18,10 +18,9 @@ export default class Repl {
         return this.okra.invoke('repl.resize', { cols, rows });
     }
     listen(event, handler) {
-        this.okra.listen(event, handler);
+        return this.okra.listen(event, handler);
     }
     onOutput(handler) {
-        this.okra.listen('repl.output', handler);
+        return this.okra.listen('repl.output', handler);
     }
 }
-//# sourceMappingURL=repl.js.map

package/dist/services.d.ts

@@ -82,4 +82,3 @@ export default class Services {
     private followLogs;
 }
 export {};
-//# sourceMappingURL=services.d.ts.map

package/dist/services.js

@@ -104,4 +104,3 @@ export default class Services {
         return { id, output, stop };
     }
 }
-//# sourceMappingURL=services.js.map

package/dist/shell.d.ts

@@ -39,7 +39,7 @@ declare class Result {
 export default class Shell {
     protected okra: NotebookInstance;
     constructor(okra: NotebookInstance);
-    onOutput(id: string, handler: (data: ShellEvents['shell.output']) => void): void;
+    onOutput(id: string, handler: (data: ShellEvents['shell.output']) => void): Disposable;
     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>;
@@ -47,4 +47,3 @@ export default class Shell {
     execStream(command: string, args: string[], opts?: SpawnOptions): ShellExecution;
 }
 export {};
-//# sourceMappingURL=shell.d.ts.map

package/dist/shell.js

@@ -31,7 +31,7 @@ export default class Shell {
         this.okra = okra;
     }
     onOutput(id, handler) {
-        this.okra.listen(`shell.output.${id}`, handler);
+        return this.okra.listen(`shell.output.${id}`, handler);
     }
     listen(event, handler) {
         return this.okra.listen(event, handler);
@@ -106,4 +106,3 @@ export default class Shell {
         return { output, result };
     }
 }
-//# sourceMappingURL=shell.js.map