@happyvertical/smrt-sales 0.55.6 → 0.55.8

package/dist/manifest.json

@@ -2,7 +2,7 @@
   "version": "1.0.0",
   "timestamp": 0,
   "packageName": "@happyvertical/smrt-sales",
-  "packageVersion": "0.55.6",
+  "packageVersion": "0.55.8",
   "objects": {
     "@happyvertical/smrt-sales:AgreementExecutionCollection": {
       "name": "agreementexecutioncollection",
@@ -5232,6 +5232,7 @@
       "className": "CommissionAdjustmentOperation",
       "qualifiedName": "@happyvertical/smrt-sales:CommissionAdjustmentOperation",
       "collection": "commissionadjustmentoperations",
+      "description": "One globally unique adjustment operation UUID mapped to its adjustment.",
       "filePath": "/home/runner/work/smrt/smrt/packages/sales/src/commissions/models/CommissionAdjustmentOperation.ts",
       "packageName": "@happyvertical/smrt-sales",
       "fields": {
@@ -8379,6 +8380,7 @@
       "className": "Lead",
       "qualifiedName": "@happyvertical/smrt-sales:Lead",
       "collection": "leads",
+      "description": "Lead is an identified prospect: a person/organization that showed intent but has not yet been qualified into an Opportunity.",
       "filePath": "/home/runner/work/smrt/smrt/packages/sales/src/crm/models/Lead.ts",
       "packageName": "@happyvertical/smrt-sales",
       "fields": {
@@ -8404,29 +8406,47 @@
           "type": "text",
           "required": true,
           "default": "",
+          "description": "What you call this lead.",
           "_meta": {
-            "required": true
+            "required": true,
+            "description": "What you call this lead."
           }
         },
         "contactName": {
           "type": "text",
           "required": false,
-          "default": ""
+          "default": "",
+          "description": "The person to talk to.",
+          "_meta": {
+            "description": "The person to talk to."
+          }
         },
         "email": {
           "type": "text",
           "required": false,
-          "default": ""
+          "default": "",
+          "description": "Their email address.",
+          "_meta": {
+            "description": "Their email address."
+          }
         },
         "phone": {
           "type": "text",
           "required": false,
-          "default": ""
+          "default": "",
+          "description": "Their phone number.",
+          "_meta": {
+            "description": "Their phone number."
+          }
         },
         "organizationName": {
           "type": "text",
           "required": false,
-          "default": ""
+          "default": "",
+          "description": "The company they are with.",
+          "_meta": {
+            "description": "The company they are with."
+          }
         },
         "profileId": {
           "type": "crossPackageRef",
@@ -8436,12 +8456,20 @@
         "ownerRepId": {
           "type": "foreignKey",
           "required": false,
-          "related": "SalesRepresentative"
+          "related": "SalesRepresentative",
+          "description": "The sales representative who owns this lead.",
+          "_meta": {
+            "description": "The sales representative who owns this lead."
+          }
         },
         "status": {
           "type": "text",
           "required": false,
-          "default": "new"
+          "default": "new",
+          "description": "Where the lead stands, for example new or qualified.",
+          "_meta": {
+            "description": "Where the lead stands, for example new or qualified."
+          }
         },
         "sourceKind": {
           "type": "text",
@@ -8778,6 +8806,7 @@
       "className": "Opportunity",
       "qualifiedName": "@happyvertical/smrt-sales:Opportunity",
       "collection": "opportunities",
+      "description": "Opportunity is a qualified engagement: a deal with an expected value moving through the stages of a PipelineDefinition.",
       "filePath": "/home/runner/work/smrt/smrt/packages/sales/src/crm/models/Opportunity.ts",
       "packageName": "@happyvertical/smrt-sales",
       "fields": {
@@ -8803,53 +8832,91 @@
           "type": "text",
           "required": true,
           "default": "",
+          "description": "What you call this deal.",
           "_meta": {
-            "required": true
+            "required": true,
+            "description": "What you call this deal."
           }
         },
         "leadId": {
           "type": "foreignKey",
           "required": false,
-          "related": "Lead"
+          "related": "Lead",
+          "description": "The lead it came from.",
+          "_meta": {
+            "description": "The lead it came from."
+          }
         },
         "ownerRepId": {
           "type": "foreignKey",
           "required": false,
-          "related": "SalesRepresentative"
+          "related": "SalesRepresentative",
+          "description": "The sales representative who owns this deal.",
+          "_meta": {
+            "description": "The sales representative who owns this deal."
+          }
         },
         "pipelineId": {
           "type": "foreignKey",
           "required": false,
-          "related": "PipelineDefinition"
+          "related": "PipelineDefinition",
+          "description": "The pipeline it moves through.",
+          "_meta": {
+            "description": "The pipeline it moves through."
+          }
         },
         "stageId": {
           "type": "foreignKey",
           "required": false,
-          "related": "PipelineStage"
+          "related": "PipelineStage",
+          "description": "The stage it is at now.",
+          "_meta": {
+            "description": "The stage it is at now."
+          }
         },
         "expectedValueCents": {
           "type": "integer",
           "required": false,
-          "default": 0
+          "default": 0,
+          "description": "What you expect the deal to be worth, in cents.",
+          "_meta": {
+            "description": "What you expect the deal to be worth, in cents."
+          }
         },
         "currency": {
           "type": "text",
           "required": false,
-          "default": "USD"
+          "default": "USD",
+          "description": "The currency of that value.",
+          "_meta": {
+            "description": "The currency of that value."
+          }
         },
         "probability": {
           "type": "decimal",
           "required": false,
-          "default": 0
+          "default": 0,
+          "description": "How likely it is to close, as a decimal (0.5 is 50%).",
+          "_meta": {
+            "description": "How likely it is to close, as a decimal (0.5 is 50%)."
+          }
         },
         "expectedCloseAt": {
           "type": "datetime",
-          "required": false
+          "required": false,
+          "description": "When you expect it to close.",
+          "_meta": {
+            "description": "When you expect it to close."
+          }
         },
         "status": {
           "type": "text",
           "required": false,
-          "default": "open"
+          "default": "open",
+          "description": "open, won or lost.",
+          "_meta": {
+            "description": "open, won or lost."
+          }
         },
         "outcomeReason": {
           "type": "text",
@@ -9179,6 +9246,7 @@
       "className": "OpportunityConversion",
       "qualifiedName": "@happyvertical/smrt-sales:OpportunityConversion",
       "collection": "opportunityconversions",
+      "description": "OpportunityConversion records that a WON opportunity materialized into a downstream record — a client, project, contract, subscription, or any caller-defined kind.",
       "filePath": "/home/runner/work/smrt/smrt/packages/sales/src/crm/models/OpportunityConversion.ts",
       "packageName": "@happyvertical/smrt-sales",
       "fields": {
@@ -9417,6 +9485,7 @@
       "className": "PipelineDefinition",
       "qualifiedName": "@happyvertical/smrt-sales:PipelineDefinition",
       "collection": "pipelinedefinitions",
+      "description": "PipelineDefinition names an ordered set of stages that opportunities move through. Pipelines are configuration rows, not code: tenants can run several (e.g.",
       "filePath": "/home/runner/work/smrt/smrt/packages/sales/src/crm/models/PipelineDefinition.ts",
       "packageName": "@happyvertical/smrt-sales",
       "fields": {
@@ -9442,29 +9511,47 @@
           "type": "text",
           "required": true,
           "default": "",
+          "description": "A short code for the pipeline.",
           "_meta": {
-            "required": true
+            "required": true,
+            "description": "A short code for the pipeline."
           }
         },
         "name": {
           "type": "text",
           "required": false,
-          "default": ""
+          "default": "",
+          "description": "What the pipeline is called.",
+          "_meta": {
+            "description": "What the pipeline is called."
+          }
         },
         "isDefault": {
           "type": "boolean",
           "required": false,
-          "default": false
+          "default": false,
+          "description": "Whether this is the default pipeline for new deals.",
+          "_meta": {
+            "description": "Whether this is the default pipeline for new deals."
+          }
         },
         "status": {
           "type": "text",
           "required": false,
-          "default": "active"
+          "default": "active",
+          "description": "Whether the pipeline is active (accepts new deals) or archived.",
+          "_meta": {
+            "description": "Whether the pipeline is active (accepts new deals) or archived."
+          }
         },
         "metadata": {
           "type": "text",
           "required": false,
-          "default": "{}"
+          "default": "{}",
+          "description": "Extra details kept with the pipeline.",
+          "_meta": {
+            "description": "Extra details kept with the pipeline."
+          }
         }
       },
       "methods": {
@@ -9636,6 +9723,7 @@
       "className": "PipelineStage",
       "qualifiedName": "@happyvertical/smrt-sales:PipelineStage",
       "collection": "pipelinestages",
+      "description": "PipelineStage is a configurable step within a pipeline.",
       "filePath": "/home/runner/work/smrt/smrt/packages/sales/src/crm/models/PipelineStage.ts",
       "packageName": "@happyvertical/smrt-sales",
       "fields": {
@@ -9661,7 +9749,9 @@
           "type": "foreignKey",
           "required": true,
           "related": "PipelineDefinition",
+          "description": "The pipeline this stage belongs to.",
           "_meta": {
+            "description": "The pipeline this stage belongs to.",
             "required": true
           }
         },
@@ -9669,34 +9759,56 @@
           "type": "text",
           "required": true,
           "default": "",
+          "description": "A short code for the stage.",
           "_meta": {
-            "required": true
+            "required": true,
+            "description": "A short code for the stage."
           }
         },
         "name": {
           "type": "text",
           "required": false,
-          "default": ""
+          "default": "",
+          "description": "What the stage is called.",
+          "_meta": {
+            "description": "What the stage is called."
+          }
         },
         "sortOrder": {
           "type": "integer",
           "required": false,
-          "default": 0
+          "default": 0,
+          "description": "Where it comes in the pipeline.",
+          "_meta": {
+            "description": "Where it comes in the pipeline."
+          }
         },
         "probability": {
           "type": "decimal",
           "required": false,
-          "default": 0
+          "default": 0,
+          "description": "How likely a deal at this stage is to close, as a decimal.",
+          "_meta": {
+            "description": "How likely a deal at this stage is to close, as a decimal."
+          }
         },
         "isWon": {
           "type": "boolean",
           "required": false,
-          "default": false
+          "default": false,
+          "description": "Whether reaching this stage closes the deal as won.",
+          "_meta": {
+            "description": "Whether reaching this stage closes the deal as won."
+          }
         },
         "isLost": {
           "type": "boolean",
           "required": false,
-          "default": false
+          "default": false,
+          "description": "Whether reaching this stage closes the deal as lost.",
+          "_meta": {
+            "description": "Whether reaching this stage closes the deal as lost."
+          }
         },
         "metadata": {
           "type": "text",
@@ -9899,6 +10011,7 @@
       "className": "SalesActivity",
       "qualifiedName": "@happyvertical/smrt-sales:SalesActivity",
       "collection": "salesactivities",
+      "description": "SalesActivity is the shared trail for Leads and Opportunities: human touchpoints (note, call, email, meeting), next actions (task with dueAt/completedAt), and framework-written audit rows…",
       "filePath": "/home/runner/work/smrt/smrt/packages/sales/src/crm/models/SalesActivity.ts",
       "packageName": "@happyvertical/smrt-sales",
       "fields": {
@@ -9923,33 +10036,55 @@
         "subjectKind": {
           "type": "text",
           "required": false,
-          "default": "lead"
+          "default": "lead",
+          "description": "What the activity is about: a lead or an opportunity.",
+          "_meta": {
+            "description": "What the activity is about: a lead or an opportunity."
+          }
         },
         "subjectId": {
           "type": "text",
           "required": true,
           "default": "",
+          "description": "The lead or opportunity it is about.",
           "_meta": {
-            "required": true
+            "required": true,
+            "description": "The lead or opportunity it is about."
           }
         },
         "activityKind": {
           "type": "text",
           "required": false,
-          "default": "note"
+          "default": "note",
+          "description": "The kind of activity, for example call, note or email.",
+          "_meta": {
+            "description": "The kind of activity, for example call, note or email."
+          }
         },
         "summary": {
           "type": "text",
           "required": false,
-          "default": ""
+          "default": "",
+          "description": "What happened or what needs doing.",
+          "_meta": {
+            "description": "What happened or what needs doing."
+          }
         },
         "dueAt": {
           "type": "datetime",
-          "required": false
+          "required": false,
+          "description": "When it is due.",
+          "_meta": {
+            "description": "When it is due."
+          }
         },
         "completedAt": {
           "type": "datetime",
-          "required": false
+          "required": false,
+          "description": "When it was done.",
+          "_meta": {
+            "description": "When it was done."
+          }
         },
         "actorProfileId": {
           "type": "crossPackageRef",
@@ -10152,6 +10287,7 @@
       "className": "SalesRepresentative",
       "qualifiedName": "@happyvertical/smrt-sales:SalesRepresentative",
       "collection": "salesrepresentatives",
+      "description": "SalesRepresentative is a ROLE model: it links an identity (smrt-profiles Profile) to sales ownership (Leads/Opportunities reference ownerRepId).",
       "filePath": "/home/runner/work/smrt/smrt/packages/sales/src/crm/models/SalesRepresentative.ts",
       "packageName": "@happyvertical/smrt-sales",
       "fields": {
@@ -14099,6 +14235,7 @@
       "className": "ReferralClickOperation",
       "qualifiedName": "@happyvertical/smrt-sales:ReferralClickOperation",
       "collection": "referralclickoperations",
+      "description": "One globally unique caller replay key mapped to its immutable click touch.",
       "filePath": "/home/runner/work/smrt/smrt/packages/sales/src/referrals/models/ReferralClickOperation.ts",
       "packageName": "@happyvertical/smrt-sales",
       "fields": {
@@ -14343,6 +14480,7 @@
       "className": "ReferralLink",
       "qualifiedName": "@happyvertical/smrt-sales:ReferralLink",
       "collection": "referrallinks",
+      "description": "A ReferralLink is the shareable artifact a Referrer distributes: a globally unique code (natural key ['code'] — codes resolve without knowing the tenant/program) plus an optional destination…",
       "filePath": "/home/runner/work/smrt/smrt/packages/sales/src/referrals/models/ReferralLink.ts",
       "packageName": "@happyvertical/smrt-sales",
       "fields": {
@@ -14641,6 +14779,7 @@
       "className": "ReferralProgram",
       "qualifiedName": "@happyvertical/smrt-sales:ReferralProgram",
       "collection": "referralprograms",
+      "description": "A ReferralProgram anchors links, touches, referrals, agreements, and exceptions, and carries the program-level DEFAULTS:",
       "filePath": "/home/runner/work/smrt/smrt/packages/sales/src/referrals/models/ReferralProgram.ts",
       "packageName": "@happyvertical/smrt-sales",
       "fields": {
@@ -15493,6 +15632,7 @@
       "className": "Referrer",
       "qualifiedName": "@happyvertical/smrt-sales:Referrer",
       "collection": "referrers",
+      "description": "Referrer is a ROLE model: it links an identity (smrt-profiles Profile) to referral activity (ReferralLinks, ReferralTouches, and Referrals reference referrerId).",
       "filePath": "/home/runner/work/smrt/smrt/packages/sales/src/referrals/models/Referrer.ts",
       "packageName": "@happyvertical/smrt-sales",
       "fields": {
@@ -15728,10 +15868,158 @@
     }
   },
   "moduleType": "smrt",
+  "recipes": [
+    {
+      "id": "sales.pipeline",
+      "className": "SalesPipelineRecipe",
+      "label": "Leads & pipeline",
+      "summary": "Capture leads and move them through your sales stages.",
+      "synonyms": [
+        "crm",
+        "prospects",
+        "opportunities",
+        "deals",
+        "funnel"
+      ],
+      "models": [
+        "@happyvertical/smrt-sales:Lead",
+        "@happyvertical/smrt-sales:Opportunity",
+        "@happyvertical/smrt-sales:PipelineDefinition",
+        "@happyvertical/smrt-sales:PipelineStage",
+        "@happyvertical/smrt-sales:SalesActivity"
+      ],
+      "nav": [
+        {
+          "label": "Leads",
+          "model": "@happyvertical/smrt-sales:Lead",
+          "icon": "users",
+          "description": "People who might become customers, and where each one stands."
+        },
+        {
+          "label": "Opportunities",
+          "model": "@happyvertical/smrt-sales:Opportunity",
+          "icon": "briefcase",
+          "description": "Deals in progress, with their value and next step."
+        },
+        {
+          "label": "Pipelines",
+          "model": "@happyvertical/smrt-sales:PipelineDefinition",
+          "icon": "layers",
+          "description": "The stages a deal moves through on its way to a sale."
+        }
+      ],
+      "requires": [],
+      "section": {
+        "id": "sales",
+        "label": "Sales",
+        "icon": "shoppingBag",
+        "description": "Customers, orders and quotes: everything you sell."
+      },
+      "options": {
+        "@happyvertical/smrt-sales:Lead": {
+          "fields": {
+            "profileId": {
+              "visibility": "hidden"
+            },
+            "mergedIntoId": {
+              "visibility": "hidden"
+            },
+            "sourceKind": {
+              "visibility": "hidden"
+            },
+            "sourceId": {
+              "visibility": "hidden"
+            },
+            "acquisitionContext": {
+              "visibility": "hidden"
+            },
+            "intakeRef": {
+              "visibility": "hidden"
+            },
+            "metadata": {
+              "visibility": "hidden"
+            },
+            "qualifiedAt": {
+              "visibility": "hidden"
+            }
+          }
+        },
+        "@happyvertical/smrt-sales:Opportunity": {
+          "fields": {
+            "sourceKind": {
+              "visibility": "hidden"
+            },
+            "sourceId": {
+              "visibility": "hidden"
+            },
+            "metadata": {
+              "visibility": "hidden"
+            },
+            "outcomeReason": {
+              "visibility": "hidden"
+            },
+            "wonAt": {
+              "visibility": "hidden"
+            },
+            "lostAt": {
+              "visibility": "hidden"
+            }
+          }
+        },
+        "@happyvertical/smrt-sales:PipelineStage": {
+          "fields": {
+            "metadata": {
+              "visibility": "hidden"
+            }
+          }
+        },
+        "@happyvertical/smrt-sales:SalesActivity": {
+          "fields": {
+            "metadata": {
+              "visibility": "hidden"
+            },
+            "actorProfileId": {
+              "visibility": "hidden"
+            }
+          }
+        }
+      },
+      "help": {
+        "markdown": "## Overview\n\nLeads and pipeline is a light CRM. You capture leads, turn the promising ones\ninto opportunities, and move each through the stages of a pipeline. Activities\nrecord calls, notes and follow-ups.\n\n## Tasks\n\n### Capture a lead\n\n1. Create a new lead.\n2. Enter the **{field:name}**, **{field:email}** and **{field:phone}**.\n3. Keep **{field:status}** up to date as you qualify them.\n\n### Work an opportunity\n\n1. Create a pipeline, then add its stages in order.\n2. Create a new opportunity and pick the **{field:leadId}**.\n3. Choose the **{field:pipelineId}** and **{field:stageId}**, and enter the\n   **{field:expectedValueCents}** and **{field:expectedCloseAt}**.\n4. Move the **{field:stageId}** along as the deal progresses.\n",
+        "fieldRefs": [
+          "email",
+          "expectedCloseAt",
+          "expectedValueCents",
+          "leadId",
+          "name",
+          "phone",
+          "pipelineId",
+          "stageId",
+          "status"
+        ]
+      },
+      "demo": {
+        "mode": "server",
+        "reasons": [
+          "Needs a server because its package does not build for a browser: node:crypto; and its package depends on @happyvertical/smrt-tenancy, which do not build for a browser (#3624)."
+        ]
+      }
+    }
+  ],
   "smrtDependencies": [
     "@happyvertical/smrt-assets",
     "@happyvertical/smrt-core",
     "@happyvertical/smrt-tenancy"
   ],
+  "browser": {
+    "status": "server-only",
+    "issues": [
+      "#3624"
+    ],
+    "reason": "node:crypto",
+    "via": [
+      "@happyvertical/smrt-tenancy"
+    ]
+  },
   "stampsConstructors": true
 }

package/dist/referrals.js

@@ -1,3 +1,3 @@
-import "./chunks/__smrt-register__-eOj6oe0J.js";
+import "./chunks/__smrt-register__-DFr5ksXZ.js";
 import { A as ReferralClickOperation, B as ATTRIBUTION_RESOLUTION_MODES, C as ReferralTouchCollection, D as ReferralCollection, E as assertHttpTargetUrl, F as validateAttributionPolicyTerms, G as REFERRAL_STATUSES, H as REFERRAL_AGREEMENT_STATUSES, I as ATTRIBUTION_CONFLICT_BEHAVIORS, J as AttributionExceptionCollection, K as REFERRAL_TOUCH_KINDS, L as ATTRIBUTION_CREDIT_MODES, M as ReferralAgreement, N as AttributionPolicyCollection, O as Referral, P as AttributionPolicy, R as ATTRIBUTION_EXCEPTION_STATUSES, S as generateReferralCode, T as ReferralLink, U as REFERRAL_LINK_STATUSES, V as REFERRAL_AGREEMENT_APPROVAL_MODES, W as REFERRAL_PROGRAM_STATUSES, Y as AttributionException, _ as REFERRAL_CODE_ALPHABET, a as ReferralAgreementExecutionService, b as ReferralClickValidationError, c as ReferrerCollection, d as ReferralTermSnapshot, f as ReferralProgramCollection, g as MAX_REFERRAL_CLICK_IDEMPOTENCY_KEY_BYTES, h as MAX_CODE_GENERATION_ATTEMPTS, i as REFERRAL_AGREEMENT_SOURCE_KIND, j as ReferralAgreementCollection, k as ReferralClickOperationCollection, l as Referrer, m as DEFAULT_REFERRAL_CLICK_EVIDENCE_MAX_BYTES, n as REFERRAL_TERMS_SNAPSHOT_KIND, o as AttributionService, p as ReferralProgram, q as REFERRER_STATUSES, r as ReferralCommissionService, s as QualifiedReferralOverrideError, t as ReferralQualificationService, u as ReferralTermSnapshotCollection, v as REFERRAL_CODE_LENGTH, w as ReferralTouch, x as ReferralLinkCollection, y as ReferralClickReplayConflictError, z as ATTRIBUTION_POLICY_STATUSES } from "./chunks/referrals-CrFDsdq-.js";
 export { ATTRIBUTION_CONFLICT_BEHAVIORS, ATTRIBUTION_CREDIT_MODES, ATTRIBUTION_EXCEPTION_STATUSES, ATTRIBUTION_POLICY_STATUSES, ATTRIBUTION_RESOLUTION_MODES, AttributionException, AttributionExceptionCollection, AttributionPolicy, AttributionPolicyCollection, AttributionService, DEFAULT_REFERRAL_CLICK_EVIDENCE_MAX_BYTES, MAX_CODE_GENERATION_ATTEMPTS, MAX_REFERRAL_CLICK_IDEMPOTENCY_KEY_BYTES, QualifiedReferralOverrideError, REFERRAL_AGREEMENT_APPROVAL_MODES, REFERRAL_AGREEMENT_SOURCE_KIND, REFERRAL_AGREEMENT_STATUSES, REFERRAL_CODE_ALPHABET, REFERRAL_CODE_LENGTH, REFERRAL_LINK_STATUSES, REFERRAL_PROGRAM_STATUSES, REFERRAL_STATUSES, REFERRAL_TERMS_SNAPSHOT_KIND, REFERRAL_TOUCH_KINDS, REFERRER_STATUSES, Referral, ReferralAgreement, ReferralAgreementCollection, ReferralAgreementExecutionService, ReferralClickOperation, ReferralClickOperationCollection, ReferralClickReplayConflictError, ReferralClickValidationError, ReferralCollection, ReferralCommissionService, ReferralLink, ReferralLinkCollection, ReferralProgram, ReferralProgramCollection, ReferralQualificationService, ReferralTermSnapshot, ReferralTermSnapshotCollection, ReferralTouch, ReferralTouchCollection, Referrer, ReferrerCollection, assertHttpTargetUrl, generateReferralCode, validateAttributionPolicyTerms };