@phpsandbox/sdk 0.0.56 → 0.0.58

package/dist/deployments.d.ts

@@ -1,138 +1,175 @@
-import type { Client, PaginatedApiResponse } from './index.js';
-export type DeploymentStrategy = 'auto' | 'laravel' | 'phpsandbox' | 'compose' | 'custom';
-export type DeploymentTargetProvider = 'okra' | 'cloudflare-containers';
-export type DeploymentRuntimeProvider = 'docker' | 'compose' | 'cloudflare-container';
-export type DeploymentStatus = 'pending' | 'queued' | 'building' | 'deploying' | 'healthy' | 'failed' | 'stopped' | 'deleting' | 'deleted' | 'delete_failed';
-export type DeploymentSize = 'nano' | 'small' | 'medium' | 'large' | 'lite' | 'basic' | 'standard-1' | 'standard-2';
+import { type Client, type SecretRef } from './index.js';
+import type { DeploymentBuildStatus, DeploymentDomainDnsRecordType, DeploymentEventData, DeploymentJurisdiction, DeploymentLogChunkData, DeploymentProtectionMode, DeploymentRegion, DeploymentReleaseStatus, DeploymentSize, DeploymentStatus, DeploymentTargetProvider, DeployStreamEvent, DeployStreamResult } from './schemas/deployments.js';
+export * from './schemas/deployments.js';
 export interface DeploymentPlacement {
-    regions?: Array<'ENAM' | 'WNAM' | 'EEUR' | 'WEUR' | 'APAC' | 'SAM' | 'ME' | 'OC' | 'AFR' | string>;
-    jurisdiction?: 'eu' | 'fedramp' | string;
-}
-export interface DeployInput {
-    name?: string;
-    slug?: string;
-    strategy?: DeploymentStrategy;
-    target_provider?: DeploymentTargetProvider;
-    runtime_provider?: DeploymentRuntimeProvider;
+    regions?: DeploymentRegion[];
+    jurisdiction?: DeploymentJurisdiction;
+}
+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 DeploymentProtectionData {
+    mode: DeploymentProtectionMode;
+    enabled: boolean;
+    token?: string;
+    expiresAt?: string;
+    url?: string;
+}
+export interface DeploymentFeedbackData {
+    enabled: boolean;
+    config: Record<string, unknown>;
+}
+export type DeploymentProtectionInput = {
+    mode: 'none';
+    password?: never;
+} | {
+    mode: 'password';
+    password: string;
+};
+export interface DeploymentFeedbackInput {
+    enabled: boolean;
+    config?: Record<string, unknown>;
+}
+export interface OkraCloudflareContainerBuildOptions {
     size?: DeploymentSize;
-    sleep_after?: string;
+    sleepAfter?: string;
     placement?: DeploymentPlacement;
     instances?: number;
-    source_ref?: string;
-    password?: string;
-    feedback_enabled?: boolean;
-    metadata?: Record<string, unknown>;
 }
+export interface OkraCloudflareContainerDeploymentOptions extends OkraCloudflareContainerBuildOptions {
+    protection: DeploymentProtectionData;
+    feedback: DeploymentFeedbackData;
+}
+export interface OkraCloudflareContainerPublishOptions extends OkraCloudflareContainerBuildOptions {
+    protection?: DeploymentProtectionInput;
+    feedback?: DeploymentFeedbackInput;
+}
+export interface OkraSshAgentBuildOptions {
+    serverId: string;
+}
+export interface OkraSshAgentDeploymentOptions extends OkraSshAgentBuildOptions {
+    protection: DeploymentProtectionData;
+    feedback: DeploymentFeedbackData;
+}
+export interface OkraSshAgentPublishOptions extends OkraSshAgentBuildOptions {
+    protection?: DeploymentProtectionInput;
+    feedback?: DeploymentFeedbackInput;
+}
+export interface OkraLaravelCloudBuildOptions {
+    region?: LaravelCloudRegion;
+    repository?: string;
+    branch?: string;
+    sourceControlProviderType?: 'github' | 'gitlab' | 'bitbucket';
+    apiKeyConfigured?: boolean;
+}
+export interface OkraLaravelCloudDeploymentOptions extends OkraLaravelCloudBuildOptions {
+    protection: DeploymentProtectionData;
+    feedback: DeploymentFeedbackData;
+}
+export interface OkraLaravelCloudPublishOptions {
+    apiKey: SecretRef;
+    region?: LaravelCloudRegion;
+    protection?: DeploymentProtectionInput;
+    feedback?: DeploymentFeedbackInput;
+}
+export interface DeploymentProviderOptions {
+    okraCloudflareContainer: OkraCloudflareContainerDeploymentOptions;
+    okraSshAgent: OkraSshAgentDeploymentOptions;
+    okraLaravelCloud: OkraLaravelCloudDeploymentOptions;
+}
+export interface DeploymentProviderBuildOptions {
+    okraCloudflareContainer: OkraCloudflareContainerBuildOptions;
+    okraSshAgent: OkraSshAgentBuildOptions;
+    okraLaravelCloud: OkraLaravelCloudBuildOptions;
+}
+export type DeploymentOptionsForProvider<TProvider extends DeploymentTargetProvider> = DeploymentProviderOptions[TProvider];
+export type DeploymentBuildOptionsForProvider<TProvider extends DeploymentTargetProvider> = DeploymentProviderBuildOptions[TProvider];
+export interface OkraCloudflareContainerPublishInput {
+    targetProvider: 'okraCloudflareContainer';
+    options?: OkraCloudflareContainerPublishOptions;
+}
+export interface OkraSshAgentPublishInput {
+    targetProvider: 'okraSshAgent';
+    options: OkraSshAgentPublishOptions;
+}
+export interface OkraLaravelCloudPublishInput {
+    targetProvider: 'okraLaravelCloud';
+    options: OkraLaravelCloudPublishOptions;
+}
+export type ProviderPublishInput = OkraCloudflareContainerPublishInput | OkraSshAgentPublishInput | OkraLaravelCloudPublishInput;
+export type FirstPublishInput = ProviderPublishInput & {
+    slug: string;
+};
+export type PublishInput = FirstPublishInput;
 export interface DeploymentSlugAvailabilityData {
     slug: string;
     available: boolean;
     domain: string;
 }
-export interface DeploymentBuildData {
+export interface DeploymentBuildData<TProvider extends DeploymentTargetProvider = DeploymentTargetProvider> {
     id: string;
-    status: string;
-    source_ref: string | null;
-    strategy: DeploymentStrategy | string;
-    target_provider: DeploymentTargetProvider | string;
-    runtime_provider: DeploymentRuntimeProvider | string | null;
-    size: DeploymentSize | string;
-    artifact_path: string | null;
-    artifact_checksum: string | null;
-    error_message: string | null;
-    started_at: string | null;
-    finished_at: string | null;
+    status: DeploymentBuildStatus;
+    strategy: string;
+    targetProvider: TProvider;
+    options: DeploymentBuildOptionsForProvider<TProvider>;
+    errorMessage: string | null;
+    startedAt: string | null;
+    finishedAt: string | null;
 }
 export interface DeploymentReleaseData {
     id: string;
-    status: string;
-    artifact_path: string;
-    artifact_checksum: string;
+    status: DeploymentReleaseStatus;
     manifest: Record<string, unknown>;
 }
 export interface DeploymentDomainDnsData {
-    type: 'CNAME' | 'ALIAS' | 'ANAME' | string;
+    type: DeploymentDomainDnsRecordType;
     name: string;
     value: string;
 }
 export interface DeploymentDomainData {
     id: string;
-    deployment_id: string;
+    deploymentId: string | null;
     hostname: string;
     status: string;
     provider: string;
-    provider_hostname_id: string | null;
+    providerHostnameId: string | null;
     dns: DeploymentDomainDnsData;
     ssl: {
         status: string | null;
     };
-    validation_errors: unknown[];
-    validation_records: unknown[];
+    validationErrors: unknown[];
+    validationRecords: unknown[];
     metadata: Record<string, unknown>;
-    verified_at: string | null;
-    created_at: string | null;
-    updated_at: string | null;
+    verifiedAt: string | null;
+    createdAt: string | null;
+    updatedAt: string | null;
 }
 export interface CreateDeploymentDomainInput {
     hostname: string;
 }
-export interface DeploymentData {
+export interface DeploymentData<TProvider extends DeploymentTargetProvider = DeploymentTargetProvider> {
     id: string;
-    notebook_id: string;
-    name: string;
     slug: string;
     url: string;
-    status: DeploymentStatus | string;
-    strategy: DeploymentStrategy | string;
-    target_provider: DeploymentTargetProvider | string;
-    runtime_provider: DeploymentRuntimeProvider | string | null;
-    size: DeploymentSize | string;
-    sleep_after: string;
-    placement: DeploymentPlacement | null;
-    instances: number;
-    origin_url: string | null;
-    protection: {
-        mode: 'none' | 'password' | string;
-        enabled: boolean;
-    };
-    feedback: {
-        enabled: boolean;
-        config: Record<string, unknown>;
-    };
-    current_release?: DeploymentReleaseData | null;
+    status: DeploymentStatus;
+    strategy: string;
+    targetProvider: TProvider;
+    options: DeploymentOptionsForProvider<TProvider>;
+    okraUrl: string | null;
+    originUrl: string | null;
+    currentRelease?: DeploymentReleaseData | null;
     domains?: DeploymentDomainData[];
-    latest_build?: DeploymentBuildData | null;
-    deployed_at: string | null;
-    created_at: string | null;
-    updated_at: string | null;
-}
-export interface DeploymentEventData {
-    id?: number | string;
-    sequence: number;
-    type: string;
-    payload: Record<string, unknown>;
-    created_at: string | null;
-}
-export interface DeploymentLogChunkData {
-    sequence: number;
-    stream: 'build' | 'runtime' | string;
-    content: string;
-    created_at: string | null;
+    latestBuild?: DeploymentBuildData<TProvider> | null;
+    deployedAt: string | null;
+    createdAt: string | null;
+    updatedAt: string | null;
 }
 export interface UpdateDeploymentProtectionInput {
-    mode: 'none' | 'password';
+    mode: DeploymentProtectionMode;
     password?: string;
 }
-export interface DeploymentProtectionData {
-    mode: 'none' | 'password' | string;
-    enabled: boolean;
-    token?: string;
-    expires_at?: string;
-    url?: string;
-}
 export interface DeploymentProtectionSessionData {
-    preview_session_id: string;
+    previewSessionId: string;
     token: string;
-    expires_at: string;
+    expiresAt: string;
     url: string;
 }
 export interface UpdateDeploymentFeedbackInput {
@@ -142,21 +179,20 @@ export interface UpdateDeploymentFeedbackInput {
 export declare class NotebookDeploymentApi {
     private readonly client;
     constructor(client: Client);
-    create(id: string, input?: DeployInput): Promise<DeploymentInstance>;
-    list(id: string): Promise<PaginatedApiResponse<DeploymentData>>;
+    current<TProvider extends DeploymentTargetProvider = DeploymentTargetProvider>(notebookId: string): Promise<DeploymentInstance<TProvider> | null>;
+    publish<TProvider extends DeploymentTargetProvider = DeploymentTargetProvider>(notebookId: string, input?: PublishInput): Promise<DeploymentRun<TProvider>>;
     slugAvailability(id: string, slug: string): Promise<DeploymentSlugAvailabilityData>;
 }
 export declare class DeploymentApi {
     private readonly client;
     constructor(client: Client);
-    get(id: string): Promise<DeploymentInstance>;
-    redeploy(id: string, input?: DeployInput): Promise<DeploymentInstance>;
+    get<TProvider extends DeploymentTargetProvider = DeploymentTargetProvider>(id: string): Promise<DeploymentInstance<TProvider>>;
     delete(id: string): Promise<void>;
-    setProtection(id: string, input: UpdateDeploymentProtectionInput): Promise<DeploymentInstance>;
+    setProtection<TProvider extends DeploymentTargetProvider = DeploymentTargetProvider>(id: string, input: UpdateDeploymentProtectionInput): Promise<DeploymentInstance<TProvider>>;
     protection(id: string): Promise<DeploymentProtectionData>;
     createProtectionSession(id: string): Promise<DeploymentProtectionSessionData>;
-    disableProtection(id: string): Promise<DeploymentInstance>;
-    setFeedback(id: string, input: UpdateDeploymentFeedbackInput): Promise<DeploymentInstance>;
+    disableProtection<TProvider extends DeploymentTargetProvider = DeploymentTargetProvider>(id: string): Promise<DeploymentInstance<TProvider>>;
+    setFeedback<TProvider extends DeploymentTargetProvider = DeploymentTargetProvider>(id: string, input: UpdateDeploymentFeedbackInput): Promise<DeploymentInstance<TProvider>>;
     listDomains(id: string): Promise<DeploymentDomainData[]>;
     createDomain(id: string, input: CreateDeploymentDomainInput): Promise<DeploymentDomainData>;
     refreshDomain(id: string, domainId: string): Promise<DeploymentDomainData>;
@@ -165,25 +201,49 @@ export declare class DeploymentApi {
     buildLogs(id: string, buildId: string): Promise<ReadableStream<DeploymentLogChunkData>>;
     logs(id: string): Promise<ReadableStream<DeploymentLogChunkData>>;
 }
-export declare class DeploymentInstance {
-    readonly data: DeploymentData;
+export declare class DeploymentRun<TProvider extends DeploymentTargetProvider = DeploymentTargetProvider> {
+    readonly initial: DeploymentInstance<TProvider>;
+    private readonly client;
+    private started;
+    private completed;
+    private finalError;
+    private finalResult;
+    private resultPromise;
+    private resolveResult;
+    private rejectResult;
+    private readonly bufferedEvents;
+    private readonly subscribers;
+    constructor(initial: DeploymentInstance<TProvider>, client: Client);
+    events(): AsyncIterable<DeployStreamEvent>;
+    result(): Promise<DeployStreamResult>;
+    deployment(): Promise<DeploymentInstance<TProvider>>;
+    start(): this;
+    private subscribe;
+    private consumeStream;
+    private publish;
+    private closeSubscribers;
+    private fail;
+}
+export declare class DeploymentInstance<TProvider extends DeploymentTargetProvider = DeploymentTargetProvider> {
+    readonly data: DeploymentData<TProvider>;
     private readonly client;
-    constructor(data: DeploymentData, client: Client);
-    refresh(): Promise<DeploymentInstance>;
-    redeploy(input?: DeployInput): Promise<DeploymentInstance>;
+    private readonly notebookId?;
+    constructor(data: DeploymentData<TProvider>, client: Client, notebookId?: string);
+    refresh(): Promise<DeploymentInstance<TProvider>>;
+    publish(): Promise<DeploymentRun<TProvider>>;
     delete(): Promise<void>;
     wait(options?: {
         intervalMs?: number;
         timeoutMs?: number;
-    }): Promise<DeploymentInstance>;
+    }): Promise<DeploymentInstance<TProvider>>;
     events(): Promise<ReadableStream<DeploymentEventData>>;
     buildLogs(buildId?: string): Promise<ReadableStream<DeploymentLogChunkData>>;
     logs(): Promise<ReadableStream<DeploymentLogChunkData>>;
-    setProtection(input: UpdateDeploymentProtectionInput): Promise<DeploymentInstance>;
+    setProtection(input: UpdateDeploymentProtectionInput): Promise<DeploymentInstance<TProvider>>;
     protection(): Promise<DeploymentProtectionData>;
     createProtectionSession(): Promise<DeploymentProtectionSessionData>;
-    disableProtection(): Promise<DeploymentInstance>;
-    setFeedback(input: UpdateDeploymentFeedbackInput): Promise<DeploymentInstance>;
+    disableProtection(): Promise<DeploymentInstance<TProvider>>;
+    setFeedback(input: UpdateDeploymentFeedbackInput): Promise<DeploymentInstance<TProvider>>;
     domains(): Promise<DeploymentDomainData[]>;
     addDomain(input: CreateDeploymentDomainInput): Promise<DeploymentDomainData>;
     refreshDomain(domainId: string): Promise<DeploymentDomainData>;