@lcap/nasl 2.22.0-beta.5 → 3.0.0-beta.1

package/src/concepts/AuthLogic__.ts

@@ -0,0 +1,225 @@
+//================================================================================
+// 从这里开始到结尾注释之间的代码由 NASL Workbench 自动生成，请不手动修改！
+// ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓
+//================================================================================
+import { EventPayload, Params } from '../common/EventEmitter';
+import { concept, excludedInJSON, property } from '../decorators';
+
+import * as utils from '../utils';
+import { v4 as uuidv4 } from 'uuid';
+import BaseNode from '../common/BaseNode';
+import classMap from '../common/classMap';
+import Module from './Module__';
+import View from './View__';
+import ProcessElement from './ProcessElement__';
+import App from './App__';
+import Frontend from './Frontend__';
+import Process from './Process__';
+import Logic from './Logic__';
+
+/**
+ * 开放接口的鉴权逻辑
+ */
+@concept('开放接口的鉴权逻辑')
+export class AuthLogic extends Logic {
+    /**
+     * 产品概念
+     */
+    @property()
+    concept: 'AuthLogic' | 'AuthLogicForCallInterface' = 'AuthLogic';
+
+    /**
+     * 是否为默认鉴权逻辑
+     */
+    @property()
+    isDefault: boolean = undefined;
+
+    /**
+     * 祖先 Module
+     */
+    get module() {
+        return this.getAncestor('Module') as Module;
+    }
+    /**
+     * 祖先 App
+     */
+    get app() {
+        return this.getAncestor('App') as App;
+    }
+    /**
+     * 祖先 View
+     */
+    get view() {
+        return this.getAncestor('View') as View;
+    }
+    /**
+     * 祖先 Frontend
+     */
+    get frontend() {
+        return this.getAncestor('Frontend') as Frontend;
+    }
+    /**
+     * 祖先 ProcessElement
+     */
+    get processElement() {
+        return this.getAncestor('ProcessElement') as ProcessElement;
+    }
+    /**
+     * 祖先 Process
+     */
+    get process() {
+        return this.getAncestor('Process') as Process;
+    }
+
+    /**
+     * @param source 需要合并的部分参数
+     */
+    constructor(source?: Partial<AuthLogic>) {
+        source = Object.assign({}, AuthLogic.getDefaultOptions(), source);
+        super(source);
+        super.subConstructor(source);
+    }
+    getClassName() {
+        return 'AuthLogic';
+    }
+
+    static from(source: any, parentNode?: any, parentKey?: string): AuthLogic {
+        return super.from(source, parentNode, parentKey) as AuthLogic;
+    }
+
+
+    /**
+     * 设置是否为默认鉴权逻辑
+     */
+    setIsDefault(isDefault: boolean) {
+        const object = {
+            isDefault,
+        };
+        this.update({
+            ...object,
+        });
+    }
+
+
+
+
+
+    //================================================================================
+    // ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑
+    // 自动生成的代码已结束。下面可以手动编写。
+    //================================================================================
+    public static getDefaultOptions(): Partial<{
+        body: Array<any>,
+        params: Array<any>,
+        returns: Array<any>,
+    }> {
+        return {
+            body: [
+                {
+                    concept: 'Start',
+                    label: '开始',
+                    kind: 'Statement',
+                    type: 'Start',
+                },
+                {
+                    concept: 'End',
+                    label: '结束',
+                    kind: 'Statement',
+                    type: 'End',
+                },
+            ],
+            params: [
+                {
+                    concept: 'Param', // 产品概念
+                    name: 'request', // 输入参数名称
+                    description: '请求信息，系统自动注入，包含 method、url、header、cookie、body等', // 输入参数描述
+                    typeAnnotation: {
+                        concept: 'TypeAnnotation',
+                        typeKind: 'generic',
+                        typeNamespace: 'nasl.http',
+                        typeName: 'HttpRequest',
+                        typeArguments: [{
+                            concept: 'TypeAnnotation',
+                            typeKind: 'primitive',
+                            typeNamespace: 'nasl.core',
+                            typeName: 'String',
+                        }],
+                    }, // 类型
+                    required: true, // 是否必填
+                },
+                {
+                    concept: 'Param', // 产品概念
+                    name: 'response', // 输入参数名称
+                    description: '请求响应信息，系统自动注入，包含 status、header、cookie、body等', // 输入参数描述
+                    typeAnnotation: {
+                        concept: 'TypeAnnotation',
+                        typeKind: 'generic',
+                        typeNamespace: 'nasl.http',
+                        typeName: 'HttpResponse',
+                        typeArguments: [{
+                            concept: 'TypeAnnotation',
+                            typeKind: 'primitive',
+                            typeNamespace: 'nasl.core',
+                            typeName: 'String',
+                        }],
+                    }, // 类型
+                    required: true, // 是否必填
+                },
+            ],
+            returns: [
+                {
+                    concept: 'Return', // 产品概念
+                    name: 'result', // 输出参数名称
+                    description: '', // 输出参数描述
+                    typeAnnotation: {
+                        concept: 'TypeAnnotation',
+                        typeKind: 'primitive',
+                        typeNamespace: 'nasl.core',
+                        typeName: 'Boolean',
+                    },
+                },
+            ],
+        };
+    }
+
+    /**
+     * 生成宿主语言的文件路径
+     * @param name 一般不用传，用于 rename
+     */
+    getEmbeddedFilePath(name = this.name) {
+        const _path = this.module ? `/${this.module.parentKey}/${this.module.name}` : '';
+        return `/embedded/${this.app.name}${_path}/authLogics/${name}.ts`;
+    }
+
+    getTsNamespace(): string {
+        if (this.parentNode) {
+            const parentNamespace = (this.parentNode as any)?.getTsNamespace();
+            const parentName = this.parentNode.tsName || this.parentNode.name;
+            const arr = [parentNamespace];
+            if (this.parentNode.concept !== 'App' && parentName) {
+                arr.push(parentName);
+            }
+            let namespace = arr.join('.');
+            if (
+                !['nasl.ui', 'nasl.utils', 'nasl.util', 'nasl.browser', 'nasl.auth', 'nasl.configuration', 'nasl.process', 'nasl.logging', 'nasl.io'].includes(namespace)
+                && !namespace.includes('.authLogics')
+            ) {
+                namespace = `${namespace}.authLogics`;
+            }
+            return namespace;
+        } else
+            throw new Error('无法获取命名空间，请设置 parentNode！');
+    }
+
+    //================================================================================
+    // 从这里开始到结尾注释之间的代码由 NASL Workbench 自动生成，请不手动修改！
+    // ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓
+    //================================================================================
+}
+
+classMap.AuthLogic = AuthLogic;
+export default AuthLogic;
+//================================================================================
+// ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑
+// 自动生成的代码已结束。下面可以手动编写。
+//================================================================================

package/src/concepts/BackendVariable__.ts

@@ -0,0 +1,466 @@
+import { dataTypesMap } from './basics/types';
+import { TranslatorState, shiftState, withSourceMap, createCompilerState, indent } from '../translator';
+import { ElementToVueOptions } from './ViewElement__';
+import EntityProperty from './EntityProperty__';
+import StructureProperty from './StructureProperty__';
+import Structure from './Structure__';
+import { getNodeByNodeCallee, getNaslNodeByNodeCallee } from '../automate/engine/utils';
+import Namespace from './Namespace__';
+
+function tryJSONParse(str: string) {
+    let result;
+
+    try {
+        result = JSON.parse(str);
+    } catch (e) { }
+
+    return result;
+}
+//================================================================================
+// 从这里开始到结尾注释之间的代码由 NASL Workbench 自动生成，请不手动修改！
+// ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓
+//================================================================================
+import { EventPayload, Params } from '../common/EventEmitter';
+import { concept, excludedInJSON, property } from '../decorators';
+
+import * as utils from '../utils';
+import { v4 as uuidv4 } from 'uuid';
+import BaseNode from '../common/BaseNode';
+import classMap from '../common/classMap';
+import TypeAnnotation from './TypeAnnotation__';
+import Backend from './Backend__';
+import View from './View__';
+import App from './App__';
+import Module from './Module__';
+import Frontend from './Frontend__';
+
+/**
+ * 全局变量
+ */
+@concept('全局变量')
+export class BackendVariable extends BaseNode {
+    /**
+     * 产品概念
+     */
+    @property()
+    concept: 'BackendVariable' = 'BackendVariable';
+
+    /**
+     * 全局变量名称
+     */
+    @property()
+    name: string = undefined;
+
+    /**
+     * 全局变量描述
+     */
+    @property()
+    description: string = undefined;
+
+    /**
+     * 类型
+     */
+    @property('TypeAnnotation')
+    typeAnnotation: TypeAnnotation = undefined;
+
+    /**
+     * 默认值
+     */
+    @property()
+    defaultValue: string = undefined;
+
+    /**
+     * 作用域
+     */
+    @property()
+    scope: 'request' | 'applicaion' = undefined;
+
+    /**
+     * 祖先 Backend
+     */
+    get Backend() {
+        return this.getAncestor('Backend') as Backend;
+    }
+    /**
+     * 祖先 App
+     */
+    get app() {
+        return this.getAncestor('App') as App;
+    }
+    /**
+     * 祖先 View
+     */
+    get view() {
+        return this.getAncestor('View') as View;
+    }
+    /**
+     * 祖先 Module
+     */
+    get module() {
+        return this.getAncestor('Module') as Module;
+    }
+    /**
+     * 祖先 Frontend
+     */
+    get frontend() {
+        return this.getAncestor('Frontend') as Frontend;
+    }
+
+    /**
+     * @param source 需要合并的部分参数
+     */
+    constructor(source?: Partial<BackendVariable>) {
+        source = Object.assign({}, BackendVariable.getDefaultOptions(), source);
+        super(source);
+        super.subConstructor(source);
+    }
+    getClassName() {
+        return 'BackendVariable';
+    }
+
+    static from(source: any, parentNode?: any, parentKey?: string): BackendVariable {
+        return super.from(source, parentNode, parentKey) as BackendVariable;
+    }
+
+    /**
+     * 从父级删除该节点
+     * @internal
+     */
+    _delete() {
+        let params: Params = null;
+        if (this.parentNode) {
+            params = (this.parentNode as any)?.__removeBackendVariable?.(this);
+        }
+        return params;
+    }
+    /**
+     * 设置全局变量名称
+     */
+    setName(name: string) {
+        const object = {
+            name,
+        };
+        this.update({
+            ...object,
+            field: 'name',
+        });
+    }
+
+    /**
+     * 设置全局变量描述
+     */
+    setDescription(description: string) {
+        const object = {
+            description,
+        };
+        this.update({
+            ...object,
+        });
+    }
+
+    /**
+     * 设置默认值
+     */
+    setDefaultValue(defaultValue: string) {
+        const object = {
+            defaultValue,
+        };
+        this.update({
+            ...object,
+        });
+    }
+
+    /**
+     * 设置作用域
+     */
+    setScope(scope: 'request' | 'applicaion') {
+        const object = {
+            scope,
+        };
+        this.update({
+            ...object,
+        });
+    }
+
+    
+
+    
+
+    /**
+    * 删除类型标注
+    * @param name 类型标注名称
+    */
+    removeTypeAnnotation(name: string): void;
+
+    /**
+     * 删除类型标注
+     * @param typeAnnotation 已有的类型标注实例
+     */
+    removeTypeAnnotation(typeAnnotation: TypeAnnotation): void;
+
+    removeTypeAnnotation(options: string | TypeAnnotation) {
+        let typeAnnotation: TypeAnnotation;
+        if (typeof options === 'string') {
+            typeAnnotation = this.typeAnnotation;
+            if (!typeAnnotation) {
+                throw new Error('找不到类型标注 ' + options);
+            }
+        } else {
+            typeAnnotation = options;
+        }
+        return typeAnnotation.delete();
+    }
+
+    __removeTypeAnnotation(typeAnnotation: TypeAnnotation) {
+        const parentKey = typeAnnotation.parentKey;
+        const params: Params = {
+            parentNode: this,
+            parentKey,
+            index: -1,
+            object: null,
+            oldObject: typeAnnotation,
+        };
+        if (parentKey) {
+            params.parentKey = parentKey;
+            if (Array.isArray((this as any)[parentKey])) {
+                const index = (this as any)[parentKey].indexOf(typeAnnotation);
+                ~index && (this as any)[parentKey].splice(index, 1);
+                params.index = index;
+            } else if ((this as any)[parentKey] === typeAnnotation) {
+                params.index = 0;
+                (this as any)[parentKey] = undefined;
+            }
+        }
+        return params;
+    }
+
+    //================================================================================
+    // ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑
+    // 自动生成的代码已结束。下面可以手动编写。
+    //================================================================================
+    /**
+        * 自动补全的属性列表
+        */
+    completionChildren: Array<EntityProperty | StructureProperty> = undefined;
+
+    toVue(options?: ElementToVueOptions): string {
+        return this.name;
+    }
+
+    toUI(): string {
+        return this.name;
+    }
+
+    toJS(state?: TranslatorState): string {
+        const context = this.view ? 'this' : 'Vue.prototype';
+        const typeAnnotation = this.typeAnnotation || this.__TypeAnnotation;
+        const needGenInitFromSchema = typeAnnotation && (
+            !['primitive', 'union'].includes(typeAnnotation.typeKind)
+            || typeAnnotation.typeName === 'DateTime'
+        );
+        let code = `${this.name} =`;
+        if (needGenInitFromSchema) {
+            code += `${context}.$genInitFromSchema('${typeAnnotation?.sortedTypeKey}',`;
+        }
+        const defaultValue = this.defaultValue;
+        const defaultValueType = Object.prototype.toString.call(defaultValue);
+        const { typeKind, typeNamespace, typeName } = typeAnnotation || {};
+        // 设置成null，才能同步给后端清除该值，但是null对checkbox组件是一种特殊状态
+        let parsedValue = defaultValue ?? undefined;
+        if (
+            defaultValueType === '[object String]'
+            && (
+                !(typeKind === 'primitive' && typeNamespace === 'nasl.core' && ['String', 'Text', 'Email'].includes(typeName))
+                && !(this.isEnum())
+                && !['union'].includes(typeKind)
+            )
+        ) {
+            // 一些特殊情况，特殊处理成undefined
+            // 1.defaultValue在nasl节点上错误得赋值给了空制符串
+            if ([''].includes(defaultValue)) {
+                parsedValue = undefined;
+            } else {
+                parsedValue = tryJSONParse(defaultValue) ?? defaultValue;
+            }
+        }
+        code += JSON.stringify(parsedValue);
+        if (needGenInitFromSchema) {
+            code += `)`;
+        }
+        return code;
+    }
+
+    @withSourceMap()
+    toEmbeddedTS(state?: TranslatorState): string {
+        let code = this.name;
+        if (this.typeAnnotation) {
+            code += ': ';
+            code += this.typeAnnotation.toEmbeddedTS(shiftState(state, code));
+            // toTS暂时只需要翻译引用数据类型的，因为值都是字符串
+            // 就不在这里赋值了，这里单纯就为了快速查找
+            // 并且屏蔽了一些异常的错误
+            if (this.typeAnnotation?.typeKind !== 'primitive' && this.defaultValue) {
+                if (this.isEnum()) {
+                    code += `= ${this.typeAnnotation.typeKey}['${this.defaultValue}']`;
+                }
+            }
+        }
+        return code;
+    }
+    isEnum() {
+        return this.typeAnnotation?.typeNamespace?.endsWith('.enums');
+    }
+
+    /**
+     * 生成宿主语言的文件路径
+     * @param name 一般不用传，用于 rename
+     */
+    getEmbeddedFilePath(name = this.name) {
+        return `/embedded/${this.app.name}/Backend/${this.parentNode.name || 'backend'}/variables/${name}.ts`;
+    }
+    getNamespace() {
+        if (this.parentNode && (this.parentNode as Namespace).getNamespace) {
+            const parentNamespace = (this.parentNode as Namespace).getNamespace();
+            const parentName = this.parentNode.name;
+            const arr = [parentNamespace];
+            if (this.parentNode.concept !== 'App' && parentName) {
+                arr.push(parentName);
+            }
+            if (['App', 'Module', 'Namespace', 'Backend'].includes(this.parentNode?.concept) && this.parentKey === 'variables') {
+                // return `${arr.join('.')}.backendVariables`;
+                return `${arr.join('.')}.variables`;
+            } else {
+                return `${arr.join('.')}.variables`;
+            }
+        } else
+            throw new Error('无法获取命名空间，请设置 parentNode！');
+    }
+    toEmbeddedTSFile() {
+        let code = `namespace ${this.getNamespace()} {\n`;
+        code += `${indent(1)}export let `;
+        const state = createCompilerState(code, { tabSize: 1 });
+        try {
+            code += `${this.toEmbeddedTS(state)}\n`;
+        } catch (err) {
+            code += '\n';
+        }
+        code += '}\n';
+
+        return {
+            code,
+            filePath: this.getEmbeddedFilePath(),
+            sourceMap: state.sourceMap,
+        };
+    }
+
+    @withSourceMap()
+    toEmbeddedTSInProcess(state?: TranslatorState): string {
+        let code = this.name;
+        if (this.typeAnnotation) {
+            code += ': undefined as ';
+            code += this.typeAnnotation.toEmbeddedTS(shiftState(state, code));
+        }
+        // if (this.defaultValue) {
+        //     code += `: ${this.defaultValue}`;
+        // }
+        return code;
+    }
+
+    /**
+     * 设置数据类型
+     * @param typeAnnotation 类型标注对象
+     */
+    async setDataType(typeAnnotation: TypeAnnotation): Promise<void>;
+    /**
+     * 设置数据类型
+     * @param typeAnnotation 类型唯一标识
+     */
+    async setDataType(typeKey: string): Promise<void>;
+    async setDataType(typeAnnotation: TypeAnnotation | string) {
+        if (typeAnnotation) {
+            if (typeof typeAnnotation === 'string') {
+                typeAnnotation = dataTypesMap[typeAnnotation];
+                if (!typeAnnotation)
+                    throw new Error('找不到类型：' + typeAnnotation);
+            } else {
+                typeAnnotation._delete?.();
+                const relationOptions = { parentId: this.id, parentConcept: this.concept, parentNode: this };
+                Object.assign(typeAnnotation, relationOptions);
+            }
+
+            // 处理下拉属性
+            try {
+                this.completionChildren = this.getSelectRef(typeAnnotation, true);
+            } catch (err) {
+                this.completionChildren = [];
+                console.log(err);
+            }
+        } else {
+            this.completionChildren = [];
+        }
+        const object: any = {
+            typeAnnotation: typeAnnotation || null,
+        };
+        // 切换类型的时候如果有默认值就清除掉
+        if (this.defaultValue) {
+            object.defaultValue = '';
+        }
+
+        return this.update({
+            ...object,
+        });
+    }
+
+
+    async _setDataType(typeAnnotation: TypeAnnotation | string) {
+        if (typeAnnotation) {
+            if (typeof typeAnnotation === 'string') {
+                typeAnnotation = dataTypesMap[typeAnnotation];
+                if (!typeAnnotation)
+                    throw new Error('找不到类型：' + typeAnnotation);
+            } else {
+                // typeAnnotation._delete?.();
+                const relationOptions = { parentId: this.id, parentConcept: this.concept, parentNode: this };
+                Object.assign(typeAnnotation, relationOptions);
+            }
+
+            // 处理下拉属性
+            try {
+                this.completionChildren = this.getSelectRef(typeAnnotation, true);
+            } catch (err) {
+                this.completionChildren = [];
+                console.log(err);
+            }
+        } else {
+            this.completionChildren = [];
+        }
+        const object: any = {
+            typeAnnotation: typeAnnotation || null,
+        };
+        // 切换类型的时候如果有默认值就清除掉
+        if (this.defaultValue) {
+            object.defaultValue = '';
+        }
+    }
+    public static getDefaultOptions() {
+        return {};
+    }
+
+    /**
+     * 是否可编辑
+     * */
+    get readonly() {
+        return !!this.module;
+    }
+    //================================================================================
+    // 从这里开始到结尾注释之间的代码由 NASL Workbench 自动生成，请不手动修改！
+    // ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓
+    //================================================================================
+}
+
+classMap.BackendVariable = BackendVariable;
+export default BackendVariable;
+//================================================================================
+// ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑
+// 自动生成的代码已结束。下面可以手动编写。
+//================================================================================