@dao42/d42paas-front 0.7.53 → 0.7.57

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/editor.d.ts CHANGED
@@ -1,625 +1,678 @@
1
- /*!-----------------------------------------------------------
2
- * Copyright (c) dao42. All rights reserved.
3
- * Type definitions for @dao42/d42paas-front
4
- * Released under the MIT license
5
- *-----------------------------------------------------------*/
6
-
7
- import { Extend } from 'schema-utils/declarations/validate';
8
-
9
- /*---------------------------------------------------------------------------------------------
10
- * Copyright (c) Microsoft Corporation. All rights reserved.
11
- * Licensed under the MIT License. See License.txt in the project root for license information.
12
- *--------------------------------------------------------------------------------------------*/
13
-
14
- export type ComponentType =
15
- | 'Page'
16
- | 'Tree'
17
- | 'Editor'
18
- | 'Console'
19
- | 'Browser'
20
- | 'Shell';
21
-
22
- export type Mode = 'tsdoc' | 'singleFile' | 'IDE';
23
-
24
- export type PlaygroundStatus = 'EMPTY' | 'ACTIVE' | 'INACTIVE';
25
-
26
- export type DockerStatus = 'RUNNING' | 'STOP';
27
-
28
- // export type Replay = 'stop' | 'disabled' | 'pause';
29
- interface MessageType {
30
- playgroundStatus?: PlaygroundStatus;
31
- dockerStatus?: DockerStatus;
32
- userList?: UserInfo[];
33
- followingUser?: UserInfo;
34
- usersFollowYou?: UserInfo[];
35
- }
36
-
37
- interface ErrorType {
38
- /**
39
- * The error message block
40
- */
41
- message: {
42
- /**
43
- * The error message content
44
- */
45
- content: string;
46
-
47
- /**
48
- * The error playground you started
49
- */
50
- playgroundId: string;
51
-
52
- /**
53
- * The error timestamp
54
- */
55
- timestamp: number;
56
- };
57
- }
58
-
59
- /**
60
- * Userinfo type
61
- */
62
- interface UserInfo {
63
- playgroundId?: string;
64
- operation?: any;
65
- uuid?: string;
66
- color?: string;
67
- name?: string;
68
- username?: string;
69
- userId?: string;
70
- role?: string;
71
- avatar?: string;
72
- onlineCount?: number;
73
- }
74
-
75
- // interface ReplayType {
76
- // /**
77
- // * The userId of the user who started the replay
78
- // */
79
- // userId?: UserInfo['userId'];
80
-
81
- // /**
82
- // * The timestamp of the replay
83
- // */
84
- // timestamp: number;
85
- // }
86
-
87
- export interface TreeProps {
88
- /**
89
- * The background color of the tree
90
- */
91
- bgColor?: string;
92
-
93
- /**
94
- * The text color of the tree
95
- */
96
- fontColor?: string;
97
-
98
- /**
99
- * The drop background color
100
- */
101
- dropBgColor?: string;
102
-
103
- /**
104
- * The drop Text color
105
- */
106
- dropTextColor?: string;
107
-
108
- /**
109
- * The hover background color
110
- */
111
- hoverBgColor?: string;
112
-
113
- /**
114
- * The hover Text color
115
- */
116
- hoverTextColor?: string;
117
-
118
- /**
119
- * The tree item will fire the event when you click on it
120
- *
121
- * @param The path of the item
122
- * @param The uri of the item
123
- * @event
124
- */
125
- onClick?: (arg: { path: string; uri: string }) => void;
126
- }
127
-
128
- export interface MenuTagProps {
129
- /**
130
- * The style of the menu tag block
131
- */
132
- menuStyle?: {
133
- /**
134
- * The background color
135
- */
136
- backgroundColor?: string;
137
-
138
- /**
139
- * The text color
140
- */
141
- textColor?: string;
142
-
143
- /**
144
- * The hover background color
145
- */
146
- hoverBgColor?: string;
147
-
148
- /**
149
- * The hover text color
150
- */
151
- hoverTextColor?: string;
152
-
153
- /**
154
- * The icon color
155
- */
156
- iconColor?: string;
157
-
158
- /**
159
- * The icon hover color
160
- */
161
- hoverIconColor?: string;
162
-
163
- /**
164
- * The menu tag height
165
- */
166
- height?: string;
167
- };
168
- }
169
-
170
- interface EditorProps extends MenuTagProps {
171
- /**
172
- * The Theme of the editor block
173
- */
174
- theme?: {
175
- /**
176
- * The color of the margin view overlay
177
- */
178
- marginViewOverlaysBgColor?: string;
179
-
180
- /**
181
- * The width of the margin view overlay
182
- */
183
- marginViewOverlaysWidth?: string;
184
-
185
- /**
186
- * The left position of the margin view overlay
187
- */
188
- marginViewOverlaysLeft?: string;
189
-
190
- /**
191
- * The line number color
192
- */
193
- lineNumbersColor?: string;
194
-
195
- /**
196
- * The line number with
197
- */
198
- lineNumbersWidth?: string;
199
-
200
- /**
201
- * The line number left
202
- */
203
- lineNumbersLeft?: string;
204
-
205
- /**
206
- * The active line number color
207
- */
208
- activeLineNumberColor?: string;
209
- };
210
- }
211
-
212
- export interface ConsoleOrShellProps {
213
- /**
214
- * The font size of the shell
215
- */
216
- fontSize?: number;
217
-
218
- /**
219
- * The font family of the shell
220
- */
221
- fontFamily?: string;
222
-
223
- /**
224
- * The line height of the shell
225
- */
226
- lineHeight?: number;
227
-
228
- /**
229
- * The cursor color of the shell
230
- */
231
- cursorBlink?: boolean;
232
-
233
- /**
234
- * The cursor width of the shell
235
- */
236
- cursorWidth?: number;
237
-
238
- /**
239
- * The cursor style of the shell
240
- */
241
- cursorStyle?: string;
242
-
243
- /**
244
- * if the shell can be right click to open the context menu
245
- */
246
- rightClickSelectsWord?: boolean;
247
-
248
- /**
249
- * The theme of the shell block
250
- */
251
- theme?: {
252
- /**
253
- * The background color
254
- */
255
- background?: string;
256
- };
257
- }
258
-
259
- export interface BrowserProps {
260
- /**
261
- * The url of the browser
262
- */
263
- url?: string;
264
-
265
- /**
266
- * if the browser can show the url
267
- */
268
- showURL?: boolean;
269
-
270
- /**
271
- * The fresh icon color
272
- */
273
- freshIconColor?: string;
274
-
275
- /**
276
- * The input text color
277
- */
278
- inputColor?: string;
279
-
280
- /**
281
- * The open icon color
282
- */
283
- openIconColor?: string;
284
- }
285
-
286
- /**
287
- * The Component props type collection
288
- */
289
- export type ComponentPropsType =
290
- | EditorProps
291
- | TreeProps
292
- | BrowserProps
293
- | ConsoleOrShellProps;
294
-
295
- /**
296
- * Passing the values to init the playground.
297
- * @category PaaS Options [Required]
298
- */
299
- export interface Options {
300
- /**
301
- * @ignore
302
- *
303
- */
304
- debug?: boolean;
305
-
306
- /**
307
- *
308
- * Error listener to the application.
309
- * @param The error message block
310
- * @event
311
- */
312
- onError?: (error: ErrorType) => void;
313
-
314
- /**
315
- *
316
- * Message listener to the application.
317
- * @param MessageType
318
- * @event
319
- */
320
- onMessage?: (message: MessageType) => void;
321
-
322
- /**
323
- * The service worker origin
324
- */
325
- serviceWorkerOrigin: string;
326
-
327
- /**
328
- *
329
- * init the playground with the mode.
330
- *
331
- */
332
- mode?: Mode;
333
-
334
- /**
335
- *
336
- * init the playground with the paasDomain.
337
- *
338
- */
339
- paasDomain: string;
340
-
341
- /**
342
- *
343
- * init the playground ticket needed.
344
- *
345
- */
346
- ticket: string;
347
-
348
- /**
349
- *
350
- * to init the playground with this id.
351
- *
352
- */
353
- playgroundId: string;
354
-
355
- /**
356
- *
357
- * userId for the playground.
358
- *
359
- */
360
- userId: string;
361
-
362
- /**
363
- *
364
- * tenantId for the playground.
365
- *
366
- */
367
- tenantId: string;
368
-
369
- /**
370
- *
371
- * username for the playground.
372
- *
373
- */
374
- username?: string;
375
-
376
- /**
377
- *
378
- * avatarUrl for the playground but not necessarily.
379
- *
380
- */
381
- avatarUrl?: string;
382
-
383
- /**
384
- *
385
- * this argument is to ingnore replaying patterns.
386
- *
387
- */
388
- ignoreReplayers?: string[];
389
-
390
- /**
391
- *
392
- * Here you can map the components to the playground.
393
- *
394
- * @category ComponentsMapper
395
- *
396
- */
397
- components?: Component<ComponentPropsType>[];
398
-
399
- /**
400
- * @deprecated to fix the issue of the playground.
401
- *
402
- * render?: () => TComponent[]; keyof D42_FrontType['CRDT'][]
403
- */
404
- }
405
-
406
- /**
407
- *
408
- * @interface Component
409
- * @desc The props of the component.
410
- *
411
- */
412
- export interface Component<T> {
413
- /**
414
- *
415
- * The DOM for the component.
416
- * @type {(string | HTMLElement | Element)}
417
- *
418
- */
419
- container: string | HTMLElement | Element;
420
-
421
- item: ComponentType;
422
- /**
423
- * The component props
424
- */
425
- props?: T;
426
- }
427
-
428
- /**
429
- * * This is the entry point for the application.
430
- *
431
- * * like:
432
- *
433
- *
434
- * ```ts
435
- let options = {...};
436
- let Dao = new DaoPaaS(options);
437
- ```
438
- *
439
- * See {@link Options} for more details.
440
- */
441
- export class DaoPaaS {
442
- constructor(options: Options);
443
-
444
- get playgroundStatus(): PlaygroundStatus;
445
-
446
- get dockerStatus(): DockerStatus;
447
-
448
- get userList(): UserInfo[];
449
-
450
- /**
451
- *
452
- * Replaying method for global calling.
453
- * @param {unFollowUser} args
454
- *
455
- */
456
-
457
- unFollowUser(user: UserInfo, callback: (userInfo: UserInfo) => void): void;
458
-
459
- /**
460
- *
461
- * Replaying method for global calling.
462
- * @param {followUser} args
463
- *
464
- */
465
- followUser(userId: string, callback: (userInfo: UserInfo) => void): void;
466
-
467
- /**
468
- *
469
- * Replaying method for global calling.
470
- * @param {ReplayType} args
471
- *
472
- */
473
- replay(userId: Pick<UserInfo, 'userId'>): void;
474
-
475
- /**
476
- *
477
- * Recording method for global calling.
478
- * @param {boolean} arg
479
- *
480
- */
481
- record(arg?: boolean): void;
482
-
483
- /**
484
- *
485
- * async method to set Replayers.
486
- * @param {keyof D42_FrontType['CRDT'][]} arg
487
- *
488
- */
489
- setReplayers(arg: string[]): void;
490
-
491
- /**
492
- *
493
- * Here you can switch language services by calling this method.
494
- * @param {boolean} arg
495
- *
496
- */
497
- switchLspServer(arg: boolean): void;
498
-
499
- /**
500
- *
501
- * Active the playground handler.
502
- *
503
- */
504
- activePlayground(): void;
505
-
506
- /**
507
- *
508
- * Run the playground handler.
509
- *
510
- */
511
- runPlayground(): void;
512
-
513
- /**
514
- *
515
- * Stop the playground.
516
- *
517
- */
518
- stopPlayground(): void;
519
-
520
- /**
521
- * Editor component.
522
- *
523
- *
524
- * ```ts
525
- * Dao.Editor({
526
- * container: '#editor',
527
- * item: 'editor',
528
- * props: {...EditorProps}
529
- * });
530
- ```
531
- *
532
- * @category Components
533
- *
534
- *
535
- */
536
- Editor(args: Component<EditorProps>): void;
537
-
538
- /**
539
- *
540
- * Page component.
541
- * @ignore
542
- * @category Components
543
- * @param Component
544
- *
545
- */
546
- Page(args: Component<TreeProps>): void;
547
-
548
- /**
549
- *
550
- * Tree component.
551
- *
552
- * ```ts
553
- * Dao.Tree({
554
- * container: '#tree',
555
- * item: 'tree',
556
- * props: {...TreeProps}
557
- * });
558
- ```
559
- *
560
- *
561
- * @category Components
562
- * @param Component
563
- *
564
- */
565
- Tree(args: Component<TreeProps>): void;
566
-
567
- /**
568
- *
569
- * Shell component.
570
- *
571
- *
572
- * ```ts
573
- * Dao.Shell({
574
- * container: '#shell',
575
- * item: 'shell',
576
- * props: {...ConsoleOrShellProps}
577
- * });
578
- ```
579
- *
580
- *
581
- * @category Components
582
- * @param Component
583
- *
584
- */
585
- Shell(args: Component<ConsoleOrShellProps>): void;
586
-
587
- /**
588
- *
589
- * Browser component.
590
- *
591
- * ```ts
592
- * Dao.Browser({
593
- * container: '#browser',
594
- * item: 'browser',
595
- * props: {...BrowserProps}
596
- * });
597
- ```
598
- *
599
- *
600
- * @category Components
601
- * @param Component
602
- *
603
- */
604
- Browser(args: Component<BrowserProps>): void;
605
-
606
- /**
607
- *
608
- * Console component.
609
- *
610
- *
611
- * ```ts
612
- * Dao.Console({
613
- * container: '#console',
614
- * item: 'console',
615
- * props: {...ConsoleOrShellProps}
616
- * });
617
- ```
618
- *
619
- *
620
- * @category Components
621
- * @param Component
622
- *
623
- */
624
- Console(args: Component<ConsoleOrShellProps>): void;
625
- }
1
+ /*!-----------------------------------------------------------
2
+ * Copyright (c) dao42. All rights reserved.
3
+ * Type definitions for @dao42/d42paas-front
4
+ * Released under the MIT license
5
+ *-----------------------------------------------------------*/
6
+
7
+ /*---------------------------------------------------------------------------------------------
8
+ * Copyright (c) Microsoft Corporation. All rights reserved.
9
+ * Licensed under the MIT License. See License.txt in the project root for license information.
10
+ *--------------------------------------------------------------------------------------------*/
11
+
12
+ export interface DiffPatternInfo {
13
+ value: string;
14
+ type: string;
15
+ }
16
+
17
+ export type ComponentType =
18
+ | 'Page'
19
+ | 'Tree'
20
+ | 'Editor'
21
+ | 'Console'
22
+ | 'Browser'
23
+ | 'Shell';
24
+
25
+ export type Mode = 'tsdoc' | 'singleFile' | 'IDE';
26
+
27
+ export type PlaygroundStatus = 'EMPTY' | 'ACTIVE' | 'INACTIVE';
28
+
29
+ export type DockerStatus = 'RUNNING' | 'STOP';
30
+
31
+ // export type Replay = 'stop' | 'disabled' | 'pause';
32
+ interface MessageType {
33
+ /**
34
+ * The message type is use to show up the playground status.
35
+ */
36
+ playgroundStatus?: PlaygroundStatus;
37
+
38
+ /**
39
+ * The message type is used to show up the docker status.
40
+ */
41
+ dockerStatus?: DockerStatus;
42
+
43
+ /**
44
+ * The message type is used to list the users in the room
45
+ */
46
+ userList?: UserInfo[];
47
+
48
+ /**
49
+ * The message type is used to identify the user you following.
50
+ */
51
+ followingUser?: UserInfo;
52
+
53
+ /**
54
+ * The message type is used to indicate the users who following you.
55
+ */
56
+ usersFollowYou?: UserInfo[];
57
+ }
58
+
59
+ interface ErrorType {
60
+ /**
61
+ * The error message block
62
+ */
63
+ message: {
64
+ /**
65
+ * The error message content
66
+ */
67
+ content: string;
68
+
69
+ /**
70
+ * The error playground you started
71
+ */
72
+ playgroundId: string;
73
+
74
+ /**
75
+ * The error timestamp
76
+ */
77
+ timestamp: number;
78
+ };
79
+ }
80
+
81
+ /**
82
+ * Userinfo type
83
+ */
84
+ interface UserInfo {
85
+ /**
86
+ * The playground id show up in the user info
87
+ */
88
+ playgroundId?: string;
89
+
90
+ operation?: any;
91
+ uuid?: string;
92
+ color?: string;
93
+ name?: string;
94
+ username?: string;
95
+ userId?: string;
96
+ role?: string;
97
+ avatar?: string;
98
+ onlineCount?: number;
99
+ }
100
+
101
+ // interface ReplayType {
102
+ // /**
103
+ // * The userId of the user who started the replay
104
+ // */
105
+ // userId?: UserInfo['userId'];
106
+
107
+ // /**
108
+ // * The timestamp of the replay
109
+ // */
110
+ // timestamp: number;
111
+ // }
112
+
113
+ export interface TreeProps {
114
+ /**
115
+ * The tree Item height
116
+ */
117
+ treeItemHeight?: string;
118
+ /**
119
+ * The background color of the tree
120
+ */
121
+ bgColor?: string;
122
+
123
+ /**
124
+ * The text color of the tree
125
+ */
126
+ fontColor?: string;
127
+
128
+ /**
129
+ * The drop background color
130
+ */
131
+ dropBgColor?: string;
132
+
133
+ /**
134
+ * The drop Text color
135
+ */
136
+ dropTextColor?: string;
137
+
138
+ /**
139
+ * The hover background color
140
+ */
141
+ hoverBgColor?: string;
142
+
143
+ /**
144
+ * The hover Text color
145
+ */
146
+ hoverTextColor?: string;
147
+
148
+ /**
149
+ * The tree item will fire the event when you click on it
150
+ *
151
+ * @param The path of the item
152
+ * @param The uri of the item
153
+ * @event
154
+ */
155
+ onClick?: (arg: { path: string; uri: string }) => void;
156
+ }
157
+
158
+ export interface MenuTagProps {
159
+ /**
160
+ * The style of the menu tag block
161
+ */
162
+ menuStyle?: {
163
+ /**
164
+ * The background color
165
+ */
166
+ backgroundColor?: string;
167
+
168
+ /**
169
+ * The text color
170
+ */
171
+ textColor?: string;
172
+
173
+ /**
174
+ * The hover background color
175
+ */
176
+ hoverBgColor?: string;
177
+
178
+ /**
179
+ * The hover text color
180
+ */
181
+ hoverTextColor?: string;
182
+
183
+ /**
184
+ * The icon color
185
+ */
186
+ iconColor?: string;
187
+
188
+ /**
189
+ * The icon hover color
190
+ */
191
+ hoverIconColor?: string;
192
+
193
+ /**
194
+ * The menu tag height
195
+ */
196
+ height?: string;
197
+ };
198
+ }
199
+
200
+ interface EditorProps extends MenuTagProps {
201
+ /**
202
+ * The editor font size
203
+ */
204
+ fontSize: string;
205
+
206
+ /**
207
+ * The editor line height
208
+ */
209
+ lineHeight: string;
210
+
211
+ /**
212
+ *
213
+ */
214
+
215
+ /**
216
+ * The Theme of the editor block
217
+ */
218
+ theme?: {
219
+ /**
220
+ * The color of the margin view overlay
221
+ */
222
+ marginViewOverlaysBgColor?: string;
223
+
224
+ /**
225
+ * The width of the margin view overlay
226
+ */
227
+ marginViewOverlaysWidth?: string;
228
+
229
+ /**
230
+ * The left position of the margin view overlay
231
+ */
232
+ marginViewOverlaysLeft?: string;
233
+
234
+ /**
235
+ * The line number color
236
+ */
237
+ lineNumbersColor?: string;
238
+
239
+ /**
240
+ * The line number with
241
+ */
242
+ lineNumbersWidth?: string;
243
+
244
+ /**
245
+ * The line number left
246
+ */
247
+ lineNumbersLeft?: string;
248
+
249
+ /**
250
+ * The active line number color
251
+ */
252
+ activeLineNumberColor?: string;
253
+ };
254
+ }
255
+
256
+ export interface ConsoleOrShellProps {
257
+ /**
258
+ * The font size of the shell
259
+ */
260
+ fontSize?: number;
261
+
262
+ /**
263
+ * The font family of the shell
264
+ */
265
+ fontFamily?: string;
266
+
267
+ /**
268
+ * The line height of the shell
269
+ */
270
+ lineHeight?: number;
271
+
272
+ /**
273
+ * The cursor color of the shell
274
+ */
275
+ cursorBlink?: boolean;
276
+
277
+ /**
278
+ * The cursor width of the shell
279
+ */
280
+ cursorWidth?: number;
281
+
282
+ /**
283
+ * The cursor style of the shell
284
+ */
285
+ cursorStyle?: string;
286
+
287
+ /**
288
+ * if the shell can be right click to open the context menu
289
+ */
290
+ rightClickSelectsWord?: boolean;
291
+
292
+ /**
293
+ * The theme of the shell block
294
+ */
295
+ theme?: {
296
+ /**
297
+ * The background color
298
+ */
299
+ background?: string;
300
+ };
301
+ }
302
+
303
+ export interface BrowserProps {
304
+ /**
305
+ * The url of the browser
306
+ */
307
+ url?: string;
308
+
309
+ /**
310
+ * if the browser can show the url
311
+ */
312
+ showURL?: boolean;
313
+
314
+ /**
315
+ * The fresh icon color
316
+ */
317
+ freshIconColor?: string;
318
+
319
+ /**
320
+ * The input text color
321
+ */
322
+ inputColor?: string;
323
+
324
+ /**
325
+ * The open icon color
326
+ */
327
+ openIconColor?: string;
328
+ }
329
+
330
+ /**
331
+ * The Component props type collection
332
+ */
333
+ export type ComponentPropsType =
334
+ | EditorProps
335
+ | TreeProps
336
+ | BrowserProps
337
+ | ConsoleOrShellProps;
338
+
339
+ /**
340
+ * Passing the values to init the playground.
341
+ * @category PaaS Options [Required]
342
+ */
343
+ export interface Options {
344
+ /**
345
+ * @ignore
346
+ *
347
+ */
348
+ debug?: boolean;
349
+
350
+ /**
351
+ *
352
+ * Error listener to the application.
353
+ * @param The error message block
354
+ * @event
355
+ */
356
+ onError?: (error: ErrorType) => void;
357
+
358
+ /**
359
+ *
360
+ * Message listener to the application.
361
+ * @param MessageType
362
+ * @event
363
+ */
364
+ onMessage?: (message: MessageType) => void;
365
+
366
+ /**
367
+ * The service worker origin
368
+ */
369
+ serviceWorkerOrigin: string;
370
+
371
+ /**
372
+ *
373
+ * init the playground with the mode.
374
+ *
375
+ */
376
+ mode?: Mode;
377
+
378
+ /**
379
+ *
380
+ * init the playground with the paasDomain.
381
+ *
382
+ */
383
+ paasDomain: string;
384
+
385
+ /**
386
+ *
387
+ * init the playground ticket needed.
388
+ *
389
+ */
390
+ ticket: string;
391
+
392
+ /**
393
+ *
394
+ * to init the playground with this id.
395
+ *
396
+ */
397
+ playgroundId: string;
398
+
399
+ /**
400
+ *
401
+ * userId for the playground.
402
+ *
403
+ */
404
+ userId: string;
405
+
406
+ /**
407
+ *
408
+ * tenantId for the playground.
409
+ *
410
+ */
411
+ tenantId: string;
412
+
413
+ /**
414
+ *
415
+ * username for the playground.
416
+ *
417
+ */
418
+ username?: string;
419
+
420
+ /**
421
+ *
422
+ * avatarUrl for the playground but not necessarily.
423
+ *
424
+ */
425
+ avatarUrl?: string;
426
+
427
+ /**
428
+ *
429
+ * this argument is to ingnore replaying patterns.
430
+ *
431
+ */
432
+ ignoreReplayers?: string[];
433
+
434
+ /**
435
+ *
436
+ * Here you can map the components to the playground.
437
+ *
438
+ * @category ComponentsMapper
439
+ *
440
+ */
441
+ components?: Component<ComponentPropsType>[];
442
+
443
+ /**
444
+ * @deprecated to fix the issue of the playground.
445
+ *
446
+ * render?: () => TComponent[]; keyof D42_FrontType['CRDT'][]
447
+ */
448
+ }
449
+
450
+ /**
451
+ *
452
+ * @interface Component
453
+ * @desc The props of the component.
454
+ *
455
+ */
456
+ export interface Component<T> {
457
+ /**
458
+ *
459
+ * The DOM for the component.
460
+ * @type {(string | HTMLElement | Element)}
461
+ *
462
+ */
463
+ container: string | HTMLElement | Element;
464
+
465
+ item: ComponentType;
466
+ /**
467
+ * The component props
468
+ */
469
+ props?: T;
470
+ }
471
+
472
+ /**
473
+ * * This is the entry point for the application.
474
+ *
475
+ * * like:
476
+ *
477
+ *
478
+ * ```ts
479
+ let options = {...};
480
+ let Dao = new DaoPaaS(options);
481
+ ```
482
+ *
483
+ * See {@link Options} for more details.
484
+ */
485
+ export class DaoPaaS {
486
+ constructor(options: Options);
487
+
488
+ get playgroundStatus(): PlaygroundStatus;
489
+
490
+ get dockerStatus(): DockerStatus;
491
+
492
+ get userList(): UserInfo[];
493
+
494
+ /**
495
+ *
496
+ * Replaying method for global calling.
497
+ * @param {unFollowUser} args
498
+ *
499
+ */
500
+
501
+ unFollowUser(user: UserInfo, callback: (userInfo: UserInfo) => void): void;
502
+
503
+ /**
504
+ *
505
+ * Replaying method for global calling.
506
+ * @param {followUser} args
507
+ *
508
+ */
509
+ followUser(userId: string, callback: (userInfo: UserInfo) => void): void;
510
+
511
+ /**
512
+ *
513
+ * Replaying method for global calling.
514
+ * @param {DiffPatternInfo} args
515
+ * @param {DiffPatternInfo} args
516
+ *
517
+ */
518
+ setDiff(current: DiffPatternInfo, next: DiffPatternInfo): void;
519
+
520
+ /**
521
+ *
522
+ * Replaying method for global calling.
523
+ * @param {ReplayType} args
524
+ *
525
+ */
526
+ replay(userId: Pick<UserInfo, 'userId'>): void;
527
+
528
+ /**
529
+ *
530
+ * Recording method for global calling.
531
+ * @param {boolean} arg
532
+ *
533
+ */
534
+ record(arg?: boolean): void;
535
+
536
+ /**
537
+ *
538
+ * async method to set Replayers.
539
+ * @param {keyof D42_FrontType['CRDT'][]} arg
540
+ *
541
+ */
542
+ setReplayers(arg: string[]): void;
543
+
544
+ /**
545
+ *
546
+ * Here you can switch language services by calling this method.
547
+ * @param {boolean} arg
548
+ *
549
+ */
550
+ switchLspServer(arg: boolean): void;
551
+
552
+ /**
553
+ *
554
+ * Active the playground handler.
555
+ *
556
+ */
557
+ activePlayground(): void;
558
+
559
+ /**
560
+ *
561
+ * Run the playground handler.
562
+ *
563
+ */
564
+ runPlayground(): void;
565
+
566
+ /**
567
+ *
568
+ * Stop the playground.
569
+ *
570
+ */
571
+ stopPlayground(): void;
572
+
573
+ /**
574
+ * Editor component.
575
+ *
576
+ *
577
+ * ```ts
578
+ * Dao.Editor({
579
+ * container: '#editor',
580
+ * item: 'editor',
581
+ * props: {...EditorProps}
582
+ * });
583
+ ```
584
+ *
585
+ * @category Components
586
+ *
587
+ *
588
+ */
589
+ Editor(args: Component<EditorProps>): void;
590
+
591
+ /**
592
+ *
593
+ * Page component.
594
+ * @ignore
595
+ * @category Components
596
+ * @param Component
597
+ *
598
+ */
599
+ Page(args: Component<TreeProps>): void;
600
+
601
+ /**
602
+ *
603
+ * Tree component.
604
+ *
605
+ * ```ts
606
+ * Dao.Tree({
607
+ * container: '#tree',
608
+ * item: 'tree',
609
+ * props: {...TreeProps}
610
+ * });
611
+ ```
612
+ *
613
+ *
614
+ * @category Components
615
+ * @param Component
616
+ *
617
+ */
618
+ Tree(args: Component<TreeProps>): void;
619
+
620
+ /**
621
+ *
622
+ * Shell component.
623
+ *
624
+ *
625
+ * ```ts
626
+ * Dao.Shell({
627
+ * container: '#shell',
628
+ * item: 'shell',
629
+ * props: {...ConsoleOrShellProps}
630
+ * });
631
+ ```
632
+ *
633
+ *
634
+ * @category Components
635
+ * @param Component
636
+ *
637
+ */
638
+ Shell(args: Component<ConsoleOrShellProps>): void;
639
+
640
+ /**
641
+ *
642
+ * Browser component.
643
+ *
644
+ * ```ts
645
+ * Dao.Browser({
646
+ * container: '#browser',
647
+ * item: 'browser',
648
+ * props: {...BrowserProps}
649
+ * });
650
+ ```
651
+ *
652
+ *
653
+ * @category Components
654
+ * @param Component
655
+ *
656
+ */
657
+ Browser(args: Component<BrowserProps>): void;
658
+
659
+ /**
660
+ *
661
+ * Console component.
662
+ *
663
+ *
664
+ * ```ts
665
+ * Dao.Console({
666
+ * container: '#console',
667
+ * item: 'console',
668
+ * props: {...ConsoleOrShellProps}
669
+ * });
670
+ ```
671
+ *
672
+ *
673
+ * @category Components
674
+ * @param Component
675
+ *
676
+ */
677
+ Console(args: Component<ConsoleOrShellProps>): void;
678
+ }