Skip to main content

Interface: CourseMetadata

Defined in: types.ts:16

Properties​

courseId​

readonly courseId: string

Defined in: types.ts:18

Globally unique ID for the course. Used as the manifest identifier. Kebab-case ASCII recommended.

description?​

readonly optional description?: string

Defined in: types.ts:22

Short description. May be multi-paragraph; kept under 2000 chars for LMS compat.

entryLessonId?​

readonly optional entryLessonId?: string

Defined in: types.ts:51

Identifier of the lesson that is the SCO entry point in single-SCO mode. Must match a Lesson.id. When omitted in single-SCO mode, defaults to the first lesson. Ignored in multi-SCO mode.

estimatedMinutes?​

readonly optional estimatedMinutes?: number

Defined in: types.ts:34

Estimated duration in minutes.

language​

readonly language: string

Defined in: types.ts:26

ISO 639-1 language code (e.g. "en", "de").

masteryScore?​

readonly optional masteryScore?: number

Defined in: types.ts:32

Deprecated​

Course-level mastery is no longer auto-applied per item. Set Lesson.masteryScore per lesson instead. Retained for backwards compatibility (e.g. SCORM 2004 packagers may still consume it).

objectives?​

readonly optional objectives?: readonly string[]

Defined in: types.ts:30

Learning objectives, free-form.

organization?​

readonly optional organization?: Organization

Defined in: types.ts:28

Organization publishing the course.

singleSco?​

readonly optional singleSco?: boolean

Defined in: types.ts:44

When true, only the entry lesson is declared as a SCO; all other lesson HTMLs become <file> entries of that single SCO. Pairs with SPA-style internal navigation (e.g., Astro View Transitions) so the whole course runs in one SCORM session — LMSInitialize and LMSFinish each fire exactly once.

When false/undefined (default), each lesson is its own SCO.

title​

readonly title: string

Defined in: types.ts:20

Human-readable course title. Shown in the LMS catalog.

version​

readonly version: string

Defined in: types.ts:24

Semantic version of the course. Bumping this signals re-publish.