@helia/verified-fetch 1.5.0 → 2.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helia/verified-fetch",
-  "version": "1.5.0",
+  "version": "2.0.0",
   "description": "A fetch-like API for obtaining verified & trustless IPFS content on the web",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/ipfs/helia-verified-fetch/tree/main/packages/verified-fetch#readme",
@@ -41,6 +41,91 @@
       "sourceType": "module"
     }
   },
+  "release": {
+    "branches": [
+      "main"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "breaking": true,
+              "release": "major"
+            },
+            {
+              "revert": true,
+              "release": "patch"
+            },
+            {
+              "type": "feat",
+              "release": "minor"
+            },
+            {
+              "type": "fix",
+              "release": "patch"
+            },
+            {
+              "type": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "type": "deps",
+              "release": "patch"
+            },
+            {
+              "scope": "no-release",
+              "release": false
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "chore",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "docs",
+                "section": "Documentation"
+              },
+              {
+                "type": "deps",
+                "section": "Dependencies"
+              },
+              {
+                "type": "test",
+                "section": "Tests"
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      "@semantic-release/git"
+    ]
+  },
   "scripts": {
     "clean": "aegir clean",
     "lint": "aegir lint",
@@ -57,52 +142,52 @@
     "release": "aegir release"
   },
   "dependencies": {
-    "@helia/block-brokers": "^3.0.1",
-    "@helia/car": "^3.1.5",
-    "@helia/http": "^1.0.8",
-    "@helia/interface": "^4.3.0",
-    "@helia/ipns": "^7.2.2",
-    "@helia/routers": "^1.1.0",
-    "@ipld/dag-cbor": "^9.2.0",
-    "@ipld/dag-json": "^10.2.0",
-    "@ipld/dag-pb": "^4.1.0",
-    "@libp2p/interface": "^1.4.0",
-    "@libp2p/kad-dht": "^12.0.17",
-    "@libp2p/peer-id": "^4.1.2",
+    "@helia/block-brokers": "^4.0.0",
+    "@helia/car": "^4.0.0",
+    "@helia/http": "^2.0.0",
+    "@helia/interface": "^5.0.0",
+    "@helia/ipns": "^8.0.0",
+    "@helia/routers": "^2.0.0",
+    "@helia/unixfs": "^4.0.0",
+    "@ipld/dag-cbor": "^9.2.1",
+    "@ipld/dag-json": "^10.2.2",
+    "@ipld/dag-pb": "^4.1.2",
+    "@libp2p/interface": "^2.1.3",
+    "@libp2p/kad-dht": "^14.0.1",
+    "@libp2p/peer-id": "^5.0.5",
     "@multiformats/dns": "^1.0.6",
-    "cborg": "^4.2.0",
+    "cborg": "^4.2.4",
     "hashlru": "^2.3.0",
-    "interface-blockstore": "^5.2.10",
-    "interface-datastore": "^8.2.11",
-    "ipfs-unixfs-exporter": "^13.5.0",
-    "it-map": "^3.1.0",
+    "interface-blockstore": "^5.3.1",
+    "interface-datastore": "^8.3.1",
+    "ipfs-unixfs-exporter": "^13.6.1",
+    "it-map": "^3.1.1",
     "it-pipe": "^3.0.1",
     "it-tar": "^6.0.5",
     "it-to-browser-readablestream": "^2.0.9",
     "lru-cache": "^10.2.2",
-    "multiformats": "^13.1.0",
-    "progress-events": "^1.0.0",
+    "multiformats": "^13.3.0",
+    "progress-events": "^1.0.1",
     "uint8arrays": "^5.1.0"
   },
   "devDependencies": {
-    "@helia/dag-cbor": "^3.0.4",
-    "@helia/dag-json": "^3.0.4",
-    "@helia/json": "^3.0.4",
-    "@helia/unixfs": "^3.0.6",
-    "@helia/utils": "^0.3.1",
-    "@ipld/car": "^5.3.0",
-    "@libp2p/interface-compliance-tests": "^5.4.5",
-    "@libp2p/logger": "^4.0.13",
-    "@libp2p/peer-id-factory": "^4.1.2",
+    "@helia/dag-cbor": "^4.0.0",
+    "@helia/dag-json": "^4.0.0",
+    "@helia/json": "^4.0.0",
+    "@helia/utils": "^1.0.0",
+    "@ipld/car": "^5.3.2",
+    "@libp2p/crypto": "^5.0.5",
+    "@libp2p/interface-compliance-tests": "^6.1.6",
+    "@libp2p/logger": "^5.1.1",
     "@sgtpooki/file-type": "^1.0.1",
     "@types/sinon": "^17.0.3",
-    "aegir": "^42.2.11",
-    "blockstore-core": "^4.4.1",
+    "aegir": "^44.1.4",
+    "blockstore-core": "^5.0.2",
     "browser-readablestream-to-it": "^2.0.7",
-    "datastore-core": "^9.2.9",
-    "helia": "^4.2.2",
-    "ipfs-unixfs-importer": "^15.2.5",
-    "ipns": "^9.1.0",
+    "datastore-core": "^10.0.2",
+    "helia": "^5.0.0",
+    "ipfs-unixfs-importer": "^15.3.1",
+    "ipns": "^10.0.0",
     "it-all": "^3.0.6",
     "it-drain": "^3.0.7",
     "it-last": "^3.0.6",

package/src/errors.ts

@@ -0,0 +1,26 @@
+export class InvalidRangeError extends Error {
+  static name = 'InvalidRangeError'
+
+  constructor (message = 'Invalid range request') {
+    super(message)
+    this.name = 'InvalidRangeError'
+  }
+}
+
+export class NoContentError extends Error {
+  static name = 'NoContentError'
+
+  constructor (message = 'No content found') {
+    super(message)
+    this.name = 'NoContentError'
+  }
+}
+
+export class SubdomainNotSupportedError extends Error {
+  static name = 'SubdomainNotSupportedError'
+
+  constructor (message = 'Subdomain not supported') {
+    super(message)
+    this.name = 'SubdomainNotSupportedError'
+  }
+}

package/src/index.ts

@@ -493,7 +493,7 @@
  *
  * This library supports the following methods of fetching web3 content from IPFS:
  *
- * 1. IPFS protocol: `ipfs://<cidv0>` & `ipfs://<cidv0>`
+ * 1. IPFS protocol: `ipfs://<cidv0>` & `ipfs://<cidv1>`
  * 2. IPNS protocol: `ipns://<peerId>` & `ipns://<publicKey>` & `ipns://<hostUri_Supporting_DnsLink_TxtRecords>`
  * 3. CID instances: An actual CID instance `CID.parse('bafy...')`
  *

package/src/utils/byte-range-context.ts

@@ -1,3 +1,4 @@
+import { InvalidRangeError } from '../errors.js'
 import { calculateByteRangeIndexes, getHeader } from './request-headers.js'
 import { getContentRangeHeader } from './response-headers.js'
 import type { SupportedBodyTypes } from '../types.js'
@@ -32,7 +33,7 @@ function getByteRangeFromHeader (rangeHeader: string): { start: string, end: str
    */
   const match = rangeHeader.match(/^bytes=(?<start>\d+)?-(?<end>\d+)?$/)
   if (match?.groups == null) {
-    throw new Error('Invalid range request')
+    throw new InvalidRangeError('Invalid range request')
   }
 
   const { start, end } = match.groups
@@ -289,7 +290,7 @@ export class ByteRangeContext {
   public get contentRangeHeaderValue (): string {
     if (!this.isValidRangeRequest) {
       this.log.error('cannot get contentRangeHeaderValue for invalid range request')
-      throw new Error('Invalid range request')
+      throw new InvalidRangeError('Invalid range request')
     }
 
     return getContentRangeHeader({

package/src/utils/get-stream-from-async-iterable.ts

@@ -1,5 +1,6 @@
 import { AbortError, type ComponentLogger } from '@libp2p/interface'
 import { CustomProgressEvent } from 'progress-events'
+import { NoContentError } from '../errors.js'
 import type { VerifiedFetchInit } from '../index.js'
 
 /**
@@ -12,7 +13,7 @@ export async function getStreamFromAsyncIterable (iterator: AsyncIterable<Uint8A
 
   if (done === true) {
     log.error('no content found for path', path)
-    throw new Error('No content found')
+    throw new NoContentError()
   }
 
   const stream = new ReadableStream({

package/src/utils/get-tar-stream.ts

@@ -1,4 +1,4 @@
-import { CodeError } from '@libp2p/interface'
+import { NotUnixFSError } from '@helia/unixfs/errors'
 import { exporter, recursive, type UnixFSEntry } from 'ipfs-unixfs-exporter'
 import map from 'it-map'
 import { pipe } from 'it-pipe'
@@ -28,7 +28,7 @@ function toHeader (file: UnixFSEntry): Partial<TarEntryHeader> & { name: string
 
 function toTarImportCandidate (entry: UnixFSEntry): TarImportCandidate {
   if (!EXPORTABLE.includes(entry.type)) {
-    throw new CodeError('Not a UnixFS node', 'ERR_NOT_UNIXFS')
+    throw new NotUnixFSError(`${entry.type} is not a UnixFS node`)
   }
 
   const candidate: TarImportCandidate = {
@@ -64,5 +64,5 @@ export async function * tarStream (ipfsPath: string, blockstore: Blockstore, opt
     return
   }
 
-  throw new CodeError('Not a UnixFS node', 'ERR_NOT_UNIXFS')
+  throw new NotUnixFSError('Not a UnixFS node')
 }

package/src/utils/handle-redirects.ts

@@ -1,4 +1,5 @@
 import { type AbortOptions, type ComponentLogger } from '@libp2p/interface'
+import { SubdomainNotSupportedError } from '../errors.js'
 import { type VerifiedFetchInit, type Resource } from '../index.js'
 import { matchURLString } from './parse-url-string.js'
 import { movedPermanentlyResponse } from './responses.js'
@@ -82,7 +83,7 @@ export async function getRedirectResponse ({ resource, options, logger, cid, fet
         return movedPermanentlyResponse(resource.toString(), subdomainUrl.href)
       } else {
         log('subdomain not supported, subdomain failed with status %s %s', subdomainTest.status, subdomainTest.statusText)
-        throw new Error('subdomain not supported')
+        throw new SubdomainNotSupportedError('subdomain not supported')
       }
     } catch (err: any) {
       log('subdomain not supported', err)

package/src/utils/parse-url-string.ts

@@ -3,7 +3,7 @@ import { CID } from 'multiformats/cid'
 import { TLRU } from './tlru.js'
 import type { RequestFormatShorthand } from '../types.js'
 import type { DNSLinkResolveResult, IPNS, IPNSResolveResult, IPNSRoutingEvents, ResolveDNSLinkProgressEvents, ResolveProgressEvents, ResolveResult } from '@helia/ipns'
-import type { AbortOptions, ComponentLogger } from '@libp2p/interface'
+import type { AbortOptions, ComponentLogger, PeerId } from '@libp2p/interface'
 import type { ProgressOptions } from 'progress-events'
 
 const ipnsCache = new TLRU<DNSLinkResolveResult | IPNSResolveResult>(1000)
@@ -174,11 +174,14 @@ export async function parseUrlString ({ urlString, ipns, logger }: ParseUrlStrin
       log.trace('resolved %s to %c from cache', cidOrPeerIdOrDnsLink, cid)
     } else {
       log.trace('Attempting to resolve PeerId for %s', cidOrPeerIdOrDnsLink)
-      let peerId = null
+      let peerId: PeerId | undefined
       try {
         // try resolving as an IPNS name
         peerId = peerIdFromString(cidOrPeerIdOrDnsLink)
-        resolveResult = await ipns.resolve(peerId, options)
+        if (peerId.publicKey == null) {
+          throw new TypeError('cidOrPeerIdOrDnsLink contains no public key')
+        }
+        resolveResult = await ipns.resolve(peerId.publicKey, options)
         cid = resolveResult?.cid
         resolvedPath = resolveResult?.path
         log.trace('resolved %s to %c', cidOrPeerIdOrDnsLink, cid)

package/src/utils/request-headers.ts

@@ -1,3 +1,5 @@
+import { InvalidRangeError } from '../errors.js'
+
 export function getHeader (headers: HeadersInit | undefined, header: string): string | undefined {
   if (headers == null) {
     return undefined
@@ -26,16 +28,16 @@ export function getHeader (headers: HeadersInit | undefined, header: string): st
 // eslint-disable-next-line complexity
 export function calculateByteRangeIndexes (start: number | undefined, end: number | undefined, fileSize?: number): { byteSize?: number, start?: number, end?: number } {
   if ((start ?? 0) > (end ?? Infinity)) {
-    throw new Error('Invalid range: Range-start index is greater than range-end index.')
+    throw new InvalidRangeError('Invalid range: Range-start index is greater than range-end index.')
   }
   if (start != null && (end ?? 0) >= (fileSize ?? Infinity)) {
-    throw new Error('Invalid range: Range-end index is greater than or equal to the size of the file.')
+    throw new InvalidRangeError('Invalid range: Range-end index is greater than or equal to the size of the file.')
   }
   if (start == null && (end ?? 0) > (fileSize ?? Infinity)) {
-    throw new Error('Invalid range: Range-end index is greater than the size of the file.')
+    throw new InvalidRangeError('Invalid range: Range-end index is greater than the size of the file.')
   }
   if (start != null && start < 0) {
-    throw new Error('Invalid range: Range-start index cannot be negative.')
+    throw new InvalidRangeError('Invalid range: Range-start index cannot be negative.')
   }
 
   if (start != null && end != null) {

package/src/utils/response-headers.ts

@@ -1,3 +1,4 @@
+import { InvalidRangeError } from '../errors.js'
 import type { CID } from 'multiformats/cid'
 
 interface CacheControlHeaderOptions {
@@ -46,10 +47,10 @@ export function getContentRangeHeader ({ byteStart, byteEnd, byteSize }: { byteS
   const total = byteSize ?? '*' // if we don't know the total size, we should use *
 
   if ((byteEnd ?? 0) >= (byteSize ?? Infinity)) {
-    throw new Error('Invalid range: Range-end index is greater than or equal to the size of the file.')
+    throw new InvalidRangeError('Invalid range: Range-end index is greater than or equal to the size of the file.')
   }
   if ((byteStart ?? 0) >= (byteSize ?? Infinity)) {
-    throw new Error('Invalid range: Range-start index is greater than or equal to the size of the file.')
+    throw new InvalidRangeError('Invalid range: Range-start index is greater than or equal to the size of the file.')
   }
 
   if (byteStart != null && byteEnd == null) {

package/src/utils/select-output-type.ts

@@ -133,7 +133,7 @@ function parseQFactor (str?: string): number {
     str = str.trim()
   }
 
-  if (str == null || !str.startsWith('q=')) {
+  if (str?.startsWith('q=') !== true) {
     return 1
   }
 

package/src/utils/walk-path.ts

@@ -1,4 +1,5 @@
-import { CodeError, type Logger } from '@libp2p/interface'
+import { DoesNotExistError } from '@helia/unixfs/errors'
+import { type Logger } from '@libp2p/interface'
 import { type Blockstore } from 'interface-blockstore'
 import { walkPath as exporterWalk, type ExporterOptions, type ReadableStorage, type ObjectNode, type UnixFSEntry } from 'ipfs-unixfs-exporter'
 import { type FetchHandlerFunctionArg } from '../types.js'
@@ -28,7 +29,7 @@ export async function walkPath (blockstore: ReadableStorage, path: string, optio
   }
 
   if (terminalElement == null) {
-    throw new CodeError('No terminal element found', 'ERR_NO_TERMINAL_ELEMENT')
+    throw new DoesNotExistError('No terminal element found')
   }
 
   return {

package/src/verified-fetch.ts

@@ -32,7 +32,7 @@ import { setCacheControlHeader, setIpfsRoots } from './utils/response-headers.js
 import { badRequestResponse, movedPermanentlyResponse, notAcceptableResponse, notSupportedResponse, okResponse, badRangeResponse, okRangeResponse, badGatewayResponse, notFoundResponse } from './utils/responses.js'
 import { selectOutputType } from './utils/select-output-type.js'
 import { handlePathWalking, isObjectNode } from './utils/walk-path.js'
-import type { CIDDetail, ContentTypeParser, CreateVerifiedFetchOptions, Resource, VerifiedFetchInit as VerifiedFetchOptions } from './index.js'
+import type { CIDDetail, ContentTypeParser, CreateVerifiedFetchOptions, Resource, ResourceDetail, VerifiedFetchInit as VerifiedFetchOptions } from './index.js'
 import type { FetchHandlerFunctionArg, RequestFormatShorthand } from './types.js'
 import type { Helia, SessionBlockstore } from '@helia/interface'
 import type { Blockstore } from 'interface-blockstore'
@@ -167,7 +167,7 @@ export class VerifiedFetch {
     // just read it out..
     const routingKey = uint8ArrayConcat([
       uint8ArrayFromString('/ipns/'),
-      peerId.toBytes()
+      peerId.toMultihash().bytes
     ])
     const datastoreKey = new Key('/dht/record/' + uint8ArrayToString(routingKey, 'base32'), false)
     const buf = await this.helia.datastore.get(datastoreKey, options)
@@ -185,7 +185,7 @@ export class VerifiedFetch {
    */
   private async handleCar ({ resource, cid, session, options }: FetchHandlerFunctionArg): Promise<Response> {
     const blockstore = this.getBlockstore(cid, resource, session, options)
-    const c = car({ blockstore, dagWalkers: this.helia.dagWalkers })
+    const c = car({ blockstore, getCodec: this.helia.getCodec })
     const stream = toBrowserReadableStream(c.stream(cid, options))
 
     const response = okResponse(resource, stream)
@@ -481,8 +481,7 @@ export class VerifiedFetch {
 
     const options = convertOptions(opts)
 
-    options?.onProgress?.(new CustomProgressEvent<CIDDetail>('verified-fetch:request:start', { resource }))
-
+    options?.onProgress?.(new CustomProgressEvent<ResourceDetail>('verified-fetch:request:start', { resource }))
     // resolve the CID/path from the requested resource
     let cid: ParsedUrlStringResults['cid']
     let path: ParsedUrlStringResults['path']