@better-giving/donation 3.0.10 → 3.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -33,22 +33,22 @@ export interface IDonationOnHoldAttrLegacy {
33
33
  export interface IDonationOnHoldAttr {
34
34
  transactionDate: string;
35
35
  transactionId: string;
36
- allocation?: IAllocation;
37
- amount: number;
38
36
  status: TOnHoldStatus;
37
+ network: Environment;
38
+ /** TTL attribute */
39
+ expireAt?: number;
40
+ amount: number;
41
+ feeAllowance?: number;
39
42
  tipAmount: number;
43
+ usdValue: number;
44
+ allocation?: IAllocation;
40
45
  /**
41
46
  "USD", "TRX", "karate-295", "BRL", "GBP", "USDC", "JPY", "ETH", "USDCMATIC", "EUR", "INR", "THB", "PHP",
42
47
  "XRP", "RUB", "CAD", "karate-1" ... */
43
48
  denomination: string;
44
- /** bg-marketplace | bg-widget */
45
- appUsed: TDonationSource;
46
- /** "fiat", "trx", "hbar", "eth", "matic", "xrp-mainnet" */
47
- chainId: string;
48
- /** "Fiat", "TRON", "Hedera", "Ethereum", "", "Polygon", "Stripe", "XRP Ledger" */
49
- chainName: string;
50
- charityName: string;
51
- claimed?: boolean;
49
+ isRecurring?: boolean;
50
+ title?: TDonorTitle;
51
+ fullName: string;
52
52
  /** may be empty */
53
53
  company_name?: string;
54
54
  donor_message?: string;
@@ -56,41 +56,46 @@ export interface IDonationOnHoldAttr {
56
56
  kycEmail: string;
57
57
  /** @legacy */
58
58
  email?: string;
59
+ msg_to_npo?: string;
60
+ ukGiftAid?: boolean;
61
+ /** may be empty */
62
+ walletAddress?: string;
63
+ streetAddress?: string;
64
+ city?: string;
65
+ state?: string;
66
+ country?: string;
67
+ zipCode?: string;
59
68
  /** 0 when donating to fund */
60
69
  endowmentId: number;
61
- fiatRamp?: TFiatRamp;
62
- feeAllowance?: number;
70
+ charityName: string;
71
+ claimed?: boolean;
63
72
  fiscalSponsored: boolean;
64
- fullName: string;
65
73
  /** may be empty, if donation is to npo */
66
74
  fund_id?: string;
67
75
  fund_members?: number[];
68
76
  fund_name?: string;
69
77
  hideBgTip?: boolean;
70
78
  /** may be empty */
71
- inHonorOf?: string;
72
- isRecurring?: boolean;
73
- msg_to_npo?: string;
74
- network: Environment;
79
+ programId?: string;
80
+ /** may be empty */
81
+ programName?: string;
75
82
  /** may be empty */
76
83
  nonProfitMsg?: string;
84
+ fiatRamp?: TFiatRamp;
85
+ /** bg-marketplace | bg-widget */
86
+ appUsed: TDonationSource;
87
+ /** "fiat", "trx", "hbar", "eth", "matic", "xrp-mainnet" */
88
+ chainId: string;
89
+ /** "Fiat", "TRON", "Hedera", "Ethereum", "", "Polygon", "Stripe", "XRP Ledger" */
90
+ chainName: string;
77
91
  /** Nowpayments: number, custom: uuid */
78
92
  payment_id?: number | string;
79
93
  /** e.g. Bank transfer */
80
94
  paymentMethod?: string;
81
- /** may be empty */
82
- programId?: string;
83
- /** may be empty */
84
- programName?: string;
85
95
  stripeDepositVerifyUrl?: string;
86
- /** TTL attribute */
87
- expireAt?: number;
88
- title?: TDonorTitle;
89
- tributeNotif?: ITributeNotif;
90
- ukGiftAid?: boolean;
91
- usdValue: number;
92
96
  /** may be empty */
93
- walletAddress?: string;
97
+ inHonorOf?: string;
98
+ tributeNotif?: ITributeNotif;
94
99
  }
95
100
  export interface IDonationOnHold extends IDonationOnHoldAttr, IDonationOnHoldAttrLegacy {
96
101
  }
@@ -153,13 +158,29 @@ export type TExplicit<T> = {
153
158
  [K in keyof T]-?: T[K];
154
159
  };
155
160
  export interface IDonationFinalAttr {
161
+ transactionId: string;
162
+ /** iso */
163
+ transactionDate?: string;
164
+ /** indicates this is a tip record */
165
+ parentTx?: string;
166
+ network?: Environment;
156
167
  amount?: number;
168
+ usdValue?: number;
169
+ isRecurring?: boolean;
170
+ feeAllowance?: number;
171
+ /**
172
+ PHP", "UST", "USD", "LUNA", "ETH", "USDCMATIC", "axlUSDC", "LTC", undefined, "EUR", "NZD", "JUNO", "INR",
173
+ "IDR", "GBP", "USDTMATIC", "PKR", "BTC", "SEK", "HKD", "SGD", "BNB", "CAD", "MATICMAINNET",
174
+ "USDC", "MOP", "XRP", "JPY", "MATIC", "RSD", "ZEC", "TWD", "SOL", "AUD", "KRW", "BCH", "CHF", "TEL", "USDTBSC",
175
+ "YER", "ATOM", "AVAXC", "USDTERC20", "XVG", "BUSD", "SEI", "ICX", "ETHBASE", "USDC.e", "USDCBASE", "TRX",
176
+ "VND", "SZL", "GONE", "AFN", "PLN", "NOK", "WETH", "EGP", "BUSDBSC", "USDCARC20", "USDTTRC20", "THB"
177
+ */
178
+ denomination?: string;
157
179
  allocation?: IAllocation;
158
180
  /** "bg-marketplace", "restore-earth", "angel-protocol",
159
181
  "ukraine-portal", "bg-widget", undefined, "aging", "black-history-month",
160
182
  "make-whole", "mental-health" */
161
183
  appUsed?: TDonationSource | (string & {});
162
- baseFee?: number;
163
184
  /**
164
185
  "fiat", "columbus-5", "eth", "matic", "juno-1", "ltc", undefined, "btc", "phoenix-1", "56", "1", "137",
165
186
  "xrp-mainnet", "zec", "sol", "bch", "bsc", "cchain", "xvg", "xrp", "sei-1", "icx", "base",
@@ -174,24 +195,56 @@ export interface IDonationFinalAttr {
174
195
  "Avalanche C-Chain", "Verge", "XRP", "Sei", "ICON", "Base", "TRON", "CHARIOT"
175
196
  */
176
197
  chainName?: string;
198
+ fiatRamp?: TFiatRamp;
199
+ /**
200
+ "Credit Card", undefined, "Stripe Link", "Bank Transfer",
201
+ "Crypto", "Debit Card", "link", "Card", "Bank", "crypto", "Amazon Pay", "Daf", "Affirm", "eps", "card",
202
+ "p24", "affirm"
203
+ */
204
+ paymentMethod?: string;
205
+ endowmentId?: number;
177
206
  charityName?: string;
178
- /** may be empty */
179
- city?: string;
180
207
  claimed?: boolean;
208
+ fiscalSponsored?: boolean;
209
+ fund_id?: string;
210
+ fund_name?: string;
211
+ fund_members?: number[];
181
212
  /** may be empty */
182
- company_name?: string;
213
+ nonProfitMsg?: string;
183
214
  /** may be empty */
184
- country?: string;
215
+ programId?: string;
216
+ /** may be empty */
217
+ programName?: string;
185
218
  donor_public?: boolean;
186
219
  donor_message?: string;
187
- /**
188
- PHP", "UST", "USD", "LUNA", "ETH", "USDCMATIC", "axlUSDC", "LTC", undefined, "EUR", "NZD", "JUNO", "INR",
189
- "IDR", "GBP", "USDTMATIC", "PKR", "BTC", "SEK", "HKD", "SGD", "BNB", "CAD", "MATICMAINNET",
190
- "USDC", "MOP", "XRP", "JPY", "MATIC", "RSD", "ZEC", "TWD", "SOL", "AUD", "KRW", "BCH", "CHF", "TEL", "USDTBSC",
191
- "YER", "ATOM", "AVAXC", "USDTERC20", "XVG", "BUSD", "SEI", "ICX", "ETHBASE", "USDC.e", "USDCBASE", "TRX",
192
- "VND", "SZL", "GONE", "AFN", "PLN", "NOK", "WETH", "EGP", "BUSDBSC", "USDCARC20", "USDTTRC20", "THB"
193
- */
194
- denomination?: string;
220
+ kycEmail?: string;
221
+ /** @warning, about 14 legacy records (~2021) contain invalid email */
222
+ email?: string;
223
+ msg_to_npo?: string;
224
+ /** Mr Ms Mrs Mx, may be empty */
225
+ title?: string;
226
+ /** may be empty */
227
+ fullName?: string;
228
+ streetAddress?: string;
229
+ state?: string;
230
+ /** @legacy may be empty */
231
+ stateAddress?: string;
232
+ /** may be empty */
233
+ city?: string;
234
+ /** may be empty */
235
+ country?: string;
236
+ /** may be empty */
237
+ zipCode?: string;
238
+ ukGiftAid?: boolean;
239
+ /** may be empty */
240
+ company_name?: string;
241
+ /** may be empty */
242
+ inHonorOf?: string;
243
+ tributeNotif?: ITributeNotif;
244
+ baseFee?: number;
245
+ fiscalSponsorFee?: number;
246
+ processingFee?: number;
247
+ settledUsdAmount?: number;
195
248
  donationFinalAmount?: number;
196
249
  /**
197
250
  "fiat", undefined, "matic", "137", "noble-1", "eth"*/
@@ -204,59 +257,11 @@ export interface IDonationFinalAttr {
204
257
  donationFinalDenom?: string;
205
258
  /** iso date */
206
259
  donationFinalTxDate?: string;
207
- donationFinalTxHash?: string;
208
- endowmentId?: number;
209
260
  excessFeeAllowanceUsd?: number;
210
- feeAllowance?: number;
211
- fiatRamp?: TFiatRamp;
212
- fiscalSponsored?: boolean;
213
- fiscalSponsorFee?: number;
214
- /** may be empty */
215
- fullName?: string;
216
- fund_id?: string;
217
- fund_name?: string;
218
- fund_members?: number[];
219
- /** may be empty */
220
- inHonorOf?: string;
221
- isRecurring?: boolean;
222
- kycEmail?: string;
223
- /** @warning, about 14 legacy records (~2021) contain invalid email */
224
- email?: string;
225
- msg_to_npo?: string;
226
- network?: Environment;
227
- /** may be empty */
228
- nonProfitMsg?: string;
229
- /** indicates this is a tip record */
230
- parentTx?: string;
231
- /**
232
- "Credit Card", undefined, "Stripe Link", "Bank Transfer",
233
- "Crypto", "Debit Card", "link", "Card", "Bank", "crypto", "Amazon Pay", "Daf", "Affirm", "eps", "card",
234
- "p24", "affirm"
235
- */
236
- paymentMethod?: string;
237
- processingFee?: number;
238
- /** may be empty */
239
- programId?: string;
240
- /** may be empty */
241
- programName?: string;
261
+ donationFinalTxHash?: string;
242
262
  referrer_commission?: IReferrerCommission;
243
263
  referrer?: string;
244
- settledUsdAmount?: number;
245
- state?: string;
246
- /** @legacy may be empty */
247
- stateAddress?: string;
248
- streetAddress?: string;
249
264
  taxReceiptId?: string;
250
- /** Mr Ms Mrs Mx, may be empty */
251
- title?: string;
252
- /** iso */
253
- transactionDate?: string;
254
- transactionId: string;
255
- tributeNotif?: ITributeNotif;
256
- ukGiftAid?: boolean;
257
- usdValue?: number;
258
- /** may be empty */
259
- zipCode?: string;
260
265
  }
261
266
  export interface IDonationFinal extends IDonationFinalAttr, IDonationFinalAttrLegacy {
262
267
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@better-giving/donation",
3
- "version": "3.0.10",
3
+ "version": "3.0.12",
4
4
  "devDependencies": {
5
5
  "@better-giving/config": "1.1.2"
6
6
  },
@@ -39,22 +39,25 @@ export interface IDonationOnHoldAttrLegacy {
39
39
  export interface IDonationOnHoldAttr {
40
40
  transactionDate: string;
41
41
  transactionId: string;
42
- allocation?: IAllocation;
43
- amount: number;
44
42
  status: TOnHoldStatus;
43
+ network: Environment;
44
+ /** TTL attribute */
45
+ expireAt?: number;
46
+
47
+ amount: number;
48
+ feeAllowance?: number;
45
49
  tipAmount: number;
50
+ usdValue: number;
51
+ allocation?: IAllocation;
46
52
  /**
47
53
  "USD", "TRX", "karate-295", "BRL", "GBP", "USDC", "JPY", "ETH", "USDCMATIC", "EUR", "INR", "THB", "PHP",
48
54
  "XRP", "RUB", "CAD", "karate-1" ... */
49
55
  denomination: string;
50
- /** bg-marketplace | bg-widget */
51
- appUsed: TDonationSource;
52
- /** "fiat", "trx", "hbar", "eth", "matic", "xrp-mainnet" */
53
- chainId: string;
54
- /** "Fiat", "TRON", "Hedera", "Ethereum", "", "Polygon", "Stripe", "XRP Ledger" */
55
- chainName: string;
56
- charityName: string;
57
- claimed?: boolean;
56
+ isRecurring?: boolean;
57
+
58
+ /// FROM ///
59
+ title?: TDonorTitle;
60
+ fullName: string;
58
61
  /** may be empty */
59
62
  company_name?: string;
60
63
  donor_message?: string;
@@ -62,41 +65,52 @@ export interface IDonationOnHoldAttr {
62
65
  kycEmail: string;
63
66
  /** @legacy */
64
67
  email?: string;
68
+ msg_to_npo?: string;
69
+ ukGiftAid?: boolean;
70
+ /** may be empty */
71
+ walletAddress?: string;
72
+ streetAddress?: string;
73
+ city?: string;
74
+ state?: string;
75
+ country?: string;
76
+ zipCode?: string;
77
+
78
+ /// TO ///
65
79
  /** 0 when donating to fund */
66
80
  endowmentId: number;
67
- fiatRamp?: TFiatRamp;
68
- feeAllowance?: number;
81
+ charityName: string;
82
+ claimed?: boolean;
69
83
  fiscalSponsored: boolean;
70
- fullName: string;
71
84
  /** may be empty, if donation is to npo */
72
85
  fund_id?: string;
73
86
  fund_members?: number[];
74
87
  fund_name?: string;
75
88
  hideBgTip?: boolean;
76
89
  /** may be empty */
77
- inHonorOf?: string;
78
- isRecurring?: boolean;
79
- msg_to_npo?: string;
80
- network: Environment;
90
+ programId?: string;
91
+ /** may be empty */
92
+ programName?: string;
81
93
  /** may be empty */
82
94
  nonProfitMsg?: string;
95
+
96
+ /// VIA ///
97
+ fiatRamp?: TFiatRamp;
98
+ /** bg-marketplace | bg-widget */
99
+ appUsed: TDonationSource;
100
+ /** "fiat", "trx", "hbar", "eth", "matic", "xrp-mainnet" */
101
+ chainId: string;
102
+ /** "Fiat", "TRON", "Hedera", "Ethereum", "", "Polygon", "Stripe", "XRP Ledger" */
103
+ chainName: string;
83
104
  /** Nowpayments: number, custom: uuid */
84
105
  payment_id?: number | string;
85
106
  /** e.g. Bank transfer */
86
107
  paymentMethod?: string;
87
- /** may be empty */
88
- programId?: string;
89
- /** may be empty */
90
- programName?: string;
91
108
  stripeDepositVerifyUrl?: string;
92
- /** TTL attribute */
93
- expireAt?: number;
94
- title?: TDonorTitle;
95
- tributeNotif?: ITributeNotif;
96
- ukGiftAid?: boolean;
97
- usdValue: number;
109
+
110
+ /// TRIBUTE ///
98
111
  /** may be empty */
99
- walletAddress?: string;
112
+ inHonorOf?: string;
113
+ tributeNotif?: ITributeNotif;
100
114
  }
101
115
 
102
116
  export interface IDonationOnHold
@@ -162,13 +176,31 @@ export interface IDonationFinalAttrLegacy {
162
176
  export type TExplicit<T> = { [K in keyof T]-?: T[K] };
163
177
 
164
178
  export interface IDonationFinalAttr {
179
+ transactionId: string;
180
+ /** iso */
181
+ transactionDate?: string;
182
+ /** indicates this is a tip record */
183
+ parentTx?: string;
184
+ network?: Environment;
165
185
  amount?: number;
186
+ usdValue?: number;
187
+ isRecurring?: boolean;
188
+ feeAllowance?: number;
189
+ /**
190
+ PHP", "UST", "USD", "LUNA", "ETH", "USDCMATIC", "axlUSDC", "LTC", undefined, "EUR", "NZD", "JUNO", "INR",
191
+ "IDR", "GBP", "USDTMATIC", "PKR", "BTC", "SEK", "HKD", "SGD", "BNB", "CAD", "MATICMAINNET",
192
+ "USDC", "MOP", "XRP", "JPY", "MATIC", "RSD", "ZEC", "TWD", "SOL", "AUD", "KRW", "BCH", "CHF", "TEL", "USDTBSC",
193
+ "YER", "ATOM", "AVAXC", "USDTERC20", "XVG", "BUSD", "SEI", "ICX", "ETHBASE", "USDC.e", "USDCBASE", "TRX",
194
+ "VND", "SZL", "GONE", "AFN", "PLN", "NOK", "WETH", "EGP", "BUSDBSC", "USDCARC20", "USDTTRC20", "THB"
195
+ */
196
+ denomination?: string;
166
197
  allocation?: IAllocation;
198
+
199
+ /// VIA ///
167
200
  /** "bg-marketplace", "restore-earth", "angel-protocol",
168
201
  "ukraine-portal", "bg-widget", undefined, "aging", "black-history-month",
169
202
  "make-whole", "mental-health" */
170
203
  appUsed?: TDonationSource | (string & {});
171
- baseFee?: number;
172
204
  /**
173
205
  "fiat", "columbus-5", "eth", "matic", "juno-1", "ltc", undefined, "btc", "phoenix-1", "56", "1", "137",
174
206
  "xrp-mainnet", "zec", "sol", "bch", "bsc", "cchain", "xvg", "xrp", "sei-1", "icx", "base",
@@ -183,25 +215,64 @@ export interface IDonationFinalAttr {
183
215
  "Avalanche C-Chain", "Verge", "XRP", "Sei", "ICON", "Base", "TRON", "CHARIOT"
184
216
  */
185
217
  chainName?: string;
218
+ fiatRamp?: TFiatRamp;
219
+ /**
220
+ "Credit Card", undefined, "Stripe Link", "Bank Transfer",
221
+ "Crypto", "Debit Card", "link", "Card", "Bank", "crypto", "Amazon Pay", "Daf", "Affirm", "eps", "card",
222
+ "p24", "affirm"
223
+ */
224
+ paymentMethod?: string;
225
+
226
+ /// TO ///
227
+ endowmentId?: number;
186
228
  charityName?: string;
187
- /** may be empty */
188
- city?: string;
189
229
  claimed?: boolean;
230
+ fiscalSponsored?: boolean;
231
+ fund_id?: string;
232
+ fund_name?: string;
233
+ fund_members?: number[];
190
234
  /** may be empty */
191
- company_name?: string;
235
+ nonProfitMsg?: string;
192
236
  /** may be empty */
193
- country?: string;
237
+ programId?: string;
238
+ /** may be empty */
239
+ programName?: string;
240
+
241
+ /// FROM ///
194
242
  donor_public?: boolean;
195
243
  donor_message?: string;
196
- /**
197
- PHP", "UST", "USD", "LUNA", "ETH", "USDCMATIC", "axlUSDC", "LTC", undefined, "EUR", "NZD", "JUNO", "INR",
198
- "IDR", "GBP", "USDTMATIC", "PKR", "BTC", "SEK", "HKD", "SGD", "BNB", "CAD", "MATICMAINNET",
199
- "USDC", "MOP", "XRP", "JPY", "MATIC", "RSD", "ZEC", "TWD", "SOL", "AUD", "KRW", "BCH", "CHF", "TEL", "USDTBSC",
200
- "YER", "ATOM", "AVAXC", "USDTERC20", "XVG", "BUSD", "SEI", "ICX", "ETHBASE", "USDC.e", "USDCBASE", "TRX",
201
- "VND", "SZL", "GONE", "AFN", "PLN", "NOK", "WETH", "EGP", "BUSDBSC", "USDCARC20", "USDTTRC20", "THB"
202
- */
203
- denomination?: string;
244
+ kycEmail?: string;
245
+ /** @warning, about 14 legacy records (~2021) contain invalid email */
246
+ email?: string;
247
+ msg_to_npo?: string;
248
+ /** Mr Ms Mrs Mx, may be empty */
249
+ title?: string;
250
+ /** may be empty */
251
+ fullName?: string;
252
+ streetAddress?: string;
253
+ state?: string;
254
+ /** @legacy may be empty */
255
+ stateAddress?: string;
256
+ /** may be empty */
257
+ city?: string;
258
+ /** may be empty */
259
+ country?: string;
260
+ /** may be empty */
261
+ zipCode?: string;
262
+ ukGiftAid?: boolean;
263
+ /** may be empty */
264
+ company_name?: string;
265
+
266
+ /// TRIBUTE ///
267
+ /** may be empty */
268
+ inHonorOf?: string;
269
+ tributeNotif?: ITributeNotif;
204
270
 
271
+ /// SETTLEMENT ///
272
+ baseFee?: number;
273
+ fiscalSponsorFee?: number;
274
+ processingFee?: number;
275
+ settledUsdAmount?: number;
205
276
  donationFinalAmount?: number;
206
277
  /**
207
278
  "fiat", undefined, "matic", "137", "noble-1", "eth"*/
@@ -214,61 +285,15 @@ export interface IDonationFinalAttr {
214
285
  donationFinalDenom?: string;
215
286
  /** iso date */
216
287
  donationFinalTxDate?: string;
217
- donationFinalTxHash?: string;
218
-
219
- endowmentId?: number;
220
288
  excessFeeAllowanceUsd?: number;
221
- feeAllowance?: number;
289
+ donationFinalTxHash?: string;
222
290
 
223
- fiatRamp?: TFiatRamp;
224
- fiscalSponsored?: boolean;
225
- fiscalSponsorFee?: number;
226
- /** may be empty */
227
- fullName?: string;
228
- fund_id?: string;
229
- fund_name?: string;
230
- fund_members?: number[];
231
- /** may be empty */
232
- inHonorOf?: string;
233
- isRecurring?: boolean;
234
- kycEmail?: string;
235
- /** @warning, about 14 legacy records (~2021) contain invalid email */
236
- email?: string;
237
- msg_to_npo?: string;
238
- network?: Environment;
239
- /** may be empty */
240
- nonProfitMsg?: string;
241
- /** indicates this is a tip record */
242
- parentTx?: string;
243
- /**
244
- "Credit Card", undefined, "Stripe Link", "Bank Transfer",
245
- "Crypto", "Debit Card", "link", "Card", "Bank", "crypto", "Amazon Pay", "Daf", "Affirm", "eps", "card",
246
- "p24", "affirm"
247
- */
248
- paymentMethod?: string;
249
- processingFee?: number;
250
- /** may be empty */
251
- programId?: string;
252
- /** may be empty */
253
- programName?: string;
291
+ /// REFERRALS ///
254
292
  referrer_commission?: IReferrerCommission;
255
293
  referrer?: string;
256
- settledUsdAmount?: number;
257
- state?: string;
258
- /** @legacy may be empty */
259
- stateAddress?: string;
260
- streetAddress?: string;
294
+
295
+ /// OTHERS ///
261
296
  taxReceiptId?: string;
262
- /** Mr Ms Mrs Mx, may be empty */
263
- title?: string;
264
- /** iso */
265
- transactionDate?: string;
266
- transactionId: string;
267
- tributeNotif?: ITributeNotif;
268
- ukGiftAid?: boolean;
269
- usdValue?: number;
270
- /** may be empty */
271
- zipCode?: string;
272
297
  }
273
298
 
274
299
  export interface IDonationFinal