@better-giving/donation 3.0.10 → 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 +94 -90
  2. package/package.json +1 -1
  3. package/src/interfaces.mts +115 -91
package/dist/interfaces.d.mts CHANGED
@@ -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,45 @@ 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
+ country?: string;
66
+ zipCode?: string;
59
67
  /** 0 when donating to fund */
60
68
  endowmentId: number;
61
- fiatRamp?: TFiatRamp;
62
- feeAllowance?: number;
69
+ charityName: string;
70
+ claimed?: boolean;
63
71
  fiscalSponsored: boolean;
64
- fullName: string;
65
72
  /** may be empty, if donation is to npo */
66
73
  fund_id?: string;
67
74
  fund_members?: number[];
68
75
  fund_name?: string;
69
76
  hideBgTip?: boolean;
70
77
  /** may be empty */
71
- inHonorOf?: string;
72
- isRecurring?: boolean;
73
- msg_to_npo?: string;
74
- network: Environment;
78
+ programId?: string;
79
+ /** may be empty */
80
+ programName?: string;
75
81
  /** may be empty */
76
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;
77
90
  /** Nowpayments: number, custom: uuid */
78
91
  payment_id?: number | string;
79
92
  /** e.g. Bank transfer */
80
93
  paymentMethod?: string;
81
- /** may be empty */
82
- programId?: string;
83
- /** may be empty */
84
- programName?: string;
85
94
  stripeDepositVerifyUrl?: string;
86
- /** TTL attribute */
87
- expireAt?: number;
88
- title?: TDonorTitle;
89
- tributeNotif?: ITributeNotif;
90
- ukGiftAid?: boolean;
91
- usdValue: number;
92
95
  /** may be empty */
93
- walletAddress?: string;
96
+ inHonorOf?: string;
97
+ tributeNotif?: ITributeNotif;
94
98
  }
95
99
  export interface IDonationOnHold extends IDonationOnHoldAttr, IDonationOnHoldAttrLegacy {
96
100
  }
@@ -153,13 +157,29 @@ export type TExplicit<T> = {
153
157
  [K in keyof T]-?: T[K];
154
158
  };
155
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;
156
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;
157
178
  allocation?: IAllocation;
158
179
  /** "bg-marketplace", "restore-earth", "angel-protocol",
159
180
  "ukraine-portal", "bg-widget", undefined, "aging", "black-history-month",
160
181
  "make-whole", "mental-health" */
161
182
  appUsed?: TDonationSource | (string & {});
162
- baseFee?: number;
163
183
  /**
164
184
  "fiat", "columbus-5", "eth", "matic", "juno-1", "ltc", undefined, "btc", "phoenix-1", "56", "1", "137",
165
185
  "xrp-mainnet", "zec", "sol", "bch", "bsc", "cchain", "xvg", "xrp", "sei-1", "icx", "base",
@@ -174,24 +194,56 @@ export interface IDonationFinalAttr {
174
194
  "Avalanche C-Chain", "Verge", "XRP", "Sei", "ICON", "Base", "TRON", "CHARIOT"
175
195
  */
176
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;
177
205
  charityName?: string;
178
- /** may be empty */
179
- city?: string;
180
206
  claimed?: boolean;
207
+ fiscalSponsored?: boolean;
208
+ fund_id?: string;
209
+ fund_name?: string;
210
+ fund_members?: number[];
181
211
  /** may be empty */
182
- company_name?: string;
212
+ nonProfitMsg?: string;
183
213
  /** may be empty */
184
- country?: string;
214
+ programId?: string;
215
+ /** may be empty */
216
+ programName?: string;
185
217
  donor_public?: boolean;
186
218
  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;
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;
195
247
  donationFinalAmount?: number;
196
248
  /**
197
249
  "fiat", undefined, "matic", "137", "noble-1", "eth"*/
@@ -204,59 +256,11 @@ export interface IDonationFinalAttr {
204
256
  donationFinalDenom?: string;
205
257
  /** iso date */
206
258
  donationFinalTxDate?: string;
207
- donationFinalTxHash?: string;
208
- endowmentId?: number;
209
259
  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;
260
+ donationFinalTxHash?: string;
242
261
  referrer_commission?: IReferrerCommission;
243
262
  referrer?: string;
244
- settledUsdAmount?: number;
245
- state?: string;
246
- /** @legacy may be empty */
247
- stateAddress?: string;
248
- streetAddress?: string;
249
263
  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
264
  }
261
265
  export interface IDonationFinal extends IDonationFinalAttr, IDonationFinalAttrLegacy {
262
266
  }
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.11",
4
4
  "devDependencies": {
5
5
  "@better-giving/config": "1.1.2"
6
6
  },
package/src/interfaces.mts CHANGED
@@ -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,51 @@ 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
+ country?: string;
75
+ zipCode?: string;
76
+
77
+ /// TO ///
65
78
  /** 0 when donating to fund */
66
79
  endowmentId: number;
67
- fiatRamp?: TFiatRamp;
68
- feeAllowance?: number;
80
+ charityName: string;
81
+ claimed?: boolean;
69
82
  fiscalSponsored: boolean;
70
- fullName: string;
71
83
  /** may be empty, if donation is to npo */
72
84
  fund_id?: string;
73
85
  fund_members?: number[];
74
86
  fund_name?: string;
75
87
  hideBgTip?: boolean;
76
88
  /** may be empty */
77
- inHonorOf?: string;
78
- isRecurring?: boolean;
79
- msg_to_npo?: string;
80
- network: Environment;
89
+ programId?: string;
90
+ /** may be empty */
91
+ programName?: string;
81
92
  /** may be empty */
82
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;
83
103
  /** Nowpayments: number, custom: uuid */
84
104
  payment_id?: number | string;
85
105
  /** e.g. Bank transfer */
86
106
  paymentMethod?: string;
87
- /** may be empty */
88
- programId?: string;
89
- /** may be empty */
90
- programName?: string;
91
107
  stripeDepositVerifyUrl?: string;
92
- /** TTL attribute */
93
- expireAt?: number;
94
- title?: TDonorTitle;
95
- tributeNotif?: ITributeNotif;
96
- ukGiftAid?: boolean;
97
- usdValue: number;
108
+
109
+ /// TRIBUTE ///
98
110
  /** may be empty */
99
- walletAddress?: string;
111
+ inHonorOf?: string;
112
+ tributeNotif?: ITributeNotif;
100
113
  }
101
114
 
102
115
  export interface IDonationOnHold
@@ -162,13 +175,31 @@ export interface IDonationFinalAttrLegacy {
162
175
  export type TExplicit<T> = { [K in keyof T]-?: T[K] };
163
176
 
164
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;
165
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;
166
196
  allocation?: IAllocation;
197
+
198
+ /// VIA ///
167
199
  /** "bg-marketplace", "restore-earth", "angel-protocol",
168
200
  "ukraine-portal", "bg-widget", undefined, "aging", "black-history-month",
169
201
  "make-whole", "mental-health" */
170
202
  appUsed?: TDonationSource | (string & {});
171
- baseFee?: number;
172
203
  /**
173
204
  "fiat", "columbus-5", "eth", "matic", "juno-1", "ltc", undefined, "btc", "phoenix-1", "56", "1", "137",
174
205
  "xrp-mainnet", "zec", "sol", "bch", "bsc", "cchain", "xvg", "xrp", "sei-1", "icx", "base",
@@ -183,25 +214,64 @@ export interface IDonationFinalAttr {
183
214
  "Avalanche C-Chain", "Verge", "XRP", "Sei", "ICON", "Base", "TRON", "CHARIOT"
184
215
  */
185
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;
186
227
  charityName?: string;
187
- /** may be empty */
188
- city?: string;
189
228
  claimed?: boolean;
229
+ fiscalSponsored?: boolean;
230
+ fund_id?: string;
231
+ fund_name?: string;
232
+ fund_members?: number[];
190
233
  /** may be empty */
191
- company_name?: string;
234
+ nonProfitMsg?: string;
192
235
  /** may be empty */
193
- country?: string;
236
+ programId?: string;
237
+ /** may be empty */
238
+ programName?: string;
239
+
240
+ /// FROM ///
194
241
  donor_public?: boolean;
195
242
  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;
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;
204
264
 
265
+ /// TRIBUTE ///
266
+ /** may be empty */
267
+ inHonorOf?: string;
268
+ tributeNotif?: ITributeNotif;
269
+
270
+ /// SETTLEMENT ///
271
+ baseFee?: number;
272
+ fiscalSponsorFee?: number;
273
+ processingFee?: number;
274
+ settledUsdAmount?: number;
205
275
  donationFinalAmount?: number;
206
276
  /**
207
277
  "fiat", undefined, "matic", "137", "noble-1", "eth"*/
@@ -214,61 +284,15 @@ export interface IDonationFinalAttr {
214
284
  donationFinalDenom?: string;
215
285
  /** iso date */
216
286
  donationFinalTxDate?: string;
217
- donationFinalTxHash?: string;
218
-
219
- endowmentId?: number;
220
287
  excessFeeAllowanceUsd?: number;
221
- feeAllowance?: number;
288
+ donationFinalTxHash?: string;
222
289
 
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;
290
+ /// REFERRALS ///
254
291
  referrer_commission?: IReferrerCommission;
255
292
  referrer?: string;
256
- settledUsdAmount?: number;
257
- state?: string;
258
- /** @legacy may be empty */
259
- stateAddress?: string;
260
- streetAddress?: string;
293
+
294
+ /// OTHERS ///
261
295
  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
296
  }
273
297
 
274
298
  export interface IDonationFinal