Glossary

Terms you will see across LessonKit docs, npm packages, and LMS export tooling.

LessonKit

The React-first framework and CLI for authoring courses and exporting LMS packages. npm scope: @lessonkit/*.

lessonkit (CLI)

The command-line tool from @lessonkit/cli: lessonkit init, dev, build, package. In scaffolded projects, prefer npm run dev / npm run build (they call the local CLI in node_modules).

lessonkit.json

Project manifest (schemaVersion: 1) at the repo root. Describes the course for packaging (IDs, assessments, theme, paths). React props for courseId, lessonId, and checkId must stay in sync with this file.

LessonkitProvider

React context provider that powers telemetry, xAPI, progress, and plugins. Course wraps LessonkitProvider for you—pass config on Course unless you build a custom tree with LessonkitProvider directly.

LXPack

External packaging engine used by @lessonkit/lxpack and the CLI. Produces SCORM, standalone, xAPI, and cmi5 artifacts. You rarely import @lxpack/api directly when using lessonkit package.

lxpackBridge

Browser bridge (window.parent.lxpackBridge.v1) used when a packaged course runs inside an LXPack-hosted iframe. @lessonkit/react can forward completion events automatically when config.lxpack.bridge is enabled.

.lxpack/

Working directories created during packaging (descriptor staging, output zips). Default output base: .lxpack/out/ (see section Package for your LMS in Getting started in 5 minutes).

single-spa

course.layout value in lessonkit.json for one Vite SPA that contains the full course UI. Required for standard lessonkit package workflows in 1.x.

courseId, lessonId, checkId

Stable identifiers for telemetry, xAPI URNs, and LMS descriptors. Required on Course, Lesson, and assessment blocks. See Identity reference.

Block catalog

Machine-readable list of block types and props. buildBlockCatalog() defaults to catalog v3 in framework 1.2. JSON files are named block-catalog.v1.json … v3.json on @lessonkit/react—the filename is the schema generation, not necessarily the default you pass at runtime.

LessonKit Studio

Visual editor (Alpha) for StudioProjectV1 JSON. npm packages use studio-v* release tags, separate from framework v* tags. Try the live app without cloning the monorepo.

StudioProjectV1

Versioned JSON project format edited in Studio and exported via @lessonkit/studio-codegen.