@lcap/nasl 3.2.0-beta.1 → 3.2.0-beta.2

package/out/concepts/Frontend__.d.ts

@@ -0,0 +1,477 @@
+import { TranslatorState } from '../translator';
+import { AssetsInfo } from './App__';
+import Variable from './Variable__';
+import { Params } from '../common/EventEmitter';
+import BaseNode from '../common/BaseNode';
+import BindEvent from './BindEvent__';
+import View from './View__';
+import FrontendVariable from './FrontendVariable__';
+import Theme from './Theme__';
+import Module from './Module__';
+import App from './App__';
+/**
+ * 端
+ */
+export declare class Frontend extends BaseNode {
+    /**
+     * 产品概念
+     */
+    concept: 'Frontend';
+    /**
+     * 端标识
+     */
+    name: string;
+    /**
+     * pc端
+     */
+    title: string;
+    /**
+     * PC/H5 端
+     */
+    type: 'pc' | 'h5';
+    /**
+     * 基础路径
+     */
+    path: string;
+    /**
+     * 制品应用标题
+     */
+    documentTitle: string;
+    /**
+     * 制品应用图标
+     */
+    documentIcon: string;
+    /**
+     * 元素绑定事件列表
+     */
+    bindEvents: Array<BindEvent>;
+    /**
+     * 页面列表
+     */
+    views: Array<View>;
+    /**
+     * 前端全局变量列表
+     */
+    variables: Array<FrontendVariable>;
+    /**
+     * 主题配置
+     */
+    theme: Theme;
+    /**
+     * 扩展组件列表（兼容老版）
+     */
+    componentDependencies: Array<Module>;
+    /**
+     * 全局缩放开关
+     */
+    globalScaleEnabled: boolean;
+    /**
+     * 画布宽度
+     */
+    canvasWidth: number;
+    /**
+     * 祖先 App
+     */
+    get app(): App;
+    /**
+     * @param source 需要合并的部分参数
+     */
+    constructor(source?: Partial<Frontend>);
+    getClassName(): string;
+    static from(source: any, parentNode?: any, parentKey?: string): Frontend;
+    /**
+     * 从父级删除该节点
+     * @internal
+     */
+    _delete(): Params;
+    /**
+     * 设置端标识
+     */
+    setName(name: string): void;
+    /**
+     * 设置pc端
+     */
+    setTitle(title: string): void;
+    /**
+     * 设置基础路径
+     */
+    setPath(path: string): void;
+    /**
+     * 设置制品应用标题
+     */
+    setDocumentTitle(documentTitle: string): void;
+    /**
+     * 设置制品应用图标
+     */
+    setDocumentIcon(documentIcon: string): void;
+    /**
+     * 设置全局缩放开关
+     */
+    setGlobalScaleEnabled(globalScaleEnabled: boolean): void;
+    /**
+     * 设置画布宽度
+     */
+    setCanvasWidth(canvasWidth: number): void;
+    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;
+    getViewExistingNames(excludedList?: Array<View>): string[];
+    getViewUniqueName(name?: string): string;
+    /**
+    * 插入页面
+    * @internal
+    * @param name 页面名称，如果不填会自动生成一个唯一名称
+    */
+    _insertViewAt(name: string, index: number): View;
+    /**
+    * 插入页面
+    * @internal
+    * @param viewOptions 页面参数
+    */
+    _insertViewAt(viewOptions: Partial<View>, index: number): View;
+    /**
+    * 插入页面
+    * @internal
+    * @param view 已有的页面实例
+    */
+    _insertViewAt(view: View, index: number): View;
+    /**
+     * 插入页面
+     * @param name 页面名称，如果不填会自动生成一个唯一名称
+     */
+    insertViewAt(name: string, index: number): View;
+    /**
+     * 插入页面
+     * @param viewOptions 页面参数
+     */
+    insertViewAt(viewOptions: Partial<View>, index: number): View;
+    /**
+     * 插入页面
+     * @param view 已有的页面实例
+     */
+    insertViewAt(view: View, index: number): View;
+    /**
+     * 添加页面
+     * @internal
+     * @param name 页面名称，如果不填会自动生成一个唯一名称
+     */
+    _addView(name?: string): View;
+    /**
+     * 添加页面
+     * @internal
+     * @param viewOptions 页面参数
+     */
+    _addView(viewOptions: Partial<View>): View;
+    /**
+     * 添加页面
+     * @internal
+     * @param view 已有的页面实例
+     */
+    _addView(view: View): View;
+    /**
+     * 添加页面
+     * @internal
+     * @param name 页面名称，如果不填会自动生成一个唯一名称
+     */
+    addView(name?: string): View;
+    /**
+     * 添加页面
+     * @param viewOptions 页面参数
+     */
+    addView(viewOptions: Partial<View>): View;
+    /**
+     * 添加页面
+     * @param view 已有的页面实例
+     */
+    addView(view: View): View;
+    getVarExistingNames(excludedList?: Array<FrontendVariable>): string[];
+    getFrontendVariableUniqueName(name?: string): string;
+    /**
+    * 插入前端全局变量
+    * @internal
+    * @param name 前端全局变量名称，如果不填会自动生成一个唯一名称
+    */
+    _insertFrontendVariableAt(name: string, index: number): FrontendVariable;
+    /**
+    * 插入前端全局变量
+    * @internal
+    * @param frontendVariableOptions 前端全局变量参数
+    */
+    _insertFrontendVariableAt(frontendVariableOptions: Partial<FrontendVariable>, index: number): FrontendVariable;
+    /**
+    * 插入前端全局变量
+    * @internal
+    * @param frontendVariable 已有的前端全局变量实例
+    */
+    _insertFrontendVariableAt(frontendVariable: FrontendVariable, index: number): FrontendVariable;
+    /**
+     * 插入前端全局变量
+     * @param name 前端全局变量名称，如果不填会自动生成一个唯一名称
+     */
+    insertFrontendVariableAt(name: string, index: number): FrontendVariable;
+    /**
+     * 插入前端全局变量
+     * @param frontendVariableOptions 前端全局变量参数
+     */
+    insertFrontendVariableAt(frontendVariableOptions: Partial<FrontendVariable>, index: number): FrontendVariable;
+    /**
+     * 插入前端全局变量
+     * @param frontendVariable 已有的前端全局变量实例
+     */
+    insertFrontendVariableAt(frontendVariable: FrontendVariable, index: number): FrontendVariable;
+    /**
+     * 添加前端全局变量
+     * @internal
+     * @param name 前端全局变量名称，如果不填会自动生成一个唯一名称
+     */
+    _addFrontendVariable(name?: string): FrontendVariable;
+    /**
+     * 添加前端全局变量
+     * @internal
+     * @param frontendVariableOptions 前端全局变量参数
+     */
+    _addFrontendVariable(frontendVariableOptions: Partial<FrontendVariable>): FrontendVariable;
+    /**
+     * 添加前端全局变量
+     * @internal
+     * @param frontendVariable 已有的前端全局变量实例
+     */
+    _addFrontendVariable(frontendVariable: FrontendVariable): FrontendVariable;
+    /**
+     * 添加前端全局变量
+     * @internal
+     * @param name 前端全局变量名称，如果不填会自动生成一个唯一名称
+     */
+    addFrontendVariable(name?: string): FrontendVariable;
+    /**
+     * 添加前端全局变量
+     * @param frontendVariableOptions 前端全局变量参数
+     */
+    addFrontendVariable(frontendVariableOptions: Partial<FrontendVariable>): FrontendVariable;
+    /**
+     * 添加前端全局变量
+     * @param frontendVariable 已有的前端全局变量实例
+     */
+    addFrontendVariable(frontendVariable: FrontendVariable): FrontendVariable;
+    getModuleExistingNames(excludedList?: Array<Module>): string[];
+    getModuleUniqueName(name?: string): string;
+    /**
+    * 插入模块
+    * @internal
+    * @param name 模块名称，如果不填会自动生成一个唯一名称
+    */
+    _insertModuleAt(name: string, index: number): Module;
+    /**
+    * 插入模块
+    * @internal
+    * @param moduleOptions 模块参数
+    */
+    _insertModuleAt(moduleOptions: Partial<Module>, index: number): Module;
+    /**
+    * 插入模块
+    * @internal
+    * @param module 已有的模块实例
+    */
+    _insertModuleAt(module: Module, index: number): Module;
+    /**
+     * 插入模块
+     * @param name 模块名称，如果不填会自动生成一个唯一名称
+     */
+    insertModuleAt(name: string, index: number): Module;
+    /**
+     * 插入模块
+     * @param moduleOptions 模块参数
+     */
+    insertModuleAt(moduleOptions: Partial<Module>, index: number): Module;
+    /**
+     * 插入模块
+     * @param module 已有的模块实例
+     */
+    insertModuleAt(module: Module, index: number): Module;
+    /**
+     * 添加模块
+     * @internal
+     * @param name 模块名称，如果不填会自动生成一个唯一名称
+     */
+    _addModule(name?: string): Module;
+    /**
+     * 添加模块
+     * @internal
+     * @param moduleOptions 模块参数
+     */
+    _addModule(moduleOptions: Partial<Module>): Module;
+    /**
+     * 添加模块
+     * @internal
+     * @param module 已有的模块实例
+     */
+    _addModule(module: Module): Module;
+    /**
+     * 添加模块
+     * @internal
+     * @param name 模块名称，如果不填会自动生成一个唯一名称
+     */
+    addModule(name?: string): Module;
+    /**
+     * 添加模块
+     * @param moduleOptions 模块参数
+     */
+    addModule(moduleOptions: Partial<Module>): Module;
+    /**
+     * 添加模块
+     * @param module 已有的模块实例
+     */
+    addModule(module: Module): Module;
+    /**
+    * 删除元素绑定事件
+    * @param name 元素绑定事件名称
+    */
+    removeBindEvent(name: string): void;
+    /**
+     * 删除元素绑定事件
+     * @param bindEvent 已有的元素绑定事件实例
+     */
+    removeBindEvent(bindEvent: BindEvent): void;
+    __removeBindEvent(bindEvent: BindEvent): Params;
+    /**
+    * 删除页面
+    * @param name 页面名称
+    */
+    removeView(name: string): void;
+    /**
+     * 删除页面
+     * @param view 已有的页面实例
+     */
+    removeView(view: View): void;
+    __removeView(view: View): Params;
+    /**
+    * 删除前端全局变量
+    * @param name 前端全局变量名称
+    */
+    removeFrontendVariable(name: string): void;
+    /**
+     * 删除前端全局变量
+     * @param frontendVariable 已有的前端全局变量实例
+     */
+    removeFrontendVariable(frontendVariable: FrontendVariable): void;
+    __removeVariable(variable: Variable): Params;
+    /**
+    * 删除主题
+    * @param name 主题名称
+    */
+    removeTheme(name: string): void;
+    /**
+     * 删除主题
+     * @param theme 已有的主题实例
+     */
+    removeTheme(theme: Theme): void;
+    __removeTheme(theme: Theme): Params;
+    /**
+    * 删除模块
+    * @param name 模块名称
+    */
+    removeModule(name: string): void;
+    /**
+     * 删除模块
+     * @param module 已有的模块实例
+     */
+    removeModule(module: Module): void;
+    __removeModule(module: Module): Params;
+    findComponentDependencyByName(name: string): Module;
+    /**
+     * @param path 路径
+     * path 为要查找路径：如 /dashboard/student/list、/dashboard/student/list
+     */
+    findViewByPath(path: string): View;
+    findViewByName(name: string): View;
+    genThemeCSS(): string;
+    getTsNamespace(): string;
+    getNamespace(): string;
+    /**
+     * 生成宿主语言的文件路径
+     * @param name 一般不用传，用于 rename
+     */
+    getEmbeddedFilePath(name?: string): string;
+    toEmbeddedTS(state?: TranslatorState): string;
+    toEmbeddedTSFile(): {
+        code: string;
+        filePath: string;
+        sourceMap: import("../translator").SourceMap;
+    };
+    getPath(): string;
+    get prefixPath(): string;
+    /**
+     * 为/的转成''，便于url拼接
+     */
+    get basePath(): string;
+    genCustomAssetsInfo(prefix: string): AssetsInfo;
+    getExtensionsCallbackLogics(): string[];
+    get defaultCanvasWidth(): 1440 | 375;
+}
+export default Frontend;