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.
This commit is contained in:
@@ -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;
|
||||
}
|
||||
Reference in New Issue
Block a user