@ea-lab/reactive-json 0.0.19 → 0.0.21

package/README.md

@@ -127,7 +127,7 @@ Generic reusable code.
 
 Contains the core functionality of *reactive-json*.
 
-This is where `ReactiveJsonRoot.jsx` is.
+This is where `ReactiveJsonRoot.tsx` is.
 
 Usually, you won't need to edit its content. (But feel free to inspect it if you
 want to contribute!)

package/dist/esm/types/component/action/HashChangeListener.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Listens to hash changes (URL fragment) on the window object and executes a reaction function in response.
+ *
+ * @param {{}} props
+ * @returns {JSX.Element}
+ * @constructor
+ */
+declare const HashChangeListener: (props: any) => import("react/jsx-runtime").JSX.Element;
+export default HashChangeListener;

package/{lib/component/action/Hide.jsx → dist/esm/types/component/action/Hide.d.ts}

@@ -2,13 +2,9 @@
  * Action which will not render the children.
  *
  * This will also cancel any subsequent actions.
- * 
+ *
  * @returns {null}
  * @constructor
  */
-const Hide = () => {
-    // Simply don't render the children.
-    return null;
-};
-
+declare const Hide: () => null;
 export default Hide;

package/dist/esm/types/component/action/MessageListener.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Listens to messages on the window object and executes a reaction function in response.
+ *
+ * @param {{}} props
+ * @returns {JSX.Element}
+ * @constructor
+ */
+declare const MessageListener: (props: any) => import("react/jsx-runtime").JSX.Element;
+export default MessageListener;

package/dist/esm/types/component/action/Popover.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Action which will append a popover when the current component is hovered.
+ */
+declare const Popover: (props: any) => import("react/jsx-runtime").JSX.Element;
+export default Popover;

package/dist/esm/types/component/action/ReactOnEvent.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Functions that will be executed on specific events.
+ *
+ * @type {{}}
+ */
+export declare const reactionFunctions: {
+    addData: (props: any) => void;
+    fetchData: (props: any) => void;
+    moveData: (props: any) => void;
+    postMessage: (props: any) => void;
+    redirectNow: (props: any) => void;
+    removeData: (props: any) => void;
+    setClipboardData: (props: any) => Promise<void>;
+    setData: (props: any) => void;
+    submitData: (props: any) => void;
+    triggerEvent: (props: any) => void;
+};
+/**
+ * Action component which will append one or more event listeners on the element.
+ *
+ * @param {Object} props
+ *
+ * @constructor
+ */
+declare const ReactOnEvent: (props: any) => import("react/jsx-runtime").JSX.Element;
+export default ReactOnEvent;

package/dist/esm/types/component/action/Redirect.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Redirects when the conditions are valid.
+ *
+ * @param {{actionProps: {to}}} props Action props.
+ *
+ * @constructor
+ */
+declare const Redirect: (props: any) => void;
+export default Redirect;

package/dist/esm/types/component/action/Tooltip.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Action which will append a tooltip when the current component is hovered.
+ */
+declare const Tooltip: (props: any) => import("react/jsx-runtime").JSX.Element;
+export default Tooltip;

package/{lib/component/action/VisuallyHide.jsx → dist/esm/types/component/action/VisuallyHide.d.ts}

@@ -8,8 +8,5 @@
  * @returns {JSX.Element}
  * @constructor
  */
-const VisuallyHide = (props) => {
-    return <visually-hidden style={{"display": "none"}}>{props.children}</visually-hidden>;
-};
-
+declare const VisuallyHide: (props: any) => import("react/jsx-runtime").JSX.Element;
 export default VisuallyHide;

package/dist/esm/types/component/element/form/CheckBoxField.d.ts

@@ -0,0 +1,7 @@
+declare const CheckBoxField: ({ props, currentData, datafield, path }: {
+    props: any;
+    currentData: any;
+    datafield: any;
+    path: any;
+}) => import("react/jsx-runtime").JSX.Element;
+export default CheckBoxField;

package/dist/esm/types/component/element/form/DateField.d.ts

@@ -0,0 +1,2 @@
+declare const DateField: (componentProps: any) => import("react/jsx-runtime").JSX.Element;
+export default DateField;

package/dist/esm/types/component/element/form/NumberField.d.ts

@@ -0,0 +1,7 @@
+declare const NumberField: ({ props, currentData, datafield, path }: {
+    props: any;
+    currentData: any;
+    datafield: any;
+    path: any;
+}) => import("react/jsx-runtime").JSX.Element;
+export default NumberField;

package/dist/esm/types/component/element/form/SelectField.d.ts

@@ -0,0 +1,7 @@
+declare const SelectField: ({ props, data, path, datafield }: {
+    props: any;
+    data: any;
+    path: any;
+    datafield: any;
+}) => import("react/jsx-runtime").JSX.Element;
+export default SelectField;

package/dist/esm/types/component/element/form/TextAreaField.d.ts

@@ -0,0 +1,6 @@
+declare const TextAreaField: ({ props, datafield, path }: {
+    props: any;
+    datafield: any;
+    path: any;
+}) => import("react/jsx-runtime").JSX.Element;
+export default TextAreaField;

package/dist/esm/types/component/element/form/TextField.d.ts

@@ -0,0 +1,6 @@
+declare const TextField: ({ props, datafield, path }: {
+    props: any;
+    datafield: any;
+    path: any;
+}) => import("react/jsx-runtime").JSX.Element;
+export default TextField;

package/dist/esm/types/component/element/form/formElementsCommon.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Gets the path and the data for the specified dataLocation and contexts.
+ *
+ * @param {string} currentPath The current path of the component calling this function.
+ * @param {string} datafield The datafield (field name) of the component calling this function.
+ * @param {string|undefined} dataLocation The dataLocation value set in the component structure.
+ * @param {any} defaultValue The default value set in the component structure.
+ * @param {{}} globalDataContext The global data context of the component calling this function.
+ * @param {{}} templateContext The template context of the component calling this function.
+ *
+ * @returns {{formDataPath: undefined, formData: undefined}}
+ */
+export declare const propsDataLocationToPathAndValue: ({ currentPath, datafield, dataLocation, defaultValue, globalDataContext, templateContext }: {
+    currentPath: any;
+    datafield: any;
+    dataLocation: any;
+    defaultValue: any;
+    globalDataContext: any;
+    templateContext: any;
+}) => {
+    formData: undefined;
+    formDataPath: undefined;
+};

package/dist/esm/types/component/element/html/AccordionItem.d.ts

@@ -0,0 +1,16 @@
+/**
+ * To use with the BsAccordion component.
+ *
+ * To use this, use the BsAccordion component, and add
+ * AccordionItem in the content.
+ *
+ * You can of course use the Switch component to map to
+ * dynamic data.
+ */
+declare const AccordionItem: ({ props, path, currentData, datafield }: {
+    props: any;
+    path: any;
+    currentData: any;
+    datafield: any;
+}) => import("react/jsx-runtime").JSX.Element;
+export default AccordionItem;

package/dist/esm/types/component/element/html/FolderSortableTree.d.ts

@@ -0,0 +1,6 @@
+declare const FolderSortableTree: ({ props, path, datafield }: {
+    props: any;
+    path: any;
+    datafield: any;
+}) => import("react/jsx-runtime").JSX.Element | null;
+export default FolderSortableTree;

package/dist/esm/types/component/element/html/FormatNumeral.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Transforms a number into a numeral of a specific language: roman, upper latin, lower latin, ... and custom.
+ */
+declare const FormatNumeral: ({ props }: {
+    props: any;
+}) => import("react/jsx-runtime").JSX.Element;
+export default FormatNumeral;

package/dist/esm/types/component/element/html/Html.d.ts

@@ -0,0 +1,8 @@
+export declare const normalizeAttributesForReactJsx: (maybeAttributesObj: any) => {};
+declare const Html: ({ props, currentData, datafield, path }: {
+    props: any;
+    currentData: any;
+    datafield: any;
+    path: any;
+}) => import("react/jsx-runtime").JSX.Element;
+export default Html;

package/dist/esm/types/component/element/html/LabelFromValue.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Shows the label associated to a value.
+ *
+ * Uses an option-like structure as data source.
+ * Thus, it's compatible with SelectField, CheckBoxField...
+ *
+ * E.g.: [{"label": "Public name", "value": "option value"}].
+ *
+ * @param currentData
+ * @param datafield
+ * @param path
+ * @param props
+ * @returns {JSX.Element}
+ * @constructor
+ */
+declare const LabelFromValue: ({ currentData, datafield, path, props }: {
+    currentData: any;
+    datafield: any;
+    path: any;
+    props: any;
+}) => import("react/jsx-runtime").JSX.Element | null;
+export default LabelFromValue;

package/dist/esm/types/component/element/html/Modal.d.ts

@@ -0,0 +1,6 @@
+declare const Modal: ({ currentData, path, props }: {
+    currentData: any;
+    path: any;
+    props: any;
+}) => import("react/jsx-runtime").JSX.Element;
+export default Modal;

package/dist/esm/types/component/element/html/ModalForm.d.ts

@@ -0,0 +1,9 @@
+declare function ModalForm({ show, path, handleClose, handleSave, form, currentData }: {
+    show: any;
+    path: any;
+    handleClose: any;
+    handleSave: any;
+    form: any;
+    currentData: any;
+}): import("react/jsx-runtime").JSX.Element;
+export default ModalForm;

package/dist/esm/types/component/element/html/Paragraph.d.ts

@@ -0,0 +1,5 @@
+declare const Paragraph: ({ props, currentData }: {
+    props: any;
+    currentData: any;
+}) => import("react/jsx-runtime").JSX.Element;
+export default Paragraph;

package/dist/esm/types/component/element/html/PreformattedMarkup.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Preformatted markup component that takes content and inserts it as HTML.
+ */
+declare const PreformattedMarkup: ({ props }: {
+    props: any;
+}) => import("react/jsx-runtime").JSX.Element;
+export default PreformattedMarkup;

package/dist/esm/types/component/element/html/SortableTreeItemCollapseButton.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This is the collapse button for the sortable tree.
+ *
+ * It's used when SortableTree is used with a manualDrag option.
+ */
+declare const SortableTreeItemCollapseButton: ({ props }: {
+    props: any;
+}) => import("react/jsx-runtime").JSX.Element;
+export default SortableTreeItemCollapseButton;

package/dist/esm/types/component/element/html/Tabs.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Tabs component using the simple Tabs component from react-bootstrap.
+ *
+ * The react-bootstrap's Tabs component is special as it requires a very
+ * specific structure with <Tabs> directly underneath.
+ *
+ * @param currentData
+ * @param path
+ * @param props
+ * @returns {JSX.Element}
+ * @constructor
+ */
+declare const Tabs: ({ currentData, path, props }: {
+    currentData: any;
+    path: any;
+    props: any;
+}) => import("react/jsx-runtime").JSX.Element;
+export default Tabs;

package/dist/esm/types/component/element/special/BootstrapElement.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Wraps a React Bootstrap component.
+ */
+declare function BootstrapElement({ props, currentData, path, bsComponent }: {
+    props: any;
+    currentData: any;
+    path: any;
+    bsComponent: any;
+}): import("react/jsx-runtime").JSX.Element | null;
+export default BootstrapElement;

package/dist/esm/types/component/element/special/Count.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Returns a count for something to count.
+ *
+ * @param props Component build data.
+ *
+ * @returns {null|*}
+ *
+ * @constructor
+ */
+declare const Count: ({ props }: {
+    props: any;
+}) => any;
+export default Count;

package/dist/esm/types/component/element/special/DataFilter.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Use DataFilter to filter data from the global or template data.
+ *
+ * @param args Component build data.
+ *
+ * @returns {JSX.Element}
+ *
+ * @constructor
+ */
+declare const DataFilter: (args: any) => import("react/jsx-runtime").JSX.Element;
+export default DataFilter;

package/dist/esm/types/component/element/special/DelayedActions.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Provides a way to execute actions after a delay, at intervals, etc.
+ *
+ * @param {{}} props Build data.
+ * @param currentData Current data.
+ * @param path Element path.
+ *
+ * @constructor
+ */
+declare const DelayedActions: ({ props, currentData, path }: {
+    props: any;
+    currentData: any;
+    path: any;
+}) => import("react/jsx-runtime").JSX.Element;
+/**
+ * Gets the reaction functions to execute.
+ *
+ * This is a specific adaptation of getActionsToExecute from the Actions core functionality.
+ *
+ * @param {Array} actions
+ * @param {object} templateContexts
+ * @returns {*[]} The list of reaction function properties. The structure is simpler than getActionsToExecute.
+ */
+export declare const getReactionFunctionsToExecute: (actions: any, templateContexts: any) => never[];
+export default DelayedActions;

package/dist/esm/types/component/element/special/PageControls.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Displays the PageControls found in the PaginationContext, if any.
+ *
+ * @returns {JSX.Element|null}
+ *
+ * @constructor
+ */
+declare const PageControls: () => import("react/jsx-runtime").JSX.Element | null;
+export default PageControls;

package/dist/esm/types/component/element/special/Phantom.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Phantom element without DOM output.
+ *
+ * Use this if you want actions without a DOM element.
+ *
+ * @param {{}} props Build data.
+ * @param currentData Current data.
+ * @param path Element path.
+ *
+ * @constructor
+ */
+declare const Phantom: ({ props, currentData, path }: {
+    props: any;
+    currentData: any;
+    path: any;
+}) => import("react/jsx-runtime").JSX.Element;
+export default Phantom;

package/dist/esm/types/component/element/special/Switch.d.ts

@@ -0,0 +1,6 @@
+declare const Switch: ({ props, currentData, path }: {
+    props: any;
+    currentData: any;
+    path: any;
+}) => import("react/jsx-runtime").JSX.Element;
+export default Switch;

package/dist/esm/types/component/hook/usePagination.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Use this hook to create paginations.
+ *
+ * @param [Array] dataToPaginate The complete data to paginate.
+ * @param [int] forcePaginationDisplay Set to true to force the pagination even when having less than 2 pages.
+ * @param [int] maxPageButtonsCount The maximum page buttons count. Must be at least 1. Defaults to 5 when undefined.
+ * @param [int] pageMaxItemCount The maximum item count per page. Defaults to 10 when undefined.
+ *
+ * @returns {{
+ *     firstShownItemIndex: number,
+ *     getPageCountForContent: (function(Array): number),
+ *     maxShownItemIndexExcluded: number,
+ *     PageControls: (function({pageCount: *})),
+ *     pageMaxItemCount: number,
+ *     sliceVisibleContent: ((function(Array): *)|*),
+ * }}
+ */
+export declare const usePagination: ({ dataToPaginate, forcePaginationDisplay, maxPageButtonsCount, pageMaxItemCount, }: {
+    dataToPaginate?: never[] | undefined;
+    forcePaginationDisplay?: boolean | undefined;
+    maxPageButtonsCount?: number | undefined;
+    pageMaxItemCount?: number | undefined;
+}) => {
+    firstShownItemIndex: number;
+    getPageCountForContent: (contentSource: any) => number;
+    maxShownItemIndexExcluded: number;
+    PageControls: () => import("react/jsx-runtime").JSX.Element | null;
+    pageMaxItemCount: number;
+    sliceVisibleContent: (contentToSlice: any) => any;
+};

package/dist/esm/types/component/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./action";
+export * from "./element";
+export * from "./hook";
+export * from "./reaction";
+export * from "./utility";

package/dist/esm/types/component/reaction/addData.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Adds data at the specified path.
+ *
+ * @param {{}} props
+ */
+export declare const addData: (props: any) => void;

package/dist/esm/types/component/reaction/fetchData.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Fetches data. Similar to submitData, but for GET requests.
+ *
+ * Will reload the app content if refreshAppOnResponse is true.
+ *
+ * @param {{args: {refreshAppOnResponse, url}, event, globalDataContext, templateContext}} props Reaction function props.
+ */
+export declare const fetchData: (props: any) => void;

package/dist/esm/types/component/reaction/moveData.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Moves data at the specified path.
+ *
+ * @param {{}} props
+ */
+export declare const moveData: (props: any) => void;

package/dist/esm/types/component/reaction/postMessage.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Posts a message to the specified target.
+ *
+ * @param {{args: {includeChangedValue, message, messageTarget, on, targetOrigin}, event, globalDataContext, templateContext}} props
+ */
+export declare const postMessage: (props: any) => void;

package/dist/esm/types/component/reaction/redirectNow.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Redirects to the specified URL.
+ *
+ * @param {{}} props
+ */
+export declare const redirectNow: (props: any) => void;

package/dist/esm/types/component/reaction/removeData.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Removes data at the specified path.
+ *
+ * @param {{}} props
+ */
+export declare const removeData: (props: any) => void;

package/dist/esm/types/component/reaction/setClipboardData.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copies data to the clipboard.
+ *
+ * @param {{}} props
+ */
+export declare const setClipboardData: (props: any) => Promise<void>;

package/dist/esm/types/component/reaction/setData.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Sets data at the specified path.
+ *
+ * @param {{}} props
+ */
+export declare const setData: (props: any) => void;

package/dist/esm/types/component/reaction/submitData.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Submits the current state of this app data.
+ *
+ * Will reload the app content if refreshAppOnResponse is true.
+ *
+ * @param {{args: {data, httpMethod, refreshAppOnResponse, submitSilently, url}, event, globalDataContext, templateContext}} props Reaction function props.
+ */
+export declare const submitData: (props: any) => void;

package/dist/esm/types/component/reaction/triggerEvent.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Reaction function which will trigger an event on an element identified by the given selector.
+ *
+ * @param {{args:{selector, selectorBase, eventName}, event}} props Reaction function props.
+ */
+export declare const triggerEvent: (props: any) => void;

package/dist/esm/types/component/utility/formatString.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Formats the given string with replacement arguments.
+ *
+ * @param {{globalDataContext: {}, templateContext: {}}} templateContexts Template contexts.
+ * @param {string} toFormat The string to format.
+ * @param {...string} argv The replacement arguments.
+ */
+export declare const formatString: ({ templateContexts }: {
+    templateContexts: any;
+}, toFormat: any, ...argv: any[]) => any;
+/**
+ * Formats the given data with replacement arguments if possible.
+ *
+ * @param {{templateContexts: {globalDataContext: {}, templateContext: {}}}} options Template contexts.
+ * @param {*} toFormat The data to format.
+ */
+export declare const maybeFormatString: (options: any, toFormat: any) => any;

package/dist/esm/types/engine/Actions.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Checks whether the conditions are fulfilled.
+ * @param {{andConditions, containedBy, containedByNot, contains, containsNot, is, isNot, orConditions, when, whenDataCountOf, ">", "<", ">=", "<=", compareAsDates}} condition
+ * @param {object} templateContexts
+ * @param {Map} additionalConditionHandlers
+ * @returns {*}
+ */
+export declare const isValid: (condition: any, templateContexts: any, additionalConditionHandlers: any) => any;
+/**
+ * Component that executes actions before rendering its children.
+ *
+ * Actions include a system to hide.
+ *
+ * @param props The props that served to build an action dependant component.
+ * @returns {*}
+ * @constructor
+ */
+declare const ActionDependant: (props: any) => any;
+export default ActionDependant;

package/dist/esm/types/engine/ComponentCollector.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Merges component collections (aka plugins).
+ * @param {[{}]} collections Array of plugin collections.
+ * @return {{hook: {}, reaction: {}, action: {}, utility: {}, element: {}}}
+ */
+export declare function mergeComponentCollections(collections: any): {
+    action: {};
+    element: {};
+    hook: {};
+    reaction: {};
+    utility: {};
+};

package/{lib/engine/EventDispatcherContext.jsx → dist/esm/types/engine/EventDispatcherContext.d.ts}

@@ -1,5 +1,3 @@
-import {createContext} from "react";
-
 /**
  * A context for "globalizing" event dispatchers.
  *
@@ -8,9 +6,8 @@ import {createContext} from "react";
  *
  * @type {React.Context<{removeEventListener: removeEventListener, addEventListener: addEventListener}>}
  */
-const EventDispatcherContext = createContext({
-    addEventListener: null,
-    removeEventListener: null,
-});
-
+declare const EventDispatcherContext: import("react").Context<{
+    addEventListener: null;
+    removeEventListener: null;
+}>;
 export default EventDispatcherContext;

package/dist/esm/types/engine/EventDispatcherProvider.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Adds the listener to registered listeners.
+ *
+ * @param {string} type The event type.
+ * @param {Function} listener The event listener.
+ */
+export declare const addEventListener: (type: any, listener: any) => void;
+/**
+ * Removes the specified listener.
+ *
+ * @param {string} type Event type.
+ * @param {Function} listener Event listener.
+ */
+export declare const removeEventListener: (type: any, listener: any) => void;
+declare const _default: import("react").MemoExoticComponent<(props: any) => import("react/jsx-runtime").JSX.Element>;
+export default _default;

package/{lib/engine/GlobalDataContext.jsx → dist/esm/types/engine/GlobalDataContext.d.ts}

@@ -1,5 +1,3 @@
-import { createContext } from 'react';
-
 /**
  * This context contains all the build data for the current app.
  *
@@ -8,6 +6,5 @@ import { createContext } from 'react';
  *
  * @type {React.Context<{}>}
  */
-const GlobalDataContext = createContext({});
-
+declare const GlobalDataContext: import("react").Context<{}>;
 export default GlobalDataContext;