@oneblink/apps-react 4.1.0-beta.7 → 4.1.0-beta.8

package/dist/hooks/useIsOffline.d.ts

@@ -1,6 +1,60 @@
 import * as React from 'react';
+/**
+ * @param type
+ * @param listener
+ * @group Hooks
+ */
 export declare const useNetworkChangeEffect: (type: 'online' | 'offline', listener: () => unknown) => void;
+/**
+ * IsOfflineContextProvider is a React Component that provides the `isOffline`
+ * state for components further down your component tree to consume. It should
+ * be used to wrap the components requiring the state.
+ *
+ * - **This component is required in your component tree to be able to consume the
+ *   [`useIsOffline`](./useIsOffline.html) hook.**
+ *
+ * ### Usage
+ *
+ * ```jsx
+ * import { IsOfflineContextProvider } from '@oneblink/apps-react'
+ *
+ * const TopLevelComponent = () => {
+ *   return (
+ *     <IsOfflineContextProvider>
+ *       <div>
+ *         <ComponentThatRequiresOfflineState />
+ *       </div>
+ *     </IsOfflineContextProvider>
+ *   )
+ * }
+ *
+ * export default TopLevelComponent
+ * ```
+ *
+ * @param props
+ * @returns
+ * @group Components
+ */
 export declare function IsOfflineContextProvider({ children, }: {
     children: React.ReactNode;
 }): JSX.Element;
+/**
+ * This function is a react hook for determining whether an application is in an
+ * offline state.
+ *
+ * - **This component requires
+ *   [`<IsOfflineContextProvider/>`](./IsOfflineContextProvider.html) to be
+ *   present in your component tree.**
+ *
+ * ## Example
+ *
+ * ```js
+ * import { useIsOffline } from '@oneblink/apps-react'
+ *
+ * const isOffline = useIsOffline()
+ * ```
+ *
+ * @returns
+ * @group Hooks
+ */
 export default function useIsOffline(): boolean;

package/dist/hooks/useIsOffline.js

@@ -3,6 +3,11 @@ import { offlineService } from '@oneblink/apps';
 import useBooleanState from '../hooks/useBooleanState';
 const defaultValue = offlineService.isOffline();
 const IsOfflineContext = React.createContext(defaultValue);
+/**
+ * @param type
+ * @param listener
+ * @group Hooks
+ */
 export const useNetworkChangeEffect = (type, listener) => {
     React.useEffect(() => {
         // Stupid cordova seems to require that offline/online
@@ -15,12 +20,61 @@ export const useNetworkChangeEffect = (type, listener) => {
         };
     }, [type, listener]);
 };
+/**
+ * IsOfflineContextProvider is a React Component that provides the `isOffline`
+ * state for components further down your component tree to consume. It should
+ * be used to wrap the components requiring the state.
+ *
+ * - **This component is required in your component tree to be able to consume the
+ *   [`useIsOffline`](./useIsOffline.html) hook.**
+ *
+ * ### Usage
+ *
+ * ```jsx
+ * import { IsOfflineContextProvider } from '@oneblink/apps-react'
+ *
+ * const TopLevelComponent = () => {
+ *   return (
+ *     <IsOfflineContextProvider>
+ *       <div>
+ *         <ComponentThatRequiresOfflineState />
+ *       </div>
+ *     </IsOfflineContextProvider>
+ *   )
+ * }
+ *
+ * export default TopLevelComponent
+ * ```
+ *
+ * @param props
+ * @returns
+ * @group Components
+ */
 export function IsOfflineContextProvider({ children, }) {
     const [isOffline, goOffline, goOnline] = useBooleanState(defaultValue);
     useNetworkChangeEffect('online', goOnline);
     useNetworkChangeEffect('offline', goOffline);
     return (React.createElement(IsOfflineContext.Provider, { value: isOffline }, children));
 }
+/**
+ * This function is a react hook for determining whether an application is in an
+ * offline state.
+ *
+ * - **This component requires
+ *   [`<IsOfflineContextProvider/>`](./IsOfflineContextProvider.html) to be
+ *   present in your component tree.**
+ *
+ * ## Example
+ *
+ * ```js
+ * import { useIsOffline } from '@oneblink/apps-react'
+ *
+ * const isOffline = useIsOffline()
+ * ```
+ *
+ * @returns
+ * @group Hooks
+ */
 export default function useIsOffline() {
     return React.useContext(IsOfflineContext);
 }

package/dist/hooks/useIsOffline.js.map

@@ -1 +1 @@
-{"version":3,"file":"useIsOffline.js","sourceRoot":"","sources":["../../src/hooks/useIsOffline.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,eAAe,MAAM,0BAA0B,CAAA;AAEtD,MAAM,YAAY,GAAG,cAAc,CAAC,SAAS,EAAE,CAAA;AAE/C,MAAM,gBAAgB,GAAG,KAAK,CAAC,aAAa,CAAU,YAAY,CAAC,CAAA;AAEnE,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,IAA0B,EAC1B,QAAuB,EACvB,EAAE;IACF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,sDAAsD;QACtD,sDAAsD;QACtD,qBAAqB;QACrB,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAA;QAClD,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;QAExC,OAAO,GAAG,EAAE;YACV,OAAO,CAAC,mBAAmB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;QAC7C,CAAC,CAAA;IACH,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAA;AACtB,CAAC,CAAA;AAED,MAAM,UAAU,wBAAwB,CAAC,EACvC,QAAQ,GAGT;IACC,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAC,GAAG,eAAe,CAAC,YAAY,CAAC,CAAA;IAEtE,sBAAsB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAC1C,sBAAsB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;IAE5C,OAAO,CACL,oBAAC,gBAAgB,CAAC,QAAQ,IAAC,KAAK,EAAE,SAAS,IACxC,QAAQ,CACiB,CAC7B,CAAA;AACH,CAAC;AAED,MAAM,CAAC,OAAO,UAAU,YAAY;IAClC,OAAO,KAAK,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAA;AAC3C,CAAC","sourcesContent":["import * as React from 'react'\n\nimport { offlineService } from '@oneblink/apps'\nimport useBooleanState from '../hooks/useBooleanState'\n\nconst defaultValue = offlineService.isOffline()\n\nconst IsOfflineContext = React.createContext<boolean>(defaultValue)\n\nexport const useNetworkChangeEffect = (\n  type: 'online' | 'offline',\n  listener: () => unknown,\n) => {\n  React.useEffect(() => {\n    // Stupid cordova seems to require that offline/online\n    // listeners are set on the document and browsers seem\n    // to require window.\n    const element = window.cordova ? document : window\n    element.addEventListener(type, listener)\n\n    return () => {\n      element.removeEventListener(type, listener)\n    }\n  }, [type, listener])\n}\n\nexport function IsOfflineContextProvider({\n  children,\n}: {\n  children: React.ReactNode\n}) {\n  const [isOffline, goOffline, goOnline] = useBooleanState(defaultValue)\n\n  useNetworkChangeEffect('online', goOnline)\n  useNetworkChangeEffect('offline', goOffline)\n\n  return (\n    <IsOfflineContext.Provider value={isOffline}>\n      {children}\n    </IsOfflineContext.Provider>\n  )\n}\n\nexport default function useIsOffline() {\n  return React.useContext(IsOfflineContext)\n}\n"]}
+{"version":3,"file":"useIsOffline.js","sourceRoot":"","sources":["../../src/hooks/useIsOffline.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,eAAe,MAAM,0BAA0B,CAAA;AAEtD,MAAM,YAAY,GAAG,cAAc,CAAC,SAAS,EAAE,CAAA;AAE/C,MAAM,gBAAgB,GAAG,KAAK,CAAC,aAAa,CAAU,YAAY,CAAC,CAAA;AAEnE;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,IAA0B,EAC1B,QAAuB,EACvB,EAAE;IACF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,sDAAsD;QACtD,sDAAsD;QACtD,qBAAqB;QACrB,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAA;QAClD,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;QAExC,OAAO,GAAG,EAAE;YACV,OAAO,CAAC,mBAAmB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;QAC7C,CAAC,CAAA;IACH,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAA;AACtB,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,UAAU,wBAAwB,CAAC,EACvC,QAAQ,GAGT;IACC,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAC,GAAG,eAAe,CAAC,YAAY,CAAC,CAAA;IAEtE,sBAAsB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAC1C,sBAAsB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;IAE5C,OAAO,CACL,oBAAC,gBAAgB,CAAC,QAAQ,IAAC,KAAK,EAAE,SAAS,IACxC,QAAQ,CACiB,CAC7B,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY;IAClC,OAAO,KAAK,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAA;AAC3C,CAAC","sourcesContent":["import * as React from 'react'\n\nimport { offlineService } from '@oneblink/apps'\nimport useBooleanState from '../hooks/useBooleanState'\n\nconst defaultValue = offlineService.isOffline()\n\nconst IsOfflineContext = React.createContext<boolean>(defaultValue)\n\n/**\n * @param type\n * @param listener\n * @group Hooks\n */\nexport const useNetworkChangeEffect = (\n  type: 'online' | 'offline',\n  listener: () => unknown,\n) => {\n  React.useEffect(() => {\n    // Stupid cordova seems to require that offline/online\n    // listeners are set on the document and browsers seem\n    // to require window.\n    const element = window.cordova ? document : window\n    element.addEventListener(type, listener)\n\n    return () => {\n      element.removeEventListener(type, listener)\n    }\n  }, [type, listener])\n}\n\n/**\n * IsOfflineContextProvider is a React Component that provides the `isOffline`\n * state for components further down your component tree to consume. It should\n * be used to wrap the components requiring the state.\n *\n * - **This component is required in your component tree to be able to consume the\n *   [`useIsOffline`](./useIsOffline.html) hook.**\n *\n * ### Usage\n *\n * ```jsx\n * import { IsOfflineContextProvider } from '@oneblink/apps-react'\n *\n * const TopLevelComponent = () => {\n *   return (\n *     <IsOfflineContextProvider>\n *       <div>\n *         <ComponentThatRequiresOfflineState />\n *       </div>\n *     </IsOfflineContextProvider>\n *   )\n * }\n *\n * export default TopLevelComponent\n * ```\n *\n * @param props\n * @returns\n * @group Components\n */\nexport function IsOfflineContextProvider({\n  children,\n}: {\n  children: React.ReactNode\n}) {\n  const [isOffline, goOffline, goOnline] = useBooleanState(defaultValue)\n\n  useNetworkChangeEffect('online', goOnline)\n  useNetworkChangeEffect('offline', goOffline)\n\n  return (\n    <IsOfflineContext.Provider value={isOffline}>\n      {children}\n    </IsOfflineContext.Provider>\n  )\n}\n\n/**\n * This function is a react hook for determining whether an application is in an\n * offline state.\n *\n * - **This component requires\n *   [`<IsOfflineContextProvider/>`](./IsOfflineContextProvider.html) to be\n *   present in your component tree.**\n *\n * ## Example\n *\n * ```js\n * import { useIsOffline } from '@oneblink/apps-react'\n *\n * const isOffline = useIsOffline()\n * ```\n *\n * @returns\n * @group Hooks\n */\nexport default function useIsOffline() {\n  return React.useContext(IsOfflineContext)\n}\n"]}

package/dist/hooks/useLoadDataState.d.ts

@@ -1,15 +1,58 @@
 import * as React from 'react';
 export type LoadDataState<T> = {
     status: 'SUCCESS';
+    /** Your data. */
     result: T;
 } | {
     status: 'ERROR';
+    /** A JavaScript `Error` object. */
     error: Error;
 } | {
     status: 'LOADING';
 };
+/**
+ * This function is a react hook for managing the state involved with loading
+ * data.
+ *
+ * ## Example
+ *
+ * ```js
+ * import { useLoadDataState } from '@oneblink/apps-react'
+ * const fetchData = async () => {
+ *   const response = await fetch(`https://some-website.com/api?data=data`)
+ *
+ *   if (!response.ok) {
+ *     const text = await response.text()
+ *     throw new Error(text)
+ *   }
+ *
+ *   return await response.json()
+ * }
+ *
+ * const MyComponent = () => {
+ *   const [state, refresh, setResult] = useLoadDataState(fetchData)
+ *
+ *   switch (state.status) {
+ *     case 'LOADING':
+ *       return <Loading />
+ *     case 'ERROR':
+ *       return <Error message={state.error} />
+ *     case 'SUCCESS':
+ *     // RENDER UI
+ *   }
+ * }
+ *
+ * export default MyComponent
+ * ```
+ *
+ * @typeParam T The type of the data returned by your `onLoad` function
+ * @param onLoad The function that fetches your data. Should be a Promise that
+ *   returns your data
+ * @returns
+ * @group Hooks
+ */
 export default function useLoadDataState<T>(onLoad: (abortSignal?: AbortSignal) => Promise<T>): [
-    LoadDataState<T>,
-    (abortSignal?: AbortSignal) => void,
-    React.Dispatch<React.SetStateAction<T>>
+    state: LoadDataState<T>,
+    handleLoad: (abortSignal?: AbortSignal) => void,
+    setResult: React.Dispatch<React.SetStateAction<T>>
 ];

package/dist/hooks/useLoadDataState.js

@@ -1,5 +1,46 @@
 import * as React from 'react';
 import useIsMounted from './useIsMounted';
+/**
+ * This function is a react hook for managing the state involved with loading
+ * data.
+ *
+ * ## Example
+ *
+ * ```js
+ * import { useLoadDataState } from '@oneblink/apps-react'
+ * const fetchData = async () => {
+ *   const response = await fetch(`https://some-website.com/api?data=data`)
+ *
+ *   if (!response.ok) {
+ *     const text = await response.text()
+ *     throw new Error(text)
+ *   }
+ *
+ *   return await response.json()
+ * }
+ *
+ * const MyComponent = () => {
+ *   const [state, refresh, setResult] = useLoadDataState(fetchData)
+ *
+ *   switch (state.status) {
+ *     case 'LOADING':
+ *       return <Loading />
+ *     case 'ERROR':
+ *       return <Error message={state.error} />
+ *     case 'SUCCESS':
+ *     // RENDER UI
+ *   }
+ * }
+ *
+ * export default MyComponent
+ * ```
+ *
+ * @typeParam T The type of the data returned by your `onLoad` function
+ * @param onLoad The function that fetches your data. Should be a Promise that
+ *   returns your data
+ * @returns
+ * @group Hooks
+ */
 export default function useLoadDataState(onLoad) {
     const isMounted = useIsMounted();
     const [state, setState] = React.useState({

package/dist/hooks/useLoadDataState.js.map

@@ -1 +1 @@
-{"version":3,"file":"useLoadDataState.js","sourceRoot":"","sources":["../../src/hooks/useLoadDataState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAC9B,OAAO,YAAY,MAAM,gBAAgB,CAAA;AAezC,MAAM,CAAC,OAAO,UAAU,gBAAgB,CACtC,MAAiD;IAMjD,MAAM,SAAS,GAAG,YAAY,EAAE,CAAA;IAChC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAmB;QACzD,MAAM,EAAE,SAAS;KAClB,CAAC,CAAA;IAEF,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,CAClC,KAAK,EAAE,WAAyB,EAAE,EAAE;QAClC,QAAQ,CAAC;YACP,MAAM,EAAE,SAAS;SAClB,CAAC,CAAA;QACF,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,CAAA;YACxC,IAAI,SAAS,CAAC,OAAO,IAAI,CAAC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAA,EAAE;gBAC9C,QAAQ,CAAC;oBACP,MAAM,EAAE,SAAS;oBACjB,MAAM;iBACP,CAAC,CAAA;aACH;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,SAAS,CAAC,OAAO,IAAI,CAAC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAA,EAAE;gBAC9C,QAAQ,CAAC;oBACP,MAAM,EAAE,OAAO;oBACf,KAAK,EAAE,GAAY;iBACpB,CAAC,CAAA;aACH;SACF;IACH,CAAC,EACD,CAAC,SAAS,EAAE,MAAM,CAAC,CACpB,CAAA;IAED,MAAM,SAAS,GAA4C,KAAK,CAAC,WAAW,CAC1E,CAAC,MAAM,EAAE,EAAE;QACT,QAAQ,CAAC,CAAC,YAA8B,EAAE,EAAE;YAC1C,IAAI,YAAY,CAAC,MAAM,KAAK,SAAS,EAAE;gBACrC,OAAO;oBACL,GAAG,YAAY;oBACf,MAAM,EACJ,OAAO,MAAM,KAAK,UAAU;wBAC1B,CAAC,CAAC,oFAAoF;4BACpF,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC;wBAC7B,CAAC,CAAC,MAAM;iBACb,CAAA;aACF;iBAAM;gBACL,OAAO,YAAY,CAAA;aACpB;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,EACD,EAAE,CACH,CAAA;IAED,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;QAC7C,UAAU,CAAC,eAAe,CAAC,MAAM,CAAC,CAAA;QAClC,OAAO,GAAG,EAAE;YACV,eAAe,CAAC,KAAK,EAAE,CAAA;QACzB,CAAC,CAAA;IACH,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAA;IAEhB,OAAO,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,CAAC,CAAA;AACvC,CAAC","sourcesContent":["import * as React from 'react'\nimport useIsMounted from './useIsMounted'\n\nexport type LoadDataState<T> =\n  | {\n      status: 'SUCCESS'\n      result: T\n    }\n  | {\n      status: 'ERROR'\n      error: Error\n    }\n  | {\n      status: 'LOADING'\n    }\n\nexport default function useLoadDataState<T>(\n  onLoad: (abortSignal?: AbortSignal) => Promise<T>,\n): [\n  LoadDataState<T>,\n  (abortSignal?: AbortSignal) => void,\n  React.Dispatch<React.SetStateAction<T>>,\n] {\n  const isMounted = useIsMounted()\n  const [state, setState] = React.useState<LoadDataState<T>>({\n    status: 'LOADING',\n  })\n\n  const handleLoad = React.useCallback(\n    async (abortSignal?: AbortSignal) => {\n      setState({\n        status: 'LOADING',\n      })\n      try {\n        const result = await onLoad(abortSignal)\n        if (isMounted.current && !abortSignal?.aborted) {\n          setState({\n            status: 'SUCCESS',\n            result,\n          })\n        }\n      } catch (err) {\n        if (isMounted.current && !abortSignal?.aborted) {\n          setState({\n            status: 'ERROR',\n            error: err as Error,\n          })\n        }\n      }\n    },\n    [isMounted, onLoad],\n  )\n\n  const setResult: React.Dispatch<React.SetStateAction<T>> = React.useCallback(\n    (setter) => {\n      setState((currentState: LoadDataState<T>) => {\n        if (currentState.status === 'SUCCESS') {\n          return {\n            ...currentState,\n            result:\n              typeof setter === 'function'\n                ? // @ts-expect-error Typescript cannot tell between a generic type (T) and a function\n                  setter(currentState.result)\n                : setter,\n          }\n        } else {\n          return currentState\n        }\n      })\n    },\n    [],\n  )\n\n  React.useEffect(() => {\n    const abortController = new AbortController()\n    handleLoad(abortController.signal)\n    return () => {\n      abortController.abort()\n    }\n  }, [handleLoad])\n\n  return [state, handleLoad, setResult]\n}\n"]}
+{"version":3,"file":"useLoadDataState.js","sourceRoot":"","sources":["../../src/hooks/useLoadDataState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAC9B,OAAO,YAAY,MAAM,gBAAgB,CAAA;AAiBzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CACtC,MAAiD;IAMjD,MAAM,SAAS,GAAG,YAAY,EAAE,CAAA;IAChC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAmB;QACzD,MAAM,EAAE,SAAS;KAClB,CAAC,CAAA;IAEF,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,CAClC,KAAK,EAAE,WAAyB,EAAE,EAAE;QAClC,QAAQ,CAAC;YACP,MAAM,EAAE,SAAS;SAClB,CAAC,CAAA;QACF,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,CAAA;YACxC,IAAI,SAAS,CAAC,OAAO,IAAI,CAAC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAA,EAAE;gBAC9C,QAAQ,CAAC;oBACP,MAAM,EAAE,SAAS;oBACjB,MAAM;iBACP,CAAC,CAAA;aACH;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,SAAS,CAAC,OAAO,IAAI,CAAC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAA,EAAE;gBAC9C,QAAQ,CAAC;oBACP,MAAM,EAAE,OAAO;oBACf,KAAK,EAAE,GAAY;iBACpB,CAAC,CAAA;aACH;SACF;IACH,CAAC,EACD,CAAC,SAAS,EAAE,MAAM,CAAC,CACpB,CAAA;IAED,MAAM,SAAS,GAA4C,KAAK,CAAC,WAAW,CAC1E,CAAC,MAAM,EAAE,EAAE;QACT,QAAQ,CAAC,CAAC,YAA8B,EAAE,EAAE;YAC1C,IAAI,YAAY,CAAC,MAAM,KAAK,SAAS,EAAE;gBACrC,OAAO;oBACL,GAAG,YAAY;oBACf,MAAM,EACJ,OAAO,MAAM,KAAK,UAAU;wBAC1B,CAAC,CAAC,oFAAoF;4BACpF,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC;wBAC7B,CAAC,CAAC,MAAM;iBACb,CAAA;aACF;iBAAM;gBACL,OAAO,YAAY,CAAA;aACpB;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,EACD,EAAE,CACH,CAAA;IAED,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;QAC7C,UAAU,CAAC,eAAe,CAAC,MAAM,CAAC,CAAA;QAClC,OAAO,GAAG,EAAE;YACV,eAAe,CAAC,KAAK,EAAE,CAAA;QACzB,CAAC,CAAA;IACH,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAA;IAEhB,OAAO,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,CAAC,CAAA;AACvC,CAAC","sourcesContent":["import * as React from 'react'\nimport useIsMounted from './useIsMounted'\n\nexport type LoadDataState<T> =\n  | {\n      status: 'SUCCESS'\n      /** Your data. */\n      result: T\n    }\n  | {\n      status: 'ERROR'\n      /** A JavaScript `Error` object. */\n      error: Error\n    }\n  | {\n      status: 'LOADING'\n    }\n\n/**\n * This function is a react hook for managing the state involved with loading\n * data.\n *\n * ## Example\n *\n * ```js\n * import { useLoadDataState } from '@oneblink/apps-react'\n * const fetchData = async () => {\n *   const response = await fetch(`https://some-website.com/api?data=data`)\n *\n *   if (!response.ok) {\n *     const text = await response.text()\n *     throw new Error(text)\n *   }\n *\n *   return await response.json()\n * }\n *\n * const MyComponent = () => {\n *   const [state, refresh, setResult] = useLoadDataState(fetchData)\n *\n *   switch (state.status) {\n *     case 'LOADING':\n *       return <Loading />\n *     case 'ERROR':\n *       return <Error message={state.error} />\n *     case 'SUCCESS':\n *     // RENDER UI\n *   }\n * }\n *\n * export default MyComponent\n * ```\n *\n * @typeParam T The type of the data returned by your `onLoad` function\n * @param onLoad The function that fetches your data. Should be a Promise that\n *   returns your data\n * @returns\n * @group Hooks\n */\nexport default function useLoadDataState<T>(\n  onLoad: (abortSignal?: AbortSignal) => Promise<T>,\n): [\n  state: LoadDataState<T>,\n  handleLoad: (abortSignal?: AbortSignal) => void,\n  setResult: React.Dispatch<React.SetStateAction<T>>,\n] {\n  const isMounted = useIsMounted()\n  const [state, setState] = React.useState<LoadDataState<T>>({\n    status: 'LOADING',\n  })\n\n  const handleLoad = React.useCallback(\n    async (abortSignal?: AbortSignal) => {\n      setState({\n        status: 'LOADING',\n      })\n      try {\n        const result = await onLoad(abortSignal)\n        if (isMounted.current && !abortSignal?.aborted) {\n          setState({\n            status: 'SUCCESS',\n            result,\n          })\n        }\n      } catch (err) {\n        if (isMounted.current && !abortSignal?.aborted) {\n          setState({\n            status: 'ERROR',\n            error: err as Error,\n          })\n        }\n      }\n    },\n    [isMounted, onLoad],\n  )\n\n  const setResult: React.Dispatch<React.SetStateAction<T>> = React.useCallback(\n    (setter) => {\n      setState((currentState: LoadDataState<T>) => {\n        if (currentState.status === 'SUCCESS') {\n          return {\n            ...currentState,\n            result:\n              typeof setter === 'function'\n                ? // @ts-expect-error Typescript cannot tell between a generic type (T) and a function\n                  setter(currentState.result)\n                : setter,\n          }\n        } else {\n          return currentState\n        }\n      })\n    },\n    [],\n  )\n\n  React.useEffect(() => {\n    const abortController = new AbortController()\n    handleLoad(abortController.signal)\n    return () => {\n      abortController.abort()\n    }\n  }, [handleLoad])\n\n  return [state, handleLoad, setResult]\n}\n"]}