mirror of
https://github.com/kennethnym/aris.git
synced 2026-03-20 09:01:19 +00:00
kenneth
e6ca1763ef
Rename all references across the codebase: package names, imports, source IDs, directory names, docs, and configs. 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[]>
|
|
}
|