Skip to content

feat: add shortDescriptionFacets to collection #189

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
aspiers merged 3 commits into from
Apr 3, 2026
Merged

feat: add shortDescriptionFacets to collection #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1838fc7
feat: add shortDescriptionFacets to collection
holkexyz Apr 1, 2026
e40d2cd
changeset: add changeset for feat/collection-short-description-facets
holkexyz Apr 1, 2026
8eeb304
chore: add changeset for collection shortDescriptionFacets
holkexyz Apr 1, 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
5 changes: 5 additions & 0 deletions .changeset/collection-short-description-facets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@hypercerts-org/lexicon": minor
---

Add `shortDescriptionFacets` to collection for rich text annotations on `shortDescription`
23 changes: 12 additions & 11 deletions SCHEMAS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,17 +129,18 @@ A free-form string describing the work scope for simple or legacy scopes.

#### Properties

| Property | Type | Required | Description | Comments |
| ------------------ | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `type` | `string` | ❌ | The type of this collection. Values beyond the known set are permitted. | maxLength: 64, Known values: `favorites`, `project`, `portfolio`, `program` |
| `title` | `string` | ✅ | Display name for this collection (e.g. 'Q1 2025 Impact Projects') | maxLength: 800, maxGraphemes: 80 |
| `shortDescription` | `string` | ❌ | Short summary of this collection, suitable for previews and list views | maxLength: 3000, maxGraphemes: 300 |
| `description` | `ref` | ❌ | Rich-text description, represented as a Leaflet linear document. | |
| `avatar` | `union` | ❌ | The collection's avatar/profile image as a URI or image blob. | |
| `banner` | `union` | ❌ | Larger horizontal image to display behind the collection view. | |
| `items` | `ref[]` | ❌ | Array of items in this collection with optional weights. | maxLength: 1000 |
| `location` | `ref` | ❌ | A strong reference to the location where this collection's activities were performed. The record referenced must conform with the lexicon app.certified.location. | |
| `createdAt` | `string` | ✅ | Client-declared timestamp when this record was originally created | |
| Property | Type | Required | Description | Comments |
| ------------------------ | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `type` | `string` | ❌ | The type of this collection. Values beyond the known set are permitted. | maxLength: 64, Known values: `favorites`, `project`, `portfolio`, `program` |
| `title` | `string` | ✅ | Display name for this collection (e.g. 'Q1 2025 Impact Projects') | maxLength: 800, maxGraphemes: 80 |
| `shortDescription` | `string` | ❌ | Short summary of this collection, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`. | maxLength: 3000, maxGraphemes: 300 |
| `shortDescriptionFacets` | `ref[]` | ❌ | Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc). | |
| `description` | `ref` | ❌ | Rich-text description, represented as a Leaflet linear document. | |
| `avatar` | `union` | ❌ | The collection's avatar/profile image as a URI or image blob. | |
| `banner` | `union` | ❌ | Larger horizontal image to display behind the collection view. | |
| `items` | `ref[]` | ❌ | Array of items in this collection with optional weights. | maxLength: 1000 |
| `location` | `ref` | ❌ | A strong reference to the location where this collection's activities were performed. The record referenced must conform with the lexicon app.certified.location. | |
| `createdAt` | `string` | ✅ | Client-declared timestamp when this record was originally created | |

#### Defs

Expand Down
10 changes: 9 additions & 1 deletion lexicons/org/hypercerts/collection.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,15 @@
"type": "string",
"maxLength": 3000,
"maxGraphemes": 300,
"description": "Short summary of this collection, suitable for previews and list views"
"description": "Short summary of this collection, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`."
},
"shortDescriptionFacets": {
"type": "array",
"description": "Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc).",
"items": {
"type": "ref",
"ref": "app.bsky.richtext.facet"
}
},
"description": {
"type": "ref",
Expand Down
Loading