autopass 3.3.0 → 3.4.0

package/README.md

@@ -71,13 +71,30 @@ 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`
 
@@ -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,10 +78,12 @@ class AutopassPairer extends ReadyResource {
 
           await this.pass.deleteInvite()
         }
-        const readOnly = JSON.parse(result.data.toString()).readOnly
+
+        const metadata = result.data ? c.decode(PUBLIC_INVITE_METADATA, result.data) : null
+
         this.swarm = null
         this.store = null
-        if (this.onresolve && readOnly) {
+        if (this.onresolve && metadata && metadata.readOnly) {
           this._whenReadable()
         } else if (this.onresolve) {
           this._whenWritable()
@@ -84,11 +94,7 @@ class AutopassPairer extends ReadyResource {
   }
 
   _whenReadable() {
-    const check = () => {
-      this.pass.base.off('update', check)
-      this.onresolve(this.pass)
-    }
-    this.pass.base.on('update', check)
+    this.onresolve(this.pass)
   }
 
   _whenWritable() {
@@ -149,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) => {
@@ -263,7 +271,7 @@ class Autopass extends ReadyResource {
     const { id, invite, publicKey, expires, additional } = BlindPairing.createInvite(
       this.base.key,
       {
-        data: Buffer.from(JSON.stringify({ readOnly }))
+        data: c.encode(PUBLIC_INVITE_METADATA, { readOnly })
       }
     )
 
@@ -293,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')
       })
     )
   }
@@ -337,9 +351,8 @@ class Autopass extends ReadyResource {
         }
         const readOnly = inv.readOnly
         candidate.open(inv.publicKey)
-        if (!readOnly) {
-          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,

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "autopass",
-  "version": "3.3.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,20 @@ 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 },
@@ -70,7 +91,7 @@ template.register({
   ]
 })
 
-template.register({
+pass.register({
   name: 'invite',
   compact: false,
   fields: [
@@ -97,7 +118,7 @@ template.register({
     {
       name: 'readOnly',
       type: 'bool',
-      required: true
+      required: false
     },
     {
       name: 'additional',
@@ -107,7 +128,7 @@ template.register({
   ]
 })
 
-template.register({
+pass.register({
   name: 'del-invite',
   compact: false,
   fields: [
@@ -118,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,7 +7,7 @@
       "namespace": "autopass",
       "id": 0,
       "type": 1,
-      "version": 0,
+      "version": 1,
       "versionField": null,
       "indexes": [],
       "schema": "@autopass/records",
@@ -20,7 +20,7 @@
       "namespace": "autopass",
       "id": 1,
       "type": 1,
-      "version": 0,
+      "version": 1,
       "versionField": null,
       "indexes": [],
       "schema": "@autopass/invite",
@@ -33,7 +33,7 @@
       "namespace": "autopass",
       "id": 2,
       "type": 1,
-      "version": 0,
+      "version": 1,
       "versionField": null,
       "indexes": [],
       "schema": "@autopass/mirrors",
@@ -46,7 +46,7 @@
       "namespace": "autopass",
       "id": 3,
       "type": 1,
-      "version": 0,
+      "version": 1,
       "versionField": null,
       "indexes": [],
       "schema": "@autopass/writer",
@@ -59,7 +59,7 @@
       "namespace": "autopass",
       "id": 4,
       "type": 1,
-      "version": 0,
+      "version": 1,
       "versionField": null,
       "indexes": [],
       "schema": "@autopass/delete",
@@ -72,7 +72,7 @@
       "namespace": "autopass",
       "id": 5,
       "type": 1,
-      "version": 0,
+      "version": 1,
       "versionField": null,
       "indexes": [],
       "schema": "@autopass/del-invite",
@@ -85,7 +85,7 @@
       "namespace": "autopass",
       "id": 6,
       "type": 1,
-      "version": 0,
+      "version": 1,
       "versionField": null,
       "indexes": [],
       "schema": "@autopass/del-mirror",

package/spec/db/index.js

@@ -4,7 +4,7 @@
 const { IndexEncoder, c, b4a } = require('hyperdb/runtime')
 const { version, getEncoding, setVersion } = require('./messages.js')
 
-const versions = { schema: version, db: 0 }
+const versions = { schema: version, db: 1 }
 
 // '@autopass/records' collection key
 const collection0_key = new IndexEncoder([IndexEncoder.STRING], { prefix: 0 })
@@ -22,6 +22,9 @@ function collection0_reconstruct(schemaVersion, keyBuf, valueBuf) {
   const key = collection0_key.decode(keyBuf)
   setVersion(schemaVersion)
   const state = { start: 0, end: valueBuf.byteLength, buffer: valueBuf }
+  const type = c.uint.decode(state)
+  if (type !== 0) throw new Error('Unknown collection type: ' + type)
+  collection0.decodedVersion = c.uint.decode(state)
   const record = collection0_enc.decode(state)
   record.key = key[0]
   return record
@@ -38,7 +41,7 @@ function collection0_reconstruct_key(keyBuf) {
 const collection0 = {
   name: '@autopass/records',
   id: 0,
-  version: 0,
+  version: 1,
   encodeKey(record) {
     const key = [record.key]
     return collection0_key.encode(key)
@@ -53,9 +56,11 @@ const collection0 = {
   },
   encodeValue(schemaVersion, collectionVersion, record) {
     setVersion(schemaVersion)
-    const state = { start: 0, end: 0, buffer: null }
+    const state = { start: 0, end: 2, buffer: null }
     collection0_enc.preencode(state, record)
     state.buffer = b4a.allocUnsafe(state.end)
+    state.buffer[state.start++] = 0
+    state.buffer[state.start++] = collectionVersion
     collection0_enc.encode(state, record)
     return state.buffer
   },
@@ -82,6 +87,9 @@ function collection1_reconstruct(schemaVersion, keyBuf, valueBuf) {
   const key = collection1_key.decode(keyBuf)
   setVersion(schemaVersion)
   const state = { start: 0, end: valueBuf.byteLength, buffer: valueBuf }
+  const type = c.uint.decode(state)
+  if (type !== 0) throw new Error('Unknown collection type: ' + type)
+  collection1.decodedVersion = c.uint.decode(state)
   const record = collection1_enc.decode(state)
   record.id = key[0]
   return record
@@ -98,7 +106,7 @@ function collection1_reconstruct_key(keyBuf) {
 const collection1 = {
   name: '@autopass/invite',
   id: 1,
-  version: 0,
+  version: 1,
   encodeKey(record) {
     const key = [record.id]
     return collection1_key.encode(key)
@@ -113,9 +121,11 @@ const collection1 = {
   },
   encodeValue(schemaVersion, collectionVersion, record) {
     setVersion(schemaVersion)
-    const state = { start: 0, end: 0, buffer: null }
+    const state = { start: 0, end: 2, buffer: null }
     collection1_enc.preencode(state, record)
     state.buffer = b4a.allocUnsafe(state.end)
+    state.buffer[state.start++] = 0
+    state.buffer[state.start++] = collectionVersion
     collection1_enc.encode(state, record)
     return state.buffer
   },
@@ -142,6 +152,9 @@ function collection2_reconstruct(schemaVersion, keyBuf, valueBuf) {
   const key = collection2_key.decode(keyBuf)
   setVersion(schemaVersion)
   const state = { start: 0, end: valueBuf.byteLength, buffer: valueBuf }
+  const type = c.uint.decode(state)
+  if (type !== 0) throw new Error('Unknown collection type: ' + type)
+  collection2.decodedVersion = c.uint.decode(state)
   const record = collection2_enc.decode(state)
   record.key = key[0]
   return record
@@ -158,7 +171,7 @@ function collection2_reconstruct_key(keyBuf) {
 const collection2 = {
   name: '@autopass/mirrors',
   id: 2,
-  version: 0,
+  version: 1,
   encodeKey(record) {
     const key = [record.key]
     return collection2_key.encode(key)
@@ -173,9 +186,11 @@ const collection2 = {
   },
   encodeValue(schemaVersion, collectionVersion, record) {
     setVersion(schemaVersion)
-    const state = { start: 0, end: 0, buffer: null }
+    const state = { start: 0, end: 2, buffer: null }
     collection2_enc.preencode(state, record)
     state.buffer = b4a.allocUnsafe(state.end)
+    state.buffer[state.start++] = 0
+    state.buffer[state.start++] = collectionVersion
     collection2_enc.encode(state, record)
     return state.buffer
   },
@@ -202,6 +217,9 @@ function collection3_reconstruct(schemaVersion, keyBuf, valueBuf) {
   const key = collection3_key.decode(keyBuf)
   setVersion(schemaVersion)
   const state = { start: 0, end: valueBuf.byteLength, buffer: valueBuf }
+  const type = c.uint.decode(state)
+  if (type !== 0) throw new Error('Unknown collection type: ' + type)
+  collection3.decodedVersion = c.uint.decode(state)
   const record = collection3_enc.decode(state)
   record.key = key[0]
   return record
@@ -218,7 +236,7 @@ function collection3_reconstruct_key(keyBuf) {
 const collection3 = {
   name: '@autopass/writer',
   id: 3,
-  version: 0,
+  version: 1,
   encodeKey(record) {
     const key = [record.key]
     return collection3_key.encode(key)
@@ -233,9 +251,11 @@ const collection3 = {
   },
   encodeValue(schemaVersion, collectionVersion, record) {
     setVersion(schemaVersion)
-    const state = { start: 0, end: 0, buffer: null }
+    const state = { start: 0, end: 2, buffer: null }
     collection3_enc.preencode(state, record)
     state.buffer = b4a.allocUnsafe(state.end)
+    state.buffer[state.start++] = 0
+    state.buffer[state.start++] = collectionVersion
     collection3_enc.encode(state, record)
     return state.buffer
   },
@@ -262,6 +282,9 @@ function collection4_reconstruct(schemaVersion, keyBuf, valueBuf) {
   const key = collection4_key.decode(keyBuf)
   setVersion(schemaVersion)
   const state = { start: 0, end: valueBuf.byteLength, buffer: valueBuf }
+  const type = c.uint.decode(state)
+  if (type !== 0) throw new Error('Unknown collection type: ' + type)
+  collection4.decodedVersion = c.uint.decode(state)
   const record = collection4_enc.decode(state)
   record.key = key[0]
   return record
@@ -278,7 +301,7 @@ function collection4_reconstruct_key(keyBuf) {
 const collection4 = {
   name: '@autopass/delete',
   id: 4,
-  version: 0,
+  version: 1,
   encodeKey(record) {
     const key = [record.key]
     return collection4_key.encode(key)
@@ -293,9 +316,11 @@ const collection4 = {
   },
   encodeValue(schemaVersion, collectionVersion, record) {
     setVersion(schemaVersion)
-    const state = { start: 0, end: 0, buffer: null }
+    const state = { start: 0, end: 2, buffer: null }
     collection4_enc.preencode(state, record)
     state.buffer = b4a.allocUnsafe(state.end)
+    state.buffer[state.start++] = 0
+    state.buffer[state.start++] = collectionVersion
     collection4_enc.encode(state, record)
     return state.buffer
   },
@@ -322,6 +347,9 @@ function collection5_reconstruct(schemaVersion, keyBuf, valueBuf) {
   const key = collection5_key.decode(keyBuf)
   setVersion(schemaVersion)
   const state = { start: 0, end: valueBuf.byteLength, buffer: valueBuf }
+  const type = c.uint.decode(state)
+  if (type !== 0) throw new Error('Unknown collection type: ' + type)
+  collection5.decodedVersion = c.uint.decode(state)
   const record = collection5_enc.decode(state)
   record.id = key[0]
   return record
@@ -338,7 +366,7 @@ function collection5_reconstruct_key(keyBuf) {
 const collection5 = {
   name: '@autopass/del-invite',
   id: 5,
-  version: 0,
+  version: 1,
   encodeKey(record) {
     const key = [record.id]
     return collection5_key.encode(key)
@@ -353,9 +381,11 @@ const collection5 = {
   },
   encodeValue(schemaVersion, collectionVersion, record) {
     setVersion(schemaVersion)
-    const state = { start: 0, end: 0, buffer: null }
+    const state = { start: 0, end: 2, buffer: null }
     collection5_enc.preencode(state, record)
     state.buffer = b4a.allocUnsafe(state.end)
+    state.buffer[state.start++] = 0
+    state.buffer[state.start++] = collectionVersion
     collection5_enc.encode(state, record)
     return state.buffer
   },
@@ -382,6 +412,9 @@ function collection6_reconstruct(schemaVersion, keyBuf, valueBuf) {
   const key = collection6_key.decode(keyBuf)
   setVersion(schemaVersion)
   const state = { start: 0, end: valueBuf.byteLength, buffer: valueBuf }
+  const type = c.uint.decode(state)
+  if (type !== 0) throw new Error('Unknown collection type: ' + type)
+  collection6.decodedVersion = c.uint.decode(state)
   const record = collection6_enc.decode(state)
   record.key = key[0]
   return record
@@ -398,7 +431,7 @@ function collection6_reconstruct_key(keyBuf) {
 const collection6 = {
   name: '@autopass/del-mirror',
   id: 6,
-  version: 0,
+  version: 1,
   encodeKey(record) {
     const key = [record.key]
     return collection6_key.encode(key)
@@ -413,9 +446,11 @@ const collection6 = {
   },
   encodeValue(schemaVersion, collectionVersion, record) {
     setVersion(schemaVersion)
-    const state = { start: 0, end: 0, buffer: null }
+    const state = { start: 0, end: 2, buffer: null }
     collection6_enc.preencode(state, record)
     state.buffer = b4a.allocUnsafe(state.end)
+    state.buffer[state.start++] = 0
+    state.buffer[state.start++] = collectionVersion
     collection6_enc.encode(state, record)
     return state.buffer
   },