@xterm/xterm 6.1.0-beta.24 → 6.1.0-beta.240

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 (162) hide show
  1. package/README.md +62 -38
  2. package/css/xterm.css +29 -22
  3. package/lib/xterm.js +1 -1
  4. package/lib/xterm.js.map +1 -1
  5. package/lib/xterm.mjs +8 -34
  6. package/lib/xterm.mjs.map +4 -4
  7. package/package.json +25 -22
  8. package/src/browser/AccessibilityManager.ts +11 -6
  9. package/src/browser/Clipboard.ts +6 -3
  10. package/src/browser/CoreBrowserTerminal.ts +149 -319
  11. package/src/browser/Dom.ts +178 -0
  12. package/src/browser/Linkifier.ts +11 -11
  13. package/src/browser/OscLinkProvider.ts +82 -14
  14. package/src/browser/RenderDebouncer.ts +2 -2
  15. package/src/browser/TimeBasedDebouncer.ts +2 -2
  16. package/src/browser/Types.ts +12 -11
  17. package/src/browser/Viewport.ts +55 -20
  18. package/src/browser/decorations/BufferDecorationRenderer.ts +1 -1
  19. package/src/browser/decorations/OverviewRulerRenderer.ts +33 -17
  20. package/src/browser/input/CompositionHelper.ts +44 -8
  21. package/src/browser/public/Terminal.ts +25 -28
  22. package/src/browser/renderer/dom/DomRenderer.ts +242 -76
  23. package/src/browser/renderer/dom/DomRendererRowFactory.ts +19 -13
  24. package/src/browser/renderer/dom/WidthCache.ts +54 -52
  25. package/src/browser/renderer/shared/Constants.ts +7 -0
  26. package/src/browser/renderer/shared/TextBlinkStateManager.ts +97 -0
  27. package/src/browser/renderer/shared/Types.ts +8 -2
  28. package/src/browser/scrollable/abstractScrollbar.ts +300 -0
  29. package/src/browser/scrollable/fastDomNode.ts +126 -0
  30. package/src/browser/scrollable/globalPointerMoveMonitor.ts +90 -0
  31. package/src/browser/scrollable/horizontalScrollbar.ts +85 -0
  32. package/src/browser/scrollable/mouseEvent.ts +292 -0
  33. package/src/browser/scrollable/scrollable.ts +486 -0
  34. package/src/browser/scrollable/scrollableElement.ts +581 -0
  35. package/src/browser/scrollable/scrollableElementOptions.ts +161 -0
  36. package/src/browser/scrollable/scrollbarArrow.ts +110 -0
  37. package/src/browser/scrollable/scrollbarState.ts +246 -0
  38. package/src/browser/scrollable/scrollbarVisibilityController.ts +113 -0
  39. package/src/browser/scrollable/touch.ts +485 -0
  40. package/src/browser/scrollable/verticalScrollbar.ts +143 -0
  41. package/src/browser/scrollable/widget.ts +23 -0
  42. package/src/browser/services/CharSizeService.ts +2 -2
  43. package/src/browser/services/CoreBrowserService.ts +7 -5
  44. package/src/browser/services/KeyboardService.ts +67 -0
  45. package/src/browser/services/LinkProviderService.ts +1 -1
  46. package/src/browser/services/MouseCoordsService.ts +47 -0
  47. package/src/browser/services/MouseService.ts +518 -25
  48. package/src/browser/services/RenderService.ts +28 -16
  49. package/src/browser/services/SelectionService.ts +45 -39
  50. package/src/browser/services/Services.ts +40 -17
  51. package/src/browser/services/ThemeService.ts +2 -2
  52. package/src/common/Async.ts +141 -0
  53. package/src/common/CircularList.ts +2 -2
  54. package/src/common/Color.ts +8 -0
  55. package/src/common/CoreTerminal.ts +31 -21
  56. package/src/common/Event.ts +118 -0
  57. package/src/common/InputHandler.ts +283 -85
  58. package/src/common/Lifecycle.ts +113 -0
  59. package/src/common/Platform.ts +13 -3
  60. package/src/common/SortedList.ts +7 -3
  61. package/src/common/StringBuilder.ts +67 -0
  62. package/src/common/TaskQueue.ts +14 -5
  63. package/src/common/Types.ts +51 -31
  64. package/src/common/Version.ts +9 -0
  65. package/src/common/buffer/Buffer.ts +34 -19
  66. package/src/common/buffer/BufferLine.ts +133 -65
  67. package/src/common/buffer/BufferLineStringCache.ts +69 -0
  68. package/src/common/buffer/BufferSet.ts +11 -6
  69. package/src/common/buffer/CellData.ts +57 -0
  70. package/src/common/buffer/Marker.ts +2 -2
  71. package/src/common/buffer/Types.ts +6 -2
  72. package/src/common/data/EscapeSequences.ts +71 -70
  73. package/src/common/input/Keyboard.ts +14 -7
  74. package/src/common/input/KittyKeyboard.ts +526 -0
  75. package/src/common/input/Win32InputMode.ts +297 -0
  76. package/src/common/input/WriteBuffer.ts +69 -32
  77. package/src/common/input/XParseColor.ts +2 -2
  78. package/src/common/parser/ApcParser.ts +196 -0
  79. package/src/common/parser/Constants.ts +14 -4
  80. package/src/common/parser/DcsParser.ts +11 -12
  81. package/src/common/parser/EscapeSequenceParser.ts +205 -63
  82. package/src/common/parser/OscParser.ts +11 -12
  83. package/src/common/parser/Params.ts +27 -8
  84. package/src/common/parser/Types.ts +36 -2
  85. package/src/common/public/BufferLineApiView.ts +2 -2
  86. package/src/common/public/BufferNamespaceApi.ts +3 -3
  87. package/src/common/public/ParserApi.ts +3 -0
  88. package/src/common/services/BufferService.ts +14 -9
  89. package/src/common/services/CharsetService.ts +4 -0
  90. package/src/common/services/CoreService.ts +22 -9
  91. package/src/common/services/DecorationService.ts +258 -8
  92. package/src/common/services/LogService.ts +1 -31
  93. package/src/common/services/{CoreMouseService.ts → MouseStateService.ts} +21 -132
  94. package/src/common/services/OptionsService.ts +13 -4
  95. package/src/common/services/ServiceRegistry.ts +9 -7
  96. package/src/common/services/Services.ts +49 -40
  97. package/src/common/services/UnicodeService.ts +1 -1
  98. package/typings/xterm.d.ts +318 -34
  99. package/src/common/Clone.ts +0 -23
  100. package/src/common/TypedArrayUtils.ts +0 -17
  101. package/src/vs/base/browser/browser.ts +0 -141
  102. package/src/vs/base/browser/canIUse.ts +0 -49
  103. package/src/vs/base/browser/dom.ts +0 -2369
  104. package/src/vs/base/browser/fastDomNode.ts +0 -316
  105. package/src/vs/base/browser/globalPointerMoveMonitor.ts +0 -112
  106. package/src/vs/base/browser/iframe.ts +0 -135
  107. package/src/vs/base/browser/keyboardEvent.ts +0 -213
  108. package/src/vs/base/browser/mouseEvent.ts +0 -229
  109. package/src/vs/base/browser/touch.ts +0 -372
  110. package/src/vs/base/browser/ui/scrollbar/abstractScrollbar.ts +0 -303
  111. package/src/vs/base/browser/ui/scrollbar/horizontalScrollbar.ts +0 -114
  112. package/src/vs/base/browser/ui/scrollbar/scrollableElement.ts +0 -720
  113. package/src/vs/base/browser/ui/scrollbar/scrollableElementOptions.ts +0 -165
  114. package/src/vs/base/browser/ui/scrollbar/scrollbarArrow.ts +0 -114
  115. package/src/vs/base/browser/ui/scrollbar/scrollbarState.ts +0 -243
  116. package/src/vs/base/browser/ui/scrollbar/scrollbarVisibilityController.ts +0 -118
  117. package/src/vs/base/browser/ui/scrollbar/verticalScrollbar.ts +0 -116
  118. package/src/vs/base/browser/ui/widget.ts +0 -57
  119. package/src/vs/base/browser/window.ts +0 -14
  120. package/src/vs/base/common/arrays.ts +0 -887
  121. package/src/vs/base/common/arraysFind.ts +0 -202
  122. package/src/vs/base/common/assert.ts +0 -71
  123. package/src/vs/base/common/async.ts +0 -1992
  124. package/src/vs/base/common/cancellation.ts +0 -148
  125. package/src/vs/base/common/charCode.ts +0 -450
  126. package/src/vs/base/common/collections.ts +0 -140
  127. package/src/vs/base/common/decorators.ts +0 -130
  128. package/src/vs/base/common/equals.ts +0 -146
  129. package/src/vs/base/common/errors.ts +0 -303
  130. package/src/vs/base/common/event.ts +0 -1778
  131. package/src/vs/base/common/functional.ts +0 -32
  132. package/src/vs/base/common/hash.ts +0 -316
  133. package/src/vs/base/common/iterator.ts +0 -159
  134. package/src/vs/base/common/keyCodes.ts +0 -526
  135. package/src/vs/base/common/keybindings.ts +0 -284
  136. package/src/vs/base/common/lazy.ts +0 -47
  137. package/src/vs/base/common/lifecycle.ts +0 -801
  138. package/src/vs/base/common/linkedList.ts +0 -142
  139. package/src/vs/base/common/map.ts +0 -202
  140. package/src/vs/base/common/numbers.ts +0 -98
  141. package/src/vs/base/common/observable.ts +0 -76
  142. package/src/vs/base/common/observableInternal/api.ts +0 -31
  143. package/src/vs/base/common/observableInternal/autorun.ts +0 -281
  144. package/src/vs/base/common/observableInternal/base.ts +0 -489
  145. package/src/vs/base/common/observableInternal/debugName.ts +0 -145
  146. package/src/vs/base/common/observableInternal/derived.ts +0 -428
  147. package/src/vs/base/common/observableInternal/lazyObservableValue.ts +0 -146
  148. package/src/vs/base/common/observableInternal/logging.ts +0 -328
  149. package/src/vs/base/common/observableInternal/promise.ts +0 -209
  150. package/src/vs/base/common/observableInternal/utils.ts +0 -610
  151. package/src/vs/base/common/platform.ts +0 -281
  152. package/src/vs/base/common/scrollable.ts +0 -522
  153. package/src/vs/base/common/sequence.ts +0 -34
  154. package/src/vs/base/common/stopwatch.ts +0 -43
  155. package/src/vs/base/common/strings.ts +0 -557
  156. package/src/vs/base/common/symbols.ts +0 -9
  157. package/src/vs/base/common/uint.ts +0 -59
  158. package/src/vs/patches/nls.ts +0 -90
  159. package/src/vs/typings/base-common.d.ts +0 -20
  160. package/src/vs/typings/require.d.ts +0 -42
  161. package/src/vs/typings/vscode-globals-nls.d.ts +0 -36
  162. package/src/vs/typings/vscode-globals-product.d.ts +0 -33
@@ -1,328 +0,0 @@
1
- /*---------------------------------------------------------------------------------------------
2
- * Copyright (c) Microsoft Corporation. All rights reserved.
3
- * Licensed under the MIT License. See License.txt in the project root for license information.
4
- *--------------------------------------------------------------------------------------------*/
5
-
6
- import { AutorunObserver } from 'vs/base/common/observableInternal/autorun';
7
- import { IObservable, ObservableValue, TransactionImpl } from 'vs/base/common/observableInternal/base';
8
- import { Derived } from 'vs/base/common/observableInternal/derived';
9
- import { FromEventObservable } from 'vs/base/common/observableInternal/utils';
10
-
11
- let globalObservableLogger: IObservableLogger | undefined;
12
-
13
- export function setLogger(logger: IObservableLogger): void {
14
- globalObservableLogger = logger;
15
- }
16
-
17
- export function getLogger(): IObservableLogger | undefined {
18
- return globalObservableLogger;
19
- }
20
-
21
- interface IChangeInformation {
22
- oldValue: unknown;
23
- newValue: unknown;
24
- change: unknown;
25
- didChange: boolean;
26
- hadValue: boolean;
27
- }
28
-
29
- export interface IObservableLogger {
30
- handleObservableChanged(observable: ObservableValue<any, any>, info: IChangeInformation): void;
31
- handleFromEventObservableTriggered(observable: FromEventObservable<any, any>, info: IChangeInformation): void;
32
-
33
- handleAutorunCreated(autorun: AutorunObserver): void;
34
- handleAutorunTriggered(autorun: AutorunObserver): void;
35
- handleAutorunFinished(autorun: AutorunObserver): void;
36
-
37
- handleDerivedCreated(observable: Derived<any>): void;
38
- handleDerivedRecomputed(observable: Derived<any>, info: IChangeInformation): void;
39
-
40
- handleBeginTransaction(transaction: TransactionImpl): void;
41
- handleEndTransaction(): void;
42
- }
43
-
44
- export class ConsoleObservableLogger implements IObservableLogger {
45
- private indentation = 0;
46
-
47
- private textToConsoleArgs(text: ConsoleText): unknown[] {
48
- return consoleTextToArgs([
49
- normalText(repeat('| ', this.indentation)),
50
- text,
51
- ]);
52
- }
53
-
54
- private formatInfo(info: IChangeInformation): ConsoleText[] {
55
- if (!info.hadValue) {
56
- return [
57
- normalText(` `),
58
- styled(formatValue(info.newValue, 60), {
59
- color: 'green',
60
- }),
61
- normalText(` (initial)`),
62
- ];
63
- }
64
- return info.didChange
65
- ? [
66
- normalText(` `),
67
- styled(formatValue(info.oldValue, 70), {
68
- color: 'red',
69
- strikeThrough: true,
70
- }),
71
- normalText(` `),
72
- styled(formatValue(info.newValue, 60), {
73
- color: 'green',
74
- }),
75
- ]
76
- : [normalText(` (unchanged)`)];
77
- }
78
-
79
- handleObservableChanged(observable: IObservable<unknown, unknown>, info: IChangeInformation): void {
80
- console.log(...this.textToConsoleArgs([
81
- formatKind('observable value changed'),
82
- styled(observable.debugName, { color: 'BlueViolet' }),
83
- ...this.formatInfo(info),
84
- ]));
85
- }
86
-
87
- private readonly changedObservablesSets = new WeakMap<object, Set<IObservable<any, any>>>();
88
-
89
- formatChanges(changes: Set<IObservable<any, any>>): ConsoleText | undefined {
90
- if (changes.size === 0) {
91
- return undefined;
92
- }
93
- return styled(
94
- ' (changed deps: ' +
95
- [...changes].map((o) => o.debugName).join(', ') +
96
- ')',
97
- { color: 'gray' }
98
- );
99
- }
100
-
101
- handleDerivedCreated(derived: Derived<unknown>): void {
102
- const existingHandleChange = derived.handleChange;
103
- this.changedObservablesSets.set(derived, new Set());
104
- derived.handleChange = (observable, change) => {
105
- this.changedObservablesSets.get(derived)!.add(observable);
106
- return existingHandleChange.apply(derived, [observable, change]);
107
- };
108
- }
109
-
110
- handleDerivedRecomputed(derived: Derived<unknown>, info: IChangeInformation): void {
111
- const changedObservables = this.changedObservablesSets.get(derived)!;
112
- console.log(...this.textToConsoleArgs([
113
- formatKind('derived recomputed'),
114
- styled(derived.debugName, { color: 'BlueViolet' }),
115
- ...this.formatInfo(info),
116
- this.formatChanges(changedObservables),
117
- { data: [{ fn: derived._debugNameData.referenceFn ?? derived._computeFn }] }
118
- ]));
119
- changedObservables.clear();
120
- }
121
-
122
- handleFromEventObservableTriggered(observable: FromEventObservable<any, any>, info: IChangeInformation): void {
123
- console.log(...this.textToConsoleArgs([
124
- formatKind('observable from event triggered'),
125
- styled(observable.debugName, { color: 'BlueViolet' }),
126
- ...this.formatInfo(info),
127
- { data: [{ fn: observable._getValue }] }
128
- ]));
129
- }
130
-
131
- handleAutorunCreated(autorun: AutorunObserver): void {
132
- const existingHandleChange = autorun.handleChange;
133
- this.changedObservablesSets.set(autorun, new Set());
134
- autorun.handleChange = (observable, change) => {
135
- this.changedObservablesSets.get(autorun)!.add(observable);
136
- return existingHandleChange.apply(autorun, [observable, change]);
137
- };
138
- }
139
-
140
- handleAutorunTriggered(autorun: AutorunObserver): void {
141
- const changedObservables = this.changedObservablesSets.get(autorun)!;
142
- console.log(...this.textToConsoleArgs([
143
- formatKind('autorun'),
144
- styled(autorun.debugName, { color: 'BlueViolet' }),
145
- this.formatChanges(changedObservables),
146
- { data: [{ fn: autorun._debugNameData.referenceFn ?? autorun._runFn }] }
147
- ]));
148
- changedObservables.clear();
149
- this.indentation++;
150
- }
151
-
152
- handleAutorunFinished(autorun: AutorunObserver): void {
153
- this.indentation--;
154
- }
155
-
156
- handleBeginTransaction(transaction: TransactionImpl): void {
157
- let transactionName = transaction.getDebugName();
158
- if (transactionName === undefined) {
159
- transactionName = '';
160
- }
161
- console.log(...this.textToConsoleArgs([
162
- formatKind('transaction'),
163
- styled(transactionName, { color: 'BlueViolet' }),
164
- { data: [{ fn: transaction._fn }] }
165
- ]));
166
- this.indentation++;
167
- }
168
-
169
- handleEndTransaction(): void {
170
- this.indentation--;
171
- }
172
- }
173
-
174
- type ConsoleText =
175
- | (ConsoleText | undefined)[]
176
- | { text: string; style: string; data?: unknown[] }
177
- | { data: unknown[] };
178
-
179
- function consoleTextToArgs(text: ConsoleText): unknown[] {
180
- const styles = new Array<any>();
181
- const data: unknown[] = [];
182
- let firstArg = '';
183
-
184
- function process(t: ConsoleText): void {
185
- if ('length' in t) {
186
- for (const item of t) {
187
- if (item) {
188
- process(item);
189
- }
190
- }
191
- } else if ('text' in t) {
192
- firstArg += `%c${t.text}`;
193
- styles.push(t.style);
194
- if (t.data) {
195
- data.push(...t.data);
196
- }
197
- } else if ('data' in t) {
198
- data.push(...t.data);
199
- }
200
- }
201
-
202
- process(text);
203
-
204
- const result = [firstArg, ...styles];
205
- result.push(...data);
206
- return result;
207
- }
208
-
209
- function normalText(text: string): ConsoleText {
210
- return styled(text, { color: 'black' });
211
- }
212
-
213
- function formatKind(kind: string): ConsoleText {
214
- return styled(padStr(`${kind}: `, 10), { color: 'black', bold: true });
215
- }
216
-
217
- function styled(
218
- text: string,
219
- options: { color: string; strikeThrough?: boolean; bold?: boolean } = {
220
- color: 'black',
221
- }
222
- ): ConsoleText {
223
- function objToCss(styleObj: Record<string, string>): string {
224
- return Object.entries(styleObj).reduce(
225
- (styleString, [propName, propValue]) => {
226
- return `${styleString}${propName}:${propValue};`;
227
- },
228
- ''
229
- );
230
- }
231
-
232
- const style: Record<string, string> = {
233
- color: options.color,
234
- };
235
- if (options.strikeThrough) {
236
- style['text-decoration'] = 'line-through';
237
- }
238
- if (options.bold) {
239
- style['font-weight'] = 'bold';
240
- }
241
-
242
- return {
243
- text,
244
- style: objToCss(style),
245
- };
246
- }
247
-
248
- function formatValue(value: unknown, availableLen: number): string {
249
- switch (typeof value) {
250
- case 'number':
251
- return '' + value;
252
- case 'string':
253
- if (value.length + 2 <= availableLen) {
254
- return `"${value}"`;
255
- }
256
- return `"${value.substr(0, availableLen - 7)}"+...`;
257
-
258
- case 'boolean':
259
- return value ? 'true' : 'false';
260
- case 'undefined':
261
- return 'undefined';
262
- case 'object':
263
- if (value === null) {
264
- return 'null';
265
- }
266
- if (Array.isArray(value)) {
267
- return formatArray(value, availableLen);
268
- }
269
- return formatObject(value, availableLen);
270
- case 'symbol':
271
- return value.toString();
272
- case 'function':
273
- return `[[Function${value.name ? ' ' + value.name : ''}]]`;
274
- default:
275
- return '' + value;
276
- }
277
- }
278
-
279
- function formatArray(value: unknown[], availableLen: number): string {
280
- let result = '[ ';
281
- let first = true;
282
- for (const val of value) {
283
- if (!first) {
284
- result += ', ';
285
- }
286
- if (result.length - 5 > availableLen) {
287
- result += '...';
288
- break;
289
- }
290
- first = false;
291
- result += `${formatValue(val, availableLen - result.length)}`;
292
- }
293
- result += ' ]';
294
- return result;
295
- }
296
-
297
- function formatObject(value: object, availableLen: number): string {
298
- let result = '{ ';
299
- let first = true;
300
- for (const [key, val] of Object.entries(value)) {
301
- if (!first) {
302
- result += ', ';
303
- }
304
- if (result.length - 5 > availableLen) {
305
- result += '...';
306
- break;
307
- }
308
- first = false;
309
- result += `${key}: ${formatValue(val, availableLen - result.length)}`;
310
- }
311
- result += ' }';
312
- return result;
313
- }
314
-
315
- function repeat(str: string, count: number): string {
316
- let result = '';
317
- for (let i = 1; i <= count; i++) {
318
- result += str;
319
- }
320
- return result;
321
- }
322
-
323
- function padStr(str: string, length: number): string {
324
- while (str.length < length) {
325
- str += ' ';
326
- }
327
- return str;
328
- }
@@ -1,209 +0,0 @@
1
- /*---------------------------------------------------------------------------------------------
2
- * Copyright (c) Microsoft Corporation. All rights reserved.
3
- * Licensed under the MIT License. See License.txt in the project root for license information.
4
- *--------------------------------------------------------------------------------------------*/
5
- import { autorun } from 'vs/base/common/observableInternal/autorun';
6
- import { IObservable, IReader, observableValue, transaction } from './base';
7
- import { Derived, derived } from 'vs/base/common/observableInternal/derived';
8
- import { CancellationToken, CancellationTokenSource } from 'vs/base/common/cancellation';
9
- import { DebugNameData, DebugOwner } from 'vs/base/common/observableInternal/debugName';
10
- import { strictEquals } from 'vs/base/common/equals';
11
- import { CancellationError } from 'vs/base/common/errors';
12
-
13
- export class ObservableLazy<T> {
14
- private readonly _value = observableValue<T | undefined>(this, undefined);
15
-
16
- /**
17
- * The cached value.
18
- * Does not force a computation of the value.
19
- */
20
- public get cachedValue(): IObservable<T | undefined> { return this._value; }
21
-
22
- constructor(private readonly _computeValue: () => T) {
23
- }
24
-
25
- /**
26
- * Returns the cached value.
27
- * Computes the value if the value has not been cached yet.
28
- */
29
- public getValue() {
30
- let v = this._value.get();
31
- if (!v) {
32
- v = this._computeValue();
33
- this._value.set(v, undefined);
34
- }
35
- return v;
36
- }
37
- }
38
-
39
- /**
40
- * A promise whose state is observable.
41
- */
42
- export class ObservablePromise<T> {
43
- public static fromFn<T>(fn: () => Promise<T>): ObservablePromise<T> {
44
- return new ObservablePromise(fn());
45
- }
46
-
47
- private readonly _value = observableValue<PromiseResult<T> | undefined>(this, undefined);
48
-
49
- /**
50
- * The promise that this object wraps.
51
- */
52
- public readonly promise: Promise<T>;
53
-
54
- /**
55
- * The current state of the promise.
56
- * Is `undefined` if the promise didn't resolve yet.
57
- */
58
- public readonly promiseResult: IObservable<PromiseResult<T> | undefined> = this._value;
59
-
60
- constructor(promise: Promise<T>) {
61
- this.promise = promise.then(value => {
62
- transaction(tx => {
63
- /** @description onPromiseResolved */
64
- this._value.set(new PromiseResult(value, undefined), tx);
65
- });
66
- return value;
67
- }, error => {
68
- transaction(tx => {
69
- /** @description onPromiseRejected */
70
- this._value.set(new PromiseResult<T>(undefined, error), tx);
71
- });
72
- throw error;
73
- });
74
- }
75
- }
76
-
77
- export class PromiseResult<T> {
78
- constructor(
79
- /**
80
- * The value of the resolved promise.
81
- * Undefined if the promise rejected.
82
- */
83
- public readonly data: T | undefined,
84
-
85
- /**
86
- * The error in case of a rejected promise.
87
- * Undefined if the promise resolved.
88
- */
89
- public readonly error: unknown | undefined,
90
- ) {
91
- }
92
-
93
- /**
94
- * Returns the value if the promise resolved, otherwise throws the error.
95
- */
96
- public getDataOrThrow(): T {
97
- if (this.error) {
98
- throw this.error;
99
- }
100
- return this.data!;
101
- }
102
- }
103
-
104
- /**
105
- * A lazy promise whose state is observable.
106
- */
107
- export class ObservableLazyPromise<T> {
108
- private readonly _lazyValue = new ObservableLazy(() => new ObservablePromise(this._computePromise()));
109
-
110
- /**
111
- * Does not enforce evaluation of the promise compute function.
112
- * Is undefined if the promise has not been computed yet.
113
- */
114
- public readonly cachedPromiseResult = derived(this, reader => this._lazyValue.cachedValue.read(reader)?.promiseResult.read(reader));
115
-
116
- constructor(private readonly _computePromise: () => Promise<T>) {
117
- }
118
-
119
- public getPromise(): Promise<T> {
120
- return this._lazyValue.getValue().promise;
121
- }
122
- }
123
-
124
- /**
125
- * Resolves the promise when the observables state matches the predicate.
126
- */
127
- export function waitForState<T>(observable: IObservable<T | null | undefined>): Promise<T>;
128
- export function waitForState<T, TState extends T>(observable: IObservable<T>, predicate: (state: T) => state is TState, isError?: (state: T) => boolean | unknown | undefined, cancellationToken?: CancellationToken): Promise<TState>;
129
- export function waitForState<T>(observable: IObservable<T>, predicate: (state: T) => boolean, isError?: (state: T) => boolean | unknown | undefined, cancellationToken?: CancellationToken): Promise<T>;
130
- export function waitForState<T>(observable: IObservable<T>, predicate?: (state: T) => boolean, isError?: (state: T) => boolean | unknown | undefined, cancellationToken?: CancellationToken): Promise<T> {
131
- if (!predicate) {
132
- predicate = state => state !== null && state !== undefined;
133
- }
134
- return new Promise((resolve, reject) => {
135
- let isImmediateRun = true;
136
- let shouldDispose = false;
137
- const stateObs = observable.map(state => {
138
- /** @description waitForState.state */
139
- return {
140
- isFinished: predicate(state),
141
- error: isError ? isError(state) : false,
142
- state
143
- };
144
- });
145
- const d = autorun(reader => {
146
- /** @description waitForState */
147
- const { isFinished, error, state } = stateObs.read(reader);
148
- if (isFinished || error) {
149
- if (isImmediateRun) {
150
- // The variable `d` is not initialized yet
151
- shouldDispose = true;
152
- } else {
153
- d.dispose();
154
- }
155
- if (error) {
156
- reject(error === true ? state : error);
157
- } else {
158
- resolve(state);
159
- }
160
- }
161
- });
162
- if (cancellationToken) {
163
- const dc = cancellationToken.onCancellationRequested(() => {
164
- d.dispose();
165
- dc.dispose();
166
- reject(new CancellationError());
167
- });
168
- if (cancellationToken.isCancellationRequested) {
169
- d.dispose();
170
- dc.dispose();
171
- reject(new CancellationError());
172
- return;
173
- }
174
- }
175
- isImmediateRun = false;
176
- if (shouldDispose) {
177
- d.dispose();
178
- }
179
- });
180
- }
181
-
182
- export function derivedWithCancellationToken<T>(computeFn: (reader: IReader, cancellationToken: CancellationToken) => T): IObservable<T>;
183
- export function derivedWithCancellationToken<T>(owner: object, computeFn: (reader: IReader, cancellationToken: CancellationToken) => T): IObservable<T>;
184
- export function derivedWithCancellationToken<T>(computeFnOrOwner: ((reader: IReader, cancellationToken: CancellationToken) => T) | object, computeFnOrUndefined?: ((reader: IReader, cancellationToken: CancellationToken) => T)): IObservable<T> {
185
- let computeFn: (reader: IReader, store: CancellationToken) => T;
186
- let owner: DebugOwner;
187
- if (computeFnOrUndefined === undefined) {
188
- computeFn = computeFnOrOwner as any;
189
- owner = undefined;
190
- } else {
191
- owner = computeFnOrOwner;
192
- computeFn = computeFnOrUndefined as any;
193
- }
194
-
195
- let cancellationTokenSource: CancellationTokenSource | undefined = undefined;
196
- return new Derived(
197
- new DebugNameData(owner, undefined, computeFn),
198
- r => {
199
- if (cancellationTokenSource) {
200
- cancellationTokenSource.dispose(true);
201
- }
202
- cancellationTokenSource = new CancellationTokenSource();
203
- return computeFn(r, cancellationTokenSource.token);
204
- }, undefined,
205
- undefined,
206
- () => cancellationTokenSource?.dispose(),
207
- strictEquals,
208
- );
209
- }