@openstax/ts-utils 1.21.10 → 1.21.11

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 (248) hide show
  1. package/dist/tsconfig.tsbuildinfo +1 -0
  2. package/package.json +1 -1
  3. package/dist/cjs/assertions/index.d.ts +0 -85
  4. package/dist/cjs/assertions/index.js +0 -157
  5. package/dist/cjs/aws/ssmService.d.ts +0 -5
  6. package/dist/cjs/aws/ssmService.js +0 -9
  7. package/dist/cjs/config/awsParameterConfig.d.ts +0 -10
  8. package/dist/cjs/config/awsParameterConfig.js +0 -26
  9. package/dist/cjs/config/envConfig.d.ts +0 -24
  10. package/dist/cjs/config/envConfig.js +0 -57
  11. package/dist/cjs/config/index.d.ts +0 -48
  12. package/dist/cjs/config/index.js +0 -35
  13. package/dist/cjs/config/lambdaParameterConfig.d.ts +0 -12
  14. package/dist/cjs/config/lambdaParameterConfig.js +0 -45
  15. package/dist/cjs/config/replaceConfig.d.ts +0 -14
  16. package/dist/cjs/config/replaceConfig.js +0 -22
  17. package/dist/cjs/config/resolveConfigValue.d.ts +0 -5
  18. package/dist/cjs/config/resolveConfigValue.js +0 -12
  19. package/dist/cjs/errors/index.d.ts +0 -66
  20. package/dist/cjs/errors/index.js +0 -95
  21. package/dist/cjs/fetch/fetchStatusRetry.d.ts +0 -7
  22. package/dist/cjs/fetch/fetchStatusRetry.js +0 -16
  23. package/dist/cjs/fetch/index.d.ts +0 -64
  24. package/dist/cjs/fetch/index.js +0 -55
  25. package/dist/cjs/guards/index.d.ts +0 -30
  26. package/dist/cjs/guards/index.js +0 -35
  27. package/dist/cjs/index.d.ts +0 -4
  28. package/dist/cjs/index.js +0 -20
  29. package/dist/cjs/middleware/apiErrorHandler.d.ts +0 -23
  30. package/dist/cjs/middleware/apiErrorHandler.js +0 -40
  31. package/dist/cjs/middleware/apiSlowResponseMiddleware.d.ts +0 -23
  32. package/dist/cjs/middleware/apiSlowResponseMiddleware.js +0 -54
  33. package/dist/cjs/middleware/index.d.ts +0 -47
  34. package/dist/cjs/middleware/index.js +0 -48
  35. package/dist/cjs/middleware/lambdaCorsResponseMiddleware.d.ts +0 -20
  36. package/dist/cjs/middleware/lambdaCorsResponseMiddleware.js +0 -42
  37. package/dist/cjs/middleware/throwNotFoundMiddleware.d.ts +0 -4
  38. package/dist/cjs/middleware/throwNotFoundMiddleware.js +0 -14
  39. package/dist/cjs/misc/hashValue.d.ts +0 -10
  40. package/dist/cjs/misc/hashValue.js +0 -17
  41. package/dist/cjs/misc/helpers.d.ts +0 -124
  42. package/dist/cjs/misc/helpers.js +0 -214
  43. package/dist/cjs/misc/merge.d.ts +0 -21
  44. package/dist/cjs/misc/merge.js +0 -45
  45. package/dist/cjs/misc/partitionSequence.d.ts +0 -35
  46. package/dist/cjs/misc/partitionSequence.js +0 -55
  47. package/dist/cjs/pagination/index.d.ts +0 -91
  48. package/dist/cjs/pagination/index.js +0 -83
  49. package/dist/cjs/routing/helpers.d.ts +0 -57
  50. package/dist/cjs/routing/helpers.js +0 -90
  51. package/dist/cjs/routing/index.d.ts +0 -272
  52. package/dist/cjs/routing/index.js +0 -270
  53. package/dist/cjs/routing/validators/zod.d.ts +0 -4
  54. package/dist/cjs/routing/validators/zod.js +0 -12
  55. package/dist/cjs/services/accountsGateway/index.d.ts +0 -85
  56. package/dist/cjs/services/accountsGateway/index.js +0 -118
  57. package/dist/cjs/services/apiGateway/index.d.ts +0 -59
  58. package/dist/cjs/services/apiGateway/index.js +0 -96
  59. package/dist/cjs/services/authProvider/browser.d.ts +0 -74
  60. package/dist/cjs/services/authProvider/browser.js +0 -154
  61. package/dist/cjs/services/authProvider/decryption.d.ts +0 -19
  62. package/dist/cjs/services/authProvider/decryption.js +0 -61
  63. package/dist/cjs/services/authProvider/index.d.ts +0 -61
  64. package/dist/cjs/services/authProvider/index.js +0 -26
  65. package/dist/cjs/services/authProvider/subrequest.d.ts +0 -16
  66. package/dist/cjs/services/authProvider/subrequest.js +0 -50
  67. package/dist/cjs/services/authProvider/utils/decryptAndVerify.d.ts +0 -29
  68. package/dist/cjs/services/authProvider/utils/decryptAndVerify.js +0 -91
  69. package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.d.ts +0 -26
  70. package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.js +0 -47
  71. package/dist/cjs/services/authProvider/utils/userRoleValidator.d.ts +0 -13
  72. package/dist/cjs/services/authProvider/utils/userRoleValidator.js +0 -37
  73. package/dist/cjs/services/documentStore/dynamoEncoding.d.ts +0 -10
  74. package/dist/cjs/services/documentStore/dynamoEncoding.js +0 -52
  75. package/dist/cjs/services/documentStore/index.d.ts +0 -14
  76. package/dist/cjs/services/documentStore/index.js +0 -2
  77. package/dist/cjs/services/documentStore/unversioned/dynamodb.d.ts +0 -16
  78. package/dist/cjs/services/documentStore/unversioned/dynamodb.js +0 -122
  79. package/dist/cjs/services/documentStore/unversioned/file-system.d.ts +0 -18
  80. package/dist/cjs/services/documentStore/unversioned/file-system.js +0 -121
  81. package/dist/cjs/services/documentStore/unversioned/index.d.ts +0 -2
  82. package/dist/cjs/services/documentStore/unversioned/index.js +0 -2
  83. package/dist/cjs/services/documentStore/versioned/dynamodb.d.ts +0 -22
  84. package/dist/cjs/services/documentStore/versioned/dynamodb.js +0 -135
  85. package/dist/cjs/services/documentStore/versioned/file-system.d.ts +0 -24
  86. package/dist/cjs/services/documentStore/versioned/file-system.js +0 -62
  87. package/dist/cjs/services/documentStore/versioned/index.d.ts +0 -17
  88. package/dist/cjs/services/documentStore/versioned/index.js +0 -2
  89. package/dist/cjs/services/exercisesGateway/index.d.ts +0 -71
  90. package/dist/cjs/services/exercisesGateway/index.js +0 -97
  91. package/dist/cjs/services/fileServer/index.d.ts +0 -19
  92. package/dist/cjs/services/fileServer/index.js +0 -19
  93. package/dist/cjs/services/fileServer/localFileServer.d.ts +0 -17
  94. package/dist/cjs/services/fileServer/localFileServer.js +0 -80
  95. package/dist/cjs/services/fileServer/s3FileServer.d.ts +0 -16
  96. package/dist/cjs/services/fileServer/s3FileServer.js +0 -49
  97. package/dist/cjs/services/launchParams/index.d.ts +0 -2
  98. package/dist/cjs/services/launchParams/index.js +0 -7
  99. package/dist/cjs/services/launchParams/signer.d.ts +0 -27
  100. package/dist/cjs/services/launchParams/signer.js +0 -58
  101. package/dist/cjs/services/launchParams/verifier.d.ts +0 -22
  102. package/dist/cjs/services/launchParams/verifier.js +0 -94
  103. package/dist/cjs/services/logger/console.d.ts +0 -4
  104. package/dist/cjs/services/logger/console.js +0 -12
  105. package/dist/cjs/services/logger/index.d.ts +0 -39
  106. package/dist/cjs/services/logger/index.js +0 -31
  107. package/dist/cjs/services/lrsGateway/addStatementDefaultFields.d.ts +0 -5
  108. package/dist/cjs/services/lrsGateway/addStatementDefaultFields.js +0 -21
  109. package/dist/cjs/services/lrsGateway/attempt-utils.d.ts +0 -70
  110. package/dist/cjs/services/lrsGateway/attempt-utils.js +0 -258
  111. package/dist/cjs/services/lrsGateway/file-system.d.ts +0 -17
  112. package/dist/cjs/services/lrsGateway/file-system.js +0 -140
  113. package/dist/cjs/services/lrsGateway/index.d.ts +0 -125
  114. package/dist/cjs/services/lrsGateway/index.js +0 -138
  115. package/dist/cjs/services/lrsGateway/xapiUtils.d.ts +0 -61
  116. package/dist/cjs/services/lrsGateway/xapiUtils.js +0 -94
  117. package/dist/cjs/services/postgresConnection/index.d.ts +0 -35
  118. package/dist/cjs/services/postgresConnection/index.js +0 -65
  119. package/dist/cjs/services/searchProvider/index.d.ts +0 -31
  120. package/dist/cjs/services/searchProvider/index.js +0 -2
  121. package/dist/cjs/services/searchProvider/memorySearchTheBadWay.d.ts +0 -14
  122. package/dist/cjs/services/searchProvider/memorySearchTheBadWay.js +0 -89
  123. package/dist/cjs/tsconfig.without-specs.cjs.tsbuildinfo +0 -1
  124. package/dist/cjs/types.d.ts +0 -31
  125. package/dist/cjs/types.js +0 -2
  126. package/dist/esm/assertions/index.d.ts +0 -85
  127. package/dist/esm/assertions/index.js +0 -146
  128. package/dist/esm/aws/ssmService.d.ts +0 -5
  129. package/dist/esm/aws/ssmService.js +0 -6
  130. package/dist/esm/config/awsParameterConfig.d.ts +0 -10
  131. package/dist/esm/config/awsParameterConfig.js +0 -22
  132. package/dist/esm/config/envConfig.d.ts +0 -24
  133. package/dist/esm/config/envConfig.js +0 -53
  134. package/dist/esm/config/index.d.ts +0 -48
  135. package/dist/esm/config/index.js +0 -17
  136. package/dist/esm/config/lambdaParameterConfig.d.ts +0 -12
  137. package/dist/esm/config/lambdaParameterConfig.js +0 -38
  138. package/dist/esm/config/replaceConfig.d.ts +0 -14
  139. package/dist/esm/config/replaceConfig.js +0 -18
  140. package/dist/esm/config/resolveConfigValue.d.ts +0 -5
  141. package/dist/esm/config/resolveConfigValue.js +0 -8
  142. package/dist/esm/errors/index.d.ts +0 -66
  143. package/dist/esm/errors/index.js +0 -86
  144. package/dist/esm/fetch/fetchStatusRetry.d.ts +0 -7
  145. package/dist/esm/fetch/fetchStatusRetry.js +0 -12
  146. package/dist/esm/fetch/index.d.ts +0 -64
  147. package/dist/esm/fetch/index.js +0 -46
  148. package/dist/esm/guards/index.d.ts +0 -30
  149. package/dist/esm/guards/index.js +0 -28
  150. package/dist/esm/index.d.ts +0 -4
  151. package/dist/esm/index.js +0 -4
  152. package/dist/esm/middleware/apiErrorHandler.d.ts +0 -23
  153. package/dist/esm/middleware/apiErrorHandler.js +0 -36
  154. package/dist/esm/middleware/apiSlowResponseMiddleware.d.ts +0 -23
  155. package/dist/esm/middleware/apiSlowResponseMiddleware.js +0 -50
  156. package/dist/esm/middleware/index.d.ts +0 -47
  157. package/dist/esm/middleware/index.js +0 -44
  158. package/dist/esm/middleware/lambdaCorsResponseMiddleware.d.ts +0 -20
  159. package/dist/esm/middleware/lambdaCorsResponseMiddleware.js +0 -38
  160. package/dist/esm/middleware/throwNotFoundMiddleware.d.ts +0 -4
  161. package/dist/esm/middleware/throwNotFoundMiddleware.js +0 -10
  162. package/dist/esm/misc/hashValue.d.ts +0 -10
  163. package/dist/esm/misc/hashValue.js +0 -13
  164. package/dist/esm/misc/helpers.d.ts +0 -124
  165. package/dist/esm/misc/helpers.js +0 -199
  166. package/dist/esm/misc/merge.d.ts +0 -21
  167. package/dist/esm/misc/merge.js +0 -40
  168. package/dist/esm/misc/partitionSequence.d.ts +0 -35
  169. package/dist/esm/misc/partitionSequence.js +0 -48
  170. package/dist/esm/pagination/index.d.ts +0 -91
  171. package/dist/esm/pagination/index.js +0 -77
  172. package/dist/esm/routing/helpers.d.ts +0 -57
  173. package/dist/esm/routing/helpers.js +0 -83
  174. package/dist/esm/routing/index.d.ts +0 -272
  175. package/dist/esm/routing/index.js +0 -232
  176. package/dist/esm/routing/validators/zod.d.ts +0 -4
  177. package/dist/esm/routing/validators/zod.js +0 -8
  178. package/dist/esm/services/accountsGateway/index.d.ts +0 -85
  179. package/dist/esm/services/accountsGateway/index.js +0 -111
  180. package/dist/esm/services/apiGateway/index.d.ts +0 -59
  181. package/dist/esm/services/apiGateway/index.js +0 -65
  182. package/dist/esm/services/authProvider/browser.d.ts +0 -74
  183. package/dist/esm/services/authProvider/browser.js +0 -150
  184. package/dist/esm/services/authProvider/decryption.d.ts +0 -19
  185. package/dist/esm/services/authProvider/decryption.js +0 -57
  186. package/dist/esm/services/authProvider/index.d.ts +0 -61
  187. package/dist/esm/services/authProvider/index.js +0 -18
  188. package/dist/esm/services/authProvider/subrequest.d.ts +0 -16
  189. package/dist/esm/services/authProvider/subrequest.js +0 -43
  190. package/dist/esm/services/authProvider/utils/decryptAndVerify.d.ts +0 -29
  191. package/dist/esm/services/authProvider/utils/decryptAndVerify.js +0 -85
  192. package/dist/esm/services/authProvider/utils/embeddedAuthProvider.d.ts +0 -26
  193. package/dist/esm/services/authProvider/utils/embeddedAuthProvider.js +0 -40
  194. package/dist/esm/services/authProvider/utils/userRoleValidator.d.ts +0 -13
  195. package/dist/esm/services/authProvider/utils/userRoleValidator.js +0 -33
  196. package/dist/esm/services/documentStore/dynamoEncoding.d.ts +0 -10
  197. package/dist/esm/services/documentStore/dynamoEncoding.js +0 -45
  198. package/dist/esm/services/documentStore/index.d.ts +0 -14
  199. package/dist/esm/services/documentStore/index.js +0 -1
  200. package/dist/esm/services/documentStore/unversioned/dynamodb.d.ts +0 -16
  201. package/dist/esm/services/documentStore/unversioned/dynamodb.js +0 -118
  202. package/dist/esm/services/documentStore/unversioned/file-system.d.ts +0 -18
  203. package/dist/esm/services/documentStore/unversioned/file-system.js +0 -91
  204. package/dist/esm/services/documentStore/unversioned/index.d.ts +0 -2
  205. package/dist/esm/services/documentStore/unversioned/index.js +0 -1
  206. package/dist/esm/services/documentStore/versioned/dynamodb.d.ts +0 -22
  207. package/dist/esm/services/documentStore/versioned/dynamodb.js +0 -131
  208. package/dist/esm/services/documentStore/versioned/file-system.d.ts +0 -24
  209. package/dist/esm/services/documentStore/versioned/file-system.js +0 -58
  210. package/dist/esm/services/documentStore/versioned/index.d.ts +0 -17
  211. package/dist/esm/services/documentStore/versioned/index.js +0 -1
  212. package/dist/esm/services/exercisesGateway/index.d.ts +0 -71
  213. package/dist/esm/services/exercisesGateway/index.js +0 -70
  214. package/dist/esm/services/fileServer/index.d.ts +0 -19
  215. package/dist/esm/services/fileServer/index.js +0 -13
  216. package/dist/esm/services/fileServer/localFileServer.d.ts +0 -17
  217. package/dist/esm/services/fileServer/localFileServer.js +0 -73
  218. package/dist/esm/services/fileServer/s3FileServer.d.ts +0 -16
  219. package/dist/esm/services/fileServer/s3FileServer.js +0 -45
  220. package/dist/esm/services/launchParams/index.d.ts +0 -2
  221. package/dist/esm/services/launchParams/index.js +0 -2
  222. package/dist/esm/services/launchParams/signer.d.ts +0 -27
  223. package/dist/esm/services/launchParams/signer.js +0 -51
  224. package/dist/esm/services/launchParams/verifier.d.ts +0 -22
  225. package/dist/esm/services/launchParams/verifier.js +0 -67
  226. package/dist/esm/services/logger/console.d.ts +0 -4
  227. package/dist/esm/services/logger/console.js +0 -8
  228. package/dist/esm/services/logger/index.d.ts +0 -39
  229. package/dist/esm/services/logger/index.js +0 -27
  230. package/dist/esm/services/lrsGateway/addStatementDefaultFields.d.ts +0 -5
  231. package/dist/esm/services/lrsGateway/addStatementDefaultFields.js +0 -14
  232. package/dist/esm/services/lrsGateway/attempt-utils.d.ts +0 -70
  233. package/dist/esm/services/lrsGateway/attempt-utils.js +0 -236
  234. package/dist/esm/services/lrsGateway/file-system.d.ts +0 -17
  235. package/dist/esm/services/lrsGateway/file-system.js +0 -110
  236. package/dist/esm/services/lrsGateway/index.d.ts +0 -125
  237. package/dist/esm/services/lrsGateway/index.js +0 -111
  238. package/dist/esm/services/lrsGateway/xapiUtils.d.ts +0 -61
  239. package/dist/esm/services/lrsGateway/xapiUtils.js +0 -84
  240. package/dist/esm/services/postgresConnection/index.d.ts +0 -35
  241. package/dist/esm/services/postgresConnection/index.js +0 -58
  242. package/dist/esm/services/searchProvider/index.d.ts +0 -31
  243. package/dist/esm/services/searchProvider/index.js +0 -1
  244. package/dist/esm/services/searchProvider/memorySearchTheBadWay.d.ts +0 -14
  245. package/dist/esm/services/searchProvider/memorySearchTheBadWay.js +0 -85
  246. package/dist/esm/tsconfig.without-specs.esm.tsbuildinfo +0 -1
  247. package/dist/esm/types.d.ts +0 -31
  248. package/dist/esm/types.js +0 -1
@@ -1,91 +0,0 @@
1
- import * as fsModule from 'fs';
2
- import path from 'path';
3
- import { hashValue } from '../../..';
4
- import { resolveConfigValue } from '../../../config';
5
- import { NotFoundError } from '../../../errors';
6
- import { ifDefined, isDefined } from '../../../guards';
7
- export const fileSystemUnversionedDocumentStore = (initializer) => () => (configProvider) => (_, hashKey) => {
8
- const tableName = resolveConfigValue(configProvider[initializer.configSpace || 'fileSystem'].tableName);
9
- const tablePath = tableName.then((table) => path.join(initializer.dataDir, table));
10
- const { mkdir, readdir, readFile, writeFile } = ifDefined(initializer.fs, fsModule);
11
- const mkTableDir = new Promise((resolve, reject) => tablePath.then((path) => mkdir(path, { recursive: true }, (err) => err && err.code !== 'EEXIST' ? reject(err) : resolve())));
12
- const hashFilename = (value) => `${hashValue(value)}.json`;
13
- const filePath = async (filename) => path.join(await tablePath, filename);
14
- const load = async (filename) => {
15
- const path = await filePath(filename);
16
- await mkTableDir;
17
- return new Promise((resolve, reject) => {
18
- readFile(path, (err, readData) => {
19
- if (err) {
20
- err.code === 'ENOENT' ? resolve(undefined) : reject(err);
21
- }
22
- else {
23
- try {
24
- const data = JSON.parse(readData.toString());
25
- typeof data === 'object' ? resolve(data) : reject(new Error('unexpected non-object JSON'));
26
- }
27
- catch (err) {
28
- reject(err);
29
- }
30
- }
31
- });
32
- });
33
- };
34
- return {
35
- loadAllDocumentsTheBadWay: async () => {
36
- const path = await tablePath;
37
- await mkTableDir;
38
- return new Promise((resolve, reject) => readdir(path, (err, files) => err ?
39
- reject(err) :
40
- Promise.all(files.map((file) => load(file)))
41
- .then((allData) => resolve(allData.filter(isDefined)), (err) => reject(err))));
42
- },
43
- batchGetItem: async (ids) => {
44
- const items = await Promise.all(ids.map((id) => load(hashFilename(id))));
45
- return items.filter(isDefined);
46
- },
47
- getItem: (id) => load(hashFilename(id)),
48
- incrementItemAttribute: async (id, attribute) => {
49
- const filename = hashFilename(id);
50
- const path = await filePath(filename);
51
- await mkTableDir;
52
- const data = await load(filename);
53
- if (!data) {
54
- throw new NotFoundError(`Item with ${hashKey.toString()} "${id}" does not exist`);
55
- }
56
- const newValue = typeof data[attribute] === 'number' ? data[attribute] + 1 : 1;
57
- const newItem = { ...data, [hashKey]: id, [attribute]: newValue };
58
- return new Promise((resolve, reject) => {
59
- writeFile(path, JSON.stringify(newItem, null, 2), (err) => err ? reject(err) : resolve(newValue));
60
- });
61
- },
62
- patchItem: async (item) => {
63
- const id = item[hashKey];
64
- if (!id) {
65
- throw new Error(`Key attribute "${hashKey.toString()}" is required for patchItem`);
66
- }
67
- // This check is just to make this adapter consistent with the dynamo adapter
68
- if (Object.keys(item).filter((key) => key !== hashKey.toString()).length === 0) {
69
- throw new Error('No attributes to update');
70
- }
71
- const filename = hashFilename(id);
72
- const path = await filePath(filename);
73
- await mkTableDir;
74
- const data = await load(filename);
75
- if (!data) {
76
- throw new NotFoundError(`Item with ${hashKey.toString()} "${id}" does not exist`);
77
- }
78
- const newItem = { ...data, ...item };
79
- return new Promise((resolve, reject) => {
80
- writeFile(path, JSON.stringify(newItem, null, 2), (err) => err ? reject(err) : resolve(newItem));
81
- });
82
- },
83
- putItem: async (item) => {
84
- const path = await filePath(hashFilename(item[hashKey]));
85
- await mkTableDir;
86
- return new Promise((resolve, reject) => {
87
- writeFile(path, JSON.stringify(item, null, 2), (err) => err ? reject(err) : resolve(item));
88
- });
89
- },
90
- };
91
- };
@@ -1,2 +0,0 @@
1
- import { dynamoUnversionedDocumentStore } from './dynamodb';
2
- export declare type UnversionedDocumentStoreCreator = typeof dynamoUnversionedDocumentStore;
@@ -1 +0,0 @@
1
- export {};
@@ -1,22 +0,0 @@
1
- import { Config } from '..';
2
- import { ConfigProviderForConfig } from '../../../config';
3
- import { VersionedDocumentAuthor, VersionedTDocument } from '.';
4
- interface Initializer<C> {
5
- configSpace?: C;
6
- }
7
- export declare const dynamoVersionedDocumentStore: <C extends string = "dynamodb">(initializer?: Initializer<C> | undefined) => <T extends VersionedTDocument<T>>() => (configProvider: { [key in C]: {
8
- tableName: import("../../../config").ConfigValueProvider<string>;
9
- }; }) => <K extends keyof T, A extends ((...a: any[]) => Promise<VersionedDocumentAuthor>) | undefined>(_: {}, hashKey: K, getAuthor: A) => {
10
- loadAllDocumentsTheBadWay: () => Promise<T[]>;
11
- getVersions: (id: T[K], startVersion?: number | undefined) => Promise<{
12
- items: T[];
13
- nextPageToken: number | undefined;
14
- } | undefined>;
15
- getItem: (id: T[K], timestamp?: number | undefined) => Promise<T | undefined>;
16
- prepareItem: (item: Omit<T, "timestamp" | "author">, ...authorArgs: A extends Function ? Parameters<A> : [VersionedDocumentAuthor]) => Promise<{
17
- document: T;
18
- save: (changes?: Partial<Omit<T, "timestamp" | "author">> | undefined) => Promise<T>;
19
- }>;
20
- putItem: (item: Omit<T, "timestamp" | "author">, ...authorArgs: A extends Function ? Parameters<A> : [VersionedDocumentAuthor]) => Promise<T>;
21
- };
22
- export {};
@@ -1,131 +0,0 @@
1
- import { DynamoDB, PutItemCommand, QueryCommand, ScanCommand } from '@aws-sdk/client-dynamodb';
2
- import { once } from '../../..';
3
- import { resolveConfigValue } from '../../../config';
4
- import { ifDefined } from '../../../guards';
5
- import { decodeDynamoDocument, encodeDynamoAttribute, encodeDynamoDocument } from '../dynamoEncoding';
6
- const dynamodb = once(() => new DynamoDB({ apiVersion: '2012-08-10' }));
7
- // i'm not really excited about getAuthor being required, but ts is getting confused about the type when unspecified
8
- export const dynamoVersionedDocumentStore = (initializer) => () => (configProvider) => (_, hashKey, getAuthor) => {
9
- const options = ifDefined(initializer, {});
10
- const tableName = once(() => resolveConfigValue(configProvider[ifDefined(options.configSpace, 'dynamodb')].tableName));
11
- return {
12
- loadAllDocumentsTheBadWay: async () => {
13
- const loadAllResults = async (ExclusiveStartKey) => {
14
- var _a;
15
- const cmd = new ScanCommand({ TableName: await tableName(), ExclusiveStartKey });
16
- const result = await dynamodb().send(cmd);
17
- const resultItems = ((_a = result.Items) === null || _a === void 0 ? void 0 : _a.map(decodeDynamoDocument)) || [];
18
- if (result.LastEvaluatedKey) {
19
- return [...resultItems, ...await loadAllResults(result.LastEvaluatedKey)];
20
- }
21
- return resultItems;
22
- };
23
- const allResults = await loadAllResults().then(results => results.reduce((result, document) => {
24
- const current = result.get(document[hashKey]);
25
- if (!current || current.timestamp < document.timestamp) {
26
- return result.set(document[hashKey], document);
27
- }
28
- return result;
29
- }, new Map()));
30
- return Array.from(allResults.values());
31
- },
32
- getVersions: async (id, startVersion) => {
33
- const cmd = new QueryCommand({
34
- TableName: await tableName(),
35
- KeyConditionExpression: '#hk = :hkv',
36
- ExpressionAttributeValues: {
37
- ':hkv': encodeDynamoAttribute(id)
38
- },
39
- ExpressionAttributeNames: {
40
- '#hk': hashKey.toString()
41
- },
42
- ...(startVersion
43
- ? { ExclusiveStartKey: {
44
- [hashKey]: encodeDynamoAttribute(id),
45
- timestamp: { N: startVersion.toString() }
46
- } }
47
- : {}),
48
- ScanIndexForward: false,
49
- });
50
- return dynamodb().send(cmd).then(result => {
51
- var _a;
52
- const items = (_a = result.Items) === null || _a === void 0 ? void 0 : _a.map(decodeDynamoDocument);
53
- if (!items || items.length === 0) {
54
- return undefined;
55
- }
56
- return {
57
- items,
58
- nextPageToken: result.LastEvaluatedKey ? decodeDynamoDocument(result.LastEvaluatedKey).timestamp : undefined
59
- };
60
- });
61
- },
62
- getItem: async (id, timestamp) => {
63
- let keyConditionExpression = '#hk = :hkv';
64
- const expressionAttributeNames = {
65
- '#hk': hashKey.toString()
66
- };
67
- const expressionAttributeValues = {
68
- ':hkv': encodeDynamoAttribute(id)
69
- };
70
- if (timestamp) {
71
- keyConditionExpression += ' and #ts = :tsv';
72
- expressionAttributeNames['#ts'] = 'timestamp';
73
- expressionAttributeValues[':tsv'] = encodeDynamoAttribute(timestamp);
74
- }
75
- const cmd = new QueryCommand({
76
- TableName: await tableName(),
77
- KeyConditionExpression: keyConditionExpression,
78
- ExpressionAttributeNames: expressionAttributeNames,
79
- ExpressionAttributeValues: expressionAttributeValues,
80
- ScanIndexForward: false,
81
- Limit: 1
82
- });
83
- return dynamodb().send(cmd).then(result => {
84
- var _a;
85
- return (_a = result.Items) === null || _a === void 0 ? void 0 : _a.map(decodeDynamoDocument)[0];
86
- });
87
- },
88
- /* prepares a new version of a document with the given data, then allows some additional
89
- * changes to be input to a `save` function that actually saves it. useful for additional
90
- * changes based on the new document version or author. the document version and author
91
- * cannot be modified */
92
- prepareItem: async (item, ...authorArgs) => {
93
- // this getAuthor type is terrible
94
- const author = getAuthor ? await getAuthor(...authorArgs) : authorArgs[0];
95
- const timestamp = new Date().getTime();
96
- return {
97
- document: { ...item, timestamp, author },
98
- save: async (changes) => {
99
- const document = {
100
- ...item,
101
- ...changes,
102
- timestamp,
103
- author
104
- };
105
- const cmd = new PutItemCommand({
106
- TableName: await tableName(),
107
- Item: encodeDynamoDocument(document),
108
- });
109
- return dynamodb().send(cmd)
110
- .then(() => document);
111
- }
112
- };
113
- },
114
- /* saves a new version of a document with the given data */
115
- putItem: async (item, ...authorArgs) => {
116
- // this getAuthor type is terrible
117
- const author = getAuthor ? await getAuthor(...authorArgs) : authorArgs[0];
118
- const document = {
119
- ...item,
120
- timestamp: new Date().getTime(),
121
- author
122
- };
123
- const cmd = new PutItemCommand({
124
- TableName: await tableName(),
125
- Item: encodeDynamoDocument(document),
126
- });
127
- return dynamodb().send(cmd)
128
- .then(() => document);
129
- },
130
- };
131
- };
@@ -1,24 +0,0 @@
1
- import { Config } from '..';
2
- import { ConfigProviderForConfig } from '../../../config';
3
- import { VersionedDocumentAuthor, VersionedTDocument } from '.';
4
- interface Initializer<C> {
5
- dataDir: string;
6
- fs?: Pick<typeof import('fs'), 'mkdir' | 'readdir' | 'readFile' | 'writeFile'>;
7
- configSpace?: C;
8
- }
9
- export declare const fileSystemVersionedDocumentStore: <C extends string = "fileSystem">(initializer: Initializer<C>) => <T extends VersionedTDocument<T>>() => (configProvider: { [key in C]: {
10
- tableName: import("../../../config").ConfigValueProvider<string>;
11
- }; }) => <K extends keyof T, A extends ((...a: any[]) => Promise<VersionedDocumentAuthor>) | undefined>(_: {}, hashKey: K, getAuthor: A) => {
12
- loadAllDocumentsTheBadWay: () => Promise<T[]>;
13
- getVersions: (id: T[K], startVersion?: number | undefined) => Promise<{
14
- items: T[];
15
- nextPageToken: number | undefined;
16
- } | undefined>;
17
- getItem: (id: T[K], timestamp?: number | undefined) => Promise<T | undefined>;
18
- prepareItem: (item: Omit<T, "timestamp" | "author">, ...authorArgs: A extends Function ? Parameters<A> : [VersionedDocumentAuthor]) => Promise<{
19
- document: T;
20
- save: (changes?: Partial<Omit<T, "timestamp" | "author">> | undefined) => Promise<T>;
21
- }>;
22
- putItem: (item: Omit<T, "timestamp" | "author">, ...authorArgs: A extends Function ? Parameters<A> : [VersionedDocumentAuthor]) => Promise<T>;
23
- };
24
- export {};
@@ -1,58 +0,0 @@
1
- import { fileSystemUnversionedDocumentStore } from '../unversioned/file-system';
2
- const PAGE_LIMIT = 5;
3
- export const fileSystemVersionedDocumentStore = (initializer) => () => (configProvider) => (_, hashKey, getAuthor) => {
4
- const unversionedDocuments = fileSystemUnversionedDocumentStore(initializer)()(configProvider)({}, 'id');
5
- return {
6
- loadAllDocumentsTheBadWay: () => {
7
- return unversionedDocuments.loadAllDocumentsTheBadWay().then(documents => documents.map(document => {
8
- return document.items[document.items.length - 1];
9
- }));
10
- },
11
- getVersions: async (id, startVersion) => {
12
- const item = await unversionedDocuments.getItem(id);
13
- const versions = item === null || item === void 0 ? void 0 : item.items.reverse();
14
- if (!versions) {
15
- return undefined;
16
- }
17
- const startIndex = startVersion ? versions.findIndex(version => version.timestamp === startVersion) + 1 : 0;
18
- const items = versions.slice(startIndex, startIndex + PAGE_LIMIT);
19
- const hasMore = (startIndex + 5) < versions.length;
20
- return {
21
- items,
22
- nextPageToken: hasMore ? items[items.length - 1].timestamp : undefined
23
- };
24
- },
25
- getItem: async (id, timestamp) => {
26
- const item = await unversionedDocuments.getItem(id);
27
- if (timestamp) {
28
- return item === null || item === void 0 ? void 0 : item.items.find(version => version.timestamp === timestamp);
29
- }
30
- return item ? item.items[item.items.length - 1] : undefined;
31
- },
32
- prepareItem: async (item, ...authorArgs) => {
33
- // this getAuthor type is terrible
34
- const author = getAuthor ? await getAuthor(...authorArgs) : authorArgs[0];
35
- const timestamp = new Date().getTime();
36
- return {
37
- document: { ...item, timestamp, author },
38
- save: async (changes) => {
39
- var _a;
40
- const document = { ...item, ...changes, timestamp, author };
41
- const container = (_a = await unversionedDocuments.getItem(document[hashKey])) !== null && _a !== void 0 ? _a : { id: document[hashKey], items: [] };
42
- const updated = { ...container, items: [...container.items, document] };
43
- await unversionedDocuments.putItem(updated);
44
- return document;
45
- }
46
- };
47
- },
48
- putItem: async (item, ...authorArgs) => {
49
- var _a;
50
- const author = getAuthor ? await getAuthor(...authorArgs) : authorArgs[0];
51
- const document = { ...item, timestamp: new Date().getTime(), author };
52
- const container = (_a = await unversionedDocuments.getItem(document[hashKey])) !== null && _a !== void 0 ? _a : { id: document[hashKey], items: [] };
53
- const updated = { ...container, items: [...container.items, document] };
54
- await unversionedDocuments.putItem(updated);
55
- return document;
56
- },
57
- };
58
- };
@@ -1,17 +0,0 @@
1
- import { TDocument } from '..';
2
- import { dynamoVersionedDocumentStore } from './dynamodb';
3
- export declare type VersionedDocumentAuthor = {
4
- type: 'user';
5
- uuid: string;
6
- name: string;
7
- reason?: string;
8
- } | {
9
- type: 'system';
10
- reason: string;
11
- };
12
- export declare type VersionedDocumentRequiredFields = {
13
- timestamp: number;
14
- author: VersionedDocumentAuthor;
15
- };
16
- export declare type VersionedTDocument<T> = TDocument<T> & VersionedDocumentRequiredFields;
17
- export declare type VersionedDocumentStoreCreator = typeof dynamoVersionedDocumentStore;
@@ -1 +0,0 @@
1
- export {};
@@ -1,71 +0,0 @@
1
- import { ConfigProviderForConfig } from '../../config';
2
- import { GenericFetch } from '../../fetch';
3
- export declare type Config = {
4
- defaultCorrectness?: string;
5
- exercisesHost: string;
6
- exercisesAuthToken: string;
7
- };
8
- interface Initializer<C> {
9
- configSpace?: C;
10
- fetch: GenericFetch;
11
- }
12
- export declare type Answer = {
13
- id: number;
14
- content_html: string;
15
- correctness?: string;
16
- feedback_html?: string;
17
- };
18
- export declare type Solution = {
19
- images: any[];
20
- solution_type: string;
21
- content_html: string;
22
- };
23
- export declare type Question = {
24
- id: number;
25
- is_answer_order_important: boolean;
26
- stimulus_html: string;
27
- stem_html: string;
28
- answers: Answer[];
29
- hints: string[];
30
- formats: string[];
31
- combo_choices: any[];
32
- collaborator_solutions?: Solution[];
33
- community_solutions?: Solution[];
34
- };
35
- export declare type Exercise = {
36
- images: any[];
37
- tags: string[];
38
- uuid: string;
39
- group_uuid: string;
40
- number: number;
41
- version: number;
42
- uid: string;
43
- published_at: string;
44
- solutions_are_public: boolean;
45
- authors: any[];
46
- copyright_holders: any[];
47
- derived_from: any[];
48
- is_vocab: boolean;
49
- questions: Question[];
50
- delegations: any[];
51
- versions: number[];
52
- stimulus_html: string;
53
- };
54
- export declare type ExercisesSearchResults = {
55
- total_count: number;
56
- items: Exercise[];
57
- };
58
- export declare type ExercisesSearchResultsWithDigest = ExercisesSearchResults & {
59
- digest: string;
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
- }; }) => (_: {}) => {
66
- searchDigest: (query: string, page?: number, per_page?: number) => Promise<string>;
67
- get: (uuid: string) => Promise<Exercise | undefined>;
68
- search: (query: string, page?: number, per_page?: number) => Promise<ExercisesSearchResultsWithDigest>;
69
- };
70
- export declare type ExercisesGateway = ReturnType<ReturnType<ReturnType<typeof exercisesGateway>>>;
71
- export {};
@@ -1,70 +0,0 @@
1
- import * as queryString from 'query-string';
2
- import { once } from '../..';
3
- import { assertString } from '../../assertions';
4
- import { resolveConfigValue } from '../../config';
5
- import { ifDefined } from '../../guards';
6
- import { METHOD } from '../../routing';
7
- export const exercisesGateway = (initializer) => (configProvider) => {
8
- const config = configProvider[ifDefined(initializer.configSpace, 'exercises')];
9
- const exercisesHost = once(() => resolveConfigValue(config.exercisesHost));
10
- const exercisesAuthToken = once(() => resolveConfigValue(config.exercisesAuthToken));
11
- const defaultCorrectness = once(() => resolveConfigValue(config.defaultCorrectness || ''));
12
- const doDefaultCorrectness = async (exercise) => {
13
- if (await defaultCorrectness() !== 'true') {
14
- return exercise;
15
- }
16
- for (const question of exercise.questions) {
17
- const existingCorrect = question.answers.find(answer => answer.correctness !== undefined);
18
- if (question.answers.length < 1 || existingCorrect) {
19
- continue;
20
- }
21
- const defaultCorrectIndex = question.id % question.answers.length;
22
- const defaultCorrect = question.answers[defaultCorrectIndex];
23
- const defaultHint = `<em>random default: the correct answer is ${defaultCorrect.id}: ${defaultCorrect.content_html.slice(0, 20)}</em>`;
24
- question.stem_html += `\n<br>${defaultHint}`;
25
- question.collaborator_solutions = [
26
- { solution_type: 'detailed', images: [], content_html: defaultHint }
27
- ];
28
- for (let index = 0; index < question.answers.length; index++) {
29
- const answer = question.answers[index];
30
- answer.correctness = defaultCorrectIndex === index ? '1.0' : '0.0';
31
- answer.feedback_html = defaultCorrectIndex === index ? 'This is the good one!' : defaultHint;
32
- }
33
- }
34
- return exercise;
35
- };
36
- return (_) => {
37
- const request = async (method, path, query = undefined) => {
38
- const host = (await exercisesHost()).replace(/\/+$/, '');
39
- const baseUrl = `${host}/api/${path}`;
40
- const url = query ? `${baseUrl}?${queryString.stringify(query)}` : baseUrl;
41
- return initializer.fetch(url, {
42
- headers: {
43
- Authorization: `Bearer ${await exercisesAuthToken()}`,
44
- },
45
- method,
46
- });
47
- };
48
- const searchDigest = async (query, page = 1, per_page = 100) => {
49
- const response = await request(METHOD.HEAD, 'exercises', { query, page, per_page });
50
- return assertString(response.headers.get('X-Digest'), 'OpenStax Exercises search endpoint HEAD did not return an X-Digest header');
51
- };
52
- const search = async (query, page = 1, per_page = 100) => {
53
- const response = await request(METHOD.GET, 'exercises', { query, page, per_page });
54
- const digest = assertString(response.headers.get('X-Digest'), 'OpenStax Exercises search endpoint GET did not return an X-Digest header');
55
- const { items, total_count } = await response.json();
56
- return { digest, items: await Promise.all(items.map(doDefaultCorrectness)), total_count };
57
- };
58
- const get = async (uuid) => {
59
- const response = await request(METHOD.GET, `exercises/${uuid}`);
60
- return response.status === 404
61
- ? undefined
62
- : response.json().then(doDefaultCorrectness);
63
- };
64
- return {
65
- searchDigest,
66
- get,
67
- search,
68
- };
69
- };
70
- };
@@ -1,19 +0,0 @@
1
- /// <reference types="node" />
2
- export declare type FileValue = {
3
- dataType: 'file';
4
- mimeType: string;
5
- path: string;
6
- label: string;
7
- };
8
- export declare type FolderValue = {
9
- dataType: 'folder';
10
- files: FileValue[];
11
- };
12
- export declare const isFileValue: (thing: any) => thing is FileValue;
13
- export declare const isFolderValue: (thing: any) => thing is FolderValue;
14
- export interface FileServerAdapter {
15
- putFileContent: (source: FileValue, content: string) => Promise<FileValue>;
16
- getSignedViewerUrl: (source: FileValue) => Promise<string>;
17
- getFileContent: (source: FileValue) => Promise<Buffer>;
18
- }
19
- export declare const isFileOrFolder: (thing: any) => thing is FileValue | FolderValue;
@@ -1,13 +0,0 @@
1
- import { isPlainObject } from '../../guards';
2
- export const isFileValue = (thing) => isPlainObject(thing)
3
- && Object.keys(thing).every(key => ['dataType', 'path', 'label', 'mimeType'].includes(key))
4
- && thing.dataType === 'file'
5
- && typeof thing.mimeType === 'string'
6
- && typeof thing.path === 'string'
7
- && typeof thing.label === 'string';
8
- export const isFolderValue = (thing) => isPlainObject(thing)
9
- && Object.keys(thing).every(key => ['dataType', 'files'].includes(key))
10
- && thing.dataType === 'folder'
11
- && thing.files instanceof Array
12
- && thing.files.every(isFileValue);
13
- export const isFileOrFolder = (thing) => isFileValue(thing) || isFolderValue(thing);
@@ -1,17 +0,0 @@
1
- import { ConfigProviderForConfig } from '../../config';
2
- import { FileServerAdapter } from '.';
3
- export declare type Config = {
4
- port?: string;
5
- host?: string;
6
- storagePrefix: string;
7
- };
8
- interface Initializer<C> {
9
- dataDir: string;
10
- configSpace?: C;
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;
17
- export {};
@@ -1,73 +0,0 @@
1
- import fs from 'fs';
2
- import path from 'path';
3
- import { resolveConfigValue } from '../../config';
4
- import { ifDefined } from '../../guards';
5
- import cors from 'cors';
6
- import express from 'express';
7
- import multer from 'multer';
8
- import https from 'https';
9
- import { once } from "../../misc/helpers";
10
- import { assertString } from "../../assertions";
11
- /* istanbul ignore next */
12
- const startServer = once((port, uploadDir) => {
13
- // TODO - re-evaluate the `preservePath` behavior to match whatever s3 does
14
- const upload = multer({ dest: uploadDir, preservePath: true });
15
- const fileServerApp = express();
16
- fileServerApp.use(cors());
17
- fileServerApp.use(express.static(uploadDir));
18
- fileServerApp.post('/', upload.single('file'), async (req, res) => {
19
- const file = req.file;
20
- if (!file) {
21
- return res.status(400).send({ message: 'file is required' });
22
- }
23
- const destinationName = req.body.key.replace('${filename}', file.originalname);
24
- const destinationPath = path.join(uploadDir, destinationName);
25
- const destinationDirectory = path.dirname(destinationPath);
26
- await fs.promises.mkdir(destinationDirectory, { recursive: true });
27
- await fs.promises.rename(file.path, destinationPath);
28
- res.status(201).send();
29
- });
30
- const server = https.createServer({
31
- key: fs.readFileSync(assertString(process.env.SSL_KEY_FILE, new Error('ssl key is required for localFileServer')), 'utf8'),
32
- cert: fs.readFileSync(assertString(process.env.SSL_CRT_FILE, new Error('ssl key is required for localFileServer')), 'utf8'),
33
- }, fileServerApp);
34
- server.once('error', function (err) {
35
- if (err.code === 'EADDRINUSE') {
36
- // when the local dev server reloads files on every request it doesn't
37
- // actually tear down the old modules, so this server only starts on the
38
- // first execution and changes in its code will not be reloaded
39
- return;
40
- }
41
- throw err;
42
- });
43
- server.listen(port);
44
- return true;
45
- });
46
- export const localFileServer = (initializer) => (configProvider) => {
47
- const config = configProvider[ifDefined(initializer.configSpace, 'local')];
48
- const port = resolveConfigValue(config.port || '');
49
- const host = resolveConfigValue(config.host || '');
50
- const storagePrefix = resolveConfigValue(config.storagePrefix);
51
- const fileDir = storagePrefix.then((prefix) => path.join(initializer.dataDir, prefix));
52
- Promise.all([port, fileDir])
53
- .then(([port, fileDir]) => port && startServer(port, fileDir));
54
- const getSignedViewerUrl = async (source) => {
55
- return `https://${await host}:${await port}/${source.path}`;
56
- };
57
- const getFileContent = async (source) => {
58
- const filePath = path.join(await fileDir, source.path);
59
- return fs.promises.readFile(filePath);
60
- };
61
- const putFileContent = async (source, content) => {
62
- const filePath = path.join(await fileDir, source.path);
63
- const directory = path.dirname(filePath);
64
- await fs.promises.mkdir(directory, { recursive: true });
65
- await fs.promises.writeFile(filePath, content);
66
- return source;
67
- };
68
- return {
69
- getSignedViewerUrl,
70
- getFileContent,
71
- putFileContent,
72
- };
73
- };
@@ -1,16 +0,0 @@
1
- import { S3Client } from '@aws-sdk/client-s3';
2
- import { ConfigProviderForConfig } from '../../config';
3
- import { FileServerAdapter } from '.';
4
- export declare type Config = {
5
- bucketName: string;
6
- bucketRegion: string;
7
- };
8
- interface Initializer<C> {
9
- configSpace?: C;
10
- s3Client?: typeof S3Client;
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;
16
- export {};