autopass 3.2.0 → 3.4.0

package/README.md

@@ -71,19 +71,36 @@ Add new entry
 
 Remove an entry.
 
+#### `stream = pass.listWriters(query)`
+
+List all writers, optionally takes a hyperdb query
+
+#### `writer = await pass.getWriter(key)
+
+Get a writer, object similar to the addWriter input.
+
 #### `await pass.removeWriter(writerKey)`
 
 Remove a writer explictly.
 
-#### `await pass.addWriter(writerKey)`
+#### `await pass.addWriter(writer)`
 
 Add a writer explictly.
+Writer should look like this
+
+```
+{
+  key: otherSidesLocalWriterKey,
+  name: 'optional name for the writer',
+  readOnly: false // weather the person can write or only read
+}
+```
 
 #### `pass.writerKey`
 
 Get the local writer key.
 
-#### `inv = await pass.createInvite()`
+#### `inv = await pass.createInvite({ readOnly })`
 
 Get invite to add a writer.
 
@@ -127,7 +144,7 @@ Fully close the pass instance.
 
 Suspend the swarm and discovery
 
-#### `await pass.resume`
+#### `await pass.resume()`
 
 Resume the swarm is suspended
 

package/index.js

@@ -12,6 +12,12 @@ const { Router, encode, decode } = require('./spec/hyperdispatch')
 const BlindPeering = require('blind-peering')
 const db = require('./spec/db/index.js')
 const enc = require('hypercore-id-encoding')
+const c = require('compact-encoding')
+
+const { getEncoding } = require('./spec/schema/index.js')
+
+const PUBLIC_INVITE_METADATA = getEncoding('@autopass/public-invite-metadata')
+const INVITEE = getEncoding('@autopass/invitee')
 
 class AutopassPairer extends ReadyResource {
   constructor(store, invite, opts = {}) {
@@ -29,6 +35,7 @@ class AutopassPairer extends ReadyResource {
     this.pass = null
     this.relayThrough = opts.relayThrough || null
     this.blindEncryption = opts.blindEncryption || null
+    this.name = opts.name || null
 
     this.ready().catch(noop)
   }
@@ -54,9 +61,10 @@ class AutopassPairer extends ReadyResource {
     await core.ready()
     const key = core.key
     await core.close()
+
     this.candidate = this.pairing.addCandidate({
       invite: z32.decode(this.invite),
-      userData: key,
+      userData: c.encode(INVITEE, { key, name: this.name }),
       onadd: async (result) => {
         if (this.pass === null) {
           this.pass = new Autopass(this.store, {
@@ -70,14 +78,25 @@ class AutopassPairer extends ReadyResource {
 
           await this.pass.deleteInvite()
         }
+
+        const metadata = result.data ? c.decode(PUBLIC_INVITE_METADATA, result.data) : null
+
         this.swarm = null
         this.store = null
-        if (this.onresolve) this._whenWritable()
+        if (this.onresolve && metadata && metadata.readOnly) {
+          this._whenReadable()
+        } else if (this.onresolve) {
+          this._whenWritable()
+        }
         this.candidate.close().catch(noop)
       }
     })
   }
 
+  _whenReadable() {
+    this.onresolve(this.pass)
+  }
+
   _whenWritable() {
     if (this.pass.base.writable) return
     const check = () => {
@@ -136,11 +155,13 @@ class Autopass extends ReadyResource {
     this.debug = !!opts.key
     // Register handlers for commands
     this.router.add('@autopass/remove-writer', async (data, context) => {
+      await context.view.delete('@autopass/writer', data)
       await context.base.removeWriter(data.key)
     })
 
     this.router.add('@autopass/add-writer', async (data, context) => {
-      await context.base.addWriter(data.key)
+      await context.view.insert('@autopass/writer', data)
+      if (!data.readOnly) await context.base.addWriter(data.key)
     })
 
     this.router.add('@autopass/put', async (data, context) => {
@@ -238,14 +259,23 @@ class Autopass extends ReadyResource {
 
   async createInvite(opts) {
     if (this.opened === false) await this.ready()
+    const readOnly = opts?.readOnly ? true : false
     const existing = await this.base.view.findOne('@autopass/invite', {})
-    if (existing) {
+
+    if (existing && existing.readOnly !== readOnly) {
+      await this.deleteInvite()
+    } else if (existing) {
       if (this.member) await this.member.flushed()
       return z32.encode(existing.invite)
     }
-    const { id, invite, publicKey, expires } = BlindPairing.createInvite(this.base.key)
+    const { id, invite, publicKey, expires, additional } = BlindPairing.createInvite(
+      this.base.key,
+      {
+        data: c.encode(PUBLIC_INVITE_METADATA, { readOnly })
+      }
+    )
 
-    const record = { id, invite, publicKey, expires }
+    const record = { id, invite, publicKey, expires, readOnly, additional }
     await this.base.append(encode('@autopass/add-invite', record))
     if (this.member) await this.member.flushed()
     return z32.encode(record.invite)
@@ -271,19 +301,25 @@ class Autopass extends ReadyResource {
     return { value: data.value, file: data.file }
   }
 
-  async addWriter(key) {
-    await this.base.append(
-      encode('@autopass/add-writer', {
-        key: b4a.isBuffer(key) ? key : b4a.from(key)
-      })
-    )
+  listWriters(query) {
+    return this.base.view.find('@autopass/writer', query)
+  }
+
+  async getWriter(key) {
+    return this.base.view.get('@autopass/writer', { key })
+  }
+
+  async addWriter(data) {
+    if (typeof data === 'string') data = b4a.from(data, 'hex')
+    if (b4a.isBuffer(data)) data = { key: data, name: null, readOnly: false }
+    await this.base.append(encode('@autopass/add-writer', data))
     return true
   }
 
   async removeWriter(key) {
     await this.base.append(
       encode('@autopass/remove-writer', {
-        key: b4a.isBuffer(key) ? key : b4a.from(key)
+        key: b4a.isBuffer(key) ? key : b4a.from(key, 'hex')
       })
     )
   }
@@ -313,11 +349,14 @@ class Autopass extends ReadyResource {
         if (inv === null || !b4a.equals(inv.id, id)) {
           return
         }
+        const readOnly = inv.readOnly
         candidate.open(inv.publicKey)
-        await this.addWriter(candidate.userData)
+        const { key, name } = c.decode(INVITEE, candidate.userData)
+        await this.addWriter({ key, name, readOnly })
         candidate.confirm({
           key: this.base.key,
-          encryptionKey: this.base.encryptionKey
+          encryptionKey: this.base.encryptionKey,
+          additional: inv.additional
         })
         await this.deleteInvite()
       }

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "autopass",
-  "version": "3.2.0",
+  "version": "3.4.0",
   "main": "index.js",
   "scripts": {
-    "brittle": "npx brittle test.js",
-    "lint": "npx prettier . --check",
+    "brittle": "brittle test.js",
+    "lint": "prettier . --check",
+    "format": "prettier . --write",
     "test": "npm run lint && npm run brittle"
   },
   "author": "Holepunch Inc",

package/schema.js

@@ -4,9 +4,9 @@ const Hyperdispatch = require('hyperdispatch')
 
 // SCHEMA CREATION START //
 const autopass = Hyperschema.from('./spec/schema')
-const template = autopass.namespace('autopass')
+const pass = autopass.namespace('autopass')
 // You can find a list of supported data types here: https://github.com/holepunchto/compact-encoding
-template.register({
+pass.register({
   name: 'records',
   compact: false,
   fields: [
@@ -27,7 +27,7 @@ template.register({
     }
   ]
 })
-template.register({
+pass.register({
   name: 'mirrors',
   compact: false,
   fields: [
@@ -38,7 +38,7 @@ template.register({
     }
   ]
 })
-template.register({
+pass.register({
   name: 'writer',
   compact: false,
   fields: [
@@ -46,11 +46,19 @@ template.register({
       name: 'key',
       type: 'buffer',
       required: true
+    },
+    {
+      name: 'name',
+      type: 'string'
+    },
+    {
+      name: 'readOnly',
+      type: 'bool'
     }
   ]
 })
 
-template.register({
+pass.register({
   name: 'delete',
   compact: false,
   fields: [
@@ -62,7 +70,28 @@ template.register({
   ]
 })
 
-template.register({
+pass.register({
+  name: 'invitee',
+  fields: [
+    { name: 'key', type: 'fixed32', required: true },
+    { name: 'name', type: 'string' }
+  ]
+})
+
+pass.register({
+  name: 'public-invite-metadata',
+  fields: [{ name: 'readOnly', type: 'bool' }]
+})
+
+pass.register({
+  name: 'additional-invite-data',
+  fields: [
+    { name: 'data', type: 'buffer', required: true },
+    { name: 'signature', type: 'buffer', required: true }
+  ]
+})
+
+pass.register({
   name: 'invite',
   compact: false,
   fields: [
@@ -85,11 +114,21 @@ template.register({
       name: 'expires',
       type: 'int',
       required: true
+    },
+    {
+      name: 'readOnly',
+      type: 'bool',
+      required: false
+    },
+    {
+      name: 'additional',
+      type: '@autopass/additional-invite-data',
+      required: false
     }
   ]
 })
 
-template.register({
+pass.register({
   name: 'del-invite',
   compact: false,
   fields: [
@@ -100,7 +139,7 @@ template.register({
     }
   ]
 })
-template.register({
+pass.register({
   name: 'del-mirror',
   compact: false,
   fields: [

package/spec/db/db.json

@@ -1,5 +1,5 @@
 {
-  "version": 0,
+  "version": 1,
   "offset": 0,
   "schema": [
     {
@@ -7,6 +7,8 @@
       "namespace": "autopass",
       "id": 0,
       "type": 1,
+      "version": 1,
+      "versionField": null,
       "indexes": [],
       "schema": "@autopass/records",
       "derived": false,
@@ -18,6 +20,8 @@
       "namespace": "autopass",
       "id": 1,
       "type": 1,
+      "version": 1,
+      "versionField": null,
       "indexes": [],
       "schema": "@autopass/invite",
       "derived": false,
@@ -29,6 +33,8 @@
       "namespace": "autopass",
       "id": 2,
       "type": 1,
+      "version": 1,
+      "versionField": null,
       "indexes": [],
       "schema": "@autopass/mirrors",
       "derived": false,
@@ -40,6 +46,8 @@
       "namespace": "autopass",
       "id": 3,
       "type": 1,
+      "version": 1,
+      "versionField": null,
       "indexes": [],
       "schema": "@autopass/writer",
       "derived": false,
@@ -51,6 +59,8 @@
       "namespace": "autopass",
       "id": 4,
       "type": 1,
+      "version": 1,
+      "versionField": null,
       "indexes": [],
       "schema": "@autopass/delete",
       "derived": false,
@@ -62,6 +72,8 @@
       "namespace": "autopass",
       "id": 5,
       "type": 1,
+      "version": 1,
+      "versionField": null,
       "indexes": [],
       "schema": "@autopass/del-invite",
       "derived": false,
@@ -73,6 +85,8 @@
       "namespace": "autopass",
       "id": 6,
       "type": 1,
+      "version": 1,
+      "versionField": null,
       "indexes": [],
       "schema": "@autopass/del-mirror",
       "derived": false,