@phpsandbox/sdk 0.1.18 → 0.1.19

package/dist/index.d.ts

@@ -340,7 +340,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;
 }

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);

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.19",
   "description": "The TypeScript SDK for PHPSandbox cloud development environments",
   "main": "./dist/index.js",
   "module": "./dist/index.js",