npm - @comapeo/ipc - Versions diffs - 3.0.0 → 5.0.0-prerelease.0 - Mend

@comapeo/ipc 3.0.0 → 5.0.0-prerelease.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.

Files changed (6) hide show

package/dist/client.d.ts CHANGED Viewed

@@ -1,89 +1,17 @@
 /**
  * @param {import('./lib/sub-channel.js').MessagePortLike} messagePort
- * @param {object} [opts]
- * @param {number} [opts.timeout]
+ * @param {Parameters<typeof createClient>[1]} [opts]
  *
  * @returns {MapeoClientApi}
  */
-export function createMapeoClient(messagePort: import('./lib/sub-channel.js').MessagePortLike, opts?: {
-    timeout?: number | undefined;
-} | undefined): MapeoClientApi;
+export function createMapeoClient(messagePort: import("./lib/sub-channel.js").MessagePortLike, opts?: Parameters<typeof createClient>[1]): MapeoClientApi;
 /**
  * @param {MapeoClientApi} client client created with `createMapeoClient`
  * @returns {Promise<void>}
  */
 export function closeMapeoClient(client: MapeoClientApi): Promise<void>;
-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("@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>;
-    createProject: ({ name, configPath }?: {
-        name?: string | undefined;
-        configPath?: string | undefined;
-    } | undefined) => Promise<string>;
-    listProjects: () => Promise<(Pick<{
-        schemaName: "projectSettings";
-        name?: string | undefined;
-        defaultPresets?: {
-            point: string[];
-            area: string[];
-            vertex: string[];
-            line: string[];
-            relation: string[];
-        } | undefined;
-        configMetadata?: {
-            name: string;
-            buildDate: string;
-            importDate: string;
-            fileVersion: string;
-        } | undefined;
-    }, "name"> & {
-        projectId: string;
-        createdAt?: string | undefined;
-        updatedAt?: string | undefined;
-    })[]>;
-    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").Exact<import("@comapeo/core/dist/schema/client.js").DeviceInfoParam & {
-        deviceType?: "UNRECOGNIZED" | "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer" | undefined;
-    }, T>>(deviceInfo: T) => Promise<void>;
-    getDeviceInfo: () => Promise<{
-        deviceId: string;
-        deviceType: "UNRECOGNIZED" | "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer";
-    } & Partial<import("@comapeo/core/dist/schema/client.js").DeviceInfoParam>>;
-    setIsArchiveDevice: (isArchiveDevice: boolean) => Promise<void>;
-    getIsArchiveDevice: () => Promise<boolean>;
-    readonly invite: import("rpc-reflector/lib/types.js").ClientApi<import("@comapeo/core/dist/invite/invite-api.js").InviteApi> & (() => Promise<import("@comapeo/core/dist/invite/invite-api.js").InviteApi>);
-    startLocalPeerDiscoveryServer: () => Promise<{
-        name: string;
-        port: number;
-    }>;
-    stopLocalPeerDiscoveryServer: (opts?: {
-        force?: boolean | undefined;
-        timeout?: number | undefined;
-    } | undefined) => Promise<void>;
-    connectLocalPeer: (args_0: {
-        address: string;
-        port: number;
-        name: string;
-    }) => Promise<void>;
-    listLocalPeers: () => Promise<import("@comapeo/core/dist/mapeo-manager.js").PublicPeerInfo[]>;
-    onBackgrounded: () => Promise<void>;
-    onForegrounded: () => Promise<void>;
-    leaveProject: (projectPublicId: string) => Promise<void>;
-    getMapStyleJsonUrl: () => Promise<string>;
+export type MapeoProjectApi = import("rpc-reflector/client.js").ClientApi<import("@comapeo/core/dist/mapeo-project.js").MapeoProject>;
+export type MapeoClientApi = import("rpc-reflector/client.js").ClientApi<Omit<import("@comapeo/core").MapeoManager, "getProject"> & {
     getProject: (projectPublicId: string) => Promise<MapeoProjectApi>;
-};
+}>;
+import { createClient } from 'rpc-reflector/client.js';

package/dist/client.js CHANGED Viewed

@@ -1,4 +1,4 @@
-import { createClient } from 'rpc-reflector';
+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';
 /**
@@ -16,8 +16,7 @@ import { MANAGER_CHANNEL_ID, MAPEO_RPC_ID, SubChannel, } from './lib/sub-channel
 const CLOSE = Symbol('close');
 /**
  * @param {import('./lib/sub-channel.js').MessagePortLike} messagePort
- * @param {object} [opts]
- * @param {number} [opts.timeout]
+ * @param {Parameters<typeof createClient>[1]} [opts]
  *
  * @returns {MapeoClientApi}
  */
@@ -62,7 +61,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('@comapeo/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 {

package/dist/index.d.ts CHANGED Viewed

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

package/dist/server.d.ts CHANGED Viewed

@@ -1,15 +1,16 @@
 /**
  * @param {import('@comapeo/core').MapeoManager} manager
  * @param {import('./lib/sub-channel.js').MessagePortLike} messagePort
+ * @param {Parameters<typeof createServer>[2]} [opts]
  */
-export function createMapeoServer(manager: import('@comapeo/core').MapeoManager, messagePort: import('./lib/sub-channel.js').MessagePortLike): {
+export function createMapeoServer(manager: import("@comapeo/core").MapeoManager, messagePort: import("./lib/sub-channel.js").MessagePortLike, opts?: Parameters<typeof createServer>[2]): {
     close(): void;
 };
 export class MapeoRpcApi {
     /**
      * @param {import('@comapeo/core').MapeoManager} manager
      */
-    constructor(manager: import('@comapeo/core').MapeoManager);
+    constructor(manager: import("@comapeo/core").MapeoManager);
     /**
      * @param {string} projectId
      * @returns {Promise<boolean>}
@@ -17,3 +18,4 @@ export class MapeoRpcApi {
     assertProjectExists(projectId: string): Promise<boolean>;
     #private;
 }
+import { createServer } from 'rpc-reflector/server.js';

package/dist/server.js CHANGED Viewed

@@ -1,11 +1,12 @@
-import { createServer } from 'rpc-reflector';
+import { createServer } from 'rpc-reflector/server.js';
 import { MANAGER_CHANNEL_ID, MAPEO_RPC_ID, SubChannel, } from './lib/sub-channel.js';
 import { extractMessageEventData } from './lib/utils.js';
 /**
  * @param {import('@comapeo/core').MapeoManager} manager
  * @param {import('./lib/sub-channel.js').MessagePortLike} messagePort
+ * @param {Parameters<typeof createServer>[2]} [opts]
  */
-export function createMapeoServer(manager, messagePort) {
+export function createMapeoServer(manager, messagePort, opts) {
     /** @type {Map<string, { close: () => void }>} */
     const existingProjectServers = new Map();
     /** @type {Map<string, SubChannel>} */
@@ -13,8 +14,8 @@ export function createMapeoServer(manager, messagePort) {
     const mapeoRpcApi = new MapeoRpcApi(manager);
     const managerChannel = new SubChannel(messagePort, MANAGER_CHANNEL_ID);
     const mapeoRpcChannel = new SubChannel(messagePort, MAPEO_RPC_ID);
-    const managerServer = createServer(manager, managerChannel);
-    const mapeoRpcServer = createServer(mapeoRpcApi, mapeoRpcChannel);
+    const managerServer = createServer(manager, managerChannel, opts);
+    const mapeoRpcServer = createServer(mapeoRpcApi, mapeoRpcChannel, opts);
     managerChannel.start();
     mapeoRpcChannel.start();
     messagePort.addEventListener('message', handleMessage);
@@ -54,14 +55,14 @@ export function createMapeoServer(manager, messagePort) {
         try {
             project = await manager.getProject(id);
         }
-        catch (err) {
+        catch (_err) {
             // TODO: how to respond to client so that method errors?
             projectChannel.close();
             existingProjectChannels.delete(id);
             existingProjectServers.delete(id);
             return;
         }
-        const { close } = createServer(project, projectChannel);
+        const { close } = createServer(project, projectChannel, opts);
         existingProjectServers.set(id, { close });
         projectChannel.emit('message', data.message);
         projectChannel.start();

package/package.json CHANGED Viewed

@@ -1,24 +1,37 @@
 {
   "name": "@comapeo/ipc",
-  "version": "3.0.0",
+  "version": "5.0.0-prerelease.0",
   "description": "IPC wrappers for CoMapeo Core",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./client": {
+      "import": "./dist/client.js",
+      "types": "./dist/client.d.ts"
+    },
+    "./server": {
+      "import": "./dist/server.js",
+      "types": "./dist/server.d.ts"
+    }
+  },
   "engines": {
     "node": ">=18.17.1"
   },
   "scripts": {
-    "format": "prettier **/*.{js,md} --write",
-    "lint": "eslint . --cache",
-    "types": "tsc -p tsconfig.json",
-    "test:unit": "node --test tests/*.js",
-    "test": "npm-run-all lint types test:unit",
     "bench": "node bench/bench.js",
     "build": "tsc -p tsconfig.npm.json",
+    "check:eslint": "eslint . --cache",
+    "check:format": "prettier --check --cache .",
+    "check:types": "tsc",
+    "check": "npm-run-all --parallel --continue-on-error --print-label --aggregate-output check:*",
     "prepack": "npm run build",
-    "prepare": "husky install",
-    "release": "standard-version"
+    "prepare": "husky",
+    "test": "node --test tests/*.js"
   },
   "files": [
     "dist"
@@ -41,46 +54,28 @@
   "homepage": "https://github.com/digidem/comapeo-ipc#readme",
   "dependencies": {
     "eventemitter3": "^5.0.1",
-    "p-defer": "^4.0.0",
-    "rpc-reflector": "^1.3.11"
+    "p-defer": "^4.0.1",
+    "rpc-reflector": "^3.0.0-prerelease.0"
   },
   "peerDependencies": {
-    "@comapeo/core": "^3.0.0"
+    "@comapeo/core": "^4.0.0"
   },
   "devDependencies": {
-    "@comapeo/core": "3.0.0",
+    "@comapeo/core": "4.0.0",
     "@digidem/types": "^2.1.0",
+    "@eslint/js": "^9.29.0",
     "@mapeo/crypto": "^1.0.0-alpha.8",
     "@types/nanobench": "^3.0.0",
-    "@types/node": "^20.7.1",
-    "eslint": "^8.50.0",
-    "fastify": "^4.26.2",
-    "husky": "^8.0.0",
-    "lint-staged": "^14.0.1",
+    "@types/node": "^20.19.1",
+    "eslint": "^9.29.0",
+    "fastify": "^4.29.1",
+    "globals": "^16.2.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^15.5.2",
     "nanobench": "^3.0.0",
-    "npm-run-all": "^4.1.5",
-    "prettier": "^3.0.3",
-    "random-access-memory": "^6.2.0",
-    "standard-version": "^9.5.0",
-    "typescript": "^5.2.2"
-  },
-  "prettier": {
-    "semi": false,
-    "singleQuote": true
-  },
-  "eslintConfig": {
-    "env": {
-      "commonjs": true,
-      "es2021": true,
-      "node": true
-    },
-    "extends": "eslint:recommended",
-    "parserOptions": {
-      "ecmaVersion": "latest",
-      "sourceType": "module"
-    }
-  },
-  "lint-staged": {
-    "*.{js,md}": "prettier . --write"
+    "npm-run-all2": "^7.0.2",
+    "prettier": "^3.5.3",
+    "random-access-memory": "^6.2.1",
+    "typescript": "5.8.3"
   }
 }