@cxbox-ui/core 2.0.0-alpha.7 → 2.0.0-alpha.9

package/dist/interfaces/view.d.ts

@@ -1,202 +0,0 @@
-import { WidgetMeta } from './widget';
-import { RowMeta } from './rowMeta';
-import { PendingDataItem, PickMap } from './data';
-import { SystemNotification } from './objectMap';
-import { OperationTypeCrud, OperationPostInvokeConfirm } from './operation';
-import { AxiosError } from 'axios';
-export { FieldType } from '@cxbox-ui/schema';
-export interface ViewSelectedCell {
-    widgetName: string;
-    rowId: string;
-    fieldKey: string;
-}
-export interface PendingValidationFails {
-    [bcName: string]: {
-        [cursor: string]: Record<string, string>;
-    };
-}
-/**
- * Describes format of `pendingValidationFails`
- * TODO remove in 2.0.0
- */
-export declare enum PendingValidationFailsFormat {
-    old = "old",
-    target = "target"
-}
-export interface ViewState extends ViewMetaResponse {
-    rowMeta: {
-        [bcName: string]: {
-            [bcUrl: string]: RowMeta;
-        };
-    };
-    pendingDataChanges: {
-        [bcName: string]: {
-            [cursor: string]: PendingDataItem;
-        };
-    };
-    handledForceActive: {
-        [bcName: string]: {
-            [cursor: string]: PendingDataItem;
-        };
-    };
-    metaInProgress: {
-        [bcName: string]: boolean;
-    };
-    popupData?: PopupData;
-    infiniteWidgets?: string[];
-    pickMap?: PickMap;
-    selectedCell?: ViewSelectedCell;
-    systemNotifications?: SystemNotification[];
-    error?: ApplicationError;
-    /**
-     * For backward compatibility
-     *
-     * `old` describes `pendingValidationFails` as `Record<string, string>`
-     * `target` describes `pendingValidationFails` as `PendingValidationFails`
-     */
-    pendingValidationFailsFormat?: PendingValidationFailsFormat.old | PendingValidationFailsFormat.target;
-    pendingValidationFails?: Record<string, string> | PendingValidationFails;
-    modalInvoke?: {
-        operation: {
-            bcName: string;
-            operationType: OperationTypeCrud | string;
-            widgetName: string;
-        };
-        confirmOperation: OperationPostInvokeConfirm;
-    };
-}
-/**
- * View description returned by Cxbox API
- */
-export interface ViewMetaResponse {
-    /**
-     * @deprecated Deprecated in favor of `name`
-     */
-    id?: number;
-    /**
-     * Name of the view as specified in *.view.json file
-     */
-    name: string;
-    /**
-     * Displayed title
-     */
-    title?: string;
-    /**
-     * Specifies which layout template to use for the view
-     *
-     *Not used in Cxbox UI Core, but can used by client application
-     */
-    template?: string;
-    /**
-     * @deprecated Used for dynamic view layouts (configurable from user side), which are no longer implemented
-     */
-    customizable?: boolean;
-    /**
-     * @deprecated Not used
-     */
-    editable?: boolean;
-    /**
-     * Url for the view (usually in form of `${screen.name}/${view.name}`)
-     */
-    url: string;
-    /**
-     * Widgets present on the view
-     */
-    widgets: WidgetMeta[];
-    /**
-     * @deprecated Used for dynamic view layouts (configurable from user side), which are no longer implemented
-     */
-    columns?: number | null;
-    /**
-     * @deprecated Used for dynamic view layouts (configurable from user side), which are no longer implemented
-     */
-    rowHeight?: number | null;
-    /**
-     * Not used in Cxbox UI Core, but can be used by client application
-     */
-    readOnly?: boolean;
-    /**
-     * Not used in Cxbox UI Core
-     *
-     * TODO: Need description
-     */
-    ignoreHistory?: boolean;
-}
-export type PopupType = 'assoc' | 'file-upload' | null;
-/**
- * Describes currently open popup
- *
- * TODO: Split interface by popup types
- */
-export interface PopupData {
-    /**
-     * Business component of the widget that initiated popup
-     *
-     * TODO: Will me removed in favor of widgetName in 2.0.0
-     */
-    calleeBCName?: string;
-    /**
-     * Name of the widget that initiated popup
-     */
-    calleeWidgetName?: string;
-    /**
-     * Type of the popup
-     *
-     * TODO: Will not be optional in 2.0.0
-     */
-    type?: PopupType;
-    /**
-     * Business component for widget in Popup
-     *
-     * TODO: Move to inherited interfaces (not all popups display widgets)
-     */
-    bcName?: string;
-    /**
-     * Name of popup widget
-     *
-     * TODO: Move to inherited interfaces (not all popups display widgets)
-     */
-    widgetName?: string;
-    /**
-     * TODO: Description + move to AssocPopupDescriptor
-     */
-    associateFieldKey?: string;
-    /**
-     * TODO: Description + move to AssocPopupDescriptor
-     */
-    assocValueKey?: string;
-    /**
-     * If true popup confirm button will send selected items to Cxbox API
-     *
-     * TODO: Move to AssocPopupDescriptor
-     */
-    active?: boolean;
-    /**
-     * This popup is used as a filter
-     *
-     * TODO: Used only by assocs so probably move to AssocPopupDescriptor
-     */
-    isFilter?: boolean;
-}
-export type ApplicationError = BusinessError | SystemError | ApplicationErrorBase;
-export declare enum ApplicationErrorType {
-    BusinessError = 0,
-    SystemError = 1,
-    NetworkError = 2
-}
-export interface ApplicationErrorBase {
-    type: ApplicationErrorType;
-    code?: number;
-}
-export interface BusinessError extends ApplicationErrorBase {
-    type: ApplicationErrorType.BusinessError;
-    message: string;
-}
-export interface SystemError extends ApplicationErrorBase {
-    type: ApplicationErrorType.SystemError;
-    error?: AxiosError;
-    details: string;
-}
-export interface NetworkError extends ApplicationErrorBase {
-    type: ApplicationErrorType.NetworkError;
-}

package/dist/interfaces/widget.d.ts

@@ -1,209 +0,0 @@
-import { WidgetShowCondition, WidgetTypes, WidgetOptions, WidgetFormField, WidgetListField, WidgetInfoField } from '@cxbox-ui/schema';
-import { ComponentType } from 'react';
-export type { WidgetOptions, WidgetShowCondition, LayoutRow, LayoutCol, WidgetOperations, TableOperations, WidgetTableHierarchy, WidgetFieldBase, WidgetListFieldBase, WidgetFormFieldBase, AllWidgetTypeFieldBase, NumberFieldMeta, DateFieldMeta, CheckboxFieldMeta, DateTimeFieldMeta, DateTimeWithSecondsFieldMeta, DictionaryFieldMeta, TextFieldMeta, InputFieldMeta, MultiFieldMeta, MultivalueFieldMeta, PickListFieldMeta, InlinePickListFieldMeta, FileUploadFieldMeta, WidgetFormField, WidgetListField, HiddenFieldMeta, RadioButtonFieldMeta, WidgetField, WidgetInfoField } from '@cxbox-ui/schema';
-export { WidgetTypes, PositionTypes } from '@cxbox-ui/schema';
-/**
- * Different widget types that are considered `tables` in nature for purposes of applying some shared features.
- * For example, autofocus on missing required field should work for tables but not forms.
- *
- * TODO: Make extension point
- *
- * @category Components
- */
-export declare const TableLikeWidgetTypes: readonly [WidgetTypes.List, WidgetTypes.DataGrid, WidgetTypes.AssocListPopup, WidgetTypes.PickListPopup, WidgetTypes.FlatTree, WidgetTypes.FlatTreePopup];
-/**
- * Widgets that are considered `popups` and usually excluded from widgets layout grid
- */
-export declare const PopupWidgetTypes: string[];
-/**
- * All widget types that display table-like data.ts
- */
-type TableLikeWidgetType = (typeof TableLikeWidgetTypes)[number];
-export interface WidgetInfoOptions {
-    fieldBorderBottom?: boolean;
-    footer?: string;
-}
-export interface WidgetMeta {
-    name: string;
-    type: WidgetTypes | string;
-    title: string;
-    bcName: string;
-    /**
-     * Business components ancestors hierarchy
-     *
-     * TODO: Will be mandatory (but nullable) in 2.0.0
-     *
-     * It is declared in `WidgetDTO` of Cxbox API, can be null for widgets without
-     * business component (headers, navigation tabs, etc.)
-     */
-    url?: string | null;
-    position: number;
-    limit?: number;
-    gridWidth: number;
-    fields: unknown[];
-    options?: WidgetOptions;
-    showCondition?: WidgetShowCondition;
-    description?: string;
-}
-/**
- * Description of the list of fields of block type.
- *
- * @deprecated Used to create a block grouping of fields
- */
-export interface WidgetFieldBlock<T> {
-    /**
-     * Block ID
-     */
-    blockId: number;
-    /**
-     * Name of the block
-     */
-    name: string;
-    /**
-     * Fields contained in the block
-     */
-    fields: T[];
-    /**
-     * @deprecated TODO: Remove in 2.0.0, used to denote a new row in old layout system for forms
-     */
-    newRow?: boolean;
-    /**
-     * @deprecated TODO: Remove in 2.0.0, used to ...
-     */
-    break?: boolean;
-}
-export type WidgetFieldsOrBlocks<T> = Array<T | WidgetFieldBlock<T>>;
-/**
- * Configuration for widgets dislaying form data.ts
- */
-export interface WidgetFormMeta extends WidgetMeta {
-    /**
-     * Unambiguous marker for JSON file specifing widget type
-     */
-    type: WidgetTypes.Form;
-    /**
-     * Descriptor for fields or block of fields on the form
-     */
-    fields: WidgetFieldsOrBlocks<WidgetFormField>;
-}
-/**
- * Configuration for widgets displaying table-like data.ts
- */
-export interface WidgetTableMeta extends WidgetMeta {
-    /**
-     * Unambiguous marker for JSON file specifing widget type
-     */
-    type: TableLikeWidgetType;
-    /**
-     * Descriptor for table columns
-     */
-    fields: WidgetListField[];
-}
-/**
- * Configuration for widgets displaying read-only table data.ts
- */
-export interface WidgetInfoMeta extends WidgetMeta {
-    /**
-     * Unambiguous marker for JSON file specifying widget type
-     */
-    type: WidgetTypes.Info;
-    /**
-     * Descriptor for fields or block of fields on the form
-     */
-    fields: WidgetFieldsOrBlocks<WidgetInfoField>;
-    /**
-     * Options for customizing widget
-     */
-    options?: WidgetOptions & WidgetInfoOptions;
-}
-/**
- * Configuration for widgets displaying markdown text
- */
-export interface WidgetTextMeta extends WidgetMeta {
-    /**
-     * Unambiguous marker for JSON file specifying widget type
-     */
-    type: WidgetTypes.Text;
-    /**
-     * Text to display
-     */
-    description: string;
-    /**
-     * Title text
-     */
-    descriptionTitle: string;
-}
-/**
- * Options configuration for widgets displaying NavigationTabs
- */
-export interface NavigationOptions extends WidgetOptions {
-    /**
-     * Level of menu
-     */
-    navigationLevel?: number;
-}
-/**
- * Configuration for widgets displaying NavigationTabs
- */
-export interface NavigationWidgetMeta extends WidgetMeta {
-    /**
-     * Unambiguous marker for JSON file specifying widget type
-     */
-    type: WidgetTypes.NavigationTabs | WidgetTypes.ViewNavigation;
-    /**
-     * Options for customizing widget
-     */
-    options: NavigationOptions;
-}
-/**
- * A widget configuration of any known type
- */
-export type WidgetMetaAny = WidgetFormMeta | WidgetTableMeta | WidgetTextMeta | WidgetInfoMeta | NavigationWidgetMeta;
-/**
- * Component of custom widget
- *
- * @deprecated TODO: Remove in 2.0.0
- */
-export type CustomWidget = ComponentType<any>;
-/**
- * Configuration of custom widget
- */
-export interface CustomWidgetConfiguration {
-    /**
-     * Whether widget is popup
-     */
-    isPopup?: boolean;
-    /**
-     * Component of custom widget
-     */
-    component: ComponentType<any>;
-    /**
-     * Card of widget
-     */
-    card?: ComponentType<any> | null;
-}
-export type CustomWidgetDescriptor = CustomWidget | CustomWidgetConfiguration;
-/**
- * Check if descriptor is just a widget, or it has additional data.ts
- */
-export declare function isCustomWidget(descriptor: CustomWidgetDescriptor): descriptor is CustomWidget;
-/**
- * Checks whether @param descriptor is an instance of `CustomWidgetConfiguration`
- *
- * @param descriptor custom widget descriptor
- */
-export declare function isCustomWidgetConfiguration(descriptor: CustomWidgetDescriptor): descriptor is CustomWidgetConfiguration;
-/**
- * TODO
- *
- * @param item
- * @category Type Guards
- */
-export declare function isWidgetFieldBlock(item: any): item is WidgetFieldBlock<any>;
-/**
- * Type of pagination, either page numbers or "Load More" button
- */
-export declare enum PaginationMode {
-    page = "page",
-    loadMore = "loadMore"
-}

package/dist/middlewares/autosaveMiddleware.d.ts

@@ -1,2 +0,0 @@
-import { Middleware } from 'redux';
-export declare const saveFormMiddleware: Middleware;

package/dist/middlewares/index.d.ts

@@ -1,6 +0,0 @@
-export declare const middlewares: {
-    autosave: import("redux").Middleware<{}, any, import("redux").Dispatch<import("redux").AnyAction>>;
-    requiredFields: import("redux").Middleware<{}, any, import("redux").Dispatch<import("redux").AnyAction>>;
-    preInvoke: import("redux").Middleware<{}, any, import("redux").Dispatch<import("redux").AnyAction>>;
-    popup: import("redux").Middleware<{}, any, import("redux").Dispatch<import("redux").AnyAction>>;
-};

package/dist/middlewares/popupMiddleware.d.ts

@@ -1,2 +0,0 @@
-import { Middleware } from 'redux';
-export declare const popupMiddleware: Middleware;

package/dist/middlewares/preInvokeMiddleware.d.ts

@@ -1,5 +0,0 @@
-/**
- * Process preInvoke operation before action sendOperation
- */
-import { Middleware } from 'redux';
-export declare const preInvokeAction: Middleware;

package/dist/middlewares/requiredFieldsMiddleware.d.ts

@@ -1,30 +0,0 @@
-/**
- * Handles validation of "required fields" for widget operations
- */
-import { Middleware } from 'redux';
-import { Operation, OperationGroup, PendingDataItem, RowMetaField, Store } from '../interfaces';
-import { DataItem } from '@cxbox-ui/schema';
-export declare const requiredFields: Middleware;
-/**
- * Check operations and operation groups for 'autoSaveBefore' flag (i.e. operation is validation-sensetive)
- *
- * @param operationType Key of operation to check
- * @param actions List of operations and/or operation groups
- */
-export declare function operationRequiresAutosave(operationType: string, actions: Array<Operation | OperationGroup>): boolean;
-/**
- * Check if required records fields have a falsy value.
- * "Falsy" stands for "undefined", "null", "", [] and {}.
- *
- * @param record Record to check
- * @param pendingChanges Pending record changes which could override record values
- * @param fieldsMeta
- */
-export declare function getRequiredFieldsMissing(record: DataItem, pendingChanges: PendingDataItem, fieldsMeta: RowMetaField[]): PendingDataItem;
-/**
- * Checks if `pendingValidationFails` is not empty
- *
- * @param store
- * @param bcName
- */
-export declare function hasPendingValidationFails(store: Store, bcName: string): boolean;

package/dist/reducers/ReducerBuilderManager.d.ts

@@ -1,19 +0,0 @@
-import { ActionReducerMapBuilder, CaseReducer } from '@reduxjs/toolkit';
-import { Action, AnyAction } from 'redux';
-interface TypedActionCreator<Type extends string> {
-    (...args: any[]): Action<Type>;
-    type: Type;
-}
-type TypeGuard<T> = (value: any) => value is T;
-export declare class ReducerBuilderManager<State> {
-    private reducers;
-    private matchers;
-    private defaultCaseReducer;
-    addCase<ActionCreator extends TypedActionCreator<string>>(action: ActionCreator, reducer: CaseReducer<State, ReturnType<ActionCreator>>): this;
-    removeCase<ActionCreator extends TypedActionCreator<string>>(action: ActionCreator): this;
-    replaceCase<ActionCreator extends TypedActionCreator<string>>(action: ActionCreator, reducer: CaseReducer<State, ReturnType<ActionCreator>>): this;
-    addMatcher<A>(matcher: TypeGuard<A> | ((action: any) => boolean), reducer: CaseReducer<State, A extends AnyAction ? A : A & AnyAction>): Omit<ReducerBuilderManager<State>, 'addCase'>;
-    addDefaultCase(reducer: CaseReducer<State, AnyAction>): Omit<ReducerBuilderManager<State>, 'addCase' | 'addMatcher' | 'addDefaultCase'>;
-    get builder(): (builder: ActionReducerMapBuilder<State>) => {};
-}
-export {};

package/dist/reducers/data.d.ts

@@ -1,4 +0,0 @@
-import { DataState } from '../interfaces';
-import { ReducerBuilderManager } from './ReducerBuilderManager';
-export declare const dataInitialState: DataState;
-export declare const createDataReducerBuilderManager: (initialState: DataState) => ReducerBuilderManager<DataState>;

package/dist/reducers/depthData.d.ts

@@ -1,4 +0,0 @@
-import { DepthDataState } from '../interfaces';
-import { ReducerBuilderManager } from './ReducerBuilderManager';
-export declare const initialDepthDataState: DepthDataState;
-export declare const createDepthDataReducerBuilderManager: (initialState: DepthDataState) => ReducerBuilderManager<DepthDataState>;

package/dist/reducers/index.d.ts

@@ -1,6 +0,0 @@
-export * from './data';
-export * from './depthData';
-export * from './router';
-export * from './screen';
-export * from './session';
-export * from './view';

package/dist/reducers/router.d.ts

@@ -1,9 +0,0 @@
-import { Route } from '../interfaces';
-import { ReducerBuilderManager } from './ReducerBuilderManager';
-export declare const initialRouterState: Route;
-/**
- * Router reducer
- *
- * Stores information about currently active route
- */
-export declare const createRouterReducerBuilderManager: <S extends Route>(initialState: S) => ReducerBuilderManager<S>;

package/dist/reducers/screen.d.ts

@@ -1,10 +0,0 @@
-import { ScreenState } from '../interfaces';
-import { ReducerBuilderManager } from './ReducerBuilderManager';
-export declare const initialScreenState: ScreenState;
-/**
- * Screen reducer
- *
- * Stores information about currently active screen and various more persistent values which should be stored
- * until we navitage to a different screen.
- */
-export declare const createScreenReducerBuilderManager: <S extends ScreenState>(initialState: S) => ReducerBuilderManager<S>;

package/dist/reducers/session.d.ts

@@ -1,10 +0,0 @@
-import { Session } from '../interfaces';
-import { ReducerBuilderManager } from './ReducerBuilderManager';
-export declare const initialSessionState: Session;
-/**
- * Session reducer
- *
- * Stores information about currently active session and dataEpics.ts that should be persistent during all period of
- * user interaction with application.
- */
-export declare const createSessionReducerBuilderManager: <S extends Session>(initialState: S) => ReducerBuilderManager<S>;

package/dist/reducers/view.d.ts

@@ -1,10 +0,0 @@
-import { ViewState } from '../interfaces';
-import { ReducerBuilderManager } from './ReducerBuilderManager';
-export declare const initialViewState: ViewState;
-/**
- * View reducer
- *
- * Stores information about currently active view and various fast-living pending values which should be stored
- * until we navitage to a different view.
- */
-export declare const createViewReducerBuilderManager: <S extends ViewState>(initialState: S) => ReducerBuilderManager<S>;

package/dist/utils/api.d.ts

@@ -1,25 +0,0 @@
-export interface ApiCallContext {
-    widgetName: string;
-}
-type QueryParamsMap = Record<string, string | number>;
-/**
- * Extends url with query parameters control symbol (`?` or `&`)
- *
- * @param url Url with or without `?` symbol
- */
-export declare function addTailControlSequences(url: string): string;
-/**
- * Extends url with query parameters
- *
- * @param url Url to extend
- * @param qso Query parameters dictionary
- */
-export declare function applyParams(url: string, qso?: QueryParamsMap): string;
-/**
- * TODO
- *
- * @param url
- * @param qso
- */
-export declare function applyRawParams(url: string, qso: Record<string, any>): string;
-export {};

package/dist/utils/apiError.d.ts

@@ -1,19 +0,0 @@
-import { AxiosError } from 'axios';
-interface ApiCallContext {
-    widgetName: string;
-}
-export declare function createApiError(error: AxiosError, context?: ApiCallContext): {
-    payload: {
-        error: AxiosError<unknown, any>;
-        callContext: import("./api").ApiCallContext;
-    };
-    type: string;
-};
-export declare function createApiErrorObservable(error: AxiosError, context?: ApiCallContext): import("rxjs").Observable<{
-    payload: {
-        error: AxiosError<unknown, any>;
-        callContext: import("./api").ApiCallContext;
-    };
-    type: string;
-}>;
-export {};

package/dist/utils/autosave.d.ts

@@ -1,37 +0,0 @@
-import { Store as CoreStore } from '../interfaces/store';
-import { AnyAction, Dispatch, MiddlewareAPI } from 'redux';
-/**
- * Performs mechanism of autosave
- *
- * @param action
- * @param store
- * @param next
- * @category Utils
- */
-export declare function autosaveRoutine(action: AnyAction, store: MiddlewareAPI<Dispatch<AnyAction>, CoreStore>, next: Dispatch): AnyAction | {
-    payload: {
-        bcName: string;
-        operationType: string;
-        widgetName: string;
-        onSuccessAction?: AnyAction;
-        confirm?: string;
-        bcKey?: string;
-        confirmOperation?: import("../interfaces/operation").OperationPreInvoke;
-    };
-    type: string;
-};
-/**
- * Checks presence of pending changes suitable for autosave
- *
- * @param store
- * @param bcName
- * @param cursor
- */
-export declare function bcHasPendingAutosaveChanges(store: CoreStore, bcName: string, cursor: string): boolean;
-/**
- * Checks presence of unsaved data.ts for specified BC
- *
- * @param store
- * @param bcName
- */
-export declare function checkUnsavedChangesOfBc(store: CoreStore, bcName: string): boolean;

package/dist/utils/bc.d.ts

@@ -1,27 +0,0 @@
-import { WidgetMeta, WidgetShowCondition } from '../interfaces/widget';
-import { BcMetaState } from '../interfaces/bc';
-import { DataItem, PendingDataItem } from '../interfaces/data';
-/**
- * Find all widgets referencing or descendant from specified origin BC
- *
- * @param originBcName Origin business component name
- * @param widgets Widgets to search through
- * @param bcMap Business components dictionary
- * @returns A dictionary of business components and widgets
- */
-export declare function getBcChildren(originBcName: string, widgets: WidgetMeta[], bcMap: Record<string, BcMetaState>): Record<string, string[]>;
-/**
- * Check specified show condition for the widget
- *
- * Condition is true (and widget is visible) if currently active record for condition business component has a value of the specific
- * field matching the condition; pending values are also enough for the condition to be true.
- * Condition is also true when it explicitly declared as default condition, if it's empty or of the legacy array format
- *
- * Otherwise the condition is false and the widget is hidden.
- *
- * @param condition Widget showCondition to check
- * @param cursor Id of active record for business component in condition
- * @param data An array of data.ts items to check for condition
- * @param pendingDataChanges Pending data.ts changes of the currently active view
- */
-export declare function checkShowCondition(condition: WidgetShowCondition | undefined, cursor: string, data: DataItem[], pendingDataChanges: Record<string, Record<string, PendingDataItem>>): boolean;

package/dist/utils/breadthFirst.d.ts

@@ -1,21 +0,0 @@
-/**
- * Search node matching the predicate on the current depth prior to moving to the next depth level
- *
- * @param root Tree root
- * @param predicate Search condition for the target tree node
- * @returns Matching node and a tree depth where this node was found
- */
-export declare function breadthFirstSearch<T>(root: T, predicate: (current: any) => boolean, depth?: number, childrenProperty?: keyof T): BreadthFirstResult<T>;
-/**
- * Bredth-first search result
- */
-export interface BreadthFirstResult<T> {
-    /**
-     * Matching node
-     */
-    node: T;
-    /**
-     * Tree depth where this node was found
-     */
-    depth: number;
-}