@openstax/ts-utils 1.6.1 → 1.7.0

package/dist/esm/misc/helpers.js

@@ -106,7 +106,18 @@ export const mapFind = (array, mapper, predicate = (r) => !!r) => {
 export const once = (fn) => {
     const initialValue = {};
     let result = initialValue;
-    return ((...args) => result === initialValue ? (result = fn(...args)) : result);
+    return ((...args) => {
+        if (result !== initialValue) {
+            return result;
+        }
+        result = fn(...args);
+        if (typeof result === 'object' && result instanceof Promise) {
+            // Clear the result when possible but do not return a Promise that resolves to the initialValue
+            result.catch(() => result = initialValue);
+        }
+        // If this is a rejected Promise, it should be returned before catch() actually overwrites it
+        return result;
+    });
 };
 /**
  * memoizes a function with any number of arguments

package/dist/esm/services/authProvider/browser.d.ts

@@ -29,6 +29,10 @@ export interface Window {
 export declare const browserAuthProvider: <C extends string = "auth">({ window, configSpace }: Initializer<C>) => (configProvider: { [key in C]: {
     accountsBase: import("../../config").ConfigValueProvider<string>;
 }; }) => {
+    /**
+     * gets the authentication token
+     */
+    getAuthToken: () => Promise<string | null>;
     /**
      * adds auth parameters to the url. this is only safe to use when using javascript to navigate
      * within the current window, eg `window.location = 'https://my.otherservice.com';` anchors

package/dist/esm/services/authProvider/browser.js

@@ -17,6 +17,9 @@ export const browserAuthProvider = ({ window, configSpace }) => (configProvider)
     let userData = {
         token: [null, embeddedQueryValue].includes(authQuery) ? null : authQuery
     };
+    const getAuthToken = async () => {
+        return (await getUserData()).token;
+    };
     const getAuthorizedLinkUrl = (urlString) => {
         const url = new URL(urlString);
         if (userData.token) {
@@ -89,6 +92,10 @@ export const browserAuthProvider = ({ window, configSpace }) => (configProvider)
         return (await getUserData()).user;
     };
     return {
+        /**
+         * gets the authentication token
+         */
+        getAuthToken,
         /**
          * adds auth parameters to the url. this is only safe to use when using javascript to navigate
          * within the current window, eg `window.location = 'https://my.otherservice.com';` anchors

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

@@ -9,7 +9,7 @@ export interface Grade {
     comment?: string;
     activityProgress: 'Initialized' | 'Started' | 'inProgress' | 'Submitted' | 'Completed';
     gradingProgress: 'FullyGraded' | 'Pending' | 'PendingManual' | 'Failed' | 'NotReady';
-    userId: string;
+    userId?: string;
 }
 export declare const getRegistrationAttemptInfo: (lrs: LrsGateway, registration: string, options?: {
     activity?: string | undefined;
@@ -25,7 +25,7 @@ export declare const getScoreGrade: (score: {
     raw?: number;
     min?: number;
     max?: number;
-}, completed: boolean, userId: string, maxScore?: number | undefined) => Grade;
+}, completed: boolean, userId?: string | undefined, maxScore?: number | undefined) => Grade;
 export declare type Progress = {
     scaled: number;
     max?: number;
@@ -34,6 +34,7 @@ export declare type Progress = {
 export declare type GradeAndProgress = {
     grade: Grade;
     progress: Progress;
+    name?: string;
 };
 export declare const getCurrentGrade: (services: {
     lrs: LrsGateway;
@@ -41,6 +42,7 @@ export declare const getCurrentGrade: (services: {
 }, registration: string, options?: {
     currentPreference?: "latest" | "oldest" | undefined;
     incompleteAttemptCallback?: ((info: ActivityState) => Promise<GradeAndProgress>) | undefined;
+    name?: string | undefined;
     scoreMaximum?: number | undefined;
     userId?: string | undefined;
 } | undefined) => Promise<GradeAndProgress | null>;

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

@@ -40,17 +40,20 @@ export const getScoreGrade = (score, completed, userId, maxScore) => {
         scoreGiven: roundToPrecision(scoreGiven, -2),
     };
 };
-// These methods assigns 0's to incomplete activities
-const getCompletedActivityStateGradeAndProgress = (state, userId, maxScore) => {
+// These methods assign 0's to incomplete activities
+const getCompletedActivityStateGradeAndProgress = ({ name, scoreMaximum, state, userId }) => {
     var _a, _b;
     return ({
-        grade: 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),
+        grade: getScoreGrade(((_b = (_a = state.currentAttemptCompleted) === null || _a === void 0 ? void 0 : _a.result) === null || _b === void 0 ? void 0 : _b.score) || {}, !!state.currentAttemptCompleted, userId, scoreMaximum),
         progress: {
             scaled: state.currentAttemptCompleted ? 1 : 0,
         },
+        name,
     });
 };
-const getCompletedUserInfosGradeAndProgress = (infos, scoreMaximum) => infos.map(({ data, fullName, platformUserId }) => getCompletedActivityStateGradeAndProgress(data, platformUserId !== null && platformUserId !== void 0 ? platformUserId : fullName, scoreMaximum));
+const getCompletedUserInfosGradeAndProgress = (infos, scoreMaximum) => infos.map(({ data, fullName, platformUserId }) => getCompletedActivityStateGradeAndProgress({
+    name: fullName, scoreMaximum, userId: platformUserId, state: data
+}));
 export const getCurrentGrade = async (services, registration, options) => {
     var _a;
     const user = await services.ltiAuthProvider.getUser();
@@ -58,14 +61,14 @@ export const getCurrentGrade = async (services, registration, options) => {
         return null;
     }
     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 { currentPreference, incompleteAttemptCallback, name, scoreMaximum } = options !== null && options !== void 0 ? options : {};
     const infoPerUser = await getRegistrationAttemptInfo(services.lrs, registration, { currentPreference });
     const userInfo = infoPerUser[user.uuid];
     if (!userInfo) {
-        return getCompletedActivityStateGradeAndProgress(resolveAttemptInfo([]), userId, scoreMaximum);
+        return getCompletedActivityStateGradeAndProgress({ name, scoreMaximum, state: resolveAttemptInfo([]), userId });
     }
     if (userInfo.currentAttemptCompleted || !incompleteAttemptCallback) {
-        return getCompletedActivityStateGradeAndProgress(userInfo, userId, scoreMaximum);
+        return getCompletedActivityStateGradeAndProgress({ name, scoreMaximum, state: userInfo, userId });
     }
     return incompleteAttemptCallback(userInfo);
 };