@happyvertical/smrt-sales 0.57.34 → 0.57.36

package/dist/chunks/{commissions-nMBMa0DT.js → commissions-DSVGf1ZX.js}

@@ -337,15 +337,8 @@ var Commission = class extends SmrtObject {
 	* event/component carries the same `splitGroupId`. Empty for unsplit rows.
 	*/
 	splitGroupId = "";
-	/** The earned amount in integer cents. */
 	amountCents = 0;
-	/** ISO 4217 currency (copied from the earning event). */
 	currency = "USD";
-	/**
-	* Lifecycle status — strict chain `pending → earned → approved → payable
-	* → paid`. Mutate via the transition methods; the save-time guard rejects
-	* illegal edges.
-	*/
 	status = "pending";
 	/**
 	* End of the clearing window (refund/chargeback holdback). `null` means
@@ -564,10 +557,16 @@ var Commission = class extends SmrtObject {
 };
 __publicField$5(Commission, "__smrtPackage__", "@happyvertical/smrt-sales");
 __decorateClass$5([tenantId({ nullable: true })], Commission.prototype, "tenantId", 2);
-__decorateClass$5([foreignKey("Earner", { required: true })], Commission.prototype, "earnerId", 2);
+__decorateClass$5([field({ description: "The affiliate who earned this commission." }), foreignKey("Earner", { required: true })], Commission.prototype, "earnerId", 2);
 __decorateClass$5([foreignKey("EarningEvent")], Commission.prototype, "earningEventId", 2);
+__decorateClass$5([field({ description: "How much was earned, in the smallest unit of the currency." })], Commission.prototype, "amountCents", 2);
+__decorateClass$5([field({ description: "The currency the commission is paid in." })], Commission.prototype, "currency", 2);
+__decorateClass$5([field({ description: "Where the commission stands, from pending to paid." })], Commission.prototype, "status", 2);
 __decorateClass$5([foreignKey("CommissionPayout")], Commission.prototype, "payoutId", 2);
-__decorateClass$5([field({ required: true })], Commission.prototype, "dedupeKey", 2);
+__decorateClass$5([field({
+	required: true,
+	description: "A reference that stops the same commission being recorded twice."
+})], Commission.prototype, "dedupeKey", 2);
 Commission = __decorateClass$5([TenantScoped({ mode: "optional" }), smrt({
 	conflictColumns: ["dedupe_key"],
 	api: { include: [
@@ -826,9 +825,7 @@ var Earner = class extends SmrtObject {
 	*/
 	kind = "person";
 	profileId = "";
-	/** Human-readable display name for portals and operator views. */
 	displayName = "";
-	/** Account lifecycle: `pending` (default) → `active` / `suspended`. */
 	status = "pending";
 	/** Preferred payout delivery method. */
 	payoutMethod = "bank_transfer";
@@ -952,6 +949,8 @@ var Earner = class extends SmrtObject {
 __publicField$4(Earner, "__smrtPackage__", "@happyvertical/smrt-sales");
 __decorateClass$4([tenantId({ nullable: true })], Earner.prototype, "tenantId", 2);
 __decorateClass$4([crossPackageRef("@happyvertical/smrt-profiles:Profile")], Earner.prototype, "profileId", 2);
+__decorateClass$4([field({ description: "The name this payee is paid under." })], Earner.prototype, "displayName", 2);
+__decorateClass$4([field({ description: "Whether this payee can be paid." })], Earner.prototype, "status", 2);
 Earner = __decorateClass$4([TenantScoped({ mode: "optional" }), smrt({
 	api: { include: [
 		"list",
@@ -1010,12 +1009,7 @@ var CommissionPayout = class extends SmrtObject {
 	* cents; clawbacks make it negative).
 	*/
 	adjustmentTotalCents = 0;
-	/**
-	* Net amount remitted — must equal
-	* `commissionTotalCents + adjustmentTotalCents` (enforced on save).
-	*/
 	totalAmountCents = 0;
-	/** ISO 4217 currency of the batch. */
 	currency = "USD";
 	/** Delivery method for this batch (defaulted from the Earner). */
 	payoutMethod = "bank_transfer";
@@ -1026,11 +1020,6 @@ var CommissionPayout = class extends SmrtObject {
 	* Legacy/manual methods have no typed descriptor (`{}`).
 	*/
 	payoutDestination = "{}";
-	/**
-	* Lifecycle status — see the class doc. Mutate via {@link approve} /
-	* {@link markProcessing} / {@link complete} / {@link fail} /
-	* {@link resetFromFailed}.
-	*/
 	status = "pending";
 	/**
 	* Payment reference recorded at completion (check number, transfer id,
@@ -1042,7 +1031,6 @@ var CommissionPayout = class extends SmrtObject {
 	* id, …). Retained across failure/reset for audit.
 	*/
 	providerRef = "";
-	/** When the payout completed. */
 	paidAt = null;
 	invoiceId = "";
 	/** Operator notes — approval memos, failure reasons (append-only). */
@@ -1300,9 +1288,16 @@ ${memo}` : memo;
 };
 __publicField$3(CommissionPayout, "__smrtPackage__", "@happyvertical/smrt-sales");
 __decorateClass$3([tenantId({ nullable: true })], CommissionPayout.prototype, "tenantId", 2);
-__decorateClass$3([foreignKey("Earner", { required: true })], CommissionPayout.prototype, "earnerId", 2);
+__decorateClass$3([field({ description: "The affiliate being paid." }), foreignKey("Earner", { required: true })], CommissionPayout.prototype, "earnerId", 2);
+__decorateClass$3([field({ description: "The total being paid, in the smallest unit of the currency." })], CommissionPayout.prototype, "totalAmountCents", 2);
+__decorateClass$3([field({ description: "The currency of the payment." })], CommissionPayout.prototype, "currency", 2);
+__decorateClass$3([field({ description: "Whether the payment is waiting, being sent, completed or failed." })], CommissionPayout.prototype, "status", 2);
+__decorateClass$3([field({ description: "When the payment went out." })], CommissionPayout.prototype, "paidAt", 2);
 __decorateClass$3([crossPackageRef("@happyvertical/smrt-commerce:Invoice")], CommissionPayout.prototype, "invoiceId", 2);
-__decorateClass$3([field({ required: true })], CommissionPayout.prototype, "idempotencyKey", 2);
+__decorateClass$3([field({
+	required: true,
+	description: "A reference that stops the same payout being made twice."
+})], CommissionPayout.prototype, "idempotencyKey", 2);
 __decorateClass$3([field({ indexed: true })], CommissionPayout.prototype, "sourceId", 2);
 CommissionPayout = __decorateClass$3([TenantScoped({ mode: "optional" }), smrt({
 	conflictColumns: ["idempotency_key"],
@@ -4404,4 +4399,4 @@ var EarnerAttributionService = class EarnerAttributionService {
 //#endregion
 export { ADJUSTMENT_SETTLEABLE_COMMISSION_STATUSES as A, PAYOUT_METHODS as B, calculateWaterfallWithPools as C, CommissionPayout as D, CommissionPayoutCollection as E, COMMISSION_STATUSES as F, Commission as G, WATERFALL_POOL_RESIDUAL_RULES as H, EARNER_KINDS as I, CommissionAdjustmentCollection as J, CommissionAdjustmentOperationCollection as K, EARNER_SOURCE_ATTRIBUTION_STATUSES as L, COMMISSION_BASES as M, COMMISSION_PAYOUT_STATUSES as N, Earner as O, COMMISSION_PLAN_STATUSES as P, EARNER_STATUSES as R, calculateWaterfall as S, validateWaterfallPlan as T, WATERFALL_POOL_ZERO_WEIGHT_RULES as U, PAYOUT_METHODS_REQUIRING_DESTINATION as V, CommissionCollection as W, CommissionAdjustment as Y, EarnerCollection as _, CommissionBalanceService as a, validateCommissionPlanComponents as b, CommissionAdjustmentValidationError as c, centsToAmount as d, roundCents as f, EarnerSourceAttribution as g, EarnerSourceAttributionCollection as h, CommissionCalculationService as i, COMMISSION_ADJUSTMENT_KINDS as j, validatePayoutDestination as k, amountToCents as l, EarningEvent as m, CommissionSettlementService as n, CommissionAdjustmentReplayConflictError as o, EarningEventCollection as p, CommissionAdjustmentOperation as q, CommissionPayoutService as r, CommissionAdjustmentService as s, EarnerAttributionService as t, calculateCommissionAmountCents as u, CommissionPlanCollection as v, prepareWaterfallPools as w, WaterfallRecipientResolverRegistry as x, CommissionPlan as y, EARNING_EVENT_KINDS as z };
 
-//# sourceMappingURL=commissions-nMBMa0DT.js.map
+//# sourceMappingURL=commissions-DSVGf1ZX.js.map