@kaumlaut/pure 0.5.2 → 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Max Kämmerer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,5 +1,7 @@
 # @kaumlaut/pure
 
+![example workflow](https://github.com/maxkaemmerer/pure/actions/workflows/node.js.yml/badge.svg)
+
 Types and functions for a state runtime inspired by Elm and functional programming
 
-- [API Reference](https://github.com/maxkaemmerer/pure-vue-poc/blob/main/pure/docs/README.md)
+- [API Reference](https://github.com/maxkaemmerer/pure/blob/main/docs/README.md)

package/dist/error-aware-guard/index.d.ts

@@ -0,0 +1,186 @@
+/**
+ * Provides easily composable generic type guards that track errors
+ * @module error-aware-guard
+ */
+import * as Guard from "@kaumlaut/pure/guard";
+/**
+ * Represents a successful ErrorAwareGuard, containing the value
+ */
+export type SuccessResult<T> = {
+    readonly success: true;
+    readonly value: T;
+};
+/**
+ * Represents a failed ErrorAwareGuard, containing errors
+ */
+export type ErrorResult = {
+    readonly success: false;
+    readonly errors: string[];
+};
+/**
+ * Represents the result of a ErrorAwareGuard
+ */
+export type ValidationResult<T> = SuccessResult<T> | ErrorResult;
+/**
+ * Represents a function that returns a wrapped value on success or a wrapped error on failure
+ */
+export type ErrorAwareGuard<T> = (value: unknown) => ValidationResult<T>;
+/**
+ * Creates an ErrorResult with the given errors
+ */
+export declare function fail(...errors: string[]): ErrorResult;
+/**
+ * Creates an SuccessResult<T> with the given value
+ */
+export declare function pass<T>(value: T): SuccessResult<T>;
+/**
+ * Takes a ValidationResult<T> and if it is an ErrorResult, prefixes every error with the given prefix.
+ */
+export declare function prefixErrors<T>(value: ValidationResult<T>, prefix: string): ValidationResult<T>;
+/**
+ * Converts an ErrorAwareGuard<T> to a Guard<T>
+ */
+export declare function toGuard<T>(guard: ErrorAwareGuard<T>): Guard.Guard<T>;
+/**
+ * Evaluates an ErrorAwareGuard<T> for given value
+ */
+export declare function check<T>(value: unknown, guard: ErrorAwareGuard<T>): value is T;
+/**
+ * Combines a list of results. Returning a SuccessResult<T> if all of them are SucessResult<T>
+ * or returns an ErrorResult with combined errors if any of them are ErrorResult.
+ */
+export declare function combineResultsAll<T>(...results: ValidationResult<T>[]): ValidationResult<T>;
+/**
+ * Combines two results. Returning a SuccessResult<T> if both of them are SucessResult<T>
+ * or returns an ErrorResult with combined errors if one is an ErrorResult.
+ */
+export declare function combineTwoResultsAnd<T1, T2>(a: ValidationResult<T1>, b: ValidationResult<T2>): ValidationResult<T1 & T2>;
+/**
+ * Combines two results. Returning a SuccessResult<T> if either of them are SucessResult<T>
+ * or returns an ErrorResult with combined errors if both are an ErrorResult.
+ */
+export declare function combineTwoResultsOneOf<T1, T2>(a: ValidationResult<T1>, b: ValidationResult<T2>): ValidationResult<T1 | T2>;
+/**
+ * Combines a list of results. Returning a SuccessResult<T> if either of them are SucessResult<T>
+ * or returns an ErrorResult with combined errors if all are an ErrorResult.
+ */
+export declare function combineResultsOneOf<T>(...results: ValidationResult<T>[]): ValidationResult<T>;
+/**
+ * Converts a Guard<T> to an ErrorAwareGuard<T> with provided error factory function
+ */
+export declare function fromGuard<T>(guard: Guard.Guard<T>, createErrors: (value: unknown) => string[]): ErrorAwareGuard<T>;
+/**
+ * First applies the predicateGuard and if it is a SuccessResult<T> passes the value to check.
+ * If check returns true it creates SuccessResult<T>.
+ * Otherwise an ErrorResult is created, containing the errors created by the error factory function.
+ */
+export declare function tryGuardIf<T, T2 extends T = T>(predicateGuard: ErrorAwareGuard<T>, check: (value: T) => value is T2, createErrors: (value: T) => string[]): ErrorAwareGuard<T2>;
+/**
+ * Confirms that the given value passes both guards.
+ */
+export declare function isBoth<T1, T2>(a: ErrorAwareGuard<T1>, b: ErrorAwareGuard<T2>): ErrorAwareGuard<T1 & T2>;
+/**
+ * Confirms that the given value passes all guards.
+ */
+export declare function isAll<T>(guards: ErrorAwareGuard<T>[]): ErrorAwareGuard<T>;
+/**
+ * Confirms the value passes at least one of the given Guards.
+ */
+export declare function isOneOf<T1, T2>(a: ErrorAwareGuard<T1>, b: ErrorAwareGuard<T2>): ErrorAwareGuard<T1 | T2>;
+/**
+ * Confirms the value is a list of items that all pass the given guard.
+ */
+export declare function isListOf<I, T extends I[]>(guard: ErrorAwareGuard<I>): ErrorAwareGuard<T>;
+/**
+ * Confirms that the value is a number.
+ */
+export declare const isNumber: ErrorAwareGuard<number>;
+/**
+ * Confirms that the value is a string.
+ */
+export declare const isString: <T extends string>(value: unknown) => ValidationResult<T>;
+/**
+ * Confirms that the value is an exact string.
+ */
+export declare const isExactString: <T extends string>(expectedString: T) => ErrorAwareGuard<T>;
+/**
+ * Confirms that the value is a boolean.
+ */
+export declare const isBool: ErrorAwareGuard<boolean>;
+/**
+ * Confirms that the value is a float.
+ */
+export declare const isFloat: ErrorAwareGuard<number>;
+/**
+ * Confirms that the value is an interger.
+ */
+export declare const isInt: ErrorAwareGuard<number>;
+/**
+ * Confirms that the value is null.
+ */
+export declare const isNull: ErrorAwareGuard<null>;
+/**
+ * Confirms that the value is undefined.
+ */
+export declare const isUndefined: ErrorAwareGuard<undefined>;
+/**
+ * Confirms that the value is an object.
+ */
+export declare const isObject: ErrorAwareGuard<object>;
+/**
+ * Always passes.
+ */
+export declare const isAlways: ErrorAwareGuard<unknown>;
+/**
+ * Never passes.
+ */
+export declare const isNever: ErrorAwareGuard<unknown>;
+/**
+ * Confirms that the value is a non-empty string.
+ */
+export declare const isNonEmptyString: ErrorAwareGuard<string>;
+/**
+ * Confirms that the value is a string with specified length.
+ */
+export declare const isStringOfLength: (length: number) => ErrorAwareGuard<string>;
+/**
+ * Confirms the value is a string and matches the given regular expression.
+ */
+export declare const isStringWithPattern: (pattern: RegExp) => ErrorAwareGuard<string>;
+/**
+ * Confirms the value is a list with atleast one item and all items match the given guard.
+ */
+export declare const isNonEmptyListOf: <I, T extends I[]>(guard: ErrorAwareGuard<I>) => ErrorAwareGuard<T>;
+/**
+ * Confirms the value is number between min and max inclusive.
+ * Meaning if the value equals min or max the guard passes.
+ */
+export declare const isNumberBetweenInclusive: (min: number, max: number) => ErrorAwareGuard<number>;
+/**
+ * Confirms the value is either null or passes the given Guard.
+ */
+export declare const isNullOr: <T>(guard: ErrorAwareGuard<T>) => ErrorAwareGuard<T>;
+export declare const isOneStringOf: <T extends string>(validValues: T[]) => ErrorAwareGuard<T>;
+/**
+ * Confirms that the value is an object containing the specified key.
+ */
+export declare function isObjectWithKey<T extends object, K extends keyof T>(key: K): ErrorAwareGuard<T>;
+/**
+ * Confirms that the value is an object containing the specified key the value matching the given guard.
+ */
+export declare function isObjectWithKeyMatchingGuard<T extends object, K extends keyof T>(key: K, guard: ErrorAwareGuard<T[K]>): ErrorAwareGuard<T>;
+/**
+ * Confirms that the value is an object containing the specified keys.
+ */
+export declare function isObjectWithKeys<T extends object, K extends keyof T>(keys: K[]): ErrorAwareGuard<T>;
+/**
+ * Confirms that the value is an object whose key value pairs match the corresponding type guards.
+ */
+export declare function isObjectWithKeysMatchingGuard<T extends object, K extends keyof T>(guards: {
+    [K in keyof T]: ErrorAwareGuard<T[K]>;
+}): ErrorAwareGuard<T>;
+/**
+ * Confirms the value is an object where every value matches the given guard.
+ */
+export declare function isObjectWithAllKeysMatchingGuard<T extends object, K extends keyof T>(guard: ErrorAwareGuard<T[K]>): ErrorAwareGuard<T>;
+//# sourceMappingURL=index.d.ts.map

package/dist/error-aware-guard/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/error-aware-guard/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,KAAK,MAAM,sBAAsB,CAAC;AAE9C;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI;IAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC;AAE7E;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,KAAK,gBAAgB,CAAC,CAAC,CAAC,CAAC;AAEzE;;GAEG;AACH,wBAAgB,IAAI,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,WAAW,CAKrD;AAED;;GAEG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAKlD;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAC1B,MAAM,EAAE,MAAM,GACb,gBAAgB,CAAC,CAAC,CAAC,CASrB;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAEpE;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,CAAC,EACrB,KAAK,EAAE,OAAO,EACd,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,GACxB,KAAK,IAAI,CAAC,CAEZ;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EACjC,GAAG,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,GAChC,gBAAgB,CAAC,CAAC,CAAC,CAqBrB;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,EAAE,EAAE,EAAE,EACzC,CAAC,EAAE,gBAAgB,CAAC,EAAE,CAAC,EACvB,CAAC,EAAE,gBAAgB,CAAC,EAAE,CAAC,GACtB,gBAAgB,CAAC,EAAE,GAAG,EAAE,CAAC,CAW3B;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,EAAE,EAAE,EAAE,EAC3C,CAAC,EAAE,gBAAgB,CAAC,EAAE,CAAC,EACvB,CAAC,EAAE,gBAAgB,CAAC,EAAE,CAAC,GACtB,gBAAgB,CAAC,EAAE,GAAG,EAAE,CAAC,CAkB3B;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EACnC,GAAG,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,GAChC,gBAAgB,CAAC,CAAC,CAAC,CAiBrB;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,CAAC,EACzB,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EACrB,YAAY,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,MAAM,EAAE,GACzC,eAAe,CAAC,CAAC,CAAC,CAcpB;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,EAAE,SAAS,CAAC,GAAG,CAAC,EAC5C,cAAc,EAAE,eAAe,CAAC,CAAC,CAAC,EAClC,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,KAAK,IAAI,EAAE,EAChC,YAAY,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,MAAM,EAAE,GACnC,eAAe,CAAC,EAAE,CAAC,CAWrB;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,EAAE,EAAE,EAAE,EAC3B,CAAC,EAAE,eAAe,CAAC,EAAE,CAAC,EACtB,CAAC,EAAE,eAAe,CAAC,EAAE,CAAC,GACrB,eAAe,CAAC,EAAE,GAAG,EAAE,CAAC,CAM1B;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,GAAG,eAAe,CAAC,CAAC,CAAC,CAIzE;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,EAAE,EAAE,EAAE,EAC5B,CAAC,EAAE,eAAe,CAAC,EAAE,CAAC,EACtB,CAAC,EAAE,eAAe,CAAC,EAAE,CAAC,GACrB,eAAe,CAAC,EAAE,GAAG,EAAE,CAAC,CAY1B;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,EACvC,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,GACxB,eAAe,CAAC,CAAC,CAAC,CAuBpB;AAED;;GAEG;AACH,eAAO,MAAM,QAAQ,yBAAoD,CAAC;AAE1E;;GAEG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,MAAM,EAAE,OAAO,OAAO,wBACI,CAAC;AAE9D;;GAEG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,MAAM,EAAE,gBAAgB,CAAC,uBAG7D,CAAC;AAEL;;GAEG;AACH,eAAO,MAAM,MAAM,0BAAmD,CAAC;AAEvE;;GAEG;AACH,eAAO,MAAM,OAAO,yBAElB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,KAAK,yBAAmD,CAAC;AAEtE;;GAEG;AACH,eAAO,MAAM,MAAM,uBAA8C,CAAC;AAElE;;GAEG;AACH,eAAO,MAAM,WAAW,4BAEtB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,QAAQ,yBAAqD,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,QAAQ,0BAAsC,CAAC;AAE5D;;GAEG;AACH,eAAO,MAAM,OAAO,0BAAmD,CAAC;AAExE;;GAEG;AACH,eAAO,MAAM,gBAAgB,yBAI5B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gBAAgB,GAAI,QAAQ,MAAM,4BAO5C,CAAC;AAEJ;;GAEG;AACH,eAAO,MAAM,mBAAmB,GAAI,SAAS,MAAM,4BAKhD,CAAC;AAEJ;;GAEG;AACH,eAAO,MAAM,gBAAgB,GAAI,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE,OAAO,eAAe,CAAC,CAAC,CAAC,uBAKzE,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,wBAAwB,GAAI,KAAK,MAAM,EAAE,KAAK,MAAM,4BAK9D,CAAC;AAEJ;;GAEG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,EAAE,OAAO,eAAe,CAAC,CAAC,CAAC,uBAC7B,CAAC;AACzB,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,MAAM,EAAE,aAAa,CAAC,EAAE,uBAK7D,CAAC;AAEJ;;GAEG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EACjE,GAAG,EAAE,CAAC,GACL,eAAe,CAAC,CAAC,CAAC,CAMpB;AAED;;GAEG;AACH,wBAAgB,4BAA4B,CAC1C,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,CAAC,EACjB,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAe1D;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EAClE,IAAI,EAAE,CAAC,EAAE,GACR,eAAe,CAAC,CAAC,CAAC,CAEpB;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAC3C,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,CAAC,EACjB,MAAM,EAAE;KACP,CAAC,IAAI,MAAM,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACtC,GAAG,eAAe,CAAC,CAAC,CAAC,CAOrB;AAED;;GAEG;AACH,wBAAgB,gCAAgC,CAC9C,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,CAAC,EACjB,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAQlD"}

package/dist/error-aware-guard/index.js

@@ -0,0 +1,313 @@
+/**
+ * Provides easily composable generic type guards that track errors
+ * @module error-aware-guard
+ */
+import * as Guard from "@kaumlaut/pure/guard";
+/**
+ * Creates an ErrorResult with the given errors
+ */
+export function fail(...errors) {
+    return {
+        success: false,
+        errors: [...errors],
+    };
+}
+/**
+ * Creates an SuccessResult<T> with the given value
+ */
+export function pass(value) {
+    return {
+        success: true,
+        value,
+    };
+}
+/**
+ * Takes a ValidationResult<T> and if it is an ErrorResult, prefixes every error with the given prefix.
+ */
+export function prefixErrors(value, prefix) {
+    if (value.success === true) {
+        return value;
+    }
+    return {
+        success: false,
+        errors: value.errors.map((it) => `${prefix}${it}`),
+    };
+}
+/**
+ * Converts an ErrorAwareGuard<T> to a Guard<T>
+ */
+export function toGuard(guard) {
+    return (value) => guard(value).success;
+}
+/**
+ * Evaluates an ErrorAwareGuard<T> for given value
+ */
+export function check(value, guard) {
+    return guard(value).success;
+}
+/**
+ * Combines a list of results. Returning a SuccessResult<T> if all of them are SucessResult<T>
+ * or returns an ErrorResult with combined errors if any of them are ErrorResult.
+ */
+export function combineResultsAll(...results) {
+    const successResult = results.find((it) => it.success);
+    if (successResult &&
+        successResult.success &&
+        results.every((it) => it.success)) {
+        return pass(successResult.value);
+    }
+    return fail(...results.reduce((all, result) => [
+        ...all,
+        ...(result.success === true ? [] : result.errors),
+    ], []));
+}
+/**
+ * Combines two results. Returning a SuccessResult<T> if both of them are SucessResult<T>
+ * or returns an ErrorResult with combined errors if one is an ErrorResult.
+ */
+export function combineTwoResultsAnd(a, b) {
+    if (a.success === true && b.success === true) {
+        return a;
+    }
+    return fail(...[a, b].reduce((all, result) => [...all, ...result.errors], []));
+}
+/**
+ * Combines two results. Returning a SuccessResult<T> if either of them are SucessResult<T>
+ * or returns an ErrorResult with combined errors if both are an ErrorResult.
+ */
+export function combineTwoResultsOneOf(a, b) {
+    if (a.success === true) {
+        return a;
+    }
+    if (b.success === true) {
+        return b;
+    }
+    return fail(...[a, b].reduce((all, result) => [
+        ...all,
+        ...(result.success === true ? [] : result.errors),
+    ], []));
+}
+/**
+ * Combines a list of results. Returning a SuccessResult<T> if either of them are SucessResult<T>
+ * or returns an ErrorResult with combined errors if all are an ErrorResult.
+ */
+export function combineResultsOneOf(...results) {
+    const successResult = results.find((it) => it.success);
+    if (successResult.success) {
+        return pass(successResult.value);
+    }
+    return fail(...results.reduce((all, result) => [
+        ...all,
+        ...(result.success === true ? [] : result.errors),
+    ], []));
+}
+/**
+ * Converts a Guard<T> to an ErrorAwareGuard<T> with provided error factory function
+ */
+export function fromGuard(guard, createErrors) {
+    return (value) => {
+        if (guard(value)) {
+            return {
+                success: true,
+                value,
+            };
+        }
+        return {
+            success: false,
+            errors: createErrors(value),
+        };
+    };
+}
+/**
+ * First applies the predicateGuard and if it is a SuccessResult<T> passes the value to check.
+ * If check returns true it creates SuccessResult<T>.
+ * Otherwise an ErrorResult is created, containing the errors created by the error factory function.
+ */
+export function tryGuardIf(predicateGuard, check, createErrors) {
+    return (value) => {
+        const predicateResult = predicateGuard(value);
+        if (predicateResult.success === true) {
+            if (check(predicateResult.value)) {
+                return pass(predicateResult.value);
+            }
+            return fail(...createErrors(predicateResult.value));
+        }
+        return predicateResult;
+    };
+}
+/**
+ * Confirms that the given value passes both guards.
+ */
+export function isBoth(a, b) {
+    return (value) => {
+        const resultA = a(value);
+        const resultB = b(value);
+        return combineTwoResultsAnd(resultA, resultB);
+    };
+}
+/**
+ * Confirms that the given value passes all guards.
+ */
+export function isAll(guards) {
+    return (value) => {
+        return combineResultsAll(...guards.map((it) => it(value)));
+    };
+}
+/**
+ * Confirms the value passes at least one of the given Guards.
+ */
+export function isOneOf(a, b) {
+    return (value) => {
+        const resultA = prefixErrors(a(value), "(A) ");
+        const resultB = prefixErrors(b(value), "(B) ");
+        const combinedResult = combineTwoResultsOneOf(resultA, resultB);
+        if (combinedResult.success === true) {
+            return pass(combinedResult.value);
+        }
+        return fail("Neither A nor B passed", ...combinedResult.errors);
+    };
+}
+/**
+ * Confirms the value is a list of items that all pass the given guard.
+ */
+export function isListOf(guard) {
+    return (value) => {
+        if (!Array.isArray(value)) {
+            return fail("Not a list");
+        }
+        if (value.length === 0) {
+            return pass([]);
+        }
+        const results = value.map((value, index) => prefixErrors(guard(value), `[${index}] `));
+        if (results.every((it) => it.success)) {
+            return pass(value);
+        }
+        return combineResultsAll(fail("Not all items passed the Guard"), ...results.filter((it) => !it.success));
+    };
+}
+/**
+ * Confirms that the value is a number.
+ */
+export const isNumber = fromGuard(Guard.isNumber, () => ["Not a number"]);
+/**
+ * Confirms that the value is a string.
+ */
+export const isString = (value) => fromGuard((Guard.isString), () => ["Not a string"])(value);
+/**
+ * Confirms that the value is an exact string.
+ */
+export const isExactString = (expectedString) => tryGuardIf((isString), Guard.isExactString(expectedString), () => [
+    `Not the exact string "${expectedString}"`,
+]);
+/**
+ * Confirms that the value is a boolean.
+ */
+export const isBool = fromGuard(Guard.isBool, () => ["Not a boolean"]);
+/**
+ * Confirms that the value is a float.
+ */
+export const isFloat = fromGuard(Guard.isFloat, () => [
+    "Not a floating point number",
+]);
+/**
+ * Confirms that the value is an interger.
+ */
+export const isInt = fromGuard(Guard.isInt, () => ["Not an integer"]);
+/**
+ * Confirms that the value is null.
+ */
+export const isNull = fromGuard(Guard.isNull, () => ["Not null"]);
+/**
+ * Confirms that the value is undefined.
+ */
+export const isUndefined = fromGuard(Guard.isUndefined, () => [
+    "Not undefined",
+]);
+/**
+ * Confirms that the value is an object.
+ */
+export const isObject = fromGuard(Guard.isObject, () => ["Not an object"]);
+/**
+ * Always passes.
+ */
+export const isAlways = fromGuard(Guard.isAlways, () => []);
+/**
+ * Never passes.
+ */
+export const isNever = fromGuard(Guard.isNever, () => ["Never passes"]);
+/**
+ * Confirms that the value is a non-empty string.
+ */
+export const isNonEmptyString = tryGuardIf(isString, (value) => value.length > 0, () => ["Is empty"]);
+/**
+ * Confirms that the value is a string with specified length.
+ */
+export const isStringOfLength = (length) => tryGuardIf(isString, (value) => value.length === length, (value) => [
+    `String length was ${value.length} instead of expected ${length}`,
+]);
+/**
+ * Confirms the value is a string and matches the given regular expression.
+ */
+export const isStringWithPattern = (pattern) => tryGuardIf(isString, (value) => pattern.test(value), (value) => [`String ${value} did not match pattern ${pattern.source}`]);
+/**
+ * Confirms the value is a list with atleast one item and all items match the given guard.
+ */
+export const isNonEmptyListOf = (guard) => tryGuardIf(isListOf(guard), (value) => value.length > 0, () => ["Not enough items"]);
+/**
+ * Confirms the value is number between min and max inclusive.
+ * Meaning if the value equals min or max the guard passes.
+ */
+export const isNumberBetweenInclusive = (min, max) => tryGuardIf(isNumber, (value) => value >= min && value <= max, (value) => [`${value} is not between ${min} and ${max} (inclusively)`]);
+/**
+ * Confirms the value is either null or passes the given Guard.
+ */
+export const isNullOr = (guard) => isOneOf(isNull, guard);
+export const isOneStringOf = (validValues) => tryGuardIf((isString), (value) => validValues.includes(value), (value) => [`String ${value} is not one of ${validValues.join("|")}`]);
+/**
+ * Confirms that the value is an object containing the specified key.
+ */
+export function isObjectWithKey(key) {
+    return tryGuardIf(isObject, (value) => key in value, () => [`Object does not have key ${key.toString()}`]);
+}
+/**
+ * Confirms that the value is an object containing the specified key the value matching the given guard.
+ */
+export function isObjectWithKeyMatchingGuard(key, guard) {
+    return (value) => {
+        const isObjectWithKeyResult = isObjectWithKey(key)(value);
+        if (isObjectWithKeyResult.success === false) {
+            return isObjectWithKeyResult;
+        }
+        const keyValueResult = guard(value[key]);
+        if (keyValueResult.success === true) {
+            return pass(isObjectWithKeyResult.value);
+        }
+        return prefixErrors(keyValueResult, `[${key.toString()}] `);
+    };
+}
+/**
+ * Confirms that the value is an object containing the specified keys.
+ */
+export function isObjectWithKeys(keys) {
+    return isAll(keys.map((isObjectWithKey)));
+}
+/**
+ * Confirms that the value is an object whose key value pairs match the corresponding type guards.
+ */
+export function isObjectWithKeysMatchingGuard(guards) {
+    return isAll(
+    // @ts-expect-error not error just a bad type system
+    Object.entries(guards).map(([key, guard]) => {
+        return isObjectWithKeyMatchingGuard(key, guard);
+    }));
+}
+/**
+ * Confirms the value is an object where every value matches the given guard.
+ */
+export function isObjectWithAllKeysMatchingGuard(guard) {
+    return (value) => isAll(
+    // @ts-expect-error not error just a bad type system
+    Object.keys(value).map((key) => {
+        return isObjectWithKeyMatchingGuard(key, guard);
+    }))(value);
+}

package/dist/fetch-state/index.d.ts

@@ -2,12 +2,13 @@
  * Provides types and functions to represent fetch request states
  * @module fetch-state
  */
-import { type Guard } from "@kaumlaut/pure/guard";
+import * as Guard from "@kaumlaut/pure/guard";
+import * as ErrorAwareGuard from "@kaumlaut/pure/error-aware-guard";
 /**
  * Represents a failed fetch request
  */
 export type Failed = {
-    error: Readonly<string>;
+    errors: Readonly<string[]>;
     type: "Failed";
 };
 /**
@@ -52,7 +53,7 @@ export declare function isSuccess<T>(state: FetchState<T>): state is Success<T>;
 /**
  * Creates a fetch state of type Failed
  */
-export declare function fail(error: string): Failed;
+export declare function fail(first: string, ...errors: string[]): Failed;
 /**
  * Creates a fetch state of type Loading
  */
@@ -72,7 +73,19 @@ if(isSuccess(value)){
   console.error(value.error)
 }
  */
-export declare function attempt<T>(guard: Guard<T>, error?: string): (data: unknown) => Success<T> | Failed;
+export declare function attempt<T>(guard: Guard.Guard<T>, firstError?: string, ...errors: string[]): (data: unknown) => Success<T> | Failed;
+/**
+ * Attempts to create a fetch state of type Success if the given guard passes.
+ * Otherwise creates a fetch state of type Failed with the errors from the ErrorAwareGuard.
+ * @example
+const value = attemptErrorAware(isString)(3);
+if(isSuccess(value)){
+  console.log(value.data)
+} else if (isFailed(value)){
+  console.error(value.error)
+}
+ */
+export declare function attemptErrorAware<T>(guard: ErrorAwareGuard.ErrorAwareGuard<T>): (data: unknown) => Success<T> | Failed;
 /**
  * A Utility function that allows to map the Failed fetch state to any other fetch state.
  * The mapper function is only called if the given fetch state is Failed.

package/dist/fetch-state/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fetch-state/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IACxB,IAAI,EAAE,QAAQ,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,SAAS,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI;IACvB,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAClB,IAAI,EAAE,SAAS,CAAC;CACjB,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AACjE;;GAEG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,OAAO,CAEnE;AACD;;GAEG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,MAAM,CAEjE;AACD;;GAEG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,IAAI,CAE7D;AACD;;GAEG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,OAAO,CAAC,CAAC,CAAC,CAEtE;AACD;;GAEG;AACH,wBAAgB,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAK1C;AACD;;GAEG;AACH,wBAAgB,IAAI,IAAI,OAAO,CAI9B;AACD;;GAEG;AACH,wBAAgB,IAAI,IAAI,IAAI,CAI3B;AACD;;;;;;;;;;GAUG;AACH,wBAAgB,OAAO,CAAC,CAAC,EACvB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EACf,KAAK,GAAE,MAA6E,GACnF,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAcxC;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,CAAC,EACzB,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,GACvC,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,CAQzC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fetch-state/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,KAAK,MAAM,sBAAsB,CAAC;AAC9C,OAAO,KAAK,eAAe,MAAM,kCAAkC,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAC3B,IAAI,EAAE,QAAQ,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,SAAS,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI;IACvB,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAClB,IAAI,EAAE,SAAS,CAAC;CACjB,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AACjE;;GAEG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,OAAO,CAEnE;AACD;;GAEG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,MAAM,CAEjE;AACD;;GAEG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,IAAI,CAE7D;AACD;;GAEG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,OAAO,CAAC,CAAC,CAAC,CAEtE;AACD;;GAEG;AACH,wBAAgB,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAK/D;AACD;;GAEG;AACH,wBAAgB,IAAI,IAAI,OAAO,CAI9B;AACD;;GAEG;AACH,wBAAgB,IAAI,IAAI,IAAI,CAI3B;AACD;;;;;;;;;;GAUG;AACH,wBAAgB,OAAO,CAAC,CAAC,EACvB,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EACrB,UAAU,GAAE,MAA6E,EACzF,GAAG,MAAM,EAAE,MAAM,EAAE,GAClB,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAcxC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EACjC,KAAK,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC,CAAC,GACxC,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAexC;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,CAAC,EACzB,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,GACvC,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,CAQzC"}

package/dist/fetch-state/index.js

@@ -25,10 +25,10 @@ export function isSuccess(state) {
 /**
  * Creates a fetch state of type Failed
  */
-export function fail(error) {
+export function fail(first, ...errors) {
     return {
         type: "Failed",
-        error,
+        errors: [first, ...errors],
     };
 }
 /**
@@ -58,7 +58,7 @@ if(isSuccess(value)){
   console.error(value.error)
 }
  */
-export function attempt(guard, error = "Guard did not pass. Ensure the attempted data has the correct type") {
+export function attempt(guard, firstError = "Guard did not pass. Ensure the attempted data has the correct type", ...errors) {
     return (data) => {
         if (guard(data)) {
             return {
@@ -68,7 +68,33 @@ export function attempt(guard, error = "Guard did not pass. Ensure the attempted
         }
         return {
             type: "Failed",
-            error,
+            errors: [firstError, ...errors],
+        };
+    };
+}
+/**
+ * Attempts to create a fetch state of type Success if the given guard passes.
+ * Otherwise creates a fetch state of type Failed with the errors from the ErrorAwareGuard.
+ * @example
+const value = attemptErrorAware(isString)(3);
+if(isSuccess(value)){
+  console.log(value.data)
+} else if (isFailed(value)){
+  console.error(value.error)
+}
+ */
+export function attemptErrorAware(guard) {
+    return (data) => {
+        const result = guard(data);
+        if (result.success === true) {
+            return {
+                type: "Success",
+                data: result.value,
+            };
+        }
+        return {
+            type: "Failed",
+            errors: result.errors,
         };
     };
 }

package/dist/guard/index.d.ts

@@ -6,14 +6,26 @@ export type Guard<T> = (value: unknown) => value is T;
  * Confirms that the given value passes all guards.
  */
 export declare function isAll<T>(guards: Guard<T>[]): (value: unknown) => value is T;
+/**
+ * Confirms that the given value passes both guards.
+ */
+export declare function isBoth<T>(a: Guard<T>, b: Guard<T>): (value: unknown) => value is T;
 /**
  * Confirms that the value is a string.
  */
-export declare function isString(value: unknown): value is string;
+export declare function isString<T extends string>(value: unknown): value is T;
+/**
+ * Confirms that the value is a non-empty string.
+ */
+export declare function isNonEmptyString(value: unknown): value is string;
 /**
  * Confirms that the value is a string with specified length.
  */
 export declare function isStringOfLength(length: number): (value: unknown) => value is string;
+/**
+ * Confirms that the value is an object.
+ */
+export declare function isObject(value: unknown): value is object;
 /**
  * Confirms that the value is a number.
  */