@cxbox-ui/core 2.0.0-alpha.8 → 2.0.0

package/dist/utils/cancelRequestEpic.d.ts

@@ -1,27 +0,0 @@
-import { Observable } from 'rxjs';
-import { AnyAction } from 'redux';
-import { isAnyOf } from '@reduxjs/toolkit';
-/**
- * Type tweak for backward @reduxjs/toolkit compatibility
- */
-type TypeGuard<T> = (value: any) => value is T;
-interface HasMatchFunction<T> {
-    match: TypeGuard<T>;
-}
-/** @public */
-type Matcher<T> = HasMatchFunction<T> | TypeGuard<T>;
-/**
- * Default list of action types which are triggers for request cancel
- */
-export declare const cancelRequestActionTypes: [Matcher<any>, ...Matcher<any>[]];
-/**
- * Creator of request cancel epic
- *
- * @param action$ an observable input
- * @param actionTypes list of action types which triggers cancel
- * @param cancelFn a callback of request cancelation
- * @param cancelActionCreator an action creator which called by request cancelation
- * @param filterFn a callback function which filters come actions
- */
-export declare function cancelRequestEpic(action$: Observable<AnyAction>, actionTypes: Parameters<typeof isAnyOf>, cancelFn: (() => void) | undefined, cancelActionCreator: AnyAction, filterFn?: (actions: AnyAction) => boolean): Observable<AnyAction>;
-export {};

package/dist/utils/combineMiddlewares.d.ts

@@ -1,3 +0,0 @@
-import { Middleware } from 'redux';
-import { CustomMiddlewares, CoreMiddlewares } from '../interfaces/customMiddlewares';
-export declare function combineMiddlewares(coreMiddlewares: CoreMiddlewares, customMiddlewares?: CustomMiddlewares): Middleware<{}, any, import("redux").Dispatch<import("redux").AnyAction>>[];

package/dist/utils/deleteUndefinedFromObject.d.ts

@@ -1 +0,0 @@
-export declare function deleteUndefinedFromObject(obj: Record<string, any>): void;

package/dist/utils/extendPopupWidgetTypes.d.ts

@@ -1,8 +0,0 @@
-import { CustomWidgetDescriptor } from '../interfaces/widget';
-/**
- * Add new values to `PopupWidgetTypes` from client application
- *
- * @param customWidgets client's widgets
- */
-declare function extendPopupWidgetTypes(customWidgets: Record<string, CustomWidgetDescriptor>): void;
-export default extendPopupWidgetTypes;

package/dist/utils/filters.d.ts

@@ -1,63 +0,0 @@
-import { BcFilter, BcSorter, FilterType, FieldType } from '../interfaces';
-/**
- * Maps an input array of BcFilter objects into a dictionary of GET-request params
- *
- * Name of the param formed as field name and filter type, separated by dot,
- * e.g. `${filter.fieldName}.${filter.type}`
- *
- * Value of the param is:
- * - for non-array values, stringified filter value
- * - for array values, a comma-separated list of stringified elements with each element enclosed in double quotes
- *
- * @see {@link parseFilters} Reverse function
- *
- * @param filters Filters for business components
- * @returns Dictionary of query-params for GET-request
- * @category Utils
- */
-export declare function getFilters(filters: BcFilter[]): Record<string, string>;
-/**
- * Maps an input array of business component sorters into a dictionary of query params for
- * Cxbox API, where values are field names and keys follows the template:
- * `_sort.${index}.${item.direction}`
- *
- * @param sorters Array of business component sorters
- * @returns Dictionary of query-params for GET-request
- * @category Utils
- */
-export declare function getSorters(sorters: BcSorter[]): Record<string, string>;
-/**
- * Function for parsing filters from string into BcFilter type
- *
- * @see {@link getFilters} Reverse function
- * @param defaultFilters string representation of filters
- * @category Utils
- */
-export declare function parseFilters(defaultFilters?: string): BcFilter[];
-/**
- * Parse sorter string into separate sorter objects.
- * String representation of sorters is url based:
- * "_sort.{order}.{direction}={fieldKey}&_sort.{order}.{direction}"
- *
- * fieldKey Sort by field
- * order Priority of this specfic sorter
- * direction "asc" or "desc"
- *
- * i.e. "_sort.0.asc=firstName"
- *
- * @param sorters string representation of sorters
- * @category Utils
- */
-export declare function parseSorters(sorters?: string): BcSorter[];
-/**
- * Returns appropriate filtration type for specified field type.
- *
- * - Text-based fields use `contains`
- * - Checkbox fields use `specified` (boolean)
- * - Dictionary fiels use `equalsOneOf`
- *
- * All other field types use strict `equals`
- *
- * @param fieldType Field type
- */
-export declare function getFilterType(fieldType: FieldType): FilterType.equals | FilterType.contains | FilterType.specified | FilterType.equalsOneOf;

package/dist/utils/hierarchy.d.ts

@@ -1,17 +0,0 @@
-import { RowMetaField } from '../interfaces/rowMeta';
-import { WidgetListField } from '../interfaces/widget';
-/**
- * Function of calculate hierarchy column width
- *
- * @param columnName Witch column is match
- * @param depthLevel Hierarchy level
- * @param fields Widget fields
- * @param rowMetaFields Widget field meta
- * @param maxDepth Maximum hierarchy depth level
- * @param width Custom column width
- *
- * function return string value as number with 'px' or null
- * example '100px'
- * Last column dont math width and return null value
- */
-export declare function getColumnWidth(columnName: string, depthLevel: number, fields: WidgetListField[], rowMetaFields: RowMetaField[], maxDepth: number, width?: number): string;

package/dist/utils/highlightJson.d.ts

@@ -1,12 +0,0 @@
-/**
- * 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/dist/utils/history.d.ts

@@ -1,50 +0,0 @@
-/**
- * Utilities for urls and browser history
- */
-import { Route } from '../interfaces';
-/**
- * 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 defaultBuildURL}.
- *
- * @category Utils
- */
-export declare function defaultParseURL(url: URL): Route;
-/**
- * Transform {@link Route | Cxbox UI route} to string url.
- *
- * Reverse function is {@link defaultParseURL}.
- *
- * @param route Cxbox UI route
- * @category Utils
- */
-export declare function defaultBuildURL(route: Route): string;
-export declare const getRouteFromString: (ulrString: string) => Route;

package/dist/utils/index.d.ts

@@ -1,10 +0,0 @@
-export * from './api';
-export * from './apiError';
-export * from './strings';
-export * from './history';
-export * from './filters';
-export * from './operations';
-export * from './bc';
-export * from './tree';
-export * from './breadthFirst';
-export * from './deleteUndefinedFromObject';

package/dist/utils/operations.d.ts

@@ -1,21 +0,0 @@
-import { Operation, OperationGroup, OperationTypeCrud } from '../interfaces/operation';
-import { Store } from '../interfaces/store';
-import { sendOperation } from '../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: ReturnType<typeof sendOperation>['payload'], store: Store): boolean;

package/dist/utils/others.d.ts

@@ -1,6 +0,0 @@
-import { FieldType, MultivalueFieldMeta, PickListFieldMeta } from '@cxbox-ui/schema';
-export declare function isMultivalueField(fieldType: FieldType): boolean;
-export declare function getPopupAssocKeys(fieldMeta: MultivalueFieldMeta | PickListFieldMeta): {
-    assocValueKey: string;
-    associateFieldKey: string;
-};

package/dist/utils/strings.d.ts

@@ -1,44 +0,0 @@
-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 state
- * @category Utils
- */
-export declare function buildBcUrl(bcName: string, includeSelf: boolean, state: Store): string;
-export declare function splitBcUrl(bcUrl: string): 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/dist/utils/tree.d.ts

@@ -1,43 +0,0 @@
-/**
- * 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.ts.
- *
- * @param data Unsorted data.ts
- */
-export declare function presort(data: TreeNodeBidirectional[]): TreeNodeBidirectional[];

package/dist/utils/viewTabs.d.ts

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