@tour-companion/tour-companion-core

Core domain entities, policies, and presenters for the Tour Companion application.

Installation

npm install @tour-companion/tour-companion-core

Usage

import { User, Tour, PointOfInterest, AudioFile } from '@guided-tour/tour-companion-core';

// Create a new user
const user = new User({
  id: 'user-123',
  email: '[email protected]',
  name: 'John Doe'
});

// Create a tour
const tour = new Tour({
  id: 'tour-456',
  title: 'Historic Downtown Walk',
  description: 'A guided tour through the historic downtown area'
});

API Reference

Entities

• User: User management and authentication
• Tour: Tour creation and management
• PointOfInterest: Points of interest within tours
• AudioFile: Audio content management
• UserTourProgress: Track user progress through tours
• UserPreferences: User settings and preferences
• Subscription: Subscription management
• Pricing: Pricing models and calculations
• UserFeedback: User feedback collection
• Admin: Administrative functions

Policies

• UserPolicy: User access and permissions
• TourPolicy: Tour access and management permissions
• SubscriptionPolicy: Subscription-related permissions
• PricingPolicy: Pricing access permissions

Presenters

• UserPresenter: User data presentation
• TourPresenter: Tour data presentation
• PointOfInterestPresenter: POI data presentation
• AudioFilePresenter: Audio file presentation

Development

# Install dependencies
npm install

# Run tests
npm test

# Build the package
npm run build

# Development build with watch
npm run dev

License

UNLICENSED - Private package