@phpsandbox/sdk 0.1.14 → 0.1.16

package/dist/errors/index.d.ts

@@ -29,9 +29,15 @@ export declare class RemoteError<TCode extends RemoteErrorCode = RemoteErrorCode
     };
     is<TExpectedCode extends RemoteErrorCode>(code: TExpectedCode): this is this & RemoteError<TExpectedCode>;
 }
+export interface HttpResponseDiagnostics {
+    readonly status: number;
+    readonly statusText: string;
+    readonly body: string;
+}
 export declare class TransportError<TCode extends TransportErrorCode = TransportErrorCode> extends PHPSandboxError {
     readonly code: TCode;
-    constructor(message: string, code: TCode, cause?: unknown);
+    readonly response?: HttpResponseDiagnostics;
+    constructor(message: string, code: TCode, cause?: unknown, response?: HttpResponseDiagnostics);
     static is(error: unknown): error is TransportError;
     static is<TCode extends TransportErrorCode>(error: unknown, code: TCode): error is TransportError<TCode>;
     is<TExpectedCode extends TransportErrorCode>(code: TExpectedCode): this is this & TransportError<TExpectedCode>;

package/dist/errors/index.js

@@ -56,9 +56,10 @@ export class RemoteError extends PHPSandboxError {
     }
 }
 export class TransportError extends PHPSandboxError {
-    constructor(message, code, cause) {
+    constructor(message, code, cause, response) {
         super(message, cause);
         this.code = code;
+        this.response = response;
     }
     static is(error, code) {
         return error instanceof TransportError && (code === undefined || error.code === code);

package/dist/index.d.ts

@@ -31,7 +31,7 @@ export { notebookBuiltinServices, notebookKnownServices } from './services.js';
 export type { NotebookBuiltinServiceName, NotebookKnownServiceName, NotebookServiceCommand, NotebookServiceKind, NotebookServiceName, NotebookServiceSource, NotebookServiceState, NotebookServiceStatus, ServiceLogOptions, ServiceLogStreamOptions, } from './services.js';
 export type { ConfigPortMapping, ProjectConfig } from './config.js';
 export { PHPSandboxError, RemoteError, TransportError, } from './errors/index.js';
-export type { RemoteErrorCode, RemoteErrorSource, TransportErrorCode, ValidationErrorDetails, } 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 { CreateServerInput, ServerData, ServerInstance, ServerListOptions, ServerSshOptions } from './servers.js';
 export type { ConfigureFeedbackInput, FeedbackData, FeedbackListOptions, FeedbackSource, FeedbackStatus, FeedbackType, FeedbackWidgetConfig, FeedbackWidgetTarget, SubmitFeedbackInput, UpdateFeedbackInput, } from './feedback.js';
@@ -52,16 +52,25 @@ export type NotebookInitResponse = {
     provisioned: boolean;
     provisioningAction: NotebookProvisioningAction | null;
 };
-export type NotebookInitProgressKind = 'phase' | 'log' | 'heartbeat';
-export interface NotebookInitProgress {
+export interface NotebookDownloadProgress {
+    totalBytes: number;
+    downloadedBytes: number;
+}
+export interface NotebookInitProgressMessage {
     message: string;
     details?: string;
-    kind?: NotebookInitProgressKind;
     step?: string;
     line?: string;
     chunk?: string;
     command?: string;
 }
+export type NotebookInitProgress = NotebookInitProgressMessage & ({
+    phase: 'downloading';
+    download: NotebookDownloadProgress;
+} | {
+    phase: 'waiting' | 'preparing' | 'extracting' | 'provisioning' | 'starting';
+    download?: never;
+});
 export type NotebookInitErrorCode = 'GitHubImportCredentialMissing' | 'NotebookDiskQuotaExceeded' | 'NotebookNotFound' | 'NotebookSetupJsonInvalid' | 'NotebookBackupRestoreFailed';
 export interface NotebookInitErrorData {
     errorCode?: NotebookInitErrorCode;
@@ -211,11 +220,14 @@ export interface NotebookPreviewDataEnabled {
 export type NotebookPreviewData = NotebookPreviewDataDisabled | NotebookPreviewDataEnabled;
 export type NotebookPreviewDataWithUrl = NotebookPreviewDataDisabled | (NotebookPreviewDataEnabled & {
     url: string;
+    accessUrl: string;
 });
 export interface SetNotebookPreviewInput {
     password: string;
 }
 export interface NotebookPreviewSessionData {
+    /** Open this URL to establish preview access. */
+    accessUrl: string;
     previewSessionId: string;
     token: string;
     expiresAt: string;
@@ -230,6 +242,8 @@ export interface CreateNotebookPreviewHandoffInput {
     url: string;
 }
 export interface NotebookPreviewHandoffData {
+    /** Open this URL to establish preview access. */
+    accessUrl: string;
     handoffId: string;
     previewSessionId: string;
     token: string;

package/dist/index.js

@@ -114,7 +114,7 @@ class ClientImplementation {
             headers: this.headers,
         }));
         if (!response.ok) {
-            throw remoteError('core', errorPayload(await responsePayload(response)), response);
+            throw await responseError(response);
         }
         if (!response.body) {
             throw new TransportError('PHPSandbox API response body is not readable.', 'InvalidResponse', response);
@@ -130,7 +130,7 @@ class ClientImplementation {
             },
         }));
         if (!response.ok) {
-            throw remoteError('core', errorPayload(await responsePayload(response)), response);
+            throw await responseError(response);
         }
         if (!response.body) {
             throw new TransportError('PHPSandbox API SSE response body is not readable.', 'InvalidResponse', response);
@@ -144,7 +144,7 @@ class ClientImplementation {
             headers: this.headers,
         }));
         if (!response.ok) {
-            throw remoteError('core', errorPayload(await responsePayload(response)), response);
+            throw await responseError(response);
         }
         if (response.status === 204) {
             return { data: undefined };
@@ -179,16 +179,17 @@ class ClientImplementation {
         }
     }
 }
-async function responsePayload(response) {
+async function responseError(response) {
     const body = await response.text();
-    if (body === '') {
-        return undefined;
-    }
     try {
-        return JSON.parse(body);
+        return remoteError('core', errorPayload(body === '' ? undefined : JSON.parse(body)), response);
     }
-    catch (error) {
-        throw new TransportError('PHPSandbox API returned an invalid JSON response.', 'InvalidResponse', error);
+    catch {
+        return new TransportError(`PHPSandbox API returned an invalid error response (HTTP ${response.status}).`, 'InvalidResponse', response, {
+            status: response.status,
+            statusText: response.statusText,
+            body,
+        });
     }
 }
 function errorPayload(payload) {

package/package.json

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