@better-giving/endowment 1.0.0

package/dist/cloudsearch.d.mts

@@ -0,0 +1,14 @@
+import type { ToDoc, ToHitFields, ToUpdate } from "@better-giving/types/cloudsearch";
+import type { Endow, Environment } from "./db.mjs";
+export type Fields = Pick<Endow.DBRecord, "card_img" | "name" | "tagline" | "hq_country" | "sdgs" | "active_in_countries" | "endow_designation" | "registration_number" | "kyc_donors_only" | "claimed" | "env" | "id" | "published" | "fund_opt_in"> & {
+    contributions_total: number;
+    contributions_count: number;
+};
+type DocId = `${Environment}-${number}`;
+type Doc = {
+    documentId: DocId;
+    _score: number;
+} & ToDoc<Fields>;
+export type HitFields = ToHitFields<Omit<Doc, "documentId" | "_score">>;
+export type Update = ToUpdate<DocId, Fields>;
+export {};

package/dist/cloudsearch.mjs

@@ -0,0 +1 @@
+export {};

package/dist/db.d.mts

@@ -0,0 +1,60 @@
+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 namespace EndowCount {
+    interface Keys {
+        PK: "Count";
+        SK: Environment;
+    }
+    interface NonKeyAttributes {
+        count: number;
+    }
+}
+export declare namespace Endow {
+    type Keys = {
+        PK: `Endow#${EndowId}`;
+        SK: Environment;
+    };
+    type NonKeyAttributes = EndowmentShape & {
+        env: Environment;
+        kyc_donors_only: boolean;
+        fiscal_sponsored: boolean;
+        claimed: boolean;
+        /** in USD @deprecated */
+        payout_minimum?: number;
+        /** @deprecated */
+        splitLiqPct?: number;
+        /** @deprecated */
+        splitFixed?: boolean;
+    };
+    type DBRecord = Keys & NonKeyAttributes;
+}
+export declare namespace RegNumEnvGsi {
+    type Name = "regnum-env-gsi";
+    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 Keys = Pick<Endow.NonKeyAttributes, "slug" | "env">;
+    type DBRecord = Endow.DBRecord;
+}
+export declare namespace Program {
+    type Keys = {
+        PK: `Endow#${number}#${Environment}`;
+        SK: `Prog#${ProgramId}`;
+    };
+    type NonKeyAttributes = ProgramShape & {
+        /** in USD */
+        totalDonations?: number;
+    };
+    export type DBRecord = Keys & NonKeyAttributes;
+    export {};
+}
+export declare namespace Milestone {
+    type Keys = {
+        PK: `Prog#${string}#${Environment}`;
+        SK: `Mile#${MilestoneId}`;
+    };
+    export type DBRecord = Keys & MilestoneShape;
+    export {};
+}

package/dist/db.mjs

@@ -0,0 +1 @@
+export {};

package/dist/index.d.mts

@@ -0,0 +1,4 @@
+import type { Fields as FundItem } from "./cloudsearch.mjs";
+import type { Endow as NEndow } from "./db.mjs";
+export type { FundItem };
+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" | "sfCompounded" | "progDonationsAllowed" | "donateMethods" | "allocation" | "increments">;

package/dist/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/schema.d.mts

@@ -0,0 +1,285 @@
+export type { OrgDesignation as EndowDesignation, Environment, } from "@better-giving/schemas";
+import { type InferInput, type InferOutput } from "valibot";
+export declare const allocation: import("valibot").SchemaWithPipe<[import("valibot").ObjectSchema<{
+    readonly cash: import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").IntegerAction<number, undefined>, import("valibot").MinValueAction<number, 0, undefined>, import("valibot").MaxValueAction<number, 100, undefined>]>;
+    readonly liq: import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").IntegerAction<number, undefined>, import("valibot").MinValueAction<number, 0, undefined>, import("valibot").MaxValueAction<number, 100, undefined>]>;
+    readonly lock: import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").IntegerAction<number, undefined>, import("valibot").MinValueAction<number, 0, undefined>, import("valibot").MaxValueAction<number, 100, undefined>]>;
+}, undefined>, import("valibot").CheckAction<{
+    cash: number;
+    liq: number;
+    lock: number;
+}, "must total to 100">]>;
+export type Allocation = InferOutput<typeof allocation>;
+export declare const endowId: import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").IntegerAction<number, undefined>, import("valibot").MinValueAction<number, 1, undefined>]>;
+export type EndowId = InferOutput<typeof endowId>;
+export declare const endowIdParam: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TransformAction<string, number>, import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").IntegerAction<number, undefined>, import("valibot").MinValueAction<number, 1, undefined>]>]>;
+export declare const segment: import("valibot").LazySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").MaxLengthAction<string, 30, "max 30 characters">, import("valibot").RegexAction<string, "should not be an id">, import("valibot").RegexAction<string, "allowed: numbers | letters | - | . | _ | ~">, import("valibot").ExcludesAction<string, "..", "should not contain double periods">, import("valibot").CustomSchema<string, "should not start with dot">, import("valibot").CustomSchema<string, "should not end with dot">]>>;
+export declare const reg_number: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">, import("valibot").RegexAction<string, "must only contain letters and numbers">]>;
+export declare const donateMethodIds: readonly ["stripe", "crypto", "daf", "stocks"];
+export declare const donateMethodId: import("valibot").PicklistSchema<readonly ["stripe", "crypto", "daf", "stocks"], undefined>;
+export type DonateMethodId = InferOutput<typeof donateMethodId>;
+declare const social_media_urls: import("valibot").ObjectSchema<{
+    readonly facebook: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+    readonly twitter: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+    readonly linkedin: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+    readonly discord: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+    readonly instagram: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+    readonly youtube: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+    readonly tiktok: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+}, undefined>;
+export type SocialMediaURLs = InferOutput<typeof social_media_urls>;
+export declare const MAX_RECEIPT_MSG_CHAR = 500;
+export declare const incrementVal: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">, import("valibot").TransformAction<string, number>, import("valibot").NumberSchema<"must be a number">, import("valibot").MinValueAction<number, 0, "must be greater than 0">, import("valibot").TransformAction<number, string>]>;
+export declare const MAX_NUM_INCREMENTS = 4;
+export declare const incrementLabelMaxChars = 30;
+export declare const incrementLabel: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").MaxLengthAction<string, 30, ({ requirement: r }: import("valibot").MaxLengthIssue<string, 30>) => string>]>;
+export declare const increment: import("valibot").ObjectSchema<{
+    readonly value: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">, import("valibot").TransformAction<string, number>, import("valibot").NumberSchema<"must be a number">, import("valibot").MinValueAction<number, 0, "must be greater than 0">, import("valibot").TransformAction<number, string>]>;
+    readonly label: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").MaxLengthAction<string, 30, ({ requirement: r }: import("valibot").MaxLengthIssue<string, 30>) => string>]>;
+}, undefined>;
+export type Increment = InferOutput<typeof increment>;
+export declare const endowment: import("valibot").ObjectSchema<{
+    readonly id: import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").IntegerAction<number, undefined>, import("valibot").MinValueAction<number, 1, undefined>]>;
+    readonly slug: import("valibot").OptionalSchema<import("valibot").LazySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").MaxLengthAction<string, 30, "max 30 characters">, import("valibot").RegexAction<string, "should not be an id">, import("valibot").RegexAction<string, "allowed: numbers | letters | - | . | _ | ~">, import("valibot").ExcludesAction<string, "..", "should not contain double periods">, import("valibot").CustomSchema<string, "should not start with dot">, import("valibot").CustomSchema<string, "should not end with dot">]>>, never>;
+    readonly registration_number: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">, import("valibot").RegexAction<string, "must only contain letters and numbers">]>;
+    readonly name: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">]>;
+    readonly endow_designation: import("valibot").PicklistSchema<readonly ["Charity", "Religious Organization", "University", "Hospital", "Other"], undefined>;
+    readonly overview: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, never>;
+    readonly tagline: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, never>;
+    readonly image: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+    readonly logo: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+    readonly card_img: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+    readonly hq_country: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">]>;
+    readonly active_in_countries: import("valibot").SchemaWithPipe<[import("valibot").ArraySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, undefined>, import("valibot").NonEmptyAction<string[], "required">]>;
+    readonly street_address: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, never>;
+    readonly social_media_urls: import("valibot").ObjectSchema<{
+        readonly facebook: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+        readonly twitter: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+        readonly linkedin: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+        readonly discord: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+        readonly instagram: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+        readonly youtube: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+        readonly tiktok: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+    }, undefined>;
+    /** website */
+    readonly url: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+    readonly sdgs: import("valibot").SchemaWithPipe<[import("valibot").ArraySchema<import("valibot").PicklistSchema<readonly [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], undefined>, undefined>, import("valibot").MinLengthAction<(2 | 1 | 4 | 3 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17)[], 1, undefined>]>;
+    readonly receiptMsg: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").MaxLengthAction<string, 500, undefined>]>, never>;
+    readonly hide_bg_tip: import("valibot").OptionalSchema<import("valibot").BooleanSchema<undefined>, never>;
+    readonly sfCompounded: import("valibot").OptionalSchema<import("valibot").BooleanSchema<undefined>, never>;
+    readonly published: import("valibot").OptionalSchema<import("valibot").BooleanSchema<undefined>, never>;
+    /** allowed by default */
+    readonly progDonationsAllowed: import("valibot").OptionalSchema<import("valibot").BooleanSchema<undefined>, never>;
+    readonly allocation: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").ObjectSchema<{
+        readonly cash: import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").IntegerAction<number, undefined>, import("valibot").MinValueAction<number, 0, undefined>, import("valibot").MaxValueAction<number, 100, undefined>]>;
+        readonly liq: import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").IntegerAction<number, undefined>, import("valibot").MinValueAction<number, 0, undefined>, import("valibot").MaxValueAction<number, 100, undefined>]>;
+        readonly lock: import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").IntegerAction<number, undefined>, import("valibot").MinValueAction<number, 0, undefined>, import("valibot").MaxValueAction<number, 100, undefined>]>;
+    }, undefined>, import("valibot").CheckAction<{
+        cash: number;
+        liq: number;
+        lock: number;
+    }, "must total to 100">]>, never>;
+    readonly donateMethods: import("valibot").OptionalSchema<import("valibot").ArraySchema<import("valibot").PicklistSchema<readonly ["stripe", "crypto", "daf", "stocks"], undefined>, undefined>, never>;
+    readonly increments: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").ArraySchema<import("valibot").ObjectSchema<{
+        readonly value: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">, import("valibot").TransformAction<string, number>, import("valibot").NumberSchema<"must be a number">, import("valibot").MinValueAction<number, 0, "must be greater than 0">, import("valibot").TransformAction<number, string>]>;
+        readonly label: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").MaxLengthAction<string, 30, ({ requirement: r }: import("valibot").MaxLengthIssue<string, 30>) => string>]>;
+    }, undefined>, undefined>, import("valibot").MaxLengthAction<{
+        value: string;
+        label: string;
+    }[], 4, undefined>]>, never>;
+    readonly fund_opt_in: import("valibot").OptionalSchema<import("valibot").BooleanSchema<undefined>, never>;
+}, undefined>;
+export declare const endowFields: import("valibot").PicklistSchema<["url", "slug", "name", "overview", "tagline", "image", "logo", "card_img", "hq_country", "active_in_countries", "street_address", "sdgs", "receiptMsg", "hide_bg_tip", "sfCompounded", "published", "progDonationsAllowed", "allocation", "donateMethods", "increments", "fund_opt_in", "id", "registration_number", "endow_designation", "social_media_urls"], undefined>;
+export type Endowment = InferOutput<typeof endowment>;
+export type EndowmentFields = InferOutput<typeof endowFields>;
+export declare const endowsQueryParams: import("valibot").ObjectSchema<{
+    readonly query: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+    readonly page: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TransformAction<string, number>, import("valibot").IntegerAction<number, undefined>, import("valibot").MinValueAction<number, 1, undefined>]>;
+    readonly endow_designation: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").LazySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").RegexAction<string, "invalid csv">]>>, import("valibot").TransformAction<string, string[]>, import("valibot").ArraySchema<import("valibot").PicklistSchema<readonly ["Charity", "Religious Organization", "University", "Hospital", "Other"], undefined>, undefined>]>, never>;
+    readonly sdgs: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").LazySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").RegexAction<string, "invalid csv">]>>, import("valibot").TransformAction<string, number[]>, import("valibot").ArraySchema<import("valibot").PicklistSchema<readonly [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], undefined>, undefined>]>, never>;
+    readonly kyc_only: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").LazySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").RegexAction<string, "invalid csv">]>>, import("valibot").TransformAction<string, boolean[]>, import("valibot").ArraySchema<import("valibot").BooleanSchema<undefined>, undefined>]>, never>;
+    readonly fund_opt_in: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").LazySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").RegexAction<string, "invalid csv">]>>, import("valibot").TransformAction<string, boolean[]>, import("valibot").ArraySchema<import("valibot").BooleanSchema<undefined>, undefined>]>, never>;
+    readonly claimed: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").LazySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").RegexAction<string, "invalid csv">]>>, import("valibot").TransformAction<string, boolean[]>, import("valibot").ArraySchema<import("valibot").BooleanSchema<undefined>, undefined>]>, never>;
+    readonly countries: import("valibot").OptionalSchema<import("valibot").LazySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").RegexAction<string, "invalid csv">]>>, never>;
+    readonly fields: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").LazySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").RegexAction<string, "invalid csv">]>>, import("valibot").TransformAction<string, string[]>, import("valibot").ArraySchema<import("valibot").PicklistSchema<["url", "slug", "name", "overview", "tagline", "image", "logo", "card_img", "hq_country", "active_in_countries", "street_address", "sdgs", "receiptMsg", "hide_bg_tip", "sfCompounded", "published", "progDonationsAllowed", "allocation", "donateMethods", "increments", "fund_opt_in", "id", "registration_number", "endow_designation", "social_media_urls"], undefined>, undefined>]>, never>;
+}, undefined>;
+export type EndowsQueryParams = InferInput<typeof endowsQueryParams>;
+export declare const endowQueryParam: import("valibot").ObjectSchema<{
+    readonly fields: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").LazySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").RegexAction<string, "invalid csv">]>>, import("valibot").TransformAction<string, string[]>, import("valibot").ArraySchema<import("valibot").PicklistSchema<["url", "slug", "name", "overview", "tagline", "image", "logo", "card_img", "hq_country", "active_in_countries", "street_address", "sdgs", "receiptMsg", "hide_bg_tip", "sfCompounded", "published", "progDonationsAllowed", "allocation", "donateMethods", "increments", "fund_opt_in", "id", "registration_number", "endow_designation", "social_media_urls"], undefined>, undefined>]>, never>;
+    readonly slug: import("valibot").OptionalSchema<import("valibot").LazySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").MaxLengthAction<string, 30, "max 30 characters">, import("valibot").RegexAction<string, "should not be an id">, import("valibot").RegexAction<string, "allowed: numbers | letters | - | . | _ | ~">, import("valibot").ExcludesAction<string, "..", "should not contain double periods">, import("valibot").CustomSchema<string, "should not start with dot">, import("valibot").CustomSchema<string, "should not end with dot">]>>, never>;
+    readonly env: import("valibot").PicklistSchema<readonly ["staging", "production"], undefined>;
+}, undefined>;
+export type EndowQueryParam = InferInput<typeof endowQueryParam>;
+export declare const endowByEinParams: import("valibot").ObjectSchema<{
+    readonly env: import("valibot").PicklistSchema<readonly ["staging", "production"], undefined>;
+    readonly ein: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">, import("valibot").RegexAction<string, "must only contain letters and numbers">]>;
+}, undefined>;
+export type EndowByEinParams = InferInput<typeof endowByEinParams>;
+export declare const programId: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UuidAction<string, undefined>]>;
+export type ProgramId = InferOutput<typeof programId>;
+export declare const milestoneId: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UuidAction<string, undefined>]>;
+export type MilestoneId = InferOutput<typeof milestoneId>;
+export declare const newMilestone: import("valibot").ObjectSchema<{
+    readonly date: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").IsoDateAction<string, undefined>]>;
+    readonly title: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+    readonly description: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+    readonly media: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+}, undefined>;
+export declare const milestoneUpdate: Omit<import("valibot").ObjectSchema<{
+    readonly date: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").IsoDateAction<string, undefined>]>;
+    readonly title: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+    readonly description: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+    readonly media: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+}, undefined>, "_types" | "_run" | "entries"> & {
+    readonly entries: {
+        readonly date: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").IsoDateAction<string, undefined>]>, never>;
+        readonly title: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+        readonly description: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+        readonly media: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+    };
+    _run(dataset: import("valibot").Dataset<unknown, never>, config: import("valibot").Config<import("valibot").StringIssue | import("valibot").ObjectIssue | import("valibot").UrlIssue<string> | import("valibot").IsoDateIssue<string>>): import("valibot").Dataset<{
+        title: string;
+        description: string;
+        date?: string | undefined;
+        media?: string | undefined;
+    }, import("valibot").StringIssue | import("valibot").ObjectIssue | import("valibot").UrlIssue<string> | import("valibot").IsoDateIssue<string>>;
+    readonly _types?: {
+        readonly input: {
+            title: string;
+            description: string;
+            date?: string | undefined;
+            media?: string | undefined;
+        };
+        readonly output: {
+            title: string;
+            description: string;
+            date?: string | undefined;
+            media?: string | undefined;
+        };
+        readonly issue: import("valibot").StringIssue | import("valibot").ObjectIssue | import("valibot").UrlIssue<string> | import("valibot").IsoDateIssue<string>;
+    } | undefined;
+};
+export type MilestoneUpdate = InferOutput<typeof milestoneUpdate>;
+export type NewMilestone = InferOutput<typeof newMilestone>;
+export declare const milestone: import("valibot").ObjectSchema<{
+    readonly id: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UuidAction<string, undefined>]>;
+    readonly date: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").IsoDateAction<string, undefined>]>;
+    readonly title: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+    readonly description: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+    readonly media: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+}, undefined>;
+export type Milestone = InferOutput<typeof milestone>;
+export declare const newProgram: import("valibot").ObjectSchema<{
+    readonly title: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+    readonly description: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+    readonly banner: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+    /** null unsets target */
+    readonly targetRaise: import("valibot").NullishSchema<import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").MinValueAction<number, 0, undefined>]>, never>;
+    readonly milestones: import("valibot").SchemaWithPipe<[import("valibot").ArraySchema<import("valibot").ObjectSchema<{
+        readonly date: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").IsoDateAction<string, undefined>]>;
+        readonly title: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+        readonly description: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+        readonly media: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+    }, undefined>, undefined>, import("valibot").MaxLengthAction<{
+        date: string;
+        title: string;
+        description: string;
+        media?: string | undefined;
+    }[], 24, undefined>]>;
+}, undefined>;
+export declare const program: import("valibot").ObjectSchema<{
+    readonly id: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UuidAction<string, undefined>]>;
+    readonly title: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+    readonly description: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+    readonly banner: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+    readonly targetRaise: import("valibot").NullishSchema<import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").MinValueAction<number, 0, undefined>]>, never>;
+}, undefined>;
+export declare const programUpdate: Omit<Omit<import("valibot").ObjectSchema<{
+    readonly title: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+    readonly description: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+    readonly banner: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+    /** null unsets target */
+    readonly targetRaise: import("valibot").NullishSchema<import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").MinValueAction<number, 0, undefined>]>, never>;
+    readonly milestones: import("valibot").SchemaWithPipe<[import("valibot").ArraySchema<import("valibot").ObjectSchema<{
+        readonly date: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").IsoDateAction<string, undefined>]>;
+        readonly title: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+        readonly description: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+        readonly media: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+    }, undefined>, undefined>, import("valibot").MaxLengthAction<{
+        date: string;
+        title: string;
+        description: string;
+        media?: string | undefined;
+    }[], 24, undefined>]>;
+}, undefined>, "_types" | "_run" | "entries"> & {
+    readonly entries: Omit<{
+        readonly title: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+        readonly description: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+        readonly banner: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+        /** null unsets target */
+        readonly targetRaise: import("valibot").NullishSchema<import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").MinValueAction<number, 0, undefined>]>, never>;
+        readonly milestones: import("valibot").SchemaWithPipe<[import("valibot").ArraySchema<import("valibot").ObjectSchema<{
+            readonly date: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").IsoDateAction<string, undefined>]>;
+            readonly title: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+            readonly description: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
+            readonly media: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+        }, undefined>, undefined>, import("valibot").MaxLengthAction<{
+            date: string;
+            title: string;
+            description: string;
+            media?: string | undefined;
+        }[], 24, undefined>]>;
+    }, "milestones">;
+    _run(dataset: import("valibot").Dataset<unknown, never>, config: import("valibot").Config<import("valibot").StringIssue | import("valibot").NumberIssue | import("valibot").MinValueIssue<number, 0> | import("valibot").ObjectIssue | import("valibot").UrlIssue<string>>): import("valibot").Dataset<{
+        title: string;
+        description: string;
+        banner?: string | undefined;
+        targetRaise?: number | null | undefined;
+    }, import("valibot").StringIssue | import("valibot").NumberIssue | import("valibot").MinValueIssue<number, 0> | import("valibot").ObjectIssue | import("valibot").UrlIssue<string>>;
+    readonly _types?: {
+        readonly input: {
+            title: string;
+            description: string;
+            banner?: string | undefined;
+            targetRaise?: number | null | undefined;
+        };
+        readonly output: {
+            title: string;
+            description: string;
+            banner?: string | undefined;
+            targetRaise?: number | null | undefined;
+        };
+        readonly issue: import("valibot").StringIssue | import("valibot").NumberIssue | import("valibot").MinValueIssue<number, 0> | import("valibot").ObjectIssue | import("valibot").UrlIssue<string>;
+    } | undefined;
+}, "_types" | "_run" | "entries"> & {
+    readonly entries: {
+        readonly title: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, never>;
+        readonly description: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, never>;
+        readonly banner: import("valibot").OptionalSchema<import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>, never>;
+        readonly targetRaise: import("valibot").OptionalSchema<import("valibot").NullishSchema<import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").MinValueAction<number, 0, undefined>]>, never>, never>;
+    };
+    _run(dataset: import("valibot").Dataset<unknown, never>, config: import("valibot").Config<import("valibot").StringIssue | import("valibot").NumberIssue | import("valibot").MinValueIssue<number, 0> | import("valibot").ObjectIssue | import("valibot").UrlIssue<string>>): import("valibot").Dataset<{
+        title?: string | undefined;
+        description?: string | undefined;
+        banner?: string | undefined;
+        targetRaise?: number | null | undefined;
+    }, import("valibot").StringIssue | import("valibot").NumberIssue | import("valibot").MinValueIssue<number, 0> | import("valibot").ObjectIssue | import("valibot").UrlIssue<string>>;
+    readonly _types?: {
+        readonly input: {
+            title?: string | undefined;
+            description?: string | undefined;
+            banner?: string | undefined;
+            targetRaise?: number | null | undefined;
+        };
+        readonly output: {
+            title?: string | undefined;
+            description?: string | undefined;
+            banner?: string | undefined;
+            targetRaise?: number | null | undefined;
+        };
+        readonly issue: import("valibot").StringIssue | import("valibot").NumberIssue | import("valibot").MinValueIssue<number, 0> | import("valibot").ObjectIssue | import("valibot").UrlIssue<string>;
+    } | undefined;
+};
+export type NewProgram = InferOutput<typeof newProgram>;
+export type Program = InferOutput<typeof program>;
+export type ProgramUpdate = InferOutput<typeof programUpdate>;

package/dist/schema.mjs

@@ -0,0 +1,125 @@
+import { env, orgDesignation, unSdgNum } from "@better-giving/schemas";
+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, } from "valibot";
+const str = pipe(string(), trim());
+const pct = pipe(number(), integer(), minValue(0), maxValue(100));
+export const allocation = pipe(object({
+    cash: pct,
+    liq: pct,
+    lock: pct,
+}), check((x) => x.cash + x.liq + x.lock === 100, "must total to 100"));
+export const endowId = pipe(number(), integer(), minValue(1));
+export const endowIdParam = pipe(string(), transform((x) => +x), endowId);
+export const segment = lazy((x) => {
+    if (!x)
+        return str;
+    return pipe(str, maxLength(30, "max 30 characters"), 
+    //must not be id-like
+    regex(/^(?!^\d+$)/, "should not be an id"), 
+    //valid characters
+    regex(/^[a-zA-Z0-9-._~]+$/, "allowed: numbers | letters | - | . | _ | ~"), excludes("..", "should not contain double periods"), custom((x) => !x.startsWith("."), "should not start with dot"), custom((x) => !x.endsWith("."), "should not end with dot"));
+});
+export const reg_number = pipe(str, nonEmpty("required"), regex(/^[a-zA-Z0-9]+$/, "must only contain letters and numbers"));
+export const donateMethodIds = ["stripe", "crypto", "daf", "stocks"];
+export const donateMethodId = picklist(donateMethodIds);
+const _url = pipe(str, url());
+const social_media_urls = object({
+    facebook: optional(_url),
+    twitter: optional(_url),
+    linkedin: optional(_url),
+    discord: optional(_url),
+    instagram: optional(_url),
+    youtube: optional(_url),
+    tiktok: optional(_url),
+});
+export const MAX_RECEIPT_MSG_CHAR = 500;
+export const incrementVal = pipe(str, nonEmpty("required"), transform((x) => +x), number("must be a number"), minValue(0, "must be greater than 0"), 
+//parsed output
+transform((x) => x.toString()));
+export const MAX_NUM_INCREMENTS = 4;
+export const incrementLabelMaxChars = 30;
+export const incrementLabel = pipe(str, maxLength(incrementLabelMaxChars, ({ requirement: r }) => `cannot exceed ${r} characters`));
+export const increment = object({
+    value: incrementVal,
+    label: incrementLabel,
+});
+export const endowment = object({
+    id: endowId,
+    slug: optional(segment),
+    registration_number: reg_number,
+    name: pipe(str, nonEmpty("required")),
+    endow_designation: orgDesignation,
+    overview: optional(str),
+    tagline: optional(str),
+    image: optional(_url),
+    logo: optional(_url),
+    card_img: optional(_url),
+    hq_country: pipe(str, nonEmpty("required")),
+    active_in_countries: pipe(array(str), nonEmpty("required")),
+    street_address: optional(str),
+    social_media_urls,
+    /** website */
+    url: optional(_url),
+    sdgs: pipe(array(unSdgNum), minLength(1)),
+    receiptMsg: optional(pipe(str, maxLength(MAX_RECEIPT_MSG_CHAR))),
+    //can be optional, default false and need not be explicit
+    hide_bg_tip: optional(boolean()),
+    sfCompounded: optional(boolean()),
+    published: optional(boolean()),
+    /** allowed by default */
+    progDonationsAllowed: optional(boolean()),
+    allocation: optional(allocation),
+    donateMethods: optional(array(donateMethodId)),
+    increments: optional(pipe(array(increment), maxLength(MAX_NUM_INCREMENTS))),
+    fund_opt_in: optional(boolean()),
+});
+export const endowFields = keyof(endowment);
+const csv = lazy((x) => {
+    if (!x)
+        return str;
+    return pipe(str, regex(/^[^,]+(?:,[^,]+)*$/, "invalid csv"));
+});
+const boolCsv = pipe(csv, transform((x) => x.split(",").map(Boolean)), array(boolean()));
+export const endowsQueryParams = object({
+    query: str,
+    page: pipe(string(), transform((x) => +x), integer(), minValue(1)),
+    endow_designation: optional(pipe(csv, transform((x) => x.split(",")), array(orgDesignation))),
+    sdgs: optional(pipe(csv, transform((x) => x.split(",").map((s) => +s)), array(unSdgNum))),
+    kyc_only: optional(boolCsv),
+    fund_opt_in: optional(boolCsv),
+    claimed: optional(boolCsv),
+    countries: optional(csv),
+    fields: optional(pipe(csv, transform((x) => x.split(",")), array(endowFields))),
+});
+export const endowQueryParam = object({
+    fields: optional(pipe(csv, transform((x) => x.split(",")), array(endowFields))),
+    slug: optional(segment),
+    env,
+});
+export const endowByEinParams = object({
+    env,
+    ein: reg_number,
+});
+const amnt = pipe(number(), minValue(0));
+export const programId = pipe(str, uuid());
+export const milestoneId = pipe(str, uuid());
+export const newMilestone = object({
+    date: pipe(str, isoDate()),
+    title: str,
+    description: str,
+    media: optional(_url),
+});
+export const milestoneUpdate = partial(newMilestone, ["date"]);
+export const milestone = object({ ...newMilestone.entries, id: milestoneId });
+export const newProgram = object({
+    title: str,
+    description: str,
+    banner: optional(_url),
+    /** null unsets target */
+    targetRaise: nullish(amnt),
+    milestones: pipe(array(newMilestone), maxLength(24)),
+});
+export const program = object({
+    ...omit(newProgram, ["milestones"]).entries,
+    id: programId,
+});
+export const programUpdate = partial(omit(newProgram, ["milestones"]));

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@better-giving/endowment",
+  "version": "1.0.0",
+  "peerDependencies": {
+    "@better-giving/schemas": "1.0.1",
+    "@better-giving/types": "1.0.1"
+  },
+  "devDependencies": {
+    "@better-giving/config": "workspace:*"
+  },
+  "files": [
+    "src",
+    "dist"
+  ],
+  "exports": {
+    ".": "./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"
+  }
+}

package/src/cloudsearch.mts

@@ -0,0 +1,39 @@
+import type {
+  ToDoc,
+  ToHitFields,
+  ToUpdate,
+} from "@better-giving/types/cloudsearch";
+import type { Endow, Environment } from "./db.mjs";
+
+export type Fields = Pick<
+  Endow.DBRecord,
+  //card UI attribures
+  | "card_img"
+  | "name"
+  | "tagline"
+  | "hq_country"
+  | "sdgs"
+  | "active_in_countries"
+  | "endow_designation"
+  | "registration_number"
+  //icons
+  | "kyc_donors_only"
+  | "claimed"
+  //filters
+  | "env"
+  | "id"
+  | "published"
+  | "fund_opt_in"
+  // balance data
+> & { contributions_total: number; contributions_count: number };
+
+type DocId = `${Environment}-${number}`;
+
+type Doc = {
+  documentId: DocId;
+  _score: number;
+} & ToDoc<Fields>;
+
+export type HitFields = ToHitFields<Omit<Doc, "documentId" | "_score">>;
+
+export type Update = ToUpdate<DocId, Fields>;

package/src/db.mts

@@ -0,0 +1,89 @@
+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 namespace EndowCount {
+  export interface Keys {
+    PK: "Count";
+    SK: Environment;
+  }
+  export interface NonKeyAttributes {
+    count: number;
+  }
+}
+
+export namespace Endow {
+  export type Keys = {
+    PK: `Endow#${EndowId}`;
+    SK: Environment;
+  };
+
+  export type NonKeyAttributes = EndowmentShape & {
+    env: Environment;
+    kyc_donors_only: boolean;
+    fiscal_sponsored: boolean;
+    claimed: boolean;
+
+    /** in USD @deprecated */
+    payout_minimum?: number;
+    /** @deprecated */
+    splitLiqPct?: number;
+    /** @deprecated */
+    splitFixed?: boolean;
+  };
+
+  export type DBRecord = Keys & NonKeyAttributes;
+}
+
+export namespace RegNumEnvGsi {
+  export type Name = "regnum-env-gsi";
+  export type Keys = Pick<
+    Endow.NonKeyAttributes,
+    "registration_number" | "env"
+  >;
+  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 Keys = Pick<Endow.NonKeyAttributes, "slug" | "env">;
+  export type DBRecord = Endow.DBRecord; //all attributes are copied to this index
+}
+
+export namespace Program {
+  type Keys = {
+    PK: `Endow#${number}#${Environment}`;
+    SK: `Prog#${ProgramId}`;
+  };
+
+  type NonKeyAttributes = ProgramShape & {
+    /** in USD */
+    totalDonations?: number;
+  };
+  export type DBRecord = Keys & NonKeyAttributes;
+}
+
+export namespace Milestone {
+  type Keys = {
+    PK: `Prog#${string}#${Environment}`;
+    SK: `Mile#${MilestoneId}`;
+  };
+  export type DBRecord = Keys & MilestoneShape;
+}

package/src/index.mts

@@ -0,0 +1,33 @@
+import type { Fields as FundItem } from "./cloudsearch.mjs";
+import type { Endow as NEndow } from "./db.mjs";
+export type { FundItem };
+
+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"
+  | "sfCompounded"
+  | "progDonationsAllowed"
+  | "donateMethods"
+  | "allocation"
+  | "increments"
+>;

package/src/schema.mts

@@ -0,0 +1,273 @@
+import { env, orgDesignation, unSdgNum } from "@better-giving/schemas";
+export type {
+  OrgDesignation as EndowDesignation,
+  Environment,
+} from "@better-giving/schemas";
+import {
+  url,
+  type InferInput,
+  type InferOutput,
+  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,
+} from "valibot";
+
+const str = pipe(string(), trim());
+
+const pct = pipe(number(), integer(), minValue(0), maxValue(100));
+export const allocation = pipe(
+  object({
+    cash: pct,
+    liq: pct,
+    lock: pct,
+  }),
+  check((x) => x.cash + x.liq + x.lock === 100, "must total to 100")
+);
+
+export type Allocation = InferOutput<typeof allocation>;
+
+export const endowId = pipe(number(), integer(), minValue(1));
+export type EndowId = InferOutput<typeof endowId>;
+export const endowIdParam = pipe(
+  string(),
+  transform((x) => +x),
+  endowId
+);
+
+export const segment = lazy((x) => {
+  if (!x) return str;
+  return pipe(
+    str,
+    maxLength(30, "max 30 characters"),
+    //must not be id-like
+    regex(/^(?!^\d+$)/, "should not be an id"),
+    //valid characters
+    regex(/^[a-zA-Z0-9-._~]+$/, "allowed: numbers | letters | - | . | _ | ~"),
+    excludes("..", "should not contain double periods"),
+    custom((x) => !(x as string).startsWith("."), "should not start with dot"),
+    custom((x) => !(x as string).endsWith("."), "should not end with dot")
+  );
+});
+
+export const reg_number = pipe(
+  str,
+  nonEmpty("required"),
+  regex(/^[a-zA-Z0-9]+$/, "must only contain letters and numbers")
+);
+
+export const donateMethodIds = ["stripe", "crypto", "daf", "stocks"] as const;
+export const donateMethodId = picklist(donateMethodIds);
+export type DonateMethodId = InferOutput<typeof donateMethodId>;
+
+const _url = pipe(str, url());
+
+const social_media_urls = object({
+  facebook: optional(_url),
+  twitter: optional(_url),
+  linkedin: optional(_url),
+  discord: optional(_url),
+  instagram: optional(_url),
+  youtube: optional(_url),
+  tiktok: optional(_url),
+});
+
+export type SocialMediaURLs = InferOutput<typeof social_media_urls>;
+
+export const MAX_RECEIPT_MSG_CHAR = 500;
+
+export const incrementVal = pipe(
+  str,
+  nonEmpty("required"),
+  transform((x) => +x),
+  number("must be a number"),
+  minValue(0, "must be greater than 0"),
+  //parsed output
+  transform((x) => x.toString())
+);
+
+export const MAX_NUM_INCREMENTS = 4;
+export const incrementLabelMaxChars = 30;
+export const incrementLabel = pipe(
+  str,
+  maxLength(
+    incrementLabelMaxChars,
+    ({ requirement: r }) => `cannot exceed ${r} characters`
+  )
+);
+
+export const increment = object({
+  value: incrementVal,
+  label: incrementLabel,
+});
+
+export type Increment = InferOutput<typeof increment>;
+
+export const endowment = object({
+  id: endowId,
+  slug: optional(segment),
+  registration_number: reg_number,
+  name: pipe(str, nonEmpty("required")),
+  endow_designation: orgDesignation,
+  overview: optional(str),
+  tagline: optional(str),
+  image: optional(_url),
+  logo: optional(_url),
+  card_img: optional(_url),
+  hq_country: pipe(str, nonEmpty("required")),
+  active_in_countries: pipe(array(str), nonEmpty("required")),
+  street_address: optional(str),
+  social_media_urls,
+  /** website */
+  url: optional(_url),
+  sdgs: pipe(array(unSdgNum), minLength(1)),
+  receiptMsg: optional(pipe(str, maxLength(MAX_RECEIPT_MSG_CHAR))),
+  //can be optional, default false and need not be explicit
+  hide_bg_tip: optional(boolean()),
+  sfCompounded: optional(boolean()),
+  published: optional(boolean()),
+  /** allowed by default */
+  progDonationsAllowed: optional(boolean()),
+
+  allocation: optional(allocation),
+  donateMethods: optional(array(donateMethodId)),
+  increments: optional(pipe(array(increment), maxLength(MAX_NUM_INCREMENTS))),
+  fund_opt_in: optional(boolean()),
+});
+
+export const endowFields = keyof(endowment);
+
+export type Endowment = InferOutput<typeof endowment>;
+export type EndowmentFields = InferOutput<typeof endowFields>;
+
+const csv = lazy((x) => {
+  if (!x) return str;
+  return pipe(str, regex(/^[^,]+(?:,[^,]+)*$/, "invalid csv"));
+});
+
+const boolCsv = pipe(
+  csv,
+  transform((x) => x.split(",").map(Boolean)),
+  array(boolean())
+);
+
+export const endowsQueryParams = object({
+  query: str,
+  page: pipe(
+    string(),
+    transform((x) => +x),
+    integer(),
+    minValue(1)
+  ),
+  endow_designation: optional(
+    pipe(
+      csv,
+      transform((x) => x.split(",")),
+      array(orgDesignation)
+    )
+  ),
+  sdgs: optional(
+    pipe(
+      csv,
+      transform((x) => x.split(",").map((s) => +s)),
+      array(unSdgNum)
+    )
+  ),
+  kyc_only: optional(boolCsv),
+  fund_opt_in: optional(boolCsv),
+  claimed: optional(boolCsv),
+  countries: optional(csv),
+  fields: optional(
+    pipe(
+      csv,
+      transform((x) => x.split(",")),
+      array(endowFields)
+    )
+  ),
+});
+
+export type EndowsQueryParams = InferInput<typeof endowsQueryParams>;
+
+export const endowQueryParam = object({
+  fields: optional(
+    pipe(
+      csv,
+      transform((x) => x.split(",")),
+      array(endowFields)
+    )
+  ),
+  slug: optional(segment),
+  env,
+});
+
+export type EndowQueryParam = InferInput<typeof endowQueryParam>;
+
+export const endowByEinParams = object({
+  env,
+  ein: reg_number,
+});
+
+export type EndowByEinParams = InferInput<typeof endowByEinParams>;
+
+const amnt = pipe(number(), minValue(0));
+export const programId = pipe(str, uuid());
+export type ProgramId = InferOutput<typeof programId>;
+export const milestoneId = pipe(str, uuid());
+export type MilestoneId = InferOutput<typeof milestoneId>;
+
+export const newMilestone = object({
+  date: pipe(str, isoDate()),
+  title: str,
+  description: str,
+  media: optional(_url),
+});
+
+export const milestoneUpdate = partial(newMilestone, ["date"]);
+export type MilestoneUpdate = InferOutput<typeof milestoneUpdate>;
+
+export type NewMilestone = InferOutput<typeof newMilestone>;
+export const milestone = object({ ...newMilestone.entries, id: milestoneId });
+export type Milestone = InferOutput<typeof milestone>;
+
+export const newProgram = object({
+  title: str,
+  description: str,
+  banner: optional(_url),
+  /** null unsets target */
+  targetRaise: nullish(amnt),
+  milestones: pipe(array(newMilestone), maxLength(24)),
+});
+
+export const program = object({
+  ...omit(newProgram, ["milestones"]).entries,
+  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>;