@anyblock/any-block-core 3.4.6

package/README.md

@@ -0,0 +1,162 @@
+# Any Block Converter
+
+## 使用
+
+### 使用流程
+
+```typescript
+// 转换器模块
+import { ABConvertManager } from "ABConvertManager"
+// 加载所有转换器 (都是可选的)
+// (当然，如果A转换器依赖B转换器，那么你导入A必然导入B)
+import {} from "./ABConverter/converter/abc_text"
+import {} from "./ABConverter/converter/abc_code"
+import {} from "./ABConverter/converter/abc_list"
+import {} from "./ABConverter/converter/abc_table"
+import {} from "./ABConverter/converter/abc_deco"
+import {} from "./ABConverter/converter/abc_ex"
+import {} from "./ABConverter/converter/abc_echarts"
+import {} from "./ABConverter/converter/abc_mermaid" // 可选建议：非 min 环境下 7.1MB
+import {} from "./ABConverter/converter/abc_markmap" // 可选建议：1.3MB
+
+// 先注册默认渲染行为
+ABConvertManager.getInstance().redefine_renderMarkdown((markdown: string, el: HTMLElement): void => {...})
+
+// 然后按下面这个原型正常使用即可
+ABConvertManager.autoABConvert(el:HTMLDivElement, header:string, content:string): HTMLElement
+```
+
+### Obsidian 回调函数设置
+
+```typescript
+ABConvertManager.getInstance().redefine_renderMarkdown((markdown: string, el: HTMLElement, ctx?: any): void => {
+    /**
+     * Renders markdown string to an HTML element.
+     * @deprecated - use {@link MarkdownRenderer.render}
+     * 
+     * 原定义： 
+     * @param markdown - The markdown source code
+     * @param el - The element to append to
+     * @param sourcePath - The normalized path of this markdown file, used to resolve relative internal links
+     *     此标记文件的规范化路径，用于解析相对内部链接
+     *     TODO 我可能知道为什么重渲染图片会出现bug了，原因应该在这里
+     * @param component - A parent component to manage the lifecycle of the rendered child components, if any
+     *     一个父组件，用于管理呈现的子组件(如果有的话)的生命周期
+     * @public
+     * 
+     */
+    //MarkdownRenderer.renderMarkdown(markdown, el, "", new MarkdownRenderChild(el))
+
+    const mdrc: MarkdownRenderChild = new MarkdownRenderChild(el);
+    if (ctx) ctx.addChild(mdrc);
+    else if (ABCSetting.global_ctx) ABCSetting.global_ctx.addChild(mdrc);
+    /**
+     * Renders markdown string to an HTML element.
+     * @param app - A reference to the app object
+     * @param markdown - The markdown source code
+     * @param el - The element to append to
+     * @param sourcePath - The normalized path of this markdown file, used to resolve relative internal links
+     * @param component - A parent component to manage the lifecycle of the rendered child components.
+     * @public
+     */
+    // @ts-ignore 新接口，但旧接口似乎不支持
+    MarkdownRenderer.render(app, markdown, el, app.workspace.activeLeaf?.view?.file?.path??"", mdrc)
+})
+```
+
+### MarkdownIt 回调函数设置
+
+```typescript
+ABConvertManager.getInstance().redefine_renderMarkdown((markdown: string, el: HTMLElement): void => {
+    const result: string = md.render(markdown)
+    const el_child = document.createElement("div"); el.appendChild(el_child); el_child.innerHTML = result;
+})
+```
+
+## 开发/设计/架构补充
+
+（先读src下的README）
+
+### 架构
+
+也叫 Any Block Render (text->html时)
+
+因为模块化内置了很多 Converter (text->text等)，所以整体叫 Any Block Converter
+
+### 该模块设计不应依赖于Ob插件
+
+**这个模块以前是依赖Ob插件接口的**，后来才改成可复用的 AnyBlock 转化器。
+
+为了高复用 (不仅仅在Ob插件上使用，还在md-it的等其他地方使用)
+
+1. 要与选择器解耦
+2. 相较于V2版本，为了不依赖于Ob底层，使用一个回调函数去替代 `MarkdownRenderer` 相关函数
+
+### 程序缩写
+
+- `AnyBlock`：`AB`
+- `AnyBlockConvert`：`ABC`
+- `AnyBlockSelector`：`ABS`
+- `AnyBlockRender`：`ABR`
+
+### 格式转换所在位置
+
+> ##### 思考
+
+例如我有两个格式：格式1（有格式1解析渲染、将自己格式转别人格式，将别人格式转自己格式）、格式2（有格式2解析渲染、将别人的格式转自己式、将自己的格式转别人的格式）。问题在于：1转2和2转1的功能，应该怎么设置？
+
+1. 都放在两个文件中
+    - 优点：两模块互相独立
+    - 缺点：造成冗余，而非复用 —— 只写一遍，两个程序都用一份
+2. 只放格式2
+    - 思想：该方式视为先有的格式1后有的格式2扩展。或视为格式1是更通用更广泛的格式，格式2属于扩展格式，自然由格式2负责12的互转
+    - 采用：abc_mermaid、abc_markmap 与 list 的转换属于此类，后期增加的新格式也属于此类
+3. 1转2由2实现，2转1则由1实现
+    - 思想：该方式视为1和2是两个商业软件，他们乐意于让对方的用户转移到自己这边，但并不乐意让自己的用户转到对方那边
+    - 采用：list、table 的互相转换属于此类
+
+> ##### 总结
+
+按格式的通用性分为：(越往上通用级别越高)
+
+1. str
+2. html
+3. list、table
+4. mermaid、mindmap、……以后的扩展
+
+> ##### 策略
+
+1. 低通用级格式要实现对高通用级格式的互转
+2. 同通用级则实现其他同通用级格式对自己格式的转化
+
+## todo
+
+1. 别名模块，AnyBlockConverter 不应该最后强制输出html。最后补md的行为是ob的别名模块做的，不应该由abc来快
+2. PlantUML，感觉很多东西都好用多了
+
+## bug
+
+### mdit环境下onclick需要内嵌才生效
+
+```typescript
+// TODO，onClick代码在mdit环境下按钮点击失效。测试代码如下
+const btn = document.createElement("button"); table.appendChild(btn); btn.textContent = "测试按钮1";
+btn.onclick = () => { console.log("btn.onclick") }
+const btndiv = document.createElement("div"); table.appendChild(btndiv);
+btndiv.innerHTML = `<button onclick="console.log('Button was clicked!')">测试按钮2</button>`
+// 发现mdit环境下，按钮1无法正常按动，而按钮2可以
+// 原因应该是：因为mdit环境下的document对象是jdsom创建的，假的。这个dom对象后面会被转化为html_str，onclick的信息就丢失了
+```
+
+### mermaid找不到DOMPurify
+
+mermaid的一个未定义行为的报错 (不过修复了这个之后又说BBox找不到了)
+
+```typescript
+// 见：https://github.com/kkomelin/isomorphic-dompurify
+
+// 用
+import DOMPurify from "isomorphic-dompurify"
+// 替换
+import DOMPurify from "dompurify"
+```

package/converter/ABConvert.ts

@@ -0,0 +1,158 @@
+/**
+ * AB转换器的抽象基类
+ * 
+ * @detail
+ * 被所有权：ABConvertManager
+ */
+
+import { ABConvertManager } from "../ABConvertManager"
+import type { List_C2ListItem } from "./abc_c2list"
+import type { List_ListItem } from "./abc_list"
+import type { List_TableItem } from "./abc_table"
+
+/**
+ * ab处理器子接口 - 类型声明
+ * 
+ * @detail
+ * TODO 待增加一个list和json专用格式
+ */
+export enum ABConvert_IOEnum {
+  text = "string",          // string
+  el = "HTMLElement",       // HTMLElement
+  // el_text = "string",    // string
+  json = "json_string",     // string
+  list_stream = "array",    // object
+  c2list_stream = "array2", // object  
+}
+export type ABConvert_IOType =
+  string|           // text/el_text
+  HTMLElement|      // html元素
+  void|             // TODO void是旧的别名系统，以后要删掉
+  List_ListItem|    // 多叉树 数据流
+  List_C2ListItem|  // 二层树 数据流
+  List_TableItem|   // 表格用 数据流
+  Object            // json对象
+
+/**
+ * AB转换器的抽象基类
+ * 
+ * @detail
+ * 被所有权：ABConvertManager
+ */
+export class ABConvert {
+
+  /** --------------------------------- 静态参数 -------------------------- */
+
+  id: string                      // 唯一标识（当不填match时也会作为匹配项）
+  name: string                    // 处理器名字
+  match: RegExp|string            // 处理器匹配正则（不填则为id，而不是name！name可以被翻译或是重复的）如果填写了且为正则类型，不会显示在下拉
+  default: string|null            // 下拉选择的默认规则，不填的话：非正则默认为id，有正则则为空
+  detail: string                  // 处理器描述
+  process_alias: string           // 组装，如果不为空串则会覆盖process方法，但扔需要给process一个空实现
+  process_param: ABConvert_IOEnum|null
+  process_return: ABConvert_IOEnum|null
+  process: (el:HTMLDivElement, header:string, content:ABConvert_IOType, ctx?:any)=> ABConvert_IOType // html->html的处理器不需要用到content参数
+  is_disable: boolean = false     // 是否禁用，默认false
+  register_from: string = "内置"  // 自带、其他插件、面板设置，如果是其他插件，则需要提供插件的名称（不知道能不能自动识别）
+                                  // TODO，这个词条应该修改成 “作者名” 鼓励二次开发
+
+  /** --------------------------------- 动态参数 -------------------------- */
+
+  // 非注册项：
+  // ~~is_inner：这个不可设置，用来区分是内部还是外部给的~~
+  is_enable: boolean = false      // 加载后能禁用这个项
+
+  /** --------------------------------- 特殊函数 -------------------------- */
+
+  /// 构造 + 容器管理
+  public static factory(process: ABConvert_SpecSimp| ABConvert_SpecUser): ABConvert {
+    let ret: ABConvert = new ABConvert(process)
+    ABConvertManager.getInstance().list_abConvert.push(ret)
+    return ret 
+  }
+
+  /// 构造函数
+  /// TODO 应该将注册修改为创建实例，因为里面有动态参数
+  /// TODO id冲突提醒
+  /// TODO 别名功能删除，由独立的别名模块负责，不集成在转换器里 
+  /// (优点是转换器功能保持单一性和可复用性，二是允许无代码设置别名，缺点是二次开发者需要多注册一次或独立设置转换器)
+  constructor(process: ABConvert_SpecSimp| ABConvert_SpecUser) {
+    // 注册版
+    if ('process' in process) {
+      this.constructor_simp(process)
+    }
+    // 别名版
+    else {
+      this.constructor_user(process)
+    }
+  }
+
+  constructor_simp(sim: ABConvert_SpecSimp) {
+    this.id = sim.id
+    this.name = sim.name
+    this.match = sim.match??sim.id
+    this.default = sim.default??(!sim.match||typeof(sim.match)=="string")?sim.id:null
+    this.detail = sim.detail??""
+    this.process_alias = sim.process_alias??""
+    this.process_param = sim.process_param??null
+    this.process_return = sim.process_return??null
+    this.process = sim.process
+    this.is_disable = false
+    this.register_from = "内置"
+  }
+
+  constructor_user(sim: ABConvert_SpecUser) {
+    this.id = sim.id
+    this.name = sim.name
+    this.match = /^\//.test(sim.match)?RegExp(sim.match):sim.match
+    this.default = null
+    this.detail = ""
+    this.process_alias = sim.process_alias
+    this.process_param = null
+    this.process_return = null
+    this.process = ()=>{}
+    this.is_disable = false
+    this.register_from = "用户"
+  }
+
+  /// 析构函数
+  destructor() {
+    // ABConvertManager.getInstance().list_abConvert.remove(this) // 旧，remove接口是ob定义的
+    
+    const index = ABConvertManager.getInstance().list_abConvert.indexOf(this)
+    if (index > -1) {
+      ABConvertManager.getInstance().list_abConvert.splice(index, 1)
+    }
+  }
+}
+
+/**
+ * ab转换器的注册参数类型
+ */
+export interface ABConvert_SpecSimp{
+  id: string                // 唯一标识（当不填match时也会作为匹配项）
+  name: string              // 处理器名字
+  match?: RegExp|string     // 处理器匹配正则（不填则为id，而不是name！name可以被翻译或是重复的）如果填写了且为正则类型，不会显示在下拉框中
+  default?: string|null     // 下拉选择的默认规则，不填的话：非正则默认为id，有正则则为空
+  detail?: string           // 处理器描述
+  process_alias?: string    // 组装，如果不为空串则会覆盖process方法，但扔需要给process一个空实现
+  process_param?: ABConvert_IOEnum
+  process_return?: ABConvert_IOEnum
+  process: (el:HTMLDivElement, header:string, content:ABConvert_IOType, ctx?:any)=> ABConvert_IOType
+                            // 处理器。话说第三个参数以前是只能接收string的，现在应该改为：上一次修改后的结果
+}
+
+/**
+ * ab转换器的注册参数类型 - 别名版
+ * TODO：后续删除，别名系统用另一个模块来处理
+ * 
+ * @detail
+ * 使用 ab处理器接口 - 用户版（都是字符串存储）
+ * 特点：不能注册process（无法存储在txt中），只能注册别名
+ */
+export interface ABConvert_SpecUser{
+  id:string
+  name:string
+  match:string
+  process_alias:string
+}

package/converter/GeneratorDataTable.ts

@@ -0,0 +1,40 @@
+/// 这个估计本来是想做可排序可筛选的数据表格
+import {ABConvertManager} from "../ABConvertManager"
+/*
+import type {List_TableInfo} from "src/ab_converter/converter/listProcess"
+
+export let list_tableInfo:List_TableInfo;
+export let modeT:boolean;
+export let prev_line: number;
+
+let table:HTMLDivElement;
+// 表格数据 组装成表格
+table.addClasses(["ab-table", "ab-data-table"])
+if (modeT) table.setAttribute("modeT", "true")
+let thead
+if(list_tableInfo[0].content.indexOf("< ")==0){ // 判断是否有表头
+  thead = table.createEl("thead")
+  list_tableInfo[0].content=list_tableInfo[0].content.replace(/^\<\s/,"")
+}
+const tbody = table.createEl("tbody")
+for (let index_line=0; index_line<prev_line+1; index_line++){ // 遍历表格行，创建tr……
+  let is_head
+  let tr
+  if (index_line==0 && thead){ // 判断是否第一行&&是否有表头
+    tr = thead.createEl("tr")
+    is_head = true
+  }
+  else{
+    is_head = false
+    tr = tbody.createEl("tr")
+  }
+  for (let item of list_tableInfo){                           // 遍历表格列，创建td
+    if (item.tableLine!=index_line) continue
+    // md版
+    let td = tr.createEl(is_head?"th":"td", {
+      attr:{"rowspan": item.tableRow}
+    })
+    ABConvertManager.getInstance().m_renderMarkdownFn(item.content, td)
+  }
+}
+*/