@lxpack/tracking-schema

Canonical tracking event types for LXPack and adapters — shared between the browser runtime, xAPI reporters, and external tooling so track() payloads stay consistent.

Part of LXPack. Docs: Tracking and completion.

| Related | Package | |---------|---------| | Runtime track() | @lxpack/runtime | | xAPI transport | @lxpack/xapi |

Install

npm install @lxpack/tracking-schema

Requires Node.js 18 or 20 (18+) for the build toolchain. The package is dependency-free at runtime.

Usage

import {
  TRACK_EVENT_INTERACTION,
  TRACK_EVENT_SIMULATION,
  TRACK_EVENT_ASSESSMENT,
  TRACK_EVENT_XAPI_VERB,
  type TrackEventType,
} from "@lxpack/tracking-schema";

const eventType: TrackEventType = TRACK_EVENT_INTERACTION;
const verb = TRACK_EVENT_XAPI_VERB[eventType]; // "interacted"

Event types

| Constant | track({ type }) value | xAPI verb (via TRACK_EVENT_XAPI_VERB) | |----------|------------------------|----------------------------------------| | TRACK_EVENT_INTERACTION | interaction | interacted | | TRACK_EVENT_SIMULATION | simulation | interacted | | TRACK_EVENT_ASSESSMENT | assessment | answered |

Lesson navigation and completion are emitted by the runtime analytics layer, not through these track() types.

Development

From the monorepo root:

pnpm --filter @lxpack/tracking-schema build
pnpm --filter @lxpack/tracking-schema test
pnpm --filter @lxpack/tracking-schema typecheck

Links

• LXPack repository
• Documentation
• Changelog

License

Apache-2.0