7 Commits
Author SHA1 Message Date
litruv bb27305b70 Add a developer tools view for public profile fields.
Trigger cinny-mobile / dispatch (push) Successful in 1s
2026-11-01 02:03:29 +11:00
litruv fcbd9b4b66 Remove the unused joinNames helper from the typing indicator. 2026-11-01 02:03:23 +11:00
litruv 14f31f57c1 Add a per-user custom typing verb to the typing indicator.
The verb is a profile field (im.paarrot.typing_verb) read through the shared profile cache. The sentence builder replaces the four hardcoded branches, and the profile settings page has presets, a text input, and a live preview.
2026-11-01 01:24:59 +11:00
litruv b294bb0c06 Revert reporting the activity bar against the message in the viewport.
Trigger cinny-mobile / dispatch (push) Successful in 1s
The activity bar shows readers of the latest rendered event again. The scroll listener and the extra prop are gone.
2026-10-31 23:51:34 +11:00
litruv a6fac786b3 Fetch the TikTok oEmbed through the main process in Electron and drop the thumbnail crossOrigin.
Trigger cinny-mobile / dispatch (push) Successful in 1s
2026-10-15 23:12:55 +11:00
litruv a4e96dd01f Remove the Paarrot delivery receipt.
Trigger cinny-mobile / dispatch (push) Successful in 2s
Delivery markers (com.paarrot.received) are no longer sent or rendered; the activity bar shows only read receipts. Markers already sent to servers remain there.
2026-10-13 19:04:54 +11:00
litruv f0495cccca Report the activity bar against the message in the viewport.
Trigger cinny-mobile / dispatch (push) Successful in 1s
2026-10-13 14:34:25 +11:00
12 changed files with 591 additions and 187 deletions
+12 -11
View File
@@ -62,11 +62,17 @@ async function fetchTikTokOEmbed(url: string): Promise<{
videoId: string | null;
} | null> {
try {
const oembedUrl = `${TIKTOK_OEMBED_API}?url=${encodeURIComponent(url)}`;
const response = await fetch(oembedUrl);
if (!response.ok) return null;
const data = await response.json();
const electron = (window as any).electron;
let data;
if (electron?.tiktok?.getOEmbed) {
data = await electron.tiktok.getOEmbed(url);
} else {
const oembedUrl = `${TIKTOK_OEMBED_API}?url=${encodeURIComponent(url)}`;
const response = await fetch(oembedUrl);
if (!response.ok) return null;
data = await response.json();
}
if (!data) return null;
return {
title: data.title || 'TikTok Video',
@@ -224,12 +230,7 @@ export const TikTokEmbed = as<'div', TikTokEmbedProps>(({ url, ...props }, ref)
aria-label="Play TikTok video"
>
{state.thumbnailUrl ? (
<img
src={state.thumbnailUrl}
alt={state.title}
className={css.TikTokThumbnail}
crossOrigin="anonymous"
/>
<img src={state.thumbnailUrl} alt={state.title} className={css.TikTokThumbnail} />
) : null}
</button>
</Box>
+6 -17
View File
@@ -11,7 +11,6 @@ import * as css from './RoomViewFollowing.css';
import { useMatrixClient } from '../../hooks/useMatrixClient';
import { useRoomLatestRenderedEvent } from '../../hooks/useRoomLatestRenderedEvent';
import { useRoomEventReaders } from '../../hooks/useRoomEventReaders';
import { useRoomEventDelivery } from '../../hooks/useRoomEventDelivery';
import { EventReaders } from '../../components/event-readers';
import { stopPropagation } from '../../utils/keyboard';
@@ -30,18 +29,12 @@ export const RoomViewFollowing = as<'div', RoomViewFollowingProps>(
const latestEvent = useRoomLatestRenderedEvent(room);
const eventId = latestEvent?.getId();
const latestEventReaders = useRoomEventReaders(room, eventId);
const received = useRoomEventDelivery(room, eventId, myUserId);
// Received but not read shows a single tick, read shows the double tick.
const receivedOnly = received && !latestEventReaders.includes(myUserId);
const getName = (userId: string) =>
getMemberDisplayName(room, userId) ?? getMxIdLocalPart(userId) ?? userId;
const names = [
...(receivedOnly && myUserId ? [myUserId] : []),
...latestEventReaders.filter((readerId) => readerId !== myUserId),
].map(getName);
const names = latestEventReaders
.filter((readerId) => readerId !== myUserId)
.map(
(readerId) => getMemberDisplayName(room, readerId) ?? getMxIdLocalPart(readerId) ?? readerId
);
if (names.length === 0) {
return null;
@@ -77,11 +70,7 @@ export const RoomViewFollowing = as<'div', RoomViewFollowingProps>(
{...props}
ref={ref}
>
<Icon
style={{ opacity: config.opacity.P300 }}
size="100"
src={receivedOnly ? Icons.Check : Icons.CheckTwice}
/>
<Icon style={{ opacity: config.opacity.P300 }} size="100" src={Icons.CheckTwice} />
<Text size="T300" truncate>
{names.length === 1 && <b>{names[0]}</b>}
{names.length === 2 && (
+40 -61
View File
@@ -11,6 +11,9 @@ import { getMxIdLocalPart } from '../../utils/matrix';
import * as css from './RoomViewTyping.css';
import { useMatrixClient } from '../../hooks/useMatrixClient';
import { useRoomTypingMember } from '../../hooks/useRoomTypingMembers';
import { useTypingVerbs } from '../../hooks/useUserTypingVerb';
const DEFAULT_VERB = 'typing';
export type RoomViewTypingProps = {
room: Room;
@@ -21,17 +24,40 @@ export const RoomViewTyping = as<'div', RoomViewTypingProps>(
const mx = useMatrixClient();
const typingMembers = useRoomTypingMember(room.roomId);
const typingNames = typingMembers
const typers = typingMembers
.filter((receipt) => receipt.userId !== mx.getUserId())
.map(
(receipt) => getMemberDisplayName(room, receipt.userId) ?? getMxIdLocalPart(receipt.userId)
)
.map((receipt) => ({
userId: receipt.userId,
name: getMemberDisplayName(room, receipt.userId) ?? getMxIdLocalPart(receipt.userId),
}))
.reverse();
if (typingNames.length === 0) {
const verbs = useTypingVerbs(typers.map((typer) => typer.userId));
if (typers.length === 0) {
return null;
}
const entries = typers.slice(0, 3).map((typer) => ({
name: typer.name,
verb: verbs[typer.userId],
plural: false,
}));
if (typers.length > 3) {
entries.push({ name: `${typers.length - 3} others`, verb: undefined, plural: true });
}
// One verb for everyone keeps the joined form; mixed verbs need a clause per person
const firstVerb = verbs[typers[0].userId];
const sameVerb = typers.every((typer) => verbs[typer.userId] === firstVerb);
const clauses = entries.map((entry) => ({
name: entry.name,
suffix: `${entry.plural ? 'are' : 'is'} ${entry.verb ?? DEFAULT_VERB}`,
}));
const sharedSuffix = sameVerb
? ` ${entries.length > 1 ? 'are' : 'is'} ${firstVerb ?? DEFAULT_VERB}`
: undefined;
const handleDropAll = () => {
// some homeserver does not timeout typing status
// we have given option so user can drop their typing status
@@ -54,62 +80,15 @@ export const RoomViewTyping = as<'div', RoomViewTypingProps>(
>
<TypingIndicator />
<Text className={css.TypingText} size="T300" truncate>
{typingNames.length === 1 && (
<>
<b>{typingNames[0]}</b>
<Text as="span" size="Inherit" priority="300">
{' is typing...'}
</Text>
</>
)}
{typingNames.length === 2 && (
<>
<b>{typingNames[0]}</b>
<Text as="span" size="Inherit" priority="300">
{' and '}
</Text>
<b>{typingNames[1]}</b>
<Text as="span" size="Inherit" priority="300">
{' are typing...'}
</Text>
</>
)}
{typingNames.length === 3 && (
<>
<b>{typingNames[0]}</b>
<Text as="span" size="Inherit" priority="300">
{', '}
</Text>
<b>{typingNames[1]}</b>
<Text as="span" size="Inherit" priority="300">
{' and '}
</Text>
<b>{typingNames[2]}</b>
<Text as="span" size="Inherit" priority="300">
{' are typing...'}
</Text>
</>
)}
{typingNames.length > 3 && (
<>
<b>{typingNames[0]}</b>
<Text as="span" size="Inherit" priority="300">
{', '}
</Text>
<b>{typingNames[1]}</b>
<Text as="span" size="Inherit" priority="300">
{', '}
</Text>
<b>{typingNames[2]}</b>
<Text as="span" size="Inherit" priority="300">
{' and '}
</Text>
<b>{typingNames.length - 3} others</b>
<Text as="span" size="Inherit" priority="300">
{' are typing...'}
</Text>
</>
)}
{clauses.map((clause, index) => (
<React.Fragment key={index}>
{index > 0 && (index === clauses.length - 1 ? ' and ' : ', ')}
<b>{clause.name}</b>
{!sharedSuffix && ` ${clause.suffix}`}
</React.Fragment>
))}
{sharedSuffix}
{'...'}
</Text>
<IconButton title="Drop Typing Status" size="300" radii="Pill" onClick={handleDropAll}>
<Icon size="50" src={Icons.Cross} />
@@ -41,10 +41,14 @@ import { CollectiblesSection } from './CollectiblesSection';
import { useUserCollectibles } from '../../../hooks/useUserCollectibles';
import { pickAvatarDecorationUrl } from '../../../utils/collectibleAssets';
import * as avatarDecorationCss from '../../../styles/AvatarDecoration.css';
import { useUserTypingVerb } from '../../../hooks/useUserTypingVerb';
import { TypingIndicator } from '../../../components/typing-indicator';
import {
ColorPreference,
hasColorPreference,
parseTypingVerb,
resolveColorForTheme,
TYPING_VERB_PRESETS,
} from '../../../utils/profileFields';
/**
@@ -142,6 +146,44 @@ function ProfileBanner({ avatarRef, nameRef }: { avatarRef: React.RefObject<HTML
setSavingColor(false);
};
const [typingVerb, setTypingVerb, typingVerbLoading] = useUserTypingVerb();
const [localVerb, setLocalVerb] = useState('');
const [savingVerb, setSavingVerb] = useState(false);
const [verbError, setVerbError] = useState<string>();
useEffect(() => {
setLocalVerb(typingVerb ?? '');
}, [typingVerb]);
const handleVerbSave = async () => {
const parsed = parseTypingVerb(localVerb);
if (!parsed) {
setVerbError('Use letters, numbers and single spaces only.');
return;
}
setSavingVerb(true);
setVerbError(undefined);
try {
await setTypingVerb(parsed);
} catch (e) {
setVerbError('Failed to save typing verb. Server may not support profile fields (MSC4133).');
}
setSavingVerb(false);
};
const handleVerbRemove = async () => {
setSavingVerb(true);
setVerbError(undefined);
try {
await setTypingVerb(undefined);
setLocalVerb('');
} catch (e) {
setVerbError('Failed to remove typing verb');
}
setSavingVerb(false);
};
const [isEditingName, setIsEditingName] = useState(false);
const [editedName, setEditedName] = useState(profile.displayName || '');
const [savingName, setSavingName] = useState(false);
@@ -1024,6 +1066,101 @@ function ProfileBanner({ avatarRef, nameRef }: { avatarRef: React.RefObject<HTML
)}
</Box>
{/* Paarrot custom typing verb */}
<Box
direction="Column"
gap="300"
style={{
padding: config.space.S400,
border: `${toRem(1)} solid ${color.Surface.ContainerLine}`,
borderRadius: toRem(8),
width: '100%',
boxSizing: 'border-box',
}}
>
<Text size="H6">Typing verb</Text>
<Box gap="200" wrap="Wrap" alignItems="Center">
{TYPING_VERB_PRESETS.map((preset) => (
<Box
key={preset}
as="button"
onClick={() => {
setLocalVerb(preset);
setVerbError(undefined);
}}
style={{
backgroundColor: color.Surface.Container,
border: `${toRem(1)} solid ${color.Surface.ContainerLine}`,
padding: `${toRem(4)} ${toRem(8)}`,
borderRadius: toRem(16),
cursor: 'pointer',
}}
>
<Text size="B300">{preset}</Text>
</Box>
))}
</Box>
<Input
size="300"
variant="Secondary"
style={{ width: '100%' }}
value={localVerb}
onChange={(e) => {
setLocalVerb(e.target.value);
setVerbError(undefined);
}}
placeholder="Custom typing verb..."
maxLength={48}
/>
<Box gap="200" alignItems="Center">
<Avatar size="300">
<UserAvatar
userId={userId}
src={avatarUrl}
alt={userId}
renderFallback={() => <Icon size="200" src={Icons.User} filled />}
/>
</Avatar>
<TypingIndicator />
<Text size="T300">
<b>{profile.displayName || getMxIdLocalPart(userId)}</b>
{` is ${parseTypingVerb(localVerb) ?? 'typing'}...`}
</Text>
</Box>
<Box gap="200" alignItems="Center" wrap="Wrap">
<Button
size="300"
variant="Primary"
fill="Solid"
radii="300"
onClick={handleVerbSave}
disabled={savingVerb || typingVerbLoading}
>
<Text size="B300">{savingVerb ? 'Saving...' : 'Save verb'}</Text>
</Button>
{typingVerb && (
<Button
size="300"
variant="Critical"
fill="Soft"
radii="300"
onClick={handleVerbRemove}
disabled={savingVerb}
>
<Text size="B300">Remove verb</Text>
</Button>
)}
</Box>
{verbError && (
<Text size="T200" style={{ color: color.Critical.Main }}>{verbError}</Text>
)}
</Box>
<Box
direction="Column"
gap="300"
@@ -1,5 +1,6 @@
import React, { useCallback, useState } from 'react';
import { Box, Text, IconButton, Scroll, Switch, Button } from 'folds';
import { Box, Text, IconButton, Scroll, Switch, Button, Modal, Overlay, OverlayBackdrop, OverlayCenter } from 'folds';
import FocusTrap from 'focus-trap-react';
import { Icon, Icons } from '../../../components/icons';
import { Page, PageContent, PageHeader } from '../../../components/page';
import { SequenceCard } from '../../../components/sequence-card';
@@ -12,8 +13,12 @@ import {
AccountDataEditor,
AccountDataSubmitCallback,
} from '../../../components/AccountDataEditor';
import { TextViewer } from '../../../components/text-viewer';
import { copyToClipboard } from '../../../utils/dom';
import { stopPropagation } from '../../../utils/keyboard';
import { clearProfileCache } from '../../../utils/profileCache';
import { AccountData } from './AccountData';
import { ProfileFields } from './ProfileFields';
type DeveloperToolsProps = {
requestClose: () => void;
@@ -23,6 +28,67 @@ export function DeveloperTools({ requestClose }: DeveloperToolsProps) {
const [developerTools, setDeveloperTools] = useSetting(settingsAtom, 'developerTools');
const [expand, setExpend] = useState(false);
const [accountDataType, setAccountDataType] = useState<string | null>();
const [profileExpand, setProfileExpand] = useState(false);
const [profileUserId, setProfileUserId] = useState(mx.getUserId() ?? '');
const [profileFields, setProfileFields] = useState<Record<string, unknown>>({});
const [profileSupported, setProfileSupported] = useState(false);
const [profileFieldKey, setProfileFieldKey] = useState<string | null>();
const profileEditable = profileSupported && profileUserId.trim() === mx.getUserId();
const fetchProfileFields = useCallback(async (userId: string) => {
if (!userId) return;
try {
const supported = await mx.doesServerSupportExtendedProfiles();
setProfileSupported(supported);
setProfileFields(
supported
? await mx.getExtendedProfile(userId)
: ((await mx.getProfileInfo(userId)) as Record<string, unknown>),
);
} catch (err) {
console.error('Failed to fetch profile fields:', err);
setProfileSupported(false);
setProfileFields({});
}
}, [mx]);
const submitProfileField: AccountDataSubmitCallback = useCallback(
async (key, content) => {
await mx.setExtendedProfileProperty(key, content);
setProfileFields((prev) => ({ ...prev, [key]: content }));
// The rest of the client reads through the shared profile cache
clearProfileCache(profileUserId.trim());
},
[mx, profileUserId]
);
const deleteProfileField = useCallback(
async (key: string) => {
try {
await mx.deleteExtendedProfileProperty(key);
setProfileFields((prev) => {
const next = { ...prev };
delete next[key];
return next;
});
// The rest of the client reads through the shared profile cache
clearProfileCache(profileUserId.trim());
} catch (err) {
console.error('Failed to delete profile field:', err);
}
},
[mx, profileUserId]
);
const handleProfileExpand = useCallback(
(expand: boolean) => {
setProfileExpand(expand);
if (expand) fetchProfileFields(profileUserId.trim());
},
[fetchProfileFields, profileUserId]
);
const submitAccountData: AccountDataSubmitCallback = useCallback(
async (type, content) => {
@@ -42,6 +108,8 @@ export function DeveloperTools({ requestClose }: DeveloperToolsProps) {
);
}
const closeProfileField = useCallback(() => setProfileFieldKey(undefined), []);
return (
<Page>
<PageHeader outlined={false}>
@@ -109,6 +177,18 @@ export function DeveloperTools({ requestClose }: DeveloperToolsProps) {
</SequenceCard>
)}
</Box>
{developerTools && (
<ProfileFields
userId={profileUserId}
fields={profileFields}
editable={profileEditable}
expand={profileExpand}
onUserIdChange={setProfileUserId}
onExpandToggle={handleProfileExpand}
onSelect={setProfileFieldKey}
onDelete={deleteProfileField}
/>
)}
{developerTools && (
<AccountData
expand={expand}
@@ -120,6 +200,38 @@ export function DeveloperTools({ requestClose }: DeveloperToolsProps) {
</PageContent>
</Scroll>
</Box>
{profileFieldKey !== undefined && (
<Overlay open backdrop={<OverlayBackdrop />}>
<OverlayCenter>
<FocusTrap
focusTrapOptions={{
initialFocus: false,
clickOutsideDeactivates: true,
onDeactivate: closeProfileField,
escapeDeactivates: stopPropagation,
}}
>
<Modal size="500" variant="Surface">
{profileEditable ? (
<AccountDataEditor
type={profileFieldKey}
content={profileFields[profileFieldKey] as object}
submitChange={submitProfileField}
requestClose={closeProfileField}
/>
) : (
<TextViewer
name={profileFieldKey}
text={JSON.stringify(profileFields[profileFieldKey], null, 2)}
langName="json"
requestClose={closeProfileField}
/>
)}
</Modal>
</FocusTrap>
</OverlayCenter>
</Overlay>
)}
</Page>
);
}
@@ -0,0 +1,109 @@
import { Box, Text, Button, Input, MenuItem, IconButton } from 'folds';
import { Icon, Icons } from '../../../components/icons';
import { SequenceCard } from '../../../components/sequence-card';
import { SequenceCardStyle } from '../styles.css';
import { SettingTile } from '../../../components/setting-tile';
import { CutoutCard } from '../../../components/cutout-card';
type ProfileFieldsProps = {
userId: string;
fields: Record<string, unknown>;
editable: boolean;
expand: boolean;
onUserIdChange: (userId: string) => void;
onExpandToggle: (expand: boolean) => void;
onSelect: (key: string) => void;
onDelete: (key: string) => void;
};
export function ProfileFields({
userId,
fields,
editable,
expand,
onUserIdChange,
onExpandToggle,
onSelect,
onDelete,
}: ProfileFieldsProps) {
return (
<Box direction="Column" gap="100">
<Text size="L400">Public Profile Fields</Text>
<SequenceCard
className={SequenceCardStyle}
variant="SurfaceVariant"
direction="Column"
gap="400"
>
<SettingTile
title="Public Profile Fields"
description="Extended profile fields (MSC4133) as the server returns them, not through the client profile cache. Editable only when the user is you and the server supports MSC4133."
after={
<Button
onClick={() => onExpandToggle(!expand)}
variant="Secondary"
fill="Soft"
size="300"
radii="300"
outlined
before={
<Icon src={expand ? Icons.ChevronTop : Icons.ChevronBottom} size="100" filled />
}
>
<Text size="B300">{expand ? 'Collapse' : 'Expand'}</Text>
</Button>
}
/>
<Input
size="300"
variant="Secondary"
style={{ width: '100%' }}
value={userId}
onChange={(e) => onUserIdChange(e.target.value)}
placeholder="@user:server"
/>
{expand && (
<Box direction="Column" gap="100">
<Box justifyContent="SpaceBetween">
<Text size="L400">Fields</Text>
<Text size="L400">Total: {Object.keys(fields).length}</Text>
</Box>
<CutoutCard>
{Object.keys(fields).sort().map((key) => (
<MenuItem
key={key}
variant="Surface"
fill="None"
size="300"
radii="0"
after={
<Box gap="100" alignItems="Center">
{editable && (
<IconButton
size="200"
radii="Round"
title={`Delete ${key}`}
onClick={() => onDelete(key)}
>
<Icon size="50" src={Icons.Cross} />
</IconButton>
)}
<Icon size="50" src={Icons.ChevronRight} />
</Box>
}
onClick={() => onSelect(key)}
>
<Box grow="Yes">
<Text size="T200" truncate>
{key}
</Text>
</Box>
</MenuItem>
))}
</CutoutCard>
</Box>
)}
</SequenceCard>
</Box>
);
}
@@ -126,6 +126,11 @@ export const SETTINGS_SEARCH_CATALOG: SettingsSearchEntry[] = [
},
{ page: SettingsPages.DeveloperToolsPage, title: 'Access Token', keywords: ['auth', 'secret'] },
{ page: SettingsPages.DeveloperToolsPage, title: 'Account Data', keywords: ['global', 'events'] },
{
page: SettingsPages.DeveloperToolsPage,
title: 'Public Profile Fields',
keywords: ['profile', 'msc4133', 'json'],
},
// About
{ page: SettingsPages.AboutPage, title: 'Clear Cache & Reload', keywords: ['reset', 'storage'] },
-35
View File
@@ -1,35 +0,0 @@
import { useEffect, useState } from 'react';
import { MatrixEvent, Room, RoomEvent } from 'matrix-js-sdk';
import { PAARROT_RECEIVED_EVENT, hasReceivedMarker } from '../utils/paarrotDelivery';
/**
* Whether `userId` has recorded a delivery marker for `eventId` - received, but
* not necessarily read. Read state still comes from the read receipt.
*/
export const useRoomEventDelivery = (room: Room, eventId?: string, userId?: string): boolean => {
const [received, setReceived] = useState(() =>
eventId && userId ? hasReceivedMarker(room, eventId, userId) : false,
);
useEffect(() => {
setReceived(eventId && userId ? hasReceivedMarker(room, eventId, userId) : false);
if (!eventId || !userId) return;
const update = () => setReceived(hasReceivedMarker(room, eventId, userId));
const handleTimeline = (event: MatrixEvent, r: Room) => {
if (r.roomId !== room.roomId) return;
if (event.getRelation()?.event_id !== eventId) return;
if (event.getType() !== PAARROT_RECEIVED_EVENT && !event.isRedaction()) return;
update();
};
room.on(RoomEvent.Timeline, handleTimeline);
return () => {
room.removeListener(RoomEvent.Timeline, handleTimeline);
};
}, [room, eventId, userId]);
return received;
};
+114
View File
@@ -0,0 +1,114 @@
import { useCallback, useEffect, useState } from 'react';
import { useMatrixClient } from './useMatrixClient';
import {
PROFILE_KEY_TYPING_VERB,
deleteTypingVerb,
parseTypingVerb,
saveTypingVerb,
} from '../utils/profileFields';
import {
getCachedProfileFields,
getProfileFields,
registerProfileCacheListener,
} from '../utils/profileCache';
/**
* Hook to manage the user's custom typing verb on their global profile.
*/
export function useUserTypingVerb(): [
string | undefined,
(verb: string | undefined) => Promise<void>,
boolean
] {
const mx = useMatrixClient();
const [verb, setVerb] = useState<string | undefined>();
const [loading, setLoading] = useState(true);
useEffect(() => {
const userId = mx.getUserId();
if (!userId) {
setLoading(false);
return undefined;
}
let cancelled = false;
const load = async () => {
setLoading(true);
try {
const fields = await getProfileFields(mx, userId);
const loaded = parseTypingVerb(fields[PROFILE_KEY_TYPING_VERB]);
if (!cancelled) setVerb(loaded);
} catch (e) {
console.error('Failed to load typing verb:', e);
if (!cancelled) setVerb(undefined);
}
if (!cancelled) setLoading(false);
};
load();
return () => {
cancelled = true;
};
}, [mx]);
const updateVerb = useCallback(
async (newVerb: string | undefined) => {
const parsed = parseTypingVerb(newVerb);
if (!parsed) {
await deleteTypingVerb(mx);
setVerb(undefined);
return;
}
await saveTypingVerb(mx, parsed);
setVerb(parsed);
},
[mx]
);
return [verb, updateVerb, loading];
}
/** Typing verb for a user already in the shared profile cache. */
export function getCachedTypingVerb(userId: string): string | undefined {
const fields = getCachedProfileFields(userId);
return fields ? parseTypingVerb(fields[PROFILE_KEY_TYPING_VERB]) : undefined;
}
/**
* Typing verbs for a group of users. Hooks cannot be called per typing user, so this
* reads the shared profile cache and re-renders when a cache entry arrives. Only cache
* misses are fetched.
*/
export function useTypingVerbs(userIds: string[]): Record<string, string | undefined> {
const mx = useMatrixClient();
const [, setTick] = useState(0);
const key = userIds.join(',');
useEffect(() => {
if (!key) return undefined;
let cancelled = false;
const unsubscribe = registerProfileCacheListener(() => setTick((tick) => tick + 1));
for (const userId of key.split(',')) {
if (getCachedProfileFields(userId)) continue;
// setProfileCache does not notify listeners, so a fresh fetch has to re-render here
getProfileFields(mx, userId)
.then(() => {
if (!cancelled) setTick((tick) => tick + 1);
})
.catch(() => undefined);
}
return () => {
cancelled = true;
unsubscribe();
};
}, [mx, key]);
const verbs: Record<string, string | undefined> = {};
for (const userId of userIds) verbs[userId] = getCachedTypingVerb(userId);
return verbs;
}
@@ -22,7 +22,6 @@ import {
getOrphanParents,
guessPerfectParent,
} from '../../utils/room';
import { sendReceivedMarker } from '../../utils/paarrotDelivery';
import { NotificationType, UnreadInfo } from '../../../types/matrix/room';
import { getMxIdLocalPart, mxcUrlToHttp, getCanonicalAliasOrRoomId } from '../../utils/matrix';
import { mDirectAtom } from '../../state/mDirectList';
@@ -388,14 +387,6 @@ function MessageNotifications() {
(notificationType === NotificationType.Default && !isDm);
if (mentionsOnly && unreadInfo.highlight === 0) return;
// Record that Paarrot received this message. This is the single tick; the
// read receipt below is what turns it into the double tick.
if (showNotifications) {
sendReceivedMarker(mx, room, eventId).catch((error) => {
console.error('[PaarrotDelivery] Failed to send delivery marker:', error);
});
}
if (
showNotifications &&
((isTauri() && !isElectron()) || isCapacitorNative() || notificationPermission('granted'))
-53
View File
@@ -1,53 +0,0 @@
import { MatrixClient, RelationType, Room } from 'matrix-js-sdk';
/**
* Client-defined event marking that Paarrot has received a message.
*
* The spec has no delivery receipt type - Synapse only accepts `m.read`,
* `m.read.private` and `m.fully_read` on the receipts endpoint - so delivery is
* recorded as a custom event related to the target message with `m.reference`.
*
* It never shows in the cinny timeline (events with a relation are skipped
* unless "show hidden events" is on), and other clients only see an unknown
* event. Delivery is always self-reported: in E2EE, only the receiving client
* can know it actually got the event.
*/
export const PAARROT_RECEIVED_EVENT = 'com.paarrot.received';
export const getReceivedContent = (eventId: string) => ({
'm.relates_to': {
event_id: eventId,
rel_type: RelationType.Reference,
},
});
export const getEventDeliveryRelations = (room: Room, eventId: string) =>
room
.getUnfilteredTimelineSet()
.relations.getChildEventsForEvent(eventId, RelationType.Reference, PAARROT_RECEIVED_EVENT);
export const hasReceivedMarker = (room: Room, eventId: string, userId: string): boolean => {
const relations = getEventDeliveryRelations(room, eventId);
if (!relations) return false;
return relations
.getRelations()
.some(
(rel) =>
!rel.isRedacted() && rel.getSender() === userId && rel.getRelation()?.event_id === eventId,
);
};
/**
* Sends the delivery marker for `eventId`. Skips events that are still local
* echoes (no `$` id yet) and events this user already marked, so a room that
* re-syncs does not spam markers.
*/
export async function sendReceivedMarker(mx: MatrixClient, room: Room, eventId: string) {
const userId = mx.getUserId();
if (!userId || !eventId.startsWith('$')) return false;
if (hasReceivedMarker(room, eventId, userId)) return false;
await mx.sendEvent(room.roomId, PAARROT_RECEIVED_EVENT, getReceivedContent(eventId));
return true;
}
+55
View File
@@ -23,6 +23,38 @@ export const PROFILE_KEY_NAMEPLATE = 'im.paarrot.nameplate';
/** Paarrot avatar decoration (avatar frame) */
export const PROFILE_KEY_AVATAR_DECORATION = 'im.paarrot.avatar_decoration';
/** Paarrot custom typing verb (shown in the typing indicator) */
export const PROFILE_KEY_TYPING_VERB = 'im.paarrot.typing_verb';
export const TYPING_VERB_PRESETS: string[] = [
'typing',
'cooking',
'thinking',
'plotting',
'brewing',
'sketching',
'humming',
'whispering',
'doodling',
'lurking',
'scheming',
'daydreaming',
];
const TYPING_VERB_MAX_LENGTH = 48;
/** Profile data arrives as unknown from the homeserver, so it is validated here. */
export function parseTypingVerb(value: unknown): string | undefined {
if (typeof value !== 'string') return undefined;
const verb = value
.replace(/[^a-zA-Z0-9 ]/g, '')
.replace(/ {2,}/g, ' ')
.trim();
if (!verb || verb.length > TYPING_VERB_MAX_LENGTH) return undefined;
return verb;
}
export type StoredCollectible = {
sku_id: string;
name: string;
@@ -230,3 +262,26 @@ export async function deleteColorPreference(mx: MatrixClient): Promise<void> {
const userId = mx.getUserId();
if (userId) clearProfileCache(userId);
}
export async function saveTypingVerb(mx: MatrixClient, verb: string): Promise<void> {
if (!(await mx.doesServerSupportExtendedProfiles())) {
throw new Error('Server does not support extended profile fields (MSC4133)');
}
const value = parseTypingVerb(verb);
if (!value) throw new Error('Invalid typing verb');
await mx.setExtendedProfileProperty(PROFILE_KEY_TYPING_VERB, value);
const userId = mx.getUserId();
if (userId) clearProfileCache(userId);
}
export async function deleteTypingVerb(mx: MatrixClient): Promise<void> {
if (!(await mx.doesServerSupportExtendedProfiles())) {
throw new Error('Server does not support extended profile fields (MSC4133)');
}
await mx.deleteExtendedProfileProperty(PROFILE_KEY_TYPING_VERB);
const userId = mx.getUserId();
if (userId) clearProfileCache(userId);
}