@helia/interface 7.0.3 → 7.1.0

package/dist/src/routing.d.ts

@@ -166,11 +166,13 @@ export interface RoutingGetClosestPeersEndEvent {
     key: Uint8Array;
 }
 export type RoutingGetClosestPeersProgressEvents = ProgressEvent<'helia:routing:get-closest-peers:start', RoutingGetClosestPeersStartEvent> | ProgressEvent<'helia:routing:get-closest-peers:end', RoutingGetClosestPeersEndEvent>;
+export type Capability = 'fallback';
 export interface Router {
     /**
      * The name of this routing implementation
      */
     name: string;
+    capabilities?(): Capability[];
     /**
      * The implementation of this method should ensure that network peers know the
      * caller can provide content that corresponds to the passed CID.
@@ -276,5 +278,5 @@ export interface Router {
      */
     getClosestPeers?(key: Uint8Array, options?: RoutingOptions<RoutingGetClosestPeersProgressEvents>): AsyncIterable<Peer>;
 }
-export type Routing = Required<Omit<Router, 'name'>>;
+export type Routing = Required<Omit<Router, 'name' | 'capabilities'>>;
 //# sourceMappingURL=routing.d.ts.map

package/dist/src/routing.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"routing.d.ts","sourceRoot":"","sources":["../../src/routing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE;;;;;GAKG;AACH,MAAM,WAAW,cAAc,CAAC,KAAK,SAAS,aAAa,GAAG,GAAG,CAAE,SAAQ,YAAY,EAAE,eAAe,CAAC,KAAK,CAAC;IAC7G;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,GAAG,CAAA;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,GAAG,CAAA;IAEP;;OAEG;IACH,UAAU,EAAE,SAAS,EAAE,CAAA;IAEvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,GAAG,CAAA;IAEP;;OAEG;IACH,UAAU,EAAE,SAAS,EAAE,CAAA;IAEvB;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IAEpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,8BAA8B;IAC7C,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;IACR,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,uCAAuC;IACtD,MAAM,EAAE,qBAAqB,CAAA;IAC7B,GAAG,EAAE,GAAG,CAAA;IACR,QAAQ,EAAE,IAAI,GAAG;QACf,SAAS,EAAE,CAAC,6BAA6B,CAAC,CAAA;KAC3C,CAAA;CACF;AAED,MAAM,WAAW,gDAAgD;IAC/D,MAAM,EAAE,uBAAuB,CAAA;IAC/B,GAAG,EAAE,GAAG,CAAA;IACR,QAAQ,EAAE,IAAI,GAAG;QACf,MAAM,EAAE,wBAAwB,CAAA;QAChC,SAAS,EAAE,MAAM,EAAE,CAAA;KACpB,CAAA;CACF;AAED,MAAM,WAAW,kCAAkC;IACjD,MAAM,EAAE,eAAe,CAAA;IACvB,GAAG,EAAE,GAAG,CAAA;IACR,QAAQ,EAAE,IAAI,CAAA;CACf;AAED,MAAM,MAAM,iCAAiC,GAAG,uCAAuC,GAAG,gDAAgD,GAAG,kCAAkC,CAAA;AAE/K,MAAM,MAAM,kCAAkC,GAC5C,aAAa,CAAC,oCAAoC,EAAE,8BAA8B,CAAC,GACnF,aAAa,CAAC,uCAAuC,EAAE,iCAAiC,CAAC,GACzF,aAAa,CAAC,kCAAkC,EAAE,4BAA4B,CAAC,GAC/E,6BAA6B,CAAA;AAE/B,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,MAAM,4BAA4B,GACtC,aAAa,CAAC,6BAA6B,EAAE,wBAAwB,CAAC,GACtE,aAAa,CAAC,2BAA2B,EAAE,sBAAsB,CAAC,CAAA;AAEpE,MAAM,WAAW,gCAAgC;IAC/C,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,WAAW,8BAA8B;IAC7C,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,MAAM,oCAAoC,GAC9C,aAAa,CAAC,sCAAsC,EAAE,gCAAgC,CAAC,GACvF,aAAa,CAAC,oCAAoC,EAAE,8BAA8B,CAAC,CAAA;AAErF,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,UAAU,CAAA;IACf,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,UAAU,CAAA;IACf,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,MAAM,wBAAwB,GAClC,aAAa,CAAC,yBAAyB,EAAE,oBAAoB,CAAC,GAC9D,aAAa,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAAA;AAE5D,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,MAAM,wBAAwB,GAClC,aAAa,CAAC,yBAAyB,EAAE,oBAAoB,CAAC,GAC9D,aAAa,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAAA;AAE5D,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,GAAG,CAAA;CACZ;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,GAAG,CAAA;CACZ;AAED,MAAM,MAAM,6BAA6B,GACvC,aAAa,CAAC,+BAA+B,EAAE,yBAAyB,CAAC,GACzE,aAAa,CAAC,6BAA6B,EAAE,uBAAuB,CAAC,CAAA;AAEvE,MAAM,WAAW,gCAAgC;IAC/C,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,WAAW,8BAA8B;IAC7C,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,MAAM,oCAAoC,GAC9C,aAAa,CAAC,uCAAuC,EAAE,gCAAgC,CAAC,GACxF,aAAa,CAAC,qCAAqC,EAAE,8BAA8B,CAAC,CAAA;AAEtF,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,4BAA4B,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzF;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEjE;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,kCAAkC,CAAC,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAA;IAE/G;;;;;;;;;;;;;;;OAeG;IACH,GAAG,CAAC,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE3G;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAA;IAE3G;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,6BAA6B,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE5F;;;;;;;;;;;;;;OAcG;IACH,eAAe,CAAC,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,oCAAoC,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,CAAA;CACvH;AAED,MAAM,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA"}
+{"version":3,"file":"routing.d.ts","sourceRoot":"","sources":["../../src/routing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE;;;;;GAKG;AACH,MAAM,WAAW,cAAc,CAAC,KAAK,SAAS,aAAa,GAAG,GAAG,CAAE,SAAQ,YAAY,EAAE,eAAe,CAAC,KAAK,CAAC;IAC7G;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,GAAG,CAAA;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,GAAG,CAAA;IAEP;;OAEG;IACH,UAAU,EAAE,SAAS,EAAE,CAAA;IAEvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,GAAG,CAAA;IAEP;;OAEG;IACH,UAAU,EAAE,SAAS,EAAE,CAAA;IAEvB;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IAEpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,8BAA8B;IAC7C,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;IACR,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,uCAAuC;IACtD,MAAM,EAAE,qBAAqB,CAAA;IAC7B,GAAG,EAAE,GAAG,CAAA;IACR,QAAQ,EAAE,IAAI,GAAG;QACf,SAAS,EAAE,CAAC,6BAA6B,CAAC,CAAA;KAC3C,CAAA;CACF;AAED,MAAM,WAAW,gDAAgD;IAC/D,MAAM,EAAE,uBAAuB,CAAA;IAC/B,GAAG,EAAE,GAAG,CAAA;IACR,QAAQ,EAAE,IAAI,GAAG;QACf,MAAM,EAAE,wBAAwB,CAAA;QAChC,SAAS,EAAE,MAAM,EAAE,CAAA;KACpB,CAAA;CACF;AAED,MAAM,WAAW,kCAAkC;IACjD,MAAM,EAAE,eAAe,CAAA;IACvB,GAAG,EAAE,GAAG,CAAA;IACR,QAAQ,EAAE,IAAI,CAAA;CACf;AAED,MAAM,MAAM,iCAAiC,GAAG,uCAAuC,GAAG,gDAAgD,GAAG,kCAAkC,CAAA;AAE/K,MAAM,MAAM,kCAAkC,GAC5C,aAAa,CAAC,oCAAoC,EAAE,8BAA8B,CAAC,GACnF,aAAa,CAAC,uCAAuC,EAAE,iCAAiC,CAAC,GACzF,aAAa,CAAC,kCAAkC,EAAE,4BAA4B,CAAC,GAC/E,6BAA6B,CAAA;AAE/B,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,MAAM,4BAA4B,GACtC,aAAa,CAAC,6BAA6B,EAAE,wBAAwB,CAAC,GACtE,aAAa,CAAC,2BAA2B,EAAE,sBAAsB,CAAC,CAAA;AAEpE,MAAM,WAAW,gCAAgC;IAC/C,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,WAAW,8BAA8B;IAC7C,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;CACT;AAED,MAAM,MAAM,oCAAoC,GAC9C,aAAa,CAAC,sCAAsC,EAAE,gCAAgC,CAAC,GACvF,aAAa,CAAC,oCAAoC,EAAE,8BAA8B,CAAC,CAAA;AAErF,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,UAAU,CAAA;IACf,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,UAAU,CAAA;IACf,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,MAAM,wBAAwB,GAClC,aAAa,CAAC,yBAAyB,EAAE,oBAAoB,CAAC,GAC9D,aAAa,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAAA;AAE5D,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,MAAM,wBAAwB,GAClC,aAAa,CAAC,yBAAyB,EAAE,oBAAoB,CAAC,GAC9D,aAAa,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAAA;AAE5D,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,GAAG,CAAA;CACZ;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,GAAG,CAAA;CACZ;AAED,MAAM,MAAM,6BAA6B,GACvC,aAAa,CAAC,+BAA+B,EAAE,yBAAyB,CAAC,GACzE,aAAa,CAAC,6BAA6B,EAAE,uBAAuB,CAAC,CAAA;AAEvE,MAAM,WAAW,gCAAgC;IAC/C,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,WAAW,8BAA8B;IAC7C,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,MAAM,oCAAoC,GAC9C,aAAa,CAAC,uCAAuC,EAAE,gCAAgC,CAAC,GACxF,aAAa,CAAC,qCAAqC,EAAE,8BAA8B,CAAC,CAAA;AAEtF,MAAM,MAAM,UAAU,GAAG,UAAU,CAAA;AAEnC,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ,YAAY,CAAC,IAAI,UAAU,EAAE,CAAA;IAE7B;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,4BAA4B,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzF;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEjE;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,kCAAkC,CAAC,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAA;IAE/G;;;;;;;;;;;;;;;OAeG;IACH,GAAG,CAAC,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE3G;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAA;IAE3G;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,6BAA6B,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE5F;;;;;;;;;;;;;;OAcG;IACH,eAAe,CAAC,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,oCAAoC,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,CAAA;CACvH;AAED,MAAM,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,CAAC,CAAC,CAAA"}

package/dist/typedoc-urls.json

@@ -81,6 +81,7 @@
   "RoutingProvideStartEvent": "https://ipfs.github.io/helia/interfaces/_helia_interface.routing.RoutingProvideStartEvent.html",
   "RoutingPutEndEvent": "https://ipfs.github.io/helia/interfaces/_helia_interface.routing.RoutingPutEndEvent.html",
   "RoutingPutStartEvent": "https://ipfs.github.io/helia/interfaces/_helia_interface.routing.RoutingPutStartEvent.html",
+  "Capability": "https://ipfs.github.io/helia/types/_helia_interface.routing.Capability.html",
   "Routing": "https://ipfs.github.io/helia/types/_helia_interface.routing.Routing.html",
   "RoutingCancelReprovideProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface.routing.RoutingCancelReprovideProgressEvents.html",
   "RoutingFindPeerProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface.routing.RoutingFindPeerProgressEvents.html",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helia/interface",
-  "version": "7.0.3",
+  "version": "7.1.0",
   "description": "The Helia API",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/ipfs/helia/tree/main/packages/interface#readme",

package/src/routing.ts

@@ -219,12 +219,16 @@ export type RoutingGetClosestPeersProgressEvents =
   ProgressEvent<'helia:routing:get-closest-peers:start', RoutingGetClosestPeersStartEvent> |
   ProgressEvent<'helia:routing:get-closest-peers:end', RoutingGetClosestPeersEndEvent>
 
+export type Capability = 'fallback'
+
 export interface Router {
   /**
    * The name of this routing implementation
    */
   name: string
 
+  capabilities?(): Capability[]
+
   /**
    * The implementation of this method should ensure that network peers know the
    * caller can provide content that corresponds to the passed CID.
@@ -337,4 +341,4 @@ export interface Router {
   getClosestPeers?(key: Uint8Array, options?: RoutingOptions<RoutingGetClosestPeersProgressEvents>): AsyncIterable<Peer>
 }
 
-export type Routing = Required<Omit<Router, 'name'>>
+export type Routing = Required<Omit<Router, 'name' | 'capabilities'>>