chore: tighten up input types

package.json

@@ -3,7 +3,7 @@
   "version": "1.0.0",
   "description": "JS implementation of the IPFS UnixFS",
   "scripts": {
-    "reset": "lerna run clean && rimraf packages/*/node_modules node_modules",
+    "reset": "lerna run clean && rimraf packages/*/node_modules node_modules packages/*/package-lock.json package-lock.json",
     "test": "lerna run test",
     "coverage": "lerna run coverage",
     "prepare": "lerna run prepare",
@@ -51,6 +51,7 @@
     "packages/*"
   ],
   "engines": {
+    "node": ">=14.0.0",
     "npm": ">=7.0.0"
   }
 }

packages/ipfs-unixfs-exporter/package.json

@@ -28,15 +28,15 @@
     "url": "https://github.com/ipfs/js-ipfs-unixfs/issues"
   },
   "engines": {
-    "node": ">=10.0.0",
-    "npm": ">=4.0.0"
+    "node": ">=14.0.0",
+    "npm": ">=7.0.0"
   },
   "homepage": "https://github.com/ipfs/js-ipfs-unixfs#readme",
   "devDependencies": {
     "@types/mocha": "^8.2.1",
     "@types/sinon": "^9.0.10",
     "abort-controller": "^3.0.0",
-    "aegir": "^32.0.0",
+    "aegir": "^32.1.0",
     "copy": "^0.3.2",
     "crypto-browserify": "^3.12.0",
     "detect-node": "^2.0.4",

packages/ipfs-unixfs-exporter/test/exporter-sharded.spec.js

@@ -20,6 +20,7 @@ const {
 } = require('ipld-dag-pb')
 const blockApi = require('./helpers/block')
 const uint8ArrayConcat = require('uint8arrays/concat')
+const asAsyncIterable = require('./helpers/as-async-iterable')
 
 /**
  * @typedef {import('cids')} CID
@@ -49,14 +50,14 @@ describe('exporter sharded', function () {
   const createShardWithFileNames = (numFiles, fileName) => {
     const files = new Array(numFiles).fill(0).map((_, index) => ({
       path: fileName(index),
-      content: Uint8Array.from([0, 1, 2, 3, 4, index])
+      content: asAsyncIterable(Uint8Array.from([0, 1, 2, 3, 4, index]))
     }))
 
     return createShardWithFiles(files)
   }
 
   /**
-   * @param {{ path: string, content: Uint8Array }[] } files
+   * @param {{ path: string, content: AsyncIterable<Uint8Array> }[] } files
    */
   const createShardWithFiles = async (files) => {
     const result = await last(importer(files, block, {
@@ -88,7 +89,7 @@ describe('exporter sharded', function () {
 
     const imported = await all(importer(Object.keys(files).map(path => ({
       path,
-      content: files[path].content
+      content: asAsyncIterable(files[path].content)
     })), block, {
       wrapWithDirectory: true,
       shardSplitThreshold: SHARD_SPLIT_THRESHOLD

packages/ipfs-unixfs-exporter/test/exporter-subtree.spec.js

@@ -12,6 +12,7 @@ const last = require('it-last')
 const blockApi = require('./helpers/block')
 const randomBytes = require('it-buffer-stream')
 const uint8ArrayConcat = require('uint8arrays/concat')
+const asAsyncIterable = require('./helpers/as-async-iterable')
 
 const ONE_MEG = Math.pow(1024, 2)
 
@@ -36,7 +37,7 @@ describe('exporter subtree', () => {
       content: randomBytes(ONE_MEG)
     }, {
       path: './level-1/200Bytes.txt',
-      content
+      content: asAsyncIterable(content)
     }], block))
 
     if (!imported) {
@@ -64,7 +65,7 @@ describe('exporter subtree', () => {
       content: randomBytes(ONE_MEG)
     }, {
       path: './level-1/200Bytes.txt',
-      content
+      content: asAsyncIterable(content)
     }, {
       path: './level-1/level-2'
     }], block))
@@ -121,12 +122,12 @@ describe('exporter subtree', () => {
       content: randomBytes(ONE_MEG)
     }, {
       path: './level-1/200Bytes.txt',
-      content
+      content: asAsyncIterable(content)
     }, {
       path: './level-1/level-2'
     }, {
       path: './level-1/level-2/200Bytes.txt',
-      content
+      content: asAsyncIterable(content)
     }], block))
 
     if (!imported) {

packages/ipfs-unixfs-exporter/test/exporter.spec.js

@@ -25,6 +25,7 @@ const blockApi = require('./helpers/block')
 const uint8ArrayFromString = require('uint8arrays/from-string')
 const uint8ArrayToString = require('uint8arrays/to-string')
 const uint8ArrayConcat = require('uint8arrays/concat')
+const asAsyncIterable = require('./helpers/as-async-iterable')
 
 const ONE_MEG = Math.pow(1024, 2)
 
@@ -79,7 +80,7 @@ describe('exporter', () => {
   async function addTestFile ({ file, strategy = 'balanced', path = '/foo', maxChunkSize, rawLeaves }) {
     const result = await all(importer([{
       path,
-      content: file
+      content: asAsyncIterable(file)
     }], block, {
       strategy,
       rawLeaves,
@@ -195,7 +196,7 @@ describe('exporter', () => {
 
     const files = await all(importer([{
       path: filePath,
-      content: smallFile
+      content: asAsyncIterable(smallFile)
     }], block))
 
     const path = `/ipfs/${files[1].cid.toBaseEncodedString()}/${fileName}`
@@ -211,7 +212,7 @@ describe('exporter', () => {
 
     const files = await all(importer([{
       path: filePath,
-      content: smallFile
+      content: asAsyncIterable(smallFile)
     }], block))
 
     const path = `/ipfs/${files[1].cid.toBaseEncodedString()}/${fileName}`
@@ -613,7 +614,7 @@ describe('exporter', () => {
   it('exports a large file > 1mb imported with raw leaves', async () => {
     const imported = await first(importer([{
       path: '1.2MiB.txt',
-      content: bigFile
+      content: asAsyncIterable(bigFile)
     }], block, {
       rawLeaves: true
     }))
@@ -890,7 +891,7 @@ describe('exporter', () => {
 
     const imported = await first(importer([{
       path: '200Bytes.txt',
-      content: bigFile
+      content: asAsyncIterable(bigFile)
     }], block, {
       rawLeaves: true
     }))
@@ -915,7 +916,7 @@ describe('exporter', () => {
   it('exports a raw leaf', async () => {
     const imported = await first(importer([{
       path: '200Bytes.txt',
-      content: smallFile
+      content: asAsyncIterable(smallFile)
     }], block, {
       rawLeaves: true
     }))
@@ -1022,7 +1023,7 @@ describe('exporter', () => {
   it('exports a node with depth', async () => {
     const imported = await all(importer([{
       path: '/foo/bar/baz.txt',
-      content: uint8ArrayFromString('hello world')
+      content: asAsyncIterable(uint8ArrayFromString('hello world'))
     }], block))
 
     const exported = await exporter(imported[0].cid, ipld)
@@ -1033,13 +1034,13 @@ describe('exporter', () => {
   it('exports a node recursively with depth', async () => {
     const dir = await last(importer([{
       path: '/foo/bar/baz.txt',
-      content: uint8ArrayFromString('hello world')
+      content: asAsyncIterable(uint8ArrayFromString('hello world'))
     }, {
       path: '/foo/qux.txt',
-      content: uint8ArrayFromString('hello world')
+      content: asAsyncIterable(uint8ArrayFromString('hello world'))
     }, {
       path: '/foo/bar/quux.txt',
-      content: uint8ArrayFromString('hello world')
+      content: asAsyncIterable(uint8ArrayFromString('hello world'))
     }], block))
 
     if (!dir) {

packages/ipfs-unixfs-exporter/test/helpers/as-async-iterable.js

@@ -0,0 +1,14 @@
+'use strict'
+
+/**
+ * @param {Uint8Array | Uint8Array[]} arr
+ */
+async function * asAsyncIterable (arr) {
+  if (!Array.isArray(arr)) {
+    arr = [arr]
+  }
+
+  yield * arr
+}
+
+module.exports = asAsyncIterable

packages/ipfs-unixfs-exporter/test/import-export-dir-sharding.spec.js

@@ -15,6 +15,7 @@ const blockApi = require('./helpers/block')
 const uint8ArrayFromString = require('uint8arrays/from-string')
 const uint8ArrayToString = require('uint8arrays/to-string')
 const uint8ArrayConcat = require('uint8arrays/concat')
+const asAsyncIterable = require('./helpers/as-async-iterable')
 
 /**
  * @typedef {import('../src').UnixFSEntry} UnixFSEntry
@@ -37,7 +38,7 @@ describe('builder: directory sharding', () => {
       const content = uint8ArrayFromString('i have the best bytes')
       const nodes = await all(importer([{
         path: 'a/b',
-        content
+        content: asAsyncIterable(content)
       }], block, {
         shardSplitThreshold: Infinity // never shard
       }))
@@ -73,7 +74,7 @@ describe('builder: directory sharding', () => {
     it('yields a sharded dir', async () => {
       const nodes = await all(importer([{
         path: 'a/b',
-        content: uint8ArrayFromString('i have the best bytes')
+        content: asAsyncIterable(uint8ArrayFromString('i have the best bytes'))
       }], block, {
         shardSplitThreshold: 0 // always shard
       }))
@@ -95,7 +96,7 @@ describe('builder: directory sharding', () => {
       const content = 'i have the best bytes'
       const nodes = await all(importer([{
         path: 'a/b',
-        content: uint8ArrayFromString(content)
+        content: asAsyncIterable(uint8ArrayFromString(content))
       }], block, {
         shardSplitThreshold: Infinity // never shard
       }))
@@ -132,7 +133,7 @@ describe('builder: directory sharding', () => {
       const content = 'i have the best bytes'
       const nodes = await all(importer([{
         path: 'a/b',
-        content: uint8ArrayFromString(content)
+        content: asAsyncIterable(uint8ArrayFromString(content))
       }], block, {
         shardSplitThreshold: 0 // always shard
       }))
@@ -177,7 +178,7 @@ describe('builder: directory sharding', () => {
           for (let i = 0; i < maxDirs; i++) {
             yield {
               path: 'big/' + i.toString().padStart(4, '0'),
-              content: uint8ArrayFromString(i.toString())
+              content: asAsyncIterable(uint8ArrayFromString(i.toString()))
             }
           }
         }
@@ -196,7 +197,7 @@ describe('builder: directory sharding', () => {
           for (let i = 0; i < maxDirs; i++) {
             yield {
               path: 'big/' + i.toString().padStart(4, '0'),
-              content: uint8ArrayFromString(i.toString())
+              content: asAsyncIterable(uint8ArrayFromString(i.toString()))
             }
           }
         }
@@ -249,7 +250,7 @@ describe('builder: directory sharding', () => {
 
             yield {
               path: dir.concat(i.toString().padStart(4, '0')).join('/'),
-              content: uint8ArrayFromString(i.toString())
+              content: asAsyncIterable(uint8ArrayFromString(i.toString()))
             }
 
             pending--

packages/ipfs-unixfs-exporter/test/import-export-nested-dir.spec.js

@@ -13,6 +13,7 @@ const blockApi = require('./helpers/block')
 const uint8ArrayFromString = require('uint8arrays/from-string')
 const uint8ArrayToString = require('uint8arrays/to-string')
 const uint8ArrayConcat = require('uint8arrays/concat')
+const asAsyncIterable = require('./helpers/as-async-iterable')
 
 describe('import and export: directory', () => {
   const rootHash = 'QmdCrquDwd7RfZ6GCZFEVADwe8uyyw1YmF9mtAB7etDgmK'
@@ -31,16 +32,16 @@ describe('import and export: directory', () => {
 
     const source = [{
       path: 'a/b/c/d/e',
-      content: uint8ArrayFromString('banana')
+      content: asAsyncIterable(uint8ArrayFromString('banana'))
     }, {
       path: 'a/b/c/d/f',
-      content: uint8ArrayFromString('strawberry')
+      content: asAsyncIterable(uint8ArrayFromString('strawberry'))
     }, {
       path: 'a/b/g',
-      content: uint8ArrayFromString('ice')
+      content: asAsyncIterable(uint8ArrayFromString('ice'))
     }, {
       path: 'a/b/h',
-      content: uint8ArrayFromString('cream')
+      content: asAsyncIterable(uint8ArrayFromString('cream'))
     }]
 
     const files = await all(importer(source, block))

packages/ipfs-unixfs-exporter/test/import-export.spec.js

@@ -13,6 +13,7 @@ const loadFixture = require('aegir/utils/fixtures')
 const isNode = require('detect-node')
 const bigFile = loadFixture((isNode ? __dirname : 'test') + '/fixtures/1.2MiB.txt')
 const blockApi = require('./helpers/block')
+const asAsyncIterable = require('./helpers/as-async-iterable')
 
 const { importer } = require('ipfs-unixfs-importer')
 const { exporter } = require('../src')
@@ -42,7 +43,7 @@ describe('import and export', function () {
 
       it('imports and exports', async () => {
         const path = `${strategy}-big.dat`
-        const values = [{ path: path, content: bigFile }]
+        const values = [{ path: path, content: asAsyncIterable(bigFile) }]
 
         // @ts-ignore
         for await (const file of importer(values, block, importerOptions)) {