feat!: accept pre-configured import components as options instead of options for components

[achingbrain]

The existing importer takes one big options object that contains options for every subsystem. This leads to situations where different components use the same option keys - for example both the rabin and fixed-size chunkers use the maxChunkSize key.

This PR reduces the number of options by accepting preconfigured instances of internal components - e.g. instead of passing '"rabin" for the chunker argument, you pass an instance of the rabin chunker instead. This greatly simplifies the config and also allows a simple way for users to pass custom chunkers in. The same thing applies to file layouts, dag builders etc.

Before:

import { importer } from 'ipfs-unixfs-importer'

for await (const result of importer(stream, blockstore, {
  chunker: 'rabin',
  avgChunkSize: 512000,
  strategy: 'trickle'
}) {
  // ...
}

After:

import { importer } from 'ipfs-unixfs-importer'
import { rabin } from 'ipfs-unixfs-importer/chunkers'
import { trickle } from 'ipfs-unixfs-importer/layouts'

for await (const result of importer(stream, blockstore, {
  chunker: rabin({
    avgChunkSize: 512000
  }),
  layout: trickle()
}) {
  // ...
}

Other breaking changes:

• This module is now typescript
• CID 1 is now the default
• Raw leaves: true is now the default
• The onlyHash option has been removed - just pass a MemoryBlockstore or other blockstore implementation that doesn't store the blocks anywhere
• The strategy config key is now layout and accepts an instance of a file layout instead of a string
• The chunker config key now accepts an instance of a file chunker instead of a string

importFile, importDirectory, importBytes and importByteStream functions are also now exported along side importer to make dealing with simple imports that only import one thing easier.

import { importFile, importDirectory, importBytes, importByteStream } from 'ipfs-unixfs-importer'

// import single file
const result = await importFile({
  path: 'foo.txt',
  content: Uint8Array.from([0, 1, 2, 3, 4])
}, blockstore, options)

// import single directory
const result = await importDirectory({
  path: 'dir'
}, blockstore, options)

// import single buffer
const result = await importBytes(Uint8Array.from([0, 1, 2, 3, 4]), blockstore, options)

// import single byte stream
const result = await importByteStream(fs.createReadStream('./foo.txt'), blockstore, options)

BREAKING CHANGE: The options object now accepts preconfigured instances of chunkers and file layouts - these can be imported from this module - see #283 for more

[github-actions]

🎉 This PR is included in version ipfs-unixfs-v11.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[github-actions]

🎉 This PR is included in version ipfs-unixfs-importer-v14.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[github-actions]

🎉 This PR is included in version ipfs-unixfs-exporter-v12.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀