@phpsandbox/sdk 0.1.19 → 0.2.0

package/dist/publication/types.d.ts

@@ -0,0 +1,303 @@
+import type { LaravelCloudSetupState, LaravelCloudProviderData, LaravelCloudProviderInput } from './providers/laravel-cloud.js';
+export type * from './providers/laravel-cloud.js';
+import type { PublicationBuildStatus, PublicationJurisdiction, PublicationProtectionMode, PublicationRegion, PublicationReleaseStatus, PublicationSize, PublicationStatus } from '../schemas/publications.js';
+export interface PublicationDestroyOptions {
+    deleteResources?: boolean;
+}
+export interface PublicationPlacement {
+    regions?: PublicationRegion[];
+    jurisdiction?: PublicationJurisdiction;
+}
+export interface PublicationProtectionData {
+    mode: PublicationProtectionMode;
+    enabled: boolean;
+    supported?: boolean;
+    token?: string;
+    expiresAt?: string;
+    url?: string;
+}
+export type PublicationProtectionInput = {
+    mode: 'none';
+    password?: never;
+} | {
+    mode: 'password';
+    password: string;
+};
+export interface CloudflareContainersProviderOptions {
+    resources?: Partial<Record<PublicationResourceKind, PublicationResourceSelection>>;
+    accountId: string;
+    size?: PublicationSize;
+    sleepAfter?: string;
+    placement?: PublicationPlacement;
+    instances?: number;
+}
+export interface SshServerProviderOptions {
+    serverId: string;
+    resources?: Partial<Record<PublicationResourceKind, PublicationResourceSelection>>;
+}
+export type PublicationResourceKind = 'database' | 'cache' | 'storage' | 'worker' | 'scheduler';
+export interface PublicationRequirement {
+    kind: PublicationResourceKind;
+    required?: boolean;
+    recommended?: boolean;
+    engine?: string;
+    reason?: string;
+}
+export interface PublicationReadiness {
+    repository: string | null;
+    branch: string | null;
+    sourceProvider: string | null;
+    requirements: PublicationRequirement[];
+    productionVariables: string[];
+    missingVariables: string[];
+    warnings: string[];
+}
+export type PublicationResourceMode = 'none' | 'create' | 'reuse' | 'external' | 'enable';
+export interface PublicationResourceSelection {
+    mode: PublicationResourceMode;
+    id?: string;
+    type?: string;
+    version?: string;
+    size?: string;
+    config?: Record<string, string | number | boolean | null>;
+}
+export type PublicationPlanProviderInput<TName extends PublicationProviderName = PublicationProviderName> = {
+    [Name in TName]: {
+        name: Name;
+    } & Partial<PublicationProviderInputs[Name]>;
+}[TName];
+export interface PublicationPlanInput<TName extends PublicationProviderName = PublicationProviderName> {
+    slug?: string;
+    provider: PublicationPlanProviderInput<TName>;
+    requirements?: PublicationRequirement[];
+    resources?: Partial<Record<PublicationResourceKind, PublicationResourceSelection>>;
+}
+export type PlannedPublishInput = PublishInput & Pick<PublicationPlanInput, 'requirements' | 'resources'>;
+export interface PublicationAccessCapabilities {
+    routing: 'platform' | 'provider';
+    protection: boolean;
+    feedback: boolean;
+}
+export interface PublicationCapabilities {
+    source: 'git' | 'workspace';
+    sourceProviders?: string[];
+    resourceCleanup?: boolean;
+    resources: Record<PublicationResourceKind, PublicationResourceMode[]>;
+    access: {
+        managed: PublicationAccessCapabilities;
+        custom: PublicationAccessCapabilities;
+    };
+}
+export interface PublicationCatalogConfigField {
+    name: string;
+    type: string;
+    required: boolean;
+    label?: string;
+    nullable?: boolean;
+    description?: string;
+    min?: number;
+    max?: number;
+    enum?: Array<string | number>;
+    example?: string | number;
+}
+export interface PublicationCatalogResourceType {
+    kind: PublicationResourceKind;
+    type: string;
+    label: string;
+    versions: string[];
+    regions: string[];
+    sizes: {
+        id: string;
+        label: string;
+    }[];
+    configFields: PublicationCatalogConfigField[];
+}
+export interface PublicationResourceCatalog {
+    provider: PublicationProviderName;
+    scope: string | null;
+    capabilities: PublicationCapabilities;
+    regions: {
+        id: string;
+        label: string;
+        flag?: string;
+    }[];
+    resourceTypes: PublicationCatalogResourceType[];
+    resources: {
+        id: string;
+        name: string;
+        kind: PublicationResourceKind;
+        type: string | null;
+        version: string | null;
+        region: string | null;
+        status: string;
+    }[];
+    pricingUrl: string | null;
+}
+export interface PublicationPlan<TName extends PublicationProviderName = PublicationProviderName> {
+    provider: TName;
+    capabilities: PublicationCapabilities;
+    readiness: PublicationReadiness;
+    source: {
+        type: 'git' | 'workspace';
+        repository: string | null;
+        branch: string | null;
+        commitAndPush: boolean;
+        providerAccess: 'verified' | 'confirmed' | 'confirmation_required' | 'not_required';
+    };
+    resources: Array<{
+        kind: PublicationResourceKind;
+        mode: PublicationResourceMode | 'unconfigured';
+        engine: string | null;
+        required: boolean;
+        recommended: boolean;
+        supported: boolean;
+        selection: PublicationResourceSelection | boolean | null;
+    }>;
+    blockers: Array<{
+        code: string;
+        message: string;
+    }>;
+    ready: boolean;
+    input: PublicationPlanInput<TName>;
+    cost: {
+        status: 'unknown';
+        message: string;
+    };
+}
+export interface PublicationDnsInstructions {
+    stage: 'ownership' | 'traffic' | 'connected';
+    records: PublicationDnsRecord[];
+    trafficRecords: PublicationDnsRecord[];
+}
+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> {
+    capabilities?: PublicationCapabilities;
+    id: string;
+    slug: string;
+    url: string;
+    status: PublicationStatus;
+    strategy: string;
+    provider: PublicationProvider<TProvider>;
+    protection: PublicationProtectionData;
+    eventStreamUrl: string | null;
+    originUrl: string | null;
+    domains?: PublicationDomainData[];
+    setupState?: LaravelCloudSetupState | 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 PublicationDnsRecord {
+    type: string;
+    name: string;
+    value: string;
+    purpose?: 'ownership' | 'certificate' | 'traffic';
+}
+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;
+    };
+    dnsInstructions: PublicationDnsInstructions;
+    validationErrors: unknown[];
+    validationRecords: unknown[];
+    metadata: Record<string, unknown>;
+    verifiedAt: string | null;
+    createdAt: string | null;
+    updatedAt: string | null;
+}
+export interface PublicationManagedResource {
+    id: string;
+    parentId: string | null;
+    provider: PublicationProviderName;
+    scope: string;
+    providerId: string;
+    kind: 'database' | 'cache' | 'storage';
+    name: string;
+    type: string | null;
+    version: string | null;
+    managed: boolean;
+    status: 'pending' | 'provisioning' | 'available' | 'unknown' | 'retained' | 'deleting' | 'delete_failed' | 'deleted';
+    observation?: {
+        status: 'present' | 'missing' | 'unreachable' | 'unauthorized' | 'unsupported';
+        message: string;
+        checkedAt: string;
+    } | null;
+    attachments: PublicationResourceAttachment[];
+    attachmentCount: number;
+    createdAt: string;
+}
+export interface PublicationResourceListOptions {
+    provider?: PublicationProviderName;
+    kind?: PublicationManagedResource['kind'];
+    type?: string;
+    scope?: string;
+    page?: number;
+}
+export interface PublicationResourceAttachment {
+    notebookId: string | null;
+    publicationId: string | null;
+    detachedAt: string | null;
+}

package/dist/publication/types.js

@@ -0,0 +1 @@
+export {};

package/dist/runtime/rest.d.ts

@@ -7,7 +7,7 @@ export declare class RestRuntimeInvoker {
     private ticket;
     private refreshPromise;
     private readonly notebookId;
-    constructor(data: NotebookData, fetch: typeof globalThis.fetch, refresh?: () => Promise<string>);
+    constructor(data: NotebookData, fetch: typeof globalThis.fetch, refresh?: (() => Promise<string>) | undefined);
     private configure;
     ready(): Promise<NotebookInitSuccessResult>;
     supports(action: string): action is RestRuntimeAction;

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