@better-giving/donation 3.0.9 → 3.0.11

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