@happyvertical/smrt-sales 0.57.34 → 0.57.35

package/dist/chunks/{referrals-BPEaXqCz.js → referrals-o8qZG5fw.js}

@@ -1,5 +1,5 @@
-import { W as CommissionCollection, i as CommissionCalculationService, v as CommissionPlanCollection } from "./commissions-nMBMa0DT.js";
-import { SmrtCollection, SmrtObject, crossPackageRef, field, foreignKey, smrt } from "@happyvertical/smrt-core";
+import { D as CommissionPayout, G as Commission, O as Earner, W as CommissionCollection, i as CommissionCalculationService, v as CommissionPlanCollection } from "./commissions-DSVGf1ZX.js";
+import { SmrtCollection, SmrtObject, SmrtRecipe, crossPackageRef, field, foreignKey, smrt } from "@happyvertical/smrt-core";
 import { TenantScoped, requireTenantId, tenantId } from "@happyvertical/smrt-tenancy";
 import { createHash, randomBytes, randomUUID } from "node:crypto";
 //#region src/referrals/models/AttributionException.ts
@@ -1111,10 +1111,6 @@ var Referral = class extends SmrtObject {
 	policyKey = "";
 	/** AttributionPolicy version resolved at attribution (0 until attributed). */
 	policyVersion = 0;
-	/**
-	* Lifecycle status — see the module transition map. Mutate via the
-	* transition methods; the save-time guard rejects illegal edges.
-	*/
 	status = "pending";
 	/**
 	* Generic qualifying target: what the introduction became/points at —
@@ -1291,8 +1287,9 @@ var Referral = class extends SmrtObject {
 };
 __publicField$5(Referral, "__smrtPackage__", "@happyvertical/smrt-sales");
 __decorateClass$5([tenantId({ nullable: true })], Referral.prototype, "tenantId", 2);
-__decorateClass$5([foreignKey("Referrer", { required: true })], Referral.prototype, "referrerId", 2);
-__decorateClass$5([foreignKey("ReferralProgram", { required: true })], Referral.prototype, "programId", 2);
+__decorateClass$5([field({ description: "The affiliate who sent this person." }), foreignKey("Referrer", { required: true })], Referral.prototype, "referrerId", 2);
+__decorateClass$5([field({ description: "The program this referral counts towards." }), foreignKey("ReferralProgram", { required: true })], Referral.prototype, "programId", 2);
+__decorateClass$5([field({ description: "Whether the referral is waiting, has led to a sale or has lapsed." })], Referral.prototype, "status", 2);
 __decorateClass$5([foreignKey("ReferralTouch")], Referral.prototype, "primaryTouchId", 2);
 Referral = __decorateClass$5([TenantScoped({ mode: "optional" }), smrt({
 	api: { include: [
@@ -2087,13 +2084,7 @@ var __publicField$2 = (obj, key, value) => __defNormalProp$2(obj, typeof key !==
 var ReferralProgram = class extends SmrtObject {
 	tenantId = null;
 	key = "";
-	/** Human-readable program name. */
 	name = "";
-	/**
-	* Program lifecycle: `draft` (default) → `active` → `paused` /
-	* `archived`. Applications gate intake on `active`; this module records
-	* the status without enforcing transition edges.
-	*/
 	status = "draft";
 	/**
 	* Default commissions-plan key suggested to new ReferralAgreements.
@@ -2141,7 +2132,12 @@ var ReferralProgram = class extends SmrtObject {
 };
 __publicField$2(ReferralProgram, "__smrtPackage__", "@happyvertical/smrt-sales");
 __decorateClass$2([tenantId({ nullable: true })], ReferralProgram.prototype, "tenantId", 2);
-__decorateClass$2([field({ required: true })], ReferralProgram.prototype, "key", 2);
+__decorateClass$2([field({
+	required: true,
+	description: "A short name for the program, used in links and reports."
+})], ReferralProgram.prototype, "key", 2);
+__decorateClass$2([field({ description: "What you call this program." })], ReferralProgram.prototype, "name", 2);
+__decorateClass$2([field({ description: "Whether the program is in draft, running or finished." })], ReferralProgram.prototype, "status", 2);
 ReferralProgram = __decorateClass$2([TenantScoped({ mode: "optional" }), smrt({
 	conflictColumns: ["tenant_id", "key"],
 	api: { include: [
@@ -2356,12 +2352,7 @@ var Referrer = class extends SmrtObject {
 	tenantId = null;
 	profileId = "";
 	earnerId = "";
-	/** Human-readable display name for portals and operator views. */
 	displayName = "";
-	/**
-	* Role lifecycle: `pending` (default, awaiting approval) → `active` /
-	* `suspended`. Only active referrers should receive new links/agreements.
-	*/
 	status = "pending";
 	/**
 	* Free-form JSON object stored as a string. Use
@@ -2406,6 +2397,8 @@ __publicField(Referrer, "__smrtPackage__", "@happyvertical/smrt-sales");
 __decorateClass([tenantId({ nullable: true })], Referrer.prototype, "tenantId", 2);
 __decorateClass([crossPackageRef("@happyvertical/smrt-profiles:Profile")], Referrer.prototype, "profileId", 2);
 __decorateClass([foreignKey("Earner")], Referrer.prototype, "earnerId", 2);
+__decorateClass([field({ description: "The name you know this affiliate by." })], Referrer.prototype, "displayName", 2);
+__decorateClass([field({ description: "Whether this affiliate is approved to send you referrals." })], Referrer.prototype, "status", 2);
 Referrer = __decorateClass([TenantScoped({ mode: "optional" }), smrt({
 	api: { include: [
 		"list",
@@ -2447,6 +2440,204 @@ var ReferrerCollection = class extends SmrtCollection {
 	}
 };
 //#endregion
+//#region src/referrals/recipes.ts
+var AffiliatesReferralsRecipe = class extends SmrtRecipe {
+	static id = "affiliates.referrals";
+	static help = "./referrals.recipe.md";
+	static label = "Affiliates";
+	static summary = "Reward partners for the customers they send you, and pay them what they earn.";
+	static synonyms = [
+		"referrals",
+		"referral program",
+		"partners",
+		"commissions",
+		"payouts",
+		"refer a friend"
+	];
+	static section = {
+		id: "grow",
+		label: "Grow",
+		icon: "tag",
+		description: "Bring in new customers and reward the people who help."
+	};
+	static models = [
+		Referrer,
+		ReferralProgram,
+		Referral,
+		Earner,
+		Commission,
+		CommissionPayout
+	];
+	static nav = [
+		{
+			label: "Affiliates",
+			model: Referrer,
+			icon: "users",
+			description: "The partners and customers who send people your way.",
+			noun: "affiliate"
+		},
+		{
+			label: "Programs",
+			model: ReferralProgram,
+			icon: "layers",
+			description: "The offers that decide what a referral earns.",
+			noun: "program"
+		},
+		{
+			label: "Referrals",
+			model: Referral,
+			icon: "repeat",
+			description: "Each person sent to you, and whether it led to a sale."
+		},
+		{
+			label: "Commissions",
+			model: Commission,
+			icon: "receipt",
+			description: "What each affiliate has earned and where it stands."
+		},
+		{
+			label: "Payouts",
+			model: CommissionPayout,
+			icon: "bank",
+			description: "Payments made to affiliates for what they earned."
+		}
+	];
+	static options = {
+		Referrer: { fields: {
+			displayName: {
+				label: "Name",
+				order: 1
+			},
+			status: { order: 2 },
+			profileId: {
+				label: "Person",
+				visibility: "advanced"
+			},
+			tenantId: { visibility: "hidden" },
+			earnerId: {
+				label: "Payee",
+				visibility: "advanced"
+			},
+			metadata: { visibility: "hidden" }
+		} },
+		ReferralProgram: { fields: {
+			name: { order: 1 },
+			key: {
+				label: "Short name",
+				order: 2
+			},
+			status: { order: 3 },
+			defaultCommissionPlanKey: { visibility: "advanced" },
+			defaultAttributionPolicyKey: { visibility: "advanced" },
+			tenantId: { visibility: "hidden" },
+			metadata: { visibility: "hidden" }
+		} },
+		Referral: { fields: {
+			referrerId: {
+				label: "Affiliate",
+				order: 1
+			},
+			programId: {
+				label: "Program",
+				order: 2
+			},
+			status: { order: 3 },
+			tenantId: { visibility: "hidden" },
+			policyKey: { visibility: "hidden" },
+			policyVersion: { visibility: "hidden" },
+			targetKind: { visibility: "advanced" },
+			targetId: { visibility: "advanced" },
+			creditFraction: { visibility: "advanced" },
+			splitGroupId: { visibility: "hidden" },
+			primaryTouchId: { visibility: "hidden" },
+			attributedAt: { visibility: "advanced" },
+			qualifiedAt: { visibility: "advanced" },
+			expiresAt: { visibility: "advanced" },
+			snapshotId: { visibility: "hidden" },
+			metadata: { visibility: "hidden" }
+		} },
+		Earner: { fields: {
+			displayName: {
+				label: "Name",
+				order: 1
+			},
+			status: { order: 2 },
+			tenantId: { visibility: "hidden" },
+			kind: { visibility: "advanced" },
+			profileId: { visibility: "advanced" },
+			payoutMethod: { visibility: "advanced" },
+			payoutDestination: { visibility: "advanced" },
+			payoutThresholdCents: { visibility: "advanced" },
+			payoutScheduleKey: { visibility: "advanced" },
+			currency: { visibility: "advanced" },
+			metadata: { visibility: "hidden" }
+		} },
+		Commission: { fields: {
+			earnerId: {
+				label: "Affiliate",
+				order: 1
+			},
+			amountCents: {
+				label: "Amount",
+				order: 2
+			},
+			currency: { order: 3 },
+			status: { order: 4 },
+			tenantId: { visibility: "hidden" },
+			earningEventId: { visibility: "hidden" },
+			planKey: { visibility: "advanced" },
+			planVersion: { visibility: "hidden" },
+			componentKey: { visibility: "hidden" },
+			termsSnapshotKind: { visibility: "hidden" },
+			termsSnapshotId: { visibility: "hidden" },
+			basis: { visibility: "advanced" },
+			baseAmountCents: { visibility: "advanced" },
+			rate: { visibility: "advanced" },
+			shareFraction: { visibility: "hidden" },
+			splitGroupId: { visibility: "hidden" },
+			clearingEndsAt: { visibility: "advanced" },
+			earnedAt: { visibility: "advanced" },
+			approvedAt: { visibility: "advanced" },
+			payableAt: { visibility: "advanced" },
+			paidAt: { visibility: "advanced" },
+			payoutId: { visibility: "advanced" },
+			sourceKind: { visibility: "hidden" },
+			sourceId: { visibility: "hidden" },
+			calculationTrace: { visibility: "hidden" },
+			dedupeKey: { visibility: "hidden" },
+			metadata: { visibility: "hidden" }
+		} },
+		CommissionPayout: { fields: {
+			earnerId: {
+				label: "Affiliate",
+				order: 1
+			},
+			totalAmountCents: {
+				label: "Total",
+				order: 2
+			},
+			currency: { order: 3 },
+			status: { order: 4 },
+			paidAt: { order: 5 },
+			tenantId: { visibility: "hidden" },
+			periodStart: { visibility: "advanced" },
+			periodEnd: { visibility: "advanced" },
+			commissionTotalCents: { visibility: "advanced" },
+			adjustmentTotalCents: { visibility: "advanced" },
+			payoutMethod: { visibility: "advanced" },
+			payoutDestination: { visibility: "advanced" },
+			paymentReference: { visibility: "advanced" },
+			providerRef: { visibility: "hidden" },
+			invoiceId: { visibility: "hidden" },
+			notes: { visibility: "advanced" },
+			idempotencyKey: { visibility: "hidden" },
+			sourceKind: { visibility: "hidden" },
+			sourceId: { visibility: "hidden" },
+			metadata: { visibility: "hidden" }
+		} }
+	};
+};
+//#endregion
 //#region src/referrals/services/AttributionService.ts
 var MS_PER_DAY = 1440 * 60 * 1e3;
 var QualifiedReferralOverrideError = class extends Error {
@@ -3503,6 +3694,6 @@ var ReferralQualificationService = class ReferralQualificationService {
 	}
 };
 //#endregion
-export { ReferralClickOperation as A, ATTRIBUTION_RESOLUTION_MODES as B, ReferralTouchCollection as C, ReferralCollection as D, assertHttpTargetUrl as E, validateAttributionPolicyTerms as F, REFERRAL_STATUSES as G, REFERRAL_AGREEMENT_STATUSES as H, ATTRIBUTION_CONFLICT_BEHAVIORS as I, AttributionExceptionCollection as J, REFERRAL_TOUCH_KINDS as K, ATTRIBUTION_CREDIT_MODES as L, ReferralAgreement as M, AttributionPolicyCollection as N, Referral as O, AttributionPolicy as P, ATTRIBUTION_EXCEPTION_STATUSES as R, generateReferralCode as S, ReferralLink as T, REFERRAL_LINK_STATUSES as U, REFERRAL_AGREEMENT_APPROVAL_MODES as V, REFERRAL_PROGRAM_STATUSES as W, AttributionException as Y, REFERRAL_CODE_ALPHABET as _, ReferralAgreementExecutionService as a, ReferralClickValidationError as b, ReferrerCollection as c, ReferralTermSnapshot as d, ReferralProgramCollection as f, MAX_REFERRAL_CLICK_IDEMPOTENCY_KEY_BYTES as g, MAX_CODE_GENERATION_ATTEMPTS as h, REFERRAL_AGREEMENT_SOURCE_KIND as i, ReferralAgreementCollection as j, ReferralClickOperationCollection as k, Referrer as l, DEFAULT_REFERRAL_CLICK_EVIDENCE_MAX_BYTES as m, REFERRAL_TERMS_SNAPSHOT_KIND as n, AttributionService as o, ReferralProgram as p, REFERRER_STATUSES as q, ReferralCommissionService as r, QualifiedReferralOverrideError as s, ReferralQualificationService as t, ReferralTermSnapshotCollection as u, REFERRAL_CODE_LENGTH as v, ReferralTouch as w, ReferralLinkCollection as x, ReferralClickReplayConflictError as y, ATTRIBUTION_POLICY_STATUSES as z };
+export { ReferralClickOperationCollection as A, ATTRIBUTION_POLICY_STATUSES as B, generateReferralCode as C, assertHttpTargetUrl as D, ReferralLink as E, AttributionPolicy as F, REFERRAL_PROGRAM_STATUSES as G, REFERRAL_AGREEMENT_APPROVAL_MODES as H, validateAttributionPolicyTerms as I, REFERRER_STATUSES as J, REFERRAL_STATUSES as K, ATTRIBUTION_CONFLICT_BEHAVIORS as L, ReferralAgreementCollection as M, ReferralAgreement as N, ReferralCollection as O, AttributionPolicyCollection as P, ATTRIBUTION_CREDIT_MODES as R, ReferralLinkCollection as S, ReferralTouch as T, REFERRAL_AGREEMENT_STATUSES as U, ATTRIBUTION_RESOLUTION_MODES as V, REFERRAL_LINK_STATUSES as W, AttributionException as X, AttributionExceptionCollection as Y, MAX_REFERRAL_CLICK_IDEMPOTENCY_KEY_BYTES as _, ReferralAgreementExecutionService as a, ReferralClickReplayConflictError as b, AffiliatesReferralsRecipe as c, ReferralTermSnapshotCollection as d, ReferralTermSnapshot as f, MAX_CODE_GENERATION_ATTEMPTS as g, DEFAULT_REFERRAL_CLICK_EVIDENCE_MAX_BYTES as h, REFERRAL_AGREEMENT_SOURCE_KIND as i, ReferralClickOperation as j, Referral as k, ReferrerCollection as l, ReferralProgram as m, REFERRAL_TERMS_SNAPSHOT_KIND as n, AttributionService as o, ReferralProgramCollection as p, REFERRAL_TOUCH_KINDS as q, ReferralCommissionService as r, QualifiedReferralOverrideError as s, ReferralQualificationService as t, Referrer as u, REFERRAL_CODE_ALPHABET as v, ReferralTouchCollection as w, ReferralClickValidationError as x, REFERRAL_CODE_LENGTH as y, ATTRIBUTION_EXCEPTION_STATUSES as z };
 
-//# sourceMappingURL=referrals-BPEaXqCz.js.map
+//# sourceMappingURL=referrals-o8qZG5fw.js.map