@nasl/types 0.2.0 → 0.2.2

package/index.d.ts

@@ -4,3 +4,4 @@
 /// <reference path="nasl.ui.d.ts" />
 /// <reference path="nasl.ui.options.d.ts" />
 /// <reference path="nasl.ui.decorators.d.ts" />
+/// <reference path="nasl.io.d.ts" />

package/nasl.io.d.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/naming-convention */
 /* eslint-disable lines-between-class-members */
 declare namespace nasl.io {
     export class FileInfo {
@@ -8,5 +9,7 @@ declare namespace nasl.io {
         type: nasl.core.String;
     }
 
-    export class File {}
+    export class File {
+        __name: 'File';
+    }
 }

package/nasl.ui.ast.d.ts

@@ -413,6 +413,24 @@ export interface PropDeclaration {
      * 渲染时的设计值
      */
     tsDesignerValue?: string;
+    /**
+     * 是否隐藏
+     *
+     * 标记该功能在 IDE 面板中不展示，优先级高于 if
+     */
+    hidden?: boolean;
+    /**
+     * 废弃说明
+     *
+     * 标记该功能已废弃，可以说明被哪些新的 API 取代
+     */
+    deprecation?: string;
+    /**
+     * 是否按字面量类型检查
+     *
+     * 当属性类型为 string、boolean 或 number literal 时，为 true 则按字面量类型严格检查，默认 false 按通用基础类型处理
+     */
+    checkLiteralType?: boolean;
     /**
      * 是否显隐
      *
@@ -562,6 +580,18 @@ export interface EventDeclaration {
      * 组件事件描述
      */
     description?: string;
+    /**
+     * 是否隐藏
+     *
+     * 标记该功能在 IDE 面板中不展示
+     */
+    hidden?: boolean;
+    /**
+     * 废弃说明
+     *
+     * 标记该功能已废弃，可以说明被哪些新的 API 取代
+     */
+    deprecation?: string;
     /**
      * 类型
      *
@@ -591,6 +621,18 @@ export interface SlotDeclaration {
      * 插槽描述
      */
     description?: string;
+    /**
+     * 是否隐藏
+     *
+     * 标记该功能在 IDE 面板中不展示
+     */
+    hidden?: boolean;
+    /**
+     * 废弃说明
+     *
+     * 标记该功能已废弃，可以说明被哪些新的 API 取代
+     */
+    deprecation?: string;
     /**
      * 类型
      *
@@ -717,6 +759,18 @@ export interface LogicDeclaration {
      * 逻辑描述
      */
     description: string;
+    /**
+     * 是否隐藏
+     *
+     * 标记该功能在 IDE 面板中不展示
+     */
+    hidden?: boolean;
+    /**
+     * 废弃说明
+     *
+     * 标记该功能已废弃，可以说明被哪些新的 API 取代
+     */
+    deprecation?: string;
     /**
      * 类型参数列表
      */

package/nasl.ui.ast.schema.json

@@ -231,6 +231,18 @@
                     "type": "string",
                     "description": "渲染时的设计值"
                 },
+                "hidden": {
+                    "type": "boolean",
+                    "description": "是否隐藏\n\n标记该功能在 IDE 面板中不展示，优先级高于 if"
+                },
+                "deprecation": {
+                    "type": "string",
+                    "description": "废弃说明\n\n标记该功能已废弃，可以说明被哪些新的 API 取代"
+                },
+                "checkLiteralType": {
+                    "type": "boolean",
+                    "description": "是否按字面量类型检查\n\n当属性类型为 string、boolean 或 number literal 时，为 true 则按字面量类型严格检查，默认 false 按通用基础类型处理"
+                },
                 "tsIf": {
                     "type": "string",
                     "description": "是否显隐\n\n用 TS 写表达式，在 IDE 中直接 eval"
@@ -1064,6 +1076,14 @@
                     "type": "string",
                     "description": "组件事件描述"
                 },
+                "hidden": {
+                    "type": "boolean",
+                    "description": "是否隐藏\n\n标记该功能在 IDE 面板中不展示"
+                },
+                "deprecation": {
+                    "type": "string",
+                    "description": "废弃说明\n\n标记该功能已废弃，可以说明被哪些新的 API 取代"
+                },
                 "tsType": {
                     "type": "string",
                     "description": "类型\n\n直接写 TS 类型，这里是个函数类型"
@@ -1101,6 +1121,14 @@
                     "type": "string",
                     "description": "插槽描述"
                 },
+                "hidden": {
+                    "type": "boolean",
+                    "description": "是否隐藏\n\n标记该功能在 IDE 面板中不展示"
+                },
+                "deprecation": {
+                    "type": "string",
+                    "description": "废弃说明\n\n标记该功能已废弃，可以说明被哪些新的 API 取代"
+                },
                 "tsType": {
                     "type": "string",
                     "description": "类型\n\n直接写 TS 类型"
@@ -1236,6 +1264,14 @@
                     "type": "string",
                     "description": "逻辑描述"
                 },
+                "hidden": {
+                    "type": "boolean",
+                    "description": "是否隐藏\n\n标记该功能在 IDE 面板中不展示"
+                },
+                "deprecation": {
+                    "type": "string",
+                    "description": "废弃说明\n\n标记该功能已废弃，可以说明被哪些新的 API 取代"
+                },
                 "typeParams": {
                     "type": "array",
                     "items": {

package/nasl.ui.options.d.ts

@@ -233,10 +233,6 @@ declare namespace nasl.ui {
          * 文档描述
          */
         docDescription?: string;
-        /**
-         * 隐藏绑定属性按钮
-         */
-        bindHide?: boolean;
         /**
          * 绑定属性并打开弹窗
          */
@@ -259,6 +255,18 @@ declare namespace nasl.ui {
          * 渲染时的设计值
          */
         designerValue?: any;
+        /**
+         * 是否隐藏
+         *
+         * 标记该功能在 IDE 面板中不展示，优先级高于 if
+         */
+        hidden?: boolean;
+        /**
+         * 废弃说明
+         *
+         * 标记该功能已废弃，可以说明被哪些新的 API 取代
+         */
+        deprecation?: string;
         /**
          * 是否显隐
          *
@@ -293,6 +301,28 @@ declare namespace nasl.ui {
          * 仅在属性类型为 string（不包括字符串枚举）的情况下，且 sync 为 falsy 时可配置
          */
         implicitToString?: T[K] extends string ? (string extends T[K] ? boolean : never) : never;
+    }) & ({
+        /**
+         * 隐藏绑定属性按钮
+         */
+        bindHide: true;
+        /**
+         * 是否按字面量类型检查
+         *
+         * 当属性类型为 string、boolean 或 number literal 时，为 true 则按字面量类型严格检查，默认 false 按通用基础类型处理
+         */
+        checkLiteralType: true;
+    } | {
+        /**
+         * 隐藏绑定属性按钮
+         */
+        bindHide?: boolean;
+        /**
+         * 是否按字面量类型检查
+         *
+         * 当属性类型为 string、boolean 或 number literal 时，为 true 则按字面量类型严格检查，默认 false 按通用基础类型处理
+         */
+        checkLiteralType?: false;
     })
 
     /**
@@ -307,6 +337,18 @@ declare namespace nasl.ui {
          * 组件事件描述
          */
         description?: string;
+        /**
+         * 是否隐藏
+         *
+         * 标记该功能在 IDE 面板中不展示
+         */
+        hidden?: boolean;
+        /**
+         * 废弃说明
+         *
+         * 标记该功能已废弃，可以说明被哪些新的 API 取代
+         */
+        deprecation?: string;
     }
 
     /**
@@ -321,6 +363,18 @@ declare namespace nasl.ui {
          * 插槽描述
          */
         description?: string;
+        /**
+         * 是否隐藏
+         *
+         * 标记该功能在 IDE 面板中不展示
+         */
+        hidden?: boolean;
+        /**
+         * 废弃说明
+         *
+         * 标记该功能已废弃，可以说明被哪些新的 API 取代
+         */
+        deprecation?: string;
         /**
          * 空的占位图
          */
@@ -343,6 +397,18 @@ declare namespace nasl.ui {
          * 逻辑描述
          */
         description: string;
+        /**
+         * 是否隐藏
+         *
+         * 标记该功能在 IDE 面板中不展示
+         */
+        hidden?: boolean;
+        /**
+         * 废弃说明
+         *
+         * 标记该功能已废弃，可以说明被哪些新的 API 取代
+         */
+        deprecation?: string;
         /**
          * 是否同步执行
          */

package/package.json

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