shelving 1.145.3 → 1.146.0

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.145.3",
+	"version": "1.146.0",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",

package/schema/SlugSchema.js

@@ -1,4 +1,4 @@
-import { requireSlug } from "../util/string.js";
+import { getSlug } from "../util/string.js";
 import { OPTIONAL } from "./OptionalSchema.js";
 import { StringSchema } from "./StringSchema.js";
 /**
@@ -17,7 +17,7 @@ export class SlugSchema extends StringSchema {
         });
     }
     sanitize(str) {
-        return requireSlug(str);
+        return getSlug(str) || "";
     }
 }
 /** Valid slug, e.g. `this-is-a-slug` */

package/schema/UUIDSchema.d.ts

@@ -0,0 +1,14 @@
+import { StringSchema, type StringSchemaOptions } from "./StringSchema.js";
+/**
+ * Type of `StringSchema` that defines a valid UUID (versions 1-5). Defaults to any-version validation.
+ * - Input is trimmed and lowercased.
+ * - Falsy values are converted to empty string.
+ */
+export declare class UUIDSchema extends StringSchema {
+    constructor(options?: StringSchemaOptions);
+    sanitize(str: string): string;
+}
+/** Any valid UUID (versions 1-5) */
+export declare const UUID: UUIDSchema;
+/** Any valid UUID (versions 1-5) or null */
+export declare const OPTIONAL_UUID: import("./OptionalSchema.js").OptionalSchema<string>;

package/schema/UUIDSchema.js

@@ -0,0 +1,26 @@
+import { getUUID } from "../util/uuid.js";
+import { OPTIONAL } from "./OptionalSchema.js";
+import { StringSchema } from "./StringSchema.js";
+/**
+ * Type of `StringSchema` that defines a valid UUID (versions 1-5). Defaults to any-version validation.
+ * - Input is trimmed and lowercased.
+ * - Falsy values are converted to empty string.
+ */
+export class UUIDSchema extends StringSchema {
+    constructor(options = {}) {
+        const { title = "UUID", ...rest } = options;
+        super({
+            title,
+            ...rest,
+            min: 36,
+            max: 36, // 36 chars including hyphens
+        });
+    }
+    sanitize(str) {
+        return getUUID(str) || "";
+    }
+}
+/** Any valid UUID (versions 1-5) */
+export const UUID = new UUIDSchema({ title: "ID" });
+/** Any valid UUID (versions 1-5) or null */
+export const OPTIONAL_UUID = OPTIONAL(UUID);

package/schema/index.d.ts

@@ -1,4 +1,7 @@
 export * from "./Schema.js";
+export * from "./ThroughSchema.js";
+export * from "./OptionalSchema.js";
+export * from "./RequiredSchema.js";
 export * from "./AllowSchema.js";
 export * from "./ArraySchema.js";
 export * from "./BooleanSchema.js";
@@ -18,6 +21,4 @@ export * from "./SlugSchema.js";
 export * from "./StringSchema.js";
 export * from "./TextSchema.js";
 export * from "./TimeSchema.js";
-export * from "./ThroughSchema.js";
-export * from "./OptionalSchema.js";
-export * from "./RequiredSchema.js";
+export * from "./UUIDSchema.js";

package/schema/index.js

@@ -1,4 +1,9 @@
 export * from "./Schema.js";
+// Utility schemas.
+export * from "./ThroughSchema.js";
+export * from "./OptionalSchema.js";
+export * from "./RequiredSchema.js";
+// Field schemas.
 export * from "./AllowSchema.js";
 export * from "./ArraySchema.js";
 export * from "./BooleanSchema.js";
@@ -18,6 +23,4 @@ export * from "./SlugSchema.js";
 export * from "./StringSchema.js";
 export * from "./TextSchema.js";
 export * from "./TimeSchema.js";
-export * from "./ThroughSchema.js";
-export * from "./OptionalSchema.js";
-export * from "./RequiredSchema.js";
+export * from "./UUIDSchema.js";

package/util/index.d.ts

@@ -58,4 +58,5 @@ export * from "./undefined.js";
 export * from "./units.js";
 export * from "./update.js";
 export * from "./url.js";
+export * from "./uuid.js";
 export * from "./validate.js";

package/util/index.js

@@ -58,4 +58,5 @@ export * from "./undefined.js";
 export * from "./units.js";
 export * from "./update.js";
 export * from "./url.js";
+export * from "./uuid.js";
 export * from "./validate.js";

package/util/uuid.d.ts

@@ -0,0 +1,6 @@
+/** Return a random UUID (v4) */
+export declare function randomUUID(): string;
+/** Convert/validate a unknown value as as UUID. */
+export declare function getUUID(value: string): string | undefined;
+/** Require a valid UUID. */
+export declare function requireUUID(value: string): string;

package/util/uuid.js

@@ -0,0 +1,22 @@
+import { RequiredError } from "../error/RequiredError.js";
+/** Return a random UUID (v4) */
+export function randomUUID() {
+    return crypto.randomUUID();
+}
+/** Convert/validate a unknown value as as UUID. */
+export function getUUID(value) {
+    if (typeof value !== "string" || !value)
+        return;
+    // Strip any non-hex characters (including existing dashes), then normalize to lowercase.
+    const cleaned = value.replace(/[^0-9A-Fa-f]/g, "").toLowerCase();
+    if (cleaned.length !== 32)
+        return;
+    return `${cleaned.slice(0, 8)}-${cleaned.slice(8, 12)}-${cleaned.slice(12, 16)}-${cleaned.slice(16, 20)}-${cleaned.slice(20)}`;
+}
+/** Require a valid UUID. */
+export function requireUUID(value) {
+    const uuid = getUUID(value);
+    if (!uuid)
+        throw new RequiredError("Invalid UUID");
+    return uuid;
+}