Skip to content

Latest commit

 

History

History
98 lines (79 loc) · 5.08 KB

1.10.0.md

File metadata and controls

98 lines (79 loc) · 5.08 KB

Swift-JSON 1.10.0 — release notes

This minor release is about exact interchange: canonical bytes for hashing and signing, a versioned envelope for stored records, structural differences as RFC 6902 patches and as a visual page, and RFC 7464 JSON text sequences. Preparation and tagging do not establish publication; the official GitHub release and its qualification asset identify the final source and actual outcomes.

Added

Canonical JSON (RFC 8785). JSONCanonicalWriter writes JSON Canonicalization Scheme bytes: compact output, keys ordered by UTF-16 code units, short string escapes and ECMAScript spelling of binary64 numbers. Equal values produce equal bytes, so the output can be hashed, signed or used as a content address. Because JSONNumber is an exact decimal, NumberPolicy.preserving (the default) refuses a number whose binary64 spelling would denote a different value; .rounding rounds as RFC 8785 does. Tests cover the RFC's Appendix B number vectors, its sample document and its key-sorting example. The existing writer and its scalar key order are unchanged.

Versioned envelopes. JSONEnvelope stores one payload with a caller-chosen type and schema version as one canonical object:

{"digest":"sha256:…","format":"swift-json-envelope","formatVersion":1,"payload":{…},"type":"mcp.task","version":3}

The digest is the SHA-256 of the payload's canonical bytes. Decoding accepts any strict spelling, checks the marker, the six members, the format version, the fields and the digest, and reports JSONEnvelopeFailure for invalid or damaged records. Equal envelopes encode to equal bytes, and equal payloads have equal digests. Format version 1 is fixed. Stores built on Swift-SQLite are the intended users; Swift-JSON itself adds no persistence.

Structural differences. JSONPatch.difference(from:to:options:) computes RFC 6902 operations that turn one exact value into another. Equal values produce no operation, objects are compared by key, and arrays keep their longest equal prefix and suffix and compare the rest by position. The result always applies to the source to give the target. It is deterministic but not minimal, and it never uses move, copy or test.

Visual differences. JSONHTMLRenderer.renderDifference(from:to:) renders two values as one static, script-free tree. Added, removed and changed values carry text markers as well as color, and unchanged parts stay visible but collapsed. The page has a summary, a change list linked by JSON Pointer, a CSS-only "Show changes only" toggle and downloads of the patch, the source and the target. Its CSP sets script-src 'none' and authorizes its stylesheets by hash. The comparison is a package walker in JSON shared with JSONPatch.difference, so JSONHTML still depends on JSON only.

JSON text sequences (RFC 7464). JSONTextSequence reads application/json-seq streams with the same pull model and budgets as NDJSON. A top-level number, true, false or null without trailing whitespace is treated as possibly truncated. Malformed texts fail by default; the .skip policy skips and counts them as RFC 7464 recommends, but never skips resource failures. JSONTextSequenceWriter writes RS, strict JSON and LF per value, as a whole sequence or in awaited bounded chunks.

Maintenance

These changes were collected for a 1.9.1 hygiene release that was not published separately; they ship in 1.10.0.

  • A platform-floor CI lane checks the macOS 15 / iOS 18 manifest minimums, cross-compiles every library for iOS 18 devices and the simulator, and builds and runs an external consumer with the same minimums.
  • The CLI source identity no longer covers DocC catalogs.
  • Developer kit 0.2.0 targets published 1.9.0. The repository is a Claude Code plugin marketplace. A kit update for 1.10.0 follows the 1.10.0 tag.

Platforms

Unchanged from 1.9.0: macOS 15 and iOS 18 minimums, developed with Swift 6.4 and the macOS 27 SDK (Xcode 27). Linux and WASI scope is unchanged.

Compatibility and qualification

The release is additive over 1.9.0. The package keeps twelve library products plus swift-json, thirteen DocC catalogs, Swift tools and compiler 6.4+, Swift language mode 6, an empty root dependency graph, Apache-2.0 and retained upstream notices. No product dependency changes. CLI metadata reports 1.10.0 with the deterministic final-source identity.

The maintainer recorded an explicit exception for the 1.10.0 controlled-performance gate. It is not a pass. This release makes no speed, throughput, allocation or RSS claim.

See the 1.10 qualification record for the API compatibility check, the local and CI lane outcomes and the exception.

The work was integrated through PR #94, PR #95, PR #96, PR #97, PR #98 and PR #99.