@cyvest/cyvest-js 7.2.3 → 7.3.0

package/dist/index.cjs

@@ -392,7 +392,7 @@ var cyvest_schema_default = {
 			"type": "object"
 		},
 		"FindingResult": {
-			"description": "A finding's verdict.\n\n``own_term_suppressed`` flags that the rule's own claim was overridden by a stronger link —\na contradiction worth surfacing rather than silently dropping.\n\nThree combinations of ``(counted, score)`` are meaningful, and a consumer must not conflate\nthe last two:\n\n- ``(True, float)`` — an additive finding, a term of the total;\n- ``(False, None)`` — dismissed or not evaluated: visible, but out of the evaluation;\n- ``(True, None)`` — a conclusion (``effect`` is ``FLOOR`` or ``CEILING``): it takes part, but\n  it has no magnitude of its own. Its effect is a bound on the investigation total, reported\n  as a contribution of :class:`InvestigationResult`.",
+			"description": "A finding's verdict.\n\n``own_term_suppressed`` flags that the rule's own claim was overridden by a stronger link —\na contradiction worth surfacing rather than silently dropping.\n\nThree combinations of ``(counted, score)`` are meaningful, and a consumer must not conflate\nthe last two:\n\n- ``(True, float)`` — an additive finding with a local score;\n- ``(False, None)`` — dismissed or not evaluated: visible, but out of the evaluation;\n- ``(True, None)`` — a conclusion (``effect`` is ``FLOOR`` or ``CEILING``): it takes part, but\n  it has no magnitude of its own. Its effect is a bound on the investigation total, reported\n  as a contribution of :class:`InvestigationResult`.\n\n    ``basic-v1`` sums local finding scores; ``basic-v2`` counts their retained fact origins\n    once across the investigation.",
 			"properties": {
 				"key": {
 					"title": "Key",
@@ -445,6 +445,27 @@ var cyvest_schema_default = {
 					"default": true,
 					"title": "Counted",
 					"type": "boolean"
+				},
+				"contribution_score": {
+					"anyOf": [{ "type": "number" }, { "type": "null" }],
+					"default": null,
+					"description": "Signed credit allocated to this finding in the investigation total, including conclusion deltas. None means the producing engine or older report did not supply attribution.",
+					"title": "Contribution Score"
+				},
+				"contribution_status": {
+					"anyOf": [{
+						"enum": [
+							"credited",
+							"shared",
+							"partial",
+							"excluded",
+							"neutral"
+						],
+						"type": "string"
+					}, { "type": "null" }],
+					"default": null,
+					"description": "credited: retained numeric origins (possibly cancelling to zero); shared: all numeric origins already credited; partial: some retained and some shared; excluded: not counted; neutral: no numeric effect. None means attribution is unavailable.",
+					"title": "Contribution Status"
 				}
 			},
 			"required": ["key"],
@@ -1187,7 +1208,7 @@ var cyvest_schema_default = {
 	description: "A complete serialized investigation.",
 	properties: {
 		"schema_version": {
-			"default": "7.1.0",
+			"default": "7.3.0",
 			"pattern": "^7\\.\\d+\\.\\d+$",
 			"title": "Schema Version",
 			"type": "string"
@@ -1233,7 +1254,7 @@ var cyvest_schema_default = {
 * window is the SDK's job alone; reading and judging the version first also keeps the error
 * message explicit instead of an opaque ajv shape error.
 */
-const SCHEMA_VERSION = "7.1.0";
+const SCHEMA_VERSION = "7.3.0";
 const SEMVER = /^\d+\.\d+\.\d+$/;
 const ajv = new ajv_dist_2020_js.default({ allErrors: true });
 (0, ajv_formats.default)(ajv);

package/dist/index.d.cts

@@ -136,6 +136,14 @@ export type Score = number | null;
 export type Contributions = Contribution[];
 export type Score1 = number | null;
 export type Contributions1 = Contribution[];
+/**
+ * Signed credit allocated to this finding in the investigation total, including conclusion deltas. None means the producing engine or older report did not supply attribution.
+ */
+export type ContributionScore = number | null;
+/**
+ * credited: retained numeric origins (possibly cancelling to zero); shared: all numeric origins already credited; partial: some retained and some shared; excluded: not counted; neutral: no numeric effect. None means attribution is unavailable.
+ */
+export type ContributionStatus = ("credited" | "shared" | "partial" | "excluded" | "neutral") | null;
 export type Score2 = number | null;
 export type Contributions2 = Contribution[];
 /**
@@ -477,11 +485,14 @@ export interface Findings1 {
  * Three combinations of ``(counted, score)`` are meaningful, and a consumer must not conflate
  * the last two:
  *
- * - ``(True, float)`` — an additive finding, a term of the total;
+ * - ``(True, float)`` — an additive finding with a local score;
  * - ``(False, None)`` — dismissed or not evaluated: visible, but out of the evaluation;
  * - ``(True, None)`` — a conclusion (``effect`` is ``FLOOR`` or ``CEILING``): it takes part, but
  *   it has no magnitude of its own. Its effect is a bound on the investigation total, reported
  *   as a contribution of :class:`InvestigationResult`.
+ *
+ *     ``basic-v1`` sums local finding scores; ``basic-v2`` counts their retained fact origins
+ *     once across the investigation.
  */
 export interface FindingResult {
   key: string;
@@ -495,6 +506,8 @@ export interface FindingResult {
   effect?: Effect;
   own_term_suppressed?: boolean;
   counted?: boolean;
+  contribution_score?: ContributionScore;
+  contribution_status?: ContributionStatus;
   [k: string]: unknown;
 }
 export interface Raw1 {
@@ -534,7 +547,7 @@ type FindingResult$1 = FindingResult;
 type InvestigationResult$1 = InvestigationResult;
 //#endregion
 //#region src/helpers.d.ts
-export declare const SCHEMA_VERSION = "7.1.0";
+export declare const SCHEMA_VERSION = "7.3.0";
 /**
  * Read the declared schema version, falling back to `"5"` for anything unversioned.
  *

package/dist/index.d.ts

@@ -136,6 +136,14 @@ export type Score = number | null;
 export type Contributions = Contribution[];
 export type Score1 = number | null;
 export type Contributions1 = Contribution[];
+/**
+ * Signed credit allocated to this finding in the investigation total, including conclusion deltas. None means the producing engine or older report did not supply attribution.
+ */
+export type ContributionScore = number | null;
+/**
+ * credited: retained numeric origins (possibly cancelling to zero); shared: all numeric origins already credited; partial: some retained and some shared; excluded: not counted; neutral: no numeric effect. None means attribution is unavailable.
+ */
+export type ContributionStatus = ("credited" | "shared" | "partial" | "excluded" | "neutral") | null;
 export type Score2 = number | null;
 export type Contributions2 = Contribution[];
 /**
@@ -477,11 +485,14 @@ export interface Findings1 {
  * Three combinations of ``(counted, score)`` are meaningful, and a consumer must not conflate
  * the last two:
  *
- * - ``(True, float)`` — an additive finding, a term of the total;
+ * - ``(True, float)`` — an additive finding with a local score;
  * - ``(False, None)`` — dismissed or not evaluated: visible, but out of the evaluation;
  * - ``(True, None)`` — a conclusion (``effect`` is ``FLOOR`` or ``CEILING``): it takes part, but
  *   it has no magnitude of its own. Its effect is a bound on the investigation total, reported
  *   as a contribution of :class:`InvestigationResult`.
+ *
+ *     ``basic-v1`` sums local finding scores; ``basic-v2`` counts their retained fact origins
+ *     once across the investigation.
  */
 export interface FindingResult {
   key: string;
@@ -495,6 +506,8 @@ export interface FindingResult {
   effect?: Effect;
   own_term_suppressed?: boolean;
   counted?: boolean;
+  contribution_score?: ContributionScore;
+  contribution_status?: ContributionStatus;
   [k: string]: unknown;
 }
 export interface Raw1 {
@@ -534,7 +547,7 @@ type FindingResult$1 = FindingResult;
 type InvestigationResult$1 = InvestigationResult;
 //#endregion
 //#region src/helpers.d.ts
-export declare const SCHEMA_VERSION = "7.1.0";
+export declare const SCHEMA_VERSION = "7.3.0";
 /**
  * Read the declared schema version, falling back to `"5"` for anything unversioned.
  *

package/dist/index.js

@@ -367,7 +367,7 @@ var cyvest_schema_default = {
 			"type": "object"
 		},
 		"FindingResult": {
-			"description": "A finding's verdict.\n\n``own_term_suppressed`` flags that the rule's own claim was overridden by a stronger link —\na contradiction worth surfacing rather than silently dropping.\n\nThree combinations of ``(counted, score)`` are meaningful, and a consumer must not conflate\nthe last two:\n\n- ``(True, float)`` — an additive finding, a term of the total;\n- ``(False, None)`` — dismissed or not evaluated: visible, but out of the evaluation;\n- ``(True, None)`` — a conclusion (``effect`` is ``FLOOR`` or ``CEILING``): it takes part, but\n  it has no magnitude of its own. Its effect is a bound on the investigation total, reported\n  as a contribution of :class:`InvestigationResult`.",
+			"description": "A finding's verdict.\n\n``own_term_suppressed`` flags that the rule's own claim was overridden by a stronger link —\na contradiction worth surfacing rather than silently dropping.\n\nThree combinations of ``(counted, score)`` are meaningful, and a consumer must not conflate\nthe last two:\n\n- ``(True, float)`` — an additive finding with a local score;\n- ``(False, None)`` — dismissed or not evaluated: visible, but out of the evaluation;\n- ``(True, None)`` — a conclusion (``effect`` is ``FLOOR`` or ``CEILING``): it takes part, but\n  it has no magnitude of its own. Its effect is a bound on the investigation total, reported\n  as a contribution of :class:`InvestigationResult`.\n\n    ``basic-v1`` sums local finding scores; ``basic-v2`` counts their retained fact origins\n    once across the investigation.",
 			"properties": {
 				"key": {
 					"title": "Key",
@@ -420,6 +420,27 @@ var cyvest_schema_default = {
 					"default": true,
 					"title": "Counted",
 					"type": "boolean"
+				},
+				"contribution_score": {
+					"anyOf": [{ "type": "number" }, { "type": "null" }],
+					"default": null,
+					"description": "Signed credit allocated to this finding in the investigation total, including conclusion deltas. None means the producing engine or older report did not supply attribution.",
+					"title": "Contribution Score"
+				},
+				"contribution_status": {
+					"anyOf": [{
+						"enum": [
+							"credited",
+							"shared",
+							"partial",
+							"excluded",
+							"neutral"
+						],
+						"type": "string"
+					}, { "type": "null" }],
+					"default": null,
+					"description": "credited: retained numeric origins (possibly cancelling to zero); shared: all numeric origins already credited; partial: some retained and some shared; excluded: not counted; neutral: no numeric effect. None means attribution is unavailable.",
+					"title": "Contribution Status"
 				}
 			},
 			"required": ["key"],
@@ -1162,7 +1183,7 @@ var cyvest_schema_default = {
 	description: "A complete serialized investigation.",
 	properties: {
 		"schema_version": {
-			"default": "7.1.0",
+			"default": "7.3.0",
 			"pattern": "^7\\.\\d+\\.\\d+$",
 			"title": "Schema Version",
 			"type": "string"
@@ -1208,7 +1229,7 @@ var cyvest_schema_default = {
 * window is the SDK's job alone; reading and judging the version first also keeps the error
 * message explicit instead of an opaque ajv shape error.
 */
-const SCHEMA_VERSION = "7.1.0";
+const SCHEMA_VERSION = "7.3.0";
 const SEMVER = /^\d+\.\d+\.\d+$/;
 const ajv = new Ajv2020({ allErrors: true });
 addFormats(ajv);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cyvest/cyvest-js",
-  "version": "7.2.3",
+  "version": "7.3.0",
   "description": "Typed reader for Cyvest investigation documents: schema validation, fact accessors, and graph helpers.",
   "keywords": [
     "cybersecurity",