mirror of
https://github.com/kennethnym/aris.git
synced 2026-03-19 16:41:18 +00:00
feat(tfl): add FeedItemRenderer for TfL alerts (#73)
* feat(tfl): add FeedItemRenderer for TfL alerts Implement renderTflAlert using JRX and @aelis/components. Upgrade @nym.sh/jrx to 0.2.0 for null child support. Co-authored-by: Ona <no-reply@ona.com> * fix(tfl): add jsxImportSource pragma for CI The CI test runner doesn't use per-package tsconfig.json, so the pragma is needed alongside the tsconfig setting. Co-authored-by: Ona <no-reply@ona.com> * fix(ci): run tests per-package via bun run test Use 'bun run test' (which runs 'bun run --filter * test') instead of 'bun test' so each package runs tests from its own directory. Add jsxImportSource pragma to renderer files since consumers without a JRX tsconfig also import them. Co-authored-by: Ona <no-reply@ona.com> * fix(tfl): handle near-1km boundary in formatDistance Values like 0.9999km rounded to 1000m and displayed as '1000m away'. Now converts to meters first and switches to km format when rounded meters >= 1000. Co-authored-by: Ona <no-reply@ona.com> --------- Co-authored-by: Ona <no-reply@ona.com>
This commit is contained in:
2
.github/workflows/test.yml
vendored
2
.github/workflows/test.yml
vendored
@@ -21,4 +21,4 @@ jobs:
|
||||
run: bun install --frozen-lockfile
|
||||
|
||||
- name: Run tests
|
||||
run: bun test
|
||||
run: bun run test
|
||||
|
||||
5
bun.lock
5
bun.lock
@@ -178,10 +178,15 @@
|
||||
"name": "@aelis/source-tfl",
|
||||
"version": "0.0.0",
|
||||
"dependencies": {
|
||||
"@aelis/components": "workspace:*",
|
||||
"@aelis/core": "workspace:*",
|
||||
"@aelis/source-location": "workspace:*",
|
||||
"arktype": "^2.1.0",
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@json-render/core": "*",
|
||||
"@nym.sh/jrx": "*",
|
||||
},
|
||||
},
|
||||
"packages/aelis-source-weatherkit": {
|
||||
"name": "@aelis/source-weatherkit",
|
||||
|
||||
@@ -10,7 +10,12 @@
|
||||
},
|
||||
"dependencies": {
|
||||
"@aelis/core": "workspace:*",
|
||||
"@aelis/components": "workspace:*",
|
||||
"@aelis/source-location": "workspace:*",
|
||||
"arktype": "^2.1.0"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@json-render/core": "*",
|
||||
"@nym.sh/jrx": "*"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -11,3 +11,4 @@ export {
|
||||
type TflLineStatus,
|
||||
type TflSourceOptions,
|
||||
} from "./types.ts"
|
||||
export { renderTflAlert } from "./renderer.tsx"
|
||||
|
||||
103
packages/aelis-source-tfl/src/renderer.test.tsx
Normal file
103
packages/aelis-source-tfl/src/renderer.test.tsx
Normal file
@@ -0,0 +1,103 @@
|
||||
/** @jsxImportSource @nym.sh/jrx */
|
||||
import { render } from "@nym.sh/jrx"
|
||||
import { describe, expect, test } from "bun:test"
|
||||
|
||||
import type { TflAlertFeedItem } from "./types.ts"
|
||||
|
||||
import { renderTflAlert } from "./renderer.tsx"
|
||||
|
||||
function makeItem(overrides: Partial<TflAlertFeedItem["data"]> = {}): TflAlertFeedItem {
|
||||
return {
|
||||
id: "tfl-alert-northern-minor-delays",
|
||||
type: "tfl-alert",
|
||||
timestamp: new Date("2026-01-15T12:00:00Z"),
|
||||
data: {
|
||||
line: "northern",
|
||||
lineName: "Northern",
|
||||
severity: "minor-delays",
|
||||
description: "Minor delays due to signal failure",
|
||||
closestStationDistance: null,
|
||||
...overrides,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
describe("renderTflAlert", () => {
|
||||
test("renders a FeedCard with title and description", () => {
|
||||
const node = renderTflAlert(makeItem())
|
||||
const spec = render(node)
|
||||
|
||||
const root = spec.elements[spec.root]!
|
||||
expect(root.type).toBe("FeedCard")
|
||||
expect(root.children!.length).toBeGreaterThanOrEqual(2)
|
||||
|
||||
const title = spec.elements[root.children![0]!]!
|
||||
expect(title.type).toBe("SansSerifText")
|
||||
expect(title.props.content).toBe("Northern · Minor delays")
|
||||
|
||||
const body = spec.elements[root.children![1]!]!
|
||||
expect(body.type).toBe("SansSerifText")
|
||||
expect(body.props.content).toBe("Minor delays due to signal failure")
|
||||
})
|
||||
|
||||
test("shows nearest station distance when available", () => {
|
||||
const node = renderTflAlert(makeItem({ closestStationDistance: 0.35 }))
|
||||
const spec = render(node)
|
||||
|
||||
const root = spec.elements[spec.root]!
|
||||
expect(root.children).toHaveLength(3)
|
||||
|
||||
const caption = spec.elements[root.children![2]!]!
|
||||
expect(caption.type).toBe("SansSerifText")
|
||||
expect(caption.props.content).toBe("Nearest station: 350m away")
|
||||
})
|
||||
|
||||
test("formats distance in km when >= 1km", () => {
|
||||
const node = renderTflAlert(makeItem({ closestStationDistance: 2.456 }))
|
||||
const spec = render(node)
|
||||
|
||||
const root = spec.elements[spec.root]!
|
||||
const caption = spec.elements[root.children![2]!]!
|
||||
expect(caption.props.content).toBe("Nearest station: 2.5km away")
|
||||
})
|
||||
|
||||
test("formats near-1km boundary as km not meters", () => {
|
||||
const node = renderTflAlert(makeItem({ closestStationDistance: 0.9999 }))
|
||||
const spec = render(node)
|
||||
|
||||
const root = spec.elements[spec.root]!
|
||||
const caption = spec.elements[root.children![2]!]!
|
||||
expect(caption.props.content).toBe("Nearest station: 1.0km away")
|
||||
})
|
||||
|
||||
test("omits station distance when null", () => {
|
||||
const node = renderTflAlert(makeItem({ closestStationDistance: null }))
|
||||
const spec = render(node)
|
||||
|
||||
const root = spec.elements[spec.root]!
|
||||
// Title + body only, no caption (empty fragment doesn't produce a child)
|
||||
const children = root.children!.filter((key) => {
|
||||
const el = spec.elements[key]
|
||||
return el && el.type !== "Fragment"
|
||||
})
|
||||
expect(children).toHaveLength(2)
|
||||
})
|
||||
|
||||
test("renders closure severity label", () => {
|
||||
const node = renderTflAlert(makeItem({ severity: "closure", lineName: "Central" }))
|
||||
const spec = render(node)
|
||||
|
||||
const root = spec.elements[spec.root]!
|
||||
const title = spec.elements[root.children![0]!]!
|
||||
expect(title.props.content).toBe("Central · Closed")
|
||||
})
|
||||
|
||||
test("renders major delays severity label", () => {
|
||||
const node = renderTflAlert(makeItem({ severity: "major-delays", lineName: "Jubilee" }))
|
||||
const spec = render(node)
|
||||
|
||||
const root = spec.elements[spec.root]!
|
||||
const title = spec.elements[root.children![0]!]!
|
||||
expect(title.props.content).toBe("Jubilee · Major delays")
|
||||
})
|
||||
})
|
||||
40
packages/aelis-source-tfl/src/renderer.tsx
Normal file
40
packages/aelis-source-tfl/src/renderer.tsx
Normal file
@@ -0,0 +1,40 @@
|
||||
/** @jsxImportSource @nym.sh/jrx */
|
||||
import type { FeedItemRenderer } from "@aelis/core"
|
||||
|
||||
import { FeedCard, SansSerifText } from "@aelis/components"
|
||||
|
||||
import type { TflAlertData } from "./types.ts"
|
||||
|
||||
import { TflAlertSeverity } from "./types.ts"
|
||||
|
||||
const SEVERITY_LABEL: Record<TflAlertSeverity, string> = {
|
||||
[TflAlertSeverity.Closure]: "Closed",
|
||||
[TflAlertSeverity.MajorDelays]: "Major delays",
|
||||
[TflAlertSeverity.MinorDelays]: "Minor delays",
|
||||
}
|
||||
|
||||
function formatDistance(km: number): string {
|
||||
const meters = Math.round(km * 1000)
|
||||
if (meters < 1000) {
|
||||
return `${meters}m away`
|
||||
}
|
||||
return `${(meters / 1000).toFixed(1)}km away`
|
||||
}
|
||||
|
||||
export const renderTflAlert: FeedItemRenderer<"tfl-alert", TflAlertData> = (item) => {
|
||||
const { lineName, severity, description, closestStationDistance } = item.data
|
||||
const severityLabel = SEVERITY_LABEL[severity]
|
||||
|
||||
return (
|
||||
<FeedCard>
|
||||
<SansSerifText content={`${lineName} · ${severityLabel}`} style="text-base font-semibold" />
|
||||
<SansSerifText content={description} style="text-sm" />
|
||||
{closestStationDistance !== null ? (
|
||||
<SansSerifText
|
||||
content={`Nearest station: ${formatDistance(closestStationDistance)}`}
|
||||
style="text-xs text-stone-500"
|
||||
/>
|
||||
) : null}
|
||||
</FeedCard>
|
||||
)
|
||||
}
|
||||
7
packages/aelis-source-tfl/tsconfig.json
Normal file
7
packages/aelis-source-tfl/tsconfig.json
Normal file
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"extends": "../../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"jsxImportSource": "@nym.sh/jrx"
|
||||
},
|
||||
"include": ["src"]
|
||||
}
|
||||
Reference in New Issue
Block a user