Merge pull request #339 from toasted-nutbread/type-annotations

Type annotations

2 files changed, 0 insertions, 657 deletions

diff --git a/docs/interfaces/dictionary-entry.ts b/docs/interfaces/dictionary-entry.ts
deleted file mode 100644
index 2ad8f70f..00000000
--- a/docs/interfaces/dictionary-entry.ts
+++ /dev/null
@@ -1,479 +0,0 @@
-/*
- * Copyright (C) 2023  Yomitan Authors
- * Copyright (C) 2021-2022  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
-
-    /**
-     * Enum representing the type of a `DictionaryEntry`.
-     * `'kanji'` corresponds to a KanjiDictionaryEntry.
-     * `'term'` corresponds to a TermDictionaryEntry.
-     */
-    export enum DictionaryEntryType {
-        Kanji = 'kanji',
-        Term = 'term',
-    }
-
-    /**
-     * A generic dictionary entry which is used as the base interface.
-     */
-    export interface DictionaryEntry {
-        /**
-         * The type of the entry.
-         */
-        type: DictionaryEntryType;
-    }
-
-    /**
-     * 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 `DictionaryEntryType.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;
-        /**
-         * A display value to show to the user.
-         */
-        displayValue: string | null;
-        /**
-         * Whether or not the displayValue string was parsed to determine the frequency value.
-         */
-        displayValueParsed: boolean;
-    }
-
-    // Terms
-
-    /**
-     * A dictionary entry for a term or group of terms.
-     * `DictionaryEntry.type` is always `DictionaryEntryType.Term`.
-     */
-    export interface TermDictionaryEntry extends DictionaryEntry {
-        /**
-         * 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;
-        /**
-         * 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 length of the transformed text for all primary sources.
-         */
-        maxTransformedTextLength: 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[];
-        /**
-         * List of word classes (part of speech) for the headword.
-         */
-        wordClasses: string[];
-    }
-
-    /**
-     * 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;
-        /**
-         * The index of the dictionary in the original list of dictionaries used for the lookup.
-         */
-        dictionaryIndex: number;
-        /**
-         * The priority of the dictionary.
-         */
-        dictionaryPriority: number;
-        /**
-         * Database ID for the definition.
-         */
-        id: number[];
-        /**
-         * A score for the definition.
-         */
-        score: number;
-        /**
-         * A list of database sequence numbers for the term. A value of `-1` corresponds to no sequence.
-         * The list can have multiple values if multiple definitions with different sequences have been merged.
-         * The list should always have at least one item.
-         */
-        sequences: number;
-        /**
-         * 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;
-        /**
-         * Positions of morae with a nasal sound.
-         */
-        nasalPositions: number[];
-        /**
-         * Positions of morae with a devoiced sound.
-         */
-        devoicePositions: [];
-        /**
-         * 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;
-        /**
-         * A display value to show to the user.
-         */
-        displayValue: string | null;
-        /**
-         * Whether or not the displayValue string was parsed to determine the frequency value.
-         */
-        displayValueParsed: boolean;
-    }
-
-    /**
-     * Enum representing how the search term relates to the final term.
-     */
-     export enum TermSourceMatchType {
-        Exact = 'exact',
-        Prefix = 'prefix',
-        Suffix = 'suffix',
-    }
-
-    /**
-     * Enum representing what database field was used to match the source term.
-     */
-    export enum TermSourceMatchSource {
-        Term = 'term',
-        Reading = 'reading',
-        Sequence = 'sequence',
-    }
-
-    /**
-     * 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;
-        /**
-         * How the deinflected text matches the value from the database.
-         */
-        matchType: TermSourceMatchType;
-        /**
-         * Which field was used to match the database entry.
-         */
-        matchSource: TermSourceMatchSource;
-        /**
-         * 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;
-    }
-}
diff --git a/docs/interfaces/translator-types.ts b/docs/interfaces/translator-types.ts
deleted file mode 100644
index 305f5ef2..00000000
--- a/docs/interfaces/translator-types.ts
+++ /dev/null
@@ -1,178 +0,0 @@
-/*
- * Copyright (C) 2023  Yomitan Authors
- * Copyright (C) 2022  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 {
-    // Kanji
-
-    /**
-     * An options object for use with `Translator.findKanji`.
-     */
-    export interface FindKanjiOptions {
-        /**
-         * The mapping of dictionaries to search for kanji in.
-         * The key is the dictionary name.
-         */
-        enabledDictionaryMap: Map<string, FindKanjiDictionary>;
-    }
-
-    /**
-     * Details about a dictionary.
-     */
-    export interface FindKanjiDictionary {
-        /**
-         * The index of the dictionary
-         */
-        index: number;
-        /**
-         * The priority of the dictionary
-         */
-        priority: number;
-    }
-
-    // Terms
-
-    /**
-     * An options object for use with `Translator.findTerms`.
-     */
-    export interface FindTermsOptions {
-        /**
-         * The matching type for looking up terms.
-         */
-        matchType: FindTermsMatchType;
-        /**
-         * The name of the primary dictionary to search.
-         */
-        mainDictionary: string;
-        /**
-         * The name of the frequency dictionary used for sorting
-         */
-        sortFrequencyDictionary: string | null;
-        /**
-         * The order used when using a sorting dictionary.
-         */
-        sortFrequencyDictionaryOrder: FindTermsSortOrder;
-        /**
-         * Whether or not non-Japanese characters should be searched.
-         */
-        removeNonJapaneseCharacters: boolean;
-        /**
-         * Whether or not half-width characters should be converted to full-width characters.
-         */
-        convertHalfWidthCharacters: FindTermsVariantMode;
-        /**
-         * Whether or not ASCII numeric characters should be converted to full-width numeric characters.
-         */
-        convertNumericCharacters: FindTermsVariantMode;
-        /**
-         * Whether or not alphabetic characters should be converted to kana.
-         */
-        convertAlphabeticCharacters: FindTermsVariantMode;
-        /**
-         * Whether or not hiragana characters should be converted to katakana.
-         */
-        convertHiraganaToKatakana: FindTermsVariantMode;
-        /**
-         * Whether or not katakana characters should be converted to hiragana.
-         */
-        convertKatakanaToHiragana: FindTermsVariantMode;
-        /**
-         * How emphatic character sequences should be collapsed.
-         */
-        collapseEmphaticSequences: FindTermsEmphaticSequencesMode;
-        /**
-         * An iterable sequence of text replacements to be applied during the term lookup process.
-         */
-        textReplacements: Iterable<(FindTermsTextReplacement | null)> | null;
-        /**
-         * The mapping of dictionaries to search for terms in.
-         * The key is the dictionary name.
-         */
-        enabledDictionaryMap: Map<string, FindTermDictionary>;
-        /**
-         * A set of dictionary names which should have definitions removed.
-         */
-        excludeDictionaryDefinitions: Set<string> | null;
-    }
-
-    /**
-     * The matching type for looking up terms.
-     */
-    export enum FindTermsMatchType {
-        Exact = 'exact',
-        Prefix = 'prefix',
-        Suffix = 'suffix',
-    }
-
-    /**
-     * A sorting order to use when finding terms.
-     */
-     export enum FindTermsSortOrder {
-        Ascending = 'ascending',
-        Descending = 'descending',
-    }
-
-    /**
-     * Mode describing how to handle variations.
-     */
-     export enum FindTermsVariantMode {
-        False = 'false',
-        True = 'true',
-        Variant = 'variant',
-    }
-
-    /**
-     * Mode describing how to handle emphatic sequence variations.
-     */
-     export enum FindTermsEmphaticSequencesMode {
-        False = 'false',
-        True = 'true',
-        Full = 'full',
-    }
-
-    /**
-     * Information about how text should be replaced when looking up terms.
-     */
-    export interface FindTermsTextReplacement {
-        /**
-         * The pattern to replace.
-         */
-        pattern: RegExp;
-        /**
-         * The replacement string. This can contain special sequences, such as `$&`.
-         */
-        replacement: string;
-    }
-
-    /**
-     * Details about a dictionary.
-     */
-    export interface FindTermDictionary {
-        /**
-         * The index of the dictionary
-         */
-        index: number;
-        /**
-         * The priority of the dictionary
-         */
-        priority: number;
-        /**
-         * Whether or not secondary term searches are allowed for this dictionary.
-         */
-        allowSecondarySearches: boolean;
-    }
-}