@en-solutions/tgm-client-sdk 1.6.21

package/lib/models/api/project.models.d.ts

@@ -0,0 +1,118 @@
+export interface Project {
+    id: number;
+    name: string;
+    description?: string;
+    status?: string;
+    startDate?: string;
+    endDate?: string;
+    budget?: number;
+    managerId?: number;
+    companyId?: number;
+    customFields?: Record<string, any>;
+    location?: any;
+    manager?: any;
+    bid?: any;
+    bidId?: number;
+    actualCost?: number;
+    currency?: string;
+    priority?: string;
+    progress?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type ProjectCreateRequest = Partial<Omit<Project, 'id' | 'createdAt' | 'updatedAt'>>;
+export type ProjectUpdateRequest = ProjectCreateRequest;
+export interface CapexProject {
+    id: number;
+    name: string;
+    code?: string;
+    description?: string;
+    status?: string;
+    budget?: number;
+    actualCost?: number;
+    startDate?: string;
+    endDate?: string;
+    companyId?: number;
+    partOfRehabilitation?: boolean;
+    rehabilitationReportNumber?: string;
+    hasSignatureTesting?: boolean;
+    projectTarget?: string;
+    approvedBy?: any;
+    location?: any;
+    phases?: any[];
+    projectManagers?: any[];
+    units?: any[];
+    subAssemblies?: any[];
+    componentGroups?: any[];
+    components?: any[];
+    signatureTestingAttachments?: any[];
+    approvalDate?: string;
+    approvalStatus?: string;
+    category?: string;
+    currency?: string;
+    estimatedCost?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface Budget {
+    id: number;
+    name?: string;
+    description?: string;
+    year?: string;
+    reportNumber?: string;
+    comments?: string;
+    inputDate?: string;
+    reminderDate?: string;
+    category?: string;
+    amount?: string;
+    currency?: string;
+    spentAmount?: string;
+    remainingAmount?: string;
+    status?: string;
+    chargeCodes?: string;
+    periodicity?: any;
+    capex?: any;
+    omBudget?: any;
+    preventive?: any;
+    corrective?: any;
+    specialMaintenance?: any;
+    emergency?: any;
+    contingencies?: any;
+    materialProcurement?: any;
+    operations?: any;
+    phases?: any;
+    department?: any;
+    location?: any;
+    departmentId?: number;
+    locationId?: number;
+    /** @deprecated Use category */
+    categoryId?: number;
+    /** @deprecated Use spentAmount */
+    spent?: number;
+    /** @deprecated Use remainingAmount */
+    remaining?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface Bid {
+    id: number;
+    title?: string;
+    description?: string;
+    amount?: number;
+    status?: string;
+    interventionRequestId?: number;
+    project?: any;
+    supplier?: any;
+    assignees?: any[];
+    attachments?: any[];
+    currency?: string;
+    notes?: string;
+    submissionDate?: string;
+    validityDate?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}

package/lib/models/api/quality.models.d.ts

@@ -0,0 +1,153 @@
+import { RCAStatus, RCAMethodology, CAPAStatus, CAPAType, FishboneCategory, RcaEventCause, RcaWorkOrderType } from '../enums';
+export interface RootCauseAnalysis {
+    id: number;
+    rcaNumber?: string;
+    title?: string;
+    description?: string;
+    status?: RCAStatus;
+    methodology?: RCAMethodology;
+    priority?: string;
+    eventId?: number;
+    failureId?: number;
+    interventionId?: number;
+    problemStatement?: string;
+    problemDate?: string;
+    impactDescription?: string;
+    analysisDate?: string;
+    startedAt?: string;
+    completedAt?: string;
+    publishedAt?: string;
+    elaborationDate?: string;
+    eventDate?: string;
+    rootCause?: string;
+    rootCauseCategory?: string;
+    contributingFactors?: string;
+    immediateCauses?: string;
+    recommendations?: string;
+    lessonsLearned?: string;
+    findings?: string;
+    initiatorId?: number;
+    leadAnalystId?: number;
+    teamMembers?: number[];
+    staffInvolved?: number[];
+    reviewedById?: number;
+    reviewedAt?: string;
+    reviewNotes?: string;
+    approvedById?: number;
+    approvedAt?: string;
+    affectedEquipment?: Record<string, any>[];
+    relatedDocuments?: Record<string, any>[];
+    notes?: string;
+    eventCause?: RcaEventCause;
+    eventCauseDetails?: string;
+    workOrderReportNumber?: string;
+    workOrderCode?: string;
+    workOrderType?: RcaWorkOrderType;
+    involvedWorkOrders?: any;
+    sseIncident?: any;
+    workshopLocation?: any;
+    locationId?: number;
+    workOrderSummary?: any;
+    failureModeIds?: any;
+    reportNumber?: string;
+    eventTime?: string;
+    assessmentDate?: string;
+    typeOfMeeting?: string;
+    workshopLocationPlace?: string;
+    platform?: string;
+    otherPlatform?: string;
+    rca1?: string;
+    rca2?: string;
+    rca3?: string;
+    rca4?: string;
+    rca5?: string;
+    rootCauseAnalysis?: any;
+    componentSelected?: number;
+    fiveWhyAnalyses?: FiveWhyAnalysis[];
+    fishboneCauses?: FishboneCause[];
+    correctiveActions?: any[];
+    capas?: CAPA[];
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface FiveWhyAnalysis {
+    id: number;
+    rcaId?: number;
+    whyNumber?: number;
+    question?: string;
+    answer?: string;
+    isRootCause?: boolean;
+    verified?: boolean;
+    createdAt?: string;
+}
+export interface FishboneCause {
+    id: number;
+    rcaId?: number;
+    category?: FishboneCategory;
+    cause?: string;
+    isInvestigated?: boolean;
+    riskLevel?: string;
+    createdAt?: string;
+}
+export interface CAPA {
+    id: number;
+    capaNumber?: string;
+    title: string;
+    description?: string;
+    capaType: CAPAType;
+    status: CAPAStatus;
+    priority?: string;
+    problemStatement?: string;
+    impactDescription?: string;
+    riskAssessment?: string;
+    rootCause?: string;
+    actionPlan?: string;
+    implementationDetails?: string;
+    resourcesRequired?: string;
+    estimatedCost?: number;
+    actualCost?: number;
+    identifiedDate?: string;
+    dueDate?: string;
+    implementationDate?: string;
+    verificationDate?: string;
+    closureDate?: string;
+    verificationMethod?: string;
+    verificationResult?: string;
+    effectivenessRating?: number;
+    effectivenessEvidence?: string;
+    preventiveMeasures?: string;
+    recurrencePrevention?: string;
+    affectedAreas?: string[];
+    relatedDocuments?: string[];
+    notes?: string;
+    rcaId?: number;
+    sourceEventId?: number;
+    sourceFailureId?: number;
+    ownerId?: number;
+    assignedToId?: number;
+    verifiedById?: number;
+    approvedById?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface SystemicRiskAssessment {
+    id: number;
+    title?: string;
+    description?: string;
+    riskLevel?: string;
+    content?: string;
+    isActive?: boolean;
+    source?: 'workshops' | 'workOrders' | 'library' | string;
+    riskIdentification?: string;
+    elaborationDate?: string;
+    location?: any;
+    users?: any[];
+    unitId?: number;
+    findings?: string;
+    recommendations?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}

package/lib/models/api/reporting.models.d.ts

@@ -0,0 +1,76 @@
+export type ReportType = 'MAINTENANCE_SUMMARY' | 'INSPECTION_COMPLIANCE' | 'EQUIPMENT_HEALTH' | 'FAILURE_ANALYSIS' | 'TECHNICIAN_PERFORMANCE' | 'COST_ANALYSIS' | 'RESERVOIR_OPERATIONS' | 'WATER_QUALITY' | 'REGULATORY_COMPLIANCE' | 'ALERT_ANALYSIS';
+export type ReportFormat = 'PDF' | 'EXCEL' | 'CSV';
+export type ReportSchedule = 'NONE' | 'DAILY' | 'WEEKLY' | 'MONTHLY';
+export type ReportStatus = 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
+export type DeliveryMethod = 'DOWNLOAD' | 'EMAIL';
+export interface ReportDefinition {
+    id: number;
+    name: string;
+    description?: string;
+    reportType: ReportType;
+    reportFormat: ReportFormat;
+    schedule: ReportSchedule;
+    deliveryMethod: DeliveryMethod;
+    filters?: Record<string, any>;
+    parameters?: Record<string, any>;
+    emailRecipients?: string;
+    enabled: boolean;
+    lastRunAt?: string;
+    nextRunAt?: string;
+    runCount: number;
+    companyId?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface GeneratedReport {
+    id: number;
+    reportDefinition?: ReportDefinition;
+    reportName: string;
+    reportType: ReportType;
+    reportFormat: ReportFormat;
+    status: ReportStatus;
+    recordCount: number;
+    fileSizeBytes?: number;
+    fileName?: string;
+    errorMessage?: string;
+    startedAt?: string;
+    completedAt?: string;
+    filtersApplied?: Record<string, any>;
+    companyId?: number;
+    generatedBy?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface ReportTemplate {
+    type: ReportType;
+    name: string;
+    description: string;
+    supportedFormats: ReportFormat[];
+    availableFilters: string[];
+}
+export interface GenerateReportRequest {
+    reportType: ReportType;
+    reportFormat?: ReportFormat;
+    filters?: Record<string, any>;
+}
+export interface CreateReportDefinitionRequest {
+    name: string;
+    description?: string;
+    reportType: ReportType;
+    reportFormat?: ReportFormat;
+    schedule?: ReportSchedule;
+    deliveryMethod?: DeliveryMethod;
+    filters?: Record<string, any>;
+    parameters?: Record<string, any>;
+    emailRecipients?: string;
+    enabled?: boolean;
+    companyId?: number;
+}
+export type UpdateReportDefinitionRequest = Partial<CreateReportDefinitionRequest>;
+export interface ReportStats {
+    totalDefinitions: number;
+    byStatus: Record<string, number>;
+    byType: Record<string, number>;
+}

package/lib/models/api/reservoir-websocket.models.d.ts

@@ -0,0 +1,48 @@
+export type SensorDisplayStatus = 'normal' | 'warning' | 'critical';
+export interface SensorDisplayInfo {
+    status: SensorDisplayStatus;
+    formattedValue: string;
+}
+/** Single sensor reading emitted on the sensors topic. */
+export interface ReservoirSensorMessage {
+    sensorId: string;
+    value: number;
+    unit: string;
+    timestamp: string;
+    display: SensorDisplayInfo;
+}
+/** Bulk synchronized message containing multiple sensor readings at the same timestamp. */
+export interface ReservoirBulkSensorMessage {
+    timestamp: string;
+    readings: ReservoirSensorMessage[];
+}
+/** Union type — what the `sensors$` observable emits. */
+export type ReservoirSensorEvent = ReservoirSensorMessage | ReservoirBulkSensorMessage;
+/** Type guard: check if a sensor event is a bulk message. */
+export declare function isBulkSensorMessage(msg: ReservoirSensorEvent): msg is ReservoirBulkSensorMessage;
+export type ExternalDataType = 'WEATHER' | 'GRID_MARKET' | 'LABORATORY' | 'FISH_MONITORING' | 'REGULATORY_UPDATE';
+/** External data message emitted on the external topic. */
+export interface ReservoirExternalMessage {
+    dataType: ExternalDataType;
+    reservoirId: string;
+    timestamp: string;
+    data: unknown;
+}
+export type ManualDataType = 'MANUAL_READING' | 'INSPECTION' | 'OBSERVATION';
+/** Manual data message emitted on the manual topic. */
+export interface ReservoirManualMessage {
+    dataType: ManualDataType;
+    reservoirId: string;
+    timestamp: string;
+    data: unknown;
+}
+export type StatusDataType = 'ALERT' | 'SYSTEM_EVENT';
+export type StatusEventType = 'GATE_OPERATION' | 'ALERT_TRIGGERED' | 'ALERT_ACKNOWLEDGED' | 'ALERT_CLEARED' | string;
+/** Status/alert message emitted on the status topic. */
+export interface ReservoirStatusMessage {
+    dataType: StatusDataType;
+    type: StatusEventType;
+    reservoirId: string;
+    timestamp: string;
+    data: unknown;
+}

package/lib/models/api/reservoir.models.d.ts

@@ -0,0 +1,274 @@
+import { GateType, SampleType, VerificationStatus, ObservationCategory, ObservationSeverity, SurveyMethod, AIScenarioType, RegulatoryUpdateType, MonitoringMethod, MonitoringLocationType, ReadingType } from '../enums';
+export interface GateSystem {
+    id: number;
+    gateId?: string;
+    gateType?: GateType;
+    name?: string;
+    description?: string;
+    status?: string;
+    physicalCharacteristics?: Record<string, any>;
+    controlSystem?: Record<string, any>;
+    operationalLimits?: Record<string, any>;
+    locationId?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type GateSystemCreateRequest = Partial<Omit<GateSystem, 'id' | 'createdAt' | 'updatedAt'>>;
+export type GateSystemUpdateRequest = GateSystemCreateRequest;
+export interface AlertDefinition {
+    id: number;
+    name?: string;
+    description?: string;
+    alertCategory?: string;
+    severityLevel?: string;
+    enabled?: boolean;
+    triggerConditions?: Record<string, any>;
+    notificationSettings?: Record<string, any>;
+    displayTemplate?: Record<string, any>;
+    locationId?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type AlertDefinitionCreateRequest = Partial<Omit<AlertDefinition, 'id' | 'createdAt' | 'updatedAt'>>;
+export type AlertDefinitionUpdateRequest = AlertDefinitionCreateRequest;
+export interface ManualReading {
+    id: number;
+    readingDate?: string;
+    readingType?: ReadingType;
+    location?: string;
+    gaugeId?: string;
+    value?: number;
+    unit?: string;
+    verificationStatus?: VerificationStatus;
+    notes?: string;
+    operatorId?: number;
+    locationId?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type ManualReadingCreateRequest = Partial<Omit<ManualReading, 'id' | 'createdAt' | 'updatedAt'>>;
+export type ManualReadingUpdateRequest = ManualReadingCreateRequest;
+export interface LaboratoryResult {
+    id: number;
+    sampleType?: SampleType;
+    sampleDate?: string;
+    sampleLocation?: string;
+    labName?: string;
+    labReportId?: string;
+    parameters?: any;
+    reportUrl?: string;
+    notes?: string;
+    zoneName?: string;
+    sedimentRemovalOperationId?: number;
+    locationId?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type LaboratoryResultCreateRequest = Partial<Omit<LaboratoryResult, 'id' | 'createdAt' | 'updatedAt'>>;
+export type LaboratoryResultUpdateRequest = LaboratoryResultCreateRequest;
+export interface FishMonitoring {
+    id: number;
+    monitoringDate?: string;
+    monitoringLocation?: string;
+    monitoringLocationType?: MonitoringLocationType;
+    speciesCounts?: Record<string, any>;
+    environmentalConditions?: Record<string, any>;
+    monitoringMethod?: MonitoringMethod;
+    notes?: string;
+    locationId?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type FishMonitoringCreateRequest = Partial<Omit<FishMonitoring, 'id' | 'createdAt' | 'updatedAt'>>;
+export type FishMonitoringUpdateRequest = FishMonitoringCreateRequest;
+export interface RegulatoryUpdate {
+    id: number;
+    title?: string;
+    updateType?: RegulatoryUpdateType;
+    issuingAgency?: string;
+    description?: string;
+    actionRequired?: string;
+    dueDate?: string;
+    status?: string;
+    documents?: Record<string, any>[];
+    locationId?: number;
+    permitId?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type RegulatoryUpdateCreateRequest = Partial<Omit<RegulatoryUpdate, 'id' | 'createdAt' | 'updatedAt'>>;
+export type RegulatoryUpdateUpdateRequest = RegulatoryUpdateCreateRequest;
+export interface OperationalObservation {
+    id: number;
+    title?: string;
+    category?: ObservationCategory;
+    description?: string;
+    severity?: ObservationSeverity;
+    followUpRequired?: boolean;
+    photos?: Record<string, any>[];
+    status?: string;
+    operatorId?: number;
+    locationId?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type OperationalObservationCreateRequest = Partial<Omit<OperationalObservation, 'id' | 'createdAt' | 'updatedAt'>>;
+export type OperationalObservationUpdateRequest = OperationalObservationCreateRequest;
+export interface BathymetricSurvey {
+    id: number;
+    surveyDate?: string;
+    surveyMethod?: SurveyMethod;
+    coveragePercentage?: number;
+    totalCapacity?: number;
+    sedimentVolume?: number;
+    zones?: Record<string, any>[];
+    reportUrl?: string;
+    notes?: string;
+    locationId?: number;
+    nextSurveyScheduled?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type BathymetricSurveyCreateRequest = Partial<Omit<BathymetricSurvey, 'id' | 'createdAt' | 'updatedAt'>>;
+export type BathymetricSurveyUpdateRequest = BathymetricSurveyCreateRequest;
+export interface AIScenario {
+    id: number;
+    name?: string;
+    type?: AIScenarioType;
+    description?: string;
+    confidence?: number;
+    selected?: boolean;
+    implemented?: boolean;
+    implementedAt?: string;
+    simulationInputs?: any;
+    metrics?: any;
+    dispatchPlan?: any;
+    waterReserveForecast?: any;
+    risks?: any;
+    turbineCombinations?: any;
+    pros?: any;
+    cons?: any;
+    recommendations?: any;
+    locationId?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type AIScenarioCreateRequest = Partial<Omit<AIScenario, 'id' | 'createdAt' | 'updatedAt'>>;
+export type AIScenarioUpdateRequest = AIScenarioCreateRequest;
+export interface TimeSeriesQueryParams {
+    start: string;
+    end: string;
+    interval?: string;
+    aggregation?: string;
+    max_points?: number;
+    fields?: string;
+}
+export interface TimeSeriesResponse {
+    data: Record<string, any>[];
+    meta?: {
+        total_raw_points?: number;
+        returned_points?: number;
+        aggregation_applied?: string;
+        interval?: string;
+    };
+}
+export interface GateOperateRequest {
+    operation: string;
+    targetPosition: number;
+    operatorId: number;
+    reason?: string;
+}
+export interface AlertAcknowledgeRequest {
+    acknowledgedBy: string;
+}
+export interface ElevationStorageCurve {
+    id?: number;
+    locationId?: number;
+    surveyDate?: string;
+    points?: Array<{
+        elevation: number;
+        volume: number;
+        surfaceArea?: number;
+    }>;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type ElevationStorageCurveCreateRequest = Partial<Omit<ElevationStorageCurve, 'id' | 'createdAt' | 'updatedAt'>>;
+export type ElevationStorageCurveUpdateRequest = ElevationStorageCurveCreateRequest;
+export interface SedimentRemovalOperation {
+    id?: number;
+    locationId?: number;
+    bathymetricSurveyId?: number;
+    primaryZoneName?: string;
+    operationType?: 'mechanical_dredging' | 'hydraulic_flushing' | 'sediment_bypass' | 'disposal' | 'other';
+    title?: string;
+    description?: string;
+    startDate?: string;
+    endDate?: string;
+    volumeRemovedM3?: number;
+    totalCost?: number;
+    currency?: string;
+    status?: 'planned' | 'evaluating' | 'scheduled' | 'in_progress' | 'completed' | 'cancelled';
+    contractor?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type SedimentRemovalOperationCreateRequest = Partial<Omit<SedimentRemovalOperation, 'id' | 'createdAt' | 'updatedAt'>>;
+export type SedimentRemovalOperationUpdateRequest = SedimentRemovalOperationCreateRequest;
+export interface SedimentManagementPlan {
+    id?: number;
+    locationId?: number;
+    currentStrategy?: {
+        method?: string;
+        frequency?: string;
+        costPerYear?: number;
+        effectivenessPercent?: number;
+    };
+    alternativeOptions?: {
+        sedimentBypassCost?: number;
+        upstreamControlCost?: number;
+        hybridApproach?: string;
+    };
+    operationCostEstimates?: {
+        dredgingCost?: number;
+        disposalCost?: number;
+        unit?: string;
+    };
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type SedimentManagementPlanCreateRequest = Partial<Omit<SedimentManagementPlan, 'id' | 'createdAt' | 'updatedAt'>>;
+export type SedimentManagementPlanUpdateRequest = SedimentManagementPlanCreateRequest;
+export interface TimeSeriesCoverage {
+    minTime?: string;
+    maxTime?: string;
+    pointCount?: number;
+}
+export interface InflowForecastResponse {
+    run?: {
+        run_id?: string;
+        model?: string;
+        generated_at?: string;
+        interval?: string;
+    };
+    data?: Array<{
+        timestamp: string;
+        inflow_m3s: number;
+        confidence?: number;
+        p10_m3s?: number;
+        p50_m3s?: number;
+        p90_m3s?: number;
+    }>;
+}

package/lib/models/api/search.models.d.ts

@@ -0,0 +1,30 @@
+export interface SearchRequest {
+    query: string;
+    locale?: string;
+    page?: number;
+    pageSize?: number;
+}
+export interface UnifiedSearchResponse {
+    query: string;
+    strategy: 'structured' | 'fulltext';
+    description?: string;
+    entity?: string;
+    filters?: Record<string, string>;
+    sort?: string;
+    apiUrl?: string;
+    results?: any[];
+    total?: number;
+    error?: string;
+    suggestions?: string[];
+}
+export interface NaturalSearchResponse {
+    query: string;
+    understood: boolean;
+    description?: string;
+    entity?: string;
+    filters?: Record<string, string>;
+    sort?: string;
+    apiUrl?: string;
+    error?: string;
+    suggestions?: string[];
+}