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.
Files changed (141) hide show
  1. package/LICENCE +1 -1
  2. package/README.md +173 -366
  3. package/cjs/entries/index.d.ts +1 -0
  4. package/cjs/entries/index.js +6 -0
  5. package/cjs/entries/main.d.ts +2 -0
  6. package/cjs/entries/main.js +27 -0
  7. package/cjs/entries/preload.d.ts +3 -0
  8. package/cjs/entries/preload.js +29 -0
  9. package/cjs/entries/renderer.d.ts +2 -0
  10. package/cjs/entries/renderer.js +27 -0
  11. package/cjs/errors.d.ts +42 -10
  12. package/cjs/errors.js +77 -23
  13. package/cjs/scripts/base-bridge.d.ts +95 -0
  14. package/cjs/scripts/base-bridge.js +128 -0
  15. package/cjs/scripts/helpers/env.d.ts +19 -0
  16. package/cjs/scripts/helpers/env.js +28 -0
  17. package/cjs/scripts/helpers/errors.d.ts +12 -0
  18. package/cjs/scripts/helpers/errors.js +17 -0
  19. package/cjs/scripts/helpers/id.d.ts +9 -0
  20. package/cjs/scripts/helpers/id.js +14 -0
  21. package/cjs/scripts/helpers/index.d.ts +8 -0
  22. package/cjs/scripts/helpers/index.js +22 -0
  23. package/cjs/scripts/helpers/ipc-channel.d.ts +75 -0
  24. package/cjs/scripts/helpers/ipc-channel.js +78 -0
  25. package/cjs/scripts/helpers/ipc-event-in-main.d.ts +24 -0
  26. package/cjs/scripts/helpers/ipc-event-in-main.js +30 -0
  27. package/cjs/scripts/helpers/ipc-result.d.ts +26 -0
  28. package/cjs/scripts/helpers/ipc-result.js +48 -0
  29. package/cjs/scripts/helpers/transfer.d.ts +33 -0
  30. package/cjs/scripts/helpers/transfer.js +57 -0
  31. package/cjs/scripts/helpers/web-contents-events-container.d.ts +51 -0
  32. package/cjs/scripts/helpers/web-contents-events-container.js +75 -0
  33. package/cjs/scripts/main/publish.d.ts +36 -0
  34. package/cjs/scripts/main/publish.js +184 -0
  35. package/cjs/scripts/preload/bridge.d.ts +27 -0
  36. package/cjs/scripts/preload/bridge.js +85 -0
  37. package/cjs/scripts/preload/provider.d.ts +7 -0
  38. package/cjs/scripts/preload/provider.js +89 -0
  39. package/cjs/scripts/renderer/bridge.d.ts +6 -0
  40. package/cjs/scripts/renderer/bridge.js +74 -0
  41. package/cjs/scripts/renderer/tunnels.d.ts +171 -0
  42. package/cjs/scripts/renderer/tunnels.js +205 -0
  43. package/cjs/types.d.ts +189 -64
  44. package/esm/entries/index.d.ts +1 -0
  45. package/esm/entries/index.js +5 -0
  46. package/esm/entries/main.d.ts +2 -0
  47. package/esm/entries/main.js +5 -0
  48. package/esm/entries/preload.d.ts +3 -0
  49. package/esm/entries/preload.js +7 -0
  50. package/esm/entries/renderer.d.ts +2 -0
  51. package/esm/entries/renderer.js +6 -0
  52. package/esm/errors.d.ts +42 -10
  53. package/esm/errors.js +69 -16
  54. package/esm/scripts/base-bridge.d.ts +95 -0
  55. package/esm/scripts/base-bridge.js +125 -0
  56. package/esm/scripts/helpers/env.d.ts +19 -0
  57. package/esm/scripts/helpers/env.js +25 -0
  58. package/esm/scripts/helpers/errors.d.ts +12 -0
  59. package/esm/scripts/helpers/errors.js +14 -0
  60. package/esm/scripts/helpers/id.d.ts +9 -0
  61. package/esm/scripts/helpers/id.js +11 -0
  62. package/esm/scripts/helpers/index.d.ts +8 -0
  63. package/esm/scripts/helpers/index.js +8 -0
  64. package/esm/scripts/helpers/ipc-channel.d.ts +75 -0
  65. package/esm/scripts/helpers/ipc-channel.js +76 -0
  66. package/esm/scripts/helpers/ipc-event-in-main.d.ts +24 -0
  67. package/esm/scripts/helpers/ipc-event-in-main.js +27 -0
  68. package/esm/scripts/helpers/ipc-result.d.ts +26 -0
  69. package/esm/scripts/helpers/ipc-result.js +42 -0
  70. package/esm/scripts/helpers/transfer.d.ts +33 -0
  71. package/esm/scripts/helpers/transfer.js +54 -0
  72. package/esm/scripts/helpers/web-contents-events-container.d.ts +51 -0
  73. package/esm/scripts/helpers/web-contents-events-container.js +72 -0
  74. package/esm/scripts/main/publish.d.ts +36 -0
  75. package/esm/scripts/main/publish.js +177 -0
  76. package/esm/scripts/preload/bridge.d.ts +27 -0
  77. package/esm/scripts/preload/bridge.js +77 -0
  78. package/esm/scripts/preload/provider.d.ts +7 -0
  79. package/esm/scripts/preload/provider.js +84 -0
  80. package/esm/scripts/renderer/bridge.d.ts +6 -0
  81. package/esm/scripts/renderer/bridge.js +69 -0
  82. package/esm/scripts/renderer/tunnels.d.ts +171 -0
  83. package/esm/scripts/renderer/tunnels.js +203 -0
  84. package/esm/types.d.ts +189 -64
  85. package/package.json +23 -41
  86. package/cjs/enums.d.ts +0 -19
  87. package/cjs/enums.js +0 -25
  88. package/cjs/exp.d.ts +0 -4
  89. package/cjs/exp.js +0 -19
  90. package/cjs/index.d.ts +0 -4
  91. package/cjs/index.js +0 -18
  92. package/cjs/main.d.ts +0 -4
  93. package/cjs/main.js +0 -18
  94. package/cjs/preload.d.ts +0 -3
  95. package/cjs/preload.js +0 -10
  96. package/cjs/renderer.d.ts +0 -2
  97. package/cjs/renderer.js +0 -8
  98. package/cjs/scripts/bridge.d.ts +0 -8
  99. package/cjs/scripts/bridge.js +0 -57
  100. package/cjs/scripts/main.d.ts +0 -8
  101. package/cjs/scripts/main.js +0 -72
  102. package/cjs/scripts/new-decorators.d.ts +0 -150
  103. package/cjs/scripts/new-decorators.js +0 -141
  104. package/cjs/scripts/old-decorators.d.ts +0 -185
  105. package/cjs/scripts/old-decorators.js +0 -132
  106. package/cjs/scripts/preload-provider.d.ts +0 -7
  107. package/cjs/scripts/preload-provider.js +0 -96
  108. package/cjs/scripts/provider.d.ts +0 -25
  109. package/cjs/scripts/provider.js +0 -116
  110. package/cjs/scripts/publish.d.ts +0 -40
  111. package/cjs/scripts/publish.js +0 -232
  112. package/cjs/scripts/renderer-tunnels.d.ts +0 -47
  113. package/cjs/scripts/renderer-tunnels.js +0 -115
  114. package/esm/enums.d.ts +0 -19
  115. package/esm/enums.js +0 -22
  116. package/esm/exp.d.ts +0 -4
  117. package/esm/exp.js +0 -3
  118. package/esm/index.d.ts +0 -4
  119. package/esm/index.js +0 -3
  120. package/esm/main.d.ts +0 -4
  121. package/esm/main.js +0 -3
  122. package/esm/preload.d.ts +0 -3
  123. package/esm/preload.js +0 -2
  124. package/esm/renderer.d.ts +0 -2
  125. package/esm/renderer.js +0 -1
  126. package/esm/scripts/bridge.d.ts +0 -8
  127. package/esm/scripts/bridge.js +0 -52
  128. package/esm/scripts/main.d.ts +0 -8
  129. package/esm/scripts/main.js +0 -67
  130. package/esm/scripts/new-decorators.d.ts +0 -150
  131. package/esm/scripts/new-decorators.js +0 -132
  132. package/esm/scripts/old-decorators.d.ts +0 -185
  133. package/esm/scripts/old-decorators.js +0 -122
  134. package/esm/scripts/preload-provider.d.ts +0 -7
  135. package/esm/scripts/preload-provider.js +0 -91
  136. package/esm/scripts/provider.d.ts +0 -25
  137. package/esm/scripts/provider.js +0 -113
  138. package/esm/scripts/publish.d.ts +0 -40
  139. package/esm/scripts/publish.js +0 -220
  140. package/esm/scripts/renderer-tunnels.d.ts +0 -47
  141. package/esm/scripts/renderer-tunnels.js +0 -109
@@ -0,0 +1,171 @@
1
+ import type { IpcRendererEvent } from 'electron';
2
+ import type { EventListener, EventUnsubscribe, IRequest, IResult } from '../../types.js';
3
+ /**
4
+ * IPC туннель для функции.
5
+ */
6
+ declare class FunctionTunnel {
7
+ /**
8
+ * Туннель.
9
+ */
10
+ private readonly tunnel;
11
+ /**
12
+ * Создать IPC туннель для функции.
13
+ * @param name - Имя функции.
14
+ */
15
+ constructor(name: string);
16
+ /**
17
+ * Вызвать функцию.
18
+ * @param args - Аргументы вызова.
19
+ * @returns Результат вызова.
20
+ */
21
+ call(args?: IRequest): IResult;
22
+ }
23
+ /**
24
+ * Туннель для переменной.
25
+ */
26
+ declare class VariableTunnel {
27
+ /**
28
+ * Туннель для получения значения.
29
+ */
30
+ private readonly getTunnel;
31
+ /**
32
+ * Туннель для установки значения.
33
+ */
34
+ private readonly setTunnel;
35
+ /**
36
+ * Создать туннель для переменной.
37
+ * @param name - Имя переменной.
38
+ */
39
+ constructor(name: string);
40
+ /**
41
+ * Получить значение переменной.
42
+ */
43
+ get(): IResult;
44
+ /**
45
+ * Установить значение переменной.
46
+ * @param value - Значение.
47
+ */
48
+ set(value: any): IResult;
49
+ }
50
+ /**
51
+ * Туннель для обработки обещания.
52
+ */
53
+ declare class PromiseTunnel {
54
+ /**
55
+ * Туннель.
56
+ */
57
+ private readonly tunnel;
58
+ /**
59
+ * Создать туннель для обработки обещания.
60
+ * @param channel - Канал возвращающий обещание.
61
+ */
62
+ constructor(channel: string);
63
+ /**
64
+ * Ожидать завершения обещания.
65
+ * @param id - Уникальный идентификатор.
66
+ */
67
+ wait(id?: string): Promise<any>;
68
+ }
69
+ /**
70
+ * Туннель для события.
71
+ */
72
+ declare class EventTunnel {
73
+ private readonly name;
74
+ /**
75
+ * Туннель вызова события.
76
+ */
77
+ private readonly emitTunnel;
78
+ /**
79
+ * Туннель обработки события.
80
+ */
81
+ private readonly onTunnel;
82
+ /**
83
+ * Туннель однократной обработки события.
84
+ */
85
+ private readonly onceTunnel;
86
+ /**
87
+ * Создать туннель для события.
88
+ * @param name - Имя события.
89
+ */
90
+ constructor(name: string);
91
+ /**
92
+ * Добавить обработчик события.
93
+ * @param listener - Обработчик события.
94
+ * @returns Функция отписки от события.
95
+ */
96
+ on(listener: EventListener<IResult>): EventUnsubscribe;
97
+ /**
98
+ * Добавить одноразовый обработчик события.
99
+ * @param listener - Обработчик события.
100
+ * @returns Функция отписки от события.
101
+ */
102
+ once(listener: EventListener<IResult>): EventUnsubscribe;
103
+ /**
104
+ * Вызвать событие.
105
+ * @param value - Передаваемое значение.
106
+ */
107
+ emit(value: any): void;
108
+ /**
109
+ * Бросить ошибку.
110
+ * @param error - Ошибка.
111
+ */
112
+ error(error: Error | string): void;
113
+ }
114
+ /**
115
+ * IPC туннель.
116
+ */
117
+ export default class IPCTunnel {
118
+ private channel;
119
+ /**
120
+ * Туннель для функции.
121
+ */
122
+ static readonly Function: typeof FunctionTunnel;
123
+ /**
124
+ * Туннель для переменной.
125
+ */
126
+ static readonly Variable: typeof VariableTunnel;
127
+ /**
128
+ * Туннель для обещания.
129
+ */
130
+ static readonly Promise: typeof PromiseTunnel;
131
+ /**
132
+ * Туннель для события.
133
+ */
134
+ static readonly Event: typeof EventTunnel;
135
+ /**
136
+ * Создать IPC туннель.
137
+ * @param channel - Канал.
138
+ */
139
+ constructor(channel: string);
140
+ /**
141
+ * Отправить запрос.
142
+ * @param args - Аргументы запроса.
143
+ * @returns Результат запроса.
144
+ */
145
+ request(args?: IRequest): IResult;
146
+ /**
147
+ * Отправить ответ.
148
+ * @param result - Результат.
149
+ */
150
+ response(result?: IResult): void;
151
+ /**
152
+ * Добавить обработчик IPC.
153
+ * @param listener - Обработчик.
154
+ */
155
+ on(listener: (event: IpcRendererEvent, ...args: any[]) => void): void;
156
+ /**
157
+ * Добавить одноразовый обработчик IPC.
158
+ * @param listener - Обработчик.
159
+ */
160
+ once(listener: (event: IpcRendererEvent, ...args: any[]) => void): void;
161
+ /**
162
+ * Удалить обработчик IPC.
163
+ * @param listener - Обработчик.
164
+ */
165
+ removeListener(listener: (event: IpcRendererEvent, ...args: any[]) => void): void;
166
+ /**
167
+ * Удалить все обработчики IPC.
168
+ */
169
+ removeAllListeners(): void;
170
+ }
171
+ export {};
@@ -0,0 +1,203 @@
1
+ import { ipcRenderer } from 'electron';
2
+ import { IpcChannel, IpcResult } from '../helpers/index.js';
3
+ /**
4
+ * IPC туннель для функции.
5
+ */
6
+ class FunctionTunnel {
7
+ /**
8
+ * Создать IPC туннель для функции.
9
+ * @param name - Имя функции.
10
+ */
11
+ constructor(name) {
12
+ this.tunnel = new IPCTunnel(IpcChannel.func.call(name));
13
+ }
14
+ /**
15
+ * Вызвать функцию.
16
+ * @param args - Аргументы вызова.
17
+ * @returns Результат вызова.
18
+ */
19
+ call(args = { args: [] }) {
20
+ return this.tunnel.request(args);
21
+ }
22
+ }
23
+ /**
24
+ * Туннель для переменной.
25
+ */
26
+ class VariableTunnel {
27
+ /**
28
+ * Создать туннель для переменной.
29
+ * @param name - Имя переменной.
30
+ */
31
+ constructor(name) {
32
+ this.getTunnel = new IPCTunnel(IpcChannel.prop.get(name));
33
+ this.setTunnel = new IPCTunnel(IpcChannel.prop.set(name));
34
+ }
35
+ /**
36
+ * Получить значение переменной.
37
+ */
38
+ get() {
39
+ return this.getTunnel.request();
40
+ }
41
+ /**
42
+ * Установить значение переменной.
43
+ * @param value - Значение.
44
+ */
45
+ set(value) {
46
+ return this.setTunnel.request({ args: [value] });
47
+ }
48
+ }
49
+ /**
50
+ * Туннель для обработки обещания.
51
+ */
52
+ class PromiseTunnel {
53
+ /**
54
+ * Создать туннель для обработки обещания.
55
+ * @param channel - Канал возвращающий обещание.
56
+ */
57
+ constructor(channel) {
58
+ this.tunnel = new IPCTunnel(channel);
59
+ }
60
+ /**
61
+ * Ожидать завершения обещания.
62
+ * @param id - Уникальный идентификатор.
63
+ */
64
+ wait(id) {
65
+ return new Promise((resolve, reject) => {
66
+ const handler = (_, { error, value, id: resultId }) => {
67
+ if (id !== undefined && resultId !== id) {
68
+ return;
69
+ }
70
+ if (error) {
71
+ reject(error);
72
+ }
73
+ else {
74
+ resolve(value);
75
+ }
76
+ this.tunnel.removeListener(handler);
77
+ };
78
+ this.tunnel.on(handler);
79
+ });
80
+ }
81
+ }
82
+ /**
83
+ * Туннель для события.
84
+ */
85
+ class EventTunnel {
86
+ /**
87
+ * Создать туннель для события.
88
+ * @param name - Имя события.
89
+ */
90
+ constructor(name) {
91
+ this.name = name;
92
+ this.emitTunnel = new IPCTunnel(IpcChannel.event.emit(name));
93
+ this.onTunnel = new IPCTunnel(IpcChannel.event.on());
94
+ this.onceTunnel = new IPCTunnel(IpcChannel.event.once());
95
+ }
96
+ /**
97
+ * Добавить обработчик события.
98
+ * @param listener - Обработчик события.
99
+ * @returns Функция отписки от события.
100
+ */
101
+ 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);
106
+ }
107
+ /**
108
+ * Добавить одноразовый обработчик события.
109
+ * @param listener - Обработчик события.
110
+ * @returns Функция отписки от события.
111
+ */
112
+ 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);
117
+ }
118
+ /**
119
+ * Вызвать событие.
120
+ * @param value - Передаваемое значение.
121
+ */
122
+ emit(value) {
123
+ this.emitTunnel.response({ value });
124
+ }
125
+ /**
126
+ * Бросить ошибку.
127
+ * @param error - Ошибка.
128
+ */
129
+ error(error) {
130
+ this.emitTunnel.response({ error: String(error) });
131
+ }
132
+ }
133
+ /**
134
+ * IPC туннель.
135
+ */
136
+ class IPCTunnel {
137
+ /**
138
+ * Создать IPC туннель.
139
+ * @param channel - Канал.
140
+ */
141
+ constructor(channel) {
142
+ this.channel = channel;
143
+ }
144
+ /**
145
+ * Отправить запрос.
146
+ * @param args - Аргументы запроса.
147
+ * @returns Результат запроса.
148
+ */
149
+ request(args = { args: [] }) {
150
+ return ipcRenderer.sendSync(this.channel, args);
151
+ }
152
+ /**
153
+ * Отправить ответ.
154
+ * @param result - Результат.
155
+ */
156
+ response(result = {}) {
157
+ ipcRenderer.send(this.channel, result);
158
+ }
159
+ /**
160
+ * Добавить обработчик IPC.
161
+ * @param listener - Обработчик.
162
+ */
163
+ on(listener) {
164
+ ipcRenderer.on(this.channel, listener);
165
+ }
166
+ /**
167
+ * Добавить одноразовый обработчик IPC.
168
+ * @param listener - Обработчик.
169
+ */
170
+ once(listener) {
171
+ ipcRenderer.once(this.channel, listener);
172
+ }
173
+ /**
174
+ * Удалить обработчик IPC.
175
+ * @param listener - Обработчик.
176
+ */
177
+ removeListener(listener) {
178
+ ipcRenderer.removeListener(this.channel, listener);
179
+ }
180
+ /**
181
+ * Удалить все обработчики IPC.
182
+ */
183
+ removeAllListeners() {
184
+ ipcRenderer.removeAllListeners(this.channel);
185
+ }
186
+ }
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
@@ -1,74 +1,199 @@
1
- import type { Scope } from './enums';
2
- import { Access } from './enums';
3
- export interface Target {
4
- as<T>(): T;
1
+ /**
2
+ * Мост до main.
3
+ */
4
+ export interface IBridge {
5
+ /**
6
+ * Вернуть в качестве типа.
7
+ */
8
+ as<TTarget>(): IBridge & TTarget;
9
+ /**
10
+ * Вызвать событие.
11
+ * @param name - Имя события.
12
+ * @param value - Передаваемое значение.
13
+ */
14
+ emit<TValue = unknown>(name: string, value?: TValue): void;
15
+ /**
16
+ * Добавить обработчик события.
17
+ * @param name - Имя события.
18
+ * @param listener - Обработчик.
19
+ * @returns Функция отписки от события.
20
+ */
21
+ on<TValue>(name: string, listener: EventListener<TValue>): EventUnsubscribe;
22
+ /**
23
+ * Добавить одноразовый обработчик события.
24
+ * @param name - Имя события.
25
+ * @param listener - Обработчик.
26
+ * @returns Функция отписки от события.
27
+ */
28
+ once<TValue>(name: string, listener: EventListener<TValue>): EventUnsubscribe;
29
+ /**
30
+ * Вызвать функцию, возвращающую объект, не передаваемый стандартным путём.
31
+ * @param func - Вызываемая функция.
32
+ * @param Class - Класс, экземпляр которого будет возвращён функцией.
33
+ * @param args - Аргументы вызова функции.
34
+ * @returns Возвращённое функцией значение (преобразованное из снимка).
35
+ */
36
+ call<TFunc extends (...args: any[]) => InstanceType<TClass>, TClass extends {
37
+ new (): IHasSnapshot;
38
+ }>(func: TFunc, Class: TClass, args: Parameters<TFunc>): InstanceType<TClass>;
39
+ /**
40
+ * Обернуть функцию, возвращающую экземпляр класса.
41
+ * @param func - Оригинальная функция.
42
+ * @param Class - Класс.
43
+ */
44
+ returns<TFunc extends (...args: any[]) => InstanceType<TClass>, TClass extends {
45
+ new (): IHasSnapshot;
46
+ }>(func: TFunc, Class: TClass): TFunc;
5
47
  }
6
- export type ClassMethodDecorator = <This, Args extends any[], Return>(method: (this: This, ...args: Args) => Return, context: ClassMethodDecoratorContext<This, (this: This, ...args: Args) => Return>) => void;
7
- export type ClassPropertyDecorator = <This, Value>(target: undefined, context: ClassFieldDecoratorContext<This, Value>) => void;
8
- export type ClassGetterDecorator = <This, Value>(getter: () => Value, context: ClassGetterDecoratorContext<This, Value>) => void;
9
- export type ClassSetterDecorator = <This, Value>(setter: (value: Value) => void, context: ClassSetterDecoratorContext<This, Value>) => void;
10
- export type PublishSetterArgs = Omit<PublishPropertyArgs, 'access'>;
11
- export type PublishGetterArgs = Omit<PublishPropertyArgs, 'access'>;
12
- export interface IPCResult {
13
- value?: any;
48
+ /**
49
+ * Работает со снимками.
50
+ */
51
+ export interface IHasSnapshot<TSnapshot = unknown> {
52
+ /**
53
+ * Получить снимок.
54
+ * @returns Снимок.
55
+ */
56
+ takeSnapshot(): TSnapshot;
57
+ /**
58
+ * Обновить из снимка.
59
+ * @param snapshot - Снимок.
60
+ */
61
+ updateFromSnapshot(snapshot: TSnapshot): void;
62
+ }
63
+ /**
64
+ * Значение-снимок, передаваемое по IPC.
65
+ */
66
+ export interface ISnapshotValue<TSnapshot = unknown> {
67
+ /**
68
+ * Тип значения.
69
+ */
70
+ __type__: 'snapshot';
71
+ /**
72
+ * Снимок.
73
+ */
74
+ __snapshot__: TSnapshot;
75
+ }
76
+ /**
77
+ * Передаваемый по IPC результат.
78
+ */
79
+ export interface IResult<TValue = any> {
80
+ /**
81
+ * Значение.
82
+ */
83
+ value?: TValue;
84
+ /**
85
+ * Ошибка.
86
+ */
14
87
  error?: string;
88
+ /**
89
+ * Канал обработки обещания.
90
+ */
15
91
  promiseChannel?: string;
16
- secret?: number;
92
+ /**
93
+ * Уникальный идентификатор.
94
+ */
95
+ id?: string;
17
96
  }
18
- export interface IPCRequest {
97
+ /**
98
+ * Передаваемый по IPC запрос.
99
+ */
100
+ export interface IRequest {
101
+ /**
102
+ * Аргументы.
103
+ */
19
104
  args: any[];
20
- secret?: number;
21
- }
22
- export interface PublishMethodArgs {
23
- name?: string;
24
- scope?: Scope;
25
- }
26
- export interface PublishMainEventArgs {
27
- name?: string;
28
- scope?: Scope;
29
- }
30
- export interface PublishRendererEventArgs {
31
- name?: string;
32
- scope?: Scope;
33
- procFn?: EventReceiver;
34
- }
35
- export interface PublishPropertyArgs {
36
- name?: string;
37
- scope?: Scope;
38
- access?: Access;
39
- }
40
- export type RendererEvent<T = void> = (handler: EventHandler<T>, isOnce?: boolean) => EventUnsubscriber;
41
- export type MainEvent<T = void> = (handler: EventHandler<T>) => EventUnsubscriber;
42
- export type EventEmitter = (...args: any[]) => any;
43
- export type EventReceiver<I = void, O = I> = (input: I) => O;
44
- export type EventUnsubscriber = () => void;
45
- export type EventHandler<T = void> = (result: T) => void;
46
- export type PublicFunction = (...args: any[]) => any;
47
- export interface PublicProperty<T> {
48
- get?(): T;
49
- set?(value: T): void;
50
- }
51
- export interface RendererPublic {
52
- __register__?(instance: any): void;
105
+ /**
106
+ * Уникальный идентификатор.
107
+ */
108
+ id?: string;
53
109
  }
54
- export interface GlobalProvider {
55
- getInfo(): Info;
56
- waitPromise(name: string, resolve: (value: any) => void, reject?: (reason?: any) => void, secret?: number): void;
57
- provided: {
58
- functions: Record<string, (secret: number, args: any[]) => IPCResult>;
59
- mainEvents: Record<string, (type: 'on' | 'once', handler: EventHandler<IPCResult>) => EventUnsubscriber>;
60
- rendererEvents: Record<string, (arg: any) => void>;
61
- properties: Record<string, {
62
- get(): IPCResult;
63
- set(val: any): IPCResult;
64
- }>;
110
+ /**
111
+ * Класс объекта, умеющего работать со снимками.
112
+ */
113
+ export type HasSnapshotClass<TValue = unknown> = {
114
+ new (): IHasSnapshot<TValue>;
115
+ };
116
+ /**
117
+ * Функция отписки от события.
118
+ */
119
+ export type EventUnsubscribe = () => void;
120
+ /**
121
+ * Обработчик события.
122
+ */
123
+ export type EventListener<TResult = undefined> = TResult extends undefined ? () => void : (result: TResult) => void;
124
+ /**
125
+ * Провайдер обязательных функций для работы.
126
+ */
127
+ export interface IGlobalProvider {
128
+ /**
129
+ * Получить информацию о сущностях.
130
+ * @returns Информация о сущностях.
131
+ */
132
+ getEntitiesInfo(): IEntitiesInfo;
133
+ /**
134
+ * Ожидать завершения обещания.
135
+ * @param channel - Канал обработки обещания.
136
+ * @param onSuccess - Функция, вызываемая при успехе.
137
+ * @param onError - Функция, вызываемая при неудаче.
138
+ * @param id - Уникальный идентификатор.
139
+ */
140
+ waitPromise(channel: string, onSuccess: (value: any) => void, onError?: (reason?: any) => void, id?: string): void;
141
+ /**
142
+ * Сущности.
143
+ */
144
+ entities: {
145
+ /**
146
+ * Функции.
147
+ */
148
+ functions: {
149
+ [name: string]: (id: string, args: any[]) => IResult;
150
+ };
151
+ /**
152
+ * События.
153
+ */
154
+ events: {
155
+ /**
156
+ * Добавить обработчик события.
157
+ * @param name - Имя события.
158
+ * @param listener - Обработчик события.
159
+ * @returns Функция отписки от события.
160
+ */
161
+ on(name: string, listener: EventListener<IResult>): EventUnsubscribe;
162
+ /**
163
+ * Добавить одноразовы обработчик события.
164
+ * @param name - Имя события.
165
+ * @param listener - Обработчик события.
166
+ * @returns Функция отписки от события.
167
+ */
168
+ once(name: string, listener: EventListener<IResult>): EventUnsubscribe;
169
+ /**
170
+ * Взывать событие.
171
+ * @param name - Имя события.
172
+ * @param value - Передаваемое значение.
173
+ */
174
+ emit(name: string, value: any): void;
175
+ };
176
+ /**
177
+ * Переменные.
178
+ */
179
+ variables: {
180
+ [name: string]: {
181
+ get(): IResult;
182
+ set(value: any): IResult;
183
+ };
184
+ };
65
185
  };
66
186
  }
67
- export interface Info {
68
- properties: Set<string>;
187
+ /**
188
+ * Информация о сущностях.
189
+ */
190
+ export interface IEntitiesInfo {
191
+ /**
192
+ * Доступные переменные.
193
+ */
194
+ variables: Set<string>;
195
+ /**
196
+ * Доступные функции.
197
+ */
69
198
  functions: Set<string>;
70
- mainEvents: Set<string>;
71
- rendererEvents: Set<string>;
72
- scopes: Map<string, Set<Scope>>;
73
- accesses: Map<string, Set<Access>>;
74
199
  }