@better-giving/endowment 2.0.6 → 3.0.2

package/src/media.mts

@@ -0,0 +1,67 @@
+import type { TRecord } from "@better-giving/db";
+import type { IMedia, TBinFlag } from "./interfaces.mjs";
+import type { IMediaSearchObj, TMediaType } from "./schema.mjs";
+
+export const med_sk = (ksuid: string, type: TMediaType, featured: TBinFlag) =>
+  `MediaList#${featured}#${ksuid}#${type}`;
+
+export const med_sk_attr = (sk: string) => {
+  const [featured, ksuid, type] = sk.split("#").slice(1) as [
+    TBinFlag,
+    string,
+    TMediaType,
+  ];
+  return { featured, ksuid, type };
+};
+
+export function med_key_filter(
+  PK: string,
+  params: IMediaSearchObj
+): [string, Record<string, string>] {
+  /** KSUID string is base62, length:27 */
+  const min_ksuid = "0".repeat(27);
+  const max_ksuid = "z".repeat(27);
+
+  //media categories: get all media per type, all featured - sorted by date
+  if (params.featured && params.type) {
+    return [
+      `gsi1PK = :pk AND gsi1SK BETWEEN :startSK and :endSK`,
+      {
+        ":pk": PK,
+        ":startSK": med_sk(min_ksuid, params.type, "0"),
+        ":endSK": med_sk(max_ksuid, params.type, "0"),
+      },
+    ];
+  }
+
+  //media type page: get all media per type - sorted by featured and date
+  if (params.type) {
+    return [
+      `gsi1PK = :pk AND gsi1SK BETWEEN :startSK and :endSK`,
+      {
+        ":pk": PK,
+        ":startSK": med_sk(min_ksuid, params.type, "0"),
+        ":endSK": med_sk(max_ksuid, params.type, "1"),
+      },
+    ];
+  }
+
+  //endow-profile: get all media, all featured - sorted by date
+  if (params.featured) {
+    return [
+      `gsi1PK = :pk AND begins_with(gsi1SK, :sk)`,
+      { ":pk": PK, ":sk": `MediaList#0` },
+    ];
+  }
+
+  return [
+    `gsi1PK = :pk AND begins_with(gsi1SK, :sk)`,
+    { ":pk": PK, ":sk": `MediaList#` },
+  ];
+}
+
+export const to_imedia = (d: TRecord): IMedia => {
+  const { gsi1SK, gsi1PK, PK, SK, ...rest } = d;
+  const x = med_sk_attr(gsi1SK);
+  return { ...rest, featured: x.featured === "1" } as any;
+};

package/src/npo.mts

@@ -0,0 +1,47 @@
+import type { INpo } from "./schema.mjs";
+
+const npo_fields: { [K in keyof Required<INpo>]: "" } = {
+  id: "",
+  active_in_countries: "",
+  endow_designation: "",
+  fiscal_sponsored: "",
+  hide_bg_tip: "",
+  hq_country: "",
+  image: "",
+  kyc_donors_only: "",
+  logo: "",
+  name: "",
+  overview: "",
+  published: "",
+  registration_number: "",
+  social_media_urls: "",
+  sdgs: "",
+  street_address: "",
+  tagline: "",
+  url: "",
+  slug: "",
+  claimed: "",
+  card_img: "",
+  progDonationsAllowed: "",
+  allocation: "",
+  donateMethods: "",
+  increments: "",
+  receiptMsg: "",
+  fund_opt_in: "",
+  env: "",
+  target: "",
+  referrer: "",
+  referrer_expiry: "",
+  referral_id: "",
+  w_form: "",
+  payout_minimum: "",
+};
+
+export function projection(fields: string[] = Object.keys(npo_fields)) {
+  const expression = fields.map((n) => `#${n}`).join(",");
+  const names = fields.reduce(
+    (prev, curr) => ({ ...prev, [`#${curr}`]: curr }),
+    {} as Record<string, string>
+  );
+  return { expression, names };
+}

package/src/schema.mts

@@ -11,13 +11,6 @@ import {
   org_designation,
   unsdg_num,
 } from "@better-giving/schemas";
-export {
-  type OrgDesignation as EndowDesignation,
-  type Environment,
-  type UnSdgNum,
-  type DonateMethodId,
-  https_url,
-} from "@better-giving/schemas";
 export {
   org_designation as endow_designation,
   env,
@@ -54,25 +47,7 @@ export const allocation = v.pipe(
   v.check((x) => x.cash + x.liq + x.lock === 100, "must total to 100")
 );
 
-export interface Allocation extends v.InferOutput<typeof allocation> {}
-
-export const segmentMaxChars = 30;
-export const segment = v.pipe(
-  $,
-  v.maxLength(
-    segmentMaxChars,
-    ({ requirement: r }) => `cannot exceed ${r} chars`
-  ),
-  //must not be id-like
-  v.regex(/^(?!^\d+$)/, "should not be an id"),
-  //valid characters
-  v.regex(/^[a-zA-Z0-9-._~]+$/, "allowed: numbers | letters | - | . | _ | ~"),
-  v.excludes("..", "should not contain double periods"),
-  v.custom((x) => !(x as string).startsWith("."), "should not start with dot"),
-  v.custom((x) => !(x as string).endsWith("."), "should not end with dot")
-);
-
-export const slug = v.lazy((x) => (x ? segment : $));
+export interface IAllocation extends v.InferOutput<typeof allocation> {}
 
 export const reg_number = v.pipe(
   $,
@@ -91,37 +66,37 @@ export const social_media_urls = v.object({
   tiktok: v.optional(https_url(false)),
 });
 
-export interface SocialMediaURLs
+export interface ISocialMediaURLs
   extends v.InferOutput<typeof social_media_urls> {}
 
 export const MAX_RECEIPT_MSG_CHAR = 500;
 
-export const incrementVal = v.pipe(
+export const increment_val = v.pipe(
   $req_num_gt0,
   //parsed output
   v.transform((x) => x.toString())
 );
 
 export const MAX_NUM_INCREMENTS = 4;
-export const incrementLabelMaxChars = 60;
-export const taglineMaxChars = 140;
+export const increment_label_max_chars = 60;
+export const tagline_max_chars = 140;
 
-export const incrementLabel = v.pipe(
+export const increment_label = v.pipe(
   $,
   v.maxLength(
-    incrementLabelMaxChars,
+    increment_label_max_chars,
     ({ requirement: r }) => `cannot exceed ${r} characters`
   )
 );
 
 export const increment = v.object({
-  value: incrementVal,
-  label: incrementLabel,
+  value: increment_val,
+  label: increment_label,
 });
 
-export interface Increment extends v.InferOutput<typeof increment> {}
+export interface IIncrement extends v.InferOutput<typeof increment> {}
 
-export const endowment = v.object({
+export const npo = v.object({
   id: int_gte1,
   env,
   slug: v.optional(slug),
@@ -129,7 +104,7 @@ export const endowment = v.object({
   name: $req,
   endow_designation: org_designation,
   overview: v.optional($),
-  tagline: v.optional(v.pipe($, v.maxLength(taglineMaxChars))),
+  tagline: v.optional(v.pipe($, v.maxLength(tagline_max_chars))),
   image: v.optional(_url),
   logo: v.optional(_url),
   card_img: v.optional(_url),
@@ -177,93 +152,88 @@ export const endowment = v.object({
   payout_minimum: v.optional(v.pipe(v.number(), v.minValue(min_payout_amount))),
 });
 
-export const endowUpdate = v.partial(
-  v.omit(endowment, [
-    "id",
-    "claimed",
-    "kyc_donors_only",
-    "env",
-    "fiscal_sponsored",
-  ])
+export const npo_update = v.partial(
+  v.omit(npo, ["id", "claimed", "kyc_donors_only", "env", "fiscal_sponsored"])
 );
 
-export const endowFields = v.keyof(endowment);
-export interface Endowment extends v.InferOutput<typeof endowment> {}
-export interface EndowUpdate extends v.InferOutput<typeof endowUpdate> {}
-export type EndowFields = v.InferOutput<typeof endowFields>;
+export const npo_fields = v.keyof(npo);
+export interface INpo extends v.InferOutput<typeof npo> {}
+export interface INpoUpdate extends v.InferOutput<typeof npo_update> {}
+export type INpoFields = v.InferOutput<typeof npo_fields>;
 
 /** for ein path, only fields in reg-num/env gsi is available */
-export const endowQueryParams = v.object({
-  fields: v.optional(v.pipe(csvStrs, v.array(endowFields))),
+export const npo_search = v.object({
+  fields: v.optional(v.pipe(csvStrs, v.array(npo_fields))),
 });
 
-export interface EndowQueryParams
-  extends v.InferInput<typeof endowQueryParams> {}
+export interface INposSearch extends v.InferInput<typeof npo_search> {}
 
 const amnt = v.pipe(v.number(), v.minValue(0));
-export const programId = v.pipe($, v.uuid());
-export type ProgramId = v.InferOutput<typeof programId>;
-export const milestoneId = v.pipe($, v.uuid());
-export type MilestoneId = v.InferOutput<typeof milestoneId>;
+export const program_id = v.pipe($, v.uuid());
+export const milestone_id = v.pipe($, v.uuid());
 
-export const newMilestone = v.object({
+export const milestone_new = v.object({
   date: v.pipe($, v.isoTimestamp()),
   title: $,
   description: $,
   media: v.optional(_url),
 });
 
-export const milestoneUpdate = v.partial(newMilestone, ["date"]);
-export interface MilestoneUpdate
-  extends v.InferOutput<typeof milestoneUpdate> {}
+export const milestone_update = v.partial(milestone_new, ["date"]);
+export interface IMilestoneUpdate
+  extends v.InferOutput<typeof milestone_update> {}
 
-export interface NewMilestone extends v.InferOutput<typeof newMilestone> {}
-export const milestone = v.object({ ...newMilestone.entries, id: milestoneId });
-export interface Milestone extends v.InferOutput<typeof milestone> {}
+export interface IMilestoneNew extends v.InferOutput<typeof milestone_new> {}
+export const milestone = v.object({
+  ...milestone_new.entries,
+  id: milestone_id,
+});
+export interface IMilestone extends v.InferOutput<typeof milestone> {}
 
-export const newProgram = v.object({
+export const program_new = v.object({
   title: $,
   description: $,
   banner: v.optional(_url),
   /** null unsets target */
   targetRaise: v.nullish(amnt),
-  milestones: v.pipe(v.array(newMilestone), v.maxLength(24)),
+  milestones: v.pipe(v.array(milestone_new), v.maxLength(24)),
 });
 
 export const program = v.object({
-  ...v.omit(newProgram, ["milestones"]).entries,
+  ...v.omit(program_new, ["milestones"]).entries,
   /** in USD */
   totalDonations: v.optional(v.number()),
-  id: programId,
+  id: program_id,
 });
 
-export const programUpdate = v.partial(v.omit(newProgram, ["milestones"]));
+export const program_update = v.partial(v.omit(program_new, ["milestones"]));
 
-export interface NewProgram extends v.InferOutput<typeof newProgram> {}
-export interface Program extends v.InferOutput<typeof program> {}
-export interface ProgramUpdate extends v.InferOutput<typeof programUpdate> {}
+export interface IProgramNew extends v.InferOutput<typeof program_new> {}
+export interface IProgramDb extends v.InferOutput<typeof program> {}
+export interface IProgram extends v.InferOutput<typeof program> {
+  milestones: IMilestone[];
+}
+export interface IProgramUpdate extends v.InferOutput<typeof program_update> {}
 
-export const mediaUrl = v.pipe($, v.url());
+export const media_url = v.pipe($, v.url());
 /**
  * so that media is automatically sorted by date
  * @see https://github.com/segmentio/ksuid
  * */
-export const mediaKsuid = $req; // base62;
-export const mediaTypes = ["album", "article", "video"] as const;
-export const mediaType = v.picklist(mediaTypes);
-export type MediaType = v.InferOutput<typeof mediaType>;
+export const media_ksuid = $req; // base62;
+export const media_types = ["album", "article", "video"] as const;
+export const media_type = v.picklist(media_types);
+export type TMediaType = v.InferOutput<typeof media_type>;
 
-export const mediaUpdate = v.object({
-  url: v.optional(mediaUrl),
+export const media_update = v.object({
+  url: v.optional(media_url),
   featured: v.optional(v.boolean()),
 });
-export interface MediaUpdate extends v.InferOutput<typeof mediaUpdate> {}
-
-export type MediaId = v.InferOutput<typeof mediaKsuid>;
+export interface IMediaUpdate extends v.InferOutput<typeof media_update> {}
 
-export const mediaQueryParams = v.object({
-  type: v.optional(mediaType),
-  nextPageKey: v.optional(v.pipe($, v.base64())),
+export const media_search = v.object({
+  type: v.optional(media_type),
+  next: v.optional(v.pipe($, v.base64())),
   featured: v.optional(
     v.pipe(
       $,
@@ -279,7 +249,5 @@ export const mediaQueryParams = v.object({
     )
   ),
 });
-export interface MediaQueryParams
-  extends v.InferInput<typeof mediaQueryParams> {}
-export interface MediaQueryParamsObj
-  extends v.InferOutput<typeof mediaQueryParams> {}
+export interface IMediaSearch extends v.InferInput<typeof media_search> {}
+export interface IMediaSearchObj extends v.InferOutput<typeof media_search> {}