typing-genius-content 1.0.0

package/content/kz/_meta.json

@@ -0,0 +1,18 @@
+{
+    "code": "kz",
+    "name": "Қазақша",
+    "nameEnglish": "Kazakh",
+    "keyboard": "kazakh",
+    "contributors": [],
+    "availableContent": {
+        "quotes": false,
+        "words": {
+            "easy": false,
+            "medium": false,
+            "hard": false,
+            "byLength": []
+        }
+    },
+    "status": "needs-contribution",
+    "note": "This language needs contributors! See CONTRIBUTING.md for how to add content."
+}

package/content/ru/_meta.json

@@ -0,0 +1,18 @@
+{
+    "code": "ru",
+    "name": "Русский",
+    "nameEnglish": "Russian",
+    "keyboard": "jcuken",
+    "contributors": [],
+    "availableContent": {
+        "quotes": false,
+        "words": {
+            "easy": false,
+            "medium": false,
+            "hard": false,
+            "byLength": []
+        }
+    },
+    "status": "needs-contribution",
+    "note": "This language needs contributors! See CONTRIBUTING.md for how to add content."
+}

package/content/uz/_meta.json

@@ -0,0 +1,18 @@
+{
+    "code": "uz",
+    "name": "O'zbek",
+    "nameEnglish": "Uzbek",
+    "keyboard": "uzbek",
+    "contributors": [],
+    "availableContent": {
+        "quotes": false,
+        "words": {
+            "easy": false,
+            "medium": false,
+            "hard": false,
+            "byLength": []
+        }
+    },
+    "status": "needs-contribution",
+    "note": "This language needs contributors! See CONTRIBUTING.md for how to add content."
+}

package/dist/index.d.mts

@@ -0,0 +1,222 @@
+/**
+ * Typing Genius Content - Type Definitions
+ *
+ * Core types for typing test content structure.
+ * These types ensure consistency across all content contributions.
+ */
+/**
+ * A quote for typing practice
+ */
+interface Quote {
+    /** The quote text to type */
+    text: string;
+    /** Optional author of the quote */
+    author?: string;
+    /** Optional source (book, movie, etc.) */
+    source?: string;
+}
+/**
+ * A word list with metadata
+ */
+interface WordList {
+    /** The language code (ISO 639-1) */
+    language: string;
+    /** Difficulty level */
+    difficulty?: Difficulty;
+    /** Category description */
+    category?: string;
+    /** Word length (for by-length lists) */
+    wordLength?: number;
+    /** The actual words */
+    words: string[];
+}
+/**
+ * Word difficulty levels
+ */
+type Difficulty = 'easy' | 'medium' | 'hard';
+/**
+ * Supported language codes
+ * Add new languages here as they become available
+ */
+type SupportedLanguage = 'en' | 'kg' | 'ru' | 'kz' | 'uz';
+/**
+ * Language metadata describing available content
+ */
+interface LanguageMeta {
+    /** ISO 639-1 language code */
+    code: SupportedLanguage;
+    /** Language name in the native language */
+    name: string;
+    /** Language name in English */
+    nameEnglish: string;
+    /** Default keyboard layout identifier */
+    keyboard: string;
+    /** RTL (right-to-left) language */
+    rtl?: boolean;
+    /** Available content for this language */
+    availableContent: AvailableContent;
+}
+/**
+ * Describes what content is available for a language
+ */
+interface AvailableContent {
+    /** Whether quotes are available */
+    quotes: boolean;
+    /** Word content availability */
+    words: {
+        easy: boolean;
+        medium: boolean;
+        hard: boolean;
+        /** Available word lengths for by-length word lists */
+        byLength: number[];
+    };
+}
+/**
+ * Global content metadata
+ */
+interface GlobalMeta {
+    /** Package version */
+    version: string;
+    /** Last updated timestamp */
+    lastUpdated: string;
+    /** List of available languages */
+    languages: SupportedLanguage[];
+}
+/**
+ * Options for getting random content
+ */
+interface RandomOptions {
+    /** Number of items to return */
+    count?: number;
+    /** Minimum length (for words or quotes) */
+    minLength?: number;
+    /** Maximum length (for words or quotes) */
+    maxLength?: number;
+    /** Exclude items (for avoiding repeats) */
+    exclude?: string[];
+}
+/**
+ * Options for filtering quotes
+ */
+interface QuoteFilterOptions {
+    /** Minimum quote length in characters */
+    minLength?: number;
+    /** Maximum quote length in characters */
+    maxLength?: number;
+    /** Filter by author */
+    author?: string;
+}
+/**
+ * Options for filtering words
+ */
+interface WordFilterOptions {
+    /** Minimum word length */
+    minLength?: number;
+    /** Maximum word length */
+    maxLength?: number;
+    /** Exact word length */
+    length?: number;
+}
+
+/**
+ * Language Registry
+ *
+ * Defines all supported languages and their metadata.
+ * To add a new language, add an entry here and create the content folder.
+ */
+
+/**
+ * Registry of all supported languages with their metadata
+ */
+declare const LANGUAGES: Record<SupportedLanguage, LanguageMeta>;
+/**
+ * Get list of all supported language codes
+ */
+declare function getSupportedLanguageCodes(): SupportedLanguage[];
+/**
+ * Get metadata for a specific language
+ */
+declare function getLanguageMeta(code: SupportedLanguage): LanguageMeta;
+/**
+ * Get all language metadata
+ */
+declare function getAllLanguages(): LanguageMeta[];
+/**
+ * Check if a language code is supported
+ */
+declare function isLanguageSupported(code: string): code is SupportedLanguage;
+/**
+ * Get languages that have content available
+ */
+declare function getLanguagesWithContent(): LanguageMeta[];
+
+/**
+ * Content Loader
+ *
+ * Provides functions to load and access typing content.
+ * All content is loaded synchronously for simplicity.
+ */
+
+/**
+ * Get all quotes for a language
+ */
+declare function getQuotes(lang: SupportedLanguage): Quote[];
+/**
+ * Get quotes filtered by options
+ */
+declare function getFilteredQuotes(lang: SupportedLanguage, options?: QuoteFilterOptions): Quote[];
+/**
+ * Get a random quote
+ */
+declare function getRandomQuote(lang: SupportedLanguage): Quote | null;
+/**
+ * Get multiple random quotes
+ */
+declare function getRandomQuotes(lang: SupportedLanguage, options?: RandomOptions): Quote[];
+/**
+ * Get all words for a language and difficulty
+ */
+declare function getWords(lang: SupportedLanguage, difficulty: Difficulty): string[];
+/**
+ * Get all words for a language (all difficulties combined)
+ */
+declare function getAllWords(lang: SupportedLanguage): string[];
+/**
+ * Get words by specific length
+ */
+declare function getWordsByLength(lang: SupportedLanguage, length: number): string[];
+/**
+ * Get words filtered by options
+ */
+declare function getFilteredWords(lang: SupportedLanguage, difficulty: Difficulty, options?: WordFilterOptions): string[];
+/**
+ * Get random words
+ */
+declare function getRandomWords(lang: SupportedLanguage, difficulty: Difficulty, options?: RandomOptions): string[];
+
+/**
+ * Get languages that have quotes available
+ */
+declare function getLanguagesWithQuotes(): LanguageMeta[];
+/**
+ * Get languages that have words available
+ */
+declare function getLanguagesWithWords(): LanguageMeta[];
+/**
+ * Get content statistics for a language
+ */
+declare function getContentStats(lang: SupportedLanguage): {
+    quotes: number;
+    words: {
+        easy: number;
+        medium: number;
+        hard: number;
+        total: number;
+    };
+    byLength: {
+        length: number;
+        count: number;
+    }[];
+};
+
+export { type AvailableContent, type Difficulty, type GlobalMeta, LANGUAGES, type LanguageMeta, type Quote, type QuoteFilterOptions, type RandomOptions, type SupportedLanguage, type WordFilterOptions, type WordList, getAllLanguages, getAllWords, getContentStats, getFilteredQuotes, getFilteredWords, getLanguageMeta, getLanguagesWithContent, getLanguagesWithQuotes, getLanguagesWithWords, getQuotes, getRandomQuote, getRandomQuotes, getRandomWords, getSupportedLanguageCodes, getWords, getWordsByLength, isLanguageSupported };

package/dist/index.d.ts

@@ -0,0 +1,222 @@
+/**
+ * Typing Genius Content - Type Definitions
+ *
+ * Core types for typing test content structure.
+ * These types ensure consistency across all content contributions.
+ */
+/**
+ * A quote for typing practice
+ */
+interface Quote {
+    /** The quote text to type */
+    text: string;
+    /** Optional author of the quote */
+    author?: string;
+    /** Optional source (book, movie, etc.) */
+    source?: string;
+}
+/**
+ * A word list with metadata
+ */
+interface WordList {
+    /** The language code (ISO 639-1) */
+    language: string;
+    /** Difficulty level */
+    difficulty?: Difficulty;
+    /** Category description */
+    category?: string;
+    /** Word length (for by-length lists) */
+    wordLength?: number;
+    /** The actual words */
+    words: string[];
+}
+/**
+ * Word difficulty levels
+ */
+type Difficulty = 'easy' | 'medium' | 'hard';
+/**
+ * Supported language codes
+ * Add new languages here as they become available
+ */
+type SupportedLanguage = 'en' | 'kg' | 'ru' | 'kz' | 'uz';
+/**
+ * Language metadata describing available content
+ */
+interface LanguageMeta {
+    /** ISO 639-1 language code */
+    code: SupportedLanguage;
+    /** Language name in the native language */
+    name: string;
+    /** Language name in English */
+    nameEnglish: string;
+    /** Default keyboard layout identifier */
+    keyboard: string;
+    /** RTL (right-to-left) language */
+    rtl?: boolean;
+    /** Available content for this language */
+    availableContent: AvailableContent;
+}
+/**
+ * Describes what content is available for a language
+ */
+interface AvailableContent {
+    /** Whether quotes are available */
+    quotes: boolean;
+    /** Word content availability */
+    words: {
+        easy: boolean;
+        medium: boolean;
+        hard: boolean;
+        /** Available word lengths for by-length word lists */
+        byLength: number[];
+    };
+}
+/**
+ * Global content metadata
+ */
+interface GlobalMeta {
+    /** Package version */
+    version: string;
+    /** Last updated timestamp */
+    lastUpdated: string;
+    /** List of available languages */
+    languages: SupportedLanguage[];
+}
+/**
+ * Options for getting random content
+ */
+interface RandomOptions {
+    /** Number of items to return */
+    count?: number;
+    /** Minimum length (for words or quotes) */
+    minLength?: number;
+    /** Maximum length (for words or quotes) */
+    maxLength?: number;
+    /** Exclude items (for avoiding repeats) */
+    exclude?: string[];
+}
+/**
+ * Options for filtering quotes
+ */
+interface QuoteFilterOptions {
+    /** Minimum quote length in characters */
+    minLength?: number;
+    /** Maximum quote length in characters */
+    maxLength?: number;
+    /** Filter by author */
+    author?: string;
+}
+/**
+ * Options for filtering words
+ */
+interface WordFilterOptions {
+    /** Minimum word length */
+    minLength?: number;
+    /** Maximum word length */
+    maxLength?: number;
+    /** Exact word length */
+    length?: number;
+}
+
+/**
+ * Language Registry
+ *
+ * Defines all supported languages and their metadata.
+ * To add a new language, add an entry here and create the content folder.
+ */
+
+/**
+ * Registry of all supported languages with their metadata
+ */
+declare const LANGUAGES: Record<SupportedLanguage, LanguageMeta>;
+/**
+ * Get list of all supported language codes
+ */
+declare function getSupportedLanguageCodes(): SupportedLanguage[];
+/**
+ * Get metadata for a specific language
+ */
+declare function getLanguageMeta(code: SupportedLanguage): LanguageMeta;
+/**
+ * Get all language metadata
+ */
+declare function getAllLanguages(): LanguageMeta[];
+/**
+ * Check if a language code is supported
+ */
+declare function isLanguageSupported(code: string): code is SupportedLanguage;
+/**
+ * Get languages that have content available
+ */
+declare function getLanguagesWithContent(): LanguageMeta[];
+
+/**
+ * Content Loader
+ *
+ * Provides functions to load and access typing content.
+ * All content is loaded synchronously for simplicity.
+ */
+
+/**
+ * Get all quotes for a language
+ */
+declare function getQuotes(lang: SupportedLanguage): Quote[];
+/**
+ * Get quotes filtered by options
+ */
+declare function getFilteredQuotes(lang: SupportedLanguage, options?: QuoteFilterOptions): Quote[];
+/**
+ * Get a random quote
+ */
+declare function getRandomQuote(lang: SupportedLanguage): Quote | null;
+/**
+ * Get multiple random quotes
+ */
+declare function getRandomQuotes(lang: SupportedLanguage, options?: RandomOptions): Quote[];
+/**
+ * Get all words for a language and difficulty
+ */
+declare function getWords(lang: SupportedLanguage, difficulty: Difficulty): string[];
+/**
+ * Get all words for a language (all difficulties combined)
+ */
+declare function getAllWords(lang: SupportedLanguage): string[];
+/**
+ * Get words by specific length
+ */
+declare function getWordsByLength(lang: SupportedLanguage, length: number): string[];
+/**
+ * Get words filtered by options
+ */
+declare function getFilteredWords(lang: SupportedLanguage, difficulty: Difficulty, options?: WordFilterOptions): string[];
+/**
+ * Get random words
+ */
+declare function getRandomWords(lang: SupportedLanguage, difficulty: Difficulty, options?: RandomOptions): string[];
+
+/**
+ * Get languages that have quotes available
+ */
+declare function getLanguagesWithQuotes(): LanguageMeta[];
+/**
+ * Get languages that have words available
+ */
+declare function getLanguagesWithWords(): LanguageMeta[];
+/**
+ * Get content statistics for a language
+ */
+declare function getContentStats(lang: SupportedLanguage): {
+    quotes: number;
+    words: {
+        easy: number;
+        medium: number;
+        hard: number;
+        total: number;
+    };
+    byLength: {
+        length: number;
+        count: number;
+    }[];
+};
+
+export { type AvailableContent, type Difficulty, type GlobalMeta, LANGUAGES, type LanguageMeta, type Quote, type QuoteFilterOptions, type RandomOptions, type SupportedLanguage, type WordFilterOptions, type WordList, getAllLanguages, getAllWords, getContentStats, getFilteredQuotes, getFilteredWords, getLanguageMeta, getLanguagesWithContent, getLanguagesWithQuotes, getLanguagesWithWords, getQuotes, getRandomQuote, getRandomQuotes, getRandomWords, getSupportedLanguageCodes, getWords, getWordsByLength, isLanguageSupported };