@happyvertical/smrt-sales 0.55.7 → 0.55.8

package/dist/chunks/{crm-B-irXbbr.js → crm-DaUkdNoG.js}

@@ -1,4 +1,4 @@
-import { SmrtCollection, SmrtObject, crossPackageRef, field, foreignKey, smrt } from "@happyvertical/smrt-core";
+import { SmrtCollection, SmrtObject, SmrtRecipe, crossPackageRef, field, foreignKey, smrt } from "@happyvertical/smrt-core";
 import { TenantContextError, TenantScoped, getTenantId, requireTenantId, tenantId } from "@happyvertical/smrt-tenancy";
 import { createHash } from "node:crypto";
 //#region src/crm/models/Lead.ts
@@ -37,17 +37,12 @@ var loadedLeadStatus = /* @__PURE__ */ new WeakMap();
 var Lead = class extends SmrtObject {
 	tenantId = null;
 	name = "";
-	/** Primary human contact name. */
 	contactName = "";
-	/** Primary contact email. */
 	email = "";
-	/** Primary contact phone. */
 	phone = "";
-	/** Prospect organization/company name. */
 	organizationName = "";
 	profileId = "";
 	ownerRepId = "";
-	/** Lifecycle status; transitions are save-guarded (see module map). */
 	status = "new";
 	/**
 	* Generic acquisition-source kind (open string): `'campaign'`,
@@ -189,9 +184,17 @@ var Lead = class extends SmrtObject {
 };
 __publicField$6(Lead, "__smrtPackage__", "@happyvertical/smrt-sales");
 __decorateClass$6([tenantId({ nullable: true })], Lead.prototype, "tenantId", 2);
-__decorateClass$6([field({ required: true })], Lead.prototype, "name", 2);
+__decorateClass$6([field({
+	required: true,
+	description: "What you call this lead."
+})], Lead.prototype, "name", 2);
+__decorateClass$6([field({ description: "The person to talk to." })], Lead.prototype, "contactName", 2);
+__decorateClass$6([field({ description: "Their email address." })], Lead.prototype, "email", 2);
+__decorateClass$6([field({ description: "Their phone number." })], Lead.prototype, "phone", 2);
+__decorateClass$6([field({ description: "The company they are with." })], Lead.prototype, "organizationName", 2);
 __decorateClass$6([crossPackageRef("@happyvertical/smrt-profiles:Profile")], Lead.prototype, "profileId", 2);
-__decorateClass$6([foreignKey("SalesRepresentative")], Lead.prototype, "ownerRepId", 2);
+__decorateClass$6([field({ description: "The sales representative who owns this lead." }), foreignKey("SalesRepresentative")], Lead.prototype, "ownerRepId", 2);
+__decorateClass$6([field({ description: "Where the lead stands, for example new or qualified." })], Lead.prototype, "status", 2);
 __decorateClass$6([foreignKey("Lead")], Lead.prototype, "mergedIntoId", 2);
 Lead = __decorateClass$6([TenantScoped({ mode: "optional" }), smrt({
 	api: { include: [
@@ -352,18 +355,10 @@ var Opportunity = class extends SmrtObject {
 	ownerRepId = "";
 	pipelineId = "";
 	stageId = "";
-	/** Expected deal value in integer cents (INTEGER column). */
 	expectedValueCents = 0;
-	/** ISO 4217 currency code for `expectedValueCents`. */
 	currency = "USD";
-	/**
-	* Win probability (`0`–`1`, DECIMAL). Adopted from the current stage's
-	* default on stage moves unless explicitly overridden.
-	*/
 	probability = 0;
-	/** Forecasted close date. */
 	expectedCloseAt = null;
-	/** Lifecycle status; `open → won|lost` is save-guarded, terminal after. */
 	status = "open";
 	/**
 	* Human-readable outcome note — conventionally the loss reason
@@ -476,11 +471,19 @@ var Opportunity = class extends SmrtObject {
 };
 __publicField$5(Opportunity, "__smrtPackage__", "@happyvertical/smrt-sales");
 __decorateClass$5([tenantId({ nullable: true })], Opportunity.prototype, "tenantId", 2);
-__decorateClass$5([field({ required: true })], Opportunity.prototype, "name", 2);
-__decorateClass$5([foreignKey("Lead")], Opportunity.prototype, "leadId", 2);
-__decorateClass$5([foreignKey("SalesRepresentative")], Opportunity.prototype, "ownerRepId", 2);
-__decorateClass$5([foreignKey("PipelineDefinition")], Opportunity.prototype, "pipelineId", 2);
-__decorateClass$5([foreignKey("PipelineStage")], Opportunity.prototype, "stageId", 2);
+__decorateClass$5([field({
+	required: true,
+	description: "What you call this deal."
+})], Opportunity.prototype, "name", 2);
+__decorateClass$5([field({ description: "The lead it came from." }), foreignKey("Lead")], Opportunity.prototype, "leadId", 2);
+__decorateClass$5([field({ description: "The sales representative who owns this deal." }), foreignKey("SalesRepresentative")], Opportunity.prototype, "ownerRepId", 2);
+__decorateClass$5([field({ description: "The pipeline it moves through." }), foreignKey("PipelineDefinition")], Opportunity.prototype, "pipelineId", 2);
+__decorateClass$5([field({ description: "The stage it is at now." }), foreignKey("PipelineStage")], Opportunity.prototype, "stageId", 2);
+__decorateClass$5([field({ description: "What you expect the deal to be worth, in cents." })], Opportunity.prototype, "expectedValueCents", 2);
+__decorateClass$5([field({ description: "The currency of that value." })], Opportunity.prototype, "currency", 2);
+__decorateClass$5([field({ description: "How likely it is to close, as a decimal (0.5 is 50%)." })], Opportunity.prototype, "probability", 2);
+__decorateClass$5([field({ description: "When you expect it to close." })], Opportunity.prototype, "expectedCloseAt", 2);
+__decorateClass$5([field({ description: "open, won or lost." })], Opportunity.prototype, "status", 2);
 Opportunity = __decorateClass$5([TenantScoped({ mode: "optional" }), smrt({
 	api: { include: [
 		"list",
@@ -512,18 +515,10 @@ var PipelineStage = class extends SmrtObject {
 	tenantId = null;
 	pipelineId = "";
 	key = "";
-	/** Human-readable stage name shown on board columns. */
 	name = "";
-	/** Ordering within the pipeline (ascending). Seeded in steps of 10. */
 	sortOrder = 0;
-	/**
-	* Default win probability (`0`–`1`, DECIMAL) adopted by an opportunity
-	* entering this stage unless the move overrides it.
-	*/
 	probability = 0;
-	/** Terminal flag: moving an opportunity here closes it as `won`. */
 	isWon = false;
-	/** Terminal flag: moving an opportunity here closes it as `lost`. */
 	isLost = false;
 	/**
 	* Free-form JSON object stored as a string. Use
@@ -563,8 +558,16 @@ var PipelineStage = class extends SmrtObject {
 };
 __publicField$4(PipelineStage, "__smrtPackage__", "@happyvertical/smrt-sales");
 __decorateClass$4([tenantId({ nullable: true })], PipelineStage.prototype, "tenantId", 2);
-__decorateClass$4([foreignKey("PipelineDefinition", { required: true })], PipelineStage.prototype, "pipelineId", 2);
-__decorateClass$4([field({ required: true })], PipelineStage.prototype, "key", 2);
+__decorateClass$4([field({ description: "The pipeline this stage belongs to." }), foreignKey("PipelineDefinition", { required: true })], PipelineStage.prototype, "pipelineId", 2);
+__decorateClass$4([field({
+	required: true,
+	description: "A short code for the stage."
+})], PipelineStage.prototype, "key", 2);
+__decorateClass$4([field({ description: "What the stage is called." })], PipelineStage.prototype, "name", 2);
+__decorateClass$4([field({ description: "Where it comes in the pipeline." })], PipelineStage.prototype, "sortOrder", 2);
+__decorateClass$4([field({ description: "How likely a deal at this stage is to close, as a decimal." })], PipelineStage.prototype, "probability", 2);
+__decorateClass$4([field({ description: "Whether reaching this stage closes the deal as won." })], PipelineStage.prototype, "isWon", 2);
+__decorateClass$4([field({ description: "Whether reaching this stage closes the deal as lost." })], PipelineStage.prototype, "isLost", 2);
 PipelineStage = __decorateClass$4([TenantScoped({ mode: "optional" }), smrt({
 	api: { include: [
 		"list",
@@ -632,21 +635,11 @@ function permitSalesActivityWorkflowCompletion(activity) {
 }
 var SalesActivity = class extends SmrtObject {
 	tenantId = null;
-	/** Which model the activity attaches to: `'lead'` or `'opportunity'`. */
 	subjectKind = "lead";
 	subjectId = "";
-	/**
-	* Kind of activity — OPEN string so consumers can extend the vocabulary
-	* without schema changes. See `SALES_ACTIVITY_KINDS` for the recommended
-	* kinds (framework-written rows use `qualification`, `stage_change`,
-	* `merge`).
-	*/
 	activityKind = "note";
-	/** One-line human-readable description. */
 	summary = "";
-	/** Next-action due date — set for `task`-like activities. */
 	dueAt = null;
-	/** When the next action was completed; `null` while open. */
 	completedAt = null;
 	actorProfileId = "";
 	/**
@@ -722,7 +715,15 @@ var SalesActivity = class extends SmrtObject {
 };
 __publicField$3(SalesActivity, "__smrtPackage__", "@happyvertical/smrt-sales");
 __decorateClass$3([tenantId({ nullable: true })], SalesActivity.prototype, "tenantId", 2);
-__decorateClass$3([field({ required: true })], SalesActivity.prototype, "subjectId", 2);
+__decorateClass$3([field({ description: "What the activity is about: a lead or an opportunity." })], SalesActivity.prototype, "subjectKind", 2);
+__decorateClass$3([field({
+	required: true,
+	description: "The lead or opportunity it is about."
+})], SalesActivity.prototype, "subjectId", 2);
+__decorateClass$3([field({ description: "The kind of activity, for example call, note or email." })], SalesActivity.prototype, "activityKind", 2);
+__decorateClass$3([field({ description: "What happened or what needs doing." })], SalesActivity.prototype, "summary", 2);
+__decorateClass$3([field({ description: "When it is due." })], SalesActivity.prototype, "dueAt", 2);
+__decorateClass$3([field({ description: "When it was done." })], SalesActivity.prototype, "completedAt", 2);
 __decorateClass$3([crossPackageRef("@happyvertical/smrt-profiles:Profile")], SalesActivity.prototype, "actorProfileId", 2);
 SalesActivity = __decorateClass$3([TenantScoped({ mode: "optional" }), smrt({
 	api: { include: [
@@ -904,19 +905,9 @@ var __publicField$2 = (obj, key, value) => __defNormalProp$2(obj, typeof key !==
 var PipelineDefinition = class extends SmrtObject {
 	tenantId = null;
 	key = "";
-	/** Human-readable pipeline name shown on CRM surfaces. */
 	name = "";
-	/**
-	* Marks the tenant's default pipeline. Informational for pickers/UI; the
-	* seeded default pipeline sets it `true`.
-	*/
 	isDefault = false;
-	/** `active` pipelines accept new opportunities; `archived` are read-only history. */
 	status = "active";
-	/**
-	* Free-form JSON object stored as a string. Use
-	* {@link getMetadata}/{@link setMetadata} instead of parsing manually.
-	*/
 	metadata = "{}";
 	constructor(options = {}) {
 		super(options);
@@ -948,7 +939,14 @@ var PipelineDefinition = class extends SmrtObject {
 };
 __publicField$2(PipelineDefinition, "__smrtPackage__", "@happyvertical/smrt-sales");
 __decorateClass$2([tenantId({ nullable: true })], PipelineDefinition.prototype, "tenantId", 2);
-__decorateClass$2([field({ required: true })], PipelineDefinition.prototype, "key", 2);
+__decorateClass$2([field({
+	required: true,
+	description: "A short code for the pipeline."
+})], PipelineDefinition.prototype, "key", 2);
+__decorateClass$2([field({ description: "What the pipeline is called." })], PipelineDefinition.prototype, "name", 2);
+__decorateClass$2([field({ description: "Whether this is the default pipeline for new deals." })], PipelineDefinition.prototype, "isDefault", 2);
+__decorateClass$2([field({ description: "Whether the pipeline is active (accepts new deals) or archived." })], PipelineDefinition.prototype, "status", 2);
+__decorateClass$2([field({ description: "Extra details kept with the pipeline." })], PipelineDefinition.prototype, "metadata", 2);
 PipelineDefinition = __decorateClass$2([TenantScoped({ mode: "optional" }), smrt({
 	api: { include: [
 		"list",
@@ -1771,6 +1769,79 @@ var OpportunityConversionCollection = class extends SmrtCollection {
 	}
 };
 //#endregion
+//#region src/crm/recipes.ts
+var SalesPipelineRecipe = class extends SmrtRecipe {
+	static id = "sales.pipeline";
+	static help = "./pipeline.recipe.md";
+	static label = "Leads & pipeline";
+	static summary = "Capture leads and move them through your sales stages.";
+	static synonyms = [
+		"crm",
+		"prospects",
+		"opportunities",
+		"deals",
+		"funnel"
+	];
+	static section = {
+		id: "sales",
+		label: "Sales",
+		icon: "shoppingBag",
+		description: "Customers, orders and quotes: everything you sell."
+	};
+	static models = [
+		Lead,
+		Opportunity,
+		PipelineDefinition,
+		PipelineStage,
+		SalesActivity
+	];
+	static nav = [
+		{
+			label: "Leads",
+			model: Lead,
+			icon: "users",
+			description: "People who might become customers, and where each one stands."
+		},
+		{
+			label: "Opportunities",
+			model: Opportunity,
+			icon: "briefcase",
+			description: "Deals in progress, with their value and next step."
+		},
+		{
+			label: "Pipelines",
+			model: PipelineDefinition,
+			icon: "layers",
+			description: "The stages a deal moves through on its way to a sale."
+		}
+	];
+	static options = {
+		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" }
+		} },
+		Opportunity: { fields: {
+			sourceKind: { visibility: "hidden" },
+			sourceId: { visibility: "hidden" },
+			metadata: { visibility: "hidden" },
+			outcomeReason: { visibility: "hidden" },
+			wonAt: { visibility: "hidden" },
+			lostAt: { visibility: "hidden" }
+		} },
+		PipelineStage: { fields: { metadata: { visibility: "hidden" } } },
+		SalesActivity: { fields: {
+			metadata: { visibility: "hidden" },
+			actorProfileId: { visibility: "hidden" }
+		} }
+	};
+};
+//#endregion
 //#region src/crm/services/LeadWorkflowService.ts
 var LEAD_HUMAN_ACTIVITY_KINDS = [
 	"note",
@@ -2607,6 +2678,6 @@ function uuidFromHash(hash) {
 	return `${value.slice(0, 8)}-${value.slice(8, 12)}-${value.slice(12, 16)}-${value.slice(16, 20)}-${value.slice(20)}`;
 }
 //#endregion
-export { PIPELINE_STATUSES as C, Lead as D, SALES_REPRESENTATIVE_STATUSES as E, OPPORTUNITY_STATUSES as S, SALES_ACTIVITY_SUBJECT_KINDS as T, PipelineStage as _, projectLeadWorkQueue as a, DEFAULT_PIPELINE_STAGES as b, LeadCollection as c, PipelineDefinitionCollection as d, PipelineDefinition as f, PipelineStageCollection as g, SalesActivity as h, MAX_LEAD_WORKFLOW_TEXT_LENGTH as i, SalesRepresentativeCollection as l, SalesActivityCollection as m, LeadWorkflowService as n, OpportunityConversionCollection as o, OpportunityCollection as p, LeadWorkflowValidationError as r, OpportunityConversion as s, LEAD_HUMAN_ACTIVITY_KINDS as t, SalesRepresentative as u, Opportunity as v, SALES_ACTIVITY_KINDS as w, LEAD_STATUSES as x, DEFAULT_PIPELINE_KEY as y };
+export { OPPORTUNITY_STATUSES as C, SALES_REPRESENTATIVE_STATUSES as D, SALES_ACTIVITY_SUBJECT_KINDS as E, Lead as O, LEAD_STATUSES as S, SALES_ACTIVITY_KINDS as T, PipelineStageCollection as _, projectLeadWorkQueue as a, DEFAULT_PIPELINE_KEY as b, OpportunityConversion as c, SalesRepresentative as d, PipelineDefinitionCollection as f, SalesActivity as g, SalesActivityCollection as h, MAX_LEAD_WORKFLOW_TEXT_LENGTH as i, LeadCollection as l, OpportunityCollection as m, LeadWorkflowService as n, SalesPipelineRecipe as o, PipelineDefinition as p, LeadWorkflowValidationError as r, OpportunityConversionCollection as s, LEAD_HUMAN_ACTIVITY_KINDS as t, SalesRepresentativeCollection as u, PipelineStage as v, PIPELINE_STATUSES as w, DEFAULT_PIPELINE_STAGES as x, Opportunity as y };
 
-//# sourceMappingURL=crm-B-irXbbr.js.map
+//# sourceMappingURL=crm-DaUkdNoG.js.map