@openstax/ts-utils 1.38.0-beta → 1.38.0

package/dist/cjs/services/lrsGateway/attempt-utils.d.ts

@@ -14,16 +14,21 @@ export type ActivityState = {
     mostRecentWithCompleted?: AttemptEntry;
 };
 export declare const matchAttempt: (statement: UXapiStatement) => boolean;
-export declare const matchAttemptCompleted: (attempt: UXapiStatement) => (statement: UXapiStatement) => boolean;
-export declare const matchAttemptScored: (attempt: UXapiStatement) => (statement: UXapiStatement) => boolean;
+export declare const matchAttemptCompleted: (attempt: UXapiStatement) => (statement: UXapiStatement) => boolean | "";
+export declare const matchAttemptScored: (attempt: UXapiStatement) => (statement: UXapiStatement) => boolean | "";
 export declare const resolveAttempts: (statements: UXapiStatement[], options?: {
     activityIRI?: string;
     parentActivityAttempt?: string;
 }) => UXapiStatement[];
 export declare const resolveCompletedForAttempt: (statements: UXapiStatement[], attempt: UXapiStatement, activityIRI?: string) => UXapiStatement | undefined;
 export declare const resolveScoredForAttempt: (statements: UXapiStatement[], attempt: UXapiStatement, activityIRI?: string) => UXapiStatement | undefined;
-export declare const oldestStatement: (statements: UXapiStatement[]) => UXapiStatement | undefined;
-export declare const mostRecentStatement: (statements: UXapiStatement[]) => UXapiStatement | undefined;
+export declare const getStatementTimeString: (statement: UXapiStatement) => string;
+export declare const getStatementTime: (statement: UXapiStatement) => Date;
+export declare const oldestStatement: (items: UXapiStatement[]) => UXapiStatement | undefined;
+export declare const mostRecentStatement: (items: UXapiStatement[]) => UXapiStatement | undefined;
+export declare const oldestEntry: (items: AttemptEntry[]) => AttemptEntry | undefined;
+export declare const mostRecentEntry: (items: AttemptEntry[]) => AttemptEntry | undefined;
+export declare const bestEntry: (items: AttemptEntry[]) => AttemptEntry | undefined;
 export declare const resolveAttemptInfo: (statements: UXapiStatement[], options?: {
     activityIRI?: string;
     currentAttempt?: string;

package/dist/cjs/services/lrsGateway/attempt-utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.putScoredStatement = exports.createScoredStatement = exports.putCompletedPendingScoringStatement = exports.createCompletedPendingScoringStatement = exports.putCompletedStatement = exports.createCompletedStatement = exports.putAttemptActivityStatement = exports.createAttemptActivityStatement = exports.putAttemptStatement = exports.createAttemptStatement = exports.createStatement = exports.loadActivityAttemptInfo = exports.loadStatementsForActivityAndFirstChildren = exports.resolveAttemptInfo = exports.mostRecentStatement = exports.oldestStatement = exports.resolveScoredForAttempt = exports.resolveCompletedForAttempt = exports.resolveAttempts = exports.matchAttemptScored = exports.matchAttemptCompleted = exports.matchAttempt = exports.EXT_PENDING_SCORING = void 0;
+exports.putScoredStatement = exports.createScoredStatement = exports.putCompletedPendingScoringStatement = exports.createCompletedPendingScoringStatement = exports.putCompletedStatement = exports.createCompletedStatement = exports.putAttemptActivityStatement = exports.createAttemptActivityStatement = exports.putAttemptStatement = exports.createAttemptStatement = exports.createStatement = exports.loadActivityAttemptInfo = exports.loadStatementsForActivityAndFirstChildren = exports.resolveAttemptInfo = exports.bestEntry = exports.mostRecentEntry = exports.oldestEntry = exports.mostRecentStatement = exports.oldestStatement = exports.getStatementTime = exports.getStatementTimeString = exports.resolveScoredForAttempt = exports.resolveCompletedForAttempt = exports.resolveAttempts = exports.matchAttemptScored = exports.matchAttemptCompleted = exports.matchAttempt = exports.EXT_PENDING_SCORING = void 0;
 /*
  * the structure of xapi statements for handling multiple attempts of an activity
  * including the option of a parent activity/attempt such that a new attempt
@@ -28,7 +28,7 @@ const matchAttempt = (statement) => statement.verb.id === Verb.Attempted;
 exports.matchAttempt = matchAttempt;
 const matchAttemptCompleted = (attempt) => (statement) => {
     var _a, _b;
-    return statement.verb.id === Verb.Completed
+    return statement.verb.id === Verb.Completed && attempt.id
         && statement.context !== undefined
         && ((_a = statement.context.statement) === null || _a === void 0 ? void 0 : _a.id) === attempt.id
         && statement.context.registration === ((_b = attempt.context) === null || _b === void 0 ? void 0 : _b.registration);
@@ -36,7 +36,7 @@ const matchAttemptCompleted = (attempt) => (statement) => {
 exports.matchAttemptCompleted = matchAttemptCompleted;
 const matchAttemptScored = (attempt) => (statement) => {
     var _a, _b;
-    return statement.verb.id === Verb.Scored
+    return statement.verb.id === Verb.Scored && attempt.id
         && statement.context !== undefined
         && ((_a = statement.context.statement) === null || _a === void 0 ? void 0 : _a.id) === attempt.id
         && statement.context.registration === ((_b = attempt.context) === null || _b === void 0 ? void 0 : _b.registration);
@@ -53,104 +53,89 @@ const resolveCompletedForAttempt = (statements, attempt, activityIRI) => stateme
     && (!activityIRI || statement.object.id === activityIRI));
 exports.resolveCompletedForAttempt = resolveCompletedForAttempt;
 const resolveScoredForAttempt = (statements, attempt, activityIRI) => {
-    // Prefer the most recent Scored
-    const scored = (0, exports.mostRecentStatement)(statements.filter(s => (0, exports.matchAttemptScored)(attempt)(s) && (!activityIRI || s.object.id === activityIRI)));
-    if (scored)
-        return scored;
-    // if no scored found, return most recent Completed with a score for the attempt.
-    const completedWithScore = (0, exports.mostRecentStatement)(statements.filter(s => (0, exports.matchAttemptCompleted)(attempt)(s) &&
-        (!activityIRI || s.object.id === activityIRI) && s.result &&
-        s.result.score &&
-        (s.result.score.scaled !== undefined)));
-    return completedWithScore;
+    // scored or completed statements that contain a score in their
+    // result are 'scoring statements' for our purposes.
+    const scoringStatements = statements.filter(s => {
+        var _a;
+        return ((0, exports.matchAttemptScored)(attempt)(s) || (0, exports.matchAttemptCompleted)(attempt)(s))
+            && ((_a = s.result) === null || _a === void 0 ? void 0 : _a.score)
+            && (!activityIRI || s.object.id === activityIRI);
+    });
+    return (0, exports.mostRecentStatement)(scoringStatements);
 };
 exports.resolveScoredForAttempt = resolveScoredForAttempt;
-const oldestStatement = (statements) => statements.reduce((result, statement) => result && (0, isBefore_1.default)((0, parseISO_1.default)('stored' in result && result.stored ? result.stored : result.timestamp), (0, parseISO_1.default)(statement.timestamp)) ? result : statement, statements[0]);
-exports.oldestStatement = oldestStatement;
-const mostRecentStatement = (statements) => statements.reduce((result, statement) => result && (0, isAfter_1.default)((0, parseISO_1.default)('stored' in result && result.stored ? result.stored : result.timestamp), (0, parseISO_1.default)(statement.timestamp)) ? result : statement, statements[0]);
-exports.mostRecentStatement = mostRecentStatement;
+const resolveAttemptEntries = (statements, attempts, activityIRI) => attempts.reduce((acc, attempt) => {
+    const completed = (0, exports.resolveCompletedForAttempt)(statements, attempt, activityIRI);
+    const scored = (0, exports.resolveScoredForAttempt)(statements, attempt, activityIRI);
+    acc.push({ attempt, completed, scored });
+    return acc;
+}, []);
+const getStatementTimeString = (statement) => 'stored' in statement && statement.stored ? statement.stored : statement.timestamp;
+exports.getStatementTimeString = getStatementTimeString;
+const getStatementTime = (statement) => (0, parseISO_1.default)((0, exports.getStatementTimeString)(statement));
+exports.getStatementTime = getStatementTime;
+const findByComparator = (comparator, extractor) => (items) => {
+    return items.reduce((best, item) => {
+        if (!best)
+            return item;
+        return comparator(extractor(best), extractor(item)) ? best : item;
+    }, undefined);
+};
+exports.oldestStatement = findByComparator(isBefore_1.default, exports.getStatementTime);
+exports.mostRecentStatement = findByComparator(isAfter_1.default, exports.getStatementTime);
+exports.oldestEntry = findByComparator(isBefore_1.default, (entry) => (0, exports.getStatementTime)(entry.attempt));
+exports.mostRecentEntry = findByComparator(isAfter_1.default, (entry) => (0, exports.getStatementTime)(entry.attempt));
+const scaledScoreForEntry = (entry) => {
+    var _a;
+    const scoringStatement = entry.scored;
+    const score = (_a = scoringStatement === null || scoringStatement === void 0 ? void 0 : scoringStatement.result) === null || _a === void 0 ? void 0 : _a.score;
+    if (!score)
+        return { score: undefined, entry };
+    // Prefer scaled, otherwise normalize raw/max if available
+    if (score.scaled !== undefined)
+        return { score: score.scaled, entry };
+    if (score.raw !== undefined && score.max !== undefined && score.max !== 0) {
+        return { score: score.raw / score.max, entry };
+    }
+    return { score: undefined, entry };
+};
+/*
+ * the 'best' entry is the one with the highest scaled score.
+ * if two entries have no score, the most recent is considered best.
+ */
+exports.bestEntry = findByComparator((a, b) => {
+    // if neither has a score, use the most recent
+    if (a.score === undefined && b.score === undefined) {
+        return (0, isAfter_1.default)((0, exports.getStatementTime)(a.entry.attempt), (0, exports.getStatementTime)(b.entry.attempt));
+    }
+    if (a.score === undefined)
+        return false;
+    if (b.score === undefined)
+        return true;
+    return a.score > b.score;
+}, scaledScoreForEntry);
 const resolveAttemptInfo = (statements, options) => {
     // TODO optimize. i'm 100% that this could all be done in one iteration but i'm not messing around with that for now.
     const attempts = (0, exports.resolveAttempts)(statements, options);
-    /* attempts that have a completed statement */
-    const resolveAttemptsWithCompleted = (statements, attempts, activityIRI) => attempts.reduce((acc, attempt) => {
-        const completed = (0, exports.resolveCompletedForAttempt)(statements, attempt, activityIRI);
-        if (completed)
-            acc.push({ attempt, completed });
-        return acc;
-    }, []);
-    const completedPairs = resolveAttemptsWithCompleted(statements, attempts, options === null || options === void 0 ? void 0 : options.activityIRI);
-    const completedAttempts = completedPairs.length;
-    /* the last attempt sorted by timestamp */
-    const currentAttempt = (options === null || options === void 0 ? void 0 : options.currentAttempt)
-        ? attempts.find(attempt => attempt.id === options.currentAttempt)
-        : (options === null || options === void 0 ? void 0 : options.currentPreference) === 'oldest'
-            ? (0, exports.oldestStatement)(attempts)
-            : (0, exports.mostRecentStatement)(attempts);
-    const current = currentAttempt
-        ? {
-            attempt: currentAttempt,
-            completed: (0, exports.resolveCompletedForAttempt)(statements, currentAttempt, options === null || options === void 0 ? void 0 : options.activityIRI),
-            scored: (0, exports.resolveScoredForAttempt)(statements, currentAttempt, options === null || options === void 0 ? void 0 : options.activityIRI),
-        }
-        : undefined;
-    const currentAttemptStatements = currentAttempt
+    const attemptEntries = resolveAttemptEntries(statements, attempts, options === null || options === void 0 ? void 0 : options.activityIRI);
+    const completedEntries = attemptEntries.filter((entry) => !!entry.completed);
+    const current = (options === null || options === void 0 ? void 0 : options.currentAttempt)
+        ? attemptEntries.find(({ attempt }) => attempt.id === options.currentAttempt)
+        : (options === null || options === void 0 ? void 0 : options.currentPreference) === 'oldest' /* the attempt sorted by timestamp */
+            ? (0, exports.oldestEntry)(attemptEntries)
+            : (0, exports.mostRecentEntry)(attemptEntries);
+    const currentAttemptStatements = current
         ? statements.filter(statement => {
             var _a;
             return (!(options === null || options === void 0 ? void 0 : options.activityIRI) || statement.object.id === options.activityIRI) &&
-                ((_a = statement.context) === null || _a === void 0 ? void 0 : _a.registration) === currentAttempt.id;
+                ((_a = statement.context) === null || _a === void 0 ? void 0 : _a.registration) === current.attempt.id;
         })
         : [];
-    const mostRecentPair = completedPairs.reduce((cur, pair) => {
-        if (!cur)
-            return pair;
-        return (0, isAfter_1.default)((0, parseISO_1.default)(cur.attempt.timestamp), (0, parseISO_1.default)(pair.attempt.timestamp)) ? cur : pair;
-    }, undefined);
-    const mostRecentWithCompleted = mostRecentPair
-        ? {
-            attempt: mostRecentPair.attempt,
-            completed: (0, exports.resolveCompletedForAttempt)(statements, mostRecentPair.attempt, options === null || options === void 0 ? void 0 : options.activityIRI),
-            scored: (0, exports.resolveScoredForAttempt)(statements, mostRecentPair.attempt, options === null || options === void 0 ? void 0 : options.activityIRI),
-        }
-        : undefined;
-    const scaledForAttempt = (attempt) => {
-        var _a;
-        // resolveScoredForAttempt may return a Scored, or fallback to a Completed that has a score
-        const picked = (0, exports.resolveScoredForAttempt)(statements, attempt, options === null || options === void 0 ? void 0 : options.activityIRI);
-        const score = (_a = picked === null || picked === void 0 ? void 0 : picked.result) === null || _a === void 0 ? void 0 : _a.score;
-        if (!score)
-            return undefined;
-        // Prefer scaled, otherwise normalize raw/max if available
-        if (score.scaled !== undefined)
-            return score.scaled;
-        if (score.raw !== undefined && score.max !== undefined && score.max !== 0) {
-            return score.raw / score.max;
-        }
-        return undefined;
-    };
-    let bestAttempt = completedPairs.reduce((best, { attempt }) => {
-        const bScaled = best !== undefined ? scaledForAttempt(best) : undefined;
-        const aScaled = scaledForAttempt(attempt);
-        if (bScaled === undefined)
-            return aScaled === undefined ? best : attempt;
-        if (aScaled === undefined)
-            return best;
-        return aScaled > bScaled ? attempt : best;
-    }, undefined);
-    // Fallback if no attempt had a score, use newest completed as best
-    if (!bestAttempt && mostRecentPair) {
-        bestAttempt = mostRecentPair.attempt;
-    }
-    const best = bestAttempt
-        ? {
-            attempt: bestAttempt,
-            completed: (0, exports.resolveCompletedForAttempt)(statements, bestAttempt, options && options.activityIRI),
-            scored: (0, exports.resolveScoredForAttempt)(statements, bestAttempt, options && options.activityIRI),
-        }
-        : undefined;
+    const mostRecentWithCompleted = (0, exports.mostRecentEntry)(completedEntries);
+    const best = (0, exports.bestEntry)(completedEntries);
     return {
         attempts: attempts.length,
-        completedAttempts,
+        completedAttempts: completedEntries.length,
         currentAttemptStatements,
         current,
         best,

package/dist/cjs/services/lrsGateway/xapiUtils.d.ts

@@ -1,6 +1,6 @@
 import { AccountsGateway, MappedUserInfo } from '../accountsGateway';
 import { AuthProvider } from '../authProvider';
-import { ActivityState } from './attempt-utils';
+import { ActivityState, AttemptEntry } from './attempt-utils';
 import { LrsGateway } from '.';
 export interface Grade {
     activityProgress: 'Initialized' | 'Started' | 'inProgress' | 'Submitted' | 'Completed';
@@ -23,15 +23,8 @@ export declare const getRegistrationAttemptInfo: (lrs: LrsGateway, registration:
 }) => Promise<{
     [key: string]: ActivityState;
 }>;
-export declare const getScoreGrade: (score: {
-    scaled?: number;
-    raw?: number;
-    min?: number;
-    max?: number;
-}, options: {
+export declare const getScoreGrade: (entry: Partial<AttemptEntry>, options: {
     maxScore?: number;
-    startedAt?: string;
-    submittedAt?: string;
     userId?: string;
 }) => Grade;
 export type Progress = {

package/dist/cjs/services/lrsGateway/xapiUtils.js

@@ -30,28 +30,28 @@ exports.getRegistrationAttemptInfo = getRegistrationAttemptInfo;
 // lti: http://www.imsglobal.org/spec/lti-ags/v2p0#score-publish-service
 // ltijs: https://cvmcosta.me/ltijs/#/grading
 // Note: "min" is currently completely ignored
-const getScoreGrade = (score, options) => {
-    const { raw, scaled, max } = score;
-    const { maxScore, startedAt, submittedAt, userId } = options;
+const getScoreGrade = (entry, options) => {
+    var _a, _b, _c, _d, _e;
+    const { raw, scaled, max } = ((_b = (_a = entry.scored) === null || _a === void 0 ? void 0 : _a.result) === null || _b === void 0 ? void 0 : _b.score) || {};
+    const { maxScore, userId } = options;
     const scoreMaximum = maxScore !== null && maxScore !== void 0 ? maxScore : 100;
     const scoreGiven = raw && max
         ? scoreMaximum / max * raw
         : scaled
             ? scaled * scoreMaximum
             : 0;
-    const submission = {};
-    if (startedAt) {
-        submission.startedAt = startedAt;
-    }
-    if (submittedAt) {
-        submission.submittedAt = submittedAt;
-    }
+    const submission = {
+        startedAt: entry.attempt ? (0, attempt_utils_1.getStatementTimeString)(entry.attempt) : undefined,
+        submittedAt: entry.completed ? (0, attempt_utils_1.getStatementTimeString)(entry.completed) : undefined,
+    };
+    const pendingManual = entry.scored === undefined
+        && ((_e = (_d = (_c = entry.completed) === null || _c === void 0 ? void 0 : _c.result) === null || _d === void 0 ? void 0 : _d.extensions) === null || _e === void 0 ? void 0 : _e[attempt_utils_1.EXT_PENDING_SCORING]) === 'true';
     return {
         userId,
-        activityProgress: submittedAt ? 'Completed' : 'Started',
+        activityProgress: entry.completed ? 'Completed' : 'Started',
         // canvas assumes that anything that isn't 'FullyGraded' requires manual grading and displays a "needs grading" icon.
         // if you warp your mind you can consider the portion of the assignment which is completed to be fully graded.
-        gradingProgress: 'FullyGraded',
+        gradingProgress: pendingManual ? 'PendingManual' : 'FullyGraded',
         scoreMaximum,
         scoreGiven: (0, __1.roundToPrecision)(scoreGiven, -2),
         submission,
@@ -59,32 +59,19 @@ const getScoreGrade = (score, options) => {
 };
 exports.getScoreGrade = getScoreGrade;
 // These methods assign 0's to incomplete activities
-const pickAttemptAndCompletedOrScored = (state, gradePreference) => {
-    var _a;
-    const entry = (gradePreference === 'best' ? state.best : state.current);
-    return {
-        attempt: entry === null || entry === void 0 ? void 0 : entry.attempt,
-        completedOrScored: (_a = entry === null || entry === void 0 ? void 0 : entry.scored) !== null && _a !== void 0 ? _a : entry === null || entry === void 0 ? void 0 : entry.completed,
-        completed: entry === null || entry === void 0 ? void 0 : entry.completed,
-    };
+const getGradingAttemptEntry = (state, gradePreference) => {
+    return (gradePreference === 'best' ? state.best : state.current) || {};
 };
 const getCompletedActivityStateGradeAndProgress = ({ name, scoreMaximum, state, userId, gradePreference = 'current' }) => {
-    var _a, _b, _c;
-    const { attempt, completedOrScored, completed } = pickAttemptAndCompletedOrScored(state, gradePreference);
-    const grade = (0, exports.getScoreGrade)(((_a = completedOrScored === null || completedOrScored === void 0 ? void 0 : completedOrScored.result) === null || _a === void 0 ? void 0 : _a.score) || {}, {
+    const entry = getGradingAttemptEntry(state, gradePreference);
+    const grade = (0, exports.getScoreGrade)(entry, {
         maxScore: scoreMaximum,
-        startedAt: attempt === null || attempt === void 0 ? void 0 : attempt.timestamp,
-        submittedAt: completed === null || completed === void 0 ? void 0 : completed.timestamp,
         userId,
     });
-    // If this Completed is explicitly "pending scoring", surface that in the grade.
-    if (((_c = (_b = completedOrScored === null || completedOrScored === void 0 ? void 0 : completedOrScored.result) === null || _b === void 0 ? void 0 : _b.extensions) === null || _c === void 0 ? void 0 : _c[attempt_utils_1.EXT_PENDING_SCORING]) === 'true') {
-        grade.gradingProgress = 'PendingManual';
-    }
     return {
         grade,
         progress: {
-            scaled: completedOrScored ? 1 : 0,
+            scaled: entry.completed ? 1 : 0,
         },
         name,
     };
@@ -98,7 +85,7 @@ const getCompletedUserInfosGradeAndProgress = (infos, scoreMaximum, gradePrefere
 }));
 exports.getCompletedUserInfosGradeAndProgress = getCompletedUserInfosGradeAndProgress;
 const getCurrentGrade = async (services, registration, options) => {
-    var _a;
+    var _a, _b;
     const user = await services.ltiAuthProvider.getUser();
     if (!user) {
         return null;
@@ -116,7 +103,7 @@ const getCurrentGrade = async (services, registration, options) => {
             gradePreference,
         });
     }
-    if (userInfo.current && userInfo.current.completed || !incompleteAttemptCallback) {
+    if (((_b = userInfo.current) === null || _b === void 0 ? void 0 : _b.completed) || !incompleteAttemptCallback) {
         return getCompletedActivityStateGradeAndProgress({
             name,
             scoreMaximum,
@@ -138,8 +125,8 @@ const getAssignmentGrades = async (services, assignmentIRI, registration, option
     }
     // Partition based on whether the chosen preference has a completed attempt
     const [incompleteInfo, completedInfo] = (0, partition_1.default)((info) => {
-        const { completedOrScored } = pickAttemptAndCompletedOrScored(info.data, gradePreference);
-        return completedOrScored === undefined;
+        const { completed } = getGradingAttemptEntry(info.data, gradePreference);
+        return completed === undefined;
     })(mappedInfo);
     return (0, exports.getCompletedUserInfosGradeAndProgress)(completedInfo, scoreMaximum, gradePreference).concat(await incompleteAttemptsCallback(incompleteInfo));
 };