跳到主要内容

rxdb-plugin-working-tree-vue

@aiao/rxdb-plugin-working-tree 的 Vue 集成层。提供 useWorkingTree() composable，把工作树插件的 WorkingTreeManager 适配为 Vue ComputedRef 消费接口。

安装​

pnpm add @aiao/rxdb @aiao/rxdb-plugin-working-tree @aiao/rxdb-vue @aiao/rxdb-plugin-working-tree-vue vue rxjs

用法​

<script lang="ts" setup>
import { useWorkingTree } from '@aiao/rxdb-plugin-working-tree-vue';

const tree = useWorkingTree();

const save = async (): Promise<void> => {
  const status = await tree.status();
  const result = await tree.commit('保存', {
    expectedBranch: {
      branchId: status.branchId,
      activationRevision: status.activationRevision
    },
    expectedHeadRevision: status.headRevision,
    expectedWorkingTreeRevision: status.workingTreeRevision,
    authorId: 'alice',
    operationId: crypto.randomUUID()
  });
  if (!result.ok) console.warn('别人先提交了，重试即可', result.conflict);
};
</script>

<template>
  <span v-if="tree.statusState.value.phase === 'empty'">没有未提交的改动</span>
  <span v-else-if="tree.statusState.value.phase === 'success'">
    {{ tree.statusState.value.value.entryCount }} 条未提交
  </span>
  <button :disabled="tree.commitState.value.phase === 'loading'" @click="save">提交</button>
</template>

装插件仍在库侧完成（db.use(rxDBPluginWorkingTree) 必须排在 connect() 之前），本包只负责读写。

useWorkingTree() 经 useRxDB() 取库，因此上游要有 provideRxDB()。十格状态各自装进 ComputedRef：模板只读了 statusState 时，一次 diff() 的相位变化不会让它重新求值。

三端对称​

Angular @aiao/rxdb-plugin-working-tree-angular / React @aiao/rxdb-plugin-working-tree-react / Vue @aiao/rxdb-plugin-working-tree-vue（本包） 的 useWorkingTree() 同名、同字段、同方法签名，只有状态容器形态不同（Signal / 渲染快照 / ComputedRef）。 三个包各自的 spec 结尾都带一段 tri-framework-api.md §3 清单守卫，任一端加减成员都会红。

行为约定（三端一致）​

  • 创建入口本身一次 IO 都不发：十格状态初值全是 idle，只有真调了方法才去读库。
  • 没有变更流：状态只在经本入口发出的命令之后更新。别的标签页写进来的改动、直接走 entity.save() 的写入，都不会推一份新的 status 过来——要最新值就再调一次 status()。
  • 拿不到数据库时抛错，而不是返回一份「一切干净」的默认值。
  • commit() 的 CAS 落败走返回值（result.ok === false 且带 conflict），不是异常。
  • restore() 的四个被拒成因（冲突 / 工作树不干净 / 编解码不兼容 / 目标不可达）同样走返回值， 因此 restoreState 没有 empty——「被拒」与「一条都没恢复」都是结果。restoreSessionState 的空只有一个含义：当前分支没有未结束的恢复会话；conflicted 的会话不是空。
  • switchBranch(branchId, options?) 的被拒反过来走异常：{ requireClean: true } 撞上非空工作树时 抛 WorkingTreeDirtyError，expectedActivationRevision 过期时抛核心的分支前置条件错误——那一刻分支 根本没切，没有任何结果可交给调用方。不传第二参与无条件切换逐字节一致（核心那条「一个条件都没提 就一条语句都不发」的快路径因此仍然成立）。成功之后自动重读一次 status：那份摘要属于另一条分支。 它挂在核心的 VersionManager 而不是 WorkingTreeManager 上（contracts/core-api.md §6），三端入口 因此取整个 RxDB，而不是只取 db.workingTree。

类型与错误类一律从 @aiao/rxdb-plugin-working-tree 直接 import， 本包不重定义、也不再导出（tri-framework-api.md §1）。

文档​

License​

MIT

rxdb-plugin-working-tree-vue - Vue 集成层

提供 useWorkingTree() composable，把 @aiao/rxdb-plugin-working-tree 的 WorkingTreeManager 适配成 Vue ComputedRef 消费接口。命名与 Angular / React 绑定层一致（tri-framework-api.md §3）。

Interfaces​

InterfaceDescription
WorkingTreeResourceuseWorkingTree 的返回值。

Functions​

FunctionDescription
useWorkingTree读写当前数据库的工作树。