@better-giving/donation 1.0.0

package/src/intent.mts

@@ -0,0 +1,100 @@
+import * as v from "valibot";
+
+const str = v.pipe(v.string(), v.trim(), 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 donationSources = [
+  "bg-marketplace",
+  "bg-widget",
+  "tester-app",
+] as const;
+
+export const donationSource = v.picklist(donationSources);
+export type DonationSource = v.InferOutput<typeof donationSource>;
+
+export const donorTitles = ["Mr", "Mrs", "Ms", "Mx"] as const;
+export const donorTitle = v.picklist(donorTitles);
+
+export type DonorTitle = v.InferOutput<typeof donorTitle>;
+
+export const donorAddress = v.object({
+  street: str,
+  city: str,
+  state: v.optional(str),
+  zipCode: v.optional(str),
+  /** country name */
+  country: str,
+  ukGiftAid: v.optional(v.boolean()),
+});
+
+export type DonorAddress = v.InferOutput<typeof donorAddress>;
+
+export const donor = v.object({
+  title: donorTitle,
+  firstName: str,
+  lastName: str,
+  email: v.pipe(str, v.email()),
+  address: v.optional(donorAddress),
+});
+
+export type Donor = v.InferOutput<typeof donor>;
+
+const money = v.pipe(v.number(), v.minValue(0));
+
+export const amount = v.object({
+  amount: money,
+  currency: str,
+  tip: money,
+  feeAllowance: money,
+});
+
+export type Amount = v.InferOutput<typeof amount>;
+
+export const endowId = v.pipe(v.number(), v.integer(), v.minValue(1));
+export const uuid = v.pipe(str, v.uuid());
+
+export const program = v.object({
+  id: uuid,
+  name: str,
+});
+
+export type Program = v.InferOutput<typeof program>;
+
+export const recipient = v.union([endowId, uuid]);
+
+export type Recipient = v.InferOutput<typeof recipient>;
+
+export const tributeNotif = v.object({
+  toEmail: v.pipe(str, v.email()),
+  toFullName: str,
+  fromMsg: v.optional(v.pipe(v.string(), v.maxLength(250))),
+});
+
+export type TributeNotif = v.InferOutput<typeof tributeNotif>;
+
+export const tribute = v.object({
+  fullName: str,
+  notif: v.optional(tributeNotif),
+});
+
+export type Tribute = v.InferOutput<typeof tribute>;
+
+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,
+});
+
+export type DonationIntent = v.InferOutput<typeof intent>;

package/src/subscription.mts

@@ -0,0 +1,34 @@
+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 {}
+}