@better-giving/fundraiser 6.0.0 → 7.0.1

package/dist/db.d.mts

@@ -1,5 +1,5 @@
 import { Db, type TxType } from "@better-giving/db";
-import type { IFund } from "./interfaces.mjs";
+import type { IFund, IFundsPageOpts } from "./interfaces.mjs";
 import type { IFundUpdate } from "./schema.mjs";
 export declare class FundDb extends Db {
     static readonly table = "funds";
@@ -8,6 +8,10 @@ export declare class FundDb extends Db {
         readonly PK: `Fund#${string}`;
         readonly SK: `Fund#${string}`;
     };
+    gsi1_funds_key(date_created: string): {
+        readonly gsi1PK: "Funds#staging" | "Funds#production";
+        readonly gsi1SK: string;
+    };
     fund_record(data: IFund): {
         readonly name: string;
         readonly description: string;
@@ -26,7 +30,7 @@ export declare class FundDb extends Db {
         readonly slug?: string | undefined;
         readonly id: string;
         readonly spam_score?: number;
-        readonly date_created?: string;
+        readonly created_at?: string;
         readonly env: import("@better-giving/schemas").Environment;
         readonly active: boolean;
         readonly verified: boolean;
@@ -34,6 +38,8 @@ export declare class FundDb extends Db {
         readonly settings: import("./interfaces.mjs").IFundSettings;
         readonly creator_id: string;
         readonly creator_name: string;
+        readonly gsi1PK?: "Funds#staging" | "Funds#production" | undefined;
+        readonly gsi1SK?: string | undefined;
         readonly PK: `Fund#${string}`;
         readonly SK: `Fund#${string}`;
     };
@@ -41,6 +47,7 @@ export declare class FundDb extends Db {
     /**@param id - slug or uuid */
     fund(id: string): Promise<IFund | undefined>;
     funds_get(ids: string[]): Promise<IFund[]>;
+    funds(opts: IFundsPageOpts): Promise<import("@better-giving/types/api").IPageKeyed<IFund>>;
     fund_update(id: string, { target, slug, ...update }: IFundUpdate): Promise<Record<string, any>>;
     fund_contrib_update_txi(id: string, amount: number): TxType["Update"];
     fund_close(fund: string): Promise<import("@aws-sdk/lib-dynamodb").UpdateCommandOutput>;

package/dist/db.mjs

@@ -7,9 +7,13 @@ export class FundDb extends Db {
     key_fund(id) {
         return { PK: `Fund#${id}`, SK: `Fund#${id}` };
     }
+    gsi1_funds_key(date_created) {
+        return { gsi1PK: `Funds#${this.env}`, gsi1SK: date_created };
+    }
     fund_record(data) {
         return {
             ...this.key_fund(data.id),
+            ...(data.created_at && this.gsi1_funds_key(data.created_at)),
             ...data,
         };
     }
@@ -58,6 +62,18 @@ export class FundDb extends Db {
         const x = Responses?.[FundDb.table] ?? [];
         return x.map((i) => this.sans_keys(i));
     }
+    async funds(opts) {
+        const cmd = new QueryCommand({
+            TableName: FundDb.table,
+            Limit: opts.limit ?? 10,
+            ExclusiveStartKey: this.key_to_obj(opts.next),
+            IndexName: "gsi1",
+            KeyConditionExpression: "gsi1PK = :pk",
+            ScanIndexForward: false,
+            ExpressionAttributeValues: { ":pk": `Funds#${this.env}` },
+        });
+        return this.client.send(cmd).then((this.to_page));
+    }
     async fund_update(id, { target, slug, ...update }) {
         const updates = new UpdateBuilder();
         if (slug)

package/dist/interfaces.d.mts

@@ -1,5 +1,5 @@
 import type { DonateMethodId, Environment } from "@better-giving/schemas";
-import type { IPageNumbered } from "@better-giving/types/api";
+import type { IPageKeyed, IPageNumbered } from "@better-giving/types/api";
 import type { IFundNew } from "./schema.mjs";
 export interface IFundSettings {
     hide_bg_tip: boolean;
@@ -14,7 +14,7 @@ export interface IFundInternal extends IFundCreator {
     /** uuid */
     id: string;
     spam_score?: number;
-    date_created?: string;
+    created_at?: string;
     env: Environment;
     /** fund can be closed before expiration  */
     active: boolean;
@@ -25,10 +25,17 @@ export interface IFundInternal extends IFundCreator {
 }
 export interface IFund extends IFundNew, IFundInternal {
 }
+/** typesense record */
 export interface IFundItem extends Pick<IFundNew, "name" | "description" | "logo" | "banner" | "featured" | "members" | "target">, Pick<IFundInternal, "id" | "env" | "active" | "verified" | "donation_total_usd" | "creator_id" | "creator_name"> {
     /** Unix timestamp @default - 253402300799 */
     expiration: number;
     members_csv: string;
 }
-export interface IFundsPage extends IPageNumbered<IFundItem> {
+export interface IFundItemsPage extends IPageNumbered<IFundItemsPage> {
+}
+export interface IFundsPageOpts {
+    limit?: number;
+    next?: string;
+}
+export interface IFundsPage extends IPageKeyed<IFund> {
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@better-giving/fundraiser",
-  "version": "6.0.0",
+  "version": "7.0.1",
   "peerDependencies": {
     "valibot": "^1.0.0",
     "@better-giving/schemas": "^2.0.0",

package/src/db.mts

@@ -11,7 +11,7 @@ import {
   UpdateBuilder,
 } from "@better-giving/db";
 import { UUID_REGEX } from "valibot";
-import type { IFund } from "./interfaces.mjs";
+import type { IFund, IFundsPageOpts } from "./interfaces.mjs";
 import type { IFundUpdate } from "./schema.mjs";
 
 export class FundDb extends Db {
@@ -20,12 +20,19 @@ export class FundDb extends Db {
   key_fund(id: string) {
     return { PK: `Fund#${id}`, SK: `Fund#${id}` } as const;
   }
+
+  gsi1_funds_key(date_created: string) {
+    return { gsi1PK: `Funds#${this.env}`, gsi1SK: date_created } as const;
+  }
+
   fund_record(data: IFund) {
     return {
       ...this.key_fund(data.id),
+      ...(data.created_at && this.gsi1_funds_key(data.created_at)),
       ...data,
     } as const;
   }
+
   fund_put_txi(data: IFund): TxType["Put"] {
     return {
       TableName: FundDb.table,
@@ -71,6 +78,19 @@ export class FundDb extends Db {
     return x.map((i) => this.sans_keys(i));
   }
 
+  async funds(opts: IFundsPageOpts) {
+    const cmd = new QueryCommand({
+      TableName: FundDb.table,
+      Limit: opts.limit ?? 10,
+      ExclusiveStartKey: this.key_to_obj(opts.next),
+      IndexName: "gsi1",
+      KeyConditionExpression: "gsi1PK = :pk",
+      ScanIndexForward: false,
+      ExpressionAttributeValues: { ":pk": `Funds#${this.env}` },
+    });
+    return this.client.send(cmd).then(this.to_page<IFund>);
+  }
+
   async fund_update(id: string, { target, slug, ...update }: IFundUpdate) {
     const updates = new UpdateBuilder();
 

package/src/interfaces.mts

@@ -1,5 +1,5 @@
 import type { DonateMethodId, Environment } from "@better-giving/schemas";
-import type { IPageNumbered } from "@better-giving/types/api";
+import type { IPageKeyed, IPageNumbered } from "@better-giving/types/api";
 import type { IFundNew } from "./schema.mjs";
 
 export interface IFundSettings {
@@ -17,7 +17,7 @@ export interface IFundInternal extends IFundCreator {
   /** uuid */
   id: string;
   spam_score?: number;
-  date_created?: string;
+  created_at?: string;
   env: Environment;
   /** fund can be closed before expiration  */
   active: boolean;
@@ -29,6 +29,7 @@ export interface IFundInternal extends IFundCreator {
 
 export interface IFund extends IFundNew, IFundInternal {}
 
+/** typesense record */
 export interface IFundItem
   extends Pick<
       IFundNew,
@@ -55,4 +56,9 @@ export interface IFundItem
   members_csv: string;
 }
 
-export interface IFundsPage extends IPageNumbered<IFundItem> {}
+export interface IFundItemsPage extends IPageNumbered<IFundItemsPage> {}
+export interface IFundsPageOpts {
+  limit?: number;
+  next?: string;
+}
+export interface IFundsPage extends IPageKeyed<IFund> {}