@better-giving/donation 1.1.3 → 1.1.5

package/dist/donation-message.d.mts

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

package/dist/donation-message.mjs

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

package/dist/donation.d.mts

@@ -292,6 +292,8 @@ export declare namespace OnHoldDonation {
         inHonorOf?: string;
         /** only allowed if honoree is provided */
         tributeNotif?: Donation.TributeNotif;
+        donor_message?: string;
+        donor_public?: boolean;
     } & (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>;

package/dist/intent.d.mts

@@ -92,6 +92,8 @@ export declare const intent: v.ObjectSchema<{
             readonly ukGiftAid: v.OptionalSchema<v.BooleanSchema<undefined>, never>;
         }, undefined>, never>;
     }, undefined>;
+    readonly donor_message: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, undefined>]>, v.MaxLengthAction<string, 500, undefined>]>, never>;
+    readonly donor_public: v.OptionalSchema<v.BooleanSchema<undefined>, never>;
     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>]>;

package/dist/intent.mjs

@@ -55,6 +55,8 @@ export const intent = v.object({
     recipient,
     program: v.optional(program),
     donor,
+    donor_message: v.optional(v.pipe(requiredStr, v.maxLength(500))),
+    donor_public: v.optional(v.boolean()),
     source: donationSource,
     tribute: v.optional(tribute),
     frequency,

package/package.json

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

package/src/donation-message.mts

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

package/src/donation.mts

@@ -339,7 +339,7 @@ export declare namespace OnHoldDonation {
     /** status of this record should NOT be changed by our pipelines */
     third_party?: true;
     /** Nowpayments: number, custom: uuid */
-    payment_id?: number | string; 
+    payment_id?: number | string;
   };
 
   type FiatAttributes = {
@@ -349,8 +349,6 @@ export declare namespace OnHoldDonation {
     paymentMethod?: string;
     /** only exists if donor opts for manual bank verification */
     stripeDepositVerifyUrl?: string;
-    // TODO: create donation intents for subscriptions as well, then uncomment the below line
-    // frequency: FiatDonations.Frequency;
   };
 
   type NonKeyAttributes = {
@@ -396,6 +394,8 @@ export declare namespace OnHoldDonation {
     inHonorOf?: string;
     /** only allowed if honoree is provided */
     tributeNotif?: Donation.TributeNotif;
+    donor_message?: string;
+    donor_public?: boolean;
   } & (ApesAttributes | EmptyObject) &
     (Donation.WithKYC | Donation.WithoutKYC);
 

package/src/intent.mts

@@ -95,6 +95,8 @@ export const intent = v.object({
   recipient,
   program: v.optional(program),
   donor,
+  donor_message: v.optional(v.pipe(requiredStr, v.maxLength(500))),
+  donor_public: v.optional(v.boolean()),
   source: donationSource,
   tribute: v.optional(tribute),
   frequency,