@cxbox-ui/core 1.34.1

package/utils/highlightJson.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Format json and highlight it as well.
+ * May not be suitable for handling huge (such as 10MB) JSON.
+ *
+ * It's temp solution
+ *
+ * @param json JSON to highlight
+ * @param colorOptions optional color options
+ * @category Utils
+ */
+declare function highlightJson(json: any, colorOptions?: {}): any;
+export default highlightJson;

package/utils/history.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Utilities for urls and browser history
+ */
+import { Location } from 'history';
+import { Route } from '../interfaces/router';
+/**
+ * Appends '/' in front of `absoluteUrl` argument.
+ * If `absoluteUrl` alredy starts with `/` then argument returned without changes.
+ *
+ * @param absoluteUrl Url
+ */
+export declare function makeRelativeUrl(absoluteUrl: string): string;
+/**
+ * Parses a business component hierarchy url into a dictionary of business components
+ * and their cursors.
+ *
+ * @param bcPath Business component hierarchy url, e.g. `bcName1/cursor1/bcName2/cursor2`
+ * @category Utils
+ */
+export declare function parseBcCursors(bcPath: string): Record<string, string>;
+/**
+ * TODO
+ *
+ * @param literals
+ * @param placeholders
+ * @category Utils
+ */
+export declare function buildUrl(literals: TemplateStringsArray, ...placeholders: Array<string | number>): string;
+/**
+ * Default implementation for utility to parse `history`-compatible location to {@link Route | Cxbox UI route}.
+ *
+ * Supports three types of URLs:
+ * - {@link RouteType.screen | RouteType.screen}, i.e. an url referencing some UI entity that can be parsed to Route directly. Example: `/screen/name/view/name/`;
+ * - {@link RouteType.router | RouteType.router}, i.e. an url without information about entity that should be handled on server side. Example: `/router/server-entity`
+ * - {@link RouteType.default | RouteType.default}, i.e. an url that leads to default entity of the application. Example: `/`
+ *
+ * Reverse function is {@link defaultBuildLocation}.
+ *
+ * @param loc Location compatible with `history` module
+ * @category Utils
+ */
+export declare function defaultParseLocation(loc: Location<any>): Route;
+/**
+ * Transform {@link Route | Cxbox UI route} to string url.
+ *
+ * Reverse function is {@link defaultParseLocation}.
+ *
+ * @param route Cxbox UI route
+ * @category Utils
+ */
+export declare function defaultBuildLocation(route: Route): string;

package/utils/index.d.ts

@@ -0,0 +1,6 @@
+export * as api from './api';
+export * as redux from './redux';
+export * as strings from './strings';
+export * as history from './history';
+export * as filters from './filters';
+export * as operations from './operations';

package/utils/notifications.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Shows antd notification with button
+ *
+ * @param description Notification message
+ * @param buttonText Displayed text on button
+ * @param duration How long notification will be shown
+ * @param onButtonClick Button callback
+ * @param key Used for updating existing notification instead of showing new one.
+ * If omitted, following template will be used to generate unique key: `notification_${Date.now}`
+ */
+export declare const openButtonWarningNotification: (description: string, buttonText: string, duration?: number, onButtonClick?: () => void, key?: string) => string;

package/utils/operations.d.ts

@@ -0,0 +1,21 @@
+import { Operation, OperationGroup, OperationTypeCrud } from '../interfaces/operation';
+import { Store } from '../interfaces/store';
+import { ActionPayloadTypes } from '../actions/actions';
+/**
+ * Extract operations from all operations groups and return them as an array of flat operations
+ *
+ * @param operations Operations or operation groups as received from row meta
+ * @category Utils
+ */
+export declare function flattenOperations(operations: Array<Operation | OperationGroup>): Operation[];
+/**
+ * Check if an operation matches a specified `role` directly by type or by `actionRole` field.
+ *
+ * If operation role is unavailable due to the store lacking an appropriate row meta, only `role` is checked.
+ *
+ * @param role Expected operation role or 'none' if operation shouldn't match any crud role
+ * @param payload sendOperation action payload
+ * @param store Store instance
+ * @category Utils
+ */
+export declare function matchOperationRole(role: OperationTypeCrud | 'none' | string, payload: ActionPayloadTypes['sendOperation'], store: Store): boolean;

package/utils/redux.d.ts

@@ -0,0 +1,49 @@
+import { Dispatch, ReducersMapObject, Reducer } from 'redux';
+import { MapDispatchToPropsFactory } from 'react-redux';
+import { CombinedReducersMapObject } from '../interfaces/store';
+import { AnyAction } from '../actions/actions';
+/**
+ * Combines a dictionary of reducers for different slices of the store into one
+ * root reducer.
+ *
+ * Effectively works like default redux `combineReducers` but provides access to the store
+ * via the third argument to allow reducers read only access to other slices
+ * (simplifies callbacks, epics and actions' payloads).
+ *
+ * @param reducers A dictionary of reducers for different slices of the redux store
+ * @category Utils
+ */
+export declare function combineReducers<State>(reducers: ReducersMapObject<State, AnyAction> | CombinedReducersMapObject<State, AnyAction>): Reducer<State, AnyAction>;
+/**
+ * Shallow compare of two dictionaries by strict comparison.
+ * `ignore` argument can be used to forcefully exclude some properties from result set even if their
+ * are different.
+ *
+ * TODO: Check if possible to replace with `shallowEqual` from `react-redux`
+ *
+ * @param prevProps
+ * @param nextProps
+ * @param ignore
+ */
+export declare function shallowCompare(prevProps: Record<string, any>, nextProps: Record<string, any>, ignore?: string[]): string[];
+/**
+ * TODO: JSDoc
+ */
+declare class ActionsContext<T> {
+    /**
+     * TODO
+     */
+    dispatch: Dispatch<any>;
+    /**
+     * TODO
+     */
+    props: T;
+}
+/**
+ * TODO: JSDoc
+ *
+ * @param contextCreator
+ * @param actionsCreator
+ */
+export declare function createMapDispatchToProps<ContextProps, Actions, OwnProps>(contextCreator: (props: OwnProps) => ContextProps, actionsCreator: (context: ActionsContext<ContextProps>) => Actions): MapDispatchToPropsFactory<Actions, OwnProps>;
+export {};

package/utils/strings.d.ts

@@ -0,0 +1,43 @@
+import { Store } from '../interfaces/store';
+import { DataItem } from '../interfaces/data';
+/**
+ * TODO
+ *
+ * @param literals
+ * @param placeholders
+ */
+export declare function getTemplate(literals: TemplateStringsArray, ...placeholders: any[]): string;
+/**
+ * Forms a string representation of business components hierarchy with
+ * respect to business components ancestors and their corresponding cursors
+ *
+ * @param bcName Business component name
+ * @param includeSelf If result hierarchy should include target bc or only ancestors
+ * @param store
+ * @category Utils
+ */
+export declare function buildBcUrl(bcName: string, includeSelf?: boolean, store?: Store): string;
+/**
+ * If there is a template in the field name then returns the formatted string
+ *
+ * @param title Field name
+ * @param dataItem An object in the fields of which tokens should be searched
+ */
+export declare function getFieldTitle(title: string, dataItem?: DataItem): string;
+/**
+ * If there is a template in the field name then returns array of string
+ *
+ * Example:
+ * splitIntoTokens(`The quick brown fox jumps over the lazy dog. If the dog reacted, was it realdogly lazy?`, 'dog')
+ * ["The quick brown fox jumps over the lazy ", "dog", ". If the ", "dog", " reacted, was it real", "dog", "ly lazy?"]
+ *
+ * @param source Field name
+ * @param search An object in the fields of which tokens should be searched
+ */
+export declare function splitIntoTokens(source: string, search: string | RegExp): string[];
+/**
+ * Convert string to RegExp
+ *
+ * @param str Source string
+ */
+export declare function escapedSrc(str: string): RegExp;

package/utils/tree.d.ts

@@ -0,0 +1,43 @@
+/**
+ * This module contains utilities for tree-like structures
+ */
+import { DataNode, TreeNodeBidirectional, TreeNodeDescending } from '../interfaces/tree';
+/**
+ * Assigns for each element:
+ *
+ * - `parent` property, which is a reference to parent mode found through `parentId` match.
+ * - `children` property, which is an array of references to child nodes.
+ *
+ * `parentId`: '0' considered a root pseudo-node
+ *
+ * Orphaned records will be excluded from result and throw a console warning.
+ *
+ * @param flat Flat array representation of tree structure
+ * @returns New array
+ */
+export declare function assignTreeLinks<T extends DataNode>(flat: T[]): (T & TreeNodeBidirectional)[];
+/**
+ * Recursively traverse through each node and their descendant to aggregate ids of all
+ * descendant nodes into `result` array.
+ *
+ * @param nodes Nodes to start search from; their ids also will be part of the result
+ * @param result An array of ids for found descendant nodes
+ */
+export declare function getDescendants(nodes: TreeNodeDescending[], result: string[]): void;
+/**
+ * Returns array of matching nodes, their direct children and every ancestor node
+ *
+ * @param nodes An array to search
+ * @param matchingNodes Ids of the nodes to match
+ */
+export declare function buildSearchResultTree<T extends TreeNodeBidirectional = TreeNodeBidirectional>(nodes: T[], matchingNodes: string[]): T[];
+/**
+ * Presort items based on their `level` property: each parent is followed by its descendant.
+ * Items with level `1` considered to be root-level items.
+ *
+ * Notice: not very performant and almost always wasted as Cxbox API mostly returns already
+ * sorted data.
+ *
+ * @param data Unsorted data
+ */
+export declare function presort(data: TreeNodeBidirectional[]): TreeNodeBidirectional[];

package/utils/viewTabs.d.ts

@@ -0,0 +1,20 @@
+import { MenuItem, ViewNavigationCategory, NavigationTab } from '../interfaces/navigation';
+/**
+ * Return navigation tabs array appropriate for specified level of navigation and currently active view
+ *
+ * @param navigation Navigation `menu` description from screen meta model
+ * @param level Target level of navigation
+ * @param activeView Currently active view
+ */
+export declare function getViewTabs(navigation: Array<Exclude<MenuItem, ViewNavigationCategory>>, level: number, activeView?: string): NavigationTab[];
+/**
+ * Return matching navigation tab for provided navigation item:
+ * - view name if item is just a view
+ * - group title and referenced view name, where view is found by breadth-first search through group children
+ * for default view if `defaultView` is specified on group or first available view otherwise.
+ *
+ * TODO: Change Exclude<MenuItem, ViewNavigationCategory> to MenuItem in 2.0.0
+ *
+ * @param navigationItem
+ */
+export declare function getReferencedView(navigationItem: Readonly<Exclude<MenuItem, ViewNavigationCategory>>): string;