emr-bridge 1.7.0 → 2.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.
Files changed (159) 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/enums.d.ts +5 -14
  12. package/cjs/enums.js +12 -23
  13. package/cjs/errors.d.ts +42 -10
  14. package/cjs/errors.js +77 -23
  15. package/cjs/index.d.ts +4 -4
  16. package/cjs/index.js +14 -16
  17. package/cjs/main.d.ts +2 -4
  18. package/cjs/main.js +7 -16
  19. package/cjs/preload.d.ts +3 -3
  20. package/cjs/preload.js +5 -5
  21. package/cjs/renderer.d.ts +2 -2
  22. package/cjs/renderer.js +2 -2
  23. package/cjs/scripts/base-bridge.d.ts +95 -0
  24. package/cjs/scripts/base-bridge.js +128 -0
  25. package/cjs/scripts/bridge.d.ts +3 -3
  26. package/cjs/scripts/bridge.js +51 -39
  27. package/cjs/scripts/helpers/env.d.ts +19 -0
  28. package/cjs/scripts/helpers/env.js +28 -0
  29. package/cjs/scripts/helpers/error-thrower.d.ts +3 -0
  30. package/cjs/scripts/helpers/error-thrower.js +8 -0
  31. package/cjs/scripts/helpers/errors.d.ts +12 -0
  32. package/cjs/scripts/helpers/errors.js +17 -0
  33. package/cjs/scripts/helpers/id.d.ts +9 -0
  34. package/cjs/scripts/helpers/id.js +14 -0
  35. package/cjs/scripts/helpers/index.d.ts +8 -0
  36. package/cjs/scripts/helpers/index.js +22 -0
  37. package/cjs/scripts/helpers/ipc-channel.d.ts +75 -0
  38. package/cjs/scripts/helpers/ipc-channel.js +78 -0
  39. package/cjs/scripts/helpers/ipc-event-in-main.d.ts +24 -0
  40. package/cjs/scripts/helpers/ipc-event-in-main.js +30 -0
  41. package/cjs/scripts/helpers/ipc-result.d.ts +26 -0
  42. package/cjs/scripts/helpers/ipc-result.js +48 -0
  43. package/cjs/scripts/helpers/main-event.d.ts +8 -0
  44. package/cjs/scripts/helpers/main-event.js +15 -0
  45. package/cjs/scripts/helpers/transfer.d.ts +33 -0
  46. package/cjs/scripts/helpers/transfer.js +57 -0
  47. package/cjs/scripts/helpers/web-contents-container.d.ts +12 -0
  48. package/cjs/scripts/helpers/web-contents-container.js +34 -0
  49. package/cjs/scripts/helpers/web-contents-events-container.d.ts +56 -0
  50. package/cjs/scripts/helpers/web-contents-events-container.js +81 -0
  51. package/cjs/scripts/main/publish.d.ts +36 -0
  52. package/cjs/scripts/main/publish.js +186 -0
  53. package/cjs/scripts/preload/bridge.d.ts +27 -0
  54. package/cjs/scripts/preload/bridge.js +85 -0
  55. package/cjs/scripts/preload/provider.d.ts +7 -0
  56. package/cjs/scripts/preload/provider.js +89 -0
  57. package/cjs/scripts/preload-bridge.d.ts +20 -0
  58. package/cjs/scripts/preload-bridge.js +76 -0
  59. package/cjs/scripts/preload-provider.js +37 -53
  60. package/cjs/scripts/provider.d.ts +17 -15
  61. package/cjs/scripts/provider.js +70 -91
  62. package/cjs/scripts/publish.d.ts +19 -18
  63. package/cjs/scripts/publish.js +97 -175
  64. package/cjs/scripts/renderer/bridge.d.ts +6 -0
  65. package/cjs/scripts/renderer/bridge.js +74 -0
  66. package/cjs/scripts/renderer/tunnels.d.ts +171 -0
  67. package/cjs/scripts/renderer/tunnels.js +205 -0
  68. package/cjs/scripts/renderer-tunnels.d.ts +19 -21
  69. package/cjs/scripts/renderer-tunnels.js +53 -58
  70. package/cjs/types.d.ts +189 -64
  71. package/esm/entries/index.d.ts +1 -0
  72. package/esm/entries/index.js +5 -0
  73. package/esm/entries/main.d.ts +2 -0
  74. package/esm/entries/main.js +5 -0
  75. package/esm/entries/preload.d.ts +3 -0
  76. package/esm/entries/preload.js +7 -0
  77. package/esm/entries/renderer.d.ts +2 -0
  78. package/esm/entries/renderer.js +6 -0
  79. package/esm/enums.d.ts +5 -14
  80. package/esm/enums.js +11 -22
  81. package/esm/errors.d.ts +42 -10
  82. package/esm/errors.js +69 -16
  83. package/esm/helpers.d.ts +41 -0
  84. package/esm/helpers.js +96 -0
  85. package/esm/index.d.ts +4 -4
  86. package/esm/index.js +3 -3
  87. package/esm/main.d.ts +2 -4
  88. package/esm/main.js +1 -3
  89. package/esm/preload.d.ts +3 -3
  90. package/esm/preload.js +2 -2
  91. package/esm/renderer.d.ts +2 -2
  92. package/esm/renderer.js +1 -1
  93. package/esm/scripts/base-bridge.d.ts +95 -0
  94. package/esm/scripts/base-bridge.js +125 -0
  95. package/esm/scripts/bridge.d.ts +3 -3
  96. package/esm/scripts/bridge.js +50 -38
  97. package/esm/scripts/helpers/electron-importer.d.ts +4 -0
  98. package/esm/scripts/helpers/electron-importer.js +16 -0
  99. package/esm/scripts/helpers/env.d.ts +19 -0
  100. package/esm/scripts/helpers/env.js +25 -0
  101. package/esm/scripts/helpers/error-thrower.d.ts +3 -0
  102. package/esm/scripts/helpers/error-thrower.js +5 -0
  103. package/esm/scripts/helpers/errors.d.ts +12 -0
  104. package/esm/scripts/helpers/errors.js +14 -0
  105. package/esm/scripts/helpers/id.d.ts +9 -0
  106. package/esm/scripts/helpers/id.js +11 -0
  107. package/esm/scripts/helpers/index.d.ts +8 -0
  108. package/esm/scripts/helpers/index.js +8 -0
  109. package/esm/scripts/helpers/ipc-channel.d.ts +75 -0
  110. package/esm/scripts/helpers/ipc-channel.js +76 -0
  111. package/esm/scripts/helpers/ipc-event-in-main.d.ts +24 -0
  112. package/esm/scripts/helpers/ipc-event-in-main.js +27 -0
  113. package/esm/scripts/helpers/ipc-result.d.ts +26 -0
  114. package/esm/scripts/helpers/ipc-result.js +42 -0
  115. package/esm/scripts/helpers/main-event.d.ts +8 -0
  116. package/esm/scripts/helpers/main-event.js +12 -0
  117. package/esm/scripts/helpers/transfer.d.ts +33 -0
  118. package/esm/scripts/helpers/transfer.js +54 -0
  119. package/esm/scripts/helpers/web-contents-container.d.ts +12 -0
  120. package/esm/scripts/helpers/web-contents-container.js +31 -0
  121. package/esm/scripts/helpers/web-contents-events-container.d.ts +56 -0
  122. package/esm/scripts/helpers/web-contents-events-container.js +78 -0
  123. package/esm/scripts/main/publish.d.ts +36 -0
  124. package/esm/scripts/main/publish.js +179 -0
  125. package/esm/scripts/main.d.ts +3 -3
  126. package/esm/scripts/main.js +43 -41
  127. package/esm/scripts/preload/bridge.d.ts +27 -0
  128. package/esm/scripts/preload/bridge.js +77 -0
  129. package/esm/scripts/preload/provider.d.ts +7 -0
  130. package/esm/scripts/preload/provider.js +84 -0
  131. package/esm/scripts/preload-bridge.d.ts +20 -0
  132. package/esm/scripts/preload-bridge.js +68 -0
  133. package/esm/scripts/preload-provider.js +35 -51
  134. package/esm/scripts/provider.d.ts +17 -15
  135. package/esm/scripts/provider.js +70 -91
  136. package/esm/scripts/publish.d.ts +19 -18
  137. package/esm/scripts/publish.js +89 -162
  138. package/esm/scripts/renderer/bridge.d.ts +6 -0
  139. package/esm/scripts/renderer/bridge.js +69 -0
  140. package/esm/scripts/renderer/tunnels.d.ts +171 -0
  141. package/esm/scripts/renderer/tunnels.js +203 -0
  142. package/esm/scripts/renderer-tunnels.d.ts +19 -21
  143. package/esm/scripts/renderer-tunnels.js +53 -55
  144. package/esm/types.d.ts +189 -64
  145. package/package.json +24 -41
  146. package/cjs/exp.d.ts +0 -4
  147. package/cjs/exp.js +0 -19
  148. package/cjs/scripts/main.d.ts +0 -8
  149. package/cjs/scripts/main.js +0 -72
  150. package/cjs/scripts/new-decorators.d.ts +0 -150
  151. package/cjs/scripts/new-decorators.js +0 -141
  152. package/cjs/scripts/old-decorators.d.ts +0 -185
  153. package/cjs/scripts/old-decorators.js +0 -132
  154. package/esm/exp.d.ts +0 -4
  155. package/esm/exp.js +0 -3
  156. package/esm/scripts/new-decorators.d.ts +0 -150
  157. package/esm/scripts/new-decorators.js +0 -132
  158. package/esm/scripts/old-decorators.d.ts +0 -185
  159. package/esm/scripts/old-decorators.js +0 -122
package/cjs/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
  }
@@ -0,0 +1 @@
1
+ export type { EventListener, EventUnsubscribe, HasSnapshotClass, IBridge, IHasSnapshot } from '../types.js';
@@ -0,0 +1,5 @@
1
+ /*
2
+ Главная точка входа.
3
+ Экспорт только типов потому что одновременный импорт для разных процессов приводит к ошибке.
4
+ */
5
+ export {};
@@ -0,0 +1,2 @@
1
+ export { emitEvent, on, once, publishFunction, publishVariable } from '../scripts/main/publish.js';
2
+ export * from './index.js';
@@ -0,0 +1,5 @@
1
+ /*
2
+ Экспорт для `main` процесса.
3
+ */
4
+ export { emitEvent, on, once, publishFunction, publishVariable } from '../scripts/main/publish.js';
5
+ export * from './index.js';
@@ -0,0 +1,3 @@
1
+ export { default as Bridge } from '../scripts/preload/bridge.js';
2
+ export { default as provideFromMain } from '../scripts/preload/provider.js';
3
+ export * from './index.js';
@@ -0,0 +1,7 @@
1
+ /*
2
+ Экспорт для `preload` процесса.
3
+ Нельзя объединить с `renderer` из-за ошибки импорта electron.
4
+ */
5
+ export { default as Bridge } from '../scripts/preload/bridge.js';
6
+ export { default as provideFromMain } from '../scripts/preload/provider.js';
7
+ export * from './index.js';
@@ -0,0 +1,2 @@
1
+ export { default as Bridge } from '../scripts/renderer/bridge.js';
2
+ export * from './index.js';
@@ -0,0 +1,6 @@
1
+ /*
2
+ Экспорт для `renderer` процесса.
3
+ Нельзя объединить с `preload` из-за ошибки импорта electron.
4
+ */
5
+ export { default as Bridge } from '../scripts/renderer/bridge.js';
6
+ export * from './index.js';
package/esm/enums.d.ts CHANGED
@@ -1,19 +1,10 @@
1
- export declare enum Access {
2
- get = "get",
3
- set = "set"
4
- }
5
- export declare enum Scope {
6
- renderer = "renderer",
7
- preload = "preload"
8
- }
9
- export declare enum IPCChannel {
1
+ export declare enum IpcChannel {
10
2
  getPublicInfo = "GET_PUBLIC_INFO",
11
3
  functionCall = "FUNCTION_CALL_",
12
- mainEventOn = "MAIN_EVENT_ON_",
13
- mainEventOnce = "MAIN_EVENT_ONCE_",
14
- mainEventEmit = "MAIN_EVENT_EMIT_",
4
+ eventOn = "EVENT_ON",
5
+ eventOnce = "EVENT_ONCE",
6
+ eventEmit = "EVENT_EMIT_",
15
7
  propertyGet = "PROPERTY_GET_",
16
8
  propertySet = "PROPERTY_SET_",
17
- promisePostfix = "_PROMISE",
18
- rendererEventEmit = "RENDERER_EMIT_"
9
+ promisePostfix = "_PROMISE"
19
10
  }
package/esm/enums.js CHANGED
@@ -1,22 +1,11 @@
1
- export var Access;
2
- (function (Access) {
3
- Access["get"] = "get";
4
- Access["set"] = "set";
5
- })(Access || (Access = {}));
6
- export var Scope;
7
- (function (Scope) {
8
- Scope["renderer"] = "renderer";
9
- Scope["preload"] = "preload";
10
- })(Scope || (Scope = {}));
11
- export var IPCChannel;
12
- (function (IPCChannel) {
13
- IPCChannel["getPublicInfo"] = "GET_PUBLIC_INFO";
14
- IPCChannel["functionCall"] = "FUNCTION_CALL_";
15
- IPCChannel["mainEventOn"] = "MAIN_EVENT_ON_";
16
- IPCChannel["mainEventOnce"] = "MAIN_EVENT_ONCE_";
17
- IPCChannel["mainEventEmit"] = "MAIN_EVENT_EMIT_";
18
- IPCChannel["propertyGet"] = "PROPERTY_GET_";
19
- IPCChannel["propertySet"] = "PROPERTY_SET_";
20
- IPCChannel["promisePostfix"] = "_PROMISE";
21
- IPCChannel["rendererEventEmit"] = "RENDERER_EMIT_";
22
- })(IPCChannel || (IPCChannel = {}));
1
+ export var IpcChannel;
2
+ (function (IpcChannel) {
3
+ IpcChannel["getPublicInfo"] = "GET_PUBLIC_INFO";
4
+ IpcChannel["functionCall"] = "FUNCTION_CALL_";
5
+ IpcChannel["eventOn"] = "EVENT_ON";
6
+ IpcChannel["eventOnce"] = "EVENT_ONCE";
7
+ IpcChannel["eventEmit"] = "EVENT_EMIT_";
8
+ IpcChannel["propertyGet"] = "PROPERTY_GET_";
9
+ IpcChannel["propertySet"] = "PROPERTY_SET_";
10
+ IpcChannel["promisePostfix"] = "_PROMISE";
11
+ })(IpcChannel || (IpcChannel = {}));
package/esm/errors.d.ts CHANGED
@@ -1,28 +1,60 @@
1
- import { Scope } from './enums';
2
- export declare class NoSetAccessError extends Error {
3
- constructor(name: string);
4
- }
1
+ /**
2
+ * Нет доступа к получению переменной.
3
+ */
5
4
  export declare class NoGetAccessError extends Error {
6
5
  constructor(name: string);
7
6
  }
8
- export declare class NotProvidedIntoScopeError extends Error {
9
- constructor(name: string, scope: Scope);
7
+ /**
8
+ * Нет публичных сущностей.
9
+ */
10
+ export declare class NotProvidedFromMainError extends Error {
11
+ constructor();
10
12
  }
11
- export declare class NotProvidedFromMain extends Error {
13
+ /**
14
+ * Публикация доступна только в main процессе.
15
+ */
16
+ export declare class PublishMethodsUnavailableError extends Error {
12
17
  constructor();
13
18
  }
19
+ /**
20
+ * Нет провайдера.
21
+ */
14
22
  export declare class GlobalProviderNotFoundError extends Error {
15
23
  constructor();
16
24
  }
25
+ /**
26
+ * Попытка установить свойство, доступное только для чтения.
27
+ */
17
28
  export declare class TrySetReadonlyError extends Error {
18
29
  constructor(name: string);
19
30
  }
20
- export declare class TryUseBridgeInPreload extends Error {
31
+ /**
32
+ * Использование неверного `Bridge` в preload процессе.
33
+ */
34
+ export declare class WrongBridgeInPreloadError extends Error {
35
+ constructor();
36
+ }
37
+ /**
38
+ * Использование неверного `Bridge` в renderer процессе.
39
+ */
40
+ export declare class WrongBridgeInRendererError extends Error {
41
+ constructor();
42
+ }
43
+ /**
44
+ * Попытка использовать `Bridge` в main процессе.
45
+ */
46
+ export declare class TryUseBridgeInMainError extends Error {
21
47
  constructor();
22
48
  }
23
- export declare class TryUseMainInRenderer extends Error {
49
+ /**
50
+ * Попытка добавить провайдер в main процессе.
51
+ */
52
+ export declare class TryProvideInMainError extends Error {
24
53
  constructor();
25
54
  }
26
- export declare class TryUseMainInMain extends Error {
55
+ /**
56
+ * Попытка добавить провайдер в renderer процессе.
57
+ */
58
+ export declare class TryProvideInRendererError extends Error {
27
59
  constructor();
28
60
  }
package/esm/errors.js CHANGED
@@ -1,27 +1,80 @@
1
- export class NoSetAccessError extends Error {
2
- constructor(name) { super(`No access to setting '${name}'`); }
3
- }
1
+ /**
2
+ * Нет доступа к получению переменной.
3
+ */
4
4
  export class NoGetAccessError extends Error {
5
- constructor(name) { super(`No access to getting '${name}'`); }
5
+ constructor(name) {
6
+ super(`Нет доступа к получению '${name}'.`);
7
+ }
6
8
  }
7
- export class NotProvidedIntoScopeError extends Error {
8
- constructor(name, scope) { super(`'${name}' is not provided into ${scope} scope`); }
9
+ /**
10
+ * Нет публичных сущностей.
11
+ */
12
+ export class NotProvidedFromMainError extends Error {
13
+ constructor() {
14
+ super('Публичные сущности не найдены. Добавьте их в main процессе.');
15
+ }
9
16
  }
10
- export class NotProvidedFromMain extends Error {
11
- constructor() { super('Public methods from main is not provided. Call any publish methods to provide it from main process.'); }
17
+ /**
18
+ * Публикация доступна только в main процессе.
19
+ */
20
+ export class PublishMethodsUnavailableError extends Error {
21
+ constructor() {
22
+ super('Публикация доступна только в main процессе.');
23
+ }
12
24
  }
25
+ /**
26
+ * Нет провайдера.
27
+ */
13
28
  export class GlobalProviderNotFoundError extends Error {
14
- constructor() { super('Required methods not provided. Call "provideFromMain" in preload process.'); }
29
+ constructor() {
30
+ super('Провайдер не найден. Вызовите "provideFromMain" в preload процессе.');
31
+ }
15
32
  }
33
+ /**
34
+ * Попытка установить свойство, доступное только для чтения.
35
+ */
16
36
  export class TrySetReadonlyError extends Error {
17
- constructor(name) { super(`'${name}' is readonly`); }
37
+ constructor(name) {
38
+ super(`'${name}' доступно только для чтения.`);
39
+ }
40
+ }
41
+ /**
42
+ * Использование неверного `Bridge` в preload процессе.
43
+ */
44
+ export class WrongBridgeInPreloadError extends Error {
45
+ constructor() {
46
+ super('Попытка использовать в preload процессе "Bridge" для renderer процесса. Проверьте импорт.');
47
+ }
48
+ }
49
+ /**
50
+ * Использование неверного `Bridge` в renderer процессе.
51
+ */
52
+ export class WrongBridgeInRendererError extends Error {
53
+ constructor() {
54
+ super('Попытка использовать в renderer процессе "Bridge" для preload процесса. Проверьте импорт.');
55
+ }
18
56
  }
19
- export class TryUseBridgeInPreload extends Error {
20
- constructor() { super('"Bridge" is unavailable in main process. In preload use "Main" instead.'); }
57
+ /**
58
+ * Попытка использовать `Bridge` в main процессе.
59
+ */
60
+ export class TryUseBridgeInMainError extends Error {
61
+ constructor() {
62
+ super('"Bridge" недоступен в main процессе.');
63
+ }
21
64
  }
22
- export class TryUseMainInRenderer extends Error {
23
- constructor() { super('"Main" is unavailable in renderer process. Use "Bridge" instead'); }
65
+ /**
66
+ * Попытка добавить провайдер в main процессе.
67
+ */
68
+ export class TryProvideInMainError extends Error {
69
+ constructor() {
70
+ super('"provideFromMain" недоступен в main процессе.');
71
+ }
24
72
  }
25
- export class TryUseMainInMain extends Error {
26
- constructor() { super('"Main" is unavailable in main process.'); }
73
+ /**
74
+ * Попытка добавить провайдер в renderer процессе.
75
+ */
76
+ export class TryProvideInRendererError extends Error {
77
+ constructor() {
78
+ super('"provideFromMain" недоступен в renderer процессе.');
79
+ }
27
80
  }
@@ -0,0 +1,41 @@
1
+ import { IpcMainEvent, WebContents } from 'electron';
2
+ import { IResult } from './types';
3
+ export declare class WebContentsContainer {
4
+ private container;
5
+ addOn(event: string, sender: WebContents): void;
6
+ addOnce(event: string, sender: WebContents): void;
7
+ getOn(event: string): WebContents[];
8
+ getOnce(event: string): WebContents[];
9
+ getAll(event: string): WebContents[];
10
+ clearOnce(event: string): void;
11
+ private addEvent;
12
+ private getEvent;
13
+ }
14
+ export declare class IpcResult {
15
+ static withPromise(promiseChannel: string): IResult;
16
+ static withValue(value: any, id?: string): IResult;
17
+ static withError(error?: Error | string, id?: string): IResult;
18
+ }
19
+ export declare class MainEvent {
20
+ private event;
21
+ constructor(event: IpcMainEvent);
22
+ send(channel: string, result: IResult): void;
23
+ return(value: any): void;
24
+ }
25
+ export declare class Id {
26
+ static generate(): string;
27
+ }
28
+ export declare class ErrorThrower {
29
+ static throws<TClass extends new (...args: TArgs) => InstanceType<TClass>, TArgs extends any[]>(errorClass: TClass, ...args: TArgs): () => never;
30
+ }
31
+ export declare class Env {
32
+ static readonly global: {
33
+ readonly hasWindow: boolean;
34
+ readonly hasProvider: boolean;
35
+ };
36
+ static readonly electron: {
37
+ readonly hasIpcRenderer: boolean;
38
+ readonly hasIpcMain: boolean;
39
+ readonly hasContextBridge: boolean;
40
+ };
41
+ }