Refactor Translator and dictionary entry format (#1553)

* Update test data

* Move translator.js

* Create new version of Translator

* Update Backend

* Update DictionaryDataUtil

* Update DisplayGenerator

* Create AnkiNoteDataCreator

* Replace AnkiNoteData with AnkiNoteDataCreator

* Update tests

* Remove AnkiNoteData

* Update test data

* Remove translator-old.js

* Add TypeScript interface definitions for the new translator data format

1 files changed, 402 insertions, 0 deletions

diff --git a/docs/interfaces/dictionary-entry.ts b/docs/interfaces/dictionary-entry.ts
new file mode 100644
index 00000000..6aaafbf8
--- /dev/null
+++ b/docs/interfaces/dictionary-entry.ts
@@ -0,0 +1,402 @@
+/*
+ * Copyright (C) 2021  Yomichan Authors
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+namespace Translation {
+    // Common
+
+    /**
+     * A generic dictionary entry which is used as the base interface.
+     */
+    export interface DictionaryEntry {
+        /**
+         * A string corresponding to the type of the entry.
+         * `'kanji'` corresponds to a KanjiDictionaryEntry.
+         * `'term'` corresponds to a TermDictionaryEntry.
+         */
+        type: string;
+    }
+
+    /**
+     * A tag represents some brief information about part of a dictionary entry.
+     */
+    export interface Tag {
+        /**
+         * The name of the tag.
+         */
+        name: string;
+        /**
+         * The category of the tag.
+         */
+        category: string;
+        /**
+         * A number indicating the sorting order of the tag.
+         */
+        order: number;
+        /**
+         * A score value for the tag.
+         */
+        score: number;
+        /**
+         * An array of descriptions for the tag. * If there are multiple entries,
+         * the values will typically have originated from different dictionaries.
+         * However, there is no correlation between the length of this array and
+         * the length of the `dictionaries` field, as duplicates are removed.
+         */
+        content: string[];
+        /**
+         * An array of dictionary names that contained a tag with this name and category.
+         */
+        dictionaries: string[];
+        /**
+         * Whether or not this tag is redundant with previous tags.
+         */
+        redundant: boolean;
+    }
+
+    // Kanji
+
+    /**
+     * A dictionary entry for a kanji character.
+     * `DictionaryEntry.type` is always `'kanji'`.
+     */
+    export interface KanjiDictionaryEntry extends DictionaryEntry {
+        /**
+         * The kanji character that was looked up.
+         */
+        character: string;
+        /**
+         * The name of the dictionary that the information originated from.
+         */
+        dictionary: string;
+        /**
+         * Onyomi readings for the kanji character.
+         */
+        onyomi: string[];
+        /**
+         * Kunyomi readings for the kanji character.
+         */
+        kunyomi: string[];
+        /**
+         * Tags for the kanji character.
+         */
+        tags: Tag[];
+        /**
+         * An object containing stats about the kanji character.
+         */
+        stats: KanjiStatGroups;
+        /**
+         * Definitions for the kanji character.
+         */
+        definitions: string[];
+        /**
+         * Frequency information for the kanji character.
+         */
+        frequencies: KanjiFrequency[];
+    }
+
+    /**
+     * An object with groups of stats about a kanji character.
+     */
+    export interface KanjiStatGroups {
+        /**
+         * A group of stats.
+         * @param propName The name of the group.
+         */
+        [propName: string]: KanjiStat[];
+    }
+
+    /**
+     * A stat represents a generic piece of information about a kanji character.
+     */
+    export interface KanjiStat {
+        /**
+         * The name of the stat.
+         */
+        name: string;
+        /**
+         * The category of the stat.
+         */
+        category: string;
+        /**
+         * A description of the stat.
+         */
+        content: string;
+        /**
+         * A number indicating the sorting order of the stat.
+         */
+        order: number;
+        /**
+         * A score value for the stat.
+         */
+        score: number;
+        /**
+         * The name of the dictionary that the stat originated from.
+         */
+        dictionary: string;
+        /**
+         * A value for the stat.
+         */
+        value: number | string;
+    }
+
+    /**
+     * Frequency information corresponds to how frequently a character appears in a corpus,
+     * which can be a number of occurrences or an overall rank.
+     */
+    export interface KanjiFrequency {
+        /**
+         * The original order of the frequency, which is usually used for sorting.
+         */
+        index: number;
+        /**
+         * The name of the dictionary that the frequency information originated from.
+         */
+        dictionary: string;
+        /**
+         * The index of the dictionary in the original list of dictionaries used for the lookup.
+         */
+        dictionaryIndex: number;
+        /**
+         * The priority of the dictionary.
+         */
+        dictionaryPriority: number;
+        /**
+         * The kanji character for the frequency.
+         */
+        character: string;
+        /**
+         * The frequency for the character, as a number of occurrences or an overall rank.
+         */
+        frequency: number | string;
+    }
+
+    // Terms
+
+    /**
+     * A dictionary entry for a term or group of terms.
+     * `DictionaryEntry.type` is always `'term'`.
+     */
+    export interface TermDictionaryEntry extends DictionaryEntry {
+        /**
+         * Database ID for the term, or `-1` if multiple entries have been merged.
+         */
+        id: number;
+        /**
+         * Whether or not any of the sources is a primary source. Primary sources are derived from the
+         * original search text, while non-primary sources originate from related terms.
+         */
+        isPrimary: boolean;
+        /**
+         * Database sequence number for the term, or `-1` if multiple entries have been merged.
+         */
+        sequence: number;
+        /**
+         * A list of inflections that was applied to get the term.
+         */
+        inflections: string[];
+        /**
+         * A score for the dictionary entry.
+         */
+        score: number;
+        /**
+         * The index of the dictionary in the original list of dictionaries used for the lookup.
+         */
+        dictionaryIndex: number;
+        /**
+         * The priority of the dictionary.
+         */
+        dictionaryPriority: number;
+        /**
+         * The number of primary sources that had an exact text match for the term.
+         */
+        sourceTermExactMatchCount: number;
+        /**
+         * The maximum deinflected text length of a primary source.
+         */
+        maxDeinflectedTextLength: number;
+        /**
+         * Headwords for the entry.
+         */
+        headwords: TermHeadword[];
+        /**
+         * Definitions for the entry.
+         */
+        definitions: TermDefinition[];
+        /**
+         * Pronunciations for the entry.
+         */
+        pronunciations: TermPronunciation[];
+        /**
+         * Frequencies for the entry.
+         */
+        frequencies: TermFrequency[];
+    }
+
+    /**
+     * A term headword is a combination of a term, reading, and auxiliary information.
+     */
+    export interface TermHeadword {
+        /**
+         * The original order of the headword, which is usually used for sorting.
+         */
+        index: number;
+        /**
+         * The text for the term.
+         */
+        term: string;
+        /**
+         * The reading of the term.
+         */
+        reading: string;
+        /**
+         * The sources of the term.
+         */
+        sources: TermSource[];
+        /**
+         * Tags for the headword.
+         */
+        tags: Tag[];
+    }
+
+    /**
+     * A definition contains a list of entries and information about what what terms it corresponds to.
+     */
+    export interface TermDefinition {
+        /**
+         * The original order of the definition, which is usually used for sorting.
+         */
+        index: number;
+        /**
+         * A list of headwords that this definition corresponds to.
+         */
+        headwordIndices: number[];
+        /**
+         * The name of the dictionary that the definition information originated from.
+         */
+        dictionary: string;
+        /**
+         * Tags for the definition.
+         */
+        tags: Tag[];
+        /**
+         * The definition entries.
+         */
+        entries: string[];
+    }
+
+    /**
+     * A term pronunciation represents different ways to pronounce one of the headwords.
+     */
+    export interface TermPronunciation {
+        /**
+         * The original order of the pronunciation, which is usually used for sorting.
+         */
+        index: number;
+        /**
+         * Which headword this pronunciation corresponds to.
+         */
+        headwordIndex: number;
+        /**
+         * The name of the dictionary that the proununciation information originated from.
+         */
+        dictionary: string;
+        /**
+         * The index of the dictionary in the original list of dictionaries used for the lookup.
+         */
+        dictionaryIndex: number;
+        /**
+         * The priority of the dictionary.
+         */
+        dictionaryPriority: number;
+        /**
+         * The pitch accent representations for the term.
+         */
+        pitches: TermPitch[];
+    }
+
+    /**
+     * Pitch accent information for a term, represented as the position of the downstep.
+     */
+    export interface TermPitch {
+        /**
+         * Position of the downstep, as a number of mora.
+         */
+        position: number;
+        /**
+         * Tags for the pitch accent.
+         */
+        tags: Tag[];
+    }
+
+    /**
+     * Frequency information corresponds to how frequently a term appears in a corpus,
+     * which can be a number of occurrences or an overall rank.
+     */
+    export interface TermFrequency {
+        /**
+         * The original order of the frequency, which is usually used for sorting.
+         */
+        index: number;
+        /**
+         * Which headword this frequency corresponds to.
+         */
+        headwordIndex: number;
+        /**
+         * The name of the dictionary that the frequency information originated from.
+         */
+        dictionary: string;
+        /**
+         * The index of the dictionary in the original list of dictionaries used for the lookup.
+         */
+        dictionaryIndex: number;
+        /**
+         * The priority of the dictionary.
+         */
+        dictionaryPriority: number;
+        /**
+         * Whether or not the frequency had an explicit reading specified.
+         */
+        hasReading: boolean;
+        /**
+         * The frequency for the term, as a number of occurrences or an overall rank.
+         */
+        frequency: number | string;
+    }
+
+    /**
+     * Source information represents how the original text was transformed to get to the final term.
+     */
+    export interface TermSource {
+        /**
+         * The original text that was searched.
+         */
+        originalText: string;
+        /**
+         * The original text after being transformed, but before applying deinflections.
+         */
+        transformedText: string;
+        /**
+         * The final text after applying deinflections.
+         */
+        deinflectedText: string;
+        /**
+         * Whether or not this source is a primary source. Primary sources are derived from the
+         * original search text, while non-primary sources originate from related terms.
+         */
+        isPrimary: boolean;
+    }
+}