zulip/web/src/typing_data.ts

import * as muted_users from "./muted_users";
import * as util from "./util";

// See docs/subsystems/typing-indicators.md for details on typing indicators.

const typist_dct = new Map<string, number[]>();
const inbound_timer_dict = new Map<string, ReturnType<typeof setInterval> | undefined>();

export function clear_for_testing(): void {
    typist_dct.clear();
    inbound_timer_dict.clear();
}

function get_key(group: number[]): string {
    const ids = util.sorted_ids(group);
    return ids.join(",");
}

export function add_typist(group: number[], typist: number): void {
    const key = get_key(group);
    const current = typist_dct.get(key) || [];
    if (!current.includes(typist)) {
        current.push(typist);
    }
    typist_dct.set(key, util.sorted_ids(current));
}

export function remove_typist(group: number[], typist: number): boolean {
    const key = get_key(group);
    let current = typist_dct.get(key) || [];

    if (!current.includes(typist)) {
        return false;
    }

    current = current.filter((user_id) => user_id !== typist);

    typist_dct.set(key, current);
    return true;
}

export function get_group_typists(group: number[]): number[] {
    const key = get_key(group);
    const user_ids = typist_dct.get(key) || [];
    return muted_users.filter_muted_user_ids(user_ids);
}

export function get_all_typists(): number[] {
    let typists = [...typist_dct.values()].flat();
    typists = util.sorted_ids(typists);
    return muted_users.filter_muted_user_ids(typists);
}

// The next functions aren't pure data, but it is easy
// enough to mock the setTimeout/clearTimeout functions.
export function clear_inbound_timer(group: number[]): void {
    const key = get_key(group);
    const timer = inbound_timer_dict.get(key);
    if (timer) {
        clearTimeout(timer);
        inbound_timer_dict.set(key, undefined);
    }
}

export function kickstart_inbound_timer(
    group: number[],
    delay: number,
    callback: () => void,
): void {
    const key = get_key(group);
    clear_inbound_timer(group);
    const timer = setTimeout(callback, delay);
    inbound_timer_dict.set(key, timer);
}