Skip to content

fix: widen description fields from Leaflet ref to union type #181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
s-adamantine merged 9 commits into from
Apr 7, 2026
Merged

fix: widen description fields from Leaflet ref to union type #181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
71e2704
fix: widen description fields from Leaflet ref to union type
holkexyz Apr 1, 2026
e998889
changeset: add changeset for fix/description-union-type
holkexyz Apr 1, 2026
6125d83
chore: update ERD and add changeset for description union
holkexyz Apr 1, 2026
b855ec6
fix: use inline Leaflet lexicon ref instead of strongRef for descript…
s-adamantine Apr 6, 2026
719cdc6
chore: remove duplicate changeset
s-adamantine Apr 7, 2026
dd2c5eb
feat: add strongRef as third option in description union
s-adamantine Apr 7, 2026
a1f6bff
chore: clarify breaking change note in changeset
s-adamantine Apr 7, 2026
aab9093
Widen description fields to union type
s-adamantine Apr 7, 2026
06fce2c
fix: remove redundant #main from linearDocument union refs
s-adamantine Apr 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/description-union-type.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"@hypercerts-org/lexicon": minor
---

Widen description fields on activity, collection, and attachment from a bare Leaflet ref to a union of inline descriptionString and Leaflet linearDocument, with a shared def in org.hypercerts.defs.

This is technically a breaking schema change (ref → union), but not breaking for most published records, as they already include a `$type` discriminator on the description object, so existing data validates against the union without modification.
2 changes: 1 addition & 1 deletion ERD.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ dataclass collection {
type?
title
shortDescription?
description? (Leaflet ref)
description?
items[]?
location?
createdAt
Expand Down
63 changes: 36 additions & 27 deletions SCHEMAS.md
View file
Open in desktop

Large diffs are not rendered by default.

10 changes: 7 additions & 3 deletions lexicons/org/hypercerts/claim/activity.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,13 @@
}
},
"description": {
"type": "ref",
"ref": "pub.leaflet.pages.linearDocument#main",
"description": "Rich-text description, represented as a Leaflet linear document."
"type": "union",
"refs": [
"org.hypercerts.defs#descriptionString",
"pub.leaflet.pages.linearDocument",
"com.atproto.repo.strongRef"
],
"description": "Long-form description of the activity. An inline string for plain text or markdown, a Leaflet linear document for rich-text content, or a strong reference to an external description record."
},
"image": {
"type": "union",
Expand Down
10 changes: 7 additions & 3 deletions lexicons/org/hypercerts/collection.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,13 @@
}
},
"description": {
"type": "ref",
"ref": "pub.leaflet.pages.linearDocument#main",
"description": "Rich-text description, represented as a Leaflet linear document."
"type": "union",
"refs": [
"org.hypercerts.defs#descriptionString",
"pub.leaflet.pages.linearDocument",
"com.atproto.repo.strongRef"
],
"description": "Long-form description of the collection. An inline string for plain text or markdown, a Leaflet linear document for rich-text content, or a strong reference to an external description record."
},
"avatar": {
"type": "union",
Expand Down
10 changes: 7 additions & 3 deletions lexicons/org/hypercerts/context/attachment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,13 @@
}
},
"description": {
"type": "ref",
"ref": "pub.leaflet.pages.linearDocument#main",
"description": "Rich-text description, represented as a Leaflet linear document."
"type": "union",
"refs": [
"org.hypercerts.defs#descriptionString",
"pub.leaflet.pages.linearDocument",
"com.atproto.repo.strongRef"
],
"description": "Long-form description of the attachment. An inline string for plain text or markdown, a Leaflet linear document for rich-text content, or a strong reference to an external description record."
},
"location": {
"type": "ref",
Expand Down
21 changes: 21 additions & 0 deletions lexicons/org/hypercerts/defs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,27 @@
"id": "org.hypercerts.defs",
"description": "Common type definitions used across all Hypercerts protocols.",
"defs": {
"descriptionString": {
"type": "object",
"description": "An inline long-form description as plain text or markdown, with optional rich-text annotations.",
"required": ["value"],
"properties": {
"value": {
"type": "string",
"description": "The description text (plain text or markdown).",
"maxLength": 250000,
"maxGraphemes": 25000
Comment thread
aspiers marked this conversation as resolved.
},
"facets": {
"type": "array",
"description": "Rich text annotations for the description (mentions, URLs, hashtags, etc).",
"items": {
"type": "ref",
"ref": "app.bsky.richtext.facet"
}
}
}
},
"uri": {
"type": "object",
"required": ["uri"],
Expand Down
Loading