@better-giving/endowment 1.0.13 → 1.0.16

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import type { Fields as FundItem } from "./cloudsearch.mjs";
-import type { Media, Endow as NEndow } from "./db.mjs";
-export type { Allocation, DonateMethodId, EndowByEinParams, EndowDesignation, EndowQueryParam, EndowsQueryParams, EndowUpdate, Environment, Increment, Milestone, MilestoneUpdate, NewMilestone, NewProgram, Program, ProgramUpdate, SocialMediaURLs, UnSdgNum, MediaQueryParams, MediaType, MediaUpdate, } from "./schema.mjs";
+import type { Endow as NEndow, Media } from "./db.mjs";
+export type { Allocation, DonateMethodId, EndowByEinParams, EndowDesignation, EndowQueryParam, EndowsQueryParams, EndowUpdate, Environment, Increment, Milestone, MilestoneUpdate, NewMilestone, NewProgram, Program, ProgramUpdate, SocialMediaURLs, UnSdgNum, MediaQueryParams, MediaQueryParamsObj, MediaType, MediaUpdate, } from "./schema.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" | "progDonationsAllowed" | "donateMethods" | "allocation" | "increments" | "receiptMsg">;
 /** web-app format */

package/dist/schema.d.mts

@@ -23,7 +23,8 @@ export declare const donateMethodIds: readonly ["stripe", "crypto", "daf", "stoc
 export declare const donateMethodId: import("valibot").PicklistSchema<readonly ["stripe", "crypto", "daf", "stocks"], undefined>;
 export type DonateMethodId = InferOutput<typeof donateMethodId>;
 export declare const _url: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").UrlAction<string, undefined>]>;
-export declare const userInputUrl: 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").StartsWithAction<string, "https://", "should start with https://">, import("valibot").CustomSchema<string, "incomplete url">, import("valibot").UrlAction<string, "invalid url">]>>;
+export declare const httpsUrl: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").StartsWithAction<string, "https://", "should start with https://">, import("valibot").CustomSchema<string, "incomplete url">, import("valibot").UrlAction<string, "invalid url">]>;
+export declare const maybeEmptyHttpsUrl: 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").StartsWithAction<string, "https://", "should start with https://">, import("valibot").CustomSchema<string, "incomplete url">, import("valibot").UrlAction<string, "invalid url">]>>;
 export declare const social_media_urls: import("valibot").ObjectSchema<{
     readonly facebook: 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").StartsWithAction<string, "https://", "should start with https://">, import("valibot").CustomSchema<string, "incomplete url">, import("valibot").UrlAction<string, "invalid url">]>>, never>;
     readonly twitter: 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").StartsWithAction<string, "https://", "should start with https://">, import("valibot").CustomSchema<string, "incomplete url">, import("valibot").UrlAction<string, "invalid url">]>>, never>;
@@ -749,3 +750,4 @@ export declare const mediaQueryParams: import("valibot").ObjectSchema<{
     readonly limit: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TransformAction<string, number>, import("valibot").NumberSchema<undefined>, import("valibot").IntegerAction<number, undefined>, import("valibot").MinValueAction<number, 1, undefined>]>, never>;
 }, undefined>;
 export type MediaQueryParams = InferInput<typeof mediaQueryParams>;
+export type MediaQueryParamsObj = InferOutput<typeof mediaQueryParams>;

package/dist/schema.mjs

@@ -24,19 +24,20 @@ export const reg_number = pipe(str, nonEmpty("required"), regex(/^[a-zA-Z0-9]+$/
 export const donateMethodIds = ["stripe", "crypto", "daf", "stocks"];
 export const donateMethodId = picklist(donateMethodIds);
 export const _url = pipe(str, url());
-export const userInputUrl = lazy((x) => {
+export const httpsUrl = pipe(str, startsWith("https://", "should start with https://"), custom((x) => x !== "https://", "incomplete url"), url("invalid url"));
+export const maybeEmptyHttpsUrl = lazy((x) => {
     if (!x)
         return str;
-    return pipe(str, startsWith("https://", "should start with https://"), custom((x) => x !== "https://", "incomplete url"), url("invalid url"));
+    return httpsUrl;
 });
 export const social_media_urls = object({
-    facebook: optional(userInputUrl),
-    twitter: optional(userInputUrl),
-    linkedin: optional(userInputUrl),
-    discord: optional(userInputUrl),
-    instagram: optional(userInputUrl),
-    youtube: optional(userInputUrl),
-    tiktok: optional(userInputUrl),
+    facebook: optional(maybeEmptyHttpsUrl),
+    twitter: optional(maybeEmptyHttpsUrl),
+    linkedin: optional(maybeEmptyHttpsUrl),
+    discord: optional(maybeEmptyHttpsUrl),
+    instagram: optional(maybeEmptyHttpsUrl),
+    youtube: optional(maybeEmptyHttpsUrl),
+    tiktok: optional(maybeEmptyHttpsUrl),
 });
 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"), 
@@ -66,7 +67,7 @@ export const endowment = object({
     street_address: optional(str),
     social_media_urls,
     /** website */
-    url: optional(userInputUrl),
+    url: optional(maybeEmptyHttpsUrl),
     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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@better-giving/endowment",
-  "version": "1.0.13",
+  "version": "1.0.16",
   "peerDependencies": {
     "@better-giving/schemas": "1.0.1",
     "@better-giving/types": "1.0.1"

package/src/index.mts

@@ -1,5 +1,5 @@
 import type { Fields as FundItem } from "./cloudsearch.mjs";
-import type { Media, Endow as NEndow } from "./db.mjs";
+import type { Endow as NEndow, Media } from "./db.mjs";
 export type {
   Allocation,
   DonateMethodId,
@@ -19,6 +19,7 @@ export type {
   SocialMediaURLs,
   UnSdgNum,
   MediaQueryParams,
+  MediaQueryParamsObj,
   MediaType,
   MediaUpdate,
 } from "./schema.mjs";

package/src/schema.mts

@@ -92,24 +92,27 @@ export const donateMethodId = picklist(donateMethodIds);
 export type DonateMethodId = InferOutput<typeof donateMethodId>;
 
 export const _url = pipe(str, url());
-export const userInputUrl = lazy((x) => {
+
+export const httpsUrl = pipe(
+  str,
+  startsWith("https://", "should start with https://"),
+  custom((x) => x !== "https://", "incomplete url"),
+  url("invalid url")
+);
+
+export const maybeEmptyHttpsUrl = lazy((x) => {
   if (!x) return str;
-  return pipe(
-    str,
-    startsWith("https://", "should start with https://"),
-    custom((x) => x !== "https://", "incomplete url"),
-    url("invalid url")
-  );
+  return httpsUrl;
 });
 
 export const social_media_urls = object({
-  facebook: optional(userInputUrl),
-  twitter: optional(userInputUrl),
-  linkedin: optional(userInputUrl),
-  discord: optional(userInputUrl),
-  instagram: optional(userInputUrl),
-  youtube: optional(userInputUrl),
-  tiktok: optional(userInputUrl),
+  facebook: optional(maybeEmptyHttpsUrl),
+  twitter: optional(maybeEmptyHttpsUrl),
+  linkedin: optional(maybeEmptyHttpsUrl),
+  discord: optional(maybeEmptyHttpsUrl),
+  instagram: optional(maybeEmptyHttpsUrl),
+  youtube: optional(maybeEmptyHttpsUrl),
+  tiktok: optional(maybeEmptyHttpsUrl),
 });
 
 export type SocialMediaURLs = InferOutput<typeof social_media_urls>;
@@ -161,7 +164,7 @@ export const endowment = object({
   street_address: optional(str),
   social_media_urls,
   /** website */
-  url: optional(userInputUrl),
+  url: optional(maybeEmptyHttpsUrl),
   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
@@ -331,3 +334,4 @@ export const mediaQueryParams = object({
   ),
 });
 export type MediaQueryParams = InferInput<typeof mediaQueryParams>;
+export type MediaQueryParamsObj = InferOutput<typeof mediaQueryParams>;