@xyo-network/dns 5.3.24 → 5.3.26

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 (2) hide show
  1. package/README.md +503 -10
  2. package/package.json +7 -7
package/README.md CHANGED
@@ -1,23 +1,516 @@
1
+ [![logo][]](https://xyo.network)
2
+
1
3
  # @xyo-network/dns
2
4
 
3
- [![logo][]](https://xyo.network)
5
+ [![npm][npm-badge]][npm-link]
6
+ [![license][license-badge]][license-link]
7
+
8
+ > Primary SDK for using XYO Protocol 2.0
9
+
10
+ ## Install
11
+
12
+ Using npm:
4
13
 
5
- Version: 5.0.2
14
+ ```sh
15
+ npm install {{name}}
16
+ ```
6
17
 
7
- Primary SDK for using XYO Protocol 2.0
18
+ Using yarn:
8
19
 
9
- ## Documentation
20
+ ```sh
21
+ yarn add {{name}}
22
+ ```
10
23
 
11
- [TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__dns)
24
+ Using pnpm:
25
+
26
+ ```sh
27
+ pnpm add {{name}}
28
+ ```
29
+
30
+ Using bun:
31
+
32
+ ```sh
33
+ bun add {{name}}
34
+ ```
12
35
 
13
- Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
14
36
 
15
37
  ## License
16
38
 
17
- > See the [LICENSE](LICENSE) file for license details
39
+ See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
40
+
41
+ ## Reference
42
+
43
+ ### packages
44
+
45
+ ### sdk-utils
46
+
47
+ ### packages
48
+
49
+ ### dns
50
+
51
+ ### .temp-typedoc
52
+
53
+ ### functions
54
+
55
+ ### <a id="domainExists"></a>domainExists
56
+
57
+ [**@xyo-network/dns**](#../README)
58
+
59
+ ***
60
+
61
+ ```ts
62
+ function domainExists(domain?): Promise<boolean>;
63
+ ```
64
+
65
+ Checks if a domain exists (resolves using DNS)
66
+
67
+ ## Parameters
68
+
69
+ ### domain?
70
+
71
+ `string`
72
+
73
+ string
74
+
75
+ ## Returns
76
+
77
+ `Promise`\<`boolean`\>
78
+
79
+ boolean
80
+
81
+ ### <a id="domainResolve"></a>domainResolve
82
+
83
+ [**@xyo-network/dns**](#../README)
84
+
85
+ ***
86
+
87
+ ```ts
88
+ function domainResolve(domain?, type?): Promise<GoogleDnsResult | undefined>;
89
+ ```
90
+
91
+ Resolves DNS information (resolves using DNS)
92
+
93
+ ## Parameters
94
+
95
+ ### domain?
96
+
97
+ `string`
98
+
99
+ string
100
+
101
+ ### type?
102
+
103
+ [`DnsRecordType`](#../type-aliases/DnsRecordType) = `DnsRecordType.A`
104
+
105
+ ## Returns
106
+
107
+ `Promise`\<[`GoogleDnsResult`](#../interfaces/GoogleDnsResult) \| `undefined`\>
108
+
109
+ GoogleDnsResult
110
+
111
+ ### <a id="googleDnsOverHttps"></a>googleDnsOverHttps
112
+
113
+ [**@xyo-network/dns**](#../README)
114
+
115
+ ***
116
+
117
+ ```ts
118
+ function googleDnsOverHttps(name, type?): Promise<GoogleDnsResult>;
119
+ ```
120
+
121
+ ## Parameters
122
+
123
+ ### name
124
+
125
+ `string`
126
+
127
+ ### type?
128
+
129
+ [`DnsRecordType`](#../type-aliases/DnsRecordType) = `DnsRecordType.A`
130
+
131
+ ## Returns
132
+
133
+ `Promise`\<[`GoogleDnsResult`](#../interfaces/GoogleDnsResult)\>
134
+
135
+ ### interfaces
136
+
137
+ ### <a id="GoogleDnsResult"></a>GoogleDnsResult
138
+
139
+ [**@xyo-network/dns**](#../README)
140
+
141
+ ***
142
+
143
+ ## Properties
144
+
145
+ ### AD?
146
+
147
+ ```ts
148
+ optional AD?: boolean;
149
+ ```
150
+
151
+ ***
152
+
153
+ ### Answer?
154
+
155
+ ```ts
156
+ optional Answer?: GoogleDnsResultAnswer[];
157
+ ```
158
+
159
+ ***
160
+
161
+ ### Authority?
162
+
163
+ ```ts
164
+ optional Authority?: GoogleDnsResultAnswer[];
165
+ ```
166
+
167
+ ***
168
+
169
+ ### CD?
170
+
171
+ ```ts
172
+ optional CD?: boolean;
173
+ ```
174
+
175
+ ***
176
+
177
+ ### Comment?
178
+
179
+ ```ts
180
+ optional Comment?: string;
181
+ ```
182
+
183
+ ***
184
+
185
+ ### Question?
186
+
187
+ ```ts
188
+ optional Question?: GoogleDnsResultQuestion[];
189
+ ```
190
+
191
+ ***
192
+
193
+ ### RA?
194
+
195
+ ```ts
196
+ optional RA?: boolean;
197
+ ```
198
+
199
+ ***
200
+
201
+ ### RD?
202
+
203
+ ```ts
204
+ optional RD?: boolean;
205
+ ```
206
+
207
+ ***
208
+
209
+ ### Status?
210
+
211
+ ```ts
212
+ optional Status?: number;
213
+ ```
214
+
215
+ ***
216
+
217
+ ### TC?
218
+
219
+ ```ts
220
+ optional TC?: boolean;
221
+ ```
222
+
223
+ ***
224
+
225
+ ### edns\_client\_subnet?
226
+
227
+ ```ts
228
+ optional edns_client_subnet?: string;
229
+ ```
230
+
231
+ ### <a id="GoogleDnsResultAnswer"></a>GoogleDnsResultAnswer
232
+
233
+ [**@xyo-network/dns**](#../README)
234
+
235
+ ***
236
+
237
+ ## Properties
238
+
239
+ ### TTL?
240
+
241
+ ```ts
242
+ optional TTL?: number;
243
+ ```
244
+
245
+ ***
246
+
247
+ ### data?
248
+
249
+ ```ts
250
+ optional data?: string;
251
+ ```
252
+
253
+ ***
254
+
255
+ ### name?
256
+
257
+ ```ts
258
+ optional name?: string;
259
+ ```
260
+
261
+ ***
262
+
263
+ ### type?
264
+
265
+ ```ts
266
+ optional type?: DnsRecordType;
267
+ ```
268
+
269
+ ### <a id="GoogleDnsResultQuestion"></a>GoogleDnsResultQuestion
270
+
271
+ [**@xyo-network/dns**](#../README)
272
+
273
+ ***
274
+
275
+ ## Properties
276
+
277
+ ### cd?
278
+
279
+ ```ts
280
+ optional cd?: boolean;
281
+ ```
282
+
283
+ ***
284
+
285
+ ### ct?
286
+
287
+ ```ts
288
+ optional ct?: string;
289
+ ```
290
+
291
+ ***
292
+
293
+ ### do?
294
+
295
+ ```ts
296
+ optional do?: boolean;
297
+ ```
298
+
299
+ ***
300
+
301
+ ### edns\_client\_subnet?
302
+
303
+ ```ts
304
+ optional edns_client_subnet?: string;
305
+ ```
306
+
307
+ ***
308
+
309
+ ### name?
310
+
311
+ ```ts
312
+ optional name?: string;
313
+ ```
314
+
315
+ ***
316
+
317
+ ### random\_padding?
318
+
319
+ ```ts
320
+ optional random_padding?: string;
321
+ ```
322
+
323
+ ***
324
+
325
+ ### type?
326
+
327
+ ```ts
328
+ optional type?: DnsRecordType;
329
+ ```
330
+
331
+ ### type-aliases
332
+
333
+ ### <a id="DnsRecordType"></a>DnsRecordType
334
+
335
+ [**@xyo-network/dns**](#../README)
336
+
337
+ ***
338
+
339
+ ```ts
340
+ type DnsRecordType = typeof DnsRecordType[keyof typeof DnsRecordType];
341
+ ```
342
+
343
+ ### <a id="DnsReturnCode"></a>DnsReturnCode
344
+
345
+ [**@xyo-network/dns**](#../README)
346
+
347
+ ***
348
+
349
+ ```ts
350
+ type DnsReturnCode = typeof DnsReturnCode[keyof typeof DnsReturnCode];
351
+ ```
352
+
353
+ ### variables
354
+
355
+ ### <a id="DnsRecordType"></a>DnsRecordType
356
+
357
+ [**@xyo-network/dns**](#../README)
358
+
359
+ ***
360
+
361
+ ```ts
362
+ const DnsRecordType: object;
363
+ ```
364
+
365
+ ## Type Declaration
366
+
367
+ ### A
368
+
369
+ ```ts
370
+ readonly A: 1 = 1;
371
+ ```
372
+
373
+ ### AAAA
374
+
375
+ ```ts
376
+ readonly AAAA: 28 = 28;
377
+ ```
378
+
379
+ ### CAA
380
+
381
+ ```ts
382
+ readonly CAA: 257 = 257;
383
+ ```
384
+
385
+ ### CNAME
386
+
387
+ ```ts
388
+ readonly CNAME: 5 = 5;
389
+ ```
390
+
391
+ ### DNAME
392
+
393
+ ```ts
394
+ readonly DNAME: 39 = 39;
395
+ ```
396
+
397
+ ### MX
398
+
399
+ ```ts
400
+ readonly MX: 15 = 15;
401
+ ```
402
+
403
+ ### NS
404
+
405
+ ```ts
406
+ readonly NS: 2 = 2;
407
+ ```
408
+
409
+ ### PTR
410
+
411
+ ```ts
412
+ readonly PTR: 12 = 12;
413
+ ```
414
+
415
+ ### SOA
416
+
417
+ ```ts
418
+ readonly SOA: 6 = 6;
419
+ ```
420
+
421
+ ### SPF
422
+
423
+ ```ts
424
+ readonly SPF: 99 = 99;
425
+ ```
426
+
427
+ ### SRV
428
+
429
+ ```ts
430
+ readonly SRV: 33 = 33;
431
+ ```
432
+
433
+ ### TXT
434
+
435
+ ```ts
436
+ readonly TXT: 16 = 16;
437
+ ```
438
+
439
+ ### <a id="DnsReturnCode"></a>DnsReturnCode
440
+
441
+ [**@xyo-network/dns**](#../README)
442
+
443
+ ***
444
+
445
+ ```ts
446
+ const DnsReturnCode: object;
447
+ ```
448
+
449
+ ## Type Declaration
450
+
451
+ ### NoError
452
+
453
+ ```ts
454
+ NoError: number = 0;
455
+ ```
456
+
457
+ ### QueryFormatError
458
+
459
+ ```ts
460
+ QueryFormatError: number = 1;
461
+ ```
462
+
463
+ ### ServerFailed
464
+
465
+ ```ts
466
+ ServerFailed: number = 2;
467
+ ```
468
+
469
+ ### DomainDoesNotExist
470
+
471
+ ```ts
472
+ DomainDoesNotExist: number = 3;
473
+ ```
474
+
475
+ ### NotImplemented
476
+
477
+ ```ts
478
+ NotImplemented: number = 4;
479
+ ```
480
+
481
+ ### Refused
482
+
483
+ ```ts
484
+ Refused: number = 5;
485
+ ```
486
+
487
+ ### NameShouldNotExist
488
+
489
+ ```ts
490
+ NameShouldNotExist: number = 6;
491
+ ```
492
+
493
+ ### RRSetShouldNotExist
494
+
495
+ ```ts
496
+ RRSetShouldNotExist: number = 7;
497
+ ```
498
+
499
+ ### NotAuthoritative
500
+
501
+ ```ts
502
+ NotAuthoritative: number = 8;
503
+ ```
504
+
505
+ ### NotInZone
18
506
 
19
- ## Credits
507
+ ```ts
508
+ NotInZone: number = 9;
509
+ ```
20
510
 
21
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
22
511
 
23
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
512
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
513
+ [npm-badge]: https://img.shields.io/npm/v/@xyo-network/dns.svg
514
+ [npm-link]: https://www.npmjs.com/package/@xyo-network/dns
515
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/dns.svg
516
+ [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/dns",
3
- "version": "5.3.24",
3
+ "version": "5.3.26",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -22,11 +22,11 @@
22
22
  "exports": {
23
23
  ".": {
24
24
  "types": "./dist/neutral/index.d.ts",
25
+ "import": "./dist/neutral/index.mjs",
25
26
  "default": "./dist/neutral/index.mjs"
26
27
  },
27
28
  "./package.json": "./package.json"
28
29
  },
29
- "module": "dist/neutral/index.mjs",
30
30
  "types": "dist/neutral/index.d.ts",
31
31
  "files": [
32
32
  "dist",
@@ -37,11 +37,11 @@
37
37
  ],
38
38
  "devDependencies": {
39
39
  "@opentelemetry/api": "^1.9.1",
40
- "@types/node": "^25.5.0",
41
- "@xylabs/sdk-js": "~5.0.93",
42
- "@xylabs/ts-scripts-common": "~7.6.16",
43
- "@xylabs/ts-scripts-pnpm": "~7.6.16",
44
- "@xylabs/tsconfig": "~7.6.16",
40
+ "@types/node": "^25.5.2",
41
+ "@xylabs/sdk-js": "~5.0.94",
42
+ "@xylabs/ts-scripts-common": "~7.7.5",
43
+ "@xylabs/ts-scripts-pnpm": "~7.7.5",
44
+ "@xylabs/tsconfig": "~7.7.5",
45
45
  "acorn": "^8.16.0",
46
46
  "axios": "^1.14.0",
47
47
  "esbuild": "^0.28.0",