@comapeo/core 5.5.0 → 6.0.0

package/src/fastify-plugins/blobs.js

@@ -5,7 +5,13 @@ import { Type as T } from '@sinclair/typebox'
 
 import { SUPPORTED_BLOB_VARIANTS } from '../blob-store/index.js'
 import { HEX_REGEX_32_BYTES, Z_BASE_32_REGEX_32_BYTES } from './constants.js'
-import { getErrorMessage } from '../lib/error.js'
+import { ensureKnownError } from '../errors.js'
+import {
+  BlobNotFoundError,
+  BlobStoreEntryNotFoundError,
+  UnsupportedVariantError,
+} from '../errors.js'
+import ensureError from 'ensure-error'
 
 /** @import { BlobId } from '../types.js' */
 
@@ -45,7 +51,7 @@ const PARAMS_JSON_SCHEMA = T.Object({
 
 /** @type {import('fastify').FastifyPluginAsync<import('fastify').RegisterOptions & BlobServerPluginOpts>} */
 async function blobServerPlugin(fastify, options) {
-  if (!options.getBlobStore) throw new Error('Missing getBlobStore')
+  if (!options.getBlobStore) throw new TypeError('Missing getBlobStore')
 
   // We call register here so that the `prefix` option can work if desired
   // https://fastify.dev/docs/latest/Reference/Routes#route-prefixing-and-fastify-plugin
@@ -64,9 +70,10 @@ async function routes(fastify, options) {
 
       if (!isValidBlobId(blobId)) {
         reply.code(400)
-        throw new Error(
-          `Unsupported variant "${blobId.variant}" for ${blobId.type}`
-        )
+        throw new UnsupportedVariantError({
+          variant: blobId.variant,
+          type: blobId.type,
+        })
       }
       const { driveId } = blobId
 
@@ -75,7 +82,7 @@ async function routes(fastify, options) {
         blobStore = await getBlobStore(projectPublicId)
       } catch (e) {
         reply.code(404)
-        throw e
+        throw ensureKnownError(e)
       }
 
       let entry
@@ -83,12 +90,12 @@ async function routes(fastify, options) {
         entry = await blobStore.entry(blobId, { wait: false })
       } catch (e) {
         reply.code(404)
-        throw e
+        throw ensureKnownError(e)
       }
 
       if (!entry) {
         reply.code(404)
-        throw new Error('Entry not found')
+        throw new BlobStoreEntryNotFoundError()
       }
 
       const { metadata } = entry.value
@@ -98,19 +105,19 @@ async function routes(fastify, options) {
         blobStream = await blobStore.createReadStreamFromEntry(driveId, entry)
       } catch (e) {
         reply.code(404)
-        throw e
+        throw ensureKnownError(e)
       }
 
       try {
         await pEvent(blobStream, 'readable', { rejectionEvents: ['error'] })
-      } catch (err) {
+      } catch (e) {
         // This matches [how Hyperblobs checks if a blob is unavailable][0].
         // [0]: https://github.com/holepunchto/hyperblobs/blob/518088d2b828082fd70a276fa2c8848a2cf2a56b/index.js#L49
-        if (getErrorMessage(err) === 'Block not available') {
+        if (ensureError(e).message === 'Block not available') {
           reply.code(404)
-          throw new Error('Blob not found')
+          throw new BlobNotFoundError()
         } else {
-          throw err
+          throw ensureKnownError(e)
         }
       }
 
@@ -130,7 +137,7 @@ async function routes(fastify, options) {
 
         if (!blobSlice) {
           reply.code(404)
-          throw new Error('Blob not found')
+          throw new BlobNotFoundError()
         }
 
         const [guessedMime] = filetypemime(blobSlice)

package/src/fastify-plugins/icons.js

@@ -4,7 +4,12 @@ import { docSchemas } from '@comapeo/schema'
 
 import { kGetIconBlob } from '../icon-api.js'
 import { HEX_REGEX_32_BYTES, Z_BASE_32_REGEX_32_BYTES } from './constants.js'
-import { ExhaustivenessError } from '../utils.js'
+import {
+  ensureKnownError,
+  InvalidIconPixelDensityError,
+  InvalidIconSizeError,
+  ExhaustivenessError,
+} from '../errors.js'
 
 export default fp(iconServerPlugin, {
   fastify: '4.x',
@@ -42,7 +47,7 @@ const PARAMS_JSON_SCHEMA = T.Object({
         case 'image/svg+xml':
           return T.Literal('svg')
         default:
-          throw new ExhaustivenessError(mimeType)
+          throw new ExhaustivenessError({ value: mimeType })
       }
     })
   ),
@@ -56,7 +61,7 @@ const PARAMS_JSON_SCHEMA = T.Object({
 
 /** @type {import('fastify').FastifyPluginAsync<import('fastify').RegisterOptions & IconServerPluginOpts>} */
 async function iconServerPlugin(fastify, options) {
-  if (!options.getProject) throw new Error('Missing getProject')
+  if (!options.getProject) throw new TypeError('Missing getProject')
   fastify.register(routes, options)
 }
 
@@ -95,9 +100,9 @@ async function routes(fastify, options) {
 
         res.header('Content-Type', mimeType)
         return res.send(icon)
-      } catch (err) {
+      } catch (e) {
         res.code(404)
-        throw err
+        throw ensureKnownError(e)
       }
     }
   )
@@ -143,16 +148,20 @@ function assertValidSize(value) {
       value
     )
   ) {
-    throw new Error(`'${value}' is not a valid icon size`)
+    throw new InvalidIconSizeError({ value })
   }
 }
 
 /**
- * @param {unknown} value
+ * @param {number} value
  * @returns {asserts value is import('../icon-api.js').BitmapOpts['pixelDensity']}
  */
 function assertValidPixelDensity(value) {
-  if (!VALID_PIXEL_DENSITIES.includes(/** @type {any} */ (value))) {
-    throw new Error(`${value} is not a valid icon pixel density`)
+  if (
+    !VALID_PIXEL_DENSITIES.includes(
+      /** @type {import('../icon-api.js').BitmapOpts['pixelDensity']} */ (value)
+    )
+  ) {
+    throw new InvalidIconPixelDensityError({ density: value })
   }
 }

package/src/fastify-plugins/maps.js

@@ -5,7 +5,8 @@ import { ReaderWatch, createServer } from 'styled-map-package'
 
 import { noop } from '../utils.js'
 import { NotFoundError, ENOENTError } from './utils.js'
-import { getErrorCode } from '../lib/error.js'
+import { ensureKnownError, getErrorCode } from '../errors.js'
+import { FailedToGetStyleError } from '../errors.js'
 
 /** @import { FastifyPluginAsync } from 'fastify' */
 /** @import { Stats } from 'node:fs' */
@@ -48,7 +49,7 @@ export async function plugin(fastify, opts) {
       }
 
       if (!response.ok) {
-        throw new Error(`Failed to get style from ${customStyleJsonUrl.href}`)
+        throw new FailedToGetStyleError(customStyleJsonUrl)
       }
 
       /** @type {Stats | undefined} */
@@ -56,12 +57,12 @@ export async function plugin(fastify, opts) {
 
       try {
         stats = await fs.stat(customMapPath)
-      } catch (err) {
-        if (getErrorCode(err) === 'ENOENT') {
+      } catch (e) {
+        if (getErrorCode(e) === 'ENOENT') {
           throw new ENOENTError(customMapPath)
         }
 
-        throw err
+        throw ensureKnownError(e)
       }
 
       const style = await response.json()

package/src/generated/rpc.d.ts

@@ -10,6 +10,7 @@ export interface Invite {
     projectColor?: string | undefined;
     projectDescription?: string | undefined;
     sendStats: boolean;
+    invitorWroteDeviceInfo: boolean;
 }
 export interface InviteCancel {
     inviteId: Buffer;

package/src/generated/rpc.js

@@ -122,6 +122,7 @@ function createBaseInvite() {
         projectName: "",
         invitorName: "",
         sendStats: false,
+        invitorWroteDeviceInfo: false,
     };
 }
 export var Invite = {
@@ -154,6 +155,9 @@ export var Invite = {
         if (message.sendStats === true) {
             writer.uint32(72).bool(message.sendStats);
         }
+        if (message.invitorWroteDeviceInfo === true) {
+            writer.uint32(80).bool(message.invitorWroteDeviceInfo);
+        }
         return writer;
     },
     decode: function (input, length) {
@@ -217,6 +221,12 @@ export var Invite = {
                     }
                     message.sendStats = reader.bool();
                     continue;
+                case 10:
+                    if (tag !== 80) {
+                        break;
+                    }
+                    message.invitorWroteDeviceInfo = reader.bool();
+                    continue;
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -229,7 +239,7 @@ export var Invite = {
         return Invite.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial: function (object) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
         var message = createBaseInvite();
         message.inviteId = (_a = object.inviteId) !== null && _a !== void 0 ? _a : Buffer.alloc(0);
         message.projectInviteId = (_b = object.projectInviteId) !== null && _b !== void 0 ? _b : Buffer.alloc(0);
@@ -240,6 +250,7 @@ export var Invite = {
         message.projectColor = (_g = object.projectColor) !== null && _g !== void 0 ? _g : undefined;
         message.projectDescription = (_h = object.projectDescription) !== null && _h !== void 0 ? _h : undefined;
         message.sendStats = (_j = object.sendStats) !== null && _j !== void 0 ? _j : false;
+        message.invitorWroteDeviceInfo = (_k = object.invitorWroteDeviceInfo) !== null && _k !== void 0 ? _k : false;
         return message;
     },
 };

package/src/generated/rpc.ts

@@ -12,6 +12,7 @@ export interface Invite {
   projectColor?: string | undefined;
   projectDescription?: string | undefined;
   sendStats: boolean;
+  invitorWroteDeviceInfo: boolean;
 }
 
 export interface InviteCancel {
@@ -187,6 +188,7 @@ function createBaseInvite(): Invite {
     projectName: "",
     invitorName: "",
     sendStats: false,
+    invitorWroteDeviceInfo: false,
   };
 }
 
@@ -219,6 +221,9 @@ export const Invite = {
     if (message.sendStats === true) {
       writer.uint32(72).bool(message.sendStats);
     }
+    if (message.invitorWroteDeviceInfo === true) {
+      writer.uint32(80).bool(message.invitorWroteDeviceInfo);
+    }
     return writer;
   },
 
@@ -292,6 +297,13 @@ export const Invite = {
 
           message.sendStats = reader.bool();
           continue;
+        case 10:
+          if (tag !== 80) {
+            break;
+          }
+
+          message.invitorWroteDeviceInfo = reader.bool();
+          continue;
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -315,6 +327,7 @@ export const Invite = {
     message.projectColor = object.projectColor ?? undefined;
     message.projectDescription = object.projectDescription ?? undefined;
     message.sendStats = object.sendStats ?? false;
+    message.invitorWroteDeviceInfo = object.invitorWroteDeviceInfo ?? false;
     return message;
   },
 };

package/src/icon-api.js

@@ -1,5 +1,13 @@
 /** @import { PresetValue, IconValue } from '@comapeo/schema' */
 
+import {
+  EmptyIconPathError,
+  EmptyVariantsArrayError,
+  InvalidPixelDensityError,
+  NoVariantsExistError,
+  NoVariantsForMimeTypeError,
+} from './errors.js'
+
 export const kGetIconBlob = Symbol('getIcon')
 
 /** @typedef {PresetValue['iconRef']} IconRef */
@@ -59,7 +67,7 @@ export class IconApi {
    */
   async create(icon) {
     if (icon.variants.length < 1) {
-      throw new Error('empty variants array')
+      throw new EmptyVariantsArrayError()
     }
 
     const savedVariants = await Promise.all(
@@ -158,15 +166,13 @@ export function getBestVariant(variants, opts) {
     wantedPixelDensity = opts.pixelDensity
   }
   if (variants.length === 0) {
-    throw new Error('No variants exist')
+    throw new NoVariantsExistError()
   }
 
   const matchingMime = variants.filter((v) => v.mimeType === wantedMimeType)
 
   if (matchingMime.length === 0) {
-    throw new Error(
-      `No variants with desired mime type ${wantedMimeType} exist`
-    )
+    throw new NoVariantsForMimeTypeError({ wantedMimeType })
   }
   const wantedSizeNum = SIZE_AS_NUMERIC[wantedSize]
 
@@ -264,14 +270,16 @@ function determineSortValue(target, a, b) {
  */
 export function constructIconPath({ size, pixelDensity, iconId, extension }) {
   if (iconId.length === 0 || size.length === 0 || extension.length === 0) {
-    throw new Error('iconId, size, and extension cannot be empty strings')
+    throw new EmptyIconPathError()
   }
 
   let result = `${iconId}/${size}`
 
   if (typeof pixelDensity === 'number') {
     if (pixelDensity < 1) {
-      throw new Error('pixelDensity must be a positive number')
+      throw new InvalidPixelDensityError({
+        pixelDensity,
+      })
     }
     result += `@${pixelDensity}x`
   }

package/src/import-categories.js

@@ -3,6 +3,7 @@ import { Reader } from 'comapeocat/reader.js'
 import { typedEntries } from './utils.js'
 import { parseBcp47 } from './intl/parse-bcp-47.js'
 import ensureError from 'ensure-error'
+import { IconNotFoundError, KeyNotFoundError } from './errors.js'
 
 // The main reason for the concurrency limit is to avoid run-away memory usage.
 // The comapeocat Reader limits icon size to 2Mb (as-per the specification), and
@@ -75,7 +76,7 @@ export async function importCategories(project, { filePath, logger }) {
           const iconXml = await reader.getIcon(iconName)
           if (!iconXml) {
             // This should never happen because of the validate() call above
-            throw new Error(`Icon ${iconName} not found in import file`)
+            throw new IconNotFoundError(iconName)
           }
           /** @type {Parameters<typeof project.$icons.create>[0]} */
           const icon = {
@@ -308,7 +309,7 @@ export async function importCategories(project, { filePath, logger }) {
     // flow statements (return, throw, break, continue) in the finally block
     // will "mask" any completion value of the try block or catch block)
     await reader.close().catch((e) => {
-      logger.log('error closing import file reader', e)
+      logger.log('ERROR: closing import file reader', e)
     })
   }
 }
@@ -349,19 +350,17 @@ function appliesToToGeometry(appliesTo) {
 /**
  * Get a value from a Map, or throw an error if the key is not present
  *
- * @template K, V
+ * @template {string} K, V
  * @param {Map<K, V>} map
  * @param {K} key
- * @param {string | Error} [msgOrError]
  * @returns {V}
  * @throws {TypeError} if `map` is not a Map
  * @throws {Error} if `key` is not in `map` (with `msgOrError` as message or the default message)
  */
-function getOrThrow(map, key, msgOrError) {
+function getOrThrow(map, key) {
   if (!(map instanceof Map)) throw new TypeError('map must be a Map')
   if (!map.has(key)) {
-    if (msgOrError instanceof Error) throw msgOrError
-    throw new Error(msgOrError ?? `key ${key} not found in map`)
+    throw new KeyNotFoundError(key)
   }
   return /** @type {V} */ (map.get(key))
 }

package/src/index-writer/index.js

@@ -4,6 +4,7 @@ import { getTableConfig } from 'drizzle-orm/sqlite-core'
 import { getBacklinkTableName } from '../schema/comapeo-to-drizzle.js'
 import { discoveryKey } from 'hypercore-crypto'
 import { Logger } from '../logger.js'
+import { UnknownSchemaError } from '../errors.js'
 /** @import { MapeoDoc, VersionIdObject } from '@comapeo/schema' */
 /** @import { MapeoDocTables } from '../datatype/index.js' */
 
@@ -76,7 +77,7 @@ export class IndexWriter {
       try {
         const version = { coreDiscoveryKey: discoveryKey(key), index }
         doc = this.#mapDoc(decode(block, version), version)
-      } catch (e) {
+      } catch {
         this.#l.log('Could not decode entry %d of %h', index, key)
         // Unknown or invalid entry - silently ignore
         continue
@@ -119,7 +120,7 @@ export class IndexWriter {
   deleteSchema(schemaName) {
     const indexer = this.#indexers.get(schemaName)
     if (!indexer) {
-      throw new Error(`IndexWriter doesn't know a schema named "${schemaName}"`)
+      throw new UnknownSchemaError({ schemaName })
     }
     indexer.deleteAll()
   }

package/src/index.js

@@ -34,6 +34,7 @@ export { MapeoManager } from './mapeo-manager.js'
 /**
  * @namespace MemberApi
  * @typedef {import('./member-api.js').MemberInfo} MemberApi.MemberInfo
+ * @typedef {import('./member-api.js').ActiveMemberInfo} MemberApi.ActiveMemberInfo
  * @typedef {import('./roles.js').RoleId} MemberApi.RoleId
  * @typedef {import('./roles.js').RoleIdForNewInvite} MemberApi.RoleIdForNewInvite
  * @typedef {import('./roles.js').RoleIdAssignableToOthers} MemberApi.RoleIdAssignableToOthers

package/src/intl/parse-bcp-47.js

@@ -4,6 +4,7 @@ import { iso6391To6393, iso6393 } from './iso639.js'
 import { iso31661 } from 'iso-3166'
 import { iso31661Alpha3ToAlpha2 } from 'iso-3166'
 import { unM49 as unM49Array } from 'un-m49'
+import { InvalidLanguageTagError } from '../errors.js'
 
 /**
  * Map of UN M.49 country codes to their corresponding ISO 3166-1 alpha-2 country codes.
@@ -82,7 +83,7 @@ export function parseBcp47(languageTag) {
   const normalized = bcp47Normalize(languageTag)
   const { language, region } = simpleParseBcp47(normalized)
   if (!language) {
-    throw new Error(`Invalid BCP 47 language tag: ${languageTag}`)
+    throw new InvalidLanguageTagError({ languageTag })
   }
   return {
     language: normalizePrimaryLanguageSubtag(language),

package/src/invite/invite-api.js

@@ -1,6 +1,6 @@
 import { TypedEmitter } from 'tiny-typed-emitter'
 import { InviteResponse_Decision } from '../generated/rpc.js'
-import { assert, keyToId, noop } from '../utils.js'
+import { keyToId, noop } from '../utils.js'
 import HashMap from '../lib/hashmap.js'
 import timingSafeEqual from 'string-timing-safe-equal'
 import { Logger } from '../logger.js'
@@ -10,6 +10,8 @@ import {
   NotFoundError,
   AlreadyJoinedError,
   InviteSendError,
+  ensureKnownError,
+  InviteNotFoundError,
 } from '../errors.js'
 
 /** @import { ProjectToAddDetails } from '../mapeo-manager.js' */
@@ -79,24 +81,24 @@ export class InviteApi extends TypedEmitter {
     this.rpc.on('invite', (...args) => {
       try {
         this.#handleNewInvite(...args)
-      } catch (err) {
-        console.error('Error handling invite', err)
+      } catch (e) {
+        this.#l.log('ERROR: could not handle invite', e)
       }
     })
 
     this.rpc.on('invite-cancel', (_peerId, inviteCancel) => {
       try {
         this.#handleInviteCancel(inviteCancel)
-      } catch (err) {
-        console.error('Error handling invite cancel', err)
+      } catch (e) {
+        this.#l.log('ERROR: could not handle invite cancel', e)
       }
     })
 
     this.rpc.on('got-project-details', (peerId, projectJoinDetails) => {
       try {
         this.#handleGotProjectDetails(peerId, projectJoinDetails)
-      } catch (err) {
-        console.error('Error handling got-project-details', err)
+      } catch (e) {
+        this.#l.log('ERROR: could not handle got-project-details', e)
       }
     })
   }
@@ -127,6 +129,7 @@ export class InviteApi extends TypedEmitter {
       projectColor,
       projectDescription,
       sendStats,
+      invitorWroteDeviceInfo,
     } = inviteRpcMessage
     const invite = { ...inviteRpcMessage, receivedAt: Date.now() }
 
@@ -167,6 +170,7 @@ export class InviteApi extends TypedEmitter {
               projectColor,
               projectDescription,
               sendStats,
+              invitorWroteDeviceInfo,
             })
           }),
         },
@@ -202,7 +206,9 @@ export class InviteApi extends TypedEmitter {
     this.#l.log('Received invite cancel for invite ID %h', inviteId)
 
     const invite = this.#invites.get(inviteId)
-    assert(!!invite, `Cannot find invite ${inviteId.toString('hex')}`)
+    if (!invite) {
+      throw new InviteNotFoundError({ inviteId: inviteId.toString('hex') })
+    }
 
     // TODO: Move this logging to the state machine
     const state = invite.actor.getSnapshot()
@@ -292,10 +298,9 @@ export class InviteApi extends TypedEmitter {
       const inviteId = Buffer.from(inviteIdString, 'hex')
 
       const invite = this.#invites.get(inviteId)
-      assert(
-        !!invite,
-        new NotFoundError(`Cannot find invite ${inviteIdString}`)
-      )
+      if (!invite) {
+        throw new InviteNotFoundError({ inviteId: inviteId.toString('hex') })
+      }
       assertCanSend(invite.actor, { type: 'ACCEPT_INVITE' })
 
       this.#l.log('Accepting invite %h', inviteId)
@@ -321,9 +326,9 @@ export class InviteApi extends TypedEmitter {
       }
 
       return projectPublicId
-    } catch (err) {
-      this.#l.log('ERROR: Unable to accept invite', err)
-      throw err
+    } catch (e) {
+      this.#l.log('ERROR: Unable to accept invite', e)
+      throw ensureKnownError(e)
     }
   }
 
@@ -335,7 +340,9 @@ export class InviteApi extends TypedEmitter {
     const inviteId = Buffer.from(inviteIdString, 'hex')
 
     const invite = this.#invites.get(inviteId)
-    assert(!!invite, `Cannot find invite ${inviteIdString}`)
+    if (!invite) {
+      throw new InviteNotFoundError({ inviteId: inviteId.toString('hex') })
+    }
     assertCanSend(invite.actor, { type: 'REJECT_INVITE' })
 
     this.#l.log('Rejecting invite %h', inviteId)
@@ -381,14 +388,13 @@ function toInvite(internal, snapshot, invitorDeviceId) {
  */
 function assertCanSend(actor, eventType) {
   const state = actor.getSnapshot()
-  assert(
-    state.can(eventType),
-    new InviteSendError(
+  if (!state.can(eventType)) {
+    throw new InviteSendError(
       `Cannot send ${JSON.stringify(eventType)} in state ${toStateString(
         state.value
       )}`
     )
-  )
+  }
 }
 
 /**