Skip to content

Commit

Permalink
api: Update InitialDataRealm and RealmDataForUpdate to FL 237
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisbobbe committed Dec 22, 2023
1 parent 042c4cf commit 6b46817
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 8 deletions.
1 change: 0 additions & 1 deletion src/__tests__/lib/exampleData.js
Original file line number Diff line number Diff line change
Expand Up @@ -764,7 +764,6 @@ export const action = Object.freeze({
realm_avatar_changes_disabled: false,
realm_bot_creation_policy: 3,
realm_bot_domain: 'example.com',
realm_community_topic_editing_limit_seconds: 600,
realm_create_private_stream_policy: 3,
realm_create_public_stream_policy: 3,
realm_create_web_public_stream_policy: CreateWebPublicStreamPolicy.ModeratorOrAbove,
Expand Down
37 changes: 33 additions & 4 deletions src/api/initialDataTypes.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import type {
EmailAddressVisibility,
} from './permissionsTypes';
import type { ZulipVersion } from '../utils/zulipVersion';
import type { JSONableDict } from '../utils/jsonable';

/*
The types in this file are organized by which `fetch_event_types` values
Expand Down Expand Up @@ -117,7 +118,7 @@ export type AvailableVideoChatProviders = $ReadOnly<{|
[providerName: string]: $ReadOnly<{| name: string, id: number |}>,
|}>;

// This is current to feature level 140.
// This is current to feature level 237.
export type InitialDataRealm = $ReadOnly<{|
//
// Keep alphabetical order. When changing this, also change our type for
Expand All @@ -129,7 +130,7 @@ export type InitialDataRealm = $ReadOnly<{|
// TODO(server-5.0): Added, at feat. 74.
event_queue_longpoll_timeout_seconds?: number,

jitsi_server_url?: string, // TODO: Really optional?
jitsi_server_url?: string, // deprecated
max_avatar_file_size_mib: number,
max_file_upload_size_mib: number,

Expand Down Expand Up @@ -181,8 +182,11 @@ export type InitialDataRealm = $ReadOnly<{|
realm_bot_creation_policy: number,
realm_bot_domain: string,

// TODO(server-3.0): Added in feat. 11
realm_community_topic_editing_limit_seconds?: number,
// TODO(server-8.0): Added in feat. 225
realm_can_access_all_users_group?: boolean,

// TODO(server-8.0): Added in feat. 209
realm_create_multiuse_invite_group?: number,

// TODO(server-5.0): Added in feat. 102, replacing
// realm_create_stream_policy for private streams
Expand All @@ -202,6 +206,7 @@ export type InitialDataRealm = $ReadOnly<{|
// CreateWebPublicStreamPolicy.Nobody.
realm_create_web_public_stream_policy?: CreateWebPublicStreamPolicy,

// TODO(server-8.0): In feat. 195+, just `string`, not `string | null`.
realm_default_code_block_language: string | null,

// TODO(server-2.1): Added in commit 2.1.0-rc1~1382.
Expand Down Expand Up @@ -238,6 +243,9 @@ export type InitialDataRealm = $ReadOnly<{|
realm_email_changes_disabled: boolean,
realm_emails_restricted_to_domains: boolean,

// TODO(server-8.0): Added in feat. 216
realm_enable_guest_user_indicator?: boolean,

// TODO(server-6.0): Added in feat. 137; if absent, treat as false.
realm_enable_read_receipts?: boolean,

Expand All @@ -262,6 +270,10 @@ export type InitialDataRealm = $ReadOnly<{|

realm_invite_to_stream_policy: number,
realm_is_zephyr_mirror_realm: boolean,

// TODO(server-8.0): Added in feat. 212
realm_jitsi_server_url?: string | null,

realm_logo_source: 'D' | 'U',
realm_logo_url: string,
realm_mandatory_topics: boolean,
Expand All @@ -282,6 +294,12 @@ export type InitialDataRealm = $ReadOnly<{|
// TODO(server-4.0): Added in feat. 56
realm_move_messages_between_streams_policy?: number,

// TODO(server-7.0): Added in feat. 162
realm_move_messages_between_streams_limit_seconds?: number | null,

// TODO(server-7.0): Added in feat. 162
realm_move_messages_within_stream_limit_seconds?: number | null,

realm_name: string,
realm_name_changes_disabled: boolean,
realm_night_logo_source: 'D' | 'U',
Expand All @@ -296,6 +314,10 @@ export type InitialDataRealm = $ReadOnly<{|
realm_presence_disabled: boolean,
realm_private_message_policy: number,
realm_push_notifications_enabled: boolean,

// TODO(server-8.0): Added in feat. 231
realm_push_notifications_enabled_end_timestamp?: number | null,

realm_send_welcome_emails: boolean,
realm_signup_notifications_stream_id: number,

Expand Down Expand Up @@ -326,11 +348,18 @@ export type InitialDataRealm = $ReadOnly<{|
server_generation: number,
server_inline_image_preview: boolean,
server_inline_url_embed_preview: boolean,

// TODO(server-8.0): Added in feat. 212
server_jitsi_server_url?: string | null,

server_name_changes_disabled: boolean,

// TODO(server-5.0): Added in feat. 74
server_needs_upgrade?: boolean,

// TODO(server-8.0): Added in feat. 221
server_supported_permission_settings?: JSONableDict, // unstable

// TODO(server-5.0): Added in feat. 110; if absent, treat as false.
server_web_public_streams_enabled?: boolean,

Expand Down
22 changes: 19 additions & 3 deletions src/api/realmDataTypes.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import type { InitialDataRealm } from './initialDataTypes';
* start with "realm_"). But we expect the values to be typed the same.
*/
/* prettier-ignore */
// Current to FL 140.
// Current to FL 237.
export type RealmDataForUpdate = $ReadOnly<{
//
// Keep alphabetical by the InitialDataRealm property. So by
Expand All @@ -35,8 +35,10 @@ export type RealmDataForUpdate = $ReadOnly<{
InitialDataRealm['realm_authentication_methods'],
bot_creation_policy:
InitialDataRealm['realm_bot_creation_policy'],
community_topic_editing_limit_seconds:
InitialDataRealm['realm_community_topic_editing_limit_seconds'],
can_access_all_users_group:
InitialDataRealm['realm_can_access_all_users_group'],
create_multiuse_invite_group:
InitialDataRealm['realm_create_multiuse_invite_group'],
create_private_stream_policy:
InitialDataRealm['realm_create_private_stream_policy'],
create_public_stream_policy:
Expand Down Expand Up @@ -65,6 +67,8 @@ export type RealmDataForUpdate = $ReadOnly<{
InitialDataRealm['realm_email_changes_disabled'],
emails_restricted_to_domains:
InitialDataRealm['realm_emails_restricted_to_domains'],
enable_guest_user_indicator:
InitialDataRealm['realm_enable_guest_user_indicator'],
enable_read_receipts:
InitialDataRealm['realm_enable_read_receipts'],
enable_spectator_access:
Expand All @@ -87,6 +91,8 @@ export type RealmDataForUpdate = $ReadOnly<{
InitialDataRealm['realm_invite_to_realm_policy'],
invite_to_stream_policy:
InitialDataRealm['realm_invite_to_stream_policy'],
jitsi_server_url:
InitialDataRealm['realm_jitsi_server_url'],
logo_source:
InitialDataRealm['realm_logo_source'],
logo_url:
Expand All @@ -101,6 +107,10 @@ export type RealmDataForUpdate = $ReadOnly<{
InitialDataRealm['realm_message_content_edit_limit_seconds'],
move_messages_between_streams_policy:
InitialDataRealm['realm_move_messages_between_streams_policy'],
move_messages_between_streams_limit_seconds:
InitialDataRealm['realm_move_messages_between_streams_limit_seconds'],
move_messages_within_stream_limit_seconds:
InitialDataRealm['realm_move_messages_within_stream_limit_seconds'],
name:
InitialDataRealm['realm_name'],
name_changes_disabled:
Expand All @@ -111,12 +121,18 @@ export type RealmDataForUpdate = $ReadOnly<{
InitialDataRealm['realm_night_logo_url'],
notifications_stream_id:
InitialDataRealm['realm_notifications_stream_id'],
org_type:
InitialDataRealm['realm_org_type'],
plan_type:
InitialDataRealm['realm_plan_type'],
presence_disabled:
InitialDataRealm['realm_presence_disabled'],
private_message_policy:
InitialDataRealm['realm_private_message_policy'],
push_notifications_enabled:
InitialDataRealm['realm_push_notifications_enabled'],
push_notifications_enabled_end_timestamp:
InitialDataRealm['realm_push_notifications_enabled_end_timestamp'],
send_welcome_emails:
InitialDataRealm['realm_send_welcome_emails'],
signup_notifications_stream_id:
Expand Down

0 comments on commit 6b46817

Please sign in to comment.