Skip to content

chore(sdk-core): enhance RichText changeset with versioning note and usage examples #136

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 2 commits into from
Feb 18, 2026
Merged

chore(sdk-core): enhance RichText changeset with versioning note and usage examples #136

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b601d6
chore(sdk-core): enhance RichText changeset
aspiers Jan 27, 2026
a2b7074
fix(docs): rename duplicate const facets variables in changeset example
aspiers Feb 18, 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
19 changes: 17 additions & 2 deletions .changeset/add-richtext-utility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,24 @@

Add RichText utility functions for auto-detecting facets from text

**0.x Versioning Note:** This is a non-breaking addition. No existing APIs are modified or removed.

New utility functions to simplify creating rich text facets:

- `createFacetsFromText(text, agent?)` - async function that auto-detects URLs, hashtags, and @mentions. If an agent is
provided, resolves mentions to DIDs.
- `createFacetsFromTextSync(text)` - sync function for fast detection without mention resolution
provided, resolves mentions to DIDs; otherwise mentions use the handle string as the DID.
- `createFacetsFromTextSync(text)` - sync function for fast detection without mention resolution (mentions use handle as
DID)
- Re-exports `RichText` class from `@atproto/api` for advanced use cases

**Usage:**

```typescript
import { createFacetsFromText, createFacetsFromTextSync } from "@hypercerts-org/sdk-core";

// Sync (no DID resolution)
const facetsSync = createFacetsFromTextSync("Check out #hypercerts by @alice");

// Async with DID resolution (requires authenticated agent)
const facetsAsync = await createFacetsFromText("Check out #hypercerts by @alice", agent);
```