@openstax/ts-utils 1.44.1 → 1.44.2

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

@@ -1,14 +1,9 @@
 import formatISO from 'date-fns/formatISO';
 import { v4 as uuid } from 'uuid';
+import { formatAgent } from './attempt-utils';
 export const addStatementDefaultFields = (statement, user) => ({
     id: uuid(),
-    actor: {
-        account: {
-            homePage: 'https://openstax.org',
-            name: user.uuid,
-        },
-        objectType: 'Agent',
-    },
+    actor: formatAgent(user.uuid),
     timestamp: formatISO(new Date()),
     ...statement,
 });

package/dist/esm/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/esm/services/lrsGateway/attempt-utils.js

@@ -11,6 +11,18 @@ import intervalToDuration from 'date-fns/intervalToDuration';
 import isAfter from 'date-fns/isAfter';
 import isBefore from 'date-fns/isBefore';
 import parseISO from 'date-fns/parseISO';
+export const formatAgent = (agent) => {
+    if (typeof agent === 'string') {
+        return {
+            objectType: 'Agent',
+            account: {
+                homePage: 'https://openstax.org',
+                name: agent,
+            },
+        };
+    }
+    return agent;
+};
 var Verb;
 (function (Verb) {
     Verb["Attempted"] = "http://adlnet.gov/expapi/verbs/attempted";
@@ -153,7 +165,7 @@ export const loadActivityAttemptInfo = async (gateway, activityIRI, options) =>
     const loadOptions = parentActivityAttempt ? { ...partialOptions, registration: parentActivityAttempt } : partialOptions;
     return resolveAttemptInfo(await gateway.getAllXapiStatements({ ...loadOptions, activity: activityIRI }), { ...options, activityIRI });
 };
-export const createStatement = (verb, activity, attempt, parentActivityIRI) => {
+export const createStatement = (verb, activity, attempt, parentActivityIRI, instructor) => {
     return {
         context: {
             ...(parentActivityIRI ? {
@@ -167,6 +179,7 @@ export const createStatement = (verb, activity, attempt, parentActivityIRI) => {
                 },
             } : {}),
             registration: attempt,
+            ...(instructor ? { instructor: formatAgent(instructor) } : {}),
         },
         object: {
             definition: {
@@ -210,7 +223,7 @@ export const createAttemptStatement = (activity, parentActivity) => {
                 } : {}),
                 ...(parentActivity.attempt ? {
                     registration: parentActivity.attempt,
-                } : {})
+                } : {}),
             },
         } : {}),
         object: {
@@ -276,7 +289,7 @@ export const createCompletedStatement = (attemptStatement, result) => {
             statement: {
                 objectType: 'StatementRef',
                 id: attemptStatement.id,
-            }
+            },
         },
         object: attemptStatement.object,
         verb: {
@@ -304,7 +317,7 @@ export const putCompletedPendingScoringStatement = async (gateway, attemptStatem
     ], user))[0];
 };
 // scored statement for when the open written response has been graded.
-export const createScoredStatement = (attemptStatement, result) => {
+export const createScoredStatement = (attemptStatement, result, instructor) => {
     var _a, _b;
     return {
         context: {
@@ -317,7 +330,8 @@ export const createScoredStatement = (attemptStatement, result) => {
             statement: {
                 objectType: 'StatementRef',
                 id: attemptStatement.id,
-            }
+            },
+            ...(instructor ? { instructor: formatAgent(instructor) } : {}),
         },
         object: attemptStatement.object,
         verb: {
@@ -330,8 +344,8 @@ export const createScoredStatement = (attemptStatement, result) => {
         }
     };
 };
-export const putScoredStatement = async (gateway, attemptStatement, result, user) => {
-    return (await gateway.putXapiStatements([createScoredStatement(attemptStatement, result)], user))[0];
+export const putScoredStatement = async (gateway, attemptStatement, result, user, instructor) => {
+    return (await gateway.putXapiStatements([createScoredStatement(attemptStatement, result, instructor)], user))[0];
 };
 // scored statement for retry assessments - records a score but marks the attempt as still pending scoring
 export const createScoredPendingScoringStatement = (attemptStatement, result) => createScoredStatement(attemptStatement, {

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

@@ -7,6 +7,7 @@ import { resolveConfigValue } from '../../config';
 import { UnauthorizedError } from '../../errors';
 import { ifDefined } from '../../guards';
 import { hashValue } from '../../misc/hashValue';
+import { formatAgent } from './attempt-utils';
 const pageSize = 5;
 export const fileSystemLrsGateway = (initializer) => (configProvider) => ({ authProvider }) => {
     const name = resolveConfigValue(configProvider[initializer.configSpace || 'fileSystem'].name);
@@ -69,13 +70,7 @@ export const fileSystemLrsGateway = (initializer) => (configProvider) => ({ auth
         const statementsWithDefaults = statements.map(statement => ({
             ...statement,
             id: uuid(),
-            actor: {
-                account: {
-                    homePage: 'https://openstax.org',
-                    name: author.uuid,
-                },
-                objectType: 'Agent',
-            },
+            actor: formatAgent(author.uuid),
             timestamp: formatISO(new Date()),
         }));
         await load;

package/dist/esm/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/esm/services/lrsGateway/index.js

@@ -7,6 +7,7 @@ import { ifDefined } from '../../guards';
 import { retryWithDelay } from '../../misc/helpers';
 import { METHOD } from '../../routing';
 import { addStatementDefaultFields } from './addStatementDefaultFields';
+import { formatAgent } from './attempt-utils';
 import { RequestBatcher } from './batching';
 export const lrsGateway = (initializer) => (configProvider) => {
     const config = configProvider[ifDefined(initializer.configSpace, 'lrs')];
@@ -33,22 +34,6 @@ export 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
@@ -110,13 +95,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 || assertDefined(await authProvider.getUser(), new UnauthorizedError()).uuid,
-                    },
-                    objectType: 'Agent',
-                });
+                queryParams.agent = JSON.stringify(formatAgent(user || assertDefined(await authProvider.getUser(), new UnauthorizedError()).uuid));
             }
             return makeFetch({
                 path: '/data/xAPI/statements',