Files
lcbp3/frontend/lib/api/numbering.ts
T
admin 25ea2fcd0f
CI / CD Pipeline / build (push) Successful in 15m6s
CI / CD Pipeline / deploy (push) Successful in 8m56s
260326:1726 Fixing Refactor ADR-019 Naming convention uuid #06
2026-03-26 17:26:28 +07:00

376 lines
12 KiB
TypeScript

import apiClient from '@/lib/api/client';
// ============================================================
// Types - aligned with backend entities
// ============================================================
/**
* Document Number Format/Template
* Matches: backend/src/modules/document-numbering/entities/document-number-format.entity.ts
*/
export interface NumberingTemplate {
id: number;
projectId: number | string;
correspondenceTypeId: number | null; // null = Default Format for project
correspondenceType?: {
id: number;
typeCode: string;
typeName: string;
} | null;
project?: {
id: number | string;
projectCode: string;
projectName: string;
publicId?: string; // ADR-019: exposed as 'id' in API responses
};
formatTemplate: string;
disciplineId: number;
description?: string;
resetSequenceYearly: boolean; // Controls yearly counter reset
isActive: number;
createdAt?: string;
updatedAt?: string;
}
/**
* DTO for creating/updating templates
*/
export interface SaveTemplateDto {
id?: number; // If present, update; otherwise create
projectId: number | string;
correspondenceTypeId: number | null;
formatTemplate: string;
disciplineId?: number;
description?: string;
resetSequenceYearly?: boolean;
isActive?: number;
}
/**
* Document Number Audit Log
* Matches: backend/src/modules/document-numbering/entities/document-number-audit.entity.ts
*/
export interface DocumentNumberAudit {
id: number;
documentId: number;
generatedNumber: string;
counterKey: Record<string, unknown>;
templateUsed: string;
operation: 'RESERVE' | 'CONFIRM' | 'MANUAL_OVERRIDE' | 'VOID_REPLACE' | 'CANCEL';
metadata?: Record<string, unknown>;
userId: number;
ipAddress?: string;
retryCount: number;
lockWaitMs?: number;
totalDurationMs?: number;
fallbackUsed?: 'NONE' | 'DB_LOCK' | 'RETRY';
createdAt: string;
}
/**
* Document Number Error Log
*/
export interface DocumentNumberError {
id: number;
errorMessage: string;
stackTrace?: string;
context?: Record<string, unknown>;
userId?: number;
ipAddress?: string;
createdAt: string;
resolvedAt?: string;
}
/**
* Manual Override DTO
*/
export interface ManualOverrideDto {
projectId: number;
correspondenceTypeId: number | null;
year: number;
newValue: number;
}
/**
* Void and Replace DTO
*/
export interface VoidAndReplaceDto {
documentId: number;
reason: string;
}
/**
* Cancel Number DTO
*/
export interface CancelNumberDto {
documentNumber: string;
reason: string;
}
/**
* Bulk Import Item
*/
export interface BulkImportItem {
projectId: number;
correspondenceTypeId: number | null;
year: number;
lastNumber: number;
}
// ============================================================
// API Client
// ============================================================
export const numberingApi = {
// ----------------------------------------------------------
// Template Management (Admin endpoints)
// ----------------------------------------------------------
/**
* Get all templates
*/
getTemplates: async (): Promise<NumberingTemplate[]> => {
const res = await apiClient.get<unknown>('/admin/document-numbering/templates');
const data = res.data as { data: NumberingTemplate[] } | NumberingTemplate[];
return Array.isArray(data) ? data : (data as { data: NumberingTemplate[] }).data || [];
},
/**
* Get templates for a specific project
*/
getTemplatesByProject: async (projectId: number): Promise<NumberingTemplate[]> => {
const res = await apiClient.get<unknown>(`/admin/document-numbering/templates?projectId=${projectId}`);
const data = res.data as { data: NumberingTemplate[] } | NumberingTemplate[];
return Array.isArray(data) ? data : (data as { data: NumberingTemplate[] }).data || [];
},
/**
* Get single template by ID
*/
getTemplate: async (id: number): Promise<NumberingTemplate | undefined> => {
const templates = await numberingApi.getTemplates();
return templates.find((t) => t.id === id);
},
/**
* Save (create or update) a template
*/
saveTemplate: async (dto: SaveTemplateDto): Promise<NumberingTemplate> => {
// Clean the DTO to avoid sending nested objects that might confuse TypeORM or violate constraints
const cleanDto: Record<string, unknown> = {
id: dto.id,
projectId: dto.projectId,
correspondenceTypeId: dto.correspondenceTypeId,
disciplineId: dto.disciplineId || 0,
formatTemplate: dto.formatTemplate,
description: dto.description,
resetSequenceYearly: dto.resetSequenceYearly,
isActive: dto.isActive ?? 1,
};
const res = await apiClient.post<unknown>('/admin/document-numbering/templates', cleanDto);
const data = res.data as Record<string, unknown>;
return (data.id ? data : data.data) as NumberingTemplate;
},
/**
* Delete a template
*/
deleteTemplate: async (id: number): Promise<void> => {
await apiClient.delete(`/admin/document-numbering/templates/${id}`);
},
// ----------------------------------------------------------
// Logs (Requires system.view_logs permission)
// ----------------------------------------------------------
/**
* Get audit logs
*/
getAuditLogs: async (limit = 100): Promise<DocumentNumberAudit[]> => {
const res = await apiClient.get<unknown>(`/document-numbering/logs/audit?limit=${limit}`);
const data = res.data as { data: DocumentNumberAudit[] } | DocumentNumberAudit[];
return Array.isArray(data) ? data : (data as { data: DocumentNumberAudit[] }).data || [];
},
/**
* Get error logs
*/
getErrorLogs: async (limit = 100): Promise<DocumentNumberError[]> => {
const res = await apiClient.get<unknown>(`/document-numbering/logs/errors?limit=${limit}`);
const data = res.data as { data: DocumentNumberError[] } | DocumentNumberError[];
return Array.isArray(data) ? data : (data as { data: DocumentNumberError[] }).data || [];
},
/**
* Get metrics (audit + errors combined)
*/
getMetrics: async (): Promise<{ audit: DocumentNumberAudit[]; errors: DocumentNumberError[] }> => {
const res = await apiClient.get<unknown>('/admin/document-numbering/metrics');
const data = res.data as {
data?: { audit: DocumentNumberAudit[]; errors: DocumentNumberError[] };
audit?: DocumentNumberAudit[];
errors?: DocumentNumberError[];
};
return 'audit' in data
? (data as { audit: DocumentNumberAudit[]; errors: DocumentNumberError[] })
: data.data || { audit: [], errors: [] };
},
// ----------------------------------------------------------
// Admin Tools
// ----------------------------------------------------------
/**
* Manually override/set a counter value
*/
manualOverride: async (dto: ManualOverrideDto): Promise<{ success: boolean; message: string }> => {
const res = await apiClient.post<unknown>('/admin/document-numbering/manual-override', dto);
const data = res.data as { data?: { success: boolean; message: string }; success?: boolean; message?: string };
return 'success' in data
? (data as { success: boolean; message: string })
: data.data || { success: false, message: '' };
},
/**
* Void a document number and generate replacement
*/
voidAndReplace: async (dto: VoidAndReplaceDto): Promise<{ newNumber: string; auditId: number }> => {
const res = await apiClient.post<unknown>('/admin/document-numbering/void-and-replace', dto);
const data = res.data as { data?: { newNumber: string; auditId: number }; newNumber?: string; auditId?: number };
return 'newNumber' in data
? (data as { newNumber: string; auditId: number })
: data.data || { newNumber: '', auditId: 0 };
},
/**
* Cancel/skip a document number
*/
cancelNumber: async (dto: CancelNumberDto): Promise<{ success: boolean }> => {
const res = await apiClient.post<unknown>('/admin/document-numbering/cancel', dto);
const data = res.data as { data?: { success: boolean }; success?: boolean };
return 'success' in data ? (data as { success: boolean }) : data.data || { success: false };
},
/**
* Bulk import counter values
*/
bulkImport: async (items: BulkImportItem[]): Promise<{ imported: number; errors: string[] }> => {
const res = await apiClient.post<unknown>('/admin/document-numbering/bulk-import', items);
const data = res.data as { data?: { imported: number; errors: string[] }; imported?: number; errors?: string[] };
return 'imported' in data
? (data as { imported: number; errors: string[] })
: data.data || { imported: 0, errors: [] };
},
/**
* Update counter sequence value (Admin only)
*/
updateCounter: async (counterId: number, sequence: number): Promise<void> => {
await apiClient.patch(`/document-numbering/counters/${counterId}`, { sequence });
},
// ----------------------------------------------------------
// Placeholder Methods (Backend not yet implemented)
// ----------------------------------------------------------
/**
* Get all counter sequences
*/
getSequences: async (projectId?: number): Promise<NumberSequence[]> => {
const url = projectId ? `/document-numbering/sequences?projectId=${projectId}` : '/document-numbering/sequences';
const res = await apiClient.get<unknown>(url);
const data = res.data as { data: NumberSequence[] } | NumberSequence[];
return Array.isArray(data) ? data : (data as { data: NumberSequence[] }).data || [];
},
/**
* Preview what a document number would look like (without generating)
*/
previewNumber: async (ctx: {
projectId: number | string;
originatorOrganizationId: number | string;
correspondenceTypeId: number;
disciplineId?: number;
subTypeId?: number;
rfaTypeId?: number;
recipientOrganizationId?: number | string;
}): Promise<{ previewNumber: string; nextSequence: number; isDefault: boolean }> => {
// Preview what a document number would look like (without generating)
const res = await apiClient.post<unknown>('/document-numbering/preview', ctx);
const body = res.data as Record<string, unknown>;
// Drill down to find the actual data object
let current: Record<string, unknown> = body;
let depth = 0;
while (
current &&
typeof current === 'object' &&
!current.previewNumber &&
!current.number &&
current.data &&
depth < 3
) {
current = current.data as Record<string, unknown>;
depth++;
}
// Final extraction
const previewData = current;
const previewNumber =
((typeof current === 'string' ? current : previewData?.previewNumber || previewData?.number) as string) || '';
const nextSequence = (previewData?.nextSequence ?? previewData?.sequence ?? 0) as number;
const isDefault = previewData?.isDefault === true;
return {
previewNumber: previewNumber || JSON.stringify(body), // Fallback to body string if all else fails
nextSequence: nextSequence,
isDefault: isDefault,
};
},
/**
* Generate test number - Uses preview endpoint
* @deprecated Use previewNumber instead
*/
generateTestNumber: async (
_templateId: number,
_context: { organizationId: string; disciplineId: string }
): Promise<{ number: string }> => {
// Fallback mock for legacy UI - requires proper context for real use
const mockNumber = `TEST-${new Date().getFullYear()}-${String(Math.floor(Math.random() * 9999)).padStart(4, '0')}`;
return { number: mockNumber };
},
};
// ============================================================
// Types for Sequences
// ============================================================
/**
* Number Sequence / Counter record
*/
export interface NumberSequence {
projectId: number;
originatorId: number;
recipientOrganizationId: number;
typeId: number;
disciplineId: number;
year: number;
lastNumber: number;
}
/**
* Preview Number Context
*/
export interface PreviewNumberContext {
projectId: number;
originatorId: number;
typeId: number;
disciplineId?: number;
subTypeId?: number;
rfaTypeId?: number;
recipientOrganizationId?: number;
}