Export parity (React / Vite vs LMS)

LessonKit 1.7.x extends the 0.9.x conformance harness with Vitest CLI integration tests and Playwright launch coverage for SCORM 2004, xAPI, and cmi5. Last verified against release 1.7.4.

Surfaces

Surface

What it is

How we test

Vite preview

npm run dev / vite preview on your React app

Playwright golden-vite project on examples/lxpack-golden

Telemetry harness

Minimal React app for batch/xAPI behavior

Playwright telemetry-harness project on e2e/fixtures/telemetry-harness

Standalone

LXPack standalone output (shell + SPA iframe)

Static server + Playwright

SCORM 1.2

ZIP for LMS upload

Unzip + launch HTML with injected SCORM 1.2 API mock

SCORM 2004

ZIP for LMS upload

Unzip + launch SCO with injected API_1484_11 mock

xAPI / cmi5

ZIP for LRS / cmi5 hosts

Unzip + static server on package index.html

Conformance matrix

Surface

Playwright / script

Guarantee

Vite (golden)

tests/vite/keyboard.spec.ts

Quiz and knowledge check reachable by keyboard; lesson nav activatable

Vite (golden)

tests/vite/telemetry.spec.ts

Session id persisted; quiz completion feedback

Vite (golden)

tests/vite/smoke.spec.ts

Sign-off assessments complete

Vite (harness)

tests/telemetry-harness/batching.spec.ts

batchSink receives coalesced events after manual flush

Vite (harness)

tests/telemetry-harness/xapi-queue.spec.ts

Failed transport queues statements; flush delivers after mode ok

Standalone

tests/standalone/launch.spec.ts, tests/parity/matrix.spec.ts

Native assessment shell completes

SCORM 1.2

tests/scorm12/launch.spec.ts, tests/parity/matrix.spec.ts

LMS API mock receives status/score updates

SCORM 2004

tests/scorm2004/launch.spec.ts

API_1484_11 mock receives completion/score updates

xAPI

tests/xapi/launch.spec.ts

Packaged shell completes native assessments

cmi5

tests/cmi5/launch.spec.ts

Packaged shell completes native assessments

CLI pipeline

npm run test:integration

Real init / build / package without mocks

Manifest ↔ React IDs

integration/test/showcase-parity.test.ts

courseId and checkId in lessonkit.json appear in example src/

Package-time ID guard

lessonkit package

validateReactManifestParity fails when React source omits manifest IDs

All LMS packages

npm run conformance:lxpack

@lxpack/conformance validate + build (standalone, scorm12, scorm2004, xapi, cmi5)

Golden artifacts

npm run conformance:golden

examples/lxpack-golden produces standalone dir + scorm12 zip

What is guaranteed (1.7.x)

For the reference course (examples/lxpack-golden):

  • Sign-off step loads in the SPA on Vite, standalone, and SCORM 1.2 surfaces.

  • Quiz safety-check accepts the correct answer and shows success feedback.

  • Knowledge check ppe-acknowledgment accepts the confirm choice.

  • SCORM 1.2: LMS API mock receives status/score SetValue calls after interaction (see e2e/support/scorm/).

  • SCORM 2004: API_1484_11 mock receives completion or score updates after interaction.

  • xAPI / cmi5: Packaged launch HTML loads and sign-off assessments complete (same shell model as standalone).

For the telemetry harness (e2e/fixtures/telemetry-harness):

  • Telemetry batching delivers multiple events in one batchSink call when flushed.

  • xAPI statements queue when transport fails and flush after transport succeeds.

What is not guaranteed yet

  • Bit-identical DOM or CSS across surfaces (themes should match via interchange runtime, but layout is shell-specific).

  • Multi-lesson per-lesson-spa CLI packaging (use @lessonkit/lxpack directly).

SCORM 1.2 artifact layout

After lessonkit package --target scorm12:

.lxpack/course/.lxpack/out/course-scorm12.zip
  imsmanifest.xml          # first <resource href="..."> is the launch file
  <launch>.html            # LXPack shell; hosts SPA in <iframe>
  dist/                    # Vite build (single-spa)
  ...

E2E resolves the launch file from imsmanifest.xml, injects window.API, then drives assessments in the LXPack shell.

Run locally

npm ci
npm exec -w @lessonkit/e2e -- playwright install --with-deps chromium
npm run test:integration
npm run test:e2e
npm run conformance:lxpack
npm run conformance:golden

See e2e/README for the test catalog, artifact layout, and debugging.

CI job map

GitHub Actions job

Node

Commands (equivalent)

Checks (matrix)

18, 20

npm run build, typecheck, test, coverage

Docs (Sphinx)

20

build-docs-demos.sh, sphinx-build -W

Integration

20

build:packages, CLI build, npm run test:integration

Packaging smoke

20

golden package:scorm12 / standalone, conformance:lxpack, conformance:golden

E2E (Playwright)

20

playwright install, npm run test:e2e

Security (npm audit)

20

npm run audit:ci

Workflow: .github/workflows/checks.yml