@openstax/ts-utils 1.5.5 → 1.5.7

package/dist/cjs/assertions.d.ts

@@ -1,4 +1,5 @@
-declare type AssertionFailed = string | Error | (() => never) | undefined;
+export declare type AssertionFailed = string | Error | (() => never) | undefined;
+export declare const doThrow: (failed: AssertionFailed) => never;
 /**
  * Asserts that the given value is true.
  *
@@ -82,4 +83,3 @@ export declare const assertInstanceOf: <T>(thing: any, constructable: Function &
  * @see assertInstanceOf
  */
 export declare const assertErrorInstanceOf: <T extends Error>(thing: unknown, constructable: Function & (new (...args: any[]) => T)) => T;
-export {};

package/dist/cjs/assertions.js

@@ -13,7 +13,7 @@
  * that might be handled differently.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertErrorInstanceOf = exports.assertInstanceOf = exports.notNaN = exports.assertNotNaN = exports.assertString = exports.assertDefined = exports.assertFalse = exports.assertTrue = void 0;
+exports.assertErrorInstanceOf = exports.assertInstanceOf = exports.notNaN = exports.assertNotNaN = exports.assertString = exports.assertDefined = exports.assertFalse = exports.assertTrue = exports.doThrow = void 0;
 const doThrow = (failed) => {
     if (typeof failed === 'string') {
         throw new Error(failed);
@@ -26,6 +26,7 @@ const doThrow = (failed) => {
     }
     return failed();
 };
+exports.doThrow = doThrow;
 /**
  * Asserts that the given value is true.
  *
@@ -38,7 +39,7 @@ const doThrow = (failed) => {
  */
 const assertTrue = (x, failed) => {
     if (typeof x !== 'boolean' || x !== true) {
-        return doThrow(failed);
+        return (0, exports.doThrow)(failed);
     }
     return x;
 };
@@ -55,7 +56,7 @@ exports.assertTrue = assertTrue;
  */
 const assertFalse = (x, failed) => {
     if (typeof x !== 'boolean' || x !== false) {
-        return doThrow(failed);
+        return (0, exports.doThrow)(failed);
     }
     return x;
 };
@@ -72,7 +73,7 @@ exports.assertFalse = assertFalse;
  */
 const assertDefined = (x, failed) => {
     if (x === undefined) {
-        return doThrow(failed);
+        return (0, exports.doThrow)(failed);
     }
     return x;
 };
@@ -89,7 +90,7 @@ exports.assertDefined = assertDefined;
  */
 const assertString = (x, failed) => {
     if (typeof x !== 'string') {
-        return doThrow(failed);
+        return (0, exports.doThrow)(failed);
     }
     return x;
 };
@@ -106,7 +107,7 @@ exports.assertString = assertString;
  */
 const assertNotNaN = (thing, failed) => {
     if (typeof thing === 'number' && isNaN(thing)) {
-        return doThrow(failed);
+        return (0, exports.doThrow)(failed);
     }
     return thing;
 };
@@ -130,7 +131,7 @@ const assertInstanceOf = (thing, constructable, failed) => {
     if (thing instanceof constructable) {
         return thing;
     }
-    return doThrow(failed);
+    return (0, exports.doThrow)(failed);
 };
 exports.assertInstanceOf = assertInstanceOf;
 /**

package/dist/cjs/services/authProvider/utils/userRoleValidator.d.ts

@@ -0,0 +1,13 @@
+import { AuthProvider } from '..';
+import { AssertionFailed } from '../../../assertions';
+import { ConfigProviderForConfig } from '../../../config';
+declare type Config = {
+    application: string;
+};
+export declare const createUserRoleValidator: (auth: AuthProvider, config: ConfigProviderForConfig<Config>) => {
+    getUserRoles: () => Promise<string[]>;
+    userHasRole: (role: string[]) => Promise<boolean>;
+    assertUserRole: (role: string[], fail?: AssertionFailed) => Promise<void>;
+};
+export declare type UserRoleValidator = ReturnType<typeof createUserRoleValidator>;
+export {};

package/dist/cjs/services/authProvider/utils/userRoleValidator.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createUserRoleValidator = void 0;
+const assertions_1 = require("../../../assertions");
+const resolveConfigValue_1 = require("../../../config/resolveConfigValue");
+const errors_1 = require("../../../errors");
+const helpers_1 = require("../../../misc/helpers");
+const createUserRoleValidator = (auth, config) => {
+    const application = (0, helpers_1.once)(() => (0, resolveConfigValue_1.resolveConfigValue)(config.application));
+    const getUserRoles = async () => {
+        var _a;
+        const user = await auth.getUser();
+        const appName = await application();
+        if (!user || !('applications' in user)) {
+            return [];
+        }
+        return ((_a = user.applications.find(a => a.name === appName)) === null || _a === void 0 ? void 0 : _a.roles) || [];
+    };
+    const userHasRole = async (role) => {
+        const roles = await getUserRoles();
+        if (!roles.some(r => role.includes(r))) {
+            return false;
+        }
+        return true;
+    };
+    const assertUserRole = async (role, fail = new errors_1.UnauthorizedError()) => {
+        if (!await userHasRole(role)) {
+            return (0, assertions_1.doThrow)(fail);
+        }
+    };
+    return {
+        getUserRoles,
+        userHasRole,
+        assertUserRole
+    };
+};
+exports.createUserRoleValidator = createUserRoleValidator;

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

@@ -40,7 +40,9 @@ const getScoreGrade = (score, completed, userId, maxScore) => {
     return {
         userId,
         activityProgress: completed ? 'Completed' : 'Started',
-        gradingProgress: completed ? 'FullyGraded' : 'NotReady',
+        // 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',
         scoreMaximum,
         scoreGiven: (0, __1.roundToPrecision)(scoreGiven, -2),
     };