@openstax/ts-utils 1.20.0 → 1.20.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,5 @@
1
+ import { XapiStatement, EagerXapiStatement } from ".";
2
+ import { User } from "../authProvider";
3
+ export declare const addStatementDefaultFields: (statement: Pick<XapiStatement, 'object' | 'verb' | 'context' | 'result'> & {
4
+ id?: string;
5
+ }, user: User) => EagerXapiStatement;
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.addStatementDefaultFields = void 0;
7
+ const formatISO_1 = __importDefault(require("date-fns/formatISO"));
8
+ const uuid_1 = require("uuid");
9
+ const addStatementDefaultFields = (statement, user) => ({
10
+ id: (0, uuid_1.v4)(),
11
+ ...statement,
12
+ actor: {
13
+ account: {
14
+ homePage: 'https://openstax.org',
15
+ name: user.uuid,
16
+ },
17
+ objectType: 'Agent',
18
+ },
19
+ timestamp: (0, formatISO_1.default)(new Date())
20
+ });
21
+ exports.addStatementDefaultFields = addStatementDefaultFields;
@@ -80,9 +80,9 @@ export declare const lrsGateway: <C extends string = "lrs">(initializer: Initial
80
80
  lrsHost: import("../../config").ConfigValueProvider<string>;
81
81
  lrsAuthorization: import("../../config").ConfigValueProvider<string>;
82
82
  }; }) => (authProvider: AuthProvider) => {
83
- putXapiStatements: (statements: Array<Pick<XapiStatement, 'object' | 'verb' | 'context' | 'result'> & {
83
+ putXapiStatements: (statements: Array<(Pick<XapiStatement, 'object' | 'verb' | 'context' | 'result'> & {
84
84
  id?: string;
85
- }>) => Promise<EagerXapiStatement[]>;
85
+ }) | EagerXapiStatement>) => Promise<EagerXapiStatement[]>;
86
86
  getXapiStatements: (params: {
87
87
  verb?: string | undefined;
88
88
  activity?: string | undefined;
@@ -22,12 +22,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
22
22
  __setModuleDefault(result, mod);
23
23
  return result;
24
24
  };
25
- var __importDefault = (this && this.__importDefault) || function (mod) {
26
- return (mod && mod.__esModule) ? mod : { "default": mod };
27
- };
28
25
  Object.defineProperty(exports, "__esModule", { value: true });
29
26
  exports.lrsGateway = void 0;
30
- const formatISO_1 = __importDefault(require("date-fns/formatISO"));
31
27
  const queryString = __importStar(require("query-string"));
32
28
  const __1 = require("../..");
33
29
  const assertions_1 = require("../../assertions");
@@ -36,6 +32,7 @@ const errors_1 = require("../../errors");
36
32
  const fetchStatusRetry_1 = require("../../fetch/fetchStatusRetry");
37
33
  const guards_1 = require("../../guards");
38
34
  const routing_1 = require("../../routing");
35
+ const addStatementDefaultFields_1 = require("./addStatementDefaultFields");
39
36
  const lrsGateway = (initializer) => (configProvider) => {
40
37
  const config = configProvider[(0, guards_1.ifDefined)(initializer.configSpace, 'lrs')];
41
38
  const lrsHost = (0, __1.once)(() => (0, config_1.resolveConfigValue)(config.lrsHost));
@@ -45,17 +42,7 @@ const lrsGateway = (initializer) => (configProvider) => {
45
42
  // Note: This method actually uses POST
46
43
  const putXapiStatements = async (statements) => {
47
44
  const user = (0, assertions_1.assertDefined)(await authProvider.getUser(), new errors_1.UnauthorizedError);
48
- const statementsWithDefaults = statements.map(statement => ({
49
- ...statement,
50
- actor: {
51
- account: {
52
- homePage: 'https://openstax.org',
53
- name: user.uuid,
54
- },
55
- objectType: 'Agent',
56
- },
57
- timestamp: (0, formatISO_1.default)(new Date())
58
- }));
45
+ const statementsWithDefaults = statements.map(statement => (0, addStatementDefaultFields_1.addStatementDefaultFields)(statement, user));
59
46
  const response = await fetcher((await lrsHost()).replace(/\/+$/, '') + '/data/xAPI/statements', {
60
47
  body: JSON.stringify(statementsWithDefaults),
61
48
  headers: {
@@ -70,8 +57,8 @@ const lrsGateway = (initializer) => (configProvider) => {
70
57
 
71
58
  ${await response.text()}`);
72
59
  }
73
- const ids = await response.json();
74
- return ids.map((id, index) => ({ id, ...statementsWithDefaults[index] }));
60
+ await response.json();
61
+ return statementsWithDefaults;
75
62
  };
76
63
  // Note: This code does not currently handle a single statement response,
77
64
  // which can return 404 if the statement is not found