/
webviewMessages.ts
537 lines (453 loc) · 13.9 KB
/
webviewMessages.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import type { RenderOutputType } from 'vs/workbench/contrib/notebook/browser/notebookBrowser';
import type { PreloadOptions, RenderOptions } from 'vs/workbench/contrib/notebook/browser/view/renderers/webviewPreloads';
import { NotebookCellMetadata } from 'vs/workbench/contrib/notebook/common/notebookCommon';
interface BaseToWebviewMessage {
readonly __vscode_notebook_message: true;
}
export interface WebviewInitialized extends BaseToWebviewMessage {
readonly type: 'initialized';
}
export interface DimensionUpdate {
readonly id: string;
readonly init?: boolean;
readonly height: number;
readonly isOutput?: boolean;
}
export interface IDimensionMessage extends BaseToWebviewMessage {
readonly type: 'dimension';
readonly updates: readonly DimensionUpdate[];
}
export interface IMouseEnterMessage extends BaseToWebviewMessage {
readonly type: 'mouseenter';
readonly id: string;
}
export interface IMouseLeaveMessage extends BaseToWebviewMessage {
readonly type: 'mouseleave';
readonly id: string;
}
export interface IOutputFocusMessage extends BaseToWebviewMessage {
readonly type: 'outputFocus';
readonly id: string;
}
export interface IOutputBlurMessage extends BaseToWebviewMessage {
readonly type: 'outputBlur';
readonly id: string;
}
export interface IScrollToRevealMessage extends BaseToWebviewMessage {
readonly type: 'scroll-to-reveal';
readonly scrollTop: number;
}
export interface IWheelMessage extends BaseToWebviewMessage {
readonly type: 'did-scroll-wheel';
readonly payload: any;
}
export interface IScrollAckMessage extends BaseToWebviewMessage {
readonly type: 'scroll-ack';
readonly data: { top: number };
readonly version: number;
}
export interface IBlurOutputMessage extends BaseToWebviewMessage {
readonly type: 'focus-editor';
readonly cellId: string;
readonly focusNext?: boolean;
}
export interface IClickedDataUrlMessage extends BaseToWebviewMessage {
readonly type: 'clicked-data-url';
readonly data: string | ArrayBuffer | null;
readonly downloadName?: string;
}
export interface IClickMarkupCellMessage extends BaseToWebviewMessage {
readonly type: 'clickMarkupCell';
readonly cellId: string;
readonly ctrlKey: boolean;
readonly altKey: boolean;
readonly metaKey: boolean;
readonly shiftKey: boolean;
}
export interface IClickedLinkMessage extends BaseToWebviewMessage {
readonly type: 'clicked-link';
readonly href: string;
}
export interface IContextMenuMarkupCellMessage extends BaseToWebviewMessage {
readonly type: 'contextMenuMarkupCell';
readonly cellId: string;
readonly clientX: number;
readonly clientY: number;
}
export interface IMouseEnterMarkupCellMessage extends BaseToWebviewMessage {
readonly type: 'mouseEnterMarkupCell';
readonly cellId: string;
}
export interface IMouseLeaveMarkupCellMessage extends BaseToWebviewMessage {
readonly type: 'mouseLeaveMarkupCell';
readonly cellId: string;
}
export interface IToggleMarkupPreviewMessage extends BaseToWebviewMessage {
readonly type: 'toggleMarkupPreview';
readonly cellId: string;
}
export interface ICellDragStartMessage extends BaseToWebviewMessage {
readonly type: 'cell-drag-start';
readonly cellId: string;
readonly dragOffsetY: number;
}
export interface ICellDragMessage extends BaseToWebviewMessage {
readonly type: 'cell-drag';
readonly cellId: string;
readonly dragOffsetY: number;
}
export interface ICellDropMessage extends BaseToWebviewMessage {
readonly type: 'cell-drop';
readonly cellId: string;
readonly ctrlKey: boolean;
readonly altKey: boolean;
readonly dragOffsetY: number;
}
export interface ICellDragEndMessage extends BaseToWebviewMessage {
readonly type: 'cell-drag-end';
readonly cellId: string;
}
export interface IInitializedMarkupMessage extends BaseToWebviewMessage {
readonly type: 'initializedMarkup';
readonly requestId: string;
}
export interface ICodeBlockHighlightRequest {
readonly id: string;
readonly value: string;
readonly lang: string;
}
export interface IRenderedMarkupMessage extends BaseToWebviewMessage {
readonly type: 'renderedMarkup';
readonly cellId: string;
readonly html: string;
readonly codeBlocks: ReadonlyArray<ICodeBlockHighlightRequest>;
}
export interface IRenderedCellOutputMessage extends BaseToWebviewMessage {
readonly type: 'renderedCellOutput';
readonly codeBlocks: ReadonlyArray<ICodeBlockHighlightRequest>;
}
export interface IClearMessage {
readonly type: 'clear';
}
export interface IOutputRequestMetadata {
/**
* Additional attributes of a cell metadata.
*/
readonly custom?: { readonly [key: string]: unknown };
}
export interface IOutputRequestDto {
/**
* { mime_type: value }
*/
readonly data: { readonly [key: string]: unknown };
readonly metadata?: IOutputRequestMetadata;
readonly outputId: string;
}
export interface OutputItemEntry {
readonly mime: string;
readonly valueBytes: Uint8Array;
}
export type ICreationContent =
| { readonly type: RenderOutputType.Html; readonly htmlContent: string }
| { readonly type: RenderOutputType.Extension; readonly outputId: string; readonly metadata: unknown; readonly output: OutputItemEntry; readonly allOutputs: ReadonlyArray<{ readonly mime: string }> };
export interface ICreationRequestMessage {
readonly type: 'html';
readonly content: ICreationContent;
readonly cellId: string;
readonly outputId: string;
cellTop: number;
outputOffset: number;
readonly left: number;
readonly requiredPreloads: readonly IControllerPreload[];
readonly initiallyHidden?: boolean;
readonly rendererId?: string | undefined;
readonly executionId?: string | undefined;
readonly createOnIdle: boolean;
}
export interface IContentWidgetTopRequest {
readonly cellId: string;
readonly outputId: string;
readonly cellTop: number;
readonly outputOffset: number;
readonly forceDisplay: boolean;
}
export interface IMarkupCellScrollTops {
readonly id: string;
readonly top: number;
}
export interface IViewScrollTopRequestMessage {
readonly type: 'view-scroll';
readonly widgets: readonly IContentWidgetTopRequest[];
readonly markupCells: readonly IMarkupCellScrollTops[];
}
export interface IScrollRequestMessage {
readonly type: 'scroll';
readonly id: string;
readonly top: number;
readonly widgetTop?: number;
readonly version: number;
}
export interface IClearOutputRequestMessage {
readonly type: 'clearOutput';
readonly cellId: string;
readonly outputId: string;
readonly cellUri: string;
readonly rendererId: string | undefined;
}
export interface IHideOutputMessage {
readonly type: 'hideOutput';
readonly outputId: string;
readonly cellId: string;
}
export interface IShowOutputMessage {
readonly type: 'showOutput';
readonly cellId: string;
readonly outputId: string;
readonly cellTop: number;
readonly outputOffset: number;
readonly content?: ICreationContent;
}
export interface IFocusOutputMessage {
readonly type: 'focus-output';
readonly cellId: string;
}
export interface IAckOutputHeight {
readonly cellId: string;
readonly outputId: string;
readonly height: number;
}
export interface IAckOutputHeightMessage {
readonly type: 'ack-dimension';
readonly updates: readonly IAckOutputHeight[];
}
export interface IControllerPreload {
readonly originalUri: string;
readonly uri: string;
}
export interface IUpdateControllerPreloadsMessage {
readonly type: 'preload';
readonly resources: readonly IControllerPreload[];
}
export interface RendererMetadata {
readonly id: string;
readonly entrypoint: { readonly extends: string | undefined; readonly path: string };
readonly mimeTypes: readonly string[];
readonly messaging: boolean;
readonly isBuiltin: boolean;
}
export interface StaticPreloadMetadata {
readonly entrypoint: string;
}
export interface IUpdateRenderersMessage {
readonly type: 'updateRenderers';
readonly rendererData: readonly RendererMetadata[];
}
export interface IUpdateDecorationsMessage {
readonly type: 'decorations';
readonly cellId: string;
readonly addedClassNames: readonly string[];
readonly removedClassNames: readonly string[];
}
export interface ICustomKernelMessage extends BaseToWebviewMessage {
readonly type: 'customKernelMessage';
readonly message: unknown;
}
export interface ICustomRendererMessage extends BaseToWebviewMessage {
readonly type: 'customRendererMessage';
readonly rendererId: string;
readonly message: unknown;
}
export interface ICreateMarkupCellMessage {
readonly type: 'createMarkupCell';
readonly cell: IMarkupCellInitialization;
}
export interface IDeleteMarkupCellMessage {
readonly type: 'deleteMarkupCell';
readonly ids: readonly string[];
}
export interface IHideMarkupCellMessage {
readonly type: 'hideMarkupCells';
readonly ids: readonly string[];
}
export interface IUnhideMarkupCellMessage {
readonly type: 'unhideMarkupCells';
readonly ids: readonly string[];
}
export interface IShowMarkupCellMessage {
readonly type: 'showMarkupCell';
readonly id: string;
readonly handle: number;
readonly content: string | undefined;
readonly top: number;
readonly metadata: NotebookCellMetadata | undefined;
}
export interface IUpdateSelectedMarkupCellsMessage {
readonly type: 'updateSelectedMarkupCells';
readonly selectedCellIds: readonly string[];
}
export interface IMarkupCellInitialization {
mime: string;
cellId: string;
cellHandle: number;
content: string;
offset: number;
visible: boolean;
metadata: NotebookCellMetadata;
}
export interface IInitializeMarkupCells {
readonly type: 'initializeMarkup';
readonly cells: readonly IMarkupCellInitialization[];
readonly requestId: string;
}
export interface INotebookStylesMessage {
readonly type: 'notebookStyles';
readonly styles: {
readonly [key: string]: string;
};
}
export interface INotebookOptionsMessage {
readonly type: 'notebookOptions';
readonly options: PreloadOptions;
readonly renderOptions: RenderOptions;
}
export interface ITokenizedCodeBlockMessage {
readonly type: 'tokenizedCodeBlock';
readonly codeBlockId: string;
readonly html: string;
}
export interface ITokenizedStylesChangedMessage {
readonly type: 'tokenizedStylesChanged';
readonly css: string;
}
export interface IFindMessage {
readonly type: 'find';
readonly query: string;
readonly options: { wholeWord?: boolean; caseSensitive?: boolean; includeMarkup: boolean; includeOutput: boolean; shouldGetSearchPreviewInfo: boolean };
}
export interface IFindHighlightMessage {
readonly type: 'findHighlight';
readonly index: number;
}
export interface IFindUnHighlightMessage {
readonly type: 'findUnHighlight';
readonly index: number;
}
export interface IFindStopMessage {
readonly type: 'findStop';
}
export interface ISearchPreviewInfo {
line: string;
range: {
start: number;
end: number;
};
}
export interface IFindMatch {
readonly type: 'preview' | 'output';
readonly cellId: string;
readonly id: string;
readonly index: number;
readonly searchPreviewInfo?: ISearchPreviewInfo;
}
export interface IDidFindMessage extends BaseToWebviewMessage {
readonly type: 'didFind';
readonly matches: IFindMatch[];
}
export interface IDidFindHighlightMessage extends BaseToWebviewMessage {
readonly type: 'didFindHighlight';
readonly offset: number;
}
export interface IOutputResizedMessage extends BaseToWebviewMessage {
readonly type: 'outputResized';
readonly cellId: string;
}
export interface IGetOutputItemMessage extends BaseToWebviewMessage {
readonly type: 'getOutputItem';
readonly requestId: number;
readonly outputId: string;
readonly mime: string;
}
export interface IReturnOutputItemMessage {
readonly type: 'returnOutputItem';
readonly requestId: number;
readonly output: OutputItemEntry | undefined;
}
export interface ILogRendererDebugMessage extends BaseToWebviewMessage {
readonly type: 'logRendererDebugMessage';
readonly message: string;
readonly data?: Record<string, string>;
}
export interface IPerformanceMessage extends BaseToWebviewMessage {
readonly type: 'notebookPerformanceMessage';
readonly executionId: string;
readonly cellId: string;
readonly duration: number;
readonly rendererId: string;
}
export type FromWebviewMessage = WebviewInitialized |
IDimensionMessage |
IMouseEnterMessage |
IMouseLeaveMessage |
IOutputFocusMessage |
IOutputBlurMessage |
IScrollToRevealMessage |
IWheelMessage |
IScrollAckMessage |
IBlurOutputMessage |
ICustomKernelMessage |
ICustomRendererMessage |
IClickedDataUrlMessage |
IClickMarkupCellMessage |
IClickedLinkMessage |
IContextMenuMarkupCellMessage |
IMouseEnterMarkupCellMessage |
IMouseLeaveMarkupCellMessage |
IToggleMarkupPreviewMessage |
ICellDragStartMessage |
ICellDragMessage |
ICellDropMessage |
ICellDragEndMessage |
IInitializedMarkupMessage |
IRenderedMarkupMessage |
IRenderedCellOutputMessage |
IDidFindMessage |
IDidFindHighlightMessage |
IOutputResizedMessage |
IGetOutputItemMessage |
ILogRendererDebugMessage |
IPerformanceMessage;
export type ToWebviewMessage = IClearMessage |
IFocusOutputMessage |
IAckOutputHeightMessage |
ICreationRequestMessage |
IViewScrollTopRequestMessage |
IScrollRequestMessage |
IClearOutputRequestMessage |
IHideOutputMessage |
IShowOutputMessage |
IUpdateControllerPreloadsMessage |
IUpdateRenderersMessage |
IUpdateDecorationsMessage |
ICustomKernelMessage |
ICustomRendererMessage |
ICreateMarkupCellMessage |
IDeleteMarkupCellMessage |
IShowMarkupCellMessage |
IHideMarkupCellMessage |
IUnhideMarkupCellMessage |
IUpdateSelectedMarkupCellsMessage |
IInitializeMarkupCells |
INotebookStylesMessage |
INotebookOptionsMessage |
ITokenizedCodeBlockMessage |
ITokenizedStylesChangedMessage |
IFindMessage |
IFindHighlightMessage |
IFindUnHighlightMessage |
IFindStopMessage |
IReturnOutputItemMessage;
export type AnyMessage = FromWebviewMessage | ToWebviewMessage;