@suss/extractor 0.12.0 → 0.13.0

package/dist/index.cjs

@@ -148,7 +148,7 @@ function httpRouteDiscovery(opts) {
         position: "methodName",
         nameMap: { all: "*" }
       },
-      path: { type: "fromRegistration", position: 0 }
+      path: { type: "fromArgument", position: 0 }
     },
     ...opts.mount !== void 0 ? { mount: opts.mount } : {},
     requiresImport: [opts.importModule]

package/dist/index.d.cts

@@ -23,10 +23,6 @@ type DiscoveryMatch = {
     importModule: string;
     importName: string;
     registrationChain: string[];
-} | {
-    type: "decorator";
-    decoratorModule: string;
-    decoratorName: string;
 } | {
     type: "fileConvention";
     filePattern: string;
@@ -471,7 +467,7 @@ type BindingExtraction = {
         value: string;
     };
     path: {
-        type: "fromRegistration";
+        type: "fromArgument";
         position: number;
     } | {
         type: "fromArgumentProperty";
@@ -521,9 +517,6 @@ type BindingExtraction = {
         type: "fromContract";
     } | {
         type: "fromClientMethod";
-    } | {
-        type: "fromArgumentLiteral";
-        position: number;
     };
 };
 interface DiscoveryPattern {
@@ -727,12 +720,6 @@ interface ContractPattern {
     };
 }
 type InputMappingPattern = {
-    /** Single object parameter, e.g. React Router LoaderFunctionArgs */
-    type: "singleObjectParam";
-    paramPosition: number;
-    /** Property name → role, e.g. { params: "pathParams", request: "request" } */
-    knownProperties: Record<string, string>;
-} | {
     /** Positional parameters, e.g. Express (req, res, next) */
     type: "positionalParams";
     params: Array<{
@@ -740,10 +727,21 @@ type InputMappingPattern = {
         role: string;
     }>;
 } | {
-    /** Destructured from framework call, e.g. ts-rest { params, body, query } */
-    type: "destructuredObject";
-    /** Property name → role, e.g. { params: "pathParams", body: "requestBody" } */
+    /**
+     * One object parameter whose properties are the inputs, the way
+     * ts-rest passes `{ params, body, query }` and React Router passes
+     * `{ params, request }`. A handler that destructures it gets one
+     * input per name it binds; a handler that takes it whole gets a
+     * single input, since the source does not say which properties it
+     * reads.
+     */
+    type: "objectParam";
+    /** Defaults to the first parameter. */
+    paramPosition?: number;
+    /** Property name mapped to the role it takes, e.g. `{ params: "pathParams" }`. A name not here keeps the name it was bound under. */
     knownProperties: Record<string, string>;
+    /** The role for a parameter taken whole. Defaults to "request". */
+    wholeParamRole?: string;
 } | {
     /**
      * Component props, React / Vue / Svelte-style: one parameter that
@@ -753,10 +751,10 @@ type InputMappingPattern = {
      * not destructured (`function X(props) {...}`), a single Input comes
      * out with `wholeParamRole`, which defaults to `"props"`.
      *
-     * This differs from `destructuredObject` because the pack does not
-     * declare the prop names up front; they are whatever the component
-     * author wrote. It differs from `singleObjectParam` because the
-     * destructuring pattern is respected when there is one.
+     * This differs from `objectParam` in two ways. The pack declares no
+     * prop names up front, since they are whatever the component author
+     * wrote, and each input records the type text of the prop, which a
+     * component's shape comparison reads.
      */
     type: "componentProps";
     paramPosition: number;
@@ -769,7 +767,7 @@ type InputMappingPattern = {
      * reachable-closure pass for internal library functions, where no
      * framework declares a set of roles, so the name a caller sees IS
      * the role. Destructured parameters are captured the
-     * same way `destructuredObject` captures them, so `(ctx, { userId })`
+     * same way `objectParam` captures them, so `(ctx, { userId })`
      * gives two inputs, `ctx` and `userId`.
      */
     type: "allPositional";

package/dist/index.d.ts

@@ -23,10 +23,6 @@ type DiscoveryMatch = {
     importModule: string;
     importName: string;
     registrationChain: string[];
-} | {
-    type: "decorator";
-    decoratorModule: string;
-    decoratorName: string;
 } | {
     type: "fileConvention";
     filePattern: string;
@@ -471,7 +467,7 @@ type BindingExtraction = {
         value: string;
     };
     path: {
-        type: "fromRegistration";
+        type: "fromArgument";
         position: number;
     } | {
         type: "fromArgumentProperty";
@@ -521,9 +517,6 @@ type BindingExtraction = {
         type: "fromContract";
     } | {
         type: "fromClientMethod";
-    } | {
-        type: "fromArgumentLiteral";
-        position: number;
     };
 };
 interface DiscoveryPattern {
@@ -727,12 +720,6 @@ interface ContractPattern {
     };
 }
 type InputMappingPattern = {
-    /** Single object parameter, e.g. React Router LoaderFunctionArgs */
-    type: "singleObjectParam";
-    paramPosition: number;
-    /** Property name → role, e.g. { params: "pathParams", request: "request" } */
-    knownProperties: Record<string, string>;
-} | {
     /** Positional parameters, e.g. Express (req, res, next) */
     type: "positionalParams";
     params: Array<{
@@ -740,10 +727,21 @@ type InputMappingPattern = {
         role: string;
     }>;
 } | {
-    /** Destructured from framework call, e.g. ts-rest { params, body, query } */
-    type: "destructuredObject";
-    /** Property name → role, e.g. { params: "pathParams", body: "requestBody" } */
+    /**
+     * One object parameter whose properties are the inputs, the way
+     * ts-rest passes `{ params, body, query }` and React Router passes
+     * `{ params, request }`. A handler that destructures it gets one
+     * input per name it binds; a handler that takes it whole gets a
+     * single input, since the source does not say which properties it
+     * reads.
+     */
+    type: "objectParam";
+    /** Defaults to the first parameter. */
+    paramPosition?: number;
+    /** Property name mapped to the role it takes, e.g. `{ params: "pathParams" }`. A name not here keeps the name it was bound under. */
     knownProperties: Record<string, string>;
+    /** The role for a parameter taken whole. Defaults to "request". */
+    wholeParamRole?: string;
 } | {
     /**
      * Component props, React / Vue / Svelte-style: one parameter that
@@ -753,10 +751,10 @@ type InputMappingPattern = {
      * not destructured (`function X(props) {...}`), a single Input comes
      * out with `wholeParamRole`, which defaults to `"props"`.
      *
-     * This differs from `destructuredObject` because the pack does not
-     * declare the prop names up front; they are whatever the component
-     * author wrote. It differs from `singleObjectParam` because the
-     * destructuring pattern is respected when there is one.
+     * This differs from `objectParam` in two ways. The pack declares no
+     * prop names up front, since they are whatever the component author
+     * wrote, and each input records the type text of the prop, which a
+     * component's shape comparison reads.
      */
     type: "componentProps";
     paramPosition: number;
@@ -769,7 +767,7 @@ type InputMappingPattern = {
      * reachable-closure pass for internal library functions, where no
      * framework declares a set of roles, so the name a caller sees IS
      * the role. Destructured parameters are captured the
-     * same way `destructuredObject` captures them, so `(ctx, { userId })`
+     * same way `objectParam` captures them, so `(ctx, { userId })`
      * gives two inputs, `ctx` and `userId`.
      */
     type: "allPositional";

package/dist/index.js

@@ -106,7 +106,7 @@ function httpRouteDiscovery(opts) {
         position: "methodName",
         nameMap: { all: "*" }
       },
-      path: { type: "fromRegistration", position: 0 }
+      path: { type: "fromArgument", position: 0 }
     },
     ...opts.mount !== void 0 ? { mount: opts.mount } : {},
     requiresImport: [opts.importModule]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suss/extractor",
-  "version": "0.12.0",
+  "version": "0.13.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.12.0"
+    "@suss/behavioral-ir": "0.13.0"
   },
   "devDependencies": {
     "tsup": "*",