@scoutflo/alert-correlation 0.2.0 → 0.2.1

package/README.md

@@ -4,14 +4,22 @@ Pure alert-to-topology correlation contracts and policies for Scoutflo alert inv
 
 This package intentionally owns only shared contracts, extraction, matching, scoring, and decision logic. Provider detail fetching, tenant authorization, topology loading, topology slice construction, and API response shaping stay in Gateway. Investigation lifecycle and supervisor startup stay in Voyager.
 
+## Relationship To Correlation Core
+
+Reusable cross-mode contracts live in `@scoutflo/correlation-core`.
+
+`@scoutflo/alert-correlation` remains alert-specific. It owns `AlertRef`, alert time windows, provider alert extractors, alert-to-topology matching, alert-specific scoring, and alert decision behavior.
+
+This package consumes core entity, fact, and status primitives where safe. It also exports `correlationCore` as a namespace for compatibility during migration, without replacing existing alert-specific export names.
+
 ## Version
 
-Current package version: `0.2.0`.
+Current package version: `0.2.1`.
 
 Gateway and Voyager should consume the exact published version:
 
 ```json
-"@scoutflo/alert-correlation": "0.2.0"
+"@scoutflo/alert-correlation": "0.2.1"
 ```
 
 During local development, consumers may temporarily use a `file:` dependency pointed at `../integration-sdk/packages/alert-correlation`, then replace it with the exact npm version before release.
@@ -88,7 +96,7 @@ If `npm view` returns `E404` immediately after a successful publish, wait and re
 After the version is visible, update Gateway and Voyager from any local `file:` dependency to the exact published version, for example:
 
 ```json
-"@scoutflo/alert-correlation": "0.2.0"
+"@scoutflo/alert-correlation": "0.2.1"
 ```
 
 Run install and the relevant tests in each consumer repo after updating its dependency lockfile.

package/dist/src/contracts/decision.d.ts

@@ -1,4 +1,5 @@
-export type CorrelationStatus = 'resolved' | 'ambiguous' | 'degraded' | 'unresolved';
+import type { CorrelationEntityRef, CorrelationStatus as CoreCorrelationStatus } from '@scoutflo/correlation-core';
+export type CorrelationStatus = Extract<CoreCorrelationStatus, 'resolved' | 'ambiguous' | 'degraded' | 'unresolved'>;
 export interface CorrelationEvidence {
     kind: 'relationship_attribute' | 'raw_alert_field' | 'resource_inference' | 'fallback';
     factKey?: string;
@@ -7,10 +8,7 @@ export interface CorrelationEvidence {
     reason: string;
 }
 export interface CorrelationCandidate {
-    target: {
-        type: 'service' | 'resource';
-        id: string;
-    };
+    target: CorrelationEntityRef;
     name?: string;
     confidence: number;
     evidence: CorrelationEvidence[];
@@ -18,10 +16,7 @@ export interface CorrelationCandidate {
 }
 export interface AlertCorrelationDecision {
     status: CorrelationStatus;
-    target: {
-        type: 'service' | 'resource';
-        id: string;
-    } | null;
+    target: CorrelationEntityRef | null;
     candidates: CorrelationCandidate[];
     evidence: CorrelationEvidence[];
     confidence: number;

package/dist/src/contracts/facts.d.ts

@@ -1,9 +1,6 @@
-export type FactKind = 'label' | 'tag' | 'annotation' | 'provider_identity' | 'resource_hint' | 'text_derived' | 'time';
-export interface Fact {
-    key: string;
-    value: string;
-    sourcePath: string;
-    confidence: number;
+import type { CorrelationFact, FactKind as CoreFactKind } from '@scoutflo/correlation-core';
+export type FactKind = Extract<CoreFactKind, 'label' | 'tag' | 'annotation' | 'provider_identity' | 'resource_hint' | 'text_derived' | 'time'>;
+export interface Fact extends Omit<CorrelationFact, 'kind'> {
     kind: FactKind;
 }
 export interface AlertTimeWindow {

package/dist/src/contracts/topology.d.ts

@@ -1,8 +1,6 @@
-export type CorrelationEntityType = 'service' | 'resource';
-export interface CorrelationTopologyEntityRef {
-    type: CorrelationEntityType;
-    id: string;
-}
+import type { CorrelationEntityRef, CorrelationEntityType } from '@scoutflo/correlation-core';
+export type { CorrelationEntityType };
+export type CorrelationTopologyEntityRef = CorrelationEntityRef;
 export interface CorrelationService {
     id: string;
     name: string;

package/dist/src/index.d.ts

@@ -1,4 +1,5 @@
 export declare const ALERT_CORRELATION_PACKAGE = "@scoutflo/alert-correlation";
+export * as correlationCore from '@scoutflo/correlation-core';
 export * from './contracts/alertRef';
 export * from './contracts/facts';
 export * from './contracts/topology';

package/dist/src/index.js

@@ -10,12 +10,35 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ALERT_CORRELATION_PACKAGE = void 0;
+exports.correlationCore = exports.ALERT_CORRELATION_PACKAGE = void 0;
 exports.ALERT_CORRELATION_PACKAGE = '@scoutflo/alert-correlation';
+exports.correlationCore = __importStar(require("@scoutflo/correlation-core"));
 __exportStar(require("./contracts/alertRef"), exports);
 __exportStar(require("./contracts/facts"), exports);
 __exportStar(require("./contracts/topology"), exports);

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAa,QAAA,yBAAyB,GAAG,6BAA6B,CAAC;AAEvE,uDAAqC;AACrC,oDAAkC;AAClC,uDAAqC;AACrC,uDAAqC;AACrC,sDAAoC;AACpC,4DAA0C;AAC1C,qDAAmC;AACnC,gEAA8C;AAC9C,mEAAiD;AACjD,+DAA6C;AAC7C,wEAAsD;AACtD,wDAAsC;AACtC,yDAAuC;AACvC,0DAAwC;AACxC,mDAAiC;AACjC,yEAAuD;AACvD,4DAA0C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAa,QAAA,yBAAyB,GAAG,6BAA6B,CAAC;AAEvE,8EAA8D;AAE9D,uDAAqC;AACrC,oDAAkC;AAClC,uDAAqC;AACrC,uDAAqC;AACrC,sDAAoC;AACpC,4DAA0C;AAC1C,qDAAmC;AACnC,gEAA8C;AAC9C,mEAAiD;AACjD,+DAA6C;AAC7C,wEAAsD;AACtD,wDAAsC;AACtC,yDAAuC;AACvC,0DAAwC;AACxC,mDAAiC;AACjC,yEAAuD;AACvD,4DAA0C"}

package/dist/test/core-compatibility.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/core-compatibility.test.js

@@ -0,0 +1,50 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const strict_1 = __importDefault(require("node:assert/strict"));
+const node_test_1 = __importDefault(require("node:test"));
+const src_1 = require("../src");
+(0, node_test_1.default)('alert facts remain core fact compatible', () => {
+    const fact = {
+        key: 'service',
+        value: 'checkout',
+        sourcePath: 'labels.service',
+        confidence: 0.8,
+        kind: 'label',
+    };
+    const parsed = src_1.correlationCore.correlationFactSchema.parse(fact);
+    strict_1.default.equal(parsed.key, 'service');
+    strict_1.default.equal(parsed.kind, 'label');
+});
+(0, node_test_1.default)('alert topology entity refs use the core entity ref shape', () => {
+    const ref = {
+        type: 'service',
+        id: 'svc-checkout',
+    };
+    const parsed = src_1.correlationCore.correlationEntityRefSchema.parse(ref);
+    strict_1.default.deepEqual(parsed, ref);
+});
+(0, node_test_1.default)('alert decisions preserve legacy confidence candidate shape', () => {
+    const candidate = {
+        target: { type: 'service', id: 'svc-checkout' },
+        name: 'checkout',
+        confidence: 10,
+        evidence: [
+            {
+                kind: 'relationship_attribute',
+                factKey: 'service',
+                factValue: 'checkout',
+                relationshipId: 'rel-1',
+                reason: 'serviceLabel exact match',
+            },
+        ],
+        reasonCodes: ['relationship_attribute_match'],
+    };
+    const decision = (0, src_1.decideTarget)([candidate]);
+    strict_1.default.equal(decision.status, 'resolved');
+    strict_1.default.equal(decision.confidence, 10);
+    strict_1.default.deepEqual(decision.target, { type: 'service', id: 'svc-checkout' });
+});
+//# sourceMappingURL=core-compatibility.test.js.map

package/dist/test/core-compatibility.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core-compatibility.test.js","sourceRoot":"","sources":["../../test/core-compatibility.test.ts"],"names":[],"mappings":";;;;;AAAA,gEAAwC;AACxC,0DAA6B;AAC7B,gCAOgB;AAEhB,IAAA,mBAAI,EAAC,yCAAyC,EAAE,GAAG,EAAE;IACnD,MAAM,IAAI,GAAS;QACjB,GAAG,EAAE,SAAS;QACd,KAAK,EAAE,UAAU;QACjB,UAAU,EAAE,gBAAgB;QAC5B,UAAU,EAAE,GAAG;QACf,IAAI,EAAE,OAAO;KACd,CAAC;IAEF,MAAM,MAAM,GAAG,qBAAe,CAAC,qBAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAEjE,gBAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IACpC,gBAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AACrC,CAAC,CAAC,CAAC;AAEH,IAAA,mBAAI,EAAC,0DAA0D,EAAE,GAAG,EAAE;IACpE,MAAM,GAAG,GAAiC;QACxC,IAAI,EAAE,SAAS;QACf,EAAE,EAAE,cAAc;KACnB,CAAC;IAEF,MAAM,MAAM,GAAG,qBAAe,CAAC,0BAA0B,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAErE,gBAAM,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAChC,CAAC,CAAC,CAAC;AAEH,IAAA,mBAAI,EAAC,4DAA4D,EAAE,GAAG,EAAE;IACtE,MAAM,SAAS,GAAyB;QACtC,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,cAAc,EAAE;QAC/C,IAAI,EAAE,UAAU;QAChB,UAAU,EAAE,EAAE;QACd,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,wBAAwB;gBAC9B,OAAO,EAAE,SAAS;gBAClB,SAAS,EAAE,UAAU;gBACrB,cAAc,EAAE,OAAO;gBACvB,MAAM,EAAE,0BAA0B;aACnC;SACF;QACD,WAAW,EAAE,CAAC,8BAA8B,CAAC;KAC9C,CAAC;IAEF,MAAM,QAAQ,GAA6B,IAAA,kBAAY,EAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAErE,gBAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC1C,gBAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IACtC,gBAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC;AAC7E,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scoutflo/alert-correlation",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Pure alert-to-topology correlation contracts and policies for Scoutflo alert investigation workflows.",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -19,6 +19,7 @@
   "author": "Scoutflo",
   "license": "MIT",
   "dependencies": {
+    "@scoutflo/correlation-core": "0.1.0",
     "zod": "^3.23.8"
   },
   "devDependencies": {