@openstax/ts-utils 1.5.2 → 1.5.4

package/dist/cjs/services/accountsGateway/index.d.ts

@@ -60,6 +60,12 @@ export declare type SearchUsersResponse = {
     } & JsonCompatibleStruct>;
     total_count: number;
 };
+export declare type MappedUserInfo<T> = {
+    data: T;
+    fullName: string;
+    platformUserId?: string;
+    uuid: string;
+};
 export declare const accountsGateway: <C extends string = "accounts">(initializer: Initializer<C>) => (configProvider: { [key in C]: {
     accountsBase: import("../../config").ConfigValueProvider<string>;
     accountsAuthToken: import("../../config").ConfigValueProvider<string>;
@@ -70,7 +76,7 @@ export declare const accountsGateway: <C extends string = "accounts">(initialize
     linkUser: (body: LinkUserPayload) => Promise<LinkUserResponse>;
     mapUserUuids: <T>(userUuidsMap: {
         [uuid: string]: T;
-    }, logger: Logger, platformId?: string | undefined) => Promise<[string, T][]>;
+    }, logger: Logger, platformId?: string | undefined) => Promise<MappedUserInfo<T>[]>;
     searchUsers: (payload: SearchUsersPayload) => Promise<SearchUsersResponse>;
 };
 export declare type AccountsGateway = ReturnType<ReturnType<typeof accountsGateway>>;

package/dist/cjs/services/accountsGateway/index.js

@@ -91,16 +91,23 @@ const accountsGateway = (initializer) => (configProvider) => {
                 });
             }
             items.forEach((user) => {
-                const userId = platformId ? getPlatformUserId(user.external_ids, platformId) : user.full_name;
-                if (!userId) {
-                    const missing = platformId ? 'external_id matching the given platformId' : 'full_name';
+                const platformUserId = platformId ? getPlatformUserId(user.external_ids, platformId) : undefined;
+                if (platformId && !platformUserId) {
                     logger.logEvent(logger_1.Level.Warn, {
-                        message: `Accounts user has no ${missing}`,
+                        message: 'Accounts user has no external_id matching the given platformId',
                         accountsUuid: user.uuid,
                         platformId,
                     });
                 }
-                results.push([userId || 'N/A', userUuidsMap[user.uuid]]);
+                if (!user.full_name) {
+                    logger.logEvent(logger_1.Level.Warn, {
+                        message: 'Accounts user has no full_name',
+                        accountsUuid: user.uuid,
+                    });
+                }
+                results.push({
+                    data: userUuidsMap[user.uuid], fullName: user.full_name, platformUserId, uuid: user.uuid,
+                });
             });
         }));
         return results;

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

@@ -1,4 +1,4 @@
-import { AccountsGateway } from '../accountsGateway';
+import { AccountsGateway, MappedUserInfo } from '../accountsGateway';
 import { AuthProvider } from '../authProvider';
 import { Logger } from '../logger';
 import { ActivityState } from './attempt-utils';
@@ -13,22 +13,45 @@ export interface Grade {
 }
 export declare const getRegistrationAttemptInfo: (lrs: LrsGateway, registration: string, options?: {
     anyUser?: boolean | undefined;
+    currentPreference?: "latest" | "oldest" | undefined;
+    user?: string | undefined;
 } | undefined) => Promise<{
     [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 type Progress = {
+    scaled: number;
+    max?: number;
+    raw?: number;
+};
+export declare type GradeAndProgress = {
+    grade: Grade;
+    progress: Progress;
+};
 export declare const getCurrentGrade: (services: {
     lrs: LrsGateway;
     ltiAuthProvider: AuthProvider;
 }, registration: string, options?: {
+    currentPreference?: "latest" | "oldest" | undefined;
+    incompleteAttemptCallback?: ((info: ActivityState) => Promise<GradeAndProgress>) | undefined;
     scoreMaximum?: number | undefined;
     userId?: string | undefined;
-} | undefined) => Promise<Grade | null>;
-export declare const getAllGradesForAssignment: (services: {
+} | undefined) => Promise<GradeAndProgress | null>;
+export declare type UserActivityInfo = MappedUserInfo<ActivityState>;
+export declare const getAssignmentGrades: (services: {
     accountsGateway: AccountsGateway;
     lrs: LrsGateway;
     logger: Logger;
 }, registration: string, options?: {
-    incompleteAttemptsCallback?: ((mappedInfo: [string, ActivityState][]) => Promise<Grade[]>) | undefined;
+    anyUser?: boolean | undefined;
+    currentPreference?: "latest" | "oldest" | undefined;
+    incompleteAttemptsCallback?: ((mappedInfo: UserActivityInfo[]) => Promise<GradeAndProgress[]>) | undefined;
     platformId?: string | undefined;
     scoreMaximum?: number | undefined;
-} | undefined) => Promise<Grade[]>;
+    user?: string | undefined;
+} | undefined) => Promise<GradeAndProgress[]>;

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

@@ -3,12 +3,13 @@ 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) => {
-    const allStatements = await lrs.getAllXapiStatements({ ...options, registration, ensureSync: true });
+    const { currentPreference, ...xapiOptions } = options !== null && options !== void 0 ? options : {};
+    const allStatements = await lrs.getAllXapiStatements({ ...xapiOptions, registration, ensureSync: true });
     // Partition statements for each user
     const statementsPerUser = {};
     allStatements.forEach((statement) => {
@@ -20,7 +21,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 });
     }
     return result;
 };
@@ -28,10 +29,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
@@ -46,25 +45,45 @@ const getInfoGrade = (info, userId, maxScore) => {
         scoreGiven: (0, __1.roundToPrecision)(scoreGiven, -2),
     };
 };
+exports.getScoreGrade = getScoreGrade;
+// These methods assigns 0's to incomplete activities
+const getCompletedActivityStateGradeAndProgress = (state, userId, maxScore) => {
+    var _a, _b;
+    return ({
+        grade: (0, exports.getScoreGrade)(((_b = (_a = state.currentAttemptCompleted) === null || _a === void 0 ? void 0 : _a.result) === null || _b === void 0 ? void 0 : _b.score) || {}, !!state.currentAttemptCompleted, userId, maxScore),
+        progress: {
+            scaled: state.currentAttemptCompleted ? 1 : 0,
+        },
+    });
+};
+const getCompletedUserInfosGradeAndProgress = (infos, scoreMaximum) => infos.map(({ data, fullName, platformUserId }) => getCompletedActivityStateGradeAndProgress(data, platformUserId !== null && platformUserId !== void 0 ? platformUserId : fullName, scoreMaximum));
 const getCurrentGrade = async (services, registration, options) => {
     var _a;
     const user = await services.ltiAuthProvider.getUser();
     if (!user) {
         return null;
     }
-    const infoPerUser = await (0, exports.getRegistrationAttemptInfo)(services.lrs, registration);
+    const userId = (_a = options === null || options === void 0 ? void 0 : options.userId) !== null && _a !== void 0 ? _a : user.uuid;
+    const { currentPreference, incompleteAttemptCallback, scoreMaximum } = options !== null && options !== void 0 ? options : {};
+    const infoPerUser = await (0, exports.getRegistrationAttemptInfo)(services.lrs, registration, { currentPreference });
     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 getCompletedActivityStateGradeAndProgress((0, attempt_utils_1.resolveAttemptInfo)([]), userId, scoreMaximum);
+    }
+    if (userInfo.currentAttemptCompleted || !incompleteAttemptCallback) {
+        return getCompletedActivityStateGradeAndProgress(userInfo, userId, scoreMaximum);
+    }
+    return incompleteAttemptCallback(userInfo);
 };
 exports.getCurrentGrade = getCurrentGrade;
-const getAllGradesForAssignment = async (services, registration, options) => {
-    const infoPerUserUuid = await (0, exports.getRegistrationAttemptInfo)(services.lrs, registration, { anyUser: true });
-    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 getAssignmentGrades = async (services, registration, options) => {
+    const { anyUser, currentPreference, incompleteAttemptsCallback, platformId, scoreMaximum, user } = options !== null && options !== void 0 ? options : {};
+    const infoPerUserUuid = await (0, exports.getRegistrationAttemptInfo)(services.lrs, registration, { anyUser, currentPreference, user });
+    const mappedInfo = await services.accountsGateway.mapUserUuids(infoPerUserUuid, services.logger, platformId);
+    if (!incompleteAttemptsCallback) {
+        return getCompletedUserInfosGradeAndProgress(mappedInfo, scoreMaximum);
     }
-    const [incompleteInfo, completedInfo] = (0, partition_1.default)((info) => info[1].currentAttemptCompleted === undefined)(mappedInfo);
-    return gradeCompletedAttemptsOnly(completedInfo).concat(await options.incompleteAttemptsCallback(incompleteInfo));
+    const [incompleteInfo, completedInfo] = (0, partition_1.default)((info) => info.data.currentAttemptCompleted === undefined)(mappedInfo);
+    return getCompletedUserInfosGradeAndProgress(completedInfo, scoreMaximum).concat(await incompleteAttemptsCallback(incompleteInfo));
 };
-exports.getAllGradesForAssignment = getAllGradesForAssignment;
+exports.getAssignmentGrades = getAssignmentGrades;