solid-ctrl-flow 1.0.37 → 1.0.39

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import { Accessor } from 'solid-js';
 import { Context } from 'solid-js';
 import { EffectFunction } from 'solid-js';
 import { JSX } from 'solid-js';
+import { MemoOptions } from 'solid-js';
 import { Ref } from 'solid-js';
 import { Resource } from 'solid-js';
 import { Setter } from 'solid-js';
@@ -132,6 +133,9 @@ export declare function createReactiveResource<R>(f: EffectFunction<R | undefine
 /** Built-in {@link ReactiveContext} which allows you to display different things in debug mode */
 export declare const debug: ReactiveContext<boolean>;
 
+/** Handy type alias */
+declare type Equals = MemoOptions<unknown>["equals"];
+
 /** Informations about a {@link Source} component */
 declare type Info = {
     /** Order of the current source if there are many */
@@ -140,12 +144,16 @@ declare type Info = {
 };
 
 /**
- * Memoizes some of the properties of {@link obj}
- * If {@link keys} is not provided, memoizes everything that get returned by {@link Object.keys} when provided with {@link obj}
+ * Memoizes some of the properties of {@link obj}.
+ * If {@link keys} is not provided, memoizes everything that get returned by {@link Object.keys} when provided with {@link obj}.
+ * The {@link equals} parameter defaults to `false` to allow the specific reactive value to have control over when its dependant effects are triggered
  * @param obj Object to partially memoize
  * @param keys The keys of the properties to memoize
+ * @param equals The comparator function to use on the newly created memos
  */
-export declare function memoProps<T, K extends readonly (keyof T)[] = (keyof T)[]>(obj: T, keys?: K): Pick<T, K[number]>;
+export declare function memoProps<T>(obj: T, keys?: undefined, equals?: Equals): T;
+
+export declare function memoProps<T, K extends readonly (keyof T)[]>(obj: T, keys: K, equals?: Equals): Pick<T, K[number]>;
 
 /**
  * Like a {@link For}, but instead of putting an element after another it nests them.
@@ -229,11 +237,12 @@ export declare function runWithContext<T, V extends T, R>(ctx: Context<T>, value
 export declare function runWithContext<T, R>(ctx: Context<T>, value: T | undefined, f: (x: T) => R): R;
 
 /**
- * Executes {@link splitProps} and memoizes the first of the two returned objects
+ * Executes {@link splitProps} and memoizes the first of the two returned objects using {@link memoProps}
  * @param obj Object to split and partially memoize
  * @param keys The keys of the properties to memoize and to include in the first of the two objects
+ * @param equals The comparator function to use on the newly created memos
  */
-export declare function splitAndMemoProps<T extends object, K extends readonly (keyof T)[]>(obj: T, keys: K): [Pick<T, Extract<K, readonly (keyof T)[]>[number]>, Omit<T, K[number]>];
+export declare function splitAndMemoProps<T extends Record<any, any>, K extends readonly (keyof T)[]>(obj: T, keys: K, equals?: Equals): [Pick<T, Extract<K, readonly (keyof T)[]>[number]>, Omit<T, K[number]>];
 
 /**
  * Creates a full-fledged solid {@link Setter} from a normal one
@@ -260,10 +269,11 @@ export declare function toSignal<T, K extends keyof T>(obj: Accessor<T>, k: Acce
 export declare function untrackCall<F extends (...args: any[]) => unknown>(this: ThisParameterType<F>, f: F, ...args: Parameters<F>): ReturnType<F>;
 
 /**
- * Calls {@link f} maintaining its reactivity
- * @param f An {@link Accessor} to a {@link Signal}
+ * Calls an {@link Accessor} maintaining its reactivity
+ * @param f The {@link Accessor} to the value to emulate
+ * @returns A {@link Proxy} that copies the functionalities of the result of {@link f} calling it for each interaction, thus maintaining reactivity
  */
-export declare function unwrapSignal<T>(f: Accessor<Signal<T>>): Signal<T>;
+export declare const unwrap: <T>(f: Accessor<T>) => T;
 
 /** Like a {@link Match} but gets the value from the closest {@link Case} ancestor */
 export declare function When(props: {

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { useContext, createMemo, createComponent, createContext, Match, mergeProps, onCleanup, For, Show, mapArray, createSignal, onMount, createRoot, createRenderEffect, on, untrack, splitProps, getOwner, createEffect, createResource } from "solid-js";
+import { useContext, createMemo, createComponent, createContext, createRoot, getOwner, Match, mergeProps, onCleanup, For, Show, untrack, splitProps, createEffect, on, createResource, mapArray, createSignal, onMount, createRenderEffect } from "solid-js";
 import { createMutable } from "solid-js/store";
 const BASE_CTOR = Function;
 class ReactiveContext extends BASE_CTOR {
@@ -54,6 +54,16 @@ class ReactiveContext extends BASE_CTOR {
     return out;
   }
 }
+function runWithContext(ctx2, value, f) {
+  return createRoot((d) => {
+    try {
+      (getOwner().context ??= {})[ctx2.id] = value;
+      return f(value === void 0 ? ctx2.defaultValue : value);
+    } finally {
+      d();
+    }
+  });
+}
 const ctx = ReactiveContext.create(void 0, "case-when");
 const Case = ctx.Provider;
 function When(props) {
@@ -141,6 +151,42 @@ function Joint(props) {
     }
   });
 }
+function untrackCall(f, ...args) {
+  return untrack(() => f.apply(this, args));
+}
+function refCall(ref, value) {
+  if (!ref)
+    return value;
+  if (typeof ref !== "function")
+    throw new ReferenceError('Il parametro "ref" deve essere stato compilato in una funzione a runtime');
+  ref(value);
+  return value;
+}
+function memoProps(obj, keys = Object.keys(obj), equals = false) {
+  const out = {};
+  for (const elm of keys)
+    Object.defineProperty(out, elm, {
+      enumerable: true,
+      get: createMemo(() => obj[elm], void 0, {
+        equals
+      })
+    });
+  return out;
+}
+function splitAndMemoProps(obj, keys, equals) {
+  const out = splitProps(obj, keys);
+  out[0] = memoProps(out[0], keys, equals);
+  return out;
+}
+function createReactiveResource(f) {
+  var refetch;
+  const memo = createMemo(f);
+  createEffect(on(memo, () => refetch?.()));
+  const [get] = [, {
+    refetch
+  }] = createResource(memo);
+  return get;
+}
 function Nest(props) {
   const memo = memoProps(props, ["template", "children"]);
   const content = mapArray(() => props.each, (x, i) => {
@@ -177,53 +223,14 @@ function toSignal(obj, k) {
 function coalesceSignal([get, set], f) {
   return [() => get() ?? set(f), set];
 }
-function unwrapSignal(f) {
-  return [() => f()[0](), (x) => f()[1](x)];
-}
-function untrackCall(f, ...args) {
-  return untrack(() => f.apply(this, args));
-}
-function refCall(ref, value) {
-  if (!ref)
-    return value;
-  if (typeof ref !== "function")
-    throw new ReferenceError('Il parametro "ref" deve essere stato compilato in una funzione a runtime');
-  ref(value);
-  return value;
-}
-function memoProps(obj, keys = Object.keys(obj)) {
-  const out = {};
-  for (const elm of keys)
-    Object.defineProperty(out, elm, {
-      enumerable: true,
-      get: createMemo(() => obj[elm])
-    });
-  return out;
-}
-function splitAndMemoProps(obj, keys) {
-  const out = splitProps(obj, keys);
-  out[0] = memoProps(out[0], keys);
-  return out;
-}
-function runWithContext(ctx2, value, f) {
-  return createRoot((d) => {
-    try {
-      (getOwner().context ??= {})[ctx2.id] = value;
-      return f(value === void 0 ? ctx2.defaultValue : value);
-    } finally {
-      d();
-    }
-  });
-}
-function createReactiveResource(f) {
-  var refetch;
-  const memo = createMemo(f);
-  createEffect(on(memo, () => refetch?.()));
-  const [get] = [, {
-    refetch
-  }] = createResource(memo);
-  return get;
-}
+const unwrap = (f) => new Proxy(f, HANDLER);
+const HANDLER = new Proxy({}, {
+  get(cache, k) {
+    return cache[k] ??= (t, ...args) => {
+      return Reflect[k](t(), ...args);
+    };
+  }
+});
 const debug = ReactiveContext.create(false, "debug-scope");
 export {
   Case,
@@ -243,5 +250,5 @@ export {
   toSetter,
   toSignal,
   untrackCall,
-  unwrapSignal
+  unwrap
 };

package/dist/index.umd.js

@@ -56,6 +56,16 @@
       return out;
     }
   }
+  function runWithContext(ctx2, value, f) {
+    return solidJs.createRoot((d) => {
+      try {
+        (solidJs.getOwner().context ??= {})[ctx2.id] = value;
+        return f(value === void 0 ? ctx2.defaultValue : value);
+      } finally {
+        d();
+      }
+    });
+  }
   const ctx = ReactiveContext.create(void 0, "case-when");
   const Case = ctx.Provider;
   function When(props) {
@@ -143,6 +153,42 @@
       }
     });
   }
+  function untrackCall(f, ...args) {
+    return solidJs.untrack(() => f.apply(this, args));
+  }
+  function refCall(ref, value) {
+    if (!ref)
+      return value;
+    if (typeof ref !== "function")
+      throw new ReferenceError('Il parametro "ref" deve essere stato compilato in una funzione a runtime');
+    ref(value);
+    return value;
+  }
+  function memoProps(obj, keys = Object.keys(obj), equals = false) {
+    const out = {};
+    for (const elm of keys)
+      Object.defineProperty(out, elm, {
+        enumerable: true,
+        get: solidJs.createMemo(() => obj[elm], void 0, {
+          equals
+        })
+      });
+    return out;
+  }
+  function splitAndMemoProps(obj, keys, equals) {
+    const out = solidJs.splitProps(obj, keys);
+    out[0] = memoProps(out[0], keys, equals);
+    return out;
+  }
+  function createReactiveResource(f) {
+    var refetch;
+    const memo = solidJs.createMemo(f);
+    solidJs.createEffect(solidJs.on(memo, () => refetch?.()));
+    const [get] = [, {
+      refetch
+    }] = solidJs.createResource(memo);
+    return get;
+  }
   function Nest(props) {
     const memo = memoProps(props, ["template", "children"]);
     const content = solidJs.mapArray(() => props.each, (x, i) => {
@@ -179,53 +225,14 @@
   function coalesceSignal([get, set], f) {
     return [() => get() ?? set(f), set];
   }
-  function unwrapSignal(f) {
-    return [() => f()[0](), (x) => f()[1](x)];
-  }
-  function untrackCall(f, ...args) {
-    return solidJs.untrack(() => f.apply(this, args));
-  }
-  function refCall(ref, value) {
-    if (!ref)
-      return value;
-    if (typeof ref !== "function")
-      throw new ReferenceError('Il parametro "ref" deve essere stato compilato in una funzione a runtime');
-    ref(value);
-    return value;
-  }
-  function memoProps(obj, keys = Object.keys(obj)) {
-    const out = {};
-    for (const elm of keys)
-      Object.defineProperty(out, elm, {
-        enumerable: true,
-        get: solidJs.createMemo(() => obj[elm])
-      });
-    return out;
-  }
-  function splitAndMemoProps(obj, keys) {
-    const out = solidJs.splitProps(obj, keys);
-    out[0] = memoProps(out[0], keys);
-    return out;
-  }
-  function runWithContext(ctx2, value, f) {
-    return solidJs.createRoot((d) => {
-      try {
-        (solidJs.getOwner().context ??= {})[ctx2.id] = value;
-        return f(value === void 0 ? ctx2.defaultValue : value);
-      } finally {
-        d();
-      }
-    });
-  }
-  function createReactiveResource(f) {
-    var refetch;
-    const memo = solidJs.createMemo(f);
-    solidJs.createEffect(solidJs.on(memo, () => refetch?.()));
-    const [get] = [, {
-      refetch
-    }] = solidJs.createResource(memo);
-    return get;
-  }
+  const unwrap = (f) => new Proxy(f, HANDLER);
+  const HANDLER = new Proxy({}, {
+    get(cache, k) {
+      return cache[k] ??= (t, ...args) => {
+        return Reflect[k](t(), ...args);
+      };
+    }
+  });
   const debug = ReactiveContext.create(false, "debug-scope");
   exports2.Case = Case;
   exports2.Nest = Nest;
@@ -244,6 +251,6 @@
   exports2.toSetter = toSetter;
   exports2.toSignal = toSignal;
   exports2.untrackCall = untrackCall;
-  exports2.unwrapSignal = unwrapSignal;
+  exports2.unwrap = unwrap;
   Object.defineProperty(exports2, Symbol.toStringTag, { value: "Module" });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "solid-ctrl-flow",
-  "version": "1.0.37",
+  "version": "1.0.39",
   "description": "Control flow components for solid-js",
   "author": "AFatNiBBa",
   "license": "ISC",

package/readMe.md

@@ -150,9 +150,6 @@ Functions that create bindings between `Signal`s
 > 
 > #### `coalesceSignal()`
 > Creates a non nullable `Signal` from a nullable one
-> 
-> #### `unwrapSignal()`
-> Calls an `Accessor` to a `Signal` maintaining its reactivity
 
 ### `ReactiveContext.create()`
 Method that creates a reactive version of a solid `Context` with some additional built-in functionalities
@@ -163,6 +160,12 @@ const valueAccessorForTheCurrentOwner = ctx.read;
 const value = ctx();
 ```
 
+### `runWithContext()`
+Creates a context scope that persists for the duration of a function
+
+### `unwrap()`
+Calls an `Accessor` maintaining its reactivity
+
 ### `debug()`
 Allows you to define ui section that are only visible in debug or NOT in debug
 ```tsx
@@ -189,8 +192,5 @@ Creates a partial version of an object with memoized remaining properties
 ### `splitAndMemoProps()`
 Like `splitProps()` but memoizes the whole local part
 
-### `runWithContext()`
-Creates a context scope that persists for the duration of a function
-
 ### `createReactiveResource()`
 Like `createResource()` but the provided function will be reactive