solid-ctrl-flow 1.0.26 → 1.0.28

package/dist/index.d.ts

@@ -2,12 +2,17 @@ import { Accessor } from 'solid-js';
 import { Context } from 'solid-js';
 import { EffectFunction } from 'solid-js';
 import { JSX } from 'solid-js';
+import { Ref } from 'solid-js';
 import { Resource } from 'solid-js';
 import { Setter } from 'solid-js';
 import { Signal } from 'solid-js';
 
 /**
- * Creates a one-way binding between two {@link Signal}s
+ * Creates a one-way binding between two {@link Signal}s.
+ * The function uses {@link createRenderEffect}, which means that:
+ * - As soon as the function is done executing the two {@link Signal}s will have the same value
+ * - If {@link source} changes, {@link dest} wont be instantly updated
+ * - If the current owner gets disposed before {@link dest} is updated, it never will
  * @param source The source of the binding
  * @param dest The destination of the binding
  * @param to Conversion function from {@link S} to {@link D}
@@ -18,7 +23,7 @@ export declare function bind<S>(source: Signal<S>, dest: Signal<S>): () => void;
 export declare function bind<S, D>(source: Signal<S>, dest: Signal<D>, to: Convert<S, D>): () => void;
 
 /**
- * Creates a two-way binding between two {@link Signal}s
+ * Creates a two-way binding between two {@link Signal}s calling {@link bind} two times
  * @param source The source of the binding
  * @param dest The destination of the binding
  * @param to Conversion function from {@link S} to {@link D}
@@ -68,7 +73,7 @@ export declare function Case(props: {
  * Returns a {@link Signal} that applies the `??=` operator to the input one.
  * If the getter of {@link param0} is like "x", then the result one is like "(x ??= {@link f}())"
  * @param param0 The {@link Signal} to which to coalesce the getter
- * @param f A function that creates a new {@link T}
+ * @param f An {@link Accessor} to the value to use when there's a nullish value
  */
 export declare function coalesceSignal<T>([get, set]: Signal<T | undefined>, f: Accessor<T>): Signal<T>;
 
@@ -152,6 +157,11 @@ export declare const Debug: {
     read: Accessor<boolean>;
 };
 
+/** Component that gives you the owner {@link Document} */
+export declare function Doc(props: {
+    ref: Ref<Document>;
+}): Text;
+
 /** Informations about a {@link Source} component */
 declare type Info = {
     /** Order of the current source if there are many */
@@ -167,6 +177,15 @@ declare type Info = {
  */
 export declare function memoProps<T, K extends readonly (keyof T)[] = (keyof T)[]>(obj: T, keys?: K): Pick<T, K[number]>;
 
+/**
+ * Executes a {@link Ref}.
+ * Throws a {@link ReferenceError} if {@link ref} its not a function at runtime (Which should never be the case thanks to the solid compiler)
+ * @param ref The function to execute
+ * @param value The value to pass to the function
+ * @returns The same value of {@link value}
+ */
+export declare function refCall<T, U extends T = T>(ref: Ref<T> | undefined, value: U): U;
+
 /**
  * Executes {@link f} with the provided {@link Context}
  * @param ctx The context to which to set the value
@@ -205,7 +224,7 @@ export declare function toSignal<T, K extends keyof T>(obj: Accessor<T>, k: Acce
  * @param args Arguments for calling {@link f}
  * @returns The same thing {@link f} returned
  */
-export declare function untrackCall<F extends (...args: any[]) => any>(this: ThisParameterType<F>, f: F, ...args: Parameters<F>): any;
+export declare function untrackCall<F extends (...args: any[]) => any>(this: ThisParameterType<F>, f: F, ...args: Parameters<F>): ReturnType<F>;
 
 /**
  * Calls {@link f} maintaining its reactivity

package/dist/index.mjs

@@ -1,8 +1,16 @@
-import { untrack, createMemo, splitProps, createEffect, on, createResource, createContext, createRoot, getOwner, createComponent, useContext, createRenderEffect, onCleanup, Match, mergeProps, For, Show } from "solid-js";
+import { untrack, createMemo, splitProps, createContext, createRoot, getOwner, createEffect, on, createResource, createComponent, useContext, createRenderEffect, onCleanup, Match, mergeProps, For, Show, onMount } from "solid-js";
 import { createMutable } from "solid-js/store";
 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)
@@ -17,15 +25,6 @@ function splitAndMemoProps(obj, keys) {
   out[0] = memoProps(out[0], keys);
   return out;
 }
-function createReactiveResource(f) {
-  var refetch;
-  const memo = createMemo(f);
-  createEffect(on(memo, () => refetch?.()));
-  const [get] = [, {
-    refetch
-  }] = createResource(memo);
-  return get;
-}
 function createOption(init, def = init, name) {
   const prop = "read";
   const ctx2 = createContext(() => init, {
@@ -58,6 +57,15 @@ function runWithContext(ctx2, value, f) {
     }
   });
 }
+function createReactiveResource(f) {
+  var refetch;
+  const memo = createMemo(f);
+  createEffect(on(memo, () => refetch?.()));
+  const [get] = [, {
+    refetch
+  }] = createResource(memo);
+  return get;
+}
 const IDENTITY = (x) => x;
 function bind([get], [, set], to = IDENTITY) {
   const d = createRoot((d2) => (createRenderEffect(on(get, (x) => set((prev) => to(x, prev)))), d2));
@@ -180,9 +188,15 @@ function Joint(props) {
   });
 }
 const Debug = createOption(false, true, "debug-scope");
+function Doc(props) {
+  const node = document.createTextNode("");
+  onMount(() => (refCall(props.ref, node.ownerDocument), node.remove()));
+  return node;
+}
 export {
   Case,
   Debug,
+  Doc,
   When,
   bind,
   bindTwoWay,
@@ -191,6 +205,7 @@ export {
   createOption,
   createReactiveResource,
   memoProps,
+  refCall,
   runWithContext,
   splitAndMemoProps,
   toSetter,

package/dist/index.umd.js

@@ -5,6 +5,14 @@
   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)
@@ -19,15 +27,6 @@
     out[0] = memoProps(out[0], keys);
     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 createOption(init, def = init, name) {
     const prop = "read";
     const ctx2 = solidJs.createContext(() => init, {
@@ -60,6 +59,15 @@
       }
     });
   }
+  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 IDENTITY = (x) => x;
   function bind([get], [, set], to = IDENTITY) {
     const d = solidJs.createRoot((d2) => (solidJs.createRenderEffect(solidJs.on(get, (x) => set((prev) => to(x, prev)))), d2));
@@ -182,8 +190,14 @@
     });
   }
   const Debug = createOption(false, true, "debug-scope");
+  function Doc(props) {
+    const node = document.createTextNode("");
+    solidJs.onMount(() => (refCall(props.ref, node.ownerDocument), node.remove()));
+    return node;
+  }
   exports2.Case = Case;
   exports2.Debug = Debug;
+  exports2.Doc = Doc;
   exports2.When = When;
   exports2.bind = bind;
   exports2.bindTwoWay = bindTwoWay;
@@ -192,6 +206,7 @@
   exports2.createOption = createOption;
   exports2.createReactiveResource = createReactiveResource;
   exports2.memoProps = memoProps;
+  exports2.refCall = refCall;
   exports2.runWithContext = runWithContext;
   exports2.splitAndMemoProps = splitAndMemoProps;
   exports2.toSetter = toSetter;

package/package.json

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

package/readMe.md

@@ -47,6 +47,15 @@ return <>
 </>
 ```
 
+### `Doc`
+Gives back the current document
+```tsx
+var doc: Document;
+return <>
+  <Doc ref={doc} />
+</>
+```
+
 ### `createExtractor()`
 Creates a context for components that may need to be out of their parent in certain conditions.
 If you have this component
@@ -148,17 +157,20 @@ Utility functions needed for the components above
 ### `untrackCall()`
 Calls a function untracking what happens inside of it but not what gets passed as its argument
 
+### `refCall()`
+Executes a `Ref`
+
 ### `memoProps()`
 Creates a partial version of an object with memoized remaining properties
 
 ### `splitAndMemoProps()`
 Like `splitProps()` but memoizes the whole local part
 
-### `createReactiveResource()`
-Like `createResource()` but the provided function will be reactive
-
 ### `createOption()`
 Allows you to create simple reactive contexts; For example `Debug` is made with it
 
 ### `runWithContext()`
-Creates a context scope that persists for the duration of a function
+Creates a context scope that persists for the duration of a function
+
+### `createReactiveResource()`
+Like `createResource()` but the provided function will be reactive