Compare commits
23 Commits
feat/apple
...
refactor/r
| Author | SHA1 | Date | |
|---|---|---|---|
|
963bf073d1
|
|||
| c0b3db0e11 | |||
|
ca4a337dcd
|
|||
| 1ade63dd8c | |||
|
8df340d9af
|
|||
|
727280e8b1
|
|||
| d30f70494b | |||
| 413a57c156 | |||
|
d9625198d6
|
|||
| 959167a93c | |||
|
3ebb47c5ab
|
|||
| cd29a60bab | |||
|
2f082b5833
|
|||
| f987253e53 | |||
|
699155e0d8
|
|||
| 4d6cac7ec8 | |||
|
1f2920a7ad
|
|||
| 476c6f06d9 | |||
|
bfdc5e67b7
|
|||
|
2cf6536e48
|
|||
|
c7a1048320
|
|||
|
512faf191e
|
|||
| e5d65816dc |
@@ -11,12 +11,12 @@
|
||||
"dockerfile": "Dockerfile"
|
||||
},
|
||||
"postCreateCommand": "bun install",
|
||||
"postStartCommand": "./scripts/setup-git.sh && ./scripts/setup-nvim.sh"
|
||||
"postStartCommand": "./scripts/setup-git.sh && ./scripts/setup-nvim.sh",
|
||||
// Features add additional features to your environment. See https://containers.dev/features
|
||||
// Beware: features are not supported on all platforms and may have unintended side-effects.
|
||||
// "features": {
|
||||
// "ghcr.io/devcontainers/features/docker-in-docker": {
|
||||
// "moby": false
|
||||
// }
|
||||
// }
|
||||
"features": {
|
||||
"ghcr.io/tailscale/codespace/tailscale": {
|
||||
"version": "latest"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
1
.gitignore
vendored
@@ -32,3 +32,4 @@ report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
|
||||
|
||||
# Finder (MacOS) folder config
|
||||
.DS_Store
|
||||
core
|
||||
|
||||
8
.ona/automations.yaml
Normal file
@@ -0,0 +1,8 @@
|
||||
services:
|
||||
expo:
|
||||
name: Expo Dev Server
|
||||
description: Expo development server for aris-client
|
||||
triggeredBy:
|
||||
- postDevcontainerStart
|
||||
commands:
|
||||
start: cd apps/aris-client && ./scripts/run-dev-server.sh
|
||||
@@ -13,8 +13,6 @@
|
||||
"@aris/source-location": "workspace:*",
|
||||
"@aris/source-tfl": "workspace:*",
|
||||
"@aris/source-weatherkit": "workspace:*",
|
||||
"@hono/trpc-server": "^0.3",
|
||||
"@trpc/server": "^11",
|
||||
"arktype": "^2.1.29",
|
||||
"better-auth": "^1",
|
||||
"hono": "^4",
|
||||
|
||||
@@ -1,13 +1,16 @@
|
||||
import type { Context, Next } from "hono"
|
||||
|
||||
import type { AuthSession, AuthUser } from "./session.ts"
|
||||
|
||||
import { auth } from "./index.ts"
|
||||
|
||||
type SessionUser = typeof auth.$Infer.Session.user
|
||||
type Session = typeof auth.$Infer.Session.session
|
||||
|
||||
export interface SessionVariables {
|
||||
user: SessionUser | null
|
||||
session: Session | null
|
||||
user: AuthUser | null
|
||||
session: AuthSession | null
|
||||
}
|
||||
|
||||
declare module "hono" {
|
||||
interface ContextVariableMap extends SessionVariables {}
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -48,7 +51,7 @@ export async function requireSession(c: Context, next: Next): Promise<Response |
|
||||
*/
|
||||
export async function getSessionFromHeaders(
|
||||
headers: Headers,
|
||||
): Promise<{ user: SessionUser; session: Session } | null> {
|
||||
): Promise<{ user: AuthUser; session: AuthSession } | null> {
|
||||
const session = await auth.api.getSession({ headers })
|
||||
return session
|
||||
}
|
||||
|
||||
4
apps/aris-backend/src/auth/session.ts
Normal file
@@ -0,0 +1,4 @@
|
||||
import type { auth } from "./index.ts"
|
||||
|
||||
export type AuthUser = typeof auth.$Infer.Session.user
|
||||
export type AuthSession = typeof auth.$Infer.Session.session
|
||||
@@ -1,162 +0,0 @@
|
||||
import { describe, expect, mock, test } from "bun:test"
|
||||
|
||||
import { LocationService } from "../location/service.ts"
|
||||
import { FeedEngineService } from "./service.ts"
|
||||
|
||||
describe("FeedEngineService", () => {
|
||||
test("engineForUser creates engine on first call", () => {
|
||||
const locationService = new LocationService()
|
||||
const service = new FeedEngineService([locationService])
|
||||
|
||||
const engine = service.engineForUser("user-1")
|
||||
|
||||
expect(engine).toBeDefined()
|
||||
})
|
||||
|
||||
test("engineForUser returns same engine for same user", () => {
|
||||
const locationService = new LocationService()
|
||||
const service = new FeedEngineService([locationService])
|
||||
|
||||
const engine1 = service.engineForUser("user-1")
|
||||
const engine2 = service.engineForUser("user-1")
|
||||
|
||||
expect(engine1).toBe(engine2)
|
||||
})
|
||||
|
||||
test("engineForUser returns different engines for different users", () => {
|
||||
const locationService = new LocationService()
|
||||
const service = new FeedEngineService([locationService])
|
||||
|
||||
const engine1 = service.engineForUser("user-1")
|
||||
const engine2 = service.engineForUser("user-2")
|
||||
|
||||
expect(engine1).not.toBe(engine2)
|
||||
})
|
||||
|
||||
test("engineForUser registers sources from all providers", async () => {
|
||||
const locationService = new LocationService()
|
||||
const service = new FeedEngineService([locationService])
|
||||
|
||||
const engine = service.engineForUser("user-1")
|
||||
const result = await engine.refresh()
|
||||
|
||||
expect(result.errors).toHaveLength(0)
|
||||
})
|
||||
|
||||
test("engineForUser works with empty providers array", async () => {
|
||||
const service = new FeedEngineService([])
|
||||
|
||||
const engine = service.engineForUser("user-1")
|
||||
const result = await engine.refresh()
|
||||
|
||||
expect(result.errors).toHaveLength(0)
|
||||
expect(result.items).toHaveLength(0)
|
||||
})
|
||||
|
||||
test("refresh returns feed result", async () => {
|
||||
const locationService = new LocationService()
|
||||
const service = new FeedEngineService([locationService])
|
||||
|
||||
const result = await service.refresh("user-1")
|
||||
|
||||
expect(result).toHaveProperty("context")
|
||||
expect(result).toHaveProperty("items")
|
||||
expect(result).toHaveProperty("errors")
|
||||
expect(result.context.time).toBeInstanceOf(Date)
|
||||
})
|
||||
|
||||
test("refresh uses location from LocationService", async () => {
|
||||
const locationService = new LocationService()
|
||||
const service = new FeedEngineService([locationService])
|
||||
const location = {
|
||||
lat: 51.5074,
|
||||
lng: -0.1278,
|
||||
accuracy: 10,
|
||||
timestamp: new Date(),
|
||||
}
|
||||
|
||||
// Create engine first, then update location
|
||||
service.engineForUser("user-1")
|
||||
locationService.updateUserLocation("user-1", location)
|
||||
|
||||
const result = await service.refresh("user-1")
|
||||
|
||||
expect(result.context.location).toEqual(location)
|
||||
})
|
||||
|
||||
test("subscribe receives updates", async () => {
|
||||
const locationService = new LocationService()
|
||||
const service = new FeedEngineService([locationService])
|
||||
const callback = mock()
|
||||
|
||||
service.subscribe("user-1", callback)
|
||||
|
||||
// Push location to trigger update
|
||||
locationService.updateUserLocation("user-1", {
|
||||
lat: 51.5074,
|
||||
lng: -0.1278,
|
||||
accuracy: 10,
|
||||
timestamp: new Date(),
|
||||
})
|
||||
|
||||
// Wait for async update propagation
|
||||
await new Promise((resolve) => setTimeout(resolve, 10))
|
||||
|
||||
expect(callback).toHaveBeenCalled()
|
||||
})
|
||||
|
||||
test("subscribe returns unsubscribe function", async () => {
|
||||
const locationService = new LocationService()
|
||||
const service = new FeedEngineService([locationService])
|
||||
const callback = mock()
|
||||
|
||||
const unsubscribe = service.subscribe("user-1", callback)
|
||||
|
||||
unsubscribe()
|
||||
|
||||
locationService.updateUserLocation("user-1", {
|
||||
lat: 51.5074,
|
||||
lng: -0.1278,
|
||||
accuracy: 10,
|
||||
timestamp: new Date(),
|
||||
})
|
||||
|
||||
await new Promise((resolve) => setTimeout(resolve, 10))
|
||||
|
||||
expect(callback).not.toHaveBeenCalled()
|
||||
})
|
||||
|
||||
test("removeUser stops engine and removes it", async () => {
|
||||
const locationService = new LocationService()
|
||||
const service = new FeedEngineService([locationService])
|
||||
const callback = mock()
|
||||
|
||||
service.subscribe("user-1", callback)
|
||||
|
||||
service.removeUser("user-1")
|
||||
|
||||
// Push location - should not trigger update since engine is stopped
|
||||
locationService.feedSourceForUser("user-1")
|
||||
locationService.updateUserLocation("user-1", {
|
||||
lat: 51.5074,
|
||||
lng: -0.1278,
|
||||
accuracy: 10,
|
||||
timestamp: new Date(),
|
||||
})
|
||||
|
||||
await new Promise((resolve) => setTimeout(resolve, 10))
|
||||
|
||||
expect(callback).not.toHaveBeenCalled()
|
||||
})
|
||||
|
||||
test("removeUser allows new engine to be created", () => {
|
||||
const locationService = new LocationService()
|
||||
const service = new FeedEngineService([locationService])
|
||||
|
||||
const engine1 = service.engineForUser("user-1")
|
||||
service.removeUser("user-1")
|
||||
const engine2 = service.engineForUser("user-1")
|
||||
|
||||
expect(engine1).not.toBe(engine2)
|
||||
})
|
||||
})
|
||||
@@ -1,75 +0,0 @@
|
||||
import { FeedEngine, type FeedResult, type FeedSource, type FeedSubscriber } from "@aris/core"
|
||||
|
||||
/**
|
||||
* Provides a FeedSource instance for a user.
|
||||
*/
|
||||
export interface FeedSourceProvider {
|
||||
feedSourceForUser(userId: string): FeedSource
|
||||
}
|
||||
|
||||
/**
|
||||
* Manages FeedEngine instances per user.
|
||||
*
|
||||
* Receives FeedSource instances from injected providers and wires them
|
||||
* into per-user engines. Engines are auto-started on creation.
|
||||
*/
|
||||
export class FeedEngineService {
|
||||
private engines = new Map<string, FeedEngine>()
|
||||
|
||||
constructor(private readonly providers: FeedSourceProvider[]) {}
|
||||
|
||||
/**
|
||||
* Get or create a FeedEngine for a user.
|
||||
* Automatically registers sources and starts the engine.
|
||||
*/
|
||||
engineForUser(userId: string): FeedEngine {
|
||||
let engine = this.engines.get(userId)
|
||||
if (!engine) {
|
||||
engine = this.createEngine(userId)
|
||||
this.engines.set(userId, engine)
|
||||
}
|
||||
return engine
|
||||
}
|
||||
|
||||
/**
|
||||
* Refresh a user's feed.
|
||||
*/
|
||||
async refresh(userId: string): Promise<FeedResult> {
|
||||
const engine = this.engineForUser(userId)
|
||||
return engine.refresh()
|
||||
}
|
||||
|
||||
/**
|
||||
* Subscribe to feed updates for a user.
|
||||
* Returns unsubscribe function.
|
||||
*/
|
||||
subscribe(userId: string, callback: FeedSubscriber): () => void {
|
||||
const engine = this.engineForUser(userId)
|
||||
return engine.subscribe(callback)
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove a user's FeedEngine.
|
||||
* Stops the engine and cleans up resources.
|
||||
*/
|
||||
removeUser(userId: string): void {
|
||||
const engine = this.engines.get(userId)
|
||||
if (engine) {
|
||||
engine.stop()
|
||||
this.engines.delete(userId)
|
||||
}
|
||||
}
|
||||
|
||||
private createEngine(userId: string): FeedEngine {
|
||||
const engine = new FeedEngine()
|
||||
|
||||
for (const provider of this.providers) {
|
||||
const source = provider.feedSourceForUser(userId)
|
||||
engine.register(source)
|
||||
}
|
||||
|
||||
engine.start()
|
||||
|
||||
return engine
|
||||
}
|
||||
}
|
||||
56
apps/aris-backend/src/location/http.ts
Normal file
@@ -0,0 +1,56 @@
|
||||
import type { Context, Hono } from "hono"
|
||||
|
||||
import { type } from "arktype"
|
||||
import { createMiddleware } from "hono/factory"
|
||||
|
||||
import type { UserSessionManager } from "../session/index.ts"
|
||||
|
||||
import { requireSession } from "../auth/session-middleware.ts"
|
||||
|
||||
type Env = { Variables: { sessionManager: UserSessionManager } }
|
||||
|
||||
const locationInput = type({
|
||||
lat: "number",
|
||||
lng: "number",
|
||||
accuracy: "number",
|
||||
timestamp: "string.date.iso",
|
||||
})
|
||||
|
||||
export function registerLocationHttpHandlers(
|
||||
app: Hono,
|
||||
{ sessionManager }: { sessionManager: UserSessionManager },
|
||||
) {
|
||||
const inject = createMiddleware<Env>(async (c, next) => {
|
||||
c.set("sessionManager", sessionManager)
|
||||
await next()
|
||||
})
|
||||
|
||||
app.post("/api/location", inject, requireSession, handleUpdateLocation)
|
||||
}
|
||||
|
||||
async function handleUpdateLocation(c: Context<Env>) {
|
||||
let body: unknown
|
||||
try {
|
||||
body = await c.req.json()
|
||||
} catch {
|
||||
return c.json({ error: "Invalid JSON" }, 400)
|
||||
}
|
||||
|
||||
const result = locationInput(body)
|
||||
|
||||
if (result instanceof type.errors) {
|
||||
return c.json({ error: result.summary }, 400)
|
||||
}
|
||||
|
||||
const user = c.get("user")!
|
||||
const sessionManager = c.get("sessionManager")
|
||||
const session = sessionManager.getOrCreate(user.id)
|
||||
await session.engine.executeAction("aris.location", "update-location", {
|
||||
lat: result.lat,
|
||||
lng: result.lng,
|
||||
accuracy: result.accuracy,
|
||||
timestamp: new Date(result.timestamp),
|
||||
})
|
||||
|
||||
return c.body(null, 204)
|
||||
}
|
||||
@@ -1,37 +0,0 @@
|
||||
import { TRPCError } from "@trpc/server"
|
||||
import { type } from "arktype"
|
||||
|
||||
import type { TRPC } from "../trpc/router.ts"
|
||||
import type { LocationService } from "./service.ts"
|
||||
|
||||
import { UserNotFoundError } from "../lib/error.ts"
|
||||
|
||||
const locationInput = type({
|
||||
lat: "number",
|
||||
lng: "number",
|
||||
accuracy: "number",
|
||||
timestamp: "Date",
|
||||
})
|
||||
|
||||
export function createLocationRouter(
|
||||
t: TRPC,
|
||||
{ locationService }: { locationService: LocationService },
|
||||
) {
|
||||
return t.router({
|
||||
update: t.procedure.input(locationInput).mutation(({ input, ctx }) => {
|
||||
try {
|
||||
locationService.updateUserLocation(ctx.user.id, {
|
||||
lat: input.lat,
|
||||
lng: input.lng,
|
||||
accuracy: input.accuracy,
|
||||
timestamp: input.timestamp,
|
||||
})
|
||||
} catch (error) {
|
||||
if (error instanceof UserNotFoundError) {
|
||||
throw new TRPCError({ code: "NOT_FOUND", message: error.message })
|
||||
}
|
||||
throw error
|
||||
}
|
||||
}),
|
||||
})
|
||||
}
|
||||
@@ -1,111 +0,0 @@
|
||||
import { describe, expect, test } from "bun:test"
|
||||
|
||||
import { UserNotFoundError } from "../lib/error.ts"
|
||||
import { LocationService } from "./service.ts"
|
||||
|
||||
describe("LocationService", () => {
|
||||
test("feedSourceForUser creates source on first call", () => {
|
||||
const service = new LocationService()
|
||||
const source = service.feedSourceForUser("user-1")
|
||||
|
||||
expect(source).toBeDefined()
|
||||
expect(source.id).toBe("location")
|
||||
})
|
||||
|
||||
test("feedSourceForUser returns same source for same user", () => {
|
||||
const service = new LocationService()
|
||||
const source1 = service.feedSourceForUser("user-1")
|
||||
const source2 = service.feedSourceForUser("user-1")
|
||||
|
||||
expect(source1).toBe(source2)
|
||||
})
|
||||
|
||||
test("feedSourceForUser returns different sources for different users", () => {
|
||||
const service = new LocationService()
|
||||
const source1 = service.feedSourceForUser("user-1")
|
||||
const source2 = service.feedSourceForUser("user-2")
|
||||
|
||||
expect(source1).not.toBe(source2)
|
||||
})
|
||||
|
||||
test("updateUserLocation updates the source", () => {
|
||||
const service = new LocationService()
|
||||
const source = service.feedSourceForUser("user-1")
|
||||
const location = {
|
||||
lat: 51.5074,
|
||||
lng: -0.1278,
|
||||
accuracy: 10,
|
||||
timestamp: new Date(),
|
||||
}
|
||||
|
||||
service.updateUserLocation("user-1", location)
|
||||
|
||||
expect(source.lastLocation).toEqual(location)
|
||||
})
|
||||
|
||||
test("updateUserLocation throws if source does not exist", () => {
|
||||
const service = new LocationService()
|
||||
const location = {
|
||||
lat: 51.5074,
|
||||
lng: -0.1278,
|
||||
accuracy: 10,
|
||||
timestamp: new Date(),
|
||||
}
|
||||
|
||||
expect(() => service.updateUserLocation("user-1", location)).toThrow(UserNotFoundError)
|
||||
})
|
||||
|
||||
test("lastUserLocation returns null for unknown user", () => {
|
||||
const service = new LocationService()
|
||||
|
||||
expect(service.lastUserLocation("unknown")).toBeNull()
|
||||
})
|
||||
|
||||
test("lastUserLocation returns last location", () => {
|
||||
const service = new LocationService()
|
||||
service.feedSourceForUser("user-1")
|
||||
const location1 = {
|
||||
lat: 51.5074,
|
||||
lng: -0.1278,
|
||||
accuracy: 10,
|
||||
timestamp: new Date(),
|
||||
}
|
||||
const location2 = {
|
||||
lat: 52.0,
|
||||
lng: -0.2,
|
||||
accuracy: 5,
|
||||
timestamp: new Date(),
|
||||
}
|
||||
|
||||
service.updateUserLocation("user-1", location1)
|
||||
service.updateUserLocation("user-1", location2)
|
||||
|
||||
expect(service.lastUserLocation("user-1")).toEqual(location2)
|
||||
})
|
||||
|
||||
test("removeUser removes the source", () => {
|
||||
const service = new LocationService()
|
||||
service.feedSourceForUser("user-1")
|
||||
const location = {
|
||||
lat: 51.5074,
|
||||
lng: -0.1278,
|
||||
accuracy: 10,
|
||||
timestamp: new Date(),
|
||||
}
|
||||
|
||||
service.updateUserLocation("user-1", location)
|
||||
service.removeUser("user-1")
|
||||
|
||||
expect(service.lastUserLocation("user-1")).toBeNull()
|
||||
})
|
||||
|
||||
test("removeUser allows new source to be created", () => {
|
||||
const service = new LocationService()
|
||||
const source1 = service.feedSourceForUser("user-1")
|
||||
|
||||
service.removeUser("user-1")
|
||||
const source2 = service.feedSourceForUser("user-1")
|
||||
|
||||
expect(source1).not.toBe(source2)
|
||||
})
|
||||
})
|
||||
@@ -1,57 +0,0 @@
|
||||
import { LocationSource, type Location } from "@aris/source-location"
|
||||
|
||||
import type { FeedSourceProvider } from "../feed/service.ts"
|
||||
|
||||
import { UserNotFoundError } from "../lib/error.ts"
|
||||
|
||||
/**
|
||||
* Manages LocationSource instances per user.
|
||||
*/
|
||||
export class LocationService implements FeedSourceProvider {
|
||||
private sources = new Map<string, LocationSource>()
|
||||
|
||||
/**
|
||||
* Get or create a LocationSource for a user.
|
||||
* @param userId - The user's unique identifier
|
||||
* @returns The user's LocationSource instance
|
||||
*/
|
||||
feedSourceForUser(userId: string): LocationSource {
|
||||
let source = this.sources.get(userId)
|
||||
if (!source) {
|
||||
source = new LocationSource()
|
||||
this.sources.set(userId, source)
|
||||
}
|
||||
return source
|
||||
}
|
||||
|
||||
/**
|
||||
* Update location for a user.
|
||||
* @param userId - The user's unique identifier
|
||||
* @param location - The new location data
|
||||
* @throws {UserNotFoundError} If no source exists for the user
|
||||
*/
|
||||
updateUserLocation(userId: string, location: Location): void {
|
||||
const source = this.sources.get(userId)
|
||||
if (!source) {
|
||||
throw new UserNotFoundError(userId)
|
||||
}
|
||||
source.pushLocation(location)
|
||||
}
|
||||
|
||||
/**
|
||||
* Get last known location for a user.
|
||||
* @param userId - The user's unique identifier
|
||||
* @returns The last location, or null if none exists
|
||||
*/
|
||||
lastUserLocation(userId: string): Location | null {
|
||||
return this.sources.get(userId)?.lastLocation ?? null
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove a user's LocationSource.
|
||||
* @param userId - The user's unique identifier
|
||||
*/
|
||||
removeUser(userId: string): void {
|
||||
this.sources.delete(userId)
|
||||
}
|
||||
}
|
||||
@@ -1,39 +1,30 @@
|
||||
import { trpcServer } from "@hono/trpc-server"
|
||||
import { LocationSource } from "@aris/source-location"
|
||||
import { Hono } from "hono"
|
||||
|
||||
import { registerAuthHandlers } from "./auth/http.ts"
|
||||
import { LocationService } from "./location/service.ts"
|
||||
import { createContext } from "./trpc/context.ts"
|
||||
import { createTRPCRouter } from "./trpc/router.ts"
|
||||
import { WeatherService } from "./weather/service.ts"
|
||||
import { registerLocationHttpHandlers } from "./location/http.ts"
|
||||
import { UserSessionManager } from "./session/index.ts"
|
||||
import { WeatherSourceProvider } from "./weather/provider.ts"
|
||||
|
||||
function main() {
|
||||
const locationService = new LocationService()
|
||||
|
||||
const weatherService = new WeatherService({
|
||||
credentials: {
|
||||
privateKey: process.env.WEATHERKIT_PRIVATE_KEY!,
|
||||
keyId: process.env.WEATHERKIT_KEY_ID!,
|
||||
teamId: process.env.WEATHERKIT_TEAM_ID!,
|
||||
serviceId: process.env.WEATHERKIT_SERVICE_ID!,
|
||||
},
|
||||
})
|
||||
|
||||
const trpcRouter = createTRPCRouter({ locationService, weatherService })
|
||||
const sessionManager = new UserSessionManager([
|
||||
() => new LocationSource(),
|
||||
new WeatherSourceProvider({
|
||||
credentials: {
|
||||
privateKey: process.env.WEATHERKIT_PRIVATE_KEY!,
|
||||
keyId: process.env.WEATHERKIT_KEY_ID!,
|
||||
teamId: process.env.WEATHERKIT_TEAM_ID!,
|
||||
serviceId: process.env.WEATHERKIT_SERVICE_ID!,
|
||||
},
|
||||
}),
|
||||
])
|
||||
|
||||
const app = new Hono()
|
||||
|
||||
app.get("/health", (c) => c.json({ status: "ok" }))
|
||||
|
||||
registerAuthHandlers(app)
|
||||
|
||||
app.use(
|
||||
"/trpc/*",
|
||||
trpcServer({
|
||||
router: trpcRouter,
|
||||
createContext,
|
||||
}),
|
||||
)
|
||||
registerLocationHttpHandlers(app, { sessionManager })
|
||||
|
||||
return app
|
||||
}
|
||||
|
||||
9
apps/aris-backend/src/session/feed-source-provider.ts
Normal file
@@ -0,0 +1,9 @@
|
||||
import type { FeedSource } from "@aris/core"
|
||||
|
||||
export interface FeedSourceProvider {
|
||||
feedSourceForUser(userId: string): FeedSource
|
||||
}
|
||||
|
||||
export type FeedSourceProviderFn = (userId: string) => FeedSource
|
||||
|
||||
export type FeedSourceProviderInput = FeedSourceProvider | FeedSourceProviderFn
|
||||
7
apps/aris-backend/src/session/index.ts
Normal file
@@ -0,0 +1,7 @@
|
||||
export type {
|
||||
FeedSourceProvider,
|
||||
FeedSourceProviderFn,
|
||||
FeedSourceProviderInput,
|
||||
} from "./feed-source-provider.ts"
|
||||
export { UserSession } from "./user-session.ts"
|
||||
export { UserSessionManager } from "./user-session-manager.ts"
|
||||
166
apps/aris-backend/src/session/user-session-manager.test.ts
Normal file
@@ -0,0 +1,166 @@
|
||||
import type { WeatherKitClient, WeatherKitResponse } from "@aris/source-weatherkit"
|
||||
|
||||
import { LocationSource } from "@aris/source-location"
|
||||
import { describe, expect, mock, test } from "bun:test"
|
||||
|
||||
import { WeatherSourceProvider } from "../weather/provider.ts"
|
||||
import { UserSessionManager } from "./user-session-manager.ts"
|
||||
|
||||
const mockWeatherClient: WeatherKitClient = {
|
||||
fetch: async () => ({}) as WeatherKitResponse,
|
||||
}
|
||||
|
||||
describe("UserSessionManager", () => {
|
||||
test("getOrCreate creates session on first call", () => {
|
||||
const manager = new UserSessionManager([() => new LocationSource()])
|
||||
|
||||
const session = manager.getOrCreate("user-1")
|
||||
|
||||
expect(session).toBeDefined()
|
||||
expect(session.engine).toBeDefined()
|
||||
})
|
||||
|
||||
test("getOrCreate returns same session for same user", () => {
|
||||
const manager = new UserSessionManager([() => new LocationSource()])
|
||||
|
||||
const session1 = manager.getOrCreate("user-1")
|
||||
const session2 = manager.getOrCreate("user-1")
|
||||
|
||||
expect(session1).toBe(session2)
|
||||
})
|
||||
|
||||
test("getOrCreate returns different sessions for different users", () => {
|
||||
const manager = new UserSessionManager([() => new LocationSource()])
|
||||
|
||||
const session1 = manager.getOrCreate("user-1")
|
||||
const session2 = manager.getOrCreate("user-2")
|
||||
|
||||
expect(session1).not.toBe(session2)
|
||||
})
|
||||
|
||||
test("each user gets independent source instances", () => {
|
||||
const manager = new UserSessionManager([() => new LocationSource()])
|
||||
|
||||
const session1 = manager.getOrCreate("user-1")
|
||||
const session2 = manager.getOrCreate("user-2")
|
||||
|
||||
const source1 = session1.getSource<LocationSource>("aris.location")
|
||||
const source2 = session2.getSource<LocationSource>("aris.location")
|
||||
|
||||
expect(source1).not.toBe(source2)
|
||||
})
|
||||
|
||||
test("remove destroys session and allows re-creation", () => {
|
||||
const manager = new UserSessionManager([() => new LocationSource()])
|
||||
|
||||
const session1 = manager.getOrCreate("user-1")
|
||||
manager.remove("user-1")
|
||||
const session2 = manager.getOrCreate("user-1")
|
||||
|
||||
expect(session1).not.toBe(session2)
|
||||
})
|
||||
|
||||
test("remove is no-op for unknown user", () => {
|
||||
const manager = new UserSessionManager([() => new LocationSource()])
|
||||
|
||||
expect(() => manager.remove("unknown")).not.toThrow()
|
||||
})
|
||||
|
||||
test("accepts function providers", async () => {
|
||||
const manager = new UserSessionManager([() => new LocationSource()])
|
||||
|
||||
const session = manager.getOrCreate("user-1")
|
||||
const result = await session.engine.refresh()
|
||||
|
||||
expect(result.errors).toHaveLength(0)
|
||||
})
|
||||
|
||||
test("accepts object providers", () => {
|
||||
const provider = new WeatherSourceProvider({ client: mockWeatherClient })
|
||||
const manager = new UserSessionManager([() => new LocationSource(), provider])
|
||||
|
||||
const session = manager.getOrCreate("user-1")
|
||||
|
||||
expect(session.getSource("aris.weather")).toBeDefined()
|
||||
})
|
||||
|
||||
test("accepts mixed providers", () => {
|
||||
const provider = new WeatherSourceProvider({ client: mockWeatherClient })
|
||||
const manager = new UserSessionManager([() => new LocationSource(), provider])
|
||||
|
||||
const session = manager.getOrCreate("user-1")
|
||||
|
||||
expect(session.getSource("aris.location")).toBeDefined()
|
||||
expect(session.getSource("aris.weather")).toBeDefined()
|
||||
})
|
||||
|
||||
test("refresh returns feed result through session", async () => {
|
||||
const manager = new UserSessionManager([() => new LocationSource()])
|
||||
|
||||
const session = manager.getOrCreate("user-1")
|
||||
const result = await session.engine.refresh()
|
||||
|
||||
expect(result).toHaveProperty("context")
|
||||
expect(result).toHaveProperty("items")
|
||||
expect(result).toHaveProperty("errors")
|
||||
expect(result.context.time).toBeInstanceOf(Date)
|
||||
})
|
||||
|
||||
test("location update via executeAction works", async () => {
|
||||
const manager = new UserSessionManager([() => new LocationSource()])
|
||||
|
||||
const session = manager.getOrCreate("user-1")
|
||||
await session.engine.executeAction("aris.location", "update-location", {
|
||||
lat: 51.5074,
|
||||
lng: -0.1278,
|
||||
accuracy: 10,
|
||||
timestamp: new Date(),
|
||||
})
|
||||
|
||||
const source = session.getSource<LocationSource>("aris.location")
|
||||
expect(source?.lastLocation?.lat).toBe(51.5074)
|
||||
})
|
||||
|
||||
test("subscribe receives updates after location push", async () => {
|
||||
const manager = new UserSessionManager([() => new LocationSource()])
|
||||
const callback = mock()
|
||||
|
||||
const session = manager.getOrCreate("user-1")
|
||||
session.engine.subscribe(callback)
|
||||
|
||||
await session.engine.executeAction("aris.location", "update-location", {
|
||||
lat: 51.5074,
|
||||
lng: -0.1278,
|
||||
accuracy: 10,
|
||||
timestamp: new Date(),
|
||||
})
|
||||
|
||||
// Wait for async update propagation
|
||||
await new Promise((resolve) => setTimeout(resolve, 10))
|
||||
|
||||
expect(callback).toHaveBeenCalled()
|
||||
})
|
||||
|
||||
test("remove stops reactive updates", async () => {
|
||||
const manager = new UserSessionManager([() => new LocationSource()])
|
||||
const callback = mock()
|
||||
|
||||
const session = manager.getOrCreate("user-1")
|
||||
session.engine.subscribe(callback)
|
||||
|
||||
manager.remove("user-1")
|
||||
|
||||
// Create new session and push location — old callback should not fire
|
||||
const session2 = manager.getOrCreate("user-1")
|
||||
await session2.engine.executeAction("aris.location", "update-location", {
|
||||
lat: 51.5074,
|
||||
lng: -0.1278,
|
||||
accuracy: 10,
|
||||
timestamp: new Date(),
|
||||
})
|
||||
|
||||
await new Promise((resolve) => setTimeout(resolve, 10))
|
||||
|
||||
expect(callback).not.toHaveBeenCalled()
|
||||
})
|
||||
})
|
||||
32
apps/aris-backend/src/session/user-session-manager.ts
Normal file
@@ -0,0 +1,32 @@
|
||||
import type { FeedSourceProviderInput } from "./feed-source-provider.ts"
|
||||
|
||||
import { UserSession } from "./user-session.ts"
|
||||
|
||||
export class UserSessionManager {
|
||||
private sessions = new Map<string, UserSession>()
|
||||
private readonly providers: FeedSourceProviderInput[]
|
||||
|
||||
constructor(providers: FeedSourceProviderInput[]) {
|
||||
this.providers = providers
|
||||
}
|
||||
|
||||
getOrCreate(userId: string): UserSession {
|
||||
let session = this.sessions.get(userId)
|
||||
if (!session) {
|
||||
const sources = this.providers.map((p) =>
|
||||
typeof p === "function" ? p(userId) : p.feedSourceForUser(userId),
|
||||
)
|
||||
session = new UserSession(sources)
|
||||
this.sessions.set(userId, session)
|
||||
}
|
||||
return session
|
||||
}
|
||||
|
||||
remove(userId: string): void {
|
||||
const session = this.sessions.get(userId)
|
||||
if (session) {
|
||||
session.destroy()
|
||||
this.sessions.delete(userId)
|
||||
}
|
||||
}
|
||||
}
|
||||
72
apps/aris-backend/src/session/user-session.test.ts
Normal file
@@ -0,0 +1,72 @@
|
||||
import type { ActionDefinition, Context, FeedSource } from "@aris/core"
|
||||
|
||||
import { LocationSource } from "@aris/source-location"
|
||||
import { describe, expect, test } from "bun:test"
|
||||
|
||||
import { UserSession } from "./user-session.ts"
|
||||
|
||||
function createStubSource(id: string): FeedSource {
|
||||
return {
|
||||
id,
|
||||
async listActions(): Promise<Record<string, ActionDefinition>> {
|
||||
return {}
|
||||
},
|
||||
async executeAction(): Promise<unknown> {
|
||||
return undefined
|
||||
},
|
||||
async fetchContext(): Promise<Partial<Context> | null> {
|
||||
return null
|
||||
},
|
||||
async fetchItems() {
|
||||
return []
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
describe("UserSession", () => {
|
||||
test("registers sources and starts engine", async () => {
|
||||
const session = new UserSession([createStubSource("test-a"), createStubSource("test-b")])
|
||||
|
||||
const result = await session.engine.refresh()
|
||||
|
||||
expect(result.errors).toHaveLength(0)
|
||||
})
|
||||
|
||||
test("getSource returns registered source", () => {
|
||||
const location = new LocationSource()
|
||||
const session = new UserSession([location])
|
||||
|
||||
const result = session.getSource<LocationSource>("aris.location")
|
||||
|
||||
expect(result).toBe(location)
|
||||
})
|
||||
|
||||
test("getSource returns undefined for unknown source", () => {
|
||||
const session = new UserSession([createStubSource("test")])
|
||||
|
||||
expect(session.getSource("unknown")).toBeUndefined()
|
||||
})
|
||||
|
||||
test("destroy stops engine and clears sources", () => {
|
||||
const session = new UserSession([createStubSource("test")])
|
||||
|
||||
session.destroy()
|
||||
|
||||
expect(session.getSource("test")).toBeUndefined()
|
||||
})
|
||||
|
||||
test("engine.executeAction routes to correct source", async () => {
|
||||
const location = new LocationSource()
|
||||
const session = new UserSession([location])
|
||||
|
||||
await session.engine.executeAction("aris.location", "update-location", {
|
||||
lat: 51.5,
|
||||
lng: -0.1,
|
||||
accuracy: 10,
|
||||
timestamp: new Date(),
|
||||
})
|
||||
|
||||
expect(location.lastLocation).toBeDefined()
|
||||
expect(location.lastLocation!.lat).toBe(51.5)
|
||||
})
|
||||
})
|
||||
24
apps/aris-backend/src/session/user-session.ts
Normal file
@@ -0,0 +1,24 @@
|
||||
import { FeedEngine, type FeedSource } from "@aris/core"
|
||||
|
||||
export class UserSession {
|
||||
readonly engine: FeedEngine
|
||||
private sources = new Map<string, FeedSource>()
|
||||
|
||||
constructor(sources: FeedSource[]) {
|
||||
this.engine = new FeedEngine()
|
||||
for (const source of sources) {
|
||||
this.sources.set(source.id, source)
|
||||
this.engine.register(source)
|
||||
}
|
||||
this.engine.start()
|
||||
}
|
||||
|
||||
getSource<T extends FeedSource>(sourceId: string): T | undefined {
|
||||
return this.sources.get(sourceId) as T | undefined
|
||||
}
|
||||
|
||||
destroy(): void {
|
||||
this.engine.stop()
|
||||
this.sources.clear()
|
||||
}
|
||||
}
|
||||
19
apps/aris-backend/src/tfl/provider.ts
Normal file
@@ -0,0 +1,19 @@
|
||||
import { TflSource, type ITflApi } from "@aris/source-tfl"
|
||||
|
||||
import type { FeedSourceProvider } from "../session/feed-source-provider.ts"
|
||||
|
||||
export type TflSourceProviderOptions =
|
||||
| { apiKey: string; client?: never }
|
||||
| { apiKey?: never; client: ITflApi }
|
||||
|
||||
export class TflSourceProvider implements FeedSourceProvider {
|
||||
private readonly options: TflSourceProviderOptions
|
||||
|
||||
constructor(options: TflSourceProviderOptions) {
|
||||
this.options = options
|
||||
}
|
||||
|
||||
feedSourceForUser(_userId: string): TflSource {
|
||||
return new TflSource(this.options)
|
||||
}
|
||||
}
|
||||
@@ -1,206 +0,0 @@
|
||||
import type { Context } from "@aris/core"
|
||||
import type { ITflApi, StationLocation, TflLineId, TflLineStatus } from "@aris/source-tfl"
|
||||
|
||||
import { describe, expect, test } from "bun:test"
|
||||
|
||||
import { UserNotFoundError } from "../lib/error.ts"
|
||||
import { TflService } from "./service.ts"
|
||||
|
||||
class StubTflApi implements ITflApi {
|
||||
private statuses: TflLineStatus[]
|
||||
|
||||
constructor(statuses: TflLineStatus[] = []) {
|
||||
this.statuses = statuses
|
||||
}
|
||||
|
||||
async fetchLineStatuses(lines?: TflLineId[]): Promise<TflLineStatus[]> {
|
||||
if (lines) {
|
||||
return this.statuses.filter((s) => lines.includes(s.lineId))
|
||||
}
|
||||
return this.statuses
|
||||
}
|
||||
|
||||
async fetchStations(): Promise<StationLocation[]> {
|
||||
return [
|
||||
{
|
||||
id: "940GZZLUKSX",
|
||||
name: "King's Cross",
|
||||
lat: 51.5308,
|
||||
lng: -0.1238,
|
||||
lines: ["northern", "victoria"],
|
||||
},
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
function createContext(): Context {
|
||||
return { time: new Date("2026-01-15T12:00:00Z") }
|
||||
}
|
||||
|
||||
const sampleStatuses: TflLineStatus[] = [
|
||||
{
|
||||
lineId: "northern",
|
||||
lineName: "Northern",
|
||||
severity: "minor-delays",
|
||||
description: "Minor delays on the Northern line",
|
||||
},
|
||||
{
|
||||
lineId: "victoria",
|
||||
lineName: "Victoria",
|
||||
severity: "major-delays",
|
||||
description: "Severe delays on the Victoria line",
|
||||
},
|
||||
{
|
||||
lineId: "central",
|
||||
lineName: "Central",
|
||||
severity: "closure",
|
||||
description: "Central line suspended",
|
||||
},
|
||||
]
|
||||
|
||||
describe("TflService", () => {
|
||||
test("feedSourceForUser creates source on first call", () => {
|
||||
const service = new TflService(new StubTflApi())
|
||||
const source = service.feedSourceForUser("user-1")
|
||||
|
||||
expect(source).toBeDefined()
|
||||
expect(source.id).toBe("tfl")
|
||||
})
|
||||
|
||||
test("feedSourceForUser returns same source for same user", () => {
|
||||
const service = new TflService(new StubTflApi())
|
||||
const source1 = service.feedSourceForUser("user-1")
|
||||
const source2 = service.feedSourceForUser("user-1")
|
||||
|
||||
expect(source1).toBe(source2)
|
||||
})
|
||||
|
||||
test("feedSourceForUser returns different sources for different users", () => {
|
||||
const service = new TflService(new StubTflApi())
|
||||
const source1 = service.feedSourceForUser("user-1")
|
||||
const source2 = service.feedSourceForUser("user-2")
|
||||
|
||||
expect(source1).not.toBe(source2)
|
||||
})
|
||||
|
||||
test("updateLinesOfInterest mutates the existing source in place", () => {
|
||||
const service = new TflService(new StubTflApi())
|
||||
const original = service.feedSourceForUser("user-1")
|
||||
|
||||
service.updateLinesOfInterest("user-1", ["northern", "victoria"])
|
||||
const after = service.feedSourceForUser("user-1")
|
||||
|
||||
expect(after).toBe(original)
|
||||
})
|
||||
|
||||
test("updateLinesOfInterest throws if source does not exist", () => {
|
||||
const service = new TflService(new StubTflApi())
|
||||
|
||||
expect(() => service.updateLinesOfInterest("user-1", ["northern"])).toThrow(UserNotFoundError)
|
||||
})
|
||||
|
||||
test("removeUser removes the source", () => {
|
||||
const service = new TflService(new StubTflApi())
|
||||
const source1 = service.feedSourceForUser("user-1")
|
||||
|
||||
service.removeUser("user-1")
|
||||
const source2 = service.feedSourceForUser("user-1")
|
||||
|
||||
expect(source1).not.toBe(source2)
|
||||
})
|
||||
|
||||
test("removeUser clears line configuration", async () => {
|
||||
const api = new StubTflApi(sampleStatuses)
|
||||
const service = new TflService(api)
|
||||
service.feedSourceForUser("user-1")
|
||||
service.updateLinesOfInterest("user-1", ["northern"])
|
||||
|
||||
service.removeUser("user-1")
|
||||
const items = await service.feedSourceForUser("user-1").fetchItems(createContext())
|
||||
|
||||
expect(items.length).toBe(3)
|
||||
})
|
||||
|
||||
test("shares single api instance across users", () => {
|
||||
const api = new StubTflApi()
|
||||
const service = new TflService(api)
|
||||
|
||||
service.feedSourceForUser("user-1")
|
||||
service.feedSourceForUser("user-2")
|
||||
|
||||
expect(service.feedSourceForUser("user-1").id).toBe("tfl")
|
||||
expect(service.feedSourceForUser("user-2").id).toBe("tfl")
|
||||
})
|
||||
|
||||
describe("returned source fetches items", () => {
|
||||
test("source returns feed items from api", async () => {
|
||||
const api = new StubTflApi(sampleStatuses)
|
||||
const service = new TflService(api)
|
||||
const source = service.feedSourceForUser("user-1")
|
||||
|
||||
const items = await source.fetchItems(createContext())
|
||||
|
||||
expect(items.length).toBe(3)
|
||||
for (const item of items) {
|
||||
expect(item.type).toBe("tfl-alert")
|
||||
expect(item.id).toMatch(/^tfl-alert-/)
|
||||
expect(typeof item.priority).toBe("number")
|
||||
expect(item.timestamp).toBeInstanceOf(Date)
|
||||
}
|
||||
})
|
||||
|
||||
test("source returns items sorted by priority descending", async () => {
|
||||
const api = new StubTflApi(sampleStatuses)
|
||||
const service = new TflService(api)
|
||||
const source = service.feedSourceForUser("user-1")
|
||||
|
||||
const items = await source.fetchItems(createContext())
|
||||
|
||||
for (let i = 1; i < items.length; i++) {
|
||||
expect(items[i - 1]!.priority).toBeGreaterThanOrEqual(items[i]!.priority)
|
||||
}
|
||||
})
|
||||
|
||||
test("source returns empty array when no disruptions", async () => {
|
||||
const api = new StubTflApi([])
|
||||
const service = new TflService(api)
|
||||
const source = service.feedSourceForUser("user-1")
|
||||
|
||||
const items = await source.fetchItems(createContext())
|
||||
|
||||
expect(items).toEqual([])
|
||||
})
|
||||
|
||||
test("updateLinesOfInterest filters items to configured lines", async () => {
|
||||
const api = new StubTflApi(sampleStatuses)
|
||||
const service = new TflService(api)
|
||||
|
||||
const before = await service.feedSourceForUser("user-1").fetchItems(createContext())
|
||||
expect(before.length).toBe(3)
|
||||
|
||||
service.updateLinesOfInterest("user-1", ["northern"])
|
||||
const after = await service.feedSourceForUser("user-1").fetchItems(createContext())
|
||||
|
||||
expect(after.length).toBe(1)
|
||||
expect(after[0]!.data.line).toBe("northern")
|
||||
})
|
||||
|
||||
test("different users get independent line configs", async () => {
|
||||
const api = new StubTflApi(sampleStatuses)
|
||||
const service = new TflService(api)
|
||||
service.feedSourceForUser("user-1")
|
||||
service.feedSourceForUser("user-2")
|
||||
|
||||
service.updateLinesOfInterest("user-1", ["northern"])
|
||||
service.updateLinesOfInterest("user-2", ["central"])
|
||||
|
||||
const items1 = await service.feedSourceForUser("user-1").fetchItems(createContext())
|
||||
const items2 = await service.feedSourceForUser("user-2").fetchItems(createContext())
|
||||
|
||||
expect(items1.length).toBe(1)
|
||||
expect(items1[0]!.data.line).toBe("northern")
|
||||
expect(items2.length).toBe(1)
|
||||
expect(items2[0]!.data.line).toBe("central")
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -1,40 +0,0 @@
|
||||
import { TflSource, type ITflApi, type TflLineId } from "@aris/source-tfl"
|
||||
|
||||
import type { FeedSourceProvider } from "../feed/service.ts"
|
||||
|
||||
import { UserNotFoundError } from "../lib/error.ts"
|
||||
|
||||
/**
|
||||
* Manages per-user TflSource instances with individual line configuration.
|
||||
*/
|
||||
export class TflService implements FeedSourceProvider {
|
||||
private sources = new Map<string, TflSource>()
|
||||
|
||||
constructor(private readonly api: ITflApi) {}
|
||||
|
||||
feedSourceForUser(userId: string): TflSource {
|
||||
let source = this.sources.get(userId)
|
||||
if (!source) {
|
||||
source = new TflSource({ client: this.api })
|
||||
this.sources.set(userId, source)
|
||||
}
|
||||
return source
|
||||
}
|
||||
|
||||
/**
|
||||
* Update monitored lines for a user. Mutates the existing TflSource
|
||||
* so that references held by FeedEngine remain valid.
|
||||
* @throws {UserNotFoundError} If no source exists for the user
|
||||
*/
|
||||
updateLinesOfInterest(userId: string, lines: TflLineId[]): void {
|
||||
const source = this.sources.get(userId)
|
||||
if (!source) {
|
||||
throw new UserNotFoundError(userId)
|
||||
}
|
||||
source.setLinesOfInterest(lines)
|
||||
}
|
||||
|
||||
removeUser(userId: string): void {
|
||||
this.sources.delete(userId)
|
||||
}
|
||||
}
|
||||
@@ -1,14 +0,0 @@
|
||||
import type { FetchCreateContextFnOptions } from "@trpc/server/adapters/fetch"
|
||||
|
||||
import { auth } from "../auth/index.ts"
|
||||
|
||||
export async function createContext(opts: FetchCreateContextFnOptions) {
|
||||
const session = await auth.api.getSession({ headers: opts.req.headers })
|
||||
|
||||
return {
|
||||
user: session?.user ?? null,
|
||||
session: session?.session ?? null,
|
||||
}
|
||||
}
|
||||
|
||||
export type Context = Awaited<ReturnType<typeof createContext>>
|
||||
@@ -1,50 +0,0 @@
|
||||
import { initTRPC, TRPCError } from "@trpc/server"
|
||||
|
||||
import type { LocationService } from "../location/service.ts"
|
||||
import type { WeatherService } from "../weather/service.ts"
|
||||
import type { Context } from "./context.ts"
|
||||
|
||||
import { createLocationRouter } from "../location/router.ts"
|
||||
|
||||
interface AuthedContext {
|
||||
user: NonNullable<Context["user"]>
|
||||
session: NonNullable<Context["session"]>
|
||||
}
|
||||
|
||||
function createTRPC() {
|
||||
const t = initTRPC.context<Context>().create()
|
||||
|
||||
const isAuthed = t.middleware(({ ctx, next }) => {
|
||||
if (!ctx.user || !ctx.session) {
|
||||
throw new TRPCError({ code: "UNAUTHORIZED" })
|
||||
}
|
||||
return next({
|
||||
ctx: {
|
||||
user: ctx.user,
|
||||
session: ctx.session,
|
||||
},
|
||||
})
|
||||
})
|
||||
|
||||
return {
|
||||
router: t.router,
|
||||
procedure: t.procedure.use(isAuthed),
|
||||
}
|
||||
}
|
||||
|
||||
export type TRPC = ReturnType<typeof createTRPC>
|
||||
|
||||
export interface TRPCRouterDeps {
|
||||
locationService: LocationService
|
||||
weatherService: WeatherService
|
||||
}
|
||||
|
||||
export function createTRPCRouter({ locationService }: TRPCRouterDeps) {
|
||||
const t = createTRPC()
|
||||
|
||||
return t.router({
|
||||
location: createLocationRouter(t, { locationService }),
|
||||
})
|
||||
}
|
||||
|
||||
export type TRPCRouter = ReturnType<typeof createTRPCRouter>
|
||||
15
apps/aris-backend/src/weather/provider.ts
Normal file
@@ -0,0 +1,15 @@
|
||||
import { WeatherSource, type WeatherSourceOptions } from "@aris/source-weatherkit"
|
||||
|
||||
import type { FeedSourceProvider } from "../session/feed-source-provider.ts"
|
||||
|
||||
export class WeatherSourceProvider implements FeedSourceProvider {
|
||||
private readonly options: WeatherSourceOptions
|
||||
|
||||
constructor(options: WeatherSourceOptions) {
|
||||
this.options = options
|
||||
}
|
||||
|
||||
feedSourceForUser(_userId: string): WeatherSource {
|
||||
return new WeatherSource(this.options)
|
||||
}
|
||||
}
|
||||
@@ -1,116 +0,0 @@
|
||||
import type { Context } from "@aris/core"
|
||||
|
||||
import { LocationKey } from "@aris/source-location"
|
||||
import {
|
||||
Units,
|
||||
WeatherFeedItemType,
|
||||
type WeatherKitClient,
|
||||
type WeatherKitResponse,
|
||||
} from "@aris/source-weatherkit"
|
||||
import { describe, expect, test } from "bun:test"
|
||||
|
||||
import fixture from "../../../../packages/aris-source-weatherkit/fixtures/san-francisco.json"
|
||||
import { WeatherService } from "./service.ts"
|
||||
|
||||
const mockClient = createMockClient(fixture.response as WeatherKitResponse)
|
||||
|
||||
function createMockClient(response: WeatherKitResponse): WeatherKitClient {
|
||||
return {
|
||||
fetch: async () => response,
|
||||
}
|
||||
}
|
||||
|
||||
function createMockContext(location?: { lat: number; lng: number }): Context {
|
||||
const ctx: Context = { time: new Date("2026-01-17T00:00:00Z") }
|
||||
if (location) {
|
||||
ctx[LocationKey] = { ...location, accuracy: 10, timestamp: new Date() }
|
||||
}
|
||||
return ctx
|
||||
}
|
||||
|
||||
describe("WeatherService", () => {
|
||||
test("feedSourceForUser creates source on first call", () => {
|
||||
const service = new WeatherService({ client: mockClient })
|
||||
const source = service.feedSourceForUser("user-1")
|
||||
|
||||
expect(source).toBeDefined()
|
||||
expect(source.id).toBe("weather")
|
||||
})
|
||||
|
||||
test("feedSourceForUser returns same source for same user", () => {
|
||||
const service = new WeatherService({ client: mockClient })
|
||||
const source1 = service.feedSourceForUser("user-1")
|
||||
const source2 = service.feedSourceForUser("user-1")
|
||||
|
||||
expect(source1).toBe(source2)
|
||||
})
|
||||
|
||||
test("feedSourceForUser returns different sources for different users", () => {
|
||||
const service = new WeatherService({ client: mockClient })
|
||||
const source1 = service.feedSourceForUser("user-1")
|
||||
const source2 = service.feedSourceForUser("user-2")
|
||||
|
||||
expect(source1).not.toBe(source2)
|
||||
})
|
||||
|
||||
test("feedSourceForUser applies hourly and daily limits", async () => {
|
||||
const service = new WeatherService({
|
||||
client: mockClient,
|
||||
hourlyLimit: 3,
|
||||
dailyLimit: 2,
|
||||
})
|
||||
const source = service.feedSourceForUser("user-1")
|
||||
const context = createMockContext({ lat: 37.7749, lng: -122.4194 })
|
||||
|
||||
const items = await source.fetchItems(context)
|
||||
|
||||
const hourly = items.filter((i) => i.type === WeatherFeedItemType.hourly)
|
||||
const daily = items.filter((i) => i.type === WeatherFeedItemType.daily)
|
||||
|
||||
expect(hourly).toHaveLength(3)
|
||||
expect(daily).toHaveLength(2)
|
||||
})
|
||||
|
||||
test("feedSourceForUser applies units", async () => {
|
||||
const service = new WeatherService({
|
||||
client: mockClient,
|
||||
units: Units.imperial,
|
||||
})
|
||||
const source = service.feedSourceForUser("user-1")
|
||||
const context = createMockContext({ lat: 37.7749, lng: -122.4194 })
|
||||
|
||||
const items = await source.fetchItems(context)
|
||||
const current = items.find((i) => i.type === WeatherFeedItemType.current)
|
||||
|
||||
expect(current).toBeDefined()
|
||||
// Fixture has ~15.87°C, imperial should be ~60.6°F
|
||||
expect(current!.data.temperature).toBeGreaterThan(50)
|
||||
})
|
||||
|
||||
test("removeUser removes the source", () => {
|
||||
const service = new WeatherService({ client: mockClient })
|
||||
service.feedSourceForUser("user-1")
|
||||
|
||||
service.removeUser("user-1")
|
||||
|
||||
// After removal, feedSourceForUser should create a new instance
|
||||
const source2 = service.feedSourceForUser("user-1")
|
||||
expect(source2).toBeDefined()
|
||||
})
|
||||
|
||||
test("removeUser allows new source to be created", () => {
|
||||
const service = new WeatherService({ client: mockClient })
|
||||
const source1 = service.feedSourceForUser("user-1")
|
||||
|
||||
service.removeUser("user-1")
|
||||
const source2 = service.feedSourceForUser("user-1")
|
||||
|
||||
expect(source1).not.toBe(source2)
|
||||
})
|
||||
|
||||
test("removeUser is no-op for unknown user", () => {
|
||||
const service = new WeatherService({ client: mockClient })
|
||||
|
||||
expect(() => service.removeUser("unknown")).not.toThrow()
|
||||
})
|
||||
})
|
||||
@@ -1,40 +0,0 @@
|
||||
import { WeatherSource, type WeatherSourceOptions } from "@aris/source-weatherkit"
|
||||
|
||||
import type { FeedSourceProvider } from "../feed/service.ts"
|
||||
|
||||
/**
|
||||
* Options forwarded to every per-user WeatherSource.
|
||||
* Must include either `credentials` or `client` (same requirement as WeatherSourceOptions).
|
||||
*/
|
||||
export type WeatherServiceOptions = WeatherSourceOptions
|
||||
|
||||
/**
|
||||
* Manages WeatherSource instances per user.
|
||||
*/
|
||||
export class WeatherService implements FeedSourceProvider {
|
||||
private sources = new Map<string, WeatherSource>()
|
||||
private readonly options: WeatherServiceOptions
|
||||
|
||||
constructor(options: WeatherServiceOptions) {
|
||||
this.options = options
|
||||
}
|
||||
|
||||
/**
|
||||
* Get or create a WeatherSource for a user.
|
||||
*/
|
||||
feedSourceForUser(userId: string): WeatherSource {
|
||||
let source = this.sources.get(userId)
|
||||
if (!source) {
|
||||
source = new WeatherSource(this.options)
|
||||
this.sources.set(userId, source)
|
||||
}
|
||||
return source
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove a user's WeatherSource.
|
||||
*/
|
||||
removeUser(userId: string): void {
|
||||
this.sources.delete(userId)
|
||||
}
|
||||
}
|
||||
43
apps/aris-client/.gitignore
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
# Learn more https://docs.github.com/en/get-started/getting-started-with-git/ignoring-files
|
||||
|
||||
# dependencies
|
||||
node_modules/
|
||||
|
||||
# Expo
|
||||
.expo/
|
||||
dist/
|
||||
web-build/
|
||||
expo-env.d.ts
|
||||
|
||||
# Native
|
||||
.kotlin/
|
||||
*.orig.*
|
||||
*.jks
|
||||
*.p8
|
||||
*.p12
|
||||
*.key
|
||||
*.mobileprovision
|
||||
|
||||
# Metro
|
||||
.metro-health-check*
|
||||
|
||||
# debug
|
||||
npm-debug.*
|
||||
yarn-debug.*
|
||||
yarn-error.*
|
||||
|
||||
# macOS
|
||||
.DS_Store
|
||||
*.pem
|
||||
|
||||
# local env files
|
||||
.env*.local
|
||||
|
||||
# typescript
|
||||
*.tsbuildinfo
|
||||
|
||||
app-example
|
||||
|
||||
# generated native folders
|
||||
/ios
|
||||
/android
|
||||
1
apps/aris-client/.vscode/extensions.json
vendored
Normal file
@@ -0,0 +1 @@
|
||||
{ "recommendations": ["expo.vscode-expo-tools"] }
|
||||
7
apps/aris-client/.vscode/settings.json
vendored
Normal file
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"editor.codeActionsOnSave": {
|
||||
"source.fixAll": "explicit",
|
||||
"source.organizeImports": "explicit",
|
||||
"source.sortMembers": "explicit"
|
||||
}
|
||||
}
|
||||
50
apps/aris-client/README.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# Welcome to your Expo app 👋
|
||||
|
||||
This is an [Expo](https://expo.dev) project created with [`create-expo-app`](https://www.npmjs.com/package/create-expo-app).
|
||||
|
||||
## Get started
|
||||
|
||||
1. Install dependencies
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
2. Start the app
|
||||
|
||||
```bash
|
||||
npx expo start
|
||||
```
|
||||
|
||||
In the output, you'll find options to open the app in a
|
||||
|
||||
- [development build](https://docs.expo.dev/develop/development-builds/introduction/)
|
||||
- [Android emulator](https://docs.expo.dev/workflow/android-studio-emulator/)
|
||||
- [iOS simulator](https://docs.expo.dev/workflow/ios-simulator/)
|
||||
- [Expo Go](https://expo.dev/go), a limited sandbox for trying out app development with Expo
|
||||
|
||||
You can start developing by editing the files inside the **app** directory. This project uses [file-based routing](https://docs.expo.dev/router/introduction).
|
||||
|
||||
## Get a fresh project
|
||||
|
||||
When you're ready, run:
|
||||
|
||||
```bash
|
||||
npm run reset-project
|
||||
```
|
||||
|
||||
This command will move the starter code to the **app-example** directory and create a blank **app** directory where you can start developing.
|
||||
|
||||
## Learn more
|
||||
|
||||
To learn more about developing your project with Expo, look at the following resources:
|
||||
|
||||
- [Expo documentation](https://docs.expo.dev/): Learn fundamentals, or go into advanced topics with our [guides](https://docs.expo.dev/guides).
|
||||
- [Learn Expo tutorial](https://docs.expo.dev/tutorial/introduction/): Follow a step-by-step tutorial where you'll create a project that runs on Android, iOS, and the web.
|
||||
|
||||
## Join the community
|
||||
|
||||
Join our community of developers creating universal apps.
|
||||
|
||||
- [Expo on GitHub](https://github.com/expo/expo): View our open source platform and contribute.
|
||||
- [Discord community](https://chat.expo.dev): Chat with Expo users and ask questions.
|
||||
62
apps/aris-client/app.json
Normal file
@@ -0,0 +1,62 @@
|
||||
{
|
||||
"expo": {
|
||||
"name": "Aris",
|
||||
"slug": "aris-client",
|
||||
"version": "1.0.0",
|
||||
"orientation": "portrait",
|
||||
"icon": "./assets/images/icon.png",
|
||||
"scheme": "aris",
|
||||
"userInterfaceStyle": "automatic",
|
||||
"newArchEnabled": true,
|
||||
"ios": {
|
||||
"infoPlist": {
|
||||
"NSAppTransportSecurity": {
|
||||
"NSAllowsArbitraryLoads": true
|
||||
},
|
||||
"ITSAppUsesNonExemptEncryption": false
|
||||
},
|
||||
"bundleIdentifier": "sh.nym.aris"
|
||||
},
|
||||
"android": {
|
||||
"adaptiveIcon": {
|
||||
"backgroundColor": "#E6F4FE",
|
||||
"foregroundImage": "./assets/images/android-icon-foreground.png",
|
||||
"backgroundImage": "./assets/images/android-icon-background.png",
|
||||
"monochromeImage": "./assets/images/android-icon-monochrome.png"
|
||||
},
|
||||
"edgeToEdgeEnabled": true,
|
||||
"predictiveBackGestureEnabled": false,
|
||||
"package": "sh.nym.aris"
|
||||
},
|
||||
"web": {
|
||||
"output": "static",
|
||||
"favicon": "./assets/images/favicon.png"
|
||||
},
|
||||
"plugins": [
|
||||
"expo-router",
|
||||
[
|
||||
"expo-splash-screen",
|
||||
{
|
||||
"image": "./assets/images/splash-icon.png",
|
||||
"imageWidth": 200,
|
||||
"resizeMode": "contain",
|
||||
"backgroundColor": "#ffffff",
|
||||
"dark": {
|
||||
"backgroundColor": "#000000"
|
||||
}
|
||||
}
|
||||
],
|
||||
"expo-font"
|
||||
],
|
||||
"experiments": {
|
||||
"typedRoutes": true,
|
||||
"reactCompiler": true
|
||||
},
|
||||
"extra": {
|
||||
"router": {},
|
||||
"eas": {
|
||||
"projectId": "61092d23-36aa-418e-929d-ea40dc912e8f"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
BIN
apps/aris-client/assets/images/android-icon-background.png
Normal file
|
After Width: | Height: | Size: 17 KiB |
BIN
apps/aris-client/assets/images/android-icon-foreground.png
Normal file
|
After Width: | Height: | Size: 77 KiB |
BIN
apps/aris-client/assets/images/android-icon-monochrome.png
Normal file
|
After Width: | Height: | Size: 4.0 KiB |
BIN
apps/aris-client/assets/images/favicon.png
Normal file
|
After Width: | Height: | Size: 1.1 KiB |
BIN
apps/aris-client/assets/images/icon.png
Normal file
|
After Width: | Height: | Size: 384 KiB |
BIN
apps/aris-client/assets/images/partial-react-logo.png
Normal file
|
After Width: | Height: | Size: 5.0 KiB |
BIN
apps/aris-client/assets/images/react-logo.png
Normal file
|
After Width: | Height: | Size: 6.2 KiB |
BIN
apps/aris-client/assets/images/react-logo@2x.png
Normal file
|
After Width: | Height: | Size: 14 KiB |
BIN
apps/aris-client/assets/images/react-logo@3x.png
Normal file
|
After Width: | Height: | Size: 21 KiB |
BIN
apps/aris-client/assets/images/splash-icon.png
Normal file
|
After Width: | Height: | Size: 17 KiB |
21
apps/aris-client/eas.json
Normal file
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"cli": {
|
||||
"version": ">= 18.0.1",
|
||||
"appVersionSource": "remote"
|
||||
},
|
||||
"build": {
|
||||
"development": {
|
||||
"developmentClient": true,
|
||||
"distribution": "internal"
|
||||
},
|
||||
"preview": {
|
||||
"distribution": "internal"
|
||||
},
|
||||
"production": {
|
||||
"autoIncrement": true
|
||||
}
|
||||
},
|
||||
"submit": {
|
||||
"production": {}
|
||||
}
|
||||
}
|
||||
10
apps/aris-client/eslint.config.js
Normal file
@@ -0,0 +1,10 @@
|
||||
// https://docs.expo.dev/guides/using-eslint/
|
||||
const { defineConfig } = require("eslint/config")
|
||||
const expoConfig = require("eslint-config-expo/flat")
|
||||
|
||||
module.exports = defineConfig([
|
||||
expoConfig,
|
||||
{
|
||||
ignores: ["dist/*"],
|
||||
},
|
||||
])
|
||||
55
apps/aris-client/package.json
Normal file
@@ -0,0 +1,55 @@
|
||||
{
|
||||
"name": "aris-client",
|
||||
"version": "1.0.0",
|
||||
"private": true,
|
||||
"main": "expo-router/entry",
|
||||
"scripts": {
|
||||
"start": "./scripts/run-dev-server.sh",
|
||||
"reset-project": "node ./scripts/reset-project.js",
|
||||
"android": "expo start --android",
|
||||
"ios": "expo start --ios",
|
||||
"web": "expo start --web",
|
||||
"lint": "expo lint",
|
||||
"build:ios": "eas build --profile development --platform ios --non-interactive",
|
||||
"debugger": "bun run scripts/open-debugger.ts"
|
||||
},
|
||||
"dependencies": {
|
||||
"@expo-google-fonts/inter": "^0.4.2",
|
||||
"@expo/vector-icons": "^15.0.3",
|
||||
"@react-navigation/bottom-tabs": "^7.4.0",
|
||||
"@react-navigation/elements": "^2.6.3",
|
||||
"@react-navigation/native": "^7.1.8",
|
||||
"expo": "~54.0.33",
|
||||
"expo-constants": "~18.0.13",
|
||||
"expo-dev-client": "~6.0.20",
|
||||
"expo-font": "~14.0.11",
|
||||
"expo-haptics": "~15.0.8",
|
||||
"expo-image": "~3.0.11",
|
||||
"expo-linking": "~8.0.11",
|
||||
"expo-location": "~19.0.8",
|
||||
"expo-router": "~6.0.23",
|
||||
"expo-splash-screen": "~31.0.13",
|
||||
"expo-status-bar": "~3.0.9",
|
||||
"expo-symbols": "~1.0.8",
|
||||
"expo-system-ui": "~6.0.9",
|
||||
"expo-web-browser": "~15.0.10",
|
||||
"react": "19.1.0",
|
||||
"react-dom": "19.1.0",
|
||||
"react-native": "0.81.5",
|
||||
"react-native-gesture-handler": "~2.28.0",
|
||||
"react-native-reanimated": "~4.1.1",
|
||||
"react-native-safe-area-context": "~5.6.0",
|
||||
"react-native-screens": "~4.16.0",
|
||||
"react-native-svg": "15.12.1",
|
||||
"react-native-web": "~0.21.0",
|
||||
"react-native-worklets": "0.5.1",
|
||||
"twrnc": "^4.16.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/react": "~19.1.0",
|
||||
"eas-cli": "^18.0.1",
|
||||
"eslint": "^9.25.0",
|
||||
"eslint-config-expo": "~10.0.0",
|
||||
"typescript": "~5.9.2"
|
||||
}
|
||||
}
|
||||
127
apps/aris-client/scripts/dev-proxy.ts
Normal file
@@ -0,0 +1,127 @@
|
||||
// Reverse proxy that sits in front of Metro so that all requests
|
||||
// (including those arriving via Tailscale or Ona port-forwarding) reach
|
||||
// Metro as loopback connections. This satisfies the isLocalSocket check
|
||||
// in Expo's debug middleware, making /debugger-frontend, /json, and
|
||||
// /open-debugger accessible from a remote browser.
|
||||
|
||||
import type { ServerWebSocket } from "bun"
|
||||
|
||||
const PROXY_PORT = parseInt(process.env.PROXY_PORT || "8080", 10)
|
||||
const METRO_PORT = parseInt(process.env.METRO_PORT || "8081", 10)
|
||||
const METRO_BASE = `http://127.0.0.1:${METRO_PORT}`
|
||||
|
||||
function forwardHeaders(headers: Headers): Headers {
|
||||
const result = new Headers(headers)
|
||||
result.delete("origin")
|
||||
result.delete("referer")
|
||||
result.set("host", `127.0.0.1:${METRO_PORT}`)
|
||||
return result
|
||||
}
|
||||
|
||||
interface WsData {
|
||||
upstream: WebSocket
|
||||
isDevice: boolean
|
||||
}
|
||||
|
||||
Bun.serve<WsData>({
|
||||
port: PROXY_PORT,
|
||||
|
||||
async fetch(req, server) {
|
||||
const url = new URL(req.url)
|
||||
|
||||
// WebSocket upgrade — bridge to Metro's ws endpoint
|
||||
if (req.headers.get("upgrade")?.toLowerCase() === "websocket") {
|
||||
const wsUrl = `ws://127.0.0.1:${METRO_PORT}${url.pathname}${url.search}`
|
||||
const upstream = new WebSocket(wsUrl)
|
||||
|
||||
// Wait for upstream to connect before upgrading the client
|
||||
try {
|
||||
await new Promise<void>((resolve, reject) => {
|
||||
upstream.addEventListener("open", () => resolve())
|
||||
upstream.addEventListener("error", () => reject(new Error("upstream ws failed")))
|
||||
})
|
||||
} catch {
|
||||
return new Response("Upstream WebSocket unavailable", { status: 502 })
|
||||
}
|
||||
|
||||
const isDevice = url.pathname.startsWith("/inspector/device")
|
||||
const ok = server.upgrade(req, { data: { upstream, isDevice } })
|
||||
if (!ok) {
|
||||
upstream.close()
|
||||
return new Response("WebSocket upgrade failed", { status: 500 })
|
||||
}
|
||||
return undefined
|
||||
}
|
||||
|
||||
// HTTP proxy
|
||||
const upstream = `${METRO_BASE}${url.pathname}${url.search}`
|
||||
const res = await fetch(upstream, {
|
||||
method: req.method,
|
||||
headers: forwardHeaders(req.headers),
|
||||
body: req.body,
|
||||
redirect: "manual",
|
||||
})
|
||||
|
||||
return new Response(res.body, {
|
||||
status: res.status,
|
||||
statusText: res.statusText,
|
||||
headers: res.headers,
|
||||
})
|
||||
},
|
||||
|
||||
websocket: {
|
||||
message(ws: ServerWebSocket<WsData>, msg) {
|
||||
ws.data.upstream.send(msg)
|
||||
},
|
||||
open(ws: ServerWebSocket<WsData>) {
|
||||
const { upstream } = ws.data
|
||||
upstream.addEventListener("message", (ev) => {
|
||||
if (typeof ev.data === "string") {
|
||||
ws.send(ev.data)
|
||||
} else if (ev.data instanceof ArrayBuffer) {
|
||||
ws.sendBinary(new Uint8Array(ev.data))
|
||||
}
|
||||
})
|
||||
upstream.addEventListener("close", () => ws.close())
|
||||
upstream.addEventListener("error", () => ws.close())
|
||||
|
||||
// Print debugger URL shortly after a device connects,
|
||||
// giving Metro time to register the target.
|
||||
if (ws.data.isDevice) {
|
||||
setTimeout(() => printDebuggerUrl(), 1000)
|
||||
}
|
||||
},
|
||||
close(ws: ServerWebSocket<WsData>) {
|
||||
ws.data.upstream.close()
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const tsIp = await Bun.$`tailscale ip -4`.text().then((s) => s.trim())
|
||||
|
||||
async function printDebuggerUrl() {
|
||||
const base = `http://${tsIp}:${PROXY_PORT}`
|
||||
const res = await fetch(`${METRO_BASE}/json`)
|
||||
if (!res.ok) return
|
||||
|
||||
interface DebugTarget {
|
||||
webSocketDebuggerUrl: string
|
||||
reactNative?: {
|
||||
capabilities?: { prefersFuseboxFrontend?: boolean }
|
||||
}
|
||||
}
|
||||
|
||||
const targets: DebugTarget[] = await res.json()
|
||||
const target = targets.find((t) => t.reactNative?.capabilities?.prefersFuseboxFrontend)
|
||||
if (!target) return
|
||||
|
||||
const wsPath = target.webSocketDebuggerUrl
|
||||
.replace(/^ws:\/\//, "")
|
||||
.replace(`127.0.0.1:${METRO_PORT}`, `${tsIp}:${PROXY_PORT}`)
|
||||
|
||||
console.log(
|
||||
`\n React Native DevTools:\n ${base}/debugger-frontend/rn_fusebox.html?ws=${encodeURIComponent(wsPath)}&sources.hide_add_folder=true&unstable_enableNetworkPanel=true\n`,
|
||||
)
|
||||
}
|
||||
|
||||
console.log(`[proxy] listening on :${PROXY_PORT}, forwarding to 127.0.0.1:${METRO_PORT}`)
|
||||
52
apps/aris-client/scripts/open-debugger.ts
Normal file
@@ -0,0 +1,52 @@
|
||||
// Opens React Native DevTools in Chrome, connected to the first
|
||||
// available Hermes debug target. Requires Metro + proxy to be running.
|
||||
|
||||
import { $ } from "bun"
|
||||
|
||||
const PROXY_PORT = process.env.PROXY_PORT || "8080"
|
||||
const METRO_PORT = process.env.METRO_PORT || "8081"
|
||||
const tsIp = (await $`tailscale ip -4`.text()).trim()
|
||||
const base = `http://${tsIp}:${PROXY_PORT}`
|
||||
|
||||
interface DebugTarget {
|
||||
devtoolsFrontendUrl: string
|
||||
webSocketDebuggerUrl: string
|
||||
reactNative?: {
|
||||
capabilities?: {
|
||||
prefersFuseboxFrontend?: boolean
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const res = await fetch(`${base}/json`)
|
||||
if (!res.ok) {
|
||||
console.error("Failed to fetch /json — is Metro running?")
|
||||
process.exit(1)
|
||||
}
|
||||
|
||||
const targets: DebugTarget[] = await res.json()
|
||||
const target = targets.find((t) => t.reactNative?.capabilities?.prefersFuseboxFrontend)
|
||||
|
||||
if (!target) {
|
||||
console.error("No debug target found. Is the app connected?")
|
||||
process.exit(1)
|
||||
}
|
||||
|
||||
const wsUrl = target.webSocketDebuggerUrl
|
||||
.replace(/^ws:\/\//, "")
|
||||
.replace(`127.0.0.1:${METRO_PORT}`, `${tsIp}:${PROXY_PORT}`)
|
||||
|
||||
const url = `${base}/debugger-frontend/rn_fusebox.html?ws=${encodeURIComponent(wsUrl)}&sources.hide_add_folder=true&unstable_enableNetworkPanel=true`
|
||||
|
||||
console.log(url)
|
||||
|
||||
// Open in Chrome app mode if on macOS
|
||||
try {
|
||||
await $`open -a "Google Chrome" --args --app=${url}`.quiet()
|
||||
} catch {
|
||||
try {
|
||||
await $`xdg-open ${url}`.quiet()
|
||||
} catch {
|
||||
console.log("Open the URL above in Chrome.")
|
||||
}
|
||||
}
|
||||
112
apps/aris-client/scripts/reset-project.js
Executable file
@@ -0,0 +1,112 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/**
|
||||
* This script is used to reset the project to a blank state.
|
||||
* It deletes or moves the /app, /components, /hooks, /scripts, and /constants directories to /app-example based on user input and creates a new /app directory with an index.tsx and _layout.tsx file.
|
||||
* You can remove the `reset-project` script from package.json and safely delete this file after running it.
|
||||
*/
|
||||
|
||||
const fs = require("fs")
|
||||
const path = require("path")
|
||||
const readline = require("readline")
|
||||
|
||||
const root = process.cwd()
|
||||
const oldDirs = ["app", "components", "hooks", "constants", "scripts"]
|
||||
const exampleDir = "app-example"
|
||||
const newAppDir = "app"
|
||||
const exampleDirPath = path.join(root, exampleDir)
|
||||
|
||||
const indexContent = `import { Text, View } from "react-native";
|
||||
|
||||
export default function Index() {
|
||||
return (
|
||||
<View
|
||||
style={{
|
||||
flex: 1,
|
||||
justifyContent: "center",
|
||||
alignItems: "center",
|
||||
}}
|
||||
>
|
||||
<Text>Edit app/index.tsx to edit this screen.</Text>
|
||||
</View>
|
||||
);
|
||||
}
|
||||
`
|
||||
|
||||
const layoutContent = `import { Stack } from "expo-router";
|
||||
|
||||
export default function RootLayout() {
|
||||
return <Stack />;
|
||||
}
|
||||
`
|
||||
|
||||
const rl = readline.createInterface({
|
||||
input: process.stdin,
|
||||
output: process.stdout,
|
||||
})
|
||||
|
||||
const moveDirectories = async (userInput) => {
|
||||
try {
|
||||
if (userInput === "y") {
|
||||
// Create the app-example directory
|
||||
await fs.promises.mkdir(exampleDirPath, { recursive: true })
|
||||
console.log(`📁 /${exampleDir} directory created.`)
|
||||
}
|
||||
|
||||
// Move old directories to new app-example directory or delete them
|
||||
for (const dir of oldDirs) {
|
||||
const oldDirPath = path.join(root, dir)
|
||||
if (fs.existsSync(oldDirPath)) {
|
||||
if (userInput === "y") {
|
||||
const newDirPath = path.join(root, exampleDir, dir)
|
||||
await fs.promises.rename(oldDirPath, newDirPath)
|
||||
console.log(`➡️ /${dir} moved to /${exampleDir}/${dir}.`)
|
||||
} else {
|
||||
await fs.promises.rm(oldDirPath, { recursive: true, force: true })
|
||||
console.log(`❌ /${dir} deleted.`)
|
||||
}
|
||||
} else {
|
||||
console.log(`➡️ /${dir} does not exist, skipping.`)
|
||||
}
|
||||
}
|
||||
|
||||
// Create new /app directory
|
||||
const newAppDirPath = path.join(root, newAppDir)
|
||||
await fs.promises.mkdir(newAppDirPath, { recursive: true })
|
||||
console.log("\n📁 New /app directory created.")
|
||||
|
||||
// Create index.tsx
|
||||
const indexPath = path.join(newAppDirPath, "index.tsx")
|
||||
await fs.promises.writeFile(indexPath, indexContent)
|
||||
console.log("📄 app/index.tsx created.")
|
||||
|
||||
// Create _layout.tsx
|
||||
const layoutPath = path.join(newAppDirPath, "_layout.tsx")
|
||||
await fs.promises.writeFile(layoutPath, layoutContent)
|
||||
console.log("📄 app/_layout.tsx created.")
|
||||
|
||||
console.log("\n✅ Project reset complete. Next steps:")
|
||||
console.log(
|
||||
`1. Run \`npx expo start\` to start a development server.\n2. Edit app/index.tsx to edit the main screen.${
|
||||
userInput === "y"
|
||||
? `\n3. Delete the /${exampleDir} directory when you're done referencing it.`
|
||||
: ""
|
||||
}`,
|
||||
)
|
||||
} catch (error) {
|
||||
console.error(`❌ Error during script execution: ${error.message}`)
|
||||
}
|
||||
}
|
||||
|
||||
rl.question(
|
||||
"Do you want to move existing files to /app-example instead of deleting them? (Y/n): ",
|
||||
(answer) => {
|
||||
const userInput = answer.trim().toLowerCase() || "y"
|
||||
if (userInput === "y" || userInput === "n") {
|
||||
moveDirectories(userInput).finally(() => rl.close())
|
||||
} else {
|
||||
console.log("❌ Invalid input. Please enter 'Y' or 'N'.")
|
||||
rl.close()
|
||||
}
|
||||
},
|
||||
)
|
||||
15
apps/aris-client/scripts/run-dev-server.sh
Executable file
@@ -0,0 +1,15 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
PROXY_PORT=8080
|
||||
METRO_PORT=8081
|
||||
|
||||
# Start a reverse proxy so Metro sees all requests as loopback.
|
||||
# This makes debugger endpoints (/debugger-frontend, /json, /open-debugger)
|
||||
# accessible through the Tailscale IP.
|
||||
PROXY_PORT=$PROXY_PORT METRO_PORT=$METRO_PORT bun run scripts/dev-proxy.ts &
|
||||
PROXY_PID=$!
|
||||
trap "kill $PROXY_PID 2>/dev/null" EXIT
|
||||
|
||||
EXPO_PACKAGER_PROXY_URL=http://$(tailscale ip -4):$PROXY_PORT bunx expo start --localhost -p $METRO_PORT
|
||||
|
||||
36
apps/aris-client/src/app/(tabs)/_layout.tsx
Normal file
@@ -0,0 +1,36 @@
|
||||
import { Tabs } from "expo-router"
|
||||
import React from "react"
|
||||
|
||||
import { HapticTab } from "@/components/haptic-tab"
|
||||
import { IconSymbol } from "@/components/ui/icon-symbol"
|
||||
import { Colors } from "@/constants/theme"
|
||||
import { useColorScheme } from "@/hooks/use-color-scheme"
|
||||
|
||||
export default function TabLayout() {
|
||||
const colorScheme = useColorScheme()
|
||||
|
||||
return (
|
||||
<Tabs
|
||||
screenOptions={{
|
||||
tabBarActiveTintColor: Colors[colorScheme ?? "light"].tint,
|
||||
headerShown: false,
|
||||
tabBarButton: HapticTab,
|
||||
}}
|
||||
>
|
||||
<Tabs.Screen
|
||||
name="index"
|
||||
options={{
|
||||
title: "Home",
|
||||
tabBarIcon: ({ color }) => <IconSymbol size={28} name="house.fill" color={color} />,
|
||||
}}
|
||||
/>
|
||||
<Tabs.Screen
|
||||
name="explore"
|
||||
options={{
|
||||
title: "Explore",
|
||||
tabBarIcon: ({ color }) => <IconSymbol size={28} name="paperplane.fill" color={color} />,
|
||||
}}
|
||||
/>
|
||||
</Tabs>
|
||||
)
|
||||
}
|
||||
114
apps/aris-client/src/app/(tabs)/explore.tsx
Normal file
@@ -0,0 +1,114 @@
|
||||
import { Image } from "expo-image"
|
||||
import { Platform, StyleSheet } from "react-native"
|
||||
|
||||
import { ExternalLink } from "@/components/external-link"
|
||||
import ParallaxScrollView from "@/components/parallax-scroll-view"
|
||||
import { ThemedText } from "@/components/themed-text"
|
||||
import { ThemedView } from "@/components/themed-view"
|
||||
import { Collapsible } from "@/components/ui/collapsible"
|
||||
import { IconSymbol } from "@/components/ui/icon-symbol"
|
||||
import { Fonts } from "@/constants/theme"
|
||||
|
||||
export default function TabTwoScreen() {
|
||||
return (
|
||||
<ParallaxScrollView
|
||||
headerBackgroundColor={{ light: "#D0D0D0", dark: "#353636" }}
|
||||
headerImage={
|
||||
<IconSymbol
|
||||
size={310}
|
||||
color="#808080"
|
||||
name="chevron.left.forwardslash.chevron.right"
|
||||
style={styles.headerImage}
|
||||
/>
|
||||
}
|
||||
>
|
||||
<ThemedView style={styles.titleContainer}>
|
||||
<ThemedText
|
||||
type="title"
|
||||
style={{
|
||||
fontFamily: Fonts.rounded,
|
||||
}}
|
||||
>
|
||||
Explore
|
||||
</ThemedText>
|
||||
</ThemedView>
|
||||
<ThemedText>This app includes example code to help you get started.</ThemedText>
|
||||
<Collapsible title="File-based routing">
|
||||
<ThemedText>
|
||||
This app has two screens:{" "}
|
||||
<ThemedText type="defaultSemiBold">app/(tabs)/index.tsx</ThemedText> and{" "}
|
||||
<ThemedText type="defaultSemiBold">app/(tabs)/explore.tsx</ThemedText>
|
||||
</ThemedText>
|
||||
<ThemedText>
|
||||
The layout file in <ThemedText type="defaultSemiBold">app/(tabs)/_layout.tsx</ThemedText>{" "}
|
||||
sets up the tab navigator.
|
||||
</ThemedText>
|
||||
<ExternalLink href="https://docs.expo.dev/router/introduction">
|
||||
<ThemedText type="link">Learn more</ThemedText>
|
||||
</ExternalLink>
|
||||
</Collapsible>
|
||||
<Collapsible title="Android, iOS, and web support">
|
||||
<ThemedText>
|
||||
You can open this project on Android, iOS, and the web. To open the web version, press{" "}
|
||||
<ThemedText type="defaultSemiBold">w</ThemedText> in the terminal running this project.
|
||||
</ThemedText>
|
||||
</Collapsible>
|
||||
<Collapsible title="Images">
|
||||
<ThemedText>
|
||||
For static images, you can use the <ThemedText type="defaultSemiBold">@2x</ThemedText> and{" "}
|
||||
<ThemedText type="defaultSemiBold">@3x</ThemedText> suffixes to provide files for
|
||||
different screen densities
|
||||
</ThemedText>
|
||||
<Image
|
||||
source={require("@assets/images/react-logo.png")}
|
||||
style={{ width: 100, height: 100, alignSelf: "center" }}
|
||||
/>
|
||||
<ExternalLink href="https://reactnative.dev/docs/images">
|
||||
<ThemedText type="link">Learn more</ThemedText>
|
||||
</ExternalLink>
|
||||
</Collapsible>
|
||||
<Collapsible title="Light and dark mode components">
|
||||
<ThemedText>
|
||||
This template has light and dark mode support. The{" "}
|
||||
<ThemedText type="defaultSemiBold">useColorScheme()</ThemedText> hook lets you inspect
|
||||
what the user's current color scheme is, and so you can adjust UI colors accordingly.
|
||||
</ThemedText>
|
||||
<ExternalLink href="https://docs.expo.dev/develop/user-interface/color-themes/">
|
||||
<ThemedText type="link">Learn more</ThemedText>
|
||||
</ExternalLink>
|
||||
</Collapsible>
|
||||
<Collapsible title="Animations">
|
||||
<ThemedText>
|
||||
This template includes an example of an animated component. The{" "}
|
||||
<ThemedText type="defaultSemiBold">components/HelloWave.tsx</ThemedText> component uses
|
||||
the powerful{" "}
|
||||
<ThemedText type="defaultSemiBold" style={{ fontFamily: Fonts.mono }}>
|
||||
react-native-reanimated
|
||||
</ThemedText>{" "}
|
||||
library to create a waving hand animation.
|
||||
</ThemedText>
|
||||
{Platform.select({
|
||||
ios: (
|
||||
<ThemedText>
|
||||
The <ThemedText type="defaultSemiBold">components/ParallaxScrollView.tsx</ThemedText>{" "}
|
||||
component provides a parallax effect for the header image.
|
||||
</ThemedText>
|
||||
),
|
||||
})}
|
||||
</Collapsible>
|
||||
</ParallaxScrollView>
|
||||
)
|
||||
}
|
||||
|
||||
const styles = StyleSheet.create({
|
||||
headerImage: {
|
||||
color: "#808080",
|
||||
bottom: -90,
|
||||
left: -35,
|
||||
position: "absolute",
|
||||
},
|
||||
titleContainer: {
|
||||
flexDirection: "row",
|
||||
gap: 8,
|
||||
},
|
||||
})
|
||||
96
apps/aris-client/src/app/(tabs)/index.tsx
Normal file
@@ -0,0 +1,96 @@
|
||||
import { Image } from "expo-image"
|
||||
import { Link } from "expo-router"
|
||||
import { Platform, StyleSheet } from "react-native"
|
||||
|
||||
import { HelloWave } from "@/components/hello-wave"
|
||||
import ParallaxScrollView from "@/components/parallax-scroll-view"
|
||||
import { ThemedText } from "@/components/themed-text"
|
||||
import { ThemedView } from "@/components/themed-view"
|
||||
|
||||
export default function HomeScreen() {
|
||||
return (
|
||||
<ParallaxScrollView
|
||||
headerBackgroundColor={{ light: "#A1CEDC", dark: "#1D3D47" }}
|
||||
headerImage={
|
||||
<Image source={require("@assets/images/partial-react-logo.png")} style={styles.reactLogo} />
|
||||
}
|
||||
>
|
||||
<ThemedView style={styles.titleContainer}>
|
||||
<ThemedText type="title">Welcome!</ThemedText>
|
||||
<HelloWave />
|
||||
</ThemedView>
|
||||
<ThemedView style={styles.stepContainer}>
|
||||
<ThemedText type="subtitle">Step 1: Try it</ThemedText>
|
||||
<ThemedText>
|
||||
Edit <ThemedText type="defaultSemiBold">app/(tabs)/index.tsx</ThemedText> to see changes.
|
||||
Press{" "}
|
||||
<ThemedText type="defaultSemiBold">
|
||||
{Platform.select({
|
||||
ios: "cmd + d",
|
||||
android: "cmd + m",
|
||||
web: "F12",
|
||||
})}
|
||||
</ThemedText>{" "}
|
||||
to open developer tools.
|
||||
</ThemedText>
|
||||
</ThemedView>
|
||||
<ThemedView style={styles.stepContainer}>
|
||||
<Link href="/modal">
|
||||
<Link.Trigger>
|
||||
<ThemedText type="subtitle">Step 2: Explore</ThemedText>
|
||||
</Link.Trigger>
|
||||
<Link.Preview />
|
||||
<Link.Menu>
|
||||
<Link.MenuAction title="Action" icon="cube" onPress={() => alert("Action pressed")} />
|
||||
<Link.MenuAction
|
||||
title="Share"
|
||||
icon="square.and.arrow.up"
|
||||
onPress={() => alert("Share pressed")}
|
||||
/>
|
||||
<Link.Menu title="More" icon="ellipsis">
|
||||
<Link.MenuAction
|
||||
title="Delete"
|
||||
icon="trash"
|
||||
destructive
|
||||
onPress={() => alert("Delete pressed")}
|
||||
/>
|
||||
</Link.Menu>
|
||||
</Link.Menu>
|
||||
</Link>
|
||||
|
||||
<ThemedText>
|
||||
{`Tap the Explore tab to learn more about what's included in this starter app.`}
|
||||
</ThemedText>
|
||||
</ThemedView>
|
||||
<ThemedView style={styles.stepContainer}>
|
||||
<ThemedText type="subtitle">Step 3: Get a fresh start</ThemedText>
|
||||
<ThemedText>
|
||||
{`When you're ready, run `}
|
||||
<ThemedText type="defaultSemiBold">npm run reset-project</ThemedText> to get a fresh{" "}
|
||||
<ThemedText type="defaultSemiBold">app</ThemedText> directory. This will move the current{" "}
|
||||
<ThemedText type="defaultSemiBold">app</ThemedText> to{" "}
|
||||
<ThemedText type="defaultSemiBold">app-example</ThemedText>.
|
||||
</ThemedText>
|
||||
</ThemedView>
|
||||
</ParallaxScrollView>
|
||||
)
|
||||
}
|
||||
|
||||
const styles = StyleSheet.create({
|
||||
titleContainer: {
|
||||
flexDirection: "row",
|
||||
alignItems: "center",
|
||||
gap: 8,
|
||||
},
|
||||
stepContainer: {
|
||||
gap: 8,
|
||||
marginBottom: 8,
|
||||
},
|
||||
reactLogo: {
|
||||
height: 178,
|
||||
width: 290,
|
||||
bottom: 0,
|
||||
left: 0,
|
||||
position: "absolute",
|
||||
},
|
||||
})
|
||||
23
apps/aris-client/src/app/_layout.tsx
Normal file
@@ -0,0 +1,23 @@
|
||||
import { DarkTheme, DefaultTheme, ThemeProvider } from "@react-navigation/native"
|
||||
import { Stack } from "expo-router"
|
||||
import { StatusBar } from "expo-status-bar"
|
||||
import "react-native-reanimated"
|
||||
import { useColorScheme } from "@/hooks/use-color-scheme"
|
||||
|
||||
export const unstable_settings = {
|
||||
anchor: "(tabs)",
|
||||
}
|
||||
|
||||
export default function RootLayout() {
|
||||
const colorScheme = useColorScheme()
|
||||
|
||||
return (
|
||||
<ThemeProvider value={colorScheme === "dark" ? DarkTheme : DefaultTheme}>
|
||||
<Stack>
|
||||
<Stack.Screen name="(tabs)" options={{ headerShown: false }} />
|
||||
<Stack.Screen name="modal" options={{ presentation: "modal", title: "Modal" }} />
|
||||
</Stack>
|
||||
<StatusBar style="auto" />
|
||||
</ThemeProvider>
|
||||
)
|
||||
}
|
||||
29
apps/aris-client/src/app/modal.tsx
Normal file
@@ -0,0 +1,29 @@
|
||||
import { Link } from "expo-router"
|
||||
import { StyleSheet } from "react-native"
|
||||
|
||||
import { ThemedText } from "@/components/themed-text"
|
||||
import { ThemedView } from "@/components/themed-view"
|
||||
|
||||
export default function ModalScreen() {
|
||||
return (
|
||||
<ThemedView style={styles.container}>
|
||||
<ThemedText type="title">This is a modal</ThemedText>
|
||||
<Link href="/" dismissTo style={styles.link}>
|
||||
<ThemedText type="link">Go to home screen</ThemedText>
|
||||
</Link>
|
||||
</ThemedView>
|
||||
)
|
||||
}
|
||||
|
||||
const styles = StyleSheet.create({
|
||||
container: {
|
||||
flex: 1,
|
||||
alignItems: "center",
|
||||
justifyContent: "center",
|
||||
padding: 20,
|
||||
},
|
||||
link: {
|
||||
marginTop: 15,
|
||||
paddingVertical: 15,
|
||||
},
|
||||
})
|
||||
25
apps/aris-client/src/components/external-link.tsx
Normal file
@@ -0,0 +1,25 @@
|
||||
import { Href, Link } from "expo-router"
|
||||
import { openBrowserAsync, WebBrowserPresentationStyle } from "expo-web-browser"
|
||||
import { type ComponentProps } from "react"
|
||||
|
||||
type Props = Omit<ComponentProps<typeof Link>, "href"> & { href: Href & string }
|
||||
|
||||
export function ExternalLink({ href, ...rest }: Props) {
|
||||
return (
|
||||
<Link
|
||||
target="_blank"
|
||||
{...rest}
|
||||
href={href}
|
||||
onPress={async (event) => {
|
||||
if (process.env.EXPO_OS !== "web") {
|
||||
// Prevent the default behavior of linking to the default browser on native.
|
||||
event.preventDefault()
|
||||
// Open the link in an in-app browser.
|
||||
await openBrowserAsync(href, {
|
||||
presentationStyle: WebBrowserPresentationStyle.AUTOMATIC,
|
||||
})
|
||||
}
|
||||
}}
|
||||
/>
|
||||
)
|
||||
}
|
||||
18
apps/aris-client/src/components/haptic-tab.tsx
Normal file
@@ -0,0 +1,18 @@
|
||||
import { BottomTabBarButtonProps } from "@react-navigation/bottom-tabs"
|
||||
import { PlatformPressable } from "@react-navigation/elements"
|
||||
import * as Haptics from "expo-haptics"
|
||||
|
||||
export function HapticTab(props: BottomTabBarButtonProps) {
|
||||
return (
|
||||
<PlatformPressable
|
||||
{...props}
|
||||
onPressIn={(ev) => {
|
||||
if (process.env.EXPO_OS === "ios") {
|
||||
// Add a soft haptic feedback when pressing down on the tabs.
|
||||
Haptics.impactAsync(Haptics.ImpactFeedbackStyle.Light)
|
||||
}
|
||||
props.onPressIn?.(ev)
|
||||
}}
|
||||
/>
|
||||
)
|
||||
}
|
||||
20
apps/aris-client/src/components/hello-wave.tsx
Normal file
@@ -0,0 +1,20 @@
|
||||
import Animated from "react-native-reanimated"
|
||||
|
||||
export function HelloWave() {
|
||||
return (
|
||||
<Animated.Text
|
||||
style={{
|
||||
fontSize: 28,
|
||||
lineHeight: 32,
|
||||
marginTop: -6,
|
||||
animationName: {
|
||||
"50%": { transform: [{ rotate: "25deg" }] },
|
||||
},
|
||||
animationIterationCount: 4,
|
||||
animationDuration: "300ms",
|
||||
}}
|
||||
>
|
||||
👋
|
||||
</Animated.Text>
|
||||
)
|
||||
}
|
||||
82
apps/aris-client/src/components/parallax-scroll-view.tsx
Normal file
@@ -0,0 +1,82 @@
|
||||
import type { PropsWithChildren, ReactElement } from "react"
|
||||
|
||||
import { StyleSheet } from "react-native"
|
||||
import Animated, {
|
||||
interpolate,
|
||||
useAnimatedRef,
|
||||
useAnimatedStyle,
|
||||
useScrollOffset,
|
||||
} from "react-native-reanimated"
|
||||
|
||||
import { ThemedView } from "@/components/themed-view"
|
||||
import { useColorScheme } from "@/hooks/use-color-scheme"
|
||||
import { useThemeColor } from "@/hooks/use-theme-color"
|
||||
|
||||
const HEADER_HEIGHT = 250
|
||||
|
||||
type Props = PropsWithChildren<{
|
||||
headerImage: ReactElement
|
||||
headerBackgroundColor: { dark: string; light: string }
|
||||
}>
|
||||
|
||||
export default function ParallaxScrollView({
|
||||
children,
|
||||
headerImage,
|
||||
headerBackgroundColor,
|
||||
}: Props) {
|
||||
const backgroundColor = useThemeColor({}, "background")
|
||||
const colorScheme = useColorScheme() ?? "light"
|
||||
const scrollRef = useAnimatedRef<Animated.ScrollView>()
|
||||
const scrollOffset = useScrollOffset(scrollRef)
|
||||
const headerAnimatedStyle = useAnimatedStyle(() => {
|
||||
return {
|
||||
transform: [
|
||||
{
|
||||
translateY: interpolate(
|
||||
scrollOffset.value,
|
||||
[-HEADER_HEIGHT, 0, HEADER_HEIGHT],
|
||||
[-HEADER_HEIGHT / 2, 0, HEADER_HEIGHT * 0.75],
|
||||
),
|
||||
},
|
||||
{
|
||||
scale: interpolate(scrollOffset.value, [-HEADER_HEIGHT, 0, HEADER_HEIGHT], [2, 1, 1]),
|
||||
},
|
||||
],
|
||||
}
|
||||
})
|
||||
|
||||
return (
|
||||
<Animated.ScrollView
|
||||
ref={scrollRef}
|
||||
style={{ backgroundColor, flex: 1 }}
|
||||
scrollEventThrottle={16}
|
||||
>
|
||||
<Animated.View
|
||||
style={[
|
||||
styles.header,
|
||||
{ backgroundColor: headerBackgroundColor[colorScheme] },
|
||||
headerAnimatedStyle,
|
||||
]}
|
||||
>
|
||||
{headerImage}
|
||||
</Animated.View>
|
||||
<ThemedView style={styles.content}>{children}</ThemedView>
|
||||
</Animated.ScrollView>
|
||||
)
|
||||
}
|
||||
|
||||
const styles = StyleSheet.create({
|
||||
container: {
|
||||
flex: 1,
|
||||
},
|
||||
header: {
|
||||
height: HEADER_HEIGHT,
|
||||
overflow: "hidden",
|
||||
},
|
||||
content: {
|
||||
flex: 1,
|
||||
padding: 32,
|
||||
gap: 16,
|
||||
overflow: "hidden",
|
||||
},
|
||||
})
|
||||
60
apps/aris-client/src/components/themed-text.tsx
Normal file
@@ -0,0 +1,60 @@
|
||||
import { StyleSheet, Text, type TextProps } from "react-native"
|
||||
|
||||
import { useThemeColor } from "@/hooks/use-theme-color"
|
||||
|
||||
export type ThemedTextProps = TextProps & {
|
||||
lightColor?: string
|
||||
darkColor?: string
|
||||
type?: "default" | "title" | "defaultSemiBold" | "subtitle" | "link"
|
||||
}
|
||||
|
||||
export function ThemedText({
|
||||
style,
|
||||
lightColor,
|
||||
darkColor,
|
||||
type = "default",
|
||||
...rest
|
||||
}: ThemedTextProps) {
|
||||
const color = useThemeColor({ light: lightColor, dark: darkColor }, "text")
|
||||
|
||||
return (
|
||||
<Text
|
||||
style={[
|
||||
{ color },
|
||||
type === "default" ? styles.default : undefined,
|
||||
type === "title" ? styles.title : undefined,
|
||||
type === "defaultSemiBold" ? styles.defaultSemiBold : undefined,
|
||||
type === "subtitle" ? styles.subtitle : undefined,
|
||||
type === "link" ? styles.link : undefined,
|
||||
style,
|
||||
]}
|
||||
{...rest}
|
||||
/>
|
||||
)
|
||||
}
|
||||
|
||||
const styles = StyleSheet.create({
|
||||
default: {
|
||||
fontSize: 16,
|
||||
lineHeight: 24,
|
||||
},
|
||||
defaultSemiBold: {
|
||||
fontSize: 16,
|
||||
lineHeight: 24,
|
||||
fontWeight: "600",
|
||||
},
|
||||
title: {
|
||||
fontSize: 32,
|
||||
fontWeight: "bold",
|
||||
lineHeight: 32,
|
||||
},
|
||||
subtitle: {
|
||||
fontSize: 20,
|
||||
fontWeight: "bold",
|
||||
},
|
||||
link: {
|
||||
lineHeight: 30,
|
||||
fontSize: 16,
|
||||
color: "#0a7ea4",
|
||||
},
|
||||
})
|
||||
14
apps/aris-client/src/components/themed-view.tsx
Normal file
@@ -0,0 +1,14 @@
|
||||
import { View, type ViewProps } from "react-native"
|
||||
|
||||
import { useThemeColor } from "@/hooks/use-theme-color"
|
||||
|
||||
export type ThemedViewProps = ViewProps & {
|
||||
lightColor?: string
|
||||
darkColor?: string
|
||||
}
|
||||
|
||||
export function ThemedView({ style, lightColor, darkColor, ...otherProps }: ThemedViewProps) {
|
||||
const backgroundColor = useThemeColor({ light: lightColor, dark: darkColor }, "background")
|
||||
|
||||
return <View style={[{ backgroundColor }, style]} {...otherProps} />
|
||||
}
|
||||
46
apps/aris-client/src/components/ui/collapsible.tsx
Normal file
@@ -0,0 +1,46 @@
|
||||
import { PropsWithChildren, useState } from "react"
|
||||
import { StyleSheet, TouchableOpacity } from "react-native"
|
||||
|
||||
import { ThemedText } from "@/components/themed-text"
|
||||
import { ThemedView } from "@/components/themed-view"
|
||||
import { IconSymbol } from "@/components/ui/icon-symbol"
|
||||
import { Colors } from "@/constants/theme"
|
||||
import { useColorScheme } from "@/hooks/use-color-scheme"
|
||||
|
||||
export function Collapsible({ children, title }: PropsWithChildren & { title: string }) {
|
||||
const [isOpen, setIsOpen] = useState(false)
|
||||
const theme = useColorScheme() ?? "light"
|
||||
|
||||
return (
|
||||
<ThemedView>
|
||||
<TouchableOpacity
|
||||
style={styles.heading}
|
||||
onPress={() => setIsOpen((value) => !value)}
|
||||
activeOpacity={0.8}
|
||||
>
|
||||
<IconSymbol
|
||||
name="chevron.right"
|
||||
size={18}
|
||||
weight="medium"
|
||||
color={theme === "light" ? Colors.light.icon : Colors.dark.icon}
|
||||
style={{ transform: [{ rotate: isOpen ? "90deg" : "0deg" }] }}
|
||||
/>
|
||||
|
||||
<ThemedText type="defaultSemiBold">{title}</ThemedText>
|
||||
</TouchableOpacity>
|
||||
{isOpen && <ThemedView style={styles.content}>{children}</ThemedView>}
|
||||
</ThemedView>
|
||||
)
|
||||
}
|
||||
|
||||
const styles = StyleSheet.create({
|
||||
heading: {
|
||||
flexDirection: "row",
|
||||
alignItems: "center",
|
||||
gap: 6,
|
||||
},
|
||||
content: {
|
||||
marginTop: 6,
|
||||
marginLeft: 24,
|
||||
},
|
||||
})
|
||||
32
apps/aris-client/src/components/ui/icon-symbol.ios.tsx
Normal file
@@ -0,0 +1,32 @@
|
||||
import { SymbolView, SymbolViewProps, SymbolWeight } from "expo-symbols"
|
||||
import { StyleProp, ViewStyle } from "react-native"
|
||||
|
||||
export function IconSymbol({
|
||||
name,
|
||||
size = 24,
|
||||
color,
|
||||
style,
|
||||
weight = "regular",
|
||||
}: {
|
||||
name: SymbolViewProps["name"]
|
||||
size?: number
|
||||
color: string
|
||||
style?: StyleProp<ViewStyle>
|
||||
weight?: SymbolWeight
|
||||
}) {
|
||||
return (
|
||||
<SymbolView
|
||||
weight={weight}
|
||||
tintColor={color}
|
||||
resizeMode="scaleAspectFit"
|
||||
name={name}
|
||||
style={[
|
||||
{
|
||||
width: size,
|
||||
height: size,
|
||||
},
|
||||
style,
|
||||
]}
|
||||
/>
|
||||
)
|
||||
}
|
||||
41
apps/aris-client/src/components/ui/icon-symbol.tsx
Normal file
@@ -0,0 +1,41 @@
|
||||
// Fallback for using MaterialIcons on Android and web.
|
||||
|
||||
import MaterialIcons from "@expo/vector-icons/MaterialIcons"
|
||||
import { SymbolWeight, SymbolViewProps } from "expo-symbols"
|
||||
import { ComponentProps } from "react"
|
||||
import { OpaqueColorValue, type StyleProp, type TextStyle } from "react-native"
|
||||
|
||||
type IconMapping = Record<SymbolViewProps["name"], ComponentProps<typeof MaterialIcons>["name"]>
|
||||
type IconSymbolName = keyof typeof MAPPING
|
||||
|
||||
/**
|
||||
* Add your SF Symbols to Material Icons mappings here.
|
||||
* - see Material Icons in the [Icons Directory](https://icons.expo.fyi).
|
||||
* - see SF Symbols in the [SF Symbols](https://developer.apple.com/sf-symbols/) app.
|
||||
*/
|
||||
const MAPPING = {
|
||||
"house.fill": "home",
|
||||
"paperplane.fill": "send",
|
||||
"chevron.left.forwardslash.chevron.right": "code",
|
||||
"chevron.right": "chevron-right",
|
||||
} as IconMapping
|
||||
|
||||
/**
|
||||
* An icon component that uses native SF Symbols on iOS, and Material Icons on Android and web.
|
||||
* This ensures a consistent look across platforms, and optimal resource usage.
|
||||
* Icon `name`s are based on SF Symbols and require manual mapping to Material Icons.
|
||||
*/
|
||||
export function IconSymbol({
|
||||
name,
|
||||
size = 24,
|
||||
color,
|
||||
style,
|
||||
}: {
|
||||
name: IconSymbolName
|
||||
size?: number
|
||||
color: string | OpaqueColorValue
|
||||
style?: StyleProp<TextStyle>
|
||||
weight?: SymbolWeight
|
||||
}) {
|
||||
return <MaterialIcons color={color} size={size} name={MAPPING[name]} style={style} />
|
||||
}
|
||||
53
apps/aris-client/src/constants/theme.ts
Normal file
@@ -0,0 +1,53 @@
|
||||
/**
|
||||
* Below are the colors that are used in the app. The colors are defined in the light and dark mode.
|
||||
* There are many other ways to style your app. For example, [Nativewind](https://www.nativewind.dev/), [unistyles](https://reactnativeunistyles.vercel.app), etc.
|
||||
*/
|
||||
|
||||
import { Platform } from "react-native"
|
||||
|
||||
const tintColorLight = "#0a7ea4"
|
||||
const tintColorDark = "#fff"
|
||||
|
||||
export const Colors = {
|
||||
light: {
|
||||
text: "#11181C",
|
||||
background: "#fff",
|
||||
tint: tintColorLight,
|
||||
icon: "#687076",
|
||||
tabIconDefault: "#687076",
|
||||
tabIconSelected: tintColorLight,
|
||||
},
|
||||
dark: {
|
||||
text: "#ECEDEE",
|
||||
background: "#151718",
|
||||
tint: tintColorDark,
|
||||
icon: "#9BA1A6",
|
||||
tabIconDefault: "#9BA1A6",
|
||||
tabIconSelected: tintColorDark,
|
||||
},
|
||||
}
|
||||
|
||||
export const Fonts = Platform.select({
|
||||
ios: {
|
||||
/** iOS `UIFontDescriptorSystemDesignDefault` */
|
||||
sans: "system-ui",
|
||||
/** iOS `UIFontDescriptorSystemDesignSerif` */
|
||||
serif: "ui-serif",
|
||||
/** iOS `UIFontDescriptorSystemDesignRounded` */
|
||||
rounded: "ui-rounded",
|
||||
/** iOS `UIFontDescriptorSystemDesignMonospaced` */
|
||||
mono: "ui-monospace",
|
||||
},
|
||||
default: {
|
||||
sans: "normal",
|
||||
serif: "serif",
|
||||
rounded: "normal",
|
||||
mono: "monospace",
|
||||
},
|
||||
web: {
|
||||
sans: "system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif",
|
||||
serif: "Georgia, 'Times New Roman', serif",
|
||||
rounded: "'SF Pro Rounded', 'Hiragino Maru Gothic ProN', Meiryo, 'MS PGothic', sans-serif",
|
||||
mono: "SFMono-Regular, Menlo, Monaco, Consolas, 'Liberation Mono', 'Courier New', monospace",
|
||||
},
|
||||
})
|
||||
1
apps/aris-client/src/hooks/use-color-scheme.ts
Normal file
@@ -0,0 +1 @@
|
||||
export { useColorScheme } from "react-native"
|
||||
21
apps/aris-client/src/hooks/use-color-scheme.web.ts
Normal file
@@ -0,0 +1,21 @@
|
||||
import { useEffect, useState } from "react"
|
||||
import { useColorScheme as useRNColorScheme } from "react-native"
|
||||
|
||||
/**
|
||||
* To support static rendering, this value needs to be re-calculated on the client side for web
|
||||
*/
|
||||
export function useColorScheme() {
|
||||
const [hasHydrated, setHasHydrated] = useState(false)
|
||||
|
||||
useEffect(() => {
|
||||
setHasHydrated(true)
|
||||
}, [])
|
||||
|
||||
const colorScheme = useRNColorScheme()
|
||||
|
||||
if (hasHydrated) {
|
||||
return colorScheme
|
||||
}
|
||||
|
||||
return "light"
|
||||
}
|
||||
21
apps/aris-client/src/hooks/use-theme-color.ts
Normal file
@@ -0,0 +1,21 @@
|
||||
/**
|
||||
* Learn more about light and dark modes:
|
||||
* https://docs.expo.dev/guides/color-schemes/
|
||||
*/
|
||||
|
||||
import { Colors } from "@/constants/theme"
|
||||
import { useColorScheme } from "@/hooks/use-color-scheme"
|
||||
|
||||
export function useThemeColor(
|
||||
props: { light?: string; dark?: string },
|
||||
colorName: keyof typeof Colors.light & keyof typeof Colors.dark,
|
||||
) {
|
||||
const theme = useColorScheme() ?? "light"
|
||||
const colorFromProps = props[theme]
|
||||
|
||||
if (colorFromProps) {
|
||||
return colorFromProps
|
||||
} else {
|
||||
return Colors[theme][colorName]
|
||||
}
|
||||
}
|
||||
11
apps/aris-client/tsconfig.json
Normal file
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"extends": "expo/tsconfig.base",
|
||||
"compilerOptions": {
|
||||
"strict": true,
|
||||
"paths": {
|
||||
"@/*": ["./src/*"],
|
||||
"@assets/*": ["./assets/*"]
|
||||
}
|
||||
},
|
||||
"include": ["**/*.ts", "**/*.tsx", ".expo/types/**/*.ts", "expo-env.d.ts"]
|
||||
}
|
||||
306
docs/backend-service-architecture-spec.md
Normal file
@@ -0,0 +1,306 @@
|
||||
# Backend Service Architecture: Per-User Refactor
|
||||
|
||||
## Problem Statement
|
||||
|
||||
The current backend uses a **per-source service** pattern: each source type (Location, Weather, TFL) has its own `XxxService` class that manages a `Map<userId, SourceInstance>`. Adding a new source requires:
|
||||
|
||||
1. A new `XxxService` class with identical boilerplate (~30-40 lines: Map, get-or-create, removeUser)
|
||||
2. Wiring it into `server.ts` constructor
|
||||
3. Passing it to `FeedEngineService`
|
||||
4. Optionally adding source-specific tRPC routes
|
||||
|
||||
With 3 sources this is manageable. With 10+ (calendar, music, transit, news, etc.) it becomes:
|
||||
|
||||
- **Repetitive**: Every service class repeats the same Map + get-or-create + removeUser pattern
|
||||
- **Fragmented lifecycle**: User cleanup requires calling `removeUser` on every service independently
|
||||
- **No user-level config**: No unified place to store which sources a user has enabled or their per-source settings
|
||||
- **Hard to reason about**: User state is scattered across N independent Maps
|
||||
|
||||
### Current Flow
|
||||
|
||||
```
|
||||
server.ts
|
||||
├── new LocationService() ← owns Map<userId, LocationSource>
|
||||
├── new WeatherService(creds) ← owns Map<userId, WeatherSource>
|
||||
├── new TflService(api) ← owns Map<userId, TflSource>
|
||||
└── FeedEngineService([loc, weather, tfl])
|
||||
└── owns Map<userId, FeedEngine>
|
||||
└── on create: asks each service for feedSourceForUser(userId)
|
||||
```
|
||||
|
||||
4 independent Maps for 3 sources. Each user's state lives in 4 different places.
|
||||
|
||||
## Scope
|
||||
|
||||
**Backend only** (`apps/aris-backend`). No changes to `aris-core` or source packages (`packages/aris-source-*`). The `FeedSource` interface and source implementations remain unchanged.
|
||||
|
||||
## Architectural Options
|
||||
|
||||
### Option A: UserSession Object
|
||||
|
||||
A single `UserSession` class owns everything for one user. A `UserSessionManager` is the only top-level Map.
|
||||
|
||||
```typescript
|
||||
class UserSession {
|
||||
readonly userId: string
|
||||
readonly engine: FeedEngine
|
||||
private sources: Map<string, FeedSource>
|
||||
|
||||
constructor(userId: string, sourceFactories: SourceFactory[]) {
|
||||
this.engine = new FeedEngine()
|
||||
this.sources = new Map()
|
||||
for (const factory of sourceFactories) {
|
||||
const source = factory.create()
|
||||
this.sources.set(source.id, source)
|
||||
this.engine.register(source)
|
||||
}
|
||||
this.engine.start()
|
||||
}
|
||||
|
||||
getSource<T extends FeedSource>(id: string): T | undefined {
|
||||
return this.sources.get(id) as T | undefined
|
||||
}
|
||||
|
||||
destroy(): void {
|
||||
this.engine.stop()
|
||||
this.sources.clear()
|
||||
}
|
||||
}
|
||||
|
||||
class UserSessionManager {
|
||||
private sessions = new Map<string, UserSession>()
|
||||
|
||||
getOrCreate(userId: string): UserSession { ... }
|
||||
remove(userId: string): void { ... } // single cleanup point
|
||||
}
|
||||
```
|
||||
|
||||
**Source-specific operations** use typed accessors:
|
||||
|
||||
```typescript
|
||||
const session = manager.getOrCreate(userId)
|
||||
const location = session.getSource<LocationSource>("location")
|
||||
location?.pushLocation({ lat: 51.5, lng: -0.1, ... })
|
||||
```
|
||||
|
||||
**Pros:**
|
||||
|
||||
- Single Map, single cleanup point
|
||||
- All user state co-located
|
||||
- Easy to add TTL/eviction at one level
|
||||
- Source factories are simple functions, no service classes needed
|
||||
|
||||
**Cons:**
|
||||
|
||||
- `getSource<T>("id")` requires callers to know the source ID string and cast type
|
||||
- Shared resources (e.g., TFL API client) need to be passed through factories
|
||||
|
||||
### Option B: Source Registry with Factories
|
||||
|
||||
Keep `FeedEngineService` but replace per-source service classes with a registry of factory functions. No `XxxService` classes at all.
|
||||
|
||||
```typescript
|
||||
interface SourceFactory {
|
||||
readonly sourceId: string
|
||||
create(userId: string): FeedSource
|
||||
}
|
||||
|
||||
// Weather factory — closure over shared credentials
|
||||
function weatherSourceFactory(creds: WeatherKitCredentials): SourceFactory {
|
||||
return {
|
||||
sourceId: "weather",
|
||||
create: () => new WeatherSource({ credentials: creds }),
|
||||
}
|
||||
}
|
||||
|
||||
// TFL factory — closure over shared API client
|
||||
function tflSourceFactory(api: ITflApi): SourceFactory {
|
||||
return {
|
||||
sourceId: "tfl",
|
||||
create: () => new TflSource({ client: api }),
|
||||
}
|
||||
}
|
||||
|
||||
class FeedEngineService {
|
||||
private engines = new Map<string, FeedEngine>()
|
||||
private userSources = new Map<string, Map<string, FeedSource>>()
|
||||
|
||||
constructor(private readonly factories: SourceFactory[]) {}
|
||||
|
||||
engineForUser(userId: string): FeedEngine { ... }
|
||||
getSourceForUser<T extends FeedSource>(userId: string, sourceId: string): T | undefined { ... }
|
||||
removeUser(userId: string): void { ... } // cleans up engine + all sources
|
||||
}
|
||||
```
|
||||
|
||||
**Pros:**
|
||||
|
||||
- Minimal change from current structure — `FeedEngineService` evolves, services disappear
|
||||
- Factory functions are 5-10 lines each, no classes
|
||||
- Shared resources handled naturally via closures
|
||||
|
||||
**Cons:**
|
||||
|
||||
- `FeedEngineService` grows in responsibility (engine + source tracking + source access)
|
||||
- Still two Maps (engines + userSources), though co-located
|
||||
|
||||
### Option C: UserSession + Typed Source Handles (Recommended)
|
||||
|
||||
Combines Option A's co-location with type-safe source access. `UserSession` owns everything. Source-specific operations go through **source handles** — thin typed wrappers registered at setup time.
|
||||
|
||||
```typescript
|
||||
// Source handle: typed wrapper for source-specific operations
|
||||
interface SourceHandle<T extends FeedSource = FeedSource> {
|
||||
readonly source: T
|
||||
}
|
||||
|
||||
class UserSession {
|
||||
readonly engine: FeedEngine
|
||||
private handles = new Map<string, SourceHandle>()
|
||||
|
||||
register<T extends FeedSource>(source: T): SourceHandle<T> {
|
||||
this.engine.register(source)
|
||||
const handle: SourceHandle<T> = { source }
|
||||
this.handles.set(source.id, handle)
|
||||
return handle
|
||||
}
|
||||
|
||||
destroy(): void {
|
||||
this.engine.stop()
|
||||
this.handles.clear()
|
||||
}
|
||||
}
|
||||
|
||||
// In setup code — handles are typed at creation time
|
||||
function createSession(userId: string, deps: SessionDeps): UserSession {
|
||||
const session = new UserSession(userId)
|
||||
|
||||
const locationHandle = session.register(new LocationSource())
|
||||
const weatherHandle = session.register(new WeatherSource(deps.weatherCreds))
|
||||
const tflHandle = session.register(new TflSource({ client: deps.tflApi }))
|
||||
|
||||
return session
|
||||
}
|
||||
```
|
||||
|
||||
**Source-specific operations** use the typed handles returned at registration:
|
||||
|
||||
```typescript
|
||||
// In the tRPC router or wherever source-specific ops happen:
|
||||
// The handle is obtained during session setup and stored where needed
|
||||
locationHandle.source.pushLocation({ ... })
|
||||
tflHandle.source.setLinesOfInterest(["northern"])
|
||||
```
|
||||
|
||||
**Pros:**
|
||||
|
||||
- Single Map, single cleanup
|
||||
- Type-safe source access without string-based lookups or casts
|
||||
- No boilerplate service classes
|
||||
- Handles can be extended later (e.g., add per-source config, metrics)
|
||||
- Shared resources passed directly to constructors
|
||||
|
||||
**Cons:**
|
||||
|
||||
- Handles need to be threaded to where they're used (tRPC routers, etc.)
|
||||
- Slightly more setup code in the factory function
|
||||
|
||||
## Source-Specific Operations: Approaches
|
||||
|
||||
Orthogonal to the session model, there are three ways to handle operations like `pushLocation` or `setLinesOfInterest`:
|
||||
|
||||
### Approach 1: Direct Source Access (Recommended)
|
||||
|
||||
Callers get a typed reference to the source and call methods directly. This is what all three options above use in different ways.
|
||||
|
||||
```typescript
|
||||
locationSource.pushLocation(location)
|
||||
tflSource.setLinesOfInterest(lines)
|
||||
```
|
||||
|
||||
**Why this works:** Source packages already define these methods. The backend just needs to expose the source instance to the right caller. No new abstraction needed.
|
||||
|
||||
### Approach 2: Command Dispatch
|
||||
|
||||
A generic `dispatch(command)` method on the session routes typed commands to sources.
|
||||
|
||||
```typescript
|
||||
session.dispatch({ type: "location.update", payload: { lat: 51.5, ... } })
|
||||
```
|
||||
|
||||
**Tradeoff:** Adds indirection and a command type registry. Useful if sources are dynamically loaded plugins, but over-engineered for the current case where sources are known at compile time.
|
||||
|
||||
### Approach 3: Context-Only
|
||||
|
||||
All input goes through `FeedEngine` context updates. Sources react to context changes.
|
||||
|
||||
```typescript
|
||||
engine.pushContext({ [LocationKey]: location })
|
||||
// LocationSource picks this up via onContextUpdate
|
||||
```
|
||||
|
||||
**Tradeoff:** Location already works this way (it's a context provider). But not all operations map to context — `setLinesOfInterest` is configuration, not context. Would require stretching the context concept.
|
||||
|
||||
## User Source Configuration (DB-Persisted)
|
||||
|
||||
Regardless of which option is chosen, user source config needs a storage model:
|
||||
|
||||
```sql
|
||||
CREATE TABLE user_source_config (
|
||||
user_id TEXT NOT NULL REFERENCES users(id),
|
||||
source_id TEXT NOT NULL, -- e.g., "weather", "tfl", "location"
|
||||
enabled BOOLEAN NOT NULL DEFAULT true,
|
||||
config JSONB NOT NULL DEFAULT '{}', -- source-specific settings
|
||||
PRIMARY KEY (user_id, source_id)
|
||||
);
|
||||
```
|
||||
|
||||
On session creation:
|
||||
|
||||
1. Load `user_source_config` rows for the user
|
||||
2. Only create sources where `enabled = true`
|
||||
3. Pass `config` JSON to the source factory/constructor
|
||||
|
||||
New users get default config rows inserted on first login.
|
||||
|
||||
## Recommendation
|
||||
|
||||
**Option C (UserSession + Typed Source Handles)** with **Approach 1 (Direct Source Access)**.
|
||||
|
||||
Rationale:
|
||||
|
||||
- Eliminates all per-source service boilerplate
|
||||
- Single user lifecycle management point
|
||||
- Type-safe without string-based lookups in hot paths
|
||||
- Minimal new abstraction — `UserSession` is a thin container, not a framework
|
||||
- Handles are just typed references, not a new pattern to learn
|
||||
- Natural extension point for per-user config loading from DB
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
1. **No per-source service classes**: `LocationService`, `WeatherService`, `TflService` are removed
|
||||
2. **Single user state container**: All per-user state (engine, sources) lives in one object
|
||||
3. **Single cleanup**: Removing a user requires one call, not N
|
||||
4. **Type-safe source access**: Source-specific operations don't require string-based lookups or unsafe casts at call sites
|
||||
5. **Existing tests pass**: `FeedEngineService` tests are migrated to the new structure
|
||||
6. **tRPC routes work**: Location update route works through the new architecture
|
||||
7. **DB config table**: `user_source_config` table exists; session creation reads from it
|
||||
8. **Default config**: New users get default source config on first session
|
||||
|
||||
## Implementation Steps
|
||||
|
||||
1. Create `user_source_config` DB table and migration
|
||||
2. Create `UserSession` class with `register()`, `destroy()`, typed handle return
|
||||
3. Create `UserSessionManager` with `getOrCreate()`, `remove()`, config loading
|
||||
4. Create `createSession()` factory that reads DB config and registers enabled sources
|
||||
5. Refactor `server.ts` to use `UserSessionManager` instead of individual services
|
||||
6. Refactor tRPC router to receive session/handles instead of individual services
|
||||
7. Delete `LocationService`, `WeatherService`, `TflService` classes
|
||||
8. Migrate existing tests to new structure
|
||||
9. Add tests for session lifecycle (create, destroy, config loading)
|
||||
|
||||
## Open Questions
|
||||
|
||||
- **TTL/eviction**: Should `UserSessionManager` handle idle session cleanup? (Currently deferred in backend-spec.md)
|
||||
- **Hot reload config**: If a user changes their source config, should the session be recreated or patched in-place?
|
||||
- **Shared source instances**: Some sources (e.g., TFL) share an API client. Should the factory receive shared deps, or should there be a DI container?
|
||||
269
docs/feed-source-actions-spec.md
Normal file
@@ -0,0 +1,269 @@
|
||||
# FeedSource Actions
|
||||
|
||||
## Problem Statement
|
||||
|
||||
`FeedSource` is read-only. Sources can provide context and feed items but can't expose write operations (play, RSVP, dismiss). This blocks interactive sources like Spotify, calendar, and tasks.
|
||||
|
||||
## Scope
|
||||
|
||||
**`aris-core` only.** Add action support to `FeedSource` and `FeedItem`. No changes to existing fields or methods — purely additive.
|
||||
|
||||
## Design
|
||||
|
||||
### Why Not MCP
|
||||
|
||||
MCP was considered. It doesn't fit because:
|
||||
|
||||
- MCP resources don't accept input context (FeedSource needs accumulated context as input)
|
||||
- MCP has no structured feed items (priority, timestamp, type)
|
||||
- MCP's isolation model conflicts with ARIS's dependency graph
|
||||
- Adding these as MCP extensions would mean the extensions are the entire protocol
|
||||
|
||||
The interface is designed to be **protocol-compatible** — a future `RemoteFeedSource` adapter can map each field/method to a JSON-RPC operation without changing the interface:
|
||||
|
||||
| FeedSource field/method | Future protocol operation |
|
||||
| ----------------------- | ------------------------- |
|
||||
| `id`, `dependencies` | `source/describe` |
|
||||
| `listActions()` | `source/listActions` |
|
||||
| `fetchContext()` | `source/fetchContext` |
|
||||
| `fetchItems()` | `source/fetchItems` |
|
||||
| `executeAction()` | `source/executeAction` |
|
||||
| `onContextUpdate()` | `source/contextUpdated` |
|
||||
| `onItemsUpdate()` | `source/itemsUpdated` |
|
||||
|
||||
No interface changes needed when the transport layer is built.
|
||||
|
||||
### Source ID & Action ID Convention
|
||||
|
||||
Source IDs use reverse domain notation. Built-in sources use `aris.<name>`. Third parties use their own domain.
|
||||
|
||||
Action IDs are descriptive verb-noun pairs in kebab-case, scoped to their source. The globally unique form is `<sourceId>/<actionId>`.
|
||||
|
||||
| Source ID | Action IDs |
|
||||
| --------------- | -------------------------------------------------------------- |
|
||||
| `aris.location` | `update-location` (migrated from `pushLocation()`) |
|
||||
| `aris.tfl` | `set-lines-of-interest` (migrated from `setLinesOfInterest()`) |
|
||||
| `aris.weather` | _(none)_ |
|
||||
| `com.spotify` | `play-track`, `pause-playback`, `skip-track`, `like-track` |
|
||||
| `aris.calendar` | `rsvp`, `create-event` |
|
||||
| `com.todoist` | `complete-task`, `snooze-task` |
|
||||
|
||||
This means existing source packages need their `id` updated (e.g., `"location"` → `"aris.location"`).
|
||||
|
||||
### New Types
|
||||
|
||||
```typescript
|
||||
/** Describes an action a source can perform. */
|
||||
interface ActionDefinition<TInput = unknown> {
|
||||
/** Descriptive action name in kebab-case (e.g., "update-location", "play-track") */
|
||||
readonly id: string
|
||||
/** Human-readable label for UI (e.g., "Play", "RSVP Yes") */
|
||||
readonly label: string
|
||||
/** Optional longer description */
|
||||
readonly description?: string
|
||||
/** Schema for input validation. Accepts any Standard Schema compatible validator (arktype, zod, valibot, etc.). Omit if no params. */
|
||||
readonly input?: StandardSchemaV1<TInput>
|
||||
}
|
||||
```
|
||||
|
||||
`StandardSchemaV1` is the [Standard Schema](https://github.com/standard-schema/standard-schema) interface implemented by arktype, zod, and valibot. This means sources can use any validator:
|
||||
|
||||
```typescript
|
||||
import { type } from "arktype"
|
||||
import { z } from "zod"
|
||||
|
||||
// With arktype
|
||||
{ id: "play-track", label: "Play", input: type({ trackId: "string" }) }
|
||||
|
||||
// With zod
|
||||
{ id: "play-track", label: "Play", input: z.object({ trackId: z.string() }) }
|
||||
|
||||
// Without validation (e.g., remote sources using raw JSON Schema)
|
||||
{ id: "play-track", label: "Play" }
|
||||
|
||||
/** Result of executing an action. */
|
||||
interface ActionResult {
|
||||
ok: boolean
|
||||
data?: Record<string, unknown>
|
||||
error?: string
|
||||
}
|
||||
|
||||
/** Reference to an action on a specific feed item. */
|
||||
interface ItemAction {
|
||||
/** Action ID (matches ActionDefinition.id on the source) */
|
||||
actionId: string
|
||||
/** Per-item label override (e.g., "RSVP to standup") */
|
||||
label?: string
|
||||
/** Pre-filled params for this item (e.g., { eventId: "abc" }) */
|
||||
params?: Record<string, unknown>
|
||||
}
|
||||
```
|
||||
|
||||
### Changes to FeedSource
|
||||
|
||||
Two optional fields added. Nothing else changes.
|
||||
|
||||
```typescript
|
||||
interface FeedSource<TItem extends FeedItem = FeedItem> {
|
||||
readonly id: string // unchanged
|
||||
readonly dependencies?: readonly string[] // unchanged
|
||||
fetchContext(...): ... // unchanged
|
||||
onContextUpdate?(...): ... // unchanged
|
||||
fetchItems?(...): ... // unchanged
|
||||
onItemsUpdate?(...): ... // unchanged
|
||||
|
||||
/** List actions this source supports. Empty record if none. Maps to: source/listActions */
|
||||
listActions(): Promise<Record<string, ActionDefinition>>
|
||||
|
||||
/** Execute an action by ID. No-op returning { ok: false } if source has no actions. */
|
||||
executeAction(
|
||||
actionId: string,
|
||||
params: Record<string, unknown>,
|
||||
): Promise<ActionResult>
|
||||
}
|
||||
```
|
||||
|
||||
### Changes to FeedItem
|
||||
|
||||
One optional field added.
|
||||
|
||||
```typescript
|
||||
interface FeedItem<
|
||||
TType extends string = string,
|
||||
TData extends Record<string, unknown> = Record<string, unknown>,
|
||||
> {
|
||||
id: string // unchanged
|
||||
type: TType // unchanged
|
||||
priority: number // unchanged
|
||||
timestamp: Date // unchanged
|
||||
data: TData // unchanged
|
||||
|
||||
/** Actions the user can take on this item. */
|
||||
actions?: readonly ItemAction[]
|
||||
}
|
||||
```
|
||||
|
||||
### Changes to FeedEngine
|
||||
|
||||
Two new methods. Existing methods unchanged.
|
||||
|
||||
```typescript
|
||||
class FeedEngine {
|
||||
// All existing methods unchanged...
|
||||
|
||||
/** Route an action call to the correct source. */
|
||||
async executeAction(
|
||||
sourceId: string,
|
||||
actionId: string,
|
||||
params: Record<string, unknown>,
|
||||
): Promise<ActionResult>
|
||||
|
||||
/** List all actions across all registered sources. */
|
||||
listActions(): { sourceId: string; actions: readonly ActionDefinition[] }[]
|
||||
}
|
||||
```
|
||||
|
||||
### Example: Spotify Source
|
||||
|
||||
```typescript
|
||||
class SpotifySource implements FeedSource<SpotifyFeedItem> {
|
||||
readonly id = "com.spotify"
|
||||
|
||||
async listActions() {
|
||||
return {
|
||||
"play-track": { id: "play-track", label: "Play", input: type({ trackId: "string" }) },
|
||||
"pause-playback": { id: "pause-playback", label: "Pause" },
|
||||
"skip-track": { id: "skip-track", label: "Skip" },
|
||||
"like-track": { id: "like-track", label: "Like", input: type({ trackId: "string" }) },
|
||||
}
|
||||
}
|
||||
|
||||
async executeAction(actionId: string, params: Record<string, unknown>): Promise<ActionResult> {
|
||||
switch (actionId) {
|
||||
case "play-track":
|
||||
await this.client.play(params.trackId as string)
|
||||
return { ok: true }
|
||||
case "pause-playback":
|
||||
await this.client.pause()
|
||||
return { ok: true }
|
||||
case "skip-track":
|
||||
await this.client.skip()
|
||||
return { ok: true }
|
||||
case "like-track":
|
||||
await this.client.like(params.trackId as string)
|
||||
return { ok: true }
|
||||
default:
|
||||
return { ok: false, error: `Unknown action: ${actionId}` }
|
||||
}
|
||||
}
|
||||
|
||||
async fetchContext(): Promise<null> {
|
||||
return null
|
||||
}
|
||||
|
||||
// Note: for a source with no actions, it would be:
|
||||
// async listActions() { return {} }
|
||||
// async executeAction(): Promise<ActionResult> {
|
||||
// return { ok: false, error: "No actions supported" }
|
||||
// }
|
||||
|
||||
async fetchItems(context: Context): Promise<SpotifyFeedItem[]> {
|
||||
const track = await this.client.getCurrentTrack()
|
||||
if (!track) return []
|
||||
return [
|
||||
{
|
||||
id: `spotify-${track.id}`,
|
||||
type: "spotify-now-playing",
|
||||
priority: 0.4,
|
||||
timestamp: context.time,
|
||||
data: { trackName: track.name, artist: track.artist },
|
||||
actions: [
|
||||
{ actionId: "pause-playback" },
|
||||
{ actionId: "skip-track" },
|
||||
{ actionId: "like-track", params: { trackId: track.id } },
|
||||
],
|
||||
},
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
1. `ActionDefinition` type exists with `id`, `label`, `description?`, `inputSchema?`
|
||||
2. `ActionResult` type exists with `ok`, `data?`, `error?`
|
||||
3. `ItemAction` type exists with `actionId`, `label?`, `params?`
|
||||
4. `FeedSource.listActions()` is a required method returning `Record<string, ActionDefinition>` (empty record if no actions)
|
||||
5. `FeedSource.executeAction()` is a required method (no-op for sources without actions)
|
||||
6. `FeedItem.actions` is an optional readonly array of `ItemAction`
|
||||
7. `FeedEngine.executeAction()` routes to correct source, returns `ActionResult`
|
||||
8. `FeedEngine.listActions()` aggregates actions from all sources
|
||||
9. Existing tests pass unchanged (all changes are additive)
|
||||
10. New tests: action execution, unknown action ID, unknown source ID, source without actions, `listActions()` aggregation
|
||||
|
||||
## Implementation Steps
|
||||
|
||||
1. Create `action.ts` in `aris-core/src` with `ActionDefinition`, `ActionResult`, `ItemAction`
|
||||
2. Add optional `actions` and `executeAction` to `FeedSource` interface in `feed-source.ts`
|
||||
3. Add optional `actions` field to `FeedItem` interface in `feed.ts`
|
||||
4. Add `executeAction()` and `listActions()` to `FeedEngine` in `feed-engine.ts`
|
||||
5. Export new types from `aris-core/index.ts`
|
||||
6. Add tests for `FeedEngine.executeAction()` routing
|
||||
7. Add tests for `FeedEngine.listActions()` aggregation
|
||||
8. Add tests for error cases (unknown action, unknown source, source without actions)
|
||||
9. Update source IDs to reverse-domain format (`"location"` → `"aris.location"`, etc.) across all source packages
|
||||
10. Migrate `LocationSource.pushLocation()` → action `update-location` on `aris.location`
|
||||
11. Migrate `TflSource.setLinesOfInterest()` → action `set-lines-of-interest` on `aris.tfl`
|
||||
12. Add `async listActions() { return {} }` and no-op `executeAction()` to sources without actions (WeatherSource, GoogleCalendarSource, AppleCalendarSource)
|
||||
13. Update any tests or code referencing old source IDs
|
||||
14. Run all tests to confirm nothing breaks
|
||||
|
||||
## What This Defers
|
||||
|
||||
- Transport layer (JSON-RPC over HTTP/WebSocket) — built when remote sources are needed
|
||||
- `RemoteFeedSource` adapter — mechanical once transport exists
|
||||
- MCP adapter — wraps MCP servers as FeedSource
|
||||
- Runtime schema validation of action params
|
||||
- Action permissions / confirmation UI
|
||||
- Source discovery / registry API
|
||||
- Backend service consolidation (separate spec, depends on this one)
|
||||
@@ -6,5 +6,8 @@
|
||||
"types": "src/index.ts",
|
||||
"scripts": {
|
||||
"test": "bun test ."
|
||||
},
|
||||
"dependencies": {
|
||||
"@standard-schema/spec": "^1.1.0"
|
||||
}
|
||||
}
|
||||
|
||||
27
packages/aris-core/src/action.ts
Normal file
@@ -0,0 +1,27 @@
|
||||
import type { StandardSchemaV1 } from "@standard-schema/spec"
|
||||
|
||||
/**
|
||||
* Describes an action a source can perform.
|
||||
*
|
||||
* Action IDs use descriptive verb-noun kebab-case (e.g., "update-location", "play-track").
|
||||
* Combined with the source's reverse-domain ID, they form a globally unique identifier:
|
||||
* `<sourceId>/<actionId>` (e.g., "aris.location/update-location").
|
||||
*/
|
||||
export class UnknownActionError extends Error {
|
||||
readonly actionId: string
|
||||
|
||||
constructor(actionId: string) {
|
||||
super(`Unknown action: ${actionId}`)
|
||||
this.name = "UnknownActionError"
|
||||
this.actionId = actionId
|
||||
}
|
||||
}
|
||||
|
||||
export interface ActionDefinition<TInput = unknown> {
|
||||
/** Descriptive action name in kebab-case (e.g., "update-location", "play-track") */
|
||||
readonly id: string
|
||||
/** Optional longer description */
|
||||
readonly description?: string
|
||||
/** Schema for input validation. Accepts any Standard Schema compatible validator (arktype, zod, valibot, etc.). */
|
||||
readonly input?: StandardSchemaV1<TInput>
|
||||
}
|
||||
@@ -1,9 +1,19 @@
|
||||
import { describe, expect, test } from "bun:test"
|
||||
|
||||
import type { Context, ContextKey, FeedItem, FeedSource } from "./index"
|
||||
import type { ActionDefinition, Context, ContextKey, FeedItem, FeedSource } from "./index"
|
||||
|
||||
import { FeedEngine } from "./feed-engine"
|
||||
import { contextKey, contextValue } from "./index"
|
||||
import { UnknownActionError, contextKey, contextValue } from "./index"
|
||||
|
||||
// No-op action methods for test sources
|
||||
const noActions = {
|
||||
async listActions(): Promise<Record<string, ActionDefinition>> {
|
||||
return {}
|
||||
},
|
||||
async executeAction(actionId: string): Promise<void> {
|
||||
throw new UnknownActionError(actionId)
|
||||
},
|
||||
}
|
||||
|
||||
// =============================================================================
|
||||
// CONTEXT KEYS
|
||||
@@ -43,6 +53,7 @@ function createLocationSource(): SimulatedLocationSource {
|
||||
|
||||
return {
|
||||
id: "location",
|
||||
...noActions,
|
||||
|
||||
onContextUpdate(cb) {
|
||||
callback = cb
|
||||
@@ -71,10 +82,11 @@ function createWeatherSource(
|
||||
return {
|
||||
id: "weather",
|
||||
dependencies: ["location"],
|
||||
...noActions,
|
||||
|
||||
async fetchContext(context) {
|
||||
const location = contextValue(context, LocationKey)
|
||||
if (!location) return {}
|
||||
if (!location) return null
|
||||
|
||||
const weather = await fetchWeather(location)
|
||||
return { [WeatherKey]: weather }
|
||||
@@ -104,6 +116,11 @@ function createAlertSource(): FeedSource<AlertFeedItem> {
|
||||
return {
|
||||
id: "alert",
|
||||
dependencies: ["weather"],
|
||||
...noActions,
|
||||
|
||||
async fetchContext() {
|
||||
return null
|
||||
},
|
||||
|
||||
async fetchItems(context) {
|
||||
const weather = contextValue(context, WeatherKey)
|
||||
@@ -164,39 +181,78 @@ describe("FeedEngine", () => {
|
||||
})
|
||||
|
||||
describe("graph validation", () => {
|
||||
test("throws on missing dependency", () => {
|
||||
test("throws on missing dependency", async () => {
|
||||
const engine = new FeedEngine()
|
||||
const orphan: FeedSource = {
|
||||
id: "orphan",
|
||||
dependencies: ["nonexistent"],
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
return null
|
||||
},
|
||||
}
|
||||
|
||||
engine.register(orphan)
|
||||
|
||||
expect(engine.refresh()).rejects.toThrow(
|
||||
await expect(engine.refresh()).rejects.toThrow(
|
||||
'Source "orphan" depends on "nonexistent" which is not registered',
|
||||
)
|
||||
})
|
||||
|
||||
test("throws on circular dependency", () => {
|
||||
test("throws on circular dependency", async () => {
|
||||
const engine = new FeedEngine()
|
||||
const a: FeedSource = { id: "a", dependencies: ["b"] }
|
||||
const b: FeedSource = { id: "b", dependencies: ["a"] }
|
||||
const a: FeedSource = {
|
||||
id: "a",
|
||||
dependencies: ["b"],
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
return null
|
||||
},
|
||||
}
|
||||
const b: FeedSource = {
|
||||
id: "b",
|
||||
dependencies: ["a"],
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
return null
|
||||
},
|
||||
}
|
||||
|
||||
engine.register(a).register(b)
|
||||
|
||||
expect(engine.refresh()).rejects.toThrow("Circular dependency detected: a → b → a")
|
||||
await expect(engine.refresh()).rejects.toThrow("Circular dependency detected: a → b → a")
|
||||
})
|
||||
|
||||
test("throws on longer cycles", () => {
|
||||
test("throws on longer cycles", async () => {
|
||||
const engine = new FeedEngine()
|
||||
const a: FeedSource = { id: "a", dependencies: ["c"] }
|
||||
const b: FeedSource = { id: "b", dependencies: ["a"] }
|
||||
const c: FeedSource = { id: "c", dependencies: ["b"] }
|
||||
const a: FeedSource = {
|
||||
id: "a",
|
||||
dependencies: ["c"],
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
return null
|
||||
},
|
||||
}
|
||||
const b: FeedSource = {
|
||||
id: "b",
|
||||
dependencies: ["a"],
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
return null
|
||||
},
|
||||
}
|
||||
const c: FeedSource = {
|
||||
id: "c",
|
||||
dependencies: ["b"],
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
return null
|
||||
},
|
||||
}
|
||||
|
||||
engine.register(a).register(b).register(c)
|
||||
|
||||
expect(engine.refresh()).rejects.toThrow("Circular dependency detected")
|
||||
await expect(engine.refresh()).rejects.toThrow("Circular dependency detected")
|
||||
})
|
||||
})
|
||||
|
||||
@@ -206,6 +262,7 @@ describe("FeedEngine", () => {
|
||||
|
||||
const location: FeedSource = {
|
||||
id: "location",
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
order.push("location")
|
||||
return { [LocationKey]: { lat: 51.5, lng: -0.1 } }
|
||||
@@ -215,6 +272,7 @@ describe("FeedEngine", () => {
|
||||
const weather: FeedSource = {
|
||||
id: "weather",
|
||||
dependencies: ["location"],
|
||||
...noActions,
|
||||
async fetchContext(ctx) {
|
||||
order.push("weather")
|
||||
const loc = contextValue(ctx, LocationKey)
|
||||
@@ -240,8 +298,14 @@ describe("FeedEngine", () => {
|
||||
|
||||
const { context } = await engine.refresh()
|
||||
|
||||
expect(contextValue(context, LocationKey)).toEqual({ lat: 51.5, lng: -0.1 })
|
||||
expect(contextValue(context, WeatherKey)).toEqual({ temperature: 20, condition: "sunny" })
|
||||
expect(contextValue(context, LocationKey)).toEqual({
|
||||
lat: 51.5,
|
||||
lng: -0.1,
|
||||
})
|
||||
expect(contextValue(context, WeatherKey)).toEqual({
|
||||
temperature: 20,
|
||||
condition: "sunny",
|
||||
})
|
||||
})
|
||||
|
||||
test("collects items from all sources", async () => {
|
||||
@@ -281,8 +345,9 @@ describe("FeedEngine", () => {
|
||||
test("handles missing upstream context gracefully", async () => {
|
||||
const location: FeedSource = {
|
||||
id: "location",
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
return {} // No location available
|
||||
return null // No location available
|
||||
},
|
||||
}
|
||||
|
||||
@@ -299,6 +364,7 @@ describe("FeedEngine", () => {
|
||||
test("captures errors from fetchContext", async () => {
|
||||
const failing: FeedSource = {
|
||||
id: "failing",
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
throw new Error("Context fetch failed")
|
||||
},
|
||||
@@ -316,6 +382,10 @@ describe("FeedEngine", () => {
|
||||
test("captures errors from fetchItems", async () => {
|
||||
const failing: FeedSource = {
|
||||
id: "failing",
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
return null
|
||||
},
|
||||
async fetchItems() {
|
||||
throw new Error("Items fetch failed")
|
||||
},
|
||||
@@ -333,6 +403,7 @@ describe("FeedEngine", () => {
|
||||
test("continues after source error", async () => {
|
||||
const failing: FeedSource = {
|
||||
id: "failing",
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
throw new Error("Failed")
|
||||
},
|
||||
@@ -340,6 +411,10 @@ describe("FeedEngine", () => {
|
||||
|
||||
const working: FeedSource = {
|
||||
id: "working",
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
return null
|
||||
},
|
||||
async fetchItems() {
|
||||
return [
|
||||
{
|
||||
@@ -380,7 +455,10 @@ describe("FeedEngine", () => {
|
||||
await engine.refresh()
|
||||
|
||||
const context = engine.currentContext()
|
||||
expect(contextValue(context, LocationKey)).toEqual({ lat: 51.5, lng: -0.1 })
|
||||
expect(contextValue(context, LocationKey)).toEqual({
|
||||
lat: 51.5,
|
||||
lng: -0.1,
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
@@ -455,4 +533,109 @@ describe("FeedEngine", () => {
|
||||
engine.stop()
|
||||
})
|
||||
})
|
||||
|
||||
describe("executeAction", () => {
|
||||
test("routes action to correct source", async () => {
|
||||
let receivedAction = ""
|
||||
let receivedParams: unknown = {}
|
||||
|
||||
const source: FeedSource = {
|
||||
id: "test-source",
|
||||
async listActions() {
|
||||
return {
|
||||
"do-thing": { id: "do-thing" },
|
||||
}
|
||||
},
|
||||
async executeAction(actionId, params) {
|
||||
receivedAction = actionId
|
||||
receivedParams = params
|
||||
},
|
||||
async fetchContext() {
|
||||
return null
|
||||
},
|
||||
}
|
||||
|
||||
const engine = new FeedEngine().register(source)
|
||||
await engine.executeAction("test-source", "do-thing", { key: "value" })
|
||||
|
||||
expect(receivedAction).toBe("do-thing")
|
||||
expect(receivedParams).toEqual({ key: "value" })
|
||||
})
|
||||
|
||||
test("throws for unknown source", async () => {
|
||||
const engine = new FeedEngine()
|
||||
|
||||
await expect(engine.executeAction("nonexistent", "action", {})).rejects.toThrow(
|
||||
"Source not found: nonexistent",
|
||||
)
|
||||
})
|
||||
|
||||
test("throws for unknown action on source", async () => {
|
||||
const source: FeedSource = {
|
||||
id: "test-source",
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
return null
|
||||
},
|
||||
}
|
||||
|
||||
const engine = new FeedEngine().register(source)
|
||||
|
||||
await expect(engine.executeAction("test-source", "nonexistent", {})).rejects.toThrow(
|
||||
'Action "nonexistent" not found on source "test-source"',
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
describe("listActions", () => {
|
||||
test("returns actions for a specific source", async () => {
|
||||
const source: FeedSource = {
|
||||
id: "test-source",
|
||||
async listActions() {
|
||||
return {
|
||||
"action-1": { id: "action-1" },
|
||||
"action-2": { id: "action-2" },
|
||||
}
|
||||
},
|
||||
async executeAction() {},
|
||||
async fetchContext() {
|
||||
return null
|
||||
},
|
||||
}
|
||||
|
||||
const engine = new FeedEngine().register(source)
|
||||
const actions = await engine.listActions("test-source")
|
||||
|
||||
expect(Object.keys(actions)).toEqual(["action-1", "action-2"])
|
||||
})
|
||||
|
||||
test("throws for unknown source", async () => {
|
||||
const engine = new FeedEngine()
|
||||
|
||||
await expect(engine.listActions("nonexistent")).rejects.toThrow(
|
||||
"Source not found: nonexistent",
|
||||
)
|
||||
})
|
||||
|
||||
test("throws on mismatched action ID", async () => {
|
||||
const source: FeedSource = {
|
||||
id: "bad-source",
|
||||
async listActions() {
|
||||
return {
|
||||
"correct-key": { id: "wrong-id" },
|
||||
}
|
||||
},
|
||||
async executeAction() {},
|
||||
async fetchContext() {
|
||||
return null
|
||||
},
|
||||
}
|
||||
|
||||
const engine = new FeedEngine().register(source)
|
||||
|
||||
await expect(engine.listActions("bad-source")).rejects.toThrow(
|
||||
'Action ID mismatch on source "bad-source"',
|
||||
)
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import type { ActionDefinition } from "./action"
|
||||
import type { Context } from "./context"
|
||||
import type { FeedItem } from "./feed"
|
||||
import type { FeedSource } from "./feed-source"
|
||||
@@ -89,16 +90,16 @@ export class FeedEngine<TItems extends FeedItem = FeedItem> {
|
||||
|
||||
// Run fetchContext in topological order
|
||||
for (const source of graph.sorted) {
|
||||
if (source.fetchContext) {
|
||||
try {
|
||||
const update = await source.fetchContext(context)
|
||||
try {
|
||||
const update = await source.fetchContext(context)
|
||||
if (update) {
|
||||
context = { ...context, ...update }
|
||||
} catch (err) {
|
||||
errors.push({
|
||||
sourceId: source.id,
|
||||
error: err instanceof Error ? err : new Error(String(err)),
|
||||
})
|
||||
}
|
||||
} catch (err) {
|
||||
errors.push({
|
||||
sourceId: source.id,
|
||||
error: err instanceof Error ? err : new Error(String(err)),
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
@@ -187,6 +188,44 @@ export class FeedEngine<TItems extends FeedItem = FeedItem> {
|
||||
return this.context
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute an action on a registered source.
|
||||
* Validates the action exists before dispatching.
|
||||
*
|
||||
* In pull-only mode (before `start()` is called), the action mutates source
|
||||
* state but does not automatically refresh dependents. Call `refresh()`
|
||||
* after to propagate changes. In reactive mode (`start()` called), sources
|
||||
* that push context updates (e.g., LocationSource) will trigger dependent
|
||||
* refresh automatically.
|
||||
*/
|
||||
async executeAction(sourceId: string, actionId: string, params: unknown): Promise<unknown> {
|
||||
const actions = await this.listActions(sourceId)
|
||||
if (!(actionId in actions)) {
|
||||
throw new Error(`Action "${actionId}" not found on source "${sourceId}"`)
|
||||
}
|
||||
return this.sources.get(sourceId)!.executeAction(actionId, params)
|
||||
}
|
||||
|
||||
/**
|
||||
* List actions available on a specific source.
|
||||
* Validates that action definition IDs match their record keys.
|
||||
*/
|
||||
async listActions(sourceId: string): Promise<Record<string, ActionDefinition>> {
|
||||
const source = this.sources.get(sourceId)
|
||||
if (!source) {
|
||||
throw new Error(`Source not found: ${sourceId}`)
|
||||
}
|
||||
const actions = await source.listActions()
|
||||
for (const [key, definition] of Object.entries(actions)) {
|
||||
if (key !== definition.id) {
|
||||
throw new Error(
|
||||
`Action ID mismatch on source "${sourceId}": key "${key}" !== definition.id "${definition.id}"`,
|
||||
)
|
||||
}
|
||||
}
|
||||
return actions
|
||||
}
|
||||
|
||||
private ensureGraph(): SourceGraph {
|
||||
if (!this.graph) {
|
||||
this.graph = buildGraph(Array.from(this.sources.values()))
|
||||
@@ -208,10 +247,12 @@ export class FeedEngine<TItems extends FeedItem = FeedItem> {
|
||||
// Re-run fetchContext for dependents in order
|
||||
for (const id of toRefresh) {
|
||||
const source = graph.sources.get(id)
|
||||
if (source?.fetchContext) {
|
||||
if (source) {
|
||||
try {
|
||||
const update = await source.fetchContext(this.context)
|
||||
this.context = { ...this.context, ...update }
|
||||
if (update) {
|
||||
this.context = { ...this.context, ...update }
|
||||
}
|
||||
} catch {
|
||||
// Errors during reactive updates are logged but don't stop propagation
|
||||
}
|
||||
@@ -238,7 +279,11 @@ export class FeedEngine<TItems extends FeedItem = FeedItem> {
|
||||
|
||||
items.sort((a, b) => b.priority - a.priority)
|
||||
|
||||
this.notifySubscribers({ context: this.context, items: items as TItems[], errors })
|
||||
this.notifySubscribers({
|
||||
context: this.context,
|
||||
items: items as TItems[],
|
||||
errors,
|
||||
})
|
||||
}
|
||||
|
||||
private collectDependents(sourceId: string, graph: SourceGraph): string[] {
|
||||
|
||||
@@ -1,8 +1,18 @@
|
||||
import { describe, expect, test } from "bun:test"
|
||||
|
||||
import type { Context, ContextKey, FeedItem, FeedSource } from "./index"
|
||||
import type { ActionDefinition, Context, ContextKey, FeedItem, FeedSource } from "./index"
|
||||
|
||||
import { contextKey, contextValue } from "./index"
|
||||
import { UnknownActionError, contextKey, contextValue } from "./index"
|
||||
|
||||
// No-op action methods for test sources
|
||||
const noActions = {
|
||||
async listActions(): Promise<Record<string, ActionDefinition>> {
|
||||
return {}
|
||||
},
|
||||
async executeAction(actionId: string): Promise<void> {
|
||||
throw new UnknownActionError(actionId)
|
||||
},
|
||||
}
|
||||
|
||||
// =============================================================================
|
||||
// CONTEXT KEYS
|
||||
@@ -42,6 +52,7 @@ function createLocationSource(): SimulatedLocationSource {
|
||||
|
||||
return {
|
||||
id: "location",
|
||||
...noActions,
|
||||
|
||||
onContextUpdate(cb) {
|
||||
callback = cb
|
||||
@@ -70,10 +81,11 @@ function createWeatherSource(
|
||||
return {
|
||||
id: "weather",
|
||||
dependencies: ["location"],
|
||||
...noActions,
|
||||
|
||||
async fetchContext(context) {
|
||||
const location = contextValue(context, LocationKey)
|
||||
if (!location) return {}
|
||||
if (!location) return null
|
||||
|
||||
const weather = await fetchWeather(location)
|
||||
return { [WeatherKey]: weather }
|
||||
@@ -103,6 +115,11 @@ function createAlertSource(): FeedSource<AlertFeedItem> {
|
||||
return {
|
||||
id: "alert",
|
||||
dependencies: ["weather"],
|
||||
...noActions,
|
||||
|
||||
async fetchContext() {
|
||||
return null
|
||||
},
|
||||
|
||||
async fetchItems(context) {
|
||||
const weather = contextValue(context, WeatherKey)
|
||||
@@ -194,8 +211,8 @@ async function refreshGraph(graph: SourceGraph): Promise<{ context: Context; ite
|
||||
|
||||
// Run fetchContext in topological order
|
||||
for (const source of graph.sorted) {
|
||||
if (source.fetchContext) {
|
||||
const update = await source.fetchContext(context)
|
||||
const update = await source.fetchContext(context)
|
||||
if (update) {
|
||||
context = { ...context, ...update }
|
||||
}
|
||||
}
|
||||
@@ -245,9 +262,15 @@ describe("FeedSource", () => {
|
||||
|
||||
expect(source.id).toBe("alert")
|
||||
expect(source.dependencies).toEqual(["weather"])
|
||||
expect(source.fetchContext).toBeUndefined()
|
||||
expect(source.fetchContext).toBeDefined()
|
||||
expect(source.fetchItems).toBeDefined()
|
||||
})
|
||||
|
||||
test("source without context returns null from fetchContext", async () => {
|
||||
const source = createAlertSource()
|
||||
const result = await source.fetchContext({ time: new Date() })
|
||||
expect(result).toBeNull()
|
||||
})
|
||||
})
|
||||
|
||||
describe("graph validation", () => {
|
||||
@@ -255,6 +278,10 @@ describe("FeedSource", () => {
|
||||
const orphan: FeedSource = {
|
||||
id: "orphan",
|
||||
dependencies: ["nonexistent"],
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
return null
|
||||
},
|
||||
}
|
||||
|
||||
expect(() => buildGraph([orphan])).toThrow(
|
||||
@@ -263,16 +290,51 @@ describe("FeedSource", () => {
|
||||
})
|
||||
|
||||
test("detects circular dependencies", () => {
|
||||
const a: FeedSource = { id: "a", dependencies: ["b"] }
|
||||
const b: FeedSource = { id: "b", dependencies: ["a"] }
|
||||
const a: FeedSource = {
|
||||
id: "a",
|
||||
dependencies: ["b"],
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
return null
|
||||
},
|
||||
}
|
||||
const b: FeedSource = {
|
||||
id: "b",
|
||||
dependencies: ["a"],
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
return null
|
||||
},
|
||||
}
|
||||
|
||||
expect(() => buildGraph([a, b])).toThrow("Circular dependency detected: a → b → a")
|
||||
})
|
||||
|
||||
test("detects longer cycles", () => {
|
||||
const a: FeedSource = { id: "a", dependencies: ["c"] }
|
||||
const b: FeedSource = { id: "b", dependencies: ["a"] }
|
||||
const c: FeedSource = { id: "c", dependencies: ["b"] }
|
||||
const a: FeedSource = {
|
||||
id: "a",
|
||||
dependencies: ["c"],
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
return null
|
||||
},
|
||||
}
|
||||
const b: FeedSource = {
|
||||
id: "b",
|
||||
dependencies: ["a"],
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
return null
|
||||
},
|
||||
}
|
||||
const c: FeedSource = {
|
||||
id: "c",
|
||||
dependencies: ["b"],
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
return null
|
||||
},
|
||||
}
|
||||
|
||||
expect(() => buildGraph([a, b, c])).toThrow("Circular dependency detected")
|
||||
})
|
||||
@@ -307,6 +369,7 @@ describe("FeedSource", () => {
|
||||
|
||||
const location: FeedSource = {
|
||||
id: "location",
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
order.push("location")
|
||||
return { [LocationKey]: { lat: 51.5, lng: -0.1 } }
|
||||
@@ -316,6 +379,7 @@ describe("FeedSource", () => {
|
||||
const weather: FeedSource = {
|
||||
id: "weather",
|
||||
dependencies: ["location"],
|
||||
...noActions,
|
||||
async fetchContext(ctx) {
|
||||
order.push("weather")
|
||||
const loc = contextValue(ctx, LocationKey)
|
||||
@@ -339,8 +403,14 @@ describe("FeedSource", () => {
|
||||
const graph = buildGraph([location, weather])
|
||||
const { context } = await refreshGraph(graph)
|
||||
|
||||
expect(contextValue(context, LocationKey)).toEqual({ lat: 51.5, lng: -0.1 })
|
||||
expect(contextValue(context, WeatherKey)).toEqual({ temperature: 20, condition: "sunny" })
|
||||
expect(contextValue(context, LocationKey)).toEqual({
|
||||
lat: 51.5,
|
||||
lng: -0.1,
|
||||
})
|
||||
expect(contextValue(context, WeatherKey)).toEqual({
|
||||
temperature: 20,
|
||||
condition: "sunny",
|
||||
})
|
||||
})
|
||||
|
||||
test("collects items from all sources", async () => {
|
||||
@@ -376,12 +446,13 @@ describe("FeedSource", () => {
|
||||
})
|
||||
|
||||
test("source without location context returns empty items", async () => {
|
||||
// Location source exists but hasn't been updated (returns default 0,0)
|
||||
// Location source exists but hasn't been updated
|
||||
const location: FeedSource = {
|
||||
id: "location",
|
||||
...noActions,
|
||||
async fetchContext() {
|
||||
// Simulate no location available
|
||||
return {}
|
||||
return null
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
@@ -1,54 +1,60 @@
|
||||
import type { ActionDefinition } from "./action"
|
||||
import type { Context } from "./context"
|
||||
import type { FeedItem } from "./feed"
|
||||
|
||||
/**
|
||||
* Unified interface for sources that provide context and/or feed items.
|
||||
* Unified interface for sources that provide context, feed items, and actions.
|
||||
*
|
||||
* Sources form a dependency graph - a source declares which other sources
|
||||
* Sources form a dependency graph — a source declares which other sources
|
||||
* it depends on, and the graph ensures dependencies are resolved before
|
||||
* dependents run.
|
||||
*
|
||||
* A source may:
|
||||
* - Provide context for other sources (implement fetchContext/onContextUpdate)
|
||||
* - Produce feed items (implement fetchItems/onItemsUpdate)
|
||||
* - Both
|
||||
* Source IDs use reverse domain notation. Built-in sources use `aris.<name>`,
|
||||
* third parties use their own domain (e.g., `com.spotify`).
|
||||
*
|
||||
* Every method maps to a protocol operation for remote source support:
|
||||
* - `id`, `dependencies` → source/describe
|
||||
* - `listActions()` → source/listActions
|
||||
* - `executeAction()` → source/executeAction
|
||||
* - `fetchContext()` → source/fetchContext
|
||||
* - `fetchItems()` → source/fetchItems
|
||||
* - `onContextUpdate()` → source/contextUpdated (notification)
|
||||
* - `onItemsUpdate()` → source/itemsUpdated (notification)
|
||||
*
|
||||
* @example
|
||||
* ```ts
|
||||
* // Location source - provides context only
|
||||
* const locationSource: FeedSource = {
|
||||
* id: "location",
|
||||
* fetchContext: async () => {
|
||||
* const pos = await getCurrentPosition()
|
||||
* return { location: { lat: pos.coords.latitude, lng: pos.coords.longitude } }
|
||||
* },
|
||||
* }
|
||||
*
|
||||
* // Weather source - depends on location, provides both context and items
|
||||
* const weatherSource: FeedSource<WeatherFeedItem> = {
|
||||
* id: "weather",
|
||||
* dependencies: ["location"],
|
||||
* fetchContext: async (ctx) => {
|
||||
* const weather = await fetchWeather(ctx.location)
|
||||
* return { weather }
|
||||
* },
|
||||
* fetchItems: async (ctx) => {
|
||||
* return createWeatherFeedItems(ctx.weather)
|
||||
* },
|
||||
* id: "aris.location",
|
||||
* async listActions() { return { "update-location": { id: "update-location" } } },
|
||||
* async executeAction(actionId) { throw new UnknownActionError(actionId) },
|
||||
* async fetchContext() { ... },
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
export interface FeedSource<TItem extends FeedItem = FeedItem> {
|
||||
/** Unique identifier for this source */
|
||||
/** Unique identifier for this source in reverse-domain format */
|
||||
readonly id: string
|
||||
|
||||
/** IDs of sources this source depends on */
|
||||
readonly dependencies?: readonly string[]
|
||||
|
||||
/**
|
||||
* List actions this source supports. Empty record if none.
|
||||
* Maps to: source/listActions
|
||||
*/
|
||||
listActions(): Promise<Record<string, ActionDefinition>>
|
||||
|
||||
/**
|
||||
* Execute an action by ID. Throws on unknown action or invalid input.
|
||||
* Maps to: source/executeAction
|
||||
*/
|
||||
executeAction(actionId: string, params: unknown): Promise<unknown>
|
||||
|
||||
/**
|
||||
* Subscribe to reactive context updates.
|
||||
* Called when the source can push context changes proactively.
|
||||
* Returns cleanup function.
|
||||
* Maps to: source/contextUpdated (notification, source → host)
|
||||
*/
|
||||
onContextUpdate?(
|
||||
callback: (update: Partial<Context>) => void,
|
||||
@@ -58,19 +64,23 @@ export interface FeedSource<TItem extends FeedItem = FeedItem> {
|
||||
/**
|
||||
* Fetch context on-demand.
|
||||
* Called during manual refresh or initial load.
|
||||
* Return null if this source cannot provide context.
|
||||
* Maps to: source/fetchContext
|
||||
*/
|
||||
fetchContext?(context: Context): Promise<Partial<Context>>
|
||||
fetchContext(context: Context): Promise<Partial<Context> | null>
|
||||
|
||||
/**
|
||||
* Subscribe to reactive feed item updates.
|
||||
* Called when the source can push item changes proactively.
|
||||
* Returns cleanup function.
|
||||
* Maps to: source/itemsUpdated (notification, source → host)
|
||||
*/
|
||||
onItemsUpdate?(callback: (items: TItem[]) => void, getContext: () => Context): () => void
|
||||
|
||||
/**
|
||||
* Fetch feed items on-demand.
|
||||
* Called during manual refresh or when dependencies update.
|
||||
* Maps to: source/fetchItems
|
||||
*/
|
||||
fetchItems?(context: Context): Promise<TItem[]>
|
||||
}
|
||||
|
||||
@@ -2,6 +2,10 @@
|
||||
export type { Context, ContextKey } from "./context"
|
||||
export { contextKey, contextValue } from "./context"
|
||||
|
||||
// Actions
|
||||
export type { ActionDefinition } from "./action"
|
||||
export { UnknownActionError } from "./action"
|
||||
|
||||
// Feed
|
||||
export type { FeedItem } from "./feed"
|
||||
|
||||
|
||||
@@ -26,14 +26,18 @@ const createMockContext = (location?: { lat: number; lng: number }): Context =>
|
||||
|
||||
describe("WeatherKitDataSource", () => {
|
||||
test("returns empty array when location is missing", async () => {
|
||||
const dataSource = new WeatherKitDataSource({ credentials: mockCredentials })
|
||||
const dataSource = new WeatherKitDataSource({
|
||||
credentials: mockCredentials,
|
||||
})
|
||||
const items = await dataSource.query(createMockContext())
|
||||
|
||||
expect(items).toEqual([])
|
||||
})
|
||||
|
||||
test("type is weather-current", () => {
|
||||
const dataSource = new WeatherKitDataSource({ credentials: mockCredentials })
|
||||
const dataSource = new WeatherKitDataSource({
|
||||
credentials: mockCredentials,
|
||||
})
|
||||
|
||||
expect(dataSource.type).toBe(WeatherFeedItemType.current)
|
||||
})
|
||||
@@ -100,7 +104,9 @@ describe("WeatherKitDataSource with fixture", () => {
|
||||
})
|
||||
|
||||
test("default limits are applied", () => {
|
||||
const dataSource = new WeatherKitDataSource({ credentials: mockCredentials })
|
||||
const dataSource = new WeatherKitDataSource({
|
||||
credentials: mockCredentials,
|
||||
})
|
||||
|
||||
expect(dataSource["hourlyLimit"]).toBe(12)
|
||||
expect(dataSource["dailyLimit"]).toBe(7)
|
||||
@@ -163,8 +169,12 @@ describe("query() with mocked client", () => {
|
||||
const dataSource = new WeatherKitDataSource({ client: mockClient })
|
||||
const context = createMockContext({ lat: 37.7749, lng: -122.4194 })
|
||||
|
||||
const metricItems = await dataSource.query(context, { units: Units.metric })
|
||||
const imperialItems = await dataSource.query(context, { units: Units.imperial })
|
||||
const metricItems = await dataSource.query(context, {
|
||||
units: Units.metric,
|
||||
})
|
||||
const imperialItems = await dataSource.query(context, {
|
||||
units: Units.imperial,
|
||||
})
|
||||
|
||||
const metricCurrent = metricItems.find((i) => i.type === WeatherFeedItemType.current)
|
||||
const imperialCurrent = imperialItems.find((i) => i.type === WeatherFeedItemType.current)
|
||||
|
||||
@@ -78,7 +78,7 @@ class MockDAVClient implements CalendarDAVClient {
|
||||
describe("CalendarSource", () => {
|
||||
test("has correct id", () => {
|
||||
const source = new CalendarSource(new NullCredentialProvider(), "user-1")
|
||||
expect(source.id).toBe("apple-calendar")
|
||||
expect(source.id).toBe("aris.apple-calendar")
|
||||
})
|
||||
|
||||
test("returns empty array when credentials are null", async () => {
|
||||
@@ -121,7 +121,10 @@ describe("CalendarSource", () => {
|
||||
const objects: Record<string, CalendarDAVObject[]> = {
|
||||
"/cal/work": [{ url: "/cal/work/event1.ics", data: loadFixture("single-event.ics") }],
|
||||
"/cal/personal": [
|
||||
{ url: "/cal/personal/event2.ics", data: loadFixture("all-day-event.ics") },
|
||||
{
|
||||
url: "/cal/personal/event2.ics",
|
||||
data: loadFixture("all-day-event.ics"),
|
||||
},
|
||||
],
|
||||
}
|
||||
const client = new MockDAVClient(
|
||||
@@ -206,7 +209,12 @@ describe("CalendarSource", () => {
|
||||
|
||||
test("handles calendar with non-string displayName", async () => {
|
||||
const objects: Record<string, CalendarDAVObject[]> = {
|
||||
"/cal/weird": [{ url: "/cal/weird/event1.ics", data: loadFixture("minimal-event.ics") }],
|
||||
"/cal/weird": [
|
||||
{
|
||||
url: "/cal/weird/event1.ics",
|
||||
data: loadFixture("minimal-event.ics"),
|
||||
},
|
||||
],
|
||||
}
|
||||
const client = new MockDAVClient(
|
||||
[{ url: "/cal/weird", displayName: { _cdata: "Weird Calendar" } }],
|
||||
@@ -222,7 +230,12 @@ describe("CalendarSource", () => {
|
||||
|
||||
test("handles recurring events with exceptions", async () => {
|
||||
const objects: Record<string, CalendarDAVObject[]> = {
|
||||
"/cal/work": [{ url: "/cal/work/recurring.ics", data: loadFixture("recurring-event.ics") }],
|
||||
"/cal/work": [
|
||||
{
|
||||
url: "/cal/work/recurring.ics",
|
||||
data: loadFixture("recurring-event.ics"),
|
||||
},
|
||||
],
|
||||
}
|
||||
const client = new MockDAVClient([{ url: "/cal/work", displayName: "Work" }], objects)
|
||||
const source = new CalendarSource(new MockCredentialProvider(), "user-1", {
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
import type { Context, FeedSource } from "@aris/core"
|
||||
import type { ActionDefinition, Context, FeedSource } from "@aris/core"
|
||||
import { UnknownActionError } from "@aris/core"
|
||||
|
||||
import { DAVClient } from "tsdav"
|
||||
|
||||
@@ -37,7 +38,7 @@ const DEFAULT_LOOK_AHEAD_DAYS = 0
|
||||
* ```
|
||||
*/
|
||||
export class CalendarSource implements FeedSource<CalendarFeedItem> {
|
||||
readonly id = "apple-calendar"
|
||||
readonly id = "aris.apple-calendar"
|
||||
|
||||
private readonly credentialProvider: CalendarCredentialProvider
|
||||
private readonly userId: string
|
||||
@@ -58,7 +59,15 @@ export class CalendarSource implements FeedSource<CalendarFeedItem> {
|
||||
this.injectedClient = options?.davClient ?? null
|
||||
}
|
||||
|
||||
async fetchContext(context: Context): Promise<Partial<Context>> {
|
||||
async listActions(): Promise<Record<string, ActionDefinition>> {
|
||||
return {}
|
||||
}
|
||||
|
||||
async executeAction(actionId: string): Promise<void> {
|
||||
throw new UnknownActionError(actionId)
|
||||
}
|
||||
|
||||
async fetchContext(context: Context): Promise<Partial<Context> | null> {
|
||||
const events = await this.fetchEvents(context)
|
||||
if (events.length === 0) {
|
||||
return {
|
||||
|
||||
72
packages/aris-source-google-calendar/fixtures/events.json
Normal file
@@ -0,0 +1,72 @@
|
||||
{
|
||||
"kind": "calendar#events",
|
||||
"summary": "primary",
|
||||
"items": [
|
||||
{
|
||||
"id": "evt-ongoing",
|
||||
"status": "confirmed",
|
||||
"htmlLink": "https://calendar.google.com/event?eid=evt-ongoing",
|
||||
"summary": "Team Standup",
|
||||
"description": "Daily standup meeting",
|
||||
"location": "Room 3A",
|
||||
"start": {
|
||||
"dateTime": "2026-01-20T09:30:00Z"
|
||||
},
|
||||
"end": {
|
||||
"dateTime": "2026-01-20T10:15:00Z"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "evt-soon",
|
||||
"status": "confirmed",
|
||||
"htmlLink": "https://calendar.google.com/event?eid=evt-soon",
|
||||
"summary": "1:1 with Manager",
|
||||
"start": {
|
||||
"dateTime": "2026-01-20T10:10:00Z"
|
||||
},
|
||||
"end": {
|
||||
"dateTime": "2026-01-20T10:40:00Z"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "evt-later",
|
||||
"status": "confirmed",
|
||||
"htmlLink": "https://calendar.google.com/event?eid=evt-later",
|
||||
"summary": "Design Review",
|
||||
"description": "Review new dashboard designs",
|
||||
"location": "Conference Room B",
|
||||
"start": {
|
||||
"dateTime": "2026-01-20T14:00:00Z"
|
||||
},
|
||||
"end": {
|
||||
"dateTime": "2026-01-20T15:00:00Z"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "evt-tentative",
|
||||
"status": "tentative",
|
||||
"htmlLink": "https://calendar.google.com/event?eid=evt-tentative",
|
||||
"summary": "Lunch with Alex",
|
||||
"location": "Cafe Nero",
|
||||
"start": {
|
||||
"dateTime": "2026-01-20T12:00:00Z"
|
||||
},
|
||||
"end": {
|
||||
"dateTime": "2026-01-20T13:00:00Z"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "evt-allday",
|
||||
"status": "confirmed",
|
||||
"htmlLink": "https://calendar.google.com/event?eid=evt-allday",
|
||||
"summary": "Company Holiday",
|
||||
"description": "Office closed",
|
||||
"start": {
|
||||
"date": "2026-01-20"
|
||||
},
|
||||
"end": {
|
||||
"date": "2026-01-21"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
14
packages/aris-source-google-calendar/package.json
Normal file
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"name": "@aris/source-google-calendar",
|
||||
"version": "0.0.0",
|
||||
"type": "module",
|
||||
"main": "src/index.ts",
|
||||
"types": "src/index.ts",
|
||||
"scripts": {
|
||||
"test": "bun test ."
|
||||
},
|
||||
"dependencies": {
|
||||
"@aris/core": "workspace:*",
|
||||
"arktype": "^2.1.0"
|
||||
}
|
||||
}
|
||||
13
packages/aris-source-google-calendar/src/calendar-context.ts
Normal file
@@ -0,0 +1,13 @@
|
||||
import type { ContextKey } from "@aris/core"
|
||||
|
||||
import { contextKey } from "@aris/core"
|
||||
|
||||
export interface NextEvent {
|
||||
title: string
|
||||
startTime: Date
|
||||
endTime: Date
|
||||
minutesUntilStart: number
|
||||
location: string | null
|
||||
}
|
||||
|
||||
export const NextEventKey: ContextKey<NextEvent> = contextKey("nextEvent")
|
||||
22
packages/aris-source-google-calendar/src/feed-items.ts
Normal file
@@ -0,0 +1,22 @@
|
||||
import type { FeedItem } from "@aris/core"
|
||||
|
||||
import type { CalendarEventData } from "./types"
|
||||
|
||||
export const CalendarFeedItemType = {
|
||||
event: "calendar-event",
|
||||
allDay: "calendar-all-day",
|
||||
} as const
|
||||
|
||||
export type CalendarFeedItemType = (typeof CalendarFeedItemType)[keyof typeof CalendarFeedItemType]
|
||||
|
||||
export interface CalendarEventFeedItem extends FeedItem<
|
||||
typeof CalendarFeedItemType.event,
|
||||
CalendarEventData
|
||||
> {}
|
||||
|
||||
export interface CalendarAllDayFeedItem extends FeedItem<
|
||||
typeof CalendarFeedItemType.allDay,
|
||||
CalendarEventData
|
||||
> {}
|
||||
|
||||
export type CalendarFeedItem = CalendarEventFeedItem | CalendarAllDayFeedItem
|
||||
122
packages/aris-source-google-calendar/src/google-calendar-api.ts
Normal file
@@ -0,0 +1,122 @@
|
||||
// Google Calendar REST API v3 client
|
||||
// https://developers.google.com/calendar/api/v3/reference/events/list
|
||||
|
||||
import { type } from "arktype"
|
||||
|
||||
import type {
|
||||
ApiCalendarEvent,
|
||||
GoogleCalendarClient,
|
||||
GoogleOAuthProvider,
|
||||
ListEventsOptions,
|
||||
} from "./types"
|
||||
|
||||
import { EventStatus } from "./types"
|
||||
|
||||
const eventStatusSchema = type.enumerated(
|
||||
EventStatus.Confirmed,
|
||||
EventStatus.Tentative,
|
||||
EventStatus.Cancelled,
|
||||
)
|
||||
|
||||
const eventDateTimeSchema = type({
|
||||
"dateTime?": "string",
|
||||
"date?": "string",
|
||||
"timeZone?": "string",
|
||||
})
|
||||
|
||||
const eventSchema = type({
|
||||
id: "string",
|
||||
status: eventStatusSchema,
|
||||
htmlLink: "string",
|
||||
"summary?": "string",
|
||||
"description?": "string",
|
||||
"location?": "string",
|
||||
start: eventDateTimeSchema,
|
||||
end: eventDateTimeSchema,
|
||||
})
|
||||
|
||||
const calendarListEntrySchema = type({
|
||||
id: "string",
|
||||
})
|
||||
|
||||
const calendarListResponseSchema = type({
|
||||
"items?": calendarListEntrySchema.array(),
|
||||
"nextPageToken?": "string",
|
||||
})
|
||||
|
||||
const eventsResponseSchema = type({
|
||||
"items?": eventSchema.array(),
|
||||
"nextPageToken?": "string",
|
||||
})
|
||||
|
||||
export class DefaultGoogleCalendarClient implements GoogleCalendarClient {
|
||||
private static readonly API_BASE = "https://www.googleapis.com/calendar/v3"
|
||||
|
||||
private readonly oauthProvider: GoogleOAuthProvider
|
||||
|
||||
constructor(oauthProvider: GoogleOAuthProvider) {
|
||||
this.oauthProvider = oauthProvider
|
||||
}
|
||||
|
||||
async listCalendarIds(): Promise<string[]> {
|
||||
const url = `${DefaultGoogleCalendarClient.API_BASE}/users/me/calendarList?fields=items(id)`
|
||||
const json = await this.request(url)
|
||||
const result = calendarListResponseSchema(json)
|
||||
|
||||
if (result instanceof type.errors) {
|
||||
throw new Error(`Google Calendar API response validation failed: ${result.summary}`)
|
||||
}
|
||||
|
||||
if (!result.items) {
|
||||
return []
|
||||
}
|
||||
return result.items.map((entry) => entry.id)
|
||||
}
|
||||
|
||||
async listEvents(options: ListEventsOptions): Promise<ApiCalendarEvent[]> {
|
||||
const url = new URL(
|
||||
`${DefaultGoogleCalendarClient.API_BASE}/calendars/${encodeURIComponent(options.calendarId)}/events`,
|
||||
)
|
||||
url.searchParams.set("timeMin", options.timeMin.toISOString())
|
||||
url.searchParams.set("timeMax", options.timeMax.toISOString())
|
||||
url.searchParams.set("singleEvents", "true")
|
||||
url.searchParams.set("orderBy", "startTime")
|
||||
|
||||
const json = await this.request(url.toString())
|
||||
const result = eventsResponseSchema(json)
|
||||
|
||||
if (result instanceof type.errors) {
|
||||
throw new Error(`Google Calendar API response validation failed: ${result.summary}`)
|
||||
}
|
||||
|
||||
if (!result.items) {
|
||||
return []
|
||||
}
|
||||
|
||||
return result.items
|
||||
}
|
||||
|
||||
/** Authenticated GET with auto token refresh on 401. */
|
||||
private async request(url: string): Promise<unknown> {
|
||||
const token = await this.oauthProvider.fetchAccessToken()
|
||||
let response = await fetch(url, {
|
||||
headers: { Authorization: `Bearer ${token}` },
|
||||
})
|
||||
|
||||
if (response.status === 401) {
|
||||
const newToken = await this.oauthProvider.refresh()
|
||||
response = await fetch(url, {
|
||||
headers: { Authorization: `Bearer ${newToken}` },
|
||||
})
|
||||
}
|
||||
|
||||
if (!response.ok) {
|
||||
const body = await response.text()
|
||||
throw new Error(
|
||||
`Google Calendar API error: ${response.status} ${response.statusText}: ${body}`,
|
||||
)
|
||||
}
|
||||
|
||||
return response.json()
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,296 @@
|
||||
import { contextValue, type Context } from "@aris/core"
|
||||
import { describe, expect, test } from "bun:test"
|
||||
|
||||
import type { ApiCalendarEvent, GoogleCalendarClient, ListEventsOptions } from "./types"
|
||||
|
||||
import fixture from "../fixtures/events.json"
|
||||
import { NextEventKey } from "./calendar-context"
|
||||
import { CalendarFeedItemType } from "./feed-items"
|
||||
import { GoogleCalendarSource } from "./google-calendar-source"
|
||||
|
||||
const NOW = new Date("2026-01-20T10:00:00Z")
|
||||
|
||||
function fixtureEvents(): ApiCalendarEvent[] {
|
||||
return fixture.items as unknown as ApiCalendarEvent[]
|
||||
}
|
||||
|
||||
function createMockClient(
|
||||
eventsByCalendar: Record<string, ApiCalendarEvent[]>,
|
||||
): GoogleCalendarClient {
|
||||
return {
|
||||
listCalendarIds: async () => Object.keys(eventsByCalendar),
|
||||
listEvents: async (options: ListEventsOptions) => {
|
||||
const events = eventsByCalendar[options.calendarId] ?? []
|
||||
return events.filter((e) => {
|
||||
const startRaw = e.start.dateTime ?? e.start.date ?? ""
|
||||
const endRaw = e.end.dateTime ?? e.end.date ?? ""
|
||||
return (
|
||||
new Date(startRaw).getTime() < options.timeMax.getTime() &&
|
||||
new Date(endRaw).getTime() > options.timeMin.getTime()
|
||||
)
|
||||
})
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
function defaultMockClient(): GoogleCalendarClient {
|
||||
return createMockClient({ primary: fixtureEvents() })
|
||||
}
|
||||
|
||||
function createContext(time?: Date): Context {
|
||||
return { time: time ?? NOW }
|
||||
}
|
||||
|
||||
describe("GoogleCalendarSource", () => {
|
||||
describe("constructor", () => {
|
||||
test("has correct id", () => {
|
||||
const source = new GoogleCalendarSource({ client: defaultMockClient() })
|
||||
expect(source.id).toBe("aris.google-calendar")
|
||||
})
|
||||
})
|
||||
|
||||
describe("fetchItems", () => {
|
||||
test("returns empty array when no events", async () => {
|
||||
const source = new GoogleCalendarSource({
|
||||
client: createMockClient({ primary: [] }),
|
||||
})
|
||||
const items = await source.fetchItems(createContext())
|
||||
expect(items).toEqual([])
|
||||
})
|
||||
|
||||
test("returns feed items for all events in window", async () => {
|
||||
const source = new GoogleCalendarSource({ client: defaultMockClient() })
|
||||
const items = await source.fetchItems(createContext())
|
||||
|
||||
expect(items.length).toBe(fixture.items.length)
|
||||
})
|
||||
|
||||
test("assigns calendar-event type to timed events", async () => {
|
||||
const source = new GoogleCalendarSource({ client: defaultMockClient() })
|
||||
const items = await source.fetchItems(createContext())
|
||||
|
||||
const timedItems = items.filter((i) => i.type === CalendarFeedItemType.event)
|
||||
expect(timedItems.length).toBe(4)
|
||||
})
|
||||
|
||||
test("assigns calendar-all-day type to all-day events", async () => {
|
||||
const source = new GoogleCalendarSource({ client: defaultMockClient() })
|
||||
const items = await source.fetchItems(createContext())
|
||||
|
||||
const allDayItems = items.filter((i) => i.type === CalendarFeedItemType.allDay)
|
||||
expect(allDayItems.length).toBe(1)
|
||||
})
|
||||
|
||||
test("ongoing events get highest priority (1.0)", async () => {
|
||||
const source = new GoogleCalendarSource({ client: defaultMockClient() })
|
||||
const items = await source.fetchItems(createContext())
|
||||
|
||||
const ongoing = items.find((i) => i.data.eventId === "evt-ongoing")
|
||||
expect(ongoing).toBeDefined()
|
||||
expect(ongoing!.priority).toBe(1.0)
|
||||
})
|
||||
|
||||
test("upcoming events get higher priority when sooner", async () => {
|
||||
const source = new GoogleCalendarSource({ client: defaultMockClient() })
|
||||
const items = await source.fetchItems(createContext())
|
||||
|
||||
const soon = items.find((i) => i.data.eventId === "evt-soon")
|
||||
const later = items.find((i) => i.data.eventId === "evt-later")
|
||||
|
||||
expect(soon).toBeDefined()
|
||||
expect(later).toBeDefined()
|
||||
expect(soon!.priority).toBeGreaterThan(later!.priority)
|
||||
})
|
||||
|
||||
test("all-day events get flat priority (0.4)", async () => {
|
||||
const source = new GoogleCalendarSource({ client: defaultMockClient() })
|
||||
const items = await source.fetchItems(createContext())
|
||||
|
||||
const allDay = items.find((i) => i.data.eventId === "evt-allday")
|
||||
expect(allDay).toBeDefined()
|
||||
expect(allDay!.priority).toBe(0.4)
|
||||
})
|
||||
|
||||
test("generates unique IDs for each item", async () => {
|
||||
const source = new GoogleCalendarSource({ client: defaultMockClient() })
|
||||
const items = await source.fetchItems(createContext())
|
||||
|
||||
const ids = items.map((i) => i.id)
|
||||
const uniqueIds = new Set(ids)
|
||||
expect(uniqueIds.size).toBe(ids.length)
|
||||
})
|
||||
|
||||
test("sets timestamp from context.time", async () => {
|
||||
const source = new GoogleCalendarSource({ client: defaultMockClient() })
|
||||
const items = await source.fetchItems(createContext())
|
||||
|
||||
for (const item of items) {
|
||||
expect(item.timestamp).toEqual(NOW)
|
||||
}
|
||||
})
|
||||
|
||||
test("respects lookaheadHours", async () => {
|
||||
// Only 2 hours lookahead from 10:00 → events before 12:00
|
||||
const source = new GoogleCalendarSource({
|
||||
client: defaultMockClient(),
|
||||
lookaheadHours: 2,
|
||||
})
|
||||
const items = await source.fetchItems(createContext())
|
||||
|
||||
// Should include: ongoing (09:30-10:15), soon (10:10-10:40), allday (00:00-next day)
|
||||
// Should exclude: later (14:00), tentative lunch (12:00)
|
||||
const eventIds = items.map((i) => i.data.eventId)
|
||||
expect(eventIds).toContain("evt-ongoing")
|
||||
expect(eventIds).toContain("evt-soon")
|
||||
expect(eventIds).toContain("evt-allday")
|
||||
expect(eventIds).not.toContain("evt-later")
|
||||
expect(eventIds).not.toContain("evt-tentative")
|
||||
})
|
||||
|
||||
test("defaults to all user calendars via listCalendarIds", async () => {
|
||||
const workEvent: ApiCalendarEvent = {
|
||||
id: "evt-work",
|
||||
status: "confirmed",
|
||||
htmlLink: "https://calendar.google.com/event?eid=evt-work",
|
||||
summary: "Work Meeting",
|
||||
start: { dateTime: "2026-01-20T11:00:00Z" },
|
||||
end: { dateTime: "2026-01-20T12:00:00Z" },
|
||||
}
|
||||
|
||||
const client = createMockClient({
|
||||
primary: fixtureEvents(),
|
||||
"work@example.com": [workEvent],
|
||||
})
|
||||
|
||||
// No calendarIds provided — should discover both calendars
|
||||
const source = new GoogleCalendarSource({ client })
|
||||
const items = await source.fetchItems(createContext())
|
||||
|
||||
const eventIds = items.map((i) => i.data.eventId)
|
||||
expect(eventIds).toContain("evt-work")
|
||||
expect(eventIds).toContain("evt-ongoing")
|
||||
})
|
||||
|
||||
test("fetches from explicit calendar IDs", async () => {
|
||||
const workEvent: ApiCalendarEvent = {
|
||||
id: "evt-work",
|
||||
status: "confirmed",
|
||||
htmlLink: "https://calendar.google.com/event?eid=evt-work",
|
||||
summary: "Work Meeting",
|
||||
start: { dateTime: "2026-01-20T11:00:00Z" },
|
||||
end: { dateTime: "2026-01-20T12:00:00Z" },
|
||||
}
|
||||
|
||||
const client = createMockClient({
|
||||
primary: fixtureEvents(),
|
||||
"work@example.com": [workEvent],
|
||||
})
|
||||
|
||||
const source = new GoogleCalendarSource({
|
||||
client,
|
||||
calendarIds: ["primary", "work@example.com"],
|
||||
})
|
||||
const items = await source.fetchItems(createContext())
|
||||
|
||||
const eventIds = items.map((i) => i.data.eventId)
|
||||
expect(eventIds).toContain("evt-work")
|
||||
expect(eventIds).toContain("evt-ongoing")
|
||||
})
|
||||
})
|
||||
|
||||
describe("fetchContext", () => {
|
||||
test("returns null when no events", async () => {
|
||||
const source = new GoogleCalendarSource({
|
||||
client: createMockClient({ primary: [] }),
|
||||
})
|
||||
const result = await source.fetchContext(createContext())
|
||||
expect(result).toBeNull()
|
||||
})
|
||||
|
||||
test("returns null when only all-day events", async () => {
|
||||
const allDayOnly: ApiCalendarEvent[] = [
|
||||
{
|
||||
id: "evt-allday",
|
||||
status: "confirmed",
|
||||
htmlLink: "https://calendar.google.com/event?eid=evt-allday",
|
||||
summary: "Holiday",
|
||||
start: { date: "2026-01-20" },
|
||||
end: { date: "2026-01-21" },
|
||||
},
|
||||
]
|
||||
const source = new GoogleCalendarSource({
|
||||
client: createMockClient({ primary: allDayOnly }),
|
||||
})
|
||||
const result = await source.fetchContext(createContext())
|
||||
expect(result).toBeNull()
|
||||
})
|
||||
|
||||
test("returns next upcoming timed event (not ongoing)", async () => {
|
||||
const source = new GoogleCalendarSource({ client: defaultMockClient() })
|
||||
const result = await source.fetchContext(createContext())
|
||||
|
||||
expect(result).not.toBeNull()
|
||||
const nextEvent = contextValue(result! as Context, NextEventKey)
|
||||
expect(nextEvent).toBeDefined()
|
||||
// evt-soon starts at 10:10, which is the nearest future timed event
|
||||
expect(nextEvent!.title).toBe("1:1 with Manager")
|
||||
expect(nextEvent!.minutesUntilStart).toBe(10)
|
||||
expect(nextEvent!.location).toBeNull()
|
||||
})
|
||||
|
||||
test("includes location when available", async () => {
|
||||
const events: ApiCalendarEvent[] = [
|
||||
{
|
||||
id: "evt-loc",
|
||||
status: "confirmed",
|
||||
htmlLink: "https://calendar.google.com/event?eid=evt-loc",
|
||||
summary: "Offsite",
|
||||
location: "123 Main St",
|
||||
start: { dateTime: "2026-01-20T11:00:00Z" },
|
||||
end: { dateTime: "2026-01-20T12:00:00Z" },
|
||||
},
|
||||
]
|
||||
const source = new GoogleCalendarSource({
|
||||
client: createMockClient({ primary: events }),
|
||||
})
|
||||
const result = await source.fetchContext(createContext())
|
||||
|
||||
expect(result).not.toBeNull()
|
||||
const nextEvent = contextValue(result! as Context, NextEventKey)
|
||||
expect(nextEvent).toBeDefined()
|
||||
expect(nextEvent!.location).toBe("123 Main St")
|
||||
})
|
||||
|
||||
test("skips ongoing events for next-event context", async () => {
|
||||
const events: ApiCalendarEvent[] = [
|
||||
{
|
||||
id: "evt-now",
|
||||
status: "confirmed",
|
||||
htmlLink: "https://calendar.google.com/event?eid=evt-now",
|
||||
summary: "Current Meeting",
|
||||
start: { dateTime: "2026-01-20T09:30:00Z" },
|
||||
end: { dateTime: "2026-01-20T10:30:00Z" },
|
||||
},
|
||||
]
|
||||
const source = new GoogleCalendarSource({
|
||||
client: createMockClient({ primary: events }),
|
||||
})
|
||||
const result = await source.fetchContext(createContext())
|
||||
expect(result).toBeNull()
|
||||
})
|
||||
})
|
||||
|
||||
describe("priority ordering", () => {
|
||||
test("ongoing > upcoming > all-day", async () => {
|
||||
const source = new GoogleCalendarSource({ client: defaultMockClient() })
|
||||
const items = await source.fetchItems(createContext())
|
||||
|
||||
const ongoing = items.find((i) => i.data.eventId === "evt-ongoing")!
|
||||
const upcoming = items.find((i) => i.data.eventId === "evt-soon")!
|
||||
const allDay = items.find((i) => i.data.eventId === "evt-allday")!
|
||||
|
||||
expect(ongoing.priority).toBeGreaterThan(upcoming.priority)
|
||||
expect(upcoming.priority).toBeGreaterThan(allDay.priority)
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,212 @@
|
||||
import type { ActionDefinition, Context, FeedSource } from "@aris/core"
|
||||
|
||||
import { UnknownActionError } from "@aris/core"
|
||||
|
||||
import type {
|
||||
ApiCalendarEvent,
|
||||
CalendarEventData,
|
||||
GoogleCalendarClient,
|
||||
GoogleOAuthProvider,
|
||||
} from "./types"
|
||||
|
||||
import { NextEventKey, type NextEvent } from "./calendar-context"
|
||||
|
||||
interface GoogleCalendarSourceBaseOptions {
|
||||
calendarIds?: string[]
|
||||
/** Default: 24 */
|
||||
lookaheadHours?: number
|
||||
}
|
||||
|
||||
interface GoogleCalendarSourceWithProvider extends GoogleCalendarSourceBaseOptions {
|
||||
oauthProvider: GoogleOAuthProvider
|
||||
client?: never
|
||||
}
|
||||
|
||||
interface GoogleCalendarSourceWithClient extends GoogleCalendarSourceBaseOptions {
|
||||
oauthProvider?: never
|
||||
client: GoogleCalendarClient
|
||||
}
|
||||
|
||||
export type GoogleCalendarSourceOptions =
|
||||
| GoogleCalendarSourceWithProvider
|
||||
| GoogleCalendarSourceWithClient
|
||||
import { CalendarFeedItemType, type CalendarFeedItem } from "./feed-items"
|
||||
import { DefaultGoogleCalendarClient } from "./google-calendar-api"
|
||||
|
||||
const DEFAULT_LOOKAHEAD_HOURS = 24
|
||||
|
||||
const PRIORITY_ONGOING = 1.0
|
||||
const PRIORITY_UPCOMING_MAX = 0.9
|
||||
const PRIORITY_UPCOMING_MIN = 0.3
|
||||
const PRIORITY_ALL_DAY = 0.4
|
||||
|
||||
/**
|
||||
* A FeedSource that provides Google Calendar events and next-event context.
|
||||
*
|
||||
* Fetches upcoming and all-day events within a configurable lookahead window.
|
||||
* Provides a NextEvent context for downstream sources to react to the user's schedule.
|
||||
*
|
||||
* @example
|
||||
* ```ts
|
||||
* const calendarSource = new GoogleCalendarSource({
|
||||
* oauthProvider: myOAuthProvider,
|
||||
* calendarIds: ["primary", "work@example.com"],
|
||||
* lookaheadHours: 12,
|
||||
* })
|
||||
*
|
||||
* const engine = new FeedEngine()
|
||||
* .register(calendarSource)
|
||||
*
|
||||
* // Access next-event context in downstream sources
|
||||
* const next = contextValue(context, NextEventKey)
|
||||
* if (next && next.minutesUntilStart < 15) {
|
||||
* // remind user
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
export class GoogleCalendarSource implements FeedSource<CalendarFeedItem> {
|
||||
readonly id = "aris.google-calendar"
|
||||
|
||||
private readonly client: GoogleCalendarClient
|
||||
private readonly calendarIds: string[] | undefined
|
||||
private readonly lookaheadHours: number
|
||||
|
||||
constructor(options: GoogleCalendarSourceOptions) {
|
||||
this.client = options.client ?? new DefaultGoogleCalendarClient(options.oauthProvider)
|
||||
this.calendarIds = options.calendarIds
|
||||
this.lookaheadHours = options.lookaheadHours ?? DEFAULT_LOOKAHEAD_HOURS
|
||||
}
|
||||
|
||||
async listActions(): Promise<Record<string, ActionDefinition>> {
|
||||
return {}
|
||||
}
|
||||
|
||||
async executeAction(actionId: string): Promise<void> {
|
||||
throw new UnknownActionError(actionId)
|
||||
}
|
||||
|
||||
async fetchContext(context: Context): Promise<Partial<Context> | null> {
|
||||
const events = await this.fetchAllEvents(context.time)
|
||||
|
||||
const now = context.time.getTime()
|
||||
const nextTimedEvent = events.find((e) => !e.isAllDay && e.startTime.getTime() > now)
|
||||
|
||||
if (!nextTimedEvent) {
|
||||
return null
|
||||
}
|
||||
|
||||
const minutesUntilStart = (nextTimedEvent.startTime.getTime() - now) / 60_000
|
||||
|
||||
const nextEvent: NextEvent = {
|
||||
title: nextTimedEvent.title,
|
||||
startTime: nextTimedEvent.startTime,
|
||||
endTime: nextTimedEvent.endTime,
|
||||
minutesUntilStart,
|
||||
location: nextTimedEvent.location,
|
||||
}
|
||||
|
||||
return { [NextEventKey]: nextEvent }
|
||||
}
|
||||
|
||||
async fetchItems(context: Context): Promise<CalendarFeedItem[]> {
|
||||
const events = await this.fetchAllEvents(context.time)
|
||||
const now = context.time.getTime()
|
||||
const lookaheadMs = this.lookaheadHours * 60 * 60 * 1000
|
||||
|
||||
return events.map((event) => createFeedItem(event, now, lookaheadMs))
|
||||
}
|
||||
|
||||
private async resolveCalendarIds(): Promise<string[]> {
|
||||
if (this.calendarIds) {
|
||||
return this.calendarIds
|
||||
}
|
||||
return this.client.listCalendarIds()
|
||||
}
|
||||
|
||||
private async fetchAllEvents(time: Date): Promise<CalendarEventData[]> {
|
||||
const timeMax = new Date(time.getTime() + this.lookaheadHours * 60 * 60 * 1000)
|
||||
const calendarIds = await this.resolveCalendarIds()
|
||||
|
||||
const results = await Promise.all(
|
||||
calendarIds.map(async (calendarId) => {
|
||||
const raw = await this.client.listEvents({
|
||||
calendarId,
|
||||
timeMin: time,
|
||||
timeMax,
|
||||
})
|
||||
return raw.map((event) => parseEvent(event, calendarId))
|
||||
}),
|
||||
)
|
||||
|
||||
const allEvents = results.flat()
|
||||
|
||||
// Sort by start time ascending
|
||||
allEvents.sort((a, b) => a.startTime.getTime() - b.startTime.getTime())
|
||||
|
||||
return allEvents
|
||||
}
|
||||
}
|
||||
|
||||
function parseEvent(event: ApiCalendarEvent, calendarId: string): CalendarEventData {
|
||||
const startRaw = event.start.dateTime ?? event.start.date
|
||||
const endRaw = event.end.dateTime ?? event.end.date
|
||||
|
||||
if (!startRaw || !endRaw) {
|
||||
throw new Error(`Event ${event.id} is missing start or end date`)
|
||||
}
|
||||
|
||||
const isAllDay = !event.start.dateTime
|
||||
|
||||
return {
|
||||
eventId: event.id,
|
||||
calendarId,
|
||||
title: event.summary ?? "(No title)",
|
||||
description: event.description ?? null,
|
||||
location: event.location ?? null,
|
||||
startTime: new Date(startRaw),
|
||||
endTime: new Date(endRaw),
|
||||
isAllDay,
|
||||
status: event.status,
|
||||
htmlLink: event.htmlLink,
|
||||
}
|
||||
}
|
||||
|
||||
function computePriority(event: CalendarEventData, nowMs: number, lookaheadMs: number): number {
|
||||
if (event.isAllDay) {
|
||||
return PRIORITY_ALL_DAY
|
||||
}
|
||||
|
||||
const startMs = event.startTime.getTime()
|
||||
const endMs = event.endTime.getTime()
|
||||
|
||||
// Ongoing: start <= now < end
|
||||
if (startMs <= nowMs && nowMs < endMs) {
|
||||
return PRIORITY_ONGOING
|
||||
}
|
||||
|
||||
// Upcoming: linear decay from PRIORITY_UPCOMING_MAX to PRIORITY_UPCOMING_MIN
|
||||
const msUntilStart = startMs - nowMs
|
||||
if (msUntilStart <= 0) {
|
||||
return PRIORITY_UPCOMING_MIN
|
||||
}
|
||||
|
||||
const ratio = Math.min(msUntilStart / lookaheadMs, 1)
|
||||
return PRIORITY_UPCOMING_MAX - ratio * (PRIORITY_UPCOMING_MAX - PRIORITY_UPCOMING_MIN)
|
||||
}
|
||||
|
||||
function createFeedItem(
|
||||
event: CalendarEventData,
|
||||
nowMs: number,
|
||||
lookaheadMs: number,
|
||||
): CalendarFeedItem {
|
||||
const priority = computePriority(event, nowMs, lookaheadMs)
|
||||
const itemType = event.isAllDay ? CalendarFeedItemType.allDay : CalendarFeedItemType.event
|
||||
|
||||
return {
|
||||
id: `calendar-${event.calendarId}-${event.eventId}`,
|
||||
type: itemType,
|
||||
priority,
|
||||
timestamp: new Date(nowMs),
|
||||
data: event,
|
||||
}
|
||||
}
|
||||
20
packages/aris-source-google-calendar/src/index.ts
Normal file
@@ -0,0 +1,20 @@
|
||||
export { NextEventKey, type NextEvent } from "./calendar-context"
|
||||
export {
|
||||
CalendarFeedItemType,
|
||||
type CalendarFeedItemType as CalendarFeedItemTypeType,
|
||||
type CalendarAllDayFeedItem,
|
||||
type CalendarEventFeedItem,
|
||||
type CalendarFeedItem,
|
||||
} from "./feed-items"
|
||||
export { DefaultGoogleCalendarClient } from "./google-calendar-api"
|
||||
export { GoogleCalendarSource, type GoogleCalendarSourceOptions } from "./google-calendar-source"
|
||||
export {
|
||||
EventStatus,
|
||||
type EventStatus as EventStatusType,
|
||||
type ApiCalendarEvent,
|
||||
type ApiEventDateTime,
|
||||
type CalendarEventData,
|
||||
type GoogleCalendarClient,
|
||||
type GoogleOAuthProvider,
|
||||
type ListEventsOptions,
|
||||
} from "./types"
|
||||
55
packages/aris-source-google-calendar/src/types.ts
Normal file
@@ -0,0 +1,55 @@
|
||||
export interface GoogleOAuthProvider {
|
||||
fetchAccessToken(): Promise<string>
|
||||
refresh(): Promise<string>
|
||||
revoke(): Promise<void>
|
||||
}
|
||||
|
||||
export const EventStatus = {
|
||||
Confirmed: "confirmed",
|
||||
Tentative: "tentative",
|
||||
Cancelled: "cancelled",
|
||||
} as const
|
||||
|
||||
export type EventStatus = (typeof EventStatus)[keyof typeof EventStatus]
|
||||
|
||||
/** Exactly one of dateTime or date is present. */
|
||||
export interface ApiEventDateTime {
|
||||
dateTime?: string
|
||||
date?: string
|
||||
timeZone?: string
|
||||
}
|
||||
|
||||
export interface ApiCalendarEvent {
|
||||
id: string
|
||||
status: EventStatus
|
||||
htmlLink: string
|
||||
summary?: string
|
||||
description?: string
|
||||
location?: string
|
||||
start: ApiEventDateTime
|
||||
end: ApiEventDateTime
|
||||
}
|
||||
|
||||
export type CalendarEventData = {
|
||||
eventId: string
|
||||
calendarId: string
|
||||
title: string
|
||||
description: string | null
|
||||
location: string | null
|
||||
startTime: Date
|
||||
endTime: Date
|
||||
isAllDay: boolean
|
||||
status: EventStatus
|
||||
htmlLink: string
|
||||
}
|
||||
|
||||
export interface ListEventsOptions {
|
||||
calendarId: string
|
||||
timeMin: Date
|
||||
timeMax: Date
|
||||
}
|
||||
|
||||
export interface GoogleCalendarClient {
|
||||
listCalendarIds(): Promise<string[]>
|
||||
listEvents(options: ListEventsOptions): Promise<ApiCalendarEvent[]>
|
||||
}
|
||||
@@ -8,6 +8,7 @@
|
||||
"test": "bun test src/"
|
||||
},
|
||||
"dependencies": {
|
||||
"@aris/core": "workspace:*"
|
||||
"@aris/core": "workspace:*",
|
||||
"arktype": "^2.1.0"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,6 +1,2 @@
|
||||
export {
|
||||
LocationSource,
|
||||
LocationKey,
|
||||
type Location,
|
||||
type LocationSourceOptions,
|
||||
} from "./location-source.ts"
|
||||
export { LocationSource, LocationKey } from "./location-source.ts"
|
||||
export { Location, type LocationSourceOptions } from "./types.ts"
|
||||
|
||||
@@ -16,7 +16,7 @@ describe("LocationSource", () => {
|
||||
describe("FeedSource interface", () => {
|
||||
test("has correct id", () => {
|
||||
const source = new LocationSource()
|
||||
expect(source.id).toBe("location")
|
||||
expect(source.id).toBe("aris.location")
|
||||
})
|
||||
|
||||
test("fetchItems always returns empty array", async () => {
|
||||
@@ -27,11 +27,11 @@ describe("LocationSource", () => {
|
||||
expect(items).toEqual([])
|
||||
})
|
||||
|
||||
test("fetchContext returns empty when no location", async () => {
|
||||
test("fetchContext returns null when no location", async () => {
|
||||
const source = new LocationSource()
|
||||
|
||||
const context = await source.fetchContext()
|
||||
expect(context).toEqual({})
|
||||
expect(context).toBeNull()
|
||||
})
|
||||
|
||||
test("fetchContext returns location when available", async () => {
|
||||
@@ -147,4 +147,40 @@ describe("LocationSource", () => {
|
||||
expect(listener2).toHaveBeenCalledTimes(1)
|
||||
})
|
||||
})
|
||||
|
||||
describe("actions", () => {
|
||||
test("listActions returns update-location action", async () => {
|
||||
const source = new LocationSource()
|
||||
const actions = await source.listActions()
|
||||
|
||||
expect(actions["update-location"]).toBeDefined()
|
||||
expect(actions["update-location"]!.id).toBe("update-location")
|
||||
expect(actions["update-location"]!.input).toBeDefined()
|
||||
})
|
||||
|
||||
test("executeAction update-location pushes location", async () => {
|
||||
const source = new LocationSource()
|
||||
|
||||
expect(source.lastLocation).toBeNull()
|
||||
|
||||
const location = createLocation({ lat: 40.7128, lng: -74.006 })
|
||||
await source.executeAction("update-location", location)
|
||||
|
||||
expect(source.lastLocation).toEqual(location)
|
||||
})
|
||||
|
||||
test("executeAction throws on invalid input", async () => {
|
||||
const source = new LocationSource()
|
||||
|
||||
await expect(
|
||||
source.executeAction("update-location", { lat: "not a number" }),
|
||||
).rejects.toThrow()
|
||||
})
|
||||
|
||||
test("executeAction throws for unknown action", async () => {
|
||||
const source = new LocationSource()
|
||||
|
||||
await expect(source.executeAction("nonexistent", {})).rejects.toThrow("Unknown action")
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
@@ -1,22 +1,9 @@
|
||||
import type { Context, FeedSource } from "@aris/core"
|
||||
import type { ActionDefinition, Context, FeedSource } from "@aris/core"
|
||||
|
||||
import { contextKey, type ContextKey } from "@aris/core"
|
||||
import { UnknownActionError, contextKey, type ContextKey } from "@aris/core"
|
||||
import { type } from "arktype"
|
||||
|
||||
/**
|
||||
* Geographic coordinates with accuracy and timestamp.
|
||||
*/
|
||||
export interface Location {
|
||||
lat: number
|
||||
lng: number
|
||||
/** Accuracy in meters */
|
||||
accuracy: number
|
||||
timestamp: Date
|
||||
}
|
||||
|
||||
export interface LocationSourceOptions {
|
||||
/** Number of locations to retain in history. Defaults to 1. */
|
||||
historySize?: number
|
||||
}
|
||||
import { Location, type LocationSourceOptions } from "./types.ts"
|
||||
|
||||
export const LocationKey: ContextKey<Location> = contextKey("location")
|
||||
|
||||
@@ -29,7 +16,7 @@ export const LocationKey: ContextKey<Location> = contextKey("location")
|
||||
* Does not produce feed items - always returns empty array from `fetchItems`.
|
||||
*/
|
||||
export class LocationSource implements FeedSource {
|
||||
readonly id = "location"
|
||||
readonly id = "aris.location"
|
||||
|
||||
private readonly historySize: number
|
||||
private locations: Location[] = []
|
||||
@@ -39,6 +26,31 @@ export class LocationSource implements FeedSource {
|
||||
this.historySize = options.historySize ?? 1
|
||||
}
|
||||
|
||||
async listActions(): Promise<Record<string, ActionDefinition>> {
|
||||
return {
|
||||
"update-location": {
|
||||
id: "update-location",
|
||||
description: "Push a new location update",
|
||||
input: Location,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
async executeAction(actionId: string, params: unknown): Promise<void> {
|
||||
switch (actionId) {
|
||||
case "update-location": {
|
||||
const result = Location(params)
|
||||
if (result instanceof type.errors) {
|
||||
throw new Error(result.summary)
|
||||
}
|
||||
this.pushLocation(result)
|
||||
return
|
||||
}
|
||||
default:
|
||||
throw new UnknownActionError(actionId)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Push a new location update. Notifies all context listeners.
|
||||
*/
|
||||
@@ -73,11 +85,11 @@ export class LocationSource implements FeedSource {
|
||||
}
|
||||
}
|
||||
|
||||
async fetchContext(): Promise<Partial<Context>> {
|
||||
async fetchContext(): Promise<Partial<Context> | null> {
|
||||
if (this.lastLocation) {
|
||||
return { [LocationKey]: this.lastLocation }
|
||||
}
|
||||
return {}
|
||||
return null
|
||||
}
|
||||
|
||||
async fetchItems(): Promise<[]> {
|
||||
|
||||
17
packages/aris-source-location/src/types.ts
Normal file
@@ -0,0 +1,17 @@
|
||||
import { type } from "arktype"
|
||||
|
||||
/** Geographic coordinates with accuracy and timestamp. */
|
||||
export const Location = type({
|
||||
lat: "number",
|
||||
lng: "number",
|
||||
/** Accuracy in meters */
|
||||
accuracy: "number",
|
||||
timestamp: "Date",
|
||||
})
|
||||
|
||||
export type Location = typeof Location.infer
|
||||
|
||||
export interface LocationSourceOptions {
|
||||
/** Number of locations to retain in history. Defaults to 1. */
|
||||
historySize?: number
|
||||
}
|
||||
@@ -142,7 +142,7 @@ export class TflApi {
|
||||
|
||||
// Schemas
|
||||
|
||||
const lineId = type(
|
||||
export const lineId = type(
|
||||
"'bakerloo' | 'central' | 'circle' | 'district' | 'hammersmith-city' | 'jubilee' | 'metropolitan' | 'northern' | 'piccadilly' | 'victoria' | 'waterloo-city' | 'lioness' | 'mildmay' | 'windrush' | 'weaver' | 'suffragette' | 'liberty' | 'elizabeth'",
|
||||
)
|
||||
|
||||
|
||||
@@ -94,12 +94,12 @@ describe("TflSource", () => {
|
||||
describe("interface", () => {
|
||||
test("has correct id", () => {
|
||||
const source = new TflSource({ client: api })
|
||||
expect(source.id).toBe("tfl")
|
||||
expect(source.id).toBe("aris.tfl")
|
||||
})
|
||||
|
||||
test("depends on location", () => {
|
||||
const source = new TflSource({ client: api })
|
||||
expect(source.dependencies).toEqual(["location"])
|
||||
expect(source.dependencies).toEqual(["aris.location"])
|
||||
})
|
||||
|
||||
test("implements fetchItems", () => {
|
||||
@@ -122,7 +122,12 @@ describe("TflSource", () => {
|
||||
severity: "minor-delays",
|
||||
description: "Delays",
|
||||
},
|
||||
{ lineId: "central", lineName: "Central", severity: "closure", description: "Closed" },
|
||||
{
|
||||
lineId: "central",
|
||||
lineName: "Central",
|
||||
severity: "closure",
|
||||
description: "Closed",
|
||||
},
|
||||
]
|
||||
return lines ? all.filter((s) => lines.includes(s.lineId)) : all
|
||||
},
|
||||
@@ -144,7 +149,10 @@ describe("TflSource", () => {
|
||||
})
|
||||
|
||||
test("DEFAULT_LINES_OF_INTEREST restores all lines", async () => {
|
||||
const source = new TflSource({ client: lineFilteringApi, lines: ["northern"] })
|
||||
const source = new TflSource({
|
||||
client: lineFilteringApi,
|
||||
lines: ["northern"],
|
||||
})
|
||||
const filtered = await source.fetchItems(createContext())
|
||||
expect(filtered.length).toBe(1)
|
||||
|
||||
@@ -164,7 +172,12 @@ describe("TflSource", () => {
|
||||
|
||||
test("feed items have correct base structure", async () => {
|
||||
const source = new TflSource({ client: api })
|
||||
const location: Location = { lat: 51.5074, lng: -0.1278, accuracy: 10, timestamp: new Date() }
|
||||
const location: Location = {
|
||||
lat: 51.5074,
|
||||
lng: -0.1278,
|
||||
accuracy: 10,
|
||||
timestamp: new Date(),
|
||||
}
|
||||
const items = await source.fetchItems(createContext(location))
|
||||
|
||||
for (const item of items) {
|
||||
@@ -178,7 +191,12 @@ describe("TflSource", () => {
|
||||
|
||||
test("feed items have correct data structure", async () => {
|
||||
const source = new TflSource({ client: api })
|
||||
const location: Location = { lat: 51.5074, lng: -0.1278, accuracy: 10, timestamp: new Date() }
|
||||
const location: Location = {
|
||||
lat: 51.5074,
|
||||
lng: -0.1278,
|
||||
accuracy: 10,
|
||||
timestamp: new Date(),
|
||||
}
|
||||
const items = await source.fetchItems(createContext(location))
|
||||
|
||||
for (const item of items) {
|
||||
@@ -230,7 +248,12 @@ describe("TflSource", () => {
|
||||
|
||||
test("closestStationDistance is number when location provided", async () => {
|
||||
const source = new TflSource({ client: api })
|
||||
const location: Location = { lat: 51.5074, lng: -0.1278, accuracy: 10, timestamp: new Date() }
|
||||
const location: Location = {
|
||||
lat: 51.5074,
|
||||
lng: -0.1278,
|
||||
accuracy: 10,
|
||||
timestamp: new Date(),
|
||||
}
|
||||
const items = await source.fetchItems(createContext(location))
|
||||
|
||||
for (const item of items) {
|
||||
@@ -248,6 +271,62 @@ describe("TflSource", () => {
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
describe("actions", () => {
|
||||
test("listActions returns set-lines-of-interest", async () => {
|
||||
const source = new TflSource({ client: api })
|
||||
const actions = await source.listActions()
|
||||
|
||||
expect(actions["set-lines-of-interest"]).toBeDefined()
|
||||
expect(actions["set-lines-of-interest"]!.id).toBe("set-lines-of-interest")
|
||||
})
|
||||
|
||||
test("executeAction set-lines-of-interest updates lines", async () => {
|
||||
const lineFilteringApi: ITflApi = {
|
||||
async fetchLineStatuses(lines?: TflLineId[]): Promise<TflLineStatus[]> {
|
||||
const all: TflLineStatus[] = [
|
||||
{
|
||||
lineId: "northern",
|
||||
lineName: "Northern",
|
||||
severity: "minor-delays",
|
||||
description: "Delays",
|
||||
},
|
||||
{
|
||||
lineId: "central",
|
||||
lineName: "Central",
|
||||
severity: "closure",
|
||||
description: "Closed",
|
||||
},
|
||||
]
|
||||
return lines ? all.filter((s) => lines.includes(s.lineId)) : all
|
||||
},
|
||||
async fetchStations(): Promise<StationLocation[]> {
|
||||
return []
|
||||
},
|
||||
}
|
||||
|
||||
const source = new TflSource({ client: lineFilteringApi })
|
||||
await source.executeAction("set-lines-of-interest", ["northern"])
|
||||
|
||||
const items = await source.fetchItems(createContext())
|
||||
expect(items.length).toBe(1)
|
||||
expect(items[0]!.data.line).toBe("northern")
|
||||
})
|
||||
|
||||
test("executeAction throws on invalid input", async () => {
|
||||
const source = new TflSource({ client: api })
|
||||
|
||||
await expect(
|
||||
source.executeAction("set-lines-of-interest", "not-an-array"),
|
||||
).rejects.toThrow()
|
||||
})
|
||||
|
||||
test("executeAction throws for unknown action", async () => {
|
||||
const source = new TflSource({ client: api })
|
||||
|
||||
await expect(source.executeAction("nonexistent", {})).rejects.toThrow("Unknown action")
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe("TfL Fixture Data Shape", () => {
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
import type { Context, FeedSource } from "@aris/core"
|
||||
import type { ActionDefinition, Context, FeedSource } from "@aris/core"
|
||||
|
||||
import { contextValue } from "@aris/core"
|
||||
import { UnknownActionError, contextValue } from "@aris/core"
|
||||
import { LocationKey } from "@aris/source-location"
|
||||
import { type } from "arktype"
|
||||
|
||||
import type {
|
||||
ITflApi,
|
||||
@@ -13,7 +14,9 @@ import type {
|
||||
TflSourceOptions,
|
||||
} from "./types.ts"
|
||||
|
||||
import { TflApi } from "./tfl-api.ts"
|
||||
import { TflApi, lineId } from "./tfl-api.ts"
|
||||
|
||||
const setLinesInput = lineId.array()
|
||||
|
||||
const SEVERITY_PRIORITY: Record<TflAlertSeverity, number> = {
|
||||
closure: 1.0,
|
||||
@@ -63,8 +66,8 @@ export class TflSource implements FeedSource<TflAlertFeedItem> {
|
||||
"elizabeth",
|
||||
]
|
||||
|
||||
readonly id = "tfl"
|
||||
readonly dependencies = ["location"]
|
||||
readonly id = "aris.tfl"
|
||||
readonly dependencies = ["aris.location"]
|
||||
|
||||
private readonly client: ITflApi
|
||||
private lines: TflLineId[]
|
||||
@@ -77,6 +80,35 @@ export class TflSource implements FeedSource<TflAlertFeedItem> {
|
||||
this.lines = options.lines ?? [...TflSource.DEFAULT_LINES_OF_INTEREST]
|
||||
}
|
||||
|
||||
async listActions(): Promise<Record<string, ActionDefinition>> {
|
||||
return {
|
||||
"set-lines-of-interest": {
|
||||
id: "set-lines-of-interest",
|
||||
description: "Update the set of monitored TfL lines",
|
||||
input: setLinesInput,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
async executeAction(actionId: string, params: unknown): Promise<void> {
|
||||
switch (actionId) {
|
||||
case "set-lines-of-interest": {
|
||||
const result = setLinesInput(params)
|
||||
if (result instanceof type.errors) {
|
||||
throw new Error(result.summary)
|
||||
}
|
||||
this.setLinesOfInterest(result)
|
||||
return
|
||||
}
|
||||
default:
|
||||
throw new UnknownActionError(actionId)
|
||||
}
|
||||
}
|
||||
|
||||
async fetchContext(): Promise<null> {
|
||||
return null
|
||||
}
|
||||
|
||||
/**
|
||||
* Update the set of monitored lines. Takes effect on the next fetchItems call.
|
||||
*/
|
||||
|
||||
@@ -34,12 +34,12 @@ describe("WeatherSource", () => {
|
||||
describe("properties", () => {
|
||||
test("has correct id", () => {
|
||||
const source = new WeatherSource({ credentials: mockCredentials })
|
||||
expect(source.id).toBe("weather")
|
||||
expect(source.id).toBe("aris.weather")
|
||||
})
|
||||
|
||||
test("depends on location", () => {
|
||||
const source = new WeatherSource({ credentials: mockCredentials })
|
||||
expect(source.dependencies).toEqual(["location"])
|
||||
expect(source.dependencies).toEqual(["aris.location"])
|
||||
})
|
||||
|
||||
test("throws error if neither client nor credentials provided", () => {
|
||||
@@ -52,11 +52,11 @@ describe("WeatherSource", () => {
|
||||
describe("fetchContext", () => {
|
||||
const mockClient = createMockClient(fixture.response as WeatherKitResponse)
|
||||
|
||||
test("returns empty when no location", async () => {
|
||||
test("returns null when no location", async () => {
|
||||
const source = new WeatherSource({ client: mockClient })
|
||||
const result = await source.fetchContext(createMockContext())
|
||||
|
||||
expect(result).toEqual({})
|
||||
expect(result).toBeNull()
|
||||
})
|
||||
|
||||
test("returns simplified weather context", async () => {
|
||||
@@ -64,7 +64,8 @@ describe("WeatherSource", () => {
|
||||
const context = createMockContext({ lat: 37.7749, lng: -122.4194 })
|
||||
|
||||
const result = await source.fetchContext(context)
|
||||
const weather = contextValue(result, WeatherKey)
|
||||
expect(result).not.toBeNull()
|
||||
const weather = contextValue(result! as Context, WeatherKey)
|
||||
|
||||
expect(weather).toBeDefined()
|
||||
expect(typeof weather!.temperature).toBe("number")
|
||||
@@ -77,11 +78,15 @@ describe("WeatherSource", () => {
|
||||
})
|
||||
|
||||
test("converts temperature to imperial", async () => {
|
||||
const source = new WeatherSource({ client: mockClient, units: Units.imperial })
|
||||
const source = new WeatherSource({
|
||||
client: mockClient,
|
||||
units: Units.imperial,
|
||||
})
|
||||
const context = createMockContext({ lat: 37.7749, lng: -122.4194 })
|
||||
|
||||
const result = await source.fetchContext(context)
|
||||
const weather = contextValue(result, WeatherKey)
|
||||
expect(result).not.toBeNull()
|
||||
const weather = contextValue(result! as Context, WeatherKey)
|
||||
|
||||
// Fixture has temperature around 10°C, imperial should be around 50°F
|
||||
expect(weather!.temperature).toBeGreaterThan(40)
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import type { Context, FeedSource } from "@aris/core"
|
||||
import type { ActionDefinition, Context, FeedSource } from "@aris/core"
|
||||
|
||||
import { contextValue } from "@aris/core"
|
||||
import { UnknownActionError, contextValue } from "@aris/core"
|
||||
import { LocationKey } from "@aris/source-location"
|
||||
|
||||
import { WeatherFeedItemType, type WeatherFeedItem } from "./feed-items"
|
||||
@@ -93,8 +93,8 @@ const MODERATE_CONDITIONS = new Set<ConditionCode>([
|
||||
* ```
|
||||
*/
|
||||
export class WeatherSource implements FeedSource<WeatherFeedItem> {
|
||||
readonly id = "weather"
|
||||
readonly dependencies = ["location"]
|
||||
readonly id = "aris.weather"
|
||||
readonly dependencies = ["aris.location"]
|
||||
|
||||
private readonly client: WeatherKitClient
|
||||
private readonly hourlyLimit: number
|
||||
@@ -111,10 +111,18 @@ export class WeatherSource implements FeedSource<WeatherFeedItem> {
|
||||
this.units = options.units ?? Units.metric
|
||||
}
|
||||
|
||||
async fetchContext(context: Context): Promise<Partial<Context>> {
|
||||
async listActions(): Promise<Record<string, ActionDefinition>> {
|
||||
return {}
|
||||
}
|
||||
|
||||
async executeAction(actionId: string): Promise<void> {
|
||||
throw new UnknownActionError(actionId)
|
||||
}
|
||||
|
||||
async fetchContext(context: Context): Promise<Partial<Context> | null> {
|
||||
const location = contextValue(context, LocationKey)
|
||||
if (!location) {
|
||||
return {}
|
||||
return null
|
||||
}
|
||||
|
||||
const response = await this.client.fetch({
|
||||
@@ -123,7 +131,7 @@ export class WeatherSource implements FeedSource<WeatherFeedItem> {
|
||||
})
|
||||
|
||||
if (!response.currentWeather) {
|
||||
return {}
|
||||
return null
|
||||
}
|
||||
|
||||
const weather: Weather = {
|
||||
|
||||