Tianyi Cui
cd9737d569
New doc-sync gate verify-export-jsdoc walks every module-level exported name under packages/*/*/src and requires description prose everywhere, plus @param per parameter and @returns on non-void annotated returns for function-like exports, public class methods, properties, and accessors. The parsing + check helpers move out of gen-cordis-catalog.ts into a shared scripts/jsdoc.ts so 'documented' means one thing on both gated surfaces. Deliberate exemptions (documented in the RFC): heritage-declared class members (the seam declaration is the doc's one home — the one checker query in an otherwise pure-AST walk), cordis plugin-protocol slots (name/inject/reusable/Config/apply, top-level and static), constructors, overload implementations, declare-module augmentation bodies, and re-export statements (checked at the defining module). The 203 under-documented exports the gate found at adoption are filled in this change, so the gate lands green; generated catalogs/graphs are regenerated for the shifted line pointers. RFC: docs/rfc/implemented/process/2026-07-06-export-surface-jsdoc-gate.md
86 lines
3.9 KiB
TypeScript
86 lines
3.9 KiB
TypeScript
/**
|
|
* JSON-serializability validation for session event data.
|
|
*
|
|
* The session event log is the durable source of truth (the event-sourcing / session-persistence RFCs): every
|
|
* `event.data` must round-trip losslessly through JSON so any persistence
|
|
* backend can store and reload it byte-identically. This invariant belongs to
|
|
* the log itself — `Session.append` enforces it at the source, so a
|
|
* non-serializable event never enters `session.events` and the live log can
|
|
* never diverge from what a backend can persist. Backends re-use the same
|
|
* predicate to validate their own `append(events)` entry point (replay/fork
|
|
* paths that do not go through a live `Session`).
|
|
*
|
|
* @module @deepseek-ai/dsh-session/json
|
|
*/
|
|
|
|
/**
|
|
* A value that round-trips losslessly through JSON: `null`, a boolean, a finite
|
|
* number, a string, an array of such values, or a plain object whose values are
|
|
* such values. The static type companion to {@link isJsonValue} (which validates
|
|
* the same shape at runtime). Use it to type a payload that must survive
|
|
* session-log persistence and replay byte-identically — e.g. a tool's private
|
|
* presentation `meta`.
|
|
*/
|
|
export type JsonValue = null | boolean | number | string | JsonValue[] | { [key: string]: JsonValue }
|
|
|
|
/**
|
|
* Whether `value` is losslessly JSON-serializable: only `null`, finite numbers,
|
|
* booleans, strings, plain arrays, and plain objects of such values. Rejects
|
|
* `BigInt`, function, symbol, `undefined`, non-finite numbers (`NaN`/`Infinity`,
|
|
* which `JSON.stringify` turns into `null`), and exotic objects (`Map`/`Set`/
|
|
* `Date`/class instances) — anything `JSON.stringify` would drop, throw on, or
|
|
* convert lossily. Sparse arrays are rejected too: a hole serializes to `null`,
|
|
* so `[1, , 3]` would not round-trip. Detects circular references (which would
|
|
* throw) and reports them as non-serializable rather than propagating the throw.
|
|
*
|
|
* Scope — matches `JSON.stringify` exactly: only an object's OWN ENUMERABLE
|
|
* STRING-keyed properties are inspected (`Object.values`). Symbol-keyed and
|
|
* non-enumerable properties are NOT examined, because `JSON.stringify` likewise
|
|
* drops them — they never reach the durable form, so a non-serializable value
|
|
* hiding under a symbol/non-enumerable key cannot make the round-trip lossy.
|
|
* Getters are invoked during the check (again as `JSON.stringify` would), so the
|
|
* contract is for plain data records, not objects with side-effecting accessors.
|
|
* @param value - the candidate event data to test.
|
|
* @param seen - objects on the current descent path, for circular-reference
|
|
* detection; the recursion threads it — callers omit it.
|
|
* @returns true when `value` survives a JSON round-trip losslessly.
|
|
*/
|
|
export function isJsonValue(value: unknown, seen: Set<object> = new Set()): boolean {
|
|
if (value === null) return true
|
|
switch (typeof value) {
|
|
case 'boolean':
|
|
case 'string':
|
|
return true
|
|
case 'number':
|
|
return Number.isFinite(value)
|
|
case 'bigint':
|
|
case 'function':
|
|
case 'symbol':
|
|
case 'undefined':
|
|
return false
|
|
case 'object':
|
|
break // handled below
|
|
}
|
|
// object
|
|
if (seen.has(value)) return false // circular
|
|
seen.add(value)
|
|
try {
|
|
if (Array.isArray(value)) {
|
|
// Reject sparse arrays: a hole is skipped by `every`/`forEach` but
|
|
// JSON.stringify writes it as `null`, so `[1, , 3]` would round-trip
|
|
// lossily. Require every index 0..length-1 to be an OWN property.
|
|
for (let i = 0; i < value.length; i++) {
|
|
if (!Object.prototype.hasOwnProperty.call(value, i)) return false
|
|
if (!isJsonValue(value[i], seen)) return false
|
|
}
|
|
return true
|
|
}
|
|
// Plain object only (reject Map/Set/Date/class instances).
|
|
const proto = Object.getPrototypeOf(value) as unknown
|
|
if (proto !== Object.prototype && proto !== null) return false
|
|
return Object.values(value).every(v => isJsonValue(v, seen))
|
|
} finally {
|
|
seen.delete(value)
|
|
}
|
|
}
|