@nasl/types 0.1.6 → 0.1.7-beta.1

package/nasl.core.d.ts

@@ -1,23 +1,9 @@
 declare namespace nasl.core {
-    export type Any = any;
     export type Boolean = boolean;
     export type Integer = number;
     export type Decimal = number;
     export type String = string;
-
-    export class Binary {
-        accept: 'Binary';
-    }
-
-    export class Date {
-        accept: 'Date';
-    }
-
-    export class Time {
-        accept: 'Time';
-    }
-
-    export class DateTime {
-        accept: 'DateTime';
-    }
+    export type Date = string;
+    export type Time = string;
+    export type DateTime = string;
 }

package/nasl.ui.ast.d.ts

@@ -11,6 +11,9 @@ export type BaseSetter = InputSetter | SwitchSetter | EnumSelectSetter | Capsule
  */
 export interface InputSetter {
     concept: 'InputSetter';
+    /**
+     * 占位文本
+     */
     placeholder?: string;
 }
 
@@ -27,6 +30,9 @@ export interface SwitchSetter {
  */
 export interface EnumSelectSetter {
     concept: 'EnumSelectSetter';
+    /**
+     * 枚举选项列表
+     */
     options: Array<SetterOption>;
 }
 
@@ -35,6 +41,9 @@ export interface EnumSelectSetter {
  */
 export interface CapsulesSetter {
     concept: 'CapsulesSetter';
+    /**
+     * 枚举选项列表
+     */
     options: Array<SetterOption>;
 }
 
@@ -43,10 +52,25 @@ export interface CapsulesSetter {
  */
 export interface NumberInputSetter {
     concept: 'NumberInputSetter';
+    /**
+     * 按钮位置
+     */
     placement?: string;
+    /**
+     * 最小值
+     */
     min?: number;
+    /**
+     * 最大值
+     */
     max?: number;
+    /**
+     * 精度
+     */
     precision?: number;
+    /**
+     * 占位文本
+     */
     placeholder?: string;
 }
 
@@ -55,6 +79,9 @@ export interface NumberInputSetter {
  */
 export interface IconSetter {
     concept: 'IconSetter';
+    /**
+     * 图标标题
+     */
     title?: string;
 }
 
@@ -79,21 +106,70 @@ export interface PropertySelectSetter {
  */
 export interface ViewComponentDeclaration {
     concept: 'ViewComponentDeclaration';
+    /**
+     * 页面组件名称
+     */
     name: string;
+    /**
+     * 页面组件中划线名称
+     */
     kebabName: string;
+    /**
+     * 页面组件标题
+     */
     title: string;
+    /**
+     * 所在分组
+     */
     group: string;
+    /**
+     * 页面组件图标
+     */
     icon: string;
+    /**
+     * 页面组件描述
+     */
     description?: string;
+    /**
+     * 关于 TS 的 typeParams
+     */
     tsTypeParams?: string;
+    /**
+     * 组件属性列表
+     */
     props: Array<PropDeclaration>;
+    /**
+     * 可访问的组件属性列表
+     */
     readableProps: Array<PropDeclaration>;
+    /**
+     * 组件事件列表
+     */
     events: Array<EventDeclaration>;
+    /**
+     * 插槽列表
+     */
     slots: Array<SlotDeclaration>;
+    /**
+     * 逻辑列表
+     */
     methods: Array<LogicDeclaration>;
+    /**
+     * 页面组件列表
+     */
     children: Array<ViewComponentDeclaration>;
+    /**
+     * 页面组件的代码块列表
+     */
     blocks: Array<ViewBlockWithImage>;
+    /**
+     * 主题变量
+     */
     themeVariables: Array<ThemeVariable>;
+    /**
+     * 国际化配置列表
+     */
+    i18nMap?: Map<string, Map<string, string>>;
 }
 
 /**
@@ -101,23 +177,97 @@ export interface ViewComponentDeclaration {
  */
 export interface PropDeclaration {
     concept: 'PropDeclaration';
+    /**
+     * 组件属性名称
+     */
     name: string;
+    /**
+     * 组件属性标题
+     */
     title: string;
+    /**
+     * 组件属性分组
+     */
     group: '基础信息' | '数据属性' | '主要属性' | '交互属性' | '状态属性' | '样式属性' | '工具属性';
+    /**
+     * 组件属性图标
+     */
     icon?: string;
+    /**
+     * 组件属性描述
+     */
     description?: string;
+    /**
+     * 类型
+     *
+     * 直接写 TS 类型
+     */
     tsType: string;
+    /**
+     * 是否支持双向绑定
+     */
     sync: boolean;
+    /**
+     * 是否将任意类型隐式转换成String
+     *
+     * 仅在属性类型为 string（不包括字符串枚举）的情况下，且 sync 为 falsy 时可配置
+     */
+    implicitToString?: boolean;
+    /**
+     * 工具提示链接
+     */
     tooltipLink?: string;
+    /**
+     * 文档描述
+     */
     docDescription?: string;
+    /**
+     * 隐藏绑定属性按钮
+     */
     bindHide: boolean;
+    /**
+     * 绑定属性并打开弹窗
+     */
     bindOpen: boolean;
+    /**
+     * 所在的 tab 页
+     */
     tabKind: 'property' | 'style';
+    /**
+     * 属性设置器
+     */
     setter: BaseSetter;
+    /**
+     * 属性在面板中的布局方式
+     *
+     * block 表示标题与设置器分行展示；inline 表示同一行展示
+     */
+    layout: 'block' | 'inline';
+    /**
+     * 默认值
+     */
     defaultValue?: DefaultValue;
+    /**
+     * 渲染时的设计值
+     */
     tsDesignerValue?: string;
+    /**
+     * 是否显隐
+     *
+     * 用 TS 写表达式，在 IDE 中直接 eval
+     */
     tsIf?: string;
+    /**
+     * 是否禁用
+     *
+     * 用 TS 写表达式，在 IDE 中直接 eval
+     */
     tsDisabledIf?: string;
+    /**
+     * 在属性切换时发生的事件
+     *
+     * 用 TS 写表达式，在 IDE 中直接 eval
+     */
     tsOnChange?: string;
 }
 
@@ -126,9 +276,23 @@ export interface PropDeclaration {
  */
 export interface EventDeclaration {
     concept: 'EventDeclaration';
+    /**
+     * 组件事件名称
+     */
     name: string;
+    /**
+     * 组件事件标题
+     */
     title: string;
+    /**
+     * 组件事件描述
+     */
     description?: string;
+    /**
+     * 类型
+     *
+     * 直接写 TS 类型，这里是个函数类型
+     */
     tsType: string;
 }
 
@@ -137,12 +301,35 @@ export interface EventDeclaration {
  */
 export interface SlotDeclaration {
     concept: 'SlotDeclaration';
+    /**
+     * 插槽名称
+     */
     name: string;
+    /**
+     * 插槽标题
+     */
     title: string;
+    /**
+     * 插槽描述
+     */
     description?: string;
+    /**
+     * 类型
+     *
+     * 直接写 TS 类型
+     */
     tsType: string;
+    /**
+     * 输入参数列表
+     */
     params: Array<Param>;
+    /**
+     * 空的占位图
+     */
     emptyBackground?: string;
+    /**
+     * 插槽代码块
+     */
     snippets: Array<ViewBlockWithImage>;
 }
 
@@ -151,11 +338,29 @@ export interface SlotDeclaration {
  */
 export interface LogicDeclaration {
     concept: 'LogicDeclaration';
+    /**
+     * 逻辑名称
+     */
     name: string;
+    /**
+     * 逻辑标题
+     */
     title: string;
+    /**
+     * 逻辑描述
+     */
     description: string;
+    /**
+     * 类型参数列表
+     */
     typeParams?: Array<TypeParam>;
+    /**
+     * 输入参数列表
+     */
     params: Array<Param>;
+    /**
+     * 输出参数列表
+     */
     returns: Array<Return>;
 }
 
@@ -172,6 +377,9 @@ export interface NullLiteral {
  */
 export interface BooleanLiteral {
     concept: 'BooleanLiteral';
+    /**
+     * 字面量的值
+     */
     value: string;
 }
 
@@ -180,8 +388,14 @@ export interface BooleanLiteral {
  */
 export interface StringLiteral {
     concept: 'StringLiteral';
+    /**
+     * 字面量的值
+     */
     value: string;
-    i18nKey: string;
+    /**
+     * 国际化键
+     */
+    i18nKey?: string;
 }
 
 /**
@@ -189,7 +403,13 @@ export interface StringLiteral {
  */
 export interface NumericLiteral {
     concept: 'NumericLiteral';
+    /**
+     * 字面量的值
+     */
     value: string;
+    /**
+     * 类型
+     */
     typeAnnotation: TypeAnnotation;
 }
 
@@ -198,7 +418,13 @@ export interface NumericLiteral {
  */
 export interface NewList {
     concept: 'NewList';
-    typeAnnotation: TypeAnnotation;
+    /**
+     * 类型
+     */
+    typeAnnotation?: TypeAnnotation;
+    /**
+     * 成员表达式
+     */
     items: Array<LogicItem>;
 }
 
@@ -207,11 +433,33 @@ export interface NewList {
  */
 export interface SetterOption {
     concept: 'SetterOption';
+    /**
+     * 选项值
+     */
     value: string;
+    /**
+     * 选项标题
+     */
     title: string;
+    /**
+     * 选项图标
+     */
     icon?: string;
+    /**
+     * 选项工具提示
+     */
     tooltip?: string;
+    /**
+     * 是否显隐
+     *
+     * 用 TS 写表达式，在 IDE 中直接 eval
+     */
     tsIf?: string;
+    /**
+     * 是否禁用
+     *
+     * 用 TS 写表达式，在 IDE 中直接 eval
+     */
     tsDisabledIf?: string;
 }
 
@@ -220,10 +468,25 @@ export interface SetterOption {
  */
 export interface ViewBlockWithImage {
     concept: 'ViewBlockWithImage';
+    /**
+     * 标题
+     */
     title: string;
+    /**
+     * 代码
+     */
     code: string;
+    /**
+     * 描述
+     */
     description?: string;
+    /**
+     * 截图
+     */
     screenshot: string;
+    /**
+     * 手绘
+     */
     drawing: string;
 }
 
@@ -232,8 +495,17 @@ export interface ViewBlockWithImage {
  */
 export interface ViewBlock {
     concept: 'ViewBlock';
+    /**
+     * 标题
+     */
     title: string;
+    /**
+     * 代码
+     */
     code: string;
+    /**
+     * 描述
+     */
     description?: string;
 }
 
@@ -242,6 +514,9 @@ export interface ViewBlock {
  */
 export interface ThemeVariable {
     concept: 'ThemeVariable';
+    /**
+     * 主题变量名称
+     */
     name: string;
 }
 
@@ -250,13 +525,19 @@ export interface ThemeVariable {
  */
 export interface DefaultValue {
     concept: 'DefaultValue';
+    /**
+     * 根表达式
+     */
     expression: LogicItem;
+    /**
+     * 草稿态
+     */
     playground: Array<LogicItem>;
 }
 
 /**
-* 设置器基类
-*/
+ * 设置器基类
+ */
 export type LogicItem = NullLiteral | BooleanLiteral | StringLiteral | NumericLiteral | NewList;
 
 /**
@@ -264,9 +545,25 @@ export type LogicItem = NullLiteral | BooleanLiteral | StringLiteral | NumericLi
  */
 export interface Param {
     concept: 'Param';
+    /**
+     * 输入参数名称
+     */
     name: string;
+    /**
+     * 输入参数描述
+     */
     description?: string;
-    typeAnnotation: TypeAnnotation;
+    /**
+     * 是否为展开参数
+     */
+    spread?: boolean;
+    /**
+     * 类型
+     */
+    typeAnnotation?: TypeAnnotation;
+    /**
+     * 默认值
+     */
     defaultValue?: DefaultValue;
 }
 
@@ -275,13 +572,37 @@ export interface Param {
  */
 export interface TypeAnnotation {
     concept: 'TypeAnnotation';
+    /**
+     * 类型种类
+     */
     typeKind: 'primitive' | 'reference' | 'generic' | 'typeParam' | 'function' | 'union' | 'anonymousStructure';
+    /**
+     * 类型命名空间
+     */
     typeNamespace: string;
+    /**
+     * 类型名称
+     */
     typeName: string;
+    /**
+     * 类型参数
+     */
     typeArguments?: Array<TypeAnnotation>;
+    /**
+     * 返回类型
+     */
     returnType?: Array<TypeAnnotation>;
+    /**
+     * 是否是推断出来的
+     */
     inferred: boolean;
+    /**
+     * 匿名数据结构属性
+     */
     properties?: Array<StructureProperty>;
+    /**
+     * 规则对象
+     */
     ruleMap: Map<string, number>;
 }
 
@@ -290,12 +611,34 @@ export interface TypeAnnotation {
  */
 export interface StructureProperty {
     concept: 'StructureProperty';
+    /**
+     * 数据结构属性名称
+     */
     name: string;
-    label: string;
-    description: string;
-    typeAnnotation: TypeAnnotation;
-    defaultValue: DefaultValue;
-    jsonName: string;
+    /**
+     * 数据结构属性标题
+     */
+    label?: string;
+    /**
+     * 数据结构属性描述
+     */
+    description?: string;
+    /**
+     * 类型
+     */
+    typeAnnotation?: TypeAnnotation;
+    /**
+     * 默认值
+     *
+     * defaultValue结构体
+     */
+    defaultValue?: DefaultValue;
+    /**
+     * 数据结构字段 JSON 的序列化别名
+     *
+     * JSON 字符串别名
+     */
+    jsonName?: string;
 }
 
 /**
@@ -303,6 +646,9 @@ export interface StructureProperty {
  */
 export interface TypeParam {
     concept: 'TypeParam';
+    /**
+     * 类型名称
+     */
     name: string;
 }
 
@@ -311,9 +657,21 @@ export interface TypeParam {
  */
 export interface Return {
     concept: 'Return';
+    /**
+     * 输出参数名称
+     */
     name: string;
+    /**
+     * 输出参数描述
+     */
     description: string;
-    typeAnnotation: TypeAnnotation;
+    /**
+     * 类型
+     */
+    typeAnnotation?: TypeAnnotation;
+    /**
+     * 默认值
+     */
     defaultValue?: DefaultValue;
 }