Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 15e5dedae4 | |||
| 5834721da8 | |||
| 2f31e14cbe | |||
| 5691e5fb78 |
18
changelog.md
18
changelog.md
@@ -1,5 +1,23 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## 2025-11-24 - 3.0.2 - fix(readme)
|
||||||
|
Update README to document 3.0.0+ changes: architecture refactor, streaming improvements, health check and circular dependency fixes
|
||||||
|
|
||||||
|
- Documented major refactor to a Clean OOP / Facade pattern with DockerHost as the single entry point
|
||||||
|
- Added/clarified real-time container streaming APIs: streamLogs(), attach(), exec()
|
||||||
|
- Clarified support for flexible descriptors (accept both string references and class instances)
|
||||||
|
- Documented complete container lifecycle API (start, stop, remove, logs, inspect, stats)
|
||||||
|
- Documented new ping() health check method to verify Docker daemon availability
|
||||||
|
- Noted fix for circular dependency issues in Node.js by using type-only imports
|
||||||
|
- Mentioned improved TypeScript definitions and expanded examples, migration guides, and real-world use cases
|
||||||
|
|
||||||
|
## 2025-11-24 - 3.0.1 - fix(classes.base)
|
||||||
|
Use type-only import for DockerHost in classes.base to avoid runtime side-effects
|
||||||
|
|
||||||
|
- Changed the import in ts/classes.base.ts to a type-only import: import type { DockerHost } from './classes.host.js';
|
||||||
|
- Prevents a runtime import of classes.host when only the type is needed, reducing risk of circular dependencies and unintended side-effects during module initialization.
|
||||||
|
- No behavior changes to the public API — TypeScript-only change; intended to improve bundling and runtime stability.
|
||||||
|
|
||||||
## 2025-11-24 - 3.0.0 - BREAKING CHANGE(DockerHost)
|
## 2025-11-24 - 3.0.0 - BREAKING CHANGE(DockerHost)
|
||||||
Refactor public API to DockerHost facade; introduce DockerResource base; make resource static methods internal; support flexible descriptors and stream compatibility
|
Refactor public API to DockerHost facade; introduce DockerResource base; make resource static methods internal; support flexible descriptors and stream compatibility
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@apiclient.xyz/docker",
|
"name": "@apiclient.xyz/docker",
|
||||||
"version": "3.0.0",
|
"version": "3.0.2",
|
||||||
"description": "Provides easy communication with Docker remote API from Node.js, with TypeScript support.",
|
"description": "Provides easy communication with Docker remote API from Node.js, with TypeScript support.",
|
||||||
"private": false,
|
"private": false,
|
||||||
"main": "dist_ts/index.js",
|
"main": "dist_ts/index.js",
|
||||||
|
|||||||
16
readme.md
16
readme.md
@@ -904,15 +904,17 @@ async function healthCheckService() {
|
|||||||
|
|
||||||
## 🆕 Recent Updates
|
## 🆕 Recent Updates
|
||||||
|
|
||||||
### Version 2.1.0 - Architecture & Features
|
### Version 3.0.0+ - Architecture & Stability
|
||||||
|
|
||||||
- ✨ **Clean OOP Architecture**: Refactored to Facade pattern with DockerHost as single entry point
|
- ✨ **Clean OOP Architecture**: Refactored to Facade pattern with DockerHost as single entry point
|
||||||
- ✨ **Container Streaming**: Added `streamLogs()`, `attach()`, and `exec()` methods
|
- ✨ **Container Streaming**: Real-time `streamLogs()`, `attach()`, and `exec()` methods for interactive containers
|
||||||
- ✨ **Flexible Descriptors**: Support both string references and class instances
|
- ✨ **Flexible Descriptors**: Support both string references and class instances in all creation methods
|
||||||
- ✨ **Complete Container API**: All lifecycle methods (start, stop, remove, logs, inspect, stats)
|
- ✨ **Complete Container API**: Full lifecycle methods (start, stop, remove, logs, inspect, stats)
|
||||||
- ✨ **DockerResource Base Class**: Consistent patterns across all resources
|
- ✨ **DockerResource Base Class**: Consistent patterns and type safety across all resources
|
||||||
- 🔧 **Improved Type Safety**: Better TypeScript definitions throughout
|
- ✨ **Health Check Support**: New `ping()` method to verify Docker daemon availability
|
||||||
- 📚 **Enhanced Documentation**: Comprehensive examples and migration guides
|
- 🐛 **Fixed Circular Dependencies**: Resolved Node.js module loading issues with type-only imports
|
||||||
|
- 🔧 **Improved Type Safety**: Better TypeScript definitions and interfaces throughout
|
||||||
|
- 📚 **Enhanced Documentation**: Comprehensive examples, migration guides, and real-world use cases
|
||||||
|
|
||||||
## License and Legal Information
|
## License and Legal Information
|
||||||
|
|
||||||
|
|||||||
@@ -3,6 +3,6 @@
|
|||||||
*/
|
*/
|
||||||
export const commitinfo = {
|
export const commitinfo = {
|
||||||
name: '@apiclient.xyz/docker',
|
name: '@apiclient.xyz/docker',
|
||||||
version: '3.0.0',
|
version: '3.0.2',
|
||||||
description: 'Provides easy communication with Docker remote API from Node.js, with TypeScript support.'
|
description: 'Provides easy communication with Docker remote API from Node.js, with TypeScript support.'
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { DockerHost } from './classes.host.js';
|
import type { DockerHost } from './classes.host.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Abstract base class for all Docker resources.
|
* Abstract base class for all Docker resources.
|
||||||
|
|||||||
Reference in New Issue
Block a user