mirror of https://github.com/zulip/zulip.git
1049 lines
31 KiB
TypeScript
1049 lines
31 KiB
TypeScript
import Handlebars from "handlebars/runtime";
|
|
|
|
import {page_params} from "./base_page_params";
|
|
import {$t, $t_html} from "./i18n";
|
|
import type {RealmDefaultSettings} from "./realm_user_settings_defaults";
|
|
import {realm} from "./state_data";
|
|
import type {StreamSpecificNotificationSettings} from "./sub_store";
|
|
import {StreamPostPolicy} from "./sub_store";
|
|
import type {
|
|
FollowedTopicNotificationSettings,
|
|
PmNotificationSettings,
|
|
StreamNotificationSettings,
|
|
UserSettings,
|
|
} from "./user_settings";
|
|
|
|
/*
|
|
This file contains translations between the integer values used in
|
|
the Zulip API to describe values in dropdowns, radio buttons, and
|
|
similar widgets and the user-facing strings that should be used to
|
|
describe them, as well as data details like sort orders that may
|
|
be useful for some widgets.
|
|
|
|
We plan to eventually transition much of this file to have a more
|
|
standard format and then to be populated using data sent from the
|
|
Zulip server in `page_params`, so that the data is available for
|
|
other parts of the ecosystem to use (including the mobile apps and
|
|
API documentation) without a ton of copying.
|
|
*/
|
|
|
|
export const demote_inactive_streams_values = {
|
|
automatic: {
|
|
code: 1,
|
|
description: $t({defaultMessage: "Automatic"}),
|
|
},
|
|
always: {
|
|
code: 2,
|
|
description: $t({defaultMessage: "Always"}),
|
|
},
|
|
never: {
|
|
code: 3,
|
|
description: $t({defaultMessage: "Never"}),
|
|
},
|
|
};
|
|
|
|
export const web_mark_read_on_scroll_policy_values = {
|
|
always: {
|
|
code: 1,
|
|
description: $t({defaultMessage: "Always"}),
|
|
},
|
|
conversation_only: {
|
|
code: 2,
|
|
description: $t({defaultMessage: "Only in conversation views"}),
|
|
},
|
|
never: {
|
|
code: 3,
|
|
description: $t({defaultMessage: "Never"}),
|
|
},
|
|
};
|
|
|
|
export const user_list_style_values = {
|
|
compact: {
|
|
code: 1,
|
|
description: $t({defaultMessage: "Compact"}),
|
|
},
|
|
with_status: {
|
|
code: 2,
|
|
description: $t({defaultMessage: "Show status text"}),
|
|
},
|
|
// The `with_avatar` design in still in discussion.
|
|
// with_avatar: {
|
|
// code: 3,
|
|
// description: $t({defaultMessage: "Show status text and avatar"}),
|
|
// },
|
|
};
|
|
|
|
export const web_stream_unreads_count_display_policy_values = {
|
|
all_streams: {
|
|
code: 1,
|
|
description: $t({defaultMessage: "All streams"}),
|
|
},
|
|
unmuted_streams: {
|
|
code: 2,
|
|
description: $t({defaultMessage: "Unmuted streams and topics"}),
|
|
},
|
|
no_streams: {
|
|
code: 3,
|
|
description: $t({defaultMessage: "No streams"}),
|
|
},
|
|
};
|
|
|
|
export const web_home_view_values = {
|
|
inbox: {
|
|
code: "inbox",
|
|
description: $t({defaultMessage: "Inbox"}),
|
|
},
|
|
recent_topics: {
|
|
code: "recent_topics",
|
|
description: $t({defaultMessage: "Recent conversations"}),
|
|
},
|
|
all_messages: {
|
|
code: "all_messages",
|
|
description: $t({defaultMessage: "Combined feed"}),
|
|
},
|
|
};
|
|
|
|
export const color_scheme_values = {
|
|
automatic: {
|
|
code: 1,
|
|
description: $t({defaultMessage: "Automatic (follows system settings)"}),
|
|
},
|
|
day: {
|
|
code: 3,
|
|
description: $t({defaultMessage: "Light"}),
|
|
},
|
|
night: {
|
|
code: 2,
|
|
description: $t({defaultMessage: "Dark"}),
|
|
},
|
|
};
|
|
|
|
export const twenty_four_hour_time_values = {
|
|
twenty_four_hour_clock: {
|
|
value: true,
|
|
description: $t({defaultMessage: "24-hour clock (17:00)"}),
|
|
},
|
|
twelve_hour_clock: {
|
|
value: false,
|
|
description: $t({defaultMessage: "12-hour clock (5:00 PM)"}),
|
|
},
|
|
};
|
|
|
|
export type DisplaySettings = {
|
|
settings: {
|
|
user_display_settings: string[];
|
|
};
|
|
render_group?: boolean;
|
|
render_only: {
|
|
dense_mode?: boolean;
|
|
high_contrast_mode?: boolean;
|
|
web_font_size_px?: boolean;
|
|
web_line_height_percent?: boolean;
|
|
};
|
|
};
|
|
|
|
/* istanbul ignore next */
|
|
export const get_all_preferences = (): DisplaySettings => ({
|
|
settings: {
|
|
user_display_settings: [
|
|
"dense_mode",
|
|
"high_contrast_mode",
|
|
"starred_message_counts",
|
|
"receives_typing_notifications",
|
|
"fluid_layout_width",
|
|
],
|
|
},
|
|
render_only: {
|
|
dense_mode: page_params.development_environment,
|
|
high_contrast_mode: page_params.development_environment,
|
|
},
|
|
});
|
|
|
|
/* istanbul ignore next */
|
|
export const get_information_density_preferences = (): DisplaySettings => ({
|
|
render_group: page_params.development_environment,
|
|
render_only: {
|
|
web_font_size_px: page_params.development_environment,
|
|
web_line_height_percent: page_params.development_environment,
|
|
},
|
|
settings: {
|
|
user_display_settings: ["web_font_size_px", "web_line_height_percent"],
|
|
},
|
|
});
|
|
|
|
export const email_address_visibility_values = {
|
|
everyone: {
|
|
code: 1,
|
|
description: $t({defaultMessage: "Admins, moderators, members and guests"}),
|
|
},
|
|
members: {
|
|
code: 2,
|
|
description: $t({defaultMessage: "Admins, moderators and members"}),
|
|
},
|
|
moderators: {
|
|
code: 5,
|
|
description: $t({defaultMessage: "Admins and moderators"}),
|
|
},
|
|
admins_only: {
|
|
code: 3,
|
|
description: $t({defaultMessage: "Admins only"}),
|
|
},
|
|
nobody: {
|
|
code: 4,
|
|
description: $t({defaultMessage: "Nobody"}),
|
|
},
|
|
};
|
|
|
|
export const common_policy_values = {
|
|
by_admins_only: {
|
|
order: 1,
|
|
code: 2,
|
|
description: $t({defaultMessage: "Admins"}),
|
|
},
|
|
by_moderators_only: {
|
|
order: 2,
|
|
code: 4,
|
|
description: $t({defaultMessage: "Admins and moderators"}),
|
|
},
|
|
by_full_members: {
|
|
order: 3,
|
|
code: 3,
|
|
description: $t({defaultMessage: "Admins, moderators and full members"}),
|
|
},
|
|
by_members: {
|
|
order: 4,
|
|
code: 1,
|
|
description: $t({defaultMessage: "Admins, moderators and members"}),
|
|
},
|
|
};
|
|
|
|
export const email_invite_to_realm_policy_values = {
|
|
nobody: {
|
|
order: 1,
|
|
code: 6,
|
|
description: $t({defaultMessage: "Nobody"}),
|
|
},
|
|
by_admins_only: {
|
|
order: 2,
|
|
code: 2,
|
|
description: $t({defaultMessage: "Admins"}),
|
|
},
|
|
by_moderators_only: {
|
|
order: 3,
|
|
code: 4,
|
|
description: $t({defaultMessage: "Admins and moderators"}),
|
|
},
|
|
by_full_members: {
|
|
order: 4,
|
|
code: 3,
|
|
description: $t({defaultMessage: "Admins, moderators and full members"}),
|
|
},
|
|
by_members: {
|
|
order: 5,
|
|
code: 1,
|
|
description: $t({defaultMessage: "Admins, moderators and members"}),
|
|
},
|
|
};
|
|
|
|
export const private_message_policy_values = {
|
|
by_anyone: {
|
|
order: 1,
|
|
code: 1,
|
|
description: $t({defaultMessage: "Admins, moderators, members and guests"}),
|
|
},
|
|
disabled: {
|
|
order: 2,
|
|
code: 2,
|
|
description: $t({defaultMessage: "Direct messages disabled"}),
|
|
},
|
|
};
|
|
|
|
export const wildcard_mention_policy_values = {
|
|
by_everyone: {
|
|
order: 1,
|
|
code: 1,
|
|
description: $t({defaultMessage: "Admins, moderators, members and guests"}),
|
|
},
|
|
by_members: {
|
|
order: 2,
|
|
code: 2,
|
|
description: $t({defaultMessage: "Admins, moderators and members"}),
|
|
},
|
|
by_full_members: {
|
|
order: 3,
|
|
code: 3,
|
|
description: $t({defaultMessage: "Admins, moderators and full members"}),
|
|
},
|
|
by_moderators_only: {
|
|
order: 4,
|
|
code: 7,
|
|
description: $t({defaultMessage: "Admins and moderators"}),
|
|
},
|
|
by_admins_only: {
|
|
order: 5,
|
|
code: 5,
|
|
description: $t({defaultMessage: "Admins only"}),
|
|
},
|
|
nobody: {
|
|
order: 6,
|
|
code: 6,
|
|
description: $t({defaultMessage: "Nobody"}),
|
|
},
|
|
};
|
|
|
|
export const create_web_public_stream_policy_values = {
|
|
by_moderators_only: {
|
|
order: 1,
|
|
code: 4,
|
|
description: $t({defaultMessage: "Admins and moderators"}),
|
|
},
|
|
by_admins_only: {
|
|
order: 2,
|
|
code: 2,
|
|
description: $t({defaultMessage: "Admins only"}),
|
|
},
|
|
by_owners_only: {
|
|
order: 3,
|
|
code: 7,
|
|
description: $t({defaultMessage: "Owners only"}),
|
|
},
|
|
nobody: {
|
|
order: 4,
|
|
code: 6,
|
|
description: $t({defaultMessage: "Nobody"}),
|
|
},
|
|
};
|
|
|
|
export const common_message_policy_values = {
|
|
by_everyone: {
|
|
order: 1,
|
|
code: 5,
|
|
description: $t({defaultMessage: "Admins, moderators, members and guests"}),
|
|
},
|
|
by_members: {
|
|
order: 2,
|
|
code: 1,
|
|
description: $t({defaultMessage: "Admins, moderators and members"}),
|
|
},
|
|
by_full_members: {
|
|
order: 3,
|
|
code: 3,
|
|
description: $t({defaultMessage: "Admins, moderators and full members"}),
|
|
},
|
|
by_moderators_only: {
|
|
order: 4,
|
|
code: 4,
|
|
description: $t({defaultMessage: "Admins and moderators"}),
|
|
},
|
|
by_admins_only: {
|
|
order: 5,
|
|
code: 2,
|
|
description: $t({defaultMessage: "Admins only"}),
|
|
},
|
|
};
|
|
|
|
export const edit_topic_policy_values = {
|
|
...common_message_policy_values,
|
|
nobody: {
|
|
order: 6,
|
|
code: 6,
|
|
description: $t({defaultMessage: "Nobody"}),
|
|
},
|
|
};
|
|
|
|
export const move_messages_between_streams_policy_values = email_invite_to_realm_policy_values;
|
|
|
|
export const time_limit_dropdown_values = [
|
|
{
|
|
text: $t({defaultMessage: "Any time"}),
|
|
value: "any_time",
|
|
},
|
|
{
|
|
text: $t(
|
|
{defaultMessage: "Up to {time_limit} after posting"},
|
|
{time_limit: $t({defaultMessage: "2 minutes"})},
|
|
),
|
|
value: 2 * 60,
|
|
},
|
|
{
|
|
text: $t(
|
|
{defaultMessage: "Up to {time_limit} after posting"},
|
|
{time_limit: $t({defaultMessage: "10 minutes"})},
|
|
),
|
|
value: 10 * 60,
|
|
},
|
|
{
|
|
text: $t(
|
|
{defaultMessage: "Up to {time_limit} after posting"},
|
|
{time_limit: $t({defaultMessage: "1 hour"})},
|
|
),
|
|
value: 60 * 60,
|
|
},
|
|
{
|
|
text: $t(
|
|
{defaultMessage: "Up to {time_limit} after posting"},
|
|
{time_limit: $t({defaultMessage: "1 day"})},
|
|
),
|
|
value: 24 * 60 * 60,
|
|
},
|
|
{
|
|
text: $t(
|
|
{defaultMessage: "Up to {time_limit} after posting"},
|
|
{time_limit: $t({defaultMessage: "1 week"})},
|
|
),
|
|
value: 7 * 24 * 60 * 60,
|
|
},
|
|
{
|
|
text: $t({defaultMessage: "Custom"}),
|
|
value: "custom_period",
|
|
},
|
|
];
|
|
export const msg_edit_limit_dropdown_values = time_limit_dropdown_values;
|
|
export const msg_delete_limit_dropdown_values = time_limit_dropdown_values;
|
|
export const msg_move_limit_dropdown_values = time_limit_dropdown_values;
|
|
|
|
export const waiting_period_threshold_dropdown_values = [
|
|
{
|
|
description: $t({defaultMessage: "None"}),
|
|
code: 0,
|
|
},
|
|
{
|
|
description: $t({defaultMessage: "3 days"}),
|
|
code: 3,
|
|
},
|
|
{
|
|
description: $t({defaultMessage: "Custom"}),
|
|
code: "custom_period",
|
|
},
|
|
];
|
|
|
|
export const retain_message_forever = -1;
|
|
|
|
export const user_role_values = {
|
|
guest: {
|
|
code: 600,
|
|
description: $t({defaultMessage: "Guest"}),
|
|
},
|
|
member: {
|
|
code: 400,
|
|
description: $t({defaultMessage: "Member"}),
|
|
},
|
|
moderator: {
|
|
code: 300,
|
|
description: $t({defaultMessage: "Moderator"}),
|
|
},
|
|
admin: {
|
|
code: 200,
|
|
description: $t({defaultMessage: "Administrator"}),
|
|
},
|
|
owner: {
|
|
code: 100,
|
|
description: $t({defaultMessage: "Owner"}),
|
|
},
|
|
};
|
|
|
|
export const all_org_type_values = {
|
|
// When org_type was added to the database model, 'unspecified'
|
|
// was the default for existing organizations. To discourage
|
|
// organizations keeping (or selecting) it as an option, we
|
|
// use an empty string for its description.
|
|
unspecified: {
|
|
code: 0,
|
|
description: "",
|
|
},
|
|
business: {
|
|
code: 10,
|
|
description: $t({defaultMessage: "Business"}),
|
|
},
|
|
opensource: {
|
|
code: 20,
|
|
description: $t({defaultMessage: "Open-source project"}),
|
|
},
|
|
education_nonprofit: {
|
|
code: 30,
|
|
description: $t({defaultMessage: "Education (non-profit)"}),
|
|
},
|
|
education: {
|
|
code: 35,
|
|
description: $t({defaultMessage: "Education (for-profit)"}),
|
|
},
|
|
research: {
|
|
code: 40,
|
|
description: $t({defaultMessage: "Research"}),
|
|
},
|
|
event: {
|
|
code: 50,
|
|
description: $t({defaultMessage: "Event or conference"}),
|
|
},
|
|
nonprofit: {
|
|
code: 60,
|
|
description: $t({defaultMessage: "Non-profit (registered)"}),
|
|
},
|
|
government: {
|
|
code: 70,
|
|
description: $t({defaultMessage: "Government"}),
|
|
},
|
|
political_group: {
|
|
code: 80,
|
|
description: $t({defaultMessage: "Political group"}),
|
|
},
|
|
community: {
|
|
code: 90,
|
|
description: $t({defaultMessage: "Community"}),
|
|
},
|
|
personal: {
|
|
code: 100,
|
|
description: $t({defaultMessage: "Personal"}),
|
|
},
|
|
other: {
|
|
code: 1000,
|
|
description: $t({defaultMessage: "Other"}),
|
|
},
|
|
};
|
|
|
|
// Remove the 'unspecified' org_type for dropdown menu options
|
|
// when an org_type other than 'unspecified' has been selected.
|
|
export const defined_org_type_values = Object.fromEntries(
|
|
Object.entries(all_org_type_values).slice(1),
|
|
);
|
|
|
|
export const expires_in_values = {
|
|
// Backend support for this configuration is not available yet.
|
|
// hour: {
|
|
// value: 1,
|
|
// description: $t({defaultMessage: "1 hour"}),
|
|
// default: false,
|
|
// },
|
|
day: {
|
|
value: 24 * 60,
|
|
description: $t({defaultMessage: "1 day"}),
|
|
default: false,
|
|
},
|
|
threeDays: {
|
|
value: 3 * 24 * 60,
|
|
description: $t({defaultMessage: "3 days"}),
|
|
default: false,
|
|
},
|
|
tenDays: {
|
|
value: 10 * 24 * 60,
|
|
description: $t({defaultMessage: "10 days"}),
|
|
default: true,
|
|
},
|
|
thirtyDays: {
|
|
value: 30 * 24 * 60,
|
|
description: $t({defaultMessage: "30 days"}),
|
|
default: false,
|
|
},
|
|
never: {
|
|
// Ideally we'd just store `null`, not the string `"null"`, but
|
|
// .val() will read null back as `""`. Custom logic in
|
|
// get_common_invitation_data converts this back to `null`
|
|
// before sending to the server.
|
|
value: "null",
|
|
description: $t({defaultMessage: "Never expires"}),
|
|
default: false,
|
|
},
|
|
custom: {
|
|
value: "custom",
|
|
description: $t({defaultMessage: "Custom"}),
|
|
default: false,
|
|
},
|
|
};
|
|
|
|
const user_role_array = Object.values(user_role_values);
|
|
export const user_role_map = new Map(user_role_array.map((role) => [role.code, role.description]));
|
|
|
|
export const preferences_settings_labels = {
|
|
default_language_settings_label: $t({defaultMessage: "Language"}),
|
|
dense_mode: $t({defaultMessage: "Dense mode"}),
|
|
display_emoji_reaction_users: new Handlebars.SafeString(
|
|
$t_html({
|
|
defaultMessage:
|
|
"Display names of reacting users when few users have reacted to a message",
|
|
}),
|
|
),
|
|
fluid_layout_width: $t({defaultMessage: "Use full width on wide screens"}),
|
|
high_contrast_mode: $t({defaultMessage: "High contrast mode"}),
|
|
receives_typing_notifications: $t({defaultMessage: "Show when other users are typing"}),
|
|
starred_message_counts: $t({defaultMessage: "Show counts for starred messages"}),
|
|
twenty_four_hour_time: $t({defaultMessage: "Time format"}),
|
|
translate_emoticons: new Handlebars.SafeString(
|
|
$t_html({
|
|
defaultMessage: "Convert emoticons before sending (<code>:)</code> becomes 😃)",
|
|
}),
|
|
),
|
|
web_escape_navigates_to_home_view: $t({defaultMessage: "Escape key navigates to home view"}),
|
|
web_font_size_px: $t({defaultMessage: "Message-area font size (px)"}),
|
|
web_line_height_percent: $t({defaultMessage: "Message-area line height (%)"}),
|
|
};
|
|
|
|
export const notification_settings_labels = {
|
|
automatically_follow_topics_policy: $t({
|
|
defaultMessage: "Automatically follow topics",
|
|
}),
|
|
automatically_follow_topics_where_mentioned: $t({
|
|
defaultMessage: "Automatically follow topics where I'm mentioned",
|
|
}),
|
|
automatically_unmute_topics_in_muted_streams_policy: $t({
|
|
defaultMessage: "Automatically unmute topics in muted streams",
|
|
}),
|
|
desktop_icon_count_display: $t({
|
|
defaultMessage: "Unread count badge (appears in desktop sidebar and browser tab)",
|
|
}),
|
|
enable_online_push_notifications: $t({
|
|
defaultMessage: "Send mobile notifications even if I'm online",
|
|
}),
|
|
enable_digest_emails: $t({defaultMessage: "Send digest emails when I'm away"}),
|
|
enable_login_emails: $t({
|
|
defaultMessage: "Send email notifications for new logins to my account",
|
|
}),
|
|
enable_marketing_emails: $t({
|
|
defaultMessage: "Send me Zulip's low-traffic newsletter (a few emails a year)",
|
|
}),
|
|
message_content_in_email_notifications: $t({
|
|
defaultMessage: "Include message content in message notification emails",
|
|
}),
|
|
pm_content_in_desktop_notifications: $t({
|
|
defaultMessage: "Include content of direct messages in desktop notifications",
|
|
}),
|
|
realm_name_in_email_notifications_policy: $t({
|
|
defaultMessage: "Include organization name in subject of message notification emails",
|
|
}),
|
|
};
|
|
|
|
export const realm_user_settings_defaults_labels = {
|
|
...notification_settings_labels,
|
|
...preferences_settings_labels,
|
|
|
|
/* Overrides to remove "I" from labels for the realm-level versions of these labels. */
|
|
enable_online_push_notifications: $t({
|
|
defaultMessage: "Send mobile notifications even if user is online",
|
|
}),
|
|
enable_digest_emails: $t({defaultMessage: "Send digest emails when user is away"}),
|
|
|
|
realm_presence_enabled: $t({
|
|
defaultMessage: "Display availability to other users",
|
|
}),
|
|
realm_presence_enabled_parens_text: $t({defaultMessage: "invisible mode off"}),
|
|
realm_enter_sends: $t({defaultMessage: "Enter sends when composing a message"}),
|
|
realm_send_read_receipts: $t({defaultMessage: "Allow other users to view read receipts"}),
|
|
realm_send_private_typing_notifications: $t({
|
|
defaultMessage: "Let recipients see when a user is typing direct messages",
|
|
}),
|
|
realm_send_stream_typing_notifications: $t({
|
|
defaultMessage: "Let recipients see when a user is typing stream messages",
|
|
}),
|
|
};
|
|
|
|
// NOTIFICATIONS
|
|
|
|
export const general_notifications_table_labels = {
|
|
realm: [
|
|
/* An array of notification settings of any category like
|
|
* `stream_notification_settings` which makes a single row of
|
|
* "Notification triggers" table should follow this order
|
|
*/
|
|
"visual",
|
|
"audio",
|
|
"mobile",
|
|
"email",
|
|
"all_mentions",
|
|
],
|
|
stream: {
|
|
is_muted: $t({defaultMessage: "Mute stream"}),
|
|
desktop_notifications: $t({defaultMessage: "Visual desktop notifications"}),
|
|
audible_notifications: $t({defaultMessage: "Audible desktop notifications"}),
|
|
push_notifications: $t({defaultMessage: "Mobile notifications"}),
|
|
email_notifications: $t({defaultMessage: "Email notifications"}),
|
|
pin_to_top: $t({defaultMessage: "Pin stream to top of left sidebar"}),
|
|
wildcard_mentions_notify: $t({defaultMessage: "Notifications for @all/@everyone mentions"}),
|
|
},
|
|
};
|
|
|
|
export const stream_specific_notification_settings: (keyof StreamSpecificNotificationSettings)[] = [
|
|
"desktop_notifications",
|
|
"audible_notifications",
|
|
"push_notifications",
|
|
"email_notifications",
|
|
"wildcard_mentions_notify",
|
|
];
|
|
|
|
export const stream_notification_settings: (keyof StreamNotificationSettings)[] = [
|
|
"enable_stream_desktop_notifications",
|
|
"enable_stream_audible_notifications",
|
|
"enable_stream_push_notifications",
|
|
"enable_stream_email_notifications",
|
|
"wildcard_mentions_notify",
|
|
];
|
|
|
|
export const generalize_stream_notification_setting: Record<
|
|
keyof StreamSpecificNotificationSettings,
|
|
keyof StreamNotificationSettings
|
|
> = {
|
|
desktop_notifications: "enable_stream_desktop_notifications",
|
|
audible_notifications: "enable_stream_audible_notifications",
|
|
push_notifications: "enable_stream_push_notifications",
|
|
email_notifications: "enable_stream_email_notifications",
|
|
wildcard_mentions_notify: "wildcard_mentions_notify",
|
|
};
|
|
|
|
export const specialize_stream_notification_setting: Record<
|
|
keyof StreamNotificationSettings,
|
|
keyof StreamSpecificNotificationSettings
|
|
> = {
|
|
enable_stream_desktop_notifications: "desktop_notifications",
|
|
enable_stream_audible_notifications: "audible_notifications",
|
|
enable_stream_push_notifications: "push_notifications",
|
|
enable_stream_email_notifications: "email_notifications",
|
|
wildcard_mentions_notify: "wildcard_mentions_notify",
|
|
};
|
|
|
|
export const pm_mention_notification_settings: (keyof PmNotificationSettings)[] = [
|
|
"enable_desktop_notifications",
|
|
"enable_sounds",
|
|
"enable_offline_push_notifications",
|
|
"enable_offline_email_notifications",
|
|
];
|
|
|
|
export const followed_topic_notification_settings: (keyof FollowedTopicNotificationSettings)[] = [
|
|
"enable_followed_topic_desktop_notifications",
|
|
"enable_followed_topic_audible_notifications",
|
|
"enable_followed_topic_push_notifications",
|
|
"enable_followed_topic_email_notifications",
|
|
"enable_followed_topic_wildcard_mentions_notify",
|
|
];
|
|
|
|
const desktop_notification_settings = ["pm_content_in_desktop_notifications"];
|
|
|
|
const mobile_notification_settings = ["enable_online_push_notifications"];
|
|
|
|
export const email_notifications_batching_period_values = [
|
|
{
|
|
value: 60 * 2,
|
|
description: $t({defaultMessage: "2 minutes"}),
|
|
},
|
|
{
|
|
value: 60 * 5,
|
|
description: $t({defaultMessage: "5 minutes"}),
|
|
},
|
|
{
|
|
value: 60 * 10,
|
|
description: $t({defaultMessage: "10 minutes"}),
|
|
},
|
|
{
|
|
value: 60 * 30,
|
|
description: $t({defaultMessage: "30 minutes"}),
|
|
},
|
|
{
|
|
value: 60 * 60,
|
|
description: $t({defaultMessage: "1 hour"}),
|
|
},
|
|
{
|
|
value: 60 * 60 * 6,
|
|
description: $t({defaultMessage: "6 hours"}),
|
|
},
|
|
{
|
|
value: 60 * 60 * 24,
|
|
description: $t({defaultMessage: "1 day"}),
|
|
},
|
|
{
|
|
value: 60 * 60 * 24 * 7,
|
|
description: $t({defaultMessage: "1 week"}),
|
|
},
|
|
{
|
|
value: "custom_period",
|
|
description: $t({defaultMessage: "Custom"}),
|
|
},
|
|
];
|
|
|
|
const email_message_notification_settings = ["message_content_in_email_notifications"];
|
|
|
|
const other_email_settings = [
|
|
"enable_digest_emails",
|
|
"enable_login_emails",
|
|
"enable_marketing_emails",
|
|
];
|
|
|
|
const email_notification_settings = [
|
|
...other_email_settings,
|
|
...email_message_notification_settings,
|
|
];
|
|
|
|
const other_notification_settings = [
|
|
...desktop_notification_settings,
|
|
"desktop_icon_count_display",
|
|
...mobile_notification_settings,
|
|
...email_notification_settings,
|
|
"email_notifications_batching_period_seconds",
|
|
"realm_name_in_email_notifications_policy",
|
|
"notification_sound",
|
|
"automatically_follow_topics_policy",
|
|
"automatically_unmute_topics_in_muted_streams_policy",
|
|
"automatically_follow_topics_where_mentioned",
|
|
];
|
|
|
|
export const all_notification_settings = [
|
|
...followed_topic_notification_settings,
|
|
...other_notification_settings,
|
|
...pm_mention_notification_settings,
|
|
...stream_notification_settings,
|
|
];
|
|
|
|
type Settings = UserSettings | RealmDefaultSettings;
|
|
type PageParamsItem = keyof Settings;
|
|
type NotificationSettingCheckbox = {
|
|
setting_name: string;
|
|
is_disabled: boolean;
|
|
is_checked: boolean;
|
|
is_mobile_checkbox: boolean;
|
|
};
|
|
|
|
export function get_notifications_table_row_data(
|
|
notify_settings: PageParamsItem[],
|
|
settings_object: Settings,
|
|
): NotificationSettingCheckbox[] {
|
|
return general_notifications_table_labels.realm.map((column, index) => {
|
|
const setting_name = notify_settings[index];
|
|
if (setting_name === undefined) {
|
|
return {
|
|
setting_name: "",
|
|
is_disabled: true,
|
|
is_checked: false,
|
|
is_mobile_checkbox: false,
|
|
};
|
|
}
|
|
|
|
const checked = settings_object[setting_name];
|
|
if (typeof checked !== "boolean") {
|
|
throw new TypeError(`Incorrect setting_name passed: ${setting_name}`);
|
|
}
|
|
|
|
const checkbox = {
|
|
setting_name,
|
|
is_disabled: false,
|
|
is_checked: checked,
|
|
is_mobile_checkbox: false,
|
|
};
|
|
if (column === "mobile") {
|
|
checkbox.is_disabled = !realm.realm_push_notifications_enabled;
|
|
checkbox.is_mobile_checkbox = true;
|
|
}
|
|
return checkbox;
|
|
});
|
|
}
|
|
|
|
export type AllNotifications = {
|
|
general_settings: {label: string; notification_settings: NotificationSettingCheckbox[]}[];
|
|
settings: {
|
|
desktop_notification_settings: string[];
|
|
mobile_notification_settings: string[];
|
|
email_message_notification_settings: string[];
|
|
other_email_settings: string[];
|
|
};
|
|
show_push_notifications_tooltip: {
|
|
push_notifications: boolean;
|
|
enable_online_push_notifications: boolean;
|
|
};
|
|
};
|
|
|
|
export const all_notifications = (settings_object: Settings): AllNotifications => ({
|
|
general_settings: [
|
|
{
|
|
label: $t({defaultMessage: "Streams"}),
|
|
notification_settings: get_notifications_table_row_data(
|
|
stream_notification_settings,
|
|
settings_object,
|
|
),
|
|
},
|
|
{
|
|
label: $t({defaultMessage: "DMs, mentions, and alerts"}),
|
|
notification_settings: get_notifications_table_row_data(
|
|
pm_mention_notification_settings,
|
|
settings_object,
|
|
),
|
|
},
|
|
{
|
|
label: $t({defaultMessage: "Followed topics"}),
|
|
notification_settings: get_notifications_table_row_data(
|
|
followed_topic_notification_settings,
|
|
settings_object,
|
|
),
|
|
},
|
|
],
|
|
settings: {
|
|
desktop_notification_settings,
|
|
mobile_notification_settings,
|
|
email_message_notification_settings,
|
|
other_email_settings,
|
|
},
|
|
show_push_notifications_tooltip: {
|
|
push_notifications: !realm.realm_push_notifications_enabled,
|
|
enable_online_push_notifications: !realm.realm_push_notifications_enabled,
|
|
},
|
|
});
|
|
|
|
export const realm_name_in_email_notifications_policy_values = {
|
|
automatic: {
|
|
code: 1,
|
|
description: $t({defaultMessage: "Automatic"}),
|
|
},
|
|
always: {
|
|
code: 2,
|
|
description: $t({defaultMessage: "Always"}),
|
|
},
|
|
never: {
|
|
code: 3,
|
|
description: $t({defaultMessage: "Never"}),
|
|
},
|
|
};
|
|
|
|
export const desktop_icon_count_display_values = {
|
|
messages: {
|
|
code: 1,
|
|
description: $t({defaultMessage: "All unread messages"}),
|
|
},
|
|
dm_mention_followed_topic: {
|
|
code: 2,
|
|
description: $t({defaultMessage: "DMs, mentions, and followed topics"}),
|
|
},
|
|
dm_mention: {
|
|
code: 3,
|
|
description: $t({defaultMessage: "DMs and mentions"}),
|
|
},
|
|
none: {
|
|
code: 4,
|
|
description: $t({defaultMessage: "None"}),
|
|
},
|
|
};
|
|
|
|
export const system_user_groups_list = [
|
|
{
|
|
name: "role:internet",
|
|
display_name: $t({defaultMessage: "Everyone on the internet"}),
|
|
},
|
|
{
|
|
name: "role:everyone",
|
|
display_name: $t({defaultMessage: "Admins, moderators, members and guests"}),
|
|
},
|
|
{
|
|
name: "role:members",
|
|
display_name: $t({defaultMessage: "Admins, moderators and members"}),
|
|
},
|
|
{
|
|
name: "role:fullmembers",
|
|
display_name: $t({defaultMessage: "Admins, moderators and full members"}),
|
|
},
|
|
{
|
|
name: "role:moderators",
|
|
display_name: $t({defaultMessage: "Admins and moderators"}),
|
|
},
|
|
{
|
|
name: "role:administrators",
|
|
display_name: $t({defaultMessage: "Admins"}),
|
|
},
|
|
{
|
|
name: "role:owners",
|
|
display_name: $t({defaultMessage: "Owners"}),
|
|
},
|
|
{
|
|
name: "role:nobody",
|
|
display_name: $t({defaultMessage: "Nobody"}),
|
|
},
|
|
];
|
|
|
|
export const user_topic_visibility_policy_values = {
|
|
followed: {
|
|
code: 3,
|
|
description: $t({defaultMessage: "Followed"}),
|
|
},
|
|
muted: {
|
|
code: 1,
|
|
description: $t({defaultMessage: "Muted"}),
|
|
},
|
|
unmuted: {
|
|
code: 2,
|
|
description: $t({defaultMessage: "Unmuted"}),
|
|
},
|
|
inherit: {
|
|
code: 0,
|
|
description: $t({defaultMessage: "Default for stream"}),
|
|
},
|
|
};
|
|
|
|
export const automatically_follow_or_unmute_topics_policy_values = {
|
|
participation: {
|
|
code: 1,
|
|
description: $t({defaultMessage: "Topics I participate in"}),
|
|
},
|
|
send: {
|
|
code: 2,
|
|
description: $t({defaultMessage: "Topics I send a message to"}),
|
|
},
|
|
initiation: {
|
|
code: 3,
|
|
description: $t({defaultMessage: "Topics I start"}),
|
|
},
|
|
never: {
|
|
code: 4,
|
|
description: $t({defaultMessage: "Never"}),
|
|
},
|
|
};
|
|
|
|
export const stream_privacy_policy_values = {
|
|
web_public: {
|
|
code: "web-public",
|
|
name: $t({defaultMessage: "Web-public"}),
|
|
description: $t({
|
|
defaultMessage:
|
|
"Organization members can join (guests must be invited by a subscriber); anyone on the Internet can view complete message history without creating an account",
|
|
}),
|
|
},
|
|
public: {
|
|
code: "public",
|
|
name: $t({defaultMessage: "Public"}),
|
|
description: $t({
|
|
defaultMessage:
|
|
"Organization members can join (guests must be invited by a subscriber); organization members can view complete message history without joining",
|
|
}),
|
|
},
|
|
private_with_public_history: {
|
|
code: "invite-only-public-history",
|
|
name: $t({defaultMessage: "Private, shared history"}),
|
|
description: $t({
|
|
defaultMessage:
|
|
"Must be invited by a subscriber; new subscribers can view complete message history; hidden from non-administrator users",
|
|
}),
|
|
},
|
|
private: {
|
|
code: "invite-only",
|
|
name: $t({defaultMessage: "Private, protected history"}),
|
|
description: $t({
|
|
defaultMessage:
|
|
"Must be invited by a subscriber; new subscribers can only see messages sent after they join; hidden from non-administrator users",
|
|
}),
|
|
},
|
|
};
|
|
|
|
export const stream_post_policy_values = {
|
|
// These strings should match the strings in the
|
|
// Stream.POST_POLICIES object in zerver/models/streams.py.
|
|
everyone: {
|
|
code: StreamPostPolicy.EVERYONE,
|
|
description: $t({defaultMessage: "Everyone"}),
|
|
},
|
|
non_new_members: {
|
|
code: StreamPostPolicy.RESTRICT_NEW_MEMBERS,
|
|
description: $t({defaultMessage: "Admins, moderators and full members"}),
|
|
},
|
|
moderators: {
|
|
code: StreamPostPolicy.MODERATORS,
|
|
description: $t({
|
|
defaultMessage: "Admins and moderators",
|
|
}),
|
|
},
|
|
admins: {
|
|
code: StreamPostPolicy.ADMINS,
|
|
description: $t({defaultMessage: "Admins only"}),
|
|
},
|
|
} as const;
|