@lcap/nasl 3.2.0-beta.4 → 3.3.0-alpha

package/out/server/naslServer.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { Worker } from 'worker_threads';
-import Messager from '../common/Messager';
 import * as tsProtocol from 'typescript/lib/protocol';
+import Messager from '../common/Messager';
 import { Module, BaseNode, App, Structure, Logic, TypeAnnotation, View, Param, Argument, ViewElement, CallInterface, Connector } from '../concepts';
 import { SourceMap, SourceMapItem } from '../translator';
 import { MinRange } from './translator';
@@ -11,8 +11,8 @@ import { EventEmitter } from '../common/EventEmitter';
 export interface FileNode extends BaseNode {
     getEmbeddedFilePath(name?: string): string;
     toEmbeddedTSFile(): {
-        code: string;
         filePath: string;
+        code: string;
         sourceMap: SourceMap;
     };
 }
@@ -52,7 +52,7 @@ declare class NaslServer {
     singleFileChangeIng: Boolean;
     logicSetWithComponentLogic: Set<string>;
     constructor();
-    start(): Promise<unknown>;
+    start(): Promise<void>;
     terminate(): void;
     createUiTs(allComponent: any): Promise<void>;
     contentToFile(module: Module | App | Connector, results: Array<ReturnType<Structure['toEmbeddedTSFile']>>): void;
@@ -60,38 +60,38 @@ declare class NaslServer {
     openApp(app: App): Promise<void>;
     refreshApp(app: App): Promise<void>;
     /**
- * 初始化之前添加文件
- */
+     * 初始化之前添加文件
+     */
     addFile(file: tsProtocol.OpenRequestArgs, { cache }?: {
         cache?: boolean;
-    }): Promise<unknown>;
+    }): Promise<void>;
     cacheFile(options: tsProtocol.OpenRequestArgs): void;
-    /**u
- * 只新增文件
- * @param {*} files
- */
-    writeFiles(files: Array<tsProtocol.OpenRequestArgs>): Promise<unknown>;
+    /** u
+     * 只新增文件
+     * @param {*} files
+     */
+    writeFiles(files: Array<tsProtocol.OpenRequestArgs>): Promise<void>;
     /**
- * 新增、修改
- * 删除文件 文件用修改内容为空模拟，防止报错
- * @param {*} args
- */
+     * 新增、修改
+     * 删除文件 文件用修改内容为空模拟，防止报错
+     * @param {*} args
+     */
     updateFiles(args: {
         outputFiles: Array<tsProtocol.OpenRequestArgs>;
-    }): Promise<unknown>;
+    }): Promise<void>;
     /**
- * 清除一个目录下的所有文件
- */
+     * 清除一个目录下的所有文件
+     */
     deleteDirectoryFiles(args: {
         directoryName: string;
-    }): Promise<unknown>;
+    }): Promise<void>;
     _debugInFileStorage(node: BaseNode, openFiles: Array<tsProtocol.OpenRequestArgs>): Promise<void>;
-    open(): Promise<unknown>;
-    updateOpen(args: tsProtocol.UpdateOpenRequestArgs): Promise<unknown>;
-    fileReferences(filePath: string): Promise<unknown>;
+    open(): Promise<void>;
+    updateOpen(args: tsProtocol.UpdateOpenRequestArgs): Promise<void>;
+    fileReferences(filePath: string): Promise<void>;
     references(args: tsProtocol.FileLocationRequestArgs): Promise<tsProtocol.ReferencesResponseBody>;
-    getValueSelectCompletion(node: BaseNode, value: string, noFilterList?: Array<string>): Promise<unknown>;
-    _getValueSelectCompletion(args: any): Promise<unknown>;
+    getValueSelectCompletion(node: BaseNode, value: string, noFilterList?: Array<string>): Promise<void>;
+    _getValueSelectCompletion(args: any): Promise<void>;
     /**
      * 获取 Convert 的可选类型
      * @param node 传入当前已经选择的变量
@@ -110,10 +110,10 @@ declare class NaslServer {
     getDataSchemaType(node: BaseNode, allType?: boolean): Promise<string>;
     getDataSchemaStructureOrTypeAnnotation(node: ViewElement): Promise<any>;
     /**
- * ts的 quickInfo方法，查询指定位置的详情
- * @param args 文件信息数组
- * @returns 查询到的
- */
+     * ts的 quickInfo方法，查询指定位置的详情
+     * @param args 文件信息数组
+     * @returns 查询到的
+     */
     _getTypeQuickinfo(args: any): {
         responseRequired: boolean;
         response: tsProtocol.QuickInfoResponseBody;
@@ -149,23 +149,17 @@ declare class NaslServer {
         response: tsProtocol.QuickInfoResponseBody;
     }>;
     /**
- * 获取已经选中的内容的 下一级的内容
- * @param node 已经选中的内容
- * @param noFilterList 不过滤的key 的数据
- * @returns 可以选择的数据数组
- */
-    getSelectNextCompletion(node: BaseNode, noFilterList?: Array<string>): Promise<unknown>;
-    _getSelectNextCompletion(args: any): Promise<unknown>;
-    /**
-     * 获取诊断信息
-     * @param fileNames 多个文件名
-     * @returns 诊断结果
+     * 获取已经选中的内容的 下一级的内容
+     * @param node 已经选中的内容
+     * @param noFilterList 不过滤的key 的数据
+     * @returns 可以选择的数据数组
      */
-    getDiagnosticRecords(fileNames?: Array<string>): Promise<Array<DiagnosticRecord>>;
+    getSelectNextCompletion(node: BaseNode, noFilterList?: Array<string>): Promise<void>;
+    _getSelectNextCompletion(args: any): Promise<void>;
     getDiagnosticRecordsAndPushAll(fileNames?: Array<string>): Promise<void>;
     /**
- * 节点异常是只能挂载单个，如果已经了就不赋值了
- */
+     * 节点异常是只能挂载单个，如果已经了就不赋值了
+     */
     baseNodeAssignmentTsError(node: BaseNode, tsErrorDetail: Diagnostic): void;
     /**
      * 处理诊断结果
@@ -184,12 +178,23 @@ declare class NaslServer {
      */
     _attachSuggestionDiagnostics(fileNode: BaseNode): Diagnostic[];
     hasComponentLogics(expression: BaseNode): boolean;
+    /** 是否被 触发器依赖, 如果存在，返回第一个触发器对应的名称 */
+    isRefedByTriggerAndReturnFirstRef(fileNode: BaseNode): Promise<{
+        isRefedByTrigger: boolean;
+        fRefName: string;
+    }>;
+    /**
+     * 是否符合 触发器规则
+     * 规则：
+     * 1. 入参仅有一个，且必须为string类型
+     */
+    isTriggerRule(fileNode: BaseNode): boolean;
     /**
- * 额外的诊断
- * @param fileNode 文件级别的节点
- * @returns 诊断结果
- */
-    _attachDiagnostics(fileNode: BaseNode): Diagnostic[];
+     * 额外的诊断
+     * @param fileNode 文件级别的节点
+     * @returns 诊断结果
+     */
+    _attachDiagnostics(fileNode: BaseNode): Promise<Diagnostic[]>;
     checkNodeError(node: BaseNode, diagnostics: Diagnostic[]): any;
     /**
      * 判断当前CallInterface 对应的 Interface 是否含有鉴权方式
@@ -197,18 +202,18 @@ declare class NaslServer {
     hasAuth(node: CallInterface): boolean;
     existStructureFix(semanticDiagnostics: Diagnostic[], node: FileNode, that: any): void;
     /**
- * 单个问题的诊断处理
- * @param diagnostic 诊断问题
- * @param fileNode 页面节点
- * @returns 处理后的结果
- */
+     * 单个问题的诊断处理
+     * @param diagnostic 诊断问题
+     * @param fileNode 页面节点
+     * @returns 处理后的结果
+     */
     _resolveDiagnostic(diagnostic: tsProtocol.DiagnosticWithFileName, fileNode: FileNode, record: DiagnosticRecord): Diagnostic;
     /**
- * 通过节点诊断反过来查找节点
- * @param diagnostic 诊断信息
- * @param fileNode 文件级别节点
- * @returns 找到的节点
- */
+     * 通过节点诊断反过来查找节点
+     * @param diagnostic 诊断信息
+     * @param fileNode 文件级别节点
+     * @returns 找到的节点
+     */
     _findMinRange(diagnostic: tsProtocol.DiagnosticWithFileName | tsProtocol.ReferencesResponseItem, fileNode: FileNode): MinRange;
     /**
      * 查看当前节点是不是有引用
@@ -217,13 +222,13 @@ declare class NaslServer {
      */
     _isHaveRef(node: BaseNode): Promise<tsProtocol.ReferencesResponseItem[]>;
     /**
- * 查找引用，并且做一些 修改前的准备工作，
- * 有引用有的话，就返回集合
- * @param node 当前重命名的节点
- * @param newValue 传递过来的新值，给MemberExpression用的比较特殊
- * 而且，这个新值不一定会用到，MemberExpression在批量更新的时候，可以取到新的value， 这里需要位置信息防止 a.a.a.a 中的一个a发生修改
- * @returns 找到的引用
- */
+     * 查找引用，并且做一些 修改前的准备工作，
+     * 有引用有的话，就返回集合
+     * @param node 当前重命名的节点
+     * @param newValue 传递过来的新值，给MemberExpression用的比较特殊
+     * 而且，这个新值不一定会用到，MemberExpression在批量更新的时候，可以取到新的value， 这里需要位置信息防止 a.a.a.a 中的一个a发生修改
+     * @returns 找到的引用
+     */
     _renamePrepare(node: BaseNode, refsList: any[], newValue: string): RenameMinRange[];
     _addParamsEffect(refsList: any[], node: Param): void;
     _addParamsPrepare(node: BaseNode, refsList: any[], needAdd?: boolean): BaseNode;
@@ -232,23 +237,23 @@ declare class NaslServer {
     _getTreeMap(minRange: MinRange, fileNode: BaseNode, resMap: Map<BaseNode, Array<Array<QuoteNode>>>, nodeMap: Map<BaseNode, QuoteNode>): void;
     handleTreeMap(resMap: Map<BaseNode, Array<Array<QuoteNode>>>): Map<any, any>;
     /**
- * 处理tree的队列，把相同节点进行合并
- * 这里把当前二维数组进行一个整合
- * @param arr 当前页面下的queue的二维数组，一个数组下有多条链路
- * @returns 最后要使用到的节点和对应的子集
- */
+     * 处理tree的队列，把相同节点进行合并
+     * 这里把当前二维数组进行一个整合
+     * @param arr 当前页面下的queue的二维数组，一个数组下有多条链路
+     * @returns 最后要使用到的节点和对应的子集
+     */
     handleTreeQueue(queueLists: Array<Array<QuoteNode>>): QuoteNode;
     /**
- * 递归调用输出结果
- * @param root 一个根节点
- * @param map 当前所有节点的map对象
- * @returns 当前节点，最后输出所有节点
- */
+     * 递归调用输出结果
+     * @param root 一个根节点
+     * @param map 当前所有节点的map对象
+     * @returns 当前节点，最后输出所有节点
+     */
     _recursionCreateResult(root: QuoteNode, map: Map<QuoteNode, Array<QuoteNode>>): QuoteNode;
     /**
- *  获取
- *  当前this上下文 的Source 和 父级文件级别的节点
- */
+     *  获取
+     *  当前this上下文 的Source 和 父级文件级别的节点
+     */
     getCurrentSource(node: BaseNode): {
         currentSource: SourceMapItem;
         fileNode: BaseNode;
@@ -257,8 +262,8 @@ declare class NaslServer {
         currentSource?: undefined;
     };
     handlingCurrentSourceException(currentSource: SourceMapItem, node: BaseNode): void;
-    getFieldKeySelectCompletion(node: BaseNode, fieldKey?: string): Promise<unknown>;
-    _getFieldKeySelectCompletion(args: any): Promise<unknown>;
+    getFieldKeySelectCompletion(node: BaseNode, fieldKey?: string): Promise<void>;
+    _getFieldKeySelectCompletion(args: any): Promise<void>;
     /**
      * 获取模块下多个CallInterface 被依赖的页面节点
      * 查找callInterface 被依赖的页面级别的节点，要让他们重新生成一次代码，因为多个Interface重新导入，需要查找到引用的额内容
@@ -274,10 +279,10 @@ declare class NaslServer {
      * @returns 查找到的有引用这个内容的页面级别节点
      */
     findCallLogicFileRef(logic: Logic): Promise<BaseNode[]>;
-    /**获取当前节点的已知类型
- * @param node 当前要获取类型的节点
- * @returns 不需要去查就可以返回类型的节点
- */
+    /** 获取当前节点的已知类型
+     * @param node 当前要获取类型的节点
+     * @returns 不需要去查就可以返回类型的节点
+     */
     getCurrentNodeKnownTypeAnnotation(node: BaseNode): TypeAnnotation;
     /**
      * 获取传入节点的TypeAnnotation
@@ -298,10 +303,10 @@ declare class NaslServer {
         option: any;
     }>, json: {}): void;
     /**
- * 获取getArgument的参数位的类型
- * 如果内部表达式的，就用表达式的，如果没有就试试用默认值的
- * 获取logic的默认值和原来Arg的类型和默认值对应
- */
+     * 获取getArgument的参数位的类型
+     * 如果内部表达式的，就用表达式的，如果没有就试试用默认值的
+     * 获取logic的默认值和原来Arg的类型和默认值对应
+     */
     getArgumentTypeAnnotation(node: Argument, QuickInfoNodes: QuickInfoNodes, types: Map<BaseNode, TypeAnnotation>): {
         typeAnnotation: TypeAnnotation;
         option: {
@@ -341,13 +346,13 @@ declare class NaslServer {
      */
     handleChange(fileNode: BaseNode, targetNode: BaseNode, result: ReturnType<Structure['toEmbeddedTSFile']>, action: string): Promise<void>;
     /**
- * 重命名的更新
- * @param fileNode 文件级别的节点
- * @param targetNode 触发修改的节点
- * @param result 生成代码的code 和位置信息
- * @param isRename 是不是修改名字
- * @param oldFilePath 如果是改名，文件级别的才会有这个参数，用于文件新增替换
- */
+     * 重命名的更新
+     * @param fileNode 文件级别的节点
+     * @param targetNode 触发修改的节点
+     * @param result 生成代码的code 和位置信息
+     * @param isRename 是不是修改名字
+     * @param oldFilePath 如果是改名，文件级别的才会有这个参数，用于文件新增替换
+     */
     handleRename(fileNode: BaseNode, targetNode: BaseNode, result: ReturnType<Structure['toEmbeddedTSFile']>, oldFilePath?: string): Promise<void>;
     /**
      * 处理一些节点操作，子节点需要更新并且check的场景