Skip to content

New: new v1 schemas files added to repo (fixes #144) #145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

New: new v1 schemas files added to repo (fixes #144) #145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
04b10bf
New: new schema files added to repo
joe-allen-89 Aug 14, 2025
6114ef2
add title for globals, correct enum
joe-allen-89 Aug 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
212 changes: 212 additions & 0 deletions schema/config.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,212 @@
{
"$anchor": "extension-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"$patch": {
"source": {
"$ref": "config"
},
"with": {
"properties": {
"_xapi": {
"type": "object",
"title": "xAPI",
"default": {},
"properties": {
"_isEnabled": {
"type": "boolean",
"title": "Is Enabled",
"description": "Indicates whether this course should send statements to a configured Learning Record Store (LRS).",
"default": true
},
"_specification": {
"type": "string",
"title": "Specification",
"description": "Indicates whether the plugin should use standard xAPI or cmi5 profile.",
"default": "xAPI",
"enum": [
"xAPI",
"cmi5"
],
"_backboneForms": "Select"
},
"_activityID": {
"type": "string",
"title": "Activity ID",
"description": "Unique identifier for this xAPI activity, i.e. usually the URL to the course.",
"default": ""
},
"_auID": {
"type": "string",
"title": "Assignable Unit (AU) ID",
"description": "Unique identifier for this assignable unit.",
"default": "1"
},
"_endpoint": {
"type": "string",
"title": "Endpoint",
"description": "The Learning Record Store (LRS) URL where xAPI statements will be sent to.",
"default": ""
},
"_user": {
"type": "string",
"title": "User (or Key)",
"description": "The 'user' or 'key' as defined in your Learning Record Store (LRS).",
"default": ""
},
"_password": {
"type": "string",
"title": "Password (or Secret)",
"description": "The 'password' or 'secret' as defined in your Learning Record Store (LRS).",
"default": ""
},
"_lang": {
"type": "string",
"title": "Verb language",
"description": "Select the language for verbs to be sent to the LRS.",
"default": "en-US",
"enum": [
"de-DE",
"en-US",
"fr-FR",
"es-ES"
],
"_backboneForms": "Select"
},
"_generateIds": {
"type": "boolean",
"title": "Auto-generate ID for statements",
"description": "When enabled, this will append an auto-generated 'id' value for all xAPI statements. NOTE: It is recommended this is left off so that the LRS will generate the IDs.",
"default": false
},
"_shouldTrackState": {
"type": "boolean",
"title": "Track state",
"description": "When enabled, the associated LRS be used to track state via the State API.",
"default": true
},
"_shouldUseRegistration": {
"type": "boolean",
"title": "Use registration",
"description": "When enabled, the registration will be used as part of get/set calls to the State API.",
"default": true
},
"_componentBlacklist": {
"type": "string",
"title": "Component blacklist",
"description": "Comma separated list of components which will not send statements.",
"default": "blank,graphic"
},
"_coreEvents": {
"type": "object",
"title": "Core Events",
"default": {},
"properties": {
"Adapt": {
"type": "object",
"title": "Adapt",
"default": {},
"properties": {
"router:menu": {
"type": "boolean",
"title": "router:menu",
"description": "Triggered when a menu item is displayed.",
"default": false
},
"router:page": {
"type": "boolean",
"title": "router:page",
"description": "Triggered when a page is displayed.",
"default": false
},
"questionView:recordInteraction": {
"type": "boolean",
"title": "questionView:recordInteraction",
"description": "Triggered when a user interacts with a question component.",
"default": true
},
"assessments:complete": {
"type": "boolean",
"title": "assessments:complete",
"description": "Triggered when an individual assessment is completed.",
"default": true
}
}
},
"contentObjects": {
"type": "object",
"title": "contentObjects",
"default": {},
"properties": {
"change:_isComplete": {
"type": "boolean",
"title": "change:_isComplete",
"description": "Triggered when a contentobject, i.e. a page or menu item, is completed.",
"default": false
}
}
},
"articles": {
"type": "object",
"title": "articles",
"default": {},
"properties": {
"change:_isComplete": {
"type": "boolean",
"title": "change:_isComplete",
"description": "Triggered when an article is completed.",
"default": false
}
}
},
"blocks": {
"type": "object",
"title": "blocks",
"default": {},
"properties": {
"change:_isComplete": {
"type": "boolean",
"title": "change:_isComplete",
"description": "Triggered when a block is completed.",
"default": false
}
}
},
"components": {
"type": "object",
"title": "components",
"default": {},
"properties": {
"change:_isComplete": {
"type": "boolean",
"title": "change:_isComplete",
"description": "Triggered when a component is completed.",
"default": true
}
}
}
}
},
"_lrsFailureBehaviour": {
"type": "string",
"title": "LRS connection failure behaviour",
"description": "Determines how the plugin should behave whenever it fails to successfully connect or send statements to the configured LRS",
"default": "show",
"enum": [
"ignore",
"show"
],
"_backboneForms": "Select"
},
"_retryConnectionAttempts": {
"type": "number",
"title": "How many attempts should be made to reestablish an LRS connection if disconnected?",
"description": "Indicates how many attempts this course should make to retry initialization or sending state/statements to a configured Learning Record Store (LRS) after a failure.",
"default": 0
}
}
}
}
}
}
}
56 changes: 56 additions & 0 deletions schema/course.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
{
"$anchor": "extension-course",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"$patch": {
"source": {
"$ref": "course"
},
"with": {
"properties": {
"_globals": {
"type": "object",
"default": {},
"properties": {
"_extension": {
"type": "object",
"default": {},
"properties": {
"_xapi": {
"type": "object",
"title": "xAPI",
"properties": {
"confirm": {
"type": "string",
"title": "Confirm",
"default": "OK",
"_adapt": {
"translatable": true
}
},
"lrsConnectionErrorTitle": {
"type": "string",
"title": "LRS connection error title",
"default": "LRS not available",
"_adapt": {
"translatable": true
}
},
"lrsConnectionErrorMessage": {
"type": "string",
"title": "LRS connection error message",
"default": "We were unable to connect to your Learning Record Store (LRS). This means that your progress cannot be recorded.",
"_adapt": {
"translatable": true
}
}
}
}
}
}
}
}
}
}
}
}
Loading