@better-giving/donation 1.0.8 → 1.0.12

package/dist/donation.d.mts

@@ -75,6 +75,8 @@ export declare namespace Donation {
         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;

package/dist/final-recorder.d.mts

@@ -1,5 +1,5 @@
 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" | "usdValue">;
+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;

package/dist/old-intent.d.mts

@@ -0,0 +1,112 @@
+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

@@ -0,0 +1,89 @@
+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/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@better-giving/donation",
-  "version": "1.0.8",
+  "version": "1.0.12",
   "devDependencies": {
     "@better-giving/config": "workspace:*"
   },
   "peerDependencies": {
-    "@better-giving/types": "1.0.3",
+    "@better-giving/types": "1.0.5",
     "valibot": "0.42.0"
   },
   "files": [

package/src/donation.mts

@@ -113,6 +113,8 @@ export declare namespace Donation {
     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;

package/src/final-recorder.mts

@@ -24,6 +24,7 @@ type FinalRecord = Pick<
   | "tipAmount"
   | "transactionDate"
   | "transactionId"
+  | "tributeNotif"
   | "usdValue"
 >;
 

package/src/old-intent.mts

@@ -0,0 +1,104 @@
+import * as v from "valibot";
+import {
+  type Frequency,
+  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") as Frequency,
+    viaName: input.chainName ?? "fiat",
+    viaId: input.chainId ? input.chainId : input.transactionId ?? "fiat",
+  }))
+);