@comapeo/core 6.0.1 → 7.0.0

package/src/mapeo-project.js

@@ -3,7 +3,6 @@ import Database from 'better-sqlite3'
 import { decodeBlockPrefix, decode, parseVersionId } from '@comapeo/schema'
 import { drizzle } from 'drizzle-orm/better-sqlite3'
 import { sql, count, eq } from 'drizzle-orm'
-import { TypedEmitter } from 'tiny-typed-emitter'
 import ZipArchive from 'zip-stream-promise'
 import * as b4a from 'b4a'
 import mime from 'mime/lite'
@@ -39,18 +38,13 @@ import {
   getWinner,
   mapAndValidateCoreOwnership,
 } from './core-ownership.js'
-import {
-  BLOCKED_ROLE_ID,
-  Roles,
-  LEFT_ROLE_ID,
-  INACTIVE_MEMBER_ROLE_IDS,
-} from './roles.js'
+import { BLOCKED_ROLE_ID, Roles, LEFT_ROLE_ID } from './roles.js'
 import {
   buildBlobId,
   getDeviceId,
+  noop,
   projectKeyToId,
   projectKeyToPublicId,
-  validateMapShareExtension,
   valueOf,
 } from './utils.js'
 import { migrate } from './lib/drizzle-helpers.js'
@@ -73,7 +67,6 @@ import {
   ExhaustivenessError,
   nullIfNotFound,
   GeoJSONExportError,
-  InvalidMapShareError,
   MultipleCategoryImportsError,
   UnexpectedDocSchemaError,
 } from './errors.js'
@@ -81,6 +74,8 @@ import { WebSocket } from 'ws'
 import fs from 'node:fs'
 
 import ensureError from 'ensure-error'
+import ReadyResource from 'ready-resource'
+
 /** @import { MapShareExtension } from './generated/extensions.js' */
 /** @import { ProjectSettingsValue, Observation, Track } from '@comapeo/schema' */
 /** @import { Attachment, CoreStorage, BlobFilter, BlobId, BlobStoreEntriesStream, KeyPair, Namespace, ReplicationStream, GenericBlobFilter, MapeoValueMap, MapeoDocMap } from './types.js' */
@@ -129,36 +124,16 @@ const VARIANT_EXPORT_ORDER = ['original', 'preview', 'thumbnail']
  * @property {Role & {reason: string | undefined}} role
  */
 
-/**
- * @typedef {object} AugmentedMapShareProperties
- * @property {readonly [number, number, number, number]} bounds - Bounding box of the shared map [W, S, E, N].
- * @property {readonly [string, ...string[]]} mapShareUrls - URLs associated with the map share.
- * @property {number} mapShareReceivedAt - Timestamp when the map share was received.
- * @property {string} senderDeviceId - The ID of the device that sent the map share.
- * @property {string} [senderDeviceName] - The name of the device that sent the map share.
- * @property {string} receiverDeviceId - The deviceId of the peer the map share was sent to
- */
-
-/**
- * @typedef {Omit<MapShareExtension, 'bounds' | 'mapShareUrls' | 'receiverDeviceKey'> & AugmentedMapShareProperties} MapShare
- */
-
-/**
- * @typedef {Omit<MapShare, 'mapShareReceivedAt' | 'senderDeviceId' | 'senderDeviceName'>} MapShareSend
- */
-
 /**
  * @typedef {object} ProjectEvents
  * @property {() => void} close Project resources have been cleared up
  * @property {(changeEvent: RoleChangeEvent) => void} own-role-change
- * @property {(e: Error, mapShare: MapShareExtension) => void} map-share-error - Emitted when an incoming map share fails to be recieved due to formatting issues
- * @property {(mapShare: MapShare) => void} map-share - Emitted when a map share is recieved from someone on the project
  */
 
 /**
- * @extends {TypedEmitter<ProjectEvents>}
+ * @extends {ReadyResource<ProjectEvents>}
  */
-export class MapeoProject extends TypedEmitter {
+export class MapeoProject extends ReadyResource {
   #projectKey
   #deviceId
   #identityKeypair
@@ -563,22 +538,17 @@ export class MapeoProject extends TypedEmitter {
       }
     })
 
-    this.#coreManager.on('map-share', (mapShareBase, senderDeviceId) =>
-      this.#handleMapShare(mapShareBase, senderDeviceId).catch((e) => {
-        this.emit('map-share-error', e, mapShareBase)
-        this.#l.log(
-          'Error: Unable to handle incoming Map Share',
-          ensureError(e)
-        )
-      })
-    )
-
     this.once('close', () => {
       localPeers.off('peer-add', onPeerAdd)
       localPeers.off('discovery-key', onDiscoverykey)
     })
 
     this.#l.log('Created project instance %h, %s', projectKey, isArchiveDevice)
+
+    // Not necessary, because coreManager and blobStore "auto-open", but leaving
+    // this here defensively in case we add additional resources to _open() in
+    // the future
+    this.ready().catch(noop)
   }
 
   /**
@@ -620,23 +590,23 @@ export class MapeoProject extends TypedEmitter {
 
   /**
    * Resolves when hypercores have all loaded
-   *
    * @returns {Promise<void>}
    */
-  ready() {
-    return this.#coreManager.ready()
+  async _open() {
+    await this.#coreManager.ready()
+    await this.#blobStore.ready()
   }
 
   /**
    */
-  async close() {
+  async _close() {
     this.#l.log('closing project %h', this.#projectId)
-    this.#blobStore.close()
     const dataStorePromises = []
     for (const dataStore of Object.values(this.#dataStores)) {
       dataStorePromises.push(dataStore.close())
     }
     await Promise.all(dataStorePromises)
+    await this.#blobStore.close()
     await this.#coreManager.close()
 
     this.#sqlite.close()
@@ -805,43 +775,6 @@ export class MapeoProject extends TypedEmitter {
     this.emit('own-role-change', { role })
   }
 
-  /**
-   * @param {MapShareExtension} mapShareBase
-   * @param {string} senderDeviceId
-   */
-  async #handleMapShare(mapShareBase, senderDeviceId) {
-    const mapShareReceivedAt = Date.now()
-
-    validateMapShareExtension(mapShareBase)
-
-    const sender = await this.$member.getById(senderDeviceId)
-
-    if (INACTIVE_MEMBER_ROLE_IDS.includes(sender.role.roleId)) {
-      throw new InvalidMapShareError(
-        `Map Share Sender is not an active member of the project (role: ${sender.role.name})`
-      )
-    }
-
-    const { receiverDeviceKey, ...mapShareData } = mapShareBase
-
-    const receiverDeviceId = receiverDeviceKey.toString('hex')
-
-    if (receiverDeviceId !== this.#deviceId) {
-      throw new Error('Got map share intended for a different peer')
-    }
-
-    /** @type {MapShare} */
-    const mapShare = {
-      ...mapShareData,
-      senderDeviceId,
-      senderDeviceName: sender.name,
-      mapShareReceivedAt,
-      receiverDeviceId,
-    }
-
-    this.emit('map-share', mapShare)
-  }
-
   /**
    * @deprecated
    * @param {string} originalVersionId The `originalVersionId` from a document.
@@ -1490,29 +1423,6 @@ export class MapeoProject extends TypedEmitter {
       this.#importingCategories = false
     }
   }
-
-  /**
-   * Send a map share offer to the peer with device ID `mapShare.receiverDeviceId`
-   *
-   * @param {MapShareSend} mapShare
-   * @param {object} [options]
-   * @param {boolean} [options.__testOnlyBypassValidation=false] Warning: Do not use!
-   */
-  async $sendMapShare(mapShare, { __testOnlyBypassValidation = false } = {}) {
-    const { receiverDeviceId, ...mapShareData } = mapShare
-    const receiverDeviceKey = Buffer.from(receiverDeviceId, 'hex')
-
-    /** @type {MapShareExtension} */
-    // @ts-expect-error readonly fields being assigned as mutable
-    const shareExtension = {
-      ...mapShareData,
-      receiverDeviceKey,
-    }
-    if (!__testOnlyBypassValidation) {
-      validateMapShareExtension(shareExtension)
-    }
-    await this.#coreManager.sendMapShare(shareExtension)
-  }
 }
 
 /**

package/src/utils.js

@@ -11,7 +11,7 @@ import {
 } from './errors.js'
 import pTimeout, { TimeoutError as pTimeoutError } from 'p-timeout'
 
-/** @import { MapShareExtension } from './generated/extensions.js' */
+/** @import { MapShareExtension } from './generated/rpc.js' */
 /** @import {Attachment, BlobId} from "./types.js" */
 
 const PROJECT_INVITE_ID_SALT = Buffer.from('mapeo project invite id', 'ascii')
@@ -267,7 +267,7 @@ export async function timeoutPromise(promise, opts) {
  * Does not validate device ID or device name
  *
  * @param {MapShareExtension} mapShare
- * @returns {asserts mapShare is { [K in keyof MapShareExtension]: import('./mapeo-project.js').MapShare[K] }} - this validates the properties that MapShareExtension and MapShare have in common - bounds tuple and mapShareUrls
+ * @returns {asserts mapShare is { [K in keyof MapShareExtension]: import('./mapeo-manager.js').MapShare[K] }} - this validates the properties that MapShareExtension and MapShare have in common - bounds tuple and mapShareUrls
  */
 export function validateMapShareExtension(mapShare) {
   const {