@phpsandbox/sdk 0.0.67 → 0.1.1

package/README.md

@@ -76,14 +76,11 @@ PHPSandbox.rest('token', 'https://api.phpsandbox.io/v1', {
 const client = PHPSandbox.realtime(process.env.PHPSANDBOX_TOKEN!);
 
 const created = await client.notebook.create('laravel');
-const opened = await client.notebook.open('notebook-id');
-await opened.ready();
-
 const fetched = await client.notebook.get('notebook-id');
 await fetched.ready();
 
 const forked = await created.fork();
-await forked.delete();
+await forked.destroy();
 
 const persistent = await client.notebook.create('laravel', {
   title: 'Persistent Laravel',
@@ -101,9 +98,9 @@ console.log(persistentFork.data.policy);
 Notes:
 
 - `create()` and `fork()` initialize automatically.
-- `open()` and `get()` return a notebook instance; call `await notebook.ready()` before using tools.
+- `get()` returns a notebook instance; call `await notebook.ready()` before using tools.
 - API notebook creates and forks are ephemeral by default. `persistent: true` requires an entitled account.
-- Use `NotebookData.runtimeUrl`, `runtimeUrlProvider`, and `DeploymentData.eventStreamUrl` for runtime access. Their `okraUrl` and `okraUrlProvider` aliases are deprecated compatibility fields.
+- Use `NotebookData.runtimeUrl`, `runtimeUrlProvider`, and `PublicationData.eventStreamUrl` for runtime access.
 
 ## Services At A Glance
 
@@ -117,7 +114,6 @@ Each `NotebookInstance` exposes service clients:
 - `notebook.git` (`Git`)
 - `notebook.lsp` (`Lsp`)
 - `notebook.repl` (`Repl`)
-- `notebook.laravel` (`Laravel`)
 - `notebook.auth` (`Auth`)
 - `notebook.log` (`Log`)
 - `notebook.services` (`Services`)
@@ -125,9 +121,8 @@ Each `NotebookInstance` exposes service clients:
 
 Notes:
 
-- `terminal.spawn()` and `shell.exec()` are part of the current runtime action set. `terminal.start` currently is not.
-- `notebook.repl.eval()` is part of the current runtime action set. `repl.start` is currently not.
-- `notebook.laravel` is exposed by the SDK, but the current runtime action set does not expose Laravel maintenance actions.
+- `terminal.spawn()` is the TTY-oriented process API; `notebook.run()` is the native non-TTY process API.
+- `notebook.repl.eval()` evaluates PHP without exposing the unsupported `repl.start` action.
 
 ## Common Operations
 
@@ -166,9 +161,11 @@ console.log(exitCode);
 ### Shell
 
 ```ts
-const result = await notebook.shell.exec('php -v');
-result.throw();
-console.log(result.output);
+const process = notebook.run('php -v', { tty: false });
+for await (const chunk of process.output) {
+  console.log(chunk.source, new TextDecoder().decode(chunk.data));
+}
+(await process.exit).throw();
 ```
 
 ### Services

package/dist/auth.d.ts

@@ -7,6 +7,5 @@ export interface AuthActions {
 export default class Auth {
     protected okra: NotebookInstance;
     constructor(okra: NotebookInstance);
-    logout(): void;
     login(runtimeUrl: string): Promise<boolean>;
 }

package/dist/auth.js

@@ -2,9 +2,6 @@ export default class Auth {
     constructor(okra) {
         this.okra = okra;
     }
-    logout() {
-        this.okra.dispose();
-    }
     login(runtimeUrl) {
         const runtimeTicket = new URL(runtimeUrl).searchParams.get('ticket');
         if (runtimeTicket === null || runtimeTicket === '') {

package/dist/beacon/index.d.ts

@@ -1,6 +1,7 @@
 import { Disposable } from '../types.js';
 import { BeaconActions, BeaconEvents, BeaconOptions, DebugInfo, ConsoleEvent, BeaconErrorEvent, DebugRequest, DebugResult, ScreenshotRequest, ScreenshotResult, FetchRequest, FetchResult } from './types.js';
 import { Navigator } from './navigator.js';
+import type { NotebookInstance } from '../index.js';
 export * from './types.js';
 export { Navigator } from './navigator.js';
 /**
@@ -166,6 +167,7 @@ export declare class Beacon implements BeaconActions {
  * Factory function to create a beacon instance for an iframe
  */
 export declare function createBeacon(iframe: HTMLIFrameElement, options?: BeaconOptions): Beacon;
+export declare function connectBeacon(notebook: NotebookInstance, iframe: HTMLIFrameElement, options?: BeaconOptions): Promise<Beacon>;
 /**
  * Check if the current environment supports the Beacon SDK
  */

package/dist/beacon/index.js

@@ -530,6 +530,11 @@ export class Beacon {
 export function createBeacon(iframe, options) {
     return new Beacon(iframe, options);
 }
+export async function connectBeacon(notebook, iframe, options) {
+    const result = await notebook.ready();
+    iframe.src = result.data.previewUrl;
+    return createBeacon(iframe, options);
+}
 /**
  * Check if the current environment supports the Beacon SDK
  */