@tracegraph/graph-engine 0.1.0

package/LICENSE

@@ -0,0 +1,181 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other derivative
+      works represent, as a whole, an original work of authorship. For the
+      purposes of this License, Derivative Works shall not include works
+      that remain separable from, or merely link (or bind by name) to the
+      interfaces of, the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the
+      purposes of this definition, "submitted" means any form of electronic,
+      verbal, or written communication sent to the Licensor or its
+      representatives, including but not limited to communication on
+      electronic mailing lists, source code control systems, and issue
+      tracking systems that are managed by, or on behalf of, the Licensor
+      for the purpose of discussing and improving the Work, but excluding
+      communication that is conspicuously marked or designated in writing
+      by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combined work to with their
+      Contribution(s) was submitted. If You institute patent litigation
+      against any entity (including a cross-claim or counterclaim in a
+      lawsuit) alleging that the Work or any Contribution embodied within
+      the Work constitutes direct or contributory patent infringement,
+      then any patent licenses granted to You under this License for that
+      Work shall terminate as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or as an addendum to
+          the NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Derivative Works, and to permit persons to whom the Derivative
+      Works is furnished to do so.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any conditions of TITLE,
+      NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR
+      PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may offer
+      only conditions consistent with this License, in a way that does
+      not create a new obligation for any Contributor to provide such
+      acceptance.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 TraceGraph Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/index.d.mts

@@ -0,0 +1,166 @@
+import { TraceEvent, CaptureLevel, TraceSession, EventRole, SemanticSignature, TraceEntrypoint, JsonShape, CompactBaseline, BehaviorDiff, SignatureChange, Finding, Suppression, FindingApproval, EvaluatedFinding } from '@tracegraph/shared-types';
+
+/**
+ * T1.6 — Graph engine
+ *
+ * Converts a finalised TraceSession into a TraceGraph suitable for rendering.
+ *
+ * Design decisions (ARCHITECTURE.md §9):
+ *  - Events from node_modules / vendor directories are collapsed into a single
+ *    node per package, keeping the graph focused on application code.
+ *  - Edges are derived from the parentEventId chain.
+ *  - asyncGroupId members are marked as parallel_branch edges.
+ *  - tracegraph_xdebug_marker events are stripped.
+ */
+
+type GraphNodeType = 'http_request' | 'http_response' | 'function_call' | 'method_call' | 'return' | 'db_query' | 'external_http_call' | 'auth_check' | 'authorization_check' | 'error' | 'log' | 'queue_event' | 'trace_start' | 'trace_end' | 'test_file' | 'test_suite' | 'test_run' | 'vendor' | 'other';
+type GraphNode = {
+    /** Stable node ID (equals eventId, or 'vendor__<pkg>' for collapsed packages). */
+    id: string;
+    label: string;
+    displayName?: string;
+    type: GraphNodeType;
+    language: string;
+    framework?: string;
+    durationMs?: number;
+    file?: string;
+    line?: number;
+    /** Hex colour string for the node. */
+    color: string;
+    /** Visual size (1–10 scale). */
+    size: number;
+    /** The original TraceEvent that produced this node. */
+    data: TraceEvent;
+};
+type GraphEdgeType = 'parent' | 'parallel_branch';
+type GraphEdge = {
+    id: string;
+    source: string;
+    target: string;
+    label?: string;
+    type: GraphEdgeType;
+};
+type TraceGraph = {
+    nodes: GraphNode[];
+    edges: GraphEdge[];
+    captureLevel: CaptureLevel;
+};
+/**
+ * Converts a TraceSession into a graph structure with nodes and edges.
+ *
+ * @returns A TraceGraph suitable for passing to the webview renderer.
+ */
+declare function traceSessionToGraph(session: TraceSession): TraceGraph;
+
+/**
+ * Classify an event into a semantic role.
+ * Auth events → "authorization"; validation-named functions → "validation";
+ * db_query → "db"; external_http_call → "external_call"; else → "business_logic".
+ */
+declare function classifyRole(event: TraceEvent): EventRole;
+/**
+ * Extract a `SemanticSignature` from a `TraceEvent`.
+ * The signature is identity-stable across file moves and line changes.
+ */
+declare function eventToSignature(event: TraceEvent): SemanticSignature;
+/**
+ * Produce a stable 16-char hex hash from a `SemanticSignature`.
+ *
+ * Fields included (in order): eventType, language, framework, className,
+ * methodName, functionName, routeMethod, routePathPattern, resourceType,
+ * resourceKey, resourceOperation, role.
+ *
+ * Fields NEVER included: file, line, column, packageName, eventId, traceId.
+ */
+declare function signatureToIdentityHash(sig: SemanticSignature): string;
+
+type BaselineMeta = {
+    approvedBy: string;
+    reason: string;
+};
+/**
+ * Convert a `TraceSession` into a `CompactBaseline`.
+ *
+ * @param session  The finalised trace session to baseline.
+ * @param meta     Who approved this baseline and why.
+ */
+declare function sessionToBaseline(session: TraceSession, meta: BaselineMeta): CompactBaseline;
+/**
+ * Derive a stable `testId` from a trace entrypoint.
+ * Two sessions covering the same route/test get the same testId.
+ */
+declare function deriveTestId(entrypoint: TraceEntrypoint): string;
+/**
+ * Recursively extract a `JsonShape` from a sanitised value.
+ * Arrays capture one representative element shape only.
+ */
+declare function extractShape(value: unknown, depth?: number, maxDepth?: number): JsonShape;
+
+/**
+ * T2.4 — BehaviorDiff engine — Structure mode
+ *
+ * Compares a CompactBaseline against a candidate TraceSession to produce
+ * a BehaviorDiff describing:
+ *   - Signatures present in baseline but absent in candidate (removedSignatures)
+ *   - Signatures present in candidate but absent in baseline (addedSignatures)
+ *   - Resource operation count changes
+ *   - Response shape changes (added/removed fields, type changes)
+ *
+ * Volatile values in candidate event outputs are normalised before comparison
+ * so that changing IDs (INV-001 vs INV-523) do not produce false diffs.
+ */
+
+/**
+ * Diff a `CompactBaseline` against a candidate `TraceSession`.
+ *
+ * The candidate's event outputs are normalised via `normaliseForDiff()` before
+ * shape comparison so that volatile values (UUIDs, IDs, timestamps) do not
+ * produce noise findings.
+ */
+declare function diffBaseline(baseline: CompactBaseline, candidate: TraceSession): BehaviorDiff;
+
+/**
+ * Convert a `BehaviorDiff` into a list of `Finding` objects.
+ */
+declare function diffToFindings(diff: BehaviorDiff): Finding[];
+/**
+ * Compute a stable 16-hex-char fingerprint for a finding.
+ * Never includes file path, line, or column.
+ */
+declare function computeFingerprint(input: {
+    ruleId: string;
+    removed: SignatureChange;
+}): string;
+
+/**
+ * T2.6 — Approval and suppression evaluator
+ *
+ * For each Finding, determines its effective status:
+ *   "approved"   — a non-expired FindingApproval matches by fingerprint
+ *   "suppressed" — a Suppression matches by ruleId + semanticTarget AND all
+ *                  requiresEvidence items exist in the candidate session
+ *   "open"       — no matching approval or suppression
+ *
+ * requiresEvidence self-invalidation:
+ *   A suppression that requires `authorization_check:RolePolicy.update` is only
+ *   effective when that event actually appears in the candidate trace.  If the
+ *   compensating function disappears, the suppression becomes invalid and the
+ *   finding surfaces as "open" (Critical if the original finding was Critical).
+ *
+ */
+
+declare function evaluateFindings(findings: Finding[], session: TraceSession, suppressions: Suppression[], approvals: FindingApproval[]): EvaluatedFinding[];
+
+declare const ANALYSE_RULES: {
+    readonly SENSITIVE_DATA_IN_RESPONSE: "security.sensitive_data.in_response";
+    readonly N_PLUS_ONE_QUERY: "reliability.n_plus_one_query";
+    readonly DUPLICATE_SIDE_EFFECTS: "reliability.duplicate_side_effects";
+    readonly MISSING_TRANSACTION: "reliability.missing_transaction";
+};
+/**
+ * Analyse a single `TraceSession` for intrinsic security and reliability
+ * findings (independent of any baseline comparison).
+ */
+declare function analyseTraceFindings(session: TraceSession): Finding[];
+
+export { ANALYSE_RULES, type BaselineMeta, type GraphEdge, type GraphEdgeType, type GraphNode, type GraphNodeType, type TraceGraph, analyseTraceFindings, classifyRole, computeFingerprint, deriveTestId, diffBaseline, diffToFindings, evaluateFindings, eventToSignature, extractShape, sessionToBaseline, signatureToIdentityHash, traceSessionToGraph };

package/dist/index.d.ts

@@ -0,0 +1,166 @@
+import { TraceEvent, CaptureLevel, TraceSession, EventRole, SemanticSignature, TraceEntrypoint, JsonShape, CompactBaseline, BehaviorDiff, SignatureChange, Finding, Suppression, FindingApproval, EvaluatedFinding } from '@tracegraph/shared-types';
+
+/**
+ * T1.6 — Graph engine
+ *
+ * Converts a finalised TraceSession into a TraceGraph suitable for rendering.
+ *
+ * Design decisions (ARCHITECTURE.md §9):
+ *  - Events from node_modules / vendor directories are collapsed into a single
+ *    node per package, keeping the graph focused on application code.
+ *  - Edges are derived from the parentEventId chain.
+ *  - asyncGroupId members are marked as parallel_branch edges.
+ *  - tracegraph_xdebug_marker events are stripped.
+ */
+
+type GraphNodeType = 'http_request' | 'http_response' | 'function_call' | 'method_call' | 'return' | 'db_query' | 'external_http_call' | 'auth_check' | 'authorization_check' | 'error' | 'log' | 'queue_event' | 'trace_start' | 'trace_end' | 'test_file' | 'test_suite' | 'test_run' | 'vendor' | 'other';
+type GraphNode = {
+    /** Stable node ID (equals eventId, or 'vendor__<pkg>' for collapsed packages). */
+    id: string;
+    label: string;
+    displayName?: string;
+    type: GraphNodeType;
+    language: string;
+    framework?: string;
+    durationMs?: number;
+    file?: string;
+    line?: number;
+    /** Hex colour string for the node. */
+    color: string;
+    /** Visual size (1–10 scale). */
+    size: number;
+    /** The original TraceEvent that produced this node. */
+    data: TraceEvent;
+};
+type GraphEdgeType = 'parent' | 'parallel_branch';
+type GraphEdge = {
+    id: string;
+    source: string;
+    target: string;
+    label?: string;
+    type: GraphEdgeType;
+};
+type TraceGraph = {
+    nodes: GraphNode[];
+    edges: GraphEdge[];
+    captureLevel: CaptureLevel;
+};
+/**
+ * Converts a TraceSession into a graph structure with nodes and edges.
+ *
+ * @returns A TraceGraph suitable for passing to the webview renderer.
+ */
+declare function traceSessionToGraph(session: TraceSession): TraceGraph;
+
+/**
+ * Classify an event into a semantic role.
+ * Auth events → "authorization"; validation-named functions → "validation";
+ * db_query → "db"; external_http_call → "external_call"; else → "business_logic".
+ */
+declare function classifyRole(event: TraceEvent): EventRole;
+/**
+ * Extract a `SemanticSignature` from a `TraceEvent`.
+ * The signature is identity-stable across file moves and line changes.
+ */
+declare function eventToSignature(event: TraceEvent): SemanticSignature;
+/**
+ * Produce a stable 16-char hex hash from a `SemanticSignature`.
+ *
+ * Fields included (in order): eventType, language, framework, className,
+ * methodName, functionName, routeMethod, routePathPattern, resourceType,
+ * resourceKey, resourceOperation, role.
+ *
+ * Fields NEVER included: file, line, column, packageName, eventId, traceId.
+ */
+declare function signatureToIdentityHash(sig: SemanticSignature): string;
+
+type BaselineMeta = {
+    approvedBy: string;
+    reason: string;
+};
+/**
+ * Convert a `TraceSession` into a `CompactBaseline`.
+ *
+ * @param session  The finalised trace session to baseline.
+ * @param meta     Who approved this baseline and why.
+ */
+declare function sessionToBaseline(session: TraceSession, meta: BaselineMeta): CompactBaseline;
+/**
+ * Derive a stable `testId` from a trace entrypoint.
+ * Two sessions covering the same route/test get the same testId.
+ */
+declare function deriveTestId(entrypoint: TraceEntrypoint): string;
+/**
+ * Recursively extract a `JsonShape` from a sanitised value.
+ * Arrays capture one representative element shape only.
+ */
+declare function extractShape(value: unknown, depth?: number, maxDepth?: number): JsonShape;
+
+/**
+ * T2.4 — BehaviorDiff engine — Structure mode
+ *
+ * Compares a CompactBaseline against a candidate TraceSession to produce
+ * a BehaviorDiff describing:
+ *   - Signatures present in baseline but absent in candidate (removedSignatures)
+ *   - Signatures present in candidate but absent in baseline (addedSignatures)
+ *   - Resource operation count changes
+ *   - Response shape changes (added/removed fields, type changes)
+ *
+ * Volatile values in candidate event outputs are normalised before comparison
+ * so that changing IDs (INV-001 vs INV-523) do not produce false diffs.
+ */
+
+/**
+ * Diff a `CompactBaseline` against a candidate `TraceSession`.
+ *
+ * The candidate's event outputs are normalised via `normaliseForDiff()` before
+ * shape comparison so that volatile values (UUIDs, IDs, timestamps) do not
+ * produce noise findings.
+ */
+declare function diffBaseline(baseline: CompactBaseline, candidate: TraceSession): BehaviorDiff;
+
+/**
+ * Convert a `BehaviorDiff` into a list of `Finding` objects.
+ */
+declare function diffToFindings(diff: BehaviorDiff): Finding[];
+/**
+ * Compute a stable 16-hex-char fingerprint for a finding.
+ * Never includes file path, line, or column.
+ */
+declare function computeFingerprint(input: {
+    ruleId: string;
+    removed: SignatureChange;
+}): string;
+
+/**
+ * T2.6 — Approval and suppression evaluator
+ *
+ * For each Finding, determines its effective status:
+ *   "approved"   — a non-expired FindingApproval matches by fingerprint
+ *   "suppressed" — a Suppression matches by ruleId + semanticTarget AND all
+ *                  requiresEvidence items exist in the candidate session
+ *   "open"       — no matching approval or suppression
+ *
+ * requiresEvidence self-invalidation:
+ *   A suppression that requires `authorization_check:RolePolicy.update` is only
+ *   effective when that event actually appears in the candidate trace.  If the
+ *   compensating function disappears, the suppression becomes invalid and the
+ *   finding surfaces as "open" (Critical if the original finding was Critical).
+ *
+ */
+
+declare function evaluateFindings(findings: Finding[], session: TraceSession, suppressions: Suppression[], approvals: FindingApproval[]): EvaluatedFinding[];
+
+declare const ANALYSE_RULES: {
+    readonly SENSITIVE_DATA_IN_RESPONSE: "security.sensitive_data.in_response";
+    readonly N_PLUS_ONE_QUERY: "reliability.n_plus_one_query";
+    readonly DUPLICATE_SIDE_EFFECTS: "reliability.duplicate_side_effects";
+    readonly MISSING_TRANSACTION: "reliability.missing_transaction";
+};
+/**
+ * Analyse a single `TraceSession` for intrinsic security and reliability
+ * findings (independent of any baseline comparison).
+ */
+declare function analyseTraceFindings(session: TraceSession): Finding[];
+
+export { ANALYSE_RULES, type BaselineMeta, type GraphEdge, type GraphEdgeType, type GraphNode, type GraphNodeType, type TraceGraph, analyseTraceFindings, classifyRole, computeFingerprint, deriveTestId, diffBaseline, diffToFindings, evaluateFindings, eventToSignature, extractShape, sessionToBaseline, signatureToIdentityHash, traceSessionToGraph };