Apply the auto-fixable lint rules and the formatter, and drop the Vite build artifacts.
This commit is contained in:
@@ -25,14 +25,14 @@ tauri.ts → native notification APIs
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/capacitor.config.json` | Capacitor app id, web dir |
|
||||
| `src-tauri/src/main.rs` | Tauri Android entry |
|
||||
| `cinny/src/app/utils/tauri.ts` | Platform detection, notifications |
|
||||
| `cinny/src/app/utils/backgroundSync.ts` | UnifiedPush registration |
|
||||
| `cinny/src/app/utils/androidShare.ts` | Share target handling |
|
||||
| `cinny/src/app/pages/client/ClientNonUIFeatures.tsx` | Share listener wiring |
|
||||
| Path | Role |
|
||||
| ---------------------------------------------------- | --------------------------------- |
|
||||
| `cinny/capacitor.config.json` | Capacitor app id, web dir |
|
||||
| `src-tauri/src/main.rs` | Tauri Android entry |
|
||||
| `cinny/src/app/utils/tauri.ts` | Platform detection, notifications |
|
||||
| `cinny/src/app/utils/backgroundSync.ts` | UnifiedPush registration |
|
||||
| `cinny/src/app/utils/androidShare.ts` | Share target handling |
|
||||
| `cinny/src/app/pages/client/ClientNonUIFeatures.tsx` | Share listener wiring |
|
||||
|
||||
## Data model
|
||||
|
||||
|
||||
@@ -25,29 +25,29 @@ ClientRoot (authenticated)
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/pages/auth/login/Login.tsx` | Login hub |
|
||||
| `cinny/src/app/pages/auth/login/PasswordLoginForm.tsx` | Password login |
|
||||
| `cinny/src/app/pages/auth/login/TokenLogin.tsx` | Access token login |
|
||||
| `cinny/src/app/pages/auth/SSOLogin.tsx` | SSO redirect |
|
||||
| `cinny/src/app/pages/auth/register/Register.tsx` | Registration |
|
||||
| `cinny/src/app/pages/auth/register/PasswordRegisterForm.tsx` | Password register |
|
||||
| `cinny/src/app/pages/auth/reset-password/ResetPassword.tsx` | Password reset |
|
||||
| `cinny/src/app/pages/auth/ServerPicker.tsx` | Homeserver selection |
|
||||
| `cinny/src/app/pages/auth/AuthLayout.tsx` | Auth chrome + logo |
|
||||
| `cinny/src/app/pages/auth/login/loginUtil.ts` | Login helpers |
|
||||
| `cinny/src/app/pages/auth/register/registerUtil.ts` | Register helpers |
|
||||
| `cinny/src/app/state/sessions.ts` | Session storage |
|
||||
| `cinny/src/client/initMatrix.ts` | Client init from session |
|
||||
| `cinny/src/app/pages/afterLoginRedirectPath.ts` | Post-login redirect |
|
||||
| Path | Role |
|
||||
| ------------------------------------------------------------ | ------------------------ |
|
||||
| `cinny/src/app/pages/auth/login/Login.tsx` | Login hub |
|
||||
| `cinny/src/app/pages/auth/login/PasswordLoginForm.tsx` | Password login |
|
||||
| `cinny/src/app/pages/auth/login/TokenLogin.tsx` | Access token login |
|
||||
| `cinny/src/app/pages/auth/SSOLogin.tsx` | SSO redirect |
|
||||
| `cinny/src/app/pages/auth/register/Register.tsx` | Registration |
|
||||
| `cinny/src/app/pages/auth/register/PasswordRegisterForm.tsx` | Password register |
|
||||
| `cinny/src/app/pages/auth/reset-password/ResetPassword.tsx` | Password reset |
|
||||
| `cinny/src/app/pages/auth/ServerPicker.tsx` | Homeserver selection |
|
||||
| `cinny/src/app/pages/auth/AuthLayout.tsx` | Auth chrome + logo |
|
||||
| `cinny/src/app/pages/auth/login/loginUtil.ts` | Login helpers |
|
||||
| `cinny/src/app/pages/auth/register/registerUtil.ts` | Register helpers |
|
||||
| `cinny/src/app/state/sessions.ts` | Session storage |
|
||||
| `cinny/src/client/initMatrix.ts` | Client init from session |
|
||||
| `cinny/src/app/pages/afterLoginRedirectPath.ts` | Post-login redirect |
|
||||
|
||||
## Data model
|
||||
|
||||
| Key | Storage | Content |
|
||||
|-----|---------|---------|
|
||||
| Session store | localStorage | access token, user id, device id, hs url |
|
||||
| `setAfterLoginRedirectPath` | sessionStorage/memory | deep link target after login |
|
||||
| Key | Storage | Content |
|
||||
| --------------------------- | --------------------- | ---------------------------------------- |
|
||||
| Session store | localStorage | access token, user id, device id, hs url |
|
||||
| `setAfterLoginRedirectPath` | sessionStorage/memory | deep link target after login |
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
||||
@@ -24,25 +24,25 @@ Other clients / Profile.tsx
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/utils/imageMetadata.ts` | Unified embed/extract API |
|
||||
| `cinny/src/app/utils/pngMetadata.ts` | PNG tEXt chunks |
|
||||
| `cinny/src/app/utils/jpegMetadata.ts` | JPEG XMP APP1 |
|
||||
| `cinny/src/app/utils/webpMetadata.ts` | WebP XMP |
|
||||
| `cinny/src/app/utils/gifMetadata.ts` | GIF application extension |
|
||||
| Path | Role |
|
||||
| ----------------------------------------------------- | ----------------------------- |
|
||||
| `cinny/src/app/utils/imageMetadata.ts` | Unified embed/extract API |
|
||||
| `cinny/src/app/utils/pngMetadata.ts` | PNG tEXt chunks |
|
||||
| `cinny/src/app/utils/jpegMetadata.ts` | JPEG XMP APP1 |
|
||||
| `cinny/src/app/utils/webpMetadata.ts` | WebP XMP |
|
||||
| `cinny/src/app/utils/gifMetadata.ts` | GIF application extension |
|
||||
| `cinny/src/app/features/settings/account/Profile.tsx` | Settings UI + upload pipeline |
|
||||
|
||||
## Data model
|
||||
|
||||
Metadata keys (embedded in binary image, not Matrix):
|
||||
|
||||
| Key | Format | Notes |
|
||||
|-----|--------|-------|
|
||||
| `paarrot:color` | All | Accent color hex |
|
||||
| `paarrot:banner` | PNG (+ unified API) | Banner image URL |
|
||||
| `paarrot:borderColor` | PNG | Border accent |
|
||||
| `paarrot:gradient` | PNG | Gradient spec |
|
||||
| Key | Format | Notes |
|
||||
| --------------------- | ------------------- | ---------------- |
|
||||
| `paarrot:color` | All | Accent color hex |
|
||||
| `paarrot:banner` | PNG (+ unified API) | Banner image URL |
|
||||
| `paarrot:borderColor` | PNG | Border accent |
|
||||
| `paarrot:gradient` | PNG | Gradient spec |
|
||||
|
||||
XMP namespace: `http://paarrot.app/ns/1.0/`
|
||||
|
||||
|
||||
@@ -27,22 +27,22 @@ tauri.ts / electron main
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/pages/client/ClientNonUIFeatures.tsx` | Favicon, notifications, API init, background sync hooks |
|
||||
| `cinny/src/app/utils/backgroundSync.ts` | Pushers, UnifiedPush, foreground state |
|
||||
| `cinny/src/app/utils/tauri.ts` | Tauri/Capacitor notification helpers |
|
||||
| `cinny/src/app/features/settings/notifications/SystemNotification.tsx` | Permission UX |
|
||||
| `electron/main.js` | Tray, notification IPC (if applicable) |
|
||||
| `src-tauri/src/main.rs` | Tauri Android shell |
|
||||
| Path | Role |
|
||||
| ---------------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `cinny/src/app/pages/client/ClientNonUIFeatures.tsx` | Favicon, notifications, API init, background sync hooks |
|
||||
| `cinny/src/app/utils/backgroundSync.ts` | Pushers, UnifiedPush, foreground state |
|
||||
| `cinny/src/app/utils/tauri.ts` | Tauri/Capacitor notification helpers |
|
||||
| `cinny/src/app/features/settings/notifications/SystemNotification.tsx` | Permission UX |
|
||||
| `electron/main.js` | Tray, notification IPC (if applicable) |
|
||||
| `src-tauri/src/main.rs` | Tauri Android shell |
|
||||
|
||||
## Data model
|
||||
|
||||
| Key | Storage | Purpose |
|
||||
|-----|---------|---------|
|
||||
| `paarrot.unifiedpush.*` | localStorage prefix | UP endpoint state |
|
||||
| `com.paarrot.app.android` | Pusher app id base | Android pushers |
|
||||
| Matrix pusher | Homeserver | HTTP push gateway |
|
||||
| Key | Storage | Purpose |
|
||||
| ------------------------- | ------------------- | ----------------- |
|
||||
| `paarrot.unifiedpush.*` | localStorage prefix | UP endpoint state |
|
||||
| `com.paarrot.app.android` | Pusher app id base | Android pushers |
|
||||
| Matrix pusher | Homeserver | HTTP push gateway |
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
||||
@@ -27,24 +27,24 @@ SpecVersions in ClientRoot
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/components/title-bar/TitleBar.tsx` | Desktop title bar |
|
||||
| `cinny/src/app/components/splash-screen/SplashScreen.tsx` | Splash |
|
||||
| `cinny/src/app/pages/client/WelcomePage.tsx` | Welcome / download links |
|
||||
| `cinny/src/app/components/account-switcher/AccountSwitcher.tsx` | Multi-account |
|
||||
| `cinny/src/app/components/update-notification/UpdateNotification.tsx` | Auto-update UI |
|
||||
| `cinny/src/app/pages/FeatureCheck.tsx` | Browser capability gate |
|
||||
| `cinny/src/app/pages/client/SpecVersions.tsx` | HS version warning |
|
||||
| `cinny/src/app/pages/client/SyncStatus.tsx` | Sync indicator |
|
||||
| `cinny/src/app/pages/ConfigConfig.tsx` | Config load error UI |
|
||||
| `cinny/src/app/components/ClientConfigLoader.tsx` | Load config.json |
|
||||
| Path | Role |
|
||||
| --------------------------------------------------------------------- | ------------------------ |
|
||||
| `cinny/src/app/components/title-bar/TitleBar.tsx` | Desktop title bar |
|
||||
| `cinny/src/app/components/splash-screen/SplashScreen.tsx` | Splash |
|
||||
| `cinny/src/app/pages/client/WelcomePage.tsx` | Welcome / download links |
|
||||
| `cinny/src/app/components/account-switcher/AccountSwitcher.tsx` | Multi-account |
|
||||
| `cinny/src/app/components/update-notification/UpdateNotification.tsx` | Auto-update UI |
|
||||
| `cinny/src/app/pages/FeatureCheck.tsx` | Browser capability gate |
|
||||
| `cinny/src/app/pages/client/SpecVersions.tsx` | HS version warning |
|
||||
| `cinny/src/app/pages/client/SyncStatus.tsx` | Sync indicator |
|
||||
| `cinny/src/app/pages/ConfigConfig.tsx` | Config load error UI |
|
||||
| `cinny/src/app/components/ClientConfigLoader.tsx` | Load config.json |
|
||||
|
||||
## Data model
|
||||
|
||||
| Key | Storage |
|
||||
|-----|---------|
|
||||
| Sessions | multi-account in sessions.ts |
|
||||
| Key | Storage |
|
||||
| -------------- | ---------------------------- |
|
||||
| Sessions | multi-account in sessions.ts |
|
||||
| electron-store | window bounds (main process) |
|
||||
|
||||
## Dependencies
|
||||
|
||||
@@ -26,15 +26,15 @@ Imported by room-settings and space-settings shells
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/features/common-settings/general/RoomProfile.tsx` | Name/topic/avatar |
|
||||
| `cinny/src/app/features/common-settings/general/RoomJoinRules.tsx` | Join rules |
|
||||
| `cinny/src/app/features/common-settings/general/RoomEncryption.tsx` | E2E toggle |
|
||||
| `cinny/src/app/features/common-settings/general/EmbedFilters.tsx` | Room-wide embed filters |
|
||||
| `cinny/src/app/features/common-settings/members/Members.tsx` | Member management |
|
||||
| `cinny/src/app/features/common-settings/permissions/PowersEditor.tsx` | Power levels |
|
||||
| `cinny/src/app/features/common-settings/developer-tools/` | Dev event tools |
|
||||
| Path | Role |
|
||||
| --------------------------------------------------------------------- | ----------------------- |
|
||||
| `cinny/src/app/features/common-settings/general/RoomProfile.tsx` | Name/topic/avatar |
|
||||
| `cinny/src/app/features/common-settings/general/RoomJoinRules.tsx` | Join rules |
|
||||
| `cinny/src/app/features/common-settings/general/RoomEncryption.tsx` | E2E toggle |
|
||||
| `cinny/src/app/features/common-settings/general/EmbedFilters.tsx` | Room-wide embed filters |
|
||||
| `cinny/src/app/features/common-settings/members/Members.tsx` | Member management |
|
||||
| `cinny/src/app/features/common-settings/permissions/PowersEditor.tsx` | Power levels |
|
||||
| `cinny/src/app/features/common-settings/developer-tools/` | Dev event tools |
|
||||
|
||||
## Data model
|
||||
|
||||
|
||||
@@ -26,18 +26,18 @@ State: createRoomModal.ts, createSpaceModal.ts
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/features/create-room/CreateRoomModal.tsx` | Room create + sub-room parent update |
|
||||
| `cinny/src/app/features/create-space/CreateSpaceModal.tsx` | Space create |
|
||||
| `cinny/src/app/features/create-chat/` | DM flows |
|
||||
| `cinny/src/app/features/add-existing/AddExisting.tsx` | Add to space |
|
||||
| `cinny/src/app/features/create-room/CreateRoom.tsx` | Standalone create page |
|
||||
| `cinny/src/app/features/create-space/CreateSpace.tsx` | Standalone space create |
|
||||
| `cinny/src/app/state/createRoomModal.ts` | Modal state + parent room id |
|
||||
| `cinny/src/app/state/createSpaceModal.ts` | Space modal state |
|
||||
| `cinny/src/app/pages/client/create/Create.tsx` | Create hub route |
|
||||
| `cinny/src/app/pages/client/home/CreateRoom.tsx` | Home create entry |
|
||||
| Path | Role |
|
||||
| ---------------------------------------------------------- | ------------------------------------ |
|
||||
| `cinny/src/app/features/create-room/CreateRoomModal.tsx` | Room create + sub-room parent update |
|
||||
| `cinny/src/app/features/create-space/CreateSpaceModal.tsx` | Space create |
|
||||
| `cinny/src/app/features/create-chat/` | DM flows |
|
||||
| `cinny/src/app/features/add-existing/AddExisting.tsx` | Add to space |
|
||||
| `cinny/src/app/features/create-room/CreateRoom.tsx` | Standalone create page |
|
||||
| `cinny/src/app/features/create-space/CreateSpace.tsx` | Standalone space create |
|
||||
| `cinny/src/app/state/createRoomModal.ts` | Modal state + parent room id |
|
||||
| `cinny/src/app/state/createSpaceModal.ts` | Space modal state |
|
||||
| `cinny/src/app/pages/client/create/Create.tsx` | Create hub route |
|
||||
| `cinny/src/app/pages/client/home/CreateRoom.tsx` | Home create entry |
|
||||
|
||||
## Data model
|
||||
|
||||
|
||||
@@ -23,23 +23,23 @@ settings emojis-stickers + common-settings emojis
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/plugins/custom-emoji/PackMetaReader.ts` | Read pack metadata |
|
||||
| `cinny/src/app/plugins/custom-emoji/PackImageReader.ts` | Single image |
|
||||
| `cinny/src/app/plugins/custom-emoji/PackImagesReader.ts` | Bulk images |
|
||||
| `cinny/src/app/plugins/custom-emoji/ImagePack.ts` | Pack model |
|
||||
| `cinny/src/app/plugins/custom-emoji/types.ts` | Types |
|
||||
| `cinny/src/app/plugins/emoji.ts` | Shortcode rendering |
|
||||
| `cinny/src/app/plugins/recent-emoji.ts` | Recent emoji helper |
|
||||
| `cinny/src/app/components/image-pack-view/ImagePackView.tsx` | Pack browser UI |
|
||||
| `cinny/src/app/hooks/useImagePackRooms.ts` | Rooms with packs |
|
||||
| Path | Role |
|
||||
| ------------------------------------------------------------ | ------------------- |
|
||||
| `cinny/src/app/plugins/custom-emoji/PackMetaReader.ts` | Read pack metadata |
|
||||
| `cinny/src/app/plugins/custom-emoji/PackImageReader.ts` | Single image |
|
||||
| `cinny/src/app/plugins/custom-emoji/PackImagesReader.ts` | Bulk images |
|
||||
| `cinny/src/app/plugins/custom-emoji/ImagePack.ts` | Pack model |
|
||||
| `cinny/src/app/plugins/custom-emoji/types.ts` | Types |
|
||||
| `cinny/src/app/plugins/emoji.ts` | Shortcode rendering |
|
||||
| `cinny/src/app/plugins/recent-emoji.ts` | Recent emoji helper |
|
||||
| `cinny/src/app/components/image-pack-view/ImagePackView.tsx` | Pack browser UI |
|
||||
| `cinny/src/app/hooks/useImagePackRooms.ts` | Rooms with packs |
|
||||
|
||||
## Data model
|
||||
|
||||
| Event | Purpose |
|
||||
|-------|---------|
|
||||
| `im.ponies.room_emotes` | Room emoji pack definition |
|
||||
| Event | Purpose |
|
||||
| ----------------------- | -------------------------------------- |
|
||||
| `im.ponies.room_emotes` | Room emoji pack definition |
|
||||
| Image pack account data | User/global packs (see emoji-stickers) |
|
||||
|
||||
## Dependencies
|
||||
|
||||
@@ -21,13 +21,13 @@ common-settings/developer-tools/
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/features/settings/developer-tools/DevelopTools.tsx` | User-level dev tools |
|
||||
| `cinny/src/app/features/settings/developer-tools/AccountData.tsx` | Account data viewer |
|
||||
| `cinny/src/app/features/common-settings/developer-tools/DevelopTools.tsx` | Room dev tools entry |
|
||||
| `cinny/src/app/features/common-settings/developer-tools/StateEventEditor.tsx` | Edit state events |
|
||||
| `cinny/src/app/features/common-settings/developer-tools/SendRoomEvent.tsx` | Send events |
|
||||
| Path | Role |
|
||||
| ----------------------------------------------------------------------------- | -------------------- |
|
||||
| `cinny/src/app/features/settings/developer-tools/DevelopTools.tsx` | User-level dev tools |
|
||||
| `cinny/src/app/features/settings/developer-tools/AccountData.tsx` | Account data viewer |
|
||||
| `cinny/src/app/features/common-settings/developer-tools/DevelopTools.tsx` | Room dev tools entry |
|
||||
| `cinny/src/app/features/common-settings/developer-tools/StateEventEditor.tsx` | Edit state events |
|
||||
| `cinny/src/app/features/common-settings/developer-tools/SendRoomEvent.tsx` | Send events |
|
||||
|
||||
## Data model
|
||||
|
||||
|
||||
@@ -24,19 +24,19 @@ mDirectAtom — direct room index
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/pages/client/direct/Direct.tsx` | DM list |
|
||||
| `cinny/src/app/pages/client/direct/DirectCreate.tsx` | Create DM |
|
||||
| `cinny/src/app/pages/client/direct/useDirectRooms.ts` | List logic |
|
||||
| `cinny/src/app/pages/client/sidebar/DirectTab.tsx` | Sidebar tab |
|
||||
| `cinny/src/app/state/mDirectList.ts` | `mDirectAtom` |
|
||||
| `cinny/src/app/hooks/useDirectUsers.ts` | DM user helpers |
|
||||
| Path | Role |
|
||||
| ----------------------------------------------------- | --------------- |
|
||||
| `cinny/src/app/pages/client/direct/Direct.tsx` | DM list |
|
||||
| `cinny/src/app/pages/client/direct/DirectCreate.tsx` | Create DM |
|
||||
| `cinny/src/app/pages/client/direct/useDirectRooms.ts` | List logic |
|
||||
| `cinny/src/app/pages/client/sidebar/DirectTab.tsx` | Sidebar tab |
|
||||
| `cinny/src/app/state/mDirectList.ts` | `mDirectAtom` |
|
||||
| `cinny/src/app/hooks/useDirectUsers.ts` | DM user helpers |
|
||||
|
||||
## Data model
|
||||
|
||||
| Key | Scope |
|
||||
|-----|-------|
|
||||
| Key | Scope |
|
||||
| ---------- | ------------------------------------------ |
|
||||
| `m.direct` | User account data — map userId → roomIds[] |
|
||||
|
||||
## Dependencies
|
||||
|
||||
@@ -24,26 +24,26 @@ useSecretStorage, useKeyBackup, useVerificationRequest hooks
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/client/secretStorageKeys.ts` | SSSS key handling |
|
||||
| `cinny/src/app/features/settings/devices/Devices.tsx` | Device list |
|
||||
| `cinny/src/app/features/settings/devices/Verification.tsx` | Verification UI |
|
||||
| `cinny/src/app/features/settings/devices/LocalBackup.tsx` | Key export |
|
||||
| `cinny/src/app/features/settings/devices/OtherDevices.tsx` | Remote sessions |
|
||||
| `cinny/src/app/components/DeviceVerification.tsx` | Incoming verify modal |
|
||||
| `cinny/src/app/components/BackupRestore.tsx` | Auto restore |
|
||||
| `cinny/src/app/components/SecretStorage.tsx` | Passphrase setup |
|
||||
| `cinny/src/app/hooks/useSecretStorage.ts` | Secret storage API |
|
||||
| `cinny/src/app/hooks/useKeyBackup.ts` | Backup API |
|
||||
| `cinny/src/app/pages/client/sidebar/UnverifiedTab.tsx` | Unverified badge |
|
||||
| Path | Role |
|
||||
| ---------------------------------------------------------- | --------------------- |
|
||||
| `cinny/src/client/secretStorageKeys.ts` | SSSS key handling |
|
||||
| `cinny/src/app/features/settings/devices/Devices.tsx` | Device list |
|
||||
| `cinny/src/app/features/settings/devices/Verification.tsx` | Verification UI |
|
||||
| `cinny/src/app/features/settings/devices/LocalBackup.tsx` | Key export |
|
||||
| `cinny/src/app/features/settings/devices/OtherDevices.tsx` | Remote sessions |
|
||||
| `cinny/src/app/components/DeviceVerification.tsx` | Incoming verify modal |
|
||||
| `cinny/src/app/components/BackupRestore.tsx` | Auto restore |
|
||||
| `cinny/src/app/components/SecretStorage.tsx` | Passphrase setup |
|
||||
| `cinny/src/app/hooks/useSecretStorage.ts` | Secret storage API |
|
||||
| `cinny/src/app/hooks/useKeyBackup.ts` | Backup API |
|
||||
| `cinny/src/app/pages/client/sidebar/UnverifiedTab.tsx` | Unverified badge |
|
||||
|
||||
## Data model
|
||||
|
||||
| Store | Purpose |
|
||||
|-------|---------|
|
||||
| IndexedDB crypto | Olm account, Megolm sessions |
|
||||
| SSSS | Cross-signing keys, backup key |
|
||||
| Store | Purpose |
|
||||
| ------------------- | ----------------------------------------- |
|
||||
| IndexedDB crypto | Olm account, Megolm sessions |
|
||||
| SSSS | Cross-signing keys, backup key |
|
||||
| Matrix account data | `m.cross_signing.*`, `m.secret_storage.*` |
|
||||
|
||||
## Dependencies
|
||||
|
||||
@@ -25,25 +25,25 @@ text-area plugin (legacy/plain areas in some UI)
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/components/editor/Editor.tsx` | Main Slate editor |
|
||||
| `cinny/src/app/components/editor/Toolbar.tsx` | Formatting toolbar |
|
||||
| `cinny/src/app/components/editor/input.ts` | Parse into editor |
|
||||
| `cinny/src/app/components/editor/output.ts` | Serialize to Matrix |
|
||||
| `cinny/src/app/components/editor/autocomplete/` | Mention/emoji menus |
|
||||
| `cinny/src/app/features/room/RoomInput.tsx` | Room composer wrapper |
|
||||
| `cinny/src/app/plugins/text-area/` | Plain text area utilities |
|
||||
| `cinny/src/app/hooks/useFilePasteHandler.ts` | Paste files |
|
||||
| `cinny/src/app/hooks/useFileDrop.ts` | Drag-drop files |
|
||||
| `cinny/src/app/state/room/roomInputDrafts.ts` | Draft persistence |
|
||||
| Path | Role |
|
||||
| ----------------------------------------------- | ------------------------- |
|
||||
| `cinny/src/app/components/editor/Editor.tsx` | Main Slate editor |
|
||||
| `cinny/src/app/components/editor/Toolbar.tsx` | Formatting toolbar |
|
||||
| `cinny/src/app/components/editor/input.ts` | Parse into editor |
|
||||
| `cinny/src/app/components/editor/output.ts` | Serialize to Matrix |
|
||||
| `cinny/src/app/components/editor/autocomplete/` | Mention/emoji menus |
|
||||
| `cinny/src/app/features/room/RoomInput.tsx` | Room composer wrapper |
|
||||
| `cinny/src/app/plugins/text-area/` | Plain text area utilities |
|
||||
| `cinny/src/app/hooks/useFilePasteHandler.ts` | Paste files |
|
||||
| `cinny/src/app/hooks/useFileDrop.ts` | Drag-drop files |
|
||||
| `cinny/src/app/state/room/roomInputDrafts.ts` | Draft persistence |
|
||||
|
||||
## Data model
|
||||
|
||||
| Key | Storage |
|
||||
|-----|---------|
|
||||
| `roomIdToMsgDraftAtomFamily` | localStorage per room |
|
||||
| `roomIdToUploadItemsAtomFamily` | pending uploads |
|
||||
| Key | Storage |
|
||||
| ------------------------------- | --------------------- |
|
||||
| `roomIdToMsgDraftAtomFamily` | localStorage per room |
|
||||
| `roomIdToUploadItemsAtomFamily` | pending uploads |
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
||||
@@ -25,23 +25,23 @@ preload / contextBridge → window.electron in renderer
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `electron/main.js` | Main process entry |
|
||||
| `electron/api-server.js` | Local HTTP API |
|
||||
| `electron/preload.js` (if exists) | IPC bridge |
|
||||
| `electron-builder.json5` | Packaging config |
|
||||
| `package.json` (root) | `npm run dev`, build scripts |
|
||||
| `dev-app-update.yml` | Update channel config |
|
||||
| `cinny/src/app/components/title-bar/TitleBar.tsx` | Custom title bar UI |
|
||||
| `build-resources/` | Linux after-install, icons |
|
||||
| Path | Role |
|
||||
| ------------------------------------------------- | ---------------------------- |
|
||||
| `electron/main.js` | Main process entry |
|
||||
| `electron/api-server.js` | Local HTTP API |
|
||||
| `electron/preload.js` (if exists) | IPC bridge |
|
||||
| `electron-builder.json5` | Packaging config |
|
||||
| `package.json` (root) | `npm run dev`, build scripts |
|
||||
| `dev-app-update.yml` | Update channel config |
|
||||
| `cinny/src/app/components/title-bar/TitleBar.tsx` | Custom title bar UI |
|
||||
| `build-resources/` | Linux after-install, icons |
|
||||
|
||||
## Data model
|
||||
|
||||
| Store | Tool | Contents |
|
||||
|-------|------|----------|
|
||||
| `electron-store` | main.js | Window bounds, user prefs |
|
||||
| UserData | Electron | plugins, caches |
|
||||
| Store | Tool | Contents |
|
||||
| ---------------- | -------- | ------------------------- |
|
||||
| `electron-store` | main.js | Window bounds, user prefs |
|
||||
| UserData | Electron | plugins, caches |
|
||||
|
||||
Protocol: `PROTOCOL_SCHEME = 'paarrot'` in main.js
|
||||
|
||||
|
||||
@@ -21,22 +21,22 @@ useRoomWideEmbedFilters (room state)
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/hooks/useRoomEmbedFilters.ts` | Hooks, types, combine logic |
|
||||
| `cinny/src/types/matrix/room.ts` | `StateEvent.RoomEmbedFilters` |
|
||||
| `cinny/src/app/features/room/ThreadView.tsx` | Consumer |
|
||||
| `cinny/src/app/features/room/RoomTimeline.tsx` | Consumer |
|
||||
| `cinny/src/app/features/common-settings/general/EmbedFilters.tsx` | Room-wide settings UI |
|
||||
| `cinny/src/app/components/RenderMessageContent.tsx` | Embed render gating |
|
||||
| `cinny/src/app/features/forum/useForumMessageRenderOptions.ts` | Forum post embed options |
|
||||
| Path | Role |
|
||||
| ----------------------------------------------------------------- | ----------------------------- |
|
||||
| `cinny/src/app/hooks/useRoomEmbedFilters.ts` | Hooks, types, combine logic |
|
||||
| `cinny/src/types/matrix/room.ts` | `StateEvent.RoomEmbedFilters` |
|
||||
| `cinny/src/app/features/room/ThreadView.tsx` | Consumer |
|
||||
| `cinny/src/app/features/room/RoomTimeline.tsx` | Consumer |
|
||||
| `cinny/src/app/features/common-settings/general/EmbedFilters.tsx` | Room-wide settings UI |
|
||||
| `cinny/src/app/components/RenderMessageContent.tsx` | Embed render gating |
|
||||
| `cinny/src/app/features/forum/useForumMessageRenderOptions.ts` | Forum post embed options |
|
||||
|
||||
## Data model
|
||||
|
||||
| Key | Scope | Content |
|
||||
|-----|-------|---------|
|
||||
| `im.paarrot.embed_filters` | Room account data (per user) | `{ disabledPatterns: string[] }` |
|
||||
| `im.paarrot.room.embed_filters` | Room state | `{ disabledPatterns: string[] }` |
|
||||
| Key | Scope | Content |
|
||||
| ------------------------------- | ---------------------------- | -------------------------------- |
|
||||
| `im.paarrot.embed_filters` | Room account data (per user) | `{ disabledPatterns: string[] }` |
|
||||
| `im.paarrot.room.embed_filters` | Room state | `{ disabledPatterns: string[] }` |
|
||||
|
||||
Patterns are JavaScript `RegExp` strings — invalid regex can throw; handle at input time.
|
||||
|
||||
|
||||
@@ -24,25 +24,25 @@ Settings / common-settings EmojisStickers pages
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/hooks/useEmojiUsage.ts` | Usage stats in account data |
|
||||
| `cinny/src/app/utils/telegramStickerImport.ts` | Telegram Bot API import |
|
||||
| `cinny/src/app/features/settings/emojis-stickers/TelegramImport.tsx` | Import UI |
|
||||
| `cinny/src/app/features/settings/emojis-stickers/EmojisStickers.tsx` | Settings hub |
|
||||
| `cinny/src/app/features/settings/emojis-stickers/UserPack.tsx` | User pack editor |
|
||||
| `cinny/src/app/features/settings/emojis-stickers/GlobalPacks.tsx` | Global packs |
|
||||
| `cinny/src/app/plugins/custom-emoji/` | Custom emoji pack reader |
|
||||
| `cinny/src/app/pages/client/ClientNonUIFeatures.tsx` | `EmojiStyleFeature` |
|
||||
| `cinny/src/app/state/settings.ts` | `EmojiStyle` enum |
|
||||
| Path | Role |
|
||||
| -------------------------------------------------------------------- | --------------------------- |
|
||||
| `cinny/src/app/hooks/useEmojiUsage.ts` | Usage stats in account data |
|
||||
| `cinny/src/app/utils/telegramStickerImport.ts` | Telegram Bot API import |
|
||||
| `cinny/src/app/features/settings/emojis-stickers/TelegramImport.tsx` | Import UI |
|
||||
| `cinny/src/app/features/settings/emojis-stickers/EmojisStickers.tsx` | Settings hub |
|
||||
| `cinny/src/app/features/settings/emojis-stickers/UserPack.tsx` | User pack editor |
|
||||
| `cinny/src/app/features/settings/emojis-stickers/GlobalPacks.tsx` | Global packs |
|
||||
| `cinny/src/app/plugins/custom-emoji/` | Custom emoji pack reader |
|
||||
| `cinny/src/app/pages/client/ClientNonUIFeatures.tsx` | `EmojiStyleFeature` |
|
||||
| `cinny/src/app/state/settings.ts` | `EmojiStyle` enum |
|
||||
|
||||
## Data model
|
||||
|
||||
| Key | Scope | Content |
|
||||
|-----|-------|---------|
|
||||
| `paarrot.favemojis` | User account data | Emoji usage counts |
|
||||
| `cinny_telegram_bot_token` | localStorage | Telegram bot token (TelegramImport) |
|
||||
| `im.ponies.room_emotes` | Room state | Standard Matrix emoji packs |
|
||||
| Key | Scope | Content |
|
||||
| -------------------------- | ----------------- | ----------------------------------- |
|
||||
| `paarrot.favemojis` | User account data | Emoji usage counts |
|
||||
| `cinny_telegram_bot_token` | localStorage | Telegram bot token (TelegramImport) |
|
||||
| `im.ponies.room_emotes` | Room state | Standard Matrix emoji packs |
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
||||
@@ -24,12 +24,12 @@ client/explore/
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/pages/client/explore/Explore.tsx` | Explore hub |
|
||||
| `cinny/src/app/pages/client/explore/Server.tsx` | Server directory |
|
||||
| `cinny/src/app/pages/client/explore/Featured.tsx` | Featured list |
|
||||
| `cinny/src/app/pages/client/sidebar/ExploreTab.tsx` | Sidebar entry |
|
||||
| Path | Role |
|
||||
| --------------------------------------------------- | -------------------- |
|
||||
| `cinny/src/app/pages/client/explore/Explore.tsx` | Explore hub |
|
||||
| `cinny/src/app/pages/client/explore/Server.tsx` | Server directory |
|
||||
| `cinny/src/app/pages/client/explore/Featured.tsx` | Featured list |
|
||||
| `cinny/src/app/pages/client/sidebar/ExploreTab.tsx` | Sidebar entry |
|
||||
| `cinny/src/app/hooks/useRoomDirectoryVisibility.ts` | Directory visibility |
|
||||
|
||||
## Data model
|
||||
|
||||
@@ -27,31 +27,31 @@ Routing: `getSpaceDefaultPath` + `shouldShowForumLobby` in path utils / room uti
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/features/forum/ForumFeedPage.tsx` | Main feed page |
|
||||
| `cinny/src/app/features/forum/ForumSpaceLayout.tsx` | Layout shell |
|
||||
| `cinny/src/app/features/forum/ForumAwareSpaceLayout.tsx` | Forum vs non-forum switch |
|
||||
| `cinny/src/app/features/forum/forumFeed.ts` | Post aggregation, root detection |
|
||||
| `cinny/src/app/features/forum/types.ts` | ForumTopic, ForumPost, etc. |
|
||||
| `cinny/src/app/features/forum/ForumBoardView.tsx` | Board listing |
|
||||
| `cinny/src/app/features/forum/ForumThreadDetail.tsx` | Thread view |
|
||||
| `cinny/src/app/features/forum/ForumNewPostModal.tsx` | Create post |
|
||||
| `cinny/src/app/features/forum/ForumReplyComposer.tsx` | Replies |
|
||||
| `cinny/src/app/features/forum/useForumBoard.ts` | Board data hook |
|
||||
| `cinny/src/app/features/forum/useForumRoomLiveUpdates.ts` | Live timeline sync |
|
||||
| `cinny/src/app/pages/pathUtils.ts` | Forum routing |
|
||||
| Path | Role |
|
||||
| --------------------------------------------------------- | -------------------------------- |
|
||||
| `cinny/src/app/features/forum/ForumFeedPage.tsx` | Main feed page |
|
||||
| `cinny/src/app/features/forum/ForumSpaceLayout.tsx` | Layout shell |
|
||||
| `cinny/src/app/features/forum/ForumAwareSpaceLayout.tsx` | Forum vs non-forum switch |
|
||||
| `cinny/src/app/features/forum/forumFeed.ts` | Post aggregation, root detection |
|
||||
| `cinny/src/app/features/forum/types.ts` | ForumTopic, ForumPost, etc. |
|
||||
| `cinny/src/app/features/forum/ForumBoardView.tsx` | Board listing |
|
||||
| `cinny/src/app/features/forum/ForumThreadDetail.tsx` | Thread view |
|
||||
| `cinny/src/app/features/forum/ForumNewPostModal.tsx` | Create post |
|
||||
| `cinny/src/app/features/forum/ForumReplyComposer.tsx` | Replies |
|
||||
| `cinny/src/app/features/forum/useForumBoard.ts` | Board data hook |
|
||||
| `cinny/src/app/features/forum/useForumRoomLiveUpdates.ts` | Live timeline sync |
|
||||
| `cinny/src/app/pages/pathUtils.ts` | Forum routing |
|
||||
|
||||
## Data model
|
||||
|
||||
| Signal | Purpose |
|
||||
|--------|---------|
|
||||
| `m.room.create` `type: m.forum` | Matrix forum room type |
|
||||
| `im.paarrot.room.kind: forum_space` | Paarrot forum classification |
|
||||
| `com.matrixsso.title` on messages | Forum post title (legacy/custom) |
|
||||
| `formatted_body` with `<h1>` | Root post detection |
|
||||
| `m.relates_to` threads | Replies and edits |
|
||||
| `im.paarrot.sub_rooms` | Topic room hierarchy (see sub-rooms) |
|
||||
| Signal | Purpose |
|
||||
| ----------------------------------- | ------------------------------------ |
|
||||
| `m.room.create` `type: m.forum` | Matrix forum room type |
|
||||
| `im.paarrot.room.kind: forum_space` | Paarrot forum classification |
|
||||
| `com.matrixsso.title` on messages | Forum post title (legacy/custom) |
|
||||
| `formatted_body` with `<h1>` | Root post detection |
|
||||
| `m.relates_to` threads | Replies and edits |
|
||||
| `im.paarrot.sub_rooms` | Topic room hierarchy (see sub-rooms) |
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
||||
@@ -21,17 +21,17 @@ useAsyncSearch or similar for filtering
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/features/search/Search.tsx` | Modal UI |
|
||||
| `cinny/src/app/state/searchModal.ts` | Open/close state |
|
||||
| `cinny/src/app/pages/client/sidebar/SearchTab.tsx` | Sidebar entry |
|
||||
| Path | Role |
|
||||
| -------------------------------------------------- | ---------------- |
|
||||
| `cinny/src/app/features/search/Search.tsx` | Modal UI |
|
||||
| `cinny/src/app/state/searchModal.ts` | Open/close state |
|
||||
| `cinny/src/app/pages/client/sidebar/SearchTab.tsx` | Sidebar entry |
|
||||
|
||||
## Data model
|
||||
|
||||
| Key | Storage |
|
||||
|-----|---------|
|
||||
| `searchModal` atom | memory |
|
||||
| Key | Storage |
|
||||
| ------------------ | ------- |
|
||||
| `searchModal` atom | memory |
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
||||
@@ -24,32 +24,32 @@ DirectTab.tsx → useDirectRooms.ts
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/pages/client/home/Home.tsx` | Home room list UI |
|
||||
| `cinny/src/app/pages/client/home/useHomeRooms.ts` | Room list logic + Paarrot room kind |
|
||||
| `cinny/src/app/pages/client/SidebarNav.tsx` | Sidebar tab bar |
|
||||
| `cinny/src/app/pages/client/sidebar/HomeTab.tsx` | Home tab |
|
||||
| `cinny/src/app/pages/client/sidebar/DirectTab.tsx` | DMs tab + favicon logos |
|
||||
| `cinny/src/app/pages/client/sidebar/InboxTab.tsx` | Inbox tab |
|
||||
| `cinny/src/app/pages/client/sidebar/ExploreTab.tsx` | Explore tab |
|
||||
| `cinny/src/app/pages/client/sidebar/SearchTab.tsx` | Search tab |
|
||||
| `cinny/src/app/pages/client/sidebar/SettingsTab.tsx` | Settings tab |
|
||||
| `cinny/src/app/pages/client/sidebar/SpaceTabs.tsx` | Space context tabs |
|
||||
| `cinny/src/app/pages/client/home/HomeThreadsCategory.tsx` | Threads grouping |
|
||||
| `cinny/src/app/hooks/useRoomListReorder.ts` | DnD reorder |
|
||||
| `cinny/src/app/hooks/useSidebarItems.ts` | Sidebar item model |
|
||||
| Path | Role |
|
||||
| --------------------------------------------------------- | ----------------------------------- |
|
||||
| `cinny/src/app/pages/client/home/Home.tsx` | Home room list UI |
|
||||
| `cinny/src/app/pages/client/home/useHomeRooms.ts` | Room list logic + Paarrot room kind |
|
||||
| `cinny/src/app/pages/client/SidebarNav.tsx` | Sidebar tab bar |
|
||||
| `cinny/src/app/pages/client/sidebar/HomeTab.tsx` | Home tab |
|
||||
| `cinny/src/app/pages/client/sidebar/DirectTab.tsx` | DMs tab + favicon logos |
|
||||
| `cinny/src/app/pages/client/sidebar/InboxTab.tsx` | Inbox tab |
|
||||
| `cinny/src/app/pages/client/sidebar/ExploreTab.tsx` | Explore tab |
|
||||
| `cinny/src/app/pages/client/sidebar/SearchTab.tsx` | Search tab |
|
||||
| `cinny/src/app/pages/client/sidebar/SettingsTab.tsx` | Settings tab |
|
||||
| `cinny/src/app/pages/client/sidebar/SpaceTabs.tsx` | Space context tabs |
|
||||
| `cinny/src/app/pages/client/home/HomeThreadsCategory.tsx` | Threads grouping |
|
||||
| `cinny/src/app/hooks/useRoomListReorder.ts` | DnD reorder |
|
||||
| `cinny/src/app/hooks/useSidebarItems.ts` | Sidebar item model |
|
||||
|
||||
## Data model
|
||||
|
||||
| Source | Data |
|
||||
|--------|------|
|
||||
| `allRoomsAtom` | Joined rooms |
|
||||
| `roomToUnreadAtom` | Badge state |
|
||||
| `mDirectAtom` | DM room mapping |
|
||||
| Source | Data |
|
||||
| ---------------------- | ------------------------------- |
|
||||
| `allRoomsAtom` | Joined rooms |
|
||||
| `roomToUnreadAtom` | Badge state |
|
||||
| `mDirectAtom` | DM room mapping |
|
||||
| `im.paarrot.sub_rooms` | Nested children (see sub-rooms) |
|
||||
| `im.paarrot.room.kind` | Room classification |
|
||||
| localStorage | Category collapse, room order |
|
||||
| `im.paarrot.room.kind` | Room classification |
|
||||
| localStorage | Category collapse, room order |
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
||||
@@ -22,21 +22,21 @@ ClientRoomsNotificationPreferences.tsx — bulk prefs
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/pages/client/inbox/Inbox.tsx` | Inbox layout |
|
||||
| `cinny/src/app/pages/client/inbox/Invites.tsx` | Invites UI |
|
||||
| `cinny/src/app/pages/client/inbox/Notifications.tsx` | Notifications list |
|
||||
| `cinny/src/app/state/room-list/inviteList.ts` | `allInvitesAtom` |
|
||||
| `cinny/src/app/pages/client/ClientRoomsNotificationPreferences.tsx` | Room notif prefs |
|
||||
| `cinny/src/app/pages/client/sidebar/InboxTab.tsx` | Sidebar entry |
|
||||
| `cinny/src/app/hooks/useRoomsNotificationPreferences.ts` | Prefs hook |
|
||||
| Path | Role |
|
||||
| ------------------------------------------------------------------- | ------------------ |
|
||||
| `cinny/src/app/pages/client/inbox/Inbox.tsx` | Inbox layout |
|
||||
| `cinny/src/app/pages/client/inbox/Invites.tsx` | Invites UI |
|
||||
| `cinny/src/app/pages/client/inbox/Notifications.tsx` | Notifications list |
|
||||
| `cinny/src/app/state/room-list/inviteList.ts` | `allInvitesAtom` |
|
||||
| `cinny/src/app/pages/client/ClientRoomsNotificationPreferences.tsx` | Room notif prefs |
|
||||
| `cinny/src/app/pages/client/sidebar/InboxTab.tsx` | Sidebar entry |
|
||||
| `cinny/src/app/hooks/useRoomsNotificationPreferences.ts` | Prefs hook |
|
||||
|
||||
## Data model
|
||||
|
||||
| Source | Data |
|
||||
|--------|------|
|
||||
| Sync | `m.room.member` invite membership |
|
||||
| Source | Data |
|
||||
| ------------ | --------------------------------------- |
|
||||
| Sync | `m.room.member` invite membership |
|
||||
| Account data | push rules, per-room notification prefs |
|
||||
|
||||
## Dependencies
|
||||
|
||||
@@ -22,12 +22,12 @@ Route: _JOIN_PATH in Router.tsx
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/features/join-before-navigate/JoinBeforeNavigate.tsx` | Preview + join UI |
|
||||
| `cinny/src/app/components/RoomSummaryLoader.tsx` | Fetch room preview |
|
||||
| `cinny/src/app/hooks/useRoomNavigate.ts` | Post-join navigation |
|
||||
| `cinny/src/app/state/joiningProgress.ts` | Join in progress UX |
|
||||
| Path | Role |
|
||||
| -------------------------------------------------------------------- | -------------------- |
|
||||
| `cinny/src/app/features/join-before-navigate/JoinBeforeNavigate.tsx` | Preview + join UI |
|
||||
| `cinny/src/app/components/RoomSummaryLoader.tsx` | Fetch room preview |
|
||||
| `cinny/src/app/hooks/useRoomNavigate.ts` | Post-join navigation |
|
||||
| `cinny/src/app/state/joiningProgress.ts` | Join in progress UX |
|
||||
|
||||
## Data model
|
||||
|
||||
|
||||
@@ -23,29 +23,29 @@ Space route → Lobby.tsx (SpaceCardLobby)
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/features/lobby/Lobby.tsx` | Main lobby view |
|
||||
| `cinny/src/app/features/lobby/LobbyHeader.tsx` | Space header |
|
||||
| `cinny/src/app/features/lobby/LobbyHero.tsx` | Hero banner area |
|
||||
| `cinny/src/app/features/lobby/SpaceHierarchy.tsx` | Room tree/cards |
|
||||
| `cinny/src/app/features/lobby/DnD.tsx` | Drag and drop |
|
||||
| `cinny/src/app/features/lobby/RoomItem.tsx` | Room card |
|
||||
| `cinny/src/app/state/closedLobbyCategories.ts` | Collapsed categories |
|
||||
| `cinny/src/app/state/hooks/closedLobbyCategories.ts` | Jotai hook |
|
||||
| `cinny/src/app/pages/pathUtils.ts` | `getSpaceLobbyPath`, forum routing |
|
||||
| `cinny/src/app/utils/room.ts` | `shouldShowForumLobby`, `getStateEvent` |
|
||||
| `cinny/src/types/matrix/room.ts` | `RoomType.Forum`, `PaarrotRoomKind` |
|
||||
| Path | Role |
|
||||
| ---------------------------------------------------- | --------------------------------------- |
|
||||
| `cinny/src/app/features/lobby/Lobby.tsx` | Main lobby view |
|
||||
| `cinny/src/app/features/lobby/LobbyHeader.tsx` | Space header |
|
||||
| `cinny/src/app/features/lobby/LobbyHero.tsx` | Hero banner area |
|
||||
| `cinny/src/app/features/lobby/SpaceHierarchy.tsx` | Room tree/cards |
|
||||
| `cinny/src/app/features/lobby/DnD.tsx` | Drag and drop |
|
||||
| `cinny/src/app/features/lobby/RoomItem.tsx` | Room card |
|
||||
| `cinny/src/app/state/closedLobbyCategories.ts` | Collapsed categories |
|
||||
| `cinny/src/app/state/hooks/closedLobbyCategories.ts` | Jotai hook |
|
||||
| `cinny/src/app/pages/pathUtils.ts` | `getSpaceLobbyPath`, forum routing |
|
||||
| `cinny/src/app/utils/room.ts` | `shouldShowForumLobby`, `getStateEvent` |
|
||||
| `cinny/src/types/matrix/room.ts` | `RoomType.Forum`, `PaarrotRoomKind` |
|
||||
|
||||
## Data model
|
||||
|
||||
| Event / field | Purpose |
|
||||
|---------------|---------|
|
||||
| `m.space.child` | Child room membership + `order` |
|
||||
| `im.paarrot.sub_rooms` | Paarrot nested children (see sub-rooms handoff) |
|
||||
| `im.paarrot.room.kind` | e.g. `forum_space` for forum behavior |
|
||||
| `m.room.create` `type` | `m.forum` for forum rooms |
|
||||
| Local: `closedLobbyCategories` | UI collapse state (not Matrix) |
|
||||
| Event / field | Purpose |
|
||||
| ------------------------------ | ----------------------------------------------- |
|
||||
| `m.space.child` | Child room membership + `order` |
|
||||
| `im.paarrot.sub_rooms` | Paarrot nested children (see sub-rooms handoff) |
|
||||
| `im.paarrot.room.kind` | e.g. `forum_space` for forum behavior |
|
||||
| `m.room.create` `type` | `m.forum` for forum rooms |
|
||||
| Local: `closedLobbyCategories` | UI collapse state (not Matrix) |
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
||||
@@ -25,14 +25,14 @@ Navigation for room changes uses `setPaarrotNavigate()` registered from the Reac
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `electron/api-server.js` | Express routes, IPC bridge to renderer |
|
||||
| `electron/main.js` | Starts `PaarrotAPIServer` with the main window |
|
||||
| `cinny/src/app/paarrot-api.ts` | Action handlers (mute, deafen, channel, message, status) |
|
||||
| `cinny/src/app/pages/client/ClientNonUIFeatures.tsx` | Calls `initPaarrotAPI()` and `setPaarrotNavigate()` |
|
||||
| `test-api.js` / `test-api.sh` | Smoke tests for endpoints |
|
||||
| `paarrot-api.postman_collection.json` | Postman collection (generated) |
|
||||
| Path | Role |
|
||||
| ---------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `electron/api-server.js` | Express routes, IPC bridge to renderer |
|
||||
| `electron/main.js` | Starts `PaarrotAPIServer` with the main window |
|
||||
| `cinny/src/app/paarrot-api.ts` | Action handlers (mute, deafen, channel, message, status) |
|
||||
| `cinny/src/app/pages/client/ClientNonUIFeatures.tsx` | Calls `initPaarrotAPI()` and `setPaarrotNavigate()` |
|
||||
| `test-api.js` / `test-api.sh` | Smoke tests for endpoints |
|
||||
| `paarrot-api.postman_collection.json` | Postman collection (generated) |
|
||||
|
||||
## Data model
|
||||
|
||||
@@ -40,22 +40,22 @@ No persistent storage. Actions read/write ephemeral app state (current room, cal
|
||||
|
||||
### IPC actions (renderer)
|
||||
|
||||
| Action | Params | Returns |
|
||||
|--------|--------|---------|
|
||||
| `get-status` | — | mute, deafen, currentRoom, connected, userId |
|
||||
| `toggle-mute` / `set-mute` | `{ muted? }` | `{ muted }` |
|
||||
| `toggle-deafen` / `set-deafen` | `{ deafened? }` | `{ deafened }` |
|
||||
| `change-channel` | `{ roomId }` | navigation result |
|
||||
| `get-channels` | — | room list |
|
||||
| `send-message` | `{ roomId, message }` | send result |
|
||||
| `send-message-current` | `{ message }` | send to active room |
|
||||
| `get-current-room` | — | current room id |
|
||||
| `get-messages-groups` | `{ limit? }` | recent messages across group channels |
|
||||
| `get-messages-dms` | `{ limit? }` | recent messages across DMs |
|
||||
| `get-messages-combined` | `{ limit? }` | recent messages across groups + DMs |
|
||||
| `get-unreads-groups` | — | unread group conversations |
|
||||
| `get-unreads-dms` | — | unread DM conversations |
|
||||
| `get-unreads-combined` | — | unread groups + DMs |
|
||||
| Action | Params | Returns |
|
||||
| ------------------------------ | --------------------- | -------------------------------------------- |
|
||||
| `get-status` | — | mute, deafen, currentRoom, connected, userId |
|
||||
| `toggle-mute` / `set-mute` | `{ muted? }` | `{ muted }` |
|
||||
| `toggle-deafen` / `set-deafen` | `{ deafened? }` | `{ deafened }` |
|
||||
| `change-channel` | `{ roomId }` | navigation result |
|
||||
| `get-channels` | — | room list |
|
||||
| `send-message` | `{ roomId, message }` | send result |
|
||||
| `send-message-current` | `{ message }` | send to active room |
|
||||
| `get-current-room` | — | current room id |
|
||||
| `get-messages-groups` | `{ limit? }` | recent messages across group channels |
|
||||
| `get-messages-dms` | `{ limit? }` | recent messages across DMs |
|
||||
| `get-messages-combined` | `{ limit? }` | recent messages across groups + DMs |
|
||||
| `get-unreads-groups` | — | unread group conversations |
|
||||
| `get-unreads-dms` | — | unread DM conversations |
|
||||
| `get-unreads-combined` | — | unread groups + DMs |
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
||||
@@ -25,23 +25,23 @@ initMatrix.ts
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/client/initMatrix.ts` | createClient, start/stop, logout, cache clear |
|
||||
| `cinny/src/client/secretStorageKeys.ts` | SSSS / secret storage callbacks |
|
||||
| `cinny/src/app/pages/client/ClientRoot.tsx` | Bootstrap, providers, title bar |
|
||||
| `cinny/src/app/hooks/useMatrixClient.ts` | React context for `MatrixClient` |
|
||||
| `cinny/src/app/hooks/useSyncState.ts` | Sync state subscription |
|
||||
| `cinny/src/app/pages/client/SyncStatus.tsx` | Sync indicator UI |
|
||||
| `cinny/src/app/components/splash-screen/SplashScreen.tsx` | Loading shell |
|
||||
| Path | Role |
|
||||
| --------------------------------------------------------- | --------------------------------------------- |
|
||||
| `cinny/src/client/initMatrix.ts` | createClient, start/stop, logout, cache clear |
|
||||
| `cinny/src/client/secretStorageKeys.ts` | SSSS / secret storage callbacks |
|
||||
| `cinny/src/app/pages/client/ClientRoot.tsx` | Bootstrap, providers, title bar |
|
||||
| `cinny/src/app/hooks/useMatrixClient.ts` | React context for `MatrixClient` |
|
||||
| `cinny/src/app/hooks/useSyncState.ts` | Sync state subscription |
|
||||
| `cinny/src/app/pages/client/SyncStatus.tsx` | Sync indicator UI |
|
||||
| `cinny/src/app/components/splash-screen/SplashScreen.tsx` | Loading shell |
|
||||
|
||||
## Data model
|
||||
|
||||
| Store | Backend | Purpose |
|
||||
|-------|---------|---------|
|
||||
| IndexedDB sync store | matrix-js-sdk | Room timeline cache |
|
||||
| IndexedDB crypto store | matrix-js-sdk | Olm/Megolm keys |
|
||||
| Session | localStorage | Auth credentials |
|
||||
| Store | Backend | Purpose |
|
||||
| ---------------------- | ------------- | ------------------- |
|
||||
| IndexedDB sync store | matrix-js-sdk | Room timeline cache |
|
||||
| IndexedDB crypto store | matrix-js-sdk | Olm/Megolm keys |
|
||||
| Session | localStorage | Auth credentials |
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
||||
@@ -26,18 +26,18 @@ image-viewer/, video-viewer/ — fullscreen media
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/components/upload-card/UploadCardRenderer.tsx` | Upload UI |
|
||||
| `cinny/src/app/state/upload.ts` | Upload state |
|
||||
| `cinny/src/app/state/room/roomInputDrafts.ts` | `TUploadItem` |
|
||||
| `cinny/src/app/utils/matrix.ts` | `encryptFile`, upload helpers |
|
||||
| `cinny/src/app/components/url-preview/` | Link embed cards |
|
||||
| `cinny/src/app/components/image-viewer/` | Image lightbox |
|
||||
| `cinny/src/app/components/video-viewer/` | Video player |
|
||||
| `cinny/src/app/hooks/useMediaAuthentication.ts` | Authenticated media URLs |
|
||||
| `cinny/src/app/hooks/useAuthenticatedMediaUrl.ts` | MXC → HTTP with auth |
|
||||
| `cinny/src/app/components/message/content/` | Image/video/thumbnail content |
|
||||
| Path | Role |
|
||||
| ------------------------------------------------------------- | ----------------------------- |
|
||||
| `cinny/src/app/components/upload-card/UploadCardRenderer.tsx` | Upload UI |
|
||||
| `cinny/src/app/state/upload.ts` | Upload state |
|
||||
| `cinny/src/app/state/room/roomInputDrafts.ts` | `TUploadItem` |
|
||||
| `cinny/src/app/utils/matrix.ts` | `encryptFile`, upload helpers |
|
||||
| `cinny/src/app/components/url-preview/` | Link embed cards |
|
||||
| `cinny/src/app/components/image-viewer/` | Image lightbox |
|
||||
| `cinny/src/app/components/video-viewer/` | Video player |
|
||||
| `cinny/src/app/hooks/useMediaAuthentication.ts` | Authenticated media URLs |
|
||||
| `cinny/src/app/hooks/useAuthenticatedMediaUrl.ts` | MXC → HTTP with auth |
|
||||
| `cinny/src/app/components/message/content/` | Image/video/thumbnail content |
|
||||
|
||||
## Data model
|
||||
|
||||
|
||||
@@ -24,18 +24,18 @@ msgContent.ts — content type detection
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/components/RenderMessageContent.tsx` | Main render entry |
|
||||
| `cinny/src/app/plugins/react-custom-html-parser.tsx` | HTML → React |
|
||||
| `cinny/src/app/plugins/markdown/` | Markdown rules + parsers |
|
||||
| `cinny/src/app/plugins/react-prism/ReactPrism.tsx` | Code highlighting |
|
||||
| `cinny/src/app/plugins/emoji.ts` | Emoji shortcodes |
|
||||
| `cinny/src/app/plugins/matrix-to.ts` | matrix.to link handling |
|
||||
| `cinny/src/app/plugins/bad-words.ts` | Content filter hook |
|
||||
| `cinny/src/app/plugins/color.ts` | Text color |
|
||||
| `cinny/src/app/utils/sanitize.ts` | HTML sanitization |
|
||||
| `cinny/src/app/features/room/msgContent.ts` | Message content helpers |
|
||||
| Path | Role |
|
||||
| ---------------------------------------------------- | ------------------------ |
|
||||
| `cinny/src/app/components/RenderMessageContent.tsx` | Main render entry |
|
||||
| `cinny/src/app/plugins/react-custom-html-parser.tsx` | HTML → React |
|
||||
| `cinny/src/app/plugins/markdown/` | Markdown rules + parsers |
|
||||
| `cinny/src/app/plugins/react-prism/ReactPrism.tsx` | Code highlighting |
|
||||
| `cinny/src/app/plugins/emoji.ts` | Emoji shortcodes |
|
||||
| `cinny/src/app/plugins/matrix-to.ts` | matrix.to link handling |
|
||||
| `cinny/src/app/plugins/bad-words.ts` | Content filter hook |
|
||||
| `cinny/src/app/plugins/color.ts` | Text color |
|
||||
| `cinny/src/app/utils/sanitize.ts` | HTML sanitization |
|
||||
| `cinny/src/app/features/room/msgContent.ts` | Message content helpers |
|
||||
|
||||
## Data model
|
||||
|
||||
|
||||
@@ -22,13 +22,13 @@ Router may mount search under client routes
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/features/message-search/MessageSearch.tsx` | Main UI |
|
||||
| `cinny/src/app/features/message-search/useMessageSearch.ts` | Search logic |
|
||||
| `cinny/src/app/features/message-search/SearchInput.tsx` | Query field |
|
||||
| `cinny/src/app/features/message-search/SearchFilters.tsx` | Filters |
|
||||
| `cinny/src/app/features/message-search/SearchResultGroup.tsx` | Result list |
|
||||
| Path | Role |
|
||||
| ------------------------------------------------------------- | ------------ |
|
||||
| `cinny/src/app/features/message-search/MessageSearch.tsx` | Main UI |
|
||||
| `cinny/src/app/features/message-search/useMessageSearch.ts` | Search logic |
|
||||
| `cinny/src/app/features/message-search/SearchInput.tsx` | Query field |
|
||||
| `cinny/src/app/features/message-search/SearchFilters.tsx` | Filters |
|
||||
| `cinny/src/app/features/message-search/SearchResultGroup.tsx` | Result list |
|
||||
|
||||
## Data model
|
||||
|
||||
|
||||
@@ -22,18 +22,18 @@ Plugin folder (index.js + plugin-metadata.json)
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/features/settings/plugins/PluginLoader.tsx` | Load/enable/disable plugins |
|
||||
| `cinny/src/app/features/settings/plugins/PluginAPI.ts` | Re-exports plugin-manager + app hooks |
|
||||
| `cinny/src/app/features/settings/plugins/Plugins.tsx` | Settings UI (installed + marketplace) |
|
||||
| `cinny/src/app/features/settings/plugins/PluginButtonSlot.tsx` | Icon button injection |
|
||||
| `cinny/src/app/features/settings/plugins/PluginNavSlot.tsx` | Nav row injection |
|
||||
| `cinny/src/app/features/settings/plugins/PluginSidebarSlot.tsx` | Sidebar icon injection |
|
||||
| `cinny/src/app/features/settings/plugins/types.ts` | Local types |
|
||||
| `cinny/src/app/features/settings/plugins/PLUGIN_DEVELOPMENT.md` | Author-facing dev guide |
|
||||
| `example-plugin/` | Reference plugin at repo root |
|
||||
| `cinny/docs/PLUGIN_*.md` | API reference docs |
|
||||
| Path | Role |
|
||||
| --------------------------------------------------------------- | ------------------------------------- |
|
||||
| `cinny/src/app/features/settings/plugins/PluginLoader.tsx` | Load/enable/disable plugins |
|
||||
| `cinny/src/app/features/settings/plugins/PluginAPI.ts` | Re-exports plugin-manager + app hooks |
|
||||
| `cinny/src/app/features/settings/plugins/Plugins.tsx` | Settings UI (installed + marketplace) |
|
||||
| `cinny/src/app/features/settings/plugins/PluginButtonSlot.tsx` | Icon button injection |
|
||||
| `cinny/src/app/features/settings/plugins/PluginNavSlot.tsx` | Nav row injection |
|
||||
| `cinny/src/app/features/settings/plugins/PluginSidebarSlot.tsx` | Sidebar icon injection |
|
||||
| `cinny/src/app/features/settings/plugins/types.ts` | Local types |
|
||||
| `cinny/src/app/features/settings/plugins/PLUGIN_DEVELOPMENT.md` | Author-facing dev guide |
|
||||
| `example-plugin/` | Reference plugin at repo root |
|
||||
| `cinny/docs/PLUGIN_*.md` | API reference docs |
|
||||
|
||||
## Data model
|
||||
|
||||
|
||||
@@ -23,21 +23,21 @@ Bot → state im.paarrot.ui
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/types/matrix/room.ts` | `StateEvent.PaarrotUi`, `MessageEvent.PaarrotUiAction`, node types |
|
||||
| `cinny/src/app/utils/room.ts` | `getPaarrotUiContent`, `hasRoomAppUi` |
|
||||
| `cinny/src/app/features/room/Room.tsx` | Takeover branch + Show chat / Show app |
|
||||
| `cinny/src/app/features/room-app/` | `RoomAppView`, schema renderer, CSS sanitize/scope |
|
||||
| `cinny/src/app/features/room/RoomTimeline.tsx` | Hides `im.paarrot.ui.action` |
|
||||
| `cinny/src/app/features/room-settings/permissions/usePermissionItems.ts` | Permission labels |
|
||||
| Path | Role |
|
||||
| ------------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||
| `cinny/src/types/matrix/room.ts` | `StateEvent.PaarrotUi`, `MessageEvent.PaarrotUiAction`, node types |
|
||||
| `cinny/src/app/utils/room.ts` | `getPaarrotUiContent`, `hasRoomAppUi` |
|
||||
| `cinny/src/app/features/room/Room.tsx` | Takeover branch + Show chat / Show app |
|
||||
| `cinny/src/app/features/room-app/` | `RoomAppView`, schema renderer, CSS sanitize/scope |
|
||||
| `cinny/src/app/features/room/RoomTimeline.tsx` | Hides `im.paarrot.ui.action` |
|
||||
| `cinny/src/app/features/room-settings/permissions/usePermissionItems.ts` | Permission labels |
|
||||
|
||||
## Data model
|
||||
|
||||
| Event | Kind | Content |
|
||||
|-------|------|---------|
|
||||
| `im.paarrot.ui` | state (`""`) | `{ version, title?, css?, root }` |
|
||||
| `im.paarrot.ui.action` | timeline | `{ action, component_id, value?, values?, ui_event_id? }` |
|
||||
| Event | Kind | Content |
|
||||
| ---------------------- | ------------ | --------------------------------------------------------- |
|
||||
| `im.paarrot.ui` | state (`""`) | `{ version, title?, css?, root }` |
|
||||
| `im.paarrot.ui.action` | timeline | `{ action, component_id, value?, values?, ui_event_id? }` |
|
||||
|
||||
See [samples/](./samples/) for pasteable Developer Tools payloads.
|
||||
|
||||
|
||||
@@ -25,13 +25,13 @@ Used by Home.tsx, space sidebars, forum sidebars
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/features/room-nav/RoomNavItem.tsx` | Main room row |
|
||||
| `cinny/src/app/features/room-nav/RoomNavCategoryButton.tsx` | Category header |
|
||||
| `cinny/src/app/features/room-nav/UnjoinedSubRoomItem.tsx` | Unjoined sub-room |
|
||||
| Path | Role |
|
||||
| --------------------------------------------------------------- | ----------------- |
|
||||
| `cinny/src/app/features/room-nav/RoomNavItem.tsx` | Main room row |
|
||||
| `cinny/src/app/features/room-nav/RoomNavCategoryButton.tsx` | Category header |
|
||||
| `cinny/src/app/features/room-nav/UnjoinedSubRoomItem.tsx` | Unjoined sub-room |
|
||||
| `cinny/src/app/features/room-nav/CallParticipantsIndicator.tsx` | In-call indicator |
|
||||
| `cinny/src/app/features/room-nav/styles.css.ts` | Nav styles |
|
||||
| `cinny/src/app/features/room-nav/styles.css.ts` | Nav styles |
|
||||
|
||||
## Data model
|
||||
|
||||
|
||||
@@ -23,15 +23,15 @@ roomSettings.ts atom — which page open
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/features/room-settings/RoomSettings.tsx` | Settings shell |
|
||||
| `cinny/src/app/features/room-settings/general/` | General tab |
|
||||
| `cinny/src/app/features/room-settings/permissions/` | Permissions |
|
||||
| `cinny/src/app/features/room-settings/sub-rooms/SubRooms.tsx` | Sub-rooms (Paarrot) |
|
||||
| `cinny/src/app/state/roomSettings.ts` | Modal/page state |
|
||||
| `cinny/src/app/state/hooks/roomSettings.ts` | Open/close hooks |
|
||||
| `cinny/src/app/features/common-settings/` | Shared setting pages |
|
||||
| Path | Role |
|
||||
| ------------------------------------------------------------- | -------------------- |
|
||||
| `cinny/src/app/features/room-settings/RoomSettings.tsx` | Settings shell |
|
||||
| `cinny/src/app/features/room-settings/general/` | General tab |
|
||||
| `cinny/src/app/features/room-settings/permissions/` | Permissions |
|
||||
| `cinny/src/app/features/room-settings/sub-rooms/SubRooms.tsx` | Sub-rooms (Paarrot) |
|
||||
| `cinny/src/app/state/roomSettings.ts` | Modal/page state |
|
||||
| `cinny/src/app/state/hooks/roomSettings.ts` | Open/close hooks |
|
||||
| `cinny/src/app/features/common-settings/` | Shared setting pages |
|
||||
|
||||
## Data model
|
||||
|
||||
|
||||
@@ -27,32 +27,32 @@ Hooks: useVirtualPaginator, useRoomLatestRenderedEvent, useMarkAsRead
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/features/room/Room.tsx` | Room entry |
|
||||
| `cinny/src/app/features/room/RoomView.tsx` | Main layout |
|
||||
| `cinny/src/app/features/room/RoomTimeline.tsx` | Timeline |
|
||||
| `cinny/src/app/features/room/RoomInput.tsx` | Composer |
|
||||
| `cinny/src/app/features/room/ThreadView.tsx` | Thread panel |
|
||||
| `cinny/src/app/features/room/RoomViewHeader.tsx` | Header bar |
|
||||
| `cinny/src/app/features/room/message/Message.tsx` | Single message |
|
||||
| `cinny/src/app/features/room/message/Reactions.tsx` | Reaction row |
|
||||
| `cinny/src/app/features/room/message/MessageEditor.tsx` | Edit message |
|
||||
| `cinny/src/app/features/room/CommandAutocomplete.tsx` | Slash commands |
|
||||
| `cinny/src/app/features/room/reaction-viewer/ReactionViewer.tsx` | Who reacted |
|
||||
| `cinny/src/app/features/room/jump-to-time/JumpToTime.tsx` | Time jump UI |
|
||||
| `cinny/src/app/features/room/room-pin-menu/RoomPinMenu.tsx` | Pinned messages |
|
||||
| `cinny/src/app/components/RenderMessageContent.tsx` | Content render + embeds |
|
||||
| `cinny/src/app/hooks/useVirtualPaginator.ts` | Timeline pagination |
|
||||
| Path | Role |
|
||||
| ---------------------------------------------------------------- | ----------------------- |
|
||||
| `cinny/src/app/features/room/Room.tsx` | Room entry |
|
||||
| `cinny/src/app/features/room/RoomView.tsx` | Main layout |
|
||||
| `cinny/src/app/features/room/RoomTimeline.tsx` | Timeline |
|
||||
| `cinny/src/app/features/room/RoomInput.tsx` | Composer |
|
||||
| `cinny/src/app/features/room/ThreadView.tsx` | Thread panel |
|
||||
| `cinny/src/app/features/room/RoomViewHeader.tsx` | Header bar |
|
||||
| `cinny/src/app/features/room/message/Message.tsx` | Single message |
|
||||
| `cinny/src/app/features/room/message/Reactions.tsx` | Reaction row |
|
||||
| `cinny/src/app/features/room/message/MessageEditor.tsx` | Edit message |
|
||||
| `cinny/src/app/features/room/CommandAutocomplete.tsx` | Slash commands |
|
||||
| `cinny/src/app/features/room/reaction-viewer/ReactionViewer.tsx` | Who reacted |
|
||||
| `cinny/src/app/features/room/jump-to-time/JumpToTime.tsx` | Time jump UI |
|
||||
| `cinny/src/app/features/room/room-pin-menu/RoomPinMenu.tsx` | Pinned messages |
|
||||
| `cinny/src/app/components/RenderMessageContent.tsx` | Content render + embeds |
|
||||
| `cinny/src/app/hooks/useVirtualPaginator.ts` | Timeline pagination |
|
||||
|
||||
## Data model
|
||||
|
||||
| Source | Data |
|
||||
|--------|------|
|
||||
| Matrix sync | `m.room.message`, edits, reactions, pins |
|
||||
| Room account data | drafts (`roomInputDrafts`) |
|
||||
| `im.paarrot.embed_filters` | Personal embed blocks |
|
||||
| `im.paarrot.room.embed_filters` | Room-wide embed blocks |
|
||||
| Source | Data |
|
||||
| ------------------------------- | ---------------------------------------- |
|
||||
| Matrix sync | `m.room.message`, edits, reactions, pins |
|
||||
| Room account data | drafts (`roomInputDrafts`) |
|
||||
| `im.paarrot.embed_filters` | Personal embed blocks |
|
||||
| `im.paarrot.room.embed_filters` | Room-wide embed blocks |
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
||||
@@ -24,26 +24,26 @@ Router.tsx — route tree + loaders/guards
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/pages/Router.tsx` | Full route tree |
|
||||
| `cinny/src/app/pages/paths.ts` | Path constants |
|
||||
| `cinny/src/app/pages/pathUtils.ts` | Path builder utilities |
|
||||
| `cinny/src/app/pages/App.tsx` | RouterProvider setup |
|
||||
| `cinny/src/app/pages/client/ClientLayout.tsx` | Authenticated layout shell |
|
||||
| `cinny/src/app/pages/client/SidebarNav.tsx` | Left sidebar tabs |
|
||||
| `cinny/src/app/pages/MobileFriendly.tsx` | Mobile nav adapters |
|
||||
| `cinny/src/app/hooks/useRoomNavigate.ts` | Imperative room navigation |
|
||||
| `cinny/src/app/hooks/useNavToActivePathMapper.ts` | Restore last path |
|
||||
| `cinny/src/app/pages/afterLoginRedirectPath.ts` | Login redirect |
|
||||
| `cinny/src/app/components/AnimatedOutlet.tsx` | Route transitions |
|
||||
| Path | Role |
|
||||
| ------------------------------------------------- | -------------------------- |
|
||||
| `cinny/src/app/pages/Router.tsx` | Full route tree |
|
||||
| `cinny/src/app/pages/paths.ts` | Path constants |
|
||||
| `cinny/src/app/pages/pathUtils.ts` | Path builder utilities |
|
||||
| `cinny/src/app/pages/App.tsx` | RouterProvider setup |
|
||||
| `cinny/src/app/pages/client/ClientLayout.tsx` | Authenticated layout shell |
|
||||
| `cinny/src/app/pages/client/SidebarNav.tsx` | Left sidebar tabs |
|
||||
| `cinny/src/app/pages/MobileFriendly.tsx` | Mobile nav adapters |
|
||||
| `cinny/src/app/hooks/useRoomNavigate.ts` | Imperative room navigation |
|
||||
| `cinny/src/app/hooks/useNavToActivePathMapper.ts` | Restore last path |
|
||||
| `cinny/src/app/pages/afterLoginRedirectPath.ts` | Login redirect |
|
||||
| `cinny/src/app/components/AnimatedOutlet.tsx` | Route transitions |
|
||||
|
||||
## Data model
|
||||
|
||||
| Key | Purpose |
|
||||
|-----|---------|
|
||||
| `navToActivePath` atom | Per-context last URL |
|
||||
| URL path params | roomId, spaceId, eventId |
|
||||
| Key | Purpose |
|
||||
| ---------------------- | ------------------------ |
|
||||
| `navToActivePath` atom | Per-context last URL |
|
||||
| URL path params | roomId, spaceId, eventId |
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
||||
@@ -21,13 +21,13 @@ spaceSettings.ts atom
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| Path | Role |
|
||||
| --------------------------------------------------------- | -------------- |
|
||||
| `cinny/src/app/features/space-settings/SpaceSettings.tsx` | Settings shell |
|
||||
| `cinny/src/app/features/space-settings/general/` | General tab |
|
||||
| `cinny/src/app/features/space-settings/permissions/` | Permissions |
|
||||
| `cinny/src/app/state/spaceSettings.ts` | Open state |
|
||||
| `cinny/src/app/state/hooks/spaceSettings.ts` | Hooks |
|
||||
| `cinny/src/app/features/space-settings/general/` | General tab |
|
||||
| `cinny/src/app/features/space-settings/permissions/` | Permissions |
|
||||
| `cinny/src/app/state/spaceSettings.ts` | Open state |
|
||||
| `cinny/src/app/state/hooks/spaceSettings.ts` | Hooks |
|
||||
|
||||
## Data model
|
||||
|
||||
|
||||
@@ -22,35 +22,35 @@ ClientBindAtoms.tsx binds Matrix events → atom updates
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/state/settings.ts` | User settings atom |
|
||||
| `cinny/src/app/state/sessions.ts` | Auth sessions |
|
||||
| `cinny/src/app/state/room-list/roomList.ts` | `allRoomsAtom`, ordering |
|
||||
| `cinny/src/app/state/room/roomToUnread.ts` | Unread counts |
|
||||
| `cinny/src/app/state/room/roomInputDrafts.ts` | Composer drafts + uploads |
|
||||
| `cinny/src/app/state/room/roomToParents.ts` | Space parent mapping |
|
||||
| `cinny/src/app/state/mDirectList.ts` | Direct message index |
|
||||
| `cinny/src/app/state/navToActivePath.ts` | Last active path per context |
|
||||
| `cinny/src/app/state/closedNavCategories.ts` | Collapsed nav sections |
|
||||
| `cinny/src/app/state/closedLobbyCategories.ts` | Collapsed lobby categories |
|
||||
| `cinny/src/app/state/createRoomModal.ts` | Create room modal state |
|
||||
| `cinny/src/app/state/createSpaceModal.ts` | Create space modal state |
|
||||
| `cinny/src/app/state/searchModal.ts` | Global search modal |
|
||||
| `cinny/src/app/state/utils/atomWithLocalStorage.ts` | Persistence helper |
|
||||
| `cinny/src/app/pages/client/ClientBindAtoms.ts` | Matrix → atom bindings |
|
||||
| Path | Role |
|
||||
| --------------------------------------------------- | ---------------------------- |
|
||||
| `cinny/src/app/state/settings.ts` | User settings atom |
|
||||
| `cinny/src/app/state/sessions.ts` | Auth sessions |
|
||||
| `cinny/src/app/state/room-list/roomList.ts` | `allRoomsAtom`, ordering |
|
||||
| `cinny/src/app/state/room/roomToUnread.ts` | Unread counts |
|
||||
| `cinny/src/app/state/room/roomInputDrafts.ts` | Composer drafts + uploads |
|
||||
| `cinny/src/app/state/room/roomToParents.ts` | Space parent mapping |
|
||||
| `cinny/src/app/state/mDirectList.ts` | Direct message index |
|
||||
| `cinny/src/app/state/navToActivePath.ts` | Last active path per context |
|
||||
| `cinny/src/app/state/closedNavCategories.ts` | Collapsed nav sections |
|
||||
| `cinny/src/app/state/closedLobbyCategories.ts` | Collapsed lobby categories |
|
||||
| `cinny/src/app/state/createRoomModal.ts` | Create room modal state |
|
||||
| `cinny/src/app/state/createSpaceModal.ts` | Create space modal state |
|
||||
| `cinny/src/app/state/searchModal.ts` | Global search modal |
|
||||
| `cinny/src/app/state/utils/atomWithLocalStorage.ts` | Persistence helper |
|
||||
| `cinny/src/app/pages/client/ClientBindAtoms.ts` | Matrix → atom bindings |
|
||||
|
||||
## Data model
|
||||
|
||||
Most state is **local only** (not Matrix). Exceptions: settings that also write account data (notification prefs via separate hooks).
|
||||
|
||||
| Atom area | Persists? |
|
||||
|-----------|-----------|
|
||||
| settings | localStorage |
|
||||
| room list order | localStorage |
|
||||
| drafts | localStorage |
|
||||
| unread | memory (derived from sync) |
|
||||
| modals | memory |
|
||||
| Atom area | Persists? |
|
||||
| --------------- | -------------------------- |
|
||||
| settings | localStorage |
|
||||
| room list order | localStorage |
|
||||
| drafts | localStorage |
|
||||
| unread | memory (derived from sync) |
|
||||
| modals | memory |
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
||||
@@ -21,15 +21,15 @@ Stream Deck button press
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `streamdeck-plugin/com.paarrot.streamdeck.sdPlugin/manifest.json` | Plugin manifest |
|
||||
| `streamdeck-plugin/com.paarrot.streamdeck.sdPlugin/plugin/index.js` | Action implementations |
|
||||
| `streamdeck-plugin/com.paarrot.streamdeck.sdPlugin/plugin/index.html` | Property inspector UI |
|
||||
| `streamdeck-plugin/build.js` | Build `.streamDeckPlugin` bundle |
|
||||
| `streamdeck-plugin/validate.js` | Manifest validation |
|
||||
| `streamdeck-plugin/README.md` | User install guide |
|
||||
| `streamdeck-plugin/QUICKSTART.md` | Dev quickstart |
|
||||
| Path | Role |
|
||||
| --------------------------------------------------------------------- | -------------------------------- |
|
||||
| `streamdeck-plugin/com.paarrot.streamdeck.sdPlugin/manifest.json` | Plugin manifest |
|
||||
| `streamdeck-plugin/com.paarrot.streamdeck.sdPlugin/plugin/index.js` | Action implementations |
|
||||
| `streamdeck-plugin/com.paarrot.streamdeck.sdPlugin/plugin/index.html` | Property inspector UI |
|
||||
| `streamdeck-plugin/build.js` | Build `.streamDeckPlugin` bundle |
|
||||
| `streamdeck-plugin/validate.js` | Manifest validation |
|
||||
| `streamdeck-plugin/README.md` | User install guide |
|
||||
| `streamdeck-plugin/QUICKSTART.md` | Dev quickstart |
|
||||
|
||||
## Data model
|
||||
|
||||
|
||||
@@ -25,21 +25,21 @@ Room state: im.paarrot.sub_rooms { children: string[] }
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/hooks/useRoomSubRooms.ts` | Hook + `PaarrotSubRoomsContent` type |
|
||||
| `cinny/src/types/matrix/room.ts` | `StateEvent.PaarrotSubRooms` |
|
||||
| `cinny/src/app/pages/client/home/Home.tsx` | Renders nested list |
|
||||
| `cinny/src/app/features/room-nav/RoomNavItem.tsx` | Add sub-room action |
|
||||
| `cinny/src/app/features/room-nav/UnjoinedSubRoomItem.tsx` | Unjoined child UI |
|
||||
| `cinny/src/app/features/room-settings/sub-rooms/SubRooms.tsx` | Settings page |
|
||||
| `cinny/src/app/features/create-room/CreateRoomModal.tsx` | Appends new room to parent state |
|
||||
| `cinny/src/app/features/lobby/SpaceHierarchy.tsx` | Lobby hierarchy integration |
|
||||
| Path | Role |
|
||||
| ------------------------------------------------------------- | ------------------------------------ |
|
||||
| `cinny/src/app/hooks/useRoomSubRooms.ts` | Hook + `PaarrotSubRoomsContent` type |
|
||||
| `cinny/src/types/matrix/room.ts` | `StateEvent.PaarrotSubRooms` |
|
||||
| `cinny/src/app/pages/client/home/Home.tsx` | Renders nested list |
|
||||
| `cinny/src/app/features/room-nav/RoomNavItem.tsx` | Add sub-room action |
|
||||
| `cinny/src/app/features/room-nav/UnjoinedSubRoomItem.tsx` | Unjoined child UI |
|
||||
| `cinny/src/app/features/room-settings/sub-rooms/SubRooms.tsx` | Settings page |
|
||||
| `cinny/src/app/features/create-room/CreateRoomModal.tsx` | Appends new room to parent state |
|
||||
| `cinny/src/app/features/lobby/SpaceHierarchy.tsx` | Lobby hierarchy integration |
|
||||
|
||||
## Data model
|
||||
|
||||
| Event | State key | Content |
|
||||
|-------|-----------|---------|
|
||||
| Event | State key | Content |
|
||||
| ---------------------- | ------------ | ---------------------------------------------------- |
|
||||
| `im.paarrot.sub_rooms` | `""` (empty) | `{ children: string[] }` — room IDs in display order |
|
||||
|
||||
Power levels: treat like other state events; editors need `state_default` or explicit level for `im.paarrot.sub_rooms`.
|
||||
|
||||
@@ -24,21 +24,21 @@ vanilla-extract / folds tokens in colors.css.ts
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/pages/ThemeManager.tsx` | Route-level theme |
|
||||
| `cinny/src/app/state/settings.ts` | Settings including theme |
|
||||
| `cinny/src/app/hooks/useTheme.ts` | Theme hook |
|
||||
| `cinny/src/colors.css.ts` | Color tokens |
|
||||
| `cinny/src/app/pages/client/ClientNonUIFeatures.tsx` | Page zoom CSS |
|
||||
| `cinny/src/app/hooks/useViewTransitions.ts` | View transitions |
|
||||
| `cinny/src/app/hooks/useMessageSpacing.ts` | Message density |
|
||||
| `cinny/public/themes/` | Bundled theme files (if present) |
|
||||
| Path | Role |
|
||||
| ---------------------------------------------------- | -------------------------------- |
|
||||
| `cinny/src/app/pages/ThemeManager.tsx` | Route-level theme |
|
||||
| `cinny/src/app/state/settings.ts` | Settings including theme |
|
||||
| `cinny/src/app/hooks/useTheme.ts` | Theme hook |
|
||||
| `cinny/src/colors.css.ts` | Color tokens |
|
||||
| `cinny/src/app/pages/client/ClientNonUIFeatures.tsx` | Page zoom CSS |
|
||||
| `cinny/src/app/hooks/useViewTransitions.ts` | View transitions |
|
||||
| `cinny/src/app/hooks/useMessageSpacing.ts` | Message density |
|
||||
| `cinny/public/themes/` | Bundled theme files (if present) |
|
||||
|
||||
## Data model
|
||||
|
||||
| Key | Storage |
|
||||
|-----|---------|
|
||||
| Key | Storage |
|
||||
| -------------- | ------------------------------------------- |
|
||||
| `settingsAtom` | theme, pageZoom, messageSpacing, emojiStyle |
|
||||
|
||||
## Dependencies
|
||||
|
||||
@@ -24,25 +24,25 @@ SettingsPages enum
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/features/settings/Settings.tsx` | Settings modal shell |
|
||||
| `cinny/src/app/features/settings/general/General.tsx` | General prefs |
|
||||
| Path | Role |
|
||||
| ----------------------------------------------------- | ------------------------- |
|
||||
| `cinny/src/app/features/settings/Settings.tsx` | Settings modal shell |
|
||||
| `cinny/src/app/features/settings/general/General.tsx` | General prefs |
|
||||
| `cinny/src/app/features/settings/account/Profile.tsx` | Profile + avatar metadata |
|
||||
| `cinny/src/app/features/settings/notifications/` | Notification rules |
|
||||
| `cinny/src/app/features/settings/audio/Audio.tsx` | Call audio devices |
|
||||
| `cinny/src/app/features/settings/devices/` | Sessions & verification |
|
||||
| `cinny/src/app/features/settings/about/About.tsx` | About page |
|
||||
| `cinny/src/app/state/settings.ts` | Settings atom |
|
||||
| `cinny/src/app/pages/client/sidebar/SettingsTab.tsx` | Entry point |
|
||||
| `cinny/src/app/features/settings/notifications/` | Notification rules |
|
||||
| `cinny/src/app/features/settings/audio/Audio.tsx` | Call audio devices |
|
||||
| `cinny/src/app/features/settings/devices/` | Sessions & verification |
|
||||
| `cinny/src/app/features/settings/about/About.tsx` | About page |
|
||||
| `cinny/src/app/state/settings.ts` | Settings atom |
|
||||
| `cinny/src/app/pages/client/sidebar/SettingsTab.tsx` | Entry point |
|
||||
|
||||
## Data model
|
||||
|
||||
| Key | Storage |
|
||||
|-----|---------|
|
||||
| Key | Storage |
|
||||
| -------------- | --------------------------------------------- |
|
||||
| `settingsAtom` | localStorage (theme, zoom, emoji style, etc.) |
|
||||
| Profile | Matrix account data + avatar MXC |
|
||||
| Push rules | Homeserver account data |
|
||||
| Profile | Matrix account data + avatar MXC |
|
||||
| Push rules | Homeserver account data |
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
||||
@@ -23,26 +23,26 @@ useCallService (CallProvider)
|
||||
|
||||
## Key files
|
||||
|
||||
| Path | Role |
|
||||
|------|------|
|
||||
| `cinny/src/app/features/call/useCall.ts` | React context, global CallService ref |
|
||||
| `cinny/src/app/features/call/CallService.ts` | Core call logic |
|
||||
| `cinny/src/app/features/call/types.ts` | CallState, ActiveCall, events |
|
||||
| `cinny/src/app/features/call/useRtcConfig.ts` | Homeserver RTC / LiveKit discovery |
|
||||
| `cinny/src/app/features/call/CallOverlay.tsx` | Full-screen call UI |
|
||||
| `cinny/src/app/features/call/DockedCallPanel.tsx` | Docked UI |
|
||||
| `cinny/src/app/features/call/SidebarDockedCallPanel.tsx` | Sidebar variant |
|
||||
| `cinny/src/app/features/call/useRemoteCursor.ts` | Screen-share cursor sync |
|
||||
| `cinny/src/app/features/call/CallSounds.ts` | Join/leave sounds |
|
||||
| `cinny/src/app/features/room-nav/CallParticipantsIndicator.tsx` | Nav badge |
|
||||
| `cinny/src/types/matrix/room.ts` | `StateEvent.CallMember` |
|
||||
| Path | Role |
|
||||
| --------------------------------------------------------------- | ------------------------------------- |
|
||||
| `cinny/src/app/features/call/useCall.ts` | React context, global CallService ref |
|
||||
| `cinny/src/app/features/call/CallService.ts` | Core call logic |
|
||||
| `cinny/src/app/features/call/types.ts` | CallState, ActiveCall, events |
|
||||
| `cinny/src/app/features/call/useRtcConfig.ts` | Homeserver RTC / LiveKit discovery |
|
||||
| `cinny/src/app/features/call/CallOverlay.tsx` | Full-screen call UI |
|
||||
| `cinny/src/app/features/call/DockedCallPanel.tsx` | Docked UI |
|
||||
| `cinny/src/app/features/call/SidebarDockedCallPanel.tsx` | Sidebar variant |
|
||||
| `cinny/src/app/features/call/useRemoteCursor.ts` | Screen-share cursor sync |
|
||||
| `cinny/src/app/features/call/CallSounds.ts` | Join/leave sounds |
|
||||
| `cinny/src/app/features/room-nav/CallParticipantsIndicator.tsx` | Nav badge |
|
||||
| `cinny/src/types/matrix/room.ts` | `StateEvent.CallMember` |
|
||||
|
||||
## Data model
|
||||
|
||||
| Key | Scope | Notes |
|
||||
|-----|-------|-------|
|
||||
| `org.matrix.msc3401.call.member` | Room state | Call membership |
|
||||
| LiveKit JWT / room | Ephemeral | From homeserver RTC focus |
|
||||
| Key | Scope | Notes |
|
||||
| -------------------------------- | ---------- | ------------------------- |
|
||||
| `org.matrix.msc3401.call.member` | Room state | Call membership |
|
||||
| LiveKit JWT / room | Ephemeral | From homeserver RTC focus |
|
||||
|
||||
Call mute/deafen/video state lives in `CallService` memory, not Matrix account data.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user