@better-giving/endowment 1.0.24 → 1.0.26

package/dist/schema.mjs

@@ -86,8 +86,15 @@ export const endowment = object({
     /** endowment is not claimed if `false` only */
     claimed: boolean(),
     kyc_donors_only: boolean(),
+    fiscal_sponsored: boolean(),
 });
-export const endowUpdate = partial(omit(endowment, ["id", "claimed", "kyc_donors_only", "env"]));
+export const endowUpdate = partial(omit(endowment, [
+    "id",
+    "claimed",
+    "kyc_donors_only",
+    "env",
+    "fiscal_sponsored",
+]));
 export const endowFields = keyof(endowment);
 /** for ein path, only fields in reg-num/env gsi is available */
 export const endowQueryParams = object({
@@ -114,6 +121,8 @@ export const newProgram = object({
 });
 export const program = object({
     ...omit(newProgram, ["milestones"]).entries,
+    /** in USD */
+    totalDonations: optional(number()),
     id: programId,
 });
 export const programUpdate = partial(omit(newProgram, ["milestones"]));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@better-giving/endowment",
-  "version": "1.0.24",
+  "version": "1.0.26",
   "peerDependencies": {
     "@better-giving/schemas": "1.0.1",
     "@better-giving/types": "1.0.1",
@@ -9,30 +9,15 @@
   "devDependencies": {
     "@better-giving/config": "workspace:*"
   },
-  "files": [
-    "src",
-    "dist"
-  ],
+  "files": ["src", "dist"],
   "exports": {
-    ".": {
-      "types": "./src/index.mts",
-      "default": "./dist/index.mjs"
-    },
-    "./schema": {
-      "types": "./src/schema.mts",
-      "default": "./dist/schema.mjs"
-    },
-    "./db": {
-      "types": "./src/db.mts",
-      "default": "./dist/db.mjs"
-    },
-    "./cloudsearch": {
-      "types": "./src/cloudsearch.mts",
-      "default": "./dist/cloudsearch.mjs"
-    }
+    ".": "./dist/index.mjs",
+    "./schema": "./dist/schema.mjs",
+    "./db": "./dist/db.mjs",
+    "./cloudsearch": "./dist/cloudsearch.mjs"
   },
   "scripts": {
     "publish": "npm publish --access public",
-    "build": "tsc --outDir dist --declaration false"
+    "build": "tsc --outDir dist"
   }
 }

package/src/cloudsearch.mts

@@ -80,17 +80,20 @@ export const endowsQueryParams = object({
   fields: optional(pipe(csvStrs, array(cloudSearchEndowFields))),
 });
 
-export type CloudsearchEndowsQueryParams = InferInput<typeof endowsQueryParams>;
+export interface CloudsearchEndowsQueryParams
+  extends InferInput<typeof endowsQueryParams> {}
 
-export type CloudsearchEndow = InferOutput<typeof cloudsearchEndow>;
+export interface CloudsearchEndow
+  extends InferOutput<typeof cloudsearchEndow> {}
 
 type DocId = `${Environment}-${number}`;
 
-type Doc = {
+interface Doc extends ToDoc<CloudsearchEndow> {
   documentId: DocId;
   _score: number;
-} & ToDoc<CloudsearchEndow>;
+}
 
-export type HitFields = ToHitFields<Omit<Doc, "documentId" | "_score">>;
+export interface HitFields
+  extends ToHitFields<Omit<Doc, "documentId" | "_score">> {}
 
 export type Update = ToUpdate<DocId, CloudsearchEndow>;

package/src/db.mts

@@ -41,8 +41,6 @@ export namespace Endow {
   };
 
   export type NonKeyAttributes = EndowmentShape & {
-    fiscal_sponsored: boolean;
-
     /** in USD @deprecated */
     payout_minimum?: number;
     /** @deprecated */
@@ -53,77 +51,73 @@ export namespace Endow {
     sfCompounded?: boolean;
   };
 
-  export type DbRecord = Keys & NonKeyAttributes;
+  export interface DbRecord extends Keys, NonKeyAttributes {}
 }
 
 export namespace RegNumEnvGsi {
   export type Name = typeof endowGsi.regnumEnv;
-  export type Keys = Pick<
-    Endow.NonKeyAttributes,
-    "registration_number" | "env"
-  >;
-  export type DbRecord = Keys &
-    Endow.Keys &
-    Pick<Endow.NonKeyAttributes, "claimed" | "name" | "hq_country" | "id">;
+  export interface Keys
+    extends Pick<Endow.NonKeyAttributes, "registration_number" | "env"> {}
+  export interface DbRecord
+    extends Keys,
+      Endow.Keys,
+      Pick<Endow.NonKeyAttributes, "claimed" | "name" | "hq_country" | "id"> {}
 }
 
 export namespace SlugEnvGsi {
   export type Name = typeof endowGsi.slugEnv;
-  export type Keys = Pick<Endow.NonKeyAttributes, "slug" | "env">;
-  export type DbRecord = Endow.DbRecord; //all attributes are copied to this index
+  export interface Keys extends Pick<Endow.NonKeyAttributes, "slug" | "env"> {}
+  export interface DbRecord extends Endow.DbRecord {} //all attributes are copied to this index
 }
 
 export namespace Program {
-  export type Keys = {
+  export interface Keys {
     PK: `Endow#${number}#${Environment}`;
     SK: `Prog#${ProgramId}`;
-  };
+  }
 
-  export type NonKeyAttributes = ProgramShape & {
-    /** in USD */
-    totalDonations?: number;
-  };
-  export type DbRecord = Keys & NonKeyAttributes;
+  export interface NonKeyAttributes extends ProgramShape {}
+  export interface DbRecord extends Keys, NonKeyAttributes {}
 }
 
 export namespace Milestone {
-  export type Keys = {
+  export interface Keys {
     PK: `Prog#${string}#${Environment}`;
     SK: `Mile#${MilestoneId}`;
-  };
-  export type DbRecord = Keys & MilestoneShape;
+  }
+  export interface DbRecord extends Keys, MilestoneShape {}
 }
 
 export const mediaGsi = {
   1: "gsi1",
 } as const;
 export namespace Media {
-  export type Keys = {
+  export interface Keys {
     PK: `Endow#${EndowId}#${Environment}`;
     SK: `Media#${MediaId}`;
-  };
+  }
 
   /** "0" - featured (goes before 1), "1" - not-featured */
   export type FeaturedFlag = "0" | "1";
-  export type NonKeyAttributes = {
+  export interface NonKeyAttributes {
     id: MediaId;
     gsi1PK: Keys["PK"];
     gsi1SK: `MediaList#${FeaturedFlag}#${MediaId}#${MediaType}`;
     /** iso string */
     dateCreated: string;
-  };
+  }
 
-  export type VideoAttributes = NonKeyAttributes & {
+  export interface VideoAttributes extends NonKeyAttributes {
     type: Extract<MediaType, "video">;
     url: string;
-  };
+  }
 
-  export type VideoDbRecord = Keys & VideoAttributes;
+  export interface VideoDbRecord extends Keys, VideoAttributes {}
   export type DbRecord = VideoDbRecord; // | album | article
 
   export namespace Gsi1 {
     export type Name = (typeof mediaGsi)[1];
-    export type Keys = Pick<NonKeyAttributes, "gsi1PK" | "gsi1SK">;
-    export type DbRecord = Keys & NonKeyAttributes;
+    export interface Keys extends Pick<NonKeyAttributes, "gsi1PK" | "gsi1SK"> {}
+    export interface DbRecord extends Keys, NonKeyAttributes {}
   }
 }

package/src/index.mts

@@ -1,13 +1,19 @@
-import type { Endow as NEndow, Media, Program as NProgram } from "./db.mjs";
-import type { Milestone } from "./schema.mjs";
+import type { Media } from "./db.mjs";
+import type { Milestone, Program as ProgramShape } from "./schema.mjs";
 export type {
   Allocation,
   DonateMethodId,
   EndowDesignation,
-  EndowQueryParam,
+  Endowment as Endow,
+  EndowFields,
+  EndowQueryParams,
   EndowUpdate,
   Environment,
   Increment,
+  MediaQueryParams,
+  MediaQueryParamsObj,
+  MediaType,
+  MediaUpdate,
   Milestone,
   MilestoneUpdate,
   NewMilestone,
@@ -15,56 +21,23 @@ export type {
   ProgramUpdate,
   SocialMediaURLs,
   UnSdgNum,
-  MediaQueryParams,
-  MediaQueryParamsObj,
-  MediaType,
-  MediaUpdate,
 } from "./schema.mjs";
 export type {
   CloudsearchEndow as EndowItem,
   CloudsearchEndowsQueryParams as EndowsQueryParams,
 } from "./cloudsearch.mjs";
 
-export type Endow = Pick<
-  NEndow.DbRecord,
-  | "id"
-  | "slug"
-  | "active_in_countries"
-  | "endow_designation"
-  | "fiscal_sponsored"
-  | "hide_bg_tip"
-  | "hq_country"
-  | "image"
-  | "card_img"
-  | "kyc_donors_only"
-  | "logo"
-  | "name"
-  | "overview"
-  | "published"
-  | "registration_number"
-  | "sdgs"
-  | "social_media_urls"
-  | "street_address"
-  | "tagline"
-  | "url"
-  | "claimed"
-  | "progDonationsAllowed"
-  | "donateMethods"
-  | "allocation"
-  | "increments"
-  | "receiptMsg"
->;
-
-export type Program = Omit<NProgram.DbRecord, "PK" | "SK"> & {
+export interface Program extends ProgramShape {
   milestones: Milestone[];
-};
+}
 
 /** web-app format */
-export type TMedia = Omit<Media.DbRecord, "PK" | "SK" | "gsi1PK" | "gsi1SK"> & {
+export interface IMedia
+  extends Omit<Media.DbRecord, "PK" | "SK" | "gsi1PK" | "gsi1SK"> {
   featured: boolean;
-};
+}
 
-export type MediaPage = {
-  items: TMedia[];
+export interface MediaPage {
+  items: IMedia[];
   nextPageKey?: string;
-};
+}

package/src/schema.mts

@@ -62,7 +62,7 @@ export const allocation = pipe(
   check((x) => x.cash + x.liq + x.lock === 100, "must total to 100")
 );
 
-export type Allocation = InferOutput<typeof allocation>;
+export interface Allocation extends InferOutput<typeof allocation> {}
 
 export const endowId = pipe(number(), integer(), minValue(1));
 export type EndowId = InferOutput<typeof endowId>;
@@ -124,7 +124,8 @@ export const social_media_urls = object({
   tiktok: optional(maybeEmptyHttpsUrl),
 });
 
-export type SocialMediaURLs = InferOutput<typeof social_media_urls>;
+export interface SocialMediaURLs
+  extends InferOutput<typeof social_media_urls> {}
 
 export const MAX_RECEIPT_MSG_CHAR = 500;
 
@@ -155,7 +156,7 @@ export const increment = object({
   label: incrementLabel,
 });
 
-export type Increment = InferOutput<typeof increment>;
+export interface Increment extends InferOutput<typeof increment> {}
 
 export const endowment = object({
   id: endowId,
@@ -191,23 +192,30 @@ export const endowment = object({
   /** endowment is not claimed if `false` only */
   claimed: boolean(),
   kyc_donors_only: boolean(),
+  fiscal_sponsored: boolean(),
 });
 
 export const endowUpdate = partial(
-  omit(endowment, ["id", "claimed", "kyc_donors_only", "env"])
+  omit(endowment, [
+    "id",
+    "claimed",
+    "kyc_donors_only",
+    "env",
+    "fiscal_sponsored",
+  ])
 );
 
 export const endowFields = keyof(endowment);
-export type Endowment = InferOutput<typeof endowment>;
-export type EndowUpdate = InferOutput<typeof endowUpdate>;
-export type EndowmentFields = InferOutput<typeof endowFields>;
+export interface Endowment extends InferOutput<typeof endowment> {}
+export interface EndowUpdate extends InferOutput<typeof endowUpdate> {}
+export type EndowFields = InferOutput<typeof endowFields>;
 
 /** for ein path, only fields in reg-num/env gsi is available */
 export const endowQueryParams = object({
   fields: optional(pipe(csvStrs, array(endowFields))),
 });
 
-export type EndowQueryParam = InferInput<typeof endowQueryParams>;
+export interface EndowQueryParams extends InferInput<typeof endowQueryParams> {}
 
 const amnt = pipe(number(), minValue(0));
 export const programId = pipe(str, uuid());
@@ -223,11 +231,11 @@ export const newMilestone = object({
 });
 
 export const milestoneUpdate = partial(newMilestone, ["date"]);
-export type MilestoneUpdate = InferOutput<typeof milestoneUpdate>;
+export interface MilestoneUpdate extends InferOutput<typeof milestoneUpdate> {}
 
-export type NewMilestone = InferOutput<typeof newMilestone>;
+export interface NewMilestone extends InferOutput<typeof newMilestone> {}
 export const milestone = object({ ...newMilestone.entries, id: milestoneId });
-export type Milestone = InferOutput<typeof milestone>;
+export interface Milestone extends InferOutput<typeof milestone> {}
 
 export const newProgram = object({
   title: str,
@@ -240,14 +248,16 @@ export const newProgram = object({
 
 export const program = object({
   ...omit(newProgram, ["milestones"]).entries,
+  /** in USD */
+  totalDonations: optional(number()),
   id: programId,
 });
 
 export const programUpdate = partial(omit(newProgram, ["milestones"]));
 
-export type NewProgram = InferOutput<typeof newProgram>;
-export type Program = InferOutput<typeof program>;
-export type ProgramUpdate = InferOutput<typeof programUpdate>;
+export interface NewProgram extends InferOutput<typeof newProgram> {}
+export interface Program extends InferOutput<typeof program> {}
+export interface ProgramUpdate extends InferOutput<typeof programUpdate> {}
 
 export const mediaUrl = pipe(str, url());
 /**
@@ -263,7 +273,7 @@ export const mediaUpdate = object({
   url: optional(mediaUrl),
   featured: optional(boolean()),
 });
-export type MediaUpdate = InferOutput<typeof mediaUpdate>;
+export interface MediaUpdate extends InferOutput<typeof mediaUpdate> {}
 
 export type MediaId = InferOutput<typeof mediaKsuid>;
 
@@ -287,5 +297,6 @@ export const mediaQueryParams = object({
     )
   ),
 });
-export type MediaQueryParams = InferInput<typeof mediaQueryParams>;
-export type MediaQueryParamsObj = InferOutput<typeof mediaQueryParams>;
+export interface MediaQueryParams extends InferInput<typeof mediaQueryParams> {}
+export interface MediaQueryParamsObj
+  extends InferOutput<typeof mediaQueryParams> {}