@better-giving/endowment 1.0.8 → 1.0.9

package/dist/db.d.mts

@@ -1,5 +1,9 @@
 import type { EndowId, Endowment as EndowmentShape, Environment, 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 gsi: {
+    readonly regnumEnv: "regnum-env-gsi";
+    readonly slugEnv: "slug-env-gsi";
+};
 export declare namespace EndowCount {
     interface Keys {
         PK: "Count";
@@ -25,17 +29,18 @@ export declare namespace Endow {
         splitLiqPct?: number;
         /** @deprecated */
         splitFixed?: boolean;
+        /** @deprecated */
         sfCompounded?: boolean;
     };
     type DBRecord = Keys & NonKeyAttributes;
 }
 export declare namespace RegNumEnvGsi {
-    type Name = "regnum-env-gsi";
+    type Name = typeof gsi.regnumEnv;
     type Keys = Pick<Endow.NonKeyAttributes, "registration_number" | "env">;
     type DBRecord = Keys & Endow.Keys & Pick<Endow.NonKeyAttributes, "claimed" | "name" | "hq_country" | "id">;
 }
 export declare namespace SlugEnvGsi {
-    type Name = "slug-env-gsi";
+    type Name = typeof gsi.slugEnv;
     type Keys = Pick<Endow.NonKeyAttributes, "slug" | "env">;
     type DBRecord = Endow.DBRecord;
 }

package/dist/db.mjs

@@ -1 +1,4 @@
-export {};
+export const gsi = {
+    regnumEnv: "regnum-env-gsi",
+    slugEnv: "slug-env-gsi",
+};

package/dist/schema.mjs

@@ -1,6 +1,6 @@
 import { env, orgDesignation, unSdgNum } from "@better-giving/schemas";
 export { orgDesignation as endowDesignation, env, unSdgNum };
-import { url, array, boolean, check, custom, excludes, integer, isoDate, keyof, lazy, maxLength, maxValue, minLength, minValue, nonEmpty, nullish, number, object, omit, optional, partial, picklist, pipe, regex, string, transform, trim, uuid, startsWith, } from "valibot";
+import { url, array, boolean, check, custom, excludes, integer, isoDate, keyof, lazy, maxLength, maxValue, minLength, minValue, nonEmpty, nullish, number, object, omit, optional, partial, picklist, pipe, regex, startsWith, string, transform, trim, uuid, } from "valibot";
 export const str = pipe(string(), trim());
 const pct = pipe(number(), integer(), minValue(0), maxValue(100));
 export const allocation = pipe(object({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@better-giving/endowment",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "peerDependencies": {
     "@better-giving/schemas": "1.0.1",
     "@better-giving/types": "1.0.1"

package/src/db.mts

@@ -2,6 +2,8 @@ import type {
   EndowId,
   Endowment as EndowmentShape,
   Environment,
+  MediaId,
+  MediaType,
   Milestone as MilestoneShape,
   MilestoneId,
   Program as ProgramShape,
@@ -17,6 +19,11 @@ export type {
   ProgramId,
 } from "./schema.mjs";
 
+export const endowGsi = {
+  regnumEnv: "regnum-env-gsi",
+  slugEnv: "slug-env-gsi",
+} as const;
+
 export namespace EndowCount {
   export interface Keys {
     PK: "Count";
@@ -45,27 +52,28 @@ export namespace Endow {
     splitLiqPct?: number;
     /** @deprecated */
     splitFixed?: boolean;
+    /** @deprecated */
     sfCompounded?: boolean;
   };
 
-  export type DBRecord = Keys & NonKeyAttributes;
+  export type DbRecord = Keys & NonKeyAttributes;
 }
 
 export namespace RegNumEnvGsi {
-  export type Name = "regnum-env-gsi";
+  export type Name = typeof endowGsi.regnumEnv;
   export type Keys = Pick<
     Endow.NonKeyAttributes,
     "registration_number" | "env"
   >;
-  export type DBRecord = Keys &
+  export type DbRecord = Keys &
     Endow.Keys &
     Pick<Endow.NonKeyAttributes, "claimed" | "name" | "hq_country" | "id">;
 }
 
 export namespace SlugEnvGsi {
-  export type Name = "slug-env-gsi";
+  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 type DbRecord = Endow.DbRecord; //all attributes are copied to this index
 }
 
 export namespace Program {
@@ -78,7 +86,7 @@ export namespace Program {
     /** in USD */
     totalDonations?: number;
   };
-  export type DBRecord = Keys & NonKeyAttributes;
+  export type DbRecord = Keys & NonKeyAttributes;
 }
 
 export namespace Milestone {
@@ -86,5 +94,39 @@ export namespace Milestone {
     PK: `Prog#${string}#${Environment}`;
     SK: `Mile#${MilestoneId}`;
   };
-  export type DBRecord = Keys & MilestoneShape;
+  export type DbRecord = Keys & MilestoneShape;
+}
+
+export const mediaGsi = {
+  1: "gsi1",
+} as const;
+export namespace Media {
+  export type Keys = {
+    PK: `Endow#${EndowId}#${Environment}`;
+    SK: `Media#${MediaId}`;
+  };
+
+  /** "0" - featured (goes before 1), "1" - not-featured */
+  export type FeaturedFlag = "0" | "1";
+  export type NonKeyAttributes = {
+    id: MediaId;
+    gsi1PK: Keys["PK"];
+    gsi1SK: `MediaList#${FeaturedFlag}#${MediaId}#${MediaType}`;
+    /** iso string */
+    dateCreated: string;
+  };
+
+  export type VideoAttributes = NonKeyAttributes & {
+    type: Extract<MediaType, "video">;
+    url: string;
+  };
+
+  export type VideoDbRecord = 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;
+  }
 }

package/src/index.mts

@@ -18,11 +18,13 @@ export type {
   ProgramUpdate,
   SocialMediaURLs,
   UnSdgNum,
+  MediaQueryParams,
+  MediaType,
 } from "./schema.mjs";
 export type { FundItem };
 
 export type Endow = Pick<
-  NEndow.DBRecord,
+  NEndow.DbRecord,
   | "id"
   | "slug"
   | "active_in_countries"

package/src/schema.mts

@@ -10,6 +10,7 @@ import {
   type InferInput,
   type InferOutput,
   array,
+  base64,
   boolean,
   check,
   custom,
@@ -32,11 +33,11 @@ import {
   picklist,
   pipe,
   regex,
+  startsWith,
   string,
   transform,
   trim,
   uuid,
-  startsWith,
 } from "valibot";
 
 export const str = pipe(string(), trim());
@@ -290,3 +291,42 @@ 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 const mediaUrl = pipe(str, url());
+/**
+ * so that media is automatically sorted by date
+ * @see https://github.com/segmentio/ksuid
+ * */
+export const mediaKsuid = pipe(str, nonEmpty() /** base62? */);
+export const mediaTypes = ["album", "article", "video"] as const;
+export const mediaType = picklist(mediaTypes);
+export type MediaType = InferOutput<typeof mediaType>;
+
+export const mediaUpdate = object({
+  url: optional(mediaUrl),
+  featured: optional(boolean()),
+});
+
+export type MediaId = InferOutput<typeof mediaKsuid>;
+
+export const mediaQueryParams = object({
+  type: mediaType,
+  nextPageKey: optional(pipe(str, base64())),
+  featured: optional(
+    pipe(
+      str,
+      transform((x) => Boolean(x)),
+      boolean()
+    )
+  ),
+  limit: optional(
+    pipe(
+      string(),
+      transform((x) => +x),
+      number(),
+      integer(),
+      minValue(1)
+    )
+  ),
+});
+export type MediaQueryParams = InferInput<typeof mediaQueryParams>;