@en-solutions/tgm-client-sdk 1.8.6 → 1.9.6

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

@@ -84,6 +84,10 @@ export interface OutageEvent {
     status?: OutageStatus;
     unitId?: number;
     failureId?: number;
+    /** Grid Management: the grid node this outage concerns (set for grid outages). */
+    gridNodeId?: number;
+    /** True when auto-created by the grid auto-response (vs entered manually). */
+    autoGenerated?: boolean;
     plannedStart?: string;
     plannedEnd?: string;
     actualStart?: string;
@@ -104,6 +108,36 @@ export interface OutageEvent {
     createdAt?: string;
     updatedAt?: string;
 }
+/** Per-resource-type roll-up inside an {@link OutageAnalysis} (backend: ResourceSummaryDTO). */
+export interface OutageResourceSummary {
+    resourceType?: string;
+    count: number;
+    estimatedHours: number;
+    actualHours: number;
+    variance: number;
+}
+/** Post-outage analysis contract (backend: PostOutageAnalysisDTO) returned by `getAnalysis(id)`. */
+export interface OutageAnalysis {
+    outageId: number;
+    outageNumber?: string;
+    title?: string;
+    status?: string;
+    plannedDurationHours?: number;
+    actualDurationHours?: number;
+    durationVarianceHours?: number;
+    durationVariancePercent?: number;
+    estimatedCost?: number;
+    actualCost?: number;
+    costVariance?: number;
+    costVariancePercent?: number;
+    lostRevenue?: number;
+    lostCapacityMw?: number;
+    totalResourcesAssigned?: number;
+    totalEstimatedHours?: number;
+    totalActualHours?: number;
+    resourceHoursVariance?: number;
+    resourceBreakdown?: OutageResourceSummary[];
+}
 export interface OperatingEvent {
     id: number;
     name?: string;

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

@@ -0,0 +1,57 @@
+/**
+ * Grid Management plugin models — distribution network nodes/links and live status.
+ * Mirrors the backend `ca.ensolutions.tgm.grid` entities and DTOs.
+ */
+export type GridNodeType = 'SUBSTATION' | 'DISTRIBUTION_SUBSTATION' | 'TRANSFORMER' | 'FEEDER' | 'LINE' | 'SWITCH' | 'RING_MAIN_UNIT' | 'BUSBAR' | 'POLE' | 'METER' | 'OTHER';
+export type GridLinkType = 'OVERHEAD_LINE' | 'UNDERGROUND_CABLE' | 'TRANSFORMER_LINK' | 'BUSBAR_LINK' | 'OTHER';
+/** Live availability state of a grid element. */
+export type OperationalState = 'UP' | 'DEGRADED' | 'DOWN' | 'IMPACTED' | 'UNKNOWN';
+export interface GridNode {
+    id?: number;
+    name: string;
+    nodeType: GridNodeType;
+    description?: string;
+    latitude?: number;
+    longitude?: number;
+    voltageLevelKv?: number;
+    ratedCapacityKva?: number;
+    parentNodeId?: number;
+    operationalState?: OperationalState;
+    stateSince?: string;
+    lastTelemetryAt?: string;
+    componentId?: number;
+    locationId?: number;
+    deviceGatewayId?: number;
+    aipNetworkNodeId?: number;
+    customFields?: Record<string, any>;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface GridLink {
+    id?: number;
+    name?: string;
+    fromNodeId: number;
+    toNodeId: number;
+    linkType?: GridLinkType;
+    operationalState?: OperationalState;
+    lengthKm?: number;
+    voltageLevelKv?: number;
+    createdAt?: string;
+    updatedAt?: string;
+}
+/** A node's live status as returned by GET /api/grid/status and pushed on /topic/grid/status. */
+export interface GridNodeStatus {
+    id: number;
+    name: string;
+    nodeType: GridNodeType;
+    latitude?: number;
+    longitude?: number;
+    voltageLevelKv?: number;
+    operationalState: OperationalState;
+    parentNodeId?: number;
+    lastTelemetryAt?: string;
+    activeAlertSeverity?: 'INFO' | 'WARNING' | 'CRITICAL' | 'EMERGENCY' | null;
+    /** Id of the worst active SensorAlert on this node — pass to acknowledge/resolve/escalate. */
+    activeAlertId?: number | null;
+    reachable: boolean;
+}

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

@@ -0,0 +1,43 @@
+/** Plugin framework models — installable per-tenant modules. */
+export interface PluginStatus {
+    id: string;
+    name: string;
+    version: string;
+    description: string;
+    requiredLicenseFeature?: string | null;
+    menuModuleId?: string | null;
+    installed: boolean;
+    status: 'INSTALLED' | 'DISABLED' | 'NOT_INSTALLED' | string;
+    installedAt?: string | null;
+}
+/**
+ * Full detail of one plugin = descriptor + curated rich content + this organization's install status.
+ * Returned by `GET /api/plugins/{id}`; everything a plugin detail page needs (pure JSON, no backend UI).
+ */
+export interface PluginDetail {
+    id: string;
+    name: string;
+    version: string;
+    category: string;
+    description: string;
+    tagline: string;
+    longDescription: string;
+    features: string[];
+    dataModel: string[];
+    endpoints: string[];
+    useCases: string[];
+    dependsOn: string[];
+    requiredLicenseFeature?: string | null;
+    menuModuleId?: string | null;
+    installed: boolean;
+    status: 'INSTALLED' | 'DISABLED' | 'NOT_INSTALLED' | string;
+    installedAt?: string | null;
+}
+export interface InstalledPlugin {
+    id?: number;
+    pluginId: string;
+    version?: string;
+    status: 'INSTALLED' | 'DISABLED';
+    installedAt?: string;
+    installedBy?: string;
+}

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

@@ -278,6 +278,9 @@ export declare const WorkflowStatus: {
 };
 export type WorkflowStatus = (typeof WorkflowStatus)[keyof typeof WorkflowStatus];
 export declare const InterventionRequestStatus: {
+    readonly PENDING: "PENDING";
+    readonly THREATED: "THREATED";
+    readonly CANCELLED: "CANCELLED";
     readonly ON_HOLD: "OnHold";
     readonly ACCEPTED: "Accepted";
     readonly REJECTED: "Rejected";

package/lib/models/index.d.ts

@@ -40,3 +40,5 @@ export * from './api/cortex-insight.models';
 export * from './api/aip.models';
 export * from './api/reservoir-websocket.models';
 export * from './api/cms.models';
+export * from './api/grid.models';
+export * from './api/plugin.models';

package/lib/services/api/asset-lifecycle.service.d.ts

@@ -22,7 +22,8 @@ export declare class AssetLifecycleService {
     getRecommendedReplacement(): Observable<ApiResponse<AssetLifecycle[]>>;
     getDashboard(): Observable<ApiResponse<any>>;
     getStageEnums(): Observable<ApiResponse<string[]>>;
-    /** Create a lifecycle record via the collection endpoint (wraps data in { data } if needed) */
+    /** Create a lifecycle record via the standard collection endpoint. The backend expects a FLAT
+     *  payload — wrapping it in { data } makes Spring ignore every field and persist an empty record. */
     createRecord(data: Record<string, any>): Observable<ApiResponse<AssetLifecycle>>;
     static ɵfac: i0.ɵɵFactoryDeclaration<AssetLifecycleService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<AssetLifecycleService>;

package/lib/services/api/energy.service.d.ts

@@ -2,7 +2,7 @@ import { Observable } from 'rxjs';
 import { TgmHttpClient } from '../../core/http-client.service';
 import { BaseCrudService } from './base-crud.service';
 import { ApiResponse } from '../../models/base.models';
-import { AncillaryService, GridConnection, CurtailmentEvent, OutageEvent, OperatingEvent, SiteAssessment } from '../../models/api/energy.models';
+import { AncillaryService, GridConnection, CurtailmentEvent, OutageEvent, OutageAnalysis, OperatingEvent, SiteAssessment } from '../../models/api/energy.models';
 import * as i0 from "@angular/core";
 export declare class AncillaryServiceCrudService extends BaseCrudService<AncillaryService> {
     protected resourcePath: string;
@@ -26,9 +26,20 @@ export declare class OutageEventService extends BaseCrudService<OutageEvent> {
     protected resourcePath: string;
     constructor(http: TgmHttpClient);
     getGantt(start: string, end: string): Observable<ApiResponse<any>>;
-    getAnalysis(id: number): Observable<ApiResponse<any>>;
+    /** Post-outage impact analysis (backend: PostOutageAnalysisDTO). */
+    getAnalysis(id: number): Observable<ApiResponse<OutageAnalysis>>;
+    /** Schedule overlaps (backend: OverlapDTO[]). */
     getOverlaps(id: number): Observable<ApiResponse<any[]>>;
+    /** Resource conflicts (backend: ResourceConflictDTO[]). */
     getResourceConflicts(id: number): Observable<ApiResponse<any[]>>;
+    /**
+     * Lifecycle actions (backend: `POST /api/outages/{id}/approve|complete|cancel`).
+     * NB: `approve` drives the separate `approvalStatus` field (PENDING → APPROVED), while
+     * `complete`/`cancel` drive `status` (ACTIVE → COMPLETED/CANCELLED).
+     */
+    approve(id: number, notes?: string): Observable<ApiResponse<OutageEvent>>;
+    complete(id: number, notes?: string): Observable<ApiResponse<OutageEvent>>;
+    cancel(id: number): Observable<ApiResponse<OutageEvent>>;
     static ɵfac: i0.ɵɵFactoryDeclaration<OutageEventService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<OutageEventService>;
 }

package/lib/services/api/export.service.d.ts

@@ -5,6 +5,10 @@ export declare class ExportService {
     private http;
     private basePath;
     constructor(http: TgmHttpClient);
+    /** Export the dashboard KPIs as CSV (period in days, default 30). */
+    exportDashboardCsv(periodDays?: number): Observable<Blob>;
+    /** Export the dashboard KPIs as Excel (period in days, default 30). */
+    exportDashboardExcel(periodDays?: number): Observable<Blob>;
     exportInspectionsExcel(ids?: number[]): Observable<Blob>;
     exportInspectionsCsv(ids?: number[]): Observable<Blob>;
     exportInspectionsPdf(ids?: number[]): Observable<Blob>;

package/lib/services/api/grid.service.d.ts

@@ -0,0 +1,61 @@
+import { Observable } from 'rxjs';
+import { TgmHttpClient } from '../../core/http-client.service';
+import { WebSocketService } from '../../core/websocket.service';
+import { BaseCrudService } from './base-crud.service';
+import { ApiResponse } from '../../models/base.models';
+import { GridLink, GridNode, GridNodeStatus } from '../../models/api/grid.models';
+import * as i0 from "@angular/core";
+/** CRUD for grid nodes (`/api/grid/nodes`). Requires the grid-management plugin. */
+export declare class GridNodeService extends BaseCrudService<GridNode> {
+    protected resourcePath: string;
+    constructor(http: TgmHttpClient);
+    static ɵfac: i0.ɵɵFactoryDeclaration<GridNodeService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<GridNodeService>;
+}
+/** CRUD for grid links/edges (`/api/grid/links`). */
+export declare class GridLinkService extends BaseCrudService<GridLink> {
+    protected resourcePath: string;
+    constructor(http: TgmHttpClient);
+    static ɵfac: i0.ɵɵFactoryDeclaration<GridLinkService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<GridLinkService>;
+}
+/**
+ * Real-time distribution-grid view: the status snapshot that powers the map plus a live STOMP feed.
+ *
+ * Typical usage:
+ * ```ts
+ * grid.status().subscribe(r => this.render(r.data));   // initial map render
+ * grid.liveStatus().subscribe(snapshot => this.render(snapshot)); // live updates
+ * ```
+ */
+export declare class GridService {
+    private http;
+    private ws;
+    private base;
+    static readonly TOPIC_STATUS = "/topic/grid/status";
+    constructor(http: TgmHttpClient, ws: WebSocketService);
+    /** Live status snapshot of every node (for the initial map render). */
+    status(): Observable<ApiResponse<GridNodeStatus[]>>;
+    /** All links/edges (for drawing the topology). */
+    links(): Observable<ApiResponse<GridLink[]>>;
+    /** Admin: recompute and persist live states, then broadcast over WebSocket. */
+    recompute(): Observable<ApiResponse<{
+        changed: number;
+    }>>;
+    /**
+     * Admin: run the grid auto-response — opens/closes `OutageEvent`s (and maintenance tickets) from the
+     * current derived states. This is more than `recompute()` (which only persists/broadcasts states).
+     */
+    autoResponse(): Observable<ApiResponse<{
+        changed: number;
+    }>>;
+    /**
+     * Live stream of full status snapshots pushed on `/topic/grid/status`.
+     * Ensure {@link WebSocketService.connect} has been called once after login.
+     */
+    liveStatus(): Observable<GridNodeStatus[]>;
+    /** Live stream for a single node pushed on `/topic/grid/node/{id}`. */
+    liveNode(nodeId: number): Observable<GridNodeStatus>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<GridService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<GridService>;
+}

package/lib/services/api/index.d.ts

@@ -102,3 +102,5 @@ export { AuditEntryService } from './audit-entry.service';
 export { ThresholdAlertRuleService } from './threshold-alert-rule.service';
 export { CmsContentTypeService, CmsDataService } from './cms.service';
 export { CmsMenuHelper, CmsMenuItem, CmsMenuSection } from './cms-menu.helper';
+export { GridService, GridNodeService, GridLinkService } from './grid.service';
+export { PluginService } from './plugin.service';

package/lib/services/api/plugin.service.d.ts

@@ -0,0 +1,36 @@
+import { Observable } from 'rxjs';
+import { TgmHttpClient } from '../../core/http-client.service';
+import { ApiResponse } from '../../models/base.models';
+import { InstalledPlugin, PluginDetail, PluginStatus } from '../../models/api/plugin.models';
+import * as i0 from "@angular/core";
+/**
+ * Installable modules (plugins) for the current organization.
+ *
+ * `list()` is readable by any authenticated user — the frontend uses it to decide which modules /
+ * menus to reveal. `install()` / `uninstall()` require an admin and run the plugin's isolated
+ * migrations on the tenant DB.
+ */
+export declare class PluginService {
+    private http;
+    private base;
+    constructor(http: TgmHttpClient);
+    /** Catalog of all plugins with this organization's install status. */
+    list(): Observable<ApiResponse<PluginStatus[]>>;
+    /** Full detail of one plugin (rich content + this organization's install status) — for a detail page. */
+    detail(pluginId: string): Observable<ApiResponse<PluginDetail>>;
+    /** True if the given plugin is installed for the current organization. */
+    isInstalled(pluginId: string): Observable<boolean>;
+    install(pluginId: string): Observable<ApiResponse<InstalledPlugin>>;
+    uninstall(pluginId: string): Observable<ApiResponse<void>>;
+    private platformBase;
+    /** Tenant-agnostic plugin catalog (descriptors). */
+    platformCatalog(): Observable<ApiResponse<PluginStatus[]>>;
+    /** Plugins with a specific client's install status. */
+    platformListForClient(clientId: string): Observable<ApiResponse<PluginStatus[]>>;
+    /** Install a plugin for a specific client. */
+    platformInstall(clientId: string, pluginId: string): Observable<ApiResponse<InstalledPlugin>>;
+    /** Disable a plugin for a specific client (data retained). */
+    platformUninstall(clientId: string, pluginId: string): Observable<ApiResponse<void>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PluginService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<PluginService>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@en-solutions/tgm-client-sdk",
-  "version": "1.8.6",
+  "version": "1.9.6",
   "description": "TGM Manager Client SDK for Angular 18 - Type-safe services for all TGM API endpoints",
   "license": "SEE LICENSE IN LICENSE",
   "repository": {