linguareef-utils
v1.0.18
Published
Shared TypeScript types and enums for the LinguaReef ecosystem.
Downloads
29
Maintainers
Readme
linguareef-utils
Shared TypeScript types and enums for LinguaReef services and clients.
What This Package Contains
- Canonical domain enums used across LinguaReef modules
- Shared contracts for tasks, messages, education, interactions, checks, and feature flags
- Type declarations published with compiled output for strong editor/CI checks
Installation
npm install linguareef-utilsor
yarn add linguareef-utilsUsage
import { TaskType, MessageType, type Task } from 'linguareef-utils';
const nextType: TaskType = TaskType.AUDIO_LISTENING;
const task: Task = {
id: 'task-1',
type: TaskType.MULTIPLE_CHOICE,
content: 'Choose the correct option',
options: ['A', 'B', 'C'],
correctAnswer: 'A',
};Exports
Root export:
import { ... } from 'linguareef-utils';The package re-exports:
src/enums/*src/types/*
Scripts
yarn check-types
yarn build
yarn watchPublish
Release notes and publish flow are documented in PUBLISHING.md.
Notes
- This package is intended to be the single source of truth for shared contracts in LinguaReef.
- Keep breaking changes versioned properly and aligned with dependent services.
