@nasl/types 0.1.6 → 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 +3 -17
  2. package/nasl.ui.ast.d.ts +369 -11
  3. package/nasl.ui.ast.schema.json +241 -117
  4. package/nasl.ui.options.d.ts +201 -3
  5. package/package.json +5 -2
package/nasl.ui.ast.schema.json CHANGED
@@ -16,73 +16,101 @@
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": "主题变量"
101
+ },
102
+ "i18nMap": {
103
+ "type": "object",
104
+ "properties": {
105
+ "size": {
106
+ "type": "number"
107
+ }
108
+ },
109
+ "required": [
110
+ "size"
111
+ ],
112
+ "additionalProperties": false,
113
+ "description": "国际化配置列表"
86
114
  }
87
115
  },
88
116
  "required": [
@@ -112,10 +140,12 @@
112
140
  "const": "PropDeclaration"
113
141
  },
114
142
  "name": {
115
- "type": "string"
143
+ "type": "string",
144
+ "description": "组件属性名称"
116
145
  },
117
146
  "title": {
118
- "type": "string"
147
+ "type": "string",
148
+ "description": "组件属性标题"
119
149
  },
120
150
  "group": {
121
151
  "type": "string",
@@ -127,56 +157,84 @@
127
157
  "状态属性",
128
158
  "样式属性",
129
159
  "工具属性"
130
- ]
160
+ ],
161
+ "description": "组件属性分组"
131
162
  },
132
163
  "icon": {
133
- "type": "string"
164
+ "type": "string",
165
+ "description": "组件属性图标"
134
166
  },
135
167
  "description": {
136
- "type": "string"
168
+ "type": "string",
169
+ "description": "组件属性描述"
137
170
  },
138
171
  "tsType": {
139
- "type": "string"
172
+ "type": "string",
173
+ "description": "类型\n\n直接写 TS 类型"
140
174
  },
141
175
  "sync": {
142
- "type": "boolean"
176
+ "type": "boolean",
177
+ "description": "是否支持双向绑定"
178
+ },
179
+ "implicitToString": {
180
+ "type": "boolean",
181
+ "description": "是否将任意类型隐式转换成String\n\n仅在属性类型为 string（不包括字符串枚举）的情况下，且 sync 为 falsy 时可配置"
143
182
  },
144
183
  "tooltipLink": {
145
- "type": "string"
184
+ "type": "string",
185
+ "description": "工具提示链接"
146
186
  },
147
187
  "docDescription": {
148
- "type": "string"
188
+ "type": "string",
189
+ "description": "文档描述"
149
190
  },
150
191
  "bindHide": {
151
- "type": "boolean"
192
+ "type": "boolean",
193
+ "description": "隐藏绑定属性按钮"
152
194
  },
153
195
  "bindOpen": {
154
- "type": "boolean"
196
+ "type": "boolean",
197
+ "description": "绑定属性并打开弹窗"
155
198
  },
156
199
  "tabKind": {
157
200
  "type": "string",
158
201
  "enum": [
159
202
  "property",
160
203
  "style"
161
- ]
204
+ ],
205
+ "description": "所在的 tab 页"
162
206
  },
163
207
  "setter": {
164
- "$ref": "#/definitions/BaseSetter"
208
+ "$ref": "#/definitions/BaseSetter",
209
+ "description": "属性设置器"
210
+ },
211
+ "layout": {
212
+ "type": "string",
213
+ "enum": [
214
+ "block",
215
+ "inline"
216
+ ],
217
+ "description": "属性在面板中的布局方式\n\nblock 表示标题与设置器分行展示；inline 表示同一行展示"
165
218
  },
166
219
  "defaultValue": {
167
- "$ref": "#/definitions/DefaultValue"
220
+ "$ref": "#/definitions/DefaultValue",
221
+ "description": "默认值"
168
222
  },
169
223
  "tsDesignerValue": {
170
- "type": "string"
224
+ "type": "string",
225
+ "description": "渲染时的设计值"
171
226
  },
172
227
  "tsIf": {
173
- "type": "string"
228
+ "type": "string",
229
+ "description": "是否显隐\n\n用 TS 写表达式，在 IDE 中直接 eval"
174
230
  },
175
231
  "tsDisabledIf": {
176
- "type": "string"
232
+ "type": "string",
233
+ "description": "是否禁用\n\n用 TS 写表达式，在 IDE 中直接 eval"
177
234
  },
178
235
  "tsOnChange": {
179
- "type": "string"
236
+ "type": "string",
237
+ "description": "在属性切换时发生的事件\n\n用 TS 写表达式，在 IDE 中直接 eval"
180
238
  }
181
239
  },
182
240
  "required": [
@@ -189,7 +247,8 @@
189
247
  "bindHide",
190
248
  "bindOpen",
191
249
  "tabKind",
192
- "setter"
250
+ "setter",
251
+ "layout"
193
252
  ],
194
253
  "additionalProperties": false,
195
254
  "description": "组件属性"
@@ -231,7 +290,8 @@
231
290
  "const": "InputSetter"
232
291
  },
233
292
  "placeholder": {
234
- "type": "string"
293
+ "type": "string",
294
+ "description": "占位文本"
235
295
  }
236
296
  },
237
297
  "required": [
@@ -265,7 +325,8 @@
265
325
  "type": "array",
266
326
  "items": {
267
327
  "$ref": "#/definitions/SetterOption"
268
- }
328
+ },
329
+ "description": "枚举选项列表"
269
330
  }
270
331
  },
271
332
  "required": [
@@ -283,22 +344,28 @@
283
344
  "const": "SetterOption"
284
345
  },
285
346
  "value": {
286
- "type": "string"
347
+ "type": "string",
348
+ "description": "选项值"
287
349
  },
288
350
  "title": {
289
- "type": "string"
351
+ "type": "string",
352
+ "description": "选项标题"
290
353
  },
291
354
  "icon": {
292
- "type": "string"
355
+ "type": "string",
356
+ "description": "选项图标"
293
357
  },
294
358
  "tooltip": {
295
- "type": "string"
359
+ "type": "string",
360
+ "description": "选项工具提示"
296
361
  },
297
362
  "tsIf": {
298
- "type": "string"
363
+ "type": "string",
364
+ "description": "是否显隐\n\n用 TS 写表达式，在 IDE 中直接 eval"
299
365
  },
300
366
  "tsDisabledIf": {
301
- "type": "string"
367
+ "type": "string",
368
+ "description": "是否禁用\n\n用 TS 写表达式，在 IDE 中直接 eval"
302
369
  }
303
370
  },
304
371
  "required": [
@@ -320,7 +387,8 @@
320
387
  "type": "array",
321
388
  "items": {
322
389
  "$ref": "#/definitions/SetterOption"
323
- }
390
+ },
391
+ "description": "枚举选项列表"
324
392
  }
325
393
  },
326
394
  "required": [
@@ -338,19 +406,24 @@
338
406
  "const": "NumberInputSetter"
339
407
  },
340
408
  "placement": {
341
- "type": "string"
409
+ "type": "string",
410
+ "description": "按钮位置"
342
411
  },
343
412
  "min": {
344
- "type": "number"
413
+ "type": "number",
414
+ "description": "最小值"
345
415
  },
346
416
  "max": {
347
- "type": "number"
417
+ "type": "number",
418
+ "description": "最大值"
348
419
  },
349
420
  "precision": {
350
- "type": "number"
421
+ "type": "number",
422
+ "description": "精度"
351
423
  },
352
424
  "placeholder": {
353
- "type": "string"
425
+ "type": "string",
426
+ "description": "占位文本"
354
427
  }
355
428
  },
356
429
  "required": [
@@ -367,7 +440,8 @@
367
440
  "const": "IconSetter"
368
441
  },
369
442
  "title": {
370
- "type": "string"
443
+ "type": "string",
444
+ "description": "图标标题"
371
445
  }
372
446
  },
373
447
  "required": [
@@ -412,13 +486,15 @@
412
486
  "const": "DefaultValue"
413
487
  },
414
488
  "expression": {
415
- "$ref": "#/definitions/LogicItem"
489
+ "$ref": "#/definitions/LogicItem",
490
+ "description": "根表达式"
416
491
  },
417
492
  "playground": {
418
493
  "type": "array",
419
494
  "items": {
420
495
  "$ref": "#/definitions/LogicItem"
421
- }
496
+ },
497
+ "description": "草稿态"
422
498
  }
423
499
  },
424
500
  "required": [
@@ -471,7 +547,8 @@
471
547
  "const": "BooleanLiteral"
472
548
  },
473
549
  "value": {
474
- "type": "string"
550
+ "type": "string",
551
+ "description": "字面量的值"
475
552
  }
476
553
  },
477
554
  "required": [
@@ -489,16 +566,17 @@
489
566
  "const": "StringLiteral"
490
567
  },
491
568
  "value": {
492
- "type": "string"
569
+ "type": "string",
570
+ "description": "字面量的值"
493
571
  },
494
572
  "i18nKey": {
495
- "type": "string"
573
+ "type": "string",
574
+ "description": "国际化键"
496
575
  }
497
576
  },
498
577
  "required": [
499
578
  "concept",
500
- "value",
501
- "i18nKey"
579
+ "value"
502
580
  ],
503
581
  "additionalProperties": false,
504
582
  "description": "字符串字面量"
@@ -511,10 +589,12 @@
511
589
  "const": "NumericLiteral"
512
590
  },
513
591
  "value": {
514
- "type": "string"
592
+ "type": "string",
593
+ "description": "字面量的值"
515
594
  },
516
595
  "typeAnnotation": {
517
- "$ref": "#/definitions/TypeAnnotation"
596
+ "$ref": "#/definitions/TypeAnnotation",
597
+ "description": "类型"
518
598
  }
519
599
  },
520
600
  "required": [
@@ -542,34 +622,41 @@
542
622
  "function",
543
623
  "union",
544
624
  "anonymousStructure"
545
- ]
625
+ ],
626
+ "description": "类型种类"
546
627
  },
547
628
  "typeNamespace": {
548
- "type": "string"
629
+ "type": "string",
630
+ "description": "类型命名空间"
549
631
  },
550
632
  "typeName": {
551
- "type": "string"
633
+ "type": "string",
634
+ "description": "类型名称"
552
635
  },
553
636
  "typeArguments": {
554
637
  "type": "array",
555
638
  "items": {
556
639
  "$ref": "#/definitions/TypeAnnotation"
557
- }
640
+ },
641
+ "description": "类型参数"
558
642
  },
559
643
  "returnType": {
560
644
  "type": "array",
561
645
  "items": {
562
646
  "$ref": "#/definitions/TypeAnnotation"
563
- }
647
+ },
648
+ "description": "返回类型"
564
649
  },
565
650
  "inferred": {
566
- "type": "boolean"
651
+ "type": "boolean",
652
+ "description": "是否是推断出来的"
567
653
  },
568
654
  "properties": {
569
655
  "type": "array",
570
656
  "items": {
571
657
  "$ref": "#/definitions/StructureProperty"
572
- }
658
+ },
659
+ "description": "匿名数据结构属性"
573
660
  },
574
661
  "ruleMap": {
575
662
  "type": "object",
@@ -581,7 +668,8 @@
581
668
  "required": [
582
669
  "size"
583
670
  ],
584
- "additionalProperties": false
671
+ "additionalProperties": false,
672
+ "description": "规则对象"
585
673
  }
586
674
  },
587
675
  "required": [
@@ -603,32 +691,33 @@
603
691
  "const": "StructureProperty"
604
692
  },
605
693
  "name": {
606
- "type": "string"
694
+ "type": "string",
695
+ "description": "数据结构属性名称"
607
696
  },
608
697
  "label": {
609
- "type": "string"
698
+ "type": "string",
699
+ "description": "数据结构属性标题"
610
700
  },
611
701
  "description": {
612
- "type": "string"
702
+ "type": "string",
703
+ "description": "数据结构属性描述"
613
704
  },
614
705
  "typeAnnotation": {
615
- "$ref": "#/definitions/TypeAnnotation"
706
+ "$ref": "#/definitions/TypeAnnotation",
707
+ "description": "类型"
616
708
  },
617
709
  "defaultValue": {
618
- "$ref": "#/definitions/DefaultValue"
710
+ "$ref": "#/definitions/DefaultValue",
711
+ "description": "默认值\n\ndefaultValue结构体"
619
712
  },
620
713
  "jsonName": {
621
- "type": "string"
714
+ "type": "string",
715
+ "description": "数据结构字段 JSON 的序列化别名\n\nJSON 字符串别名"
622
716
  }
623
717
  },
624
718
  "required": [
625
719
  "concept",
626
- "name",
627
- "label",
628
- "description",
629
- "typeAnnotation",
630
- "defaultValue",
631
- "jsonName"
720
+ "name"
632
721
  ],
633
722
  "additionalProperties": false,
634
723
  "description": "数据结构属性"
@@ -641,18 +730,19 @@
641
730
  "const": "NewList"
642
731
  },
643
732
  "typeAnnotation": {
644
- "$ref": "#/definitions/TypeAnnotation"
733
+ "$ref": "#/definitions/TypeAnnotation",
734
+ "description": "类型"
645
735
  },
646
736
  "items": {
647
737
  "type": "array",
648
738
  "items": {
649
739
  "$ref": "#/definitions/LogicItem"
650
- }
740
+ },
741
+ "description": "成员表达式"
651
742
  }
652
743
  },
653
744
  "required": [
654
745
  "concept",
655
- "typeAnnotation",
656
746
  "items"
657
747
  ],
658
748
  "additionalProperties": false,
@@ -666,16 +756,20 @@
666
756
  "const": "EventDeclaration"
667
757
  },
668
758
  "name": {
669
- "type": "string"
759
+ "type": "string",
760
+ "description": "组件事件名称"
670
761
  },
671
762
  "title": {
672
- "type": "string"
763
+ "type": "string",
764
+ "description": "组件事件标题"
673
765
  },
674
766
  "description": {
675
- "type": "string"
767
+ "type": "string",
768
+ "description": "组件事件描述"
676
769
  },
677
770
  "tsType": {
678
- "type": "string"
771
+ "type": "string",
772
+ "description": "类型\n\n直接写 TS 类型，这里是个函数类型"
679
773
  }
680
774
  },
681
775
  "required": [
@@ -695,31 +789,38 @@
695
789
  "const": "SlotDeclaration"
696
790
  },
697
791
  "name": {
698
- "type": "string"
792
+ "type": "string",
793
+ "description": "插槽名称"
699
794
  },
700
795
  "title": {
701
- "type": "string"
796
+ "type": "string",
797
+ "description": "插槽标题"
702
798
  },
703
799
  "description": {
704
- "type": "string"
800
+ "type": "string",
801
+ "description": "插槽描述"
705
802
  },
706
803
  "tsType": {
707
- "type": "string"
804
+ "type": "string",
805
+ "description": "类型\n\n直接写 TS 类型"
708
806
  },
709
807
  "params": {
710
808
  "type": "array",
711
809
  "items": {
712
810
  "$ref": "#/definitions/Param"
713
- }
811
+ },
812
+ "description": "输入参数列表"
714
813
  },
715
814
  "emptyBackground": {
716
- "type": "string"
815
+ "type": "string",
816
+ "description": "空的占位图"
717
817
  },
718
818
  "snippets": {
719
819
  "type": "array",
720
820
  "items": {
721
821
  "$ref": "#/definitions/ViewBlockWithImage"
722
- }
822
+ },
823
+ "description": "插槽代码块"
723
824
  }
724
825
  },
725
826
  "required": [
@@ -741,22 +842,29 @@
741
842
  "const": "Param"
742
843
  },
743
844
  "name": {
744
- "type": "string"
845
+ "type": "string",
846
+ "description": "输入参数名称"
745
847
  },
746
848
  "description": {
747
- "type": "string"
849
+ "type": "string",
850
+ "description": "输入参数描述"
851
+ },
852
+ "spread": {
853
+ "type": "boolean",
854
+ "description": "是否为展开参数"
748
855
  },
749
856
  "typeAnnotation": {
750
- "$ref": "#/definitions/TypeAnnotation"
857
+ "$ref": "#/definitions/TypeAnnotation",
858
+ "description": "类型"
751
859
  },
752
860
  "defaultValue": {
753
- "$ref": "#/definitions/DefaultValue"
861
+ "$ref": "#/definitions/DefaultValue",
862
+ "description": "默认值"
754
863
  }
755
864
  },
756
865
  "required": [
757
866
  "concept",
758
- "name",
759
- "typeAnnotation"
867
+ "name"
760
868
  ],
761
869
  "additionalProperties": false,
762
870
  "description": "输入参数"
@@ -769,19 +877,24 @@
769
877
  "const": "ViewBlockWithImage"
770
878
  },
771
879
  "title": {
772
- "type": "string"
880
+ "type": "string",
881
+ "description": "标题"
773
882
  },
774
883
  "code": {
775
- "type": "string"
884
+ "type": "string",
885
+ "description": "代码"
776
886
  },
777
887
  "description": {
778
- "type": "string"
888
+ "type": "string",
889
+ "description": "描述"
779
890
  },
780
891
  "screenshot": {
781
- "type": "string"
892
+ "type": "string",
893
+ "description": "截图"
782
894
  },
783
895
  "drawing": {
784
- "type": "string"
896
+ "type": "string",
897
+ "description": "手绘"
785
898
  }
786
899
  },
787
900
  "required": [
@@ -802,31 +915,37 @@
802
915
  "const": "LogicDeclaration"
803
916
  },
804
917
  "name": {
805
- "type": "string"
918
+ "type": "string",
919
+ "description": "逻辑名称"
806
920
  },
807
921
  "title": {
808
- "type": "string"
922
+ "type": "string",
923
+ "description": "逻辑标题"
809
924
  },
810
925
  "description": {
811
- "type": "string"
926
+ "type": "string",
927
+ "description": "逻辑描述"
812
928
  },
813
929
  "typeParams": {
814
930
  "type": "array",
815
931
  "items": {
816
932
  "$ref": "#/definitions/TypeParam"
817
- }
933
+ },
934
+ "description": "类型参数列表"
818
935
  },
819
936
  "params": {
820
937
  "type": "array",
821
938
  "items": {
822
939
  "$ref": "#/definitions/Param"
823
- }
940
+ },
941
+ "description": "输入参数列表"
824
942
  },
825
943
  "returns": {
826
944
  "type": "array",
827
945
  "items": {
828
946
  "$ref": "#/definitions/Return"
829
- }
947
+ },
948
+ "description": "输出参数列表"
830
949
  }
831
950
  },
832
951
  "required": [
@@ -848,7 +967,8 @@
848
967
  "const": "TypeParam"
849
968
  },
850
969
  "name": {
851
- "type": "string"
970
+ "type": "string",
971
+ "description": "类型名称"
852
972
  }
853
973
  },
854
974
  "required": [
@@ -866,23 +986,26 @@
866
986
  "const": "Return"
867
987
  },
868
988
  "name": {
869
- "type": "string"
989
+ "type": "string",
990
+ "description": "输出参数名称"
870
991
  },
871
992
  "description": {
872
- "type": "string"
993
+ "type": "string",
994
+ "description": "输出参数描述"
873
995
  },
874
996
  "typeAnnotation": {
875
- "$ref": "#/definitions/TypeAnnotation"
997
+ "$ref": "#/definitions/TypeAnnotation",
998
+ "description": "类型"
876
999
  },
877
1000
  "defaultValue": {
878
- "$ref": "#/definitions/DefaultValue"
1001
+ "$ref": "#/definitions/DefaultValue",
1002
+ "description": "默认值"
879
1003
  }
880
1004
  },
881
1005
  "required": [
882
1006
  "concept",
883
1007
  "name",
884
- "description",
885
- "typeAnnotation"
1008
+ "description"
886
1009
  ],
887
1010
  "additionalProperties": false,
888
1011
  "description": "输出参数"
@@ -895,7 +1018,8 @@
895
1018
  "const": "ThemeVariable"
896
1019
  },
897
1020
  "name": {
898
- "type": "string"
1021
+ "type": "string",
1022
+ "description": "主题变量名称"
899
1023
  }
900
1024
  },
901
1025
  "required": [