@better-giving/endowment 5.0.0 → 6.1.0

package/dist/db.d.mts

@@ -1,10 +1,11 @@
 import { Db, type TxItems, type TxType, type UpdateComps } from "@better-giving/db";
-import type { IMedia, IMediaPage, INpoReferredBy, INpoWithRegNum, INpoWithRid, TBinFlag, TNpoDbKeys, TNpoDbProjectedTo } from "./interfaces.mjs";
+import type { IMedia, IMediaPage, INpoReferredBy, INpoWithKeyword, INpoWithRegNum, INpoWithRid, TBinFlag, TNpoDbKeys, TNpoDbProjectedTo } from "./interfaces.mjs";
 import type { IMediaSearchObj, IMediaUpdate, IMilestone, IMilestoneNew, IMilestoneUpdate, INpo, INpoUpdate, IProgram, IProgramDb, IProgramNew, IProgramUpdate, TMediaType } from "./schema.mjs";
 export declare class NpoDb extends Db {
     static readonly table = "endowments_v3";
     static readonly slug_env_gsi: "slug-env-gsi";
     static readonly regnum_env_gsi: "regnum-env-gsi";
+    static readonly keyword_env_gsi: "keyword-env-gsi";
     key_npo(id: number): {
         PK: string;
         SK: import("@better-giving/types/list").Environment;
@@ -25,11 +26,11 @@ export declare class NpoDb extends Db {
         PK: string;
         SK: string;
     };
-    gsi1_npo(id: string): {
+    gsi1_npo_ref_by_key(id: string): {
         gsi1PK: string;
         gsi1SK: import("@better-giving/types/list").Environment;
     };
-    gsi2_npo(id: string): {
+    gsi2_npo_w_rid_key(id: string): {
         gsi2PK: string;
         gsi2SK: string;
     };
@@ -42,6 +43,7 @@ export declare class NpoDb extends Db {
     npo_media(npo: number, opts: IMediaSearchObj): Promise<IMediaPage>;
     npo_referred_by(id: string): Promise<INpoReferredBy[]>;
     npo_with_rid(id: string): Promise<INpoWithRid | undefined>;
+    npo_with_keyword(keyword: string, env?: import("@better-giving/types/list").Environment): Promise<INpoWithKeyword | undefined>;
     npo_with_regnum(regnum: string, country?: string): Promise<INpoWithRegNum | undefined>;
     npo_record(data: INpo): {
         gsi2PK?: string | undefined;
@@ -51,6 +53,7 @@ export declare class NpoDb extends Db {
         id: number;
         env: "staging" | "production";
         slug?: string | undefined;
+        keyword?: string | undefined;
         registration_number: string;
         name: string;
         endow_designation: "Charity" | "Religious Organization" | "University" | "Hospital" | "Other";
@@ -72,7 +75,7 @@ export declare class NpoDb extends Db {
             tiktok?: string | undefined;
         };
         url?: string | undefined;
-        sdgs: (2 | 1 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17)[];
+        sdgs: (2 | 1 | 10 | 5 | 3 | 4 | 6 | 7 | 8 | 9 | 11 | 12 | 13 | 14 | 15 | 16 | 17)[];
         receiptMsg?: string | undefined;
         hide_bg_tip?: boolean | undefined;
         published?: boolean | undefined;

package/dist/db.mjs

@@ -9,6 +9,7 @@ export class NpoDb extends Db {
     static table = "endowments_v3";
     static slug_env_gsi = "slug-env-gsi";
     static regnum_env_gsi = "regnum-env-gsi";
+    static keyword_env_gsi = "keyword-env-gsi";
     key_npo(id) {
         return {
             PK: `Endow#${id}`,
@@ -39,13 +40,13 @@ export class NpoDb extends Db {
             SK: `Media#${ksuid}`,
         };
     }
-    gsi1_npo(id) {
+    gsi1_npo_ref_by_key(id) {
         return {
             gsi1PK: `ReferredBy#${id}`,
             gsi1SK: this.env,
         };
     }
-    gsi2_npo(id) {
+    gsi2_npo_w_rid_key(id) {
         return {
             gsi2PK: `Rid#${id}`,
             gsi2SK: `Rid#${id}`,
@@ -109,7 +110,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" },
         });
@@ -122,7 +123,26 @@ 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,
+        });
+        const { Items = [] } = await this.client.send(cmd);
+        const i = Items[0];
+        return i && this.sans_keys(i);
+    }
+    async npo_with_keyword(keyword, env = this.env) {
+        const cmd = new QueryCommand({
+            TableName: NpoDb.table,
+            IndexName: NpoDb.keyword_env_gsi,
+            KeyConditionExpression: "#kw = :kw AND #env = :env",
+            ExpressionAttributeNames: {
+                "#kw": "keyword",
+                "#env": "env",
+            },
+            ExpressionAttributeValues: {
+                ":kw": keyword,
+                ":env": env,
             },
             Limit: 1,
         });
@@ -156,8 +176,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) : {}),
         };
     }
     npo_prog_record(npo, data) {

package/dist/helpers.d.mts

@@ -0,0 +1,7 @@
+import type { TId } from "./interfaces.mjs";
+export declare const is_id: (id: TId) => id is {
+    id: number | string;
+};
+export declare const is_slug: (id: TId) => id is {
+    slug: string;
+};

package/dist/helpers.mjs

@@ -0,0 +1,6 @@
+export const is_id = (id) => {
+    return "id" in id;
+};
+export const is_slug = (id) => {
+    return "slug" in id;
+};

package/dist/interfaces.d.mts

@@ -18,6 +18,8 @@ export interface INpoReferredBy extends Ensure<INpo, "referrer" | "referrer_expi
 }
 export interface INpoWithRid extends Ensure<INpo, "referral_id"> {
 }
+export interface INpoWithKeyword extends Ensure<INpo, "keyword"> {
+}
 export interface INpoWithRegNum extends Pick<INpo, "registration_number" | "env" | "claimed" | "name" | "hq_country" | "id"> {
 }
 export interface IMedia extends Required<IMediaUpdate> {

package/dist/npo.mjs

@@ -18,6 +18,7 @@ export const npo_fields = {
     tagline: "",
     url: "",
     slug: "",
+    keyword: "",
     claimed: "",
     card_img: "",
     progDonationsAllowed: "",