@openstax/ts-utils 1.28.1 → 1.30.0

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.
Files changed (117) hide show
  1. package/dist/cjs/assertions/index.d.ts +7 -3
  2. package/dist/cjs/config/envConfig.d.ts +1 -1
  3. package/dist/cjs/config/index.d.ts +7 -7
  4. package/dist/cjs/config/resolveConfigValue.d.ts +2 -2
  5. package/dist/cjs/fetch/index.d.ts +16 -16
  6. package/dist/cjs/fetch/index.js +1 -1
  7. package/dist/cjs/middleware/apiErrorHandler.d.ts +3 -3
  8. package/dist/cjs/middleware/apiSlowResponseMiddleware.d.ts +1 -1
  9. package/dist/cjs/middleware/index.d.ts +7 -7
  10. package/dist/cjs/middleware/lambdaCorsResponseMiddleware.d.ts +1 -1
  11. package/dist/cjs/misc/hashValue.d.ts +2 -2
  12. package/dist/cjs/misc/helpers.d.ts +11 -11
  13. package/dist/cjs/misc/merge.d.ts +2 -2
  14. package/dist/cjs/misc/partitionSequence.d.ts +2 -2
  15. package/dist/cjs/pagination/index.d.ts +1 -1
  16. package/dist/cjs/routing/index.d.ts +30 -30
  17. package/dist/cjs/routing/index.js +18 -8
  18. package/dist/cjs/routing/validators/zod.d.ts +1 -1
  19. package/dist/cjs/routing/validators/zod.js +3 -1
  20. package/dist/cjs/services/accountsGateway/index.d.ts +17 -20
  21. package/dist/cjs/services/apiGateway/index.d.ts +10 -10
  22. package/dist/cjs/services/apiGateway/index.js +17 -7
  23. package/dist/cjs/services/authProvider/browser.d.ts +5 -7
  24. package/dist/cjs/services/authProvider/decryption.d.ts +3 -7
  25. package/dist/cjs/services/authProvider/index.d.ts +8 -8
  26. package/dist/cjs/services/authProvider/subrequest.d.ts +2 -5
  27. package/dist/cjs/services/authProvider/utils/decryptAndVerify.d.ts +1 -2
  28. package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.d.ts +4 -4
  29. package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.js +1 -1
  30. package/dist/cjs/services/authProvider/utils/userRoleValidator.d.ts +2 -2
  31. package/dist/cjs/services/documentStore/index.d.ts +7 -7
  32. package/dist/cjs/services/documentStore/unversioned/dynamodb.d.ts +7 -9
  33. package/dist/cjs/services/documentStore/unversioned/file-system.d.ts +7 -9
  34. package/dist/cjs/services/documentStore/unversioned/file-system.js +17 -7
  35. package/dist/cjs/services/documentStore/unversioned/index.d.ts +1 -1
  36. package/dist/cjs/services/documentStore/versioned/dynamodb.d.ts +7 -9
  37. package/dist/cjs/services/documentStore/versioned/file-system.d.ts +6 -8
  38. package/dist/cjs/services/documentStore/versioned/index.d.ts +4 -4
  39. package/dist/cjs/services/exercisesGateway/index.d.ts +9 -13
  40. package/dist/cjs/services/exercisesGateway/index.js +17 -7
  41. package/dist/cjs/services/fileServer/index.d.ts +2 -3
  42. package/dist/cjs/services/fileServer/localFileServer.d.ts +2 -6
  43. package/dist/cjs/services/fileServer/s3FileServer.d.ts +2 -5
  44. package/dist/cjs/services/launchParams/signer.d.ts +4 -9
  45. package/dist/cjs/services/launchParams/verifier.d.ts +5 -6
  46. package/dist/cjs/services/launchParams/verifier.js +29 -11
  47. package/dist/cjs/services/logger/index.d.ts +2 -2
  48. package/dist/cjs/services/logger/index.js +1 -1
  49. package/dist/cjs/services/lrsGateway/addStatementDefaultFields.d.ts +1 -1
  50. package/dist/cjs/services/lrsGateway/attempt-utils.d.ts +34 -34
  51. package/dist/cjs/services/lrsGateway/file-system.d.ts +2 -4
  52. package/dist/cjs/services/lrsGateway/file-system.js +17 -7
  53. package/dist/cjs/services/lrsGateway/index.d.ts +29 -32
  54. package/dist/cjs/services/lrsGateway/index.js +17 -7
  55. package/dist/cjs/services/lrsGateway/xapiUtils.d.ts +23 -23
  56. package/dist/cjs/services/postgresConnection/index.d.ts +3 -10
  57. package/dist/cjs/services/searchProvider/index.d.ts +7 -7
  58. package/dist/cjs/services/searchProvider/memorySearchTheBadWay.d.ts +1 -1
  59. package/dist/cjs/services/searchProvider/openSearch.d.ts +3 -6
  60. package/dist/cjs/services/searchProvider/openSearch.js +7 -3
  61. package/dist/cjs/tsconfig.without-specs.cjs.tsbuildinfo +1 -1
  62. package/dist/cjs/types.d.ts +5 -5
  63. package/dist/esm/assertions/index.d.ts +7 -3
  64. package/dist/esm/config/envConfig.d.ts +1 -1
  65. package/dist/esm/config/index.d.ts +7 -7
  66. package/dist/esm/config/resolveConfigValue.d.ts +2 -2
  67. package/dist/esm/fetch/index.d.ts +16 -16
  68. package/dist/esm/middleware/apiErrorHandler.d.ts +3 -3
  69. package/dist/esm/middleware/apiSlowResponseMiddleware.d.ts +1 -1
  70. package/dist/esm/middleware/index.d.ts +7 -7
  71. package/dist/esm/middleware/lambdaCorsResponseMiddleware.d.ts +1 -1
  72. package/dist/esm/misc/hashValue.d.ts +2 -2
  73. package/dist/esm/misc/helpers.d.ts +11 -11
  74. package/dist/esm/misc/merge.d.ts +2 -2
  75. package/dist/esm/misc/partitionSequence.d.ts +2 -2
  76. package/dist/esm/pagination/index.d.ts +1 -1
  77. package/dist/esm/routing/index.d.ts +30 -30
  78. package/dist/esm/routing/validators/zod.d.ts +1 -1
  79. package/dist/esm/routing/validators/zod.js +3 -1
  80. package/dist/esm/services/accountsGateway/index.d.ts +17 -20
  81. package/dist/esm/services/apiGateway/index.d.ts +10 -10
  82. package/dist/esm/services/authProvider/browser.d.ts +5 -7
  83. package/dist/esm/services/authProvider/decryption.d.ts +3 -7
  84. package/dist/esm/services/authProvider/index.d.ts +8 -8
  85. package/dist/esm/services/authProvider/subrequest.d.ts +2 -5
  86. package/dist/esm/services/authProvider/utils/decryptAndVerify.d.ts +1 -2
  87. package/dist/esm/services/authProvider/utils/embeddedAuthProvider.d.ts +4 -4
  88. package/dist/esm/services/authProvider/utils/userRoleValidator.d.ts +2 -2
  89. package/dist/esm/services/documentStore/index.d.ts +7 -7
  90. package/dist/esm/services/documentStore/unversioned/dynamodb.d.ts +7 -9
  91. package/dist/esm/services/documentStore/unversioned/file-system.d.ts +7 -9
  92. package/dist/esm/services/documentStore/unversioned/index.d.ts +1 -1
  93. package/dist/esm/services/documentStore/versioned/dynamodb.d.ts +7 -9
  94. package/dist/esm/services/documentStore/versioned/file-system.d.ts +6 -8
  95. package/dist/esm/services/documentStore/versioned/index.d.ts +4 -4
  96. package/dist/esm/services/exercisesGateway/index.d.ts +9 -13
  97. package/dist/esm/services/fileServer/index.d.ts +2 -3
  98. package/dist/esm/services/fileServer/localFileServer.d.ts +2 -6
  99. package/dist/esm/services/fileServer/s3FileServer.d.ts +2 -5
  100. package/dist/esm/services/launchParams/signer.d.ts +4 -9
  101. package/dist/esm/services/launchParams/verifier.d.ts +5 -6
  102. package/dist/esm/services/launchParams/verifier.js +12 -4
  103. package/dist/esm/services/logger/index.d.ts +2 -2
  104. package/dist/esm/services/lrsGateway/addStatementDefaultFields.d.ts +1 -1
  105. package/dist/esm/services/lrsGateway/attempt-utils.d.ts +34 -34
  106. package/dist/esm/services/lrsGateway/file-system.d.ts +2 -4
  107. package/dist/esm/services/lrsGateway/index.d.ts +29 -32
  108. package/dist/esm/services/lrsGateway/xapiUtils.d.ts +23 -23
  109. package/dist/esm/services/postgresConnection/index.d.ts +3 -10
  110. package/dist/esm/services/searchProvider/index.d.ts +7 -7
  111. package/dist/esm/services/searchProvider/memorySearchTheBadWay.d.ts +1 -1
  112. package/dist/esm/services/searchProvider/openSearch.d.ts +3 -6
  113. package/dist/esm/services/searchProvider/openSearch.js +7 -3
  114. package/dist/esm/tsconfig.without-specs.esm.tsbuildinfo +1 -1
  115. package/dist/esm/types.d.ts +5 -5
  116. package/package.json +6 -6
  117. package/script/bin/.init-params-script.bash.swp +0 -0
@@ -1,6 +1,6 @@
1
1
  import { ConfigProviderForConfig } from '../../config';
2
2
  import { GenericFetch } from '../../fetch';
3
- export declare type Config = {
3
+ export type Config = {
4
4
  defaultCorrectness?: string;
5
5
  exercisesHost: string;
6
6
  exercisesAuthToken: string;
@@ -9,18 +9,18 @@ interface Initializer<C> {
9
9
  configSpace?: C;
10
10
  fetch: GenericFetch;
11
11
  }
12
- export declare type Answer = {
12
+ export type Answer = {
13
13
  id: number;
14
14
  content_html: string;
15
15
  correctness?: string;
16
16
  feedback_html?: string;
17
17
  };
18
- export declare type Solution = {
18
+ export type Solution = {
19
19
  images: any[];
20
20
  solution_type: string;
21
21
  content_html: string;
22
22
  };
23
- export declare type Question = {
23
+ export type Question = {
24
24
  id: number;
25
25
  is_answer_order_important: boolean;
26
26
  stimulus_html: string;
@@ -32,7 +32,7 @@ export declare type Question = {
32
32
  collaborator_solutions?: Solution[];
33
33
  community_solutions?: Solution[];
34
34
  };
35
- export declare type Exercise = {
35
+ export type Exercise = {
36
36
  images: any[];
37
37
  tags: string[];
38
38
  uuid: string;
@@ -51,21 +51,17 @@ export declare type Exercise = {
51
51
  versions: number[];
52
52
  stimulus_html: string;
53
53
  };
54
- export declare type ExercisesSearchResults = {
54
+ export type ExercisesSearchResults = {
55
55
  total_count: number;
56
56
  items: Exercise[];
57
57
  };
58
- export declare type ExercisesSearchResultsWithDigest = ExercisesSearchResults & {
58
+ export type ExercisesSearchResultsWithDigest = ExercisesSearchResults & {
59
59
  digest: string;
60
60
  };
61
- export declare const exercisesGateway: <C extends string = "exercises">(initializer: Initializer<C>) => (configProvider: { [key in C]: {
62
- defaultCorrectness?: import("../../config").ConfigValueProvider<string> | undefined;
63
- exercisesHost: import("../../config").ConfigValueProvider<string>;
64
- exercisesAuthToken: import("../../config").ConfigValueProvider<string>;
65
- }; }) => (_: {}) => {
61
+ export declare const exercisesGateway: <C extends string = "exercises">(initializer: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => (_: {}) => {
66
62
  searchDigest: (query: string, page?: number, per_page?: number) => Promise<string>;
67
63
  get: (uuid: string) => Promise<Exercise | undefined>;
68
64
  search: (query: string, page?: number, per_page?: number) => Promise<ExercisesSearchResultsWithDigest>;
69
65
  };
70
- export declare type ExercisesGateway = ReturnType<ReturnType<ReturnType<typeof exercisesGateway>>>;
66
+ export type ExercisesGateway = ReturnType<ReturnType<ReturnType<typeof exercisesGateway>>>;
71
67
  export {};
@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
15
15
  }) : function(o, v) {
16
16
  o["default"] = v;
17
17
  });
18
- var __importStar = (this && this.__importStar) || function (mod) {
19
- if (mod && mod.__esModule) return mod;
20
- var result = {};
21
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
- __setModuleDefault(result, mod);
23
- return result;
24
- };
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
25
35
  Object.defineProperty(exports, "__esModule", { value: true });
26
36
  exports.exercisesGateway = void 0;
27
37
  const queryString = __importStar(require("query-string"));
@@ -1,11 +1,10 @@
1
- /// <reference types="node" />
2
- export declare type FileValue = {
1
+ export type FileValue = {
3
2
  dataType: 'file';
4
3
  mimeType: string;
5
4
  path: string;
6
5
  label: string;
7
6
  };
8
- export declare type FolderValue = {
7
+ export type FolderValue = {
9
8
  dataType: 'folder';
10
9
  files: FileValue[];
11
10
  };
@@ -1,6 +1,6 @@
1
1
  import { ConfigProviderForConfig } from '../../config';
2
2
  import { FileServerAdapter } from '.';
3
- export declare type Config = {
3
+ export type Config = {
4
4
  port?: string;
5
5
  host?: string;
6
6
  storagePrefix: string;
@@ -9,9 +9,5 @@ interface Initializer<C> {
9
9
  dataDir: string;
10
10
  configSpace?: C;
11
11
  }
12
- export declare const localFileServer: <C extends string = "local">(initializer: Initializer<C>) => (configProvider: { [key in C]: {
13
- port?: import("../../config").ConfigValueProvider<string> | undefined;
14
- host?: import("../../config").ConfigValueProvider<string> | undefined;
15
- storagePrefix: import("../../config").ConfigValueProvider<string>;
16
- }; }) => FileServerAdapter;
12
+ export declare const localFileServer: <C extends string = "local">(initializer: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => FileServerAdapter;
17
13
  export {};
@@ -1,7 +1,7 @@
1
1
  import { S3Client } from '@aws-sdk/client-s3';
2
2
  import { ConfigProviderForConfig } from '../../config';
3
3
  import { FileServerAdapter } from '.';
4
- export declare type Config = {
4
+ export type Config = {
5
5
  bucketName: string;
6
6
  bucketRegion: string;
7
7
  };
@@ -9,8 +9,5 @@ interface Initializer<C> {
9
9
  configSpace?: C;
10
10
  getS3Client?: (...args: ConstructorParameters<typeof S3Client>) => S3Client;
11
11
  }
12
- export declare const s3FileServer: <C extends string = "deployed">(initializer: Initializer<C>) => (configProvider: { [key in C]: {
13
- bucketName: import("../../config").ConfigValueProvider<string>;
14
- bucketRegion: import("../../config").ConfigValueProvider<string>;
15
- }; }) => FileServerAdapter;
12
+ export declare const s3FileServer: <C extends string = "deployed">(initializer: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => FileServerAdapter;
16
13
  export {};
@@ -1,7 +1,7 @@
1
1
  import { JWK } from 'node-jose';
2
2
  import { ConfigProviderForConfig } from '../../config';
3
3
  import type { JsonCompatibleValue } from '../../routing';
4
- declare type Config = {
4
+ type Config = {
5
5
  alg: string;
6
6
  expiresIn: string;
7
7
  iss: string;
@@ -13,16 +13,11 @@ interface Initializer<C> {
13
13
  /**
14
14
  * Creates a class that can sign launch params
15
15
  */
16
- export declare const createLaunchSigner: <C extends string = "launch">({ configSpace }: Initializer<C>) => (configProvider: { [key in C]: {
17
- alg: import("../../config").ConfigValueProvider<string>;
18
- expiresIn: import("../../config").ConfigValueProvider<string>;
19
- iss: import("../../config").ConfigValueProvider<string>;
20
- privateKey: import("../../config").ConfigValueProvider<string>;
21
- }; }) => {
16
+ export declare const createLaunchSigner: <C extends string = "launch">({ configSpace }: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => {
22
17
  jwks: () => Promise<{
23
18
  keys: JWK.RawKey[];
24
19
  }>;
25
- sign: (data: Record<string, JsonCompatibleValue>, subject: string, maxExp?: number | null | undefined) => Promise<string>;
20
+ sign: (data: Record<string, JsonCompatibleValue>, subject: string, maxExp?: number | null) => Promise<string>;
26
21
  };
27
- export declare type LaunchSigner = ReturnType<ReturnType<typeof createLaunchSigner>>;
22
+ export type LaunchSigner = ReturnType<ReturnType<typeof createLaunchSigner>>;
28
23
  export {};
@@ -1,8 +1,9 @@
1
1
  import jwt from 'jsonwebtoken';
2
2
  import type { JWK } from 'node-jose';
3
3
  import { ConfigProviderForConfig } from '../../config';
4
- declare type Config = {
4
+ type Config = {
5
5
  trustedDomain: string;
6
+ bypassSignatureVerification: string;
6
7
  };
7
8
  interface Initializer<C> {
8
9
  configSpace?: C;
@@ -13,10 +14,8 @@ interface Initializer<C> {
13
14
  /**
14
15
  * Creates a class that can verify launch params
15
16
  */
16
- export declare const createLaunchVerifier: <C extends string = "launch">({ configSpace, fetcher }: Initializer<C>) => (configProvider: { [key in C]: {
17
- trustedDomain: import("../../config").ConfigValueProvider<string>;
18
- }; }) => (_services: {}, getDefaultToken?: (() => string) | undefined) => {
19
- verify: <T = undefined>(...args: T extends undefined ? [] | [string] : [(input: any) => T] | [string, (input: any) => T]) => Promise<T extends undefined ? jwt.JwtPayload : T>;
17
+ export declare const createLaunchVerifier: <C extends string = "launch">({ configSpace, fetcher }: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => (_services: {}, getDefaultToken?: () => string) => {
18
+ verify: <T = undefined>(...args: T extends undefined ? ([] | [string]) : ([(input: any) => T] | [string, (input: any) => T])) => Promise<T extends undefined ? jwt.JwtPayload : T>;
20
19
  };
21
- export declare type LaunchVerifier = ReturnType<ReturnType<ReturnType<typeof createLaunchVerifier>>>;
20
+ export type LaunchVerifier = ReturnType<ReturnType<ReturnType<typeof createLaunchVerifier>>>;
22
21
  export {};
@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
15
15
  }) : function(o, v) {
16
16
  o["default"] = v;
17
17
  });
18
- var __importStar = (this && this.__importStar) || function (mod) {
19
- if (mod && mod.__esModule) return mod;
20
- var result = {};
21
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
- __setModuleDefault(result, mod);
23
- return result;
24
- };
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
25
35
  Object.defineProperty(exports, "__esModule", { value: true });
26
36
  exports.createLaunchVerifier = void 0;
27
37
  const jsonwebtoken_1 = __importStar(require("jsonwebtoken"));
@@ -37,6 +47,7 @@ const helpers_1 = require("../../misc/helpers");
37
47
  const createLaunchVerifier = ({ configSpace, fetcher }) => (configProvider) => {
38
48
  const config = configProvider[(0, guards_1.ifDefined)(configSpace, 'launch')];
39
49
  const getTrustedDomain = (0, helpers_1.once)(() => (0, config_1.resolveConfigValue)(config.trustedDomain));
50
+ const getBypassSignatureVerification = (0, helpers_1.once)(async () => (await (0, config_1.resolveConfigValue)(config.bypassSignatureVerification)) === 'true');
40
51
  const getJwksClient = (0, __1.memoize)((jwksUri) => new jwks_rsa_1.JwksClient({ fetcher, jwksUri }));
41
52
  const getJwksKey = (0, __1.memoize)(async (jwksUri, kid) => {
42
53
  const client = getJwksClient(jwksUri);
@@ -63,25 +74,26 @@ const createLaunchVerifier = ({ configSpace, fetcher }) => (configProvider) => {
63
74
  }
64
75
  };
65
76
  return (_services, getDefaultToken) => {
66
- const verify = (...args) => {
77
+ const verify = async (...args) => {
67
78
  const [inputToken, validator] = args.length === 1
68
79
  ? typeof args[0] === 'string'
69
80
  ? [args[0], undefined]
70
81
  : [undefined, args[0]]
71
82
  : args;
83
+ const bypassSignatureVerification = await getBypassSignatureVerification();
72
84
  return new Promise((resolve, reject) => {
73
85
  const token = inputToken !== null && inputToken !== void 0 ? inputToken : getDefaultToken === null || getDefaultToken === void 0 ? void 0 : getDefaultToken();
74
86
  if (!token) {
75
87
  return reject(new errors_1.InvalidRequestError('Missing token for launch verification'));
76
88
  }
77
- return jsonwebtoken_1.default.verify(token, getKey, {}, (err, payload) => {
89
+ const resolvePayload = (err, payload) => {
78
90
  if (err && err instanceof jsonwebtoken_1.TokenExpiredError) {
79
91
  reject(new errors_1.SessionExpiredError());
80
92
  }
81
93
  else if (err) {
82
94
  reject(err);
83
95
  }
84
- else if (typeof payload !== 'object') {
96
+ else if (typeof payload !== 'object' || payload === null) {
85
97
  reject(new Error('received JWT token with unexpected non-JSON payload'));
86
98
  }
87
99
  else if (!payload.sub) {
@@ -102,7 +114,13 @@ const createLaunchVerifier = ({ configSpace, fetcher }) => (configProvider) => {
102
114
  // conditional return types are annoying
103
115
  resolve((validator ? validator(parsed) : parsed));
104
116
  }
105
- });
117
+ };
118
+ if (bypassSignatureVerification) {
119
+ return resolvePayload(null, jsonwebtoken_1.default.decode(token));
120
+ }
121
+ else {
122
+ return jsonwebtoken_1.default.verify(token, getKey, {}, resolvePayload);
123
+ }
106
124
  });
107
125
  };
108
126
  return { verify };
@@ -13,7 +13,7 @@ export declare enum Level {
13
13
  * @param level - log level
14
14
  * @param event - event to log
15
15
  */
16
- export declare type LogEvent = (level: Level, event: JsonCompatibleStruct) => void;
16
+ export type LogEvent = (level: Level, event: JsonCompatibleStruct) => void;
17
17
  /**
18
18
  * A logger that can be used to log events.
19
19
  *
@@ -36,4 +36,4 @@ export interface Logger {
36
36
  * (the context is returned when messages are logged with the logger)
37
37
  * @returns a Logger
38
38
  */
39
- export declare const createCoreLogger: (driver: LogEvent, getParentContext?: (() => JsonCompatibleStruct) | undefined) => Logger;
39
+ export declare const createCoreLogger: (driver: LogEvent, getParentContext?: () => JsonCompatibleStruct) => Logger;
@@ -9,7 +9,7 @@ var Level;
9
9
  Level["Info"] = "info";
10
10
  Level["Warn"] = "warn";
11
11
  Level["Error"] = "error";
12
- })(Level = exports.Level || (exports.Level = {}));
12
+ })(Level || (exports.Level = Level = {}));
13
13
  /**
14
14
  * Creates a logger that logs events using the given driver and context provider.
15
15
  *
@@ -1,5 +1,5 @@
1
1
  import { User } from '../authProvider';
2
2
  import { EagerXapiStatement, UXapiStatement, XapiStatement } from '.';
3
- export declare const addStatementDefaultFields: (statement: (Pick<XapiStatement, 'object' | 'verb' | 'context' | 'result'> & {
3
+ export declare const addStatementDefaultFields: (statement: (Pick<XapiStatement, "object" | "verb" | "context" | "result"> & {
4
4
  id?: string;
5
5
  }) | UXapiStatement, user: User) => EagerXapiStatement;
@@ -1,5 +1,5 @@
1
1
  import { LrsGateway, UXapiStatement } from '.';
2
- export declare type ActivityState = {
2
+ export type ActivityState = {
3
3
  attempts: number;
4
4
  completedAttempts: number;
5
5
  currentAttempt?: UXapiStatement;
@@ -11,60 +11,60 @@ export declare type ActivityState = {
11
11
  export declare const matchAttempt: (statement: UXapiStatement) => boolean;
12
12
  export declare const matchAttemptCompleted: (attempt: UXapiStatement) => (statement: UXapiStatement) => boolean;
13
13
  export declare const resolveAttempts: (statements: UXapiStatement[], options?: {
14
- activityIRI?: string | undefined;
15
- parentActivityAttempt?: string | undefined;
16
- } | undefined) => UXapiStatement[];
17
- export declare const resolveCompletedForAttempt: (statements: UXapiStatement[], attempt: UXapiStatement, activityIRI?: string | undefined) => UXapiStatement | undefined;
14
+ activityIRI?: string;
15
+ parentActivityAttempt?: string;
16
+ }) => UXapiStatement[];
17
+ export declare const resolveCompletedForAttempt: (statements: UXapiStatement[], attempt: UXapiStatement, activityIRI?: string) => UXapiStatement | undefined;
18
18
  export declare const oldestStatement: (statements: UXapiStatement[]) => UXapiStatement | undefined;
19
19
  export declare const mostRecentStatement: (statements: UXapiStatement[]) => UXapiStatement | undefined;
20
20
  export declare const resolveAttemptInfo: (statements: UXapiStatement[], options?: {
21
- activityIRI?: string | undefined;
22
- currentAttempt?: string | undefined;
23
- parentActivityAttempt?: string | undefined;
24
- currentPreference?: "latest" | "oldest" | undefined;
25
- } | undefined) => ActivityState;
21
+ activityIRI?: string;
22
+ currentAttempt?: string;
23
+ parentActivityAttempt?: string;
24
+ currentPreference?: "latest" | "oldest";
25
+ }) => ActivityState;
26
26
  export declare const loadStatementsForActivityAndFirstChildren: (gateway: LrsGateway, activityIRI: string, options?: {
27
- anyUser?: boolean | undefined;
28
- attempt?: string | undefined;
29
- ensureSync?: boolean | undefined;
30
- user?: string | undefined;
31
- } | undefined) => Promise<import(".").XapiStatement[]>;
27
+ anyUser?: boolean;
28
+ attempt?: string;
29
+ ensureSync?: boolean;
30
+ user?: string;
31
+ }) => Promise<import(".").XapiStatement[]>;
32
32
  export declare const loadActivityAttemptInfo: (gateway: LrsGateway, activityIRI: string, options?: {
33
- currentAttempt?: string | undefined;
34
- parentActivityAttempt?: string | undefined;
35
- ensureSync?: boolean | undefined;
36
- } | undefined) => Promise<ActivityState>;
37
- export declare const createStatement: (verb: UXapiStatement['verb'], activity: {
33
+ currentAttempt?: string;
34
+ parentActivityAttempt?: string;
35
+ ensureSync?: boolean;
36
+ }) => Promise<ActivityState>;
37
+ export declare const createStatement: (verb: UXapiStatement["verb"], activity: {
38
38
  iri: string;
39
39
  type: string;
40
40
  name: string;
41
41
  extensions?: {
42
42
  [key: string]: string;
43
- } | undefined;
44
- }, attempt: string, parentActivityIRI?: string | undefined) => Pick<UXapiStatement, 'object' | 'verb' | 'context'>;
43
+ };
44
+ }, attempt: string, parentActivityIRI?: string) => Pick<UXapiStatement, "object" | "verb" | "context">;
45
45
  export declare const createAttemptStatement: (activity: {
46
46
  iri: string;
47
47
  type: string;
48
48
  name: string;
49
49
  extensions?: {
50
50
  [key: string]: string;
51
- } | undefined;
51
+ };
52
52
  }, parentActivity?: {
53
- iri?: string | undefined;
54
- attempt?: string | undefined;
55
- } | undefined) => Pick<UXapiStatement, 'object' | 'verb' | 'context'>;
53
+ iri?: string;
54
+ attempt?: string;
55
+ }) => Pick<UXapiStatement, "object" | "verb" | "context">;
56
56
  export declare const putAttemptStatement: (gateway: LrsGateway, activity: {
57
57
  iri: string;
58
58
  type: string;
59
59
  name: string;
60
60
  extensions?: {
61
61
  [key: string]: string;
62
- } | undefined;
62
+ };
63
63
  }, parentActivity?: {
64
- iri?: string | undefined;
65
- attempt?: string | undefined;
66
- } | undefined) => Promise<import(".").EagerXapiStatement>;
67
- export declare const createAttemptActivityStatement: (attemptStatement: UXapiStatement, verb: UXapiStatement['verb'], result?: UXapiStatement['result']) => Pick<UXapiStatement, 'object' | 'verb' | 'context' | 'result'>;
68
- export declare const putAttemptActivityStatement: (gateway: LrsGateway, attemptStatement: UXapiStatement, verb: UXapiStatement['verb'], result?: UXapiStatement['result']) => Promise<import(".").EagerXapiStatement>;
69
- export declare const createCompletedStatement: (attemptStatement: UXapiStatement, result?: UXapiStatement['result']) => Pick<UXapiStatement, 'object' | 'verb' | 'context' | 'result'>;
70
- export declare const putCompletedStatement: (gateway: LrsGateway, attemptStatement: UXapiStatement, result: UXapiStatement['result']) => Promise<import(".").EagerXapiStatement>;
64
+ iri?: string;
65
+ attempt?: string;
66
+ }) => Promise<import(".").EagerXapiStatement>;
67
+ export declare const createAttemptActivityStatement: (attemptStatement: UXapiStatement, verb: UXapiStatement["verb"], result?: UXapiStatement["result"]) => Pick<UXapiStatement, "object" | "verb" | "context" | "result">;
68
+ export declare const putAttemptActivityStatement: (gateway: LrsGateway, attemptStatement: UXapiStatement, verb: UXapiStatement["verb"], result?: UXapiStatement["result"]) => Promise<import(".").EagerXapiStatement>;
69
+ export declare const createCompletedStatement: (attemptStatement: UXapiStatement, result?: UXapiStatement["result"]) => Pick<UXapiStatement, "object" | "verb" | "context" | "result">;
70
+ export declare const putCompletedStatement: (gateway: LrsGateway, attemptStatement: UXapiStatement, result: UXapiStatement["result"]) => Promise<import(".").EagerXapiStatement>;
@@ -1,7 +1,7 @@
1
1
  import { ConfigProviderForConfig } from '../../config';
2
2
  import { AuthProvider } from '../authProvider';
3
3
  import { LrsGateway } from '.';
4
- declare type Config = {
4
+ type Config = {
5
5
  name: string;
6
6
  };
7
7
  interface Initializer<C> {
@@ -9,9 +9,7 @@ interface Initializer<C> {
9
9
  fs?: Pick<typeof import('fs'), 'readFile' | 'writeFile'>;
10
10
  configSpace?: C;
11
11
  }
12
- export declare const fileSystemLrsGateway: <C extends string = "fileSystem">(initializer: Initializer<C>) => (configProvider: { [key in C]: {
13
- name: import("../../config").ConfigValueProvider<string>;
14
- }; }) => ({ authProvider }: {
12
+ export declare const fileSystemLrsGateway: <C extends string = "fileSystem">(initializer: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => ({ authProvider }: {
15
13
  authProvider: AuthProvider;
16
14
  }) => LrsGateway;
17
15
  export {};
@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
15
15
  }) : function(o, v) {
16
16
  o["default"] = v;
17
17
  });
18
- var __importStar = (this && this.__importStar) || function (mod) {
19
- if (mod && mod.__esModule) return mod;
20
- var result = {};
21
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
- __setModuleDefault(result, mod);
23
- return result;
24
- };
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
25
35
  var __importDefault = (this && this.__importDefault) || function (mod) {
26
36
  return (mod && mod.__esModule) ? mod : { "default": mod };
27
37
  };
@@ -3,7 +3,7 @@ import { GenericFetch } from '../../fetch';
3
3
  import { WithRequired } from '../../types';
4
4
  import { AuthProvider } from '../authProvider';
5
5
  import { Logger } from '../logger';
6
- declare type Config = {
6
+ type Config = {
7
7
  lrsHost: string;
8
8
  lrsAuthorization: string;
9
9
  };
@@ -73,32 +73,29 @@ export interface XapiStatement {
73
73
  timestamp: string;
74
74
  stored?: string;
75
75
  }
76
- export declare type SavedXapiStatement = WithRequired<XapiStatement, 'stored'>;
77
- export declare type EagerXapiStatement = Omit<XapiStatement, 'stored'>;
78
- export declare type UXapiStatement = XapiStatement | EagerXapiStatement | SavedXapiStatement;
79
- export declare type LrsGateway = ReturnType<ReturnType<ReturnType<typeof lrsGateway>>>;
80
- export declare type LrsProvider = ReturnType<ReturnType<typeof lrsGateway>>;
81
- export declare const lrsGateway: <C extends string = "lrs">(initializer: Initializer<C>) => (configProvider: { [key in C]: {
82
- lrsHost: import("../../config").ConfigValueProvider<string>;
83
- lrsAuthorization: import("../../config").ConfigValueProvider<string>;
84
- }; }) => ({ authProvider, logger }: {
76
+ export type SavedXapiStatement = WithRequired<XapiStatement, 'stored'>;
77
+ export type EagerXapiStatement = Omit<XapiStatement, 'stored'>;
78
+ export type UXapiStatement = XapiStatement | EagerXapiStatement | SavedXapiStatement;
79
+ export type LrsGateway = ReturnType<ReturnType<ReturnType<typeof lrsGateway>>>;
80
+ export type LrsProvider = ReturnType<ReturnType<typeof lrsGateway>>;
81
+ export declare const lrsGateway: <C extends string = "lrs">(initializer: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => ({ authProvider, logger }: {
85
82
  authProvider: AuthProvider;
86
83
  logger: Logger;
87
84
  }) => {
88
- putXapiStatements: (statements: Array<(Pick<XapiStatement, 'object' | 'verb' | 'context' | 'result'> & {
85
+ putXapiStatements: (statements: Array<(Pick<XapiStatement, "object" | "verb" | "context" | "result"> & {
89
86
  id?: string;
90
87
  }) | UXapiStatement>) => Promise<EagerXapiStatement[]>;
91
88
  getXapiStatements: (params: {
92
- verb?: string | undefined;
93
- activity?: string | undefined;
94
- registration?: string | undefined;
95
- related_activities?: boolean | undefined;
96
- user?: string | undefined;
97
- anyUser?: boolean | undefined;
98
- since?: string | undefined;
99
- until?: string | undefined;
89
+ verb?: string;
90
+ activity?: string;
91
+ registration?: string;
92
+ related_activities?: boolean;
93
+ user?: string;
94
+ anyUser?: boolean;
95
+ since?: string;
96
+ until?: string;
100
97
  } & {
101
- ensureSync?: boolean | undefined;
98
+ ensureSync?: boolean;
102
99
  }) => Promise<{
103
100
  more: string;
104
101
  statements: XapiStatement[];
@@ -107,19 +104,19 @@ export declare const lrsGateway: <C extends string = "lrs">(initializer: Initial
107
104
  more: string;
108
105
  statements: XapiStatement[];
109
106
  }>;
110
- getAllXapiStatements: ({ fetchUntil, ...params }: {
111
- verb?: string | undefined;
112
- activity?: string | undefined;
113
- registration?: string | undefined;
114
- related_activities?: boolean | undefined;
115
- user?: string | undefined;
116
- anyUser?: boolean | undefined;
117
- since?: string | undefined;
118
- until?: string | undefined;
119
- } & {
120
- ensureSync?: boolean | undefined;
107
+ getAllXapiStatements: ({ fetchUntil, ...params }: ({
108
+ verb?: string;
109
+ activity?: string;
110
+ registration?: string;
111
+ related_activities?: boolean;
112
+ user?: string;
113
+ anyUser?: boolean;
114
+ since?: string;
115
+ until?: string;
121
116
  } & {
122
- fetchUntil?: ((statements: XapiStatement[]) => boolean) | undefined;
117
+ ensureSync?: boolean;
118
+ }) & {
119
+ fetchUntil?: (statements: XapiStatement[]) => boolean;
123
120
  }) => Promise<XapiStatement[]>;
124
121
  };
125
122
  export {};
@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
15
15
  }) : function(o, v) {
16
16
  o["default"] = v;
17
17
  });
18
- var __importStar = (this && this.__importStar) || function (mod) {
19
- if (mod && mod.__esModule) return mod;
20
- var result = {};
21
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
- __setModuleDefault(result, mod);
23
- return result;
24
- };
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
25
35
  Object.defineProperty(exports, "__esModule", { value: true });
26
36
  exports.lrsGateway = void 0;
27
37
  const queryString = __importStar(require("query-string"));