@scoutflo/correlation-core

Pure shared correlation contracts and Zod schemas for Scoutflo correlation workflows.

This package owns reusable vocabulary only:

• entity refs
• facts and fact kinds
• evidence
• confidence and confidence source
• candidates
• decisions and statuses
• diagnostics
• source refs
• stable key contract types
• correlation contract framework types and registry

It does not own provider clients, database models, Express controllers, LangGraph state, topology apply logic, provider payload storage, or lifecycle authority.

Version

Current package version: 0.2.0.

0.2.0 adds additive fact/evidence provenance fields and the CorrelationContract registry framework. It does not add concrete contracts or matcher behavior.

Usage

import {
  correlationDecisionSchema,
  type CorrelationDecision,
} from '@scoutflo/correlation-core';

const decision: CorrelationDecision = correlationDecisionSchema.parse(input);

Release Flow

Use this flow when releasing only @scoutflo/correlation-core. Do not publish the root @scoutflo/integration-sdk package for a correlation-core-only release.

npm run build --workspace @scoutflo/correlation-core
npm test --workspace @scoutflo/correlation-core
npm pack --dry-run --workspace @scoutflo/correlation-core

If local npm cache permissions fail during npm pack --dry-run, use a repo-local cache:

mkdir -p .tmp/npm-cache
npm_config_cache=.tmp/npm-cache npm pack --dry-run --workspace @scoutflo/correlation-core

After release approval:

npm view @scoutflo/[email protected] version
npm publish --workspace @scoutflo/correlation-core
npm view @scoutflo/[email protected] version

Consumer Order

1. Publish @scoutflo/correlation-core.
2. Publish a compatible @scoutflo/alert-correlation version that depends on it.
3. Migrate Gateway imports where local DTO drift is highest.
4. Migrate Voyager validation after Gateway returns shared-compatible context.
5. Update Client only if it gains a direct shared-contract dependency.