Disroot/Mangane
5
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity

Features: sort keys alphabetically

Browse source
This commit is contained in:
Alex Gleason 2022-04-23 15:54:57 -05:00
parent ab2e6b2ee3
commit 677327336f
No known key found for this signature in database
GPG key ID: 7211D1F99744FBB7
1 changed files with 248 additions and 247 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

495
app/soapbox/utils/features.ts
View file

@ -1,3 +1,4 @@
/* eslint sort-keys: "error" */
import { List as ImmutableList, Map as ImmutableMap } from 'immutable'; import { List as ImmutableList, Map as ImmutableMap } from 'immutable';
import { createSelector } from 'reselect'; import { createSelector } from 'reselect';
import gte from 'semver/functions/gte'; import gte from 'semver/functions/gte';
@ -51,49 +52,80 @@ const getInstanceFeatures = (instance: Instance) => {
return { return {
/** /**
* Can upload media attachments to statuses. * Can view and manage ActivityPub aliases through the API.
* @see POST /api/v1/media * @see GET /api/pleroma/aliases
* @see POST /api/v1/statuses * @see PATCH /api/v1/accounts/update_credentials
*/ */
media: true, accountAliasesAPI: v.software === PLEROMA,
/** /**
* Can set privacy scopes on statuses. * The accounts API allows an acct instead of an ID.
* @see POST /api/v1/statuses * @see GET /api/v1/accounts/:acct_or_id
*/ */
privacyScopes: v.software !== TRUTHSOCIAL, accountByUsername: v.software === PLEROMA,
/** /**
* Can set content warnings on statuses. * Ability to pin other accounts on one's profile.
* @see POST /api/v1/statuses * @see POST /api/v1/accounts/:id/pin
* @see POST /api/v1/accounts/:id/unpin
* @see GET /api/v1/pleroma/accounts/:id/endorsements
*/ */
spoilers: v.software !== TRUTHSOCIAL, accountEndorsements: v.software === PLEROMA && gte(v.version, '2.4.50'),
/** /**
* Can edit and manage timeline filters (aka "muted words"). * Ability to set one's location on their profile.
* @see {@link https://docs.joinmastodon.org/methods/accounts/filters/} * @see PATCH /api/v1/accounts/update_credentials
*/ */
filters: v.software !== TRUTHSOCIAL, accountLocation: v.software === TRUTHSOCIAL,
/** /**
* Can add polls to statuses. * Look up an account by the acct.
* @see POST /api/v1/statuses * @see GET /api/v1/accounts/lookup
*/ */
polls: any([ accountLookup: any([
v.software === MASTODON && gte(v.version, '2.8.0'), v.software === MASTODON && gte(v.compatVersion, '3.4.0'),
v.software === PLEROMA, v.software === PLEROMA && gte(v.version, '2.4.50'),
]), ]),
/** /**
* Can schedule statuses to be posted at a later time. * Move followers to a different ActivityPub account.
* @see POST /api/v1/statuses * @see POST /api/pleroma/move_account
* @see {@link https://docs.joinmastodon.org/methods/statuses/scheduled_statuses/}
*/ */
scheduledStatuses: any([ accountMoving: v.software === PLEROMA && gte(v.version, '2.4.50'),
v.software === MASTODON && gte(v.version, '2.7.0'),
v.software === PLEROMA, /**
* Ability to subscribe to notifications every time an account posts.
* @see POST /api/v1/accounts/:id/follow
*/
accountNotifies: any([
v.software === MASTODON && gte(v.compatVersion, '3.3.0'),
v.software === PLEROMA && gte(v.version, '2.4.50'),
]), ]),
/**
* Ability to subscribe to notifications every time an account posts.
* @see POST /api/v1/pleroma/accounts/:id/subscribe
* @see POST /api/v1/pleroma/accounts/:id/unsubscribe
*/
accountSubscriptions: v.software === PLEROMA && gte(v.version, '1.0.0'),
/**
* Ability to set one's website on their profile.
* @see PATCH /api/v1/accounts/update_credentials
*/
accountWebsite: v.software === TRUTHSOCIAL,
/**
* Set your birthday and view upcoming birthdays.
* @see GET /api/v1/pleroma/birthdays
* @see POST /api/v1/accounts
* @see PATCH /api/v1/accounts/update_credentials
*/
birthdays: v.software === PLEROMA && gte(v.version, '2.4.50'),
/** Whether people who blocked you are visible through the API. */
blockersVisible: features.includes('blockers_visible'),
/** /**
* Can bookmark statuses. * Can bookmark statuses.
* @see POST /api/v1/statuses/:id/bookmark * @see POST /api/v1/statuses/:id/bookmark
@ -106,66 +138,30 @@ const getInstanceFeatures = (instance: Instance) => {
]), ]),
/** /**
* Can create, view, and manage lists. * Pleroma chats API.
* @see {@link https://docs.joinmastodon.org/methods/timelines/lists/} * @see {@link https://docs.pleroma.social/backend/development/API/chats/}
* @see GET /api/v1/timelines/list/:list_id
*/ */
lists: any([ chats: v.software === PLEROMA && gte(v.version, '2.1.0'),
v.software === MASTODON && gte(v.compatVersion, '2.1.0'),
/**
* Paginated chats API.
* @see GET /api/v2/chats
*/
chatsV2: v.software === PLEROMA && gte(v.version, '2.3.0'),
/**
* Mastodon's newer solution for direct messaging.
* @see {@link https://docs.joinmastodon.org/methods/timelines/conversations/}
*/
conversations: any([
v.software === MASTODON && gte(v.compatVersion, '2.6.0'),
v.software === PLEROMA && gte(v.version, '0.9.9'), v.software === PLEROMA && gte(v.version, '0.9.9'),
v.software === PIXELFED,
]), ]),
/** // FIXME: long-term this shouldn't be a feature,
* Can display suggested accounts. // but for now we want it to be overrideable in the build
* @see {@link https://docs.joinmastodon.org/methods/accounts/suggestions/} darkMode: true,
*/
suggestions: any([
v.software === MASTODON && gte(v.compatVersion, '2.4.3'),
v.software === TRUTHSOCIAL,
features.includes('v2_suggestions'),
]),
/**
* Supports V2 suggested accounts.
* @see GET /api/v2/suggestions
*/
suggestionsV2: any([
v.software === MASTODON && gte(v.compatVersion, '3.4.0'),
v.software === TRUTHSOCIAL,
features.includes('v2_suggestions'),
]),
/** Whether people who blocked you are visible through the API. */
blockersVisible: features.includes('blockers_visible'),
/**
* Can display trending hashtags.
* @see GET /api/v1/trends
*/
trends: any([
v.software === MASTODON && gte(v.compatVersion, '3.0.0'),
v.software === TRUTHSOCIAL,
]),
/**
* Supports V2 media uploads.
* @see POST /api/v2/media
*/
mediaV2: any([
v.software === MASTODON && gte(v.compatVersion, '3.1.3'),
// Even though Pleroma supports these endpoints, it has disadvantages
// v.software === PLEROMA && gte(v.version, '2.1.0'),
]),
/**
* Can display a timeline of all known public statuses.
* Local and Fediverse timelines both use this feature.
* @see GET /api/v1/timelines/public
*/
publicTimeline: any([
v.software === MASTODON,
v.software === PLEROMA,
]),
/** /**
* Legacy DMs timeline where messages are displayed chronologically without groupings. * Legacy DMs timeline where messages are displayed chronologically without groupings.
@ -177,14 +173,14 @@ const getInstanceFeatures = (instance: Instance) => {
]), ]),
/** /**
* Mastodon's newer solution for direct messaging. * Soapbox email list.
* @see {@link https://docs.joinmastodon.org/methods/timelines/conversations/} * @see POST /api/v1/accounts
* @see PATCH /api/v1/accounts/update_credentials
* @see GET /api/v1/pleroma/admin/email_list/subscribers.csv
* @see GET /api/v1/pleroma/admin/email_list/unsubscribers.csv
* @see GET /api/v1/pleroma/admin/email_list/combined.csv
*/ */
conversations: any([ emailList: features.includes('email_list'),
v.software === MASTODON && gte(v.compatVersion, '2.6.0'),
v.software === PLEROMA && gte(v.version, '0.9.9'),
v.software === PIXELFED,
]),
/** /**
* Ability to add emoji reactions to a status. * Ability to add emoji reactions to a status.
@ -200,12 +196,45 @@ const getInstanceFeatures = (instance: Instance) => {
*/ */
emojiReactsRGI: v.software === PLEROMA && gte(v.version, '2.2.49'), emojiReactsRGI: v.software === PLEROMA && gte(v.version, '2.2.49'),
/**
* Sign in with an Ethereum wallet.
* @see POST /oauth/token
*/
ethereumLogin: v.software === MITRA,
/**
* Ability to address recipients of a status explicitly (with `to`).
* @see POST /api/v1/statuses
*/
explicitAddressing: any([
v.software === PLEROMA && gte(v.version, '1.0.0'),
v.software === TRUTHSOCIAL,
]),
/** Whether the accounts who favourited or emoji-reacted to a status can be viewed through the API. */
exposableReactions: features.includes('exposable_reactions'),
/** Whether the instance federates. */
federating: federation.get('enabled', true) === true, // Assume true unless explicitly false
/**
* Can edit and manage timeline filters (aka "muted words").
* @see {@link https://docs.joinmastodon.org/methods/accounts/filters/}
*/
filters: v.software !== TRUTHSOCIAL,
/** /**
* Allows setting the focal point of a media attachment. * Allows setting the focal point of a media attachment.
* @see {@link https://docs.joinmastodon.org/methods/statuses/media/} * @see {@link https://docs.joinmastodon.org/methods/statuses/media/}
*/ */
focalPoint: v.software === MASTODON && gte(v.compatVersion, '2.3.0'), focalPoint: v.software === MASTODON && gte(v.compatVersion, '2.3.0'),
/**
* Whether client settings can be retrieved from the API.
* @see GET /api/pleroma/frontend_configurations
*/
frontendConfigurations: v.software === PLEROMA,
/** /**
* Pleroma import API. * Pleroma import API.
* @see POST /api/pleroma/follow_import * @see POST /api/pleroma/follow_import
@ -221,26 +250,115 @@ const getInstanceFeatures = (instance: Instance) => {
importMutes: v.software === PLEROMA && gte(v.version, '2.2.0'), importMutes: v.software === PLEROMA && gte(v.version, '2.2.0'),
/** /**
* Soapbox email list. * Can create, view, and manage lists.
* @see POST /api/v1/accounts * @see {@link https://docs.joinmastodon.org/methods/timelines/lists/}
* @see PATCH /api/v1/accounts/update_credentials * @see GET /api/v1/timelines/list/:list_id
* @see GET /api/v1/pleroma/admin/email_list/subscribers.csv
* @see GET /api/v1/pleroma/admin/email_list/unsubscribers.csv
* @see GET /api/v1/pleroma/admin/email_list/combined.csv
*/ */
emailList: features.includes('email_list'), lists: any([
v.software === MASTODON && gte(v.compatVersion, '2.1.0'),
v.software === PLEROMA && gte(v.version, '0.9.9'),
]),
/** /**
* Pleroma chats API. * Can upload media attachments to statuses.
* @see {@link https://docs.pleroma.social/backend/development/API/chats/} * @see POST /api/v1/media
* @see POST /api/v1/statuses
*/ */
chats: v.software === PLEROMA && gte(v.version, '2.1.0'), media: true,
/** /**
* Paginated chats API. * Supports V2 media uploads.
* @see GET /api/v2/chats * @see POST /api/v2/media
*/ */
chatsV2: v.software === PLEROMA && gte(v.version, '2.3.0'), mediaV2: any([
v.software === MASTODON && gte(v.compatVersion, '3.1.3'),
// Even though Pleroma supports these endpoints, it has disadvantages
// v.software === PLEROMA && gte(v.version, '2.1.0'),
]),
/**
* Add private notes to accounts.
* @see POST /api/v1/accounts/:id/note
* @see GET /api/v1/accounts/relationships
*/
notes: any([
v.software === MASTODON && gte(v.compatVersion, '3.2.0'),
v.software === PLEROMA && gte(v.version, '2.4.50'),
]),
/** Truth Social account registration API. */
pepe: v.software === TRUTHSOCIAL,
/**
* Can add polls to statuses.
* @see POST /api/v1/statuses
*/
polls: any([
v.software === MASTODON && gte(v.version, '2.8.0'),
v.software === PLEROMA,
]),
/**
* Can set privacy scopes on statuses.
* @see POST /api/v1/statuses
*/
privacyScopes: v.software !== TRUTHSOCIAL,
/**
* A directory of discoverable profiles from the instance.
* @see {@link https://docs.joinmastodon.org/methods/instance/directory/}
*/
profileDirectory: any([
v.software === MASTODON && gte(v.compatVersion, '3.0.0'),
features.includes('profile_directory'),
]),
/**
* Can display a timeline of all known public statuses.
* Local and Fediverse timelines both use this feature.
* @see GET /api/v1/timelines/public
*/
publicTimeline: any([
v.software === MASTODON,
v.software === PLEROMA,
]),
/**
* Ability to quote posts in statuses.
* @see POST /api/v1/statuses
*/
quotePosts: any([
v.software === PLEROMA && gte(v.version, '2.4.50'),
instance.feature_quote === true,
]),
/**
* Interact with statuses from another instance while logged-out.
* @see POST /api/v1/pleroma/remote_interaction
*/
remoteInteractionsAPI: v.software === PLEROMA && gte(v.version, '2.4.50'),
/**
* Can request a password reset email through the API.
* @see POST /auth/password
*/
resetPasswordAPI: v.software === PLEROMA,
/**
* Ability to post statuses in Markdown, BBCode, and HTML.
* @see POST /api/v1/statuses
*/
richText: v.software === PLEROMA,
/**
* Can schedule statuses to be posted at a later time.
* @see POST /api/v1/statuses
* @see {@link https://docs.joinmastodon.org/methods/statuses/scheduled_statuses/}
*/
scheduledStatuses: any([
v.software === MASTODON && gte(v.version, '2.7.0'),
v.software === PLEROMA,
]),
/** /**
* List of OAuth scopes supported by both Soapbox and the backend. * List of OAuth scopes supported by both Soapbox and the backend.
@ -249,15 +367,6 @@ const getInstanceFeatures = (instance: Instance) => {
*/ */
scopes: v.software === PLEROMA ? 'read write follow push admin' : 'read write follow push', scopes: v.software === PLEROMA ? 'read write follow push admin' : 'read write follow push',
/** Whether the instance federates. */
federating: federation.get('enabled', true) === true, // Assume true unless explicitly false
/**
* Ability to post statuses in Markdown, BBCode, and HTML.
* @see POST /api/v1/statuses
*/
richText: v.software === PLEROMA,
/** /**
* Ability to manage account security settings. * Ability to manage account security settings.
* @see POST /api/pleroma/change_password * @see POST /api/pleroma/change_password
@ -279,128 +388,36 @@ const getInstanceFeatures = (instance: Instance) => {
]), ]),
/** /**
* Can view and manage ActivityPub aliases through the API. * Can set content warnings on statuses.
* @see GET /api/pleroma/aliases
* @see PATCH /api/v1/accounts/update_credentials
*/
accountAliasesAPI: v.software === PLEROMA,
/**
* Can request a password reset email through the API.
* @see POST /auth/password
*/
resetPasswordAPI: v.software === PLEROMA,
/** Whether the accounts who favourited or emoji-reacted to a status can be viewed through the API. */
exposableReactions: features.includes('exposable_reactions'),
/**
* Ability to subscribe to notifications every time an account posts.
* @see POST /api/v1/pleroma/accounts/:id/subscribe
* @see POST /api/v1/pleroma/accounts/:id/unsubscribe
*/
accountSubscriptions: v.software === PLEROMA && gte(v.version, '1.0.0'),
/**
* Ability to subscribe to notifications every time an account posts.
* @see POST /api/v1/accounts/:id/follow
*/
accountNotifies: any([
v.software === MASTODON && gte(v.compatVersion, '3.3.0'),
v.software === PLEROMA && gte(v.version, '2.4.50'),
]),
/**
* Whether the backend allows adding users you don't follow to lists.
* @see POST /api/v1/lists/:id/accounts
*/
unrestrictedLists: v.software === PLEROMA,
/**
* The accounts API allows an acct instead of an ID.
* @see GET /api/v1/accounts/:acct_or_id
*/
accountByUsername: v.software === PLEROMA,
/**
* A directory of discoverable profiles from the instance.
* @see {@link https://docs.joinmastodon.org/methods/instance/directory/}
*/
profileDirectory: any([
v.software === MASTODON && gte(v.compatVersion, '3.0.0'),
features.includes('profile_directory'),
]),
/**
* Look up an account by the acct.
* @see GET /api/v1/accounts/lookup
*/
accountLookup: any([
v.software === MASTODON && gte(v.compatVersion, '3.4.0'),
v.software === PLEROMA && gte(v.version, '2.4.50'),
]),
/**
* Interact with statuses from another instance while logged-out.
* @see POST /api/v1/pleroma/remote_interaction
*/
remoteInteractionsAPI: v.software === PLEROMA && gte(v.version, '2.4.50'),
/**
* Ability to address recipients of a status explicitly (with `to`).
* @see POST /api/v1/statuses * @see POST /api/v1/statuses
*/ */
explicitAddressing: any([ spoilers: v.software !== TRUTHSOCIAL,
v.software === PLEROMA && gte(v.version, '1.0.0'),
/**
* Can display suggested accounts.
* @see {@link https://docs.joinmastodon.org/methods/accounts/suggestions/}
*/
suggestions: any([
v.software === MASTODON && gte(v.compatVersion, '2.4.3'),
v.software === TRUTHSOCIAL, v.software === TRUTHSOCIAL,
features.includes('v2_suggestions'),
]), ]),
/** /**
* Ability to pin other accounts on one's profile. * Supports V2 suggested accounts.
* @see POST /api/v1/accounts/:id/pin * @see GET /api/v2/suggestions
* @see POST /api/v1/accounts/:id/unpin
* @see GET /api/v1/pleroma/accounts/:id/endorsements
*/ */
accountEndorsements: v.software === PLEROMA && gte(v.version, '2.4.50'), suggestionsV2: any([
v.software === MASTODON && gte(v.compatVersion, '3.4.0'),
/** v.software === TRUTHSOCIAL,
* Ability to quote posts in statuses. features.includes('v2_suggestions'),
* @see POST /api/v1/statuses
*/
quotePosts: any([
v.software === PLEROMA && gte(v.version, '2.4.50'),
instance.feature_quote === true,
]), ]),
/** /**
* Set your birthday and view upcoming birthdays. * Trending statuses.
* @see GET /api/v1/pleroma/birthdays * @see GET /api/v1/trends/statuses
* @see POST /api/v1/accounts
* @see PATCH /api/v1/accounts/update_credentials
*/ */
birthdays: v.software === PLEROMA && gte(v.version, '2.4.50'), trendingStatuses: v.software === MASTODON && gte(v.compatVersion, '3.5.0'),
/**
* Sign in with an Ethereum wallet.
* @see POST /oauth/token
*/
ethereumLogin: v.software === MITRA,
/**
* Move followers to a different ActivityPub account.
* @see POST /api/pleroma/move_account
*/
accountMoving: v.software === PLEROMA && gte(v.version, '2.4.50'),
/**
* Add private notes to accounts.
* @see POST /api/v1/accounts/:id/note
* @see GET /api/v1/accounts/relationships
*/
notes: any([
v.software === MASTODON && gte(v.compatVersion, '3.2.0'),
v.software === PLEROMA && gte(v.version, '2.4.50'),
]),
/** /**
* Truth Social trending statuses API. * Truth Social trending statuses API.
@ -409,35 +426,19 @@ const getInstanceFeatures = (instance: Instance) => {
trendingTruths: v.software === TRUTHSOCIAL, trendingTruths: v.software === TRUTHSOCIAL,
/** /**
* Trending statuses. * Can display trending hashtags.
* @see GET /api/v1/trends/statuses * @see GET /api/v1/trends
*/ */
trendingStatuses: v.software === MASTODON && gte(v.compatVersion, '3.5.0'), trends: any([
v.software === MASTODON && gte(v.compatVersion, '3.0.0'),
/** Truth Social account registration API. */ v.software === TRUTHSOCIAL,
pepe: v.software === TRUTHSOCIAL, ]),
/** /**
* Ability to set one's location on their profile. * Whether the backend allows adding users you don't follow to lists.
* @see PATCH /api/v1/accounts/update_credentials * @see POST /api/v1/lists/:id/accounts
*/ */
accountLocation: v.software === TRUTHSOCIAL, unrestrictedLists: v.software === PLEROMA,
/**
* Ability to set one's website on their profile.
* @see PATCH /api/v1/accounts/update_credentials
*/
accountWebsite: v.software === TRUTHSOCIAL,
/**
* Whether client settings can be retrieved from the API.
* @see GET /api/pleroma/frontend_configurations
*/
frontendConfigurations: v.software === PLEROMA,
// FIXME: long-term this shouldn't be a feature,
// but for now we want it to be overrideable in the build
darkMode: true,
}; };
}; };
@ -469,17 +470,17 @@ export const parseVersion = (version: string): Backend => {
if (match) { if (match) {
return { return {
compatVersion: match[1],
software: match[2] || MASTODON, software: match[2] || MASTODON,
version: match[3] || match[1], version: match[3] || match[1],
compatVersion: match[1],
}; };
} else { } else {
// If we can't parse the version, this is a new and exotic backend. // If we can't parse the version, this is a new and exotic backend.
// Fall back to minimal featureset. // Fall back to minimal featureset.
return { return {
compatVersion: '0.0.0',
software: null, software: null,
version: '0.0.0', version: '0.0.0',
compatVersion: '0.0.0',
}; };
} }
}; };