@en-solutions/tgm-client-sdk 1.6.21

package/lib/models/api/maintenance-record.models.d.ts

@@ -0,0 +1,100 @@
+import { WorkOrderStatus, Priority, MaintenanceType, CostAllocation, UnitStatus, OperatingMode, WaterLevel, InspectionType, InspectionNature, InspectionLevel, ReasonForInspection, CalendarPlanning, MeteringParameterType, MeteringParameterStatus, Periodicity, ReasonForIntervention, EventNature, YesNo } from '../enums';
+import { StrapiFile } from './media.models';
+import { RelevantInformation, ComponentInterventionStatus } from './intervention.models';
+import { ComponentInspectionStatus } from './inspection.models';
+export type MaintenanceRecordType = 'INSPECTION' | 'INTERVENTION';
+export interface MaintenanceRecord {
+    id: number;
+    recordType: MaintenanceRecordType;
+    reportNumber?: string;
+    title?: string;
+    status?: WorkOrderStatus;
+    priority?: Priority;
+    maintenanceType?: MaintenanceType;
+    plannedDate?: string;
+    startDate?: string;
+    scheduleDate?: string;
+    creationDate?: string;
+    costAllocation?: CostAllocation;
+    actionPlan?: string;
+    comments?: string;
+    relevantInformation?: RelevantInformation | string;
+    recommendations?: string;
+    estimatedRevenueShortFall?: string;
+    isRiskComponents?: boolean;
+    productInterruption?: string;
+    unitStatus?: UnitStatus;
+    operatingMode?: OperatingMode;
+    waterLevel?: WaterLevel;
+    systemIsolationCompleted?: boolean;
+    externalId?: string;
+    sevenDaysReminderSent?: boolean;
+    threeDaysReminderSent?: boolean;
+    sameDayReminderSent?: boolean;
+    inspectionType?: InspectionType;
+    inspectionNature?: InspectionNature;
+    inspectionLevel?: InspectionLevel;
+    reasonForInspection?: ReasonForInspection;
+    calendarPlanning?: CalendarPlanning;
+    meteringParameterType?: MeteringParameterType;
+    meteringParameterStatus?: MeteringParameterStatus;
+    meteringParameterValue?: string;
+    meteringParameterPassed?: string;
+    meteringParameterStartDate?: string;
+    periodicity?: Periodicity;
+    periodicityHash?: string;
+    hasardAnalysisCompleted?: boolean;
+    hasardAnalysisJSANumber?: string;
+    maintenanceJSA?: string;
+    maintenanceTimes?: string;
+    processedIndex?: string;
+    initialInspection?: string;
+    woGroupInformation?: string;
+    scheduleFollowUp?: boolean;
+    inspectionCategory?: string;
+    componentsInspectionStatus?: ComponentInspectionStatus[];
+    inspectionInOperationReason?: string;
+    locationId?: number;
+    reasonForIntervention?: ReasonForIntervention;
+    eventNature?: EventNature;
+    eventDescriptionType?: YesNo;
+    plannedOutageDuration?: string;
+    isProjectRelated?: boolean;
+    isMultiTeamsWork?: boolean;
+    immediate?: boolean;
+    interventionJSA?: string;
+    eventDescription?: string;
+    eventReportNumber?: string;
+    interventionCategory?: string;
+    interventionTimes?: string;
+    chargeCode?: string;
+    maintenanceReportNumber?: string;
+    phaseRef?: string;
+    potentialCause?: string;
+    componentsInterventionStatus?: ComponentInterventionStatus[];
+    groupsSelected?: number[];
+    unit?: any;
+    location?: any;
+    users?: any[];
+    initiator?: any;
+    departments?: any[];
+    subAssembly?: any;
+    attachments?: StrapiFile[];
+    components?: any[];
+    inspection?: any;
+    inspectionComponents?: any[];
+    intervention?: any;
+    legacyId?: number;
+    legacyType?: string;
+    maintenancePlan?: any;
+    worReportNumber?: string;
+    customFields?: Record<string, any>;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type MaintenanceRecordCreateRequest = Partial<Omit<MaintenanceRecord, 'id' | 'createdAt' | 'updatedAt'>> & {
+    recordType: MaintenanceRecordType;
+    reportNumber: string;
+};
+export type MaintenanceRecordUpdateRequest = Partial<Omit<MaintenanceRecord, 'id' | 'createdAt' | 'updatedAt' | 'recordType'>>;

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

@@ -0,0 +1,188 @@
+export interface MaintenancePlan {
+    id: number;
+    name: string;
+    description?: string;
+    planType?: string;
+    status?: string;
+    priority?: string;
+    frequencyType?: string;
+    frequencyValue?: number;
+    lastExecutedDate?: string;
+    nextScheduledDate?: string;
+    startDate?: string;
+    endDate?: string;
+    estimatedHours?: number;
+    estimatedCost?: number;
+    instructions?: string;
+    checklistTemplate?: string;
+    assetId?: number;
+    componentId?: number;
+    assignedToId?: number;
+    executionCount?: number;
+    isActive?: boolean;
+    notes?: string;
+    companyId?: number;
+    customFields?: Record<string, any>;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface RecurringEvent {
+    id: number;
+    name: string;
+    description?: string;
+    eventType?: string;
+    recurrencePattern?: string;
+    recurrenceInterval?: number;
+    dayOfWeek?: number;
+    dayOfMonth?: number;
+    monthOfYear?: number;
+    startDate?: string;
+    endDate?: string;
+    lastGeneratedDate?: string;
+    nextGenerationDate?: string;
+    templateTitle?: string;
+    templateDescription?: string;
+    templatePriority?: string;
+    assetId?: number;
+    componentId?: number;
+    assignedToId?: number;
+    generatedCount?: number;
+    maxOccurrences?: number;
+    isActive?: boolean;
+    leadTimeDays?: number;
+    companyId?: number;
+    customFields?: Record<string, any>;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface TimeEntry {
+    id: number;
+    userId?: number;
+    interventionId?: number;
+    inspectionId?: number;
+    startTime?: string;
+    endTime?: string;
+    hoursWorked?: number;
+    hourlyRate?: number;
+    totalCost?: number;
+    entryType?: string;
+    description?: string;
+    isApproved?: boolean;
+    approvedBy?: number;
+    approvedAt?: string;
+    notes?: string;
+    companyId?: number;
+    customFields?: Record<string, any>;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface ServiceLevelAgreement {
+    id: number;
+    name: string;
+    description?: string;
+    entityType?: string;
+    priorityFilter?: string;
+    responseTimeHours?: number;
+    resolutionTimeHours?: number;
+    escalationEnabled?: boolean;
+    firstEscalationRuleId?: number;
+    secondEscalationRuleId?: number;
+    firstEscalationAfterHours?: number;
+    secondEscalationAfterHours?: number;
+    isActive?: boolean;
+    notes?: string;
+    companyId?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface AssetLifecycle {
+    id: number;
+    componentId?: number;
+    reportNumber?: string;
+    phase?: string;
+    prevPhase?: string;
+    status?: string;
+    startDate?: string;
+    endDate?: string;
+    duration?: string;
+    reason?: string;
+    workOrderReportNumber?: string;
+    approvedById?: number;
+    unitId?: number;
+    plantId?: number;
+    componentInfoId?: number;
+    currentStage?: string;
+    healthScore?: number;
+    reliabilityScore?: number;
+    performanceEfficiency?: number;
+    acquisitionDate?: string;
+    acquisitionCost?: number;
+    vendorName?: string;
+    purchaseOrderNumber?: string;
+    warrantyExpiryDate?: string;
+    warrantyDetails?: string;
+    installationDate?: string;
+    commissioningDate?: string;
+    firstOperationalDate?: string;
+    installationCost?: number;
+    expectedUsefulLifeYears?: number;
+    expectedEndOfLife?: string;
+    actualEndOfLife?: string;
+    remainingUsefulLifeMonths?: number;
+    depreciationMethod?: string;
+    salvageValue?: number;
+    currentBookValue?: number;
+    accumulatedDepreciation?: number;
+    annualDepreciation?: number;
+    totalOperatingHours?: number;
+    totalCycles?: number;
+    totalOutputUnits?: number;
+    averageDailyUsageHours?: number;
+    totalMaintenanceCost?: number;
+    totalDowntimeHours?: number;
+    plannedDowntimeHours?: number;
+    unplannedDowntimeHours?: number;
+    totalFailures?: number;
+    mtbfHours?: number;
+    mttrHours?: number;
+    replacementRecommended?: boolean;
+    replacementReason?: string;
+    estimatedReplacementCost?: number;
+    replacementPriority?: string;
+    disposalDate?: string;
+    disposalMethod?: string;
+    disposalValue?: number;
+    disposalNotes?: string;
+    lastAssessmentDate?: string;
+    lastAssessedById?: number;
+    notes?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface LifecycleEvent {
+    id: number;
+    assetLifecycleId?: number;
+    eventType?: string;
+    eventDate?: string;
+    description?: string;
+    fromStage?: string;
+    toStage?: string;
+    stageChangeReason?: string;
+    costImpact?: number;
+    downtimeHours?: number;
+    healthScoreBefore?: number;
+    healthScoreAfter?: number;
+    interventionId?: number;
+    failureId?: number;
+    documents?: string;
+    recordedById?: number;
+    notes?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}

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

@@ -0,0 +1,261 @@
+import { StrapiFile } from './media.models';
+export interface MaterialItem {
+    id: number;
+    name: string;
+    description?: string;
+    /** Backend field name */
+    partNumber?: string;
+    /** Legacy SDK alias — same as partNumber */
+    code?: string;
+    serialNumber?: string;
+    manufacturer?: string;
+    model?: string;
+    quantity?: number;
+    unit?: string;
+    location?: string;
+    status?: string;
+    /** Backend field name */
+    minStockLevel?: number;
+    /** Legacy SDK alias — same as minStockLevel */
+    minimumQuantity?: number;
+    /** Backend field name */
+    maxStockLevel?: number;
+    /** Legacy SDK alias — same as maxStockLevel */
+    maxQuantity?: number;
+    reorderPoint?: number;
+    unitCost?: number;
+    currency?: string;
+    isActive?: boolean;
+    externalId?: string;
+    conditioning?: string;
+    storageArea?: string;
+    storagePosition?: string;
+    netWeight?: number;
+    length?: number;
+    width?: number;
+    height?: number;
+    volume?: number;
+    handlingInstructions?: string;
+    storageInstructions?: string;
+    hazardousMaterial?: boolean;
+    hasSubItems?: boolean;
+    typeOfUnit?: string;
+    category?: any;
+    supplier?: any;
+    component?: any;
+    unitRelation?: any;
+    locationRelation?: any;
+    type?: any;
+    parent?: any;
+    utilityProperty?: any;
+    categoryId?: number;
+    supplierId?: number;
+    pictures?: StrapiFile[];
+    supplierDocumentation?: StrapiFile[];
+    drawingAttachment?: StrapiFile[];
+    shippingNumber?: string;
+    drawingNumber?: string;
+    partBill?: string;
+    deliveryDate?: string;
+    inspectionDate?: string;
+    costCenter?: string;
+    reportMI?: string;
+    barcode?: string;
+    purchasedFollowingIntervention?: boolean;
+    company?: any;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type MaterialItemCreateRequest = Partial<Omit<MaterialItem, 'id' | 'createdAt' | 'updatedAt'>>;
+export type MaterialItemUpdateRequest = MaterialItemCreateRequest;
+export interface MaterialItemHistory {
+    id: number;
+    materialItemId?: number;
+    quantity?: number;
+    type?: string;
+    reason?: string;
+    performedById?: number;
+    createdAt?: string;
+}
+export interface MaterialCategory {
+    id: number;
+    name: string;
+    description?: string;
+    parentId?: number;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface SparePart {
+    id: number;
+    name: string;
+    code?: string;
+    componentId?: number;
+    materialItemId?: number;
+    quantity?: number;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface MaterialConsumable {
+    id: number;
+    name: string;
+    code?: string;
+    description?: string;
+    categoryId?: number;
+    quantity?: number;
+    unitCost?: number;
+    supplierId?: number;
+    supplierDocumentation?: StrapiFile[];
+    category?: any;
+    supplier?: any;
+    currency?: string;
+    expiryDate?: string;
+    histories?: any[];
+    isActive?: boolean;
+    location?: string;
+    manufacturer?: string;
+    minStockLevel?: number;
+    partNumber?: string;
+    status?: string;
+    unit?: string;
+    typeOfConsumable?: string;
+    utilityProperty?: string;
+    condition?: string;
+    storageArea?: string;
+    storagePosition?: string;
+    calibrationDate?: string;
+    calibrationExpirationDate?: string;
+    costCenter?: string;
+    reportMI?: string;
+    hazardousMaterial?: boolean;
+    purchasedFollowingIntervention?: boolean;
+    company?: any;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface MaterialInstrument {
+    id: number;
+    name: string;
+    code?: string;
+    description?: string;
+    serialNumber?: string;
+    calibrationDate?: string;
+    nextCalibrationDate?: string;
+    attachment?: StrapiFile | null;
+    attachments?: StrapiFile[];
+    supplierDocumentation?: StrapiFile | null;
+    attachmentFile?: any;
+    calibrationInterval?: string;
+    histories?: any[];
+    isActive?: boolean;
+    location?: string;
+    manufacturer?: string;
+    model?: string;
+    status?: string;
+    supplier?: any;
+    typeOfInstrument?: string;
+    quantity?: number;
+    unitCost?: number;
+    depreciationPeriod?: string;
+    purchaseYear?: string;
+    utilityProperty?: string;
+    typeOfUnit?: string;
+    condition?: string;
+    storageArea?: string;
+    storagePosition?: string;
+    costCenter?: string;
+    reportMI?: string;
+    hazardousMaterial?: boolean;
+    company?: any;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface MaterialTooling {
+    id: number;
+    name: string;
+    code?: string;
+    description?: string;
+    condition?: string;
+    location?: string;
+    attachments?: StrapiFile[];
+    supplierDocumentation?: StrapiFile[];
+    category?: any;
+    supplier?: any;
+    histories?: any[];
+    isActive?: boolean;
+    manufacturer?: string;
+    model?: string;
+    serialNumber?: string;
+    status?: string;
+    typeOfTooling?: string;
+    quantity?: number;
+    unitCost?: number;
+    depreciationPeriod?: string;
+    purchaseYear?: string;
+    utilityProperty?: string;
+    typeOfUnit?: string;
+    storageArea?: string;
+    storagePosition?: string;
+    calibrationDate?: string;
+    calibrationExpirationDate?: string;
+    costCenter?: string;
+    reportMI?: string;
+    hazardousMaterial?: boolean;
+    purchasedFollowingInterventions?: boolean;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface Model3D {
+    id: number;
+    name?: string;
+    description?: string;
+    type?: string;
+    format?: string;
+    version?: string;
+    status?: string;
+    url?: string;
+    thumbnailUrl?: string;
+    fileSize?: number;
+    metadata?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface MaterialConsumableCategory {
+    id: number;
+    name: string;
+    description?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface MaterialToolingCategory {
+    id: number;
+    name: string;
+    description?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface MaterialConsumableHistory {
+    id: number;
+    consumableId?: number;
+    quantity?: number;
+    type?: string;
+    createdAt?: string;
+}
+export interface MaterialInstrumentHistory {
+    id: number;
+    instrumentId?: number;
+    action?: string;
+    notes?: string;
+    createdAt?: string;
+}
+export interface MaterialToolingHistory {
+    id: number;
+    toolingId?: number;
+    action?: string;
+    notes?: string;
+    createdAt?: string;
+}

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

@@ -0,0 +1,106 @@
+/**
+ * Represents a single format variant (thumbnail, small, medium, large) of a StrapiFile.
+ */
+export interface StrapiFileFormat {
+    url: string;
+    width: number;
+    height: number;
+    size: number;
+    name: string;
+    hash: string;
+    ext: string;
+    mime: string;
+}
+/**
+ * Nested format variants for a StrapiFile.
+ * Each key is optional since not all variants are generated for every upload.
+ */
+export interface StrapiFileFormats {
+    thumbnail?: StrapiFileFormat;
+    small?: StrapiFileFormat;
+    medium?: StrapiFileFormat;
+    large?: StrapiFileFormat;
+}
+/**
+ * Represents a file/media object managed by the backend (mirrors StrapiFileDTO).
+ */
+export interface StrapiFile {
+    id: number;
+    name: string;
+    alternativeText?: string;
+    caption?: string;
+    width?: number;
+    height?: number;
+    formats?: StrapiFileFormats;
+    hash?: string;
+    ext?: string;
+    mime?: string;
+    size?: number;
+    url: string;
+    previewUrl?: string;
+    provider?: string;
+    provider_metadata?: any;
+    folderPath?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+/**
+ * Represents a client-facing article (from the platform CMS).
+ */
+export interface ClientArticle {
+    id: number;
+    platformArticleId?: number;
+    title: string;
+    slug?: string;
+    content?: string;
+    summary?: string;
+    category?: string;
+    articleCategories?: ClientArticleCategory[];
+    tags?: string;
+    author?: string;
+    coverImageUrl?: string;
+    isPublished?: boolean;
+    publishedAt?: string;
+    isFeatured?: boolean;
+    createdByName?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    titleEn?: string;
+    titleFr?: string;
+    titleDe?: string;
+    titlePt?: string;
+    titleEs?: string;
+    titleSw?: string;
+    contentEn?: string;
+    contentFr?: string;
+    contentDe?: string;
+    contentPt?: string;
+    contentEs?: string;
+    contentSw?: string;
+    attachments?: StrapiFile[];
+    external?: boolean;
+    url?: string;
+    language?: string;
+    yearOfPublication?: number;
+    locallyModified?: boolean;
+}
+export interface ClientArticleCategory {
+    id: number;
+    name: string;
+    nameEn?: string;
+    nameFr?: string;
+    nameDe?: string;
+    namePt?: string;
+    nameEs?: string;
+    nameSw?: string;
+    description?: string;
+    isActive?: boolean;
+    slug?: string;
+    icon?: string;
+    articleTopic?: {
+        id: number;
+        name: string;
+        description?: string;
+        isActive?: boolean;
+    };
+}