hypercore-fetch 10.1.0 → 10.2.0

package/README.md

@@ -11,11 +11,13 @@ import * as SDK from 'hyper-sdk'
 // Create in-memory hyper-sdk instance
 const sdk = await SDK.create({storage: false})
 
+// Init
 const fetch = await makeFetch({
   sdk: true,
   writable: true
 })
 
+// Download
 const someURL = `hyper://blog.mauve.moe/`
 
 const response = await fetch(someURL)
@@ -23,6 +25,16 @@ const response = await fetch(someURL)
 const data = await response.text()
 
 console.log(data)
+
+const response = await fetch('hyper://localhost/example.txt', {
+  method: 'PUT',
+  body: 'Hello World'
+})
+
+// This is where the data got uploaded
+const location = response.headers.get('Location')
+// Clear the response body or else electron will flip out
+await response.text()
 ```
 
 ## API
@@ -104,6 +116,8 @@ In order to create a writable Hyperdrive with its own URL, you must first genera
 
 `NAME` can be any alphanumeric string which can be used for key generation in [Corestore](https://github.com/holepunchto/corestore).
 
+If you omit the `NAME`, it will use the name `default`.
+
 The response body will contain a `hyper://` URL with the new Hyperdrive.
 
 You can then use this with `PUT`/`DELETE` requests.
@@ -116,6 +130,8 @@ If you want to resolve the public key URL of a previously created Hyperdrive, yo
 
 `NAME` can be any alphanumeric string which can be used for key generation in [Corestore](https://github.com/holepunchto/corestore).
 
+If you omit the `NAME`, it will use the name `default`.
+
 The response body will contain a `hyper://` URL with the new Hyperdrive.
 
 You can then use this with `PUT`/`DELETE` requests.
@@ -130,7 +146,7 @@ flag.
 
 The `body` can be any of the options supported by the Fetch API such as a `String`, `Blob`, `FormData`, or `ReadableStream`.
 
-`NAME` can either be the 52 character [z32 encoded](https://github.com/mafintosh/z32) key for a Hyperdrive or Hypercore , or a domain to parse with the [DNSLink](https://www.dnslink.io/) standard.
+`NAME` can either be the 52 character [z32 encoded](https://github.com/mafintosh/z32) key for a Hyperdrive, `localhost` for the `default` drive, or a domain to parse with the [DNSLink](https://www.dnslink.io/) standard.
 
 The mtime metadata is automatically set to the current time when
 uploading. To override this value, pass a `Last-Modified` header with a value
@@ -149,7 +165,7 @@ The `filename` will be the filename within the directory that gets created.
 
 Note that you must use the name `file` for uploaded files.
 
-`NAME` can either be the 52 character [z32 encoded](https://github.com/mafintosh/z32) key for a Hyperdrive or Hypercore , or a domain to parse with the [DNSLink](https://www.dnslink.io/) standard.
+`NAME` can either be the 52 character [z32 encoded](https://github.com/mafintosh/z32) key for a Hyperdrive, `localhost` for the `default` drive, or a domain to parse with the [DNSLink](https://www.dnslink.io/) standard.
 
 ### `fetch('hyper://NAME/', {method: 'DELETE'})`
 
@@ -159,13 +175,13 @@ If this is a writable drive, your data will get fully clearned and trying to wri
 
 If you try to load this drive again data will be loaded from scratch.
 
-`NAME` can either be the 52 character [z32 encoded](https://github.com/mafintosh/z32) key for a Hyperdrive or Hypercore , or a domain to parse with the [DNSLink](https://www.dnslink.io/) standard.
+`NAME` can either be the 52 character [z32 encoded](https://github.com/mafintosh/z32) key for a Hyperdrive, `localhost` for the `default` drive, or a domain to parse with the [DNSLink](https://www.dnslink.io/) standard.
 
 ### `fetch('hyper://NAME/example.txt', {method: 'DELETE'})`
 
 You can delete a file or directory tree in a Hyperdrive by using the `DELETE` method.
 
-`NAME` can either be the 52 character [z32 encoded](https://github.com/mafintosh/z32) key for a Hyperdrive or Hypercore , or a domain to parse with the [DNSLink](https://www.dnslink.io/) standard.
+`NAME` can either be the 52 character [z32 encoded](https://github.com/mafintosh/z32) key for a Hyperdrive, `localhost` for the `default` drive, or a domain to parse with the [DNSLink](https://www.dnslink.io/) standard.
 
 Note that this is only available with the `writable: true` flag.
 

package/index.js

@@ -15,6 +15,7 @@ import { EventIterator } from 'event-iterator'
 /** @typedef {(url: URL) => void} OnDeleteHandler */
 
 const DEFAULT_TIMEOUT = 5000
+const DEFAULT_DRIVE = 'default'
 
 const SPECIAL_DOMAIN = 'localhost'
 const SPECIAL_FOLDER = '$'
@@ -83,6 +84,7 @@ function noop () {}
  * @param {boolean} [options.writable]
  * @param {boolean} [options.extensionMessages]
  * @param {number} [options.timeout]
+ * @param {string} [options.defaultDrive]
  * @param {typeof DEFAULT_RENDER_INDEX} [options.renderIndex]
  * @param {OnLoadHandler} [options.onLoad]
  * @param {OnDeleteHandler} [options.onDelete]
@@ -93,6 +95,7 @@ export default async function makeHyperFetch ({
   writable = false,
   extensionMessages = writable,
   timeout = DEFAULT_TIMEOUT,
+  defaultDrive = DEFAULT_DRIVE,
   renderIndex = DEFAULT_RENDER_INDEX,
   onLoad = noop,
   onDelete = noop
@@ -115,6 +118,10 @@ export default async function makeHyperFetch ({
   if (writable) {
     router.get(`hyper://${SPECIAL_DOMAIN}/`, getKey)
     router.post(`hyper://${SPECIAL_DOMAIN}/`, createKey)
+    router.put(`hyper://${SPECIAL_DOMAIN}/`, putFilesDefault)
+    router.delete('hyper://SPECIAL_DOMAIN/**', deleteFilesDefault)
+    router.get(`hyper://${SPECIAL_DOMAIN}/**`, getFilesDefault)
+    router.head(`hyper://${SPECIAL_DOMAIN}/**`, headFilesDefault)
 
     router.put(`hyper://*/${SPECIAL_FOLDER}/${VERSION_FOLDER_NAME}/**`, putFilesVersioned)
     router.put('hyper://*/**', putFiles)
@@ -345,10 +352,7 @@ export default async function makeHyperFetch ({
    * @returns
    */
   async function getKey (request) {
-    const key = new URL(request.url).searchParams.get('key')
-    if (!key) {
-      return { status: 400, body: 'Must specify key parameter to resolve' }
-    }
+    const key = new URL(request.url).searchParams.get('key') || defaultDrive
 
     try {
       const drive = await sdk.getDrive(key)
@@ -378,10 +382,7 @@ export default async function makeHyperFetch ({
     // Maybe specify a seed to use for generating the blobs?
     // Else we'd need to specify the blobs keys and metadata keys
 
-    const key = new URL(request.url).searchParams.get('key')
-    if (!key) {
-      return { status: 400, body: 'Must specify key parameter to resolve' }
-    }
+    const key = new URL(request.url).searchParams.get('key') || defaultDrive
 
     const drive = await sdk.getDrive(key)
     onLoad(new URL('/', drive.url), drive.writable, key)
@@ -389,12 +390,30 @@ export default async function makeHyperFetch ({
     return { body: drive.url }
   }
 
+  /**
+   * @param {Request} request
+   */
+  async function putFilesDefault (request) {
+    const finalURL = await resolveInDefault(request.url)
+
+    return putTo(finalURL, request)
+  }
+
   /**
    * @param {Request} request
    * @returns
    */
   async function putFiles (request) {
-    const { hostname, pathname: rawPathname } = new URL(request.url)
+    return putTo(request.url, request)
+  }
+
+  /**
+   * @param {string} url
+   * @param {Request} request
+   * @returns
+   */
+  async function putTo (url, request) {
+    const { hostname, pathname: rawPathname } = new URL(url)
     const pathname = decodeURI(ensureLeadingSlash(rawPathname))
     const contentType = request.headers.get('Content-Type') || ''
     const lastModified = request.headers.get('Last-Modified')
@@ -407,7 +426,7 @@ export default async function makeHyperFetch ({
       return { status: 403, body: `Cannot PUT file to read-only drive: ${drive.url}`, headers: { Location: request.url } }
     }
 
-    onLoad(new URL('/', request.url), drive.writable)
+    onLoad(new URL('/', url), drive.writable)
 
     if (isFormData) {
       // It's a form! Get the files out and process them
@@ -427,7 +446,7 @@ export default async function makeHyperFetch ({
       }
     } else {
       if (pathname.endsWith('/')) {
-        return { status: 405, body: 'Cannot PUT file with trailing slash', headers: { Location: request.url } }
+        return { status: 405, body: 'Cannot PUT file with trailing slash', headers: { Location: url } }
       } else {
         await pipelinePromise(
           Readable.from(request.body),
@@ -478,20 +497,39 @@ export default async function makeHyperFetch ({
     return { status: 200 }
   }
 
+  /**
+   * @param {Request} request
+   * @returns
+   */
+  async function deleteFilesDefault (request) {
+    const finalURL = await resolveInDefault(request.url)
+
+    return deleteFilesTo(finalURL, request)
+  }
+
   /**
    * @param {Request} request
    * @returns
    */
   async function deleteFiles (request) {
-    const { hostname, pathname: rawPathname } = new URL(request.url)
+    return deleteFilesTo(request.url, request)
+  }
+
+  /**
+   * @param {string} url
+   * @param {Request} request
+   * @returns
+   */
+  async function deleteFilesTo (url, request) {
+    const { hostname, pathname: rawPathname } = new URL(url)
     const pathname = decodeURI(ensureLeadingSlash(rawPathname))
 
     const drive = await sdk.getDrive(`hyper://${hostname}/`)
     if (!drive.writable) {
-      return { status: 403, body: `Cannot DELETE file in read-only drive: ${drive.url}`, headers: { Location: request.url } }
+      return { status: 403, body: `Cannot DELETE file in read-only drive: ${drive.url}`, headers: { Location: url } }
     }
 
-    onLoad(new URL('/', request.url), drive.writable)
+    onLoad(new URL('/', url), drive.writable)
 
     if (pathname.endsWith('/')) {
       let didDelete = false
@@ -561,12 +599,31 @@ export default async function makeHyperFetch ({
     return serveHead(snapshot, realPath, { accept, isRanged, noResolve })
   }
 
+  /**
+   * @param {Request} request
+   * @returns
+   */
+  async function headFilesDefault (request) {
+    const finalURL = await resolveInDefault(request.url)
+
+    return headFilesFrom(finalURL, request)
+  }
+
   /**
    * @param {Request} request
    * @returns
    */
   async function headFiles (request) {
-    const url = new URL(request.url)
+    return headFilesFrom(request.url, request)
+  }
+
+  /**
+   * @param {string} _url
+   * @param {Request} request
+   * @returns
+   */
+  async function headFilesFrom (_url, request) {
+    const url = new URL(_url)
     const { hostname, pathname: rawPathname, searchParams } = url
     const pathname = decodeURI(ensureLeadingSlash(rawPathname))
 
@@ -738,12 +795,31 @@ export default async function makeHyperFetch ({
   }
 
   /**
- * @param {Request} request
- * @returns
- */
+  * @param {Request} request
+  * @returns
+  */
+  async function getFilesDefault (request) {
+    const finalURL = await resolveInDefault(request.url)
+
+    return getFilesFrom(finalURL, request)
+  }
+
+  /**
+   * @param {Request} request
+   * @returns
+   */
   async function getFiles (request) {
+    return getFilesFrom(request.url, request)
+  }
+
+  /**
+   * @param {string} _url
+   * @param {Request} request
+   * @returns
+   */
+  async function getFilesFrom (_url, request) {
     // TODO: Redirect on directories without trailing slash
-    const url = new URL(request.url)
+    const url = new URL(_url)
     const { hostname, pathname: rawPathname, searchParams } = url
     const pathname = decodeURI(ensureLeadingSlash(rawPathname))
 
@@ -760,7 +836,7 @@ export default async function makeHyperFetch ({
       }
     }
 
-    onLoad(new URL('/', request.url), drive.writable)
+    onLoad(new URL('/', url), drive.writable)
 
     return serveGet(drive, pathname, { accept, isRanged, noResolve })
   }
@@ -836,6 +912,20 @@ export default async function makeHyperFetch ({
     return serveFile(drive, path, isRanged)
   }
 
+  /**
+   * Resolve a URL with a pathname to be within the default drive
+   * @param {string} url
+   * @returns {Promise<string>}
+   */
+  async function resolveInDefault (url) {
+    const { pathname } = new URL(url)
+
+    const drive = await sdk.getDrive(defaultDrive)
+    const finalURL = new URL(pathname, drive.url).href
+
+    return finalURL
+  }
+
   return fetch
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hypercore-fetch",
-  "version": "10.1.0",
+  "version": "10.2.0",
   "description": "Implementation of Fetch that uses the Dat SDK for loading p2p content",
   "type": "module",
   "main": "index.js",

package/test.js

@@ -669,7 +669,7 @@ test('Check hyperdrive writability', async (t) => {
   t.equal(writableHeadersAllow, 'HEAD,GET,PUT,DELETE', 'Expected writable Allows header')
 })
 
-test.only('onLoad and onDelete handlers', async (t) => {
+test('onLoad and onDelete handlers', async (t) => {
   /** @type {Parameters<OnLoadHandler> | Parameters<OnDeleteHandler> | null} */
   let args = null