### Description This pull request standardizes the usage of Matrix event content keys by replacing hardcoded property names and older constants with centralized, unstable prefix constants imported from the `$unstable/prefixes` module. This change improves maintainability and consistency across the codebase, especially in handling experimental or non-standard Matrix properties. The most important changes are as follows: ##### Prefix Standardization and Centralization Replaced all hardcoded Matrix property names and older constants (e.g., `'com.beeper.per_message_profile'`, `'com.beeper.linkpreviews'`, etc.) with corresponding constants from the `$unstable/prefixes` module throughout the codebase, including message rendering, room creation, user profiles, and input handling. ##### Message Content Handling Updated all logic for reading, writing, and deleting Matrix event content properties (e.g., per-message profiles, link previews, image source packs, spoilers, blur hashes, forward metadata) to use the new prefix constants, ensuring consistent access and mutation of event content. ##### User Profile and Room Metadata Updated user profile extended keys (such as bio, banner, pronouns, timezone, animal identity) in `UserRoomProfile.tsx` to use the new prefix constants, replacing all previous hardcoded or legacy key strings. ##### Room Creation and Calls Changed the room call state event type to use the new unstable prefix constant in room creation utilities. ##### Code Clean-up Removed now-unused imports of old constants from files where they have been replaced with the new prefix-based constants. These changes collectively improve the code's future compatibility with evolving Matrix specifications and make it easier to update property names as they stabilize. #### Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update Shouldn't cause user facing changes ### Checklist: - [ ] My code follows the style guidelines of this project - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings ### AI disclosure: No AI usage
Sable
A Matrix client built to enhance the user experience with quality-of-life features, cosmetics, utilities, and sheer usability. See the changelog.
Soon to be replaced desktop apps can be downloaded here. They auto-update by pulling the website.
Join our matrix space here to discuss features, issues, or meowing.
Forked from Cinny.
Getting started
The web app is available at app.sable.moe and gets updated on frequently, as soon as a feature is deemed stable.
You can also download our desktop app for windows and linux from releases.
Self-hosting
You have a few options for self hosting, you can:
- Run the prebuilt docker container.
- Deploy on a site like GitLab Pages. Jae has a guide here.
- Build it yourself.
Docker
Prebuilt images are published to ghcr.io/sableclient/sable.
latesttracks the currentdevbranch image.X.Y.Ztags are versioned releases.X.Ytags float within a release line.- Pushes to
devalso publish a short commit SHA tag.
Run the latest image with:
docker run --rm -p 8080:8080 ghcr.io/sableclient/sable:latest
Then open http://localhost:8080.
If you want to override the bundled config.json, mount your own
file at /app/config.json:
services:
sable:
image: ghcr.io/sableclient/sable:latest
ports:
- '8080:8080'
volumes:
- ./config.json:/app/config.json:ro
Build it yourself
To build and serve Sable yourself with nginx, clone this repo and build it:
pnpm i # Installs all dependencies
pnpm run build # Compiles the app into the dist/ directory
After that, you can copy the dist/ directory to your server and serve it.
-
In the
config.json, you can modify the default homeservers, feature rooms/spaces, toggle the account switcher, and toggle experimental simplified slilding sync support. -
To deploy on subdirectory, you need to rebuild the app youself after updating the
basepath inbuild.config.ts.- For example, if you want to deploy on
https://sable.moe/app, then setbase: '/app'.
- For example, if you want to deploy on
Local development
Tip
We recommend using a version manager as versions change quickly. fnm is a great cross-platform option (Windows, macOS, and Linux). NVM on Windows and nvm on Linux/macOS are also good choices. Use the version defined in
.node-version.
Execute the following commands to start a development server:
fnm use --corepack-enabled # Activates the Node version and enables corepack
# If you not using fnm, install corepack manually: npm install --global corepack@latest
corepack install # Installs the pnpm version specified in package.json
pnpm i # Installs all dependencies
pnpm run dev # Serve a development version
To build the app:
pnpm run build # Compiles the app into the dist/ directory
Deployment and infrastructure
Deployment workflows and infrastructure details live in
infra/README.md.