Skip to content

Commit 39c2876

Browse files
authored
update roadmap (#60)
1 parent 879db69 commit 39c2876

File tree

1 file changed

+78
-7
lines changed

1 file changed

+78
-7
lines changed

ROADMAP.md

Lines changed: 78 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ Delivered:
2020

2121
### 0.6.x — Request lifecycle
2222

23-
**Focus**: request control and lifecycle management.
23+
Focus: request control and lifecycle management.
2424

2525
Status: completed
2626

2727
Delivered:
2828

29-
- AbortSignal support (extended and stabilized)
29+
- abortSignal support (extended and stabilized)
3030
- request context object for passing metadata through lifecycle
3131
- correlation ID support (`x-request-id` propagation across services)
3232
- improved hook context with additional execution details
@@ -35,7 +35,7 @@ Delivered:
3535

3636
### 0.7.x — Observability
3737

38-
**Focus**: logging, monitoring, and request insights.
38+
Focus: logging, monitoring, and request insights.
3939

4040
Status: completed
4141

@@ -51,15 +51,86 @@ Delivered:
5151

5252
### 0.8.x — Integration safety
5353

54-
**Focus**: safer and more predictable integrations.
54+
Focus: safer and more predictable integrations.
55+
56+
Status: in progress
5557

5658
Planned features:
5759

5860
- response validation (schema-based or custom)
5961
- idempotency key support for safe retries
6062

63+
### 0.9.x — Platform readiness & API stabilization
64+
65+
Focus: stabilizing core APIs, improving extensibility, and preparing dfsync for production-scale usage and future SaaS integration.
66+
67+
Planned features:
68+
69+
- stable validation API (finalized `responseSchema` contract)
70+
- validation adapters (starting with `zod`)
71+
- serializer / parser extensibility (custom request/response handling)
72+
- improved retry model:
73+
- retry budget (`maxElapsedMs`)
74+
- jitter support
75+
- advanced retry conditions
76+
- finalized error model:
77+
- `HttpError`
78+
- `NetworkError`
79+
- `TimeoutError`
80+
- `AbortError`
81+
- `ValidationError`
82+
- extended error metadata:
83+
- `requestId`
84+
- `attempt`
85+
- `duration`
86+
- optional response details
87+
- stable public extension interfaces:
88+
- telemetry exporter interface
89+
- auth provider interface
90+
- validation adapter interface
91+
- retry policy interface
92+
- operation naming support (`operationName` for requests)
93+
- documentation restructuring (use-case oriented)
94+
95+
### 1.0.x — Stable core & production readiness
96+
97+
Focus: delivering a stable, well-documented, and production-ready API with long-term support guarantees.
98+
99+
Planned features:
100+
101+
- stable and fully documented public API
102+
- finalized request lifecycle model
103+
- production-ready retry and timeout behavior
104+
- first-class validation support
105+
- stable and versioned extension interfaces
106+
- migration guide from 0.x
107+
- production best practices documentation:
108+
- retries
109+
- timeouts
110+
- idempotency
111+
- observability
112+
- compatibility guarantees (Node.js/runtime support)
113+
- improved examples:
114+
- internal APIs
115+
- external integrations
116+
- background jobs / workers
117+
118+
### Future direction — dfsync Cloud (SaaS)
119+
120+
Focus: extending dfsync as a platform with observability, control, and reliability tooling for service-to-service communication.
121+
122+
Planned areas:
123+
124+
- request observability dashboard (latency, errors, retries)
125+
- request tracing by `requestId`
126+
- integration health monitoring
127+
- centralized retry / timeout policy management
128+
- alerting (error spikes, high latency)
129+
- secure data handling (redaction / filtering)
130+
- telemetry ingestion and analytics
131+
61132
### Notes
62133

63-
- Versions below `1.0.0` may introduce breaking changes.
64-
- The API will be stabilized before the `1.0.0` release.
65-
- The roadmap may evolve based on real-world usage and feedback.
134+
- versions below `1.0.0` may introduce breaking changes.
135+
- the API will be stabilized before the `1.0.0` release.
136+
- the roadmap may evolve based on real-world usage and feedback.

0 commit comments

Comments
 (0)