@openstax/ts-utils 1.21.9 → 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 -11
  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,86 +0,0 @@
1
- /*
2
- * if code is split into multiple bundles, sometimes each bundle
3
- * will get its own definition of this module and then instanceof checks
4
- * are unreliable, this provides a way to reliably check the error types
5
- *
6
- * eg this will always work:
7
- * InvalidRequestError.matches(error);
8
- *
9
- * eg this might not work if you have code splitting:
10
- * error instanceof InvalidRequestError
11
- *
12
- */
13
- const errorIsType = (t) => (e) => e instanceof Error
14
- && e.constructor.TYPE === t.TYPE;
15
- /**
16
- * Returns true if the error is defined in this library
17
- */
18
- export const isAppError = (e) => e instanceof Error
19
- && typeof e.constructor.TYPE === 'string';
20
- /**
21
- * Invalid request error
22
- *
23
- * `InvalidRequestError.matches(error)` is a reliable way to check if an error is an
24
- * `InvalidRequestError`; `instanceof` checks may not work if code is split into multiple bundles
25
- */
26
- export class InvalidRequestError extends Error {
27
- constructor(message) {
28
- super(message || InvalidRequestError.TYPE);
29
- }
30
- }
31
- InvalidRequestError.TYPE = 'InvalidRequestError';
32
- InvalidRequestError.matches = errorIsType(InvalidRequestError);
33
- /**
34
- * Validation Error
35
- *
36
- * `ValidationError.matches(error)` is a reliable way to check if an error is an
37
- * `ValidationError`; `instanceof` checks may not work if code is split into multiple bundles
38
- */
39
- export class ValidationError extends Error {
40
- constructor(data) {
41
- super(InvalidRequestError.TYPE);
42
- this.data = data;
43
- }
44
- getData() { return this.data; }
45
- }
46
- ValidationError.TYPE = 'ValidationError';
47
- ValidationError.matches = errorIsType(ValidationError);
48
- /**
49
- * Unauthorized error
50
- *
51
- * `UnauthorizedError.matches(error)` is a reliable way to check if an error is an
52
- * `UnauthorizedError`; `instanceof` checks may not work if code is split into multiple bundles
53
- */
54
- export class UnauthorizedError extends Error {
55
- constructor(message) {
56
- super(message || UnauthorizedError.TYPE);
57
- }
58
- }
59
- UnauthorizedError.TYPE = 'UnauthorizedError';
60
- UnauthorizedError.matches = errorIsType(UnauthorizedError);
61
- /**
62
- * Not found error
63
- *
64
- * `NotFoundError.matches(error)` is a reliable way to check if an error is a
65
- * `NotFoundError`; `instanceof` checks may not work if code is split into multiple bundles
66
- */
67
- export class NotFoundError extends Error {
68
- constructor(message) {
69
- super(message || NotFoundError.TYPE);
70
- }
71
- }
72
- NotFoundError.TYPE = 'NotFoundError';
73
- NotFoundError.matches = errorIsType(NotFoundError);
74
- /**
75
- * Session expired error
76
- *
77
- * `SessionExpiredError.matches(error)` is a reliable way to check if an error is a
78
- * `SessionExpiredError`; `instanceof` checks may not work if code is split into multiple bundles
79
- */
80
- export class SessionExpiredError extends Error {
81
- constructor(message) {
82
- super(message || SessionExpiredError.TYPE);
83
- }
84
- }
85
- SessionExpiredError.TYPE = 'SessionExpiredError';
86
- SessionExpiredError.matches = errorIsType(SessionExpiredError);
@@ -1,7 +0,0 @@
1
- import { RetryOptions } from '../misc/helpers';
2
- import { GenericFetch } from '.';
3
- interface Options extends RetryOptions {
4
- status?: number[];
5
- }
6
- export declare const fetchStatusRetry: (base: GenericFetch, options: Options) => GenericFetch;
7
- export {};
@@ -1,12 +0,0 @@
1
- import { retryWithDelay } from '../misc/helpers';
2
- export const fetchStatusRetry = (base, options) => {
3
- return (...params) => retryWithDelay(() => base(...params).then(r => {
4
- var _a;
5
- if ((_a = options.status) === null || _a === void 0 ? void 0 : _a.includes(r.status)) {
6
- return r.text().then(text => {
7
- throw new Error(`fetch failed ${params[0]} -- ${r.status}: ${text}`);
8
- });
9
- }
10
- return r;
11
- }), options);
12
- };
@@ -1,64 +0,0 @@
1
- import { METHOD } from '../routing';
2
- export declare enum FetchStateType {
3
- SUCCESS = "success",
4
- ERROR = "error",
5
- LOADING = "loading",
6
- IDLE = "idle"
7
- }
8
- export declare type FetchState<D, E> = FetchStateLoading<D> | FetchStateError<D, E> | FetchStateSuccess<D> | FetchStateIdle;
9
- declare type FetchStateLoading<D> = {
10
- type: FetchStateType.LOADING;
11
- data?: D;
12
- };
13
- declare type FetchStateError<D, E> = {
14
- type: FetchStateType.ERROR;
15
- data?: D;
16
- error: E;
17
- };
18
- declare type FetchStateSuccess<D> = {
19
- type: FetchStateType.SUCCESS;
20
- data: D;
21
- };
22
- declare type FetchStateIdle = {
23
- type: FetchStateType.IDLE;
24
- };
25
- export declare const fetchLoading: <D, E>(previous?: FetchState<D, E> | undefined) => FetchStateLoading<D>;
26
- export declare const fetchError: <D, E>(error: E, previous?: FetchState<D, E> | undefined) => FetchStateError<D, E>;
27
- export declare const fetchSuccess: <D>(data: D) => FetchStateSuccess<D>;
28
- export declare const fetchIdle: () => FetchStateIdle;
29
- export declare const stateHasData: <D, E>(state: {
30
- type: FetchStateType;
31
- data?: D | undefined;
32
- error?: E | undefined;
33
- }) => state is {
34
- type: FetchStateType;
35
- data: D;
36
- };
37
- export declare const stateHasError: <D, E>(state: {
38
- type: FetchStateType;
39
- data?: D | undefined;
40
- error?: E | undefined;
41
- }) => state is {
42
- type: FetchStateType;
43
- error: E;
44
- };
45
- export declare type FetchConfig = {
46
- credentials?: 'include' | 'omit' | 'same-origin';
47
- method?: METHOD;
48
- body?: string;
49
- headers?: {
50
- [key: string]: string;
51
- };
52
- };
53
- declare type Headers = {
54
- get: (name: string) => string | null;
55
- };
56
- export declare type Response = {
57
- status: number;
58
- headers: Headers;
59
- json: () => Promise<any>;
60
- text: () => Promise<string>;
61
- };
62
- export declare type GenericFetch<C extends FetchConfig = FetchConfig, R extends Response = Response> = (url: string, fetchConfig?: C) => Promise<R>;
63
- export declare type ConfigForFetch<F> = F extends GenericFetch<infer C, any> ? C : never;
64
- export {};
@@ -1,46 +0,0 @@
1
- /*
2
- * these are just helpers for formatting responses, they don't actually do any loading. especially in UI development they
3
- * help with continuity over loading, reloading, saving, and errors. this is pretty nice in typescript because you have to deal
4
- * with the possibility that the result state is in a loading or error state. if you avoid dealing with those states you need
5
- * to write very clear code to ignore them, which easily presents missing functionality like errors that are not being messaged
6
- * to the user.
7
- * */
8
- export var FetchStateType;
9
- (function (FetchStateType) {
10
- FetchStateType["SUCCESS"] = "success";
11
- FetchStateType["ERROR"] = "error";
12
- FetchStateType["LOADING"] = "loading";
13
- FetchStateType["IDLE"] = "idle";
14
- })(FetchStateType || (FetchStateType = {}));
15
- /*
16
- * keeps existing data but sets the new status
17
- *
18
- * const state = fetchLoading(previousState)
19
- * */
20
- export const fetchLoading = (previous) => ({ type: FetchStateType.LOADING, ...(previous && 'data' in previous ? { data: previous.data } : {}) });
21
- /*
22
- * keeps existing data but sets the new status and error value
23
- *
24
- * const state = fetchError(error, previousState)
25
- * */
26
- export const fetchError = (error, previous) => ({ ...previous, type: FetchStateType.ERROR, error });
27
- /*
28
- * formats data with success type
29
- *
30
- * const state = fetchSuccess(newData)
31
- * */
32
- export const fetchSuccess = (data) => ({ type: FetchStateType.SUCCESS, data });
33
- /*
34
- * formats data with idle type
35
- *
36
- * const state = fetchIdle(newData)
37
- * */
38
- export const fetchIdle = () => ({ type: FetchStateType.IDLE });
39
- /*
40
- * guard for checking if the state has result data, it might be true for any state type.
41
- * */
42
- export const stateHasData = (state) => 'data' in state;
43
- /*
44
- * guard for checking if the state has an error, it might be true for error or loading states.
45
- * */
46
- export const stateHasError = (state) => 'error' in state;
@@ -1,30 +0,0 @@
1
- /**
2
- * checks if a thing is defined. while often easy to do with a simple if statement, in certain
3
- * situations the guard is required and its nice to have one pre-defined. E.g. in the following
4
- * example, the result is `Array<string>`.
5
- *
6
- * `const result = (array as Array<string | undefined>).filter(isDefined);`
7
- */
8
- export declare const isDefined: <X>(x: X) => x is Exclude<X, undefined>;
9
- /**
10
- * checks if a thing is a number. while often easy to do with a simple if statement, in certain
11
- * situations the guard is required and its nice to have one pre-defined. E.g. in the following
12
- * example, the result is `Array<number>`.
13
- *
14
- * `const result = (array as Array<number | undefined>).filter(isNumber);`
15
- */
16
- export declare const isNumber: (x: any) => x is number;
17
- /**
18
- * a guard for plain old javascript objects that are not based on some other prototype,
19
- * for example making them safe to JSON stringify and stuff
20
- */
21
- export declare const isPlainObject: (thing: any) => thing is {
22
- [key: string]: any;
23
- };
24
- /**
25
- * if the first thing is defined it uses it, otherwise it returns the second thing. this isn't
26
- * really a guard its just a way to provide a default value without creating a coverage branch.
27
- *
28
- * @example const valueWithDefault = ifDefined(thing, 'default value')
29
- */
30
- export declare const ifDefined: <X, D>(x: X, d: D) => D | Exclude<X, undefined>;
@@ -1,28 +0,0 @@
1
- /**
2
- * checks if a thing is defined. while often easy to do with a simple if statement, in certain
3
- * situations the guard is required and its nice to have one pre-defined. E.g. in the following
4
- * example, the result is `Array<string>`.
5
- *
6
- * `const result = (array as Array<string | undefined>).filter(isDefined);`
7
- */
8
- export const isDefined = (x) => x !== undefined;
9
- /**
10
- * checks if a thing is a number. while often easy to do with a simple if statement, in certain
11
- * situations the guard is required and its nice to have one pre-defined. E.g. in the following
12
- * example, the result is `Array<number>`.
13
- *
14
- * `const result = (array as Array<number | undefined>).filter(isNumber);`
15
- */
16
- export const isNumber = (x) => typeof x === 'number';
17
- /**
18
- * a guard for plain old javascript objects that are not based on some other prototype,
19
- * for example making them safe to JSON stringify and stuff
20
- */
21
- export const isPlainObject = (thing) => thing instanceof Object && thing.__proto__.constructor.name === 'Object';
22
- /**
23
- * if the first thing is defined it uses it, otherwise it returns the second thing. this isn't
24
- * really a guard its just a way to provide a default value without creating a coverage branch.
25
- *
26
- * @example const valueWithDefault = ifDefined(thing, 'default value')
27
- */
28
- export const ifDefined = (x, d) => isDefined(x) ? x : d;
@@ -1,4 +0,0 @@
1
- export * from './misc/partitionSequence';
2
- export * from './misc/helpers';
3
- export * from './misc/merge';
4
- export * from './misc/hashValue';
package/dist/esm/index.js DELETED
@@ -1,4 +0,0 @@
1
- export * from './misc/partitionSequence';
2
- export * from './misc/helpers';
3
- export * from './misc/merge';
4
- export * from './misc/hashValue';
@@ -1,23 +0,0 @@
1
- import { InvalidRequestError, NotFoundError, SessionExpiredError, UnauthorizedError, ValidationError } from '../errors';
2
- import type { ApiResponse } from '../routing';
3
- import type { Logger } from '../services/logger';
4
- export declare type DefaultErrors = {
5
- UnauthorizedError: UnauthorizedError;
6
- SessionExpiredError: SessionExpiredError;
7
- NotFoundError: NotFoundError;
8
- InvalidRequestError: InvalidRequestError;
9
- ValidationError: ValidationError;
10
- };
11
- export declare type Handlers<E> = {
12
- [T in keyof E]: (e: E[T], logger: Logger) => ApiResponse<number, any>;
13
- };
14
- export declare const defaultHandlers: Handlers<DefaultErrors>;
15
- /**
16
- * Creates an error handler. Provides default handlers for `UnauthorizedError`,
17
- * `SessionExpiredError`, `NotFoundError`, and `InvalidRequestError`. User-specified
18
- * handlers can be added to these. If no handler is found, the error is logged and
19
- * a 500 text response is returned.
20
- *
21
- * @param inputHandlers a map of errors to handler functions
22
- */
23
- export declare const createErrorHandler: <Errors = DefaultErrors>(inputHandlers?: Handlers<Errors> | undefined) => (e: Error, logger: Logger) => Promise<ApiResponse<number, any>>;
@@ -1,36 +0,0 @@
1
- import { isAppError } from '../errors';
2
- import { apiJsonResponse, apiTextResponse } from '../routing';
3
- import { Level } from '../services/logger';
4
- export const defaultHandlers = {
5
- UnauthorizedError: () => apiTextResponse(401, '401 UnauthorizedError'),
6
- SessionExpiredError: () => apiTextResponse(440, '440 SessionExpiredError'),
7
- NotFoundError: (e) => apiTextResponse(404, `404 ${e.message}`),
8
- InvalidRequestError: (e) => apiTextResponse(400, `400 ${e.message}`),
9
- ValidationError: (e) => apiJsonResponse(422, e.getData()),
10
- };
11
- /**
12
- * Creates an error handler. Provides default handlers for `UnauthorizedError`,
13
- * `SessionExpiredError`, `NotFoundError`, and `InvalidRequestError`. User-specified
14
- * handlers can be added to these. If no handler is found, the error is logged and
15
- * a 500 text response is returned.
16
- *
17
- * @param inputHandlers a map of errors to handler functions
18
- */
19
- export const createErrorHandler = (inputHandlers) => {
20
- const handlers = { ...defaultHandlers, ...inputHandlers };
21
- return async (e, logger) => {
22
- const name = isAppError(e) ? e.constructor.TYPE : e.constructor.name;
23
- const handler = handlers[name];
24
- if (handler) {
25
- // convincing typescript that this error is the right kind for the handler
26
- // we looked up based on the errors name is very annoying
27
- return handler(e, logger);
28
- }
29
- logger.logEvent(Level.Error, {
30
- name: e.name,
31
- message: e.message,
32
- stack: e.stack,
33
- });
34
- return apiTextResponse(500, '500 Error');
35
- };
36
- };
@@ -1,23 +0,0 @@
1
- import type { ConfigProviderForConfig } from '../config';
2
- import type { ApiResponse } from '../routing';
3
- import type { Logger } from '../services/logger';
4
- declare type Config = {
5
- logResponseSlowerThan: string;
6
- timeoutResponseAfter: string;
7
- };
8
- /**
9
- * Creates response middleware that logs slow responses and times out responses that take too long. lambda functions have a timeout setting, but when a lambda times out there is no way to log anything helpful before it exists. this middleware allows the logger context to show up for timeout requests. just make sure that the `timeoutResponseAfter` is set to something slightly shorter than the lambda timeout so that it has time to run.
10
- *
11
- * @param config
12
- * @param config.logResponseSlowerThan the config that specifies the threshold for a slow response
13
- * @param config.timeoutResponseAfter the config that specifies the timeout for a response
14
- * @example
15
- * createSlowResponseMiddleware({
16
- * logResponseSlowerThan: envConfig('LOG_SLOW_RESPONSE', 'runtime', '1000'),
17
- * timeoutResponseAfter: envConfig('RESPONSE_TIMEOUT', 'runtime', '28000'),
18
- * });
19
- */
20
- export declare const createSlowResponseMiddleware: (config: ConfigProviderForConfig<Config>) => () => (response: Promise<ApiResponse<number, any>> | undefined, { logger }: {
21
- logger: Logger;
22
- }) => Promise<ApiResponse<number, string>> | undefined;
23
- export {};
@@ -1,50 +0,0 @@
1
- import { resolveConfigValue } from '../config/resolveConfigValue';
2
- import { once } from '../misc/helpers';
3
- import { apiTextResponse } from '../routing';
4
- import { Level } from '../services/logger';
5
- /**
6
- * Creates response middleware that logs slow responses and times out responses that take too long. lambda functions have a timeout setting, but when a lambda times out there is no way to log anything helpful before it exists. this middleware allows the logger context to show up for timeout requests. just make sure that the `timeoutResponseAfter` is set to something slightly shorter than the lambda timeout so that it has time to run.
7
- *
8
- * @param config
9
- * @param config.logResponseSlowerThan the config that specifies the threshold for a slow response
10
- * @param config.timeoutResponseAfter the config that specifies the timeout for a response
11
- * @example
12
- * createSlowResponseMiddleware({
13
- * logResponseSlowerThan: envConfig('LOG_SLOW_RESPONSE', 'runtime', '1000'),
14
- * timeoutResponseAfter: envConfig('RESPONSE_TIMEOUT', 'runtime', '28000'),
15
- * });
16
- */
17
- export const createSlowResponseMiddleware = (config) => {
18
- const getSlowThreshold = once(() => resolveConfigValue(config.logResponseSlowerThan).then(result => parseInt(result, 10)));
19
- const getTimeoutAfter = once(() => resolveConfigValue(config.timeoutResponseAfter).then(result => parseInt(result, 10)));
20
- return () => (response, { logger }) => {
21
- const start = Date.now();
22
- if (!response) {
23
- return response;
24
- }
25
- return Promise.all([getSlowThreshold(), getTimeoutAfter()]).then(([slowThreshold, timeoutAfter]) => {
26
- let timeout = undefined;
27
- const timeoutPromise = isNaN(timeoutAfter)
28
- ? undefined
29
- : new Promise(resolve => timeout = setTimeout(() => {
30
- logger.logEvent(Level.Error, {
31
- message: 'request processing timed out',
32
- });
33
- resolve(apiTextResponse(504, '504 Gateway Timeout'));
34
- }, timeoutAfter));
35
- const requestPromise = response.finally(() => {
36
- const time = Date.now() - start;
37
- if (timeout !== undefined) {
38
- clearTimeout(timeout);
39
- }
40
- if (time > slowThreshold) {
41
- logger.logEvent(Level.Warn, {
42
- message: 'slow response',
43
- time,
44
- });
45
- }
46
- });
47
- return timeoutPromise ? Promise.race([timeoutPromise, requestPromise]) : requestPromise;
48
- });
49
- };
50
- };
@@ -1,47 +0,0 @@
1
- import { TupleZip } from '../types';
2
- export declare type MiddlewareProvider<Sa, M, A extends any[], R> = (app: Sa, appBinder?: ((app: Sa, provider: MiddlewareProvider<Sa, M, A, R>) => (middleware: M, ...args: A) => R)) => (middleware: M, ...args: A) => R;
3
- export declare type MiddlewareTransformProvider<Sa, M, A extends any[], R> = (app: Sa) => (middleware: M, ...args: A) => Omit<M, keyof R> & R;
4
- export declare type MiddlewareInput<S> = S extends MiddlewareProvider<any, infer M, any, any> ? M : never;
5
- export declare type ServiceMiddlewareProviderResult<M, S> = [M] extends [never] ? never : [M] extends [MiddlewareInput<S>] ? S extends MiddlewareTransformProvider<any, M, any, infer R> ? (Omit<R, keyof M> & M) extends R ? Omit<R, keyof M> & M : R extends M ? R : Omit<M, keyof R> & R : S extends MiddlewareProvider<any, M, any, infer R> ? R : never : never;
6
- export declare type ServiceMiddlewareProviderArgs<S> = S extends MiddlewareProvider<any, any, infer A, any> ? A : never;
7
- export declare type ServiceMiddlewareProviderChainResult<C, M> = C extends [infer S1, ...infer S] ? S extends never[] ? ServiceMiddlewareProviderResult<M, S1> : ServiceMiddlewareProviderChainResult<S, ServiceMiddlewareProviderResult<M, S1>> : C extends unknown ? M : never;
8
- export declare type ServiceMiddlewareProviderChainArgs<C> = C extends [infer S1, ...infer S] ? S extends never[] ? ServiceMiddlewareProviderArgs<S1> : TupleZip<ServiceMiddlewareProviderChainArgs<S>, ServiceMiddlewareProviderArgs<S1>> : C extends unknown ? [] : never;
9
- /**
10
- * Creates a middleware composer for given AppServices and input value types. The composer accepts a list of middleware
11
- * that it assembles into a chain. The function returned by the composer takes a value of the given input value type,
12
- * passes that value through the chain, and returns the result of the last element in the chain. The ending value will
13
- * depend on the composed middleware.
14
- *
15
- * Examples:
16
- *
17
- * ```
18
- * export const composeServiceMiddleware =
19
- * makeComposeMiddleware<AppServices, {request: ApiRouteRequest}>();
20
- * export const composeResponseMiddleware =
21
- * makeComposeMiddleware<AppServices, Promise<ApiRouteResponse> | undefined>();
22
- *
23
- * // `requestServiceProvider` is a function that expects
24
- * //`{request: ApiRouteRequest}` (specified in the call to
25
- * //`makeComposeMiddleware`); for requestServiceProviders as part of routes in
26
- * // particular, the request responder calls this when it resolves the routes.
27
- *
28
- * const requestServiceProvider = composeServiceMiddleware(
29
- * cookieAuthMiddleware, // expects `request` (from input), adds `authProvider`
30
- * myDocumentStoreMiddleware, // expects authProvider, adds the document store
31
- * myDocumentSearchMiddleware, // expects document store, adds search provider
32
- * ); // if you try to specify them in the wrong order it'll yell at you
33
- * ```
34
- *
35
- * WARNING: depending on how you use it, typescript _sometimes_ explodes on these recursive types. if you have problems in your build
36
- * with memory, you will have to specify the expected result type when calling the middleware reducer. this is a little annoying,
37
- * but it will still correctly error if the type you specify is wrong, so you've still got the type safety.
38
- *
39
- * ```
40
- * // this might work, or it might make your compiler run out of memory
41
- * eg: const myThing = makeComposeMiddleware()(...);
42
- *
43
- * // this helps typescript figure out what is going on
44
- * eg: const myThing: myType = makeComposeMiddleware()(...);
45
- * ```
46
- */
47
- export declare const makeComposeMiddleware: <Sa, M>() => <C extends any[]>(...chain: C) => MiddlewareProvider<Sa, M, ServiceMiddlewareProviderChainArgs<C>, ServiceMiddlewareProviderChainResult<C, M>>;
@@ -1,44 +0,0 @@
1
- /**
2
- * Creates a middleware composer for given AppServices and input value types. The composer accepts a list of middleware
3
- * that it assembles into a chain. The function returned by the composer takes a value of the given input value type,
4
- * passes that value through the chain, and returns the result of the last element in the chain. The ending value will
5
- * depend on the composed middleware.
6
- *
7
- * Examples:
8
- *
9
- * ```
10
- * export const composeServiceMiddleware =
11
- * makeComposeMiddleware<AppServices, {request: ApiRouteRequest}>();
12
- * export const composeResponseMiddleware =
13
- * makeComposeMiddleware<AppServices, Promise<ApiRouteResponse> | undefined>();
14
- *
15
- * // `requestServiceProvider` is a function that expects
16
- * //`{request: ApiRouteRequest}` (specified in the call to
17
- * //`makeComposeMiddleware`); for requestServiceProviders as part of routes in
18
- * // particular, the request responder calls this when it resolves the routes.
19
- *
20
- * const requestServiceProvider = composeServiceMiddleware(
21
- * cookieAuthMiddleware, // expects `request` (from input), adds `authProvider`
22
- * myDocumentStoreMiddleware, // expects authProvider, adds the document store
23
- * myDocumentSearchMiddleware, // expects document store, adds search provider
24
- * ); // if you try to specify them in the wrong order it'll yell at you
25
- * ```
26
- *
27
- * WARNING: depending on how you use it, typescript _sometimes_ explodes on these recursive types. if you have problems in your build
28
- * with memory, you will have to specify the expected result type when calling the middleware reducer. this is a little annoying,
29
- * but it will still correctly error if the type you specify is wrong, so you've still got the type safety.
30
- *
31
- * ```
32
- * // this might work, or it might make your compiler run out of memory
33
- * eg: const myThing = makeComposeMiddleware()(...);
34
- *
35
- * // this helps typescript figure out what is going on
36
- * eg: const myThing: myType = makeComposeMiddleware()(...);
37
- * ```
38
- */
39
- export const makeComposeMiddleware = () => (...chain) => (app, appBinder) => {
40
- const boundChain = chain.map(provider => appBinder ? appBinder(app, provider) : provider(app));
41
- return (middleware, ...args) => {
42
- return boundChain.reduce((result, provider) => provider(result, ...args), middleware);
43
- };
44
- };
@@ -1,20 +0,0 @@
1
- import { APIGatewayProxyEventV2 } from 'aws-lambda';
2
- import { ConfigProviderForConfig } from '../config';
3
- import { ApiResponse } from '../routing';
4
- declare type Config = {
5
- corsAllowedHostRegex: string;
6
- };
7
- /**
8
- * Creates response middleware that adds CORS headers to responses from approved hosts.
9
- *
10
- * @param config the config object
11
- * @param config.corsAllowedHostRegex the config that specifies the regex for allowed hosts
12
- * @example
13
- * createLambdaCorsResponseMiddleware({
14
- * corsAllowedHostRegex: '(openstax.org|herokuapp.com)$'
15
- * }),
16
- */
17
- export declare const createLambdaCorsResponseMiddleware: (config: ConfigProviderForConfig<Config>) => () => (responsePromise: Promise<ApiResponse<number, any>> | undefined, { request }: {
18
- request: APIGatewayProxyEventV2;
19
- }) => Promise<ApiResponse<number, any>> | undefined;
20
- export {};
@@ -1,38 +0,0 @@
1
- import { resolveConfigValue } from '../config/resolveConfigValue';
2
- import { apiTextResponse } from '../routing';
3
- /**
4
- * Creates response middleware that adds CORS headers to responses from approved hosts.
5
- *
6
- * @param config the config object
7
- * @param config.corsAllowedHostRegex the config that specifies the regex for allowed hosts
8
- * @example
9
- * createLambdaCorsResponseMiddleware({
10
- * corsAllowedHostRegex: '(openstax.org|herokuapp.com)$'
11
- * }),
12
- */
13
- export const createLambdaCorsResponseMiddleware = (config) => () => (responsePromise, { request }) => {
14
- const cors = async () => {
15
- const allowedHost = await resolveConfigValue(config.corsAllowedHostRegex);
16
- if (request.headers.origin && request.headers.origin !== 'null' && new URL(request.headers.origin).hostname.match(new RegExp(allowedHost))) {
17
- return {
18
- 'Access-Control-Allow-Origin': request.headers.origin,
19
- 'Access-Control-Allow-Credentials': 'true',
20
- 'Access-Control-Allow-Headers': 'content-type',
21
- 'Access-Control-Allow-Methods': 'POST, GET, OPTIONS',
22
- };
23
- }
24
- };
25
- if (responsePromise) {
26
- return responsePromise.then(async (response) => {
27
- response.headers = {
28
- ...await cors(),
29
- ...response.headers
30
- };
31
- return response;
32
- });
33
- }
34
- if (request.requestContext.http.method === 'OPTIONS') {
35
- return cors().then(headers => apiTextResponse(200, '', headers));
36
- }
37
- return responsePromise;
38
- };
@@ -1,4 +0,0 @@
1
- /**
2
- * Creates response middleware that throws a `NotFoundError` if the response is undefined.
3
- */
4
- export declare const createThrowNotFoundMiddleware: <Ro>() => () => (response: Promise<Ro> | undefined) => Promise<Ro>;
@@ -1,10 +0,0 @@
1
- import { NotFoundError } from '../errors';
2
- /**
3
- * Creates response middleware that throws a `NotFoundError` if the response is undefined.
4
- */
5
- export const createThrowNotFoundMiddleware = () => () => (response) => {
6
- if (!response) {
7
- throw new NotFoundError('not found');
8
- }
9
- return response;
10
- };
@@ -1,10 +0,0 @@
1
- export declare type HashValue = string | number | boolean | null | HashCompoundValue;
2
- export declare type HashCompoundValue = Array<HashValue> | {
3
- [key: string]: HashValue;
4
- };
5
- /**
6
- * creates a string hash of lots of different kinds of things.
7
- *
8
- * @example hashValue({someKey: 'someValue'})
9
- */
10
- export declare const hashValue: (value: HashValue) => string;
@@ -1,13 +0,0 @@
1
- import { createHash } from 'crypto';
2
- /**
3
- * creates a string hash of lots of different kinds of things.
4
- *
5
- * @example hashValue({someKey: 'someValue'})
6
- */
7
- export const hashValue = (value) => {
8
- // hack for sorting keys https://stackoverflow.com/a/53593328/14809536
9
- const allKeys = new Set();
10
- JSON.stringify(value, (k, v) => (allKeys.add(k), v));
11
- const strValue = JSON.stringify(value, Array.from(allKeys).sort());
12
- return createHash('sha1').update(strValue).digest('hex');
13
- };