@dockstat/docker 0.1.0 → 0.1.2

package/src/modules/networks/index.ts

@@ -1,87 +0,0 @@
-import { BaseModule } from "../base"
-import type {
-  CreateNetworkOptions,
-  ListNetworksOptions,
-  NetworkConnectRequest,
-  NetworkCreateResponse,
-  NetworkDisconnectRequest,
-  NetworkInspect,
-  NetworkPruneResponse,
-  NetworkSummary,
-  PruneNetworksOptions,
-} from "./types"
-
-/**
- * Networks module for managing Docker networks
- */
-export class NetworksModule extends BaseModule {
-  /**
-   * List networks
-   * @param options - List options including filters
-   * @returns Array of network summaries
-   */
-  async list(options?: ListNetworksOptions): Promise<NetworkSummary[]> {
-    const res = await this.request(`/networks`, "GET", undefined, undefined, options)
-    return (await res.json()) as NetworkSummary[]
-  }
-
-  /**
-   * Create a network
-   * @param config - Network configuration
-   * @returns Network create response with ID and warnings
-   */
-  async create(config: CreateNetworkOptions): Promise<NetworkCreateResponse> {
-    const res = await this.request("/networks/create", "POST", config)
-    return (await res.json()) as NetworkCreateResponse
-  }
-
-  /**
-   * Inspect a network
-   * @param id - Network ID or name
-   * @param options - Inspect options
-   * @returns Detailed network information
-   */
-  async inspect(
-    id: string,
-    options?: { verbose?: boolean; scope?: string }
-  ): Promise<NetworkInspect> {
-    const res = await this.request(`/networks/${id}`, "GET", undefined, undefined, options)
-    return (await res.json()) as NetworkInspect
-  }
-
-  /**
-   * Remove a network
-   * @param id - Network ID or name
-   */
-  async remove(id: string): Promise<void> {
-    await this.request(`/networks/${id}`, "DELETE")
-  }
-
-  /**
-   * Connect a container to a network
-   * @param id - Network ID or name
-   * @param request - Connection request with container and endpoint config
-   */
-  async connect(id: string, request: NetworkConnectRequest): Promise<void> {
-    await this.request(`/networks/${id}/connect`, "POST", request)
-  }
-
-  /**
-   * Disconnect a container from a network
-   * @param id - Network ID or name
-   * @param request - Disconnection request with container and force option
-   */
-  async disconnect(id: string, request: NetworkDisconnectRequest): Promise<void> {
-    await this.request(`/networks/${id}/disconnect`, "POST", request)
-  }
-
-  /**
-   * Remove unused networks
-   * @param options - Prune options including filters
-   * @returns Prune response with deleted networks
-   */
-  async prune(options?: PruneNetworksOptions): Promise<NetworkPruneResponse> {
-    const res = await this.request(`/networks/prune`, "POST", undefined, undefined, options)
-    return (await res.json()) as NetworkPruneResponse
-  }
-}

package/src/modules/networks/types.ts

@@ -1,258 +0,0 @@
-// ============================================================================
-// Network Types
-// ============================================================================
-
-/**
- * Network configuration and state
- */
-export interface Network {
-  Name?: string
-  Id?: string
-  Created?: number
-  Scope?: string
-  Driver?: string
-  EnableIPv4?: boolean
-  EnableIPv6?: boolean
-  IPAM?: IPAM
-  Internal?: boolean
-  Attachable?: boolean
-  Ingress?: boolean
-  ConfigFrom?: ConfigReference
-  ConfigOnly?: boolean
-  Options?: Record<string, string>
-  Labels?: Record<string, string>
-  Peers?: PeerInfo[]
-}
-
-/**
- * Network summary (extends Network)
- */
-export interface NetworkSummary extends Network {}
-
-/**
- * Full network inspection details
- */
-export interface NetworkInspect extends Network {
-  Containers?: Record<string, EndpointResource>
-  Services?: Record<string, ServiceInfo>
-  Status?: NetworkStatus
-}
-
-/**
- * Network status information
- */
-export interface NetworkStatus {
-  IPAM?: IPAMStatus
-}
-
-/**
- * Service information in a network
- */
-export interface ServiceInfo {
-  VIP?: string
-  Ports?: string[]
-  LocalLBIndex?: number
-  Tasks?: NetworkTaskInfo[]
-}
-
-/**
- * Task information in a network
- */
-export interface NetworkTaskInfo {
-  Name?: string
-  EndpointID?: string
-  EndpointIP?: string
-  MacAddress?: string
-  IPv4Address?: string
-  IPv6Address?: string
-}
-
-/**
- * Config reference for network
- */
-export interface ConfigReference {
-  Network?: string
-}
-
-/**
- * IPAM configuration
- */
-export interface IPAM {
-  Driver?: string
-  Config?: IPAMConfig[]
-  Options?: Record<string, string>
-}
-
-/**
- * IPAM configuration entry
- */
-export interface IPAMConfig {
-  Subnet?: string
-  IPRange?: string
-  Gateway?: string
-  AuxiliaryAddresses?: Record<string, string>
-}
-
-/**
- * IPAM status
- */
-export interface IPAMStatus {
-  Subnets?: Record<string, SubnetStatus>
-}
-
-/**
- * Subnet status
- */
-export interface SubnetStatus {
-  IPsInUse?: number
-  DynamicIPsAvailable?: number
-}
-
-/**
- * Endpoint resource information
- */
-export interface EndpointResource {
-  Name?: string
-  EndpointID?: string
-  MacAddress?: string
-  IPv4Address?: string
-  IPv6Address?: string
-}
-
-/**
- * Peer information
- */
-export interface PeerInfo {
-  Name?: string
-  IP?: string
-}
-
-/**
- * Network create response
- */
-export interface NetworkCreateResponse {
-  Id?: string
-  Warning?: string
-}
-
-/**
- * Network connect request
- */
-export interface NetworkConnectRequest {
-  Container?: string
-  EndpointConfig?: EndpointSettings
-}
-
-/**
- * Network disconnect request
- */
-export interface NetworkDisconnectRequest {
-  Container?: string
-  Force?: boolean
-}
-
-/**
- * Endpoint settings
- */
-export interface EndpointSettings {
-  IPAMConfig?: EndpointIPAMConfig
-  Links?: string[]
-  Aliases?: string[]
-  NetworkID?: string
-  EndpointID?: string
-  Gateway?: string
-  IPAddress?: string
-  IPPrefixLen?: number
-  IPv6Gateway?: string
-  GlobalIPv6Address?: string
-  GlobalIPv6PrefixLen?: number
-  MacAddress?: string
-  DriverOpts?: Record<string, string>
-}
-
-/**
- * Endpoint IPAM configuration
- */
-export interface EndpointIPAMConfig {
-  IPv4Address?: string
-  IPv6Address?: string
-  LinkLocalIPs?: string[]
-}
-
-/**
- * Network prune response
- */
-export interface NetworkPruneResponse {
-  NetworksDeleted?: string[]
-}
-
-// ============================================================================
-// Request/Response Types
-// ============================================================================
-
-/**
- * List networks options
- */
-export interface ListNetworksOptions {
-  filters?: {
-    dangling?: boolean[]
-    driver?: string[]
-    id?: string[]
-    label?: string[]
-    name?: string[]
-    scope?: string[]
-    type?: string[]
-  }
-}
-
-/**
- * Create network options
- */
-export interface CreateNetworkOptions {
-  Name: string
-  CheckDuplicate?: boolean
-  Driver?: string
-  Internal?: boolean
-  Attachable?: boolean
-  Ingress?: boolean
-  IPAM?: IPAM
-  EnableIPv6?: boolean
-  Options?: Record<string, string>
-  Labels?: Record<string, string>
-  Scope?: string
-}
-
-/**
- * Inspect network options
- */
-export interface InspectNetworkOptions {
-  verbose?: boolean
-  scope?: string
-}
-
-/**
- * Connect network options
- */
-export interface ConnectNetworkOptions {
-  Container?: string
-  EndpointConfig?: EndpointSettings
-}
-
-/**
- * Disconnect network options
- */
-export interface DisconnectNetworkOptions {
-  Container?: string
-  Force?: boolean
-}
-
-/**
- * Prune networks options
- */
-export interface PruneNetworksOptions {
-  filters?: {
-    dangling?: boolean[]
-    label?: string[]
-    until?: string[]
-  }
-}

package/src/modules/nodes/index.ts

@@ -1,48 +0,0 @@
-import { BaseModule } from "../base"
-import type { ListNodesOptions, NodeResponse, NodeUpdateOptions } from "./types"
-
-export class NodesModule extends BaseModule {
-  /**
-   * List nodes
-   * @param options Filters to process on the nodes list, encoded as JSON (a Record<string, string[]>).
-   * @returns NodeResponse[]
-   */
-  async list(options?: ListNodesOptions) {
-    const res = await this.request(`/nodes`, "GET", undefined, undefined, options)
-    return (await res.json()) as NodeResponse[]
-  }
-
-  /**
-   * Inspect a node
-   * @param id The ID or name of the node
-   */
-  async inspect(id: string) {
-    const res = await this.request(`/nodes/${id}`, "GET")
-    return (await res.json()) as NodeResponse
-  }
-
-  /**
-   *
-   * @param id The ID or name of the node
-   * @param force Force remove a node from the swarm (Default: false)
-   * @returns `true` or throws an DockerError
-   */
-  async delete(id: string, force: boolean = false) {
-    await this.request(`/nodes/${id}`, "DELETE", undefined, undefined, { force })
-    // No thrown error = sucess
-    return true
-  }
-
-  /**
-   *
-   * @param id The ID or name of the node
-   * @param version The version number of the node object being updated. This is required to avoid conflicting writes.
-   * @param options What to update
-   * @returns
-   */
-  async update(id: string, version: number, options: NodeUpdateOptions) {
-    await this.request(`/nodes/${id}/update`, "POST", options, undefined, { version })
-    // No thrown error = sucess
-    return true
-  }
-}

package/src/modules/nodes/types.ts

@@ -1,69 +0,0 @@
-type NodeFilters = {
-  id?: string[]
-  label?: string[]
-  membership?: Array<"accepted" | "pending">
-  name?: string[]
-  "node.label"?: string[]
-  role?: Array<"manager" | "worker">
-}
-
-export type ListNodesOptions = {
-  filters: NodeFilters
-}
-
-export type NodeResponse = {
-  ID: string
-  Version: {
-    Index: number
-  }
-  CreatedAt: string
-  UpdatedAt: string
-  Spec: {
-    Name: string
-    Labels: Record<string, string>
-    Role: "worker" | "manager"
-    Availability: "active" | "pause" | "drain"
-  }
-  Description: {
-    Hostname: string
-    Platform: {
-      Architecture: string
-      OS: string
-    }
-    Resources: {
-      NanoCPUs: number
-      MemoryBytes: number
-      GenericResources: Array<
-        | { DiscreteResourceSpec: { Kind: string; Value: number } }
-        | { NamedResourceSpec: { Kind: string; Value: string } }
-      >
-    }
-    Engine: {
-      EngineVersion: string
-      Labels: Record<string, string>
-      Plugins: Array<{ Type: string; Name: string }>
-    }
-    TLSInfo: {
-      TrustRoot: string
-      CertIssuerSubject: string
-      CertIssuerPublicKey: string
-    }
-  }
-  Status: {
-    State: "unknown" | "down" | "ready" | "disconnected"
-    Message: string
-    Addr: string
-  }
-  ManagerStatus: {
-    Leader: boolean
-    Reachability: "unknown" | "unreachable" | "reachable"
-    Addr: string
-  } | null
-}
-
-export type NodeUpdateOptions = {
-  Name: string
-  Labels: Record<string, string>
-  Role: "worker" | "manager"
-  Availability: "active" | "pause" | "drain"
-}

package/src/modules/plugins/index.ts

@@ -1,128 +0,0 @@
-import { BaseModule } from "../base"
-import type {
-  CreatePluginOptions,
-  DisablePluginOptions,
-  EnablePluginOptions,
-  ListPluginsOptions,
-  PluginConfig,
-  PluginPrivilege,
-  PullPluginOptions,
-  RemovePluginOptions,
-  SetPluginOptions,
-  UpgradePluginOptions,
-} from "./types"
-
-export class PluginsModule extends BaseModule {
-  /**
-   * List plugins
-   * @param options - List options
-   * @returns Array of plugin configurations
-   */
-  async list(options?: ListPluginsOptions): Promise<PluginConfig[]> {
-    const res = await this.request(`/plugins`, "GET", undefined, undefined, options)
-    return (await res.json()) as PluginConfig[]
-  }
-
-  /**
-   * Get plugin privileges
-   * @param remote - Remote name or plugin name
-   * @returns Array of plugin privileges
-   */
-  async privileges(remote: string): Promise<PluginPrivilege[]> {
-    const res = await this.request(`/plugins/privileges`, "GET", undefined, undefined, { remote })
-    return (await res.json()) as PluginPrivilege[]
-  }
-
-  /**
-   * Pull a plugin
-   * @param options - Pull options
-   * @returns Plugin configuration
-   */
-  async pull(options: PullPluginOptions): Promise<PluginConfig> {
-    const res = await this.request(`/plugins/pull`, "POST", undefined, undefined, options)
-    return (await res.json()) as PluginConfig
-  }
-
-  /**
-   * Get plugin details
-   * @param name - Plugin name
-   * @returns Plugin configuration
-   */
-  async inspect(name: string): Promise<PluginConfig> {
-    const res = await this.request(`/plugins/${name}/json`, "GET")
-    return (await res.json()) as PluginConfig
-  }
-
-  /**
-   * Remove a plugin
-   * @param name - Plugin name
-   * @param options - Remove options
-   */
-  async remove(name: string, options?: RemovePluginOptions): Promise<void> {
-    await this.request(`/plugins/${name}`, "DELETE", undefined, undefined, options)
-  }
-
-  /**
-   * Enable a plugin
-   * @param name - Plugin name
-   * @param options - Enable options
-   */
-  async enable(name: string, options?: EnablePluginOptions): Promise<void> {
-    await this.request(`/plugins/${name}/enable`, "POST", undefined, undefined, options)
-  }
-
-  /**
-   * Disable a plugin
-   * @param name - Plugin name
-   * @param options - Disable options
-   */
-  async disable(name: string, options?: DisablePluginOptions): Promise<void> {
-    await this.request(`/plugins/${name}/disable`, "POST", undefined, undefined, options)
-  }
-
-  /**
-   * Upgrade a plugin
-   * @param name - Plugin name
-   * @param options - Upgrade options
-   * @returns Plugin configuration
-   */
-  async upgrade(name: string, options: UpgradePluginOptions): Promise<PluginConfig> {
-    const res = await this.request(
-      `/plugins/${name}/upgrade`,
-      "POST",
-      undefined,
-      undefined,
-      options
-    )
-    return (await res.json()) as PluginConfig
-  }
-
-  /**
-   * Create a plugin
-   * @param options - Create options
-   * @returns Plugin configuration
-   */
-  async create(options: CreatePluginOptions): Promise<PluginConfig> {
-    const res = await this.request(`/plugins/create`, "POST", options.path, undefined, {
-      name: options.name,
-    })
-    return (await res.json()) as PluginConfig
-  }
-
-  /**
-   * Push a plugin
-   * @param name - Plugin name
-   */
-  async push(name: string): Promise<void> {
-    await this.request(`/plugins/${name}/push`, "POST")
-  }
-
-  /**
-   * Set plugin settings
-   * @param name - Plugin name
-   * @param options - Set options
-   */
-  async set(name: string, options: SetPluginOptions): Promise<void> {
-    await this.request(`/plugins/${name}/set`, "POST", JSON.stringify(options.settings))
-  }
-}

package/src/modules/plugins/types.ts

@@ -1,114 +0,0 @@
-export type PluginsFilter = {
-  capability: string[]
-  enabled: boolean[]
-}
-
-export type PluginDevice = {
-  Name: string
-  Description: string
-  Settable: string[]
-  Path: string
-}
-
-export type PluginMount = {
-  Name: string
-  Description: string
-  Settable: string[]
-  Source: string
-  Destination: string
-  Type: string
-  Options: string[]
-}
-
-export type PluginConfig = {
-  Id: string
-  Name: string
-  Enabled: boolean
-  Settings: {
-    Mounts: Array<PluginMount>
-    Env: string[]
-    Args: string[]
-    Devices: Array<PluginDevice>
-  }
-  PluginReference: string
-  Config: {
-    Description: string
-    Documentation: string
-    Interface: Array<{
-      Types: string[]
-      Socket: string
-      ProtocolScheme: "" | "moby.plugins.http/v1"
-    }>
-    Entrypoint: string[]
-    WorkDir: string
-    User: {
-      UID: number
-      GID: number
-    }
-    Network: {
-      Type: string
-    }
-    Linux: {
-      Capabilities: string[]
-      AllowAllDevices: boolean
-      Devices: Array<PluginDevice>
-    }
-    PropagatedMount: string
-    IpcHost: string
-    PidHost: string
-    Mounts: Array<PluginMount>
-    Env: Array<{
-      Name: string
-      Description: string
-      Settable: string[]
-      Value: string
-    }>
-    Args: Array<{ Name: string; Description: string; Settable: string[]; Value: string[] }>
-    rootfs: {
-      type: string
-      diff_ids: string[]
-    }
-  }
-}
-
-export type PluginPrivilege = {
-  Name: string
-  Description: string
-  Value: string[]
-}
-
-export type ListPluginsOptions = {
-  filters?: PluginsFilter
-}
-
-export type PullPluginOptions = {
-  remote: string
-  name?: string
-  privileges?: PluginPrivilege[]
-}
-
-export type CreatePluginOptions = {
-  name: string
-  path: string
-}
-
-export type RemovePluginOptions = {
-  force?: boolean
-}
-
-export type EnablePluginOptions = {
-  timeout?: number
-}
-
-export type DisablePluginOptions = {
-  timeout?: number
-}
-
-export type UpgradePluginOptions = {
-  remote: string
-  privileges?: PluginPrivilege[]
-}
-
-export type SetPluginOptions = {
-  settings: Array<PluginMount | PluginDevice | string[]>
-}

package/src/modules/secrets/index.ts

@@ -1,5 +0,0 @@
-import { BaseModule } from "../base"
-
-export class SecretsModule extends BaseModule {
-  list() {}
-}