@phpsandbox/sdk 0.0.66 → 0.0.67

package/README.md

@@ -66,7 +66,7 @@ PHPSandbox.realtime('token', 'https://api.phpsandbox.io/v1', {
 
 // Use explicit request/response runtime actions without a websocket.
 PHPSandbox.rest('token', 'https://api.phpsandbox.io/v1', {
-  okraUrlProvider: async (notebookId) => getFreshOkraUrl(notebookId),
+  runtimeUrlProvider: async (notebookId) => getFreshRuntimeUrl(notebookId),
 });
 ```
 
@@ -103,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
 
@@ -124,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

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

package/dist/auth.js

@@ -5,8 +5,8 @@ export default class Auth {
     logout() {
         this.okra.dispose();
     }
-    login(okraUrl) {
-        const runtimeTicket = new URL(okraUrl).searchParams.get('ticket');
+    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.');
         }

package/dist/browser/phpsandbox-sdk.esm.js

@@ -584,8 +584,8 @@ var Auth = class {
   logout() {
     this.okra.dispose();
   }
-  login(okraUrl) {
-    const runtimeTicket = new URL(okraUrl).searchParams.get("ticket");
+  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.");
     }
@@ -19441,8 +19441,9 @@ var DeploymentRun = class {
     if (this.started) {
       return this;
     }
-    if (!this.initial.data.okraUrl) {
-      throw new Error(`Deployment ${this.initial.data.id} has no okraUrl for SSE streaming`);
+    const eventStreamUrl = this.initial.data.eventStreamUrl ?? this.initial.data.okraUrl;
+    if (!eventStreamUrl) {
+      throw new Error(`Deployment ${this.initial.data.id} has no eventStreamUrl for SSE streaming`);
     }
     this.started = true;
     this.resultPromise = new Promise((resolve, reject) => {
@@ -19450,7 +19451,7 @@ var DeploymentRun = class {
       this.rejectResult = reject;
     });
     this.resultPromise.catch(() => void 0);
-    void this.consumeStream(this.initial.data.okraUrl);
+    void this.consumeStream(eventStreamUrl);
     return this;
   }
   subscribe() {
@@ -19467,9 +19468,9 @@ var DeploymentRun = class {
     }
     return queue;
   }
-  async consumeStream(okraUrl) {
+  async consumeStream(eventStreamUrl) {
     try {
-      const stream = await this.client.sse(okraUrl);
+      const stream = await this.client.sse(eventStreamUrl);
       for await (const event of readDeployStreamEvents(stream)) {
         this.publish(event);
         if (event.type === "result") {
@@ -19868,20 +19869,20 @@ var RestRuntimeInvoker = class {
     this.refresh = refresh;
     this.refreshPromise = null;
     this.notebookId = data.id;
-    this.configure(data.okraUrl);
+    this.configure(data.runtimeUrl ?? data.okraUrl);
   }
-  configure(connectionUrl) {
-    const okraUrl = new URL(connectionUrl);
-    const ticket = okraUrl.searchParams.get("ticket") ?? "";
+  configure(runtimeUrl) {
+    const actionUrl = new URL(runtimeUrl);
+    const ticket = actionUrl.searchParams.get("ticket") ?? "";
     if (ticket === "") {
       throw new UnsupportedRuntimeTransportError("The notebook connection does not contain a runtime ticket.");
     }
     this.ticket = ticket;
-    okraUrl.protocol = okraUrl.protocol === "wss:" ? "https:" : "http:";
-    okraUrl.pathname = `/api/v1/notebooks/${encodeURIComponent(this.notebookId)}`;
-    okraUrl.searchParams.delete("ticket");
-    okraUrl.hash = "";
-    this.actionUrl = okraUrl;
+    actionUrl.protocol = actionUrl.protocol === "wss:" ? "https:" : "http:";
+    actionUrl.pathname = `/api/v1/notebooks/${encodeURIComponent(this.notebookId)}`;
+    actionUrl.searchParams.delete("ticket");
+    actionUrl.hash = "";
+    this.actionUrl = actionUrl;
   }
   ready() {
     return this.invokeRaw("runtime.ready", {}, {});
@@ -19939,7 +19940,7 @@ var RestRuntimeInvoker = class {
   }
   async refreshAuthorization() {
     if (this.refreshPromise === null) {
-      this.refreshPromise = this.refresh().then((okraUrl) => this.configure(okraUrl));
+      this.refreshPromise = this.refresh().then((runtimeUrl) => this.configure(runtimeUrl));
     }
     try {
       await this.refreshPromise;
@@ -20335,23 +20336,25 @@ var NotebookInstance2 = class {
     this.initialized = false;
     __privateAdd(this, _initPromise, null);
     this.disposables = [];
+    const runtimeUrl = data.runtimeUrl ?? data.okraUrl;
+    const runtimeUrlProvider = client.options.runtimeUrlProvider ?? client.options.okraUrlProvider;
     this.emitter = EventManager.createInstance();
     if (client.runtimeTransport === "rest") {
       this.socket = null;
       this.restInvoker = new RestRuntimeInvoker(
         data,
         client.options.fetch ?? globalThis.fetch,
-        client.options.okraUrlProvider === void 0 ? void 0 : () => client.options.okraUrlProvider(data.id)
+        runtimeUrlProvider === void 0 ? void 0 : () => runtimeUrlProvider(data.id)
       );
     } else {
       this.restInvoker = null;
       let initialConnection = true;
-      const connectionUrl = client.options.okraUrlProvider === void 0 ? data.okraUrl : async () => {
+      const connectionUrl = runtimeUrlProvider === void 0 ? runtimeUrl : async () => {
         if (initialConnection) {
           initialConnection = false;
-          return data.okraUrl;
+          return runtimeUrl;
         }
-        return client.options.okraUrlProvider(data.id);
+        return runtimeUrlProvider(data.id);
       };
       this.socket = new Transport(connectionUrl, this.emitter, {
         debug: client.options.debug,