@better-giving/endowment 1.1.6 → 1.1.8

package/dist/db.d.mts

@@ -1,3 +1,4 @@
+import type { Ensure } from "@better-giving/types/utils";
 import type { EndowId, Endowment as EndowmentShape, Environment, MediaId, MediaType, Milestone as MilestoneShape, MilestoneId, Program as ProgramShape, ProgramId } from "./schema.mjs";
 export type { EndowId, SocialMediaURLs, Allocation, Increment, EndowDesignation, Environment, ProgramId, } from "./schema.mjs";
 export declare const endowGsi: {
@@ -19,6 +20,10 @@ export declare namespace Endow {
         SK: Environment;
     };
     type NonKeyAttributes = EndowmentShape & {
+        /** referral id */
+        gsi1PK?: `ReferredBy#${string}`;
+        /** npo id */
+        gsi1SK?: string;
         /** will only be present for unclaimed NPOs */
         updated_at_auto?: string;
         /** in USD @deprecated */
@@ -65,9 +70,6 @@ export declare namespace Milestone {
     interface DbRecord extends Keys, MilestoneShape {
     }
 }
-export declare const mediaGsi: {
-    readonly 1: "gsi1";
-};
 export declare namespace Media {
     interface Keys {
         PK: `Endow#${EndowId}#${Environment}`;
@@ -89,11 +91,18 @@ export declare namespace Media {
     interface VideoDbRecord extends Keys, VideoAttributes {
     }
     type DbRecord = VideoDbRecord;
-    namespace Gsi1 {
-        type Name = (typeof mediaGsi)[1];
-        interface Keys extends Pick<NonKeyAttributes, "gsi1PK" | "gsi1SK"> {
+}
+export declare namespace Gsi1 {
+    namespace MediaList {
+        interface Keys extends Pick<Media.NonKeyAttributes, "gsi1PK" | "gsi1SK"> {
+        }
+        interface DbRecord extends Media.DbRecord {
+        }
+    }
+    namespace ReferredNpos {
+        interface Keys extends Required<Pick<Endow.NonKeyAttributes, "gsi1PK" | "gsi1SK">> {
         }
-        interface DbRecord extends Keys, NonKeyAttributes {
+        interface DbRecord extends Ensure<Endow.DbRecord, "gsi1PK" | "gsi1SK" | "referrer" | "referrer_expiry"> {
         }
     }
 }

package/dist/db.mjs

@@ -2,6 +2,3 @@ export const endowGsi = {
     regnumEnv: "regnum-env-gsi",
     slugEnv: "slug-env-gsi",
 };
-export const mediaGsi = {
-    1: "gsi1",
-};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@better-giving/endowment",
-  "version": "1.1.6",
+  "version": "1.1.8",
   "peerDependencies": {
     "@better-giving/schemas": "1.1.2",
     "@better-giving/types": "1.1.3",

package/src/db.mts

@@ -1,3 +1,4 @@
+import type { Ensure } from "@better-giving/types/utils";
 import type {
   EndowId,
   Endowment as EndowmentShape,
@@ -41,6 +42,11 @@ export namespace Endow {
   };
 
   export type NonKeyAttributes = EndowmentShape & {
+    /** referral id */
+    gsi1PK?: `ReferredBy#${string}`;
+    /** npo id */
+    gsi1SK?: string;
+
     /** will only be present for unclaimed NPOs */
     updated_at_auto?: string;
     /** in USD @deprecated */
@@ -90,9 +96,6 @@ export namespace Milestone {
   export interface DbRecord extends Keys, MilestoneShape {}
 }
 
-export const mediaGsi = {
-  1: "gsi1",
-} as const;
 export namespace Media {
   export interface Keys {
     PK: `Endow#${EndowId}#${Environment}`;
@@ -116,11 +119,23 @@ export namespace Media {
 
   export interface VideoDbRecord extends Keys, VideoAttributes {}
   export type DbRecord = VideoDbRecord; // | album | article
+}
+
+export namespace Gsi1 {
+  export namespace MediaList {
+    export interface Keys
+      extends Pick<Media.NonKeyAttributes, "gsi1PK" | "gsi1SK"> {}
+    export interface DbRecord extends Media.DbRecord {}
+  }
 
-  export namespace Gsi1 {
-    export type Name = (typeof mediaGsi)[1];
-    export interface Keys extends Pick<NonKeyAttributes, "gsi1PK" | "gsi1SK"> {}
-    export interface DbRecord extends Keys, NonKeyAttributes {}
+  export namespace ReferredNpos {
+    export interface Keys
+      extends Required<Pick<Endow.NonKeyAttributes, "gsi1PK" | "gsi1SK">> {}
+    export interface DbRecord
+      extends Ensure<
+        Endow.DbRecord,
+        "gsi1PK" | "gsi1SK" | "referrer" | "referrer_expiry"
+      > {}
   }
 }