shelving 1.150.4 → 1.150.5

package/feedback/index.d.ts

@@ -1,2 +1 @@
 export * from "./Feedback.js";
-export * from "./Feedbacks.js";

package/feedback/index.js

@@ -1,2 +1 @@
 export * from "./Feedback.js";
-export * from "./Feedbacks.js";

package/package.json

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

package/util/error.d.ts

@@ -4,3 +4,28 @@ export declare function logError(reason: unknown): void;
 export declare function isError(v: unknown): v is Error & {
     readonly code?: string | undefined;
 };
+/**
+ * Extract the _main message(s)_ from a full error message string.
+ *
+ * - Error messages can have multiple lines separated by `\n` newline.
+ * - Some lines may be _named messages_ in `name: This is a message` format.
+ * - The _main_ message is any line(s) that is not a named message.
+ *
+ * @returns The combined main message(s) found in the full message string.
+ */
+export declare function getMainMessage(fullMessage: string): string;
+/**
+ * Extract the _named message(s)_ from a full error message string.
+ *
+ * - Error messages can have multiple lines separated by `\n` newline.
+ * - Some lines may be _named messages_ in `name: This is a message` format.
+ * - This function extracts any `name: This is a message` lines from the full message string.
+ * - Note there may be multiple lines starting with `name:` (in the case where there were multiple errors with that name).
+ * - This trims the `name: ` prefix from found messages and rejoins them with `\n` newline.
+ *
+ * @param fullMessage The full message string which may contain named messages in `name: This is a message` format.
+ * @param name The name of the prop to extract the message for.
+ *
+ * @returns The combined message(s) for the named prop found in the full message string, or an empty string if no messages were found for that prop.
+ */
+export declare function getNamedMessage(fullMessage: string, name: string | number): string;

package/util/error.js

@@ -6,3 +6,40 @@ export function logError(reason) {
 export function isError(v) {
     return typeof Error.isError === "function" ? Error.isError(v) : v instanceof Error;
 }
+/**
+ * Extract the _main message(s)_ from a full error message string.
+ *
+ * - Error messages can have multiple lines separated by `\n` newline.
+ * - Some lines may be _named messages_ in `name: This is a message` format.
+ * - The _main_ message is any line(s) that is not a named message.
+ *
+ * @returns The combined main message(s) found in the full message string.
+ */
+export function getMainMessage(fullMessage) {
+    let propMessages = "";
+    for (const [foundMessage] of fullMessage.matchAll(/^\s*(?!.*: )(.*?)\s*/g))
+        if (foundMessage)
+            propMessages = propMessages ? `${propMessages}\n${foundMessage}` : foundMessage;
+    return propMessages;
+}
+/**
+ * Extract the _named message(s)_ from a full error message string.
+ *
+ * - Error messages can have multiple lines separated by `\n` newline.
+ * - Some lines may be _named messages_ in `name: This is a message` format.
+ * - This function extracts any `name: This is a message` lines from the full message string.
+ * - Note there may be multiple lines starting with `name:` (in the case where there were multiple errors with that name).
+ * - This trims the `name: ` prefix from found messages and rejoins them with `\n` newline.
+ *
+ * @param fullMessage The full message string which may contain named messages in `name: This is a message` format.
+ * @param name The name of the prop to extract the message for.
+ *
+ * @returns The combined message(s) for the named prop found in the full message string, or an empty string if no messages were found for that prop.
+ */
+export function getNamedMessage(fullMessage, name) {
+    let namedMessages = "";
+    for (const [foundMessage] of fullMessage.matchAll(new RegExp(`^${name}: \s*(.*?)\s*$`, "g")))
+        if (foundMessage)
+            namedMessages = namedMessages ? `${namedMessages}\n${foundMessage}` : foundMessage;
+    return namedMessages;
+}

package/util/validate.js

@@ -1,6 +1,5 @@
 import { ValueError } from "../error/ValueError.js";
-import { Feedback } from "../feedback/Feedback.js";
-import { ValueFeedbacks } from "../feedback/Feedbacks.js";
+import { Feedback, ValueFeedback } from "../feedback/Feedback.js";
 import { isArray } from "./array.js";
 import { getDataKeys, getDataProps } from "./data.js";
 import { getDictionaryItems } from "./dictionary.js";
@@ -30,8 +29,7 @@ export function getValid(value, validator, ErrorConstructor = ValueError, caller
  */
 export function* validateItems(unsafeItems, validator) {
     let index = 0;
-    let valid = true;
-    const messages = {};
+    const messages = [];
     for (const unsafeItem of unsafeItems) {
         try {
             yield validator.validate(unsafeItem);
@@ -39,13 +37,12 @@ export function* validateItems(unsafeItems, validator) {
         catch (thrown) {
             if (!(thrown instanceof Feedback))
                 throw thrown;
-            messages[index] = thrown.message;
-            valid = false;
+            messages.push(`${index}: ${thrown.message}`);
         }
         index++;
     }
-    if (!valid)
-        throw new ValueFeedbacks(messages, unsafeItems);
+    if (messages.length)
+        throw new ValueFeedback(messages.join("\n"), unsafeItems);
 }
 /**
  * Validate an array of items.
@@ -56,10 +53,9 @@ export function* validateItems(unsafeItems, validator) {
  */
 export function validateArray(unsafeArray, validator) {
     let index = 0;
-    let valid = true;
     let changed = false; // start false so we can reuse original if nothing changes
     const safeArray = [];
-    const messages = {};
+    const messages = [];
     for (const unsafeItem of unsafeArray) {
         try {
             const safeItem = validator.validate(unsafeItem);
@@ -70,13 +66,12 @@ export function validateArray(unsafeArray, validator) {
         catch (thrown) {
             if (!(thrown instanceof Feedback))
                 throw thrown;
-            messages[index] = thrown.message;
-            valid = false;
+            messages.push(`${index}: ${thrown.message}`);
         }
         index++;
     }
-    if (!valid)
-        throw new ValueFeedbacks(messages, unsafeArray);
+    if (messages.length)
+        throw new ValueFeedback(messages.join("\n"), unsafeArray);
     return changed || !isArray(unsafeArray) ? safeArray : unsafeArray;
 }
 /**
@@ -86,10 +81,9 @@ export function validateArray(unsafeArray, validator) {
  * - `feedback.details` will contain an entry for each invalid item (keyed by their count in the input iterable).
  */
 export function validateDictionary(unsafeDictionary, validator) {
-    let valid = true;
     let changed = false;
     const safeDictionary = {};
-    const messages = {};
+    const messages = [];
     for (const [key, unsafeValue] of getDictionaryItems(unsafeDictionary)) {
         try {
             const safeValue = validator.validate(unsafeValue);
@@ -100,21 +94,19 @@ export function validateDictionary(unsafeDictionary, validator) {
         catch (thrown) {
             if (!(thrown instanceof Feedback))
                 throw thrown;
-            messages[key] = thrown.message;
-            valid = false;
+            messages.push(`${key}: ${thrown.message}`);
         }
     }
-    if (!valid)
-        throw new ValueFeedbacks(messages, unsafeDictionary);
+    if (messages.length)
+        throw new ValueFeedback(messages.join("\n"), unsafeDictionary);
     return changed || isIterable(unsafeDictionary) ? safeDictionary : unsafeDictionary;
 }
 /** Keep track of whether we're doing a deep-partial match or not. */
 let isDeeplyPartial = false;
 export function validateData(unsafeData, validators, partial = isDeeplyPartial) {
-    let valid = true;
     let changed = false;
     const safeData = {};
-    const messages = {};
+    const messages = [];
     try {
         isDeeplyPartial = partial;
         const props = getDataProps(validators);
@@ -132,12 +124,11 @@ export function validateData(unsafeData, validators, partial = isDeeplyPartial)
             catch (thrown) {
                 if (!(thrown instanceof Feedback))
                     throw thrown;
-                messages[key] = thrown.message;
-                valid = false;
+                messages.push(`${key}: ${thrown.message}`);
             }
         }
-        if (!valid)
-            throw new ValueFeedbacks(messages, unsafeData);
+        if (messages.length)
+            throw new ValueFeedback(messages.join("\n"), unsafeData);
         if (changed || getDataKeys(unsafeData).length > props.length)
             return safeData;
         return unsafeData;

package/feedback/Feedbacks.d.ts

@@ -1,13 +0,0 @@
-import type { ImmutableDictionary } from "../util/dictionary.js";
-import { Feedback } from "./Feedback.js";
-/** Feedback with a set of named messages. */
-export declare class Feedbacks extends Feedback {
-    /** List of named messages. */
-    readonly messages: ImmutableDictionary<string>;
-    constructor(messages: ImmutableDictionary<string>);
-}
-/** Feedbacks with a known and typed `.value` field. */
-export declare class ValueFeedbacks<T> extends Feedbacks {
-    readonly value: T;
-    constructor(messages: ImmutableDictionary<string>, value: T);
-}

package/feedback/Feedbacks.js

@@ -1,18 +0,0 @@
-import { Feedback } from "./Feedback.js";
-/** Feedback with a set of named messages. */
-export class Feedbacks extends Feedback {
-    /** List of named messages. */
-    messages;
-    constructor(messages) {
-        super(Object.values(messages).join("\n"));
-        this.messages = messages;
-    }
-}
-/** Feedbacks with a known and typed `.value` field. */
-export class ValueFeedbacks extends Feedbacks {
-    value;
-    constructor(messages, value) {
-        super(messages);
-        this.value = value;
-    }
-}