solid-ctrl-flow 6.0.0 → 6.1.1

package/dist/index.d.ts

@@ -11,6 +11,14 @@ export declare function Case(props: ParentProps<{
     value: unknown;
 }>): JSX;
 
+/**
+ * Runs {@link f} and ensures that its reactive resources are cleaned up not only when the current {@link Owner} is disposed, but also when the provided one is
+ * @param outer The {@link Owner} for which to listen for its disposal
+ * @param f The function to run
+ * @return The same thing {@link f} returned
+ */
+export declare function disposeWithOwner<T>(outer: Owner, f: Accessor<T>): T;
+
 /**
  * Eventually wraps its content into a template if a certain condition is met.
  * If you set {@link Standard.recycled} to `true`, the content will be memoized in the beginning and will be recycled even if the wrapper changes.
@@ -55,17 +63,23 @@ export declare class Extractor {
     constructor(name?: string);
     readonly ctx: Context<State | undefined>;
     Joint: (props: {
-        children?: JSX.Element;
-    }) => JSX.Element;
+        children?: JSX;
+    }) => JSX;
     Dest: (props: {
-        children?: JSX.Element;
-    }) => JSX.Element;
-    Source: (props: Info) => JSX.Element;
+        children?: JSX;
+    }) => JSX;
+    Source: (props: Info) => JSX;
     SameContextSource: (props: {
         order?: number | undefined;
     } & {
-        children?: JSX.Element;
-    }) => JSX.Element;
+        children?: JSX;
+    }) => JSX;
+    /**
+     * Returns the number of sources available for the current {@link Extractor}.
+     * It's a getter that returns a function that will be bound to the {@link Owner} in which the getter was called.
+     * If the current {@link Owner} is NOT under a {@link Joint}, it will return `undefined`
+     */
+    get getSourceCount(): (() => number) | undefined;
     /**
      * Returns the number of destinations available for the current {@link Extractor}.
      * It's a getter that returns a function that will be bound to the {@link Owner} in which the getter was called.
@@ -193,9 +207,12 @@ declare type Standard<T> = ParentProps<{
 declare class State {
     #private;
     get sources(): OrderedLinkedList<Info>;
+    get sourceCount(): number;
     get destCount(): number;
-    shift(k: number): void;
     force(): void;
+    shiftSource(k: number): void;
+    shiftDest(k: number): void;
+    shiftSourceAndForce(k: number): void;
 }
 
 /** Type of an element wrapping call-back which accepts an additional parameter */

package/dist/index.mjs

@@ -1,8 +1,16 @@
-import { untrack, createRoot, getOwner, createMemo, Show, createContext, useContext, onCleanup, For, createRenderEffect, on, splitProps, createSignal, createSelector, equalFn, Match, runWithOwner } from "solid-js";
+import { untrack, getOwner, createRoot, runWithOwner, onCleanup, createMemo, Show, createContext, useContext, For, createRenderEffect, on, splitProps, createSignal, batch, createSelector, equalFn, Match } from "solid-js";
 import { createComponent, memo, mergeProps, spread } from "solid-js/web";
 function untrackCall(f, ...args) {
   return untrack(() => f.apply(this, args));
 }
+function disposeWithOwner(outer, f) {
+  const inner = getOwner();
+  return createRoot((d) => {
+    runWithOwner(outer, () => onCleanup(d));
+    runWithOwner(inner, () => onCleanup(d));
+    return f();
+  });
+}
 function runWithContext(ctx2, value, f) {
   return createRoot((d) => {
     try {
@@ -85,24 +93,37 @@ const COMPARATOR = (a, b) => (a.order ?? 0) - (b.order ?? 0);
 const SOURCES_OPTS = {
   internal: true,
   equals: false
-}, DEST_COUNT_OPTS = {
+}, COUNT_OPTS = {
   internal: true
 };
 class State {
   #sources = createSignal(new OrderedLinkedList(), SOURCES_OPTS);
-  #destCount = createSignal(0, DEST_COUNT_OPTS);
+  #sourceCount = createSignal(0, COUNT_OPTS);
+  #destCount = createSignal(0, COUNT_OPTS);
   get sources() {
     return this.#sources[0]();
   }
+  get sourceCount() {
+    return this.#sourceCount[0]();
+  }
   get destCount() {
     return this.#destCount[0]();
   }
-  shift(k) {
-    this.#destCount[1]((v) => v + k);
-  }
   force() {
     this.#sources[1]((v) => v);
   }
+  shiftSource(k) {
+    this.#sourceCount[1]((v) => v + k);
+  }
+  shiftDest(k) {
+    this.#destCount[1]((v) => v + k);
+  }
+  shiftSourceAndForce(k) {
+    batch(() => {
+      this.shiftSource(k);
+      this.force();
+    });
+  }
 }
 class Extractor {
   constructor(name) {
@@ -115,6 +136,15 @@ class Extractor {
   Dest = Dest.bind(this);
   Source = Source.bind(this);
   SameContextSource = SameContextSource.bind(this);
+  /**
+   * Returns the number of sources available for the current {@link Extractor}.
+   * It's a getter that returns a function that will be bound to the {@link Owner} in which the getter was called.
+   * If the current {@link Owner} is NOT under a {@link Joint}, it will return `undefined`
+   */
+  get getSourceCount() {
+    const state = useContext(this.ctx);
+    return state && (() => state.sourceCount);
+  }
   /**
    * Returns the number of destinations available for the current {@link Extractor}.
    * It's a getter that returns a function that will be bound to the {@link Owner} in which the getter was called.
@@ -138,8 +168,8 @@ function Dest(props) {
   const state = useContext(this.ctx);
   if (!state)
     return memo(() => props.children);
-  onCleanup(() => state.shift(-1));
-  state.shift(1);
+  onCleanup(() => state.shiftDest(-1));
+  state.shiftDest(1);
   return createComponent(For, {
     get each() {
       return [...state.sources];
@@ -158,22 +188,23 @@ function Source(props) {
     sources
   } = state;
   const order = createMemo(() => props.order);
+  const owner = getOwner();
   const info = {
     get order() {
       return order();
     },
     get children() {
-      return props.children;
+      return disposeWithOwner(owner, () => props.children);
     }
   };
   const node = new OrderedLinkedListNode(info);
   createRenderEffect(on(order, () => {
     onCleanup(() => {
       node.remove();
-      state.force();
+      state.shiftSourceAndForce(-1);
     });
     sources.add(node, COMPARATOR);
-    state.force();
+    state.shiftSourceAndForce(1);
   }));
 }
 function SameContextSource(props) {
@@ -269,6 +300,7 @@ export {
   OrderedLinkedListNode,
   SameContext,
   Spread,
+  disposeWithOwner,
   memoProps,
   runWithContext,
   splitAndMemoProps,

package/dist/index.umd.js

@@ -5,6 +5,14 @@
   function untrackCall(f, ...args) {
     return solidJs.untrack(() => f.apply(this, args));
   }
+  function disposeWithOwner(outer, f) {
+    const inner = solidJs.getOwner();
+    return solidJs.createRoot((d) => {
+      solidJs.runWithOwner(outer, () => solidJs.onCleanup(d));
+      solidJs.runWithOwner(inner, () => solidJs.onCleanup(d));
+      return f();
+    });
+  }
   function runWithContext(ctx2, value, f) {
     return solidJs.createRoot((d) => {
       try {
@@ -87,24 +95,37 @@
   const SOURCES_OPTS = {
     internal: true,
     equals: false
-  }, DEST_COUNT_OPTS = {
+  }, COUNT_OPTS = {
     internal: true
   };
   class State {
     #sources = solidJs.createSignal(new OrderedLinkedList(), SOURCES_OPTS);
-    #destCount = solidJs.createSignal(0, DEST_COUNT_OPTS);
+    #sourceCount = solidJs.createSignal(0, COUNT_OPTS);
+    #destCount = solidJs.createSignal(0, COUNT_OPTS);
     get sources() {
       return this.#sources[0]();
     }
+    get sourceCount() {
+      return this.#sourceCount[0]();
+    }
     get destCount() {
       return this.#destCount[0]();
     }
-    shift(k) {
-      this.#destCount[1]((v) => v + k);
-    }
     force() {
       this.#sources[1]((v) => v);
     }
+    shiftSource(k) {
+      this.#sourceCount[1]((v) => v + k);
+    }
+    shiftDest(k) {
+      this.#destCount[1]((v) => v + k);
+    }
+    shiftSourceAndForce(k) {
+      solidJs.batch(() => {
+        this.shiftSource(k);
+        this.force();
+      });
+    }
   }
   class Extractor {
     constructor(name) {
@@ -117,6 +138,15 @@
     Dest = Dest.bind(this);
     Source = Source.bind(this);
     SameContextSource = SameContextSource.bind(this);
+    /**
+     * Returns the number of sources available for the current {@link Extractor}.
+     * It's a getter that returns a function that will be bound to the {@link Owner} in which the getter was called.
+     * If the current {@link Owner} is NOT under a {@link Joint}, it will return `undefined`
+     */
+    get getSourceCount() {
+      const state = solidJs.useContext(this.ctx);
+      return state && (() => state.sourceCount);
+    }
     /**
      * Returns the number of destinations available for the current {@link Extractor}.
      * It's a getter that returns a function that will be bound to the {@link Owner} in which the getter was called.
@@ -140,8 +170,8 @@
     const state = solidJs.useContext(this.ctx);
     if (!state)
       return web.memo(() => props.children);
-    solidJs.onCleanup(() => state.shift(-1));
-    state.shift(1);
+    solidJs.onCleanup(() => state.shiftDest(-1));
+    state.shiftDest(1);
     return web.createComponent(solidJs.For, {
       get each() {
         return [...state.sources];
@@ -160,22 +190,23 @@
       sources
     } = state;
     const order = solidJs.createMemo(() => props.order);
+    const owner = solidJs.getOwner();
     const info = {
       get order() {
         return order();
       },
       get children() {
-        return props.children;
+        return disposeWithOwner(owner, () => props.children);
       }
     };
     const node = new OrderedLinkedListNode(info);
     solidJs.createRenderEffect(solidJs.on(order, () => {
       solidJs.onCleanup(() => {
         node.remove();
-        state.force();
+        state.shiftSourceAndForce(-1);
       });
       sources.add(node, COMPARATOR);
-      state.force();
+      state.shiftSourceAndForce(1);
     }));
   }
   function SameContextSource(props) {
@@ -270,6 +301,7 @@
   exports2.OrderedLinkedListNode = OrderedLinkedListNode;
   exports2.SameContext = SameContext;
   exports2.Spread = Spread;
+  exports2.disposeWithOwner = disposeWithOwner;
   exports2.memoProps = memoProps;
   exports2.runWithContext = runWithContext;
   exports2.splitAndMemoProps = splitAndMemoProps;

package/package.json

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

package/readMe.md

@@ -196,6 +196,8 @@ return <>
   </e.Joint>
 </>
 ```
+> Same applies to `Extractor.getSourceCount()`
+
 You can use `Extractor.SameContextSource` to automate the process of using a `SameContext` inside a `Extractor.Source`. When in doubt, use `Extractor.SameContextSource` instead of `Extractor.Source`
 ```tsx
 const e = new Extractor(), ctx = createContext(1);
@@ -233,5 +235,8 @@ Like `splitProps()` but passes the every part except the last one to [`memoProps
 ### `untrackCall()`
 Calls a function untracking what happens inside of it but not what gets passed as its argument
 
+### `disposeWithOwner()`
+Calls a function in a way that makes it so that the reactive resources it creates are managed by 2 `Owner`s
+
 ### `runWithContext()`
 Creates a context scope that persists for the duration of a function