@synnaxlabs/client 0.1.2 → 0.2.0

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 (170) hide show
  1. package/.DS_Store +0 -0
  2. package/.editorconfig +15 -0
  3. package/.eslintrc.json +33 -0
  4. package/.gitignore +9 -0
  5. package/.nyc_output/20720f2d-6abe-420f-a3c5-304d52d60827.json +1 -0
  6. package/.nyc_output/4725921c-6f1b-4ae9-9819-e455f702d31c.json +1 -0
  7. package/.nyc_output/47478588-5ffd-4332-873c-facaa4a2fc38.json +1 -0
  8. package/.nyc_output/48180641-e0b2-49ab-a6eb-e7910e9eac2f.json +1 -0
  9. package/.nyc_output/cb0abf31-740f-47db-b94a-8e3f8f117cb8.json +1 -0
  10. package/.nyc_output/fc77fce2-dad0-49a8-8d4b-0a9014ecf8c5.json +1 -0
  11. package/.nyc_output/processinfo/20720f2d-6abe-420f-a3c5-304d52d60827.json +1 -0
  12. package/.nyc_output/processinfo/4725921c-6f1b-4ae9-9819-e455f702d31c.json +1 -0
  13. package/.nyc_output/processinfo/47478588-5ffd-4332-873c-facaa4a2fc38.json +1 -0
  14. package/.nyc_output/processinfo/48180641-e0b2-49ab-a6eb-e7910e9eac2f.json +1 -0
  15. package/.nyc_output/processinfo/cb0abf31-740f-47db-b94a-8e3f8f117cb8.json +1 -0
  16. package/.nyc_output/processinfo/fc77fce2-dad0-49a8-8d4b-0a9014ecf8c5.json +1 -0
  17. package/.nyc_output/processinfo/index.json +1 -0
  18. package/.prettierignore +2 -0
  19. package/CHANGELOG.md +5 -0
  20. package/build/main/index.d.ts +1 -1
  21. package/build/main/index.js +2 -3
  22. package/build/main/lib/auth.d.ts +54 -0
  23. package/build/main/lib/auth.js +62 -0
  24. package/build/main/lib/auth.spec.d.ts +1 -0
  25. package/build/main/lib/auth.spec.js +39 -0
  26. package/build/main/lib/channel/channel.spec.js +17 -3
  27. package/build/main/lib/channel/client.d.ts +2 -2
  28. package/build/main/lib/channel/client.js +6 -3
  29. package/build/main/lib/channel/payload.d.ts +2 -2
  30. package/build/main/lib/client.d.ts +13 -6
  31. package/build/main/lib/client.js +16 -4
  32. package/build/main/lib/segment/iterator.spec.js +14 -3
  33. package/build/main/lib/segment/typed.js +4 -4
  34. package/build/main/lib/segment/writer.spec.js +17 -3
  35. package/build/main/lib/telem.d.ts +2 -2
  36. package/build/main/lib/telem.js +4 -4
  37. package/build/main/lib/telem.spec.js +4 -2
  38. package/build/main/lib/transport.d.ts +2 -1
  39. package/build/main/lib/transport.js +5 -1
  40. package/build/main/lib/user/payload.d.ts +12 -0
  41. package/build/main/lib/user/payload.js +9 -0
  42. package/build/main/setupspecs.d.ts +4 -0
  43. package/build/main/setupspecs.js +17 -0
  44. package/build/module/index.d.ts +1 -1
  45. package/build/module/index.js +2 -2
  46. package/build/module/lib/auth.d.ts +54 -0
  47. package/build/module/lib/auth.js +63 -0
  48. package/build/module/lib/auth.spec.d.ts +1 -0
  49. package/build/module/lib/auth.spec.js +34 -0
  50. package/build/module/lib/channel/channel.spec.js +17 -3
  51. package/build/module/lib/channel/client.d.ts +2 -2
  52. package/build/module/lib/channel/client.js +6 -3
  53. package/build/module/lib/channel/payload.d.ts +2 -2
  54. package/build/module/lib/client.d.ts +13 -6
  55. package/build/module/lib/client.js +17 -4
  56. package/build/module/lib/segment/iterator.spec.js +14 -3
  57. package/build/module/lib/segment/typed.js +5 -5
  58. package/build/module/lib/segment/writer.spec.js +18 -4
  59. package/build/module/lib/telem.d.ts +2 -2
  60. package/build/module/lib/telem.js +4 -4
  61. package/build/module/lib/telem.spec.js +5 -3
  62. package/build/module/lib/transport.d.ts +2 -1
  63. package/build/module/lib/transport.js +5 -1
  64. package/build/module/lib/user/payload.d.ts +12 -0
  65. package/build/module/lib/user/payload.js +6 -0
  66. package/build/module/setupspecs.d.ts +4 -0
  67. package/build/module/setupspecs.js +16 -0
  68. package/build/tsconfig.module.tsbuildinfo +1 -0
  69. package/build/tsconfig.tsbuildinfo +1 -0
  70. package/coverage/base.css +224 -0
  71. package/coverage/block-navigation.js +87 -0
  72. package/coverage/favicon.png +0 -0
  73. package/coverage/index.html +191 -0
  74. package/coverage/lcov-report/base.css +224 -0
  75. package/coverage/lcov-report/block-navigation.js +87 -0
  76. package/coverage/lcov-report/favicon.png +0 -0
  77. package/coverage/lcov-report/index.html +191 -0
  78. package/coverage/lcov-report/prettify.css +1 -0
  79. package/coverage/lcov-report/prettify.js +2 -0
  80. package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  81. package/coverage/lcov-report/sorter.js +196 -0
  82. package/coverage/lcov-report/src/index.html +116 -0
  83. package/coverage/lcov-report/src/lib/auth.ts.html +340 -0
  84. package/coverage/lcov-report/src/lib/channel/client.ts.html +604 -0
  85. package/coverage/lcov-report/src/lib/channel/creator.ts.html +304 -0
  86. package/coverage/lcov-report/src/lib/channel/index.html +176 -0
  87. package/coverage/lcov-report/src/lib/channel/payload.ts.html +139 -0
  88. package/coverage/lcov-report/src/lib/channel/registry.ts.html +202 -0
  89. package/coverage/lcov-report/src/lib/channel/retriever.ts.html +244 -0
  90. package/coverage/lcov-report/src/lib/client.ts.html +244 -0
  91. package/coverage/lcov-report/src/lib/errors.ts.html +484 -0
  92. package/coverage/lcov-report/src/lib/index.html +176 -0
  93. package/coverage/lcov-report/src/lib/segment/client.ts.html +463 -0
  94. package/coverage/lcov-report/src/lib/segment/index.html +206 -0
  95. package/coverage/lcov-report/src/lib/segment/iterator.ts.html +928 -0
  96. package/coverage/lcov-report/src/lib/segment/payload.ts.html +139 -0
  97. package/coverage/lcov-report/src/lib/segment/splitter.ts.html +181 -0
  98. package/coverage/lcov-report/src/lib/segment/typed.ts.html +307 -0
  99. package/coverage/lcov-report/src/lib/segment/validator.ts.html +331 -0
  100. package/coverage/lcov-report/src/lib/segment/writer.ts.html +727 -0
  101. package/coverage/lcov-report/src/lib/telem.ts.html +2056 -0
  102. package/coverage/lcov-report/src/lib/transport.ts.html +196 -0
  103. package/coverage/lcov-report/src/lib/user/index.html +116 -0
  104. package/coverage/lcov-report/src/lib/user/payload.ts.html +109 -0
  105. package/coverage/lcov-report/src/lib/util/index.html +116 -0
  106. package/coverage/lcov-report/src/lib/util/telem.ts.html +124 -0
  107. package/coverage/lcov-report/src/setupspecs.ts.html +133 -0
  108. package/coverage/lcov.info +1230 -0
  109. package/coverage/prettify.css +1 -0
  110. package/coverage/prettify.js +2 -0
  111. package/coverage/sort-arrow-sprite.png +0 -0
  112. package/coverage/sorter.js +196 -0
  113. package/coverage/src/index.html +116 -0
  114. package/coverage/src/lib/auth.ts.html +340 -0
  115. package/coverage/src/lib/channel/client.ts.html +604 -0
  116. package/coverage/src/lib/channel/creator.ts.html +304 -0
  117. package/coverage/src/lib/channel/index.html +176 -0
  118. package/coverage/src/lib/channel/payload.ts.html +139 -0
  119. package/coverage/src/lib/channel/registry.ts.html +202 -0
  120. package/coverage/src/lib/channel/retriever.ts.html +244 -0
  121. package/coverage/src/lib/client.ts.html +244 -0
  122. package/coverage/src/lib/errors.ts.html +484 -0
  123. package/coverage/src/lib/index.html +176 -0
  124. package/coverage/src/lib/segment/client.ts.html +463 -0
  125. package/coverage/src/lib/segment/index.html +206 -0
  126. package/coverage/src/lib/segment/iterator.ts.html +928 -0
  127. package/coverage/src/lib/segment/payload.ts.html +139 -0
  128. package/coverage/src/lib/segment/splitter.ts.html +181 -0
  129. package/coverage/src/lib/segment/typed.ts.html +307 -0
  130. package/coverage/src/lib/segment/validator.ts.html +331 -0
  131. package/coverage/src/lib/segment/writer.ts.html +727 -0
  132. package/coverage/src/lib/telem.ts.html +2056 -0
  133. package/coverage/src/lib/transport.ts.html +196 -0
  134. package/coverage/src/lib/user/index.html +116 -0
  135. package/coverage/src/lib/user/payload.ts.html +109 -0
  136. package/coverage/src/lib/util/index.html +116 -0
  137. package/coverage/src/lib/util/telem.ts.html +124 -0
  138. package/coverage/src/setupspecs.ts.html +133 -0
  139. package/package.json +2 -2
  140. package/src/index.ts +13 -0
  141. package/src/lib/.DS_Store +0 -0
  142. package/src/lib/auth.spec.ts +36 -0
  143. package/src/lib/auth.ts +85 -0
  144. package/src/lib/channel/channel.spec.ts +49 -0
  145. package/src/lib/channel/client.ts +173 -0
  146. package/src/lib/channel/creator.ts +73 -0
  147. package/src/lib/channel/payload.ts +18 -0
  148. package/src/lib/channel/registry.ts +39 -0
  149. package/src/lib/channel/retriever.ts +53 -0
  150. package/src/lib/client.ts +53 -0
  151. package/src/lib/errors.ts +133 -0
  152. package/src/lib/segment/client.ts +126 -0
  153. package/src/lib/segment/iterator.spec.ts +78 -0
  154. package/src/lib/segment/iterator.ts +281 -0
  155. package/src/lib/segment/payload.ts +18 -0
  156. package/src/lib/segment/splitter.ts +32 -0
  157. package/src/lib/segment/typed.ts +74 -0
  158. package/src/lib/segment/validator.ts +82 -0
  159. package/src/lib/segment/writer.spec.ts +85 -0
  160. package/src/lib/segment/writer.ts +214 -0
  161. package/src/lib/telem.spec.ts +200 -0
  162. package/src/lib/telem.ts +657 -0
  163. package/src/lib/transport.ts +37 -0
  164. package/src/lib/user/payload.ts +8 -0
  165. package/src/lib/util/telem.ts +13 -0
  166. package/src/setupspecs.ts +16 -0
  167. package/tsconfig.json +47 -0
  168. package/tsconfig.module.json +9 -0
  169. package/yarn-error.log +5756 -0
  170. package/yarn.lock +5936 -0
package/coverage/src/lib/client.ts.html ADDED
@@ -0,0 +1,244 @@
1
+
2
+ <!doctype html>
3
+ <html lang="en">
4
+
5
+ <head>
6
+ <title>Code coverage report for src/lib/client.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/lib</a> client.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'>18/18</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'>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'>18/18</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></td><td class="line-coverage quiet"><span class="cline-any cline-yes">4x</span>
120
+ <span class="cline-any cline-neutral">&nbsp;</span>
121
+ <span class="cline-any cline-yes">4x</span>
122
+ <span class="cline-any cline-yes">4x</span>
123
+ <span class="cline-any cline-yes">4x</span>
124
+ <span class="cline-any cline-yes">4x</span>
125
+ <span class="cline-any cline-yes">4x</span>
126
+ <span class="cline-any cline-yes">4x</span>
127
+ <span class="cline-any cline-yes">4x</span>
128
+ <span class="cline-any cline-neutral">&nbsp;</span>
129
+ <span class="cline-any cline-neutral">&nbsp;</span>
130
+ <span class="cline-any cline-neutral">&nbsp;</span>
131
+ <span class="cline-any cline-neutral">&nbsp;</span>
132
+ <span class="cline-any cline-neutral">&nbsp;</span>
133
+ <span class="cline-any cline-neutral">&nbsp;</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-neutral">&nbsp;</span>
140
+ <span class="cline-any cline-neutral">&nbsp;</span>
141
+ <span class="cline-any cline-neutral">&nbsp;</span>
142
+ <span class="cline-any cline-yes">4x</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-neutral">&nbsp;</span>
147
+ <span class="cline-any cline-neutral">&nbsp;</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-neutral">&nbsp;</span>
151
+ <span class="cline-any cline-neutral">&nbsp;</span>
152
+ <span class="cline-any cline-neutral">&nbsp;</span>
153
+ <span class="cline-any cline-neutral">&nbsp;</span>
154
+ <span class="cline-any cline-neutral">&nbsp;</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-yes">3x</span>
158
+ <span class="cline-any cline-yes">3x</span>
159
+ <span class="cline-any cline-yes">3x</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-yes">3x</span>
164
+ <span class="cline-any cline-neutral">&nbsp;</span>
165
+ <span class="cline-any cline-yes">3x</span>
166
+ <span class="cline-any cline-yes">3x</span>
167
+ <span class="cline-any cline-yes">3x</span>
168
+ <span class="cline-any cline-yes">3x</span>
169
+ <span class="cline-any cline-yes">3x</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-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import { URL } from '@synnaxlabs/freighter';
173
+ &nbsp;
174
+ import AuthenticationClient from './auth';
175
+ import ChannelClient from './channel/client';
176
+ import ChannelCreator from './channel/creator';
177
+ import Registry from './channel/registry';
178
+ import ChannelRetriever from './channel/retriever';
179
+ import SegmentClient from './segment/client';
180
+ import Transport from './transport';
181
+ &nbsp;
182
+ export type SynnaxProps = {
183
+ host: string;
184
+ port: number;
185
+ username?: string;
186
+ password?: string;
187
+ };
188
+ &nbsp;
189
+ /**
190
+ * Client to perform operations against a Synnax cluster.
191
+ *
192
+ * @property channel - Channel client for creating and retrieving channels.
193
+ * @property data - Data client for reading and writing telemetry.
194
+ */
195
+ export default class Synnax {
196
+ private transport: Transport;
197
+ data: SegmentClient;
198
+ channel: ChannelClient;
199
+ auth: AuthenticationClient | undefined;
200
+ &nbsp;
201
+ /**
202
+ * @param props.host - Hostname of a node in the cluster.
203
+ * @param props.port - Port of the node in the cluster.
204
+ * @param props.username - Username for authentication. Not required if the
205
+ * cluster is insecure.
206
+ * @param props.password - Password for authentication. Not required if the
207
+ * cluster is insecure.
208
+ */
209
+ constructor({ host, port, username, password }: SynnaxProps) {
210
+ this.transport = new Transport(new URL({ host, port }));
211
+ <span class="missing-if-branch" title="else path not taken" >E</span>if (username &amp;&amp; password) {
212
+ this.auth = new AuthenticationClient(this.transport.httpFactory, {
213
+ username,
214
+ password,
215
+ });
216
+ this.transport.use(this.auth.middleware());
217
+ }
218
+ const chRetriever = new ChannelRetriever(this.transport);
219
+ const chCreator = new ChannelCreator(this.transport);
220
+ const chRegistry = new Registry(chRetriever);
221
+ this.data = new SegmentClient(this.transport, chRegistry);
222
+ this.channel = new ChannelClient(this.data, chRetriever, chCreator);
223
+ }
224
+ }
225
+ &nbsp;</pre></td></tr></table></pre>
226
+
227
+ <div class='push'></div><!-- for sticky footer -->
228
+ </div><!-- /wrapper -->
229
+ <div class='footer quiet pad2 space-top1 center small'>
230
+ Code coverage generated by
231
+ <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
232
+ at 2022-10-04T02:07:47.903Z
233
+ </div>
234
+ <script src="../../prettify.js"></script>
235
+ <script>
236
+ window.onload = function () {
237
+ prettyPrint();
238
+ };
239
+ </script>
240
+ <script src="../../sorter.js"></script>
241
+ <script src="../../block-navigation.js"></script>
242
+ </body>
243
+ </html>
244
+