@anyblock/any-block-core 3.4.6 → 3.4.10

package/ABConvertEvent.ts

@@ -7,6 +7,8 @@
  * 这些操作统一注册在此处
  */
 
+import { ABCSetting } from "./ABSetting"
+
 /**
  * 一些AB块的后触发事件 - css加载完触发
  * 
@@ -267,41 +269,8 @@ export function abConvertEvent(d: Element|Document, isCycle: boolean = false) {
         const scale_new = el_g.getBBox().height/el_div.offsetWidth;
         el_svg.setAttribute("style", `height:${el_g.getBBox().height*scale_new+40}px`); // 重调容器大小
         // el_g.setAttribute("transform", `translate(20.0,80.0) scale(${scale_new})`) // 重调位置和缩放
-        markmap_event(d) // 好像调位置有问题，只能重渲染了……
+        ABCSetting.obsidian.markmap_event?.(d) // 好像调位置有问题，只能重渲染了……
       }
     }
   }
 }
-
-/**
- * 一些AB块的后触发事件 - dom加载完触发 - markmap
- */
-export function markmap_event(d: Element|Document) {
-  // xxx2markmap，渲染事件
-  if (d.querySelector('.ab-markmap-svg')) {
-    console.log("  - markmap_event")
-    let script_el: HTMLScriptElement|null = document.querySelector('script[script-id="ab-markmap-script"]');
-    if (script_el) script_el.remove();
-    const divEl = d as Element;
-    let markmapId = '';
-    if (divEl.tagName === 'DIV') {
-      markmapId = divEl.querySelector('.ab-markmap-svg')?.id || '';
-    }
-    script_el = document.createElement('script'); document.head.appendChild(script_el);
-    script_el.type = "module";
-    script_el.setAttribute("script-id", "ab-markmap-script");
-    script_el.textContent = `
-    import { Markmap, } from 'https://jspm.dev/markmap-view';
-    const markmapId = "${markmapId || ''}";
-    let mindmaps;
-    if (markmapId) {
-      mindmaps = document.querySelectorAll('#' + markmapId);
-    } else {
-      mindmaps = document.querySelectorAll('.ab-markmap-svg'); // 注意一下这里的选择器
-    }
-    for(const mindmap of mindmaps) {
-      mindmap.innerHTML = "";
-      Markmap.create(mindmap,null,JSON.parse(mindmap.getAttribute('data-json')));
-    }`;
-  }
-}

package/ABConvertManager.ts

@@ -25,7 +25,18 @@ import {
 } from './converter/ABConvert'
 import { autoABAlias } from "./ABAlias"
 import { ABCSetting } from "./ABSetting"
- 
+
+/** 上个处理器的结果
+ * 多个处理器串连时，每个处理器给下一个处理器的东西。
+ * 标注了上次的处理结果，以让下个处理器判断是否能继续处理，还是跳过。
+ */
+type PREV = {
+    prev_result: ABConvert_IOType;            // 上次转换后的结果，初始必为string
+    prev_type: string;                        // 上次转换后的结果的类型 (类型检测而来)
+    prev_type2: ABConvert_IOEnum;             // 上次转换后的结果的类型 (接口声明而来)
+    prev_processor: string | undefined | any; // 上一次执行转换的处理器
+}
+
 /**
   * AB转换器的管理器。注意：使用前必须先执行：`redefine_renderMarkdown`
   * 
@@ -82,15 +93,15 @@ export class ABConvertManager {
    * @detail 这里需要能够被回调函数替换。从而用于接回软件自身的html渲染机制，来进行解耦
    * @param markdown 原md
    * @param el 要追加到的元素
-   * @param ctx Obsidian在这里需要传入 MarkdownRenderChild 类型，但为了跨平台我这里修改成可选的any类型
+   * @param ctx Obsidian在这里需要传入 MarkdownRenderChild 类型，但为了跨平台我这里修改成可选的unknown类型
    */
-  public m_renderMarkdownFn:(markdown: string, el: HTMLElement, ctx?: any) => void = (markdown, el) => {
+  public m_renderMarkdownFn:(markdown: string, el: HTMLElement, ctx?: unknown) => void = (markdown, el) => {
     el.classList.add("markdown-rendered") // 并注意，应当在使用该函数前将el添加该css类，或者重定义时增加该条语句
     console.error("Please use renderMarkdownFn redefine render function")
   }
 
   /// 用回调函数替换重渲染器
-  public redefine_renderMarkdown(callback: (markdown: string, el: HTMLElement, ctx?: any) => void) {
+  public redefine_renderMarkdown(callback: (markdown: string, el: HTMLElement, ctx?: unknown) => void) {
     this.m_renderMarkdownFn = callback
   }
 
@@ -110,25 +121,24 @@ export class ABConvertManager {
    * @param header 转换方式
    * @param content 要转换的初始文本 (无前缀版本，前缀在选择器环节已经删除了)
    * @param selectorName 选择器名，空表示未知
-   * @return 等于el，无用，后面可以删了
    */
-  public static autoABConvert(el:HTMLDivElement, header:string, content:string, selectorName:string = "", ctx?: any): void{
-    let prev_result: ABConvert_IOType = content               // 上次转换后的结果，初始必为string
-    let prev_type: string = "string"                          // 上次转换后的结果的类型 (类型检测而来)
-    let prev_type2: ABConvert_IOEnum = ABConvert_IOEnum.text  // 上次转换后的结果的类型 (接口声明而来)
-    let prev_processor;                                       // 上一次转换的处理器
-    let prev = {                                              // 组合在一起是为了引用传参
-      prev_result, prev_type, prev_type2, prev_processor
+  public static autoABConvert(el:HTMLDivElement, header:string, content:string, selectorName:string = "", ctx?: unknown): void{
+    // 初始情况，上一个处理器不存在
+    let prev: PREV = {
+      prev_result: content,
+      prev_type: "string",
+      prev_type2: ABConvert_IOEnum.text,
+      prev_processor: undefined,
     }
 
-    if (false && ABCSetting.is_debug) ABConvertManager.startTime = performance.now();
+    if (false && ABCSetting.is_debug) ABConvertManager.startTime = performance.now(); // 性能检查1
     {
-      header = autoABAlias(header, selectorName, prev_result as string);
+      header = autoABAlias(header, selectorName, prev.prev_result as string);
       let list_header = header.split("|")
-      prev_result = this.autoABConvert_runConvert(el, list_header, prev, ctx)
+      this.autoABConvert_runConvert(el, list_header, prev, ctx)
       this.autoABConvert_last(el, header, selectorName, prev, ctx)
     }
-    if (false && ABCSetting.is_debug) {
+    if (false && ABCSetting.is_debug) { // 性能检查2
       const endTime = performance.now();
       console.log(`Takes ${(endTime - ABConvertManager.startTime).toFixed(2)} ms when selector "${selectorName}" header "${header}"`);
     }
@@ -143,7 +153,11 @@ export class ABConvertManager {
    * @param prev_type2  上次转换后的结果的类型 (接口声明而来, IOEnum类型)
    * @returns           递归转换后的结果
    */
-  private static autoABConvert_runConvert(el:HTMLDivElement, list_header:string[], prev:any, ctx?: any):any{
+  private static autoABConvert_runConvert(
+    el:HTMLDivElement, list_header:string[],
+    prev: PREV,
+    ctx?: unknown
+  ): PREV | void {
     // 循环header组，直到遍历完文本处理器或遇到渲染处理器
     for (let item_header of list_header){ // TODO 因为可能被插入新的“中间自动转换器”，要么for替换成递归，要么都在头部预处理时弄完
       for (let abReplaceProcessor of ABConvertManager.getInstance().list_abConvert){
@@ -179,7 +193,7 @@ export class ABConvertManager {
               prev.prev_type2==ABConvert_IOEnum.text
             ){ // 需要输入html，实际输入md，则插入一个md->html
               const subEl: HTMLDivElement = document.createElement("div"); el.appendChild(subEl);
-              ABConvertManager.getInstance().m_renderMarkdownFn(prev.prev_result, subEl);
+              ABConvertManager.getInstance().m_renderMarkdownFn(prev.prev_result as string, subEl);
               prev.prev_result = el
               prev.prev_type = typeof(prev.prev_result)
               prev.prev_type2 = ABConvert_IOEnum.el
@@ -206,7 +220,14 @@ export class ABConvertManager {
           }
 
           // (2) 执行处理器
-          prev.prev_result = abReplaceProcessor.process(el, item_header, prev.prev_result, ctx)
+          // 避免用户扩展或PR的一些新处理器不正常
+          // TODO cm 相关的依赖升级后，list2card 中包含 `<br>` 时，id `id:c2listdata2items-e` 存在错误
+          try {
+            prev.prev_result = abReplaceProcessor.process(el, item_header, prev.prev_result, ctx)
+          } catch (e) {
+            console.error(`处理器执行错误, id:${abReplaceProcessor.id}, header:${item_header}, error:`, e)
+            break
+          }
           prev.prev_type = typeof(prev.prev_result)
           prev.prev_type2 = abReplaceProcessor.process_return as ABConvert_IOEnum
           prev.prev_processor = abReplaceProcessor.process
@@ -232,19 +253,19 @@ export class ABConvertManager {
   /**
    * 子函数，后处理/尾处理，主要进行末尾追加指令
    */
-  private static autoABConvert_last (el:HTMLDivElement, header:string, selectorName:string, prev:any, ctx?: any):any{
+  private static autoABConvert_last (el:HTMLDivElement, _header:string, _selectorName:string, prev:PREV, _ctx?: unknown):any{
     // text内容，则给一个md渲染器
     if (prev.prev_type == "string" && prev.prev_type2 == ABConvert_IOEnum.text) {
       const subEl = document.createElement("div"); el.appendChild(subEl);
       ABConvertManager.getInstance().m_renderMarkdownFn(prev.prev_result as string, subEl);
-      prev.prev_result = el; prev.prev_type = "object"; prev.prev_type2 = ABConvert_IOEnum.el; prev.process = "md";
+      prev.prev_result = el; prev.prev_type = "object"; prev.prev_type2 = ABConvert_IOEnum.el; prev.prev_processor = "md";
     }
     // json内容/数组内容，则用代码块表示
     else if (prev.prev_type == "string" && prev.prev_type2 == ABConvert_IOEnum.json) {
       const code_str:string = "```json\n" + prev.prev_result + "\n```\n"
       const subEl = document.createElement("div"); el.appendChild(subEl);
       ABConvertManager.getInstance().m_renderMarkdownFn(code_str, subEl);
-      prev.prev_result = el; prev.prev_type = "object"; prev.prev_type2 = ABConvert_IOEnum.el; prev.process = "show_json";
+      prev.prev_result = el; prev.prev_type = "object"; prev.prev_type2 = ABConvert_IOEnum.el; prev.prev_processor = "show_json";
     }
     // 数组流，用代码块表示
     else if (prev.prev_type == "object" &&
@@ -253,7 +274,7 @@ export class ABConvertManager {
       const code_str:string = "```json\n" + JSON.stringify(prev.prev_result, null, 2) + "\n```\n"
       const subEl = document.createElement("div"); el.appendChild(subEl);
       ABConvertManager.getInstance().m_renderMarkdownFn(code_str, subEl);
-      prev.prev_result = el; prev.prev_type = "object"; prev.prev_type2 = ABConvert_IOEnum.el; prev.process = "show_listStream";
+      prev.prev_result = el; prev.prev_type = "object"; prev.prev_type2 = ABConvert_IOEnum.el; prev.prev_processor = "show_listStream";
     }
     else if (prev.prev_type == "object" && prev.prev_type2 == ABConvert_IOEnum.el) {
       return prev

package/ABSetting.ts

@@ -16,9 +16,10 @@ export const ABCSetting: {
   env: "obsidian"|"obsidian-min"|"obsidian-pro"|"app"|"markdown-it"|"remark",
   // 某些环境的独占 api，其他环境用不上
   obsidian: {
-    global_app: any,
-    global_ctx: any, // MarkdownPostProcessorContext类型, obsidian专用
+    global_app: unknown|null,
+    global_ctx: unknown|null, // MarkdownPostProcessorContext类型, obsidian专用
     mermaid?: Promise<any>, // obsidian专用，obsidian 如何渲染mermaid
+    markmap_event?: (d: Element|Document) => Promise<void>, // 如何渲染 markmap
   },
   pro: {
     disable: boolean, // 禁用 pro 版的扩展功能，变为非 pro 版
@@ -45,6 +46,7 @@ export const ABCSetting: {
     global_app: null,
     global_ctx: null,
     mermaid: undefined,
+    markmap_event: undefined,
   },
   pro: {
     disable: false,
@@ -63,7 +65,7 @@ export const ABCSetting: {
  * 
  * @attention 注意：修改正则要注意小括号的位置是否对应，不然还要去修改索引
  */
-export const ABReg = {
+export const ABReg: Record<string, RegExp> = {
   /**
    * AB块头部
    *

package/README.md

@@ -49,7 +49,7 @@ ABConvertManager.getInstance().redefine_renderMarkdown((markdown: string, el: HT
 
     const mdrc: MarkdownRenderChild = new MarkdownRenderChild(el);
     if (ctx) ctx.addChild(mdrc);
-    else if (ABCSetting.global_ctx) ABCSetting.global_ctx.addChild(mdrc);
+    else if (ABCSetting.global_ctx) { (ABCSetting.global_ctx  as MarkdownPostProcessorContext).addChild(mdrc) }
     /**
      * Renders markdown string to an HTML element.
      * @param app - A reference to the app object

package/converter/abc_markmap.ts

@@ -18,10 +18,9 @@
  *    - 在VuePress-Mdit环境，没有真正的document元素，而打开文件的钩子在mdit里面又没有，可能需要要vuepress插件解决
  */
 
- import DOMPurify from "dompurify"
+import DOMPurify from "dompurify"
 import { ABConvert_IOEnum, ABConvert } from "./ABConvert"
 import { ABCSetting } from "../ABSetting"
-import { markmap_event } from "../ABConvertEvent";
 
 /**
  * 生成一个随机id
@@ -46,7 +45,7 @@ process_param: ABConvert_IOEnum.text,
 process_return: ABConvert_IOEnum.el,
 process: (el, header, content: string): HTMLElement=>{
 		list2markmap(content, el)
-		markmap_event(el)
+		ABCSetting.obsidian.markmap_event?.(el)
 		// setTimeout(()=>{abConvertEvent(el)}, 500);
 		return el
 	}
@@ -117,3 +116,42 @@ function list2markmap(markdown: string, div: HTMLDivElement) {
 
 	return div
 }
+
+/**
+ * 一些AB块的后触发事件 - dom加载完触发 - markmap
+ * 
+ * 注意这里的 script 标签执行动态类型会被 obsidian 审查认为是不安全的。
+ * 所以没必要打包使用时，不加载该函数
+ */
+async function markmap_event(d: Element|Document) {
+  if (ABCSetting.env == "obsidian-min") return // min 不支持 markmap
+
+  // xxx2markmap，渲染事件
+  if (d.querySelector('.ab-markmap-svg')) {
+    console.log("  - markmap_event")
+    let script_el: HTMLScriptElement|null = document.querySelector('script[script-id="ab-markmap-script"]');
+    if (script_el) script_el.remove();
+    const divEl = d as Element;
+    let markmapId = '';
+    if (divEl.tagName === 'DIV') {
+      markmapId = divEl.querySelector('.ab-markmap-svg')?.id || '';
+    }
+    script_el = document.createElement('script'); document.head.appendChild(script_el);
+    script_el.type = "module";
+    script_el.setAttribute("script-id", "ab-markmap-script");
+    script_el.textContent = `
+    import { Markmap, } from 'https://jspm.dev/markmap-view';
+    const markmapId = "${markmapId || ''}";
+    let mindmaps;
+    if (markmapId) {
+      mindmaps = document.querySelectorAll('#' + markmapId);
+    } else {
+      mindmaps = document.querySelectorAll('.ab-markmap-svg'); // 注意一下这里的选择器
+    }
+    for(const mindmap of mindmaps) {
+      mindmap.innerHTML = "";
+      Markmap.create(mindmap,null,JSON.parse(mindmap.getAttribute('data-json')));
+    }`;
+  }
+}
+ABCSetting.obsidian.markmap_event = markmap_event

package/converter/abc_mermaid.ts

@@ -21,7 +21,7 @@ function getID(length=16){
 }
 
 // 纯组合，后续用别名模块替代
-const abc_title2mindmap = ABConvert.factory({
+const _abc_title2mindmap = ABConvert.factory({
   id: "title2mindmap",
   name: "标题到脑图",
   process_param: ABConvert_IOEnum.text,
@@ -34,7 +34,7 @@ const abc_title2mindmap = ABConvert.factory({
 })
 
 // 纯组合，后续用别名模块替代
-const abc_list2mindmap = ABConvert.factory({
+const _abc_list2mindmap = ABConvert.factory({
   id: "list2mindmap",
   name: "列表转mermaid思维导图",
   process_param: ABConvert_IOEnum.text,
@@ -46,7 +46,7 @@ const abc_list2mindmap = ABConvert.factory({
   }
 })
 
-const abc_list2mermaid = ABConvert.factory({
+const _abc_list2mermaid = ABConvert.factory({
   id: "list2mermaid",
   name: "列表转mermaid流程图",
   match: /^list2mermaid(\((.*)\))?$/,
@@ -65,7 +65,7 @@ const abc_list2mermaid = ABConvert.factory({
   }
 })
 
-const abc_list2mermaidText = ABConvert.factory({
+const _abc_list2mermaidText = ABConvert.factory({
   id: "list2mermaidText",
   name: "列表转mermaid文本",
   match: /^list2mermaidText(\((.*)\))?$/,
@@ -84,7 +84,7 @@ const abc_list2mermaidText = ABConvert.factory({
   }
 })
 
-const abc_list2mehrmaid = ABConvert.factory({
+const _abc_list2mehrmaid = ABConvert.factory({
   id: "list2mehrmaidText",
   name: "列表转mehrmaid文本",
   match: /^list2mehrmaidText(\((.*)\))?$/,
@@ -103,7 +103,7 @@ const abc_list2mehrmaid = ABConvert.factory({
   }
 })
 
-const abc_mermaid = ABConvert.factory({
+const _abc_mermaid = ABConvert.factory({
   id: "mermaid-with",
   name: "新mermaid",
   match: /^mermaid(\((.*)\))?$/,

package/package.json

@@ -1,22 +1,22 @@
-{
-  "name": "@anyblock/any-block-core",
-  "version": "3.4.6",
-  "description": "You can flexibility to create a 'Block' by many means. It also provides many useful features, like `list to table`. (obsidian/markdown-it/vuepress plugin/app)",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "author": "LincZero",
-  "license": "GNU Affero General Public License v3.0",
-  "dependencies": {
-    "dompurify": "^3.4.3",
-    "luxon": "^3.7.2",
-    "markmap-lib": "^0.17.2",
-    "plantuml-encoder": "^1.4.0"
-  },
-  "devDependencies": {
-    "@types/luxon": "^3.7.1",
-    "@types/plantuml-encoder": "^1.4.2",
-    "tslib": "^2.8.1"
-  }
-}
+{
+  "name": "@anyblock/any-block-core",
+  "version": "3.4.10",
+  "description": "You can flexibility to create a 'Block' by many means. It also provides many useful features, like `list to table`. (obsidian/markdown-it/vuepress plugin/app)",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "LincZero",
+  "license": "GNU Affero General Public License v3.0",
+  "dependencies": {
+    "dompurify": "^3.4.3",
+    "luxon": "^3.7.2",
+    "markmap-lib": "^0.17.2",
+    "plantuml-encoder": "^1.4.0"
+  },
+  "devDependencies": {
+    "@types/luxon": "^3.7.1",
+    "@types/plantuml-encoder": "^1.4.2",
+    "tslib": "^2.8.1"
+  }
+}