-
Notifications
You must be signed in to change notification settings - Fork 18
/
package.json
819 lines (819 loc) · 32.5 KB
/
package.json
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
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
{
"name": "vs-rest-api",
"displayName": "REST API",
"description": "Extension that provides a REST API to control your editor.",
"version": "3.0.1",
"publisher": "mkloubert",
"engines": {
"vscode": "^1.20.0"
},
"license": "MIT",
"categories": [
"Other"
],
"keywords": [
"HTTP",
"Remote",
"Editor",
"REST",
"API"
],
"activationEvents": [
"*"
],
"main": "./out/src/extension",
"contributes": {
"commands": [
{
"command": "extension.restApi.toggleHostState",
"title": "Starts or stops the api server",
"category": "REST API"
},
{
"command": "extension.restApi.startHost",
"title": "(Re)start the api server",
"category": "REST API"
},
{
"command": "extension.restApi.stopHost",
"title": "Stop the api server",
"category": "REST API"
}
],
"configuration": {
"properties": {
"rest.api": {
"type": "object",
"properties": {
"autoStart": {
"description": "Start HTTP on startup or not.",
"type": "boolean",
"default": false
},
"customOnly": {
"description": "Indicates if build-in endpoints are disabled by default or not.",
"type": "boolean",
"default": false
},
"disableNewVersionPopups": {
"description": "Disables popups that report for a new (installed) version.",
"type": "boolean",
"default": false
},
"endpoints": {
"description": "One or more regular expressions that describe custom endpoints to register.",
"type": "object",
"patternProperties": {
"(.*)": {
"description": "The regular expression of the endpoint.",
"type": "object",
"format": "regex",
"properties": {
"isActive": {
"description": "Indicates if the endpoint is currently active or not.",
"type": "boolean",
"default": true
},
"options": {
"description": "The options for the execution."
},
"script": {
"description": "The path to the script with the methods to handle the API request.",
"type": "string",
"default": "./my-api-endpoint.js"
},
"state": {
"description": "The initial value for the execution arguments of the underlying script."
}
},
"required": [
"script"
]
}
}
},
"globals": {
"description": "Data that is accessable from everywhere, in scripts e.g."
},
"guest": {
"oneOf": [
{
"description": "Defines if guest account should be activated or not.",
"type": "boolean",
"default": true
},
{
"description": "Settings for the guest account.",
"type": "object",
"properties": {
"canActivate": {
"description": "Defines if guest is able to activate extensions or not.",
"type": "boolean",
"default": false
},
"canAnything": {
"description": "Defines if guest is able to do anything with the API or not.",
"type": "boolean",
"default": false
},
"canClose": {
"description": "Defines if guest is able to close editor tabs or not.",
"type": "boolean",
"default": false
},
"canCreate": {
"description": "Defines if guest is able to create things like output channels or not.",
"type": "boolean",
"default": false
},
"canDelete": {
"description": "Defines if guest is able to delete files or folders.",
"type": "boolean",
"default": false
},
"canDeploy": {
"description": "Defines if guest is able to deploy files via 'vs-deploy', e.g.",
"type": "boolean",
"default": false
},
"canExecute": {
"description": "Defines if guest can execute commands or not.",
"type": "boolean",
"default": false
},
"canOpen": {
"description": "Defines if guest is able to open an editor tab in VS Code or not.",
"type": "boolean",
"default": false
},
"canWrite": {
"description": "Defines if guest has write access or not.",
"type": "boolean",
"default": false
},
"customOnly": {
"description": "Indicates if build-in endpoints are disabled for a guest or not.",
"type": "boolean",
"default": false
},
"endpoints": {
"description": "Defines one or more endpoint(s) via regular expressions that are available for the guest.",
"type": "object",
"patternProperties": {
"(.*)": {
"description": "The regular expression for the endpoint(s) to make available.",
"type": "object",
"properties": {
"isAvailable": {
"description": "Endpoint is available or not.",
"type": "boolean",
"default": true
},
"methods": {
"description": "One or more HTTP methods that are allowed for the guest.",
"oneOf": [
{
"description": "The name of the HTTP method to allow.",
"type": "string"
},
{
"description": "The names of the HTTP methods to allow.",
"type": "array",
"items": {
"description": "The name of the HTTP method to allow.",
"type": "string"
}
}
]
}
}
}
}
},
"exclude": {
"description": "Defines one or more glob patterns with files to exclude.",
"oneOf": [
{
"description": "The glob pattern with the files to exclude.",
"type": "string"
},
{
"description": "The list glob patterns with the files to exclude.",
"type": "array",
"default": [],
"items": {
"type": "string"
}
}
]
},
"files": {
"description": "Defines one or more glob patterns with files to include.",
"oneOf": [
{
"description": "The glob pattern with the files to include.",
"type": "string",
"default": "**"
},
{
"description": "The list glob patterns with the files to include.",
"type": "array",
"default": [
"**"
],
"items": {
"type": "string"
}
}
]
},
"isActive": {
"description": "Defines if guest account should be activated or not.",
"type": "boolean",
"default": true
},
"values": {
"description": "Custom values for the guest account.",
"type": "object"
},
"withDot": {
"description": "Show (directories) with leading '.' character for the guest or not.",
"type": "boolean",
"default": false
}
}
}
]
},
"hooks": {
"description": "One or more hooks to register.",
"type": "object",
"patternProperties": {
"(.*)": {
"description": "The regular expression for the hook(s) to register.",
"oneOf": [
{
"type": "string",
"description": "The path to the script to execute.",
"default": "./my-hook.js"
},
{
"type": "object",
"properties": {
"options": {
"description": "Data for the execution."
},
"script": {
"description": "The path to the script to execute.",
"type": "string",
"default": "./my-hook.js"
}
},
"required": [
"script"
]
},
{
"type": "array",
"items": {
"oneOf": [
{
"type": "string",
"description": "The path to the script to execute."
},
{
"type": "object",
"properties": {
"options": {
"description": "Data for the execution."
},
"script": {
"description": "The path to the script to execute.",
"type": "string",
"default": "./my-hook.js"
}
},
"required": [
"script"
]
}
]
}
}
]
}
}
},
"lang": {
"description": "The custom language to use.",
"type": "string"
},
"openInBrowser": {
"type": "boolean",
"description": "Indicates if the root endpoint should be opened in browser after host has been started or not.",
"default": false
},
"preparer": {
"oneOf": [
{
"type": "string",
"description": "The path to the script that prepares an user (object).",
"default": "./my-user-preparer.js"
},
{
"type": "object",
"description": "Settings for a account preparer script.",
"properties": {
"options": {
"description": "The options for the execution."
},
"script": {
"description": "The path to the script that prepares an account (object).",
"type": "string",
"default": "./my-user-preparer.js"
}
},
"required": [
"script"
]
}
]
},
"port": {
"oneOf": [
{
"description": "The TCP port the HTTP server should listen on.",
"type": "integer",
"minimum": 0,
"maximum": 65535,
"default": 1781
},
{
"description": "Each property represents the machine (name) and its TCP port.",
"type": "object",
"patternProperties": {
"(.*)": {
"description": "The TCP port the HTTP server should listen on that machine.",
"type": "integer",
"minimum": 0,
"maximum": 65535,
"default": 1781
}
}
}
]
},
"realm": {
"description": "The name of the realm for the authentication.",
"type": "string",
"default": "REST API for Visual Studio Code"
},
"showPopupOnSuccess": {
"type": "boolean",
"description": "Indicates if an info popup / notification should be displayed after a successful start / stop of the API host.",
"default": true
},
"ssl": {
"description": "Configuration for running as HTTPs server.",
"properties": {
"ca": {
"description": "The path to the ca file.",
"type": "string"
},
"cert": {
"description": "The path to the file of the certificate.",
"type": "string"
},
"key": {
"description": "The path to the key file.",
"type": "string"
},
"passphrase": {
"description": "The required password for the key file.",
"type": "string"
},
"rejectUnauthorized": {
"description": "Request unauthorized or not.",
"type": "boolean",
"default": true
}
}
},
"users": {
"oneOf": [
{
"description": "The configuration of the user.",
"type": "object",
"properties": {
"canActivate": {
"description": "Defines if user is able to activate extensions or not.",
"type": "boolean",
"default": false
},
"canAnything": {
"description": "Defines if user is able to do anything with the API or not.",
"type": "boolean",
"default": false
},
"canClose": {
"description": "Defines if user is able to close editor tabs or not.",
"type": "boolean",
"default": false
},
"canCreate": {
"description": "Defines if user is able to create things like output channels or not.",
"type": "boolean",
"default": false
},
"canDelete": {
"description": "Defines if user is able to delete files or folders.",
"type": "boolean",
"default": false
},
"canDeploy": {
"description": "Defines if user is able to deploy files via 'vs-deploy', e.g.",
"type": "boolean",
"default": false
},
"canExecute": {
"description": "Defines if user can execute commands or not.",
"type": "boolean",
"default": false
},
"canOpen": {
"description": "Defines if user is able to open an editor tab in VS Code or not.",
"type": "boolean",
"default": false
},
"canWrite": {
"description": "Defines if user has write access or not.",
"type": "boolean",
"default": false
},
"customOnly": {
"description": "Indicates if build-in endpoints are disabled for that user or not.",
"type": "boolean",
"default": false
},
"endpoints": {
"description": "Defines one or more endpoint(s) via regular expressions that are available for the user.",
"type": "object",
"patternProperties": {
"(.*)": {
"description": "The regular expression for the endpoint(s) to make available.",
"type": "object",
"properties": {
"isAvailable": {
"description": "Endpoint is available or not.",
"type": "boolean",
"default": true
},
"methods": {
"description": "One or more HTTP methods that are allowed for the user.",
"oneOf": [
{
"description": "The name of the HTTP method to allow.",
"type": "string"
},
{
"description": "The names of the HTTP methods to allow.",
"type": "array",
"items": {
"description": "The name of the HTTP method to allow.",
"type": "string"
}
}
]
}
}
}
}
},
"exclude": {
"description": "Defines one or more glob patterns with files to exclude.",
"oneOf": [
{
"description": "The glob pattern with the files to exclude.",
"type": "string"
},
{
"description": "The list glob patterns with the files to exclude.",
"type": "array",
"default": [],
"items": {
"type": "string"
}
}
]
},
"files": {
"description": "Defines one or more glob patterns with files to include.",
"oneOf": [
{
"description": "The glob pattern with the files to include.",
"type": "string",
"default": "**"
},
{
"description": "The list glob patterns with the files to include.",
"type": "array",
"default": [
"**"
],
"items": {
"type": "string"
}
}
]
},
"isActive": {
"description": "Defines if user account should be activated or not.",
"type": "boolean",
"default": true
},
"name": {
"description": "The name of the user.",
"type": "string"
},
"password": {
"description": "The password.",
"type": "string"
},
"values": {
"description": "Custom values for the user account.",
"type": "object"
},
"withDot": {
"description": "Show (directories) with leading '.' character for the user or not.",
"type": "boolean",
"default": false
}
},
"required": [
"name",
"password"
]
},
{
"description": "A list of one or more users.",
"type": "array",
"items": {
"properties": {
"canActivate": {
"description": "Defines if user is able to activate extensions or not.",
"type": "boolean",
"default": false
},
"canAnything": {
"description": "Defines if user is able to do anything with the API or not.",
"type": "boolean",
"default": false
},
"canClose": {
"description": "Defines if user is able to close editor tabs or not.",
"type": "boolean",
"default": false
},
"canCreate": {
"description": "Defines if user is able to create things like output channels or not.",
"type": "boolean",
"default": false
},
"canDelete": {
"description": "Defines if user is able to delete files or folders.",
"type": "boolean",
"default": false
},
"canDeploy": {
"description": "Defines if user is able to deploy files via 'vs-deploy', e.g.",
"type": "boolean",
"default": false
},
"canExecute": {
"description": "Defines if user can execute commands or not.",
"type": "boolean",
"default": false
},
"canOpen": {
"description": "Defines if user is able to open an editor tab in VS Code or not.",
"type": "boolean",
"default": false
},
"canWrite": {
"description": "Defines if user has write access or not.",
"type": "boolean",
"default": false
},
"customOnly": {
"description": "Indicates if build-in endpoints are disabled for that user or not.",
"type": "boolean",
"default": false
},
"endpoints": {
"description": "Defines one or more endpoint(s) via regular expressions that are available for the user.",
"type": "object",
"patternProperties": {
"(.*)": {
"description": "The regular expression for the endpoint(s) to make available.",
"type": "object",
"properties": {
"isAvailable": {
"description": "Endpoint is available or not.",
"type": "boolean",
"default": true
},
"methods": {
"description": "One or more HTTP methods that are allowed for the user.",
"oneOf": [
{
"description": "The name of the HTTP method to allow.",
"type": "string"
},
{
"description": "The names of the HTTP methods to allow.",
"type": "array",
"items": {
"description": "The name of the HTTP method to allow.",
"type": "string"
}
}
]
}
}
}
}
},
"exclude": {
"description": "Defines one or more glob patterns with files to exclude.",
"oneOf": [
{
"description": "The glob pattern with the files to exclude.",
"type": "string"
},
{
"description": "The list glob patterns with the files to exclude.",
"type": "array",
"default": [],
"items": {
"type": "string"
}
}
]
},
"files": {
"description": "Defines one or more global patterns with files to include.",
"oneOf": [
{
"description": "The glob pattern with the files to include.",
"type": "string",
"default": "**"
},
{
"description": "The list glob patterns with the files to include.",
"type": "array",
"default": [
"**"
],
"items": {
"type": "string"
}
}
]
},
"isActive": {
"description": "Defines if user account should be activated or not.",
"type": "boolean",
"default": true
},
"name": {
"description": "The name of the user.",
"type": "string"
},
"password": {
"description": "The password.",
"type": "string"
},
"values": {
"description": "Custom values for the user account.",
"type": "object"
},
"withDot": {
"description": "Show (directories) with leading '.' character for the user or not.",
"type": "boolean",
"default": false
}
},
"required": [
"name",
"password"
]
}
}
]
},
"validator": {
"description": "Defines a script that validates a client request.",
"oneOf": [
{
"type": "string",
"description": "The path to the validator script.",
"default": "./my-client-validator.js"
},
{
"type": "object",
"description": "Settings for the client request validator.",
"properties": {
"options": {
"description": "Additional options / data for the execution (if required)."
},
"script": {
"type": "string",
"description": "The path to the validator script.",
"default": "./my-client-validator.js"
},
"state": {
"description": "The initial value for the execution arguments of the underlying script."
}
},
"required": [
"script"
]
}
]
},
"whiteboard": {
"oneOf": [
{
"type": "boolean",
"description": "Indicates if whiteboard feature should be active or not.",
"default": true
},
{
"type": "object",
"description": "Settings for handling a virtual whiteboard.",
"properties": {
"dir": {
"description": "The optional directory where to store the revisions.",
"type": "string"
},
"isActive": {
"type": "boolean",
"description": "Indicates if whiteboard feature should be active or not.",
"default": true
}
}
}
]
},
"withDot": {
"description": "Show (directories) with leading '.' character or not.",
"type": "boolean",
"default": false
}
}
}
}
}
},
"scripts": {
"vscode:prepublish": "tsc -p ./",
"compile": "tsc -watch -p ./",
"postinstall": "node ./node_modules/vscode/bin/install",
"test": "node ./node_modules/vscode/bin/test"
},
"devDependencies": {
"@types/mocha": "^2.2.48",
"@types/node": "^6.0.102",
"mocha": "^2.3.3",
"typescript": "^2.7.2",
"vscode": "^1.1.13"
},
"icon": "icon.png",
"badges": [
{
"description": "PayPal Donate",
"url": "https://img.shields.io/badge/Donate-PayPal-green.svg",
"href": "https://paypal.me/MarcelKloubert"
}
],
"author": {
"name": "Marcel Joachim Kloubert"
},
"repository": {
"type": "git",
"url": "https://github.com/mkloubert/vs-rest-api"
},
"bugs": {
"url": "https://github.com/mkloubert/vs-rest-api/issues"
},
"readmeFilename": "README.md",
"dependencies": {
"fs-extra": "^2.0.0",
"glob": "^7.1.1",
"html-entities": "^1.2.0",
"i18next": "^6.1.2",
"isbinaryfile": "^3.0.2",
"mime": "^1.6.0",
"moment": "^2.21.0"
}
}