@phpsandbox/sdk 0.1.20 → 0.2.1

package/dist/publication/types.d.ts

@@ -0,0 +1,425 @@
+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;
+    revision?: 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[];
+    buildModes?: Array<PublicationComponentBuild['mode']>;
+    componentKinds?: PublicationComponentKind[];
+    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 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[];
+    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;