Skip to Content
DocumentationPackagesglost-registry

glost-registry

Plugin discovery, validation, and conflict detection for GLOST.

Installation

npm install @glotblocks/glost-registry @glotblocks/glost-core @glotblocks/glost-plugins

Or use the main glost package which includes the registry:

npm install @glotblocks/glost

Features

  • Plugin registration with metadata
  • Search and filtering
  • Conflict detection
  • Version validation
  • Capability checking

Quick Start

import { pluginRegistry } from '@glotblocks/glost'; // Register a plugin pluginRegistry.register({ id: 'my-plugin', name: 'My Plugin', version: '1.0.0', description: 'Does something useful', plugin: myPluginImplementation }); // Find plugins const frequencyPlugins = pluginRegistry.search({ category: 'frequency' }); // Get a specific plugin const plugin = pluginRegistry.get('my-plugin');

API

pluginRegistry

Singleton registry instance.

import { pluginRegistry } from '@glotblocks/glost';

register(metadata)

Register a plugin with metadata.

pluginRegistry.register({ id: 'frequency-thai', name: 'Thai Frequency Plugin', version: '1.0.0', description: 'Word frequency data for Thai', category: 'frequency', languages: ['th'], plugin: thaiFrequencyPlugin, dependencies: [], conflicts: ['frequency-generic'] });

registerAll(plugins)

Register multiple plugins at once.

pluginRegistry.registerAll([ { id: 'plugin1', ... }, { id: 'plugin2', ... } ]);

get(id)

Get a plugin by ID.

const plugin = pluginRegistry.get('frequency-thai'); if (plugin) { console.log(plugin.name); // 'Thai Frequency Plugin' }

search(criteria)

Search for plugins matching criteria.

// By category const freqPlugins = pluginRegistry.search({ category: 'frequency' }); // By language const thaiPlugins = pluginRegistry.search({ language: 'th' }); // By name pattern const posPlugins = pluginRegistry.search({ name: /pos/i }); // Combined const results = pluginRegistry.search({ category: 'transcription', language: 'ja' });

has(id)

Check if a plugin exists.

if (pluginRegistry.has('frequency-thai')) { // Plugin is registered }

remove(id)

Remove a plugin from the registry.

pluginRegistry.remove('my-plugin');

list()

List all registered plugins.

const allPlugins = pluginRegistry.list(); console.log(`${allPlugins.length} plugins registered`);

Plugin Metadata

Required Fields

FieldTypeDescription
idstringUnique identifier
namestringHuman-readable name
versionstringSemver version
pluginPluginPlugin implementation

Optional Fields

FieldTypeDescription
descriptionstringWhat the plugin does
categorystringPlugin category
languagesstring[]Supported languages
dependenciesstring[]Required plugins
conflictsstring[]Incompatible plugins
authorstringPlugin author
homepagestringDocumentation URL

Conflict Detection

The registry detects conflicts between plugins.

// Register conflicting plugins pluginRegistry.register({ id: 'frequency-v1', conflicts: ['frequency-v2'] }); pluginRegistry.register({ id: 'frequency-v2', conflicts: ['frequency-v1'] }); // Check for conflicts const conflicts = pluginRegistry.checkConflicts(['frequency-v1', 'frequency-v2']); // Returns: [{ plugins: ['frequency-v1', 'frequency-v2'], reason: '...' }]

Dependency Resolution

Validate that all dependencies are met.

pluginRegistry.register({ id: 'advanced-analysis', dependencies: ['frequency', 'pos'] }); // Check dependencies const missing = pluginRegistry.checkDependencies('advanced-analysis'); // Returns array of missing plugin IDs

Version Validation

// Check if a specific version is available const plugin = pluginRegistry.get('frequency', '^1.0.0'); // List all versions const versions = pluginRegistry.getVersions('frequency');

Categories

Common plugin categories:

CategoryDescription
transcriptionPronunciation data
translationGlosses and translations
frequencyWord frequency metrics
difficultyDifficulty/CEFR levels
posPart-of-speech tagging
genderGrammatical gender
segmentationText segmentation

Example: Plugin Discovery UI

import { pluginRegistry } from '@glotblocks/glost'; function PluginBrowser({ language }) { const plugins = pluginRegistry.search({ language }); return ( <div> <h2>Plugins for {language}</h2> {plugins.map(p => ( <div key={p.id}> <h3>{p.name}</h3> <p>{p.description}</p> <span>v{p.version}</span> </div> ))} </div> ); }

See Also

Last updated on