solid-ctrl-flow 5.1.1 → 6.1.0

package/dist/index.d.ts

@@ -6,12 +6,6 @@ import { Owner } from 'solid-js';
 import { ParentProps } from 'solid-js';
 import { splitProps } from 'solid-js';
 
-/** Minimal representation of an event target */
-declare type AbstractEventTarget<K, F> = {
-    addEventListener(k: K, f: F): void;
-    removeEventListener(k: K, f: F): void;
-};
-
 /** Like a {@link Match} but gets the value from the closest {@link On} ancestor */
 export declare function Case(props: ParentProps<{
     value: unknown;
@@ -61,17 +55,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.
@@ -157,16 +157,6 @@ export declare class OrderedLinkedListNode<T> extends OrderedLinkedList<T> {
     remove(): void;
 }
 
-/**
- * Adds the {@link f} event listener to the {@link k} event of the {@link obj} emitter and removes it when the current reactive context is disposed
- * @param obj The emitter to which to add the event listener
- * @param k The key of the event for which to add the listener
- * @param f The function to call when the event is emitted
- */
-export declare function registerEventListener<K extends keyof HTMLElementEventMap>(obj: HTMLElement, type: K, listener: (this: HTMLElement, e: HTMLElementEventMap[K]) => any): void;
-
-export declare function registerEventListener<K, F>(obj: AbstractEventTarget<K, F>, k: K, f: F): void;
-
 /**
  * Executes {@link f} with the provided value for the specified {@link Context}.
  * You can pass `undefined` to {@link value} in order to get back the default value for {@link ctx}.
@@ -209,9 +199,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,12 +1,8 @@
-import { untrack, onCleanup, createRoot, getOwner, createMemo, Show, createContext, useContext, For, createRenderEffect, on, splitProps, createSignal, createSelector, equalFn, Match, runWithOwner } from "solid-js";
+import { untrack, createRoot, getOwner, createMemo, Show, createContext, useContext, onCleanup, For, createRenderEffect, on, splitProps, createSignal, batch, createSelector, equalFn, Match, runWithOwner } from "solid-js";
 import { createComponent, memo, mergeProps, spread } from "solid-js/web";
 function untrackCall(f, ...args) {
   return untrack(() => f.apply(this, args));
 }
-function registerEventListener(obj, k, f) {
-  obj.addEventListener(k, f);
-  onCleanup(() => obj.removeEventListener(k, f));
-}
 function runWithContext(ctx2, value, f) {
   return createRoot((d) => {
     try {
@@ -89,24 +85,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) {
@@ -119,6 +128,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.
@@ -142,8 +160,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];
@@ -174,10 +192,10 @@ function Source(props) {
   createRenderEffect(on(order, () => {
     onCleanup(() => {
       node.remove();
-      state.force();
+      state.shiftSourceAndForce(-1);
     });
     sources.add(node, COMPARATOR);
-    state.force();
+    state.shiftSourceAndForce(1);
   }));
 }
 function SameContextSource(props) {
@@ -274,7 +292,6 @@ export {
   SameContext,
   Spread,
   memoProps,
-  registerEventListener,
   runWithContext,
   splitAndMemoProps,
   untrackCall,

package/dist/index.umd.js

@@ -5,10 +5,6 @@
   function untrackCall(f, ...args) {
     return solidJs.untrack(() => f.apply(this, args));
   }
-  function registerEventListener(obj, k, f) {
-    obj.addEventListener(k, f);
-    solidJs.onCleanup(() => obj.removeEventListener(k, f));
-  }
   function runWithContext(ctx2, value, f) {
     return solidJs.createRoot((d) => {
       try {
@@ -91,24 +87,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) {
@@ -121,6 +130,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.
@@ -144,8 +162,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];
@@ -176,10 +194,10 @@
     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) {
@@ -275,7 +293,6 @@
   exports2.SameContext = SameContext;
   exports2.Spread = Spread;
   exports2.memoProps = memoProps;
-  exports2.registerEventListener = registerEventListener;
   exports2.runWithContext = runWithContext;
   exports2.splitAndMemoProps = splitAndMemoProps;
   exports2.untrackCall = untrackCall;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "solid-ctrl-flow",
-  "version": "5.1.1",
+  "version": "6.1.0",
   "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,8 +235,5 @@ 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
 
-### `registerEventListener()`
-Adds an event listener and registers its removal
-
 ### `runWithContext()`
 Creates a context scope that persists for the duration of a function