effect 4.0.0-beta.102 → 4.0.0-beta.103

package/dist/Optic.js

@@ -12,7 +12,7 @@
  * @since 4.0.0
  */
 import { format } from "./Formatter.js";
-import { identity, memoize } from "./Function.js";
+import { identity } from "./Function.js";
 import * as InternalRecord from "./internal/record.js";
 import * as Option from "./Option.js";
 import * as Predicate from "./Predicate.js";
@@ -33,7 +33,7 @@ import * as Struct from "./Struct.js";
  *
  * **Example** (Wrapping and unwrapping a branded type)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Optic } from "effect"
  *
  * type Meters = { readonly value: number }
@@ -42,11 +42,9 @@ import * as Struct from "./Struct.js";
  *   (n) => ({ value: n })
  * )
  *
- * console.log(meters.get({ value: 100 }))
- * // Output: 100
+ * meters.get({ value: 100 }) // => 100
  *
- * console.log(meters.set(42))
- * // Output: { value: 42 }
+ * meters.set(42) // => { value: 42 }
  * ```
  *
  * @see {@link Iso} — the type this function returns
@@ -56,7 +54,7 @@ import * as Struct from "./Struct.js";
  * @since 4.0.0
  */
 export function makeIso(get, set) {
-  return make(new IsoNode(get, set));
+  return make(primitiveNode("Iso", get, set));
 }
 /**
  * Creates a {@link Lens} from a getter and a replacer.
@@ -73,7 +71,7 @@ export function makeIso(get, set) {
  *
  * **Example** (Focusing on the first element of a pair)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Optic } from "effect"
  *
  * const _first = Optic.makeLens<readonly [string, number], string>(
@@ -81,11 +79,9 @@ export function makeIso(get, set) {
  *   (s, pair) => [s, pair[1]]
  * )
  *
- * console.log(_first.get(["hello", 42]))
- * // Output: "hello"
+ * _first.get(["hello", 42]) // => "hello"
  *
- * console.log(_first.replace("world", ["hello", 42]))
- * // Output: ["world", 42]
+ * _first.replace("world", ["hello", 42]) // => ["world", 42]
  * ```
  *
  * @see {@link Lens} — the type this function returns
@@ -95,7 +91,7 @@ export function makeIso(get, set) {
  * @since 4.0.0
  */
 export function makeLens(get, replace) {
-  return make(new LensNode(get, replace));
+  return make(primitiveNode("Lens", get, replace));
 }
 /**
  * Creates a {@link Prism} from a fallible getter and an infallible setter.
@@ -111,7 +107,7 @@ export function makeLens(get, replace) {
  *
  * **Example** (Parsing a string to a number)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Optic, Result } from "effect"
  *
  * const numeric = Optic.makePrism<string, number>(
@@ -122,11 +118,9 @@ export function makeLens(get, replace) {
  *   String
  * )
  *
- * console.log(Result.isSuccess(numeric.getResult("42")))
- * // Output: true
+ * numeric.getResult("42") // => Result.succeed(42)
  *
- * console.log(numeric.set(42))
- * // Output: "42"
+ * numeric.set(42) // => "42"
  * ```
  *
  * @see {@link Prism} — the type this function returns
@@ -136,7 +130,7 @@ export function makeLens(get, replace) {
  * @since 4.0.0
  */
 export function makePrism(getResult, set) {
-  return make(new PrismNode(getResult, set));
+  return make(primitiveNode("Prism", getResult, set));
 }
 /**
  * Creates a {@link Prism} from one or more `Schema` validation checks.
@@ -155,7 +149,7 @@ export function makePrism(getResult, set) {
  *
  * **Example** (Creating a positive integer prism)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Optic, Result, Schema } from "effect"
  *
  * const posInt = Optic.fromChecks<number>(
@@ -163,11 +157,9 @@ export function makePrism(getResult, set) {
  *   Schema.isInt()
  * )
  *
- * console.log(Result.isSuccess(posInt.getResult(3)))
- * // Output: true
+ * posInt.getResult(3) // => Result.succeed(3)
  *
- * console.log(Result.isFailure(posInt.getResult(-1)))
- * // Output: true
+ * Result.isFailure(posInt.getResult(-1)) // => true
  * ```
  *
  * @see {@link makePrism} — constructor with custom getter/setter
@@ -177,109 +169,77 @@ export function makePrism(getResult, set) {
  * @since 4.0.0
  */
 export function fromChecks(...checks) {
-  return make(new CheckNode(checks));
-}
-class IdentityNode {
-  _tag = "IdentityNode";
-}
-const identityNode = /*#__PURE__*/new IdentityNode();
-class CompositionNode {
-  _tag = "CompositionNode";
-  nodes;
-  constructor(nodes) {
-    this.nodes = nodes;
-  }
-}
-class IsoNode {
-  _tag = "IsoNode";
-  get;
-  set;
-  constructor(get, set) {
-    this.get = get;
-    this.set = set;
-  }
-}
-class LensNode {
-  _tag = "LensNode";
-  get;
-  set;
-  constructor(get, set) {
-    this.get = get;
-    this.set = set;
-  }
-}
-class PrismNode {
-  _tag = "PrismNode";
-  get;
-  set;
-  constructor(get, set) {
-    this.get = get;
-    this.set = set;
-  }
-}
-class OptionalNode {
-  _tag = "OptionalNode";
-  get;
-  set;
-  constructor(get, set) {
-    this.get = get;
-    this.set = set;
-  }
-}
+  return make([new CheckNode(checks)]);
+}
+function primitiveNode(kind, get, set) {
+  return [{
+    _tag: "PrimitiveNode",
+    kind,
+    get,
+    set
+  }];
+}
+const identityOperation = {
+  kind: "Iso",
+  get: identity,
+  set: identity
+};
 class PathNode {
   _tag = "PathNode";
+  kind = "Lens";
   path;
+  get;
+  set;
   constructor(path) {
     this.path = path;
+    this.get = s => {
+      let out = s;
+      for (let i = 0; i < path.length; i++) {
+        out = out[path[i]];
+      }
+      return out;
+    };
+    this.set = (a, s) => {
+      const out = cloneShallow(s);
+      let current = out;
+      let i = 0;
+      for (; i < path.length - 1; i++) {
+        const key = path[i];
+        InternalRecord.assignProperty(current, key, cloneShallow(current[key]));
+        current = current[key];
+      }
+      InternalRecord.assignProperty(current, path[i], a);
+      return out;
+    };
   }
 }
 class CheckNode {
   _tag = "CheckNode";
+  kind = "Prism";
   checks;
+  get;
+  set = identity;
   constructor(checks) {
     this.checks = checks;
+    this.get = s => Result.mapError(SchemaAST.runChecks(checks, s), String);
   }
 }
-// Fuse with tail when possible, else push.
-function pushNormalized(acc, node) {
-  const last = acc[acc.length - 1];
-  if (last) {
+function compose(a, b) {
+  if (a.length === 0) return b;
+  if (b.length === 0) return a;
+  const nodes = a.slice();
+  for (let i = 0; i < b.length; i++) {
+    const node = b[i];
+    const last = nodes[nodes.length - 1];
     if (last._tag === "PathNode" && node._tag === "PathNode") {
-      // fuse Path
-      acc[acc.length - 1] = new PathNode([...last.path, ...node.path]);
-      return;
+      nodes[nodes.length - 1] = new PathNode([...last.path, ...node.path]);
+    } else if (last._tag === "CheckNode" && node._tag === "CheckNode") {
+      nodes[nodes.length - 1] = new CheckNode([...last.checks, ...node.checks]);
+    } else {
+      nodes.push(node);
     }
-    if (last._tag === "CheckNode" && node._tag === "CheckNode") {
-      // fuse Checks
-      acc[acc.length - 1] = new CheckNode([...last.checks, ...node.checks]);
-      return;
-    }
-  }
-  acc.push(node);
-}
-// Collect nodes from a node into `acc`, flattening & normalizing on the fly.
-function collect(node, acc) {
-  if (node._tag === "IdentityNode") return;
-  if (node._tag === "CompositionNode") {
-    // flatten without extra arrays
-    for (let i = 0; i < node.nodes.length; i++) collect(node.nodes[i], acc);
-    return;
-  }
-  // primitive node
-  pushNormalized(acc, node);
-}
-function compose(a, b) {
-  const nodes = [];
-  collect(a, nodes);
-  collect(b, nodes);
-  switch (nodes.length) {
-    case 0:
-      return identityNode;
-    case 1:
-      return nodes[0];
-    default:
-      return new CompositionNode(nodes);
   }
+  return nodes;
 }
 /**
  * Creates an {@link Optional} from a fallible getter and a fallible setter.
@@ -297,7 +257,7 @@ function compose(a, b) {
  *
  * **Example** (Accessing record keys safely)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Optic, Result } from "effect"
  *
  * const atKey = (key: string) =>
@@ -312,8 +272,7 @@ function compose(a, b) {
  *         : Result.fail(`Key "${key}" not found`)
  *   )
  *
- * console.log(Result.isSuccess(atKey("x").getResult({ x: 1 })))
- * // Output: true
+ * atKey("x").getResult({ x: 1 }) // => Result.succeed(1)
  * ```
  *
  * @see {@link Optional} — the type this function returns
@@ -324,9 +283,10 @@ function compose(a, b) {
  * @since 4.0.0
  */
 export function makeOptional(getResult, set) {
-  return make(new OptionalNode(getResult, set));
+  return make(primitiveNode("Optional", getResult, set));
 }
 class OptionalImpl {
+  /** @internal */
   node;
   getResult;
   replaceResult;
@@ -345,10 +305,10 @@ class OptionalImpl {
     return make(compose(this.node, that.node));
   }
   key(key) {
-    return make(compose(this.node, new PathNode([key])));
+    return make(compose(this.node, [new PathNode([key])]));
   }
   optionalKey(key) {
-    return make(compose(this.node, new LensNode(s => s[key], (a, s) => {
+    return make(compose(this.node, primitiveNode("Lens", s => s[key], (a, s) => {
       const copy = cloneShallow(s);
       if (a === undefined) {
         if (Array.isArray(copy) && typeof key === "number") {
@@ -363,17 +323,17 @@ class OptionalImpl {
     })));
   }
   check(...checks) {
-    return make(compose(this.node, new CheckNode(checks)));
+    return make(compose(this.node, [new CheckNode(checks)]));
   }
   refine(refinement, annotations) {
-    return make(compose(this.node, new CheckNode([SchemaAST.makeFilterByGuard(refinement, annotations)])));
+    return make(compose(this.node, [new CheckNode([SchemaAST.makeFilterByGuard(refinement, annotations)])]));
   }
   tag(tag) {
-    return make(compose(this.node, new PrismNode(s => s._tag === tag ? Result.succeed(s) : Result.fail(`Expected ${format(tag)} tag, got ${format(s._tag)}`), identity)));
+    return make(compose(this.node, primitiveNode("Prism", s => s._tag === tag ? Result.succeed(s) : Result.fail(`Expected ${format(tag)} tag, got ${format(s._tag)}`), identity)));
   }
   at(key, ..._rest) {
     const err = Result.fail(`Key ${format(key)} not found`);
-    return make(compose(this.node, new OptionalNode(s => Object.hasOwn(s, key) ? Result.succeed(s[key]) : err, (a, s) => {
+    return make(compose(this.node, primitiveNode("Optional", s => Object.hasOwn(s, key) ? Result.succeed(s[key]) : err, (a, s) => {
       if (Object.hasOwn(s, key)) {
         const copy = cloneShallow(s);
         InternalRecord.assignProperty(copy, key, a);
@@ -480,15 +440,23 @@ class PrismImpl extends OptionalImpl {
   }
 }
 function make(node) {
-  const op = recur(node);
-  switch (op._tag) {
-    case "IsoNode":
+  let op = node[0] ?? identityOperation;
+  if (node.length > 1) {
+    const kind = node.reduce((kind, step) => composeKind(kind, step.kind), "Iso");
+    op = {
+      kind,
+      get: compileGet(node, kind),
+      set: compileSet(node, kind)
+    };
+  }
+  switch (op.kind) {
+    case "Iso":
       return new IsoImpl(node, op.get, op.set);
-    case "LensNode":
+    case "Lens":
       return new LensImpl(node, op.get, op.set);
-    case "PrismNode":
+    case "Prism":
       return new PrismImpl(node, op.get, op.set);
-    case "OptionalNode":
+    case "Optional":
       return new OptionalImpl(node, op.get, op.set);
   }
 }
@@ -505,133 +473,75 @@ function cloneShallow(pojo) {
   }
   return pojo;
 }
-const recur = /*#__PURE__*/memoize(node => {
-  switch (node._tag) {
-    case "IdentityNode":
-      return {
-        _tag: "IsoNode",
-        get: identity,
-        set: identity
-      };
-    case "IsoNode":
-    case "LensNode":
-    case "PrismNode":
-    case "OptionalNode":
-      return {
-        _tag: node._tag,
-        get: node.get,
-        set: node.set
-      };
-    case "PathNode":
-      {
-        return {
-          _tag: "LensNode",
-          get: s => {
-            const path = node.path;
-            let out = s;
-            for (let i = 0, n = path.length; i < n; i++) {
-              out = out[path[i]];
-            }
-            return out;
-          },
-          set: (a, s) => {
-            const path = node.path;
-            const out = cloneShallow(s);
-            let current = out;
-            let i = 0;
-            for (; i < path.length - 1; i++) {
-              const key = path[i];
-              InternalRecord.assignProperty(current, key, cloneShallow(current[key]));
-              current = current[key];
-            }
-            const finalKey = path[i];
-            InternalRecord.assignProperty(current, finalKey, a);
-            return out;
-          }
-        };
+function compileGet(nodes, kind) {
+  return s => {
+    for (let i = 0; i < nodes.length; i++) {
+      const op = nodes[i];
+      const result = op.get(s);
+      if (hasFailingGet(op.kind)) {
+        if (Result.isFailure(result)) {
+          return result;
+        }
+        s = result.success;
+      } else {
+        s = result;
       }
-    case "CheckNode":
-      return {
-        _tag: "PrismNode",
-        get: s => Result.mapError(SchemaAST.runChecks(node.checks, s), String),
-        set: identity
-      };
-    case "CompositionNode":
-      {
-        const ops = node.nodes.map(recur);
-        const _tag = ops.reduce((tag, op) => getCompositionTag(tag, op._tag), "IsoNode");
-        return {
-          _tag,
-          get: s => {
-            for (let i = 0; i < ops.length; i++) {
-              const op = ops[i];
-              const result = op.get(s);
-              if (hasFailingGet(op._tag)) {
-                if (Result.isFailure(result)) {
-                  return result;
-                }
-                s = result.success;
-              } else {
-                s = result;
-              }
-            }
-            return hasFailingGet(_tag) ? Result.succeed(s) : s;
-          },
-          set: (a, s) => {
-            const source = s;
-            const len = ops.length;
-            const ss = new Array(len + 1);
-            ss[0] = s;
-            for (let i = 0; i < len; i++) {
-              const op = ops[i];
-              if (hasFailingGet(op._tag)) {
-                const result = op.get(s);
-                if (Result.isFailure(result)) {
-                  return _tag === "OptionalNode" ? result : source;
-                }
-                s = result.success;
-              } else {
-                s = op.get(s);
-              }
-              ss[i + 1] = s;
-            }
-            for (let i = len - 1; i >= 0; i--) {
-              const op = ops[i];
-              if (hasSet(op._tag)) {
-                a = op.set(a);
-              } else if (op._tag === "LensNode") {
-                a = op.set(a, ss[i]);
-              } else {
-                const result = op.set(a, ss[i]);
-                if (Result.isFailure(result)) {
-                  return result;
-                }
-                a = result.success;
-              }
-            }
-            return _tag === "OptionalNode" ? Result.succeed(a) : a;
-          }
-        };
+    }
+    return hasFailingGet(kind) ? Result.succeed(s) : s;
+  };
+}
+function compileSet(nodes, kind) {
+  if (hasSourceFreeSet(kind)) {
+    return a => {
+      for (let i = nodes.length - 1; i >= 0; i--) {
+        a = nodes[i].set(a);
       }
+      return a;
+    };
   }
-});
-function hasFailingGet(tag) {
-  return tag === "PrismNode" || tag === "OptionalNode";
+  return (a, s) => {
+    const len = nodes.length;
+    const sources = new Array(len);
+    for (let i = 0; i < len; i++) {
+      sources[i] = s;
+      const op = nodes[i];
+      if (hasFailingGet(op.kind)) {
+        const result = op.get(s);
+        if (Result.isFailure(result)) {
+          return result;
+        }
+        s = result.success;
+      } else {
+        s = op.get(s);
+      }
+    }
+    for (let i = len - 1; i >= 0; i--) {
+      const op = nodes[i];
+      if (hasSourceFreeSet(op.kind)) {
+        a = op.set(a);
+      } else if (op.kind === "Lens") {
+        a = op.set(a, sources[i]);
+      } else {
+        const result = op.set(a, sources[i]);
+        if (Result.isFailure(result)) {
+          return result;
+        }
+        a = result.success;
+      }
+    }
+    return kind === "Optional" ? Result.succeed(a) : a;
+  };
 }
-function hasSet(tag) {
-  return tag === "IsoNode" || tag === "PrismNode";
+function hasFailingGet(kind) {
+  return kind === "Prism" || kind === "Optional";
 }
-function getCompositionTag(a, b) {
-  switch (a) {
-    case "IsoNode":
-      return b;
-    case "LensNode":
-      return hasFailingGet(b) ? "OptionalNode" : "LensNode";
-    case "PrismNode":
-      return hasSet(b) ? "PrismNode" : "OptionalNode";
-    case "OptionalNode":
-      return "OptionalNode";
-  }
+function hasSourceFreeSet(kind) {
+  return kind === "Iso" || kind === "Prism";
+}
+function composeKind(a, b) {
+  if (a === "Iso") return b;
+  if (b === "Iso" || a === b) return a;
+  return "Optional";
 }
 // ---------------------------------------------
 // Derived APIs
@@ -652,7 +562,7 @@ function getCompositionTag(a, b) {
  *
  * **Example** (Collecting positive numbers)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Optic, Schema } from "effect"
  *
  * type S = { readonly values: ReadonlyArray<number> }
@@ -663,16 +573,14 @@ function getCompositionTag(a, b) {
  *
  * const getPositive = Optic.getAll(_pos)
  *
- * console.log(getPositive({ values: [3, -1, 5] }))
- * // Output: [3, 5]
+ * getPositive({ values: [3, -1, 5] }) // => [3, 5]
  *
- * console.log(getPositive({ values: [-1, -2] }))
- * // Output: []
+ * getPositive({ values: [-1, -2] }) // => []
  * ```
  *
  * @see {@link Traversal} — the optic type this operates on
  *
- * @category Traversal
+ * @category getters
  * @since 4.0.0
  */
 export function getAll(traversal) {
@@ -684,7 +592,7 @@ export function getAll(traversal) {
 // ---------------------------------------------
 // Built-in Optics
 // ---------------------------------------------
-const identityIso = /*#__PURE__*/make(identityNode);
+const identityIso = /*#__PURE__*/make([]);
 /**
  * Iso that focuses on the whole value unchanged.
  *
@@ -700,20 +608,19 @@ const identityIso = /*#__PURE__*/make(identityNode);
  *
  * **Example** (Starting an optic chain)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Optic } from "effect"
  *
  * type S = { readonly x: number }
  *
  * const _x = Optic.id<S>().key("x")
  *
- * console.log(_x.get({ x: 42 }))
- * // Output: 42
+ * _x.get({ x: 42 }) // => 42
  * ```
  *
  * @see {@link Iso} — the type this function returns
  *
- * @category Iso
+ * @category constructors
  * @since 4.0.0
  */
 export function id() {
@@ -736,7 +643,7 @@ export function id() {
  *
  * **Example** (Traversing record values)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Optic, Schema } from "effect"
  *
  * const _positiveValues = Optic.entries<number>()
@@ -744,18 +651,17 @@ export function id() {
  *
  * const inc = _positiveValues.modifyAll((n) => n + 1)
  *
- * console.log(inc({ a: 0, b: 3, c: -1 }))
- * // Output: { a: 0, b: 4, c: -1 }
+ * inc({ a: 0, b: 3, c: -1 }) // => { a: 0, b: 4, c: -1 }
  * ```
  *
  * @see {@link Iso} — the type this function returns
  * @see {@link id} — identity iso
  *
- * @category Iso
+ * @category constructors
  * @since 4.0.0
  */
 export function entries() {
-  return make(new IsoNode(Object.entries, Object.fromEntries));
+  return make(primitiveNode("Iso", Object.entries, Object.fromEntries));
 }
 /**
  * Prism that focuses on the value inside `Option.Some`.
@@ -772,25 +678,22 @@ export function entries() {
  *
  * **Example** (Accessing Some value)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Optic, Option, Result } from "effect"
  *
  * const _some = Optic.id<Option.Option<number>>().compose(Optic.some())
  *
- * console.log(Result.isSuccess(_some.getResult(Option.some(42))))
- * // Output: true
+ * _some.getResult(Option.some(42)) // => Result.succeed(42)
  *
- * console.log(Result.isFailure(_some.getResult(Option.none())))
- * // Output: true
+ * Result.isFailure(_some.getResult(Option.none())) // => true
  *
- * console.log(_some.set(10))
- * // Output: { _tag: "Some", value: 10 }
+ * _some.set(10) // => Option.some(10)
  * ```
  *
  * @see {@link none} — focuses on `None` instead
  * @see {@link Prism} — the type this function returns
  *
- * @category Prism
+ * @category constructors
  * @since 4.0.0
  */
 export function some() {
@@ -817,22 +720,20 @@ export function some() {
  *
  * **Example** (Matching None)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Optic, Option, Result } from "effect"
  *
  * const _none = Optic.id<Option.Option<number>>().compose(Optic.none())
  *
- * console.log(Result.isSuccess(_none.getResult(Option.none())))
- * // Output: true
+ * _none.getResult(Option.none()) // => Result.succeed(undefined)
  *
- * console.log(Result.isFailure(_none.getResult(Option.some(1))))
- * // Output: true
+ * Result.isFailure(_none.getResult(Option.some(1))) // => true
  * ```
  *
  * @see {@link some} — focuses on `Some` instead
  * @see {@link Prism} — the type this function returns
  *
- * @category Prism
+ * @category constructors
  * @since 4.0.0
  */
 export function none() {
@@ -859,22 +760,20 @@ export function none() {
  *
  * **Example** (Accessing success)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Optic, Result } from "effect"
  *
  * const _ok = Optic.id<Result.Result<number, string>>().compose(Optic.success())
  *
- * console.log(Result.isSuccess(_ok.getResult(Result.succeed(42))))
- * // Output: true
+ * _ok.getResult(Result.succeed(42)) // => Result.succeed(42)
  *
- * console.log(Result.isFailure(_ok.getResult(Result.fail("err"))))
- * // Output: true
+ * Result.isFailure(_ok.getResult(Result.fail("err"))) // => true
  * ```
  *
  * @see {@link failure} — focuses on the failure side
  * @see {@link Prism} — the type this function returns
  *
- * @category Prism
+ * @category constructors
  * @since 4.0.0
  */
 export function success() {
@@ -901,22 +800,20 @@ export function success() {
  *
  * **Example** (Accessing failure)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Optic, Result } from "effect"
  *
  * const _err = Optic.id<Result.Result<number, string>>().compose(Optic.failure())
  *
- * console.log(Result.isSuccess(_err.getResult(Result.fail("oops"))))
- * // Output: true
+ * _err.getResult(Result.fail("oops")) // => Result.succeed("oops")
  *
- * console.log(Result.isFailure(_err.getResult(Result.succeed(42))))
- * // Output: true
+ * Result.isFailure(_err.getResult(Result.succeed(42))) // => true
  * ```
  *
  * @see {@link success} — focuses on the success side
  * @see {@link Prism} — the type this function returns
  *
- * @category Prism
+ * @category constructors
  * @since 4.0.0
  */
 export function failure() {