Free California Drivers Ed Types

Types and Interfaces for Free Drivers Ed California UI & API

Installation

npm install @free-drivers-ed-california/types

Project Structure

src/
  curriculum/
    interfaces/    # Curriculum-related interfaces
    enums/        # Curriculum-related enums
  generics/
    interfaces/    # Generic/shared interfaces
    enums/        # Generic/shared enums
  student/
    interfaces/    # Student-related interfaces
    enums/        # Student-related enums
  user/
    interfaces/    # User-related interfaces
    enums/        # User-related enums

TypeScript Path Aliases

This project includes TypeScript path aliases for cleaner imports:

Available Aliases

• @curriculum/* - Access curriculum module
• @curriculum-interfaces/* - Direct access to curriculum interfaces
• @curriculum-enums/* - Direct access to curriculum enums
• @generics/* - Access generics module
• @generics-interfaces/* - Direct access to generic interfaces
• @student/* - Access student module
• @student-interfaces/* - Direct access to student interfaces
• @user/* - Access user module
• @user-interfaces/* - Direct access to user interfaces
• @user-enums/* - Direct access to user enums

Usage Examples

Without aliases (relative paths):

import {Student} from '../../student/interfaces/student.interface';
import {UserRoles} from '../../user/enums/user-roles.enum';
import {BaseResponse} from '../../generics/interfaces/base-response.interface';

With aliases (clean imports):

import {Student} from '@student-interfaces/student.interface';
import {UserRoles} from '@user-enums/user-roles.enum';
import {BaseResponse} from '@generics-interfaces/base-response.interface';

Module-level imports:

import {Student, StudentUser} from '@student';
import {UserRoles} from '@user';
import {BaseResponse, Address} from '@generics';

Development

Build

npm run build

Clean

npm run clean

Release

npm run release:patch  # For bug fixes
npm run release:minor  # For new features
npm run release:major  # For breaking changes

Exports

All types and interfaces are exported from the main entry point:

import {
    // Curriculum
    Curriculum,
    CurriculumContentTypes,

    // Generics
    BaseResponse,
    Address,
    Person,

    // Student
    Student,
    StudentUser,

    // User
    User,
    UserRoles
} from '@free-drivers-ed-california/types';

License

ISC