@comapeo/core 5.0.0 → 5.1.0

package/drizzle/project/meta/_journal.json

@@ -22,6 +22,13 @@
       "when": 1749657174497,
       "tag": "0002_cooing_princess_powerful",
       "breakpoints": true
+    },
+    {
+      "idx": 3,
+      "version": "6",
+      "when": 1761590068314,
+      "tag": "0003_lying_piledriver",
+      "breakpoints": true
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@comapeo/core",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "description": "Offline p2p mapping library",
   "main": "src/index.js",
   "types": "dist/index.d.ts",
@@ -164,7 +164,7 @@
   },
   "dependencies": {
     "@comapeo/fallback-smp": "^1.0.0",
-    "@comapeo/schema": "2.1.1",
+    "@comapeo/schema": "2.2.0",
     "@digidem/types": "^2.3.0",
     "@fastify/error": "^3.4.1",
     "@fastify/type-provider-typebox": "^4.1.0",

package/src/mapeo-manager.js

@@ -1056,8 +1056,6 @@ export class MapeoManager extends TypedEmitter {
     const project = await this.getProject(projectPublicId)
 
     await project[kProjectLeave]()
-
-    this.#activeProjects.delete(projectPublicId)
   }
 
   async getMapStyleJsonUrl() {

package/src/mapeo-project.js

@@ -69,6 +69,7 @@ import { createWriteStream } from 'fs'
 import ensureError from 'ensure-error'
 /** @import { ProjectSettingsValue, Observation, Track } from '@comapeo/schema' */
 /** @import { Attachment, CoreStorage, BlobFilter, BlobId, BlobStoreEntriesStream, KeyPair, Namespace, ReplicationStream, GenericBlobFilter, MapeoValueMap, MapeoDocMap } from './types.js' */
+/** @import {Role} from './roles.js' */
 /** @typedef {Omit<ProjectSettingsValue, 'schemaName'>} EditableProjectSettings */
 /** @typedef {ProjectSettingsValue['configMetadata']} ConfigMetadata */
 /** @typedef {Map<string,Attachment>} SeenAttachments*/
@@ -109,7 +110,18 @@ const EMPTY_PROJECT_SETTINGS = Object.freeze({ sendStats: false })
 const VARIANT_EXPORT_ORDER = ['original', 'preview', 'thumbnail']
 
 /**
- * @extends {TypedEmitter<{ close: () => void }>}
+ * @typedef RoleChangeEvent
+ * @property {Role & {reason: string | null}} role
+ */
+
+/**
+ * @typedef {object} ProjectEvents
+ * @property {() => void} close Project resources have been cleared up
+ * @property {(changeEvent: RoleChangeEvent) => void} own-role-change
+ */
+
+/**
+ * @extends {TypedEmitter<ProjectEvents>}
  */
 export class MapeoProject extends TypedEmitter {
   #projectKey
@@ -506,6 +518,16 @@ export class MapeoProject extends TypedEmitter {
     // for the core.
     localPeers.on('discovery-key', onDiscoverykey)
 
+    this.#roles.on('update', (roleDocIds) => {
+      for (const roleDocId of roleDocIds) {
+        // Ignore docs not about ourselves
+        if (roleDocId !== this.#deviceId) continue
+        this.#handleRoleChange().catch((e) => {
+          this.#l.log(`Error: Could not handle role change`, ensureError(e))
+        })
+      }
+    })
+
     this.once('close', () => {
       localPeers.off('peer-add', onPeerAdd)
       localPeers.off('discovery-key', onDiscoverykey)
@@ -718,8 +740,18 @@ export class MapeoProject extends TypedEmitter {
     return (await this.$getProjectSettings()).name
   }
 
+  /**
+   * @returns {Promise<Role & {reason: string | null}>}
+   */
   async $getOwnRole() {
-    return this.#roles.getRole(this.#deviceId)
+    const reason = await this.#roles.getRoleReason(this.#deviceId)
+    const role = await this.#roles.getRole(this.#deviceId)
+    return { ...role, reason }
+  }
+
+  async #handleRoleChange() {
+    const role = await this.$getOwnRole()
+    this.emit('own-role-change', { role })
   }
 
   /**
@@ -1280,12 +1312,6 @@ export class MapeoProject extends TypedEmitter {
   async #throwIfCannotLeaveProject() {
     const roleDocs = await this.#dataTypes.role.getMany()
 
-    const ownRole = roleDocs.find(({ docId }) => this.#deviceId === docId)
-
-    if (ownRole?.roleId === BLOCKED_ROLE_ID) {
-      throw new Error('Cannot leave a project as a blocked device')
-    }
-
     const allRoles = await this.#roles.getAll()
 
     const isOnlyDevice = allRoles.size <= 1
@@ -1311,9 +1337,13 @@ export class MapeoProject extends TypedEmitter {
   }
 
   async [kProjectLeave]() {
+    const ownRole = await this.$getOwnRole()
+
     await this.#throwIfCannotLeaveProject()
 
-    await this.#roles.assignRole(this.#deviceId, LEFT_ROLE_ID)
+    if (ownRole.roleId !== BLOCKED_ROLE_ID) {
+      await this.#roles.assignRole(this.#deviceId, LEFT_ROLE_ID)
+    }
 
     await this[kClearData]()
   }

package/src/member-api.js

@@ -22,6 +22,7 @@ import { InviteAbortedError, ProjectDetailsSendFailError } from './errors.js'
 import { wsCoreReplicator } from './lib/ws-core-replicator.js'
 import {
   BLOCKED_ROLE_ID,
+  LEFT_ROLE_ID,
   MEMBER_ROLE_ID,
   ROLES,
   isRoleIdForNewInvite,
@@ -355,6 +356,25 @@ export class MemberApi extends TypedEmitter {
     })
   }
 
+  /**
+   * Remove a member from the project
+   * @param {string} deviceId Device id of member to remove
+   * @param {object} [opts]
+   * @param {string} opts.reason
+   */
+  async remove(deviceId, opts) {
+    const member = await this.getById(deviceId)
+    const { roleId } = member.role
+
+    if (roleId === BLOCKED_ROLE_ID || roleId === LEFT_ROLE_ID) {
+      throw new ErrorWithCode('ALREADY_BLOCKED', 'Member already blocked')
+    }
+
+    // Add blocked role to project
+    // Should error if you don't have permission to do so
+    await this.#roles.assignRole(deviceId, BLOCKED_ROLE_ID, opts)
+  }
+
   /**
    * Remove a server peer. Only works when the peer is reachable
    *

package/src/roles.js

@@ -292,6 +292,19 @@ export class Roles extends TypedEmitter {
     return ROLES[roleId]
   }
 
+  /**
+   * Get the reason for the role of `deviceId` (if it exists).
+   *
+   * @param {string} deviceId
+   * @returns {Promise<string | null>}
+   */
+  async getRoleReason(deviceId) {
+    const roleRecord = await this.#dataType
+      .getByDocId(deviceId)
+      .catch(nullIfNotFound)
+    return roleRecord?.reason ?? null
+  }
+
   /**
    * Get roles of all devices in the project. For your own device, if you have
    * not yet synced your own role record, the "no role" capabilties is
@@ -346,8 +359,10 @@ export class Roles extends TypedEmitter {
    *
    * @param {string} deviceId
    * @param {RoleIdAssignableToAnyone} roleId
+   * @param {object} [opts]
+   * @param {string} opts.reason
    */
-  async assignRole(deviceId, roleId) {
+  async assignRole(deviceId, roleId, opts) {
     assert(
       isRoleIdAssignableToAnyone(roleId),
       `Role ID should be assignable to anyone but got ${roleId}`
@@ -398,6 +413,7 @@ export class Roles extends TypedEmitter {
           schemaName: 'role',
           roleId,
           fromIndex,
+          reason: opts?.reason,
         }
       )
     } else {