feat(chequebook): add cheque book module with Maker-Checker workflow

Adds cheque series creation, stock receive, cheque leaf request/lookup, and stop-payment/lost-reporting flows with Maker-Checker approval and a checker-inbox tab for pending chequebook requests.
2026-07-15 11:02:46 +05:30
parent b9856a1c93
commit 7abfa394df
40 changed files with 4892 additions and 2 deletions
@@ -0,0 +1,136 @@
+<!--
+  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/.
+-->
+
+<div class="container">
+  <div class="page-header">
+    <h2>{{ 'labels.inputs.Cheque Series' | translate }}</h2>
+    <div class="header-actions">
+      <button mat-raised-button color="primary" (click)="showForm = !showForm">
+        <fa-icon icon="plus"></fa-icon>&nbsp;{{ 'labels.buttons.Add Cheque Series' | translate }}
+      </button>
+      <button mat-raised-button [routerLink]="['/chequebook']">{{ 'labels.buttons.Back' | translate }}</button>
+    </div>
+  </div>
+
+  @if (showForm) {
+    <mat-card class="add-form">
+      <mat-card-content>
+        <form [formGroup]="seriesForm" (ngSubmit)="submit()">
+          <div class="form-grid">
+            <mat-form-field appearance="fill">
+              <mat-label>{{ 'labels.inputs.Series Code' | translate }}</mat-label>
+              <input matInput formControlName="seriesCode" placeholder="CTS-25" required />
+            </mat-form-field>
+            <mat-form-field appearance="fill">
+              <mat-label>{{ 'labels.inputs.Name' | translate }}</mat-label>
+              <input matInput formControlName="name" required />
+            </mat-form-field>
+            <mat-form-field appearance="fill">
+              <mat-label>{{ 'labels.inputs.Leaves Per Book' | translate }}</mat-label>
+              <input matInput type="number" formControlName="leavesPerBook" required />
+            </mat-form-field>
+            <mat-form-field appearance="fill">
+              <mat-label>{{ 'labels.inputs.Applicable Account Type' | translate }}</mat-label>
+              <mat-select formControlName="applicableAccountType" required>
+                <mat-option value="SAVINGS">{{ 'labels.inputs.Savings Only' | translate }}</mat-option>
+                <mat-option value="CURRENT">{{ 'labels.inputs.Current Only' | translate }}</mat-option>
+              </mat-select>
+              <mat-hint>{{ 'labels.text.SB and CA cheque stationery differ' | translate }}</mat-hint>
+            </mat-form-field>
+            <mat-form-field appearance="fill">
+              <mat-label>{{ 'labels.inputs.Reorder Level' | translate }}</mat-label>
+              <input matInput type="number" formControlName="reorderLevel" />
+              <mat-hint>{{ 'labels.text.Low-stock alert threshold (remaining leaves)' | translate }}</mat-hint>
+            </mat-form-field>
+          </div>
+          <mat-checkbox formControlName="ctsCompliant">{{
+            'labels.inputs.CTS-2010 Compliant' | translate
+          }}</mat-checkbox>
+          <div class="form-actions">
+            <button mat-raised-button type="button" (click)="showForm = false">
+              {{ 'labels.buttons.Cancel' | translate }}
+            </button>
+            <button mat-raised-button color="primary" type="submit" [disabled]="seriesForm.invalid || busy">
+              {{ 'labels.buttons.Submit' | translate }}
+            </button>
+          </div>
+        </form>
+      </mat-card-content>
+    </mat-card>
+  }
+
+  <div class="filter-row">
+    @for (s of ['ACTIVE', 'INACTIVE']; track s) {
+      <button mat-stroked-button [class.active]="statusFilter === s" (click)="filterByStatus(s)">{{ s }}</button>
+    }
+  </div>
+
+  <div class="table-wrapper mat-elevation-z1">
+    <table mat-table [dataSource]="seriesList">
+      <ng-container matColumnDef="seriesCode">
+        <th mat-header-cell *matHeaderCellDef>{{ 'labels.inputs.Series Code' | translate }}</th>
+        <td mat-cell *matCellDef="let s">{{ s.seriesCode }}</td>
+      </ng-container>
+      <ng-container matColumnDef="name">
+        <th mat-header-cell *matHeaderCellDef>{{ 'labels.inputs.Name' | translate }}</th>
+        <td mat-cell *matCellDef="let s">{{ s.name }}</td>
+      </ng-container>
+      <ng-container matColumnDef="leavesPerBook">
+        <th mat-header-cell *matHeaderCellDef class="num">{{ 'labels.inputs.Leaves Per Book' | translate }}</th>
+        <td mat-cell *matCellDef="let s" class="num">{{ s.leavesPerBook }}</td>
+      </ng-container>
+      <ng-container matColumnDef="applicableAccountType">
+        <th mat-header-cell *matHeaderCellDef>{{ 'labels.inputs.Applicable Account Type' | translate }}</th>
+        <td mat-cell *matCellDef="let s">
+          <span class="pill neutral">{{ s.applicableAccountType }}</span>
+        </td>
+      </ng-container>
+      <ng-container matColumnDef="ctsCompliant">
+        <th mat-header-cell *matHeaderCellDef>{{ 'labels.inputs.CTS-2010 Compliant' | translate }}</th>
+        <td mat-cell *matCellDef="let s">
+          <span class="pill" [ngClass]="s.ctsCompliant ? 'ok' : 'neutral'">{{ s.ctsCompliant ? 'Yes' : 'No' }}</span>
+        </td>
+      </ng-container>
+      <ng-container matColumnDef="reorderLevel">
+        <th mat-header-cell *matHeaderCellDef class="num">{{ 'labels.inputs.Reorder Level' | translate }}</th>
+        <td mat-cell *matCellDef="let s" class="num">{{ s.reorderLevel ?? '-' }}</td>
+      </ng-container>
+      <ng-container matColumnDef="active">
+        <th mat-header-cell *matHeaderCellDef>{{ 'labels.inputs.Status' | translate }}</th>
+        <td mat-cell *matCellDef="let s">
+          <span class="pill" [ngClass]="s.active ? 'ok' : 'neutral'">{{ s.active ? 'Active' : 'Inactive' }}</span>
+        </td>
+      </ng-container>
+      <ng-container matColumnDef="actions">
+        <th mat-header-cell *matHeaderCellDef></th>
+        <td mat-cell *matCellDef="let s">
+          @if (s.active) {
+            <button mat-icon-button color="warn" (click)="deactivate(s)">
+              <mat-icon><fa-icon icon="trash"></fa-icon></mat-icon>
+            </button>
+          }
+        </td>
+      </ng-container>
+      <tr mat-header-row *matHeaderRowDef="columns"></tr>
+      <tr mat-row *matRowDef="let row; columns: columns"></tr>
+    </table>
+    @if (seriesList.length === 0) {
+      <div class="empty-state">{{ 'labels.text.No records to display' | translate }}</div>
+    }
+    @if (totalRecords > 0) {
+      <mat-paginator
+        [length]="totalRecords"
+        [pageSize]="pageSize"
+        [pageSizeOptions]="pageSizeOptions"
+        [pageIndex]="pageIndex"
+        showFirstLastButtons
+        (page)="onPageChange($event)"
+      ></mat-paginator>
+    }
+  </div>
+</div>
@@ -0,0 +1,93 @@
+/**
+ * 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/.
+ */
+
+.container {
+  padding: 16px;
+}
+
+.page-header {
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+  margin-bottom: 16px;
+}
+
+.header-actions {
+  display: flex;
+  gap: 12px;
+}
+
+.filter-row {
+  display: flex;
+  gap: 8px;
+  margin-bottom: 16px;
+
+  button.active {
+    background: rgb(25 118 210 / 12%);
+  }
+}
+
+.add-form {
+  margin-bottom: 16px;
+}
+
+.form-grid {
+  display: grid;
+  grid-template-columns: repeat(auto-fill, minmax(220px, 1fr));
+  gap: 12px 20px;
+  margin-bottom: 8px;
+}
+
+mat-form-field {
+  width: 100%;
+}
+
+.form-actions {
+  display: flex;
+  justify-content: flex-end;
+  gap: 12px;
+  margin-top: 16px;
+}
+
+.table-wrapper {
+  overflow-x: auto;
+  background: #fff;
+}
+
+table {
+  width: 100%;
+}
+
+td.num,
+th.num {
+  text-align: right;
+  font-variant-numeric: tabular-nums;
+}
+
+.pill {
+  font-size: 11px;
+  padding: 2px 8px;
+  border-radius: 6px;
+  font-weight: 600;
+
+  &.ok {
+    background: #dff5e8;
+    color: #28c07a;
+  }
+
+  &.neutral {
+    background: #e0e0e0;
+    color: #757575;
+  }
+}
+
+.empty-state {
+  padding: 24px;
+  text-align: center;
+  color: rgb(0 0 0 / 50%);
+}
@@ -0,0 +1,176 @@
+/**
+ * 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/.
+ */
+
+/** Angular Imports */
+import { Component, OnInit, inject } from '@angular/core';
+import { UntypedFormBuilder, UntypedFormGroup, Validators } from '@angular/forms';
+import { RouterLink } from '@angular/router';
+import { MatIconModule } from '@angular/material/icon';
+import { MatButtonModule } from '@angular/material/button';
+import { MatTableModule } from '@angular/material/table';
+import { MatPaginatorModule, PageEvent } from '@angular/material/paginator';
+import { MatSnackBar, MatSnackBarModule } from '@angular/material/snack-bar';
+import { MatDialog } from '@angular/material/dialog';
+import { FaIconComponent } from '@fortawesome/angular-fontawesome';
+import { STANDALONE_SHARED_IMPORTS } from 'app/standalone-shared.module';
+
+/** Custom Services */
+import { ChequeBookService } from '../chequebook.service';
+import { DeleteDialogComponent } from 'app/shared/delete-dialog/delete-dialog.component';
+
+/** Cheque-leaf stationery master — leaves per book, CTS-2010 compliance, low-stock reorder threshold. */
+@Component({
+  selector: 'mifosx-cheque-series',
+  templateUrl: './cheque-series.component.html',
+  styleUrls: ['./cheque-series.component.scss'],
+  imports: [
+    ...STANDALONE_SHARED_IMPORTS,
+    RouterLink,
+    MatIconModule,
+    MatButtonModule,
+    MatTableModule,
+    MatPaginatorModule,
+    MatSnackBarModule,
+    FaIconComponent
+  ]
+})
+export class ChequeSeriesComponent implements OnInit {
+  private formBuilder = inject(UntypedFormBuilder);
+  private chequeBookService = inject(ChequeBookService);
+  private dialog = inject(MatDialog);
+  private snackBar = inject(MatSnackBar);
+
+  private notify(message: string, isError = false): void {
+    this.snackBar.open(message, 'Dismiss', { duration: isError ? 6000 : 3000 });
+  }
+
+  seriesList: any[] = [];
+  showForm = false;
+  busy = false;
+
+  statusFilter = '';
+  pageSize = 10;
+  pageIndex = 0;
+  totalRecords = 0;
+  pageSizeOptions = [
+    10,
+    25,
+    50,
+    100
+  ];
+
+  seriesForm: UntypedFormGroup;
+
+  columns = [
+    'seriesCode',
+    'name',
+    'leavesPerBook',
+    'applicableAccountType',
+    'ctsCompliant',
+    'reorderLevel',
+    'active',
+    'actions'
+  ];
+
+  constructor() {
+    this.seriesForm = this.formBuilder.group({
+      seriesCode: [
+        '',
+        Validators.required
+      ],
+      name: [
+        '',
+        Validators.required
+      ],
+      leavesPerBook: [
+        25,
+        Validators.required
+      ],
+      applicableAccountType: [
+        '',
+        Validators.required
+      ],
+      ctsCompliant: [true],
+      reorderLevel: [10]
+    });
+  }
+
+  ngOnInit(): void {
+    this.loadSeries();
+  }
+
+  loadSeries(): void {
+    this.chequeBookService
+      .getSeries(this.statusFilter || undefined, this.pageIndex * this.pageSize, this.pageSize)
+      .subscribe((res: any) => {
+        this.seriesList = res?.pageItems ?? [];
+        this.totalRecords = Number(res?.totalFilteredRecords ?? 0);
+      });
+  }
+
+  filterByStatus(status: string): void {
+    this.statusFilter = this.statusFilter === status ? '' : status;
+    this.pageIndex = 0;
+    this.loadSeries();
+  }
+
+  onPageChange(event: PageEvent): void {
+    this.pageSize = event.pageSize;
+    this.pageIndex = event.pageIndex;
+    this.loadSeries();
+  }
+
+  submit(): void {
+    if (this.seriesForm.invalid || this.busy) {
+      return;
+    }
+    this.busy = true;
+    const raw = this.seriesForm.value;
+    const payload: any = {
+      seriesCode: raw.seriesCode,
+      name: raw.name,
+      leavesPerBook: raw.leavesPerBook,
+      applicableAccountType: raw.applicableAccountType,
+      ctsCompliant: !!raw.ctsCompliant,
+      locale: 'en'
+    };
+    if (raw.reorderLevel !== '' && raw.reorderLevel != null) payload.reorderLevel = raw.reorderLevel;
+
+    this.chequeBookService.createSeries(payload).subscribe({
+      next: () => {
+        this.busy = false;
+        this.showForm = false;
+        this.seriesForm.reset({ leavesPerBook: 25, applicableAccountType: '', ctsCompliant: true, reorderLevel: 10 });
+        this.notify('Submitted for approval — see Approvals > Cheque Book Requests');
+        this.loadSeries();
+      },
+      error: () => {
+        this.busy = false;
+        this.notify('Failed to add cheque series', true);
+      }
+    });
+  }
+
+  deactivate(series: any): void {
+    const dialogRef = this.dialog.open(DeleteDialogComponent, {
+      data: { deleteContext: `cheque series ${series.seriesCode}` }
+    });
+    dialogRef.afterClosed().subscribe((response: any) => {
+      if (!response?.delete) {
+        return;
+      }
+      this.chequeBookService.deactivateSeries(series.id).subscribe({
+        next: () => {
+          this.notify('Submitted for approval — see Approvals > Cheque Book Requests');
+          this.loadSeries();
+        },
+        error: () => this.notify('Failed to submit for approval', true)
+      });
+    });
+  }
+}