[v1] Roadmap

[z0al]

This is a meta-issue to track progress towards the first stable release of Oktane. It's worth mentioning that the order of tasks listed here is not relevant.

Before v1.0.0

Tasks

• Automatic fetching via useQuery
• Manual fetching via useManualQuery
• Prefetching (via client.prefetch)
• Request cancellation & refetching
• Helpers for infinite loading: hasMore and fetchMore.
• Support Subscriptions
• support refetching (acts like a the refresh button in the browser)
• support passing options to useQuery & useManualQuery
• Server Side Rendering (SSR)?
• Retrying failed requests
• React suspense support
• Pass AbortController signal to the fetch function to enable true Promise(s) cancellation.
• Throw an error if cache objects were mutated externally (e.g. in plugins, fetch handlers ..etc).
• Official plugins:
  • Optimistic updates
• Anything else? comment below.

Docs

• Public API docs
  • createClient
  • useQuery
  • useManualQuery
  • useClient
• Examples:
  • Basic
  • Pagination
  • Infinite loading
  • Subscription
  • Prefetching
  • Request cancellation
  • Using Observables
• Anything else? comment below.

A bit later (maybe)

• Provide Dev tooling support either by building from scratch or on the top of existing devtools.
• Make it easy to run the client inside a Web Worker by wrapping helpers from comlink.