feat!: named exports instead of default exports

BREAKING CHANGE:

Only use names exports as default exports don't play well with
CommonJS + Typescript typing.

This means that e.g. the raw codec is not longer imported as

```js
const raw = require('multiformats/codecs/raw')
import raw from 'multiformats/codecs/raw'

but as

```js
const { rawCodec } = require('multiformats/codec/raw')
import { rawCodec } from 'multiformats/codecs/raw'
```

Author: vmx

README.md

@@ -9,8 +9,8 @@ Library provides implementations for most basics and many others can be found in
 ## Interfaces
 
 ```js
-import CID from 'multiformats/cid'
-import json from 'multiformats/codecs/json'
+import { CID } from 'multiformats/cid'
+import { jsonCodec } from 'multiformats/codecs/json'
 import { sha256 } from 'multiformats/hashes/sha2'
 
 const bytes = json.encode({ hello: 'world' })

src/basics.js

@@ -4,13 +4,13 @@ import * as base32 from './bases/base32.js'
 import * as base58 from './bases/base58.js'
 import * as sha2 from './hashes/sha2.js'
 
-import raw from './codecs/raw.js'
-import json from './codecs/json.js'
+import { rawCodec } from './codecs/raw.js'
+import { jsonCodec } from './codecs/json.js'
 
 import { CID, hasher, digest, varint, bytes } from './index.js'
 
 const bases = { ...base32, ...base58 }
 const hashes = { ...sha2 }
-const codecs = { raw, json }
+const codecs = { raw: rawCodec, json: jsonCodec }
 
 export { CID, hasher, digest, varint, bytes, hashes, bases, codecs }

src/cid.js

@@ -18,7 +18,7 @@ import { coerce } from './bytes.js'
  * @typedef {import('./bases/interface').MultibaseDecoder<Prefix>} MultibaseDecoder
  */
 
-export default class CID {
+export class CID {
   /**
    * @param {0|1} version
    * @param {number} code

src/codecs/json.js

@@ -2,7 +2,7 @@
 
 import { codec } from './codec.js'
 
-export default codec({
+export const jsonCodec = codec({
   name: 'json',
   code: 0x0200,
   encode: json => new TextEncoder().encode(JSON.stringify(json)),

src/codecs/raw.js

@@ -7,11 +7,11 @@ import { codec } from './codec.js'
  * @param {Uint8Array} bytes
  * @returns {Uint8Array}
  */
-const raw = (bytes) => coerce(bytes)
+const rawEncodeDecode = (bytes) => coerce(bytes)
 
-export default codec({
+export const rawCodec = codec({
   name: 'raw',
   code: 85,
-  decode: raw,
-  encode: raw
+  decode: rawEncodeDecode,
+  encode: rawEncodeDecode
 })

src/hashes/identity.js

@@ -3,7 +3,7 @@
 import { from } from './hasher.js'
 import { coerce } from '../bytes.js'
 
-export default from({
+export const identity = from({
   name: 'identity',
   code: 0x0,
   encode: (input) => coerce(input)

src/index.js

@@ -1,4 +1,4 @@
-import CID from './cid.js'
+import { CID } from './cid.js'
 import * as varint from './varint.js'
 import * as bytes from './bytes.js'
 import * as hasher from './hashes/hasher.js'

src/legacy.js

@@ -1,7 +1,7 @@
 import OldCID from 'cids'
 import * as bytes from './bytes.js'
 import { Buffer } from 'buffer'
-import CID from './cid.js'
+import { CID } from './cid.js'
 
 /**
  * @template {number} Code
@@ -11,7 +11,7 @@ import CID from './cid.js'
  * @param {Object<string, MultihashHasher>} options.hashes
  */
 
-const legacy = (codec, { hashes }) => {
+export const legacy = (codec, { hashes }) => {
   /**
    * @param {*} obj
    */
@@ -139,7 +139,6 @@ const legacy = (codec, { hashes }) => {
   return { defaultHashAlg, codec: codec.code, util, resolver }
 }
 
-export default legacy
 /**
  * @typedef {import('./hashes/interface').MultihashHasher} MultihashHasher
  */

test/test-block.js

@@ -1,5 +1,5 @@
 /* globals describe, it */
-import codec from 'multiformats/codecs/json'
+import { jsonCodec as codec } from 'multiformats/codecs/json'
 import { sha256 as hasher } from 'multiformats/hashes/sha2'
 import * as main from 'multiformats/block'
 import { CID, bytes } from 'multiformats'

test/test-legacy.js

@@ -1,12 +1,12 @@
 /* globals before, describe, it */
 import { Buffer } from 'buffer'
 import assert from 'assert'
-import legacy from 'multiformats/legacy'
-import rawCodec from 'multiformats/codecs/raw'
-import jsonCodec from 'multiformats/codecs/json'
+import { legacy } from 'multiformats/legacy'
+import { rawCodec } from 'multiformats/codecs/raw'
+import { jsonCodec } from 'multiformats/codecs/json'
 import { sha256, sha512 } from 'multiformats/hashes/sha2'
 import { codec } from 'multiformats/codecs/codec'
-import CID from 'multiformats/cid'
+import { CID } from 'multiformats/cid'
 
 const same = assert.deepStrictEqual
 const test = it

test/test-multicodec.js

@@ -1,8 +1,8 @@
 /* globals describe, it */
 import * as bytes from '../src/bytes.js'
 import assert from 'assert'
-import raw from 'multiformats/codecs/raw'
-import json from 'multiformats/codecs/json'
+import { rawCodec } from 'multiformats/codecs/raw'
+import { jsonCodec } from 'multiformats/codecs/json'
 import { codec } from 'multiformats/codecs/codec'
 const same = assert.deepStrictEqual
 const test = it
@@ -20,35 +20,35 @@ const testThrow = async (fn, message) => {
 
 describe('multicodec', () => {
   test('encode/decode raw', () => {
-    const buff = raw.encode(bytes.fromString('test'))
+    const buff = rawCodec.encode(bytes.fromString('test'))
     same(buff, bytes.fromString('test'))
-    same(raw.decode(buff, 'raw'), bytes.fromString('test'))
+    same(rawCodec.decode(buff, 'raw'), bytes.fromString('test'))
   })
 
   test('encode/decode json', () => {
-    const buff = json.encode({ hello: 'world' })
+    const buff = jsonCodec.encode({ hello: 'world' })
     same(buff, bytes.fromString(JSON.stringify({ hello: 'world' })))
-    same(json.decode(buff), { hello: 'world' })
+    same(jsonCodec.decode(buff), { hello: 'world' })
   })
 
   test('json.encoder', () => {
-    const { encoder } = json
-    same(encoder === json.encoder, true, 'getter cached decoder')
+    const { encoder } = jsonCodec
+    same(encoder === jsonCodec.encoder, true, 'getter cached decoder')
 
     const buff = encoder.encode({ hello: 'world' })
     same(buff, bytes.fromString(JSON.stringify({ hello: 'world' })))
   })
 
   test('json.decoder', () => {
-    const { decoder } = json
-    same(decoder === json.decoder, true, 'getter cached encoder')
+    const { decoder } = jsonCodec
+    same(decoder === jsonCodec.decoder, true, 'getter cached encoder')
 
-    const buff = json.encode({ hello: 'world' })
+    const buff = jsonCodec.encode({ hello: 'world' })
     same(decoder.decode(buff), { hello: 'world' })
   })
 
   test('raw cannot encode string', async () => {
-    await testThrow(() => raw.encode('asdf'), 'Unknown type, must be binary type')
+    await testThrow(() => rawCodec.encode('asdf'), 'Unknown type, must be binary type')
   })
 
   test('add with function', () => {

test/test-multihash.js

@@ -5,7 +5,7 @@ import valid from './fixtures/valid-multihash.js'
 import invalid from './fixtures/invalid-multihash.js'
 import crypto from 'crypto'
 import { sha256, sha512, __browser } from 'multiformats/hashes/sha2'
-import identity from 'multiformats/hashes/identity'
+import { identity } from 'multiformats/hashes/identity'
 import { decode as decodeDigest, create as createDigest } from 'multiformats/hashes/digest'
 const test = it
 const encode = name => data => coerce(crypto.createHash(name).update(data).digest())

test/ts-use/src/main.ts

@@ -1,12 +1,12 @@
 import * as Block from 'multiformats/block'
 import { sha256 } from 'multiformats/hashes/sha2'
-import json from 'multiformats/codecs/json'
+import { jsonCodec } from 'multiformats/codecs/json'
 
 const main = async () => {
   const block = await Block.encode({
     value: { hello: 'world' },
     hasher: sha256,
-    codec: json
+    codec: jsonCodec
   })
 
   console.log(block)