@comapeo/ipc 3.0.0 → 4.0.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.
- package/dist/client.d.ts +5 -75
- package/dist/index.d.ts +2 -2
- package/dist/server.d.ts +2 -2
- package/dist/server.js +1 -1
- package/package.json +21 -40
package/dist/client.d.ts
CHANGED
|
@@ -5,85 +5,15 @@
|
|
|
5
5
|
*
|
|
6
6
|
* @returns {MapeoClientApi}
|
|
7
7
|
*/
|
|
8
|
-
export function createMapeoClient(messagePort: import(
|
|
8
|
+
export function createMapeoClient(messagePort: import("./lib/sub-channel.js").MessagePortLike, opts?: {
|
|
9
9
|
timeout?: number | undefined;
|
|
10
|
-
}
|
|
10
|
+
}): MapeoClientApi;
|
|
11
11
|
/**
|
|
12
12
|
* @param {MapeoClientApi} client client created with `createMapeoClient`
|
|
13
13
|
* @returns {Promise<void>}
|
|
14
14
|
*/
|
|
15
15
|
export function closeMapeoClient(client: MapeoClientApi): Promise<void>;
|
|
16
|
-
export type MapeoProjectApi = import(
|
|
17
|
-
export type MapeoClientApi = {
|
|
18
|
-
addListener: <U extends "local-peers">(event: U, listener: import("@comapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U]) => import("@comapeo/core").MapeoManager;
|
|
19
|
-
on: <U_1 extends "local-peers">(event: U_1, listener: import("@comapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_1]) => import("@comapeo/core").MapeoManager;
|
|
20
|
-
once: <U_2 extends "local-peers">(event: U_2, listener: import("@comapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_2]) => import("@comapeo/core").MapeoManager;
|
|
21
|
-
removeListener: <U_3 extends "local-peers">(event: U_3, listener: import("@comapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_3]) => import("@comapeo/core").MapeoManager;
|
|
22
|
-
off: <U_4 extends "local-peers">(event: U_4, listener: import("@comapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_4]) => import("@comapeo/core").MapeoManager;
|
|
23
|
-
removeAllListeners: (event?: "local-peers" | undefined) => import("@comapeo/core").MapeoManager;
|
|
24
|
-
listeners: <U_5 extends "local-peers">(type: U_5) => import("@comapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_5][];
|
|
25
|
-
rawListeners: <U_6 extends "local-peers">(type: U_6) => import("@comapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_6][];
|
|
26
|
-
emit: <U_7 extends "local-peers">(event: U_7, ...args: Parameters<import("@comapeo/core/dist/mapeo-manager.js").MapeoManagerEvents[U_7]>) => boolean;
|
|
27
|
-
listenerCount: (type: "local-peers") => number;
|
|
28
|
-
eventNames: <U_8 extends "local-peers">() => U_8[];
|
|
29
|
-
readonly deviceId: () => Promise<string>;
|
|
30
|
-
createProject: ({ name, configPath }?: {
|
|
31
|
-
name?: string | undefined;
|
|
32
|
-
configPath?: string | undefined;
|
|
33
|
-
} | undefined) => Promise<string>;
|
|
34
|
-
listProjects: () => Promise<(Pick<{
|
|
35
|
-
schemaName: "projectSettings";
|
|
36
|
-
name?: string | undefined;
|
|
37
|
-
defaultPresets?: {
|
|
38
|
-
point: string[];
|
|
39
|
-
area: string[];
|
|
40
|
-
vertex: string[];
|
|
41
|
-
line: string[];
|
|
42
|
-
relation: string[];
|
|
43
|
-
} | undefined;
|
|
44
|
-
configMetadata?: {
|
|
45
|
-
name: string;
|
|
46
|
-
buildDate: string;
|
|
47
|
-
importDate: string;
|
|
48
|
-
fileVersion: string;
|
|
49
|
-
} | undefined;
|
|
50
|
-
}, "name"> & {
|
|
51
|
-
projectId: string;
|
|
52
|
-
createdAt?: string | undefined;
|
|
53
|
-
updatedAt?: string | undefined;
|
|
54
|
-
})[]>;
|
|
55
|
-
addProject: ({ projectKey, encryptionKeys, projectName }: Pick<import("@comapeo/core/dist/generated/rpc.js").ProjectJoinDetails, "projectKey" | "encryptionKeys"> & {
|
|
56
|
-
projectName: string;
|
|
57
|
-
}, { waitForSync }?: {
|
|
58
|
-
waitForSync?: boolean | undefined;
|
|
59
|
-
} | undefined) => Promise<string>;
|
|
60
|
-
setDeviceInfo: <T extends import("type-fest").Exact<import("@comapeo/core/dist/schema/client.js").DeviceInfoParam & {
|
|
61
|
-
deviceType?: "UNRECOGNIZED" | "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer" | undefined;
|
|
62
|
-
}, T>>(deviceInfo: T) => Promise<void>;
|
|
63
|
-
getDeviceInfo: () => Promise<{
|
|
64
|
-
deviceId: string;
|
|
65
|
-
deviceType: "UNRECOGNIZED" | "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer";
|
|
66
|
-
} & Partial<import("@comapeo/core/dist/schema/client.js").DeviceInfoParam>>;
|
|
67
|
-
setIsArchiveDevice: (isArchiveDevice: boolean) => Promise<void>;
|
|
68
|
-
getIsArchiveDevice: () => Promise<boolean>;
|
|
69
|
-
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>);
|
|
70
|
-
startLocalPeerDiscoveryServer: () => Promise<{
|
|
71
|
-
name: string;
|
|
72
|
-
port: number;
|
|
73
|
-
}>;
|
|
74
|
-
stopLocalPeerDiscoveryServer: (opts?: {
|
|
75
|
-
force?: boolean | undefined;
|
|
76
|
-
timeout?: number | undefined;
|
|
77
|
-
} | undefined) => Promise<void>;
|
|
78
|
-
connectLocalPeer: (args_0: {
|
|
79
|
-
address: string;
|
|
80
|
-
port: number;
|
|
81
|
-
name: string;
|
|
82
|
-
}) => Promise<void>;
|
|
83
|
-
listLocalPeers: () => Promise<import("@comapeo/core/dist/mapeo-manager.js").PublicPeerInfo[]>;
|
|
84
|
-
onBackgrounded: () => Promise<void>;
|
|
85
|
-
onForegrounded: () => Promise<void>;
|
|
86
|
-
leaveProject: (projectPublicId: string) => Promise<void>;
|
|
87
|
-
getMapStyleJsonUrl: () => Promise<string>;
|
|
16
|
+
export type MapeoProjectApi = import("rpc-reflector/client.js").ClientApi<import("@comapeo/core/dist/mapeo-project.js").MapeoProject>;
|
|
17
|
+
export type MapeoClientApi = import("rpc-reflector/client.js").ClientApi<Omit<import("@comapeo/core").MapeoManager, "getProject"> & {
|
|
88
18
|
getProject: (projectPublicId: string) => Promise<MapeoProjectApi>;
|
|
89
|
-
}
|
|
19
|
+
}>;
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
export { createMapeoServer } from "./server.js";
|
|
2
|
-
export type MapeoClientApi = import(
|
|
3
|
-
export type MapeoProjectApi = import(
|
|
2
|
+
export type MapeoClientApi = import("./client.js").MapeoClientApi;
|
|
3
|
+
export type MapeoProjectApi = import("./client.js").MapeoProjectApi;
|
|
4
4
|
export { createMapeoClient, closeMapeoClient } from "./client.js";
|
package/dist/server.d.ts
CHANGED
|
@@ -2,14 +2,14 @@
|
|
|
2
2
|
* @param {import('@comapeo/core').MapeoManager} manager
|
|
3
3
|
* @param {import('./lib/sub-channel.js').MessagePortLike} messagePort
|
|
4
4
|
*/
|
|
5
|
-
export function createMapeoServer(manager: import(
|
|
5
|
+
export function createMapeoServer(manager: import("@comapeo/core").MapeoManager, messagePort: import("./lib/sub-channel.js").MessagePortLike): {
|
|
6
6
|
close(): void;
|
|
7
7
|
};
|
|
8
8
|
export class MapeoRpcApi {
|
|
9
9
|
/**
|
|
10
10
|
* @param {import('@comapeo/core').MapeoManager} manager
|
|
11
11
|
*/
|
|
12
|
-
constructor(manager: import(
|
|
12
|
+
constructor(manager: import("@comapeo/core").MapeoManager);
|
|
13
13
|
/**
|
|
14
14
|
* @param {string} projectId
|
|
15
15
|
* @returns {Promise<boolean>}
|
package/dist/server.js
CHANGED
|
@@ -54,7 +54,7 @@ export function createMapeoServer(manager, messagePort) {
|
|
|
54
54
|
try {
|
|
55
55
|
project = await manager.getProject(id);
|
|
56
56
|
}
|
|
57
|
-
catch (
|
|
57
|
+
catch (_err) {
|
|
58
58
|
// TODO: how to respond to client so that method errors?
|
|
59
59
|
projectChannel.close();
|
|
60
60
|
existingProjectChannels.delete(id);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@comapeo/ipc",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "4.0.0",
|
|
4
4
|
"description": "IPC wrappers for CoMapeo Core",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -9,16 +9,15 @@
|
|
|
9
9
|
"node": ">=18.17.1"
|
|
10
10
|
},
|
|
11
11
|
"scripts": {
|
|
12
|
-
"format": "prettier **/*.{js,md} --write",
|
|
13
|
-
"lint": "eslint . --cache",
|
|
14
|
-
"types": "tsc -p tsconfig.json",
|
|
15
|
-
"test:unit": "node --test tests/*.js",
|
|
16
|
-
"test": "npm-run-all lint types test:unit",
|
|
17
12
|
"bench": "node bench/bench.js",
|
|
18
13
|
"build": "tsc -p tsconfig.npm.json",
|
|
14
|
+
"check:eslint": "eslint . --cache",
|
|
15
|
+
"check:format": "prettier --check --cache .",
|
|
16
|
+
"check:types": "tsc",
|
|
17
|
+
"check": "npm-run-all --parallel --continue-on-error --print-label --aggregate-output check:*",
|
|
19
18
|
"prepack": "npm run build",
|
|
20
|
-
"prepare": "husky
|
|
21
|
-
"
|
|
19
|
+
"prepare": "husky",
|
|
20
|
+
"test": "node --test tests/*.js"
|
|
22
21
|
},
|
|
23
22
|
"files": [
|
|
24
23
|
"dist"
|
|
@@ -41,46 +40,28 @@
|
|
|
41
40
|
"homepage": "https://github.com/digidem/comapeo-ipc#readme",
|
|
42
41
|
"dependencies": {
|
|
43
42
|
"eventemitter3": "^5.0.1",
|
|
44
|
-
"p-defer": "^4.0.
|
|
43
|
+
"p-defer": "^4.0.1",
|
|
45
44
|
"rpc-reflector": "^1.3.11"
|
|
46
45
|
},
|
|
47
46
|
"peerDependencies": {
|
|
48
|
-
"@comapeo/core": "^
|
|
47
|
+
"@comapeo/core": "^4.0.0"
|
|
49
48
|
},
|
|
50
49
|
"devDependencies": {
|
|
51
|
-
"@comapeo/core": "
|
|
50
|
+
"@comapeo/core": "4.0.0",
|
|
52
51
|
"@digidem/types": "^2.1.0",
|
|
52
|
+
"@eslint/js": "^9.29.0",
|
|
53
53
|
"@mapeo/crypto": "^1.0.0-alpha.8",
|
|
54
54
|
"@types/nanobench": "^3.0.0",
|
|
55
|
-
"@types/node": "^20.
|
|
56
|
-
"eslint": "^
|
|
57
|
-
"fastify": "^4.
|
|
58
|
-
"
|
|
59
|
-
"
|
|
55
|
+
"@types/node": "^20.19.1",
|
|
56
|
+
"eslint": "^9.29.0",
|
|
57
|
+
"fastify": "^4.29.1",
|
|
58
|
+
"globals": "^16.2.0",
|
|
59
|
+
"husky": "^9.1.7",
|
|
60
|
+
"lint-staged": "^15.5.2",
|
|
60
61
|
"nanobench": "^3.0.0",
|
|
61
|
-
"npm-run-
|
|
62
|
-
"prettier": "^3.
|
|
63
|
-
"random-access-memory": "^6.2.
|
|
64
|
-
"
|
|
65
|
-
"typescript": "^5.2.2"
|
|
66
|
-
},
|
|
67
|
-
"prettier": {
|
|
68
|
-
"semi": false,
|
|
69
|
-
"singleQuote": true
|
|
70
|
-
},
|
|
71
|
-
"eslintConfig": {
|
|
72
|
-
"env": {
|
|
73
|
-
"commonjs": true,
|
|
74
|
-
"es2021": true,
|
|
75
|
-
"node": true
|
|
76
|
-
},
|
|
77
|
-
"extends": "eslint:recommended",
|
|
78
|
-
"parserOptions": {
|
|
79
|
-
"ecmaVersion": "latest",
|
|
80
|
-
"sourceType": "module"
|
|
81
|
-
}
|
|
82
|
-
},
|
|
83
|
-
"lint-staged": {
|
|
84
|
-
"*.{js,md}": "prettier . --write"
|
|
62
|
+
"npm-run-all2": "^7.0.2",
|
|
63
|
+
"prettier": "^3.5.3",
|
|
64
|
+
"random-access-memory": "^6.2.1",
|
|
65
|
+
"typescript": "5.8.3"
|
|
85
66
|
}
|
|
86
67
|
}
|