@better-giving/fundraiser 1.0.0-rc.1

package/dist/cloudsearch.d.mts

@@ -0,0 +1,18 @@
+import type { ToDoc, ToHitFields, ToUpdate } from "@better-giving/types/cloudsearch";
+import type { DbRecord } from "./db.mjs";
+export type Fields = Pick<DbRecord, "id" | "name" | "description" | "env" | "logo" | "featured" | "active" | "verified" | "donation_total_usd" | "members" | "target" | "approvers"> & {
+    /** iso | "9999-12-31T23:59:59.000Z" year 9999 */
+    expiration: string;
+};
+/** uuidv4 */
+type DocId = string;
+type FundDoc = {
+    documentId: DocId;
+    _score: number;
+} & ToDoc<Fields>;
+export type HitFields = ToHitFields<Omit<FundDoc, "documentId" | "_score">>;
+export type Update = ToUpdate<DocId, Fields & {
+    /** not returned - query: endow only member */
+    members_csv: string;
+}>;
+export {};

package/dist/cloudsearch.mjs

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

package/dist/db.d.mts

@@ -0,0 +1,25 @@
+import type { Environment } from "@better-giving/types/list";
+import type { NewFund } from "./schema.mjs";
+export interface Keys {
+    /** Fund#${uuid} */
+    PK: `Fund#${string}`;
+    SK: `Fund#${string}`;
+}
+export interface Attributes extends NewFund {
+    /** uuid */
+    id: string;
+    env: Environment;
+    /** fund can be closed before expiration  */
+    active: boolean;
+    verified: boolean;
+    /** to date received: initialized to `0` */
+    donation_total_usd: number;
+    /**
+     * approving NPO ids
+     * NPOs have a whitelist of fundraisers they support. thus, appears in their NPO profile page
+     * @default - [0]
+     * */
+    approvers: number[];
+}
+export interface DbRecord extends Keys, Attributes {
+}

package/dist/db.mjs

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

package/dist/index.d.mts

@@ -0,0 +1,11 @@
+import type { Attributes, DbRecord } from "./db.mjs";
+export interface FundMember {
+    id: number;
+    name: string;
+    card_img?: string;
+}
+export interface SingleFund extends Omit<DbRecord, "PK" | "SK" | "members"> {
+    members: FundMember[];
+}
+export interface FundCard extends Pick<Attributes, "id" | "name" | "description" | "env" | "logo" | "featured" | "active" | "verified" | "donation_total_usd" | "members" | "target" | "approvers"> {
+}

package/dist/index.mjs

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

package/dist/schema.d.mts

@@ -0,0 +1,121 @@
+import { type InferOutput } from "valibot";
+export declare const fundId: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UuidAction<string, undefined>]>;
+export declare const settings: import("valibot").ObjectSchema<{
+    readonly allowBgTip: import("valibot").BooleanSchema<undefined>;
+}, undefined>;
+export declare const newFund: import("valibot").ObjectSchema<{
+    readonly name: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">]>;
+    readonly description: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">]>;
+    readonly banner: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>;
+    readonly logo: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>;
+    /** endowment ids */
+    readonly members: import("valibot").ArraySchema<import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").IntegerAction<number, undefined>, import("valibot").MinValueAction<number, 1, undefined>]>, undefined>;
+    readonly featured: import("valibot").BooleanSchema<undefined>;
+    readonly expiration: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").IsoTimestampAction<string, "invalid date">, import("valibot").MinValueAction<string, string, undefined>]>, never>;
+    /** `"0"` - none, {"number"} = fixed */
+    readonly target: import("valibot").UnionSchema<[import("valibot").LiteralSchema<"smart", undefined>, import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").MinValueAction<number, 0, undefined>, import("valibot").TransformAction<number, string>]>], undefined>;
+}, undefined>;
+export declare const fundUpdate: Omit<Omit<import("valibot").ObjectSchema<{
+    readonly name: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">]>;
+    readonly description: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">]>;
+    readonly banner: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>;
+    readonly logo: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>;
+    /** endowment ids */
+    readonly members: import("valibot").ArraySchema<import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").IntegerAction<number, undefined>, import("valibot").MinValueAction<number, 1, undefined>]>, undefined>;
+    readonly featured: import("valibot").BooleanSchema<undefined>;
+    readonly expiration: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").IsoTimestampAction<string, "invalid date">, import("valibot").MinValueAction<string, string, undefined>]>, never>;
+    /** `"0"` - none, {"number"} = fixed */
+    readonly target: import("valibot").UnionSchema<[import("valibot").LiteralSchema<"smart", undefined>, import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").MinValueAction<number, 0, undefined>, import("valibot").TransformAction<number, string>]>], undefined>;
+}, undefined>, "_types" | "_run" | "entries"> & {
+    readonly entries: Pick<{
+        readonly name: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">]>;
+        readonly description: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">]>;
+        readonly banner: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>;
+        readonly logo: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>;
+        /** endowment ids */
+        readonly members: import("valibot").ArraySchema<import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").IntegerAction<number, undefined>, import("valibot").MinValueAction<number, 1, undefined>]>, undefined>;
+        readonly featured: import("valibot").BooleanSchema<undefined>;
+        readonly expiration: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").IsoTimestampAction<string, "invalid date">, import("valibot").MinValueAction<string, string, undefined>]>, never>;
+        /** `"0"` - none, {"number"} = fixed */
+        readonly target: import("valibot").UnionSchema<[import("valibot").LiteralSchema<"smart", undefined>, import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").MinValueAction<number, 0, undefined>, import("valibot").TransformAction<number, string>]>], undefined>;
+    }, "name" | "description" | "banner" | "logo" | "target" | "featured">;
+    _run(dataset: import("valibot").Dataset<unknown, never>, config: import("valibot").Config<import("valibot").StringIssue | import("valibot").BooleanIssue | import("valibot").NonEmptyIssue<string> | import("valibot").UrlIssue<string> | import("valibot").NumberIssue | import("valibot").LiteralIssue | import("valibot").MinValueIssue<number, 0> | import("valibot").UnionIssue<import("valibot").NumberIssue | import("valibot").LiteralIssue | import("valibot").MinValueIssue<number, 0>> | import("valibot").ObjectIssue>): import("valibot").Dataset<{
+        name: string;
+        description: string;
+        banner: string;
+        logo: string;
+        target: string;
+        featured: boolean;
+    }, import("valibot").StringIssue | import("valibot").BooleanIssue | import("valibot").NonEmptyIssue<string> | import("valibot").UrlIssue<string> | import("valibot").NumberIssue | import("valibot").LiteralIssue | import("valibot").MinValueIssue<number, 0> | import("valibot").UnionIssue<import("valibot").NumberIssue | import("valibot").LiteralIssue | import("valibot").MinValueIssue<number, 0>> | import("valibot").ObjectIssue>;
+    readonly _types?: {
+        readonly input: {
+            name: string;
+            description: string;
+            banner: string;
+            logo: string;
+            target: number | "smart";
+            featured: boolean;
+        };
+        readonly output: {
+            name: string;
+            description: string;
+            banner: string;
+            logo: string;
+            target: string;
+            featured: boolean;
+        };
+        readonly issue: import("valibot").StringIssue | import("valibot").BooleanIssue | import("valibot").NonEmptyIssue<string> | import("valibot").UrlIssue<string> | import("valibot").NumberIssue | import("valibot").LiteralIssue | import("valibot").MinValueIssue<number, 0> | import("valibot").UnionIssue<import("valibot").NumberIssue | import("valibot").LiteralIssue | import("valibot").MinValueIssue<number, 0>> | import("valibot").ObjectIssue;
+    } | undefined;
+}, "_types" | "_run" | "entries"> & {
+    readonly entries: {
+        readonly name: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">]>, never>;
+        readonly description: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">]>, never>;
+        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 logo: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>, never>;
+        readonly target: import("valibot").OptionalSchema<import("valibot").UnionSchema<[import("valibot").LiteralSchema<"smart", undefined>, import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").MinValueAction<number, 0, undefined>, import("valibot").TransformAction<number, string>]>], undefined>, never>;
+        readonly featured: import("valibot").OptionalSchema<import("valibot").BooleanSchema<undefined>, never>;
+    };
+    _run(dataset: import("valibot").Dataset<unknown, never>, config: import("valibot").Config<import("valibot").StringIssue | import("valibot").BooleanIssue | import("valibot").NonEmptyIssue<string> | import("valibot").UrlIssue<string> | import("valibot").NumberIssue | import("valibot").LiteralIssue | import("valibot").MinValueIssue<number, 0> | import("valibot").UnionIssue<import("valibot").NumberIssue | import("valibot").LiteralIssue | import("valibot").MinValueIssue<number, 0>> | import("valibot").ObjectIssue>): import("valibot").Dataset<{
+        name?: string | undefined;
+        description?: string | undefined;
+        banner?: string | undefined;
+        logo?: string | undefined;
+        target?: string | undefined;
+        featured?: boolean | undefined;
+    }, import("valibot").StringIssue | import("valibot").BooleanIssue | import("valibot").NonEmptyIssue<string> | import("valibot").UrlIssue<string> | import("valibot").NumberIssue | import("valibot").LiteralIssue | import("valibot").MinValueIssue<number, 0> | import("valibot").UnionIssue<import("valibot").NumberIssue | import("valibot").LiteralIssue | import("valibot").MinValueIssue<number, 0>> | import("valibot").ObjectIssue>;
+    readonly _types?: {
+        readonly input: {
+            name?: string | undefined;
+            description?: string | undefined;
+            banner?: string | undefined;
+            logo?: string | undefined;
+            target?: number | "smart" | undefined;
+            featured?: boolean | undefined;
+        };
+        readonly output: {
+            name?: string | undefined;
+            description?: string | undefined;
+            banner?: string | undefined;
+            logo?: string | undefined;
+            target?: string | undefined;
+            featured?: boolean | undefined;
+        };
+        readonly issue: import("valibot").StringIssue | import("valibot").BooleanIssue | import("valibot").NonEmptyIssue<string> | import("valibot").UrlIssue<string> | import("valibot").NumberIssue | import("valibot").LiteralIssue | import("valibot").MinValueIssue<number, 0> | import("valibot").UnionIssue<import("valibot").NumberIssue | import("valibot").LiteralIssue | import("valibot").MinValueIssue<number, 0>> | import("valibot").ObjectIssue;
+    } | undefined;
+};
+export declare const fundsParams: import("valibot").ObjectSchema<{
+    /** search text */
+    readonly query: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, never>;
+    readonly page: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").IntegerAction<number, undefined>, import("valibot").MinValueAction<number, 1, undefined>]>, never>;
+}, undefined>;
+export declare const fundsEndowMemberOfParams: import("valibot").ObjectSchema<{
+    readonly npoProfileFeatured: import("valibot").BooleanSchema<undefined>;
+}, undefined>;
+export interface NewFund extends InferOutput<typeof newFund> {
+}
+export interface FundUpdate extends InferOutput<typeof fundUpdate> {
+}
+export interface FundsParams extends InferOutput<typeof fundsParams> {
+}
+export interface FundsEndowMemberOfParams extends InferOutput<typeof fundsEndowMemberOfParams> {
+}

package/dist/schema.mjs

@@ -0,0 +1,37 @@
+import { url, array, boolean, integer, isoTimestamp, literal, minValue, nonEmpty, number, object, optional, partial, pick, pipe, string, transform, trim, union, uuid, } from "valibot";
+const str = pipe(string(), trim());
+export const fundId = pipe(str, uuid());
+export const settings = object({
+    allowBgTip: boolean(),
+});
+export const newFund = object({
+    name: pipe(str, nonEmpty("required")),
+    description: pipe(str, nonEmpty("required")),
+    banner: pipe(str, url()),
+    logo: pipe(str, url()),
+    /** endowment ids */
+    members: array(pipe(number(), integer(), minValue(1))),
+    featured: boolean(),
+    expiration: optional(pipe(str, isoTimestamp("invalid date"), minValue(new Date().toISOString()) //created each parsing
+    )),
+    /** `"0"` - none, {"number"} = fixed */
+    target: union([
+        literal("smart"),
+        pipe(number(), minValue(0), transform((v) => v.toString())),
+    ]),
+});
+export const fundUpdate = partial(pick(newFund, ["name", "description", "banner", "logo", "featured", "target"]));
+export const fundsParams = object({
+    /** search text */
+    query: optional(str),
+    page: optional(pipe(number(), integer(), minValue(1))),
+});
+export const fundsEndowMemberOfParams = object({
+    /*
+     * this endow is the only member (not an index fund),
+     * and is approved:
+     * either pre-approval in creation (creator has endow credential)
+     * or creator has no credential but later npo approved
+     */
+    npoProfileFeatured: boolean(),
+});

package/package.json

@@ -0,0 +1,29 @@
+{
+    "name": "@better-giving/fundraiser",
+    "version": "1.0.0-rc.1",
+    "dependencies": {
+        "valibot": "0.42.0"
+    },
+    "peerDependencies": {
+        "valibot": "0.42.0"
+    },
+    "devDependencies": {
+        "@better-giving/config": "workspace:*",
+        "@better-giving/types": "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": "rm -rf ./dist && tsc --outDir dist",
+        "type-chek": "tsc --noEmit"
+    }
+}

package/src/cloudsearch.mts

@@ -0,0 +1,42 @@
+import type {
+  ToDoc,
+  ToHitFields,
+  ToUpdate,
+} from "@better-giving/types/cloudsearch";
+import type { DbRecord } from "./db.mjs";
+
+export type Fields = Pick<
+  DbRecord,
+  | "id"
+  | "name"
+  | "description"
+  | "env"
+  | "logo"
+  | "featured"
+  | "active"
+  | "verified"
+  | "donation_total_usd"
+  | "members"
+  | "target"
+  | "approvers"
+> & {
+  /** iso | "9999-12-31T23:59:59.000Z" year 9999 */
+  expiration: string;
+};
+
+/** uuidv4 */
+type DocId = string;
+type FundDoc = {
+  documentId: DocId;
+  _score: number;
+} & ToDoc<Fields>;
+
+export type HitFields = ToHitFields<Omit<FundDoc, "documentId" | "_score">>;
+
+export type Update = ToUpdate<
+  DocId,
+  Fields & {
+    /** not returned - query: endow only member */
+    members_csv: string;
+  }
+>;

package/src/db.mts

@@ -0,0 +1,26 @@
+import type { Environment } from "@better-giving/types/list";
+import type { NewFund } from "./schema.mjs";
+export interface Keys {
+  /** Fund#${uuid} */
+  PK: `Fund#${string}`;
+  SK: `Fund#${string}`;
+}
+
+export interface Attributes extends NewFund {
+  /** uuid */
+  id: string;
+  env: Environment;
+  /** fund can be closed before expiration  */
+  active: boolean;
+  verified: boolean;
+  /** to date received: initialized to `0` */
+  donation_total_usd: number;
+  /**
+   * approving NPO ids
+   * NPOs have a whitelist of fundraisers they support. thus, appears in their NPO profile page
+   * @default - [0]
+   * */
+  approvers: number[];
+}
+
+export interface DbRecord extends Keys, Attributes {}

package/src/index.mts

@@ -0,0 +1,28 @@
+import type { Attributes, DbRecord } from "./db.mjs";
+
+export interface FundMember {
+  id: number;
+  name: string;
+  card_img?: string;
+}
+
+export interface SingleFund extends Omit<DbRecord, "PK" | "SK" | "members"> {
+  members: FundMember[];
+}
+
+export interface FundCard
+  extends Pick<
+    Attributes,
+    | "id"
+    | "name"
+    | "description"
+    | "env"
+    | "logo"
+    | "featured"
+    | "active"
+    | "verified"
+    | "donation_total_usd"
+    | "members"
+    | "target"
+    | "approvers"
+  > {}

package/src/schema.mts

@@ -0,0 +1,82 @@
+import {
+  url,
+  type InferOutput,
+  array,
+  boolean,
+  integer,
+  isoTimestamp,
+  literal,
+  minValue,
+  nonEmpty,
+  number,
+  object,
+  optional,
+  partial,
+  pick,
+  pipe,
+  string,
+  transform,
+  trim,
+  union,
+  uuid,
+} from "valibot";
+
+const str = pipe(string(), trim());
+
+export const fundId = pipe(str, uuid());
+
+export const settings = object({
+  allowBgTip: boolean(),
+});
+
+export const newFund = object({
+  name: pipe(str, nonEmpty("required")),
+  description: pipe(str, nonEmpty("required")),
+  banner: pipe(str, url()),
+  logo: pipe(str, url()),
+  /** endowment ids */
+  members: array(pipe(number(), integer(), minValue(1))),
+  featured: boolean(),
+  expiration: optional(
+    pipe(
+      str,
+      isoTimestamp("invalid date"),
+      minValue(new Date().toISOString()) //created each parsing
+    )
+  ),
+  /** `"0"` - none, {"number"} = fixed */
+  target: union([
+    literal("smart"),
+    pipe(
+      number(),
+      minValue(0),
+      transform((v) => v.toString())
+    ),
+  ]),
+});
+
+export const fundUpdate = partial(
+  pick(newFund, ["name", "description", "banner", "logo", "featured", "target"])
+);
+
+export const fundsParams = object({
+  /** search text */
+  query: optional(str),
+  page: optional(pipe(number(), integer(), minValue(1))),
+});
+
+export const fundsEndowMemberOfParams = object({
+  /*
+   * this endow is the only member (not an index fund),
+   * and is approved:
+   * either pre-approval in creation (creator has endow credential)
+   * or creator has no credential but later npo approved
+   */
+  npoProfileFeatured: boolean(),
+});
+
+export interface NewFund extends InferOutput<typeof newFund> {}
+export interface FundUpdate extends InferOutput<typeof fundUpdate> {}
+export interface FundsParams extends InferOutput<typeof fundsParams> {}
+export interface FundsEndowMemberOfParams
+  extends InferOutput<typeof fundsEndowMemberOfParams> {}