@better-giving/donation 3.0.17 → 3.0.18

package/dist/donation-msgs-db.d.mts

@@ -1,7 +1,6 @@
 import { Db } from "@better-giving/db";
 import type { ISODate } from "@better-giving/types/alias";
 import type { IPageKeyed } from "@better-giving/types/api";
-import type { Environment } from "@better-giving/types/list";
 import type { IPublicDonor } from "./interfaces.mjs";
 import type { IPageOpts } from "./schema.mjs";
 export type DMKey = `DM#${string}`;
@@ -18,34 +17,3 @@ export declare class DonationDonorsDb extends Db {
     };
     list(recipient: string, opts?: IPageOpts): Promise<IPageKeyed<IPublicDonor>>;
 }
-export declare namespace GSI1 {
-    type Name = "recipient-env-gsi";
-    interface Key {
-        /** `Recipient#{recipient_id}#{env}` */
-        gsi1PK: `Recipient#${string}#${Environment}`;
-        gsi1SK: ISODate;
-    }
-}
-export declare namespace DonationMessage {
-    /** `DM#{uuid}` */
-    interface PrimaryKey {
-        PK: DMKey;
-        SK: DMKey;
-    }
-    interface NonKeyAttributes {
-        /** USD amount at the time of donation */
-        amount: number;
-        date: ISODate;
-        donation_id: string;
-        donor_id: string;
-        donor_message: string;
-        donor_name: string;
-        env: Environment;
-        /** uuidv4 */
-        id: string;
-        /** Endow or fund ID */
-        recipient_id: string;
-    }
-    interface DBRecord extends PrimaryKey, NonKeyAttributes, GSI1.Key {
-    }
-}

package/dist/donations-db.mjs

@@ -17,7 +17,7 @@ export class DonationsDb extends Db {
         });
         return this.client.send(cmd).then((r) => r.Item);
     }
-    async put_txi(data) {
+    put_txi(data) {
         const cmd = new PutCommand({
             TableName: this.table,
             Item: data,

package/package.json

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

package/src/donation-msgs-db.mts

@@ -36,38 +36,3 @@ export class DonationDonorsDb extends Db {
     return this.client.send(cmd).then(this.to_page<IPublicDonor>);
   }
 }
-
-export declare namespace GSI1 {
-  type Name = "recipient-env-gsi";
-
-  interface Key {
-    /** `Recipient#{recipient_id}#{env}` */
-    gsi1PK: `Recipient#${string}#${Environment}`;
-    gsi1SK: ISODate;
-  }
-}
-
-export declare namespace DonationMessage {
-  /** `DM#{uuid}` */
-  interface PrimaryKey {
-    PK: DMKey;
-    SK: DMKey;
-  }
-
-  interface NonKeyAttributes {
-    /** USD amount at the time of donation */
-    amount: number;
-    date: ISODate;
-    donation_id: string;
-    donor_id: string;
-    donor_message: string;
-    donor_name: string;
-    env: Environment;
-    /** uuidv4 */
-    id: string;
-    /** Endow or fund ID */
-    recipient_id: string;
-  }
-
-  interface DBRecord extends PrimaryKey, NonKeyAttributes, GSI1.Key {}
-}

package/src/donations-db.mts

@@ -39,7 +39,7 @@ export class DonationsDb extends Db {
     return this.client.send(cmd).then((r) => r.Item as any);
   }
 
-  async put_txi(data: TExplicit<IDonationFinalAttr>) {
+  put_txi(data: TExplicit<IDonationFinalAttr>) {
     const cmd = new PutCommand({
       TableName: this.table,
       Item: data,

package/dist/donation-message.d.mts

@@ -1,34 +0,0 @@
-import type { ISODate } from "@better-giving/types/alias";
-import type { Environment } from "@better-giving/types/list";
-export type DMKey = `DM#${string}`;
-export declare namespace GSI1 {
-    type Name = "recipient-env-gsi";
-    interface Key {
-        /** `Recipient#{recipient_id}#{env}` */
-        gsi1PK: `Recipient#${string}#${Environment}`;
-        gsi1SK: ISODate;
-    }
-}
-export declare namespace DonationMessage {
-    /** `DM#{uuid}` */
-    interface PrimaryKey {
-        PK: DMKey;
-        SK: DMKey;
-    }
-    interface NonKeyAttributes {
-        /** USD amount at the time of donation */
-        amount: number;
-        date: ISODate;
-        donation_id: string;
-        donor_id: string;
-        donor_message: string;
-        donor_name: string;
-        env: Environment;
-        /** uuidv4 */
-        id: string;
-        /** Endow or fund ID */
-        recipient_id: string;
-    }
-    interface DBRecord extends PrimaryKey, NonKeyAttributes, GSI1.Key {
-    }
-}

package/dist/donation-message.mjs

@@ -1 +0,0 @@
-export {};

package/dist/donation.d.mts

@@ -1,355 +0,0 @@
-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";
-import type { Allocation, DonorTitle } from "./schema.mjs";
-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" | "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";
-    type ApesComplianceReviewStatus = "pending" | "approved";
-    type PrimaryKey = {
-        transactionId: string;
-    };
-    /** AppUsed_Index */
-    type AppUsed_IndexKey = {
-        appUsed?: App;
-    };
-    /** Checked-8283_Index */
-    type Checked_8283_IndexKey = {
-        checked8283?: "yes" | "no";
-    };
-    /** Email_Index */
-    type EmailIndexKey = {
-        /** donor email */
-        email?: string;
-    };
-    /** EndowmentId_Index */
-    type EndowmentId_IndexKey = {
-        endowmentId?: number;
-    };
-    type FiatRamp_IndexKey = {
-        fiatRamp?: "STRIPE" | "PAYPAL" | "CHARIOT";
-    };
-    /** FundDeposits_Index */
-    type FundDeposits_IndexKey = {
-        fundDepositTxHash?: string;
-        donationFinalTxHash?: string;
-    };
-    /** Network-FinalizedDate_Index */
-    type Network_FinalizedDate_IndexKey = {
-        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";
-    };
-    /** WalletAddress_Index */
-    type WalletAddress_Index = {
-        walletAddress?: string;
-    };
-    type DonorBasicInfo = {
-        /** may be empty */
-        title?: DonorTitle;
-        fullName: string;
-        kycEmail: string;
-        /** signifies eligibility to UK Gift Aid, defaults to `false` for crypto donations */
-        ukGiftAid: boolean;
-    };
-    type DonorAddress = {
-        streetAddress: string;
-        /** may be empty `''` */
-        city: string;
-        /** optional */
-        state?: string;
-        zipCode: string;
-        country: string;
-    };
-    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;
-        programName?: string;
-        /** honorary full name - may be empty `""` */
-        inHonorOf?: string;
-        /** only allowed if honoree is provided */
-        tributeNotif?: Donation.TributeNotif;
-        transactionDate: ISODate;
-        /** if tipAmount is present, value includes tipAmount */
-        amount: number;
-        /** USD value at the time of donation */
-        usdValue: number;
-        /**
-         * settled USD amount before fsa,base fees
-         *
-         * Crypto: post-swaps USDC amount and converted to USD equivalent
-         *
-         * Fiat: 1:1 for USD donations while post-FX conversion for non USD donations
-         */
-        settledUsdAmount: number;
-        feeAllowance: number;
-        /** what's left of feeAllowance after covering processing fee, could be less than 0 (loss) */
-        excessFeeAllowanceUsd: number;
-        /** indicates DB record is not yet separated into endow-record & tip-record */
-        tipAmount?: number;
-        /** indicates this is a tip record extracted from parent */
-        parentTx?: string;
-        denomination: string;
-        chainId: ChainID.V2SupportedChainID;
-        chainName: string;
-        /** 0 - 100 */
-        splitLiq: string;
-        charityName: string;
-        nonProfitMsg?: string;
-        msg_to_npo?: string;
-        claimed: boolean;
-        fiscalSponsored: boolean;
-        client: Client;
-        network: Environment;
-        paymentMethod: string;
-        isRecurring: boolean;
-        destinationChainId: OrStr<ChainID.V2DestinationChainID>;
-        donationFinalAmount: number;
-        donationFinalChainId: OrStr<ChainID.V2DestinationChainID>;
-        donationFinalDenom: string;
-        donationFinalTxDate: ISODate;
-        donationFinalTxHash: string;
-        baseFee: number;
-        processingFee: number;
-        fiscalSponsorFee: number;
-        referrer_commission?: ReferrerCommission;
-        fund_id?: string;
-        fund_name?: string;
-        fund_tx?: string;
-        company_name?: string;
-        allocation?: Allocation;
-    };
-    type NonKeyAttributes = {
-        addressComplement?: " ";
-        /** one record with this value */
-        apesComplianceNewRecipient?: 4;
-        apesComplianceReviewStatus?: ApesComplianceReviewStatus;
-        apesComplianceTimeWindow?: ISODate;
-        /** source chainID */
-        chainId?: ChainID.V2SupportedChainID
-        /** terra */
-         | "bombay-12" | "columbus-5" | "uni-4" | "uni-5";
-        /** string charityId is terra endow address */
-        charityId?: string | number;
-        consent_marketing?: boolean;
-        consent_tax?: boolean;
-        cryptoFee?: number;
-        donationFinalChainId?: ChainID.V2DestinationChainID | "juno-1" | "staging" | "uni-4" | "uni-5";
-        fiscalSponsorshipFee?: number;
-        /** @deprecated */
-        fundId?: number;
-        /** @deprecated only one record with this value */
-        fundMembers?: string[];
-        name?: string;
-        nftAddress?: string;
-        nftRequested?: boolean;
-        receiptRequested?: boolean;
-        stateAddress?: string;
-        /** initialized as "null" */
-        swapDenomination?: string;
-        swapFinalAmount?: number;
-        swapFinished?: boolean;
-        swapStarted?: boolean;
-        taxReceiptId?: string;
-        tcaAssociation?: string;
-        transactionDate: ISODate;
-        ustFinal?: number;
-    } & PartialV2Kyc & Partial<Omit<V2NonKeyAttributes, "chainId" | "donationFinalChainId" | "transactionDate">>;
-    type DBRecord = PrimaryKey & AppUsed_IndexKey & Checked_8283_IndexKey & EmailIndexKey & EndowmentId_IndexKey & FiatRamp_IndexKey & FundDeposits_IndexKey & Network_FinalizedDate_IndexKey & Tax_Receipt_Sent_IndexKey & WalletAddress_Index & NonKeyAttributes;
-    type WithoutKYC = {
-        kycEmail?: never;
-    };
-    type WithKYC = V2Kyc;
-    /** 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 & 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 */
-    WalletAddress_Index & Required<EndowmentId_IndexKey> & Required<AppUsed_IndexKey> & (WithKYC | WithoutKYC);
-    type TributeNotif = {
-        toFullName: string;
-        toEmail: string;
-        /** may be empty `""` */
-        fromMsg: string;
-    };
-    /** web-app determinant: show signup page or not*/
-    type GuestDonor = {
-        email: string;
-        fullName: string;
-    };
-}
-export declare namespace OnHoldDonation {
-    type PrimaryKey = {
-        transactionId: string;
-    };
-    type Index = "Email_Index" | "EndowmentId_Index" | "fiatRamp_Index";
-    type ApesAttributes = {
-        client: Extract<Donation.Client, "apes">;
-        apesComplianceReviewStatus: Donation.ApesComplianceReviewStatus;
-        apesComplianceTimeWindow: ISODate;
-    };
-    type CryptoAttributes = {
-        chainId: ChainID.V2CryptoChainID;
-        destinationChainId: Exclude<ChainID.V2DestinationChainID, "fiat">;
-        walletAddress: string;
-        /** status of this record should NOT be changed by our pipelines */
-        third_party?: true;
-        /** Nowpayments: number, custom: uuid */
-        payment_id?: number | string;
-    };
-    type FiatAttributes = {
-        chainId: ChainID.V2FiatChainID;
-        destinationChainId: Extract<ChainID.V2DestinationChainID, "fiat">;
-        /** we can only know the method once it's confirmed by webhook */
-        paymentMethod?: string;
-        /** only exists if donor opts for manual bank verification */
-        stripeDepositVerifyUrl?: string;
-    };
-    type NonKeyAttributes = {
-        /** tip, fee-allowance is included*/
-        amount: number;
-        /** tip, fee-allowance is included*/
-        usdValue: number;
-        /** same denomination as amount */
-        tipAmount?: number;
-        /** same denomination as amount */
-        feeAllowance?: number;
-        appUsed: Donation.App;
-        chainName: string;
-        /** fund name or npo name, as onhold records not yet distributed */
-        charityName: string;
-        nonProfitMsg?: string;
-        /** upper case */
-        denomination: string;
-        donationFinalized: boolean;
-        endowmentId: number;
-        /** donation to fund */
-        fund_id?: string;
-        /** donation to fund */
-        fund_name?: string;
-        /** endowment ids */
-        fund_members?: number[];
-        /** program donation: may be empty `""`*/
-        programId?: string;
-        programName?: string;
-        claimed: boolean;
-        fiscalSponsored: boolean;
-        hideBgTip?: boolean;
-        network: Environment;
-        /** "0" - "100" */
-        splitLiq: string;
-        status?: "intent" | "pending";
-        transactionDate: ISODate;
-        /** TTL attribute */
-        expireAt?: number;
-        /** for new records only: `true` is recurring */
-        isRecurring?: boolean;
-        /** honorary full name - may be empty `''` */
-        inHonorOf?: string;
-        /** only allowed if honoree is provided */
-        tributeNotif?: Donation.TributeNotif;
-        donor_message?: string;
-        msg_to_npo?: string;
-        donor_public?: boolean;
-        company_name?: string;
-        allocation?: Allocation;
-    } & (ApesAttributes | EmptyObject) & (Donation.WithKYC | Donation.WithoutKYC);
-    type CryptoDBRecord = PrimaryKey & NonKeyAttributes & CryptoAttributes & Donation.EmailIndexKey;
-    type FiatDBRecord = PrimaryKey & Required<Donation.FiatRamp_IndexKey> & NonKeyAttributes & FiatAttributes & Required<Donation.EmailIndexKey>;
-    type DBRecord = CryptoDBRecord | FiatDBRecord;
-    /** Only used when donation is finalized and ready for transfer to Donations DB */
-}
-export declare namespace FiatDonations {
-    type Currency = {
-        /** lowercase ISO 4217 code */
-        currency_code: string;
-        minimum_amount: number;
-        rate: number;
-        timestamp: string;
-    };
-}
-export declare namespace PayPalDonation {
-    type CreateOrder = {
-        purchase_units: PurchaseUnit[];
-        intent: Intent;
-        payment_source?: PaymentSource;
-    };
-    type Order = {
-        id: string;
-        status: Status;
-        intent: Intent;
-        payment_source: PaymentSource;
-        purchase_units: PurchaseUnit[];
-        payer: Payer;
-        create_time: Date;
-        links: Link[];
-    };
-    type Link = {
-        href: string;
-        rel: string;
-        method: string;
-    };
-    type Payer = {
-        name: Name;
-        email_address: string;
-        payer_id: string;
-    };
-    type PaymentSource = {
-        paypal: {
-            name: Name;
-            email_address: string;
-            account_id: string;
-        };
-    };
-    type Name = {
-        given_name: string;
-        surname: string;
-    };
-    type PurchaseUnit = {
-        amount: {
-            /** Three-character ISO-4217 code. */
-            currency_code: string;
-            value: string;
-        };
-        /** @link https://developer.paypal.com/docs/api/orders/v2/#orders_get */
-        payments?: {
-            captures: CapturedPayment[];
-        };
-    };
-    type CapturedPayment = {
-        seller_receivable_breakdown: {
-            gross_amount: {
-                value: number;
-            };
-            paypal_fee: {
-                value: number;
-            };
-            net_amount: {
-                value: number;
-            };
-        };
-    };
-    type Intent = "CAPTURE" | "AUTHORIZE";
-    type Status = "CREATED" | "SAVED" | "APPROVED" | "VOIDED" | "COMPLETED" | "PAYER_ACTION_REQUIRED";
-}

package/dist/donation.mjs

@@ -1 +0,0 @@
-export {};

package/dist/final-recorder.d.mts

@@ -1,18 +0,0 @@
-import type { Donation } from "./donation.mjs";
-type FinalRecord = Pick<Donation.V2DBRecord, "amount" | "appUsed" | "chainName" | "charityName" | "claimed" | "denomination" | "email" | "endowmentId" | "feeAllowance" | "fiatRamp" | "fiscalSponsored" | "inHonorOf" | "isRecurring" | "network" | "nonProfitMsg" | "paymentMethod" | "programId" | "programName" | "splitLiq" | "tipAmount" | "transactionDate" | "transactionId" | "tributeNotif" | "usdValue">;
-interface SettledAmounts {
-    settledFee: number;
-    settledNet: number;
-}
-/** donation is to fund */
-interface Fund {
-    fund_id?: string;
-    fund_name?: string;
-    fund_members?: number[];
-}
-export type FinalRecorderPayload = {
-    /** intent to delete */
-    intentId?: string;
-    hideBgTip: boolean;
-} & FinalRecord & SettledAmounts & Fund & (Donation.WithKYC | Donation.WithoutKYC);
-export {};

package/dist/final-recorder.mjs

@@ -1 +0,0 @@
-export {};

package/dist/get-min-fee-allowance.d.mts

@@ -1,7 +0,0 @@
-/**
- * @param amount endow amount + tip
- * @param rate 0-1, to be applied to amount @example `amount * rate`
- * @param flat flat amount added to `amount * rate`. NOTE: make sure that this is in the same unit as `amount`
- * @returns number
- */
-export declare const getMinFeeAllowance: (amount: number, rate: number, flat?: number) => number;

package/dist/get-min-fee-allowance.mjs

@@ -1,16 +0,0 @@
-/**
- * @param amount endow amount + tip
- * @param rate 0-1, to be applied to amount @example `amount * rate`
- * @param flat flat amount added to `amount * rate`. NOTE: make sure that this is in the same unit as `amount`
- * @returns number
- */
-export const getMinFeeAllowance = (amount, rate, flat = 0) => {
-    /**
-     * fee(1) = amount * rate + flat
-     * fee(2) = (amount + fee(1)) * rate + flat
-     * fee(3) = (amount + fee(2)) * rate + flat
-     * i.e. F₍ₙ₎ = a · ∑ᵏ⁼¹ⁿ (rᵏ) + f · ∑ᵏ⁼⁰ⁿ⁻¹ (rᵏ)
-     * which converges to this formula: n approaches infinity
-     */
-    return (amount * rate + flat) / (1 - rate);
-};

package/dist/intent.d.mts

@@ -1,110 +0,0 @@
-import * as v from "valibot";
-export declare const frequencies: readonly ["one-time", "recurring"];
-export declare const frequency: v.PicklistSchema<readonly ["one-time", "recurring"], undefined>;
-export type Frequency = v.InferOutput<typeof frequency>;
-export declare const donationSources: readonly ["bg-marketplace", "bg-widget", "tester-app"];
-export declare const donationSource: v.PicklistSchema<readonly ["bg-marketplace", "bg-widget", "tester-app"], undefined>;
-export type DonationSource = v.InferOutput<typeof donationSource>;
-export declare const donorTitles: readonly ["Mr", "Mrs", "Ms", "Mx", ""];
-export declare const donorTitle: v.PicklistSchema<readonly ["Mr", "Mrs", "Ms", "Mx", ""], undefined>;
-export type DonorTitle = v.InferOutput<typeof donorTitle>;
-export declare const donorAddress: v.ObjectSchema<{
-    readonly street: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-    readonly city: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-    readonly state: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>, never>;
-    readonly zipCode: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>, never>;
-    /** country name */
-    readonly country: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-    readonly ukGiftAid: v.OptionalSchema<v.BooleanSchema<undefined>, never>;
-}, undefined>;
-export type DonorAddress = v.InferOutput<typeof donorAddress>;
-export declare const donor: v.ObjectSchema<{
-    readonly title: v.PicklistSchema<readonly ["Mr", "Mrs", "Ms", "Mx", ""], undefined>;
-    readonly firstName: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-    readonly lastName: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-    readonly email: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.EmailAction<string, undefined>]>;
-    readonly address: v.OptionalSchema<v.ObjectSchema<{
-        readonly street: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-        readonly city: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-        readonly state: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>, never>;
-        readonly zipCode: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>, never>;
-        /** country name */
-        readonly country: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-        readonly ukGiftAid: v.OptionalSchema<v.BooleanSchema<undefined>, never>;
-    }, undefined>, never>;
-}, undefined>;
-export type Donor = v.InferOutput<typeof donor>;
-export declare const amount: v.ObjectSchema<{
-    readonly amount: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 0, undefined>]>;
-    readonly currency: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-    readonly tip: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 0, undefined>]>;
-    readonly feeAllowance: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 0, undefined>]>;
-}, undefined>;
-export type Amount = v.InferOutput<typeof amount>;
-export declare const endowId: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.TransformAction<string, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>;
-export declare const uuid: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.UuidAction<string, undefined>]>;
-export declare const program: v.ObjectSchema<{
-    readonly id: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.UuidAction<string, undefined>]>;
-    readonly name: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-}, undefined>;
-export type Program = v.InferOutput<typeof program>;
-export declare const recipient: v.UnionSchema<[v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.TransformAction<string, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>, v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.UuidAction<string, undefined>]>], undefined>;
-export type Recipient = v.InferOutput<typeof recipient>;
-export declare const tributeNotif: v.ObjectSchema<{
-    readonly toEmail: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.EmailAction<string, undefined>]>;
-    readonly toFullName: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-    readonly fromMsg: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.MaxLengthAction<string, 250, undefined>]>;
-}, undefined>;
-export type TributeNotif = v.InferOutput<typeof tributeNotif>;
-export declare const tribute: v.ObjectSchema<{
-    readonly fullName: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-    readonly notif: v.OptionalSchema<v.ObjectSchema<{
-        readonly toEmail: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.EmailAction<string, undefined>]>;
-        readonly toFullName: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-        readonly fromMsg: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.MaxLengthAction<string, 250, undefined>]>;
-    }, undefined>, never>;
-}, undefined>;
-export type Tribute = v.InferOutput<typeof tribute>;
-export declare const intent: v.ObjectSchema<{
-    readonly amount: v.ObjectSchema<{
-        readonly amount: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 0, undefined>]>;
-        readonly currency: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-        readonly tip: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 0, undefined>]>;
-        readonly feeAllowance: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 0, undefined>]>;
-    }, undefined>;
-    readonly recipient: v.UnionSchema<[v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.TransformAction<string, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>, v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.UuidAction<string, undefined>]>], undefined>;
-    readonly program: v.OptionalSchema<v.ObjectSchema<{
-        readonly id: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.UuidAction<string, undefined>]>;
-        readonly name: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-    }, undefined>, never>;
-    readonly donor: v.ObjectSchema<{
-        readonly title: v.PicklistSchema<readonly ["Mr", "Mrs", "Ms", "Mx", ""], undefined>;
-        readonly firstName: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-        readonly lastName: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-        readonly email: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.EmailAction<string, undefined>]>;
-        readonly address: v.OptionalSchema<v.ObjectSchema<{
-            readonly street: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-            readonly city: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-            readonly state: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>, never>;
-            readonly zipCode: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>, never>;
-            /** country name */
-            readonly country: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-            readonly ukGiftAid: v.OptionalSchema<v.BooleanSchema<undefined>, never>;
-        }, undefined>, never>;
-    }, undefined>;
-    readonly source: v.PicklistSchema<readonly ["bg-marketplace", "bg-widget", "tester-app"], undefined>;
-    readonly tribute: v.OptionalSchema<v.ObjectSchema<{
-        readonly fullName: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-        readonly notif: v.OptionalSchema<v.ObjectSchema<{
-            readonly toEmail: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.EmailAction<string, undefined>]>;
-            readonly toFullName: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-            readonly fromMsg: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.MaxLengthAction<string, 250, undefined>]>;
-        }, undefined>, never>;
-    }, undefined>, never>;
-    readonly frequency: v.PicklistSchema<readonly ["one-time", "recurring"], undefined>;
-    /** chain name, etc. */
-    readonly viaName: v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>;
-    /** chain id, workflow-session-id, etc. */
-    readonly viaId: v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>;
-}, undefined>;
-export type DonationIntent = v.InferOutput<typeof intent>;

package/dist/intent.mjs

@@ -1,65 +0,0 @@
-import * as v from "valibot";
-const str = v.pipe(v.string(), v.trim());
-const requiredStr = v.pipe(str, v.nonEmpty());
-export const frequencies = ["one-time", "recurring"];
-export const frequency = v.picklist(frequencies);
-export const donationSources = [
-    "bg-marketplace",
-    "bg-widget",
-    "tester-app",
-];
-export const donationSource = v.picklist(donationSources);
-export const donorTitles = ["Mr", "Mrs", "Ms", "Mx", ""];
-export const donorTitle = v.picklist(donorTitles);
-export const donorAddress = v.object({
-    street: requiredStr,
-    city: requiredStr,
-    state: v.optional(requiredStr),
-    zipCode: v.optional(requiredStr),
-    /** country name */
-    country: requiredStr,
-    ukGiftAid: v.optional(v.boolean()),
-});
-export const donor = v.object({
-    title: donorTitle,
-    firstName: requiredStr,
-    lastName: requiredStr,
-    email: v.pipe(str, v.email()),
-    address: v.optional(donorAddress),
-});
-const money = v.pipe(v.number(), v.minValue(0));
-export const amount = v.object({
-    amount: money,
-    currency: requiredStr,
-    tip: money,
-    feeAllowance: money,
-});
-export const endowId = v.pipe(str, v.transform((x) => +x), v.number(), v.integer(), v.minValue(1));
-export const uuid = v.pipe(str, v.uuid());
-export const program = v.object({
-    id: uuid,
-    name: requiredStr,
-});
-export const recipient = v.union([endowId, uuid]);
-export const tributeNotif = v.object({
-    toEmail: v.pipe(str, v.email()),
-    toFullName: v.pipe(str, v.nonEmpty()),
-    fromMsg: v.pipe(str, v.maxLength(250)),
-});
-export const tribute = v.object({
-    fullName: requiredStr,
-    notif: v.optional(tributeNotif),
-});
-export const intent = v.object({
-    amount,
-    recipient,
-    program: v.optional(program),
-    donor,
-    source: donationSource,
-    tribute: v.optional(tribute),
-    frequency,
-    /** chain name, etc. */
-    viaName: str,
-    /** chain id, workflow-session-id, etc. */
-    viaId: str,
-});

package/dist/old-intent.d.mts

@@ -1,112 +0,0 @@
-import * as v from "valibot";
-import { type Frequency } from "./intent.mjs";
-export declare const oldIntent: v.SchemaWithPipe<[v.ObjectSchema<{
-    readonly transactionId: v.OptionalSchema<v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, never>;
-    readonly type: v.OptionalSchema<v.PicklistSchema<["one-time", "subscription"], undefined>, never>;
-    readonly amount: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 0, undefined>]>;
-    readonly tipAmount: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 0, undefined>]>;
-    readonly feeAllowance: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 0, undefined>]>;
-    readonly currency: v.OptionalSchema<v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, never>;
-    readonly endowmentId: v.SchemaWithPipe<[v.SchemaWithPipe<[v.NumberSchema<undefined>, v.IntegerAction<number, undefined>]>, v.MinValueAction<number, 1, undefined>]>;
-    readonly programId: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.UuidAction<string, undefined>]>, never>;
-    readonly programName: v.OptionalSchema<v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, never>;
-    readonly splitLiq: v.SchemaWithPipe<[v.SchemaWithPipe<[v.NumberSchema<undefined>, v.IntegerAction<number, undefined>]>, v.MinValueAction<number, 0, undefined>, v.MaxValueAction<number, 100, undefined>]>;
-    readonly donor: v.ObjectSchema<{
-        readonly title: v.PicklistSchema<readonly ["Mr", "Mrs", "Ms", "Mx", ""], undefined>;
-        readonly firstName: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-        readonly lastName: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-        readonly email: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.EmailAction<string, undefined>]>;
-        readonly address: v.OptionalSchema<v.ObjectSchema<{
-            readonly streetAddress: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-            readonly city: v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>;
-            readonly state: v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>;
-            readonly zipCode: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-            /** country name */
-            readonly country: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-        }, undefined>, never>;
-        readonly ukGiftAid: v.OptionalSchema<v.BooleanSchema<undefined>, never>;
-    }, undefined>;
-    readonly inHonorOf: v.OptionalSchema<v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, never>;
-    readonly tributeNotif: v.OptionalSchema<v.ObjectSchema<{
-        readonly toEmail: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.EmailAction<string, undefined>]>;
-        readonly toFullName: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>;
-        readonly fromMsg: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.MaxLengthAction<string, 250, undefined>]>;
-    }, undefined>, never>;
-    readonly source: v.PicklistSchema<readonly ["bg-marketplace", "bg-widget", "tester-app"], undefined>;
-    readonly denomination: v.OptionalSchema<v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, never>;
-    readonly chainId: v.OptionalSchema<v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, never>;
-    readonly chainName: v.OptionalSchema<v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, never>;
-}, undefined>, v.TransformAction<{
-    amount: number;
-    feeAllowance: number;
-    tipAmount: number;
-    splitLiq: number;
-    endowmentId: number;
-    donor: {
-        email: string;
-        title: "" | "Mr" | "Ms" | "Mrs" | "Mx";
-        firstName: string;
-        lastName: string;
-        ukGiftAid?: boolean | undefined;
-        address?: {
-            streetAddress: string;
-            city: string;
-            state: string;
-            zipCode: string;
-            country: string;
-        } | undefined;
-    };
-    source: "bg-marketplace" | "bg-widget" | "tester-app";
-    chainId?: string | undefined;
-    programId?: string | undefined;
-    programName?: string | undefined;
-    inHonorOf?: string | undefined;
-    tributeNotif?: {
-        toEmail: string;
-        toFullName: string;
-        fromMsg: string;
-    } | undefined;
-    denomination?: string | undefined;
-    chainName?: string | undefined;
-    transactionId?: string | undefined;
-    type?: "one-time" | "subscription" | undefined;
-    currency?: string | undefined;
-}, {
-    amount: {
-        amount: number;
-        currency: string;
-        tip: number;
-        feeAllowance: number;
-    };
-    recipient: number;
-    program: {
-        id: string;
-        name: string;
-    } | undefined;
-    donor: {
-        title: "" | "Mr" | "Ms" | "Mrs" | "Mx";
-        firstName: string;
-        lastName: string;
-        email: string;
-        address: {
-            street: string;
-            city: string;
-            state: string;
-            zipCode: string;
-            country: string;
-            ukGiftAid: boolean | undefined;
-        } | undefined;
-    };
-    source: "bg-marketplace" | "bg-widget" | "tester-app";
-    tribute: {
-        fullName: string;
-        notif: {
-            toEmail: string;
-            toFullName: string;
-            fromMsg: string;
-        } | undefined;
-    } | undefined;
-    frequency: Frequency;
-    viaName: string;
-    viaId: string;
-}>]>;

package/dist/old-intent.mjs

@@ -1,89 +0,0 @@
-import * as v from "valibot";
-import { donationSource, donorTitle, tributeNotif, uuid, } from "./intent.mjs";
-const str = v.pipe(v.string(), v.trim());
-const requiredStr = v.pipe(str, v.nonEmpty());
-const int = v.pipe(v.number(), v.integer());
-const money = v.pipe(v.number(), v.minValue(0));
-const donorAddress = v.object({
-    streetAddress: requiredStr,
-    city: str,
-    state: str,
-    zipCode: requiredStr,
-    /** country name */
-    country: requiredStr,
-});
-const donor = v.object({
-    title: donorTitle,
-    firstName: requiredStr,
-    lastName: requiredStr,
-    email: v.pipe(str, v.email()),
-    address: v.optional(donorAddress),
-    ukGiftAid: v.optional(v.boolean()),
-});
-export const oldIntent = v.pipe(v.object({
-    transactionId: v.optional(str),
-    type: v.optional(v.picklist(["one-time", "subscription"])),
-    amount: money,
-    tipAmount: money,
-    feeAllowance: money,
-    currency: v.optional(str),
-    endowmentId: v.pipe(int, v.minValue(1)),
-    programId: v.optional(uuid),
-    programName: v.optional(str),
-    splitLiq: v.pipe(int, v.minValue(0), v.maxValue(100)),
-    donor,
-    inHonorOf: v.optional(str),
-    tributeNotif: v.optional(tributeNotif),
-    source: donationSource,
-    denomination: v.optional(str),
-    chainId: v.optional(str),
-    chainName: v.optional(str),
-}), v.transform((input) => ({
-    amount: {
-        amount: input.amount,
-        currency: input.currency ? input.currency : input.denomination ?? "",
-        tip: input.tipAmount,
-        feeAllowance: input.feeAllowance,
-    },
-    recipient: input.endowmentId,
-    program: input.programId && input.programName
-        ? {
-            id: input.programId,
-            name: input.programName,
-        }
-        : undefined,
-    donor: {
-        title: input.donor.title,
-        firstName: input.donor.firstName,
-        lastName: input.donor.lastName,
-        email: input.donor.email,
-        address: input.donor.address
-            ? {
-                street: input.donor.address.streetAddress,
-                city: input.donor.address.city,
-                state: input.donor.address.state,
-                zipCode: input.donor.address.zipCode,
-                country: input.donor.address.country,
-                ukGiftAid: input.donor.ukGiftAid,
-            }
-            : undefined,
-    },
-    source: input.source,
-    tribute: input.inHonorOf
-        ? {
-            fullName: input.inHonorOf,
-            notif: input.tributeNotif
-                ? {
-                    toEmail: input.tributeNotif.toEmail,
-                    toFullName: input.tributeNotif.toFullName,
-                    fromMsg: input.tributeNotif.fromMsg,
-                }
-                : undefined,
-        }
-        : undefined,
-    frequency: (input.type === "subscription"
-        ? "recurring"
-        : input.type ?? "one-time"),
-    viaName: input.chainName ?? "fiat",
-    viaId: input.chainId ? input.chainId : input.transactionId ?? "fiat",
-})));

package/dist/subscription.d.mts

@@ -1,32 +0,0 @@
-import type { Environment } from "@better-giving/types/list";
-import type { Donation } from "./donation.mjs";
-export declare namespace Subscription {
-    interface PrimaryKey {
-        subscription_id: string;
-    }
-    interface NonKeyAttributes {
-        app_used: Donation.App;
-        charity_name: string;
-        customer_id: string;
-        email: string;
-        endowment_id: number;
-        fiat_ramp: "STRIPE";
-        fiscal_sponsored: boolean;
-        hide_bg_tip: boolean;
-        /** URL link to latest invoice */
-        latest_invoice?: string;
-        network: Environment;
-        product_id: string;
-        /**
-         * Determines overall price the user has to pay
-         * For example, we have a recurring subscription plan of $1 per month.
-         * If quantity is set to 2 then the user pays $2 per month
-         */
-        quantity: number;
-        split_liq: string;
-        /** @link https://docs.stripe.com/billing/subscriptions/overview#payment-status */
-        status: "active" | "incomplete";
-    }
-    interface DBRecord extends PrimaryKey, NonKeyAttributes {
-    }
-}

package/dist/subscription.mjs

@@ -1 +0,0 @@
-export {};