@helia/car 5.2.5 → 5.3.0-a1994bf0

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.
@@ -1,9 +1,16 @@
1
1
  import type { ExportStrategy } from '../index.js';
2
2
  import type { CodecLoader } from '@helia/interface';
3
+ import type { GraphWalker, GraphWalkerComponents } from '@helia/utils';
3
4
  import type { AbortOptions } from '@libp2p/interface';
4
5
  import type { Blockstore } from 'interface-blockstore';
5
6
  import type { BlockView } from 'multiformats';
6
7
  import type { CID } from 'multiformats/cid';
8
+ export interface SubgraphExporterInit {
9
+ /**
10
+ * Graph traversal strategy, defaults to breadth-first
11
+ */
12
+ walker?(components: GraphWalkerComponents): GraphWalker;
13
+ }
7
14
  /**
8
15
  * Traverses the DAG breadth-first starting at the target CID and yields all
9
16
  * encountered blocks.
@@ -12,6 +19,8 @@ import type { CID } from 'multiformats/cid';
12
19
  * the helia config.
13
20
  */
14
21
  export declare class SubgraphExporter implements ExportStrategy {
22
+ private walker?;
23
+ constructor(init?: SubgraphExporterInit);
15
24
  export(cid: CID, blockstore: Blockstore, getCodec: CodecLoader, options?: AbortOptions): AsyncGenerator<BlockView<unknown, number, number, 0 | 1>, void, undefined>;
16
25
  }
17
26
  //# sourceMappingURL=subgraph-exporter.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"subgraph-exporter.d.ts","sourceRoot":"","sources":["../../../src/export-strategies/subgraph-exporter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAE3C;;;;;;GAMG;AACH,qBAAa,gBAAiB,YAAW,cAAc;IAC7C,MAAM,CAAE,GAAG,EAAE,GAAG,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC;CAU7K"}
1
+ {"version":3,"file":"subgraph-exporter.d.ts","sourceRoot":"","sources":["../../../src/export-strategies/subgraph-exporter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AACtE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAE3C,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,MAAM,CAAC,CAAC,UAAU,EAAE,qBAAqB,GAAG,WAAW,CAAA;CACxD;AAED;;;;;;GAMG;AACH,qBAAa,gBAAiB,YAAW,cAAc;IACrD,OAAO,CAAC,MAAM,CAAC,CAAoD;gBAEtD,IAAI,CAAC,EAAE,oBAAoB;IAIhC,MAAM,CAAE,GAAG,EAAE,GAAG,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC;CAiB7K"}
@@ -7,11 +7,22 @@ import { breadthFirstWalker } from '@helia/utils';
7
7
  * the helia config.
8
8
  */
9
9
  export class SubgraphExporter {
10
+ walker;
11
+ constructor(init) {
12
+ this.walker = init?.walker;
13
+ }
10
14
  async *export(cid, blockstore, getCodec, options) {
11
- const walker = breadthFirstWalker({
15
+ let walker;
16
+ const components = {
12
17
  blockstore,
13
18
  getCodec
14
- });
19
+ };
20
+ if (this.walker != null) {
21
+ walker = this.walker(components);
22
+ }
23
+ else {
24
+ walker = breadthFirstWalker()(components);
25
+ }
15
26
  for await (const node of walker.walk(cid, options)) {
16
27
  yield node.block;
17
28
  }
@@ -1 +1 @@
1
- {"version":3,"file":"subgraph-exporter.js","sourceRoot":"","sources":["../../../src/export-strategies/subgraph-exporter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAQjD;;;;;;GAMG;AACH,MAAM,OAAO,gBAAgB;IAC3B,KAAK,CAAC,CAAE,MAAM,CAAE,GAAQ,EAAE,UAAsB,EAAE,QAAqB,EAAE,OAAsB;QAC7F,MAAM,MAAM,GAAG,kBAAkB,CAAC;YAChC,UAAU;YACV,QAAQ;SACT,CAAC,CAAA;QAEF,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,CAAC;YACnD,MAAM,IAAI,CAAC,KAAK,CAAA;QAClB,CAAC;IACH,CAAC;CACF"}
1
+ {"version":3,"file":"subgraph-exporter.js","sourceRoot":"","sources":["../../../src/export-strategies/subgraph-exporter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAgBjD;;;;;;GAMG;AACH,MAAM,OAAO,gBAAgB;IACnB,MAAM,CAAqD;IAEnE,YAAa,IAA2B;QACtC,IAAI,CAAC,MAAM,GAAG,IAAI,EAAE,MAAM,CAAA;IAC5B,CAAC;IAED,KAAK,CAAC,CAAE,MAAM,CAAE,GAAQ,EAAE,UAAsB,EAAE,QAAqB,EAAE,OAAsB;QAC7F,IAAI,MAAmB,CAAA;QACvB,MAAM,UAAU,GAAG;YACjB,UAAU;YACV,QAAQ;SACT,CAAA;QAED,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,kBAAkB,EAAE,CAAC,UAAU,CAAC,CAAA;QAC3C,CAAC;QAED,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,CAAC;YACnD,MAAM,IAAI,CAAC,KAAK,CAAA;QAClB,CAAC;IACH,CAAC;CACF"}
@@ -38,7 +38,7 @@ export class UnixFSExporter {
38
38
  if (cid.code !== DAG_PB_CODEC_CODE && cid.code !== RAW_PB_CODEC_CODE) {
39
39
  throw new NotUnixFSError('Target CID was not UnixFS - use the SubGraphExporter to export arbitrary graphs');
40
40
  }
41
- const walker = depthFirstWalker({
41
+ const walker = depthFirstWalker()({
42
42
  blockstore,
43
43
  getCodec
44
44
  });
@@ -1 +1 @@
1
- {"version":3,"file":"unixfs-exporter.js","sourceRoot":"","sources":["../../../src/export-strategies/unixfs-exporter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAC/C,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAC3E,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAyC7C,SAAS,UAAU,CAAE,KAA8C;IACjE,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,KAAK,iBAAiB,CAAA;AAC7C,CAAC;AAED,SAAS,YAAY,CAAE,KAA8C;IACnE,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,KAAK,iBAAiB,CAAA;AAC7C,CAAC;AAED,SAAS,MAAM,CAAE,KAA4C;IAC3D,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,IAAI,CAAA;IACb,CAAC;SAAM,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;QAC3D,MAAM,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAE5C,OAAO,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,IAAI,KAAK,KAAK,CAAA;IAC9C,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,cAAc,CAAC,8CAA8C,CAAC,CAAA;IAC1E,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,OAAO,cAAc;IACjB,OAAO,CAAwB;IAEvC,YAAa,OAA+B;QAC1C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAED,KAAK,CAAC,CAAE,MAAM,CAAE,GAAQ,EAAE,UAAsB,EAAE,QAAqB,EAAE,OAAsB;QAC7F,IAAI,GAAG,CAAC,IAAI,KAAK,iBAAiB,IAAI,GAAG,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;YACrE,MAAM,IAAI,cAAc,CAAC,iFAAiF,CAAC,CAAA;QAC7G,CAAC;QAED,MAAM,MAAM,GAAG,gBAAgB,CAAC;YAC9B,UAAU;YACV,QAAQ;SACT,CAAC,CAAA;QAEF,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC,CAAA;QACxC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,MAAM,IAAI,QAAQ,CAAA;QAC/C,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,EAAE,WAAW,IAAI,KAAK,CAAA;QAEtD,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;YACf,MAAM,IAAI,sBAAsB,CAAC,2BAA2B,CAAC,CAAA;QAC/D,CAAC;QAED,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;YACf,MAAM,IAAI,sBAAsB,CAAC,2BAA2B,CAAC,CAAA;QAC/D,CAAC;QAED,IAAI,aAAsB,CAAA;QAC1B,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;QAC7C,MAAM,MAAM,GAAG,SAAS,CAAC;YACvB,eAAe,CAAC,MAAM;YACtB,OAAO,EAAE,MAAM;SAChB,CAAC,CAAA;QACF,eAAe,CAAC,QAAQ,EAAE,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAEzD,SAAS,YAAY,CAAE,KAAU,EAAE,MAAyB;YAC1D,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC;gBAC1B,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;YAChC,CAAC;YAED,+CAA+C;YAC/C,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;gBAC/D,MAAM,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,IAAI,UAAU,EAAE,CAAC,CAAA;gBAEjE,IAAI,CAAC,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;oBAC3B,iCAAiC;oBACjC,OAAO,CAAC,WAAW,CAAA;gBACrB,CAAC;gBAED,IAAI,CAAC,CAAC,IAAI,KAAK,wBAAwB,IAAI,WAAW,EAAE,CAAC;oBACvD,+CAA+C;oBAC/C,OAAO,IAAI,EAAE,IAAI,EAAE,MAAM,KAAK,CAAC,CAAA;gBACjC,CAAC;gBAED,OAAO,IAAI,CAAA;YACb,CAAC;YAED,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;YAChF,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,IAAI,UAAU,EAAE,CAAC,CAAA;YAEtE,MAAM,KAAK,GAAG,MAAM,CAAA;YACpB,MAAM,GAAG,GAAG,KAAK,GAAG,MAAM,CAAA;YAE1B,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,GAAG,GAAG,EAAE,EAAE,CAAC,CAAC,CAAA;YAC5G,MAAM,QAAQ,GAAG,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAA;YAEnE,wBAAwB;YACxB,IAAI,KAAK,IAAI,UAAU,IAAI,KAAK,GAAG,QAAQ,EAAE,CAAC;gBAC5C,OAAO,IAAI,CAAA;YACb,CAAC;YAED,sBAAsB;YACtB,IAAI,GAAG,IAAI,UAAU,IAAI,GAAG,GAAG,QAAQ,EAAE,CAAC;gBACxC,OAAO,IAAI,CAAA;YACb,CAAC;YAED,uBAAuB;YACvB,IAAI,KAAK,IAAI,UAAU,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;gBAC3C,OAAO,IAAI,CAAA;YACb,CAAC;YAED,OAAO,KAAK,CAAA;QACd,CAAC;QAED,IAAI,CAAC;YACH,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE;gBACxC,GAAG,OAAO;gBACV,YAAY;gBACZ,MAAM;aACP,CAAC,EAAE,CAAC;gBACH,MAAM,IAAI,CAAC,KAAK,CAAA;YAClB,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,eAAe,CAAC,KAAK,EAAE,CAAA;YACvB,MAAM,CAAC,KAAK,EAAE,CAAA;QAChB,CAAC;IACH,CAAC;CACF"}
1
+ {"version":3,"file":"unixfs-exporter.js","sourceRoot":"","sources":["../../../src/export-strategies/unixfs-exporter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAC/C,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAC3E,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAyC7C,SAAS,UAAU,CAAE,KAA8C;IACjE,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,KAAK,iBAAiB,CAAA;AAC7C,CAAC;AAED,SAAS,YAAY,CAAE,KAA8C;IACnE,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,KAAK,iBAAiB,CAAA;AAC7C,CAAC;AAED,SAAS,MAAM,CAAE,KAA4C;IAC3D,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,IAAI,CAAA;IACb,CAAC;SAAM,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;QAC3D,MAAM,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAE5C,OAAO,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,IAAI,KAAK,KAAK,CAAA;IAC9C,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,cAAc,CAAC,8CAA8C,CAAC,CAAA;IAC1E,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,OAAO,cAAc;IACjB,OAAO,CAAwB;IAEvC,YAAa,OAA+B;QAC1C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAED,KAAK,CAAC,CAAE,MAAM,CAAE,GAAQ,EAAE,UAAsB,EAAE,QAAqB,EAAE,OAAsB;QAC7F,IAAI,GAAG,CAAC,IAAI,KAAK,iBAAiB,IAAI,GAAG,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;YACrE,MAAM,IAAI,cAAc,CAAC,iFAAiF,CAAC,CAAA;QAC7G,CAAC;QAED,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAC;YAChC,UAAU;YACV,QAAQ;SACT,CAAC,CAAA;QAEF,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC,CAAA;QACxC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,MAAM,IAAI,QAAQ,CAAA;QAC/C,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,EAAE,WAAW,IAAI,KAAK,CAAA;QAEtD,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;YACf,MAAM,IAAI,sBAAsB,CAAC,2BAA2B,CAAC,CAAA;QAC/D,CAAC;QAED,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;YACf,MAAM,IAAI,sBAAsB,CAAC,2BAA2B,CAAC,CAAA;QAC/D,CAAC;QAED,IAAI,aAAsB,CAAA;QAC1B,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;QAC7C,MAAM,MAAM,GAAG,SAAS,CAAC;YACvB,eAAe,CAAC,MAAM;YACtB,OAAO,EAAE,MAAM;SAChB,CAAC,CAAA;QACF,eAAe,CAAC,QAAQ,EAAE,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAEzD,SAAS,YAAY,CAAE,KAAU,EAAE,MAAyB;YAC1D,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC;gBAC1B,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;YAChC,CAAC;YAED,+CAA+C;YAC/C,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;gBAC/D,MAAM,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,IAAI,UAAU,EAAE,CAAC,CAAA;gBAEjE,IAAI,CAAC,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;oBAC3B,iCAAiC;oBACjC,OAAO,CAAC,WAAW,CAAA;gBACrB,CAAC;gBAED,IAAI,CAAC,CAAC,IAAI,KAAK,wBAAwB,IAAI,WAAW,EAAE,CAAC;oBACvD,+CAA+C;oBAC/C,OAAO,IAAI,EAAE,IAAI,EAAE,MAAM,KAAK,CAAC,CAAA;gBACjC,CAAC;gBAED,OAAO,IAAI,CAAA;YACb,CAAC;YAED,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;YAChF,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,IAAI,UAAU,EAAE,CAAC,CAAA;YAEtE,MAAM,KAAK,GAAG,MAAM,CAAA;YACpB,MAAM,GAAG,GAAG,KAAK,GAAG,MAAM,CAAA;YAE1B,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,GAAG,GAAG,EAAE,EAAE,CAAC,CAAC,CAAA;YAC5G,MAAM,QAAQ,GAAG,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAA;YAEnE,wBAAwB;YACxB,IAAI,KAAK,IAAI,UAAU,IAAI,KAAK,GAAG,QAAQ,EAAE,CAAC;gBAC5C,OAAO,IAAI,CAAA;YACb,CAAC;YAED,sBAAsB;YACtB,IAAI,GAAG,IAAI,UAAU,IAAI,GAAG,GAAG,QAAQ,EAAE,CAAC;gBACxC,OAAO,IAAI,CAAA;YACb,CAAC;YAED,uBAAuB;YACvB,IAAI,KAAK,IAAI,UAAU,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;gBAC3C,OAAO,IAAI,CAAA;YACb,CAAC;YAED,OAAO,KAAK,CAAA;QACd,CAAC;QAED,IAAI,CAAC;YACH,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE;gBACxC,GAAG,OAAO;gBACV,YAAY;gBACZ,MAAM;aACP,CAAC,EAAE,CAAC;gBACH,MAAM,IAAI,CAAC,KAAK,CAAA;YAClB,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,eAAe,CAAC,KAAK,EAAE,CAAA;YACvB,MAAM,CAAC,KAAK,EAAE,CAAA;QAChB,CAAC;IACH,CAAC;CACF"}
@@ -164,6 +164,8 @@ export interface ExportStrategy {
164
164
  }
165
165
  export * from './export-strategies/index.js';
166
166
  export * from './traversal-strategies/index.js';
167
+ export type { GraphWalker } from '@helia/utils';
168
+ export { depthFirstWalker, breadthFirstWalker, naturalOrderWalker } from '@helia/utils';
167
169
  export interface ExportCarOptions extends AbortOptions, ProgressOptions<GetBlockProgressEvents>, ProviderOptions {
168
170
  /**
169
171
  * If true, the blockstore will not do any network requests.
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8HG;AAGH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,KAAK,EAAE,2BAA2B,EAAE,sBAAsB,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AACnH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAC1C,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACtE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AAC7D,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEtD,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,eAAe,CAAA;IACvB,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,WAAW,CAAA;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;CACvK;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;CACpK;AAED,cAAc,8BAA8B,CAAA;AAC5C,cAAc,iCAAiC,CAAA;AAE/C,MAAM,WAAW,gBAAiB,SAAQ,YAAY,EAAE,eAAe,CAAC,sBAAsB,CAAC,EAAE,eAAe;IAC9G;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;OAGG;IACH,SAAS,CAAC,EAAE,iBAAiB,CAAA;IAE7B;;;OAGG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAA;IAEzB;;;;;OAKG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,GAAG;IAClB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,eAAe,CAAC,2BAA2B,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE/H;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,EAAE,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAAC,UAAU,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;CACnG;AAED;;GAEG;AACH,wBAAgB,GAAG,CAAE,KAAK,EAAE,aAAa,GAAG,GAAG,CAE9C"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8HG;AAGH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,KAAK,EAAE,2BAA2B,EAAE,sBAAsB,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AACnH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAC1C,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACtE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AAC7D,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEtD,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,eAAe,CAAA;IACvB,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,WAAW,CAAA;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;CACvK;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;CACpK;AAED,cAAc,8BAA8B,CAAA;AAC5C,cAAc,iCAAiC,CAAA;AAG/C,YAAY,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC/C,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAEvF,MAAM,WAAW,gBAAiB,SAAQ,YAAY,EAAE,eAAe,CAAC,sBAAsB,CAAC,EAAE,eAAe;IAC9G;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;OAGG;IACH,SAAS,CAAC,EAAE,iBAAiB,CAAA;IAE7B;;;OAGG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAA;IAEzB;;;;;OAKG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,GAAG;IAClB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,eAAe,CAAC,2BAA2B,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE/H;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,EAAE,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAAC,UAAU,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;CACnG;AAED;;GAEG;AACH,wBAAgB,GAAG,CAAE,KAAK,EAAE,aAAa,GAAG,GAAG,CAE9C"}
package/dist/src/index.js CHANGED
@@ -128,6 +128,7 @@
128
128
  import { Car as CarClass } from './car.js';
129
129
  export * from './export-strategies/index.js';
130
130
  export * from './traversal-strategies/index.js';
131
+ export { depthFirstWalker, breadthFirstWalker, naturalOrderWalker } from '@helia/utils';
131
132
  /**
132
133
  * Create a {@link Car} instance for use with {@link https://github.com/ipfs/helia Helia}
133
134
  */
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8HG;AAEH,OAAO,EAAE,GAAG,IAAI,QAAQ,EAAE,MAAM,UAAU,CAAA;AA0C1C,cAAc,8BAA8B,CAAA;AAC5C,cAAc,iCAAiC,CAAA;AAuF/C;;GAEG;AACH,MAAM,UAAU,GAAG,CAAE,KAAoB;IACvC,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAA;AAC5B,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8HG;AAEH,OAAO,EAAE,GAAG,IAAI,QAAQ,EAAE,MAAM,UAAU,CAAA;AA0C1C,cAAc,8BAA8B,CAAA;AAC5C,cAAc,iCAAiC,CAAA;AAI/C,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAuFvF;;GAEG;AACH,MAAM,UAAU,GAAG,CAAE,KAAoB;IACvC,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAA;AAC5B,CAAC"}
@@ -1,10 +1,20 @@
1
1
  import type { TraversalStrategy } from '../index.js';
2
2
  import type { CodecLoader } from '@helia/interface';
3
+ import type { GraphWalker, GraphWalkerComponents } from '@helia/utils';
3
4
  import type { AbortOptions } from '@libp2p/interface';
4
5
  import type { Blockstore } from 'interface-blockstore';
5
6
  import type { BlockView } from 'multiformats';
6
7
  import type { CID } from 'multiformats/cid';
7
8
  export interface GraphSearchOptions {
9
+ /**
10
+ * Graph traversal strategy, defaults to breadth-first
11
+ */
12
+ walker?(components: GraphWalkerComponents): GraphWalker;
13
+ /**
14
+ * How to search the graph
15
+ *
16
+ * @deprecated use `walker` instead - this will be removed in a future release
17
+ */
8
18
  strategy?: 'depth-first' | 'breadth-first';
9
19
  }
10
20
  /**
@@ -15,6 +25,7 @@ export declare class GraphSearch implements TraversalStrategy {
15
25
  private haystack?;
16
26
  private readonly needle;
17
27
  private readonly options?;
28
+ private walker?;
18
29
  constructor(needle: CID, options?: GraphSearchOptions);
19
30
  constructor(haystack: CID, needle: CID, options?: GraphSearchOptions);
20
31
  traverse(root: CID, blockstore: Blockstore, getCodec: CodecLoader, options?: AbortOptions): AsyncGenerator<BlockView<unknown, number, number, 0 | 1>, void, undefined>;
@@ -1 +1 @@
1
- {"version":3,"file":"graph-search.d.ts","sourceRoot":"","sources":["../../../src/traversal-strategies/graph-search.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAE3C,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,EAAE,aAAa,GAAG,eAAe,CAAA;CAC3C;AAMD;;;GAGG;AACH,qBAAa,WAAY,YAAW,iBAAiB;IACnD,OAAO,CAAC,QAAQ,CAAC,CAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAK;IAC5B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAoB;gBAEhC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,kBAAkB;gBACzC,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,kBAAkB;IAgB7D,QAAQ,CAAE,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC;CAmChL"}
1
+ {"version":3,"file":"graph-search.d.ts","sourceRoot":"","sources":["../../../src/traversal-strategies/graph-search.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AACtE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAE3C,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,CAAC,UAAU,EAAE,qBAAqB,GAAG,WAAW,CAAA;IAEvD;;;;OAIG;IACH,QAAQ,CAAC,EAAE,aAAa,GAAG,eAAe,CAAA;CAC3C;AAMD;;;GAGG;AACH,qBAAa,WAAY,YAAW,iBAAiB;IACnD,OAAO,CAAC,QAAQ,CAAC,CAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAK;IAC5B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAoB;IAC7C,OAAO,CAAC,MAAM,CAAC,CAAoD;gBAEtD,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,kBAAkB;gBACzC,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,kBAAkB;IAkB7D,QAAQ,CAAE,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC;CAmChL"}
@@ -14,6 +14,7 @@ export class GraphSearch {
14
14
  haystack;
15
15
  needle;
16
16
  options;
17
+ walker;
17
18
  constructor(...args) {
18
19
  if (isCID(args[0])) {
19
20
  if (isCID(args[1])) {
@@ -29,21 +30,23 @@ export class GraphSearch {
29
30
  else {
30
31
  throw new InvalidParametersError('needle must be specified');
31
32
  }
33
+ this.walker = this.options?.walker;
32
34
  }
33
35
  async *traverse(root, blockstore, getCodec, options) {
34
36
  const start = this.haystack ?? root;
35
37
  let walker;
36
- if (this.options?.strategy === 'breadth-first') {
37
- walker = breadthFirstWalker({
38
- blockstore,
39
- getCodec
40
- });
38
+ const components = {
39
+ blockstore,
40
+ getCodec
41
+ };
42
+ if (this.walker != null) {
43
+ walker = this.walker(components);
44
+ }
45
+ else if (this.options?.strategy === 'breadth-first') {
46
+ walker = breadthFirstWalker()(components);
41
47
  }
42
48
  else {
43
- walker = depthFirstWalker({
44
- blockstore,
45
- getCodec
46
- });
49
+ walker = depthFirstWalker()(components);
47
50
  }
48
51
  for await (const node of walker.walk(start, options)) {
49
52
  if (node.block.cid.equals(this.needle)) {
@@ -1 +1 @@
1
- {"version":3,"file":"graph-search.js","sourceRoot":"","sources":["../../../src/traversal-strategies/graph-search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AACnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAC1D,OAAO,QAAQ,MAAM,cAAc,CAAA;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAapD,SAAS,KAAK,CAAE,GAAS;IACvB,OAAO,GAAG,IAAI,IAAI,IAAI,GAAG,EAAE,KAAK,KAAK,GAAG,CAAA;AAC1C,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,WAAW;IACd,QAAQ,CAAM;IACL,MAAM,CAAK;IACX,OAAO,CAAqB;IAI7C,YAAa,GAAG,IAAW;QACzB,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACnB,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;gBACvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;gBACrB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;YACxB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;gBACrB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;YACxB,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,sBAAsB,CAAC,0BAA0B,CAAC,CAAA;QAC9D,CAAC;IACH,CAAC;IAED,KAAK,CAAC,CAAE,QAAQ,CAAE,IAAS,EAAE,UAAsB,EAAE,QAAqB,EAAE,OAAsB;QAChG,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAA;QACnC,IAAI,MAAmB,CAAA;QAEvB,IAAI,IAAI,CAAC,OAAO,EAAE,QAAQ,KAAK,eAAe,EAAE,CAAC;YAC/C,MAAM,GAAG,kBAAkB,CAAC;gBAC1B,UAAU;gBACV,QAAQ;aACT,CAAC,CAAA;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,gBAAgB,CAAC;gBACxB,UAAU;gBACV,QAAQ;aACT,CAAC,CAAA;QACJ,CAAC;QAED,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC;YACrD,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;gBACvC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;oBAC5B,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAA;oBAC1D,MAAM,KAAK,GAAG,YAAY,CAAC;wBACzB,GAAG;wBACH,KAAK;wBACL,KAAK,EAAE,MAAM,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC;qBAChC,CAAC,CAAA;oBAEF,MAAM,KAAK,CAAA;gBACb,CAAC;gBAED,OAAM;YACR,CAAC;QACH,CAAC;QAED,MAAM,IAAI,qBAAqB,CAAC,GAAG,IAAI,CAAC,MAAM,uBAAuB,KAAK,EAAE,CAAC,CAAA;IAC/E,CAAC;CACF"}
1
+ {"version":3,"file":"graph-search.js","sourceRoot":"","sources":["../../../src/traversal-strategies/graph-search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AACnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAC1D,OAAO,QAAQ,MAAM,cAAc,CAAA;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAuBpD,SAAS,KAAK,CAAE,GAAS;IACvB,OAAO,GAAG,IAAI,IAAI,IAAI,GAAG,EAAE,KAAK,KAAK,GAAG,CAAA;AAC1C,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,WAAW;IACd,QAAQ,CAAM;IACL,MAAM,CAAK;IACX,OAAO,CAAqB;IACrC,MAAM,CAAqD;IAInE,YAAa,GAAG,IAAW;QACzB,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACnB,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;gBACvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;gBACrB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;YACxB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;gBACrB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;YACxB,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,sBAAsB,CAAC,0BAA0B,CAAC,CAAA;QAC9D,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,MAAM,CAAA;IACpC,CAAC;IAED,KAAK,CAAC,CAAE,QAAQ,CAAE,IAAS,EAAE,UAAsB,EAAE,QAAqB,EAAE,OAAsB;QAChG,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAA;QACnC,IAAI,MAAmB,CAAA;QACvB,MAAM,UAAU,GAAG;YACjB,UAAU;YACV,QAAQ;SACT,CAAA;QAED,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;aAAM,IAAI,IAAI,CAAC,OAAO,EAAE,QAAQ,KAAK,eAAe,EAAE,CAAC;YACtD,MAAM,GAAG,kBAAkB,EAAE,CAAC,UAAU,CAAC,CAAA;QAC3C,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,gBAAgB,EAAE,CAAC,UAAU,CAAC,CAAA;QACzC,CAAC;QAED,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC;YACrD,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;gBACvC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;oBAC5B,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAA;oBAC1D,MAAM,KAAK,GAAG,YAAY,CAAC;wBACzB,GAAG;wBACH,KAAK;wBACL,KAAK,EAAE,MAAM,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC;qBAChC,CAAC,CAAA;oBAEF,MAAM,KAAK,CAAA;gBACb,CAAC;gBAED,OAAM;YACR,CAAC;QACH,CAAC;QAED,MAAM,IAAI,qBAAqB,CAAC,GAAG,IAAI,CAAC,MAAM,uBAAuB,KAAK,EAAE,CAAC,CAAA;IAC/E,CAAC;CACF"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@helia/car",
3
- "version": "5.2.5",
3
+ "version": "5.3.0-a1994bf0",
4
4
  "description": "Import/export car files from Helia",
5
5
  "license": "Apache-2.0 OR MIT",
6
6
  "homepage": "https://github.com/ipfs/helia/tree/main/packages/car#readme",
@@ -47,8 +47,8 @@
47
47
  "test:electron-main": "aegir test -t electron-main"
48
48
  },
49
49
  "dependencies": {
50
- "@helia/interface": "^6.0.2",
51
- "@helia/utils": "^2.2.5",
50
+ "@helia/interface": "6.0.2-a1994bf0",
51
+ "@helia/utils": "2.3.0-a1994bf0",
52
52
  "@ipld/car": "^5.4.2",
53
53
  "@ipld/dag-pb": "^4.1.5",
54
54
  "@libp2p/interface": "^3.1.0",
@@ -65,8 +65,8 @@
65
65
  "race-signal": "^2.0.0"
66
66
  },
67
67
  "devDependencies": {
68
- "@helia/mfs": "^6.0.3",
69
- "@helia/unixfs": "^6.0.3",
68
+ "@helia/mfs": "6.0.3-a1994bf0",
69
+ "@helia/unixfs": "6.0.3-a1994bf0",
70
70
  "@ipld/dag-cbor": "^9.2.5",
71
71
  "@libp2p/logger": "^6.0.5",
72
72
  "aegir": "^47.0.22",
@@ -1,11 +1,19 @@
1
1
  import { breadthFirstWalker } from '@helia/utils'
2
2
  import type { ExportStrategy } from '../index.js'
3
3
  import type { CodecLoader } from '@helia/interface'
4
+ import type { GraphWalker, GraphWalkerComponents } from '@helia/utils'
4
5
  import type { AbortOptions } from '@libp2p/interface'
5
6
  import type { Blockstore } from 'interface-blockstore'
6
7
  import type { BlockView } from 'multiformats'
7
8
  import type { CID } from 'multiformats/cid'
8
9
 
10
+ export interface SubgraphExporterInit {
11
+ /**
12
+ * Graph traversal strategy, defaults to breadth-first
13
+ */
14
+ walker?(components: GraphWalkerComponents): GraphWalker
15
+ }
16
+
9
17
  /**
10
18
  * Traverses the DAG breadth-first starting at the target CID and yields all
11
19
  * encountered blocks.
@@ -14,11 +22,24 @@ import type { CID } from 'multiformats/cid'
14
22
  * the helia config.
15
23
  */
16
24
  export class SubgraphExporter implements ExportStrategy {
25
+ private walker?: (components: GraphWalkerComponents) => GraphWalker
26
+
27
+ constructor (init?: SubgraphExporterInit) {
28
+ this.walker = init?.walker
29
+ }
30
+
17
31
  async * export (cid: CID, blockstore: Blockstore, getCodec: CodecLoader, options?: AbortOptions): AsyncGenerator<BlockView<unknown, number, number, 0 | 1>, void, undefined> {
18
- const walker = breadthFirstWalker({
32
+ let walker: GraphWalker
33
+ const components = {
19
34
  blockstore,
20
35
  getCodec
21
- })
36
+ }
37
+
38
+ if (this.walker != null) {
39
+ walker = this.walker(components)
40
+ } else {
41
+ walker = breadthFirstWalker()(components)
42
+ }
22
43
 
23
44
  for await (const node of walker.walk(cid, options)) {
24
45
  yield node.block
@@ -83,7 +83,7 @@ export class UnixFSExporter implements ExportStrategy {
83
83
  throw new NotUnixFSError('Target CID was not UnixFS - use the SubGraphExporter to export arbitrary graphs')
84
84
  }
85
85
 
86
- const walker = depthFirstWalker({
86
+ const walker = depthFirstWalker()({
87
87
  blockstore,
88
88
  getCodec
89
89
  })
package/src/index.ts CHANGED
@@ -171,6 +171,10 @@ export interface ExportStrategy {
171
171
  export * from './export-strategies/index.js'
172
172
  export * from './traversal-strategies/index.js'
173
173
 
174
+ // re-export walkers from @helia/utils so consumers don't need an extra dep
175
+ export type { GraphWalker } from '@helia/utils'
176
+ export { depthFirstWalker, breadthFirstWalker, naturalOrderWalker } from '@helia/utils'
177
+
174
178
  export interface ExportCarOptions extends AbortOptions, ProgressOptions<GetBlockProgressEvents>, ProviderOptions {
175
179
  /**
176
180
  * If true, the blockstore will not do any network requests.
@@ -5,13 +5,23 @@ import { createUnsafe } from 'multiformats/block'
5
5
  import { InvalidTraversalError } from '../errors.ts'
6
6
  import type { TraversalStrategy } from '../index.js'
7
7
  import type { CodecLoader } from '@helia/interface'
8
- import type { GraphWalker } from '@helia/utils'
8
+ import type { GraphWalker, GraphWalkerComponents } from '@helia/utils'
9
9
  import type { AbortOptions } from '@libp2p/interface'
10
10
  import type { Blockstore } from 'interface-blockstore'
11
11
  import type { BlockView } from 'multiformats'
12
12
  import type { CID } from 'multiformats/cid'
13
13
 
14
14
  export interface GraphSearchOptions {
15
+ /**
16
+ * Graph traversal strategy, defaults to breadth-first
17
+ */
18
+ walker?(components: GraphWalkerComponents): GraphWalker
19
+
20
+ /**
21
+ * How to search the graph
22
+ *
23
+ * @deprecated use `walker` instead - this will be removed in a future release
24
+ */
15
25
  strategy?: 'depth-first' | 'breadth-first'
16
26
  }
17
27
 
@@ -27,6 +37,7 @@ export class GraphSearch implements TraversalStrategy {
27
37
  private haystack?: CID
28
38
  private readonly needle: CID
29
39
  private readonly options?: GraphSearchOptions
40
+ private walker?: (components: GraphWalkerComponents) => GraphWalker
30
41
 
31
42
  constructor (needle: CID, options?: GraphSearchOptions)
32
43
  constructor (haystack: CID, needle: CID, options?: GraphSearchOptions)
@@ -43,22 +54,24 @@ export class GraphSearch implements TraversalStrategy {
43
54
  } else {
44
55
  throw new InvalidParametersError('needle must be specified')
45
56
  }
57
+
58
+ this.walker = this.options?.walker
46
59
  }
47
60
 
48
61
  async * traverse (root: CID, blockstore: Blockstore, getCodec: CodecLoader, options?: AbortOptions): AsyncGenerator<BlockView<unknown, number, number, 0 | 1>, void, undefined> {
49
62
  const start = this.haystack ?? root
50
63
  let walker: GraphWalker
64
+ const components = {
65
+ blockstore,
66
+ getCodec
67
+ }
51
68
 
52
- if (this.options?.strategy === 'breadth-first') {
53
- walker = breadthFirstWalker({
54
- blockstore,
55
- getCodec
56
- })
69
+ if (this.walker != null) {
70
+ walker = this.walker(components)
71
+ } else if (this.options?.strategy === 'breadth-first') {
72
+ walker = breadthFirstWalker()(components)
57
73
  } else {
58
- walker = depthFirstWalker({
59
- blockstore,
60
- getCodec
61
- })
74
+ walker = depthFirstWalker()(components)
62
75
  }
63
76
 
64
77
  for await (const node of walker.walk(start, options)) {
@@ -1,22 +0,0 @@
1
- {
2
- "BlockExporter": "https://ipfs.github.io/helia/classes/_helia_car.BlockExporter.html",
3
- "CIDPath": "https://ipfs.github.io/helia/classes/_helia_car.CIDPath.html",
4
- "GraphSearch": "https://ipfs.github.io/helia/classes/_helia_car.GraphSearch.html",
5
- "SubgraphExporter": "https://ipfs.github.io/helia/classes/_helia_car.SubgraphExporter.html",
6
- "UnixFSExporter": "https://ipfs.github.io/helia/classes/_helia_car.UnixFSExporter.html",
7
- "UnixFSPath": "https://ipfs.github.io/helia/classes/_helia_car.UnixFSPath.html",
8
- "Car": "https://ipfs.github.io/helia/interfaces/_helia_car.Car.html",
9
- ".:Car": "https://ipfs.github.io/helia/interfaces/_helia_car.Car.html",
10
- "CarComponents": "https://ipfs.github.io/helia/interfaces/_helia_car.CarComponents.html",
11
- ".:CarComponents": "https://ipfs.github.io/helia/interfaces/_helia_car.CarComponents.html",
12
- "ExportCarOptions": "https://ipfs.github.io/helia/interfaces/_helia_car.ExportCarOptions.html",
13
- ".:ExportCarOptions": "https://ipfs.github.io/helia/interfaces/_helia_car.ExportCarOptions.html",
14
- "ExportStrategy": "https://ipfs.github.io/helia/interfaces/_helia_car.ExportStrategy.html",
15
- ".:ExportStrategy": "https://ipfs.github.io/helia/interfaces/_helia_car.ExportStrategy.html",
16
- "GraphSearchOptions": "https://ipfs.github.io/helia/interfaces/_helia_car.GraphSearchOptions.html",
17
- "TraversalStrategy": "https://ipfs.github.io/helia/interfaces/_helia_car.TraversalStrategy.html",
18
- ".:TraversalStrategy": "https://ipfs.github.io/helia/interfaces/_helia_car.TraversalStrategy.html",
19
- "UnixFSExporterOptions": "https://ipfs.github.io/helia/interfaces/_helia_car.UnixFSExporterOptions.html",
20
- "car": "https://ipfs.github.io/helia/functions/_helia_car.car.html",
21
- ".:car": "https://ipfs.github.io/helia/functions/_helia_car.car.html"
22
- }