@openstax/ts-utils 1.20.0 → 1.20.2

package/dist/cjs/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/cjs/services/lrsGateway/addStatementDefaultFields.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addStatementDefaultFields = void 0;
+const formatISO_1 = __importDefault(require("date-fns/formatISO"));
+const uuid_1 = require("uuid");
+const addStatementDefaultFields = (statement, user) => ({
+    id: (0, uuid_1.v4)(),
+    actor: {
+        account: {
+            homePage: 'https://openstax.org',
+            name: user.uuid,
+        },
+        objectType: 'Agent',
+    },
+    timestamp: (0, formatISO_1.default)(new Date()),
+    ...statement,
+});
+exports.addStatementDefaultFields = addStatementDefaultFields;

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

@@ -42,9 +42,9 @@ exports.resolveAttempts = resolveAttempts;
 const resolveCompletedForAttempt = (statements, attempt, activityIRI) => statements.find(statement => (0, exports.matchAttemptCompleted)(attempt)(statement)
     && (!activityIRI || statement.object.id === activityIRI));
 exports.resolveCompletedForAttempt = resolveCompletedForAttempt;
-const oldestStatement = (statements) => statements.reduce((result, statement) => result && (0, isBefore_1.default)((0, parseISO_1.default)(result.stored || result.timestamp), (0, parseISO_1.default)(statement.timestamp)) ? result : statement, statements[0]);
+const oldestStatement = (statements) => statements.reduce((result, statement) => result && (0, isBefore_1.default)((0, parseISO_1.default)('stored' in result && result.stored ? result.stored : result.timestamp), (0, parseISO_1.default)(statement.timestamp)) ? result : statement, statements[0]);
 exports.oldestStatement = oldestStatement;
-const mostRecentStatement = (statements) => statements.reduce((result, statement) => result && (0, isAfter_1.default)((0, parseISO_1.default)(result.stored || result.timestamp), (0, parseISO_1.default)(statement.timestamp)) ? result : statement, statements[0]);
+const mostRecentStatement = (statements) => statements.reduce((result, statement) => result && (0, isAfter_1.default)((0, parseISO_1.default)('stored' in result && result.stored ? result.stored : result.timestamp), (0, parseISO_1.default)(statement.timestamp)) ? result : statement, statements[0]);
 exports.mostRecentStatement = mostRecentStatement;
 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.

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

@@ -22,12 +22,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.lrsGateway = void 0;
-const formatISO_1 = __importDefault(require("date-fns/formatISO"));
 const queryString = __importStar(require("query-string"));
 const __1 = require("../..");
 const assertions_1 = require("../../assertions");
@@ -36,6 +32,7 @@ const errors_1 = require("../../errors");
 const fetchStatusRetry_1 = require("../../fetch/fetchStatusRetry");
 const guards_1 = require("../../guards");
 const routing_1 = require("../../routing");
+const addStatementDefaultFields_1 = require("./addStatementDefaultFields");
 const lrsGateway = (initializer) => (configProvider) => {
     const config = configProvider[(0, guards_1.ifDefined)(initializer.configSpace, 'lrs')];
     const lrsHost = (0, __1.once)(() => (0, config_1.resolveConfigValue)(config.lrsHost));
@@ -45,17 +42,7 @@ const lrsGateway = (initializer) => (configProvider) => {
         // Note: This method actually uses POST
         const putXapiStatements = async (statements) => {
             const user = (0, assertions_1.assertDefined)(await authProvider.getUser(), new errors_1.UnauthorizedError);
-            const statementsWithDefaults = statements.map(statement => ({
-                ...statement,
-                actor: {
-                    account: {
-                        homePage: 'https://openstax.org',
-                        name: user.uuid,
-                    },
-                    objectType: 'Agent',
-                },
-                timestamp: (0, formatISO_1.default)(new Date())
-            }));
+            const statementsWithDefaults = statements.map(statement => (0, addStatementDefaultFields_1.addStatementDefaultFields)(statement, user));
             const response = await fetcher((await lrsHost()).replace(/\/+$/, '') + '/data/xAPI/statements', {
                 body: JSON.stringify(statementsWithDefaults),
                 headers: {
@@ -70,8 +57,8 @@ 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