@better-giving/schemas 2.0.2 → 2.0.4

package/dist/index.d.mts

@@ -26,9 +26,20 @@ export declare const $req_num_gt0: import("valibot").SchemaWithPipe<[import("val
 export declare const $num_gt0_fn: ({ required, }?: {
     required?: boolean;
 }) => import("valibot").LazySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<"required">, import("valibot").TrimAction]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<"required">, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<"required">, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">]>, import("valibot").TransformAction<string, number>, import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").MinValueAction<number, 0, "must be > 0">]>, import("valibot").TransformAction<number, string>]>>;
-export declare const https_url: ({ required }: {
-    required?: boolean | undefined;
+export declare const https_url: (opts?: {
+    required?: boolean;
 }) => import("valibot").LazySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<"required">, import("valibot").TrimAction]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<"required">, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<"required">, import("valibot").TrimAction]>, import("valibot").TransformAction<string, string>, import("valibot").UrlAction<string, "invalid url">]>>;
 export declare const segment_max_chars = 30;
 export declare const segment: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<"required">, import("valibot").TrimAction]>, import("valibot").MaxLengthAction<string, 30, ({ requirement: r }: import("valibot").MaxLengthIssue<string, 30>) => string>, 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 slug: import("valibot").LazySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<"required">, import("valibot").TrimAction]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<"required">, import("valibot").TrimAction]>, import("valibot").MaxLengthAction<string, 30, ({ requirement: r }: import("valibot").MaxLengthIssue<string, 30>) => string>, 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 increment_label_max_chars = 60;
+export declare const MAX_NUM_INCREMENTS = 4;
+export declare const increment_label: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<"required">, import("valibot").TrimAction]>, import("valibot").MaxLengthAction<string, 60, ({ requirement: r }: import("valibot").MaxLengthIssue<string, 60>) => string>]>;
+export declare const increment_val: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<"required">, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">]>, import("valibot").TransformAction<string, number>, import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").MinValueAction<number, 0, "must be > 0">]>, import("valibot").TransformAction<number, string>]>, import("valibot").TransformAction<string, string>]>;
+export declare const increment: import("valibot").ObjectSchema<{
+    readonly value: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<"required">, import("valibot").TrimAction]>, import("valibot").NonEmptyAction<string, "required">]>, import("valibot").TransformAction<string, number>, import("valibot").SchemaWithPipe<[import("valibot").NumberSchema<undefined>, import("valibot").MinValueAction<number, 0, "must be > 0">]>, import("valibot").TransformAction<number, string>]>, import("valibot").TransformAction<string, string>]>;
+    readonly label: import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<"required">, import("valibot").TrimAction]>, import("valibot").MaxLengthAction<string, 60, ({ requirement: r }: import("valibot").MaxLengthIssue<string, 60>) => string>]>;
+}, undefined>;
+export interface IIncrement extends InferOutput<typeof increment> {
+}
+export declare const target: import("valibot").UnionSchema<[import("valibot").LiteralSchema<"smart", undefined>, import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TransformAction<string, number>, import("valibot").NumberSchema<undefined>, import("valibot").MinValueAction<number, 0, undefined>, import("valibot").TransformAction<number, string>]>], undefined>;

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { url, custom, excludes, integer, lazy, maxLength, minValue, nonEmpty, number, object, picklist, pipe, regex, string, transform, trim, } from "valibot";
+import { url, custom, excludes, integer, lazy, maxLength, minValue, nonEmpty, number, object, picklist, pipe, regex, string, transform, trim, union, literal, } from "valibot";
 export const file_obj = object({
     name: string(),
     publicUrl: pipe(string(), url()),
@@ -34,10 +34,10 @@ export const $num_gt0_fn = ({ required = false, } = {}) => {
         return $req_num_gt0;
     });
 };
-export const https_url = ({ required = false }) => {
+export const https_url = (opts) => {
     return lazy((x) => {
         if (!x)
-            return required ? $req : $;
+            return (opts?.required ?? false) ? $req : $;
         return pipe($, transform((x) => (x.startsWith("https://") ? x : `https://${x}`)), url("invalid url"));
     });
 };
@@ -48,3 +48,18 @@ 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 slug = lazy((x) => (x ? segment : $));
+export const increment_label_max_chars = 60;
+export const MAX_NUM_INCREMENTS = 4;
+export const increment_label = pipe($, maxLength(increment_label_max_chars, ({ requirement: r }) => `cannot exceed ${r} characters`));
+export const increment_val = pipe($req_num_gt0, 
+//parsed output
+transform((x) => x.toString()));
+export const increment = object({
+    value: increment_val,
+    label: increment_label,
+});
+export const target = union([
+    literal("smart"),
+    // "0" - none, `${number}` - fixed
+    pipe(string(), transform((v) => +v), number(), minValue(0), transform((v) => v.toString())),
+]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@better-giving/schemas",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "devDependencies": {
     "@better-giving/config": "1.1.2"
   },
@@ -11,6 +11,9 @@
   "peerDependencies": {
     "valibot": "0.42.0"
   },
+  "optionalDependencies": {
+    "date-fns": "4.1.0"
+  },
   "exports": {
     ".": "./dist/index.mjs",
     "./*": "./dist/*.mjs"

package/src/index.mts

@@ -16,6 +16,8 @@ import {
   string,
   transform,
   trim,
+  union,
+  literal,
 } from "valibot";
 
 export const file_obj = object({
@@ -80,9 +82,9 @@ export const $num_gt0_fn = ({
   });
 };
 
-export const https_url = ({ required = false }) => {
+export const https_url = (opts?: { required?: boolean }) => {
   return lazy((x) => {
-    if (!x) return required ? $req : $;
+    if (!x) return (opts?.required ?? false) ? $req : $;
     return pipe(
       $,
       transform((x) => (x.startsWith("https://") ? x : `https://${x}`)),
@@ -108,3 +110,39 @@ export const segment = pipe(
 );
 
 export const slug = lazy((x) => (x ? segment : $));
+
+export const increment_label_max_chars = 60;
+export const MAX_NUM_INCREMENTS = 4;
+
+export const increment_label = pipe(
+  $,
+  maxLength(
+    increment_label_max_chars,
+    ({ requirement: r }) => `cannot exceed ${r} characters`
+  )
+);
+
+export const increment_val = pipe(
+  $req_num_gt0,
+  //parsed output
+  transform((x) => x.toString())
+);
+
+export const increment = object({
+  value: increment_val,
+  label: increment_label,
+});
+
+export interface IIncrement extends InferOutput<typeof increment> {}
+
+export const target = union([
+  literal("smart"),
+  // "0" - none, `${number}` - fixed
+  pipe(
+    string(),
+    transform((v) => +v),
+    number(),
+    minValue(0),
+    transform((v) => v.toString())
+  ),
+]);