piral-core 0.14.3 → 0.14.5-beta.3331

package/src/actions/components.ts

@@ -1,46 +1,18 @@
-import { appendItem, excludeOn, withKey, withoutKey } from '../utils';
+import { withExtension, withoutExtension, withoutPage, withPage } from '../utils';
 import { PageRegistration, ExtensionRegistration, GlobalStateContext } from '../types';
 
 export function registerPage(ctx: GlobalStateContext, name: string, value: PageRegistration) {
-  ctx.dispatch((state) => ({
-    ...state,
-    registry: {
-      ...state.registry,
-      pages: withKey(state.registry.pages, name, value),
-    },
-  }));
+  ctx.dispatch(withPage(name, value));
 }
 
 export function unregisterPage(ctx: GlobalStateContext, name: string) {
-  ctx.dispatch((state) => ({
-    ...state,
-    registry: {
-      ...state.registry,
-      pages: withoutKey(state.registry.pages, name),
-    },
-  }));
+  ctx.dispatch(withoutPage(name));
 }
 
 export function registerExtension(ctx: GlobalStateContext, name: string, value: ExtensionRegistration) {
-  ctx.dispatch((state) => ({
-    ...state,
-    registry: {
-      ...state.registry,
-      extensions: withKey(state.registry.extensions, name, appendItem(state.registry.extensions[name], value)),
-    },
-  }));
+  ctx.dispatch(withExtension(name, value));
 }
 
 export function unregisterExtension(ctx: GlobalStateContext, name: string, reference: any) {
-  ctx.dispatch((state) => ({
-    ...state,
-    registry: {
-      ...state.registry,
-      extensions: withKey(
-        state.registry.extensions,
-        name,
-        excludeOn(state.registry.extensions[name], (m) => m.reference === reference),
-      ),
-    },
-  }));
+  ctx.dispatch(withoutExtension(name, reference));
 }

package/src/utils/extension.test.tsx

@@ -0,0 +1,12 @@
+import * as React from 'react';
+import { mount } from 'enzyme';
+import { toExtension } from './extension';
+
+describe('Util Extension.', () => {
+  it('Convert some component to an extension component.', () => {
+    const Component = (props) => <b>{props.title}</b>;
+    const Extension = toExtension(Component);
+    const node = mount(<Extension piral={undefined} params={{ title: 'Foo' }} />);
+    expect(node.find('b').length).toBe(1);
+  });
+});

package/src/utils/extension.tsx

@@ -0,0 +1,6 @@
+import * as React from 'react';
+import { ExtensionComponentProps, WrappedComponent } from '../types';
+
+export function toExtension<T>(Component: React.ComponentType<T>): WrappedComponent<ExtensionComponentProps<T>> {
+  return (props) => <Component {...props.params} />;
+}

package/src/utils/index.ts

@@ -1,8 +1,10 @@
 export * from './compare';
 export * from './data';
+export * from './extension';
 export * from './foreign';
 export * from './guid';
 export * from './helpers';
 export * from './media';
 export * from './react';
+export * from './state';
 export * from './storage';

package/src/utils/state.ts

@@ -0,0 +1,128 @@
+import { cloneElement, ComponentType, createElement } from 'react';
+import { RouteComponentProps } from 'react-router';
+import { toExtension } from './extension';
+import { withKey, withoutKey, appendItem, excludeOn } from './helpers';
+import { GlobalState, PageRegistration, ExtensionRegistration } from '../types';
+
+/**
+ * Returns a dispatcher that includes all mentioned dispatchers.
+ * @param dispatchers The dispatchers to include.
+ */
+export function withAll(...dispatchers: Array<(state: GlobalState) => GlobalState>) {
+  return (state: GlobalState): GlobalState => {
+    for (const dispatcher of dispatchers) {
+      state = dispatcher(state);
+    }
+
+    return state;
+  };
+}
+
+/**
+ * Returns a dispatcher that adds a page registration.
+ * @param name The path of the page to register.
+ * @param value The value of the page to register.
+ * @returns The dispatcher.
+ */
+export function withPage(name: string, value: PageRegistration) {
+  return (state: GlobalState): GlobalState => ({
+    ...state,
+    registry: {
+      ...state.registry,
+      pages: withKey(state.registry.pages, name, value),
+    },
+  });
+}
+
+/**
+ * Returns a dispatcher that removes a page registration.
+ * @param name The path of the page to unregister.
+ * @returns The dispatcher.
+ */
+export function withoutPage(name: string) {
+  return (state: GlobalState): GlobalState => ({
+    ...state,
+    registry: {
+      ...state.registry,
+      pages: withoutKey(state.registry.pages, name),
+    },
+  });
+}
+
+/**
+ * Returns a dispatcher that adds an extension registration.
+ * @param name The name of the extension to register.
+ * @param value The value of the extension to register.
+ * @returns The dispatcher.
+ */
+export function withExtension(name: string, value: ExtensionRegistration) {
+  return (state: GlobalState): GlobalState => ({
+    ...state,
+    registry: {
+      ...state.registry,
+      extensions: withKey(state.registry.extensions, name, appendItem(state.registry.extensions[name], value)),
+    },
+  });
+}
+
+/**
+ * Returns a dispatcher that removes an extension registration.
+ * @param name The name of the extension to unregister.
+ * @param reference The reference for the extension.
+ * @returns The dispatcher.
+ */
+export function withoutExtension(name: string, reference: any) {
+  return (state: GlobalState): GlobalState => ({
+    ...state,
+    registry: {
+      ...state.registry,
+      extensions: withKey(
+        state.registry.extensions,
+        name,
+        excludeOn(state.registry.extensions[name], (m) => m.reference === reference),
+      ),
+    },
+  });
+}
+
+/**
+ * Returns a dispatcher that adds an extension registration from the root (no Pilet API).
+ * @param name The name of the extension to register.
+ * @param component The extension's component to use.
+ * @returns The dispatcher.
+ */
+export function withRootExtension<T>(name: string, component: ComponentType<T>) {
+  return withExtension(name, {
+    component: toExtension(component),
+    defaults: {},
+    pilet: '',
+    reference: component,
+  });
+}
+
+/**
+ * Returns a dispatcher that adds another provider.
+ * @param provider The provider to include.
+ * @returns The dispatcher.
+ */
+export function withProvider(provider: JSX.Element) {
+  const wrapper: React.FC = (props) => cloneElement(provider, props);
+
+  return (state: GlobalState): GlobalState => ({
+    ...state,
+    provider: !state.provider ? wrapper : (props) => createElement(state.provider, undefined, wrapper(props)),
+  });
+}
+
+/**
+ * Returns a dispatcher that registers another route.
+ * @param path The path of the route to register.
+ * @param component The component representing the route.
+ * @returns The dispatcher.
+ */
+export function withRoute<T>(path: string, component: ComponentType<RouteComponentProps<T>>) {
+  return (state: GlobalState): GlobalState => ({
+    ...state,
+    routes: withKey(state.routes, path, component),
+  });
+}

package/esm/hooks/debounce.d.ts

@@ -1,8 +0,0 @@
-/**
- * Hook that returns the debounced (i.e., delayed) value.
- * Useful when user input should not fire immediately, but rather
- * only after a certain timespan without any changes passed.
- * @param value The value to consider.
- * @param delay The timespan to pass before applying the value.
- */
-export declare function useDebounce<T>(value: T, delay?: number): T;

package/esm/hooks/debounce.js

@@ -1,18 +0,0 @@
-import { useState, useEffect } from 'react';
-/**
- * Hook that returns the debounced (i.e., delayed) value.
- * Useful when user input should not fire immediately, but rather
- * only after a certain timespan without any changes passed.
- * @param value The value to consider.
- * @param delay The timespan to pass before applying the value.
- */
-export function useDebounce(value, delay) {
-    if (delay === void 0) { delay = 300; }
-    var _a = useState(value), debouncedValue = _a[0], setDebouncedValue = _a[1];
-    useEffect(function () {
-        var handler = setTimeout(function () { return setDebouncedValue(value); }, delay);
-        return function () { return clearTimeout(handler); };
-    }, [value, delay]);
-    return debouncedValue;
-}
-//# sourceMappingURL=debounce.js.map

package/esm/hooks/debounce.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"debounce.js","sourceRoot":"","sources":["../../src/hooks/debounce.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAE5C;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAI,KAAQ,EAAE,KAAW;IAAX,sBAAA,EAAA,WAAW;IAC5C,IAAA,KAAsC,QAAQ,CAAC,KAAK,CAAC,EAApD,cAAc,QAAA,EAAE,iBAAiB,QAAmB,CAAC;IAE5D,SAAS,CAAC;QACR,IAAM,OAAO,GAAG,UAAU,CAAC,cAAM,OAAA,iBAAiB,CAAC,KAAK,CAAC,EAAxB,CAAwB,EAAE,KAAK,CAAC,CAAC;QAClE,OAAO,cAAM,OAAA,YAAY,CAAC,OAAO,CAAC,EAArB,CAAqB,CAAC;IACrC,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;IAEnB,OAAO,cAAc,CAAC;AACxB,CAAC"}

package/esm/hooks/lockBodyScroll.d.ts

@@ -1,6 +0,0 @@
-/**
- * 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

@@ -1,15 +0,0 @@
-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(function () {
-        document.body.style.overflow = 'hidden';
-        return function () {
-            document.body.style.overflow = 'visible';
-        };
-    }, []);
-}
-//# sourceMappingURL=lockBodyScroll.js.map

package/esm/hooks/lockBodyScroll.js.map

@@ -1 +0,0 @@
-{"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;QACd,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACxC,OAAO;YACL,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

@@ -1,11 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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(function () {
-        var listener = function (event) {
-            if (ref.current && !ref.current.contains(event.target)) {
-                handler(event);
-            }
-        };
-        document.addEventListener('mousedown', listener);
-        document.addEventListener('touchstart', listener);
-        return function () {
-            document.removeEventListener('mousedown', listener);
-            document.removeEventListener('touchstart', listener);
-        };
-    }, [handler]);
-}
-//# sourceMappingURL=onClickOutside.js.map

package/esm/hooks/onClickOutside.js.map

@@ -1 +0,0 @@
-{"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;QACR,IAAM,QAAQ,GAAG,UAAC,KAAiB;YACjC,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;YACL,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

@@ -1,11 +0,0 @@
-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

@@ -1,28 +0,0 @@
-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) {
-    if (rootMargin === void 0) { rootMargin = '0px'; }
-    var _a = useState(false), isIntersecting = _a[0], setIntersecting = _a[1];
-    useEffect(function () {
-        var observer = new IntersectionObserver(function (_a) {
-            var entry = _a[0];
-            return setIntersecting(entry.isIntersecting);
-        }, {
-            rootMargin: rootMargin,
-        });
-        if (ref.current) {
-            observer.observe(ref.current);
-        }
-        return function () { return observer.unobserve(ref.current); };
-    }, []);
-    return isIntersecting;
-}
-//# sourceMappingURL=onScreenVisible.js.map

package/esm/hooks/onScreenVisible.js.map

@@ -1 +0,0 @@
-{"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,UAAkB;IAAlB,2BAAA,EAAA,kBAAkB;IACvF,IAAA,KAAoC,QAAQ,CAAC,KAAK,CAAC,EAAlD,cAAc,QAAA,EAAE,eAAe,QAAmB,CAAC;IAE1D,SAAS,CAAC;QACR,IAAM,QAAQ,GAAG,IAAI,oBAAoB,CAAC,UAAC,EAAO;gBAAN,KAAK,QAAA;YAAM,OAAA,eAAe,CAAC,KAAK,CAAC,cAAc,CAAC;QAArC,CAAqC,EAAE;YAC5F,UAAU,YAAA;SACX,CAAC,CAAC;QAEH,IAAI,GAAG,CAAC,OAAO,EAAE;YACf,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;SAC/B;QAED,OAAO,cAAM,OAAA,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAA/B,CAA+B,CAAC;IAC/C,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,cAAc,CAAC;AACxB,CAAC"}

package/esm/hooks/promise.d.ts

@@ -1,13 +0,0 @@
-/**
- * The currently captured Promise state.
- */
-export interface UsePromiseResult<T> {
-  loading: boolean;
-  data: T;
-  error: any;
-}
-/**
- * Hook for introducing a complete local loading state for a promise.
- * @param promise The callback for the promise to wait for.
- */
-export declare function usePromise<T>(promise: () => Promise<T>): UsePromiseResult<T>;

package/esm/hooks/promise.js

@@ -1,21 +0,0 @@
-import { useState, useEffect } from 'react';
-/**
- * Hook for introducing a complete local loading state for a promise.
- * @param promise The callback for the promise to wait for.
- */
-export function usePromise(promise) {
-    var _a = useState({
-        loading: true,
-        data: undefined,
-        error: undefined,
-    }), result = _a[0], setResult = _a[1];
-    useEffect(function () {
-        var cancelled = false;
-        promise().then(function (data) { return !cancelled && setResult({ data: data, error: undefined, loading: false }); }, function (error) { return !cancelled && setResult({ data: undefined, error: error, loading: false }); });
-        return function () {
-            cancelled = true;
-        };
-    }, []);
-    return result;
-}
-//# sourceMappingURL=promise.js.map

package/esm/hooks/promise.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"promise.js","sourceRoot":"","sources":["../../src/hooks/promise.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAW5C;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAI,OAAyB;IAC/C,IAAA,KAAsB,QAAQ,CAAsB;QACxD,OAAO,EAAE,IAAI;QACb,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,SAAS;KACjB,CAAC,EAJK,MAAM,QAAA,EAAE,SAAS,QAItB,CAAC;IACH,SAAS,CAAC;QACR,IAAI,SAAS,GAAG,KAAK,CAAC;QAEtB,OAAO,EAAE,CAAC,IAAI,CACZ,UAAC,IAAI,IAAK,OAAA,CAAC,SAAS,IAAI,SAAS,CAAC,EAAE,IAAI,MAAA,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,EAAnE,CAAmE,EAC7E,UAAC,KAAK,IAAK,OAAA,CAAC,SAAS,IAAI,SAAS,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,OAAA,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,EAAnE,CAAmE,CAC/E,CAAC;QAEF,OAAO;YACL,SAAS,GAAG,IAAI,CAAC;QACnB,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IACP,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/esm/utils/events.d.ts

@@ -1,3 +0,0 @@
-import { EventEmitter } from '../types';
-export declare type EventListeners = Array<[any, any]>;
-export declare function createListener(state: any): EventEmitter;

package/esm/utils/events.js

@@ -1,35 +0,0 @@
-function nameOf(type) {
-    return "piral-" + type;
-}
-export function createListener(state) {
-    var eventListeners = [];
-    return {
-        on: function (type, callback) {
-            var listener = function (_a) {
-                var detail = _a.detail;
-                return detail && detail.state === state && callback(detail.arg);
-            };
-            document.body.addEventListener(nameOf(type), listener);
-            eventListeners.push([callback, listener]);
-            return this;
-        },
-        off: function (type, callback) {
-            var listener = eventListeners.filter(function (m) { return m[0] === callback; })[0];
-            if (listener) {
-                document.body.removeEventListener(nameOf(type), listener[1]);
-                eventListeners.splice(eventListeners.indexOf(listener), 1);
-            }
-            return this;
-        },
-        emit: function (type, arg) {
-            var ce = document.createEvent('CustomEvent');
-            ce.initCustomEvent(nameOf(type), false, false, {
-                arg: arg,
-                state: state,
-            });
-            document.body.dispatchEvent(ce);
-            return this;
-        },
-    };
-}
-//# sourceMappingURL=events.js.map

package/esm/utils/events.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/utils/events.ts"],"names":[],"mappings":"AAIA,SAAS,MAAM,CAAC,IAAqB;IACnC,OAAO,WAAS,IAAM,CAAC;AACzB,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAU;IACvC,IAAM,cAAc,GAAmB,EAAE,CAAC;IAE1C,OAAO;QACL,EAAE,EAAF,UAAG,IAAI,EAAE,QAAQ;YACf,IAAM,QAAQ,GAAG,UAAC,EAAuB;oBAArB,MAAM,YAAA;gBAAoB,OAAA,MAAM,IAAI,MAAM,CAAC,KAAK,KAAK,KAAK,IAAI,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC;YAAxD,CAAwD,CAAC;YACvG,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC;YACvD,cAAc,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC1C,OAAO,IAAI,CAAC;QACd,CAAC;QACD,GAAG,YAAC,IAAI,EAAE,QAAQ;YACT,IAAA,QAAQ,GAAI,cAAc,CAAC,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAjB,CAAiB,CAAC,GAAnD,CAAoD;YAEnE,IAAI,QAAQ,EAAE;gBACZ,QAAQ,CAAC,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC7D,cAAc,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;aAC5D;YAED,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,YAAC,IAAI,EAAE,GAAG;YACZ,IAAM,EAAE,GAAG,QAAQ,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;YAC/C,EAAE,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE;gBAC7C,GAAG,KAAA;gBACH,KAAK,OAAA;aACN,CAAC,CAAC;YACH,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;YAChC,OAAO,IAAI,CAAC;QACd,CAAC;KACF,CAAC;AACJ,CAAC"}

package/lib/hooks/debounce.d.ts

@@ -1,8 +0,0 @@
-/**
- * Hook that returns the debounced (i.e., delayed) value.
- * Useful when user input should not fire immediately, but rather
- * only after a certain timespan without any changes passed.
- * @param value The value to consider.
- * @param delay The timespan to pass before applying the value.
- */
-export declare function useDebounce<T>(value: T, delay?: number): T;

package/lib/hooks/debounce.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useDebounce = void 0;
-var react_1 = require("react");
-/**
- * Hook that returns the debounced (i.e., delayed) value.
- * Useful when user input should not fire immediately, but rather
- * only after a certain timespan without any changes passed.
- * @param value The value to consider.
- * @param delay The timespan to pass before applying the value.
- */
-function useDebounce(value, delay) {
-    if (delay === void 0) { delay = 300; }
-    var _a = react_1.useState(value), debouncedValue = _a[0], setDebouncedValue = _a[1];
-    react_1.useEffect(function () {
-        var handler = setTimeout(function () { return setDebouncedValue(value); }, delay);
-        return function () { return clearTimeout(handler); };
-    }, [value, delay]);
-    return debouncedValue;
-}
-exports.useDebounce = useDebounce;
-//# sourceMappingURL=debounce.js.map

package/lib/hooks/debounce.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"debounce.js","sourceRoot":"","sources":["../../src/hooks/debounce.ts"],"names":[],"mappings":";;;AAAA,+BAA4C;AAE5C;;;;;;GAMG;AACH,SAAgB,WAAW,CAAI,KAAQ,EAAE,KAAW;IAAX,sBAAA,EAAA,WAAW;IAC5C,IAAA,KAAsC,gBAAQ,CAAC,KAAK,CAAC,EAApD,cAAc,QAAA,EAAE,iBAAiB,QAAmB,CAAC;IAE5D,iBAAS,CAAC;QACR,IAAM,OAAO,GAAG,UAAU,CAAC,cAAM,OAAA,iBAAiB,CAAC,KAAK,CAAC,EAAxB,CAAwB,EAAE,KAAK,CAAC,CAAC;QAClE,OAAO,cAAM,OAAA,YAAY,CAAC,OAAO,CAAC,EAArB,CAAqB,CAAC;IACrC,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;IAEnB,OAAO,cAAc,CAAC;AACxB,CAAC;AATD,kCASC"}

package/lib/hooks/lockBodyScroll.d.ts

@@ -1,6 +0,0 @@
-/**
- * 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/lib/hooks/lockBodyScroll.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useLockBodyScroll = void 0;
-var react_1 = require("react");
-/**
- * Hook that locks scrolling on the main document.
- * Useful for preventing the standard scrolling in context of
- * a modal dialog.
- */
-function useLockBodyScroll() {
-    react_1.useLayoutEffect(function () {
-        document.body.style.overflow = 'hidden';
-        return function () {
-            document.body.style.overflow = 'visible';
-        };
-    }, []);
-}
-exports.useLockBodyScroll = useLockBodyScroll;
-//# sourceMappingURL=lockBodyScroll.js.map

package/lib/hooks/lockBodyScroll.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"lockBodyScroll.js","sourceRoot":"","sources":["../../src/hooks/lockBodyScroll.ts"],"names":[],"mappings":";;;AAAA,+BAAwC;AAExC;;;;GAIG;AACH,SAAgB,iBAAiB;IAC/B,uBAAe,CAAC;QACd,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACxC,OAAO;YACL,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC3C,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC;AAPD,8CAOC"}

package/lib/hooks/onClickOutside.d.ts

@@ -1,8 +0,0 @@
-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/lib/hooks/onClickOutside.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useOnClickOutside = void 0;
-var react_1 = require("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.
- */
-function useOnClickOutside(ref, handler) {
-    react_1.useEffect(function () {
-        var listener = function (event) {
-            if (ref.current && !ref.current.contains(event.target)) {
-                handler(event);
-            }
-        };
-        document.addEventListener('mousedown', listener);
-        document.addEventListener('touchstart', listener);
-        return function () {
-            document.removeEventListener('mousedown', listener);
-            document.removeEventListener('touchstart', listener);
-        };
-    }, [handler]);
-}
-exports.useOnClickOutside = useOnClickOutside;
-//# sourceMappingURL=onClickOutside.js.map

package/lib/hooks/onClickOutside.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"onClickOutside.js","sourceRoot":"","sources":["../../src/hooks/onClickOutside.ts"],"names":[],"mappings":";;;AAAA,+BAA6C;AAE7C;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAwB,GAAiB,EAAE,OAAoC;IAC9G,iBAAS,CAAC;QACR,IAAM,QAAQ,GAAG,UAAC,KAAiB;YACjC,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;YACL,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;AAhBD,8CAgBC"}

package/lib/hooks/onScreenVisible.d.ts

@@ -1,11 +0,0 @@
-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/lib/hooks/onScreenVisible.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useOnScreenVisible = void 0;
-var react_1 = require("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.
- */
-function useOnScreenVisible(ref, rootMargin) {
-    if (rootMargin === void 0) { rootMargin = '0px'; }
-    var _a = react_1.useState(false), isIntersecting = _a[0], setIntersecting = _a[1];
-    react_1.useEffect(function () {
-        var observer = new IntersectionObserver(function (_a) {
-            var entry = _a[0];
-            return setIntersecting(entry.isIntersecting);
-        }, {
-            rootMargin: rootMargin,
-        });
-        if (ref.current) {
-            observer.observe(ref.current);
-        }
-        return function () { return observer.unobserve(ref.current); };
-    }, []);
-    return isIntersecting;
-}
-exports.useOnScreenVisible = useOnScreenVisible;
-//# sourceMappingURL=onScreenVisible.js.map

package/lib/hooks/onScreenVisible.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"onScreenVisible.js","sourceRoot":"","sources":["../../src/hooks/onScreenVisible.ts"],"names":[],"mappings":";;;AAAA,+BAAuD;AAEvD;;;;;;;;GAQG;AACH,SAAgB,kBAAkB,CAAwB,GAAiB,EAAE,UAAkB;IAAlB,2BAAA,EAAA,kBAAkB;IACvF,IAAA,KAAoC,gBAAQ,CAAC,KAAK,CAAC,EAAlD,cAAc,QAAA,EAAE,eAAe,QAAmB,CAAC;IAE1D,iBAAS,CAAC;QACR,IAAM,QAAQ,GAAG,IAAI,oBAAoB,CAAC,UAAC,EAAO;gBAAN,KAAK,QAAA;YAAM,OAAA,eAAe,CAAC,KAAK,CAAC,cAAc,CAAC;QAArC,CAAqC,EAAE;YAC5F,UAAU,YAAA;SACX,CAAC,CAAC;QAEH,IAAI,GAAG,CAAC,OAAO,EAAE;YACf,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;SAC/B;QAED,OAAO,cAAM,OAAA,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAA/B,CAA+B,CAAC;IAC/C,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,cAAc,CAAC;AACxB,CAAC;AAhBD,gDAgBC"}

package/lib/hooks/promise.d.ts

@@ -1,13 +0,0 @@
-/**
- * The currently captured Promise state.
- */
-export interface UsePromiseResult<T> {
-    loading: boolean;
-    data: T;
-    error: any;
-}
-/**
- * Hook for introducing a complete local loading state for a promise.
- * @param promise The callback for the promise to wait for.
- */
-export declare function usePromise<T>(promise: () => Promise<T>): UsePromiseResult<T>;