fix: type check ipfs-core

Author: Gozala

packages/ipfs-core/package.json

@@ -32,7 +32,10 @@
   },
   "scripts": {
     "lint": "aegir lint",
-    "build": "aegir build",
+    "check": "tsc --noEmit",
+    "build": "npm run build:bundle && npm run build:types",
+    "build:bundle": "aegir build",
+    "build:types": "tsc --emitDeclarationOnly --declarationDir dist",
     "test": "aegir test",
     "test:node": "aegir test -t node",
     "test:browser": "aegir test -t browser",
@@ -132,5 +135,12 @@
   "optionalDependencies": {
     "prom-client": "^12.0.0",
     "prometheus-gc-stats": "^0.6.0"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "dist/*"
+      ]
+    }
   }
 }

packages/ipfs-core/src/components/add-all/utils.js

@@ -4,7 +4,7 @@
  * Parses chunker string into options used by DAGBuilder in ipfs-unixfs-engine
  *
  *
- * @param  {string}   chunker - Chunker algorithm supported formats:
+ * @param  {string} [chunker] - Chunker algorithm supported formats:
  * "size-{size}"
  * "rabin"
  * "rabin-{avg}"

packages/ipfs-core/src/components/add.js

@@ -35,7 +35,9 @@ module.exports = ({ addAll }) => {
    * @type {Add<{}>}
    */
   async function add (source, options) { // eslint-disable-line require-await
-    return last(addAll(source, options))
+    /** @type {UnixFSEntry} - Could be undefined if empty */
+    const result = (await last(addAll(source, options)))
+    return result
   }
   return add
 }

packages/ipfs-core/src/components/dag/get.js

@@ -38,7 +38,8 @@ const toCidAndPath = require('ipfs-core-utils/src/to-cid-and-path')
  */
 
 module.exports = ({ ipld, preload }) => {
-  return withTimeoutOption(async function get (ipfsPath, options = {}) {
+  /** @type {Get} */
+  const get = async function get (ipfsPath, options = {}) {
     const {
       cid,
       path
@@ -53,16 +54,19 @@ module.exports = ({ ipld, preload }) => {
     }
 
     if (options.path) {
-      if (options.localResolve) {
-        return first(ipld.resolve(cid, options.path))
-      }
-
-      return last(ipld.resolve(cid, options.path))
+      const result = options.localResolve
+      /** @type {DagEntry} - first will return undefined if empty */
+        ? (await first(ipld.resolve(cid, options.path)))
+      /** @type {DagEntry} - last will return undefined if empty */
+        : (await last(ipld.resolve(cid, options.path)))
+      return result
     }
 
     return {
       value: await ipld.get(cid, options),
       remainderPath: ''
     }
-  })
+  }
+
+  return withTimeoutOption(get)
 }

packages/ipfs-core/src/components/init.js

@@ -198,7 +198,7 @@ module.exports = ({
 
 /**
  * @param {IPFSRepo} repo
- * @param {InitOptions} options
+ * @param {Object} options
  * @param {PrivateKey} options.privateKey
  * @param {boolean} [options.emptyRepo]
  * @param {number} [options.bits=2048] - Number of bits to use in the generated key
@@ -231,8 +231,6 @@ async function initNewRepo (repo, { privateKey, emptyRepo, algorithm, bits, prof
     PrivKey: uint8ArrayToString(peerId.privKey.bytes, 'base64pad')
   }
 
-  privateKey = peerId.privKey
-
   log('peer identity: %s', config.Identity.PeerID)
 
   await repo.init(config)

packages/ipfs-core/src/components/pin/add.js

@@ -13,7 +13,8 @@ module.exports = ({ addAll }) =>
    * @returns {Promise<CID>}
    */
   async (path, options = {}) =>
-    await last(addAll({ path, ...options }, options))
+    /** @type {CID} - Need to loosen check here because it could be void */
+    (await last(addAll({ path, ...options }, options)))
 
 /**
  * @typedef {AddSettings & AbortOptions} AddOptions

packages/ipfs-core/src/components/pin/rm.js

@@ -23,7 +23,8 @@ module.exports = ({ rmAll }) =>
    * ```
    */
   async (path, options) =>
-    await last(rmAll({ path, ...options }, options))
+    /** @type {CID} - Need to loosen check here because it could be void */
+    (await last(rmAll({ path, ...options }, options)))
 
 /**
  * @typedef {RmSettings & AbortOptions} RmOptions

packages/ipfs-core/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "../../typescript.json",
+  "include": [
+    "./src"
+  ]
+}