fix: typedef resolution & add examples that use types

examples/ipfs-from-ts/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "ipfs-from-ts",
+  "private": true,
+  "dependencies": {
+    "ipfs": "^0.50.1"
+  },
+  "scripts": {
+    "test": "npx typescript --noEmit"
+  }
+}

examples/ipfs-from-ts/src/main.ts

@@ -0,0 +1,29 @@
+import IPFS from 'ipfs'
+
+export default async function main () {
+  const node = await IPFS.create()
+  const version = await node.version()
+
+  console.log('Version:', version.version)
+
+  const file = await node.add({
+    path: 'hello.txt',
+    content: new TextEncoder().encode('Hello World 101')
+  })
+
+  console.log('Added file:', file.path, file.cid.toString())
+  try {
+    // @ts-expect-error - CID is not a string
+    file.cid.toUpperCase()
+  } catch(error) {
+
+  }
+
+  const decoder = new TextDecoder()
+  let content = ''
+  for await (const chunk of node.cat(file.cid)) {
+    content += decoder.decode(chunk)  
+  }
+
+  console.log('Added file contents:', content)
+}

examples/ipfs-from-ts/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "skipLibCheck": true,
+    "noImplicitAny": false,
+    "esModuleInterop": true,
+    "moduleResolution": "Node",
+    "noEmit": true
+  },
+  "include": [
+    "src"
+  ]
+}

examples/ipfs-from-typed-js/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "ipfs-from-ts",
+  "private": true,
+  "dependencies": {
+    "ipfs": "^0.50.1"
+  },
+  "scripts": {
+    "test": "npx typescript --noEmit"
+  }
+}

examples/ipfs-from-typed-js/src/main.js

@@ -0,0 +1,31 @@
+const IPFS = require('ipfs')
+
+async function main () {
+  const node = await IPFS.create()
+  const version = await node.version()
+
+  console.log('Version:', version.version)
+
+  const file = await node.add({
+    path: 'hello.txt',
+    content: new TextEncoder().encode('Hello World 101')
+  })
+
+  console.log('Added file:', file.path, file.cid.toString())
+  try {
+    // @ts-expect-error - CID is not a string
+    file.cid.toUpperCase()
+  } catch(error) {
+
+  }
+
+  const decoder = new TextDecoder()
+  let content = ''
+  for await (const chunk of node.cat(file.cid)) {
+    content += decoder.decode(chunk)  
+  }
+
+  console.log('Added file contents:', content)
+}
+
+main()

examples/ipfs-from-typed-js/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "noImplicitAny": false,
+    "esModuleInterop": true,
+    "moduleResolution": "Node",
+    "noEmit": true
+  },
+  "include": [
+    "src"
+  ]
+}

packages/ipfs-core-utils/package.json

@@ -14,7 +14,8 @@
   "typesVersions": {
     "*": {
       "*": [
-        "dist/*"
+        "dist/*",
+        "dist/*/index"
       ]
     }
   },

packages/ipfs-core/package.json

@@ -29,7 +29,8 @@
   "typesVersions": {
     "*": {
       "*": [
-        "dist/*"
+        "dist/*",
+        "dist/*/index"
       ]
     }
   },

packages/ipfs-core/src/components/files/index.js

@@ -5,17 +5,17 @@ const isIpfs = require('is-ipfs')
 
 /**
  * @typedef {Object} MFS
- * @property {ReturnType<import('./stat')>} stat
- * @property {ReturnType<import('./chmod')>} chmod
- * @property {ReturnType<import('./cp')>} cp
- * @property {ReturnType<import('./flush')>} flush
- * @property {ReturnType<import('./mkdir')>} mkdir
- * @property {ReturnType<import('./mv')>} mv
- * @property {ReturnType<import('./rm')>} rm
- * @property {ReturnType<import('./touch')>} touch
- * @property {ReturnType<import('./write')>} write
- * @property {ReturnType<import('./read')>} read
- * @property {ReturnType<import('./ls')>} ls
+ * @property {ReturnType<typeof import('./stat')>} stat
+ * @property {ReturnType<typeof import('./chmod')>} chmod
+ * @property {ReturnType<typeof import('./cp')>} cp
+ * @property {ReturnType<typeof import('./flush')>} flush
+ * @property {ReturnType<typeof import('./mkdir')>} mkdir
+ * @property {ReturnType<typeof import('./mv')>} mv
+ * @property {ReturnType<typeof import('./rm')>} rm
+ * @property {ReturnType<typeof import('./touch')>} touch
+ * @property {ReturnType<typeof import('./write')>} write
+ * @property {ReturnType<typeof import('./read')>} read
+ * @property {ReturnType<typeof import('./ls')>} ls
  */
 
 // These operations are read-locked at the function level and will execute simultaneously