@sonisoft/now-sdk-ext-core 2.2.1 → 2.5.1

package/dist/sn/discovery/InstanceDiscovery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InstanceDiscovery.js","sourceRoot":"","sources":["../../../src/sn/discovery/InstanceDiscovery.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAiBlE;;;;GAIG;AACH,MAAM,OAAO,iBAAiB;IAClB,MAAM,CAAU,mBAAmB,GAAG,eAAe,CAAC;IACtD,MAAM,CAAU,aAAa,GAAG,SAAS,CAAC;IAC1C,MAAM,CAAU,mBAAmB,GAAG,eAAe,CAAC;IACtD,MAAM,CAAU,cAAc,GAAG,UAAU,CAAC;IAE5C,OAAO,GAAW,IAAI,MAAM,CAAC,mBAAmB,CAAC,CAAC;IAClD,SAAS,CAAkB;IAC3B,SAAS,CAAqB;IAEtC,YAAmB,QAA4B;QAC3C,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,SAAS,GAAG,IAAI,eAAe,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,UAAU,CAAC,UAA6B,EAAE;QACnD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;QAEhD,MAAM,UAAU,GAAa,EAAE,CAAC;QAEhC,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACrB,UAAU,CAAC,IAAI,CAAC,iBAAiB,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;QAC3D,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAChB,UAAU,CAAC,IAAI,CAAC,aAAa,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QAClD,CAAC;QACD,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YACzB,UAAU,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAC1C,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAChB,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC;QAED,MAAM,KAAK,GAAoC;YAC3C,aAAa,EAAE,OAAO,CAAC,KAAK,IAAI,GAAG;SACtC,CAAC;QAEF,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrD,KAAK,CAAC,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;QAC1C,CAAC;QAED,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,KAAK,CAAC,aAAa,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC/C,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9C,KAAK,CAAC,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,QAAQ,GAA2C,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAC7E,iBAAiB,CAAC,mBAAmB,EACrC,KAAK,CACR,CAAC;QAEF,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YACrE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,SAAS,CAAC,CAAC;YACvE,OAAO,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;QACtC,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,kCAAkC,QAAQ,EAAE,MAAM,IAAI,SAAS,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CAAC,UAAiC,EAAE;QAC3D,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;QAEjD,MAAM,UAAU,GAAa,EAAE,CAAC;QAEhC,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACrB,UAAU,CAAC,IAAI,CAAC,iBAAiB,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;QAC3D,CAAC;QACD,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACrB,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACnC,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAChB,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC;QAED,MAAM,KAAK,GAAoC;YAC3C,aAAa,EAAE,OAAO,CAAC,KAAK,IAAI,GAAG;SACtC,CAAC;QAEF,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrD,KAAK,CAAC,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;QAC1C,CAAC;QAED,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,KAAK,CAAC,aAAa,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC/C,CAAC;QAED,MAAM,QAAQ,GAAqC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CACvE,iBAAiB,CAAC,aAAa,EAC/B,KAAK,CACR,CAAC;QAEF,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YACrE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,sBAAsB,CAAC,CAAC;YACpF,OAAO,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;QACtC,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,+CAA+C,QAAQ,EAAE,MAAM,IAAI,SAAS,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,aAAa,CAAC,UAAgC,EAAE;QACzD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;QAEhD,MAAM,UAAU,GAAa,EAAE,CAAC;QAEhC,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACrB,UAAU,CAAC,IAAI,CAAC,iBAAiB,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;QAC3D,CAAC;QACD,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACrB,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACnC,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAChB,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC;QAED,MAAM,KAAK,GAAoC;YAC3C,aAAa,EAAE,OAAO,CAAC,KAAK,IAAI,GAAG;SACtC,CAAC;QAEF,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrD,KAAK,CAAC,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;QAC1C,CAAC;QAED,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,KAAK,CAAC,aAAa,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC/C,CAAC;QAED,MAAM,QAAQ,GAAoC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CACtE,iBAAiB,CAAC,mBAAmB,EACrC,KAAK,CACR,CAAC;QAEF,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YACrE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,qBAAqB,CAAC,CAAC;YACnF,OAAO,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;QACtC,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,8CAA8C,QAAQ,EAAE,MAAM,IAAI,SAAS,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,WAAW,CAAC,UAA8B,EAAE;QACrD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAErC,MAAM,UAAU,GAAa,EAAE,CAAC;QAEhC,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACrB,UAAU,CAAC,IAAI,CAAC,iBAAiB,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;QAC3D,CAAC;QACD,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACrB,UAAU,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAChB,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC;QAED,MAAM,KAAK,GAAoC;YAC3C,aAAa,EAAE,OAAO,CAAC,KAAK,IAAI,GAAG;SACtC,CAAC;QAEF,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrD,KAAK,CAAC,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;QAC1C,CAAC;QAED,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,KAAK,CAAC,aAAa,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC/C,CAAC;QAED,MAAM,QAAQ,GAAkC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CACpE,iBAAiB,CAAC,cAAc,EAChC,KAAK,CACR,CAAC;QAEF,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YACrE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,UAAU,CAAC,CAAC;YACxE,OAAO,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;QACtC,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,mCAAmC,QAAQ,EAAE,MAAM,IAAI,SAAS,EAAE,CAAC,CAAC;IACxF,CAAC"}

package/dist/sn/health/HealthModels.d.ts

@@ -0,0 +1,124 @@
+/**
+ * Options for the health check.
+ */
+export interface HealthCheckOptions {
+    /** Include instance version info from sys_properties. Defaults to true. */
+    includeVersion?: boolean;
+    /** Include cluster node status from sys_cluster_state. Defaults to true. */
+    includeCluster?: boolean;
+    /** Include stuck job detection from sys_trigger. Defaults to true. */
+    includeStuckJobs?: boolean;
+    /** Include active semaphore count from sys_semaphore. Defaults to true. */
+    includeSemaphores?: boolean;
+    /** Include operational counts (incidents, changes, problems). Defaults to true. */
+    includeOperationalCounts?: boolean;
+    /** Threshold in minutes for a job to be considered "stuck". Defaults to 30. */
+    stuckJobThresholdMinutes?: number;
+}
+/**
+ * Instance version information.
+ */
+export interface InstanceVersionInfo {
+    /** The WAR version (glide.war) */
+    version?: string | null;
+    /** Build date (glide.build.date) */
+    buildDate?: string | null;
+    /** Build tag (glide.build.tag) */
+    buildTag?: string | null;
+}
+/**
+ * A cluster node status record.
+ */
+export interface ClusterNodeStatus {
+    /** The system ID */
+    sys_id: string;
+    /** The node ID */
+    node_id?: string;
+    /** The node status */
+    status?: string;
+    /** System updated on */
+    sys_updated_on?: string;
+    /** Additional fields */
+    [key: string]: unknown;
+}
+/**
+ * A stuck job (sys_trigger) record.
+ */
+export interface StuckJobRecord {
+    /** The system ID */
+    sys_id: string;
+    /** Name of the trigger */
+    name?: string;
+    /** The next scheduled action time */
+    next_action?: string;
+    /** The state of the trigger */
+    state?: string;
+    /** Additional fields */
+    [key: string]: unknown;
+}
+/**
+ * Operational record counts.
+ */
+export interface OperationalCounts {
+    /** Number of open incidents */
+    openIncidents?: number | null;
+    /** Number of open change requests */
+    openChanges?: number | null;
+    /** Number of open problems */
+    openProblems?: number | null;
+}
+/**
+ * Consolidated health check result.
+ */
+export interface HealthCheckResult {
+    /** Timestamp of the health check */
+    timestamp: string;
+    /** Instance version information (null if check failed or was skipped) */
+    version: InstanceVersionInfo | null;
+    /** Cluster node statuses (null if check failed or was skipped) */
+    clusterNodes: ClusterNodeStatus[] | null;
+    /** Stuck jobs (null if check failed or was skipped) */
+    stuckJobs: StuckJobRecord[] | null;
+    /** Number of active semaphores (null if check failed or was skipped) */
+    activeSemaphoreCount: number | null;
+    /** Operational counts (null if check failed or was skipped) */
+    operationalCounts: OperationalCounts | null;
+    /** Summary string describing overall health */
+    summary: string;
+}
+/**
+ * A sys_properties record.
+ */
+export interface SysPropertyRecord {
+    sys_id: string;
+    name?: string;
+    value?: string;
+    [key: string]: unknown;
+}
+/**
+ * Response from sys_properties query.
+ */
+export interface SysPropertyResponse {
+    result: SysPropertyRecord[];
+}
+/**
+ * Response from sys_cluster_state query.
+ */
+export interface ClusterStateResponse {
+    result: ClusterNodeStatus[];
+}
+/**
+ * Response from sys_trigger query.
+ */
+export interface SysTriggerResponse {
+    result: StuckJobRecord[];
+}
+/**
+ * Response from sys_semaphore query.
+ */
+export interface SysSemaphoreResponse {
+    result: Array<{
+        sys_id: string;
+        [key: string]: unknown;
+    }>;
+}

package/dist/sn/health/HealthModels.js

@@ -0,0 +1,5 @@
+// ============================================================
+// Options Types
+// ============================================================
+export {};
+//# sourceMappingURL=HealthModels.js.map

package/dist/sn/health/HealthModels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HealthModels.js","sourceRoot":"","sources":["../../../src/sn/health/HealthModels.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAC/D,gBAAgB;AAChB,+DAA+D"}

package/dist/sn/health/InstanceHealth.d.ts

@@ -0,0 +1,58 @@
+import { ServiceNowInstance } from "../ServiceNowInstance.js";
+import { AggregateQuery } from "../aggregate/AggregateQuery.js";
+import { HealthCheckOptions, HealthCheckResult } from './HealthModels.js';
+/**
+ * InstanceHealth provides a consolidated health check for a ServiceNow instance.
+ * Checks version info, cluster status, stuck jobs, semaphores, and operational counts.
+ * Each sub-check is isolated — a failure in one does not affect others.
+ */
+export declare class InstanceHealth {
+    private static readonly SYS_PROPERTIES_TABLE;
+    private static readonly SYS_CLUSTER_STATE_TABLE;
+    private static readonly SYS_TRIGGER_TABLE;
+    private static readonly SYS_SEMAPHORE_TABLE;
+    private _logger;
+    private _tableAPI;
+    private _aggregateQuery;
+    private _instance;
+    constructor(instance: ServiceNowInstance, aggregateQuery?: AggregateQuery);
+    /**
+     * Run a consolidated health check on the instance.
+     * Each sub-check is wrapped in try/catch — failures return null for that check
+     * without affecting the overall result.
+     *
+     * @param options Options to control which checks are run
+     * @returns HealthCheckResult with all collected information and a summary
+     */
+    checkHealth(options?: HealthCheckOptions): Promise<HealthCheckResult>;
+    /**
+     * Get instance version information from sys_properties.
+     * @private
+     */
+    private _getVersionInfo;
+    /**
+     * Get cluster node status from sys_cluster_state.
+     * @private
+     */
+    private _getClusterStatus;
+    /**
+     * Get stuck jobs from sys_trigger (state=0 and next_action overdue).
+     * @private
+     */
+    private _getStuckJobs;
+    /**
+     * Get count of active semaphores from sys_semaphore.
+     * @private
+     */
+    private _getActiveSemaphores;
+    /**
+     * Get operational counts using AggregateQuery.
+     * @private
+     */
+    private _getOperationalCounts;
+    /**
+     * Build a human-readable summary string from the health check results.
+     * @private
+     */
+    private _buildSummary;
+}

package/dist/sn/health/InstanceHealth.js

@@ -0,0 +1,221 @@
+import { Logger } from "../../util/Logger.js";
+import { TableAPIRequest } from "../../comm/http/TableAPIRequest.js";
+import { AggregateQuery } from "../aggregate/AggregateQuery.js";
+/**
+ * InstanceHealth provides a consolidated health check for a ServiceNow instance.
+ * Checks version info, cluster status, stuck jobs, semaphores, and operational counts.
+ * Each sub-check is isolated — a failure in one does not affect others.
+ */
+export class InstanceHealth {
+    static SYS_PROPERTIES_TABLE = 'sys_properties';
+    static SYS_CLUSTER_STATE_TABLE = 'sys_cluster_state';
+    static SYS_TRIGGER_TABLE = 'sys_trigger';
+    static SYS_SEMAPHORE_TABLE = 'sys_semaphore';
+    _logger = new Logger("InstanceHealth");
+    _tableAPI;
+    _aggregateQuery;
+    _instance;
+    constructor(instance, aggregateQuery) {
+        this._instance = instance;
+        this._tableAPI = new TableAPIRequest(instance);
+        this._aggregateQuery = aggregateQuery || new AggregateQuery(instance);
+    }
+    /**
+     * Run a consolidated health check on the instance.
+     * Each sub-check is wrapped in try/catch — failures return null for that check
+     * without affecting the overall result.
+     *
+     * @param options Options to control which checks are run
+     * @returns HealthCheckResult with all collected information and a summary
+     */
+    async checkHealth(options = {}) {
+        const includeVersion = options.includeVersion !== false;
+        const includeCluster = options.includeCluster !== false;
+        const includeStuckJobs = options.includeStuckJobs !== false;
+        const includeSemaphores = options.includeSemaphores !== false;
+        const includeOperationalCounts = options.includeOperationalCounts !== false;
+        const stuckJobThreshold = options.stuckJobThresholdMinutes ?? 30;
+        this._logger.info('Running instance health check');
+        const version = includeVersion ? await this._getVersionInfo() : null;
+        const clusterNodes = includeCluster ? await this._getClusterStatus() : null;
+        const stuckJobs = includeStuckJobs ? await this._getStuckJobs(stuckJobThreshold) : null;
+        const activeSemaphoreCount = includeSemaphores ? await this._getActiveSemaphores() : null;
+        const operationalCounts = includeOperationalCounts ? await this._getOperationalCounts() : null;
+        const summary = this._buildSummary(version, clusterNodes, stuckJobs, activeSemaphoreCount, operationalCounts);
+        this._logger.info(`Health check complete: ${summary}`);
+        return {
+            timestamp: new Date().toISOString(),
+            version,
+            clusterNodes,
+            stuckJobs,
+            activeSemaphoreCount,
+            operationalCounts,
+            summary
+        };
+    }
+    /**
+     * Get instance version information from sys_properties.
+     * @private
+     */
+    async _getVersionInfo() {
+        try {
+            const query = {
+                sysparm_query: 'nameINglide.war,glide.build.date,glide.build.tag',
+                sysparm_limit: 10
+            };
+            const response = await this._tableAPI.get(InstanceHealth.SYS_PROPERTIES_TABLE, query);
+            if (response && response.status === 200 && response.bodyObject?.result) {
+                const props = response.bodyObject.result;
+                const versionInfo = {};
+                for (const prop of props) {
+                    switch (prop.name) {
+                        case 'glide.war':
+                            versionInfo.version = prop.value || null;
+                            break;
+                        case 'glide.build.date':
+                            versionInfo.buildDate = prop.value || null;
+                            break;
+                        case 'glide.build.tag':
+                            versionInfo.buildTag = prop.value || null;
+                            break;
+                    }
+                }
+                return versionInfo;
+            }
+            return null;
+        }
+        catch (err) {
+            this._logger.error(`Failed to get version info: ${err}`);
+            return null;
+        }
+    }
+    /**
+     * Get cluster node status from sys_cluster_state.
+     * @private
+     */
+    async _getClusterStatus() {
+        try {
+            const query = {
+                sysparm_limit: 100
+            };
+            const response = await this._tableAPI.get(InstanceHealth.SYS_CLUSTER_STATE_TABLE, query);
+            if (response && response.status === 200 && response.bodyObject?.result) {
+                return response.bodyObject.result;
+            }
+            return null;
+        }
+        catch (err) {
+            this._logger.error(`Failed to get cluster status: ${err}`);
+            return null;
+        }
+    }
+    /**
+     * Get stuck jobs from sys_trigger (state=0 and next_action overdue).
+     * @private
+     */
+    async _getStuckJobs(thresholdMinutes) {
+        try {
+            const query = {
+                sysparm_query: `state=0^next_action<javascript:gs.minutesAgoStart(${thresholdMinutes})`,
+                sysparm_limit: 100
+            };
+            const response = await this._tableAPI.get(InstanceHealth.SYS_TRIGGER_TABLE, query);
+            if (response && response.status === 200 && response.bodyObject?.result) {
+                return response.bodyObject.result;
+            }
+            return null;
+        }
+        catch (err) {
+            this._logger.error(`Failed to get stuck jobs: ${err}`);
+            return null;
+        }
+    }
+    /**
+     * Get count of active semaphores from sys_semaphore.
+     * @private
+     */
+    async _getActiveSemaphores() {
+        try {
+            const query = {
+                sysparm_limit: 1000
+            };
+            const response = await this._tableAPI.get(InstanceHealth.SYS_SEMAPHORE_TABLE, query);
+            if (response && response.status === 200 && response.bodyObject?.result) {
+                return response.bodyObject.result.length;
+            }
+            return null;
+        }
+        catch (err) {
+            this._logger.error(`Failed to get active semaphores: ${err}`);
+            return null;
+        }
+    }
+    /**
+     * Get operational counts using AggregateQuery.
+     * @private
+     */
+    async _getOperationalCounts() {
+        try {
+            const counts = {};
+            try {
+                counts.openIncidents = await this._aggregateQuery.count({ table: 'incident', query: 'active=true' });
+            }
+            catch {
+                counts.openIncidents = null;
+            }
+            try {
+                counts.openChanges = await this._aggregateQuery.count({ table: 'change_request', query: 'active=true' });
+            }
+            catch {
+                counts.openChanges = null;
+            }
+            try {
+                counts.openProblems = await this._aggregateQuery.count({ table: 'problem', query: 'active=true' });
+            }
+            catch {
+                counts.openProblems = null;
+            }
+            return counts;
+        }
+        catch (err) {
+            this._logger.error(`Failed to get operational counts: ${err}`);
+            return null;
+        }
+    }
+    /**
+     * Build a human-readable summary string from the health check results.
+     * @private
+     */
+    _buildSummary(version, clusterNodes, stuckJobs, activeSemaphoreCount, operationalCounts) {
+        const parts = [];
+        if (version) {
+            parts.push(`Version: ${version.version || 'unknown'}${version.buildTag ? ` (${version.buildTag})` : ''}`);
+        }
+        if (clusterNodes !== null) {
+            parts.push(`Cluster: ${clusterNodes.length} node(s)`);
+        }
+        if (stuckJobs !== null) {
+            parts.push(`Stuck jobs: ${stuckJobs.length}`);
+        }
+        if (activeSemaphoreCount !== null) {
+            parts.push(`Active semaphores: ${activeSemaphoreCount}`);
+        }
+        if (operationalCounts) {
+            const countParts = [];
+            if (operationalCounts.openIncidents !== null && operationalCounts.openIncidents !== undefined) {
+                countParts.push(`${operationalCounts.openIncidents} incidents`);
+            }
+            if (operationalCounts.openChanges !== null && operationalCounts.openChanges !== undefined) {
+                countParts.push(`${operationalCounts.openChanges} changes`);
+            }
+            if (operationalCounts.openProblems !== null && operationalCounts.openProblems !== undefined) {
+                countParts.push(`${operationalCounts.openProblems} problems`);
+            }
+            if (countParts.length > 0) {
+                parts.push(`Open: ${countParts.join(', ')}`);
+            }
+        }
+        return parts.length > 0 ? parts.join(' | ') : 'Health check completed (no data collected)';
+    }
+}
+//# sourceMappingURL=InstanceHealth.js.map

package/dist/sn/health/InstanceHealth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InstanceHealth.js","sourceRoot":"","sources":["../../../src/sn/health/InstanceHealth.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAElE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAc7D;;;;GAIG;AACH,MAAM,OAAO,cAAc;IACf,MAAM,CAAU,oBAAoB,GAAG,gBAAgB,CAAC;IACxD,MAAM,CAAU,uBAAuB,GAAG,mBAAmB,CAAC;IAC9D,MAAM,CAAU,iBAAiB,GAAG,aAAa,CAAC;IAClD,MAAM,CAAU,mBAAmB,GAAG,eAAe,CAAC;IAEtD,OAAO,GAAW,IAAI,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAC/C,SAAS,CAAkB;IAC3B,eAAe,CAAiB;IAChC,SAAS,CAAqB;IAEtC,YAAmB,QAA4B,EAAE,cAA+B;QAC5E,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,SAAS,GAAG,IAAI,eAAe,CAAC,QAAQ,CAAC,CAAC;QAC/C,IAAI,CAAC,eAAe,GAAG,cAAc,IAAI,IAAI,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,WAAW,CAAC,UAA8B,EAAE;QACrD,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,KAAK,KAAK,CAAC;QACxD,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,KAAK,KAAK,CAAC;QACxD,MAAM,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,KAAK,KAAK,CAAC;QAC5D,MAAM,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,KAAK,KAAK,CAAC;QAC9D,MAAM,wBAAwB,GAAG,OAAO,CAAC,wBAAwB,KAAK,KAAK,CAAC;QAC5E,MAAM,iBAAiB,GAAG,OAAO,CAAC,wBAAwB,IAAI,EAAE,CAAC;QAEjE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;QAEnD,MAAM,OAAO,GAAG,cAAc,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QACrE,MAAM,YAAY,GAAG,cAAc,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5E,MAAM,SAAS,GAAG,gBAAgB,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACxF,MAAM,oBAAoB,GAAG,iBAAiB,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QAC1F,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QAE/F,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,oBAAoB,EAAE,iBAAiB,CAAC,CAAC;QAE9G,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,OAAO,EAAE,CAAC,CAAC;QAEvD,OAAO;YACH,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,OAAO;YACP,YAAY;YACZ,SAAS;YACT,oBAAoB;YACpB,iBAAiB;YACjB,OAAO;SACV,CAAC;IACN,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,eAAe;QACzB,IAAI,CAAC;YACD,MAAM,KAAK,GAAoC;gBAC3C,aAAa,EAAE,kDAAkD;gBACjE,aAAa,EAAE,EAAE;aACpB,CAAC;YAEF,MAAM,QAAQ,GAAuC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CACzE,cAAc,CAAC,oBAAoB,EACnC,KAAK,CACR,CAAC;YAEF,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;gBACrE,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;gBACzC,MAAM,WAAW,GAAwB,EAAE,CAAC;gBAE5C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBACvB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;wBAChB,KAAK,WAAW;4BACZ,WAAW,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC;4BACzC,MAAM;wBACV,KAAK,kBAAkB;4BACnB,WAAW,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC;4BAC3C,MAAM;wBACV,KAAK,iBAAiB;4BAClB,WAAW,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC;4BAC1C,MAAM;oBACd,CAAC;gBACL,CAAC;gBAED,OAAO,WAAW,CAAC;YACvB,CAAC;YAED,OAAO,IAAI,CAAC;QAChB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,+BAA+B,GAAG,EAAE,CAAC,CAAC;YACzD,OAAO,IAAI,CAAC;QAChB,CAAC;IACL,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,iBAAiB;QAC3B,IAAI,CAAC;YACD,MAAM,KAAK,GAAoC;gBAC3C,aAAa,EAAE,GAAG;aACrB,CAAC;YAEF,MAAM,QAAQ,GAAwC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAC1E,cAAc,CAAC,uBAAuB,EACtC,KAAK,CACR,CAAC;YAEF,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;gBACrE,OAAO,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;YACtC,CAAC;YAED,OAAO,IAAI,CAAC;QAChB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,iCAAiC,GAAG,EAAE,CAAC,CAAC;YAC3D,OAAO,IAAI,CAAC;QAChB,CAAC;IACL,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,aAAa,CAAC,gBAAwB;QAChD,IAAI,CAAC;YACD,MAAM,KAAK,GAAoC;gBAC3C,aAAa,EAAE,qDAAqD,gBAAgB,GAAG;gBACvF,aAAa,EAAE,GAAG;aACrB,CAAC;YAEF,MAAM,QAAQ,GAAsC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CACxE,cAAc,CAAC,iBAAiB,EAChC,KAAK,CACR,CAAC;YAEF,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;gBACrE,OAAO,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;YACtC,CAAC;YAED,OAAO,IAAI,CAAC;QAChB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,6BAA6B,GAAG,EAAE,CAAC,CAAC;YACvD,OAAO,IAAI,CAAC;QAChB,CAAC;IACL,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,oBAAoB;QAC9B,IAAI,CAAC;YACD,MAAM,KAAK,GAAoC;gBAC3C,aAAa,EAAE,IAAI;aACtB,CAAC;YAEF,MAAM,QAAQ,GAAwC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAC1E,cAAc,CAAC,mBAAmB,EAClC,KAAK,CACR,CAAC;YAEF,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;gBACrE,OAAO,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC;YAC7C,CAAC;YAED,OAAO,IAAI,CAAC;QAChB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,oCAAoC,GAAG,EAAE,CAAC,CAAC;YAC9D,OAAO,IAAI,CAAC;QAChB,CAAC;IACL,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,qBAAqB;QAC/B,IAAI,CAAC;YACD,MAAM,MAAM,GAAsB,EAAE,CAAC;YAErC,IAAI,CAAC;gBACD,MAAM,CAAC,aAAa,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC;YACzG,CAAC;YAAC,MAAM,CAAC;gBACL,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;YAChC,CAAC;YAED,IAAI,CAAC;gBACD,MAAM,CAAC,WAAW,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC;YAC7G,CAAC;YAAC,MAAM,CAAC;gBACL,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;YAC9B,CAAC;YAED,IAAI,CAAC;gBACD,MAAM,CAAC,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC;YACvG,CAAC;YAAC,MAAM,CAAC;gBACL,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC;YAC/B,CAAC;YAED,OAAO,MAAM,CAAC;QAClB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,qCAAqC,GAAG,EAAE,CAAC,CAAC;YAC/D,OAAO,IAAI,CAAC;QAChB,CAAC;IACL,CAAC;IAED;;;OAGG;IACK,aAAa,CACjB,OAAmC,EACnC,YAAwC,EACxC,SAAkC,EAClC,oBAAmC,EACnC,iBAA2C;QAE3C,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,IAAI,OAAO,EAAE,CAAC;YACV,KAAK,CAAC,IAAI,CAAC,YAAY,OAAO,CAAC,OAAO,IAAI,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC9G,CAAC;QAED,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;YACxB,KAAK,CAAC,IAAI,CAAC,YAAY,YAAY,CAAC,MAAM,UAAU,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,eAAe,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;QAClD,CAAC;QAED,IAAI,oBAAoB,KAAK,IAAI,EAAE,CAAC;YAChC,KAAK,CAAC,IAAI,CAAC,sBAAsB,oBAAoB,EAAE,CAAC,CAAC;QAC7D,CAAC;QAED,IAAI,iBAAiB,EAAE,CAAC;YACpB,MAAM,UAAU,GAAa,EAAE,CAAC;YAChC,IAAI,iBAAiB,CAAC,aAAa,KAAK,IAAI,IAAI,iBAAiB,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBAC5F,UAAU,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,aAAa,YAAY,CAAC,CAAC;YACpE,CAAC;YACD,IAAI,iBAAiB,CAAC,WAAW,KAAK,IAAI,IAAI,iBAAiB,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBACxF,UAAU,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,WAAW,UAAU,CAAC,CAAC;YAChE,CAAC;YACD,IAAI,iBAAiB,CAAC,YAAY,KAAK,IAAI,IAAI,iBAAiB,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;gBAC1F,UAAU,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,YAAY,WAAW,CAAC,CAAC;YAClE,CAAC;YACD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxB,KAAK,CAAC,IAAI,CAAC,SAAS,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACjD,CAAC;QACL,CAAC;QAED,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,4CAA4C,CAAC;IAC/F,CAAC"}

package/dist/sn/schema/SchemaDiscovery.d.ts

@@ -0,0 +1,68 @@
+import { ServiceNowInstance } from "../ServiceNowInstance.js";
+import { TableSchemaOptions, TableSchema, FieldExplanation, CatalogValidationResult } from './SchemaModels.js';
+/**
+ * SchemaDiscovery provides operations for discovering ServiceNow table schemas,
+ * explaining fields, and validating catalog configurations.
+ */
+export declare class SchemaDiscovery {
+    private static readonly SYS_DB_OBJECT_TABLE;
+    private static readonly SYS_DICTIONARY_TABLE;
+    private static readonly SYS_CHOICE_TABLE;
+    private static readonly ITEM_OPTION_NEW_TABLE;
+    private static readonly CATALOG_UI_POLICY_TABLE;
+    private _logger;
+    private _req;
+    private _tableAPI;
+    private _instance;
+    constructor(instance: ServiceNowInstance);
+    /**
+     * Discover the schema for a ServiceNow table.
+     * Queries sys_db_object for table info and sys_dictionary for field definitions.
+     * Optionally includes choice tables, relationships, UI policies, and business rules.
+     *
+     * @param tableName The name of the table to discover
+     * @param options Optional flags to include additional information
+     * @returns TableSchema with all discovered information
+     * @throws Error if tableName is empty or the table is not found
+     */
+    discoverTableSchema(tableName: string, options?: TableSchemaOptions): Promise<TableSchema>;
+    /**
+     * Explain a specific field on a table.
+     * Queries sys_dictionary for the field definition and sys_choice for available choices.
+     *
+     * @param tableName The table containing the field
+     * @param fieldName The field name to explain
+     * @returns Detailed FieldExplanation
+     * @throws Error if tableName or fieldName is empty, or the field is not found
+     */
+    explainField(tableName: string, fieldName: string): Promise<FieldExplanation>;
+    /**
+     * Validate a catalog item configuration.
+     * Checks variables (item_option_new) and UI policies (catalog_ui_policy) for integrity issues.
+     *
+     * @param catalogItemSysId The sys_id of the catalog item to validate
+     * @returns Validation result with issues, warnings, and errors
+     * @throws Error if catalogItemSysId is empty
+     */
+    validateCatalogConfiguration(catalogItemSysId: string): Promise<CatalogValidationResult>;
+    /**
+     * Get choice values for all fields on a table.
+     * @private
+     */
+    private _getChoicesForTable;
+    /**
+     * Extract relationship information from field schemas (reference fields).
+     * @private
+     */
+    private _extractRelationships;
+    /**
+     * Get UI policies for a table.
+     * @private
+     */
+    private _getUIPoliciesForTable;
+    /**
+     * Get business rules for a table.
+     * @private
+     */
+    private _getBusinessRulesForTable;
+}