corestore 6.3.0 → 6.4.1

package/README.md

@@ -1,12 +1,14 @@
 # Corestore
 
+### [See the full API docs at docs.holepunch.to](https://docs.holepunch.to/building-blocks/corestore)
+
 Corestore is a Hypercore factory that makes it easier to manage large collections of named Hypercores.
 
 Corestore provides:
 1. __Key Derivation__ - All writable Hypercore keys are derived from a single master key and a user-provided name.
 2. __Session Handling__ - If a single Hypercore is loaded multiple times through the `get` method, the underlying resources will only be opened once (using Hypercore 10's new session feature). Once all sessions are closed, the resources will be released.
 3. __Storage Management__ - Hypercores can be stored in any random-access-storage instance, where they will be keyed by their discovery keys.
-4. __Namespacing__ - You can share a single Corestore instance between multiple applications or components without worrying about naming collisions by creating "namespaces" (e.g. `corestore.namespace('my-app').get({ name: 'main' }) 
+4. __Namespacing__ - You can share a single Corestore instance between multiple applications or components without worrying about naming collisions by creating "namespaces" (e.g. `corestore.namespace('my-app').get({ name: 'main' })`)
 
 ### Installation
 `npm install corestore`
@@ -43,7 +45,7 @@ Corestore replicates in an "all-to-all" fashion, meaning that when replication b
 
 If the remote side dynamically adds a new Hypercore to the replication stream, Corestore will load and replicate that core if possible.
 
-Using [Hyperswarm](https://github.com/hyperswarm/hyperswarm) you can easily replicate corestores
+Using [Hyperswarm](https://github.com/holepunchto/hyperswarm) you can easily replicate corestores
 
 ``` js
 const swarm = new Hyperswarm()
@@ -79,6 +81,14 @@ Useful when an application wants to accept an optional Corestore, but needs to m
 }
 ```
 
+#### `store.on('core-open', core)`
+Emitted when the first session for a core is opened.
+
+*Note: This core may close at any time, so treat it as a weak reference*
+
+#### `store.on('core-close', core)`
+Emitted when the last session for a core is closed.
+
 ### License
 MIT
 

package/index.js

@@ -201,6 +201,7 @@ module.exports = class Corestore extends EventEmitter {
     this.cores.set(id, core)
     core.ready().then(() => {
       if (core.closing) return // extra safety here as ready is a tick after open
+      this.emit('core-open', core)
       for (const { stream } of this._replicationStreams) {
         core.replicate(stream, { session: true })
       }
@@ -208,6 +209,7 @@ module.exports = class Corestore extends EventEmitter {
       this.cores.delete(id)
     })
     core.once('close', () => {
+      this.emit('core-close', core)
       this.cores.delete(id)
     })
     core.on('conflict', (len, fork, proof) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "corestore",
-  "version": "6.3.0",
+  "version": "6.4.1",
   "description": "A Hypercore factory that simplifies managing collections of cores.",
   "main": "index.js",
   "scripts": {
@@ -8,7 +8,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/hypercore-protocol/corestore.git"
+    "url": "git+https://github.com/holepunchto/corestore.git"
   },
   "keywords": [
     "corestore"
@@ -16,9 +16,9 @@
   "author": "Andrew Osheroff <andrewosh@gmail.com>",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/hypercore-protocol/corestore/issues"
+    "url": "https://github.com/holepunchto/corestore/issues"
   },
-  "homepage": "https://github.com/hypercore-protocol/corestore#readme",
+  "homepage": "https://github.com/holepunchto/corestore#readme",
   "files": [
     "index.js",
     "lib/**.js"
@@ -33,7 +33,7 @@
     "hypercore": "^10.5.3",
     "hypercore-crypto": "^3.2.1",
     "safety-catch": "^1.0.1",
-    "sodium-universal": "^3.0.4",
+    "sodium-universal": "^4.0.0",
     "xache": "^1.1.0"
   }
 }