@helia/verified-fetch 0.0.0-f58d467 → 1.0.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.
- package/README.md +285 -25
- package/dist/index.min.js +7 -4
- package/dist/src/index.d.ts +285 -25
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +267 -25
- package/dist/src/index.js.map +1 -1
- package/dist/src/types.d.ts +2 -0
- package/dist/src/types.d.ts.map +1 -0
- package/dist/src/types.js +2 -0
- package/dist/src/types.js.map +1 -0
- package/dist/src/utils/dag-cbor-to-safe-json.d.ts +7 -0
- package/dist/src/utils/dag-cbor-to-safe-json.d.ts.map +1 -0
- package/dist/src/utils/dag-cbor-to-safe-json.js +37 -0
- package/dist/src/utils/dag-cbor-to-safe-json.js.map +1 -0
- package/dist/src/utils/get-content-disposition-filename.d.ts +6 -0
- package/dist/src/utils/get-content-disposition-filename.d.ts.map +1 -0
- package/dist/src/utils/get-content-disposition-filename.js +16 -0
- package/dist/src/utils/get-content-disposition-filename.js.map +1 -0
- package/dist/src/utils/get-e-tag.d.ts +28 -0
- package/dist/src/utils/get-e-tag.d.ts.map +1 -0
- package/dist/src/utils/get-e-tag.js +18 -0
- package/dist/src/utils/get-e-tag.js.map +1 -0
- package/dist/src/utils/get-tar-stream.d.ts +4 -0
- package/dist/src/utils/get-tar-stream.d.ts.map +1 -0
- package/dist/src/utils/get-tar-stream.js +46 -0
- package/dist/src/utils/get-tar-stream.js.map +1 -0
- package/dist/src/utils/parse-url-string.d.ts +7 -1
- package/dist/src/utils/parse-url-string.d.ts.map +1 -1
- package/dist/src/utils/parse-url-string.js +6 -0
- package/dist/src/utils/parse-url-string.js.map +1 -1
- package/dist/src/utils/responses.d.ts +5 -0
- package/dist/src/utils/responses.d.ts.map +1 -0
- package/dist/src/utils/responses.js +27 -0
- package/dist/src/utils/responses.js.map +1 -0
- package/dist/src/utils/select-output-type.d.ts +12 -0
- package/dist/src/utils/select-output-type.d.ts.map +1 -0
- package/dist/src/utils/select-output-type.js +148 -0
- package/dist/src/utils/select-output-type.js.map +1 -0
- package/dist/src/verified-fetch.d.ts +19 -26
- package/dist/src/verified-fetch.d.ts.map +1 -1
- package/dist/src/verified-fetch.js +261 -142
- package/dist/src/verified-fetch.js.map +1 -1
- package/dist/typedoc-urls.json +27 -0
- package/package.json +49 -112
- package/src/index.ts +290 -29
- package/src/types.ts +1 -0
- package/src/utils/dag-cbor-to-safe-json.ts +44 -0
- package/src/utils/get-content-disposition-filename.ts +18 -0
- package/src/utils/get-e-tag.ts +36 -0
- package/src/utils/get-tar-stream.ts +68 -0
- package/src/utils/parse-url-string.ts +17 -2
- package/src/utils/responses.ts +29 -0
- package/src/utils/select-output-type.ts +167 -0
- package/src/verified-fetch.ts +310 -154
package/dist/src/index.d.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*
|
|
4
4
|
* `@helia/verified-fetch` provides a [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)-like API for retrieving content from the [IPFS](https://ipfs.tech/) network.
|
|
5
5
|
*
|
|
6
|
-
* All content is retrieved in a [trustless manner](https://www.techopedia.com/definition/trustless), and the integrity of all bytes are verified by comparing hashes of the data.
|
|
6
|
+
* All content is retrieved in a [trustless manner](https://www.techopedia.com/definition/trustless), and the integrity of all bytes are verified by comparing hashes of the data. By default, CIDs are retrieved over HTTP from [trustless gateways](https://specs.ipfs.tech/http-gateways/trustless-gateway/).
|
|
7
7
|
*
|
|
8
8
|
* This is a marked improvement over `fetch` which offers no such protections and is vulnerable to all sorts of attacks like [Content Spoofing](https://owasp.org/www-community/attacks/Content_Spoofing), [DNS Hijacking](https://en.wikipedia.org/wiki/DNS_hijacking), etc.
|
|
9
9
|
*
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
* import { verifiedFetch } from '@helia/verified-fetch'
|
|
34
34
|
* import { CID } from 'multiformats/cid'
|
|
35
35
|
*
|
|
36
|
-
* const cid = CID.parse('bafyFoo') // some
|
|
36
|
+
* const cid = CID.parse('bafyFoo') // some json file
|
|
37
37
|
* const response = await verifiedFetch(cid)
|
|
38
38
|
* const json = await response.json()
|
|
39
39
|
* ```
|
|
@@ -56,7 +56,7 @@
|
|
|
56
56
|
* import { verifiedFetch } from '@helia/verified-fetch'
|
|
57
57
|
*
|
|
58
58
|
* const response = await verifiedFetch('ipns://mydomain.com/path/to/very-long-file.log')
|
|
59
|
-
* const bigFileStreamReader = await response.body
|
|
59
|
+
* const bigFileStreamReader = await response.body?.getReader()
|
|
60
60
|
* ```
|
|
61
61
|
*
|
|
62
62
|
* ## Configuration
|
|
@@ -73,8 +73,8 @@
|
|
|
73
73
|
* import { createVerifiedFetch } from '@helia/verified-fetch'
|
|
74
74
|
*
|
|
75
75
|
* const fetch = await createVerifiedFetch({
|
|
76
|
-
*
|
|
77
|
-
*
|
|
76
|
+
* gateways: ['https://trustless-gateway.link'],
|
|
77
|
+
* routers: ['http://delegated-ipfs.dev']
|
|
78
78
|
* })
|
|
79
79
|
*
|
|
80
80
|
* const resp = await fetch('ipfs://bafy...')
|
|
@@ -98,13 +98,13 @@
|
|
|
98
98
|
*
|
|
99
99
|
* const fetch = await createVerifiedFetch(
|
|
100
100
|
* await createHeliaHTTP({
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
101
|
+
* blockBrokers: [
|
|
102
|
+
* trustlessGateway({
|
|
103
|
+
* gateways: ['https://mygateway.example.net', 'https://trustless-gateway.link']
|
|
104
|
+
* })
|
|
105
|
+
* ],
|
|
106
|
+
* routers: ['http://delegated-ipfs.dev'].map((routerUrl) => delegatedHTTPRouting(routerUrl))
|
|
107
|
+
* })
|
|
108
108
|
* )
|
|
109
109
|
*
|
|
110
110
|
* const resp = await fetch('ipfs://bafy...')
|
|
@@ -114,7 +114,7 @@
|
|
|
114
114
|
*
|
|
115
115
|
* ### Custom content-type parsing
|
|
116
116
|
*
|
|
117
|
-
* By default, `@helia/verified-fetch` sets the `Content-Type` header as `application/octet-stream` - this is because the `.json()`, `.text()`, `.blob()`, and `.arrayBuffer()` methods will usually work as expected without a detailed content type.
|
|
117
|
+
* By default, if the response can be parsed as JSON, `@helia/verified-fetch` sets the `Content-Type` header as `application/json`, otherwise it sets it as `application/octet-stream` - this is because the `.json()`, `.text()`, `.blob()`, and `.arrayBuffer()` methods will usually work as expected without a detailed content type.
|
|
118
118
|
*
|
|
119
119
|
* If you require an accurate content-type you can provide a `contentTypeParser` function as an option to `createVerifiedFetch` to handle parsing the content type.
|
|
120
120
|
*
|
|
@@ -127,16 +127,258 @@
|
|
|
127
127
|
* import { fileTypeFromBuffer } from '@sgtpooki/file-type'
|
|
128
128
|
*
|
|
129
129
|
* const fetch = await createVerifiedFetch({
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
130
|
+
* gateways: ['https://trustless-gateway.link'],
|
|
131
|
+
* routers: ['http://delegated-ipfs.dev']
|
|
132
|
+
* }, {
|
|
133
|
+
* contentTypeParser: async (bytes) => {
|
|
134
|
+
* // call to some magic-byte recognition library like magic-bytes, file-type, or your own custom byte recognition
|
|
135
|
+
* const result = await fileTypeFromBuffer(bytes)
|
|
136
|
+
* return result?.mime
|
|
137
|
+
* }
|
|
137
138
|
* })
|
|
138
139
|
* ```
|
|
139
140
|
*
|
|
141
|
+
* ### Custom DNS resolvers
|
|
142
|
+
*
|
|
143
|
+
* If you don't want to leak DNS queries to the default resolvers, you can provide your own list of DNS resolvers to `createVerifiedFetch`.
|
|
144
|
+
*
|
|
145
|
+
* Note that you do not need to provide both a DNS-over-HTTPS and a DNS-over-JSON resolver, and you should prefer `dnsJsonOverHttps` resolvers for usage in the browser for a smaller bundle size. See https://github.com/ipfs/helia/tree/main/packages/ipns#example---using-dns-json-over-https for more information.
|
|
146
|
+
*
|
|
147
|
+
* @example Customizing DNS resolvers
|
|
148
|
+
*
|
|
149
|
+
* ```typescript
|
|
150
|
+
* import { createVerifiedFetch } from '@helia/verified-fetch'
|
|
151
|
+
* import { dnsJsonOverHttps, dnsOverHttps } from '@helia/ipns/dns-resolvers'
|
|
152
|
+
*
|
|
153
|
+
* const fetch = await createVerifiedFetch({
|
|
154
|
+
* gateways: ['https://trustless-gateway.link'],
|
|
155
|
+
* routers: ['http://delegated-ipfs.dev'],
|
|
156
|
+
* dnsResolvers: [
|
|
157
|
+
* dnsJsonOverHttps('https://my-dns-resolver.example.com/dns-json'),
|
|
158
|
+
* dnsOverHttps('https://my-dns-resolver.example.com/dns-query')
|
|
159
|
+
* ]
|
|
160
|
+
* })
|
|
161
|
+
* ```
|
|
162
|
+
*
|
|
163
|
+
* ### IPLD codec handling
|
|
164
|
+
*
|
|
165
|
+
* IPFS supports several data formats (typically referred to as codecs) which are included in the CID. `@helia/verified-fetch` attempts to abstract away some of the details for easier consumption.
|
|
166
|
+
*
|
|
167
|
+
* #### DAG-PB
|
|
168
|
+
*
|
|
169
|
+
* [DAG-PB](https://ipld.io/docs/codecs/known/dag-pb/) is the codec we are most likely to encounter, it is what [UnixFS](https://github.com/ipfs/specs/blob/main/UNIXFS.md) uses under the hood.
|
|
170
|
+
*
|
|
171
|
+
* ##### Using the DAG-PB codec as a Blob
|
|
172
|
+
*
|
|
173
|
+
* ```typescript
|
|
174
|
+
* import { verifiedFetch } from '@helia/verified-fetch'
|
|
175
|
+
*
|
|
176
|
+
* const res = await verifiedFetch('ipfs://Qmfoo')
|
|
177
|
+
* const blob = await res.blob()
|
|
178
|
+
*
|
|
179
|
+
* console.info(blob) // Blob { size: x, type: 'application/octet-stream' }
|
|
180
|
+
* ```
|
|
181
|
+
*
|
|
182
|
+
* ##### Using the DAG-PB codec as an ArrayBuffer
|
|
183
|
+
*
|
|
184
|
+
* ```typescript
|
|
185
|
+
* import { verifiedFetch } from '@helia/verified-fetch'
|
|
186
|
+
*
|
|
187
|
+
* const res = await verifiedFetch('ipfs://Qmfoo')
|
|
188
|
+
* const buf = await res.arrayBuffer()
|
|
189
|
+
*
|
|
190
|
+
* console.info(buf) // ArrayBuffer { [Uint8Contents]: < ... >, byteLength: x }
|
|
191
|
+
* ```
|
|
192
|
+
*
|
|
193
|
+
* ##### Using the DAG-PB codec as a stream
|
|
194
|
+
*
|
|
195
|
+
* ```typescript
|
|
196
|
+
* import { verifiedFetch } from '@helia/verified-fetch'
|
|
197
|
+
*
|
|
198
|
+
* const res = await verifiedFetch('ipfs://Qmfoo')
|
|
199
|
+
* const reader = res.body?.getReader()
|
|
200
|
+
*
|
|
201
|
+
* if (reader == null) {
|
|
202
|
+
* throw new Error('Could not create reader from response body')
|
|
203
|
+
* }
|
|
204
|
+
*
|
|
205
|
+
* while (true) {
|
|
206
|
+
* const next = await reader.read()
|
|
207
|
+
*
|
|
208
|
+
* if (next?.done === true) {
|
|
209
|
+
* break
|
|
210
|
+
* }
|
|
211
|
+
*
|
|
212
|
+
* if (next?.value != null) {
|
|
213
|
+
* console.info(next.value) // Uint8Array(x) [ ... ]
|
|
214
|
+
* }
|
|
215
|
+
* }
|
|
216
|
+
* ```
|
|
217
|
+
*
|
|
218
|
+
* ##### Content-Type
|
|
219
|
+
*
|
|
220
|
+
* When fetching `DAG-PB` data, the content type will be set to `application/octet-stream` unless a custom content-type parser is configured.
|
|
221
|
+
*
|
|
222
|
+
* #### JSON
|
|
223
|
+
*
|
|
224
|
+
* The JSON codec is a very simple codec, a block parseable with this codec is a JSON string encoded into a `Uint8Array`.
|
|
225
|
+
*
|
|
226
|
+
* ##### Using the JSON codec
|
|
227
|
+
*
|
|
228
|
+
* ```typescript
|
|
229
|
+
* import * as json from 'multiformats/codecs/json'
|
|
230
|
+
*
|
|
231
|
+
* const block = new TextEncoder().encode('{ "hello": "world" }')
|
|
232
|
+
* const obj = json.decode(block)
|
|
233
|
+
*
|
|
234
|
+
* console.info(obj) // { hello: 'world' }
|
|
235
|
+
* ```
|
|
236
|
+
*
|
|
237
|
+
* ##### Content-Type
|
|
238
|
+
*
|
|
239
|
+
* When the `JSON` codec is encountered, the `Content-Type` header of the response will be set to `application/json`.
|
|
240
|
+
*
|
|
241
|
+
* ### DAG-JSON
|
|
242
|
+
*
|
|
243
|
+
* [DAG-JSON](https://ipld.io/docs/codecs/known/dag-json/) expands on the `JSON` codec, adding the ability to contain [CID](https://docs.ipfs.tech/concepts/content-addressing/)s which act as links to other blocks, and byte arrays.
|
|
244
|
+
*
|
|
245
|
+
* `CID`s and byte arrays are represented using special object structures with a single `"/"` property.
|
|
246
|
+
*
|
|
247
|
+
* Using `DAG-JSON` has two important caveats:
|
|
248
|
+
*
|
|
249
|
+
* 1. Your `JSON` structure cannot contain an object with only a `"/"` property, as it will be interpreted as a special type.
|
|
250
|
+
* 2. Since `JSON` has no technical limit on number sizes, `DAG-JSON` also allows numbers larger than `Number.MAX_SAFE_INTEGER`. JavaScript requires use of `BigInt`s to represent numbers larger than this, and `JSON.parse` does not support them, so precision will be lost.
|
|
251
|
+
*
|
|
252
|
+
* Otherwise this codec follows the same rules as the `JSON` codec.
|
|
253
|
+
*
|
|
254
|
+
* ##### Using the DAG-JSON codec
|
|
255
|
+
*
|
|
256
|
+
* ```typescript
|
|
257
|
+
* import * as dagJson from '@ipld/dag-json'
|
|
258
|
+
*
|
|
259
|
+
* const block = new TextEncoder().encode(`{
|
|
260
|
+
* "hello": "world",
|
|
261
|
+
* "cid": {
|
|
262
|
+
* "/": "baeaaac3imvwgy3zao5xxe3de"
|
|
263
|
+
* },
|
|
264
|
+
* "buf": {
|
|
265
|
+
* "/": {
|
|
266
|
+
* "bytes": "AAECAwQ"
|
|
267
|
+
* }
|
|
268
|
+
* }
|
|
269
|
+
* }`)
|
|
270
|
+
*
|
|
271
|
+
* const obj = dagJson.decode(block)
|
|
272
|
+
*
|
|
273
|
+
* console.info(obj)
|
|
274
|
+
* // {
|
|
275
|
+
* // hello: 'world',
|
|
276
|
+
* // cid: CID(baeaaac3imvwgy3zao5xxe3de),
|
|
277
|
+
* // buf: Uint8Array(5) [ 0, 1, 2, 3, 4 ]
|
|
278
|
+
* // }
|
|
279
|
+
* ```
|
|
280
|
+
*
|
|
281
|
+
* ##### Content-Type
|
|
282
|
+
*
|
|
283
|
+
* When the `DAG-JSON` codec is encountered in the requested CID, the `Content-Type` header of the response will be set to `application/json`.
|
|
284
|
+
*
|
|
285
|
+
* `DAG-JSON` data can be parsed from the response by using the `.json()` function, which will return `CID`s/byte arrays as plain `{ "/": ... }` objects:
|
|
286
|
+
*
|
|
287
|
+
* ```typescript
|
|
288
|
+
* import { verifiedFetch } from '@helia/verified-fetch'
|
|
289
|
+
* import * as dagJson from '@ipld/dag-json'
|
|
290
|
+
*
|
|
291
|
+
* const res = await verifiedFetch('ipfs://bafyDAGJSON')
|
|
292
|
+
*
|
|
293
|
+
* // either:
|
|
294
|
+
* const obj = await res.json()
|
|
295
|
+
* console.info(obj.cid) // { "/": "baeaaac3imvwgy3zao5xxe3de" }
|
|
296
|
+
* console.info(obj.buf) // { "/": { "bytes": "AAECAwQ" } }
|
|
297
|
+
* ```
|
|
298
|
+
*
|
|
299
|
+
* Alternatively, it can be decoded using the `@ipld/dag-json` module and the `.arrayBuffer()` method, in which case you will get `CID` objects and `Uint8Array`s:
|
|
300
|
+
*
|
|
301
|
+
*```typescript
|
|
302
|
+
* import { verifiedFetch } from '@helia/verified-fetch'
|
|
303
|
+
* import * as dagJson from '@ipld/dag-json'
|
|
304
|
+
*
|
|
305
|
+
* const res = await verifiedFetch('ipfs://bafyDAGJSON')
|
|
306
|
+
*
|
|
307
|
+
* // or:
|
|
308
|
+
* const obj = dagJson.decode<any>(await res.arrayBuffer())
|
|
309
|
+
* console.info(obj.cid) // CID(baeaaac3imvwgy3zao5xxe3de)
|
|
310
|
+
* console.info(obj.buf) // Uint8Array(5) [ 0, 1, 2, 3, 4 ]
|
|
311
|
+
* ```
|
|
312
|
+
*
|
|
313
|
+
* #### DAG-CBOR
|
|
314
|
+
*
|
|
315
|
+
* [DAG-CBOR](https://ipld.io/docs/codecs/known/dag-cbor/) uses the [Concise Binary Object Representation](https://cbor.io/) format for serialization instead of JSON.
|
|
316
|
+
*
|
|
317
|
+
* This supports more datatypes in a safer way than JSON and is smaller on the wire to boot so is usually preferable to JSON or DAG-JSON.
|
|
318
|
+
*
|
|
319
|
+
* ##### Content-Type
|
|
320
|
+
*
|
|
321
|
+
* Not all data types supported by `DAG-CBOR` can be successfully turned into JSON and back into the same binary form.
|
|
322
|
+
*
|
|
323
|
+
* When a decoded block can be round-tripped to JSON, the `Content-Type` will be set to `application/json`. In this case the `.json()` method on the `Response` object can be used to obtain an object representation of the response.
|
|
324
|
+
*
|
|
325
|
+
* When it cannot, the `Content-Type` will be `application/octet-stream` - in this case the `@ipld/dag-json` module must be used to deserialize the return value from `.arrayBuffer()`.
|
|
326
|
+
*
|
|
327
|
+
* ##### Detecting JSON-safe DAG-CBOR
|
|
328
|
+
*
|
|
329
|
+
* If the `Content-Type` header of the response is `application/json`, the `.json()` method may be used to access the response body in object form, otherwise the `.arrayBuffer()` method must be used to decode the raw bytes using the `@ipld/dag-cbor` module.
|
|
330
|
+
*
|
|
331
|
+
* ```typescript
|
|
332
|
+
* import { verifiedFetch } from '@helia/verified-fetch'
|
|
333
|
+
* import * as dagCbor from '@ipld/dag-cbor'
|
|
334
|
+
*
|
|
335
|
+
* const res = await verifiedFetch('ipfs://bafyDagCborCID')
|
|
336
|
+
* let obj
|
|
337
|
+
*
|
|
338
|
+
* if (res.headers.get('Content-Type') === 'application/json') {
|
|
339
|
+
* // DAG-CBOR data can be safely decoded as JSON
|
|
340
|
+
* obj = await res.json()
|
|
341
|
+
* } else {
|
|
342
|
+
* // response contains non-JSON friendly data types
|
|
343
|
+
* obj = dagCbor.decode(await res.arrayBuffer())
|
|
344
|
+
* }
|
|
345
|
+
*
|
|
346
|
+
* console.info(obj) // ...
|
|
347
|
+
* ```
|
|
348
|
+
*
|
|
349
|
+
* ## The `Accept` header
|
|
350
|
+
*
|
|
351
|
+
* The `Accept` header can be passed to override certain response processing, or to ensure that the final `Content-Type` of the response is the one that is expected.
|
|
352
|
+
*
|
|
353
|
+
* If the final `Content-Type` does not match the `Accept` header, or if the content cannot be represented in the format dictated by the `Accept` header, or you have configured a custom content type parser, and that parser returns a value that isn't in the accept header, a [406: Not Acceptable](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/406) response will be returned:
|
|
354
|
+
*
|
|
355
|
+
* ```typescript
|
|
356
|
+
* import { verifiedFetch } from '@helia/verified-fetch'
|
|
357
|
+
*
|
|
358
|
+
* const res = await verifiedFetch('ipfs://bafyJPEGImageCID', {
|
|
359
|
+
* headers: {
|
|
360
|
+
* accept: 'image/png'
|
|
361
|
+
* }
|
|
362
|
+
* })
|
|
363
|
+
*
|
|
364
|
+
* console.info(res.status) // 406 - the image was a JPEG but we specified PNG as the accept header
|
|
365
|
+
* ```
|
|
366
|
+
*
|
|
367
|
+
* It can also be used to skip processing the data from some formats such as `DAG-CBOR` if you wish to handle decoding it yourself:
|
|
368
|
+
*
|
|
369
|
+
* ```typescript
|
|
370
|
+
* import { verifiedFetch } from '@helia/verified-fetch'
|
|
371
|
+
*
|
|
372
|
+
* const res = await verifiedFetch('ipfs://bafyDAGCBORCID', {
|
|
373
|
+
* headers: {
|
|
374
|
+
* accept: 'application/octet-stream'
|
|
375
|
+
* }
|
|
376
|
+
* })
|
|
377
|
+
*
|
|
378
|
+
* console.info(res.headers.get('accept')) // application/octet-stream
|
|
379
|
+
* const buf = await res.arrayBuffer() // raw bytes, not processed as JSON
|
|
380
|
+
* ```
|
|
381
|
+
*
|
|
140
382
|
* ## Comparison to fetch
|
|
141
383
|
*
|
|
142
384
|
* This module attempts to act as similarly to the `fetch()` API as possible.
|
|
@@ -154,7 +396,7 @@
|
|
|
154
396
|
* 2. IPNS protocol: `ipns://<peerId>` & `ipns://<publicKey>` & `ipns://<hostUri_Supporting_DnsLink_TxtRecords>`
|
|
155
397
|
* 3. CID instances: An actual CID instance `CID.parse('bafy...')`
|
|
156
398
|
*
|
|
157
|
-
* As well as support for pathing & params for
|
|
399
|
+
* As well as support for pathing & params for items 1 & 2 above according to [IPFS - Path Gateway Specification](https://specs.ipfs.tech/http-gateways/path-gateway) & [IPFS - Trustless Gateway Specification](https://specs.ipfs.tech/http-gateways/trustless-gateway/). Further refinement of those specifications specifically for web-based scenarios can be found in the [Web Pathing Specification IPIP](https://github.com/ipfs/specs/pull/453).
|
|
158
400
|
*
|
|
159
401
|
* If you pass a CID instance, it assumes you want the content for that specific CID only, and does not support pathing or params for that CID.
|
|
160
402
|
*
|
|
@@ -251,7 +493,7 @@
|
|
|
251
493
|
* 4. `AbortError` - If the content request is aborted due to user aborting provided AbortSignal.
|
|
252
494
|
*/
|
|
253
495
|
import type { Helia } from '@helia/interface';
|
|
254
|
-
import type { IPNSRoutingEvents, ResolveDnsLinkProgressEvents, ResolveProgressEvents } from '@helia/ipns';
|
|
496
|
+
import type { DNSResolver, IPNSRoutingEvents, ResolveDnsLinkProgressEvents, ResolveProgressEvents } from '@helia/ipns';
|
|
255
497
|
import type { GetEvents } from '@helia/unixfs';
|
|
256
498
|
import type { CID } from 'multiformats/cid';
|
|
257
499
|
import type { ProgressEvent, ProgressOptions } from 'progress-events';
|
|
@@ -259,8 +501,11 @@ import type { ProgressEvent, ProgressOptions } from 'progress-events';
|
|
|
259
501
|
* The types for the first argument of the `verifiedFetch` function.
|
|
260
502
|
*/
|
|
261
503
|
export type Resource = string | CID;
|
|
504
|
+
export interface ResourceDetail {
|
|
505
|
+
resource: Resource;
|
|
506
|
+
}
|
|
262
507
|
export interface CIDDetail {
|
|
263
|
-
cid:
|
|
508
|
+
cid: CID;
|
|
264
509
|
path: string;
|
|
265
510
|
}
|
|
266
511
|
export interface CIDDetailError extends CIDDetail {
|
|
@@ -275,14 +520,29 @@ export interface VerifiedFetch {
|
|
|
275
520
|
* Instead of passing a Helia instance, you can pass a list of gateways and
|
|
276
521
|
* routers, and a HeliaHTTP instance will be created for you.
|
|
277
522
|
*/
|
|
278
|
-
export interface
|
|
523
|
+
export interface CreateVerifiedFetchInit {
|
|
279
524
|
gateways: string[];
|
|
280
525
|
routers?: string[];
|
|
526
|
+
/**
|
|
527
|
+
* In order to parse DNSLink records, we need to resolve DNS queries. You can
|
|
528
|
+
* pass a list of DNS resolvers that we will provide to the @helia/ipns
|
|
529
|
+
* instance for you. You must construct them using the `dnsJsonOverHttps` or
|
|
530
|
+
* `dnsOverHttps` functions exported from `@helia/ipns/dns-resolvers`.
|
|
531
|
+
*
|
|
532
|
+
* We use cloudflare and google's dnsJsonOverHttps resolvers by default.
|
|
533
|
+
*
|
|
534
|
+
* @default [dnsJsonOverHttps('https://mozilla.cloudflare-dns.com/dns-query'),dnsJsonOverHttps('https://dns.google/resolve')]
|
|
535
|
+
*/
|
|
536
|
+
dnsResolvers?: DNSResolver[];
|
|
537
|
+
}
|
|
538
|
+
export interface CreateVerifiedFetchOptions {
|
|
281
539
|
/**
|
|
282
540
|
* A function to handle parsing content type from bytes. The function you
|
|
283
541
|
* provide will be passed the first set of bytes we receive from the network,
|
|
284
542
|
* and should return a string that will be used as the value for the
|
|
285
543
|
* `Content-Type` header in the response.
|
|
544
|
+
*
|
|
545
|
+
* @default undefined
|
|
286
546
|
*/
|
|
287
547
|
contentTypeParser?: ContentTypeParser;
|
|
288
548
|
}
|
|
@@ -313,6 +573,6 @@ export interface VerifiedFetchInit extends RequestInit, ProgressOptions<BubbledP
|
|
|
313
573
|
/**
|
|
314
574
|
* Create and return a Helia node
|
|
315
575
|
*/
|
|
316
|
-
export declare function createVerifiedFetch(init?: Helia | CreateVerifiedFetchOptions): Promise<VerifiedFetch>;
|
|
576
|
+
export declare function createVerifiedFetch(init?: Helia | CreateVerifiedFetchInit, options?: CreateVerifiedFetchOptions): Promise<VerifiedFetch>;
|
|
317
577
|
export { verifiedFetch } from './singleton.js';
|
|
318
578
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/src/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6eG;AAMH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,4BAA4B,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACtH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,GAAG,CAAA;AAEnC,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,GAAG,CAAA;IACR,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,cAAe,SAAQ,SAAS;IAC/C,KAAK,EAAE,KAAK,CAAA;CACb;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IACpE,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IACtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAElB;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,WAAW,EAAE,CAAA;CAC7B;AAED,MAAM,WAAW,0BAA0B;IACzC;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;CACtC;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,GAAG,MAAM,GAAG,SAAS,CAAA;CACzF;AAED,MAAM,MAAM,qBAAqB,GAE/B,SAAS,GAET,qBAAqB,GAAG,4BAA4B,GAAG,iBAAiB,CAAA;AAE1E,MAAM,MAAM,2BAA2B,GACrC,aAAa,CAAC,8BAA8B,EAAE,SAAS,CAAC,GACxD,aAAa,CAAC,6BAA6B,EAAE,MAAM,CAAC,GACpD,aAAa,CAAC,uCAAuC,EAAE,SAAS,CAAC,GACjE,aAAa,CAAC,4BAA4B,EAAE,SAAS,CAAC,GACtD,aAAa,CAAC,8BAA8B,EAAE,cAAc,CAAC,CAAA;AAE/D;;;;;;GAMG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW,EAAE,eAAe,CAAC,qBAAqB,GAAG,2BAA2B,CAAC;CAC3H;AAED;;GAEG;AACH,wBAAsB,mBAAmB,CAAE,IAAI,CAAC,EAAE,KAAK,GAAG,uBAAuB,EAAE,OAAO,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,aAAa,CAAC,CAsB/I;AAED,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA"}
|