chishiki-cmi5

cmi5 AU (Assignable Unit) runtime client for Chishiki. Enables any HTML activity to communicate with a cmi5-compliant LMS: parse launch parameters, manage session lifecycle, and send spec-compliant xAPI statements.

Install

npm install chishiki-cmi5 chishiki

Usage

import { Cmi5 } from 'chishiki-cmi5';

// Auto-detect: real cmi5 launch or mock mode
const cmi5 = await Cmi5.initialize();

// Send allowed statements during the activity
await cmi5.sendAllowedStatement({
  verb: {
    id: 'http://adlnet.gov/expapi/verbs/answered',
    display: { 'en-US': 'answered' },
  },
  result: { success: true, score: { scaled: 1.0 } },
});

// Complete the session
if (cmi5.canSendResults()) {
  await cmi5.complete();
  await cmi5.pass({ score: { scaled: 0.92 } });
}
await cmi5.terminate();

License

MIT