chore: rename @helia/core to @helia/utils (#390)

Utils is probably a better name as it has a strong implication that it's not to be used on it's own whereas `@helia/core` is too close to `ipfs-core` which we did want people to use on it's own.
ipfs · Jan 17, 2024 · 163df38 · 163df38
1 parent a2229bd
commit 163df38
Show file tree

Hide file tree

Showing 45 changed files with 49 additions and 37 deletions.
diff --git a/.release-please.json b/.release-please.json
@@ -4,7 +4,6 @@
   "packages": {
     "packages/block-brokers": {},
     "packages/car": {},
-    "packages/core": {},
     "packages/dag-cbor": {},
     "packages/dag-json": {},
     "packages/helia": {},
@@ -16,6 +15,7 @@
     "packages/mfs": {},
     "packages/routers": {},
     "packages/strings": {},
-    "packages/unixfs": {}
+    "packages/unixfs": {},
+    "packages/utils": {}
   }
 }
diff --git a/packages/car/package.json b/packages/car/package.json
@@ -140,10 +140,10 @@
   },
   "dependencies": {
     "@helia/interface": "^3.0.1",
-    "@ipld/car": "^5.1.1",
+    "@ipld/car": "^5.2.5",
     "@libp2p/interfaces": "^3.3.1",
     "it-drain": "^3.0.5",
-    "it-map": "^3.0.3",
+    "it-map": "^3.0.5",
     "multiformats": "^13.0.0",
     "p-defer": "^4.0.0",
     "p-queue": "^8.0.1",

diff --git a/packages/core/src/version.ts b/packages/core/src/version.ts
diff --git a/packages/dag-cbor/package.json b/packages/dag-cbor/package.json
@@ -141,7 +141,7 @@
   },
   "dependencies": {
     "@helia/interface": "^3.0.1",
-    "@ipld/dag-cbor": "^9.0.6",
+    "@ipld/dag-cbor": "^9.0.7",
     "@libp2p/interfaces": "^3.3.1",
     "multiformats": "^13.0.0",
     "progress-events": "^1.0.0"

diff --git a/packages/helia/package.json b/packages/helia/package.json
@@ -58,10 +58,10 @@
     "@chainsafe/libp2p-noise": "^14.0.0",
     "@chainsafe/libp2p-yamux": "^6.0.1",
     "@helia/block-brokers": "^1.0.0",
-    "@helia/core": "^0.0.0",
     "@helia/delegated-routing-v1-http-api-client": "^2.0.2",
     "@helia/interface": "^3.0.1",
     "@helia/routers": "^0.0.0",
+    "@helia/utils": "^0.0.0",
     "@libp2p/autonat": "^1.0.1",
     "@libp2p/bootstrap": "^10.0.2",
     "@libp2p/circuit-relay-v2": "^1.0.2",
@@ -77,7 +77,7 @@
     "@libp2p/tcp": "^9.0.2",
     "@libp2p/upnp-nat": "^1.0.1",
     "@libp2p/webrtc": "^4.0.3",
-    "@libp2p/websockets": "^8.0.2",
+    "@libp2p/websockets": "^8.0.10",
     "@libp2p/webtransport": "^4.0.3",
     "blockstore-core": "^4.3.8",
     "datastore-core": "^9.2.6",

diff --git a/packages/helia/src/helia-p2p.ts b/packages/helia/src/helia-p2p.ts
@@ -1,4 +1,4 @@
-import { Helia, type HeliaInit } from '@helia/core'
+import { Helia, type HeliaInit } from '@helia/utils'
 import type { BlockBroker } from './index.js'
 import type { Libp2p } from '@libp2p/interface'
 import type { Blockstore } from 'interface-blockstore'

diff --git a/packages/helia/src/index.ts b/packages/helia/src/index.ts
@@ -27,7 +27,7 @@ import { HeliaP2P } from './helia-p2p.js'
 import { libp2pDefaults } from './utils/libp2p-defaults.js'
 import { createLibp2p } from './utils/libp2p.js'
 import type { DefaultLibp2pServices } from './utils/libp2p-defaults.js'
-import type { Helia } from '@helia/core'
+import type { Helia } from '@helia/interface'
 import type { BlockBroker } from '@helia/interface/blocks'
 import type { ComponentLogger, Libp2p } from '@libp2p/interface'
 import type { KeychainInit } from '@libp2p/keychain'

diff --git a/packages/helia/tsconfig.json b/packages/helia/tsconfig.json
@@ -11,14 +11,14 @@
     {
       "path": "../block-brokers"
     },
-    {
-      "path": "../core"
-    },
     {
       "path": "../interface"
     },
     {
       "path": "../routers"
+    },
+    {
+      "path": "../utils"
     }
   ]
 }
diff --git a/packages/http/package.json b/packages/http/package.json
@@ -54,9 +54,9 @@
   },
   "dependencies": {
     "@helia/block-brokers": "^1.0.0",
-    "@helia/core": "^0.0.0",
     "@helia/interface": "^3.0.1",
     "@helia/routers": "^0.0.0",
+    "@helia/utils": "^0.0.0",
     "blockstore-core": "^4.3.8",
     "datastore-core": "^9.2.6"
   },

diff --git a/packages/http/src/index.ts b/packages/http/src/index.ts
@@ -44,8 +44,8 @@
  */
 
 import { trustlessGateway } from '@helia/block-brokers'
-import { Helia as HeliaClass, type HeliaInit } from '@helia/core'
 import { delegatedHTTPRouting } from '@helia/routers'
+import { Helia as HeliaClass, type HeliaInit } from '@helia/utils'
 import { MemoryBlockstore } from 'blockstore-core'
 import { MemoryDatastore } from 'datastore-core'
 import type { Helia } from '@helia/interface'

diff --git a/packages/http/tsconfig.json b/packages/http/tsconfig.json
@@ -11,14 +11,14 @@
     {
       "path": "../block-brokers"
     },
-    {
-      "path": "../core"
-    },
     {
       "path": "../interface"
     },
     {
       "path": "../routers"
+    },
+    {
+      "path": "../utils"
     }
   ]
 }
diff --git a/packages/interface/README.md b/packages/interface/README.md
@@ -11,6 +11,20 @@
 
 > The Helia API
 
+# About
+
+The API defined by a Helia node
+
+## Example
+
+```typescript
+import type { Helia } from '@helia/interface'
+
+export function doSomething(helia: Helia) {
+  // use helia node functions here
+}
+```
+
 # Install
 
 ```console

diff --git a/packages/interop/package.json b/packages/interop/package.json
@@ -70,7 +70,7 @@
     "@ipld/dag-cbor": "^9.0.7",
     "@libp2p/interface": "^1.1.1",
     "@libp2p/kad-dht": "^12.0.2",
-    "@libp2p/peer-id": "^4.0.3",
+    "@libp2p/peer-id": "^4.0.5",
     "@libp2p/peer-id-factory": "^4.0.3",
     "@libp2p/websockets": "^8.0.10",
     "@multiformats/sha3": "^3.0.0",

diff --git a/packages/ipns/package.json b/packages/ipns/package.json
@@ -168,20 +168,20 @@
     "@libp2p/interface": "^1.1.1",
     "@libp2p/kad-dht": "^12.0.2",
     "@libp2p/logger": "^4.0.4",
-    "@libp2p/peer-id": "^4.0.4",
+    "@libp2p/peer-id": "^4.0.5",
     "dns-over-http-resolver": "^3.0.0",
     "dns-packet": "^5.6.0",
     "hashlru": "^2.3.0",
     "interface-datastore": "^8.2.9",
-    "ipns": "^8.0.0",
+    "ipns": "^8.0.3",
     "is-ipfs": "^8.0.1",
     "multiformats": "^13.0.0",
     "p-queue": "^8.0.1",
     "progress-events": "^1.0.0",
     "uint8arrays": "^5.0.1"
   },
   "devDependencies": {
-    "@libp2p/peer-id-factory": "^4.0.3",
+    "@libp2p/peer-id-factory": "^4.0.5",
     "@types/dns-packet": "^5.6.4",
     "aegir": "^42.1.0",
     "datastore-core": "^9.2.7",

diff --git a/packages/mfs/package.json b/packages/mfs/package.json
@@ -146,11 +146,11 @@
     "interface-datastore": "^8.2.9",
     "ipfs-unixfs": "^11.0.0",
     "ipfs-unixfs-exporter": "^13.1.0",
-    "ipfs-unixfs-importer": "^15.1.0",
+    "ipfs-unixfs-importer": "^15.2.3",
     "multiformats": "^13.0.0"
   },
   "devDependencies": {
-    "@ipld/dag-pb": "^4.0.7",
+    "@ipld/dag-pb": "^4.0.8",
     "aegir": "^42.1.0",
     "blockstore-core": "^4.3.10",
     "datastore-core": "^9.2.7",

diff --git a/packages/unixfs/README.md b/packages/unixfs/README.md
@@ -17,7 +17,7 @@
 
 `@helia/unixfs` is an implementation of a filesystem compatible with Helia.
 
-See the interface for all available operations.
+See the [API docs](https://ipfs.github.io/helia/modules/_helia_unixfs.html) for all available operations.
 
 ## Example - Creating files and directories
 

diff --git a/packages/unixfs/package.json b/packages/unixfs/package.json
@@ -167,9 +167,9 @@
     "hamt-sharding": "^3.0.2",
     "ipfs-unixfs": "^11.0.0",
     "ipfs-unixfs-exporter": "^13.1.0",
-    "ipfs-unixfs-importer": "^15.1.0",
+    "ipfs-unixfs-importer": "^15.2.3",
     "it-glob": "^2.0.4",
-    "it-last": "^3.0.1",
+    "it-last": "^3.0.4",
     "it-pipe": "^3.0.1",
     "merge-options": "^3.0.4",
     "multiformats": "^13.0.0",

diff --git a/packages/core/CHANGELOG.md → packages/utils/CHANGELOG.md b/packages/core/CHANGELOG.md → packages/utils/CHANGELOG.md
diff --git a/packages/core/LICENSE → packages/utils/LICENSE b/packages/core/LICENSE → packages/utils/LICENSE
diff --git a/packages/core/LICENSE-APACHE → packages/utils/LICENSE-APACHE b/packages/core/LICENSE-APACHE → packages/utils/LICENSE-APACHE
diff --git a/packages/core/LICENSE-MIT → packages/utils/LICENSE-MIT b/packages/core/LICENSE-MIT → packages/utils/LICENSE-MIT
diff --git a/packages/core/README.md → packages/utils/README.md b/packages/core/README.md → packages/utils/README.md
@@ -21,7 +21,7 @@ pre-configure Helia for certain use-cases (p2p or pure-HTTP).
 ## Example
 
 ```typescript
-import { Helia } from '@helia/core'
+import { Helia } from '@helia/utils'
 
 const node = new Helia({
   // ...options
@@ -31,20 +31,20 @@ const node = new Helia({
 # Install
 
 ```console
-$ npm i @helia/core
+$ npm i @helia/utils
 ```
 
 ## Browser `<script>` tag
 
-Loading this module through a script tag will make it's exports available as `HeliaCore` in the global namespace.
+Loading this module through a script tag will make it's exports available as `HeliaUtils` in the global namespace.
 
 ```html
-<script src="https://unpkg.com/@helia/core/dist/index.min.js"></script>
+<script src="https://unpkg.com/@helia/utils/dist/index.min.js"></script>
 ```
 
 # API Docs
 
-- <https://ipfs.github.io/helia/modules/_helia_core.html>
+- <https://ipfs.github.io/helia/modules/_helia_utils.html>
 
 # License
 

diff --git a/packages/core/package.json → packages/utils/package.json b/packages/core/package.json → packages/utils/package.json
@@ -1,9 +1,9 @@
 {
-  "name": "@helia/core",
+  "name": "@helia/utils",
   "version": "0.0.0",
   "description": "Shared code that implements the Helia API",
   "license": "Apache-2.0 OR MIT",
-  "homepage": "https://github.com/ipfs/helia/tree/main/packages/core#readme",
+  "homepage": "https://github.com/ipfs/helia/tree/main/packages/utils#readme",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ipfs/helia.git"
@@ -54,7 +54,7 @@
   },
   "dependencies": {
     "@helia/interface": "^3.0.1",
-    "@ipld/dag-cbor": "^9.0.6",
+    "@ipld/dag-cbor": "^9.0.7",
     "@ipld/dag-json": "^10.1.5",
     "@ipld/dag-pb": "^4.0.6",
     "@libp2p/interface": "^1.1.1",

diff --git a/packages/core/src/index.ts → packages/utils/src/index.ts b/packages/core/src/index.ts → packages/utils/src/index.ts
@@ -9,7 +9,7 @@
  * @example
  *
  * ```typescript
- * import { Helia } from '@helia/core'
+ * import { Helia } from '@helia/utils'
  *
  * const node = new Helia({
  *   // ...options

diff --git a/packages/core/src/pins.ts → packages/utils/src/pins.ts b/packages/core/src/pins.ts → packages/utils/src/pins.ts
diff --git a/packages/core/src/routing.ts → packages/utils/src/routing.ts b/packages/core/src/routing.ts → packages/utils/src/routing.ts
diff --git a/packages/core/src/storage.ts → packages/utils/src/storage.ts b/packages/core/src/storage.ts → packages/utils/src/storage.ts
diff --git a/packages/core/src/utils/dag-walkers.ts → packages/utils/src/utils/dag-walkers.ts b/packages/core/src/utils/dag-walkers.ts → packages/utils/src/utils/dag-walkers.ts
diff --git a/packages/core/src/utils/datastore-version.ts → ...ages/utils/src/utils/datastore-version.ts b/packages/core/src/utils/datastore-version.ts → ...ages/utils/src/utils/datastore-version.ts
diff --git a/packages/core/src/utils/default-hashers.ts → packages/utils/src/utils/default-hashers.ts b/packages/core/src/utils/default-hashers.ts → packages/utils/src/utils/default-hashers.ts
diff --git a/packages/core/src/utils/networked-storage.ts → ...ages/utils/src/utils/networked-storage.ts b/packages/core/src/utils/networked-storage.ts → ...ages/utils/src/utils/networked-storage.ts
diff --git a/packages/core/test/block-broker.spec.ts → packages/utils/test/block-broker.spec.ts b/packages/core/test/block-broker.spec.ts → packages/utils/test/block-broker.spec.ts
diff --git a/packages/core/test/fixtures/create-block.ts → packages/utils/test/fixtures/create-block.ts b/packages/core/test/fixtures/create-block.ts → packages/utils/test/fixtures/create-block.ts
diff --git a/packages/core/test/fixtures/create-dag.ts → packages/utils/test/fixtures/create-dag.ts b/packages/core/test/fixtures/create-dag.ts → packages/utils/test/fixtures/create-dag.ts
diff --git a/packages/core/test/fixtures/create-helia.ts → packages/utils/test/fixtures/create-helia.ts b/packages/core/test/fixtures/create-helia.ts → packages/utils/test/fixtures/create-helia.ts
diff --git a/packages/core/test/fixtures/dag-walker.ts → packages/utils/test/fixtures/dag-walker.ts b/packages/core/test/fixtures/dag-walker.ts → packages/utils/test/fixtures/dag-walker.ts
diff --git a/packages/core/test/gc.spec.ts → packages/utils/test/gc.spec.ts b/packages/core/test/gc.spec.ts → packages/utils/test/gc.spec.ts
diff --git a/packages/core/test/index.spec.ts → packages/utils/test/index.spec.ts b/packages/core/test/index.spec.ts → packages/utils/test/index.spec.ts
diff --git a/...ages/core/test/pins.depth-limited.spec.ts → ...ges/utils/test/pins.depth-limited.spec.ts b/...ages/core/test/pins.depth-limited.spec.ts → ...ges/utils/test/pins.depth-limited.spec.ts
diff --git a/packages/core/test/pins.recursive.spec.ts → packages/utils/test/pins.recursive.spec.ts b/packages/core/test/pins.recursive.spec.ts → packages/utils/test/pins.recursive.spec.ts
diff --git a/packages/core/test/pins.spec.ts → packages/utils/test/pins.spec.ts b/packages/core/test/pins.spec.ts → packages/utils/test/pins.spec.ts
diff --git a/packages/core/test/storage.spec.ts → packages/utils/test/storage.spec.ts b/packages/core/test/storage.spec.ts → packages/utils/test/storage.spec.ts
diff --git a/...core/test/utils/networked-storage.spec.ts → ...tils/test/utils/networked-storage.spec.ts b/...core/test/utils/networked-storage.spec.ts → ...tils/test/utils/networked-storage.spec.ts
diff --git a/packages/core/tsconfig.json → packages/utils/tsconfig.json b/packages/core/tsconfig.json → packages/utils/tsconfig.json
diff --git a/packages/core/typedoc.json → packages/utils/typedoc.json b/packages/core/typedoc.json → packages/utils/typedoc.json