piral-hooks-utils 0.15.0-alpha.3537

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 - 2022 smapiot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,57 @@
+[![Piral Logo](https://github.com/smapiot/piral/raw/main/docs/assets/logo.png)](https://piral.io)
+
+# [Piral Hooks Utils](https://piral.io) · [![GitHub License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/smapiot/piral/blob/main/LICENSE) [![npm version](https://img.shields.io/npm/v/piral-hooks-utils.svg?style=flat)](https://www.npmjs.com/package/piral-hooks-utils) [![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://jestjs.io) [![Gitter Chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/piral-io/community)
+
+A set of hooks and HOCs for pilets and Piral instances.
+
+## Installation
+
+This should only be installed as a dependency (`dependencies`) as it is only designed mostly for runtime / consumption by Piral or pilets. You could also share it explicitly or implicitly from your Piral instance if you'd like to optimize usage in your pilets. It's not required though as the code provided by it is minimal and tree-shakable.
+
+If you'd love to use yarn:
+
+```sh
+yarn add piral-hooks-utils
+```
+
+Alternatively, npm works reliably, too:
+
+```sh
+npm i --save piral-hooks-utils
+```
+
+## Included Hooks
+
+The following hooks are included.
+
+### `useAfterVisible`
+
+A hook to indicate something was suddenly visible.
+
+### `useAsyncReplace`
+
+Gives a full async lifecycle in a hook.
+
+### `useLockBodyScroll`
+
+Hook that locks scrolling on the main document.
+
+### `useOnClickOutside`
+
+Hook that detects if a click outside the given reference has been performed.
+
+### `useOnScreenVisible`
+
+Hook that detects if a reference element within the main document is visible.
+
+### `usePiletApi`
+
+Retrieves the Pilet API stored in the provider.
+
+### `usePrompt`
+
+Hook to notify the user in case of potential data loss when performing a page transition (internal or external).
+
+## License
+
+Piral is released using the MIT license. For more information see the [license file](./LICENSE).

package/esm/contexts/PiletApiProvider.d.ts

@@ -0,0 +1,2 @@
+import * as React from 'react';
+export declare const PiletApiProvider: React.Context<any>;

package/esm/contexts/PiletApiProvider.js

@@ -0,0 +1,3 @@
+import * as React from 'react';
+export const PiletApiProvider = React.createContext(undefined);
+//# sourceMappingURL=PiletApiProvider.js.map

package/esm/contexts/PiletApiProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PiletApiProvider.js","sourceRoot":"","sources":["../../src/contexts/PiletApiProvider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,CAAC,aAAa,CAAM,SAAS,CAAC,CAAC"}

package/esm/contexts/index.d.ts

@@ -0,0 +1 @@
+export * from './PiletApiProvider';

package/esm/contexts/index.js

@@ -0,0 +1,2 @@
+export * from './PiletApiProvider';
+//# sourceMappingURL=index.js.map

package/esm/contexts/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/contexts/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC"}

package/esm/hocs/index.d.ts

@@ -0,0 +1 @@
+export * from './withProvider';

package/esm/hocs/index.js

@@ -0,0 +1,2 @@
+export * from './withProvider';
+//# sourceMappingURL=index.js.map

package/esm/hocs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/hocs/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC"}

package/esm/hocs/withProvider.d.ts

@@ -0,0 +1,15 @@
+import * as React from 'react';
+interface BaseComponentProps {
+    /**
+     * The currently used pilet API.
+     */
+    piral: any;
+}
+/**
+ * Wraps the component in a Pilet API provider allowing to make use of
+ * the `usePilet` hook.
+ * @param Component The component that should be wrapped in a provider.
+ * @returns The wrapped component.
+ */
+export declare function withPiletApi<T>(Component: React.FC<T>): React.FC<T & BaseComponentProps>;
+export {};

package/esm/hocs/withProvider.js

@@ -0,0 +1,13 @@
+import * as React from 'react';
+import { PiletApiProvider } from '../contexts';
+/**
+ * Wraps the component in a Pilet API provider allowing to make use of
+ * the `usePilet` hook.
+ * @param Component The component that should be wrapped in a provider.
+ * @returns The wrapped component.
+ */
+export function withPiletApi(Component) {
+    return (props) => (React.createElement(PiletApiProvider.Provider, { value: props.piral },
+        React.createElement(Component, Object.assign({}, props))));
+}
+//# sourceMappingURL=withProvider.js.map

package/esm/hocs/withProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"withProvider.js","sourceRoot":"","sources":["../../src/hocs/withProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAS/C;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAI,SAAsB;IACpD,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAChB,oBAAC,gBAAgB,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,CAAC,KAAK;QAC3C,oBAAC,SAAS,oBAAK,KAAK,EAAI,CACE,CAC7B,CAAC;AACJ,CAAC"}

package/esm/hooks/afterVisible.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+/**
+ * A hook to indicate something was suddenly visible.
+ * @param time The time after which it should be triggered.
+ * @param cb The callback to use when the part was visible.
+ * @returns The reference to the element which should be watched.
+ */
+export declare function useAfterVisible(time: number, cb: () => void): import("react").MutableRefObject<HTMLDivElement>;

package/esm/hooks/afterVisible.js

@@ -0,0 +1,26 @@
+import { useState, useEffect, useRef } from 'react';
+/**
+ * A hook to indicate something was suddenly visible.
+ * @param time The time after which it should be triggered.
+ * @param cb The callback to use when the part was visible.
+ * @returns The reference to the element which should be watched.
+ */
+export function useAfterVisible(time, cb) {
+    const ref = useRef(null);
+    const [intersecting, setIntersecting] = useState(false);
+    useEffect(() => {
+        const observer = new IntersectionObserver((ev) => {
+            setIntersecting(ev.some((m) => m.isIntersecting));
+        });
+        observer.observe(ref.current);
+        return () => observer.disconnect();
+    }, [ref.current]);
+    useEffect(() => {
+        if (intersecting) {
+            const tid = setTimeout(cb, time);
+            return () => clearTimeout(tid);
+        }
+    }, [intersecting, cb]);
+    return ref;
+}
+//# sourceMappingURL=afterVisible.js.map

package/esm/hooks/afterVisible.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"afterVisible.js","sourceRoot":"","sources":["../../src/hooks/afterVisible.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAEpD;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY,EAAE,EAAc;IAC1D,MAAM,GAAG,GAAG,MAAM,CAAiB,IAAI,CAAC,CAAC;IACzC,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAExD,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,QAAQ,GAAG,IAAI,oBAAoB,CAAC,CAAC,EAAE,EAAE,EAAE;YAC/C,eAAe,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC9B,OAAO,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;IACrC,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;IAElB,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,YAAY,EAAE;YAChB,MAAM,GAAG,GAAG,UAAU,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;YACjC,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;SAChC;IACH,CAAC,EAAE,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,CAAC;IAEvB,OAAO,GAAG,CAAC;AACb,CAAC"}

package/esm/hooks/asyncReplace.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Gives a full async lifecycle in a hook.
+ * @param action The lazy loader.
+ * @param resolve The resolve function getting the result from the promise.
+ * @returns The current executing state, and the trigger to start the async operation.
+ */
+export declare function useAsyncReplace<T = void>(action: () => Promise<T>, resolve?: (result: T) => void): [boolean, () => void, Error | undefined];

package/esm/hooks/asyncReplace.js

@@ -0,0 +1,21 @@
+import { useState, useEffect } from 'react';
+/**
+ * Gives a full async lifecycle in a hook.
+ * @param action The lazy loader.
+ * @param resolve The resolve function getting the result from the promise.
+ * @returns The current executing state, and the trigger to start the async operation.
+ */
+export function useAsyncReplace(action, resolve = () => { }) {
+    const [executing, setExecuting] = useState(false);
+    const error = executing instanceof Error ? executing : undefined;
+    useEffect(() => {
+        if (executing === true) {
+            let active = true;
+            action().then((result) => active && resolve(result), (err) => active && setExecuting(err));
+            return () => (active = false);
+        }
+        return () => { };
+    }, [executing]);
+    return [executing === true, () => setExecuting(true), error];
+}
+//# sourceMappingURL=asyncReplace.js.map

package/esm/hooks/asyncReplace.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asyncReplace.js","sourceRoot":"","sources":["../../src/hooks/asyncReplace.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAE5C;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAC7B,MAAwB,EACxB,UAA+B,GAAG,EAAE,GAAE,CAAC;IAEvC,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,QAAQ,CAAkB,KAAK,CAAC,CAAC;IACnE,MAAM,KAAK,GAAG,SAAS,YAAY,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;IAEjE,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,SAAS,KAAK,IAAI,EAAE;YACtB,IAAI,MAAM,GAAG,IAAI,CAAC;YAElB,MAAM,EAAE,CAAC,IAAI,CACX,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,EACrC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,IAAI,YAAY,CAAC,GAAG,CAAC,CACrC,CAAC;YAEF,OAAO,GAAG,EAAE,CAAC,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC;SAC/B;QAED,OAAO,GAAG,EAAE,GAAE,CAAC,CAAC;IAClB,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhB,OAAO,CAAC,SAAS,KAAK,IAAI,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;AAC/D,CAAC"}

package/esm/hooks/index.d.ts

@@ -0,0 +1,7 @@
+export * from './afterVisible';
+export * from './asyncReplace';
+export * from './lockBodyScroll';
+export * from './onClickOutside';
+export * from './onScreenVisible';
+export * from './piletApi';
+export * from './prompt';

package/esm/hooks/index.js

@@ -0,0 +1,8 @@
+export * from './afterVisible';
+export * from './asyncReplace';
+export * from './lockBodyScroll';
+export * from './onClickOutside';
+export * from './onScreenVisible';
+export * from './piletApi';
+export * from './prompt';
+//# sourceMappingURL=index.js.map

package/esm/hooks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC"}

package/esm/hooks/lockBodyScroll.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Hook that locks scrolling on the main document.
+ * Useful for preventing the standard scrolling in context of
+ * a modal dialog.
+ */
+export declare function useLockBodyScroll(): void;

package/esm/hooks/lockBodyScroll.js

@@ -0,0 +1,15 @@
+import { useLayoutEffect } from 'react';
+/**
+ * Hook that locks scrolling on the main document.
+ * Useful for preventing the standard scrolling in context of
+ * a modal dialog.
+ */
+export function useLockBodyScroll() {
+    useLayoutEffect(() => {
+        document.body.style.overflow = 'hidden';
+        return () => {
+            document.body.style.overflow = 'visible';
+        };
+    }, []);
+}
+//# sourceMappingURL=lockBodyScroll.js.map

package/esm/hooks/lockBodyScroll.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lockBodyScroll.js","sourceRoot":"","sources":["../../src/hooks/lockBodyScroll.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,OAAO,CAAC;AAExC;;;;GAIG;AACH,MAAM,UAAU,iBAAiB;IAC/B,eAAe,CAAC,GAAG,EAAE;QACnB,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACxC,OAAO,GAAG,EAAE;YACV,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC3C,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC"}

package/esm/hooks/onClickOutside.d.ts

@@ -0,0 +1,8 @@
+import { RefObject } from 'react';
+/**
+ * Hook that detects if a click outside the given reference
+ * has been performed.
+ * @param ref The reference to the element.
+ * @param handler The callback to invoke when an outside click happened.
+ */
+export declare function useOnClickOutside<T extends HTMLElement>(ref: RefObject<T>, handler: (event: MouseEvent) => void): void;

package/esm/hooks/onClickOutside.js

@@ -0,0 +1,23 @@
+import { useEffect } from 'react';
+/**
+ * Hook that detects if a click outside the given reference
+ * has been performed.
+ * @param ref The reference to the element.
+ * @param handler The callback to invoke when an outside click happened.
+ */
+export function useOnClickOutside(ref, handler) {
+    useEffect(() => {
+        const listener = (event) => {
+            if (ref.current && !ref.current.contains(event.target)) {
+                handler(event);
+            }
+        };
+        document.addEventListener('mousedown', listener);
+        document.addEventListener('touchstart', listener);
+        return () => {
+            document.removeEventListener('mousedown', listener);
+            document.removeEventListener('touchstart', listener);
+        };
+    }, [handler]);
+}
+//# sourceMappingURL=onClickOutside.js.map

package/esm/hooks/onClickOutside.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"onClickOutside.js","sourceRoot":"","sources":["../../src/hooks/onClickOutside.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAa,MAAM,OAAO,CAAC;AAE7C;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAwB,GAAiB,EAAE,OAAoC;IAC9G,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,QAAQ,GAAG,CAAC,KAAiB,EAAE,EAAE;YACrC,IAAI,GAAG,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAc,CAAC,EAAE;gBAC9D,OAAO,CAAC,KAAK,CAAC,CAAC;aAChB;QACH,CAAC,CAAC;QAEF,QAAQ,CAAC,gBAAgB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QACjD,QAAQ,CAAC,gBAAgB,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QAElD,OAAO,GAAG,EAAE;YACV,QAAQ,CAAC,mBAAmB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;YACpD,QAAQ,CAAC,mBAAmB,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QACvD,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;AAChB,CAAC"}

package/esm/hooks/onScreenVisible.d.ts

@@ -0,0 +1,11 @@
+import { RefObject } from 'react';
+/**
+ * Hook that detects if a reference element within the main document is
+ * visible.
+ * Useful for performing some animation or triggering certain actions (e.g.,
+ * loading data for infinity scrolling) when an element appears or is close
+ * to appear on screen.
+ * @param ref The reference element to be visible.
+ * @param rootMargin The tolerance level to the reference element.
+ */
+export declare function useOnScreenVisible<T extends HTMLElement>(ref: RefObject<T>, rootMargin?: string): boolean;

package/esm/hooks/onScreenVisible.js

@@ -0,0 +1,24 @@
+import { useState, useEffect } from 'react';
+/**
+ * Hook that detects if a reference element within the main document is
+ * visible.
+ * Useful for performing some animation or triggering certain actions (e.g.,
+ * loading data for infinity scrolling) when an element appears or is close
+ * to appear on screen.
+ * @param ref The reference element to be visible.
+ * @param rootMargin The tolerance level to the reference element.
+ */
+export function useOnScreenVisible(ref, rootMargin = '0px') {
+    const [isIntersecting, setIntersecting] = useState(false);
+    useEffect(() => {
+        const observer = new IntersectionObserver(([entry]) => setIntersecting(entry.isIntersecting), {
+            rootMargin,
+        });
+        if (ref.current) {
+            observer.observe(ref.current);
+        }
+        return () => observer.unobserve(ref.current);
+    }, []);
+    return isIntersecting;
+}
+//# sourceMappingURL=onScreenVisible.js.map

package/esm/hooks/onScreenVisible.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"onScreenVisible.js","sourceRoot":"","sources":["../../src/hooks/onScreenVisible.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAa,MAAM,OAAO,CAAC;AAEvD;;;;;;;;GAQG;AACH,MAAM,UAAU,kBAAkB,CAAwB,GAAiB,EAAE,UAAU,GAAG,KAAK;IAC7F,MAAM,CAAC,cAAc,EAAE,eAAe,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAE1D,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,QAAQ,GAAG,IAAI,oBAAoB,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE;YAC5F,UAAU;SACX,CAAC,CAAC;QAEH,IAAI,GAAG,CAAC,OAAO,EAAE;YACf,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;SAC/B;QAED,OAAO,GAAG,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,cAAc,CAAC;AACxB,CAAC"}

package/esm/hooks/piletApi.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Retrieves the Pilet API stored in the provider.
+ * The component must be somewhat wrapped in the
+ * PiletApiProvider, e.g., via withPiletApi wrapper.
+ * @returns The Pilet API for this component.
+ */
+export declare function usePiletApi<TPiletApi = any>(): TPiletApi;

package/esm/hooks/piletApi.js

@@ -0,0 +1,12 @@
+import { useContext } from 'react';
+import { PiletApiProvider } from '../contexts';
+/**
+ * Retrieves the Pilet API stored in the provider.
+ * The component must be somewhat wrapped in the
+ * PiletApiProvider, e.g., via withPiletApi wrapper.
+ * @returns The Pilet API for this component.
+ */
+export function usePiletApi() {
+    return useContext(PiletApiProvider);
+}
+//# sourceMappingURL=piletApi.js.map

package/esm/hooks/piletApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"piletApi.js","sourceRoot":"","sources":["../../src/hooks/piletApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACnC,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C;;;;;GAKG;AACH,MAAM,UAAU,WAAW;IACzB,OAAO,UAAU,CAAC,gBAAgB,CAAC,CAAC;AACtC,CAAC"}

package/esm/hooks/prompt.d.ts

@@ -0,0 +1,9 @@
+import type { History, Location } from 'history';
+/**
+ * Hook to notify the user in case of potential data loss when
+ * performing a page transition (internal or external).
+ * @param active True if the prompt should be shown, otherwise false.
+ * @param history The history of the currently used router.
+ * @param message The message to display when the prompt is shown.
+ */
+export declare function usePrompt(active: boolean, history: History, message: string, onTransition?: (location: Location) => void): void;

package/esm/hooks/prompt.js

@@ -0,0 +1,28 @@
+import { useEffect } from 'react';
+/**
+ * Hook to notify the user in case of potential data loss when
+ * performing a page transition (internal or external).
+ * @param active True if the prompt should be shown, otherwise false.
+ * @param history The history of the currently used router.
+ * @param message The message to display when the prompt is shown.
+ */
+export function usePrompt(active, history, message, onTransition) {
+    useEffect(() => {
+        if (active) {
+            const beforeUnload = (ev) => {
+                ev.returnValue = message;
+                return message;
+            };
+            const unlisten = onTransition && history.listen(onTransition);
+            const unblock = message && history.block(message);
+            window.addEventListener('beforeunload', beforeUnload);
+            return () => {
+                unlisten && unlisten();
+                unblock && unblock();
+                window.removeEventListener('beforeunload', beforeUnload);
+            };
+        }
+        return () => { };
+    }, [active, message]);
+}
+//# sourceMappingURL=prompt.js.map

package/esm/hooks/prompt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.js","sourceRoot":"","sources":["../../src/hooks/prompt.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAGlC;;;;;;GAMG;AACF,MAAM,UAAU,SAAS,CACxB,MAAe,EACf,OAAgB,EAChB,OAAe,EACf,YAA2C;IAE3C,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,MAAM,EAAE;YACV,MAAM,YAAY,GAAG,CAAC,EAAqB,EAAE,EAAE;gBAC7C,EAAE,CAAC,WAAW,GAAG,OAAO,CAAC;gBACzB,OAAO,OAAO,CAAC;YACjB,CAAC,CAAC;YACF,MAAM,QAAQ,GAAG,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;YAC9D,MAAM,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAClD,MAAM,CAAC,gBAAgB,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YACtD,OAAO,GAAG,EAAE;gBACV,QAAQ,IAAI,QAAQ,EAAE,CAAC;gBACvB,OAAO,IAAI,OAAO,EAAE,CAAC;gBACrB,MAAM,CAAC,mBAAmB,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YAC3D,CAAC,CAAC;SACH;QAED,OAAO,GAAG,EAAE,GAAE,CAAC,CAAC;IAClB,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AACxB,CAAC"}

package/esm/index.d.ts

@@ -0,0 +1,3 @@
+export * from './contexts';
+export * from './hooks';
+export * from './hocs';

package/esm/index.js

@@ -0,0 +1,4 @@
+export * from './contexts';
+export * from './hooks';
+export * from './hocs';
+//# sourceMappingURL=index.js.map

package/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC"}

package/lib/contexts/PiletApiProvider.d.ts

@@ -0,0 +1,2 @@
+import * as React from 'react';
+export declare const PiletApiProvider: React.Context<any>;

package/lib/contexts/PiletApiProvider.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PiletApiProvider = void 0;
+const React = require("react");
+exports.PiletApiProvider = React.createContext(undefined);
+//# sourceMappingURL=PiletApiProvider.js.map

package/lib/contexts/PiletApiProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PiletApiProvider.js","sourceRoot":"","sources":["../../src/contexts/PiletApiProvider.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAElB,QAAA,gBAAgB,GAAG,KAAK,CAAC,aAAa,CAAM,SAAS,CAAC,CAAC"}

package/lib/contexts/index.d.ts

@@ -0,0 +1 @@
+export * from './PiletApiProvider';

package/lib/contexts/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./PiletApiProvider"), exports);
+//# sourceMappingURL=index.js.map

package/lib/contexts/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/contexts/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAAmC"}

package/lib/hocs/index.d.ts

@@ -0,0 +1 @@
+export * from './withProvider';

package/lib/hocs/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./withProvider"), exports);
+//# sourceMappingURL=index.js.map

package/lib/hocs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/hocs/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iDAA+B"}

package/lib/hocs/withProvider.d.ts

@@ -0,0 +1,15 @@
+import * as React from 'react';
+interface BaseComponentProps {
+    /**
+     * The currently used pilet API.
+     */
+    piral: any;
+}
+/**
+ * Wraps the component in a Pilet API provider allowing to make use of
+ * the `usePilet` hook.
+ * @param Component The component that should be wrapped in a provider.
+ * @returns The wrapped component.
+ */
+export declare function withPiletApi<T>(Component: React.FC<T>): React.FC<T & BaseComponentProps>;
+export {};

package/lib/hocs/withProvider.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withPiletApi = void 0;
+const React = require("react");
+const contexts_1 = require("../contexts");
+/**
+ * Wraps the component in a Pilet API provider allowing to make use of
+ * the `usePilet` hook.
+ * @param Component The component that should be wrapped in a provider.
+ * @returns The wrapped component.
+ */
+function withPiletApi(Component) {
+    return (props) => (React.createElement(contexts_1.PiletApiProvider.Provider, { value: props.piral },
+        React.createElement(Component, Object.assign({}, props))));
+}
+exports.withPiletApi = withPiletApi;
+//# sourceMappingURL=withProvider.js.map

package/lib/hocs/withProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"withProvider.js","sourceRoot":"","sources":["../../src/hocs/withProvider.tsx"],"names":[],"mappings":";;;AAAA,+BAA+B;AAC/B,0CAA+C;AAS/C;;;;;GAKG;AACH,SAAgB,YAAY,CAAI,SAAsB;IACpD,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAChB,oBAAC,2BAAgB,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,CAAC,KAAK;QAC3C,oBAAC,SAAS,oBAAK,KAAK,EAAI,CACE,CAC7B,CAAC;AACJ,CAAC;AAND,oCAMC"}

package/lib/hooks/afterVisible.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+/**
+ * A hook to indicate something was suddenly visible.
+ * @param time The time after which it should be triggered.
+ * @param cb The callback to use when the part was visible.
+ * @returns The reference to the element which should be watched.
+ */
+export declare function useAfterVisible(time: number, cb: () => void): import("react").MutableRefObject<HTMLDivElement>;

package/lib/hooks/afterVisible.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useAfterVisible = void 0;
+const react_1 = require("react");
+/**
+ * A hook to indicate something was suddenly visible.
+ * @param time The time after which it should be triggered.
+ * @param cb The callback to use when the part was visible.
+ * @returns The reference to the element which should be watched.
+ */
+function useAfterVisible(time, cb) {
+    const ref = (0, react_1.useRef)(null);
+    const [intersecting, setIntersecting] = (0, react_1.useState)(false);
+    (0, react_1.useEffect)(() => {
+        const observer = new IntersectionObserver((ev) => {
+            setIntersecting(ev.some((m) => m.isIntersecting));
+        });
+        observer.observe(ref.current);
+        return () => observer.disconnect();
+    }, [ref.current]);
+    (0, react_1.useEffect)(() => {
+        if (intersecting) {
+            const tid = setTimeout(cb, time);
+            return () => clearTimeout(tid);
+        }
+    }, [intersecting, cb]);
+    return ref;
+}
+exports.useAfterVisible = useAfterVisible;
+//# sourceMappingURL=afterVisible.js.map

package/lib/hooks/afterVisible.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"afterVisible.js","sourceRoot":"","sources":["../../src/hooks/afterVisible.ts"],"names":[],"mappings":";;;AAAA,iCAAoD;AAEpD;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,IAAY,EAAE,EAAc;IAC1D,MAAM,GAAG,GAAG,IAAA,cAAM,EAAiB,IAAI,CAAC,CAAC;IACzC,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,IAAA,gBAAQ,EAAC,KAAK,CAAC,CAAC;IAExD,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,MAAM,QAAQ,GAAG,IAAI,oBAAoB,CAAC,CAAC,EAAE,EAAE,EAAE;YAC/C,eAAe,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC9B,OAAO,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;IACrC,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;IAElB,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,IAAI,YAAY,EAAE;YAChB,MAAM,GAAG,GAAG,UAAU,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;YACjC,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;SAChC;IACH,CAAC,EAAE,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,CAAC;IAEvB,OAAO,GAAG,CAAC;AACb,CAAC;AApBD,0CAoBC"}

package/lib/hooks/asyncReplace.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Gives a full async lifecycle in a hook.
+ * @param action The lazy loader.
+ * @param resolve The resolve function getting the result from the promise.
+ * @returns The current executing state, and the trigger to start the async operation.
+ */
+export declare function useAsyncReplace<T = void>(action: () => Promise<T>, resolve?: (result: T) => void): [boolean, () => void, Error | undefined];

package/lib/hooks/asyncReplace.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useAsyncReplace = void 0;
+const react_1 = require("react");
+/**
+ * Gives a full async lifecycle in a hook.
+ * @param action The lazy loader.
+ * @param resolve The resolve function getting the result from the promise.
+ * @returns The current executing state, and the trigger to start the async operation.
+ */
+function useAsyncReplace(action, resolve = () => { }) {
+    const [executing, setExecuting] = (0, react_1.useState)(false);
+    const error = executing instanceof Error ? executing : undefined;
+    (0, react_1.useEffect)(() => {
+        if (executing === true) {
+            let active = true;
+            action().then((result) => active && resolve(result), (err) => active && setExecuting(err));
+            return () => (active = false);
+        }
+        return () => { };
+    }, [executing]);
+    return [executing === true, () => setExecuting(true), error];
+}
+exports.useAsyncReplace = useAsyncReplace;
+//# sourceMappingURL=asyncReplace.js.map