diff --git a/src/app/api-management/api-import.util.ts b/src/app/api-management/api-import.util.ts new file mode 100644 index 000000000..13ab86be7 --- /dev/null +++ b/src/app/api-management/api-import.util.ts @@ -0,0 +1,778 @@ +/** + * Copyright since 2025 Mifos Initiative + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +import { ApiMappingRow, KeyValue, kv } from './api-management.service'; + +/** + * Reads what a vendor's documentation or a Postman / browser / cURL capture gives - in any of these shapes - and turns + * it into the pieces of an API: method, URL, path, query parameters, headers, content type, payload, response status, + * response headers, response body, and a first guess at the CBS field mapping. Nothing is sent anywhere. + * + * Understood: + * - a cURL command + * - a Postman collection or a single Postman request / item (with its saved responses) + * - a HAR capture + * - an "API definition" object: { method, url | path, query, headers, body, status, ... } + * - a bare JSON payload (treated as the request body, or the response body on the response side) + * - form text (a=1&b=2) and other raw text + * + * Credentials found in headers or query strings are never kept: the value is replaced by {{secret}} and the row is + * flagged as secret, so a key pasted from a sample cannot end up stored. + */ + +export interface ImportedRequest { + source: string; + method?: string; + /** The full URL when the file had one. */ + url?: string; + /** Scheme and host of the URL, when present. */ + baseUrl?: string; + path?: string; + queryParams: KeyValue[]; + headers: KeyValue[]; + contentType?: string; + body?: string; + /** A response found in the same file (Postman saved response, HAR entry, definition object). */ + response?: ImportedResponse; + notes: string[]; +} + +export interface ImportedResponse { + source: string; + status?: number; + headers: KeyValue[]; + body?: string; + errorBody?: string; + notes: string[]; +} + +const SECRET_HEADERS = + /^(authorization|proxy-authorization|x-api-key|api-key|apikey|authkey|x-auth-token|auth-token|token|x-access-token|cookie|set-cookie|x-hub-signature(-256)?)$/i; +const SECRET_QUERY = /^(key|api[-_]?key|apikey|token|access[-_]?token|auth[-_]?key|secret|password|signature)$/i; +const SECRET = '{{secret}}'; + +// ── small helpers ─────────────────────────────────────────────────────────── + +function isObject(v: unknown): v is Record { + return typeof v === 'object' && v !== null && !Array.isArray(v); +} + +function tryJson(text: string): any { + try { + return JSON.parse(text); + } catch { + return undefined; + } +} + +function prettyJsonOrText(text: string): string { + const parsed = tryJson(text); + return parsed !== undefined && typeof parsed === 'object' ? JSON.stringify(parsed, null, 2) : text; +} + +function bodyToText(body: unknown): string | undefined { + if (body === undefined || body === null) return undefined; + if (typeof body === 'string') return prettyJsonOrText(body); + return JSON.stringify(body, null, 2); +} + +function toKeyValues(source: unknown, kind: 'header' | 'query' | 'plain'): KeyValue[] { + const out: KeyValue[] = []; + const add = (key: unknown, value: unknown, description = '', disabled = false) => { + const k = String(key ?? '').trim(); + if (!k) return; + const secret = (kind === 'header' && SECRET_HEADERS.test(k)) || (kind === 'query' && SECRET_QUERY.test(k)); + out.push({ + key: k, + value: secret ? SECRET : value === undefined || value === null ? '' : String(value), + description, + enabled: !disabled, + secret + }); + }; + if (Array.isArray(source)) { + for (const item of source) { + if (isObject(item)) + add(item.key ?? item.name, item.value, String(item.description ?? ''), item.disabled === true); + } + } else if (isObject(source)) { + for (const [ + k, + v + ] of Object.entries(source)) add(k, v); + } + return out; +} + +/** Splits a URL into its base, path and query without failing on {{placeholders}} or {path} parameters. */ +function splitUrl(raw: string): { baseUrl?: string; path: string; query: KeyValue[] } { + let rest = raw.trim(); + let baseUrl: string | undefined; + const m = /^([a-zA-Z][a-zA-Z0-9+.-]*:\/\/[^/?#]+)(.*)$/.exec(rest); + if (m) { + baseUrl = m[1]; + rest = m[2]; + } + const hash = rest.indexOf('#'); + if (hash >= 0) rest = rest.slice(0, hash); + let queryText = ''; + const q = rest.indexOf('?'); + if (q >= 0) { + queryText = rest.slice(q + 1); + rest = rest.slice(0, q); + } + const query: KeyValue[] = []; + for (const part of queryText.split('&')) { + if (!part) continue; + const eq = part.indexOf('='); + const key = safeDecode(eq >= 0 ? part.slice(0, eq) : part); + const value = eq >= 0 ? safeDecode(part.slice(eq + 1)) : ''; + query.push(...toKeyValues([{ key, value }], 'query')); + } + return { baseUrl, path: rest || '/', query }; +} + +function safeDecode(s: string): string { + try { + return decodeURIComponent(s.replace(/\+/g, ' ')); + } catch { + return s; + } +} + +function detectContentType( + headers: KeyValue[], + body: string | undefined +): { contentType?: string; headers: KeyValue[] } { + const ct = headers.find((h) => h.key.toLowerCase() === 'content-type'); + const rest = headers.filter((h) => h.key.toLowerCase() !== 'content-type'); + if (ct) return { contentType: ct.value.split(';')[0].trim(), headers: rest }; + if (!body) return { headers: rest }; + if (tryJson(body) !== undefined) return { contentType: 'application/json', headers: rest }; + if (/^\s* q.secret)) + notes.push('A credential in the query string was replaced by {{secret}} - set it on the Connection tab.'); + if (headers.some((h) => h.secret)) + notes.push('Credentials in the headers were replaced by {{secret}} - set them on the Connection tab.'); + return { + source, + method: method ? method.toUpperCase() : body ? 'POST' : undefined, + url, + baseUrl: parts?.baseUrl, + path: parts?.path, + queryParams, + headers: detected.headers, + contentType: contentTypeHint ?? detected.contentType, + body, + notes + }; +} + +// ── cURL ──────────────────────────────────────────────────────────────────── + +/** Splits a shell command into words, honouring '…' "…" quotes and \ line continuations. */ +function shellWords(command: string): string[] { + const words: string[] = []; + let cur = ''; + let quote: '"' | "'" | null = null; + let started = false; + const text = command.replace(/\\\r?\n/g, ' ').trim(); + for (let i = 0; i < text.length; i++) { + const c = text[i]; + if (quote) { + if (c === quote) quote = null; + else if (c === '\\' && quote === '"' && i + 1 < text.length) cur += text[++i]; + else cur += c; + } else if (c === '"' || c === "'") { + quote = c; + started = true; + } else if (/\s/.test(c)) { + if (started || cur) words.push(cur); + cur = ''; + started = false; + } else if (c === '\\' && i + 1 < text.length) { + cur += text[++i]; + } else { + cur += c; + } + } + if (started || cur) words.push(cur); + return words; +} + +function parseCurl(text: string): ImportedRequest { + const words = shellWords(text); + const notes: string[] = []; + let method: string | undefined; + let url: string | undefined; + const headers: KeyValue[] = []; + const data: string[] = []; + let form = false; + let getMode = false; + for (let i = 0; i < words.length; i++) { + const w = words[i]; + const next = () => words[++i] ?? ''; + if (w === 'curl') continue; + if (w === '-X' || w === '--request') method = next(); + else if (w === '-H' || w === '--header') { + const h = next(); + const c = h.indexOf(':'); + if (c > 0) headers.push(...toKeyValues([{ key: h.slice(0, c), value: h.slice(c + 1).trim() }], 'header')); + } else if ([ + '-d', + '--data', + '--data-raw', + '--data-binary', + '--data-ascii' + ].includes(w)) data.push(next()); + else if (w === '--data-urlencode') { + data.push(next()); + form = true; + } else if (w === '-F' || w === '--form') { + data.push(next()); + form = true; + notes.push('Multipart form fields were read as name=value pairs.'); + } else if (w === '--url') url = next(); + else if (w === '-G' || w === '--get') getMode = true; + else if (w === '-u' || w === '--user') { + next(); + headers.push({ + key: 'Authorization', + value: SECRET, + description: 'Basic authentication from the cURL -u option', + enabled: true, + secret: true + }); + } else if (w.startsWith('-')) { + // Flags that take a value we do not need. + if ([ + '-o', + '--output', + '-A', + '--user-agent', + '-e', + '--referer', + '--connect-timeout', + '-m', + '--max-time', + '--proxy', + '-x' + ].includes(w)) next(); + } else if (!url && /^[a-zA-Z][a-zA-Z0-9+.-]*:\/\//.test(w)) url = w; + else if (!url && /^[\w.-]+(:\d+)?\//.test(w)) url = w; + } + let body = data.length ? data.join('&') : undefined; + if (body && getMode) { + url = url + (url?.includes('?') ? '&' : '?') + body; + body = undefined; + } + return finishRequest( + 'cURL command', + method ?? (getMode ? 'GET' : body ? 'POST' : 'GET'), + url, + undefined, + undefined, + headers, + body ? prettyJsonOrText(body) : undefined, + form && !headers.some((h) => h.key.toLowerCase() === 'content-type') + ? 'application/x-www-form-urlencoded' + : undefined, + notes + ); +} + +// ── Postman / HAR / definition object ─────────────────────────────────────── + +function findPostmanItem(node: any): any { + if (!node) return undefined; + if (node.request) return node; + if (Array.isArray(node.item)) { + for (const child of node.item) { + const found = findPostmanItem(child); + if (found) return found; + } + } + return undefined; +} + +function postmanUrl(url: any): string | undefined { + if (!url) return undefined; + if (typeof url === 'string') return url; + if (typeof url.raw === 'string') return url.raw; + const host = Array.isArray(url.host) ? url.host.join('.') : url.host; + const path = Array.isArray(url.path) ? url.path.join('/') : url.path; + return `${url.protocol ? url.protocol + '://' : ''}${host ?? ''}/${path ?? ''}`; +} + +function postmanResponse(r: any): ImportedResponse { + return { + source: 'Postman saved response', + status: typeof r?.code === 'number' ? r.code : undefined, + headers: toKeyValues(r?.header, 'header'), + body: bodyToText(r?.body), + notes: [] + }; +} + +function fromPostman(item: any): ImportedRequest { + const req = item.request; + const notes: string[] = []; + let body: string | undefined; + let contentType: string | undefined; + const b = req?.body; + if (b?.mode === 'raw') { + body = bodyToText(b.raw); + const lang = b.options?.raw?.language; + if (lang === 'json') contentType = 'application/json'; + } else if (b?.mode === 'urlencoded') { + body = (b.urlencoded ?? []) + .filter((p: any) => !p.disabled) + .map((p: any) => `${encodeURIComponent(p.key)}=${encodeURIComponent(p.value ?? '')}`) + .join('&'); + contentType = 'application/x-www-form-urlencoded'; + } else if (b?.mode === 'formdata') { + body = (b.formdata ?? []).map((p: any) => `${p.key}=${p.value ?? ''}`).join('&'); + contentType = 'multipart/form-data'; + } + const request = finishRequest( + 'Postman request', + typeof req?.method === 'string' ? req.method : undefined, + postmanUrl(req?.url), + undefined, + undefined, + toKeyValues(req?.header, 'header'), + body, + contentType, + notes + ); + if (Array.isArray(item.response) && item.response.length) request.response = postmanResponse(item.response[0]); + if (req?.auth) + notes.push('The request had an auth section; it was not read. Set authentication on the Connection tab.'); + return request; +} + +function fromHar(har: any): ImportedRequest { + const entry = har.log.entries[0]; + const r = entry.request ?? {}; + const body = r.postData?.text ? prettyJsonOrText(r.postData.text) : undefined; + const request = finishRequest( + 'HAR capture', + r.method, + r.url, + undefined, + undefined, + toKeyValues(r.headers, 'header'), + body, + typeof r.postData?.mimeType === 'string' ? r.postData.mimeType.split(';')[0] : undefined, + [] + ); + const res = entry.response; + if (res) { + request.response = { + source: 'HAR capture', + status: typeof res.status === 'number' ? res.status : undefined, + headers: toKeyValues(res.headers, 'header'), + body: res.content?.text ? prettyJsonOrText(res.content.text) : undefined, + notes: [] + }; + } + return request; +} + +function definitionResponse(def: any): ImportedResponse | undefined { + const r = def.response ?? def.responseDefinition; + const status = def.status ?? def.statusCode ?? def.successCode ?? r?.status ?? r?.statusCode ?? r?.code; + const headers = def.responseHeaders ?? r?.headers; + const body = def.responseBody ?? (isObject(r) ? (r.body ?? r.data) : r); + const errorBody = def.errorBody ?? def.errorResponse ?? r?.errorBody; + if (status === undefined && headers === undefined && body === undefined && errorBody === undefined) return undefined; + return { + source: 'API definition', + status: typeof status === 'number' ? status : status ? Number(status) || undefined : undefined, + headers: toKeyValues(headers, 'header'), + body: bodyToText(body), + errorBody: bodyToText(errorBody), + notes: [] + }; +} + +function fromDefinition(def: any): ImportedRequest { + const body = def.body ?? def.payload ?? def.data ?? def.requestBody ?? def.request; + const bodyText = isObject(body) && ('method' in body || 'url' in body) ? undefined : bodyToText(body); + const url = def.url ?? def.endpoint ?? def.uri; + const request = finishRequest( + 'API definition', + def.method ?? def.httpMethod, + typeof url === 'string' ? url : undefined, + typeof def.path === 'string' ? def.path : undefined, + def.query ?? def.queryParams ?? def.params, + toKeyValues(def.headers, 'header'), + bodyText, + typeof def.contentType === 'string' ? def.contentType : undefined, + [] + ); + request.response = definitionResponse(def); + return request; +} + +// ── public: request side ──────────────────────────────────────────────────── + +export function parseRequestText(text: string): ImportedRequest { + const t = (text ?? '').trim(); + if (!t) throw new Error('Nothing to read - paste the request or choose a file.'); + if (/^curl\b/i.test(t)) return parseCurl(t); + + const parsed = tryJson(t); + if (parsed === undefined) { + // Not JSON: a cURL command in the middle of text, form data, or other raw text. + const curl = /curl\b[\s\S]*/i.exec(t); + if (curl && /https?:\/\//.test(curl[0])) return parseCurl(curl[0]); + const detected = detectContentType([], t); + return finishRequest('Raw text', undefined, undefined, undefined, undefined, [], t, detected.contentType, [ + 'The text is not JSON; it was kept as the request payload.' + ]); + } + if (isObject(parsed) && isObject(parsed.log) && Array.isArray(parsed.log.entries) && parsed.log.entries.length) + return fromHar(parsed); + if (isObject(parsed) && (parsed.item || parsed.info?.schema)) { + const item = findPostmanItem(parsed); + if (!item) throw new Error('The Postman collection has no request in it.'); + return fromPostman(item); + } + if ( + isObject(parsed) && + isObject(parsed.request) && + (parsed.request.url || parsed.request.method || parsed.request.header) + ) + return fromPostman(parsed); + if (isObject(parsed) && [ + 'method', + 'httpMethod', + 'url', + 'endpoint', + 'uri', + 'headers', + 'queryParams', + 'requestBody', + 'payload' + ].some((k) => k in parsed) && !('statuses' in parsed)) { + return fromDefinition(parsed); + } + // A bare JSON payload. + return finishRequest( + 'JSON payload', + undefined, + undefined, + undefined, + undefined, + [], + JSON.stringify(parsed, null, 2), + 'application/json', + [] + ); +} + +// ── public: response side ─────────────────────────────────────────────────── + +export function parseResponseText(text: string): ImportedResponse { + const t = (text ?? '').trim(); + if (!t) throw new Error('Nothing to read - paste the response or choose a file.'); + const parsed = tryJson(t); + if (parsed === undefined) { + return { + source: 'Raw text', + headers: [], + body: t, + notes: ['The text is not JSON; it was kept as the response body.'] + }; + } + if (isObject(parsed) && isObject(parsed.log) && Array.isArray(parsed.log.entries) && parsed.log.entries.length) { + return ( + fromHar(parsed).response ?? { source: 'HAR capture', headers: [], notes: ['The HAR entry has no response.'] } + ); + } + if (isObject(parsed) && (parsed.item || parsed.info?.schema)) { + const item = findPostmanItem(parsed); + const res = item ? fromPostman(item).response : undefined; + if (!res) throw new Error('The Postman collection has no saved response.'); + return res; + } + if (isObject(parsed) && Array.isArray(parsed.response) && parsed.response.length && (parsed.request || parsed.name)) { + return postmanResponse(parsed.response[0]); + } + if (isObject(parsed) && [ + 'status', + 'statusCode', + 'headers', + 'responseHeaders', + 'responseBody', + 'errorBody' + ].some( + (k) => k in parsed + ) && ('body' in parsed || 'responseBody' in parsed || 'headers' in parsed || 'responseHeaders' in parsed || 'errorBody' in parsed || 'data' in parsed)) { + const r = definitionResponse({ + status: parsed.status ?? parsed.statusCode, + responseHeaders: parsed.responseHeaders ?? parsed.headers, + responseBody: parsed.responseBody ?? parsed.body ?? parsed.data, + errorBody: parsed.errorBody + }); + if (r) return r; + } + return { source: 'JSON body', headers: [], body: JSON.stringify(parsed, null, 2), notes: [] }; +} + +// ── JSON → mapping rows ───────────────────────────────────────────────────── + +export interface JsonLeaf { + path: string; + value: unknown; +} + +/** Every value in a JSON document with its path: `a.b[0].c`. Only the first item of an array is walked. */ +export function flatten(json: unknown, prefix = ''): JsonLeaf[] { + const out: JsonLeaf[] = []; + if (Array.isArray(json)) { + if (json.length) out.push(...flatten(json[0], `${prefix}[0]`)); + } else if (isObject(json)) { + for (const [ + k, + v + ] of Object.entries(json)) { + out.push(...flatten(v, prefix ? `${prefix}.${k}` : k)); + } + } else if (prefix) { + out.push({ path: prefix, value: json }); + } + return out; +} + +function lastKey(path: string): string { + const m = /([A-Za-z0-9_$-]+)(\[\d+\])*$/.exec(path); + return m ? m[1] : path; +} + +const norm = (s: string) => s.toLowerCase().replace(/[^a-z0-9]/g, ''); + +const REQUEST_GUESS: [RegExp, string, boolean][] = [ + [ + /^(mobile|mobiles|mobileno|mobilenumber|msisdn|phone|phoneno|phonenumber|to|destination|recipient|recipients|number|contact)$/, + 'customer.mobile', + true + ], + [ + /^(templateid|template|templatename|dlttemplateid|flowid)$/, + 'message.templateId', + true + ], + [ + /^(message|text|body|content|sms|msg|smstext|var1|messagetext)$/, + 'message.text', + true + ], + [ + /^(sender|senderid|from|source|shortcode)$/, + 'bank.senderId', + false + ], + [ + /^(email|emailid|mail|emailaddress)$/, + 'customer.email', + false + ], + [ + /^(customername|fullname|firstname|name)$/, + 'customer.name', + false + ], + [ + /^(otp|code|pin)$/, + 'message.otp', + false + ], + [ + /^(pan|pannumber)$/, + 'customer.pan', + false + ], + [ + /^(aadhaar|aadhar|aadhaarnumber)$/, + 'customer.aadhaar', + false + ], + [ + /^(dob|dateofbirth|birthdate)$/, + 'customer.dob', + false + ], + [ + /^(membercode|memberid|memberreference)$/, + 'bank.memberCode', + false + ], + [ + /^(accountno|accountnumber|acno|account)$/, + 'account.number', + false + ], + [ + /^(cif|customerid|clientid|cifno)$/, + 'customer.cif', + false + ], + [ + /^(amount|amt|txnamount|transactionamount)$/, + 'txn.amount', + false + ], + [ + /^(txnid|transactionid|transactionreference|txnref)$/, + 'txn.reference', + false + ], + [ + /^(txndate|transactiondate)$/, + 'txn.date', + false + ], + [ + /^(fromdate|startdate|datefrom)$/, + 'request.fromDate', + false + ], + [ + /^(todate|enddate|dateto)$/, + 'request.toDate', + false + ], + [ + /^(reference|referenceno|referencenumber|ref|requestid|clientreference|correlationid)$/, + 'request.reference', + false + ], + [ + /^(tenantidentifier|tenantid)$/, + 'tenant.identifier', + false + ], + [ + /^(providerid)$/, + 'sms.providerId', + false + ] +]; + +function guessTransform(cbsField: string, value: unknown): string { + if (cbsField === 'customer.mobile') return 'DIGITS_ONLY'; + if (cbsField === 'customer.email') return 'LOWER'; + if (cbsField === 'bank.senderId') return 'UPPER'; + if (cbsField === 'txn.amount') return 'NUMBER'; + if (typeof value === 'boolean') return 'BOOLEAN'; + if (typeof value === 'number') return 'NUMBER'; + if (typeof value === 'string') { + if (/^\d{8}$/.test(value) && cbsField.includes('Date')) return 'DATE_DDMMYYYY'; + if (/^\d{4}-\d{2}-\d{2}/.test(value)) return 'DATE_YYYY_MM_DD'; + } + return 'NONE'; +} + +/** + * A first mapping for a request payload: each value that looks like a known CBS field (mobile, message, template, + * sender ...) becomes "CBS field → path"; every other value becomes a fixed value at its path, so the whole payload is + * reproduced. Review and adjust. + */ +export function guessRequestRows(bodyText: string): ApiMappingRow[] { + const parsed = tryJson(bodyText); + if (parsed === undefined || typeof parsed !== 'object' || parsed === null) return []; + const rows: ApiMappingRow[] = []; + const used = new Set(); + for (const leaf of flatten(parsed)) { + const key = norm(lastKey(leaf.path)); + const hit = REQUEST_GUESS.find(([re]) => re.test(key)); + if (hit && !used.has(hit[1])) { + used.add(hit[1]); + rows.push({ + from: hit[1], + to: leaf.path, + transform: guessTransform(hit[1], leaf.value), + defaultValue: '', + mandatory: hit[2] + }); + } else { + rows.push({ + from: '', + to: leaf.path, + transform: guessTransform('', leaf.value), + defaultValue: leaf.value === null ? '' : String(leaf.value), + mandatory: false + }); + } + } + return rows.filter((r) => r.from || r.defaultValue); +} + +/** + * A first mapping for a response body: every value at its path → a CBS field named after the vendor and the key + * (`sms.messageId`). Ids / references are marked required. + */ +export function guessResponseRows(bodyText: string, vendorCode: string): ApiMappingRow[] { + const parsed = tryJson(bodyText); + if (parsed === undefined || typeof parsed !== 'object' || parsed === null) return []; + const prefix = vendorCode.toLowerCase().split('_')[0] || 'vendor'; + const rows: ApiMappingRow[] = []; + const used = new Set(); + for (const leaf of flatten(parsed)) { + const key = lastKey(leaf.path); + const n = norm(key); + let target: string; + if (/^(messageid|msgid|id|reference|requestid|referenceid|messageid)$/.test(n)) target = 'reference'; + else if (/^(status|state|result|type)$/.test(n)) target = 'status'; + else if (/^(error|errormessage|errormsg|reason|detail|description)$/.test(n)) target = 'error'; + else target = key.replace(/[^A-Za-z0-9]+(.)?/g, (_m, c: string) => (c ? c.toUpperCase() : '')); + let to = `${prefix}.${target}`; + for (let i = 2; used.has(to); i++) to = `${prefix}.${target}${i}`; + used.add(to); + rows.push({ + from: leaf.path, + to, + transform: target === 'status' ? 'UPPER' : guessTransform('', leaf.value), + defaultValue: '', + mandatory: target === 'reference' + }); + } + return rows; +} + +export function secretNote(rows: KeyValue[]): string | null { + const n = rows.filter((r) => r.secret).length; + return n ? `${n} credential value(s) were hidden.` : null; +} + +export { kv }; diff --git a/src/app/api-management/api-key-value-editor/api-key-value-editor.component.html b/src/app/api-management/api-key-value-editor/api-key-value-editor.component.html new file mode 100644 index 000000000..c13a8f1e4 --- /dev/null +++ b/src/app/api-management/api-key-value-editor/api-key-value-editor.component.html @@ -0,0 +1,61 @@ + + +@if (!rows.length) { +
{{ emptyText }}
+} @else { +
+ + + + + + + + + @if (!fixedKeys) { + + } + + + + @for (r of rows; track $index; let i = $index) { + + + + + + + @if (!fixedKeys) { + + } + + } + +
On{{ keyLabel }}{{ valueLabel }}NoteSecret
+ + + + + + + + + +
+
+} +@if (!fixedKeys) { + +} diff --git a/src/app/api-management/api-key-value-editor/api-key-value-editor.component.ts b/src/app/api-management/api-key-value-editor/api-key-value-editor.component.ts new file mode 100644 index 000000000..e3b3b0910 --- /dev/null +++ b/src/app/api-management/api-key-value-editor/api-key-value-editor.component.ts @@ -0,0 +1,44 @@ +/** + * Copyright since 2025 Mifos Initiative + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +import { CommonModule } from '@angular/common'; +import { Component, Input } from '@angular/core'; +import { FormsModule } from '@angular/forms'; + +import { KeyValue } from '../api-management.service'; + +/** An editable table of name / value pairs: headers, query parameters, path parameters. Edits the array in place. */ +@Component({ + selector: 'mifosx-api-key-value-editor', + standalone: true, + imports: [ + CommonModule, + FormsModule + ], + templateUrl: './api-key-value-editor.component.html', + styleUrls: ['../../credit-bureau/cic-shared.scss'] +}) +export class ApiKeyValueEditorComponent { + @Input() rows: KeyValue[] = []; + @Input() keyLabel = 'Name'; + @Input() valueLabel = 'Value'; + @Input() keyPlaceholder = ''; + @Input() valuePlaceholder = ''; + @Input() addLabel = '+ Add'; + /** Path parameters come from the path itself; the names cannot be edited or removed. */ + @Input() fixedKeys = false; + @Input() emptyText = 'None.'; + + add(): void { + this.rows.push({ key: '', value: '', description: '', enabled: true, secret: false }); + } + + remove(i: number): void { + this.rows.splice(i, 1); + } +} diff --git a/src/app/api-management/api-log-detail/api-log-detail.component.html b/src/app/api-management/api-log-detail/api-log-detail.component.html new file mode 100644 index 000000000..fa7262a55 --- /dev/null +++ b/src/app/api-management/api-log-detail/api-log-detail.component.html @@ -0,0 +1,55 @@ + + +@if (log) { +
+
+

+ {{ log.vendorName }} · {{ log.apiName }} + {{ + log.direction + }} + {{ + log.result + }} +

+
+
Reference
+
{{ log.reference }}
+
Call
+
{{ log.method }} {{ log.url }}
+
Result
+
HTTP {{ log.httpStatus }} in {{ log.durationMs }} ms · {{ log.time | slice: 0 : 16 }}
+ @if (log.error) { +
Error
+
{{ log.error }}
+ } +
+
+
+

+ {{ log.direction === 'OUT' ? 'Request headers' : 'Headers received / sent' }} + (credentials masked) +

+ 
{{ log.requestHeaders }}
+

Request payload

+ 
{{ log.request || '(empty)' }}
+
+
+

Response headers

+ 
{{ log.responseHeaders }}
+

Response body

+ 
{{ log.response || '(empty)' }}
+
+
+
+ +
+
+
+} diff --git a/src/app/api-management/api-log-detail/api-log-detail.component.ts b/src/app/api-management/api-log-detail/api-log-detail.component.ts new file mode 100644 index 000000000..bfffa3eea --- /dev/null +++ b/src/app/api-management/api-log-detail/api-log-detail.component.ts @@ -0,0 +1,25 @@ +/** + * Copyright since 2025 Mifos Initiative + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +import { CommonModule } from '@angular/common'; +import { Component, EventEmitter, Input, Output } from '@angular/core'; + +import { ApiLog } from '../api-management.service'; + +/** One API call: what was sent and what came back. */ +@Component({ + selector: 'mifosx-api-log-detail', + standalone: true, + imports: [CommonModule], + templateUrl: './api-log-detail.component.html', + styleUrls: ['../../credit-bureau/cic-shared.scss'] +}) +export class ApiLogDetailComponent { + @Input() log: ApiLog | null = null; + @Output() closed = new EventEmitter(); +} diff --git a/src/app/api-management/api-logs/api-logs.component.html b/src/app/api-management/api-logs/api-logs.component.html new file mode 100644 index 000000000..339081a13 --- /dev/null +++ b/src/app/api-management/api-logs/api-logs.component.html @@ -0,0 +1,122 @@ + + +
+
+
+

API Call Logs

+

Every API call the CBS made (OUT) or received (IN), across all vendors, with its request and response.

+
+
+ ← All vendors +
+
+ +
+
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+
+ + +
+
+ +
+

+ {{ total }} call(s) + + {{ success }} success · + {{ failed }} failed + +

+ @if (loading && !items.length) { +
Loading…
+ } @else if (!items.length) { +
No call matches the filter.
+ } @else { +
+ + + + + + + + + + + + + + + + @for (l of items; track l.id) { + + + + + + + + + + + + } + +
TimeVendorAPIDirectionCallHTTPmsResultReference
{{ l.time | slice: 0 : 16 }}{{ l.vendorName }}{{ l.apiName }} + {{ + l.direction + }} + {{ l.method }} {{ l.path }}{{ l.httpStatus }}{{ l.durationMs }} + {{ + l.result + }} + {{ l.reference }}
+
+
+ {{ offset + 1 }}–{{ offset + items.length }} of {{ total }} + + + + +
+ } +
+
+ + diff --git a/src/app/api-management/api-logs/api-logs.component.ts b/src/app/api-management/api-logs/api-logs.component.ts new file mode 100644 index 000000000..447bd8e82 --- /dev/null +++ b/src/app/api-management/api-logs/api-logs.component.ts @@ -0,0 +1,77 @@ +/** + * Copyright since 2025 Mifos Initiative + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +import { CommonModule } from '@angular/common'; +import { Component, OnInit, inject } from '@angular/core'; +import { FormsModule } from '@angular/forms'; +import { ActivatedRoute, RouterModule } from '@angular/router'; + +import { ApiLogDetailComponent } from '../api-log-detail/api-log-detail.component'; +import { ApiLog, ApiManagementService, ApiVendor } from '../api-management.service'; + +/** Every API call, IN and OUT, across all vendors, with its request and response. */ +@Component({ + selector: 'mifosx-api-logs', + standalone: true, + imports: [ + CommonModule, + FormsModule, + RouterModule, + ApiLogDetailComponent + ], + templateUrl: './api-logs.component.html', + styleUrls: ['../../credit-bureau/cic-shared.scss'] +}) +export class ApiLogsComponent implements OnInit { + private service = inject(ApiManagementService); + private route = inject(ActivatedRoute); + + vendors: ApiVendor[] = []; + filter = { vendorId: '', direction: '', result: '', search: '' }; + items: ApiLog[] = []; + total = 0; + success = 0; + failed = 0; + offset = 0; + readonly limit = 15; + loading = false; + openLog: ApiLog | null = null; + + ngOnInit(): void { + const vendorId = this.route.snapshot.queryParamMap.get('vendorId'); + if (vendorId) this.filter.vendorId = vendorId; + this.service.vendors().subscribe((v) => (this.vendors = v)); + this.load(); + } + + load(): void { + this.loading = true; + this.service.logs({ ...this.filter, offset: this.offset, limit: this.limit }).subscribe((r) => { + this.items = r.items; + this.total = r.total; + this.success = r.success; + this.failed = r.failed; + this.loading = false; + }); + } + + apply(): void { + this.offset = 0; + this.load(); + } + + reset(): void { + this.filter = { vendorId: '', direction: '', result: '', search: '' }; + this.apply(); + } + + page(delta: number): void { + this.offset = Math.max(0, this.offset + delta * this.limit); + this.load(); + } +} diff --git a/src/app/api-management/api-management-routing.module.ts b/src/app/api-management/api-management-routing.module.ts new file mode 100644 index 000000000..1cf94c6c6 --- /dev/null +++ b/src/app/api-management/api-management-routing.module.ts @@ -0,0 +1,58 @@ +/** + * Copyright since 2025 Mifos Initiative + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +import { NgModule } from '@angular/core'; +import { Routes, RouterModule } from '@angular/router'; + +import { Route } from '../core/route/route.service'; +import { ApiVendorsComponent } from './api-vendors/api-vendors.component'; +import { ApiVendorSetupComponent } from './api-vendor-setup/api-vendor-setup.component'; +import { ApiLogsComponent } from './api-logs/api-logs.component'; + +const routes: Routes = [ + Route.withShell([ + { + path: 'api-management', + data: { title: 'API Management', breadcrumb: 'API Management' }, + children: [ + { + path: '', + redirectTo: 'vendors', + pathMatch: 'full' + }, + { + path: 'vendors', + data: { breadcrumb: 'Vendors' }, + children: [ + { + path: '', + component: ApiVendorsComponent, + data: { title: 'API Vendors & Setup' } + }, + { + path: ':id', + component: ApiVendorSetupComponent, + data: { title: 'Vendor Setup', breadcrumb: 'Setup' } + } + ] + }, + { + path: 'logs', + component: ApiLogsComponent, + data: { title: 'API Call Logs', breadcrumb: 'Call Logs' } + } + ] + } + ]) +]; + +@NgModule({ + imports: [RouterModule.forChild(routes)], + exports: [RouterModule] +}) +export class ApiManagementRoutingModule {} diff --git a/src/app/api-management/api-management.module.ts b/src/app/api-management/api-management.module.ts new file mode 100644 index 000000000..6ee7ef247 --- /dev/null +++ b/src/app/api-management/api-management.module.ts @@ -0,0 +1,29 @@ +/** + * Copyright since 2025 Mifos Initiative + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +import { NgModule } from '@angular/core'; + +import { SharedModule } from '../shared/shared.module'; +import { ApiManagementRoutingModule } from './api-management-routing.module'; +import { ApiVendorsComponent } from './api-vendors/api-vendors.component'; +import { ApiVendorSetupComponent } from './api-vendor-setup/api-vendor-setup.component'; +import { ApiLogsComponent } from './api-logs/api-logs.component'; +import { ApiLogDetailComponent } from './api-log-detail/api-log-detail.component'; + +/** API Management: connect any outside API service (CIC, SMS, WhatsApp ...) - vendor, work, API set, IN / OUT. */ +@NgModule({ + imports: [ + SharedModule, + ApiManagementRoutingModule, + ApiVendorsComponent, + ApiVendorSetupComponent, + ApiLogsComponent, + ApiLogDetailComponent + ] +}) +export class ApiManagementModule {} diff --git a/src/app/api-management/api-management.service.ts b/src/app/api-management/api-management.service.ts new file mode 100644 index 000000000..84ff6f4c6 --- /dev/null +++ b/src/app/api-management/api-management.service.ts @@ -0,0 +1,1042 @@ +/** + * Copyright since 2025 Mifos Initiative + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +import { Injectable } from '@angular/core'; +import { Observable, delay, of, throwError } from 'rxjs'; + +/** + * API Management: every outside API service the CBS talks to, set up the same way - Vendor → Work → API set - with a + * direction for each API. + * + * OUT - the CBS calls the vendor (send an SMS, send a WhatsApp message) + * IN pull - data comes INTO the CBS because the CBS asks the vendor on a schedule (CIC alerts, delivery reports) + * IN push - data comes INTO the CBS because the vendor calls a CBS path (webhook) + * + * Every API carries the whole HTTP picture - method, path, path / query parameters, headers, content type, payload, + * success codes, response headers, success and error bodies - plus the CBS field mapping. It can be typed in, or read + * from a JSON / cURL / Postman / HAR file (see api-import.util.ts). + * + * This is the STATIC version: everything is kept in memory for the session, no backend call is made, and it resets on + * reload. When the backend is built, only this service changes. + */ + +export type ApiDirection = 'IN' | 'OUT'; +export type ApiMode = 'PUSH' | 'PULL'; + +/** One header, query parameter or path parameter. */ +export interface KeyValue { + key: string; + value: string; + description: string; + enabled: boolean; + /** Secret values (tokens, keys) are shown masked and never read from an imported file. */ + secret: boolean; +} + +export interface ApiMappingRow { + /** Request mapping: the CBS field. Response mapping: the vendor's JSON path. Empty = a fixed value (see defaultValue). */ + from: string; + /** Request mapping: the vendor's JSON path. Response mapping: the CBS field. */ + to: string; + transform: string; + defaultValue: string; + mandatory: boolean; +} + +export interface VendorApi { + id: number; + name: string; + direction: ApiDirection; + /** IN only: PULL = the CBS asks the vendor on a schedule; PUSH = the vendor calls a CBS path (webhook). */ + mode?: ApiMode; + method: 'POST' | 'PUT' | 'GET' | 'PATCH' | 'DELETE'; + /** Calls the vendor (OUT, IN pull): the vendor's path after its base URL. IN push: the CBS path the vendor calls. */ + path: string; + /** When the CBS uses this API. */ + usedFor: string; + active: boolean; + contentType: string; + pathParams: KeyValue[]; + queryParams: KeyValue[]; + headers: KeyValue[]; + /** The request payload (for IN push: what the vendor sends us). Mapping rows put CBS values into / read values out of it. */ + requestBody: string; + /** Status codes that mean success, e.g. "200, 202". */ + successCodes: string; + responseHeaders: KeyValue[]; + responseBody: string; + errorBody: string; + /** Overrides of the vendor's timeout / retries for this API only. */ + timeoutMs: number | null; + retries: number | null; + /** OUT / IN pull: CBS value → the vendor's request path. IN push: the vendor's incoming path → CBS field. */ + requestRows: ApiMappingRow[]; + /** OUT / IN pull: the vendor's response path → CBS field. IN push: CBS value (or fixed) → our answer path. */ + responseRows: ApiMappingRow[]; +} + +export interface ApiVendor { + id: number; + code: string; + name: string; + /** What this vendor is used for - the "work". */ + work: string; + /** Where this vendor is configured in the CBS today. */ + configNote?: string; + environment: 'SIMULATOR' | 'UAT' | 'PRODUCTION'; + baseUrl: string; + authType: string; + username: string; + apiKeyHeader: string; + hasSecret: boolean; + senderId: string; + timeoutMs: number; + retries: number; + /** Headers sent on every API of this vendor. */ + defaultHeaders: KeyValue[]; + active: boolean; + apis: VendorApi[]; + lastCallOn?: string; + /** Screens that already exist for this vendor (e.g. CIC whitelist and mapping). */ + links: { label: string; route: string }[]; +} + +export interface ApiLog { + id: number; + time: string; + vendorId: number; + vendorName: string; + apiName: string; + direction: ApiDirection; + method: string; + path: string; + url: string; + httpStatus: number; + durationMs: number; + result: 'SUCCESS' | 'FAILED'; + reference: string; + error?: string; + requestHeaders: string; + request: string; + responseHeaders: string; + response: string; +} + +export interface ApiLogFilter { + vendorId?: string; + direction?: string; + result?: string; + search?: string; + offset?: number; + limit?: number; +} + +export const API_AUTH_TYPES: Record = { + NONE: 'None (IP whitelisting / mutual TLS)', + BASIC: 'Basic (user id + password)', + API_KEY: 'API key in a header', + BEARER_TOKEN: 'Static bearer token', + OAUTH2_CLIENT_CREDENTIALS: 'OAuth2 client credentials' +}; + +export const API_METHODS = [ + 'POST', + 'GET', + 'PUT', + 'PATCH', + 'DELETE' +]; + +export const API_CONTENT_TYPES: Record = { + 'application/json': 'JSON (application/json)', + 'application/x-www-form-urlencoded': 'Form (application/x-www-form-urlencoded)', + 'multipart/form-data': 'Multipart form', + 'application/xml': 'XML (application/xml)', + 'text/xml': 'XML (text/xml)', + 'text/plain': 'Plain text' +}; + +export const API_TRANSFORMS: Record = { + NONE: 'As is', + UPPER: 'UPPER CASE', + LOWER: 'lower case', + DIGITS_ONLY: 'Digits only', + DATE_DDMMYYYY: 'Date ddMMyyyy', + DATE_YYYY_MM_DD: 'Date yyyy-MM-dd', + AMOUNT_INTEGER: 'Amount, whole rupees', + NUMBER: 'Number', + BOOLEAN: 'true / false' +}; + +/** CBS values an OUT request (or an IN answer) can take. */ +export const API_CBS_FIELDS: Record = { + 'customer.name': 'Customer name', + 'customer.mobile': 'Customer mobile number', + 'customer.email': 'Customer e-mail', + 'customer.cif': 'Customer CIF / client number', + 'customer.pan': 'Customer PAN', + 'customer.aadhaar': 'Customer Aadhaar (masked)', + 'customer.dob': 'Customer date of birth', + 'account.number': 'Account number', + 'txn.amount': 'Transaction amount', + 'txn.reference': 'Transaction reference', + 'txn.date': 'Transaction date', + 'message.text': 'Message text', + 'message.templateId': 'Message template id', + 'message.otp': 'One-time password', + 'bank.senderId': 'Bank sender id', + 'bank.memberCode': 'Bank member code', + 'request.reference': 'Request reference number', + 'request.fromDate': 'From date', + 'request.toDate': 'To date', + 'sms.queueId': 'SMS queue id', + 'sms.providerId': 'SMS provider id', + 'tenant.identifier': 'Tenant identifier' +}; + +const DAY = 86_400_000; + +function ago(minutes: number): string { + return new Date(Date.now() - minutes * 60_000).toISOString().slice(0, 19); +} + +function row(from: string, to: string, transform = 'NONE', mandatory = false, defaultValue = ''): ApiMappingRow { + return { from, to, transform, defaultValue, mandatory }; +} + +export function kv(key: string, value: string, description = '', secret = false, enabled = true): KeyValue { + return { key, value, description, enabled, secret }; +} + +function api( + p: Partial & Pick +): VendorApi { + return { + active: true, + contentType: 'application/json', + pathParams: [], + queryParams: [], + headers: [], + requestBody: '{}', + successCodes: '200', + responseHeaders: [], + responseBody: '{}', + errorBody: '{}', + timeoutMs: null, + retries: null, + requestRows: [], + responseRows: [], + ...p + }; +} + +const pretty = (v: unknown) => JSON.stringify(v, null, 2); + +export function blankApi(direction: ApiDirection): VendorApi { + return api({ + id: 0, + name: '', + direction, + mode: direction === 'IN' ? 'PUSH' : undefined, + method: 'POST', + path: '', + usedFor: '', + headers: [kv('Accept', 'application/json')] + }); +} + +/** Names of the {param} placeholders in a path (not the {{double}} placeholders). */ +export function pathParamNames(path: string): string[] { + const names: string[] = []; + const re = /(?): boolean { + return a.direction === 'OUT' || a.mode === 'PULL'; +} + +export interface RequestPreview { + method: string; + url: string; + headers: { key: string; value: string }[]; + body: string; +} + +/** The request exactly as it would go out (credentials masked), assembled from the vendor and the API. */ +export function buildRequestPreview(vendor: ApiVendor, a: VendorApi): RequestPreview { + const outbound = callsVendor(a); + let path = a.path; + for (const p of a.pathParams) { + if (p.key) path = path.split(`{${p.key}}`).join(p.value || `{${p.key}}`); + } + const query = a.queryParams + .filter((q) => q.enabled && q.key) + .map((q) => `${encodeURIComponent(q.key)}=${q.secret ? '••••••' : encodeURIComponent(q.value)}`) + .join('&'); + const base = outbound ? vendor.baseUrl || '(vendor base URL not set)' : 'https://'; + const url = + base.replace(/\/+$/, '') + (path.startsWith('/') || !path ? path : '/' + path) + (query ? '?' + query : ''); + + const headers = new Map(); + const put = (k: string, v: string) => headers.set(k.toLowerCase(), { key: k, value: v }); + vendor.defaultHeaders.filter((h) => h.enabled && h.key).forEach((h) => put(h.key, h.secret ? '••••••' : h.value)); + a.headers.filter((h) => h.enabled && h.key).forEach((h) => put(h.key, h.secret ? '••••••' : h.value)); + if (a.method !== 'GET' && a.method !== 'DELETE' && a.contentType) put('Content-Type', a.contentType); + if (outbound) { + if (vendor.authType === 'API_KEY') put(vendor.apiKeyHeader || 'X-API-KEY', '••••••'); + else if (vendor.authType === 'BEARER_TOKEN') put('Authorization', 'Bearer ••••••'); + else if (vendor.authType === 'BASIC') put('Authorization', 'Basic ••••••'); + else if (vendor.authType === 'OAUTH2_CLIENT_CREDENTIALS') put('Authorization', 'Bearer '); + } + return { + method: a.method, + url, + headers: [...headers.values()], + body: a.method === 'GET' || a.method === 'DELETE' ? '' : a.requestBody + }; +} + +function buildVendors(): ApiVendor[] { + return [ + { + id: 1, + code: 'CIC', + name: 'CIC — Credit Information Companies', + work: 'Enquiry alerts: tells us when another lender enquires on one of our customers (CIBIL, Experian, Equifax, CRIF)', + configNote: + 'Each bureau is whitelisted and connected on the CIC Whitelist & Configuration screen; this API set is its alert call.', + environment: 'SIMULATOR', + baseUrl: '', + authType: 'NONE', + username: '', + apiKeyHeader: 'X-API-KEY', + hasSecret: false, + senderId: 'MH00123456', + timeoutMs: 30000, + retries: 1, + defaultHeaders: [kv('Accept', 'application/json', 'Every call asks for JSON')], + active: true, + lastCallOn: ago(55), + links: [ + { label: 'Whitelist & configuration', route: '/credit-bureau/bureaus' }, + { label: 'API mapping', route: '/credit-bureau/api-mapping' }, + { label: 'Credit Bureau dashboard', route: '/credit-bureau/dashboard' } + ], + apis: [ + api({ + id: 101, + name: 'Enquiry alerts', + direction: 'IN', + mode: 'PULL', + method: 'POST', + path: '/monitoring/enquiry-alerts', + usedFor: 'Every 60 minutes the CBS asks each whitelisted bureau for new enquiries on our customers', + queryParams: [kv('version', '1.0', 'API version of the bureau')], + headers: [ + kv('X-Member-Code', '{{bank.memberCode}}', "The bank's member code at the bureau"), + kv('X-Request-Id', '{{request.reference}}', 'Our reference for this fetch') + ], + requestBody: pretty({ + requestHeader: { memberCode: 'MH00123456', referenceNumber: 'CICF000001' }, + criteria: { fromDate: '01102026', toDate: '08102026', scope: 'OTHER_MEMBERS' } + }), + successCodes: '200', + responseHeaders: [ + kv('Content-Type', 'application/json'), + kv('X-RateLimit-Remaining', '98', 'Calls left in this window') + ], + responseBody: pretty({ + responseHeader: { status: 'SUCCESS' }, + data: { + totalAlerts: 1, + alerts: [ + { + alertId: 'CIBIL-20261008-1', + consumer: { pan: 'ABXPS4421K' }, + enquiry: { productType: 'PERSONAL LOAN', amount: 450000, date: '08102026' } + } + ] + } + }), + errorBody: pretty({ + responseHeader: { status: 'ERROR', errorCode: 'E102', errorMessage: 'Invalid member code' } + }), + requestRows: [ + row('bank.memberCode', 'requestHeader.memberCode'), + row('request.reference', 'requestHeader.referenceNumber', 'NONE', true), + row('request.fromDate', 'criteria.fromDate', 'DATE_DDMMYYYY', true), + row('request.toDate', 'criteria.toDate', 'DATE_DDMMYYYY', true), + row('', 'criteria.scope', 'NONE', false, 'OTHER_MEMBERS') + ], + responseRows: [ + row('data.alerts', 'alerts', 'NONE', true), + row('consumer.pan', 'customer.pan', 'UPPER'), + row('enquiry.productType', 'alert.loanType'), + row('enquiry.amount', 'alert.amount', 'NUMBER'), + row('enquiry.date', 'alert.enquiryDate', 'DATE_DDMMYYYY') + ] + }) + ] + }, + { + id: 2, + code: 'SMS_NOTICE', + name: 'SMS Gateway — Customer Notices (MSG91)', + work: 'SMS to customers from the CBS: KYC exception outreach (Log Customer Contact), alerts and reminders — sent on a DLT-registered sender id and template', + configNote: + 'Today this is configured in application.properties as fineract.notification.sms.* (provider, base-url, path, auth-header, body-template, sender-id, template-id). Setting it up here replaces that.', + environment: 'UAT', + baseUrl: 'https://control.msg91.com', + authType: 'API_KEY', + username: '', + apiKeyHeader: 'authkey', + hasSecret: true, + senderId: 'LNCPAY', + timeoutMs: 10000, + retries: 2, + defaultHeaders: [kv('Accept', 'application/json')], + active: true, + lastCallOn: ago(4), + links: [], + apis: [ + api({ + id: 201, + name: 'Customer notice SMS', + direction: 'OUT', + method: 'POST', + path: '/api/v5/flow/', + usedFor: 'Log Customer Contact → SMS on the KYC Exceptions screen, and other one-to-one customer notices', + requestBody: pretty({ + template_id: '1107169123456789012', + sender: 'LNCPAY', + short_url: '0', + recipients: [{ mobiles: '919876543210', VAR1: 'Please submit your PAN to complete KYC. - LincPay' }] + }), + successCodes: '200', + responseHeaders: [kv('Content-Type', 'application/json')], + responseBody: pretty({ type: 'success', data: { messageId: '3166707a4f36323138343631' } }), + errorBody: pretty({ type: 'error', message: 'Authentication failure', code: '401' }), + requestRows: [ + row('message.templateId', 'template_id', 'NONE', true), + row('bank.senderId', 'sender', 'UPPER', true), + row('customer.mobile', 'recipients[0].mobiles', 'DIGITS_ONLY', true), + row('message.text', 'recipients[0].VAR1', 'NONE', true), + row('', 'short_url', 'NONE', false, '0') + ], + responseRows: [ + row('data.messageId', 'sms.reference', 'NONE'), + row('type', 'sms.status', 'UPPER') + ] + }) + ] + }, + { + id: 3, + code: 'SMS_GATEWAY', + name: 'SMS Message Gateway — Campaigns & OTP', + work: 'Queued SMS sent by the CBS scheduler: SMS campaigns, two-factor login OTP and self-service registration OTP — with delivery reports', + configNote: + 'Today this is configured under System → External Services → SMS (host name, port, end point, tenant app key). Jobs: "Send messages to SMS gateway" and "Get delivery reports from SMS gateway".', + environment: 'UAT', + baseUrl: 'http://sms-gateway.internal:9191', + authType: 'API_KEY', + username: '', + apiKeyHeader: 'Fineract-Tenant-App-Key', + hasSecret: true, + senderId: '', + timeoutMs: 20000, + retries: 1, + defaultHeaders: [kv('Fineract-Platform-TenantId', '{{tenant.identifier}}', 'Tenant the messages belong to')], + active: true, + lastCallOn: ago(11), + links: [{ label: 'External services → SMS', route: '/system/external-services/sms' }], + apis: [ + api({ + id: 301, + name: 'Send queued messages', + direction: 'OUT', + method: 'POST', + path: '/sms', + usedFor: + 'Job "Send messages to SMS gateway": campaign SMS, two-factor OTP and registration OTP. The gateway must answer 202 Accepted', + requestBody: pretty([ + { + id: 5821, + tenantIdentifier: 'lincpay', + mobileNo: '9876543210', + message: 'Your LincPay OTP is 482913. Valid for 5 minutes.', + providerId: 1 + } + ]), + successCodes: '202', + responseHeaders: [kv('Content-Length', '0')], + responseBody: '', + errorBody: pretty({ error: 'Unknown SMS provider', providerId: 9 }), + requestRows: [ + row('sms.queueId', '[0].id', 'NUMBER', true), + row('tenant.identifier', '[0].tenantIdentifier', 'NONE', true), + row('customer.mobile', '[0].mobileNo', 'DIGITS_ONLY', true), + row('message.text', '[0].message', 'NONE', true), + row('sms.providerId', '[0].providerId', 'NUMBER') + ] + }), + api({ + id: 302, + name: 'Get delivery reports', + direction: 'IN', + mode: 'PULL', + method: 'POST', + path: '/sms/report', + usedFor: 'Job "Get delivery reports from SMS gateway": the CBS asks for the status of messages it sent', + requestBody: pretty([ + 5821, + 5822 + ]), + successCodes: '200', + responseHeaders: [kv('Content-Type', 'application/json')], + responseBody: pretty([ + { id: 5821, deliveryStatus: 300, hasError: false }, + { id: 5822, deliveryStatus: 400, hasError: true, errorMessage: 'Number is on the DND list' } + ]), + errorBody: pretty({ error: 'Report not available yet' }), + requestRows: [row('sms.queueId', '[0]', 'NUMBER', true)], + responseRows: [ + row('[0].id', 'sms.queueId', 'NUMBER', true), + row('[0].deliveryStatus', 'sms.deliveryStatus', 'NUMBER', true), + row('[0].hasError', 'sms.hasError', 'BOOLEAN'), + row('[0].errorMessage', 'sms.error') + ] + }) + ] + }, + { + id: 4, + code: 'WHATSAPP', + name: 'WhatsApp — Customer Notices (Meta Cloud API)', + work: 'WhatsApp messages to customers from the CBS: KYC exception outreach and notices', + configNote: + 'Today this is configured in application.properties as fineract.notification.whatsapp.* (base-url, path with the phone-number id, bearer token, body-template, country code 91).', + environment: 'SIMULATOR', + baseUrl: 'https://graph.facebook.com', + authType: 'BEARER_TOKEN', + username: '', + apiKeyHeader: 'Authorization', + hasSecret: false, + senderId: '109876543210987', + timeoutMs: 15000, + retries: 1, + defaultHeaders: [kv('Accept', 'application/json')], + active: true, + lastCallOn: ago(190), + links: [], + apis: [ + api({ + id: 401, + name: 'Send customer notice', + direction: 'OUT', + method: 'POST', + path: '/v21.0/{senderId}/messages', + usedFor: 'Log Customer Contact → WhatsApp on the KYC Exceptions screen', + pathParams: [kv('senderId', '{{bank.senderId}}', 'The WhatsApp phone-number id')], + requestBody: pretty({ + messaging_product: 'whatsapp', + to: '919876543210', + type: 'text', + text: { body: 'Please submit your PAN to complete KYC. - LincPay' } + }), + successCodes: '200', + responseHeaders: [ + kv('Content-Type', 'application/json; charset=UTF-8'), + kv('x-fb-trace-id', 'AbCdEf123', 'For Meta support') + ], + responseBody: pretty({ + messaging_product: 'whatsapp', + contacts: [{ input: '919876543210', wa_id: '919876543210' }], + messages: [{ id: 'wamid.HBgMOTE5ODc2NTQzMjEw' }] + }), + errorBody: pretty({ + error: { + message: 'Invalid OAuth access token.', + type: 'OAuthException', + code: 190, + fbtrace_id: 'AbCdEf123' + } + }), + requestRows: [ + row('customer.mobile', 'to', 'DIGITS_ONLY', true), + row('message.text', 'text.body', 'NONE', true), + row('', 'messaging_product', 'NONE', true, 'whatsapp'), + row('', 'type', 'NONE', false, 'text') + ], + responseRows: [row('messages[0].id', 'whatsapp.reference', 'NONE')] + }), + api({ + id: 402, + name: 'Message status', + direction: 'IN', + mode: 'PUSH', + method: 'POST', + path: '/webhooks/whatsapp/status', + usedFor: 'Planned — WhatsApp tells us a message was sent, delivered or read (not used by the CBS yet)', + active: false, + headers: [kv('X-Hub-Signature-256', 'sha256=…', 'Signature we check on every call', true)], + requestBody: pretty({ + statuses: [ + { + id: 'wamid.HBgMOTE5ODc2NTQzMjEw', + status: 'delivered', + timestamp: '1760000000', + recipient_id: '919876543210' + } + ] + }), + successCodes: '200', + responseBody: pretty({ ack: 'OK' }), + errorBody: pretty({ error: 'Invalid signature' }), + requestRows: [ + row('statuses[0].id', 'whatsapp.reference', 'NONE', true), + row('statuses[0].status', 'whatsapp.status', 'UPPER', true) + ], + responseRows: [row('', 'ack', 'NONE', false, 'OK')] + }) + ] + } + ]; +} + +function logFor( + id: number, + time: string, + v: ApiVendor, + a: VendorApi, + status: number, + durationMs: number, + reference: string +): ApiLog { + const p = buildRequestPreview(v, a); + const failed = !a.successCodes + .split(',') + .map((s) => Number(s.trim())) + .includes(status); + return { + id, + time, + vendorId: v.id, + vendorName: v.name, + apiName: a.name, + direction: a.direction, + method: a.method, + path: a.path, + url: p.url, + httpStatus: status, + durationMs, + result: failed ? 'FAILED' : 'SUCCESS', + reference, + error: failed + ? status === 401 + ? 'Vendor refused the credentials' + : status === 429 + ? 'Rate limit exceeded' + : status === 504 + ? 'Vendor timed out' + : 'Vendor returned an internal error' + : undefined, + requestHeaders: pretty( + Object.fromEntries( + p.headers.map((h) => [ + h.key, + h.value + ]) + ) + ), + request: p.body, + responseHeaders: pretty( + Object.fromEntries( + a.responseHeaders + .filter((h) => h.enabled) + .map((h) => [ + h.key, + h.value + ]) + ) + ), + response: failed ? a.errorBody || pretty({ error: 'failed', status }) : a.responseBody + }; +} + +function buildLogs(vendors: ApiVendor[]): ApiLog[] { + const logs: ApiLog[] = []; + let id = 1; + let seed = 7; + const next = () => { + seed = (seed * 1664525 + 1013904223) % 4294967296; + return seed / 4294967296; + }; + for (let i = 0; i < 64; i++) { + const v = vendors[Math.floor(next() * vendors.length)]; + const apis = v.apis.filter((a) => a.active); + const a = apis[Math.floor(next() * apis.length)]; + const failed = next() < 0.14; + const okCode = Number(a.successCodes.split(',')[0]); + const status = failed ? [ + 500, + 504, + 401, + 429 + ][Math.floor(next() * 4)] : okCode; + logs.push( + logFor( + id++, + ago(i * 38 + Math.floor(next() * 30)), + v, + a, + status, + 90 + Math.floor(next() * (failed ? 9000 : 900)), + `${v.code}-${String(2026100000 + i * 17)}` + ) + ); + } + return logs; +} + +function fail(message: string): Observable { + return throwError(() => ({ error: { defaultUserMessage: message } })); +} + +function reply(value: T): Observable { + // A copy, so a screen editing what it got never changes the in-memory "database". + return of(JSON.parse(JSON.stringify(value)) as T).pipe(delay(200)); +} + +const HEADER_NAME = /^[A-Za-z0-9!#$%&'*+.^_`|~-]+$/; + +/** Checks the key / value tables; returns a message or null. */ +function checkPairs(label: string, pairs: KeyValue[], unique: boolean): string | null { + const seen = new Set(); + for (const p of pairs) { + if (!p.key.trim()) return `${label}: a row has no name (fill it in or remove the row).`; + if (label.startsWith('Header') && !HEADER_NAME.test(p.key.trim())) + return `${label}: "${p.key}" is not a valid header name.`; + if (unique && p.enabled) { + const k = p.key.trim().toLowerCase(); + if (seen.has(k)) return `${label}: "${p.key}" is listed twice.`; + seen.add(k); + } + } + return null; +} + +function looksJson(text: string): boolean { + const t = text.trim(); + return t.startsWith('{') || t.startsWith('['); +} + +function jsonError(text: string): string | null { + try { + JSON.parse(text); + return null; + } catch (e: any) { + return String(e?.message ?? e); + } +} + +@Injectable({ providedIn: 'root' }) +export class ApiManagementService { + private vendorList = buildVendors(); + private logList = buildLogs(this.vendorList); + private nextVendorId = 10; + private nextApiId = 1000; + private nextLogId = 1000; + + // ── vendors ── + + vendors(): Observable { + return reply(this.vendorList); + } + + vendor(id: number): Observable { + const v = this.vendorList.find((x) => x.id === id); + return v ? reply(v) : fail('Vendor was not found.'); + } + + addVendor(input: { name: string; work: string; environment: ApiVendor['environment'] }): Observable { + const name = input.name.trim(); + if (!name) return fail('Give the vendor a name.'); + if (!input.work.trim()) return fail('Say what this vendor is used for (its work).'); + if (this.vendorList.some((v) => v.name.toLowerCase() === name.toLowerCase())) { + return fail(`A vendor called "${name}" already exists.`); + } + const vendor: ApiVendor = { + id: this.nextVendorId++, + code: name + .toUpperCase() + .replace(/[^A-Z0-9]+/g, '_') + .replace(/^_|_$/g, '') + .slice(0, 20), + name, + work: input.work.trim(), + environment: input.environment, + baseUrl: '', + authType: 'NONE', + username: '', + apiKeyHeader: 'X-API-KEY', + hasSecret: false, + senderId: '', + timeoutMs: 30000, + retries: 1, + defaultHeaders: [kv('Accept', 'application/json')], + active: false, + links: [], + apis: [] + }; + this.vendorList.push(vendor); + return reply(vendor); + } + + saveVendor(id: number, body: Partial & { secret?: string; clearSecret?: boolean }): Observable { + const v = this.vendorList.find((x) => x.id === id); + if (!v) return fail('Vendor was not found.'); + const name = (body.name ?? v.name).trim(); + if (!name) return fail('Give the vendor a name.'); + const baseUrl = (body.baseUrl ?? v.baseUrl).trim(); + const environment = body.environment ?? v.environment; + if (baseUrl && !/^https?:\/\//.test(baseUrl)) + return fail('Base URL must start with https:// (or http:// for a test server).'); + if (environment === 'PRODUCTION' && baseUrl && !baseUrl.startsWith('https://')) { + return fail('A PRODUCTION vendor must be reached over https://.'); + } + const timeout = Number(body.timeoutMs ?? v.timeoutMs); + if (timeout < 1000 || timeout > 300000) return fail('Timeout must be between 1,000 and 300,000 milliseconds.'); + const retries = Number(body.retries ?? v.retries); + if (retries < 0 || retries > 5) return fail('Retries must be between 0 and 5.'); + const defaultHeaders = body.defaultHeaders ?? v.defaultHeaders; + const headerProblem = checkPairs('Header', defaultHeaders, true); + if (headerProblem) return fail(`Default headers — ${headerProblem}`); + const authType = body.authType ?? v.authType; + const hasSecret = body.clearSecret ? false : body.secret ? true : v.hasSecret; + if (body.active ?? v.active) { + if (environment !== 'SIMULATOR' && !baseUrl) + return fail(`${name} needs a base URL before it can be active in ${environment}.`); + if (environment !== 'SIMULATOR' && authType !== 'NONE' && !hasSecret) { + return fail(`${name} uses ${authType} but no password / key / token is stored.`); + } + } + Object.assign(v, { + name, + work: (body.work ?? v.work).trim(), + environment, + baseUrl, + authType, + username: (body.username ?? v.username).trim(), + apiKeyHeader: (body.apiKeyHeader ?? v.apiKeyHeader).trim() || 'X-API-KEY', + hasSecret, + senderId: (body.senderId ?? v.senderId).trim(), + timeoutMs: timeout, + retries, + defaultHeaders, + active: body.active ?? v.active + }); + return reply(v); + } + + // ── API set ── + + saveApi(vendorId: number, input: VendorApi): Observable { + const v = this.vendorList.find((x) => x.id === vendorId); + if (!v) return fail('Vendor was not found.'); + const a = input; + if (!a.name.trim()) return fail('Give the API a name.'); + const inbound = !callsVendor(a); + if (!a.path.trim()) + return fail(inbound ? 'Enter the CBS path the vendor will call.' : "Enter the vendor's API path."); + if (inbound && !a.path.trim().startsWith('/')) return fail('The CBS path must start with /.'); + if (!a.usedFor.trim()) return fail('Say when the CBS uses this API.'); + + for (const [ + label, + pairs, + unique + ] of [ + [ + 'Header', + a.headers, + true + ], + [ + 'Query parameter', + a.queryParams, + false + ], + [ + 'Path parameter', + a.pathParams, + true + ], + [ + 'Header (response)', + a.responseHeaders, + true + ] + ] as [string, KeyValue[], boolean][]) { + const problem = checkPairs(label, pairs, unique); + if (problem) return fail(problem); + } + for (const name of pathParamNames(a.path)) { + const p = a.pathParams.find((x) => x.key === name); + if (!p || !p.value.trim()) return fail(`The path has {${name}} - give it a value under Path parameters.`); + } + if (a.contentType === 'application/json' && a.requestBody.trim() && looksJson(a.requestBody)) { + const err = jsonError(a.requestBody); + if (err) return fail(`Request payload is not valid JSON: ${err}`); + } + for (const [ + label, + text + ] of [ + [ + 'Success response body', + a.responseBody + ], + [ + 'Error response body', + a.errorBody + ] + ]) { + if (text.trim() && looksJson(text)) { + const err = jsonError(text); + if (err) return fail(`${label} is not valid JSON: ${err}`); + } + } + const codes = a.successCodes + .split(',') + .map((s) => s.trim()) + .filter(Boolean); + if (!codes.length || codes.some((c) => !/^[1-5]\d\d$/.test(c))) { + return fail('Success codes must be HTTP status codes like "200" or "200, 202".'); + } + if (a.timeoutMs !== null && (a.timeoutMs < 1000 || a.timeoutMs > 300000)) { + return fail("The API timeout must be between 1,000 and 300,000 ms (or empty to use the vendor's)."); + } + if (a.retries !== null && (a.retries < 0 || a.retries > 5)) + return fail('The API retries must be between 0 and 5 (or empty).'); + for (const r of [ + ...a.requestRows, + ...a.responseRows + ]) { + if ((!r.from.trim() && !r.defaultValue.trim()) || !r.to.trim()) { + return fail('Every mapping row needs both sides filled in, or a fixed value (or remove the row).'); + } + } + if (a.active && a.direction === 'IN' && !(inbound ? a.requestRows : a.responseRows).length) { + return fail('An active IN API needs at least one incoming-data mapping, or nothing can be read from it.'); + } + if (v.apis.some((x) => x.id !== a.id && x.name.toLowerCase() === a.name.trim().toLowerCase())) { + return fail(`${v.name} already has an API called "${a.name.trim()}".`); + } + const clean: VendorApi = { + ...a, + name: a.name.trim(), + path: a.path.trim(), + usedFor: a.usedFor.trim(), + successCodes: codes.join(', ') + }; + const i = v.apis.findIndex((x) => x.id === a.id); + if (i >= 0) { + v.apis[i] = clean; + } else { + clean.id = this.nextApiId++; + v.apis.push(clean); + } + return reply(clean); + } + + deleteApi(vendorId: number, apiId: number): Observable<{ deleted: boolean }> { + const v = this.vendorList.find((x) => x.id === vendorId); + if (!v) return fail('Vendor was not found.'); + v.apis = v.apis.filter((a) => a.id !== apiId); + return reply({ deleted: true }); + } + + /** Simulated call: nothing leaves the browser; the result is added to the log. */ + testApi(vendorId: number, apiId: number, requestBody: string): Observable { + const v = this.vendorList.find((x) => x.id === vendorId); + const a = v?.apis.find((x) => x.id === apiId); + if (!v || !a) return fail('API was not found.'); + if (a.contentType === 'application/json' && requestBody.trim() && looksJson(requestBody)) { + const err = jsonError(requestBody); + if (err) return fail(`The test request is not valid JSON: ${err}`); + } + if (callsVendor(a) && v.environment !== 'SIMULATOR' && !v.baseUrl) { + return fail(`${v.name} has no base URL for ${v.environment}.`); + } + const log = logFor( + this.nextLogId++, + new Date().toISOString().slice(0, 19), + v, + { ...a, requestBody: requestBody || a.requestBody }, + Number(a.successCodes.split(',')[0]), + 120 + Math.floor(Math.random() * 300), + `${v.code}-TEST-${this.nextLogId}` + ); + this.logList = [ + log, + ...this.logList + ]; + v.lastCallOn = log.time; + return reply(log); + } + + // ── logs ── + + logs(filter: ApiLogFilter): Observable<{ total: number; success: number; failed: number; items: ApiLog[] }> { + const q = (filter.search ?? '').trim().toLowerCase(); + const rows = this.logList.filter( + (l) => + (!filter.vendorId || String(l.vendorId) === String(filter.vendorId)) && + (!filter.direction || l.direction === filter.direction) && + (!filter.result || l.result === filter.result) && + (!q || `${l.reference} ${l.apiName} ${l.vendorName} ${l.path}`.toLowerCase().includes(q)) + ); + const offset = filter.offset ?? 0; + const limit = filter.limit ?? 20; + return reply({ + total: rows.length, + success: rows.filter((l) => l.result === 'SUCCESS').length, + failed: rows.filter((l) => l.result === 'FAILED').length, + items: rows.slice(offset, offset + limit) + }); + } + + /** Numbers for the vendors page: calls in the last 24 hours. */ + summary(): Observable<{ + callsToday: number; + failedToday: number; + perVendor: Record; + }> { + const since = Date.now() - DAY; + const recent = this.logList.filter((l) => new Date(l.time).getTime() >= since); + const perVendor: Record = {}; + for (const l of recent) { + const e = perVendor[l.vendorId] ?? { calls: 0, failed: 0 }; + e.calls++; + if (l.result === 'FAILED') e.failed++; + perVendor[l.vendorId] = e; + } + return reply({ + callsToday: recent.length, + failedToday: recent.filter((l) => l.result === 'FAILED').length, + perVendor + }); + } +} diff --git a/src/app/api-management/api-vendor-setup/api-vendor-setup.component.html b/src/app/api-management/api-vendor-setup/api-vendor-setup.component.html new file mode 100644 index 000000000..83a17dd44 --- /dev/null +++ b/src/app/api-management/api-vendor-setup/api-vendor-setup.component.html @@ -0,0 +1,747 @@ + + +
+
+
+

{{ vendor?.name || 'Vendor setup' }}

+

{{ vendor?.work }}

+
+
+ @if (vendor) { + {{ vendor.active ? 'Active' : 'Switched off' }} + {{ vendor.environment }} + } + ← All vendors +
+
+ + @if (error && !editing && !importOpen) { +
{{ error }}
+ } + @if (info && !editing) { +
{{ info }}
+ } + @if (loading && !vendor) { +
Loading…
+ } + + @if (vendor) { + @if (vendor.configNote) { +
{{ vendor.configNote }}
+ } + @if (vendor.links.length) { +
+ {{ vendor.code }} also has its own screens: + @for (l of vendor.links; track l.route) { + {{ l.label }} + } +
+ } + +
+ + + + +
+ + + @if (tab === 'connection') { +
+

Vendor and connection

+
+
+ + +
+
+ + +
+
+ + +
+
+ + + Every OUT / pull API path is added to this. PRODUCTION needs https://. +
+
+ + +
+ @if (form.authType === 'BASIC') { +
+ + +
+ } + @if (form.authType === 'API_KEY') { +
+ + +
+ } + @if (needsSecret()) { +
+ + + @if (vendor.hasSecret) { + + } +
+ } +
+ + + The bank's id at this vendor (SMS sender id, WhatsApp number id, CIC member code …). +
+
+ + +
+
+ + +
+ +
+ +

+ Default headers + — sent on every API of this vendor (an API can override one) +

+ + +
+ + +
+
+ } + + + @if (tab === 'apis') { +
+

+ API set + + + + +

+ @if (!vendor.apis.length) { +
+ No API yet. Add one, then fill it in by hand or read it from a JSON / cURL / Postman file. +
+ } @else { +
+ + + + + + + + + + + + + + + @for (a of vendor.apis; track a.id) { + + + + + + + + + + + } + +
APIDirectionCallUsed forHeaders / queryMappingActive
+ {{ a.name }} + + {{ + a.direction + }} + @if (a.mode) { + {{ a.mode === 'PULL' ? 'pull' : 'push' }} + } + {{ a.method }} {{ a.path }}{{ a.usedFor }}{{ a.headers.length }} / {{ a.queryParams.length }}{{ a.requestRows.length }} / {{ a.responseRows.length }} + {{ a.active ? 'Yes' : 'Off' }} + + + +
+
+ } +
+ } + + + @if (tab === 'test') { +
+

+ Test an API + simulated — nothing is sent to the vendor; the result is added to the logs +

+ @if (!vendor.apis.length) { +
Add an API first.
+ } @else { +
+ + +
+ @if (testPreview; as p) { +

The request

+ 
{{ p.method }} {{ p.url }}
+@for (h of p.headers; track h.key) {
+{{ h.key }}: {{ h.value }}
+}
+ } +
+ + +
+ + } +
+ @if (testResult) { +
+ {{ testResult.reference }} — HTTP {{ testResult.httpStatus }} in {{ testResult.durationMs }} ms +
+
+
+

Response headers

+ 
{{ testResult.responseHeaders }}
+
+
+

Response body

+ 
{{ testResult.response || '(empty)' }}
+
+
+ } + } + + + @if (tab === 'calls') { +
+

+ Recent calls + All logs +

+ @if (!calls.length) { +
No call yet.
+ } @else { +
+ + + + + + + + + + + + + + @for (l of calls; track l.id) { + + + + + + + + + + } + +
TimeAPIDirectionHTTPmsResultReference
{{ l.time | slice: 0 : 16 }}{{ l.apiName }} + {{ + l.direction + }} + {{ l.httpStatus }}{{ l.durationMs }} + {{ l.result }} + {{ l.reference }}
+
+ } +
+ } + } +
+ + +@if (editing) { +
+
+
+

+ {{ isNewApi ? 'New' : 'Edit' }} API + {{ + editing.direction + }} + @if (editing.mode) { + + {{ editing.mode === 'PULL' ? 'pull' : 'push' }} + } +

+ +
+

+ @if (editing.direction === 'OUT') { + OUT — the CBS calls the vendor: fill the request it sends and the response it expects. + } @else if (editing.mode === 'PULL') { + IN (pull) — the CBS asks the vendor for data on a schedule: fill the request it sends and the response it + reads. + } @else { + IN (push) — the vendor calls a CBS path: fill what the vendor sends us and what we answer. + } + Type everything in, or read it from a file with the import button — then check each tab. +

+ + @if (info) { +
{{ info }}
+ } + @if (error) { +
{{ error }}
+ } + +
+ + + +
+ + + @if (editorTab === 'basics') { +
+
+ + +
+
+ + +
+ @if (editing.direction === 'IN') { +
+ + +
+ } @else { +
+ } +
+ + +
+
+ + + Use {{ '{' }}name{{ '}' }} for a value that changes, e.g. /v21.0/{{ '{' }}senderId{{ + '}' + }}/messages. +
+
+ + +
+
+ + +
+
+ + +
+
+ + + @if (preview(editing); as p) { +

+ {{ outbound ? 'The call as it will go out' : 'The call the vendor will make to us' }} + (credentials masked) +

+ 
{{ p.method }} {{ p.url }}
+@for (h of p.headers; track h.key) {
+{{ h.key }}: {{ h.value }}
+}
+{{ p.body }}
+ } + } + + + @if (editorTab === 'request') { +

Path parameters

+ + +

Query parameters

+ + +

+ Headers + — this API's own; the vendor's default headers and its authentication are added automatically +

+ + +
+
+ + +
+
+ +
+ + + + {{ + outbound + ? 'The constant parts of the payload; the mapping below puts CBS values into it.' + : 'A sample of what arrives; the mapping reads values out of it.' + }} + +
+ +

+ {{ mappingTitle('request') }} + +

+
+ + + + + + + + + + + + + @for (r of editing.requestRows; track $index; let i = $index) { + + + + + + + + + } + +
{{ fromLabel('request') }}{{ toLabel('request') }}TransformFixed / default valueRequired
+ @if (fromIsCbs('request')) { + + } @else { + + } + + + + +
+
+ + } + + + @if (editorTab === 'response') { +
+
+ + + {{ + outbound ? 'Codes the vendor answers with when it worked.' : 'Codes the CBS answers with.' + }} +
+
+ +

+ {{ outbound ? 'Response headers' : 'Headers of our answer' }} +

+ + +
+
+ + +
+
+ + + What comes back when it fails (wrong key, rate limit …) — shown in the logs for a failed call. +
+
+ +

+ {{ mappingTitle('response') }} + +

+
+ + + + + + + + + + + + + @for (r of editing.responseRows; track $index; let i = $index) { + + + + + + + + + } + +
{{ fromLabel('response') }}{{ toLabel('response') }}TransformFixed / default valueRequired
+ @if (fromIsCbs('response')) { + + } @else { + + } + + + + +
+
+ + } + +
+ + +
+
+
+} + + +@if (importOpen && editing) { +
+
+

Import from JSON / cURL / Postman

+

+ Paste it or choose a file — + {{ outbound ? 'the request and the response' : 'what the vendor sends us and what we answer' }}. Any of these + works: a cURL command, a Postman collection or request, a HAR capture, an API definition + ({{ '{' }} method, url, headers, query, body, status … {{ '}' }}), or just the JSON payload. The method, URL / path, query parameters, headers, content type, payload, + status code, response headers, bodies and a first CBS mapping are filled in for you. Passwords, keys and tokens + are never kept. +

+ @if (importError) { +
{{ importError }}
+ } +
+
+ + +
+ + @if (importRequestFile) { + {{ importRequestFile }} + } +
+
+
+ + +
+ + @if (importResponseFile) { + {{ importResponseFile }} + } +
+
+
+
+ + +
+
+ + +
+
+
+} + + diff --git a/src/app/api-management/api-vendor-setup/api-vendor-setup.component.ts b/src/app/api-management/api-vendor-setup/api-vendor-setup.component.ts new file mode 100644 index 000000000..3171a7521 --- /dev/null +++ b/src/app/api-management/api-vendor-setup/api-vendor-setup.component.ts @@ -0,0 +1,546 @@ +/** + * Copyright since 2025 Mifos Initiative + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +import { CommonModule } from '@angular/common'; +import { Component, OnInit, inject } from '@angular/core'; +import { FormsModule } from '@angular/forms'; +import { ActivatedRoute, RouterModule } from '@angular/router'; + +import { ApiKeyValueEditorComponent } from '../api-key-value-editor/api-key-value-editor.component'; +import { ApiLogDetailComponent } from '../api-log-detail/api-log-detail.component'; +import { + guessRequestRows, + guessResponseRows, + ImportedRequest, + ImportedResponse, + parseRequestText, + parseResponseText +} from '../api-import.util'; +import { + API_AUTH_TYPES, + API_CBS_FIELDS, + API_CONTENT_TYPES, + API_METHODS, + API_TRANSFORMS, + ApiLog, + ApiManagementService, + ApiMappingRow, + ApiVendor, + blankApi, + buildRequestPreview, + callsVendor, + KeyValue, + pathParamNames, + RequestPreview, + VendorApi +} from '../api-management.service'; + +/** + * One vendor's setup: its connection (URL, authentication, default headers, credentials), its API set - each API IN or + * OUT with the full HTTP detail and the field mapping, typed in or read from a JSON / cURL / Postman / HAR file - a + * test call, and its recent calls. + */ +@Component({ + selector: 'mifosx-api-vendor-setup', + standalone: true, + imports: [ + CommonModule, + FormsModule, + RouterModule, + ApiLogDetailComponent, + ApiKeyValueEditorComponent + ], + templateUrl: './api-vendor-setup.component.html', + styleUrls: ['../../credit-bureau/cic-shared.scss'] +}) +export class ApiVendorSetupComponent implements OnInit { + private service = inject(ApiManagementService); + private route = inject(ActivatedRoute); + + vendor: ApiVendor | null = null; + tab: 'connection' | 'apis' | 'test' | 'calls' = 'connection'; + loading = false; + error: string | null = null; + info: string | null = null; + + // connection + form: any = {}; + saving = false; + + // API set + editing: VendorApi | null = null; + isNewApi = false; + savingApi = false; + editorTab: 'basics' | 'request' | 'response' = 'basics'; + + // import from JSON / cURL / Postman / HAR + importOpen = false; + importRequestText = ''; + importResponseText = ''; + importRequestFile = ''; + importResponseFile = ''; + importReplace = true; + importGenerate = true; + importError: string | null = null; + + // test + testApiId: number | null = null; + testBody = ''; + testing = false; + testResult: ApiLog | null = null; + + // calls + calls: ApiLog[] = []; + openLog: ApiLog | null = null; + + readonly authTypes = Object.entries(API_AUTH_TYPES).map( + ([ + key, + label + ]) => ({ key, label }) + ); + readonly contentTypes = Object.entries(API_CONTENT_TYPES).map( + ([ + key, + label + ]) => ({ key, label }) + ); + readonly transforms = Object.entries(API_TRANSFORMS).map( + ([ + key, + label + ]) => ({ key, label }) + ); + readonly cbsFields = Object.entries(API_CBS_FIELDS).map( + ([ + key, + label + ]) => ({ key, label }) + ); + readonly methods = API_METHODS; + + ngOnInit(): void { + this.load(Number(this.route.snapshot.paramMap.get('id'))); + } + + load(id: number): void { + this.loading = true; + this.service.vendor(id).subscribe({ + next: (v) => { + this.vendor = v; + this.loading = false; + this.resetForm(v); + if (!this.testApiId || !v.apis.some((a) => a.id === this.testApiId)) this.testApiId = v.apis[0]?.id ?? null; + this.fillTestBody(); + this.loadCalls(); + }, + error: (e) => { + this.loading = false; + this.error = e?.error?.defaultUserMessage ?? 'Could not load the vendor.'; + } + }); + } + + private resetForm(v: ApiVendor): void { + this.form = { + name: v.name, + work: v.work, + environment: v.environment, + baseUrl: v.baseUrl, + authType: v.authType, + username: v.username, + apiKeyHeader: v.apiKeyHeader, + secret: '', + clearSecret: false, + senderId: v.senderId, + timeoutMs: v.timeoutMs, + retries: v.retries, + defaultHeaders: JSON.parse(JSON.stringify(v.defaultHeaders)), + active: v.active + }; + } + + loadCalls(): void { + if (!this.vendor) return; + this.service.logs({ vendorId: String(this.vendor.id), limit: 12 }).subscribe((r) => (this.calls = r.items)); + } + + // ── connection ── + + needsSecret(): boolean { + return this.form.authType !== 'NONE'; + } + + secretLabel(): string { + const a = this.form.authType; + return a === 'BASIC' + ? 'Password' + : a === 'API_KEY' + ? 'API key' + : a === 'BEARER_TOKEN' + ? 'Bearer token' + : 'Client secret'; + } + + saveConnection(): void { + if (!this.vendor) return; + this.saving = true; + this.error = null; + this.info = null; + const body = { ...this.form }; + if (!body.secret) delete body.secret; + this.service.saveVendor(this.vendor.id, body).subscribe({ + next: (v) => { + this.saving = false; + this.vendor = v; + this.resetForm(v); + this.info = `${v.name} connection saved.`; + }, + error: (e) => { + this.saving = false; + this.error = e?.error?.defaultUserMessage ?? 'Could not save the connection.'; + } + }); + } + + // ── API set ── + + newApi(direction: 'IN' | 'OUT'): void { + this.isNewApi = true; + this.error = null; + this.info = null; + this.editorTab = 'basics'; + this.editing = blankApi(direction); + } + + editApi(a: VendorApi): void { + this.isNewApi = false; + this.error = null; + this.info = null; + this.editorTab = 'basics'; + this.editing = JSON.parse(JSON.stringify(a)); + } + + /** True when the CBS makes the HTTP call (OUT, or IN pull); false for an IN push webhook. */ + get outbound(): boolean { + return !!this.editing && callsVendor(this.editing); + } + + directionChanged(): void { + if (!this.editing) return; + this.editing.mode = this.editing.direction === 'IN' ? (this.editing.mode ?? 'PUSH') : undefined; + } + + /** Keeps the path-parameter table in step with the {names} typed in the path. */ + pathChanged(): void { + if (!this.editing) return; + const names = pathParamNames(this.editing.path); + const kept = this.editing.pathParams.filter((p) => names.includes(p.key)); + for (const n of names) { + if (!kept.some((p) => p.key === n)) + kept.push({ key: n, value: '', description: '', enabled: true, secret: false }); + } + this.editing.pathParams = kept; + } + + rowsOf(side: 'request' | 'response'): ApiMappingRow[] { + if (!this.editing) return []; + return side === 'request' ? this.editing.requestRows : this.editing.responseRows; + } + + /** Whether the left column of a mapping table holds a CBS value (a pick list) or a path in the vendor's JSON. */ + fromIsCbs(side: 'request' | 'response'): boolean { + return this.outbound ? side === 'request' : side === 'response'; + } + + mappingTitle(side: 'request' | 'response'): string { + if (this.outbound) return side === 'request' ? 'Request mapping (CBS → vendor)' : 'Response mapping (vendor → CBS)'; + return side === 'request' ? 'Incoming data mapping (vendor → CBS)' : 'Answer mapping (CBS → vendor)'; + } + + fromLabel(side: 'request' | 'response'): string { + return this.fromIsCbs(side) ? 'CBS value' : "Vendor's JSON path"; + } + + toLabel(side: 'request' | 'response'): string { + if (this.fromIsCbs(side)) return side === 'request' ? "Vendor's request path" : 'Answer path'; + return 'CBS field'; + } + + addRow(side: 'request' | 'response'): void { + this.rowsOf(side).push({ from: '', to: '', transform: 'NONE', defaultValue: '', mandatory: false }); + } + + removeRow(side: 'request' | 'response', i: number): void { + this.rowsOf(side).splice(i, 1); + } + + /** Builds mapping rows from the payload typed or imported for that side. */ + generateRows(side: 'request' | 'response'): void { + if (!this.editing || !this.vendor) return; + const body = side === 'request' ? this.editing.requestBody : this.editing.responseBody; + // Reading values OUT of a payload (vendor → CBS) vs putting values INTO one (CBS → vendor). + const reading = !this.fromIsCbs(side); + const rows = reading ? guessResponseRows(body, this.vendor.code) : guessRequestRows(body); + if (!rows.length) { + this.error = 'That payload has no JSON values to build a mapping from.'; + return; + } + this.error = null; + const target = this.rowsOf(side); + const have = new Set(target.map((r) => r.to)); + target.push(...rows.filter((r) => !have.has(r.to))); + this.info = `${rows.length} mapping row(s) read from the payload. Review the CBS fields and adjust.`; + } + + saveApi(): void { + if (!this.vendor || !this.editing) return; + this.savingApi = true; + this.error = null; + this.service.saveApi(this.vendor.id, this.editing).subscribe({ + next: (a) => { + this.savingApi = false; + this.info = `${a.name} saved.`; + this.editing = null; + this.load(this.vendor!.id); + }, + error: (e) => { + this.savingApi = false; + this.error = e?.error?.defaultUserMessage ?? 'Could not save the API.'; + } + }); + } + + deleteApi(a: VendorApi): void { + if (!this.vendor || !confirm(`Delete the API "${a.name}"?`)) return; + this.service.deleteApi(this.vendor.id, a.id).subscribe(() => { + this.editing = null; + this.info = `${a.name} deleted.`; + this.load(this.vendor!.id); + }); + } + + /** The request this API would send (or receive), as the Test tab and the editor show it. */ + preview(a: VendorApi | null): RequestPreview | null { + return this.vendor && a ? buildRequestPreview(this.vendor, a) : null; + } + + // ── import ── + + openImport(): void { + this.importOpen = true; + this.importError = null; + this.importReplace = this.isNewApi; + this.importRequestText = ''; + this.importResponseText = ''; + this.importRequestFile = ''; + this.importResponseFile = ''; + } + + onFile(event: Event, which: 'request' | 'response'): void { + const input = event.target as HTMLInputElement; + const file = input.files?.[0]; + if (!file) return; + if (file.size > 5 * 1024 * 1024) { + this.importError = 'The file is larger than 5 MB.'; + return; + } + const reader = new FileReader(); + reader.onload = () => { + const text = String(reader.result ?? ''); + if (which === 'request') { + this.importRequestText = text; + this.importRequestFile = file.name; + } else { + this.importResponseText = text; + this.importResponseFile = file.name; + } + }; + reader.readAsText(file); + input.value = ''; + } + + applyImport(): void { + if (!this.editing || !this.vendor) return; + this.importError = null; + let req: ImportedRequest | null = null; + let res: ImportedResponse | null = null; + try { + if (this.importRequestText.trim()) req = parseRequestText(this.importRequestText); + if (this.importResponseText.trim()) res = parseResponseText(this.importResponseText); + else if (req?.response) res = req.response; + } catch (e: any) { + this.importError = e?.message ?? 'Could not read the file.'; + return; + } + if (!req && !res) { + this.importError = 'Paste or choose a request, a response, or both.'; + return; + } + + const a = this.editing; + const done: string[] = []; + const notes: string[] = [ + ...(req?.notes ?? []), + ...(res?.notes ?? []) + ]; + const replace = this.importReplace; + + const mergePairs = (target: KeyValue[], incoming: KeyValue[]): KeyValue[] => { + if (replace) return incoming; + const out = [...target]; + for (const p of incoming) { + const i = out.findIndex((x) => x.key.toLowerCase() === p.key.toLowerCase()); + if (i >= 0) out[i] = p; + else out.push(p); + } + return out; + }; + + if (req) { + if (req.method && this.methods.includes(req.method)) { + a.method = req.method as VendorApi['method']; + done.push(`method ${req.method}`); + } + if (req.path && req.path !== '/') { + a.path = this.stripVendorBasePath(req.path); + done.push(`path ${a.path}`); + } + if (req.baseUrl) { + if (!this.form.baseUrl) { + this.form.baseUrl = req.baseUrl; + notes.push(`Base URL ${req.baseUrl} was put on the Connection tab - save it there.`); + } else if (this.form.baseUrl.replace(/\/+$/, '') !== req.baseUrl) { + notes.push( + `The file's host (${req.baseUrl}) is not this vendor's base URL (${this.form.baseUrl}); only the path was used.` + ); + } + } + if (req.queryParams.length) { + a.queryParams = mergePairs(a.queryParams, req.queryParams); + done.push(`${req.queryParams.length} query parameter(s)`); + } + if (req.headers.length) { + a.headers = mergePairs(a.headers, req.headers); + done.push(`${req.headers.length} header(s)`); + } + if (req.contentType) { + a.contentType = Object.keys(API_CONTENT_TYPES).includes(req.contentType) ? req.contentType : a.contentType; + done.push(`content type ${a.contentType}`); + } + if (req.body !== undefined) { + a.requestBody = req.body; + done.push('request payload'); + } + if (!a.name.trim() && a.path) { + const last = + a.path + .split('/') + .filter((s) => s && !s.includes('{')) + .pop() ?? 'API'; + a.name = last.charAt(0).toUpperCase() + last.slice(1).replace(/[-_]+/g, ' '); + } + this.pathChanged(); + } + + if (res) { + const failure = res.status !== undefined && (res.status < 200 || res.status > 299); + if (res.status !== undefined && !failure) { + a.successCodes = String(res.status); + done.push(`success code ${res.status}`); + } + if (res.headers.length) { + a.responseHeaders = mergePairs(a.responseHeaders, res.headers); + done.push(`${res.headers.length} response header(s)`); + } + if (res.body !== undefined) { + if (failure) { + a.errorBody = res.body; + done.push(`error body (HTTP ${res.status})`); + } else { + a.responseBody = res.body; + done.push('response body'); + } + } + if (res.errorBody !== undefined) { + a.errorBody = res.errorBody; + done.push('error body'); + } + } + + if (this.importGenerate) { + const addRows = (side: 'request' | 'response', body: string) => { + const reading = !this.fromIsCbs(side); + const rows = reading ? guessResponseRows(body, this.vendor!.code) : guessRequestRows(body); + if (!rows.length) return; + const target = replace ? [] : this.rowsOf(side); + const have = new Set(target.map((r) => r.to)); + const merged = [ + ...target, + ...rows.filter((r) => !have.has(r.to)) + ]; + if (side === 'request') a.requestRows = merged; + else a.responseRows = merged; + done.push(`${rows.length} ${side === 'request' ? 'request' : 'response'} mapping row(s)`); + }; + if (req?.body !== undefined) addRows('request', a.requestBody); + if (res?.body !== undefined && !(res.status !== undefined && (res.status < 200 || res.status > 299))) + addRows('response', a.responseBody); + } + + this.importOpen = false; + this.error = null; + this.info = `Read from ${[ + req?.source, + res?.source + ] + .filter(Boolean) + .join(' + ')}: ${done.join(', ') || 'nothing new'}. ${notes.join(' ')} Review each tab, then Save API.`; + } + + /** A path read from a full URL may repeat the path already in the vendor's base URL. */ + private stripVendorBasePath(path: string): string { + const base = String(this.form.baseUrl ?? ''); + const m = /^[a-zA-Z][a-zA-Z0-9+.-]*:\/\/[^/]+(\/.+)$/.exec(base.replace(/\/+$/, '')); + if (m && path.startsWith(m[1] + '/')) return path.slice(m[1].length); + return path; + } + + // ── test ── + + get testApi(): VendorApi | null { + return this.vendor?.apis.find((x) => x.id === this.testApiId) ?? null; + } + + fillTestBody(): void { + this.testBody = this.testApi?.requestBody ?? '{}'; + this.testResult = null; + } + + get testPreview(): RequestPreview | null { + const a = this.testApi; + return this.vendor && a ? buildRequestPreview(this.vendor, { ...a, requestBody: this.testBody }) : null; + } + + runTest(): void { + if (!this.vendor || !this.testApiId) return; + this.testing = true; + this.error = null; + this.service.testApi(this.vendor.id, this.testApiId, this.testBody).subscribe({ + next: (log) => { + this.testing = false; + this.testResult = log; + this.loadCalls(); + }, + error: (e) => { + this.testing = false; + this.error = e?.error?.defaultUserMessage ?? 'Test failed.'; + } + }); + } +} diff --git a/src/app/api-management/api-vendors/api-vendors.component.html b/src/app/api-management/api-vendors/api-vendors.component.html new file mode 100644 index 000000000..dbc0209e3 --- /dev/null +++ b/src/app/api-management/api-vendors/api-vendors.component.html @@ -0,0 +1,172 @@ + + +
+
+
+

API Management

+

+ Connect any API service to the CBS the same way: Vendor → Work → API set. IN = data comes into the + CBS from the vendor (CIC alerts, delivery reports, replies). OUT = the CBS calls the vendor (send an SMS + or WhatsApp message). +

+
+
+ API call logs + +
+
+ + @if (error && !adding) { +
{{ error }}
+ } + @if (info) { +
{{ info }}
+ } + +
+
+
Vendors
+
{{ vendors.length }}
+
{{ activeVendors }} active
+
+
+
APIs
+
{{ totalIn + totalOut }}
+
{{ totalIn }} IN · {{ totalOut }} OUT
+
+
+
Calls in 24 hours
+
{{ summary.callsToday }}
+
both directions
+
+
+
Failed in 24 hours
+
{{ summary.failedToday }}
+
see the call logs
+
+
+ +
+

Vendors

+ @if (loading && !vendors.length) { +
Loading…
+ } @else { +
+ + + + + + + + + + + + + + + @for (v of vendors; track v.id) { + + + + + + + + + + + @if (v.links.length) { + + + + } + } + +
VendorWorkAPIsEnvironment24 h callsLast callActive
+ {{ v.name }} +
{{ v.code }}
+ 		{{ v.work }} + @if (count(v, 'IN')) { + IN × {{ count(v, 'IN') }} + } + @if (count(v, 'OUT')) { + OUT × {{ count(v, 'OUT') }} + } + @if (!v.apis.length) { + none yet + } + + {{ v.environment }} + + {{ calls(v).calls }} + @if (calls(v).failed) { + · {{ calls(v).failed }} failed + } + {{ v.lastCallOn ? (v.lastCallOn | slice: 0 : 16) : '—' }} + + + + + + Set up +
+ {{ v.code }} also has: + @for (l of v.links; track l.route) { + {{ l.label }} + } +
+
+ } +
+ + @if (adding) { +
+
+

Add an API vendor

+ @if (error) { +
{{ error }}
+ } +
+
+ + +
+
+ + +
+
+ + +
+
+

+ Next you set up the connection and add its APIs, each marked IN or OUT. +

+
+ + +
+
+
+ } +
diff --git a/src/app/api-management/api-vendors/api-vendors.component.ts b/src/app/api-management/api-vendors/api-vendors.component.ts new file mode 100644 index 000000000..bb4bda497 --- /dev/null +++ b/src/app/api-management/api-vendors/api-vendors.component.ts @@ -0,0 +1,121 @@ +/** + * Copyright since 2025 Mifos Initiative + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +import { CommonModule } from '@angular/common'; +import { Component, OnInit, inject } from '@angular/core'; +import { FormsModule } from '@angular/forms'; +import { Router, RouterModule } from '@angular/router'; + +import { ApiManagementService, ApiVendor } from '../api-management.service'; + +/** Every outside API service the CBS uses: vendor, its work, its APIs (IN / OUT) and whether it is switched on. */ +@Component({ + selector: 'mifosx-api-vendors', + standalone: true, + imports: [ + CommonModule, + FormsModule, + RouterModule + ], + templateUrl: './api-vendors.component.html', + styleUrls: ['../../credit-bureau/cic-shared.scss'] +}) +export class ApiVendorsComponent implements OnInit { + private service = inject(ApiManagementService); + private router = inject(Router); + + vendors: ApiVendor[] = []; + summary: { callsToday: number; failedToday: number; perVendor: Record } = { + callsToday: 0, + failedToday: 0, + perVendor: {} + }; + loading = false; + error: string | null = null; + info: string | null = null; + + adding = false; + saving = false; + form: { name: string; work: string; environment: ApiVendor['environment'] } = this.blankForm(); + + ngOnInit(): void { + this.load(); + } + + private blankForm() { + return { name: '', work: '', environment: 'SIMULATOR' as ApiVendor['environment'] }; + } + + load(): void { + this.loading = true; + this.service.vendors().subscribe((v) => { + this.vendors = v; + this.loading = false; + }); + this.service.summary().subscribe((s) => (this.summary = s)); + } + + count(v: ApiVendor, direction: 'IN' | 'OUT'): number { + return v.apis.filter((a) => a.direction === direction).length; + } + + get totalIn(): number { + return this.vendors.reduce((s, v) => s + this.count(v, 'IN'), 0); + } + + get totalOut(): number { + return this.vendors.reduce((s, v) => s + this.count(v, 'OUT'), 0); + } + + get activeVendors(): number { + return this.vendors.filter((v) => v.active).length; + } + + calls(v: ApiVendor): { calls: number; failed: number } { + return this.summary.perVendor[v.id] ?? { calls: 0, failed: 0 }; + } + + toggle(v: ApiVendor, event: Event): void { + const want = (event.target as HTMLInputElement).checked; + (event.target as HTMLInputElement).checked = v.active; + this.error = null; + this.info = null; + this.service.saveVendor(v.id, { active: want }).subscribe({ + next: (u) => { + v.active = u.active; + this.info = `${u.name} is now ${u.active ? 'active' : 'switched off'}.`; + }, + error: (e) => (this.error = e?.error?.defaultUserMessage ?? 'Could not change the vendor.') + }); + } + + startAdd(): void { + this.adding = true; + this.form = this.blankForm(); + this.error = null; + } + + saveNew(): void { + this.saving = true; + this.error = null; + this.service.addVendor(this.form).subscribe({ + next: (v) => { + this.saving = false; + this.adding = false; + this.router.navigate([ + '/api-management/vendors', + v.id + ]); + }, + error: (e) => { + this.saving = false; + this.error = e?.error?.defaultUserMessage ?? 'Could not add the vendor.'; + } + }); + } +} diff --git a/src/app/app.module.ts b/src/app/app.module.ts index 00ebb2abc..1f9b2ba1d 100644 --- a/src/app/app.module.ts +++ b/src/app/app.module.ts @@ -74,10 +74,12 @@ import { NpaModule } from './npa/npa.module'; import { ReconciliationModule } from './reconciliation/reconciliation.module'; import { LoanOriginationModule } from './loan-origination/loan-origination.module'; import { CreditBureauModule } from './credit-bureau/credit-bureau.module'; +import { ApiManagementModule } from './api-management/api-management.module'; import { DigitalModule } from './digital/digital.module'; import { LetterMgmtModule } from './letter-mgmt/letter-mgmt.module'; import { AccountsModule } from './accounts/accounts.module'; import { ElectionModule } from './election/election.module'; +import { LoanEligibilityModule } from './loan-eligibility/loan-eligibility.module'; import { SponsorDDModule } from './sponsor-dd/sponsor-dd.module'; import { SponsorDDReconciliationModule } from './sponsor-dd-reconciliation/sponsor-dd-reconciliation.module'; import { PortalModule } from '@angular/cdk/portal'; @@ -191,10 +193,12 @@ export function HttpLoaderFactory(http: HttpClient) { ReconciliationModule, LoanOriginationModule, CreditBureauModule, + ApiManagementModule, DigitalModule, LetterMgmtModule, AccountsModule, ElectionModule, + LoanEligibilityModule, SponsorDDModule, SponsorDDReconciliationModule, AppRoutingModule, diff --git a/src/app/core/shell/shell.component.html b/src/app/core/shell/shell.component.html index 3223ce52d..dfa7bfad3 100644 --- a/src/app/core/shell/shell.component.html +++ b/src/app/core/shell/shell.component.html @@ -407,9 +407,14 @@ Loan Origination - + Credit Bureau - Advances @@ -512,10 +517,15 @@ >Loans - + Credit BureauCIC - - -
- -
-
Bureau Enquiry
- - - - -
- -
-
CIC Setup
- - -
-
- -
diff --git a/src/app/core/shell/toolbar/toolbar.component.html b/src/app/core/shell/toolbar/toolbar.component.html index 450624b69..fbb86e720 100644 --- a/src/app/core/shell/toolbar/toolbar.component.html +++ b/src/app/core/shell/toolbar/toolbar.component.html @@ -154,7 +154,7 @@ Lending & Risk
- + +
+
+ + API Management +
+ + + + +
diff --git a/src/app/core/shell/toolbar/toolbar.component.scss b/src/app/core/shell/toolbar/toolbar.component.scss index 0e29cbc78..0339ecc1c 100644 --- a/src/app/core/shell/toolbar/toolbar.component.scss +++ b/src/app/core/shell/toolbar/toolbar.component.scss @@ -373,7 +373,7 @@ $icon-hover-border: rgb(255 255 255 / 28%); // ===== AI Mega Menu Panel ===== ::ng-deep .ai-menu { &.mat-mdc-menu-panel { - min-width: 880px !important; + min-width: 1080px !important; max-width: 96vw !important; max-height: 80vh; border-radius: 14px !important; @@ -520,7 +520,7 @@ $icon-hover-border: rgb(255 255 255 / 28%); // ===== Mega Layout — 4 colour-coded columns ===== .ai-menu-cols { display: grid; - grid-template-columns: repeat(4, 1fr); + grid-template-columns: repeat(5, 1fr); gap: 0; padding: 14px 14px 6px; background: #f8fafc; @@ -567,6 +567,12 @@ $icon-hover-border: rgb(255 255 255 / 28%); --c-hover: #be185d; } +.ai-col--blue { + --c-color: #0369a1; + --c-bg: #e0f2fe; + --c-hover: #0369a1; +} + .ai-col-h { display: flex; align-items: center; @@ -702,7 +708,7 @@ $icon-hover-border: rgb(255 255 255 / 28%); } // Responsive collapse -@media (width <= 1100px) { +@media (width <= 1300px) { ::ng-deep .ai-menu.mat-mdc-menu-panel { min-width: 680px !important; } diff --git a/src/app/credit-bureau/cic-alert-detail/cic-alert-detail.component.html b/src/app/credit-bureau/cic-alert-detail/cic-alert-detail.component.html new file mode 100644 index 000000000..ac9fb4fa4 --- /dev/null +++ b/src/app/credit-bureau/cic-alert-detail/cic-alert-detail.component.html @@ -0,0 +1,252 @@ + + +
+
+ @if (loading && !alert) { +
Loading…
+ } + @if (alert) { + @if (history.length) { +
+ You are viewing another enquiry of this customer. + +
+ } +
+
+

+ {{ alert.clientName || alert.customerName || 'Unknown customer' }} applied for + {{ alert.loanType || 'a loan' }} elsewhere +

+
+ {{ alert.bureauCode }} alert · {{ alert.alertKey }} · received {{ alert.receivedOn | slice: 0 : 16 }} via + {{ alert.receivedVia }} +
+
+
+ {{ alert.status }} + +
+
+ + @if (error) { +
{{ error }}
+ } + @if (info) { +
{{ info }}
+ } + +
+
+
Loan applied for
+
{{ alert.loanType || '—' }}
+
+
+
Amount
+
+ {{ alert.amount !== null && alert.amount !== undefined ? '₹' + (alert.amount | number: '1.0-0') : '—' }} +
+
+
+
Enquiry date
+
{{ alert.enquiryDate | date: 'dd MMM yyyy' }}
+
+
+ +
+
+

+ Enquiry elsewhere + the CIC does not name the lender +

+
+
Loan type
+
{{ alert.loanType || '—' }}
+
Amount
+
+ {{ alert.amount !== null && alert.amount !== undefined ? '₹' + (alert.amount | number: '1.0-2') : '—' }} +
+
Purpose
+
{{ alert.purpose || '—' }}
+
Place
+
{{ alert.location || '—' }}
+
Enquiry date
+
{{ alert.enquiryDate | date: 'dd MMM yyyy' }}
+
+
+
+

+ Our customer + @if (!alert.clientId) { + + } +

+
+
Customer
+
+ @if (alert.clientId) { + {{ + alert.clientName + }} + · {{ alert.clientAccountNo }} + } @else { + Not matched to any customer + } +
+
Branch
+
{{ alert.officeName || '—' }}
+
Matched by
+
{{ matchLabels[alert.matchType] || alert.matchType }}
+
Name at bureau
+
{{ alert.customerName || '—' }}
+
PAN / Aadhaar
+
{{ alert.panMasked || '—' }} / {{ alert.aadhaarMasked || '—' }}
+ @if (alert.customerRef) { +
Reference
+
{{ alert.customerRef }}
+ } +
+
+
+ + @if (alert.clientId) { +
+

+ Customer's loans with us + outstanding ₹{{ exposure | number: '1.0-0' }} +

+ @if (alert.clientLoans?.length) { +
+ + + + + + + + + + + + + @for (l of alert.clientLoans; track l.id) { + + + + + + + + + } + +
AccountProductStatusPrincipalOutstandingDisbursed
{{ l.accountNo }}{{ l.productName }}{{ l.status }}{{ l.principal | number: '1.0-0' }}{{ l.outstanding | number: '1.0-0' }}{{ l.disbursedOn | date: 'dd MMM yyyy' }}
+
+ } @else { +
+ No loan with us. A customer with deposits only who is borrowing elsewhere may be a cross-sell opportunity. +
+ } +
+ } + + @if (alert.otherAlertsOfCustomer?.length) { +
+

+ All enquiries on this customer + {{ customerEnquiries.length }} in total +

+
+ + + + + + + + + + + @for (o of customerEnquiries; track o.id) { + + + + + + + } + +
DateLoan typeAmountStatus
{{ o.enquiryDate | date: 'dd MMM yyyy' }} + {{ o.loanType }} + @if (o.id === alert.id) { + (shown above) + } + {{ o.amount | number: '1.0-0' }} + {{ o.status }} +
+
+
+ } + + @if (alert.remarks || alert.actionedByName) { +
+ {{ alert.status }} by {{ alert.actionedByName }} on {{ alert.actionedOn | slice: 0 : 16 }} + @if (alert.remarks) { + — {{ alert.remarks }} + } +
+ } + + + @if (action) { +
+ + +
+ } +
+ @if (action) { + + + } @else { + @if (alert.status === 'ACTIONED' || alert.status === 'DISMISSED') { + + } + @if (alert.status !== 'DISMISSED') { + + } + @if (alert.status !== 'ACTIONED') { + + } + } +
+ + +
+ + @if (showRaw) { + 
{{ rawText() }}
+ } +
+ } +
+
diff --git a/src/app/credit-bureau/cic-alert-detail/cic-alert-detail.component.ts b/src/app/credit-bureau/cic-alert-detail/cic-alert-detail.component.ts new file mode 100644 index 000000000..8055ed319 --- /dev/null +++ b/src/app/credit-bureau/cic-alert-detail/cic-alert-detail.component.ts @@ -0,0 +1,181 @@ +/** + * Copyright since 2025 Mifos Initiative + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +import { CommonModule } from '@angular/common'; +import { Component, EventEmitter, Input, OnChanges, Output, inject } from '@angular/core'; +import { FormsModule } from '@angular/forms'; +import { MatDialog, MatDialogModule } from '@angular/material/dialog'; +import { RouterModule } from '@angular/router'; + +import { HasPermissionDirective } from 'app/directives/has-permission/has-permission.directive'; +import { + CustomerSearchDialogComponent, + CustomerSearchResult +} from 'app/shared/customer-search-dialog/customer-search-dialog.component'; +import { CIC_MATCH_LABELS, CicAlert, CicService, cicError, cicStatusTone } from '../cic.service'; + +/** + * One enquiry alert: which of our customers applied elsewhere (the CIC does not name the lender), for what loan and + * how much; the customer's + * loans with us and earlier alerts; and the follow-up (seen / actioned / dismissed, or linking an unmatched alert). + */ +@Component({ + selector: 'mifosx-cic-alert-detail', + standalone: true, + imports: [ + CommonModule, + FormsModule, + RouterModule, + MatDialogModule, + HasPermissionDirective + ], + templateUrl: './cic-alert-detail.component.html', + styleUrls: ['../cic-shared.scss'] +}) +export class CicAlertDetailComponent implements OnChanges { + private cic = inject(CicService); + private dialog = inject(MatDialog); + + @Input() alertId: number | null = null; + @Output() closed = new EventEmitter(); + @Output() changed = new EventEmitter(); + + alert: CicAlert | null = null; + loading = false; + saving = false; + error: string | null = null; + info: string | null = null; + showRaw = false; + + /** Alerts visited before the current one, so the user can go back after opening another enquiry of the customer. */ + history: number[] = []; + private autoSeen = true; + + action: 'ACTIONED' | 'DISMISSED' | null = null; + remarks = ''; + + readonly matchLabels = CIC_MATCH_LABELS; + readonly statusTone = cicStatusTone; + + ngOnChanges(): void { + this.history = []; + this.autoSeen = true; + if (this.alertId) this.load(); + } + + openOther(id: number): void { + if (this.alertId) this.history.push(this.alertId); + this.alertId = id; + // Only the alert opened from the dashboard counts as "seen"; browsing the customer's other enquiries changes nothing. + this.autoSeen = false; + this.load(); + } + + back(): void { + const id = this.history.pop(); + if (!id) return; + this.alertId = id; + this.autoSeen = false; + this.load(); + } + + load(): void { + if (!this.alertId) return; + this.loading = true; + this.error = null; + this.info = null; + this.action = null; + this.remarks = ''; + this.cic.alert(this.alertId).subscribe({ + next: (a) => { + this.alert = a; + this.loading = false; + setTimeout(() => document.querySelector('.cic-modal')?.scrollTo({ top: 0 })); + // Opening a new alert is seeing it. + if (this.autoSeen && a.status === 'NEW' && a.clientId) this.setStatus('SEEN', null, true); + }, + error: (e) => { + this.loading = false; + this.error = cicError(e, 'Could not load the alert.'); + } + }); + } + + setStatus(status: string, remarks: string | null, quiet = false): void { + if (!this.alert) return; + this.saving = true; + this.error = null; + this.cic.updateStatus(this.alert.id, status, remarks).subscribe({ + next: (a) => { + this.saving = false; + this.alert = a; + this.action = null; + this.remarks = ''; + if (!quiet) this.info = `Alert marked ${status.toLowerCase()}.`; + this.changed.emit(a); + }, + error: (e) => { + this.saving = false; + // A user without UPDATE_CICALERT can still read; the automatic "seen" is then simply skipped. + if (!quiet) this.error = cicError(e, 'Could not update the alert.'); + } + }); + } + + confirmAction(): void { + if (!this.action) return; + if (!this.remarks.trim()) { + this.error = + this.action === 'ACTIONED' + ? 'Write what was done (customer contacted, retention offer made, limit reviewed ...).' + : 'Write why the alert is dismissed.'; + return; + } + this.setStatus(this.action, this.remarks.trim()); + } + + linkCustomer(): void { + if (!this.alert) return; + this.dialog + .open(CustomerSearchDialogComponent, { width: '960px', maxWidth: '95vw', data: { requireAccount: false } }) + .afterClosed() + .subscribe((r: CustomerSearchResult | undefined) => { + if (!r?.clientId || !this.alert) return; + this.saving = true; + this.cic.linkClient(this.alert.id, r.clientId).subscribe({ + next: (a) => { + this.saving = false; + this.alert = a; + this.info = `Alert linked to ${a.clientName}.`; + this.changed.emit(a); + }, + error: (e) => { + this.saving = false; + this.error = cicError(e, 'Could not link the customer.'); + } + }); + }); + } + + /** All of the customer's enquiries, this one included, in a fixed order so the list does not reshuffle when one is opened. */ + get customerEnquiries(): CicAlert[] { + if (!this.alert) return []; + return [ + this.alert, + ...(this.alert.otherAlertsOfCustomer ?? []) + ].sort((x, y) => (y.enquiryDate ?? '').localeCompare(x.enquiryDate ?? '') || y.id - x.id); + } + + get exposure(): number { + return (this.alert?.clientLoans ?? []).reduce((s, l) => s + Number(l.outstanding ?? 0), 0); + } + + rawText(): string { + return JSON.stringify(this.alert?.raw ?? {}, null, 2); + } +} diff --git a/src/app/credit-bureau/cic-api-mapping/cic-api-mapping.component.html b/src/app/credit-bureau/cic-api-mapping/cic-api-mapping.component.html index 44b1b042b..8087b94d6 100644 --- a/src/app/credit-bureau/cic-api-mapping/cic-api-mapping.component.html +++ b/src/app/credit-bureau/cic-api-mapping/cic-api-mapping.component.html @@ -9,13 +9,14 @@
-

CIC API Mapping

+

CIC API Mapping — Enquiry Alerts

- Map CBS data to each bureau's request, and the bureau's response back to the score and report — no code change - needed. + How the CBS asks each bureau for enquiry alerts, and how the bureau's answer is read into our alerts (customer, + loan type, amount, enquiry date …) — no code change needed.

+ ← Dashboard CIC Configuration
- +
@@ -77,7 +80,8 @@ @if (bureau?.environment === 'SIMULATOR') {
In SIMULATOR mode the built-in test bureau answers in the shape of the seeded generic mapping. When moving to the - bureau's UAT / PRODUCTION, change the paths below to match the bureau's own API specification. + bureau's UAT / PRODUCTION, change the paths below to the bureau's own API specification and check them with Test + Response.
} @@ -87,29 +91,124 @@ @if (endpoint && !loading) {
- + - + +
- - @if (tab === 'request') { + + @if (tab === 'response') {

- CBS field → bureau request - Paths like consumer.ids[0].number build nested JSON and arrays + Bureau response → CBS alert + "alerts", "errorCode" and "errorMessage" are read from the whole response; every other field from each + alert

- + + + + + + + + + @for (r of responseRows; track $index; let i = $index) { + + + + + + + + + } + +
#CBS fieldBureau response JSON pathCBS alert fieldTransformDefault
{{ i + 1 }} + + + +
+ {{ isRoot(r.targetField) ? 'whole response' : 'each alert' }} +
+ 		+ + + + + +
+
+ + @for (f of resultFieldList; track f.key) { + + } + +
+ + + For dates the transform names the format the bureau sends (e.g. Date ddMMyyyy). The customer is matched by + PAN, then Aadhaar (with date of birth or name), then our customer reference. + +
+
+ @for (f of resultFieldList; track f.key) { +
+ {{ f.key }} — {{ f.label }} +
+ } +
+
+ } + + + @if (tab === 'request') { +
+

+ CBS value → bureau request + Paths like criteria.fromDate build nested JSON; [0] builds arrays +

+
+ + + + + @@ -134,7 +233,7 @@ class="cic-mono" [(ngModel)]="r.targetField" (ngModelChange)="markDirty()" - placeholder="consumer.name.firstName" + placeholder="criteria.fromDate" />
#CBS value Bureau JSON path Transform Fixed / default value @@ -181,88 +280,7 @@
A mandatory field missing on the customer stops the enquiry before the bureau is called. -
- - } - - - @if (tab === 'response') { -
-

- Bureau response → CBS result - "score" drives the score shown everywhere; "hit" = false marks a no-hit; "errorCode" marks a failure -

-
- - - - - - - - - - - - - @for (r of responseRows; track $index; let i = $index) { - - - - - - - - - } - -
#Bureau response JSON pathCBS result fieldTransformDefault
{{ i + 1 }} - - - - - - - - - -
-
- - @for (f of resultFieldList; track f.key) { - - } - -
- - Standard result fields: {{ resultFieldList.length }}; any other simple name is kept as an extra - field.A mandatory value that is empty stops the fetch before the bureau is called.
@@ -287,7 +305,7 @@ class="cic-mono" [(ngModel)]="endpoint.path" (ngModelChange)="markDirty()" - placeholder="/consumer/enquiry" + placeholder="/monitoring/enquiry-alerts" />
@@ -309,7 +327,7 @@ > Placeholders like {{ '{{' }}bureau.memberCode{{ '}}' }} or - {{ '{{' }}enquiry.reference{{ '}}' }} are filled in. Authentication headers are added + {{ '{{' }}fetch.reference{{ '}}' }} are filled in. Authentication headers are added automatically. @if (jsonErrors.headers) { @@ -333,46 +351,100 @@
} + + @if (tab === 'test') { +
+

+ Test response + reads a bureau answer through the saved response mapping and matches customers — nothing is saved +

+
+ + +
+
+ + +
+
+ @if (testResult) { + @if (testResult.errorCode) { +
Bureau error {{ testResult.errorCode }}: {{ testResult.errorMessage }}
+ } + @if (!testResult.alertListFound) { +
+ No alert list was found at the path mapped to "alerts". Check that row of the response mapping. +
+ } +
+

{{ testResult.count }} alert(s) read

+ @if (testResult.items?.length) { +
+ + + + + + + + + + + + + + @for (it of testResult.items; track $index) { + + + + + + + + + + } + +
Alert idCustomer (bureau)PANDateLoan typeAmountMatch
{{ it.alertRef }}{{ it.customerName }}{{ it.pan || it.aadhaar || it.customerRef }}{{ it.enquiryDate }}{{ it.loanType }}{{ it.amount | number: '1.0-0' }} + @if (it.ownBank) { + Own bank — skipped + } @else if (it.clientId) { + {{ matchLabels[it.matchType] }} {{ it.clientName }} + } @else { + Not matched + } +
+
+ } +
+ } + } + @if (tab === 'preview') {
-

- Preview - builds the request from the saved mapping for a real customer — nothing is sent -

+

Preview builds the request from the saved mapping — nothing is sent

-
- -
- - -
+
+ +
- - + +
-
- - +
+ Empty = the bureau's look-back window up to today.
-
@@ -380,20 +452,18 @@ @if (previewResult) { @if (previewResult.missingMandatory?.length) {
- This customer would be refused — missing mandatory fields: + The fetch would be refused — mandatory values are empty:
    @for (m of previewResult.missingMandatory; track m) {
  • {{ m }}
    • }
- } @else { -
All mandatory fields are present for this customer.
}
-

Request body sensitive values masked

- 
{{ prettyBody(previewResult.body) }}
+

Request body

+ 
{{ prettyJson(previewResult.body) }}

Call

@@ -402,6 +472,8 @@
{{ previewResult.method }}
URL
{{ previewResult.url }}
+
Window
+
{{ previewResult.fromDate }} → {{ previewResult.toDate }}
Auth
{{ previewResult.authentication }}
@for (h of headerEntries(previewResult.headers); track h.k) { diff --git a/src/app/credit-bureau/cic-api-mapping/cic-api-mapping.component.ts b/src/app/credit-bureau/cic-api-mapping/cic-api-mapping.component.ts index 6b2e33355..6ee1a3ef3 100644 --- a/src/app/credit-bureau/cic-api-mapping/cic-api-mapping.component.ts +++ b/src/app/credit-bureau/cic-api-mapping/cic-api-mapping.component.ts @@ -9,20 +9,16 @@ import { CommonModule } from '@angular/common'; import { Component, OnInit, inject } from '@angular/core'; import { FormsModule } from '@angular/forms'; -import { MatDialog, MatDialogModule } from '@angular/material/dialog'; import { ActivatedRoute, RouterModule } from '@angular/router'; import { HasPermissionDirective } from 'app/directives/has-permission/has-permission.directive'; -import { - CustomerSearchDialogComponent, - CustomerSearchResult -} from 'app/shared/customer-search-dialog/customer-search-dialog.component'; -import { CicBureau, CicCatalog, CicEndpoint, CicMapping, CicService, cicError } from '../cic.service'; +import { CIC_MATCH_LABELS, CicBureau, CicCatalog, CicEndpoint, CicMapping, CicService, cicError } from '../cic.service'; /** - * The per-bureau API mapping, maintained from the UI: endpoint (method, path, headers, base body), REQUEST rows that - * put a CBS field into the bureau's request at a JSON path, and RESPONSE rows that read the bureau's answer into the - * CBS result (score, accounts, overdue ...). A dry-run preview shows the exact request for a real customer. + * The per-bureau API mapping of the enquiry-alert call, maintained from the UI: endpoint (method, path, headers, base + * body), REQUEST rows that put the fetch window and the bank's identity into the bureau's request, and RESPONSE rows + * that read the bureau's alert list and each alert's fields (customer, lender, loan type, amount ...). A dry-run + * preview shows the request; Test Response reads a sample answer through the mapping without saving anything. */ @Component({ selector: 'mifosx-cic-api-mapping', @@ -31,7 +27,6 @@ import { CicBureau, CicCatalog, CicEndpoint, CicMapping, CicService, cicError } CommonModule, FormsModule, RouterModule, - MatDialogModule, HasPermissionDirective ], templateUrl: './cic-api-mapping.component.html', @@ -39,18 +34,17 @@ import { CicBureau, CicCatalog, CicEndpoint, CicMapping, CicService, cicError } }) export class CicApiMappingComponent implements OnInit { private cic = inject(CicService); - private dialog = inject(MatDialog); private route = inject(ActivatedRoute); catalog: CicCatalog | null = null; bureaus: CicBureau[] = []; bureauId: number | null = null; - endpointType = 'CONSUMER_ENQUIRY'; + endpointType = 'ENQUIRY_ALERT'; endpoint: CicEndpoint | null = null; requestRows: CicMapping[] = []; responseRows: CicMapping[] = []; - tab: 'request' | 'response' | 'endpoint' | 'preview' = 'request'; + tab: 'request' | 'response' | 'endpoint' | 'preview' | 'test' = 'response'; loading = false; saving = false; @@ -60,16 +54,21 @@ export class CicApiMappingComponent implements OnInit { jsonErrors: { headers?: string; body?: string } = {}; // preview - previewClient: { id: number; name: string } | null = null; - previewAmount = 100000; - previewPurpose = 'NEW_LOAN'; + previewFrom = ''; + previewTo = ''; previewResult: any = null; previewing = false; + // test response + sampleText = ''; + testResult: any = null; + testing = false; + cbsFieldList: { key: string; label: string }[] = []; resultFieldList: { key: string; label: string }[] = []; transformList: { key: string; label: string }[] = []; - purposes: { code: string; label: string }[] = []; + + readonly matchLabels = CIC_MATCH_LABELS; ngOnInit(): void { this.cic.catalog().subscribe({ @@ -93,12 +92,6 @@ export class CicApiMappingComponent implements OnInit { label ]) => ({ key, label }) ); - this.purposes = Object.entries(c.purposes).map( - ([ - code, - label - ]) => ({ code, label }) - ); }, error: (e) => (this.error = cicError(e)) }); @@ -117,6 +110,10 @@ export class CicApiMappingComponent implements OnInit { return this.bureaus.find((b) => b.id === this.bureauId); } + isRoot(target: string): boolean { + return (this.catalog?.rootFields ?? []).includes(target); + } + load(): void { if (!this.bureauId) return; if (this.dirty && !confirm('Discard unsaved mapping changes?')) return; @@ -124,14 +121,11 @@ export class CicApiMappingComponent implements OnInit { this.error = null; this.info = null; this.previewResult = null; + this.testResult = null; this.cic.endpoint(this.bureauId, this.endpointType).subscribe({ next: (e) => { - this.endpoint = { ...e, headersJson: this.prettyJson(e.headersJson), baseBody: this.prettyJson(e.baseBody) }; - this.requestRows = e.requestMappings.map((m) => ({ ...m })); - this.responseRows = e.responseMappings.map((m) => ({ ...m })); + this.apply(e); this.loading = false; - this.dirty = false; - this.jsonErrors = {}; }, error: (err) => { this.loading = false; @@ -140,6 +134,14 @@ export class CicApiMappingComponent implements OnInit { }); } + private apply(e: CicEndpoint): void { + this.endpoint = { ...e, headersJson: this.prettyJson(e.headersJson), baseBody: this.prettyJson(e.baseBody) }; + this.requestRows = e.requestMappings.map((m) => ({ ...m })); + this.responseRows = e.responseMappings.map((m) => ({ ...m })); + this.dirty = false; + this.jsonErrors = {}; + } + markDirty(): void { this.dirty = true; } @@ -235,11 +237,8 @@ export class CicApiMappingComponent implements OnInit { .subscribe({ next: (e) => { this.saving = false; - this.dirty = false; - this.endpoint = { ...e, headersJson: this.prettyJson(e.headersJson), baseBody: this.prettyJson(e.baseBody) }; - this.requestRows = e.requestMappings.map((m) => ({ ...m })); - this.responseRows = e.responseMappings.map((m) => ({ ...m })); - this.info = `${this.bureau?.code} ${this.endpointType} mapping saved (${this.requestRows.length} request, ${this.responseRows.length} response fields).`; + this.apply(e); + this.info = `${this.bureau?.code} enquiry-alert mapping saved (${this.requestRows.length} request, ${this.responseRows.length} response fields).`; }, error: (err) => { this.saving = false; @@ -248,30 +247,20 @@ export class CicApiMappingComponent implements OnInit { }); } - pickPreviewClient(): void { - this.dialog - .open(CustomerSearchDialogComponent, { width: '960px', maxWidth: '95vw', data: { requireAccount: false } }) - .afterClosed() - .subscribe((r: CustomerSearchResult | undefined) => { - if (r?.clientId) this.previewClient = { id: r.clientId, name: r.displayName }; - }); + private requireSaved(): boolean { + if (this.dirty) { + this.error = 'Save the mapping first — preview and test use the saved mapping.'; + return false; + } + return true; } runPreview(): void { - if (!this.bureauId || !this.previewClient) return; - if (this.dirty) { - this.error = 'Save the mapping first — the preview uses the saved mapping.'; - return; - } + if (!this.bureauId || !this.requireSaved()) return; this.previewing = true; this.error = null; this.cic - .preview(this.bureauId, { - clientId: this.previewClient.id, - enquiryType: this.endpointType, - purpose: this.previewPurpose, - loanAmount: this.previewAmount - }) + .preview(this.bureauId, { fromDate: this.previewFrom || undefined, toDate: this.previewTo || undefined }) .subscribe({ next: (r) => { this.previewing = false; @@ -284,6 +273,23 @@ export class CicApiMappingComponent implements OnInit { }); } + runTest(): void { + if (!this.bureauId || !this.requireSaved()) return; + this.testing = true; + this.error = null; + this.cic.parseTest(this.bureauId, this.sampleText.trim() || null).subscribe({ + next: (r) => { + this.testing = false; + this.testResult = r; + if (r.sampleResponse && !this.sampleText.trim()) this.sampleText = this.prettyJson(r.sampleResponse); + }, + error: (e) => { + this.testing = false; + this.error = cicError(e, 'Test failed.'); + } + }); + } + prettyJson(text?: string | null): string { if (!text) return '{}'; try { @@ -293,10 +299,6 @@ export class CicApiMappingComponent implements OnInit { } } - prettyBody(text?: string | null): string { - return this.prettyJson(text); - } - headerEntries(h: Record | null | undefined): { k: string; v: string }[] { return Object.entries(h ?? {}).map( ([ diff --git a/src/app/credit-bureau/cic-bureau-config/cic-bureau-config.component.html b/src/app/credit-bureau/cic-bureau-config/cic-bureau-config.component.html index 18870f99e..7a44b3d73 100644 --- a/src/app/credit-bureau/cic-bureau-config/cic-bureau-config.component.html +++ b/src/app/credit-bureau/cic-bureau-config/cic-bureau-config.component.html @@ -11,11 +11,12 @@

CIC Whitelist & Configuration

- Choose which Credit Information Companies this bank may enquire, and how each is reached. Only whitelisted - bureaus appear on the enquiry screen. + Choose which Credit Information Companies this bank receives enquiry alerts from, and how each is reached. Only + whitelisted bureaus are fetched.

+ ← Dashboard API Mapping
@@ -76,10 +77,26 @@
Endpoints
{{ b.activeEndpoints }} active
-
Report reuse
-
{{ b.reportValidityDays ? 'within ' + b.reportValidityDays + ' days' : 'always pull fresh' }}
-
Charge / enquiry
-
₹{{ b.enquiryCharge | number: '1.0-2' }}
+
Alert fetch
+
+ {{ b.alertAutoFetch ? 'Automatic, every ' + b.alertFetchIntervalMin + ' min' : 'Manual only' }} + · looks back {{ b.alertLookbackDays }} days +
+
Last fetch
+
+ @if (b.lastFetchOn) { + {{ b.lastFetchStatus }} + {{ b.lastFetchOn | slice: 0 : 16 }} +
{{ b.lastFetchMessage }}
+ } @else { + never + } +
Last test
@if (b.lastTestStatus) { @@ -95,8 +112,13 @@ never }
-
Enquiries (30d)
-
{{ b.enquiriesLast30Days }}
+
Alerts (30d)
+
+ {{ b.alertsLast30Days }} + @if (b.newAlerts) { + {{ b.newAlerts }} new + } +
@@ -109,6 +131,16 @@ > {{ testing === b.id ? 'Testing…' : 'Test Connection' }} + @if (b.whitelisted) { + + } API Mapping
@@ -116,10 +148,11 @@
- Going live with a bureau: 1) get the bank's member code, API URL and credentials from the bureau; 2) - Configure them here (environment UAT first); 3) adapt the request / response fields under API Mapping to the - bureau's specification and use Preview; 4) Test Connection and run a test enquiry; 5) switch to PRODUCTION and - whitelist it. + Going live with a bureau: 1) subscribe to the bureau's enquiry-alert (portfolio monitoring) service and get + the bank's member code, API URL and credentials; 2) Configure them here (environment UAT first); 3) adapt the + request / response fields under API Mapping to the bureau's specification and check them with Preview and Test + Response; 4) Test Connection and Fetch alerts now; 5) switch to PRODUCTION and whitelist it. Alerts then arrive + automatically.
@if (editing) { @@ -206,20 +239,32 @@
- - - 0 = always pull a fresh report. Reuse avoids a second hard enquiry and its charge. + + +
- - + + + Each fetch asks for alerts of this many past days; ones already received are skipped.
diff --git a/src/app/credit-bureau/cic-bureau-config/cic-bureau-config.component.ts b/src/app/credit-bureau/cic-bureau-config/cic-bureau-config.component.ts index 97e1981c6..3fba2fde6 100644 --- a/src/app/credit-bureau/cic-bureau-config/cic-bureau-config.component.ts +++ b/src/app/credit-bureau/cic-bureau-config/cic-bureau-config.component.ts @@ -15,8 +15,8 @@ import { HasPermissionDirective } from 'app/directives/has-permission/has-permis import { CicBureau, CicCatalog, CicService, cicError } from '../cic.service'; /** - * Which CICs the bank may enquire (whitelist), and how each is reached: environment, URL, member code, - * authentication and credentials (stored encrypted, never shown back), timeouts, report reuse window and charge. + * Which CICs the bank receives enquiry alerts from (whitelist), and how each is reached: environment, URL, member + * code, authentication and credentials (stored encrypted, never shown back), timeout, and the alert fetch schedule. */ @Component({ selector: 'mifosx-cic-bureau-config', @@ -44,6 +44,7 @@ export class CicBureauConfigComponent implements OnInit { saving = false; testing: number | null = null; toggling: number | null = null; + fetching: number | null = null; readonly authLabels: Record = { NONE: 'None (IP whitelisting / mutual TLS)', @@ -83,7 +84,7 @@ export class CicBureauConfigComponent implements OnInit { next: (u) => { this.toggling = null; this.replace(u); - this.info = `${u.code} is now ${u.whitelisted ? 'whitelisted — enquiries can be run against it' : 'not whitelisted'}.`; + this.info = `${u.code} is now ${u.whitelisted ? 'whitelisted — its enquiry alerts will be fetched' : 'not whitelisted'}.`; }, error: (e) => { this.toggling = null; @@ -110,8 +111,9 @@ export class CicBureauConfigComponent implements OnInit { tokenUrl: b.tokenUrl ?? '', clientId: b.clientId ?? '', timeoutMs: b.timeoutMs, - reportValidityDays: b.reportValidityDays, - enquiryCharge: b.enquiryCharge, + alertAutoFetch: b.alertAutoFetch, + alertFetchIntervalMin: b.alertFetchIntervalMin, + alertLookbackDays: b.alertLookbackDays, isDefault: b.isDefault }; } @@ -154,6 +156,24 @@ export class CicBureauConfigComponent implements OnInit { }); } + fetchNow(b: CicBureau): void { + this.fetching = b.id; + this.error = null; + this.info = null; + this.cic.fetch(b.id).subscribe({ + next: (r) => { + this.fetching = null; + if (r.status === 'SUCCESS') this.info = `${b.code}: ${r.message}`; + else this.error = `${b.code}: ${r.message}`; + this.load(); + }, + error: (e) => { + this.fetching = null; + this.error = cicError(e, 'Fetch failed.'); + } + }); + } + needsSecret(auth: string): boolean { return auth !== 'NONE'; } diff --git a/src/app/credit-bureau/cic-consents/cic-consents.component.html b/src/app/credit-bureau/cic-consents/cic-consents.component.html deleted file mode 100644 index eaaf21331..000000000 --- a/src/app/credit-bureau/cic-consents/cic-consents.component.html +++ /dev/null @@ -1,253 +0,0 @@ - - -
-
-
-

Consent Register

-

Borrowers' consents to pull their credit report. No enquiry runs without an active, unexpired consent.

-
-
- -
-
- - @if (error) { -
{{ error }}
- } - @if (info) { -
{{ info }}
- } - - @if (capturing) { -
-

Record a consent

-
-
- -
- - -
-
-
- - -
-
- - -
-
- - -
- @if (form.consentMode === 'OTP') { -
- - -
- } @else { -
- - -
- } -
- - -
-
- - -
-
-
- - -
- - -
- } - -
-
-
- - -
-
- - -
-
- -
-
- - @if (loading) { -
Loading…
- } @else if (!items.length) { -
No consent recorded yet.
- } @else { -
- - - - - - - - - - - - - - - - @for (c of items; track c.id) { - - - - - - - - - - - - } - -
Consent refCustomerBureauPurposeModeValidStatusCaptured by
{{ c.consentRef }} - {{ c.clientName }} #{{ c.clientId }} - @if (c.applicationNo) { -
App {{ c.applicationNo }}
- } - 		{{ c.bureauCode }}{{ c.purpose }}{{ c.consentMode }}{{ c.validFrom }} → {{ c.validUntil }} - {{ c.status }} - - {{ c.capturedByName }} -
{{ c.capturedOn | slice: 0 : 16 }}
- 		- - @if (c.status === 'ACTIVE') { - - } -
-
-
- {{ offset + 1 }}–{{ offset + items.length }} of {{ total }} -
- - -
-
- } -
- - @if (revoking) { -
-
-

Revoke consent {{ revoking.consentRef }}

-

- {{ revoking.clientName }} — no further enquiry can run under this consent. Enquiries already made are not - affected. -

-
- - -
-
- - -
-
-
- } - - @if (viewing) { -
-
-

Consent {{ viewing.consentRef }}

-
-
Customer
-
{{ viewing.clientName }} (#{{ viewing.clientId }})
-
Bureau
-
{{ viewing.bureauCode }}
-
Purpose / mode
-
{{ viewing.purpose }} · {{ viewing.consentMode }}
-
Document / OTP ref
-
{{ viewing.documentRef || viewing.otpReference || '—' }}
-
Valid
-
{{ viewing.validFrom }} → {{ viewing.validUntil }}
-
Status
-
{{ viewing.status }}{{ viewing.revokedReason ? ' — ' + viewing.revokedReason : '' }}
-
Captured
-
- {{ viewing.capturedOn | slice: 0 : 19 }} by {{ viewing.capturedByName }} ({{ - viewing.ipAddress || 'IP n/a' - }}) -
-
-
- -
- {{ viewing.consentText }} -
-
-
-
-
- } -
diff --git a/src/app/credit-bureau/cic-consents/cic-consents.component.ts b/src/app/credit-bureau/cic-consents/cic-consents.component.ts deleted file mode 100644 index a9b13914d..000000000 --- a/src/app/credit-bureau/cic-consents/cic-consents.component.ts +++ /dev/null @@ -1,187 +0,0 @@ -/** - * Copyright since 2025 Mifos Initiative - * - * This Source Code Form is subject to the terms of the Mozilla Public - * License, v. 2.0. If a copy of the MPL was not distributed with this - * file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -import { CommonModule } from '@angular/common'; -import { Component, OnInit, inject } from '@angular/core'; -import { FormsModule } from '@angular/forms'; -import { MatDialog, MatDialogModule } from '@angular/material/dialog'; -import { RouterModule } from '@angular/router'; - -import { HasPermissionDirective } from 'app/directives/has-permission/has-permission.directive'; -import { - CustomerSearchDialogComponent, - CustomerSearchResult -} from 'app/shared/customer-search-dialog/customer-search-dialog.component'; -import { CicBureau, CicCatalog, CicConsent, CicService, cicError } from '../cic.service'; - -/** Register of borrower consents to a credit bureau pull: capture, view, revoke. */ -@Component({ - selector: 'mifosx-cic-consents', - standalone: true, - imports: [ - CommonModule, - FormsModule, - RouterModule, - MatDialogModule, - HasPermissionDirective - ], - templateUrl: './cic-consents.component.html', - styleUrls: ['../cic-shared.scss'] -}) -export class CicConsentsComponent implements OnInit { - private cic = inject(CicService); - private dialog = inject(MatDialog); - - catalog: CicCatalog | null = null; - bureaus: CicBureau[] = []; - purposes: { code: string; label: string }[] = []; - - items: CicConsent[] = []; - total = 0; - loading = false; - error: string | null = null; - info: string | null = null; - - filter = { search: '', status: '' }; - offset = 0; - readonly limit = 20; - - // capture - capturing = false; - saving = false; - form = this.blankForm(); - formClient: { id: number; name: string } | null = null; - - // revoke / view - revoking: CicConsent | null = null; - revokeReason = ''; - viewing: CicConsent | null = null; - - ngOnInit(): void { - this.cic.catalog().subscribe({ - next: (c) => { - this.catalog = c; - this.purposes = Object.entries(c.purposes).map( - ([ - code, - label - ]) => ({ code, label }) - ); - this.form.consentText = c.defaultConsentText; - }, - error: (e) => (this.error = cicError(e)) - }); - this.cic.bureaus().subscribe({ next: (b) => (this.bureaus = b), error: () => (this.bureaus = []) }); - this.load(); - } - - private blankForm() { - return { - bureauId: '' as any, - applicationNo: '', - purpose: 'NEW_LOAN', - consentMode: 'SIGNED_FORM', - documentRef: '', - otpReference: '', - validityDays: 30, - consentText: this.catalog?.defaultConsentText ?? '', - customerDeclarationAccepted: false - }; - } - - load(): void { - this.loading = true; - this.error = null; - this.cic.consents({ ...this.filter, offset: this.offset, limit: this.limit }).subscribe({ - next: (p) => { - this.items = p.pageItems; - this.total = p.totalFilteredRecords; - this.loading = false; - }, - error: (e) => { - this.error = cicError(e, 'Could not load consents.'); - this.loading = false; - } - }); - } - - apply(): void { - this.offset = 0; - this.load(); - } - - page(delta: number): void { - this.offset = Math.max(0, this.offset + delta * this.limit); - this.load(); - } - - tone(status: string): string { - return status === 'ACTIVE' ? 'good' : status === 'EXPIRED' ? 'warn' : 'bad'; - } - - startCapture(): void { - this.capturing = true; - this.form = this.blankForm(); - this.formClient = null; - this.info = null; - } - - pickClient(): void { - this.dialog - .open(CustomerSearchDialogComponent, { width: '960px', maxWidth: '95vw', data: { requireAccount: false } }) - .afterClosed() - .subscribe((r: CustomerSearchResult | undefined) => { - if (r?.clientId) this.formClient = { id: r.clientId, name: r.displayName }; - }); - } - - save(): void { - if (!this.formClient) return; - this.saving = true; - this.error = null; - this.cic - .createConsent({ - clientId: this.formClient.id, - bureauId: this.form.bureauId ? Number(this.form.bureauId) : null, - applicationNo: this.form.applicationNo || null, - purpose: this.form.purpose, - consentMode: this.form.consentMode, - documentRef: this.form.documentRef || null, - otpReference: this.form.otpReference || null, - validityDays: this.form.validityDays, - consentText: this.form.consentText, - customerDeclarationAccepted: this.form.customerDeclarationAccepted - }) - .subscribe({ - next: (c) => { - this.saving = false; - this.capturing = false; - this.info = `Consent ${c.consentRef} recorded for ${c.clientName}, valid until ${c.validUntil}.`; - this.apply(); - }, - error: (e) => { - this.saving = false; - this.error = cicError(e, 'Could not record the consent.'); - } - }); - } - - confirmRevoke(): void { - if (!this.revoking) return; - const target = this.revoking; - this.cic.revokeConsent(target.id, this.revokeReason).subscribe({ - next: () => { - this.info = `Consent ${target.consentRef} revoked.`; - this.revoking = null; - this.revokeReason = ''; - this.load(); - }, - error: (e) => (this.error = cicError(e, 'Could not revoke the consent.')) - }); - } -} diff --git a/src/app/credit-bureau/cic-dashboard/cic-dashboard.component.html b/src/app/credit-bureau/cic-dashboard/cic-dashboard.component.html index cdd9cd287..58c8202f1 100644 --- a/src/app/credit-bureau/cic-dashboard/cic-dashboard.component.html +++ b/src/app/credit-bureau/cic-dashboard/cic-dashboard.component.html @@ -9,161 +9,246 @@
-

Credit Bureau Dashboard

+

Credit Bureau — Customer Enquiry Alerts

- Enquiries to the Credit Information Companies (CIBIL, Experian, Equifax, CRIF High Mark) over the last 30 days. + Our customers who applied for a loan at another bank or NBFC, as reported by the CIC (CIBIL, Experian, Equifax, + CRIF): what loan and how much. The CIC does not tell which bank or lender it was.

- - New Enquiry + + Fetch log + @if (whitelisted.length) { + + }
@if (error) {
{{ error }}
} + @if (info) { +
{{ info }}
+ } + @if (data && !whitelisted.length) { +
+ No CIC is whitelisted yet, so no alerts are being received. Whitelist a bureau from the AI / Intelligence Modules + menu → API Management → CIC Whitelist & Configuration. +
+ } @if (loading && !data) {
Loading…
} @if (data) { - @if (whitelistedCount === 0) { -
- No credit bureau is whitelisted yet, so no enquiry can be run. - Open CIC Whitelist & Configuration to enable one. -
- } -
-
Enquiries today
-
{{ data.enquiriesToday }}
-
{{ data.enquiriesLast30Days }} in the last 30 days
+
New alerts
+
{{ data.newAlerts }}
+
not yet looked at
-
Success rate
-
{{ successRate }}%
-
{{ statusCount('FAILED') }} failed · {{ statusCount('NO_HIT') }} no-hit
+
Customers enquired elsewhere
+
{{ data.customersInPeriod }}
+
{{ data.alertsInPeriod }} enquiries · last {{ days }} days
-
Average score
-
- {{ data.averageScoreLast30Days ? (data.averageScoreLast30Days | number: '1.0-0') : '—' }} -
-
{{ scoreBand(data.averageScoreLast30Days).label }}
+
Amount applied elsewhere
+
₹{{ data.amountInPeriod | number: '1.0-0' }}
+
in total · last {{ days }} days
-
Active consents
-
{{ data.activeConsents }}
-
- Charges ₹{{ data.chargesLast30Days | number: '1.0-2' }} · {{ statusCount('REUSED') }} reports reused -
+
Unmatched alerts
+
{{ data.unmatchedOpen }}
+
bureau sent, customer not found · {{ data.receivedToday }} received today
-
-
-

- Bureaus {{ whitelistedCount }} of {{ data.bureaus.length }} whitelisted -

+ +
+

Latest enquiries on our customers

+ @if (data.recent?.length) {
+ + + + + + - - - - + - @for (b of data.bureaus; track b.id) { - + @for (a of data.recent; track a.id) { + + + + + + + - - - }
Enquiry dateOur customerBranchLoan typeAmount (₹)Purpose BureauWhitelistedEnvironmentEnquiries (30d)FailedStatus
{{ a.enquiryDate | date: 'dd MMM yyyy' }} - {{ b.code }} - @if (b.isDefault) { - Default - } -
{{ b.name }}
+ {{ a.clientName }} +
{{ a.clientAccountNo }}
{{ a.officeName }}{{ a.loanType }}{{ a.amount | number: '1.0-0' }}{{ a.purpose }}{{ a.bureauCode }} - {{ b.whitelisted ? 'Yes' : 'No' }} + {{ a.status }} - {{ b.environment }} - {{ b.enquiries }}{{ b.failed }}
+ } @else { +
+ No enquiry alerts yet. They appear here as soon as a CIC reports one of our customers. +
+ } +
+ +
+ +
+

+ Customers applying elsewhere repeatedly + 2+ enquiries · last {{ days }} days +

+ @if (data.repeatCustomers?.length) { +
+ + + + + + + + + + + @for (c of data.repeatCustomers; track c.clientId) { + + + + + + + } + +
CustomerEnquiriesTotal applied (₹)Last
+ {{ c.clientName }} +
{{ c.accountNo }}
+ 		+ {{ c.alerts }} + {{ c.amount | number: '1.0-0' }}{{ c.lastEnquiryDate | date: 'dd MMM' }}
+
+ } @else { +
No customer has more than one enquiry in this period.
+ }
+
-

Score spread successful enquiries, 30 days

- @for (band of data.scoreBandsLast30Days; track band.label) { +

Enquiries per day last 14 days

+
+ @for (p of data.trend14Days; track p.date) { +
+ {{ p.count || '' }} +
+ {{ p.date | date: 'dd' }} +
+ } +
+
+
+ +
+
+

By loan type

+ @for (g of data.byLoanType; track g.label) {
- {{ band.label }}{{ band.count }} + {{ g.label }} + {{ g.count }} · ₹{{ g.amount | number: '1.0-0' }}
-
+
+ } @empty { +
No data.
}
-
+ +

- Recent enquiries - View all + Alert feed from each CIC + Fetch log

- @if (!data.recent?.length) { -
No enquiry yet.
- } @else { -
- - - - - - - - - - - - - - @for (e of data.recent; track e.id) { - - - - - - - - - +
+ @for (b of data.bureaus; track b.id) { +
+
+ {{ b.code }} + {{ b.whitelisted ? 'Whitelisted' : 'Off' }} +
+
+ {{ b.environment }} · {{ b.autoFetch ? 'auto every ' + b.intervalMin + ' min' : 'manual fetch only' }} +
+
+ Last fetch: + @if (b.lastFetchOn) { + {{ + b.lastFetchStatus + }} + {{ b.lastFetchOn | slice: 0 : 16 }} + } @else { + never } -
-
ReferenceCustomerBureauStatusScoreByWhen
{{ e.enquiryRef }}{{ e.clientName }}{{ e.bureauCode }} - {{ e.status }} - - {{ e.score ?? '—' }} - {{ e.requestedByName }}{{ e.requestedOn | slice: 0 : 16 }}
-
- } +
+ @if (b.lastFetchMessage) { +
{{ b.lastFetchMessage }}
+ } + @if (b.whitelisted) { + + } +
+ } +
}
+ +@if (openAlertId) { + +} diff --git a/src/app/credit-bureau/cic-dashboard/cic-dashboard.component.ts b/src/app/credit-bureau/cic-dashboard/cic-dashboard.component.ts index 273de9f6f..93f20b54e 100644 --- a/src/app/credit-bureau/cic-dashboard/cic-dashboard.component.ts +++ b/src/app/credit-bureau/cic-dashboard/cic-dashboard.component.ts @@ -8,30 +8,44 @@ import { CommonModule } from '@angular/common'; import { Component, OnInit, inject } from '@angular/core'; -import { Router, RouterModule } from '@angular/router'; +import { FormsModule } from '@angular/forms'; +import { RouterModule } from '@angular/router'; -import { CicService, cicError, cicScoreBand } from '../cic.service'; +import { HasPermissionDirective } from 'app/directives/has-permission/has-permission.directive'; +import { CicAlertDetailComponent } from '../cic-alert-detail/cic-alert-detail.component'; +import { CicService, cicError, cicStatusTone } from '../cic.service'; -/** Credit Bureau overview: volumes, outcomes, score spread and the state of each bureau. */ +/** + * Credit Bureau dashboard: our customers who applied for a loan at another bank / NBFC, as reported by the CICs - + * who, what loan and how much (the CIC does not name the lender) - with the customers applying elsewhere repeatedly, + * the loan types, the trend, and the fetch status of each bureau. The other pages (fetch log, CIC configuration, API + * mapping) are reached from the buttons at the top. + */ @Component({ selector: 'mifosx-cic-dashboard', standalone: true, imports: [ CommonModule, - RouterModule + FormsModule, + RouterModule, + HasPermissionDirective, + CicAlertDetailComponent ], templateUrl: './cic-dashboard.component.html', styleUrls: ['../cic-shared.scss'] }) export class CicDashboardComponent implements OnInit { private cic = inject(CicService); - private router = inject(Router); + days = 30; loading = false; error: string | null = null; + info: string | null = null; data: any = null; + fetching: number | 'ALL' | null = null; + openAlertId: number | null = null; - readonly scoreBand = cicScoreBand; + readonly statusTone = cicStatusTone; ngOnInit(): void { this.load(); @@ -40,7 +54,7 @@ export class CicDashboardComponent implements OnInit { load(): void { this.loading = true; this.error = null; - this.cic.dashboard().subscribe({ + this.cic.dashboard(this.days).subscribe({ next: (d) => { this.data = d; this.loading = false; @@ -52,32 +66,54 @@ export class CicDashboardComponent implements OnInit { }); } - statusCount(status: string): number { - return Number(this.data?.byStatusLast30Days?.[status] ?? 0); + get whitelisted(): any[] { + return (this.data?.bureaus ?? []).filter((b: any) => b.whitelisted); } - get successRate(): number { - const total = Number(this.data?.enquiriesLast30Days ?? 0); - if (!total) return 0; - return Math.round(((this.statusCount('SUCCESS') + this.statusCount('REUSED')) / total) * 100); + /** Fetch now from one bureau, or from every whitelisted bureau in turn. */ + fetchNow(bureauId: number | 'ALL'): void { + const ids = bureauId === 'ALL' ? this.whitelisted.map((b) => b.id as number) : [bureauId]; + if (!ids.length) return; + this.fetching = bureauId; + this.error = null; + this.info = null; + const messages: string[] = []; + const next = (i: number) => { + if (i >= ids.length) { + this.fetching = null; + this.info = messages.join(' · '); + this.load(); + return; + } + this.cic.fetch(ids[i]).subscribe({ + next: (run) => { + messages.push( + `${run.bureauCode}: ${run.status === 'SUCCESS' ? run.newAlerts + ' new alert(s)' : 'failed - ' + run.message}` + ); + next(i + 1); + }, + error: (e) => { + messages.push(cicError(e, 'Fetch failed.')); + next(i + 1); + } + }); + }; + next(0); } - get maxBand(): number { - return Math.max(1, ...(this.data?.scoreBandsLast30Days ?? []).map((b: any) => Number(b.count))); + max(list: any[] | undefined, key: string): number { + return Math.max(1, ...(list ?? []).map((x) => Number(x[key] ?? 0))); } - get whitelistedCount(): number { - return (this.data?.bureaus ?? []).filter((b: any) => b.whitelisted).length; + pct(value: any, list: any[] | undefined, key: string): number { + return Math.round((Number(value ?? 0) / this.max(list, key)) * 100); } - statusTone(status: string): string { - return status === 'SUCCESS' ? 'good' : status === 'REUSED' ? 'ok' : status === 'NO_HIT' ? 'warn' : 'bad'; + onChanged(): void { + this.load(); } - open(id: number): void { - this.router.navigate([ - '/credit-bureau/enquiries', - id - ]); + fetchTone(status?: string): string { + return status === 'SUCCESS' ? 'good' : status === 'FAILED' ? 'bad' : ''; } } diff --git a/src/app/credit-bureau/cic-enquiry-detail/cic-enquiry-detail.component.html b/src/app/credit-bureau/cic-enquiry-detail/cic-enquiry-detail.component.html deleted file mode 100644 index f7edac05b..000000000 --- a/src/app/credit-bureau/cic-enquiry-detail/cic-enquiry-detail.component.html +++ /dev/null @@ -1,96 +0,0 @@ - - -
-
-
-

Enquiry {{ enquiry?.enquiryRef ?? '' }}

-

{{ enquiry?.clientName }} · {{ enquiry?.bureauName ?? enquiry?.bureauCode }}

-
-
- Back to history - - @if (enquiry) { - Enquire again - } -
-
- - @if (error) { -
{{ error }}
- } - - @if (enquiry) { -
-
-
Customer
-
- {{ enquiry.clientName }} (client #{{ enquiry.clientId }}) -
-
Bureau / environment
-
{{ enquiry.bureauCode }} · {{ enquiry.environment }}
-
Type / purpose
-
{{ enquiry.enquiryType }} · {{ enquiry.purpose }}
-
Amount
-
₹{{ enquiry.loanAmount | number: '1.0-2' }}
-
Loan application
-
{{ enquiry.applicationNo || '—' }}
-
Consent
-
{{ enquiry.consentRef || '—' }}
- @if (enquiry.reusedFromRef) { -
Reused report of
-
{{ enquiry.reusedFromRef }}
- } -
Charge
-
₹{{ enquiry.chargeAmount ?? 0 | number: '1.0-2' }}
-
Requested
-
{{ enquiry.requestedOn | slice: 0 : 19 }} by {{ enquiry.requestedByName }}
-
Response time
-
- {{ enquiry.durationMs ?? 0 }} ms - @if (enquiry.httpStatus) { - · HTTP {{ enquiry.httpStatus }} - } -
-
-
- -
- - - -
- - @if (tab === 'report') { - - } - @if (tab === 'request') { -
-

- Request PAN, mobile and e-mail are masked; credentials are never stored -

- 
{{ pretty(enquiry.requestMasked) }}
-
- } - @if (tab === 'response') { -
-

Raw response as returned by the bureau

- 
{{ pretty(enquiry.responseRaw) }}
-
- } - } -
diff --git a/src/app/credit-bureau/cic-enquiry-detail/cic-enquiry-detail.component.ts b/src/app/credit-bureau/cic-enquiry-detail/cic-enquiry-detail.component.ts deleted file mode 100644 index f156610b0..000000000 --- a/src/app/credit-bureau/cic-enquiry-detail/cic-enquiry-detail.component.ts +++ /dev/null @@ -1,56 +0,0 @@ -/** - * Copyright since 2025 Mifos Initiative - * - * This Source Code Form is subject to the terms of the Mozilla Public - * License, v. 2.0. If a copy of the MPL was not distributed with this - * file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -import { CommonModule } from '@angular/common'; -import { Component, OnInit, inject } from '@angular/core'; -import { ActivatedRoute, RouterModule } from '@angular/router'; - -import { CicEnquiry, CicService, cicError } from '../cic.service'; -import { CicReportViewComponent } from '../cic-report-view/cic-report-view.component'; - -/** One enquiry in full: report, audit trail, the masked request sent and the bureau's raw response. */ -@Component({ - selector: 'mifosx-cic-enquiry-detail', - standalone: true, - imports: [ - CommonModule, - RouterModule, - CicReportViewComponent - ], - templateUrl: './cic-enquiry-detail.component.html', - styleUrls: ['../cic-shared.scss'] -}) -export class CicEnquiryDetailComponent implements OnInit { - private cic = inject(CicService); - private route = inject(ActivatedRoute); - - enquiry: CicEnquiry | null = null; - error: string | null = null; - tab: 'report' | 'request' | 'response' = 'report'; - - ngOnInit(): void { - const id = Number(this.route.snapshot.paramMap.get('id')); - this.cic.enquiry(id).subscribe({ - next: (e) => (this.enquiry = e), - error: (e) => (this.error = cicError(e, 'Could not load the enquiry.')) - }); - } - - pretty(text?: string | null): string { - if (!text) return '—'; - try { - return JSON.stringify(JSON.parse(text), null, 2); - } catch { - return text; - } - } - - print(): void { - window.print(); - } -} diff --git a/src/app/credit-bureau/cic-enquiry-history/cic-enquiry-history.component.html b/src/app/credit-bureau/cic-enquiry-history/cic-enquiry-history.component.html deleted file mode 100644 index 13f05d004..000000000 --- a/src/app/credit-bureau/cic-enquiry-history/cic-enquiry-history.component.html +++ /dev/null @@ -1,127 +0,0 @@ - - -
-
-
-

Enquiry History

-

Every credit bureau enquiry made from this bank, with its outcome and score.

-
-
- - New Enquiry -
-
- -
-
-
- - -
-
- - -
-
- - -
-
-
- - -
-
- - -
-
-
-
- - -
-
- - @if (error) { -
{{ error }}
- } - -
- @if (loading) { -
Loading…
- } @else if (!items.length) { -
No enquiry matches these filters.
- } @else { -
- - - - - - - - - - - - - - - - @for (e of items; track e.id) { - - - - - - - - - - - - } - -
ReferenceCustomerBureauPurposeAmountStatusScoreRequested byWhen
- {{ e.enquiryRef }} - @if (e.environment === 'SIMULATOR') { - SIM - } - - {{ e.clientName }} - @if (e.applicationNo) { -
App {{ e.applicationNo }}
- } - 		{{ e.bureauCode }}{{ e.purpose }}₹{{ e.loanAmount | number: '1.0-0' }} - {{ e.status }} - - {{ e.score ?? '—' }} - {{ e.requestedByName }}{{ e.requestedOn | slice: 0 : 16 }}
-
-
- {{ offset + 1 }}–{{ offset + items.length }} of {{ total }} -
- - -
-
- } -
-
diff --git a/src/app/credit-bureau/cic-enquiry-history/cic-enquiry-history.component.ts b/src/app/credit-bureau/cic-enquiry-history/cic-enquiry-history.component.ts deleted file mode 100644 index ff185744d..000000000 --- a/src/app/credit-bureau/cic-enquiry-history/cic-enquiry-history.component.ts +++ /dev/null @@ -1,137 +0,0 @@ -/** - * Copyright since 2025 Mifos Initiative - * - * This Source Code Form is subject to the terms of the Mozilla Public - * License, v. 2.0. If a copy of the MPL was not distributed with this - * file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -import { CommonModule } from '@angular/common'; -import { Component, OnInit, inject } from '@angular/core'; -import { FormsModule } from '@angular/forms'; -import { Router, RouterModule } from '@angular/router'; - -import { CicBureau, CicEnquiry, CicService, cicError, cicScoreBand } from '../cic.service'; - -/** Every bureau enquiry made, with filters, paging and CSV export. */ -@Component({ - selector: 'mifosx-cic-enquiry-history', - standalone: true, - imports: [ - CommonModule, - FormsModule, - RouterModule - ], - templateUrl: './cic-enquiry-history.component.html', - styleUrls: ['../cic-shared.scss'] -}) -export class CicEnquiryHistoryComponent implements OnInit { - private cic = inject(CicService); - private router = inject(Router); - - bureaus: CicBureau[] = []; - items: CicEnquiry[] = []; - total = 0; - loading = false; - error: string | null = null; - - filter = { search: '', bureauId: '', status: '', fromDate: '', toDate: '' }; - offset = 0; - readonly limit = 20; - readonly statuses = [ - 'SUCCESS', - 'NO_HIT', - 'FAILED', - 'REUSED' - ]; - readonly scoreBand = cicScoreBand; - - ngOnInit(): void { - this.cic.bureaus().subscribe({ next: (b) => (this.bureaus = b), error: () => (this.bureaus = []) }); - this.load(); - } - - load(): void { - this.loading = true; - this.error = null; - this.cic.enquiries({ ...this.filter, offset: this.offset, limit: this.limit }).subscribe({ - next: (p) => { - this.items = p.pageItems; - this.total = p.totalFilteredRecords; - this.loading = false; - }, - error: (e) => { - this.error = cicError(e, 'Could not load enquiries.'); - this.loading = false; - } - }); - } - - apply(): void { - this.offset = 0; - this.load(); - } - - reset(): void { - this.filter = { search: '', bureauId: '', status: '', fromDate: '', toDate: '' }; - this.apply(); - } - - page(delta: number): void { - this.offset = Math.max(0, this.offset + delta * this.limit); - this.load(); - } - - open(e: CicEnquiry): void { - this.router.navigate([ - '/credit-bureau/enquiries', - e.id - ]); - } - - statusTone(status: string): string { - return status === 'SUCCESS' ? 'good' : status === 'REUSED' ? 'ok' : status === 'NO_HIT' ? 'warn' : 'bad'; - } - - /** CSV of the current page, for audit / MIS. */ - exportCsv(): void { - const head = [ - 'Reference', - 'Customer', - 'Client id', - 'Bureau', - 'Type', - 'Purpose', - 'Amount', - 'Status', - 'Score', - 'Requested by', - 'Requested on' - ]; - const rows = this.items.map((e) => [ - e.enquiryRef, - e.clientName, - e.clientId, - e.bureauCode, - e.enquiryType, - e.purpose, - e.loanAmount, - e.status, - e.score ?? '', - e.requestedByName, - e.requestedOn - ]); - const csv = [ - head, - ...rows - ] - .map((r) => r.map((v) => `"${String(v ?? '').replace(/"/g, '""')}"`).join(',')) - .join('\n'); - const url = URL.createObjectURL(new Blob([csv], { type: 'text/csv;charset=utf-8' })); - const a = document.createElement('a'); - a.href = url; - a.download = `cic-enquiries-${new Date().toISOString().slice(0, 10)}.csv`; - a.click(); - URL.revokeObjectURL(url); - } -} diff --git a/src/app/credit-bureau/cic-fetch-log/cic-fetch-log.component.html b/src/app/credit-bureau/cic-fetch-log/cic-fetch-log.component.html new file mode 100644 index 000000000..02d6d5b7b --- /dev/null +++ b/src/app/credit-bureau/cic-fetch-log/cic-fetch-log.component.html @@ -0,0 +1,126 @@ + + +
+
+
+

Fetch Log

+

Every time the CBS asked a CIC for enquiry alerts: when, how many came, how many were our customers.

+
+
+ ← Dashboard +
+
+ + @if (error) { +
{{ error }}
+ } + +
+

+ Fetches + + + + +

+ @if (loading && !runs.length) { +
Loading…
+ } @else if (!runs.length) { +
No fetch has run yet.
+ } @else { +
+ + + + + + + + + + + + + + + + + + + + @for (r of runs; track r.id) { + + + + + + + + + + + + + + + + } + +
RunBureauHowWindowStatusReceivedNewMatchedUnmatchedAlready hadOwn bankByWhen
{{ r.runRef }}{{ r.bureauCode }}{{ r.trigger }}{{ r.fromDate | date: 'dd MMM' }} – {{ r.toDate | date: 'dd MMM yy' }} + {{ r.status }} + {{ r.received }} + {{ r.newAlerts }} + {{ r.matched }}{{ r.unmatched }}{{ r.duplicates }}{{ r.ownBank }}{{ r.triggeredByName }}{{ r.startedOn | slice: 0 : 16 }}
+
+
+ {{ offset + 1 }}–{{ offset + runs.length }} of {{ total }} + + + + +
+ } +
+
+ +@if (viewing) { +
+
+

{{ viewing.runRef }} · {{ viewing.bureauCode }} · {{ viewing.status }}

+
+ {{ viewing.message }} + @if (viewing.httpStatus) { + (HTTP {{ viewing.httpStatus }}, {{ viewing.durationMs }} ms) + } +
+
+
+

Request

+ 
{{ pretty(viewing.request) || '—' }}
+
+
+

Response

+ 
{{ pretty(viewing.response) || '—' }}
+
+
+
+ +
+
+
+} diff --git a/src/app/credit-bureau/cic-fetch-log/cic-fetch-log.component.ts b/src/app/credit-bureau/cic-fetch-log/cic-fetch-log.component.ts new file mode 100644 index 000000000..efc6ced45 --- /dev/null +++ b/src/app/credit-bureau/cic-fetch-log/cic-fetch-log.component.ts @@ -0,0 +1,91 @@ +/** + * Copyright since 2025 Mifos Initiative + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +import { CommonModule } from '@angular/common'; +import { Component, OnInit, inject } from '@angular/core'; +import { FormsModule } from '@angular/forms'; +import { RouterModule } from '@angular/router'; + +import { CicBureau, CicFetchRun, CicService, cicError } from '../cic.service'; + +/** Log of every alert fetch from the CICs: when, how many alerts, how many matched, and the request / response. */ +@Component({ + selector: 'mifosx-cic-fetch-log', + standalone: true, + imports: [ + CommonModule, + FormsModule, + RouterModule + ], + templateUrl: './cic-fetch-log.component.html', + styleUrls: ['../cic-shared.scss'] +}) +export class CicFetchLogComponent implements OnInit { + private cic = inject(CicService); + + bureaus: CicBureau[] = []; + runs: CicFetchRun[] = []; + total = 0; + offset = 0; + readonly limit = 20; + bureauId = ''; + viewing: CicFetchRun | null = null; + loading = false; + error: string | null = null; + + ngOnInit(): void { + this.cic.bureaus().subscribe({ next: (b) => (this.bureaus = b), error: () => (this.bureaus = []) }); + this.load(); + } + + load(): void { + this.loading = true; + this.error = null; + this.cic.fetchRuns({ bureauId: this.bureauId, offset: this.offset, limit: this.limit }).subscribe({ + next: (p) => { + this.runs = p.pageItems; + this.total = p.totalFilteredRecords; + this.loading = false; + }, + error: (e) => { + this.error = cicError(e, 'Could not load the fetch log.'); + this.loading = false; + } + }); + } + + filterChanged(): void { + this.offset = 0; + this.load(); + } + + page(delta: number): void { + this.offset = Math.max(0, this.offset + delta * this.limit); + this.load(); + } + + view(r: CicFetchRun): void { + this.cic.fetchRun(r.id).subscribe({ + next: (full) => (this.viewing = full), + error: (e) => (this.error = cicError(e)) + }); + } + + pretty(text?: string | null): string { + if (!text) return ''; + try { + return JSON.stringify(JSON.parse(text), null, 2); + } catch { + return text; + } + } + + tone(status: string): string { + return status === 'SUCCESS' ? 'good' : status === 'FAILED' ? 'bad' : 'warn'; + } +} diff --git a/src/app/credit-bureau/cic-new-enquiry/cic-new-enquiry.component.html b/src/app/credit-bureau/cic-new-enquiry/cic-new-enquiry.component.html deleted file mode 100644 index b5d7b331c..000000000 --- a/src/app/credit-bureau/cic-new-enquiry/cic-new-enquiry.component.html +++ /dev/null @@ -1,297 +0,0 @@ - - -
-
-
-

New Credit Bureau Enquiry

-

- Pull a customer's credit report from a whitelisted Credit Information Company, under their recorded consent. -

-
-
- Enquiry History -
-
- -
-
1Customer
-
2Consent
-
3Enquiry
-
- - @if (error) { -
{{ error }}
- } - @if (info) { -
{{ info }}
- } - -
-
- -
-

- 1. Customer - @if (client) { - - } -

- @if (!client) { -
-
- - -
-
- - -
-
- } @else { -
-
-
{{ client.name }}
-
- Client #{{ client.id }} - @if (client.office) { - · {{ client.office }} - } -
-
- @if (loadingProfile) { - Loading… - } -
- @if (profile) { - @if (missingEssentials.length) { -
- Missing on the customer record: {{ missingEssentials.join(', ') }}. Bureaus match a customer on these — update the customer's KYC before enquiring, or the enquiry will - be refused. -
- } -
- Data that will be sent (masked) -
- @for (r of dataRows(); track r.label) { -
{{ r.label }}
-
{{ r.value ?? '—' }}
- } -
-
- } - } -
- - - @if (client && profile) { -
-

2. Customer consent

- @if (profile.validConsent) { -
- Consent {{ profile.validConsent.consentRef }} ({{ profile.validConsent.consentMode }}) on record, - valid until {{ profile.validConsent.validUntil }}. -
- @if (!showConsentForm) { - - } - } @else { -
- No valid consent for this customer{{ selectedBureau ? ' and ' + selectedBureau.code : '' }}. RBI requires - the borrower's consent before a credit report is pulled — record it below. -
- } - - @if (showConsentForm) { -
-
- - -
- @if (consent.consentMode === 'SIGNED_FORM') { -
- - -
- } @else if (consent.consentMode === 'OTP') { -
- - -
- } @else { -
- - -
- } -
- - -
-
- - -
-
-
- - -
- -
- - @if (profile.validConsent) { - - } -
- } -
- } - - - @if (client && profile) { -
-

3. Enquiry

-
-
- - - @if (selectedBureau) { - - {{ selectedBureau.environment }} · reuses a report up to {{ selectedBureau.reportValidityDays }} days - old · charge ₹{{ selectedBureau.enquiryCharge | number: '1.0-2' }} - - } -
-
- - -
-
- - -
-
- - -
-
- - -
-
- -
-
-
- - @if (!profile.validConsent) { - Record the customer's consent first. - } -
-
- } -
- - -
- @if (result) { -
-

- Result - Full details -

-
- - } @else if (profile?.recentEnquiries?.length) { -
-

Previous enquiries of this customer

-
- - - - - - - - - - - - @for (e of profile.recentEnquiries; track e.id) { - - - - - - - - } - -
ReferenceBureauStatusScoreWhen
{{ e.enquiryRef }}{{ e.bureauCode }} - {{ e.status }} - {{ e.score ?? '—' }}{{ e.requestedOn | slice: 0 : 16 }}
-
-
- } @else { -
- The credit report appears here once the enquiry is run. -
- Bureaus in SIMULATOR mode answer with a realistic test report — no real bureau is contacted and no - charge applies. -
-
- } -
-
-
diff --git a/src/app/credit-bureau/cic-new-enquiry/cic-new-enquiry.component.ts b/src/app/credit-bureau/cic-new-enquiry/cic-new-enquiry.component.ts deleted file mode 100644 index dc6e9b434..000000000 --- a/src/app/credit-bureau/cic-new-enquiry/cic-new-enquiry.component.ts +++ /dev/null @@ -1,260 +0,0 @@ -/** - * Copyright since 2025 Mifos Initiative - * - * This Source Code Form is subject to the terms of the Mozilla Public - * License, v. 2.0. If a copy of the MPL was not distributed with this - * file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -import { CommonModule } from '@angular/common'; -import { Component, OnInit, inject } from '@angular/core'; -import { FormsModule } from '@angular/forms'; -import { MatDialog, MatDialogModule } from '@angular/material/dialog'; -import { ActivatedRoute, RouterModule } from '@angular/router'; - -import { - CustomerSearchDialogComponent, - CustomerSearchResult -} from 'app/shared/customer-search-dialog/customer-search-dialog.component'; -import { CicBureau, CicCatalog, CicEnquiry, CicService, cicError } from '../cic.service'; -import { CicReportViewComponent } from '../cic-report-view/cic-report-view.component'; - -/** - * Pull a credit report: pick the customer, make sure their bureau consent is on record (capture it here if not), - * choose a whitelisted bureau, purpose and amount, and run the enquiry. - */ -@Component({ - selector: 'mifosx-cic-new-enquiry', - standalone: true, - imports: [ - CommonModule, - FormsModule, - RouterModule, - MatDialogModule, - CicReportViewComponent - ], - templateUrl: './cic-new-enquiry.component.html', - styleUrls: ['../cic-shared.scss'] -}) -export class CicNewEnquiryComponent implements OnInit { - private cic = inject(CicService); - private dialog = inject(MatDialog); - private route = inject(ActivatedRoute); - - catalog: CicCatalog | null = null; - bureaus: CicBureau[] = []; - purposes: { code: string; label: string }[] = []; - - clientIdInput: number | null = null; - client: { id: number; name: string; mobile?: string | null; office?: string | null } | null = null; - profile: any = null; - loadingProfile = false; - - bureauId: number | null = null; - enquiryType = 'CONSUMER_ENQUIRY'; - purpose = 'NEW_LOAN'; - loanAmount: number | null = null; - applicationNo = ''; - forceFresh = false; - - showConsentForm = false; - consent = { - consentMode: 'SIGNED_FORM', - documentRef: '', - otpReference: '', - validityDays: 30, - bureauScope: 'ANY', - customerDeclarationAccepted: false, - consentText: '' - }; - savingConsent = false; - - running = false; - result: CicEnquiry | null = null; - error: string | null = null; - info: string | null = null; - - ngOnInit(): void { - this.cic.catalog().subscribe({ - next: (c) => { - this.catalog = c; - this.purposes = Object.entries(c.purposes).map( - ([ - code, - label - ]) => ({ code, label }) - ); - this.consent.consentText = c.defaultConsentText; - }, - error: (e) => (this.error = cicError(e)) - }); - this.cic.bureaus(true).subscribe({ - next: (b) => { - this.bureaus = b; - this.bureauId = (b.find((x) => x.isDefault) ?? b[0])?.id ?? null; - if (!b.length) { - this.error = - 'No credit bureau is whitelisted for this bank yet. Ask an administrator to whitelist one under CIC Configuration.'; - } - this.reloadProfile(); - }, - error: (e) => (this.error = cicError(e)) - }); - // Deep link from another screen (e.g. a loan application): /credit-bureau/new-enquiry?clientId=..&amount=..&applicationNo=.. - const q = this.route.snapshot.queryParamMap; - if (q.get('applicationNo')) this.applicationNo = q.get('applicationNo')!; - if (q.get('amount')) this.loanAmount = Number(q.get('amount')); - if (q.get('clientId')) { - this.clientIdInput = Number(q.get('clientId')); - this.loadClientById(); - } - } - - get selectedBureau(): CicBureau | undefined { - return this.bureaus.find((b) => b.id === this.bureauId); - } - - get step(): number { - if (!this.client) return 1; - if (!this.profile?.validConsent) return 2; - return 3; - } - - /** Data the default mapping cannot work without; the server checks the real mapping on submit. */ - get missingEssentials(): string[] { - const d = this.profile?.data ?? {}; - const missing: string[] = []; - if (!d['client.pan']) missing.push('PAN'); - if (!d['client.dob']) missing.push('Date of birth'); - if (!d['client.firstName'] && !d['client.fullName']) missing.push('Name'); - return missing; - } - - openSearch(): void { - this.dialog - .open(CustomerSearchDialogComponent, { width: '960px', maxWidth: '95vw', data: { requireAccount: false } }) - .afterClosed() - .subscribe((r: CustomerSearchResult | undefined) => { - if (!r?.clientId) return; - this.client = { id: r.clientId, name: r.displayName, mobile: r.mobileNo, office: r.officeName }; - this.clientIdInput = r.clientId; - this.resetOutcome(); - this.reloadProfile(); - }); - } - - loadClientById(): void { - if (!this.clientIdInput) return; - this.client = { id: Number(this.clientIdInput), name: `Client #${this.clientIdInput}` }; - this.resetOutcome(); - this.reloadProfile(); - } - - reloadProfile(): void { - if (!this.client) return; - this.loadingProfile = true; - this.cic.clientProfile(this.client.id, this.bureauId).subscribe({ - next: (p) => { - this.profile = p; - this.loadingProfile = false; - const name = p?.data?.['client.fullName']; - if (name && this.client) this.client.name = name; - if (this.client && p?.data?.['client.branch']) this.client.office = p.data['client.branch']; - this.showConsentForm = !p?.validConsent; - }, - error: (e) => { - this.error = cicError(e, 'Could not load the customer.'); - this.profile = null; - this.client = null; - this.loadingProfile = false; - } - }); - } - - onBureauChange(): void { - this.resetOutcome(); - this.reloadProfile(); - } - - saveConsent(): void { - if (!this.client) return; - this.error = null; - this.savingConsent = true; - this.cic - .createConsent({ - clientId: this.client.id, - bureauId: this.consent.bureauScope === 'THIS' ? this.bureauId : null, - applicationNo: this.applicationNo || null, - purpose: this.purpose, - consentMode: this.consent.consentMode, - documentRef: this.consent.documentRef || null, - otpReference: this.consent.otpReference || null, - validityDays: this.consent.validityDays, - consentText: this.consent.consentText, - customerDeclarationAccepted: this.consent.customerDeclarationAccepted - }) - .subscribe({ - next: (c) => { - this.savingConsent = false; - this.info = `Consent ${c.consentRef} recorded, valid until ${c.validUntil}.`; - this.consent.customerDeclarationAccepted = false; - this.reloadProfile(); - }, - error: (e) => { - this.savingConsent = false; - this.error = cicError(e, 'Could not record the consent.'); - } - }); - } - - runEnquiry(): void { - if (!this.client || !this.bureauId) return; - this.error = null; - this.info = null; - this.result = null; - this.running = true; - this.cic - .enquire({ - clientId: this.client.id, - bureauId: this.bureauId, - enquiryType: this.enquiryType, - purpose: this.purpose, - loanAmount: this.loanAmount, - applicationNo: this.applicationNo || null, - consentId: this.profile?.validConsent?.id ?? null, - forceFresh: this.forceFresh - }) - .subscribe({ - next: (r) => { - this.running = false; - this.result = r; - this.reloadProfile(); - }, - error: (e) => { - this.running = false; - this.error = cicError(e, 'The enquiry could not be run.'); - } - }); - } - - clearClient(): void { - this.client = null; - this.profile = null; - this.clientIdInput = null; - this.resetOutcome(); - } - - private resetOutcome(): void { - this.result = null; - this.error = null; - this.info = null; - } - - dataRows(): { label: string; value: any }[] { - const d = this.profile?.data ?? {}; - const fields = this.catalog?.cbsFields ?? {}; - return Object.keys(d) - .filter((k) => !['client.id'].includes(k)) - .map((k) => ({ label: fields[k] ?? k, value: d[k] })); - } -} diff --git a/src/app/credit-bureau/cic-report-view/cic-report-view.component.html b/src/app/credit-bureau/cic-report-view/cic-report-view.component.html deleted file mode 100644 index 56a03e5b4..000000000 --- a/src/app/credit-bureau/cic-report-view/cic-report-view.component.html +++ /dev/null @@ -1,164 +0,0 @@ - - -@if (enquiry.status === 'FAILED') { -
- Enquiry failed. {{ enquiry.errorMessage }} - @if (enquiry.httpStatus) { -
HTTP status {{ enquiry.httpStatus }}
- } -
-} -@if (enquiry.status === 'NO_HIT') { -
No record found. {{ enquiry.errorMessage }}
-} -@if (enquiry.status === 'REUSED') { -
{{ enquiry.errorMessage }}
-} - -@if (enquiry.status === 'SUCCESS' || enquiry.status === 'REUSED') { -
-
-
-
-
- {{ enquiry.score ?? '—' }}{{ band.label }} -
-
-
-
-
- {{ enquiry.status }} - {{ enquiry.bureauCode }} - @if (enquiry.environment === 'SIMULATOR') { - SIMULATOR — not a real bureau report - } -
-
-
Report / control no.
-
{{ result.reportId ?? '—' }}
-
Score model
-
{{ result.scoreVersion ?? '—' }}
-
Enquiry reference
-
{{ enquiry.enquiryRef }}
-
-
-
-
- -
-
-
Accounts
-
{{ result.totalAccounts ?? '—' }}
-
{{ result.activeAccounts ?? 0 }} active
-
-
-
Outstanding
-
₹{{ result.totalOutstanding ?? 0 | number: '1.0-0' }}
-
across active accounts
-
-
-
Overdue
-
- ₹{{ result.totalOverdue ?? 0 | number: '1.0-0' }} -
-
- {{ result.overdueAccounts ?? 0 }} account(s) · max DPD {{ result.maxDpd ?? 0 }} - @if ((result.writtenOffAccounts ?? 0) > 0) { - · {{ result.writtenOffAccounts }} written-off - } -
-
-
-
Enquiries (6 months)
-
- {{ result.enquiriesLast6Months ?? '—' }} -
-
credit hunger indicator
-
-
- - @if (extraFields.length) { -
-

Other mapped fields

-
- @for (f of extraFields; track f.key) { -
{{ f.key }}
-
{{ f.value ?? '—' }}
- } -
-
- } - -
-

- Credit accounts {{ accounts.length }} reported -

- @if (!accounts.length) { -
The bureau reported no account (or the response mapping has no "accounts" field).
- } @else { -
- - - - @for (k of keys(accounts[0]); track k) { - - } - - - - @for (a of accounts; track $index) { - - @for (k of keys(accounts[0]); track k) { - - } - - } - -
{{ k }}
- @if (k === 'status') { - {{ a[k] }} - } @else { - {{ a[k] }} - } -
-
- } -
- -
-

- Recent enquiries by other lenders {{ enquiries.length }} -

- @if (!enquiries.length) { -
No enquiry reported.
- } @else { -
- - - - @for (k of keys(enquiries[0]); track k) { - - } - - - - @for (q of enquiries; track $index) { - - @for (k of keys(enquiries[0]); track k) { - - } - - } - -
{{ k }}
{{ q[k] }}
-
- } -
-} diff --git a/src/app/credit-bureau/cic-report-view/cic-report-view.component.ts b/src/app/credit-bureau/cic-report-view/cic-report-view.component.ts deleted file mode 100644 index 5a9922715..000000000 --- a/src/app/credit-bureau/cic-report-view/cic-report-view.component.ts +++ /dev/null @@ -1,108 +0,0 @@ -/** - * Copyright since 2025 Mifos Initiative - * - * This Source Code Form is subject to the terms of the Mozilla Public - * License, v. 2.0. If a copy of the MPL was not distributed with this - * file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -import { CommonModule } from '@angular/common'; -import { Component, Input } from '@angular/core'; -import { RouterModule } from '@angular/router'; - -import { CicEnquiry, cicScoreBand } from '../cic.service'; - -/** The outcome of one enquiry: score, summary, accounts and enquiries, read from the normalised result. */ -@Component({ - selector: 'mifosx-cic-report-view', - standalone: true, - imports: [ - CommonModule, - RouterModule - ], - templateUrl: './cic-report-view.component.html', - styleUrls: ['../cic-shared.scss'] -}) -export class CicReportViewComponent { - @Input({ required: true }) enquiry!: CicEnquiry; - - get result(): any { - return this.enquiry?.result ?? {}; - } - - get band() { - return cicScoreBand(this.enquiry?.score); - } - - /** Conic ring filled in proportion to the score on the 300-900 scale. */ - get ringStyle(): string { - const score = this.enquiry?.score; - const pct = score ? Math.max(0, Math.min(100, ((score - 300) / 600) * 100)) : 0; - const colors: Record = { - good: '#047857', - ok: '#0369a1', - warn: '#b45309', - bad: '#b91c1c', - muted: '#94a3b8' - }; - const color = colors[this.band.tone] ?? colors['muted']; - return `conic-gradient(${color} ${pct}%, #e2e8f0 ${pct}% 100%)`; - } - - get accounts(): any[] { - return Array.isArray(this.result.accounts) ? this.result.accounts : []; - } - - get enquiries(): any[] { - return Array.isArray(this.result.enquiries) ? this.result.enquiries : []; - } - - /** Result fields beyond the standard ones a custom RESPONSE mapping may have added. */ - get extraFields(): { key: string; value: any }[] { - const standard = new Set([ - 'hit', - 'reportId', - 'score', - 'scoreVersion', - 'totalAccounts', - 'activeAccounts', - 'overdueAccounts', - 'writtenOffAccounts', - 'totalOutstanding', - 'totalOverdue', - 'enquiriesLast6Months', - 'maxDpd', - 'accounts', - 'enquiries' - ]); - return Object.entries(this.result) - .filter( - ([ - k, - v - ]) => !standard.has(k) && (v === null || typeof v !== 'object') - ) - .map( - ([ - key, - value - ]) => ({ key, value }) - ); - } - - statusTone(status: string): string { - return status === 'SUCCESS' ? 'good' : status === 'REUSED' ? 'ok' : status === 'NO_HIT' ? 'warn' : 'bad'; - } - - accountTone(a: any): string { - const status = String(a?.status ?? '').toUpperCase(); - if (status.includes('WRITTEN') || status.includes('SETTLED')) return 'bad'; - if (Number(a?.dpd ?? 0) > 0 || Number(a?.amountOverdue ?? 0) > 0) return 'warn'; - if (status === 'CLOSED') return ''; - return 'good'; - } - - keys(o: any): string[] { - return o && typeof o === 'object' ? Object.keys(o) : []; - } -} diff --git a/src/app/credit-bureau/cic-shared.scss b/src/app/credit-bureau/cic-shared.scss index ef56120eb..f34f4e951 100644 --- a/src/app/credit-bureau/cic-shared.scss +++ b/src/app/credit-bureau/cic-shared.scss @@ -492,45 +492,6 @@ textarea.cic-mono { } } -.cic-score { - display: flex; - align-items: center; - gap: 18px; - - .ring { - width: 120px; - height: 120px; - border-radius: 50%; - display: grid; - place-items: center; - flex: none; - - .inner { - width: 92px; - height: 92px; - border-radius: 50%; - background: #fff; - display: grid; - place-items: center; - text-align: center; - - b { - font-size: 28px; - display: block; - line-height: 1; - font-variant-numeric: tabular-nums; - } - - small { - font-size: 10px; - color: var(--cic-muted); - text-transform: uppercase; - letter-spacing: 0.06em; - } - } - } -} - .cic-kv { display: grid; grid-template-columns: 170px minmax(0, 1fr); @@ -562,56 +523,41 @@ textarea.cic-mono { margin: 0; } -.cic-steps { +.cic-trend { display: flex; - gap: 8px; - margin-bottom: 16px; - flex-wrap: wrap; + align-items: flex-end; + gap: 6px; + height: 180px; + padding-top: 6px; - .step { + .col { + flex: 1; display: flex; + flex-direction: column; align-items: center; - gap: 8px; - padding: 7px 12px; - border-radius: 999px; - border: 1px solid var(--cic-line); - background: #fff; - font-size: 12px; - font-weight: 600; + justify-content: flex-end; + height: 100%; + min-width: 0; + } + + .bar { + width: 100%; + max-width: 28px; + min-height: 2px; + background: var(--cic-brand); + border-radius: 4px 4px 0 0; + } + + .n { + font-size: 10px; color: var(--cic-muted); + margin-bottom: 2px; + } - i { - width: 20px; - height: 20px; - border-radius: 50%; - background: var(--cic-soft); - display: grid; - place-items: center; - font-style: normal; - font-size: 11px; - } - - &.done { - color: var(--cic-good); - border-color: #a7f3d0; - background: var(--cic-good-soft); - - i { - background: var(--cic-good); - color: #fff; - } - } - - &.current { - color: var(--cic-brand); - border-color: #bfdbfe; - background: var(--cic-brand-soft); - - i { - background: var(--cic-brand); - color: #fff; - } - } + .d { + font-size: 10px; + color: var(--cic-muted); + margin-top: 4px; } } diff --git a/src/app/credit-bureau/cic-static.service.ts b/src/app/credit-bureau/cic-static.service.ts new file mode 100644 index 000000000..99465d633 --- /dev/null +++ b/src/app/credit-bureau/cic-static.service.ts @@ -0,0 +1,1270 @@ +/** + * Copyright since 2025 Mifos Initiative + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +import { Injectable } from '@angular/core'; +import { Observable, delay, of, throwError } from 'rxjs'; + +import { + CicAlert, + CicBureau, + CicCatalog, + CicEndpoint, + CicFetchRun, + CicMapping, + CicPage, + CicService +} from './cic.service'; + +/** + * Static (in-memory) stand-in for the backend, so the Credit Bureau screens can be shown without any API call. + * Everything works inside the session - whitelisting, configuring, fetching, working an alert - and resets on reload. + * + * To go back to the real backend, remove the `{ provide: CicService, useClass: CicStaticService }` line from + * CreditBureauModule. + */ + +const DAY = 86_400_000; +const LATENCY = 250; + +function iso(d: Date): string { + return d.toISOString().slice(0, 10); +} + +function daysAgo(n: number): string { + return iso(new Date(Date.now() - n * DAY)); +} + +function stamp(n: number, hour: number, minute: number): string { + return `${daysAgo(n)}T${String(hour).padStart(2, '0')}:${String(minute).padStart(2, '0')}:00`; +} + +/** Small deterministic generator, so the demo data is the same on every load. */ +function rng(seed: number): () => number { + let s = seed; + return () => { + s = (s * 1664525 + 1013904223) % 4294967296; + return s / 4294967296; + }; +} + +/** + * "Our customers" are this system's own clients (same ids, names, account numbers and branch as in the CBS), so the + * links to their profiles work and no made-up bank or branch name is shown. Only their PANs are sample values. + */ +const OWN_BRANCH = 'Head Office'; +const CUSTOMERS = [ + { id: 2, name: 'Shri Santosh Iyer', acc: '000000002', office: OWN_BRANCH, pan: 'ABXPS4421K' }, + { id: 3, name: 'Ms. Priya Verma', acc: '000000003', office: OWN_BRANCH, pan: 'BCDPV8812L' }, + { id: 4, name: 'Mr. Sanket Raghuwanshi', acc: '000000004', office: OWN_BRANCH, pan: 'CDEPR3345M' }, + { id: 5, name: 'Ms. Sneha Iyer', acc: '000000005', office: OWN_BRANCH, pan: 'DEFPI7790N' }, + { id: 6, name: 'Mr. Karan Singh', acc: '000000006', office: OWN_BRANCH, pan: 'EFGPS1156P' }, + { id: 7, name: 'Mr. Anshul Rathore', acc: '000000007', office: OWN_BRANCH, pan: 'FGHPR6623Q' } +]; + +/** The demo plan below was laid out for 12 people; each slot is one of the six real customers. */ +const SLOT_TO_CUSTOMER: Record = { + 101: 3, + 102: 5, + 103: 6, + 104: 7, + 105: 3, + 106: 5, + 107: 4, + 108: 6, + 109: 2, + 110: 7, + 111: 3, + 112: 5 +}; + +const LOAN_TYPES: [string, number, number][] = [ + [ + 'Personal Loan', + 50_000, + 1_000_000 + ], + [ + 'Housing Loan', + 800_000, + 6_000_000 + ], + [ + 'Auto Loan', + 300_000, + 1_500_000 + ], + [ + 'Two-Wheeler Loan', + 50_000, + 200_000 + ], + [ + 'Gold Loan', + 20_000, + 500_000 + ], + [ + 'Business Loan', + 200_000, + 5_000_000 + ], + [ + 'Credit Card', + 25_000, + 300_000 + ], + [ + 'Kisan Credit Card', + 50_000, + 300_000 + ], + [ + 'Education Loan', + 200_000, + 2_000_000 + ], + [ + 'Loan Against Property', + 500_000, + 5_000_000 + ] +]; + +const PLACES = [ + 'Bhopal', + 'Indore', + 'Vidisha', + 'Sagar', + 'Jabalpur', + 'Gwalior', + 'Basoda', + 'Raisen' +]; + +const MY_LOANS: Record = { + 3: [ + { + id: 9001, + accountNo: '000900001', + productName: 'Gold Loan', + status: 'ACTIVE', + principal: 150000, + outstanding: 112500, + disbursedOn: daysAgo(210) + } + ], + 5: [ + { + id: 9002, + accountNo: '000900002', + productName: 'Agriculture Loan', + status: 'ACTIVE', + principal: 300000, + outstanding: 241000, + disbursedOn: daysAgo(400) + } + ], + 7: [ + { + id: 9003, + accountNo: '000900003', + productName: 'Personal Loan', + status: 'ACTIVE', + principal: 200000, + outstanding: 88000, + disbursedOn: daysAgo(540) + } + ], + 4: [ + { + id: 9004, + accountNo: '000900004', + productName: 'Business Loan', + status: 'ACTIVE', + principal: 500000, + outstanding: 410000, + disbursedOn: daysAgo(150) + }, + { + id: 9005, + accountNo: '000900005', + productName: 'Gold Loan', + status: 'ACTIVE', + principal: 80000, + outstanding: 80000, + disbursedOn: daysAgo(40) + } + ], + 2: [ + { + id: 9006, + accountNo: '000900006', + productName: 'Housing Loan', + status: 'ACTIVE', + principal: 1800000, + outstanding: 1525000, + disbursedOn: daysAgo(900) + } + ] +}; + +function buildAlerts(): CicAlert[] { + const r = rng(20260905); + const out: CicAlert[] = []; + let id = 1; + // Day 0 (today) .. 59 days back; heavier near today. Customers 107 and 109 are shopping at several lenders. + const plan: { day: number; cust: number; unmatched?: boolean }[] = [ + { day: 0, cust: 107 }, + { day: 0, cust: 103 }, + { day: 0, cust: 110 }, + { day: 1, cust: 107 }, + { day: 1, cust: 101 }, + { day: 1, cust: 105 }, + { day: 2, cust: 109 }, + { day: 2, cust: 102 }, + { day: 2, cust: 0, unmatched: true }, + { day: 3, cust: 107 }, + { day: 3, cust: 104 }, + { day: 4, cust: 109 }, + { day: 4, cust: 106 }, + { day: 5, cust: 112 }, + { day: 5, cust: 101 }, + { day: 6, cust: 108 }, + { day: 6, cust: 103 }, + { day: 7, cust: 109 }, + { day: 8, cust: 111 }, + { day: 8, cust: 0, unmatched: true }, + { day: 9, cust: 105 }, + { day: 10, cust: 110 }, + { day: 11, cust: 104 }, + { day: 12, cust: 102 }, + { day: 13, cust: 107 }, + { day: 14, cust: 106 }, + { day: 15, cust: 112 }, + { day: 16, cust: 0, unmatched: true }, + { day: 18, cust: 108 }, + { day: 19, cust: 101 }, + { day: 21, cust: 111 }, + { day: 23, cust: 109 }, + { day: 25, cust: 103 }, + { day: 27, cust: 110 }, + { day: 29, cust: 105 }, + { day: 33, cust: 0, unmatched: true }, + { day: 36, cust: 102 }, + { day: 41, cust: 106 }, + { day: 47, cust: 104 }, + { day: 54, cust: 112 } + ]; + const unmatchedNames = [ + 'Vijay Kumar Soni', + 'Neha Choudhary', + 'Arvind Tiwari', + 'Geeta Bai Lodhi' + ]; + let u = 0; + for (const p of plan) { + const lt = LOAN_TYPES[Math.floor(r() * LOAN_TYPES.length)]; + const amount = Math.round((lt[1] + r() * (lt[2] - lt[1])) / 5000) * 5000; + const c = p.unmatched ? null : CUSTOMERS.find((x) => x.id === SLOT_TO_CUSTOMER[p.cust])!; + const bureau = [ + 'CIBIL', + 'CIBIL', + 'EXPERIAN', + 'EQUIFAX', + 'CRIF' + ][Math.floor(r() * 5)]; + const unmatchedName = unmatchedNames[u % unmatchedNames.length]; + const pan = c ? c.pan : `ZZZPZ${1000 + Math.floor(r() * 8999)}Z`; + const masked = pan.slice(0, 2) + '******' + pan.slice(-2); + const daysOld = p.day; + // Recent alerts are still new; older ones have been worked. + let status: CicAlert['status'] = + daysOld <= 3 ? 'NEW' : daysOld <= 9 ? (r() < 0.5 ? 'SEEN' : 'NEW') : r() < 0.6 ? 'ACTIONED' : 'SEEN'; + let remarks: string | undefined; + let actionedByName: string | undefined; + let actionedOn: string | undefined; + if (status === 'ACTIONED') { + remarks = [ + 'Customer called; offered a top-up on the existing loan at a lower rate.', + 'Visited the branch; will continue with us after document review.', + 'Customer confirmed the enquiry; no action needed.' + ][Math.floor(r() * 3)]; + actionedByName = 'Branch Manager'; + actionedOn = stamp(Math.max(0, daysOld - 1), 11, 20); + } else if (status === 'SEEN') { + actionedByName = 'Credit Officer'; + actionedOn = stamp(Math.max(0, daysOld - 1), 15, 5); + } + if (p.unmatched) { + status = daysOld > 20 ? 'DISMISSED' : status === 'ACTIONED' ? 'SEEN' : status; + if (status === 'DISMISSED') { + remarks = 'Not our customer — PAN does not exist in our KYC.'; + actionedByName = 'Credit Officer'; + actionedOn = stamp(daysOld - 1, 12, 0); + } + } + const a: CicAlert = { + id: id++, + bureauId: [ + 'CIBIL', + 'EXPERIAN', + 'EQUIFAX', + 'CRIF' + ].indexOf(bureau) + 1, + bureauCode: bureau, + alertKey: `${bureau}-${daysAgo(daysOld).replace(/-/g, '')}-${id - 1}`, + clientId: c?.id, + clientName: c?.name, + clientAccountNo: c?.acc, + officeName: c?.office, + matchType: c ? 'PAN' : 'NONE', + customerName: (c ? c.name : unmatchedName).toUpperCase(), + panMasked: masked, + enquiryDate: daysAgo(daysOld), + loanType: lt[0], + amount, + purpose: r() < 0.2 ? 'Loan renewal / enhancement' : 'New loan application', + location: PLACES[Math.floor(r() * PLACES.length)], + status, + remarks, + actionedByName, + actionedOn, + receivedVia: 'SIMULATOR', + receivedOn: stamp(daysOld, 6 + Math.floor(r() * 12), Math.floor(r() * 60)) + }; + if (!c) u++; + out.push(a); + } + // A couple matched by Aadhaar / customer reference, for variety. + out[5].matchType = 'AADHAAR'; + out[5].panMasked = undefined; + out[5].aadhaarMasked = 'XXXX-XXXX-4821'; + out[13].matchType = 'CUSTOMER_REF'; + out[13].panMasked = undefined; + out[13].customerRef = out[13].clientAccountNo; + return out; +} + +function buildBureaus(): CicBureau[] { + const base = ( + id: number, + code: string, + name: string, + whitelisted: boolean, + isDefault: boolean, + lastFetchOn: string | undefined, + lastFetchStatus: string | undefined, + lastFetchMessage: string | undefined + ): CicBureau => ({ + id, + code, + name, + description: `${name} - consumer credit information and enquiry alerts`, + whitelisted, + isDefault, + environment: 'SIMULATOR', + baseUrl: undefined, + memberCode: whitelisted ? 'MH00123456' : undefined, + authType: 'NONE', + username: undefined, + apiKeyHeader: 'X-API-KEY', + hasSecret: false, + tokenUrl: undefined, + clientId: undefined, + timeoutMs: 30000, + alertAutoFetch: true, + alertFetchIntervalMin: 60, + alertLookbackDays: 7, + lastFetchOn, + lastFetchStatus, + lastFetchMessage, + lastTestStatus: whitelisted ? 'OK' : undefined, + lastTestMessage: whitelisted + ? 'Simulator mode - no network call is made; alerts are answered by the built-in simulator.' + : undefined, + lastTestedOn: whitelisted ? stamp(2, 10, 12) : undefined, + updatedOn: stamp(2, 10, 10), + activeEndpoints: 1, + alertsLast30Days: 0, + newAlerts: 0 + }); + return [ + base( + 1, + 'CIBIL', + 'TransUnion CIBIL', + true, + true, + stamp(0, 9, 5), + 'SUCCESS', + '6 received, 3 new (3 matched to customers, 0 unmatched), 3 already on record, 0 by this bank itself.' + ), + base( + 2, + 'EXPERIAN', + 'Experian Credit Information Company of India', + true, + false, + stamp(0, 9, 7), + 'SUCCESS', + '2 received, 1 new (1 matched to customers, 0 unmatched), 1 already on record, 0 by this bank itself.' + ), + base(3, 'EQUIFAX', 'Equifax Credit Information Services', false, false, undefined, undefined, undefined), + base(4, 'CRIF', 'CRIF High Mark Credit Information Services', false, false, undefined, undefined, undefined) + ]; +} + +const REQUEST_ROWS: [string | null, string, string, string | null, boolean][] = [ + [ + 'bureau.memberCode', + 'requestHeader.memberCode', + 'NONE', + null, + false + ], + [ + 'fetch.reference', + 'requestHeader.referenceNumber', + 'NONE', + null, + true + ], + [ + 'fetch.fromDate', + 'criteria.fromDate', + 'DATE_DDMMYYYY', + null, + true + ], + [ + 'fetch.toDate', + 'criteria.toDate', + 'DATE_DDMMYYYY', + null, + true + ], + [ + null, + 'criteria.scope', + 'NONE', + 'OTHER_MEMBERS', + false + ] +]; + +const RESPONSE_ROWS: [string, string, string][] = [ + [ + 'responseHeader.errorCode', + 'errorCode', + 'NONE' + ], + [ + 'responseHeader.errorMessage', + 'errorMessage', + 'NONE' + ], + [ + 'data.alerts', + 'alerts', + 'NONE' + ], + [ + 'alertId', + 'alertRef', + 'NONE' + ], + [ + 'consumer.pan', + 'pan', + 'UPPER' + ], + [ + 'consumer.aadhaar', + 'aadhaar', + 'NONE' + ], + [ + 'consumer.name', + 'customerName', + 'UPPER' + ], + [ + 'consumer.dateOfBirth', + 'dateOfBirth', + 'DATE_DDMMYYYY' + ], + [ + 'consumer.memberReference', + 'customerRef', + 'NONE' + ], + [ + 'enquiry.date', + 'enquiryDate', + 'DATE_DDMMYYYY' + ], + [ + 'enquiry.productType', + 'loanType', + 'NONE' + ], + [ + 'enquiry.amount', + 'amount', + 'NUMBER' + ], + [ + 'enquiry.purpose', + 'purpose', + 'NONE' + ], + [ + 'enquiry.location', + 'location', + 'NONE' + ] +]; + +function buildEndpoint(bureauId: number): CicEndpoint { + return { + bureauId, + endpointType: 'ENQUIRY_ALERT', + exists: true, + id: bureauId, + httpMethod: 'POST', + path: '/monitoring/enquiry-alerts', + contentType: 'application/json', + headersJson: JSON.stringify({ + Accept: 'application/json', + 'X-Member-Code': '{{bureau.memberCode}}', + 'X-Request-Id': '{{fetch.reference}}' + }), + baseBody: JSON.stringify({ requestHeader: { product: 'ENQUIRY_ALERT', version: '1.0' }, criteria: {} }), + isActive: true, + requestMappings: REQUEST_ROWS.map( + ([ + sourceField, + targetField, + transform, + defaultValue, + mandatory + ], i) => ({ + id: bureauId * 100 + i, + sourceField, + targetField, + transform, + defaultValue, + mandatory, + sortOrder: (i + 1) * 10 + }) + ), + responseMappings: RESPONSE_ROWS.map( + ([ + sourceField, + targetField, + transform + ], i) => ({ + id: bureauId * 1000 + i, + sourceField, + targetField, + transform, + defaultValue: null as string | null, + mandatory: false, + sortOrder: (i + 1) * 10 + }) + ) + }; +} + +function fail(message: string): Observable { + return throwError(() => ({ error: { defaultUserMessage: message } })); +} + +function reply(value: T): Observable { + // A copy, so a screen editing what it got never changes the "database". + return of(JSON.parse(JSON.stringify(value)) as T).pipe(delay(LATENCY)); +} + +@Injectable() +export class CicStaticService extends CicService { + private bureauList = buildBureaus(); + private alertList = buildAlerts(); + private endpoints = new Map( + [ + 1, + 2, + 3, + 4 + ].map((i) => [ + i, + buildEndpoint(i) + ]) + ); + private runList: CicFetchRun[] = []; + private nextAlertId = 1000; + private nextRunId = 1; + + constructor() { + super(); + this.runList = [ + this.makeRun(1, 'SCHEDULED', 0, 9, 5, 6, 3, 3, 0, 3, 0, 'SUCCESS'), + this.makeRun(2, 'SCHEDULED', 0, 9, 7, 2, 1, 1, 0, 1, 0, 'SUCCESS'), + this.makeRun(1, 'SCHEDULED', 0, 8, 5, 4, 2, 2, 0, 2, 0, 'SUCCESS'), + this.makeRun(1, 'MANUAL', 1, 17, 40, 9, 5, 4, 1, 4, 0, 'SUCCESS'), + this.makeRun(2, 'SCHEDULED', 1, 9, 7, 0, 0, 0, 0, 0, 0, 'SUCCESS'), + this.makeRun( + 1, + 'SCHEDULED', + 2, + 9, + 5, + 0, + 0, + 0, + 0, + 0, + 0, + 'FAILED', + 'Bureau not reachable: connect timed out (simulated failure).' + ) + ]; + this.refreshCounts(); + } + + private makeRun( + bureauId: number, + trigger: CicFetchRun['trigger'], + day: number, + hour: number, + minute: number, + received: number, + newAlerts: number, + matched: number, + unmatched: number, + duplicates: number, + ownBank: number, + status: CicFetchRun['status'], + message?: string + ): CicFetchRun { + const id = this.nextRunId++; + const code = this.bureauList.find((b) => b.id === bureauId)!.code; + return { + id, + runRef: `CICF${daysAgo(day).replace(/-/g, '').slice(2)}${String(id).padStart(6, '0')}`, + bureauId, + bureauCode: code, + trigger, + environment: 'SIMULATOR', + fromDate: daysAgo(day + 7), + toDate: daysAgo(day), + status, + httpStatus: status === 'SUCCESS' ? 200 : undefined, + received, + newAlerts, + matched, + unmatched, + duplicates, + ownBank, + message: + message ?? + `${received} received, ${newAlerts} new (${matched} matched to customers, ${unmatched} unmatched), ${duplicates} already on record, ${ownBank} by this bank itself.`, + durationMs: 180 + id * 37, + triggeredByName: trigger === 'MANUAL' ? 'Branch Manager' : 'SYSTEM (scheduled)', + startedOn: stamp(day, hour, minute), + request: JSON.stringify({ + method: 'POST', + url: '(simulator)', + headers: { Accept: 'application/json', 'X-Member-Code': 'MH00123456', 'X-Request-Id': `CICF${id}` }, + body: { + requestHeader: { + product: 'ENQUIRY_ALERT', + version: '1.0', + memberCode: 'MH00123456', + referenceNumber: `CICF${id}` + }, + criteria: { + fromDate: daysAgo(day + 7) + .split('-') + .reverse() + .join(''), + toDate: daysAgo(day).split('-').reverse().join(''), + scope: 'OTHER_MEMBERS' + } + } + }), + response: JSON.stringify({ + responseHeader: { status: status === 'SUCCESS' ? 'SUCCESS' : 'ERROR' }, + data: { totalAlerts: received, alerts: '[...]' } + }) + }; + } + + private refreshCounts(): void { + const since = Date.now() - 30 * DAY; + for (const b of this.bureauList) { + b.alertsLast30Days = this.alertList.filter( + (a) => a.bureauId === b.id && new Date(a.receivedOn ?? '').getTime() >= since + ).length; + b.newAlerts = this.alertList.filter((a) => a.bureauId === b.id && a.status === 'NEW').length; + } + } + + private requireAlert(id: number): CicAlert | null { + return this.alertList.find((a) => a.id === id) ?? null; + } + + // ── catalog / bureaus ── + + override catalog(): Observable { + return reply({ + environments: [ + 'SIMULATOR', + 'UAT', + 'PRODUCTION' + ], + authTypes: [ + 'NONE', + 'BASIC', + 'API_KEY', + 'BEARER_TOKEN', + 'OAUTH2_CLIENT_CREDENTIALS' + ], + endpointTypes: ['ENQUIRY_ALERT'], + httpMethods: [ + 'POST', + 'PUT', + 'GET' + ], + cbsFields: { + 'fetch.reference': 'Fetch reference number', + 'fetch.fromDate': 'Alerts from date', + 'fetch.toDate': 'Alerts to date', + 'fetch.date': 'Request date (business date)', + 'bureau.memberCode': "Bank's member code at the bureau", + 'bureau.username': 'Bureau user id' + }, + resultFields: { + alerts: 'List of alerts (array) - root', + errorCode: 'Bureau error code - root', + errorMessage: 'Bureau error message - root', + alertRef: 'Alert / enquiry id at the bureau', + pan: 'Customer PAN', + aadhaar: 'Customer Aadhaar (masked or last 4)', + customerName: 'Customer name', + dateOfBirth: 'Customer date of birth', + customerRef: 'Our customer reference (CIF / account no) reported to the bureau', + enquiryDate: 'Enquiry date', + loanType: 'Loan type applied for', + amount: 'Loan amount applied for', + purpose: 'Enquiry purpose', + location: 'Branch / city of the enquiry' + }, + rootFields: [ + 'alerts', + 'errorCode', + 'errorMessage' + ], + transforms: { + NONE: 'As is', + UPPER: 'UPPER CASE', + LOWER: 'lower case', + TRIM: 'Trim spaces', + DIGITS_ONLY: 'Digits only', + DATE_DDMMYYYY: 'Date ddMMyyyy', + DATE_DD_MM_YYYY: 'Date dd-MM-yyyy', + DATE_DD_SLASH_MM_YYYY: 'Date dd/MM/yyyy', + DATE_YYYY_MM_DD: 'Date yyyy-MM-dd', + AMOUNT_INTEGER: 'Amount, whole rupees', + NUMBER: 'Number', + BOOLEAN: 'true / false' + }, + alertStatuses: [ + 'NEW', + 'SEEN', + 'ACTIONED', + 'DISMISSED' + ], + matchTypes: [ + 'PAN', + 'AADHAAR', + 'CUSTOMER_REF', + 'MANUAL', + 'NONE' + ] + }); + } + + override bureaus(whitelistedOnly = false): Observable { + this.refreshCounts(); + return reply(this.bureauList.filter((b) => !whitelistedOnly || b.whitelisted)); + } + + override updateBureau(id: number, body: any): Observable { + const b = this.bureauList.find((x) => x.id === id); + if (!b) return fail('Credit bureau was not found.'); + const environment = body.environment ?? b.environment; + const baseUrl = (body.baseUrl ?? b.baseUrl ?? '').trim() || undefined; + if (baseUrl && !/^https?:\/\//.test(baseUrl)) + return fail('Base URL must start with https:// (or http:// for a test server).'); + if (environment === 'PRODUCTION' && baseUrl && !baseUrl.startsWith('https://')) + return fail('A PRODUCTION bureau must be reached over https://.'); + const interval = Number(body.alertFetchIntervalMin ?? b.alertFetchIntervalMin); + if (interval < 15 || interval > 1440) + return fail('Automatic fetch interval must be between 15 minutes and 24 hours (1440).'); + const lookback = Number(body.alertLookbackDays ?? b.alertLookbackDays); + if (lookback < 1 || lookback > 90) return fail('Look-back window must be between 1 and 90 days.'); + const timeout = Number(body.timeoutMs ?? b.timeoutMs); + if (timeout < 1000 || timeout > 300000) return fail('Timeout must be between 1,000 and 300,000 milliseconds.'); + if (body.isDefault) this.bureauList.forEach((x) => (x.isDefault = false)); + Object.assign(b, { + name: body.name || b.name, + description: body.description ?? b.description, + environment, + baseUrl, + memberCode: (body.memberCode ?? b.memberCode ?? '').trim() || undefined, + authType: body.authType ?? b.authType, + username: (body.username ?? b.username ?? '').trim() || undefined, + apiKeyHeader: body.apiKeyHeader || b.apiKeyHeader, + tokenUrl: (body.tokenUrl ?? b.tokenUrl ?? '').trim() || undefined, + clientId: (body.clientId ?? b.clientId ?? '').trim() || undefined, + timeoutMs: timeout, + alertAutoFetch: !!(body.alertAutoFetch ?? b.alertAutoFetch), + alertFetchIntervalMin: interval, + alertLookbackDays: lookback, + isDefault: !!body.isDefault || b.isDefault, + updatedOn: new Date().toISOString().slice(0, 19) + }); + if (body.clearSecret) b.hasSecret = false; + else if (body.secret) b.hasSecret = true; + return reply(b); + } + + override setWhitelisted(id: number, whitelisted: boolean): Observable { + const b = this.bureauList.find((x) => x.id === id); + if (!b) return fail('Credit bureau was not found.'); + if (whitelisted && b.environment !== 'SIMULATOR') { + if (!b.baseUrl) return fail(`${b.code} has no base URL for ${b.environment}.`); + if (b.authType !== 'NONE' && !b.hasSecret) + return fail(`${b.code} uses ${b.authType} but no password / key / secret is stored.`); + } + b.whitelisted = whitelisted; + return reply(b); + } + + override testConnection(id: number): Observable<{ status: string; message: string }> { + const b = this.bureauList.find((x) => x.id === id); + if (!b) return fail('Credit bureau was not found.'); + let status = 'OK'; + let message = 'Simulator mode - no network call is made; alerts are answered by the built-in simulator.'; + if (b.environment !== 'SIMULATOR') { + if (!b.baseUrl) { + status = 'FAILED'; + message = 'No base URL configured.'; + } else { + message = 'Reachable (HTTP 200 in 312 ms).'; + } + } + b.lastTestStatus = status; + b.lastTestMessage = message; + b.lastTestedOn = new Date().toISOString().slice(0, 19); + return reply({ status, message }); + } + + // ── API mapping ── + + override endpoint(bureauId: number, _type: string): Observable { + const e = this.endpoints.get(bureauId); + return e ? reply(e) : fail('Credit bureau was not found.'); + } + + override saveEndpoint(bureauId: number, _type: string, body: any): Observable { + const current = this.endpoints.get(bureauId); + if (!current) return fail('Credit bureau was not found.'); + const request: CicMapping[] = body.requestMappings ?? []; + const response: CicMapping[] = body.responseMappings ?? []; + if (body.isActive && !request.length) return fail('An active endpoint needs at least one REQUEST mapping.'); + if (body.isActive && !response.some((r) => r.targetField === 'alerts')) { + return fail( + "Map the response path of the alert list to the result field 'alerts' (e.g. data.alerts), or the alerts cannot be read." + ); + } + for (const r of request) { + if (!r.targetField) return fail('REQUEST: the target field is required.'); + if (!r.sourceField && !r.defaultValue) + return fail(`REQUEST (${r.targetField}): choose a CBS value or give a fixed value.`); + } + for (const r of response) { + if (!r.sourceField) return fail(`RESPONSE (${r.targetField}): the bureau response path is missing.`); + if (!/^[A-Za-z][A-Za-z0-9_]*$/.test(r.targetField)) + return fail(`RESPONSE: result field '${r.targetField}' must be a simple name.`); + } + const saved: CicEndpoint = { + ...current, + httpMethod: body.httpMethod, + path: body.path, + contentType: body.contentType, + headersJson: body.headersJson, + baseBody: body.baseBody, + isActive: body.isActive, + requestMappings: request.map((r, i) => ({ ...r, id: bureauId * 100 + i })), + responseMappings: response.map((r, i) => ({ ...r, id: bureauId * 1000 + i })) + }; + this.endpoints.set(bureauId, saved); + return reply(saved); + } + + override preview(bureauId: number, body: { fromDate?: string; toDate?: string }): Observable { + const b = this.bureauList.find((x) => x.id === bureauId); + const e = this.endpoints.get(bureauId); + if (!b || !e) return fail('Credit bureau was not found.'); + const to = body.toDate || daysAgo(0); + const from = body.fromDate || iso(new Date(new Date(to).getTime() - b.alertLookbackDays * DAY)); + const ddmmyyyy = (s: string) => s.split('-').reverse().join(''); + const requestBody: any = { + requestHeader: { + product: 'ENQUIRY_ALERT', + version: '1.0', + memberCode: b.memberCode ?? '', + referenceNumber: 'PREVIEW-1' + }, + criteria: { fromDate: ddmmyyyy(from), toDate: ddmmyyyy(to), scope: 'OTHER_MEMBERS' } + }; + const missing: string[] = []; + if (!b.memberCode) missing.push("Bank's member code at the bureau (requestHeader.memberCode)"); + return reply({ + environment: b.environment, + url: b.environment === 'SIMULATOR' ? '(simulator - no network call)' : `${b.baseUrl ?? ''}${e.path ?? ''}`, + method: e.httpMethod, + headers: { Accept: 'application/json', 'X-Member-Code': b.memberCode ?? '', 'X-Request-Id': 'PREVIEW-1' }, + authentication: b.authType, + body: JSON.stringify(requestBody), + fromDate: from, + toDate: to, + missingMandatory: b.memberCode ? [] : missing + }); + } + + override parseTest(bureauId: number, content: string | null): Observable { + if (!this.endpoints.get(bureauId)) return fail('Credit bureau was not found.'); + let sample = content; + if (!sample || !sample.trim()) { + sample = JSON.stringify( + { + responseHeader: { status: 'SUCCESS', referenceNumber: 'SAMPLE' }, + data: { + totalAlerts: 3, + alerts: [ + { + alertId: 'CIBIL-SAMPLE-1', + consumer: { name: 'SHRI SANTOSH IYER', pan: 'ABXPS4421K', dateOfBirth: '14031985' }, + enquiry: { + date: daysAgo(1).split('-').reverse().join(''), + productType: 'PERSONAL LOAN', + amount: 450000, + purpose: 'NEW LOAN APPLICATION', + location: 'BHOPAL' + } + }, + { + alertId: 'CIBIL-SAMPLE-2', + consumer: { name: 'MR. SANKET RAGHUWANSHI', pan: 'CDEPR3345M', dateOfBirth: '02111990' }, + enquiry: { + date: daysAgo(0).split('-').reverse().join(''), + productType: 'BUSINESS LOAN', + amount: 1200000, + purpose: 'NEW LOAN APPLICATION', + location: 'INDORE' + } + }, + { + alertId: 'CIBIL-SAMPLE-3', + consumer: { name: 'UNKNOWN PERSON', pan: 'ZZZPZ1234Z' }, + enquiry: { + date: daysAgo(2).split('-').reverse().join(''), + productType: 'HOUSING LOAN', + amount: 3500000, + purpose: 'NEW LOAN APPLICATION', + location: 'SAGAR' + } + } + ] + } + }, + null, + 2 + ); + } + let parsed: any; + try { + parsed = JSON.parse(sample); + } catch (e: any) { + return fail(`The sample response is not valid JSON: ${e?.message ?? e}`); + } + const list: any[] = parsed?.data?.alerts ?? (Array.isArray(parsed) ? parsed : []); + const items = list.map((x: any) => { + const pan: string | undefined = x?.consumer?.pan; + const c = pan ? CUSTOMERS.find((k) => k.pan === pan) : undefined; + return { + alertRef: x?.alertId, + customerName: x?.consumer?.name, + pan: pan ? pan.slice(0, 2) + '******' + pan.slice(-2) : undefined, + enquiryDate: x?.enquiry?.date, + loanType: x?.enquiry?.productType, + amount: x?.enquiry?.amount, + ownBank: false, + matchType: c ? 'PAN' : 'NONE', + clientId: c?.id ?? null, + clientName: c?.name ?? null + }; + }); + return reply({ + usedSample: !content || !content.trim(), + errorCode: parsed?.responseHeader?.errorCode ?? null, + errorMessage: parsed?.responseHeader?.errorMessage ?? null, + alertListFound: Array.isArray(parsed?.data?.alerts) || Array.isArray(parsed), + count: items.length, + items, + sampleResponse: !content || !content.trim() ? sample : undefined + }); + } + + // ── fetch / import ── + + override fetch(bureauId: number, _body: { fromDate?: string; toDate?: string } = {}): Observable { + const b = this.bureauList.find((x) => x.id === bureauId); + if (!b) return fail('Credit bureau was not found.'); + if (!b.whitelisted) + return fail(`${b.code} is not whitelisted for this bank. Whitelist it under CIC Configuration first.`); + const now = new Date(); + const r = rng(now.getTime() % 100000); + const created: CicAlert[] = []; + const count = 1 + Math.floor(r() * 3); + for (let i = 0; i < count; i++) { + const c = CUSTOMERS[Math.floor(r() * CUSTOMERS.length)]; + const lt = LOAN_TYPES[Math.floor(r() * LOAN_TYPES.length)]; + const amount = Math.round((lt[1] + r() * (lt[2] - lt[1])) / 5000) * 5000; + const id = this.nextAlertId++; + created.push({ + id, + bureauId: b.id, + bureauCode: b.code, + alertKey: `${b.code}-${iso(now).replace(/-/g, '')}-${id}`, + clientId: c.id, + clientName: c.name, + clientAccountNo: c.acc, + officeName: c.office, + matchType: 'PAN', + customerName: c.name.toUpperCase(), + panMasked: c.pan.slice(0, 2) + '******' + c.pan.slice(-2), + enquiryDate: iso(now), + loanType: lt[0], + amount, + purpose: 'New loan application', + location: PLACES[Math.floor(r() * PLACES.length)], + status: 'NEW', + receivedVia: 'SIMULATOR', + receivedOn: now.toISOString().slice(0, 19) + }); + } + this.alertList = [ + ...created, + ...this.alertList + ]; + const run = this.makeRun( + b.id, + 'MANUAL', + 0, + now.getHours(), + now.getMinutes(), + count + 2, + count, + count, + 0, + 2, + 0, + 'SUCCESS' + ); + run.startedOn = now.toISOString().slice(0, 19); + run.triggeredByName = 'You'; + this.runList = [ + run, + ...this.runList + ]; + b.lastFetchOn = run.startedOn; + b.lastFetchStatus = 'SUCCESS'; + b.lastFetchMessage = run.message; + this.refreshCounts(); + return reply(run); + } + + override fetchRuns(filter: Record): Observable> { + const bureauId = filter['bureauId'] ? Number(filter['bureauId']) : null; + const rows = this.runList.filter((r) => !bureauId || r.bureauId === bureauId); + const offset = Number(filter['offset'] ?? 0); + const limit = Number(filter['limit'] ?? 20); + return reply({ totalFilteredRecords: rows.length, pageItems: rows.slice(offset, offset + limit) }); + } + + override fetchRun(id: number): Observable { + const r = this.runList.find((x) => x.id === id); + return r ? reply(r) : fail('Fetch run was not found.'); + } + + // ── alerts ── + + override alert(id: number): Observable { + const a = this.requireAlert(id); + if (!a) return fail('Alert was not found.'); + const detail: CicAlert = { + ...a, + raw: { + alertId: a.alertKey, + consumer: { name: a.customerName, pan: a.panMasked, aadhaar: a.aadhaarMasked }, + enquiry: { + date: a.enquiryDate, + productType: a.loanType, + amount: a.amount, + purpose: a.purpose, + location: a.location + } + }, + otherAlertsOfCustomer: a.clientId + ? this.alertList + .filter((x) => x.clientId === a.clientId && x.id !== a.id) + .sort((x, y) => (y.enquiryDate ?? '').localeCompare(x.enquiryDate ?? '')) + .slice(0, 20) + : [], + clientLoans: a.clientId ? (MY_LOANS[a.clientId] ?? []) : undefined + }; + return reply(detail); + } + + override updateStatus(id: number, status: string, remarks?: string | null): Observable { + const a = this.requireAlert(id); + if (!a) return fail('Alert was not found.'); + if ((status === 'ACTIONED' || status === 'DISMISSED') && !remarks?.trim()) { + return fail('Write what was done (e.g. customer contacted, retention offer made) or why it is dismissed.'); + } + a.status = status as CicAlert['status']; + if (remarks?.trim()) a.remarks = remarks.trim(); + a.actionedByName = 'You'; + a.actionedOn = new Date().toISOString().slice(0, 19); + this.refreshCounts(); + return this.alert(id); + } + + override linkClient(id: number, clientId: number): Observable { + const a = this.requireAlert(id); + if (!a) return fail('Alert was not found.'); + // The search dialog returns the real customer; for the static demo we link to whoever was chosen. + const known = CUSTOMERS.find((c) => c.id === clientId); + a.clientId = clientId; + a.clientName = known?.name ?? `Customer #${clientId}`; + a.clientAccountNo = known?.acc ?? String(clientId).padStart(9, '0'); + a.officeName = known?.office ?? OWN_BRANCH; + a.matchType = 'MANUAL'; + this.refreshCounts(); + return this.alert(id); + } + + // ── dashboard ── + + override dashboard(days = 30): Observable { + const today = daysAgo(0); + const since = daysAgo(days - 1); + const matched = this.alertList.filter((a) => a.clientId); + const inPeriod = matched.filter((a) => (a.enquiryDate ?? '') >= since); + const group = (key: keyof CicAlert, limit: number) => { + const m = new Map(); + for (const a of inPeriod) { + const label = String(a[key] ?? 'Not given'); + const e = m.get(label) ?? { label, count: 0, amount: 0 }; + e.count++; + e.amount += Number(a.amount ?? 0); + m.set(label, e); + } + return [...m.values()].sort((x, y) => y.count - x.count).slice(0, limit); + }; + + const trend = []; + for (let i = 13; i >= 0; i--) { + const d = daysAgo(i); + const rows = matched.filter((a) => a.enquiryDate === d); + trend.push({ date: d, count: rows.length, amount: rows.reduce((s, a) => s + Number(a.amount ?? 0), 0) }); + } + + const perClient = new Map(); + for (const a of inPeriod) + perClient.set(a.clientId!, [ + ...(perClient.get(a.clientId!) ?? []), + a + ]); + const repeatCustomers = [...perClient.entries()] + .filter( + ([ + , + rows + ]) => rows.length >= 2 + ) + .map( + ([ + clientId, + rows + ]) => ({ + clientId, + clientName: rows[0].clientName, + accountNo: rows[0].clientAccountNo, + alerts: rows.length, + amount: rows.reduce((s, r) => s + Number(r.amount ?? 0), 0), + lastEnquiryDate: rows + .map((r) => r.enquiryDate ?? '') + .sort() + .reverse()[0] + }) + ) + .sort((a, b) => b.alerts - a.alerts || b.amount - a.amount) + .slice(0, 10); + + const recent = [...matched] + .sort( + (a, b) => + Number(b.status === 'NEW') - Number(a.status === 'NEW') || + (b.enquiryDate ?? '').localeCompare(a.enquiryDate ?? '') || + b.id - a.id + ) + .slice(0, 15); + + return reply({ + days, + businessDate: today, + newAlerts: matched.filter((a) => a.status === 'NEW').length, + unmatchedOpen: this.alertList.filter((a) => !a.clientId && (a.status === 'NEW' || a.status === 'SEEN')).length, + receivedToday: this.alertList.filter((a) => (a.receivedOn ?? '').startsWith(today)).length, + alertsInPeriod: inPeriod.length, + amountInPeriod: inPeriod.reduce((s, a) => s + Number(a.amount ?? 0), 0), + customersInPeriod: perClient.size, + byLoanType: group('loanType', 12), + trend14Days: trend, + repeatCustomers, + recent, + bureaus: this.bureauList.map((b) => ({ + id: b.id, + code: b.code, + name: b.name, + whitelisted: b.whitelisted, + environment: b.environment, + isDefault: b.isDefault, + autoFetch: b.alertAutoFetch, + intervalMin: b.alertFetchIntervalMin, + lastFetchOn: b.lastFetchOn, + lastFetchStatus: b.lastFetchStatus, + lastFetchMessage: b.lastFetchMessage + })) + }); + } +} diff --git a/src/app/credit-bureau/cic.service.ts b/src/app/credit-bureau/cic.service.ts index 995ac8a1a..3da9ef565 100644 --- a/src/app/credit-bureau/cic.service.ts +++ b/src/app/credit-bureau/cic.service.ts @@ -30,14 +30,19 @@ export interface CicBureau { tokenUrl?: string; clientId?: string; timeoutMs: number; - reportValidityDays: number; - enquiryCharge: number; + alertAutoFetch: boolean; + alertFetchIntervalMin: number; + alertLookbackDays: number; + lastFetchOn?: string; + lastFetchStatus?: string; + lastFetchMessage?: string; lastTestStatus?: string; lastTestMessage?: string; lastTestedOn?: string; updatedOn?: string; activeEndpoints: number; - enquiriesLast30Days: number; + alertsLast30Days: number; + newAlerts: number; } export interface CicMapping { @@ -70,63 +75,78 @@ export interface CicCatalog { authTypes: string[]; endpointTypes: string[]; httpMethods: string[]; - consentModes: string[]; - purposes: Record; cbsFields: Record; resultFields: Record; + rootFields: string[]; transforms: Record; - defaultConsentText: string; + alertStatuses: string[]; + matchTypes: string[]; } -export interface CicConsent { +/** One enquiry made on our customer at another lender, as reported by the CIC. */ +export interface CicAlert { id: number; - consentRef: string; - clientId: number; - clientName: string; - applicationNo?: string; - bureauId?: number; - bureauCode: string; - purpose: string; - consentMode: string; - consentText?: string; - documentRef?: string; - otpReference?: string; - validFrom: string; - validUntil: string; - status: 'ACTIVE' | 'EXPIRED' | 'REVOKED'; - revokedReason?: string; - revokedOn?: string; - capturedByName?: string; - capturedOn?: string; - ipAddress?: string; -} - -export interface CicEnquiry { - id: number; - enquiryRef: string; bureauId: number; bureauCode: string; - bureauName?: string; - clientId: number; - clientName: string; - applicationNo?: string; - enquiryType: string; - purpose: string; - loanAmount: number; - status: 'SUCCESS' | 'NO_HIT' | 'FAILED' | 'REUSED'; - score?: number; - errorMessage?: string; - chargeAmount?: number; + alertKey: string; + clientId?: number; + clientName?: string; + clientAccountNo?: string; + officeId?: number; + officeName?: string; + matchType: 'PAN' | 'AADHAAR' | 'CUSTOMER_REF' | 'MANUAL' | 'NONE'; + customerName?: string; + panMasked?: string; + aadhaarMasked?: string; + customerRef?: string; + enquiryDate?: string; + loanType?: string; + amount?: number; + purpose?: string; + location?: string; + status: 'NEW' | 'SEEN' | 'ACTIONED' | 'DISMISSED'; + remarks?: string; + actionedByName?: string; + actionedOn?: string; + receivedVia?: string; + receivedOn?: string; + raw?: any; + fetchRunId?: number; + otherAlertsOfCustomer?: CicAlert[]; + clientLoans?: { + id: number; + accountNo: string; + productName: string; + status: string; + principal: number; + outstanding: number; + disbursedOn?: string; + }[]; +} + +export interface CicFetchRun { + id: number; + runRef: string; + bureauId: number; + bureauCode: string; + trigger: 'MANUAL' | 'SCHEDULED'; environment?: string; - requestedByName?: string; - requestedOn: string; - durationMs?: number; - consentRef?: string; - reusedFromRef?: string; + fromDate?: string; + toDate?: string; + status: 'RUNNING' | 'SUCCESS' | 'FAILED'; httpStatus?: number; - requestMasked?: string; - responseRaw?: string; - result?: any; + received: number; + newAlerts: number; + matched: number; + unmatched: number; + duplicates: number; + ownBank: number; + message?: string; + durationMs?: number; + triggeredByName?: string; + startedOn: string; + request?: string; + response?: string; } export interface CicPage { @@ -134,14 +154,16 @@ export interface CicPage { pageItems: T[]; } -/** Score band used everywhere a score is shown. */ -export function cicScoreBand(score: number | null | undefined): { label: string; tone: string } { - if (score === null || score === undefined) return { label: 'No score', tone: 'muted' }; - if (score >= 750) return { label: 'Excellent', tone: 'good' }; - if (score >= 700) return { label: 'Very good', tone: 'good' }; - if (score >= 650) return { label: 'Good', tone: 'ok' }; - if (score >= 550) return { label: 'Fair', tone: 'warn' }; - return { label: 'Poor', tone: 'bad' }; +export const CIC_MATCH_LABELS: Record = { + PAN: 'PAN', + AADHAAR: 'Aadhaar', + CUSTOMER_REF: 'Customer ref', + MANUAL: 'Linked manually', + NONE: 'Not matched' +}; + +export function cicStatusTone(status: string): string { + return status === 'NEW' ? 'bad' : status === 'SEEN' ? 'warn' : status === 'ACTIONED' ? 'good' : ''; } /** The server's own message for a failed call. */ @@ -197,45 +219,46 @@ export class CicService { return this.http.put(`${this.base}/bureaus/${bureauId}/endpoints/${type}`, body, this.silent); } - preview(bureauId: number, body: any): Observable { + preview(bureauId: number, body: { fromDate?: string; toDate?: string }): Observable { return this.http.post(`${this.base}/bureaus/${bureauId}/preview`, body, this.silent); } - clientProfile(clientId: number, bureauId?: number | null): Observable { - let params = new HttpParams(); - if (bureauId) params = params.set('bureauId', String(bureauId)); - return this.http.get(`${this.base}/clients/${clientId}/profile`, { ...this.silent, params }); + parseTest(bureauId: number, content: string | null): Observable { + return this.http.post(`${this.base}/bureaus/${bureauId}/parse-test`, { content }, this.silent); } - consents(filter: Record): Observable> { - return this.http.get>(`${this.base}/consents`, { ...this.silent, params: this.params(filter) }); + fetch(bureauId: number, body: { fromDate?: string; toDate?: string } = {}): Observable { + return this.http.post(`${this.base}/bureaus/${bureauId}/fetch`, body, this.silent); } - createConsent(body: any): Observable { - return this.http.post(`${this.base}/consents`, body, this.silent); - } - - revokeConsent(id: number, reason: string): Observable { - return this.http.post(`${this.base}/consents/${id}/revoke`, { reason }, this.silent); - } - - enquiries(filter: Record): Observable> { - return this.http.get>(`${this.base}/enquiries`, { + fetchRuns(filter: Record): Observable> { + return this.http.get>(`${this.base}/fetch-runs`, { ...this.silent, params: this.params(filter) }); } - enquiry(id: number): Observable { - return this.http.get(`${this.base}/enquiries/${id}`, this.silent); + fetchRun(id: number): Observable { + return this.http.get(`${this.base}/fetch-runs/${id}`, this.silent); } - enquire(body: any): Observable { - return this.http.post(`${this.base}/enquiries`, body, this.silent); + dashboard(days = 30): Observable { + return this.http.get(`${this.base}/dashboard`, { + ...this.silent, + params: new HttpParams().set('days', String(days)) + }); } - dashboard(): Observable { - return this.http.get(`${this.base}/dashboard`, this.silent); + alert(id: number): Observable { + return this.http.get(`${this.base}/alerts/${id}`, this.silent); + } + + updateStatus(id: number, status: string, remarks?: string | null): Observable { + return this.http.put(`${this.base}/alerts/${id}/status`, { status, remarks }, this.silent); + } + + linkClient(id: number, clientId: number): Observable { + return this.http.put(`${this.base}/alerts/${id}/client`, { clientId }, this.silent); } private params(filter: Record): HttpParams { diff --git a/src/app/credit-bureau/credit-bureau-routing.module.ts b/src/app/credit-bureau/credit-bureau-routing.module.ts index a57cda8a0..ddaadc13b 100644 --- a/src/app/credit-bureau/credit-bureau-routing.module.ts +++ b/src/app/credit-bureau/credit-bureau-routing.module.ts @@ -11,10 +11,7 @@ import { Routes, RouterModule } from '@angular/router'; import { Route } from '../core/route/route.service'; import { CicDashboardComponent } from './cic-dashboard/cic-dashboard.component'; -import { CicNewEnquiryComponent } from './cic-new-enquiry/cic-new-enquiry.component'; -import { CicEnquiryHistoryComponent } from './cic-enquiry-history/cic-enquiry-history.component'; -import { CicEnquiryDetailComponent } from './cic-enquiry-detail/cic-enquiry-detail.component'; -import { CicConsentsComponent } from './cic-consents/cic-consents.component'; +import { CicFetchLogComponent } from './cic-fetch-log/cic-fetch-log.component'; import { CicBureauConfigComponent } from './cic-bureau-config/cic-bureau-config.component'; import { CicApiMappingComponent } from './cic-api-mapping/cic-api-mapping.component'; @@ -35,30 +32,9 @@ const routes: Routes = [ data: { title: 'Credit Bureau Dashboard', breadcrumb: 'Dashboard' } }, { - path: 'new-enquiry', - component: CicNewEnquiryComponent, - data: { title: 'New Bureau Enquiry', breadcrumb: 'New Enquiry' } - }, - { - path: 'enquiries', - data: { breadcrumb: 'Enquiry History' }, - children: [ - { - path: '', - component: CicEnquiryHistoryComponent, - data: { title: 'Bureau Enquiry History' } - }, - { - path: ':id', - component: CicEnquiryDetailComponent, - data: { title: 'Bureau Report', breadcrumb: 'Report' } - } - ] - }, - { - path: 'consents', - component: CicConsentsComponent, - data: { title: 'Bureau Consent Register', breadcrumb: 'Consent Register' } + path: 'fetch-log', + component: CicFetchLogComponent, + data: { title: 'Fetch Log', breadcrumb: 'Fetch Log' } }, { path: 'bureaus', diff --git a/src/app/credit-bureau/credit-bureau.module.ts b/src/app/credit-bureau/credit-bureau.module.ts index 89c01faf7..762023c87 100644 --- a/src/app/credit-bureau/credit-bureau.module.ts +++ b/src/app/credit-bureau/credit-bureau.module.ts @@ -11,25 +11,30 @@ import { NgModule } from '@angular/core'; import { SharedModule } from '../shared/shared.module'; import { CreditBureauRoutingModule } from './credit-bureau-routing.module'; import { CicDashboardComponent } from './cic-dashboard/cic-dashboard.component'; -import { CicNewEnquiryComponent } from './cic-new-enquiry/cic-new-enquiry.component'; -import { CicEnquiryHistoryComponent } from './cic-enquiry-history/cic-enquiry-history.component'; -import { CicEnquiryDetailComponent } from './cic-enquiry-detail/cic-enquiry-detail.component'; -import { CicConsentsComponent } from './cic-consents/cic-consents.component'; +import { CicFetchLogComponent } from './cic-fetch-log/cic-fetch-log.component'; +import { CicAlertDetailComponent } from './cic-alert-detail/cic-alert-detail.component'; import { CicBureauConfigComponent } from './cic-bureau-config/cic-bureau-config.component'; import { CicApiMappingComponent } from './cic-api-mapping/cic-api-mapping.component'; +import { CicService } from './cic.service'; +import { CicStaticService } from './cic-static.service'; -/** CIC / credit bureau enquiries (CIBIL, Experian, Equifax, CRIF) — its own top-level menu. */ +/** + * CIC / credit bureau (CIBIL, Experian, Equifax, CRIF) - its own top-level menu: enquiry alerts on our customers from + * other lenders, the CIC whitelist and configuration, and the API mapping. + */ @NgModule({ imports: [ SharedModule, CreditBureauRoutingModule, CicDashboardComponent, - CicNewEnquiryComponent, - CicEnquiryHistoryComponent, - CicEnquiryDetailComponent, - CicConsentsComponent, + CicFetchLogComponent, + CicAlertDetailComponent, CicBureauConfigComponent, CicApiMappingComponent + ], + providers: [ + // Static demo data, no backend call. Remove this line to use the real /v1/cic API again. + { provide: CicService, useClass: CicStaticService } ] }) export class CreditBureauModule {} diff --git a/src/app/loan-eligibility/loan-eligibility-routing.module.ts b/src/app/loan-eligibility/loan-eligibility-routing.module.ts new file mode 100644 index 000000000..d1b831c44 --- /dev/null +++ b/src/app/loan-eligibility/loan-eligibility-routing.module.ts @@ -0,0 +1,27 @@ +/** + * Copyright since 2025 Mifos Initiative + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +import { NgModule } from '@angular/core'; +import { RouterModule, Routes } from '@angular/router'; +import { Route } from '../core/route/route.service'; + +const routes: Routes = [ + Route.withShell([ + { + path: 'ai/loan-eligibility', + loadComponent: () => import('./loan-eligibility.component').then((m) => m.LoanEligibilityComponent), + data: { title: 'Loan Eligibility', breadcrumb: 'Loan Eligibility' } + } + ]) +]; + +@NgModule({ + imports: [RouterModule.forChild(routes)], + exports: [RouterModule] +}) +export class LoanEligibilityRoutingModule {} diff --git a/src/app/loan-eligibility/loan-eligibility.component.html b/src/app/loan-eligibility/loan-eligibility.component.html new file mode 100644 index 000000000..d4cfb4854 --- /dev/null +++ b/src/app/loan-eligibility/loan-eligibility.component.html @@ -0,0 +1,482 @@ + + +
+ @if (!loading) { +
+
+
AI / INTELLIGENCE · LENDING & RISK
+

Loan Eligibility

+

+ How our loans are running (RBI asset classification) and which loan products the good borrowers are eligible + for, using the eligibility rules set on each loan product. + @if (summary) { + As on {{ summary.asOnDate }}. + } +

+
+
+ } + + @if (error) { +

{{ error }}

+ } + @if (loading) { +
+ +
Loading loan book…
+
    + @for (st of loadingSteps; track $index) { +
  • + {{ $index < loadingStep ? '✓' : $index === loadingStep ? '…' : '' }} {{ st }} +
    • + } +
+
+
+ } + + @if (summary; as s) { +
+
+ Active loans + {{ s.activeLoans }} + ₹{{ s.activeOutstanding | number: '1.0-0' }} outstanding +
+
+ Running well (Standard + SMA) + {{ s.performingLoans }} + ₹{{ s.performingOutstanding | number: '1.0-0' }} +
+
+ Gone bad (NPA) + {{ s.npaLoans }} + ₹{{ s.npaOutstanding | number: '1.0-0' }} · Gross NPA {{ s.grossNpaPct }}% +
+
+ Written off / Closed + {{ s.writtenOffLoans }} / {{ s.closedLoans }} + ₹{{ s.writtenOffAmount | number: '1.0-0' }} written off +
+
+ +
+ + +
+ + @if (view === 'BOOK') { +
+
Loans by RBI asset classification (days past due)
+ + + + + + + + + + + + + @for (st of performingStages; track st.stage) { + + + + + + + + + } + @for (st of npaStages; track st.stage) { + + + + + + + + + } + @for (st of closedStages; track st.stage) { + + + + + + + + + } + +
ClassDays past dueLoansOutstandingOverdueShare of book
+ + {{ st.label }} + {{ st.dpdRange }}{{ st.loans }}₹{{ st.outstanding | number: '1.2-2' }}₹{{ st.overdue | number: '1.2-2' }} + {{ share(st) }}% +
{{ st.label }} (NPA){{ st.dpdRange }}{{ st.loans }}₹{{ st.outstanding | number: '1.2-2' }}₹{{ st.overdue | number: '1.2-2' }} + {{ share(st) }}% +
{{ st.label }}{{ st.dpdRange }}{{ st.loans }}––
+
+ +
+
Active loans by product
+ + + + + + + + + + + + + @for (p of s.products; track p.productId) { + + + + + + + + + } @empty { + + + + } + +
ProductActiveRunning wellNPAOutstandingNPA outstanding
{{ p.productName }}{{ p.activeLoans }}{{ p.performingLoans }}{{ p.npaLoans }}₹{{ p.outstanding | number: '1.2-2' }}₹{{ p.npaOutstanding | number: '1.2-2' }}
No active loans.
+
+ +
+
Share linking to borrowing (5% unsecured · 2.5% secured)
+
+ Shares required on running loans: ₹{{ s.shareRequired | number: '1.0-0' }} + Shares held by these members: ₹{{ s.shareHeld | number: '1.0-0' }} + Members short: {{ s.shareShortMembers }} (₹{{ s.shareShortfall | number: '1.0-0' }} to collect) +
+
+ } + + @if (view === 'BORROWERS') { +
+
+ Borrowers — Good {{ s.goodBorrowers }} · Watch {{ s.watchBorrowers }} · Bad {{ s.badBorrowers }} +
+
+ @for (c of categories; track c.value) { + + } + + +
+

+ Good: every running loan is regular (0 days past due) and nothing was ever written off. Watch: a loan is + overdue up to 90 days (SMA). Bad: a loan is NPA or written off. Eligibility is worked out for good borrowers + only; a fresh loan also needs a clean EMI record (at most 2 EMIs ever paid late). +

+ + + + + + + + + + + + + + + + @if (borrowersLoading) { + + + + } + @for (b of borrowersLoading ? [] : pagedBorrowers; track b.clientId) { + + + + + + + + + + + + } @empty { + + + + } + +
BorrowerCategoryRunning / ClosedEMI recordOutstandingMax days overdueWorst classMore loan?
+ Fetching borrowers… +
+ {{ b.clientName }} ({{ b.clientAccountNo }}) + + {{ + categoryLabel(b.category) + }} + {{ b.activeLoans }} / {{ b.closedLoans }} + {{ b.emisPaid - b.emisLate }} / {{ b.emisPaid }} on time + @if (b.emisLate) { + ({{ b.emisLate }} late) + } + ₹{{ b.outstanding | number: '1.2-2' }}{{ b.maxDpd }}{{ b.worstStage || '–' }} + @if (b.eligibleProducts > 0) { + Yes · {{ b.eligibleProducts }} products + } @else { + No + } + + +
No borrowers in this category.
+ @if (borrowers.length > pageSize) { +
+ Showing {{ page * pageSize + 1 }}–{{ pageEnd }} of {{ borrowers.length }} + + @for (p of pages; track p) { + + } + +
+ } +
+ } + + @if (selected; as b) { +
+ +
+ } + +
    + @for (n of s.notes; track $index) { +
  • {{ n }}
    • + } +
+ } +
diff --git a/src/app/loan-eligibility/loan-eligibility.component.scss b/src/app/loan-eligibility/loan-eligibility.component.scss new file mode 100644 index 000000000..cd8d224c6 --- /dev/null +++ b/src/app/loan-eligibility/loan-eligibility.component.scss @@ -0,0 +1,312 @@ +/** + * Copyright since 2025 Mifos Initiative + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +.le-kpis { + display: grid; + grid-template-columns: repeat(auto-fit, minmax(220px, 1fr)); + gap: 12px; + margin-bottom: 16px; +} + +.le-kpi { + display: flex; + flex-direction: column; + gap: 4px; + padding: 14px 16px; + border: 1px solid #e4e7ec; + border-radius: 10px; + background: #fff; +} + +.le-kpi--good { + border-left: 4px solid #12b76a; +} + +.le-kpi--bad { + border-left: 4px solid #d92d20; +} + +.le-kpi-l { + font-size: 12px; + color: #667085; + text-transform: uppercase; + letter-spacing: 0.04em; +} + +.le-kpi-v { + font-size: 26px; + font-weight: 700; +} + +.le-kpi-s { + font-size: 13px; + color: #475467; +} + +.le-dot { + display: inline-block; + width: 10px; + height: 10px; + margin-right: 6px; + border-radius: 50%; +} + +.le-dot--good { + background: #12b76a; +} + +.le-dot--warn { + background: #f79009; +} + +.le-dot--bad { + background: #d92d20; +} + +.le-bar { + display: inline-block; + width: 120px; + height: 8px; + margin-right: 6px; + overflow: hidden; + border-radius: 4px; + background: #f2f4f7; + vertical-align: middle; + + span { + display: block; + height: 100%; + background: #12b76a; + } +} + +.le-bar--bad span { + background: #d92d20; +} + +.le-muted { + color: #667085; +} + +.le-tabs { + align-items: center; + flex-wrap: wrap; + gap: 8px; + padding: 12px 16px 0; +} + +.le-search { + min-width: 220px; + padding: 8px 10px; + border: 1px solid #d0d5dd; + border-radius: 8px; +} + +.le-help { + padding: 0 16px; +} + +.le-chip { + padding: 2px 10px; + border-radius: 999px; + font-size: 12px; + font-weight: 600; +} + +.le-chip--good { + background: #ecfdf3; + color: #067647; +} + +.le-chip--watch { + background: #fffaeb; + color: #b54708; +} + +.le-chip--bad { + background: #fef3f2; + color: #b42318; +} + +.le-selected { + background: #f5f8ff; +} + +.le-facts { + display: flex; + flex-wrap: wrap; + gap: 24px; + padding: 8px 16px 12px; + color: #344054; +} + +.le-why div { + font-size: 13px; + line-height: 1.5; +} + +.le-fail { + color: #b42318; +} + +.le-pass { + color: #067647; +} + +.le-note { + color: #667085; +} + +.le-error { + color: #b42318; +} + +.le-notes { + margin: 8px 0 24px; + color: #667085; + font-size: 13px; +} + +.le-late { + color: #b42318; +} + +.le-overlay { + position: fixed; + inset: 0; + z-index: 1000; + display: flex; + align-items: flex-start; + justify-content: center; + padding: 48px 16px; + overflow-y: auto; + background: rgb(15 23 42 / 55%); +} + +.le-modal { + width: min(1100px, 100%); + padding: 20px 24px; + border-radius: 12px; + background: #fff; + box-shadow: 0 20px 50px rgb(0 0 0 / 30%); +} + +.le-modal-head { + display: flex; + align-items: center; + justify-content: space-between; + gap: 12px; +} + +.le-views { + margin-bottom: 16px; +} + +.le-compact td { + padding-top: 6px; + padding-bottom: 6px; +} + +.le-compact .pg-btn { + padding: 4px 14px; +} + +.le-pager { + display: flex; + flex-wrap: wrap; + align-items: center; + justify-content: flex-end; + gap: 6px; + margin-top: 12px; + + span { + margin-right: auto; + color: #667085; + } +} + +.le-loader { + display: flex; + flex-direction: column; + align-items: center; + gap: 14px; + margin: 32px auto; + padding: 36px 24px; + max-width: 520px; + border-radius: 12px; + background: #fff; + box-shadow: 0 4px 16px rgb(16 24 40 / 8%); +} + +.le-loader-title { + font-weight: 600; + font-size: 16px; + color: #1d2939; +} + +.le-loader-steps { + margin: 0; + padding: 0; + list-style: none; + font-size: 14px; + line-height: 1.9; + color: #98a2b3; + + .le-done { + color: #067647; + } + + .le-now { + color: #1d4ed8; + font-weight: 600; + } +} + +.le-progress { + width: 100%; + height: 6px; + border-radius: 3px; + overflow: hidden; + background: #eaecf0; + + span { + display: block; + height: 100%; + background: #1d4ed8; + transition: width 0.6s ease; + } +} + +.le-spinner { + width: 44px; + height: 44px; + border: 4px solid #dbe4ff; + border-top-color: #1d4ed8; + border-radius: 50%; + animation: le-spin 0.8s linear infinite; +} + +.le-spinner--sm { + display: inline-block; + width: 14px; + height: 14px; + border-width: 2px; + margin-right: 6px; + vertical-align: middle; +} + +@keyframes le-spin { + to { + transform: rotate(360deg); + } +} + +.le-total td { + font-weight: 600; + border-top: 2px solid #d0d5dd; +} diff --git a/src/app/loan-eligibility/loan-eligibility.component.ts b/src/app/loan-eligibility/loan-eligibility.component.ts new file mode 100644 index 000000000..937fdc0bb --- /dev/null +++ b/src/app/loan-eligibility/loan-eligibility.component.ts @@ -0,0 +1,187 @@ +/** + * Copyright since 2025 Mifos Initiative + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +import { Component, HostListener, OnDestroy, OnInit, inject } from '@angular/core'; +import { CommonModule } from '@angular/common'; +import { FormsModule } from '@angular/forms'; +import { HttpErrorResponse } from '@angular/common/http'; +import { + Borrower, + BorrowerCategory, + LoanEligibilityService, + LoanEligibilitySummary, + LoanStageRow +} from './loan-eligibility.service'; + +/** + * Loan Eligibility – how the loan book is running (RBI asset classes) and which loan products the good borrowers + * qualify for, using their EMI record and the eligibility rules set on each loan product. + */ +@Component({ + selector: 'mifosx-loan-eligibility', + templateUrl: './loan-eligibility.component.html', + styleUrls: [ + '../cashier/cashier-shared.scss', + '../investment/investment-shared.scss', + './loan-eligibility.component.scss' + ], + standalone: true, + imports: [ + CommonModule, + FormsModule + ] +}) +export class LoanEligibilityComponent implements OnInit, OnDestroy { + private readonly service = inject(LoanEligibilityService); + + summary: LoanEligibilitySummary | null = null; + borrowers: Borrower[] = []; + category: BorrowerCategory | '' = 'GOOD'; + search = ''; + selected: Borrower | null = null; + /** Which part of the page is shown, so the user need not scroll past the loan book to reach borrowers. */ + view: 'BOOK' | 'BORROWERS' = 'BOOK'; + page = 0; + readonly pageSize = 10; + loading = false; + borrowersLoading = false; + /** Borrower whose detail is being fetched (View button shows it). */ + openingId: number | null = null; + error = ''; + /** Steps shown while the book is being read. */ + readonly loadingSteps = [ + 'Fetching loan accounts…', + 'Reading repayment schedules and overdues…', + 'Classifying loans as per RBI IRAC norms…', + 'Running product eligibility rules…' + ]; + loadingStep = 0; + private stepTimer?: ReturnType; + + readonly categories: Array<{ value: BorrowerCategory | ''; label: string }> = [ + { value: 'GOOD', label: 'Good borrowers' }, + { value: 'WATCH', label: 'Watch (SMA)' }, + { value: 'BAD', label: 'Bad (NPA / written off)' }, + { value: '', label: 'All borrowers' } + ]; + + ngOnInit(): void { + this.loading = true; + this.loadingStep = 0; + this.stepTimer = setInterval( + () => (this.loadingStep = Math.min(this.loadingStep + 1, this.loadingSteps.length - 1)), + 700 + ); + this.service.getSummary().subscribe({ + next: (s) => { + this.summary = s; + this.stopLoading(); + }, + error: (err) => { + this.stopLoading(); + this.error = this.message(err); + } + }); + this.loadBorrowers(); + } + + loadBorrowers(): void { + this.selected = null; + this.borrowersLoading = true; + this.service.getBorrowers(this.category, this.search).subscribe({ + next: (b) => { + this.borrowers = b; + this.page = 0; + this.borrowersLoading = false; + }, + error: (err) => { + this.borrowersLoading = false; + this.error = this.message(err); + } + }); + } + + setCategory(c: BorrowerCategory | ''): void { + this.category = c; + this.loadBorrowers(); + } + + open(b: Borrower): void { + this.openingId = b.clientId; + this.service.getBorrower(b.clientId).subscribe({ + next: (d) => { + this.openingId = null; + this.selected = d; + }, + error: (err) => { + this.openingId = null; + this.error = this.message(err); + } + }); + } + + ngOnDestroy(): void { + this.stopLoading(); + } + + private stopLoading(): void { + this.loading = false; + clearInterval(this.stepTimer); + } + + get pagedBorrowers(): Borrower[] { + return this.borrowers.slice(this.page * this.pageSize, (this.page + 1) * this.pageSize); + } + + get pageEnd(): number { + return Math.min((this.page + 1) * this.pageSize, this.borrowers.length); + } + + get pages(): number[] { + return Array.from({ length: Math.ceil(this.borrowers.length / this.pageSize) }, (_, i) => i); + } + + close(): void { + this.selected = null; + } + + @HostListener('document:keydown.escape') + onEscape(): void { + this.close(); + } + + get performingStages(): LoanStageRow[] { + return (this.summary?.stages ?? []).filter((s) => s.group === 'PERFORMING'); + } + + get npaStages(): LoanStageRow[] { + return (this.summary?.stages ?? []).filter((s) => s.group === 'NPA'); + } + + get closedStages(): LoanStageRow[] { + return (this.summary?.stages ?? []).filter((s) => s.group === 'CLOSED'); + } + + /** Share of the active book in a stage, for the bar. */ + share(s: LoanStageRow): number { + const total = this.summary?.activeOutstanding ?? 0; + return total > 0 ? Math.round((s.outstanding / total) * 1000) / 10 : 0; + } + + categoryLabel(c: BorrowerCategory): string { + return c === 'GOOD' ? 'Good' : c === 'WATCH' ? 'Watch' : 'Bad'; + } + + private message(err: unknown): string { + if (err instanceof HttpErrorResponse) { + const e = err.error as { errors?: Array<{ defaultUserMessage?: string }>; defaultUserMessage?: string } | null; + return e?.errors?.[0]?.defaultUserMessage || e?.defaultUserMessage || err.message; + } + return String(err); + } +} diff --git a/src/app/loan-eligibility/loan-eligibility.mock.ts b/src/app/loan-eligibility/loan-eligibility.mock.ts new file mode 100644 index 000000000..a72517801 --- /dev/null +++ b/src/app/loan-eligibility/loan-eligibility.mock.ts @@ -0,0 +1,726 @@ +/** + * Copyright since 2025 Mifos Initiative + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +/** + * Demo data for Loan Eligibility. The bank's rules are applied to it: RBI asset classification on days past due, and + * product eligibility rules (age, age at maturity, income, FOIR, loans per customer, LTV on pledged deposits). The book is generated from a fixed seed, so the + * figures are the same on every load. + */ +import { + Borrower, + BorrowerCategory, + BorrowerLoan, + LoanEligibilitySummary, + LoanStageRow, + ProductEligibility +} from './loan-eligibility.service'; + +interface DemoProduct { + id: number; + name: string; + minAmount: number; + maxAmount: number; + annualRate: number; + tenureMonths: number; + minAge?: number; + maxAgeAtMaturity?: number; + minMonthlyIncome?: number; + maxFoir?: number; + maxLoansPerCustomer?: number; + /** Loan against deposits: % of the FD / RD balance that can be lent. */ + ltvPct?: number; + /** Secured loans need shares of 2.5% of the loan, unsecured 5% (share linking to borrowing). */ + secured: boolean; +} + +interface DemoMonth { + month: string; + credits: number; + debits: number; + avgBalance: number; + returns: number; +} + +interface DemoAccount { + type: 'Savings' | 'Current'; + accountNo: string; + months: DemoMonth[]; +} + +interface DemoLoan { + id: number; + accountNo: string; + productId: number; + status: 'Active' | 'Closed' | 'Written off'; + dpd: number; + disbursed: number; + outstanding: number; + overdue: number; + emi: number; + /** EMIs fallen due so far, and how many of them were paid after the due date. */ + emisPaid: number; + emisLate: number; +} + +interface DemoClient { + id: number; + name: string; + accountNo: string; + age: number; + monthlyIncome?: number; + fdBalance: number; + savingsBalance: number; + loans: DemoLoan[]; + /** Paid-up share capital held as a member. */ + shareHeld: number; + accounts: DemoAccount[]; +} + +export const DEMO_PRODUCTS: DemoProduct[] = [ + { + id: 1, + name: 'Personal Loan', + minAmount: 25000, + maxAmount: 1000000, + annualRate: 11.5, + tenureMonths: 60, + minAge: 21, + maxAgeAtMaturity: 60, + minMonthlyIncome: 25000, + maxFoir: 50, + maxLoansPerCustomer: 1, + secured: false + }, + { + id: 2, + name: 'Home Loan', + minAmount: 500000, + maxAmount: 5000000, + annualRate: 9, + tenureMonths: 240, + minAge: 23, + maxAgeAtMaturity: 70, + minMonthlyIncome: 40000, + maxFoir: 55, + maxLoansPerCustomer: 1, + secured: true + }, + { + id: 3, + name: 'Vehicle Loan', + minAmount: 100000, + maxAmount: 1500000, + annualRate: 9.75, + tenureMonths: 84, + minAge: 21, + maxAgeAtMaturity: 65, + minMonthlyIncome: 20000, + maxFoir: 50, + maxLoansPerCustomer: 2, + secured: true + }, + { + id: 4, + name: 'Gold Loan', + minAmount: 10000, + maxAmount: 1000000, + annualRate: 9, + tenureMonths: 12, + minAge: 18, + maxLoansPerCustomer: 3, + secured: true + }, + { + id: 5, + name: 'Loan against FD', + minAmount: 5000, + maxAmount: 2500000, + annualRate: 8.5, + tenureMonths: 12, + minAge: 18, + ltvPct: 90, + secured: true + }, + { + id: 6, + name: 'MSME / Business Loan', + minAmount: 200000, + maxAmount: 2500000, + annualRate: 12, + tenureMonths: 84, + minAge: 25, + maxAgeAtMaturity: 65, + minMonthlyIncome: 50000, + maxFoir: 60, + maxLoansPerCustomer: 1, + secured: true + } +]; + +/** Membership share every member holds, over and above the shares linked to loans. */ +const MEMBERSHIP_SHARE = 1000; +const MONTHS = [ + 'Apr 2026', + 'May 2026', + 'Jun 2026', + 'Jul 2026', + 'Aug 2026', + 'Sep 2026' +]; +/** Late EMIs a borrower may have in their history and still get a fresh loan. */ +const MAX_LATE_EMIS = 2; +/** Cheque / ECS returns allowed in the last six months for a fresh loan. */ +const MAX_RETURNS = 1; + +function sharePct(productId: number): number { + return DEMO_PRODUCTS.find((p) => p.id === productId)?.secured === false ? 5 : 2.5; +} + +function ceil100(n: number): number { + return Math.ceil(n / 100) * 100; +} + +const FIRST = [ + 'Ramesh', + 'Sunita', + 'Amit', + 'Priya', + 'Rajesh', + 'Kavita', + 'Suresh', + 'Anjali', + 'Mahesh', + 'Pooja', + 'Dinesh', + 'Neha', + 'Vijay', + 'Rekha', + 'Sanjay', + 'Meena', + 'Arvind', + 'Geeta', + 'Manoj', + 'Seema', + 'Rahul', + 'Asha', + 'Deepak', + 'Nisha', + 'Ashok', + 'Lata', + 'Prakash', + 'Usha', + 'Anil', + 'Shobha' +]; +const LAST = [ + 'Sharma', + 'Verma', + 'Patel', + 'Gupta', + 'Singh', + 'Yadav', + 'Jain', + 'Agrawal', + 'Choudhary', + 'Mishra', + 'Tiwari', + 'Rathore', + 'Soni', + 'Malviya', + 'Dubey', + 'Saxena' +]; + +/** Small deterministic generator so the demo looks the same every time. */ +function rng(seed: number): () => number { + let s = seed; + return () => { + s = (s * 1664525 + 1013904223) % 4294967296; + return s / 4294967296; + }; +} + +function emiFor(principal: number, annualRate: number, months: number): number { + const r = annualRate / 1200; + return r === 0 ? principal / months : (principal * r) / (1 - Math.pow(1 + r, -months)); +} + +function principalForEmi(emi: number, annualRate: number, months: number): number { + const r = annualRate / 1200; + return r === 0 ? emi * months : (emi * (1 - Math.pow(1 + r, -months))) / r; +} + +function round(n: number, step = 1): number { + return Math.round(n / step) * step; +} + +function buildBook(): DemoClient[] { + const rand = rng(20261019); + const pick = (a: T[]): T => a[Math.floor(rand() * a.length)]; + const clients: DemoClient[] = []; + // Separate streams for the repayment record and the bank accounts, so the book above stays as it was. + const track = rng(7); + const bank = rng(11); + let loanId = 1; + for (let i = 0; i < 64; i++) { + const salaried = rand() < 0.85; + const client: DemoClient = { + id: 1001 + i, + name: `${FIRST[i % FIRST.length]} ${pick(LAST)}`, + accountNo: String(100010 + i).padStart(9, '0'), + age: 22 + Math.floor(rand() * 40), + monthlyIncome: salaried ? round(18000 + rand() * 132000, 500) : undefined, + fdBalance: rand() < 0.45 ? round(25000 + rand() * 775000, 1000) : 0, + savingsBalance: round(2000 + rand() * 148000, 100), + loans: [], + shareHeld: 0, + accounts: [] + }; + const count = 1 + Math.floor(rand() * 3); + // Behaviour of the borrower decides how all their loans run: most pay on time, some slip, a few go bad. + const behaviour = rand(); + for (let k = 0; k < count; k++) { + // Stay within each product's age and loans-per-customer rules, as the bank would have at sanction. + const product = pick( + DEMO_PRODUCTS.filter( + (p) => + (p.id !== 5 || client.fdBalance > 0) && + client.age >= (p.minAge ?? 18) && + client.loans.filter((l) => l.productId === p.id).length < (p.maxLoansPerCustomer ?? 3) + ) + ); + const disbursed = round( + product.minAmount + rand() * Math.min(product.maxAmount - product.minAmount, 1800000), + 1000 + ); + const closed = rand() < 0.25; + let dpd = 0; + if (!closed) { + if (behaviour > 0.975) { + dpd = 91 + Math.floor(rand() * 900); + } else if (behaviour > 0.72) { + dpd = 1 + Math.floor(rand() * 89); + } else if (behaviour > 0.705) { + dpd = 91 + Math.floor(rand() * 300); + } + } + const writtenOff = !closed && dpd > 700 && rand() < 0.5; + const outstanding = closed || writtenOff ? 0 : round(disbursed * (0.25 + rand() * 0.7), 1); + const emi = round(emiFor(disbursed, product.annualRate, product.tenureMonths), 1); + const emisPaid = closed + ? Math.min(product.tenureMonths, 12 + Math.floor(track() * 24)) + : writtenOff + ? Math.max(3, Math.round(product.tenureMonths * 0.3)) + : Math.max(1, Math.round(product.tenureMonths * (1 - outstanding / disbursed))); + // Most good payers never miss a date; some were late once or a few times but are regular today. + let emisLate = 0; + if (behaviour > 0.705) { + emisLate = 2 + Math.floor(track() * 6); + } else if (behaviour > 0.55) { + emisLate = 1 + Math.floor(track() * 4); + } + emisLate = Math.min(emisLate, emisPaid); + client.loans.push({ + id: loanId, + accountNo: String(500000 + loanId).padStart(9, '0'), + productId: product.id, + status: closed ? 'Closed' : writtenOff ? 'Written off' : 'Active', + dpd: closed || writtenOff ? 0 : dpd, + disbursed, + outstanding, + overdue: dpd > 0 && !writtenOff ? round(Math.min(outstanding, emi * Math.ceil(dpd / 30)), 1) : 0, + emi: closed || writtenOff ? 0 : emi, + emisPaid, + emisLate + }); + loanId++; + } + addBanking(client, bank); + clients.push(client); + } + return clients; +} + +/** Savings / current account statement for the last six months and the member's shareholding. */ +function addBanking(c: DemoClient, bank: () => number): void { + const active = c.loans.filter((l) => l.status === 'Active'); + const emi = active.reduce((s, l) => s + l.emi, 0); + const overdue = active.some((l) => l.dpd > 0); + const late = c.loans.reduce((s, l) => s + l.emisLate, 0); + // Salaried members run a savings account; traders and businesses run a current account. + const business = !c.monthlyIncome; + const turnover = c.monthlyIncome ?? 150000 + bank() * 650000; + const spendRatio = business ? 0.82 + bank() * 0.12 : 0.3 + bank() * 0.3; + let returns = overdue ? 1 + Math.floor(bank() * 3) : late > MAX_LATE_EMIS ? 1 : bank() < 0.08 ? 1 : 0; + const months: DemoMonth[] = MONTHS.map((month, i) => { + const credits = round(turnover * (0.9 + bank() * 0.2) + (business ? 0 : bank() * 3000), 10); + // EMIs go out first; household or business spending is a share of what is left. + const debits = round(Math.max(0, credits - emi) * Math.min(0.97, spendRatio * (0.9 + bank() * 0.2)) + emi, 10); + const r = returns > 0 && (i >= MONTHS.length - returns || bank() < 0.2) ? 1 : 0; + returns -= r; + return { + month, + credits, + debits: overdue ? Math.max(debits, round(credits * 1.02, 10)) : debits, + avgBalance: round(c.savingsBalance * (0.7 + bank() * 0.6), 100), + returns: r + }; + }); + c.accounts.push({ + type: business ? 'Current' : 'Savings', + accountNo: String((business ? 300000 : 200000) + c.id).padStart(9, '0'), + months + }); + // Shares linked to borrowing: 2.5% of secured and 5% of unsecured loans. A few members are short. + const required = active.reduce((s, l) => s + (l.disbursed * sharePct(l.productId)) / 100, 0); + const short = required > 0 && bank() < 0.15; + c.shareHeld = MEMBERSHIP_SHARE + ceil100(short ? required * 0.5 : required); +} + +const BOOK = buildBook(); +const AS_ON = '19-10-2026'; + +const STAGES: Array> = [ + { stage: 'STANDARD', label: 'Standard', dpdRange: '0', group: 'PERFORMING' }, + { stage: 'SMA0', label: 'SMA-0', dpdRange: '1-30', group: 'PERFORMING' }, + { stage: 'SMA1', label: 'SMA-1', dpdRange: '31-60', group: 'PERFORMING' }, + { stage: 'SMA2', label: 'SMA-2', dpdRange: '61-90', group: 'PERFORMING' }, + { stage: 'SUBSTANDARD', label: 'Sub-standard', dpdRange: '91-455', group: 'NPA' }, + { stage: 'DOUBTFUL1', label: 'Doubtful D1', dpdRange: '456-820', group: 'NPA' }, + { stage: 'DOUBTFUL2', label: 'Doubtful D2', dpdRange: '821-1550', group: 'NPA' }, + { stage: 'DOUBTFUL3', label: 'Doubtful D3', dpdRange: 'above 1550', group: 'NPA' }, + { stage: 'LOSS', label: 'Loss / written off', dpdRange: 'written off', group: 'CLOSED' }, + { stage: 'CLOSED', label: 'Closed', dpdRange: 'repaid', group: 'CLOSED' } +]; + +/** RBI IRAC class of a loan on days past due. */ +function stageOf(l: DemoLoan): string { + if (l.status === 'Written off') { + return 'LOSS'; + } + if (l.status === 'Closed') { + return 'CLOSED'; + } + const d = l.dpd; + if (d <= 0) { + return 'STANDARD'; + } + if (d <= 30) { + return 'SMA0'; + } + if (d <= 60) { + return 'SMA1'; + } + if (d <= 90) { + return 'SMA2'; + } + if (d <= 455) { + return 'SUBSTANDARD'; + } + if (d <= 820) { + return 'DOUBTFUL1'; + } + return d <= 1550 ? 'DOUBTFUL2' : 'DOUBTFUL3'; +} + +function labelOf(stage: string): string { + return STAGES.find((s) => s.stage === stage)?.label ?? stage; +} + +function isNpa(stage: string): boolean { + return STAGES.find((s) => s.stage === stage)?.group === 'NPA'; +} + +function categoryOf(c: DemoClient): BorrowerCategory { + let cat: BorrowerCategory = 'GOOD'; + for (const l of c.loans) { + const st = stageOf(l); + if (st === 'LOSS' || isNpa(st)) { + return 'BAD'; + } + if (l.status === 'Active' && st !== 'STANDARD') { + cat = 'WATCH'; + } + } + return cat; +} + +function productName(id: number): string { + return DEMO_PRODUCTS.find((p) => p.id === id)?.name ?? String(id); +} + +/** Shares the member should hold against the running loans. */ +function shareRequired(c: DemoClient): number { + return c.loans + .filter((l) => l.status === 'Active') + .reduce((s, l) => s + (l.disbursed * sharePct(l.productId)) / 100, 0); +} + +/** Six-month averages of the operative account. */ +function statement(c: DemoClient) { + const ms = c.accounts.flatMap((a) => a.months); + const n = MONTHS.length; + const credits = ms.reduce((s, m) => s + m.credits, 0) / n; + const debits = ms.reduce((s, m) => s + m.debits, 0) / n; + return { + type: c.accounts[0]?.type ?? 'Savings', + credits, + debits, + surplus: credits - debits, + avgBalance: ms.reduce((s, m) => s + m.avgBalance, 0) / n, + returns: ms.reduce((s, m) => s + m.returns, 0) + }; +} + +const inr = (n: number) => '₹' + Math.round(n).toLocaleString('en-IN'); + +function eligibility(c: DemoClient, p: DemoProduct): ProductEligibility { + const passed: string[] = []; + const failed: string[] = []; + const notes: string[] = []; + const active = c.loans.filter((l) => l.status === 'Active'); + const currentEmi = active.reduce((s, l) => s + l.emi, 0); + let limit = p.maxAmount; + const paid = c.loans.reduce((s, l) => s + l.emisPaid, 0); + const late = c.loans.reduce((s, l) => s + l.emisLate, 0); + if (late > MAX_LATE_EMIS) { + failed.push(`EMI record: ${late} of ${paid} EMIs paid late (allowed up to ${MAX_LATE_EMIS})`); + } else { + passed.push(`EMI record: ${paid - late} of ${paid} EMIs paid on time`); + } + const st = statement(c); + if (st.returns > MAX_RETURNS) { + failed.push(`${st.returns} cheque / ECS returns in the last 6 months (allowed up to ${MAX_RETURNS})`); + } else { + passed.push(`${st.returns} cheque / ECS return(s) in the last 6 months`); + } + if (st.surplus <= 0) { + failed.push(`Account spending ${inr(st.debits)} a month is more than the credits ${inr(st.credits)}`); + } else { + passed.push( + `${st.type} account: credits ${inr(st.credits)} − expenses ${inr(st.debits)} = ${inr(st.surplus)} left a month` + ); + if (p.maxFoir !== undefined) { + limit = Math.min(limit, principalForEmi(st.surplus, p.annualRate, p.tenureMonths)); + } + } + if (p.minAge !== undefined) { + if (c.age < p.minAge) { + failed.push(`Age ${c.age} is below the minimum ${p.minAge}`); + } else { + passed.push(`Age ${c.age} (minimum ${p.minAge})`); + } + } + if (p.maxAgeAtMaturity !== undefined) { + const atMaturity = c.age + Math.ceil(p.tenureMonths / 12); + if (atMaturity > p.maxAgeAtMaturity) { + failed.push(`Age at maturity ${atMaturity} exceeds ${p.maxAgeAtMaturity}`); + } else { + passed.push(`Age at maturity ${atMaturity} (maximum ${p.maxAgeAtMaturity})`); + } + } + if (p.minMonthlyIncome !== undefined) { + if (!c.monthlyIncome) { + failed.push(`Monthly income not recorded (minimum ${inr(p.minMonthlyIncome)})`); + } else if (c.monthlyIncome < p.minMonthlyIncome) { + failed.push(`Monthly income ${inr(c.monthlyIncome)} is below ${inr(p.minMonthlyIncome)}`); + } else { + passed.push(`Monthly income ${inr(c.monthlyIncome)} (minimum ${inr(p.minMonthlyIncome)})`); + } + } + if (p.maxLoansPerCustomer !== undefined) { + const running = active.filter((l) => l.productId === p.id).length; + if (running >= p.maxLoansPerCustomer) { + failed.push(`${running} loan(s) of this product already running (maximum ${p.maxLoansPerCustomer})`); + } else { + passed.push(`${running} loan(s) of this product running (maximum ${p.maxLoansPerCustomer})`); + } + } + if (p.maxFoir !== undefined && c.monthlyIncome) { + const room = (c.monthlyIncome * p.maxFoir) / 100 - currentEmi; + if (room <= 0) { + failed.push(`Current EMIs ${inr(currentEmi)} already use the FOIR limit of ${p.maxFoir}% of income`); + } else { + const byFoir = principalForEmi(room, p.annualRate, p.tenureMonths); + passed.push(`FOIR ${p.maxFoir}%: EMI room ${inr(room)} a month supports up to ${inr(byFoir)}`); + limit = Math.min(limit, byFoir); + } + } + if (p.ltvPct !== undefined) { + if (c.fdBalance <= 0) { + failed.push('No FD / RD to pledge'); + } else { + const byDeposit = (c.fdBalance * p.ltvPct) / 100; + passed.push(`FD ${inr(c.fdBalance)} at ${p.ltvPct}% allows up to ${inr(byDeposit)}`); + limit = Math.min(limit, byDeposit); + } + } + if (p.id === 4) { + notes.push('Final amount depends on the gold valued at the branch'); + } + let eligible = failed.length === 0; + if (eligible && limit < p.minAmount) { + failed.push(`Eligible amount ${inr(limit)} is below the product minimum ${inr(p.minAmount)}`); + eligible = false; + } + const amount = eligible ? round(limit, 1000) : undefined; + const pct = p.secured ? 2.5 : 5; + const shortfall = Math.max(0, shareRequired(c) - (c.shareHeld - MEMBERSHIP_SHARE)); + const shareToBuy = amount ? ceil100((amount * pct) / 100 + shortfall) : undefined; + if (amount) { + notes.push( + `Shares of ${inr((amount * pct) / 100)} to be taken (${pct}% of the loan, ${p.secured ? 'secured' : 'unsecured'})` + ); + if (shortfall > 0) { + notes.push(`Existing share shortfall of ${inr(shortfall)} on running loans is collected too`); + } + } + notes.push('CIBIL score not checked in this demo'); + return { + productId: p.id, + productName: p.name, + eligible, + eligibleAmount: amount, + sharePct: pct, + shareToBuy, + netInHand: amount && shareToBuy !== undefined ? amount - shareToBuy : undefined, + minAmount: p.minAmount, + maxAmount: p.maxAmount, + passed, + failed, + notes + }; +} + +function toBorrower(c: DemoClient, detail: boolean): Borrower { + const category = categoryOf(c); + const active = c.loans.filter((l) => l.status === 'Active'); + const order = STAGES.map((s) => s.stage); + const worst = active.map(stageOf).sort((a, b) => order.indexOf(b) - order.indexOf(a))[0]; + const elig = category === 'GOOD' ? DEMO_PRODUCTS.map((p) => eligibility(c, p)) : []; + const loans: BorrowerLoan[] = c.loans.map((l) => ({ + loanId: l.id, + accountNo: l.accountNo, + productName: productName(l.productId), + status: l.status, + stage: labelOf(stageOf(l)), + dpd: l.dpd, + emisPaid: l.emisPaid, + emisLate: l.emisLate, + disbursed: l.disbursed, + outstanding: l.outstanding, + overdue: l.overdue, + sharePct: sharePct(l.productId), + shareRequired: l.status === 'Active' ? (l.disbursed * sharePct(l.productId)) / 100 : 0 + })); + const st = statement(c); + return { + clientId: c.id, + clientName: c.name, + clientAccountNo: c.accountNo, + category, + activeLoans: active.length, + closedLoans: c.loans.filter((l) => l.status === 'Closed').length, + writtenOffLoans: c.loans.filter((l) => l.status === 'Written off').length, + outstanding: active.reduce((s, l) => s + l.outstanding, 0), + maxDpd: active.reduce((m, l) => Math.max(m, l.dpd), 0), + worstStage: worst ? labelOf(worst) : undefined, + monthlyIncome: c.monthlyIncome, + age: c.age, + depositBalance: c.fdBalance + c.savingsBalance, + currentEmi: active.reduce((s, l) => s + l.emi, 0), + eligibleProducts: elig.filter((e) => e.eligible).length, + emisPaid: c.loans.reduce((s, l) => s + l.emisPaid, 0), + emisLate: c.loans.reduce((s, l) => s + l.emisLate, 0), + shareHeld: c.shareHeld, + shareRequired: MEMBERSHIP_SHARE + shareRequired(c), + accountType: st.type, + avgCredits: st.credits, + avgDebits: st.debits, + returns: st.returns, + accounts: detail ? c.accounts : undefined, + loans: detail ? loans : undefined, + eligibility: detail ? elig : undefined + }; +} + +export function demoSummary(): LoanEligibilitySummary { + const all = BOOK.flatMap((c) => c.loans); + const stages: LoanStageRow[] = STAGES.map((s) => { + const ls = all.filter((l) => stageOf(l) === s.stage); + return { + ...s, + loans: ls.length, + outstanding: ls.reduce((a, l) => a + l.outstanding, 0), + overdue: ls.reduce((a, l) => a + l.overdue, 0) + }; + }); + const active = all.filter((l) => l.status === 'Active'); + const npa = active.filter((l) => isNpa(stageOf(l))); + const activeOut = active.reduce((a, l) => a + l.outstanding, 0); + const npaOut = npa.reduce((a, l) => a + l.outstanding, 0); + const cats = BOOK.map(categoryOf); + const linked = BOOK.filter((c) => shareRequired(c) > 0); + const shortOf = (c: DemoClient) => Math.max(0, shareRequired(c) - (c.shareHeld - MEMBERSHIP_SHARE)); + return { + shareRequired: linked.reduce((a, c) => a + shareRequired(c), 0), + shareHeld: linked.reduce((a, c) => a + c.shareHeld - MEMBERSHIP_SHARE, 0), + shareShortMembers: linked.filter((c) => shortOf(c) > 0).length, + shareShortfall: linked.reduce((a, c) => a + shortOf(c), 0), + asOnDate: AS_ON, + activeLoans: active.length, + activeOutstanding: activeOut, + performingLoans: active.length - npa.length, + performingOutstanding: activeOut - npaOut, + npaLoans: npa.length, + npaOutstanding: npaOut, + grossNpaPct: activeOut > 0 ? Math.round((npaOut / activeOut) * 10000) / 100 : 0, + closedLoans: all.filter((l) => l.status === 'Closed').length, + writtenOffLoans: all.filter((l) => l.status === 'Written off').length, + writtenOffAmount: all.filter((l) => l.status === 'Written off').reduce((a, l) => a + l.disbursed * 0.6, 0), + goodBorrowers: cats.filter((c) => c === 'GOOD').length, + watchBorrowers: cats.filter((c) => c === 'WATCH').length, + badBorrowers: cats.filter((c) => c === 'BAD').length, + stages, + products: DEMO_PRODUCTS.map((p) => { + const ls = active.filter((l) => l.productId === p.id); + const bad = ls.filter((l) => isNpa(stageOf(l))); + return { + productId: p.id, + productName: p.name, + activeLoans: ls.length, + performingLoans: ls.length - bad.length, + npaLoans: bad.length, + outstanding: ls.reduce((a, l) => a + l.outstanding, 0), + npaOutstanding: bad.reduce((a, l) => a + l.outstanding, 0) + }; + }).sort((a, b) => b.outstanding - a.outstanding), + notes: [ + 'Demo data: the figures are illustrative, not the bank’s books.', + 'Share linking to borrowing: members hold shares of 5% of unsecured and 2.5% of secured loans (UCBs keeping CRAR of 12% on a continuous basis are exempt).', + 'Classification as per RBI IRAC norms on days past due (90+ days = NPA; Sub-standard up to 12 months as NPA, then Doubtful D1 / D2 / D3).', + 'Eligibility uses each product’s rules: age, age at maturity, monthly income, FOIR, loans per customer and, for loans against FD, the LTV on the deposit.' + ] + }; +} + +export function demoBorrowers(category: BorrowerCategory | '', search: string): Borrower[] { + const q = search.trim().toLowerCase(); + return BOOK.filter((c) => !category || categoryOf(c) === category) + .filter((c) => !q || c.name.toLowerCase().includes(q) || c.accountNo.includes(q)) + .map((c) => toBorrower(c, false)) + .sort( + (a, b) => + b.maxDpd - a.maxDpd || b.eligibleProducts - a.eligibleProducts || a.clientName.localeCompare(b.clientName) + ); +} + +export function demoBorrower(clientId: number): Borrower | undefined { + const c = BOOK.find((x) => x.id === clientId); + return c ? toBorrower(c, true) : undefined; +} diff --git a/src/app/loan-eligibility/loan-eligibility.module.ts b/src/app/loan-eligibility/loan-eligibility.module.ts new file mode 100644 index 000000000..01f9c7e46 --- /dev/null +++ b/src/app/loan-eligibility/loan-eligibility.module.ts @@ -0,0 +1,15 @@ +/** + * Copyright since 2025 Mifos Initiative + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +import { NgModule } from '@angular/core'; +import { LoanEligibilityRoutingModule } from './loan-eligibility-routing.module'; + +@NgModule({ + imports: [LoanEligibilityRoutingModule] +}) +export class LoanEligibilityModule {} diff --git a/src/app/loan-eligibility/loan-eligibility.service.ts b/src/app/loan-eligibility/loan-eligibility.service.ts new file mode 100644 index 000000000..f4255571d --- /dev/null +++ b/src/app/loan-eligibility/loan-eligibility.service.ts @@ -0,0 +1,154 @@ +/** + * Copyright since 2025 Mifos Initiative + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +import { Injectable } from '@angular/core'; +import { Observable, delay, of, throwError } from 'rxjs'; +import { demoBorrower, demoBorrowers, demoSummary } from './loan-eligibility.mock'; + +export type BorrowerCategory = 'GOOD' | 'WATCH' | 'BAD'; + +export interface LoanStageRow { + stage: string; + label: string; + dpdRange: string; + group: 'PERFORMING' | 'NPA' | 'CLOSED'; + loans: number; + outstanding: number; + overdue: number; +} + +export interface LoanProductRow { + productId: number; + productName: string; + activeLoans: number; + performingLoans: number; + npaLoans: number; + outstanding: number; + npaOutstanding: number; +} + +/** Loan book health as on the business date (RBI asset classes, products, borrowers). */ +export interface LoanEligibilitySummary { + asOnDate: string; + activeLoans: number; + activeOutstanding: number; + performingLoans: number; + performingOutstanding: number; + npaLoans: number; + npaOutstanding: number; + grossNpaPct: number; + closedLoans: number; + writtenOffLoans: number; + writtenOffAmount: number; + /** Share linking to borrowing across members with running loans. */ + shareRequired: number; + shareHeld: number; + shareShortMembers: number; + shareShortfall: number; + goodBorrowers: number; + watchBorrowers: number; + badBorrowers: number; + stages: LoanStageRow[]; + products: LoanProductRow[]; + notes: string[]; +} + +export interface BorrowerLoan { + loanId: number; + accountNo: string; + productName: string; + status: string; + stage: string; + dpd: number; + emisPaid: number; + emisLate: number; + disbursed: number; + outstanding: number; + overdue: number; + sharePct: number; + shareRequired: number; +} + +export interface AccountMonth { + month: string; + credits: number; + debits: number; + avgBalance: number; + returns: number; +} + +/** Savings / current account statement, month by month. */ +export interface BorrowerAccount { + type: 'Savings' | 'Current'; + accountNo: string; + months: AccountMonth[]; +} + +export interface ProductEligibility { + productId: number; + productName: string; + eligible: boolean; + eligibleAmount?: number; + sharePct: number; + /** Shares to be taken with this loan (incl. any existing shortfall). */ + shareToBuy?: number; + netInHand?: number; + minAmount?: number; + maxAmount?: number; + passed: string[]; + failed: string[]; + notes: string[]; +} + +export interface Borrower { + clientId: number; + clientName: string; + clientAccountNo: string; + category: BorrowerCategory; + activeLoans: number; + closedLoans: number; + writtenOffLoans: number; + outstanding: number; + maxDpd: number; + worstStage?: string; + monthlyIncome?: number; + age?: number; + depositBalance: number; + currentEmi: number; + eligibleProducts: number; + /** Repayment record over all loans: EMIs fallen due and how many were paid late. */ + emisPaid: number; + emisLate: number; + shareHeld: number; + shareRequired: number; + /** Six-month averages of the operative account. */ + accountType: 'Savings' | 'Current'; + avgCredits: number; + avgDebits: number; + returns: number; + accounts?: BorrowerAccount[]; + loans?: BorrowerLoan[]; + eligibility?: ProductEligibility[]; +} + +/** Loan Eligibility (AI / Intelligence – Lending & Risk): demo data, worked out on the eligibility rules. */ +@Injectable({ providedIn: 'root' }) +export class LoanEligibilityService { + getSummary(): Observable { + return of(demoSummary()).pipe(delay(2800)); + } + + getBorrowers(category: BorrowerCategory | '', search: string): Observable { + return of(demoBorrowers(category, search)).pipe(delay(700)); + } + + getBorrower(clientId: number): Observable { + const b = demoBorrower(clientId); + return b ? of(b).pipe(delay(900)) : throwError(() => new Error('Borrower not found')); + } +}