@atomicjolt/lti-types/dist/src/index.js

LTI Typescript definitions.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.CANVAS_BETA_OIDC_URL = exports.CANVAS_BETA_AUTH_TOKEN_URL = exports.CANVAS_BETA_PUBLIC_JWKS_URL = exports.CANVAS_OIDC_URL = exports.CANVAS_AUTH_TOKEN_URL = exports.CANVAS_PUBLIC_JWKS_URL = exports.ALL_SCOPES = exports.LTI_PLATFORM_CONFIGURATION = exports.LTI_TOOL_CONFIGURATION = exports.ACCOUNT_CONTEXT = exports.COURSE_CONTEXT = exports.MENTOR_ROLE_SCOPE = exports.MENTOR_SCOPE = exports.LEARNER_SCOPE = exports.INSTRUCTOR_SCOPE = exports.STUDENT_SCOPE = exports.CALIPER_SCOPE = exports.NAMES_AND_ROLES_SCOPE = exports.AGS_SCOPE_SCORE = exports.AGS_SCOPE_RESULT = exports.AGS_SCOPE_LINE_ITEM_READONLY = exports.AGS_SCOPE_LINE_ITEM = exports.TOOL_USE_CALIPER_CONTEXT = exports.TOOL_LAUNCH_CALIPER_CONTEXT = exports.CALIPER_CLAIM = exports.NAMES_AND_ROLES_SERVICE_VERSIONS = exports.MIGRATION_CLAIM = exports.NAMES_AND_ROLES_CLAIM = exports.CONTENT_ITEM_CLAIM = exports.DEEP_LINKING_TOOL_LOG_CLAIM = exports.DEEP_LINKING_TOOL_MSG_CLAIM = exports.DEEP_LINKING_DATA_CLAIM = exports.DEEP_LINKING_CLAIM = exports.LTI1P1_CLAIM = exports.LTI11_LEGACY_USER_ID_CLAIM = exports.TARGET_LINK_URI_CLAIM = exports.LIS_CLAIM = exports.EXTENSION_CLAIM = exports.CUSTOM_CLAIM = exports.ROLES_CLAIM = exports.MENTOR_CLAIM = exports.BASIC_OUTCOME_CLAIM = exports.AGS_CLAIM = exports.TOOL_PLATFORM_CLAIM = exports.RESOURCE_LINK_CLAIM = exports.CONTEXT_CLAIM = exports.MESSAGE_TYPE = exports.DEPLOYMENT_ID = exports.LAUNCH_PRESENTATION = exports.LTI_VERSION = void 0;
exports.MemberStatus = exports.AGSScopes = exports.Roles = exports.MessageTypes = exports.AcceptTypes = exports.DocumentTargets = exports.LtiVersions = exports.CANVAS_PLACEMENT_COURSE_NAVIGATION_ENABLED = exports.CANVAS_PLACEMENT_VISIBILITY = exports.CANVAS_PRIVACY_LEVEL = exports.CANVAS_SUBMISSION_TYPE = void 0;
exports.LTI_VERSION = "https://purl.imsglobal.org/spec/lti/claim/version";
exports.LAUNCH_PRESENTATION = "https://purl.imsglobal.org/spec/lti/claim/launch_presentation";
exports.DEPLOYMENT_ID = "https://purl.imsglobal.org/spec/lti/claim/deployment_id";
exports.MESSAGE_TYPE = "https://purl.imsglobal.org/spec/lti/claim/message_type";
// Claims
exports.CONTEXT_CLAIM = "https://purl.imsglobal.org/spec/lti/claim/context";
exports.RESOURCE_LINK_CLAIM = "https://purl.imsglobal.org/spec/lti/claim/resource_link";
exports.TOOL_PLATFORM_CLAIM = "https://purl.imsglobal.org/spec/lti/claim/tool_platform";
exports.AGS_CLAIM = "https://purl.imsglobal.org/spec/lti-ags/claim/endpoint";
exports.BASIC_OUTCOME_CLAIM = "https://purl.imsglobal.org/spec/lti-bo/claim/basicoutcome";
exports.MENTOR_CLAIM = "https://purl.imsglobal.org/spec/lti/claim/role_scope_mentor";
exports.ROLES_CLAIM = "https://purl.imsglobal.org/spec/lti/claim/roles";
exports.CUSTOM_CLAIM = "https://purl.imsglobal.org/spec/lti/claim/custom";
exports.EXTENSION_CLAIM = "http://www.ExamplePlatformVendor.com/session";
exports.LIS_CLAIM = "https://purl.imsglobal.org/spec/lti/claim/lis";
exports.TARGET_LINK_URI_CLAIM = "https://purl.imsglobal.org/spec/lti/claim/target_link_uri";
exports.LTI11_LEGACY_USER_ID_CLAIM = "https://purl.imsglobal.org/spec/lti/claim/lti11_legacy_user_id";
exports.LTI1P1_CLAIM = "https://purl.imsglobal.org/spec/lti/claim/lti1p1";
exports.DEEP_LINKING_CLAIM = "https://purl.imsglobal.org/spec/lti-dl/claim/deep_linking_settings";
exports.DEEP_LINKING_DATA_CLAIM = "https://purl.imsglobal.org/spec/lti-dl/claim/data";
exports.DEEP_LINKING_TOOL_MSG_CLAIM = "https://purl.imsglobal.org/spec/lti-dl/claim/msg";
exports.DEEP_LINKING_TOOL_LOG_CLAIM = "https://purl.imsglobal.org/spec/lti-dl/claim/log";
exports.CONTENT_ITEM_CLAIM = "https://purl.imsglobal.org/spec/lti-dl/claim/content_items";
exports.NAMES_AND_ROLES_CLAIM = "https://purl.imsglobal.org/spec/lti-nrps/claim/namesroleservice";
exports.MIGRATION_CLAIM = "https://purl.imsglobal.org/spec/lti/claim/lti1p1";
exports.NAMES_AND_ROLES_SERVICE_VERSIONS = ["2.0"];
exports.CALIPER_CLAIM = "https://purl.imsglobal.org/spec/lti-ces/claim/caliper-endpoint-service";
exports.TOOL_LAUNCH_CALIPER_CONTEXT = "http://purl.imsglobal.org/ctx/caliper/v1p1/ToolLaunchProfile-extension";
exports.TOOL_USE_CALIPER_CONTEXT = "http://purl.imsglobal.org/ctx/caliper/v1p1";
// Scopes
exports.AGS_SCOPE_LINE_ITEM = "https://purl.imsglobal.org/spec/lti-ags/scope/lineitem";
exports.AGS_SCOPE_LINE_ITEM_READONLY = "https://purl.imsglobal.org/spec/lti-ags/scope/lineitem.readonly";
exports.AGS_SCOPE_RESULT = "https://purl.imsglobal.org/spec/lti-ags/scope/result.readonly";
exports.AGS_SCOPE_SCORE = "https://purl.imsglobal.org/spec/lti-ags/scope/score";
exports.NAMES_AND_ROLES_SCOPE = "https://purl.imsglobal.org/spec/lti-nrps/scope/contextmembership.readonly";
exports.CALIPER_SCOPE = "https://purl.imsglobal.org/spec/lti-ces/v1p0/scope/send";
exports.STUDENT_SCOPE = "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Student";
exports.INSTRUCTOR_SCOPE = "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Instructor";
exports.LEARNER_SCOPE = "http://purl.imsglobal.org/vocab/lis/v2/membership#Learner";
exports.MENTOR_SCOPE = "http://purl.imsglobal.org/vocab/lis/v2/membership#Mentor";
exports.MENTOR_ROLE_SCOPE = "a62c52c02ba262003f5e";
// Launch contexts
exports.COURSE_CONTEXT = "http://purl.imsglobal.org/vocab/lis/v2/course#CourseOffering";
exports.ACCOUNT_CONTEXT = "Account";
// Configuration
exports.LTI_TOOL_CONFIGURATION = "https://purl.imsglobal.org/spec/lti-tool-configuration";
exports.LTI_PLATFORM_CONFIGURATION = "https://purl.imsglobal.org/spec/lti-platform-configuration";
// Specfies all available scopes.
exports.ALL_SCOPES = [
    exports.AGS_SCOPE_LINE_ITEM,
    exports.AGS_SCOPE_LINE_ITEM_READONLY,
    exports.AGS_SCOPE_RESULT,
    exports.AGS_SCOPE_SCORE,
    exports.NAMES_AND_ROLES_SCOPE,
];
// Canvas specific
exports.CANVAS_PUBLIC_JWKS_URL = "https://sso.canvaslms.com/api/lti/security/jwks";
exports.CANVAS_AUTH_TOKEN_URL = "https://canvas.instructure.com/login/oauth2/token";
exports.CANVAS_OIDC_URL = "https://sso.canvaslms.com/api/lti/authorize_redirect";
exports.CANVAS_BETA_PUBLIC_JWKS_URL = "https://sso.beta.canvaslms.com/api/lti/security/jwks";
exports.CANVAS_BETA_AUTH_TOKEN_URL = "https://sso.beta.canvaslms.com/login/oauth2/token";
exports.CANVAS_BETA_OIDC_URL = "https://sso.beta.canvaslms.com/api/lti/authorize_redirect";
exports.CANVAS_SUBMISSION_TYPE = "https://canvas.instructure.com/lti/submission_type";
exports.CANVAS_PRIVACY_LEVEL = "https://canvas.instructure.com/lti/privacy_level";
exports.CANVAS_PLACEMENT_VISIBILITY = "https://canvas.instructure.com/lti/visibility";
exports.CANVAS_PLACEMENT_COURSE_NAVIGATION_ENABLED = "https://canvas.instructure.com/lti/course_navigation/default_enabled";
var LtiVersions;
(function (LtiVersions) {
    LtiVersions["v1_3_0"] = "1.3.0";
})(LtiVersions || (exports.LtiVersions = LtiVersions = {}));
var DocumentTargets;
(function (DocumentTargets) {
    DocumentTargets["iframe"] = "iframe";
    DocumentTargets["window"] = "window";
    DocumentTargets["embed"] = "embed";
})(DocumentTargets || (exports.DocumentTargets = DocumentTargets = {}));
var AcceptTypes;
(function (AcceptTypes) {
    AcceptTypes["link"] = "link";
    AcceptTypes["file"] = "file";
    AcceptTypes["html"] = "html";
    AcceptTypes["ltiResourceLink"] = "ltiResourceLink";
    AcceptTypes["image"] = "image";
})(AcceptTypes || (exports.AcceptTypes = AcceptTypes = {}));
var MessageTypes;
(function (MessageTypes) {
    MessageTypes["LtiResourceLinkRequest"] = "LtiResourceLinkRequest";
    MessageTypes["LtiDeepLinkingRequest"] = "LtiDeepLinkingRequest";
    MessageTypes["LtiDeepLinkingResponse"] = "LtiDeepLinkingResponse";
})(MessageTypes || (exports.MessageTypes = MessageTypes = {}));
// Below are all the roles specified in the LTI 1.3 spec. (https://www.imsglobal.org/spec/lti/v1p3#role-vocabularies-0)
// https://www.imsglobal.org/spec/lti/v1p3#roles-claim
var Roles;
(function (Roles) {
    // Core system roles
    Roles["AdministratorSystemRole"] = "http://purl.imsglobal.org/vocab/lis/v2/system/person#Administrator";
    Roles["NoneSystemRole"] = "http://purl.imsglobal.org/vocab/lis/v2/system/person#None";
    // Non‑core system roles
    Roles["AccountAdminSystemRole"] = "http://purl.imsglobal.org/vocab/lis/v2/system/person#AccountAdmin";
    Roles["CreatorSystemRole"] = "http://purl.imsglobal.org/vocab/lis/v2/system/person#Creator";
    Roles["SysAdminSystemRole"] = "http://purl.imsglobal.org/vocab/lis/v2/system/person#SysAdmin";
    Roles["SysSupportSystemRole"] = "http://purl.imsglobal.org/vocab/lis/v2/system/person#SysSupport";
    Roles["UserSystemRole"] = "http://purl.imsglobal.org/vocab/lis/v2/system/person#User";
    // Core institution roles
    Roles["AdministratorInstitutionRole"] = "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Administrator";
    Roles["FacultyInstitutionRole"] = "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Faculty";
    Roles["GuestInstitutionRole"] = "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Guest";
    Roles["NoneInstitutionRole"] = "http://purl.imsglobal.org/vocab/lis/v2/institution/person#None";
    Roles["OtherInstitutionRole"] = "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Other";
    Roles["StaffInstitutionRole"] = "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Staff";
    Roles["StudentInstitutionRole"] = "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Student";
    // Non‑core institution roles
    Roles["AlumniInstitutionRole"] = "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Alumni";
    Roles["InstructorInstitutionRole"] = "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Instructor";
    Roles["LearnerInstitutionRole"] = "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Learner";
    Roles["MemberInstitutionRole"] = "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Member";
    Roles["MentorInstitutionRole"] = "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Mentor";
    Roles["ObserverInstitutionRole"] = "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Observer";
    Roles["ProspectiveStudentInstitutionRole"] = "http://purl.imsglobal.org/vocab/lis/v2/institution/person#ProspectiveStudent";
    // Core context roles
    Roles["AdministratorContextRole"] = "http://purl.imsglobal.org/vocab/lis/v2/membership#Administrator";
    Roles["ContentDeveloperContextRole"] = "http://purl.imsglobal.org/vocab/lis/v2/membership#ContentDeveloper";
    Roles["InstructorContextRole"] = "http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor";
    Roles["LearnerContextRole"] = "http://purl.imsglobal.org/vocab/lis/v2/membership#Learner";
    Roles["MentorContextRole"] = "http://purl.imsglobal.org/vocab/lis/v2/membership#Mentor";
    // Non‑core context roles
    Roles["ManagerContextRole"] = "http://purl.imsglobal.org/vocab/lis/v2/membership#Manager";
    Roles["MemberContextRole"] = "http://purl.imsglobal.org/vocab/lis/v2/membership#Member";
    Roles["OfficerContextRole"] = "http://purl.imsglobal.org/vocab/lis/v2/membership#Officer";
})(Roles || (exports.Roles = Roles = {}));
var AGSScopes;
(function (AGSScopes) {
    AGSScopes["lineItem"] = "https://purl.imsglobal.org/spec/lti-ags/scope/lineitem";
    AGSScopes["resultReadOnly"] = "https://purl.imsglobal.org/spec/lti-ags/scope/result.readonly";
    AGSScopes["score"] = "https://purl.imsglobal.org/spec/lti-ags/scope/score";
    AGSScopes["lineItemReadOnly"] = "https://purl.imsglobal.org/spec/lti-ags/scope/lineitem.readonly";
})(AGSScopes || (exports.AGSScopes = AGSScopes = {}));
var MemberStatus;
(function (MemberStatus) {
    MemberStatus["Active"] = "Active";
    MemberStatus["Inactive"] = "Inactive";
    MemberStatus["Deleted"] = "Deleted";
})(MemberStatus || (exports.MemberStatus = MemberStatus = {}));
//# sourceMappingURL=index.js.map