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

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

@@ -0,0 +1,55 @@
+/**
+ * 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;
+    reachable: boolean;
+}

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

@@ -0,0 +1,20 @@
+/** 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;
+}
+export interface InstalledPlugin {
+    id?: number;
+    pluginId: string;
+    version?: string;
+    status: 'INSTALLED' | 'DISABLED';
+    installedAt?: string;
+    installedBy?: string;
+}

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/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,54 @@
+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;
+    }>>;
+    /**
+     * 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,25 @@
+import { Observable } from 'rxjs';
+import { TgmHttpClient } from '../../core/http-client.service';
+import { ApiResponse } from '../../models/base.models';
+import { InstalledPlugin, 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[]>>;
+    /** 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>>;
+    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.2",
   "description": "TGM Manager Client SDK for Angular 18 - Type-safe services for all TGM API endpoints",
   "license": "SEE LICENSE IN LICENSE",
   "repository": {