saajhedaari-types

Shared TypeScript types for Saajhedaari - a collaborative expense splitting and group management application.

⚠️ Private Package: This package builds on install and requires TypeScript in consumer environments.

Installation

From Git:

npm install git+https://github.com/GeekyMayank19/saajhedaari-types.git

Or add to package.json:

{
  "dependencies": {
    "saajhedaari-types": "github:GeekyMayank19/saajhedaari-types"
  }
}

Requirements

• Node.js >= 18.0.0
• TypeScript >= 5.3.0 (installed as devDependency)

How It Works

1. Package contains only TypeScript source files (src/)
2. On npm install, the prepare script runs automatically
3. TypeScript compiles src/ → dist/
4. Runtime uses dist/index.js, types from dist/index.d.ts

Usage

import { 
  User, 
  Group, 
  Expense, 
  LoginReq, 
  LoginRes,
  Role,
  SplitType 
} from 'saajhedaari-types';

// Example
const loginPayload: LoginReq = {
  email: '[email protected]',
  password: 'password123'
};

Available Types

Authentication

• LoginReq, LoginRes, RegisterReq, RegisterRes, JwtPayload

User

• User, CreateUserReq, UpdateUserReq

Group

• Group, GroupMember, GroupWithMembers, GroupWithOwner
• CreateGroupReq, UpdateGroupReq, AddMemberReq

Expense

• Expense, ExpenseShare, ExpenseWithShares
• CreateExpenseReq, UpdateExpenseReq
• ShareInputUnequal, ShareInputPercentage, ShareInputByUnits
• ExpenseHistory, ExpenseSnapshot

Enums

• Role (ADMIN, MEMBER)
• SplitType (EQUAL, UNEQUAL, PERCENTAGE, SHARES)
• ExpenseAction (CREATED, UPDATED, DELETED)

Development

npm install    # Installs deps + runs prepare (builds)
npm run build  # Manual rebuild

Project Structure

src/
├── index.ts          # Main entry - exports all types
├── auth.types.ts     # Authentication types
├── user.types.ts     # User types  
├── group.types.ts    # Group types
├── expense.types.ts  # Expense types
└── enums.ts          # Shared enums

Migration to Public Package

If this package becomes public later:

1. Change prepare → prepublishOnly
2. Remove dist/ from .npmignore
3. Pre-build and publish dist/

License

MIT