@better-giving/donation 1.1.9 → 1.1.11

package/dist/donation.d.mts

@@ -2,7 +2,7 @@ import type { ISODate } from "@better-giving/types/alias";
 import type { ChainID, Environment } from "@better-giving/types/list";
 import type { EmptyObject, OrStr } from "@better-giving/types/utils";
 export declare namespace Donation {
-    type Index = "AppUsed_Index" | "Checked-8283_Index" | "Email_Index" | "EndowmentId_Index" | "FundDeposits_Index" | "Tax-Receipt-Sent_Index" | "Network-FinalizedDate_Index" | "WalletAddress_Index";
+    type Index = "AppUsed_Index" | "Checked-8283_Index" | "Email_Index" | "EndowmentId_Index" | "FundDeposits_Index" | "Tax-Receipt-Sent_Index" | "Network-FinalizedDate_Index" | "WalletAddress_Index" | "Referrer-FinalizedDate_index";
     type App = "aging" | "angel-protocol" | "bg-marketplace" | "bg-widget" | "black-history-month" | "make-whole" | "mental-health" | "restore-earth" | "tester-app" | "ukraine-portal";
     type Source = Extract<Donation.App, "bg-marketplace" | "bg-widget" | "tester-app">;
     type Client = "apes" | "normal";
@@ -40,6 +40,11 @@ export declare namespace Donation {
         network: Environment;
         donationFinalTxDate: ISODate;
     };
+    /** Referrer-FinalizedDate_Index */
+    type Referrer_FinalizedDate_IndexKey = {
+        referrer?: string;
+        donationFinalTxDate: ISODate;
+    };
     /** Tax-Receipt-Sent_Index */
     type Tax_Receipt_Sent_IndexKey = {
         taxReceiptSent?: "yes" | "no";
@@ -69,6 +74,12 @@ export declare namespace Donation {
     type V2FullKyc = DonorBasicInfo & DonorAddress;
     type V2Kyc = DonorBasicInfo | V2FullKyc;
     type PartialV2Kyc = Partial<V2FullKyc>;
+    interface ReferrerCommission {
+        from_tip: number;
+        from_fee: number;
+        /** exist when paid */
+        transfer_id?: number;
+    }
     type V2NonKeyAttributes = {
         /** program which the donation is attributed: may be empty `""` */
         programId?: string;
@@ -119,6 +130,7 @@ export declare namespace Donation {
         baseFee: number;
         processingFee: number;
         fiscalSponsorFee: number;
+        referrer_commission?: ReferrerCommission;
         fund_id?: string;
         fund_name?: string;
         fund_tx?: string;
@@ -167,7 +179,7 @@ export declare namespace Donation {
     /** only use this definition on writes: for reads, it's safer to use DBRecord */
     type V2DBRecord = PrimaryKey & EmailIndexKey & FiatRamp_IndexKey & 
     /** be sure to include in crypto donation */
-    WalletAddress_Index & Required<EndowmentId_IndexKey> & Required<AppUsed_IndexKey> & (WithKYC | WithoutKYC) & V2NonKeyAttributes;
+    WalletAddress_Index & Referrer_FinalizedDate_IndexKey & Required<EndowmentId_IndexKey> & Required<AppUsed_IndexKey> & (WithKYC | WithoutKYC) & V2NonKeyAttributes;
     /** only use this definition on writes: for reads, it's safer to use DBRecord */
     type V2InitCryptoDBRecord = PrimaryKey & EmailIndexKey & 
     /** be sure to include in crypto donation */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@better-giving/donation",
-  "version": "1.1.9",
+  "version": "1.1.11",
   "devDependencies": {
     "@better-giving/config": "1.1.2"
   },

package/src/donation.mts

@@ -11,7 +11,8 @@ export declare namespace Donation {
     | "FundDeposits_Index"
     | "Tax-Receipt-Sent_Index"
     | "Network-FinalizedDate_Index"
-    | "WalletAddress_Index";
+    | "WalletAddress_Index"
+    | "Referrer-FinalizedDate_index";
 
   type App =
     | "aging"
@@ -74,6 +75,12 @@ export declare namespace Donation {
     donationFinalTxDate: ISODate; //SK
   };
 
+  /** Referrer-FinalizedDate_Index */
+  type Referrer_FinalizedDate_IndexKey = {
+    referrer?: string; //PK
+    donationFinalTxDate: ISODate; //SK
+  };
+
   /** Tax-Receipt-Sent_Index */
   type Tax_Receipt_Sent_IndexKey = {
     taxReceiptSent?: "yes" | "no"; //PK
@@ -107,6 +114,13 @@ export declare namespace Donation {
   type V2Kyc = DonorBasicInfo | V2FullKyc;
   type PartialV2Kyc = Partial<V2FullKyc>;
 
+  interface ReferrerCommission {
+    from_tip: number;
+    from_fee: number;
+    /** exist when paid */
+    transfer_id?: number;
+  }
+
   type V2NonKeyAttributes = {
     /** program which the donation is attributed: may be empty `""` */
     programId?: string;
@@ -163,6 +177,7 @@ export declare namespace Donation {
     baseFee: number;
     processingFee: number;
     fiscalSponsorFee: number;
+    referrer_commission?: ReferrerCommission;
 
     /// fundraiser this donation is attributed to
     fund_id?: string;
@@ -249,6 +264,7 @@ export declare namespace Donation {
     FiatRamp_IndexKey &
     /** be sure to include in crypto donation */
     WalletAddress_Index &
+    Referrer_FinalizedDate_IndexKey &
     Required<EndowmentId_IndexKey> &
     Required<AppUsed_IndexKey> &
     (WithKYC | WithoutKYC) &