ipfs · achingbrain · Jan 8, 2024 · Feb 16, 2023 · Feb 17, 2023 · Feb 17, 2023
@@ -5,7 +5,7 @@ updates:
   schedule:
     interval: daily
     time: "10:00"
-  open-pull-requests-limit: 10
+  open-pull-requests-limit: 20
   commit-message:
     prefix: "deps"
     prefix-development: "deps(dev)"

@@ -173,7 +173,7 @@ jobs:
       id-token: write
       pull-requests: write
     steps:
-      - uses: google-github-actions/release-please-action@v4
+      - uses: google-github-actions/release-please-action@v3
         id: release
         with:
           token: ${{ secrets.UCI_GITHUB_TOKEN || github.token }}

@@ -1 +1,14 @@
-{"packages/block-brokers":"0.0.0", "packages/helia":"3.0.0","packages/interface":"3.0.0","packages/interop":"2.0.0"}
+{
+  "packages/block-brokers":"0.0.0",
+  "packages/car":"2.0.0",
+  "packages/dag-cbor":"2.0.0",
+  "packages/dag-json":"2.0.0",
+  "packages/helia":"3.0.0",
+  "packages/interface":"3.0.0",
+  "packages/interop":"2.0.0",
+  "packages/ipns":"4.0.0",
+  "packages/json":"2.0.0",
+  "packages/mfs":"2.0.0",
+  "packages/strings":"2.0.0",
+  "packages/unixfs":"2.0.0"
+}
@@ -3,8 +3,16 @@
   "last-release-sha": "456f6841aa4f6f27cb9b8636c90a1765a3018878",
   "packages": {
     "packages/block-brokers": {},
+    "packages/car": {},
+    "packages/dag-cbor": {},
+    "packages/dag-json": {},
     "packages/helia": {},
     "packages/interface": {},
-    "packages/interop": {}
+    "packages/interop": {},
+    "packages/ipns": {},
+    "packages/json": {},
+    "packages/mfs": {},
+    "packages/strings": {},
+    "packages/unixfs": {}
   }
 }
@@ -158,28 +158,49 @@ graph TD;
 ```
 
 # 🏭 Code Structure
-Helia embraces a modular approach and encourages users to bring their own implementations of interfacing libraries to suit their needs. Helia also ships supplemental libraries and tools including:
 
-- [`@helia/UnixFS`](https://github.com/ipfs/helia-unixfs)
-- [`@helia/mfs`](https://github.com/ipfs/helia-mfs)
-- [`@helia/ipns`](https://github.com/ipfs/helia-ipns)
-- [`@helia/car`](https://github.com/ipfs/helia-car)
-- [`@helia/strings`](https://github.com/ipfs/helia-strings)
-- [`@helia/json`](https://github.com/ipfs/helia-json)
-- [`@helia/dag-json`](https://github.com/ipfs/helia-dag-json)
-- [`@helia/dag-cbor`](https://github.com/ipfs/helia-dag-cbor)
+Helia embraces a modular approach and encourages users to bring their own implementations of various APIs to suit their needs.
 
-These libraries are by no means the "one true implementation", but instead instead provide optionality depending on one's needs.
+The basic Helia API is defined in:
 
-This repo itself is made up of these packages:
 - [`/packages/interface`](./packages/interface) The Helia API
+
+The API is implemented by:
+
 - [`/packages/helia`](./packages/helia) An implementation of the Helia API
+
+Helia also ships a number of supplemental libraries and tools.
+
+These libraries are not intended to be the "one true implementation" of any given API, but are made available for users to include depending on the need of their particular application:
+
+- [./packages/unixfs](./packages/unixfs) The `@helia/unixfs` module
+- [./packages/mfs](./packages/mfs) The `@helia/mfs` module
+- [./packages/ipns](./packages/ipns) `@helia/ipns`
+- [./packages/car](./packages/car) `@helia/car`
+- [./packages/strings](./packages/strings) `@helia/strings`
+- [./packages/json](./packages/json) `@helia/json`
+- [./packages/dag-json](./packages/dag-json) `@helia/dag-json`
+- [./packages/dag-cbor](./packages/dag-cbor) `@helia/dag-cbor`
+
+An interface suite ensures everything is compatible:
+
 - [`/packages/interop`](./packages/interop) Interop tests for Helia
 
+## Other modules
+
+There are several other modules available outside this repo:
+
+- [`@helia/delegated-routing-v1-http-api`](https://github.com/ipfs/helia-delegated-routing-v1-http-api) An implementation of the [Delegated Routing v1 HTTP API](https://specs.ipfs.tech/routing/http-routing-v1/) including a server and a client
+- [Helia WNFS](https://github.com/shovelers/helia-wnfs) a [WNFS](https://guide.fission.codes/developers/webnative/file-system-wnfs) implementation built on top of Helia
+- [`@helia/remote-pinning`](https://github.com/ipfs/helia-remote-pinning) A Helia client for communicating with [IPFS Pinning Services](https://ipfs.github.io/pinning-services-api-spec/)
+- [`@helia/http-gateway`](https://github.com/ipfs/helia-http-gateway) An implentation of the [IPFS HTTP Gateway API](https://docs.ipfs.tech/concepts/ipfs-gateway/#gateway-types) built with Helia
+
 # 📣 Project status
+
 Helia v1 shipped in 202303 (see [releases](https://github.com/ipfs/helia/releases)), and development keeps on trucking as we work on initiatives in the [roadmap](#roadmap) and make performance improvements and bug fixes along the way.
 
 # 🛣️ Roadmap
+
 Please find and comment on [the Roadmap here](https://github.com/ipfs/helia/issues/5).
 
 # 👫 Get involved

@@ -1,6 +1,6 @@
 {
   "name": "helia",
-  "version": "1.0.0",
+  "version": "0.0.0",
   "description": "An implementation of IPFS in JavaScript",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/ipfs/helia#readme",
@@ -38,8 +38,7 @@
   },
   "devDependencies": {
     "aegir": "^42.0.0",
-    "npm-run-all": "^4.1.5",
-    "typedoc-plugin-mdn-links": "^3.0.3"
+    "npm-run-all": "^4.1.5"
   },
   "type": "module",
   "workspaces": [

@@ -0,0 +1,52 @@
+## [@helia/car-v2.0.0](https://github.com/ipfs/helia-car/compare/@helia/car-v1.0.4...@helia/car-v2.0.0) (2024-01-08)
+
+
+### ⚠ BREAKING CHANGES
+
+* uses multiformats v13 and helia v3
+
+### Features
+
+* update helia to v3 and multiformats to v13 ([#52](https://github.com/ipfs/helia-car/issues/52)) ([6405c34](https://github.com/ipfs/helia-car/commit/6405c3487879614dc4dd7308b15c946d644e0488))
+
+## [@helia/car-v1.0.4](https://github.com/ipfs/helia-car/compare/@helia/car-v1.0.3...@helia/car-v1.0.4) (2023-10-07)
+
+
+### Dependencies
+
+* **dev:** bump aegir from 40.0.13 to 41.0.0 ([#41](https://github.com/ipfs/helia-car/issues/41)) ([e8fc99f](https://github.com/ipfs/helia-car/commit/e8fc99f4e372eaf72c2598f5a7a9942143c6d788))
+
+## [@helia/car-v1.0.3](https://github.com/ipfs/helia-car/compare/@helia/car-v1.0.2...@helia/car-v1.0.3) (2023-08-27)
+
+
+### Dependencies
+
+* bump @helia/interface from 1.2.2 to 2.0.0 ([#32](https://github.com/ipfs/helia-car/issues/32)) ([68656a8](https://github.com/ipfs/helia-car/commit/68656a81b7cd1238641a41573915635905e4a6ed))
+* bump cborg from 1.10.2 to 2.0.5 ([#35](https://github.com/ipfs/helia-car/issues/35)) ([10994ea](https://github.com/ipfs/helia-car/commit/10994ea9abdff8906ae8c3f7d0ff5f50b50d9e60))
+* bump multiformats from 11.0.2 to 12.0.1 ([#4](https://github.com/ipfs/helia-car/issues/4)) ([50bed0f](https://github.com/ipfs/helia-car/commit/50bed0f32b3c07111de804b0e6471e36d8e66626))
+
+## [@helia/car-v1.0.2](https://github.com/ipfs/helia-car/compare/@helia/car-v1.0.1...@helia/car-v1.0.2) (2023-08-27)
+
+
+### Dependencies
+
+* **dev:** bump aegir from 39.0.13 to 40.0.11 ([#30](https://github.com/ipfs/helia-car/issues/30)) ([ea26a0b](https://github.com/ipfs/helia-car/commit/ea26a0bd14137eb1de6ab282cdcecd55578064ab))
+
+## [@helia/car-v1.0.1](https://github.com/ipfs/helia-car/compare/@helia/car-v1.0.0...@helia/car-v1.0.1) (2023-08-14)
+
+
+### Documentation
+
+* fs already defined in example ([#1](https://github.com/ipfs/helia-car/issues/1)) ([356797a](https://github.com/ipfs/helia-car/commit/356797a9493c7753178b5f343962951bc9cd3052))
+
+## @helia/car-v1.0.0 (2023-06-07)
+
+
+### Bug Fixes
+
+* import from multiformats/cid for smaller bundles ([0857d1f](https://github.com/ipfs/helia-car/commit/0857d1f76cd7403dbea46cf3d9c891543fc83fe1))
+
+
+### Trivial Changes
+
+* fix linting ([3803a37](https://github.com/ipfs/helia-car/commit/3803a378c0d7a556248e39e7a3c756e94e69888d))
@@ -0,0 +1,4 @@
+This project is dual licensed under MIT and Apache-2.0.
+
+MIT: https://www.opensource.org/licenses/mit
+Apache-2.0: https://www.apache.org/licenses/license-2.0
@@ -0,0 +1,5 @@
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
@@ -0,0 +1,109 @@
+<p align="center">
+  <a href="https://github.com/ipfs/helia" title="Helia">
+    <img src="https://raw.githubusercontent.com/ipfs/helia/main/assets/helia.png" alt="Helia logo" width="300" />
+  </a>
+</p>
+
+# @helia/car
+
+[![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)
+
+> Import/export car files from Helia
+
+# About
+
+`@helia/car` provides `import` and `export` methods to read/write Car files to Helia's blockstore.
+
+See the Car interface for all available operations.
+
+By default it supports `dag-pb`, `dag-cbor`, `dag-json` and `raw` CIDs, more esoteric DAG walkers can be passed as an init option.
+
+## Example - Exporting a DAG as a CAR file
+
+```typescript
+import { createHelia } from 'helia'
+import { unixfs } from '@helia/unixfs'
+import { car } from '@helia/car'
+import { CarWriter } from '@ipld/car'
+import { Readable } from 'node:stream'
+import nodeFs from 'node:fs'
+
+const helia = createHelia({
+  // ... helia config
+})
+const fs = unixfs(helia)
+
+// add some UnixFS data
+const cid = await fs.addBytes(fileData1)
+
+// export it as a Car
+const c = car(helia)
+const { writer, out } = await CarWriter.create(cid)
+
+// `out` needs to be directed somewhere, see the @ipld/car docs for more information
+Readable.from(out).pipe(nodeFs.createWriteStream('example.car'))
+
+// write the DAG behind `cid` into the writer
+await c.export(cid, writer)
+```
+
+## Example - Importing all blocks from a CAR file
+
+```typescript
+import { createHelia } from 'helia'
+import { unixfs } from '@helia/unixfs'
+import { car } from '@helia/car'
+import { CarReader } from '@ipld/car'
+import { Readable } from 'node:stream'
+import nodeFs from 'node:fs'
+
+const helia = createHelia({
+  // ... helia config
+})
+
+// import the car
+const inStream = nodeFs.createReadStream('example.car')
+const reader = await CarReader.fromIterable(inStream)
+
+await c.import(reader)
+```
+
+# Install
+
+```console
+$ npm i @helia/car
+```
+
+## Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `HeliaCar` in the global namespace.
+
+```html
+<script src="https://unpkg.com/@helia/car/dist/index.min.js"></script>
+```
+
+# API Docs
+
+- <https://ipfs.github.io/helia-car/modules/_helia_car.html>
+
+# 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
+
+Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia-car/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.
+
+Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
+
+[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)