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

package/dist/epics/utils/postOperationRoutine.d.ts

@@ -1,13 +0,0 @@
-import { OperationPostInvokeAny, OperationPreInvoke } from '../../interfaces';
-import { AnyAction } from '@reduxjs/toolkit';
-/**
- * Returns an array of observables for handling post- and pre-invokes from any epics handling operations
- *
- * @param widgetName Name of the widget that initiated the operation
- * @param postInvoke Response post-invoke
- * @param preInvoke Response pre-invoke
- * @param operationType Which operation was performed
- * @param bcName
- * @category Utils
- */
-export declare function postOperationRoutine(widgetName: string, postInvoke: OperationPostInvokeAny, preInvoke: OperationPreInvoke, operationType: string, bcName: string): import("rxjs").Observable<AnyAction>[];

package/dist/epics/view/clearPendingDataChangesAfterCursorChangeEpic.d.ts

@@ -1,7 +0,0 @@
-import { CXBoxEpic } from '../../interfaces';
-/**
- * Clears descendant business components pending changes on cursor change
- *
- * TODO: Review required as it might be no longer valid due to autosave middleware implementation
- */
-export declare const clearPendingDataChangesAfterCursorChangeEpic: CXBoxEpic;

package/dist/epics/view/fileUploadConfirmEpic.d.ts

@@ -1,11 +0,0 @@
-import { CXBoxEpic } from '../../interfaces';
-/**
- * It sends customAction request for `file-upload-save` endpoint with `bulkIds` dataEpics.ts
- * containing ids of uploaded files.
- * On success it fires `sendOperationSuccess`, `bcForceUpdate` and `closeViewPopup` actions
- * to refresh business component and close popup.
- *
- * It also launces postOperationRoutine to handle pre and post invokes.
- *
- */
-export declare const fileUploadConfirmEpic: CXBoxEpic;

package/dist/epics/view/getRowMetaByForceActiveEpic.d.ts

@@ -1,5 +0,0 @@
-import { CXBoxEpic } from '../../interfaces';
-/**
- * Sends row meta request when `forceActive` field fires `onChange`
- */
-export declare const getRowMetaByForceActiveEpic: CXBoxEpic;

package/dist/epics/view/index.d.ts

@@ -1,9 +0,0 @@
-export * from './sendOperationEpic';
-export * from './showAssocPopupEpic';
-export * from './fileUploadConfirmEpic';
-export * from './selectTableCellInitEpic';
-export * from './showFileUploadPopupEpic';
-export * from './sendOperationAssociateEpic';
-export * from './getRowMetaByForceActiveEpic';
-export * from './showAllTableRecordsInitEpic';
-export * from './clearPendingDataChangesAfterCursorChangeEpic';

package/dist/epics/view/selectTableCellInitEpic.d.ts

@@ -1,2 +0,0 @@
-import { CXBoxEpic } from '../../interfaces';
-export declare const selectTableCellInitEpic: CXBoxEpic;

package/dist/epics/view/sendOperationAssociateEpic.d.ts

@@ -1,5 +0,0 @@
-import { CXBoxEpic } from '../../interfaces';
-/**
- * Opens a popup with associate component.
- */
-export declare const sendOperationAssociateEpic: CXBoxEpic;

package/dist/epics/view/sendOperationEpic.d.ts

@@ -1,10 +0,0 @@
-import { CXBoxEpic } from '../../interfaces';
-/**
- * Handle any `sendOperationEpic` action which is not part of built-in operations types
- *
- * Request will be send to `custom-action/${screenName}/${bcUrl}?_action=${action.payload.type}` endpoint,
- * with pending changes of the widget as requst body.
- *
- * Fires sendOperationSuccess, bcForceUpdate and postOperationRoutine
- */
-export declare const sendOperationEpic: CXBoxEpic;

package/dist/epics/view/showAllTableRecordsInitEpic.d.ts

@@ -1,2 +0,0 @@
-import { CXBoxEpic } from '../../interfaces';
-export declare const showAllTableRecordsInitEpic: CXBoxEpic;

package/dist/epics/view/showAssocPopupEpic.d.ts

@@ -1,2 +0,0 @@
-import { CXBoxEpic } from '../../interfaces';
-export declare const showAssocPopupEpic: CXBoxEpic;

package/dist/epics/view/showFileUploadPopupEpic.d.ts

@@ -1,5 +0,0 @@
-import { CXBoxEpic } from '../../interfaces';
-/**
- * Fires `bcChangeCursors` and `showFileUploadPopupEpic` to drop the cursors and show file upload popup.
- */
-export declare const showFileUploadPopupEpic: CXBoxEpic;

package/dist/index.d.ts

@@ -1,7 +0,0 @@
-export * as reducers from './reducers';
-export * as actions from './actions';
-export * as epics from './epics';
-export { Api } from './api';
-export * as utils from './utils';
-export * as interfaces from './interfaces';
-export { middlewares } from './middlewares';

package/dist/interfaces/bc.d.ts

@@ -1,79 +0,0 @@
-/**
- * Interfaces for Business Component
- */
-import { FilterGroup } from './filters';
-/**
- * Meta data.ts for Business Component
- */
-export interface BcMeta {
-    /**
-     * Name of Business Component
-     */
-    name: string;
-    /**
-     * Name of parent Business Component
-     */
-    parentName: string | null;
-    /**
-     * TODO: desc, example
-     */
-    url: string;
-    /**
-     * Currently active record
-     */
-    cursor: string | null;
-    /**
-     * String representation of default bc sorters
-     *
-     * "_sort.{order}.{direction}={fieldKey}&_sort.{order}.{direction}"
-     *
-     * @param fieldKey Sort by field
-     * @param order Priority of this specific sorter
-     * @param direction "asc" or "desc"
-     * i.e. "_sort.0.asc=firstName"
-     */
-    defaultSort?: string;
-    /**
-     * Predefined filters
-     */
-    filterGroups?: FilterGroup[];
-    /**
-     * String representation of default bc filters
-     *
-     * "{fieldKey}.contains={someValue}"
-     *
-     * @param fieldKey Filtering field
-     * @param someValue Filter value
-     * i.e. "someField1.contains=someValue&someField2.equalsOneOf=%5B%22someValue1%22%2C%22someValue2%22%5D"
-     */
-    defaultFilter?: string;
-}
-export type DepthBcType = Record<number, {
-    loading?: boolean;
-    cursor?: string;
-}>;
-export interface BcMetaState extends BcMeta {
-    /**
-     * Data fetch for this business component is in progress
-     */
-    loading?: boolean;
-    /**
-     * Number of the page to fetch
-     */
-    page?: number;
-    /**
-     * Page limit to fetch
-     */
-    limit?: number;
-    /**
-     * There is an addional pages of data.ts to fetch
-     */
-    hasNext?: boolean;
-    /**
-     * Stores a selected cursor and loading state per depth level.
-     *
-     * Used by hierarchy widgets builded around single business component:
-     * controls which record is expanded and which children should be fetched.
-     */
-    depthBc?: DepthBcType;
-}

package/dist/interfaces/customEpics.d.ts

@@ -1,15 +0,0 @@
-/**
- * This module includes types to support overriding redux-observable Epics that we use in Cxbox UI by
- * custom implementations from client application.
- */
-import { Epic } from 'redux-observable';
-import { AnyAction } from '@reduxjs/toolkit';
-import { Store } from './store';
-import { Api } from '../api';
-export interface EpicDependencyInjection<A = Api> {
-    api: A;
-}
-/**
- * Default Epic typing with dependency injection
- */
-export type CXBoxEpic<S = Store, A = Api> = Epic<AnyAction, AnyAction, S, EpicDependencyInjection<A>>;

package/dist/interfaces/customMiddlewares.d.ts

@@ -1,35 +0,0 @@
-import { Middleware } from 'redux';
-import { middlewares } from '../middlewares';
-/**
- * Type of core middlewares
- */
-export type CoreMiddlewares = typeof middlewares;
-/**
- * Custom middleware interface
- */
-export interface CustomMiddleware {
-    /**
-     * Implementation of custom middleware
-     */
-    implementation: Middleware;
-    /**
-     * Priority of custom middleware
-     */
-    priority: 'BEFORE' | 'AFTER';
-}
-/**
- * List the names of all core middlewares
- */
-export type CoreMiddlewareType = keyof CoreMiddlewares;
-/**
- * Descriptor of custom middleware not presented in core middlewares
- */
-export type NewMiddlewareDescriptor<T = Record<string, unknown>> = Record<Exclude<keyof T, keyof CoreMiddlewares>, CustomMiddleware>;
-/**
- * Form a dictionary of override descriptors for those middleware
- */
-export type CoreMiddlewareOverrideDescriptors = Record<CoreMiddlewareType, Middleware | null>;
-/**
- * Type of custom middlewares
- */
-export type CustomMiddlewares<T = Record<string, unknown>> = Partial<CoreMiddlewareOverrideDescriptors> | NewMiddlewareDescriptor<T>;

package/dist/interfaces/data.d.ts

@@ -1,48 +0,0 @@
-import { OperationPostInvokeAny, OperationPreInvoke } from './operation';
-import { DataValue, DataItem } from '@cxbox-ui/schema';
-export type { DataValue, DataItem, MultivalueSingleValue, MultivalueSingleValueOptions, RecordSnapshotState } from '@cxbox-ui/schema';
-/**
- * API's response on Business Component's data.ts request
- */
-export interface BcDataResponse {
-    data: DataItem[];
-    hasNext: boolean;
-}
-/**
- * Edited changes
- */
-export interface PendingDataItem {
-    [fieldName: string]: DataValue;
-}
-/**
- * State of `data.ts` in global store
- */
-export interface DataState {
-    [bcName: string]: DataItem[];
-}
-export interface DepthDataState {
-    [depth: number]: {
-        [bcName: string]: DataItem[];
-    };
-}
-/**
- * Result of saving record, which back-end returns
- */
-export interface DataItemResponse {
-    data: {
-        /**
-         * Saved record
-         */
-        record: DataItem;
-        /**
-         * Actions which have to do after saving
-         */
-        postActions?: OperationPostInvokeAny[];
-        preInvoke?: OperationPreInvoke;
-    };
-}
-/**
- * `x` is name of field, for which the value will be set up.
- * A value of `x` is name of field, from which the value will be gotten.
- */
-export type PickMap = Record<string, string>;

package/dist/interfaces/filters.d.ts

@@ -1,32 +0,0 @@
-import { DataValue } from './data';
-export declare enum FilterType {
-    /**
-     * Transforms into combination of 'greaterOrEqualThan' and 'lessOrEqualThan' (See src/utils/filters.ts)
-     */
-    range = "range",
-    equals = "equals",
-    greaterThan = "greaterThan",
-    lessThan = "lessThan",
-    greaterOrEqualThan = "greaterOrEqualThan",
-    lessOrEqualThan = "lessOrEqualThan",
-    contains = "contains",
-    specified = "specified",
-    specifiedBooleanSql = "specifiedBooleanSql",
-    equalsOneOf = "equalsOneOf",
-    containsOneOf = "containsOneOf"
-}
-export interface BcFilter {
-    type: FilterType;
-    fieldName: string;
-    value: DataValue | DataValue[];
-    viewName?: string;
-    widgetName?: string;
-}
-export interface BcSorter {
-    fieldName: string;
-    direction: 'asc' | 'desc';
-}
-export interface FilterGroup {
-    name: string;
-    filters: string;
-}

package/dist/interfaces/index.d.ts

@@ -1,27 +0,0 @@
-/**
- * Types exports of Cxbox UI.
- *
- * Can be imported as:
- *
- * `import {typeName} from '@cxbox-ui/core/interfaces/moduleName'`
- *
- * @packageDocumentation
- * @module Types
- */
-export type { BcMeta, BcMetaState } from './bc';
-export type { DataValue, DataItem, MultivalueSingleValue, MultivalueSingleValueOptions, RecordSnapshotState, PendingDataItem, DataItemResponse, BcDataResponse, DataState, DepthDataState, PickMap } from './data';
-export type { SystemNotification, CxboxResponse, ObjectMap } from './objectMap';
-export { AppNotificationType } from './objectMap';
-export * from './router';
-export * from './screen';
-export * from './customMiddlewares';
-export * from './session';
-export * from './store';
-export * from './view';
-export * from './widget';
-export * from './operation';
-export * from './rowMeta';
-export * from './filters';
-export * from './customEpics';
-export * from './navigation';
-export * from './tree';

package/dist/interfaces/navigation.d.ts

@@ -1,48 +0,0 @@
-import { ViewNavigationGroup, MenuItem, ViewNavigationCategory, ViewNavigationItem } from '@cxbox-ui/schema';
-export type { ViewNavigationGroup, MenuItem, ViewNavigationCategory, ViewNavigationItem } from '@cxbox-ui/schema';
-/**
- * Returns MenuItem if it is ViewNavigationItem
- *
- * @param item to be identified as view
- * @category Type Guards
- */
-export declare function isViewNavigationItem(item: MenuItem): item is ViewNavigationItem;
-/**
- * @param item
- * @deprecated ViewNavigationCategory will be deleted in 2.0.0
- * @category Type Guards
- */
-export declare function isViewNavigationCategory(item: any): item is ViewNavigationCategory;
-/**
- * Returns MenuItem if it is ViewNavigationGroup
- *
- * @param item to be identified as group
- * @category Type Guards
- */
-export declare function isViewNavigationGroup(item: MenuItem): item is ViewNavigationGroup;
-/**
- * 1 - for static, top level navigation
- * 2 - `SecondLevelMenu` tab widgets
- * 2 - `ThirdLevelMenu` tab widgets
- * 2 - `FourthLevelMenu` tab widgets
- */
-export type NavigationLevel = 1 | 2 | 3 | 4;
-/**
- * Model for displayed tab item
- */
-export interface NavigationTab {
-    /**
-     * View name where navigation tab will redirect the user
-     */
-    viewName: string;
-    /**
-     * Displayed title: either view name or a group name
-     */
-    title?: string;
-    /**
-     * When true, menu item will not be visible
-     *
-     * It's still will be accessible through direct link though
-     */
-    hidden?: boolean;
-}

package/dist/interfaces/objectMap.d.ts

@@ -1,36 +0,0 @@
-/**
- * A dictionary for a values of specified type
- *
- * @deprecated TODO: Remove in 2.0.0 in favor of native `Record` type
- *
- * @template T Value type
- */
-export interface ObjectMap<T> {
-    [key: string]: T | undefined;
-}
-/**
- * Basic type for Cxbox API responses
- *
- * TODO: Move this to a an appropriate module
- */
-export type CxboxResponse = {
-    /**
-     * If any response returs with this field, browser should redirect on this address
-     */
-    redirectUrl?: string;
-    [x: string]: any;
-};
-/**
- * Types of notification messages
- */
-export declare enum AppNotificationType {
-    success = "success",
-    info = "info",
-    warning = "warning",
-    error = "error"
-}
-export interface SystemNotification {
-    id: number;
-    type: AppNotificationType;
-    message: string;
-}