Browse Source

docs(i18n): refresh session query snapshot contract

Tianyi Cui 2 months ago
parent
commit
6b686aa832

+ 2 - 2
docs/core-data-structures/session-query.i18n.yaml

@@ -2,5 +2,5 @@
 # side as of the last confirmed-consistent state. Both languages carry equal authority;
 # after editing either side, bring the other along and re-record with:
 #   pnpm run verify-translation-pairing --write
-session-query.md: f91b438bd6448ce5f0d871d595704556262698e8
-session-query.zh.md: 3db50df96c302a6a090fc795085b2e52b70256dd
+session-query.md: c6dde8714a0875d46cf7b49cc181daab8f44afe0
+session-query.zh.md: 44be8b7f89e1576e54c8dc3cb60619d6728c6895

+ 11 - 1
docs/core-data-structures/session-query.zh.md

@@ -27,7 +27,17 @@ interface SessionRecord {
 }
 ```
 
-`SessionSurfaceSnapshot` 表示一次精确读取所得的观测,而不是持续保留的订阅。它的原始日志边界与折叠后的事件来自同一次优先使用 live 数据的加载。
+`SessionLogSnapshot` 是供恢复预检使用的完整原始日志:它脱离运行时,并经过回放验证。`SessionSurfaceSnapshot` 表示一次精确读取的 surface 观测结果,而不是持续保留的订阅。
+
+```ts type-equiv
+/** One validated detached observation of a logical session's complete raw log. */
+interface SessionLogSnapshot {
+  /** Cloned session header selected from the same observation as `events`. */
+  session: SessionHeader
+  /** Cloned contiguous raw events after persistence repair and replay validation. */
+  events: SessionEvent[]
+}
+```
 
 ```ts type-equiv
 /** One atomic live-preferred observation of a session's current model surface. */

+ 5 - 0
scripts/type-equiv.manifest.json

@@ -1512,6 +1512,11 @@
       "symbol": "SessionRecord",
       "source": "packages/session-query/session-query/src/types.ts"
     },
+    {
+      "doc": "docs/core-data-structures/session-query.zh.md",
+      "symbol": "SessionLogSnapshot",
+      "source": "packages/session-query/session-query/src/types.ts"
+    },
     {
       "doc": "docs/core-data-structures/session-query.zh.md",
       "symbol": "SessionSurfaceSnapshot",