emr-bridge 1.7.1 → 2.0.1
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/LICENCE +1 -1
- package/README.md +173 -366
- package/cjs/entries/index.d.ts +1 -0
- package/cjs/entries/index.js +6 -0
- package/cjs/entries/main.d.ts +2 -0
- package/cjs/entries/main.js +27 -0
- package/cjs/entries/preload.d.ts +3 -0
- package/cjs/entries/preload.js +29 -0
- package/cjs/entries/renderer.d.ts +2 -0
- package/cjs/entries/renderer.js +27 -0
- package/cjs/errors.d.ts +42 -10
- package/cjs/errors.js +77 -23
- package/cjs/scripts/base-bridge.d.ts +95 -0
- package/cjs/scripts/base-bridge.js +128 -0
- package/cjs/scripts/helpers/env.d.ts +19 -0
- package/cjs/scripts/helpers/env.js +28 -0
- package/cjs/scripts/helpers/errors.d.ts +12 -0
- package/cjs/scripts/helpers/errors.js +17 -0
- package/cjs/scripts/helpers/id.d.ts +9 -0
- package/cjs/scripts/helpers/id.js +14 -0
- package/cjs/scripts/helpers/index.d.ts +8 -0
- package/cjs/scripts/helpers/index.js +22 -0
- package/cjs/scripts/helpers/ipc-channel.d.ts +75 -0
- package/cjs/scripts/helpers/ipc-channel.js +78 -0
- package/cjs/scripts/helpers/ipc-event-in-main.d.ts +24 -0
- package/cjs/scripts/helpers/ipc-event-in-main.js +30 -0
- package/cjs/scripts/helpers/ipc-result.d.ts +26 -0
- package/cjs/scripts/helpers/ipc-result.js +48 -0
- package/cjs/scripts/helpers/transfer.d.ts +33 -0
- package/cjs/scripts/helpers/transfer.js +57 -0
- package/cjs/scripts/helpers/web-contents-events-container.d.ts +51 -0
- package/cjs/scripts/helpers/web-contents-events-container.js +75 -0
- package/cjs/scripts/main/publish.d.ts +36 -0
- package/cjs/scripts/main/publish.js +184 -0
- package/cjs/scripts/preload/bridge.d.ts +27 -0
- package/cjs/scripts/preload/bridge.js +85 -0
- package/cjs/scripts/preload/provider.d.ts +7 -0
- package/cjs/scripts/preload/provider.js +89 -0
- package/cjs/scripts/renderer/bridge.d.ts +6 -0
- package/cjs/scripts/renderer/bridge.js +74 -0
- package/cjs/scripts/renderer/tunnels.d.ts +171 -0
- package/cjs/scripts/renderer/tunnels.js +205 -0
- package/cjs/types.d.ts +189 -64
- package/esm/entries/index.d.ts +1 -0
- package/esm/entries/index.js +5 -0
- package/esm/entries/main.d.ts +2 -0
- package/esm/entries/main.js +5 -0
- package/esm/entries/preload.d.ts +3 -0
- package/esm/entries/preload.js +7 -0
- package/esm/entries/renderer.d.ts +2 -0
- package/esm/entries/renderer.js +6 -0
- package/esm/errors.d.ts +42 -10
- package/esm/errors.js +69 -16
- package/esm/scripts/base-bridge.d.ts +95 -0
- package/esm/scripts/base-bridge.js +125 -0
- package/esm/scripts/helpers/env.d.ts +19 -0
- package/esm/scripts/helpers/env.js +25 -0
- package/esm/scripts/helpers/errors.d.ts +12 -0
- package/esm/scripts/helpers/errors.js +14 -0
- package/esm/scripts/helpers/id.d.ts +9 -0
- package/esm/scripts/helpers/id.js +11 -0
- package/esm/scripts/helpers/index.d.ts +8 -0
- package/esm/scripts/helpers/index.js +8 -0
- package/esm/scripts/helpers/ipc-channel.d.ts +75 -0
- package/esm/scripts/helpers/ipc-channel.js +76 -0
- package/esm/scripts/helpers/ipc-event-in-main.d.ts +24 -0
- package/esm/scripts/helpers/ipc-event-in-main.js +27 -0
- package/esm/scripts/helpers/ipc-result.d.ts +26 -0
- package/esm/scripts/helpers/ipc-result.js +42 -0
- package/esm/scripts/helpers/transfer.d.ts +33 -0
- package/esm/scripts/helpers/transfer.js +54 -0
- package/esm/scripts/helpers/web-contents-events-container.d.ts +51 -0
- package/esm/scripts/helpers/web-contents-events-container.js +72 -0
- package/esm/scripts/main/publish.d.ts +36 -0
- package/esm/scripts/main/publish.js +177 -0
- package/esm/scripts/preload/bridge.d.ts +27 -0
- package/esm/scripts/preload/bridge.js +77 -0
- package/esm/scripts/preload/provider.d.ts +7 -0
- package/esm/scripts/preload/provider.js +84 -0
- package/esm/scripts/renderer/bridge.d.ts +6 -0
- package/esm/scripts/renderer/bridge.js +69 -0
- package/esm/scripts/renderer/tunnels.d.ts +171 -0
- package/esm/scripts/renderer/tunnels.js +203 -0
- package/esm/types.d.ts +189 -64
- package/package.json +23 -41
- package/cjs/enums.d.ts +0 -19
- package/cjs/enums.js +0 -25
- package/cjs/exp.d.ts +0 -4
- package/cjs/exp.js +0 -19
- package/cjs/index.d.ts +0 -4
- package/cjs/index.js +0 -18
- package/cjs/main.d.ts +0 -4
- package/cjs/main.js +0 -18
- package/cjs/preload.d.ts +0 -3
- package/cjs/preload.js +0 -10
- package/cjs/renderer.d.ts +0 -2
- package/cjs/renderer.js +0 -8
- package/cjs/scripts/bridge.d.ts +0 -8
- package/cjs/scripts/bridge.js +0 -57
- package/cjs/scripts/main.d.ts +0 -8
- package/cjs/scripts/main.js +0 -72
- package/cjs/scripts/new-decorators.d.ts +0 -150
- package/cjs/scripts/new-decorators.js +0 -141
- package/cjs/scripts/old-decorators.d.ts +0 -185
- package/cjs/scripts/old-decorators.js +0 -132
- package/cjs/scripts/preload-provider.d.ts +0 -7
- package/cjs/scripts/preload-provider.js +0 -96
- package/cjs/scripts/provider.d.ts +0 -25
- package/cjs/scripts/provider.js +0 -116
- package/cjs/scripts/publish.d.ts +0 -40
- package/cjs/scripts/publish.js +0 -232
- package/cjs/scripts/renderer-tunnels.d.ts +0 -47
- package/cjs/scripts/renderer-tunnels.js +0 -115
- package/esm/enums.d.ts +0 -19
- package/esm/enums.js +0 -22
- package/esm/exp.d.ts +0 -4
- package/esm/exp.js +0 -3
- package/esm/index.d.ts +0 -4
- package/esm/index.js +0 -3
- package/esm/main.d.ts +0 -4
- package/esm/main.js +0 -3
- package/esm/preload.d.ts +0 -3
- package/esm/preload.js +0 -2
- package/esm/renderer.d.ts +0 -2
- package/esm/renderer.js +0 -1
- package/esm/scripts/bridge.d.ts +0 -8
- package/esm/scripts/bridge.js +0 -52
- package/esm/scripts/main.d.ts +0 -8
- package/esm/scripts/main.js +0 -67
- package/esm/scripts/new-decorators.d.ts +0 -150
- package/esm/scripts/new-decorators.js +0 -132
- package/esm/scripts/old-decorators.d.ts +0 -185
- package/esm/scripts/old-decorators.js +0 -122
- package/esm/scripts/preload-provider.d.ts +0 -7
- package/esm/scripts/preload-provider.js +0 -91
- package/esm/scripts/provider.d.ts +0 -25
- package/esm/scripts/provider.js +0 -113
- package/esm/scripts/publish.d.ts +0 -40
- package/esm/scripts/publish.js +0 -220
- package/esm/scripts/renderer-tunnels.d.ts +0 -47
- package/esm/scripts/renderer-tunnels.js +0 -109
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import type { EventListener, EventUnsubscribe, IBridge, IEntitiesInfo, IHasSnapshot, IResult } from '../types.js';
|
|
2
|
+
/**
|
|
3
|
+
* Базовый класс моста до main.
|
|
4
|
+
*/
|
|
5
|
+
export default abstract class BaseBridge implements IBridge {
|
|
6
|
+
/**
|
|
7
|
+
* Информация о сущностях.
|
|
8
|
+
*/
|
|
9
|
+
protected abstract entitiesInfo: IEntitiesInfo;
|
|
10
|
+
/**
|
|
11
|
+
* Объект, который будет использоваться пользователем.
|
|
12
|
+
*/
|
|
13
|
+
protected readonly target: {
|
|
14
|
+
as: () => any;
|
|
15
|
+
emit: (name: string, value: any) => void;
|
|
16
|
+
on: (name: string, listener: (() => void) | ((result: any) => void)) => EventUnsubscribe;
|
|
17
|
+
once: (name: string, listener: (() => void) | ((result: any) => void)) => EventUnsubscribe;
|
|
18
|
+
call: (func: any, Class: any, args: unknown[]) => any;
|
|
19
|
+
returns: (func: any, Class: any) => any;
|
|
20
|
+
};
|
|
21
|
+
as<TTarget>(): IBridge & TTarget;
|
|
22
|
+
emit(name: string, value: any): void;
|
|
23
|
+
on<TValue = any>(name: string, listener: EventListener<TValue>): EventUnsubscribe;
|
|
24
|
+
once<TValue = any>(name: string, listener: EventListener<TValue>): EventUnsubscribe;
|
|
25
|
+
call<TFunc extends (...args: any[]) => InstanceType<TClass>, TClass extends {
|
|
26
|
+
new (): IHasSnapshot;
|
|
27
|
+
}>(func: TFunc, Class: TClass, args: Parameters<TFunc>): InstanceType<TClass>;
|
|
28
|
+
returns<TFunc extends (...args: any[]) => InstanceType<TClass>, TClass extends {
|
|
29
|
+
new (): IHasSnapshot;
|
|
30
|
+
}>(func: TFunc, Class: TClass): TFunc;
|
|
31
|
+
/**
|
|
32
|
+
* Получить значение публичной переменной.
|
|
33
|
+
* @param name - Имя переменной.
|
|
34
|
+
*/
|
|
35
|
+
protected abstract getVariable<TValue = unknown>(name: string): IResult<TValue>;
|
|
36
|
+
/**
|
|
37
|
+
* Установить значение публичной переменной.
|
|
38
|
+
* @param name - Имя переменной.
|
|
39
|
+
* @param value - Устанавливаемое значение.
|
|
40
|
+
*/
|
|
41
|
+
protected abstract setVariable<TValue>(name: string, value: TValue): IResult<TValue>;
|
|
42
|
+
/**
|
|
43
|
+
* Вызвать публичную функцию.
|
|
44
|
+
* @param name - Имя функции.
|
|
45
|
+
* @param id - Уникальный идентификатор.
|
|
46
|
+
* @param args - Аргументы вызова.
|
|
47
|
+
*/
|
|
48
|
+
protected abstract callFunction<TReturns = unknown>(name: string, id: string, args: any[]): IResult<TReturns>;
|
|
49
|
+
/**
|
|
50
|
+
* Ожидать завершения обещания.
|
|
51
|
+
* @param channel - Канал обработки обещания.
|
|
52
|
+
* @param id - Уникальный идентификатор.
|
|
53
|
+
*/
|
|
54
|
+
protected abstract waitPromise<TReturns = unknown>(channel: string, id?: string): Promise<TReturns>;
|
|
55
|
+
/**
|
|
56
|
+
* Вызвать событие.
|
|
57
|
+
* @param name - Имя события.
|
|
58
|
+
* @param value - Передаваемое значение.
|
|
59
|
+
*/
|
|
60
|
+
protected abstract emitEvent<TValue = unknown>(name: string, value?: TValue): void;
|
|
61
|
+
/**
|
|
62
|
+
* Добавить обработчик события.
|
|
63
|
+
* @param name - Имя события.
|
|
64
|
+
* @param type - Тип события.
|
|
65
|
+
* @param handler - Обработчик события.
|
|
66
|
+
* @returns Функция отписки от события.
|
|
67
|
+
*/
|
|
68
|
+
protected abstract handleEvent<TValue = unknown>(name: string, type: 'on' | 'once', handler: EventListener<IResult<TValue>>): EventUnsubscribe;
|
|
69
|
+
/**
|
|
70
|
+
* Инициализация моста.
|
|
71
|
+
*/
|
|
72
|
+
protected init(): void;
|
|
73
|
+
/**
|
|
74
|
+
* Обработать возможную ошибку.
|
|
75
|
+
*
|
|
76
|
+
* Бросает ошибку если она была передана.
|
|
77
|
+
* @param channel - IPC канал.
|
|
78
|
+
* @param error - Возможная ошибка (текст).
|
|
79
|
+
*/
|
|
80
|
+
protected handlePossibleError(channel: string, error?: string): void | never;
|
|
81
|
+
/**
|
|
82
|
+
* Инициализировать доступ к публичным функциям.
|
|
83
|
+
*/
|
|
84
|
+
protected initFunctions(): void;
|
|
85
|
+
/**
|
|
86
|
+
* Инициализировать доступ к публичным переменным.
|
|
87
|
+
*/
|
|
88
|
+
protected initVariables(): void;
|
|
89
|
+
/**
|
|
90
|
+
* Добавить сущность в `target`.
|
|
91
|
+
* @param name - Имя.
|
|
92
|
+
* @param descriptor - Дескриптор значения.
|
|
93
|
+
*/
|
|
94
|
+
protected define<TValue = unknown>(name: string, descriptor?: TypedPropertyDescriptor<TValue>): void;
|
|
95
|
+
}
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
import { NoGetAccessError, TrySetReadonlyError } from '../errors.js';
|
|
2
|
+
import { Errors, Id, Transfer } from './helpers/index.js';
|
|
3
|
+
/**
|
|
4
|
+
* Базовый класс моста до main.
|
|
5
|
+
*/
|
|
6
|
+
export default class BaseBridge {
|
|
7
|
+
constructor() {
|
|
8
|
+
/**
|
|
9
|
+
* Объект, который будет использоваться пользователем.
|
|
10
|
+
*/
|
|
11
|
+
this.target = {
|
|
12
|
+
as: () => this.as(),
|
|
13
|
+
emit: (...args) => this.emit(...args),
|
|
14
|
+
on: (...args) => this.on(...args),
|
|
15
|
+
once: (...args) => this.once(...args),
|
|
16
|
+
call: (...args) => this.call(...args),
|
|
17
|
+
returns: (...args) => this.returns(...args)
|
|
18
|
+
};
|
|
19
|
+
}
|
|
20
|
+
as() {
|
|
21
|
+
return this.target;
|
|
22
|
+
}
|
|
23
|
+
emit(name, value) {
|
|
24
|
+
this.emitEvent(name, Transfer.toTransferable(value));
|
|
25
|
+
}
|
|
26
|
+
on(name, listener) {
|
|
27
|
+
return this.handleEvent(name, 'on', ({ value, error }) => {
|
|
28
|
+
this.handlePossibleError(`event: ${name}`, error);
|
|
29
|
+
listener(value);
|
|
30
|
+
});
|
|
31
|
+
}
|
|
32
|
+
once(name, listener) {
|
|
33
|
+
return this.handleEvent(name, 'once', ({ value, error }) => {
|
|
34
|
+
this.handlePossibleError(`event: ${name}`, error);
|
|
35
|
+
listener(value);
|
|
36
|
+
});
|
|
37
|
+
}
|
|
38
|
+
call(func, Class, args) {
|
|
39
|
+
const value = func(...args);
|
|
40
|
+
if (Transfer.isSnapshotValue(value)) {
|
|
41
|
+
return Transfer.getFromSnapshot(value, Class);
|
|
42
|
+
}
|
|
43
|
+
return value;
|
|
44
|
+
}
|
|
45
|
+
returns(func, Class) {
|
|
46
|
+
return ((...args) => this.call(func, Class, args));
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Инициализация моста.
|
|
50
|
+
*/
|
|
51
|
+
init() {
|
|
52
|
+
this.initFunctions();
|
|
53
|
+
this.initVariables();
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Обработать возможную ошибку.
|
|
57
|
+
*
|
|
58
|
+
* Бросает ошибку если она была передана.
|
|
59
|
+
* @param channel - IPC канал.
|
|
60
|
+
* @param error - Возможная ошибка (текст).
|
|
61
|
+
*/
|
|
62
|
+
handlePossibleError(channel, error) {
|
|
63
|
+
if (!error) {
|
|
64
|
+
return;
|
|
65
|
+
}
|
|
66
|
+
throw new Error(`Error on ${channel}.\n${error}`.replace('Error: ', ''));
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Инициализировать доступ к публичным функциям.
|
|
70
|
+
*/
|
|
71
|
+
initFunctions() {
|
|
72
|
+
for (const name of this.entitiesInfo.functions) {
|
|
73
|
+
this.define(name, {
|
|
74
|
+
value: (...args) => {
|
|
75
|
+
const id = Id.new();
|
|
76
|
+
const preparedArgs = args.map(arg => Transfer.toTransferable(arg));
|
|
77
|
+
const { error, promiseChannel, value } = this.callFunction(name, id, preparedArgs);
|
|
78
|
+
this.handlePossibleError(name, error);
|
|
79
|
+
return promiseChannel
|
|
80
|
+
? this.waitPromise(promiseChannel, id)
|
|
81
|
+
: value;
|
|
82
|
+
}
|
|
83
|
+
});
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* Инициализировать доступ к публичным переменным.
|
|
88
|
+
*/
|
|
89
|
+
initVariables() {
|
|
90
|
+
for (const name of this.entitiesInfo.variables) {
|
|
91
|
+
this.define(name, {
|
|
92
|
+
get: () => {
|
|
93
|
+
const { error, value } = this.getVariable(name);
|
|
94
|
+
this.handlePossibleError(name, error);
|
|
95
|
+
return value;
|
|
96
|
+
},
|
|
97
|
+
set: (value) => {
|
|
98
|
+
const { error } = this.setVariable(name, value);
|
|
99
|
+
this.handlePossibleError(name, error);
|
|
100
|
+
}
|
|
101
|
+
});
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* Добавить сущность в `target`.
|
|
106
|
+
* @param name - Имя.
|
|
107
|
+
* @param descriptor - Дескриптор значения.
|
|
108
|
+
*/
|
|
109
|
+
define(name, descriptor) {
|
|
110
|
+
const hasValue = Boolean(descriptor?.value);
|
|
111
|
+
const defaultDescriptor = {
|
|
112
|
+
get: () => descriptor.value,
|
|
113
|
+
set: Errors.getThrower(TrySetReadonlyError, name),
|
|
114
|
+
enumerable: true
|
|
115
|
+
};
|
|
116
|
+
const noValueDescriptor = {
|
|
117
|
+
get: descriptor?.get || Errors.getThrower(NoGetAccessError, name),
|
|
118
|
+
set: descriptor?.set || Errors.getThrower(TrySetReadonlyError, name),
|
|
119
|
+
enumerable: true
|
|
120
|
+
};
|
|
121
|
+
Object.defineProperty(this.target, name, hasValue
|
|
122
|
+
? defaultDescriptor
|
|
123
|
+
: noValueDescriptor);
|
|
124
|
+
}
|
|
125
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Хелпер для работы с исполняемым окружением.
|
|
3
|
+
*/
|
|
4
|
+
export default class Env {
|
|
5
|
+
/**
|
|
6
|
+
* Есть ли объект `window`.
|
|
7
|
+
*/
|
|
8
|
+
static get hasWindow(): boolean;
|
|
9
|
+
/**
|
|
10
|
+
* Есть ли провайдер необходимых методов из `preload` в `renderer`. (`window.__provider__`)
|
|
11
|
+
*/
|
|
12
|
+
static get hasProvider(): boolean;
|
|
13
|
+
/**
|
|
14
|
+
* Является ли окружение `preload` процессом.
|
|
15
|
+
*
|
|
16
|
+
* Работает корректно только если запущено в `preload` или `renderer`.
|
|
17
|
+
*/
|
|
18
|
+
static get isPreload(): boolean;
|
|
19
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Хелпер для работы с исполняемым окружением.
|
|
3
|
+
*/
|
|
4
|
+
export default class Env {
|
|
5
|
+
/**
|
|
6
|
+
* Есть ли объект `window`.
|
|
7
|
+
*/
|
|
8
|
+
static get hasWindow() {
|
|
9
|
+
return typeof window !== 'undefined';
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Есть ли провайдер необходимых методов из `preload` в `renderer`. (`window.__provider__`)
|
|
13
|
+
*/
|
|
14
|
+
static get hasProvider() {
|
|
15
|
+
return Boolean(window.__provider__);
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Является ли окружение `preload` процессом.
|
|
19
|
+
*
|
|
20
|
+
* Работает корректно только если запущено в `preload` или `renderer`.
|
|
21
|
+
*/
|
|
22
|
+
static get isPreload() {
|
|
23
|
+
return typeof global !== 'undefined';
|
|
24
|
+
}
|
|
25
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Хелпер для работы с ошибками.
|
|
3
|
+
*/
|
|
4
|
+
export default class Errors {
|
|
5
|
+
/**
|
|
6
|
+
* Получить функцию выброса ошибки.
|
|
7
|
+
* @param errorClass - Класс ошибки.
|
|
8
|
+
* @param args - Аргументы создания класса.
|
|
9
|
+
* @returns Функция выброса ошибки.
|
|
10
|
+
*/
|
|
11
|
+
static getThrower<TClass extends new (...args: TArgs) => InstanceType<TClass>, TArgs extends any[]>(errorClass: TClass, ...args: TArgs): () => never;
|
|
12
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Хелпер для работы с ошибками.
|
|
3
|
+
*/
|
|
4
|
+
export default class Errors {
|
|
5
|
+
/**
|
|
6
|
+
* Получить функцию выброса ошибки.
|
|
7
|
+
* @param errorClass - Класс ошибки.
|
|
8
|
+
* @param args - Аргументы создания класса.
|
|
9
|
+
* @returns Функция выброса ошибки.
|
|
10
|
+
*/
|
|
11
|
+
static getThrower(errorClass, ...args) {
|
|
12
|
+
return () => { throw new errorClass(...args); };
|
|
13
|
+
}
|
|
14
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export { default as Env } from './env.js';
|
|
2
|
+
export { default as Errors } from './errors.js';
|
|
3
|
+
export { default as Id } from './id.js';
|
|
4
|
+
export { default as IpcChannel } from './ipc-channel.js';
|
|
5
|
+
export { default as IpcEventInMain } from './ipc-event-in-main.js';
|
|
6
|
+
export { default as IpcResult } from './ipc-result.js';
|
|
7
|
+
export { default as Transfer } from './transfer.js';
|
|
8
|
+
export { default as WebContentsEventsContainer } from './web-contents-events-container.js';
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export { default as Env } from './env.js';
|
|
2
|
+
export { default as Errors } from './errors.js';
|
|
3
|
+
export { default as Id } from './id.js';
|
|
4
|
+
export { default as IpcChannel } from './ipc-channel.js';
|
|
5
|
+
export { default as IpcEventInMain } from './ipc-event-in-main.js';
|
|
6
|
+
export { default as IpcResult } from './ipc-result.js';
|
|
7
|
+
export { default as Transfer } from './transfer.js';
|
|
8
|
+
export { default as WebContentsEventsContainer } from './web-contents-events-container.js';
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Хелпер для работы с каналом IPC.
|
|
3
|
+
*/
|
|
4
|
+
export default class IpcChannel {
|
|
5
|
+
/**
|
|
6
|
+
* Информация о публичных сущностях.
|
|
7
|
+
*/
|
|
8
|
+
static readonly publicInfo: {
|
|
9
|
+
/**
|
|
10
|
+
* Получить канал получения информации.
|
|
11
|
+
* @returns Канал получения информации
|
|
12
|
+
*/
|
|
13
|
+
get: () => string;
|
|
14
|
+
};
|
|
15
|
+
/**
|
|
16
|
+
* Публичная функция.
|
|
17
|
+
*/
|
|
18
|
+
static readonly func: {
|
|
19
|
+
/**
|
|
20
|
+
* Получить канал вызова функции.
|
|
21
|
+
* @param name - Имя функции.
|
|
22
|
+
* @returns Канал вызова функции.
|
|
23
|
+
*/
|
|
24
|
+
call: (name: string) => string;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* Публичное событие.
|
|
28
|
+
*/
|
|
29
|
+
static readonly event: {
|
|
30
|
+
/**
|
|
31
|
+
* Получить канал отслеживания события.
|
|
32
|
+
* @returns Канал отслеживания события.
|
|
33
|
+
*/
|
|
34
|
+
on: () => string;
|
|
35
|
+
/**
|
|
36
|
+
* Получить канал однократного отслеживания события.
|
|
37
|
+
* @returns Канал однократного отслеживания события.
|
|
38
|
+
*/
|
|
39
|
+
once: () => string;
|
|
40
|
+
/**
|
|
41
|
+
* Получить канал вызова события.
|
|
42
|
+
* @param name - Название события.
|
|
43
|
+
* @returns Канал вызова события.
|
|
44
|
+
*/
|
|
45
|
+
emit: (name: string) => string;
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* Публичное свойство.
|
|
49
|
+
*/
|
|
50
|
+
static readonly prop: {
|
|
51
|
+
/**
|
|
52
|
+
* Получить канал получения значения свойства.
|
|
53
|
+
* @param name - Имя свойства.
|
|
54
|
+
* @returns Канал получения значения свойства.
|
|
55
|
+
*/
|
|
56
|
+
get: (name: string) => string;
|
|
57
|
+
/**
|
|
58
|
+
* Получить канал установки значения свойства.
|
|
59
|
+
* @param name - Имя свойства.
|
|
60
|
+
* @returns Канал получения установки значения свойства.
|
|
61
|
+
*/
|
|
62
|
+
set: (name: string) => string;
|
|
63
|
+
};
|
|
64
|
+
/**
|
|
65
|
+
* Обещание.
|
|
66
|
+
*/
|
|
67
|
+
static readonly promise: {
|
|
68
|
+
/**
|
|
69
|
+
* Получить канал обработки обещания.
|
|
70
|
+
* @param channel - Канал, который возвращает обещание.
|
|
71
|
+
* @returns Канал обработки обещания.
|
|
72
|
+
*/
|
|
73
|
+
get: (channel: string) => string;
|
|
74
|
+
};
|
|
75
|
+
}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Хелпер для работы с каналом IPC.
|
|
3
|
+
*/
|
|
4
|
+
class IpcChannel {
|
|
5
|
+
}
|
|
6
|
+
/**
|
|
7
|
+
* Информация о публичных сущностях.
|
|
8
|
+
*/
|
|
9
|
+
IpcChannel.publicInfo = {
|
|
10
|
+
/**
|
|
11
|
+
* Получить канал получения информации.
|
|
12
|
+
* @returns Канал получения информации
|
|
13
|
+
*/
|
|
14
|
+
get: () => 'GET_PUBLIC_INFO'
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
* Публичная функция.
|
|
18
|
+
*/
|
|
19
|
+
IpcChannel.func = {
|
|
20
|
+
/**
|
|
21
|
+
* Получить канал вызова функции.
|
|
22
|
+
* @param name - Имя функции.
|
|
23
|
+
* @returns Канал вызова функции.
|
|
24
|
+
*/
|
|
25
|
+
call: (name) => `FUNCTION_CALL_${name}`
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* Публичное событие.
|
|
29
|
+
*/
|
|
30
|
+
IpcChannel.event = {
|
|
31
|
+
/**
|
|
32
|
+
* Получить канал отслеживания события.
|
|
33
|
+
* @returns Канал отслеживания события.
|
|
34
|
+
*/
|
|
35
|
+
on: () => 'EVENT_ON',
|
|
36
|
+
/**
|
|
37
|
+
* Получить канал однократного отслеживания события.
|
|
38
|
+
* @returns Канал однократного отслеживания события.
|
|
39
|
+
*/
|
|
40
|
+
once: () => 'EVENT_ONCE',
|
|
41
|
+
/**
|
|
42
|
+
* Получить канал вызова события.
|
|
43
|
+
* @param name - Название события.
|
|
44
|
+
* @returns Канал вызова события.
|
|
45
|
+
*/
|
|
46
|
+
emit: (name) => `EVENT_EMIT_${name}`
|
|
47
|
+
};
|
|
48
|
+
/**
|
|
49
|
+
* Публичное свойство.
|
|
50
|
+
*/
|
|
51
|
+
IpcChannel.prop = {
|
|
52
|
+
/**
|
|
53
|
+
* Получить канал получения значения свойства.
|
|
54
|
+
* @param name - Имя свойства.
|
|
55
|
+
* @returns Канал получения значения свойства.
|
|
56
|
+
*/
|
|
57
|
+
get: (name) => `PROPERTY_GET_${name}`,
|
|
58
|
+
/**
|
|
59
|
+
* Получить канал установки значения свойства.
|
|
60
|
+
* @param name - Имя свойства.
|
|
61
|
+
* @returns Канал получения установки значения свойства.
|
|
62
|
+
*/
|
|
63
|
+
set: (name) => `PROPERTY_SET_${name}`
|
|
64
|
+
};
|
|
65
|
+
/**
|
|
66
|
+
* Обещание.
|
|
67
|
+
*/
|
|
68
|
+
IpcChannel.promise = {
|
|
69
|
+
/**
|
|
70
|
+
* Получить канал обработки обещания.
|
|
71
|
+
* @param channel - Канал, который возвращает обещание.
|
|
72
|
+
* @returns Канал обработки обещания.
|
|
73
|
+
*/
|
|
74
|
+
get: (channel) => `${channel}_PROMISE`
|
|
75
|
+
};
|
|
76
|
+
export default IpcChannel;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { IpcMainEvent } from 'electron';
|
|
2
|
+
import type { IResult } from '../../types.js';
|
|
3
|
+
/**
|
|
4
|
+
* Событие вызова IPC в `main` процессе.
|
|
5
|
+
*/
|
|
6
|
+
export default class IpcEventInMain {
|
|
7
|
+
private event;
|
|
8
|
+
/**
|
|
9
|
+
* Создать событие вызова IPC в `main` процессе.
|
|
10
|
+
* @param event - Оригинальное IPC событие.
|
|
11
|
+
*/
|
|
12
|
+
constructor(event: IpcMainEvent);
|
|
13
|
+
/**
|
|
14
|
+
* Отправить сообщение в канал `renderer` процесса.
|
|
15
|
+
* @param channel - IPC канал.
|
|
16
|
+
* @param result - Отправляемый результат.
|
|
17
|
+
*/
|
|
18
|
+
send(channel: string, result: IResult): void;
|
|
19
|
+
/**
|
|
20
|
+
* Вернуть результат вызова IPC.
|
|
21
|
+
* @param value - Результат.
|
|
22
|
+
*/
|
|
23
|
+
return(value: any): void;
|
|
24
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Событие вызова IPC в `main` процессе.
|
|
3
|
+
*/
|
|
4
|
+
export default class IpcEventInMain {
|
|
5
|
+
/**
|
|
6
|
+
* Создать событие вызова IPC в `main` процессе.
|
|
7
|
+
* @param event - Оригинальное IPC событие.
|
|
8
|
+
*/
|
|
9
|
+
constructor(event) {
|
|
10
|
+
this.event = event;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Отправить сообщение в канал `renderer` процесса.
|
|
14
|
+
* @param channel - IPC канал.
|
|
15
|
+
* @param result - Отправляемый результат.
|
|
16
|
+
*/
|
|
17
|
+
send(channel, result) {
|
|
18
|
+
this.event.sender.send(channel, result);
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Вернуть результат вызова IPC.
|
|
22
|
+
* @param value - Результат.
|
|
23
|
+
*/
|
|
24
|
+
return(value) {
|
|
25
|
+
this.event.returnValue = value;
|
|
26
|
+
}
|
|
27
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import type { IResult } from '../../types.js';
|
|
2
|
+
/**
|
|
3
|
+
* Хелпер для работы с результатом IPC.
|
|
4
|
+
*/
|
|
5
|
+
export default class IpcResult {
|
|
6
|
+
/**
|
|
7
|
+
* Создать результат с обещанием.
|
|
8
|
+
* @param promiseChannel - Канал обработки обещания.
|
|
9
|
+
* @returns Результат с обещанием.
|
|
10
|
+
*/
|
|
11
|
+
static createWithPromise(promiseChannel: string): IResult;
|
|
12
|
+
/**
|
|
13
|
+
* Создать результат со значением.
|
|
14
|
+
* @param value - Значение. **Должно быть передаваемым**.
|
|
15
|
+
* @param id - Уникальный идентификатор.
|
|
16
|
+
* @returns Результат со значением.
|
|
17
|
+
*/
|
|
18
|
+
static createWithValue<T = unknown>(value: T, id?: string): IResult;
|
|
19
|
+
/**
|
|
20
|
+
* Создать результат с ошибкой.
|
|
21
|
+
* @param error - Ошибка.
|
|
22
|
+
* @param id - Уникальный идентификатор.
|
|
23
|
+
* @returns Результат с ошибкой.
|
|
24
|
+
*/
|
|
25
|
+
static createWithError(error?: Error | string, id?: string): IResult;
|
|
26
|
+
}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import Transfer from './transfer.js';
|
|
2
|
+
/**
|
|
3
|
+
* Хелпер для работы с результатом IPC.
|
|
4
|
+
*/
|
|
5
|
+
export default class IpcResult {
|
|
6
|
+
/**
|
|
7
|
+
* Создать результат с обещанием.
|
|
8
|
+
* @param promiseChannel - Канал обработки обещания.
|
|
9
|
+
* @returns Результат с обещанием.
|
|
10
|
+
*/
|
|
11
|
+
static createWithPromise(promiseChannel) {
|
|
12
|
+
return { promiseChannel };
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Создать результат со значением.
|
|
16
|
+
* @param value - Значение. **Должно быть передаваемым**.
|
|
17
|
+
* @param id - Уникальный идентификатор.
|
|
18
|
+
* @returns Результат со значением.
|
|
19
|
+
*/
|
|
20
|
+
static createWithValue(value, id) {
|
|
21
|
+
return { value: Transfer.toTransferable(value), id };
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Создать результат с ошибкой.
|
|
25
|
+
* @param error - Ошибка.
|
|
26
|
+
* @param id - Уникальный идентификатор.
|
|
27
|
+
* @returns Результат с ошибкой.
|
|
28
|
+
*/
|
|
29
|
+
static createWithError(error, id) {
|
|
30
|
+
let resultError;
|
|
31
|
+
if (error === undefined) {
|
|
32
|
+
resultError = "Unknown error";
|
|
33
|
+
}
|
|
34
|
+
else if (typeof error === 'string') {
|
|
35
|
+
resultError = error;
|
|
36
|
+
}
|
|
37
|
+
else {
|
|
38
|
+
resultError = error.stack ?? error.message;
|
|
39
|
+
}
|
|
40
|
+
return { error: resultError, id };
|
|
41
|
+
}
|
|
42
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import type { IHasSnapshot, ISnapshotValue } from '../../types.js';
|
|
2
|
+
/**
|
|
3
|
+
* Хелпер для передачи значений через IPC.
|
|
4
|
+
*/
|
|
5
|
+
export default class Transfer {
|
|
6
|
+
/**
|
|
7
|
+
* Получить значение из снимка.
|
|
8
|
+
* @param value - Значение-снимок.
|
|
9
|
+
* @param Class - Класс, экземпляр которого будет создан из снимка.
|
|
10
|
+
* @returns Значение из снимка.
|
|
11
|
+
*/
|
|
12
|
+
static getFromSnapshot<TSnapshot, TClass extends {
|
|
13
|
+
new (): IHasSnapshot<TSnapshot>;
|
|
14
|
+
}>(value: ISnapshotValue<TSnapshot>, Class: TClass): InstanceType<TClass>;
|
|
15
|
+
/**
|
|
16
|
+
* Преобразовать значение в передаваемое по IPC.
|
|
17
|
+
*
|
|
18
|
+
* Если возможно, создаст снимок.
|
|
19
|
+
* @param value - Преобразуемое значение.
|
|
20
|
+
* @returns Значение, передаваемое по IPC.
|
|
21
|
+
*/
|
|
22
|
+
static toTransferable<T>(value: T): ISnapshotValue | T;
|
|
23
|
+
/**
|
|
24
|
+
* Является ли переданное по IPC значение снимком.
|
|
25
|
+
* @param value - Значение из IPC.
|
|
26
|
+
*/
|
|
27
|
+
static isSnapshotValue(value: unknown): value is ISnapshotValue;
|
|
28
|
+
/**
|
|
29
|
+
* Может ли значение вернуть снимок.
|
|
30
|
+
* @param value - Значение.
|
|
31
|
+
*/
|
|
32
|
+
static isHasSnapshot(value: unknown): value is IHasSnapshot;
|
|
33
|
+
}
|