@lcap/nasl 3.6.0-alpha.7 → 3.6.0-alpha.8

package/out/common/BaseNode.d.ts

@@ -0,0 +1,377 @@
+import { SourceMap } from '../translator';
+import { EventEmitter, EventPayload, Params } from './EventEmitter';
+import { Diagnostic } from '../manager/diagnostic';
+import type { TypeAnnotation, App } from '../concepts';
+import * as types from '../concepts/utils/types';
+export declare function setActionable(value: boolean): void;
+declare type NodePathOption = {
+    useName?: boolean;
+};
+/**
+ * 顶点类
+ * 属性均为只读，仅在初始化和 load 的情况下可以修改
+ */
+export declare class BaseNode extends EventEmitter {
+    static readonly ConceptName: string;
+    static readonly inheritanceChain: string[];
+    /**
+     * 可修改标志，内部属性
+     * 标记在构造函数结束后是否可修改
+     */
+    _mutable: boolean;
+    /** 节点类别缓存 */
+    private _concept;
+    /**
+     * 概念
+     */
+    get concept(): string;
+    set concept(val: string);
+    /**
+     * toJSON 时需要去除的键，为了避免出现 CircularJSON
+     */
+    readonly JSON_EXCLUDED_KEYS: Set<string>;
+    /**
+     * 唯一 Id
+     */
+    id: string;
+    /**
+     * 变动时间
+     */
+    changedTime: number;
+    /**
+     * 分支名称
+     */
+    branchName: string;
+    /**
+     * 合并代码相关
+     */
+    workingCopy: object;
+    branch: object;
+    /**
+     * 断点状态
+     * undefined ==> 未设置
+     * null ==> 已删除
+     * 'ENABLED' ==> 启用断点
+     * 'DISABLED' ==> 禁用断点
+     */
+    breakpoint: 'ENABLED' | 'DISABLED' | null | undefined;
+    /**
+     * 父节点
+     */
+    parentNode: types.SyntaxNode;
+    parentKey: string;
+    /**
+     * 是否正在编辑
+     * 前端 UI 状态
+     */
+    editable: boolean;
+    /**
+     * 是否可以删除
+     * 前端 UI 状态
+     */
+    removable: boolean;
+    /**
+     * 是否正在请求
+     * 前端 UI 状态
+     */
+    loading: boolean;
+    /**
+     * 节点是否为展开状态
+     * 前端 UI 状态
+     */
+    expanded: boolean;
+    /**
+     * 节点是否显示
+     * 前端 UI 状态
+     */
+    hidden: boolean;
+    /**
+     * 页面树节点是否显示
+     * 前端 UI 状态
+     */
+    pageTreeNodeHidden: boolean;
+    /**
+     * 逻辑树节点是否显示
+     * 前端 UI 状态
+     */
+    logicTreeNodeHidden: boolean;
+    /**
+     * 数据树节点是否显示
+     * 前端 UI 状态
+     */
+    dataTreeNodeHidden: boolean;
+    /**
+   * 数据树节点是否显示
+   * 前端 UI 状态
+   */
+    processTreeNodeHidden: boolean;
+    /**
+     * 数据树节点是否展开
+     * 前端 UI 状态
+     */
+    logicTreeNodeExpanded: boolean;
+    /**
+     * 用于挂 embeddedTS 的 sourceMap
+     */
+    sourceMap: SourceMap;
+    /**
+     * 是否为叶子节点
+     * 前端 UI 状态
+     */
+    isLeaf: boolean;
+    storageJSON: any;
+    /**
+     * 当前节点上报错详细信息
+     */
+    tsErrorDetail: Diagnostic | undefined;
+    /**
+     * 组件属性名称
+     */
+    name: string;
+    /**
+     * 应用内节点的分组管理机制
+     * 暂无明确的名称定义要求，只要求唯一即可，建议使用时第一个分组给一个root分组
+     */
+    composedBy?: Array<string>;
+    /**
+     * 当前节点的类型标注
+     */
+    __TypeAnnotation: TypeAnnotation;
+    /**
+     * 当前节点的类型标注是不是正确的
+     */
+    __isCorrectTypeAnnotation: boolean;
+    /**
+     * @param source 需要合并的部分参数
+     */
+    constructor(source?: Partial<BaseNode>);
+    subConstructor(source?: Partial<BaseNode>): void;
+    fixInstantiate(): void;
+    getIndexOfParent(): number;
+    /**
+     * 为存储点生成行为监听器
+     * @param action
+     * @returns
+     */
+    genActionListener($event: EventPayload): void;
+    nodeEditing($event: EventPayload): void;
+    createNode({ parentNode, parentKey, index }: {
+        parentNode: types.SyntaxNode;
+        parentKey: string;
+        index: number;
+    }): void;
+    toTemplateJSON(): any;
+    /**
+     * 创建节点
+     */
+    create(parentParams: Params): void;
+    /**
+     * 如果有父节点，则删除节点，在添加时调用
+     */
+    ensureDelete(): void;
+    /**
+     * 删除节点
+     */
+    delete(): void;
+    /**
+     * 更新节点
+     */
+    update({ field, ...object }: any): void;
+    collectOldObject(params: any): void;
+    collectNewObject(params: any): void;
+    ensureDefined(params: any): any;
+    updateInstance(object: any): void;
+    _delete(): Params;
+    static from(source: any, parentNode?: BaseNode, parentKey?: string): BaseNode;
+    get nodePath(): string;
+    getNodePath(useIndex: boolean): string;
+    getNodePath(useIndexKeys: string[]): string;
+    getNodePath(option: NodePathOption): string;
+    /**
+     * 上层节点
+     */
+    get upperNode(): types.SyntaxNode;
+    /**
+     * 根节点
+     */
+    get rootNode(): App;
+    /**
+     * 获取祖先节点
+     */
+    getAncestor(concept: types.SyntaxNode['concept']): types.SyntaxNode;
+    getAncestor<Node extends types.SyntaxNode>(concept: Node['concept']): Node;
+    /**
+     *
+     * @param source
+     * @param Ctor
+     * @param completeList
+     * @param idsList
+     */
+    handleSource(source: any, completeList: any[]): void;
+    /**
+     * 获取当前的TsName
+     */
+    get tsName(): string;
+    __editing: boolean;
+    get editing(): boolean;
+    set editing(value: boolean);
+    /**
+     * 生成json
+     * @param instance
+     * @param Ctor
+     */
+    genSources(instance: BaseNode, filerFn?: (source: Partial<BaseNode>) => {}): any;
+    /**
+     * 实例化一个 JSON
+     * 由于有 from，只能先实例化父级，再实例化子级
+     * @param obj
+     * @param parentNode
+     * @returns
+     */
+    instantiate(source: any, parentNode: BaseNode, parentKey: string): any;
+    /**
+     * 激活 JSON 内部实例
+     * @param source
+     */
+    instantiateSub(source: any, parentKey: string): any;
+    plainAssign(source: any): void;
+    pick(source: any, keys?: Array<string>): void;
+    /**
+     * 从对象中深度获取
+     * @param source
+     * @param keys
+     * @example 比如一般后端返回只是添加了个 id
+     * ```
+     * this.deepPick(result, ['id'])
+     */
+    deepPick(source: any, keys?: Array<string>): void;
+    /**
+     * 去除循环依赖，转为纯 JSON
+     * @param parentKey 外面的 key，提供给 JSON.stringify 使用
+     * @param excludedKeys 需要额外排除的 keys
+     */
+    toJSON(): any;
+    _toJSON(filerFn?: (source: Partial<BaseNode>) => {}): any;
+    /**
+     * 转为单层的 JSON
+     * @param parentKey 外面的 key，提供给 JSON.stringify 使用
+     * @param excludedKeys 需要额外排除的 keys
+     */
+    toPlainJSON(parentKey?: string, excludedKeys?: Array<string>): any;
+    getNodeChinesePath(useIndex: boolean | string[] | NodePathOption): string;
+    /**
+     * 查找引用
+     */
+    findUsage(): Promise<any>;
+    /**
+     * 通过当前节点，查找被引用的节点
+     */
+    nodeFindRefNodes(): Promise<any>;
+    findReadOnlyLogicUsage(): Promise<any>;
+    /**
+     * 重命名
+     */
+    changeName(newValue: string, updateAll?: boolean): Promise<any>;
+    /**
+     * 移除绑定实体元素的页面元素
+     */
+    removeBindEntityPropertyViewEelment(): Promise<any>;
+    /**
+     * 准备删除
+     */
+    prepareDelete(cb?: Function): Promise<any>;
+    /**
+     * 添加参数准备
+     */
+    addParamsPrepare(): Promise<any>;
+    /**
+     * 获取当前节点类型
+     */
+    getCurrentTypeAnnotation(): Promise<any>;
+    /**
+     * 获取当前节点的下一级内容
+     */
+    getSelectRef(newTypeAnnotation: TypeAnnotation, needNewStructure?: boolean): any;
+    /**
+     * 销毁
+     * 从 Map 中删除点和子节点
+     */
+    destroy(): void;
+    onChange($event?: EventPayload): void;
+    onCreate($event?: any): void;
+    onDelete($event?: any): void;
+    /**
+     * 移动节点
+     * @param sourceNode
+     * @param position
+     */
+    moveNode(options: {
+        sourceNode: BaseNode;
+        position: 'append' | 'insertBefore' | 'insertAfter';
+        action?: string;
+    }): void;
+    replaceNode(newNode: any): void;
+    updateRelyFileNode(app: any): Promise<void>;
+    /**
+     * 获取添加时的默认选项
+     * @returns
+     */
+    static getDefaultOptions(): any;
+    /**
+     * 迭代所有属性
+     *
+     * @description 是所有属性！！不是所有子节点！！
+     * @deprecated 请使用`traverseStrictChildren`方法
+     */
+    traverseChildren(cb: (el: any) => void): void;
+    /**
+     * 生成器中序遍历节点
+     *
+     * @description 与`traverseChildren`不同，此方法会过滤掉非节点值
+     */
+    traverseChildrenGenerator(cb: (node: types.SyntaxNode) => (void | Generator<any, any, any>)): Generator<any, void, any>;
+    /**
+     * 迭代所有子节点
+     *
+     * @description 严格迭代所有子节点！排除属性！
+     */
+    traverseStrictChildren(cb: (el: types.SyntaxNode) => void): void;
+    /**
+     *  获取当前节点在nasl标注节点上的节点
+     */
+    getCurrentAnnotatedJSON(): TypeAnnotation;
+    /**
+     *  获取
+     *  当前this上下文 的Source 和 父级文件级别的节点
+     */
+    getCurrentSource(): {
+        currentSource: import("../translator").Range;
+        fileNode: BaseNode;
+    } | {
+        fileNode: BaseNode;
+        currentSource?: undefined;
+    };
+    /**
+     *  获取
+     *  当前this上下文 的Source 和 父级文件级别的节点
+     */
+    getFileConceptNode(concept: string): any;
+    get isTreeLeaf(): boolean;
+    get hasChildren(): {}[];
+    /**
+     * 使用新的 concept 在当前节点生成新的数据
+     */
+    changeConceptNode(concept: types.SyntaxNodeConcept): this;
+    /** 收集所有节点 */
+    collectNodes(): types.SyntaxNode[];
+    /** 收集特定类型的子节点 */
+    collectNodes(concept: types.SyntaxNodeConcept): types.SyntaxNode[];
+    /** 收集断言返回`true`的子节点 */
+    collectNodes(pre: (node?: types.SyntaxNode) => boolean): types.SyntaxNode[];
+    toEmbeddedTS(): Generator<any, string, any>;
+    /**
+     * 调试用的 ToTS 接口
+     */
+    toDebugTs(): void;
+}
+export default BaseNode;