@aweebit/react-essentials 0.10.4 → 0.10.5

package/README.md

@@ -20,7 +20,7 @@
 const useEventListener: UseEventListener;
 ```
 
-Defined in: [hooks/useEventListener.ts:135](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/hooks/useEventListener.ts#L135)
+Defined in: [hooks/useEventListener.ts:135](https://github.com/aweebit/react-essentials/blob/v0.10.5/src/hooks/useEventListener.ts#L135)
 
 Adds `handler` as a listener for the event `eventName` of `target` with the
 provided `options` applied
@@ -71,7 +71,7 @@ function useReducerWithDeps<S, A>(
 ): [S, ActionDispatch<A>];
 ```
 
-Defined in: [hooks/useReducerWithDeps.ts:59](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/hooks/useReducerWithDeps.ts#L59)
+Defined in: [hooks/useReducerWithDeps.ts:59](https://github.com/aweebit/react-essentials/blob/v0.10.5/src/hooks/useReducerWithDeps.ts#L59)
 
 `useReducer` hook with an additional dependency array `deps` that resets the
 state to `initialState` when dependencies change
@@ -214,7 +214,7 @@ function useStateWithDeps<S>(
 ): [S, Dispatch<SetStateAction<S>>];
 ```
 
-Defined in: [hooks/useStateWithDeps.ts:62](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/hooks/useStateWithDeps.ts#L62)
+Defined in: [hooks/useStateWithDeps.ts:62](https://github.com/aweebit/react-essentials/blob/v0.10.5/src/hooks/useStateWithDeps.ts#L62)
 
 `useState` hook with an additional dependency array `deps` that resets the
 state to `initialState` when dependencies change
@@ -344,7 +344,7 @@ Dependencies that reset the state to `initialState`
 function contextualize(children): ContextualizePipe;
 ```
 
-Defined in: [misc/contextualize.tsx:79](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/misc/contextualize.tsx#L79)
+Defined in: [misc/contextualize.tsx:79](https://github.com/aweebit/react-essentials/blob/v0.10.5/src/misc/contextualize.tsx#L79)
 
 An alternative way to provide context values to component trees that avoids
 ever-increasing indentation
@@ -444,7 +444,7 @@ function createSafeContext<T>(): <DisplayName>(displayName) => {
 };
 ```
 
-Defined in: [misc/createSafeContext.ts:62](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/misc/createSafeContext.ts#L62)
+Defined in: [misc/createSafeContext.ts:62](https://github.com/aweebit/react-essentials/blob/v0.10.5/src/misc/createSafeContext.ts#L62)
 
 For a given type `T`, returns a function that produces both a context of that
 type and a hook that returns the current context value if one was provided,
@@ -586,10 +586,10 @@ A function that accepts a single string argument `displayName` (e.g.
 ## wrapJSX()
 
 ```ts
-function wrapJSX(children): JSXWrapPipe;
+function wrapJSX<Children>(children): JSXWrapPipe<Children>;
 ```
 
-Defined in: [misc/wrapJSX.tsx:94](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/misc/wrapJSX.tsx#L94)
+Defined in: [misc/wrapJSX.tsx:99](https://github.com/aweebit/react-essentials/blob/v0.10.5/src/misc/wrapJSX.tsx#L99)
 
 An alternative way to compose JSX that avoids ever-increasing indentation
 
@@ -629,6 +629,25 @@ createRoot(document.getElementById('root')!).render(
 );
 ```
 
+### Type Parameters
+
+<table>
+<thead>
+<tr>
+<th>Type Parameter</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>
+
+`Children` _extends_ `ReactNode`
+
+</td>
+</tr>
+</tbody>
+</table>
+
 ### Parameters
 
 <table>
@@ -648,7 +667,7 @@ createRoot(document.getElementById('root')!).render(
 </td>
 <td>
 
-`ReactNode`
+`Children`
 
 </td>
 <td>
@@ -662,7 +681,7 @@ The children to wrap
 
 ### Returns
 
-[`JSXWrapPipe`](#jsxwrappipe)
+[`JSXWrapPipe`](#jsxwrappipe)\<`Children`\>
 
 An object with the following properties:
 
@@ -685,7 +704,7 @@ type UseEventListener = UseEventListenerWithImplicitWindowTarget &
   UseEventListenerWithAnyExplicitTarget;
 ```
 
-Defined in: [hooks/useEventListener.ts:12](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/hooks/useEventListener.ts#L12)
+Defined in: [hooks/useEventListener.ts:12](https://github.com/aweebit/react-essentials/blob/v0.10.5/src/hooks/useEventListener.ts#L12)
 
 The type of [`useEventListener`](#useeventlistener)
 
@@ -704,7 +723,7 @@ The type of [`useEventListener`](#useeventlistener)
 type UseEventListenerWithImplicitWindowTarget = <K>(...args) => void;
 ```
 
-Defined in: [hooks/useEventListener.ts:21](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/hooks/useEventListener.ts#L21)
+Defined in: [hooks/useEventListener.ts:21](https://github.com/aweebit/react-essentials/blob/v0.10.5/src/hooks/useEventListener.ts#L21)
 
 ### Type Parameters
 
@@ -772,7 +791,7 @@ type UseEventListenerWithExplicitGlobalTarget =
     UseEventListenerWithExplicitTarget<MathMLElement, MathMLElementEventMap>;
 ```
 
-Defined in: [hooks/useEventListener.ts:32](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/hooks/useEventListener.ts#L32)
+Defined in: [hooks/useEventListener.ts:32](https://github.com/aweebit/react-essentials/blob/v0.10.5/src/hooks/useEventListener.ts#L32)
 
 ### See
 
@@ -789,7 +808,7 @@ type UseEventListenerWithExplicitTarget<Target, EventMap> = <T, K>(
 ) => void;
 ```
 
-Defined in: [hooks/useEventListener.ts:44](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/hooks/useEventListener.ts#L44)
+Defined in: [hooks/useEventListener.ts:44](https://github.com/aweebit/react-essentials/blob/v0.10.5/src/hooks/useEventListener.ts#L44)
 
 ### Type Parameters
 
@@ -888,7 +907,7 @@ type UseEventListenerWithAnyExplicitTarget = UseEventListenerWithExplicitTarget<
 >;
 ```
 
-Defined in: [hooks/useEventListener.ts:56](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/hooks/useEventListener.ts#L56)
+Defined in: [hooks/useEventListener.ts:56](https://github.com/aweebit/react-essentials/blob/v0.10.5/src/hooks/useEventListener.ts#L56)
 
 ### See
 
@@ -909,7 +928,7 @@ type UseEventListenerWithImplicitWindowTargetArgs<K> =
     : never;
 ```
 
-Defined in: [hooks/useEventListener.ts:64](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/hooks/useEventListener.ts#L64)
+Defined in: [hooks/useEventListener.ts:64](https://github.com/aweebit/react-essentials/blob/v0.10.5/src/hooks/useEventListener.ts#L64)
 
 ### Type Parameters
 
@@ -954,7 +973,7 @@ type UseEventListenerWithExplicitTargetArgs<EventMap, T, K> = [
 ];
 ```
 
-Defined in: [hooks/useEventListener.ts:78](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/hooks/useEventListener.ts#L78)
+Defined in: [hooks/useEventListener.ts:78](https://github.com/aweebit/react-essentials/blob/v0.10.5/src/hooks/useEventListener.ts#L78)
 
 ### Type Parameters
 
@@ -1004,7 +1023,7 @@ type ContextualizePipe = {
 };
 ```
 
-Defined in: [misc/contextualize.tsx:13](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/misc/contextualize.tsx#L13)
+Defined in: [misc/contextualize.tsx:13](https://github.com/aweebit/react-essentials/blob/v0.10.5/src/misc/contextualize.tsx#L13)
 
 The return type of [`contextualize`](#contextualize)
 
@@ -1058,7 +1077,7 @@ The return type of [`contextualize`](#contextualize)
 type ContextualizeWith = <T>(Context, value) => ContextualizePipe;
 ```
 
-Defined in: [misc/contextualize.tsx:23](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/misc/contextualize.tsx#L23)
+Defined in: [misc/contextualize.tsx:23](https://github.com/aweebit/react-essentials/blob/v0.10.5/src/misc/contextualize.tsx#L23)
 
 ### Type Parameters
 
@@ -1130,13 +1149,13 @@ Defined in: [misc/contextualize.tsx:23](https://github.com/aweebit/react-essenti
 ## JSXWrapPipe
 
 ```ts
-type JSXWrapPipe = {
-  with: WrapJSXWith;
-  end: () => ReactNode;
+type JSXWrapPipe<Children> = {
+  with: WrapJSXWith<Children>;
+  end: () => Children;
 };
 ```
 
-Defined in: [misc/wrapJSX.tsx:18](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/misc/wrapJSX.tsx#L18)
+Defined in: [misc/wrapJSX.tsx:19](https://github.com/aweebit/react-essentials/blob/v0.10.5/src/misc/wrapJSX.tsx#L19)
 
 The return type of [`wrapJSX`](#wrapjsx)
 
@@ -1145,6 +1164,25 @@ The return type of [`wrapJSX`](#wrapjsx)
 [`wrapJSX`](#wrapjsx),
 [`WrapJSXWith`](#wrapjsxwith)
 
+### Type Parameters
+
+<table>
+<thead>
+<tr>
+<th>Type Parameter</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>
+
+`Children` _extends_ `ReactNode`
+
+</td>
+</tr>
+</tbody>
+</table>
+
 ### Properties
 
 <table>
@@ -1163,7 +1201,7 @@ The return type of [`wrapJSX`](#wrapjsx)
 </td>
 <td>
 
-[`WrapJSXWith`](#wrapjsxwith)
+[`WrapJSXWith`](#wrapjsxwith)\<`Children`\>
 
 </td>
 </tr>
@@ -1175,7 +1213,7 @@ The return type of [`wrapJSX`](#wrapjsx)
 </td>
 <td>
 
-() => `ReactNode`
+() => `Children`
 
 </td>
 </tr>
@@ -1187,10 +1225,29 @@ The return type of [`wrapJSX`](#wrapjsx)
 ## WrapJSXWith()
 
 ```ts
-type WrapJSXWith = <C>(...args) => JSXWrapPipe;
+type WrapJSXWith<Children> = <C>(...args) => JSXWrapPipe<ReactElement>;
 ```
 
-Defined in: [misc/wrapJSX.tsx:28](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/misc/wrapJSX.tsx#L28)
+Defined in: [misc/wrapJSX.tsx:29](https://github.com/aweebit/react-essentials/blob/v0.10.5/src/misc/wrapJSX.tsx#L29)
+
+### Type Parameters
+
+<table>
+<thead>
+<tr>
+<th>Type Parameter</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>
+
+`Children` _extends_ `ReactNode`
+
+</td>
+</tr>
+</tbody>
+</table>
 
 ### Type Parameters
 
@@ -1229,7 +1286,7 @@ Defined in: [misc/wrapJSX.tsx:28](https://github.com/aweebit/react-essentials/bl
 </td>
 <td>
 
-\[`C`, `...(Record<never, unknown> extends Omit<ComponentProps<C>, "children"> ? [props?: React.JSX.IntrinsicAttributes & Omit<ComponentProps<C>, "children">] : [props: React.JSX.IntrinsicAttributes & Omit<ComponentProps<C>, "children">])`\]
+\[`"children"` _extends_ keyof `ComponentProps`\<`C`\> ? \[`Children`\] _extends_ \[`ComponentProps`\<`C`\>\[`"children"`\]\] ? `C` : `never` : `never`, `...(Record<never, unknown> extends Omit<ComponentProps<C>, "children"> ? [props?: React.JSX.IntrinsicAttributes & Omit<ComponentProps<C>, "children">] : [props: React.JSX.IntrinsicAttributes & Omit<ComponentProps<C>, "children">])`\]
 
 </td>
 </tr>
@@ -1238,7 +1295,7 @@ Defined in: [misc/wrapJSX.tsx:28](https://github.com/aweebit/react-essentials/bl
 
 ### Returns
 
-[`JSXWrapPipe`](#jsxwrappipe)
+[`JSXWrapPipe`](#jsxwrappipe)\<`ReactElement`\>
 
 ### See
 

package/dist/misc/wrapJSX.d.ts

@@ -1,4 +1,4 @@
-import type { ComponentProps, JSXElementConstructor, default as React, ReactNode } from 'react';
+import type { ComponentProps, JSXElementConstructor, default as React, ReactElement, ReactNode } from 'react';
 /**
  * The return type of {@linkcode wrapJSX}
  *
@@ -6,23 +6,23 @@ import type { ComponentProps, JSXElementConstructor, default as React, ReactNode
  * {@linkcode wrapJSX},
  * {@linkcode WrapJSXWith}
  */
-export type JSXWrapPipe = {
-    with: WrapJSXWith;
-    end: () => ReactNode;
+export type JSXWrapPipe<Children extends ReactNode> = {
+    with: WrapJSXWith<Children>;
+    end: () => Children;
 };
 /**
  * @see
  * {@linkcode wrapJSX},
  * {@linkcode JSXWrapPipe}
  */
-export type WrapJSXWith = <C extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>>(...args: [
-    Component: C,
+export type WrapJSXWith<Children extends ReactNode> = <C extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>>(...args: [
+    Component: 'children' extends keyof ComponentProps<C> ? [Children] extends [ComponentProps<C>['children']] ? C : never : never,
     ...(Record<never, unknown> extends Omit<ComponentProps<C>, 'children'> ? [
         props?: React.JSX.IntrinsicAttributes & Omit<ComponentProps<C>, 'children'>
     ] : [
         props: React.JSX.IntrinsicAttributes & Omit<ComponentProps<C>, 'children'>
     ])
-]) => JSXWrapPipe;
+]) => JSXWrapPipe<ReactElement>;
 /**
  * An alternative way to compose JSX that avoids ever-increasing indentation
  *
@@ -72,5 +72,5 @@ export type WrapJSXWith = <C extends keyof JSX.IntrinsicElements | JSXElementCon
  * @see
  * {@linkcode JSXWrapPipe}
  */
-export declare function wrapJSX(children: ReactNode): JSXWrapPipe;
+export declare function wrapJSX<Children extends ReactNode>(children: Children): JSXWrapPipe<Children>;
 //# sourceMappingURL=wrapJSX.d.ts.map

package/dist/misc/wrapJSX.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wrapJSX.d.ts","sourceRoot":"","sources":["../../src/misc/wrapJSX.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,qBAAqB,EACrB,OAAO,IAAI,KAAK,EAChB,SAAS,EACV,MAAM,OAAO,CAAC;AAKf;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,WAAW,CAAC;IAClB,GAAG,EAAE,MAAM,SAAS,CAAC;CACtB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAErB,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,iBAAiB,GAAG,qBAAqB,CAAC,GAAG,CAAC,EACjE,GAAG,IAAI,EAAE;IACP,SAAS,EAAE,CAAC;IACZ,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,SAAS,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,GAClE;QACE,KAAK,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,mBAAmB,GACnC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC;KACtC,GACD;QACE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,mBAAmB,GAClC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC;KACtC,CAAC;CACP,KACE,WAAW,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,wBAAgB,OAAO,CAAC,QAAQ,EAAE,SAAS,GAAG,WAAW,CAcxD"}
+{"version":3,"file":"wrapJSX.d.ts","sourceRoot":"","sources":["../../src/misc/wrapJSX.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,qBAAqB,EACrB,OAAO,IAAI,KAAK,EAChB,YAAY,EACZ,SAAS,EACV,MAAM,OAAO,CAAC;AAKf;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,CAAC,QAAQ,SAAS,SAAS,IAAI;IACpD,IAAI,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC5B,GAAG,EAAE,MAAM,QAAQ,CAAC;CACrB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,WAAW,CAAC,QAAQ,SAAS,SAAS,IAEhD,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,iBAAiB,GAAG,qBAAqB,CAAC,GAAG,CAAC,EACjE,GAAG,IAAI,EAAE;IACP,SAAS,EAAE,UAAU,SAAS,MAAM,cAAc,CAAC,CAAC,CAAC,GACjD,CAAC,QAAQ,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,GAChD,CAAC,GACD,KAAK,GACP,KAAK;IACT,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,SAAS,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,GAClE;QACE,KAAK,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,mBAAmB,GACnC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC;KACtC,GACD;QACE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,mBAAmB,GAClC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC;KACtC,CAAC;CACP,KACE,WAAW,CAAC,YAAY,CAAC,CAAC;AAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,wBAAgB,OAAO,CAAC,QAAQ,SAAS,SAAS,EAChD,QAAQ,EAAE,QAAQ,GACjB,WAAW,CAAC,QAAQ,CAAC,CAcvB"}

package/dist/misc/wrapJSX.js.map

@@ -1 +1 @@
-{"version":3,"file":"wrapJSX.js","sourceRoot":"","sources":["../../src/misc/wrapJSX.tsx"],"names":[],"mappings":";AA4CA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,MAAM,UAAU,OAAO,CAAC,QAAmB;IACzC,OAAO;QACL,IAAI,CACF,SAEiC,EACjC,QAAgB,EAAE;YAElB,OAAO,OAAO,CAAC,KAAC,SAAS,OAAK,KAAK,YAAG,QAAQ,GAAa,CAAC,CAAC;QAC/D,CAAC;QACD,GAAG;YACD,OAAO,QAAQ,CAAC;QAClB,CAAC;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"wrapJSX.js","sourceRoot":"","sources":["../../src/misc/wrapJSX.tsx"],"names":[],"mappings":";AAiDA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,MAAM,UAAU,OAAO,CACrB,QAAkB;IAElB,OAAO;QACL,IAAI,CACF,SAEiC,EACjC,QAAgB,EAAE;YAElB,OAAO,OAAO,CAAC,KAAC,SAAS,OAAK,KAAK,YAAG,QAAQ,GAAa,CAAC,CAAC;QAC/D,CAAC;QACD,GAAG;YACD,OAAO,QAAQ,CAAC;QAClB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aweebit/react-essentials",
-  "version": "0.10.4",
+  "version": "0.10.5",
   "type": "module",
   "repository": "github:aweebit/react-essentials",
   "main": "dist/index.js",

package/src/misc/wrapJSX.tsx

@@ -2,6 +2,7 @@ import type {
   ComponentProps,
   JSXElementConstructor,
   default as React,
+  ReactElement,
   ReactNode,
 } from 'react';
 
@@ -15,9 +16,9 @@ import type { contextualize } from './contextualize.js';
  * {@linkcode wrapJSX},
  * {@linkcode WrapJSXWith}
  */
-export type JSXWrapPipe = {
-  with: WrapJSXWith;
-  end: () => ReactNode;
+export type JSXWrapPipe<Children extends ReactNode> = {
+  with: WrapJSXWith<Children>;
+  end: () => Children;
 };
 
 /**
@@ -25,11 +26,15 @@ export type JSXWrapPipe = {
  * {@linkcode wrapJSX},
  * {@linkcode JSXWrapPipe}
  */
-export type WrapJSXWith =
+export type WrapJSXWith<Children extends ReactNode> =
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   <C extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>>(
     ...args: [
-      Component: C,
+      Component: 'children' extends keyof ComponentProps<C>
+        ? [Children] extends [ComponentProps<C>['children']]
+          ? C
+          : never
+        : never,
       ...(Record<never, unknown> extends Omit<ComponentProps<C>, 'children'>
         ? [
             props?: React.JSX.IntrinsicAttributes &
@@ -40,7 +45,7 @@ export type WrapJSXWith =
               Omit<ComponentProps<C>, 'children'>,
           ]),
     ]
-  ) => JSXWrapPipe;
+  ) => JSXWrapPipe<ReactElement>;
 
 /**
  * An alternative way to compose JSX that avoids ever-increasing indentation
@@ -91,7 +96,9 @@ export type WrapJSXWith =
  * @see
  * {@linkcode JSXWrapPipe}
  */
-export function wrapJSX(children: ReactNode): JSXWrapPipe {
+export function wrapJSX<Children extends ReactNode>(
+  children: Children,
+): JSXWrapPipe<Children> {
   return {
     with(
       Component: