solid-ctrl-flow 1.0.9 → 1.0.11

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { Accessor } from 'solid-js';
+import { Context } from 'solid-js';
 import { JSX } from 'solid-js';
 
 /**
@@ -61,9 +62,7 @@ export declare function createExtractor(name?: string): {
     /** Bound {@link Dest} */
     Dest: () => JSX.Element;
     /** Bound {@link Source} */
-    Source: (props: {
-        children: JSX.Element;
-    }) => JSX.Element;
+    Source: (props: Info) => JSX.Element;
     /** Bound {@link Joint} */
     Joint: (props: {
         children: JSX.Element;
@@ -87,6 +86,13 @@ export declare namespace Debug {
     const isDebug: Accessor<boolean>;
 }
 
+/** Informations about a {@link Source} component */
+declare type Info = {
+    /** Order of the current source if there are many */
+    order?: number;
+    children: JSX.Element;
+};
+
 /**
  * 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}
@@ -95,6 +101,15 @@ export declare namespace Debug {
  */
 export declare function memoProps<T, K extends readonly (keyof T)[] = (keyof T)[]>(obj: T, keys?: K): Pick<T, K[number]>;
 
+/**
+ * Executes {@link f} with the provided {@link Context}
+ * @param ctx The context to which to set the value
+ * @param value The value for the context
+ * @param f The function to run
+ * @returns The same thing {@link f} returned
+ */
+export declare function runWithContext<T, R>(ctx: Context<T>, value: T, f: (x: T) => R): Promise<R>;
+
 /**
  * Esecutes {@link splitProps} and memoizes the first of the two returned objects
  * @param obj Object to split and partially memoize
@@ -102,6 +117,16 @@ export declare function memoProps<T, K extends readonly (keyof T)[] = (keyof T)[
  */
 export declare function splitAndMemoProps<T extends object, K extends readonly (keyof T)[]>(obj: T, keys: K): readonly [Pick<Pick<T, Extract<K, readonly (keyof T)[]>[number]>, K[number]>, Omit<T, K[number]>];
 
+/**
+ * Executes {@link f} untracking it.
+ * Due to the fact that the function is passed as input, it does not untrack its changes (It's intentional)
+ * @param this The same thing that {@link f} wants as `this`
+ * @param f The function to call
+ * @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;
+
 /** Like a {@link Match} but gets the value from the closest {@link Case} ancestor */
 export declare function When(props: {
     value: unknown;

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { createContext, createMemo, createComponent, useContext, Match, mergeProps, onCleanup, Show, splitProps } from "solid-js";
+import { createContext, createMemo, createComponent, useContext, Match, mergeProps, onCleanup, For, Show, splitProps, createRoot, getOwner, untrack } from "solid-js";
 import { createMutable } from "solid-js/store";
 const ctx$1 = createContext(() => void 0, {
   name: "case-when"
@@ -65,22 +65,34 @@ function Dest() {
     return;
   obj.attached++;
   onCleanup(() => obj.attached--);
-  return createMemo(() => obj.source);
+  return createComponent(For, {
+    get each() {
+      return obj.source.sort((a, b) => a.order - b.order);
+    },
+    children: (x) => createMemo(() => x.children)
+  });
 }
 function Source(props) {
   const obj = useContext(this);
   if (!obj)
     return props.children;
-  if (obj.source)
-    throw new Error("An extractor can't have more than one source");
-  obj.source = () => props.children;
-  onCleanup(() => obj.source = void 0);
+  const order = createMemo(() => props.order || 0);
+  const info = {
+    get order() {
+      return order();
+    },
+    get children() {
+      return props.children;
+    }
+  };
+  obj.source.push(info);
+  onCleanup(() => obj.source.splice(obj.source.indexOf(info), 1));
   return createComponent(Show, {
     get when() {
       return !obj.attached;
     },
     get children() {
-      return obj.source();
+      return info.children;
     }
   });
 }
@@ -89,7 +101,8 @@ function Joint(props) {
     Provider
   } = this;
   const obj = createMutable({
-    attached: 0
+    attached: 0,
+    source: []
   });
   return createComponent(Provider, {
     value: obj,
@@ -101,21 +114,36 @@ function Joint(props) {
 function memoProps(obj, keys = Object.keys(obj)) {
   const out = {};
   for (const elm of keys)
-    Object.defineProperty(out, elm, {
-      enumerable: true,
-      get: createMemo(() => obj[elm])
-    });
+    Object.defineProperty(out, elm, { enumerable: true, get: createMemo(() => obj[elm]) });
   return out;
 }
 function splitAndMemoProps(obj, keys) {
   const [mine, other] = splitProps(obj, keys);
   return [memoProps(mine, keys), other];
 }
+function runWithContext(ctx2, value, f) {
+  return createRoot(async (d) => {
+    try {
+      getOwner().context = { [ctx2.id]: value };
+      const out = f(value);
+      if (out instanceof Promise)
+        return out.finally(d);
+      return d(), out;
+    } catch (ex) {
+      throw d(), ex;
+    }
+  });
+}
+function untrackCall(f, ...args) {
+  return untrack(() => f.apply(this, args));
+}
 export {
   Case,
   Debug,
   When,
   createExtractor,
   memoProps,
-  splitAndMemoProps
+  runWithContext,
+  splitAndMemoProps,
+  untrackCall
 };

package/dist/index.umd.js

@@ -67,22 +67,34 @@
       return;
     obj.attached++;
     solidJs.onCleanup(() => obj.attached--);
-    return solidJs.createMemo(() => obj.source);
+    return solidJs.createComponent(solidJs.For, {
+      get each() {
+        return obj.source.sort((a, b) => a.order - b.order);
+      },
+      children: (x) => solidJs.createMemo(() => x.children)
+    });
   }
   function Source(props) {
     const obj = solidJs.useContext(this);
     if (!obj)
       return props.children;
-    if (obj.source)
-      throw new Error("An extractor can't have more than one source");
-    obj.source = () => props.children;
-    solidJs.onCleanup(() => obj.source = void 0);
+    const order = solidJs.createMemo(() => props.order || 0);
+    const info = {
+      get order() {
+        return order();
+      },
+      get children() {
+        return props.children;
+      }
+    };
+    obj.source.push(info);
+    solidJs.onCleanup(() => obj.source.splice(obj.source.indexOf(info), 1));
     return solidJs.createComponent(solidJs.Show, {
       get when() {
         return !obj.attached;
       },
       get children() {
-        return obj.source();
+        return info.children;
       }
     });
   }
@@ -91,7 +103,8 @@
       Provider
     } = this;
     const obj = store.createMutable({
-      attached: 0
+      attached: 0,
+      source: []
     });
     return solidJs.createComponent(Provider, {
       value: obj,
@@ -103,21 +116,36 @@
   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])
-      });
+      Object.defineProperty(out, elm, { enumerable: true, get: solidJs.createMemo(() => obj[elm]) });
     return out;
   }
   function splitAndMemoProps(obj, keys) {
     const [mine, other] = solidJs.splitProps(obj, keys);
     return [memoProps(mine, keys), other];
   }
+  function runWithContext(ctx2, value, f) {
+    return solidJs.createRoot(async (d) => {
+      try {
+        solidJs.getOwner().context = { [ctx2.id]: value };
+        const out = f(value);
+        if (out instanceof Promise)
+          return out.finally(d);
+        return d(), out;
+      } catch (ex) {
+        throw d(), ex;
+      }
+    });
+  }
+  function untrackCall(f, ...args) {
+    return solidJs.untrack(() => f.apply(this, args));
+  }
   exports2.Case = Case;
   exports2.Debug = Debug;
   exports2.When = When;
   exports2.createExtractor = createExtractor;
   exports2.memoProps = memoProps;
+  exports2.runWithContext = runWithContext;
   exports2.splitAndMemoProps = splitAndMemoProps;
+  exports2.untrackCall = untrackCall;
   Object.defineProperty(exports2, Symbol.toStringTag, { value: "Module" });
 });

package/package.json

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

package/{readme.md → readMe.md}

@@ -120,4 +120,7 @@ Utility functions needed for the components above
 Creates a partial version of an object with memoized remaining properties
 
 ### `splitAndMemoProps()`
-Like `splitProps()` but memoizes the whole local part
+Like `splitProps()` but memoizes the whole local part
+
+### `runWithContext()`
+Creates a context scope that persists for the duration of a function