feat: Add source notices for language recognition.

vxern · Jun 23, 2024 · 2715e7f · 2715e7f
1 parent bd14523
commit 2715e7f
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 4 deletions.
diff --git a/assets/localisations/commands/eng-US.json b/assets/localisations/commands/eng-US.json
@@ -104,6 +104,7 @@
 	"recognise.strings.fields.possibleMatches.title": "Other options",
 	"recognise.strings.fields.possibleMatches.description.single": "The language is less likely to be {language}.",
 	"recognise.strings.fields.possibleMatches.description.multiple": "These choices are less likely, but the language could also be one of:",
+	"recognise.strings.recognitionsMadeBy": "Recognitions made by the above libraries.",
 	"game.name": "game",
 	"game.description": "Pick the correct word out of four to fit in the blank.",
 	"game.strings.sentence": "Sentence",

diff --git a/source/constants/contexts.ts b/source/constants/contexts.ts
@@ -868,6 +868,9 @@ export default Object.freeze({
 	translationsSourcedFrom: ({ localise, locale }) => ({
 		sourcedFrom: localise("translate.strings.sourcedFrom", locale),
 	}),
+	recognitionsMadeBy: ({ localise, locale }) => ({
+		recognitionsMadeBy: localise("recognise.strings.recognitionsMadeBy", locale)(),
+	}),
 	pardoned: ({ localise, locale }) => ({
 		title: localise("pardon.strings.pardoned.title", locale)(),
 		description: localise("pardon.strings.pardoned.description", locale),

diff --git a/source/library/adapters/detectors/adapter.ts b/source/library/adapters/detectors/adapter.ts
@@ -1,7 +1,7 @@
 import type { DetectionLanguage } from "logos:constants/languages";
+import type { Licence } from "logos:constants/licences.ts";
 import type { Client } from "logos/client";
 import { Logger } from "logos/logger";
-import type { Licence } from "logos:constants/licences.ts";
 
 interface SingleDetectionResult {
 	readonly language: DetectionLanguage;

diff --git a/source/library/commands/components/source-notices/recognition-notice.ts b/source/library/commands/components/source-notices/recognition-notice.ts
@@ -0,0 +1,20 @@
+import type { Licence } from "logos:constants/licences.ts";
+import type { Client } from "logos/client.ts";
+import { SourceNotice } from "logos/commands/components/source-notices/source-notice.ts";
+
+class RecognitionSourceNotice extends SourceNotice {
+	constructor(client: Client, { interaction, sources }: { interaction: Logos.Interaction; sources: Licence[] }) {
+		const strings = constants.contexts.recognitionsMadeBy({
+			localise: client.localise.bind(client),
+			locale: interaction.displayLocale,
+		});
+
+		super(client, {
+			interaction,
+			sources: sources.map((source) => `[${source.name}](${source.link})`),
+			notice: strings.recognitionsMadeBy,
+		});
+	}
+}
+
+export { RecognitionSourceNotice };
diff --git a/source/library/commands/handlers/recognise.ts b/source/library/commands/handlers/recognise.ts
@@ -1,6 +1,7 @@
 import type { DetectionLanguage } from "logos:constants/languages";
 import { list } from "logos:core/formatting";
 import type { Client } from "logos/client";
+import { RecognitionSourceNotice } from "logos/commands/components/source-notices/recognition-notice.ts";
 
 async function handleRecogniseLanguageChatInput(
 	client: Client,
@@ -69,6 +70,10 @@ async function handleRecogniseLanguage(
 		return;
 	}
 
+	const sourceNotice = new RecognitionSourceNotice(client, { interaction, sources: detectedLanguages.sources });
+
+	await sourceNotice.register();
+
 	if (detectedLanguages.likely.length === 1 && detectedLanguages.possible.length === 0) {
 		const language = detectedLanguages.likely.at(0) as DetectionLanguage | undefined;
 		if (language === undefined) {
@@ -79,8 +84,19 @@ async function handleRecogniseLanguage(
 			...constants.contexts.likelyMatch({ localise: client.localise.bind(client), locale: interaction.locale }),
 			...constants.contexts.language({ localise: client.localise.bind(client), locale: interaction.locale }),
 		};
+
 		await client.noticed(interaction, {
-			description: strings.description({ language: strings.language(language) }),
+			embeds: [
+				{
+					description: strings.description({ language: strings.language(language) }),
+				},
+			],
+			components: [
+				{
+					type: Discord.MessageComponentTypes.ActionRow,
+					components: [sourceNotice.button],
+				},
+			],
 		});
 		return;
 	}
@@ -160,7 +176,15 @@ async function handleRecogniseLanguage(
 			});
 		}
 
-		await client.noticed(interaction, { fields });
+		await client.noticed(interaction, {
+			embeds: [{ fields }],
+			components: [
+				{
+					type: Discord.MessageComponentTypes.ActionRow,
+					components: [sourceNotice.button],
+				},
+			],
+		});
 	}
 }
 

diff --git a/source/library/stores/adapters/detectors.ts b/source/library/stores/adapters/detectors.ts
@@ -1,11 +1,11 @@
 import type { DetectionLanguage, Detector } from "logos:constants/languages";
+import type { Licence } from "logos:constants/licences.ts";
 import type { DetectorAdapter, SingleDetectionResult } from "logos/adapters/detectors/adapter";
 import { CLDAdapter } from "logos/adapters/detectors/cld";
 import { ELDAdapter } from "logos/adapters/detectors/eld";
 import { FastTextAdapter } from "logos/adapters/detectors/fasttext";
 import { TinyLDAdapter } from "logos/adapters/detectors/tinyld";
 import type { Client } from "logos/client";
-import type { Licence } from "logos:constants/licences.ts";
 
 interface DetectionResult {
 	readonly likely: DetectionLanguage[];