@phpsandbox/sdk 0.1.17 → 0.1.19

package/dist/index.d.ts

@@ -32,7 +32,7 @@ export type { NotebookBuiltinServiceName, NotebookKnownServiceName, NotebookServ
 export type { ConfigPortMapping, ProjectConfig } from './config.js';
 export { PHPSandboxError, RemoteError, TransportError, } from './errors/index.js';
 export type { HttpResponseDiagnostics, RemoteErrorCode, RemoteErrorSource, TransportErrorCode, ValidationErrorDetails, } from './errors/index.js';
-export type { BuiltInPublicationProviderName, CloudflareContainersProviderOptions, LaravelCloudProviderData, LaravelCloudProviderInput, LaravelCloudRegion, PublicationBuildData, PublicationBuildStatus, PublicationData, PublicationEventData, PublicationInstance, PublicationJurisdiction, PublicationLogChunkData, PublicationLogStream, PublicationPlacement, PublicationProtectionData, PublicationProtectionInput, PublicationProtectionMode, PublicationProtectionSessionData, PublicationProvider, PublicationProviderData, PublicationProviderInput, PublicationProviderInputs, PublicationProviderName, PublicationRegion, PublicationReleaseData, PublicationReleaseStatus, PublicationRun, PublicationSize, PublicationStatus, PublishInput, PublishStreamEvent, PublishStreamLog, PublishStreamPhase, PublishStreamResult, PublishStreamSseEvent, SshServerProviderOptions, UpdatePublicationProtectionInput, } from './publications.js';
+export type { BuiltInPublicationProviderName, CloudflareContainersProviderOptions, LaravelCloudProviderData, LaravelCloudProviderInput, LaravelCloudRegion, PublicationBuildData, PublicationBuildStatus, PublicationData, PublicationDomainData, PublicationDomains, PublicationEventData, PublicationInstance, PublicationJurisdiction, PublicationLogChunkData, PublicationLogStream, PublicationPlacement, PublicationProtectionData, PublicationProtectionInput, PublicationProtectionMode, PublicationProtectionSessionData, PublicationProvider, PublicationProviderData, PublicationProviderInput, PublicationProviderInputs, PublicationProviderName, PublicationRegion, PublicationReleaseData, PublicationReleaseStatus, PublicationRun, PublicationSize, PublicationStatus, PublishInput, PublishStreamEvent, PublishStreamLog, PublishStreamPhase, PublishStreamResult, PublishStreamSseEvent, SshServerProviderOptions, UpdatePublicationProtectionInput, } from './publications.js';
 export type { CreateServerInput, ServerData, ServerInstance, ServerListOptions, ServerSshOptions } from './servers.js';
 export type { ConfigureFeedbackInput, FeedbackData, FeedbackListOptions, FeedbackSource, FeedbackStatus, FeedbackType, FeedbackWidgetConfig, FeedbackWidgetTarget, SubmitFeedbackInput, UpdateFeedbackInput, } from './feedback.js';
 export type { Integration, IntegrationAuthorization, IntegrationAuthorizationType, IntegrationData, IntegrationProvider, IntegrationReference, LinkIntegrationInput, UpdateIntegrationInput, AttachSandboxIntegrationInput, SandboxIntegration, SandboxIntegrationData, SandboxIntegrationEffect, SandboxIntegrationReference, UpdateSandboxIntegrationInput, } from './integrations/index.js';
@@ -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

@@ -106,6 +106,38 @@ export interface PublicationProtectionSessionData {
     expiresAt: string;
     url: string;
 }
+export interface PublicationDomainData {
+    id: string;
+    publicationId: string | null;
+    hostname: string;
+    status: string;
+    provider: string;
+    providerHostnameId: string | null;
+    dns: {
+        type: string | null;
+        name: string | null;
+        value: string | null;
+    };
+    ssl: {
+        status: string | null;
+    };
+    validationErrors: unknown[];
+    validationRecords: unknown[];
+    metadata: Record<string, unknown>;
+    verifiedAt: string | null;
+    createdAt: string | null;
+    updatedAt: string | null;
+}
+export declare class PublicationDomains {
+    private readonly client;
+    private readonly publicationId;
+    constructor(client: Client, publicationId: string);
+    list(): Promise<PublicationDomainData[]>;
+    create(hostname: string): Promise<PublicationDomainData>;
+    refresh(id: string): Promise<PublicationDomainData>;
+    delete(id: string): Promise<void>;
+    private path;
+}
 export declare class PublicationApi {
     private readonly client;
     constructor(client: Client);
@@ -114,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;
@@ -128,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;
@@ -138,6 +173,7 @@ export declare class PublicationInstance<TProvider extends PublicationProviderNa
     readonly data: PublicationData<TProvider>;
     private readonly client;
     private readonly notebookId?;
+    readonly domains: PublicationDomains;
     constructor(data: PublicationData<TProvider>, client: Client, notebookId?: string);
     refresh(): Promise<PublicationInstance<TProvider>>;
     publish(): Promise<PublicationRun<TProvider>>;

package/dist/publications.js

@@ -1,4 +1,25 @@
 import { PublicationEventDataSchema, PublicationLogChunkDataSchema, PublishStreamSseEventNameSchema, PublishStreamSseEventSchema, } from './schemas/publications.js';
+export class PublicationDomains {
+    constructor(client, publicationId) {
+        this.client = client;
+        this.publicationId = publicationId;
+    }
+    async list() {
+        return (await this.client.get(this.path())).data;
+    }
+    async create(hostname) {
+        return (await this.client.post(this.path(), { hostname })).data;
+    }
+    async refresh(id) {
+        return (await this.client.post(`${this.path()}/${encodeURIComponent(id)}/refresh`)).data;
+    }
+    async delete(id) {
+        await this.client.delete(`${this.path()}/${encodeURIComponent(id)}`);
+    }
+    path() {
+        return `/publications/${encodeURIComponent(this.publicationId)}/domains`;
+    }
+}
 export class PublicationApi {
     constructor(client) {
         this.client = client;
@@ -12,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;
@@ -60,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) {
@@ -78,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') {
@@ -124,6 +159,7 @@ export class PublicationInstance {
         this.data = data;
         this.client = client;
         this.notebookId = notebookId;
+        this.domains = new PublicationDomains(client, data.id);
     }
     async refresh() {
         const response = await this.client.get(`/publications/${this.data.id}`);

package/package.json

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