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

package/src/concepts/CallAuthInterface__.ts

@@ -0,0 +1,490 @@
+import Param from './Param__';
+import { TranslatorState, shiftState, withSourceMap } from '../translator';
+import { getNodeByNodeCallee } from '@nasl/automate/engine/utils';
+import AuthLogicForCallInterface from './AuthLogicForCallInterface__';
+import LogicItem from './LogicItem__';
+
+//================================================================================
+// 从这里开始到结尾注释之间的代码由 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 Argument from './Argument__';
+import CallInterface from './CallInterface__';
+
+/**
+ * 调用接口
+ */
+@concept('调用接口')
+export class CallAuthInterface extends CallInterface {
+    /**
+     * 产品概念
+     */
+    @property()
+    concept: 'CallAuthInterface' = 'CallAuthInterface';
+
+    /**
+     * 鉴权逻辑所需参数
+     */
+    @property('Argument')
+    authArguments: Array<Argument> = [];
+
+    /**
+     * @param source 需要合并的部分参数
+     */
+    constructor(source?: Partial<CallAuthInterface>) {
+        source = Object.assign({}, CallAuthInterface.getDefaultOptions(), source);
+        super(source);
+        super.subConstructor(source);
+    }
+    getClassName() {
+        return 'CallAuthInterface';
+    }
+
+    static from(source: any, parentNode?: any, parentKey?: string): CallAuthInterface {
+        return super.from(source, parentNode, parentKey) as CallAuthInterface;
+    }
+
+    getArgumentExistingNames(excludedList: Array<Argument> = []) {
+        const excludedSet = new Set(excludedList);
+        return ((this.authArguments as Argument[]) || []).filter((item) => !excludedSet.has(item)).map((item) => item.name);
+    }
+    getArgumentUniqueName(name = 'argument1') {
+        return utils.unique(name, this.getArgumentExistingNames(), undefined, false);
+    }
+
+    /**
+    * 插入实际参数
+    * @internal
+    * @param name 实际参数名称，如果不填会自动生成一个唯一名称
+    */
+    _insertArgumentAt(name: string, index: number): Argument;
+
+    /**
+    * 插入实际参数
+    * @internal
+    * @param argumentOptions 实际参数参数
+    */
+    _insertArgumentAt(argumentOptions: Partial<Argument>, index: number): Argument;
+
+    /**
+    * 插入实际参数
+    * @internal
+    * @param argument 已有的实际参数实例
+    */
+    _insertArgumentAt(argument: Argument, index: number): Argument;
+
+    _insertArgumentAt(options: string | Partial<Argument> | Argument, index: number) {
+        const argumentOptions: any = {};
+        const relationOptions = { parentNode: this, parentKey: 'authArguments' };
+        let argument: Argument;
+        if (!options) {
+            argument = Argument.from({
+                ...argumentOptions,
+                name: this.getArgumentUniqueName(),
+            }, this, 'authArguments');
+        } else if (typeof options === 'string') {
+            argument = Argument.from({
+                ...argumentOptions,
+                name: options,
+            }, this, 'authArguments');
+        } else if (options instanceof Argument) {
+            options.ensureDelete(); // 同一实例不支持多处存在
+            argument = options;
+            Object.assign(argument, relationOptions);
+        } else {
+            argument = Argument.from({
+                ...argumentOptions,
+                ...options,
+            }, this, 'authArguments');
+        }
+        this.authArguments.splice(index, 0, argument);
+        return argument;
+    }
+
+    /**
+     * 插入实际参数
+     * @param name 实际参数名称，如果不填会自动生成一个唯一名称
+     */
+    insertArgumentAt(name: string, index: number): Argument;
+
+    /**
+     * 插入实际参数
+     * @param argumentOptions 实际参数参数
+     */
+    insertArgumentAt(argumentOptions: Partial<Argument>, index: number): Argument;
+
+    /**
+     * 插入实际参数
+     * @param argument 已有的实际参数实例
+     */
+    insertArgumentAt(argument: Argument, index: number): Argument;
+
+    insertArgumentAt(options: string | Partial<Argument> | Argument, index: number) {
+        const node = this._insertArgumentAt(options as any, index);
+        node.create({
+            index,
+            parentNode: this,
+            parentKey: 'authArguments',
+        });
+        return node;
+    }
+
+    /**
+     * 添加实际参数
+     * @internal
+     * @param name 实际参数名称，如果不填会自动生成一个唯一名称
+     */
+    _addArgument(name?: string): Argument;
+
+    /**
+     * 添加实际参数
+     * @internal
+     * @param argumentOptions 实际参数参数
+     */
+    _addArgument(argumentOptions: Partial<Argument>): Argument;
+
+    /**
+     * 添加实际参数
+     * @internal
+     * @param argument 已有的实际参数实例
+     */
+    _addArgument(argument: Argument): Argument;
+
+    _addArgument(options?: string | Partial<Argument> | Argument) {
+        const index = this.authArguments.length;
+        return this._insertArgumentAt(options as any, index);
+    }
+
+    /**
+     * 添加实际参数
+     * @internal
+     * @param name 实际参数名称，如果不填会自动生成一个唯一名称
+     */
+    addArgument(name?: string): Argument;
+
+    /**
+     * 添加实际参数
+     * @param argumentOptions 实际参数参数
+     */
+    addArgument(argumentOptions: Partial<Argument>): Argument;
+
+    /**
+     * 添加实际参数
+     * @param argument 已有的实际参数实例
+     */
+    addArgument(argument: Argument): Argument;
+
+    addArgument(options?: string | Partial<Argument> | Argument) {
+        const node = this._addArgument(options as any);
+        const index = this.authArguments.indexOf(node);
+        node.create({
+            index,
+            parentNode: this,
+            parentKey: 'authArguments',
+        });
+        return node;
+    }
+
+    /**
+    * 删除实际参数
+    * @param name 实际参数名称
+    */
+    removeArgument(name: string): void;
+
+    /**
+     * 删除实际参数
+     * @param argument 已有的实际参数实例
+     */
+    removeArgument(argument: Argument): void;
+
+    removeArgument(options: string | Argument) {
+        let argument: Argument;
+        if (typeof options === 'string') {
+            argument = (this.authArguments as Argument[]).find((item) => item.name === options);
+            if (!argument) {
+                throw new Error('找不到实际参数 ' + options);
+            }
+        } else {
+            argument = options;
+        }
+        return argument.delete();
+    }
+
+    __removeLogicItem(logicItem: LogicItem) {
+        const parentKey = logicItem.parentKey;
+        const params: Params = {
+            parentNode: this,
+            parentKey,
+            index: -1,
+            object: null,
+            oldObject: logicItem,
+        };
+        if (parentKey) {
+            params.parentKey = parentKey;
+            if (Array.isArray((this as any)[parentKey])) {
+                const index = (this as any)[parentKey].indexOf(logicItem);
+                ~index && (this as any)[parentKey].splice(index, 1);
+                params.index = index;
+            } else if ((this as any)[parentKey] === logicItem) {
+                params.index = 0;
+                (this as any)[parentKey] = undefined;
+            }
+        }
+        return params;
+    }
+
+    //================================================================================
+    // ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑
+    // 自动生成的代码已结束。下面可以手动编写。
+    //================================================================================
+    /**
+     *删除所有的 Argument
+     */
+    removeAllArgument():void {
+        const snapshot = this.authArguments.slice();
+        snapshot.forEach((argument) => {
+            this.removeArgument(argument);
+        });
+    }
+
+    /**
+     * 批量增加AuthArgument
+     */
+    batchAddArgument(args: Argument[]):void {
+        args.forEach((argument) => {
+            this.addArgument(argument);
+        });
+    }
+
+    _insertNormalArgumentAt(options: Partial<Argument> | Argument, index: number) {
+        const argumentOptions: any = {};
+        const relationOptions = { parentNode: this, parentKey: 'arguments' };
+        let argument: Argument;
+        if (options instanceof Argument) {
+            options.ensureDelete(); // 同一实例不支持多处存在
+            argument = options;
+            Object.assign(argument, relationOptions);
+        } else {
+            argument = Argument.from({
+                ...argumentOptions,
+                ...options,
+            }, this, 'arguments');
+        }
+        this.arguments.splice(index, 0, argument);
+        return argument;
+    }
+
+    _addNormalArgument(options?: string | Partial<Argument> | Argument) {
+        const index = this.arguments.length;
+        return this._insertNormalArgumentAt(options as any, index);
+    }
+
+    /**
+     * 批量增加Argument
+     */
+    addNormalArgument(options?: Partial<Argument> | Argument) {
+        const node = this._addNormalArgument(options as any);
+        const index = this.arguments.indexOf(node);
+        node.create({
+            index,
+            parentNode: this,
+            parentKey: 'arguments',
+        });
+        return node;
+    }
+
+    get tsAuthLogicKey() {
+        if (!this.calleeName) {
+            return '__IDENTIFIER__';
+        }
+        const tsAuthLogicNamespace = 'app.authLogicsForCallInterface';
+        const callee = getNodeByNodeCallee(this.app, this.calleewholeKey);
+        const authLogicName = callee.authLogic;
+        return authLogicName ? `${tsAuthLogicNamespace}.${authLogicName}` : '__IDENTIFIER__';
+    }
+
+    get tsCalleeKey(): string {
+        const tsCalleeNamespace = this.tsCalleeNamespace;
+        // http://projectmanage.netease-official.lcap.163yun.com/dashboard/BugDetail?id=2653024591642368
+        const calleeName = `${this.tsCalleeName}_auth_$_api`;
+        return calleeName ? `${tsCalleeNamespace}.${calleeName}` : '__IDENTIFIER__';
+    }
+
+    @withSourceMap()
+    toEmbeddedTS(state?: TranslatorState): string {
+        let code = this.tsAuthLogicKey;
+        // 目前没有任何其他范型，故这里先支持默认俩范型
+        // FIXME
+        code += `<Parameters<typeof ${this.tsCalleeKey}>[0], ReturnType<typeof ${this.tsCalleeKey}>>`;
+        code += '(';
+        const completeAuthArguments = this.completeAuthArguments;
+        if (completeAuthArguments?.length) {
+            code += '{';
+            completeAuthArguments?.forEach((arg, index) => {
+                code += arg?.toEmbeddedTS(shiftState(state, code), arg.paramRequired, true);
+                code += ',';
+            });
+            code += `api: `;
+            code += this.tsCalleeKey;
+            const completeArguments = this.completeArguments;
+            code += '(';
+            if (completeArguments?.length) {
+                code += '{';
+                completeArguments?.forEach((arg, index) => {
+                    code += arg?.toEmbeddedTS(shiftState(state, code), arg.paramRequired, true);
+                    if (index !== this.arguments?.length - 1)
+                        code += ', ';
+                });
+                code += '}';
+            }
+            code += ')';
+            code += '}';
+        } else {
+            code += '{';
+            code += 'api: ';
+            code += this.tsCalleeKey;
+            const completeArguments = this.completeArguments;
+            code += '(';
+            if (completeArguments?.length) {
+                code += '{';
+                completeArguments?.forEach((arg, index) => {
+                    code += arg?.toEmbeddedTS(shiftState(state, code), arg.paramRequired, true);
+                    if (index !== this.arguments?.length - 1)
+                        code += ', ';
+                });
+                code += '}';
+            }
+            code += ')';
+            code += '}';
+        }
+
+        code += ')';
+
+        if (this.parentNode.concept !== 'Argument'
+            && this.parentKey !== 'test'
+            && this.parentKey !== 'patterns'
+            && this.parentNode.concept !== 'Assignment'
+            && this.parentNode.concept !== 'ForEachStatement'
+            && this.parentNode.concept !== 'SelectMembers'
+            && this.parentNode.concept !== 'BinaryExpression'
+            && this.parentNode.concept !== 'MemberExpression'
+            && this.parentNode.concept !== 'StringInterpolation'
+            && !['NewMap', 'NewList'].includes(this.parentNode.concept)) {
+            code += ';';
+        }
+        code += '\n';
+        return code;
+    }
+
+    // @withSourceMap()
+    // toEmbeddedTSForApi(state?: TranslatorState): string {
+
+    //     return code;
+    // }
+
+    get completeAuthArguments() {
+        const node = this.getCallNode(); //AuthInterface
+        const authLogic = node?.authLogic;
+        if (!authLogic) {
+            return [];
+        }
+        const targetAuthLogic = this.app.authLogicsForCallInterface.find((logic) => logic.name === authLogic);
+        const logicParam: Param[] = targetAuthLogic?.authParams || [];
+        const Arguments: Argument[] = [];
+
+        if (this.authArguments?.length) {
+            this.authArguments.forEach((arg) => {
+                const idx = logicParam.findIndex((params) => arg.keyword === params.name);
+                const param = logicParam[idx];
+
+                arg.paramRequired = param?.required;
+                arg.paramTypeAnnotation = undefined;
+                arg.paramDefaultValue = undefined;
+                // 取到是不是必填放入参数中
+                if (param && !arg.expression) {
+                    // 非必填时 才会有默认值
+                    // 因为之前接口这里的必填非必填，一直是有值的，而且不允许修改
+                    arg.paramTypeAnnotation = param.typeAnnotation;
+                    arg.paramDefaultValue = param.defaultValue;
+                }
+                Arguments.push(arg);
+            });
+        }
+        return Arguments;
+    }
+
+    deleteCalleeArg(argIndex: number) {
+        /**
+         * 传递过下标来，然后直接移动到最后结束
+         * 如果原来就是最后一个位置就不移动了
+         */
+        if (typeof argIndex === 'number') {
+            if (!this.authArguments[argIndex]?.expression) {
+                return this.authArguments[argIndex]?.delete();
+            }
+            if (argIndex !== this.authArguments.length - 1) {
+                // 如果本身没有值就直接删除
+                this.authArguments[argIndex]?.moveNode({
+                    sourceNode: this.authArguments[this.arguments.length - 1],
+                    position: 'insertAfter',
+                });
+            }
+        }
+    }
+
+    addCalleeArg(logic: AuthLogicForCallInterface) {
+        const newArgs = this.authArguments.map((argument) =>
+            Argument.from({
+                ...argument,
+            }, this));
+        const relationOptions = { parentNode: this, parentKey: 'authArguments' };
+        /**
+         * 当前两个参数对应上，添加的时候，logic会比参数位内容多，就添加一个 argment
+         */
+        if (logic.authParams.length >= newArgs.length) {
+            logic.authParams.forEach((param: Param, index: number) => {
+                const arg = newArgs[index];
+                if (!arg) {
+                    const newParam = Argument.from({
+                        keyword: param.name,
+                    }, this);
+                    Object.assign(newParam, relationOptions);
+                    newArgs.push(newParam);
+                } else {
+                    arg.keyword = param.name;
+                }
+            });
+        } else {
+            /**
+             * 当前calllogic上数量比logic参数还多，他就需要找一个arg使他变成可用的参数
+             */
+            newArgs.forEach((arg: Argument, index: number) => {
+                const param = logic.authParams[index];
+                if (param) {
+                    arg.keyword = param.name;
+                }
+            });
+        }
+        this.update({
+            authArguments: newArgs,
+        });
+    }
+    //================================================================================
+    // 从这里开始到结尾注释之间的代码由 NASL Workbench 自动生成，请不手动修改！
+    // ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓
+    //================================================================================
+}
+
+classMap.CallAuthInterface = CallAuthInterface;
+export default CallAuthInterface;
+//================================================================================
+// ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑
+// 自动生成的代码已结束。下面可以手动编写。
+//================================================================================

package/src/concepts/CallInterface__.ts

@@ -30,7 +30,7 @@ export class CallInterface extends LogicItem {
      * 产品概念
      */
     @property()
-    concept: 'CallInterface' = 'CallInterface';
+    concept: 'CallInterface' | 'CallAuthInterface' = 'CallInterface';
 
     /**
      * 调用接口标题
@@ -231,9 +231,16 @@ export class CallInterface extends LogicItem {
     // 自动生成的代码已结束。下面可以手动编写。
     //================================================================================
 
+    /**
+     * 标识当前删除是否为鉴权方式更新导致的删除。
+     * 针对此种删除，删除逻辑已经处理，需要再此走 deleteCallNode 逻辑
+     */
+    @property('Boolean')
+    __authDelete: Boolean = false;
+
     // 删除调用接口时且接口无引用，删除接口和数据结构
     async deleteCallNode() {
-        if (this.calleeKey !== '__IDENTIFIER__') {
+        if (this.calleeKey !== '__IDENTIFIER__' && !this.__authDelete) {
             (this as any).__deleteCallNodeTimer = setTimeout(async () => {
                 clearTimeout((this as any).__deleteCallNodeTimer);
                 // 计算之前选择的接口的引用次数
@@ -541,6 +548,7 @@ export class CallInterface extends LogicItem {
             Object.assign(argument, relationOptions);
             return argument;
         });
+
         if (this.app) {
             this.app.emit('collect:start', {
                 actionMsg: `切换调用逻辑`,

package/src/concepts/CallLogic__.ts

@@ -404,6 +404,7 @@ export class CallLogic extends LogicItem {
             // 页面逻辑单独处理
             return `${this.view.getNamespace()}.${this.view.name}.logics.${this.calleeName}`;
         }
+        // "app.logics"
         return this.calleeNamespace + '.' + this.calleeName;
     }
     get calleeKey(): string {
@@ -464,6 +465,7 @@ export class CallLogic extends LogicItem {
     }
 
     _setCallee(logic: Logic) {
+        console.trace();
         this.calleeNamespace = logic.getNamespace();
         if (logic.parentNode instanceof View) {
             this.calleeNamespace = '';
@@ -707,7 +709,7 @@ export class CallLogic extends LogicItem {
             }
         }
         const completeArguments = this.completeArguments;
-        // 全局逻辑
+        // 服务端逻辑
         if (!this.isViewLogic) {
             const logic = getNodeByNodeCallee(this.app, this.calleewholeKey, (key: string, tempPoint: any) => {
                 // 处理 NASL 中未定义的假的节点