@oscarpalmer/atoms 0.147.0 → 0.149.0

package/dist/atoms.full.js

@@ -954,6 +954,29 @@ const DEFAULT_CACHE_SIZE = 1024;
 function throttle(callback, time) {
 	return getLimiter(callback, true, time);
 }
+function _isResult(value, okValue) {
+	if (!isPlainObject(value)) return false;
+	return value.ok === okValue && (okValue ? "value" : "error") in value;
+}
+function isError(value, extended) {
+	return _isResult(value, false) && (extended === true ? value.original instanceof Error : true);
+}
+/**
+* Is the result ok?
+* @param result Result to check
+* @returns `true` if the result is ok, `false` otherwise
+*/
+function isOk(value) {
+	return _isResult(value, true);
+}
+/**
+* Is the value a result?
+* @param value Value to check
+* @returns `true` if the value is a result, `false` otherwise
+*/
+function isResult(value) {
+	return _isResult(value, true) || _isResult(value, false);
+}
 function assert(condition, message, error) {
 	if (!condition()) throw new (error ?? Error)(message);
 }
@@ -974,11 +997,17 @@ assert.is = (condition, message, error) => {
 };
 function asyncFlow(...fns) {
 	assertFlowFunctions(fns);
-	return (...args) => asyncWork(args, fns, true);
+	return (...args) => asyncWork(args.map((value) => {
+		if (isError(value)) throw value.error;
+		return isOk(value) ? value.value : value;
+	}), fns, true);
 }
 function flow(...fns) {
 	assertFlowFunctions(fns);
-	return (...args) => work(args, fns, true);
+	return (...args) => work(args.map((value) => {
+		if (isError(value)) throw value.error;
+		return isOk(value) ? value.value : value;
+	}), fns, true);
 }
 flow.async = asyncFlow;
 async function asyncPipe(value, ...pipes) {
@@ -992,26 +1021,38 @@ function pipe(value, ...pipes) {
 pipe.async = asyncPipe;
 async function asyncWork(initial, functions, flow) {
 	const { length } = functions;
-	let transformed = initial;
+	let transformed = unwrapValue(initial);
 	for (let index = 0; index < length; index += 1) {
 		const fn = functions[index];
-		transformed = flow && index === 0 && Array.isArray(initial) ? await fn(...initial) : await fn(transformed);
+		transformed = unwrapValue(flow && index === 0 && Array.isArray(initial) ? await fn(...initial) : await fn(transformed));
 	}
 	return transformed;
 }
+function unwrapValue(value, flow, nested) {
+	if (typeof value === "function") {
+		if (nested != null) throw new TypeError(MESSAGE_NESTING);
+		return unwrapValue(value(), flow, true);
+	}
+	if (flow != null && value instanceof Promise) throw new TypeError(flow ? MESSAGE_FLOW_PROMISE : MESSAGE_PIPE_PROMISE);
+	if (isError(value)) throw value.error;
+	return isOk(value) ? value.value : value;
+}
 function work(initial, functions, flow) {
 	const { length } = functions;
-	let transformed = initial;
+	let transformed = unwrapValue(initial, flow);
 	for (let index = 0; index < length; index += 1) {
 		const fn = functions[index];
-		transformed = flow && index === 0 && Array.isArray(initial) ? fn(...initial) : fn(transformed);
+		transformed = unwrapValue(flow && index === 0 && Array.isArray(initial) ? fn(...initial) : fn(transformed), flow);
 	}
 	return transformed;
 }
-const MESSAGE_FLOW = "Flow expected to receive an array of functions";
-const MESSAGE_PIPE = "Pipe expected to receive an array of functions";
-const assertFlowFunctions = assert.condition((value) => Array.isArray(value) && value.every((item) => typeof item === "function"), MESSAGE_FLOW, TypeError);
-const assertPipeFunctions = assert.condition((value) => Array.isArray(value) && value.every((item) => typeof item === "function"), MESSAGE_PIPE, TypeError);
+const MESSAGE_FLOW_ARRAY = "Flow expected to receive an array of functions";
+const MESSAGE_FLOW_PROMISE = "Synchronous Flow received a promise. Use `flow.async` instead.";
+const MESSAGE_NESTING = "Return values are too deeply nested.";
+const MESSAGE_PIPE_ARRAY = "Pipe expected to receive an array of functions";
+const MESSAGE_PIPE_PROMISE = "Synchronous Pipe received a promise. Use `pipe.async` instead.";
+const assertFlowFunctions = assert.condition((value) => Array.isArray(value) && value.every((item) => typeof item === "function"), MESSAGE_FLOW_ARRAY, TypeError);
+const assertPipeFunctions = assert.condition((value) => Array.isArray(value) && value.every((item) => typeof item === "function"), MESSAGE_PIPE_ARRAY, TypeError);
 /**
 * A function that does nothing, which can be useful, I guess…
 */
@@ -3495,10 +3536,67 @@ const ALPHABET = "abcdefghijklmnopqrstuvwxyz";
 const BOOLEAN_MODIFIER = .5;
 const HEX_CHARACTERS = "0123456789ABCDEF";
 const HEX_MAXIMUM = 15;
-function _isResult(value, okValue) {
-	if (!isPlainObject(value)) return false;
-	return value.ok === okValue && (okValue ? "value" : "error") in value;
+async function asyncMatchResult(result, first, error) {
+	let value;
+	if (typeof result === "function") value = await result();
+	else if (result instanceof Promise) value = await result;
+	else value = result;
+	if (!isResult(value)) throw new Error(MESSAGE_RESULT);
+	const hasObj = typeof first === "object" && first !== null;
+	const okHandler = hasObj ? first.ok : first;
+	const errorHandler = hasObj ? first.error : error;
+	if (isOk(value)) return okHandler(value.value);
+	return errorHandler(value.error, value.original);
+}
+function matchResult(result, first, error) {
+	const value = typeof result === "function" ? result() : result;
+	if (!isResult(value)) throw new Error(MESSAGE_RESULT);
+	const hasObj = typeof first === "object" && first !== null;
+	const okHandler = hasObj ? first.ok : first;
+	const errorHandler = hasObj ? first.error : error;
+	if (isOk(value)) return okHandler(value.value);
+	return errorHandler(value.error, value.original);
+}
+matchResult.async = asyncMatchResult;
+const MESSAGE_RESULT = "`result.match` expected a Result or a function that returns a Result";
+function attemptAsyncFlow(...fns) {
+	let Flow;
+	return (...args) => attempt.async(() => {
+		Flow ??= flow.async(...fns);
+		return Flow(...args.map((value) => {
+			if (isError(value)) throw value.error;
+			return isOk(value) ? value.value : value;
+		}));
+	});
+}
+function attemptFlow(...fns) {
+	let Flow;
+	return (...args) => attempt(() => {
+		Flow ??= flow(...fns);
+		return Flow(...args.map((value) => {
+			if (isError(value)) throw value.error;
+			return isOk(value) ? value.value : value;
+		}));
+	});
+}
+attemptFlow.async = attemptAsyncFlow;
+async function attemptAsyncPipe(initial, first, ...seconds) {
+	return attempt.async(() => {
+		if (isError(initial)) throw initial.error;
+		const value = typeof initial === "function" ? initial() : isOk(initial) ? initial.value : initial;
+		if (first == null) return value;
+		return pipe.async(value, ...[first, ...seconds]);
+	});
 }
+function attemptPipe(initial, first, ...seconds) {
+	return attempt(() => {
+		if (isError(initial)) throw initial.error;
+		const value = typeof initial === "function" ? initial() : isOk(initial) ? initial.value : initial;
+		if (first == null) return value;
+		return pipe(value, ...[first, ...seconds]);
+	});
+}
+attemptPipe.async = attemptAsyncPipe;
 async function asyncAttempt(value, err) {
 	try {
 		let result = typeof value === "function" ? value() : await value;
@@ -3516,6 +3614,9 @@ function attempt(callback, err) {
 	}
 }
 attempt.async = asyncAttempt;
+attempt.flow = attemptFlow;
+attempt.match = matchResult;
+attempt.pipe = attemptPipe;
 attempt.promise = attemptPromise;
 function error(value, original) {
 	return getError(value, original);
@@ -3528,25 +3629,6 @@ function getError(value, original) {
 	if (original instanceof Error) errorResult.original = original;
 	return errorResult;
 }
-function isError(value, extended) {
-	return _isResult(value, false) && (extended === true ? value.original instanceof Error : true);
-}
-/**
-* Is the result ok?
-* @param result Result to check
-* @returns `true` if the result is ok, `false` otherwise
-*/
-function isOk(value) {
-	return _isResult(value, true);
-}
-/**
-* Is the value a result?
-* @param value Value to check
-* @returns `true` if the value is a result, `false` otherwise
-*/
-function isResult(value) {
-	return _isResult(value, true) || _isResult(value, false);
-}
 /**
 * Creates an ok result
 * @param value Value

package/dist/function/work.js

@@ -1,11 +1,18 @@
 import { assert } from "./assert.js";
+import { isError, isOk } from "../internal/result.js";
 function asyncFlow(...fns) {
 	assertFlowFunctions(fns);
-	return (...args) => asyncWork(args, fns, true);
+	return (...args) => asyncWork(args.map((value) => {
+		if (isError(value)) throw value.error;
+		return isOk(value) ? value.value : value;
+	}), fns, true);
 }
 function flow(...fns) {
 	assertFlowFunctions(fns);
-	return (...args) => work(args, fns, true);
+	return (...args) => work(args.map((value) => {
+		if (isError(value)) throw value.error;
+		return isOk(value) ? value.value : value;
+	}), fns, true);
 }
 flow.async = asyncFlow;
 async function asyncPipe(value, ...pipes) {
@@ -19,24 +26,36 @@ function pipe(value, ...pipes) {
 pipe.async = asyncPipe;
 async function asyncWork(initial, functions, flow) {
 	const { length } = functions;
-	let transformed = initial;
+	let transformed = unwrapValue(initial);
 	for (let index = 0; index < length; index += 1) {
 		const fn = functions[index];
-		transformed = flow && index === 0 && Array.isArray(initial) ? await fn(...initial) : await fn(transformed);
+		transformed = unwrapValue(flow && index === 0 && Array.isArray(initial) ? await fn(...initial) : await fn(transformed));
 	}
 	return transformed;
 }
+function unwrapValue(value, flow, nested) {
+	if (typeof value === "function") {
+		if (nested != null) throw new TypeError(MESSAGE_NESTING);
+		return unwrapValue(value(), flow, true);
+	}
+	if (flow != null && value instanceof Promise) throw new TypeError(flow ? MESSAGE_FLOW_PROMISE : MESSAGE_PIPE_PROMISE);
+	if (isError(value)) throw value.error;
+	return isOk(value) ? value.value : value;
+}
 function work(initial, functions, flow) {
 	const { length } = functions;
-	let transformed = initial;
+	let transformed = unwrapValue(initial, flow);
 	for (let index = 0; index < length; index += 1) {
 		const fn = functions[index];
-		transformed = flow && index === 0 && Array.isArray(initial) ? fn(...initial) : fn(transformed);
+		transformed = unwrapValue(flow && index === 0 && Array.isArray(initial) ? fn(...initial) : fn(transformed), flow);
 	}
 	return transformed;
 }
-var MESSAGE_FLOW = "Flow expected to receive an array of functions";
-var MESSAGE_PIPE = "Pipe expected to receive an array of functions";
-var assertFlowFunctions = assert.condition((value) => Array.isArray(value) && value.every((item) => typeof item === "function"), MESSAGE_FLOW, TypeError);
-var assertPipeFunctions = assert.condition((value) => Array.isArray(value) && value.every((item) => typeof item === "function"), MESSAGE_PIPE, TypeError);
+var MESSAGE_FLOW_ARRAY = "Flow expected to receive an array of functions";
+var MESSAGE_FLOW_PROMISE = "Synchronous Flow received a promise. Use `flow.async` instead.";
+var MESSAGE_NESTING = "Return values are too deeply nested.";
+var MESSAGE_PIPE_ARRAY = "Pipe expected to receive an array of functions";
+var MESSAGE_PIPE_PROMISE = "Synchronous Pipe received a promise. Use `pipe.async` instead.";
+var assertFlowFunctions = assert.condition((value) => Array.isArray(value) && value.every((item) => typeof item === "function"), MESSAGE_FLOW_ARRAY, TypeError);
+var assertPipeFunctions = assert.condition((value) => Array.isArray(value) && value.every((item) => typeof item === "function"), MESSAGE_PIPE_ARRAY, TypeError);
 export { flow, pipe };

package/dist/index.js

@@ -41,6 +41,7 @@ import { debounce } from "./function/debounce.js";
 import { SizedMap } from "./sized/map.js";
 import { memoize } from "./function/memoize.js";
 import { throttle } from "./function/throttle.js";
+import { isError, isOk, isResult } from "./internal/result.js";
 import { flow, pipe } from "./function/work.js";
 import { equal } from "./internal/value/equal.js";
 import { getValue } from "./internal/value/get.js";
@@ -63,6 +64,6 @@ import { CancelablePromise, PromiseTimeoutError, attemptPromise, cancelable, del
 import { fromQuery, toQuery } from "./query.js";
 import { QueueError, queue } from "./queue.js";
 import { getRandomBoolean, getRandomCharacters, getRandomColor, getRandomHex, getRandomItem, getRandomItems } from "./random.js";
-import { attempt, error, isError, isOk, isResult, ok, unwrap } from "./result.js";
+import { attempt, error, ok, unwrap } from "./result/index.js";
 import { SizedSet } from "./sized/set.js";
 export { CancelablePromise, frame_rate_default as FRAME_RATE_MS, PromiseTimeoutError, QueueError, SizedMap, SizedSet, attempt, attemptPromise, average, beacon, between, camelCase, cancelable, capitalize, ceil, chunk, clamp, clone, compact, compare, count, debounce, delay, diff, endsWith, equal, error, exists, filter, find, flatten, floor, flow, fromQuery, getArray, getColor, getForegroundColor, getHexColor, getHexaColor, getHslColor, getHslaColor, getNormalizedHex, getNumber, getRandomBoolean, getRandomCharacters, getRandomColor, getRandomFloat, getRandomHex, getRandomInteger, getRandomItem, getRandomItems, getRgbColor, getRgbaColor, getString, getUuid, getValue, groupBy, hexToHsl, hexToHsla, hexToRgb, hexToRgba, hslToHex, hslToRgb, hslToRgba, ignoreKey, includes, indexOf, insert, isArrayOrPlainObject, isColor, isConstructor, isEmpty, isError, isFulfilled, isHexColor, isHslColor, isHslLike, isHslaColor, isInstanceOf, isKey, isNonNullable, isNullable, isNullableOrEmpty, isNullableOrWhitespace, isNumber, isNumerical, isObject, isOk, isPlainObject, isPrimitive, isRejected, isResult, isRgbColor, isRgbLike, isRgbaColor, isTypedArray, join, kebabCase, logger, lowerCase, max, median, memoize, merge, min, noop, ok, omit, parse, partition, pascalCase, pick, pipe, promises, push, queue, range, rgbToHex, rgbToHsl, rgbToHsla, round, select, setValue, shuffle, smush, snakeCase, sort, splice, startsWith, sum, template, throttle, timed, times, titleCase, toMap, toQuery, toRecord, toSet, toggle, trim, truncate, tryDecode, tryEncode, unique, unsmush, unwrap, update, upperCase, words };

package/dist/internal/result.js

@@ -0,0 +1,25 @@
+import { isPlainObject } from "./is.js";
+function _isResult(value, okValue) {
+	if (!isPlainObject(value)) return false;
+	return value.ok === okValue && (okValue ? "value" : "error") in value;
+}
+function isError(value, extended) {
+	return _isResult(value, false) && (extended === true ? value.original instanceof Error : true);
+}
+/**
+* Is the result ok?
+* @param result Result to check
+* @returns `true` if the result is ok, `false` otherwise
+*/
+function isOk(value) {
+	return _isResult(value, true);
+}
+/**
+* Is the value a result?
+* @param value Value to check
+* @returns `true` if the value is a result, `false` otherwise
+*/
+function isResult(value) {
+	return _isResult(value, true) || _isResult(value, false);
+}
+export { isError, isOk, isResult };

package/dist/{result.js → result/index.js}

@@ -1,9 +1,8 @@
-import { isPlainObject } from "./internal/is.js";
-import { attemptPromise } from "./promise.js";
-function _isResult(value, okValue) {
-	if (!isPlainObject(value)) return false;
-	return value.ok === okValue && (okValue ? "value" : "error") in value;
-}
+import { isError, isOk, isResult } from "../internal/result.js";
+import { attemptPromise } from "../promise.js";
+import { matchResult } from "./match.js";
+import { attemptFlow } from "./work/flow.js";
+import { attemptPipe } from "./work/pipe.js";
 async function asyncAttempt(value, err) {
 	try {
 		let result = typeof value === "function" ? value() : await value;
@@ -21,6 +20,9 @@ function attempt(callback, err) {
 	}
 }
 attempt.async = asyncAttempt;
+attempt.flow = attemptFlow;
+attempt.match = matchResult;
+attempt.pipe = attemptPipe;
 attempt.promise = attemptPromise;
 function error(value, original) {
 	return getError(value, original);
@@ -33,25 +35,6 @@ function getError(value, original) {
 	if (original instanceof Error) errorResult.original = original;
 	return errorResult;
 }
-function isError(value, extended) {
-	return _isResult(value, false) && (extended === true ? value.original instanceof Error : true);
-}
-/**
-* Is the result ok?
-* @param result Result to check
-* @returns `true` if the result is ok, `false` otherwise
-*/
-function isOk(value) {
-	return _isResult(value, true);
-}
-/**
-* Is the value a result?
-* @param value Value to check
-* @returns `true` if the value is a result, `false` otherwise
-*/
-function isResult(value) {
-	return _isResult(value, true) || _isResult(value, false);
-}
 /**
 * Creates an ok result
 * @param value Value

package/dist/result/match.js

@@ -0,0 +1,25 @@
+import { isOk, isResult } from "../internal/result.js";
+async function asyncMatchResult(result, first, error) {
+	let value;
+	if (typeof result === "function") value = await result();
+	else if (result instanceof Promise) value = await result;
+	else value = result;
+	if (!isResult(value)) throw new Error(MESSAGE_RESULT);
+	const hasObj = typeof first === "object" && first !== null;
+	const okHandler = hasObj ? first.ok : first;
+	const errorHandler = hasObj ? first.error : error;
+	if (isOk(value)) return okHandler(value.value);
+	return errorHandler(value.error, value.original);
+}
+function matchResult(result, first, error) {
+	const value = typeof result === "function" ? result() : result;
+	if (!isResult(value)) throw new Error(MESSAGE_RESULT);
+	const hasObj = typeof first === "object" && first !== null;
+	const okHandler = hasObj ? first.ok : first;
+	const errorHandler = hasObj ? first.error : error;
+	if (isOk(value)) return okHandler(value.value);
+	return errorHandler(value.error, value.original);
+}
+matchResult.async = asyncMatchResult;
+var MESSAGE_RESULT = "`result.match` expected a Result or a function that returns a Result";
+export { matchResult };

package/dist/result/work/flow.js

@@ -0,0 +1,25 @@
+import { isError, isOk } from "../../internal/result.js";
+import { flow } from "../../function/work.js";
+import { attempt } from "../index.js";
+function attemptAsyncFlow(...fns) {
+	let Flow;
+	return (...args) => attempt.async(() => {
+		Flow ??= flow.async(...fns);
+		return Flow(...args.map((value) => {
+			if (isError(value)) throw value.error;
+			return isOk(value) ? value.value : value;
+		}));
+	});
+}
+function attemptFlow(...fns) {
+	let Flow;
+	return (...args) => attempt(() => {
+		Flow ??= flow(...fns);
+		return Flow(...args.map((value) => {
+			if (isError(value)) throw value.error;
+			return isOk(value) ? value.value : value;
+		}));
+	});
+}
+attemptFlow.async = attemptAsyncFlow;
+export { attemptFlow };

package/dist/result/work/pipe.js

@@ -0,0 +1,21 @@
+import { isError, isOk } from "../../internal/result.js";
+import { pipe } from "../../function/work.js";
+import { attempt } from "../index.js";
+async function attemptAsyncPipe(initial, first, ...seconds) {
+	return attempt.async(() => {
+		if (isError(initial)) throw initial.error;
+		const value = typeof initial === "function" ? initial() : isOk(initial) ? initial.value : initial;
+		if (first == null) return value;
+		return pipe.async(value, ...[first, ...seconds]);
+	});
+}
+function attemptPipe(initial, first, ...seconds) {
+	return attempt(() => {
+		if (isError(initial)) throw initial.error;
+		const value = typeof initial === "function" ? initial() : isOk(initial) ? initial.value : initial;
+		if (first == null) return value;
+		return pipe(value, ...[first, ...seconds]);
+	});
+}
+attemptPipe.async = attemptAsyncPipe;
+export { attemptPipe };

package/package.json

@@ -110,8 +110,8 @@
 			"default": "./dist/random.js"
 		},
 		"./result": {
-			"types": "./types/result.d.ts",
-			"default": "./dist/result.js"
+			"types": "./types/result/index.d.ts",
+			"default": "./dist/result/index.js"
 		},
 		"./sized/map": {
 			"types": "./types/sized/map.d.ts",
@@ -192,5 +192,5 @@
 	},
 	"type": "module",
 	"types": "./types/index.d.ts",
-	"version": "0.147.0"
+	"version": "0.149.0"
 }