@phpsandbox/sdk 0.1.9 → 0.1.11

package/dist/index.d.ts

@@ -1,45 +1,43 @@
 import { Filesystem, FilesystemActions, FilesystemEvents } from './filesystem.js';
 import Terminals, { TerminalEvents, TerminalActions, type SpawnOptions } from './terminal.js';
-import Container, { ContainerActions, ContainerEvents, PortInfo } from './container.js';
 import Auth, { AuthActions } from './auth.js';
 import Lsp, { LspActions, LspEvents } from './lsp.js';
 import Composer, { ComposerActions, ComposerEvents } from './composer.js';
-import Logs, { LogActions, LogEvents } from './log.js';
-import Metrics from './metrics.js';
-import Ports from './ports.js';
+import { LogEvents } from './log.js';
+import Runtime, { type PortInfo, type RuntimeActions, type RuntimeEvents } from './runtime.js';
 import Repl, { ReplActions, ReplEvents } from './repl.js';
 import { ShellEvents, ShellActions, type ProcessResult, type ShellProcess } from './shell.js';
 import Services, { ServiceActions, ServiceEvents } from './services.js';
 import Config, { ConfigActions } from './config.js';
-import { EventDispatcher } from './events/index.js';
-import Git, { GitActions, GitCredentials, GitEvents } from './git.js';
+import Git, { GitActions } from './git.js';
 import { Disposable } from './types.js';
-import { NotebookUnavailableError } from './errors/index.js';
-import { PublicationApi, NotebookPublicationApi, type PublicationInstance, type PublicationRun, type PublishInput } from './publications.js';
+import { RemoteError } from './errors/index.js';
+import { PublicationApi, PublicationInstance, PublicationRun, type PublishInput } from './publications.js';
 import { ServerApi } from './servers.js';
 import { Feedback } from './feedback.js';
 import { IntegrationApi } from './integrations.js';
 import { SandboxIntegrationApi } from './sandbox-integrations.js';
-export * from './types.js';
-export * from './lsp.js';
-export * from './filesystem.js';
-export * from './container.js';
-export * from './log.js';
-export * from './metrics.js';
-export * from './ports.js';
-export * from './runtime-telemetry.js';
-export * from './shell.js';
-export * from './terminal.js';
-export * from './git.js';
-export * from './services.js';
-export * from './config.js';
-export * from './utils/promise.js';
-export * from './errors/index.js';
-export * from './publications.js';
-export * from './servers.js';
-export * from './feedback.js';
-export * from './integrations.js';
-export * from './sandbox-integrations.js';
+export type { Disposable } from './types.js';
+export { LspConnection } from './lsp.js';
+export { FileChangeFilter, FileChangeType, FileType, } from './filesystem.js';
+export type { FileChange, FileContents, FileDeleteOptions, FileDownloadOptions, FileFollowOptions, FileLineRange, FileLineRangeResult, FileListOptions, FileOverwriteOptions, FileResult, FileSearchOptions, FileTailOptions, FileWriteOptions, Filesystem, Stats, TextSearchMatch, TextSearchOptions, TextSearchQuery, TextSearchResult, WatchOptions, } from './filesystem.js';
+export type { PortInfo } from './runtime.js';
+export type { RuntimeLogEntry } from './log.js';
+export type { RuntimeWatchOptions } from './runtime-telemetry.js';
+export type { RuntimeResourceUsage, RuntimeStats } from './runtime.js';
+export type { ProcessOutputChunk, ProcessOutputSource, ProcessResult, ShellProcess } from './shell.js';
+export type { SandboxProcess, SpawnOptions, Task, TerminalOptions } from './terminal.js';
+export type { GitChangedFile, GitCheckoutResult, GitConflict, GitConflictsResult, GitCredentials, GitDiffInput, GitDiffPreview, GitIndexInput, GitLog, GitMergeInput, GitMergeResult, GitProvider, GitRef, GitResolveInput, GitResolveResult, GitRevertInput, GitReview, GitReviewFile, GitReviewFileStatus, GitStatus, GitSyncAuthor, GitSyncDirection, GitSyncExistingTargetInput, GitTarget, GitTargetConfiguration, GitTargetData, GitTargetReference, } from './git.js';
+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 { 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';
+export type { Integration, IntegrationAuthorization, IntegrationAuthorizationType, IntegrationData, IntegrationProvider, IntegrationReference, LinkIntegrationInput, UpdateIntegrationInput, } from './integrations.js';
+export type { AttachSandboxIntegrationInput, SandboxIntegration, SandboxIntegrationData, SandboxIntegrationEffect, SandboxIntegrationReference, UpdateSandboxIntegrationInput, } from './sandbox-integrations.js';
 interface Result<TType extends 'success' | 'error' | 'running', TData extends object> {
     type: TType;
     message: string;
@@ -66,7 +64,7 @@ export interface NotebookInitProgress {
     chunk?: string;
     command?: string;
 }
-export type NotebookInitErrorCode = 'github_import_credential_missing' | 'notebook_disk_quota_exceeded' | 'notebook_not_found' | 'notebook_setup_json_invalid' | 'notebook_backup_restore_failed';
+export type NotebookInitErrorCode = 'GitHubImportCredentialMissing' | 'NotebookDiskQuotaExceeded' | 'NotebookNotFound' | 'NotebookSetupJsonInvalid' | 'NotebookBackupRestoreFailed';
 export interface NotebookInitErrorData {
     errorCode?: NotebookInitErrorCode;
     details?: string;
@@ -82,9 +80,6 @@ export interface NotebookInitErrorData {
 export type NotebookInitSuccessResult = Result<'success', NotebookInitResponse>;
 export type NotebookInitFailureResult = Result<'error', NotebookInitErrorData>;
 export type NotebookInitResult = NotebookInitSuccessResult | NotebookInitFailureResult;
-export interface NotebookActions {
-    'notebook.update': Action<null>;
-}
 export interface NotebookEvents {
     'lsp.response': object;
     'lsp.close': {
@@ -93,26 +88,19 @@ export interface NotebookEvents {
     };
     'init.event': NotebookInitProgress;
     'notebook.initialized': NotebookInitResult;
-    'okra.boot_error': NotebookUnavailableError;
+    'okra.boot_error': RemoteError<'NotebookUnavailable'>;
 }
 export interface CallOption {
     responseEvent?: string;
     timeout?: number;
     abortSignal?: AbortSignal;
 }
-export interface OkraError {
-    code: number;
-    message: string;
-}
 export interface Action<Args = object, Response = void> {
     args: Args;
     response: Response;
 }
-export type Events = TerminalEvents & ContainerEvents & LspEvents & ComposerEvents & LogEvents & ServiceEvents & NotebookEvents & ReplEvents & ShellEvents & FilesystemEvents & GitEvents;
-interface SystemActions {
-    ping: Action<object, 'pong'>;
-}
-export type Invokable = SystemActions & TerminalActions & ContainerActions & FilesystemActions & AuthActions & LspActions & ComposerActions & LogActions & ServiceActions & ConfigActions & NotebookActions & ReplActions & ShellActions & GitActions;
+export type Events = TerminalEvents & RuntimeEvents & LspEvents & ComposerEvents & LogEvents & ServiceEvents & NotebookEvents & ReplEvents & ShellEvents & FilesystemEvents;
+export type Invokable = TerminalActions & RuntimeActions & FilesystemActions & AuthActions & LspActions & ComposerActions & ServiceActions & ConfigActions & ReplActions & ShellActions & GitActions;
 export interface CreateNotebookImportAuthInput {
     accessToken: string;
 }
@@ -132,21 +120,6 @@ export interface CreateNotebookInput extends NotebookLifecycleInput {
     composerCredentials?: ComposerCredentialInput[];
 }
 export type ForkNotebookInput = NotebookLifecycleInput;
-export interface NetworkMatchCondition {
-    path?: string;
-    method?: string;
-}
-export interface NetworkTransformation {
-    match?: NetworkMatchCondition;
-    header?: Record<string, string>;
-}
-export type NetworkPolicyAllow = Record<string, NetworkTransformation[]>;
-export type NetworkPolicy = 'allow' | 'deny' | {
-    allow: NetworkPolicyAllow;
-};
-export interface UpdateNotebookInput extends Omit<CreateNotebookInput, 'persistent'> {
-    network?: NetworkPolicy | null;
-}
 export interface NotebookPolicyData {
     autoDeleteWhenStale: boolean;
     staleAfterMinutes: number | null;
@@ -278,56 +251,32 @@ export interface PaginatedApiResponse<TData> {
 export interface NotebookMailListOptions {
     page?: number;
 }
-export declare class NotebookInitError extends Error {
-    readonly message: string;
-    readonly data: NotebookInitErrorData;
-    constructor(message: string, data?: NotebookInitErrorData);
-}
-export declare class ApiError extends Error {
-    readonly response: Response;
-    readonly body: string;
-    readonly status: number;
-    readonly data: unknown;
-    readonly apiMessage?: string;
-    constructor(response: Response, body: string);
-}
-export declare class NotebookApi {
+declare class NotebookApi {
     private readonly client;
-    readonly secrets: NotebookSecretApi;
-    readonly composerCredentials: NotebookComposerCredentialApi;
-    readonly preview: NotebookPreviewApi;
-    readonly mail: NotebookMailApi;
-    readonly publication: NotebookPublicationApi;
     constructor(client: Client);
-    create(template: string, input?: Partial<CreateNotebookInput>, init?: boolean): Promise<NotebookInstance>;
+    create(template: string, input?: Partial<CreateNotebookInput>): Promise<NotebookInstance>;
     get(id: string): Promise<NotebookInstance>;
-    update(id: string, input?: Partial<UpdateNotebookInput>): Promise<NotebookInstance>;
-    destroy(id: string): Promise<void>;
-    fork(id: string, input?: Partial<ForkNotebookInput>): Promise<NotebookInstance>;
-    gitCredentials(id: string): Promise<GitCredentials>;
-    openFromData(data: NotebookData): Promise<NotebookInstance>;
-    private init;
+    open(data: NotebookData): NotebookInstance;
 }
 export interface PHPSandboxClientOptions {
     debug?: boolean;
-    startClosed?: boolean;
     fetch?: typeof globalThis.fetch;
     webSocket?: unknown;
     runtimeUrlProvider?: (notebookId: string) => Promise<string>;
 }
 export type RuntimeTransport = 'realtime' | 'rest';
-export declare class Client {
+declare class ClientImplementation {
     readonly notebook: NotebookApi;
     readonly publications: PublicationApi;
     readonly servers: ServerApi;
     readonly integrations: IntegrationApi;
     readonly options: PHPSandboxClientOptions;
-    protected runtimeTransportValue: RuntimeTransport;
+    private readonly runtimeTransportValue;
     get runtimeTransport(): RuntimeTransport;
     private readonly fetch;
     private readonly baseUrl;
     private readonly headers;
-    constructor(token: string, url?: string, options?: PHPSandboxClientOptions);
+    constructor(token: string, url?: string, options?: PHPSandboxClientOptions, runtimeTransport?: RuntimeTransport);
     get<T extends unknown>(path: string): Promise<{
         data: T;
     }>;
@@ -346,45 +295,20 @@ export declare class Client {
     stream(path: string): Promise<ReadableStream<Uint8Array>>;
     sse(url: string): Promise<ReadableStream<Uint8Array>>;
     private makeRequest;
+    private fetchResponse;
 }
-export declare class PHPSandbox extends Client {
+export type Client = ClientImplementation;
+export declare class PHPSandbox {
+    private readonly client;
+    readonly notebook: NotebookApi;
+    readonly publications: PublicationApi;
+    readonly servers: ServerApi;
+    readonly integrations: IntegrationApi;
+    private constructor();
+    get runtimeTransport(): RuntimeTransport;
     static realtime(token: string, url?: string, options?: PHPSandboxClientOptions): PHPSandbox;
     static rest(token: string, url?: string, options?: PHPSandboxClientOptions): PHPSandbox;
 }
-export declare class NotebookSecretApi {
-    private readonly client;
-    constructor(client: Client);
-    list(id: string, options?: NotebookSecretListOptions): Promise<NotebookSecretData[]>;
-    set(id: string, name: string, input: string | UpsertNotebookSecretInput): Promise<NotebookSecretData>;
-    setMany(id: string, input: UpsertNotebookSecretsInput): Promise<NotebookSecretData[]>;
-    delete(id: string, name: string, options?: NotebookSecretDeleteOptions): Promise<void>;
-}
-export declare class NotebookComposerCredentialApi {
-    private readonly client;
-    constructor(client: Client);
-    set(id: string, input: ComposerCredentialInput): Promise<ComposerCredentialInfo>;
-    remove(id: string, type: ComposerCredentialType, url?: string): Promise<void>;
-}
-export declare class NotebookPreviewApi {
-    private readonly client;
-    constructor(client: Client);
-    get(id: string): Promise<NotebookPreviewData>;
-    get(id: string, url: string): Promise<NotebookPreviewDataWithUrl>;
-    setPassword(id: string, input: SetNotebookPreviewInput): Promise<NotebookPreviewData>;
-    disable(id: string): Promise<void>;
-    createSession(id: string, input: CreateNotebookPreviewSessionInput): Promise<NotebookPreviewSessionData>;
-    createHandoff(id: string, input: CreateNotebookPreviewHandoffInput): Promise<NotebookPreviewHandoffData>;
-}
-export declare class NotebookMailApi {
-    private readonly client;
-    constructor(client: Client);
-    status(id: string): Promise<NotebookMailStateData>;
-    enable(id: string): Promise<NotebookMailStateData>;
-    disable(id: string): Promise<void>;
-    list(id: string, options?: NotebookMailListOptions): Promise<PaginatedApiResponse<NotebookMailData>>;
-    get(id: string, hash: string): Promise<NotebookMailData>;
-    delete(id: string, hash: string): Promise<void>;
-}
 export interface NotebookData {
     id: string;
     runtimeUrl: string;
@@ -404,11 +328,8 @@ export declare class NotebookInstance {
     readonly auth: Auth;
     readonly lsp: Lsp;
     readonly composer: Composer;
-    readonly logs: Logs;
-    readonly metrics: Metrics;
-    readonly ports: Ports;
+    readonly runtime: Runtime;
     readonly repl: Repl;
-    readonly container: Container;
     private readonly shell;
     readonly git: Git;
     readonly services: Services;
@@ -420,7 +341,7 @@ export declare class NotebookInstance {
     readonly feedback: Feedback;
     private readonly socket;
     private readonly restInvoker;
-    readonly emitter: EventDispatcher;
+    private readonly emitter;
     initialized: NotebookInitResult | false;
     get runtimeTransport(): RuntimeTransport;
     private readonly disposables;
@@ -428,35 +349,31 @@ export declare class NotebookInstance {
     ready(): Promise<NotebookInitSuccessResult>;
     fork(input?: Partial<ForkNotebookInput>): Promise<NotebookInstance>;
     publication(): Promise<PublicationInstance | null>;
-    publish(input: PublishInput): Promise<PublicationRun>;
+    publish(input?: PublishInput): Promise<PublicationRun>;
     run(command: string | string[], opts?: SpawnOptions): ShellProcess;
     run(command: string, args: string[], opts?: SpawnOptions): ShellProcess;
     exec(command: string | string[], opts?: SpawnOptions): Promise<ProcessResult>;
     exec(command: string, args: string[], opts?: SpawnOptions): Promise<ProcessResult>;
-    gitCredentials(): Promise<GitCredentials>;
     destroy(): Promise<void>;
-    stop(): Promise<void>;
     restart(): Promise<void>;
+    stop(): Promise<void>;
     invoke<T extends keyof Invokable>(action: T, data?: Invokable[T]['args'], options?: CallOption): Promise<Invokable[T]['response']>;
     send<T extends keyof Invokable>(action: T, data?: Invokable[T]['args']): boolean;
-    ping(): Promise<"pong">;
     listen<T extends keyof Events>(event: T, handler: (data: Events[T]) => void): Disposable;
     listen(event: string, handler: (data: unknown) => void): Disposable;
     dispose(): void;
     connected(): Promise<NotebookInstance>;
-    whenConnected(): Promise<NotebookInstance>;
     private waitForSocketConnection;
     private watchConnection;
     onDidConnect(handler: () => void): Disposable;
     onDidDisconnect(handler: () => void): Disposable;
-    onDidBootError(handler: (error: NotebookUnavailableError) => void): Disposable;
+    onDidBootError(handler: (error: RemoteError<'NotebookUnavailable'>) => void): Disposable;
     private restInitialization;
-    update(input: Partial<UpdateNotebookInput>): Promise<NotebookInstance>;
     onDidInitialize(handler: (result: NotebookInitResult) => void): Disposable;
     reconnect(): Promise<NotebookInstance>;
     private realtimeSocket;
 }
-export declare class NotebookSecrets {
+declare class NotebookSecrets {
     private readonly client;
     private readonly notebookId;
     constructor(client: Client, notebookId: string);
@@ -465,14 +382,7 @@ export declare class NotebookSecrets {
     setMany(input: UpsertNotebookSecretsInput): Promise<NotebookSecretData[]>;
     delete(name: string, options?: NotebookSecretDeleteOptions): Promise<void>;
 }
-export declare class ComposerCredentials {
-    private readonly client;
-    private readonly notebookId;
-    constructor(client: Client, notebookId: string);
-    set(input: ComposerCredentialInput): Promise<ComposerCredentialInfo>;
-    remove(type: ComposerCredentialType, url?: string): Promise<void>;
-}
-export declare class NotebookPreview {
+declare class NotebookPreview {
     private readonly client;
     private readonly notebookId;
     constructor(client: Client, notebookId: string);
@@ -483,7 +393,7 @@ export declare class NotebookPreview {
     createSession(input: CreateNotebookPreviewSessionInput): Promise<NotebookPreviewSessionData>;
     createHandoff(input: CreateNotebookPreviewHandoffInput): Promise<NotebookPreviewHandoffData>;
 }
-export declare class NotebookMail {
+declare class NotebookMail {
     private readonly client;
     private readonly notebookId;
     constructor(client: Client, notebookId: string);