chore: update project

ipfs · Jan 8, 2024 · a0692f9 · a0692f9
1 parent ea5533c
commit a0692f9
Show file tree

Hide file tree

Showing 37 changed files with 183 additions and 182 deletions.
diff --git a/package.json b/package.json
@@ -11,6 +11,10 @@
   "bugs": {
     "url": "https://github.com/ipfs/helia/issues"
   },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "keywords": [
     "ipfs"
   ],

diff --git a/packages/block-brokers/README.md b/packages/block-brokers/README.md
@@ -11,28 +11,32 @@
 
 > Block brokers for Helia
 
-## Install
+# Install
 
 ```console
 $ npm i @helia/block-brokers
 ```
 
-<!-- ### Browser `<script>` tag
+## Browser `<script>` tag
 
-Loading this module through a script tag will make it's exports available as `bitswap` and `trustlessGateway` and `NetworkedStorage` in the global namespace.
+Loading this module through a script tag will make it's exports available as `HeliaBlockBrokers` in the global namespace.
 
 ```html
 <script src="https://unpkg.com/@helia/block-brokers/dist/index.min.js"></script>
-``` -->
+```
+
+# API Docs
+
+- <https://ipfs.github.io/helia/modules/_helia_block_brokers.html>
 
-## License
+# License
 
 Licensed under either of
 
 - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
 - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
-## Contribute
+# Contribute
 
 Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia/issues).
 

diff --git a/packages/block-brokers/package.json b/packages/block-brokers/package.json
@@ -3,7 +3,7 @@
   "version": "0.0.0",
   "description": "Block brokers for Helia",
   "license": "Apache-2.0 OR MIT",
-  "homepage": "https://github.com/ipfs/helia/tree/master/packages/block-brokers#readme",
+  "homepage": "https://github.com/ipfs/helia/tree/main/packages/block-brokers#readme",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ipfs/helia.git"
@@ -20,22 +20,6 @@
   ],
   "type": "module",
   "types": "./dist/src/index.d.ts",
-  "typesVersions": {
-    "*": {
-      "*": [
-        "*",
-        "dist/*",
-        "dist/src/*",
-        "dist/src/*/index"
-      ],
-      "src/*": [
-        "*",
-        "dist/*",
-        "dist/src/*",
-        "dist/src/*/index"
-      ]
-    }
-  },
   "files": [
     "src",
     "dist",
@@ -79,12 +63,12 @@
     "it-foreach": "^2.0.6",
     "multiformats": "^13.0.0",
     "progress-events": "^1.0.0",
-    "uint8arrays": "^5.0.0"
+    "uint8arrays": "^5.0.1"
   },
   "devDependencies": {
     "@libp2p/logger": "^4.0.1",
     "@types/sinon": "^17.0.2",
-    "aegir": "^42.0.0",
+    "aegir": "^42.0.1",
     "blockstore-core": "^4.3.8",
     "delay": "^6.0.0",
     "it-all": "^3.0.4",

diff --git a/packages/block-brokers/typedoc.json b/packages/block-brokers/typedoc.json
@@ -1,7 +1,5 @@
 {
   "entryPoints": [
-    "./src/index.ts",
-    "./src/utils/default-hashers.ts"
-  ],
-  "includeVersion": true
+    "./src/index.ts"
+  ]
 }
diff --git a/packages/car/README.md b/packages/car/README.md
@@ -8,8 +8,8 @@
 
 [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
 [![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
-[![codecov](https://img.shields.io/codecov/c/github/ipfs/helia-car.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia-car)
-[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia-car/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/ipfs/helia-car/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
+[![codecov](https://img.shields.io/codecov/c/github/ipfs/helia.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia)
+[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia/main.yml?branch=main\&style=flat-square)](https://github.com/ipfs/helia/actions/workflows/main.yml?query=branch%3Amain)
 
 > Import/export car files from Helia
 
@@ -87,7 +87,7 @@ Loading this module through a script tag will make it's exports available as `He
 
 # API Docs
 
-- <https://ipfs.github.io/helia-car/modules/_helia_car.html>
+- <https://ipfs.github.io/helia/modules/_helia_car.html>
 
 # License
 
@@ -98,7 +98,7 @@ Licensed under either of
 
 # Contribute
 
-Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia-car/issues).
+Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia/issues).
 
 Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
 

diff --git a/packages/car/package.json b/packages/car/package.json
@@ -3,13 +3,13 @@
   "version": "2.0.0",
   "description": "Import/export car files from Helia",
   "license": "Apache-2.0 OR MIT",
-  "homepage": "https://github.com/ipfs/helia-car/tree/main/packages/car#readme",
+  "homepage": "https://github.com/ipfs/helia/tree/main/packages/car#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/ipfs/helia-car.git"
+    "url": "git+https://github.com/ipfs/helia.git"
   },
   "bugs": {
-    "url": "https://github.com/ipfs/helia-car/issues"
+    "url": "https://github.com/ipfs/helia/issues"
   },
   "publishConfig": {
     "access": "public",
@@ -20,22 +20,6 @@
   ],
   "type": "module",
   "types": "./dist/src/index.d.ts",
-  "typesVersions": {
-    "*": {
-      "*": [
-        "*",
-        "dist/*",
-        "dist/src/*",
-        "dist/src/*/index"
-      ],
-      "src/*": [
-        "*",
-        "dist/*",
-        "dist/src/*",
-        "dist/src/*/index"
-      ]
-    }
-  },
   "files": [
     "src",
     "dist",
@@ -157,7 +141,7 @@
   "dependencies": {
     "@helia/interface": "^3.0.0",
     "@ipld/car": "^5.1.1",
-    "@ipld/dag-pb": "^4.0.0",
+    "@ipld/dag-pb": "^4.0.3",
     "@libp2p/interfaces": "^3.3.1",
     "cborg": "^4.0.3",
     "it-drain": "^3.0.5",
@@ -170,9 +154,9 @@
   "devDependencies": {
     "@helia/unixfs": "^2.0.0",
     "aegir": "^42.0.1",
-    "blockstore-core": "^4.0.1",
+    "blockstore-core": "^4.3.8",
     "interface-blockstore": "^5.2.9",
-    "ipfs-unixfs-importer": "^15.1.0",
+    "ipfs-unixfs-importer": "^15.2.3",
     "it-to-buffer": "^4.0.2"
   }
 }
diff --git a/packages/car/tsconfig.json b/packages/car/tsconfig.json
@@ -6,5 +6,13 @@
   "include": [
     "src",
     "test"
+  ],
+  "references": [
+    {
+      "path": "../interface"
+    },
+    {
+      "path": "../unixfs"
+    }
   ]
 }
diff --git a/packages/dag-cbor/README.md b/packages/dag-cbor/README.md
@@ -8,8 +8,8 @@
 
 [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
 [![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
-[![codecov](https://img.shields.io/codecov/c/github/ipfs/helia-dag-cbor.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia-dag-cbor)
-[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia-dag-cbor/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/ipfs/helia-dag-cbor/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
+[![codecov](https://img.shields.io/codecov/c/github/ipfs/helia.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia)
+[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia/main.yml?branch=main\&style=flat-square)](https://github.com/ipfs/helia/actions/workflows/main.yml?query=branch%3Amain)
 
 > Add/get IPLD blocks containing dag-cbor with your Helia node
 
@@ -52,7 +52,7 @@ Loading this module through a script tag will make it's exports available as `He
 
 # API Docs
 
-- <https://ipfs.github.io/helia-dag-cbor/modules/_helia_dag_cbor.html>
+- <https://ipfs.github.io/helia/modules/_helia_dag_cbor.html>
 
 # License
 
@@ -63,7 +63,7 @@ Licensed under either of
 
 # Contribute
 
-Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia-dag-cbor/issues).
+Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia/issues).
 
 Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
 

diff --git a/packages/dag-cbor/package.json b/packages/dag-cbor/package.json
@@ -3,13 +3,13 @@
   "version": "2.0.0",
   "description": "Add/get IPLD blocks containing dag-cbor with your Helia node",
   "license": "Apache-2.0 OR MIT",
-  "homepage": "https://github.com/ipfs/helia-dag-cbor/tree/main/packages/dag-cbor#readme",
+  "homepage": "https://github.com/ipfs/helia/tree/main/packages/dag-cbor#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/ipfs/helia-dag-cbor.git"
+    "url": "git+https://github.com/ipfs/helia.git"
   },
   "bugs": {
-    "url": "https://github.com/ipfs/helia-dag-cbor/issues"
+    "url": "https://github.com/ipfs/helia/issues"
   },
   "publishConfig": {
     "access": "public",
@@ -148,7 +148,7 @@
   },
   "devDependencies": {
     "aegir": "^42.0.1",
-    "blockstore-core": "^4.0.1",
-    "interface-blockstore": "^5.0.0"
+    "blockstore-core": "^4.3.8",
+    "interface-blockstore": "^5.2.9"
   }
 }
diff --git a/packages/dag-cbor/tsconfig.json b/packages/dag-cbor/tsconfig.json
@@ -6,5 +6,10 @@
   "include": [
     "src",
     "test"
+  ],
+  "references": [
+    {
+      "path": "../interface"
+    }
   ]
 }
diff --git a/packages/dag-json/README.md b/packages/dag-json/README.md
@@ -8,8 +8,8 @@
 
 [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
 [![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
-[![codecov](https://img.shields.io/codecov/c/github/ipfs/helia-dag-json.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia-dag-json)
-[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia-dag-json/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/ipfs/helia-dag-json/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
+[![codecov](https://img.shields.io/codecov/c/github/ipfs/helia.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia)
+[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia/main.yml?branch=main\&style=flat-square)](https://github.com/ipfs/helia/actions/workflows/main.yml?query=branch%3Amain)
 
 > Add/get IPLD blocks containing dag-json with your Helia node
 
@@ -52,7 +52,7 @@ Loading this module through a script tag will make it's exports available as `He
 
 # API Docs
 
-- <https://ipfs.github.io/helia-dag-json/modules/_helia_dag_json.html>
+- <https://ipfs.github.io/helia/modules/_helia_dag_json.html>
 
 # License
 
@@ -63,7 +63,7 @@ Licensed under either of
 
 # Contribute
 
-Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia-dag-json/issues).
+Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia/issues).
 
 Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
 

diff --git a/packages/dag-json/package.json b/packages/dag-json/package.json
@@ -3,13 +3,13 @@
   "version": "2.0.0",
   "description": "Add/get IPLD blocks containing dag-json with your Helia node",
   "license": "Apache-2.0 OR MIT",
-  "homepage": "https://github.com/ipfs/helia-dag-json/tree/main/packages/dag-json#readme",
+  "homepage": "https://github.com/ipfs/helia/tree/main/packages/dag-json#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/ipfs/helia-dag-json.git"
+    "url": "git+https://github.com/ipfs/helia.git"
   },
   "bugs": {
-    "url": "https://github.com/ipfs/helia-dag-json/issues"
+    "url": "https://github.com/ipfs/helia/issues"
   },
   "publishConfig": {
     "access": "public",
@@ -147,7 +147,7 @@
   },
   "devDependencies": {
     "aegir": "^42.0.1",
-    "blockstore-core": "^4.0.1",
-    "interface-blockstore": "^5.0.0"
+    "blockstore-core": "^4.3.8",
+    "interface-blockstore": "^5.2.9"
   }
 }
diff --git a/packages/dag-json/tsconfig.json b/packages/dag-json/tsconfig.json
@@ -6,5 +6,10 @@
   "include": [
     "src",
     "test"
+  ],
+  "references": [
+    {
+      "path": "../interface"
+    }
   ]
 }
diff --git a/packages/helia/README.md b/packages/helia/README.md
@@ -30,32 +30,32 @@ const fs = unixfs(helia)
 fs.cat(CID.parse('bafyFoo'))
 ```
 
-## Install
+# Install
 
 ```console
 $ npm i helia
 ```
 
-### Browser `<script>` tag
+## Browser `<script>` tag
 
 Loading this module through a script tag will make it's exports available as `Helia` in the global namespace.
 
 ```html
 <script src="https://unpkg.com/helia/dist/index.min.js"></script>
 ```
 
-## API Docs
+# API Docs
 
 - <https://ipfs.github.io/helia/modules/helia.html>
 
-## License
+# License
 
 Licensed under either of
 
 - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
 - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
-## Contribute
+# Contribute
 
 Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia/issues).