gip-remote 1.2.1 → 1.2.3

package/index.d.ts

@@ -1,14 +1,15 @@
 import { Readable } from 'streamx'
 
 interface RemoteOpts {
-  name?: string
-  store: any
-  swarm: any
-  key?: Buffer
   timeout?: number
-  blind?: boolean
+  blind?: any
 }
 
+type RemoteLink =
+  | string
+  | { name: string; key?: Buffer }
+  | { drive: { key: Buffer }; pathname?: string }
+
 interface GitObject {
   oid: string
   type: string
@@ -19,6 +20,7 @@ interface GitObject {
 interface Ref {
   ref: string
   oid: string
+  symref?: string
 }
 
 interface RefObject extends GitObject {
@@ -26,13 +28,14 @@ interface RefObject extends GitObject {
 }
 
 declare class Remote {
-  constructor(opts: RemoteOpts)
+  constructor(store: any, link: RemoteLink, opts?: RemoteOpts)
 
   readonly name: string
   readonly core: any
   readonly key: Buffer
   readonly discoveryKey: Buffer
   readonly availablePeers: number
+  readonly url: string
 
   ready(): Promise<void>
   close(): Promise<void>
@@ -42,11 +45,20 @@ declare class Remote {
     commitOid: string,
     objects: Map<string, { type: string; size: number; data: Buffer }>
   ): Promise<void>
+
+  getHead(): Promise<string | null>
+  setHead(branch: string): Promise<void>
+
   getAllRefs(): Promise<Ref[]>
   getBranchRef(branch: string): Promise<Ref | null>
+  deleteBranch(branchName: string): Promise<boolean>
+
   getObject(oid: string): Promise<GitObject | null>
   getRefObjects(commitOid: string, onLoad?: (size: number) => void): Promise<RefObject[]>
+
   toDrive(branch: string): Promise<RemoteDrive | null>
+
+  update(): Promise<void>
   waitForPeers(): Promise<void>
 }
 
@@ -73,6 +85,22 @@ declare class RemoteDrive {
   mirror(out: any, opts?: any): any
 }
 
+interface ParsedGitPearLink {
+  protocol: string
+  origin: string
+  pathname?: string
+  drive: {
+    key: Buffer
+    length: number
+    fork?: number | null
+  }
+}
+
+declare const GitPearLink: {
+  parse(link: string): ParsedGitPearLink
+  serialize(o: ParsedGitPearLink): string
+}
+
 interface ToDiskOpts {
   gitDir: string
   objects: Array<{ type: string; id: string; size: number; data: Buffer }>
@@ -107,4 +135,16 @@ declare function walkTree(
   prefix: string
 ): FileEntry[]
 
-export { Remote, RemoteDrive, toDisk, parseCommit, walkTree }
+export { Remote, RemoteDrive, GitPearLink, toDisk, parseCommit, walkTree }
+export type {
+  RemoteOpts,
+  RemoteLink,
+  GitObject,
+  Ref,
+  RefObject,
+  DriveEntry,
+  ParsedGitPearLink,
+  ToDiskOpts,
+  Commit,
+  FileEntry
+}

package/index.js

@@ -31,7 +31,8 @@ class Remote extends ReadyResource {
       config = this._link
     }
 
-    const bee = new Hyperbee(store, config, { autoUpdate: true })
+    config.autoUpdate = true
+    const bee = new Hyperbee(store, config)
     this._db = HyperDB.bee2(bee, def, { autoUpdate: true })
 
     this._timeout = opts.timeout || 240_000
@@ -67,7 +68,8 @@ class Remote extends ReadyResource {
   }
 
   get url() {
-    return `git+pear://${z32.encode(this.key)}/${this.name}`
+    const head = this._db.db.head()
+    return `git+pear://0.${head.length}.${z32.encode(head.key)}/${this.name}`
   }
 
   // --- Objects ---

package/lib/drive.js

@@ -26,15 +26,7 @@ class RemoteDrive extends ReadyResource {
     })
     if (!record) return null
 
-    return {
-      key,
-      value: {
-        executable: record.mode === '100755',
-        linkname: null,
-        blob: { byteLength: record.size },
-        metadata: null
-      }
-    }
+    return toEntry(key, record)
   }
 
   async get(nameOrEntry) {
@@ -89,7 +81,7 @@ class RemoteDrive extends ReadyResource {
         try {
           for await (const record of stream) {
             if (ignore && ignore(record.path)) continue
-            this.push(record.path)
+            this.push(toEntry(record.path, record))
           }
           this.push(null)
           cb(null)
@@ -130,4 +122,21 @@ class RemoteDrive extends ReadyResource {
   }
 }
 
+function toEntry(key, record) {
+  return {
+    key,
+    value: {
+      executable: record.mode === '100755',
+      linkname: null,
+      blob: {
+        blockOffset: 0,
+        blockLength: 0,
+        byteOffset: 0,
+        byteLength: record.size
+      },
+      metadata: null
+    }
+  }
+}
+
 module.exports = RemoteDrive

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gip-remote",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "Git+Pear remote DB for handling git data",
   "main": "index.js",
   "scripts": {

package/schema/hyperdb/db.json

@@ -12,9 +12,7 @@
       "indexes": [],
       "schema": "@gip/repos",
       "derived": false,
-      "key": [
-        "name"
-      ],
+      "key": ["name"],
       "trigger": null
     },
     {
@@ -27,9 +25,7 @@
       "indexes": [],
       "schema": "@gip/branches",
       "derived": false,
-      "key": [
-        "name"
-      ],
+      "key": ["name"],
       "trigger": null
     },
     {
@@ -39,15 +35,10 @@
       "type": 1,
       "version": 1,
       "versionField": null,
-      "indexes": [
-        "@gip/files-by-branch"
-      ],
+      "indexes": ["@gip/files-by-branch"],
       "schema": "@gip/files",
       "derived": false,
-      "key": [
-        "branch",
-        "path"
-      ],
+      "key": ["branch", "path"],
       "trigger": null
     },
     {
@@ -60,9 +51,7 @@
       "indexes": [],
       "schema": "@gip/objects",
       "derived": false,
-      "key": [
-        "oid"
-      ],
+      "key": ["oid"],
       "trigger": null
     },
     {
@@ -74,9 +63,7 @@
       "collection": "@gip/files",
       "unique": false,
       "deprecated": false,
-      "key": [
-        "branch"
-      ]
+      "key": ["branch"]
     },
     {
       "name": "head",
@@ -92,4 +79,4 @@
       "trigger": null
     }
   ]
-}
+}

package/schema/hyperdb/index.js

@@ -7,11 +7,9 @@ const { version, getEncoding, setVersion } = require('./messages.js')
 const versions = { schema: version, db: 2 }
 
 // '@gip/repos' collection key
-const collection0_key = new IndexEncoder([
-  IndexEncoder.STRING
-], { prefix: 0 })
+const collection0_key = new IndexEncoder([IndexEncoder.STRING], { prefix: 0 })
 
-function collection0_indexify (record) {
+function collection0_indexify(record) {
   const a = record.name
   return a === undefined ? [] : [a]
 }
@@ -20,7 +18,7 @@ function collection0_indexify (record) {
 const collection0_enc = getEncoding('@gip/repos/hyperdb#0')
 
 // '@gip/repos' reconstruction function
-function collection0_reconstruct (schemaVersion, keyBuf, valueBuf) {
+function collection0_reconstruct(schemaVersion, keyBuf, valueBuf) {
   const key = collection0_key.decode(keyBuf)
   setVersion(schemaVersion)
   const state = { start: 0, end: valueBuf.byteLength, buffer: valueBuf }
@@ -32,7 +30,7 @@ function collection0_reconstruct (schemaVersion, keyBuf, valueBuf) {
   return record
 }
 // '@gip/repos' key reconstruction function
-function collection0_reconstruct_key (keyBuf) {
+function collection0_reconstruct_key(keyBuf) {
   const key = collection0_key.decode(keyBuf)
   return {
     name: key[0]
@@ -44,11 +42,11 @@ const collection0 = {
   name: '@gip/repos',
   id: 0,
   version: 1,
-  encodeKey (record) {
+  encodeKey(record) {
     const key = [record.name]
     return collection0_key.encode(key)
   },
-  encodeKeyRange ({ gt, lt, gte, lte } = {}) {
+  encodeKeyRange({ gt, lt, gte, lte } = {}) {
     return collection0_key.encodeRange({
       gt: gt ? collection0_indexify(gt) : null,
       lt: lt ? collection0_indexify(lt) : null,
@@ -56,7 +54,7 @@ const collection0 = {
       lte: lte ? collection0_indexify(lte) : null
     })
   },
-  encodeValue (schemaVersion, collectionVersion, record) {
+  encodeValue(schemaVersion, collectionVersion, record) {
     setVersion(schemaVersion)
     const state = { start: 0, end: 2, buffer: null }
     collection0_enc.preencode(state, record)
@@ -74,11 +72,9 @@ const collection0 = {
 }
 
 // '@gip/branches' collection key
-const collection1_key = new IndexEncoder([
-  IndexEncoder.STRING
-], { prefix: 1 })
+const collection1_key = new IndexEncoder([IndexEncoder.STRING], { prefix: 1 })
 
-function collection1_indexify (record) {
+function collection1_indexify(record) {
   const a = record.name
   return a === undefined ? [] : [a]
 }
@@ -87,7 +83,7 @@ function collection1_indexify (record) {
 const collection1_enc = getEncoding('@gip/branches/hyperdb#1')
 
 // '@gip/branches' reconstruction function
-function collection1_reconstruct (schemaVersion, keyBuf, valueBuf) {
+function collection1_reconstruct(schemaVersion, keyBuf, valueBuf) {
   const key = collection1_key.decode(keyBuf)
   setVersion(schemaVersion)
   const state = { start: 0, end: valueBuf.byteLength, buffer: valueBuf }
@@ -99,7 +95,7 @@ function collection1_reconstruct (schemaVersion, keyBuf, valueBuf) {
   return record
 }
 // '@gip/branches' key reconstruction function
-function collection1_reconstruct_key (keyBuf) {
+function collection1_reconstruct_key(keyBuf) {
   const key = collection1_key.decode(keyBuf)
   return {
     name: key[0]
@@ -111,11 +107,11 @@ const collection1 = {
   name: '@gip/branches',
   id: 1,
   version: 1,
-  encodeKey (record) {
+  encodeKey(record) {
     const key = [record.name]
     return collection1_key.encode(key)
   },
-  encodeKeyRange ({ gt, lt, gte, lte } = {}) {
+  encodeKeyRange({ gt, lt, gte, lte } = {}) {
     return collection1_key.encodeRange({
       gt: gt ? collection1_indexify(gt) : null,
       lt: lt ? collection1_indexify(lt) : null,
@@ -123,7 +119,7 @@ const collection1 = {
       lte: lte ? collection1_indexify(lte) : null
     })
   },
-  encodeValue (schemaVersion, collectionVersion, record) {
+  encodeValue(schemaVersion, collectionVersion, record) {
     setVersion(schemaVersion)
     const state = { start: 0, end: 2, buffer: null }
     collection1_enc.preencode(state, record)
@@ -141,12 +137,9 @@ const collection1 = {
 }
 
 // '@gip/files' collection key
-const collection2_key = new IndexEncoder([
-  IndexEncoder.STRING,
-  IndexEncoder.STRING
-], { prefix: 2 })
+const collection2_key = new IndexEncoder([IndexEncoder.STRING, IndexEncoder.STRING], { prefix: 2 })
 
-function collection2_indexify (record) {
+function collection2_indexify(record) {
   const arr = []
 
   const a0 = record.branch
@@ -164,7 +157,7 @@ function collection2_indexify (record) {
 const collection2_enc = getEncoding('@gip/files/hyperdb#2')
 
 // '@gip/files' reconstruction function
-function collection2_reconstruct (schemaVersion, keyBuf, valueBuf) {
+function collection2_reconstruct(schemaVersion, keyBuf, valueBuf) {
   const key = collection2_key.decode(keyBuf)
   setVersion(schemaVersion)
   const state = { start: 0, end: valueBuf.byteLength, buffer: valueBuf }
@@ -177,7 +170,7 @@ function collection2_reconstruct (schemaVersion, keyBuf, valueBuf) {
   return record
 }
 // '@gip/files' key reconstruction function
-function collection2_reconstruct_key (keyBuf) {
+function collection2_reconstruct_key(keyBuf) {
   const key = collection2_key.decode(keyBuf)
   return {
     branch: key[0],
@@ -190,11 +183,11 @@ const collection2 = {
   name: '@gip/files',
   id: 2,
   version: 1,
-  encodeKey (record) {
+  encodeKey(record) {
     const key = [record.branch, record.path]
     return collection2_key.encode(key)
   },
-  encodeKeyRange ({ gt, lt, gte, lte } = {}) {
+  encodeKeyRange({ gt, lt, gte, lte } = {}) {
     return collection2_key.encodeRange({
       gt: gt ? collection2_indexify(gt) : null,
       lt: lt ? collection2_indexify(lt) : null,
@@ -202,7 +195,7 @@ const collection2 = {
       lte: lte ? collection2_indexify(lte) : null
     })
   },
-  encodeValue (schemaVersion, collectionVersion, record) {
+  encodeValue(schemaVersion, collectionVersion, record) {
     setVersion(schemaVersion)
     const state = { start: 0, end: 2, buffer: null }
     collection2_enc.preencode(state, record)
@@ -220,11 +213,9 @@ const collection2 = {
 }
 
 // '@gip/objects' collection key
-const collection3_key = new IndexEncoder([
-  IndexEncoder.STRING
-], { prefix: 3 })
+const collection3_key = new IndexEncoder([IndexEncoder.STRING], { prefix: 3 })
 
-function collection3_indexify (record) {
+function collection3_indexify(record) {
   const a = record.oid
   return a === undefined ? [] : [a]
 }
@@ -233,7 +224,7 @@ function collection3_indexify (record) {
 const collection3_enc = getEncoding('@gip/objects/hyperdb#3')
 
 // '@gip/objects' reconstruction function
-function collection3_reconstruct (schemaVersion, keyBuf, valueBuf) {
+function collection3_reconstruct(schemaVersion, keyBuf, valueBuf) {
   const key = collection3_key.decode(keyBuf)
   setVersion(schemaVersion)
   const state = { start: 0, end: valueBuf.byteLength, buffer: valueBuf }
@@ -245,7 +236,7 @@ function collection3_reconstruct (schemaVersion, keyBuf, valueBuf) {
   return record
 }
 // '@gip/objects' key reconstruction function
-function collection3_reconstruct_key (keyBuf) {
+function collection3_reconstruct_key(keyBuf) {
   const key = collection3_key.decode(keyBuf)
   return {
     oid: key[0]
@@ -257,11 +248,11 @@ const collection3 = {
   name: '@gip/objects',
   id: 3,
   version: 1,
-  encodeKey (record) {
+  encodeKey(record) {
     const key = [record.oid]
     return collection3_key.encode(key)
   },
-  encodeKeyRange ({ gt, lt, gte, lte } = {}) {
+  encodeKeyRange({ gt, lt, gte, lte } = {}) {
     return collection3_key.encodeRange({
       gt: gt ? collection3_indexify(gt) : null,
       lt: lt ? collection3_indexify(lt) : null,
@@ -269,7 +260,7 @@ const collection3 = {
       lte: lte ? collection3_indexify(lte) : null
     })
   },
-  encodeValue (schemaVersion, collectionVersion, record) {
+  encodeValue(schemaVersion, collectionVersion, record) {
     setVersion(schemaVersion)
     const state = { start: 0, end: 2, buffer: null }
     collection3_enc.preencode(state, record)
@@ -287,13 +278,12 @@ const collection3 = {
 }
 
 // '@gip/files-by-branch' collection key
-const index4_key = new IndexEncoder([
-  IndexEncoder.STRING,
-  IndexEncoder.STRING,
-  IndexEncoder.STRING
-], { prefix: 4 })
+const index4_key = new IndexEncoder(
+  [IndexEncoder.STRING, IndexEncoder.STRING, IndexEncoder.STRING],
+  { prefix: 4 }
+)
 
-function index4_indexify (record) {
+function index4_indexify(record) {
   const arr = []
 
   const a0 = record.branch
@@ -316,10 +306,10 @@ const index4 = {
   name: '@gip/files-by-branch',
   version: 1,
   id: 4,
-  encodeKey (record) {
+  encodeKey(record) {
     return index4_key.encode(index4_indexify(record))
   },
-  encodeKeyRange ({ gt, lt, gte, lte } = {}) {
+  encodeKeyRange({ gt, lt, gte, lte } = {}) {
     return index4_key.encodeRange({
       gt: gt ? index4_indexify(gt) : null,
       lt: lt ? index4_indexify(lt) : null,
@@ -328,7 +318,7 @@ const index4 = {
     })
   },
   encodeValue: (record) => index4.collection.encodeKey(record),
-  encodeIndexKeys (record, context) {
+  encodeIndexKeys(record, context) {
     return [index4_key.encode([record.branch, record.branch, record.path])]
   },
   reconstruct: (keyBuf, valueBuf) => valueBuf,
@@ -338,10 +328,9 @@ const index4 = {
 collection2.indexes.push(index4)
 
 // '@gip/head' collection key
-const collection5_key = new IndexEncoder([
-], { prefix: 5 })
+const collection5_key = new IndexEncoder([], { prefix: 5 })
 
-function collection5_indexify (record) {
+function collection5_indexify(record) {
   return []
 }
 
@@ -349,7 +338,7 @@ function collection5_indexify (record) {
 const collection5_enc = getEncoding('@gip/head')
 
 // '@gip/head' reconstruction function
-function collection5_reconstruct (schemaVersion, keyBuf, valueBuf) {
+function collection5_reconstruct(schemaVersion, keyBuf, valueBuf) {
   setVersion(schemaVersion)
   const state = { start: 0, end: valueBuf.byteLength, buffer: valueBuf }
   const type = c.uint.decode(state)
@@ -359,7 +348,7 @@ function collection5_reconstruct (schemaVersion, keyBuf, valueBuf) {
   return record
 }
 // '@gip/head' key reconstruction function
-function collection5_reconstruct_key (keyBuf) {
+function collection5_reconstruct_key(keyBuf) {
   return {}
 }
 
@@ -368,11 +357,11 @@ const collection5 = {
   name: '@gip/head',
   id: 5,
   version: 2,
-  encodeKey (record) {
+  encodeKey(record) {
     const key = []
     return collection5_key.encode(key)
   },
-  encodeKeyRange ({ gt, lt, gte, lte } = {}) {
+  encodeKeyRange({ gt, lt, gte, lte } = {}) {
     return collection5_key.encodeRange({
       gt: gt ? collection5_indexify(gt) : null,
       lt: lt ? collection5_indexify(lt) : null,
@@ -380,7 +369,7 @@ const collection5 = {
       lte: lte ? collection5_indexify(lte) : null
     })
   },
-  encodeValue (schemaVersion, collectionVersion, record) {
+  encodeValue(schemaVersion, collectionVersion, record) {
     setVersion(schemaVersion)
     const state = { start: 0, end: 2, buffer: null }
     collection5_enc.preencode(state, record)
@@ -397,34 +386,34 @@ const collection5 = {
   decodedVersion: 0
 }
 
-const collections = [
-  collection0,
-  collection1,
-  collection2,
-  collection3,
-  collection5
-]
+const collections = [collection0, collection1, collection2, collection3, collection5]
 
-const indexes = [
-  index4
-]
+const indexes = [index4]
 
 module.exports = { versions, collections, indexes, resolveCollection, resolveIndex }
 
-function resolveCollection (name) {
+function resolveCollection(name) {
   switch (name) {
-    case '@gip/repos': return collection0
-    case '@gip/branches': return collection1
-    case '@gip/files': return collection2
-    case '@gip/objects': return collection3
-    case '@gip/head': return collection5
-    default: return null
+    case '@gip/repos':
+      return collection0
+    case '@gip/branches':
+      return collection1
+    case '@gip/files':
+      return collection2
+    case '@gip/objects':
+      return collection3
+    case '@gip/head':
+      return collection5
+    default:
+      return null
   }
 }
 
-function resolveIndex (name) {
+function resolveIndex(name) {
   switch (name) {
-    case '@gip/files-by-branch': return index4
-    default: return null
+    case '@gip/files-by-branch':
+      return index4
+    default:
+      return null
   }
 }

package/schema/hyperdb/messages.js

@@ -151,10 +151,10 @@ const encoding3_enum = {
 
 // @gip/object-type enum
 const encoding3 = {
-  preencode (state, m) {
+  preencode(state, m) {
     state.end++ // max enum is 4 so always one byte
   },
-  encode (state, m) {
+  encode(state, m) {
     switch (m) {
       case 'blob':
         c.uint.encode(state, 1)
@@ -172,7 +172,7 @@ const encoding3 = {
         throw new Error('Unknown enum')
     }
   },
-  decode (state) {
+  decode(state) {
     switch (c.uint.decode(state)) {
       case 1:
         return 'blob'
@@ -182,7 +182,8 @@ const encoding3 = {
         return 'commit'
       case 4:
         return 'tag'
-      default: return null
+      default:
+        return null
     }
   }
 }

package/schema/hyperschema/index.js

@@ -151,10 +151,10 @@ const encoding3_enum = {
 
 // @gip/object-type enum
 const encoding3 = {
-  preencode (state, m) {
+  preencode(state, m) {
     state.end++ // max enum is 4 so always one byte
   },
-  encode (state, m) {
+  encode(state, m) {
     switch (m) {
       case 'blob':
         c.uint.encode(state, 1)
@@ -172,7 +172,7 @@ const encoding3 = {
         throw new Error('Unknown enum')
     }
   },
-  decode (state) {
+  decode(state) {
     switch (c.uint.decode(state)) {
       case 1:
         return 'blob'
@@ -182,7 +182,8 @@ const encoding3 = {
         return 'commit'
       case 4:
         return 'tag'
-      default: return null
+      default:
+        return null
     }
   }
 }