API Reference

Detailed API documentation for packages in the 54VIE Super App.

Package APIs

UI Library

• @54vie/kit Components - Button, Input, Card, Modal, etc.
• @54vie/kit Hooks - useTheme, useResponsive, etc.
• @54vie/kit Theme - Theme customization

API Client

• ApiClient - HTTP client methods
• Hooks - useQuery, useMutation, etc.
• WebSocket - Real-time connection
• Cache - Caching strategies

Analytics

• AnalyticsProvider - Setup & configuration
• Hooks - useAnalytics, useSession, etc.
• Events - Standard events
• Experiments - A/B testing

Mini-App SDK

• Hooks - useHostAuth, useHostDevice, etc.
• Services - storage, analytics, etc.
• Bridge - serviceRouter

Type Definitions

All packages export TypeScript types. Import them as needed:

import type {
  ButtonProps,
  InputProps,
  CardProps,
} from '@54vie/kit';

import type {
  ApiClientConfig,
  RequestOptions,
  UseQueryOptions,
} from '@54vie/api';

import type {
  AnalyticsEvent,
  UserTraits,
  Experiment,
} from '@54vie/analytics';

Versioning

API versions follow semantic versioning:

• Major (x.0.0): Breaking changes
• Minor (0.x.0): New features, backward compatible
• Patch (0.0.x): Bug fixes

Check package version:

pnpm list @54vie/kit