用途:帮助开发者创建或修改以 Docyrus 为后端的 React TypeScript Web 应用,覆盖认证、数据查询与增删改查等常见开发任务。
技术栈:React 19 + TypeScript + Vite,TanStack Router(代码式)与 TanStack Query(服务端状态),Tailwind CSS v4 与 shadcn/ui,@docyrus/api-client(REST 客户端)与 @docyrus/signin(认证提供者),以及由 OpenAPI 规范自动生成的集合。
主要能力:通过 DocyrusAuthProvider 配置 OAuth2 PKCE 认证;使用集合 Hook(如 useBaseProjectCollection、useUsersCollection)进行 list、get、create、update、deleteOne、deleteMany 操作;list 支持 columns、filters(嵌套 AND/OR 与多种操作符)、filterKeyword 全文搜索、orderBy、limit/offset 分页、fullCount、calculations 聚合、formulas 计算列、childQueries、pivot 与 expand。
使用方式:在根组件包裹 DocyrusAuthProvider 并传入 apiUrl、clientId、redirectUri、scopes 与 callbackPath;在组件内调用集合 Hook,配合 TanStack Query 的 useQuery/useMutation 使用。调用 list/get 时必须传 columns,否则只返回 id;子查询键与公式键也需出现在 columns 中;当前用户信息用 useUsersCollection().getMyInfo()。数据源端点仅在租户 OpenAPI 规范中定义后才存在。
模式变更后需重新生成集合:先调用 regenerate_openapi_spec,再下载新规范(curl -o openapi.json "<publicUrl>"),最后运行 pnpx @docyrus/tanstack-db-generator openapi.json,三步需一起执行。
限制:资料未提供收费、价格、平台支持范围与效果数据;具体查询与公式细节需查阅随附的 references 文档。