client SDK 的 `DeleteDataResult` 注释写着 "Spec: DeleteDataResponseSchema" 却声明 `deleted: boolean`,而该 schema 声明的是 `success` —— 类型骗过编译器,运行时读到 undefined

[baozhoutao]

实现 #5581(兜底 delete 成功体向 spec 收敛)时做 deleted 键读取方全仓测绘撞见,不在该单范围内(#5581 的裁定面明确排除 packages/client,且这一条是 client 公开导出接口的形状问题,blast radius 与 semver 判断都不同),故另立。

事实

packages/client/src/index.ts:235:

/** Spec: DeleteDataResponseSchema */
export interface DeleteDataResult {
  object: string;
  id: string;
  deleted: boolean;
}

注释指名 DeleteDataResponseSchema 为其规范来源,但该 schema(packages/spec/src/api/protocol.zod.ts:472)声明的第三个键是 success,不是 deleted:

export const DeleteDataResponseSchema = lazySchema(() => z.object({
  object: z.string().describe('Object name'),
  id: z.string().describe('Deleted record ID'),
  success: z.boolean().describe('Whether deletion succeeded'),
}));

DeleteDataResult 是 client.data.delete(object, id)(index.ts:4300)与 project 作用域下同名方法(index.ts:4851)的返回类型。两者都是 unwrapResponse / _unwrap 直通,没有任何运行时改写 —— 服务端回什么就是什么,类型只是一句声明。

影响(#5581 之前就已成立)

服务端 DELETE /api/v1/data/:object/:id 在装了 MetadataPlugin 的部署(即常规部署)上回的是 { object, id, success: true }。所以:

• TS 使用方写 const r = await client.data.delete('task', id); if (r.deleted) … —— 编译通过,运行时 r.deleted === undefined,分支恒假;
• 反过来写 r.success 则被编译器判为不存在的属性。

即类型声明与它自称的规范、与服务端实际返回的形状都相反,且相反的方向是「编译器为错的那一种背书」。这不是 #5581 引入的:#5581 之前 protocol 路径就已经回 success;#5581 只是把兜底路径也对齐,使这条类型声明从「在精简装配上碰巧对上」变成两条路径都对不上。

建议修点

DeleteDataResult.deleted → success,与 DeleteDataResponseSchema 一致。属 @objectstack/client 公开导出接口的破坏性重命名,需要 changeset 与升级须知;是否同时保留一个 deprecated 的 deleted?: boolean 过渡期,请分诊裁定 —— 注意 contract-first 的口径下「消费端同时认两种键」正是被禁止的形状,#5581 的生产方侧就是照这个口径收敛的。

已确认不涉及的面

packages/client 另有五处 if (res.status === 204) return { deleted: true } 归一化(index.ts:3416 / 3467 / 3536 / 3590 / 3799)。逐条核过路由,分别是 shares revoke、sharing rules delete、reports delete、report schedules unschedule、ai conversations delete —— 没有一条走 /data/:object/:id,与本条及 #5581 的收敛面无交集,不应被一并改动。

---

Related: #5581 (packages/runtime 侧同一规范的收敛)、#5138(同族的 not-found 侧)

Blocked-by: #5581

---

Generated by Claude Code

[claude]

分诊:入队 pm:queue + domain:cli + pm:blocked(Blocked-by: #5581,已补入正文)。

• 分类理由:类型声明与其自称的规范源(DeleteDataResponseSchema)及服务端实际返回同时相反,declared ≠ actual;schema 为权威已有当日裁定先例(两个 discovery 生产者都在线上返回 schema 未声明的顶层字段(scoping / features / endpoints),且 REST 形状永远无法通过 DiscoverySchema #4828 第 4 子决策)。修向:deleted → success,⛔ 不留 deprecated 双键过渡——消费端同时认两种键正是 contract-first 禁止的形状(callData 的 delete 成功体两条路径不同形状:protocol 回 {success:true}(合规范),ObjectQL 兜底回 {deleted:true}(spec 未声明的键) #5581 生产方侧即按此口径收敛),且 r.deleted 在常规部署上运行时恒 undefined,改名是揭错,不是破坏在用行为。破坏性重命名照常配 changeset + 升级须知。维护者对过渡期问题可否决。
• 排序:callData 的 delete 成功体两条路径不同形状:protocol 回 {success:true}(合规范),ObjectQL 兜底回 {deleted:true}(spec 未声明的键) #5581 在飞(生产方兜底路径收敛),消费端类型收敛在其后落地(contract-first:生产先行)→ Blocked-by: #5581。
• 域锚定:落点 packages/client/src/index.ts:235 → domain:cli(client / client-react 归 cli 车道)。
• 查重:正文已核五处 204 归一化不涉及,复核认可;callData 的 ObjectQL 兜底路径对「记录不存在」给三种不同答案(get→200 null / update→500 / delete→200 deleted:true) #5138 关联非重复;三仓关键词扫描零命中。

本评论来自分诊座位 Routine(#5474 试点),不构成认领。

---

Generated by Claude Code

[baozhoutao]

解锁 + 认领(PM 会话 session_016FNvXhtSdnEGEfLEsMmvxh,cli 车道)

Blocker #5581 已经 PR #5641 MERGED(7bf3d1ce2)——生产方两条路径已同形 {object, id, success},消费端类型收敛即时解锁。

• 分支:claude/issue-5638-client-delete-result-type
• 工作树:../objectstack-5638(os-dev 自建)
• 方向照分诊 21:56Z 裁定(带维护者否决窗):DeleteDataResult 的 deleted: boolean → success: boolean,不留 deprecated 双键(消费端认两种键正是 contract-first 禁止的形状;r.deleted 常规部署运行时恒 undefined,改名是揭错不是破坏在用行为)。破坏性重命名配 changeset + 升级须知。
• 文件面:packages/client/src/index.ts:235-236 类型与两处直通声明(:4300/:4851)+ 受影响测试;正文核过的五处 204 归一化不涉及,不动。与在飞 os doctor 把「cloud-connection 没装」和「装了但加载不了」当成同一件事 —— ledger 目录在场也照打 clean bill(#5412 假 PASS 的上一层) #5644(doctor)不相交。

---

Generated by Claude Code

[baozhoutao]

开工(os-dev 会话 session_016FNvXhtSdnEGEfLEsMmvxh,cli 车道)

• 分支:claude/issue-5638-client-delete-result-type
• 工作树:../objectstack-5638,基线 origin/main(已含 fix(runtime): callData 的 delete 兜底返回 spec 声明的 {object, id, success},与 protocol 路径同形 (#5581) #5641 的 7bf3d1ce2,git merge-base --is-ancestor 确认)
• 方向照分诊 21:56Z 裁定 + PM 22:05Z 认领:DeleteDataResult.deleted: boolean → success: boolean,不留 deprecated 双键;配 changeset + 升级须知。
• 先做前提复核(类型仍声明 deleted?生产方两路径是否已同形 success?)与 .deleted 读取方全仓测绘;若发现任一处在运行时真拿到过 deleted,停手回报。
• 不动 packages/runtime / packages/cli/src/commands(os doctor 把「cloud-connection 没装」和「装了但加载不了」当成同一件事 —— ledger 目录在场也照打 clean bill(#5412 假 PASS 的上一层) #5644 在飞)、不动 spec、不动正文核过的五处 204 归一化。

---

Generated by Claude Code