@better-giving/endowment 5.0.0 → 6.1.0

package/dist/schema.mjs

@@ -2,6 +2,8 @@ import { $, $int_gte1, $req, MAX_NUM_INCREMENTS, donate_method_id, env, https_ur
 export { $, $req, $req_num_gt0, donate_method_id, env, https_url, int_gte1, $int_gte1, org_designation, slug, unsdg_num, } from "@better-giving/schemas";
 import * as v from "valibot";
 export const min_payout_amount = 50;
+/** used for text to give */
+export const keyword = v.pipe($, v.nonEmpty("required"), v.toLowerCase(), v.maxLength(10, ({ requirement: r }) => `max ${r} characters`), v.regex(/^[a-z]+$/, "must be letters only"));
 export const csv = v.lazy((x) => {
     if (!x)
         return $;
@@ -31,6 +33,7 @@ export const npo = v.object({
     id: int_gte1,
     env,
     slug: v.optional(slug),
+    keyword: v.optional(keyword),
     registration_number: reg_number,
     name: $req,
     endow_designation: org_designation,

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@better-giving/endowment",
-  "version": "5.0.0",
+  "version": "6.1.0",
   "dependencies": {
     "ksuid": "3.0.0"
   },
   "peerDependencies": {
-    "@better-giving/schemas": "2.1.0",
-    "@better-giving/types": "1.1.8",
-    "@better-giving/db": "2.0.7",
-    "@aws-sdk/lib-dynamodb": "3.485.0",
-    "valibot": "1.2.0"
+    "@better-giving/schemas": "^2.0.0",
+    "@better-giving/types": "^1.0.0",
+    "@better-giving/db": "^2.0.0",
+    "@aws-sdk/lib-dynamodb": "^3.900.0",
+    "valibot": "^1.0.0"
   },
   "devDependencies": {
-    "@better-giving/config": "1.1.2"
+    "@better-giving/config": "^1.0.0"
   },
   "files": [
     "src",

package/src/db.mts

@@ -23,6 +23,7 @@ import type {
   IMediaDb,
   IMediaPage,
   INpoReferredBy,
+  INpoWithKeyword,
   INpoWithRegNum,
   INpoWithRid,
   TBinFlag,
@@ -50,6 +51,7 @@ export class NpoDb extends Db {
   static readonly table = "endowments_v3";
   static readonly slug_env_gsi = "slug-env-gsi" as const;
   static readonly regnum_env_gsi = "regnum-env-gsi" as const;
+  static readonly keyword_env_gsi = "keyword-env-gsi" as const;
   key_npo(id: number) {
     return {
       PK: `Endow#${id}`,
@@ -83,14 +85,14 @@ export class NpoDb extends Db {
     };
   }
 
-  gsi1_npo(id: string) {
+  gsi1_npo_ref_by_key(id: string) {
     return {
       gsi1PK: `ReferredBy#${id}`,
       gsi1SK: this.env,
     };
   }
 
-  gsi2_npo(id: string) {
+  gsi2_npo_w_rid_key(id: string) {
     return {
       gsi2PK: `Rid#${id}`,
       gsi2SK: `Rid#${id}`,
@@ -164,7 +166,7 @@ export class NpoDb extends Db {
       IndexName: "gsi1",
       KeyConditionExpression: "#pk = :pk",
       ExpressionAttributeValues: {
-        ":pk": this.gsi1_npo(id).gsi1PK,
+        ":pk": this.gsi1_npo_ref_by_key(id).gsi1PK,
       },
       ExpressionAttributeNames: { "#pk": "gsi1PK" },
     });
@@ -178,7 +180,7 @@ export class NpoDb extends Db {
       IndexName: "gsi2",
       KeyConditionExpression: "gsi2PK = :pk",
       ExpressionAttributeValues: {
-        ":pk": this.gsi2_npo(id).gsi2PK,
+        ":pk": this.gsi2_npo_w_rid_key(id).gsi2PK,
       },
       Limit: 1,
     });
@@ -186,6 +188,29 @@ export class NpoDb extends Db {
     const i = Items[0];
     return i && this.sans_keys(i);
   }
+  async npo_with_keyword(
+    keyword: string,
+    env = this.env
+  ): Promise<INpoWithKeyword | undefined> {
+    const cmd = new QueryCommand({
+      TableName: NpoDb.table,
+      IndexName: NpoDb.keyword_env_gsi,
+      KeyConditionExpression: "#kw = :kw AND #env = :env",
+      ExpressionAttributeNames: {
+        "#kw": "keyword" satisfies TNpoDbKeys,
+        "#env": "env" satisfies TNpoDbKeys,
+      },
+      ExpressionAttributeValues: {
+        ":kw": keyword,
+        ":env": env,
+      },
+      Limit: 1,
+    });
+
+    const { Items = [] } = await this.client.send(cmd);
+    const i = Items[0];
+    return i && this.sans_keys(i);
+  }
 
   async npo_with_regnum(
     regnum: string,
@@ -219,8 +244,8 @@ export class NpoDb extends Db {
     return {
       ...this.key_npo(data.id),
       ...data,
-      ...(data.referrer ? this.gsi1_npo(data.referrer) : {}),
-      ...(data.referral_id ? this.gsi2_npo(data.referral_id) : {}),
+      ...(data.referrer ? this.gsi1_npo_ref_by_key(data.referrer) : {}),
+      ...(data.referral_id ? this.gsi2_npo_w_rid_key(data.referral_id) : {}),
     };
   }
 

package/src/interfaces.mts

@@ -27,6 +27,7 @@ export interface INpoReferredBy
   extends Ensure<INpo, "referrer" | "referrer_expiry"> {}
 
 export interface INpoWithRid extends Ensure<INpo, "referral_id"> {}
+export interface INpoWithKeyword extends Ensure<INpo, "keyword"> {}
 
 export interface INpoWithRegNum
   extends Pick<

package/src/npo.mts

@@ -20,6 +20,7 @@ export const npo_fields: { [K in keyof Required<INpo>]: "" } = {
   tagline: "",
   url: "",
   slug: "",
+  keyword: "",
   claimed: "",
   card_img: "",
   progDonationsAllowed: "",

package/src/schema.mts

@@ -30,6 +30,15 @@ import * as v from "valibot";
 
 export const min_payout_amount = 50;
 
+/** used for text to give */
+export const keyword = v.pipe(
+  $,
+  v.nonEmpty("required"),
+  v.toLowerCase(),
+  v.maxLength(10, ({ requirement: r }) => `max ${r} characters`),
+  v.regex(/^[a-z]+$/, "must be letters only")
+);
+
 export const csv = v.lazy((x) => {
   if (!x) return $;
   return v.pipe($, v.regex(/^[^,]+(?:,[^,]+)*$/, "invalid csv"));
@@ -80,6 +89,7 @@ export const npo = v.object({
   id: int_gte1,
   env,
   slug: v.optional(slug),
+  keyword: v.optional(keyword),
   registration_number: reg_number,
   name: $req,
   endow_designation: org_designation,