Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

settings_invites: Convert module to TypeScript. 

Signed-off-by: Anders Kaseorg <anders@zulip.com>
This commit is contained in:
Anders Kaseorg 2023-10-02 17:10:04 -07:00 committed by Tim Abbott
parent 15de51d727
commit 30ae936793
2 changed files with 69 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
tools/test-js-with-node
View File

@ -174,7 +174,7 @@ EXEMPT_FILES = make_set(
"web/src/settings_display.js", "web/src/settings_display.js",
"web/src/settings_emoji.ts", "web/src/settings_emoji.ts",
"web/src/settings_exports.ts", "web/src/settings_exports.ts",
"web/src/settings_invites.js", "web/src/settings_invites.ts",
"web/src/settings_linkifiers.js", "web/src/settings_linkifiers.js",
"web/src/settings_muted_users.ts", "web/src/settings_muted_users.ts",
"web/src/settings_notifications.js", "web/src/settings_notifications.js",

92
web/src/settings_invites.js → web/src/settings_invites.ts
View File

@ -1,4 +1,5 @@
import $ from "jquery"; import $ from "jquery";
import {z} from "zod";
import render_settings_resend_invite_modal from "../templates/confirm_dialog/confirm_resend_invite.hbs"; import render_settings_resend_invite_modal from "../templates/confirm_dialog/confirm_resend_invite.hbs";
import render_settings_revoke_invite_modal from "../templates/confirm_dialog/confirm_revoke_invite.hbs"; import render_settings_revoke_invite_modal from "../templates/confirm_dialog/confirm_revoke_invite.hbs";
@ -18,15 +19,43 @@ import * as timerender from "./timerender";
import * as ui_report from "./ui_report"; import * as ui_report from "./ui_report";
import * as util from "./util"; import * as util from "./util";
const invite_schema = z.intersection(
z.object({
invited_by_user_id: z.number(),
invited: z.number(),
expiry_date: z.number().nullable(),
id: z.number(),
invited_as: z.number(),
}),
z.union([
z.object({
is_multiuse: z.literal(false),
email: z.string(),
}),
z.object({
is_multiuse: z.literal(true),
link_url: z.string(),
}),
]),
);
type Invite = z.output<typeof invite_schema> & {
invited_as_text?: string;
invited_absolute_time?: string;
expiry_date_absolute_time?: string;
is_admin?: boolean;
disable_buttons?: boolean;
referrer_name?: string;
};
const meta = { const meta = {
loaded: false, loaded: false,
}; };
export function reset() { export function reset(): void {
meta.loaded = false; meta.loaded = false;
} }
function failed_listing_invites(xhr) { function failed_listing_invites(xhr: JQuery.jqXHR): void {
loading.destroy_indicator($("#admin_page_invites_loading_indicator")); loading.destroy_indicator($("#admin_page_invites_loading_indicator"));
ui_report.error( ui_report.error(
$t_html({defaultMessage: "Error listing invites"}), $t_html({defaultMessage: "Error listing invites"}),
@ -35,23 +64,23 @@ function failed_listing_invites(xhr) {
); );
} }
function add_invited_as_text(invites) { function add_invited_as_text(invites: Invite[]): void {
for (const data of invites) { for (const data of invites) {
data.invited_as_text = settings_config.user_role_map.get(data.invited_as); data.invited_as_text = settings_config.user_role_map.get(data.invited_as);
} }
} }
function sort_invitee(a, b) { function sort_invitee(a: Invite, b: Invite): number {
// multi-invite links don't have an email field, // multi-invite links don't have an email field,
// so we set them to empty strings to let them // so we set them to empty strings to let them
// sort to the top // sort to the top
const str1 = (a.email || "").toUpperCase(); const str1 = a.is_multiuse ? "" : a.email.toUpperCase();
const str2 = (b.email || "").toUpperCase(); const str2 = b.is_multiuse ? "" : b.email.toUpperCase();
return util.strcmp(str1, str2); return util.strcmp(str1, str2);
} }
function populate_invites(invites_data) { function populate_invites(invites_data: {invites: Invite[]}): void {
if (!meta.loaded) { if (!meta.loaded) {
return; return;
} }
@ -75,7 +104,9 @@ function populate_invites(invites_data) {
return render_admin_invites_list({invite: item}); return render_admin_invites_list({invite: item});
}, },
filter: { filter: {
$element: $invites_table.closest(".settings-section").find(".search"), $element: $invites_table
.closest(".settings-section")
.find<HTMLInputElement>("input.search"),
predicate(item, value) { predicate(item, value) {
const referrer = people.get_by_user_id(item.invited_by_user_id); const referrer = people.get_by_user_id(item.invited_by_user_id);
const referrer_email = referrer.email; const referrer_email = referrer.email;
@ -106,7 +137,15 @@ function populate_invites(invites_data) {
loading.destroy_indicator($("#admin_page_invites_loading_indicator")); loading.destroy_indicator($("#admin_page_invites_loading_indicator"));
} }
function do_revoke_invite({$row, invite_id, is_multiuse}) { function do_revoke_invite({
$row,
invite_id,
is_multiuse,
}: {
$row: JQuery;
invite_id: string;
is_multiuse: string;
}): void {
const modal_invite_id = $(".dialog_submit_button").attr("data-invite-id"); const modal_invite_id = $(".dialog_submit_button").attr("data-invite-id");
const modal_is_multiuse = $(".dialog_submit_button").attr("data-is-multiuse"); const modal_is_multiuse = $(".dialog_submit_button").attr("data-is-multiuse");
const $revoke_button = $row.find("button.revoke"); const $revoke_button = $row.find("button.revoke");
@ -127,7 +166,7 @@ function do_revoke_invite({$row, invite_id, is_multiuse}) {
if (modal_is_multiuse === "true") { if (modal_is_multiuse === "true") {
url = "/json/invites/multiuse/" + invite_id; url = "/json/invites/multiuse/" + invite_id;
} }
channel.del({ void channel.del({
url, url,
error(xhr) { error(xhr) {
ui_report.generic_row_button_error(xhr, $revoke_button); ui_report.generic_row_button_error(xhr, $revoke_button);
@ -138,7 +177,7 @@ function do_revoke_invite({$row, invite_id, is_multiuse}) {
}); });
} }
function do_resend_invite({$row, invite_id}) { function do_resend_invite({$row, invite_id}: {$row: JQuery; invite_id: string}): void {
const modal_invite_id = $(".dialog_submit_button").attr("data-invite-id"); const modal_invite_id = $(".dialog_submit_button").attr("data-invite-id");
const $resend_button = $row.find("button.resend"); const $resend_button = $row.find("button.resend");
@ -153,38 +192,43 @@ function do_resend_invite({$row, invite_id}) {
} }
$resend_button.prop("disabled", true).text($t({defaultMessage: "Working…"})); $resend_button.prop("disabled", true).text($t({defaultMessage: "Working…"}));
channel.post({ void channel.post({
url: "/json/invites/" + invite_id + "/resend", url: "/json/invites/" + invite_id + "/resend",
error(xhr) { error(xhr) {
ui_report.generic_row_button_error(xhr, $resend_button); ui_report.generic_row_button_error(xhr, $resend_button);
}, },
success(data) { success(raw_data) {
const data = z.object({timestamp: z.number()}).parse(raw_data);
$resend_button.text($t({defaultMessage: "Sent!"})); $resend_button.text($t({defaultMessage: "Sent!"}));
$resend_button.removeClass("resend btn-warning").addClass("sea-green"); $resend_button.removeClass("resend btn-warning").addClass("sea-green");
data.timestamp = timerender.absolute_time(data.timestamp * 1000); const timestamp = timerender.absolute_time(data.timestamp * 1000);
$row.find(".invited_at").text(data.timestamp); $row.find(".invited_at").text(timestamp);
}, },
}); });
} }
export function set_up(initialize_event_handlers = true) { export function set_up(initialize_event_handlers = true): void {
meta.loaded = true; meta.loaded = true;
// create loading indicators // create loading indicators
loading.make_indicator($("#admin_page_invites_loading_indicator")); loading.make_indicator($("#admin_page_invites_loading_indicator"));
// Populate invites table // Populate invites table
channel.get({ void channel.get({
url: "/json/invites", url: "/json/invites",
timeout: 10 * 1000, timeout: 10 * 1000,
success(data) { success(raw_data) {
const data = z.object({invites: z.array(invite_schema)}).parse(raw_data);
on_load_success(data, initialize_event_handlers); on_load_success(data, initialize_event_handlers);
}, },
error: failed_listing_invites, error: failed_listing_invites,
}); });
} }
export function on_load_success(invites_data, initialize_event_handlers) { export function on_load_success(
invites_data: {invites: Invite[]},
initialize_event_handlers: boolean,
): void {
meta.loaded = true; meta.loaded = true;
populate_invites(invites_data); populate_invites(invites_data);
if (!initialize_event_handlers) { if (!initialize_event_handlers) {
@ -198,8 +242,8 @@ export function on_load_success(invites_data, initialize_event_handlers) {
const $row = $(e.target).closest(".invite_row"); const $row = $(e.target).closest(".invite_row");
const email = $row.find(".email").text(); const email = $row.find(".email").text();
const referred_by = $row.find(".referred_by").text(); const referred_by = $row.find(".referred_by").text();
const invite_id = $(e.currentTarget).attr("data-invite-id"); const invite_id = $(e.currentTarget).attr("data-invite-id")!;
const is_multiuse = $(e.currentTarget).attr("data-is-multiuse"); const is_multiuse = $(e.currentTarget).attr("data-is-multiuse")!;
const ctx = { const ctx = {
is_multiuse: is_multiuse === "true", is_multiuse: is_multiuse === "true",
email, email,
@ -229,7 +273,7 @@ export function on_load_success(invites_data, initialize_event_handlers) {
const $row = $(e.target).closest(".invite_row"); const $row = $(e.target).closest(".invite_row");
const email = $row.find(".email").text(); const email = $row.find(".email").text();
const invite_id = $(e.currentTarget).attr("data-invite-id"); const invite_id = $(e.currentTarget).attr("data-invite-id")!;
const html_body = render_settings_resend_invite_modal({email}); const html_body = render_settings_resend_invite_modal({email});
confirm_dialog.launch({ confirm_dialog.launch({
@ -244,7 +288,7 @@ export function on_load_success(invites_data, initialize_event_handlers) {
}); });
} }
export function update_invite_users_setting_tip() { export function update_invite_users_setting_tip(): void {
if (settings_data.user_can_invite_users_by_email() && !page_params.is_admin) { if (settings_data.user_can_invite_users_by_email() && !page_params.is_admin) {
$(".invite-user-settings-tip").hide(); $(".invite-user-settings-tip").hide();
return; return;
@ -296,7 +340,7 @@ export function update_invite_users_setting_tip() {
$(".invite-user-settings-tip").text(tip_text); $(".invite-user-settings-tip").text(tip_text);
} }
export function update_invite_user_panel() { export function update_invite_user_panel(): void {
update_invite_users_setting_tip(); update_invite_users_setting_tip();
if ( if (
!settings_data.user_can_invite_users_by_email() && !settings_data.user_can_invite_users_by_email() &&