@olivaresai/alma-types
v1.2.1
Published
Shared TypeScript types for the Alma ecosystem — API, SDK, MCP, Web
Maintainers
Readme
@olivaresai/alma-types
Shared TypeScript types for the Alma ecosystem.
Type definitions shared across the Alma platform — API responses, SDK parameters, MCP tools, and web frontend. This package is the single source of truth for all Alma data structures.
Install
npm install @olivaresai/alma-typesUsage
import type {
Memory,
Episode,
Procedure,
MemoryBlock,
Conversation,
Message,
BudgetStatus,
ChatStreamEvent,
Environment,
} from '@olivaresai/alma-types';What's included
| Domain | Types |
|--------|-------|
| Memory | Memory, ScoredMemory, MemoryCategory, MemorySource, CreateMemoryParams, SearchMemoriesParams, ListMemoriesParams |
| Episodes | Episode, CreateEpisodeParams, SearchEpisodesParams |
| Procedures | Procedure, CreateProcedureParams |
| Chat | Conversation, Message, ChatFile, ChatImage, ChatStreamEvent, ChatStreamCallbacks, ChatDoneEvent |
| Soul Engine | MemoryBlock, BlockCategory, CreateBlockParams, SoulVersion |
| Context | AssembleParams, AssembleResult, ContinueParams, ContinueResult, ContextPreviewMetadata, FocusBlock |
| Budget | BudgetStatus |
| Voice | VoiceCapabilities, TranscribeResult, SynthesizeResult |
| Images | GeneratedImage, GenerateImageParams, ImageModel |
| Environments | Environment |
| Admin | Stats, InsightsData, ExportData, ImportInput, ImportResult |
| Plans | PlanId |
| Pagination | PaginatedResponse<T>, PaginationParams |
| Extract | ExtractParams, ExtractResult |
Used by
@olivaresai/alma-sdk— JavaScript/TypeScript SDK@olivaresai/alma-mcp— MCP Server- Alma Web App — React frontend
- Alma VSCode — VSCode extension
Links
Built by olivares.ai — Give your AI a soul.
