@phpsandbox/sdk 0.2.0 → 0.2.1

package/dist/publication/notebook.d.ts

@@ -2,7 +2,7 @@ import type { Client } from '../index.js';
 import { PublicationInstance } from './instance.js';
 import { PublicationRun } from './run.js';
 import { PublicationResources } from './resources.js';
-import type { PlannedPublishInput, PublicationPlan, PublicationPlanInput, PublicationProviderName, PublicationReadiness, PublicationResourceCatalog } from './types.js';
+import type { PlannedPublishInput, PublicationApplicationPlan, PublicationApplicationPlanInput, PublicationApplicationData, PublicationPlan, PublicationPlanInput, PublicationProviderName, PublicationReadiness, PublicationResourceCatalog } from './types.js';
 export declare class NotebookPublication {
     private readonly notebookId;
     private readonly client;
@@ -13,6 +13,17 @@ export declare class NotebookPublication {
     readiness(): Promise<PublicationReadiness>;
     /** Review a publishing plan without committing changes or creating resources. */
     prepare<TName extends PublicationProviderName>(input: PublicationPlanInput<TName>): Promise<PublicationPlan<TName>>;
+    /** Review a multi-component publishing plan without creating resources or starting releases. */
+    prepareApplication(input: PublicationApplicationPlanInput): Promise<PublicationApplicationPlan>;
+    /** Publish every component in a reviewed application plan. */
+    publishApplication(input: PublicationApplicationPlanInput): Promise<PublicationApplicationData>;
+    application(applicationId: string): Promise<PublicationApplicationData>;
+    /** Retry only failed components while leaving healthy components untouched. */
+    retryApplication(applicationId: string): Promise<PublicationApplicationData>;
+    destroyApplication(applicationId: string, options?: {
+        deleteResources?: boolean;
+    }): Promise<void>;
+    private startApplicationRuns;
     catalog(provider: 'laravel-cloud' | 'cloudflare-containers'): Promise<PublicationResourceCatalog>;
     catalog(provider: 'ssh-server', serverId: string): Promise<PublicationResourceCatalog>;
     /** Core validates the plan, prepares source and executes publishing. */

package/dist/publication/notebook.js

@@ -30,6 +30,36 @@ export class NotebookPublication {
     async prepare(input) {
         return (await this.client.post(`${this.path}/publication/plan`, input)).data;
     }
+    /** Review a multi-component publishing plan without creating resources or starting releases. */
+    async prepareApplication(input) {
+        return (await this.client.post(`${this.path}/publication/application-plan`, input)).data;
+    }
+    /** Publish every component in a reviewed application plan. */
+    async publishApplication(input) {
+        const application = (await this.client.post(`${this.path}/publication/application`, input)).data;
+        this.startApplicationRuns(application);
+        return application;
+    }
+    async application(applicationId) {
+        return (await this.client.get(`${this.path}/publication/application/${encodeURIComponent(applicationId)}`)).data;
+    }
+    /** Retry only failed components while leaving healthy components untouched. */
+    async retryApplication(applicationId) {
+        const application = (await this.client.post(`${this.path}/publication/application/${encodeURIComponent(applicationId)}/retry`, {})).data;
+        this.startApplicationRuns(application);
+        return application;
+    }
+    async destroyApplication(applicationId, options = {}) {
+        const query = options.deleteResources ? '?deleteResources=1' : '';
+        await this.client.delete(`${this.path}/publication/application/${encodeURIComponent(applicationId)}${query}`);
+    }
+    startApplicationRuns(application) {
+        for (const component of application.components) {
+            if (!['pending', 'queued', 'building', 'deploying'].includes(component.publication.status))
+                continue;
+            new PublicationRun(new PublicationInstance(component.publication, this.client, this.notebookId), this.client).start();
+        }
+    }
     async catalog(provider, serverId) {
         const query = new URLSearchParams({ provider });
         if (serverId !== undefined) {

package/dist/publication/types.d.ts

@@ -46,6 +46,7 @@ export interface PublicationRequirement {
 export interface PublicationReadiness {
     repository: string | null;
     branch: string | null;
+    revision?: string | null;
     sourceProvider: string | null;
     requirements: PublicationRequirement[];
     productionVariables: string[];
@@ -81,6 +82,8 @@ export interface PublicationAccessCapabilities {
 export interface PublicationCapabilities {
     source: 'git' | 'workspace';
     sourceProviders?: string[];
+    buildModes?: Array<PublicationComponentBuild['mode']>;
+    componentKinds?: PublicationComponentKind[];
     resourceCleanup?: boolean;
     resources: Record<PublicationResourceKind, PublicationResourceMode[]>;
     access: {
@@ -164,6 +167,125 @@ export interface PublicationPlan<TName extends PublicationProviderName = Publica
         message: string;
     };
 }
+export type PublicationComponentKind = 'frontend' | 'http-service' | 'static-site' | 'worker' | 'scheduler';
+export type PublicationDockerfile = {
+    source: 'generated';
+    content: string;
+    digest?: string;
+} | {
+    source: 'project';
+    path: string;
+    digest?: string;
+};
+export type PublicationComponentBuild = {
+    mode: 'provider-native';
+    workingDirectory?: string;
+    context?: string;
+    installCommand?: string;
+    buildCommand?: string;
+    deployCommand?: string;
+    outputDirectory?: string;
+} | {
+    mode: 'dockerfile';
+    workingDirectory?: string;
+    context?: string;
+    dockerfile: PublicationDockerfile;
+    target?: string;
+    arguments?: Record<string, string>;
+    secrets?: string[];
+} | {
+    mode: 'image';
+    reference: string;
+};
+export interface PublicationComponentRuntime {
+    kind?: 'http' | 'static' | 'process';
+    command?: string[];
+    port?: number;
+    healthCheck?: {
+        path: string;
+    };
+}
+export type PublicationComponentPlacement<TName extends PublicationProviderName = PublicationProviderName> = {
+    [Name in TName]: {
+        provider: Name;
+    } & Partial<PublicationProviderInputs[Name]>;
+}[TName];
+export interface PublicationApplicationComponentInput<TName extends PublicationProviderName = PublicationProviderName> {
+    id: string;
+    kind: PublicationComponentKind;
+    root: string;
+    build: PublicationComponentBuild;
+    sourceDependencies?: string[];
+    runtime?: PublicationComponentRuntime;
+    resources?: string[];
+    placement: PublicationComponentPlacement<TName>;
+}
+export interface PublicationApplicationResourceInput {
+    id: string;
+    kind: PublicationResourceKind;
+    mode: PublicationResourceMode;
+    engine?: string;
+    provider?: PublicationProviderName;
+    selection?: Omit<PublicationResourceSelection, 'mode'>;
+}
+export interface PublicationApplicationRouteInput {
+    hostname: string;
+    component: string;
+}
+export interface PublicationPlanAssumption {
+    id: string;
+    statement: string;
+    basis?: string;
+    confidence?: 'low' | 'medium' | 'high';
+    requiresConfirmation?: boolean;
+}
+export interface PublicationApplicationPlanInput {
+    schemaVersion: 1;
+    slug?: string;
+    source?: {
+        repository?: string;
+        revision?: string;
+        root?: string;
+    };
+    components: PublicationApplicationComponentInput[];
+    resources?: PublicationApplicationResourceInput[];
+    routes?: PublicationApplicationRouteInput[];
+    assumptions?: PublicationPlanAssumption[];
+}
+export interface PublicationApplicationComponentPlan extends PublicationApplicationComponentInput {
+    sourceDependencies: string[];
+    resources: string[];
+    providerPlan: PublicationPlan;
+}
+export interface PublicationApplicationPlan {
+    schemaVersion: 1;
+    source: {
+        repository: string | null;
+        revision: string | null;
+        root: string;
+    };
+    components: PublicationApplicationComponentPlan[];
+    resources: PublicationApplicationResourceInput[];
+    routes: PublicationApplicationRouteInput[];
+    assumptions: PublicationPlanAssumption[];
+    blockers: Array<{
+        code: string;
+        message: string;
+        component?: string;
+        resource?: string;
+    }>;
+    ready: boolean;
+    input: PublicationApplicationPlanInput;
+}
+export interface PublicationApplicationComponentData {
+    componentId: string;
+    publication: PublicationData;
+}
+export interface PublicationApplicationData {
+    id: string;
+    status: 'publishing' | 'healthy' | 'failed' | 'deleted';
+    components: PublicationApplicationComponentData[];
+}
 export interface PublicationDnsInstructions {
     stage: 'ownership' | 'traffic' | 'connected';
     records: PublicationDnsRecord[];

package/package.json

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