File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -101,3 +101,8 @@ examples/
101101smoke/
102102 */ smoke tests verifying published packages
103103```
104+
105+ ## Roadmap
106+
107+ See the project roadmap:
108+ https://github.com/dfsyncjs/dfsync/blob/main/ROADMAP.md
Original file line number Diff line number Diff line change 1+ # dfsync Roadmap
2+
3+ This document outlines the planned direction for ** dfsync** and its packages.
4+
5+ ## @dfsync/client
6+
7+ A lightweight HTTP client for reliable service-to-service communication.
8+
9+ ### 0.4.x — Request lifecycle
10+
11+ ** Focus** : request control and lifecycle management.
12+
13+ Planned features:
14+
15+ - AbortSignal support for request cancellation
16+ - request context object for passing metadata through lifecycle
17+ - correlation ID support (e.g. ` x-request-id ` )
18+ - improved hook context with additional execution details
19+
20+ ---
21+
22+ ### 0.5.x — Observability
23+
24+ ** Focus** : logging, monitoring, and request insights.
25+
26+ Planned features:
27+
28+ - request duration tracking
29+ - retry metadata (attempt number, delay, etc.)
30+ - support for ` Retry-After ` response header
31+ - retry lifecycle hooks (` onRetry ` )
32+
33+ ---
34+
35+ ### 0.6.x — Integration safety
36+
37+ ** Focus** : safer and more predictable integrations.
38+
39+ Planned features:
40+
41+ - response validation (custom or schema-based)
42+ - idempotency key support for safe retries
43+
44+ ### Notes
45+
46+ - Versions below ` 1.0.0 ` may introduce breaking changes.
47+ - The API will be stabilized before the ` 1.0.0 ` release.
48+ - The roadmap may evolve based on real-world usage and feedback.
Original file line number Diff line number Diff line change @@ -33,7 +33,7 @@ const client = createClient({
3333const users = await client .get (' /users' );
3434```
3535
36- ## Features
36+ ## Main features
3737
3838- typed responses
3939- request timeout support
@@ -59,9 +59,5 @@ A request in `@dfsync/client` follows this flow:
5959
6060## Roadmap
6161
62- The goal of dfsync is to become a reliable toolkit for service-to-service communication.
63-
64- Planned next steps:
65-
66- - Tracing support
67- - Extended hooks and observability features
62+ See the project roadmap:
63+ https://github.com/dfsyncjs/dfsync/blob/main/ROADMAP.md
You can’t perform that action at this time.
0 commit comments