@better-giving/endowment 2.0.6 → 3.0.0

package/dist/interfaces.d.mts

@@ -0,0 +1,41 @@
+import type { IPageKeyed } from "@better-giving/types/api";
+import type { Ensure } from "@better-giving/types/utils";
+import type { IMediaUpdate, INpo, TMediaType } from "./schema.mjs";
+export type { IAllocation, INpo, INpoFields, INposSearch, INpoUpdate, IIncrement, IMediaSearch, IMediaSearchObj, TMediaType, IMediaUpdate, IMilestone, IMilestoneUpdate, IMilestoneNew, IProgramNew, IProgramUpdate, ISocialMediaURLs, } from "./schema.mjs";
+export { type OrgDesignation as EndowDesignation, type Environment, type UnSdgNum, type DonateMethodId, https_url, } from "@better-giving/schemas";
+export interface INpoDb extends INpo {
+    /** will only be present for unclaimed NPOs */
+    updated_at_auto?: string;
+    /** in USD @deprecated */
+    payout_minimum?: number;
+    /** @deprecated */
+    splitLiqPct?: number;
+    /** @deprecated */
+    splitFixed?: boolean;
+    /** @deprecated */
+    sfCompounded?: boolean;
+}
+export interface INpoReferredBy extends Ensure<INpo, "referrer" | "referrer_expiry"> {
+}
+export interface INpoWithRid extends Ensure<INpo, "referral_id"> {
+}
+export interface INpoWithRegNum extends Pick<INpo, "claimed" | "name" | "hq_country" | "id"> {
+}
+export interface IMedia extends Required<IMediaUpdate> {
+    id: string;
+    type: Extract<TMediaType, "video">;
+    dateCreated: string;
+}
+export interface IMediaDb extends Omit<IMedia, "featured"> {
+}
+export interface IMediaPage extends IPageKeyed<IMedia> {
+}
+export type TNpoDbKeys = keyof INpoDb;
+export type TArrayValues<T extends readonly unknown[]> = T[number];
+export type TNpoDbProjectedTo<T> = T extends TNpoDbKeys[] ? Pick<INpoDb, TArrayValues<T>> : INpoDb;
+export type TBinFlag = "0" | "1";
+export interface INposPage<T extends keyof INpoDb = keyof INpoDb> {
+    items: Pick<INpoDb, T>[];
+    page: number;
+    pages: number;
+}

package/dist/interfaces.mjs

@@ -0,0 +1 @@
+export { https_url, } from "@better-giving/schemas";

package/dist/media.d.mts

@@ -0,0 +1,11 @@
+import type { TRecord } from "@better-giving/db";
+import type { IMedia, TBinFlag } from "./interfaces.mjs";
+import type { IMediaSearchObj, TMediaType } from "./schema.mjs";
+export declare const med_sk: (ksuid: string, type: TMediaType, featured: TBinFlag) => string;
+export declare const med_sk_attr: (sk: string) => {
+    featured: TBinFlag;
+    ksuid: string;
+    type: "album" | "article" | "video";
+};
+export declare function med_key_filter(PK: string, params: IMediaSearchObj): [string, Record<string, string>];
+export declare const to_imedia: (d: TRecord) => IMedia;

package/dist/media.mjs

@@ -0,0 +1,48 @@
+export const med_sk = (ksuid, type, featured) => `MediaList#${featured}#${ksuid}#${type}`;
+export const med_sk_attr = (sk) => {
+    const [featured, ksuid, type] = sk.split("#").slice(1);
+    return { featured, ksuid, type };
+};
+export function med_key_filter(PK, params) {
+    /** 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) => {
+    const { gsi1SK, gsi1PK, PK, SK, ...rest } = d;
+    const x = med_sk_attr(gsi1SK);
+    return { ...rest, featured: x.featured === "1" };
+};

package/dist/npo.d.mts

@@ -0,0 +1,4 @@
+export declare function projection(fields?: string[]): {
+    expression: string;
+    names: Record<string, string>;
+};

package/dist/npo.mjs

@@ -0,0 +1,41 @@
+const npo_fields = {
+    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 = Object.keys(npo_fields)) {
+    const expression = fields.map((n) => `#${n}`).join(",");
+    const names = fields.reduce((prev, curr) => ({ ...prev, [`#${curr}`]: curr }), {});
+    return { expression, names };
+}

package/dist/schema.d.mts

@@ -1,5 +1,4 @@
 import { $, $int_gte1, $req, $req_num_gt0, donate_method_id, donate_method_ids, env, int_gte1, 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, unsdg_num, donate_method_id, donate_method_ids, $int_gte1, int_gte1, $, $req_num_gt0, $req, };
 import * as v from "valibot";
 export declare const min_payout_amount = 50;
@@ -14,9 +13,9 @@ export declare const allocation: v.SchemaWithPipe<[v.ObjectSchema<{
     liq: number;
     lock: number;
 }, "must total to 100">]>;
-export interface Allocation extends v.InferOutput<typeof allocation> {
+export interface IAllocation extends v.InferOutput<typeof allocation> {
 }
-export declare const segmentMaxChars = 30;
+export declare const segment_max_chars = 30;
 export declare const segment: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.MaxLengthAction<string, 30, ({ requirement: r }: v.MaxLengthIssue<string, 30>) => string>, v.RegexAction<string, "should not be an id">, v.RegexAction<string, "allowed: numbers | letters | - | . | _ | ~">, v.ExcludesAction<string, "..", "should not contain double periods">, v.CustomSchema<string, "should not start with dot">, v.CustomSchema<string, "should not end with dot">]>;
 export declare const slug: v.LazySchema<v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]> | v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.MaxLengthAction<string, 30, ({ requirement: r }: v.MaxLengthIssue<string, 30>) => string>, v.RegexAction<string, "should not be an id">, v.RegexAction<string, "allowed: numbers | letters | - | . | _ | ~">, v.ExcludesAction<string, "..", "should not contain double periods">, v.CustomSchema<string, "should not start with dot">, v.CustomSchema<string, "should not end with dot">]>>;
 export declare const reg_number: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, "required">, v.RegexAction<string, "must only contain letters and numbers">]>;
@@ -30,21 +29,21 @@ export declare const social_media_urls: v.ObjectSchema<{
     readonly youtube: v.OptionalSchema<v.LazySchema<v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]> | v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, "required">]> | v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.TransformAction<string, string>, v.UrlAction<string, "invalid url">]>>, never>;
     readonly tiktok: v.OptionalSchema<v.LazySchema<v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]> | v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, "required">]> | v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.TransformAction<string, string>, v.UrlAction<string, "invalid url">]>>, never>;
 }, undefined>;
-export interface SocialMediaURLs extends v.InferOutput<typeof social_media_urls> {
+export interface ISocialMediaURLs extends v.InferOutput<typeof social_media_urls> {
 }
 export declare const MAX_RECEIPT_MSG_CHAR = 500;
-export declare const incrementVal: v.SchemaWithPipe<[v.SchemaWithPipe<[v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, "required">]>, v.TransformAction<string, number>, v.NumberSchema<"invalid number">, v.MinValueAction<number, 0, "must be > 0">, v.TransformAction<number, string>]>, v.TransformAction<string, string>]>;
+export declare const increment_val: v.SchemaWithPipe<[v.SchemaWithPipe<[v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, "required">]>, v.TransformAction<string, number>, v.NumberSchema<"invalid number">, v.MinValueAction<number, 0, "must be > 0">, v.TransformAction<number, string>]>, v.TransformAction<string, string>]>;
 export declare const MAX_NUM_INCREMENTS = 4;
-export declare const incrementLabelMaxChars = 60;
-export declare const taglineMaxChars = 140;
-export declare const incrementLabel: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.MaxLengthAction<string, 60, ({ requirement: r }: v.MaxLengthIssue<string, 60>) => string>]>;
+export declare const increment_label_max_chars = 60;
+export declare const tagline_max_chars = 140;
+export declare const increment_label: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.MaxLengthAction<string, 60, ({ requirement: r }: v.MaxLengthIssue<string, 60>) => string>]>;
 export declare const increment: v.ObjectSchema<{
     readonly value: v.SchemaWithPipe<[v.SchemaWithPipe<[v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, "required">]>, v.TransformAction<string, number>, v.NumberSchema<"invalid number">, v.MinValueAction<number, 0, "must be > 0">, v.TransformAction<number, string>]>, v.TransformAction<string, string>]>;
     readonly label: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.MaxLengthAction<string, 60, ({ requirement: r }: v.MaxLengthIssue<string, 60>) => string>]>;
 }, undefined>;
-export interface Increment extends v.InferOutput<typeof increment> {
+export interface IIncrement extends v.InferOutput<typeof increment> {
 }
-export declare const endowment: v.ObjectSchema<{
+export declare const npo: v.ObjectSchema<{
     readonly id: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>;
     readonly env: v.PicklistSchema<readonly ["staging", "production"], undefined>;
     readonly slug: v.OptionalSchema<v.LazySchema<v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]> | v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.MaxLengthAction<string, 30, ({ requirement: r }: v.MaxLengthIssue<string, 30>) => string>, v.RegexAction<string, "should not be an id">, v.RegexAction<string, "allowed: numbers | letters | - | . | _ | ~">, v.ExcludesAction<string, "..", "should not contain double periods">, v.CustomSchema<string, "should not start with dot">, v.CustomSchema<string, "should not end with dot">]>>, never>;
@@ -105,7 +104,7 @@ export declare const endowment: v.ObjectSchema<{
     readonly w_form: v.OptionalSchema<v.StringSchema<undefined>, never>;
     readonly payout_minimum: v.OptionalSchema<v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 50, undefined>]>, never>;
 }, undefined>;
-export declare const endowUpdate: Omit<Omit<v.ObjectSchema<{
+export declare const npo_update: Omit<Omit<v.ObjectSchema<{
     readonly id: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>;
     readonly env: v.PicklistSchema<readonly ["staging", "production"], undefined>;
     readonly slug: v.OptionalSchema<v.LazySchema<v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]> | v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.MaxLengthAction<string, 30, ({ requirement: r }: v.MaxLengthIssue<string, 30>) => string>, v.RegexAction<string, "should not be an id">, v.RegexAction<string, "allowed: numbers | letters | - | . | _ | ~">, v.ExcludesAction<string, "..", "should not contain double periods">, v.CustomSchema<string, "should not start with dot">, v.CustomSchema<string, "should not end with dot">]>>, never>;
@@ -606,29 +605,27 @@ export declare const endowUpdate: Omit<Omit<v.ObjectSchema<{
         }[], 4> | v.LiteralIssue | v.UnionIssue<v.StringIssue | v.NumberIssue | v.MinValueIssue<number, 0> | v.LiteralIssue> | v.IsoTimestampIssue<string> | v.MinValueIssue<number, 50>;
     } | undefined;
 };
-export declare const endowFields: v.PicklistSchema<["url", "slug", "overview", "tagline", "image", "logo", "card_img", "active_in_countries", "street_address", "sdgs", "receiptMsg", "hide_bg_tip", "published", "progDonationsAllowed", "allocation", "donateMethods", "increments", "fund_opt_in", "target", "referral_id", "referrer", "referrer_expiry", "w_form", "payout_minimum", "id", "env", "registration_number", "name", "endow_designation", "hq_country", "social_media_urls", "claimed", "kyc_donors_only", "fiscal_sponsored"], undefined>;
-export interface Endowment extends v.InferOutput<typeof endowment> {
+export declare const npo_fields: v.PicklistSchema<["url", "slug", "overview", "tagline", "image", "logo", "card_img", "active_in_countries", "street_address", "sdgs", "receiptMsg", "hide_bg_tip", "published", "progDonationsAllowed", "allocation", "donateMethods", "increments", "fund_opt_in", "target", "referral_id", "referrer", "referrer_expiry", "w_form", "payout_minimum", "id", "env", "registration_number", "name", "endow_designation", "hq_country", "social_media_urls", "claimed", "kyc_donors_only", "fiscal_sponsored"], undefined>;
+export interface INpo extends v.InferOutput<typeof npo> {
 }
-export interface EndowUpdate extends v.InferOutput<typeof endowUpdate> {
+export interface INpoUpdate extends v.InferOutput<typeof npo_update> {
 }
-export type EndowFields = v.InferOutput<typeof endowFields>;
+export type INpoFields = v.InferOutput<typeof npo_fields>;
 /** for ein path, only fields in reg-num/env gsi is available */
-export declare const endowQueryParams: v.ObjectSchema<{
+export declare const npo_search: v.ObjectSchema<{
     readonly fields: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.LazySchema<v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]> | v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.RegexAction<string, "invalid csv">]>>, v.TransformAction<string, string[]>, v.FilterItemsAction<string[]>]>, v.ArraySchema<v.PicklistSchema<["url", "slug", "overview", "tagline", "image", "logo", "card_img", "active_in_countries", "street_address", "sdgs", "receiptMsg", "hide_bg_tip", "published", "progDonationsAllowed", "allocation", "donateMethods", "increments", "fund_opt_in", "target", "referral_id", "referrer", "referrer_expiry", "w_form", "payout_minimum", "id", "env", "registration_number", "name", "endow_designation", "hq_country", "social_media_urls", "claimed", "kyc_donors_only", "fiscal_sponsored"], undefined>, undefined>]>, never>;
 }, undefined>;
-export interface EndowQueryParams extends v.InferInput<typeof endowQueryParams> {
+export interface INposSearch extends v.InferInput<typeof npo_search> {
 }
-export declare const programId: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.UuidAction<string, undefined>]>;
-export type ProgramId = v.InferOutput<typeof programId>;
-export declare const milestoneId: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.UuidAction<string, undefined>]>;
-export type MilestoneId = v.InferOutput<typeof milestoneId>;
-export declare const newMilestone: v.ObjectSchema<{
+export declare const program_id: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.UuidAction<string, undefined>]>;
+export declare const milestone_id: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.UuidAction<string, undefined>]>;
+export declare const milestone_new: v.ObjectSchema<{
     readonly date: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.IsoTimestampAction<string, undefined>]>;
     readonly title: v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>;
     readonly description: v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>;
     readonly media: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.UrlAction<string, undefined>]>, never>;
 }, undefined>;
-export declare const milestoneUpdate: Omit<v.ObjectSchema<{
+export declare const milestone_update: Omit<v.ObjectSchema<{
     readonly date: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.IsoTimestampAction<string, undefined>]>;
     readonly title: v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>;
     readonly description: v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>;
@@ -662,9 +659,9 @@ export declare const milestoneUpdate: Omit<v.ObjectSchema<{
         readonly issue: v.StringIssue | v.ObjectIssue | v.UrlIssue<string> | v.IsoTimestampIssue<string>;
     } | undefined;
 };
-export interface MilestoneUpdate extends v.InferOutput<typeof milestoneUpdate> {
+export interface IMilestoneUpdate extends v.InferOutput<typeof milestone_update> {
 }
-export interface NewMilestone extends v.InferOutput<typeof newMilestone> {
+export interface IMilestoneNew extends v.InferOutput<typeof milestone_new> {
 }
 export declare const milestone: v.ObjectSchema<{
     readonly id: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.UuidAction<string, undefined>]>;
@@ -673,9 +670,9 @@ export declare const milestone: v.ObjectSchema<{
     readonly description: v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>;
     readonly media: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.UrlAction<string, undefined>]>, never>;
 }, undefined>;
-export interface Milestone extends v.InferOutput<typeof milestone> {
+export interface IMilestone extends v.InferOutput<typeof milestone> {
 }
-export declare const newProgram: v.ObjectSchema<{
+export declare const program_new: v.ObjectSchema<{
     readonly title: v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>;
     readonly description: v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>;
     readonly banner: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.UrlAction<string, undefined>]>, never>;
@@ -702,7 +699,7 @@ export declare const program: v.ObjectSchema<{
     readonly banner: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.UrlAction<string, undefined>]>, never>;
     readonly targetRaise: v.NullishSchema<v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 0, undefined>]>, never>;
 }, undefined>;
-export declare const programUpdate: Omit<Omit<v.ObjectSchema<{
+export declare const program_update: Omit<Omit<v.ObjectSchema<{
     readonly title: v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>;
     readonly description: v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>;
     readonly banner: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.UrlAction<string, undefined>]>, never>;
@@ -788,35 +785,37 @@ export declare const programUpdate: Omit<Omit<v.ObjectSchema<{
         readonly issue: v.StringIssue | v.NumberIssue | v.MinValueIssue<number, 0> | v.ObjectIssue | v.UrlIssue<string>;
     } | undefined;
 };
-export interface NewProgram extends v.InferOutput<typeof newProgram> {
+export interface IProgramNew extends v.InferOutput<typeof program_new> {
 }
-export interface Program extends v.InferOutput<typeof program> {
+export interface IProgramDb extends v.InferOutput<typeof program> {
 }
-export interface ProgramUpdate extends v.InferOutput<typeof programUpdate> {
+export interface IProgram extends v.InferOutput<typeof program> {
+    milestones: IMilestone[];
 }
-export declare const mediaUrl: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.UrlAction<string, undefined>]>;
+export interface IProgramUpdate extends v.InferOutput<typeof program_update> {
+}
+export declare const media_url: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.UrlAction<string, undefined>]>;
 /**
  * so that media is automatically sorted by date
  * @see https://github.com/segmentio/ksuid
  * */
-export declare const mediaKsuid: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, "required">]>;
-export declare const mediaTypes: readonly ["album", "article", "video"];
-export declare const mediaType: v.PicklistSchema<readonly ["album", "article", "video"], undefined>;
-export type MediaType = v.InferOutput<typeof mediaType>;
-export declare const mediaUpdate: v.ObjectSchema<{
+export declare const media_ksuid: v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.NonEmptyAction<string, "required">]>;
+export declare const media_types: readonly ["album", "article", "video"];
+export declare const media_type: v.PicklistSchema<readonly ["album", "article", "video"], undefined>;
+export type TMediaType = v.InferOutput<typeof media_type>;
+export declare const media_update: v.ObjectSchema<{
     readonly url: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.UrlAction<string, undefined>]>, never>;
     readonly featured: v.OptionalSchema<v.BooleanSchema<undefined>, never>;
 }, undefined>;
-export interface MediaUpdate extends v.InferOutput<typeof mediaUpdate> {
+export interface IMediaUpdate extends v.InferOutput<typeof media_update> {
 }
-export type MediaId = v.InferOutput<typeof mediaKsuid>;
-export declare const mediaQueryParams: v.ObjectSchema<{
+export declare const media_search: v.ObjectSchema<{
     readonly type: v.OptionalSchema<v.PicklistSchema<readonly ["album", "article", "video"], undefined>, never>;
-    readonly nextPageKey: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.Base64Action<string, undefined>]>, never>;
+    readonly next: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.Base64Action<string, undefined>]>, never>;
     readonly featured: v.OptionalSchema<v.SchemaWithPipe<[v.SchemaWithPipe<[v.StringSchema<undefined>, v.TrimAction]>, v.TransformAction<string, boolean>, v.BooleanSchema<undefined>]>, never>;
     readonly limit: v.OptionalSchema<v.SchemaWithPipe<[v.StringSchema<undefined>, v.TransformAction<string, number>, v.SchemaWithPipe<[v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>]>, never>;
 }, undefined>;
-export interface MediaQueryParams extends v.InferInput<typeof mediaQueryParams> {
+export interface IMediaSearch extends v.InferInput<typeof media_search> {
 }
-export interface MediaQueryParamsObj extends v.InferOutput<typeof mediaQueryParams> {
+export interface IMediaSearchObj extends v.InferOutput<typeof media_search> {
 }

package/dist/schema.mjs

@@ -1,5 +1,4 @@
 import { $, $int_gte1, $req, $req_num_gt0, donate_method_id, donate_method_ids, env, https_url, int_gte1, org_designation, unsdg_num, } from "@better-giving/schemas";
-export { https_url, } from "@better-giving/schemas";
 export { org_designation as endow_designation, env, unsdg_num, donate_method_id, donate_method_ids, $int_gte1, int_gte1, $, $req_num_gt0, $req, };
 import * as v from "valibot";
 export const min_payout_amount = 50;
@@ -15,8 +14,8 @@ export const allocation = v.pipe(v.object({
     liq: pct,
     lock: pct,
 }), v.check((x) => x.cash + x.liq + x.lock === 100, "must total to 100"));
-export const segmentMaxChars = 30;
-export const segment = v.pipe($, v.maxLength(segmentMaxChars, ({ requirement: r }) => `cannot exceed ${r} chars`), 
+export const segment_max_chars = 30;
+export const segment = v.pipe($, v.maxLength(segment_max_chars, ({ requirement: r }) => `cannot exceed ${r} chars`), 
 //must not be id-like
 v.regex(/^(?!^\d+$)/, "should not be an id"), 
 //valid characters
@@ -34,18 +33,18 @@ export const social_media_urls = v.object({
     tiktok: v.optional(https_url(false)),
 });
 export const MAX_RECEIPT_MSG_CHAR = 500;
-export const incrementVal = v.pipe($req_num_gt0, 
+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 incrementLabel = v.pipe($, v.maxLength(incrementLabelMaxChars, ({ requirement: r }) => `cannot exceed ${r} characters`));
+export const increment_label_max_chars = 60;
+export const tagline_max_chars = 140;
+export const increment_label = v.pipe($, v.maxLength(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 const endowment = v.object({
+export const npo = v.object({
     id: int_gte1,
     env,
     slug: v.optional(slug),
@@ -53,7 +52,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),
@@ -89,59 +88,56 @@ export const endowment = v.object({
     w_form: v.optional(v.string()),
     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 endowFields = v.keyof(endowment);
+export const npo_update = v.partial(v.omit(npo, ["id", "claimed", "kyc_donors_only", "env", "fiscal_sponsored"]));
+export const npo_fields = v.keyof(npo);
 /** 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))),
 });
 const amnt = v.pipe(v.number(), v.minValue(0));
-export const programId = v.pipe($, v.uuid());
-export const milestoneId = v.pipe($, v.uuid());
-export const newMilestone = v.object({
+export const program_id = v.pipe($, v.uuid());
+export const milestone_id = v.pipe($, v.uuid());
+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 const milestone = v.object({ ...newMilestone.entries, id: milestoneId });
-export const newProgram = v.object({
+export const milestone_update = v.partial(milestone_new, ["date"]);
+export const milestone = v.object({
+    ...milestone_new.entries,
+    id: milestone_id,
+});
+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 mediaUrl = v.pipe($, v.url());
+export const program_update = v.partial(v.omit(program_new, ["milestones"]));
+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"];
-export const mediaType = v.picklist(mediaTypes);
-export const mediaUpdate = v.object({
-    url: v.optional(mediaUrl),
+export const media_ksuid = $req; // base62;
+export const media_types = ["album", "article", "video"];
+export const media_type = v.picklist(media_types);
+export const media_update = v.object({
+    url: v.optional(media_url),
     featured: v.optional(v.boolean()),
 });
-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($, v.transform((x) => Boolean(x)), v.boolean())),
     limit: v.optional(v.pipe(v.string(), v.transform((x) => +x), int_gte1)),
 });

package/package.json

@@ -1,9 +1,14 @@
 {
   "name": "@better-giving/endowment",
-  "version": "2.0.6",
+  "version": "3.0.0",
+  "dependencies": {
+    "ksuid": "3.0.0"
+  },
   "peerDependencies": {
     "@better-giving/schemas": "1.2.2",
     "@better-giving/types": "1.1.8",
+    "@better-giving/db": "1.0.11",
+    "@aws-sdk/lib-dynamodb": "3.485.0",
     "valibot": "0.42.0"
   },
   "devDependencies": {

package/src/cloudsearch.mts

@@ -17,7 +17,8 @@ import {
   pick,
   pipe,
 } from "valibot";
-import { $, type Environment, csvStrs, endowment } from "./schema.mjs";
+import { $, csvStrs, npo } from "./schema.mjs";
+import type { Environment } from "@better-giving/types/list";
 
 const boolCsv = pipe(
   csvStrs,
@@ -31,7 +32,7 @@ export const cloudsearchEndowFields = object({
 });
 
 export const cloudsearchEndow = object({
-  ...pick(endowment, [
+  ...pick(npo, [
     "card_img",
     "name",
     "tagline",