@lcap/nasl 3.5.0-alpha.1 → 3.5.0-beta.2

package/out/concepts/BusinessComponent__.d.ts

@@ -0,0 +1,637 @@
+import type { EmbeddedTSFileGenerator } from '../utils';
+import { TranslatorGenerator } from '../translator';
+import type Assignment from './Assignment__';
+import type BatchAssignment from './BatchAssignment__';
+import type FrontendType from './FrontendType__';
+import { ElementToVueOptions } from './ViewElement__';
+import { EventPayload, Params } from '../common/EventEmitter';
+import BaseNode from '../common/BaseNode';
+import type Event from './Event__';
+import type ParamWithGroup from './ParamWithGroup__';
+import type Variable from './Variable__';
+import type BindEvent from './BindEvent__';
+import type BusinessLogic from './BusinessLogic__';
+import type ViewElement from './ViewElement__';
+import type Param from './Param__';
+import type Logic from './Logic__';
+/**
+ * 业务组件
+ */
+export declare class BusinessComponent extends BaseNode {
+    /** 类名 */
+    static readonly ConceptName: string;
+    /** 继承链 */
+    static readonly inheritanceChain: string[];
+    /**
+     * 产品概念
+     */
+    readonly concept: 'BusinessComponent';
+    /**
+     * 业务组件名称
+     */
+    name: string;
+    /**
+     * 业务组件标题
+     */
+    title: string;
+    /**
+     * 业务组件描述
+     */
+    description: string;
+    /**
+     * 组件事件列表
+     */
+    events: Array<Event>;
+    /**
+     * 参数分组列表
+     */
+    params: Array<ParamWithGroup>;
+    /**
+     * 变量列表
+     */
+    variables: Array<Variable>;
+    /**
+     * 元素绑定事件列表
+     */
+    bindEvents: Array<BindEvent>;
+    /**
+     * 业务组件逻辑列表
+     */
+    logics: Array<BusinessLogic>;
+    /**
+     * 页面元素列表
+     */
+    elements: Array<ViewElement>;
+    /**
+     * icon
+     */
+    icon: string;
+    /**
+     * @param source 需要合并的部分参数
+     */
+    constructor(source?: Partial<BusinessComponent>);
+    static from(source: any, parentNode?: any, parentKey?: string): BusinessComponent;
+    /**
+     * 从父级删除该节点
+     * @internal
+     */
+    _delete(): Params;
+    /**
+     * 设置业务组件名称
+     */
+    setName(name: string): void;
+    /**
+     * 设置业务组件标题
+     */
+    setTitle(title: string): void;
+    /**
+     * 设置业务组件描述
+     */
+    setDescription(description: string): void;
+    /**
+     * 设置icon
+     */
+    setIcon(icon: string): void;
+    getEventExistingNames(excludedList?: Array<Event>): string[];
+    getEventUniqueName(name?: string): string;
+    /**
+     * 插入组件事件
+     * @internal
+     * @param name 组件事件名称，如果不填会自动生成一个唯一名称
+     */
+    _insertEventAt(name: string, index: number): Event;
+    /**
+     * 插入组件事件
+     * @internal
+     * @param eventOptions 组件事件参数
+     */
+    _insertEventAt(eventOptions: Partial<Event>, index: number): Event;
+    /**
+     * 插入组件事件
+     * @internal
+     * @param event 已有的组件事件实例
+     */
+    _insertEventAt(event: Event, index: number): Event;
+    /**
+     * 插入组件事件
+     * @param name 组件事件名称，如果不填会自动生成一个唯一名称
+     */
+    insertEventAt(name: string, index: number): Event;
+    /**
+     * 插入组件事件
+     * @param eventOptions 组件事件参数
+     */
+    insertEventAt(eventOptions: Partial<Event>, index: number): Event;
+    /**
+     * 插入组件事件
+     * @param event 已有的组件事件实例
+     */
+    insertEventAt(event: Event, index: number): Event;
+    /**
+     * 添加组件事件
+     * @internal
+     * @param name 组件事件名称，如果不填会自动生成一个唯一名称
+     */
+    _addEvent(name?: string): Event;
+    /**
+     * 添加组件事件
+     * @internal
+     * @param eventOptions 组件事件参数
+     */
+    _addEvent(eventOptions: Partial<Event>): Event;
+    /**
+     * 添加组件事件
+     * @internal
+     * @param event 已有的组件事件实例
+     */
+    _addEvent(event: Event): Event;
+    /**
+     * 添加组件事件
+     * @internal
+     * @param name 组件事件名称，如果不填会自动生成一个唯一名称
+     */
+    addEvent(name?: string): Event;
+    /**
+     * 添加组件事件
+     * @param eventOptions 组件事件参数
+     */
+    addEvent(eventOptions: Partial<Event>): Event;
+    /**
+     * 添加组件事件
+     * @param event 已有的组件事件实例
+     */
+    addEvent(event: Event): Event;
+    getParamUniqueName(name?: string): string;
+    /**
+     * 插入参数分组
+     * @internal
+     * @param name 参数分组名称，如果不填会自动生成一个唯一名称
+     */
+    _insertParamAt(name: string, index: number): ParamWithGroup;
+    /**
+     * 插入参数分组
+     * @internal
+     * @param paramOptions 参数分组参数
+     */
+    _insertParamAt(paramOptions: Partial<ParamWithGroup>, index: number): ParamWithGroup;
+    /**
+     * 插入参数分组
+     * @internal
+     * @param param 已有的参数分组实例
+     */
+    _insertParamAt(param: ParamWithGroup, index: number): ParamWithGroup;
+    /**
+     * 插入参数分组
+     * @param name 参数分组名称，如果不填会自动生成一个唯一名称
+     */
+    insertParamAt(name: string, index: number): ParamWithGroup;
+    /**
+     * 插入参数分组
+     * @param paramOptions 参数分组参数
+     */
+    insertParamAt(paramOptions: Partial<ParamWithGroup>, index: number): ParamWithGroup;
+    /**
+     * 插入参数分组
+     * @param param 已有的参数分组实例
+     */
+    insertParamAt(param: ParamWithGroup, index: number): ParamWithGroup;
+    /**
+     * 添加参数分组
+     * @internal
+     * @param name 参数分组名称，如果不填会自动生成一个唯一名称
+     */
+    _addParam(name?: string): ParamWithGroup;
+    /**
+     * 添加参数分组
+     * @internal
+     * @param paramOptions 参数分组参数
+     */
+    _addParam(paramOptions: Partial<ParamWithGroup>): ParamWithGroup;
+    /**
+     * 添加参数分组
+     * @internal
+     * @param param 已有的参数分组实例
+     */
+    _addParam(param: ParamWithGroup): ParamWithGroup;
+    /**
+     * 添加参数分组
+     * @internal
+     * @param name 参数分组名称，如果不填会自动生成一个唯一名称
+     */
+    addParam(name?: string): ParamWithGroup;
+    /**
+     * 添加参数分组
+     * @param paramOptions 参数分组参数
+     */
+    addParam(paramOptions: Partial<ParamWithGroup>): ParamWithGroup;
+    /**
+     * 添加参数分组
+     * @param param 已有的参数分组实例
+     */
+    addParam(param: ParamWithGroup): ParamWithGroup;
+    getVariableUniqueName(name?: string): string;
+    /**
+     * 插入变量
+     * @internal
+     * @param name 变量名称，如果不填会自动生成一个唯一名称
+     */
+    _insertVariableAt(name: string, index: number): Variable;
+    /**
+     * 插入变量
+     * @internal
+     * @param variableOptions 变量参数
+     */
+    _insertVariableAt(variableOptions: Partial<Variable>, index: number): Variable;
+    /**
+     * 插入变量
+     * @internal
+     * @param variable 已有的变量实例
+     */
+    _insertVariableAt(variable: Variable, index: number): Variable;
+    /**
+     * 插入变量
+     * @param name 变量名称，如果不填会自动生成一个唯一名称
+     */
+    insertVariableAt(name: string, index: number): Variable;
+    /**
+     * 插入变量
+     * @param variableOptions 变量参数
+     */
+    insertVariableAt(variableOptions: Partial<Variable>, index: number): Variable;
+    /**
+     * 插入变量
+     * @param variable 已有的变量实例
+     */
+    insertVariableAt(variable: Variable, index: number): Variable;
+    /**
+     * 添加变量
+     * @internal
+     * @param name 变量名称，如果不填会自动生成一个唯一名称
+     */
+    _addVariable(name?: string): Variable;
+    /**
+     * 添加变量
+     * @internal
+     * @param variableOptions 变量参数
+     */
+    _addVariable(variableOptions: Partial<Variable>): Variable;
+    /**
+     * 添加变量
+     * @internal
+     * @param variable 已有的变量实例
+     */
+    _addVariable(variable: Variable): Variable;
+    /**
+     * 添加变量
+     * @internal
+     * @param name 变量名称，如果不填会自动生成一个唯一名称
+     */
+    addVariable(name?: string): Variable;
+    /**
+     * 添加变量
+     * @param variableOptions 变量参数
+     */
+    addVariable(variableOptions: Partial<Variable>): Variable;
+    /**
+     * 添加变量
+     * @param variable 已有的变量实例
+     */
+    addVariable(variable: Variable): Variable;
+    getBindEventExistingNames(excludedList?: Array<BindEvent>): string[];
+    getBindEventUniqueName(name?: string): string;
+    /**
+     * 插入元素绑定事件
+     * @internal
+     * @param name 元素绑定事件名称，如果不填会自动生成一个唯一名称
+     */
+    _insertBindEventAt(name: string, index: number): BindEvent;
+    /**
+     * 插入元素绑定事件
+     * @internal
+     * @param bindEventOptions 元素绑定事件参数
+     */
+    _insertBindEventAt(bindEventOptions: Partial<BindEvent>, index: number): BindEvent;
+    /**
+     * 插入元素绑定事件
+     * @internal
+     * @param bindEvent 已有的元素绑定事件实例
+     */
+    _insertBindEventAt(bindEvent: BindEvent, index: number): BindEvent;
+    /**
+     * 插入元素绑定事件
+     * @param name 元素绑定事件名称，如果不填会自动生成一个唯一名称
+     */
+    insertBindEventAt(name: string, index: number): BindEvent;
+    /**
+     * 插入元素绑定事件
+     * @param bindEventOptions 元素绑定事件参数
+     */
+    insertBindEventAt(bindEventOptions: Partial<BindEvent>, index: number): BindEvent;
+    /**
+     * 插入元素绑定事件
+     * @param bindEvent 已有的元素绑定事件实例
+     */
+    insertBindEventAt(bindEvent: BindEvent, index: number): BindEvent;
+    /**
+     * 添加元素绑定事件
+     * @internal
+     * @param name 元素绑定事件名称，如果不填会自动生成一个唯一名称
+     */
+    _addBindEvent(name?: string): BindEvent;
+    /**
+     * 添加元素绑定事件
+     * @internal
+     * @param bindEventOptions 元素绑定事件参数
+     */
+    _addBindEvent(bindEventOptions: Partial<BindEvent>): BindEvent;
+    /**
+     * 添加元素绑定事件
+     * @internal
+     * @param bindEvent 已有的元素绑定事件实例
+     */
+    _addBindEvent(bindEvent: BindEvent): BindEvent;
+    /**
+     * 添加元素绑定事件
+     * @internal
+     * @param name 元素绑定事件名称，如果不填会自动生成一个唯一名称
+     */
+    addBindEvent(name?: string): BindEvent;
+    /**
+     * 添加元素绑定事件
+     * @param bindEventOptions 元素绑定事件参数
+     */
+    addBindEvent(bindEventOptions: Partial<BindEvent>): BindEvent;
+    /**
+     * 添加元素绑定事件
+     * @param bindEvent 已有的元素绑定事件实例
+     */
+    addBindEvent(bindEvent: BindEvent): BindEvent;
+    getLogicExistingNames(excludedList?: Array<BusinessLogic>): string[];
+    getLogicUniqueName(name?: string): string;
+    /**
+     * 插入业务组件逻辑
+     * @internal
+     * @param name 业务组件逻辑名称，如果不填会自动生成一个唯一名称
+     */
+    _insertLogicAt(name: string, index: number): BusinessLogic;
+    /**
+     * 插入业务组件逻辑
+     * @internal
+     * @param logicOptions 业务组件逻辑参数
+     */
+    _insertLogicAt(logicOptions: Partial<BusinessLogic>, index: number): BusinessLogic;
+    /**
+     * 插入业务组件逻辑
+     * @internal
+     * @param logic 已有的业务组件逻辑实例
+     */
+    _insertLogicAt(logic: BusinessLogic, index: number): BusinessLogic;
+    /**
+     * 插入业务组件逻辑
+     * @param name 业务组件逻辑名称，如果不填会自动生成一个唯一名称
+     */
+    insertLogicAt(name: string, index: number): BusinessLogic;
+    /**
+     * 插入业务组件逻辑
+     * @param logicOptions 业务组件逻辑参数
+     */
+    insertLogicAt(logicOptions: Partial<BusinessLogic>, index: number): BusinessLogic;
+    /**
+     * 插入业务组件逻辑
+     * @param logic 已有的业务组件逻辑实例
+     */
+    insertLogicAt(logic: BusinessLogic, index: number): BusinessLogic;
+    /**
+     * 添加业务组件逻辑
+     * @internal
+     * @param name 业务组件逻辑名称，如果不填会自动生成一个唯一名称
+     */
+    _addLogic(name?: string): BusinessLogic;
+    /**
+     * 添加业务组件逻辑
+     * @internal
+     * @param logicOptions 业务组件逻辑参数
+     */
+    _addLogic(logicOptions: Partial<BusinessLogic>): BusinessLogic;
+    /**
+     * 添加业务组件逻辑
+     * @internal
+     * @param logic 已有的业务组件逻辑实例
+     */
+    _addLogic(logic: BusinessLogic): BusinessLogic;
+    /**
+     * 添加业务组件逻辑
+     * @internal
+     * @param name 业务组件逻辑名称，如果不填会自动生成一个唯一名称
+     */
+    addLogic(name?: string): BusinessLogic;
+    /**
+     * 添加业务组件逻辑
+     * @param logicOptions 业务组件逻辑参数
+     */
+    addLogic(logicOptions: Partial<BusinessLogic>): BusinessLogic;
+    /**
+     * 添加业务组件逻辑
+     * @param logic 已有的业务组件逻辑实例
+     */
+    addLogic(logic: BusinessLogic): BusinessLogic;
+    /**
+     * 插入页面元素
+     * @internal
+     * @param name 页面元素名称，如果不填会自动生成一个唯一名称
+     */
+    _insertViewElementAt(name: string, index: number): ViewElement;
+    /**
+     * 插入页面元素
+     * @internal
+     * @param viewElementOptions 页面元素参数
+     */
+    _insertViewElementAt(viewElementOptions: Partial<ViewElement>, index: number): ViewElement;
+    /**
+     * 插入页面元素
+     * @internal
+     * @param viewElement 已有的页面元素实例
+     */
+    _insertViewElementAt(viewElement: ViewElement, index: number): ViewElement;
+    /**
+     * 插入页面元素
+     * @param name 页面元素名称，如果不填会自动生成一个唯一名称
+     */
+    insertViewElementAt(name: string, index: number): ViewElement;
+    /**
+     * 插入页面元素
+     * @param viewElementOptions 页面元素参数
+     */
+    insertViewElementAt(viewElementOptions: Partial<ViewElement>, index: number): ViewElement;
+    /**
+     * 插入页面元素
+     * @param viewElement 已有的页面元素实例
+     */
+    insertViewElementAt(viewElement: ViewElement, index: number): ViewElement;
+    /**
+     * 添加页面元素
+     * @internal
+     * @param name 页面元素名称，如果不填会自动生成一个唯一名称
+     */
+    _addViewElement(name?: string): ViewElement;
+    /**
+     * 添加页面元素
+     * @internal
+     * @param viewElementOptions 页面元素参数
+     */
+    _addViewElement(viewElementOptions: Partial<ViewElement>): ViewElement;
+    /**
+     * 添加页面元素
+     * @internal
+     * @param viewElement 已有的页面元素实例
+     */
+    _addViewElement(viewElement: ViewElement): ViewElement;
+    /**
+     * 添加页面元素
+     * @internal
+     * @param name 页面元素名称，如果不填会自动生成一个唯一名称
+     */
+    addViewElement(name?: string): ViewElement;
+    /**
+     * 添加页面元素
+     * @param viewElementOptions 页面元素参数
+     */
+    addViewElement(viewElementOptions: Partial<ViewElement>): ViewElement;
+    /**
+     * 添加页面元素
+     * @param viewElement 已有的页面元素实例
+     */
+    addViewElement(viewElement: ViewElement): ViewElement;
+    /**
+     * 删除组件事件
+     * @param name 组件事件名称
+     */
+    removeEvent(name: string): void;
+    /**
+     * 删除组件事件
+     * @param event 已有的组件事件实例
+     */
+    removeEvent(event: Event): void;
+    __removeEvent(event: Event): Params;
+    /**
+     * 删除参数分组
+     * @param name 参数分组名称
+     */
+    removeParam(name: string): void;
+    /**
+     * 删除参数分组
+     * @param param 已有的参数分组实例
+     */
+    removeParam(param: ParamWithGroup): void;
+    __removeParam(param: Param): Params;
+    /**
+     * 删除变量
+     * @param name 变量名称
+     */
+    removeVariable(name: string): void;
+    /**
+     * 删除变量
+     * @param variable 已有的变量实例
+     */
+    removeVariable(variable: Variable): void;
+    __removeVariable(variable: Variable): Params;
+    /**
+     * 删除元素绑定事件
+     * @param name 元素绑定事件名称
+     */
+    removeBindEvent(name: string): void;
+    /**
+     * 删除元素绑定事件
+     * @param bindEvent 已有的元素绑定事件实例
+     */
+    removeBindEvent(bindEvent: BindEvent): void;
+    __removeBindEvent(bindEvent: BindEvent): Params;
+    /**
+     * 删除业务组件逻辑
+     * @param name 业务组件逻辑名称
+     */
+    removeLogic(name: string): void;
+    /**
+     * 删除业务组件逻辑
+     * @param logic 已有的业务组件逻辑实例
+     */
+    removeLogic(logic: BusinessLogic): void;
+    __removeLogic(logic: Logic): Params;
+    /**
+     * 删除页面元素
+     * @param name 页面元素名称
+     */
+    removeViewElement(name: string): void;
+    /**
+     * 删除页面元素
+     * @param viewElement 已有的页面元素实例
+     */
+    removeViewElement(viewElement: ViewElement): void;
+    __removeViewElement(viewElement: ViewElement): Params;
+    static getDefaultOptions(): {
+        title: string;
+    };
+    getNamespace(): string;
+    getTsNamespace(): string;
+    /**
+     * 获取当前业务组件下所有elements上bindEvents下的logic
+     */
+    elementLogicRoot: any[];
+    getElementLogicRoot(): void;
+    getVarExistingNames(excludedList?: Array<Param | Variable>): any[];
+    existingViewElement: Set<string>;
+    collectExistingViewElementName(excludedList?: Array<ViewElement>): void;
+    getViewElementExistingNames(excludedList?: Array<ViewElement>): string[];
+    getViewElementUniqueNameOld(name?: string): string;
+    getViewElementUniqueName(name?: string): string;
+    elementsMethods(elements: Array<ViewElement>, allMethods: Array<ViewElement>, parentNodeNames: Array<string>): void;
+    mergeBlock({ code, nodePath, position, cb }: {
+        code: string;
+        nodePath: string;
+        position: string;
+        cb?: Function;
+    }): ViewElement;
+    onChange($event?: EventPayload): void;
+    /**
+     * 转换成设计器中使用的 Vue template 内容
+     * @param options
+     */
+    genDesignerVueTemplate(options?: {
+        asCompontent?: boolean;
+    }): string;
+    get frontendType(): FrontendType;
+    get path(): string;
+    get slotElems(): ViewElement[];
+    /**
+     * 生成宿主语言的文件路径
+     * @param name 一般不用传，用于 rename
+     */
+    getEmbeddedFilePath(name?: string): string;
+    toEmbeddedTSFile(): EmbeddedTSFileGenerator;
+    getAncestorViewElementsWithDataSource(logic: Logic): ViewElement[];
+    handleCurrentItemCode(code: string, logic: Logic): Generator<any, string, any>;
+    removeExistingViewElement(viewElement: ViewElement): void;
+    getRightCode(code: string, assignment: Assignment | BatchAssignment, rightNode: any): Generator<any, string, any>;
+    handleReplaceCode(code: string, variable: string, replaceCode: string): string;
+    elementsAttrs(elements: Array<ViewElement>, componentList: Array<ViewElement>): void;
+    elementsAttrsAll(elements: Array<ViewElement>, componentListExtra: Array<ViewElement>): void;
+    toEmbeddedTS(state?: import("../translator").TranslatorState): TranslatorGenerator;
+    /**
+     * 转换成 VueOptions
+     * @TODO 后面 template 可以优化成 render 函数
+     */
+    toVueOptions(options?: ElementToVueOptions): {
+        template: string;
+        script: string;
+    };
+    genVueTemplate(options?: ElementToVueOptions): string;
+    getViewBindEvents(): BindEvent[];
+    getViewExpressions(): any[];
+    /**
+     * 生成 Vue 中需要的 JS 代码
+     * @TODO 这一版先做成 componentOptions 式的，后面再美化
+     */
+    genScript(): string;
+    genPreviewTemplate(): string;
+}
+export default BusinessComponent;