@suss/extractor 0.16.0 → 0.18.0

package/dist/index.cjs

@@ -129,6 +129,16 @@ function nested(value, depth) {
   }
   return valuesIn(value, depth + 1);
 }
+function mergeInputReads(derived, syntactic) {
+  const found = /* @__PURE__ */ new Map();
+  for (const read of [...derived, ...syntactic]) {
+    const key = `${read.input}\0${read.path.join(".")}`;
+    if (!found.has(key)) {
+      found.set(key, read);
+    }
+  }
+  return [...found.values()];
+}
 
 // src/packHelpers.ts
 function httpRouteDiscovery(opts) {
@@ -844,10 +854,13 @@ 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))
-  });
+  const reads = mergeInputReads(
+    inputReadsOf({
+      conditions: transitions.map((t) => t.conditions),
+      values: transitions.flatMap((t) => valuesOfOutput(t.output))
+    }),
+    raw.extraInputReads ?? []
+  );
   return {
     kind: raw.identity.kind,
     location: {

package/dist/index.d.cts

@@ -1,5 +1,26 @@
 import { Effect, MessageBusSemantics, DeployableUnit, Predicate, BehavioralSummary, TypeShape, RenderNode, CodeUnitKind, BoundaryBinding, GraphqlDeclaredContract, ConfidenceInfo, Transition, Gap, Input, Output } from '@suss/behavioral-ir';
 
+/**
+ * What a unit reads out of what it was given.
+ *
+ * A summary already describes this, but only as a chain of `derived` nodes
+ * nested one inside the next, which anyone who wants the list has to walk
+ * themselves. The `path` on an input reference is empty, so querying the
+ * field that looks like the answer gives nothing back.
+ *
+ * This module flattens that into the list directly: everything a unit reaches
+ * for through its inputs, once each, in the order somebody would say them out
+ * loud. It goes on the summary as `inputReads`.
+ */
+
+/** One thing a unit read, and the way it reached it. */
+interface InputRead {
+    /** The input it came through, by the name the inputs table uses. */
+    input: string;
+    /** The properties walked to reach it, outermost first. */
+    path: string[];
+}
+
 /**
  * The `PatternPack` interface, which is what a framework pack gives a language
  * adapter. The pack says WHAT to look for (which import, which call, which
@@ -2248,6 +2269,12 @@ interface RawCodeStructure {
      */
     bodyContent?: BodyContent;
     dependencyCalls: RawDependencyCall[];
+    /**
+     * Reads the adapter saw in the body that never flow into a condition
+     * or an output value, a render tree's `props.title` say. Merged into
+     * `inputReads` beside the derived ones.
+     */
+    extraInputReads?: InputRead[];
     declaredContract: RawDeclaredContract | null;
     /** The property a consumer goes through to get at the body, `data` for
      * axios say, so the checker can unwrap it without knowing each pack. */
@@ -2316,4 +2343,4 @@ declare function terminalToOutput(terminal: RawTerminal): Output;
 declare function effectToIR(effect: RawEffect): Effect;
 declare function paramToInput(param: RawParameter): Input;
 
-export { type AccessRecognizer, type AstCapableOps, type BindingExtraction, type BodyContent, type CallOps, type CaseGroup, type ChannelSource, type ChosenReading, type ConditionHandle, type ConditionInfo, type ConditionSource, type ConstructedFrom, type ContractPattern, type DeclaredBinding, type DeclaredBy, type DeclaredMatch, type DefaultedReading, type DiscoveredCustomUnit, type DiscoveredSubUnit, type DiscoveredSubUnitParent, type DiscoveryMatch, type DiscoveryPattern, type EffectArg, type ExitKind, type ExtractorOptions, type FailureDelivery, IdMap, IdSet, type Identified, type InputMappingPattern, type InvocationRecognizer, type LanguageAdapter, type LoweredStatementParts, type OpsCarrier, type PackDeclarations, PathBudgetExceeded, type PatternPack, type RawBranch, type RawCodeStructure, type RawCondition, type RawDeclaredContract, type RawDependencyCall, type RawEffect, type RawParameter, type RawTerminal, type Reading, type ReceiverOrigin, type RegistrationHelper, type ResponsePropertyMapping, type ResponsePropertyMeaning, type SourceRange, type StatementBlock, type StructuredPathConditionsInput, type StructuredPathConditionsResult, type StructuredStatement, type TerminalExtraction, type TerminalMatch, type TerminalPattern, type TransparentWrapper, UnmodeledFlow, type UnsettledName, type ValueEntry, type ValueOps, absentReading, ambiguousReading, andThenReading, assembleSummary, assessConfidence, detectGaps, effectToIR, enumerateOrDegrade, enumerateStructuredPaths, firstWrittenReading, httpRouteDiscovery, makeTransitionId, mapReading, paramToInput, registrationHelperDiscovery, sharedGatingConditions, terminalToOutput, unreadableReading, unwrapJsonStringify, valueToReadFurtherFrom, writtenReading };
+export { type AccessRecognizer, type AstCapableOps, type BindingExtraction, type BodyContent, type CallOps, type CaseGroup, type ChannelSource, type ChosenReading, type ConditionHandle, type ConditionInfo, type ConditionSource, type ConstructedFrom, type ContractPattern, type DeclaredBinding, type DeclaredBy, type DeclaredMatch, type DefaultedReading, type DiscoveredCustomUnit, type DiscoveredSubUnit, type DiscoveredSubUnitParent, type DiscoveryMatch, type DiscoveryPattern, type EffectArg, type ExitKind, type ExtractorOptions, type FailureDelivery, IdMap, IdSet, type Identified, type InputMappingPattern, type InputRead, type InvocationRecognizer, type LanguageAdapter, type LoweredStatementParts, type OpsCarrier, type PackDeclarations, PathBudgetExceeded, type PatternPack, type RawBranch, type RawCodeStructure, type RawCondition, type RawDeclaredContract, type RawDependencyCall, type RawEffect, type RawParameter, type RawTerminal, type Reading, type ReceiverOrigin, type RegistrationHelper, type ResponsePropertyMapping, type ResponsePropertyMeaning, type SourceRange, type StatementBlock, type StructuredPathConditionsInput, type StructuredPathConditionsResult, type StructuredStatement, type TerminalExtraction, type TerminalMatch, type TerminalPattern, type TransparentWrapper, UnmodeledFlow, type UnsettledName, type ValueEntry, type ValueOps, absentReading, ambiguousReading, andThenReading, assembleSummary, assessConfidence, detectGaps, effectToIR, enumerateOrDegrade, enumerateStructuredPaths, firstWrittenReading, httpRouteDiscovery, makeTransitionId, mapReading, paramToInput, registrationHelperDiscovery, sharedGatingConditions, terminalToOutput, unreadableReading, unwrapJsonStringify, valueToReadFurtherFrom, writtenReading };

package/dist/index.d.ts

@@ -1,5 +1,26 @@
 import { Effect, MessageBusSemantics, DeployableUnit, Predicate, BehavioralSummary, TypeShape, RenderNode, CodeUnitKind, BoundaryBinding, GraphqlDeclaredContract, ConfidenceInfo, Transition, Gap, Input, Output } from '@suss/behavioral-ir';
 
+/**
+ * What a unit reads out of what it was given.
+ *
+ * A summary already describes this, but only as a chain of `derived` nodes
+ * nested one inside the next, which anyone who wants the list has to walk
+ * themselves. The `path` on an input reference is empty, so querying the
+ * field that looks like the answer gives nothing back.
+ *
+ * This module flattens that into the list directly: everything a unit reaches
+ * for through its inputs, once each, in the order somebody would say them out
+ * loud. It goes on the summary as `inputReads`.
+ */
+
+/** One thing a unit read, and the way it reached it. */
+interface InputRead {
+    /** The input it came through, by the name the inputs table uses. */
+    input: string;
+    /** The properties walked to reach it, outermost first. */
+    path: string[];
+}
+
 /**
  * The `PatternPack` interface, which is what a framework pack gives a language
  * adapter. The pack says WHAT to look for (which import, which call, which
@@ -2248,6 +2269,12 @@ interface RawCodeStructure {
      */
     bodyContent?: BodyContent;
     dependencyCalls: RawDependencyCall[];
+    /**
+     * Reads the adapter saw in the body that never flow into a condition
+     * or an output value, a render tree's `props.title` say. Merged into
+     * `inputReads` beside the derived ones.
+     */
+    extraInputReads?: InputRead[];
     declaredContract: RawDeclaredContract | null;
     /** The property a consumer goes through to get at the body, `data` for
      * axios say, so the checker can unwrap it without knowing each pack. */
@@ -2316,4 +2343,4 @@ declare function terminalToOutput(terminal: RawTerminal): Output;
 declare function effectToIR(effect: RawEffect): Effect;
 declare function paramToInput(param: RawParameter): Input;
 
-export { type AccessRecognizer, type AstCapableOps, type BindingExtraction, type BodyContent, type CallOps, type CaseGroup, type ChannelSource, type ChosenReading, type ConditionHandle, type ConditionInfo, type ConditionSource, type ConstructedFrom, type ContractPattern, type DeclaredBinding, type DeclaredBy, type DeclaredMatch, type DefaultedReading, type DiscoveredCustomUnit, type DiscoveredSubUnit, type DiscoveredSubUnitParent, type DiscoveryMatch, type DiscoveryPattern, type EffectArg, type ExitKind, type ExtractorOptions, type FailureDelivery, IdMap, IdSet, type Identified, type InputMappingPattern, type InvocationRecognizer, type LanguageAdapter, type LoweredStatementParts, type OpsCarrier, type PackDeclarations, PathBudgetExceeded, type PatternPack, type RawBranch, type RawCodeStructure, type RawCondition, type RawDeclaredContract, type RawDependencyCall, type RawEffect, type RawParameter, type RawTerminal, type Reading, type ReceiverOrigin, type RegistrationHelper, type ResponsePropertyMapping, type ResponsePropertyMeaning, type SourceRange, type StatementBlock, type StructuredPathConditionsInput, type StructuredPathConditionsResult, type StructuredStatement, type TerminalExtraction, type TerminalMatch, type TerminalPattern, type TransparentWrapper, UnmodeledFlow, type UnsettledName, type ValueEntry, type ValueOps, absentReading, ambiguousReading, andThenReading, assembleSummary, assessConfidence, detectGaps, effectToIR, enumerateOrDegrade, enumerateStructuredPaths, firstWrittenReading, httpRouteDiscovery, makeTransitionId, mapReading, paramToInput, registrationHelperDiscovery, sharedGatingConditions, terminalToOutput, unreadableReading, unwrapJsonStringify, valueToReadFurtherFrom, writtenReading };
+export { type AccessRecognizer, type AstCapableOps, type BindingExtraction, type BodyContent, type CallOps, type CaseGroup, type ChannelSource, type ChosenReading, type ConditionHandle, type ConditionInfo, type ConditionSource, type ConstructedFrom, type ContractPattern, type DeclaredBinding, type DeclaredBy, type DeclaredMatch, type DefaultedReading, type DiscoveredCustomUnit, type DiscoveredSubUnit, type DiscoveredSubUnitParent, type DiscoveryMatch, type DiscoveryPattern, type EffectArg, type ExitKind, type ExtractorOptions, type FailureDelivery, IdMap, IdSet, type Identified, type InputMappingPattern, type InputRead, type InvocationRecognizer, type LanguageAdapter, type LoweredStatementParts, type OpsCarrier, type PackDeclarations, PathBudgetExceeded, type PatternPack, type RawBranch, type RawCodeStructure, type RawCondition, type RawDeclaredContract, type RawDependencyCall, type RawEffect, type RawParameter, type RawTerminal, type Reading, type ReceiverOrigin, type RegistrationHelper, type ResponsePropertyMapping, type ResponsePropertyMeaning, type SourceRange, type StatementBlock, type StructuredPathConditionsInput, type StructuredPathConditionsResult, type StructuredStatement, type TerminalExtraction, type TerminalMatch, type TerminalPattern, type TransparentWrapper, UnmodeledFlow, type UnsettledName, type ValueEntry, type ValueOps, absentReading, ambiguousReading, andThenReading, assembleSummary, assessConfidence, detectGaps, effectToIR, enumerateOrDegrade, enumerateStructuredPaths, firstWrittenReading, httpRouteDiscovery, makeTransitionId, mapReading, paramToInput, registrationHelperDiscovery, sharedGatingConditions, terminalToOutput, unreadableReading, unwrapJsonStringify, valueToReadFurtherFrom, writtenReading };

package/dist/index.js

@@ -86,6 +86,16 @@ function nested(value, depth) {
   }
   return valuesIn(value, depth + 1);
 }
+function mergeInputReads(derived, syntactic) {
+  const found = /* @__PURE__ */ new Map();
+  for (const read of [...derived, ...syntactic]) {
+    const key = `${read.input}\0${read.path.join(".")}`;
+    if (!found.has(key)) {
+      found.set(key, read);
+    }
+  }
+  return [...found.values()];
+}
 
 // src/packHelpers.ts
 function httpRouteDiscovery(opts) {
@@ -801,10 +811,13 @@ 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))
-  });
+  const reads = mergeInputReads(
+    inputReadsOf({
+      conditions: transitions.map((t) => t.conditions),
+      values: transitions.flatMap((t) => valuesOfOutput(t.output))
+    }),
+    raw.extraInputReads ?? []
+  );
   return {
     kind: raw.identity.kind,
     location: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suss/extractor",
-  "version": "0.16.0",
+  "version": "0.18.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.16.0"
+    "@suss/behavioral-ir": "0.18.0"
   },
   "devDependencies": {
     "tsup": "*",