@openstax/ts-utils 1.30.4 → 1.31.1

package/dist/cjs/services/documentStore/fileSystemAssert.d.ts

@@ -0,0 +1 @@
+export declare const assertNoUndefined: (obj: any, path?: string[]) => void;

package/dist/cjs/services/documentStore/fileSystemAssert.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertNoUndefined = void 0;
+const assertNoUndefined = (obj, path = []) => {
+    if (obj === undefined) {
+        throw new Error(`unknown attribute type ${typeof obj} with value ${obj} at ${path.join('.') || 'root'}.`);
+    }
+    if (obj && typeof obj === 'object') {
+        for (const [key, value] of Object.entries(obj)) {
+            (0, exports.assertNoUndefined)(value, [...path, key]);
+        }
+    }
+};
+exports.assertNoUndefined = assertNoUndefined;

package/dist/cjs/services/documentStore/unversioned/file-system.js

@@ -43,6 +43,7 @@ const __1 = require("../../..");
 const config_1 = require("../../../config");
 const errors_1 = require("../../../errors");
 const guards_1 = require("../../../guards");
+const fileSystemAssert_1 = require("../fileSystemAssert");
 const fileSystemUnversionedDocumentStore = (initializer) => () => (configProvider) => (_, hashKey, options) => {
     const tableName = (0, config_1.resolveConfigValue)(configProvider[initializer.configSpace || 'fileSystem'].tableName);
     const tablePath = tableName.then((table) => path_1.default.join(initializer.dataDir, table));
@@ -81,6 +82,7 @@ const fileSystemUnversionedDocumentStore = (initializer) => () => (configProvide
     return {
         loadAllDocumentsTheBadWay,
         getItemsByField: async (key, value, pageKey) => {
+            (0, fileSystemAssert_1.assertNoUndefined)(value, [key]);
             const pageSize = 10;
             const items = await loadAllDocumentsTheBadWay();
             const filteredItems = items.filter((item) => item[key] === value);
@@ -92,11 +94,18 @@ const fileSystemUnversionedDocumentStore = (initializer) => () => (configProvide
             return { items: paginatedItems, nextPageToken };
         },
         batchGetItem: async (ids) => {
-            const items = await Promise.all(ids.map((id) => load(hashFilename(id))));
+            const items = await Promise.all(ids.map((id) => {
+                (0, fileSystemAssert_1.assertNoUndefined)(id, ['id']);
+                return load(hashFilename(id));
+            }));
             return items.filter(guards_1.isDefined);
         },
-        getItem: (id) => load(hashFilename(id)),
+        getItem: (id) => {
+            (0, fileSystemAssert_1.assertNoUndefined)(id, ['id']);
+            return load(hashFilename(id));
+        },
         incrementItemAttribute: async (id, attribute) => {
+            (0, fileSystemAssert_1.assertNoUndefined)(id, ['id']);
             const filename = hashFilename(id);
             const path = await filePath(filename);
             await mkTableDir;
@@ -127,11 +136,13 @@ const fileSystemUnversionedDocumentStore = (initializer) => () => (configProvide
                 throw new errors_1.NotFoundError(`Item with ${hashKey.toString()} "${id}" does not exist`);
             }
             const newItem = { ...data, ...item };
+            (0, fileSystemAssert_1.assertNoUndefined)(newItem);
             return new Promise((resolve, reject) => {
                 writeFile(path, JSON.stringify(newItem, null, 2), (err) => err ? reject(err) : resolve(newItem));
             });
         },
         putItem: async (item) => {
+            (0, fileSystemAssert_1.assertNoUndefined)(item);
             const path = await filePath(hashFilename(item[hashKey]));
             await mkTableDir;
             return new Promise((resolve, reject) => {
@@ -139,6 +150,7 @@ const fileSystemUnversionedDocumentStore = (initializer) => () => (configProvide
             });
         },
         createItem: async (item) => {
+            (0, fileSystemAssert_1.assertNoUndefined)(item);
             const hashed = hashFilename(item[hashKey]);
             const existingItem = await load(hashed);
             if (existingItem) {
@@ -159,6 +171,7 @@ const fileSystemUnversionedDocumentStore = (initializer) => () => (configProvide
             // Process items sequentially to ensure consistent conflict detection
             // Note: concurrency parameter is ignored for filesystem to avoid race conditions
             for (const item of items) {
+                (0, fileSystemAssert_1.assertNoUndefined)(item);
                 try {
                     const hashed = hashFilename(item[hashKey]);
                     const existingItem = await load(hashed);

package/dist/cjs/services/documentStore/versioned/file-system.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fileSystemVersionedDocumentStore = void 0;
+const fileSystemAssert_1 = require("../fileSystemAssert");
 const file_system_1 = require("../unversioned/file-system");
 const PAGE_LIMIT = 5;
 const fileSystemVersionedDocumentStore = (initializer) => () => (configProvider) => (_, hashKey, options) => {
@@ -12,6 +13,7 @@ const fileSystemVersionedDocumentStore = (initializer) => () => (configProvider)
             }));
         },
         getVersions: async (id, startVersion) => {
+            (0, fileSystemAssert_1.assertNoUndefined)(id, ['id']);
             const item = await unversionedDocuments.getItem(id);
             const versions = item === null || item === void 0 ? void 0 : item.items.reverse();
             if (!versions) {
@@ -26,6 +28,7 @@ const fileSystemVersionedDocumentStore = (initializer) => () => (configProvider)
             };
         },
         getItem: async (id, timestamp) => {
+            (0, fileSystemAssert_1.assertNoUndefined)(id, ['id']);
             const item = await unversionedDocuments.getItem(id);
             if (timestamp) {
                 return item === null || item === void 0 ? void 0 : item.items.find(version => version.timestamp === timestamp);
@@ -41,6 +44,7 @@ const fileSystemVersionedDocumentStore = (initializer) => () => (configProvider)
                 save: async (changes) => {
                     var _a;
                     const document = { ...item, ...changes, timestamp, author };
+                    (0, fileSystemAssert_1.assertNoUndefined)(document);
                     const container = (_a = await unversionedDocuments.getItem(document[hashKey])) !== null && _a !== void 0 ? _a : { id: document[hashKey], items: [] };
                     const updated = { ...container, items: [...container.items, document] };
                     await unversionedDocuments.putItem(updated);
@@ -52,6 +56,7 @@ const fileSystemVersionedDocumentStore = (initializer) => () => (configProvider)
             var _a;
             const author = (options === null || options === void 0 ? void 0 : options.getAuthor) ? await options.getAuthor(...authorArgs) : authorArgs[0];
             const document = { ...item, timestamp: new Date().getTime(), author };
+            (0, fileSystemAssert_1.assertNoUndefined)(document);
             const container = (_a = await unversionedDocuments.getItem(document[hashKey])) !== null && _a !== void 0 ? _a : { id: document[hashKey], items: [] };
             const updated = { ...container, items: [...container.items, document] };
             await unversionedDocuments.putItem(updated);

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

@@ -3,11 +3,15 @@ import { AuthProvider } from '../authProvider';
 import { ActivityState } from './attempt-utils';
 import { LrsGateway } from '.';
 export interface Grade {
-    scoreGiven: number;
-    scoreMaximum: number;
-    comment?: string;
     activityProgress: 'Initialized' | 'Started' | 'inProgress' | 'Submitted' | 'Completed';
+    comment?: string;
     gradingProgress: 'FullyGraded' | 'Pending' | 'PendingManual' | 'Failed' | 'NotReady';
+    scoreGiven: number;
+    scoreMaximum: number;
+    submission?: {
+        startedAt?: string;
+        submittedAt?: string;
+    };
     userId?: string;
 }
 export declare const getRegistrationAttemptInfo: (lrs: LrsGateway, registration: string, options?: {
@@ -24,7 +28,12 @@ export declare const getScoreGrade: (score: {
     raw?: number;
     min?: number;
     max?: number;
-}, completed: boolean, userId?: string, maxScore?: number) => Grade;
+}, options: {
+    maxScore?: number;
+    startedAt?: string;
+    submittedAt?: string;
+    userId?: string;
+}) => Grade;
 export type Progress = {
     scaled: number;
     max?: number;

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

@@ -29,30 +29,45 @@ 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 getScoreGrade = (score, completed, userId, maxScore) => {
+// Note: "min" is currently completely ignored
+const getScoreGrade = (score, options) => {
     const { raw, scaled, max } = score;
+    const { maxScore, startedAt, submittedAt, 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;
+    }
     return {
         userId,
-        activityProgress: completed ? 'Completed' : 'Started',
+        activityProgress: submittedAt ? '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',
         scoreMaximum,
         scoreGiven: (0, __1.roundToPrecision)(scoreGiven, -2),
+        submission,
     };
 };
 exports.getScoreGrade = getScoreGrade;
 // These methods assign 0's to incomplete activities
 const getCompletedActivityStateGradeAndProgress = ({ name, scoreMaximum, state, userId }) => {
-    var _a, _b;
+    var _a, _b, _c, _d;
     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, scoreMaximum),
+        grade: (0, exports.getScoreGrade)(((_b = (_a = state.currentAttemptCompleted) === null || _a === void 0 ? void 0 : _a.result) === null || _b === void 0 ? void 0 : _b.score) || {}, {
+            maxScore: scoreMaximum,
+            startedAt: (_c = state.currentAttempt) === null || _c === void 0 ? void 0 : _c.timestamp,
+            submittedAt: (_d = state.currentAttemptCompleted) === null || _d === void 0 ? void 0 : _d.timestamp,
+            userId,
+        }),
         progress: {
             scaled: state.currentAttemptCompleted ? 1 : 0,
         },