mirror of
https://github.com/kennethnym/freya
synced 2026-06-19 08:01:17 +01:00
Kenneth
96e22e227c
Context keys are now tuples instead of strings, inspired by
React Query's query keys. This prevents context collisions
when multiple instances of the same source type are registered.
Sources write to structured keys like
["aris.google-calendar", "nextEvent", { account: "work" }]
and consumers can query by prefix via context.find().
Co-authored-by: Ona <no-reply@ona.com>
36 lines
1.0 KiB
TypeScript
36 lines
1.0 KiB
TypeScript
import type { Context } from "./context"
|
|
import type { FeedItem } from "./feed"
|
|
|
|
/**
|
|
* Produces feed items from an external source.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* type WeatherItem = FeedItem<"weather", { temp: number }>
|
|
*
|
|
* class WeatherDataSource implements DataSource<WeatherItem> {
|
|
* readonly type = "weather"
|
|
*
|
|
* async query(context: Context): Promise<WeatherItem[]> {
|
|
* const location = context.get(LocationKey)
|
|
* if (!location) return []
|
|
* const data = await fetchWeather(location)
|
|
* return [{
|
|
* id: `weather-${Date.now()}`,
|
|
* type: this.type,
|
|
* timestamp: context.time,
|
|
* data: { temp: data.temperature },
|
|
* signals: { urgency: 0.5, timeRelevance: "ambient" },
|
|
* }]
|
|
* }
|
|
* }
|
|
* ```
|
|
*/
|
|
export interface DataSource<TItem extends FeedItem = FeedItem, TConfig = unknown> {
|
|
/** Unique identifier for this source type */
|
|
readonly type: TItem["type"]
|
|
|
|
/** Queries the source and returns feed items */
|
|
query(context: Context, config: TConfig): Promise<TItem[]>
|
|
}
|