instance defaults definitions

src/boot/after_store.js

@@ -39,8 +39,8 @@ import { useUserHighlightStore } from 'src/stores/user_highlight.js'
 
 import VBodyScrollLock from 'src/directives/body_scroll_lock'
 import {
-  instanceDefaultConfig,
+  instanceDefaultConfigDefinitions,
-  instanceIdentityDefaultDefinition,
+  instanceIdentityDefaultDefinitions,
 } from 'src/modules/default_config_state.js'
 
 let staticInitialResults = null
@@ -171,18 +171,19 @@ const setSettings = async ({ apiConfig, staticConfig, store }) => {
 
   const copyInstanceOption = ({ source, definition = { required: true }, destination }) => {
     const value = config[source]
-    const { required, type } = definition
+    let { required, type, default: defaultValue } = definition
+    if (type == null && defaultValue != null) type = typeof defaultValue
     if (required && value == null) return
     if (type != null && typeof value !== type) return
 
     useInstanceStore().set({ path: destination, value })
   }
 
-  Object.entries(instanceIdentityDefaultDefinition)
+  Object.entries(instanceIdentityDefaultDefinitions)
     .map(([source, definition]) => ({ source, definition, destination: `instanceIdentity.${source}` }))
     .forEach(copyInstanceOption)
-  Object.keys(instanceDefaultConfig)
+  Object.keys(instanceDefaultConfigDefinitions)
-    .map((source) => ({ source, destination: `prefsStorage.${source}` }))
+    .map(([source, definition]) => ({ source, definition, destination: `prefsStorage.${source}` }))
     .forEach(copyInstanceOption)
 
   useAuthFlowStore().setInitialStrategy(config.loginMethod)

src/modules/default_config_state.js

@@ -1,9 +1,16 @@
 const browserLocale = (navigator.language || 'en').split('-')[0]
 
+const convertDefinitions = definitions => Object.fromEntries(
+  Object.entries(definitions).map(([k, v]) => [
+    k,
+    v.default == null ? null : v.default,
+  ]),
+)
+
 /// Instance config entries provided by static config or pleroma api
 /// Put settings here only if it does not make sense for a normal user
 /// to override it.
-export const instanceIdentityDefaultDefinition = {
+export const instanceIdentityDefaultDefinitions = {
   style: {
     description: 'Instance default style name',
     type: 'string',
@@ -103,142 +110,405 @@ export const instanceIdentityDefaultDefinition = {
     required: false,
   },
 }
-export const instanceIdentityDefault = Object.fromEntries(
+export const instanceIdentityDefault = convertDefinitions(instanceIdentityDefaultDefinitions)
-  Object.entries(instanceIdentityDefaultDefinition).map(([k, v]) => [
-    k,
-    v.default == null ? null : v.default,
-  ]),
-)
 
 /// This object contains setting entries that makes sense
 /// at the user level. The defaults can also be overriden by
 /// instance admins in the frontend_configuration endpoint or static config.
-export const instanceDefaultConfig = {
+export const instanceDefaultConfigDefinitions = {
-  expertLevel: 0, // used to track which settings to show and hide
+  expertLevel: {
-  hideISP: false,
+    description: 'Used to track which settings to show and hide in settings modal',
-  hideInstanceWallpaper: false,
+    type: 'number', // not a boolean so we could potentially make multiple levels of expert-ness
-  hideShoutbox: false,
+    default: 0,
-  // bad name: actually hides posts of muted USERS
+  },
-  hideMutedPosts: false,
+  hideISP: {
-  hideMutedThreads: true,
+    description: 'Hide Instance-specific panel',
-  hideWordFilteredPosts: false,
+    default: false,
-  muteBotStatuses: false,
+  },
-  muteSensitiveStatuses: false,
+  hideInstanceWallpaper: {
-  collapseMessageWithSubject: false,
+    description: 'Hide Instance default background',
-  padEmoji: true,
+    default: false,
-  hideAttachmentsInConv: false,
+  },
-  hideScrobbles: false,
+  hideShoutbox: {
-  hideScrobblesAfter: '2d',
+    description: 'Hide shoutbox if present',
-  maxThumbnails: 16,
+    default: false,
-  loopVideo: true,
+  },
-  loopVideoSilentOnly: true,
+  hideMutedPosts: { // bad name
+    description: 'Hide posts of muted users entirely',
+    default: false,
+  },
+  hideMutedThreads: {
+    description: 'Hide muted threads entirely',
+    default: true,
+  },
+  hideWordFilteredPosts: {
+    description: 'Hide wordfiltered posts entirely',
+    default: false,
+  },
+  muteBotStatuses: {
+    description: 'Mute posts made by bots',
+    default: false,
+  },
+  muteSensitiveStatuses: {
+    description: 'Mute posts marked as NSFW',
+    default: false,
+  },
+  collapseMessageWithSubject: {
+    description: 'Collapse posts with subject',
+    default: false,
+  },
+  padEmoji: {
+    description: 'Pad emoji with spaces when using emoji picker',
+    default: true,
+  },
+  hideAttachmentsInConv: {
+    description: 'Hide attachments',
+    default: false,
+  },
+  hideScrobbles: {
+    description: 'Hide scrobbles',
+    default: false,
+  },
+  hideScrobblesAfter: {
+    description: 'Hide scrobbles older than',
+    default: '2d',
+  },
+  maxThumbnails: {
+    description: 'Maximum attachments to show',
+    default: 16,
+  },
+  loopVideo: {
+    description: 'Loop videos',
+    default: true,
+  },
+  loopVideoSilentOnly: {
+    description: 'Loop only videos without sound',
+    default: true,
+  },
   /// This is not the streaming API configuration, but rather an option
   /// for automatically loading new posts into the timeline without
   /// the user clicking the Show New button.
-  streaming: false,
+  streaming: {
-  emojiReactionsOnTimeline: true,
+    description: 'Automatically show new posts',
-  alwaysShowNewPostButton: false,
+    default: false,
-  autohideFloatingPostButton: false,
+  },
-  pauseOnUnfocused: true,
+  pauseOnUnfocused: {
-  stopGifs: true,
+    description: 'Pause showing new posts when tab is unfocused',
-  replyVisibility: 'all',
+    default: true,
-  thirdColumnMode: 'notifications',
+  },
+  emojiReactionsOnTimeline: {
+    description: 'Show emoji reactions on timeline',
+    default: true,
+  },
+  alwaysShowNewPostButton: {
+    description: 'Always show mobile "new post" button, even in desktop mode',
+    default: false,
+  },
+  autohideFloatingPostButton: {
+    description: 'Automatically hide mobile "new post" button when scrolling down',
+    default: false,
+  },
+  stopGifs: {
+    description: 'Play animated gifs on hover only',
+    default: true,
+  },
+  replyVisibility: {
+    description: 'Type of replies to show',
+    default: 'all',
+  },
+  thirdColumnMode: {
+    description: 'What to display in third column',
+    default: 'notifications',
+  },
   notificationVisibility: {
-    follows: true,
+    description: 'What types of notifications to show',
-    mentions: true,
+    default: {
-    statuses: true,
+      follows: true,
-    likes: true,
+      mentions: true,
-    repeats: true,
+      statuses: true,
-    moves: true,
+      likes: true,
-    emojiReactions: true,
+      repeats: true,
-    followRequest: true,
+      moves: true,
-    reports: true,
+      emojiReactions: true,
-    chatMention: true,
+      followRequest: true,
-    polls: true,
+      reports: true,
+      chatMention: true,
+      polls: true,
+    },
   },
   notificationNative: {
-    follows: true,
+    description: 'What type of notifications to show desktop notification for',
-    mentions: true,
+    default: {
-    statuses: true,
+      follows: true,
-    likes: false,
+      mentions: true,
-    repeats: false,
+      statuses: true,
-    moves: false,
+      likes: false,
-    emojiReactions: false,
+      repeats: false,
-    followRequest: true,
+      moves: false,
-    reports: true,
+      emojiReactions: false,
-    chatMention: true,
+      followRequest: true,
-    polls: true,
+      reports: true,
+      chatMention: true,
+      polls: true,
+    },
+  },
+  webPushNotifications: {
+    description: 'Use WebPush',
+    default: false,
+  },
+  webPushAlwaysShowNotifications: {
+    description: 'Ignore filter when using WebPush',
+    default: false,
+  },
+  interfaceLanguage: {
+    description: 'UI language',
+    default: browserLocale,
+  },
+  hideScopeNotice: {
+    description: 'Hide scope notification',
+    default: false,
+  },
+  scopeCopy: {
+    description: 'Copy scope like mastodon does',
+    default: true,
+  },
+  subjectLineBehavior: {
+    description: 'How to treat subject line',
+    default: 'email',
+  },
+  alwaysShowSubjectInput: {
+    description: 'Always show subject line field',
+    default: true,
+  },
+  minimalScopesMode: {
+    description: 'Minimize amount of options shown in scope selector',
+    default: false,
   },
-  webPushNotifications: false,
-  webPushAlwaysShowNotifications: false,
-  interfaceLanguage: browserLocale,
-  hideScopeNotice: false,
-  scopeCopy: true,
-  subjectLineBehavior: 'email',
-  alwaysShowSubjectInput: true,
-  minimalScopesMode: false,
 
   // This hides statuses filtered via a word filter
-  hideFilteredStatuses: false,
+  hideFilteredStatuses: {
+    description: 'Hide wordfiltered entirely',
+    default: false,
+  },
 
   // Confirmations
-  modalOnRepeat: false,
+  modalOnRepeat: {
-  modalOnUnfollow: false,
+    description: 'Show confirmation modal for repeat',
-  modalOnBlock: true,
+    default: false,
-  modalOnMute: false,
+  },
-  modalOnMuteConversation: false,
+  modalOnUnfollow: {
-  modalOnMuteDomain: true,
+    description: 'Show confirmation modal for unfollow',
-  modalOnDelete: true,
+    default: false,
-  modalOnLogout: true,
+  },
-  modalOnApproveFollow: false,
+  modalOnBlock: {
-  modalOnDenyFollow: false,
+    description: 'Show confirmation modal for block',
-  modalOnRemoveUserFromFollowers: false,
+    default: true,
+  },
+  modalOnMute: {
+    description: 'Show confirmation modal for mute',
+    default: false,
+  },
+  modalOnMuteConversation: {
+    description: 'Show confirmation modal for mute conversation',
+    default: false,
+  },
+  modalOnMuteDomain: {
+    description: 'Show confirmation modal for mute domain',
+    default: true,
+  },
+  modalOnDelete: {
+    description: 'Show confirmation modal for delete',
+    default: true,
+  },
+  modalOnLogout: {
+    description: 'Show confirmation modal for logout',
+    default: true,
+  },
+  modalOnApproveFollow: {
+    description: 'Show confirmation modal for approve follow',
+    default: false,
+  },
+  modalOnDenyFollow: {
+    description: 'Show confirmation modal for deny follow',
+    default: false,
+  },
+  modalOnRemoveUserFromFollowers: {
+    description: 'Show confirmation modal for follower removal',
+    default: false,
+  },
 
   // Expiry confirmations/default actions
-  onMuteDefaultAction: 'ask',
+  onMuteDefaultAction: {
-  onBlockDefaultAction: 'ask',
+    description: 'Default action when muting user',
+    default: 'ask',
+  },
+  onBlockDefaultAction: {
+    description: 'Default action when blocking user',
+    default: 'ask',
+  },
 
-  modalMobileCenter: false,
+  modalMobileCenter: {
-  playVideosInModal: false,
+    description: 'Center mobile dialogs vertically',
-  useContainFit: true,
+    default: false,
-  disableStickyHeaders: false,
+  },
-  showScrollbars: false,
+  playVideosInModal: {
-  userPopoverAvatarAction: 'open',
+    description: 'Play videos in gallery view',
-  userPopoverOverlay: false,
+    default: false,
-  userCardLeftJustify: false,
+  },
-  userCardHidePersonalMarks: false,
+  useContainFit: {
-  forcedRoundness: -1,
+    description: 'Use object-fit: contain for attachments',
-  greentext: false,
+    default: true,
-  mentionLinkShowTooltip: true,
+  },
-  mentionLinkShowAvatar: false,
+  disableStickyHeaders: {
-  mentionLinkFadeDomain: true,
+    description: 'Disable sticky headers',
-  mentionLinkShowYous: false,
+    default: false,
-  mentionLinkBoldenYou: true,
+  },
-  hidePostStats: false,
+  showScrollbars: {
-  hideBotIndication: false,
+    description: 'Always show scrollbars',
-  hideUserStats: false,
+    default: false,
-  virtualScrolling: true,
+  },
-  sensitiveByDefault: false,
+  userPopoverAvatarAction: {
-  conversationDisplay: 'linear',
+    description: 'What to do when clicking popover avatar',
-  conversationTreeAdvanced: false,
+    default: 'open',
-  conversationOtherRepliesButton: 'below',
+  },
-  conversationTreeFadeAncestors: false,
+  userPopoverOverlay: {
-  showExtraNotifications: true,
+    description: 'Overlay user popover with centering on avatar',
-  showExtraNotificationsTip: true,
+    default: false,
-  showChatsInExtraNotifications: true,
+  },
-  showAnnouncementsInExtraNotifications: true,
+  userCardLeftJustify: {
-  showFollowRequestsInExtraNotifications: true,
+    description: 'Justify user bio to the left',
-  maxDepthInThread: 6,
+    default: false,
-  autocompleteSelect: false,
+  },
-  closingDrawerMarksAsSeen: true,
+  userCardHidePersonalMarks: {
-  unseenAtTop: false,
+    description: 'Hide highlight/personal note in user view',
-  ignoreInactionableSeen: false,
+    default: false,
-  unsavedPostAction: 'confirm',
+  },
-  autoSaveDraft: false,
+  forcedRoundness: {
-  useAbsoluteTimeFormat: false,
+    description: 'Force roundness of the theme',
-  absoluteTimeFormatMinAge: '0d',
+    default: -1,
-  absoluteTime12h: '24h',
+  },
+  greentext: {
+    description: 'Highlight plaintext >quotes',
+    default: false,
+  },
+  mentionLinkShowTooltip: {
+    description: 'Show tooltips for mention links',
+    default: true,
+  },
+  mentionLinkShowAvatar: {
+    description: 'Show avatar next to mention link',
+    default: false,
+  },
+  mentionLinkFadeDomain: {
+    description: 'Mute (fade) domain name in mention links if configured to show it',
+    default: true,
+  },
+  mentionLinkShowYous: {
+    description: 'Show (you)s when you are mentioned',
+    default: false,
+  },
+  mentionLinkBoldenYou: {
+    description: 'Boldern mentionlink of you',
+    default: true,
+  },
+  hidePostStats: {
+    description: 'Hide post stats (rt, favs)',
+    default: false,
+  },
+  hideBotIndication: {
+    description: 'Hide bot indicator',
+    default: false,
+  },
+  hideUserStats: {
+    description: 'Hide user stats (followers etc)',
+    default: false,
+  },
+  virtualScrolling: {
+    description: 'Timeline virtual scrolling',
+    default: true,
+  },
+  sensitiveByDefault: {
+    description: 'Assume attachments are NSFW by default',
+    default: false,
+  },
+  conversationDisplay: {
+    description: 'Style of conversation display',
+    default: 'linear',
+  },
+  conversationTreeAdvanced: {
+    description: 'Advanced features of tree view conversation',
+    default: false,
+  },
+  conversationOtherRepliesButton: {
+    description: 'Where to show "other replies" in tree conversation view',
+    default: 'below',
+  },
+  conversationTreeFadeAncestors: {
+    description: 'Fade ancestors in tree conversation view',
+    default: false,
+  },
+  showExtraNotifications: {
+    description: 'Show extra notifications (chats, announcements etc) in notification panel',
+    default: true,
+  },
+  showExtraNotificationsTip: {
+    description: 'Show tip for extra notifications (that user can remove them)',
+    default: true,
+  },
+  showChatsInExtraNotifications: {
+    description: 'Show chat messages in notifications',
+    default: true,
+  },
+  showAnnouncementsInExtraNotifications: {
+    description: 'Show announcements in notifications',
+    default: true,
+  },
+  showFollowRequestsInExtraNotifications: {
+    description: 'Show follow requests in notifications',
+    default: true,
+  },
+  maxDepthInThread: {
+    description: 'Maximum depth in tree conversation view',
+    default: 6,
+  },
+  autocompleteSelect: {
+    description: '',
+    default: false,
+  },
+  closingDrawerMarksAsSeen: {
+    description: 'Closing mobile notification pane marks everything as seen',
+    default: true,
+  },
+  unseenAtTop: {
+    description: 'Show unseen notifications above others',
+    default: false,
+  },
+  ignoreInactionableSeen: {
+    description: 'Treat inactionable (fav, rt etc) notifications as "seen"',
+    default: false,
+  },
+  unsavedPostAction: {
+    description: 'What to do if post is aborted',
+    default: 'confirm',
+  },
+  autoSaveDraft: {
+    description: 'Save drafts automatically',
+    default: false,
+  },
+  useAbsoluteTimeFormat: {
+    description: 'Use absolute time format',
+    default: false,
+  },
+  absoluteTimeFormatMinAge: {
+    description: 'Show absolute time format only after this post age',
+    default: '0d',
+  },
+  absoluteTime12h: {
+    description: 'Use 24h time format',
+    default: '24h',
+  },
 }
+export const instanceDefaultConfig = convertDefinitions(instanceDefaultConfigDefinitions)
 
 export const defaultConfigLocal = {
   hideAttachments: false,