@better-giving/endowment 4.0.35 → 4.0.37

package/dist/db.d.mts

@@ -97,6 +97,7 @@ export declare class NpoDb extends Db {
         referrer_expiry?: string | undefined;
         w_form?: string | undefined;
         payout_minimum?: number | undefined;
+        donor_address_required?: boolean | undefined;
         PK: string;
         SK: import("@better-giving/types/list").Environment;
     };
@@ -145,6 +146,7 @@ export declare class NpoDb extends Db {
     npo_programs(id: number): Promise<IProgramDb[]>;
     npo_program_put(npo: number, content: IProgramNew): Promise<string>;
     npo_prog_del_txis(npo: number, prog: string): Promise<TxItems>;
+    npo_prog_contrib_update_txi(npo: number, prog: string, amount: number): TxType["Update"];
     npo_prog_del(npo: number, prog: string): Promise<import("@aws-sdk/lib-dynamodb").TransactWriteCommandOutput>;
     npo_prog_update(npo: number, prog: string, update: IProgramUpdate): Promise<Record<string, any> | undefined>;
 }

package/dist/db.mjs

@@ -402,6 +402,20 @@ export class NpoDb extends Db {
         }
         return txs.all;
     }
+    npo_prog_contrib_update_txi(npo, prog, amount) {
+        return {
+            TableName: NpoDb.table,
+            Key: this.key_npo_program(prog, npo),
+            UpdateExpression: "SET #x = if_not_exists(#x, :zero) + :amt",
+            ExpressionAttributeValues: {
+                ":amt": amount,
+                ":zero": 0,
+            },
+            ExpressionAttributeNames: {
+                "#x": "totalDonations",
+            },
+        };
+    }
     async npo_prog_del(npo, prog) {
         const txs = await this.npo_prog_del_txis(npo, prog);
         const cmd = new TransactWriteCommand({

package/dist/npo.mjs

@@ -33,4 +33,5 @@ export const npo_fields = {
     referral_id: "",
     w_form: "",
     payout_minimum: "",
+    donor_address_required: "",
 };

package/dist/schema.d.mts

@@ -92,6 +92,7 @@ export declare const npo: v.ObjectSchema<{
     readonly referrer_expiry: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<"required">, v.TrimAction]>, v.IsoTimestampAction<string, undefined>]>, never>;
     readonly w_form: v.OptionalSchema<v.StringSchema<undefined>, never>;
     readonly payout_minimum: v.OptionalSchema<v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 50, undefined>]>, never>;
+    readonly donor_address_required: v.OptionalSchema<v.BooleanSchema<undefined>, never>;
 }, undefined>;
 export declare const npo_update: Omit<Omit<v.ObjectSchema<{
     readonly id: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>;
@@ -156,6 +157,7 @@ export declare const npo_update: Omit<Omit<v.ObjectSchema<{
     readonly referrer_expiry: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<"required">, v.TrimAction]>, v.IsoTimestampAction<string, undefined>]>, never>;
     readonly w_form: v.OptionalSchema<v.StringSchema<undefined>, never>;
     readonly payout_minimum: v.OptionalSchema<v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 50, undefined>]>, never>;
+    readonly donor_address_required: v.OptionalSchema<v.BooleanSchema<undefined>, never>;
 }, undefined>, "_run" | "_types" | "entries"> & {
     readonly entries: Omit<{
         readonly id: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>;
@@ -220,6 +222,7 @@ export declare const npo_update: Omit<Omit<v.ObjectSchema<{
         readonly referrer_expiry: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<"required">, v.TrimAction]>, v.IsoTimestampAction<string, undefined>]>, never>;
         readonly w_form: v.OptionalSchema<v.StringSchema<undefined>, never>;
         readonly payout_minimum: v.OptionalSchema<v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 50, undefined>]>, never>;
+        readonly donor_address_required: v.OptionalSchema<v.BooleanSchema<undefined>, never>;
     }, "id" | "env" | "claimed" | "kyc_donors_only" | "fiscal_sponsored">;
     _run(dataset: v.Dataset<unknown, never>, config: v.Config<v.StringIssue | v.RegexIssue<string> | v.NumberIssue | v.IntegerIssue<number> | v.MinValueIssue<number, 0> | v.MaxValueIssue<number, 100> | v.ObjectIssue | v.CheckIssue<{
         cash: number;
@@ -273,6 +276,7 @@ export declare const npo_update: Omit<Omit<v.ObjectSchema<{
         referrer_expiry?: string | undefined;
         w_form?: string | undefined;
         payout_minimum?: number | undefined;
+        donor_address_required?: boolean | undefined;
     }, v.StringIssue | v.RegexIssue<string> | v.NumberIssue | v.IntegerIssue<number> | v.MinValueIssue<number, 0> | v.MaxValueIssue<number, 100> | v.ObjectIssue | v.CheckIssue<{
         cash: number;
         liq: number;
@@ -327,6 +331,7 @@ export declare const npo_update: Omit<Omit<v.ObjectSchema<{
             referrer_expiry?: string | undefined;
             w_form?: string | undefined;
             payout_minimum?: number | undefined;
+            donor_address_required?: boolean | undefined;
         };
         readonly output: {
             active_in_countries: string[];
@@ -373,6 +378,7 @@ export declare const npo_update: Omit<Omit<v.ObjectSchema<{
             referrer_expiry?: string | undefined;
             w_form?: string | undefined;
             payout_minimum?: number | undefined;
+            donor_address_required?: boolean | undefined;
         };
         readonly issue: v.StringIssue | v.RegexIssue<string> | v.NumberIssue | v.IntegerIssue<number> | v.MinValueIssue<number, 0> | v.MaxValueIssue<number, 100> | v.ObjectIssue | v.CheckIssue<{
             cash: number;
@@ -426,6 +432,7 @@ export declare const npo_update: Omit<Omit<v.ObjectSchema<{
         readonly referrer_expiry: v.OptionalSchema<v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<"required">, v.TrimAction]>, v.IsoTimestampAction<string, undefined>]>, never>, never>;
         readonly w_form: v.OptionalSchema<v.OptionalSchema<v.StringSchema<undefined>, never>, never>;
         readonly payout_minimum: v.OptionalSchema<v.OptionalSchema<v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 50, undefined>]>, never>, never>;
+        readonly donor_address_required: v.OptionalSchema<v.OptionalSchema<v.BooleanSchema<undefined>, never>, never>;
         readonly registration_number: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<"required">, v.TrimAction]>, v.NonEmptyAction<string, "required">, v.RegexAction<string, "must only contain letters and numbers">]>, never>;
         readonly name: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<"required">, v.TrimAction]>, v.NonEmptyAction<string, "required">]>, never>;
         readonly endow_designation: v.OptionalSchema<v.PicklistSchema<readonly ["Charity", "Religious Organization", "University", "Hospital", "Other"], "required">, never>;
@@ -479,6 +486,7 @@ export declare const npo_update: Omit<Omit<v.ObjectSchema<{
         referrer_expiry?: string | undefined;
         w_form?: string | undefined;
         payout_minimum?: number | undefined;
+        donor_address_required?: boolean | undefined;
         registration_number?: string | undefined;
         name?: string | undefined;
         endow_designation?: "Charity" | "Religious Organization" | "University" | "Hospital" | "Other" | undefined;
@@ -533,6 +541,7 @@ export declare const npo_update: Omit<Omit<v.ObjectSchema<{
             referrer_expiry?: string | undefined;
             w_form?: string | undefined;
             payout_minimum?: number | undefined;
+            donor_address_required?: boolean | undefined;
             registration_number?: string | undefined;
             name?: string | undefined;
             endow_designation?: "Charity" | "Religious Organization" | "University" | "Hospital" | "Other" | undefined;
@@ -579,6 +588,7 @@ export declare const npo_update: Omit<Omit<v.ObjectSchema<{
             referrer_expiry?: string | undefined;
             w_form?: string | undefined;
             payout_minimum?: number | undefined;
+            donor_address_required?: boolean | undefined;
             registration_number?: string | undefined;
             name?: string | undefined;
             endow_designation?: "Charity" | "Religious Organization" | "University" | "Hospital" | "Other" | undefined;
@@ -603,7 +613,7 @@ export declare const npo_update: Omit<Omit<v.ObjectSchema<{
         }[], 4> | v.LiteralIssue | v.UnionIssue<v.StringIssue | v.NumberIssue | v.MinValueIssue<number, 0> | v.LiteralIssue> | v.IsoTimestampIssue<string> | v.MinValueIssue<number, 50>;
     } | undefined;
 };
-export declare const npo_fields: v.PicklistSchema<["url", "slug", "overview", "tagline", "image", "logo", "card_img", "active_in_countries", "street_address", "sdgs", "receiptMsg", "hide_bg_tip", "published", "progDonationsAllowed", "allocation", "donateMethods", "increments", "fund_opt_in", "target", "referral_id", "referrer", "referrer_expiry", "w_form", "payout_minimum", "id", "env", "registration_number", "name", "endow_designation", "hq_country", "social_media_urls", "claimed", "kyc_donors_only", "fiscal_sponsored"], undefined>;
+export declare const npo_fields: v.PicklistSchema<["url", "slug", "overview", "tagline", "image", "logo", "card_img", "active_in_countries", "street_address", "sdgs", "receiptMsg", "hide_bg_tip", "published", "progDonationsAllowed", "allocation", "donateMethods", "increments", "fund_opt_in", "target", "referral_id", "referrer", "referrer_expiry", "w_form", "payout_minimum", "donor_address_required", "id", "env", "registration_number", "name", "endow_designation", "hq_country", "social_media_urls", "claimed", "kyc_donors_only", "fiscal_sponsored"], undefined>;
 export interface INpo extends v.InferOutput<typeof npo> {
 }
 export interface INpoUpdate extends v.InferOutput<typeof npo_update> {
@@ -611,7 +621,7 @@ export interface INpoUpdate extends v.InferOutput<typeof npo_update> {
 export type INpoFields = v.InferOutput<typeof npo_fields>;
 /** for ein path, only fields in reg-num/env gsi is available */
 export declare const npo_search: v.ObjectSchema<{
-    readonly fields: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.LazySchema<v.SchemaWithPipe<[v.StringSchema<"required">, v.TrimAction]> | v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<"required">, v.TrimAction]>, v.RegexAction<string, "invalid csv">]>>, v.TransformAction<string, string[]>, v.FilterItemsAction<string[]>]>, v.ArraySchema<v.PicklistSchema<["url", "slug", "overview", "tagline", "image", "logo", "card_img", "active_in_countries", "street_address", "sdgs", "receiptMsg", "hide_bg_tip", "published", "progDonationsAllowed", "allocation", "donateMethods", "increments", "fund_opt_in", "target", "referral_id", "referrer", "referrer_expiry", "w_form", "payout_minimum", "id", "env", "registration_number", "name", "endow_designation", "hq_country", "social_media_urls", "claimed", "kyc_donors_only", "fiscal_sponsored"], undefined>, undefined>]>, never>;
+    readonly fields: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.LazySchema<v.SchemaWithPipe<[v.StringSchema<"required">, v.TrimAction]> | v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<"required">, v.TrimAction]>, v.RegexAction<string, "invalid csv">]>>, v.TransformAction<string, string[]>, v.FilterItemsAction<string[]>]>, v.ArraySchema<v.PicklistSchema<["url", "slug", "overview", "tagline", "image", "logo", "card_img", "active_in_countries", "street_address", "sdgs", "receiptMsg", "hide_bg_tip", "published", "progDonationsAllowed", "allocation", "donateMethods", "increments", "fund_opt_in", "target", "referral_id", "referrer", "referrer_expiry", "w_form", "payout_minimum", "donor_address_required", "id", "env", "registration_number", "name", "endow_designation", "hq_country", "social_media_urls", "claimed", "kyc_donors_only", "fiscal_sponsored"], undefined>, undefined>]>, never>;
 }, undefined>;
 export interface INposSearch extends v.InferInput<typeof npo_search> {
 }

package/dist/schema.mjs

@@ -66,6 +66,7 @@ export const npo = v.object({
     referrer_expiry: v.optional(v.pipe($, v.isoTimestamp())),
     w_form: v.optional(v.string()),
     payout_minimum: v.optional(v.pipe(v.number(), v.minValue(min_payout_amount))),
+    donor_address_required: v.optional(v.boolean()),
 });
 export const npo_update = v.partial(v.omit(npo, ["id", "claimed", "kyc_donors_only", "env", "fiscal_sponsored"]));
 export const npo_fields = v.keyof(npo);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@better-giving/endowment",
-  "version": "4.0.35",
+  "version": "4.0.37",
   "dependencies": {
     "ksuid": "3.0.0"
   },

package/src/db.mts

@@ -514,6 +514,25 @@ export class NpoDb extends Db {
     return txs.all;
   }
 
+  npo_prog_contrib_update_txi(
+    npo: number,
+    prog: string,
+    amount: number
+  ): TxType["Update"] {
+    return {
+      TableName: NpoDb.table,
+      Key: this.key_npo_program(prog, npo),
+      UpdateExpression: "SET #x = if_not_exists(#x, :zero) + :amt",
+      ExpressionAttributeValues: {
+        ":amt": amount,
+        ":zero": 0,
+      },
+      ExpressionAttributeNames: {
+        "#x": "totalDonations" satisfies keyof IProgram,
+      },
+    };
+  }
+
   async npo_prog_del(npo: number, prog: string) {
     const txs = await this.npo_prog_del_txis(npo, prog);
     const cmd = new TransactWriteCommand({

package/src/npo.mts

@@ -35,4 +35,5 @@ export const npo_fields: { [K in keyof Required<INpo>]: "" } = {
   referral_id: "",
   w_form: "",
   payout_minimum: "",
+  donor_address_required: "",
 };

package/src/schema.mts

@@ -124,6 +124,7 @@ export const npo = v.object({
   referrer_expiry: v.optional(v.pipe($, v.isoTimestamp())),
   w_form: v.optional(v.string()),
   payout_minimum: v.optional(v.pipe(v.number(), v.minValue(min_payout_amount))),
+  donor_address_required: v.optional(v.boolean()),
 });
 
 export const npo_update = v.partial(