@happyvertical/smrt-sales 0.57.2 → 0.57.3

package/dist/smrt-knowledge.json

@@ -3,17 +3,17 @@
   "sensitiveFieldsExcluded": true,
   "generatedAt": "1970-01-01T00:00:00.000Z",
   "packageName": "@happyvertical/smrt-sales",
-  "packageVersion": "0.57.2",
+  "packageVersion": "0.57.3",
   "sourceManifestPath": "dist/manifest.json",
   "agentDocPath": "AGENTS.md",
   "sourceHashes": {
-    "manifest": "79d3c0cc7e4dbffa77971a891d7710138d11bfcf36578d0d94034f0fe169fbf4",
-    "packageJson": "0c8660f9c8581f8ffc6fdd72f8356d54428b80aa08405c7c43cecf5829c927bd",
+    "manifest": "94c0a04880d49d99da803c7e3f2542f1a035069da2c2d53eabffc1c596088f3d",
+    "packageJson": "b76335ff5c9e9a79836d93cec49174fc05f88fa83a93d31fce78801d47dc3ade",
     "agents": "3100099d7cef116237e4deb4f83e32d836f3cc26e0f68a7dd55f14de942eda11",
     "moduleDoc:agents/agreements.md": "eb6ff147a0f60ee627d3337e8e9394d06fda955b4a4fff228537a9bd2803f886",
-    "moduleDoc:agents/commissions.md": "e047024aafe5edcf072c1a6b7ea253c24cb15f2fa1beb2edd13651e735921f73",
+    "moduleDoc:agents/commissions.md": "b649ef658d41f9c27287281f6d3c9ee06dec2aede89da070a3ebfc7b4c289798",
     "moduleDoc:agents/crm.md": "b2c01c33e6ac559ba32073a089760d885095969d2ad749c30428c76e6aa2cc71",
-    "moduleDoc:agents/referrals.md": "e64b64aad4b3feea08f172a18e3992539d761b5f05ac4e5107338a700c0cc4ce",
+    "moduleDoc:agents/referrals.md": "ef48c88e63155e3d08b9003f4643bc66ebb1942f1fb713252dc042ddcaad38e5",
     "moduleDoc:agents/svelte.md": "819f690b91cf93980f6f79e89da8d9629ca6e5c565494e3fd2ca3be7587ad6de"
   },
   "exports": [
@@ -68,6 +68,149 @@
     "sensitive-fields-excluded"
   ],
   "objects": [
+    {
+      "name": "AgreementCollection",
+      "qualifiedName": "@happyvertical/smrt-sales:AgreementCollection",
+      "collection": "agreements",
+      "description": "Versioned rows for one ordered (kind, partyA, partyB) relationship.",
+      "tableName": "agreements",
+      "packageName": "@happyvertical/smrt-sales",
+      "extends": "SmrtCollection",
+      "fields": [],
+      "relationships": [],
+      "methods": [
+        "activateAmendment",
+        "activeFor",
+        "createAmendment",
+        "findVersions",
+        "withdrawAmendment"
+      ],
+      "methodSignatures": [
+        {
+          "name": "activateAmendment",
+          "async": true,
+          "params": [
+            "id: string"
+          ],
+          "returns": "Promise<Agreement>"
+        },
+        {
+          "name": "activeFor",
+          "async": true,
+          "params": [
+            "kind: string",
+            "partyA: AgreementParty",
+            "partyB: AgreementParty",
+            "at?: Date",
+            "tenantId?: string | null"
+          ],
+          "returns": "Promise<Agreement | null>"
+        },
+        {
+          "name": "createAmendment",
+          "async": true,
+          "params": [
+            "kind: string",
+            "partyA: AgreementParty",
+            "partyB: AgreementParty",
+            "changes?: AgreementAmendmentChanges"
+          ],
+          "returns": "Promise<Agreement>"
+        },
+        {
+          "name": "findVersions",
+          "async": true,
+          "params": [
+            "kind: string",
+            "partyA: AgreementParty",
+            "partyB: AgreementParty"
+          ],
+          "returns": "Promise<Agreement[]>"
+        },
+        {
+          "name": "withdrawAmendment",
+          "async": true,
+          "params": [
+            "id: string"
+          ],
+          "returns": "Promise<Agreement>"
+        }
+      ],
+      "surfaces": [
+        {
+          "kind": "cli",
+          "name": "agreementcollection_findVersions",
+          "operation": "findVersions",
+          "objectName": "@happyvertical/smrt-sales:AgreementCollection"
+        },
+        {
+          "kind": "cli",
+          "name": "agreementcollection_activeFor",
+          "operation": "activeFor",
+          "objectName": "@happyvertical/smrt-sales:AgreementCollection"
+        },
+        {
+          "kind": "cli",
+          "name": "agreementcollection_createAmendment",
+          "operation": "createAmendment",
+          "objectName": "@happyvertical/smrt-sales:AgreementCollection"
+        },
+        {
+          "kind": "cli",
+          "name": "agreementcollection_activateAmendment",
+          "operation": "activateAmendment",
+          "objectName": "@happyvertical/smrt-sales:AgreementCollection"
+        },
+        {
+          "kind": "cli",
+          "name": "agreementcollection_withdrawAmendment",
+          "operation": "withdrawAmendment",
+          "objectName": "@happyvertical/smrt-sales:AgreementCollection"
+        }
+      ],
+      "withheldSurfaces": [
+        {
+          "kind": "api",
+          "operation": "activateAmendment",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:AgreementCollection"
+        },
+        {
+          "kind": "api",
+          "operation": "activeFor",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:AgreementCollection"
+        },
+        {
+          "kind": "api",
+          "operation": "createAmendment",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:AgreementCollection"
+        },
+        {
+          "kind": "api",
+          "operation": "findVersions",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:AgreementCollection"
+        },
+        {
+          "kind": "api",
+          "operation": "withdrawAmendment",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:AgreementCollection"
+        }
+      ],
+      "relationshipFeatures": [
+        "uuidColumns"
+      ],
+      "tags": [],
+      "risks": []
+    },
     {
       "name": "AgreementExecutionCollection",
       "qualifiedName": "@happyvertical/smrt-sales:AgreementExecutionCollection",
@@ -390,55 +533,536 @@
           "returns": "Promise<ExecutedAgreement | null>"
         },
         {
-          "name": "findByExecution",
-          "async": true,
-          "params": [
-            "executionId: string"
-          ],
-          "returns": "Promise<ExecutedAgreement | null>"
+          "name": "findByExecution",
+          "async": true,
+          "params": [
+            "executionId: string"
+          ],
+          "returns": "Promise<ExecutedAgreement | null>"
+        },
+        {
+          "name": "findVersionsBySource",
+          "async": true,
+          "params": [
+            "sourceKind: string",
+            "sourceId: string"
+          ],
+          "returns": "Promise<ExecutedAgreement[]>"
+        }
+      ],
+      "surfaces": [],
+      "withheldSurfaces": [
+        {
+          "kind": "api",
+          "operation": "createImmutable",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:ExecutedAgreementCollection"
+        },
+        {
+          "kind": "api",
+          "operation": "effectiveForSource",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:ExecutedAgreementCollection"
+        },
+        {
+          "kind": "api",
+          "operation": "findByExecution",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:ExecutedAgreementCollection"
+        },
+        {
+          "kind": "api",
+          "operation": "findVersionsBySource",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:ExecutedAgreementCollection"
+        }
+      ],
+      "relationshipFeatures": [
+        "uuidColumns"
+      ],
+      "tags": [],
+      "risks": []
+    },
+    {
+      "name": "Agreement",
+      "qualifiedName": "@happyvertical/smrt-sales:Agreement",
+      "collection": "agreements",
+      "tableName": "agreements",
+      "packageName": "@happyvertical/smrt-sales",
+      "extends": "SmrtObject",
+      "fields": [
+        {
+          "name": "tenantId",
+          "type": "text",
+          "required": false,
+          "columnType": "UUID"
+        },
+        {
+          "name": "kind",
+          "type": "text",
+          "required": true,
+          "columnType": "TEXT",
+          "default": ""
+        },
+        {
+          "name": "partyA",
+          "type": "text",
+          "required": true,
+          "columnType": "TEXT",
+          "default": ""
+        },
+        {
+          "name": "partyB",
+          "type": "text",
+          "required": true,
+          "columnType": "TEXT",
+          "default": ""
+        },
+        {
+          "name": "version",
+          "type": "integer",
+          "required": false,
+          "columnType": "INTEGER",
+          "default": 1
+        },
+        {
+          "name": "status",
+          "type": "text",
+          "required": false,
+          "columnType": "TEXT",
+          "default": "draft"
+        },
+        {
+          "name": "terms",
+          "type": "text",
+          "required": false,
+          "columnType": "TEXT",
+          "default": "{}"
+        },
+        {
+          "name": "effectiveFrom",
+          "type": "datetime",
+          "required": false,
+          "columnType": "TIMESTAMP"
+        },
+        {
+          "name": "effectiveTo",
+          "type": "datetime",
+          "required": false,
+          "columnType": "TIMESTAMP"
+        },
+        {
+          "name": "executedAgreementId",
+          "type": "foreignKey",
+          "required": false,
+          "related": "ExecutedAgreement",
+          "columnType": "UUID"
+        },
+        {
+          "name": "amendmentPredecessorId",
+          "type": "foreignKey",
+          "required": false,
+          "related": "Agreement",
+          "columnType": "UUID"
+        },
+        {
+          "name": "amendmentPredecessorEnd",
+          "type": "datetime",
+          "required": false,
+          "columnType": "TIMESTAMP"
+        },
+        {
+          "name": "metadata",
+          "type": "text",
+          "required": false,
+          "columnType": "TEXT",
+          "default": "{}"
+        }
+      ],
+      "relationships": [
+        {
+          "name": "executedAgreementId",
+          "type": "foreignKey",
+          "required": false,
+          "related": "ExecutedAgreement",
+          "columnType": "UUID"
+        },
+        {
+          "name": "amendmentPredecessorId",
+          "type": "foreignKey",
+          "required": false,
+          "related": "Agreement",
+          "columnType": "UUID"
+        }
+      ],
+      "methods": [
+        "activate",
+        "getPartyA",
+        "getPartyB",
+        "getTerms",
+        "initialize",
+        "isActive",
+        "isDraft",
+        "isEffectiveAt",
+        "refreshAfterLifecycleTransition",
+        "save",
+        "setPartyA",
+        "setPartyB",
+        "setTerms",
+        "supersede",
+        "terminate"
+      ],
+      "methodSignatures": [
+        {
+          "name": "activate",
+          "returns": "void"
+        },
+        {
+          "name": "getPartyA",
+          "returns": "AgreementParty | null"
+        },
+        {
+          "name": "getPartyB",
+          "returns": "AgreementParty | null"
+        },
+        {
+          "name": "getTerms",
+          "returns": "Record<string, unknown>"
+        },
+        {
+          "name": "initialize",
+          "async": true,
+          "returns": "Promise<this>"
+        },
+        {
+          "name": "isActive",
+          "returns": "boolean"
+        },
+        {
+          "name": "isDraft",
+          "returns": "boolean"
+        },
+        {
+          "name": "isEffectiveAt",
+          "params": [
+            "at: Date"
+          ],
+          "returns": "boolean"
+        },
+        {
+          "name": "refreshAfterLifecycleTransition",
+          "async": true,
+          "returns": "Promise<void>"
+        },
+        {
+          "name": "save",
+          "async": true,
+          "returns": "Promise<this>"
+        },
+        {
+          "name": "setPartyA",
+          "params": [
+            "party: AgreementParty"
+          ],
+          "returns": "void"
+        },
+        {
+          "name": "setPartyB",
+          "params": [
+            "party: AgreementParty"
+          ],
+          "returns": "void"
+        },
+        {
+          "name": "setTerms",
+          "params": [
+            "terms: Record<string, unknown>"
+          ],
+          "returns": "void"
+        },
+        {
+          "name": "supersede",
+          "returns": "void"
+        },
+        {
+          "name": "terminate",
+          "params": [
+            "at?: Date"
+          ],
+          "returns": "void"
+        }
+      ],
+      "tenant": {
+        "scoped": true,
+        "mode": "optional",
+        "field": "tenantId"
+      },
+      "conflictColumns": [
+        "tenant_id",
+        "kind",
+        "party_a",
+        "party_b",
+        "version"
+      ],
+      "surfaces": [
+        {
+          "kind": "api",
+          "name": "agreements.list",
+          "operation": "list",
+          "objectName": "@happyvertical/smrt-sales:Agreement",
+          "path": "/agreements",
+          "method": "GET"
+        },
+        {
+          "kind": "api",
+          "name": "agreements.get",
+          "operation": "get",
+          "objectName": "@happyvertical/smrt-sales:Agreement",
+          "path": "/agreements/[id]",
+          "method": "GET"
+        },
+        {
+          "kind": "api",
+          "name": "agreements.create",
+          "operation": "create",
+          "objectName": "@happyvertical/smrt-sales:Agreement",
+          "path": "/agreements",
+          "method": "POST"
+        },
+        {
+          "kind": "cli",
+          "name": "agreement_list",
+          "operation": "list",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "cli",
+          "name": "agreement_get",
+          "operation": "get",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "cli",
+          "name": "agreement_create",
+          "operation": "create",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "cli",
+          "name": "agreement_update",
+          "operation": "update",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "cli",
+          "name": "agreement_delete",
+          "operation": "delete",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "cli",
+          "name": "agreement_isDraft",
+          "operation": "isDraft",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "cli",
+          "name": "agreement_isActive",
+          "operation": "isActive",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "cli",
+          "name": "agreement_isEffectiveAt",
+          "operation": "isEffectiveAt",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "cli",
+          "name": "agreement_getPartyA",
+          "operation": "getPartyA",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "cli",
+          "name": "agreement_getPartyB",
+          "operation": "getPartyB",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "cli",
+          "name": "agreement_setPartyA",
+          "operation": "setPartyA",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "cli",
+          "name": "agreement_setPartyB",
+          "operation": "setPartyB",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "cli",
+          "name": "agreement_getTerms",
+          "operation": "getTerms",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "cli",
+          "name": "agreement_setTerms",
+          "operation": "setTerms",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "cli",
+          "name": "agreement_activate",
+          "operation": "activate",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "cli",
+          "name": "agreement_supersede",
+          "operation": "supersede",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "cli",
+          "name": "agreement_terminate",
+          "operation": "terminate",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "cli",
+          "name": "agreement_refreshAfterLifecycleTransition",
+          "operation": "refreshAfterLifecycleTransition",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "mcp",
+          "name": "agreement_list",
+          "operation": "list",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "mcp",
+          "name": "agreement_get",
+          "operation": "get",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        }
+      ],
+      "withheldSurfaces": [
+        {
+          "kind": "api",
+          "operation": "activate",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "api",
+          "operation": "getPartyA",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "api",
+          "operation": "getPartyB",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "api",
+          "operation": "getTerms",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "api",
+          "operation": "initialize",
+          "code": "lifecycle-method",
+          "reason": "`initialize` is a framework lifecycle method, not a distinct operation",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "api",
+          "operation": "isActive",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "api",
+          "operation": "isDraft",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "api",
+          "operation": "isEffectiveAt",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "api",
+          "operation": "refreshAfterLifecycleTransition",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
         },
         {
-          "name": "findVersionsBySource",
-          "async": true,
-          "params": [
-            "sourceKind: string",
-            "sourceId: string"
-          ],
-          "returns": "Promise<ExecutedAgreement[]>"
-        }
-      ],
-      "surfaces": [],
-      "withheldSurfaces": [
+          "kind": "api",
+          "operation": "save",
+          "code": "lifecycle-method",
+          "reason": "`save` is a framework lifecycle method, not a distinct operation",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
         {
           "kind": "api",
-          "operation": "createImmutable",
+          "operation": "setPartyA",
           "code": "not-included",
           "reason": "not listed in api.include",
-          "objectName": "@happyvertical/smrt-sales:ExecutedAgreementCollection"
+          "objectName": "@happyvertical/smrt-sales:Agreement"
         },
         {
           "kind": "api",
-          "operation": "effectiveForSource",
+          "operation": "setPartyB",
           "code": "not-included",
           "reason": "not listed in api.include",
-          "objectName": "@happyvertical/smrt-sales:ExecutedAgreementCollection"
+          "objectName": "@happyvertical/smrt-sales:Agreement"
         },
         {
           "kind": "api",
-          "operation": "findByExecution",
+          "operation": "setTerms",
           "code": "not-included",
           "reason": "not listed in api.include",
-          "objectName": "@happyvertical/smrt-sales:ExecutedAgreementCollection"
+          "objectName": "@happyvertical/smrt-sales:Agreement"
         },
         {
           "kind": "api",
-          "operation": "findVersionsBySource",
+          "operation": "supersede",
           "code": "not-included",
           "reason": "not listed in api.include",
-          "objectName": "@happyvertical/smrt-sales:ExecutedAgreementCollection"
+          "objectName": "@happyvertical/smrt-sales:Agreement"
+        },
+        {
+          "kind": "api",
+          "operation": "terminate",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:Agreement"
         }
       ],
       "relationshipFeatures": [
+        "foreignKey",
         "uuidColumns"
       ],
       "tags": [],
@@ -3347,6 +3971,12 @@
           "required": false,
           "columnType": "TIMESTAMP"
         },
+        {
+          "name": "effectiveTo",
+          "type": "datetime",
+          "required": false,
+          "columnType": "TIMESTAMP"
+        },
         {
           "name": "currency",
           "type": "text",
@@ -3361,6 +3991,27 @@
           "columnType": "TEXT",
           "default": "[]"
         },
+        {
+          "name": "steps",
+          "type": "text",
+          "required": false,
+          "columnType": "TEXT",
+          "default": "[]"
+        },
+        {
+          "name": "remainderSink",
+          "type": "text",
+          "required": false,
+          "columnType": "TEXT",
+          "default": "{}"
+        },
+        {
+          "name": "applicationFeeOffsetRecipient",
+          "type": "text",
+          "required": false,
+          "columnType": "TEXT",
+          "default": "{}"
+        },
         {
           "name": "metadata",
           "type": "text",
@@ -3374,6 +4025,9 @@
         "activate",
         "getComponents",
         "getMetadata",
+        "getRemainderSink",
+        "getSteps",
+        "getWaterfallPlan",
         "initialize",
         "isActive",
         "isDraft",
@@ -3381,6 +4035,8 @@
         "save",
         "setComponents",
         "setMetadata",
+        "setRemainderSink",
+        "setSteps",
         "supersede"
       ],
       "methodSignatures": [
@@ -3396,6 +4052,18 @@
           "name": "getMetadata",
           "returns": "Record<string, unknown>"
         },
+        {
+          "name": "getRemainderSink",
+          "returns": "WaterfallRecipientDescriptor | null"
+        },
+        {
+          "name": "getSteps",
+          "returns": "WaterfallStep[]"
+        },
+        {
+          "name": "getWaterfallPlan",
+          "returns": "WaterfallPlan | null"
+        },
         {
           "name": "initialize",
           "async": true,
@@ -3432,6 +4100,20 @@
           ],
           "returns": "void"
         },
+        {
+          "name": "setRemainderSink",
+          "params": [
+            "sink: WaterfallRecipientDescriptor"
+          ],
+          "returns": "void"
+        },
+        {
+          "name": "setSteps",
+          "params": [
+            "steps: WaterfallStep[]"
+          ],
+          "returns": "void"
+        },
         {
           "name": "supersede",
           "returns": "void"
@@ -3526,6 +4208,36 @@
           "operation": "setComponents",
           "objectName": "@happyvertical/smrt-sales:CommissionPlan"
         },
+        {
+          "kind": "cli",
+          "name": "commissionplan_getSteps",
+          "operation": "getSteps",
+          "objectName": "@happyvertical/smrt-sales:CommissionPlan"
+        },
+        {
+          "kind": "cli",
+          "name": "commissionplan_setSteps",
+          "operation": "setSteps",
+          "objectName": "@happyvertical/smrt-sales:CommissionPlan"
+        },
+        {
+          "kind": "cli",
+          "name": "commissionplan_getRemainderSink",
+          "operation": "getRemainderSink",
+          "objectName": "@happyvertical/smrt-sales:CommissionPlan"
+        },
+        {
+          "kind": "cli",
+          "name": "commissionplan_setRemainderSink",
+          "operation": "setRemainderSink",
+          "objectName": "@happyvertical/smrt-sales:CommissionPlan"
+        },
+        {
+          "kind": "cli",
+          "name": "commissionplan_getWaterfallPlan",
+          "operation": "getWaterfallPlan",
+          "objectName": "@happyvertical/smrt-sales:CommissionPlan"
+        },
         {
           "kind": "cli",
           "name": "commissionplan_getMetadata",
@@ -3591,6 +4303,27 @@
           "reason": "not listed in api.include",
           "objectName": "@happyvertical/smrt-sales:CommissionPlan"
         },
+        {
+          "kind": "api",
+          "operation": "getRemainderSink",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:CommissionPlan"
+        },
+        {
+          "kind": "api",
+          "operation": "getSteps",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:CommissionPlan"
+        },
+        {
+          "kind": "api",
+          "operation": "getWaterfallPlan",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:CommissionPlan"
+        },
         {
           "kind": "api",
           "operation": "initialize",
@@ -3640,6 +4373,20 @@
           "reason": "not listed in api.include",
           "objectName": "@happyvertical/smrt-sales:CommissionPlan"
         },
+        {
+          "kind": "api",
+          "operation": "setRemainderSink",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:CommissionPlan"
+        },
+        {
+          "kind": "api",
+          "operation": "setSteps",
+          "code": "not-included",
+          "reason": "not listed in api.include",
+          "objectName": "@happyvertical/smrt-sales:CommissionPlan"
+        },
         {
           "kind": "api",
           "operation": "supersede",
@@ -10475,6 +11222,180 @@
     }
   ],
   "surfaces": [
+    {
+      "kind": "cli",
+      "name": "agreementcollection_findVersions",
+      "operation": "findVersions",
+      "objectName": "@happyvertical/smrt-sales:AgreementCollection"
+    },
+    {
+      "kind": "cli",
+      "name": "agreementcollection_activeFor",
+      "operation": "activeFor",
+      "objectName": "@happyvertical/smrt-sales:AgreementCollection"
+    },
+    {
+      "kind": "cli",
+      "name": "agreementcollection_createAmendment",
+      "operation": "createAmendment",
+      "objectName": "@happyvertical/smrt-sales:AgreementCollection"
+    },
+    {
+      "kind": "cli",
+      "name": "agreementcollection_activateAmendment",
+      "operation": "activateAmendment",
+      "objectName": "@happyvertical/smrt-sales:AgreementCollection"
+    },
+    {
+      "kind": "cli",
+      "name": "agreementcollection_withdrawAmendment",
+      "operation": "withdrawAmendment",
+      "objectName": "@happyvertical/smrt-sales:AgreementCollection"
+    },
+    {
+      "kind": "api",
+      "name": "agreements.list",
+      "operation": "list",
+      "objectName": "@happyvertical/smrt-sales:Agreement",
+      "path": "/agreements",
+      "method": "GET"
+    },
+    {
+      "kind": "api",
+      "name": "agreements.get",
+      "operation": "get",
+      "objectName": "@happyvertical/smrt-sales:Agreement",
+      "path": "/agreements/[id]",
+      "method": "GET"
+    },
+    {
+      "kind": "api",
+      "name": "agreements.create",
+      "operation": "create",
+      "objectName": "@happyvertical/smrt-sales:Agreement",
+      "path": "/agreements",
+      "method": "POST"
+    },
+    {
+      "kind": "cli",
+      "name": "agreement_list",
+      "operation": "list",
+      "objectName": "@happyvertical/smrt-sales:Agreement"
+    },
+    {
+      "kind": "cli",
+      "name": "agreement_get",
+      "operation": "get",
+      "objectName": "@happyvertical/smrt-sales:Agreement"
+    },
+    {
+      "kind": "cli",
+      "name": "agreement_create",
+      "operation": "create",
+      "objectName": "@happyvertical/smrt-sales:Agreement"
+    },
+    {
+      "kind": "cli",
+      "name": "agreement_update",
+      "operation": "update",
+      "objectName": "@happyvertical/smrt-sales:Agreement"
+    },
+    {
+      "kind": "cli",
+      "name": "agreement_delete",
+      "operation": "delete",
+      "objectName": "@happyvertical/smrt-sales:Agreement"
+    },
+    {
+      "kind": "cli",
+      "name": "agreement_isDraft",
+      "operation": "isDraft",
+      "objectName": "@happyvertical/smrt-sales:Agreement"
+    },
+    {
+      "kind": "cli",
+      "name": "agreement_isActive",
+      "operation": "isActive",
+      "objectName": "@happyvertical/smrt-sales:Agreement"
+    },
+    {
+      "kind": "cli",
+      "name": "agreement_isEffectiveAt",
+      "operation": "isEffectiveAt",
+      "objectName": "@happyvertical/smrt-sales:Agreement"
+    },
+    {
+      "kind": "cli",
+      "name": "agreement_getPartyA",
+      "operation": "getPartyA",
+      "objectName": "@happyvertical/smrt-sales:Agreement"
+    },
+    {
+      "kind": "cli",
+      "name": "agreement_getPartyB",
+      "operation": "getPartyB",
+      "objectName": "@happyvertical/smrt-sales:Agreement"
+    },
+    {
+      "kind": "cli",
+      "name": "agreement_setPartyA",
+      "operation": "setPartyA",
+      "objectName": "@happyvertical/smrt-sales:Agreement"
+    },
+    {
+      "kind": "cli",
+      "name": "agreement_setPartyB",
+      "operation": "setPartyB",
+      "objectName": "@happyvertical/smrt-sales:Agreement"
+    },
+    {
+      "kind": "cli",
+      "name": "agreement_getTerms",
+      "operation": "getTerms",
+      "objectName": "@happyvertical/smrt-sales:Agreement"
+    },
+    {
+      "kind": "cli",
+      "name": "agreement_setTerms",
+      "operation": "setTerms",
+      "objectName": "@happyvertical/smrt-sales:Agreement"
+    },
+    {
+      "kind": "cli",
+      "name": "agreement_activate",
+      "operation": "activate",
+      "objectName": "@happyvertical/smrt-sales:Agreement"
+    },
+    {
+      "kind": "cli",
+      "name": "agreement_supersede",
+      "operation": "supersede",
+      "objectName": "@happyvertical/smrt-sales:Agreement"
+    },
+    {
+      "kind": "cli",
+      "name": "agreement_terminate",
+      "operation": "terminate",
+      "objectName": "@happyvertical/smrt-sales:Agreement"
+    },
+    {
+      "kind": "cli",
+      "name": "agreement_refreshAfterLifecycleTransition",
+      "operation": "refreshAfterLifecycleTransition",
+      "objectName": "@happyvertical/smrt-sales:Agreement"
+    },
+    {
+      "kind": "mcp",
+      "name": "agreement_list",
+      "operation": "list",
+      "objectName": "@happyvertical/smrt-sales:Agreement"
+    },
+    {
+      "kind": "mcp",
+      "name": "agreement_get",
+      "operation": "get",
+      "objectName": "@happyvertical/smrt-sales:Agreement"
+    },
     {
       "kind": "api",
       "name": "executedagreements.list",
@@ -10735,6 +11656,36 @@
       "operation": "setComponents",
       "objectName": "@happyvertical/smrt-sales:CommissionPlan"
     },
+    {
+      "kind": "cli",
+      "name": "commissionplan_getSteps",
+      "operation": "getSteps",
+      "objectName": "@happyvertical/smrt-sales:CommissionPlan"
+    },
+    {
+      "kind": "cli",
+      "name": "commissionplan_setSteps",
+      "operation": "setSteps",
+      "objectName": "@happyvertical/smrt-sales:CommissionPlan"
+    },
+    {
+      "kind": "cli",
+      "name": "commissionplan_getRemainderSink",
+      "operation": "getRemainderSink",
+      "objectName": "@happyvertical/smrt-sales:CommissionPlan"
+    },
+    {
+      "kind": "cli",
+      "name": "commissionplan_setRemainderSink",
+      "operation": "setRemainderSink",
+      "objectName": "@happyvertical/smrt-sales:CommissionPlan"
+    },
+    {
+      "kind": "cli",
+      "name": "commissionplan_getWaterfallPlan",
+      "operation": "getWaterfallPlan",
+      "objectName": "@happyvertical/smrt-sales:CommissionPlan"
+    },
     {
       "kind": "cli",
       "name": "commissionplan_getMetadata",
@@ -12518,12 +13469,12 @@
   ],
   "prompts": [],
   "relationshipsV2": {
-    "foreignKeyFields": 35,
+    "foreignKeyFields": 37,
     "crossPackageRefFields": 14,
     "junctionCollections": 0,
     "hierarchicalObjects": 0,
     "polymorphicAssociations": 0,
-    "uuidColumns": 216
+    "uuidColumns": 224
   },
   "agentDoc": "# @happyvertical/smrt-sales\n\nModular sales: provider-neutral agreement execution, CRM, referral intake, a neutral commissions financial core, and reusable Svelte surfaces. One installable package with distinct subpath exports:\n\n- `@happyvertical/smrt-sales/agreements`\n- `@happyvertical/smrt-sales/crm`\n- `@happyvertical/smrt-sales/referrals`\n- `@happyvertical/smrt-sales/commissions`\n- `@happyvertical/smrt-sales/svelte`\n\nThe root export re-exports every TS module. `agreements` depends on the provider-neutral `@happyvertical/signatures` contract and `smrt-assets`; provider credentials stay in the injected SDK adapter/secret store. `referrals` binds its versioned terms to `agreements`.\n\n## Validation\n\nRun `pnpm --filter @happyvertical/smrt-sales test` and `pnpm --filter @happyvertical/smrt-sales typecheck` for package changes. PostgreSQL-sensitive changes must also run `pnpm --filter @happyvertical/smrt-sales test:postgres`; the command uses the repository's disposable PostgreSQL harness and is registered in the PostgreSQL CI shard.\n\n## Roles vs. money\n\nReferrers and Sales Representatives are **distinct roles** and stay that way. Both connect to money through one neutral financial account:\n\n- **Earner** (commissions): payout identity — method, threshold, currency, status. Referenced by every Commission and CommissionPayout.\n- **SalesRepresentative** (crm) and **Referrer** (referrals): role models, each holding `profileId` (cross-package string ref to smrt-profiles) and `earnerId`.\n\n## Modules\n\nPer-module semantics live in sibling module docs — read the one for the module\nyou are editing. This file keeps what holds in every module.\n\n| Module | Scope | Module doc |\n|---|---|---|\n| `agreements` | verified execution evidence — private orchestration state, append-only provider events, immutable executed agreements, and the provider-neutral execution service | [agents/agreements.md](agents/agreements.md) |\n| `commissions` | the neutral financial core — earners, versioned plans, earning events, commissions, adjustments, balances, and payout settlement | [agents/commissions.md](agents/commissions.md) |\n| `crm` | leads, configurable pipelines, opportunities, tenant-safe Lead follow-up, activity trail, and idempotent conversion links | [agents/crm.md](agents/crm.md) |\n| `referrals` | referrers, programs, versioned attribution policies, links/touches, referrals, exception review, and term snapshots | [agents/referrals.md](agents/referrals.md) |\n| `svelte` | props-driven presentational surfaces for CRM, the referrer portal, and operator review | [agents/svelte.md](agents/svelte.md) |\n\n## Currency\n\n**All monetary fields are integer cents** with `*Cents` suffixes; that scale is a Sales contract, not an implicit framework currency rule. Fresh PostgreSQL/DuckDB INTEGER columns are BIGINT, while JavaScript hydration rejects values outside the safe-integer range. Rates are decimal (`0`–`1`). Rounding happens once per calculation step via `roundCents()` (half-away-from-zero) and every Commission stores its `calculationTrace` so amounts are reproducible. Convert at display/commerce boundaries with `centsToAmount()`/`amountToCents()`.\n\n## Tenancy\n\nBusiness/domain models are generally `@TenantScoped({ mode: 'optional' })` with `@tenantId({ nullable: true })`. This deliberately departs from legacy smrt-affiliates (which was cross-tenant by design for ad networks): sales programs, earners, and payouts are tenant-owned, while `tenantId: null` remains available for intentional global/operator-level rows. Immutable tenant-bound execution evidence (`AgreementExecution`, `AgreementExecutionEvent`, `ExecutedAgreement`) and private orchestration fences (`CommissionAdjustmentOperation`) instead use required tenancy with a non-null owner; never weaken those rows to optional tenancy.\n\n## Cross-package references (plain strings)\n\n`profileId` → smrt-profiles Profile; `invoiceId` (CommissionPayout) → smrt-commerce Invoice; agreement artifacts → smrt-assets Asset ids. No static imports of unrelated sibling domain packages.\n\n## smrt-affiliates migration\n\n`@happyvertical/smrt-affiliates` is now a deprecated compatibility package that re-exports this package's commissions core under the legacy names (`Partner` → `Earner`, `Payout` → `CommissionPayout`, `Commission`, collections, enums) with `@deprecated` guidance and **no duplicate persistence model**. The data/API mapping lives in `packages/affiliates/MIGRATION.md`.\n\n## Gotchas\n\n- **Cents vs. rates**: `*Cents` fields are INTEGER (`= 0` defaults); `rate`/`probability`/`shareFraction` are DECIMAL (`= 0.0` defaults). Don't mix the two conventions on one field.\n- **Optional same-package foreign keys use null**: execution, supersession, earning-event, and payout references that are absent persist as `null`, never `''`; their physical database constraints remain enabled when a real id is present.\n- **Versioned terms are rows, not edits**: CommissionPlan / AttributionPolicy / ReferralAgreement amendments insert `version + 1`; active versions are save-guarded immutable.\n- **Idempotency is dedupeKey-based**: EarningEvent, Commission, and CommissionPayout carry natural keys (`conflictColumns`) — retried ingestion/settlement upserts instead of duplicating.\n- **Adjustments never rewrite**: correcting an earned/paid Commission means appending a CommissionAdjustment, not editing the Commission.\n- **Adjustment retries use the service**: CommissionAdjustment has no public operation field and rejects an untyped `operationId` constructor option; ordinary legacy creates without one remain compatible. `CommissionAdjustmentService` transactionally claims the private operation fence with insert-on-conflict-no-op, creates the explicit mapped adjustment id only for the winner, then verifies the persisted intent; the same globally unique operation UUID cannot be reused by another tenant.\n- **Manifest objects must remain root-importable**: generated consumer registration imports every manifest-advertised model and collection from `@happyvertical/smrt-sales`. The `CommissionAdjustmentOperation` and `ReferralClickOperation` model/collection values are therefore root and owning-subpath exports for runtime loading, while their `api: false`, `mcp: false`, and `cli: false` decorators keep them off generated application surfaces. Publish-pack validation imports the actual CLI-generated register against the packed tarball.\n- **CommissionPayout, not Payout**: avoids the pre-existing global table-name collision between commerce `Payout` and legacy affiliates `Payout` (`payouts`).\n- **Table names are global**: new models were named to avoid collisions across packages (`commission_payouts`, `sales_activities`, `attribution_policies`, …).\n- **Svelte validation includes interaction contracts**: intake and inbox components have runtime component tests; `typecheck` also runs `svelte-check` via `scripts/svelte-check-a11y.mjs`. Ship raw `.svelte` via `svelte-package`.\n- **Lead workflows stay generic**: call `LeadWorkflowService` for tenant-safe intake, audited follow-up, qualification, nonterminal Opportunity stage movement, and terminal closure with optional conversion links. Optional intake `profileId` is stored and fingerprinted but remains host-authorized. The service delegates CRM lifecycles to their owning collections; hosts supply authorization and create downstream records. `LeadCreateForm`, `LeadList`, and `LeadDetail` are props/callback only. See [agents/crm.md](agents/crm.md) for dedupe, retry, and inbox contracts.\n- **Model transition methods don't save**: `markEarned()/approve()/markPayable()/markPaid()` (Commission) and the payout transitions mutate + stamp timestamps only — callers save; the settlement/payout services do both.\n- **`reject()` alone strands rows**: the model method only flips status — always reject through `transitionPayoutForSource`, which releases the batch's membership in the same transaction; stamped rows on a rejected payout would be unsettleable forever.\n- **The payout source stamp is derived data, never authorization**: `sourceKind`/`sourceId` on CommissionPayout index the history listing; both the listing and the lifecycle service re-verify actual membership and fail closed when the stamp cannot be proven.\n- **`sweepClearing` treats `clearingEndsAt: null` as immediately sweepable** (no clearing configured ⇒ nothing to wait for).\n- **Agreement freeze scope**: activating a ReferralAgreement requires and freezes its execution/evidence refs along with its commercial terms. `effectiveTo` remains writable for explicit end-dating; signed bytes, hashes, signer evidence, and audit trail exist only on immutable ExecutedAgreement/Asset records.\n- **Circular FK pair by design**: `Referral.snapshotId ↔ ReferralTermSnapshot.referralId`. Fine on SQLite (and no cross-table DDL constraints are emitted for these string FKs); keep an eye on strict-DDL environments.\n- **Attribution resolution is single-writer per (target, program)**: `resolve()` is idempotent against PERSISTED state, but two workers resolving the same target concurrently can both pass the existence check and create duplicate credit — the collection layer has no cross-row transaction (the same stance as payout batching, which relies on disjoint scopes for concurrency). Run intake resolution serially per target (it naturally is, in a request handler); duplicates are visible in the portal and correctable via `override()`.\n- **recordClick inside your transaction participates, never nests**: a nested adapter `transaction()` takes an independent pooled connection (happyvertical/sdk#1108) — it deadlocks undetectably on locks the caller's transaction holds (PostgreSQL sees a promise-wait, not a lock-wait) and refuses caller-created uncommitted links as `unknown_code`. Pass the caller's transaction database as `RecordClickInput.transaction` or bind the collection to it (`{ db: tx, _reuseInitializedDb: true, _deferRuntimeInitialization: true }` — detected and honored automatically); a pool-level database passed as `transaction` is refused with typed reason `invalid_transaction`. Participating results are bound to the caller's transaction — carry ids across the commit boundary; the pool-bound default still self-transacts and rehydrates after commit.\n- **Click retries reuse one key**: pass the exact same non-empty, well-formed-Unicode `recordClick.idempotencyKey` (maximum 256 UTF-8 bytes) on transport/database retry. Omitting it remains source-compatible but creates and returns a one-shot UUID; it cannot deduplicate a later independent invocation. `maxEvidenceBytes` guards creation; changing it cannot turn an already-committed exact replay into failure. Replay validation is against the immutable operation/touch snapshot, not mutable current link fields: later link edits preserve exact replay, the result link is current, and the touch evidence is the original snapshot. The private optional-tenant `ReferralClickOperation` table is the serialization fence and must be included in schema migration. Never pre-bound caller evidence: Sales owns the authoritative final-envelope byte check.\n- **`ObjectRegistry.getConfig(X)` needs the class module imported** (decorator side effects) — manifest-only registration doesn't carry api/mcp/conflictColumns; tests asserting surface configs need a side-effect import of the module barrel.\n",
   "moduleDocs": [
@@ -12535,7 +13486,7 @@
     {
       "path": "agents/commissions.md",
       "module": "commissions",
-      "content": "# smrt-sales/commissions — neutral financial core\n\nPer-module semantics for `@happyvertical/smrt-sales/commissions`. Package orientation, the\ncross-module invariants (currency, tenancy, cross-package refs, roles vs.\nmoney), and the Gotchas that apply before editing anything live in\n[../AGENTS.md](../AGENTS.md) — read that first.\n\n- **Earner**: `profileId`, `status` (`pending|active|suspended`), `payoutMethod` (`bank_transfer|check|paypal|credit|other`), `payoutThresholdCents`, `payoutScheduleKey` (open string: `manual`, `monthly`, …), `currency`, `metadata`.\n- **EarnerSourceAttribution** (#1986): indexed external attribution mapping `(sourceKind, sourceId) → earnerId` with `status` (`active|inactive`) — the queryable replacement for stashing associations in `Earner.metadata`. Natural key `(tenant_id, source_kind, source_id)` (one mapping per key per tenant; a re-`create` upserts/re-points; the adapters' null-aware upsert dedups NULL-tenant keys too, but duplicate global rows minted outside the model layer remain representable). The attribution kind space is consumer-defined and need not match earning-event source kinds. `EarnerAttributionService` is the public API: `registerAttribution` (idempotent; reports `created`/`previousEarnerId`; also the documented metadata-migration backfill primitive — loop earners, register each association, verify, drop the metadata key) and `resolveActiveEarnerBySource`/`resolveActiveEarnersBySources` (single/batched; 2 queries bounded by the REQUESTED ids, never a scan of active earners; fail-closed typed reasons `no_mapping|mapping_inactive|ambiguous_mapping|earner_not_found|earner_not_active` — more than one ACTIVE row for a key refuses rather than guessing). In tenant context mappings resolve within that tenant only; without context, lookups span all rows and cross-tenant duplicates surface as `ambiguous_mapping`.\n- **CommissionPlan**: versioned calculation terms. Natural key `(tenant_id, plan_key, version)` (per-tenant keys; the adapters' null-aware upsert dedups NULL-tenant keys through the model layer, though duplicate global rows minted via raw SQL remain representable); `status` (`draft|active|superseded|retired`); `effectiveFrom`. Components are a JSON-string array (`getComponents()`): each component has `key`, `trigger` (earning-event kind or `*`), `basis` (`fixed|gross|net|margin|custom`), `rate` or `fixedAmountCents`, `recurrence` (`one_time` or `recurring` with optional `maxOccurrences`/`windowMonths`). **Immutable once active** — amendments create a new row with `version + 1`; prior versions are never rewritten. `latestActiveByKey(key, at?)` resolves the highest active version **already in effect at `at`** — a future-dated amendment can be activated ahead of time without governing earlier qualifications (same rule on `AttributionPolicyCollection`).\n- **EarningEvent**: immutable commercial-event evidence (`conversion`, `agreement_execution`, `invoice_payment`, `collected_revenue`, `recognized_margin`, or any extensible kind). Carries `sourceKind`/`sourceId` (generic earning source), `grossAmountCents`/`netAmountCents`/`marginCents`, `currency`, `occurredAt`, and a `dedupeKey` natural key for idempotent ingestion. No update/delete surface, plus a save-time immutability guard: hydrated edits, blind id overwrites, and fresh creates onto an existing dedupe key all throw (the upsert would rotate the row id and orphan referencing Commissions) — idempotent ingestion goes through `getOrCreateByDedupeKey()`.\n- **Commission**: one earning record per earner per plan component per event occurrence. Integer-cents amounts (`baseAmountCents`, `amountCents`), decimal `rate`, `basis`, snapshot references (`planKey`/`planVersion`, generic `termsSnapshotKind`/`termsSnapshotId`), a JSON `calculationTrace` sufficient to reproduce the amount, split support (`splitGroupId`, `shareFraction`), and a `dedupeKey` for idempotent creation. Lifecycle `pending → earned → approved → payable → paid`, enforced by a save-time transition guard with an authoritative prior-status re-read (commerce pattern).\n- **CommissionAdjustment**: append-only corrections (`refund|credit|chargeback|dispute|correction`), signed `amountCents`, required `reason`, immutable once created. `CommissionAdjustmentService.createAdjustment()` is the tenant-required idempotent creation door: callers provide a stable operation UUID; the database creates exactly one row, exact retries return it, and changed tenant/commission/earner/kind/cents/currency/reason/operator/metadata fail with a typed replay conflict. Parent Commission plus denormalized tenant/Earner/currency and operator UUID are validated before insert. The financial row deliberately exposes no operation field. A private, required-tenant `CommissionAdjustmentOperation` table uses the globally unique operation UUID as its primary id, maps it to the adjustment UUID, and is inserted in the same transaction as the adjustment. Existing adjustment schemas and legacy direct creates remain unchanged. Earned/paid Commissions are never rewritten — adjustments append to them.\n- **Payable balance**: computed, not stored — `CommissionBalanceService` sums payable Commissions plus unsettled Adjustments per Earner/currency.\n- **CommissionPayout**: settlement batch per Earner. `pending → approved → processing → completed | failed` (`resetFromFailed()` is the only exit from failed), plus the terminal operator decline `rejected` reachable from pending/approved (#1987 — reject through `transitionPayoutForSource`, which also RELEASES the batch's membership so the rows settle through a future batch; `reject()` on the model mutates status only). Settles rows via the collections' **conditional `claimForPayout`** (model-layer get/save/re-read — tenancy- and dialect-safe; a row owned by another batch is never re-claimed) and stores totals recomputed from the VERIFIED claimed membership; idempotent via `idempotencyKey` natural key (default `${earnerId}:${currency}:${YYYY-MM-DD}`) — a clean replay touches nothing, while a pending payout whose totals disagree with its stamped rows (interrupted claim pass) is repaired on replay (the claim pass re-checks the payout is still pending first). Each batch/repair pass also derives the payout's **single-source stamp** (`sourceKind`/`sourceId`, indexed): set when every claimed commission — and every claimed adjustment through its parent commission — shares exactly one non-empty source; empty for mixed/unknown/empty membership. `completePayout` flips member commissions to `paid` BEFORE the terminal transition, so a mid-loop failure stays retryable. Enforces `totalAmountCents = commissionTotalCents + adjustmentTotalCents` at save; retains `paymentReference`/`providerRef`; optional `invoiceId` cross-package string ref to a commerce Invoice. Generated surface is read-only on ALL doors (api/mcp/cli `list`/`get`) — writes go through `CommissionPayoutService`. `createPayoutBatch` settles the whole earner+currency by default, or a **scoped** subset: pass `sourceKind`+`sourceId` to settle just one earning source (e.g. one ad network), or `commissionIds` for an explicit set (each validated payable+unsettled+earner+currency; requires its own `idempotencyKey`) — adjustments are narrowed to the same scope, and the default idempotency key folds the source in. Scoping is how concurrent per-source batches settle safely: batches scoped to different sources (or disjoint `commissionIds`) gather **disjoint** row sets and never contend. The collection layer has no cross-row transaction, so OVERLAPPING concurrent scopes (a source batch + the earner-wide batch, intersecting id sets, or a batch replay racing a lifecycle transition of the same payout) must be serialized by the caller — `claimForPayout` still won't double-own a row, but a shared commission and its adjustment could split across the two batches.\n- **Source-scoped payout history** (#1985): `CommissionPayoutService.getSourcePayoutHistory({ sourceKind, sourceId, limit?, offset? })` — one page of the payouts belonging to ONE earning source, newest first (`created_at DESC, id DESC`), offset contract (`nextOffset` advances by the scanned count; `null` when exhausted). Candidates come from the indexed stamp, so work is bounded by page size (a sparse source never scans the global history); each page is re-verified against actual membership in three batched queries (no per-payout N+1) — every member commission and every adjustment's parent must carry exactly the requested source and agree on earner/currency/tenant; unprovable rows (mixed-source, missing parents, memberless artifacts, released/rejected batches) are excluded fail-closed and reported in `excluded` with reasons. Adjustment-only payouts prove ownership through parent commissions and list normally. Payouts minted before the stamp existed are invisible until backfilled with `restampPayoutSource(payoutId)` (idempotent, any status).\n- **Source-authorized lifecycle transitions** (#1987): `CommissionPayoutService.transitionPayoutForSource({ payoutId, sourceKind, sourceId, action, expectedStatus?, paymentReference?, reason? })` — atomic alternative to load-verify-transition. Actions `approve | mark_processing | complete | fail | reject`. Everything runs on one transaction database: the payout row is locked (PostgreSQL `SELECT … FOR UPDATE`, replica-safe; single-connection engines serialize transitions per database in-process), membership is re-verified under the lock (every commission and every adjustment through its parent must carry exactly the requested source and matching earner/currency/tenant — else typed fail-closed refusals with no payout/member data), and only authorized calls receive status-derived `already_applied` or `status_conflict` outcomes. Totals are then recomputed under the lock (drift refuses the money-forward actions with `totals_drift`; repair = `createPayoutBatch` replay while pending; `fail`/`reject` proceed despite drift — reject IS the remedy), and the transition plus member writes commit or roll back together (`complete` flips members to paid in the same transaction; `reject` releases membership then declines). Outcomes: `transitioned`, `already_applied` (idempotent echo — terminal completion NEVER rewrites `paymentReference`/`providerRef`/`paidAt`), or `refused` with `{ reason, detail }`. Concurrent duplicate calls for actions that retain membership resolve as one `transitioned` + `already_applied` echoes; `reject` releases its membership evidence, so serialized replays fail `membership_empty` rather than expose rejected state. `expectedStatus` adds optimistic-concurrency strictness after authorization. Memberless batch artifacts cannot pass the source-authorized door (`membership_empty`) — they stay operator-level.\n"
+      "content": "# smrt-sales/commissions — neutral financial core\n\nPer-module semantics for `@happyvertical/smrt-sales/commissions`. Package orientation, the\ncross-module invariants (currency, tenancy, cross-package refs, roles vs.\nmoney), and the Gotchas that apply before editing anything live in\n[../AGENTS.md](../AGENTS.md) — read that first.\n\n- **Earner**: `profileId`, `status` (`pending|active|suspended`), `payoutMethod` (`bank_transfer|check|paypal|credit|other`), `payoutThresholdCents`, `payoutScheduleKey` (open string: `manual`, `monthly`, …), `currency`, `metadata`.\n- **EarnerSourceAttribution** (#1986): indexed external attribution mapping `(sourceKind, sourceId) → earnerId` with `status` (`active|inactive`) — the queryable replacement for stashing associations in `Earner.metadata`. Natural key `(tenant_id, source_kind, source_id)` (one mapping per key per tenant; a re-`create` upserts/re-points; the adapters' null-aware upsert dedups NULL-tenant keys too, but duplicate global rows minted outside the model layer remain representable). The attribution kind space is consumer-defined and need not match earning-event source kinds. `EarnerAttributionService` is the public API: `registerAttribution` (idempotent; reports `created`/`previousEarnerId`; also the documented metadata-migration backfill primitive — loop earners, register each association, verify, drop the metadata key) and `resolveActiveEarnerBySource`/`resolveActiveEarnersBySources` (single/batched; 2 queries bounded by the REQUESTED ids, never a scan of active earners; fail-closed typed reasons `no_mapping|mapping_inactive|ambiguous_mapping|earner_not_found|earner_not_active` — more than one ACTIVE row for a key refuses rather than guessing). In tenant context mappings resolve within that tenant only; without context, lookups span all rows and cross-tenant duplicates surface as `ambiguous_mapping`.\n- **CommissionPlan**: versioned calculation terms. Natural key `(tenant_id, plan_key, version)` (per-tenant keys; the adapters' null-aware upsert dedups NULL-tenant keys through the model layer, though duplicate global rows minted via raw SQL remain representable); `status` (`draft|active|superseded|retired`); `effectiveFrom`. Components are a JSON-string array (`getComponents()`): each component has `key`, `trigger` (earning-event kind or `*`), `basis` (`fixed|gross|net|margin|custom`), `rate` or `fixedAmountCents`, `recurrence` (`one_time` or `recurring` with optional `maxOccurrences`/`windowMonths`). **Immutable once active** — amendments create a new row with `version + 1`; prior versions are never rewritten. `latestActiveByKey(key, at?)` resolves the highest active version **already in effect at `at`** — a future-dated amendment can be activated ahead of time without governing earlier qualifications (same rule on `AttributionPolicyCollection`).\n- **EarningEvent**: immutable commercial-event evidence (`conversion`, `agreement_execution`, `invoice_payment`, `collected_revenue`, `recognized_margin`, or any extensible kind). Carries `sourceKind`/`sourceId` (generic earning source), `grossAmountCents`/`netAmountCents`/`marginCents`, `currency`, `occurredAt`, and a `dedupeKey` natural key for idempotent ingestion. No update/delete surface, plus a save-time immutability guard: hydrated edits, blind id overwrites, and fresh creates onto an existing dedupe key all throw (the upsert would rotate the row id and orphan referencing Commissions) — idempotent ingestion goes through `getOrCreateByDedupeKey()`.\n- **Commission**: one earning record per earner per plan component per event occurrence. Integer-cents amounts (`baseAmountCents`, `amountCents`), decimal `rate`, `basis`, snapshot references (`planKey`/`planVersion`, generic `termsSnapshotKind`/`termsSnapshotId`), a JSON `calculationTrace` sufficient to reproduce the amount, split support (`splitGroupId`, `shareFraction`), and a `dedupeKey` for idempotent creation. Lifecycle `pending → earned → approved → payable → paid`, enforced by a save-time transition guard with an authoritative prior-status re-read (commerce pattern).\n- **CommissionAdjustment**: append-only corrections (`refund|credit|chargeback|dispute|correction`), signed `amountCents`, required `reason`, immutable once created. `CommissionAdjustmentService.createAdjustment()` is the tenant-required idempotent creation door: callers provide a stable operation UUID; the database creates exactly one row, exact retries return it, and changed tenant/commission/earner/kind/cents/currency/reason/operator/metadata fail with a typed replay conflict. Parent Commission plus denormalized tenant/Earner/currency and operator UUID are validated before insert. The financial row deliberately exposes no operation field. A private, required-tenant `CommissionAdjustmentOperation` table uses the globally unique operation UUID as its primary id, maps it to the adjustment UUID, and is inserted in the same transaction as the adjustment. Claims tolerate either primary-key or tenant/slug/context uniqueness arbitration without aborting the transaction; only the tenant-scoped operation UUID lookup and immutable intent comparison authorize a replay. Existing adjustment schemas and legacy direct creates remain unchanged. Earned/paid Commissions are never rewritten — adjustments append to them.\n- **Payable balance**: computed, not stored — `CommissionBalanceService` sums payable Commissions plus unsettled Adjustments per Earner/currency.\n- **CommissionPayout**: settlement batch per Earner. `pending → approved → processing → completed | failed` (`resetFromFailed()` is the only exit from failed), plus the terminal operator decline `rejected` reachable from pending/approved (#1987 — reject through `transitionPayoutForSource`, which also RELEASES the batch's membership so the rows settle through a future batch; `reject()` on the model mutates status only). Settles rows via the collections' **conditional `claimForPayout`** (model-layer get/save/re-read — tenancy- and dialect-safe; a row owned by another batch is never re-claimed) and stores totals recomputed from the VERIFIED claimed membership; idempotent via `idempotencyKey` natural key (default `${earnerId}:${currency}:${YYYY-MM-DD}`) — a clean replay touches nothing, while a pending payout whose totals disagree with its stamped rows (interrupted claim pass) is repaired on replay (the claim pass re-checks the payout is still pending first). Each batch/repair pass also derives the payout's **single-source stamp** (`sourceKind`/`sourceId`, indexed): set when every claimed commission — and every claimed adjustment through its parent commission — shares exactly one non-empty source; empty for mixed/unknown/empty membership. `completePayout` flips member commissions to `paid` BEFORE the terminal transition, so a mid-loop failure stays retryable. Enforces `totalAmountCents = commissionTotalCents + adjustmentTotalCents` at save; retains `paymentReference`/`providerRef`; optional `invoiceId` cross-package string ref to a commerce Invoice. Generated surface is read-only on ALL doors (api/mcp/cli `list`/`get`) — writes go through `CommissionPayoutService`. `createPayoutBatch` settles the whole earner+currency by default, or a **scoped** subset: pass `sourceKind`+`sourceId` to settle just one earning source (e.g. one ad network), or `commissionIds` for an explicit set (each validated payable+unsettled+earner+currency; requires its own `idempotencyKey`) — adjustments are narrowed to the same scope, and the default idempotency key folds the source in. Scoping is how concurrent per-source batches settle safely: batches scoped to different sources (or disjoint `commissionIds`) gather **disjoint** row sets and never contend. The collection layer has no cross-row transaction, so OVERLAPPING concurrent scopes (a source batch + the earner-wide batch, intersecting id sets, or a batch replay racing a lifecycle transition of the same payout) must be serialized by the caller — `claimForPayout` still won't double-own a row, but a shared commission and its adjustment could split across the two batches.\n- **Source-scoped payout history** (#1985): `CommissionPayoutService.getSourcePayoutHistory({ sourceKind, sourceId, limit?, offset? })` — one page of the payouts belonging to ONE earning source, newest first (`created_at DESC, id DESC`), offset contract (`nextOffset` advances by the scanned count; `null` when exhausted). Candidates come from the indexed stamp, so work is bounded by page size (a sparse source never scans the global history); each page is re-verified against actual membership in three batched queries (no per-payout N+1) — every member commission and every adjustment's parent must carry exactly the requested source and agree on earner/currency/tenant; unprovable rows (mixed-source, missing parents, memberless artifacts, released/rejected batches) are excluded fail-closed and reported in `excluded` with reasons. Adjustment-only payouts prove ownership through parent commissions and list normally. Payouts minted before the stamp existed are invisible until backfilled with `restampPayoutSource(payoutId)` (idempotent, any status).\n- **Source-authorized lifecycle transitions** (#1987): `CommissionPayoutService.transitionPayoutForSource({ payoutId, sourceKind, sourceId, action, expectedStatus?, paymentReference?, reason? })` — atomic alternative to load-verify-transition. Actions `approve | mark_processing | complete | fail | reject`. Everything runs on one transaction database: the payout row is locked (PostgreSQL `SELECT … FOR UPDATE`, replica-safe; single-connection engines serialize transitions per database in-process), membership is re-verified under the lock (every commission and every adjustment through its parent must carry exactly the requested source and matching earner/currency/tenant — else typed fail-closed refusals with no payout/member data), and only authorized calls receive status-derived `already_applied` or `status_conflict` outcomes. Totals are then recomputed under the lock (drift refuses the money-forward actions with `totals_drift`; repair = `createPayoutBatch` replay while pending; `fail`/`reject` proceed despite drift — reject IS the remedy), and the transition plus member writes commit or roll back together (`complete` flips members to paid in the same transaction; `reject` releases membership then declines). Outcomes: `transitioned`, `already_applied` (idempotent echo — terminal completion NEVER rewrites `paymentReference`/`providerRef`/`paidAt`), or `refused` with `{ reason, detail }`. Concurrent duplicate calls for actions that retain membership resolve as one `transitioned` + `already_applied` echoes; `reject` releases its membership evidence, so serialized replays fail `membership_empty` rather than expose rejected state. `expectedStatus` adds optimistic-concurrency strictness after authorization. Memberless batch artifacts cannot pass the source-authorized door (`membership_empty`) — they stay operator-level.\n"
     },
     {
       "path": "agents/crm.md",
@@ -12545,7 +13496,7 @@
     {
       "path": "agents/referrals.md",
       "module": "referrals",
-      "content": "# smrt-sales/referrals\n\nPer-module semantics for `@happyvertical/smrt-sales/referrals`. Package orientation, the\ncross-module invariants (currency, tenancy, cross-package refs, roles vs.\nmoney), and the Gotchas that apply before editing anything live in\n[../AGENTS.md](../AGENTS.md) — read that first.\n\n- **Referrer**: role model (`profileId`, `earnerId`, `status`).\n- **ReferralProgram**: program defaults — default commission plan key, default attribution policy key, eligibility defaults.\n- **AttributionPolicy**: versioned `(tenant_id, policy_key, version)` policy (per-tenant keys) — attribution `windowDays`, credit mode (`first_touch|last_touch|assigned|split`), split shares, self-referral/existing-client eligibility, eligible services/campaigns/regions, conflict behavior. Immutable once active; amendments bump `version`.\n- **ReferralLink**: shareable link/code per Referrer+Program. Codes are crypto-random and uniqueness-checked. `ReferralLinkCollection.recordClick()` transactionally creates one immutable touch plus one counter increment behind a caller replay key. Exact retries return the original touch; changed link/subject/time/evidence intent raises `ReferralClickReplayConflictError`. Replay comparison uses the immutable operation/touch snapshot, so later mutable link edits do not invalidate the retry; the result carries the current link and original touch evidence. The exact canonical persisted evidence JSON, after Sales overwrites `code`, `linkId`, and `targetUrl`, is bounded to 4096 UTF-8 bytes by default (`maxEvidenceBytes` customizes it). By default the click self-transacts and rehydrates results after commit; inside a caller's open transaction it must participate instead — pass the transaction database as `RecordClickInput.transaction`, or call it on a collection bound to that transaction, and the click joins the caller's atomicity with results bound to that transaction (#2083).\n- **ReferralTouch**: immutable attribution evidence (`click|code_entry|manual_assignment|partner_entry`) with subject hints and evidence JSON.\n- **Referral**: the introduction — generic qualifying target (`targetKind`/`targetId`: lead, opportunity, client, project, subscription, …), resolved policy version, credit fraction (splits create sibling Referrals sharing `splitGroupId`), lifecycle `pending → attributed → qualified | disqualified | expired | under_review`.\n- **AttributionException**: conflict review queue. Conclusive policy resolves automatically; ambiguity creates an exception; overrides require a `resolutionReason` and are audited.\n- **ReferralAgreement**: versioned per-Referrer terms binding — pins `commissionPlanKey`/`planVersion`, effective dating, and an immutable `ExecutedAgreement` before activation. Amendments are fresh unsigned drafts and never inherit execution evidence.\n- **ReferralTermSnapshot**: immutable at qualification — freezes agreement/plan/policy version refs plus the calculation inputs needed to reproduce every later earning.\n- **Services**: `ReferralAgreementExecutionService` binds generated Referral Agreement versions to the generic execution service and activates/supersedes them transactionally with future-effective amendment support; `AttributionService`, `ReferralQualificationService`, and `ReferralCommissionService` retain their existing attribution/qualification/earning responsibilities.\n"
+      "content": "# smrt-sales/referrals\n\nPer-module semantics for `@happyvertical/smrt-sales/referrals`. Package orientation, the\ncross-module invariants (currency, tenancy, cross-package refs, roles vs.\nmoney), and the Gotchas that apply before editing anything live in\n[../AGENTS.md](../AGENTS.md) — read that first.\n\n- **Referrer**: role model (`profileId`, `earnerId`, `status`).\n- **ReferralProgram**: program defaults — default commission plan key, default attribution policy key, eligibility defaults.\n- **AttributionPolicy**: versioned `(tenant_id, policy_key, version)` policy (per-tenant keys) — attribution `windowDays`, credit mode (`first_touch|last_touch|assigned|split`), split shares, self-referral/existing-client eligibility, eligible services/campaigns/regions, conflict behavior. Immutable once active; amendments bump `version`.\n- **ReferralLink**: shareable link/code per Referrer+Program. Codes are crypto-random and uniqueness-checked. `ReferralLinkCollection.recordClick()` transactionally creates one immutable touch plus one counter increment behind a caller replay key. Exact retries return the original touch; changed link/subject/time/evidence intent raises `ReferralClickReplayConflictError`. Replay comparison uses the immutable operation/touch snapshot, so later mutable link edits do not invalidate the retry; the result carries the current link and original touch evidence. The exact canonical persisted evidence JSON, after Sales overwrites `code`, `linkId`, and `targetUrl`, is bounded to 4096 UTF-8 bytes by default (`maxEvidenceBytes` customizes it). By default the click self-transacts and rehydrates results after commit; inside a caller's open transaction it must participate instead — pass the transaction database as `RecordClickInput.transaction`, or call it on a collection bound to that transaction, and the click joins the caller's atomicity with results bound to that transaction (#2083).\n- **ReferralTouch**: immutable attribution evidence (`click|code_entry|manual_assignment|partner_entry`) with subject hints and evidence JSON.\n- **Referral**: the introduction — generic qualifying target (`targetKind`/`targetId`: lead, opportunity, client, project, subscription, …), resolved policy version, credit fraction (splits create sibling Referrals sharing `splitGroupId`), lifecycle `pending → attributed → qualified | disqualified | expired | under_review`.\n- **AttributionException**: conflict review queue. Conclusive policy resolves automatically; ambiguity creates an exception; overrides require a `resolutionReason` and are audited.\n- **ReferralAgreement**: versioned per-Referrer terms binding — pins `commissionPlanKey`/`planVersion`, effective dating, and an immutable `ExecutedAgreement` before activation. Amendments are fresh unsigned drafts and never inherit execution evidence.\n- **Plan compatibility**: qualification and requalification accept only v1 component plans. A pinned or latest-active v2 waterfall plan returns `unsupported_plan_engine` before snapshot/referral writes; existing snapshots remain valid and unchanged. Bind compatible component terms and retry to recover. Engine changes under a plan key never implicitly migrate referrals.\n- **ReferralTermSnapshot**: immutable at qualification — freezes agreement/plan/policy version refs plus the calculation inputs needed to reproduce every later earning.\n- **Services**: `ReferralAgreementExecutionService` binds generated Referral Agreement versions to the generic execution service and activates/supersedes them transactionally with future-effective amendment support; `AttributionService`, `ReferralQualificationService`, and `ReferralCommissionService` retain their existing attribution/qualification/earning responsibilities.\n"
     },
     {
       "path": "agents/svelte.md",