@better-giving/donation 3.0.4 → 3.0.5

package/dist/paypal.d.mts

@@ -0,0 +1,73 @@
+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/paypal.mjs

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

package/dist/schema.d.mts

@@ -1,13 +1,13 @@
 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 type TFrequency = 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 type TDonationSource = 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 type TDonorTitle = 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>]>;
@@ -17,4 +17,38 @@ export declare const allocation: v.SchemaWithPipe<[v.ObjectSchema<{
     lock: number;
     cash: number;
 }, "Allocation must sum to 100%">]>;
-export type Allocation = v.InferOutput<typeof allocation>;
+export type IAllocation = v.InferOutput<typeof allocation>;
+export declare const page_opts: v.ObjectSchema<{
+    readonly limit: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<"required">, v.TrimAction]>, v.TransformAction<string, number>, v.SchemaWithPipe<[v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>]>, never>;
+    readonly next: v.OptionalSchema<v.SchemaWithPipe<[v.StringSchema<undefined>, v.Base64Action<string, undefined>]>, never>;
+}, undefined>;
+export interface IPageOpts extends v.InferOutput<typeof page_opts> {
+}
+declare const donations_search_raw: v.ObjectSchema<{
+    readonly date_start: v.OptionalSchema<v.LazySchema<v.StringSchema<undefined> | v.SchemaWithPipe<[v.StringSchema<undefined>, v.NonEmptyAction<string, "required">]> | v.SchemaWithPipe<[v.StringSchema<undefined>, v.TransformAction<string, Date>, v.DateSchema<"invalid date">, v.MaxValueAction<Date, Date, "can't be later than today">, v.TransformAction<Date, string>]>>, never>;
+    readonly date_end: v.OptionalSchema<v.LazySchema<v.StringSchema<undefined> | v.SchemaWithPipe<[v.StringSchema<undefined>, v.NonEmptyAction<string, "required">]> | v.SchemaWithPipe<[v.StringSchema<undefined>, v.TransformAction<string, Date>, v.DateSchema<"invalid date">, v.MaxValueAction<Date, Date, "can't be later than today">, v.TransformAction<Date, string>]>>, never>;
+    readonly limit: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<"required">, v.TrimAction]>, v.TransformAction<string, number>, v.SchemaWithPipe<[v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>]>, never>;
+    readonly next: v.OptionalSchema<v.SchemaWithPipe<[v.StringSchema<undefined>, v.Base64Action<string, undefined>]>, never>;
+}, undefined>;
+export declare const donations_search: v.SchemaWithPipe<[v.ObjectSchema<{
+    readonly date_start: v.OptionalSchema<v.LazySchema<v.StringSchema<undefined> | v.SchemaWithPipe<[v.StringSchema<undefined>, v.NonEmptyAction<string, "required">]> | v.SchemaWithPipe<[v.StringSchema<undefined>, v.TransformAction<string, Date>, v.DateSchema<"invalid date">, v.MaxValueAction<Date, Date, "can't be later than today">, v.TransformAction<Date, string>]>>, never>;
+    readonly date_end: v.OptionalSchema<v.LazySchema<v.StringSchema<undefined> | v.SchemaWithPipe<[v.StringSchema<undefined>, v.NonEmptyAction<string, "required">]> | v.SchemaWithPipe<[v.StringSchema<undefined>, v.TransformAction<string, Date>, v.DateSchema<"invalid date">, v.MaxValueAction<Date, Date, "can't be later than today">, v.TransformAction<Date, string>]>>, never>;
+    readonly limit: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<"required">, v.TrimAction]>, v.TransformAction<string, number>, v.SchemaWithPipe<[v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>]>, never>;
+    readonly next: v.OptionalSchema<v.SchemaWithPipe<[v.StringSchema<undefined>, v.Base64Action<string, undefined>]>, never>;
+}, undefined>, v.BaseValidation<{
+    limit?: number | undefined;
+    next?: string | undefined;
+    date_start?: string | undefined;
+    date_end?: string | undefined;
+}, {
+    limit?: number | undefined;
+    next?: string | undefined;
+    date_start?: string | undefined;
+    date_end?: string | undefined;
+}, v.PartialCheckIssue<{
+    date_start?: string | undefined;
+    date_end?: string | undefined;
+}>>]>;
+export interface IDonationsSearch extends v.InferOutput<typeof donations_search_raw> {
+}
+export {};

package/dist/schema.mjs

@@ -1,3 +1,5 @@
+import { $int_gte1 } from "@better-giving/schemas";
+import { iso_date, startOfDay, endOfDay } from "@better-giving/schemas/date";
 import * as v from "valibot";
 export const frequencies = ["one-time", "recurring"];
 export const frequency = v.picklist(frequencies, "Please select donation frequency");
@@ -15,3 +17,15 @@ export const allocation = v.pipe(v.object({
     lock: pct,
     cash: pct,
 }), v.check((x) => x.liq + x.lock + x.cash === 100, "Allocation must sum to 100%"));
+export const page_opts = v.object({
+    limit: v.optional($int_gte1),
+    next: v.optional(v.pipe(v.string(), v.base64())),
+});
+const donations_search_raw = v.object({
+    ...page_opts.entries,
+    date_start: v.optional(iso_date(startOfDay)),
+    date_end: v.optional(iso_date(endOfDay)),
+});
+export const donations_search = v.pipe(donations_search_raw, v.forward(v.partialCheck([["date_start"], ["date_end"]], ({ date_start: a, date_end: b }) => {
+    return a && b ? a <= b : true;
+}, "start date must be earlier than end date"), ["date_start"]));

package/dist/subscriptions-db.d.mts

@@ -0,0 +1,11 @@
+import type { ISubscription } from "./interfaces.mjs";
+import { Db } from "@better-giving/db";
+export declare class SubsDb extends Db {
+    static readonly table = "subscriptions";
+    key(id: string): {
+        subscription_id: string;
+    };
+    put(data: ISubscription): Promise<import("@aws-sdk/lib-dynamodb").PutCommandOutput>;
+    update(id: string, data: Partial<Omit<ISubscription, "subscription_id">>): Promise<ISubscription>;
+    del(id: string): Promise<import("@aws-sdk/lib-dynamodb").DeleteCommandOutput>;
+}

package/dist/subscriptions-db.mjs

@@ -0,0 +1,35 @@
+import { DeleteCommand, PutCommand, UpdateCommand, } from "@aws-sdk/lib-dynamodb";
+import { Db, UpdateBuilder } from "@better-giving/db";
+export class SubsDb extends Db {
+    static table = "subscriptions";
+    key(id) {
+        return { subscription_id: id };
+    }
+    async put(data) {
+        const cmd = new PutCommand({
+            TableName: SubsDb.table,
+            Item: data,
+            ConditionExpression: `attribute_not_exists(${"subscription_id"})`,
+        });
+        return this.client.send(cmd);
+    }
+    async update(id, data) {
+        const upd8 = new UpdateBuilder();
+        for (const k in data) {
+            upd8.set(k, data[k]);
+        }
+        const cmd = new UpdateCommand({
+            TableName: SubsDb.table,
+            Key: this.key(id),
+            ...upd8.collect(),
+        });
+        return this.client.send(cmd).then((r) => r.Attributes);
+    }
+    async del(id) {
+        const cmd = new DeleteCommand({
+            TableName: SubsDb.table,
+            Key: this.key(id),
+        });
+        return this.client.send(cmd);
+    }
+}

package/package.json

@@ -1,20 +1,23 @@
 {
   "name": "@better-giving/donation",
-  "version": "3.0.4",
+  "version": "3.0.5",
   "devDependencies": {
     "@better-giving/config": "1.1.2"
   },
   "peerDependencies": {
     "@better-giving/types": "1.1.8",
+    "@better-giving/db": "2.0.6",
     "@better-giving/schemas": "2.0.3",
-    "valibot": "0.42.0"
+    "@aws-sdk/lib-dynamodb": "3.485.0",
+    "valibot": "0.42.0",
+    "date-fns": "4.1.0"
   },
   "files": [
     "src",
     "dist"
   ],
   "exports": {
-    ".": "./dist/donation.mjs",
+    ".": "./dist/index.mjs",
     "./*": "./dist/*.mjs"
   },
   "scripts": {

package/src/donation-msgs-db.mts

@@ -0,0 +1,73 @@
+import { Db } from "@better-giving/db";
+import type { ISODate } from "@better-giving/types/alias";
+import type { Environment } from "@better-giving/types/list";
+import type { IPageOpts } from "./schema.mjs";
+import { QueryCommand } from "@aws-sdk/lib-dynamodb";
+import type { IPageKeyed } from "@better-giving/types/api";
+import type { IPublicDonor } from "./interfaces.mjs";
+
+export type DMKey = `DM#${string}`;
+
+export class DonationDonorsDb extends Db {
+  static readonly table = "donation_messages";
+  static readonly gsi1 = "gsi1";
+  key(id: string) {
+    return { PK: `DM#${id}`, SK: `DM#${id}` } as const;
+  }
+  gsi1_by_recipient(recipient: string, date: string) {
+    return {
+      gsi1PK: `Recipient#${recipient}#${this.env}`,
+      gsi1SK: date as ISODate,
+    } as const;
+  }
+
+  list(recipient: string, opts?: IPageOpts): Promise<IPageKeyed<IPublicDonor>> {
+    const cmd = new QueryCommand({
+      TableName: DonationDonorsDb.table,
+      IndexName: DonationDonorsDb.gsi1,
+      KeyConditionExpression: "gsi1PK = :gsi1PK",
+      ExpressionAttributeValues: {
+        ":gsi1PK": this.gsi1_by_recipient(recipient, "only-sk-is-used").gsi1PK,
+      },
+      Limit: opts?.limit,
+      ExclusiveStartKey: this.key_to_obj(opts?.next),
+      ScanIndexForward: false,
+    });
+    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

@@ -0,0 +1,133 @@
+import { Db } from "@better-giving/db";
+import type {
+  IDonationFinal,
+  IDonationFinalAttr,
+  TExplicit,
+} from "./interfaces.mjs";
+import {
+  PutCommand,
+  QueryCommand,
+  type QueryCommandInput,
+} from "@aws-sdk/lib-dynamodb";
+import type { IPageKeyed } from "@better-giving/types/api";
+import type { IDonationsSearch } from "./schema.mjs";
+
+type K = keyof IDonationFinalAttr;
+
+export class DonationsDb extends Db {
+  static readonly table = "Donations";
+  static readonly gsi_referrer$settled_date = "Referrer-FinalizedDate_index";
+  static readonly gsi_npo$settled_date = "npo-settled_date-gsi";
+  static readonly gsi_email$tx_date = "email-tx_date-gsii";
+
+  async put_txi(data: TExplicit<IDonationFinalAttr>) {
+    const cmd = new PutCommand({
+      TableName: DonationsDb.table,
+      Item: data,
+      ConditionExpression: `attribute_not_exists(${"transactionId" satisfies keyof IDonationFinalAttr})`,
+    });
+    return this.client.send(cmd);
+  }
+
+  async referred_by_q(referrer: string) {
+    const q: QueryCommandInput = {
+      TableName: DonationsDb.table,
+      IndexName: DonationsDb.gsi_referrer$settled_date,
+      KeyConditionExpression: "#referrer = :referrer",
+      ExpressionAttributeNames: {
+        "#referrer": "referrer" satisfies K,
+      },
+      ExpressionAttributeValues: {
+        ":referrer": referrer,
+      },
+    };
+    return q;
+  }
+
+  async list_to_npo(
+    npo: number,
+    opts?: IDonationsSearch & { date_start?: string; date_end?: string }
+  ): Promise<IPageKeyed<IDonationFinal>> {
+    /** key condition expression */
+    let kce = "#npo = :npo";
+    /** expression attribute names */
+    const ean: Record<string, string> = {
+      "#npo": "endowmentId" satisfies K,
+    };
+    /** expression attribute values */
+    const eav: Record<string, any> = {
+      ":npo": npo,
+    };
+
+    if (opts?.date_start && opts?.date_end) {
+      kce += " AND #settled_date BETWEEN :date_start AND :date_end";
+      ean["#settled_date"] = "donationFinalTxDate" satisfies K;
+      eav[":date_start"] = opts.date_start;
+      eav[":date_end"] = opts.date_end;
+    } else if (opts?.date_start) {
+      kce += " AND #settled_date >= :date_start";
+      ean["#settled_date"] = "donationFinalTxDate" satisfies K;
+      eav[":date_start"] = opts.date_start;
+    } else if (opts?.date_end) {
+      kce += " AND #settled_date <= :date_end";
+      ean["#settled_date"] = "donationFinalTxDate" satisfies K;
+      eav[":date_end"] = opts.date_end;
+    }
+
+    const cmd = new QueryCommand({
+      TableName: DonationsDb.table,
+      IndexName: DonationsDb.gsi_npo$settled_date,
+      KeyConditionExpression: kce,
+      ExpressionAttributeNames: ean,
+      ExpressionAttributeValues: eav,
+      Limit: opts?.limit,
+      ExclusiveStartKey: this.key_to_obj(opts?.next),
+      ScanIndexForward: false,
+    });
+    return this.client.send(cmd).then(this.to_page<IDonationFinal>);
+  }
+
+  async list_by_email(
+    email: string,
+    opts?: IDonationsSearch
+  ): Promise<IPageKeyed<IDonationFinal>> {
+    /** key condition expression */
+    let kce = "#email = :email";
+    /** expression attribute names */
+    const ean: Record<string, string> = {
+      "#email": "email" satisfies K,
+    };
+    /** expression attribute values */
+    const eav: Record<string, any> = {
+      ":email": email,
+    };
+
+    if (opts?.date_start && opts?.date_end) {
+      kce += " AND #settled_date BETWEEN :date_start AND :date_end";
+      ean["#settled_date"] = "transactionDate" satisfies K;
+      eav[":date_start"] = opts.date_start;
+      eav[":date_end"] = opts.date_end;
+    } else if (opts?.date_start) {
+      kce += " AND #settled_date >= :date_start";
+      ean["#settled_date"] = "transactionDate" satisfies K;
+      eav[":date_start"] = opts.date_start;
+    } else if (opts?.date_end) {
+      kce += " AND #settled_date <= :date_end";
+      ean["#settled_date"] = "transactionDate" satisfies K;
+      eav[":date_end"] = opts.date_end;
+    }
+
+    const cmd = new QueryCommand({
+      TableName: DonationsDb.table,
+      IndexName: DonationsDb.gsi_email$tx_date,
+      KeyConditionExpression: kce,
+      ExpressionAttributeNames: ean,
+      ExpressionAttributeValues: eav,
+      Limit: opts?.limit,
+      ExclusiveStartKey: this.key_to_obj(opts?.next),
+      ScanIndexForward: false,
+    });
+
+    return this.client.send(cmd).then(this.to_page<IDonationFinal>);
+  }
+}

package/src/index.mts

@@ -0,0 +1,14 @@
+export type {
+  IAllocation,
+  TDonationSource,
+  TDonorTitle,
+  TFrequency,
+  IDonationsSearch,
+  IPageOpts,
+} from "./schema.mjs";
+
+export type * from "./paypal.mjs";
+export type * from "./interfaces.mjs";
+
+export { DonationsDb } from "./donations-db.mjs";
+export { OnHoldDonationsDb } from "./onhold-db.mjs";