npm - @helia/verified-fetch - Versions diffs - 2.3.1 → 2.5.0 - Mend

@helia/verified-fetch 2.3.1 → 2.5.0

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 (119) hide show

package/README.md +200 -0
package/dist/index.min.js +357 -35
package/dist/src/index.d.ts +220 -0
package/dist/src/index.d.ts.map +1 -1
package/dist/src/index.js +200 -0
package/dist/src/index.js.map +1 -1
package/dist/src/plugins/errors.d.ts +25 -0
package/dist/src/plugins/errors.d.ts.map +1 -0
package/dist/src/plugins/errors.js +33 -0
package/dist/src/plugins/errors.js.map +1 -0
package/dist/src/plugins/index.d.ts +8 -0
package/dist/src/plugins/index.d.ts.map +1 -0
package/dist/src/plugins/index.js +7 -0
package/dist/src/plugins/index.js.map +1 -0
package/dist/src/plugins/plugin-base.d.ts +19 -0
package/dist/src/plugins/plugin-base.d.ts.map +1 -0
package/dist/src/plugins/plugin-base.js +26 -0
package/dist/src/plugins/plugin-base.js.map +1 -0
package/dist/src/plugins/plugin-handle-car.d.ts +11 -0
package/dist/src/plugins/plugin-handle-car.d.ts.map +1 -0
package/dist/src/plugins/plugin-handle-car.js +28 -0
package/dist/src/plugins/plugin-handle-car.js.map +1 -0
package/dist/src/plugins/plugin-handle-dag-cbor.d.ts +11 -0
package/dist/src/plugins/plugin-handle-dag-cbor.d.ts.map +1 -0
package/dist/src/plugins/plugin-handle-dag-cbor.js +73 -0
package/dist/src/plugins/plugin-handle-dag-cbor.js.map +1 -0
package/dist/src/plugins/plugin-handle-dag-pb.d.ts +15 -0
package/dist/src/plugins/plugin-handle-dag-pb.d.ts.map +1 -0
package/dist/src/plugins/plugin-handle-dag-pb.js +152 -0
package/dist/src/plugins/plugin-handle-dag-pb.js.map +1 -0
package/dist/src/plugins/plugin-handle-dag-walk.d.ts +16 -0
package/dist/src/plugins/plugin-handle-dag-walk.d.ts.map +1 -0
package/dist/src/plugins/plugin-handle-dag-walk.js +45 -0
package/dist/src/plugins/plugin-handle-dag-walk.js.map +1 -0
package/dist/src/plugins/plugin-handle-dir-index-html.d.ts +9 -0
package/dist/src/plugins/plugin-handle-dir-index-html.d.ts.map +1 -0
package/dist/src/plugins/plugin-handle-dir-index-html.js +37 -0
package/dist/src/plugins/plugin-handle-dir-index-html.js.map +1 -0
package/dist/src/plugins/plugin-handle-ipns-record.d.ts +12 -0
package/dist/src/plugins/plugin-handle-ipns-record.d.ts.map +1 -0
package/dist/src/plugins/plugin-handle-ipns-record.js +62 -0
package/dist/src/plugins/plugin-handle-ipns-record.js.map +1 -0
package/dist/src/plugins/plugin-handle-json.d.ts +11 -0
package/dist/src/plugins/plugin-handle-json.d.ts.map +1 -0
package/dist/src/plugins/plugin-handle-json.js +51 -0
package/dist/src/plugins/plugin-handle-json.js.map +1 -0
package/dist/src/plugins/plugin-handle-raw.d.ts +8 -0
package/dist/src/plugins/plugin-handle-raw.d.ts.map +1 -0
package/dist/src/plugins/plugin-handle-raw.js +80 -0
package/dist/src/plugins/plugin-handle-raw.js.map +1 -0
package/dist/src/plugins/plugin-handle-tar.d.ts +12 -0
package/dist/src/plugins/plugin-handle-tar.d.ts.map +1 -0
package/dist/src/plugins/plugin-handle-tar.js +36 -0
package/dist/src/plugins/plugin-handle-tar.js.map +1 -0
package/dist/src/plugins/plugins.d.ts +5 -0
package/dist/src/plugins/plugins.d.ts.map +1 -0
package/dist/src/plugins/plugins.js +5 -0
package/dist/src/plugins/plugins.js.map +1 -0
package/dist/src/plugins/types.d.ts +68 -0
package/dist/src/plugins/types.d.ts.map +1 -0
package/dist/src/plugins/types.js +2 -0
package/dist/src/plugins/types.js.map +1 -0
package/dist/src/types.d.ts +0 -23
package/dist/src/types.d.ts.map +1 -1
package/dist/src/types.js +1 -2
package/dist/src/types.js.map +1 -1
package/dist/src/utils/dir-index-html.d.ts +16 -0
package/dist/src/utils/dir-index-html.d.ts.map +1 -0
package/dist/src/utils/dir-index-html.js +387 -0
package/dist/src/utils/dir-index-html.js.map +1 -0
package/dist/src/utils/get-e-tag.d.ts +1 -1
package/dist/src/utils/get-e-tag.d.ts.map +1 -1
package/dist/src/utils/get-e-tag.js +18 -3
package/dist/src/utils/get-e-tag.js.map +1 -1
package/dist/src/utils/parse-resource.d.ts +2 -1
package/dist/src/utils/parse-resource.d.ts.map +1 -1
package/dist/src/utils/parse-resource.js +4 -3
package/dist/src/utils/parse-resource.js.map +1 -1
package/dist/src/utils/parse-url-string.d.ts +8 -3
package/dist/src/utils/parse-url-string.d.ts.map +1 -1
package/dist/src/utils/parse-url-string.js +30 -4
package/dist/src/utils/parse-url-string.js.map +1 -1
package/dist/src/utils/server-timing.d.ts +13 -0
package/dist/src/utils/server-timing.d.ts.map +1 -0
package/dist/src/utils/server-timing.js +19 -0
package/dist/src/utils/server-timing.js.map +1 -0
package/dist/src/utils/walk-path.d.ts +3 -2
package/dist/src/utils/walk-path.d.ts.map +1 -1
package/dist/src/utils/walk-path.js +1 -1
package/dist/src/utils/walk-path.js.map +1 -1
package/dist/src/verified-fetch.d.ts +11 -20
package/dist/src/verified-fetch.d.ts.map +1 -1
package/dist/src/verified-fetch.js +174 -367
package/dist/src/verified-fetch.js.map +1 -1
package/dist/typedoc-urls.json +32 -24
package/package.json +6 -2
package/src/index.ts +223 -0
package/src/plugins/errors.ts +37 -0
package/src/plugins/index.ts +8 -0
package/src/plugins/plugin-base.ts +30 -0
package/src/plugins/plugin-handle-car.ts +32 -0
package/src/plugins/plugin-handle-dag-cbor.ts +84 -0
package/src/plugins/plugin-handle-dag-pb.ts +168 -0
package/src/plugins/plugin-handle-dag-walk.ts +53 -0
package/src/plugins/plugin-handle-dir-index-html.ts +44 -0
package/src/plugins/plugin-handle-ipns-record.ts +69 -0
package/src/plugins/plugin-handle-json.ts +57 -0
package/src/plugins/plugin-handle-raw.ts +92 -0
package/src/plugins/plugin-handle-tar.ts +44 -0
package/src/plugins/plugins.ts +4 -0
package/src/plugins/types.ts +73 -0
package/src/types.ts +0 -29
package/src/utils/dir-index-html.ts +445 -0
package/src/utils/get-e-tag.ts +20 -3
package/src/utils/parse-resource.ts +5 -4
package/src/utils/parse-url-string.ts +38 -7
package/src/utils/server-timing.ts +37 -0
package/src/utils/walk-path.ts +3 -3
package/src/verified-fetch.ts +198 -403

package/src/utils/dir-index-html.ts ADDED Viewed

@@ -0,0 +1,445 @@
+import type { Logger } from '@libp2p/interface'
+import type { UnixFSEntry } from 'ipfs-unixfs-exporter'
+/**
+ * Types taken from:
+ *
+ * * https://github.com/ipfs/boxo/blob/09b0013e1c3e09468009b02dfc9b2b9041199d5d/gateway/assets/assets.go#L92C1-L96C2
+ * * https://github.com/ipfs/boxo/blob/09b0013e1c3e09468009b02dfc9b2b9041199d5d/gateway/assets/assets.go#L114C1-L135C2
+ */
+interface GlobalData {
+  // Menu       []MenuItem
+  gatewayURL: string
+  dnsLink: boolean
+  // root: UnixFSEntry
+}
+interface DirectoryTemplateData {
+  globalData: GlobalData
+  listing: DirectoryItem[]
+  size: string
+  path: string
+  breadcrumbs: Breadcrumb[]
+  backLink: string
+  hash: string
+  name: string
+}
+interface DirectoryItem {
+  size: string
+  name: string
+  path: string
+  hash: string
+  shortHash: string
+}
+interface Breadcrumb {
+  name: string
+  path: string
+}
+export interface DirIndexHtmlOptions {
+  gatewayURL: string
+  dnsLink?: boolean
+  log: Logger
+}
+// see https://github.com/ipfs/boxo/blob/09b0013e1c3e09468009b02dfc9b2b9041199d5d/gateway/assets/templates.go#L19C1-L25C2
+function iconFromExt (name: string): string {
+  // not implemented yet
+  // TODO: optimize icons: https://github.com/ipfs-shipyard/ipfs-css/issues/71
+  return 'ipfs-_blank'
+}
+function itemShortHashCell (item: DirectoryItem, dirData: DirectoryTemplateData): string {
+  const href = dirData.globalData.dnsLink ? `https://inbrowser.dev/ipfs/${item.hash}` : `${dirData.globalData.gatewayURL}/ipfs/${item.hash}?filename=${item.name}`
+  return `<a class="ipfs-hash" translate="no" href="${href}">${item.shortHash}</a>`
+}
+function dirListingTitle (dirData: DirectoryTemplateData): string {
+  if (dirData.path != null) {
+    const href = `${dirData.globalData.gatewayURL}/${dirData.path}`
+    return `Index of <a href="${href}">${dirData.name}</a>`
+  }
+  return `Index of ${dirData.name} ${dirData.path}`
+}
+function getAllDirListingRows (dirData: DirectoryTemplateData): string {
+  return dirData.listing.map((item) => `<div class="type-icon">
+      <div class="${iconFromExt(item.name)}">&nbsp;</div>
+    </div>
+    <div>
+      <a href="${item.path}">${item.name}</a>
+    </div>
+    <div class="nowrap">
+      ${itemShortHashCell(item, dirData)}
+    </div>
+    <div class="nowrap" title="Cumulative size of IPFS DAG (data + metadata)">${item.size}</div>`).join(' ')
+}
+function getItemPath (item: UnixFSEntry): string {
+  const itemPathParts = item.path.split('/')
+  return itemPathParts.pop() ?? item.path
+}
+/**
+ * todo: https://github.com/ipfs/boxo/blob/09b0013e1c3e09468009b02dfc9b2b9041199d5d/gateway/handler_unixfs_dir.go#L200-L208
+ *
+ * @see https://github.com/ipfs/boxo/blob/09b0013e1c3e09468009b02dfc9b2b9041199d5d/gateway/assets/directory.html
+ * @see https://github.com/ipfs/boxo/pull/298
+ * @see https://github.com/ipfs/kubo/pull/8555
+ */
+export const dirIndexHtml = (dir: UnixFSEntry, items: UnixFSEntry[], { gatewayURL, dnsLink, log }: DirIndexHtmlOptions): string => {
+  log('loading directory html for %s', dir.path)
+  const dirData: DirectoryTemplateData = {
+    globalData: {
+      gatewayURL,
+      dnsLink: dnsLink ?? false
+    },
+    listing: items.map((item) => {
+      return {
+        size: item.size.toString(),
+        name: item.name,
+        path: getItemPath(item),
+        hash: item.cid.toString(),
+        shortHash: item.cid.toString().slice(0, 8)
+      } satisfies DirectoryItem
+    }),
+    name: dir.name,
+    size: dir.size.toString(),
+    path: dir.path,
+    breadcrumbs: [],
+    backLink: '',
+    hash: dir.cid.toString()
+  }
+  return `
+<!DOCTYPE html>
+<!--{{ $root := . }}-->
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+  <meta name="description" content="A directory of content-addressed files hosted on IPFS.">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlo89/56ZQ/8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACUjDu1lo89/6mhTP+zrVP/nplD/5+aRK8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHNiIS6Wjz3/ubFY/761W/+vp1D/urRZ/8vDZf/GvmH/nplD/1BNIm8AAAAAAAAAAAAAAAAAAAAAAAAAAJaPPf+knEj/vrVb/761W/++tVv/r6dQ/7q0Wf/Lw2X/y8Nl/8vDZf+tpk7/nplD/wAAAAAAAAAAAAAAAJaPPf+2rVX/vrVb/761W/++tVv/vrVb/6+nUP+6tFn/y8Nl/8vDZf/Lw2X/y8Nl/8G6Xv+emUP/AAAAAAAAAACWjz3/vrVb/761W/++tVv/vrVb/761W/+vp1D/urRZ/8vDZf/Lw2X/y8Nl/8vDZf/Lw2X/nplD/wAAAAAAAAAAlo89/761W/++tVv/vrVb/761W/++tVv/r6dQ/7q0Wf/Lw2X/y8Nl/8vDZf/Lw2X/y8Nl/56ZQ/8AAAAAAAAAAJaPPf++tVv/vrVb/761W/++tVv/vbRa/5aPPf+emUP/y8Nl/8vDZf/Lw2X/y8Nl/8vDZf+emUP/AAAAAAAAAACWjz3/vrVb/761W/++tVv/vrVb/5qTQP+inkb/op5G/6KdRv/Lw2X/y8Nl/8vDZf/Lw2X/nplD/wAAAAAAAAAAlo89/761W/++tVv/sqlS/56ZQ//LxWb/0Mlp/9DJaf/Kw2X/oJtE/7+3XP/Lw2X/y8Nl/56ZQ/8AAAAAAAAAAJaPPf+9tFr/mJE+/7GsUv/Rymr/0cpq/9HKav/Rymr/0cpq/9HKav+xrFL/nplD/8vDZf+emUP/AAAAAAAAAACWjz3/op5G/9HKav/Rymr/0cpq/9HKav/Rymr/0cpq/9HKav/Rymr/0cpq/9HKav+inkb/nplD/wAAAAAAAAAAAAAAAKKeRv+3slb/0cpq/9HKav/Rymr/0cpq/9HKav/Rymr/0cpq/9HKav+1sFX/op5G/wAAAAAAAAAAAAAAAAAAAAAAAAAAop5GUKKeRv/Nxmf/0cpq/9HKav/Rymr/0cpq/83GZ/+inkb/op5GSAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAop5G16KeRv/LxWb/y8Vm/6KeRv+inkaPAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAop5G/6KeRtcAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA/n8AAPgfAADwDwAAwAMAAIABAACAAQAAgAEAAIABAACAAQAAgAEAAIABAACAAQAAwAMAAPAPAAD4HwAA/n8AAA==" />
+  <title>${dirData.path}</title>
+  <style>${style}</style>
+</head>
+<body>
+  <!--
+  # Some JSON content for debugging:
+  ## dirData
+  ${JSON.stringify(dirData, null, 2)}
+  -->
+  <header id="header">
+    <div class="ipfs-logo">&nbsp;</div>
+    <!--
+    <nav>
+      <a href="https://ipfs.tech" target="_blank" rel="noopener noreferrer">About<span class="dn-mobile"> IPFS</span></a>
+      <a href="https://docs.ipfs.tech/install/" target="_blank" rel="noopener noreferrer">Install<span class="dn-mobile"> IPFS</span></a>
+    </nav>
+    -->
+  </header>
+  <main id="main">
+    <header class="flex flex-wrap">
+      <div>
+        <strong>${dirListingTitle(dirData)}</strong>
+        ${dirData.hash == null
+          ? ''
+          : `<div class="ipfs-hash" translate="no">
+              ${dirData.hash}
+            </div>`
+        }
+      </div>
+      ${dirData.size == null
+        ? ''
+        : `<div class="nowrap flex-shrink ml-auto">
+            <strong title="Cumulative size of IPFS DAG (data + metadata)">&nbsp;${dirData.size}</strong>
+          </div>`
+      }
+    </header>
+    <section>
+      <div class="grid dir">
+        <!--{{ if .BackLink }}
+          <div class="type-icon">
+            <div class="ipfs-_blank">&nbsp;</div>
+          </div>
+          <div>
+            <a href="{{.BackLink | urlEscape}}">..</a>
+          </div>
+          <div></div>
+          <div></div>
+        </tr>
+        {{ end }}-->
+        ${getAllDirListingRows(dirData)}
+      </div>
+    </section>
+  </main>
+</body>
+</html>
+`
+}
+const style = `
+    .ipfs-_blank {
+        background-image: url("data:image/svg+xml,%0A%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 72 100'%3E%3ClinearGradient id='a' gradientUnits='userSpaceOnUse' x1='36' y1='1' x2='36' y2='99' gradientTransform='matrix(1 0 0 -1 0 100)'%3E%3Cstop offset='0' stop-color='%23c8d4db'/%3E%3Cstop offset='.139' stop-color='%23d8e1e6'/%3E%3Cstop offset='.359' stop-color='%23ebf0f3'/%3E%3Cstop offset='.617' stop-color='%23f9fafb'/%3E%3Cstop offset='1' stop-color='%23fff'/%3E%3C/linearGradient%3E%3Cpath d='M45 1l27 26.7V99H0V1h45z' fill='url(%23a)'/%3E%3Cpath d='M45 1l27 26.7V99H0V1h45z' fill-opacity='0' stroke='%237191a1' stroke-width='2'/%3E%3ClinearGradient id='b' gradientUnits='userSpaceOnUse' x1='45.068' y1='72.204' x2='58.568' y2='85.705' gradientTransform='matrix(1 0 0 -1 0 100)'%3E%3Cstop offset='0' stop-color='%23fff'/%3E%3Cstop offset='.35' stop-color='%23fafbfb'/%3E%3Cstop offset='.532' stop-color='%23edf1f4'/%3E%3Cstop offset='.675' stop-color='%23dde5e9'/%3E%3Cstop offset='.799' stop-color='%23c7d3da'/%3E%3Cstop offset='.908' stop-color='%23adbdc7'/%3E%3Cstop offset='1' stop-color='%2392a5b0'/%3E%3C/linearGradient%3E%3Cpath d='M45 1l27 26.7H45V1z' fill='url(%23b)'/%3E%3Cpath d='M45 1l27 26.7H45V1z' fill-opacity='0' stroke='%237191a1' stroke-width='2' stroke-linejoin='bevel'/%3E%3C/svg%3E");
+        background-repeat: no-repeat;
+        background-size: contain
+    }
+    :root {
+        --sans-serif: "Plex",system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif;
+        --monospace: Consolas, monaco, monospace;
+        --navy: #073a53;
+        --teal: #6bc4ce;
+        --turquoise: #47AFB4;
+        --steel-gray: #3f5667;
+        --dark-white: #d9dbe2;
+        --light-white: #edf0f4;
+        --near-white: #f7f8fa;
+        --radius: 4px;
+    }
+    body {
+        color: #34373f;
+        font-family: var(--sans-serif);
+        line-height: 1.43;
+        margin: 0;
+        word-break: break-all;
+        -webkit-text-size-adjust: 100%;
+        -ms-text-size-adjust: 100%;
+        -webkit-tap-highlight-color: transparent;
+    }
+    pre, code {
+        font-family: var(--monospace);
+    }
+    a {
+        color: #117eb3;
+        text-decoration: none;
+    }
+    a:hover {
+        color: #00b0e9;
+        text-decoration: underline;
+    }
+    a:active,a:visited {
+        color: #00b0e9;
+    }
+    .flex {
+        display: flex;
+    }
+    .flex-wrap {
+        flex-flow: wrap;
+    }
+    .flex-shrink {
+        flex-shrink: 1;
+    }
+    .ml-auto {
+        margin-left: auto;
+    }
+    .nowrap {
+        white-space: nowrap
+    }
+    .ipfs-hash {
+        color: #7f8491;
+        font-family: var(--monospace);
+    }
+    #header {
+        align-items: center;
+        background: var(--navy);
+        border-bottom: 4px solid var(--teal);
+        color: #fff;
+        display: flex;
+        font-weight: 500;
+        justify-content: space-between;
+        padding: 0 1em;
+    }
+    #header a {
+        color: var(--teal);
+    }
+    #header a:active {
+        color: #9ad4db;
+    }
+    #header a:hover {
+        color: #fff;
+    }
+    #header .ipfs-logo {
+        height: 2.25em;
+        margin: .7em .7em .7em 0;
+        width: 7.15em
+    }
+    #header nav {
+        align-items: center;
+        display: flex;
+        margin: .65em 0;
+    }
+    #header nav a {
+        margin: 0 .6em;
+    }
+    #header nav a:last-child {
+        margin: 0 0 0 .6em;
+    }
+    #header nav svg {
+        fill: var(--teal);
+        height: 1.8em;
+        margin-top: .125em;
+    }
+    #header nav svg:hover {
+        fill: #fff;
+    }
+    main {
+        border: 1px solid var(--dark-white);
+        border-radius: var(--radius);
+        overflow: hidden;
+        margin: 1em;
+        font-size: .875em;
+    }
+    main header,main .container {
+        padding-left: 1em;
+        padding-right: 1em;
+    }
+    main header {
+        padding-top: .7em;
+        padding-bottom: .7em;
+        background-color: var(--light-white);
+    }
+    main header,main section:not(:last-child) {
+        border-bottom: 1px solid var(--dark-white);
+    }
+    main section header {
+        background-color: var(--near-white);
+    }
+    .grid {
+        display: grid;
+        overflow-x: auto;
+    }
+    .grid .grid {
+        overflow-x: visible;
+    }
+    .grid > div {
+        padding: .7em;
+        border-bottom: 1px solid var(--dark-white);
+    }
+    .grid.dir {
+        grid-template-columns: min-content 1fr min-content min-content;
+    }
+    .grid.dir > div:nth-of-type(4n+1) {
+        padding-left: 1em;
+    }
+    .grid.dir > div:nth-of-type(4n+4) {
+        padding-right: 1em;
+    }
+    .grid.dir > div:nth-last-child(-n+4) {
+        border-bottom: 0;
+    }
+    .grid.dir > div:nth-of-type(8n+5),.grid.dir > div:nth-of-type(8n+6),.grid.dir > div:nth-of-type(8n+7),.grid.dir > div:nth-of-type(8n+8) {
+        background-color: var(--near-white);
+    }
+    .grid.dag {
+        grid-template-columns: max-content 1fr;
+    }
+    .grid.dag pre {
+        margin: 0;
+    }
+    .grid.dag .grid {
+        padding: 0;
+    }
+    .grid.dag > div:nth-last-child(-n+2) {
+        border-bottom: 0;
+    }
+    .grid.dag > div {
+        background: white
+    }
+    .grid.dag > div:nth-child(4n),.grid.dag > div:nth-child(4n+3) {
+        background-color: var(--near-white);
+    }
+    section > .grid.dag > div:nth-of-type(2n+1) {
+        padding-left: 1em;
+    }
+    .type-icon,.type-icon > * {
+        width: 1.15em
+    }
+    .terminal {
+        background: var(--steel-gray);
+        color: white;
+        padding: .7em;
+        border-radius: var(--radius);
+        word-wrap: break-word;
+        white-space: break-spaces;
+    }
+    @media print {
+        #header {
+            display: none;
+        }
+        #main header,.ipfs-hash,body {
+            color: #000;
+        }
+        #main,#main header {
+            border-color: #000;
+        }
+        a,a:visited {
+            color: #000;
+            text-decoration: underline;
+        }
+        a[href]:after {
+            content: " (" attr(href) ")"
+        }
+    }
+    @media only screen and (max-width: 500px) {
+        .dn-mobile {
+            display: none;
+        }
+    }`

package/src/utils/get-e-tag.ts CHANGED Viewed

@@ -15,19 +15,36 @@ interface GetETagArg {
    */
   weak?: boolean
 }
+const getPrefix = ({ weak, reqFormat }: Partial<GetETagArg>): string => {
+  if (reqFormat === 'tar' || reqFormat === 'car' || reqFormat === 'ipns-record' || weak === true) {
+    return 'W/'
+  }
+  return ''
+}
+const getFormatSuffix = ({ reqFormat }: Partial<GetETagArg>): string => {
+  if (reqFormat == null) {
+    return ''
+  }
+  if (reqFormat === 'tar') {
+    return '.x-tar'
+  }
+  return `.${reqFormat}`
+}
 /**
  * etag
  * you need to wrap cid  with ""
- * we use strong Etags for immutable responses and weak one (prefixed with W/ ) for mutable/generated ones (ipns and generated HTML).
+ * we use strong Etags for immutable responses and weak one (prefixed with W/ ) for mutable/generated ones (ipns, car, tar, and generated HTML).
  * block and car responses should have different etag than deserialized one, so you can add some prefix like we do in existing gateway
  *
  * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag
  * @see https://specs.ipfs.tech/http-gateways/path-gateway/#etag-response-header
  */
 export function getETag ({ cid, reqFormat, weak, rangeStart, rangeEnd }: GetETagArg): string {
-  const prefix = weak === true ? 'W/' : ''
-  let suffix = reqFormat == null ? '' : `.${reqFormat}`
+  const prefix = getPrefix({ weak, reqFormat })
+  let suffix = getFormatSuffix({ reqFormat })
   if (rangeStart != null || rangeEnd != null) {
     suffix += `.${rangeStart ?? '0'}-${rangeEnd ?? 'N'}`
   }

package/src/utils/parse-resource.ts CHANGED Viewed

@@ -11,16 +11,16 @@ export interface ParseResourceComponents {
 }
 export interface ParseResourceOptions extends ParseUrlStringOptions {
+  withServerTiming?: boolean
 }
 /**
  * Handles the different use cases for the `resource` argument.
  * The resource can represent an IPFS path, IPNS path, or CID.
  * If the resource represents an IPNS path, we need to resolve it to a CID.
  */
-export async function parseResource (resource: Resource, { ipns, logger }: ParseResourceComponents, options?: ParseResourceOptions): Promise<ParsedUrlStringResults> {
+export async function parseResource (resource: Resource, { ipns, logger }: ParseResourceComponents, { withServerTiming = false, ...options }: ParseResourceOptions = { withServerTiming: false }): Promise<ParsedUrlStringResults> {
   if (typeof resource === 'string') {
-    return parseUrlString({ urlString: resource, ipns, logger }, options)
+    return parseUrlString({ urlString: resource, ipns, logger, withServerTiming }, options)
   }
   const cid = CID.asCID(resource)
@@ -33,7 +33,8 @@ export async function parseResource (resource: Resource, { ipns, logger }: Parse
       path: '',
       query: {},
       ipfsPath: `/ipfs/${cid.toString()}`,
-      ttl: 29030400 // 1 year for ipfs content
+      ttl: 29030400, // 1 year for ipfs content
+      serverTimings: []
     } satisfies ParsedUrlStringResults
   }

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

@@ -1,5 +1,6 @@
 import { CID } from 'multiformats/cid'
 import { getPeerIdFromString } from './get-peer-id-from-string.js'
+import { serverTiming, type ServerTimingResult } from './server-timing.js'
 import { TLRU } from './tlru.js'
 import type { RequestFormatShorthand } from '../types.js'
 import type { DNSLinkResolveResult, IPNS, IPNSResolveResult, IPNSRoutingEvents, ResolveDNSLinkProgressEvents, ResolveProgressEvents, ResolveResult } from '@helia/ipns'
@@ -12,6 +13,7 @@ export interface ParseUrlStringInput {
   urlString: string
   ipns: IPNS
   logger: ComponentLogger
+  withServerTiming?: boolean
 }
 export interface ParseUrlStringOptions extends ProgressOptions<ResolveProgressEvents | IPNSRoutingEvents | ResolveDNSLinkProgressEvents>, AbortOptions {
@@ -23,7 +25,7 @@ export interface ParsedUrlQuery extends Record<string, string | unknown> {
   filename?: string
 }
-interface ParsedUrlStringResultsBase extends ResolveResult {
+export interface ParsedUrlStringResults extends ResolveResult {
   protocol: 'ipfs' | 'ipns'
   query: ParsedUrlQuery
@@ -41,9 +43,12 @@ interface ParsedUrlStringResultsBase extends ResolveResult {
    * seconds as a number
    */
   ttl?: number
-}
-export type ParsedUrlStringResults = ParsedUrlStringResultsBase
+  /**
+   * serverTiming items
+   */
+  serverTimings: Array<ServerTimingResult<any>>
+}
 const URL_REGEX = /^(?<protocol>ip[fn]s):\/\/(?<cidOrPeerIdOrDnsLink>[^/?]+)\/?(?<path>[^?]*)\??(?<queryString>.*)$/
 const PATH_REGEX = /^\/(?<protocol>ip[fn]s)\/(?<cidOrPeerIdOrDnsLink>[^/?]+)\/?(?<path>[^?]*)\??(?<queryString>.*)$/
@@ -145,7 +150,7 @@ function dnsLinkLabelDecoder (linkLabel: string): string {
  * @todo we need to break out each step of this function (cid parsing, ipns resolving, dnslink resolving) into separate functions and then remove the eslint-disable comment
  */
 // eslint-disable-next-line complexity
-export async function parseUrlString ({ urlString, ipns, logger }: ParseUrlStringInput, options?: ParseUrlStringOptions): Promise<ParsedUrlStringResults> {
+export async function parseUrlString ({ urlString, ipns, logger, withServerTiming = false }: ParseUrlStringInput, options?: ParseUrlStringOptions): Promise<ParsedUrlStringResults> {
   const log = logger.forComponent('helia:verified-fetch:parse-url-string')
   const { protocol, cidOrPeerIdOrDnsLink, path: urlPath, queryString } = matchURLString(urlString)
@@ -153,6 +158,7 @@ export async function parseUrlString ({ urlString, ipns, logger }: ParseUrlStrin
   let resolvedPath: string | undefined
   const errors: Error[] = []
   let resolveResult: IPNSResolveResult | DNSLinkResolveResult | undefined
+  const serverTimings: Array<ServerTimingResult<any>> = []
   if (protocol === 'ipfs') {
     try {
@@ -182,7 +188,19 @@ export async function parseUrlString ({ urlString, ipns, logger }: ParseUrlStrin
         if (peerId.publicKey == null) {
           throw new TypeError('cidOrPeerIdOrDnsLink contains no public key')
         }
-        resolveResult = await ipns.resolve(peerId.publicKey, options)
+        if (withServerTiming) {
+          const resolveResultWithServerTiming = await serverTiming('ipns.resolve', `Resolve IPNS name ${cidOrPeerIdOrDnsLink}`, ipns.resolve.bind(null, peerId.publicKey, options))
+          serverTimings.push(resolveResultWithServerTiming)
+          // eslint-disable-next-line max-depth
+          if (resolveResultWithServerTiming.error != null) {
+            throw resolveResultWithServerTiming.error
+          }
+          resolveResult = resolveResultWithServerTiming.result
+        } else {
+          resolveResult = await ipns.resolve(peerId.publicKey, options)
+        }
         cid = resolveResult?.cid
         resolvedPath = resolveResult?.path
         log.trace('resolved %s to %c', cidOrPeerIdOrDnsLink, cid)
@@ -207,7 +225,19 @@ export async function parseUrlString ({ urlString, ipns, logger }: ParseUrlStrin
         log.trace('Attempting to resolve DNSLink for %s', decodedDnsLinkLabel)
         try {
-          resolveResult = await ipns.resolveDNSLink(decodedDnsLinkLabel, options)
+          // eslint-disable-next-line max-depth
+          if (withServerTiming) {
+            const resolveResultWithServerTiming = await serverTiming('ipns.resolveDNSLink', `Resolve DNSLink ${decodedDnsLinkLabel}`, ipns.resolveDNSLink.bind(ipns, decodedDnsLinkLabel, options))
+            serverTimings.push(resolveResultWithServerTiming)
+            // eslint-disable-next-line max-depth
+            if (resolveResultWithServerTiming.error != null) {
+              throw resolveResultWithServerTiming.error
+            }
+            resolveResult = resolveResultWithServerTiming.result
+          } else {
+            resolveResult = await ipns.resolveDNSLink(decodedDnsLinkLabel, options)
+          }
           cid = resolveResult?.cid
           resolvedPath = resolveResult?.path
           log.trace('resolved %s to %c', decodedDnsLinkLabel, cid)
@@ -263,7 +293,8 @@ export async function parseUrlString ({ urlString, ipns, logger }: ParseUrlStrin
     path: joinPaths(resolvedPath, urlPath ?? ''),
     query,
     ttl,
-    ipfsPath: `/${protocol}/${cidOrPeerIdOrDnsLink}${urlPath != null && urlPath !== '' ? `/${urlPath}` : ''}`
+    ipfsPath: `/${protocol}/${cidOrPeerIdOrDnsLink}${urlPath != null && urlPath !== '' ? `/${urlPath}` : ''}`,
+    serverTimings
   } satisfies ParsedUrlStringResults
 }

package/src/utils/server-timing.ts ADDED Viewed

@@ -0,0 +1,37 @@
+export interface ServerTimingSuccess<T> {
+  error: null
+  result: T
+  header: string
+}
+export interface ServerTimingError {
+  result: null
+  error: Error
+  header: string
+}
+export type ServerTimingResult<T> = ServerTimingSuccess<T> | ServerTimingError
+export async function serverTiming<T> (
+  name: string,
+  description: string,
+  fn: () => Promise<T>
+): Promise<ServerTimingResult<T>> {
+  const startTime = performance.now()
+  try {
+    const result = await fn() // Execute the function
+    const endTime = performance.now()
+    const duration = (endTime - startTime).toFixed(1) // Duration in milliseconds
+    // Create the Server-Timing header string
+    const header = `${name};dur=${duration};desc="${description}"`
+    return { result, header, error: null }
+  } catch (error: any) {
+    const endTime = performance.now()
+    const duration = (endTime - startTime).toFixed(1)
+    // Still return a timing header even on error
+    const header = `${name};dur=${duration};desc="${description}"`
+    return { result: null, error, header } // Pass error with timing info
+  }
+}

package/src/utils/walk-path.ts CHANGED Viewed

@@ -2,8 +2,8 @@ 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'
 import { badGatewayResponse, notFoundResponse } from './responses.js'
+import type { PluginContext } from '../plugins/types.js'
 import type { CID } from 'multiformats/cid'
 export interface PathWalkerOptions extends ExporterOptions {
@@ -12,7 +12,6 @@ export interface PathWalkerOptions extends ExporterOptions {
 export interface PathWalkerResponse {
   ipfsRoots: CID[]
   terminalElement: UnixFSEntry
 }
 export interface PathWalkerFn {
@@ -47,8 +46,9 @@ export function isObjectNode (node: UnixFSEntry): node is ObjectNode {
  * If the signal is aborted, the function will throw an AbortError
  * If a terminal element is not found, a notFoundResponse is returned
  * If another unknown error occurs, a badGatewayResponse is returned
+ *
  */
-export async function handlePathWalking ({ cid, path, resource, options, blockstore, log }: Omit<FetchHandlerFunctionArg, 'session'> & { blockstore: Blockstore, log: Logger }): Promise<PathWalkerResponse | Response> {
+export async function handlePathWalking ({ cid, path, resource, options, blockstore, log }: PluginContext & { blockstore: Blockstore, log: Logger }): Promise<PathWalkerResponse | Response> {
   try {
     return await walkPath(blockstore, `${cid.toString()}/${path}`, options)
   } catch (err: any) {