@phpsandbox/sdk 0.0.65 → 0.0.67

package/README.md

@@ -18,7 +18,7 @@ import { PHPSandbox } from '@phpsandbox/sdk';
 const token = process.env.PHPSANDBOX_TOKEN;
 if (!token) throw new Error('Missing PHPSANDBOX_TOKEN');
 
-const client = new PHPSandbox(token);
+const client = PHPSandbox.realtime(token);
 
 // create() initializes the notebook by default
 const notebook = await client.notebook.create('php');
@@ -53,22 +53,27 @@ Use an API token:
 ```ts
 import { PHPSandbox } from '@phpsandbox/sdk';
 
-const client = new PHPSandbox(process.env.PHPSANDBOX_TOKEN!);
+const client = PHPSandbox.realtime(process.env.PHPSANDBOX_TOKEN!);
 ```
 
-Optional constructor args:
+Explicit realtime and REST clients:
 
 ```ts
-new PHPSandbox('token', 'https://api.phpsandbox.io/v1', {
+PHPSandbox.realtime('token', 'https://api.phpsandbox.io/v1', {
   debug: false,
   startClosed: true,
 });
+
+// Use explicit request/response runtime actions without a websocket.
+PHPSandbox.rest('token', 'https://api.phpsandbox.io/v1', {
+  runtimeUrlProvider: async (notebookId) => getFreshRuntimeUrl(notebookId),
+});
 ```
 
 ## Notebook Lifecycle
 
 ```ts
-const client = new PHPSandbox(process.env.PHPSANDBOX_TOKEN!);
+const client = PHPSandbox.realtime(process.env.PHPSANDBOX_TOKEN!);
 
 const created = await client.notebook.create('laravel');
 const opened = await client.notebook.open('notebook-id');
@@ -98,6 +103,7 @@ Notes:
 - `create()` and `fork()` initialize automatically.
 - `open()` and `get()` return 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.
 
 ## Services At A Glance
 
@@ -119,9 +125,9 @@ Each `NotebookInstance` exposes service clients:
 
 Notes:
 
-- `terminal.spawn()` and `shell.exec()` are part of the current okra websocket action set. `terminal.start` currently is not.
-- `notebook.repl.eval()` is part of the current okra websocket action set. `repl.start` is currently not.
-- `notebook.laravel` is exposed by the SDK, but the current okra websocket action set does not expose Laravel maintenance actions.
+- `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.
 
 ## Common Operations
 

package/dist/auth.d.ts

@@ -1,13 +1,12 @@
 import { Action, NotebookInstance } from './index.js';
 export interface AuthActions {
     'auth.login': Action<{
-        newConnectionData: string;
+        runtimeTicket: string;
     }, boolean>;
-    'auth.logout': Action<null>;
 }
 export default class Auth {
     protected okra: NotebookInstance;
     constructor(okra: NotebookInstance);
-    logout(): Promise<void>;
-    login(newConnectionData: string): Promise<boolean>;
+    logout(): void;
+    login(runtimeUrl: string): Promise<boolean>;
 }

package/dist/auth.js

@@ -3,9 +3,13 @@ export default class Auth {
         this.okra = okra;
     }
     logout() {
-        return this.okra.invoke('auth.logout');
+        this.okra.dispose();
     }
-    login(newConnectionData) {
-        return this.okra.invoke('auth.login', { newConnectionData });
+    login(runtimeUrl) {
+        const runtimeTicket = new URL(runtimeUrl).searchParams.get('ticket');
+        if (runtimeTicket === null || runtimeTicket === '') {
+            throw new TypeError('The notebook connection does not contain a runtime ticket.');
+        }
+        return this.okra.invoke('auth.login', { runtimeTicket });
     }
 }