@en-solutions/tgm-client-sdk 1.6.21

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

@@ -0,0 +1,254 @@
+import { ReasonForIntervention, EventNature, ComponentType, ComponentCategory, InterventionRequestStatus, WorkOrderStatus, Priority, MaintenanceType, CostAllocation, UnitStatus, OperatingMode, WaterLevel, YesNo } from '../enums';
+import { StrapiFile } from './media.models';
+import { LOTOSystem } from './loto.models';
+export interface WorkOverview {
+    number?: number | string;
+    ref?: string;
+    step?: string;
+    plannedStartDate?: string;
+    plannedEndDate?: string;
+    actualStartDate?: string;
+    actualEndDate?: string;
+    days?: number;
+    hours?: number;
+    minutes?: number;
+    actualDays?: number;
+    actualHours?: number;
+    actualMinutes?: number;
+    workDuration?: number;
+    staffInvolved?: number[];
+    type?: string;
+    status?: string;
+    percentage?: number;
+    comments?: string;
+    startDate?: string;
+    startProcessDate?: string;
+}
+export interface InterventionTeam {
+    id?: number | string;
+    ref?: string;
+    name?: string;
+    description?: string;
+    departments?: number[];
+    staffInvolved?: number[];
+    components?: number[];
+    expectedDate?: string;
+    days?: number;
+    hours?: number;
+    minutes?: number;
+    workOverview?: WorkOverview[];
+    material?: number[];
+    checklist?: any[];
+    failures?: any[];
+    percentage?: number;
+    workDuration?: number;
+    startDate?: string;
+    status?: string;
+    updatedAt?: string;
+}
+export interface WorkPermitInfo {
+    workPermitRequired?: boolean;
+    workPermitRequiredList?: string[];
+    logOutTagOutSystemUsed?: boolean;
+    loto?: LOTOSystem;
+}
+export interface RelevantInformation {
+    anticipatedCost?: number;
+    approximateDuration?: number;
+    approximateDurationUnit?: string;
+    approximateDurationInterruption?: number;
+    approximateDurationScheduled?: number;
+    checklist?: any[];
+    failures?: any;
+    expectedDate?: string;
+    materials?: any[];
+    requirements?: any;
+    roles?: any[];
+    workOverview?: WorkOverview[];
+    teams?: InterventionTeam[];
+    multiTaskWork?: boolean;
+    capexProject?: any;
+    staffInvolved?: any[];
+    staffInvolvedNames?: string[];
+    staffInvolvedScheduled?: any[];
+    workPermits?: WorkPermitInfo;
+}
+export interface ComponentInterventionStatus {
+    componentId: number;
+    componentName?: string;
+    status?: string;
+    notes?: string;
+}
+export interface Intervention {
+    id: number;
+    reportNumber?: string;
+    title?: string;
+    description?: string;
+    status?: WorkOrderStatus;
+    priority?: Priority;
+    maintenanceType?: MaintenanceType;
+    costAllocation?: CostAllocation;
+    unitStatus?: UnitStatus;
+    operatingMode?: OperatingMode;
+    waterLevel?: WaterLevel;
+    eventNature?: EventNature;
+    reasonForIntervention?: ReasonForIntervention;
+    eventDescriptionType?: YesNo;
+    plannedDate?: string;
+    startDate?: string;
+    scheduleDate?: string;
+    creationDate?: string;
+    actionPlan?: string;
+    comments?: string;
+    recommendations?: string;
+    estimatedRevenueShortFall?: string;
+    productInterruption?: string;
+    externalId?: string;
+    isRiskComponents?: boolean;
+    systemIsolationCompleted?: boolean;
+    isProjectRelated?: boolean;
+    isMultiTeamsWork?: boolean;
+    immediate?: boolean;
+    plannedOutageDuration?: string;
+    interventionJSA?: string;
+    eventDescription?: string;
+    eventReportNumber?: string;
+    interventionCategory?: string;
+    interventionTimes?: string;
+    chargeCode?: string;
+    maintenanceReportNumber?: string;
+    phaseRef?: string;
+    potentialCause?: string;
+    componentsInterventionStatus?: ComponentInterventionStatus[];
+    groupsSelected?: number[];
+    relevantInformation?: RelevantInformation | string;
+    unit?: any;
+    location?: any;
+    users?: any[];
+    initiator?: any;
+    departments?: any[];
+    subAssembly?: any;
+    components?: any[];
+    attachments?: StrapiFile[];
+    customFields?: Record<string, any>;
+    interventionReportNumber?: string;
+    titleOfIntervention?: string;
+    intervention_jsa?: string;
+    sub_assembly?: any;
+    sevenDaysReminderSent?: boolean;
+    threeDaysReminderSent?: boolean;
+    sameDayReminderSent?: boolean;
+    deleted?: boolean;
+    interventionInOperationReason?: string;
+    woGroupInformation?: string;
+    projectReportNumber?: string;
+    worReportNumber?: string;
+    targetComponentInstancesRef?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type InterventionCreateRequest = Partial<Omit<Intervention, 'id' | 'createdAt' | 'updatedAt'>> & {
+    reportNumber: string;
+};
+export type InterventionUpdateRequest = Partial<Omit<Intervention, 'id' | 'createdAt' | 'updatedAt'>>;
+export interface InterventionRequest {
+    id: number;
+    reportNumber?: string;
+    title?: string;
+    description?: string;
+    status?: InterventionRequestStatus;
+    priority?: string;
+    deleted?: boolean;
+    reason?: ReasonForIntervention;
+    eventNature?: EventNature;
+    eventDescription?: string;
+    eventCode?: string;
+    eventReportNumber?: string;
+    eventOrigin?: string;
+    componentType?: ComponentType;
+    componentCategories?: ComponentCategory[];
+    groupsSelected?: number[];
+    subAssemblyId?: number;
+    requestedById?: number;
+    handledByUserId?: number;
+    requester?: {
+        id: number;
+        firstName?: string;
+        lastName?: string;
+        email?: string;
+        username?: string;
+        fullName?: string;
+    };
+    approver?: {
+        id: number;
+        firstName?: string;
+        lastName?: string;
+        email?: string;
+    };
+    handledBy?: {
+        id: number;
+        firstName?: string;
+        lastName?: string;
+        email?: string;
+    };
+    initiator?: {
+        id: number;
+        firstName?: string;
+        lastName?: string;
+        email?: string;
+    };
+    requestedDate?: string;
+    approvedDate?: string;
+    validationDate?: string;
+    cancellationDate?: string;
+    cancellationReason?: string;
+    comment?: string;
+    departments?: number[];
+    relevantInformation?: string;
+    unit?: any;
+    component?: any;
+    components?: any[];
+    location?: any;
+    company?: any;
+    locationId?: number;
+    unitId?: number;
+    componentId?: number;
+    companyId?: number;
+    technicalRequirements?: StrapiFile[];
+    generalTermsConditions?: StrapiFile[];
+    drawings?: StrapiFile[];
+    pictures?: StrapiFile[];
+    other?: StrapiFile[];
+    interventionNumber?: string;
+    materialOrderItems?: Record<string, any>;
+    published?: boolean;
+    closingDateTime?: string;
+    submissionOfBids?: 'Electronic' | 'MarkedEnvelope' | 'Both' | string;
+    otherInformation?: string;
+    primaryTenderContactNumber?: string;
+    primaryTenderContactEmail?: string;
+    siteVisits?: 'Optional' | 'Mandatory' | string;
+    mandatoryCriteriaRating?: string;
+    workSchedule?: string;
+    paymentBasis?: 'LumpSum' | 'TimeMaterial' | string;
+    otherConsideration?: string;
+    awaitingBiddingIntentions?: string;
+    discussions?: string;
+    bidsReceipt?: string;
+    bidsReviewSelection?: string;
+    contractAwarded?: string;
+    projectExecution?: string;
+    maintenanceNumber?: string;
+    type?: 'Maintenance' | 'Intervention' | 'Material' | 'Refurbishment' | 'Other' | string;
+    orderQuantity?: string;
+    bids?: any[];
+    referenceNumber?: string;
+    issueDate?: string;
+    maintenanceInterventionReport?: any[];
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type InterventionRequestCreateRequest = Partial<Omit<InterventionRequest, 'id' | 'createdAt' | 'updatedAt'>>;
+export type InterventionRequestUpdateRequest = InterventionRequestCreateRequest;

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

@@ -0,0 +1,15 @@
+export interface DeviceGateway {
+    id: number;
+    name?: string;
+    description?: string;
+    protocol?: string;
+    connectionConfig?: any;
+    status?: string;
+    lastHeartbeat?: string;
+    ipAddress?: string;
+    apiKey?: string;
+    isActive?: boolean;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}

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

@@ -0,0 +1,340 @@
+import { StrapiFile } from './media.models';
+import { LessonLearnedOrigin, RcaWorkOrderType } from '../enums';
+export interface Article {
+    id: number;
+    title: string;
+    slug?: string;
+    content?: string;
+    summary?: string;
+    category?: string;
+    tags?: string;
+    author?: string;
+    coverImageUrl?: string;
+    /** File ID of cover image (alternative to coverImageUrl for create/update) */
+    coverFileId?: number;
+    isPublished?: boolean;
+    publishedAt?: string;
+    isFeatured?: boolean;
+    createdByName?: string;
+    /** Whether article links to an external URL */
+    external?: boolean;
+    /** External URL when article is external */
+    url?: string;
+    /** Year of publication */
+    yearOfPublication?: number;
+    /** Article language code (e.g. 'en', 'fr') */
+    language?: 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;
+    locallyModified?: boolean;
+    platformArticleId?: number;
+    /** Category IDs for create/update */
+    categoryIds?: number[];
+    /** File attachments (when populated) */
+    attachments?: StrapiFile[];
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface ArticleCategory {
+    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?: ArticleTopic;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface ArticleTopic {
+    id: number;
+    name: string;
+    description?: string;
+    isActive?: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface BestPractice {
+    id: number;
+    title: string;
+    content?: string;
+    description?: string;
+    categoryId?: number;
+    titleEn?: string;
+    titleFr?: string;
+    titleDe?: string;
+    titlePt?: string;
+    titleEs?: string;
+    titleSw?: string;
+    contentEn?: string;
+    contentFr?: string;
+    contentDe?: string;
+    contentPt?: string;
+    contentEs?: string;
+    contentSw?: string;
+    status?: string;
+    author?: string;
+    publishedAt?: string;
+    viewCount?: number;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface BestPracticeCategory {
+    id: number;
+    name: string;
+    description?: 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;
+    isActive?: boolean;
+    icon?: string;
+    bestPractices?: BestPractice[];
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface Faq {
+    id: number;
+    question: string;
+    answer?: string;
+    categoryId?: number;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface FaqCategory {
+    id: number;
+    name: string;
+    description?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface LessonLearned {
+    id: number;
+    reportNumber?: string;
+    title: string;
+    description?: string;
+    lesson?: string;
+    recommendations?: string;
+    status?: string;
+    category?: string;
+    origin?: LessonLearnedOrigin;
+    sourceType?: string;
+    sourceId?: number;
+    publishedAt?: string;
+    authorId?: number;
+    locationId?: number;
+    unitId?: number;
+    componentIds?: number[];
+    impact?: string;
+    implementationStatus?: string;
+    elaborationDate?: string;
+    workOrderCode?: string;
+    workOrderReportNumber?: string;
+    workOrderType?: RcaWorkOrderType;
+    staffInvolved?: number[];
+    workOrderSummary?: Record<string, any>;
+    lessonsDetails?: Record<string, any>;
+    rcaReportNumber?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface Resource {
+    id: number;
+    title: string;
+    description?: string;
+    categoryId?: number;
+    topicId?: number;
+    attachment?: StrapiFile | null;
+    type?: string;
+    author?: string;
+    isDownloadable?: boolean;
+    isLink?: boolean;
+    link?: string;
+    language?: string;
+    locale?: string;
+    yearOfPublication?: string;
+    companyId?: number;
+    company?: {
+        id: number;
+        name?: string;
+    };
+    /** Logical (soft) delete flag */
+    deleted?: boolean;
+    /** Resource category (when populated) */
+    resource_category?: {
+        id: number;
+        name?: string;
+    };
+    /** Attachments (when multiple files are supported) */
+    attachments?: StrapiFile[];
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+/**
+ * Resource category.
+ *
+ * Filter by topic: use query param `resourceTopicId` (or `resource_topic` for Strapi-style).
+ * Example: ResourceCategoryService.getAll({ page: 1, pageSize: 100, resourceTopicId: 1 })
+ */
+export interface ResourceCategory {
+    id: number;
+    name: string;
+    description?: string;
+    resourceTopicId?: number;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface ResourceTopic {
+    id: number;
+    name: string;
+    description?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface Module {
+    id: number;
+    name: string;
+    code?: string;
+    description?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface ModuleLearning {
+    id: number;
+    title: string;
+    name?: string;
+    moduleId?: number;
+    categoryId?: number;
+    category?: LearningModuleCategory | null;
+    content?: string;
+    /** Quiz questions & answers — JSONB in PostgreSQL, may arrive as string or object depending on seed method */
+    qa?: string | Record<string, any>;
+    /** Points awarded on module completion */
+    completionPoints?: number;
+    /** Module type (e.g. video, quiz, reading) */
+    type?: string;
+    /** Estimated duration */
+    duration?: string;
+    /** Display order within category */
+    displayOrder?: number;
+    nameEn?: string;
+    nameFr?: string;
+    nameDe?: string;
+    namePt?: string;
+    nameEs?: string;
+    nameSw?: string;
+    titleEn?: string;
+    titleFr?: string;
+    titleDe?: string;
+    titlePt?: string;
+    titleEs?: string;
+    titleSw?: string;
+    descriptionEn?: string;
+    descriptionFr?: string;
+    descriptionDe?: string;
+    descriptionPt?: string;
+    descriptionEs?: string;
+    descriptionSw?: string;
+    cover?: StrapiFile | null;
+    video?: StrapiFile | null;
+    videos?: StrapiFile[];
+    attachments?: StrapiFile[];
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface ModuleVideo {
+    id: number;
+    title: string;
+    /**
+     * Filter videos by module: use query param `module.id` (not `moduleLearningId`).
+     * Example: ModuleVideoService.getAll({ page: 1, pageSize: 100, 'module.id': moduleId })
+     */
+    moduleId?: number;
+    url?: string;
+    videoUrl?: string;
+    thumbnail?: StrapiFile | null;
+    duration?: string;
+    displayOrder?: number;
+    description?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface LearningModuleCategory {
+    id: number;
+    name: string;
+    description?: string;
+    isActive?: boolean;
+    nameEn?: string;
+    nameFr?: string;
+    nameDe?: string;
+    namePt?: string;
+    nameEs?: string;
+    nameSw?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface UserLearning {
+    id: number;
+    userId?: number;
+    moduleLearningId?: number;
+    completed?: boolean;
+    progress?: number;
+    score?: number;
+    status?: string;
+    /**
+     * JSON payload storing per-module, per-question progress.
+     * Allows the UI to persist and restore quiz state within a single user-learning record.
+     */
+    modules?: string | Record<string, any>;
+    startedAt?: string;
+    completedAt?: string;
+    lastAccessedAt?: string;
+    referenceCode?: string;
+    createdAt?: string;
+}
+/** Training completion certificate (distinct from compliance certifications) */
+export interface TrainingCertificate {
+    id: number;
+    certificateNumber: string;
+    completedModules?: number;
+    totalModules?: number;
+    totalPointsEarned?: number;
+    completionDate?: string;
+    language?: string;
+    completedTopicNames?: string;
+    userId?: number;
+    pdf?: StrapiFile | null;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}

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

@@ -0,0 +1,51 @@
+import { LOTOBoxType, LOTOBoxStatus, LOTOLockType, LOTOLockStatus, LOTOLockRole, LOTOOverallStatus, EnergySourceType } from '../enums';
+export interface LOTOLock {
+    id?: string;
+    lockSerial: string;
+    lockColor?: string;
+    lockType: LOTOLockType;
+    assignedTo?: number;
+    assignedToName?: string;
+    role?: LOTOLockRole;
+    status: LOTOLockStatus;
+    appliedAt?: string;
+    removedAt?: string;
+    notes?: string;
+}
+export interface LOTOBox {
+    id?: string;
+    boxSerial: string;
+    location?: string;
+    energyType: EnergySourceType;
+    isolationPoint: string;
+    equipmentTag?: string;
+    isolationDeviceType?: string;
+    intendedState?: string;
+    boxType: LOTOBoxType;
+    status: LOTOBoxStatus;
+    permitHolder?: number;
+    permitHolderName?: string;
+    permitHolderLockSerial?: string;
+    locks?: LOTOLock[];
+    appliedAt?: string;
+    zeroEnergyVerified?: boolean;
+    zeroEnergyVerifiedBy?: number;
+    zeroEnergyVerifiedByName?: string;
+    zeroEnergyVerifiedAt?: string;
+    zeroEnergyMethod?: string;
+    releasedAt?: string;
+    releasedBy?: number;
+    notes?: string;
+}
+export interface LOTOSystem {
+    lotoRequired: boolean;
+    permitHolder?: number;
+    permitHolderName?: string;
+    importedFromPC2?: boolean;
+    energyControlProcedureRef?: string;
+    boxes?: LOTOBox[];
+    overallStatus?: LOTOOverallStatus;
+    preWorkBriefingDone?: boolean;
+    preWorkBriefingAt?: string;
+    notes?: string;
+}