@loan-risk/http-api 1.0.0 → 1.0.1

package/README.md

@@ -1,270 +1,30 @@
-# Loan Risk Analyzer
+# @loan-risk/http-api
 
-![CI](https://github.com/Aparna-tech-codes/loan-risk-analyzer/actions/workflows/ci.yml/badge.svg)
+Express HTTP API for the Loan Risk Analyzer ecosystem.
 
-![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue)
-
-![License](https://img.shields.io/badge/license-MIT-green)
-
-![PNPM](https://img.shields.io/badge/PNPM-workspace-orange)
-
-A modern TypeScript-based loan risk analysis engine with plugin architecture, hooks system, HTTP API support, and extensible rule processing.
-
-Built with:
-
-- TypeScript
-- Node.js
-- PNPM Workspace
-- Vitest
-- Express
+![npm](https://img.shields.io/npm/v/@loan-risk/http-api)
 
 ---
 
 # Features
 
-- Rule-based loan risk analysis
-- Plugin architecture
-- Hook system
-- Fraud detection support
-- Parallel rule execution
-- HTTP API package
-- Logger package
-- Automated testing
-- Monorepo architecture
-- Fully typed with TypeScript
-
----
-# Quick Start
-
-```bash
-pnpm install
-pnpm build
-pnpm test
-
-# Architecture
-
-This repository follows a modular monorepo architecture using TurboRepo and PNPM workspaces.
-
-Each package is independently buildable, type-safe, and publishable to npm.
-
-The system is designed for:
-- extensibility
-- plugin-based rule processing
-- scalable risk evaluation
-- enterprise TypeScript development workflows
-
-# Project Structure
-
-```txt
-loan-risk-analyzer/
-│
-├── packages/
-│   ├── core/
-│   │   ├── src/
-│   │   ├── tests/
-│   │   └── package.json
-│   │
-│   ├── logger/
-│   │   ├── src/
-│   │   └── package.json
-│   │
-│   └── http-api/
-│       ├── src/
-│       └── package.json
-│
-├── .github/
-│   └── workflows/
-│
-├── package.json
-├── pnpm-workspace.yaml
-├── tsconfig.base.json
-└── README.md
-```
-
----
-
-# Packages
-
-## `@loan-risk/core`
-
-Core loan risk analysis engine.
-
-Features:
-
-- Rule engine
-- Risk scoring
-- Plugin support
-- Hooks system
-- Fraud detection
-
----
-
-## `@loan-risk/logger`
-
-Reusable logger package.
-
-Features:
-
-- Info logs
-- Warning logs
-- Error logs
-- Debug logs
-
----
-
-## `@loan-risk/http-api`
-
-Express-based HTTP API for exposing the analyzer.
-
-Features:
-
-- REST API
+- Express server
+- Loan risk analysis endpoint
 - Health endpoint
-- Risk analysis endpoint
+- Swagger documentation
+- TypeScript support
 
 ---
 
 # Installation
 
-## Clone Repository
-
 ```bash
-git clone https://github.com/Aparna-tech-codes/loan-risk-analyzer.git
-```
-
----
-
-## Install Dependencies
-
-```bash
-pnpm install
-```
-
----
-
-# Build Project
-
-```bash
-pnpm -r build
-```
-
----
-
-# Run Type Check
-
-```bash
-pnpm -r exec tsc --noEmit
-```
-
----
-
-# Run Tests
-
-```bash
-pnpm test
-```
-
----
-
-# Coverage Report
-
-```bash
-pnpm coverage
-```
-
----
-
-# Usage Example
-
-## Basic Usage
-
-```ts
-import { calculateRisk } from "@loan-risk/core";
-
-const result = await calculateRisk({
-  fullName: "full name",
-
-  age: 28,
-
-  monthlyIncome: 90000,
-
-  monthlyEMI: 15000,
-
-  requestedLoanAmount: 500000,
-
-  creditScore: 760,
-
-  employmentType: "SALARIED",
-});
-
-console.log(result);
+pnpm add @loan-risk/http-api
 ```
 
 ---
 
-# Result Example
-
-```json
-{
-  "score": 85,
-  "riskLevel": "LOW",
-  "approved": true,
-  "reasons": [],
-  "explanations": []
-}
-```
-
----
-
-# Hooks Example
-
-```ts
-import { calculateRisk } from "@loan-risk/core";
-
-await calculateRisk(applicant, undefined, {
-  hooks: {
-    beforeCalculate: async (ctx) => {
-      console.log("Started");
-    },
-
-    afterCalculate: async (ctx) => {
-      console.log(ctx.result);
-    },
-  },
-});
-```
-
----
-
-# Plugin Example
-
-```ts
-import { createRiskEngine } from "@loan-risk/core";
-
-const engine = createRiskEngine();
-
-engine.use({
-  name: "CUSTOM_PLUGIN",
-
-  rules: [
-    {
-      name: "CUSTOM_RULE",
-
-      async execute() {
-        return {
-          scoreImpact: -5,
-        };
-      },
-    },
-  ],
-});
-```
-
----
-
-# HTTP API
-
-## Start API
+# Development
 
 ```bash
 pnpm --filter @loan-risk/http-api dev
@@ -272,7 +32,9 @@ pnpm --filter @loan-risk/http-api dev
 
 ---
 
-## Health Endpoint
+# API Endpoints
+
+## Health Check
 
 ```http
 GET /health
@@ -280,13 +42,15 @@ GET /health
 
 ---
 
-## Analyze Endpoint
+## Analyze Loan Risk
 
 ```http
 POST /analyze
 ```
 
-### Request
+---
+
+# Example Request
 
 ```json
 {
@@ -302,83 +66,29 @@ POST /analyze
 
 ---
 
-# Development Scripts
-
-## Build
+# Example Response
 
-```bash
-pnpm -r build
-```
-
-## Test
-
-```bash
-pnpm test
-```
-
-## Coverage
-
-```bash
-pnpm coverage
-```
-
-## Type Check
-
-```bash
-pnpm -r exec tsc --noEmit
+```json
+{
+  "success": true,
+  "data": {
+    "score": 85,
+    "riskLevel": "LOW",
+    "approved": true
+  }
+}
 ```
 
 ---
 
-# Automated Testing
-
-This project uses:
-
-- Vitest
-- TypeScript
-- Workspace testing
-
-Current tests:
-
-- Core engine tests
-- Hooks tests
-- Plugin tests
-- Fraud detection tests
-- Performance tests
-
----
-
-# CI/CD
-
-GitHub Actions workflow included.
-
-Automatically runs:
-
-- Install
-- Type checking
-- Build
-- Tests
-
-On every push and pull request.
-
----
-
-# Open Source
+# Swagger Docs
 
-This project is open source under the MIT License.
-
-This repository is an independent personal open-source project and has no relation to any external business or company.
+```txt
+http://localhost:4000/docs
+```
 
 ---
 
 # License
 
-MIT License
-
-Copyright (c) 2026 Aparna Nikam
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction.
-
-See the LICENSE file for full details.
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loan-risk/http-api",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Express HTTP API for loan risk analysis engine",
   "license": "MIT",
   "author": "Aparna Nikam",
@@ -27,8 +27,8 @@
     "swagger-jsdoc": "^6.2.8",
     "swagger-ui-express": "^5.0.1",
     "zod": "^4.4.3",
-    "@loan-risk/core": "1.0.0",
-    "@loan-risk/logger": "1.0.0"
+    "@loan-risk/core": "1.0.1",
+    "@loan-risk/logger": "1.0.1"
   },
   "devDependencies": {
     "@types/cors": "^2.8.19",