@ninedeploy/sdk 0.2.0

package/dist/index.d.ts

@@ -0,0 +1,928 @@
+import type { ActiveSession, ActivityEntry, AlertRule, CreateAlertRuleInput, ApiToken, PasskeyCredential, Attachment, Backup, BackupWithDb, CreateApiToken, CreateDatabaseInput, CreateDomainInput, CreateProjectInput, CreateServiceInput, CreateSourceInput, CreateTunnelInput, CreateWebhookInput, CreatedApiToken, CreatedWebhook, ConfigItem, ConfigListResponse, SetConfigInput, PluginListResponse, PluginInspectResponse, InstallPluginInput, MarketplaceCatalogResponse, MenuListResponse, DemoSeedResult, Deployment, DockerResources, Domain, DomainPatch, DomainEntry, EnvVar, Login, ManagedDatabase, DatabaseDetail, DatabaseCredentials, PasswordChange, PasswordReset, MetricSeries, ProjectEntry, ProjectPatchInput, PublicUser, Refresh, Register, Service, Session, SetLimitsInput, Source, StatsSnapshot, Template, TemplateSummary, TopologyGraph, TraefikCertificate, TraefikInfo, TraefikStatus, TunnelEntry, UserCreate, VolumeFileEntry, VolumeFileWriteInput, VolumePathCreateInput, TriggerDeploy, UpdateCheckResult, UpdateServiceInput, UpsertEnvVarInput, VolumeEntry, Webhook, LogDrain, LogDrainCreateInput, LogDrainUpdateInput, LogDrainTestResult, AutoPruneConfigUpdateInput, AutoPruneStatus, AutoPruneRunResult, ServerSshTest, ServerSshTestResult, ServerSshBootstrap, ServerBootstrapResult, WorkspaceEntry, WorkspaceDetail, WorkspaceCreateInput, WorkspaceUpdateInput, WorkspaceMemberEntry, WorkspaceMemberAddInput, WorkspaceMemberRoleUpdateInput, OidcPublicProvider, OidcProviderEntry, OidcProviderCreateInput, OidcProviderUpdateInput } from '@ninedeploy/schemas';
+import { NineDeployError } from './errors.js';
+export { NineDeployError };
+export type * from '@ninedeploy/schemas';
+/**
+ * Minimal structural fetch type so the SDK is isomorphic (browser + Node)
+ * without pulling in DOM lib types. Both `globalThis.fetch` implementations
+ * satisfy this shape.
+ */
+export type FetchLike = (input: string, init: {
+    method?: string;
+    headers?: Record<string, string>;
+    body?: string;
+}) => Promise<{
+    ok: boolean;
+    status: number;
+    text(): Promise<string>;
+}>;
+export interface HealthStatus {
+    status: string;
+    db?: string;
+    version?: string;
+    time?: string;
+}
+export interface NineDeployClientOptions {
+    /** Base URL of the NineDeploy API, e.g. http://localhost:3000. */
+    baseUrl: string;
+    /** Returns the current access token (or bearer credential). */
+    getToken?: () => string | undefined | null;
+    /** Custom fetch implementation (defaults to globalThis.fetch). */
+    fetch?: FetchLike;
+}
+export interface NineDeployClient {
+    auth: {
+        status: () => Promise<{
+            initialized: boolean;
+        }>;
+        setup: (input: Register) => Promise<Session>;
+        register: (input: Register) => Promise<Session>;
+        login: (input: Login) => Promise<Session>;
+        refresh: (input: Refresh) => Promise<Session>;
+        logout: () => Promise<{
+            ok: boolean;
+        }>;
+        /** Self-service password change; revokes other sessions, returns a fresh token pair. */
+        changePassword: (input: PasswordChange) => Promise<Session>;
+        /** Request a reset link (always 200 — no user enumeration). */
+        forgotPassword: (email: string) => Promise<{
+            ok: boolean;
+        }>;
+        /** Complete a reset with a single-use token; revokes all sessions. */
+        resetPasswordWithToken: (input: {
+            token: string;
+            newPassword: string;
+        }) => Promise<{
+            ok: boolean;
+        }>;
+        twoFactor: {
+            /** Generate a pending secret + otpauth URI (auth required). */
+            setup: (input?: {
+                password: string;
+            }) => Promise<{
+                secret: string;
+                otpauthUri: string;
+            }>;
+            enable: (code: string) => Promise<{
+                ok: boolean;
+                totpEnabled: boolean;
+            }>;
+            disable: (input: {
+                password: string;
+                code: string;
+            }) => Promise<{
+                ok: boolean;
+                totpEnabled: boolean;
+            }>;
+        };
+        me: () => Promise<PublicUser>;
+        tokens: {
+            create: (input?: CreateApiToken) => Promise<CreatedApiToken>;
+            list: () => Promise<ApiToken[]>;
+            remove: (id: number) => Promise<void>;
+        };
+        passkeys: {
+            /** Start a registration ceremony (returns JSON options for the browser API). */
+            registerOptions: () => Promise<{
+                options: string;
+            }>;
+            /** Complete registration: verify the browser response, store the credential. */
+            registerVerify: (input: {
+                name: string;
+                response: unknown;
+            }) => Promise<PasskeyCredential>;
+            list: () => Promise<PasskeyCredential[]>;
+            remove: (id: number) => Promise<void>;
+            /** Start a passwordless login ceremony (discoverable credentials). */
+            loginOptions: () => Promise<{
+                options: string;
+            }>;
+            /** Complete passkey login — returns a full session on success. */
+            loginVerify: (response: unknown) => Promise<Session>;
+        };
+        sessions: {
+            list: () => Promise<ActiveSession[]>;
+            revoke: (id: number) => Promise<{
+                ok: boolean;
+            }>;
+        };
+        oidc: {
+            publicProviders: () => Promise<OidcPublicProvider[]>;
+            listProviders: () => Promise<OidcProviderEntry[]>;
+            list: () => Promise<OidcProviderEntry[]>;
+            createProvider: (input: OidcProviderCreateInput) => Promise<OidcProviderEntry>;
+            create: (input: OidcProviderCreateInput) => Promise<OidcProviderEntry>;
+            updateProvider: (id: number, input: OidcProviderUpdateInput) => Promise<OidcProviderEntry>;
+            update: (id: number, input: OidcProviderUpdateInput) => Promise<OidcProviderEntry>;
+            deleteProvider: (id: number) => Promise<{
+                ok: boolean;
+            }>;
+            delete: (id: number) => Promise<{
+                ok: boolean;
+            }>;
+            callback: (slug: string, payload: {
+                code: string;
+                state: string;
+            }) => Promise<Session>;
+        };
+    };
+    workspaces: {
+        list: () => Promise<WorkspaceEntry[]>;
+        get: (id: number) => Promise<WorkspaceDetail>;
+        create: (input: WorkspaceCreateInput) => Promise<WorkspaceEntry>;
+        update: (id: number, input: WorkspaceUpdateInput) => Promise<WorkspaceEntry>;
+        delete: (id: number) => Promise<{
+            ok: boolean;
+        }>;
+        addMember: (id: number, input: WorkspaceMemberAddInput) => Promise<WorkspaceMemberEntry>;
+        updateMemberRole: (id: number, memberId: number, input: WorkspaceMemberRoleUpdateInput) => Promise<WorkspaceMemberEntry>;
+        removeMember: (id: number, memberId: number) => Promise<{
+            ok: boolean;
+        }>;
+    };
+    services: {
+        /** `query` is appended verbatim, e.g. `?projectId=3` (project scoping). */
+        list: (query?: string) => Promise<Service[]>;
+        get: (id: number) => Promise<Service>;
+        create: (input: CreateServiceInput) => Promise<Service>;
+        update: (id: number, input: UpdateServiceInput) => Promise<Service>;
+        remove: (id: number) => Promise<void>;
+        stop: (id: number) => Promise<{
+            ok: boolean;
+            status: string;
+        }>;
+        start: (id: number) => Promise<{
+            ok: boolean;
+            status: string;
+        }>;
+        restart: (id: number) => Promise<{
+            ok: boolean;
+            status: string;
+        }>;
+        logs: (id: number) => Promise<{
+            lines: string;
+        }>;
+        clone: (id: number, input?: {
+            name?: string;
+            slug?: string;
+        }) => Promise<Service>;
+        exportUrl: (id: number) => string;
+        importBundle: (bundle: unknown) => Promise<{
+            ok: boolean;
+            serviceId: number;
+            slug: string;
+            message: string;
+        }>;
+    };
+    deploys: {
+        trigger: (serviceId: number, input?: TriggerDeploy) => Promise<{
+            deploymentId: number;
+        }>;
+        list: (serviceId: number) => Promise<Deployment[]>;
+        rollback: (serviceId: number, deploymentId: number) => Promise<{
+            deploymentId: number;
+        }>;
+        /** Cancel a queued/in-flight deployment (checkpoints abort at step boundaries). */
+        cancel: (serviceId: number, deploymentId: number) => Promise<{
+            ok: boolean;
+            status: string;
+        }>;
+        /** Build-config + env-key diff against the previous deployment. */
+        configDiff: (serviceId: number, deploymentId: number) => Promise<{
+            deploymentId: number;
+            previousDeploymentId: number | null;
+            changed: boolean;
+            diff: string;
+        }>;
+    };
+    domains: {
+        list: (serviceId: number) => Promise<Domain[]>;
+        create: (serviceId: number, input: CreateDomainInput) => Promise<Domain>;
+        remove: (serviceId: number, domainId: number) => Promise<void>;
+        /** Update routing extras: ssl toggle, www→apex redirect, custom headers, basicAuth, ipAllowlist, rateLimit. */
+        update: (serviceId: number, domainId: number, input: DomainPatch) => Promise<Domain>;
+        all: () => Promise<DomainEntry[]>;
+        setSsl: (domainId: number, ssl: boolean) => Promise<{
+            id: number;
+            ssl: boolean;
+        }>;
+    };
+    volumes: {
+        list: () => Promise<VolumeEntry[]>;
+        remove: (name: string) => Promise<void>;
+        prune: () => Promise<{
+            ok: boolean;
+            deleted: number;
+            freedBytes: number;
+        }>;
+        /** File manager: list a directory inside the volume. */
+        listFiles: (name: string, path?: string) => Promise<{
+            path: string;
+            entries: VolumeFileEntry[];
+        }>;
+        /** File manager: read a file (base64 content). */
+        readFile: (name: string, path: string) => Promise<{
+            content: string;
+            encoding: 'utf8' | 'base64';
+        }>;
+        /** File manager: write/overwrite a file (base64 content). */
+        writeFile: (name: string, input: VolumeFileWriteInput) => Promise<{
+            ok: boolean;
+        }>;
+        /** File manager: create a directory. */
+        mkdir: (name: string, input: VolumePathCreateInput) => Promise<{
+            ok: boolean;
+        }>;
+        /** File manager: delete a file or directory (recursive). */
+        deleteFile: (name: string, path: string) => Promise<void>;
+    };
+    containers: {
+        inspect: (container: string) => Promise<ContainerInspectData>;
+        compose: (container: string) => Promise<ContainerComposeData>;
+        /** File manager: list a directory inside the container. */
+        listFiles: (container: string, path?: string) => Promise<{
+            path: string;
+            entries: VolumeFileEntry[];
+        }>;
+        /** File manager: read a file (base64 content). */
+        readFile: (container: string, path: string) => Promise<{
+            content: string;
+            encoding: 'utf8' | 'base64';
+        }>;
+        /** File manager: write/overwrite a file (base64 content). */
+        writeFile: (container: string, input: VolumeFileWriteInput) => Promise<{
+            ok: boolean;
+        }>;
+        /** File manager: create a directory. */
+        mkdir: (container: string, input: VolumePathCreateInput) => Promise<{
+            ok: boolean;
+        }>;
+        makeDir: (container: string, input: VolumePathCreateInput) => Promise<{
+            ok: boolean;
+        }>;
+        /** File manager: delete a file or directory (recursive). */
+        deleteFile: (container: string, path: string) => Promise<void>;
+        deletePath: (container: string, path: string) => Promise<void>;
+    };
+    system: {
+        resources: () => Promise<DockerResources>;
+        pruneImages: () => Promise<{
+            ok: boolean;
+        }>;
+        exportUrl: () => string;
+        /** Latest-release check (admin). updateAvailable is null when offline/disabled. */
+        updateCheck: (force?: boolean) => Promise<UpdateCheckResult>;
+        /** Recent docker daemon events (single-shot, for the Docker dashboard feed). */
+        dockerEvents: (minutes?: number) => Promise<{
+            events: Array<{
+                time: string;
+                type: string;
+                action: string;
+                name: string;
+            }>;
+        }>;
+    };
+    networks: {
+        list: () => Promise<{
+            networks: Array<{
+                name: string;
+                driver: string;
+                members: string[];
+            }>;
+            remote: number | null;
+        }>;
+        create: (input: {
+            name: string;
+            driver?: 'bridge' | 'overlay';
+            serverId?: number | null;
+        }) => Promise<{
+            ok: boolean;
+            name: string;
+        }>;
+        remove: (name: string, serverId?: number) => Promise<{
+            ok: boolean;
+        }>;
+        attach: (input: {
+            network: string;
+            container: string;
+            serverId?: number | null;
+        }) => Promise<{
+            ok: boolean;
+        }>;
+        detach: (input: {
+            network: string;
+            container: string;
+            serverId?: number | null;
+        }) => Promise<{
+            ok: boolean;
+        }>;
+    };
+    tunnels: {
+        list: () => Promise<TunnelEntry[]>;
+        create: (input: CreateTunnelInput) => Promise<TunnelEntry>;
+        remove: (id: number) => Promise<void>;
+    };
+    activity: {
+        /** Filter + paginate the audit trail. Omitted filters return the newest page. */
+        list: (query?: {
+            entity?: string;
+            action?: string;
+            userId?: number;
+            before?: number;
+        }) => Promise<{
+            entries: ActivityEntry[];
+            nextCursor: number | null;
+        }>;
+    };
+    alerts: {
+        list: () => Promise<AlertRule[]>;
+        create: (input: CreateAlertRuleInput) => Promise<AlertRule>;
+        update: (id: number, input: Partial<CreateAlertRuleInput>) => Promise<AlertRule>;
+        remove: (id: number) => Promise<void>;
+    };
+    settings: {
+        get: () => Promise<{
+            allowRegistration: boolean;
+            acmeEmail: string | null;
+            templatesSource: string | null;
+            dnsProvider: string | null;
+            hasDnsToken: boolean;
+            wildcardApex: string | null;
+        }>;
+        setAllowRegistration: (enabled: boolean) => Promise<{
+            ok: boolean;
+            allowRegistration: boolean;
+        }>;
+        setAcmeEmail: (email: string) => Promise<{
+            ok: boolean;
+            acmeEmail: string | null;
+            applied: string;
+        }>;
+        setTemplatesSource: (source: string) => Promise<{
+            ok: boolean;
+            templatesSource: string | null;
+        }>;
+        /** Configure the ACME DNS-01 challenge (wildcard certificates). */
+        setDns: (input: {
+            provider: string;
+            token?: string;
+            wildcardApex: string;
+        }) => Promise<{
+            ok: boolean;
+            dnsProvider: string | null;
+            wildcardApex: string | null;
+            applied: string;
+        }>;
+        /** Vault provider (deploy-time secret resolution). */
+        vault: {
+            get: () => Promise<{
+                provider: string | null;
+                hasToken: boolean;
+                projectId: string | null;
+                environment: string | null;
+            }>;
+            set: (input: {
+                provider: '' | 'infisical' | 'doppler';
+                token?: string;
+                projectId?: string;
+                environment?: string;
+            }) => Promise<{
+                ok: boolean;
+                provider: string | null;
+            }>;
+            test: () => Promise<{
+                ok: boolean;
+                secrets: number;
+            }>;
+        };
+        /** Cloudflare DNS-record auto-provisioning for added domains. */
+        dnsRecords: {
+            get: () => Promise<{
+                enabled: boolean;
+                hasToken: boolean;
+                content: string | null;
+            }>;
+            set: (input: {
+                enabled: boolean;
+                token?: string;
+                content?: string;
+            }) => Promise<{
+                ok: boolean;
+                enabled: boolean;
+            }>;
+            test: () => Promise<{
+                ok: boolean;
+                status?: string;
+                error?: string;
+            }>;
+        };
+    };
+    users: {
+        list: () => Promise<PublicUser[]>;
+        /** Admin-only: create a user directly (no registration flow needed). */
+        create: (input: UserCreate) => Promise<PublicUser>;
+        setRole: (id: number, role: 'admin' | 'member') => Promise<PublicUser>;
+        remove: (id: number) => Promise<void>;
+        /** Admin reset of another user's password (revokes their sessions). */
+        resetPassword: (id: number, input: PasswordReset) => Promise<{
+            ok: boolean;
+        }>;
+        /** Mint a one-time reset link for a user (returned exactly once). */
+        resetLink: (id: number) => Promise<{
+            url: string;
+            expiresAt: string;
+        }>;
+    };
+    projects: {
+        list: () => Promise<ProjectEntry[]>;
+        create: (input: CreateProjectInput) => Promise<ProjectEntry>;
+        update: (id: number, input: ProjectPatchInput) => Promise<ProjectEntry>;
+        remove: (id: number) => Promise<{
+            ok: boolean;
+        }>;
+    };
+    about: {
+        get: () => Promise<{
+            name: string;
+            version: string;
+            description: string;
+            license: string;
+            repo: string;
+            docs: string;
+            techStack: Array<{
+                category: string;
+                items: string[];
+            }>;
+            changelog: Array<{
+                version: string;
+                date: string;
+                title: string;
+                changes: string[];
+            }>;
+            /** Instance counts are only returned for authenticated requests. */
+            stats?: {
+                services: number;
+                databases: number;
+                deployments: number;
+                users: number;
+            };
+        }>;
+    };
+    notifications: {
+        listChannels: () => Promise<Array<{
+            id: number;
+            name: string;
+            type: string;
+            eventFilter: string;
+            active: boolean;
+            createdAt: string;
+        }>>;
+        createChannel: (input: {
+            name: string;
+            type: string;
+            target: string;
+            eventFilter?: string;
+        }) => Promise<{
+            id: number;
+            name: string;
+            type: string;
+        }>;
+        updateChannel: (id: number, input: {
+            name?: string;
+            target?: string;
+            eventFilter?: string;
+            active?: boolean;
+        }) => Promise<{
+            id: number;
+            active: boolean;
+        }>;
+        removeChannel: (id: number) => Promise<void>;
+        testChannel: (id: number) => Promise<{
+            ok: boolean;
+        }>;
+        log: () => Promise<Array<{
+            id: number;
+            channelId: number | null;
+            event: string;
+            entity: string | null;
+            status: string;
+            error: string | null;
+            ts: string;
+        }>>;
+    };
+    sources: {
+        list: () => Promise<Source[]>;
+        create: (input: CreateSourceInput) => Promise<Source>;
+        update: (id: number, input: Partial<CreateSourceInput>) => Promise<Source>;
+        remove: (id: number) => Promise<void>;
+        repos: (id: number) => Promise<Array<{
+            name: string;
+            fullName: string;
+            url: string;
+            defaultBranch: string;
+            isPrivate: boolean;
+        }>>;
+        branches: (id: number, repo: string) => Promise<string[]>;
+    };
+    webhooks: {
+        list: (serviceId: number) => Promise<Webhook[]>;
+        create: (serviceId: number, input?: CreateWebhookInput) => Promise<CreatedWebhook>;
+        remove: (serviceId: number, hookId: number) => Promise<void>;
+    };
+    databases: {
+        /** `query` is appended verbatim, e.g. `?projectId=3` (project scoping). */
+        list: (query?: string) => Promise<ManagedDatabase[]>;
+        create: (input: CreateDatabaseInput) => Promise<ManagedDatabase>;
+        get: (id: number) => Promise<DatabaseDetail>;
+        remove: (id: number, options?: {
+            force?: boolean;
+        }) => Promise<void>;
+        restart: (id: number) => Promise<void>;
+        stop: (id: number) => Promise<void>;
+        start: (id: number) => Promise<void>;
+        logs: (id: number, lines?: number) => Promise<{
+            logs: string[];
+        }>;
+        credentials: (id: number) => Promise<DatabaseCredentials>;
+        setLimits: (id: number, input: SetLimitsInput) => Promise<{
+            cpuShares: number | null;
+            memLimitMb: number | null;
+        }>;
+        startStudio: (id: number, port?: number) => Promise<{
+            ok: boolean;
+            port: number;
+            url: string;
+        }>;
+        stopStudio: (id: number) => Promise<{
+            ok: boolean;
+        }>;
+    };
+    attachments: {
+        list: (serviceId: number) => Promise<Attachment[]>;
+        create: (serviceId: number, input: {
+            databaseId: number;
+            envAlias?: string;
+        }) => Promise<Attachment>;
+        remove: (serviceId: number, attachmentId: number) => Promise<void>;
+    };
+    env: {
+        list: (serviceId: number) => Promise<EnvVar[]>;
+        create: (serviceId: number, input: UpsertEnvVarInput) => Promise<EnvVar>;
+        update: (serviceId: number, varId: number, input: UpsertEnvVarInput) => Promise<EnvVar>;
+        remove: (serviceId: number, varId: number) => Promise<void>;
+        /** Cross-scope key search: where a given env key is defined. */
+        search: (q: string) => Promise<{
+            results: Array<{
+                key: string;
+                isSecret: boolean;
+                scope: string;
+                serviceId: number | null;
+                serviceName: string | null;
+            }>;
+        }>;
+    };
+    projectEnv: {
+        /** Shared env vars applied to every service in a project (service env wins). */
+        list: (projectId: number) => Promise<EnvVar[]>;
+        create: (projectId: number, input: UpsertEnvVarInput) => Promise<EnvVar>;
+        update: (projectId: number, varId: number, input: UpsertEnvVarInput) => Promise<EnvVar>;
+        remove: (projectId: number, varId: number) => Promise<void>;
+    };
+    stats: {
+        snapshot: () => Promise<StatsSnapshot>;
+        metrics: (serviceId: number, opts?: {
+            kind?: 'cpu' | 'memory';
+            minutes?: number;
+        }) => Promise<MetricSeries>;
+    };
+    dashboard: {
+        get: () => Promise<{
+            stats: {
+                services: number;
+                databases: number;
+                deployments: number;
+                domains: number;
+                webhooks: number;
+                running: number;
+                stopped: number;
+                errored: number;
+                dbRunning: number;
+                containers: number;
+            };
+            health: Array<{
+                serviceId: number;
+                name: string;
+                slug: string;
+                type: string;
+                status: string;
+                healthy: boolean;
+                responseMs: number | null;
+                port: number | null;
+                runtimeId: string | null;
+                commitSha: string | null;
+                lastDeploy: string | null;
+            }>;
+            recentDeploys: Array<{
+                id: number;
+                serviceId: number;
+                serviceName: string;
+                status: string;
+                commitSha: string | null;
+                message: string | null;
+                trigger: string;
+                finishedAt: string | null;
+                createdAt: string;
+            }>;
+        }>;
+    };
+    topology: {
+        get: () => Promise<TopologyGraph>;
+    };
+    backups: {
+        storage: (databaseId: number) => Promise<{
+            sizeBytes: number;
+        }>;
+        backupNow: (databaseId: number) => Promise<Backup>;
+        listForDb: (databaseId: number) => Promise<Backup[]>;
+        restore: (databaseId: number, backupId: number) => Promise<{
+            ok: boolean;
+        }>;
+        list: () => Promise<BackupWithDb[]>;
+        remove: (backupId: number) => Promise<void>;
+        downloadUrl: (backupId: number) => string;
+    };
+    backupDestinations: {
+        list: () => Promise<Array<{
+            id: number;
+            name: string;
+            endpoint: string;
+            region: string;
+            bucket: string;
+            prefix: string;
+            active: boolean;
+            createdAt: string;
+        }>>;
+        create: (input: {
+            name: string;
+            endpoint: string;
+            region?: string;
+            bucket: string;
+            prefix?: string;
+            accessKeyId: string;
+            secretAccessKey: string;
+        }) => Promise<{
+            id: number;
+        }>;
+        update: (id: number, input: Partial<{
+            name: string;
+            endpoint: string;
+            region: string;
+            bucket: string;
+            prefix: string;
+            active: boolean;
+            accessKeyId: string;
+            secretAccessKey: string;
+        }>) => Promise<{
+            ok: boolean;
+        }>;
+        remove: (id: number) => Promise<{
+            ok: boolean;
+        }>;
+        test: (id: number) => Promise<{
+            ok: boolean;
+        }>;
+    };
+    jobs: {
+        list: (serviceId: number) => Promise<Array<{
+            id: number;
+            name: string;
+            cron: string;
+            kind: 'deploy' | 'exec';
+            command: string;
+            enabled: boolean;
+            lastRunAt: string | null;
+        }>>;
+        create: (serviceId: number, input: {
+            name: string;
+            cron: string;
+            kind: 'deploy' | 'exec';
+            command?: string;
+            enabled?: boolean;
+        }) => Promise<{
+            id: number;
+        }>;
+        update: (serviceId: number, jobId: number, input: Partial<{
+            name: string;
+            cron: string;
+            kind: 'deploy' | 'exec';
+            command: string;
+            enabled: boolean;
+        }>) => Promise<{
+            ok: boolean;
+        }>;
+        remove: (serviceId: number, jobId: number) => Promise<{
+            ok: boolean;
+        }>;
+        run: (serviceId: number, jobId: number) => Promise<{
+            ok: boolean;
+        }>;
+        runs: (serviceId: number, jobId: number) => Promise<Array<{
+            id: number;
+            status: string;
+            output: string;
+            exitCode: number | null;
+            createdAt: string;
+        }>>;
+    };
+    servers: {
+        list: () => Promise<Array<{
+            id: number;
+            name: string;
+            host: string;
+            port: number;
+            status: string;
+            lastSeenAt: string | null;
+        }>>;
+        /** Register a server — the agent token + its sha256 are returned exactly once. */
+        create: (input: {
+            name: string;
+            host: string;
+            port?: number;
+        }) => Promise<{
+            id: number;
+            token: string;
+            tokenSha256: string;
+            agentCommand: string;
+        }>;
+        remove: (id: number, options?: {
+            force?: boolean;
+        }) => Promise<{
+            ok: boolean;
+        }>;
+        test: (id: number) => Promise<{
+            ok: boolean;
+            status: string;
+        }>;
+        approve: (id: number) => Promise<{
+            ok: boolean;
+            status: string;
+        }>;
+        reject: (id: number) => Promise<{
+            ok: boolean;
+        }>;
+        sshTest: (input: ServerSshTest) => Promise<ServerSshTestResult>;
+        sshBootstrap: (input: ServerSshBootstrap) => Promise<ServerBootstrapResult>;
+        bootstrapLogs: (id: number) => Promise<{
+            logs: string[];
+        }>;
+    };
+    templates: {
+        list: () => Promise<TemplateSummary[]>;
+        get: (id: string) => Promise<Template>;
+        deploy: (id: string) => Promise<{
+            serviceId: number;
+            deploymentId: number;
+        }>;
+    };
+    limits: {
+        setService: (serviceId: number, input: SetLimitsInput) => Promise<{
+            cpuShares: number;
+            memLimitMb: number;
+        }>;
+        setDatabase: (databaseId: number, input: SetLimitsInput) => Promise<{
+            cpuShares: number;
+            memLimitMb: number;
+        }>;
+    };
+    traefik: {
+        get: () => Promise<TraefikInfo>;
+        status: () => Promise<TraefikStatus>;
+        certificates: () => Promise<TraefikCertificate[]>;
+        logs: (lines?: number) => Promise<{
+            logs: string[];
+        }>;
+        restart: () => Promise<{
+            ok: boolean;
+            message?: string;
+        }>;
+        backupCerts: () => Promise<{
+            ok: boolean;
+            message?: string;
+            filename?: string;
+        }>;
+    };
+    config: {
+        list: (query?: {
+            category?: string;
+            pluginId?: string;
+            reveal?: boolean;
+        }) => Promise<ConfigListResponse>;
+        get: (key: string) => Promise<ConfigItem>;
+        set: (key: string, input: SetConfigInput) => Promise<{
+            ok: boolean;
+            key: string;
+        }>;
+        delete: (key: string) => Promise<{
+            ok: boolean;
+            key: string;
+        }>;
+    };
+    plugins: {
+        list: () => Promise<PluginListResponse>;
+        marketplace: () => Promise<MarketplaceCatalogResponse>;
+        install: (input: InstallPluginInput) => Promise<{
+            ok: boolean;
+            id: string;
+            status: string;
+        }>;
+        enable: (id: string) => Promise<{
+            ok: boolean;
+            id: string;
+            status: string;
+        }>;
+        disable: (id: string) => Promise<{
+            ok: boolean;
+            id: string;
+            status: string;
+        }>;
+        reload: (id: string) => Promise<{
+            ok: boolean;
+            id: string;
+            status: string;
+        }>;
+        inspect: (id: string) => Promise<PluginInspectResponse>;
+        uninstall: (id: string) => Promise<{
+            ok: boolean;
+            id: string;
+        }>;
+    };
+    menus: {
+        list: (query?: {
+            slot?: string;
+        }) => Promise<MenuListResponse>;
+    };
+    demo: {
+        seed: () => Promise<DemoSeedResult>;
+    };
+    logDrains: {
+        list: (query?: {
+            serviceId?: number;
+        }) => Promise<LogDrain[]>;
+        get: (id: number) => Promise<LogDrain>;
+        create: (input: LogDrainCreateInput) => Promise<LogDrain>;
+        update: (id: number, input: LogDrainUpdateInput) => Promise<LogDrain>;
+        remove: (id: number) => Promise<{
+            ok: boolean;
+        }>;
+        test: (id: number) => Promise<LogDrainTestResult>;
+    };
+    housekeeping: {
+        getAutoPrune: () => Promise<AutoPruneStatus>;
+        updateAutoPrune: (input: AutoPruneConfigUpdateInput) => Promise<AutoPruneStatus>;
+        runPrune: () => Promise<AutoPruneRunResult>;
+    };
+    health: () => Promise<HealthStatus>;
+}
+export interface ContainerInspectData {
+    id: string;
+    name: string;
+    image: string;
+    state: {
+        status: string;
+        running: boolean;
+        startedAt: string;
+        finishedAt: string;
+        exitCode: number;
+        error: string;
+    };
+    labels: Record<string, string>;
+    traefikTags: Record<string, string>;
+    env: string[];
+    ports: Record<string, unknown>;
+    mounts: Array<{
+        source: string;
+        destination: string;
+        mode: string;
+        rw: boolean;
+    }>;
+    networks: string[];
+    resources: {
+        memoryLimitBytes: number;
+        cpuShares: number;
+        restartPolicy: string;
+    };
+    raw: unknown;
+}
+export interface ContainerComposeData {
+    yaml: string;
+    inspect: ContainerInspectData;
+}
+/**
+ * Create a typed NineDeploy API client. Used by both the web dashboard and the CLI.
+ *
+ * @example
+ * const client = createClient({ baseUrl: 'http://localhost:3000', getToken: () => token });
+ * const services = await client.services.list();
+ */
+export declare function createClient(opts: NineDeployClientOptions): NineDeployClient;
+//# sourceMappingURL=index.d.ts.map