@comapeo/ipc 6.1.0 → 6.2.0

package/dist/client.d.ts

@@ -10,6 +10,26 @@ export function createMapeoClient(messagePort: import("./lib/sub-channel.js").Me
  * @returns {Promise<void>}
  */
 export function closeMapeoClient(client: MapeoClientApi): Promise<void>;
+/**
+ * @typedef {import('rpc-reflector/client.js').ClientApi<import('./server.js').RpcApi>} AppRpcApi
+ */
+/**
+ * Create an rpc client for application RPC messages that are not part of core,
+ * e.g. the different servers for maps, and in the future for serving blobs and
+ * icons (once extracted from core)
+ *
+ * @param {import('./lib/sub-channel.js').MessagePortLike} messagePort
+ * @param {Parameters<typeof createClient>[1]} [opts]
+ * @return {AppRpcApi}
+ */
+export function createAppRpcClient(messagePort: import("./lib/sub-channel.js").MessagePortLike, opts?: Parameters<typeof createClient>[1]): AppRpcApi;
+/**
+ * Close the app RPC client (removes listeners but does not close the message port)
+ *
+ * @param {AppRpcApi} appRpcClient client created with `createAppRpcClient`
+ */
+export function closeAppRpcClient(appRpcClient: AppRpcApi): void;
+export type AppRpcApi = import("rpc-reflector/client.js").ClientApi<import("./server.js").RpcApi>;
 export type MapeoProjectApi = import("rpc-reflector/client.js").ClientApi<import("@comapeo/core").MapeoProject>;
 export type MapeoClientApi = import("rpc-reflector/client.js").ClientApi<Omit<import("@comapeo/core").MapeoManager, "getProject"> & {
     getProject: (projectPublicId: string) => Promise<MapeoProjectApi>;

package/dist/client.js

@@ -1,6 +1,6 @@
 import { createClient } from 'rpc-reflector/client.js';
 import pDefer from 'p-defer';
-import { MANAGER_CHANNEL_ID, MAPEO_RPC_ID, SubChannel, } from './lib/sub-channel.js';
+import { APP_RPC_ID, MANAGER_CHANNEL_ID, MAPEO_RPC_ID, SubChannel, } from './lib/sub-channel.js';
 /**
  * @typedef {import('rpc-reflector/client.js').ClientApi<import('@comapeo/core').MapeoProject>} MapeoProjectApi
  */
@@ -87,3 +87,29 @@ export async function closeMapeoClient(client) {
     // @ts-expect-error
     return client[CLOSE]();
 }
+/**
+ * @typedef {import('rpc-reflector/client.js').ClientApi<import('./server.js').RpcApi>} AppRpcApi
+ */
+/**
+ * Create an rpc client for application RPC messages that are not part of core,
+ * e.g. the different servers for maps, and in the future for serving blobs and
+ * icons (once extracted from core)
+ *
+ * @param {import('./lib/sub-channel.js').MessagePortLike} messagePort
+ * @param {Parameters<typeof createClient>[1]} [opts]
+ * @return {AppRpcApi}
+ */
+export function createAppRpcClient(messagePort, opts = {}) {
+    const appRpcChannel = new SubChannel(messagePort, APP_RPC_ID);
+    const appRpcClient = /** @type {AppRpcApi} */ (createClient(appRpcChannel, opts));
+    appRpcChannel.start();
+    return appRpcClient;
+}
+/**
+ * Close the app RPC client (removes listeners but does not close the message port)
+ *
+ * @param {AppRpcApi} appRpcClient client created with `createAppRpcClient`
+ */
+export function closeAppRpcClient(appRpcClient) {
+    createClient.close(appRpcClient);
+}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-export { createMapeoServer } from "./server.js";
 export type MapeoClientApi = import("./client.js").MapeoClientApi;
 export type MapeoProjectApi = import("./client.js").MapeoProjectApi;
-export { createMapeoClient, closeMapeoClient } from "./client.js";
+export type AppRpcApi = import("./client.js").AppRpcApi;
+export { createMapeoClient, closeMapeoClient, createAppRpcClient, closeAppRpcClient } from "./client.js";
+export { createMapeoServer, createAppRpcServer } from "./server.js";

package/dist/index.js

@@ -1,4 +1,5 @@
-export { createMapeoClient, closeMapeoClient } from './client.js';
-export { createMapeoServer } from './server.js';
+export { createMapeoClient, closeMapeoClient, createAppRpcClient, closeAppRpcClient, } from './client.js';
+export { createMapeoServer, createAppRpcServer } from './server.js';
 /** @typedef {import('./client.js').MapeoClientApi} MapeoClientApi */
 /** @typedef {import('./client.js').MapeoProjectApi} MapeoProjectApi */
+/** @typedef {import('./client.js').AppRpcApi} AppRpcApi */

package/dist/lib/sub-channel.d.ts

@@ -1,4 +1,5 @@
 export const MAPEO_RPC_ID: "@@mapeo-rpc";
+export const APP_RPC_ID: "@@app-rpc";
 export const MANAGER_CHANNEL_ID: "@@manager";
 /**
  * @typedef {Object} Events

package/dist/lib/sub-channel.js

@@ -2,6 +2,7 @@ import { EventEmitter } from 'eventemitter3';
 import { extractMessageEventData } from './utils.js';
 // Ideally unique ID used for identifying "global" Mapeo IPC messages
 export const MAPEO_RPC_ID = '@@mapeo-rpc';
+export const APP_RPC_ID = '@@app-rpc';
 export const MANAGER_CHANNEL_ID = '@@manager';
 /**
  * @typedef {Object} Events

package/dist/server.d.ts

@@ -6,6 +6,22 @@
 export function createMapeoServer(manager: import("@comapeo/core").MapeoManager, messagePort: import("./lib/sub-channel.js").MessagePortLike, opts?: Parameters<typeof createServer>[2]): {
     close(): void;
 };
+/**
+ * @typedef {object} RpcApi
+ * @property {object} mapServer
+ * @property {(options?: { localPort?: number, remotePort?: number }) => Promise<{ localPort: number, remotePort: number }>} mapServer.listen
+ * @property {() => Promise<void>} mapServer.close
+ */
+/**
+ * RPC messages that are not part of core, e.g. the different servers for maps,
+ * and in the future for serving blobs and icons (once extracted from core)
+ * @param {RpcApi} rpc
+ * @param {import('./lib/sub-channel.js').MessagePortLike} messagePort
+ * @param {Parameters<typeof createServer>[2]} [opts]
+ */
+export function createAppRpcServer(rpc: RpcApi, messagePort: import("./lib/sub-channel.js").MessagePortLike, opts?: Parameters<typeof createServer>[2]): {
+    close(): void;
+};
 export class MapeoRpcApi {
     /**
      * @param {import('@comapeo/core').MapeoManager} manager
@@ -18,4 +34,16 @@ export class MapeoRpcApi {
     assertProjectExists(projectId: string): Promise<boolean>;
     #private;
 }
+export type RpcApi = {
+    mapServer: {
+        listen: (options?: {
+            localPort?: number;
+            remotePort?: number;
+        }) => Promise<{
+            localPort: number;
+            remotePort: number;
+        }>;
+        close: () => Promise<void>;
+    };
+};
 import { createServer } from 'rpc-reflector/server.js';

package/dist/server.js

@@ -1,5 +1,5 @@
 import { createServer } from 'rpc-reflector/server.js';
-import { MANAGER_CHANNEL_ID, MAPEO_RPC_ID, SubChannel, } from './lib/sub-channel.js';
+import { APP_RPC_ID, MANAGER_CHANNEL_ID, MAPEO_RPC_ID, SubChannel, } from './lib/sub-channel.js';
 import { extractMessageEventData } from './lib/utils.js';
 /**
  * @param {import('@comapeo/core').MapeoManager} manager
@@ -92,3 +92,27 @@ export class MapeoRpcApi {
         return !!project;
     }
 }
+/**
+ * @typedef {object} RpcApi
+ * @property {object} mapServer
+ * @property {(options?: { localPort?: number, remotePort?: number }) => Promise<{ localPort: number, remotePort: number }>} mapServer.listen
+ * @property {() => Promise<void>} mapServer.close
+ */
+/**
+ * RPC messages that are not part of core, e.g. the different servers for maps,
+ * and in the future for serving blobs and icons (once extracted from core)
+ * @param {RpcApi} rpc
+ * @param {import('./lib/sub-channel.js').MessagePortLike} messagePort
+ * @param {Parameters<typeof createServer>[2]} [opts]
+ */
+export function createAppRpcServer(rpc, messagePort, opts) {
+    const appRpcChannel = new SubChannel(messagePort, APP_RPC_ID);
+    const appRpcServer = createServer(rpc, appRpcChannel, opts);
+    appRpcChannel.start();
+    return {
+        close() {
+            appRpcServer.close();
+            appRpcChannel.close();
+        },
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@comapeo/ipc",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "description": "IPC wrappers for CoMapeo Core",
   "type": "module",
   "main": "./dist/index.js",
@@ -62,6 +62,7 @@
   },
   "devDependencies": {
     "@comapeo/core": "5.2.1",
+    "@comapeo/map-server": "1.0.0",
     "@digidem/types": "2.3.0",
     "@eslint/js": "9.39.2",
     "@mapeo/crypto": "1.0.0-alpha.10",