@openstax/ts-utils 1.5.1 → 1.5.3

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

@@ -1,6 +1,7 @@
 import { AccountsGateway } from '../accountsGateway';
 import { AuthProvider } from '../authProvider';
 import { Logger } from '../logger';
+import { ActivityState } from './attempt-utils';
 import { LrsGateway } from '.';
 export interface Grade {
     scoreGiven: number;
@@ -12,21 +13,32 @@ export interface Grade {
 }
 export declare const getRegistrationAttemptInfo: (lrs: LrsGateway, registration: string, options?: {
     anyUser?: boolean | undefined;
+    user?: string | undefined;
 } | undefined) => Promise<{
-    [key: string]: import("./attempt-utils").ActivityState;
+    [key: string]: ActivityState;
 }>;
+export declare const getScoreGrade: (score: {
+    scaled?: number;
+    raw?: number;
+    min?: number;
+    max?: number;
+}, completed: boolean, userId: string, maxScore?: number | undefined) => Grade;
 export declare const getCurrentGrade: (services: {
     lrs: LrsGateway;
     ltiAuthProvider: AuthProvider;
 }, registration: string, options?: {
+    incompleteAttemptCallback?: ((info: ActivityState) => Promise<Grade>) | undefined;
     scoreMaximum?: number | undefined;
     userId?: string | undefined;
 } | undefined) => Promise<Grade | null>;
-export declare const getAllGradesForAssignment: (services: {
+export declare const getAssignmentGrades: (services: {
     accountsGateway: AccountsGateway;
     lrs: LrsGateway;
     logger: Logger;
 }, registration: string, options?: {
+    anyUser?: boolean | undefined;
+    incompleteAttemptsCallback?: ((mappedInfo: [string, ActivityState][]) => Promise<Grade[]>) | undefined;
     platformId?: string | undefined;
     scoreMaximum?: number | undefined;
+    user?: string | undefined;
 } | undefined) => Promise<Grade[]>;

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

@@ -1,6 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAllGradesForAssignment = exports.getCurrentGrade = exports.getRegistrationAttemptInfo = void 0;
+exports.getAssignmentGrades = exports.getCurrentGrade = exports.getScoreGrade = exports.getRegistrationAttemptInfo = void 0;
+const partition_1 = __importDefault(require("lodash/fp/partition"));
 const __1 = require("../..");
 const attempt_utils_1 = require("./attempt-utils");
 const getRegistrationAttemptInfo = async (lrs, registration, options) => {
@@ -16,7 +20,7 @@ const getRegistrationAttemptInfo = async (lrs, registration, options) => {
     });
     const result = {};
     for (const [userUuid, userStatements] of Object.entries(statementsPerUser)) {
-        result[userUuid] = (0, attempt_utils_1.resolveAttemptInfo)(userStatements);
+        result[userUuid] = (0, attempt_utils_1.resolveAttemptInfo)(userStatements, { currentPreference: 'oldest' });
     }
     return result;
 };
@@ -24,10 +28,8 @@ exports.getRegistrationAttemptInfo = getRegistrationAttemptInfo;
 // generates a payload that can be sent to the LMS, documentation here:
 // lti: http://www.imsglobal.org/spec/lti-ags/v2p0#score-publish-service
 // ltijs: https://cvmcosta.me/ltijs/#/grading
-const getInfoGrade = (info, userId, maxScore) => {
-    var _a;
-    const completed = info.currentAttemptCompleted;
-    const { raw, scaled, max } = ((_a = completed === null || completed === void 0 ? void 0 : completed.result) === null || _a === void 0 ? void 0 : _a.score) || {};
+const getScoreGrade = (score, completed, userId, maxScore) => {
+    const { raw, scaled, max } = score;
     const scoreMaximum = maxScore !== null && maxScore !== void 0 ? maxScore : 100;
     const scoreGiven = raw && max
         ? scoreMaximum / max * raw
@@ -42,20 +44,38 @@ const getInfoGrade = (info, userId, maxScore) => {
         scoreGiven: (0, __1.roundToPrecision)(scoreGiven, -2),
     };
 };
+exports.getScoreGrade = getScoreGrade;
+const getInfoGrade = (info, userId, maxScore) => {
+    var _a, _b;
+    return (0, exports.getScoreGrade)(((_b = (_a = info.currentAttemptCompleted) === null || _a === void 0 ? void 0 : _a.result) === null || _b === void 0 ? void 0 : _b.score) || {}, !!info.currentAttemptCompleted, userId, maxScore);
+};
 const getCurrentGrade = async (services, registration, options) => {
     var _a;
     const user = await services.ltiAuthProvider.getUser();
     if (!user) {
         return null;
     }
+    const userId = (_a = options === null || options === void 0 ? void 0 : options.userId) !== null && _a !== void 0 ? _a : user.uuid;
+    const scoreMaximum = options === null || options === void 0 ? void 0 : options.scoreMaximum;
     const infoPerUser = await (0, exports.getRegistrationAttemptInfo)(services.lrs, registration);
     const userInfo = infoPerUser[user.uuid];
-    return getInfoGrade(userInfo !== null && userInfo !== void 0 ? userInfo : (0, attempt_utils_1.resolveAttemptInfo)([]), (_a = options === null || options === void 0 ? void 0 : options.userId) !== null && _a !== void 0 ? _a : user.uuid, options === null || options === void 0 ? void 0 : options.scoreMaximum);
+    if (!userInfo) {
+        return getInfoGrade((0, attempt_utils_1.resolveAttemptInfo)([]), userId, scoreMaximum);
+    }
+    if (userInfo.currentAttemptCompleted || !(options === null || options === void 0 ? void 0 : options.incompleteAttemptCallback)) {
+        return getInfoGrade(userInfo, userId, scoreMaximum);
+    }
+    return options.incompleteAttemptCallback(userInfo);
 };
 exports.getCurrentGrade = getCurrentGrade;
-const getAllGradesForAssignment = async (services, registration, options) => {
-    const infoPerUserUuid = await (0, exports.getRegistrationAttemptInfo)(services.lrs, registration, { anyUser: true });
-    const mappedResults = await services.accountsGateway.mapUserUuids(infoPerUserUuid, services.logger, options === null || options === void 0 ? void 0 : options.platformId);
-    return mappedResults.map(([userId, userInfo]) => getInfoGrade(userInfo, userId, options === null || options === void 0 ? void 0 : options.scoreMaximum));
+const getAssignmentGrades = async (services, registration, options) => {
+    const infoPerUserUuid = await (0, exports.getRegistrationAttemptInfo)(services.lrs, registration, { anyUser: options === null || options === void 0 ? void 0 : options.anyUser, user: options === null || options === void 0 ? void 0 : options.user });
+    const mappedInfo = await services.accountsGateway.mapUserUuids(infoPerUserUuid, services.logger, options === null || options === void 0 ? void 0 : options.platformId);
+    const gradeCompletedAttemptsOnly = (results) => results.map(([userId, userInfo]) => getInfoGrade(userInfo, userId, options === null || options === void 0 ? void 0 : options.scoreMaximum));
+    if (!(options === null || options === void 0 ? void 0 : options.incompleteAttemptsCallback)) {
+        return gradeCompletedAttemptsOnly(mappedInfo);
+    }
+    const [incompleteInfo, completedInfo] = (0, partition_1.default)((info) => info[1].currentAttemptCompleted === undefined)(mappedInfo);
+    return gradeCompletedAttemptsOnly(completedInfo).concat(await options.incompleteAttemptsCallback(incompleteInfo));
 };
-exports.getAllGradesForAssignment = getAllGradesForAssignment;
+exports.getAssignmentGrades = getAssignmentGrades;