Alliance Shared Types

This package contains shared TypeScript type definitions for the Alliance B2B Travel Portal. It ensures type consistency between the frontend and backend applications.

Installation

Local Development

During local development, you can use the package directly from your local filesystem:

# From the frontend or backend project
npm install ../alliance-shared-types

Using npm

Once published to npm:

npm install alliance-shared-types

Using GitHub

You can also install directly from GitHub:

npm install git+https://github.com/yourusername/alliance-shared-types.git

Usage

// Import specific types
import { UserData, AuthResponse, USER_ROLES } from 'alliance-shared-types';

// Use in your code
const user: UserData = {
  userId: '123',
  email: '[email protected]',
  role: USER_ROLES.ADMIN,
  agentId: '456',
  status: 'active'
};

Available Types

Authentication

• UserCredentials - Login credentials
• AuthResponse - Authentication response with token and user data
• UserData - User information
• JwtPayload - JWT token payload structure
• TokenData - Token data with expiration

Enums and Constants

• UserRole and USER_ROLES - User role types and constants
• UserStatus and USER_STATUSES - User status types and constants
• AgentType and AGENT_TYPES - Agent type types and constants
• KycStatus and KYC_STATUSES - KYC status types and constants
• AgentStatus and AGENT_STATUSES - Agent status types and constants

Development

To build the package:

npm run build

Publishing

npm login
npm publish