@helia/verified-fetch 0.0.0-1ee6a4a

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 (79) hide show
  1. package/LICENSE +4 -0
  2. package/README.md +531 -0
  3. package/dist/index.min.js +118 -0
  4. package/dist/src/index.d.ts +574 -0
  5. package/dist/src/index.d.ts.map +1 -0
  6. package/dist/src/index.js +528 -0
  7. package/dist/src/index.js.map +1 -0
  8. package/dist/src/singleton.d.ts +3 -0
  9. package/dist/src/singleton.d.ts.map +1 -0
  10. package/dist/src/singleton.js +15 -0
  11. package/dist/src/singleton.js.map +1 -0
  12. package/dist/src/types.d.ts +2 -0
  13. package/dist/src/types.d.ts.map +1 -0
  14. package/dist/src/types.js +2 -0
  15. package/dist/src/types.js.map +1 -0
  16. package/dist/src/utils/dag-cbor-to-safe-json.d.ts +7 -0
  17. package/dist/src/utils/dag-cbor-to-safe-json.d.ts.map +1 -0
  18. package/dist/src/utils/dag-cbor-to-safe-json.js +37 -0
  19. package/dist/src/utils/dag-cbor-to-safe-json.js.map +1 -0
  20. package/dist/src/utils/get-content-disposition-filename.d.ts +6 -0
  21. package/dist/src/utils/get-content-disposition-filename.d.ts.map +1 -0
  22. package/dist/src/utils/get-content-disposition-filename.js +16 -0
  23. package/dist/src/utils/get-content-disposition-filename.js.map +1 -0
  24. package/dist/src/utils/get-e-tag.d.ts +28 -0
  25. package/dist/src/utils/get-e-tag.d.ts.map +1 -0
  26. package/dist/src/utils/get-e-tag.js +18 -0
  27. package/dist/src/utils/get-e-tag.js.map +1 -0
  28. package/dist/src/utils/get-stream-from-async-iterable.d.ts +10 -0
  29. package/dist/src/utils/get-stream-from-async-iterable.d.ts.map +1 -0
  30. package/dist/src/utils/get-stream-from-async-iterable.js +38 -0
  31. package/dist/src/utils/get-stream-from-async-iterable.js.map +1 -0
  32. package/dist/src/utils/get-tar-stream.d.ts +4 -0
  33. package/dist/src/utils/get-tar-stream.d.ts.map +1 -0
  34. package/dist/src/utils/get-tar-stream.js +46 -0
  35. package/dist/src/utils/get-tar-stream.js.map +1 -0
  36. package/dist/src/utils/parse-resource.d.ts +18 -0
  37. package/dist/src/utils/parse-resource.d.ts.map +1 -0
  38. package/dist/src/utils/parse-resource.js +24 -0
  39. package/dist/src/utils/parse-resource.js.map +1 -0
  40. package/dist/src/utils/parse-url-string.d.ts +32 -0
  41. package/dist/src/utils/parse-url-string.d.ts.map +1 -0
  42. package/dist/src/utils/parse-url-string.js +115 -0
  43. package/dist/src/utils/parse-url-string.js.map +1 -0
  44. package/dist/src/utils/responses.d.ts +5 -0
  45. package/dist/src/utils/responses.d.ts.map +1 -0
  46. package/dist/src/utils/responses.js +27 -0
  47. package/dist/src/utils/responses.js.map +1 -0
  48. package/dist/src/utils/select-output-type.d.ts +12 -0
  49. package/dist/src/utils/select-output-type.d.ts.map +1 -0
  50. package/dist/src/utils/select-output-type.js +148 -0
  51. package/dist/src/utils/select-output-type.js.map +1 -0
  52. package/dist/src/utils/tlru.d.ts +15 -0
  53. package/dist/src/utils/tlru.d.ts.map +1 -0
  54. package/dist/src/utils/tlru.js +40 -0
  55. package/dist/src/utils/tlru.js.map +1 -0
  56. package/dist/src/utils/walk-path.d.ts +13 -0
  57. package/dist/src/utils/walk-path.d.ts.map +1 -0
  58. package/dist/src/utils/walk-path.js +17 -0
  59. package/dist/src/utils/walk-path.js.map +1 -0
  60. package/dist/src/verified-fetch.d.ts +60 -0
  61. package/dist/src/verified-fetch.d.ts.map +1 -0
  62. package/dist/src/verified-fetch.js +408 -0
  63. package/dist/src/verified-fetch.js.map +1 -0
  64. package/package.json +197 -0
  65. package/src/index.ts +632 -0
  66. package/src/singleton.ts +20 -0
  67. package/src/types.ts +1 -0
  68. package/src/utils/dag-cbor-to-safe-json.ts +44 -0
  69. package/src/utils/get-content-disposition-filename.ts +18 -0
  70. package/src/utils/get-e-tag.ts +36 -0
  71. package/src/utils/get-stream-from-async-iterable.ts +45 -0
  72. package/src/utils/get-tar-stream.ts +68 -0
  73. package/src/utils/parse-resource.ts +40 -0
  74. package/src/utils/parse-url-string.ts +154 -0
  75. package/src/utils/responses.ts +29 -0
  76. package/src/utils/select-output-type.ts +167 -0
  77. package/src/utils/tlru.ts +52 -0
  78. package/src/utils/walk-path.ts +34 -0
  79. package/src/verified-fetch.ts +510 -0
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-content-disposition-filename.js","sourceRoot":"","sources":["../../../src/utils/get-content-disposition-filename.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,UAAU,6BAA6B,CAAE,QAAgB;IAC7D,MAAM,SAAS,GAAG,yBAAyB,CAAC,QAAQ,CAAC,CAAA;IAErD,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC3B,OAAO,aAAa,QAAQ,GAAG,CAAA;IACjC,CAAC;IAED,OAAO,aAAa,SAAS,uBAAuB,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAA;AACpF,CAAC;AAED,SAAS,yBAAyB,CAAE,QAAgB;IAClD,4CAA4C;IAC5C,OAAO,QAAQ,CAAC,OAAO,CAAC,eAAe,EAAE,GAAG,CAAC,CAAA;AAC/C,CAAC"}
@@ -0,0 +1,28 @@
1
+ import type { RequestFormatShorthand } from '../types.js';
2
+ import type { CID } from 'multiformats/cid';
3
+ interface GetETagArg {
4
+ cid: CID;
5
+ reqFormat?: RequestFormatShorthand;
6
+ rangeStart?: number;
7
+ rangeEnd?: number;
8
+ /**
9
+ * Weak Etag is used when we can't guarantee byte-for-byte-determinism (generated, or mutable content).
10
+ * Some examples:
11
+ * - IPNS requests
12
+ * - CAR streamed with blocks in non-deterministic order
13
+ * - TAR streamed with files in non-deterministic order
14
+ */
15
+ weak?: boolean;
16
+ }
17
+ /**
18
+ * etag
19
+ * you need to wrap cid with ""
20
+ * we use strong Etags for immutable responses and weak one (prefixed with W/ ) for mutable/generated ones (ipns and generated HTML).
21
+ * block and car responses should have different etag than deserialized one, so you can add some prefix like we do in existing gateway
22
+ *
23
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag
24
+ * @see https://specs.ipfs.tech/http-gateways/path-gateway/#etag-response-header
25
+ */
26
+ export declare function getETag({ cid, reqFormat, weak, rangeStart, rangeEnd }: GetETagArg): string;
27
+ export {};
28
+ //# sourceMappingURL=get-e-tag.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-e-tag.d.ts","sourceRoot":"","sources":["../../../src/utils/get-e-tag.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AACzD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAE3C,UAAU,UAAU;IAClB,GAAG,EAAE,GAAG,CAAA;IACR,SAAS,CAAC,EAAE,sBAAsB,CAAA;IAClC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;CACf;AAED;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAE,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE,UAAU,GAAG,MAAM,CAQ3F"}
@@ -0,0 +1,18 @@
1
+ /**
2
+ * etag
3
+ * you need to wrap cid with ""
4
+ * we use strong Etags for immutable responses and weak one (prefixed with W/ ) for mutable/generated ones (ipns and generated HTML).
5
+ * block and car responses should have different etag than deserialized one, so you can add some prefix like we do in existing gateway
6
+ *
7
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag
8
+ * @see https://specs.ipfs.tech/http-gateways/path-gateway/#etag-response-header
9
+ */
10
+ export function getETag({ cid, reqFormat, weak, rangeStart, rangeEnd }) {
11
+ const prefix = weak === true ? 'W/' : '';
12
+ let suffix = reqFormat == null ? '' : `.${reqFormat}`;
13
+ if (rangeStart != null || rangeEnd != null) {
14
+ suffix += `.${rangeStart ?? '0'}-${rangeEnd ?? 'N'}`;
15
+ }
16
+ return `${prefix}"${cid.toString()}${suffix}"`;
17
+ }
18
+ //# sourceMappingURL=get-e-tag.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-e-tag.js","sourceRoot":"","sources":["../../../src/utils/get-e-tag.ts"],"names":[],"mappings":"AAkBA;;;;;;;;GAQG;AACH,MAAM,UAAU,OAAO,CAAE,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAc;IACjF,MAAM,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAA;IACxC,IAAI,MAAM,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,SAAS,EAAE,CAAA;IACrD,IAAI,UAAU,IAAI,IAAI,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;QAC3C,MAAM,IAAI,IAAI,UAAU,IAAI,GAAG,IAAI,QAAQ,IAAI,GAAG,EAAE,CAAA;IACtD,CAAC;IAED,OAAO,GAAG,MAAM,IAAI,GAAG,CAAC,QAAQ,EAAE,GAAG,MAAM,GAAG,CAAA;AAChD,CAAC"}
@@ -0,0 +1,10 @@
1
+ import type { VerifiedFetchInit } from '../index.js';
2
+ import type { ComponentLogger } from '@libp2p/interface';
3
+ /**
4
+ * Converts an async iterator of Uint8Array bytes to a stream and returns the first chunk of bytes
5
+ */
6
+ export declare function getStreamFromAsyncIterable(iterator: AsyncIterable<Uint8Array>, path: string, logger: ComponentLogger, options?: Pick<VerifiedFetchInit, 'onProgress'>): Promise<{
7
+ stream: ReadableStream<Uint8Array>;
8
+ firstChunk: Uint8Array;
9
+ }>;
10
+ //# sourceMappingURL=get-stream-from-async-iterable.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-stream-from-async-iterable.d.ts","sourceRoot":"","sources":["../../../src/utils/get-stream-from-async-iterable.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AACpD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAExD;;GAEG;AACH,wBAAsB,0BAA0B,CAAE,QAAQ,EAAE,aAAa,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE,YAAY,CAAC,GAAG,OAAO,CAAC;IAAE,MAAM,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;IAAC,UAAU,EAAE,UAAU,CAAA;CAAE,CAAC,CAqCtP"}
@@ -0,0 +1,38 @@
1
+ import { CustomProgressEvent } from 'progress-events';
2
+ /**
3
+ * Converts an async iterator of Uint8Array bytes to a stream and returns the first chunk of bytes
4
+ */
5
+ export async function getStreamFromAsyncIterable(iterator, path, logger, options) {
6
+ const log = logger.forComponent('helia:verified-fetch:get-stream-from-async-iterable');
7
+ const reader = iterator[Symbol.asyncIterator]();
8
+ const { value: firstChunk, done } = await reader.next();
9
+ if (done === true) {
10
+ log.error('No content found for path', path);
11
+ throw new Error('No content found');
12
+ }
13
+ const stream = new ReadableStream({
14
+ async start(controller) {
15
+ // the initial value is already available
16
+ options?.onProgress?.(new CustomProgressEvent('verified-fetch:request:progress:chunk'));
17
+ controller.enqueue(firstChunk);
18
+ },
19
+ async pull(controller) {
20
+ const { value, done } = await reader.next();
21
+ if (done === true) {
22
+ if (value != null) {
23
+ options?.onProgress?.(new CustomProgressEvent('verified-fetch:request:progress:chunk'));
24
+ controller.enqueue(value);
25
+ }
26
+ controller.close();
27
+ return;
28
+ }
29
+ options?.onProgress?.(new CustomProgressEvent('verified-fetch:request:progress:chunk'));
30
+ controller.enqueue(value);
31
+ }
32
+ });
33
+ return {
34
+ stream,
35
+ firstChunk
36
+ };
37
+ }
38
+ //# sourceMappingURL=get-stream-from-async-iterable.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-stream-from-async-iterable.js","sourceRoot":"","sources":["../../../src/utils/get-stream-from-async-iterable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AAIrD;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAAE,QAAmC,EAAE,IAAY,EAAE,MAAuB,EAAE,OAA+C;IAC3K,MAAM,GAAG,GAAG,MAAM,CAAC,YAAY,CAAC,qDAAqD,CAAC,CAAA;IACtF,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAA;IAC/C,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAA;IAEvD,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,GAAG,CAAC,KAAK,CAAC,2BAA2B,EAAE,IAAI,CAAC,CAAA;QAC5C,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAA;IACrC,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC;QAChC,KAAK,CAAC,KAAK,CAAE,UAAU;YACrB,yCAAyC;YACzC,OAAO,EAAE,UAAU,EAAE,CAAC,IAAI,mBAAmB,CAAO,uCAAuC,CAAC,CAAC,CAAA;YAC7F,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;QAChC,CAAC;QACD,KAAK,CAAC,IAAI,CAAE,UAAU;YACpB,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAA;YAE3C,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;gBAClB,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;oBAClB,OAAO,EAAE,UAAU,EAAE,CAAC,IAAI,mBAAmB,CAAO,uCAAuC,CAAC,CAAC,CAAA;oBAC7F,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;gBAC3B,CAAC;gBACD,UAAU,CAAC,KAAK,EAAE,CAAA;gBAClB,OAAM;YACR,CAAC;YAED,OAAO,EAAE,UAAU,EAAE,CAAC,IAAI,mBAAmB,CAAO,uCAAuC,CAAC,CAAC,CAAA;YAC7F,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAC3B,CAAC;KACF,CAAC,CAAA;IAEF,OAAO;QACL,MAAM;QACN,UAAU;KACX,CAAA;AACH,CAAC"}
@@ -0,0 +1,4 @@
1
+ import type { AbortOptions } from '@libp2p/interface';
2
+ import type { Blockstore } from 'interface-blockstore';
3
+ export declare function tarStream(ipfsPath: string, blockstore: Blockstore, options?: AbortOptions): AsyncGenerator<Uint8Array>;
4
+ //# sourceMappingURL=get-tar-stream.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-tar-stream.d.ts","sourceRoot":"","sources":["../../../src/utils/get-tar-stream.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAsCtD,wBAAwB,SAAS,CAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC,UAAU,CAAC,CAuB/H"}
@@ -0,0 +1,46 @@
1
+ import { CodeError } from '@libp2p/interface';
2
+ import { exporter, recursive } from 'ipfs-unixfs-exporter';
3
+ import map from 'it-map';
4
+ import { pipe } from 'it-pipe';
5
+ import { pack } from 'it-tar';
6
+ const EXPORTABLE = ['file', 'raw', 'directory'];
7
+ function toHeader(file) {
8
+ let mode;
9
+ let mtime;
10
+ if (file.type === 'file' || file.type === 'directory') {
11
+ mode = file.unixfs.mode;
12
+ mtime = file.unixfs.mtime != null ? new Date(Number(file.unixfs.mtime.secs * 1000n)) : undefined;
13
+ }
14
+ return {
15
+ name: file.path,
16
+ mode,
17
+ mtime,
18
+ size: Number(file.size),
19
+ type: file.type === 'directory' ? 'directory' : 'file'
20
+ };
21
+ }
22
+ function toTarImportCandidate(entry) {
23
+ if (!EXPORTABLE.includes(entry.type)) {
24
+ throw new CodeError('Not a UnixFS node', 'ERR_NOT_UNIXFS');
25
+ }
26
+ const candidate = {
27
+ header: toHeader(entry)
28
+ };
29
+ if (entry.type === 'file' || entry.type === 'raw') {
30
+ candidate.body = entry.content();
31
+ }
32
+ return candidate;
33
+ }
34
+ export async function* tarStream(ipfsPath, blockstore, options) {
35
+ const file = await exporter(ipfsPath, blockstore, options);
36
+ if (file.type === 'file' || file.type === 'raw') {
37
+ yield* pipe([toTarImportCandidate(file)], pack());
38
+ return;
39
+ }
40
+ if (file.type === 'directory') {
41
+ yield* pipe(recursive(ipfsPath, blockstore, options), (source) => map(source, (entry) => toTarImportCandidate(entry)), pack());
42
+ return;
43
+ }
44
+ throw new CodeError('Not a UnixFS node', 'ERR_NOT_UNIXFS');
45
+ }
46
+ //# sourceMappingURL=get-tar-stream.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-tar-stream.js","sourceRoot":"","sources":["../../../src/utils/get-tar-stream.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAoB,MAAM,sBAAsB,CAAA;AAC5E,OAAO,GAAG,MAAM,QAAQ,CAAA;AACxB,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAC9B,OAAO,EAAE,IAAI,EAAgD,MAAM,QAAQ,CAAA;AAI3E,MAAM,UAAU,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,WAAW,CAAC,CAAA;AAE/C,SAAS,QAAQ,CAAE,IAAiB;IAClC,IAAI,IAAwB,CAAA;IAC5B,IAAI,KAAuB,CAAA;IAE3B,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QACtD,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAA;QACvB,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAClG,CAAC;IAED,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI;QACJ,KAAK;QACL,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;QACvB,IAAI,EAAE,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM;KACvD,CAAA;AACH,CAAC;AAED,SAAS,oBAAoB,CAAE,KAAkB;IAC/C,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,MAAM,IAAI,SAAS,CAAC,mBAAmB,EAAE,gBAAgB,CAAC,CAAA;IAC5D,CAAC;IAED,MAAM,SAAS,GAAuB;QACpC,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC;KACxB,CAAA;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QAClD,SAAS,CAAC,IAAI,GAAG,KAAK,CAAC,OAAO,EAAE,CAAA;IAClC,CAAC;IAED,OAAO,SAAS,CAAA;AAClB,CAAC;AAED,MAAM,CAAC,KAAK,SAAU,CAAC,CAAC,SAAS,CAAE,QAAgB,EAAE,UAAsB,EAAE,OAAsB;IACjG,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC,CAAA;IAE1D,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QAChD,KAAM,CAAC,CAAC,IAAI,CACV,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,EAC5B,IAAI,EAAE,CACP,CAAA;QAED,OAAM;IACR,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QAC9B,KAAM,CAAC,CAAC,IAAI,CACV,SAAS,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC,EACxC,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,EAC/D,IAAI,EAAE,CACP,CAAA;QAED,OAAM;IACR,CAAC;IAED,MAAM,IAAI,SAAS,CAAC,mBAAmB,EAAE,gBAAgB,CAAC,CAAA;AAC5D,CAAC"}
@@ -0,0 +1,18 @@
1
+ import type { ParsedUrlStringResults } from './parse-url-string.js';
2
+ import type { Resource } from '../index.js';
3
+ import type { IPNS, IPNSRoutingEvents, ResolveDnsLinkProgressEvents, ResolveProgressEvents } from '@helia/ipns';
4
+ import type { ComponentLogger } from '@libp2p/interface';
5
+ import type { ProgressOptions } from 'progress-events';
6
+ export interface ParseResourceComponents {
7
+ ipns: IPNS;
8
+ logger: ComponentLogger;
9
+ }
10
+ export interface ParseResourceOptions extends ProgressOptions<ResolveProgressEvents | IPNSRoutingEvents | ResolveDnsLinkProgressEvents> {
11
+ }
12
+ /**
13
+ * Handles the different use cases for the `resource` argument.
14
+ * The resource can represent an IPFS path, IPNS path, or CID.
15
+ * If the resource represents an IPNS path, we need to resolve it to a CID.
16
+ */
17
+ export declare function parseResource(resource: Resource, { ipns, logger }: ParseResourceComponents, options?: ParseResourceOptions): Promise<ParsedUrlStringResults>;
18
+ //# sourceMappingURL=parse-resource.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"parse-resource.d.ts","sourceRoot":"","sources":["../../../src/utils/parse-resource.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAA;AACnE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,4BAA4B,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAC/G,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEtD,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,IAAI,CAAA;IACV,MAAM,EAAE,eAAe,CAAA;CACxB;AAED,MAAM,WAAW,oBAAqB,SAAQ,eAAe,CAAC,qBAAqB,GAAG,iBAAiB,GAAG,4BAA4B,CAAC;CAEtI;AACD;;;;GAIG;AACH,wBAAsB,aAAa,CAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAkBnK"}
@@ -0,0 +1,24 @@
1
+ import { CID } from 'multiformats/cid';
2
+ import { parseUrlString } from './parse-url-string.js';
3
+ /**
4
+ * Handles the different use cases for the `resource` argument.
5
+ * The resource can represent an IPFS path, IPNS path, or CID.
6
+ * If the resource represents an IPNS path, we need to resolve it to a CID.
7
+ */
8
+ export async function parseResource(resource, { ipns, logger }, options) {
9
+ if (typeof resource === 'string') {
10
+ return parseUrlString({ urlString: resource, ipns, logger }, { onProgress: options?.onProgress });
11
+ }
12
+ const cid = CID.asCID(resource);
13
+ if (cid != null) {
14
+ // an actual CID
15
+ return {
16
+ cid,
17
+ protocol: 'ipfs',
18
+ path: '',
19
+ query: {}
20
+ };
21
+ }
22
+ throw new TypeError(`Invalid resource. Cannot determine CID from resource: ${resource}`);
23
+ }
24
+ //# sourceMappingURL=parse-resource.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"parse-resource.js","sourceRoot":"","sources":["../../../src/utils/parse-resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAetD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAE,QAAkB,EAAE,EAAE,IAAI,EAAE,MAAM,EAA2B,EAAE,OAA8B;IAChI,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,OAAO,cAAc,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAA;IACnG,CAAC;IAED,MAAM,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;IAE/B,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAChB,gBAAgB;QAChB,OAAO;YACL,GAAG;YACH,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,EAAE;YACR,KAAK,EAAE,EAAE;SACV,CAAA;IACH,CAAC;IAED,MAAM,IAAI,SAAS,CAAC,yDAAyD,QAAQ,EAAE,CAAC,CAAA;AAC1F,CAAC"}
@@ -0,0 +1,32 @@
1
+ import { CID } from 'multiformats/cid';
2
+ import type { RequestFormatShorthand } from '../types.js';
3
+ import type { IPNS, IPNSRoutingEvents, ResolveDnsLinkProgressEvents, ResolveProgressEvents } from '@helia/ipns';
4
+ import type { ComponentLogger } from '@libp2p/interface';
5
+ import type { ProgressOptions } from 'progress-events';
6
+ export interface ParseUrlStringInput {
7
+ urlString: string;
8
+ ipns: IPNS;
9
+ logger: ComponentLogger;
10
+ }
11
+ export interface ParseUrlStringOptions extends ProgressOptions<ResolveProgressEvents | IPNSRoutingEvents | ResolveDnsLinkProgressEvents> {
12
+ }
13
+ export interface ParsedUrlQuery extends Record<string, string | unknown> {
14
+ format?: RequestFormatShorthand;
15
+ download?: boolean;
16
+ filename?: string;
17
+ }
18
+ export interface ParsedUrlStringResults {
19
+ protocol: string;
20
+ path: string;
21
+ cid: CID;
22
+ query: ParsedUrlQuery;
23
+ }
24
+ /**
25
+ * A function that parses ipfs:// and ipns:// URLs, returning an object with easily recognizable properties.
26
+ *
27
+ * After determining the protocol successfully, we process the cidOrPeerIdOrDnsLink:
28
+ * * If it's ipfs, it parses the CID or throws an Aggregate error
29
+ * * If it's ipns, it attempts to resolve the PeerId and then the DNSLink. If both fail, an Aggregate error is thrown.
30
+ */
31
+ export declare function parseUrlString({ urlString, ipns, logger }: ParseUrlStringInput, options?: ParseUrlStringOptions): Promise<ParsedUrlStringResults>;
32
+ //# sourceMappingURL=parse-url-string.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"parse-url-string.d.ts","sourceRoot":"","sources":["../../../src/utils/parse-url-string.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAEtC,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AACzD,OAAO,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,4BAA4B,EAAE,qBAAqB,EAAiB,MAAM,aAAa,CAAA;AAC9H,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAItD,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,IAAI,CAAA;IACV,MAAM,EAAE,eAAe,CAAA;CACxB;AACD,MAAM,WAAW,qBAAsB,SAAQ,eAAe,CAAC,qBAAqB,GAAG,iBAAiB,GAAG,4BAA4B,CAAC;CAEvI;AAED,MAAM,WAAW,cAAe,SAAQ,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;IACtE,MAAM,CAAC,EAAE,sBAAsB,CAAA;IAC/B,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,GAAG,CAAA;IACR,KAAK,EAAE,cAAc,CAAA;CACtB;AAID;;;;;;GAMG;AACH,wBAAsB,cAAc,CAAE,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAgHxJ"}
@@ -0,0 +1,115 @@
1
+ import { peerIdFromString } from '@libp2p/peer-id';
2
+ import { CID } from 'multiformats/cid';
3
+ import { TLRU } from './tlru.js';
4
+ const ipnsCache = new TLRU(1000);
5
+ const URL_REGEX = /^(?<protocol>ip[fn]s):\/\/(?<cidOrPeerIdOrDnsLink>[^/$?]+)\/?(?<path>[^$?]*)\??(?<queryString>.*)$/;
6
+ /**
7
+ * A function that parses ipfs:// and ipns:// URLs, returning an object with easily recognizable properties.
8
+ *
9
+ * After determining the protocol successfully, we process the cidOrPeerIdOrDnsLink:
10
+ * * If it's ipfs, it parses the CID or throws an Aggregate error
11
+ * * If it's ipns, it attempts to resolve the PeerId and then the DNSLink. If both fail, an Aggregate error is thrown.
12
+ */
13
+ export async function parseUrlString({ urlString, ipns, logger }, options) {
14
+ const log = logger.forComponent('helia:verified-fetch:parse-url-string');
15
+ const match = urlString.match(URL_REGEX);
16
+ if (match == null || match.groups == null) {
17
+ throw new TypeError(`Invalid URL: ${urlString}, please use ipfs:// or ipns:// URLs only.`);
18
+ }
19
+ const { protocol, cidOrPeerIdOrDnsLink, path: urlPath, queryString } = match.groups;
20
+ let cid;
21
+ let resolvedPath;
22
+ const errors = [];
23
+ if (protocol === 'ipfs') {
24
+ try {
25
+ cid = CID.parse(cidOrPeerIdOrDnsLink);
26
+ }
27
+ catch (err) {
28
+ log.error(err);
29
+ errors.push(new TypeError('Invalid CID for ipfs://<cid> URL'));
30
+ }
31
+ }
32
+ else {
33
+ let resolveResult = ipnsCache.get(cidOrPeerIdOrDnsLink);
34
+ if (resolveResult != null) {
35
+ cid = resolveResult.cid;
36
+ resolvedPath = resolveResult.path;
37
+ log.trace('resolved %s to %c from cache', cidOrPeerIdOrDnsLink, cid);
38
+ }
39
+ else {
40
+ // protocol is ipns
41
+ log.trace('Attempting to resolve PeerId for %s', cidOrPeerIdOrDnsLink);
42
+ let peerId = null;
43
+ try {
44
+ peerId = peerIdFromString(cidOrPeerIdOrDnsLink);
45
+ resolveResult = await ipns.resolve(peerId, { onProgress: options?.onProgress });
46
+ cid = resolveResult?.cid;
47
+ resolvedPath = resolveResult?.path;
48
+ log.trace('resolved %s to %c', cidOrPeerIdOrDnsLink, cid);
49
+ ipnsCache.set(cidOrPeerIdOrDnsLink, resolveResult, 60 * 1000 * 2);
50
+ }
51
+ catch (err) {
52
+ if (peerId == null) {
53
+ log.error('Could not parse PeerId string "%s"', cidOrPeerIdOrDnsLink, err);
54
+ errors.push(new TypeError(`Could not parse PeerId in ipns url "${cidOrPeerIdOrDnsLink}", ${err.message}`));
55
+ }
56
+ else {
57
+ log.error('Could not resolve PeerId %c', peerId, err);
58
+ errors.push(new TypeError(`Could not resolve PeerId "${cidOrPeerIdOrDnsLink}", ${err.message}`));
59
+ }
60
+ }
61
+ if (cid == null) {
62
+ log.trace('Attempting to resolve DNSLink for %s', cidOrPeerIdOrDnsLink);
63
+ try {
64
+ resolveResult = await ipns.resolveDns(cidOrPeerIdOrDnsLink, { onProgress: options?.onProgress });
65
+ cid = resolveResult?.cid;
66
+ resolvedPath = resolveResult?.path;
67
+ log.trace('resolved %s to %c', cidOrPeerIdOrDnsLink, cid);
68
+ ipnsCache.set(cidOrPeerIdOrDnsLink, resolveResult, 60 * 1000 * 2);
69
+ }
70
+ catch (err) {
71
+ log.error('Could not resolve DnsLink for "%s"', cidOrPeerIdOrDnsLink, err);
72
+ errors.push(err);
73
+ }
74
+ }
75
+ }
76
+ }
77
+ if (cid == null) {
78
+ throw new AggregateError(errors, `Invalid resource. Cannot determine CID from URL "${urlString}"`);
79
+ }
80
+ // parse query string
81
+ const query = {};
82
+ if (queryString != null && queryString.length > 0) {
83
+ const queryParts = queryString.split('&');
84
+ for (const part of queryParts) {
85
+ const [key, value] = part.split('=');
86
+ query[key] = decodeURIComponent(value);
87
+ }
88
+ if (query.download != null) {
89
+ query.download = query.download === 'true';
90
+ }
91
+ if (query.filename != null) {
92
+ query.filename = query.filename.toString();
93
+ }
94
+ }
95
+ /**
96
+ * join the path from resolve result & given path.
97
+ * e.g. /ipns/<peerId>/ that is resolved to /ipfs/<cid>/<path1>, when requested as /ipns/<peerId>/<path2>, should be
98
+ * resolved to /ipfs/<cid>/<path1>/<path2>
99
+ */
100
+ const pathParts = [];
101
+ if (urlPath.length > 0) {
102
+ pathParts.push(urlPath);
103
+ }
104
+ if (resolvedPath != null && resolvedPath.length > 0) {
105
+ pathParts.push(resolvedPath);
106
+ }
107
+ const path = pathParts.join('/');
108
+ return {
109
+ protocol,
110
+ cid,
111
+ path,
112
+ query
113
+ };
114
+ }
115
+ //# sourceMappingURL=parse-url-string.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"parse-url-string.js","sourceRoot":"","sources":["../../../src/utils/parse-url-string.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAMhC,MAAM,SAAS,GAAG,IAAI,IAAI,CAAgB,IAAI,CAAC,CAAA;AAwB/C,MAAM,SAAS,GAAG,oGAAoG,CAAA;AAEtH;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAE,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAuB,EAAE,OAA+B;IACrH,MAAM,GAAG,GAAG,MAAM,CAAC,YAAY,CAAC,uCAAuC,CAAC,CAAA;IACxE,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;IAExC,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;QAC1C,MAAM,IAAI,SAAS,CAAC,gBAAgB,SAAS,4CAA4C,CAAC,CAAA;IAC5F,CAAC;IAED,MAAM,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC,MAAM,CAAA;IAEnF,IAAI,GAAoB,CAAA;IACxB,IAAI,YAAgC,CAAA;IACpC,MAAM,MAAM,GAAY,EAAE,CAAA;IAE1B,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;QACxB,IAAI,CAAC;YACH,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAA;QACvC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YACd,MAAM,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,kCAAkC,CAAC,CAAC,CAAA;QAChE,CAAC;IACH,CAAC;SAAM,CAAC;QACN,IAAI,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;QAEvD,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC;YAC1B,GAAG,GAAG,aAAa,CAAC,GAAG,CAAA;YACvB,YAAY,GAAG,aAAa,CAAC,IAAI,CAAA;YACjC,GAAG,CAAC,KAAK,CAAC,8BAA8B,EAAE,oBAAoB,EAAE,GAAG,CAAC,CAAA;QACtE,CAAC;aAAM,CAAC;YACN,mBAAmB;YACnB,GAAG,CAAC,KAAK,CAAC,qCAAqC,EAAE,oBAAoB,CAAC,CAAA;YACtE,IAAI,MAAM,GAAG,IAAI,CAAA;YAEjB,IAAI,CAAC;gBACH,MAAM,GAAG,gBAAgB,CAAC,oBAAoB,CAAC,CAAA;gBAC/C,aAAa,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAA;gBAC/E,GAAG,GAAG,aAAa,EAAE,GAAG,CAAA;gBACxB,YAAY,GAAG,aAAa,EAAE,IAAI,CAAA;gBAClC,GAAG,CAAC,KAAK,CAAC,mBAAmB,EAAE,oBAAoB,EAAE,GAAG,CAAC,CAAA;gBACzD,SAAS,CAAC,GAAG,CAAC,oBAAoB,EAAE,aAAa,EAAE,EAAE,GAAG,IAAI,GAAG,CAAC,CAAC,CAAA;YACnE,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;oBACnB,GAAG,CAAC,KAAK,CAAC,oCAAoC,EAAE,oBAAoB,EAAE,GAAG,CAAC,CAAA;oBAC1E,MAAM,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,uCAAuC,oBAAoB,MAAO,GAAa,CAAC,OAAO,EAAE,CAAC,CAAC,CAAA;gBACvH,CAAC;qBAAM,CAAC;oBACN,GAAG,CAAC,KAAK,CAAC,6BAA6B,EAAE,MAAM,EAAE,GAAG,CAAC,CAAA;oBACrD,MAAM,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,6BAA6B,oBAAoB,MAAO,GAAa,CAAC,OAAO,EAAE,CAAC,CAAC,CAAA;gBAC7G,CAAC;YACH,CAAC;YAED,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;gBAChB,GAAG,CAAC,KAAK,CAAC,sCAAsC,EAAE,oBAAoB,CAAC,CAAA;gBAEvE,IAAI,CAAC;oBACH,aAAa,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAA;oBAChG,GAAG,GAAG,aAAa,EAAE,GAAG,CAAA;oBACxB,YAAY,GAAG,aAAa,EAAE,IAAI,CAAA;oBAClC,GAAG,CAAC,KAAK,CAAC,mBAAmB,EAAE,oBAAoB,EAAE,GAAG,CAAC,CAAA;oBACzD,SAAS,CAAC,GAAG,CAAC,oBAAoB,EAAE,aAAa,EAAE,EAAE,GAAG,IAAI,GAAG,CAAC,CAAC,CAAA;gBACnE,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,GAAG,CAAC,KAAK,CAAC,oCAAoC,EAAE,oBAAoB,EAAE,GAAG,CAAC,CAAA;oBAC1E,MAAM,CAAC,IAAI,CAAC,GAAY,CAAC,CAAA;gBAC3B,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAChB,MAAM,IAAI,cAAc,CAAC,MAAM,EAAE,oDAAoD,SAAS,GAAG,CAAC,CAAA;IACpG,CAAC;IAED,qBAAqB;IACrB,MAAM,KAAK,GAAwB,EAAE,CAAA;IAErC,IAAI,WAAW,IAAI,IAAI,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClD,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACzC,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;YAC9B,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YACpC,KAAK,CAAC,GAAG,CAAC,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAA;QACxC,CAAC;QAED,IAAI,KAAK,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;YAC3B,KAAK,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,KAAK,MAAM,CAAA;QAC5C,CAAC;QAED,IAAI,KAAK,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;YAC3B,KAAK,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAA;QAC5C,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,MAAM,SAAS,GAAG,EAAE,CAAA;IAEpB,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACzB,CAAC;IAED,IAAI,YAAY,IAAI,IAAI,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpD,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;IAC9B,CAAC;IACD,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAEhC,OAAO;QACL,QAAQ;QACR,GAAG;QACH,IAAI;QACJ,KAAK;KACN,CAAA;AACH,CAAC"}
@@ -0,0 +1,5 @@
1
+ export declare function okResponse(body?: BodyInit | null): Response;
2
+ export declare function notSupportedResponse(body?: BodyInit | null): Response;
3
+ export declare function notAcceptableResponse(body?: BodyInit | null): Response;
4
+ export declare function badRequestResponse(body?: BodyInit | null): Response;
5
+ //# sourceMappingURL=responses.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../src/utils/responses.ts"],"names":[],"mappings":"AAAA,wBAAgB,UAAU,CAAE,IAAI,CAAC,EAAE,QAAQ,GAAG,IAAI,GAAG,QAAQ,CAK5D;AAED,wBAAgB,oBAAoB,CAAE,IAAI,CAAC,EAAE,QAAQ,GAAG,IAAI,GAAG,QAAQ,CAOtE;AAED,wBAAgB,qBAAqB,CAAE,IAAI,CAAC,EAAE,QAAQ,GAAG,IAAI,GAAG,QAAQ,CAKvE;AAED,wBAAgB,kBAAkB,CAAE,IAAI,CAAC,EAAE,QAAQ,GAAG,IAAI,GAAG,QAAQ,CAKpE"}
@@ -0,0 +1,27 @@
1
+ export function okResponse(body) {
2
+ return new Response(body, {
3
+ status: 200,
4
+ statusText: 'OK'
5
+ });
6
+ }
7
+ export function notSupportedResponse(body) {
8
+ const response = new Response(body, {
9
+ status: 501,
10
+ statusText: 'Not Implemented'
11
+ });
12
+ response.headers.set('X-Content-Type-Options', 'nosniff'); // see https://specs.ipfs.tech/http-gateways/path-gateway/#x-content-type-options-response-header
13
+ return response;
14
+ }
15
+ export function notAcceptableResponse(body) {
16
+ return new Response(body, {
17
+ status: 406,
18
+ statusText: 'Not Acceptable'
19
+ });
20
+ }
21
+ export function badRequestResponse(body) {
22
+ return new Response(body, {
23
+ status: 400,
24
+ statusText: 'Bad Request'
25
+ });
26
+ }
27
+ //# sourceMappingURL=responses.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"responses.js","sourceRoot":"","sources":["../../../src/utils/responses.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,UAAU,CAAE,IAAsB;IAChD,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE;QACxB,MAAM,EAAE,GAAG;QACX,UAAU,EAAE,IAAI;KACjB,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAE,IAAsB;IAC1D,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE;QAClC,MAAM,EAAE,GAAG;QACX,UAAU,EAAE,iBAAiB;KAC9B,CAAC,CAAA;IACF,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAA,CAAC,iGAAiG;IAC3J,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAE,IAAsB;IAC3D,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE;QACxB,MAAM,EAAE,GAAG;QACX,UAAU,EAAE,gBAAgB;KAC7B,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAE,IAAsB;IACxD,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE;QACxB,MAAM,EAAE,GAAG;QACX,UAAU,EAAE,aAAa;KAC1B,CAAC,CAAA;AACJ,CAAC"}
@@ -0,0 +1,12 @@
1
+ import type { RequestFormatShorthand } from '../types.js';
2
+ import type { CID } from 'multiformats/cid';
3
+ /**
4
+ * Selects an output mime-type based on the CID and a passed `Accept` header
5
+ */
6
+ export declare function selectOutputType(cid: CID, accept?: string): string | undefined;
7
+ /**
8
+ * Converts a `format=...` query param to a mime type as would be found in the
9
+ * `Accept` header, if a valid mapping is available
10
+ */
11
+ export declare function queryFormatToAcceptHeader(format?: RequestFormatShorthand): string | undefined;
12
+ //# sourceMappingURL=select-output-type.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"select-output-type.d.ts","sourceRoot":"","sources":["../../../src/utils/select-output-type.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AACzD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAwD3C;;GAEG;AACH,wBAAgB,gBAAgB,CAAE,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAM/E;AAuFD;;;GAGG;AACH,wBAAgB,yBAAyB,CAAE,MAAM,CAAC,EAAE,sBAAsB,GAAG,MAAM,GAAG,SAAS,CAI9F"}
@@ -0,0 +1,148 @@
1
+ import { code as dagCborCode } from '@ipld/dag-cbor';
2
+ import { code as dagJsonCode } from '@ipld/dag-json';
3
+ import { code as dagPbCode } from '@ipld/dag-pb';
4
+ import { code as jsonCode } from 'multiformats/codecs/json';
5
+ import { code as rawCode } from 'multiformats/codecs/raw';
6
+ /**
7
+ * This maps supported response types for each codec supported by verified-fetch
8
+ */
9
+ const CID_TYPE_MAP = {
10
+ [dagCborCode]: [
11
+ 'application/json',
12
+ 'application/vnd.ipld.dag-cbor',
13
+ 'application/cbor',
14
+ 'application/vnd.ipld.dag-json',
15
+ 'application/octet-stream',
16
+ 'application/vnd.ipld.raw',
17
+ 'application/vnd.ipfs.ipns-record',
18
+ 'application/vnd.ipld.car'
19
+ ],
20
+ [dagJsonCode]: [
21
+ 'application/json',
22
+ 'application/vnd.ipld.dag-cbor',
23
+ 'application/cbor',
24
+ 'application/vnd.ipld.dag-json',
25
+ 'application/octet-stream',
26
+ 'application/vnd.ipld.raw',
27
+ 'application/vnd.ipfs.ipns-record',
28
+ 'application/vnd.ipld.car'
29
+ ],
30
+ [jsonCode]: [
31
+ 'application/json',
32
+ 'application/vnd.ipld.dag-cbor',
33
+ 'application/cbor',
34
+ 'application/vnd.ipld.dag-json',
35
+ 'application/octet-stream',
36
+ 'application/vnd.ipld.raw',
37
+ 'application/vnd.ipfs.ipns-record',
38
+ 'application/vnd.ipld.car'
39
+ ],
40
+ [dagPbCode]: [
41
+ 'application/octet-stream',
42
+ 'application/json',
43
+ 'application/vnd.ipld.dag-cbor',
44
+ 'application/cbor',
45
+ 'application/vnd.ipld.dag-json',
46
+ 'application/vnd.ipld.raw',
47
+ 'application/vnd.ipfs.ipns-record',
48
+ 'application/vnd.ipld.car',
49
+ 'application/x-tar'
50
+ ],
51
+ [rawCode]: [
52
+ 'application/octet-stream',
53
+ 'application/vnd.ipld.raw',
54
+ 'application/vnd.ipfs.ipns-record',
55
+ 'application/vnd.ipld.car',
56
+ 'application/x-tar'
57
+ ]
58
+ };
59
+ /**
60
+ * Selects an output mime-type based on the CID and a passed `Accept` header
61
+ */
62
+ export function selectOutputType(cid, accept) {
63
+ const cidMimeTypes = CID_TYPE_MAP[cid.code];
64
+ if (accept != null) {
65
+ return chooseMimeType(accept, cidMimeTypes);
66
+ }
67
+ }
68
+ function chooseMimeType(accept, validMimeTypes) {
69
+ const requestedMimeTypes = accept
70
+ .split(',')
71
+ .map(s => {
72
+ const parts = s.trim().split(';');
73
+ return {
74
+ mimeType: `${parts[0]}`.trim(),
75
+ weight: parseQFactor(parts[1])
76
+ };
77
+ })
78
+ .sort((a, b) => {
79
+ if (a.weight === b.weight) {
80
+ return 0;
81
+ }
82
+ if (a.weight > b.weight) {
83
+ return -1;
84
+ }
85
+ return 1;
86
+ })
87
+ .map(s => s.mimeType);
88
+ for (const headerFormat of requestedMimeTypes) {
89
+ for (const mimeType of validMimeTypes) {
90
+ if (headerFormat.includes(mimeType)) {
91
+ return mimeType;
92
+ }
93
+ if (headerFormat === '*/*') {
94
+ return mimeType;
95
+ }
96
+ if (headerFormat.startsWith('*/') && mimeType.split('/')[1] === headerFormat.split('/')[1]) {
97
+ return mimeType;
98
+ }
99
+ if (headerFormat.endsWith('/*') && mimeType.split('/')[0] === headerFormat.split('/')[0]) {
100
+ return mimeType;
101
+ }
102
+ }
103
+ }
104
+ }
105
+ /**
106
+ * Parses q-factor weighting from the accept header to allow letting some mime
107
+ * types take precedence over others.
108
+ *
109
+ * If the q-factor for an acceptable mime representation is omitted it defaults
110
+ * to `1`.
111
+ *
112
+ * All specified values should be in the range 0-1.
113
+ *
114
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept#q
115
+ */
116
+ function parseQFactor(str) {
117
+ if (str != null) {
118
+ str = str.trim();
119
+ }
120
+ if (str == null || !str.startsWith('q=')) {
121
+ return 1;
122
+ }
123
+ const factor = parseFloat(str.replace('q=', ''));
124
+ if (isNaN(factor)) {
125
+ return 0;
126
+ }
127
+ return factor;
128
+ }
129
+ const FORMAT_TO_MIME_TYPE = {
130
+ raw: 'application/vnd.ipld.raw',
131
+ car: 'application/vnd.ipld.car',
132
+ 'dag-json': 'application/vnd.ipld.dag-json',
133
+ 'dag-cbor': 'application/vnd.ipld.dag-cbor',
134
+ json: 'application/json',
135
+ cbor: 'application/cbor',
136
+ 'ipns-record': 'application/vnd.ipfs.ipns-record',
137
+ tar: 'application/x-tar'
138
+ };
139
+ /**
140
+ * Converts a `format=...` query param to a mime type as would be found in the
141
+ * `Accept` header, if a valid mapping is available
142
+ */
143
+ export function queryFormatToAcceptHeader(format) {
144
+ if (format != null) {
145
+ return FORMAT_TO_MIME_TYPE[format];
146
+ }
147
+ }
148
+ //# sourceMappingURL=select-output-type.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"select-output-type.js","sourceRoot":"","sources":["../../../src/utils/select-output-type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,IAAI,WAAW,EAAE,MAAM,gBAAgB,CAAA;AACpD,OAAO,EAAE,IAAI,IAAI,WAAW,EAAE,MAAM,gBAAgB,CAAA;AACpD,OAAO,EAAE,IAAI,IAAI,SAAS,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EAAE,IAAI,IAAI,QAAQ,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,IAAI,IAAI,OAAO,EAAE,MAAM,yBAAyB,CAAA;AAIzD;;GAEG;AACH,MAAM,YAAY,GAA6B;IAC7C,CAAC,WAAW,CAAC,EAAE;QACb,kBAAkB;QAClB,+BAA+B;QAC/B,kBAAkB;QAClB,+BAA+B;QAC/B,0BAA0B;QAC1B,0BAA0B;QAC1B,kCAAkC;QAClC,0BAA0B;KAC3B;IACD,CAAC,WAAW,CAAC,EAAE;QACb,kBAAkB;QAClB,+BAA+B;QAC/B,kBAAkB;QAClB,+BAA+B;QAC/B,0BAA0B;QAC1B,0BAA0B;QAC1B,kCAAkC;QAClC,0BAA0B;KAC3B;IACD,CAAC,QAAQ,CAAC,EAAE;QACV,kBAAkB;QAClB,+BAA+B;QAC/B,kBAAkB;QAClB,+BAA+B;QAC/B,0BAA0B;QAC1B,0BAA0B;QAC1B,kCAAkC;QAClC,0BAA0B;KAC3B;IACD,CAAC,SAAS,CAAC,EAAE;QACX,0BAA0B;QAC1B,kBAAkB;QAClB,+BAA+B;QAC/B,kBAAkB;QAClB,+BAA+B;QAC/B,0BAA0B;QAC1B,kCAAkC;QAClC,0BAA0B;QAC1B,mBAAmB;KACpB;IACD,CAAC,OAAO,CAAC,EAAE;QACT,0BAA0B;QAC1B,0BAA0B;QAC1B,kCAAkC;QAClC,0BAA0B;QAC1B,mBAAmB;KACpB;CACF,CAAA;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAE,GAAQ,EAAE,MAAe;IACzD,MAAM,YAAY,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAE3C,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;QACnB,OAAO,cAAc,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;IAC7C,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAE,MAAc,EAAE,cAAwB;IAC/D,MAAM,kBAAkB,GAAG,MAAM;SAC9B,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,CAAC,EAAE;QACP,MAAM,KAAK,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAEjC,OAAO;YACL,QAAQ,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE;YAC9B,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC/B,CAAA;IACH,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACb,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;YAC1B,OAAO,CAAC,CAAA;QACV,CAAC;QAED,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;YACxB,OAAO,CAAC,CAAC,CAAA;QACX,CAAC;QAED,OAAO,CAAC,CAAA;IACV,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAA;IAEvB,KAAK,MAAM,YAAY,IAAI,kBAAkB,EAAE,CAAC;QAC9C,KAAK,MAAM,QAAQ,IAAI,cAAc,EAAE,CAAC;YACtC,IAAI,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACpC,OAAO,QAAQ,CAAA;YACjB,CAAC;YAED,IAAI,YAAY,KAAK,KAAK,EAAE,CAAC;gBAC3B,OAAO,QAAQ,CAAA;YACjB,CAAC;YAED,IAAI,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC3F,OAAO,QAAQ,CAAA;YACjB,CAAC;YAED,IAAI,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACzF,OAAO,QAAQ,CAAA;YACjB,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,YAAY,CAAE,GAAY;IACjC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAChB,GAAG,GAAG,GAAG,CAAC,IAAI,EAAE,CAAA;IAClB,CAAC;IAED,IAAI,GAAG,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACzC,OAAO,CAAC,CAAA;IACV,CAAC;IAED,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAA;IAEhD,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAClB,OAAO,CAAC,CAAA;IACV,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED,MAAM,mBAAmB,GAA2C;IAClE,GAAG,EAAE,0BAA0B;IAC/B,GAAG,EAAE,0BAA0B;IAC/B,UAAU,EAAE,+BAA+B;IAC3C,UAAU,EAAE,+BAA+B;IAC3C,IAAI,EAAE,kBAAkB;IACxB,IAAI,EAAE,kBAAkB;IACxB,aAAa,EAAE,kCAAkC;IACjD,GAAG,EAAE,mBAAmB;CACzB,CAAA;AAED;;;GAGG;AACH,MAAM,UAAU,yBAAyB,CAAE,MAA+B;IACxE,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;QACnB,OAAO,mBAAmB,CAAC,MAAM,CAAC,CAAA;IACpC,CAAC;AACH,CAAC"}
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Time Aware Least Recent Used Cache
3
+ *
4
+ * @see https://arxiv.org/pdf/1801.00390
5
+ */
6
+ export declare class TLRU<T> {
7
+ private readonly lru;
8
+ constructor(maxSize: number);
9
+ get(key: string): T | undefined;
10
+ set(key: string, value: T, ttl: number): void;
11
+ has(key: string): boolean;
12
+ remove(key: string): void;
13
+ clear(): void;
14
+ }
15
+ //# sourceMappingURL=tlru.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tlru.d.ts","sourceRoot":"","sources":["../../../src/utils/tlru.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,qBAAa,IAAI,CAAC,CAAC;IACjB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAA4B;gBAEnC,OAAO,EAAE,MAAM;IAI5B,GAAG,CAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAgBhC,GAAG,CAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAI9C,GAAG,CAAE,GAAG,EAAE,MAAM,GAAG,OAAO;IAU1B,MAAM,CAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAI1B,KAAK,IAAK,IAAI;CAGf"}