@helia/http 4.0.2 → 4.0.3-c0c34ad1

package/dist/src/index.d.ts

@@ -61,7 +61,7 @@
 import type { Helia } from '@helia/interface';
 import type { TrustlessGatewayBlockBrokerInit } from '@helia/trustless-gateway-client';
 export declare const DEFAULT_TRUSTLESS_GATEWAYS: string[];
-export interface HTTPOptions {
+export interface HTTPOptions extends TrustlessGatewayBlockBrokerInit {
     /**
      * Delegated routers are servers that make routing requests on behalf of peers
      * with less capable network connectivity.
@@ -82,11 +82,21 @@ export interface HTTPOptions {
      */
     recursiveGateways?: string[];
     /**
-     * Init arg passed to the trustless gateway block broker
+     * List of protocols to filter in the PeerRecords as defined in IPIP-484
+     * If undefined, PeerRecords are not filtered by protocol
      *
-     * @see https://docs.ipfs.tech/reference/http/gateway/#trusted-vs-trustless
+     * @see https://github.com/ipfs/specs/pull/484
+     * @default undefined
      */
-    trustlessGatewayBlockBrokerInit?: TrustlessGatewayBlockBrokerInit;
+    filterProtocols?: string[];
+    /**
+     * Array of address filters to filter PeerRecords's addresses as defined in IPIP-484
+     * If undefined, PeerRecords are not filtered by address
+     *
+     * @see https://github.com/ipfs/specs/pull/484
+     * @default undefined
+     */
+    filterAddrs?: string[];
 }
 /**
  * Augment a Helia node with HTTP routers and block brokers

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2DG;AAKH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,iCAAiC,CAAA;AAEtF,eAAO,MAAM,0BAA0B,UAMtC,CAAA;AAED,MAAM,WAAW,WAAW;IAC1B;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;IAE3B;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAE5B;;;;OAIG;IACH,+BAA+B,CAAC,EAAE,+BAA+B,CAAA;CAClE;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAE,CAAC,SAAS,KAAK,EAAG,KAAK,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,CAAC,CAmB3E"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2DG;AAKH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,iCAAiC,CAAA;AAEtF,eAAO,MAAM,0BAA0B,UAMtC,CAAA;AAED,MAAM,WAAW,WAAY,SAAQ,+BAA+B;IAClE;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;IAE3B;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAE5B;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;IAE1B;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;CACvB;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAE,CAAC,SAAS,KAAK,EAAG,KAAK,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,CAAC,CAwB3E"}

package/dist/src/index.js

@@ -71,19 +71,24 @@ export const DEFAULT_TRUSTLESS_GATEWAYS = [
  * Augment a Helia node with HTTP routers and block brokers
  */
 export function withHTTP(helia, init) {
-    init?.delegatedRouters ?? [
+    (init?.delegatedRouters ?? [
         'https://delegated-ipfs.dev'
-    ].forEach(url => {
+    ]).forEach(url => {
         helia.addRouter(delegatedHTTPRouter({
+            ...init,
             url
         }));
     });
-    helia.addRouter(fallbackRouter({
-        gateways: init?.recursiveGateways ?? DEFAULT_TRUSTLESS_GATEWAYS
-    }));
+    // add recursive gateways as fallback if configured
+    const recursiveGateways = init?.recursiveGateways ?? DEFAULT_TRUSTLESS_GATEWAYS;
+    if (recursiveGateways.length > 0) {
+        helia.addRouter(fallbackRouter({
+            gateways: recursiveGateways
+        }));
+    }
     // add trustless gateway block broker
     if (!helia.hasBlockBroker('trustless-gateway')) {
-        helia.addBlockBroker(trustlessGatewayBlockBroker(init?.trustlessGatewayBlockBrokerInit));
+        helia.addBlockBroker(trustlessGatewayBlockBroker(init));
     }
     return helia;
 }

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2DG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAA;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AACvD,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAA;AAI7E,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,sGAAsG;IACtG,gCAAgC;IAEhC,sGAAsG;IACtG,sBAAsB;CACvB,CAAA;AAgCD;;GAEG;AACH,MAAM,UAAU,QAAQ,CAAoB,KAAQ,EAAE,IAAkB;IACtE,IAAI,EAAE,gBAAgB,IAAI;QACxB,4BAA4B;KAC7B,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACd,KAAK,CAAC,SAAS,CAAC,mBAAmB,CAAC;YAClC,GAAG;SACJ,CAAC,CAAC,CAAA;IACL,CAAC,CAAC,CAAA;IAEF,KAAK,CAAC,SAAS,CAAC,cAAc,CAAC;QAC7B,QAAQ,EAAE,IAAI,EAAE,iBAAiB,IAAI,0BAA0B;KAChE,CAAC,CAAC,CAAA;IAEH,qCAAqC;IACrC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,mBAAmB,CAAC,EAAE,CAAC;QAC/C,KAAK,CAAC,cAAc,CAAC,2BAA2B,CAAC,IAAI,EAAE,+BAA+B,CAAC,CAAC,CAAA;IAC1F,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2DG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAA;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AACvD,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAA;AAI7E,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,sGAAsG;IACtG,gCAAgC;IAEhC,sGAAsG;IACtG,sBAAsB;CACvB,CAAA;AA2CD;;GAEG;AACH,MAAM,UAAU,QAAQ,CAAoB,KAAQ,EAAE,IAAkB;IACtE,CAAC,IAAI,EAAE,gBAAgB,IAAI;QACzB,4BAA4B;KAC7B,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACf,KAAK,CAAC,SAAS,CAAC,mBAAmB,CAAC;YAClC,GAAG,IAAI;YACP,GAAG;SACJ,CAAC,CAAC,CAAA;IACL,CAAC,CAAC,CAAA;IAEF,mDAAmD;IACnD,MAAM,iBAAiB,GAAG,IAAI,EAAE,iBAAiB,IAAI,0BAA0B,CAAA;IAC/E,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjC,KAAK,CAAC,SAAS,CAAC,cAAc,CAAC;YAC7B,QAAQ,EAAE,iBAAiB;SAC5B,CAAC,CAAC,CAAA;IACL,CAAC;IAED,qCAAqC;IACrC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,mBAAmB,CAAC,EAAE,CAAC;QAC/C,KAAK,CAAC,cAAc,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC,CAAA;IACzD,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helia/http",
-  "version": "4.0.2",
+  "version": "4.0.3-c0c34ad1",
   "description": "A lightweight implementation of IPFS over HTTP in JavaScript",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/ipfs/helia/tree/main/packages/http#readme",
@@ -48,10 +48,10 @@
     "test:electron-main": "aegir test -t electron-main"
   },
   "dependencies": {
-    "@helia/delegated-routing-client": "^1.0.2",
-    "@helia/fallback-router": "^1.0.2",
-    "@helia/interface": "^7.0.2",
-    "@helia/trustless-gateway-client": "^1.0.2"
+    "@helia/delegated-routing-client": "1.0.3-c0c34ad1",
+    "@helia/fallback-router": "1.0.2-c0c34ad1",
+    "@helia/interface": "7.0.2-c0c34ad1",
+    "@helia/trustless-gateway-client": "1.0.2-c0c34ad1"
   },
   "devDependencies": {
     "aegir": "^48.0.11",

package/src/index.ts

@@ -73,7 +73,7 @@ export const DEFAULT_TRUSTLESS_GATEWAYS = [
   'https://4everland.io'
 ]
 
-export interface HTTPOptions {
+export interface HTTPOptions extends TrustlessGatewayBlockBrokerInit {
   /**
    * Delegated routers are servers that make routing requests on behalf of peers
    * with less capable network connectivity.
@@ -96,32 +96,48 @@ export interface HTTPOptions {
   recursiveGateways?: string[]
 
   /**
-   * Init arg passed to the trustless gateway block broker
+   * List of protocols to filter in the PeerRecords as defined in IPIP-484
+   * If undefined, PeerRecords are not filtered by protocol
    *
-   * @see https://docs.ipfs.tech/reference/http/gateway/#trusted-vs-trustless
+   * @see https://github.com/ipfs/specs/pull/484
+   * @default undefined
    */
-  trustlessGatewayBlockBrokerInit?: TrustlessGatewayBlockBrokerInit
+  filterProtocols?: string[]
+
+  /**
+   * Array of address filters to filter PeerRecords's addresses as defined in IPIP-484
+   * If undefined, PeerRecords are not filtered by address
+   *
+   * @see https://github.com/ipfs/specs/pull/484
+   * @default undefined
+   */
+  filterAddrs?: string[]
 }
 
 /**
  * Augment a Helia node with HTTP routers and block brokers
  */
 export function withHTTP <H extends Helia> (helia: H, init?: HTTPOptions): H {
-  init?.delegatedRouters ?? [
+  (init?.delegatedRouters ?? [
     'https://delegated-ipfs.dev'
-  ].forEach(url => {
+  ]).forEach(url => {
     helia.addRouter(delegatedHTTPRouter({
+      ...init,
       url
     }))
   })
 
-  helia.addRouter(fallbackRouter({
-    gateways: init?.recursiveGateways ?? DEFAULT_TRUSTLESS_GATEWAYS
-  }))
+  // add recursive gateways as fallback if configured
+  const recursiveGateways = init?.recursiveGateways ?? DEFAULT_TRUSTLESS_GATEWAYS
+  if (recursiveGateways.length > 0) {
+    helia.addRouter(fallbackRouter({
+      gateways: recursiveGateways
+    }))
+  }
 
   // add trustless gateway block broker
   if (!helia.hasBlockBroker('trustless-gateway')) {
-    helia.addBlockBroker(trustlessGatewayBlockBroker(init?.trustlessGatewayBlockBrokerInit))
+    helia.addBlockBroker(trustlessGatewayBlockBroker(init))
   }
 
   return helia

package/dist/typedoc-urls.json

@@ -1,8 +0,0 @@
-{
-  "HTTPOptions": "https://ipfs.github.io/helia/interfaces/_helia_http.HTTPOptions.html",
-  ".:HTTPOptions": "https://ipfs.github.io/helia/interfaces/_helia_http.HTTPOptions.html",
-  "DEFAULT_TRUSTLESS_GATEWAYS": "https://ipfs.github.io/helia/variables/_helia_http.DEFAULT_TRUSTLESS_GATEWAYS.html",
-  ".:DEFAULT_TRUSTLESS_GATEWAYS": "https://ipfs.github.io/helia/variables/_helia_http.DEFAULT_TRUSTLESS_GATEWAYS.html",
-  "withHTTP": "https://ipfs.github.io/helia/functions/_helia_http.withHTTP.html",
-  ".:withHTTP": "https://ipfs.github.io/helia/functions/_helia_http.withHTTP.html"
-}