@movmo_app/types

This package provides all of the TypeScript type definitions used across the Movmo ecosystem.

Overview

The @movmo_app/types package serves as a central repository for shared TypeScript types, interfaces, and enums that are used across various Movmo packages and applications. By centralizing these types, we ensure consistency across our codebase and reduce duplication.

Installation

# npm
npm install @movmo_app/types

# yarn
yarn add @movmo_app/types

# pnpm
pnpm add @movmo_app/types

Usage

Import the types you need in your TypeScript files:

import { FlightOffer, DataSource, BookingStatus } from '@movmo_app/types';

// Example usage
const offer: FlightOffer = {
  // ...
};

const dataSource: DataSource = "amadeus";

const status: BookingStatus = "CONFIRMED";

Available Types

Core Types

• FlightOffer: Represents a flight offer from a data source
• BookingData: Contains booking details
• PassengerInfo: Passenger information
• PricingInfo: Flight pricing details

Enums

• DataSource: Available data sources (e.g., "amadeus", "sabre")
• BookingStatus: Status of a booking (e.g., "PENDING", "CONFIRMED", "CANCELLED")
• PaymentMethod: Available payment methods
• FlightClass: Flight class types (e.g., "ECONOMY", "BUSINESS", "FIRST")

API Request/Response Types

• FlightOfferRequest: Request format for retrieving flight offers
• FlightOfferResponse: Response format for flight offers
• BookingRequest: Request format for creating a booking
• BookingResponse: Response format for booking creation

Development

Building the Package

# Install dependencies
pnpm install

# Build
pnpm build

Adding New Types

When adding new types to this package:

1. Place the type definitions in the appropriate file under the src/ directory
2. Export them from the main index.ts file
3. Ensure proper documentation is added for each type
4. Update this README if adding significant new types or categories

Version Control

This package follows semantic versioning:

• Major version: Breaking changes to existing types
• Minor version: New types added (non-breaking)
• Patch version: Bug fixes, documentation updates

Internal Usage Guidelines

• Avoid duplicating these types in other packages or applications
• If you need a modified version of an existing type, consider extending it
• If you find yourself copy-pasting types between projects, consider adding them here instead
• For types that are only used in a single package, keep them in that package

Deployment

This package is automatically published to npm when changes are merged to the main branch via GitHub Actions.

License

Internal use only. © Movmo