import {z} from 'zod' export type GetApiInfoOptions = {baseUrl: string, fetch?: typeof fetch | undefined}; export const pluginsInfo = z.object({Volume: z.array(z.string()).optional(), Network: z.array(z.string()).optional(), Authorization: z.array(z.string()).optional(), Log: z.array(z.string()).optional()}); export const indexInfo = z.object({Name: z.string().optional(), Mirrors: z.array(z.string()).optional(), Secure: z.boolean().optional(), Official: z.boolean().optional()}).nullable(); export const registryServiceConfig = z.object({InsecureRegistryCIDRs: z.array(z.string()).optional(), IndexConfigs: z.record(z.string(), indexInfo).optional(), Mirrors: z.array(z.string()).optional()}).nullable(); export const genericResources = z.array(z.object({NamedResourceSpec: z.object({Kind: z.string().optional(), Value: z.string().optional()}).optional(), DiscreteResourceSpec: z.object({Kind: z.string().optional(), Value: z.number().int().optional()}).optional()})); export const runtime = z.object({path: z.string().optional(), runtimeArgs: z.array(z.string()).nullable().optional(), status: z.record(z.string(), z.string()).nullable().optional()}); export const localNodeState = z.enum(["", "inactive", "pending", "active", "error", "locked"]); export const peerNode = z.object({NodeID: z.string().optional(), Addr: z.string().optional()}); export const objectVersion = z.object({Index: z.number().int().optional()}); export const swarmSpec = z.object({Name: z.string().optional(), Labels: z.record(z.string(), z.string()).optional(), Orchestration: z.object({TaskHistoryRetentionLimit: z.number().int().optional()}).nullable().optional(), Raft: z.object({SnapshotInterval: z.number().int().optional(), KeepOldSnapshots: z.number().int().optional(), LogEntriesForSlowFollowers: z.number().int().optional(), ElectionTick: z.number().int().optional(), HeartbeatTick: z.number().int().optional()}).optional(), Dispatcher: z.object({HeartbeatPeriod: z.number().int().optional()}).nullable().optional(), CAConfig: z.object({NodeCertExpiry: z.number().int().optional(), ExternalCAs: z.array(z.object({Protocol: z.literal("cfssl").optional(), URL: z.string().optional(), Options: z.record(z.string(), z.string()).optional(), CACert: z.string().optional()})).optional(), SigningCACert: z.string().optional(), SigningCAKey: z.string().optional(), ForceRotate: z.number().int().optional()}).nullable().optional(), EncryptionConfig: z.object({AutoLockManagers: z.boolean().optional()}).optional(), TaskDefaults: z.object({LogDriver: z.object({Name: z.string().optional(), Options: z.record(z.string(), z.string()).optional()}).optional()}).optional()}); export const tLSInfo = z.object({TrustRoot: z.string().optional(), CertIssuerSubject: z.string().optional(), CertIssuerPublicKey: z.string().optional()}); export const clusterInfo = z.object({ID: z.string().optional(), Version: objectVersion.optional(), CreatedAt: z.string().optional(), UpdatedAt: z.string().optional(), Spec: swarmSpec.optional(), TLSInfo: tLSInfo.optional(), RootRotationInProgress: z.boolean().optional(), DataPathPort: z.number().int().optional(), DefaultAddrPool: z.array(z.string()).optional(), SubnetSize: z.number().int().lte(29).optional()}).nullable(); export const swarmInfo = z.object({NodeID: z.string().optional(), NodeAddr: z.string().optional(), LocalNodeState: localNodeState.optional(), ControlAvailable: z.boolean().optional(), Error: z.string().optional(), RemoteManagers: z.array(peerNode).nullable().optional(), Nodes: z.number().int().nullable().optional(), Managers: z.number().int().nullable().optional(), Cluster: clusterInfo.optional()}); export const commit = z.object({ID: z.string().optional()}); export const firewallInfo = z.object({Driver: z.string().optional(), Info: z.array(z.array(z.string())).optional()}).nullable(); export const deviceInfo = z.object({Source: z.string().optional(), ID: z.string().optional()}); export const containerdInfo = z.object({Address: z.string().optional(), Namespaces: z.object({Containers: z.string().optional(), Plugins: z.string().optional()}).optional()}).nullable(); export const systemInfo = z.object({ID: z.string().optional(), Containers: z.number().int().optional(), ContainersRunning: z.number().int().optional(), ContainersPaused: z.number().int().optional(), ContainersStopped: z.number().int().optional(), Images: z.number().int().optional(), Driver: z.string().optional(), DriverStatus: z.array(z.array(z.string())).optional(), DockerRootDir: z.string().optional(), Plugins: pluginsInfo.optional(), MemoryLimit: z.boolean().optional(), SwapLimit: z.boolean().optional(), KernelMemoryTCP: z.boolean().optional(), CpuCfsPeriod: z.boolean().optional(), CpuCfsQuota: z.boolean().optional(), CPUShares: z.boolean().optional(), CPUSet: z.boolean().optional(), PidsLimit: z.boolean().optional(), OomKillDisable: z.boolean().optional(), IPv4Forwarding: z.boolean().optional(), BridgeNfIptables: z.boolean().optional(), BridgeNfIp6tables: z.boolean().optional(), Debug: z.boolean().optional(), NFd: z.number().int().optional(), NGoroutines: z.number().int().optional(), SystemTime: z.string().optional(), LoggingDriver: z.string().optional(), CgroupDriver: z.enum(["cgroupfs", "systemd", "none"]).optional(), CgroupVersion: z.enum(["1", "2"]).optional(), NEventsListener: z.number().int().optional(), KernelVersion: z.string().optional(), OperatingSystem: z.string().optional(), OSVersion: z.string().optional(), OSType: z.string().optional(), Architecture: z.string().optional(), NCPU: z.number().int().optional(), MemTotal: z.number().int().optional(), IndexServerAddress: z.string().optional(), RegistryConfig: registryServiceConfig.optional(), GenericResources: genericResources.optional(), HttpProxy: z.string().optional(), HttpsProxy: z.string().optional(), NoProxy: z.string().optional(), Name: z.string().optional(), Labels: z.array(z.string()).optional(), ExperimentalBuild: z.boolean().optional(), ServerVersion: z.string().optional(), Runtimes: z.record(z.string(), runtime).optional(), DefaultRuntime: z.string().optional(), Swarm: swarmInfo.optional(), LiveRestoreEnabled: z.boolean().optional(), Isolation: z.enum(["default", "hyperv", "process", ""]).optional(), InitBinary: z.string().optional(), ContainerdCommit: commit.optional(), RuncCommit: commit.optional(), InitCommit: commit.optional(), SecurityOptions: z.array(z.string()).optional(), ProductLicense: z.string().optional(), DefaultAddressPools: z.array(z.object({Base: z.string().optional(), Size: z.number().int().optional()})).optional(), FirewallBackend: firewallInfo.optional(), DiscoveredDevices: z.array(deviceInfo).optional(), Warnings: z.array(z.string()).optional(), CDISpecDirs: z.array(z.string()).optional(), Containerd: containerdInfo.optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Get system information * * GET /info */ export const getApiInfo = async (options: GetApiInfoOptions) => { const {baseUrl, fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") const url = `${baseUrl.replace(/\/+$/, '')}/info${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(systemInfo, await res.json()) };