emr-bridge 2.0.1 → 2.1.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 (75) hide show
  1. package/README.md +8 -0
  2. package/cjs/entries/index.d.ts +1 -0
  3. package/cjs/entries/index.js +19 -0
  4. package/cjs/errors.d.ts +18 -0
  5. package/cjs/errors.js +34 -1
  6. package/cjs/package.json +3 -0
  7. package/cjs/scripts/base-bridge.d.ts +15 -8
  8. package/cjs/scripts/base-bridge.js +88 -42
  9. package/cjs/scripts/helpers/entities-info.d.ts +20 -0
  10. package/cjs/scripts/helpers/entities-info.js +38 -0
  11. package/cjs/scripts/helpers/env.js +1 -1
  12. package/cjs/scripts/helpers/id.d.ts +9 -0
  13. package/cjs/scripts/helpers/id.js +15 -1
  14. package/cjs/scripts/helpers/index.d.ts +3 -0
  15. package/cjs/scripts/helpers/index.js +7 -1
  16. package/cjs/scripts/helpers/ipc-channel.d.ts +10 -0
  17. package/cjs/scripts/helpers/ipc-channel.js +73 -61
  18. package/cjs/scripts/helpers/ipc-event-in-main.d.ts +7 -1
  19. package/cjs/scripts/helpers/ipc-event-in-main.js +27 -2
  20. package/cjs/scripts/helpers/ipc-payload.d.ts +38 -0
  21. package/cjs/scripts/helpers/ipc-payload.js +82 -0
  22. package/cjs/scripts/helpers/ipc-result.d.ts +9 -1
  23. package/cjs/scripts/helpers/ipc-result.js +32 -9
  24. package/cjs/scripts/helpers/names.d.ts +20 -0
  25. package/cjs/scripts/helpers/names.js +77 -0
  26. package/cjs/scripts/helpers/transfer.d.ts +8 -0
  27. package/cjs/scripts/helpers/transfer.js +24 -10
  28. package/cjs/scripts/helpers/web-contents-events-container.d.ts +57 -8
  29. package/cjs/scripts/helpers/web-contents-events-container.js +150 -25
  30. package/cjs/scripts/main/publish.d.ts +2 -2
  31. package/cjs/scripts/main/publish.js +177 -78
  32. package/cjs/scripts/preload/bridge.d.ts +2 -2
  33. package/cjs/scripts/preload/bridge.js +7 -6
  34. package/cjs/scripts/preload/provider.js +113 -18
  35. package/cjs/scripts/renderer/bridge.js +5 -0
  36. package/cjs/scripts/renderer/tunnels.d.ts +19 -2
  37. package/cjs/scripts/renderer/tunnels.js +133 -32
  38. package/cjs/types.d.ts +4 -0
  39. package/esm/entries/index.d.ts +1 -0
  40. package/esm/entries/index.js +5 -1
  41. package/esm/errors.d.ts +18 -0
  42. package/esm/errors.js +30 -0
  43. package/esm/scripts/base-bridge.d.ts +15 -8
  44. package/esm/scripts/base-bridge.js +90 -44
  45. package/esm/scripts/helpers/entities-info.d.ts +20 -0
  46. package/esm/scripts/helpers/entities-info.js +35 -0
  47. package/esm/scripts/helpers/env.js +1 -1
  48. package/esm/scripts/helpers/id.d.ts +9 -0
  49. package/esm/scripts/helpers/id.js +15 -1
  50. package/esm/scripts/helpers/index.d.ts +3 -0
  51. package/esm/scripts/helpers/index.js +3 -0
  52. package/esm/scripts/helpers/ipc-channel.d.ts +10 -0
  53. package/esm/scripts/helpers/ipc-channel.js +74 -63
  54. package/esm/scripts/helpers/ipc-event-in-main.d.ts +7 -1
  55. package/esm/scripts/helpers/ipc-event-in-main.js +24 -2
  56. package/esm/scripts/helpers/ipc-payload.d.ts +38 -0
  57. package/esm/scripts/helpers/ipc-payload.js +79 -0
  58. package/esm/scripts/helpers/ipc-result.d.ts +9 -1
  59. package/esm/scripts/helpers/ipc-result.js +32 -9
  60. package/esm/scripts/helpers/names.d.ts +20 -0
  61. package/esm/scripts/helpers/names.js +74 -0
  62. package/esm/scripts/helpers/transfer.d.ts +8 -0
  63. package/esm/scripts/helpers/transfer.js +24 -10
  64. package/esm/scripts/helpers/web-contents-events-container.d.ts +57 -8
  65. package/esm/scripts/helpers/web-contents-events-container.js +150 -25
  66. package/esm/scripts/main/publish.d.ts +2 -2
  67. package/esm/scripts/main/publish.js +179 -80
  68. package/esm/scripts/preload/bridge.d.ts +2 -2
  69. package/esm/scripts/preload/bridge.js +8 -7
  70. package/esm/scripts/preload/provider.js +114 -19
  71. package/esm/scripts/renderer/bridge.js +5 -0
  72. package/esm/scripts/renderer/tunnels.d.ts +19 -2
  73. package/esm/scripts/renderer/tunnels.js +135 -35
  74. package/esm/types.d.ts +4 -0
  75. package/package.json +35 -13
@@ -1,14 +1,19 @@
1
1
  import { ipcRenderer } from 'electron';
2
- import { IpcChannel, IpcResult } from '../helpers/index.js';
2
+ import { IpcChannel, IpcPayload, IpcResult, Names } from '../helpers/index.js';
3
3
  /**
4
4
  * IPC туннель для функции.
5
5
  */
6
6
  class FunctionTunnel {
7
+ /**
8
+ * Туннель.
9
+ */
10
+ tunnel;
7
11
  /**
8
12
  * Создать IPC туннель для функции.
9
13
  * @param name - Имя функции.
10
14
  */
11
15
  constructor(name) {
16
+ Names.validateEntity(name);
12
17
  this.tunnel = new IPCTunnel(IpcChannel.func.call(name));
13
18
  }
14
19
  /**
@@ -24,11 +29,20 @@ class FunctionTunnel {
24
29
  * Туннель для переменной.
25
30
  */
26
31
  class VariableTunnel {
32
+ /**
33
+ * Туннель для получения значения.
34
+ */
35
+ getTunnel;
36
+ /**
37
+ * Туннель для установки значения.
38
+ */
39
+ setTunnel;
27
40
  /**
28
41
  * Создать туннель для переменной.
29
42
  * @param name - Имя переменной.
30
43
  */
31
44
  constructor(name) {
45
+ Names.validateEntity(name);
32
46
  this.getTunnel = new IPCTunnel(IpcChannel.prop.get(name));
33
47
  this.setTunnel = new IPCTunnel(IpcChannel.prop.set(name));
34
48
  }
@@ -50,6 +64,10 @@ class VariableTunnel {
50
64
  * Туннель для обработки обещания.
51
65
  */
52
66
  class PromiseTunnel {
67
+ /**
68
+ * Туннель.
69
+ */
70
+ tunnel;
53
71
  /**
54
72
  * Создать туннель для обработки обещания.
55
73
  * @param channel - Канал возвращающий обещание.
@@ -63,17 +81,21 @@ class PromiseTunnel {
63
81
  */
64
82
  wait(id) {
65
83
  return new Promise((resolve, reject) => {
66
- const handler = (_, { error, value, id: resultId }) => {
67
- if (id !== undefined && resultId !== id) {
84
+ const handler = (_, payload) => {
85
+ const result = IpcPayload.result(payload);
86
+ if (!result) {
87
+ return;
88
+ }
89
+ if (id !== undefined && result.id !== id) {
68
90
  return;
69
91
  }
70
- if (error) {
71
- reject(error);
92
+ this.tunnel.removeListener(handler);
93
+ if (result.error) {
94
+ reject(result.error);
72
95
  }
73
96
  else {
74
- resolve(value);
97
+ resolve(result.value);
75
98
  }
76
- this.tunnel.removeListener(handler);
77
99
  };
78
100
  this.tunnel.on(handler);
79
101
  });
@@ -83,15 +105,37 @@ class PromiseTunnel {
83
105
  * Туннель для события.
84
106
  */
85
107
  class EventTunnel {
108
+ /**
109
+ * Имя события.
110
+ */
111
+ name;
112
+ /**
113
+ * Туннель вызова события.
114
+ */
115
+ emitTunnel;
116
+ /**
117
+ * Туннель обработки события.
118
+ */
119
+ onTunnel;
120
+ /**
121
+ * Туннель однократной обработки события.
122
+ */
123
+ onceTunnel;
124
+ /**
125
+ * Туннель отписки от события.
126
+ */
127
+ offTunnel;
86
128
  /**
87
129
  * Создать туннель для события.
88
130
  * @param name - Имя события.
89
131
  */
90
132
  constructor(name) {
133
+ Names.validateEvent(name);
91
134
  this.name = name;
92
135
  this.emitTunnel = new IPCTunnel(IpcChannel.event.emit(name));
93
136
  this.onTunnel = new IPCTunnel(IpcChannel.event.on());
94
137
  this.onceTunnel = new IPCTunnel(IpcChannel.event.once());
138
+ this.offTunnel = new IPCTunnel(IpcChannel.event.off());
95
139
  }
96
140
  /**
97
141
  * Добавить обработчик события.
@@ -99,10 +143,7 @@ class EventTunnel {
99
143
  * @returns Функция отписки от события.
100
144
  */
101
145
  on(listener) {
102
- const handler = (_, result) => listener(result);
103
- this.onTunnel.response(IpcResult.createWithValue(this.name));
104
- this.emitTunnel.on(handler);
105
- return () => this.emitTunnel.removeListener(handler);
146
+ return this.subscribe(listener, false);
106
147
  }
107
148
  /**
108
149
  * Добавить одноразовый обработчик события.
@@ -110,10 +151,7 @@ class EventTunnel {
110
151
  * @returns Функция отписки от события.
111
152
  */
112
153
  once(listener) {
113
- const handler = (_, result) => listener(result);
114
- this.onceTunnel.response(IpcResult.createWithValue(this.name));
115
- this.emitTunnel.once(handler);
116
- return () => this.emitTunnel.removeListener(handler);
154
+ return this.subscribe(listener, true);
117
155
  }
118
156
  /**
119
157
  * Вызвать событие.
@@ -127,13 +165,88 @@ class EventTunnel {
127
165
  * @param error - Ошибка.
128
166
  */
129
167
  error(error) {
130
- this.emitTunnel.response({ error: String(error) });
168
+ this.emitTunnel.response(IpcResult.createWithError(error));
169
+ }
170
+ /**
171
+ * Подписаться на событие.
172
+ * @param listener - Обработчик события.
173
+ * @param isOnce - Одноразовая подписка.
174
+ * @returns Функция отписки от события.
175
+ */
176
+ subscribe(listener, isOnce) {
177
+ if (typeof listener !== 'function') {
178
+ throw new TypeError('Обработчик события должен быть функцией.');
179
+ }
180
+ const handler = (_, payload) => {
181
+ const result = IpcPayload.result(payload);
182
+ if (result) {
183
+ listener(result);
184
+ }
185
+ };
186
+ if (isOnce) {
187
+ this.emitTunnel.once(handler);
188
+ }
189
+ else {
190
+ this.emitTunnel.on(handler);
191
+ }
192
+ try {
193
+ const registration = IpcResult.createWithValue(this.name);
194
+ if (isOnce) {
195
+ this.onceTunnel.response(registration);
196
+ }
197
+ else {
198
+ this.onTunnel.response(registration);
199
+ }
200
+ }
201
+ catch (error) {
202
+ this.emitTunnel.removeListener(handler);
203
+ throw error;
204
+ }
205
+ let isActive = true;
206
+ return () => {
207
+ if (!isActive) {
208
+ return;
209
+ }
210
+ isActive = false;
211
+ this.emitTunnel.removeListener(handler);
212
+ // Без этого main процесс навсегда сохранял бы ссылку на
213
+ // `WebContents` и продолжал отправлять ему события.
214
+ try {
215
+ this.offTunnel.response({
216
+ value: this.name,
217
+ type: isOnce ? 'once' : 'on'
218
+ });
219
+ }
220
+ catch {
221
+ // Renderer уже завершается — отписываться больше некуда.
222
+ }
223
+ };
131
224
  }
132
225
  }
133
226
  /**
134
227
  * IPC туннель.
135
228
  */
136
- class IPCTunnel {
229
+ export default class IPCTunnel {
230
+ /**
231
+ * Туннель для функции.
232
+ */
233
+ static Function = FunctionTunnel;
234
+ /**
235
+ * Туннель для переменной.
236
+ */
237
+ static Variable = VariableTunnel;
238
+ /**
239
+ * Туннель для обещания.
240
+ */
241
+ static Promise = PromiseTunnel;
242
+ /**
243
+ * Туннель для события.
244
+ */
245
+ static Event = EventTunnel;
246
+ /**
247
+ * Канал.
248
+ */
249
+ channel;
137
250
  /**
138
251
  * Создать IPC туннель.
139
252
  * @param channel - Канал.
@@ -147,7 +260,11 @@ class IPCTunnel {
147
260
  * @returns Результат запроса.
148
261
  */
149
262
  request(args = { args: [] }) {
150
- return ipcRenderer.sendSync(this.channel, args);
263
+ const result = IpcPayload.result(ipcRenderer.sendSync(this.channel, args));
264
+ if (!result) {
265
+ return IpcResult.createWithError(new Error(`Нет ответа по каналу '${this.channel}'.`));
266
+ }
267
+ return result;
151
268
  }
152
269
  /**
153
270
  * Отправить ответ.
@@ -184,20 +301,3 @@ class IPCTunnel {
184
301
  ipcRenderer.removeAllListeners(this.channel);
185
302
  }
186
303
  }
187
- /**
188
- * Туннель для функции.
189
- */
190
- IPCTunnel.Function = FunctionTunnel;
191
- /**
192
- * Туннель для переменной.
193
- */
194
- IPCTunnel.Variable = VariableTunnel;
195
- /**
196
- * Туннель для обещания.
197
- */
198
- IPCTunnel.Promise = PromiseTunnel;
199
- /**
200
- * Туннель для события.
201
- */
202
- IPCTunnel.Event = EventTunnel;
203
- export default IPCTunnel;
package/esm/types.d.ts CHANGED
@@ -93,6 +93,10 @@ export interface IResult<TValue = any> {
93
93
  * Уникальный идентификатор.
94
94
  */
95
95
  id?: string;
96
+ /**
97
+ * Тип подписки на событие (для канала отписки).
98
+ */
99
+ type?: 'on' | 'once';
96
100
  }
97
101
  /**
98
102
  * Передаваемый по IPC запрос.
package/package.json CHANGED
@@ -1,25 +1,47 @@
1
1
  {
2
2
  "name": "emr-bridge",
3
- "version": "2.0.1",
3
+ "version": "2.1.0",
4
4
  "description": "Allows you to easily give access to main methods from the renderer process",
5
5
  "main": "esm/entries/index.js",
6
6
  "type": "module",
7
7
  "scripts": {
8
- "compile": "tsc --project ./tsconfig.json && tsc --project ./tsconfig.cjs.json",
8
+ "clean": "node ./scripts/clean.mjs",
9
+ "compile": "npm run clean && tsc --project ./tsconfig.json && tsc --project ./tsconfig.cjs.json && node ./scripts/write-cjs-package.mjs",
10
+ "typecheck": "tsc --project ./tsconfig.test.json",
11
+ "test": "node --import ./test/setup.mjs --test \"test/*.test.ts\"",
9
12
  "pack": "npm run compile && npm pack"
10
13
  },
11
14
  "types": "esm/entries/index.d.ts",
12
- "files": [ "esm", "cjs"],
15
+ "files": [
16
+ "esm",
17
+ "cjs"
18
+ ],
13
19
  "typesVersions": {
14
20
  "*": {
15
- ".": ["./esm/entries/index.d.ts"],
16
- "./cjs": ["./cjs/entries/index.d.ts"],
17
- "./main": ["./esm/entries/main.d.ts"],
18
- "./renderer": ["./esm/entries/renderer.d.ts"],
19
- "./preload": ["./esm/entries/preload.d.ts"],
20
- "./cjs/main": ["./cjs/entries/main.d.ts"],
21
- "./cjs/renderer": ["./cjs/entries/renderer.d.ts"],
22
- "./cjs/preload": ["./cjs/entries/preload.d.ts"]
21
+ ".": [
22
+ "./esm/entries/index.d.ts"
23
+ ],
24
+ "./cjs": [
25
+ "./cjs/entries/index.d.ts"
26
+ ],
27
+ "./main": [
28
+ "./esm/entries/main.d.ts"
29
+ ],
30
+ "./renderer": [
31
+ "./esm/entries/renderer.d.ts"
32
+ ],
33
+ "./preload": [
34
+ "./esm/entries/preload.d.ts"
35
+ ],
36
+ "./cjs/main": [
37
+ "./cjs/entries/main.d.ts"
38
+ ],
39
+ "./cjs/renderer": [
40
+ "./cjs/entries/renderer.d.ts"
41
+ ],
42
+ "./cjs/preload": [
43
+ "./cjs/entries/preload.d.ts"
44
+ ]
23
45
  }
24
46
  },
25
47
  "exports": {
@@ -44,9 +66,9 @@
44
66
  "author": "VerZsuT",
45
67
  "license": "MIT",
46
68
  "peerDependencies": {
47
- "electron": ">=20.0.0"
69
+ "electron": ">=40.0.0"
48
70
  },
49
71
  "devDependencies": {
50
- "typescript": "^5.7.2"
72
+ "typescript": "^7.0.2"
51
73
  }
52
74
  }