@better-giving/endowment 1.0.24 → 1.0.26

package/dist/cloudsearch.d.mts

@@ -0,0 +1,50 @@
+import type { ToDoc, ToHitFields, ToUpdate } from "@better-giving/types/cloudsearch";
+import { type InferInput, type InferOutput } from "valibot";
+import { type Environment } from "./schema.mjs";
+export declare const cloudsearchEndowFields: import("valibot").ObjectSchema<{
+    readonly contributions_total: import("valibot").NumberSchema<undefined>;
+    readonly contributions_count: import("valibot").NumberSchema<undefined>;
+}, undefined>;
+export declare const cloudsearchEndow: import("valibot").ObjectSchema<{
+    readonly contributions_total: import("valibot").NumberSchema<undefined>;
+    readonly contributions_count: import("valibot").NumberSchema<undefined>;
+    readonly name: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">]>;
+    readonly tagline: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").MaxLengthAction<string, 140, 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 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 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17)[], 1, undefined>]>;
+    readonly published: import("valibot").OptionalSchema<import("valibot").BooleanSchema<undefined>, never>;
+    readonly fund_opt_in: import("valibot").OptionalSchema<import("valibot").BooleanSchema<undefined>, never>;
+    readonly id: import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").IntegerAction<number, undefined>, import("valibot").MinValueAction<number, 1, undefined>]>;
+    readonly env: import("valibot").PicklistSchema<readonly ["staging", "production"], undefined>;
+    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 endow_designation: import("valibot").PicklistSchema<readonly ["Charity", "Religious Organization", "University", "Hospital", "Other"], undefined>;
+    readonly claimed: import("valibot").BooleanSchema<undefined>;
+    readonly kyc_donors_only: import("valibot").BooleanSchema<undefined>;
+}, undefined>;
+export declare const cloudSearchEndowFields: import("valibot").PicklistSchema<["name", "tagline", "card_img", "hq_country", "active_in_countries", "sdgs", "published", "fund_opt_in", "id", "env", "registration_number", "endow_designation", "claimed", "kyc_donors_only", "contributions_total", "contributions_count"], undefined>;
+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").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").FilterItemsAction<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").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").FilterItemsAction<string[]>]>, import("valibot").MapItemsAction<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").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").FilterItemsAction<string[]>]>, import("valibot").MapItemsAction<string[], boolean>, import("valibot").ArraySchema<import("valibot").BooleanSchema<undefined>, undefined>]>, never>;
+    readonly fund_opt_in: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[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").FilterItemsAction<string[]>]>, import("valibot").MapItemsAction<string[], boolean>, import("valibot").ArraySchema<import("valibot").BooleanSchema<undefined>, undefined>]>, never>;
+    readonly claimed: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[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").FilterItemsAction<string[]>]>, import("valibot").MapItemsAction<string[], boolean>, import("valibot").ArraySchema<import("valibot").BooleanSchema<undefined>, undefined>]>, never>;
+    readonly countries: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[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").FilterItemsAction<string[]>]>, import("valibot").ArraySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, undefined>]>, never>;
+    readonly fields: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[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").FilterItemsAction<string[]>]>, import("valibot").ArraySchema<import("valibot").PicklistSchema<["name", "tagline", "card_img", "hq_country", "active_in_countries", "sdgs", "published", "fund_opt_in", "id", "env", "registration_number", "endow_designation", "claimed", "kyc_donors_only", "contributions_total", "contributions_count"], undefined>, undefined>]>, never>;
+}, undefined>;
+export interface CloudsearchEndowsQueryParams extends InferInput<typeof endowsQueryParams> {
+}
+export interface CloudsearchEndow extends InferOutput<typeof cloudsearchEndow> {
+}
+type DocId = `${Environment}-${number}`;
+interface Doc extends ToDoc<CloudsearchEndow> {
+    documentId: DocId;
+    _score: number;
+}
+export interface HitFields extends ToHitFields<Omit<Doc, "documentId" | "_score">> {
+}
+export type Update = ToUpdate<DocId, CloudsearchEndow>;
+export {};

package/dist/db.d.mts

@@ -0,0 +1,97 @@
+import type { EndowId, Endowment as EndowmentShape, Environment, MediaId, MediaType, Milestone as MilestoneShape, MilestoneId, Program as ProgramShape, ProgramId } from "./schema.mjs";
+export type { EndowId, SocialMediaURLs, Allocation, Increment, EndowDesignation, Environment, ProgramId, } from "./schema.mjs";
+export declare const endowGsi: {
+    readonly regnumEnv: "regnum-env-gsi";
+    readonly slugEnv: "slug-env-gsi";
+};
+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 & {
+        /** in USD @deprecated */
+        payout_minimum?: number;
+        /** @deprecated */
+        splitLiqPct?: number;
+        /** @deprecated */
+        splitFixed?: boolean;
+        /** @deprecated */
+        sfCompounded?: boolean;
+    };
+    interface DbRecord extends Keys, NonKeyAttributes {
+    }
+}
+export declare namespace RegNumEnvGsi {
+    type Name = typeof endowGsi.regnumEnv;
+    interface Keys extends Pick<Endow.NonKeyAttributes, "registration_number" | "env"> {
+    }
+    interface DbRecord extends Keys, Endow.Keys, Pick<Endow.NonKeyAttributes, "claimed" | "name" | "hq_country" | "id"> {
+    }
+}
+export declare namespace SlugEnvGsi {
+    type Name = typeof endowGsi.slugEnv;
+    interface Keys extends Pick<Endow.NonKeyAttributes, "slug" | "env"> {
+    }
+    interface DbRecord extends Endow.DbRecord {
+    }
+}
+export declare namespace Program {
+    interface Keys {
+        PK: `Endow#${number}#${Environment}`;
+        SK: `Prog#${ProgramId}`;
+    }
+    interface NonKeyAttributes extends ProgramShape {
+    }
+    interface DbRecord extends Keys, NonKeyAttributes {
+    }
+}
+export declare namespace Milestone {
+    interface Keys {
+        PK: `Prog#${string}#${Environment}`;
+        SK: `Mile#${MilestoneId}`;
+    }
+    interface DbRecord extends Keys, MilestoneShape {
+    }
+}
+export declare const mediaGsi: {
+    readonly 1: "gsi1";
+};
+export declare namespace Media {
+    interface Keys {
+        PK: `Endow#${EndowId}#${Environment}`;
+        SK: `Media#${MediaId}`;
+    }
+    /** "0" - featured (goes before 1), "1" - not-featured */
+    type FeaturedFlag = "0" | "1";
+    interface NonKeyAttributes {
+        id: MediaId;
+        gsi1PK: Keys["PK"];
+        gsi1SK: `MediaList#${FeaturedFlag}#${MediaId}#${MediaType}`;
+        /** iso string */
+        dateCreated: string;
+    }
+    interface VideoAttributes extends NonKeyAttributes {
+        type: Extract<MediaType, "video">;
+        url: string;
+    }
+    interface VideoDbRecord extends Keys, VideoAttributes {
+    }
+    type DbRecord = VideoDbRecord;
+    namespace Gsi1 {
+        type Name = (typeof mediaGsi)[1];
+        interface Keys extends Pick<NonKeyAttributes, "gsi1PK" | "gsi1SK"> {
+        }
+        interface DbRecord extends Keys, NonKeyAttributes {
+        }
+    }
+}

package/dist/index.d.mts

@@ -0,0 +1,15 @@
+import type { Media } from "./db.mjs";
+import type { Milestone, Program as ProgramShape } from "./schema.mjs";
+export type { Allocation, DonateMethodId, EndowDesignation, Endowment as Endow, EndowFields, EndowQueryParams, EndowUpdate, Environment, Increment, MediaQueryParams, MediaQueryParamsObj, MediaType, MediaUpdate, Milestone, MilestoneUpdate, NewMilestone, NewProgram, ProgramUpdate, SocialMediaURLs, UnSdgNum, } from "./schema.mjs";
+export type { CloudsearchEndow as EndowItem, CloudsearchEndowsQueryParams as EndowsQueryParams, } from "./cloudsearch.mjs";
+export interface Program extends ProgramShape {
+    milestones: Milestone[];
+}
+/** web-app format */
+export interface IMedia extends Omit<Media.DbRecord, "PK" | "SK" | "gsi1PK" | "gsi1SK"> {
+    featured: boolean;
+}
+export interface MediaPage {
+    items: IMedia[];
+    nextPageKey?: string;
+}