@alextheman/components 6.26.0 → 7.0.1

package/README.md

@@ -7,7 +7,7 @@
 [![CI](https://github.com/alextheman231/components/actions/workflows/ci.yml/badge.svg)](https://github.com/alextheman231/components/actions/workflows/ci.yml)
 [![Publish to NPM Registry and GitHub Releases/Pages](https://github.com/alextheman231/components/actions/workflows/publish.yml/badge.svg)](https://github.com/alextheman231/components/actions/workflows/publish.yml)
 
-This is a React component library used across my projects. It is built with React and Material UI, and integrates with tools such as react-router-dom (soon to be replaced with Wouter) and react-hook-form (soon to be replaced with TanStack Form).
+This is a React component library used across my projects. It is built with React and Material UI, and integrates with tools such as Wouter and Tanstack Form.
 
 ## Installation
 

package/dist/DropdownMenu/index.d.ts

@@ -0,0 +1,126 @@
+import { MenuProps } from "@mui/material/Menu";
+import { ComponentProps, ComponentPropsWithRef, ComponentPropsWithoutRef, ElementType, MouseEvent, ReactNode } from "react";
+import { MenuItemOwnProps } from "@mui/material/MenuItem";
+import Button, { ButtonOwnProps } from "@mui/material/Button";
+import { OptionalOnCondition } from "@alextheman/utility";
+
+//#region src/DropdownMenu/DropdownMenu.d.ts
+interface DropdownMenuProps extends Omit<MenuProps, "anchorEl" | "open"> {
+  /** The children to render inside of the dropdown. */
+  children: ReactNode;
+}
+/**
+ * Renders a menu component that can be used alongside the `DropdownMenuProvider`.
+ *
+ * This component's open state would be controlled by the `DropdownMenuTrigger`.
+ */
+declare function DropdownMenu({
+  children,
+  onClose,
+  ...menuProps
+}: DropdownMenuProps): import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/DropdownMenu/DropdownMenuItem.d.ts
+type DropdownMenuItemProps<RootComponent extends ElementType = typeof Button> = {
+  /**
+   * An optional component to provide to override the current component.
+   *
+   * Note that the provided component must:
+   * - accept a `to` prop.
+   * - correctly handle the forwarded `ref`.
+   * - render a valid anchor element (or equivalent) for proper accessibility.
+   */
+  component?: RootComponent; /** The children to be rendered within the menu item. */
+  children?: ReactNode; /** The ref to forward to allow it to be used with polymorphic components */
+  ref?: ComponentPropsWithRef<RootComponent>["ref"]; /** A function to execute after clicking the item. */
+  onClick?: ComponentProps<RootComponent>["onClick"];
+} & Omit<ComponentPropsWithoutRef<RootComponent>, "children" | "ref"> & MenuItemOwnProps;
+/** Represents a menu item to be used inside the `DropdownMenu`. It must be used as children of the `DropdownMenu` component. */
+declare function DropdownMenuItem<RootComponent extends ElementType = typeof Button>({
+  component,
+  children,
+  ref,
+  onClick,
+  ...menuItemProps
+}: DropdownMenuItemProps<RootComponent>): import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/root/types/ContextHookOptions.d.ts
+interface ContextHookOptions<Strict extends boolean = true> {
+  /** Error if the context is missing if this is set to true. */
+  strict?: Strict;
+}
+//#endregion
+//#region src/DropdownMenu/DropdownMenuProvider.d.ts
+interface DropdownMenuContextValue {
+  /** A function responsible for closing the dropdown menu. */
+  closeMenu: () => void;
+  /** Represents whether or not the dropdown is open. */
+  isDropdownOpen: boolean;
+}
+/**
+  Access the DropdownMenu context directly.
+ */
+declare function useDropdownMenuContext<Strict extends boolean = true>({
+  strict
+}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, DropdownMenuContextValue>;
+interface DropdownMenuProviderProps {
+  /** The children to render inside of the dropdown. */
+  children: ReactNode;
+}
+/** Provides shared context for the `DropdownMenu` related components. */
+declare function DropdownMenuProvider({
+  children
+}: DropdownMenuProviderProps): import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/DropdownMenu/DropdownMenuTrigger.d.ts
+type DropdownMenuTriggerProps<RootComponent extends ElementType> = {
+  /**
+   * An optional component to provide to override the current component.
+   *
+   * Note that the provided component must:
+   * - accept a `to` prop.
+   * - correctly handle the forwarded `ref`.
+   * - render a valid anchor element (or equivalent) for proper accessibility.
+   */
+  component?: RootComponent; /** A function to call whenever the trigger is clicked. */
+  onClick?: (event: MouseEvent<HTMLElement>) => void; /** The ref to forward to allow it to be used with polymorphic components */
+  ref?: ComponentPropsWithRef<RootComponent>["ref"]; /** The icon to display on the button when it is open. */
+  openIcon?: ElementType; /** The icon to display on the button when it is closed. */
+  closedIcon?: ElementType;
+} & ComponentPropsWithoutRef<RootComponent> & Omit<ButtonOwnProps, "endIcon">;
+/**
+ * Renders a component which, when clicked, opens the `DropdownMenu` in the current `DropdownMenuProvider`.
+ *
+ * Note that this component must be used in a `DropdownMenuProvider`. It will error in any other context.
+ */
+declare function DropdownMenuTrigger<RootComponent extends ElementType>({
+  component,
+  onClick,
+  openIcon: OpenIcon,
+  closedIcon: ClosedIcon,
+  variant,
+  ...buttonProps
+}: DropdownMenuTriggerProps<RootComponent>): import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/DropdownMenu/DropdownMenuWrapper.d.ts
+interface DropdownMenuWrapperProps {
+  /** The children to render inside of the dropdown. */
+  children: ReactNode;
+  /** The button component to be used as the dropdown toggle (defaults to a Material UI Button) */
+  trigger?: ElementType;
+  /** Props to pass to the Button. */
+  triggerProps?: Omit<DropdownMenuTriggerProps<ElementType>, "component">;
+}
+/**
+ * An in-line component that manages the `DropdownMenuProvider` internally. You can just pass in the `DropdownMenuItem` components and it will work as is.
+ *
+ * This may be used over DropdownMenuProvider if you don't require as much control over the placement of each individual part of the dropdown.
+ */
+declare function DropdownMenuWrapper({
+  children,
+  trigger,
+  triggerProps
+}: DropdownMenuWrapperProps): import("react/jsx-runtime").JSX.Element;
+//#endregion
+export { DropdownMenu, type DropdownMenuContextValue, DropdownMenuItem, type DropdownMenuItemProps, type DropdownMenuProps, DropdownMenuProvider, type DropdownMenuProviderProps, DropdownMenuTrigger, type DropdownMenuTriggerProps, DropdownMenuWrapper, type DropdownMenuWrapperProps, useDropdownMenuContext };
+//# sourceMappingURL=index.d.ts.map

package/dist/DropdownMenu/index.js

@@ -0,0 +1,2 @@
+import e from"@mui/material/Menu";import{DataError as t}from"@alextheman/utility/v6";import{createContext as n,use as r,useId as i,useState as a}from"react";import{jsx as o,jsxs as s}from"react/jsx-runtime";import c from"@mui/material/MenuItem";import l from"@mui/material/Button";import{MdArrowDropDown as u,MdArrowDropUp as d}from"react-icons/md";const f=n(void 0);function p({strict:e=!0}={}){let n=r(f);if(e&&!n)throw new t({strict:e,context:n},`DROPDOWN_MENU_NOT_FOUND`,`Could not find the DropdownMenu context. Please double-check that it is present.`);return n}function m({strict:e=!0}={}){return p({strict:e})}function h({children:e}){let[t,n]=a(null),r=i(),s=!!t;function c(){n(null)}return o(f,{value:{closeMenu:c,isDropdownOpen:s,anchorElement:t,setAnchorElement:n,menuId:r},children:e})}function g({children:t,onClose:n,...r}){let{anchorElement:i,isDropdownOpen:a,closeMenu:s,menuId:c}=m();return o(e,{id:c,anchorEl:i,open:a,onClose:(e,t)=>{e.defaultPrevented||s(),n&&n(e,t)},...r,children:t})}function _({component:e,children:t,ref:n,onClick:r,...i}){let{closeMenu:a}=p();return o(c,{component:e,ref:n,...i,onClick:e=>{r&&r(e),!e.defaultPrevented&&a()},children:t})}function v({component:e,onClick:t,openIcon:n=d,closedIcon:r=u,variant:i=`contained`,...a}){let{isDropdownOpen:s,setAnchorElement:c,menuId:f}=m();return o(l,{...e?{component:e}:{},"aria-controls":s?f:void 0,"aria-haspopup":`true`,"aria-expanded":s,endIcon:o(s?n:r,{}),variant:i,...a,onClick:e=>{t&&t(e),!e.defaultPrevented&&c(e.currentTarget)}})}function y({children:e,trigger:t,triggerProps:n}){return s(h,{children:[o(v,{component:t,...n,children:n?.children??`Menu`}),o(g,{children:e})]})}export{g as DropdownMenu,_ as DropdownMenuItem,h as DropdownMenuProvider,v as DropdownMenuTrigger,y as DropdownMenuWrapper,p as useDropdownMenuContext};
+//# sourceMappingURL=index.js.map

package/dist/DropdownMenu/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../src/DropdownMenu/DropdownMenuProvider.tsx","../../src/DropdownMenu/DropdownMenu.tsx","../../src/DropdownMenu/DropdownMenuItem.tsx","../../src/DropdownMenu/DropdownMenuTrigger.tsx","../../src/DropdownMenu/DropdownMenuWrapper.tsx"],"sourcesContent":["import type { OptionalOnCondition } from \"@alextheman/utility\";\nimport type { Dispatch, ReactNode, SetStateAction } from \"react\";\n\nimport type { ContextHookOptions } from \"src/root/types\";\n\nimport { DataError } from \"@alextheman/utility/v6\";\nimport { createContext, use, useId, useState } from \"react\";\n\nexport interface DropdownMenuContextValue {\n  /** A function responsible for closing the dropdown menu. */\n  closeMenu: () => void;\n  /** Represents whether or not the dropdown is open. */\n  isDropdownOpen: boolean;\n}\n\nexport type DropdownMenuInternalContextValue = DropdownMenuContextValue & {\n  anchorElement: HTMLElement | null;\n  setAnchorElement: Dispatch<SetStateAction<HTMLElement | null>>;\n  menuId: string;\n};\nconst DropdownMenuContext = createContext<DropdownMenuInternalContextValue | undefined>(undefined);\n\n/**\n  Access the DropdownMenu context directly.\n */\nexport function useDropdownMenuContext<Strict extends boolean = true>({\n  strict = true as Strict,\n}: ContextHookOptions<Strict> = {}): OptionalOnCondition<Strict, DropdownMenuContextValue> {\n  const context = use(DropdownMenuContext);\n  if (strict && !context) {\n    throw new DataError(\n      { strict, context },\n      \"DROPDOWN_MENU_NOT_FOUND\",\n      \"Could not find the DropdownMenu context. Please double-check that it is present.\",\n    );\n  }\n  return context as OptionalOnCondition<Strict, DropdownMenuContextValue>;\n}\n\n// eslint-disable-next-line jsdoc/require-jsdoc\nexport function useDropdownMenuContextInternal<Strict extends boolean = true>({\n  strict = true as Strict,\n}: ContextHookOptions<Strict> = {}): OptionalOnCondition<Strict, DropdownMenuInternalContextValue> {\n  return useDropdownMenuContext({ strict }) as OptionalOnCondition<\n    Strict,\n    DropdownMenuInternalContextValue\n  >;\n}\n\nexport interface DropdownMenuProviderProps {\n  /** The children to render inside of the dropdown. */\n  children: ReactNode;\n}\n\n/** Provides shared context for the `DropdownMenu` related components. */\nfunction DropdownMenuProvider({ children }: DropdownMenuProviderProps) {\n  const [anchorElement, setAnchorElement] = useState<HTMLElement | null>(null);\n  const menuId = useId();\n  const isDropdownOpen = Boolean(anchorElement);\n\n  function closeMenu() {\n    setAnchorElement(null);\n  }\n\n  return (\n    <DropdownMenuContext\n      value={{ closeMenu, isDropdownOpen, anchorElement, setAnchorElement, menuId }}\n    >\n      {children}\n    </DropdownMenuContext>\n  );\n}\n\nexport default DropdownMenuProvider;\n","import type { MenuProps } from \"@mui/material/Menu\";\nimport type { MouseEvent, ReactNode } from \"react\";\n\nimport Menu from \"@mui/material/Menu\";\n\nimport { useDropdownMenuContextInternal } from \"src/DropdownMenu/DropdownMenuProvider\";\n\nexport interface DropdownMenuProps extends Omit<MenuProps, \"anchorEl\" | \"open\"> {\n  /** The children to render inside of the dropdown. */\n  children: ReactNode;\n}\n\n/**\n * Renders a menu component that can be used alongside the `DropdownMenuProvider`.\n *\n * This component's open state would be controlled by the `DropdownMenuTrigger`.\n */\nfunction DropdownMenu({ children, onClose, ...menuProps }: DropdownMenuProps) {\n  const { anchorElement, isDropdownOpen, closeMenu, menuId } = useDropdownMenuContextInternal();\n\n  return (\n    <Menu\n      id={menuId}\n      anchorEl={anchorElement}\n      open={isDropdownOpen}\n      onClose={(event: MouseEvent, reason) => {\n        if (!event.defaultPrevented) {\n          closeMenu();\n        }\n        if (onClose) {\n          onClose(event, reason);\n        }\n      }}\n      {...menuProps}\n    >\n      {children}\n    </Menu>\n  );\n}\n\nexport default DropdownMenu;\n","import type Button from \"@mui/material/Button\";\nimport type { MenuItemOwnProps } from \"@mui/material/MenuItem\";\nimport type {\n  ComponentProps,\n  ComponentPropsWithoutRef,\n  ComponentPropsWithRef,\n  ElementType,\n  ReactNode,\n} from \"react\";\n\nimport MenuItem from \"@mui/material/MenuItem\";\n\nimport { useDropdownMenuContext } from \"src/DropdownMenu/DropdownMenuProvider\";\n\nexport type DropdownMenuItemProps<RootComponent extends ElementType = typeof Button> = {\n  /**\n   * An optional component to provide to override the current component.\n   *\n   * Note that the provided component must:\n   * - accept a `to` prop.\n   * - correctly handle the forwarded `ref`.\n   * - render a valid anchor element (or equivalent) for proper accessibility.\n   */\n  component?: RootComponent;\n  /** The children to be rendered within the menu item. */\n  children?: ReactNode;\n  /** The ref to forward to allow it to be used with polymorphic components */\n  ref?: ComponentPropsWithRef<RootComponent>[\"ref\"];\n  /** A function to execute after clicking the item. */\n  onClick?: ComponentProps<RootComponent>[\"onClick\"];\n} & Omit<ComponentPropsWithoutRef<RootComponent>, \"children\" | \"ref\"> &\n  MenuItemOwnProps;\n\n/** Represents a menu item to be used inside the `DropdownMenu`. It must be used as children of the `DropdownMenu` component. */\nfunction DropdownMenuItem<RootComponent extends ElementType = typeof Button>({\n  component,\n  children,\n  ref,\n  onClick,\n  ...menuItemProps\n}: DropdownMenuItemProps<RootComponent>) {\n  const { closeMenu } = useDropdownMenuContext();\n\n  return (\n    <MenuItem\n      component={component}\n      ref={ref}\n      {...menuItemProps}\n      onClick={(event) => {\n        if (onClick) {\n          onClick(event);\n        }\n        if (event.defaultPrevented) {\n          return;\n        }\n        closeMenu();\n      }}\n    >\n      {children}\n    </MenuItem>\n  );\n}\n\nexport default DropdownMenuItem;\n","import type { ButtonOwnProps } from \"@mui/material/Button\";\nimport type {\n  ComponentPropsWithoutRef,\n  ComponentPropsWithRef,\n  ElementType,\n  MouseEvent,\n} from \"react\";\n\nimport Button from \"@mui/material/Button\";\nimport { MdArrowDropDown, MdArrowDropUp } from \"react-icons/md\";\n\nimport { useDropdownMenuContextInternal } from \"src/DropdownMenu/DropdownMenuProvider\";\n\nexport type DropdownMenuTriggerProps<RootComponent extends ElementType> = {\n  /**\n   * An optional component to provide to override the current component.\n   *\n   * Note that the provided component must:\n   * - accept a `to` prop.\n   * - correctly handle the forwarded `ref`.\n   * - render a valid anchor element (or equivalent) for proper accessibility.\n   */\n  component?: RootComponent;\n  /** A function to call whenever the trigger is clicked. */\n  onClick?: (event: MouseEvent<HTMLElement>) => void;\n  /** The ref to forward to allow it to be used with polymorphic components */\n  ref?: ComponentPropsWithRef<RootComponent>[\"ref\"];\n  /** The icon to display on the button when it is open. */\n  openIcon?: ElementType;\n  /** The icon to display on the button when it is closed. */\n  closedIcon?: ElementType;\n} & ComponentPropsWithoutRef<RootComponent> &\n  Omit<ButtonOwnProps, \"endIcon\">;\n\n/**\n * Renders a component which, when clicked, opens the `DropdownMenu` in the current `DropdownMenuProvider`.\n *\n * Note that this component must be used in a `DropdownMenuProvider`. It will error in any other context.\n */\nfunction DropdownMenuTrigger<RootComponent extends ElementType>({\n  component,\n  onClick,\n  openIcon: OpenIcon = MdArrowDropUp,\n  closedIcon: ClosedIcon = MdArrowDropDown,\n  variant = \"contained\",\n  ...buttonProps\n}: DropdownMenuTriggerProps<RootComponent>) {\n  const { isDropdownOpen, setAnchorElement, menuId } = useDropdownMenuContextInternal();\n\n  return (\n    <Button\n      {...(component ? { component } : {})}\n      aria-controls={isDropdownOpen ? menuId : undefined}\n      aria-haspopup=\"true\"\n      aria-expanded={isDropdownOpen}\n      endIcon={isDropdownOpen ? <OpenIcon /> : <ClosedIcon />}\n      variant={variant}\n      {...buttonProps}\n      onClick={(event: MouseEvent<HTMLElement>) => {\n        if (onClick) {\n          onClick(event);\n        }\n        if (event.defaultPrevented) {\n          return;\n        }\n        setAnchorElement(event.currentTarget);\n      }}\n    />\n  );\n}\n\nexport default DropdownMenuTrigger;\n","import type { ElementType, ReactNode } from \"react\";\n\nimport type { DropdownMenuTriggerProps } from \"src/DropdownMenu/DropdownMenuTrigger\";\n\nimport DropdownMenu from \"src/DropdownMenu/DropdownMenu\";\nimport DropdownMenuProvider from \"src/DropdownMenu/DropdownMenuProvider\";\nimport DropdownMenuTrigger from \"src/DropdownMenu/DropdownMenuTrigger\";\n\nexport interface DropdownMenuWrapperProps {\n  /** The children to render inside of the dropdown. */\n  children: ReactNode;\n  /** The button component to be used as the dropdown toggle (defaults to a Material UI Button) */\n  trigger?: ElementType;\n  /** Props to pass to the Button. */\n  triggerProps?: Omit<DropdownMenuTriggerProps<ElementType>, \"component\">;\n}\n\n/**\n * An in-line component that manages the `DropdownMenuProvider` internally. You can just pass in the `DropdownMenuItem` components and it will work as is.\n *\n * This may be used over DropdownMenuProvider if you don't require as much control over the placement of each individual part of the dropdown.\n */\nfunction DropdownMenuWrapper({ children, trigger, triggerProps }: DropdownMenuWrapperProps) {\n  return (\n    <DropdownMenuProvider>\n      <DropdownMenuTrigger component={trigger} {...triggerProps}>\n        {triggerProps?.children ?? \"Menu\"}\n      </DropdownMenuTrigger>\n      <DropdownMenu>{children}</DropdownMenu>\n    </DropdownMenuProvider>\n  );\n}\n\nexport default DropdownMenuWrapper;\n"],"mappings":"6VAoBA,MAAM,EAAsB,EAA4D,IAAA,EAAS,EAKjG,SAAgB,EAAsD,CACpE,SAAS,IACqB,CAAC,EAA0D,CACzF,IAAM,EAAU,EAAI,CAAmB,EACvC,GAAI,GAAU,CAAC,EACb,MAAM,IAAI,EACR,CAAE,SAAQ,SAAQ,EAClB,0BACA,kFACF,EAEF,OAAO,CACT,CAGA,SAAgB,EAA8D,CAC5E,SAAS,IACqB,CAAC,EAAkE,CACjG,OAAO,EAAuB,CAAE,QAAO,CAAC,CAI1C,CAQA,SAAS,EAAqB,CAAE,YAAuC,CACrE,GAAM,CAAC,EAAe,GAAoB,EAA6B,IAAI,EACrE,EAAS,EAAM,EACf,EAAiB,EAAQ,EAE/B,SAAS,GAAY,CACnB,EAAiB,IAAI,CACvB,CAEA,OACE,EAAC,EAAD,CACE,MAAO,CAAE,YAAW,iBAAgB,gBAAe,mBAAkB,QAAO,EAE3E,UACkB,CAAA,CAEzB,CCtDA,SAAS,EAAa,CAAE,WAAU,UAAS,GAAG,GAAgC,CAC5E,GAAM,CAAE,gBAAe,iBAAgB,YAAW,UAAW,EAA+B,EAE5F,OACE,EAAC,EAAD,CACE,GAAI,EACJ,SAAU,EACV,KAAM,EACN,SAAU,EAAmB,IAAW,CACjC,EAAM,kBACT,EAAU,EAER,GACF,EAAQ,EAAO,CAAM,CAEzB,EACA,GAAI,EAEH,UACG,CAAA,CAEV,CCJA,SAAS,EAAoE,CAC3E,YACA,WACA,MACA,UACA,GAAG,GACoC,CACvC,GAAM,CAAE,aAAc,EAAuB,EAE7C,OACE,EAAC,EAAD,CACa,YACN,MACL,GAAI,EACJ,QAAU,GAAU,CACd,GACF,EAAQ,CAAK,EAEX,GAAM,kBAGV,EAAU,CACZ,EAEC,UACO,CAAA,CAEd,CCtBA,SAAS,EAAuD,CAC9D,YACA,UACA,SAAU,EAAW,EACrB,WAAY,EAAa,EACzB,UAAU,YACV,GAAG,GACuC,CAC1C,GAAM,CAAE,iBAAgB,mBAAkB,UAAW,EAA+B,EAEpF,OACE,EAAC,EAAD,CACE,GAAK,EAAY,CAAE,WAAU,EAAI,CAAC,EAClC,gBAAe,EAAiB,EAAS,IAAA,GACzC,gBAAc,OACd,gBAAe,EACf,QAA0B,EAAjB,EAAkB,EAAe,EAAhB,CAAW,CAAiB,EAC7C,UACT,GAAI,EACJ,QAAU,GAAmC,CACvC,GACF,EAAQ,CAAK,EAEX,GAAM,kBAGV,EAAiB,EAAM,aAAa,CACtC,CACD,CAAA,CAEL,CC/CA,SAAS,EAAoB,CAAE,WAAU,UAAS,gBAA0C,CAC1F,OACE,EAAC,EAAD,CAAA,SAAA,CACE,EAAC,EAAD,CAAqB,UAAW,EAAS,GAAI,WAC1C,GAAc,UAAY,MACR,CAAA,EACrB,EAAC,EAAD,CAAe,UAAuB,CAAA,CAClB,CAAA,CAAA,CAE1B"}

package/dist/QueryBoundary/index.d.ts

@@ -0,0 +1,288 @@
+import { JSX, Key, ReactNode } from "react";
+import { OptionalOnCondition } from "@alextheman/utility";
+
+//#region src/QueryBoundary/QueryBoundaryData.d.ts
+interface QueryBoundaryDataProps<DataType> {
+  /**
+   * The elements to show after data has been loaded.
+   * This is best provided as a function with a data argument that guarantees the data will not be undefined by the time you receive it here.
+   */
+  children: ReactNode | ((data: NonNullable<DataType>) => ReactNode);
+  /** A parser for the data. */
+  dataParser?: (data: unknown) => NonNullable<DataType>;
+  /** The component to show when the data is being fetched. */
+  loadingFallback?: ReactNode;
+}
+/**
+ * The component responsible for showing the data provided by QueryBoundaryProvider.
+ *
+ * @template DataType - The type of data being loaded.
+ */
+declare function QueryBoundaryData<DataType>({
+  children,
+  dataParser,
+  loadingFallback
+}: QueryBoundaryDataProps<DataType>): import("react/jsx-runtime").JSX.Element | null;
+//#endregion
+//#region src/QueryBoundary/QueryBoundaryDataMap.d.ts
+interface QueryBoundaryDataMapBaseProps<ItemType> {
+  /**
+   * The elements to show after data has been loaded.
+   *
+   * This is best provided as a function with a data argument that guarantees the data will not be undefined by the time you receive it here.
+   */
+  children: ReactNode | ((data: ItemType) => ReactNode);
+  /** The component to show when the data is being fetched. */
+  loadingFallback?: ReactNode;
+  /** The component to show if the array is empty. */
+  emptyFallback?: ReactNode;
+  /** Throw an error if the provided data is not an array. (defaults to `true`) */
+  strictlyRequireArray?: boolean;
+  /**
+   * A function that takes a data item and returns the key to be used for the item.
+   *
+   * If not provided, it will fall back to using the index.
+   */
+  itemKey?: (item: ItemType, index: number) => Key;
+}
+interface QueryBoundaryDataMapPropsWithItemParser<ItemType> extends QueryBoundaryDataMapBaseProps<ItemType> {
+  /** A parser for each data item. */
+  itemParser: (data: unknown) => ItemType;
+  dataParser?: never;
+}
+interface QueryBoundaryDataMapPropsWithDataParser<ItemType> extends QueryBoundaryDataMapBaseProps<ItemType> {
+  /** A parser for each data item. */
+  dataParser: (data: unknown) => Array<ItemType>;
+  itemParser?: never;
+}
+interface QueryBoundaryDataMapPropsWithNoParser<ItemType> extends QueryBoundaryDataMapBaseProps<ItemType> {
+  dataParser?: never;
+  itemParser?: never;
+}
+type QueryBoundaryDataMapProps<ItemType> = QueryBoundaryDataMapPropsWithItemParser<ItemType> | QueryBoundaryDataMapPropsWithDataParser<ItemType> | QueryBoundaryDataMapPropsWithNoParser<ItemType>;
+/**
+ * The component responsible for handling an array of data provided by `QueryBoundaryProvider`.
+ *
+ * It will map through the data array, rendering the result of the children function in a fragment with a key of its index in the list, unless overridden by the `itemKey` prop.
+ *
+ * @template ItemType - The type of data being loaded.
+ *
+ * @throws {DataError} If the data provided by `QueryBoundaryProvider` is not an array, and the `strictlyRequireArray` prop is `true` (it is by default).
+ */
+declare function QueryBoundaryDataMap<ItemType>({
+  children,
+  loadingFallback,
+  itemKey,
+  itemParser,
+  dataParser,
+  emptyFallback,
+  strictlyRequireArray
+}: QueryBoundaryDataMapProps<ItemType>): import("react/jsx-runtime").JSX.Element | null;
+//#endregion
+//#region src/QueryBoundary/QueryBoundaryError.d.ts
+interface QueryBoundaryErrorProps {
+  /** The component to show if an error has been thrown. */
+  children?: ReactNode | ((error: unknown) => ReactNode);
+  /** An option to log the error to the console. */
+  logError?: boolean;
+}
+/**
+ * The component responsible for showing any errors provided by QueryBoundaryProvider.
+ */
+declare function QueryBoundaryError({
+  children,
+  logError
+}: QueryBoundaryErrorProps): string | number | bigint | boolean | Iterable<ReactNode> | Promise<string | number | bigint | boolean | import("react").ReactPortal | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | import("react/jsx-runtime").JSX.Element | null | undefined;
+//#endregion
+//#region src/QueryBoundary/QueryBoundaryNullable.d.ts
+interface QueryBoundaryNullablePropsWithUndefinedOrNull {
+  /** The component to show if no error was thrown but data is undefined */
+  undefinedFallback?: ReactNode;
+  /** The component to show if no error was thrown but data is null */
+  nullFallback?: ReactNode;
+  nullableFallback?: never;
+}
+interface QueryBoundaryNullablePropsWithNullable {
+  undefinedFallback?: never;
+  nullFallback?: never;
+  /** The component to show if no error was thrown but data is undefined or null */
+  nullableFallback?: ReactNode;
+}
+type QueryBoundaryNullableProps = QueryBoundaryNullablePropsWithUndefinedOrNull | QueryBoundaryNullablePropsWithNullable;
+/** The component responsible for handling cases when the data provided by `QueryBoundaryProvider` may be missing. */
+declare function QueryBoundaryNullable({
+  undefinedFallback,
+  nullFallback,
+  nullableFallback
+}: QueryBoundaryNullableProps): import("react/jsx-runtime").JSX.Element | null;
+//#endregion
+//#region src/QueryBoundary/QueryBoundaryFallback.d.ts
+type QueryBoundaryFallbackProps = Omit<QueryBoundaryErrorProps, "children"> & {
+  /** The component to show if an error has been thrown. */errorFallback?: ReactNode | ((error: unknown) => ReactNode);
+} & QueryBoundaryNullableProps;
+/**
+ * The component responsible for handling both errors and nullable data from `QueryBoundaryProvider`
+ */
+declare function QueryBoundaryFallback({
+  errorFallback,
+  logError,
+  ...queryBoundaryNullableProps
+}: QueryBoundaryFallbackProps): import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/root/types/ContextHookOptions.d.ts
+interface ContextHookOptions<Strict extends boolean = true> {
+  /** Error if the context is missing if this is set to true. */
+  strict?: Strict;
+}
+//#endregion
+//#region src/QueryBoundary/QueryBoundaryProvider.d.ts
+interface QueryBoundaryContextValue<DataType> {
+  /** The current loading status (true if loading, false if not) */
+  isLoading?: boolean;
+  /** The data being loaded. */
+  data?: DataType | null | undefined;
+  /** The error given if the request gave an error. */
+  error: unknown;
+}
+type QueryBoundaryProviderProps<DataType> = QueryBoundaryContextValue<DataType> & {
+  children: ReactNode;
+};
+/** Access the QueryBoundary context directly. */
+declare function useQueryBoundaryContext<DataType, Strict extends boolean = true>({
+  strict
+}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, QueryBoundaryContextValue<DataType>>;
+/**
+ * A provider for a context that deals with state management when fetching data from an API.
+ * This may be used over QueryBoundary if you require more control over the placement of the error message and data display.
+ *
+ * @template DataType - The type of data being loaded.
+ */
+declare function QueryBoundaryProvider<DataType>({
+  children,
+  ...contextProps
+}: QueryBoundaryProviderProps<DataType>): import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/QueryBoundary/QueryBoundaryItemWrapper.d.ts
+type QueryBoundaryItemWrapperProps<DataType> = QueryBoundaryContextValue<DataType> & QueryBoundaryFallbackProps & QueryBoundaryDataProps<DataType>;
+/**
+ * An in-line component that deals with state management when fetching data from an API.
+ * This may be used over QueryBoundaryProvider if you don't require as much control over the placement of the error message and data display.
+ *
+ * @template DataType - The type of data being loaded.
+ */
+declare function QueryBoundaryItemWrapper<DataType>({
+  children,
+  errorFallback,
+  undefinedFallback,
+  nullFallback,
+  nullableFallback,
+  logError,
+  loadingFallback,
+  isLoading,
+  error,
+  data,
+  dataParser
+}: QueryBoundaryItemWrapperProps<DataType>): import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/QueryBoundary/QueryBoundaryListWrapper.d.ts
+type QueryBoundaryListWrapperProps<ItemType> = QueryBoundaryContextValue<Array<ItemType>> & QueryBoundaryFallbackProps & QueryBoundaryDataMapProps<ItemType>;
+/**
+ * An in-line component that handles an array of data provided by `QueryBoundaryProvider`.
+ *
+ * This may be used over QueryBoundaryProvider/QueryBoundaryDataMap if you don't require as much control over the placement of the error message and data display.
+ *
+ * @template DataType - The type of data being loaded.
+ */
+declare function QueryBoundaryListWrapper<ItemType>({
+  loadingFallback,
+  undefinedFallback,
+  nullFallback,
+  nullableFallback,
+  logError,
+  errorFallback,
+  children,
+  isLoading,
+  error,
+  data,
+  dataParser,
+  itemParser,
+  itemKey
+}: QueryBoundaryListWrapperProps<ItemType>): import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/QueryBoundary/creators/createBaseQueryBoundary.d.ts
+interface QueryBase<DataType> {
+  /** The current loading status (true if loading, false if not) */
+  isLoading?: boolean;
+  /** The error given if the response gave an error. */
+  error?: unknown;
+  /** The data being loaded. */
+  data: DataType;
+}
+interface CreateBaseQueryBoundaryParameters<DataType> {
+  query: QueryBase<DataType>;
+}
+interface DefaultQueryBoundaryComponentsBase {
+  /** Provides the context for the query boundary. */
+  Context: (props: {
+    children: ReactNode;
+  }) => JSX.Element;
+  /** The component responsible for showing any errors provided by `QueryBoundary.Context`. */
+  Error: typeof QueryBoundaryError;
+  /** The component responsible for handling cases when the data provided by `QueryBoundary.Context` may be missing. */
+  Fallback: typeof QueryBoundaryFallback;
+  /** The component responsible for handling both errors and nullable data from `QueryBoundary.Context`*/
+  Nullable: typeof QueryBoundaryNullable;
+}
+/** A creator function to create the base system of QueryBoundary components with the data fully typed throughout. */
+declare function createBaseQueryBoundary<DataType>({
+  query
+}: CreateBaseQueryBoundaryParameters<DataType>): DefaultQueryBoundaryComponentsBase;
+//#endregion
+//#region src/QueryBoundary/creators/createItemQueryBoundary.d.ts
+interface QueryItem<DataType> extends Omit<QueryBase<DataType>, "data"> {
+  /** The data being loaded. */
+  data: DataType | null | undefined;
+}
+interface CreateItemQueryBoundaryParameters<DataType> {
+  query: QueryItem<DataType>;
+}
+interface DefaultQueryBoundaryItemComponents<DataType> extends DefaultQueryBoundaryComponentsBase {
+  /**
+   * The component responsible for showing the data provided by `QueryBoundary.Context`.
+   *
+   * @template DataType - The type of data being loaded.
+   */
+  Data: typeof QueryBoundaryData<DataType>;
+}
+/** A creator function to create the system of QueryBoundary components with the data treated as a single data item, fully typed throughout. */
+declare function createItemQueryBoundary<DataType>({
+  query
+}: CreateItemQueryBoundaryParameters<DataType>): DefaultQueryBoundaryItemComponents<DataType>;
+//#endregion
+//#region src/QueryBoundary/creators/createListQueryBoundary.d.ts
+interface QueryList<DataType> extends Omit<QueryBase<DataType>, "data"> {
+  /** The data being loaded. */
+  data: Array<DataType> | null | undefined;
+}
+interface CreateListQueryBoundaryParameters<DataType> {
+  query: QueryList<DataType>;
+}
+interface DefaultQueryBoundaryListComponents<DataType> extends DefaultQueryBoundaryComponentsBase {
+  /**
+   * The component responsible for handling an array of data provided by `QueryBoundary.Context`.
+   *
+   * It will map through the data array, rendering the result of the children function in a fragment with a key of its index in the list, unless overridden by the `itemKey` prop.
+   *
+   * @template ItemType - The type of data being loaded.
+   *
+   * @throws {DataError} If the data provided by `QueryBoundary.Context` is not an array, and the `strictlyRequireArray` prop is `true` (it is by default).
+   */
+  DataMap: typeof QueryBoundaryDataMap<DataType>;
+}
+/** A creator function to create the system of QueryBoundary components with the data treated as an array of data items, fully typed throughout. */
+declare function createListQueryBoundary<DataType>({
+  query
+}: CreateListQueryBoundaryParameters<DataType>): DefaultQueryBoundaryListComponents<DataType>;
+//#endregion
+export { type CreateBaseQueryBoundaryParameters, type CreateItemQueryBoundaryParameters, type CreateListQueryBoundaryParameters, type DefaultQueryBoundaryComponentsBase, type DefaultQueryBoundaryItemComponents, type DefaultQueryBoundaryListComponents, type QueryBase, type QueryBoundaryContextValue, QueryBoundaryData, QueryBoundaryDataMap, type QueryBoundaryDataMapBaseProps, type QueryBoundaryDataMapProps, type QueryBoundaryDataMapPropsWithDataParser, type QueryBoundaryDataMapPropsWithItemParser, type QueryBoundaryDataMapPropsWithNoParser, type QueryBoundaryDataProps, QueryBoundaryError, type QueryBoundaryErrorProps, QueryBoundaryFallback, type QueryBoundaryFallbackProps, QueryBoundaryItemWrapper, type QueryBoundaryItemWrapperProps, QueryBoundaryListWrapper, type QueryBoundaryListWrapperProps, QueryBoundaryNullable, type QueryBoundaryNullableProps, type QueryBoundaryNullablePropsWithNullable, type QueryBoundaryNullablePropsWithUndefinedOrNull, QueryBoundaryProvider, type QueryBoundaryProviderProps, type QueryItem, type QueryList, createBaseQueryBoundary, createItemQueryBoundary, createListQueryBoundary, useQueryBoundaryContext };
+//# sourceMappingURL=index.d.ts.map

package/dist/QueryBoundary/index.js

@@ -0,0 +1,2 @@
+import e from"@mui/material/CircularProgress";import{DataError as t}from"@alextheman/utility/v6";import{Fragment as n,createContext as r,use as i,useRef as a}from"react";import{Fragment as o,jsx as s,jsxs as c}from"react/jsx-runtime";import l from"@mui/material/Typography";import u from"@mui/material/Alert";const d=r(void 0);function f({strict:e=!0}={}){let n=i(d);if(e&&!n)throw new t({strict:e,context:n},`QUERY_BOUNDARY_PROVIDER_NOT_FOUND`,`Could not find the QueryBoundaryProvider context. Please double-check that it is present.`);return n}function p({children:e,...t}){return s(d,{value:t,children:e})}function m({children:t,dataParser:n,loadingFallback:r=s(e,{})}){let{isLoading:i,data:a,error:c}=f();return c?null:i?s(o,{children:r}):a==null?null:s(o,{children:typeof t==`function`?t(n?n(a):a):t})}function h({children:r,loadingFallback:i=s(e,{}),itemKey:a,itemParser:c,dataParser:u,emptyFallback:d=s(l,{children:`No data present`}),strictlyRequireArray:p=!0}){let{isLoading:m,data:h,error:g}=f();if(m)return s(o,{children:i});if(g||h==null)return null;if(!Array.isArray(h)){if(p)throw new t({data:h,strictlyRequireArray:p},`NOT_AN_ARRAY`,`Expected the data to be an array but it was not an array.`);return null}if(h.length===0)return s(o,{children:d});let _;return _=u?u(h):c?h.map(c):h,s(o,{children:_.map((e,t)=>s(n,{children:typeof r==`function`?r(e):r},a?a(e,t):t))})}function g({children:e,logError:t}){let{data:n,error:r}=f(),i=a(!1);return r?(t&&!i.current&&(n==null?console.error(r):console.error(`An error has occurred but data is still present. This may indicate an invalid query state.`,{data:n,error:r}),i.current=!0),typeof e==`function`?e(r):e===void 0?s(u,{severity:`error`,children:typeof r==`object`&&`message`in r&&typeof r.message==`string`?r.message:`An unknown error has occured.`}):s(o,{children:e})):null}function _({undefinedFallback:e,nullFallback:t,nullableFallback:n}){let{isLoading:r,data:i,error:a}=f();if(r||a)return null;if(i==null){if(n!==void 0)return s(o,{children:n});if(i===void 0)return e===void 0?s(l,{children:`No data available.`}):s(o,{children:e});if(i===null)return t===void 0?s(l,{children:`No data found.`}):s(o,{children:t})}return null}function v({errorFallback:e,logError:t,...n}){return c(o,{children:[s(g,{logError:t,children:e}),s(_,{...n})]})}function y({query:e}){return{Context:({children:t})=>s(p,{isLoading:e.isLoading,error:e.error,data:e.data,children:t}),Error:g,Fallback:v,Nullable:_}}function b({query:e}){return{...y({query:e}),Data:m}}function x({children:t,errorFallback:n,undefinedFallback:r,nullFallback:i,nullableFallback:a,logError:o,loadingFallback:l=s(e,{}),isLoading:u,error:d,data:f,dataParser:p}){let m=b({query:{isLoading:u,error:d,data:f}}),h=s(m.Fallback,{logError:o,errorFallback:n});return a===void 0?(r!==void 0||i!==void 0)&&(h=s(m.Fallback,{undefinedFallback:r,nullFallback:i,logError:o,errorFallback:n})):h=s(m.Fallback,{nullableFallback:a,logError:o,errorFallback:n}),c(m.Context,{children:[h,s(m.Data,{loadingFallback:l,dataParser:p,children:t})]})}function S({query:e}){return{...y({query:e}),DataMap:h}}function C({loadingFallback:e,undefinedFallback:t,nullFallback:n,nullableFallback:r,logError:i,errorFallback:a,children:o,isLoading:l,error:u,data:d,dataParser:f,itemParser:p,itemKey:m}){let h=S({query:{isLoading:l,error:u,data:d}}),g=s(h.Fallback,{logError:i,errorFallback:a});r===void 0?(t!==void 0||n!==void 0)&&(g=s(h.Fallback,{undefinedFallback:t,nullFallback:n,logError:i,errorFallback:a})):g=s(h.Fallback,{nullableFallback:r,logError:i,errorFallback:a});let _=s(h.DataMap,{loadingFallback:e,itemKey:m,children:o});return f?_=s(h.DataMap,{loadingFallback:e,itemKey:m,dataParser:f,children:o}):p&&(_=s(h.DataMap,{loadingFallback:e,itemKey:m,itemParser:p,children:o})),c(h.Context,{children:[g,_]})}export{m as QueryBoundaryData,h as QueryBoundaryDataMap,g as QueryBoundaryError,v as QueryBoundaryFallback,x as QueryBoundaryItemWrapper,C as QueryBoundaryListWrapper,_ as QueryBoundaryNullable,p as QueryBoundaryProvider,y as createBaseQueryBoundary,b as createItemQueryBoundary,S as createListQueryBoundary,f as useQueryBoundaryContext};
+//# sourceMappingURL=index.js.map

package/dist/QueryBoundary/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../src/QueryBoundary/QueryBoundaryProvider.tsx","../../src/QueryBoundary/QueryBoundaryData.tsx","../../src/QueryBoundary/QueryBoundaryDataMap.tsx","../../src/QueryBoundary/QueryBoundaryError.tsx","../../src/QueryBoundary/QueryBoundaryNullable.tsx","../../src/QueryBoundary/QueryBoundaryFallback.tsx","../../src/QueryBoundary/creators/createBaseQueryBoundary.tsx","../../src/QueryBoundary/creators/createItemQueryBoundary.tsx","../../src/QueryBoundary/QueryBoundaryItemWrapper.tsx","../../src/QueryBoundary/creators/createListQueryBoundary.tsx","../../src/QueryBoundary/QueryBoundaryListWrapper.tsx"],"sourcesContent":["import type { OptionalOnCondition } from \"@alextheman/utility\";\nimport type { ReactNode } from \"react\";\n\nimport type { ContextHookOptions } from \"src/root/types\";\n\nimport { DataError } from \"@alextheman/utility/v6\";\nimport { createContext, use } from \"react\";\n\nexport interface QueryBoundaryContextValue<DataType> {\n  /** The current loading status (true if loading, false if not) */\n  isLoading?: boolean;\n  /** The data being loaded. */\n  data?: DataType | null | undefined;\n  /** The error given if the request gave an error. */\n  error: unknown;\n}\n\nexport type QueryBoundaryProviderProps<DataType> = QueryBoundaryContextValue<DataType> & {\n  children: ReactNode;\n};\n\nconst QueryBoundaryContext = createContext<QueryBoundaryContextValue<unknown> | undefined>(\n  undefined,\n);\n\n/** Access the QueryBoundary context directly. */\nexport function useQueryBoundaryContext<DataType, Strict extends boolean = true>({\n  strict = true as Strict,\n}: ContextHookOptions<Strict> = {}): OptionalOnCondition<\n  Strict,\n  QueryBoundaryContextValue<DataType>\n> {\n  const context = use(QueryBoundaryContext);\n  if (strict && !context) {\n    throw new DataError(\n      { strict, context },\n      \"QUERY_BOUNDARY_PROVIDER_NOT_FOUND\",\n      \"Could not find the QueryBoundaryProvider context. Please double-check that it is present.\",\n    );\n  }\n  return context as OptionalOnCondition<Strict, QueryBoundaryContextValue<DataType>>;\n}\n\n/**\n * A provider for a context that deals with state management when fetching data from an API.\n * This may be used over QueryBoundary if you require more control over the placement of the error message and data display.\n *\n * @template DataType - The type of data being loaded.\n */\nfunction QueryBoundaryProvider<DataType>({\n  children,\n  ...contextProps\n}: QueryBoundaryProviderProps<DataType>) {\n  return <QueryBoundaryContext value={contextProps}>{children}</QueryBoundaryContext>;\n}\n\nexport default QueryBoundaryProvider;\n","import type { ReactNode } from \"react\";\n\nimport CircularProgress from \"@mui/material/CircularProgress\";\n\nimport { useQueryBoundaryContext } from \"src/QueryBoundary/QueryBoundaryProvider\";\n\nexport interface QueryBoundaryDataProps<DataType> {\n  /**\n   * The elements to show after data has been loaded.\n   * This is best provided as a function with a data argument that guarantees the data will not be undefined by the time you receive it here.\n   */\n  children: ReactNode | ((data: NonNullable<DataType>) => ReactNode);\n  /** A parser for the data. */\n  dataParser?: (data: unknown) => NonNullable<DataType>;\n  /** The component to show when the data is being fetched. */\n  loadingFallback?: ReactNode;\n}\n\n/**\n * The component responsible for showing the data provided by QueryBoundaryProvider.\n *\n * @template DataType - The type of data being loaded.\n */\nfunction QueryBoundaryData<DataType>({\n  children,\n  dataParser,\n  loadingFallback = <CircularProgress />,\n}: QueryBoundaryDataProps<DataType>) {\n  const { isLoading, data, error } = useQueryBoundaryContext<DataType>();\n\n  if (error) {\n    return null;\n  }\n\n  if (isLoading) {\n    return <>{loadingFallback}</>;\n  }\n\n  if (data === null || data === undefined) {\n    return null;\n  }\n\n  return (\n    <>\n      {typeof children === \"function\" ? children(dataParser ? dataParser(data) : data) : children}\n    </>\n  );\n}\n\nexport default QueryBoundaryData;\n","import type { Key, ReactNode } from \"react\";\n\nimport { DataError } from \"@alextheman/utility/v6\";\nimport CircularProgress from \"@mui/material/CircularProgress\";\nimport Typography from \"@mui/material/Typography\";\nimport { Fragment } from \"react\";\n\nimport { useQueryBoundaryContext } from \"src/QueryBoundary/QueryBoundaryProvider\";\n\nexport interface QueryBoundaryDataMapBaseProps<ItemType> {\n  /**\n   * The elements to show after data has been loaded.\n   *\n   * This is best provided as a function with a data argument that guarantees the data will not be undefined by the time you receive it here.\n   */\n  children: ReactNode | ((data: ItemType) => ReactNode);\n  /** The component to show when the data is being fetched. */\n  loadingFallback?: ReactNode;\n  /** The component to show if the array is empty. */\n  emptyFallback?: ReactNode;\n  /** Throw an error if the provided data is not an array. (defaults to `true`) */\n  strictlyRequireArray?: boolean;\n  /**\n   * A function that takes a data item and returns the key to be used for the item.\n   *\n   * If not provided, it will fall back to using the index.\n   */\n  itemKey?: (item: ItemType, index: number) => Key;\n}\n\nexport interface QueryBoundaryDataMapPropsWithItemParser<\n  ItemType,\n> extends QueryBoundaryDataMapBaseProps<ItemType> {\n  /** A parser for each data item. */\n  itemParser: (data: unknown) => ItemType;\n  dataParser?: never;\n}\n\nexport interface QueryBoundaryDataMapPropsWithDataParser<\n  ItemType,\n> extends QueryBoundaryDataMapBaseProps<ItemType> {\n  /** A parser for each data item. */\n  dataParser: (data: unknown) => Array<ItemType>;\n  itemParser?: never;\n}\n\nexport interface QueryBoundaryDataMapPropsWithNoParser<\n  ItemType,\n> extends QueryBoundaryDataMapBaseProps<ItemType> {\n  dataParser?: never;\n  itemParser?: never;\n}\n\nexport type QueryBoundaryDataMapProps<ItemType> =\n  | QueryBoundaryDataMapPropsWithItemParser<ItemType>\n  | QueryBoundaryDataMapPropsWithDataParser<ItemType>\n  | QueryBoundaryDataMapPropsWithNoParser<ItemType>;\n\n/**\n * The component responsible for handling an array of data provided by `QueryBoundaryProvider`.\n *\n * It will map through the data array, rendering the result of the children function in a fragment with a key of its index in the list, unless overridden by the `itemKey` prop.\n *\n * @template ItemType - The type of data being loaded.\n *\n * @throws {DataError} If the data provided by `QueryBoundaryProvider` is not an array, and the `strictlyRequireArray` prop is `true` (it is by default).\n */\nfunction QueryBoundaryDataMap<ItemType>({\n  children,\n  loadingFallback = <CircularProgress />,\n  itemKey,\n  itemParser,\n  dataParser,\n  emptyFallback = <Typography>No data present</Typography>,\n  strictlyRequireArray = true,\n}: QueryBoundaryDataMapProps<ItemType>) {\n  const { isLoading, data, error } = useQueryBoundaryContext<Array<ItemType>>();\n\n  if (isLoading) {\n    return <>{loadingFallback}</>;\n  }\n\n  if (error) {\n    return null;\n  }\n\n  if (data === null || data === undefined) {\n    return null;\n  }\n\n  if (!Array.isArray(data)) {\n    if (strictlyRequireArray) {\n      throw new DataError(\n        { data, strictlyRequireArray },\n        \"NOT_AN_ARRAY\",\n        \"Expected the data to be an array but it was not an array.\",\n      );\n    }\n    return null;\n  }\n\n  if (data.length === 0) {\n    return <>{emptyFallback}</>;\n  }\n\n  let items: Array<ItemType>;\n\n  if (dataParser) {\n    items = dataParser(data);\n  } else if (itemParser) {\n    items = data.map(itemParser);\n  } else {\n    items = data;\n  }\n\n  return (\n    <>\n      {items.map((item, index) => {\n        return (\n          <Fragment key={itemKey ? itemKey(item, index) : index}>\n            {typeof children === \"function\" ? children(item) : children}\n          </Fragment>\n        );\n      })}\n    </>\n  );\n}\n\nexport default QueryBoundaryDataMap;\n","import type { ReactNode } from \"react\";\n\nimport Alert from \"@mui/material/Alert\";\nimport { useRef } from \"react\";\n\nimport { useQueryBoundaryContext } from \"src/QueryBoundary/QueryBoundaryProvider\";\n\nexport interface QueryBoundaryErrorProps {\n  /** The component to show if an error has been thrown. */\n  children?: ReactNode | ((error: unknown) => ReactNode);\n  /** An option to log the error to the console. */\n  logError?: boolean;\n}\n\n/**\n * The component responsible for showing any errors provided by QueryBoundaryProvider.\n */\nfunction QueryBoundaryError({ children, logError }: QueryBoundaryErrorProps) {\n  const { data, error } = useQueryBoundaryContext();\n  const warnedOnceRef = useRef(false);\n\n  if (error) {\n    if (logError && !warnedOnceRef.current) {\n      if (data !== null && data !== undefined) {\n        console.error(\n          \"An error has occurred but data is still present. This may indicate an invalid query state.\",\n          { data, error },\n        );\n      } else {\n        console.error(error);\n      }\n      warnedOnceRef.current = true;\n    }\n    if (typeof children === \"function\") {\n      return children(error);\n    }\n    if (children !== undefined) {\n      return <>{children}</>;\n    }\n\n    return (\n      <Alert severity=\"error\">\n        {typeof error === \"object\" && \"message\" in error && typeof error.message === \"string\"\n          ? error.message\n          : \"An unknown error has occured.\"}\n      </Alert>\n    );\n  }\n\n  return null;\n}\n\nexport default QueryBoundaryError;\n","import type { ReactNode } from \"react\";\n\nimport Typography from \"@mui/material/Typography\";\n\nimport { useQueryBoundaryContext } from \"src/QueryBoundary/QueryBoundaryProvider\";\n\nexport interface QueryBoundaryNullablePropsWithUndefinedOrNull {\n  /** The component to show if no error was thrown but data is undefined */\n  undefinedFallback?: ReactNode;\n  /** The component to show if no error was thrown but data is null */\n  nullFallback?: ReactNode;\n  nullableFallback?: never;\n}\n\nexport interface QueryBoundaryNullablePropsWithNullable {\n  undefinedFallback?: never;\n  nullFallback?: never;\n  /** The component to show if no error was thrown but data is undefined or null */\n  nullableFallback?: ReactNode;\n}\n\nexport type QueryBoundaryNullableProps =\n  | QueryBoundaryNullablePropsWithUndefinedOrNull\n  | QueryBoundaryNullablePropsWithNullable;\n\n/** The component responsible for handling cases when the data provided by `QueryBoundaryProvider` may be missing. */\nfunction QueryBoundaryNullable({\n  undefinedFallback,\n  nullFallback,\n  nullableFallback,\n}: QueryBoundaryNullableProps) {\n  const { isLoading, data, error } = useQueryBoundaryContext();\n\n  if (isLoading) {\n    return null;\n  }\n\n  if (error) {\n    return null;\n  }\n\n  if (data === null || data === undefined) {\n    if (nullableFallback !== undefined) {\n      return <>{nullableFallback}</>;\n    }\n\n    if (data === undefined) {\n      if (undefinedFallback !== undefined) {\n        return <>{undefinedFallback}</>;\n      }\n      return <Typography>No data available.</Typography>;\n    }\n\n    if (data === null) {\n      if (nullFallback !== undefined) {\n        return <>{nullFallback}</>;\n      }\n      return <Typography>No data found.</Typography>;\n    }\n  }\n\n  return null;\n}\n\nexport default QueryBoundaryNullable;\n","import type { ReactNode } from \"react\";\n\nimport type { QueryBoundaryErrorProps } from \"src/QueryBoundary/QueryBoundaryError\";\nimport type { QueryBoundaryNullableProps } from \"src/QueryBoundary/QueryBoundaryNullable\";\n\nimport QueryBoundaryError from \"src/QueryBoundary/QueryBoundaryError\";\nimport QueryBoundaryNullable from \"src/QueryBoundary/QueryBoundaryNullable\";\n\nexport type QueryBoundaryFallbackProps = Omit<QueryBoundaryErrorProps, \"children\"> & {\n  /** The component to show if an error has been thrown. */\n  errorFallback?: ReactNode | ((error: unknown) => ReactNode);\n} & QueryBoundaryNullableProps;\n\n/**\n * The component responsible for handling both errors and nullable data from `QueryBoundaryProvider`\n */\nfunction QueryBoundaryFallback({\n  errorFallback,\n  logError,\n  ...queryBoundaryNullableProps\n}: QueryBoundaryFallbackProps) {\n  return (\n    <>\n      <QueryBoundaryError logError={logError}>{errorFallback}</QueryBoundaryError>\n      <QueryBoundaryNullable {...queryBoundaryNullableProps} />\n    </>\n  );\n}\n\nexport default QueryBoundaryFallback;\n","import type { JSX, ReactNode } from \"react\";\n\nimport QueryBoundaryError from \"src/QueryBoundary/QueryBoundaryError\";\nimport QueryBoundaryFallback from \"src/QueryBoundary/QueryBoundaryFallback\";\nimport QueryBoundaryNullable from \"src/QueryBoundary/QueryBoundaryNullable\";\nimport QueryBoundaryProvider from \"src/QueryBoundary/QueryBoundaryProvider\";\n\nexport interface QueryBase<DataType> {\n  /** The current loading status (true if loading, false if not) */\n  isLoading?: boolean;\n  /** The error given if the response gave an error. */\n  error?: unknown;\n  /** The data being loaded. */\n  data: DataType;\n}\n\nexport interface CreateBaseQueryBoundaryParameters<DataType> {\n  query: QueryBase<DataType>;\n}\n\nexport interface DefaultQueryBoundaryComponentsBase {\n  /** Provides the context for the query boundary. */\n  Context: (props: { children: ReactNode }) => JSX.Element;\n  /** The component responsible for showing any errors provided by `QueryBoundary.Context`. */\n  Error: typeof QueryBoundaryError;\n  /** The component responsible for handling cases when the data provided by `QueryBoundary.Context` may be missing. */\n  Fallback: typeof QueryBoundaryFallback;\n  /** The component responsible for handling both errors and nullable data from `QueryBoundary.Context`*/\n  Nullable: typeof QueryBoundaryNullable;\n}\n\n/** A creator function to create the base system of QueryBoundary components with the data fully typed throughout. */\nfunction createBaseQueryBoundary<DataType>({\n  query,\n}: CreateBaseQueryBoundaryParameters<DataType>): DefaultQueryBoundaryComponentsBase {\n  return {\n    Context: ({ children }) => {\n      return (\n        <QueryBoundaryProvider isLoading={query.isLoading} error={query.error} data={query.data}>\n          {children}\n        </QueryBoundaryProvider>\n      );\n    },\n    Error: QueryBoundaryError,\n    Fallback: QueryBoundaryFallback,\n    Nullable: QueryBoundaryNullable,\n  };\n}\n\nexport default createBaseQueryBoundary;\n","import type {\n  DefaultQueryBoundaryComponentsBase,\n  QueryBase,\n} from \"src/QueryBoundary/creators/createBaseQueryBoundary\";\n\nimport createBaseQueryBoundary from \"src/QueryBoundary/creators/createBaseQueryBoundary\";\nimport QueryBoundaryData from \"src/QueryBoundary/QueryBoundaryData\";\n\nexport interface QueryItem<DataType> extends Omit<QueryBase<DataType>, \"data\"> {\n  /** The data being loaded. */\n  data: DataType | null | undefined;\n}\n\nexport interface CreateItemQueryBoundaryParameters<DataType> {\n  query: QueryItem<DataType>;\n}\n\nexport interface DefaultQueryBoundaryItemComponents<\n  DataType,\n> extends DefaultQueryBoundaryComponentsBase {\n  /**\n   * The component responsible for showing the data provided by `QueryBoundary.Context`.\n   *\n   * @template DataType - The type of data being loaded.\n   */\n  Data: typeof QueryBoundaryData<DataType>;\n}\n\n/** A creator function to create the system of QueryBoundary components with the data treated as a single data item, fully typed throughout. */\nfunction createItemQueryBoundary<DataType>({\n  query,\n}: CreateItemQueryBoundaryParameters<DataType>): DefaultQueryBoundaryItemComponents<DataType> {\n  const baseComponents = createBaseQueryBoundary({ query });\n\n  return {\n    ...baseComponents,\n    Data: QueryBoundaryData,\n  };\n}\n\nexport default createItemQueryBoundary;\n","import type { ReactNode } from \"react\";\n\nimport type { QueryBoundaryDataProps } from \"src/QueryBoundary/QueryBoundaryData\";\nimport type { QueryBoundaryFallbackProps } from \"src/QueryBoundary/QueryBoundaryFallback\";\nimport type { QueryBoundaryContextValue } from \"src/QueryBoundary/QueryBoundaryProvider\";\n\nimport CircularProgress from \"@mui/material/CircularProgress\";\n\nimport createItemQueryBoundary from \"src/QueryBoundary/creators/createItemQueryBoundary\";\n\nexport type QueryBoundaryItemWrapperProps<DataType> = QueryBoundaryContextValue<DataType> &\n  QueryBoundaryFallbackProps &\n  QueryBoundaryDataProps<DataType>;\n\n/**\n * An in-line component that deals with state management when fetching data from an API.\n * This may be used over QueryBoundaryProvider if you don't require as much control over the placement of the error message and data display.\n *\n * @template DataType - The type of data being loaded.\n */\nfunction QueryBoundaryItemWrapper<DataType>({\n  children,\n  errorFallback,\n  undefinedFallback,\n  nullFallback,\n  nullableFallback,\n  logError,\n  loadingFallback = <CircularProgress />,\n  isLoading,\n  error,\n  data,\n  dataParser,\n}: QueryBoundaryItemWrapperProps<DataType>) {\n  const QueryBoundary = createItemQueryBoundary({ query: { isLoading, error, data } });\n\n  let boundaryFallbackComponent: ReactNode = (\n    <QueryBoundary.Fallback logError={logError} errorFallback={errorFallback} />\n  );\n\n  if (nullableFallback !== undefined) {\n    boundaryFallbackComponent = (\n      <QueryBoundary.Fallback\n        nullableFallback={nullableFallback}\n        logError={logError}\n        errorFallback={errorFallback}\n      />\n    );\n  } else if (undefinedFallback !== undefined || nullFallback !== undefined) {\n    boundaryFallbackComponent = (\n      <QueryBoundary.Fallback\n        undefinedFallback={undefinedFallback}\n        nullFallback={nullFallback}\n        logError={logError}\n        errorFallback={errorFallback}\n      />\n    );\n  }\n\n  return (\n    <QueryBoundary.Context>\n      {boundaryFallbackComponent}\n      <QueryBoundary.Data loadingFallback={loadingFallback} dataParser={dataParser}>\n        {children}\n      </QueryBoundary.Data>\n    </QueryBoundary.Context>\n  );\n}\n\nexport default QueryBoundaryItemWrapper;\n","import type {\n  DefaultQueryBoundaryComponentsBase,\n  QueryBase,\n} from \"src/QueryBoundary/creators/createBaseQueryBoundary\";\n\nimport createBaseQueryBoundary from \"src/QueryBoundary/creators/createBaseQueryBoundary\";\nimport QueryBoundaryDataMap from \"src/QueryBoundary/QueryBoundaryDataMap\";\n\nexport interface QueryList<DataType> extends Omit<QueryBase<DataType>, \"data\"> {\n  /** The data being loaded. */\n  data: Array<DataType> | null | undefined;\n}\n\nexport interface CreateListQueryBoundaryParameters<DataType> {\n  query: QueryList<DataType>;\n}\n\nexport interface DefaultQueryBoundaryListComponents<\n  DataType,\n> extends DefaultQueryBoundaryComponentsBase {\n  /**\n   * The component responsible for handling an array of data provided by `QueryBoundary.Context`.\n   *\n   * It will map through the data array, rendering the result of the children function in a fragment with a key of its index in the list, unless overridden by the `itemKey` prop.\n   *\n   * @template ItemType - The type of data being loaded.\n   *\n   * @throws {DataError} If the data provided by `QueryBoundary.Context` is not an array, and the `strictlyRequireArray` prop is `true` (it is by default).\n   */\n  DataMap: typeof QueryBoundaryDataMap<DataType>;\n}\n\n/** A creator function to create the system of QueryBoundary components with the data treated as an array of data items, fully typed throughout. */\nfunction createListQueryBoundary<DataType>({\n  query,\n}: CreateListQueryBoundaryParameters<DataType>): DefaultQueryBoundaryListComponents<DataType> {\n  const baseComponents = createBaseQueryBoundary({ query });\n\n  return {\n    ...baseComponents,\n    DataMap: QueryBoundaryDataMap,\n  };\n}\n\nexport default createListQueryBoundary;\n","import type { ReactNode } from \"react\";\n\nimport type { QueryBoundaryDataMapProps } from \"src/QueryBoundary/QueryBoundaryDataMap\";\nimport type { QueryBoundaryFallbackProps } from \"src/QueryBoundary/QueryBoundaryFallback\";\nimport type { QueryBoundaryContextValue } from \"src/QueryBoundary/QueryBoundaryProvider\";\n\nimport createListQueryBoundary from \"src/QueryBoundary/creators/createListQueryBoundary\";\n\nexport type QueryBoundaryListWrapperProps<ItemType> = QueryBoundaryContextValue<Array<ItemType>> &\n  QueryBoundaryFallbackProps &\n  QueryBoundaryDataMapProps<ItemType>;\n\n/**\n * An in-line component that handles an array of data provided by `QueryBoundaryProvider`.\n *\n * This may be used over QueryBoundaryProvider/QueryBoundaryDataMap if you don't require as much control over the placement of the error message and data display.\n *\n * @template DataType - The type of data being loaded.\n */\nfunction QueryBoundaryListWrapper<ItemType>({\n  loadingFallback,\n  undefinedFallback,\n  nullFallback,\n  nullableFallback,\n  logError,\n  errorFallback,\n  children,\n  isLoading,\n  error,\n  data,\n  dataParser,\n  itemParser,\n  itemKey,\n}: QueryBoundaryListWrapperProps<ItemType>) {\n  const QueryBoundary = createListQueryBoundary({ query: { isLoading, error, data } });\n\n  let boundaryErrorFallback: ReactNode = (\n    <QueryBoundary.Fallback logError={logError} errorFallback={errorFallback} />\n  );\n\n  if (nullableFallback !== undefined) {\n    boundaryErrorFallback = (\n      <QueryBoundary.Fallback\n        nullableFallback={nullableFallback}\n        logError={logError}\n        errorFallback={errorFallback}\n      />\n    );\n  } else if (undefinedFallback !== undefined || nullFallback !== undefined) {\n    boundaryErrorFallback = (\n      <QueryBoundary.Fallback\n        undefinedFallback={undefinedFallback}\n        nullFallback={nullFallback}\n        logError={logError}\n        errorFallback={errorFallback}\n      />\n    );\n  }\n\n  let boundaryDataMapComponent: ReactNode = (\n    <QueryBoundary.DataMap loadingFallback={loadingFallback} itemKey={itemKey}>\n      {children}\n    </QueryBoundary.DataMap>\n  );\n\n  if (dataParser) {\n    boundaryDataMapComponent = (\n      <QueryBoundary.DataMap\n        loadingFallback={loadingFallback}\n        itemKey={itemKey}\n        dataParser={dataParser}\n      >\n        {children}\n      </QueryBoundary.DataMap>\n    );\n  } else if (itemParser) {\n    boundaryDataMapComponent = (\n      <QueryBoundary.DataMap\n        loadingFallback={loadingFallback}\n        itemKey={itemKey}\n        itemParser={itemParser}\n      >\n        {children}\n      </QueryBoundary.DataMap>\n    );\n  }\n\n  return (\n    <QueryBoundary.Context>\n      {boundaryErrorFallback}\n      {boundaryDataMapComponent}\n    </QueryBoundary.Context>\n  );\n}\n\nexport default QueryBoundaryListWrapper;\n"],"mappings":"qTAqBA,MAAM,EAAuB,EAC3B,IAAA,EACF,EAGA,SAAgB,EAAiE,CAC/E,SAAS,IACqB,CAAC,EAG/B,CACA,IAAM,EAAU,EAAI,CAAoB,EACxC,GAAI,GAAU,CAAC,EACb,MAAM,IAAI,EACR,CAAE,SAAQ,SAAQ,EAClB,oCACA,2FACF,EAEF,OAAO,CACT,CAQA,SAAS,EAAgC,CACvC,WACA,GAAG,GACoC,CACvC,OAAO,EAAC,EAAD,CAAsB,MAAO,EAAe,UAA+B,CAAA,CACpF,CC/BA,SAAS,EAA4B,CACnC,WACA,aACA,kBAAkB,EAAC,EAAD,CAAmB,CAAA,GACF,CACnC,GAAM,CAAE,YAAW,OAAM,SAAU,EAAkC,EAcrE,OAZI,EACK,KAGL,EACK,EAAA,EAAA,CAAA,SAAG,CAAkB,CAAA,EAG1B,GAAS,KACJ,KAIP,EAAA,EAAA,CAAA,SACG,OAAO,GAAa,WAAa,EAAS,EAAa,EAAW,CAAI,EAAI,CAAI,EAAI,CACnF,CAAA,CAEN,CCoBA,SAAS,EAA+B,CACtC,WACA,kBAAkB,EAAC,EAAD,CAAmB,CAAA,EACrC,UACA,aACA,aACA,gBAAgB,EAAC,EAAD,CAAA,SAAY,iBAA2B,CAAA,EACvD,uBAAuB,IACe,CACtC,GAAM,CAAE,YAAW,OAAM,SAAU,EAAyC,EAE5E,GAAI,EACF,OAAO,EAAA,EAAA,CAAA,SAAG,CAAkB,CAAA,EAO9B,GAJI,GAIA,GAAS,KACX,OAAO,KAGT,GAAI,CAAC,MAAM,QAAQ,CAAI,EAAG,CACxB,GAAI,EACF,MAAM,IAAI,EACR,CAAE,OAAM,sBAAqB,EAC7B,eACA,2DACF,EAEF,OAAO,IACT,CAEA,GAAI,EAAK,SAAW,EAClB,OAAO,EAAA,EAAA,CAAA,SAAG,CAAgB,CAAA,EAG5B,IAAI,EAUJ,MARA,CAKE,EALE,EACM,EAAW,CAAI,EACd,EACD,EAAK,IAAI,CAAU,EAEnB,EAIR,EAAA,EAAA,CAAA,SACG,EAAM,KAAK,EAAM,IAEd,EAAC,EAAD,CAAA,SACG,OAAO,GAAa,WAAa,EAAS,CAAI,EAAI,CAC3C,EAFK,EAAU,EAAQ,EAAM,CAAK,EAAI,CAEtC,CAEb,CACD,CAAA,CAEN,CC7GA,SAAS,EAAmB,CAAE,WAAU,YAAqC,CAC3E,GAAM,CAAE,OAAM,SAAU,EAAwB,EAC1C,EAAgB,EAAO,EAAK,EA8BlC,OA5BI,GACE,GAAY,CAAC,EAAc,UACzB,GAAS,KAMX,QAAQ,MAAM,CAAK,EALnB,QAAQ,MACN,6FACA,CAAE,OAAM,OAAM,CAChB,EAIF,EAAc,QAAU,IAEtB,OAAO,GAAa,WACf,EAAS,CAAK,EAEnB,IAAa,IAAA,GAKf,EAAC,EAAD,CAAO,SAAS,iBACb,OAAO,GAAU,UAAY,YAAa,GAAS,OAAO,EAAM,SAAY,SACzE,EAAM,QACN,+BACC,CAAA,EARA,EAAA,EAAA,CAAG,UAAW,CAAA,GAYlB,IACT,CCxBA,SAAS,EAAsB,CAC7B,oBACA,eACA,oBAC6B,CAC7B,GAAM,CAAE,YAAW,OAAM,SAAU,EAAwB,EAM3D,GAJI,GAIA,EACF,OAAO,KAGT,GAAI,GAAS,KAA4B,CACvC,GAAI,IAAqB,IAAA,GACvB,OAAO,EAAA,EAAA,CAAA,SAAG,CAAmB,CAAA,EAG/B,GAAI,IAAS,IAAA,GAIX,OAHI,IAAsB,IAAA,GAGnB,EAAC,EAAD,CAAA,SAAY,oBAA8B,CAAA,EAFxC,EAAA,EAAA,CAAA,SAAG,CAAoB,CAAA,EAKlC,GAAI,IAAS,KAIX,OAHI,IAAiB,IAAA,GAGd,EAAC,EAAD,CAAA,SAAY,gBAA0B,CAAA,EAFpC,EAAA,EAAA,CAAA,SAAG,CAAe,CAAA,CAI/B,CAEA,OAAO,IACT,CC9CA,SAAS,EAAsB,CAC7B,gBACA,WACA,GAAG,GAC0B,CAC7B,OACE,EAAA,EAAA,CAAA,SAAA,CACE,EAAC,EAAD,CAA8B,oBAAW,CAAkC,CAAA,EAC3E,EAAC,EAAD,CAAuB,GAAI,CAA6B,CAAA,CACxD,CAAA,CAAA,CAEN,CCKA,SAAS,EAAkC,CACzC,SACkF,CAClF,MAAO,CACL,SAAU,CAAE,cAER,EAAC,EAAD,CAAuB,UAAW,EAAM,UAAW,MAAO,EAAM,MAAO,KAAM,EAAM,KAChF,UACoB,CAAA,EAG3B,MAAO,EACP,SAAU,EACV,SAAU,CACZ,CACF,CClBA,SAAS,EAAkC,CACzC,SAC4F,CAG5F,MAAO,CACL,GAHqB,EAAwB,CAAE,OAAM,CAGrC,EAChB,KAAM,CACR,CACF,CClBA,SAAS,EAAmC,CAC1C,WACA,gBACA,oBACA,eACA,mBACA,WACA,kBAAkB,EAAC,EAAD,CAAmB,CAAA,EACrC,YACA,QACA,OACA,cAC0C,CAC1C,IAAM,EAAgB,EAAwB,CAAE,MAAO,CAAE,YAAW,QAAO,MAAK,CAAE,CAAC,EAE/E,EACF,EAAC,EAAc,SAAf,CAAkC,WAAyB,eAAgB,CAAA,EAsB7E,OAnBI,IAAqB,IAAA,IAQd,IAAsB,IAAA,IAAa,IAAiB,IAAA,MAC7D,EACE,EAAC,EAAc,SAAf,CACqB,oBACL,eACJ,WACK,eAChB,CAAA,GAdH,EACE,EAAC,EAAc,SAAf,CACoB,mBACR,WACK,eAChB,CAAA,EAcH,EAAC,EAAc,QAAf,CAAA,SAAA,CACG,EACD,EAAC,EAAc,KAAf,CAAqC,kBAA6B,aAC/D,UACiB,CAAA,CACC,CAAA,CAAA,CAE3B,CCjCA,SAAS,EAAkC,CACzC,SAC4F,CAG5F,MAAO,CACL,GAHqB,EAAwB,CAAE,OAAM,CAGrC,EAChB,QAAS,CACX,CACF,CCvBA,SAAS,EAAmC,CAC1C,kBACA,oBACA,eACA,mBACA,WACA,gBACA,WACA,YACA,QACA,OACA,aACA,aACA,WAC0C,CAC1C,IAAM,EAAgB,EAAwB,CAAE,MAAO,CAAE,YAAW,QAAO,MAAK,CAAE,CAAC,EAE/E,EACF,EAAC,EAAc,SAAf,CAAkC,WAAyB,eAAgB,CAAA,EAGzE,IAAqB,IAAA,IAQd,IAAsB,IAAA,IAAa,IAAiB,IAAA,MAC7D,EACE,EAAC,EAAc,SAAf,CACqB,oBACL,eACJ,WACK,eAChB,CAAA,GAdH,EACE,EAAC,EAAc,SAAf,CACoB,mBACR,WACK,eAChB,CAAA,EAaL,IAAI,EACF,EAAC,EAAc,QAAf,CAAwC,kBAA0B,UAC/D,UACoB,CAAA,EAyBzB,OAtBI,EACF,EACE,EAAC,EAAc,QAAf,CACmB,kBACR,UACG,aAEX,UACoB,CAAA,EAEhB,IACT,EACE,EAAC,EAAc,QAAf,CACmB,kBACR,UACG,aAEX,UACoB,CAAA,GAKzB,EAAC,EAAc,QAAf,CAAA,SAAA,CACG,EACA,CACoB,CAAA,CAAA,CAE3B"}

package/dist/Tab/index.d.ts

@@ -0,0 +1,103 @@
+import { TabProps } from "@mui/material/Tab";
+import { TabsProps } from "@mui/material/Tabs";
+import { Dispatch, JSX, ReactNode, SetStateAction } from "react";
+import { OptionalOnCondition } from "@alextheman/utility";
+//#region src/root/types/ContextHookOptions.d.ts
+interface ContextHookOptions<Strict extends boolean = true> {
+  /** Error if the context is missing if this is set to true. */
+  strict?: Strict;
+}
+//#endregion
+//#region src/Tab/TabProvider.d.ts
+interface TabContextValue<TabState extends string = string> {
+  tab: TabState;
+  setTab: Dispatch<SetStateAction<TabState>>;
+}
+interface TabProviderProps<TabState extends string = string> extends TabContextValue<TabState> {
+  children: ReactNode;
+}
+/** Access the TabContext directly. */
+declare function useTabContext<TabState extends string = string, Strict extends boolean = true>({
+  strict
+}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, TabContextValue<TabState>>;
+/**
+ * A provider for a context that manages tab grouping.
+ *
+ * @template TabState The possible values for the tab.
+ */
+declare function TabProvider<TabState extends string = string>({
+  children,
+  tab,
+  setTab
+}: TabProviderProps<TabState>): import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/Tab/TabItem.d.ts
+interface TabItemProps<TabState extends string = string> extends Omit<TabProps, "value"> {
+  value: TabState;
+}
+/**
+ * Renders a tab to be used within a `TabProvider`
+ *
+ * @template TabState The possible values for the tab.
+ */
+declare function TabItem<TabState extends string = string>({
+  label,
+  value,
+  ...tabProps
+}: TabItemProps<TabState>): import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/Tab/TabList.d.ts
+interface TabListProps extends Omit<TabsProps, "value"> {
+  children: ReactNode;
+}
+/** Takes the tabs provided as the children and renders them in a list. Should be used with `TabProvider`. */
+declare function TabList({
+  children,
+  onChange,
+  ...tabListProps
+}: TabListProps): import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/Tab/TabPanel.d.ts
+interface TabPanelProps<TabState extends string = string> {
+  value: TabState;
+  children: ReactNode;
+}
+/**
+ * Displays the children if the current tab matches the value prop.
+ *
+ * @template TabState The possible values for the tab.
+ */
+declare function TabPanel<TabState extends string = string>({
+  value,
+  children
+}: TabPanelProps<TabState>): ReactNode;
+//#endregion
+//#region src/Tab/createTabGroup.d.ts
+interface TabComponents<TabState extends string = string> {
+  /** Provides the context for the tab grouping. */
+  Context: (props: {
+    children: ReactNode;
+  }) => JSX.Element;
+  /** Takes the tabs provided as the children and renders them in a list. Should be used with the tab context. */
+  List: typeof TabList;
+  /**
+   * Renders a tab to be used within the context.
+   *
+   * @template TabState The possible values for the tab.
+   */
+  Item: typeof TabItem<TabState>;
+  /**
+   * Displays the children if the current tab in the `Tab.Context` matches the value prop.
+   *
+   * @template TabState The possible values for the tab.
+   */
+  Panel: typeof TabPanel<TabState>;
+}
+/** A creator function to create the tab group with the tab state fully typed throughout. */
+declare function createTabGroup<TabState extends string = string>({
+  tab,
+  setTab
+}: TabContextValue<TabState>): TabComponents<TabState>;
+//#endregion
+export { type TabContextValue, TabItem, type TabItemProps, TabList, type TabListProps, TabPanel, type TabPanelProps, TabProvider, type TabProviderProps, createTabGroup, useTabContext };
+//# sourceMappingURL=index.d.ts.map

package/dist/Tab/index.js

@@ -0,0 +1,2 @@
+import e from"@mui/material/Tab";import{jsx as t}from"react/jsx-runtime";import n from"@mui/material/Tabs";import{DataError as r}from"@alextheman/utility/v6";import{createContext as i,use as a}from"react";function o({label:n,value:r,...i}){return t(e,{label:n??r,value:r,...i})}const s=i(void 0);function c({strict:e=!0}={}){let t=a(s);if(e&&!t)throw new r({strict:e,context:t},`TAB_PROVIDER_NOT_FOUND`,`Could not find the TabProvider. Please double-check that it is present.`);return t}function l({children:e,tab:n,setTab:r}){return t(s,{value:{tab:n,setTab:r},children:e})}function u({children:e,onChange:r,...i}){let{tab:a,setTab:o}=c();return t(n,{value:a,onChange:(e,t)=>{r&&r(e,t),!e.defaultPrevented&&o(t)},...i,children:e})}function d({value:e,children:t}){let{tab:n}=c();return e===n?t:null}function f({tab:e,setTab:n}){return{Context:({children:r})=>t(l,{tab:e,setTab:n,children:r}),List:u,Item:o,Panel:d}}export{o as TabItem,u as TabList,d as TabPanel,l as TabProvider,f as createTabGroup,c as useTabContext};
+//# sourceMappingURL=index.js.map