typing-genius-content 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Typing Genius
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,221 @@
+# Typing Genius Content 📝
+
+[![npm version](https://img.shields.io/npm/v/typing-genius-content.svg)](https://www.npmjs.com/package/typing-genius-content)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Open-source typing test content library with quotes and words in multiple languages. Perfect for typing practice applications, speed tests, and educational tools.
+
+## 🌍 Supported Languages
+
+| Language | Code | Quotes | Words | Status |
+|----------|------|--------|-------|--------|
+| English | `en` | ✅ 5,000+ | ✅ 158,000+ | Active |
+| Kyrgyz | `kg` | ✅ 4,900+ | ✅ 8,500+ | Active |
+| Russian | `ru` | ❌ | ❌ | **Needs Contributors!** |
+| Kazakh | `kz` | ❌ | ❌ | **Needs Contributors!** |
+| Uzbek | `uz` | ❌ | ❌ | **Needs Contributors!** |
+
+**Want to add content for your language?** See [CONTRIBUTING.md](CONTRIBUTING.md)!
+
+## 📦 Installation
+
+```bash
+npm install typing-genius-content
+# or
+yarn add typing-genius-content
+# or
+pnpm add typing-genius-content
+```
+
+## 🚀 Usage
+
+### Basic Usage
+
+```typescript
+import {
+  getQuotes,
+  getWords,
+  getRandomQuote,
+  getRandomWords,
+  getSupportedLanguageCodes,
+} from 'typing-genius-content';
+
+// Get all English quotes
+const englishQuotes = getQuotes('en');
+console.log(englishQuotes.length); // 5000+
+
+// Get Kyrgyz hard words
+const hardWordsKg = getWords('kg', 'hard');
+console.log(hardWordsKg.length); // 4000+
+
+// Get a random quote
+const randomQuote = getRandomQuote('en');
+console.log(randomQuote?.text);
+
+// Get 10 random easy words
+const practiceWords = getRandomWords('en', 'easy', { count: 10 });
+console.log(practiceWords); // ['the', 'and', 'for', ...]
+
+// List all supported languages
+const languages = getSupportedLanguageCodes();
+console.log(languages); // ['en', 'kg', 'ru', 'kz', 'uz']
+```
+
+### Filtering Content
+
+```typescript
+import { getFilteredQuotes, getFilteredWords } from 'typing-genius-content';
+
+// Get short quotes (< 100 characters)
+const shortQuotes = getFilteredQuotes('en', { maxLength: 100 });
+
+// Get medium-length words (5-7 letters)
+const mediumWords = getFilteredWords('en', 'medium', {
+  minLength: 5,
+  maxLength: 7,
+});
+```
+
+### Words by Length
+
+```typescript
+import { getWordsByLength } from 'typing-genius-content';
+
+// Get all 5-letter words (great for Wordle practice!)
+const fiveLetterWords = getWordsByLength('en', 5);
+console.log(fiveLetterWords.length); // 7000+
+```
+
+### Language Metadata
+
+```typescript
+import {
+  getLanguageMeta,
+  getLanguagesWithQuotes,
+  getContentStats,
+} from 'typing-genius-content';
+
+// Get language info
+const kyrgyzMeta = getLanguageMeta('kg');
+console.log(kyrgyzMeta);
+// {
+//   code: 'kg',
+//   name: 'Кыргызча',
+//   nameEnglish: 'Kyrgyz',
+//   keyboard: 'kyrgyz',
+//   ...
+// }
+
+// Get statistics
+const stats = getContentStats('en');
+console.log(stats);
+// {
+//   quotes: 5000,
+//   words: { easy: 2672, medium: 8691, hard: 147026, total: 158389 },
+//   byLength: [{ length: 3, count: 577 }, ...]
+// }
+```
+
+## 📁 Content Structure
+
+```
+content/
+├── _meta.json              # Global metadata
+├── en/                     # English
+│   ├── _meta.json          # Language metadata
+│   ├── quotes.json         # Quotes for typing
+│   └── words/
+│       ├── easy.json       # Easy words (3-4 letters)
+│       ├── medium.json     # Medium words (5-6 letters)
+│       ├── hard.json       # Hard words (7+ letters)
+│       └── by-length/
+│           ├── 3-letter.json
+│           ├── 4-letter.json
+│           └── ...
+├── kg/                     # Kyrgyz
+│   ├── _meta.json
+│   ├── quotes.json
+│   └── words/
+│       ├── easy.json
+│       ├── medium.json
+│       └── hard.json
+└── ...
+```
+
+## 🤝 Contributing
+
+We welcome contributions! Adding content is easy:
+
+1. **Fork this repository**
+2. **Add or update content files** (see format below)
+3. **Submit a pull request**
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
+
+### Quick Content Formats
+
+**Quotes** (`content/{lang}/quotes.json`):
+```json
+[
+  {
+    "text": "Your quote text here.",
+    "author": "Author Name",
+    "source": "Optional Source"
+  }
+]
+```
+
+**Words** (`content/{lang}/words/easy.json`):
+```json
+{
+  "language": "en",
+  "difficulty": "easy",
+  "words": ["word1", "word2", "word3"]
+}
+```
+
+## 📊 API Reference
+
+### Quote Functions
+
+| Function | Description |
+|----------|-------------|
+| `getQuotes(lang)` | Get all quotes for a language |
+| `getFilteredQuotes(lang, options)` | Get quotes with filters |
+| `getRandomQuote(lang)` | Get a single random quote |
+| `getRandomQuotes(lang, options)` | Get multiple random quotes |
+
+### Word Functions
+
+| Function | Description |
+|----------|-------------|
+| `getWords(lang, difficulty)` | Get words by difficulty |
+| `getAllWords(lang)` | Get all words combined |
+| `getWordsByLength(lang, length)` | Get words by exact length |
+| `getFilteredWords(lang, difficulty, options)` | Get words with filters |
+| `getRandomWords(lang, difficulty, options)` | Get random words |
+
+### Language Functions
+
+| Function | Description |
+|----------|-------------|
+| `getAllLanguages()` | Get all language metadata |
+| `getLanguageMeta(code)` | Get metadata for a language |
+| `getSupportedLanguageCodes()` | Get list of language codes |
+| `getLanguagesWithQuotes()` | Get languages that have quotes |
+| `getLanguagesWithWords()` | Get languages that have words |
+| `getContentStats(lang)` | Get content statistics |
+
+## 📜 License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## 🙏 Acknowledgments
+
+- All the amazing contributors who add content
+- [Typing Genius](https://typinggenius.com) for the initial content
+- The open-source community
+
+---
+
+**Made with ❤️ for the typing community**

package/content/_meta.json

@@ -0,0 +1,14 @@
+{
+    "code": "global",
+    "name": "Typing Genius Content",
+    "version": "1.0.0",
+    "lastUpdated": "2026-01-10",
+    "languages": [
+        "en",
+        "kg",
+        "ru",
+        "kz",
+        "uz"
+    ],
+    "description": "Open source typing test content library for multiple languages"
+}

package/content/en/_meta.json

@@ -0,0 +1,24 @@
+{
+    "code": "en",
+    "name": "English",
+    "nameEnglish": "English",
+    "keyboard": "qwerty",
+    "contributors": [],
+    "availableContent": {
+        "quotes": true,
+        "words": {
+            "easy": true,
+            "medium": true,
+            "hard": true,
+            "byLength": [
+                3,
+                4,
+                5,
+                6,
+                7,
+                8,
+                9
+            ]
+        }
+    }
+}