@en-solutions/tgm-client-sdk 1.6.21

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

@@ -0,0 +1,134 @@
+export interface LoginRequest {
+    identifier: string;
+    password: string;
+    macAddress?: string;
+    metadata?: string;
+    impersonationUID?: string;
+    totpCode?: string;
+    sandbox?: string;
+}
+export interface BadgePinLoginRequest {
+    badgeNumber: string;
+    pinCode: string;
+    macAddress?: string;
+    metadata?: string;
+}
+export interface RegisterRequest {
+    username: string;
+    email: string;
+    password: string;
+    firstName?: string;
+    lastName?: string;
+    phoneNumber?: string;
+    profileId?: number;
+    roleId?: number;
+    departmentId?: number;
+}
+export interface ForgotPasswordRequest {
+    email: string;
+}
+export interface ResetPasswordRequest {
+    code: string;
+    password: string;
+    passwordConfirmation: string;
+}
+export interface ChangePasswordRequest {
+    currentPassword: string;
+    password: string;
+    passwordConfirmation: string;
+}
+export interface AuthResponse {
+    jwt: string;
+    refreshToken?: string;
+    user: UserDto;
+    licenseStatus?: string;
+    licenseMessage?: string;
+    isImpersonating?: boolean;
+    impersonationWarning?: string;
+    originalUserId?: number;
+    totpRequired?: boolean;
+    totpEnabled?: boolean;
+    totpTempToken?: string;
+    sandbox?: SandboxDto;
+    announcements?: AnnouncementDto[];
+    modules?: ModuleDto[];
+    features?: string[];
+    companyConfig?: CompanyConfigDto;
+}
+export interface UserDto {
+    id: number;
+    username: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    phoneNumber?: string;
+    isActive?: boolean;
+    confirmed?: boolean;
+    profile?: {
+        id: number;
+        name: string;
+    };
+    role?: {
+        id: number;
+        name: string;
+        type: string;
+    };
+    permissions?: PermissionDto[];
+    avatar?: any;
+    homepage?: any;
+    layoutType?: string;
+    highContrast?: boolean;
+    notificationSound?: boolean;
+    gender?: string;
+    phone?: string;
+    department?: {
+        id: number;
+        name: string;
+    } | null;
+    jobTitle?: {
+        id: number;
+        name: string;
+    } | null;
+}
+export interface PermissionDto {
+    resourceName: string;
+    canCreate?: boolean;
+    canRead?: boolean;
+    canUpdate?: boolean;
+    canDelete?: boolean;
+    canPublish?: boolean;
+    source?: string;
+}
+export interface SandboxDto {
+    id: number;
+    name: string;
+    slug: string;
+    schemaName?: string;
+    isMain?: boolean;
+}
+export interface AnnouncementDto {
+    id: number;
+    title: string;
+    message: string;
+    type: string;
+    isBanner?: boolean;
+    startsAt?: string;
+    endsAt?: string;
+}
+export interface ModuleDto {
+    id: string;
+    title: string;
+    children?: ModuleDto[];
+}
+export interface CompanyConfigDto {
+    id: number;
+    name: string;
+    appLanguage?: string;
+    theme?: string;
+    companyCurrency?: string;
+    measurementUnitSystem?: string;
+    trialAgreementSigned?: boolean;
+    enable2FA?: boolean;
+    ssoEnabled?: boolean;
+    ssoEnforced?: boolean;
+}

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

@@ -0,0 +1,136 @@
+import { ProviderType, PresetProvider } from '../enums';
+export interface SsoLoginRequest {
+    providerId: number;
+    companyId?: number;
+    redirectUri?: string;
+    loginHint?: string;
+    customState?: string;
+    sandbox?: string;
+}
+export interface SsoCallbackRequest {
+    code?: string;
+    state?: string;
+    error?: string;
+    errorDescription?: string;
+    idToken?: string;
+    accessToken?: string;
+    tokenType?: string;
+    expiresIn?: number;
+}
+export interface SamlCallbackRequest {
+    samlResponse?: string;
+    relayState?: string;
+    sigAlg?: string;
+    signature?: string;
+}
+export interface LinkAccountRequest {
+    providerId: number;
+    setPrimary?: boolean;
+    redirectUri?: string;
+}
+export interface SsoAuthorizationResponse {
+    authorizationUrl: string;
+    state: string;
+    providerName: string;
+    providerType: string;
+    providerId: number;
+    stateExpiresIn?: number;
+}
+export interface SsoProviderListResponse {
+    providers: SsoProviderInfo[];
+    ssoEnforced?: boolean;
+}
+export interface SsoProviderInfo {
+    id: number;
+    name: string;
+    displayName: string;
+    providerType: ProviderType;
+    presetProvider?: PresetProvider;
+    logoUrl?: string;
+}
+export interface LinkedAccountResponse {
+    id: number;
+    providerId: number;
+    providerName: string;
+    providerDisplayName?: string;
+    providerType: string;
+    providerLogoUrl?: string;
+    externalId: string;
+    externalEmail?: string;
+    externalUsername?: string;
+    externalDisplayName?: string;
+    isPrimary: boolean;
+    firstLoginAt?: string;
+    lastLoginAt?: string;
+    linkedAt?: string;
+    loginCount?: number;
+}
+export interface IdentityProviderRequest {
+    name: string;
+    displayName?: string;
+    description?: string;
+    logoUrl?: string;
+    providerType: ProviderType;
+    presetProvider?: PresetProvider;
+    clientId?: string;
+    clientSecret?: string;
+    authorizationUri?: string;
+    tokenUri?: string;
+    userInfoUri?: string;
+    jwksUri?: string;
+    issuerUri?: string;
+    scopes?: string;
+    discoveryUri?: string;
+    entityId?: string;
+    ssoUrl?: string;
+    sloUrl?: string;
+    idpCertificate?: string;
+    signingAlgorithm?: string;
+    nameIdFormat?: string;
+    allowedDomains?: string;
+    enabled?: boolean;
+    wantAssertionsSigned?: boolean;
+    wantAuthnRequestsSigned?: boolean;
+    jitEnabled?: boolean;
+    autoLinkByEmail?: boolean;
+    priority?: number;
+    attributeMapping?: Record<string, string>;
+    jitDefaultRoleId?: number;
+    jitDefaultProfileId?: number;
+}
+export interface IdentityProviderResponse {
+    id: number;
+    name: string;
+    displayName?: string;
+    description?: string;
+    logoUrl?: string;
+    providerType: ProviderType;
+    presetProvider?: PresetProvider;
+    clientId?: string;
+    authorizationUri?: string;
+    tokenUri?: string;
+    userInfoUri?: string;
+    jwksUri?: string;
+    issuerUri?: string;
+    scopes?: string;
+    discoveryUri?: string;
+    entityId?: string;
+    ssoUrl?: string;
+    sloUrl?: string;
+    signingAlgorithm?: string;
+    nameIdFormat?: string;
+    allowedDomains?: string;
+    enabled: boolean;
+    wantAssertionsSigned?: boolean;
+    wantAuthnRequestsSigned?: boolean;
+    jitEnabled?: boolean;
+    autoLinkByEmail?: boolean;
+    priority?: number;
+    attributeMapping?: Record<string, string>;
+    jitDefaultRoleId?: number;
+    jitDefaultProfileId?: number;
+    linkedUsersCount?: number;
+    activeSessionsCount?: number;
+    createdAt?: string;
+    updatedAt?: string;
+}

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

@@ -0,0 +1,19 @@
+export interface TotpSetupRequest {
+    code: string;
+}
+export interface TotpVerifyRequest {
+    code: string;
+    tempToken: string;
+}
+export interface TotpSetupResponse {
+    secret: string;
+    qrCodeImage: string;
+    otpauthUrl: string;
+    recoveryCodes: string[];
+    success: boolean;
+    message?: string;
+}
+export interface TotpStatusResponse {
+    enabled: boolean;
+    hasRecoveryCodes: boolean;
+}

package/lib/models/base.models.d.ts

@@ -0,0 +1,90 @@
+export interface ApiResponse<T> {
+    success: boolean;
+    data: T;
+    message?: string;
+    error?: any;
+}
+export interface PagedResponse<T> {
+    data: T[];
+    meta: {
+        pagination: {
+            page: number;
+            pageSize: number;
+            pageCount: number;
+            total: number;
+        };
+    };
+}
+export interface PaginationParams {
+    page?: number;
+    pageSize?: number;
+    sort?: string;
+    order?: 'ASC' | 'DESC';
+    /**
+     * Comma-separated list of relation fields to populate (include in response).
+     * By default, @JsonIgnore relations are hidden. Use populate to selectively
+     * include them. Example: 'location,inspections'
+     */
+    populate?: string;
+}
+export interface BaseEntity {
+    id: number;
+    /** Auto-generated unique reference code (e.g. UNT-00001, LOC-00003) */
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+/**
+ * Type-safe filter builder for the generic API filtering system.
+ *
+ * Supports all operators from GenericSpecificationBuilder:
+ * - equals, contains, startsWith, endsWith
+ * - gte, gt, lte, lt, ne
+ * - isIn (comma-separated), isNull
+ * - search (full-text across all string fields)
+ * - Foreign key dot-notation (e.g., 'unit.name')
+ *
+ * Usage:
+ * ```typescript
+ * const filters = new FilterParams()
+ *   .equals('status', 'ACTIVE')
+ *   .contains('name', 'turbine')
+ *   .gte('createdAt', '2024-01-01')
+ *   .search('maintenance');
+ *
+ * const response = service.getAll({ ...paginationParams, ...filters.toQueryParams() });
+ * ```
+ */
+export declare class FilterParams {
+    private filters;
+    /** Exact match (case-insensitive for strings). */
+    equals(field: string, value: string): FilterParams;
+    /** Case-insensitive LIKE %value%. */
+    contains(field: string, value: string): FilterParams;
+    /** LIKE value%. */
+    startsWith(field: string, value: string): FilterParams;
+    /** LIKE %value. */
+    endsWith(field: string, value: string): FilterParams;
+    /** Greater than or equal to. */
+    gte(field: string, value: string): FilterParams;
+    /** Greater than. */
+    gt(field: string, value: string): FilterParams;
+    /** Less than or equal to. */
+    lte(field: string, value: string): FilterParams;
+    /** Less than. */
+    lt(field: string, value: string): FilterParams;
+    /** Not equal. */
+    ne(field: string, value: string): FilterParams;
+    /** IN filter with comma-separated values. */
+    isIn(field: string, values: string[]): FilterParams;
+    /** IS NULL (true) or IS NOT NULL (false). */
+    isNull(field: string, isNull?: boolean): FilterParams;
+    /** Equals value OR field IS NULL. */
+    eqOrNull(field: string, value: string): FilterParams;
+    /** NOT IN filter with comma-separated values. */
+    notIn(field: string, values: string[]): FilterParams;
+    /** Full-text search across all string fields. */
+    search(value: string): FilterParams;
+    /** Converts filters to a query parameter map. */
+    toQueryParams(): Record<string, string>;
+}

package/lib/models/chat/chat.models.d.ts

@@ -0,0 +1,171 @@
+import { ConversationType, ChatMessageType, PresenceStatus } from '../enums';
+export interface Conversation {
+    id: number;
+    type: ConversationType;
+    name?: string;
+    description?: string;
+    avatarUrl?: string;
+    lastMessagePreview?: string;
+    unreadCount?: number;
+    messageCount?: number;
+    participantCount?: number;
+    isMuted?: boolean;
+    isPinned?: boolean;
+    isArchived?: boolean;
+    allowReactions?: boolean;
+    allowReplies?: boolean;
+    allowFileUploads?: boolean;
+    lastMessageAt?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    participants?: ChatParticipant[];
+    otherUser?: ChatParticipant;
+}
+export interface ChatMessage {
+    id: number;
+    conversationId: number;
+    senderId?: number;
+    senderName?: string;
+    senderAvatarUrl?: string;
+    content?: string;
+    messageType?: ChatMessageType;
+    parentMessageId?: number;
+    tempId?: string;
+    replyCount?: number;
+    readCount?: number;
+    isEdited?: boolean;
+    isDeleted?: boolean;
+    editedAt?: string;
+    deletedAt?: string;
+    metadata?: Record<string, any>;
+    attachments?: ChatAttachment[];
+    reactions?: ChatReaction[];
+    reactionSummary?: Record<string, number>;
+    readReceipts?: ChatReadReceipt[];
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface ChatParticipant {
+    id: number;
+    userId: number;
+    userName?: string;
+    userEmail?: string;
+    userAvatarUrl?: string;
+    role?: string;
+    isActive?: boolean;
+    isOnline?: boolean;
+    joinedAt?: string;
+    leftAt?: string;
+    addedByUserId?: number;
+    addedByUserName?: string;
+    lastSeenDisplay?: string;
+}
+export interface ChatAttachment {
+    id: number;
+    messageId?: number;
+    fileId?: number;
+    fileName?: string;
+    fileType?: string;
+    fileSize?: number;
+    fileSizeFormatted?: string;
+    fileUrl?: string;
+    thumbnailUrl?: string;
+    width?: number;
+    height?: number;
+    isImage?: boolean;
+    isVideo?: boolean;
+    isAudio?: boolean;
+    isDocument?: boolean;
+    createdAt?: string;
+}
+export interface ChatReaction {
+    id: number;
+    messageId?: number;
+    userId?: number;
+    emoji: string;
+    userName?: string;
+    createdAt?: string;
+}
+export interface ChatReadReceipt {
+    id: number;
+    messageId?: number;
+    userId?: number;
+    userName?: string;
+    userAvatarUrl?: string;
+    readAt?: string;
+}
+export interface PresenceResponse {
+    userId: number;
+    userName?: string;
+    userAvatarUrl?: string;
+    status?: PresenceStatus;
+    statusMessage?: string;
+    lastSeenAt?: string;
+    lastSeenDisplay?: string;
+    deviceType?: string;
+}
+export interface TypingIndicatorResponse {
+    conversationId: number;
+    userId: number;
+    userName?: string;
+    isTyping: boolean;
+    typingUsers?: {
+        userId: number;
+        userName: string;
+    }[];
+}
+export interface CreateConversationRequest {
+    type: ConversationType;
+    name?: string;
+    description?: string;
+    avatarUrl?: string;
+    participantIds: number[];
+    companyId?: number;
+    allowReactions?: boolean;
+    allowReplies?: boolean;
+    allowFileUploads?: boolean;
+}
+export interface SendMessageRequest {
+    conversationId: number;
+    content: string;
+    messageType?: ChatMessageType;
+    parentMessageId?: number;
+    attachmentIds?: number[];
+    metadata?: Record<string, any>;
+    tempId?: string;
+}
+export interface UpdateConversationRequest {
+    name?: string;
+    description?: string;
+    avatarUrl?: string;
+    allowReactions?: boolean;
+    allowReplies?: boolean;
+    allowFileUploads?: boolean;
+    maxFileSizeMb?: number;
+}
+export interface AddParticipantRequest {
+    userIds: number[];
+    role?: string;
+}
+export interface EditMessageRequest {
+    content: string;
+}
+export interface MarkReadRequest {
+    conversationId: number;
+    lastReadMessageId?: number;
+}
+export interface ReadReceiptBroadcast {
+    conversationId: number;
+    userId: number;
+    userName?: string;
+    lastReadMessageId: number;
+    readAt: string;
+}
+export interface ReactionBroadcast {
+    messageId: number;
+    conversationId: number;
+    userId: number;
+    userName?: string;
+    emoji: string;
+    add: boolean;
+}

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

@@ -0,0 +1,114 @@
+export declare const CatComponentType: {
+    readonly UNIT_COMPONENT: "UnitComponent";
+    readonly COMMON_COMPONENT: "CommonComponent";
+};
+export type CatComponentType = (typeof CatComponentType)[keyof typeof CatComponentType];
+export declare const CatTestTrigger: {
+    readonly ROUTINE: "Routine";
+    readonly POST_INCIDENT: "PostIncident";
+    readonly POST_REPAIR: "PostRepair";
+    readonly REGULATORY: "Regulatory";
+    readonly INSURANCE: "Insurance";
+    readonly ANOMALY: "Anomaly";
+    readonly PREDICTIVE: "Predictive";
+};
+export type CatTestTrigger = (typeof CatTestTrigger)[keyof typeof CatTestTrigger];
+export declare const CatTypeOfTest: {
+    readonly ELECTRICAL_TEST: "ElectricalTest";
+    readonly OIL_ANALYSIS: "OilAnalysis";
+    readonly VIBRATION_ANALYSIS: "VibrationAnalysis";
+    readonly LUBRIFICATION: "Lubrification";
+    readonly ULTRASOUND: "Ultrasound";
+    readonly THERMOGRAPHY: "Thermography";
+    readonly OTHER: "Other";
+};
+export type CatTypeOfTest = (typeof CatTypeOfTest)[keyof typeof CatTypeOfTest];
+export declare const CatWhereDone: {
+    readonly ON_SITE: "OnSite";
+    readonly OFF_SITE: "OffSite";
+    readonly LABORATORY: "Laboratory";
+};
+export type CatWhereDone = (typeof CatWhereDone)[keyof typeof CatWhereDone];
+export declare const CatDoneBy: {
+    readonly INTERNAL: "Internal";
+    readonly CONTRACTOR: "Contractor";
+    readonly LAB: "Lab";
+};
+export type CatDoneBy = (typeof CatDoneBy)[keyof typeof CatDoneBy];
+export declare const CatStatus: {
+    readonly PENDING: "Pending";
+    readonly DRAFT: "Draft";
+    readonly PLANNED: "Planned";
+    readonly SCHEDULED: "Scheduled";
+    readonly ASSIGNED: "Assigned";
+    readonly IN_PROGRESS: "InProgress";
+    readonly DONE: "Done";
+    readonly CANCELLED: "Cancelled";
+};
+export type CatStatus = (typeof CatStatus)[keyof typeof CatStatus];
+export declare const CatMachineCondition: {
+    readonly RUNNING: "Running";
+    readonly STANDBY: "Standby";
+    readonly SHUTDOWN: "Shutdown";
+    readonly POST_OVERHAUL: "PostOverhaul";
+    readonly COMMISSIONED: "Commissioned";
+};
+export type CatMachineCondition = (typeof CatMachineCondition)[keyof typeof CatMachineCondition];
+export declare const CatTestResult: {
+    readonly PASS: "Pass";
+    readonly MARGINAL: "Marginal";
+    readonly FAIL: "Fail";
+};
+export type CatTestResult = (typeof CatTestResult)[keyof typeof CatTestResult];
+export declare const CatTrendVsPrevious: {
+    readonly IMPROVED: "Improved";
+    readonly STABLE: "Stable";
+    readonly DEGRADED: "Degraded";
+};
+export type CatTrendVsPrevious = (typeof CatTrendVsPrevious)[keyof typeof CatTrendVsPrevious];
+export declare const CatRecommendedAction: {
+    readonly NO_ACTION: "NoAction";
+    readonly MONITOR: "Monitor";
+    readonly SCHEDULE_REPAIR: "ScheduleRepair";
+    readonly IMMEDIATE_REPAIR: "ImmediateRepair";
+    readonly DECOMMISSION: "Decommission";
+};
+export type CatRecommendedAction = (typeof CatRecommendedAction)[keyof typeof CatRecommendedAction];
+export declare const CatOutageType: {
+    readonly PLANNED: "Planned";
+    readonly FORCED: "Forced";
+    readonly OPPORTUNISTIC: "Opportunistic";
+};
+export type CatOutageType = (typeof CatOutageType)[keyof typeof CatOutageType];
+export declare const CatEquipmentOwner: {
+    readonly COMPANY: "Company";
+    readonly RENTAL: "Rental";
+    readonly CONTRACTOR: "Contractor";
+};
+export type CatEquipmentOwner = (typeof CatEquipmentOwner)[keyof typeof CatEquipmentOwner];
+export declare const CatSignOffRole: {
+    readonly PERFORMED_BY: "PerformedBy";
+    readonly REVIEWED_BY: "ReviewedBy";
+    readonly APPROVED_BY: "ApprovedBy";
+    readonly WITNESS: "Witness";
+};
+export type CatSignOffRole = (typeof CatSignOffRole)[keyof typeof CatSignOffRole];
+export declare const CatAttachmentCategory: {
+    readonly TEST_REPORT: "TestReport";
+    readonly OSCILLOGRAM: "Oscillogram";
+    readonly THERMAL_IMAGE: "ThermalImage";
+    readonly VIBRATION_SPECTRA: "VibrationSpectra";
+    readonly CALIBRATION_CERT: "CalibrationCert";
+    readonly PERMIT: "Permit";
+    readonly PHOTO: "Photo";
+    readonly OTHER: "Other";
+};
+export type CatAttachmentCategory = (typeof CatAttachmentCategory)[keyof typeof CatAttachmentCategory];
+export declare const CatAttachmentPhase: {
+    readonly PLANNING: "Planning";
+    readonly SCHEDULING: "Scheduling";
+    readonly ASSIGNING: "Assigning";
+    readonly EXECUTION: "Execution";
+    readonly GENERAL: "General";
+};
+export type CatAttachmentPhase = (typeof CatAttachmentPhase)[keyof typeof CatAttachmentPhase];