fix: avoid circular dependency b/w utils.ts and atom.ts

Author: derrickbeining

docs/classes/atom.html

@@ -113,7 +113,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> of</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in atom.ts:29</li>
+									<li>Defined in <a href="https://github.com/libre-org/atom/blob/15aca7c/src/atom.ts#L29">atom.ts:29</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

docs/globals.html

@@ -105,7 +105,7 @@ <h3>Atom<wbr>State</h3>
 					<div class="tsd-signature tsd-kind-icon">Atom<wbr>State<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AtomState&lt;A&gt;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in internal-types.ts:32</li>
+							<li>Defined in <a href="https://github.com/libre-org/atom/blob/15aca7c/src/internal-types.ts#L32">internal-types.ts:32</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -128,7 +128,7 @@ <h3>Deep<wbr>Immutable</h3>
 					<div class="tsd-signature tsd-kind-icon">Deep<wbr>Immutable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">T extends Primitive ? T : T extends (infer U)[] ? DeepImmutableArray&lt;U&gt; : T extends Map&lt;infer K, infer V&gt; ? DeepImmutableMap&lt;K, V&gt; : DeepImmutableObject&lt;T&gt;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in internal-types.ts:49</li>
+							<li>Defined in <a href="https://github.com/libre-org/atom/blob/15aca7c/src/internal-types.ts#L49">internal-types.ts:49</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -150,7 +150,7 @@ <h3>add<wbr>Change<wbr>Handler</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in changeHandler.ts:29</li>
+									<li>Defined in <a href="https://github.com/libre-org/atom/blob/15aca7c/src/changeHandler.ts#L29">changeHandler.ts:29</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -231,7 +231,7 @@ <h3>deref</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in deref.ts:22</li>
+									<li>Defined in <a href="https://github.com/libre-org/atom/blob/15aca7c/src/deref.ts#L22">deref.ts:22</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -279,7 +279,7 @@ <h3>get<wbr>Validator</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in getValidator.ts:24</li>
+									<li>Defined in <a href="https://github.com/libre-org/atom/blob/15aca7c/src/getValidator.ts#L24">getValidator.ts:24</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -327,7 +327,7 @@ <h3>remove<wbr>Change<wbr>Handler</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in changeHandler.ts:65</li>
+									<li>Defined in <a href="https://github.com/libre-org/atom/blob/15aca7c/src/changeHandler.ts#L65">changeHandler.ts:65</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -389,7 +389,7 @@ <h3>set</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in set.ts:28</li>
+									<li>Defined in <a href="https://github.com/libre-org/atom/blob/15aca7c/src/set.ts#L29">set.ts:29</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -447,7 +447,7 @@ <h3>set<wbr>Validator</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in setValidator.ts:30</li>
+									<li>Defined in <a href="https://github.com/libre-org/atom/blob/15aca7c/src/setValidator.ts#L30">setValidator.ts:30</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -505,7 +505,7 @@ <h3>swap</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in swap.ts:25</li>
+									<li>Defined in <a href="https://github.com/libre-org/atom/blob/15aca7c/src/swap.ts#L27">swap.ts:27</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -517,6 +517,7 @@ <h3>swap</h3>
 									<dt>example</dt>
 									<dd><pre><code class="language-jsx">
 <span class="hljs-keyword">import</span> {Atom, swap} <span class="hljs-keyword">from</span> <span class="hljs-string">'@libre/atom'</span>
+<span class="hljs-keyword">import</span> {prettyPrint} <span class="hljs-keyword">from</span> <span class="hljs-string">'./prettyPrint'</span>
 
 <span class="hljs-keyword">const</span> stateAtom = Atom.of({ <span class="hljs-attr">count</span>: <span class="hljs-number">0</span> })
 <span class="hljs-keyword">const</span> increment = <span class="hljs-function"><span class="hljs-params">()</span> =&gt;</span> swap(stateAtom, (state) =&gt; ({

docs/interfaces/atomconstructoroptions.html

@@ -115,7 +115,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> validator</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in internal-types.ts:16</li>
+									<li>Defined in <a href="https://github.com/libre-org/atom/blob/15aca7c/src/internal-types.ts#L16">internal-types.ts:16</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

src/atom.ts

@@ -1,6 +1,6 @@
 import { _getState, _initChangeHandlerDict, _setState, _setValidator, _useNextAtomId } from "./internal-state";
 import { AtomConstructorOptions, DeepImmutable } from "./internal-types";
-import { _prettyPrint } from "./utils";
+import { prettyPrint } from "./prettyPrint";
 
 /**
  * A data structure useful for providing a controlled, predictable mechanism for mutability.
@@ -37,7 +37,7 @@ const a3 = Atom.of({ count: 0 })
   private constructor(state: S, { validator }: AtomConstructorOptions<S> = {}) {
     validator = validator || (() => true);
     if (!validator(state as DeepImmutable<S>)) {
-      const errMsg = `Atom initialized with invalid state:\n\n${_prettyPrint(
+      const errMsg = `Atom initialized with invalid state:\n\n${prettyPrint(
         state
       )}\n\naccording to validator function:\n${validator}\n\n`;
       const err = Error(errMsg);
@@ -53,7 +53,7 @@ const a3 = Atom.of({ count: 0 })
   }
   /** @ignore */
   public toString(): string {
-    return `Atom<${_prettyPrint(_getState(this))}>`;
+    return `Atom<${prettyPrint(_getState(this))}>`;
   }
   /** @ignore */
   public inspect(): string {

src/deref.ts

@@ -1,7 +1,7 @@
 import { Atom } from "./atom";
 import { _getState } from "./internal-state";
 import { DeepImmutable } from "./internal-types";
-import { _throwIfNotAtom } from "./utils";
+import { throwIfNotAtom } from "./throwIfNotAtom";
 
 /**
  * Dereferences (i.e. "*reads*") the current state of an [[Atom]]. The dereferenced value
@@ -20,6 +20,6 @@ deref(stateAtom) // => { count: 0 }
 ```
  */
 export function deref<S>(atom: Atom<S>): DeepImmutable<S> {
-  _throwIfNotAtom(atom);
+  throwIfNotAtom(atom);
   return _getState(atom) as DeepImmutable<S>;
 }

src/getValidator.ts

@@ -2,7 +2,7 @@ import { Atom } from "./atom";
 import { _getValidator } from "./internal-state";
 import { AtomConstructorOptions } from "./internal-types";
 
-import { _throwIfNotAtom } from "./utils";
+import { throwIfNotAtom } from "./throwIfNotAtom";
 
 /**
  * Gets `atom`'s validator function
@@ -22,6 +22,6 @@ validator({ count: 2 }) // => true
  */
 
 export function getValidator<S>(atom: Atom<S>): NonNullable<AtomConstructorOptions<any>["validator"]> {
-  _throwIfNotAtom(atom);
+  throwIfNotAtom(atom);
   return _getValidator(atom);
 }

src/prettyPrint.ts

@@ -0,0 +1,4 @@
+/** @ignore */
+export function prettyPrint(val: any): string {
+  return JSON.stringify(val, null, "  ");
+}

src/set.ts

@@ -2,7 +2,8 @@ import { Atom } from "./atom";
 import { deref } from "./deref";
 import { _getValidator, _runChangeHandlers, _setState } from "./internal-state";
 import { DeepImmutable } from "./internal-types";
-import { _prettyPrint, _throwIfNotAtom } from "./utils";
+import { prettyPrint } from "./prettyPrint";
+import { throwIfNotAtom } from "./throwIfNotAtom";
 
 /**
  * Sets `atom`s state to `nextState`.
@@ -26,11 +27,11 @@ deref(atom) // => { count: 100 }
  */
 
 export function set<S>(atom: Atom<S>, nextState: S): void {
-  _throwIfNotAtom(atom);
+  throwIfNotAtom(atom);
   const validator = _getValidator(atom);
   const didValidate = validator(nextState as DeepImmutable<S>);
   if (!didValidate) {
-    const errMsg = `Attempted to set the state of\n\n${atom}\n\nwith:\n\n${_prettyPrint(
+    const errMsg = `Attempted to set the state of\n\n${atom}\n\nwith:\n\n${prettyPrint(
       nextState
     )}\n\nbut it did not pass validator:\n${validator}\n\n`;
     const err = Error(errMsg);

src/setValidator.ts

@@ -1,7 +1,7 @@
 import { Atom } from "./atom";
 import { _getState, _setValidator } from "./internal-state";
 import { AtomConstructorOptions } from "./internal-types";
-import { _throwIfNotAtom } from "./utils";
+import { throwIfNotAtom } from "./throwIfNotAtom";
 
 /**
  * Sets the `validator` for `atom`. `validator` must be a pure function of one argument,
@@ -28,7 +28,7 @@ set(atom, {count: 2}) // All good
  */
 
 export function setValidator<S>(atom: Atom<S>, validator: NonNullable<AtomConstructorOptions<any>["validator"]>): void {
-  _throwIfNotAtom(atom);
+  throwIfNotAtom(atom);
   if (!validator(_getState(atom))) {
     const errMsg = `Could not set validator on\n\n${atom}\n\nbecause current state would be invalid according to new validator:\n${validator}\n\n`;
     const err = Error(errMsg);

src/swap.ts

@@ -1,7 +1,8 @@
 import { Atom } from "./atom";
 import { _getState, _getValidator, _runChangeHandlers, _setState } from "./internal-state";
 import { DeepImmutable } from "./internal-types";
-import { _prettyPrint, _throwIfNotAtom } from "./utils";
+import { prettyPrint } from "./prettyPrint";
+import { throwIfNotAtom } from "./throwIfNotAtom";
 
 /**
  * Swaps `atom`'s state with the value returned from applying `updateFn` to `atom`'s
@@ -15,6 +16,7 @@ import { _prettyPrint, _throwIfNotAtom } from "./utils";
  * ```jsx
  *
  *import {Atom, swap} from '@libre/atom'
+import {prettyPrint} from './prettyPrint'
  *
  *const stateAtom = Atom.of({ count: 0 })
  *const increment = () => swap(stateAtom, (state) => ({
@@ -23,13 +25,13 @@ import { _prettyPrint, _throwIfNotAtom } from "./utils";
  * ```
  */
 export function swap<S>(atom: Atom<S>, updateFn: (state: S) => S): void {
-  _throwIfNotAtom(atom);
+  throwIfNotAtom(atom);
   const prevState = _getState(atom);
   const nextState = updateFn(prevState);
   const validator = _getValidator(atom);
   const didValidate = validator(nextState as DeepImmutable<S>);
   if (!didValidate) {
-    const errMsg = `swap updateFn\n${updateFn}\n\nattempted to swap the state of\n\n${atom}\n\nwith:\n\n${_prettyPrint(
+    const errMsg = `swap updateFn\n${updateFn}\n\nattempted to swap the state of\n\n${atom}\n\nwith:\n\n${prettyPrint(
       nextState
     )}\n\nbut it did not pass validator:\n${validator}\n\n`;
     const err = Error(errMsg);