@ninedeploy/sdk 0.18.4 → 0.18.11

package/src/resources/services.ts

@@ -4,6 +4,12 @@
 import type {
   Attachment,
   AutoscaleStatusView,
+  SizingReport,
+  RestartLimitConfig,
+  RestartLimitView,
+  PendingChangesView,
+  PendingApplyInput,
+  PendingApplyResult,
   ComposePreviewRequestInput,
   ComposePreviewResponse,
   CreateProjectInput,
@@ -42,12 +48,31 @@ import type {
   ServiceLifecycleResult,
   ServiceLifecycleView,
   ServiceLifecycleRetry,
+  ErrorPagesInput,
+  InlineDockerfileView,
+  ServiceMoveView,
+  ServiceCommitStatusView,
+  ErrorEventView,
+  ErrorIngestView,
+  ErrorIssueView,
+  ErrorPagesView,
+  MaintenanceInput,
+  MaintenanceView,
 } from '@ninedeploy/schemas';
 import { apiGetUrl } from '../apiPath.js';
 import type { ApplyManifestResult, ApplyManifestInput, ServiceDetail } from '../types.js';
 import type { Transport } from '../transport.js';
 
 /** 0.16.1: one kept upload of a service's source archive. */
+/** G1.7: the registry push webhook of one service. `url` is set only in the answer that made it. */
+export interface RegistryHookView {
+  enabled: boolean;
+  mine: boolean;
+  url: string | null;
+  createdAt: string | null;
+  lastPushAt: string | null;
+}
+
 export interface SourceUpload {
   /** First 40 hex chars of the archive's SHA-256 (the deployment's `commitSha`). */
   sha: string;
@@ -194,6 +219,72 @@ export interface ServicesApi {
     swarmRecovery: (id: number) => Promise<SwarmRecoveryEntry | null>;
     retrySwarmRecovery: (id: number) => Promise<SwarmRecoveryResult>;
     autoscale: (id: number) => Promise<AutoscaleStatusView>;
+    /** G5.6: memory and CPU limit suggestions from the metric history (viewer; advisory). */
+    sizing: (id: number) => Promise<SizingReport>;
+    /** G2.2: maintenance mode (a config turns it on, null off) and custom 502/503/504 pages. */
+    maintenance: {
+      get: (id: number) => Promise<MaintenanceView>;
+      set: (id: number, maintenance: MaintenanceInput['maintenance']) => Promise<MaintenanceView>;
+    };
+    errorPages: {
+      get: (id: number) => Promise<ErrorPagesView>;
+      set: (id: number, pages: ErrorPagesInput['pages']) => Promise<ErrorPagesView>;
+    };
+    /** G1.1: a Dockerfile pasted in the panel (null builds from the repository again). */
+    /** G5.4: errors reported by Sentry SDKs, grouped into issues. */
+    errors: {
+      list: (id: number, status?: 'unresolved' | 'resolved' | 'ignored') => Promise<ErrorIssueView[]>;
+      get: (id: number, issueId: number) => Promise<{ issue: ErrorIssueView; events: ErrorEventView[] }>;
+      setStatus: (id: number, issueId: number, status: 'unresolved' | 'resolved' | 'ignored') => Promise<ErrorIssueView>;
+      /** The DSN: `create` answers it once and replaces any earlier one. */
+      ingest: {
+        get: (id: number) => Promise<ErrorIngestView>;
+        create: (id: number) => Promise<ErrorIngestView>;
+        remove: (id: number) => Promise<ErrorIngestView>;
+      };
+    };
+    /** G3.1: move a stopped docker service to another host with its data volume (operators). */
+    move: {
+      get: (id: number) => Promise<ServiceMoveView>;
+      /** `serverId` null = the panel host. Answers at once; follow it with `get`. */
+      start: (id: number, serverId: number | null) => Promise<ServiceMoveView>;
+    };
+    inlineDockerfile: {
+      get: (id: number) => Promise<InlineDockerfileView>;
+      set: (id: number, content: string | null) => Promise<InlineDockerfileView>;
+    };
+    /**
+     * G1.7 registry push webhook: a secret URL a registry (Docker Hub, GHCR,
+     * Harbor, registry:2) calls after a push; the service redeploys when the
+     * pushed tag is its image. The URL is returned once, by `enable`.
+     */
+    /** GitLab, Gitea and Bitbucket commit statuses (ROADMAP 0.16.8 item 8). */
+    commitStatus: {
+      get: (id: number) => Promise<ServiceCommitStatusView>;
+      set: (id: number, enabled: boolean) => Promise<ServiceCommitStatusView>;
+    };
+    registryHook: {
+      get: (id: number) => Promise<RegistryHookView>;
+      enable: (id: number) => Promise<RegistryHookView>;
+      disable: (id: number) => Promise<RegistryHookView>;
+    };
+    /** G1.3: stop the service when its containers keep restarting (opt-in; member to set). */
+    restartLimit: {
+      get: (id: number) => Promise<RestartLimitView>;
+      set: (id: number, limit: RestartLimitConfig | null) => Promise<RestartLimitView>;
+    };
+    /**
+     * G5.2 pending changes tray. With staging on, edits collect (`stage`, a
+     * PATCH body) instead of applying; `apply` sends them through
+     * `update` together, optionally with a deploy.
+     */
+    pending: {
+      get: (id: number) => Promise<PendingChangesView>;
+      stage: (id: number, patch: UpdateServiceInput) => Promise<PendingChangesView>;
+      setStaging: (id: number, staging: boolean) => Promise<PendingChangesView>;
+      discard: (id: number) => Promise<PendingChangesView>;
+      apply: (id: number, input?: PendingApplyInput) => Promise<PendingApplyResult>;
+    };
     // ── 0.16.11 scale to zero ──
     /**
      * Put a docker service to sleep now (`POST /v1/services/:id/sleep`,
@@ -337,6 +428,53 @@ export function servicesApi(t: Transport): ServicesApi {
       swarmRecovery: async id => (await get<{ entry: SwarmRecoveryEntry | null }>(`/v1/services/${id}/swarm/recovery`)).entry,
       retrySwarmRecovery: id => request<SwarmRecoveryResult>(`/v1/services/${id}/swarm/recovery`, { method: 'POST' }, 600_000),
       autoscale: (id) => get<AutoscaleStatusView>(`/v1/services/${id}/autoscale`),
+      sizing: (id) => get<SizingReport>(`/v1/services/${id}/sizing`),
+      maintenance: {
+        get: (id) => get<MaintenanceView>(`/v1/services/${id}/maintenance`),
+        set: (id, maintenance) => send<MaintenanceView>('PUT', `/v1/services/${id}/maintenance`, { maintenance }),
+      },
+      errorPages: {
+        get: (id) => get<ErrorPagesView>(`/v1/services/${id}/error-pages`),
+        set: (id, pages) => send<ErrorPagesView>('PUT', `/v1/services/${id}/error-pages`, { pages }),
+      },
+      errors: {
+        list: (id, status) => get<ErrorIssueView[]>(`/v1/services/${id}/errors${status ? `?status=${status}` : ''}`),
+        get: (id, issueId) => get<{ issue: ErrorIssueView; events: ErrorEventView[] }>(`/v1/services/${id}/errors/${issueId}`),
+        setStatus: (id, issueId, status) => send<ErrorIssueView>('PATCH', `/v1/services/${id}/errors/${issueId}`, { status }),
+        ingest: {
+          get: (id) => get<ErrorIngestView>(`/v1/services/${id}/error-ingest`),
+          create: (id) => send<ErrorIngestView>('POST', `/v1/services/${id}/error-ingest`),
+          remove: (id) => send<ErrorIngestView>('DELETE', `/v1/services/${id}/error-ingest`),
+        },
+      },
+      move: {
+        get: (id) => get<ServiceMoveView>(`/v1/services/${id}/move`),
+        start: (id, serverId) => send<ServiceMoveView>('POST', `/v1/services/${id}/move`, { serverId }),
+      },
+      inlineDockerfile: {
+        get: (id) => get<InlineDockerfileView>(`/v1/services/${id}/inline-dockerfile`),
+        set: (id, content) => send<InlineDockerfileView>('PUT', `/v1/services/${id}/inline-dockerfile`, { content }),
+      },
+      commitStatus: {
+        get: (id) => get<ServiceCommitStatusView>(`/v1/services/${id}/commit-status`),
+        set: (id, enabled) => send<ServiceCommitStatusView>('PUT', `/v1/services/${id}/commit-status`, { enabled }),
+      },
+      registryHook: {
+        get: (id) => get<RegistryHookView>(`/v1/services/${id}/registry-hook`),
+        enable: (id) => send<RegistryHookView>('POST', `/v1/services/${id}/registry-hook`),
+        disable: (id) => request<RegistryHookView>(`/v1/services/${id}/registry-hook`, { method: 'DELETE' }),
+      },
+      restartLimit: {
+        get: (id) => get<RestartLimitView>(`/v1/services/${id}/restart-limit`),
+        set: (id, limit) => send<RestartLimitView>('PUT', `/v1/services/${id}/restart-limit`, { limit }),
+      },
+      pending: {
+        get: (id) => get<PendingChangesView>(`/v1/services/${id}/pending`),
+        stage: (id, patch) => send<PendingChangesView>('PUT', `/v1/services/${id}/pending`, patch),
+        setStaging: (id, staging) => send<PendingChangesView>('PUT', `/v1/services/${id}/pending/staging`, { staging }),
+        discard: (id) => send<PendingChangesView>('DELETE', `/v1/services/${id}/pending`),
+        apply: (id, input) => send<PendingApplyResult>('POST', `/v1/services/${id}/pending/apply`, input ?? {}),
+      },
       sleep: (id) => send<{ ok: boolean; asleep: boolean }>('POST', `/v1/services/${id}/sleep`),
       wake: (id) => send<{ ok: boolean; status: string }>('POST', `/v1/services/${id}/wake`),
       // ── end 0.16 T8 ──

package/src/resources/settings.ts

@@ -11,10 +11,36 @@ import type {
   SecretProviderView,
   VaultProviderPut,
   AwsProviderPut,
+  GcpProviderPut,
+  AzureProviderPut,
+  OnePasswordProviderPut,
+  ExecProviderPut,
 } from '@ninedeploy/schemas';
 import type { VaultAllowlistView, VaultSettings, EmailTemplateName, EmailTemplateEntry, EmailTemplateRender } from '../types.js';
 import type { Transport } from '../transport.js';
 
+/** The PUT body of each secret provider kind (G3.2 added gcp, azure, onepassword, exec). */
+export type SecretProviderPutFor<K extends SecretProviderKind> = {
+  vault: VaultProviderPut;
+  aws: AwsProviderPut;
+  gcp: GcpProviderPut;
+  azure: AzureProviderPut;
+  onepassword: OnePasswordProviderPut;
+  exec: ExecProviderPut;
+}[K];
+
+/** G3.5: the DNS record providers configured through `settings.dnsProvider`. */
+export type DnsCredentialProviderName = 'route53' | 'ovh' | 'porkbun' | 'hetzner';
+export interface DnsProviderSettings {
+  providers: DnsCredentialProviderName[];
+  /** The active `dns_records_provider` (may be cloudflare, dnsimple, …). */
+  provider: string | null;
+  /** Which of these four has credentials saved. */
+  configured: DnsCredentialProviderName | null;
+  /** The saved non-secret fields (an access key id, an OVH endpoint). */
+  fields: Record<string, string>;
+}
+
 export type AutoUrlMode = 'off' | 'domain' | 'sslip';
 export interface AutoUrlEffective {
   mode: AutoUrlMode;
@@ -88,6 +114,17 @@ export interface SettingsApi {
       get: () => Promise<{ configured: boolean; apiUser: string | null; clientIp: string | null; hasKey: boolean }>;
       set: (input: { apiUser: string; apiKey: string; clientIp: string }) => Promise<{ ok: boolean; apiUser: string }>;
     };
+    /**
+     * G3.5: Route 53, OVH, Porkbun and Hetzner DNS record auto-provisioning.
+     * Saving credentials makes that provider the active one; `get` never
+     * returns a secret.
+     */
+    dnsProvider: {
+      get: () => Promise<DnsProviderSettings>;
+      set: (input: { provider: DnsCredentialProviderName; credentials: Record<string, string> }) => Promise<{ ok: boolean; provider: string }>;
+      clear: () => Promise<{ ok: boolean }>;
+      test: () => Promise<{ ok: boolean; provider?: string; zones?: string[]; zoneCount?: number; error?: string }>;
+    };
     /**
      * Master-key rotation. `rotate` re-encrypts every stored secret onto the
      * highest key version in `NINEDEPLOY_MASTER_KEYS`; it does NOT rewrite
@@ -114,7 +151,7 @@ export interface SettingsApi {
      */
     secretProviders: {
       list: () => Promise<SecretProviderView[]>;
-      set: <K extends SecretProviderKind>(kind: K, input: K extends 'vault' ? VaultProviderPut : AwsProviderPut) => Promise<SecretProviderView>;
+      set: <K extends SecretProviderKind>(kind: K, input: SecretProviderPutFor<K>) => Promise<SecretProviderView>;
       delete: (kind: SecretProviderKind) => Promise<{ ok: boolean; deleted: boolean }>;
       test: (kind: SecretProviderKind, probe?: SecretProviderTestRequest) => Promise<SecretProviderTestResult>;
     };
@@ -237,6 +274,13 @@ export function settingsApi(t: Transport): SettingsApi {
         get: () => get<{ configured: boolean; apiUser: string | null; clientIp: string | null; hasKey: boolean }>('/v1/settings/dns-records/namecheap'),
         set: (input) => send<{ ok: boolean; apiUser: string }>('PUT', '/v1/settings/dns-records/namecheap', input),
       },
+      dnsProvider: {
+        get: () => get<DnsProviderSettings>('/v1/settings/dns-records/provider'),
+        set: (input) => send<{ ok: boolean; provider: string }>('PUT', '/v1/settings/dns-records/provider', input),
+        clear: () => send<{ ok: boolean }>('DELETE', '/v1/settings/dns-records/provider'),
+        test: () =>
+          send<{ ok: boolean; provider?: string; zones?: string[]; zoneCount?: number; error?: string }>('POST', '/v1/settings/dns-records/provider/test'),
+      },
       masterKey: {
         get: () => get<{ activeVersion: number; knownVersions: number[]; rotatable: boolean }>('/v1/settings/master-key'),
         rotate: () =>

package/src/resources/sources.ts

@@ -10,6 +10,8 @@ import type {
   GithubAppManifestRequest,
   GithubAppManifestResponse,
   GithubAppPatch,
+  GithubRunnerConfig,
+  GithubRunnerStatus,
 } from '@ninedeploy/schemas';
 import type { GithubAppInstallationSync, SourceRepo, SourceUpdateInput } from '../types.js';
 import type { Transport } from '../transport.js';
@@ -88,6 +90,11 @@ export interface SourcesApi {
     remove: (id: number) => Promise<void>;
     syncInstallations: (id: number) => Promise<GithubAppInstallationSync>;
     installations: (id: number) => Promise<GithubAppInstallation[]>;
+    /** Self-hosted Actions runners (G4.5): settings, waiting jobs, running runners and what is missing. */
+    runners: (id: number) => Promise<GithubRunnerStatus>;
+    setRunners: (id: number, config: GithubRunnerConfig) => Promise<GithubRunnerStatus>;
+    /** Stop one runner container (and remove its registration on GitHub). */
+    stopRunner: (id: number, name: string) => Promise<void>;
   };
 }
 
@@ -126,6 +133,11 @@ export function sourcesApi(t: Transport): SourcesApi {
       },
       syncInstallations: (id) => send<GithubAppInstallationSync>('POST', `/v1/github-apps/${id}/installations/sync`),
       installations: (id) => get<GithubAppInstallation[]>(`/v1/github-apps/${id}/installations`),
+      runners: (id) => get<GithubRunnerStatus>(`/v1/github-apps/${id}/runners`),
+      setRunners: (id, config) => send<GithubRunnerStatus>('PUT', `/v1/github-apps/${id}/runners`, config),
+      stopRunner: async (id, name) => {
+        await request(`/v1/github-apps/${id}/runners/${encodeURIComponent(name)}`, { method: 'DELETE' });
+      },
     },
   };
 }

package/src/resources/system.ts

@@ -1,4 +1,4 @@
-// Client surface: system, health, about, dashboard, stats, topology, activity, alerts, metricHistory, buildCache, housekeeping, doctor, demo.
+// Client surface: system, health, about, dashboard, stats, usage, topology, activity, alerts, metricHistory, buildCache, housekeeping, doctor, demo.
 // Split out of the former single-file SDK entry (src/index.ts); the public
 // surface is re-exported unchanged from there.
 import type {
@@ -25,11 +25,30 @@ import type {
   PanelBackupRestore,
   PanelBackupSettingsPatch,
   PanelBackupStatus,
+  GitopsApplyStep,
+  GitopsCheck,
+  GitopsConfigInput,
+  GitopsView,
+  UsageCosts,
+  UsageCostsInput,
+  UsageReport,
 } from '@ninedeploy/schemas';
 import type { HealthStatus, ImageInfo, PruneImagesInput, PruneImagesResult } from '../types.js';
 import type { Transport } from '../transport.js';
 
 export interface SystemApi {
+  /** G5.3 instance GitOps (operators): the instance as a file in a repository. */
+  gitops: {
+    get: () => Promise<GitopsView>;
+    configure: (input: GitopsConfigInput) => Promise<GitopsView>;
+    remove: () => Promise<{ ok: true }>;
+    /** Read the file now and report the drift. */
+    check: () => Promise<GitopsCheck>;
+    /** Create and update what the file names (never deletes). */
+    apply: () => Promise<{ steps: GitopsApplyStep[]; check: GitopsCheck }>;
+    /** The live instance as the file, to commit. */
+    export: () => Promise<{ file: string }>;
+  };
   system: {
     resources: () => Promise<DockerResources>;
     pruneImages: () => Promise<{ ok: boolean }>;
@@ -92,6 +111,14 @@ export interface SystemApi {
     snapshot: (opts?: { databaseId?: number }) => Promise<StatsSnapshot>;
     metrics: (serviceId: number, opts?: { kind?: 'cpu' | 'memory'; minutes?: number }) => Promise<MetricSeries>;
   };
+  /** Usage and cost (operator only): CPU-hours, memory, bandwidth and cost per service, project and workspace. */
+  usage: {
+    /** The last `days` days (1–90, default 30). */
+    report: (opts?: { days?: number }) => Promise<UsageReport>;
+    costs: () => Promise<UsageCosts>;
+    /** The monthly cost of each server (`serverId: null` is the panel host). */
+    setCosts: (input: UsageCostsInput) => Promise<UsageCosts>;
+  };
   topology: {
     get: () => Promise<TopologyGraph>;
   };
@@ -175,6 +202,14 @@ export interface SystemApi {
 export function systemApi(t: Transport): SystemApi {
   const { get, send, request } = t;
   return {
+    gitops: {
+      get: () => get<GitopsView>('/v1/gitops'),
+      configure: (input) => send<GitopsView>('PUT', '/v1/gitops', input),
+      remove: () => send<{ ok: true }>('DELETE', '/v1/gitops'),
+      check: () => send<GitopsCheck>('POST', '/v1/gitops/check'),
+      apply: () => send<{ steps: GitopsApplyStep[]; check: GitopsCheck }>('POST', '/v1/gitops/apply'),
+      export: () => get<{ file: string }>('/v1/gitops/export?format=json'),
+    },
     system: {
       resources: () => get<DockerResources>('/v1/system/resources'),
       pruneImages: () => send<{ ok: boolean }>('POST', '/v1/system/prune-images'),
@@ -224,6 +259,11 @@ export function systemApi(t: Transport): SystemApi {
           `/v1/services/${serviceId}/metrics?kind=${opts?.kind ?? 'cpu'}&minutes=${opts?.minutes ?? 60}`,
         ),
     },
+    usage: {
+      report: (opts) => get<UsageReport>(`/v1/usage?days=${opts?.days ?? 30}`),
+      costs: () => get<UsageCosts>('/v1/usage/costs'),
+      setCosts: (input) => send<UsageCosts>('PUT', '/v1/usage/costs', input),
+    },
     topology: {
       get: () => get<TopologyGraph>('/v1/topology'),
     },

package/src/resources/traefik.ts

@@ -76,6 +76,11 @@ export interface TraefikApi {
       replace: (id: number, input: CustomCertificateReplace) => Promise<CustomCertificateSaved>;
       delete: (id: number) => Promise<{ ok: boolean }>;
     };
+    /** G5.7: give node proxies the panel's ACME certificates for the hosts they route (operator; off by default). */
+    sharedCertificates: {
+      get: () => Promise<{ enabled: boolean }>;
+      set: (enabled: boolean) => Promise<{ enabled: boolean }>;
+    };
   };
 }
 
@@ -120,6 +125,10 @@ export function traefikApi(t: Transport): TraefikApi {
         replace: (id, input) => send<CustomCertificateSaved>('PUT', `/v1/traefik/certificates/custom/${id}`, input),
         delete: (id) => send<{ ok: boolean }>('DELETE', `/v1/traefik/certificates/custom/${id}`),
       },
+      sharedCertificates: {
+        get: () => get<{ enabled: boolean }>('/v1/traefik/certificates/shared'),
+        set: (enabled) => send<{ enabled: boolean }>('PUT', '/v1/traefik/certificates/shared', { enabled }),
+      },
     },
   };
 }