@secrecy/lib 1.0.0-dev.21 → 1.0.0-dev.25

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 (158) hide show
  1. package/CHANGELOG.md +178 -0
  2. package/README.md +0 -1
  3. package/__tests__/client/client.test.ts +81 -0
  4. package/__tests__/client/folder.test.ts +302 -0
  5. package/__tests__/client/mail.test.ts +476 -0
  6. package/__tests__/client/timing.test.ts +35 -0
  7. package/__tests__/client/utils.ts +41 -0
  8. package/__tests__/client/vFile.test.ts +207 -0
  9. package/__tests__/index.test.ts +171 -0
  10. package/commitlint.config.cjs +3 -0
  11. package/dist/index.d.ts +3857 -0
  12. package/dist/index.js +255 -0
  13. package/dist/index.js.map +1 -0
  14. package/dist/index.mjs +255 -0
  15. package/dist/index.mjs.map +1 -0
  16. package/docs/assets/css/main.css +2660 -0
  17. package/docs/assets/images/icons.png +0 -0
  18. package/docs/assets/images/icons@2x.png +0 -0
  19. package/docs/assets/images/widgets.png +0 -0
  20. package/docs/assets/images/widgets@2x.png +0 -0
  21. package/docs/assets/js/main.js +248 -0
  22. package/docs/assets/js/search.js +1 -0
  23. package/docs/classes/baseclient.baseclient-1.html +1165 -0
  24. package/docs/classes/client.secrecyclient.html +2527 -0
  25. package/docs/enums/index.sodium.base64_variants.html +205 -0
  26. package/docs/index.html +198 -0
  27. package/docs/interfaces/client_types.draftmail.html +335 -0
  28. package/docs/interfaces/client_types.filecontentbase.html +231 -0
  29. package/docs/interfaces/client_types.filecontentcloud.html +244 -0
  30. package/docs/interfaces/client_types.filecontentreceivedmail.html +244 -0
  31. package/docs/interfaces/client_types.filecontentsentmail.html +230 -0
  32. package/docs/interfaces/client_types.receivedmail.html +363 -0
  33. package/docs/interfaces/client_types.sentmail.html +335 -0
  34. package/docs/interfaces/crypto.keypair.html +202 -0
  35. package/docs/interfaces/index.sodium.cryptobox.html +185 -0
  36. package/docs/interfaces/index.sodium.cryptokx.html +185 -0
  37. package/docs/interfaces/index.sodium.keypair.html +199 -0
  38. package/docs/interfaces/index.sodium.messagetag.html +185 -0
  39. package/docs/interfaces/index.sodium.secretbox.html +185 -0
  40. package/docs/interfaces/index.sodium.stateaddress.html +171 -0
  41. package/docs/interfaces/index.sodium.stringcryptobox.html +185 -0
  42. package/docs/interfaces/index.sodium.stringcryptokx.html +185 -0
  43. package/docs/interfaces/index.sodium.stringkeypair.html +199 -0
  44. package/docs/interfaces/index.sodium.stringmessagetag.html +185 -0
  45. package/docs/interfaces/index.sodium.stringsecretbox.html +185 -0
  46. package/docs/interfaces/utils_store_buddy.storebuddy.html +333 -0
  47. package/docs/modules/baseclient.html +929 -0
  48. package/docs/modules/cache.html +185 -0
  49. package/docs/modules/client.html +207 -0
  50. package/docs/modules/client_convert_file.html +216 -0
  51. package/docs/modules/client_convert_folder.html +303 -0
  52. package/docs/modules/client_convert_vfile.html +216 -0
  53. package/docs/modules/client_helpers.html +311 -0
  54. package/docs/modules/client_storage.html +167 -0
  55. package/docs/modules/client_types.html +1227 -0
  56. package/docs/modules/client_types_file.html +233 -0
  57. package/docs/modules/client_types_filesonusersonapplications.html +168 -0
  58. package/docs/modules/client_types_folder.html +383 -0
  59. package/docs/modules/client_types_inputs.html +263 -0
  60. package/docs/modules/client_types_mail.html +181 -0
  61. package/docs/modules/client_types_queries.html +199 -0
  62. package/docs/modules/client_types_userappsettings.html +163 -0
  63. package/docs/modules/client_types_vfile.html +364 -0
  64. package/docs/modules/crypto.html +366 -0
  65. package/docs/modules/crypto_file.html +344 -0
  66. package/docs/modules/index.html +779 -0
  67. package/docs/modules/index.sodium.html +6039 -0
  68. package/docs/modules/minify.html +183 -0
  69. package/docs/modules/minify_lz4.html +279 -0
  70. package/docs/modules/popuptools.html +259 -0
  71. package/docs/modules/sodium.html +167 -0
  72. package/docs/modules/utils.html +219 -0
  73. package/docs/modules/utils_store_buddy.html +208 -0
  74. package/docs/modules/utils_time.html +330 -0
  75. package/docs/modules/worker_md5.html +156 -0
  76. package/docs/modules/worker_sodium.html +231 -0
  77. package/docs/modules/worker_workercodes.html +157 -0
  78. package/docs/modules.html +235 -0
  79. package/index.html +21 -0
  80. package/jest.config.ts +27 -0
  81. package/jest.setup.ts +6 -0
  82. package/package.json +39 -47
  83. package/release.config.cjs +15 -0
  84. package/tsup.config.ts +23 -0
  85. package/lib/BaseClient.d.ts +0 -274
  86. package/lib/BaseClient.js +0 -1837
  87. package/lib/PopupTools.d.ts +0 -17
  88. package/lib/PopupTools.js +0 -213
  89. package/lib/ZeusThunder.d.ts +0 -2
  90. package/lib/ZeusThunder.js +0 -112
  91. package/lib/cache.d.ts +0 -7
  92. package/lib/cache.js +0 -5
  93. package/lib/client/admin/index.d.ts +0 -11
  94. package/lib/client/admin/index.js +0 -163
  95. package/lib/client/convert/file.d.ts +0 -5
  96. package/lib/client/convert/file.js +0 -39
  97. package/lib/client/convert/folder.d.ts +0 -8
  98. package/lib/client/convert/folder.js +0 -264
  99. package/lib/client/convert/mail.d.ts +0 -3
  100. package/lib/client/convert/mail.js +0 -46
  101. package/lib/client/convert/vFile.d.ts +0 -5
  102. package/lib/client/convert/vFile.js +0 -164
  103. package/lib/client/helpers.d.ts +0 -23
  104. package/lib/client/helpers.js +0 -116
  105. package/lib/client/index.d.ts +0 -172
  106. package/lib/client/index.js +0 -4501
  107. package/lib/client/storage.d.ts +0 -7
  108. package/lib/client/storage.js +0 -12
  109. package/lib/client/types/File.d.ts +0 -21
  110. package/lib/client/types/File.js +0 -3
  111. package/lib/client/types/FilesOnUsersOnApplications.d.ts +0 -9
  112. package/lib/client/types/FilesOnUsersOnApplications.js +0 -3
  113. package/lib/client/types/Folder.d.ts +0 -68
  114. package/lib/client/types/Folder.js +0 -7
  115. package/lib/client/types/Inputs.d.ts +0 -21
  116. package/lib/client/types/Inputs.js +0 -3
  117. package/lib/client/types/UserAppNotifications.d.ts +0 -6
  118. package/lib/client/types/UserAppNotifications.js +0 -3
  119. package/lib/client/types/UserAppSettings.d.ts +0 -7
  120. package/lib/client/types/UserAppSettings.js +0 -3
  121. package/lib/client/types/VFile.d.ts +0 -62
  122. package/lib/client/types/VFile.js +0 -4
  123. package/lib/client/types/index.d.ts +0 -154
  124. package/lib/client/types/index.js +0 -10
  125. package/lib/client/types/queries.d.ts +0 -535
  126. package/lib/client/types/queries.js +0 -192
  127. package/lib/crypto/file.d.ts +0 -14
  128. package/lib/crypto/file.js +0 -291
  129. package/lib/crypto/index.d.ts +0 -12
  130. package/lib/crypto/index.js +0 -37
  131. package/lib/error.d.ts +0 -30
  132. package/lib/error.js +0 -3
  133. package/lib/index.d.ts +0 -13
  134. package/lib/index.js +0 -42
  135. package/lib/minify/index.d.ts +0 -2
  136. package/lib/minify/index.js +0 -28
  137. package/lib/minify/lz4.d.ts +0 -5
  138. package/lib/minify/lz4.js +0 -633
  139. package/lib/sodium.d.ts +0 -3
  140. package/lib/sodium.js +0 -28
  141. package/lib/utils/store-buddy.d.ts +0 -14
  142. package/lib/utils/store-buddy.js +0 -69
  143. package/lib/utils/time.d.ts +0 -10
  144. package/lib/utils/time.js +0 -22
  145. package/lib/utils.d.ts +0 -4
  146. package/lib/utils.js +0 -188
  147. package/lib/worker/__mock__/sodium.worker.d.ts +0 -19
  148. package/lib/worker/__mock__/sodium.worker.js +0 -46
  149. package/lib/worker/md5.d.ts +0 -1
  150. package/lib/worker/md5.js +0 -43
  151. package/lib/worker/sodium.d.ts +0 -3
  152. package/lib/worker/sodium.js +0 -155
  153. package/lib/worker/workerCodes.d.ts +0 -2
  154. package/lib/worker/workerCodes.js +0 -3
  155. package/lib/zeus/const.d.ts +0 -2
  156. package/lib/zeus/const.js +0 -1895
  157. package/lib/zeus/index.d.ts +0 -2798
  158. package/lib/zeus/index.js +0 -549
package/docs/modules/popuptools.html ADDED
@@ -0,0 +1,259 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>PopupTools | @secrecy/lib</title>
7
+ <meta name="description" content="Documentation for @secrecy/lib">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@secrecy/lib</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@secrecy/lib</a>
56
+ </li>
57
+ <li>
58
+ <a href="PopupTools.html">PopupTools</a>
59
+ </li>
60
+ </ul>
61
+ <h1>Module PopupTools</h1>
62
+ </div>
63
+ </div>
64
+ </header>
65
+ <div class="container container-main">
66
+ <div class="row">
67
+ <div class="col-8 col-content">
68
+ <section class="tsd-panel-group tsd-index-group">
69
+ <h2>Index</h2>
70
+ <section class="tsd-panel tsd-index-panel">
71
+ <div class="tsd-index-content">
72
+ <section class="tsd-index-section ">
73
+ <h3>Functions</h3>
74
+ <ul class="tsd-index-list">
75
+ <li class="tsd-kind-function tsd-parent-kind-module"><a href="PopupTools.html#popup" class="tsd-kind-icon">popup</a></li>
76
+ <li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="PopupTools.html#popupResponse" class="tsd-kind-icon">popup<wbr>Response</a></li>
77
+ <li class="tsd-kind-function tsd-parent-kind-module"><a href="PopupTools.html#popupWithPost" class="tsd-kind-icon">popup<wbr>With<wbr>Post</a></li>
78
+ </ul>
79
+ </section>
80
+ </div>
81
+ </section>
82
+ </section>
83
+ <section class="tsd-panel-group tsd-member-group ">
84
+ <h2>Functions</h2>
85
+ <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
86
+ <a name="popup" class="tsd-anchor"></a>
87
+ <h3>popup</h3>
88
+ <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
89
+ <li class="tsd-signature tsd-kind-icon">popup<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Options</span><span class="tsd-signature-symbol">&gt;</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Window</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li>
90
+ </ul>
91
+ <ul class="tsd-descriptions">
92
+ <li class="tsd-description">
93
+ <aside class="tsd-sources">
94
+ <ul>
95
+ <li>Defined in src/PopupTools.ts:202</li>
96
+ </ul>
97
+ </aside>
98
+ <div class="tsd-comment tsd-typography">
99
+ <div class="lead">
100
+ <p>Open a popup using the first argument.
101
+ Wait for it to close and call the callback.
102
+ Set the options string using the options object
103
+ Returns the window object</p>
104
+ </div>
105
+ </div>
106
+ <h4 class="tsd-parameters-title">Parameters</h4>
107
+ <ul class="tsd-parameters">
108
+ <li>
109
+ <h5>url: <span class="tsd-signature-type">string</span></h5>
110
+ </li>
111
+ <li>
112
+ <h5>name: <span class="tsd-signature-type">string</span></h5>
113
+ </li>
114
+ <li>
115
+ <h5>options: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Options</span><span class="tsd-signature-symbol">&gt;</span></h5>
116
+ </li>
117
+ <li>
118
+ <h5>callback: <span class="tsd-signature-type">Callback</span></h5>
119
+ </li>
120
+ </ul>
121
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Window</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h4>
122
+ </li>
123
+ </ul>
124
+ </section>
125
+ <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
126
+ <a name="popupResponse" class="tsd-anchor"></a>
127
+ <h3>popup<wbr>Response</h3>
128
+ <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
129
+ <li class="tsd-signature tsd-kind-icon">popup<wbr>Response&lt;T&gt;<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
130
+ </ul>
131
+ <ul class="tsd-descriptions">
132
+ <li class="tsd-description">
133
+ <aside class="tsd-sources">
134
+ <ul>
135
+ <li>Defined in src/PopupTools.ts:249</li>
136
+ </ul>
137
+ </aside>
138
+ <div class="tsd-comment tsd-typography">
139
+ <div class="lead">
140
+ <p>Return html that when executed, will trigger the popup to callback with a response</p>
141
+ </div>
142
+ </div>
143
+ <h4 class="tsd-type-parameters-title">Type parameters</h4>
144
+ <ul class="tsd-type-parameters">
145
+ <li>
146
+ <h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span></h4>
147
+ </li>
148
+ </ul>
149
+ <h4 class="tsd-parameters-title">Parameters</h4>
150
+ <ul class="tsd-parameters">
151
+ <li>
152
+ <h5>data: <span class="tsd-signature-type">T</span></h5>
153
+ </li>
154
+ </ul>
155
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
156
+ </li>
157
+ </ul>
158
+ </section>
159
+ <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
160
+ <a name="popupWithPost" class="tsd-anchor"></a>
161
+ <h3>popup<wbr>With<wbr>Post</h3>
162
+ <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
163
+ <li class="tsd-signature tsd-kind-icon">popup<wbr>With<wbr>Post<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, postData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Options</span><span class="tsd-signature-symbol">&gt;</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Window</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li>
164
+ </ul>
165
+ <ul class="tsd-descriptions">
166
+ <li class="tsd-description">
167
+ <aside class="tsd-sources">
168
+ <ul>
169
+ <li>Defined in src/PopupTools.ts:225</li>
170
+ </ul>
171
+ </aside>
172
+ <div class="tsd-comment tsd-typography">
173
+ <div class="lead">
174
+ <p>Open a popup using the first argument.
175
+ Post the data into the open popup.
176
+ Wait for it to close and call the callback.
177
+ Set the options string using the options object
178
+ Returns the window object</p>
179
+ </div>
180
+ </div>
181
+ <h4 class="tsd-parameters-title">Parameters</h4>
182
+ <ul class="tsd-parameters">
183
+ <li>
184
+ <h5>url: <span class="tsd-signature-type">string</span></h5>
185
+ </li>
186
+ <li>
187
+ <h5>postData: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h5>
188
+ </li>
189
+ <li>
190
+ <h5>name: <span class="tsd-signature-type">string</span></h5>
191
+ </li>
192
+ <li>
193
+ <h5>options: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Options</span><span class="tsd-signature-symbol">&gt;</span></h5>
194
+ </li>
195
+ <li>
196
+ <h5>callback: <span class="tsd-signature-type">Callback</span></h5>
197
+ </li>
198
+ </ul>
199
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Window</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h4>
200
+ </li>
201
+ </ul>
202
+ </section>
203
+ </section>
204
+ </div>
205
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
206
+ <nav class="tsd-navigation primary">
207
+ <ul>
208
+ <li class=" ">
209
+ <a href="../modules.html">Modules</a>
210
+ </li>
211
+ <li class="current tsd-kind-module">
212
+ <a href="PopupTools.html">Popup<wbr>Tools</a>
213
+ </li>
214
+ </ul>
215
+ </nav>
216
+ <nav class="tsd-navigation secondary menu-sticky">
217
+ <ul class="before-current">
218
+ <li class=" tsd-kind-function tsd-parent-kind-module">
219
+ <a href="PopupTools.html#popup" class="tsd-kind-icon">popup</a>
220
+ </li>
221
+ <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
222
+ <a href="PopupTools.html#popupResponse" class="tsd-kind-icon">popup<wbr>Response</a>
223
+ </li>
224
+ <li class=" tsd-kind-function tsd-parent-kind-module">
225
+ <a href="PopupTools.html#popupWithPost" class="tsd-kind-icon">popup<wbr>With<wbr>Post</a>
226
+ </li>
227
+ </ul>
228
+ </nav>
229
+ </div>
230
+ </div>
231
+ </div>
232
+ <footer class="with-border-bottom">
233
+ <div class="container">
234
+ <h2>Legend</h2>
235
+ <div class="tsd-legend-group">
236
+ <ul class="tsd-legend">
237
+ <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
238
+ <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
239
+ <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
240
+ <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
241
+ <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
242
+ </ul>
243
+ <ul class="tsd-legend">
244
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
245
+ <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
246
+ </ul>
247
+ <ul class="tsd-legend">
248
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
249
+ </ul>
250
+ </div>
251
+ </div>
252
+ </footer>
253
+ <div class="container tsd-generator">
254
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
255
+ </div>
256
+ <div class="overlay"></div>
257
+ <script src="../assets/js/main.js"></script>
258
+ </body>
259
+ </html>
package/docs/modules/sodium.html ADDED
@@ -0,0 +1,167 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>sodium | @secrecy/lib</title>
7
+ <meta name="description" content="Documentation for @secrecy/lib">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@secrecy/lib</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@secrecy/lib</a>
56
+ </li>
57
+ <li>
58
+ <a href="sodium.html">sodium</a>
59
+ </li>
60
+ </ul>
61
+ <h1>Module sodium</h1>
62
+ </div>
63
+ </div>
64
+ </header>
65
+ <div class="container container-main">
66
+ <div class="row">
67
+ <div class="col-8 col-content">
68
+ <section class="tsd-panel-group tsd-index-group">
69
+ <h2>Index</h2>
70
+ <section class="tsd-panel tsd-index-panel">
71
+ <div class="tsd-index-content">
72
+ <section class="tsd-index-section ">
73
+ <h3>References</h3>
74
+ <ul class="tsd-index-list">
75
+ <li class="tsd-kind-reference tsd-parent-kind-module"><a href="sodium.html#sodium-1" class="tsd-kind-icon">sodium</a></li>
76
+ </ul>
77
+ </section>
78
+ <section class="tsd-index-section ">
79
+ <h3>Functions</h3>
80
+ <ul class="tsd-index-list">
81
+ <li class="tsd-kind-function tsd-parent-kind-module"><a href="sodium.html#setup" class="tsd-kind-icon">setup</a></li>
82
+ </ul>
83
+ </section>
84
+ </div>
85
+ </section>
86
+ </section>
87
+ <section class="tsd-panel-group tsd-member-group ">
88
+ <h2>References</h2>
89
+ <section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module">
90
+ <a name="sodium-1" class="tsd-anchor"></a>
91
+ <h3>sodium</h3>
92
+ Re-exports <a href="index.sodium.html">sodium</a>
93
+ </section>
94
+ </section>
95
+ <section class="tsd-panel-group tsd-member-group ">
96
+ <h2>Functions</h2>
97
+ <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
98
+ <a name="setup" class="tsd-anchor"></a>
99
+ <h3>setup</h3>
100
+ <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
101
+ <li class="tsd-signature tsd-kind-icon">setup<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
102
+ </ul>
103
+ <ul class="tsd-descriptions">
104
+ <li class="tsd-description">
105
+ <aside class="tsd-sources">
106
+ <ul>
107
+ <li>Defined in src/sodium.ts:3</li>
108
+ </ul>
109
+ </aside>
110
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
111
+ </li>
112
+ </ul>
113
+ </section>
114
+ </section>
115
+ </div>
116
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
117
+ <nav class="tsd-navigation primary">
118
+ <ul>
119
+ <li class=" ">
120
+ <a href="../modules.html">Modules</a>
121
+ </li>
122
+ <li class="current tsd-kind-module">
123
+ <a href="sodium.html">sodium</a>
124
+ </li>
125
+ </ul>
126
+ </nav>
127
+ <nav class="tsd-navigation secondary menu-sticky">
128
+ <ul class="before-current">
129
+ <li class=" tsd-kind-reference tsd-parent-kind-module">
130
+ <a href="sodium.html#sodium-1" class="tsd-kind-icon">sodium</a>
131
+ </li>
132
+ <li class=" tsd-kind-function tsd-parent-kind-module">
133
+ <a href="sodium.html#setup" class="tsd-kind-icon">setup</a>
134
+ </li>
135
+ </ul>
136
+ </nav>
137
+ </div>
138
+ </div>
139
+ </div>
140
+ <footer class="with-border-bottom">
141
+ <div class="container">
142
+ <h2>Legend</h2>
143
+ <div class="tsd-legend-group">
144
+ <ul class="tsd-legend">
145
+ <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
146
+ <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
147
+ <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
148
+ <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
149
+ <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
150
+ </ul>
151
+ <ul class="tsd-legend">
152
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
153
+ <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
154
+ </ul>
155
+ <ul class="tsd-legend">
156
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
157
+ </ul>
158
+ </div>
159
+ </div>
160
+ </footer>
161
+ <div class="container tsd-generator">
162
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
163
+ </div>
164
+ <div class="overlay"></div>
165
+ <script src="../assets/js/main.js"></script>
166
+ </body>
167
+ </html>
package/docs/modules/utils.html ADDED
@@ -0,0 +1,219 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>utils | @secrecy/lib</title>
7
+ <meta name="description" content="Documentation for @secrecy/lib">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@secrecy/lib</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@secrecy/lib</a>
56
+ </li>
57
+ <li>
58
+ <a href="utils.html">utils</a>
59
+ </li>
60
+ </ul>
61
+ <h1>Module utils</h1>
62
+ </div>
63
+ </div>
64
+ </header>
65
+ <div class="container container-main">
66
+ <div class="row">
67
+ <div class="col-8 col-content">
68
+ <section class="tsd-panel-group tsd-index-group">
69
+ <h2>Index</h2>
70
+ <section class="tsd-panel tsd-index-panel">
71
+ <div class="tsd-index-content">
72
+ <section class="tsd-index-section ">
73
+ <h3>Functions</h3>
74
+ <ul class="tsd-index-list">
75
+ <li class="tsd-kind-function tsd-parent-kind-module"><a href="utils.html#chunks" class="tsd-kind-icon">chunks</a></li>
76
+ <li class="tsd-kind-function tsd-parent-kind-module"><a href="utils.html#concatenate" class="tsd-kind-icon">concatenate</a></li>
77
+ <li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="utils.html#enumerate" class="tsd-kind-icon">enumerate</a></li>
78
+ </ul>
79
+ </section>
80
+ </div>
81
+ </section>
82
+ </section>
83
+ <section class="tsd-panel-group tsd-member-group ">
84
+ <h2>Functions</h2>
85
+ <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
86
+ <a name="chunks" class="tsd-anchor"></a>
87
+ <h3>chunks</h3>
88
+ <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
89
+ <li class="tsd-signature tsd-kind-icon">chunks<span class="tsd-signature-symbol">(</span>arr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span>, n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Generator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></li>
90
+ </ul>
91
+ <ul class="tsd-descriptions">
92
+ <li class="tsd-description">
93
+ <aside class="tsd-sources">
94
+ <ul>
95
+ <li>Defined in src/utils.ts:26</li>
96
+ </ul>
97
+ </aside>
98
+ <h4 class="tsd-parameters-title">Parameters</h4>
99
+ <ul class="tsd-parameters">
100
+ <li>
101
+ <h5>arr: <span class="tsd-signature-type">Uint8Array</span></h5>
102
+ </li>
103
+ <li>
104
+ <h5>n: <span class="tsd-signature-type">number</span></h5>
105
+ </li>
106
+ </ul>
107
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Generator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4>
108
+ </li>
109
+ </ul>
110
+ </section>
111
+ <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
112
+ <a name="concatenate" class="tsd-anchor"></a>
113
+ <h3>concatenate</h3>
114
+ <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
115
+ <li class="tsd-signature tsd-kind-icon">concatenate<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>arrays<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span></li>
116
+ </ul>
117
+ <ul class="tsd-descriptions">
118
+ <li class="tsd-description">
119
+ <aside class="tsd-sources">
120
+ <ul>
121
+ <li>Defined in src/utils.ts:1</li>
122
+ </ul>
123
+ </aside>
124
+ <h4 class="tsd-parameters-title">Parameters</h4>
125
+ <ul class="tsd-parameters">
126
+ <li>
127
+ <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>arrays: <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">[]</span></h5>
128
+ </li>
129
+ </ul>
130
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Uint8Array</span></h4>
131
+ </li>
132
+ </ul>
133
+ </section>
134
+ <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
135
+ <a name="enumerate" class="tsd-anchor"></a>
136
+ <h3>enumerate</h3>
137
+ <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
138
+ <li class="tsd-signature tsd-kind-icon">enumerate&lt;T&gt;<span class="tsd-signature-symbol">(</span>iterable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Iterable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></li>
139
+ </ul>
140
+ <ul class="tsd-descriptions">
141
+ <li class="tsd-description">
142
+ <aside class="tsd-sources">
143
+ <ul>
144
+ <li>Defined in src/utils.ts:15</li>
145
+ </ul>
146
+ </aside>
147
+ <h4 class="tsd-type-parameters-title">Type parameters</h4>
148
+ <ul class="tsd-type-parameters">
149
+ <li>
150
+ <h4>T</h4>
151
+ </li>
152
+ </ul>
153
+ <h4 class="tsd-parameters-title">Parameters</h4>
154
+ <ul class="tsd-parameters">
155
+ <li>
156
+ <h5>iterable: <span class="tsd-signature-type">Iterable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
157
+ </li>
158
+ </ul>
159
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4>
160
+ </li>
161
+ </ul>
162
+ </section>
163
+ </section>
164
+ </div>
165
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
166
+ <nav class="tsd-navigation primary">
167
+ <ul>
168
+ <li class=" ">
169
+ <a href="../modules.html">Modules</a>
170
+ </li>
171
+ <li class="current tsd-kind-module">
172
+ <a href="utils.html">utils</a>
173
+ </li>
174
+ </ul>
175
+ </nav>
176
+ <nav class="tsd-navigation secondary menu-sticky">
177
+ <ul class="before-current">
178
+ <li class=" tsd-kind-function tsd-parent-kind-module">
179
+ <a href="utils.html#chunks" class="tsd-kind-icon">chunks</a>
180
+ </li>
181
+ <li class=" tsd-kind-function tsd-parent-kind-module">
182
+ <a href="utils.html#concatenate" class="tsd-kind-icon">concatenate</a>
183
+ </li>
184
+ <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
185
+ <a href="utils.html#enumerate" class="tsd-kind-icon">enumerate</a>
186
+ </li>
187
+ </ul>
188
+ </nav>
189
+ </div>
190
+ </div>
191
+ </div>
192
+ <footer class="with-border-bottom">
193
+ <div class="container">
194
+ <h2>Legend</h2>
195
+ <div class="tsd-legend-group">
196
+ <ul class="tsd-legend">
197
+ <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
198
+ <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
199
+ <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
200
+ <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
201
+ <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
202
+ </ul>
203
+ <ul class="tsd-legend">
204
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
205
+ <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
206
+ </ul>
207
+ <ul class="tsd-legend">
208
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
209
+ </ul>
210
+ </div>
211
+ </div>
212
+ </footer>
213
+ <div class="container tsd-generator">
214
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
215
+ </div>
216
+ <div class="overlay"></div>
217
+ <script src="../assets/js/main.js"></script>
218
+ </body>
219
+ </html>