@abide/abide 0.123.1 → 0.123.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @abide/abide
 
+## 0.123.2
+
+### Patch Changes
+
+- 4ce217a: `validateJson` reads a member left `undefined` as absent, so an `args: jsonSchema(...)` gate accepts `note: undefined` where `note` is optional rather than refusing it 422, as the derived args schema already did (RULEBOOK 19.25).
+
 ## 0.123.1
 
 ### Patch Changes

package/docs/REGISTRY.md

@@ -273,13 +273,13 @@ type Gated<Gate, Accepted> = [Schema<Accepted>] extends [Gate] ? never : Failed<
 
 | Name | Signature | Meaning | Rules |
 | --- | --- | --- | --- |
-| `Schema<T>` | `((value: unknown) => T) \| StandardSchemaV1<T>` | The two forms a shape may be declared in. | 19.2, 19.3, 19.4, 19.6, 19.8, 19.9, 19.10, 19.18, 19.25, 19.11, 19.12 |
+| `Schema<T>` | `((value: unknown) => T) \| StandardSchemaV1<T>` | The two forms a shape may be declared in. | 19.2, 19.3, 19.4, 19.6, 19.8, 19.9, 19.10, 19.18, 19.11, 19.12 |
 | `JsonValue` | `null \| boolean \| number \| string \| JsonValue[] \| { [k: string]: JsonValue }` | What an `Args` may hold. | — |
 | `Issues<T>` | `T extends object ? Partial<Record<Paths<T> \| '', string[]>> : string[]` | What was wrong, keyed by where. | 19.4, 19.19 |
 | `Paths<T>` | `string` | The dot-joined leaf paths of a type. | 19.5 |
 | `JsonSchema` | `JsonValue` | A JSON Schema document, the native form. | 19.7, 19.14 |
 | `jsonSchema` | `<T>(document: JsonSchema) => StandardSchemaV1<T>` | A JSON Schema document as a `Schema`, carrying its validator. | 19.13, 19.14, 19.23, 20.11 |
-| `validateJson` | `<T>(schema: JsonSchema, value: unknown) => Issues<T> \| null` | The native validator. | 19.13 |
+| `validateJson` | `<T>(schema: JsonSchema, value: unknown) => Issues<T> \| null` | The native validator. | 19.13, 19.25 |
 
 ## Headers abide generates
 

package/docs/RULEBOOK.md

@@ -1335,8 +1335,8 @@ to, and MUST NOT change the type of the value that slot gates.
 19.24 The value a body produces MUST be typed from the body alone, and a `schema` declared beside it
 MUST NOT change that type.
 
-19.25 A `Schema` derived per 19.9 MUST read a member left `undefined`, at any depth of a record, as
-absent — in process as the wire carries it (30.28).
+19.25 `validateJson` MUST read a member left `undefined`, at any depth of a record, as absent to
+`required`, `properties` and `additionalProperties` — in process as the wire carries it (30.28).
 
 # 20. Generated surfaces
 

package/docs/abide.md

@@ -8067,7 +8067,7 @@ Transports: what is written in place rather than imported.
 
 | Name | Signature | Meaning | Rules |
 | --- | --- | --- | --- |
-| `Schema<T>` | `((value: unknown) => T) \| StandardSchemaV1<T>` | The two forms a shape may be declared in. | [19.2](/rulebook#19.2), [19.3](/rulebook#19.3), [19.4](/rulebook#19.4), [19.6](/rulebook#19.6), [19.8](/rulebook#19.8), [19.9](/rulebook#19.9), [19.10](/rulebook#19.10), [19.18](/rulebook#19.18), [19.25](/rulebook#19.25), [19.11](/rulebook#19.11), [19.12](/rulebook#19.12) |
+| `Schema<T>` | `((value: unknown) => T) \| StandardSchemaV1<T>` | The two forms a shape may be declared in. | [19.2](/rulebook#19.2), [19.3](/rulebook#19.3), [19.4](/rulebook#19.4), [19.6](/rulebook#19.6), [19.8](/rulebook#19.8), [19.9](/rulebook#19.9), [19.10](/rulebook#19.10), [19.18](/rulebook#19.18), [19.11](/rulebook#19.11), [19.12](/rulebook#19.12) |
 | `JsonSchema` | `JsonValue` | A JSON Schema document, the native form. | [19.7](/rulebook#19.7), [19.14](/rulebook#19.14) |
 
 ## Taught in
@@ -8158,7 +8158,7 @@ Transports: what is written in place rather than imported.
 
 | Name | Signature | Meaning | Rules |
 | --- | --- | --- | --- |
-| `validateJson` | `<T>(schema: JsonSchema, value: unknown) => Issues<T> \| null` | The native validator. | [19.13](/rulebook#19.13) |
+| `validateJson` | `<T>(schema: JsonSchema, value: unknown) => Issues<T> \| null` | The native validator. | [19.13](/rulebook#19.13), [19.25](/rulebook#19.25) |
 
 ## Taught in
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@abide/abide",
-    "version": "0.123.1",
+    "version": "0.123.2",
     "type": "module",
     "description": "Isomorphic type-safe framework for reactive async interfaces for humans and machines",
     "license": "MIT",

package/src/server/derivedArgs.ts

@@ -15,81 +15,12 @@ import { argsDocumentOf } from './coerceArgs.ts'
  * called, whether or not an app mounted it. Not where its `args` gate publishes a document of its
  * own, which holds the args itself (19.7). Args that did not come are held as an empty record: a
  * schema is only derived where the handler's args are a required record, so a required member
- * missing is refused, not read off nothing. The args are held as SENT (`asSent`): a call in process
- * passing a member `undefined` is the call the wire carries without it.
+ * missing is refused, not read off nothing.
  */
 export function derivedArgs(
     handler: HeldToAnnotation & Gated<unknown>,
     schema: JsonValue,
 ): void {
     if (argsDocumentOf(handler) !== undefined) return
-    handler[DERIVED_ARGS] = (args) => validateJson(schema, asSent(args ?? {}))
-}
-
-/** The records `asSent` is inside of, so a cyclic value is walked once rather than forever. */
-const WALKING: object[] = []
-
-/**
- * `value` as the wire carries it, which drops a member left `undefined` (19.25): a URL omits it
- * (30.28) and JSON leaves it out, at any depth of a body. `value` itself wherever it holds none, so
- * the walk allocates nothing for the call that writes no `undefined` member.
- *
- * AN `undefined` IN A LIST IS KEPT. The two encodings part there — JSON writes `null`, a URL the
- * text `undefined` — so neither is the wire's, and the schema answers the value as given.
- */
-export function asSent(value: unknown): unknown {
-    if (value === null || typeof value !== 'object' || WALKING.includes(value))
-        return value
-    WALKING.push(value)
-    try {
-        return Array.isArray(value)
-            ? listAsSent(value)
-            : recordAsSent(value as Record<string, unknown>)
-    } finally {
-        WALKING.pop()
-    }
-}
-
-function listAsSent(list: unknown[]): unknown[] {
-    let sent: unknown[] | null = null
-    for (let index = 0; index < list.length; index += 1) {
-        const member = list[index]
-        const held = asSent(member)
-        if (sent === null && held !== member) sent = list.slice(0, index)
-        sent?.push(held)
-    }
-    return sent ?? list
-}
-
-function recordAsSent(
-    record: Record<string, unknown>,
-): Record<string, unknown> {
-    let sent: Record<string, unknown> | null = null
-    for (const key in record) {
-        if (!Object.hasOwn(record, key)) continue
-        const member = record[key]
-        const held = member === undefined ? undefined : asSent(member)
-        if (sent === null && (member === undefined || held !== member))
-            sent = membersBefore(record, key)
-        if (sent !== null && held !== undefined) sent[key] = held
-    }
-    return sent ?? record
-}
-
-/**
- * A copy of `record`'s own members ahead of `key`, in their order.
- *
- * NO PROTOTYPE, so an own `__proto__` member JSON parsed stays a member the schema reads rather
- * than becoming the copy's prototype.
- */
-function membersBefore(
-    record: Record<string, unknown>,
-    key: string,
-): Record<string, unknown> {
-    const copy: Record<string, unknown> = Object.create(null)
-    for (const earlier in record) {
-        if (earlier === key) break
-        if (Object.hasOwn(record, earlier)) copy[earlier] = record[earlier]
-    }
-    return copy
+    handler[DERIVED_ARGS] = (args) => validateJson(schema, args ?? {})
 }

package/src/shared/validateJson.ts

@@ -486,6 +486,17 @@ function checkArray(
         check(items, value[index], join(path, String(index)), found)
 }
 
+/**
+ * Whether `value` carries `key` as JSON would: an own member, and not one left `undefined`.
+ *
+ * 19.25 — `undefined` IS NOT A JSON VALUE, so a member holding it is the member the wire leaves out:
+ * JSON drops it and a URL omits it (30.28). Read as present, `note?: string` refused a call in process
+ * passing `note: undefined` at 422 that the same call over the wire was answered for.
+ */
+function holds(value: Record<string, unknown>, key: string): boolean {
+    return value[key] !== undefined && Object.hasOwn(value, key)
+}
+
 function checkObject(
     node: Node,
     value: Record<string, unknown>,
@@ -504,7 +515,7 @@ function checkObject(
             // `required: ['toString']` was satisfied by `{}`, and — the one that matters —
             // `'__proto__' in declared` answered true, so `additionalProperties: false` accepted
             // `{"__proto__": …}` as a declared member and handed the object on unchecked.
-            if (!Object.hasOwn(value, key))
+            if (!holds(value, key))
                 noteOr(found, join(path, key), 'is required')
         }
     }
@@ -515,7 +526,7 @@ function checkObject(
             if (!Object.hasOwn(declared, key)) continue
             // An absent member is `required`'s business, not its schema's — checking it
             // here would report every optional member as the wrong type.
-            if (!Object.hasOwn(value, key)) continue
+            if (!holds(value, key)) continue
             check(
                 declared[key] as JsonValue,
                 value[key],
@@ -527,7 +538,7 @@ function checkObject(
     const extra = node.additionalProperties
     if (extra === undefined) return
     for (const key in value) {
-        if (!Object.hasOwn(value, key)) continue
+        if (!holds(value, key)) continue
         if (declared !== null && Object.hasOwn(declared, key)) continue
         if (extra === false) {
             noteOr(found, join(path, key), 'is not a known member')