@otterdeploy/docker 0.1.1 → 0.3.0

package/README.md

@@ -16,12 +16,15 @@ import { Docker } from "@otterdeploy/docker";
 // Auto-detect from DOCKER_HOST, DOCKER_TLS_VERIFY, etc.
 const docker = Docker.fromEnv();
 
-// List containers
+// List containers (check result)
 const result = await docker.containers.list({ all: true });
 if (result.isOk()) {
   console.log(result.value);
 }
 
+// Or unwrap directly (throws on error)
+const containers = (await docker.containers.list({ all: true })).unwrap();
+
 // Pull an image
 const stream = await docker.pull("nginx:latest");
 
@@ -41,14 +44,14 @@ Transports connect to the Docker daemon over different protocols.
 const docker = Docker.fromEnv();
 ```
 
-Reads `DOCKER_HOST`, `DOCKER_TLS_VERIFY`, `DOCKER_CERT_PATH`, and `DOCKER_CLIENT_TIMEOUT`.
+Reads `DOCKER_HOST`, `DOCKER_TLS_VERIFY`, `DOCKER_CERT_PATH`, and `DOCKER_CLIENT_TIMEOUT`. Defaults to API version `v1.47`.
 
 ### Unix Socket (default)
 
 ```ts
 const docker = new Docker({
   transport: { type: "unix", socketPath: "/var/run/docker.sock" },
-  apiVersion: "v1.53",
+  apiVersion: "v1.47",
 });
 ```
 
@@ -66,7 +69,7 @@ const docker = new Docker({
       key: fs.readFileSync("/certs/key.pem"),
     },
   },
-  apiVersion: "v1.53",
+  apiVersion: "v1.47",
 });
 ```
 
@@ -81,22 +84,24 @@ const docker = new Docker({
     username: "deploy",
     privateKey: fs.readFileSync("~/.ssh/id_rsa", "utf8"),
   },
-  apiVersion: "v1.53",
+  apiVersion: "v1.47",
 });
 ```
 
+> **Note:** SSH transport does not support interactive `exec` or `attach` operations (i.e., `dialHijack`). These require a direct connection upgrade that is not possible over SSH tunnels. Use Unix socket or TCP transport for interactive container sessions.
+
 ### Windows Named Pipes
 
 ```ts
 const docker = new Docker({
   transport: { type: "npipe", path: "//./pipe/docker_engine" },
-  apiVersion: "v1.53",
+  apiVersion: "v1.47",
 });
 ```
 
 ## API Reference
 
-All methods return `Result<T, DockerError>` from [better-result](https://github.com/niconiahi/better-result). Use `isOk()` / `isErr()` for type-safe error handling.
+All methods return `Result<T, DockerError>` from [better-result](https://github.com/niconiahi/better-result). Use `isOk()` / `isErr()` for type-safe error handling, or `.unwrap()` to get the value directly (throws on error).
 
 ### Containers
 
@@ -224,8 +229,18 @@ await docker.system.pruneBuilder({ all: true });
 ```ts
 // Services
 const services = await docker.services.list();
-const service = await docker.services.create({ Name: "web", TaskTemplate: { /* ... */ } });
-await service.update({ version: 1, spec: { /* ... */ } });
+const service = await docker.services.create({
+  Name: "web",
+  TaskTemplate: {
+    /* ... */
+  },
+});
+await service.update({
+  version: 1,
+  spec: {
+    /* ... */
+  },
+});
 await service.logs({ stdout: true });
 await service.remove();
 
@@ -294,6 +309,12 @@ if (result.isErr()) {
 }
 ```
 
+If you prefer exceptions, use `.unwrap()` to get the value directly or throw on error:
+
+```ts
+const info = (await container.inspect()).unwrap(); // throws DockerError on failure
+```
+
 Error types: `DockerBadRequestError`, `DockerUnauthorizedError`, `DockerForbiddenError`, `DockerNotFoundError`, `DockerConflictError`, `DockerServerError`, `DockerServiceUnavailableError`, `DockerNetworkError`, `DockerTimeoutError`, `DockerAbortError`.
 
 ## BuildKit Sessions
@@ -303,22 +324,12 @@ For BuildKit v2 builds with registry authentication:
 ```ts
 import { withSession } from "@otterdeploy/docker";
 
-const session = await withSession(transport, "v1.53", {
+const session = await withSession(transport, "v1.47", {
   username: "user",
   password: "pass",
 });
 ```
 
-## Scripts
-
-```bash
-bun run build          # Build with tsdown
-bun test               # Run tests
-bun run lint           # Lint with oxlint
-bun run format         # Format with oxfmt
-bun run typecheck      # Type check
-```
-
 ## License
 
 MIT

package/dist/index.d.mts

@@ -2007,5 +2007,4 @@ type SessionResult = {
  */
 declare function withSession(transport: Transport, apiVersion: string, auth?: AuthConfig): Promise<Result<SessionResult, DockerError>>;
 //#endregion
-export { type ArchiveInfo, type AuthConfig, type AuthResponse, type BuildOptions, type BuilderPruneOptions, type BuilderPruneResponse, type CheckpointCreateOptions, type Config, type ConfigCreateOptions, ConfigEntity, type ConfigListOptions, ConfigOperations, type ConfigSpec, type ConfigUpdateOptions, Container, type ContainerArchiveOptions, type ContainerAttachOptions, type ContainerChange, type ContainerCommitOptions, type ContainerConfig, type ContainerInspect, type ContainerKillOptions, type ContainerListOptions, ContainerOperations, type ContainerPruneOptions, type ContainerRemoveOptions, type ContainerResizeOptions, type ContainerRestartOptions, type ContainerState, type ContainerStats, type ContainerStatsOptions, type ContainerStopOptions, type ContainerSummary, type ContainerTopResponse, type ContainerUpdateOptions, type ContainerUpdateResponse, type ContainerWaitOptions, type CreateContainerOptions, type CreateContainerResponse, type CreateImageOptions, type CreateVolumeOptions, type DialOptions, type DialResponse, Docker, DockerAbortError, type DockerApiError, DockerBadRequestError, type DockerConfig, DockerConflictError, DockerDecodeError, type DockerError, DockerForbiddenError, type DockerInfo, DockerNetworkError, DockerNotFoundError, DockerServerError, DockerServiceUnavailableError, DockerStream, DockerTimeoutError, type DockerTransportError, DockerUnauthorizedError, DockerUnknownError, type DockerVersion, type EndpointIPAMConfig, type EndpointPortConfig, type EndpointSettings, type EndpointSpec, type EventActor, type EventMessage, type EventsOptions, Exec, type ExecCreateOptions, type ExecInspect, type ExecStartOptions, type ExecStartWithStdinOptions, type Filters, type HealthConfig, type HostConfig, HttpDuplex, type HttpMethod, type IPAM, type IdResponse, Image, type ImageConfig, type ImageDeleteResponseItem, type ImageHistory, type ImageImportOptions, type ImageInspect, type ImageListOptions, ImageOperations, type ImagePruneOptions, type ImagePushOptions, type ImageRemoveOptions, type ImageSearchOptions, type ImageSummary, type ImageTagOptions, type LogsOptions, type Mount, type MountPoint, NamedPipeTransport, type Network, type NetworkConnectOptions, type NetworkCreateOptions, type NetworkCreateResponse, type NetworkDisconnectOptions, NetworkEntity, type NetworkListOptions, NetworkOperations, type NetworkPruneOptions, type NetworkSettings, type NetworkingConfig, type Node, NodeEntity, type NodeListOptions, NodeOperations, type NodeRemoveOptions, type NodeSpec, type NodeUpdateOptions, type ObjectVersion, type Plugin, type PluginConfigureOptions, type PluginCreateOptions, type PluginDisableOptions, type PluginEnableOptions, PluginEntity, type PluginInstallOptions, type PluginListOptions, PluginOperations, type PluginPrivilege, type PluginPrivilegesOptions, type PluginRemoveOptions, type PluginUpgradeOptions, type Port, type PortBinding, type PruneResponse, type PullOptions, type RestartPolicy, type RunOptions, type RunResult, type SearchResult, type Secret, type SecretCreateOptions, SecretEntity, type SecretListOptions, SecretOperations, type SecretSpec, type SecretUpdateOptions, type Service, type ServiceCreateOptions, type ServiceCreateResponse, ServiceEntity, type ServiceListOptions, ServiceOperations, type ServiceSpec, type ServiceUpdateConfig, type ServiceUpdateOptions, type ServiceUpdateResponse, type SessionResult, type StatusCodeMap, type SwarmInitOptions, type SwarmJoinOptions, type SwarmLeaveOptions, type SwarmUpdateOptions, type SystemDf, SystemOperations, type Task, TaskEntity, type TaskListOptions, TaskOperations, type TlsConfig, type Transport, type TransportConfig, type Volume, VolumeEntity, type VolumeListOptions, type VolumeListResponse, VolumeOperations, type VolumePruneOptions, type VolumeRemoveOptions, type WaitResponse, createTransport, createTransportFromEnv, demuxStream, followProgress, statusCodeToError, withSession };
-//# sourceMappingURL=index.d.mts.map
+export { type ArchiveInfo, type AuthConfig, type AuthResponse, type BuildOptions, type BuilderPruneOptions, type BuilderPruneResponse, type CheckpointCreateOptions, type Config, type ConfigCreateOptions, ConfigEntity, type ConfigListOptions, ConfigOperations, type ConfigSpec, type ConfigUpdateOptions, Container, type ContainerArchiveOptions, type ContainerAttachOptions, type ContainerChange, type ContainerCommitOptions, type ContainerConfig, type ContainerInspect, type ContainerKillOptions, type ContainerListOptions, ContainerOperations, type ContainerPruneOptions, type ContainerRemoveOptions, type ContainerResizeOptions, type ContainerRestartOptions, type ContainerState, type ContainerStats, type ContainerStatsOptions, type ContainerStopOptions, type ContainerSummary, type ContainerTopResponse, type ContainerUpdateOptions, type ContainerUpdateResponse, type ContainerWaitOptions, type CreateContainerOptions, type CreateContainerResponse, type CreateImageOptions, type CreateVolumeOptions, type DialOptions, type DialResponse, Docker, DockerAbortError, type DockerApiError, DockerBadRequestError, type DockerConfig, DockerConflictError, DockerDecodeError, type DockerError, DockerForbiddenError, type DockerInfo, DockerNetworkError, DockerNotFoundError, DockerServerError, DockerServiceUnavailableError, DockerStream, DockerTimeoutError, type DockerTransportError, DockerUnauthorizedError, DockerUnknownError, type DockerVersion, type EndpointIPAMConfig, type EndpointPortConfig, type EndpointSettings, type EndpointSpec, type EventActor, type EventMessage, type EventsOptions, Exec, type ExecCreateOptions, type ExecInspect, type ExecStartOptions, type ExecStartWithStdinOptions, type Filters, type HealthConfig, type HostConfig, HttpDuplex, type HttpMethod, type IPAM, type IdResponse, Image, type ImageConfig, type ImageDeleteResponseItem, type ImageHistory, type ImageImportOptions, type ImageInspect, type ImageListOptions, ImageOperations, type ImagePruneOptions, type ImagePushOptions, type ImageRemoveOptions, type ImageSearchOptions, type ImageSummary, type ImageTagOptions, type LogsOptions, type Mount, type MountPoint, NamedPipeTransport, type Network, type NetworkConnectOptions, type NetworkCreateOptions, type NetworkCreateResponse, type NetworkDisconnectOptions, NetworkEntity, type NetworkListOptions, NetworkOperations, type NetworkPruneOptions, type NetworkSettings, type NetworkingConfig, type Node, NodeEntity, type NodeListOptions, NodeOperations, type NodeRemoveOptions, type NodeSpec, type NodeUpdateOptions, type ObjectVersion, type Plugin, type PluginConfigureOptions, type PluginCreateOptions, type PluginDisableOptions, type PluginEnableOptions, PluginEntity, type PluginInstallOptions, type PluginListOptions, PluginOperations, type PluginPrivilege, type PluginPrivilegesOptions, type PluginRemoveOptions, type PluginUpgradeOptions, type Port, type PortBinding, type PruneResponse, type PullOptions, type RestartPolicy, type RunOptions, type RunResult, type SearchResult, type Secret, type SecretCreateOptions, SecretEntity, type SecretListOptions, SecretOperations, type SecretSpec, type SecretUpdateOptions, type Service, type ServiceCreateOptions, type ServiceCreateResponse, ServiceEntity, type ServiceListOptions, ServiceOperations, type ServiceSpec, type ServiceUpdateConfig, type ServiceUpdateOptions, type ServiceUpdateResponse, type SessionResult, type StatusCodeMap, type SwarmInitOptions, type SwarmJoinOptions, type SwarmLeaveOptions, type SwarmUpdateOptions, type SystemDf, SystemOperations, type Task, TaskEntity, type TaskListOptions, TaskOperations, type TlsConfig, type Transport, type TransportConfig, type Volume, VolumeEntity, type VolumeListOptions, type VolumeListResponse, VolumeOperations, type VolumePruneOptions, type VolumeRemoveOptions, type WaitResponse, createTransport, createTransportFromEnv, demuxStream, followProgress, statusCodeToError, withSession };