@openstax/ts-utils 1.44.1 → 1.44.2

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

@@ -6,15 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.addStatementDefaultFields = void 0;
 const formatISO_1 = __importDefault(require("date-fns/formatISO"));
 const uuid_1 = require("uuid");
+const attempt_utils_1 = require("./attempt-utils");
 const addStatementDefaultFields = (statement, user) => ({
     id: (0, uuid_1.v4)(),
-    actor: {
-        account: {
-            homePage: 'https://openstax.org',
-            name: user.uuid,
-        },
-        objectType: 'Agent',
-    },
+    actor: (0, attempt_utils_1.formatAgent)(user.uuid),
     timestamp: (0, formatISO_1.default)(new Date()),
     ...statement,
 });

package/dist/cjs/services/lrsGateway/attempt-utils.d.ts

@@ -1,4 +1,5 @@
-import { LrsGateway, UXapiStatement } from '.';
+import { LrsGateway, UXapiStatement, XapiAgent } from '.';
+export declare const formatAgent: (agent: string | XapiAgent) => XapiAgent;
 export declare const EXT_PENDING_SCORING = "https://openstax.org/xapi/extensions/pending-scoring";
 export type AttemptEntry = {
     attempt: UXapiStatement;
@@ -54,7 +55,7 @@ export declare const createStatement: (verb: UXapiStatement["verb"], activity: {
     extensions?: {
         [key: string]: string;
     };
-}, attempt: string, parentActivityIRI?: string) => Pick<UXapiStatement, "object" | "verb" | "context">;
+}, attempt: string, parentActivityIRI?: string, instructor?: string) => Pick<UXapiStatement, "object" | "verb" | "context">;
 export declare const createAttemptStatement: (activity: {
     iri: string;
     type: string;
@@ -83,7 +84,7 @@ export declare const createCompletedStatement: (attemptStatement: UXapiStatement
 export declare const putCompletedStatement: (gateway: LrsGateway, attemptStatement: UXapiStatement, result: UXapiStatement["result"], user?: string) => Promise<import(".").EagerXapiStatement>;
 export declare const createCompletedPendingScoringStatement: (attemptStatement: UXapiStatement) => Pick<UXapiStatement, "object" | "verb" | "context" | "result">;
 export declare const putCompletedPendingScoringStatement: (gateway: LrsGateway, attemptStatement: UXapiStatement, user?: string) => Promise<import(".").EagerXapiStatement>;
-export declare const createScoredStatement: (attemptStatement: UXapiStatement, result: UXapiStatement["result"]) => Pick<UXapiStatement, "object" | "verb" | "context" | "result">;
-export declare const putScoredStatement: (gateway: LrsGateway, attemptStatement: UXapiStatement, result: UXapiStatement["result"], user?: string) => Promise<import(".").EagerXapiStatement>;
+export declare const createScoredStatement: (attemptStatement: UXapiStatement, result: UXapiStatement["result"], instructor?: string) => Pick<UXapiStatement, "object" | "verb" | "context" | "result">;
+export declare const putScoredStatement: (gateway: LrsGateway, attemptStatement: UXapiStatement, result: UXapiStatement["result"], user?: string, instructor?: string) => Promise<import(".").EagerXapiStatement>;
 export declare const createScoredPendingScoringStatement: (attemptStatement: UXapiStatement, result: UXapiStatement["result"]) => Pick<UXapiStatement, "object" | "verb" | "context" | "result">;
 export declare const putScoredPendingScoringStatement: (gateway: LrsGateway, attemptStatement: UXapiStatement, result: UXapiStatement["result"], user?: string) => Promise<import(".").EagerXapiStatement>;

package/dist/cjs/services/lrsGateway/attempt-utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.putScoredPendingScoringStatement = exports.createScoredPendingScoringStatement = exports.putScoredStatement = exports.createScoredStatement = exports.putCompletedPendingScoringStatement = exports.createCompletedPendingScoringStatement = exports.putCompletedStatement = exports.createCompletedStatement = exports.putAttemptActivityStatement = exports.createAttemptActivityStatement = exports.putAttemptStatement = exports.createAttemptStatement = exports.createStatement = exports.loadActivityAttemptInfo = exports.loadStatementsForActivityAndFirstChildren = exports.resolveAttemptInfo = exports.bestEntry = exports.mostRecentEntry = exports.oldestEntry = exports.mostRecentStatement = exports.oldestStatement = exports.getStatementTime = exports.getStatementTimeString = exports.resolveScoredForAttempt = exports.resolveCompletedForAttempt = exports.resolveAttempts = exports.matchAttemptScored = exports.matchAttemptCompleted = exports.matchAttempt = exports.EXT_PENDING_SCORING = void 0;
+exports.putScoredPendingScoringStatement = exports.createScoredPendingScoringStatement = exports.putScoredStatement = exports.createScoredStatement = exports.putCompletedPendingScoringStatement = exports.createCompletedPendingScoringStatement = exports.putCompletedStatement = exports.createCompletedStatement = exports.putAttemptActivityStatement = exports.createAttemptActivityStatement = exports.putAttemptStatement = exports.createAttemptStatement = exports.createStatement = exports.loadActivityAttemptInfo = exports.loadStatementsForActivityAndFirstChildren = exports.resolveAttemptInfo = exports.bestEntry = exports.mostRecentEntry = exports.oldestEntry = exports.mostRecentStatement = exports.oldestStatement = exports.getStatementTime = exports.getStatementTimeString = exports.resolveScoredForAttempt = exports.resolveCompletedForAttempt = exports.resolveAttempts = exports.matchAttemptScored = exports.matchAttemptCompleted = exports.matchAttempt = exports.EXT_PENDING_SCORING = exports.formatAgent = void 0;
 /*
  * the structure of xapi statements for handling multiple attempts of an activity
  * including the option of a parent activity/attempt such that a new attempt
@@ -17,6 +17,19 @@ const intervalToDuration_1 = __importDefault(require("date-fns/intervalToDuratio
 const isAfter_1 = __importDefault(require("date-fns/isAfter"));
 const isBefore_1 = __importDefault(require("date-fns/isBefore"));
 const parseISO_1 = __importDefault(require("date-fns/parseISO"));
+const formatAgent = (agent) => {
+    if (typeof agent === 'string') {
+        return {
+            objectType: 'Agent',
+            account: {
+                homePage: 'https://openstax.org',
+                name: agent,
+            },
+        };
+    }
+    return agent;
+};
+exports.formatAgent = formatAgent;
 var Verb;
 (function (Verb) {
     Verb["Attempted"] = "http://adlnet.gov/expapi/verbs/attempted";
@@ -170,7 +183,7 @@ const loadActivityAttemptInfo = async (gateway, activityIRI, options) => {
     return (0, exports.resolveAttemptInfo)(await gateway.getAllXapiStatements({ ...loadOptions, activity: activityIRI }), { ...options, activityIRI });
 };
 exports.loadActivityAttemptInfo = loadActivityAttemptInfo;
-const createStatement = (verb, activity, attempt, parentActivityIRI) => {
+const createStatement = (verb, activity, attempt, parentActivityIRI, instructor) => {
     return {
         context: {
             ...(parentActivityIRI ? {
@@ -184,6 +197,7 @@ const createStatement = (verb, activity, attempt, parentActivityIRI) => {
                 },
             } : {}),
             registration: attempt,
+            ...(instructor ? { instructor: (0, exports.formatAgent)(instructor) } : {}),
         },
         object: {
             definition: {
@@ -228,7 +242,7 @@ const createAttemptStatement = (activity, parentActivity) => {
                 } : {}),
                 ...(parentActivity.attempt ? {
                     registration: parentActivity.attempt,
-                } : {})
+                } : {}),
             },
         } : {}),
         object: {
@@ -298,7 +312,7 @@ const createCompletedStatement = (attemptStatement, result) => {
             statement: {
                 objectType: 'StatementRef',
                 id: attemptStatement.id,
-            }
+            },
         },
         object: attemptStatement.object,
         verb: {
@@ -330,7 +344,7 @@ const putCompletedPendingScoringStatement = async (gateway, attemptStatement, us
 };
 exports.putCompletedPendingScoringStatement = putCompletedPendingScoringStatement;
 // scored statement for when the open written response has been graded.
-const createScoredStatement = (attemptStatement, result) => {
+const createScoredStatement = (attemptStatement, result, instructor) => {
     var _a, _b;
     return {
         context: {
@@ -343,7 +357,8 @@ const createScoredStatement = (attemptStatement, result) => {
             statement: {
                 objectType: 'StatementRef',
                 id: attemptStatement.id,
-            }
+            },
+            ...(instructor ? { instructor: (0, exports.formatAgent)(instructor) } : {}),
         },
         object: attemptStatement.object,
         verb: {
@@ -357,8 +372,8 @@ const createScoredStatement = (attemptStatement, result) => {
     };
 };
 exports.createScoredStatement = createScoredStatement;
-const putScoredStatement = async (gateway, attemptStatement, result, user) => {
-    return (await gateway.putXapiStatements([(0, exports.createScoredStatement)(attemptStatement, result)], user))[0];
+const putScoredStatement = async (gateway, attemptStatement, result, user, instructor) => {
+    return (await gateway.putXapiStatements([(0, exports.createScoredStatement)(attemptStatement, result, instructor)], user))[0];
 };
 exports.putScoredStatement = putScoredStatement;
 // scored statement for retry assessments - records a score but marks the attempt as still pending scoring

package/dist/cjs/services/lrsGateway/file-system.js

@@ -46,6 +46,7 @@ const config_1 = require("../../config");
 const errors_1 = require("../../errors");
 const guards_1 = require("../../guards");
 const hashValue_1 = require("../../misc/hashValue");
+const attempt_utils_1 = require("./attempt-utils");
 const pageSize = 5;
 const fileSystemLrsGateway = (initializer) => (configProvider) => ({ authProvider }) => {
     const name = (0, config_1.resolveConfigValue)(configProvider[initializer.configSpace || 'fileSystem'].name);
@@ -108,13 +109,7 @@ const fileSystemLrsGateway = (initializer) => (configProvider) => ({ authProvide
         const statementsWithDefaults = statements.map(statement => ({
             ...statement,
             id: (0, uuid_1.v4)(),
-            actor: {
-                account: {
-                    homePage: 'https://openstax.org',
-                    name: author.uuid,
-                },
-                objectType: 'Agent',
-            },
+            actor: (0, attempt_utils_1.formatAgent)(author.uuid),
             timestamp: (0, formatISO_1.default)(new Date()),
         }));
         await load;

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

@@ -23,13 +23,7 @@ export interface StateDocument {
     [key: string]: any;
 }
 export interface XapiStatement {
-    actor: {
-        account: {
-            homePage: 'https://openstax.org';
-            name: string;
-        };
-        objectType: 'Agent';
-    };
+    actor: XapiAgent;
     id: string;
     context?: {
         contextActivities?: {
@@ -46,6 +40,7 @@ export interface XapiStatement {
         };
         registration?: string;
         platform?: string;
+        instructor?: XapiAgent;
     };
     object: {
         definition?: {

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

@@ -10,6 +10,7 @@ const guards_1 = require("../../guards");
 const helpers_1 = require("../../misc/helpers");
 const routing_1 = require("../../routing");
 const addStatementDefaultFields_1 = require("./addStatementDefaultFields");
+const attempt_utils_1 = require("./attempt-utils");
 const batching_1 = require("./batching");
 const lrsGateway = (initializer) => (configProvider) => {
     const config = configProvider[(0, guards_1.ifDefined)(initializer.configSpace, 'lrs')];
@@ -36,22 +37,6 @@ const lrsGateway = (initializer) => (configProvider) => {
         const makeFetch = async (options) => {
             return enableBatching ? batcher.queueRequest(options) : batcher.singleRequest(options);
         };
-        /**
-         * Formats an agent parameter into a full XapiAgent object.
-         * Accepts either a UUID string or a full XapiAgent object.
-         */
-        const formatAgent = (agent) => {
-            if (typeof agent === 'string') {
-                return {
-                    objectType: 'Agent',
-                    account: {
-                        homePage: 'https://openstax.org',
-                        name: agent,
-                    },
-                };
-            }
-            return agent;
-        };
         // Note: This method actually uses POST
         const putXapiStatements = async (statements, user) => {
             const userObj = user
@@ -113,13 +98,7 @@ ${await response.text()}`);
                 queryParams.until = options.until;
             // Add agent unless anyUser is true
             if (anyUser !== true) {
-                queryParams.agent = JSON.stringify({
-                    account: {
-                        homePage: 'https://openstax.org',
-                        name: user || (0, assertions_1.assertDefined)(await authProvider.getUser(), new errors_1.UnauthorizedError()).uuid,
-                    },
-                    objectType: 'Agent',
-                });
+                queryParams.agent = JSON.stringify((0, attempt_utils_1.formatAgent)(user || (0, assertions_1.assertDefined)(await authProvider.getUser(), new errors_1.UnauthorizedError()).uuid));
             }
             return makeFetch({
                 path: '/data/xAPI/statements',
@@ -169,7 +148,7 @@ ${await response.text()}`);
          * @returns The state document as a JSON object, or null if not found
          */
         const getState = async (activityId, agent, stateId, registration) => {
-            const agentObj = formatAgent(agent);
+            const agentObj = (0, attempt_utils_1.formatAgent)(agent);
             const queryParams = {
                 activityId,
                 agent: JSON.stringify(agentObj),
@@ -207,7 +186,7 @@ ${await response.text()}`);
          * @param registration - Optional registration UUID
          */
         const setState = async (activityId, agent, stateId, body, registration) => {
-            const agentObj = formatAgent(agent);
+            const agentObj = (0, attempt_utils_1.formatAgent)(agent);
             const queryParams = {
                 activityId,
                 agent: JSON.stringify(agentObj),