@comapeo/core 3.0.0 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,20 +1,43 @@
1
1
  import { TypedEmitter } from 'tiny-typed-emitter'
2
2
  import Protomux from 'protomux'
3
+ import timingSafeEqual from 'string-timing-safe-equal'
3
4
  import { assert, ExhaustivenessError, keyToId, noop } from './utils.js'
4
5
  import { isBlank } from './lib/string.js'
5
6
  import cenc from 'compact-encoding'
6
7
  import {
7
8
  DeviceInfo,
8
9
  Invite,
10
+ InviteAck,
9
11
  InviteCancel,
12
+ InviteCancelAck,
10
13
  InviteResponse,
14
+ InviteResponseAck,
11
15
  ProjectJoinDetails,
16
+ ProjectJoinDetailsAck,
17
+ DeviceInfo_RPCFeatures,
12
18
  } from './generated/rpc.js'
13
19
  import pDefer from 'p-defer'
14
20
  import { Logger } from './logger.js'
15
21
  import pTimeout, { TimeoutError } from 'p-timeout'
16
22
  /** @import NoiseStream from '@hyperswarm/secret-stream' */
17
23
  /** @import { OpenedNoiseStream } from './lib/noise-secret-stream-helpers.js' */
24
+ /** @import {DeferredPromise} from 'p-defer' */
25
+
26
+ /**
27
+ * @typedef {InviteAck|InviteCancelAck|InviteResponseAck|ProjectJoinDetailsAck} AckResponse
28
+ */
29
+
30
+ /**
31
+ * @callback AckFilter
32
+ * @param {AckResponse} ack
33
+ * @returns {boolean}
34
+ */
35
+
36
+ /**
37
+ * @typedef {object} AckWaiter
38
+ * @property {AckFilter} filter
39
+ * @property {DeferredPromise<void>} deferred
40
+ */
18
41
 
19
42
  // Unique identifier for the mapeo rpc protocol
20
43
  const PROTOCOL_NAME = 'mapeo/rpc'
@@ -33,6 +56,10 @@ const MESSAGE_TYPES = {
33
56
  InviteResponse: 2,
34
57
  ProjectJoinDetails: 3,
35
58
  DeviceInfo: 4,
59
+ InviteAck: 5,
60
+ InviteCancelAck: 6,
61
+ InviteResponseAck: 7,
62
+ ProjectJoinDetailsAck: 8,
36
63
  }
37
64
  const MESSAGES_MAX_ID = Math.max.apply(null, [...Object.values(MESSAGE_TYPES)])
38
65
 
@@ -62,9 +89,14 @@ class Peer {
62
89
  #name
63
90
  /** @type {DeviceInfo['deviceType']} */
64
91
  #deviceType
92
+ /** @type {DeviceInfo['features']} */
93
+ #features = []
65
94
  #connectedAt = 0
66
95
  #disconnectedAt = 0
67
96
  #drainedListeners = new Set()
97
+ // Map of type -> Set<{filter, deferred}>
98
+ /** @type Map<keyof typeof MESSAGE_TYPES, Set<AckWaiter>>*/
99
+ #ackWaiters = new Map()
68
100
  #protomux
69
101
  #log
70
102
 
@@ -161,6 +193,12 @@ class Peer {
161
193
  for (const listener of this.#drainedListeners) {
162
194
  listener.reject(new Error('RPC Disconnected before sending'))
163
195
  }
196
+ for (const waiters of this.#ackWaiters.values()) {
197
+ for (const { deferred } of waiters) {
198
+ deferred.reject(new Error('RPC disconnected before receiving ACK'))
199
+ }
200
+ }
201
+ this.#ackWaiters.clear()
164
202
  this.#drainedListeners.clear()
165
203
  this.#log('disconnected')
166
204
  }
@@ -186,6 +224,53 @@ class Peer {
186
224
  await onDrain.promise
187
225
  }
188
226
 
227
+ /**
228
+ * Check if RPC Acknowledgement messages are supported by this peer
229
+ * @returns {boolean}
230
+ */
231
+ supportsAck() {
232
+ return this.#features.includes(DeviceInfo_RPCFeatures.ack) ?? false
233
+ }
234
+
235
+ /**
236
+ * @param {keyof typeof MESSAGE_TYPES} type
237
+ * @param {AckFilter} filter
238
+ * @returns {Promise<void>}
239
+ */
240
+ async #waitForAck(type, filter) {
241
+ if (!this.supportsAck()) return
242
+ if (!this.#ackWaiters.has(type)) {
243
+ this.#ackWaiters.set(type, new Set())
244
+ }
245
+ const deferred = pDefer()
246
+ this.#ackWaiters.get(type)?.add({
247
+ deferred,
248
+ filter,
249
+ })
250
+
251
+ await deferred.promise
252
+ }
253
+
254
+ /**
255
+ * @param {keyof typeof MESSAGE_TYPES} type
256
+ * @param {AckResponse} ack
257
+ */
258
+ receiveAck(type, ack) {
259
+ if (!this.supportsAck()) return
260
+ if (!this.#ackWaiters.has(type)) return
261
+ const waiters = this.#ackWaiters.get(type)
262
+ if (!waiters || !waiters.size) {
263
+ return
264
+ }
265
+
266
+ for (const waiter of waiters) {
267
+ if (waiter.filter(ack)) {
268
+ waiter.deferred.resolve()
269
+ waiters.delete(waiter)
270
+ }
271
+ }
272
+ }
273
+
189
274
  /**
190
275
  * @param {Buffer} buf
191
276
  * @returns {Promise<void>}
@@ -204,8 +289,24 @@ class Peer {
204
289
  const buf = Buffer.from(Invite.encode(invite).finish())
205
290
  const messageType = MESSAGE_TYPES.Invite
206
291
  await this.#waitForDrain(this.#channel.messages[messageType].send(buf))
292
+ await this.#waitForAck('InviteAck', ({ inviteId }) =>
293
+ timingSafeEqual(inviteId, invite.inviteId)
294
+ )
207
295
  this.#log('sent invite %h', invite.inviteId)
208
296
  }
297
+
298
+ /**
299
+ * @param {Invite} invite
300
+ * @returns {Promise<void>}
301
+ */
302
+ async sendInviteAck({ inviteId }) {
303
+ this.#assertConnected('Peer disconnected before sending invite ack')
304
+ if (!this.supportsAck()) return
305
+ const buf = Buffer.from(InviteAck.encode({ inviteId }).finish())
306
+ const messageType = MESSAGE_TYPES.InviteAck
307
+ await this.#waitForDrain(this.#channel.messages[messageType].send(buf))
308
+ }
309
+
209
310
  /**
210
311
  * @param {InviteCancel} inviteCancel
211
312
  * @returns {Promise<void>}
@@ -215,8 +316,24 @@ class Peer {
215
316
  const buf = Buffer.from(InviteCancel.encode(inviteCancel).finish())
216
317
  const messageType = MESSAGE_TYPES.InviteCancel
217
318
  await this.#waitForDrain(this.#channel.messages[messageType].send(buf))
319
+ await this.#waitForAck('InviteCancelAck', ({ inviteId }) =>
320
+ timingSafeEqual(inviteId, inviteCancel.inviteId)
321
+ )
218
322
  this.#log('sent invite cancel %h', inviteCancel.inviteId)
219
323
  }
324
+
325
+ /**
326
+ * @param {InviteCancel} inviteCancel
327
+ * @returns {Promise<void>}
328
+ */
329
+ async sendInviteCancelAck({ inviteId }) {
330
+ this.#assertConnected('Peer disconnected before sending invite cancel ack')
331
+ if (!this.supportsAck()) return
332
+ const buf = Buffer.from(InviteCancelAck.encode({ inviteId }).finish())
333
+ const messageType = MESSAGE_TYPES.InviteCancelAck
334
+ await this.#waitForDrain(this.#channel.messages[messageType].send(buf))
335
+ }
336
+
220
337
  /**
221
338
  * @param {InviteResponse} response
222
339
  * @returns {Promise<void>}
@@ -226,8 +343,26 @@ class Peer {
226
343
  const buf = Buffer.from(InviteResponse.encode(response).finish())
227
344
  const messageType = MESSAGE_TYPES.InviteResponse
228
345
  await this.#waitForDrain(this.#channel.messages[messageType].send(buf))
346
+ await this.#waitForAck('InviteResponseAck', ({ inviteId }) =>
347
+ timingSafeEqual(inviteId, response.inviteId)
348
+ )
229
349
  this.#log('sent response for %h: %s', response.inviteId, response.decision)
230
350
  }
351
+
352
+ /**
353
+ * @param {InviteResponse} response
354
+ * @returns {Promise<void>}
355
+ */
356
+ async sendInviteResponseAck({ inviteId }) {
357
+ this.#assertConnected(
358
+ 'Peer disconnected before sending invite response ack'
359
+ )
360
+ if (!this.supportsAck()) return
361
+ const buf = Buffer.from(InviteResponseAck.encode({ inviteId }).finish())
362
+ const messageType = MESSAGE_TYPES.InviteResponseAck
363
+ await this.#waitForDrain(this.#channel.messages[messageType].send(buf))
364
+ }
365
+
231
366
  /** @param {ProjectJoinDetails} details */
232
367
  async sendProjectJoinDetails(details) {
233
368
  this.#assertConnected(
@@ -236,8 +371,22 @@ class Peer {
236
371
  const buf = Buffer.from(ProjectJoinDetails.encode(details).finish())
237
372
  const messageType = MESSAGE_TYPES.ProjectJoinDetails
238
373
  await this.#waitForDrain(this.#channel.messages[messageType].send(buf))
374
+ await this.#waitForAck('ProjectJoinDetailsAck', ({ inviteId }) =>
375
+ timingSafeEqual(inviteId, details.inviteId)
376
+ )
239
377
  this.#log('sent project join details for %h', details.projectKey)
240
378
  }
379
+ /** @param {ProjectJoinDetails} details */
380
+ async sendProjectJoinDetailsAck({ inviteId }) {
381
+ this.#assertConnected(
382
+ 'Peer disconnected before sending project join details ack'
383
+ )
384
+ if (!this.supportsAck()) return
385
+ const buf = Buffer.from(ProjectJoinDetailsAck.encode({ inviteId }).finish())
386
+ const messageType = MESSAGE_TYPES.ProjectJoinDetailsAck
387
+ await this.#waitForDrain(this.#channel.messages[messageType].send(buf))
388
+ }
389
+
241
390
  /**
242
391
  * @param {DeviceInfo} deviceInfo
243
392
  * @returns {Promise<void>}
@@ -252,6 +401,7 @@ class Peer {
252
401
  receiveDeviceInfo(deviceInfo) {
253
402
  this.#name = deviceInfo.name
254
403
  this.#deviceType = deviceInfo.deviceType
404
+ this.#features = deviceInfo.features
255
405
  this.#log('received deviceInfo %o', deviceInfo)
256
406
  }
257
407
  /** @param {string} [message] */
@@ -267,9 +417,13 @@ class Peer {
267
417
  * @property {(peers: PeerInfo[]) => void} peers Emitted whenever the connection status of peers changes. An array of peerInfo objects with a peer id and the peer connection status
268
418
  * @property {(peer: PeerInfoConnected) => void} peer-add Emitted when a new peer is connected
269
419
  * @property {(peerId: string, invite: Invite) => void} invite Emitted when an invite is received
420
+ * @property {(peerId: string, invite: InviteAck) => void} invite-ack Emitted when an invite acknowledgement is received
270
421
  * @property {(peerId: string, invite: InviteCancel) => void} invite-cancel Emitted when we receive a cancelation for an invite
422
+ * @property {(peerId: string, invite: InviteCancelAck) => void} invite-cancel-ack Emitted when we receive a cancelation acknowledgement for an invite
271
423
  * @property {(peerId: string, inviteResponse: InviteResponse) => void} invite-response Emitted when an invite response is received
424
+ * @property {(peerId: string, inviteResponse: InviteResponseAck) => void} invite-response-ack Emitted when an invite response acknowledgement is received
272
425
  * @property {(peerId: string, details: ProjectJoinDetails) => void} got-project-details Emitted when project details are received
426
+ * @property {(peerId: string, details: ProjectJoinDetailsAck) => void} got-project-details-ack Emitted when project details are acknowledged as received
273
427
  * @property {(discoveryKey: Buffer, protomux: Protomux<import('@hyperswarm/secret-stream')>) => void} discovery-key Emitted when a new hypercore is replicated (by a peer) to a peer protomux instance (passed as the second parameter)
274
428
  * @property {(messageType: string, errorMessage?: string) => void} failed-to-handle-message Emitted when we received a message we couldn't handle for some reason. Primarily useful for testing
275
429
  */
@@ -572,6 +726,9 @@ export class LocalPeers extends TypedEmitter {
572
726
  const invite = parseInvite(value)
573
727
  const peerId = keyToId(protomux.stream.remotePublicKey)
574
728
  this.emit('invite', peerId, invite)
729
+ peer.sendInviteAck(invite).catch((e) => {
730
+ this.#l.log(`Error sending invite ack ${e.stack}`)
731
+ })
575
732
  this.#l.log(
576
733
  'Invite %h from %S for %h',
577
734
  invite.inviteId,
@@ -584,6 +741,9 @@ export class LocalPeers extends TypedEmitter {
584
741
  const inviteCancel = parseInviteCancel(value)
585
742
  const peerId = keyToId(protomux.stream.remotePublicKey)
586
743
  this.emit('invite-cancel', peerId, inviteCancel)
744
+ peer.sendInviteCancelAck(inviteCancel).catch((e) => {
745
+ this.#l.log(`Error sending invite cancel ack ${e.stack}`)
746
+ })
587
747
  this.#l.log(
588
748
  'Invite cancel from %S for %h',
589
749
  peerId,
@@ -595,12 +755,18 @@ export class LocalPeers extends TypedEmitter {
595
755
  const inviteResponse = parseInviteResponse(value)
596
756
  const peerId = keyToId(protomux.stream.remotePublicKey)
597
757
  this.emit('invite-response', peerId, inviteResponse)
758
+ peer.sendInviteResponseAck(inviteResponse).catch((e) => {
759
+ this.#l.log(`Error sending invite response ack ${e.stack}`)
760
+ })
598
761
  break
599
762
  }
600
763
  case 'ProjectJoinDetails': {
601
764
  const details = parseProjectJoinDetails(value)
602
765
  const peerId = keyToId(protomux.stream.remotePublicKey)
603
766
  this.emit('got-project-details', peerId, details)
767
+ peer.sendProjectJoinDetailsAck(details).catch((e) => {
768
+ this.#l.log(`Error sending project details ack ${e.stack}`)
769
+ })
604
770
  break
605
771
  }
606
772
  case 'DeviceInfo': {
@@ -609,6 +775,34 @@ export class LocalPeers extends TypedEmitter {
609
775
  this.#emitPeers()
610
776
  break
611
777
  }
778
+ case 'InviteAck': {
779
+ const ack = InviteAck.decode(value)
780
+ peer.receiveAck('InviteAck', ack)
781
+ const peerId = keyToId(protomux.stream.remotePublicKey)
782
+ this.emit('invite-ack', peerId, ack)
783
+ break
784
+ }
785
+ case 'InviteCancelAck': {
786
+ const ack = InviteCancelAck.decode(value)
787
+ peer.receiveAck('InviteCancelAck', ack)
788
+ const peerId = keyToId(protomux.stream.remotePublicKey)
789
+ this.emit('invite-cancel-ack', peerId, ack)
790
+ break
791
+ }
792
+ case 'InviteResponseAck': {
793
+ const ack = InviteResponseAck.decode(value)
794
+ peer.receiveAck('InviteResponseAck', ack)
795
+ const peerId = keyToId(protomux.stream.remotePublicKey)
796
+ this.emit('invite-response-ack', peerId, ack)
797
+ break
798
+ }
799
+ case 'ProjectJoinDetailsAck': {
800
+ const ack = ProjectJoinDetailsAck.decode(value)
801
+ peer.receiveAck('ProjectJoinDetailsAck', ack)
802
+ const peerId = keyToId(protomux.stream.remotePublicKey)
803
+ this.emit('got-project-details-ack', peerId, ack)
804
+ break
805
+ }
612
806
  /* c8 ignore next 2 */
613
807
  default:
614
808
  throw new ExhaustivenessError(type)
@@ -25,6 +25,10 @@ import {
25
25
  projectSettingsTable,
26
26
  } from './schema/client.js'
27
27
  import { ProjectKeys } from './generated/keys.js'
28
+ import {
29
+ DeviceInfo_RPCFeatures,
30
+ DeviceInfo_DeviceType,
31
+ } from './generated/rpc.js'
28
32
  import {
29
33
  deNullify,
30
34
  getDeviceId,
@@ -52,13 +56,17 @@ import {
52
56
  kRescindFullStopRequest,
53
57
  } from './sync/sync-api.js'
54
58
  import { NotFoundError } from './errors.js'
55
- /** @import { ProjectSettingsValue as ProjectValue } from '@comapeo/schema' */
59
+ import { WebSocket } from 'ws'
60
+
56
61
  /** @import NoiseSecretStream from '@hyperswarm/secret-stream' */
57
62
  /** @import { SetNonNullable } from 'type-fest' */
63
+ /** @import { ProjectJoinDetails, } from './generated/rpc.js' */
58
64
  /** @import { CoreStorage, Namespace } from './types.js' */
59
- /** @import { DeviceInfoParam } from './schema/client.js' */
65
+ /** @import { DeviceInfoParam, ProjectInfo } from './schema/client.js' */
60
66
 
61
67
  /** @typedef {SetNonNullable<ProjectKeys, 'encryptionKeys'>} ValidatedProjectKeys */
68
+ /** @typedef {Pick<ProjectJoinDetails, 'projectKey' | 'encryptionKeys'> & { projectName: string, projectColor?: string, projectDescription?: string }} ProjectToAddDetails */
69
+ /** @typedef {{ projectId: string, createdAt?: string, updatedAt?: string, name?: string, projectColor?: string, projectDescription?: string }} ListedProject */
62
70
 
63
71
  const CLIENT_SQLITE_FILE_NAME = 'client.db'
64
72
 
@@ -113,6 +121,7 @@ export class MapeoManager extends TypedEmitter {
113
121
  #loggerBase
114
122
  #l
115
123
  #defaultConfigPath
124
+ #makeWebsocket
116
125
 
117
126
  /**
118
127
  * @param {Object} opts
@@ -126,6 +135,7 @@ export class MapeoManager extends TypedEmitter {
126
135
  * @param {string} [opts.customMapPath] File path to a locally stored Styled Map Package (SMP).
127
136
  * @param {string} [opts.fallbackMapPath] File path to a locally stored Styled Map Package (SMP)
128
137
  * @param {string} [opts.defaultOnlineStyleUrl] URL for an online-hosted StyleJSON asset.
138
+ * @param {(url: string) => WebSocket} [opts.makeWebsocket]
129
139
  */
130
140
  constructor({
131
141
  rootKey,
@@ -138,11 +148,13 @@ export class MapeoManager extends TypedEmitter {
138
148
  customMapPath,
139
149
  fallbackMapPath = DEFAULT_FALLBACK_MAP_FILE_PATH,
140
150
  defaultOnlineStyleUrl = DEFAULT_ONLINE_STYLE_URL,
151
+ makeWebsocket = (url) => new WebSocket(url),
141
152
  }) {
142
153
  super()
143
154
  this.#keyManager = new KeyManager(rootKey)
144
155
  this.#deviceId = getDeviceId(this.#keyManager)
145
156
  this.#defaultConfigPath = defaultConfigPath
157
+ this.#makeWebsocket = makeWebsocket
146
158
  const logger = (this.#loggerBase = new Logger({ deviceId: this.#deviceId }))
147
159
  this.#l = Logger.create('manager', logger)
148
160
  this.#dbFolder = dbFolder
@@ -270,9 +282,14 @@ export class MapeoManager extends TypedEmitter {
270
282
  const deviceInfo = this.getDeviceInfo()
271
283
  if (!hasSavedDeviceInfo(deviceInfo)) return
272
284
 
285
+ const deviceInfoToSend = {
286
+ ...deviceInfo,
287
+ features: [DeviceInfo_RPCFeatures.ack],
288
+ }
289
+
273
290
  const peerId = keyToId(openedNoiseStream.remotePublicKey)
274
291
 
275
- return this.#localPeers.sendDeviceInfo(peerId, deviceInfo)
292
+ return this.#localPeers.sendDeviceInfo(peerId, deviceInfoToSend)
276
293
  })
277
294
  .catch((e) => {
278
295
  // Ignore error but log
@@ -318,7 +335,7 @@ export class MapeoManager extends TypedEmitter {
318
335
  * @param {string} opts.projectPublicId
319
336
  * @param {Readonly<Buffer>} opts.projectInviteId
320
337
  * @param {ProjectKeys} opts.projectKeys
321
- * @param {Readonly<{ name?: string }>} [opts.projectInfo]
338
+ * @param {Readonly<ProjectInfo>} [opts.projectInfo]
322
339
  */
323
340
  #saveToProjectKeysTable({
324
341
  projectId,
@@ -353,15 +370,16 @@ export class MapeoManager extends TypedEmitter {
353
370
 
354
371
  /**
355
372
  * Create a new project.
356
- * @param {(
357
- * import('type-fest').Simplify<(
358
- * Partial<Pick<ProjectValue, 'name'>> &
359
- * { configPath?: string }
360
- * )>
361
- * )} [options]
373
+ *
374
+ * @param {{ name?: string, configPath?: string, projectColor?: string, projectDescription?: string }} [options]
362
375
  * @returns {Promise<string>} Project public id
363
376
  */
364
- async createProject({ name, configPath = this.#defaultConfigPath } = {}) {
377
+ async createProject({
378
+ name,
379
+ configPath = this.#defaultConfigPath,
380
+ projectColor,
381
+ projectDescription,
382
+ } = {}) {
365
383
  // 1. Create project keypair
366
384
  const projectKeypair = KeyManager.generateProjectKeypair()
367
385
 
@@ -406,7 +424,11 @@ export class MapeoManager extends TypedEmitter {
406
424
  })
407
425
 
408
426
  // 5. Write project settings to project instance
409
- await project.$setProjectSettings({ name })
427
+ await project.$setProjectSettings({
428
+ name,
429
+ projectColor,
430
+ projectDescription,
431
+ })
410
432
 
411
433
  // 6. Write device info into project
412
434
  const deviceInfo = this.getDeviceInfo()
@@ -495,13 +517,14 @@ export class MapeoManager extends TypedEmitter {
495
517
  logger: this.#loggerBase,
496
518
  getMediaBaseUrl: this.#getMediaBaseUrl.bind(this),
497
519
  isArchiveDevice,
520
+ makeWebsocket: this.#makeWebsocket,
498
521
  })
499
522
  await project[kClearDataIfLeft]()
500
523
  return project
501
524
  }
502
525
 
503
526
  /**
504
- * @returns {Promise<Array<Pick<ProjectValue, 'name'> & { projectId: string, createdAt?: string, updatedAt?: string}>>}
527
+ * @returns {Promise<Array<ListedProject>>}
505
528
  */
506
529
  async listProjects() {
507
530
  // We use the project keys table as the source of truth for projects that exist
@@ -522,11 +545,13 @@ export class MapeoManager extends TypedEmitter {
522
545
  createdAt: projectSettingsTable.createdAt,
523
546
  updatedAt: projectSettingsTable.updatedAt,
524
547
  name: projectSettingsTable.name,
548
+ projectColor: projectSettingsTable.projectColor,
549
+ projectDescription: projectSettingsTable.projectDescription,
525
550
  })
526
551
  .from(projectSettingsTable)
527
552
  .all()
528
553
 
529
- /** @type {Array<Pick<ProjectValue, 'name'> & { projectId: string, createdAt?: string, updatedAt?: string, createdBy?: string }>} */
554
+ /** @type {Array<ListedProject>} */
530
555
  const result = []
531
556
 
532
557
  for (const {
@@ -544,6 +569,11 @@ export class MapeoManager extends TypedEmitter {
544
569
  createdAt: existingProject?.createdAt,
545
570
  updatedAt: existingProject?.updatedAt,
546
571
  name: existingProject?.name || projectInfo.name,
572
+ projectColor:
573
+ existingProject?.projectColor || projectInfo.projectColor,
574
+ projectDescription:
575
+ existingProject?.projectDescription ||
576
+ projectInfo.projectDescription,
547
577
  })
548
578
  )
549
579
  }
@@ -556,12 +586,18 @@ export class MapeoManager extends TypedEmitter {
556
586
  * await `project.$waitForInitialSync()` to ensure that the device has
557
587
  * downloaded their proof of project membership and the project config.
558
588
  *
559
- * @param {Pick<import('./generated/rpc.js').ProjectJoinDetails, 'projectKey' | 'encryptionKeys'> & { projectName: string }} projectJoinDetails
589
+ * @param {ProjectToAddDetails} projectToAddDetails
560
590
  * @param {{ waitForSync?: boolean }} [opts] Set opts.waitForSync = false to not wait for sync during addProject()
561
591
  * @returns {Promise<string>}
562
592
  */
563
593
  addProject = async (
564
- { projectKey, encryptionKeys, projectName },
594
+ {
595
+ projectKey,
596
+ encryptionKeys,
597
+ projectName,
598
+ projectColor,
599
+ projectDescription,
600
+ },
565
601
  { waitForSync = true } = {}
566
602
  ) => {
567
603
  const projectPublicId = projectKeyToPublicId(projectKey)
@@ -599,7 +635,7 @@ export class MapeoManager extends TypedEmitter {
599
635
  projectKey,
600
636
  encryptionKeys,
601
637
  },
602
- projectInfo: { name: projectName },
638
+ projectInfo: { name: projectName, projectColor, projectDescription },
603
639
  })
604
640
 
605
641
  // Any errors from here we need to remove project from db because it has not
@@ -720,7 +756,10 @@ export class MapeoManager extends TypedEmitter {
720
756
  * @param {T} deviceInfo
721
757
  */
722
758
  async setDeviceInfo(deviceInfo) {
723
- const values = { deviceId: this.#deviceId, deviceInfo }
759
+ const values = {
760
+ deviceId: this.#deviceId,
761
+ deviceInfo,
762
+ }
724
763
  this.#db
725
764
  .insert(deviceSettingsTable)
726
765
  .values(values)
@@ -747,6 +786,7 @@ export class MapeoManager extends TypedEmitter {
747
786
  const deviceInfoToSend = {
748
787
  ...deviceInfo,
749
788
  deviceType,
789
+ features: [DeviceInfo_RPCFeatures.ack],
750
790
  }
751
791
  await Promise.all(
752
792
  this.#localPeers.peers
@@ -764,7 +804,7 @@ export class MapeoManager extends TypedEmitter {
764
804
  * @returns {(
765
805
  * {
766
806
  * deviceId: string;
767
- * deviceType: DeviceInfoParam['deviceType']
807
+ * deviceType: DeviceInfoParam['deviceType'];
768
808
  * } & Partial<DeviceInfoParam>
769
809
  * )}
770
810
  */
@@ -776,7 +816,7 @@ export class MapeoManager extends TypedEmitter {
776
816
  .get()
777
817
  return {
778
818
  deviceId: this.#deviceId,
779
- deviceType: 'device_type_unspecified',
819
+ deviceType: DeviceInfo_DeviceType.device_type_unspecified,
780
820
  ...row?.deviceInfo,
781
821
  }
782
822
  }
@@ -57,6 +57,7 @@ import { IconApi } from './icon-api.js'
57
57
  import { readConfig } from './config-import.js'
58
58
  import TranslationApi from './translation-api.js'
59
59
  import { NotFoundError, nullIfNotFound } from './errors.js'
60
+ import { WebSocket } from 'ws'
60
61
  /** @import { ProjectSettingsValue } from '@comapeo/schema' */
61
62
  /** @import { CoreStorage, BlobFilter, BlobStoreEntriesStream, KeyPair, Namespace, ReplicationStream, GenericBlobFilter } from './types.js' */
62
63
 
@@ -116,6 +117,7 @@ export class MapeoProject extends TypedEmitter {
116
117
  * @param {IndexWriter} opts.sharedIndexWriter
117
118
  * @param {CoreStorage} opts.coreStorage Folder to store all hypercore data
118
119
  * @param {(mediaType: 'blobs' | 'icons') => Promise<string>} opts.getMediaBaseUrl
120
+ * @param {(url: string) => WebSocket} [opts.makeWebsocket]
119
121
  * @param {import('./local-peers.js').LocalPeers} opts.localPeers
120
122
  * @param {boolean} opts.isArchiveDevice Whether this device is an archive device
121
123
  * @param {Logger} [opts.logger]
@@ -132,6 +134,7 @@ export class MapeoProject extends TypedEmitter {
132
134
  projectSecretKey,
133
135
  encryptionKeys,
134
136
  getMediaBaseUrl,
137
+ makeWebsocket = (url) => new WebSocket(url),
135
138
  localPeers,
136
139
  logger,
137
140
  isArchiveDevice,
@@ -350,6 +353,7 @@ export class MapeoProject extends TypedEmitter {
350
353
  getProjectName: this.#getProjectName.bind(this),
351
354
  projectKey,
352
355
  rpc: localPeers,
356
+ makeWebsocket,
353
357
  getReplicationStream,
354
358
  waitForInitialSyncWithPeer: (deviceId, abortSignal) =>
355
359
  this.$sync[kWaitForInitialSyncWithPeer](deviceId, abortSignal),
@@ -400,6 +404,7 @@ export class MapeoProject extends TypedEmitter {
400
404
  roles: this.#roles,
401
405
  blobStore: this.#blobStore,
402
406
  logger: this.#l,
407
+ makeWebsocket,
403
408
  getServerWebsocketUrls: async () => {
404
409
  const members = await this.#memberApi.getMany()
405
410
  /** @type {string[]} */
@@ -410,9 +415,9 @@ export class MapeoProject extends TypedEmitter {
410
415
  member.selfHostedServerDetails
411
416
  ) {
412
417
  const { baseUrl } = member.selfHostedServerDetails
413
- const wsUrl = new URL(`/sync/${this.#projectPublicId}`, baseUrl)
414
- wsUrl.protocol = wsUrl.protocol === 'http:' ? 'ws:' : 'wss:'
415
- serverWebsocketUrls.push(wsUrl.href)
418
+ serverWebsocketUrls.push(
419
+ baseUrlToWS(baseUrl, this.#projectPublicId)
420
+ )
416
421
  }
417
422
  }
418
423
  return serverWebsocketUrls
@@ -1086,3 +1091,16 @@ function mapAndValidateDeviceInfo(doc, { coreDiscoveryKey }) {
1086
1091
  }
1087
1092
  return doc
1088
1093
  }
1094
+
1095
+ /**
1096
+ *
1097
+ * @param {string} baseUrl
1098
+ * @param {string} projectPublicId
1099
+ * @returns {string}
1100
+ */
1101
+ export function baseUrlToWS(baseUrl, projectPublicId) {
1102
+ const wsUrl = new URL(`/sync/${projectPublicId}`, baseUrl)
1103
+ wsUrl.protocol = wsUrl.protocol === 'http:' ? 'ws:' : 'wss:'
1104
+
1105
+ return wsUrl.href
1106
+ }