@zayne-labs/toolkit-react 0.10.7 → 0.10.9

package/dist/esm/hooks/index.d.ts

@@ -1,2 +1,2 @@
-import { ContextError, CustomContextOptions, createCustomContext, createUseLocationState, createUseStorageState, getErrorMessage, useAfterMountEffect, useAnimateElementRefs, useAnimationInterval, useAsyncEffect, useCallbackRef, useClickOutside, useConstant, useCopyToClipboard, useDebouncedFn, useDebouncedState, useDisclosure, useEffectOnce, useIsServer, useLazyRef, useLifeCycle, useLocationState, useMountEffect, usePresence, useScrollObserver, useSearch, useSearchParams, useSearchParamsObject, useShallowComparedSelector, useShallowComparedValue, useStorageState, useStore, useThrottleByFrame, useThrottleBySetTimeout, useThrottleByTimer, useToggle, useUnmountEffect } from "../index-BR_xearK.js";
+import { ContextError, CustomContextOptions, createCustomContext, createUseLocationState, createUseStorageState, getErrorMessage, useAfterMountEffect, useAnimateElementRefs, useAnimationInterval, useAsyncEffect, useCallbackRef, useClickOutside, useConstant, useCopyToClipboard, useDebouncedFn, useDebouncedState, useDisclosure, useEffectOnce, useIsServer, useLazyRef, useLifeCycle, useLocationState, useMountEffect, usePresence, useScrollObserver, useSearch, useSearchParams, useSearchParamsObject, useShallowComparedSelector, useShallowComparedValue, useStorageState, useStore, useThrottleByFrame, useThrottleBySetTimeout, useThrottleByTimer, useToggle, useUnmountEffect } from "../index-WGdWu8BB.js";
 export { ContextError, CustomContextOptions, createCustomContext, createUseLocationState, createUseStorageState, getErrorMessage, useAfterMountEffect, useAnimateElementRefs, useAnimationInterval, useAsyncEffect, useCallbackRef, useClickOutside, useConstant, useCopyToClipboard, useDebouncedFn, useDebouncedState, useDisclosure, useEffectOnce, useIsServer, useLazyRef, useLifeCycle, useLocationState, useMountEffect, usePresence, useScrollObserver, useSearch, useSearchParams, useSearchParamsObject, useShallowComparedSelector, useShallowComparedValue, useStorageState, useStore, useThrottleByFrame, useThrottleBySetTimeout, useThrottleByTimer, useToggle, useUnmountEffect };

package/dist/esm/{index-BR_xearK.d.ts → index-WGdWu8BB.d.ts}

@@ -1,7 +1,7 @@
 import { AnyFunction, CallbackFn, NonEmptyArray, Prettify, SelectorFn } from "@zayne-labs/toolkit-type-helpers";
-import * as react0 from "react";
+import * as react6 from "react";
 import { RefCallback, useEffect } from "react";
-import * as _zayne_labs_toolkit_core2 from "@zayne-labs/toolkit-core";
+import * as _zayne_labs_toolkit_core0 from "@zayne-labs/toolkit-core";
 import { AnimationIntervalOptions, LocationInfo, LocationStoreApi, LocationStoreOptions, ScrollObserverOptions, StorageOptions, StorageStoreApi, StoreApi, URLSearchParamsInit } from "@zayne-labs/toolkit-core";
 
 //#region src/hooks/createCustomContext.d.ts
@@ -19,8 +19,8 @@ type CustomContextOptions<TContextValue, TStrict extends boolean> = {
   strict?: TStrict;
 };
 type UseCustomContextResult<TContextValue, TStrict extends boolean> = TStrict extends true ? TContextValue : TContextValue | null;
-declare const createCustomContext: <TContextValue, TStrict extends boolean = true>(options?: CustomContextOptions<TContextValue, TStrict>) => [react0.Context<TContextValue | null>, () => UseCustomContextResult<TContextValue, TStrict>] & {
-  $inferUnion: react0.Context<TContextValue | null> | (() => UseCustomContextResult<TContextValue, TStrict>);
+declare const createCustomContext: <TContextValue, TStrict extends boolean = true>(options?: CustomContextOptions<TContextValue, TStrict>) => [react6.Context<TContextValue | null>, () => UseCustomContextResult<TContextValue, TStrict>] & {
+  $inferUnion: react6.Context<TContextValue | null> | (() => UseCustomContextResult<TContextValue, TStrict>);
 };
 //#endregion
 //#region src/hooks/effects/useAfterMountEffect.d.ts
@@ -108,13 +108,13 @@ declare const useDebouncedFn: <TParams>(callBackFn: CallbackFn<TParams>, delay:
   cancelMaxWait(): void;
 };
 declare const useDebouncedState: <TValue>(defaultValue: TValue, delay: number | undefined) => readonly [TValue, {
-  (...params: react0.SetStateAction<TValue>[]): void;
-  (params: react0.SetStateAction<TValue> | react0.SetStateAction<TValue>[], overrideOptions: {
+  (...params: react6.SetStateAction<TValue>[]): void;
+  (params: react6.SetStateAction<TValue> | react6.SetStateAction<TValue>[], overrideOptions: {
     $delay: number;
   }): void;
   cancel: () => void;
   cancelMaxWait(): void;
-}, react0.Dispatch<react0.SetStateAction<TValue>>];
+}, react6.Dispatch<react6.SetStateAction<TValue>>];
 //#endregion
 //#region src/hooks/useDisclosure.d.ts
 type DisclosureOptions = {
@@ -138,13 +138,13 @@ declare const useIsServer: () => boolean;
 //#endregion
 //#region src/hooks/useLocationState.d.ts
 type UseLocationResult<TSlice> = [state: TSlice, actions: LocationStoreApi];
-declare const createUseLocationState: (options?: LocationStoreOptions) => Omit<_zayne_labs_toolkit_core2.StoreApi<_zayne_labs_toolkit_core2.URLInfoObject>, "setState" | "resetState"> & {
-  push: (url: string | _zayne_labs_toolkit_core2.PartialURLInfo, options?: {
-    state?: _zayne_labs_toolkit_core2.PartialURLInfo["state"];
+declare const createUseLocationState: (options?: LocationStoreOptions) => Omit<_zayne_labs_toolkit_core0.StoreApi<_zayne_labs_toolkit_core0.URLInfoObject>, "setState" | "resetState"> & {
+  push: (url: string | _zayne_labs_toolkit_core0.PartialURLInfo, options?: {
+    state?: _zayne_labs_toolkit_core0.PartialURLInfo["state"];
   }) => void;
   replace: LocationStoreApi["push"];
   triggerPopstateEvent: (nextLocationState?: LocationInfo["state"]) => void;
-} & (<TSlice = _zayne_labs_toolkit_core2.URLInfoObject>(selector?: SelectorFn<LocationInfo, TSlice>) => UseLocationResult<TSlice>);
+} & (<TSlice = _zayne_labs_toolkit_core0.URLInfoObject>(selector?: SelectorFn<LocationInfo, TSlice>) => UseLocationResult<TSlice>);
 declare const useLocationState: <TSlice = LocationInfo>(selector?: SelectorFn<LocationInfo, TSlice>, options?: LocationStoreOptions) => UseLocationResult<TSlice>;
 //#endregion
 //#region src/hooks/useToggle.d.ts
@@ -199,7 +199,7 @@ declare const useSearch: <TData>(initialData: TData[], delay?: number) => {
   data: TData[];
   isLoading: boolean;
   query: string;
-  setQuery: react0.Dispatch<react0.SetStateAction<string>>;
+  setQuery: react6.Dispatch<react6.SetStateAction<string>>;
 };
 //#endregion
 //#region src/hooks/useSearchParams.d.ts
@@ -208,11 +208,11 @@ type UseSearchParamsOptions = LocationStoreOptions & {
 };
 declare const useSearchParams: <TSearchParams extends URLSearchParamsInit>(options?: UseSearchParamsOptions) => readonly [URLSearchParams, {
   (newQueryParams: TSearchParams | ((prev: URLSearchParams) => TSearchParams)): void;
-  triggerPopstateEvent: (nextLocationState?: _zayne_labs_toolkit_core2.LocationInfo["state"]) => void;
+  triggerPopstateEvent: (nextLocationState?: _zayne_labs_toolkit_core0.LocationInfo["state"]) => void;
 }];
 declare const useSearchParamsObject: <TSearchParams extends Record<string, string>>(options?: UseSearchParamsOptions) => readonly [TSearchParams, {
   (newQueryParams: TSearchParams | ((prev: TSearchParams) => TSearchParams)): void;
-  triggerPopstateEvent: (nextLocationState?: _zayne_labs_toolkit_core2.LocationInfo["state"]) => void;
+  triggerPopstateEvent: (nextLocationState?: _zayne_labs_toolkit_core0.LocationInfo["state"]) => void;
 }];
 //#endregion
 //#region src/hooks/useShallowCompare.d.ts
@@ -225,7 +225,7 @@ type UseStorageResult<TState, TSlice = TState> = [state: TSlice, actions: Storag
  * @description Creates a custom hook that returns a storage state and actions to modify it. You can use this if you need shared options.
  * @note You must use this if you want to be able to prevent syncing state across tabs.
  */
-declare const createUseStorageState: <TState>(baseOptions: StorageOptions<TState>) => _zayne_labs_toolkit_core2.StoreApi<TState> & {
+declare const createUseStorageState: <TState>(baseOptions: StorageOptions<TState>) => _zayne_labs_toolkit_core0.StoreApi<TState> & {
   removeState: () => void;
 } & (<TSlice = TState>(selector?: SelectorFn<TState, TSlice>) => UseStorageResult<TState, TSlice>);
 type UseStorageStateOptions<TValue> = Omit<StorageOptions<TValue>, "initialValue" | "key">;
@@ -248,4 +248,4 @@ declare const useThrottleByFrame: <TParams>(callbackFn: CallbackFn<TParams>) =>
 };
 //#endregion
 export { ContextError, CustomContextOptions, createCustomContext, createUseLocationState, createUseStorageState, getErrorMessage, useAfterMountEffect, useAnimateElementRefs, useAnimationInterval, useAsyncEffect, useCallbackRef, useClickOutside, useConstant, useCopyToClipboard, useDebouncedFn, useDebouncedState, useDisclosure, useEffectOnce, useIsServer, useLazyRef, useLifeCycle, useLocationState, useMountEffect, usePresence, useScrollObserver, useSearch, useSearchParams, useSearchParamsObject, useShallowComparedSelector, useShallowComparedValue, useStorageState, useStore, useThrottleByFrame, useThrottleBySetTimeout, useThrottleByTimer, useToggle, useUnmountEffect };
-//# sourceMappingURL=index-BR_xearK.d.ts.map
+//# sourceMappingURL=index-WGdWu8BB.d.ts.map

package/dist/esm/utils/index.d.ts

@@ -45,10 +45,25 @@ type ForwardedRefType<TComponent extends HTMLElement | React.ElementType> = TCom
 type InferProps<TComponent extends HTMLElement | React.ElementType> = TComponent extends React.ElementType ? React.ComponentPropsWithRef<TComponent> : React.HTMLAttributes<TComponent>;
 type StateSetter<TSetter = unknown> = React.Dispatch<React.SetStateAction<TSetter>>;
 type CssWithCustomProperties<TExtra extends Record<string, string> = NonNullable<unknown>> = React.CSSProperties & Record<`--${string}`, string> & TExtra;
-type DefaultRenderErrorMessages = {
+type DefaultRenderItemErrorMessages = {
   children: "Hey, Sorry but the children prop is redundant since you're currently using the render prop to do the same thing";
   renderItem: "Hey, Sorry but the renderItem prop is redundant since you're currently using the children prop to do the same thing";
 };
+/**
+ * @description Represents a set of props that can be used to render a component conditionally based on a discriminated union type.
+ * This type allows for the use of either a render prop or children prop, but not both at the same time.
+ * If both are provided, a TypeScript error will be thrown.
+ * @template TErrorMessages An object of custom messages to display on the disallowed property.
+ */
+type DiscriminatedRenderItemProps<TRenderItemPropType, TErrorMessages extends Record<keyof DefaultRenderItemErrorMessages, string> = DefaultRenderItemErrorMessages> = UnionDiscriminator<[{
+  children: TRenderItemPropType;
+}, {
+  renderItem: TRenderItemPropType;
+}], TErrorMessages>;
+type DefaultRenderErrorMessages = {
+  children: "Hey, Sorry but the children prop is redundant since you're currently using the render prop to do the same thing";
+  render: "Hey, Sorry but the render prop is redundant since you're currently using the children prop to do the same thing";
+};
 /**
  * @description Represents a set of props that can be used to render a component conditionally based on a discriminated union type.
  * This type allows for the use of either a render prop or children prop, but not both at the same time.
@@ -58,7 +73,7 @@ type DefaultRenderErrorMessages = {
 type DiscriminatedRenderProps<TRenderPropType, TErrorMessages extends Record<keyof DefaultRenderErrorMessages, string> = DefaultRenderErrorMessages> = UnionDiscriminator<[{
   children: TRenderPropType;
 }, {
-  renderItem: TRenderPropType;
+  render: TRenderPropType;
 }], TErrorMessages>;
 //#endregion
 //#region src/utils/types/polymorphism.d.ts
@@ -69,5 +84,5 @@ type InferRemainingProps<TElement extends React.ElementType, TProps> = Omit<Infe
 type MergedGivenPropsWithAs<TElement extends React.ElementType, TProps> = Prettify<Omit<AsProp<TElement>, keyof TProps> & TProps>;
 type PolymorphicProps<TElement extends React.ElementType, TProps extends AnyObject = NonNullable<unknown>> = MergedGivenPropsWithAs<TElement, TProps> & InferRemainingProps<TElement, TProps>;
 //#endregion
-export { AsProp, CssWithCustomProperties, DefaultRenderErrorMessages, DiscriminatedRenderProps, ForwardedRefType, InferProps, PolymorphicProps, StateSetter, composeEventHandlers, composeRefs, composeTwoEventHandlers, mergeProps, mergeTwoProps, setRef, useComposeRefs };
+export { AsProp, CssWithCustomProperties, DefaultRenderErrorMessages, DefaultRenderItemErrorMessages, DiscriminatedRenderItemProps, DiscriminatedRenderProps, ForwardedRefType, InferProps, PolymorphicProps, StateSetter, composeEventHandlers, composeRefs, composeTwoEventHandlers, mergeProps, mergeTwoProps, setRef, useComposeRefs };
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/zustand/index.d.ts

@@ -1,4 +1,4 @@
-import { CustomContextOptions } from "../index-BR_xearK.js";
+import { CustomContextOptions } from "../index-WGdWu8BB.js";
 import { AnyObject, Prettify, SelectorFn } from "@zayne-labs/toolkit-type-helpers";
 import * as react8 from "react";
 import { StoreApi } from "@zayne-labs/toolkit-core";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zayne-labs/toolkit-react",
   "type": "module",
-  "version": "0.10.7",
+  "version": "0.10.9",
   "description": "A collection of utility functions, types and composables used by my other projects. Nothing too fancy but can be useful.",
   "author": "Ryan Zayne",
   "license": "MIT",
@@ -47,8 +47,8 @@
     }
   },
   "dependencies": {
-    "@zayne-labs/toolkit-core": "0.10.7",
-    "@zayne-labs/toolkit-type-helpers": "0.10.7"
+    "@zayne-labs/toolkit-type-helpers": "0.10.9",
+    "@zayne-labs/toolkit-core": "0.10.9"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.2",