@phpsandbox/sdk 0.3.3 → 0.3.5

package/dist/composer.js

@@ -1,4 +1,4 @@
-import { ProcessReadable, } from './shell.js';
+import { ProcessReadable } from './shell.js';
 import { nanoid } from 'nanoid';
 class ComposerCredentials {
     constructor(client, notebookId) {
@@ -11,8 +11,9 @@ class ComposerCredentials {
     }
     async remove(type, url) {
         const params = new URLSearchParams({ type });
-        if (url)
+        if (url) {
             params.set('url', url);
+        }
         await this.client.delete(`/notebook/${this.notebookId}/composer/credentials?${params.toString()}`);
     }
 }
@@ -52,10 +53,13 @@ export class ComposerProcess {
             stdout.fail(error);
             stderr.fail(error);
         };
-        this.completion = this.okra.invoke('composer.invoke', { id, command, args, options }).then((result) => {
+        this.completion = this.okra
+            .invoke('composer.invoke', { id, command, args, options })
+            .then((result) => {
             finish();
             return result;
-        }).catch((error) => {
+        })
+            .catch((error) => {
             fail(error);
             throw error;
         });

package/dist/errors/index.d.ts

@@ -1,6 +1,6 @@
-export type RemoteErrorSource = 'core' | 'runtime';
+export type RemoteErrorSource = 'core' | 'platform' | 'runtime';
 declare const remoteErrorCodes: readonly ["ActionNotFound", "AuthenticationRequired", "BadGateway", "BadRequest", "Conflict", "FileAlreadyExists", "FileIsDirectory", "FileNotDirectory", "FileNotFound", "FilesystemUnavailable", "InternalError", "InvalidArgument", "InvalidConfiguration", "InvalidRequest", "InvalidResponse", "InvalidServiceCommand", "MethodNotAllowed", "NotebookInitializationFailed", "NotebookUnavailable", "NotFound", "PayloadTooLarge", "PermissionDenied", "RateLimited", "RequestFailed", "RuntimeOperationFailed", "ServiceNotFound", "ServiceUnavailable", "UnprocessableEntity", "ValidationFailed", "WorkspaceUnavailable"];
-export type RemoteErrorCode = typeof remoteErrorCodes[number];
+export type RemoteErrorCode = (typeof remoteErrorCodes)[number];
 export type TransportErrorCode = 'ConnectionFailed' | 'ConnectionTimeout' | 'InvalidResponse' | 'SendTimeout';
 export interface ValidationErrorDetails {
     errors: Record<string, string[]>;

package/dist/errors/index.js

@@ -94,9 +94,7 @@ function nonEmptyString(value) {
     return typeof value === 'string' && value.trim() !== '' ? value.trim() : undefined;
 }
 function record(value) {
-    return value !== null && typeof value === 'object' && !Array.isArray(value)
-        ? value
-        : undefined;
+    return value !== null && typeof value === 'object' && !Array.isArray(value) ? value : undefined;
 }
 function stringArrayRecord(value) {
     const candidate = record(value);

package/dist/feedback.js

@@ -18,8 +18,9 @@ export class Feedback {
     async list(options = {}) {
         const query = new URLSearchParams();
         for (const [name, value] of Object.entries(options)) {
-            if (value !== undefined)
+            if (value !== undefined) {
                 query.set(name, String(value));
+            }
         }
         return this.client.get(`${this.path()}${query.size === 0 ? '' : `?${query.toString()}`}`);
     }

package/dist/filesystem.js

@@ -80,11 +80,13 @@ export class Filesystem {
         const source = typeof contents === 'string' ? new TextEncoder().encode(contents) : contents;
         if (this.okra.runtimeTransport === 'rest') {
             const bytes = source instanceof Uint8Array ? source : await collectBytes(source);
-            await this.okra.invoke('fs.writeFile', {
+            await this.okra
+                .invoke('fs.writeFile', {
                 path,
                 contents: bytes,
                 options: resolvedOptions,
-            }).catch((error) => this.handleError(error));
+            })
+                .catch((error) => this.handleError(error));
             return;
         }
         const id = nanoid();
@@ -166,13 +168,16 @@ export class Filesystem {
                 disposable = this.okra.listen(`fs.read.${id}`, (event) => {
                     controller.enqueue(event.data);
                 });
-                void this.okra.invoke('fs.readStream', { id, path }).then(() => {
+                void this.okra
+                    .invoke('fs.readStream', { id, path })
+                    .then(() => {
                     if (!closed) {
                         closed = true;
                         disposable?.dispose();
                         controller.close();
                     }
-                }).catch((error) => {
+                })
+                    .catch((error) => {
                     if (!closed) {
                         closed = true;
                         disposable?.dispose();
@@ -235,7 +240,9 @@ export class Filesystem {
                     options.signal.addEventListener('abort', abort, { once: true });
                 }
                 started = true;
-                void this.okra.invoke('fs.follow', { id, path, lines: options.lines ?? 10 }).then(() => {
+                void this.okra
+                    .invoke('fs.follow', { id, path, lines: options.lines ?? 10 })
+                    .then(() => {
                     if (!closed) {
                         closed = true;
                         disposable?.dispose();
@@ -245,7 +252,8 @@ export class Filesystem {
                         abort = null;
                         controller.close();
                     }
-                }).catch((error) => {
+                })
+                    .catch((error) => {
                     if (!closed) {
                         closed = true;
                         disposable?.dispose();
@@ -340,7 +348,8 @@ export class Filesystem {
             .finally(() => disposable.dispose());
     }
     tail(path, options = {}) {
-        return this.okra.invoke('fs.tail', { path, lines: options.lines ?? 10 })
+        return this.okra
+            .invoke('fs.tail', { path, lines: options.lines ?? 10 })
             .then(({ content }) => content)
             .catch((e) => this.handleError(e));
     }
@@ -348,31 +357,39 @@ export class Filesystem {
         return this.okra.invoke('fs.stat', { path }).catch((e) => this.handleError(e));
     }
     move(from, to, options = {}) {
-        return this.okra.invoke('fs.rename', {
+        return this.okra
+            .invoke('fs.rename', {
             from,
             to,
             options: { overwrite: false, ...options },
-        }).catch((e) => this.handleError(e));
+        })
+            .catch((e) => this.handleError(e));
     }
     remove(path, options = {}) {
-        return this.okra.invoke('fs.delete', {
+        return this.okra
+            .invoke('fs.delete', {
             path,
             options: { recursive: false, useTrash: false, atomic: false, ...options },
-        }).catch((e) => this.handleError(e));
+        })
+            .catch((e) => this.handleError(e));
     }
     copy(source, destination, options = {}) {
-        return this.okra.invoke('fs.copy', {
+        return this.okra
+            .invoke('fs.copy', {
             source,
             destination,
             options: { overwrite: false, ...options },
-        }).catch((e) => this.handleError(e));
+        })
+            .catch((e) => this.handleError(e));
     }
     list(path, options = {}) {
-        return this.okra.invoke('fs.readDirectory', {
+        return this.okra
+            .invoke('fs.readDirectory', {
             path,
             include: options.include ?? [],
             exclude: options.exclude ?? [],
-        }).catch((e) => this.handleError(e));
+        })
+            .catch((e) => this.handleError(e));
     }
     createDirectory(path) {
         return this.okra.invoke('fs.createDirectory', { path }).catch((e) => this.handleError(e));

package/dist/identity.d.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+export declare const identitySchema: z.ZodObject<{
+    user: z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+    }, z.core.$strip>>;
+    organization: z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+    }, z.core.$strip>;
+    permissions: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type Identity = z.infer<typeof identitySchema>;

package/dist/identity.js

@@ -0,0 +1,6 @@
+import { z } from 'zod';
+export const identitySchema = z.object({
+    user: z.object({ id: z.string(), name: z.string() }).nullable(),
+    organization: z.object({ id: z.string(), name: z.string() }),
+    permissions: z.array(z.string()),
+});

package/dist/index.d.ts

@@ -1,7 +1,8 @@
+import { type Identity } from './identity.js';
+export type { Identity } from './identity.js';
 import { NotebookPublication } from './publication/index.js';
 import { Filesystem, FilesystemActions, FilesystemEvents } from './filesystem.js';
 import Terminals, { TerminalEvents, TerminalActions, type SpawnOptions } from './terminal.js';
-import Auth, { AuthActions } from './auth.js';
 import Lsp, { LspActions, LspEvents } from './lsp.js';
 import Composer, { ComposerActions, ComposerEvents } from './composer.js';
 import { LogEvents } from './log.js';
@@ -34,7 +35,7 @@ export type { ConfigPortMapping, ProjectConfig } from './config.js';
 export { PHPSandboxError, RemoteError, TransportError } from './errors/index.js';
 export type { HttpResponseDiagnostics, RemoteErrorCode, RemoteErrorSource, TransportErrorCode, ValidationErrorDetails, } from './errors/index.js';
 export * from './publication/index.js';
-export type { CreateServerInput, ServerData, ServerInstance, ServerListOptions, ServerMemberData, ServerSshOptions } from './servers.js';
+export type { CreateServerInput, ServerData, ServerInstance, ServerListOptions, ServerMemberData, ServerInvitationData, ServerInvitationTarget, ServerOrganizationTarget, ShareServerInput, ServerSshOptions, } from './servers.js';
 export type { ConfigureFeedbackInput, FeedbackData, FeedbackListOptions, FeedbackSource, FeedbackStatus, FeedbackType, FeedbackWidgetConfig, FeedbackWidgetTarget, SubmitFeedbackInput, UpdateFeedbackInput, } from './feedback.js';
 export type { Integration, IntegrationAuthorization, IntegrationAuthorizationType, IntegrationData, IntegrationProvider, IntegrationReference, LinkIntegrationInput, UpdateIntegrationInput, AttachSandboxIntegrationInput, SandboxIntegration, SandboxIntegrationData, SandboxIntegrationEffect, SandboxIntegrationReference, UpdateSandboxIntegrationInput, } from './integrations/index.js';
 interface Result<TType extends 'success' | 'error' | 'running', TData extends object> {
@@ -108,7 +109,7 @@ export interface Action<Args = object, Response = void> {
     response: Response;
 }
 export type Events = TerminalEvents & RuntimeEvents & LspEvents & ComposerEvents & LogEvents & ServiceEvents & NotebookEvents & ReplEvents & ShellEvents & FilesystemEvents;
-export type Invokable = TerminalActions & RuntimeActions & FilesystemActions & AuthActions & LspActions & ComposerActions & ServiceActions & ConfigActions & ReplActions & ShellActions & GitActions;
+export type Invokable = TerminalActions & RuntimeActions & FilesystemActions & LspActions & ComposerActions & ServiceActions & ConfigActions & ReplActions & ShellActions & GitActions;
 export interface CreateNotebookImportAuthInput {
     accessToken: string;
 }
@@ -364,6 +365,7 @@ export declare class PHPSandbox {
     readonly servers: ServerApi;
     readonly integrations: IntegrationApi;
     private constructor();
+    whoami(): Promise<Identity>;
     get runtimeTransport(): RuntimeTransport;
     static realtime(token: string, url?: string, options?: PHPSandboxClientOptions): PHPSandbox;
     static rest(token: string, url?: string, options?: PHPSandboxClientOptions): PHPSandbox;
@@ -387,7 +389,6 @@ export declare class NotebookInstance {
     protected client: Client;
     readonly files: Filesystem;
     readonly terminals: Terminals;
-    readonly auth: Auth;
     readonly lsp: Lsp;
     readonly composer: Composer;
     readonly runtime: Runtime;

package/dist/index.js

@@ -10,10 +10,10 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
     return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
 var _NotebookInstance_instances, _NotebookInstance_initPromise, _NotebookInstance_init;
+import { identitySchema } from './identity.js';
 import { NotebookPublication } from './publication/index.js';
 import { Filesystem } from './filesystem.js';
 import Terminals from './terminal.js';
-import Auth from './auth.js';
 import Lsp from './lsp.js';
 import Composer from './composer.js';
 import Runtime from './runtime.js';
@@ -157,7 +157,7 @@ class ClientImplementation {
             headers: this.headers,
         }));
         if (!response.ok) {
-            throw await responseError(response);
+            throw await responseError(response, path.startsWith('/platform/') ? 'platform' : 'core');
         }
         if (response.status === 204) {
             return { data: undefined };
@@ -195,10 +195,10 @@ class ClientImplementation {
         }
     }
 }
-async function responseError(response) {
+async function responseError(response, source = 'core') {
     const body = await response.text();
     try {
-        return remoteError('core', errorPayload(body === '' ? undefined : JSON.parse(body)), response);
+        return remoteError(source, errorPayload(body === '' ? undefined : JSON.parse(body)), response);
     }
     catch {
         return new TransportError(`PHPSandbox API returned an invalid error response (HTTP ${response.status}).`, 'InvalidResponse', response, {
@@ -221,6 +221,14 @@ export class PHPSandbox {
         this.servers = client.servers;
         this.integrations = client.integrations;
     }
+    async whoami() {
+        const { data } = await this.client.get('/auth/whoami');
+        const result = identitySchema.safeParse(data);
+        if (!result.success) {
+            throw new PHPSandboxError('Invalid identity response.');
+        }
+        return result.data;
+    }
     get runtimeTransport() {
         return this.client.runtimeTransport;
     }
@@ -269,7 +277,6 @@ export class NotebookInstance {
         }
         this.files = new Filesystem(this, this.socket === null ? null : (handler) => this.onDidConnect(handler));
         this.terminals = new Terminals(this);
-        this.auth = new Auth(this);
         this.lsp = new Lsp(this);
         this.composer = new Composer(this, client);
         this.runtime = new Runtime(this);
@@ -476,7 +483,7 @@ export class NotebookInstance {
         // Wait for the socket to reconnect
         await whenConnected;
         // Re-initialize the notebook
-        __classPrivateFieldGet(this, _NotebookInstance_instances, "m", _NotebookInstance_init).call(this);
+        __classPrivateFieldSet(this, _NotebookInstance_initPromise, __classPrivateFieldGet(this, _NotebookInstance_instances, "m", _NotebookInstance_init).call(this), "f");
         // Wait for initialization to complete
         return this.ready().then(() => this);
     }
@@ -524,8 +531,9 @@ class NotebookSecrets {
     }
     async list(options) {
         const params = new URLSearchParams();
-        if (options?.environment)
+        if (options?.environment) {
             params.set('environment', options.environment);
+        }
         const query = params.toString();
         const response = await this.client.get(`/notebook/${this.notebookId}/secrets${query ? `?${query}` : ''}`);
         return response.data;
@@ -543,8 +551,9 @@ class NotebookSecrets {
     }
     async delete(name, options) {
         const params = new URLSearchParams();
-        if (options?.environment)
+        if (options?.environment) {
             params.set('environment', options.environment);
+        }
         const query = params.toString();
         await this.client.delete(`/notebook/${this.notebookId}/secrets/${encodeURIComponent(name)}${query ? `?${query}` : ''}`);
     }

package/dist/integrations/sandbox.js

@@ -1,4 +1,4 @@
-import { Integration, integrationId, } from './account.js';
+import { Integration, integrationId } from './account.js';
 export class SandboxIntegrationApi {
     constructor(notebookId, client) {
         this.notebookId = notebookId;

package/dist/lsp.d.ts

@@ -47,8 +47,8 @@ export declare class LspConnection {
     onMessage(cb: (data: string) => void): Disposable;
     onError(cb: (message: string) => void): Disposable;
     onClose(cb: (code: number, reason: string) => void): Disposable;
-    dispose(): void;
-    start(): void;
+    dispose(): Promise<void>;
+    start(): Promise<void>;
     onClientDisconnect(cb: (code: number, message: string) => void): Disposable;
     whenSocketConnected(): Promise<NotebookInstance>;
     static create(id: string, lsp: Lsp): LspConnection;

package/dist/lsp.js

@@ -51,10 +51,10 @@ export class LspConnection {
         return this.lsp.onClose(this.id, cb);
     }
     dispose() {
-        this.lsp.close(this.id);
+        return this.lsp.close(this.id);
     }
     start() {
-        this.lsp.start(this.id);
+        return this.lsp.start(this.id);
     }
     onClientDisconnect(cb) {
         return this.lsp.onClientDisconnect(cb);

package/dist/publication/instance.js

@@ -51,6 +51,7 @@ export class PublicationInstance {
         const intervalMs = options.intervalMs ?? 1000;
         const timeoutMs = options.timeoutMs ?? 300000;
         const startedAt = Date.now();
+        // eslint-disable-next-line typescript/no-this-alias -- Polling starts with this instance and replaces it after each refresh.
         let current = this;
         while (!publicationStatusIsTerminal(current.data.status)) {
             if (Date.now() - startedAt > timeoutMs) {

package/dist/publication/notebook.js

@@ -41,8 +41,9 @@ export class NotebookPublication {
     /** Publish the exact app selection in a server-owned review. */
     async publish(input) {
         const application = (await this.client.post(`${this.path}/publication`, input)).data;
-        if (!('confirmationRequired' in application))
+        if (!('confirmationRequired' in application)) {
             this.startApplicationRuns(application);
+        }
         return application;
     }
     async application(applicationId) {
@@ -60,10 +61,12 @@ export class NotebookPublication {
     }
     startApplicationRuns(application) {
         for (const app of application.apps) {
-            if (!(application.selectedAppIds ?? []).includes(app.appId))
+            if (!(application.selectedAppIds ?? []).includes(app.appId)) {
                 continue;
-            if (!['pending', 'queued', 'building', 'deploying'].includes(app.publication.status))
+            }
+            if (!['pending', 'queued', 'building', 'deploying'].includes(app.publication.status)) {
                 continue;
+            }
             new PublicationRun(new PublicationInstance(app.publication, this.client, this.notebookId), this.client).start();
         }
     }
@@ -72,7 +75,6 @@ export class NotebookPublication {
         if (serverId !== undefined) {
             query.set('serverId', serverId);
         }
-        return (await this.client.get(`${this.path}/publication/catalog?${query}`))
-            .data;
+        return (await this.client.get(`${this.path}/publication/catalog?${query}`)).data;
     }
 }

package/dist/publication/resources.js

@@ -4,7 +4,8 @@ export class PublicationResources {
         this.path = path;
     }
     async inspect(id) {
-        return (await this.client.post(`/publication-resources/${encodeURIComponent(id)}/inspect`, {})).data;
+        return (await this.client.post(`/publication-resources/${encodeURIComponent(id)}/inspect`, {}))
+            .data;
     }
     async list(options = {}) {
         const query = new URLSearchParams();

package/dist/publication/stream.js

@@ -23,8 +23,9 @@ export async function* readPublicationStream(input, options = {}) {
         const lines = data;
         eventName = 'message';
         data = [];
-        if (!lines.length || !PublishStreamSseEventNameSchema.safeParse(name).success)
+        if (!lines.length || !PublishStreamSseEventNameSchema.safeParse(name).success) {
             return null;
+        }
         const raw = lines.join('\n');
         let payload;
         try {
@@ -34,24 +35,30 @@ export async function* readPublicationStream(input, options = {}) {
             payload = raw;
         }
         const event = PublishStreamSseEventSchema.parse({ event: name, data: payload });
-        if (event.type === 'result')
+        if (event.type === 'result') {
             receivedResult = true;
+        }
         return event;
     }
     function line(value) {
-        if (value === '')
+        if (value === '') {
             return dispatch();
-        if (value.startsWith(':'))
+        }
+        if (value.startsWith(':')) {
             return null;
+        }
         const colon = value.indexOf(':');
         const field = colon < 0 ? value : value.slice(0, colon);
         let content = colon < 0 ? '' : value.slice(colon + 1);
-        if (content.startsWith(' '))
+        if (content.startsWith(' ')) {
             content = content.slice(1);
-        if (field === 'event')
+        }
+        if (field === 'event') {
             eventName = content;
-        if (field === 'data')
+        }
+        if (field === 'data') {
             data.push(content);
+        }
         return null;
     }
     try {
@@ -61,24 +68,28 @@ export async function* readPublicationStream(input, options = {}) {
             // A CR at the end of a chunk may be the first half of CRLF.
             let match;
             while ((match = /\r\n|\r|\n/.exec(buffer))) {
-                if (!done && match[0] === '\r' && match.index === buffer.length - 1)
+                if (!done && match[0] === '\r' && match.index === buffer.length - 1) {
                     break;
+                }
                 const event = line(buffer.slice(0, match.index));
                 buffer = buffer.slice(match.index + match[0].length);
-                if (event)
+                if (event) {
                     yield event;
+                }
             }
             if (done) {
                 ended = true;
                 if (buffer) {
                     const event = line(buffer);
-                    if (event)
+                    if (event) {
                         yield event;
+                    }
                 }
                 // Preserve the SDK's support for a final event without a trailing blank line.
                 const event = dispatch();
-                if (event)
+                if (event) {
                     yield event;
+                }
                 if (options.requireResult !== false && !receivedResult) {
                     throw new PHPSandboxError('Publish stream ended without result');
                 }
@@ -87,8 +98,9 @@ export async function* readPublicationStream(input, options = {}) {
         }
     }
     finally {
-        if (!ended)
+        if (!ended) {
             await reader.cancel().catch(() => undefined);
+        }
         reader.releaseLock();
     }
 }
@@ -103,15 +115,16 @@ export function createPublicationStreamResponse(stream, options = {}) {
     let cancellation;
     let abort;
     async function dispose() {
-        if (disposed)
+        if (disposed) {
             return;
+        }
         disposed = true;
         options.signal?.removeEventListener('abort', abort);
         reader.releaseLock();
         await options.onDispose?.();
     }
     function cancel(reason) {
-        return cancellation ?? (cancellation = (async () => {
+        return (cancellation ?? (cancellation = (async () => {
             finished = true;
             try {
                 await reader.cancel(reason);
@@ -119,7 +132,7 @@ export function createPublicationStreamResponse(stream, options = {}) {
             finally {
                 await dispose();
             }
-        })());
+        })()));
     }
     return new Response(new ReadableStream({
         start(controller) {
@@ -127,16 +140,19 @@ export function createPublicationStreamResponse(stream, options = {}) {
                 controller.error(options.signal.reason);
                 void cancel(options.signal.reason).catch(() => undefined);
             };
-            if (options.signal?.aborted)
+            if (options.signal?.aborted) {
                 abort();
-            else
+            }
+            else {
                 options.signal?.addEventListener('abort', abort, { once: true });
+            }
         },
         async pull(controller) {
             try {
                 const { done, value } = await reader.read();
-                if (finished)
+                if (finished) {
                     return;
+                }
                 if (done) {
                     finished = true;
                     await dispose();
@@ -147,8 +163,9 @@ export function createPublicationStreamResponse(stream, options = {}) {
                 }
             }
             catch (error) {
-                if (finished && cancellation)
+                if (finished && cancellation) {
                     return;
+                }
                 try {
                     await cancel(error);
                 }

package/dist/runtime/rest.js

@@ -194,7 +194,8 @@ function runtimeActionRequestBody(action, data, url, headers) {
             throw new TypeError('Runtime file contents must be binary data.');
         }
         headers['Content-Type'] = 'application/octet-stream';
-        return Uint8Array.from(new Uint8Array(payload.contents.buffer, payload.contents.byteOffset, payload.contents.byteLength)).buffer;
+        return Uint8Array.from(new Uint8Array(payload.contents.buffer, payload.contents.byteOffset, payload.contents.byteLength))
+            .buffer;
     }
     headers['Content-Type'] = 'application/json';
     return JSON.stringify(data);

package/dist/runtime.js

@@ -1,7 +1,7 @@
 import Logs from './log.js';
 import Metrics from './metrics.js';
 import Ports from './ports.js';
-import { RuntimeTelemetry, } from './telemetry.js';
+import { RuntimeTelemetry } from './telemetry.js';
 export class RuntimeMetrics {
     constructor(metrics) {
         this.metrics = metrics;