Skip to content

docs(swift-sdk): describe item fields, sorts, type replacement and the fake - #634

Merged
aicayzer merged 3 commits into
mainfrom
docs/swift-sdk-0036
Oct 25, 2026
Merged

aicayzer merged 3 commits into
mainfrom
docs/swift-sdk-0036

Conversation

@aicayzer

Copy link
Copy Markdown
Contributor

Summary

The Swift SDK reference and the troubleshooting guide now describe what the SDK does at Marfa v0.0.36: the hydrate report lists replaced and unreplaced declared types, a create and an edit take more fields, lists and searches filter and sort on more, and the fake copy answers each of them. The code change is withmarfa/marfa-swift#374.

Changes

  • Swift SDK, declare an app type: hydration registers a missing type, replaces a changed app.* type, and leaves a type the instance refuses to replace as the instance holds it. The report names each in registeredTypes, unregisteredTypes, replacedTypes and unreplacedTypes.
  • Swift SDK, read and write: the Draft fields state, capture location and edges, the Edit fields occurredAt and clearOccurredAt, the ListFilters and SearchFilters additions, and the optional halves of Sort with the property(name:) field.
  • Swift SDK, test against a fake copy: a new section lists what the fake answers and what it refuses with FakeCopyError.unsupported.
  • Troubleshooting: an entry for a type in unreplacedTypes.

Testing

  • pnpm test passes (700 tests), including the content lint and the command check.
  • I checked each rule against the SDK's code and tests at the pinned commit, and the device/hydrate-replace-* rules in the contract.
  • Not run: pnpm build.

Notes for reviewers

  • docs#628 rewrites the same paragraph of the Swift SDK page, "Declare an app type", and says the report doesn't list replaced types yet. This pull request replaces that sentence, so it needs a rebase when docs(swift-sdk): say what hydration does with a changed declared type #628 merges. docs#631 describes the same fields for the CLI, and docs#632 edits the troubleshooting guide.
  • The pages describe the SDK at the commit marfa-swift#374 pins. Merge this after that pull request is released.

@aicayzer

Copy link
Copy Markdown
Contributor Author

Rebased onto main: the 'Declare an app type' paragraph now says what Swift SDK v0.0.33 does (HydrateReport.replacedTypes and unreplacedTypes, checked against marfa-swift), and the changelog gains a Swift SDK v0.0.33 entry. Review depth: checks only, as this was already reviewed with the SDK change.

@aicayzer
aicayzer force-pushed the docs/swift-sdk-0036 branch from 1495660 to ca2037d Compare October 25, 2026 13:53
@aicayzer
aicayzer merged commit 646a182 into main Oct 25, 2026
3 checks passed
@aicayzer
aicayzer deleted the docs/swift-sdk-0036 branch October 25, 2026 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant