@zukhruf/docker 0.0.0-stage → 0.3.34

package/dist/engine-api.d.ts

@@ -0,0 +1,390 @@
+/** The answer of GET /info. Each field is optional, as in the reference. */
+export interface SystemInfo {
+    ID?: string;
+    Name?: string;
+    ServerVersion?: string;
+    OperatingSystem?: string;
+    OSType?: string;
+    Architecture?: string;
+    KernelVersion?: string;
+    NCPU?: number;
+    MemTotal?: number;
+    Containers?: number;
+    ContainersRunning?: number;
+    ContainersPaused?: number;
+    ContainersStopped?: number;
+    Images?: number;
+    Driver?: string;
+    DockerRootDir?: string;
+    Labels?: string[];
+}
+/** One published binding of a port, as the reference names it. */
+export interface PortBinding {
+    HostIp?: string;
+    HostPort?: string;
+}
+/** The configuration of a container that does not depend on the host. */
+export interface ContainerConfig {
+    Hostname?: string;
+    Domainname?: string;
+    User?: string;
+    AttachStdin?: boolean;
+    AttachStdout?: boolean;
+    AttachStderr?: boolean;
+    ExposedPorts?: Record<string, Record<string, never>>;
+    Tty?: boolean;
+    OpenStdin?: boolean;
+    StdinOnce?: boolean;
+    Env?: string[];
+    Cmd?: string[];
+    Healthcheck?: {
+        Test?: string[];
+        Interval?: number;
+        Timeout?: number;
+        Retries?: number;
+        StartPeriod?: number;
+        StartInterval?: number;
+    };
+    Image?: string;
+    Volumes?: Record<string, Record<string, never>>;
+    WorkingDir?: string;
+    Entrypoint?: string[];
+    NetworkDisabled?: boolean;
+    Labels?: Record<string, string>;
+    StopSignal?: string;
+    StopTimeout?: number;
+}
+/** A mount of a container, as HostConfig.Mounts takes it. */
+export interface Mount {
+    Target?: string;
+    Source?: string;
+    Type?: 'bind' | 'volume' | 'tmpfs' | 'npipe' | 'cluster' | 'image';
+    ReadOnly?: boolean;
+    Consistency?: string;
+    BindOptions?: {
+        Propagation?: string;
+        CreateMountpoint?: boolean;
+    };
+    VolumeOptions?: {
+        NoCopy?: boolean;
+        Labels?: Record<string, string>;
+        Subpath?: string;
+    };
+    TmpfsOptions?: {
+        SizeBytes?: number;
+        Mode?: number;
+    };
+}
+/** The configuration of a container that depends on the host. */
+export interface HostConfig {
+    Binds?: string[];
+    Mounts?: Mount[];
+    NetworkMode?: string;
+    PortBindings?: Record<string, PortBinding[]>;
+    PublishAllPorts?: boolean;
+    RestartPolicy?: {
+        Name?: '' | 'no' | 'always' | 'unless-stopped' | 'on-failure';
+        MaximumRetryCount?: number;
+    };
+    AutoRemove?: boolean;
+    Memory?: number;
+    NanoCpus?: number;
+    CpuShares?: number;
+    Privileged?: boolean;
+    ReadonlyRootfs?: boolean;
+    CapAdd?: string[];
+    CapDrop?: string[];
+    ExtraHosts?: string[];
+    Init?: boolean;
+    ShmSize?: number;
+    Tmpfs?: Record<string, string>;
+    SecurityOpt?: string[];
+    UsernsMode?: string;
+    PidsLimit?: number;
+}
+/** The settings of a container on one network. */
+export interface EndpointSettings {
+    Aliases?: string[];
+    Links?: string[];
+    NetworkID?: string;
+    EndpointID?: string;
+    Gateway?: string;
+    IPAddress?: string;
+    MacAddress?: string;
+    DriverOpts?: Record<string, string>;
+}
+/** The networks that a create connects the container to. */
+export interface NetworkingConfig {
+    EndpointsConfig?: Record<string, EndpointSettings>;
+}
+/** The body of POST /containers/create, as container.CreateRequest of Moby names it. */
+export type ContainerCreateRequest = ContainerConfig & {
+    HostConfig?: HostConfig;
+    NetworkingConfig?: NetworkingConfig;
+};
+/** The answer of POST /containers/create. */
+export interface ContainerCreateResponse {
+    Id: string;
+    Warnings: string[];
+}
+export interface ContainerState {
+    Status?: 'created' | 'running' | 'paused' | 'restarting' | 'removing' | 'exited' | 'dead';
+    Running?: boolean;
+    Paused?: boolean;
+    Restarting?: boolean;
+    OOMKilled?: boolean;
+    Dead?: boolean;
+    Pid?: number;
+    ExitCode?: number;
+    Error?: string;
+    StartedAt?: string;
+    FinishedAt?: string;
+    Health?: {
+        Status?: 'none' | 'starting' | 'healthy' | 'unhealthy';
+    };
+}
+/** A mount of a container, as an inspect gives it. */
+export interface MountPoint {
+    Type?: string;
+    Name?: string;
+    Source?: string;
+    Destination?: string;
+    Driver?: string;
+    Mode?: string;
+    RW?: boolean;
+    Propagation?: string;
+}
+/** The answer of GET /containers/{id}/json. */
+export interface ContainerInspectResponse {
+    Id: string;
+    Created?: string;
+    Path?: string;
+    Args?: string[];
+    State?: ContainerState;
+    Image?: string;
+    Name?: string;
+    RestartCount?: number;
+    Platform?: string;
+    HostConfig?: HostConfig;
+    Mounts?: MountPoint[];
+    Config?: ContainerConfig;
+    NetworkSettings?: {
+        /** null for an exposed port that is not published. */
+        Ports?: Record<string, PortBinding[] | null>;
+        Networks?: Record<string, EndpointSettings>;
+    };
+}
+/** One container of GET /containers/json. */
+export interface ContainerSummary {
+    Id: string;
+    Names?: string[];
+    Image?: string;
+    ImageID?: string;
+    Command?: string;
+    Created?: number;
+    Ports?: {
+        IP?: string;
+        PrivatePort: number;
+        PublicPort?: number;
+        Type: 'tcp' | 'udp' | 'sctp';
+    }[];
+    Labels?: Record<string, string>;
+    State?: ContainerState['Status'];
+    Status?: string;
+    Mounts?: MountPoint[];
+}
+/** The answer of POST /containers/{id}/wait. */
+export interface ContainerWaitResponse {
+    StatusCode: number;
+    Error?: {
+        Message?: string;
+    } | null;
+}
+/** The answer of GET /images/{name}/json. */
+export interface ImageInspect {
+    Id: string;
+    RepoTags?: string[];
+    RepoDigests?: string[];
+    Created?: string;
+    Architecture?: string;
+    Variant?: string;
+    Os?: string;
+    Size?: number;
+    Config?: ContainerConfig;
+}
+/** Explicit credentials of a registry, as the X-Registry-Auth header takes them. */
+export type AuthConfig = {
+    username: string;
+    password: string;
+    serveraddress?: string;
+    email?: string;
+} | {
+    identitytoken: string;
+    serveraddress?: string;
+};
+/**
+ * The body of POST /containers/{id}/exec, without the fields that the package
+ * sets: AttachStdin, AttachStdout, AttachStderr and Detach.
+ */
+export interface ExecConfig {
+    Cmd: string[];
+    Tty?: boolean;
+    /** [height, width] of the TTY. */
+    ConsoleSize?: [number, number] | null;
+    DetachKeys?: string;
+    Env?: string[];
+    Privileged?: boolean;
+    User?: string;
+    WorkingDir?: string;
+}
+/** The answer of GET /exec/{id}/json. */
+export interface ExecInspectResponse {
+    ID: string;
+    ContainerID?: string;
+    Running: boolean;
+    /** null while the command runs. */
+    ExitCode: number | null;
+    Pid?: number;
+    OpenStdin?: boolean;
+    OpenStdout?: boolean;
+    OpenStderr?: boolean;
+    CanRemove?: boolean;
+    DetachKeys?: string;
+    ProcessConfig?: {
+        privileged?: boolean;
+        user?: string;
+        tty?: boolean;
+        entrypoint?: string;
+        arguments?: string[];
+    };
+}
+/** One message of GET /events. */
+export interface EventMessage {
+    Type?: 'builder' | 'config' | 'container' | 'daemon' | 'image' | 'network' | 'node' | 'plugin' | 'secret' | 'service' | 'volume';
+    /** Such as 'create', 'start', 'die' or 'health_status: healthy'. */
+    Action?: string;
+    Actor?: {
+        ID?: string;
+        Attributes?: Record<string, string>;
+    };
+    scope?: 'local' | 'swarm';
+    /** Seconds since the Unix epoch. */
+    time?: number;
+    /** Nanoseconds since the Unix epoch. */
+    timeNano?: number;
+}
+/** The JSON of the header X-Docker-Container-Path-Stat, as container.PathStat of Moby names it. */
+export interface ContainerPathStat {
+    name: string;
+    size: number;
+    /** The FileMode of Go: the permission bits, and high bits for the kind of the entry. */
+    mode: number;
+    mtime: string;
+    /** The target of a symlink; '' for each other entry. */
+    linkTarget: string;
+}
+/** A volume, as GET /volumes/{name} gives it. */
+export interface Volume {
+    Name: string;
+    Driver: string;
+    Mountpoint: string;
+    CreatedAt?: string;
+    Status?: Record<string, unknown>;
+    Labels: Record<string, string> | null;
+    Scope: 'local' | 'global';
+    Options: Record<string, string> | null;
+    UsageData?: {
+        Size: number;
+        RefCount: number;
+    } | null;
+}
+/** The body of POST /volumes/create. The engine gives the volume a name when it has none. */
+export interface VolumeCreateRequest {
+    Name?: string;
+    Driver?: string;
+    DriverOpts?: Record<string, string>;
+    Labels?: Record<string, string>;
+}
+/** The answer of GET /volumes. */
+export interface VolumeListResponse {
+    Volumes: Volume[] | null;
+    Warnings: string[] | null;
+}
+/** The address management of a network. */
+export interface IPAM {
+    Driver?: string;
+    Config?: {
+        Subnet?: string;
+        IPRange?: string;
+        Gateway?: string;
+        AuxiliaryAddresses?: Record<string, string>;
+    }[];
+    Options?: Record<string, string>;
+}
+/** The body of POST /networks/create. */
+export interface NetworkCreateRequest {
+    Name: string;
+    Driver?: string;
+    Scope?: string;
+    Internal?: boolean;
+    Attachable?: boolean;
+    Ingress?: boolean;
+    ConfigOnly?: boolean;
+    ConfigFrom?: {
+        Network?: string;
+    };
+    IPAM?: IPAM;
+    EnableIPv4?: boolean;
+    EnableIPv6?: boolean;
+    Options?: Record<string, string>;
+    Labels?: Record<string, string>;
+}
+/** A network, as GET /networks gives each one. */
+export interface NetworkSummary {
+    Name: string;
+    Id: string;
+    Created?: string;
+    Scope?: string;
+    Driver?: string;
+    EnableIPv4?: boolean;
+    EnableIPv6?: boolean;
+    IPAM?: IPAM;
+    Internal?: boolean;
+    Attachable?: boolean;
+    Ingress?: boolean;
+    ConfigFrom?: {
+        Network?: string;
+    };
+    ConfigOnly?: boolean;
+    Options?: Record<string, string>;
+    Labels?: Record<string, string>;
+}
+/** A network, as GET /networks/{id} gives it: the summary and the containers that are connected. */
+export interface NetworkInspect extends NetworkSummary {
+    /** The connected containers, by their IDs. Only a running container has an endpoint. */
+    Containers?: Record<string, {
+        Name?: string;
+        EndpointID?: string;
+        MacAddress?: string;
+        IPv4Address?: string;
+        IPv6Address?: string;
+    }>;
+}
+/** The body of POST /networks/{id}/connect. */
+export interface NetworkConnectRequest {
+    Container: string;
+    EndpointConfig?: EndpointSettings;
+}
+/** One image of GET /images/json. */
+export interface ImageSummary {
+    Id: string;
+    ParentId: string;
+    RepoTags: string[];
+    RepoDigests: string[];
+    Created: number;
+    Size: number;
+    SharedSize: number;
+    Labels: Record<string, string> | null;
+    Containers: number;
+}
+//# sourceMappingURL=engine-api.d.ts.map

package/dist/engine-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine-api.d.ts","sourceRoot":"","sources":["../src/engine-api.ts"],"names":[],"mappings":"AAGA,4EAA4E;AAC5E,MAAM,WAAW,UAAU;IACzB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,kEAAkE;AAClE,MAAM,WAAW,WAAW;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yEAAyE;AACzE,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;IACrD,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,WAAW,CAAC,EAAE;QACZ,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;IAChD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,6DAA6D;AAC7D,MAAM,WAAW,KAAK;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,OAAO,CAAC;IACnE,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,gBAAgB,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;IACnE,aAAa,CAAC,EAAE;QACd,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChC,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,YAAY,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACtD;AAED,iEAAiE;AACjE,MAAM,WAAW,UAAU;IACzB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;IAC7C,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,aAAa,CAAC,EAAE;QACd,IAAI,CAAC,EAAE,EAAE,GAAG,IAAI,GAAG,QAAQ,GAAG,gBAAgB,GAAG,YAAY,CAAC;QAC9D,iBAAiB,CAAC,EAAE,MAAM,CAAC;KAC5B,CAAC;IACF,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,kDAAkD;AAClD,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACrC;AAED,4DAA4D;AAC5D,MAAM,WAAW,gBAAgB;IAC/B,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;CACpD;AAED,wFAAwF;AACxF,MAAM,MAAM,sBAAsB,GAAG,eAAe,GAAG;IACrD,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC,CAAC;AAEF,6CAA6C;AAC7C,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EACH,SAAS,GACT,SAAS,GACT,QAAQ,GACR,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,MAAM,CAAC;IACX,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,GAAG,WAAW,CAAA;KAAE,CAAC;CACrE;AAED,sDAAsD;AACtD,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,OAAO,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,+CAA+C;AAC/C,MAAM,WAAW,wBAAwB;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC;IACtB,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,eAAe,CAAC,EAAE;QAChB,sDAAsD;QACtD,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,CAAC;QAC7C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;KAC7C,CAAC;CACH;AAED,6CAA6C;AAC7C,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE;QACN,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;KAC9B,EAAE,CAAC;IACJ,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,KAAK,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC;CACvB;AAED,gDAAgD;AAChD,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;CACrC;AAED,6CAA6C;AAC7C,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,eAAe,CAAC;CAC1B;AAED,oFAAoF;AACpF,MAAM,MAAM,UAAU,GAClB;IACE,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GACD;IAAE,aAAa,EAAE,MAAM,CAAC;IAAC,aAAa,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtD;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,EAAE,CAAC;IACd,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,kCAAkC;IAClC,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IACtC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yCAAyC;AACzC,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,mCAAmC;IACnC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE;QACd,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,GAAG,CAAC,EAAE,OAAO,CAAC;QACd,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;KACtB,CAAC;CACH;AAED,kCAAkC;AAClC,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EACD,SAAS,GACT,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,OAAO,GACP,SAAS,GACT,MAAM,GACN,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,QAAQ,CAAC;IACb,oEAAoE;IACpE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE;QAAE,EAAE,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;IAC7D,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAC1B,oCAAoC;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,mGAAmG;AACnG,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,wFAAwF;IACxF,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,wDAAwD;IACxD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,iDAAiD;AACjD,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IACtC,KAAK,EAAE,OAAO,GAAG,QAAQ,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IACvC,SAAS,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;CACvD;AAED,6FAA6F;AAC7F,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC;AAED,kCAAkC;AAClC,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAC3B;AAED,2CAA2C;AAC3C,MAAM,WAAW,IAAI;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE;QACP,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAC7C,EAAE,CAAC;IACJ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED,yCAAyC;AACzC,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAClC,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC;AAED,kDAAkD;AAClD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,UAAU,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAClC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC;AAED,oGAAoG;AACpG,MAAM,WAAW,cAAe,SAAQ,cAAc;IACpD,wFAAwF;IACxF,UAAU,CAAC,EAAE,MAAM,CACjB,MAAM,EACN;QACE,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CACF,CAAC;CACH;AAED,+CAA+C;AAC/C,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,gBAAgB,CAAC;CACnC;AAED,qCAAqC;AACrC,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IACtC,UAAU,EAAE,MAAM,CAAC;CACpB"}

package/dist/engine-api.js

@@ -0,0 +1,4 @@
+// The bodies and answers of the Engine API, with the names of its reference
+// (https://docs.docker.com/reference/api/engine/). Types only.
+export {};
+//# sourceMappingURL=engine-api.js.map

package/dist/engine-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine-api.js","sourceRoot":"","sources":["../src/engine-api.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,+DAA+D"}

package/dist/engine-client.d.ts

@@ -0,0 +1,74 @@
+import type { IncomingHttpHeaders, IncomingMessage } from 'node:http';
+import { type Duplex, Readable } from 'node:stream';
+import { DockerEngineError } from './errors.ts';
+import type { Filters } from './options.ts';
+import type { Transport } from './transport.ts';
+/** The query of a request. An array repeats the parameter; `filters` goes to the engine as JSON. */
+export type Query = Record<string, string | number | boolean | string[] | Filters | undefined>;
+export interface EngineRequestOptions {
+    query?: Query | undefined;
+    /** Goes to the engine as JSON. */
+    body?: unknown;
+    /** Goes to the engine as it is, with its media type, in place of a JSON body. */
+    content?: {
+        type: string;
+        data: Uint8Array | AsyncIterable<Uint8Array>;
+    } | undefined;
+    headers?: Record<string, string> | undefined;
+    signal?: AbortSignal | undefined;
+}
+export interface EngineResponse {
+    status: number;
+    headers: IncomingHttpHeaders;
+    body: Buffer;
+}
+/** A connection that the engine upgraded to a two-way stream of bytes. */
+export interface HijackedConnection {
+    /** The output of the engine, then the input to the engine. */
+    readonly socket: Duplex;
+    /** The bytes of the output that came with the answer, before the first read of the socket. */
+    readonly head: Buffer;
+    /** The Content-Type of the answer: application/vnd.docker.multiplexed-stream or application/vnd.docker.raw-stream. */
+    readonly contentType: string;
+    /** Ends the input through the end of input of the transport. The output stays open. */
+    endInput(): void;
+}
+/** True for a 2xx status. */
+export declare function isSuccess(response: EngineResponse): boolean;
+/** The JSON body of an answer. */
+export declare function parseBody<T>(response: EngineResponse): T;
+/** Sends requests of the Engine API to one engine. */
+export declare class EngineClient {
+    #private;
+    constructor(host: string, transport: Transport, apiVersion?: string, streams?: Set<Readable>, disposal?: AbortController);
+    /** The same engine and connections, with the API version in the path of each request. */
+    versioned(apiVersion: string): EngineClient;
+    /**
+     * Closes each connection, and resolves when each one is closed. A request
+     * in flight, a request that starts after close() started, and an iteration
+     * of a stream that is open reject with a DockerError that says that the
+     * client was disposed.
+     */
+    close(): Promise<void>;
+    /** Sends a request. A status that is not 2xx rejects with DockerEngineError. */
+    request(method: string, path: string, options?: EngineRequestOptions): Promise<EngineResponse>;
+    /** Sends a request and gives its JSON body. */
+    json<T>(method: string, path: string, options?: EngineRequestOptions): Promise<T>;
+    /** Sends a request and gives the answer with each status. */
+    exchange(method: string, path: string, options?: EngineRequestOptions): Promise<EngineResponse>;
+    /**
+     * Sends a request and gives the body of a 2xx answer as it comes. An abort
+     * of the signal rejects the read of the body with its reason. Each other
+     * status rejects with DockerEngineError.
+     */
+    stream(method: string, path: string, options?: EngineRequestOptions): Promise<IncomingMessage>;
+    /**
+     * Sends a request that the engine upgrades to a hijacked connection, for an
+     * attach and for the start of an exec. An answer without an upgrade
+     * rejects with DockerEngineError.
+     */
+    hijack(method: string, path: string, options?: EngineRequestOptions): Promise<HijackedConnection>;
+    /** The DockerEngineError of an answer that is not 2xx. */
+    error(response: EngineResponse, method: string, path: string): DockerEngineError;
+}
+//# sourceMappingURL=engine-client.d.ts.map

package/dist/engine-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine-client.d.ts","sourceRoot":"","sources":["../src/engine-client.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AACtE,OAAO,EAAE,KAAK,MAAM,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAGpD,OAAO,EAEL,iBAAiB,EAElB,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE5C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,oGAAoG;AACpG,MAAM,MAAM,KAAK,GAAG,MAAM,CACxB,MAAM,EACN,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,OAAO,GAAG,SAAS,CAC3D,CAAC;AAEF,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAC1B,kCAAkC;IAClC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,iFAAiF;IACjF,OAAO,CAAC,EACN;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,UAAU,GAAG,aAAa,CAAC,UAAU,CAAC,CAAA;KAAE,GAAG,SAAS,CAAC;IAC7E,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IAC7C,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;CAClC;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,mBAAmB,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,0EAA0E;AAC1E,MAAM,WAAW,kBAAkB;IACjC,8DAA8D;IAC9D,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,8FAA8F;IAC9F,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,sHAAsH;IACtH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,uFAAuF;IACvF,QAAQ,IAAI,IAAI,CAAC;CAClB;AAqDD,6BAA6B;AAC7B,wBAAgB,SAAS,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO,CAE3D;AAED,kCAAkC;AAClC,wBAAgB,SAAS,CAAC,CAAC,EAAE,QAAQ,EAAE,cAAc,GAAG,CAAC,CAGxD;AAQD,sDAAsD;AACtD,qBAAa,YAAY;;gBAcrB,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,SAAS,EACpB,UAAU,CAAC,EAAE,MAAM,EACnB,OAAO,gBAAsB,EAC7B,QAAQ,kBAAwB;IAWlC,yFAAyF;IACzF,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,YAAY;IAU3C;;;;;OAKG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAe5B,gFAAgF;IAC1E,OAAO,CACX,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,cAAc,CAAC;IAM1B,+CAA+C;IACzC,IAAI,CAAC,CAAC,EACV,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,CAAC,CAAC;IAIb,6DAA6D;IACvD,QAAQ,CACZ,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,cAAc,CAAC;IAS1B;;;;OAIG;IACG,MAAM,CACV,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,eAAe,CAAC;IAW3B;;;;OAIG;IACG,MAAM,CACV,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,kBAAkB,CAAC;IA6B9B,0DAA0D;IAC1D,KAAK,CACH,QAAQ,EAAE,cAAc,EACxB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,GACX,iBAAiB;CA0FrB"}