@oscarpalmer/atoms 0.208.0 → 0.209.0

package/dist/index.d.mts

@@ -4592,6 +4592,12 @@ export declare function setValue<Data extends PlainObject>(data: Data, path: str
  * An asynchronous plan of execution that can yield intermediate results and eventually return a result
  */
 type AsyncPlan<Value, Error = unknown> = {
+  /**
+   * Get the asynchronous generator for the plan
+   *
+   * @returns Asynchronous generator
+   */
+  [Symbol.asyncIterator]: () => AsyncGenerator<unknown, Value, unknown>;
   /**
    * Run the plan to completion
    *
@@ -4603,6 +4609,12 @@ type AsyncPlan<Value, Error = unknown> = {
  * A plan of execution that can yield intermediate results and eventually return a result
  */
 type Plan<Value, Error = unknown> = {
+  /**
+   * Get the generator for the plan
+   *
+   * @returns Generator
+   */
+  [Symbol.iterator]: () => Generator<unknown, Value, unknown>;
   /**
    * Run the plan to completion
    *

package/dist/index.mjs

@@ -2746,6 +2746,10 @@ function setValue(data, path, value, ignoreCase) {
 	return data;
 }
 const SET_EXPRESSION_INDEX = /^\d+$/;
+//#endregion
+//#region src/internal/models/plan.model.ts
+const GENERATOR_NAME_ASYNC = "AsyncGeneratorFunction";
+const GENERATOR_NAME_SYNC = "GeneratorFunction";
 const PLAN_MESSAGE_PLAN_INPUT = "plan requires a generator function";
 const PLAN_MESSAGE_RUN_INPUT = "run requires a plan or a generator function";
 const PLAN_SYMBOL = Symbol("plan");
@@ -2759,6 +2763,9 @@ function AsyncPlan(generator) {
 		type: PLAN_TYPE_PLAN_ASYNC
 	};
 }
+AsyncPlan.prototype[Symbol.asyncIterator] = function() {
+	return this[PLAN_SYMBOL].generator();
+};
 AsyncPlan.prototype.run = runAsyncPlan;
 function Plan(generator) {
 	this[PLAN_SYMBOL] = {
@@ -2766,6 +2773,9 @@ function Plan(generator) {
 		type: PLAN_TYPE_PLAN_SYNC
 	};
 }
+Plan.prototype[Symbol.iterator] = function() {
+	return this[PLAN_SYMBOL].generator();
+};
 Plan.prototype.run = runPlan;
 function asyncExecute(callback) {
 	return asyncAttempt(async () => {
@@ -2776,6 +2786,8 @@ function asyncExecute(callback) {
 			const { done } = next;
 			let value = next.value;
 			if (value instanceof Error) throw value;
+			if (isError(value)) throw value.error;
+			if (isOk(value)) value = value.value;
 			lastValue = value;
 			if (done === true) break;
 		}
@@ -2806,6 +2818,8 @@ function execute(callback) {
 			const { done } = next;
 			let { value } = next;
 			if (value instanceof Error) throw value;
+			if (isError(value)) throw value.error;
+			if (isOk(value)) value = value.value;
 			lastValue = value;
 			if (done === true) break;
 		}
@@ -2828,7 +2842,7 @@ function isAsyncPlan(value) {
 * @returns `true` if the value is an asynchronous generator function, otherwise `false`
 */
 function isAsyncGenerator(value) {
-	return typeof value === "function" && value.constructor.name === "AsyncGeneratorFunction" && typeof value.prototype.next === "function" && typeof value.prototype.return === "function" && typeof value.prototype.throw === "function";
+	return isGeneratorInstance(GENERATOR_NAME_ASYNC, value);
 }
 /**
 * Is the value a generator function?
@@ -2837,7 +2851,10 @@ function isAsyncGenerator(value) {
 * @returns `true` if the value is a generator function, otherwise `false`
 */
 function isGenerator(value) {
-	return typeof value === "function" && value.constructor.name === "GeneratorFunction" && typeof value.prototype.next === "function" && typeof value.prototype.return === "function" && typeof value.prototype.throw === "function";
+	return isGeneratorInstance(GENERATOR_NAME_SYNC, value);
+}
+function isGeneratorInstance(name, value) {
+	return typeof value === "function" && value !== null && value.constructor.name === name && typeof value.prototype.next === "function" && typeof value.prototype.return === "function" && typeof value.prototype.throw === "function";
 }
 /**
 * Is the value a plan?

package/dist/internal/models/plan.model.d.mts

@@ -4,6 +4,12 @@ import { Result } from "./result.model.mjs";
  * An asynchronous plan of execution that can yield intermediate results and eventually return a result
  */
 export type AsyncPlan<Value, Error = unknown> = {
+  /**
+   * Get the asynchronous generator for the plan
+   *
+   * @returns Asynchronous generator
+   */
+  [Symbol.asyncIterator]: () => AsyncGenerator<unknown, Value, unknown>;
   /**
    * Run the plan to completion
    *
@@ -27,6 +33,12 @@ export type InternalPlan = {
  * A plan of execution that can yield intermediate results and eventually return a result
  */
 export type Plan<Value, Error = unknown> = {
+  /**
+   * Get the generator for the plan
+   *
+   * @returns Generator
+   */
+  [Symbol.iterator]: () => Generator<unknown, Value, unknown>;
   /**
    * Run the plan to completion
    *

package/dist/plan/index.mjs

@@ -1,5 +1,7 @@
+import { isError, isOk } from "../internal/result/misc.mjs";
+import "../result/misc.mjs";
 import { asyncAttempt, attempt } from "../internal/result/attempt.mjs";
-import { PLAN_MESSAGE_PLAN_INPUT, PLAN_MESSAGE_RUN_INPUT, PLAN_SYMBOL, PLAN_TYPE_PLAN_ASYNC, PLAN_TYPE_PLAN_SYNC } from "../internal/models/plan.model.mjs";
+import { GENERATOR_NAME_ASYNC, GENERATOR_NAME_SYNC, PLAN_MESSAGE_PLAN_INPUT, PLAN_MESSAGE_RUN_INPUT, PLAN_SYMBOL, PLAN_TYPE_PLAN_ASYNC, PLAN_TYPE_PLAN_SYNC } from "../internal/models/plan.model.mjs";
 //#region src/plan/index.ts
 function AsyncPlan(generator) {
 	this[PLAN_SYMBOL] = {
@@ -7,6 +9,9 @@ function AsyncPlan(generator) {
 		type: PLAN_TYPE_PLAN_ASYNC
 	};
 }
+AsyncPlan.prototype[Symbol.asyncIterator] = function() {
+	return this[PLAN_SYMBOL].generator();
+};
 AsyncPlan.prototype.run = runAsyncPlan;
 function Plan(generator) {
 	this[PLAN_SYMBOL] = {
@@ -14,6 +19,9 @@ function Plan(generator) {
 		type: PLAN_TYPE_PLAN_SYNC
 	};
 }
+Plan.prototype[Symbol.iterator] = function() {
+	return this[PLAN_SYMBOL].generator();
+};
 Plan.prototype.run = runPlan;
 function asyncExecute(callback) {
 	return asyncAttempt(async () => {
@@ -24,6 +32,8 @@ function asyncExecute(callback) {
 			const { done } = next;
 			let value = next.value;
 			if (value instanceof Error) throw value;
+			if (isError(value)) throw value.error;
+			if (isOk(value)) value = value.value;
 			lastValue = value;
 			if (done === true) break;
 		}
@@ -54,6 +64,8 @@ function execute(callback) {
 			const { done } = next;
 			let { value } = next;
 			if (value instanceof Error) throw value;
+			if (isError(value)) throw value.error;
+			if (isOk(value)) value = value.value;
 			lastValue = value;
 			if (done === true) break;
 		}
@@ -76,7 +88,7 @@ function isAsyncPlan(value) {
 * @returns `true` if the value is an asynchronous generator function, otherwise `false`
 */
 function isAsyncGenerator(value) {
-	return typeof value === "function" && value.constructor.name === "AsyncGeneratorFunction" && typeof value.prototype.next === "function" && typeof value.prototype.return === "function" && typeof value.prototype.throw === "function";
+	return isGeneratorInstance(GENERATOR_NAME_ASYNC, value);
 }
 /**
 * Is the value a generator function?
@@ -85,7 +97,10 @@ function isAsyncGenerator(value) {
 * @returns `true` if the value is a generator function, otherwise `false`
 */
 function isGenerator(value) {
-	return typeof value === "function" && value.constructor.name === "GeneratorFunction" && typeof value.prototype.next === "function" && typeof value.prototype.return === "function" && typeof value.prototype.throw === "function";
+	return isGeneratorInstance(GENERATOR_NAME_SYNC, value);
+}
+function isGeneratorInstance(name, value) {
+	return typeof value === "function" && value !== null && value.constructor.name === name && typeof value.prototype.next === "function" && typeof value.prototype.return === "function" && typeof value.prototype.throw === "function";
 }
 /**
 * Is the value a plan?

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@oscarpalmer/atoms",
-	"version": "0.208.0",
+	"version": "0.209.0",
 	"description": "Atomic utilities for making your JavaScript better.",
 	"keywords": [
 		"array",