@better-giving/schemas 1.2.1 → 1.2.3

package/dist/index.d.mts

@@ -26,3 +26,6 @@ export declare const $num_gt0_fn: ({ required, }?: {
     required?: boolean;
 }) => 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").NonEmptyAction<string, "required">]> | import("valibot").SchemaWithPipe<[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<"invalid number">, import("valibot").MinValueAction<number, 0, "must be > 0">, import("valibot").TransformAction<number, string>]>>;
 export declare const https_url: (non_empty: boolean) => 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").NonEmptyAction<string, "required">]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, 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<undefined>, 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<undefined>, import("valibot").TrimAction]> | 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>, 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">]>>;

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { url, lazy, nonEmpty, object, picklist, pipe, string, transform, trim, number, minValue, integer, } from "valibot";
+import { url, integer, lazy, minValue, nonEmpty, number, object, picklist, pipe, string, transform, trim, maxLength, custom, regex, excludes, } from "valibot";
 export const file_obj = object({
     name: string(),
     publicUrl: pipe(string(), url()),
@@ -40,3 +40,10 @@ export const https_url = (non_empty) => {
         return pipe($, transform((x) => (x.startsWith("https://") ? x : `https://${x}`)), url("invalid url"));
     });
 };
+export const segment_max_chars = 30;
+export const segment = pipe($, maxLength(segment_max_chars, ({ requirement: r }) => `cannot exceed ${r} chars`), 
+//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 slug = lazy((x) => (x ? segment : $));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@better-giving/schemas",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "devDependencies": {
     "@better-giving/config": "1.1.2"
   },

package/src/index.mts

@@ -1,17 +1,21 @@
 import {
   url,
   type InferOutput,
+  integer,
   lazy,
+  minValue,
   nonEmpty,
+  number,
   object,
   picklist,
   pipe,
   string,
   transform,
   trim,
-  number,
-  minValue,
-  integer,
+  maxLength,
+  custom,
+  regex,
+  excludes,
 } from "valibot";
 
 export const file_obj = object({
@@ -85,3 +89,21 @@ export const https_url = (non_empty: boolean) => {
     );
   });
 };
+
+export const segment_max_chars = 30;
+export const segment = pipe(
+  $,
+  maxLength(
+    segment_max_chars,
+    ({ requirement: r }) => `cannot exceed ${r} chars`
+  ),
+  //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 slug = lazy((x) => (x ? segment : $));