Skip to main content

Documentation Index

Fetch the complete documentation index at: https://grantmaster.dev/llms.txt

Use this file to discover all available pages before exploring further.

Compliance Vault

Module ID: compliance-vault | Category: Compliance | Trust: Internal

Purpose

Provides grant compliance document management, audit trails, compliance checklists, deadline tracking, and risk assessments. This is the most widely used extension — referenced by features/admin, features/auditor, and features/compliance.

Collections

CollectionUninstallDescription
complianceDocumentsretainPolicy docs, certifications, financial reports
complianceAuditTrailretainImmutable event log of compliance actions
complianceChecklistsretainTemplate and instance checklists
complianceDeadlinesretainGrant reporting and regulatory deadlines
riskAssessmentsretainRisk evaluation records

Key Types

interface ComplianceDocument {
  id: string;
  organizationId: string;
  title: string;
  category: 'policy' | 'audit_report' | 'certification' | 'financial_report'
           | 'narrative_report' | 'irs_filing' | 'insurance' | 'contract' | 'other';
  status: 'draft' | 'under_review' | 'approved' | 'expired' | 'archived';
  fileUrl: string;
  grantIds: string[];
  tags: string[];
  expiresAt?: string;
  assignedApproverId?: string;
  escalatedAt?: string;
}

interface ComplianceDeadline {
  id: string;
  organizationId: string;
  title: string;
  grantName: string;
  dueDate: string;
  priority: 'low' | 'medium' | 'high' | 'critical';
  isCompleted: boolean;
}

interface ComplianceChecklist {
  id: string;
  organizationId: string;
  title: string;
  items: ChecklistItem[];
  completedCount: number;
  totalCount: number;
}

Services

ServiceKey Methods
ComplianceDocumentServiceuploadDocument, updateStatus(id, status, actorId, actorName, orgId), listByOrganization, listByGrant, deleteDocument
AuditTrailServicelogEvent(event), getByOrganization(orgId, limit), getByEntity(entityId)
ChecklistServicecreateChecklist, updateItem, completeChecklist
DeadlineServicecreateDeadline, updateDeadline, listUpcoming, markComplete
RiskAssessmentServicecreateAssessment, updateAssessment, getByGrant
ComplianceVaultSettingsServicegetSettings, saveSettings

Events Consumed

EventBehavior
GRANT_CREATEDCreates default compliance checklist for the grant
GRANT_UPDATEDUpdates deadline references if grant end date changes
GRANT_WONTriggers initial reporting deadline creation

Events Emitted

EventTrigger
COMPLIANCE_ALERT_RAISEDDocument status → under_review with escalation
COMPLIANCE_ALERT_RESOLVEDDocument approved or deadline completed

Permissions

VIEW_COMPLIANCE_VAULT, MANAGE_COMPLIANCE_VAULT, ADMIN_COMPLIANCE_VAULT

Consumed By

  • features/admin — reads complianceDocuments for approval queue; complianceDeadlines for timeline
  • features/auditor — reads audit trail, configuration snapshots
  • features/compliance — reads documents for compliance matrix
  • features/projects — compliance tab reads deadlines by project