@better-giving/donation 1.1.20 → 2.0.1

package/dist/donation.d.mts

@@ -1,6 +1,7 @@
 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, Frequency } 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";
@@ -53,7 +54,6 @@ export declare namespace Donation {
     type WalletAddress_Index = {
         walletAddress?: string;
     };
-    type DonorTitle = "Mr" | "Ms" | "Mrs" | "Mx";
     type DonorBasicInfo = {
         /** may be empty */
         title?: DonorTitle;
@@ -136,6 +136,7 @@ export declare namespace Donation {
         fund_name?: string;
         fund_tx?: string;
         company_name?: string;
+        allocation?: Allocation;
     };
     type NonKeyAttributes = {
         addressComplement?: " ";
@@ -272,6 +273,7 @@ export declare namespace OnHoldDonation {
         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>;
@@ -286,7 +288,6 @@ export declare namespace FiatDonations {
         rate: number;
         timestamp: string;
     };
-    type Frequency = "one-time" | "subscription";
 }
 export declare namespace PayPalDonation {
     type CreateOrder = {
@@ -356,7 +357,7 @@ export declare namespace StripeDonation {
     /** DEPRECATED - can be removed eventually as existing records will eventually "expire" */
     type LegacyMetadata = {
         /** This attr will help in identifying PaymentIntents made for one-time donations only */
-        donation_type: Extract<FiatDonations.Frequency, "one-time">;
+        donation_type: Extract<Frequency, "one-time">;
         /** This attr will link the received webhook event to a donation intent */
         intent_tx_id: string;
     };
@@ -367,7 +368,7 @@ export declare namespace StripeDonation {
     type Metadata = {
         [K in keyof OnHoldDonation.FiatDBRecord]: string;
     } & {
-        title?: Donation.DonorTitle;
+        title?: DonorTitle;
         fullName: string;
         ukGiftAid: string;
         streetAddress?: string;

package/dist/schema.d.mts

@@ -0,0 +1,20 @@
+import * as v from "valibot";
+export declare const frequencies: readonly ["one-time", "recurring"];
+export declare const frequency: v.PicklistSchema<readonly ["one-time", "recurring"], "Please select donation frequency">;
+export type Frequency = v.InferOutput<typeof frequency>;
+export declare const donation_sources: readonly ["bg-marketplace", "bg-widget", "tester-app"];
+export declare const donation_source: v.PicklistSchema<readonly ["bg-marketplace", "bg-widget", "tester-app"], undefined>;
+export type DonationSource = v.InferOutput<typeof donation_source>;
+export declare const donor_titles: readonly ["Mr", "Mrs", "Ms", "Mx", ""];
+export declare const donor_title: v.PicklistSchema<readonly ["Mr", "Mrs", "Ms", "Mx", ""], undefined>;
+export type DonorTitle = v.InferOutput<typeof donor_title>;
+export declare const allocation: v.SchemaWithPipe<[v.ObjectSchema<{
+    readonly liq: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 0, undefined>, v.MaxValueAction<number, 100, undefined>]>;
+    readonly lock: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 0, undefined>, v.MaxValueAction<number, 100, undefined>]>;
+    readonly cash: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 0, undefined>, v.MaxValueAction<number, 100, undefined>]>;
+}, undefined>, v.CheckAction<{
+    liq: number;
+    lock: number;
+    cash: number;
+}, "Allocation must sum to 100%">]>;
+export type Allocation = v.InferOutput<typeof allocation>;

package/dist/schema.mjs

@@ -0,0 +1,17 @@
+import * as v from "valibot";
+export const frequencies = ["one-time", "recurring"];
+export const frequency = v.picklist(frequencies, "Please select donation frequency");
+export const donation_sources = [
+    "bg-marketplace",
+    "bg-widget",
+    "tester-app",
+];
+export const donation_source = v.picklist(donation_sources);
+export const donor_titles = ["Mr", "Mrs", "Ms", "Mx", ""];
+export const donor_title = v.picklist(donor_titles);
+const pct = v.pipe(v.number(), v.minValue(0), v.maxValue(100));
+export const allocation = v.pipe(v.object({
+    liq: pct,
+    lock: pct,
+    cash: pct,
+}), v.check((x) => x.liq + x.lock + x.cash === 100, "Allocation must sum to 100%"));

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@better-giving/donation",
-  "version": "1.1.20",
+  "version": "2.0.1",
   "devDependencies": {
     "@better-giving/config": "1.1.2"
   },
   "peerDependencies": {
     "@better-giving/types": "1.1.7",
-    "@better-giving/schemas": "1.1.2",
+    "@better-giving/schemas": "1.2.0",
     "valibot": "0.42.0"
   },
   "files": [

package/src/donation.mts

@@ -1,6 +1,7 @@
 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, Frequency } from "./schema.mjs";
 
 export declare namespace Donation {
   type Index =
@@ -91,7 +92,6 @@ export declare namespace Donation {
     walletAddress?: string; //PK
   };
 
-  type DonorTitle = "Mr" | "Ms" | "Mrs" | "Mx";
   type DonorBasicInfo = {
     /** may be empty */
     title?: DonorTitle;
@@ -186,6 +186,7 @@ export declare namespace Donation {
     fund_tx?: string;
 
     company_name?: string;
+    allocation?: Allocation;
   };
 
   type NonKeyAttributes = {
@@ -375,6 +376,7 @@ export declare namespace OnHoldDonation {
     msg_to_npo?: string;
     donor_public?: boolean;
     company_name?: string;
+    allocation?: Allocation;
   } & (ApesAttributes | EmptyObject) &
     (Donation.WithKYC | Donation.WithoutKYC);
 
@@ -402,8 +404,6 @@ export declare namespace FiatDonations {
     rate: number;
     timestamp: string;
   };
-
-  type Frequency = "one-time" | "subscription";
 }
 
 export declare namespace PayPalDonation {
@@ -486,7 +486,7 @@ export declare namespace StripeDonation {
   /** DEPRECATED - can be removed eventually as existing records will eventually "expire" */
   type LegacyMetadata = {
     /** This attr will help in identifying PaymentIntents made for one-time donations only */
-    donation_type: Extract<FiatDonations.Frequency, "one-time">;
+    donation_type: Extract<Frequency, "one-time">;
     /** This attr will link the received webhook event to a donation intent */
     intent_tx_id: string;
   };
@@ -499,7 +499,7 @@ export declare namespace StripeDonation {
     [K in keyof OnHoldDonation.FiatDBRecord]: string;
   } & {
     // KYC fields
-    title?: Donation.DonorTitle;
+    title?: DonorTitle;
     fullName: string;
     ukGiftAid: string;
     streetAddress?: string;

package/src/schema.mts

@@ -0,0 +1,34 @@
+import * as v from "valibot";
+export const frequencies = ["one-time", "recurring"] as const;
+export const frequency = v.picklist(
+  frequencies,
+  "Please select donation frequency"
+);
+
+export type Frequency = v.InferOutput<typeof frequency>;
+
+export const donation_sources = [
+  "bg-marketplace",
+  "bg-widget",
+  "tester-app",
+] as const;
+
+export const donation_source = v.picklist(donation_sources);
+export type DonationSource = v.InferOutput<typeof donation_source>;
+
+export const donor_titles = ["Mr", "Mrs", "Ms", "Mx", ""] as const;
+export const donor_title = v.picklist(donor_titles);
+
+export type DonorTitle = v.InferOutput<typeof donor_title>;
+
+const pct = v.pipe(v.number(), v.minValue(0), v.maxValue(100));
+export const allocation = v.pipe(
+  v.object({
+    liq: pct,
+    lock: pct,
+    cash: pct,
+  }),
+  v.check((x) => x.liq + x.lock + x.cash === 100, "Allocation must sum to 100%")
+);
+
+export type Allocation = v.InferOutput<typeof allocation>;

package/src/intent.mts

@@ -1,111 +0,0 @@
-import * as v from "valibot";
-
-const str = v.pipe(v.string(), v.trim());
-const required_str = v.pipe(str, v.nonEmpty());
-
-export const frequencies = ["one-time", "recurring"] as const;
-export const frequency = v.picklist(frequencies);
-
-export type Frequency = v.InferOutput<typeof frequency>;
-
-export const donation_sources = [
-  "bg-marketplace",
-  "bg-widget",
-  "tester-app",
-] as const;
-
-export const donation_source = v.picklist(donation_sources);
-export type DonationSource = v.InferOutput<typeof donation_source>;
-
-export const donor_titles = ["Mr", "Mrs", "Ms", "Mx", ""] as const;
-export const donor_title = v.picklist(donor_titles);
-
-export type DonorTitle = v.InferOutput<typeof donor_title>;
-
-export const donor_address = v.object({
-  street: required_str,
-  city: required_str,
-  state: v.optional(required_str),
-  zip_code: v.optional(required_str),
-  /** country name */
-  country: required_str,
-  uk_gift_aid: v.optional(v.boolean()),
-});
-
-export type DonorAddress = v.InferOutput<typeof donor_address>;
-
-export const donor = v.object({
-  title: donor_title,
-  first_name: required_str,
-  company_name: v.optional(str),
-  last_name: required_str,
-  email: v.pipe(str, v.email()),
-  address: v.optional(donor_address),
-});
-
-export type Donor = v.InferOutput<typeof donor>;
-
-const money = v.pipe(v.number(), v.minValue(0));
-
-export const amount = v.object({
-  amount: money,
-  currency: v.pipe(required_str, v.toUpperCase()),
-  tip: money,
-  fee_allowance: money,
-});
-
-export type Amount = v.InferOutput<typeof amount>;
-
-export const endow_id = 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: required_str,
-});
-
-export type Program = v.InferOutput<typeof program>;
-
-export const recipient = v.union([endow_id, uuid]);
-
-export type Recipient = v.InferOutput<typeof recipient>;
-
-export const tribute_notif = v.object({
-  to_email: v.pipe(str, v.email()),
-  to_fullname: v.pipe(str, v.nonEmpty()),
-  from_msg: v.pipe(str, v.maxLength(250)),
-});
-
-export type TributeNotif = v.InferOutput<typeof tribute_notif>;
-
-export const tribute = v.object({
-  full_name: required_str,
-  notif: v.optional(tribute_notif),
-});
-
-export type Tribute = v.InferOutput<typeof tribute>;
-
-export const intent = v.object({
-  amount,
-  recipient,
-  program: v.optional(program),
-  donor,
-  donor_message: v.optional(v.pipe(required_str, v.maxLength(500))),
-  donor_public: v.optional(v.boolean()),
-  msg_to_npo: v.optional(v.pipe(required_str, v.maxLength(500))),
-  source: donation_source,
-  tribute: v.optional(tribute),
-  frequency,
-  /** chain name, etc. */
-  via_name: str,
-  /** chain id, workflow-session-id, etc. */
-  via_id: str,
-});
-
-export type DonationIntent = v.InferOutput<typeof intent>;