mobx-bonsai/src/node/computedProp.ts

A fast lightweight alternative to MobX-State-Tree + Y.js two-way binding

import { computed, IComputedValue, IComputedValueOptions } from "mobx"
import { isObservablePlainStructure } from "../plainTypes/checks"

/**
 * Represents a function used to compute derived values based on an object's state.
 *
 * @template T - The type of the object that this function computes values for.
 * @template R - The return type of the computation.
 *
 * @property getComputedFor - A method that returns the cached computed value for a given object,
 *                           or undefined if no computation has been performed yet for this object.
 */
export type ComputedPropFn<T extends object, R> = {
  (obj: T): R
  getComputedFor(obj: T): IComputedValue<R> | undefined
}

/**
 * Create a computed property on an object that is used as a function
 * that takes the object as an argument and returns the computed value.
 *
 * If the passed object is not an observable it will return the value
 * without ever caching it.
 *
 * Example:
 *
 * ```ts
 * const getPointDistance = computedProp<Point>(
 *  ({ x, y }) => Math.sqrt(x ** 2 + y ** 2)
 * )
 *
 * // this will be a computed value
 * getPointDistance(somePoint)
 * ```
 *
 * You can pass as optional second argument the options for the computed value,
 * the same that MobX takes for its computed function.
 *
 * If you ever need to get the actual computed used for the computed property
 * you can access it through the `getComputedFor` property of the returned function.
 */
export function computedProp<T extends object, R>(
  fn: (obj: T) => R,
  options?: IComputedValueOptions<R>
): ComputedPropFn<T, R> {
  const computedFns = new WeakMap<T, IComputedValue<R>>()

  const getFn = (obj: T): R => {
    if (!isObservablePlainStructure(obj)) {
      return fn(obj)
    }

    let computedFn = computedFns.get(obj)
    if (!computedFn) {
      computedFn = computed(() => fn(obj), options)
      computedFns.set(obj, computedFn)
    }

    return computedFn.get()
  }

  getFn.getComputedFor = (obj: T) => computedFns.get(obj)

  return getFn
}