@lcap/nasl 3.4.0-alpha.1 → 3.4.0-beta.1

package/src/concepts/InterfaceParam__.ts

@@ -1,71 +1,88 @@
-import { v4 as uuidv4 } from 'uuid';
 import { dataTypesMap } from './basics/types';
 import { TranslatorState, shiftState, withSourceMap } from '../translator';
 import StructureProperty from './StructureProperty__';
 import Structure from './Structure__';
 import { getNodeByNodeCallee, getNaslNodeByNodeCallee } from '../automate/engine/utils';
 
-//= ===============================================================================
+//================================================================================
 // 从这里开始到结尾注释之间的代码由 NASL Workbench 自动生成，请不手动修改！
 // ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓
-//= ===============================================================================
+//================================================================================
 import { EventPayload, Params } from '../common/EventEmitter';
-import { concept, excludedInJSON, property } from '../decorators';
+import { concept, excludedInJSON, property, className } 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 Interface from './Interface__';
 import Module from './Module__';
 import App from './App__';
+import Connector from './Connector__';
+import View from './View__';
+import Frontend from './Frontend__';
+import ProcessElement from './ProcessElement__';
+import Process from './Process__';
 
 /**
  * 接口参数
  */
+@className
 @concept('接口参数')
+// @ts-ignore
 export class InterfaceParam extends BaseNode {
+  /** 类名 */
+  static readonly ConceptName = 'InterfaceParam';
+
   /**
    * 产品概念
    */
-  @property()
-  concept: 'InterfaceParam' = 'InterfaceParam';
+  // @ts-ignore
+  readonly concept!: 'InterfaceParam';
 
   /**
    * 接口参数名称
    */
   @property()
-  name: string = undefined;
+  // @ts-ignore
+  name!: string;
 
   /**
    * 接口参数描述
    */
   @property()
-  description: string = undefined;
+  // @ts-ignore
+  description!: string;
 
   /**
    * 类型
    */
-  @property('TypeAnnotation')
-  typeAnnotation: TypeAnnotation = undefined;
+  @property({
+    objectRef: 'TypeAnnotation',
+  })
+  // @ts-ignore
+  typeAnnotation!: TypeAnnotation;
 
   /**
-   * in
+   * 参数位置
    */
   @property()
-  in: 'query' | 'path' | 'body' | 'header' | 'cookie' = undefined;
+  // @ts-ignore
+  in!: 'query' | 'path' | 'body' | 'header' | 'cookie';
 
   /**
    * 是否必填
    */
   @property()
-  required: boolean = undefined;
+  // @ts-ignore
+  required!: boolean;
 
   /**
    * 默认值
    */
   @property()
-  defaultValue: string = undefined;
+  // @ts-ignore
+  defaultValue!: string;
 
   /**
    * 祖先 Interface
@@ -73,35 +90,58 @@ export class InterfaceParam extends BaseNode {
   get interface() {
     return this.getAncestor('Interface') as Interface;
   }
-
   /**
    * 祖先 Module
    */
   get module() {
     return this.getAncestor('Module') as Module;
   }
-
   /**
    * 祖先 App
    */
   get app() {
     return this.getAncestor('App') as App;
   }
+  /**
+   * 祖先 Connector
+   */
+  get connector() {
+    return this.getAncestor('Connector') as Connector;
+  }
+  /**
+   * 祖先 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<InterfaceParam>) {
-    // @ts-ignore
-    source = { ...InterfaceParam.getDefaultOptions(), ...source };
+    source = Object.assign({}, InterfaceParam.getDefaultOptions(), source);
     super(source);
     super.subConstructor(source);
   }
 
-  getClassName() {
-    return 'InterfaceParam';
-  }
-
   static from(source: any, parentNode?: any, parentKey?: string): InterfaceParam {
     return super.from(source, parentNode, parentKey) as InterfaceParam;
   }
@@ -117,7 +157,6 @@ export class InterfaceParam extends BaseNode {
     }
     return params;
   }
-
   /**
    * 设置接口参数名称
    */
@@ -144,7 +183,7 @@ export class InterfaceParam extends BaseNode {
   }
 
   /**
-   * 设置in
+   * 设置参数位置
    */
   setIn(inWhich: 'query' | 'path' | 'body' | 'header' | 'cookie') {
     const object = {
@@ -196,7 +235,7 @@ export class InterfaceParam extends BaseNode {
     if (typeof options === 'string') {
       typeAnnotation = this.typeAnnotation;
       if (!typeAnnotation) {
-        throw new Error(`找不到类型标注 ${options}`);
+        throw new Error('找不到类型标注 ' + options);
       }
     } else {
       typeAnnotation = options;
@@ -205,7 +244,7 @@ export class InterfaceParam extends BaseNode {
   }
 
   __removeTypeAnnotation(typeAnnotation: TypeAnnotation) {
-    const { parentKey } = typeAnnotation;
+    const parentKey = typeAnnotation.parentKey;
     const params: Params = {
       parentNode: this,
       parentKey,
@@ -227,10 +266,10 @@ export class InterfaceParam extends BaseNode {
     return params;
   }
 
-  //= ===============================================================================
+  //================================================================================
   // ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑
   // 自动生成的代码已结束。下面可以手动编写。
-  //= ===============================================================================
+  //================================================================================
   /**
    * 设置数据类型
    * @param typeAnnotation 类型标注对象
@@ -284,15 +323,14 @@ export class InterfaceParam extends BaseNode {
     return code;
   }
 
-  //= ===============================================================================
+  //================================================================================
   // 从这里开始到结尾注释之间的代码由 NASL Workbench 自动生成，请不手动修改！
   // ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓
-  //= ===============================================================================
+  //================================================================================
 }
 
-classMap.InterfaceParam = InterfaceParam;
 export default InterfaceParam;
-//= ===============================================================================
+//================================================================================
 // ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑
 // 自动生成的代码已结束。下面可以手动编写。
-//= ===============================================================================
+//================================================================================

package/src/concepts/Interface__.ts

@@ -1,83 +1,106 @@
-import { v4 as uuidv4 } from 'uuid';
 import { TranslatorState, shiftState, withSourceMap, createCompilerState } from '../translator';
 import Namespace from './Namespace__';
 import TypeAnnotation from './TypeAnnotation__';
 import Structure from './Structure__';
 import Param from './Param__';
-//= ===============================================================================
+//================================================================================
 // 从这里开始到结尾注释之间的代码由 NASL Workbench 自动生成，请不手动修改！
 // ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓
-//= ===============================================================================
+//================================================================================
 import { EventPayload, Params } from '../common/EventEmitter';
-import { concept, excludedInJSON, property } from '../decorators';
+import { concept, excludedInJSON, property, className } from '../decorators';
 
 import * as utils from '../utils';
+import { v4 as uuidv4 } from 'uuid';
 import BaseNode from '../common/BaseNode';
-import classMap from '../common/classMap';
 import InterfaceParam from './InterfaceParam__';
 import Return from './Return__';
 import BindAttribute from './BindAttribute__';
 import Module from './Module__';
+import Connector from './Connector__';
 import App from './App__';
+import View from './View__';
+import Frontend from './Frontend__';
+import ProcessElement from './ProcessElement__';
+import Process from './Process__';
 
 /**
  * 接口
  */
+@className
 @concept('接口')
+// @ts-ignore
 export class Interface extends BaseNode {
+  /** 类名 */
+  static readonly ConceptName = 'Interface';
+
   /**
    * 产品概念
    */
-  @property()
-  concept: 'Interface' | 'AuthInterface' = 'Interface';
+  // @ts-ignore
+  readonly concept!: 'Interface' | 'AuthInterface';
 
   /**
    * 接口名称
    */
   @property()
-  name: string = undefined;
+  // @ts-ignore
+  name!: string;
 
   /**
-   * originLogicName
+   * 导出的来源
    */
   @property()
-  originLogicName: string = undefined;
+  // @ts-ignore
+  originLogicName!: string;
 
   /**
-   * path
+   * 接口路径
    */
   @property()
-  path: string = undefined;
+  // @ts-ignore
+  path!: string;
 
   /**
-   * method
+   * 接口方法
    */
   @property()
-  method: 'GET' | 'POST' | 'PUT' | 'DELETE' = undefined;
+  // @ts-ignore
+  method!: 'GET' | 'POST' | 'PUT' | 'DELETE';
 
   /**
    * 接口描述
    */
   @property()
-  description: string = undefined;
+  // @ts-ignore
+  description!: string;
 
   /**
    * 接口参数列表
    */
-  @property('InterfaceParam')
+  @property({
+    objectRef: 'InterfaceParam',
+    isArray: true,
+  })
   params: Array<InterfaceParam> = [];
 
   /**
    * 输出参数列表
    */
-  @property('Return')
+  @property({
+    objectRef: 'Return',
+    isArray: true,
+  })
   returns: Array<Return> = [];
 
   /**
    * 验证规则
    */
-  @property('BindAttribute')
-  validation: BindAttribute = undefined;
+  @property({
+    objectRef: 'BindAttribute',
+  })
+  // @ts-ignore
+  validation!: BindAttribute;
 
   /**
    * 祖先 Module
@@ -85,28 +108,52 @@ export class Interface extends BaseNode {
   get module() {
     return this.getAncestor('Module') as Module;
   }
-
   /**
    * 祖先 App
    */
   get app() {
     return this.getAncestor('App') as App;
   }
+  /**
+   * 祖先 Connector
+   */
+  get connector() {
+    return this.getAncestor('Connector') as Connector;
+  }
+  /**
+   * 祖先 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<Interface>) {
-    // @ts-ignore
-    source = { ...Interface.getDefaultOptions(), ...source };
+    source = Object.assign({}, Interface.getDefaultOptions(), source);
     super(source);
     super.subConstructor(source);
   }
 
-  getClassName() {
-    return 'Interface';
-  }
-
   static from(source: any, parentNode?: any, parentKey?: string): Interface {
     return super.from(source, parentNode, parentKey) as Interface;
   }
@@ -122,7 +169,6 @@ export class Interface extends BaseNode {
     }
     return params;
   }
-
   /**
    * 设置接口名称
    */
@@ -199,7 +245,7 @@ export class Interface extends BaseNode {
           name: this.getInterfaceParamUniqueName(),
         },
         this,
-        'params'
+        'params',
       );
     } else if (typeof options === 'string') {
       interfaceParam = InterfaceParam.from(
@@ -208,7 +254,7 @@ export class Interface extends BaseNode {
           name: options,
         },
         this,
-        'params'
+        'params',
       );
     } else if (options instanceof InterfaceParam) {
       options.ensureDelete(); // 同一实例不支持多处存在
@@ -221,7 +267,7 @@ export class Interface extends BaseNode {
           ...options,
         },
         this,
-        'params'
+        'params',
       );
     }
     this.params.splice(index, 0, interfaceParam);
@@ -348,7 +394,7 @@ export class Interface extends BaseNode {
           name: this.getReturnUniqueName(),
         },
         this,
-        'returns'
+        'returns',
       );
     } else if (typeof options === 'string') {
       ret = Return.from(
@@ -357,7 +403,7 @@ export class Interface extends BaseNode {
           name: options,
         },
         this,
-        'returns'
+        'returns',
       );
     } else if (options instanceof Return) {
       options.ensureDelete(); // 同一实例不支持多处存在
@@ -370,7 +416,7 @@ export class Interface extends BaseNode {
           ...options,
         },
         this,
-        'returns'
+        'returns',
       );
     }
     this.returns.splice(index, 0, ret);
@@ -478,7 +524,7 @@ export class Interface extends BaseNode {
     if (typeof options === 'string') {
       interfaceParam = (this.params as InterfaceParam[]).find((item) => item.name === options);
       if (!interfaceParam) {
-        throw new Error(`找不到接口参数 ${options}`);
+        throw new Error('找不到接口参数 ' + options);
       }
     } else {
       interfaceParam = options;
@@ -487,7 +533,7 @@ export class Interface extends BaseNode {
   }
 
   __removeInterfaceParam(interfaceParam: InterfaceParam) {
-    const { parentKey } = interfaceParam;
+    const parentKey = interfaceParam.parentKey;
     const params: Params = {
       parentNode: this,
       parentKey,
@@ -526,7 +572,7 @@ export class Interface extends BaseNode {
     if (typeof options === 'string') {
       ret = (this.returns as Return[]).find((item) => item.name === options);
       if (!ret) {
-        throw new Error(`找不到输出参数 ${options}`);
+        throw new Error('找不到输出参数 ' + options);
       }
     } else {
       ret = options;
@@ -535,7 +581,7 @@ export class Interface extends BaseNode {
   }
 
   __removeReturn(ret: Return) {
-    const { parentKey } = ret;
+    const parentKey = ret.parentKey;
     const params: Params = {
       parentNode: this,
       parentKey,
@@ -574,7 +620,7 @@ export class Interface extends BaseNode {
     if (typeof options === 'string') {
       validation = this.validation;
       if (!validation) {
-        throw new Error(`找不到元素绑定属性 ${options}`);
+        throw new Error('找不到元素绑定属性 ' + options);
       }
     } else {
       validation = options;
@@ -583,7 +629,7 @@ export class Interface extends BaseNode {
   }
 
   __removeBindAttribute(bindAttribute: BindAttribute) {
-    const { parentKey } = bindAttribute;
+    const parentKey = bindAttribute.parentKey;
     const params: Params = {
       parentNode: this,
       parentKey,
@@ -605,10 +651,10 @@ export class Interface extends BaseNode {
     return params;
   }
 
-  //= ===============================================================================
+  //================================================================================
   // ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑
   // 自动生成的代码已结束。下面可以手动编写。
-  //= ===============================================================================
+  //================================================================================
 
   /**
    * 协议
@@ -809,6 +855,11 @@ export class Interface extends BaseNode {
    * @param name 一般不用传，用于 rename
    */
   getEmbeddedFilePath(name = this.name) {
+    // 连接器相关的接口，本身没有 module 属性故，需要额外处理
+    if (this.parentNode.concept === 'Connector') {
+      return `/embedded/${this.app.name}/dependencies/${this.parentNode.name}/interfaces/${name}.ts`;
+      ``;
+    }
     const _path = this.module ? `/${this.module.parentKey}/${this.module.name}` : '';
     return `/embedded/${this.app.name}${_path}/interfaces/${name}.ts`;
   }
@@ -937,7 +988,9 @@ export class Interface extends BaseNode {
 
       code += '{\n';
       getCheckerCode();
-      code += this.module ? '' : `let logic =${(this.parentNode as Namespace).getTsNamespace()}.logics.${this.originLogicName};\n`;
+      code += this.module
+        ? ''
+        : `let logic =${(this.parentNode as Namespace).getTsNamespace()}.logics.${this.originLogicName};\n`;
       code += 'let ';
       code += this.returns[0].toEmbeddedTS(shiftState(state, code, { inline: true }));
       code += ';\n';
@@ -947,7 +1000,9 @@ export class Interface extends BaseNode {
     } else {
       code += 'void {\n';
       getCheckerCode();
-      code += this.module ? '' : `let logic =${(this.parentNode as Namespace).getTsNamespace()}.logics.${this.originLogicName};\n`;
+      code += this.module
+        ? ''
+        : `let logic =${(this.parentNode as Namespace).getTsNamespace()}.logics.${this.originLogicName};\n`;
       code += '};';
     }
     code += '\n';
@@ -955,6 +1010,12 @@ export class Interface extends BaseNode {
   }
 
   getNamespace() {
+    // 针对 Connector 下的 Interface 需要做额外的兼容处理
+    // 本来 Connector 对应的 Namespace 是 connector，走默认逻辑就成
+    // 但是后端在翻译 Connector 下的 Interface 时选择的前缀为 extensions 故这里需要强行改成 extensions
+    if (this.parentNode?.concept === 'Connector') {
+      return `extensions.${this.parentNode.name}.interfaces`;
+    }
     if (this.parentNode && (this.parentNode as Namespace).getNamespace) {
       const parentNamespace = (this.parentNode as Namespace).getNamespace();
       const parentName = this.parentNode.name;
@@ -968,6 +1029,12 @@ export class Interface extends BaseNode {
   }
 
   getTsNamespace() {
+    // 针对 Connector 下的 Interface 需要做额外的兼容处理
+    // 本来 Connector 对应的 Namespace 是 connector，走默认逻辑就成
+    // 但是后端在翻译 Connector 下的 Interface 时选择的前缀为 extensions 故这里需要强行改成 extensions
+    if (this.parentNode?.concept === 'Connector') {
+      return `extensions.${this.parentNode.tsName}.interfaces`;
+    }
     if (this.parentNode && (this.parentNode as Namespace).getTsNamespace) {
       const parentNamespace = (this.parentNode as Namespace).getTsNamespace();
       const parentName = this.parentNode.tsName || this.parentNode.name;
@@ -986,7 +1053,7 @@ export class Interface extends BaseNode {
   }
 
   // 递归找出 response/request 的 Body/Returns 引用的数据结构
-  getRefStructures(structures: Structure[] = []): Set<Structure> {
+  getRefStructures(structures: Structure[] = [], includeNameList?: string[] ): Set<Structure> {
     const structuresSet: Set<Structure> = new Set();
     const loopSaveStructure = (typeAnnotation: TypeAnnotation) => {
       if (!typeAnnotation) return;
@@ -1004,7 +1071,11 @@ export class Interface extends BaseNode {
     };
 
     const { params = [], returns = [] } = this;
-    [...params, ...returns].forEach((p) => {
+    let targetList = [...params, ...returns]
+    if (includeNameList && includeNameList.length > 0) {
+      targetList = targetList.filter((item) => includeNameList.includes(item.name))
+    }
+    targetList.forEach((p) => {
       if ('in' in p && p.in === 'cookie') {
         p.in = 'header';
         return;
@@ -1014,15 +1085,27 @@ export class Interface extends BaseNode {
     return structuresSet;
   }
 
-  //= ===============================================================================
+  deleteRefStructures(includeNameList?: string[]) {
+    if (this.upperNode instanceof Connector) {
+      const module = this.upperNode
+      const oldStructuresSet = this.getRefStructures(module.structures, includeNameList);
+      oldStructuresSet.forEach((s: Structure) => s.delete());
+    }
+  }
+
+  deleteInterface() {
+    this.deleteRefStructures()
+    this.delete()
+  }
+
+  //================================================================================
   // 从这里开始到结尾注释之间的代码由 NASL Workbench 自动生成，请不手动修改！
   // ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓
-  //= ===============================================================================
+  //================================================================================
 }
 
-classMap.Interface = Interface;
 export default Interface;
-//= ===============================================================================
+//================================================================================
 // ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑
 // 自动生成的代码已结束。下面可以手动编写。
-//= ===============================================================================
+//================================================================================