@lcap/nasl 3.8.0-beta.8 → 3.8.2-alpha.1

package/src/natural/genNaturalTS.ts

@@ -9,235 +9,359 @@ import {
   getStructures,
   getLogics,
   getModuleInterfaces,
+  getConnections,
   getConnectors,
   getDependencies,
   getFrontendVariables,
+  getServerVariables,
   getFrontendViews,
   getCurrentNodeContext,
   getCurrentNodeContextForUI,
   getNaslUIOld,
+  getNaslUICode,
+  getEnumsCode,
+  getEntitiesCode,
+  getStructuresCode,
+  getLogicsCode,
+  getModuleInterfacesCode,
+  getConnectorsCode,
+  getDependenciesCode,
+  getFrontendViewsCode,
+  wrapTSBlock,
 } from './getContext';
 import { createCompilerState } from '../translator';
+import { fr } from 'date-fns/locale';
+
+export * as getNaturalContext from './getContext';
 
 export function genNaturalTS(app: App, currentNode?: BaseNode, focusedNodePath?: string) {
   if (currentNode?.concept === 'Logic') {
     const logic = currentNode as Logic;
-    const code = logic?.toNaturalTS(createCompilerState(undefined, {
-      focusedNodePath,
-      needNamespace: true,
-      autoPrefixName: true,
-    }));
+    const code = logic?.toNaturalTS(
+      createCompilerState(undefined, {
+        focusedNodePath,
+        needNamespace: true,
+        autoPrefixName: true,
+      })
+    );
     return code;
   }
   return getCurrentNodeContextForUI(currentNode).code;
 }
 
-export function genNaturalTSContextForLogic(
+// =========================== logic ===========================
+export function genNaturalTSContextJSONForLogic(
   app: App,
   currentNode?: BaseNode,
   focusedNodePath?: string,
-  requiredIndexes?: string[],
-  experimental?: boolean
+  experimental?: boolean,
+  material?: {
+    moduleInterfaces: any;
+    connectors: any;
+    dependencies: any;
+    basicMaterials: 'pc' | 'h5' | { json: any; tsDeclaration: string; };
+    extensionMaterials: {
+      name: string;
+      title: string;
+      description: string;
+      tsDescription: string;
+    }[];
+  }
 ) {
   const frontend = currentNode?.getAncestor('Frontend') as Frontend;
   const logicType = currentNode?.parentNode?.concept === 'App' ? 'global_logic' : 'view_logic';
   const state = createCompilerState('', { descriptionComment: true });
 
-  let code = '';
-  code += '### [1] 标准库\n';
-  code += getNaslCore(logicType).code;
-
-  code += '\n### [2] nasl.util\n';
-  code += getNaslUtil().code;
-
-  if (frontend) {
-    code += '\n### [3] nasl.ui\n';
-    code += getNaslUIOld().code;
-  }
-
-  if (logicType === 'global_logic') {
-    code += '\n### [4] nasl.oql\n';
-    code += getNaslOQL().code;
+  const { naslCore } = getNaslCore(logicType);
+  const { naslUtil } = getNaslUtil();
+  const { naslUI } = getNaslUIOld();
+  let components = [];
+  if (logicType === 'view_logic' && material?.basicMaterials && material?.extensionMaterials) {
+    components = getNaslUI(app, frontend.type, {
+      basicMaterials: material?.basicMaterials,
+      extensionMaterials: material?.extensionMaterials,
+    }).naslUI;
   }
+  const { naslOql } = getNaslOQL();
+  const { enums } = getEnums(app, state);
+  const { entities } = getEntities(app, state);
+  const { structures } = getStructures(app, state);
+  const { appLogics } = getLogics(app, currentNode, state);
+  const { interfaceDependencies } = getModuleInterfaces(
+    material?.moduleInterfaces || app?.interfaceDependencies,
+    state
+  );
 
-  code += '\n### [5] 全局上下文\n';
-  code += '\n#### [5-0] 枚举\n';
-  code += getEnums(app, state, requiredIndexes).code;
-
-  code += '\n#### [5-1] 实体\n';
-  code += getEntities(app, state, requiredIndexes).code;
-
-  code += '\n#### [5-2] 可用的数据结构\n';
-  code += getStructures(app, state, requiredIndexes).code;
-
-  code += '\n### [6] 服务端逻辑\n';
-  code += getLogics(app, currentNode, requiredIndexes).code;
-
-  code += '\n### [7] 可调用的接口列表\n';
-  code += getModuleInterfaces(app, state, requiredIndexes).code;
-
-  if (app?.connections?.length > 0 && logicType === 'global_logic') {
-    code += '\n### [8] 连接器逻辑列表\n';
-    code += getConnectors(app, state, requiredIndexes).code;
+  let connections = [];
+  if (material?.connectors?.length) {
+    connections = getConnectors(material.connectors, state).connectors;
+  } else {
+    connections = getConnections(material?.connectors || app.connections, state).connections;
   }
 
-  if (app?.dependencies?.length > 0) {
-    code += '\n### [9] 依赖库逻辑列表\n';
-    code += getDependencies(app, state, requiredIndexes).code;
-  }
+  const { dependencies } = getDependencies(
+    material?.dependencies || app?.dependencies,
+    state,
+    logicType,
+    frontend?.type
+  );
+  const { frontendVariables } = getFrontendVariables(
+    currentNode?.getAncestor('Frontend') as Frontend,
+    state
+  );
 
-  if (frontend) {
-    code += '\n### [10] 页面上下文\n';
-    if (frontend?.variables?.length > 0) {
-      code += '\n#### [10-0] 前端全局变量\n';
-      code += getFrontendVariables(frontend, state).code;
-    }
+  const { backendVariables } = getServerVariables(app, state);
 
-    code += '\n#### [10-1] 前端页面列表\n';
-    code += getFrontendViews(frontend, state, currentNode, true).code;
-  }
+  const { views } = getFrontendViews(frontend, state, currentNode, false);
+  const { currentLogic } = getCurrentNodeContext(currentNode, focusedNodePath, experimental);
 
-  if (focusedNodePath) {
-    code += '\n### 当前逻辑上下文\n';
-    code += getCurrentNodeContext(currentNode, focusedNodePath, experimental).code;
-  }
-  return code;
+  return {
+    naslCore,
+    naslUtil,
+    naslUI,
+    components,
+    naslOql,
+    enums,
+    entities,
+    structures,
+    appLogics,
+    interfaceDependencies,
+    connections,
+    dependencies,
+    frontendVariables,
+    backendVariables,
+    views,
+    currentLogic,
+    logicType,
+  };
 }
 
-export const genNaturalTSContext = genNaturalTSContextForLogic;
-
-export function genNaturalTSContextForUI(
-  app: App,
-  currentNode: BaseNode,
-  focusedNodePath?: string,
-  requiredIndexes?: string[],
-  material?: { basicMaterials: { json: any; tsDeclaration: string; }, extensionMaterials: { name: string; title: string; description: string; tsDescription: string; }[]; },
-) {
-  const frontend = currentNode.getAncestor('Frontend') as Frontend;
-  const state = createCompilerState('', { descriptionComment: true });
+/**
+ * 生成 Logic 的 TypeScript 上下文
+ * @param tsContextJSON: 通过 genNaturalTSContextForLogic 获得到 tsContextJSON
+ * @param codeType: 'detail' | 'short'。detail 为详细代码，short 为简短代码
+ * 'detail' 将所有的code都返回(拼接成详细的code)。RAG召回，分析和执行阶段使用
+ * 'short' 只返回简短的code。模型召回，对应的分析阶段使用
+ * @param requiredIndexes?: 通过索引获取对应的 code。可挑选需要的 code
+ **/
+export const genNaturalTSContextFromJSONForLogic = (
+  tsContextJSON: any,
+  codeType: 'detail' | 'short',
+  requiredIndexes?: string[]
+) => {
+  const {
+    naslCore,
+    naslUtil,
+    naslUI,
+    naslOql,
+    enums,
+    entities,
+    structures,
+    appLogics,
+    interfaceDependencies,
+    connections,
+    dependencies,
+    frontendVariables,
+    backendVariables,
+    views,
+    currentLogic,
+    logicType,
+  } = tsContextJSON;
 
   let code = '';
   code += '### [1] 标准库\n';
-  code += getNaslCore('view_logic').code;
+  code += wrapTSBlock(naslCore);
 
   code += '\n### [2] nasl.util\n';
-  code += getNaslUtil().code;
+  code += wrapTSBlock(naslUtil);
 
-  if (frontend) {
+  if (naslUI && logicType === 'view_logic') {
     code += '\n### [3] nasl.ui\n';
-    code += getNaslUI(app, frontend.type, material || frontend.type, requiredIndexes).code;
-    code += '\n';
+    if (typeof naslUI === 'string') {
+      code += wrapTSBlock(naslUI);
+    } else {
+      code += getNaslUICode(naslUI, codeType, requiredIndexes);
+    }
+  }
+
+  if (naslOql && logicType === 'global_logic') {
+    code += '\n### [4] nasl.oql\n';
+    code += wrapTSBlock(naslOql);
   }
 
   code += '\n### [5] 全局上下文\n';
-  code += '\n#### [5-0] 枚举\n';
-  code += getEnums(app, state, requiredIndexes).code;
+  if (enums.data?.length) {
+    code += '\n#### [5-0] 枚举\n';
+    code += getEnumsCode(enums);
+  }
 
-  code += '\n#### [5-1] 实体\n';
-  code += getEntities(app, state, requiredIndexes).code;
+  if (entities?.length) {
+    code += '\n#### [5-1] 实体\n';
+    code += getEntitiesCode(entities);
+  }
 
-  code += '\n#### [5-2] 可用的数据结构\n';
-  code += getStructures(app, state, requiredIndexes).code;
+  if (structures.data?.length) {
+    code += '\n#### [5-2] 可用的数据结构\n';
+    code += getStructuresCode(structures);
+  }
 
-  code += '\n### [6] 服务端逻辑\n';
-  code += getLogics(app, currentNode, requiredIndexes).code;
+  if (appLogics.data?.length) {
+    code += '\n### [6] 服务端逻辑\n';
+    code += getLogicsCode(appLogics, codeType, requiredIndexes);
+  }
 
-  code += '\n### [7] 可调用的接口列表\n';
-  code += getModuleInterfaces(app, state, requiredIndexes).code;
+  if (interfaceDependencies) {
+    code += '\n### [7] 可调用的接口列表\n';
+    code += getModuleInterfacesCode(interfaceDependencies, codeType, requiredIndexes);
+  }
 
-  if (app?.dependencies?.length > 0) {
+  if (logicType === 'global_logic' && connections) {
+    code += '\n### [8] 连接器逻辑列表\n';
+    code += getConnectorsCode(connections, codeType, requiredIndexes);
+  }
+  if (dependencies) {
     code += '\n### [9] 依赖库逻辑列表\n';
-    code += getDependencies(app, state, requiredIndexes).code;
+    code += getDependenciesCode(dependencies, codeType, requiredIndexes);
   }
 
-  if (frontend) {
+  if (logicType === 'view_logic') {
     code += '\n### [10] 页面上下文\n';
-    if (frontend?.variables?.length > 0) {
+    if (frontendVariables) {
       code += '\n#### [10-0] 前端全局变量\n';
-      code += getFrontendVariables(frontend, state).code;
+      code += frontendVariables;
     }
 
-    code += '\n#### [10-1] 前端页面列表\n';
-    code += getFrontendViews(frontend, state, currentNode, true).code;
+    if (views?.data?.length) {
+      code += '\n#### [10-1] 前端页面列表\n';
+      code += getFrontendViewsCode(views);
+    }
+  } else {
+    code += '\n### [10] 全局变量\n';
+    code += backendVariables;
   }
 
-  code += '\n### 当前页面上下文\n';
-  code += getCurrentNodeContextForUI(currentNode).code;
+  code += '\n### 当前逻辑上下文\n';
+  code += wrapTSBlock(currentLogic);
+
   return code;
-}
+};
 
-export function genNaturalTSContextJSONForLogic(
+export function genNaturalTSContextForLogic(
   app: App,
   currentNode?: BaseNode,
   focusedNodePath?: string,
-  experimental?: boolean
+  requiredIndexes?: string[],
+  experimental?: boolean,
+  material?: {
+    moduleInterfaces: any;
+    connectors: any;
+    dependencies: any;
+    basicMaterials: 'pc' | 'h5' | { json: any; tsDeclaration: string; };
+    extensionMaterials: {
+      name: string;
+      title: string;
+      description: string;
+      tsDescription: string;
+    }[];
+  },
+  restParams?: {
+    codeType?: 'detail' | 'short';
+  }
 ) {
-  const frontend = currentNode?.getAncestor('Frontend') as Frontend;
-  const logicType = currentNode?.parentNode?.concept === 'App' ? 'global_logic' : 'view_logic';
-  const state = createCompilerState('', { descriptionComment: true });
+  const tsContextJSON = genNaturalTSContextJSONForLogic(
+    app,
+    currentNode,
+    focusedNodePath,
+    experimental,
+    material
+  );
+  const code = genNaturalTSContextFromJSONForLogic(
+    tsContextJSON,
+    restParams.codeType,
+    requiredIndexes
+  );
+  return code;
+}
 
-  const { naslCore } = getNaslCore(logicType);
+export const genNaturalTSContext = genNaturalTSContextForLogic;
+export const genNaturalTsContextJson = genNaturalTSContextJSONForLogic;
+
+// =========================== view ===========================
+
+// 生成 View 的 tsJson
+export function genNaturalTSContextJSONForUI(
+  app: App,
+  currentNode: BaseNode,
+  material?: {
+    basicMaterials: 'pc' | 'h5' | { json: any; tsDeclaration: string; };
+    extensionMaterials: {
+      name: string;
+      title: string;
+      description: string;
+      tsDescription: string;
+    }[];
+    moduleInterfaces: any;
+    connectors: any;
+    dependencies: any;
+  }
+) {
+  const frontend = currentNode.getAncestor('Frontend') as Frontend;
+  const state = createCompilerState('', { descriptionComment: true, needNamespace: true });
+
+  const { naslCore } = getNaslCore('view_logic');
   const { naslUtil } = getNaslUtil();
-  const { naslUI } = getNaslUIOld();
-  const { naslOql } = getNaslOQL();
-  const { enums } = getEnums(app, state, []);
-  const { entities } = getEntities(app, state, []);
-  const { structures } = getStructures(app, state, []);
-  const { appLogics } = getLogics(app, currentNode, []);
-  const { interfaceDependencies } = getModuleInterfaces(app, state, []);
-  const { connections } = getConnectors(app, state, []);
-  const { dependencies } = getDependencies(app, state, []);
-  const { frontendVar, frontendVariables } = getFrontendVariables(
-    currentNode?.getAncestor('Frontend') as Frontend,
+  const { naslUI } = getNaslUI(app, frontend.type, {
+    basicMaterials: material?.basicMaterials,
+    extensionMaterials: material?.extensionMaterials,
+  });
+  const { enums } = getEnums(app, state);
+  const { entities } = getEntities(app, state);
+  const { structures } = getStructures(app, state);
+  const { appLogics } = getLogics(app, currentNode, state);
+  const { interfaceDependencies } = getModuleInterfaces(
+    material?.moduleInterfaces || app?.interfaceDependencies,
     state
   );
+  const { dependencies } = getDependencies(
+    material?.dependencies || app?.dependencies,
+    state,
+    'view_logic',
+    frontend?.type
+  );
+  const { frontendVariables } = getFrontendVariables(frontend, state);
   const { views } = getFrontendViews(frontend, state, currentNode, false);
-  const { currentLogic } = getCurrentNodeContext(currentNode, focusedNodePath, experimental);
+  const { currentLogic } = getCurrentNodeContextForUI(currentNode);
 
   return {
     naslCore,
     naslUtil,
     naslUI,
-    naslOql,
     enums,
     entities,
     structures,
     appLogics,
     interfaceDependencies,
-    connections,
     dependencies,
-    frontendVar, // @deprecated
     frontendVariables,
     views,
-    currentLogic,
+    currentPage: currentLogic,
   };
 }
 
-export const genNaturalTsContextJson = genNaturalTSContextJSONForLogic;
-
-export function genNaturalTSContextJSONForUI(
-  app: App,
-  currentNode: BaseNode,
-  material?: { basicMaterials: { json: any; tsDeclaration: string; }, extensionMaterials: { name: string; title: string; description: string; tsDescription: string; }[]; },
-  requiredIndexes?: string[],
-) {
-  const frontend = currentNode.getAncestor('Frontend') as Frontend;
-  const state = createCompilerState();
-
-  const { naslCore } = getNaslCore('view_logic');
-  const { naslUtil } = getNaslUtil();
-  const { naslUI } = getNaslUI(app, frontend.type, material || frontend.type, requiredIndexes);
-  const { enums } = getEnums(app, state, requiredIndexes);
-  const { entities } = getEntities(app, state, requiredIndexes);
-  const { structures } = getStructures(app, state, requiredIndexes);
-  const { appLogics } = getLogics(app, currentNode, requiredIndexes);
-  const { interfaceDependencies } = getModuleInterfaces(app, state, requiredIndexes);
-  const { dependencies } = getDependencies(app, state, requiredIndexes);
-  const { frontendVariables } = getFrontendVariables(frontend, state);
-  const { views } = getFrontendViews(frontend, state, currentNode, true);
-  const { currentLogic } = getCurrentNodeContextForUI(currentNode);
-
-  return {
+/**
+ * 根据 tsContextJSON 生成 View 的 TypeScript 上下文
+ * @param tsContextJSON: 通过 genNaturalTSContextJSONForUI 获得到 tsContextJSON
+ * @param codeType: 'detail' | 'short'。detail 为详细代码，short 为简短代码
+ * 'detail' 将所有的code都返回(拼接成详细的code)。RAG召回，分析和执行阶段使用
+ * 'short' 只返回简短的code。模型召回，对应的分析阶段使用
+ * @param requiredIndexes?: 通过索引获取对应的 code。可挑选需要的 code
+ **/
+export const genNaturalTSContextFromJSONForUI = (
+  tsContextJSON: any,
+  codeType: 'detail' | 'short',
+  requiredIndexes?: string[]
+) => {
+  const {
     naslCore,
     naslUtil,
     naslUI,
@@ -249,8 +373,100 @@ export function genNaturalTSContextJSONForUI(
     dependencies,
     frontendVariables,
     views,
-    currentPage: currentLogic,
-  };
-}
+    currentPage,
+  } = tsContextJSON;
 
-export * as getNaturalContext from './getContext';
+  let code = '';
+  code += '### [1] 标准库\n';
+  code += wrapTSBlock(naslCore);
+
+  code += '\n### [2] nasl.util\n';
+  code += wrapTSBlock(naslUtil);
+
+  if (naslUI) {
+    code += '\n### [3] nasl.ui\n';
+    if (typeof naslUI === 'string') {
+      code += wrapTSBlock(naslUI);
+    } else {
+      code += getNaslUICode(naslUI, codeType, requiredIndexes);
+    }
+  }
+
+  code += '\n### [5] 全局上下文\n';
+  if (enums.data?.length) {
+    code += '\n#### [5-0] 枚举\n';
+    code += getEnumsCode(enums);
+  }
+
+  if (entities?.length) {
+    code += '\n#### [5-1] 实体\n';
+    code += getEntitiesCode(entities);
+  }
+
+  if (structures.data?.length) {
+    code += '\n#### [5-2] 可用的数据结构\n';
+    code += getStructuresCode(structures);
+  }
+
+  if (appLogics.data?.length) {
+    code += '\n### [6] 服务端逻辑\n';
+    code += getLogicsCode(appLogics, codeType, requiredIndexes);
+  }
+
+  if (interfaceDependencies) {
+    code += '\n### [7] 可调用的接口列表\n';
+    code += getModuleInterfacesCode(interfaceDependencies, codeType, requiredIndexes);
+  }
+
+  if (dependencies) {
+    code += '\n### [9] 依赖库逻辑列表\n';
+    code += getDependenciesCode(dependencies, codeType, requiredIndexes);
+  }
+
+  code += '\n### [10] 页面上下文\n';
+  if (frontendVariables) {
+    code += '\n#### [10-0] 前端全局变量\n';
+    code += frontendVariables;
+  }
+
+  if (views?.data?.length) {
+    code += '\n#### [10-1] 前端页面列表\n';
+    code += getFrontendViewsCode(views);
+  }
+
+  code += '\n### 当前页面上下文\n';
+  code += wrapTSBlock(currentPage);
+
+  return code;
+};
+
+// 兼容各版本，统一调用 genNaturalTSContextForUI 方法
+export function genNaturalTSContextForUI(
+  app: App,
+  currentNode: BaseNode,
+  focusedNodePath?: string,
+  requiredIndexes?: string[],
+  material?: {
+    basicMaterials: 'pc' | 'h5' | { json: any; tsDeclaration: string; };
+    extensionMaterials: {
+      name: string;
+      title: string;
+      description: string;
+      tsDescription: string;
+    }[];
+    moduleInterfaces: any;
+    connectors: any;
+    dependencies: any;
+  },
+  restParams?: {
+    codeType?: 'detail' | 'short';
+  }
+) {
+  const tsContextJSON = genNaturalTSContextJSONForUI(app, currentNode, material);
+  const code = genNaturalTSContextFromJSONForUI(
+    tsContextJSON,
+    restParams.codeType,
+    requiredIndexes
+  );
+  return code;
+}