@en-solutions/tgm-client-sdk 1.6.21

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

@@ -0,0 +1,294 @@
+import { ComponentType, ComponentCategory, ComponentInfoType, ComponentInfoCategory, ComponentInfoStatus, MeteringParameterType, MeteringParameterSubType, AssetPhase } from '../enums';
+import { Failure } from './failure.models';
+import { StrapiFile } from './media.models';
+export interface Component {
+    id: number;
+    name: string;
+    code?: string;
+    description?: string;
+    type?: ComponentType;
+    category?: ComponentCategory;
+    status?: ComponentInfoStatus;
+    isActive?: boolean;
+    isSubComponent?: boolean;
+    hasSubComponent?: boolean;
+    isMultiple?: boolean;
+    numberOfInstances?: string;
+    native?: boolean;
+    deleted?: boolean;
+    uuid?: string;
+    externalId?: string;
+    note?: string;
+    /** JSON string — additional parameters blob */
+    additionalParameters?: string;
+    /** JSON string — running conditions per mode (e.g. Full, Dewatered) */
+    runningConditions?: string;
+    /** JSON string — 3D model metadata */
+    threedMeta?: string;
+    installationDate?: string;
+    expectedLifespanYears?: number;
+    replacementDate?: string;
+    nameEn?: string;
+    nameFr?: string;
+    nameDe?: string;
+    namePt?: string;
+    nameEs?: string;
+    nameSw?: string;
+    descriptionEn?: string;
+    descriptionFr?: string;
+    descriptionDe?: string;
+    descriptionPt?: string;
+    descriptionEs?: string;
+    descriptionSw?: string;
+    glbFileId?: number;
+    /** @transient — populated by backend, GLB 3D model download URL */
+    glbFileUrl?: string;
+    usdzFileId?: number;
+    /** @transient — populated by backend, USDZ 3D model download URL */
+    usdzFileUrl?: string;
+    unitId?: number;
+    parentComponentId?: number;
+    /** @deprecated Lives on ComponentInfo, not Component — kept for backward compatibility */
+    manufacturer?: string;
+    /** @deprecated Lives on ComponentInfo, not Component — kept for backward compatibility */
+    model?: string;
+    /** @deprecated Lives on ComponentInfo, not Component — kept for backward compatibility */
+    serialNumber?: string;
+    /** @deprecated Use `installationDate` instead */
+    installDate?: string;
+    /** @deprecated Lives on ComponentInfo, not Component — kept for backward compatibility */
+    warrantyEndDate?: string;
+    customFields?: Record<string, any>;
+    group?: any;
+    parentComponent?: any;
+    children?: any[];
+    /** Many-to-many: a component can belong to multiple units */
+    units?: any[];
+    subAssembly?: any;
+    plant?: any;
+    sensors?: any[];
+    /** @transient — populated by backend media system */
+    images?: StrapiFile[];
+    /**
+     * Present when loaded with `populate=failures` (or `populate=failures,failures.failureCauses,failures.failureCauses.failureActions`).
+     * Not returned by default.
+     */
+    failures?: Failure[];
+    componentChecklistData?: any[];
+    componentChecklists?: any[];
+    turbineTypes?: any[];
+    associatedAssets?: any[];
+    drawings?: StrapiFile[];
+    plan?: StrapiFile;
+    threedfiles?: StrapiFile[];
+    conditionAssessmentTests?: any[];
+    name_en?: string;
+    name_fr?: string;
+    name_de?: string;
+    name_pt?: string;
+    name_es?: string;
+    name_sw?: string;
+    description_en?: string;
+    description_fr?: string;
+    description_de?: string;
+    description_pt?: string;
+    description_es?: string;
+    description_sw?: string;
+    parent_component?: any;
+    child_components?: any[];
+    sub_assembly?: any;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type ComponentCreateRequest = Partial<Omit<Component, 'id' | 'createdAt' | 'updatedAt' | 'failures' | 'children' | 'sensors' | 'componentChecklistData' | 'turbineTypes' | 'associatedAssets'>>;
+export type ComponentUpdateRequest = ComponentCreateRequest;
+export interface ComponentGroup {
+    id: number;
+    name: string;
+    description?: string;
+    isActive?: boolean;
+    code?: string;
+    slug?: string;
+    native?: boolean;
+    /** Strapi content-type discriminator (e.g. "asset") */
+    strapiType?: string;
+    nameEn?: string;
+    nameFr?: string;
+    nameDe?: string;
+    namePt?: string;
+    nameEs?: string;
+    nameSw?: string;
+    descriptionEn?: string;
+    descriptionFr?: string;
+    descriptionDe?: string;
+    descriptionPt?: string;
+    descriptionEs?: string;
+    descriptionSw?: string;
+    unitId?: number;
+    deleted?: boolean;
+    type?: 'plant' | 'hybridPlant' | 'instrumentation' | 'asset' | 'piping' | 'protectionControl' | 'other' | string;
+    name_en?: string;
+    name_fr?: string;
+    name_de?: string;
+    name_pt?: string;
+    name_es?: string;
+    name_sw?: string;
+    description_en?: string;
+    description_fr?: string;
+    description_de?: string;
+    description_pt?: string;
+    description_es?: string;
+    description_sw?: string;
+    sub_assembly?: any;
+    subAssembly?: any;
+    components?: any[];
+    parent?: any;
+    sensors?: any[];
+    conditionAssessmentTests?: any[];
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type ComponentGroupCreateRequest = Partial<Omit<ComponentGroup, 'id' | 'createdAt' | 'updatedAt' | 'components'>>;
+export type ComponentGroupUpdateRequest = ComponentGroupCreateRequest;
+export interface SubAssembly {
+    id: number;
+    name: string;
+    code?: string;
+    description?: string;
+    isActive?: boolean;
+    native?: boolean;
+    uuid?: string;
+    /** Strapi content-type discriminator (e.g. "asset") */
+    strapiType?: string;
+    componentId?: number;
+    nameEn?: string;
+    nameFr?: string;
+    nameDe?: string;
+    namePt?: string;
+    nameEs?: string;
+    nameSw?: string;
+    /**
+     * Unit IDs linked to this sub-assembly.
+     * Present when loaded with `populate=units`.
+     */
+    units?: {
+        id: number;
+        name?: string;
+    }[];
+    group?: any;
+    components?: any[];
+    inspections?: any[];
+    interventions?: any[];
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type SubAssemblyCreateRequest = Partial<Omit<SubAssembly, 'id' | 'createdAt' | 'updatedAt' | 'components' | 'inspections' | 'interventions'>>;
+export type SubAssemblyUpdateRequest = SubAssemblyCreateRequest;
+export interface InactiveComponent {
+    id: number;
+    componentId?: number;
+    component?: Component;
+    unitId?: number;
+    unit?: {
+        id: number;
+        name?: string;
+    };
+    reason?: string;
+    deactivatedAt?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface ComponentLocation {
+    id: number;
+    name?: string;
+    description?: string;
+    position?: 'erectionBay' | 'generatorPit' | 'underRotor' | 'turbinePit' | 'Other' | string;
+    floor?: string;
+    zone?: string;
+    inOutUnit?: 'In' | 'Out';
+    withinRoom?: boolean;
+    roomName?: string;
+    plantArea?: string;
+    elevation?: string;
+    otherFloorName?: string;
+    outsideLocation?: string;
+    assetEverywhere?: boolean;
+    component?: any;
+    unit?: any;
+    plant?: any;
+    location?: string;
+    altitude?: number;
+    latitude?: number;
+    longitude?: number;
+    componentId?: number;
+    locationId?: number;
+    installedAt?: string;
+    removedAt?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface ComponentInfo {
+    id: number;
+    componentId?: number;
+    /** @deprecated Use componentId instead — `component_r` was the legacy Strapi relation name */
+    component_r?: {
+        id: number;
+    };
+    component?: {
+        id: number;
+    };
+    uuid?: string;
+    type?: ComponentInfoType | string;
+    category?: ComponentInfoCategory | string;
+    status?: ComponentInfoStatus | string;
+    displayOrder?: number;
+    manufacturer?: string;
+    model?: string;
+    serialNumber?: string;
+    expectedLifespan?: number;
+    commissioningDate?: string;
+    expectedReplacementDate?: string;
+    warrantyPeriod?: number;
+    warrantyExpiryDate?: string;
+    installationDate?: string;
+    lifecycleStatus?: AssetPhase | string;
+    acquisitionCost?: number;
+    availability?: number;
+    assetConditionStatus?: string;
+    mtbf?: number;
+    mttr?: number;
+    meteringParameterType?: MeteringParameterType | string;
+    meteringParameterSubType?: MeteringParameterSubType | string;
+    meteringParameterValue?: number;
+    meteringParameterPassed?: boolean;
+    meteringParameterStartDate?: string;
+    /** JSON string — serialized technical specifications array */
+    technicalSpecifications?: string;
+    acquisitionPhaseData?: string;
+    operationalPhaseData?: string;
+    outOfServicePhaseData?: string;
+    rehabilitationPhaseData?: string;
+    disposalPhaseData?: string;
+    mpPlanAttachments?: string;
+    processesAttachments?: string;
+    drawingsAttachments?: string;
+    otherAttachments?: string;
+    unitId?: number;
+    unit?: {
+        id: number;
+        name?: string;
+    };
+    location?: any;
+    sensor?: any;
+    lifecycleHistory?: any[];
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type ComponentInfoCreateRequest = Partial<Omit<ComponentInfo, 'id' | 'createdAt' | 'updatedAt' | 'lifecycleHistory'>>;
+export type ComponentInfoUpdateRequest = ComponentInfoCreateRequest;

package/lib/models/api/cortex-edge.models.d.ts

@@ -0,0 +1,14 @@
+export interface CortexEdge {
+    id: number;
+    createdAt: string;
+    updatedAt: string;
+    referenceCode?: string;
+    sourceType: string;
+    sourceId: number;
+    targetType: string;
+    targetId: number;
+    edgeType: string;
+    weight: number;
+    properties: any;
+    lastUpdated: string;
+}

package/lib/models/api/cortex-event.models.d.ts

@@ -0,0 +1,12 @@
+export interface CortexEvent {
+    id: number;
+    createdAt: string;
+    updatedAt: string;
+    referenceCode?: string;
+    entityType: string;
+    entityId: number;
+    eventType: string;
+    eventData: any;
+    occurredAt: string;
+    processed: boolean;
+}

package/lib/models/api/cortex-insight.models.d.ts

@@ -0,0 +1,25 @@
+export interface CortexInsight {
+    id: number;
+    createdAt: string;
+    updatedAt: string;
+    referenceCode?: string;
+    patternType: string;
+    severity: string;
+    confidence: number;
+    title: string;
+    explanation: string;
+    financialImpact?: string;
+    primaryEntityType?: string;
+    primaryEntityId?: number;
+    relatedEntities?: any;
+    signals?: any;
+    context?: any;
+    recommendedActions?: any;
+    assumptions?: any;
+    acknowledged: boolean;
+    acknowledgedBy?: string;
+    acknowledgedAt?: string;
+    feedback?: string;
+    expiresAt?: string;
+    locationId?: number;
+}

package/lib/models/api/cortex-node.models.d.ts

@@ -0,0 +1,10 @@
+export interface CortexNode {
+    id: number;
+    createdAt: string;
+    updatedAt: string;
+    referenceCode?: string;
+    entityType: string;
+    entityId: number;
+    properties: any;
+    lastUpdated: string;
+}

package/lib/models/api/custom-field.models.d.ts

@@ -0,0 +1,37 @@
+import { CustomFieldType } from '../enums';
+export interface CustomFieldDefinition {
+    id: number;
+    entityType: string;
+    fieldName: string;
+    fieldType: CustomFieldType;
+    displayName?: string;
+    description?: string;
+    isRequired?: boolean;
+    defaultValue?: string;
+    validationRules?: Record<string, any>;
+    isActive?: boolean;
+    displayOrder?: number;
+    helpText?: string;
+    placeholder?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface CustomField {
+    id: number;
+    definitionId?: number;
+    entityId?: number;
+    entityType?: string;
+    value?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface CustomForm {
+    id: number;
+    name: string;
+    description?: string;
+    entityType?: string;
+    fields?: any;
+    createdAt?: string;
+    updatedAt?: string;
+}

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

@@ -0,0 +1,81 @@
+export interface DeferralEvaluation {
+    id?: number;
+    unitId?: number;
+    maintenanceRecordId?: number;
+    locationId?: number;
+    evaluatedBy?: string;
+    evaluatedAt?: string;
+    recommendation?: 'MAINTAIN_NOW' | 'DEFER' | 'MONITOR' | 'ESCALATE';
+    recommendedDeferralDays?: number;
+    confidenceLevel?: 'LOW' | 'MEDIUM' | 'HIGH';
+    expiresAt?: string;
+    expectedExtraRevenue?: number;
+    expectedRiskCost?: number;
+    netExpectedValue?: number;
+    worstCaseDownside?: number;
+    electricityPriceUsed?: number;
+    unitPowerMw?: number;
+    currentHealthIndex?: number;
+    currentRiskScore?: number;
+    projectedRiskScore?: number;
+    failureProbabilityBase?: number;
+    failureProbabilityDeferred?: number;
+    dominantRiskDriver?: 'SAFETY' | 'ENVIRONMENTAL' | 'AVAILABILITY' | 'COST';
+    hardConstraintViolated?: boolean;
+    hardConstraintReason?: string;
+    hseStatus?: string;
+    regulatoryStatus?: string;
+    oemStatus?: string;
+    monitoringConditions?: string;
+    shutdownThresholds?: any;
+    decisionStatus?: 'PENDING' | 'ACCEPTED' | 'OVERRIDDEN' | 'EXPIRED';
+    decisionBy?: string;
+    decisionAt?: string;
+    overrideReason?: string;
+    explanation?: string;
+    assumptions?: any;
+    optionsEvaluated?: DeferralOption[];
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface DeferralOption {
+    days: number;
+    revenue: number;
+    riskCost: number;
+    netValue: number;
+    adjustedNetValue: number;
+    failureProbability: number;
+    feasible: boolean;
+}
+export interface DeferralConstraintRule {
+    id?: number;
+    name?: string;
+    description?: string;
+    constraintType?: 'HSE' | 'REGULATORY' | 'OEM' | 'OPERATIONAL';
+    ruleType?: 'HARD' | 'SOFT';
+    entityType?: string;
+    fieldName?: string;
+    operator?: string;
+    thresholdValue?: string;
+    thresholdValueMax?: string;
+    penaltyCost?: number;
+    isActive?: boolean;
+    locationId?: number;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface EvaluateDeferralRequest {
+    unitId: number;
+    maintenanceRecordId: number;
+    maxDeferralDays?: number;
+    electricityPricePerMwh?: number;
+}
+export interface ConstraintCheckResult {
+    ruleName: string;
+    constraintType: string;
+    ruleType: string;
+    status: 'OK' | 'WARNING' | 'VIOLATED';
+    currentValue?: string;
+    threshold?: string;
+    message?: string;
+}

package/lib/models/api/diagnostic-report.models.d.ts

@@ -0,0 +1,29 @@
+import { StrapiFile } from './media.models';
+export type DiagnosticReportType = 'acoustic' | 'vibration';
+export type DiagnosticSeverity = 'normal' | 'acceptable' | 'alert' | 'danger';
+export interface DiagnosticReport {
+    id: number;
+    type: DiagnosticReportType;
+    severity: DiagnosticSeverity;
+    componentId?: number;
+    componentName?: string;
+    equipmentType?: string;
+    diagnosis?: string;
+    recommendation?: string;
+    confidenceScore?: number;
+    durationSeconds?: number;
+    fingerprint?: Record<string, any>;
+    metadata?: Record<string, any>;
+    maintenanceRecord?: number | {
+        id: number;
+    };
+    attachments?: StrapiFile[];
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type DiagnosticReportCreateRequest = Partial<Omit<DiagnosticReport, 'id' | 'createdAt' | 'updatedAt'>> & {
+    type: DiagnosticReportType;
+    severity: DiagnosticSeverity;
+};
+export type DiagnosticReportUpdateRequest = Partial<Omit<DiagnosticReport, 'id' | 'createdAt' | 'updatedAt'>>;

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

@@ -0,0 +1,95 @@
+import { StrapiFile } from './media.models';
+export interface TgFile {
+    id: number;
+    name: string;
+    description?: string;
+    folderId?: number;
+    size?: number;
+    mimeType?: string;
+    url?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface TgFolder {
+    id: number;
+    name: string;
+    description?: string;
+    parentId?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface Drawing {
+    id: number;
+    name: string;
+    number?: string;
+    description?: string;
+    type?: string;
+    uuid?: string;
+    drawingFile?: string;
+    downloadCount?: string;
+    revision?: string;
+    categoryId?: number;
+    unitId?: number;
+    componentId?: number;
+    drawingCategory?: any;
+    component?: any;
+    units?: any[];
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type DrawingCreateRequest = Partial<Omit<Drawing, 'id' | 'createdAt' | 'updatedAt'>>;
+export type DrawingUpdateRequest = DrawingCreateRequest;
+export interface DrawingCategory {
+    id: number;
+    name: string;
+    description?: string;
+    isActive?: boolean;
+    icon?: string;
+    nameEn?: string;
+    nameFr?: string;
+    nameDe?: string;
+    namePt?: string;
+    nameEs?: string;
+    nameSw?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type DrawingCategoryCreateRequest = Partial<Omit<DrawingCategory, 'id' | 'createdAt' | 'updatedAt'>>;
+export type DrawingCategoryUpdateRequest = DrawingCategoryCreateRequest;
+export interface Form {
+    id: number;
+    name: string;
+    description?: string;
+    schema?: string;
+    categoryId?: number;
+    /** FormCategory relation (when populated) */
+    category?: {
+        id: number;
+        name?: string;
+    };
+    isActive?: boolean;
+    templateData?: any;
+    attachments?: StrapiFile[];
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface FormCategory {
+    id: number;
+    name: string;
+    description?: string;
+    nameEn?: string;
+    nameFr?: string;
+    nameDe?: string;
+    namePt?: string;
+    nameEs?: string;
+    nameSw?: string;
+    isActive?: boolean;
+    icon?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}