@phpsandbox/sdk 0.1.20 → 0.2.0

package/dist/schemas/publications.d.ts

@@ -5,33 +5,33 @@ export declare const PublicationProviderNameSchema: z.ZodEnum<{
     "laravel-cloud": "laravel-cloud";
 }>;
 export declare const PublicationStatusSchema: z.ZodEnum<{
-    stopped: "stopped";
-    deleted: "deleted";
     pending: "pending";
     queued: "queued";
     building: "building";
     deploying: "deploying";
     healthy: "healthy";
     failed: "failed";
+    stopped: "stopped";
     deleting: "deleting";
+    deleted: "deleted";
     delete_failed: "delete_failed";
 }>;
 export declare const PublicationBuildStatusSchema: z.ZodEnum<{
-    running: "running";
     pending: "pending";
     queued: "queued";
     failed: "failed";
+    running: "running";
     succeeded: "succeeded";
     cancelled: "cancelled";
 }>;
 export declare const PublicationReleaseStatusSchema: z.ZodEnum<{
-    created: "created";
     deleted: "deleted";
+    created: "created";
     ready: "ready";
 }>;
 export declare const PublicationSizeSchema: z.ZodEnum<{
-    small: "small";
     nano: "nano";
+    small: "small";
     medium: "medium";
     large: "large";
     lite: "lite";
@@ -86,8 +86,8 @@ export declare const PublicationLogChunkDataSchema: z.ZodObject<{
 export declare const PublishStreamPhaseSchema: z.ZodObject<{
     name: z.ZodString;
     status: z.ZodOptional<z.ZodEnum<{
-        running: "running";
         failed: "failed";
+        running: "running";
         completed: "completed";
     }>>;
     data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
@@ -107,23 +107,23 @@ export declare const PublishStreamResultSchema: z.ZodObject<{
     buildId: z.ZodString;
     releaseId: z.ZodString;
     status: z.ZodEnum<{
-        stopped: "stopped";
-        deleted: "deleted";
         pending: "pending";
         queued: "queued";
         building: "building";
         deploying: "deploying";
         healthy: "healthy";
         failed: "failed";
+        stopped: "stopped";
         deleting: "deleting";
+        deleted: "deleted";
         delete_failed: "delete_failed";
     }>;
 }, z.core.$strict>;
 export declare const PublishStreamPhaseEventSchema: z.ZodObject<{
     name: z.ZodString;
     status: z.ZodOptional<z.ZodEnum<{
-        running: "running";
         failed: "failed";
+        running: "running";
         completed: "completed";
     }>>;
     data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
@@ -145,15 +145,15 @@ export declare const PublishStreamResultEventSchema: z.ZodObject<{
     buildId: z.ZodString;
     releaseId: z.ZodString;
     status: z.ZodEnum<{
-        stopped: "stopped";
-        deleted: "deleted";
         pending: "pending";
         queued: "queued";
         building: "building";
         deploying: "deploying";
         healthy: "healthy";
         failed: "failed";
+        stopped: "stopped";
         deleting: "deleting";
+        deleted: "deleted";
         delete_failed: "delete_failed";
     }>;
     type: z.ZodLiteral<"result">;
@@ -161,8 +161,8 @@ export declare const PublishStreamResultEventSchema: z.ZodObject<{
 export declare const PublishStreamEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     name: z.ZodString;
     status: z.ZodOptional<z.ZodEnum<{
-        running: "running";
         failed: "failed";
+        running: "running";
         completed: "completed";
     }>>;
     data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
@@ -182,15 +182,15 @@ export declare const PublishStreamEventSchema: z.ZodDiscriminatedUnion<[z.ZodObj
     buildId: z.ZodString;
     releaseId: z.ZodString;
     status: z.ZodEnum<{
-        stopped: "stopped";
-        deleted: "deleted";
         pending: "pending";
         queued: "queued";
         building: "building";
         deploying: "deploying";
         healthy: "healthy";
         failed: "failed";
+        stopped: "stopped";
         deleting: "deleting";
+        deleted: "deleted";
         delete_failed: "delete_failed";
     }>;
     type: z.ZodLiteral<"result">;
@@ -199,19 +199,19 @@ export declare const PublishStreamErrorSchema: z.ZodObject<{
     message: z.ZodOptional<z.ZodString>;
 }, z.core.$loose>;
 export declare const PublishStreamSseEventNameSchema: z.ZodEnum<{
-    error: "error";
     phase: "phase";
     log: "log";
     result: "result";
     done: "done";
+    error: "error";
 }>;
 export declare const PublishStreamSsePhaseEventSchema: z.ZodObject<{
     event: z.ZodLiteral<"phase">;
     data: z.ZodObject<{
         name: z.ZodString;
         status: z.ZodOptional<z.ZodEnum<{
-            running: "running";
             failed: "failed";
+            running: "running";
             completed: "completed";
         }>>;
         data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
@@ -237,15 +237,15 @@ export declare const PublishStreamSseDoneEventSchema: z.ZodObject<{
         buildId: z.ZodString;
         releaseId: z.ZodString;
         status: z.ZodEnum<{
-            stopped: "stopped";
-            deleted: "deleted";
             pending: "pending";
             queued: "queued";
             building: "building";
             deploying: "deploying";
             healthy: "healthy";
             failed: "failed";
+            stopped: "stopped";
             deleting: "deleting";
+            deleted: "deleted";
             delete_failed: "delete_failed";
         }>;
     }, z.core.$strict>;
@@ -259,15 +259,15 @@ export declare const PublishStreamSseResultEventSchema: z.ZodObject<{
         buildId: z.ZodString;
         releaseId: z.ZodString;
         status: z.ZodEnum<{
-            stopped: "stopped";
-            deleted: "deleted";
             pending: "pending";
             queued: "queued";
             building: "building";
             deploying: "deploying";
             healthy: "healthy";
             failed: "failed";
+            stopped: "stopped";
             deleting: "deleting";
+            deleted: "deleted";
             delete_failed: "delete_failed";
         }>;
     }, z.core.$strict>;
@@ -283,8 +283,8 @@ export declare const PublishStreamSseEventSchema: z.ZodPipe<z.ZodDiscriminatedUn
     data: z.ZodObject<{
         name: z.ZodString;
         status: z.ZodOptional<z.ZodEnum<{
-            running: "running";
             failed: "failed";
+            running: "running";
             completed: "completed";
         }>>;
         data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
@@ -308,15 +308,15 @@ export declare const PublishStreamSseEventSchema: z.ZodPipe<z.ZodDiscriminatedUn
         buildId: z.ZodString;
         releaseId: z.ZodString;
         status: z.ZodEnum<{
-            stopped: "stopped";
-            deleted: "deleted";
             pending: "pending";
             queued: "queued";
             building: "building";
             deploying: "deploying";
             healthy: "healthy";
             failed: "failed";
+            stopped: "stopped";
             deleting: "deleting";
+            deleted: "deleted";
             delete_failed: "delete_failed";
         }>;
     }, z.core.$strict>;
@@ -329,15 +329,15 @@ export declare const PublishStreamSseEventSchema: z.ZodPipe<z.ZodDiscriminatedUn
         buildId: z.ZodString;
         releaseId: z.ZodString;
         status: z.ZodEnum<{
-            stopped: "stopped";
-            deleted: "deleted";
             pending: "pending";
             queued: "queued";
             building: "building";
             deploying: "deploying";
             healthy: "healthy";
             failed: "failed";
+            stopped: "stopped";
             deleting: "deleting";
+            deleted: "deleted";
             delete_failed: "delete_failed";
         }>;
     }, z.core.$strict>;
@@ -349,8 +349,8 @@ export declare const PublishStreamSseEventSchema: z.ZodPipe<z.ZodDiscriminatedUn
 }, z.core.$strict>], "event">, z.ZodTransform<{
     name: string;
     type: "phase";
-    status?: "running" | "failed" | "completed";
-    data?: Record<string, unknown>;
+    status?: "failed" | "running" | "completed" | undefined;
+    data?: Record<string, unknown> | undefined;
 } | {
     stream: "runtime" | "build" | "publish";
     content: string;
@@ -361,14 +361,14 @@ export declare const PublishStreamSseEventSchema: z.ZodPipe<z.ZodDiscriminatedUn
     url: string;
     buildId: string;
     releaseId: string;
-    status: "stopped" | "deleted" | "pending" | "queued" | "building" | "deploying" | "healthy" | "failed" | "deleting" | "delete_failed";
+    status: "pending" | "queued" | "building" | "deploying" | "healthy" | "failed" | "stopped" | "deleting" | "deleted" | "delete_failed";
     type: "result";
 }, {
     event: "phase";
     data: {
         name: string;
-        status?: "running" | "failed" | "completed";
-        data?: Record<string, unknown>;
+        status?: "failed" | "running" | "completed" | undefined;
+        data?: Record<string, unknown> | undefined;
     };
 } | {
     event: "log";
@@ -384,7 +384,7 @@ export declare const PublishStreamSseEventSchema: z.ZodPipe<z.ZodDiscriminatedUn
         url: string;
         buildId: string;
         releaseId: string;
-        status: "stopped" | "deleted" | "pending" | "queued" | "building" | "deploying" | "healthy" | "failed" | "deleting" | "delete_failed";
+        status: "pending" | "queued" | "building" | "deploying" | "healthy" | "failed" | "stopped" | "deleting" | "deleted" | "delete_failed";
     };
 } | {
     event: "result";
@@ -394,13 +394,13 @@ export declare const PublishStreamSseEventSchema: z.ZodPipe<z.ZodDiscriminatedUn
         url: string;
         buildId: string;
         releaseId: string;
-        status: "stopped" | "deleted" | "pending" | "queued" | "building" | "deploying" | "healthy" | "failed" | "deleting" | "delete_failed";
+        status: "pending" | "queued" | "building" | "deploying" | "healthy" | "failed" | "stopped" | "deleting" | "deleted" | "delete_failed";
     };
 } | {
     event: "error";
     data: {
         [x: string]: unknown;
-        message?: string;
+        message?: string | undefined;
     };
 }>>;
 export type BuiltInPublicationProviderName = z.infer<typeof PublicationProviderNameSchema>;

package/dist/servers.d.ts

@@ -35,6 +35,9 @@ export declare class ServerInstance {
     readonly data: ServerData;
     private readonly client;
     constructor(data: ServerData, client: Client);
+    installation(): Promise<{
+        installCommand: string;
+    }>;
     refresh(): Promise<ServerInstance>;
     delete(): Promise<void>;
     waitReady(options?: {

package/dist/servers.js

@@ -20,6 +20,9 @@ export class ServerInstance {
         this.data = data;
         this.client = client;
     }
+    async installation() {
+        return (await this.client.get(`/servers/${encodeURIComponent(this.data.id)}/installation`)).data;
+    }
     refresh() {
         return this.client.servers.get(this.data.id);
     }

package/dist/socket/index.d.ts

@@ -31,12 +31,12 @@ export declare class ConnectionTimeoutError extends TransportError<'ConnectionTi
     constructor(message?: string);
 }
 export declare class ConnectionFailedError extends TransportError<'ConnectionFailed'> {
-    readonly originalError?: unknown;
-    constructor(message: string, originalError?: unknown);
+    readonly originalError?: unknown | undefined;
+    constructor(message: string, originalError?: unknown | undefined);
 }
 export declare class InvalidMessageError extends TransportError<'InvalidResponse'> {
-    readonly data?: unknown;
-    constructor(message: string, data?: unknown);
+    readonly data?: unknown | undefined;
+    constructor(message: string, data?: unknown | undefined);
 }
 export declare class InvalidConfigurationError extends Error {
     constructor(message: string);

package/dist/socket/index.js

@@ -67,7 +67,7 @@ export class Transport {
         this.validateConfiguration(options);
         this.url = typeof url === 'string' ? new URL(url) : null;
         const urlProvider = typeof url === 'string'
-            ? this.url.toString()
+            ? new URL(url).toString()
             : async () => new URL(await url()).toString();
         // Use configurable ping interval
         this.PING_INTERVAL = options.pingInterval ?? 30000;
@@ -313,7 +313,9 @@ export class Transport {
     }
     onDidBootError(listener) {
         return this.eventEmitter.listen('transport.boot_error', (event) => {
-            listener(event.error);
+            if (event && typeof event === 'object' && 'error' in event && RemoteError.is(event.error, 'NotebookUnavailable')) {
+                listener(event.error);
+            }
         });
     }
     removeListener(event, listener) {
@@ -323,7 +325,7 @@ export class Transport {
         return this.eventEmitter.once(event, listener, context);
     }
     emit(event, ...data) {
-        this.eventEmitter.emit(event, ...data);
+        this.eventEmitter.emit(event, data.length > 1 ? data : data[0]);
     }
     get isConnected() {
         return this.status === 'OPEN';

package/package.json

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

package/dist/publications.d.ts

@@ -1,192 +0,0 @@
-import type { Client } from './index.js';
-import type { PublicationBuildStatus, PublicationEventData, PublicationJurisdiction, PublicationLogChunkData, PublicationProtectionMode, PublicationRegion, PublicationReleaseStatus, PublicationSize, PublicationStatus, PublishStreamEvent, PublishStreamResult } from './schemas/publications.js';
-export type { BuiltInPublicationProviderName, PublicationBuildStatus, PublicationEventData, PublicationJurisdiction, PublicationLogChunkData, PublicationLogStream, PublicationProtectionMode, PublicationRegion, PublicationReleaseStatus, PublicationSize, PublicationStatus, PublishStreamEvent, PublishStreamLog, PublishStreamPhase, PublishStreamResult, PublishStreamSseEvent, } from './schemas/publications.js';
-export interface PublicationPlacement {
-    regions?: PublicationRegion[];
-    jurisdiction?: PublicationJurisdiction;
-}
-export type LaravelCloudRegion = 'us-east-2' | 'us-east-1' | 'ca-central-1' | 'eu-central-1' | 'eu-west-1' | 'eu-west-2' | 'me-central-1' | 'ap-southeast-1' | 'ap-southeast-2' | 'ap-northeast-1';
-export interface PublicationProtectionData {
-    mode: PublicationProtectionMode;
-    enabled: boolean;
-    token?: string;
-    expiresAt?: string;
-    url?: string;
-}
-export type PublicationProtectionInput = {
-    mode: 'none';
-    password?: never;
-} | {
-    mode: 'password';
-    password: string;
-};
-export interface CloudflareContainersProviderOptions {
-    accountId: string;
-    size?: PublicationSize;
-    sleepAfter?: string;
-    placement?: PublicationPlacement;
-    instances?: number;
-}
-export interface SshServerProviderOptions {
-    serverId: string;
-}
-export interface LaravelCloudProviderData {
-    region?: LaravelCloudRegion;
-    repository?: string;
-    branch?: string;
-    sourceControlProviderType?: 'github' | 'gitlab' | 'bitbucket';
-}
-export interface LaravelCloudProviderInput {
-    region: LaravelCloudRegion;
-}
-export interface PublicationProviderInputs {
-    'cloudflare-containers': CloudflareContainersProviderOptions;
-    'ssh-server': SshServerProviderOptions;
-    'laravel-cloud': LaravelCloudProviderInput;
-}
-export interface PublicationProviderData {
-    'cloudflare-containers': CloudflareContainersProviderOptions;
-    'ssh-server': SshServerProviderOptions;
-    'laravel-cloud': LaravelCloudProviderData;
-}
-export type PublicationProviderName = Extract<keyof PublicationProviderInputs, string>;
-export type PublicationProviderInput<TName extends PublicationProviderName = PublicationProviderName> = {
-    [Name in TName]: {
-        name: Name;
-    } & PublicationProviderInputs[Name];
-}[TName];
-export type PublicationProvider<TName extends PublicationProviderName = PublicationProviderName> = {
-    [Name in TName]: {
-        name: Name;
-    } & PublicationProviderData[Name];
-}[TName];
-export interface PublishInput<TName extends PublicationProviderName = PublicationProviderName> {
-    slug: string;
-    provider: PublicationProviderInput<TName>;
-    protection?: PublicationProtectionInput;
-    metadata?: Record<string, unknown>;
-}
-export interface PublicationBuildData<TProvider extends PublicationProviderName = PublicationProviderName> {
-    id: string;
-    status: PublicationBuildStatus;
-    strategy: string;
-    provider: PublicationProvider<TProvider>;
-    errorMessage: string | null;
-    startedAt: string | null;
-    finishedAt: string | null;
-}
-export interface PublicationReleaseData {
-    id: string;
-    status: PublicationReleaseStatus;
-    manifest: Record<string, unknown>;
-}
-export interface PublicationData<TProvider extends PublicationProviderName = PublicationProviderName> {
-    id: string;
-    slug: string;
-    url: string;
-    status: PublicationStatus;
-    strategy: string;
-    provider: PublicationProvider<TProvider>;
-    protection: PublicationProtectionData;
-    eventStreamUrl: string | null;
-    originUrl: string | null;
-    currentRelease?: PublicationReleaseData | null;
-    latestBuild?: PublicationBuildData<TProvider> | null;
-    deployedAt: string | null;
-    createdAt: string | null;
-    updatedAt: string | null;
-}
-export interface UpdatePublicationProtectionInput {
-    mode: PublicationProtectionMode;
-    password?: string;
-}
-export interface PublicationProtectionSessionData {
-    previewSessionId: string;
-    token: string;
-    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);
-    get<TProvider extends PublicationProviderName = PublicationProviderName>(id: string): Promise<PublicationInstance<TProvider>>;
-}
-export declare class PublicationRun<TProvider extends PublicationProviderName = PublicationProviderName> {
-    readonly initial: PublicationInstance<TProvider>;
-    private readonly client;
-    private readonly streamAbort;
-    private started;
-    private completed;
-    private finalError;
-    private finalResult;
-    private resultPromise;
-    private resolveResult;
-    private rejectResult;
-    private readonly bufferedEvents;
-    private readonly subscribers;
-    constructor(initial: PublicationInstance<TProvider>, client: Client);
-    events(): AsyncIterable<PublishStreamEvent>;
-    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;
-    private closeSubscribers;
-    private fail;
-}
-export declare class PublicationInstance<TProvider extends PublicationProviderName = PublicationProviderName> {
-    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>>;
-    destroy(): Promise<void>;
-    wait(options?: {
-        intervalMs?: number;
-        timeoutMs?: number;
-    }): Promise<PublicationInstance<TProvider>>;
-    events(): Promise<ReadableStream<PublicationEventData>>;
-    buildLogs(buildId?: string): Promise<ReadableStream<PublicationLogChunkData>>;
-    logs(): Promise<ReadableStream<PublicationLogChunkData>>;
-    setProtection(input: UpdatePublicationProtectionInput): Promise<PublicationInstance<TProvider>>;
-    protection(): Promise<PublicationProtectionData>;
-    createProtectionSession(): Promise<PublicationProtectionSessionData>;
-    disableProtection(): Promise<PublicationInstance<TProvider>>;
-}