@suss/extractor 0.1.1 → 0.3.0

package/dist/index.cjs

@@ -32,6 +32,86 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 var import_node_crypto = require("crypto");
 
+// src/inputReads.ts
+function inputReadsOf(args) {
+  const found = /* @__PURE__ */ new Map();
+  const keep = (read) => {
+    if (read === null) {
+      return;
+    }
+    found.set(`${read.input}.${read.path.join(".")}`, read);
+  };
+  for (const value of args.values) {
+    keep(readOf(value));
+  }
+  for (const list of args.conditions) {
+    for (const predicate of list) {
+      for (const value of valuesIn(predicate)) {
+        keep(readOf(value));
+      }
+    }
+  }
+  return [...found.values()].sort(
+    (a, b) => a.input.localeCompare(b.input) || a.path.join(".").localeCompare(b.path.join("."))
+  );
+}
+function readOf(value, depth = 0) {
+  if (depth > 12) {
+    return null;
+  }
+  if (value.type === "input") {
+    return { input: value.inputRef, path: [...value.path] };
+  }
+  if (value.type !== "derived") {
+    return null;
+  }
+  const inner = readOf(value.from, depth + 1);
+  if (inner === null) {
+    return null;
+  }
+  const step = stepOf(value.derivation);
+  return step === null ? inner : { input: inner.input, path: [...inner.path, step] };
+}
+function stepOf(derivation) {
+  if (derivation.type === "propertyAccess") {
+    return typeof derivation.property === "string" ? derivation.property : null;
+  }
+  if (derivation.type === "destructured") {
+    return typeof derivation.field === "string" ? derivation.field : null;
+  }
+  return null;
+}
+function valuesIn(predicate, depth = 0) {
+  if (depth > 12) {
+    return [];
+  }
+  const out = [];
+  const record = predicate;
+  for (const value of Object.values(record)) {
+    if (value === null || typeof value !== "object") {
+      continue;
+    }
+    if (Array.isArray(value)) {
+      for (const item of value) {
+        out.push(...nested(item, depth));
+      }
+      continue;
+    }
+    out.push(...nested(value, depth));
+  }
+  return out;
+}
+function nested(value, depth) {
+  if (value === null || typeof value !== "object") {
+    return [];
+  }
+  const kind = value.type;
+  if (kind === "input" || kind === "derived") {
+    return [value];
+  }
+  return valuesIn(value, depth + 1);
+}
+
 // src/packHelpers.ts
 function httpRouteDiscovery(opts) {
   const kind = opts.kind ?? "handler";
@@ -52,6 +132,12 @@ function httpRouteDiscovery(opts) {
 }
 
 // src/index.ts
+function valuesOfOutput(output) {
+  if (output.type === "response" && output.statusCode !== null) {
+    return [output.statusCode];
+  }
+  return [];
+}
 var DEFAULT_OPTIONS = { gapHandling: "permissive" };
 function makeTransitionId(functionName, branch) {
   const { terminal } = branch;
@@ -85,6 +171,10 @@ function assembleSummary(raw, options = DEFAULT_OPTIONS) {
   const confidence = assessConfidence(raw);
   const inputs = raw.parameters.map(paramToInput);
   const metadata = buildMetadata(raw);
+  const reads = inputReadsOf({
+    conditions: transitions.map((t) => t.conditions),
+    values: transitions.flatMap((t) => valuesOfOutput(t.output))
+  });
   return {
     kind: raw.identity.kind,
     location: {
@@ -102,6 +192,8 @@ function assembleSummary(raw, options = DEFAULT_OPTIONS) {
     transitions,
     gaps,
     confidence,
+    ...reads.length > 0 ? { inputReads: reads } : {},
+    ...raw.definitions !== void 0 && raw.definitions !== null ? { definitions: raw.definitions } : {},
     ...metadata !== null ? { metadata } : {}
   };
 }

package/dist/index.d.cts

@@ -1299,6 +1299,12 @@ interface RawDeclaredContract {
  */
 type BodyContent = "absent" | "empty" | "statements" | "elsewhere";
 interface RawCodeStructure {
+    /**
+     * The types this unit's shapes name rather than spell out. Carried
+     * onto the summary as `definitions`, so a reader following a name has
+     * somewhere to look.
+     */
+    definitions?: Record<string, TypeShape> | null;
     identity: {
         name: string;
         kind: CodeUnitKind;

package/dist/index.d.ts

@@ -1299,6 +1299,12 @@ interface RawDeclaredContract {
  */
 type BodyContent = "absent" | "empty" | "statements" | "elsewhere";
 interface RawCodeStructure {
+    /**
+     * The types this unit's shapes name rather than spell out. Carried
+     * onto the summary as `definitions`, so a reader following a name has
+     * somewhere to look.
+     */
+    definitions?: Record<string, TypeShape> | null;
     identity: {
         name: string;
         kind: CodeUnitKind;

package/dist/index.js

@@ -1,6 +1,86 @@
 // src/index.ts
 import { createHash } from "crypto";
 
+// src/inputReads.ts
+function inputReadsOf(args) {
+  const found = /* @__PURE__ */ new Map();
+  const keep = (read) => {
+    if (read === null) {
+      return;
+    }
+    found.set(`${read.input}.${read.path.join(".")}`, read);
+  };
+  for (const value of args.values) {
+    keep(readOf(value));
+  }
+  for (const list of args.conditions) {
+    for (const predicate of list) {
+      for (const value of valuesIn(predicate)) {
+        keep(readOf(value));
+      }
+    }
+  }
+  return [...found.values()].sort(
+    (a, b) => a.input.localeCompare(b.input) || a.path.join(".").localeCompare(b.path.join("."))
+  );
+}
+function readOf(value, depth = 0) {
+  if (depth > 12) {
+    return null;
+  }
+  if (value.type === "input") {
+    return { input: value.inputRef, path: [...value.path] };
+  }
+  if (value.type !== "derived") {
+    return null;
+  }
+  const inner = readOf(value.from, depth + 1);
+  if (inner === null) {
+    return null;
+  }
+  const step = stepOf(value.derivation);
+  return step === null ? inner : { input: inner.input, path: [...inner.path, step] };
+}
+function stepOf(derivation) {
+  if (derivation.type === "propertyAccess") {
+    return typeof derivation.property === "string" ? derivation.property : null;
+  }
+  if (derivation.type === "destructured") {
+    return typeof derivation.field === "string" ? derivation.field : null;
+  }
+  return null;
+}
+function valuesIn(predicate, depth = 0) {
+  if (depth > 12) {
+    return [];
+  }
+  const out = [];
+  const record = predicate;
+  for (const value of Object.values(record)) {
+    if (value === null || typeof value !== "object") {
+      continue;
+    }
+    if (Array.isArray(value)) {
+      for (const item of value) {
+        out.push(...nested(item, depth));
+      }
+      continue;
+    }
+    out.push(...nested(value, depth));
+  }
+  return out;
+}
+function nested(value, depth) {
+  if (value === null || typeof value !== "object") {
+    return [];
+  }
+  const kind = value.type;
+  if (kind === "input" || kind === "derived") {
+    return [value];
+  }
+  return valuesIn(value, depth + 1);
+}
+
 // src/packHelpers.ts
 function httpRouteDiscovery(opts) {
   const kind = opts.kind ?? "handler";
@@ -21,6 +101,12 @@ function httpRouteDiscovery(opts) {
 }
 
 // src/index.ts
+function valuesOfOutput(output) {
+  if (output.type === "response" && output.statusCode !== null) {
+    return [output.statusCode];
+  }
+  return [];
+}
 var DEFAULT_OPTIONS = { gapHandling: "permissive" };
 function makeTransitionId(functionName, branch) {
   const { terminal } = branch;
@@ -54,6 +140,10 @@ function assembleSummary(raw, options = DEFAULT_OPTIONS) {
   const confidence = assessConfidence(raw);
   const inputs = raw.parameters.map(paramToInput);
   const metadata = buildMetadata(raw);
+  const reads = inputReadsOf({
+    conditions: transitions.map((t) => t.conditions),
+    values: transitions.flatMap((t) => valuesOfOutput(t.output))
+  });
   return {
     kind: raw.identity.kind,
     location: {
@@ -71,6 +161,8 @@ function assembleSummary(raw, options = DEFAULT_OPTIONS) {
     transitions,
     gaps,
     confidence,
+    ...reads.length > 0 ? { inputReads: reads } : {},
+    ...raw.definitions !== void 0 && raw.definitions !== null ? { definitions: raw.definitions } : {},
     ...metadata !== null ? { metadata } : {}
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suss/extractor",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "type": "module",
   "description": "Framework-agnostic extraction pipeline that turns raw extractions into suss behavioral summaries.",
   "keywords": [
@@ -45,7 +45,7 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@suss/behavioral-ir": "0.1.1"
+    "@suss/behavioral-ir": "0.3.0"
   },
   "devDependencies": {
     "tsup": "*",