@squiz/dx-common-lib 1.63.1-alpha.7 → 1.63.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (72) hide show
  1. package/CHANGELOG.md +10 -84
  2. package/coverage/clover.xml +608 -0
  3. package/coverage/coverage-final.json +48 -0
  4. package/coverage/lcov-report/base.css +224 -0
  5. package/coverage/lcov-report/block-navigation.js +87 -0
  6. package/coverage/lcov-report/favicon.png +0 -0
  7. package/coverage/lcov-report/index.html +251 -0
  8. package/coverage/lcov-report/prettify.css +1 -0
  9. package/coverage/lcov-report/prettify.js +2 -0
  10. package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  11. package/coverage/lcov-report/sorter.js +196 -0
  12. package/coverage/lcov-report/src/api-key-validation/CloudflareApiKeyService.ts.html +382 -0
  13. package/coverage/lcov-report/src/api-key-validation/DevelopmentApiKeyService.ts.html +115 -0
  14. package/coverage/lcov-report/src/api-key-validation/getApiKeyService.ts.html +166 -0
  15. package/coverage/lcov-report/src/api-key-validation/index.html +146 -0
  16. package/coverage/lcov-report/src/assertions/assertAssign.ts.html +151 -0
  17. package/coverage/lcov-report/src/assertions/assertAssignWithDefaultUndefinedValue.ts.html +136 -0
  18. package/coverage/lcov-report/src/assertions/assertIsBoolean.ts.html +100 -0
  19. package/coverage/lcov-report/src/assertions/assertIsDefined.ts.html +106 -0
  20. package/coverage/lcov-report/src/assertions/assertIsEnumValue.ts.html +130 -0
  21. package/coverage/lcov-report/src/assertions/assertIsMapOfStringString.ts.html +172 -0
  22. package/coverage/lcov-report/src/assertions/assertIsNotAnEmptyString.ts.html +136 -0
  23. package/coverage/lcov-report/src/assertions/assertIsObject.ts.html +118 -0
  24. package/coverage/lcov-report/src/assertions/assertIsString.ts.html +118 -0
  25. package/coverage/lcov-report/src/assertions/index.html +251 -0
  26. package/coverage/lcov-report/src/assertions/index.ts.html +121 -0
  27. package/coverage/lcov-report/src/cache/applyDefaultRulesToCacheControlObject.ts.html +154 -0
  28. package/coverage/lcov-report/src/cache/cacheControlToString.ts.html +151 -0
  29. package/coverage/lcov-report/src/cache/index.html +176 -0
  30. package/coverage/lcov-report/src/cache/index.ts.html +97 -0
  31. package/coverage/lcov-report/src/cache/parseAndSanitiseCacheControlHeader.ts.html +169 -0
  32. package/coverage/lcov-report/src/cache/parseCacheControl.ts.html +307 -0
  33. package/coverage/lcov-report/src/custom-types.d.ts.html +112 -0
  34. package/coverage/lcov-report/src/error/BadRequestError.ts.html +106 -0
  35. package/coverage/lcov-report/src/error/ErrorWithHttpStatusCode.ts.html +100 -0
  36. package/coverage/lcov-report/src/error/InternalServerError.ts.html +106 -0
  37. package/coverage/lcov-report/src/error/InvalidTokenError.ts.html +109 -0
  38. package/coverage/lcov-report/src/error/MethodNotImplementedError.ts.html +106 -0
  39. package/coverage/lcov-report/src/error/ResourceNotFoundError.ts.html +106 -0
  40. package/coverage/lcov-report/src/error/TimeoutError.ts.html +109 -0
  41. package/coverage/lcov-report/src/error/UnAuthenticatedRequestError.ts.html +106 -0
  42. package/coverage/lcov-report/src/error/UnprivilegedError.ts.html +109 -0
  43. package/coverage/lcov-report/src/error/index.html +251 -0
  44. package/coverage/lcov-report/src/error/index.ts.html +115 -0
  45. package/coverage/lcov-report/src/formatted-text/formattedTextToHtmlString.ts.html +373 -0
  46. package/coverage/lcov-report/src/formatted-text/index.html +116 -0
  47. package/coverage/lcov-report/src/index.html +131 -0
  48. package/coverage/lcov-report/src/index.ts.html +127 -0
  49. package/coverage/lcov-report/src/json-order/index.html +161 -0
  50. package/coverage/lcov-report/src/json-order/index.ts.html +103 -0
  51. package/coverage/lcov-report/src/json-order/order.ts.html +442 -0
  52. package/coverage/lcov-report/src/json-order/parse.ts.html +280 -0
  53. package/coverage/lcov-report/src/json-order/stringify.ts.html +151 -0
  54. package/coverage/lcov-report/src/server-utils/apiKeyMiddleware.ts.html +154 -0
  55. package/coverage/lcov-report/src/server-utils/errorMiddleware.ts.html +184 -0
  56. package/coverage/lcov-report/src/server-utils/index.html +146 -0
  57. package/coverage/lcov-report/src/server-utils/requestLogger.ts.html +133 -0
  58. package/coverage/lcov-report/src/util/getNodeEnv.ts.html +118 -0
  59. package/coverage/lcov-report/src/util/getPageInfo.ts.html +169 -0
  60. package/coverage/lcov-report/src/util/index.html +221 -0
  61. package/coverage/lcov-report/src/util/index.ts.html +106 -0
  62. package/coverage/lcov-report/src/util/isPathTryingToAccessOutsideOfRoot.ts.html +109 -0
  63. package/coverage/lcov-report/src/util/isReadable.ts.html +121 -0
  64. package/coverage/lcov-report/src/util/joinAbsoluteUrlPath.ts.html +154 -0
  65. package/coverage/lcov-report/src/util/never.ts.html +97 -0
  66. package/coverage/lcov-report/src/util/parseEnvVarForVar.ts.html +121 -0
  67. package/coverage/lcov-report/src/zip/index.html +116 -0
  68. package/coverage/lcov-report/src/zip/zipDirectory.ts.html +178 -0
  69. package/coverage/lcov.info +1190 -0
  70. package/package.json +7 -4
  71. package/squiz-dx-common-lib-1.39.1-alpha.7.tgz +0 -0
  72. package/tsconfig.tsbuildinfo +1 -1
@@ -0,0 +1,280 @@
1
+
2
+ <!doctype html>
3
+ <html lang="en">
4
+
5
+ <head>
6
+ <title>Code coverage report for src/json-order/parse.ts</title>
7
+ <meta charset="utf-8" />
8
+ <link rel="stylesheet" href="../../prettify.css" />
9
+ <link rel="stylesheet" href="../../base.css" />
10
+ <link rel="shortcut icon" type="image/x-icon" href="../../favicon.png" />
11
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
12
+ <style type='text/css'>
13
+ .coverage-summary .sorter {
14
+ background-image: url(../../sort-arrow-sprite.png);
15
+ }
16
+ </style>
17
+ </head>
18
+
19
+ <body>
20
+ <div class='wrapper'>
21
+ <div class='pad1'>
22
+ <h1><a href="../../index.html">All files</a> / <a href="index.html">src/json-order</a> parse.ts</h1>
23
+ <div class='clearfix'>
24
+
25
+ <div class='fl pad1y space-right2'>
26
+ <span class="strong">100% </span>
27
+ <span class="quiet">Statements</span>
28
+ <span class='fraction'>20/20</span>
29
+ </div>
30
+
31
+
32
+ <div class='fl pad1y space-right2'>
33
+ <span class="strong">71.42% </span>
34
+ <span class="quiet">Branches</span>
35
+ <span class='fraction'>5/7</span>
36
+ </div>
37
+
38
+
39
+ <div class='fl pad1y space-right2'>
40
+ <span class="strong">100% </span>
41
+ <span class="quiet">Functions</span>
42
+ <span class='fraction'>3/3</span>
43
+ </div>
44
+
45
+
46
+ <div class='fl pad1y space-right2'>
47
+ <span class="strong">100% </span>
48
+ <span class="quiet">Lines</span>
49
+ <span class='fraction'>20/20</span>
50
+ </div>
51
+
52
+
53
+ </div>
54
+ <p class="quiet">
55
+ Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
56
+ </p>
57
+ <template id="filterTemplate">
58
+ <div class="quiet">
59
+ Filter:
60
+ <input oninput="onInput()" type="search" id="fileSearch">
61
+ </div>
62
+ </template>
63
+ </div>
64
+ <div class='status-line high'></div>
65
+ <pre><table class="coverage">
66
+ <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
67
+ <a name='L2'></a><a href='#L2'>2</a>
68
+ <a name='L3'></a><a href='#L3'>3</a>
69
+ <a name='L4'></a><a href='#L4'>4</a>
70
+ <a name='L5'></a><a href='#L5'>5</a>
71
+ <a name='L6'></a><a href='#L6'>6</a>
72
+ <a name='L7'></a><a href='#L7'>7</a>
73
+ <a name='L8'></a><a href='#L8'>8</a>
74
+ <a name='L9'></a><a href='#L9'>9</a>
75
+ <a name='L10'></a><a href='#L10'>10</a>
76
+ <a name='L11'></a><a href='#L11'>11</a>
77
+ <a name='L12'></a><a href='#L12'>12</a>
78
+ <a name='L13'></a><a href='#L13'>13</a>
79
+ <a name='L14'></a><a href='#L14'>14</a>
80
+ <a name='L15'></a><a href='#L15'>15</a>
81
+ <a name='L16'></a><a href='#L16'>16</a>
82
+ <a name='L17'></a><a href='#L17'>17</a>
83
+ <a name='L18'></a><a href='#L18'>18</a>
84
+ <a name='L19'></a><a href='#L19'>19</a>
85
+ <a name='L20'></a><a href='#L20'>20</a>
86
+ <a name='L21'></a><a href='#L21'>21</a>
87
+ <a name='L22'></a><a href='#L22'>22</a>
88
+ <a name='L23'></a><a href='#L23'>23</a>
89
+ <a name='L24'></a><a href='#L24'>24</a>
90
+ <a name='L25'></a><a href='#L25'>25</a>
91
+ <a name='L26'></a><a href='#L26'>26</a>
92
+ <a name='L27'></a><a href='#L27'>27</a>
93
+ <a name='L28'></a><a href='#L28'>28</a>
94
+ <a name='L29'></a><a href='#L29'>29</a>
95
+ <a name='L30'></a><a href='#L30'>30</a>
96
+ <a name='L31'></a><a href='#L31'>31</a>
97
+ <a name='L32'></a><a href='#L32'>32</a>
98
+ <a name='L33'></a><a href='#L33'>33</a>
99
+ <a name='L34'></a><a href='#L34'>34</a>
100
+ <a name='L35'></a><a href='#L35'>35</a>
101
+ <a name='L36'></a><a href='#L36'>36</a>
102
+ <a name='L37'></a><a href='#L37'>37</a>
103
+ <a name='L38'></a><a href='#L38'>38</a>
104
+ <a name='L39'></a><a href='#L39'>39</a>
105
+ <a name='L40'></a><a href='#L40'>40</a>
106
+ <a name='L41'></a><a href='#L41'>41</a>
107
+ <a name='L42'></a><a href='#L42'>42</a>
108
+ <a name='L43'></a><a href='#L43'>43</a>
109
+ <a name='L44'></a><a href='#L44'>44</a>
110
+ <a name='L45'></a><a href='#L45'>45</a>
111
+ <a name='L46'></a><a href='#L46'>46</a>
112
+ <a name='L47'></a><a href='#L47'>47</a>
113
+ <a name='L48'></a><a href='#L48'>48</a>
114
+ <a name='L49'></a><a href='#L49'>49</a>
115
+ <a name='L50'></a><a href='#L50'>50</a>
116
+ <a name='L51'></a><a href='#L51'>51</a>
117
+ <a name='L52'></a><a href='#L52'>52</a>
118
+ <a name='L53'></a><a href='#L53'>53</a>
119
+ <a name='L54'></a><a href='#L54'>54</a>
120
+ <a name='L55'></a><a href='#L55'>55</a>
121
+ <a name='L56'></a><a href='#L56'>56</a>
122
+ <a name='L57'></a><a href='#L57'>57</a>
123
+ <a name='L58'></a><a href='#L58'>58</a>
124
+ <a name='L59'></a><a href='#L59'>59</a>
125
+ <a name='L60'></a><a href='#L60'>60</a>
126
+ <a name='L61'></a><a href='#L61'>61</a>
127
+ <a name='L62'></a><a href='#L62'>62</a>
128
+ <a name='L63'></a><a href='#L63'>63</a>
129
+ <a name='L64'></a><a href='#L64'>64</a>
130
+ <a name='L65'></a><a href='#L65'>65</a>
131
+ <a name='L66'></a><a href='#L66'>66</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
132
+ <span class="cline-any cline-neutral">&nbsp;</span>
133
+ <span class="cline-any cline-yes">1x</span>
134
+ <span class="cline-any cline-neutral">&nbsp;</span>
135
+ <span class="cline-any cline-neutral">&nbsp;</span>
136
+ <span class="cline-any cline-neutral">&nbsp;</span>
137
+ <span class="cline-any cline-neutral">&nbsp;</span>
138
+ <span class="cline-any cline-neutral">&nbsp;</span>
139
+ <span class="cline-any cline-yes">37x</span>
140
+ <span class="cline-any cline-neutral">&nbsp;</span>
141
+ <span class="cline-any cline-yes">37x</span>
142
+ <span class="cline-any cline-yes">2x</span>
143
+ <span class="cline-any cline-neutral">&nbsp;</span>
144
+ <span class="cline-any cline-neutral">&nbsp;</span>
145
+ <span class="cline-any cline-neutral">&nbsp;</span>
146
+ <span class="cline-any cline-yes">35x</span>
147
+ <span class="cline-any cline-yes">26x</span>
148
+ <span class="cline-any cline-neutral">&nbsp;</span>
149
+ <span class="cline-any cline-neutral">&nbsp;</span>
150
+ <span class="cline-any cline-yes">35x</span>
151
+ <span class="cline-any cline-yes">62x</span>
152
+ <span class="cline-any cline-neutral">&nbsp;</span>
153
+ <span class="cline-any cline-yes">62x</span>
154
+ <span class="cline-any cline-yes">25x</span>
155
+ <span class="cline-any cline-neutral">&nbsp;</span>
156
+ <span class="cline-any cline-neutral">&nbsp;</span>
157
+ <span class="cline-any cline-neutral">&nbsp;</span>
158
+ <span class="cline-any cline-neutral">&nbsp;</span>
159
+ <span class="cline-any cline-neutral">&nbsp;</span>
160
+ <span class="cline-any cline-neutral">&nbsp;</span>
161
+ <span class="cline-any cline-neutral">&nbsp;</span>
162
+ <span class="cline-any cline-neutral">&nbsp;</span>
163
+ <span class="cline-any cline-neutral">&nbsp;</span>
164
+ <span class="cline-any cline-neutral">&nbsp;</span>
165
+ <span class="cline-any cline-neutral">&nbsp;</span>
166
+ <span class="cline-any cline-neutral">&nbsp;</span>
167
+ <span class="cline-any cline-neutral">&nbsp;</span>
168
+ <span class="cline-any cline-neutral">&nbsp;</span>
169
+ <span class="cline-any cline-neutral">&nbsp;</span>
170
+ <span class="cline-any cline-neutral">&nbsp;</span>
171
+ <span class="cline-any cline-neutral">&nbsp;</span>
172
+ <span class="cline-any cline-yes">1x</span>
173
+ <span class="cline-any cline-neutral">&nbsp;</span>
174
+ <span class="cline-any cline-neutral">&nbsp;</span>
175
+ <span class="cline-any cline-neutral">&nbsp;</span>
176
+ <span class="cline-any cline-neutral">&nbsp;</span>
177
+ <span class="cline-any cline-yes">14x</span>
178
+ <span class="cline-any cline-yes">1x</span>
179
+ <span class="cline-any cline-neutral">&nbsp;</span>
180
+ <span class="cline-any cline-neutral">&nbsp;</span>
181
+ <span class="cline-any cline-yes">13x</span>
182
+ <span class="cline-any cline-yes">1x</span>
183
+ <span class="cline-any cline-neutral">&nbsp;</span>
184
+ <span class="cline-any cline-neutral">&nbsp;</span>
185
+ <span class="cline-any cline-yes">12x</span>
186
+ <span class="cline-any cline-neutral">&nbsp;</span>
187
+ <span class="cline-any cline-yes">12x</span>
188
+ <span class="cline-any cline-yes">12x</span>
189
+ <span class="cline-any cline-yes">12x</span>
190
+ <span class="cline-any cline-neutral">&nbsp;</span>
191
+ <span class="cline-any cline-neutral">&nbsp;</span>
192
+ <span class="cline-any cline-neutral">&nbsp;</span>
193
+ <span class="cline-any cline-neutral">&nbsp;</span>
194
+ <span class="cline-any cline-neutral">&nbsp;</span>
195
+ <span class="cline-any cline-yes">1x</span>
196
+ <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import {OrderedParseResult, PropertyMap} from './models';
197
+ &nbsp;
198
+ const traverseObject = &lt;T extends Record&lt;string, any&gt;&gt;(
199
+ obj: T,
200
+ map: PropertyMap,
201
+ parentKey: string,
202
+ separator: string
203
+ ) =&gt; {
204
+ const childKeys = Object.keys(obj);
205
+ &nbsp;
206
+ if (childKeys.length === 0) {
207
+ return;
208
+ }
209
+ &nbsp;
210
+ // Ignore storing keys for arrays
211
+ if (!Array.isArray(obj)) {
212
+ map[`${parentKey}`] = childKeys;
213
+ }
214
+ &nbsp;
215
+ childKeys.forEach((childKey) =&gt; {
216
+ const value = obj[childKey];
217
+ &nbsp;
218
+ if (typeof value === 'object') {
219
+ traverseObject(
220
+ value,
221
+ map,
222
+ `${parentKey}${separator}${childKey}`,
223
+ separator
224
+ );
225
+ }
226
+ });
227
+ };
228
+ &nbsp;
229
+ /**
230
+ * Parse a JSON string and generate a map
231
+ *
232
+ * @param jsonString a json string
233
+ * @param prefix a non-empty `string` that controls what the key prefix value is in the generated map. Defaults to `$`.
234
+ * @param separator a non-empty `string` that controls what the key separator is in the generated map. Defaults to `~`.
235
+ * @returns an object containing the parsed `object: T` and the `map: PropertyMap`
236
+ */
237
+ const parse = &lt;T extends object&gt;(
238
+ jsonString: string,
239
+ prefix = <span class="branch-0 cbranch-no" title="branch not covered" >'$',</span>
240
+ separator = <span class="branch-0 cbranch-no" title="branch not covered" >'~'</span>
241
+ ): OrderedParseResult&lt;T&gt; =&gt; {
242
+ if (prefix.length &lt; 1) {
243
+ throw new Error('Prefix should not be an empty string.');
244
+ }
245
+ &nbsp;
246
+ if (separator.length &lt; 1) {
247
+ throw new Error('Separator should not be an empty string.');
248
+ }
249
+ &nbsp;
250
+ const obj: T = JSON.parse(jsonString);
251
+ &nbsp;
252
+ const map = {};
253
+ traverseObject(obj, map, prefix, separator);
254
+ return {
255
+ object: obj,
256
+ map,
257
+ };
258
+ };
259
+ &nbsp;
260
+ export default parse;
261
+ &nbsp;</pre></td></tr></table></pre>
262
+
263
+ <div class='push'></div><!-- for sticky footer -->
264
+ </div><!-- /wrapper -->
265
+ <div class='footer quiet pad2 space-top1 center small'>
266
+ Code coverage generated by
267
+ <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
268
+ at 2023-03-21T04:59:30.046Z
269
+ </div>
270
+ <script src="../../prettify.js"></script>
271
+ <script>
272
+ window.onload = function () {
273
+ prettyPrint();
274
+ };
275
+ </script>
276
+ <script src="../../sorter.js"></script>
277
+ <script src="../../block-navigation.js"></script>
278
+ </body>
279
+ </html>
280
+
@@ -0,0 +1,151 @@
1
+
2
+ <!doctype html>
3
+ <html lang="en">
4
+
5
+ <head>
6
+ <title>Code coverage report for src/json-order/stringify.ts</title>
7
+ <meta charset="utf-8" />
8
+ <link rel="stylesheet" href="../../prettify.css" />
9
+ <link rel="stylesheet" href="../../base.css" />
10
+ <link rel="shortcut icon" type="image/x-icon" href="../../favicon.png" />
11
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
12
+ <style type='text/css'>
13
+ .coverage-summary .sorter {
14
+ background-image: url(../../sort-arrow-sprite.png);
15
+ }
16
+ </style>
17
+ </head>
18
+
19
+ <body>
20
+ <div class='wrapper'>
21
+ <div class='pad1'>
22
+ <h1><a href="../../index.html">All files</a> / <a href="index.html">src/json-order</a> stringify.ts</h1>
23
+ <div class='clearfix'>
24
+
25
+ <div class='fl pad1y space-right2'>
26
+ <span class="strong">100% </span>
27
+ <span class="quiet">Statements</span>
28
+ <span class='fraction'>4/4</span>
29
+ </div>
30
+
31
+
32
+ <div class='fl pad1y space-right2'>
33
+ <span class="strong">0% </span>
34
+ <span class="quiet">Branches</span>
35
+ <span class='fraction'>0/1</span>
36
+ </div>
37
+
38
+
39
+ <div class='fl pad1y space-right2'>
40
+ <span class="strong">100% </span>
41
+ <span class="quiet">Functions</span>
42
+ <span class='fraction'>1/1</span>
43
+ </div>
44
+
45
+
46
+ <div class='fl pad1y space-right2'>
47
+ <span class="strong">100% </span>
48
+ <span class="quiet">Lines</span>
49
+ <span class='fraction'>4/4</span>
50
+ </div>
51
+
52
+
53
+ </div>
54
+ <p class="quiet">
55
+ Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
56
+ </p>
57
+ <template id="filterTemplate">
58
+ <div class="quiet">
59
+ Filter:
60
+ <input oninput="onInput()" type="search" id="fileSearch">
61
+ </div>
62
+ </template>
63
+ </div>
64
+ <div class='status-line high'></div>
65
+ <pre><table class="coverage">
66
+ <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
67
+ <a name='L2'></a><a href='#L2'>2</a>
68
+ <a name='L3'></a><a href='#L3'>3</a>
69
+ <a name='L4'></a><a href='#L4'>4</a>
70
+ <a name='L5'></a><a href='#L5'>5</a>
71
+ <a name='L6'></a><a href='#L6'>6</a>
72
+ <a name='L7'></a><a href='#L7'>7</a>
73
+ <a name='L8'></a><a href='#L8'>8</a>
74
+ <a name='L9'></a><a href='#L9'>9</a>
75
+ <a name='L10'></a><a href='#L10'>10</a>
76
+ <a name='L11'></a><a href='#L11'>11</a>
77
+ <a name='L12'></a><a href='#L12'>12</a>
78
+ <a name='L13'></a><a href='#L13'>13</a>
79
+ <a name='L14'></a><a href='#L14'>14</a>
80
+ <a name='L15'></a><a href='#L15'>15</a>
81
+ <a name='L16'></a><a href='#L16'>16</a>
82
+ <a name='L17'></a><a href='#L17'>17</a>
83
+ <a name='L18'></a><a href='#L18'>18</a>
84
+ <a name='L19'></a><a href='#L19'>19</a>
85
+ <a name='L20'></a><a href='#L20'>20</a>
86
+ <a name='L21'></a><a href='#L21'>21</a>
87
+ <a name='L22'></a><a href='#L22'>22</a>
88
+ <a name='L23'></a><a href='#L23'>23</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
89
+ <span class="cline-any cline-yes">1x</span>
90
+ <span class="cline-any cline-neutral">&nbsp;</span>
91
+ <span class="cline-any cline-neutral">&nbsp;</span>
92
+ <span class="cline-any cline-neutral">&nbsp;</span>
93
+ <span class="cline-any cline-neutral">&nbsp;</span>
94
+ <span class="cline-any cline-neutral">&nbsp;</span>
95
+ <span class="cline-any cline-neutral">&nbsp;</span>
96
+ <span class="cline-any cline-neutral">&nbsp;</span>
97
+ <span class="cline-any cline-neutral">&nbsp;</span>
98
+ <span class="cline-any cline-neutral">&nbsp;</span>
99
+ <span class="cline-any cline-neutral">&nbsp;</span>
100
+ <span class="cline-any cline-yes">1x</span>
101
+ <span class="cline-any cline-neutral">&nbsp;</span>
102
+ <span class="cline-any cline-neutral">&nbsp;</span>
103
+ <span class="cline-any cline-neutral">&nbsp;</span>
104
+ <span class="cline-any cline-neutral">&nbsp;</span>
105
+ <span class="cline-any cline-neutral">&nbsp;</span>
106
+ <span class="cline-any cline-yes">14x</span>
107
+ <span class="cline-any cline-neutral">&nbsp;</span>
108
+ <span class="cline-any cline-neutral">&nbsp;</span>
109
+ <span class="cline-any cline-yes">1x</span>
110
+ <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import {PropertyMap} from './models';
111
+ import order from './order';
112
+ &nbsp;
113
+ /**
114
+ * Stringify a JS object while maintaining a particular property order:
115
+ *
116
+ * @param sourceObject an object with the properties in any order
117
+ * @param map the `PropertyMap` generated by the `parse` method.
118
+ * @param separator a non-empty `string` that controls what the key separator is in the generated map. Defaults to `~`.
119
+ * @param space a `number` used to insert white space into the output JSON string for readability purposes, as per the `JSON.stringify` [documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Parameters)
120
+ * @returns the stringified source object ordered as per the map. If the map is unset, the response is a standard `JSON.stringify`.
121
+ */
122
+ const stringify = (
123
+ sourceObject: object,
124
+ map: PropertyMap | null,
125
+ separator = <span class="branch-0 cbranch-no" title="branch not covered" >'~',</span>
126
+ space?: number
127
+ ): string =&gt; {
128
+ return JSON.stringify(order(sourceObject, map, separator), null, space);
129
+ };
130
+ &nbsp;
131
+ export default stringify;
132
+ &nbsp;</pre></td></tr></table></pre>
133
+
134
+ <div class='push'></div><!-- for sticky footer -->
135
+ </div><!-- /wrapper -->
136
+ <div class='footer quiet pad2 space-top1 center small'>
137
+ Code coverage generated by
138
+ <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
139
+ at 2023-03-21T04:59:30.046Z
140
+ </div>
141
+ <script src="../../prettify.js"></script>
142
+ <script>
143
+ window.onload = function () {
144
+ prettyPrint();
145
+ };
146
+ </script>
147
+ <script src="../../sorter.js"></script>
148
+ <script src="../../block-navigation.js"></script>
149
+ </body>
150
+ </html>
151
+
@@ -0,0 +1,154 @@
1
+
2
+ <!doctype html>
3
+ <html lang="en">
4
+
5
+ <head>
6
+ <title>Code coverage report for src/server-utils/apiKeyMiddleware.ts</title>
7
+ <meta charset="utf-8" />
8
+ <link rel="stylesheet" href="../../prettify.css" />
9
+ <link rel="stylesheet" href="../../base.css" />
10
+ <link rel="shortcut icon" type="image/x-icon" href="../../favicon.png" />
11
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
12
+ <style type='text/css'>
13
+ .coverage-summary .sorter {
14
+ background-image: url(../../sort-arrow-sprite.png);
15
+ }
16
+ </style>
17
+ </head>
18
+
19
+ <body>
20
+ <div class='wrapper'>
21
+ <div class='pad1'>
22
+ <h1><a href="../../index.html">All files</a> / <a href="index.html">src/server-utils</a> apiKeyMiddleware.ts</h1>
23
+ <div class='clearfix'>
24
+
25
+ <div class='fl pad1y space-right2'>
26
+ <span class="strong">81.81% </span>
27
+ <span class="quiet">Statements</span>
28
+ <span class='fraction'>9/11</span>
29
+ </div>
30
+
31
+
32
+ <div class='fl pad1y space-right2'>
33
+ <span class="strong">75% </span>
34
+ <span class="quiet">Branches</span>
35
+ <span class='fraction'>3/4</span>
36
+ </div>
37
+
38
+
39
+ <div class='fl pad1y space-right2'>
40
+ <span class="strong">100% </span>
41
+ <span class="quiet">Functions</span>
42
+ <span class='fraction'>2/2</span>
43
+ </div>
44
+
45
+
46
+ <div class='fl pad1y space-right2'>
47
+ <span class="strong">81.81% </span>
48
+ <span class="quiet">Lines</span>
49
+ <span class='fraction'>9/11</span>
50
+ </div>
51
+
52
+
53
+ </div>
54
+ <p class="quiet">
55
+ Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
56
+ </p>
57
+ <template id="filterTemplate">
58
+ <div class="quiet">
59
+ Filter:
60
+ <input oninput="onInput()" type="search" id="fileSearch">
61
+ </div>
62
+ </template>
63
+ </div>
64
+ <div class='status-line high'></div>
65
+ <pre><table class="coverage">
66
+ <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
67
+ <a name='L2'></a><a href='#L2'>2</a>
68
+ <a name='L3'></a><a href='#L3'>3</a>
69
+ <a name='L4'></a><a href='#L4'>4</a>
70
+ <a name='L5'></a><a href='#L5'>5</a>
71
+ <a name='L6'></a><a href='#L6'>6</a>
72
+ <a name='L7'></a><a href='#L7'>7</a>
73
+ <a name='L8'></a><a href='#L8'>8</a>
74
+ <a name='L9'></a><a href='#L9'>9</a>
75
+ <a name='L10'></a><a href='#L10'>10</a>
76
+ <a name='L11'></a><a href='#L11'>11</a>
77
+ <a name='L12'></a><a href='#L12'>12</a>
78
+ <a name='L13'></a><a href='#L13'>13</a>
79
+ <a name='L14'></a><a href='#L14'>14</a>
80
+ <a name='L15'></a><a href='#L15'>15</a>
81
+ <a name='L16'></a><a href='#L16'>16</a>
82
+ <a name='L17'></a><a href='#L17'>17</a>
83
+ <a name='L18'></a><a href='#L18'>18</a>
84
+ <a name='L19'></a><a href='#L19'>19</a>
85
+ <a name='L20'></a><a href='#L20'>20</a>
86
+ <a name='L21'></a><a href='#L21'>21</a>
87
+ <a name='L22'></a><a href='#L22'>22</a>
88
+ <a name='L23'></a><a href='#L23'>23</a>
89
+ <a name='L24'></a><a href='#L24'>24</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
90
+ <span class="cline-any cline-neutral">&nbsp;</span>
91
+ <span class="cline-any cline-yes">1x</span>
92
+ <span class="cline-any cline-neutral">&nbsp;</span>
93
+ <span class="cline-any cline-yes">1x</span>
94
+ <span class="cline-any cline-neutral">&nbsp;</span>
95
+ <span class="cline-any cline-neutral">&nbsp;</span>
96
+ <span class="cline-any cline-yes">1x</span>
97
+ <span class="cline-any cline-yes">3x</span>
98
+ <span class="cline-any cline-neutral">&nbsp;</span>
99
+ <span class="cline-any cline-yes">3x</span>
100
+ <span class="cline-any cline-no">&nbsp;</span>
101
+ <span class="cline-any cline-no">&nbsp;</span>
102
+ <span class="cline-any cline-neutral">&nbsp;</span>
103
+ <span class="cline-any cline-neutral">&nbsp;</span>
104
+ <span class="cline-any cline-yes">3x</span>
105
+ <span class="cline-any cline-yes">2x</span>
106
+ <span class="cline-any cline-yes">2x</span>
107
+ <span class="cline-any cline-neutral">&nbsp;</span>
108
+ <span class="cline-any cline-neutral">&nbsp;</span>
109
+ <span class="cline-any cline-yes">1x</span>
110
+ <span class="cline-any cline-neutral">&nbsp;</span>
111
+ <span class="cline-any cline-neutral">&nbsp;</span>
112
+ <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import type { Request, Response } from 'express';
113
+ import { ApiKeyValidationService } from '../api-key-validation/ApiKeyValidationService';
114
+ import { UnAuthenticatedRequestError } from '../error/UnAuthenticatedRequestError';
115
+ &nbsp;
116
+ export function apiKeyMiddleware(
117
+ apiKeyService: ApiKeyValidationService,
118
+ ): (req: Request, res: Response, next: any) =&gt; void {
119
+ return function (req: Request, res: Response, next: any) {
120
+ const key = req.header('x-api-key');
121
+ &nbsp;
122
+ <span class="missing-if-branch" title="if path not taken" >I</span>if (req.path == '/health') {
123
+ <span class="cstat-no" title="statement not covered" > next();</span>
124
+ <span class="cstat-no" title="statement not covered" > return;</span>
125
+ }
126
+ &nbsp;
127
+ if (apiKeyService.keyIsValid(key) || apiKeyService.matrixKeyIsValid(key)) {
128
+ next();
129
+ return;
130
+ }
131
+ &nbsp;
132
+ throw new UnAuthenticatedRequestError(`API KEY IS INVALID`);
133
+ };
134
+ }
135
+ &nbsp;</pre></td></tr></table></pre>
136
+
137
+ <div class='push'></div><!-- for sticky footer -->
138
+ </div><!-- /wrapper -->
139
+ <div class='footer quiet pad2 space-top1 center small'>
140
+ Code coverage generated by
141
+ <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
142
+ at 2023-03-21T04:59:30.046Z
143
+ </div>
144
+ <script src="../../prettify.js"></script>
145
+ <script>
146
+ window.onload = function () {
147
+ prettyPrint();
148
+ };
149
+ </script>
150
+ <script src="../../sorter.js"></script>
151
+ <script src="../../block-navigation.js"></script>
152
+ </body>
153
+ </html>
154
+