remnote-bridge 0.1.0

package/remnote-plugin/src/test-scripts/test-richtext-matrix.ts

@@ -0,0 +1,332 @@
+/**
+ * RichText 字段×元素类型 交叉兼容性矩阵测试
+ *
+ * 测试 7 种 i 类型 × 12 种格式化字段 = 84 个组合
+ * 记录每个组合：✅ 写入+保留 / ❌ SDK 拒绝 / ⚠️ 写入但字段丢失
+ *
+ * 跳过：i:"m"（已全覆盖）、i:"fi"（SDK 拒绝写入）
+ */
+import type { ReactRNPlugin, PluginRem as Rem } from '@remnote/plugin-sdk';
+
+async function delay(ms: number) {
+  return new Promise((r) => setTimeout(r, ms));
+}
+
+const LOG = '[RICHTEXT-MATRIX]';
+const SESSION_KEY = 'richtext-matrix-v1-ran';
+
+// ── 格式化字段定义 ──
+
+interface FieldDef {
+  key: string;
+  value: any;
+}
+
+const FORMAT_FIELDS: FieldDef[] = [
+  { key: 'b', value: true },
+  { key: 'l', value: true },
+  { key: 'u', value: true },
+  { key: 'h', value: 4 },       // Green highlight
+  { key: 'tc', value: 6 },      // Blue text color
+  { key: 'q', value: true },    // inline code
+  { key: 'code', value: true },
+  { key: 'cId', value: 'test-cloze-matrix' },
+  { key: 'qId', value: '__PLACEHOLDER__' }, // will be replaced with real Rem ID
+  { key: 'iUrl', value: 'https://example.com/matrix-test' },
+  { key: 'block', value: true },
+  { key: 'title', value: '矩阵测试标题' },
+];
+
+// ── 元素类型定义 ──
+
+interface ElementTypeDef {
+  label: string;
+  iValue: string;
+  buildBase: (realRemId: string) => Record<string, any>;
+}
+
+const ELEMENT_TYPES: ElementTypeDef[] = [
+  {
+    label: 'q (Rem引用)',
+    iValue: 'q',
+    buildBase: (realRemId) => ({
+      i: 'q', _id: realRemId, content: false, pin: false,
+    }),
+  },
+  {
+    label: 'i (图片)',
+    iValue: 'i',
+    buildBase: () => ({
+      i: 'i', url: 'https://via.placeholder.com/1x1',
+    }),
+  },
+  {
+    label: 'a (音频)',
+    iValue: 'a',
+    buildBase: () => ({
+      i: 'a', url: 'https://example.com/test.mp3', onlyAudio: true,
+    }),
+  },
+  {
+    label: 'x (LaTeX)',
+    iValue: 'x',
+    buildBase: () => ({
+      i: 'x', text: 'E=mc^2',
+    }),
+  },
+  {
+    label: 's (分隔符)',
+    iValue: 's',
+    buildBase: () => ({
+      i: 's',
+    }),
+  },
+  {
+    label: 'n (注释)',
+    iValue: 'n',
+    buildBase: () => ({
+      i: 'n', text: 'annotation', url: 'https://example.com',
+    }),
+  },
+  {
+    label: 'g (GlobalName)',
+    iValue: 'g',
+    buildBase: (realRemId) => ({
+      i: 'g', _id: realRemId,
+    }),
+  },
+];
+
+// ── 结果类型 ──
+type CellResult = 'OK' | 'ERROR' | 'LOST';
+
+interface MatrixResult {
+  elementType: string;
+  iValue: string;
+  field: string;
+  fieldValue: any;
+  result: CellResult;
+  detail: string;
+}
+
+export async function runRichTextMatrixTest(plugin: ReactRNPlugin): Promise<void> {
+  const alreadyRan = await plugin.storage.getSession(SESSION_KEY);
+  if (alreadyRan) {
+    console.log(`${LOG} 已运行过，跳过`);
+    return;
+  }
+  await plugin.storage.setSession(SESSION_KEY, true);
+
+  console.log(`${LOG} ========== 开始交叉兼容性矩阵测试 ==========`);
+
+  try {
+    // ── 找到 "mcp 测试" 文档 ──
+    const allRem = await plugin.rem.getAll();
+    let parentDoc: Rem | undefined;
+    for (const r of allRem) {
+      const t = r.text ? await plugin.richText.toString(r.text) : '';
+      if (t.trim() === 'mcp 测试') { parentDoc = r; break; }
+    }
+    if (!parentDoc) {
+      console.error(`${LOG} 找不到 "mcp 测试" 文档`);
+      return;
+    }
+
+    // ── 创建包装 Rem 隔离测试区域 ──
+    const wrapper = await plugin.rem.createRem();
+    if (!wrapper) return;
+    await wrapper.setParent(parentDoc._id, 0);
+    await wrapper.setHighlightColor('Purple');
+    await wrapper.setText(['===== RichText 交叉兼容性矩阵测试 =====']);
+    await delay(300);
+
+    const wId = wrapper._id;
+    let pos = 0;
+
+    // ── 创建辅助 Rem（用于需要真实 Rem ID 的元素类型）──
+    const helperRem = await plugin.rem.createRem();
+    if (!helperRem) return;
+    await helperRem.setParent(wId, pos++);
+    await helperRem.setText(['辅助 Rem（用于 q/_id 和 g/_id 引用）']);
+    await delay(200);
+    const realRemId = helperRem._id;
+
+    // 替换 qId 字段的占位符
+    const fields = FORMAT_FIELDS.map((f) =>
+      f.key === 'qId' ? { ...f, value: realRemId } : f,
+    );
+
+    // ── 收集所有结果 ──
+    const allResults: MatrixResult[] = [];
+
+    // ── 外层循环：元素类型 ──
+    for (const elemType of ELEMENT_TYPES) {
+      console.log(`${LOG} --- 测试元素类型: ${elemType.label} ---`);
+
+      const typeHeader = await plugin.rem.createRem();
+      if (typeHeader) {
+        await typeHeader.setParent(wId, pos++);
+        await typeHeader.setHighlightColor('Blue');
+        await typeHeader.setText([`▶ ${elemType.label}`]);
+        await delay(100);
+      }
+
+      // ── 内层循环：格式化字段 ──
+      for (const field of fields) {
+        const combo = `${elemType.iValue}+${field.key}`;
+        console.log(`${LOG} 测试: ${combo}`);
+
+        const base = elemType.buildBase(realRemId);
+        const testObj = { ...base, [field.key]: field.value };
+
+        let result: CellResult;
+        let detail: string;
+
+        // 创建测试 Rem
+        const testRem = await plugin.rem.createRem();
+        if (!testRem) {
+          result = 'ERROR';
+          detail = '无法创建 Rem';
+          allResults.push({
+            elementType: elemType.label,
+            iValue: elemType.iValue,
+            field: field.key,
+            fieldValue: field.value,
+            result,
+            detail,
+          });
+          continue;
+        }
+        await testRem.setParent(wId, pos++);
+
+        try {
+          // 写入
+          await testRem.setText([testObj] as any);
+          await delay(200);
+
+          // 回读
+          const refetch = await plugin.rem.findOne(testRem._id);
+          const readBack = refetch ? refetch.text : testRem.text;
+
+          // 检查字段是否保留
+          let fieldRetained = false;
+          if (Array.isArray(readBack)) {
+            for (const el of readBack) {
+              if (el && typeof el === 'object' && field.key in el) {
+                // 对于 boolean 字段，检查值是否为 true
+                const val = (el as any)[field.key];
+                if (typeof field.value === 'boolean') {
+                  fieldRetained = val === field.value;
+                } else {
+                  fieldRetained = val !== undefined && val !== null;
+                }
+                break;
+              }
+            }
+          }
+
+          if (fieldRetained) {
+            result = 'OK';
+            detail = `写入+保留 → ${JSON.stringify(readBack)}`;
+          } else {
+            result = 'LOST';
+            detail = `写入成功但字段丢失 → ${JSON.stringify(readBack)}`;
+          }
+
+          console.log(`${LOG} ${combo}: ${result} — ${detail}`);
+        } catch (err) {
+          result = 'ERROR';
+          detail = `SDK 拒绝: ${String(err)}`;
+          console.error(`${LOG} ${combo}: ERROR —`, err);
+
+          // 写入错误提示到 Rem（避免空 Rem）
+          try {
+            await testRem.setText([`${combo} 失败: ${String(err).slice(0, 100)}`]);
+          } catch {
+            // ignore
+          }
+        }
+        await delay(100);
+
+        // 写结果到子 Rem
+        const resultRem = await plugin.rem.createRem();
+        if (resultRem) {
+          await resultRem.setParent(wId, pos++);
+          const icon = result === 'OK' ? '✅' : result === 'ERROR' ? '❌' : '⚠️';
+          await resultRem.setText([`${icon} ${combo}: ${result} — ${detail.slice(0, 200)}`]);
+          await delay(50);
+        }
+
+        allResults.push({
+          elementType: elemType.label,
+          iValue: elemType.iValue,
+          field: field.key,
+          fieldValue: field.value,
+          result,
+          detail,
+        });
+      }
+    }
+
+    // ── 汇总结果 ──
+
+    // 构建矩阵表
+    const matrix: Record<string, Record<string, CellResult>> = {};
+    for (const r of allResults) {
+      if (!matrix[r.iValue]) matrix[r.iValue] = {};
+      matrix[r.iValue][r.field] = r.result;
+    }
+
+    // 统计
+    const stats = {
+      total: allResults.length,
+      ok: allResults.filter((r) => r.result === 'OK').length,
+      error: allResults.filter((r) => r.result === 'ERROR').length,
+      lost: allResults.filter((r) => r.result === 'LOST').length,
+    };
+
+    console.log(`${LOG} ========== 汇总 ==========`);
+    console.log(`${LOG} 总计: ${stats.total}, OK: ${stats.ok}, ERROR: ${stats.error}, LOST: ${stats.lost}`);
+    console.log(`${LOG} 矩阵:`, JSON.stringify(matrix, null, 2));
+
+    // 写入汇总 JSON Rem
+    const summaryRem = await plugin.rem.createRem();
+    if (summaryRem) {
+      await summaryRem.setParent(wId, pos++);
+      await summaryRem.setHighlightColor('Green');
+
+      const summaryJson = JSON.stringify({
+        testName: 'richtext-field-element-matrix',
+        timestamp: new Date().toISOString(),
+        stats,
+        matrix,
+        fieldList: fields.map((f) => f.key),
+        elementList: ELEMENT_TYPES.map((e) => e.iValue),
+        details: allResults.map((r) => ({
+          elem: r.iValue,
+          field: r.field,
+          result: r.result,
+          detail: r.detail.slice(0, 300),
+        })),
+      });
+
+      await summaryRem.setText([`矩阵汇总 JSON: ${summaryJson}`]);
+      await delay(200);
+    }
+
+    // 完成标记
+    const doneRem = await plugin.rem.createRem();
+    if (doneRem) {
+      await doneRem.setParent(wId, pos++);
+      await doneRem.setHighlightColor('Green');
+      await doneRem.setText([
+        `===== 矩阵测试完成 ===== ` +
+        `✅${stats.ok} ❌${stats.error} ⚠️${stats.lost} / 共${stats.total}`,
+      ]);
+    }
+
+    console.log(`${LOG} ========== 矩阵测试全部完成 ==========`);
+  } catch (err) {
+    console.error(`${LOG} 顶层错误:`, err);
+  }
+}

package/remnote-plugin/src/test-scripts/test-richtext-remaining.ts

@@ -0,0 +1,245 @@
+/**
+ * RichText 剩余未测字段验证 v2
+ *
+ * 改进：
+ * - 用 applyTextFormatToRange + "cloze" 创建真正的 cloze，再回读真实 cId 格式
+ * - 每个测试的回读 JSON 写入结果 Rem（不依赖 console.log）
+ * - 用包装 Rem 隔离，避免跟其他测试交错
+ */
+import type { ReactRNPlugin, PluginRem as Rem } from '@remnote/plugin-sdk';
+
+async function delay(ms: number) {
+  return new Promise((r) => setTimeout(r, ms));
+}
+
+const LOG = '[RICHTEXT-REMAINING-V2]';
+
+export async function runRichTextRemainingTest(plugin: ReactRNPlugin): Promise<void> {
+  const alreadyRan = await plugin.storage.getSession('richtext-remaining-v2-ran');
+  if (alreadyRan) {
+    console.log(`${LOG} 已运行过，跳过`);
+    return;
+  }
+  await plugin.storage.setSession('richtext-remaining-v2-ran', true);
+
+  console.log(`${LOG} ========== 开始 v2 验证 ==========`);
+
+  try {
+    // ── 找到 "mcp 测试" 文档 ──
+    const allRem = await plugin.rem.getAll();
+    let parentDoc: Rem | undefined;
+    for (const r of allRem) {
+      const t = r.text ? await plugin.richText.toString(r.text) : '';
+      if (t.trim() === 'mcp 测试') { parentDoc = r; break; }
+    }
+    if (!parentDoc) {
+      console.error(`${LOG} 找不到 "mcp 测试" 文档`);
+      return;
+    }
+
+    // ── 创建包装 Rem 隔离测试区域 ──
+    const wrapper = await plugin.rem.createRem();
+    if (!wrapper) return;
+    await wrapper.setParent(parentDoc._id, 0);
+    await wrapper.setHighlightColor('Yellow');
+    await wrapper.setText(['===== RichText 剩余字段验证 v2 =====']);
+    await delay(300);
+
+    const wId = wrapper._id;
+    let pos = 0;
+
+    // 辅助：创建 Rem + 写入 + 回读 + 写结果
+    async function testWrite(
+      label: string,
+      richText: any[],
+    ): Promise<{ ok: boolean; readBack: any }> {
+      const testRem = await plugin.rem.createRem();
+      if (!testRem) return { ok: false, readBack: null };
+      await testRem.setParent(wId, pos++);
+
+      try {
+        await testRem.setText(richText);
+        await delay(200);
+        // 回读
+        const refetch = await plugin.rem.findOne(testRem._id);
+        const readBack = refetch ? refetch.text : testRem.text;
+        console.log(`${LOG} ${label} → OK, 回读:`, JSON.stringify(readBack));
+
+        // 结果 Rem
+        const resultRem = await plugin.rem.createRem();
+        if (resultRem) {
+          await resultRem.setParent(wId, pos++);
+          await resultRem.setText([`↳ ${label} 回读: ${JSON.stringify(readBack)}`]);
+        }
+        await delay(200);
+        return { ok: true, readBack };
+      } catch (err) {
+        console.error(`${LOG} ${label} → 失败:`, err);
+        await testRem.setText([`${label} 失败: ${String(err)}`]);
+        await delay(200);
+        return { ok: false, readBack: null };
+      }
+    }
+
+    // ═══════════════════════════════════════════════════
+    //  0. 探测真实 cloze：先写纯文本，再用 applyTextFormatToRange 加 cloze，再回读
+    // ═══════════════════════════════════════════════════
+    console.log(`${LOG} --- 0. 探测真实 cloze ID 格式 ---`);
+    const clozeProbe = await plugin.rem.createRem();
+    if (clozeProbe) {
+      await clozeProbe.setParent(wId, pos++);
+      await clozeProbe.setText(['探测用文本：ABCDEFGH']);
+      await delay(300);
+
+      // 对 "BCDE"（位置 5-9）加 cloze 格式
+      const originalText = clozeProbe.text;
+      if (originalText) {
+        try {
+          const formatted = await plugin.richText.applyTextFormatToRange(
+            originalText, 5, 9, 'cloze' as any
+          );
+          console.log(`${LOG} applyTextFormatToRange cloze 结果:`, JSON.stringify(formatted));
+          // 写回
+          await clozeProbe.setText(formatted);
+          await delay(300);
+          // 回读
+          const refetch = await plugin.rem.findOne(clozeProbe._id);
+          const readBack = refetch ? refetch.text : clozeProbe.text;
+          console.log(`${LOG} cloze 回读:`, JSON.stringify(readBack));
+
+          const probeResult = await plugin.rem.createRem();
+          if (probeResult) {
+            await probeResult.setParent(wId, pos++);
+            await probeResult.setText([`↳ 真实 cloze JSON: ${JSON.stringify(readBack)}`]);
+          }
+          await delay(200);
+
+          // 提取真实 cloze ID
+          let realClozeId: string | undefined;
+          if (Array.isArray(readBack)) {
+            for (const el of readBack) {
+              if (el && typeof el === 'object' && 'cId' in el) {
+                realClozeId = (el as any).cId;
+                break;
+              }
+            }
+          }
+
+          const idInfoRem = await plugin.rem.createRem();
+          if (idInfoRem) {
+            await idInfoRem.setParent(wId, pos++);
+            await idInfoRem.setText([
+              `↳ 真实 cloze ID: "${realClozeId}" ` +
+              `(类型:${typeof realClozeId}, 长度:${realClozeId?.length})`,
+            ]);
+          }
+          await delay(200);
+
+          // ── 用真实 ID 格式手拼 cloze 写入 ──
+          if (realClozeId) {
+            await testWrite('0b. 真实ID手拼cloze', [
+              '手拼(真实ID): ',
+              { i: 'm', text: '真实ID填空', cId: realClozeId } as any,
+              ' 后续',
+            ]);
+          }
+        } catch (err) {
+          console.error(`${LOG} applyTextFormatToRange 失败:`, err);
+          const errRem = await plugin.rem.createRem();
+          if (errRem) {
+            await errRem.setParent(wId, pos++);
+            await errRem.setText([`0. applyTextFormatToRange 失败: ${String(err)}`]);
+          }
+        }
+      }
+    }
+
+    // ═══════════════════════════════════════════════════
+    //  1. cId — 用随便编的 ID
+    // ═══════════════════════════════════════════════════
+    await testWrite('1. cId(随编ID)', [
+      '填空(随编): ',
+      { i: 'm', text: '答案B', cId: 'my-fake-cloze-999' } as any,
+      ' 后续',
+    ]);
+
+    // ═══════════════════════════════════════════════════
+    //  2. hiddenCloze + cId
+    // ═══════════════════════════════════════════════════
+    await testWrite('2. hiddenCloze', [
+      'hidden: ',
+      { i: 'm', text: '隐藏填空', cId: 'hc-001', hiddenCloze: true } as any,
+    ]);
+
+    // ═══════════════════════════════════════════════════
+    //  3. revealedCloze + cId
+    // ═══════════════════════════════════════════════════
+    await testWrite('3. revealedCloze', [
+      'revealed: ',
+      { i: 'm', text: '揭示填空', cId: 'rc-001', revealedCloze: true } as any,
+    ]);
+
+    // ═══════════════════════════════════════════════════
+    //  4. block = true（引用块）
+    // ═══════════════════════════════════════════════════
+    await testWrite('4. block=true', [
+      { i: 'm', text: '这应该是引用块', block: true } as any,
+    ]);
+
+    // ═══════════════════════════════════════════════════
+    //  5. qId — 行内引用链接
+    // ═══════════════════════════════════════════════════
+    const qIdTarget = await plugin.rem.createRem();
+    if (qIdTarget) {
+      await qIdTarget.setParent(wId, pos++);
+      await qIdTarget.setText(['qId 引用目标 Rem']);
+      await delay(200);
+    }
+
+    await testWrite('5. qId', [
+      '行内引用: ',
+      { i: 'm', text: '这是qId链接', qId: qIdTarget?._id || 'fake' } as any,
+      ' 后续',
+    ]);
+
+    // ═══════════════════════════════════════════════════
+    //  6. title
+    // ═══════════════════════════════════════════════════
+    await testWrite('6. title', [
+      { i: 'm', text: '有title属性的文本', title: '我是标题' } as any,
+    ]);
+
+    // ═══════════════════════════════════════════════════
+    //  7. i:"g" GlobalName
+    // ═══════════════════════════════════════════════════
+    await testWrite('7a. i:g(有_id)', [
+      'GlobalName: ',
+      { i: 'g', _id: qIdTarget?._id || null } as any,
+    ]);
+    await testWrite('7b. i:g(null)', [
+      'GlobalName(null): ',
+      { i: 'g', _id: null } as any,
+    ]);
+
+    // ═══════════════════════════════════════════════════
+    //  8. i:"fi" FlashcardIcon
+    // ═══════════════════════════════════════════════════
+    await testWrite('8. i:fi', [
+      '闪卡图标: ',
+      { i: 'fi' } as any,
+    ]);
+
+    // ── 完成 ──
+    const doneRem = await plugin.rem.createRem();
+    if (doneRem) {
+      await doneRem.setParent(wId, pos++);
+      await doneRem.setHighlightColor('Green');
+      await doneRem.setText(['===== v2 验证完成 =====']);
+    }
+
+    console.log(`${LOG} ========== v2 全部完成 ==========`);
+
+  } catch (err) {
+    console.error(`${LOG} 顶层错误:`, err);
+  }
+}