@en-solutions/tgm-client-sdk 1.6.21

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

@@ -0,0 +1,545 @@
+export interface AipSettings {
+    id?: number;
+    name?: string;
+    locationId?: number;
+    isActive?: boolean;
+    weightCondition?: number;
+    weightMonitoring?: number;
+    weightMaintenance?: number;
+    weightAge?: number;
+    riskThresholdLow?: number;
+    riskThresholdMedium?: number;
+    riskThresholdHigh?: number;
+    riskThresholdExtreme?: number;
+    mustDoMultiplier?: number;
+    safetyDriverBoost?: number;
+    environmentalDriverBoost?: number;
+    availabilityDriverBoost?: number;
+    costDriverBoost?: number;
+    discountRate?: number;
+    electricityPricePerMwh?: number;
+    laborRatePerHour?: number;
+    commissioningFactor?: number;
+    contingencyFactor?: number;
+    inflationRate?: number;
+    currency?: string;
+    planningHorizonYears?: number;
+    annualBudgetLimit?: number;
+    maxSimultaneousOutages?: number;
+    budgetLimitsByYear?: Record<string, number>;
+    outageRestrictions?: any[];
+    lastModifiedBy?: string;
+    changeReason?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface AipAssessment {
+    id?: number;
+    componentId?: number;
+    unitId?: number;
+    locationId?: number;
+    settingsId?: number;
+    healthIndex?: number;
+    conditionScore?: number;
+    monitoringScore?: number;
+    maintenanceScore?: number;
+    ageScore?: number;
+    pofScore?: number;
+    cofScore?: number;
+    riskScore?: number;
+    riskLevel?: 'LOW' | 'MEDIUM' | 'HIGH' | 'EXTREME';
+    cofSafety?: number;
+    cofEnvironmental?: number;
+    cofAvailability?: number;
+    cofCost?: number;
+    dominantDriver?: 'SAFETY' | 'ENVIRONMENTAL' | 'AVAILABILITY' | 'COST';
+    priorityScore?: number;
+    mustDo?: boolean;
+    recommendedAction?: 'DO_NOTHING' | 'MONITOR' | 'OPEX_MAINTENANCE' | 'REHABILITATION' | 'REPLACEMENT' | 'DESIGN_MODIFICATION';
+    recommendedYear?: number;
+    estimatedCost?: number;
+    confidenceScore?: number;
+    conditionEvidence?: any;
+    monitoringEvidence?: any;
+    maintenanceEvidence?: any;
+    ageEvidence?: any;
+    analysisDate?: string;
+    analysisVersion?: string;
+    notes?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface InvestmentOption {
+    id?: number;
+    assessmentId?: number;
+    actionType?: 'DO_NOTHING' | 'MONITOR' | 'OPEX_MAINTENANCE' | 'REHABILITATION' | 'REPLACEMENT' | 'DESIGN_MODIFICATION';
+    description?: string;
+    capitalCost?: number;
+    annualOpex?: number;
+    lifecycleCost?: number;
+    commissioningCost?: number;
+    contingencyCost?: number;
+    totalCost?: number;
+    npv?: number;
+    irr?: number;
+    bcr?: number;
+    paybackYears?: number;
+    residualRisk?: number;
+    riskReduction?: number;
+    extendedLifeYears?: number;
+    outageHours?: number;
+    leadTimeMonths?: number;
+    executionComplexity?: 'LOW' | 'MEDIUM' | 'HIGH';
+    targetYear?: number;
+    targetQuarter?: number;
+    optionScore?: number;
+    isRecommended?: boolean;
+    costBreakdown?: any;
+    sensitivityAnalysis?: any;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface AipPlan {
+    id?: number;
+    name?: string;
+    description?: string;
+    locationId?: number;
+    settingsId?: number;
+    status?: 'DRAFT' | 'ACTIVE' | 'APPROVED' | 'ARCHIVED';
+    startYear?: number;
+    endYear?: number;
+    totalCapex?: number;
+    totalOpex?: number;
+    mustDoCount?: number;
+    mustDoCost?: number;
+    currency?: string;
+    annualBreakdown?: any[];
+    riskTrajectory?: any[];
+    approvedBy?: string;
+    approvalDate?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface AipScenario {
+    id?: number;
+    name?: string;
+    description?: string;
+    planId?: number;
+    scenarioType?: 'BASELINE' | 'CONSERVATIVE' | 'AGGRESSIVE' | 'CUSTOM';
+    budgetFactor?: number;
+    totalCapex?: number;
+    deferredRisk?: number;
+    deferredCount?: number;
+    fundedCount?: number;
+    averageHealthAfter?: number;
+    averageRiskAfter?: number;
+    optimizationResult?: any;
+    isSelected?: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface AipOverview {
+    assetCount: number;
+    averageHealthIndex: number;
+    riskDistribution: Record<string, number>;
+    mustDoCount: number;
+    mustDoCost: number;
+    totalPlannedCapex: number;
+    topPriorities: AipAssessment[];
+    driverDistribution: Record<string, number>;
+    investmentByYear: Record<string, number>;
+}
+export interface GeneratePlanRequest {
+    locationId: number;
+    startYear: number;
+    endYear: number;
+}
+export interface SensitivityDataPoint {
+    value: number;
+    npv: number;
+    delta: number;
+}
+export interface SensitivityAnalysis {
+    discountRate: {
+        baseValue: number;
+        points: SensitivityDataPoint[];
+    };
+    electricityPrice: {
+        baseValue: number;
+        points: SensitivityDataPoint[];
+    };
+    costVariation: {
+        baseValue: number;
+        points: SensitivityDataPoint[];
+    };
+    tornado: {
+        factor: string;
+        lowNpv: number;
+        highNpv: number;
+        baseNpv: number;
+    }[];
+}
+export interface AipResourceConstraint {
+    id?: number;
+    planId?: number;
+    constraintType?: 'WORKFORCE' | 'MATERIAL' | 'CONTRACTOR' | 'OUTAGE_WINDOW';
+    resourceName?: string;
+    requiredQuantity?: number;
+    availableQuantity?: number;
+    conflictLevel?: 'BLOCKING' | 'WARNING' | 'RESOLVED';
+    optionId?: number;
+    startDate?: string;
+    endDate?: string;
+    skillset?: string;
+    leadTimeMonths?: number;
+    resolution?: string;
+    resolvedBy?: string;
+    resolvedAt?: string;
+    notes?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface AipNetworkNode {
+    id?: number;
+    locationId?: number;
+    nodeType?: 'SUBSTATION' | 'TRANSFORMER' | 'TRANSMISSION_LINE';
+    name?: string;
+    ratedCapacityMw?: number;
+    currentLoadMw?: number;
+    projectedLoadMw?: number;
+    utilizationPercent?: number;
+    status?: 'GREEN' | 'YELLOW' | 'RED';
+    n1Compliant?: boolean;
+    voltageLevel?: string;
+    constraintDescription?: string;
+    upstreamNodeId?: number;
+    notes?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface AipPerformanceRecord {
+    id?: number;
+    optionId?: number;
+    assessmentId?: number;
+    locationId?: number;
+    plannedCost?: number;
+    actualCost?: number;
+    costVariance?: number;
+    plannedStartDate?: string;
+    actualStartDate?: string;
+    plannedEndDate?: string;
+    actualEndDate?: string;
+    scheduleVarianceDays?: number;
+    plannedRiskReduction?: number;
+    actualRiskReduction?: number;
+    healthIndexBefore?: number;
+    healthIndexAfter?: number;
+    lessonsLearned?: string;
+    varianceRootCause?: string;
+    calibrationRecommendations?: any;
+    status?: 'IN_PROGRESS' | 'COMPLETED' | 'CANCELLED';
+    completedBy?: string;
+    completedAt?: string;
+    notes?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface CalibrationRecommendation {
+    parameter: string;
+    currentValue: number;
+    recommendedValue: number;
+    reason: string;
+    sampleSize: number;
+}
+export interface RecordActualsRequest {
+    actualCost: number;
+    actualStartDate: string;
+    actualEndDate: string;
+}
+export interface PoFBreakdown {
+    conditionBased?: number;
+    ageBased?: number;
+    dutyBased?: number;
+    environmentBased?: number;
+    overall?: number;
+}
+export interface CoFBreakdown {
+    safety?: number;
+    environmental?: number;
+    financial?: number;
+    serviceReliability?: number;
+    overall?: number;
+}
+export interface ProbabilityOfFailure {
+    score?: number;
+    level?: string;
+    breakdown?: PoFBreakdown;
+    trendDirection?: string;
+}
+export interface ConsequenceOfFailure {
+    score?: number;
+    level?: string;
+    breakdown?: CoFBreakdown;
+    dominantFactor?: string;
+}
+export interface RiskIndex {
+    value?: number;
+    level?: string;
+    category?: string;
+    acceptability?: string;
+}
+export interface RiskMetrics {
+    assessmentId?: number;
+    componentId?: number;
+    componentName?: string;
+    probabilityOfFailure?: ProbabilityOfFailure;
+    consequenceOfFailure?: ConsequenceOfFailure;
+    riskIndex?: RiskIndex;
+    mitigationOptions?: string[];
+    lastAssessmentDate?: string;
+}
+export interface CostBenefitAnalysis {
+    optionId?: number;
+    optionName?: string;
+    capitalCost?: number;
+    annualBenefit?: number;
+    npv?: number;
+    irr?: number;
+    bcr?: number;
+    paybackYears?: number;
+    riskReductionValue?: number;
+    avoidedOutageCost?: number;
+    residualValue?: number;
+    recommendation?: string;
+}
+export interface LifecycleCostAnalysis {
+    optionId?: number;
+    optionName?: string;
+    acquisitionCost?: number;
+    installationCost?: number;
+    annualOperatingCost?: number;
+    annualMaintenanceCost?: number;
+    disposalCost?: number;
+    totalLifecycleCost?: number;
+    annualizedCost?: number;
+    lifespanYears?: number;
+    yearlyBreakdown?: Record<string, number>[];
+}
+export interface PortfolioFinancialMetrics {
+    locationId?: number;
+    totalCapex?: number;
+    totalOpex?: number;
+    totalNpv?: number;
+    averageBcr?: number;
+    budgetUtilization?: number;
+    investmentsByCategory?: Record<string, number>;
+    investmentsByYear?: Record<string, number>;
+    riskReductionAchieved?: number;
+}
+export interface WorkflowUser {
+    userId?: number;
+    name?: string;
+    email?: string;
+    role?: string;
+}
+export interface WorkflowDefinition {
+    id?: number;
+    name?: string;
+    description?: string;
+    stages?: string[];
+    requiredApprovers?: number;
+    autoAdvance?: boolean;
+    isActive?: boolean;
+}
+export interface PendingApproval {
+    instanceId?: number;
+    investmentOptionId?: number;
+    optionName?: string;
+    currentStage?: string;
+    submitter?: WorkflowUser;
+    submittedAt?: string;
+    dueDate?: string;
+    priority?: string;
+    estimatedCost?: number;
+}
+export interface DecisionMetrics {
+    totalSubmitted?: number;
+    totalApproved?: number;
+    totalRejected?: number;
+    totalPending?: number;
+    averageApprovalTimeDays?: number;
+    approvalRate?: number;
+    byStage?: Record<string, number>;
+}
+export interface WorkforceCapacity {
+    locationId?: number;
+    totalHeadcount?: number;
+    availableHeadcount?: number;
+    utilization?: number;
+    bySkill?: Record<string, number>;
+    plannedAbsences?: number;
+    overtimeHoursAvailable?: number;
+    constraintPeriods?: {
+        startDate?: string;
+        endDate?: string;
+        reason?: string;
+    }[];
+}
+export interface ContractorResource {
+    id?: number;
+    companyName?: string;
+    specialty?: string;
+    availableFrom?: string;
+    availableTo?: string;
+    dailyRate?: number;
+    crewSize?: number;
+    rating?: number;
+    currentlyEngaged?: boolean;
+    locationId?: number;
+}
+export interface LoadForecast {
+    locationId?: number;
+    year?: number;
+    peakLoadMw?: number;
+    averageLoadMw?: number;
+    growthRate?: number;
+    seasonalPattern?: Record<string, number>;
+    confidenceInterval?: {
+        low?: number;
+        high?: number;
+    };
+}
+export interface TransmissionConstraint {
+    id?: number;
+    locationId?: number;
+    constraintType?: string;
+    affectedElement?: string;
+    currentLimit?: number;
+    projectedLoad?: number;
+    severity?: string;
+    mitigationOptions?: string[];
+    estimatedResolutionCost?: number;
+}
+export interface NetworkBottleneck {
+    id?: number;
+    locationId?: number;
+    elementName?: string;
+    elementType?: string;
+    utilizationPercent?: number;
+    capacityMw?: number;
+    currentFlowMw?: number;
+    impactedAssets?: number;
+    upgradeCost?: number;
+    priority?: string;
+}
+export interface ContingencyAnalysisResult {
+    scenario?: string;
+    impactedElements?: string[];
+    loadSheddingMw?: number;
+    voltageViolations?: number;
+    thermalOverloads?: number;
+    isSecure?: boolean;
+}
+export interface PowerFlowAnalysis {
+    locationId?: number;
+    analysisTimestamp?: string;
+    totalGeneration?: number;
+    totalLoad?: number;
+    losses?: number;
+    voltageProfile?: Record<string, number>;
+    contingencyResults?: ContingencyAnalysisResult[];
+    overloadedElements?: string[];
+}
+export interface GeoAsset {
+    assetId?: number;
+    name?: string;
+    type?: string;
+    latitude?: number;
+    longitude?: number;
+    riskLevel?: string;
+    healthIndex?: number;
+    status?: string;
+    lastAssessmentDate?: string;
+}
+export interface GeographicFilters {
+    riskLevel?: string;
+    assetType?: string;
+    minHealthIndex?: number;
+    maxHealthIndex?: number;
+    status?: string;
+}
+export interface RiskHeatmapData {
+    locationId?: number;
+    gridCells?: {
+        latitude?: number;
+        longitude?: number;
+        riskScore?: number;
+        assetCount?: number;
+    }[];
+    bounds?: {
+        north?: number;
+        south?: number;
+        east?: number;
+        west?: number;
+    };
+    maxRisk?: number;
+}
+export interface RegionalAnalysis {
+    locationId?: number;
+    regionName?: string;
+    assetCount?: number;
+    averageRisk?: number;
+    averageHealth?: number;
+    totalInvestment?: number;
+    criticalAssets?: number;
+    complianceRate?: number;
+}
+export interface ProximityAnalysis {
+    assessmentId?: number;
+    centerAsset?: GeoAsset;
+    radiusKm?: number;
+    nearbyAssets?: GeoAsset[];
+    sharedInfrastructure?: string[];
+    correlatedRisks?: string[];
+}
+export interface PerformanceMetrics {
+    locationId?: number;
+    period?: string;
+    totalProjects?: number;
+    completedOnTime?: number;
+    completedOnBudget?: number;
+    averageCostVariance?: number;
+    averageScheduleVariance?: number;
+    riskReductionAchieved?: number;
+    healthImprovementAverage?: number;
+    roi?: number;
+}
+export interface EstimationAccuracy {
+    locationId?: number;
+    costAccuracy?: number;
+    scheduleAccuracy?: number;
+    riskPredictionAccuracy?: number;
+    healthPredictionAccuracy?: number;
+    sampleSize?: number;
+    trendDirection?: string;
+    byCategory?: Record<string, number>;
+}
+export interface ContinuousImprovementMetric {
+    locationId?: number;
+    metricName?: string;
+    currentValue?: number;
+    previousValue?: number;
+    target?: number;
+    trend?: string;
+    improvementPercent?: number;
+    period?: string;
+}
+export interface RootCause {
+    id?: number;
+    recordId?: number;
+    category?: string;
+    description?: string;
+    impact?: string;
+    frequency?: number;
+    recommendation?: string;
+}