@en-solutions/tgm-client-sdk 1.6.21

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

@@ -0,0 +1,260 @@
+import { CatStatus, CatTypeOfTest, CatWhereDone, CatDoneBy, CatComponentType, CatTestTrigger, CatMachineCondition, CatTestResult, CatTrendVsPrevious, CatRecommendedAction, CatOutageType, CatEquipmentOwner, CatSignOffRole, CatAttachmentCategory, CatAttachmentPhase } from '../enums';
+import { StrapiFile } from './media.models';
+export interface ConditionAssessmentTest {
+    id: number;
+    reportNumber?: string;
+    typeOfTest?: CatTypeOfTest | string;
+    title?: string;
+    description?: string;
+    testDate?: string;
+    whereDone?: CatWhereDone | string;
+    doneBy?: CatDoneBy | string;
+    status?: CatStatus | string;
+    testResults?: Record<string, any>;
+    assetTag?: string;
+    componentType?: CatComponentType | string;
+    testTrigger?: CatTestTrigger | string;
+    priority?: string;
+    previousCatReference?: string;
+    machineCondition?: CatMachineCondition | string;
+    operatingHours?: number;
+    hoursSinceOverhaul?: string;
+    lastSimilarTestDate?: string;
+    lastSimilarTestResult?: string;
+    trendVsPrevious?: CatTrendVsPrevious | string;
+    ambientTemperature?: string;
+    ambientHumidity?: string;
+    testEnvironment?: string;
+    governingStandard?: string;
+    currency?: string;
+    overallResult?: CatTestResult | string;
+    recommendedAction?: CatRecommendedAction | string;
+    nextTestRecommendedDate?: string;
+    technicalComments?: string;
+    attachmentNotes?: string;
+    planningOverview?: CatPlanningOverview;
+    planningProtocol?: CatPlanningProtocol;
+    planningRole?: CatPlanningRole;
+    planningPpe?: CatPlanningPpe;
+    planningDateDuration?: CatPlanningDateDuration;
+    planningCost?: CatPlanningCost;
+    scheduling?: CatScheduling;
+    equipmentItems?: CatPlanningEquipmentItem[];
+    personnelAssignments?: CatPersonnelAssignment[];
+    executionResults?: CatExecutionResult[];
+    signOffs?: CatSignOff[];
+    attachments?: CatAttachment[];
+    location?: any;
+    unit?: any;
+    subAssembly?: any;
+    createdBy?: any;
+    componentGroups?: any[];
+    components?: any[];
+    users?: any[];
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type ConditionAssessmentTestCreateRequest = Partial<Omit<ConditionAssessmentTest, 'id' | 'createdAt' | 'updatedAt' | 'reportNumber'>>;
+export type ConditionAssessmentTestUpdateRequest = Partial<Omit<ConditionAssessmentTest, 'id' | 'createdAt' | 'updatedAt'>>;
+export interface CatPlanningOverview {
+    id?: number;
+    workPermitTypes?: string[];
+    lotoProcedureReference?: string;
+    minimumSafetyClearances?: string;
+    safetyOfficerName?: string;
+    minTemperature?: string;
+    maxTemperature?: string;
+    maxHumidity?: string;
+    weatherRestrictions?: string[];
+    knownHazards?: Record<string, any>[];
+    hazardNotes?: string;
+    checkDeenergized?: boolean;
+    checkGrounding?: boolean;
+    checkIsolationVerified?: boolean;
+    checkAdjacentUnits?: boolean;
+    checkSafetyBriefingPlanned?: boolean;
+    specialSafetyInstructions?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface CatPlanningProtocol {
+    id?: number;
+    selectedStandards?: string[];
+    procedureReference?: string;
+    calibrationRequirements?: string;
+    environmentalValidityConditions?: string;
+    procedureSteps?: Record<string, any>[];
+    acceptanceCriteria?: Record<string, any>[];
+    isFollowUp?: boolean;
+    previousReportNumber?: string;
+    objectives?: string;
+    typeOfTest?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface CatPlanningRole {
+    id?: number;
+    roles?: Record<string, any>[];
+    minPersonnel?: number;
+    responsibleEngineer?: string;
+    safetyObserver?: string;
+    witnessRequired?: boolean;
+    witnessName?: string;
+    witnessOrganization?: string;
+    externalContractorRequired?: boolean;
+    contractorName?: string;
+    contractorScope?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface CatPlanningPpe {
+    id?: number;
+    ppeRequired?: Record<string, any>[];
+    consumables?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface CatPlanningDateDuration {
+    id?: number;
+    plannedStartDate?: string;
+    unitAvailabilityWindowStart?: string;
+    unitAvailabilityWindowEnd?: string;
+    deadline?: string;
+    estimatedDays?: number;
+    estimatedHours?: number;
+    estimatedMinutes?: number;
+    prepDays?: number;
+    prepHours?: number;
+    prepMinutes?: number;
+    restorationDays?: number;
+    restorationHours?: number;
+    restorationMinutes?: number;
+    outageType?: CatOutageType | string;
+    requiredShutdownHours?: number;
+    adjacentUnitsImpact?: string;
+    estimatedGenerationLossMw?: number;
+    estimatedGenerationLossMwh?: number;
+    gridOperatorNotificationRequired?: boolean;
+    estimatedCost?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface CatPlanningCost {
+    id?: number;
+    currency?: string;
+    laborCost?: number;
+    equipmentCost?: number;
+    contractorCost?: number;
+    generationLossCost?: number;
+    otherCost?: number;
+    totalCost?: number;
+    budgetChargeCode?: string;
+    approvalAuthority?: string;
+    approvalThreshold?: number;
+    costNotes?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface CatScheduling {
+    id?: number;
+    confirmedOutageStart?: string;
+    confirmedTestStart?: string;
+    estimatedTestEnd?: string;
+    confirmedReturnToService?: string;
+    confirmedOutageType?: CatOutageType | string;
+    adjacentUnitsConfirmedImpact?: string;
+    gridOperatorNotificationDate?: string;
+    scheduleNotes?: string;
+    workPermitIssued?: boolean;
+    permitNumber?: string;
+    lotoApplied?: boolean;
+    lotoNumber?: string;
+    controlRoomNotified?: boolean;
+    gridOperatorNotified?: boolean;
+    preliminaryWorkCompleted?: boolean;
+    confirmedLaborCost?: number;
+    confirmedEquipmentCost?: number;
+    confirmedContractorCost?: number;
+    confirmedGenerationLossCost?: number;
+    confirmedOtherCost?: number;
+    confirmedTotalCost?: number;
+    notifiedDepartments?: string[];
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface CatPlanningEquipmentItem {
+    id?: number;
+    conditionAssessmentTestId?: number;
+    name?: string;
+    reference?: string;
+    quantity?: number;
+    calibrationCertNumber?: string;
+    calibrationExpiry?: string;
+    owner?: CatEquipmentOwner | string;
+    available?: boolean;
+    isPrePopulated?: boolean;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface CatPersonnelAssignment {
+    id?: number;
+    conditionAssessmentTestId?: number;
+    role?: string;
+    assignedTo?: string;
+    qualification?: string;
+    contactNumber?: string;
+    confirmedAvailable?: boolean;
+    briefed?: boolean;
+    signedBriefing?: boolean;
+    isTeamLeader?: boolean;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface CatExecutionResult {
+    id?: number;
+    conditionAssessmentTestId?: number;
+    testType?: string;
+    parameter?: string;
+    measurementPoint?: string;
+    value?: number;
+    unit?: string;
+    specificationMin?: number;
+    specificationMax?: number;
+    result?: CatTestResult | string;
+    notes?: string;
+    additionalData?: Record<string, any>;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface CatSignOff {
+    id?: number;
+    conditionAssessmentTestId?: number;
+    role?: CatSignOffRole | string;
+    signatoryName?: string;
+    signatureDate?: string;
+    notes?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface CatAttachment {
+    id?: number;
+    conditionAssessmentTestId?: number;
+    file?: StrapiFile;
+    category?: CatAttachmentCategory | string;
+    phase?: CatAttachmentPhase | string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}

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

@@ -0,0 +1,125 @@
+import { StrapiFile } from './media.models';
+export interface Company {
+    id: number;
+    name: string;
+    address?: string;
+    phone?: string;
+    email?: string;
+    website?: string;
+    city?: string;
+    state?: string;
+    country?: string;
+    logo?: StrapiFile | null;
+    countryIndicator?: string;
+    isActive?: boolean;
+    isSubContractor?: boolean;
+    electricityCompany?: boolean;
+    deleted?: boolean;
+    measurementUnitSystem?: 'metric' | 'imperial' | string;
+    electricityPrice?: string;
+    layoutType?: 'cover' | string;
+    theme?: string;
+    appFont?: string;
+    reportFonts?: string;
+    appLanguage?: string;
+    CompanyCurrency?: string;
+    companyCurrency?: string;
+    systemIsolationSettings?: string;
+    woStaffProfileConfig?: string;
+    budgetaryThresholds?: string;
+    revenueStreams?: string;
+    requestUpdates?: string;
+    otherConfig?: string;
+    emailEnabled?: boolean;
+    smsEnabled?: boolean;
+    smsCreditCount?: string;
+    emailCreditCount?: string;
+    rechargeWithoutRequest?: boolean;
+    ialiveChatEnabled?: boolean;
+    iamaintenanceEnabled?: boolean;
+    iainterventionEnabled?: boolean;
+    aiAvailable?: boolean;
+    enable2FA?: boolean;
+    maxLoginAttempts?: string;
+    maxUnitNumber?: string;
+    impersonationUID?: string;
+    trialAgreementSigned?: boolean;
+    trialAgreementSignedAt?: string;
+    trialAgreementSignedBy?: string;
+    yearSoftwareAcquisition?: string;
+    ssoEnabled?: boolean;
+    ssoEnforced?: boolean;
+    ssoAllowedDomains?: string;
+    erpId?: string;
+    erpSource?: string;
+    erpLastSync?: string;
+    ocrEnabled?: boolean;
+    ocrLanguage?: string;
+    ocrAutoProcess?: boolean;
+    ocrFileTypes?: string;
+    storageType?: string;
+    storageEndpoint?: string;
+    storageBucket?: string;
+    storageRegion?: string;
+    storagePublicUrl?: string;
+    stockManagementMode?: 'INTERNAL' | 'ERP' | string;
+    headquartersAddress?: any;
+    powerhouseLocation?: any;
+    locations?: any[];
+    companyMaterialCategories?: CompanyMaterialCategory[];
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type CompanyCreateRequest = Partial<Omit<Company, 'id' | 'createdAt' | 'updatedAt'>>;
+export type CompanyUpdateRequest = CompanyCreateRequest;
+export interface CompanyMaterialCategory {
+    id: number;
+    name: string;
+    nameEn?: string;
+    nameFr?: string;
+    nameDe?: string;
+    namePt?: string;
+    nameEs?: string;
+    nameSw?: string;
+    deleted?: boolean;
+    companies?: Company[];
+    companyMaterialType?: CompanyMaterialType;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface CompanyMaterialType {
+    id: number;
+    name?: string;
+    nameFr?: string;
+    nameDe?: string;
+    namePt?: string;
+    deleted?: boolean;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+/** Matches backend License entity (stores signed licenseKey). */
+export interface License {
+    id: number;
+    licenseKey?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+/** Decoded license payload returned by /custom/license-info. */
+export interface LicenseInfo {
+    version?: number;
+    licenseId?: string;
+    type?: string;
+    companyName?: string;
+    contactEmail?: string;
+    issuedAt?: string;
+    expiresAt?: string;
+    maxUsers?: number;
+    maxUnits?: number;
+    features?: Record<string, boolean>;
+    appVersion?: string;
+    hardwareFingerprint?: string;
+}

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

@@ -0,0 +1,74 @@
+import { ObligationStatus, ObligationType, ObligationFrequency, ComplianceSubmissionStatus } from '../enums';
+export interface ComplianceObligation {
+    id: number;
+    title: string;
+    description?: string;
+    obligationType?: ObligationType;
+    frequency?: ObligationFrequency;
+    status?: ObligationStatus;
+    permitId?: number;
+    responsibleUserId?: number;
+    requirements?: string;
+    submissionFormat?: string;
+    nextDueDate?: string;
+    lastCompletedDate?: string;
+    notes?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type ComplianceObligationCreateRequest = Partial<Omit<ComplianceObligation, 'id' | 'createdAt' | 'updatedAt' | 'status'>>;
+export type ComplianceObligationUpdateRequest = ComplianceObligationCreateRequest;
+export interface ComplianceSubmission {
+    id: number;
+    submissionReference?: string;
+    title: string;
+    description?: string;
+    obligationId?: number;
+    status?: ComplianceSubmissionStatus;
+    submissionData?: string;
+    periodStart?: string;
+    periodEnd?: string;
+    submittedDate?: string;
+    reviewDate?: string;
+    approvalDate?: string;
+    notes?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface EnvironmentalPermit {
+    id: number;
+    permitNumber: string;
+    title: string;
+    description?: string;
+    permitType?: string;
+    status?: string;
+    issuingAuthority?: string;
+    authorityContact?: string;
+    authorityEmail?: string;
+    authorityPhone?: string;
+    issueDate?: string;
+    expiryDate?: string;
+    conditions?: any;
+    renewalRequirements?: any;
+    complianceHistory?: any;
+    notes?: string;
+    responsiblePersonId?: number;
+    documents?: any[];
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface Certification {
+    id: number;
+    name: string;
+    description?: string;
+    certificationBody?: string;
+    certificationDate?: string;
+    expiryDate?: string;
+    status?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}