@lcap/nasl 3.7.1-beta.1 → 3.7.2-alpha.1

package/src/concepts/Interface__.ts

@@ -9,6 +9,7 @@ import {
   withSourceMapGenerator,
   withGenerator,
   TranslatorGenerator,
+  createDescriptionComment,
 } from '../translator';
 import type Namespace from './Namespace__';
 import type TypeAnnotation from './TypeAnnotation__';
@@ -62,41 +63,31 @@ export class Interface extends ImportedInterface {
   /**
    * 接口名称
    */
-  @property({
-    objectRef: '',
-  })
+  @property()
   name: string = '';
 
   /**
    * 导出的来源
    */
-  @property({
-    objectRef: '',
-  })
+  @property()
   originLogicName: string;
 
   /**
    * 接口路径
    */
-  @property({
-    objectRef: '',
-  })
+  @property()
   path: string;
 
   /**
    * 接口方法
    */
-  @property({
-    objectRef: '',
-  })
+  @property()
   method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
 
   /**
    * 接口描述
    */
-  @property({
-    objectRef: '',
-  })
+  @property()
   description: string;
 
   /**
@@ -622,17 +613,17 @@ export class Interface extends ImportedInterface {
     });
     super.delete();
     if (this.originLogicName) {
-      const logic = this.app.logics?.find((logic) => logic.name === this.originLogicName)
+      const logic = this.app.logics?.find((logic) => logic.name === this.originLogicName);
       this.app.naslServer?.embeddedTSEmitter.emit('change', {
         value: [
           {
             originEvent: {
               action: 'update',
               target: logic,
-            }
-          }
-        ]
-      })
+            },
+          },
+        ],
+      });
     }
     this.app?.emit('collect:end');
   }
@@ -988,7 +979,11 @@ export class Interface extends ImportedInterface {
   @withSourceMap()
   toNaturalTS(state = createCompilerState(), interfaceName: string): string {
     const { name, params, returns } = this || {};
-    let code = `declare function ${interfaceName || name}(`;
+
+    let code = '';
+    if (state.descriptionComment)
+      code += createDescriptionComment(state, this, ['description']);
+    code = `declare function ${interfaceName || name}(`;
     if (params?.length) {
       code += '{';
       params?.forEach((param, index) => {
@@ -1006,7 +1001,6 @@ export class Interface extends ImportedInterface {
     return code;
   }
 
-
   getNamespace(): string {
     // 针对 Connector 下的 Interface 需要做额外的兼容处理
     // 本来 Connector 对应的 Namespace 是 connector，走默认逻辑就成

package/src/concepts/JSBlock__.ts

@@ -45,9 +45,7 @@ export class JSBlock extends LogicItem {
   /**
    * 代码内容
    */
-  @property({
-    objectRef: '',
-  })
+  @property()
   code: string;
 
   /**

package/src/concepts/JavaLogic__.ts

@@ -45,25 +45,19 @@ export class JavaLogic extends LogicItem {
   /**
    * 包名
    */
-  @property({
-    objectRef: '',
-  })
+  @property()
   packageName: string;
 
   /**
    * className
    */
-  @property({
-    objectRef: '',
-  })
+  @property()
   className: string;
 
   /**
    * 代码内容
    */
-  @property({
-    objectRef: '',
-  })
+  @property()
   code: string;
 
   /**

package/src/concepts/LogicDeclaration__.ts

@@ -38,25 +38,19 @@ export class LogicDeclaration extends BaseNode {
   /**
    * 逻辑名称
    */
-  @property({
-    objectRef: '',
-  })
+  @property()
   name: string = '';
 
   /**
    * 逻辑标题
    */
-  @property({
-    objectRef: '',
-  })
+  @property()
   title: string;
 
   /**
    * 逻辑描述
    */
-  @property({
-    objectRef: '',
-  })
+  @property()
   description: string;
 
   /**
@@ -67,7 +61,7 @@ export class LogicDeclaration extends BaseNode {
     isArray: true,
     defaultValue: null,
   })
-  typeParams?: Array<TypeParam> = null;
+  typeParams?: Array<TypeParam>;
 
   /**
    * 输入参数列表

package/src/concepts/LogicItem__.ts

@@ -117,42 +117,32 @@ export abstract class LogicItem extends BaseNode {
   /**
    * 逻辑项标题
    */
-  @property({
-    objectRef: '',
-  })
-  label?: string = null;
+  @property()
+  label?: string;
 
   /**
    * 逻辑项描述
    */
-  @property({
-    objectRef: '',
-  })
-  description?: string = null;
+  @property()
+  description?: string;
 
   /**
    * 是否折叠
    */
-  @property({
-    objectRef: '',
-  })
+  @property()
   folded?: boolean = false;
 
   /**
    * offsetX
    */
-  @property({
-    objectRef: '',
-  })
-  offsetX?: number = null;
+  @property()
+  offsetX?: number;
 
   /**
    * offsetY
    */
-  @property({
-    objectRef: '',
-  })
-  offsetY?: number = null;
+  @property()
+  offsetY?: number;
 
   /**
    * @param source 需要合并的部分参数

package/src/concepts/Logic__.ts

@@ -17,6 +17,7 @@ import {
   withSourceMapGenerator,
   withGenerator,
   TranslatorGenerator,
+  createDescriptionComment,
 } from '../translator';
 import type App from './App__';
 import type Namespace from './Namespace__';
@@ -89,50 +90,38 @@ export class Logic extends BaseNode {
   /**
    * 逻辑名称
    */
-  @property({
-    objectRef: '',
-  })
+  @property()
   name: string = '';
 
   /**
    * 逻辑标题
    */
-  @property({
-    objectRef: '',
-  })
-  title: string;
+  @property()
+  title?: string;
 
   /**
    * 逻辑描述
    */
-  @property({
-    objectRef: '',
-  })
-  description: string;
+  @property()
+  description?: string;
 
   /**
    * 触发方式
    */
-  @property({
-    objectRef: '',
-  })
-  triggerType: string;
+  @property()
+  triggerType?: string;
 
   /**
    * 定时任务表达式
    */
-  @property({
-    objectRef: '',
-  })
-  cron: string;
+  @property()
+  cron?: string;
 
   /**
    * 是否可覆写
    */
-  @property({
-    objectRef: '',
-  })
-  overridable: boolean;
+  @property()
+  overridable?: boolean;
 
   /**
    * 事务
@@ -140,7 +129,7 @@ export class Logic extends BaseNode {
   @property({
     objectRef: 'Transactional',
   })
-  transactional: Transactional;
+  transactional?: Transactional;
 
   /**
    * 类型参数列表
@@ -150,7 +139,7 @@ export class Logic extends BaseNode {
     isArray: true,
     defaultValue: null,
   })
-  typeParams?: Array<TypeParam> = null;
+  typeParams?: Array<TypeParam>;
 
   /**
    * 输入参数列表
@@ -1574,14 +1563,13 @@ export class Logic extends BaseNode {
     // const needGetSourceMapOqlList: Promise<any>[] = [];
     yield* self.traverseChildrenGenerator(function* traverseChildrenGenerator(el) {
       if (
-        el && (
-          // 批量赋值
-          asserts.isBatchAssignment(el) ||
+        el &&
+        // 批量赋值
+        (asserts.isBatchAssignment(el) ||
           // 赋值
           (asserts.isAssignment(el) && el.left?.name) ||
           // 内置函数对集合类型的推导
-          (asserts.isCallFunction(el) && el.derivablecollection?.name)
-        )
+          (asserts.isCallFunction(el) && el.derivablecollection?.name))
       ) {
         if (asserts.isAssignment(el)) {
           const advanceVar = self.variables?.find(
@@ -1610,7 +1598,7 @@ export class Logic extends BaseNode {
               leftIndex.length === 1
                 ? yield* el.left.expression.toEmbeddedTS(shiftState(state, code, { inline: true }))
                 : yield* el.left.members[leftIndex[1]]?.toEmbeddedTS(shiftState(state, code, { inline: true })) ??
-                returnOrigin('');
+                    returnOrigin('');
             const advanceVar = self.variables?.find(
               (variable) => !variable.typeAnnotation && leftCode === variable.name,
             );
@@ -1663,7 +1651,7 @@ export class Logic extends BaseNode {
             leftIndex.length === 1
               ? yield* assignment.left.expression.toEmbeddedTS(shiftState(state, code, { inline: true }))
               : yield* assignment.left.members[leftIndex[1]]?.toEmbeddedTS(shiftState(state, code, { inline: true })) ??
-              returnOrigin('');
+                  returnOrigin('');
           if (leftCode === node.name) {
             const rightNode: any =
               rightIndex.length === 1
@@ -1788,7 +1776,11 @@ export class Logic extends BaseNode {
   }
 
   @withSourceMapGenerator
-  *toEmbeddedDeclarationTS(state = createCompilerState(), prefix?: string, hideDefaultValue?: boolean): TranslatorGenerator {
+  *toEmbeddedDeclarationTS(
+    state = createCompilerState(),
+    prefix?: string,
+    hideDefaultValue?: boolean,
+  ): TranslatorGenerator {
     const self = this;
     let code = '';
     if (!prefix) {
@@ -1831,7 +1823,6 @@ export class Logic extends BaseNode {
     return code;
   }
 
-
   @withSourceMapGenerator
   *toEmbeddedTS(state = createCompilerState(), prefix?: string, hideDefaultValue?: boolean): TranslatorGenerator {
     const self = this;
@@ -1874,14 +1865,13 @@ export class Logic extends BaseNode {
     const callFunctionAdvanceMap: Map<Return | Variable, CallFunction> = new Map();
     yield* self.traverseChildrenGenerator(function* traverseChildrenGenerator(el) {
       if (
-        el && (
-          // 批量赋值
-          asserts.isBatchAssignment(el) ||
+        el &&
+        // 批量赋值
+        (asserts.isBatchAssignment(el) ||
           // 赋值
           (asserts.isAssignment(el) && el.left?.name) ||
           // 内置函数对集合类型的推导
-          (asserts.isCallFunction(el) && el.derivablecollection?.name)
-        )
+          (asserts.isCallFunction(el) && el.derivablecollection?.name))
       ) {
         if (asserts.isAssignment(el)) {
           const advanceVar = self.variables?.find(
@@ -1910,7 +1900,7 @@ export class Logic extends BaseNode {
               leftIndex.length === 1
                 ? yield* el.left.expression.toEmbeddedTS(shiftState(state, code, { inline: true }))
                 : yield* el.left.members[leftIndex[1]]?.toEmbeddedTS(shiftState(state, code, { inline: true })) ??
-                returnOrigin('');
+                    returnOrigin('');
             const advanceVar = self.variables?.find(
               (variable) => !variable.typeAnnotation && leftCode === variable.name,
             );
@@ -1935,7 +1925,7 @@ export class Logic extends BaseNode {
     code += '{\n';
     if (self.exportInterface) {
       code += indent((state?.tabSize || 0) + 1);
-      code += `let exportInterface = app.interfaces.${self.exportInterface.name};\n`
+      code += `let exportInterface = app.interfaces.${self.exportInterface.name};\n`;
     }
     // 用于虚拟节点的查找引用
     if (Array.isArray(self.virtualParams)) {
@@ -1989,7 +1979,7 @@ export class Logic extends BaseNode {
             leftIndex.length === 1
               ? yield* assignment.left.expression.toEmbeddedTS(shiftState(state, code, { inline: true }))
               : yield* assignment.left.members[leftIndex[1]]?.toEmbeddedTS(shiftState(state, code, { inline: true })) ??
-              returnOrigin('');
+                  returnOrigin('');
           if (leftCode === node.name) {
             const rightNode: any =
               rightIndex.length === 1
@@ -2178,6 +2168,8 @@ export class Logic extends BaseNode {
   @withSourceMap()
   toNaturalTS(state = createCompilerState()): string {
     let code = '';
+    if (state.descriptionComment)
+      code += createDescriptionComment(state, this, ['description']);
 
     let logicName = this.name;
     if (state.autoPrefixName) {
@@ -2234,7 +2226,8 @@ export class Logic extends BaseNode {
       });
 
       if (!this.body.length || this.body.length === 2) {
-        if (`${this.nodePath}.body[1]` === state.focusedNodePath) code += `${indent(state.tabSize + 1)}/* 当前位置 */\n`;
+        if (`${this.nodePath}.body[1]` === state.focusedNodePath)
+          code += `${indent(state.tabSize + 1)}/* 当前位置 */\n`;
         code += `${indent(state.tabSize + 1)}return ${this?.returns?.[0]?.name || ''};\n`;
       } else {
         this.body.forEach((item) => {
@@ -2419,8 +2412,8 @@ export class Logic extends BaseNode {
           collectionTSCode === '__IDENTIFIER__'
             ? collectionTSCode
             : callFunction.isLoopMap && index === 0
-              ? `${collectionTSCode}.__getKey(0)`
-              : `${collectionTSCode}.__get(0)`,
+            ? `${collectionTSCode}.__getKey(0)`
+            : `${collectionTSCode}.__get(0)`,
         );
       }
     });
@@ -2562,8 +2555,9 @@ export class Logic extends BaseNode {
     if (asserts.isFrontendLibrary(this.parentNode)) {
       _path += `/frontends/${this.parentNode.type}`;
     } else if (this.parentNode.concept === 'BindEvent' && this.getAncestor('Frontend')) {
-      _path += `/frontendTypes/${this.getAncestor('FrontendType')?.name}/frontends/${this.getAncestor('Frontend')?.name
-        }/bindEvents/${name}.ts`;
+      _path += `/frontendTypes/${this.getAncestor('FrontendType')?.name}/frontends/${
+        this.getAncestor('Frontend')?.name
+      }/bindEvents/${name}.ts`;
     }
     return `/embedded/${this.getAncestor('App')?.name}${_path}/logics/${name}.ts`;
   }
@@ -2651,6 +2645,11 @@ export class Logic extends BaseNode {
       actionMsg,
     });
     super.delete();
+    this.body.forEach((el) => {
+      if (asserts.isCallInterface(el)) {
+        el.deleteCallNode()
+      }
+    })
     this.traverseChildren(async (el) => {
       if (el?.concept === 'CallQueryComponent') (el as CallQueryComponent).removeStructure();
       // 仅仅针对 自定义连接器下的 Loigc，其他需要界定边界

package/src/concepts/MatchCase__.ts

@@ -73,9 +73,7 @@ export class MatchCase extends LogicItem {
   /**
    * 是否可枚举
    */
-  @property({
-    objectRef: '',
-  })
+  @property()
   isMatchedTypeEnumable: boolean = false;
 
   /**
@@ -152,14 +150,6 @@ export class MatchCase extends LogicItem {
     return logicItem;
   }
 
-  getLogicItemExistingNames(excludedList: Array<LogicItem> = []) {
-    const excludedSet = new Set(excludedList);
-    return ((this.patterns as LogicItem[]) || []).filter((item) => !excludedSet.has(item)).map((item) => item.name);
-  }
-  getLogicItemUniqueName(name = 'logicItem1') {
-    return utils.unique(name, this.getLogicItemExistingNames(), undefined, false);
-  }
-
   /**
    * 插入逻辑项
    * @param logicItemOptions 逻辑项参数
@@ -592,6 +582,14 @@ export class MatchCase extends LogicItem {
   // 自动生成的代码已结束。下面可以手动编写。
   //================================================================================
 
+  getLogicItemExistingNames(excludedList: Array<LogicItem> = []) {
+    const excludedSet = new Set(excludedList);
+    return ((this.patterns as LogicItem[]) || []).filter((item) => !excludedSet.has(item)).map((item) => item.name);
+  }
+  getLogicItemUniqueName(name = 'logicItem1') {
+    return utils.unique(name, this.getLogicItemExistingNames(), undefined, false);
+  }
+
   // 是否处于禁用状态
   get isDisabled() {
     const matchExpression = this.parentNode as Match;
@@ -928,7 +926,9 @@ export class MatchCase extends LogicItem {
   @withSourceMap()
   toTextualNASL(state = createCompilerState()): string {
     let code = '';
-    code += this.patterns.length ? this.patterns.map((pattern) => pattern.toTextualNASL(shiftState(state, code, { inline: true }))).join(' | ') : '_';
+    code += this.patterns.length
+      ? this.patterns.map((pattern) => pattern.toTextualNASL(shiftState(state, code, { inline: true }))).join(' | ')
+      : '_';
     code += ` => `;
     if ((this.parentNode as Match)?.isExpression) {
       this.body.forEach((logicItem) => {

package/src/concepts/Match__.ts

@@ -63,9 +63,7 @@ export class Match extends LogicItem {
   /**
    * 是否表达式形态
    */
-  @property({
-    objectRef: '',
-  })
+  @property()
   isExpression: boolean = false;
 
   /**
@@ -285,7 +283,7 @@ export class Match extends LogicItem {
             if (enabled && messagesLanguageList?.length) {
               const filterChildren = children.filter((child) => {
                 return messagesLanguageList.find((langId) => 'I18nEnum.' + langId === child.value);
-              })
+              });
               return filterChildren.map((child) => child?.expression);
             }
           }
@@ -749,9 +747,15 @@ export class Match extends LogicItem {
     // 最后一项是else
     this.cases.forEach((item, index) => {
       // 如果是最后一项
-      code += item.toNaturalTS(shiftState(state, code, { tabSize: (state?.tabSize || 0) + 1, inline: true }), index, parentCode);
+      code += item.toNaturalTS(
+        shiftState(state, code, { tabSize: (state?.tabSize || 0) + 1, inline: true }),
+        index,
+        parentCode,
+      );
     });
-    code += `${indent(state?.tabSize || 0)}})(${this.expression?.toNaturalTS(shiftState(state, code, { inline: true }))})`;
+    code += `${indent(state?.tabSize || 0)}})(${this.expression?.toNaturalTS(
+      shiftState(state, code, { inline: true }),
+    )})`;
 
     if (
       this.parentNode?.concept !== 'Argument' &&
@@ -777,8 +781,7 @@ export class Match extends LogicItem {
     code += this.expression?.toTextualNASL(shiftState(state, '', { inline: true }));
     code += ` {\n`;
     this.cases.forEach((item, index) => {
-      if (item.body.length)
-        code += item.toTextualNASL(shiftState(state, code, { tabSize: state.tabSize + 1 }));
+      if (item.body.length) code += item.toTextualNASL(shiftState(state, code, { tabSize: state.tabSize + 1 }));
     });
     code += `${indent(state.tabSize)}}\n`;
     return code;

package/src/concepts/MemberExpression__.ts

@@ -540,7 +540,9 @@ export class MemberExpression extends LogicItem {
   @withSourceMap()
   toNaturalTS(state = createCompilerState()): string {
     let code = '';
-    const leftCode = this.object ? `${this.object.toNaturalTS(shiftState(state, code, { inline: true }))}.` : '__IDENTIFIER__';
+    const leftCode = this.object
+      ? `${this.object.toNaturalTS(shiftState(state, code, { inline: true }))}.`
+      : '__IDENTIFIER__';
     code += this.object ? `${this.object.toNaturalTS(shiftState(state, code, { inline: true }))}.` : '__IDENTIFIER__';
     code += this.property ? this.property.toNaturalTS(shiftState(state, code, { inline: true })) : '__IDENTIFIER__';
     // 就说明这是一个枚举取值操作，直接啊app.enums.color.red 要转成字符串
@@ -558,7 +560,11 @@ export class MemberExpression extends LogicItem {
   toTextualNASL(state = createCompilerState()): string {
     let code = '';
     // const leftCode = this.object ? `${this.object.toTextualNASL(shiftState(state, code, { inline: true }))}.` : '';
-    code += this.object ? `${this.object.toTextualNASL(shiftState(state, code, { inline: true }))}${(this.object as Identifier)?.namespace?.includes('.enums') ? '::' : '.'}` : '__IDENTIFIER__';
+    code += this.object
+      ? `${this.object.toTextualNASL(shiftState(state, code, { inline: true }))}${
+          (this.object as Identifier)?.namespace?.includes('.enums') ? '::' : '.'
+        }`
+      : '__IDENTIFIER__';
     code += this.property ? this.property.toTextualNASL(shiftState(state, code, { inline: true })) : '__IDENTIFIER__';
     return code;
   }

package/src/concepts/MetadataType__.ts

@@ -54,26 +54,20 @@ export class MetadataType extends BaseNode {
   /**
    * 名称
    */
-  @property({
-    objectRef: '',
-  })
+  @property()
   name: string = '';
 
   /**
    * 标题
    */
-  @property({
-    objectRef: '',
-  })
+  @property()
   label: string = '元数据';
 
   /**
    * 描述
    */
-  @property({
-    objectRef: '',
-  })
-  description: string;
+  @property()
+  description?: string;
 
   /**
    * 类型
@@ -106,9 +100,7 @@ export class MetadataType extends BaseNode {
   /**
    * 唯一标识
    */
-  @property({
-    objectRef: '',
-  })
+  @property()
   uuid: string = createUUID();
 
   /**
@@ -549,8 +541,7 @@ export class MetadataType extends BaseNode {
     let code = '';
 
     this.rules.forEach((rule, index) => {
-      if (index > 0)
-        code += indent(state.tabSize);
+      if (index > 0) code += indent(state.tabSize);
 
       code += `${rule.toTextualNASL(shiftState(state, code, { tabSize: state.tabSize + 1 }))}\n`;
     });
@@ -565,7 +556,9 @@ export class MetadataType extends BaseNode {
     code += `type ${this.name} = ${this.typeAnnotation.toTextualNASL(state)} {\n`;
 
     this.rules.forEach((rule) => {
-      code += `${indent(state.tabSize)}${rule.toTextualNASL(shiftState(state, code, { tabSize: state.tabSize + 1 }))};\n`;
+      code += `${indent(state.tabSize)}${rule.toTextualNASL(
+        shiftState(state, code, { tabSize: state.tabSize + 1 }),
+      )};\n`;
     });
 
     code += `${indent(state.tabSize)}}\n`;