@comapeo/ipc 0.16.0 → 1.0.0

package/README.md

@@ -1,6 +1,6 @@
-# @mapeo/ipc
+# @comapeo/ipc
 
-IPC wrappers for [Mapeo Core](https://github.com/digidem/mapeo-core-next). Meant to be used in contexts where there is a communication boundary between the contexts your code runs in e.g. Electron, React Native (with NodeJS Mobile), and NodeJS worker threads. The [channel messaging API](https://developer.mozilla.org/en-US/docs/Web/API/Channel_Messaging_API) is an example where this usage applies.
+IPC wrappers for [CoMapeo Core](https://github.com/digidem/comapeo-core). Meant to be used in contexts where there is a communication boundary between the contexts your code runs in e.g. Electron, React Native (with NodeJS Mobile), and NodeJS worker threads. The [channel messaging API](https://developer.mozilla.org/en-US/docs/Web/API/Channel_Messaging_API) is an example where this usage applies.
 
 ## Table of Contents
 
@@ -11,17 +11,17 @@ IPC wrappers for [Mapeo Core](https://github.com/digidem/mapeo-core-next). Meant
 
 ## Installation
 
-Note that [`@mapeo/core`](https://github.com/digidem/mapeo-core-next) is a peer dependency, so you may have to install it manually depending on your package manager.
+Note that [`@comapeo/core`](https://github.com/digidem/comapeo-core) is a peer dependency, so you may have to install it manually depending on your package manager.
 
 ```sh
-npm install @mapeo/ipc @mapeo/core
+npm install @comapeo/ipc @comapeo/core
 ```
 
 ## API
 
 ### `createMapeoServer(manager: MapeoManager, messagePort: MessagePortLike): { close: () => void }`
 
-Creates the IPC server instance. `manager` is a `@mapeo/core` `MapeoManager` instance and `messagePort` is an interface that resembles a [`MessagePort`](https://developer.mozilla.org/en-US/docs/Web/API/MessagePort).
+Creates the IPC server instance. `manager` is a `@comapeo/core` `MapeoManager` instance and `messagePort` is an interface that resembles a [`MessagePort`](https://developer.mozilla.org/en-US/docs/Web/API/MessagePort).
 
 Returns an object with a `close()` method, which removes relevant event listeners from the `messagePort`. Does not close or destroy the `messagePort`.
 
@@ -40,8 +40,8 @@ Closes the IPC client instance. Does not close or destroy the `messagePort` prov
 In the server:
 
 ```ts
-import { MapeoManager } from '@mapeo/core'
-import { createMapeoServer } from '@mapeo/ipc'
+import { MapeoManager } from '@comapeo/core'
+import { createMapeoServer } from '@comapeo/ipc'
 
 // Create Mapeo manager instance
 const manager = new MapeoManager({...})
@@ -59,7 +59,7 @@ server.close()
 In the client:
 
 ```ts
-import { createMapeoClient, closeMapeoClient } from '@mapeo/ipc'
+import { createMapeoClient, closeMapeoClient } from '@comapeo/ipc'
 
 // Create the client instance
 // `messagePort` can vary based on context (e.g. a port from a MessageChannel, a NodeJS Mobile bridge channel, etc.)

package/dist/client.d.ts

@@ -13,17 +13,17 @@ export function createMapeoClient(messagePort: import('./lib/sub-channel.js').Me
  * @returns {Promise<void>}
  */
 export function closeMapeoClient(client: MapeoClientApi): Promise<void>;
-export type MapeoProjectApi = import('rpc-reflector/client.js').ClientApi<import('@mapeo/core/dist/mapeo-project.js').MapeoProject>;
+export type MapeoProjectApi = import('rpc-reflector/client.js').ClientApi<import('@comapeo/core/dist/mapeo-project.js').MapeoProject>;
 export type MapeoClientApi = {
-    addListener: <U extends "local-peers">(event: U, listener: import("@mapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U]) => import("@mapeo/core").MapeoManager;
-    on: <U_1 extends "local-peers">(event: U_1, listener: import("@mapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_1]) => import("@mapeo/core").MapeoManager;
-    once: <U_2 extends "local-peers">(event: U_2, listener: import("@mapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_2]) => import("@mapeo/core").MapeoManager;
-    removeListener: <U_3 extends "local-peers">(event: U_3, listener: import("@mapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_3]) => import("@mapeo/core").MapeoManager;
-    off: <U_4 extends "local-peers">(event: U_4, listener: import("@mapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_4]) => import("@mapeo/core").MapeoManager;
-    removeAllListeners: (event?: "local-peers" | undefined) => import("@mapeo/core").MapeoManager;
-    listeners: <U_5 extends "local-peers">(type: U_5) => import("@mapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_5][];
-    rawListeners: <U_6 extends "local-peers">(type: U_6) => import("@mapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_6][];
-    emit: <U_7 extends "local-peers">(event: U_7, ...args: Parameters<import("@mapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_7]>) => boolean;
+    addListener: <U extends "local-peers">(event: U, listener: import("@comapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U]) => import("@comapeo/core").MapeoManager;
+    on: <U_1 extends "local-peers">(event: U_1, listener: import("@comapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_1]) => import("@comapeo/core").MapeoManager;
+    once: <U_2 extends "local-peers">(event: U_2, listener: import("@comapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_2]) => import("@comapeo/core").MapeoManager;
+    removeListener: <U_3 extends "local-peers">(event: U_3, listener: import("@comapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_3]) => import("@comapeo/core").MapeoManager;
+    off: <U_4 extends "local-peers">(event: U_4, listener: import("@comapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_4]) => import("@comapeo/core").MapeoManager;
+    removeAllListeners: (event?: "local-peers" | undefined) => import("@comapeo/core").MapeoManager;
+    listeners: <U_5 extends "local-peers">(type: U_5) => import("@comapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_5][];
+    rawListeners: <U_6 extends "local-peers">(type: U_6) => import("@comapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_6][];
+    emit: <U_7 extends "local-peers">(event: U_7, ...args: Parameters<import("@comapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_7]>) => boolean;
     listenerCount: (type: "local-peers") => number;
     eventNames: <U_8 extends "local-peers">() => U_8[];
     readonly deviceId: () => Promise<string>;
@@ -52,23 +52,23 @@ export type MapeoClientApi = {
         createdAt?: string | undefined;
         updatedAt?: string | undefined;
     })[]>;
-    addProject: ({ projectKey, encryptionKeys, projectName }: Pick<import("@mapeo/core/dist/generated/rpc.js").ProjectJoinDetails, "projectKey" | "encryptionKeys"> & {
+    addProject: ({ projectKey, encryptionKeys, projectName }: Pick<import("@comapeo/core/dist/generated/rpc.js").ProjectJoinDetails, "projectKey" | "encryptionKeys"> & {
         projectName: string;
     }, { waitForSync }?: {
         waitForSync?: boolean | undefined;
     } | undefined) => Promise<string>;
-    setDeviceInfo: <T extends import("type-fest").IsEqual<import("@mapeo/core/dist/schema/client.js").DeviceInfoParam & {
+    setDeviceInfo: <T extends import("type-fest").IsEqual<import("@comapeo/core/dist/schema/client.js").DeviceInfoParam & {
         deviceType?: "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "UNRECOGNIZED" | undefined;
-    }, T> extends true ? import("@mapeo/core/dist/schema/client.js").DeviceInfoParam & {
+    }, T> extends true ? import("@comapeo/core/dist/schema/client.js").DeviceInfoParam & {
         deviceType?: "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "UNRECOGNIZED" | undefined;
-    } : import("type-fest/source/exact.js").ExactObject<import("@mapeo/core/dist/schema/client.js").DeviceInfoParam & {
+    } : import("type-fest/source/exact.js").ExactObject<import("@comapeo/core/dist/schema/client.js").DeviceInfoParam & {
         deviceType?: "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "UNRECOGNIZED" | undefined;
     }, T>>(deviceInfo: T) => Promise<void>;
     getDeviceInfo: () => Promise<{
         deviceId: string;
         deviceType: "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer" | "UNRECOGNIZED";
-    } & Partial<import("@mapeo/core/dist/schema/client.js").DeviceInfoParam>>;
-    readonly invite: import("rpc-reflector/lib/types.js").ClientApi<import("@mapeo/core/dist/invite-api.js").InviteApi> & (() => Promise<import("@mapeo/core/dist/invite-api.js").InviteApi>);
+    } & Partial<import("@comapeo/core/dist/schema/client.js").DeviceInfoParam>>;
+    readonly invite: import("rpc-reflector/lib/types.js").ClientApi<import("@comapeo/core/dist/invite-api.js").InviteApi> & (() => Promise<import("@comapeo/core/dist/invite-api.js").InviteApi>);
     startLocalPeerDiscoveryServer: () => Promise<{
         name: string;
         port: number;
@@ -82,7 +82,7 @@ export type MapeoClientApi = {
         port: number;
         name: string;
     }) => Promise<void>;
-    listLocalPeers: () => Promise<import("@mapeo/core/dist/mapeo-manager.js").PublicPeerInfo[]>;
+    listLocalPeers: () => Promise<import("@comapeo/core/dist/mapeo-manager.js").PublicPeerInfo[]>;
     onBackgrounded: () => Promise<void>;
     onForegrounded: () => Promise<void>;
     leaveProject: (projectPublicId: string) => Promise<void>;

package/dist/client.js

@@ -2,12 +2,12 @@ import { createClient } from 'rpc-reflector';
 import pDefer from 'p-defer';
 import { MANAGER_CHANNEL_ID, MAPEO_RPC_ID, SubChannel, } from './lib/sub-channel.js';
 /**
- * @typedef {import('rpc-reflector/client.js').ClientApi<import('@mapeo/core/dist/mapeo-project.js').MapeoProject>} MapeoProjectApi
+ * @typedef {import('rpc-reflector/client.js').ClientApi<import('@comapeo/core/dist/mapeo-project.js').MapeoProject>} MapeoProjectApi
  */
 /**
  * @typedef {import('rpc-reflector/client.js').ClientApi<
  *   Omit<
- *     import('@mapeo/core').MapeoManager,
+ *     import('@comapeo/core').MapeoManager,
  *     'getProject'
  *   > & {
  *     getProject: (projectPublicId: string) => Promise<MapeoProjectApi>
@@ -22,11 +22,11 @@ const CLOSE = Symbol('close');
  * @returns {MapeoClientApi}
  */
 export function createMapeoClient(messagePort, opts = {}) {
-    /** @type {Map<string, Promise<import('rpc-reflector/client.js').ClientApi<import('@mapeo/core/dist/mapeo-project.js').MapeoProject>>>} */
+    /** @type {Map<string, Promise<import('rpc-reflector/client.js').ClientApi<import('@comapeo/core/dist/mapeo-project.js').MapeoProject>>>} */
     const projectClientPromises = new Map();
     const managerChannel = new SubChannel(messagePort, MANAGER_CHANNEL_ID);
     const mapeoRpcChannel = new SubChannel(messagePort, MAPEO_RPC_ID);
-    /** @type {import('rpc-reflector').ClientApi<import('@mapeo/core').MapeoManager>} */
+    /** @type {import('rpc-reflector').ClientApi<import('@comapeo/core').MapeoManager>} */
     const managerClient = createClient(managerChannel, opts);
     /** @type {import('rpc-reflector').ClientApi<import('./server.js').MapeoRpcApi>} */
     const mapeoRpcClient = createClient(mapeoRpcChannel, opts);
@@ -62,7 +62,7 @@ export function createMapeoClient(messagePort, opts = {}) {
         const existingClientPromise = projectClientPromises.get(projectPublicId);
         if (existingClientPromise)
             return existingClientPromise;
-        /** @type {import('p-defer').DeferredPromise<import('rpc-reflector/client.js').ClientApi<import('@mapeo/core/dist/mapeo-project.js').MapeoProject>>}*/
+        /** @type {import('p-defer').DeferredPromise<import('rpc-reflector/client.js').ClientApi<import('@comapeo/core/dist/mapeo-project.js').MapeoProject>>}*/
         const deferred = pDefer();
         projectClientPromises.set(projectPublicId, deferred.promise);
         try {
@@ -73,7 +73,7 @@ export function createMapeoClient(messagePort, opts = {}) {
             throw err;
         }
         const projectChannel = new SubChannel(messagePort, projectPublicId);
-        /** @type {import('rpc-reflector').ClientApi<import('@mapeo/core/dist/mapeo-project.js').MapeoProject>} */
+        /** @type {import('rpc-reflector').ClientApi<import('@comapeo/core/dist/mapeo-project.js').MapeoProject>} */
         const projectClient = createClient(projectChannel, opts);
         projectChannel.start();
         deferred.resolve(projectClient);

package/dist/server.d.ts

@@ -1,15 +1,15 @@
 /**
- * @param {import('@mapeo/core').MapeoManager} manager
+ * @param {import('@comapeo/core').MapeoManager} manager
  * @param {import('./lib/sub-channel.js').MessagePortLike} messagePort
  */
-export function createMapeoServer(manager: import('@mapeo/core').MapeoManager, messagePort: import('./lib/sub-channel.js').MessagePortLike): {
+export function createMapeoServer(manager: import('@comapeo/core').MapeoManager, messagePort: import('./lib/sub-channel.js').MessagePortLike): {
     close(): void;
 };
 export class MapeoRpcApi {
     /**
-     * @param {import('@mapeo/core').MapeoManager} manager
+     * @param {import('@comapeo/core').MapeoManager} manager
      */
-    constructor(manager: import('@mapeo/core').MapeoManager);
+    constructor(manager: import('@comapeo/core').MapeoManager);
     /**
      * @param {string} projectId
      * @returns {Promise<boolean>}

package/dist/server.js

@@ -2,7 +2,7 @@ import { createServer } from 'rpc-reflector';
 import { MANAGER_CHANNEL_ID, MAPEO_RPC_ID, SubChannel, } from './lib/sub-channel.js';
 import { extractMessageEventData } from './lib/utils.js';
 /**
- * @param {import('@mapeo/core').MapeoManager} manager
+ * @param {import('@comapeo/core').MapeoManager} manager
  * @param {import('./lib/sub-channel.js').MessagePortLike} messagePort
  */
 export function createMapeoServer(manager, messagePort) {
@@ -70,7 +70,7 @@ export function createMapeoServer(manager, messagePort) {
 export class MapeoRpcApi {
     #manager;
     /**
-     * @param {import('@mapeo/core').MapeoManager} manager
+     * @param {import('@comapeo/core').MapeoManager} manager
      */
     constructor(manager) {
         this.#manager = manager;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@comapeo/ipc",
-  "version": "0.16.0",
+  "version": "1.0.0",
   "description": "IPC wrappers for Mapeo Core",
   "type": "module",
   "main": "./dist/index.js",
@@ -45,7 +45,7 @@
     "rpc-reflector": "^1.3.11"
   },
   "peerDependencies": {
-    "@mapeo/core": "9.0.0-alpha.24"
+    "@comapeo/core": "1.0.0"
   },
   "devDependencies": {
     "@digidem/types": "^2.1.0",