@lcap/nasl 3.7.0-beta.3 → 3.7.0-beta.5

package/dist/src/common/BaseNode.d.ts

@@ -0,0 +1,384 @@
+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;
+    get app(): App;
+    /**
+     *
+     * @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(outTime?: number): 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<T extends types.SyntaxNodeConcept>(concept: T): types.ConceptClassMap[T][];
+    /** 收集断言返回`true`的子节点 */
+    collectNodes(pre: (node?: types.SyntaxNode) => boolean): types.SyntaxNode[];
+    toEmbeddedTS(): Generator<any, string, any>;
+    /**
+     * 生成文本化代码
+     * @param state 编译状态
+     * @returns 生成的代码
+     */
+    toTextualNASL(): string;
+    /**
+     * 调试用的 ToTS 接口
+     */
+    toDebugTs(): void;
+}
+export default BaseNode;

package/dist/src/common/Command.d.ts

@@ -0,0 +1,21 @@
+export declare type CommandExecute = (...args: any[]) => any;
+export declare class Command {
+    execute: CommandExecute;
+    constructor(execute: CommandExecute);
+}
+/**
+ * 注册命令
+ * @param command 命令名称
+ * @param execute 命令执行函数
+ */
+export declare function registerCommand(command: string, execute: CommandExecute): void;
+/**
+ * 注销命令
+ * @param command 命令名称
+ * @param execute 如果不传，则注销所有执行函数
+ * @returns
+ */
+export declare function unregisterCommand(command: string, execute?: CommandExecute): void;
+export declare function invokeCommand(command: string, ...args: any[]): any[];
+export declare function invokeOnlyCommand(command: string, ...args: any[]): any;
+export declare function hasCommand(command: string): boolean;

package/dist/src/common/ComponentAPI.d.ts

@@ -0,0 +1,112 @@
+export interface OptionAPI {
+    name: string;
+    type: string;
+    default?: any;
+    description?: string;
+}
+export interface AttrAPI {
+    name: string;
+    title: string;
+    group?: string;
+    sync?: boolean;
+    model?: boolean;
+    type: string;
+    designerValue: string;
+    options?: Array<any>;
+    default?: any;
+    description?: string;
+    compType?: string;
+    tsType?: any;
+}
+export interface ComputedAPI {
+    name: string;
+    type: string;
+    description?: string;
+}
+export interface DataAPI {
+    name: string;
+    type: string;
+    default?: any;
+    description?: string;
+}
+export interface SlotAPI {
+    name: string;
+    title: string;
+    type: string;
+    default?: any;
+    emptyBackground: 'add-sub' | 'add-sub-large' | 'image' | 'drag-entity-here' | 'add-any';
+    description?: string;
+    props?: Array<{
+        name: string;
+        type: string;
+        description?: string;
+    }>;
+    support: Array<{
+        name: string;
+        title: string;
+        snippet: string;
+    }>;
+}
+export interface EventAPI {
+    name: string;
+    description?: string;
+    params?: Array<{
+        name: string;
+        type: string;
+        description?: string;
+    }>;
+}
+export interface MethodAPI {
+    name: string;
+    type: string;
+    default?: any;
+    description?: string;
+    params?: Array<{
+        name: string;
+        type: string;
+        default?: string;
+        description?: string;
+    }>;
+}
+export interface AriaAPI {
+    key: string;
+    description?: string;
+}
+/**
+ * 组件 api.yaml
+ */
+export default interface ComponentAPI {
+    /**
+     * 组件名称
+     */
+    name: string;
+    /**
+     * 组件标题
+     */
+    title: string;
+    /**
+     * 组件图标
+     */
+    icon: string;
+    /**
+     * 组件标签
+     */
+    labels: Array<string>;
+    /**
+     * 组件分类
+     */
+    category?: string;
+    description?: string;
+    docs?: {
+        [name: string]: string;
+    };
+    options?: Array<OptionAPI>;
+    data?: Array<DataAPI>;
+    props?: Array<AttrAPI>;
+    slots?: Array<SlotAPI>;
+    computed?: Array<ComputedAPI>;
+    events?: Array<EventAPI>;
+    methods?: Array<MethodAPI>;
+    aria?: Array<AriaAPI>;
+    tsTypeParams?: string;
+}

package/dist/src/common/EventEmitter.d.ts

@@ -0,0 +1,61 @@
+import { BaseNode } from '..';
+export declare type EventListener = (...args: Array<any>) => any;
+export declare class EventEmitter {
+    static readonly ConceptName: string;
+    private readonly _events;
+    /**
+     * 监听事件
+     * @param eventName 事件名
+     * @param listener 监听器
+     */
+    on(eventName: string, listener: EventListener): void;
+    /**
+     * 取消监听事件
+     * @param eventName 事件名
+     * @param listener 监听器
+     */
+    off(eventName: string, listener: EventListener): void;
+    /**
+     * 只监听一次事件
+     * @param eventName 事件名
+     * @param listener 监听器
+     */
+    once(eventName: string, listener: EventListener): void;
+    /**
+     * 触发事件
+     * @param eventName 事件名
+     * @param args 事件参数
+     */
+    emit(eventName: string, event?: EventPayload, target?: any): void;
+}
+export interface Params {
+    parentNode?: BaseNode;
+    parentKey?: string;
+    propertyName?: string;
+    index?: number;
+    object?: any;
+    oldObject?: any;
+}
+export interface EventPayload {
+    path?: string;
+    parentParams?: Params;
+    emitTarget?: any;
+    emitAction?: string;
+    target?: any;
+    currentTarget?: any;
+    _storaged?: boolean;
+    action?: string;
+    field?: string;
+    value?: any;
+    oldValue?: any;
+    oldName?: string;
+    object?: any;
+    oldObject?: any;
+    eventList?: EventPayload[];
+    originEvent?: EventPayload;
+    eventStop?: boolean;
+    actionMsg?: string;
+    riskList?: any[];
+    extra?: any;
+}
+export default EventEmitter;

package/dist/src/common/Messager.d.ts

@@ -0,0 +1,91 @@
+export interface Message {
+    id?: string;
+    protocol: string;
+    sender: string;
+    type: 'send' | 'request' | 'response';
+    command?: string;
+    args?: Array<any>;
+    data?: any;
+    result?: any;
+    error?: any;
+    res?: (value: unknown) => void;
+    rej?: (value: unknown) => void;
+    [prop: string]: any;
+}
+export interface Options {
+    protocol?: string;
+    sender?: string;
+    logLevel?: string;
+    timeout?: number;
+    onlySend?: boolean;
+    context: any;
+    /**
+     * 获取目标 Window
+     * @example iframe.contentWindow
+     * @example window.parent
+     */
+    getSender?: () => Window | Worker;
+    getReceiver?: () => Window | Worker;
+    /**
+     * 处理接收的数据
+     * @override
+     */
+    handleMessage?: (message: Message) => void;
+}
+/**
+ * 用于两个 window 之间通信
+ * 除了基本的发送消息，提供了如命令式等更多方法
+ */
+export default class Messager {
+    options: Options;
+    requests: Map<string, Message>;
+    constructor(options: Options);
+    destroy(): void;
+    /**
+     * 发送信息
+     * 所有下面方法的基础方法
+     * 比较原生，直接给目标 window 中 postMessage
+     */
+    sendMessage(message: Message): void;
+    /**
+     * 发送数据
+     * 包装了协议和发送者。Window 的 message 可能来自不同地方，统一格式区分。
+     * @param data 数据
+     */
+    sendData(data: any): void;
+    /**
+     * 发送命令
+     * 直接发送一个命令
+     * 包装了协议和发送者。Window 的 message 可能来自不同地方，统一格式区分。
+     * @param command 命令名
+     * @param args 参数
+     */
+    sendCommand(command: string, ...args: any[]): void;
+    /**
+     * 请求信息
+     * 与 send 系列的区别是接收返回数据
+     */
+    requestMessage(message: Message, options?: {
+        id?: string | number;
+    }): Promise<any>;
+    /**
+     * 请求数据
+     * 与 sendData 系列的区别是接收返回数据
+     */
+    requestData(data: any): Promise<any>;
+    /**
+     * 请求命令
+     * 与 sendCommand 系列的区别是接收返回数据
+     */
+    requestCommand<T = void>(command: string, ...args: any[]): Promise<T>;
+    /**
+     * 内置处理接收的 MessageEvent 事件
+     * @override
+     */
+    onMessageReceived(e: MessageEvent): void;
+    /**
+     * 内置处理接收的数据
+     * @override
+     */
+    onDataReceived(data: any): Promise<void>;
+}

package/dist/src/common/asyncFuncMap.d.ts

@@ -0,0 +1,2 @@
+declare const asyncFuncMap: Record<string, string>;
+export default asyncFuncMap;

package/dist/src/common/index.d.ts

@@ -0,0 +1,4 @@
+export * from './BaseNode';
+export * from './EventEmitter';
+export * from './Command';
+export * from './utils';

package/dist/src/common/utils.d.ts

@@ -0,0 +1,2 @@
+import type { types } from '../concepts';
+export declare function waitOqlQueryComponentChildrenFinish(node: types.SyntaxNode): Promise<any[]>;

package/dist/src/concepts/Abort__.d.ts

@@ -0,0 +1,31 @@
+import { TranslatorState, TranslatorGenerator } from '../translator';
+import LogicItem from './LogicItem__';
+/**
+ * 中止表达式
+ */
+export declare class Abort extends LogicItem {
+    /** 类名 */
+    static readonly ConceptName: string;
+    /**
+     * 是否为抽象类
+     * 抽象类不能产生 concept: string
+     */
+    static isAbstract: boolean;
+    /** 继承链 */
+    static readonly inheritanceChain: string[];
+    /**
+     * 产品概念
+     */
+    readonly concept: 'Abort';
+    /**
+     * @param source 需要合并的部分参数
+     */
+    constructor(source?: Partial<Abort>);
+    static from(source: any, parentNode?: any, parentKey?: string): Abort;
+    toUI(state?: TranslatorState, hideDetails?: boolean): string;
+    toJS(state?: TranslatorState): string;
+    toEmbeddedTS(state?: TranslatorState): TranslatorGenerator;
+    toNaturalTS(state?: TranslatorState): string;
+    toTextualNASL(state?: TranslatorState): string;
+}
+export default Abort;