diff --git a/app/soapbox/normalizers/account.ts b/app/soapbox/normalizers/account.ts index 04d3a8b52..7faa3282c 100644 --- a/app/soapbox/normalizers/account.ts +++ b/app/soapbox/normalizers/account.ts @@ -1,3 +1,8 @@ +/** + * Account normalizer: + * Converts API accounts into our internal format. + * @see {@link https://docs.joinmastodon.org/entities/account/} + */ import escapeTextContentForBrowser from 'escape-html'; import { Map as ImmutableMap, diff --git a/app/soapbox/normalizers/emoji.ts b/app/soapbox/normalizers/emoji.ts index 4a5bb4941..f450af253 100644 --- a/app/soapbox/normalizers/emoji.ts +++ b/app/soapbox/normalizers/emoji.ts @@ -1,3 +1,8 @@ +/** + * Emoji normalizer: + * Converts API emojis into our internal format. + * @see {@link https://docs.joinmastodon.org/entities/emoji/} + */ import { Record as ImmutableRecord, Map as ImmutableMap } from 'immutable'; // https://docs.joinmastodon.org/entities/emoji/ diff --git a/app/soapbox/normalizers/instance.ts b/app/soapbox/normalizers/instance.ts index 1ae2801d3..8e0fe02a6 100644 --- a/app/soapbox/normalizers/instance.ts +++ b/app/soapbox/normalizers/instance.ts @@ -1,3 +1,8 @@ +/** + * Instance normalizer: + * Converts API instances into our internal format. + * @see {@link https://docs.joinmastodon.org/entities/instance/} + */ import { Map as ImmutableMap, List as ImmutableList, @@ -9,6 +14,7 @@ import { mergeDefined } from 'soapbox/utils/normalizers'; import { isNumber } from 'soapbox/utils/numbers'; // Use Mastodon defaults +// https://docs.joinmastodon.org/entities/instance/ const InstanceRecord = ImmutableRecord({ approval_required: false, contact_account: ImmutableMap(), diff --git a/app/soapbox/normalizers/notification.ts b/app/soapbox/normalizers/notification.ts index ab369a52b..e0f466618 100644 --- a/app/soapbox/normalizers/notification.ts +++ b/app/soapbox/normalizers/notification.ts @@ -1,3 +1,8 @@ +/** + * Notification normalizer: + * Converts API notifications into our internal format. + * @see {@link https://docs.joinmastodon.org/entities/notification/} + */ import { Map as ImmutableMap, Record as ImmutableRecord, diff --git a/app/soapbox/normalizers/status.ts b/app/soapbox/normalizers/status.ts index 90bb27d37..760f53b92 100644 --- a/app/soapbox/normalizers/status.ts +++ b/app/soapbox/normalizers/status.ts @@ -1,3 +1,8 @@ +/** + * Status normalizer: + * Converts API statuses into our internal format. + * @see {@link https://docs.joinmastodon.org/entities/status/} + */ import escapeTextContentForBrowser from 'escape-html'; import { Map as ImmutableMap, @@ -11,6 +16,7 @@ import { normalizeEmoji } from 'soapbox/normalizers/emoji'; import { IStatus } from 'soapbox/types'; import { mergeDefined, makeEmojiMap } from 'soapbox/utils/normalizers'; +// https://docs.joinmastodon.org/entities/status/ const StatusRecord = ImmutableRecord({ account: null, application: null, @@ -99,7 +105,6 @@ const PollOptionRecord = ImmutableRecord({ }); // Ensure attachments have required fields -// https://docs.joinmastodon.org/entities/attachment/ const normalizeAttachment = (attachment: ImmutableMap) => { const url = [ attachment.get('url'),