Skip to main content

Shared Packages

Overview

Collection of shared utility packages used across Mercury and Arcana services.

Available Packages

auth-utils

Authentication and authorization utilities

  • Token management
  • Permission handling
  • Session management

common-utils

General purpose utilities

  • Data transformations
  • Configuration management
  • Error handling
  • Logging

openai-utils

OpenAI integration utilities

  • API wrappers
  • Prompt management
  • Response handling
  • Rate limiting

types

Shared TypeScript type definitions

  • Common interfaces
  • API types
  • Configuration types
  • Event types and handlers

Development Guidelines

Package Structure

packages/
├── auth-utils/ # Authentication utilities
├── common-utils/ # Shared utilities
├── openai-utils/ # OpenAI integration
└── types/ # TypeScript types

Standards

  • TypeScript for all packages
  • Comprehensive unit tests
  • Documentation with TSDoc
  • Semantic versioning

NEXT_TASK: Implement event types system in types package with standardized interfaces for system events, including WebSocket messages, background jobs, and cross-service communication