elite-dangerous-event-types¶
Audience: Agent
Purpose¶
Shared TypeScript types, type unions, and type guards for Elite Dangerous journal JSON lines (EliteEvent, EventType, …) and Status.json (Status, isStatus). Published as @howfe/elite-dangerous-event-types.
Tech stack¶
- TypeScript only (
index.tsat package root). package.jsonpointsmaintoindex.ts— consumers resolve via their bundler/tooling.
Integration points¶
@howfe/inter-frame-messenger— importsEliteEvent,Status,isEliteEvent,isStatusfor payload validation.- Quasar apps — import types and guards from map logic, composables, and components.
Extension points¶
- Add or adjust event variants in
index.tswhen Frontier adds journal events or fields you need. - Keep guards (
is*) in sync with structural assumptions; apps rely on them for safe narrowing. - Publishing: follow repository URL in
package.json(GitLab); version bumps affect downstream semver ranges.
Pitfalls / checks¶
- Large single file — search by symbol name; consider splitting only if the repo maintainers agree (out of scope for this doc).
- Breaking changes ripple to
inter-frame-messengerand both UIs — coordinate release order.
Related docs¶
- IPC.md — which payloads travel over
postMessage - ARCHITECTURE.md — shared typing principle