@nasl/types 0.1.14 → 0.2.0

package/nasl.io.d.ts

@@ -0,0 +1,12 @@
+/* eslint-disable lines-between-class-members */
+declare namespace nasl.io {
+    export class FileInfo {
+        status: nasl.core.String;
+        url: nasl.core.String;
+        name: nasl.core.String;
+        size: nasl.core.Integer;
+        type: nasl.core.String;
+    }
+
+    export class File {}
+}

package/nasl.ui.ast.d.ts

@@ -6,7 +6,7 @@
 /**
  * 设置器基类
  */
-export type BaseSetter = CustomSetter | InputSetter | SwitchSetter | EnumSelectSetter | CapsulesSetter | NumberInputSetter | IconSetter | ImageSetter | PropertySelectSetter | PropertyTransformSetter | AnonymousFunctionSetter;
+export type BaseSetter = CustomSetter | InputSetter | SwitchSetter | EnumSelectSetter | CapsulesSetter | NumberInputSetter | IconSetter | ImageSetter | PropertySelectSetter | PropertyTransformSetter | AnonymousFunctionSetter | DataSourceSetter;
 
 /**
  * 自定义属性设置器
@@ -236,6 +236,21 @@ export interface AnonymousFunctionSetter {
     changedTime?: number;
 }
 
+/**
+ * 数据源设置器
+ */
+export interface DataSourceSetter {
+    concept: 'DataSourceSetter';
+    /**
+     * 节点变更时间
+     */
+    changedTime?: number;
+    /**
+     * 占位文本
+     */
+    placeholder?: string;
+}
+
 /**
  * 页面组件
  */
@@ -252,7 +267,7 @@ export interface ViewComponentDeclaration {
     /**
      * 页面组件中划线名称
      */
-    kebabName: string;
+    kebabName?: string;
     /**
      * 页面组件标题
      */
@@ -260,11 +275,11 @@ export interface ViewComponentDeclaration {
     /**
      * 所在分组
      */
-    group: string;
+    group?: string;
     /**
      * 页面组件图标
      */
-    icon: string;
+    icon?: string;
     /**
      * 页面组件描述
      */
@@ -331,7 +346,7 @@ export interface PropDeclaration {
     /**
      * 组件属性分组
      */
-    group: '基础信息' | '数据属性' | '主要属性' | '交互属性' | '状态属性' | '样式属性' | '工具属性' | '高级属性';
+    group?: '基础信息' | '数据属性' | '主要属性' | '交互属性' | '状态属性' | '样式属性' | '工具属性' | '高级属性';
     /**
      * 组件属性图标
      */
@@ -349,7 +364,7 @@ export interface PropDeclaration {
     /**
      * 是否支持双向绑定
      */
-    sync: boolean;
+    sync?: boolean;
     /**
      * 是否将任意类型隐式转换成String
      *
@@ -360,10 +375,6 @@ export interface PropDeclaration {
      * 允许该组件在逻辑中设置
      */
     settable?: boolean;
-    /**
-     * 该属性是否为数据源
-     */
-    isDataSource?: boolean;
     /**
      * 工具提示链接
      */
@@ -375,25 +386,25 @@ export interface PropDeclaration {
     /**
      * 隐藏绑定属性按钮
      */
-    bindHide: boolean;
+    bindHide?: boolean;
     /**
      * 绑定属性并打开弹窗
      */
-    bindOpen: boolean;
+    bindOpen?: boolean;
     /**
      * 所在的 tab 页
      */
-    tabKind: 'property' | 'style';
+    tabKind?: 'property' | 'style';
     /**
      * 属性设置器
      */
-    setter: BaseSetter;
+    setter?: BaseSetter;
     /**
      * 属性在面板中的布局方式
      *
      * block 表示标题与设置器分行展示；inline 表示同一行展示
      */
-    layout: 'block' | 'inline';
+    layout?: 'block' | 'inline';
     /**
      * 默认值
      */
@@ -483,6 +494,12 @@ export interface TypeAnnotation {
      * 规则对象
      */
     ruleMap?: Record<string, number>;
+    /**
+     * 是否同步
+     *
+     * 仅在kind=function时生效，值不是true时表示返回类型视为Promise<...>
+     */
+    sync?: boolean;
 }
 
 /**
@@ -591,7 +608,7 @@ export interface SlotDeclaration {
     /**
      * 插槽代码块
      */
-    snippets: Array<ViewBlockWithImage>;
+    snippets?: Array<ViewBlockWithImage>;
 }
 
 /**
@@ -672,11 +689,11 @@ export interface ViewBlockWithImage {
     /**
      * 截图
      */
-    screenshot: string;
+    screenshot?: string;
     /**
      * 手绘
      */
-    drawing: string;
+    drawing?: string;
 }
 
 /**
@@ -712,6 +729,10 @@ export interface LogicDeclaration {
      * 输出参数列表
      */
     returns: Array<Return>;
+    /**
+     * 是否同步执行
+     */
+    sync?: boolean;
 }
 
 /**

package/nasl.ui.ast.schema.json

@@ -117,10 +117,7 @@
             "required": [
                 "concept",
                 "name",
-                "kebabName",
                 "title",
-                "group",
-                "icon",
                 "props",
                 "readableProps",
                 "events",
@@ -190,10 +187,6 @@
                     "type": "boolean",
                     "description": "允许该组件在逻辑中设置"
                 },
-                "isDataSource": {
-                    "type": "boolean",
-                    "description": "该属性是否为数据源"
-                },
                 "tooltipLink": {
                     "type": "string",
                     "description": "工具提示链接"
@@ -255,14 +248,7 @@
                 "concept",
                 "name",
                 "title",
-                "group",
-                "tsType",
-                "sync",
-                "bindHide",
-                "bindOpen",
-                "tabKind",
-                "setter",
-                "layout"
+                "tsType"
             ],
             "additionalProperties": false,
             "description": "组件属性"
@@ -301,6 +287,9 @@
                 },
                 {
                     "$ref": "#/definitions/AnonymousFunctionSetter"
+                },
+                {
+                    "$ref": "#/definitions/DataSourceSetter"
                 }
             ],
             "description": "设置器基类"
@@ -628,6 +617,28 @@
             "additionalProperties": false,
             "description": "匿名函数设置器"
         },
+        "DataSourceSetter": {
+            "type": "object",
+            "properties": {
+                "concept": {
+                    "type": "string",
+                    "const": "DataSourceSetter"
+                },
+                "changedTime": {
+                    "type": "number",
+                    "description": "节点变更时间"
+                },
+                "placeholder": {
+                    "type": "string",
+                    "description": "占位文本"
+                }
+            },
+            "required": [
+                "concept"
+            ],
+            "additionalProperties": false,
+            "description": "数据源设置器"
+        },
         "DefaultValue": {
             "type": "object",
             "properties": {
@@ -779,6 +790,10 @@
                         "type": "number"
                     },
                     "description": "规则对象"
+                },
+                "sync": {
+                    "type": "boolean",
+                    "description": "是否同步\n\n仅在kind=function时生效，值不是true时表示返回类型视为Promise<...>"
                 }
             },
             "required": [
@@ -1114,8 +1129,7 @@
                 "name",
                 "title",
                 "tsType",
-                "params",
-                "snippets"
+                "params"
             ],
             "additionalProperties": false,
             "description": "插槽"
@@ -1194,9 +1208,7 @@
             "required": [
                 "concept",
                 "title",
-                "code",
-                "screenshot",
-                "drawing"
+                "code"
             ],
             "additionalProperties": false,
             "description": "带截图的代码块"
@@ -1244,6 +1256,10 @@
                         "$ref": "#/definitions/Return"
                     },
                     "description": "输出参数列表"
+                },
+                "sync": {
+                    "type": "boolean",
+                    "description": "是否同步执行"
                 }
             },
             "required": [

package/nasl.ui.options.d.ts

@@ -4,7 +4,7 @@ declare namespace nasl.ui {
     /**
      * 设置器基类
      */
-    export type BaseSetter<T extends object, K extends keyof T> = CustomSetter | InputSetter | SwitchSetter | EnumSelectSetter<T, K> | CapsulesSetter<T, K> | NumberInputSetter | IconSetter | ImageSetter | PropertySelectSetter | PropertyTransformSetter | AnonymousFunctionSetter;
+    export type BaseSetter<T extends object, K extends keyof T> = CustomSetter | InputSetter | SwitchSetter | EnumSelectSetter<T, K> | CapsulesSetter<T, K> | NumberInputSetter | IconSetter | ImageSetter | PropertySelectSetter | PropertyTransformSetter | AnonymousFunctionSetter | DataSourceSetter;
 
     /**
      * 自定义属性设置器
@@ -156,6 +156,17 @@ declare namespace nasl.ui {
 
     }
 
+    /**
+     * 数据源设置器
+     */
+    export interface DataSourceSetter {
+        concept: 'DataSourceSetter';
+        /**
+         * 占位文本
+         */
+        placeholder?: string;
+    }
+
     /**
      * 页面组件
      */
@@ -214,10 +225,6 @@ declare namespace nasl.ui {
          * 允许该组件在逻辑中设置
          */
         settable?: boolean;
-        /**
-         * 该属性是否为数据源
-         */
-        isDataSource?: boolean;
         /**
          * 工具提示链接
          */
@@ -336,6 +343,10 @@ declare namespace nasl.ui {
          * 逻辑描述
          */
         description: string;
+        /**
+         * 是否同步执行
+         */
+        sync?: boolean;
     }
 
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nasl/types",
-    "version": "0.1.14",
+    "version": "0.2.0",
     "description": "NASL types for TypeScript Declaration",
     "main": "index.d.ts",
     "scripts": {