feat: add ts types

.github/workflows/main.yml

@@ -14,7 +14,7 @@ jobs:
     - uses: actions/checkout@v2
     - run: yarn
     - run: yarn lint
-    # - uses: gozala/typescript-error-reporter-action@v1.0.4
+    - uses: gozala/typescript-error-reporter-action@v1.0.4
     - run: yarn build
     - run: yarn aegir dep-check
     - uses: ipfs/aegir/actions/bundle-size@master

README.md

@@ -29,12 +29,6 @@
 > npm install multicodec
 ```
 
-The type definitions for this package are available on http://definitelytyped.org/. To install just use:
-
- ```sh
- $ npm install -D @types/multicodec
- ```
-
 ## Usage
 
 ### Example

package.json

@@ -68,5 +68,9 @@
     "Peter-Jan Brone <peter-jan@settlemint.com>",
     "Vasco Santos <vasco.santos@moxy.studio>",
     "Carson Farmer <carson.farmer@gmail.com>"
-  ]
+  ],
+  "types": "dist/src/index.d.ts",
+  "typesVersions": {
+    "*": { "src/*": ["dist/src/*", "dist/src/*/index"] }
+  }
 }

src/constants.js

@@ -2,11 +2,14 @@
 
 const table = require('./base-table.json')
 
-// map for codecConstant -> code
-const constants = {}
+const constants = /** @type {Record<CodecConstant, CodecNumber>} */({})
 
 for (const [name, code] of Object.entries(table)) {
-  constants[name.toUpperCase().replace(/-/g, '_')] = code
+  const constant = /** @type {CodecConstant} */(name.toUpperCase().replace(/-/g, '_'))
+  constants[constant] = /** @type {CodecNumber} */(code)
 }
 
 module.exports = Object.freeze(constants)
+
+/** @typedef {import('./types').CodecConstant} CodecConstant */
+/** @typedef {import('./types').CodecNumber} CodecNumber */

src/index.js

@@ -17,19 +17,16 @@ const codecNameToCodeVarint = require('./varint-table')
 const util = require('./util')
 const uint8ArrayConcat = require('uint8arrays/concat')
 
-exports = module.exports
-
 /**
  * Prefix a buffer with a multicodec-packed.
  *
- * @param {string|number} multicodecStrOrCode
+ * @param {CodecName|Uint8Array} multicodecStrOrCode
  * @param {Uint8Array} data
  * @returns {Uint8Array}
  */
-exports.addPrefix = (multicodecStrOrCode, data) => {
+function addPrefix (multicodecStrOrCode, data) {
   let prefix
 
-  // @ts-ignore: TS2358
   if (multicodecStrOrCode instanceof Uint8Array) {
     prefix = util.varintUint8ArrayEncode(multicodecStrOrCode)
   } else {
@@ -48,7 +45,7 @@ exports.addPrefix = (multicodecStrOrCode, data) => {
  * @param {Uint8Array} data
  * @returns {Uint8Array}
  */
-exports.rmPrefix = (data) => {
+function rmPrefix (data) {
   varint.decode(data)
   return data.slice(varint.decode.bytes)
 }
@@ -57,9 +54,9 @@ exports.rmPrefix = (data) => {
  * Get the codec of the prefixed data.
  *
  * @param {Uint8Array} prefixedData
- * @returns {string}
+ * @returns {CodecName}
  */
-exports.getCodec = (prefixedData) => {
+function getCodec (prefixedData) {
   const code = varint.decode(prefixedData)
   const codecName = intTable.get(code)
   if (codecName === undefined) {
@@ -71,20 +68,20 @@ exports.getCodec = (prefixedData) => {
 /**
  * Get the name of the codec.
  *
- * @param {number} codec
- * @returns {string}
+ * @param {CodecNumber} codec
+ * @returns {CodecName|undefined}
  */
-exports.getName = (codec) => {
+function getName (codec) {
   return intTable.get(codec)
 }
 
 /**
  * Get the code of the codec
  *
- * @param {string} name
- * @returns {number}
+ * @param {CodecName} name
+ * @returns {CodecNumber}
  */
-exports.getNumber = (name) => {
+function getNumber (name) {
   const code = codecNameToCodeVarint[name]
   if (code === undefined) {
     throw new Error('Codec `' + name + '` not found')
@@ -96,19 +93,19 @@ exports.getNumber = (name) => {
  * Get the code of the prefixed data.
  *
  * @param {Uint8Array} prefixedData
- * @returns {number}
+ * @returns {CodecNumber}
  */
-exports.getCode = (prefixedData) => {
+function getCode (prefixedData) {
   return varint.decode(prefixedData)
 }
 
 /**
  * Get the code as varint of a codec name.
  *
- * @param {string} codecName
+ * @param {CodecName} codecName
  * @returns {Uint8Array}
  */
-exports.getCodeVarint = (codecName) => {
+function getCodeVarint (codecName) {
   const code = codecNameToCodeVarint[codecName]
   if (code === undefined) {
     throw new Error('Codec `' + codecName + '` not found')
@@ -119,16 +116,31 @@ exports.getCodeVarint = (codecName) => {
 /**
  * Get the varint of a code.
  *
- * @param {number} code
+ * @param {CodecNumber} code
  * @returns {Array.<number>}
  */
-exports.getVarint = (code) => {
+function getVarint (code) {
   return varint.encode(code)
 }
 
 // Make the constants top-level constants
 const constants = require('./constants')
-Object.assign(exports, constants)
 
 // Human friendly names for printing, e.g. in error messages
-exports.print = require('./print')
+const print = require('./print')
+
+module.exports = {
+  addPrefix,
+  rmPrefix,
+  getCodec,
+  getName,
+  getNumber,
+  getCode,
+  getCodeVarint,
+  getVarint,
+  print,
+  ...constants
+}
+
+/** @typedef {import('./types').CodecName} CodecName */
+/** @typedef {import('./types').CodecNumber} CodecNumber */

src/int-table.js

@@ -1,12 +1,18 @@
 'use strict'
+
 const baseTable = require('./base-table.json')
 
-// map for hexString -> codecName
+/**
+ * @type {Map<CodecNumber,CodecName>}
+ */
 const nameTable = new Map()
 
 for (const encodingName in baseTable) {
   const code = baseTable[encodingName]
-  nameTable.set(code, encodingName)
+  nameTable.set(code, /** @type {CodecName} */(encodingName))
 }
 
 module.exports = Object.freeze(nameTable)
+
+/** @typedef {import('./types').CodecName} CodecName */
+/** @typedef {import('./types').CodecNumber} CodecNumber */

src/print.js

@@ -2,11 +2,15 @@
 
 const table = require('./base-table.json')
 
-// map for code -> print friendly name
-const tableByCode = {}
+const tableByCode = /** @type {Record<CodecNumber,CodecName>} */({})
 
 for (const [name, code] of Object.entries(table)) {
-  if (tableByCode[code] === undefined) tableByCode[code] = name
+  if (tableByCode[code] === undefined) {
+    tableByCode[/** @type {CodecNumber} */(code)] = /** @type {CodecName} */(name)
+  }
 }
 
 module.exports = Object.freeze(tableByCode)
+
+/** @typedef {import('./types').CodecName} CodecName */
+/** @typedef {import('./types').CodecNumber} CodecNumber */