-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
405 lines (396 loc) · 19.7 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>trace-search - v0.0.5</title>
<meta name="description" content="Documentation for trace-search - v0.0.5">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<script async src="assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">trace-search - v0.0.5</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<h1>trace-search - v0.0.5</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<p><a href="https://www.npmjs.com/package/trace-search"><img src="https://img.shields.io/npm/v/trace-search" alt="npm version"></a>
<a href="https://codecov.io/gh/TRACE-Digital/TRACE-search"><img src="https://codecov.io/gh/TRACE-Digital/TRACE-search/branch/main/graph/badge.svg?token=WLKWAZBHEB" alt="codecov"></a></p>
<a href="#trace-search" id="trace-search" style="color: inherit; text-decoration: none;">
<h1>TRACE Search</h1>
</a>
<p>TRACE library for third-party account discovery.</p>
<a href="#building-and-running-on-localhost" id="building-and-running-on-localhost" style="color: inherit; text-decoration: none;">
<h2>Building and running on localhost</h2>
</a>
<p>First install dependencies:</p>
<pre><code class="language-sh"><span style="color: #000000">npm install</span>
</code></pre>
<p>To start:</p>
<pre><code class="language-sh"><span style="color: #000000">npm start</span>
<span style="color: #008000"># Open the browser to localhost:8000</span>
</code></pre>
<p>To create a production build:</p>
<pre><code class="language-sh"><span style="color: #000000">npm run build-prod</span>
</code></pre>
<p>To create a development build:</p>
<pre><code class="language-sh"><span style="color: #000000">npm run build-dev</span>
</code></pre>
<p>Create and serve docs:</p>
<pre><code class="language-sh"><span style="color: #000000">npm run build-docs</span>
<span style="color: #000000">npm run start-docs</span>
</code></pre>
<a href="#testing" id="testing" style="color: inherit; text-decoration: none;">
<h2>Testing</h2>
</a>
<pre><code class="language-sh"><span style="color: #000000">npm </span><span style="color: #795E26">test</span><span style="color: #000000"> </span><span style="color: #008000"># Full test suite</span>
<span style="color: #000000">npm </span><span style="color: #795E26">test</span><span style="color: #000000"> --verbose </span><span style="color: #008000"># Full test suite with more info</span>
<span style="color: #000000">npm </span><span style="color: #795E26">test</span><span style="color: #000000"> -- -h </span><span style="color: #008000"># Show Jest CLI help</span>
<span style="color: #000000">npm </span><span style="color: #795E26">test</span><span style="color: #000000"> -- --watch </span><span style="color: #008000"># Re-run affected tests when source code changes are detected</span>
<span style="color: #000000">npm </span><span style="color: #795E26">test</span><span style="color: #000000"> -- -t search </span><span style="color: #008000"># Run tests that contain 'search'</span>
<span style="color: #008000"># Run only a certain test file</span>
<span style="color: #000000">npm </span><span style="color: #795E26">test</span><span style="color: #000000"> -- src/tests/search.test.ts</span>
<span style="color: #000000">npm run test-all </span><span style="color: #008000"># Run all tests, including super long running ones</span>
<span style="color: #000000">npm run test-debug </span><span style="color: #008000"># If tests get stuck</span>
</code></pre>
<a href="#testing-with-external-project" id="testing-with-external-project" style="color: inherit; text-decoration: none;">
<h2>Testing with External Project</h2>
</a>
<p>To test with an external project that consumes the library, you can:</p>
<ul>
<li>Install from NPM</li>
<li>Link locally</li>
<li>Install from Git</li>
</ul>
<a href="#install-from-npm" id="install-from-npm" style="color: inherit; text-decoration: none;">
<h3>Install from NPM</h3>
</a>
<p>Install the official version of the package published on NPM.</p>
<pre><code class="language-sh"><span style="color: #795E26">cd</span><span style="color: #000000"> external-project</span>
<span style="color: #000000">npm install trace-search</span>
</code></pre>
<a href="#link-locally" id="link-locally" style="color: inherit; text-decoration: none;">
<h3>Link Locally</h3>
</a>
<p>If you are actively working on integrating the library with an external project,
this is the best method. The package is symlinked into the global collection of NPM packages.
Changes should propagate quickly and without extra work.</p>
<p>See <a href="https://docs.npmjs.com/cli/v6/commands/npm-link">https://docs.npmjs.com/cli/v6/commands/npm-link</a> for more.</p>
<pre><code class="language-sh"><span style="color: #795E26">cd</span><span style="color: #000000"> external-project</span>
<span style="color: #000000">npm link ../trace-search</span>
<span style="color: #795E26">cd</span><span style="color: #000000"> ../trace-search</span>
<span style="color: #000000">npm run build-dev -- --watch</span>
<span style="color: #008000">### OR the long way</span>
<span style="color: #795E26">cd</span><span style="color: #000000"> trace-search</span>
<span style="color: #000000">npm link trace-search </span><span style="color: #008000"># Link our local directory into the global package folder</span>
<span style="color: #795E26">cd</span><span style="color: #000000"> external-project</span>
<span style="color: #000000">npm link trace-search </span><span style="color: #008000"># Link the global package into the project</span>
<span style="color: #795E26">cd</span><span style="color: #000000"> ../trace-search</span>
<span style="color: #000000">npm run build-dev -- --watch</span>
</code></pre>
<a href="#install-from-git" id="install-from-git" style="color: inherit; text-decoration: none;">
<h3>Install from Git</h3>
</a>
<p>This is the slowest but doesn't rely on configuring/managing local directories or waiting for a release.
If you only need to consume the library, aren't actively developing it, and need more recent changes
than what's published to NPM, this is the best option.</p>
<pre><code class="language-sh"><span style="color: #795E26">cd</span><span style="color: #000000"> external-project</span>
<span style="color: #000000">npm install git+https://github.com/TRACE-Digital/trace-search.git#main</span>
<span style="color: #008000"># To update to the latest changes in the default branch</span>
<span style="color: #000000">npm upgrade trace-search</span>
</code></pre>
<a href="#helpful-scripts" id="helpful-scripts" style="color: inherit; text-decoration: none;">
<h2>Helpful Scripts</h2>
</a>
<pre><code class="language-sh"><span style="color: #000000">npm run lint </span><span style="color: #008000"># Run the linter</span>
<span style="color: #000000">npm run format </span><span style="color: #008000"># Run the code formatter</span>
</code></pre>
<a href="#publishing" id="publishing" style="color: inherit; text-decoration: none;">
<h2>Publishing</h2>
</a>
<pre><code class="language-sh"><span style="color: #008000"># Test creating the package locally</span>
<span style="color: #000000">npm pack</span>
<span style="color: #008000"># Publish to NPM</span>
<span style="color: #000000">npm publish</span>
</code></pre>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="enums/accounttype.html" class="tsd-kind-icon">Account<wbr>Type</a>
</li>
<li class=" tsd-kind-enum">
<a href="enums/autosearchaccountaction.html" class="tsd-kind-icon">Auto<wbr>Search<wbr>Account<wbr>Action</a>
</li>
<li class=" tsd-kind-enum">
<a href="enums/searchstate.html" class="tsd-kind-icon">Search<wbr>State</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/autosearchaccount.html" class="tsd-kind-icon">Auto<wbr>Search<wbr>Account</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/claimedaccount.html" class="tsd-kind-icon">Claimed<wbr>Account</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/failedaccount.html" class="tsd-kind-icon">Failed<wbr>Account</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/manualaccount.html" class="tsd-kind-icon">Manual<wbr>Account</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/profilepage.html" class="tsd-kind-icon">Profile<wbr>Page</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/registeredaccount.html" class="tsd-kind-icon">Registered<wbr>Account</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/rejectedaccount.html" class="tsd-kind-icon">Rejected<wbr>Account</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/search.html" class="tsd-kind-icon">Search</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/searchdefinition.html" class="tsd-kind-icon">Search<wbr>Definition</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/thirdpartyaccount.html" class="tsd-kind-icon">Third<wbr>Party<wbr>Account</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/unregisteredaccount.html" class="tsd-kind-icon">Unregistered<wbr>Account</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/profilepagecolorschema.html" class="tsd-kind-icon">Profile<wbr>Page<wbr>Color<wbr>Schema</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/searchresults.html" class="tsd-kind-icon">Search<wbr>Results</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/searchresultsbyid.html" class="tsd-kind-icon">Search<wbr>Results<wbr>ById</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/searchresultsbysite.html" class="tsd-kind-icon">Search<wbr>Results<wbr>BySite</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/searchresultsbyuser.html" class="tsd-kind-icon">Search<wbr>Results<wbr>ByUser</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/site.html" class="tsd-kind-icon">Site</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/sitelist.html" class="tsd-kind-icon">Site<wbr>List</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#confidencerating" class="tsd-kind-icon">Confidence<wbr>Rating</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#default_color_scheme" class="tsd-kind-icon">DEFAULT_<wbr>COLOR_<wbr>SCHEME</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#discoveredaccount" class="tsd-kind-icon">Discovered<wbr>Account</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#discoveredaccountaction" class="tsd-kind-icon">Discovered<wbr>Account<wbr>Action</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#extension_min_version" class="tsd-kind-icon">EXTENSION_<wbr>MIN_<wbr>VERSION</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#extension_version" class="tsd-kind-icon">EXTENSION_<wbr>VERSION</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#version" class="tsd-kind-icon">VERSION</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#accounts" class="tsd-kind-icon">accounts</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#allsites" class="tsd-kind-icon">all<wbr>Sites</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#pages" class="tsd-kind-icon">pages</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#privacyratings" class="tsd-kind-icon">privacy<wbr>Ratings</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#searchdefinitions" class="tsd-kind-icon">search<wbr>Definitions</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#searchresults" class="tsd-kind-icon">search<wbr>Results</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#searches" class="tsd-kind-icon">searches</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#supportedsites" class="tsd-kind-icon">supported<wbr>Sites</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#tags" class="tsd-kind-icon">tags</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#unsupportedsites" class="tsd-kind-icon">unsupported<wbr>Sites</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#checkextensionversion" class="tsd-kind-icon">check<wbr>Extension<wbr>Version</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#closedb" class="tsd-kind-icon">close<wbr>Db</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#closeremotedb" class="tsd-kind-icon">close<wbr>Remote<wbr>Db</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#destroydb" class="tsd-kind-icon">destroy<wbr>Db</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#destroylocaldb" class="tsd-kind-icon">destroy<wbr>Local<wbr>Db</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#destroyremotedb" class="tsd-kind-icon">destroy<wbr>Remote<wbr>Db</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#disablesync" class="tsd-kind-icon">disable<wbr>Sync</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#enablesync" class="tsd-kind-icon">enable<wbr>Sync</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#exporttocsv" class="tsd-kind-icon">export<wbr>ToCsv</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#exporttojson" class="tsd-kind-icon">export<wbr>ToJson</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#exporttoreadablejson" class="tsd-kind-icon">export<wbr>ToReadable<wbr>Json</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#filtersitesbytags" class="tsd-kind-icon">filter<wbr>Sites<wbr>ByTags</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#findaccount" class="tsd-kind-icon">find<wbr>Account</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#generateencryptionkey" class="tsd-kind-icon">generate<wbr>Encryption<wbr>Key</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#getdb" class="tsd-kind-icon">get<wbr>Db</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#getencryptionkey" class="tsd-kind-icon">get<wbr>Encryption<wbr>Key</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#getremotedb" class="tsd-kind-icon">get<wbr>Remote<wbr>Db</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#removeencryptionkey" class="tsd-kind-icon">remove<wbr>Encryption<wbr>Key</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#resetdb" class="tsd-kind-icon">reset<wbr>Db</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#resetremotedb" class="tsd-kind-icon">reset<wbr>Remote<wbr>Db</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#setremoteuser" class="tsd-kind-icon">set<wbr>Remote<wbr>User</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#setupreplication" class="tsd-kind-icon">setup<wbr>Replication</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#teardownreplication" class="tsd-kind-icon">teardown<wbr>Replication</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#toaccountid" class="tsd-kind-icon">to<wbr>Account<wbr>Id</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
</body>
</html>