GLOST Ecosystem
Overview
GLOST is a modular ecosystem of packages for processing multilingual text with language learning annotations. The architecture follows a layered design with clear separation of concerns.
Package Architecture
LAYER 7: MAIN EXPORT
└── glost Main entry point combining all functionality
LAYER 6: CLI & TOOLS
└── glost-cli Command-line interface for plugin management
LAYER 5: FRONTEND/INTERFACE
├── glost-react React components for rendering GLOST documents
└── glost-dialogue Dialogue syntax and helper functions
LAYER 4: PROCESSING INFRASTRUCTURE
├── glost-processor Unified-style processor API
├── glost-registry Plugin discovery and validation
└── glost-presets Pre-configured plugin combinations
LAYER 3: LANGUAGE PACKAGES
├── glost-en English support (segmentation)
├── glost-ja Japanese support (furigana, romaji, etc.)
├── glost-ko Korean support (romanization)
└── glost-th Thai support (RTGS, segmentation)
LAYER 2: PLUGIN PACKAGES
├── glost-transcription Pronunciation/transcription data
├── glost-translation Multilingual glosses
├── glost-frequency Word frequency metrics
├── glost-difficulty CEFR/difficulty levels
├── glost-pos Part-of-speech tagging
├── glost-gender Grammatical gender
├── glost-clause-segmenter Sentence segmentation
└── glost-inkle Interactive fiction integration
LAYER 1: FOUNDATION
├── glost-plugins Core plugin system architecture
├── glost-core Types, nodes, validators, tree utilities
├── glost-common Language utilities and shared code
└── glost-utils Text parsing and manipulationOfficial Packages
Foundation Layer
| Package | Version | Description |
|---|---|---|
@glotblocks/glost-core | 0.5.0 | Core types, nodes, validators, and tree traversal utilities |
@glotblocks/glost-common | 0.2.0 | Common utilities and language configurations |
@glotblocks/glost-utils | 0.2.0 | Framework-agnostic utilities for text manipulation |
@glotblocks/glost-plugins | 0.5.0 | Plugin architecture and extension system |
Plugin Packages
| Package | Version | Description |
|---|---|---|
@glotblocks/glost-transcription | 0.4.0 | Pronunciation and transcription data (IPA, romanization) |
@glotblocks/glost-translation | 0.4.0 | Multilingual glosses and translations |
@glotblocks/glost-frequency | 0.4.0 | Word frequency metrics and prioritization |
@glotblocks/glost-difficulty | 0.4.0 | CEFR levels and difficulty scoring |
@glotblocks/glost-pos | 0.4.0 | Part-of-speech tagging and formatting |
@glotblocks/glost-gender | 0.2.1 | Grammatical gender metadata |
@glotblocks/glost-clause-segmenter | 0.2.1 | Sentence segmentation into clauses |
@glotblocks/glost-inkle | 0.2.0 | Inkle/Ink interactive fiction integration |
Language Packages
| Package | Version | Description |
|---|---|---|
@glotblocks/glost-th | 0.4.1 | Thai language support (RTGS, Paiboon+, segmentation) |
@glotblocks/glost-ja | 0.4.0 | Japanese language support (furigana, romaji, JLPT) |
@glotblocks/glost-ko | 0.1.0 | Korean language support (romanization) |
@glotblocks/glost-en | 0.4.0 | English language support (segmentation) |
Processing Infrastructure
| Package | Version | Description |
|---|---|---|
@glotblocks/glost-processor | 0.5.0 | Unified-style processor with .use() API |
@glotblocks/glost-registry | 0.5.0 | Plugin discovery, validation, conflict detection |
@glotblocks/glost-presets | 0.5.0 | Pre-configured plugin combinations |
Interface Packages
| Package | Version | Description |
|---|---|---|
@glotblocks/glost-react | 0.5.0 | React components for rendering with ruby annotations |
@glotblocks/glost-dialogue | 0.5.0 | Dialogue syntax and helper functions |
Main Package & Tools
| Package | Version | Description |
|---|---|---|
glost | 0.5.0 | Main entry point combining all GLOST functionality |
@glotblocks/glost-cli | 0.5.0 | CLI for plugin management and discovery |
Package Relationships
Dependency Graph
glost (main)
├── glost-core
├── glost-processor ────────────┐
├── glost-registry ─────────────┼── glost-plugins
└── glost-presets ──────────────┘ │
│
glost-react ─────── glost ───────────────┘
glost-dialogue ─────┘ │
│
glost-th ─────────── glost ──────────────┤
├── glost-clause-segmenter │
├── glost-transcription ───────────────┤
├── glost-translation ─────────────────┤
├── glost-frequency ───────────────────┤
├── glost-difficulty ──────────────────┤
└── glost-pos ─────────────────────────┘
glost-ja ─────────── glost
├── glost-transcription
├── glost-translation
├── glost-frequency
├── glost-difficulty
└── glost-pos
glost-ko ─────────── glost
├── glost-transcription
├── glost-translation
├── glost-frequency
├── glost-difficulty
└── glost-pos
glost-en ─────────── glost
└── glost-clause-segmenterHow Packages Work Together
1. Foundation → Plugins
The foundation layer provides core types and utilities. The plugin system (@glotblocks/glost-plugins) builds on this to enable extensible processing.
// Foundation provides types
import { GLOSTWord, GLOSTSentence } from '@glotblocks/glost-core';
// Plugin system provides extension architecture
import { processGLOST, type GLOSTExtension } from '@glotblocks/glost-plugins';2. Plugins → Language Packages
Individual plugins (frequency, transcription, etc.) are composed into language-specific packages that provide a complete solution for each language.
// Language package composes multiple plugins
import { thaiFrequencyProvider } from '@glotblocks/glost-th/extensions';
import { createFrequencyExtension } from '@glotblocks/glost-frequency';
const [freqGen, freqEnh] = createFrequencyExtension({
targetLanguage: 'th',
provider: thaiFrequencyProvider
});3. Processing Infrastructure
The processor, registry, and presets provide the runtime infrastructure for using plugins.
import { glost } from '@glotblocks/glost';
import { languageLearningPreset } from '@glotblocks/glost/presets';
const processor = glost()
.use(languageLearningPreset)
.freeze();
const result = await processor.process(document);4. Interface Packages
Frontend packages consume processed documents for rendering.
// React rendering
import { GloSTWord, GloSTSentence } from '@glotblocks/glost-react';
// Dialogue structures
import { createDialogueFromTurns } from '@glotblocks/glost-dialogue';Use Cases by Package Combination
Language Learning App
glost + glost-th + glost-react
├── Core processing
├── Thai transcription, frequency, difficulty
└── React components for UIReading Comprehension Platform
glost + glost-ja + glost-clause-segmenter
├── Core processing
├── Japanese furigana and difficulty
└── Sentence breakdown for easier readingInteractive Fiction
glost + glost-inkle + glost-dialogue
├── Core processing
├── Ink story integration
└── Dialogue conversation structuresGrammar Analysis Tool
glost + glost-pos + glost-clause-segmenter
├── Core processing
├── Part-of-speech tagging
└── Clause relationship analysisCommunity Packages
Naming Conventions
| Type | Pattern | Example |
|---|---|---|
| Language | glost-{lang} | @glotblocks/glost-th, @glotblocks/glost-ja |
| Data Source | glost-{lang}-datasource-{source} | glost-th-datasource-lexitron |
| Transcription | glost-{lang}-transcription-{system} | glost-th-transcription-paiboon |
| Lookup | glost-{lang}-lookup-{type}-{system}-{source} | glost-th-lookup-transcription-paiboon-lexitron |
Creating Community Packages
- Follow naming conventions
- Implement provider interfaces from plugin packages
- Export typed providers
- Document usage examples
- Submit PR to add to ecosystem list
Standards & Specifications
- Metadata Schema - Standard metadata structure
- Provider Philosophy - “No Data > Bad Data” principle
- Naming Conventions - Package naming patterns
- Transcription Providers - Provider patterns
Getting Help
- Documentation: Getting Started, Core Concepts
- Examples: See examples
- Issues: GitHub Issues
- Discussions: GitHub Discussions
See Also
Last updated on