@en-solutions/tgm-client-sdk 1.6.21

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

@@ -0,0 +1,117 @@
+import { SensorType, AlertStatus, AlertSeverity } from '../enums';
+export interface Sensor {
+    id: number;
+    name: string;
+    code?: string;
+    description?: string;
+    type?: SensorType | string;
+    subType?: string;
+    uuid?: string;
+    manufacturer?: string;
+    installationDate?: string;
+    angle?: string;
+    native?: boolean;
+    isActive?: boolean;
+    deleted?: boolean;
+    externalId?: string;
+    /** JSON string — additional sensor metadata */
+    additionalInfos?: string;
+    warningThreshold?: string;
+    criticalThreshold?: string;
+    idealRange?: string;
+    minValue?: string;
+    maxValue?: string;
+    warningMin?: number;
+    warningMax?: number;
+    criticalMin?: number;
+    criticalMax?: number;
+    lastReadingValue?: number;
+    lastReadingTime?: string;
+    alertEnabled?: boolean;
+    autoMaintenanceEnabled?: boolean;
+    influxMeasurement?: string;
+    influxField?: string;
+    /** Unit of measurement (e.g. "mV", "°C") — NOT the Unit entity */
+    unit?: string;
+    nameEn?: string;
+    nameFr?: string;
+    nameDe?: string;
+    namePt?: string;
+    nameEs?: string;
+    nameSw?: string;
+    unitId?: number;
+    componentId?: number;
+    component?: any;
+    group?: any;
+    location?: any;
+    subAssembly?: any;
+    unitEntity?: any;
+    measurementUnit?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type SensorCreateRequest = Partial<Omit<Sensor, 'id' | 'createdAt' | 'updatedAt'>>;
+export type SensorUpdateRequest = SensorCreateRequest;
+export interface SensorReading {
+    id: number;
+    sensorId: number;
+    value: number;
+    timestamp: string;
+}
+export interface SensorAlert {
+    id: number;
+    sensorId?: number;
+    componentId?: number;
+    alertType?: string;
+    message?: string;
+    severity?: AlertSeverity;
+    status?: AlertStatus;
+    thresholdValue?: number;
+    actualValue?: number;
+    /** Legacy SDK alias for actualValue */
+    value?: number;
+    /** Legacy SDK alias for thresholdValue */
+    threshold?: number;
+    triggeredAt?: string;
+    acknowledgedAt?: string;
+    acknowledgedBy?: number;
+    resolvedAt?: string;
+    resolvedBy?: number;
+    resolutionNotes?: string;
+    sensor?: any;
+    component?: any;
+    event?: any;
+    autoEventCreated?: boolean;
+    escalationLevel?: number;
+    escalatedAt?: string;
+    metadata?: string;
+    mlPredictionId?: string;
+    mlConfidence?: string;
+    mlRecommendation?: string;
+    forecastTrend?: string;
+    detectionLevel?: string;
+    isFalsePositive?: boolean;
+    falsePositiveReportedAt?: string;
+    falsePositiveReportedBy?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface AnomalyDetection {
+    id: number;
+    sensorExternalId?: string;
+    severity?: string;
+    value?: number;
+    anomalyScore?: number;
+    timestamp?: string;
+    unitId?: number;
+    locationId?: number;
+}
+export interface AnomalyForecast {
+    sensorExternalId?: string;
+    predictedValue?: number;
+    anomalyProbability?: number;
+    severity?: string;
+    hoursAhead?: number;
+}

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

@@ -0,0 +1,82 @@
+import { UnitStatus, PlantStatus, PremiseType, PlantSize, WaterLevel, OperatingMode } from '../enums';
+import { StrapiFile } from './media.models';
+export interface Unit {
+    id: number;
+    name: string;
+    code?: string;
+    description?: string;
+    status?: UnitStatus | string;
+    plantStatus?: PlantStatus;
+    premiseType?: PremiseType;
+    plantSize?: PlantSize | string;
+    waterLevel?: WaterLevel | string;
+    operatingMode?: OperatingMode | string;
+    power?: string;
+    maxPower?: string;
+    reactivePower?: string;
+    turnDown?: string;
+    ratedVoltage?: string;
+    ratedCurrent?: string;
+    ratedSpeed?: string;
+    frequency?: string;
+    loadFactor?: string;
+    turbineNumber?: string;
+    /** DB column: year_commissioning */
+    yearCommissioning?: string;
+    /** Alias kept for backward compatibility */
+    commissioningDate?: string;
+    dateOfFirstStart?: string;
+    underWarranty?: boolean;
+    warrantyPeriod?: string;
+    warrantyExpiryDate?: string;
+    generatorManufacturer?: string;
+    turbineManufacturer?: string;
+    numberOfStart?: number;
+    operatingHours?: number;
+    approximatedDailyRevenue?: string;
+    lastInspection?: string;
+    nextInspection?: string;
+    rehabilitationHistory?: string;
+    yearOfLastMajorOverhaul?: number;
+    numberOfPoles?: number;
+    deleted?: boolean;
+    ratedHead?: number;
+    ratedFlow?: number;
+    efficiencyCurve?: Record<string, any>;
+    minimumHead?: number;
+    startupTime?: number;
+    rampingRate?: number;
+    currentPowerOutput?: number;
+    currentEfficiency?: number;
+    erpId?: string;
+    erpSource?: string;
+    erpLastSync?: string;
+    mtbf?: number;
+    mttr?: number;
+    availability?: number;
+    orientation?: 'Vertical' | 'Horizontal' | string;
+    isDirectConnection?: boolean;
+    speedMultiplierType?: 'pulley-belt' | 'rack-pinion' | 'gears' | 'other' | string;
+    companyId?: number;
+    locationId?: number;
+    latitude?: number;
+    longitude?: number;
+    capacity?: number;
+    cover?: StrapiFile | null;
+    plan?: StrapiFile | null;
+    customFields?: Record<string, any>;
+    location?: any;
+    turbineType?: any;
+    properties?: any[];
+    inspections?: any[];
+    interventions?: any[];
+    subAssemblies?: any[];
+    components?: any[];
+    incidents?: any[];
+    shutdownHistories?: any[];
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type UnitCreateRequest = Partial<Omit<Unit, 'id' | 'createdAt' | 'updatedAt' | 'properties' | 'inspections' | 'interventions' | 'subAssemblies' | 'components' | 'incidents' | 'shutdownHistories'>>;
+export type UnitUpdateRequest = UnitCreateRequest;

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

@@ -0,0 +1,253 @@
+import { RoleType } from '../enums';
+import { StrapiFile } from './media.models';
+export interface User {
+    id: number;
+    username: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    /** Computed by backend */
+    fullName?: string;
+    phone?: string;
+    /** Alias — same as phone */
+    phoneNumber?: string;
+    position?: string;
+    provider?: string;
+    confirmed?: boolean;
+    blocked?: boolean;
+    /** Computed by backend (confirmed && !blocked) */
+    isActive?: boolean;
+    powerhouse?: string;
+    birthdate?: string;
+    gender?: string;
+    city?: string;
+    state?: string;
+    country?: string;
+    addressLine1?: string;
+    addressLine2?: string;
+    postalCode?: string;
+    isSubContractor?: boolean;
+    type?: string;
+    hourlyRate?: string;
+    accountExpiryDate?: string;
+    isSupplier?: boolean;
+    learningPercentage?: string;
+    electricityCompany?: boolean;
+    notificationSound?: boolean;
+    homepage?: string;
+    layoutType?: string;
+    highContrast?: boolean;
+    employeeNumber?: string;
+    employeePin?: string;
+    /** Alias — same as employeeNumber */
+    badgeNumber?: string;
+    badgeEnabled?: boolean;
+    failedLoginAttempts?: number;
+    isBlocked?: boolean;
+    pinCode?: string;
+    smsAlertTypes?: string;
+    smsNotificationsEnabled?: boolean;
+    totpEnabled?: boolean;
+    totpVerified?: boolean;
+    totpEnabledAt?: string;
+    totpFullyEnabled?: boolean;
+    twoFactorSecret?: string;
+    /** Computed by backend (totpEnabled && totpVerified) */
+    twoFactorEnabled?: boolean;
+    ssoOnly?: boolean;
+    federationId?: string;
+    primaryIdentityProviderId?: number;
+    loginAttemptsCount?: number;
+    loginMacAddresses?: string;
+    externalId?: string;
+    erpId?: string;
+    erpSource?: string;
+    erpLastSync?: string;
+    invitedAt?: string;
+    invitedByUserId?: number;
+    inviteTokenExpiresAt?: string;
+    confirmationTokenExpiresAt?: string;
+    lastLogin?: string;
+    loginCount?: number;
+    avatar?: StrapiFile | null;
+    role?: RoleSummary;
+    profile?: ProfileSummary;
+    department?: DepartmentSummary;
+    departments?: any[];
+    location?: any;
+    jobTitleId?: number;
+    jobTitle?: {
+        id: number;
+        name?: string;
+    };
+    job_title?: {
+        id: number;
+        name?: string;
+    };
+    additionalLocations?: any[];
+    primaryLocation?: LocationSummary;
+    locations?: LocationSummary[];
+    inspections?: any[];
+    interventions?: any[];
+    module_learnings?: any[];
+    customFields?: Record<string, any>;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface LocationSummary {
+    id: number;
+    name: string;
+    typeOfPremise?: string;
+    city?: string;
+    state?: string;
+}
+export interface RoleSummary {
+    id: number;
+    name: string;
+    type?: string;
+}
+export interface ProfileSummary {
+    id: number;
+    name: string;
+}
+export interface DepartmentSummary {
+    id: number;
+    name: string;
+}
+export interface UserCreateRequest {
+    username: string;
+    email: string;
+    password?: string;
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    position?: string;
+    roleId?: number;
+    profileId?: number;
+    departmentId?: number;
+    jobTitleId?: number;
+    sendWelcomeEmail?: boolean;
+    requireEmailVerification?: boolean;
+}
+export interface UserUpdateRequest extends Partial<Omit<UserCreateRequest, 'password'>> {
+    confirmed?: boolean;
+    blocked?: boolean;
+    ssoOnly?: boolean;
+}
+export interface InviteUserRequest {
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    personalMessage?: string;
+    roleId?: number;
+    profileId?: number;
+    departmentId?: number;
+    expiryHours?: number;
+}
+export interface AcceptInviteRequest {
+    token: string;
+    username: string;
+    password: string;
+    confirmPassword: string;
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+}
+/**
+ * Notification entity (maps to backend `notifications` table).
+ *
+ * NOTE: Backend also has a separate UserNotification entity for notification preferences
+ * (emailEnabled, smsEnabled, etc.) at /api/user-notifications.
+ * This interface represents the actual notification messages.
+ */
+export interface UserNotification {
+    id: number;
+    userId?: number;
+    title?: string;
+    message?: string;
+    type?: string;
+    category?: string;
+    isRead?: boolean;
+    readAt?: string;
+    entityType?: string;
+    entityId?: number;
+    link?: string;
+    metadata?: string;
+    referenceCode?: string;
+    createdAt?: string;
+}
+export interface LoginHistory {
+    id: number;
+    userId?: number;
+    loginTime?: string;
+    logoutTime?: string;
+    ipAddress?: string;
+    userAgent?: string;
+    device?: string;
+    browser?: string;
+    os?: string;
+    location?: string;
+    macAddress?: string;
+    loginMethod?: string;
+    metadata?: string;
+    isSuccessful?: boolean;
+    failureReason?: string;
+    referenceCode?: string;
+    createdAt?: string;
+}
+export interface Role {
+    id: number;
+    name: string;
+    description?: string;
+    type?: RoleType;
+    isSystem?: boolean;
+    permissionCount?: number;
+    userCount?: number;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface Profile {
+    id: number;
+    name: string;
+    description?: string;
+    isDefault?: boolean;
+    native?: boolean;
+    deleted?: boolean;
+    nameEn?: string;
+    nameFr?: string;
+    nameDe?: string;
+    namePt?: string;
+    nameEs?: string;
+    nameSw?: string;
+    name_en?: string;
+    name_fr?: string;
+    name_de?: string;
+    name_pt?: string;
+    name_es?: string;
+    name_sw?: string;
+    /** Users assigned to this profile (when populated) */
+    users?: User[] | {
+        id: number;
+    }[];
+    /** Profile permissions (when populated) */
+    profilePermissions?: ProfilePermission[];
+    profile_permissions?: ProfilePermission[];
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface ProfilePermission {
+    id: number;
+    resourceName: string;
+    canCreate?: boolean;
+    canRead?: boolean;
+    canUpdate?: boolean;
+    canDelete?: boolean;
+    canPublish?: boolean;
+    conditions?: string;
+    profileId?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}

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

@@ -0,0 +1,51 @@
+import { WarrantyType, WarrantyStatus, WarrantyClaimStatus } from '../enums';
+export interface WarrantyContract {
+    id: number;
+    contractNumber: string;
+    title: string;
+    description?: string;
+    warrantyType?: WarrantyType;
+    status?: WarrantyStatus;
+    providerName?: string;
+    providerContact?: string;
+    providerEmail?: string;
+    providerPhone?: string;
+    coverageDescription?: string;
+    termsAndConditions?: string;
+    exclusions?: string;
+    startDate?: string;
+    endDate?: string;
+    maxClaimAmount?: number;
+    deductible?: number;
+    contractCost?: number;
+    totalClaimed?: number;
+    totalPaid?: number;
+    notes?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface WarrantyClaim {
+    id: number;
+    claimNumber: string;
+    title: string;
+    description?: string;
+    status?: WarrantyClaimStatus;
+    warrantyContractId?: number;
+    unitId?: number;
+    failureId?: number;
+    claimedAmount?: number;
+    approvedAmount?: number;
+    paidAmount?: number;
+    incidentDate?: string;
+    submittedDate?: string;
+    reviewDate?: string;
+    resolutionDate?: string;
+    rejectionReason?: string;
+    resolutionNotes?: string;
+    reviewNotes?: string;
+    notes?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}

package/lib/models/api/work-permit.models.d.ts

@@ -0,0 +1,70 @@
+import { StrapiFile } from './media.models';
+import { WorkPermitCategory, WorkPermitStatus, WorkOrderSourceType, ActivePermitHolder } from '../enums';
+import { LOTOSystem } from './loto.models';
+export interface WorkPermit {
+    id: number;
+    permitCategory: WorkPermitCategory;
+    tgmFileNumber: string;
+    internalFileNumber?: string;
+    status: WorkPermitStatus;
+    locationId?: number;
+    stationName?: string;
+    permitHolderUserId?: number;
+    alternatePermitHolderUserId?: number;
+    activePermitHolder?: ActivePermitHolder;
+    eligiblePersons?: number[];
+    toBeIssuedAt?: string;
+    toBeSurrenderedAt?: string;
+    actualSurrenderedAt?: string;
+    workOrderSourceType?: WorkOrderSourceType;
+    workOrderId?: number;
+    workOrderReportNumber?: string;
+    linkedPC1Id?: number;
+    linkedPC2Id?: number;
+    permitDetails?: Record<string, any>;
+    lotoData?: LOTOSystem;
+    notes?: string;
+    hasExistingForm?: boolean;
+    attachments?: StrapiFile[];
+    createdByUserId?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface PC2TableBRow {
+    nameOfForeman?: string;
+    permitNo?: string;
+    onIssuedDate?: string;
+    offSurrenderedDate?: string;
+    workCompleted?: boolean;
+}
+export interface SystemIsolationItem {
+    category?: string;
+    equipment?: string;
+    intendedState?: string;
+    actualState?: string;
+    isolatedBy?: string;
+    verifiedBy?: string;
+    notes?: string;
+}
+export interface PC11TaggingRecord {
+    removedTime?: string;
+    removedDate?: string;
+    removedInitials?: string;
+    replacedTime?: string;
+    replacedDate?: string;
+    replacedInitials?: string;
+}
+export interface PC14ForemanRow {
+    name?: string;
+    operatorInitials?: string;
+    time?: string;
+}
+export interface PC17OperationRow {
+    sequenceNumber?: number;
+    device?: string;
+    removeTagNo?: string;
+    operation?: string;
+    placeTagNo?: string;
+    initials?: string;
+}

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

@@ -0,0 +1,52 @@
+import { WorkflowStatus, WorkflowType, ApprovalStatus } from '../enums';
+export interface ApprovalWorkflow {
+    id: number;
+    title?: string;
+    description?: string;
+    type?: WorkflowType;
+    status?: WorkflowStatus;
+    entityType?: string;
+    entityId?: number;
+    requestedById?: number;
+    currentApproverId?: number;
+    approvalSteps?: any[];
+    completedAt?: string;
+    currentApprover?: any;
+    currentStep?: number;
+    dueDate?: string;
+    escalatedTo?: any;
+    escalationDate?: string;
+    escalationLevel?: number;
+    escalationReason?: string;
+    finalComments?: string;
+    finalDecision?: string;
+    metadata?: any;
+    notes?: string;
+    requester?: any;
+    requiresAllApprovals?: boolean;
+    submittedAt?: string;
+    totalSteps?: number;
+    workflowType?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface ApprovalStep {
+    id: number;
+    workflowId?: number;
+    approverId?: number;
+    status?: ApprovalStatus;
+    comments?: string;
+    decidedAt?: string;
+    createdAt?: string;
+}
+export interface EscalationRule {
+    id: number;
+    name?: string;
+    type?: WorkflowType;
+    escalateAfterHours?: number;
+    escalateToUserId?: number;
+    isActive?: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+}

package/lib/models/auth/index.d.ts

@@ -0,0 +1,3 @@
+export * from './login.models';
+export * from './sso.models';
+export * from './totp.models';