@phpsandbox/sdk 0.1.18 → 0.1.20

package/dist/index.d.ts

@@ -9,7 +9,7 @@ import Repl, { ReplActions, ReplEvents } from './repl.js';
 import { ShellEvents, ShellActions, type ProcessResult, type ShellProcess } from './shell.js';
 import Services, { ServiceActions, ServiceEvents } from './services.js';
 import Config, { ConfigActions } from './config.js';
-import Git, { GitActions } from './git.js';
+import Git, { GitActions, type GitSyncAuthor } from './git.js';
 import { Disposable } from './types.js';
 import { RemoteError } from './errors/index.js';
 import { PublicationApi, PublicationInstance, PublicationRun, type PublishInput } from './publications.js';
@@ -133,7 +133,12 @@ export interface NotebookImportInspectionData {
     reason: string | null;
     requiredSecrets: NotebookImportRequiredSecret[];
 }
+export interface NotebookGitConfiguration {
+    /** Set a sandbox default identity, or use null to reset it to the Helfer bot. */
+    author: GitSyncAuthor | null;
+}
 export interface NotebookLifecycleInput {
+    git?: NotebookGitConfiguration;
     persistent?: true;
 }
 export interface CreateNotebookInput extends NotebookLifecycleInput {
@@ -144,6 +149,11 @@ export interface CreateNotebookInput extends NotebookLifecycleInput {
     secrets?: UpsertNotebookSecretItemInput[];
 }
 export type ForkNotebookInput = NotebookLifecycleInput;
+export interface UpdateNotebookInput {
+    title?: string;
+    visibility?: 'public' | 'private' | 'unlisted';
+    git?: NotebookGitConfiguration;
+}
 export interface NotebookPolicyData {
     autoDeleteWhenStale: boolean;
     staleAfterMinutes: number | null;
@@ -340,7 +350,7 @@ declare class ClientImplementation {
         data: T;
     }>;
     stream(path: string): Promise<ReadableStream<Uint8Array>>;
-    sse(url: string): Promise<ReadableStream<Uint8Array>>;
+    sse(url: string, signal?: AbortSignal): Promise<ReadableStream<Uint8Array>>;
     private makeRequest;
     private fetchResponse;
 }
@@ -365,6 +375,9 @@ export interface NotebookData {
     slug?: string;
     description?: string | null;
     policy?: NotebookPolicyData;
+    git?: {
+        author: GitSyncAuthor;
+    };
 }
 export declare class NotebookInstance {
     #private;
@@ -394,6 +407,8 @@ export declare class NotebookInstance {
     private readonly disposables;
     constructor(data: NotebookData, client: Client);
     ready(): Promise<NotebookInitSuccessResult>;
+    /** Update sandbox metadata and Git defaults without restarting it. */
+    update(input: UpdateNotebookInput): Promise<NotebookData>;
     fork(input?: Partial<ForkNotebookInput>): Promise<NotebookInstance>;
     publication(): Promise<PublicationInstance | null>;
     publish(input?: PublishInput): Promise<PublicationRun>;

package/dist/index.js

@@ -124,13 +124,14 @@ class ClientImplementation {
         }
         return response.body;
     }
-    async sse(url) {
+    async sse(url, signal) {
         const response = await this.fetchResponse(authenticatedRequest(url, {
             method: 'GET',
             headers: {
                 ...this.headers,
                 'Accept': 'text/event-stream',
             },
+            ...(signal === undefined ? {} : { signal }),
         }));
         if (!response.ok) {
             throw await responseError(response);
@@ -296,6 +297,12 @@ export class NotebookInstance {
         // Just apply a reasonable timeout for the entire initialization process
         return ready();
     }
+    /** Update sandbox metadata and Git defaults without restarting it. */
+    async update(input) {
+        const response = await this.client.put(`/notebook/${this.data.id}`, input);
+        Object.assign(this.data, response.data);
+        return this.data;
+    }
     async fork(input = {}) {
         const response = await this.client.post(`/notebook/${this.data.id}/fork`, input);
         return new NotebookInstance(response.data, this.client);

package/dist/publications.d.ts

@@ -146,6 +146,7 @@ export declare class PublicationApi {
 export declare class PublicationRun<TProvider extends PublicationProviderName = PublicationProviderName> {
     readonly initial: PublicationInstance<TProvider>;
     private readonly client;
+    private readonly streamAbort;
     private started;
     private completed;
     private finalError;
@@ -160,6 +161,8 @@ export declare class PublicationRun<TProvider extends PublicationProviderName =
     result(): Promise<PublishStreamResult>;
     publication(): Promise<PublicationInstance<TProvider>>;
     start(): this;
+    /** Stop observing this run; the server-side publication continues. */
+    dispose(): void;
     private subscribe;
     private consumeStream;
     private publish;

package/dist/publications.js

@@ -33,6 +33,7 @@ export class PublicationRun {
     constructor(initial, client) {
         this.initial = initial;
         this.client = client;
+        this.streamAbort = new AbortController();
         this.started = false;
         this.completed = false;
         this.finalError = null;
@@ -81,6 +82,19 @@ export class PublicationRun {
         void this.consumeStream(eventStreamUrl);
         return this;
     }
+    /** Stop observing this run; the server-side publication continues. */
+    dispose() {
+        if (this.completed)
+            return;
+        const error = new DOMException('Stopped observing publication; deployment continues.', 'AbortError');
+        if (!this.started) {
+            this.started = true;
+            this.resultPromise = Promise.reject(error);
+            this.resultPromise.catch(() => undefined);
+        }
+        this.streamAbort.abort(error);
+        this.fail(error);
+    }
     subscribe() {
         const queue = new AsyncPublishEventQueue();
         for (const event of this.bufferedEvents) {
@@ -99,7 +113,7 @@ export class PublicationRun {
     }
     async consumeStream(eventStreamUrl) {
         try {
-            const stream = await this.client.sse(eventStreamUrl);
+            const stream = await this.client.sse(eventStreamUrl, this.streamAbort.signal);
             for await (const event of readPublishStreamEvents(stream)) {
                 this.publish(event);
                 if (event.type === 'result') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phpsandbox/sdk",
-  "version": "0.1.18",
+  "version": "0.1.20",
   "description": "The TypeScript SDK for PHPSandbox cloud development environments",
   "main": "./dist/index.js",
   "module": "./dist/index.js",