@nasl/types 0.1.7-beta → 0.1.7-beta.1

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 (5) hide show
  1. package/nasl.core.d.ts +0 -1
  2. package/nasl.ui.ast.d.ts +358 -3
  3. package/nasl.ui.ast.schema.json +217 -108
  4. package/nasl.ui.options.d.ts +199 -4
  5. package/package.json +1 -1
package/nasl.ui.ast.schema.json CHANGED
@@ -16,73 +16,88 @@
16
16
  "const": "ViewComponentDeclaration"
17
17
  },
18
18
  "name": {
19
- "type": "string"
19
+ "type": "string",
20
+ "description": "页面组件名称"
20
21
  },
21
22
  "kebabName": {
22
- "type": "string"
23
+ "type": "string",
24
+ "description": "页面组件中划线名称"
23
25
  },
24
26
  "title": {
25
- "type": "string"
27
+ "type": "string",
28
+ "description": "页面组件标题"
26
29
  },
27
30
  "group": {
28
- "type": "string"
31
+ "type": "string",
32
+ "description": "所在分组"
29
33
  },
30
34
  "icon": {
31
- "type": "string"
35
+ "type": "string",
36
+ "description": "页面组件图标"
32
37
  },
33
38
  "description": {
34
- "type": "string"
39
+ "type": "string",
40
+ "description": "页面组件描述"
35
41
  },
36
42
  "tsTypeParams": {
37
- "type": "string"
43
+ "type": "string",
44
+ "description": "关于 TS 的 typeParams"
38
45
  },
39
46
  "props": {
40
47
  "type": "array",
41
48
  "items": {
42
49
  "$ref": "#/definitions/PropDeclaration"
43
- }
50
+ },
51
+ "description": "组件属性列表"
44
52
  },
45
53
  "readableProps": {
46
54
  "type": "array",
47
55
  "items": {
48
56
  "$ref": "#/definitions/PropDeclaration"
49
- }
57
+ },
58
+ "description": "可访问的组件属性列表"
50
59
  },
51
60
  "events": {
52
61
  "type": "array",
53
62
  "items": {
54
63
  "$ref": "#/definitions/EventDeclaration"
55
- }
64
+ },
65
+ "description": "组件事件列表"
56
66
  },
57
67
  "slots": {
58
68
  "type": "array",
59
69
  "items": {
60
70
  "$ref": "#/definitions/SlotDeclaration"
61
- }
71
+ },
72
+ "description": "插槽列表"
62
73
  },
63
74
  "methods": {
64
75
  "type": "array",
65
76
  "items": {
66
77
  "$ref": "#/definitions/LogicDeclaration"
67
- }
78
+ },
79
+ "description": "逻辑列表"
68
80
  },
69
81
  "children": {
70
82
  "type": "array",
71
83
  "items": {
72
84
  "$ref": "#/definitions/ViewComponentDeclaration"
73
- }
85
+ },
86
+ "description": "页面组件列表"
74
87
  },
75
88
  "blocks": {
76
89
  "type": "array",
77
90
  "items": {
78
91
  "$ref": "#/definitions/ViewBlockWithImage"
79
- }
92
+ },
93
+ "description": "页面组件的代码块列表"
80
94
  },
81
95
  "themeVariables": {
82
96
  "type": "array",
83
97
  "items": {
84
98
  "$ref": "#/definitions/ThemeVariable"
85
- }
99
+ },
100
+ "description": "主题变量"
86
101
  },
87
102
  "i18nMap": {
88
103
  "type": "object",
@@ -94,7 +109,8 @@
94
109
  "required": [
95
110
  "size"
96
111
  ],
97
- "additionalProperties": false
112
+ "additionalProperties": false,
113
+ "description": "国际化配置列表"
98
114
  }
99
115
  },
100
116
  "required": [
@@ -111,8 +127,7 @@
111
127
  "methods",
112
128
  "children",
113
129
  "blocks",
114
- "themeVariables",
115
- "i18nMap"
130
+ "themeVariables"
116
131
  ],
117
132
  "additionalProperties": false,
118
133
  "description": "页面组件"
@@ -125,10 +140,12 @@
125
140
  "const": "PropDeclaration"
126
141
  },
127
142
  "name": {
128
- "type": "string"
143
+ "type": "string",
144
+ "description": "组件属性名称"
129
145
  },
130
146
  "title": {
131
- "type": "string"
147
+ "type": "string",
148
+ "description": "组件属性标题"
132
149
  },
133
150
  "group": {
134
151
  "type": "string",
@@ -140,63 +157,84 @@
140
157
  "状态属性",
141
158
  "样式属性",
142
159
  "工具属性"
143
- ]
160
+ ],
161
+ "description": "组件属性分组"
144
162
  },
145
163
  "icon": {
146
- "type": "string"
164
+ "type": "string",
165
+ "description": "组件属性图标"
147
166
  },
148
167
  "description": {
149
- "type": "string"
168
+ "type": "string",
169
+ "description": "组件属性描述"
150
170
  },
151
171
  "tsType": {
152
- "type": "string"
172
+ "type": "string",
173
+ "description": "类型\n\n直接写 TS 类型"
153
174
  },
154
175
  "sync": {
155
- "type": "boolean"
176
+ "type": "boolean",
177
+ "description": "是否支持双向绑定"
178
+ },
179
+ "implicitToString": {
180
+ "type": "boolean",
181
+ "description": "是否将任意类型隐式转换成String\n\n仅在属性类型为 string（不包括字符串枚举）的情况下，且 sync 为 falsy 时可配置"
156
182
  },
157
183
  "tooltipLink": {
158
- "type": "string"
184
+ "type": "string",
185
+ "description": "工具提示链接"
159
186
  },
160
187
  "docDescription": {
161
- "type": "string"
188
+ "type": "string",
189
+ "description": "文档描述"
162
190
  },
163
191
  "bindHide": {
164
- "type": "boolean"
192
+ "type": "boolean",
193
+ "description": "隐藏绑定属性按钮"
165
194
  },
166
195
  "bindOpen": {
167
- "type": "boolean"
196
+ "type": "boolean",
197
+ "description": "绑定属性并打开弹窗"
168
198
  },
169
199
  "tabKind": {
170
200
  "type": "string",
171
201
  "enum": [
172
202
  "property",
173
203
  "style"
174
- ]
204
+ ],
205
+ "description": "所在的 tab 页"
175
206
  },
176
207
  "setter": {
177
- "$ref": "#/definitions/BaseSetter"
208
+ "$ref": "#/definitions/BaseSetter",
209
+ "description": "属性设置器"
178
210
  },
179
211
  "layout": {
180
212
  "type": "string",
181
213
  "enum": [
182
214
  "block",
183
215
  "inline"
184
- ]
216
+ ],
217
+ "description": "属性在面板中的布局方式\n\nblock 表示标题与设置器分行展示；inline 表示同一行展示"
185
218
  },
186
219
  "defaultValue": {
187
- "$ref": "#/definitions/DefaultValue"
220
+ "$ref": "#/definitions/DefaultValue",
221
+ "description": "默认值"
188
222
  },
189
223
  "tsDesignerValue": {
190
- "type": "string"
224
+ "type": "string",
225
+ "description": "渲染时的设计值"
191
226
  },
192
227
  "tsIf": {
193
- "type": "string"
228
+ "type": "string",
229
+ "description": "是否显隐\n\n用 TS 写表达式，在 IDE 中直接 eval"
194
230
  },
195
231
  "tsDisabledIf": {
196
- "type": "string"
232
+ "type": "string",
233
+ "description": "是否禁用\n\n用 TS 写表达式，在 IDE 中直接 eval"
197
234
  },
198
235
  "tsOnChange": {
199
- "type": "string"
236
+ "type": "string",
237
+ "description": "在属性切换时发生的事件\n\n用 TS 写表达式，在 IDE 中直接 eval"
200
238
  }
201
239
  },
202
240
  "required": [
@@ -252,7 +290,8 @@
252
290
  "const": "InputSetter"
253
291
  },
254
292
  "placeholder": {
255
- "type": "string"
293
+ "type": "string",
294
+ "description": "占位文本"
256
295
  }
257
296
  },
258
297
  "required": [
@@ -286,7 +325,8 @@
286
325
  "type": "array",
287
326
  "items": {
288
327
  "$ref": "#/definitions/SetterOption"
289
- }
328
+ },
329
+ "description": "枚举选项列表"
290
330
  }
291
331
  },
292
332
  "required": [
@@ -304,22 +344,28 @@
304
344
  "const": "SetterOption"
305
345
  },
306
346
  "value": {
307
- "type": "string"
347
+ "type": "string",
348
+ "description": "选项值"
308
349
  },
309
350
  "title": {
310
- "type": "string"
351
+ "type": "string",
352
+ "description": "选项标题"
311
353
  },
312
354
  "icon": {
313
- "type": "string"
355
+ "type": "string",
356
+ "description": "选项图标"
314
357
  },
315
358
  "tooltip": {
316
- "type": "string"
359
+ "type": "string",
360
+ "description": "选项工具提示"
317
361
  },
318
362
  "tsIf": {
319
- "type": "string"
363
+ "type": "string",
364
+ "description": "是否显隐\n\n用 TS 写表达式，在 IDE 中直接 eval"
320
365
  },
321
366
  "tsDisabledIf": {
322
- "type": "string"
367
+ "type": "string",
368
+ "description": "是否禁用\n\n用 TS 写表达式，在 IDE 中直接 eval"
323
369
  }
324
370
  },
325
371
  "required": [
@@ -341,7 +387,8 @@
341
387
  "type": "array",
342
388
  "items": {
343
389
  "$ref": "#/definitions/SetterOption"
344
- }
390
+ },
391
+ "description": "枚举选项列表"
345
392
  }
346
393
  },
347
394
  "required": [
@@ -359,19 +406,24 @@
359
406
  "const": "NumberInputSetter"
360
407
  },
361
408
  "placement": {
362
- "type": "string"
409
+ "type": "string",
410
+ "description": "按钮位置"
363
411
  },
364
412
  "min": {
365
- "type": "number"
413
+ "type": "number",
414
+ "description": "最小值"
366
415
  },
367
416
  "max": {
368
- "type": "number"
417
+ "type": "number",
418
+ "description": "最大值"
369
419
  },
370
420
  "precision": {
371
- "type": "number"
421
+ "type": "number",
422
+ "description": "精度"
372
423
  },
373
424
  "placeholder": {
374
- "type": "string"
425
+ "type": "string",
426
+ "description": "占位文本"
375
427
  }
376
428
  },
377
429
  "required": [
@@ -388,7 +440,8 @@
388
440
  "const": "IconSetter"
389
441
  },
390
442
  "title": {
391
- "type": "string"
443
+ "type": "string",
444
+ "description": "图标标题"
392
445
  }
393
446
  },
394
447
  "required": [
@@ -433,13 +486,15 @@
433
486
  "const": "DefaultValue"
434
487
  },
435
488
  "expression": {
436
- "$ref": "#/definitions/LogicItem"
489
+ "$ref": "#/definitions/LogicItem",
490
+ "description": "根表达式"
437
491
  },
438
492
  "playground": {
439
493
  "type": "array",
440
494
  "items": {
441
495
  "$ref": "#/definitions/LogicItem"
442
- }
496
+ },
497
+ "description": "草稿态"
443
498
  }
444
499
  },
445
500
  "required": [
@@ -492,7 +547,8 @@
492
547
  "const": "BooleanLiteral"
493
548
  },
494
549
  "value": {
495
- "type": "string"
550
+ "type": "string",
551
+ "description": "字面量的值"
496
552
  }
497
553
  },
498
554
  "required": [
@@ -510,10 +566,12 @@
510
566
  "const": "StringLiteral"
511
567
  },
512
568
  "value": {
513
- "type": "string"
569
+ "type": "string",
570
+ "description": "字面量的值"
514
571
  },
515
572
  "i18nKey": {
516
- "type": "string"
573
+ "type": "string",
574
+ "description": "国际化键"
517
575
  }
518
576
  },
519
577
  "required": [
@@ -531,10 +589,12 @@
531
589
  "const": "NumericLiteral"
532
590
  },
533
591
  "value": {
534
- "type": "string"
592
+ "type": "string",
593
+ "description": "字面量的值"
535
594
  },
536
595
  "typeAnnotation": {
537
- "$ref": "#/definitions/TypeAnnotation"
596
+ "$ref": "#/definitions/TypeAnnotation",
597
+ "description": "类型"
538
598
  }
539
599
  },
540
600
  "required": [
@@ -562,34 +622,41 @@
562
622
  "function",
563
623
  "union",
564
624
  "anonymousStructure"
565
- ]
625
+ ],
626
+ "description": "类型种类"
566
627
  },
567
628
  "typeNamespace": {
568
- "type": "string"
629
+ "type": "string",
630
+ "description": "类型命名空间"
569
631
  },
570
632
  "typeName": {
571
- "type": "string"
633
+ "type": "string",
634
+ "description": "类型名称"
572
635
  },
573
636
  "typeArguments": {
574
637
  "type": "array",
575
638
  "items": {
576
639
  "$ref": "#/definitions/TypeAnnotation"
577
- }
640
+ },
641
+ "description": "类型参数"
578
642
  },
579
643
  "returnType": {
580
644
  "type": "array",
581
645
  "items": {
582
646
  "$ref": "#/definitions/TypeAnnotation"
583
- }
647
+ },
648
+ "description": "返回类型"
584
649
  },
585
650
  "inferred": {
586
- "type": "boolean"
651
+ "type": "boolean",
652
+ "description": "是否是推断出来的"
587
653
  },
588
654
  "properties": {
589
655
  "type": "array",
590
656
  "items": {
591
657
  "$ref": "#/definitions/StructureProperty"
592
- }
658
+ },
659
+ "description": "匿名数据结构属性"
593
660
  },
594
661
  "ruleMap": {
595
662
  "type": "object",
@@ -601,7 +668,8 @@
601
668
  "required": [
602
669
  "size"
603
670
  ],
604
- "additionalProperties": false
671
+ "additionalProperties": false,
672
+ "description": "规则对象"
605
673
  }
606
674
  },
607
675
  "required": [
@@ -623,22 +691,28 @@
623
691
  "const": "StructureProperty"
624
692
  },
625
693
  "name": {
626
- "type": "string"
694
+ "type": "string",
695
+ "description": "数据结构属性名称"
627
696
  },
628
697
  "label": {
629
- "type": "string"
698
+ "type": "string",
699
+ "description": "数据结构属性标题"
630
700
  },
631
701
  "description": {
632
- "type": "string"
702
+ "type": "string",
703
+ "description": "数据结构属性描述"
633
704
  },
634
705
  "typeAnnotation": {
635
- "$ref": "#/definitions/TypeAnnotation"
706
+ "$ref": "#/definitions/TypeAnnotation",
707
+ "description": "类型"
636
708
  },
637
709
  "defaultValue": {
638
- "$ref": "#/definitions/DefaultValue"
710
+ "$ref": "#/definitions/DefaultValue",
711
+ "description": "默认值\n\ndefaultValue结构体"
639
712
  },
640
713
  "jsonName": {
641
- "type": "string"
714
+ "type": "string",
715
+ "description": "数据结构字段 JSON 的序列化别名\n\nJSON 字符串别名"
642
716
  }
643
717
  },
644
718
  "required": [
@@ -656,13 +730,15 @@
656
730
  "const": "NewList"
657
731
  },
658
732
  "typeAnnotation": {
659
- "$ref": "#/definitions/TypeAnnotation"
733
+ "$ref": "#/definitions/TypeAnnotation",
734
+ "description": "类型"
660
735
  },
661
736
  "items": {
662
737
  "type": "array",
663
738
  "items": {
664
739
  "$ref": "#/definitions/LogicItem"
665
- }
740
+ },
741
+ "description": "成员表达式"
666
742
  }
667
743
  },
668
744
  "required": [
@@ -680,16 +756,20 @@
680
756
  "const": "EventDeclaration"
681
757
  },
682
758
  "name": {
683
- "type": "string"
759
+ "type": "string",
760
+ "description": "组件事件名称"
684
761
  },
685
762
  "title": {
686
- "type": "string"
763
+ "type": "string",
764
+ "description": "组件事件标题"
687
765
  },
688
766
  "description": {
689
- "type": "string"
767
+ "type": "string",
768
+ "description": "组件事件描述"
690
769
  },
691
770
  "tsType": {
692
- "type": "string"
771
+ "type": "string",
772
+ "description": "类型\n\n直接写 TS 类型，这里是个函数类型"
693
773
  }
694
774
  },
695
775
  "required": [
@@ -709,31 +789,38 @@
709
789
  "const": "SlotDeclaration"
710
790
  },
711
791
  "name": {
712
- "type": "string"
792
+ "type": "string",
793
+ "description": "插槽名称"
713
794
  },
714
795
  "title": {
715
- "type": "string"
796
+ "type": "string",
797
+ "description": "插槽标题"
716
798
  },
717
799
  "description": {
718
- "type": "string"
800
+ "type": "string",
801
+ "description": "插槽描述"
719
802
  },
720
803
  "tsType": {
721
- "type": "string"
804
+ "type": "string",
805
+ "description": "类型\n\n直接写 TS 类型"
722
806
  },
723
807
  "params": {
724
808
  "type": "array",
725
809
  "items": {
726
810
  "$ref": "#/definitions/Param"
727
- }
811
+ },
812
+ "description": "输入参数列表"
728
813
  },
729
814
  "emptyBackground": {
730
- "type": "string"
815
+ "type": "string",
816
+ "description": "空的占位图"
731
817
  },
732
818
  "snippets": {
733
819
  "type": "array",
734
820
  "items": {
735
821
  "$ref": "#/definitions/ViewBlockWithImage"
736
- }
822
+ },
823
+ "description": "插槽代码块"
737
824
  }
738
825
  },
739
826
  "required": [
@@ -755,19 +842,24 @@
755
842
  "const": "Param"
756
843
  },
757
844
  "name": {
758
- "type": "string"
845
+ "type": "string",
846
+ "description": "输入参数名称"
759
847
  },
760
848
  "description": {
761
- "type": "string"
849
+ "type": "string",
850
+ "description": "输入参数描述"
762
851
  },
763
852
  "spread": {
764
- "type": "boolean"
853
+ "type": "boolean",
854
+ "description": "是否为展开参数"
765
855
  },
766
856
  "typeAnnotation": {
767
- "$ref": "#/definitions/TypeAnnotation"
857
+ "$ref": "#/definitions/TypeAnnotation",
858
+ "description": "类型"
768
859
  },
769
860
  "defaultValue": {
770
- "$ref": "#/definitions/DefaultValue"
861
+ "$ref": "#/definitions/DefaultValue",
862
+ "description": "默认值"
771
863
  }
772
864
  },
773
865
  "required": [
@@ -785,19 +877,24 @@
785
877
  "const": "ViewBlockWithImage"
786
878
  },
787
879
  "title": {
788
- "type": "string"
880
+ "type": "string",
881
+ "description": "标题"
789
882
  },
790
883
  "code": {
791
- "type": "string"
884
+ "type": "string",
885
+ "description": "代码"
792
886
  },
793
887
  "description": {
794
- "type": "string"
888
+ "type": "string",
889
+ "description": "描述"
795
890
  },
796
891
  "screenshot": {
797
- "type": "string"
892
+ "type": "string",
893
+ "description": "截图"
798
894
  },
799
895
  "drawing": {
800
- "type": "string"
896
+ "type": "string",
897
+ "description": "手绘"
801
898
  }
802
899
  },
803
900
  "required": [
@@ -818,31 +915,37 @@
818
915
  "const": "LogicDeclaration"
819
916
  },
820
917
  "name": {
821
- "type": "string"
918
+ "type": "string",
919
+ "description": "逻辑名称"
822
920
  },
823
921
  "title": {
824
- "type": "string"
922
+ "type": "string",
923
+ "description": "逻辑标题"
825
924
  },
826
925
  "description": {
827
- "type": "string"
926
+ "type": "string",
927
+ "description": "逻辑描述"
828
928
  },
829
929
  "typeParams": {
830
930
  "type": "array",
831
931
  "items": {
832
932
  "$ref": "#/definitions/TypeParam"
833
- }
933
+ },
934
+ "description": "类型参数列表"
834
935
  },
835
936
  "params": {
836
937
  "type": "array",
837
938
  "items": {
838
939
  "$ref": "#/definitions/Param"
839
- }
940
+ },
941
+ "description": "输入参数列表"
840
942
  },
841
943
  "returns": {
842
944
  "type": "array",
843
945
  "items": {
844
946
  "$ref": "#/definitions/Return"
845
- }
947
+ },
948
+ "description": "输出参数列表"
846
949
  }
847
950
  },
848
951
  "required": [
@@ -864,7 +967,8 @@
864
967
  "const": "TypeParam"
865
968
  },
866
969
  "name": {
867
- "type": "string"
970
+ "type": "string",
971
+ "description": "类型名称"
868
972
  }
869
973
  },
870
974
  "required": [
@@ -882,16 +986,20 @@
882
986
  "const": "Return"
883
987
  },
884
988
  "name": {
885
- "type": "string"
989
+ "type": "string",
990
+ "description": "输出参数名称"
886
991
  },
887
992
  "description": {
888
- "type": "string"
993
+ "type": "string",
994
+ "description": "输出参数描述"
889
995
  },
890
996
  "typeAnnotation": {
891
- "$ref": "#/definitions/TypeAnnotation"
997
+ "$ref": "#/definitions/TypeAnnotation",
998
+ "description": "类型"
892
999
  },
893
1000
  "defaultValue": {
894
- "$ref": "#/definitions/DefaultValue"
1001
+ "$ref": "#/definitions/DefaultValue",
1002
+ "description": "默认值"
895
1003
  }
896
1004
  },
897
1005
  "required": [
@@ -910,7 +1018,8 @@
910
1018
  "const": "ThemeVariable"
911
1019
  },
912
1020
  "name": {
913
- "type": "string"
1021
+ "type": "string",
1022
+ "description": "主题变量名称"
914
1023
  }
915
1024
  },
916
1025
  "required": [