@openstax/ts-utils 1.20.0 → 1.20.2

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

@@ -0,0 +1,5 @@
+import { User } from '../authProvider';
+import { EagerXapiStatement, UXapiStatement, XapiStatement } from '.';
+export declare const addStatementDefaultFields: (statement: (Pick<XapiStatement, 'object' | 'verb' | 'context' | 'result'> & {
+    id?: string;
+}) | UXapiStatement, user: User) => EagerXapiStatement;

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

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

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

@@ -1,23 +1,23 @@
-import { LrsGateway, XapiStatement } from '.';
+import { LrsGateway, UXapiStatement } from '.';
 export declare type ActivityState = {
     attempts: number;
     completedAttempts: number;
-    currentAttempt?: XapiStatement;
-    currentAttemptCompleted?: XapiStatement;
-    currentAttemptStatements: XapiStatement[];
-    mostRecentAttemptWithCompleted?: XapiStatement;
-    mostRecentAttemptWithCompletedCompleted?: XapiStatement;
+    currentAttempt?: UXapiStatement;
+    currentAttemptCompleted?: UXapiStatement;
+    currentAttemptStatements: UXapiStatement[];
+    mostRecentAttemptWithCompleted?: UXapiStatement;
+    mostRecentAttemptWithCompletedCompleted?: UXapiStatement;
 };
-export declare const matchAttempt: (statement: XapiStatement) => boolean;
-export declare const matchAttemptCompleted: (attempt: XapiStatement) => (statement: XapiStatement) => boolean;
-export declare const resolveAttempts: (statements: XapiStatement[], options?: {
+export declare const matchAttempt: (statement: UXapiStatement) => boolean;
+export declare const matchAttemptCompleted: (attempt: UXapiStatement) => (statement: UXapiStatement) => boolean;
+export declare const resolveAttempts: (statements: UXapiStatement[], options?: {
     activityIRI?: string | undefined;
     parentActivityAttempt?: string | undefined;
-} | undefined) => XapiStatement[];
-export declare const resolveCompletedForAttempt: (statements: XapiStatement[], attempt: XapiStatement, activityIRI?: string | undefined) => XapiStatement | undefined;
-export declare const oldestStatement: (statements: XapiStatement[]) => XapiStatement | undefined;
-export declare const mostRecentStatement: (statements: XapiStatement[]) => XapiStatement | undefined;
-export declare const resolveAttemptInfo: (statements: XapiStatement[], options?: {
+} | undefined) => UXapiStatement[];
+export declare const resolveCompletedForAttempt: (statements: UXapiStatement[], attempt: UXapiStatement, activityIRI?: string | undefined) => UXapiStatement | undefined;
+export declare const oldestStatement: (statements: UXapiStatement[]) => UXapiStatement | undefined;
+export declare const mostRecentStatement: (statements: UXapiStatement[]) => UXapiStatement | undefined;
+export declare const resolveAttemptInfo: (statements: UXapiStatement[], options?: {
     activityIRI?: string | undefined;
     currentAttempt?: string | undefined;
     parentActivityAttempt?: string | undefined;
@@ -28,20 +28,20 @@ export declare const loadStatementsForActivityAndFirstChildren: (gateway: LrsGat
     attempt?: string | undefined;
     ensureSync?: boolean | undefined;
     user?: string | undefined;
-} | undefined) => Promise<XapiStatement[]>;
+} | undefined) => Promise<import(".").XapiStatement[]>;
 export declare const loadActivityAttemptInfo: (gateway: LrsGateway, activityIRI: string, options?: {
     currentAttempt?: string | undefined;
     parentActivityAttempt?: string | undefined;
     ensureSync?: boolean | undefined;
 } | undefined) => Promise<ActivityState>;
-export declare const createStatement: (verb: XapiStatement['verb'], activity: {
+export declare const createStatement: (verb: UXapiStatement['verb'], activity: {
     iri: string;
     type: string;
     name: string;
     extensions?: {
         [key: string]: string;
     } | undefined;
-}, attempt: string, parentActivityIRI?: string | undefined) => Pick<XapiStatement, 'object' | 'verb' | 'context'>;
+}, attempt: string, parentActivityIRI?: string | undefined) => Pick<UXapiStatement, 'object' | 'verb' | 'context'>;
 export declare const createAttemptStatement: (activity: {
     iri: string;
     type: string;
@@ -52,7 +52,7 @@ export declare const createAttemptStatement: (activity: {
 }, parentActivity?: {
     iri?: string | undefined;
     attempt?: string | undefined;
-} | undefined) => Pick<XapiStatement, 'object' | 'verb' | 'context'>;
+} | undefined) => Pick<UXapiStatement, 'object' | 'verb' | 'context'>;
 export declare const putAttemptStatement: (gateway: LrsGateway, activity: {
     iri: string;
     type: string;
@@ -64,7 +64,7 @@ export declare const putAttemptStatement: (gateway: LrsGateway, activity: {
     iri?: string | undefined;
     attempt?: string | undefined;
 } | undefined) => Promise<import(".").EagerXapiStatement>;
-export declare const createAttemptActivityStatement: (attemptStatement: XapiStatement, verb: XapiStatement['verb'], result?: XapiStatement['result']) => Pick<XapiStatement, 'object' | 'verb' | 'context' | 'result'>;
-export declare const putAttemptActivityStatement: (gateway: LrsGateway, attemptStatement: XapiStatement, verb: XapiStatement['verb'], result?: XapiStatement['result']) => Promise<import(".").EagerXapiStatement>;
-export declare const createCompletedStatement: (attemptStatement: XapiStatement, result?: XapiStatement['result']) => Pick<XapiStatement, 'object' | 'verb' | 'context' | 'result'>;
-export declare const putCompletedStatement: (gateway: LrsGateway, attemptStatement: XapiStatement, result: XapiStatement['result']) => Promise<import(".").EagerXapiStatement>;
+export declare const createAttemptActivityStatement: (attemptStatement: UXapiStatement, verb: UXapiStatement['verb'], result?: UXapiStatement['result']) => Pick<UXapiStatement, 'object' | 'verb' | 'context' | 'result'>;
+export declare const putAttemptActivityStatement: (gateway: LrsGateway, attemptStatement: UXapiStatement, verb: UXapiStatement['verb'], result?: UXapiStatement['result']) => Promise<import(".").EagerXapiStatement>;
+export declare const createCompletedStatement: (attemptStatement: UXapiStatement, result?: UXapiStatement['result']) => Pick<UXapiStatement, 'object' | 'verb' | 'context' | 'result'>;
+export declare const putCompletedStatement: (gateway: LrsGateway, attemptStatement: UXapiStatement, result: UXapiStatement['result']) => Promise<import(".").EagerXapiStatement>;

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

@@ -32,8 +32,8 @@ export const resolveAttempts = (statements, options) => statements.filter(statem
 });
 export const resolveCompletedForAttempt = (statements, attempt, activityIRI) => statements.find(statement => matchAttemptCompleted(attempt)(statement)
     && (!activityIRI || statement.object.id === activityIRI));
-export const oldestStatement = (statements) => statements.reduce((result, statement) => result && isBefore(parseISO(result.stored || result.timestamp), parseISO(statement.timestamp)) ? result : statement, statements[0]);
-export const mostRecentStatement = (statements) => statements.reduce((result, statement) => result && isAfter(parseISO(result.stored || result.timestamp), parseISO(statement.timestamp)) ? result : statement, statements[0]);
+export const oldestStatement = (statements) => statements.reduce((result, statement) => result && isBefore(parseISO('stored' in result && result.stored ? result.stored : result.timestamp), parseISO(statement.timestamp)) ? result : statement, statements[0]);
+export const mostRecentStatement = (statements) => statements.reduce((result, statement) => result && isAfter(parseISO('stored' in result && result.stored ? result.stored : result.timestamp), parseISO(statement.timestamp)) ? result : statement, statements[0]);
 export const resolveAttemptInfo = (statements, options) => {
     // TODO optimize. i'm 100% that this could all be done in one iteration but i'm not messing around with that for now.
     const attempts = resolveAttempts(statements, options);

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

@@ -74,15 +74,16 @@ export interface XapiStatement {
 }
 export declare type SavedXapiStatement = WithRequired<XapiStatement, 'stored'>;
 export declare type EagerXapiStatement = Omit<XapiStatement, 'stored'>;
+export declare type UXapiStatement = XapiStatement | EagerXapiStatement | SavedXapiStatement;
 export declare type LrsGateway = ReturnType<ReturnType<ReturnType<typeof lrsGateway>>>;
 export declare type LrsProvider = ReturnType<ReturnType<typeof lrsGateway>>;
 export declare const lrsGateway: <C extends string = "lrs">(initializer: Initializer<C>) => (configProvider: { [key in C]: {
     lrsHost: import("../../config").ConfigValueProvider<string>;
     lrsAuthorization: import("../../config").ConfigValueProvider<string>;
 }; }) => (authProvider: AuthProvider) => {
-    putXapiStatements: (statements: Array<Pick<XapiStatement, 'object' | 'verb' | 'context' | 'result'> & {
+    putXapiStatements: (statements: Array<(Pick<XapiStatement, 'object' | 'verb' | 'context' | 'result'> & {
         id?: string;
-    }>) => Promise<EagerXapiStatement[]>;
+    }) | UXapiStatement>) => Promise<EagerXapiStatement[]>;
     getXapiStatements: (params: {
         verb?: string | undefined;
         activity?: string | undefined;

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

@@ -1,4 +1,3 @@
-import formatISO from 'date-fns/formatISO';
 import * as queryString from 'query-string';
 import { once, retryWithDelay } from '../..';
 import { assertDefined } from '../../assertions';
@@ -7,6 +6,7 @@ import { UnauthorizedError } from '../../errors';
 import { fetchStatusRetry } from '../../fetch/fetchStatusRetry';
 import { ifDefined } from '../../guards';
 import { METHOD } from '../../routing';
+import { addStatementDefaultFields } from './addStatementDefaultFields';
 export const lrsGateway = (initializer) => (configProvider) => {
     const config = configProvider[ifDefined(initializer.configSpace, 'lrs')];
     const lrsHost = once(() => resolveConfigValue(config.lrsHost));
@@ -16,17 +16,7 @@ export const lrsGateway = (initializer) => (configProvider) => {
         // Note: This method actually uses POST
         const putXapiStatements = async (statements) => {
             const user = assertDefined(await authProvider.getUser(), new UnauthorizedError);
-            const statementsWithDefaults = statements.map(statement => ({
-                ...statement,
-                actor: {
-                    account: {
-                        homePage: 'https://openstax.org',
-                        name: user.uuid,
-                    },
-                    objectType: 'Agent',
-                },
-                timestamp: formatISO(new Date())
-            }));
+            const statementsWithDefaults = statements.map(statement => addStatementDefaultFields(statement, user));
             const response = await fetcher((await lrsHost()).replace(/\/+$/, '') + '/data/xAPI/statements', {
                 body: JSON.stringify(statementsWithDefaults),
                 headers: {
@@ -41,8 +31,8 @@ export const lrsGateway = (initializer) => (configProvider) => {
 
 ${await response.text()}`);
             }
-            const ids = await response.json();
-            return ids.map((id, index) => ({ id, ...statementsWithDefaults[index] }));
+            await response.json();
+            return statementsWithDefaults;
         };
         // Note: This code does not currently handle a single statement response,
         // which can return 404 if the statement is not found