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

package/epics/router/selectScreenFail.d.ts

@@ -0,0 +1,17 @@
+import { Observable } from 'rxjs';
+import { Store } from 'redux';
+import { Epic, AnyAction, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+/**
+ * Throws a error popup when attempting to navigate to a screen which is missing for current session
+ *
+ * @param action$ selectViewFail
+ */
+export declare const selectScreenFail: Epic;
+/**
+ *
+ * @param action
+ * @param store
+ * @category Epics
+ */
+export declare function selectScreenFailImpl(action: ActionsMap['selectScreenFail'], store: Store<CoreStore, AnyAction>): Observable<AnyAction>;

package/epics/router/selectView.d.ts

@@ -0,0 +1,19 @@
+import { Observable } from 'rxjs';
+import { Store } from 'redux';
+import { Epic, AnyAction, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+/**
+ *
+ * TODO: Rename to `selectView` in 2.0.0
+ *
+ * @param action$ `selectView` action
+ * @param store
+ */
+export declare const changeView: Epic;
+/**
+ *
+ * @param action
+ * @param store
+ * @category Epics
+ */
+export declare function selectViewImpl(action: ActionsMap['selectView'], store: Store<CoreStore>): Observable<AnyAction>;

package/epics/router/selectViewFail.d.ts

@@ -0,0 +1,17 @@
+import { Observable } from 'rxjs';
+import { Store } from 'redux';
+import { Epic, AnyAction, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+/**
+ * Throws a error popup when attempting to navigate to the view which is missing for current session
+ *
+ * @param action$ selectViewFail
+ */
+export declare const selectViewFail: Epic;
+/**
+ *
+ * @param action
+ * @param store
+ * @category Epics
+ */
+export declare function selectViewFailImpl(action: ActionsMap['selectViewFail'], store: Store<CoreStore, AnyAction>): Observable<AnyAction>;

package/epics/router/userDrillDown.d.ts

@@ -0,0 +1,29 @@
+import { Observable } from 'rxjs';
+import { Store } from 'redux';
+import { Epic, AnyAction, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+/**
+ *
+ * @param action$
+ * @param store
+ * @category Epics
+ */
+export declare const userDrillDown: Epic;
+/**
+ * Default implementation for `userDrillDown` epic.
+ *
+ * Sends a request to fetch row meta; will write a console error if request fails.
+ * Otherwise a chain of actions will be dispatched:
+ *
+ * - {@link ActionPayloadTypes.bcFetchRowMetaSuccess | bcFetchRowMetaSuccess} for drilldowns not of {@link DrillDownType.inner | DrillDownType.inner} type
+ * - {@link ActionPayloadTypes.userDrillDownSuccess | userDrillDownSuccess}
+ * - {@link ActionPayloadTypes.drillDown | drillDown}
+ *
+ * Drilldown url is taken from {@link WidgetFieldBase.drillDown | WidgetField.drillDown} property in widget meta configuration or from record
+ * directly if record's property specified in {@link WidgetFieldBase.drillDownKey | WidgetField.drillDownKey}
+ *
+ * @param action This epic will fire on {@link ActionPayloadTypes.userDrillDown | userDrillDown} action
+ * @param store Redux store instance
+ * @category Epics
+ */
+export declare function userDrillDownImpl(action: ActionsMap['userDrillDown'], store: Store<CoreStore>): Observable<AnyAction>;

package/epics/router.d.ts

@@ -0,0 +1,11 @@
+export declare const routerEpics: {
+    changeLocation: import("../actions/actions").Epic;
+    loginDone: import("../actions/actions").Epic;
+    changeScreen: import("../actions/actions").Epic;
+    changeView: import("../actions/actions").Epic;
+    drillDown: import("../actions/actions").Epic;
+    userDrillDown: import("../actions/actions").Epic;
+    handleRouter: import("../actions/actions").Epic;
+    selectScreenFail: import("../actions/actions").Epic;
+    selectViewFail: import("../actions/actions").Epic;
+};

package/epics/screen/__tests__/apiError.test.d.ts

@@ -0,0 +1 @@
+export {};

package/epics/screen/__tests__/httpError401.test.d.ts

@@ -0,0 +1 @@
+export {};

package/epics/screen/__tests__/httpError409.test.d.ts

@@ -0,0 +1 @@
+export {};

package/epics/screen/__tests__/httpError418.test.d.ts

@@ -0,0 +1 @@
+export {};

package/epics/screen/__tests__/httpError500.test.d.ts

@@ -0,0 +1 @@
+export {};

package/epics/screen/__tests__/httpErrorDefault.test.d.ts

@@ -0,0 +1 @@
+export {};

package/epics/screen/apiError.d.ts

@@ -0,0 +1,13 @@
+import { Observable } from 'rxjs';
+import { Store } from 'redux';
+import { Epic, AnyAction, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+export declare const knownHttpErrors: number[];
+export declare const apiError: Epic;
+/**
+ *
+ * @param action
+ * @param store
+ * @category Epics
+ */
+export declare function apiErrorImpl(action: ActionsMap['apiError'], store: Store<CoreStore, AnyAction>): Observable<AnyAction>;

package/epics/screen/httpError401.d.ts

@@ -0,0 +1,12 @@
+import { Observable } from 'rxjs';
+import { Store } from 'redux';
+import { Epic, AnyAction, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+export declare const httpError401: Epic;
+/**
+ *
+ * @param action
+ * @param store
+ * @category Epics
+ */
+export declare function httpError401Impl(action: ActionsMap['httpError'], store: Store<CoreStore, AnyAction>): Observable<AnyAction>;

package/epics/screen/httpError409.d.ts

@@ -0,0 +1,12 @@
+import { Observable } from 'rxjs';
+import { Store } from 'redux';
+import { Epic, AnyAction, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+export declare const httpError409: Epic;
+/**
+ *
+ * @param action
+ * @param store
+ * @category Epics
+ */
+export declare function httpError409Impl(action: ActionsMap['httpError'], store: Store<CoreStore, AnyAction>): Observable<AnyAction>;

package/epics/screen/httpError418.d.ts

@@ -0,0 +1,12 @@
+import { Observable } from 'rxjs';
+import { Store } from 'redux';
+import { Epic, AnyAction, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+export declare const httpError418: Epic;
+/**
+ *
+ * @param action
+ * @param store
+ * @category Epics
+ */
+export declare function httpError418Impl(action: ActionsMap['httpError'], store: Store<CoreStore, AnyAction>): Observable<AnyAction>;

package/epics/screen/httpError500.d.ts

@@ -0,0 +1,12 @@
+import { Observable } from 'rxjs';
+import { Store } from 'redux';
+import { Epic, AnyAction, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+export declare const httpError500: Epic;
+/**
+ *
+ * @param action
+ * @param store
+ * @category Epics
+ */
+export declare function httpError500Impl(action: ActionsMap['httpError'], store: Store<CoreStore, AnyAction>): Observable<AnyAction>;

package/epics/screen/httpErrorDefault.d.ts

@@ -0,0 +1,14 @@
+import { Observable } from 'rxjs';
+import { Store } from 'redux';
+import { Epic, AnyAction, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+export declare const httpErrorDefault: Epic;
+/**
+ *
+ * @param action
+ * @param store
+ * @category Epics
+ */
+export declare function httpErrorDefaultImpl(action: ActionsMap['httpError'], store: Store<CoreStore, AnyAction>): Observable<import("../..").Action<"showViewError", {
+    error: import("../../interfaces/view").ApplicationError;
+}>>;

package/epics/screen/processPostInvoke.d.ts

@@ -0,0 +1,12 @@
+import { Observable } from 'rxjs';
+import { Store } from 'redux';
+import { Epic, AnyAction, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+export declare const processPostInvoke: Epic;
+/**
+ *
+ * @param action
+ * @param store
+ * @category Epics
+ */
+export declare function processPostInvokeImpl(action: ActionsMap['processPostInvoke'], store: Store<CoreStore, AnyAction>): Observable<AnyAction>;

package/epics/screen.d.ts

@@ -0,0 +1,35 @@
+import { Epic } from '../actions/actions';
+/**
+ *
+ * @param action$
+ * @param store
+ * @category Epics
+ */
+export declare const downloadFile: Epic;
+/**
+ *
+ * @param action$
+ * @param store
+ * @category Epics
+ */
+export declare const downloadFileByUrl: Epic;
+/**
+ *
+ * @param action$
+ * @param store
+ * @category Epics
+ */
+export declare const processPostInvokeConfirm: Epic;
+export declare const screenEpics: {
+    processPostInvoke: Epic;
+    downloadFile: Epic;
+    downloadFileByUrl: Epic;
+    processPostInvokeConfirm: Epic;
+    apiError: Epic;
+    httpError401: Epic;
+    httpError409: Epic;
+    httpError418: Epic;
+    httpError500: Epic;
+    httpErrorDefault: Epic;
+};
+export default screenEpics;

package/epics/session/__tests__/loginByAnotherRoleEpic.test.d.ts

@@ -0,0 +1 @@
+export {};

package/epics/session/__tests__/loginDone.test.d.ts

@@ -0,0 +1 @@
+export {};

package/epics/session/__tests__/refreshMeta.test.d.ts

@@ -0,0 +1 @@
+export {};

package/epics/session/__tests__/refreshMetaAndReloadPage.test.d.ts

@@ -0,0 +1 @@
+export {};

package/epics/session/__tests__/switchRole.test.d.ts

@@ -0,0 +1 @@
+export {};

package/epics/session/loginByAnotherRole.d.ts

@@ -0,0 +1,27 @@
+import { ActionsMap, AnyAction, Epic } from '../../actions/actions';
+import { Store } from 'redux';
+import { Store as CoreStore } from '../../interfaces/store';
+import { LoginResponse } from '../../interfaces/session';
+import { Observable } from 'rxjs';
+/**
+ * Performed on role switching
+ *
+ * @param action$ This epic will fire on {@link ActionPayloadTypes.login | login} action
+ * @param store Redux store instance
+ * @category Epics
+ */
+export declare const loginByAnotherRoleEpic: Epic;
+/**
+ * Default implementation of `loginByAnotherRoleEpic` epic
+ *
+ * Performs login request with `role` parameter
+ *
+ * If `role` changed, epic changes location to default view
+ *
+ * @param action action {@link ActionPayloadTypes.login | login}
+ * @param store Store instance
+ * @category Epics
+ */
+export declare function loginByAnotherRoleEpicImpl(action: ActionsMap['login'], store: Store<CoreStore, AnyAction>): Observable<import("../..").Action<"loginDone", LoginResponse> | import("../..").Action<"loginFail", {
+    errorMsg: string;
+}>>;

package/epics/session/loginDone.d.ts

@@ -0,0 +1,10 @@
+import { Epic } from '../../actions/actions';
+/**
+ * Fires on successful login; there is no default implementation related to this epic,
+ * but it can be used to customize successful login behaivior.
+ *
+ * @param action$ This epic will fire on {@link ActionPayloadTypes.login | login} action
+ * @param store Redux store instance
+ * @category Epics
+ */
+export declare const loginEpic: Epic;

package/epics/session/refreshMeta.d.ts

@@ -0,0 +1,9 @@
+import { Epic } from '../../actions/actions';
+/**
+ * Performed on refresh meta data process.
+ *
+ * @param action$ This epic will fire on {@link ActionPayloadTypes.refreshMeta | refreshMeta} action
+ * @param store Redux store instance
+ * @category Epics
+ */
+export declare const refreshMetaEpic: Epic;

package/epics/session/refreshMetaAndReloadPage.d.ts

@@ -0,0 +1,2 @@
+import { Epic } from '../../actions/actions';
+export declare const refreshMetaAndReloadPage: Epic;

package/epics/session/switchRole.d.ts

@@ -0,0 +1,9 @@
+import { Epic } from '../../actions/actions';
+/**
+ * Activates process of role switching
+ *
+ * @param action$ This epic will fire on {@link ActionPayloadTypes.switchRole | switchRole} action
+ * @param store Redux store instance
+ * @category Epics
+ */
+export declare const switchRoleEpic: Epic;

package/epics/session.d.ts

@@ -0,0 +1,7 @@
+export declare const sessionEpics: {
+    loginByAnotherRoleEpic: import("../actions/actions").Epic;
+    refreshMetaEpic: import("../actions/actions").Epic;
+    refreshMetaAndReloadPage: import("../actions/actions").Epic;
+    switchRoleEpic: import("../actions/actions").Epic;
+    loginEpic: import("../actions/actions").Epic;
+};

package/epics/utils.d.ts

@@ -0,0 +1,4 @@
+import { Epic } from '../actions/actions';
+export declare const utilsEpics: {
+    exportStateEpic: Epic;
+};

package/epics/view/__tests__/fileUploadConfirm.test.d.ts

@@ -0,0 +1 @@
+export {};

package/epics/view/__tests__/sendOperation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/epics/view/__tests__/sendOperationAssociate.test.d.ts

@@ -0,0 +1 @@
+export {};

package/epics/view/__tests__/showAssocPopup.test.d.ts

@@ -0,0 +1 @@
+export {};

package/epics/view/__tests__/showFileUploadPopup.test.d.ts

@@ -0,0 +1 @@
+export {};

package/epics/view/fileUploadConfirm.d.ts

@@ -0,0 +1,31 @@
+import { Observable } from 'rxjs';
+import { Store } from 'redux';
+import { Epic, AnyAction, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+/**
+ * It sends customAction request for `file-upload-save` endpoint with `bulkIds` data
+ * 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.
+ *
+ * @param action removeMultivalueTag
+ * @param store Store instance
+ */
+export declare const fileUploadConfirm: Epic;
+/**
+ * Default implementation for `fileUploadConfirm` epic
+ *
+ * It sends customAction request for `file-upload-save` endpoint with `bulkIds` data
+ * 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.
+ *
+ * @param action removeMultivalueTag
+ * @param store Store instance
+ * @category Epics
+ */
+export declare function fileUploadConfirmImpl(action: ActionsMap['bulkUploadFiles'], store: Store<CoreStore, AnyAction>): Observable<AnyAction>;

package/epics/view/sendOperation.d.ts

@@ -0,0 +1,24 @@
+import { Observable } from 'rxjs';
+import { Store } from 'redux';
+import { Epic, AnyAction, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+/**
+ * Handle any `sendOperation` 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
+ *
+ * @param action$ Payload includes operation type and widget that initiated operation
+ * @param store
+ */
+export declare const sendOperation: Epic;
+/**
+ * Default implementation of `sendOperation` handler
+ *
+ * @param action
+ * @param store
+ * @category Epics
+ */
+export declare function sendOperationEpicImpl(action: ActionsMap['sendOperation'], store: Store<CoreStore, AnyAction>): Observable<AnyAction>;

package/epics/view/sendOperationAssociate.d.ts

@@ -0,0 +1,34 @@
+import { Store } from 'redux';
+import { Epic, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+/**
+ * Opens a popup with {@link AssocListPopup | associate component}.
+ *
+ * @param action$ This epic will fire on {@link ActionPayloadTypes.sendOperation | sendOperation} action where
+ * sendOperation role is matching {@link OperationTypeCrud.associate}
+ * @param store Redux store instance
+ * @returns {@link ActionPayloadTypes.showViewPopup | showViewPopup} for `${bcName}Assoc`
+ * @category Epics
+ */
+export declare const sendOperationAssociate: Epic;
+/**
+ * Default implementation for `sendOperationAssociate` epic.
+ *
+ * Opens a popup with {@link AssocListPopup | associate component}.
+ *
+ * @param action This epic will fire on {@link ActionPayloadTypes.sendOperation | userDrillDown} action
+ * @param store Redux store instance
+ * @returns {@link ActionPayloadTypes.showViewPopup | showViewPopup} for `${bcName}Assoc`
+ * @category Epics
+ */
+export declare function sendOperationAssociateImpl(action: ActionsMap['sendOperation'], store: Store<CoreStore>): import("../..").Action<"showViewPopup", {
+    bcName: string;
+    widgetName?: string;
+    calleeBCName?: string;
+    calleeWidgetName?: string;
+    associateFieldKey?: string;
+    assocValueKey?: string;
+    active?: boolean;
+    isFilter?: boolean;
+    type?: import("../../interfaces/view").PopupType;
+}>;

package/epics/view/showAssocPopup.d.ts

@@ -0,0 +1,12 @@
+import { Observable } from 'rxjs';
+import { Store } from 'redux';
+import { Epic, AnyAction, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+export declare const showAssocPopup: Epic;
+/**
+ *
+ * @param action
+ * @param store
+ * @category Epics
+ */
+export declare function showAssocPopupEpicImpl(action: ActionsMap['showViewPopup'], store: Store<CoreStore, AnyAction>): Observable<AnyAction>;

package/epics/view/showFileUploadPopup.d.ts

@@ -0,0 +1,19 @@
+import { Epic, ActionsMap, AnyAction } from '../../actions/actions';
+import { Observable } from 'rxjs';
+/**
+ * Fires `bcChangeCursors` and `showFileUploadPopup` to drop the cursors and show file upload popup.
+ *
+ * @param action sendOperation
+ * @param store Store instance
+ */
+export declare const showFileUploadPopup: Epic;
+/**
+ * Default implementation for `showFileUploadPopupImpl` epic
+ *
+ * Fires `bcChangeCursors` and `showFileUploadPopup` to drop the cursors and show file upload popup.
+ *
+ * @param action sendOperation
+ * @param store Store instance
+ * @category Epics
+ */
+export declare function showFileUploadPopupImpl(action: ActionsMap['sendOperation']): Observable<AnyAction>;

package/epics/view.d.ts

@@ -0,0 +1,57 @@
+import { Epic, AnyAction } from '../actions/actions';
+import { Observable } from 'rxjs/Observable';
+import { OperationPostInvokeAny, OperationPreInvoke } from '../interfaces/operation';
+/**
+ * Sends row meta request when `forceActive` field fires `onChange`
+ *
+ * @param action$
+ * @param store
+ * @category Epics
+ */
+export declare const getRowMetaByForceActive: Epic;
+/**
+ * Clears descendant business components pending changes on cursor change
+ *
+ * TODO: Review required as it might be no longer valid due to autosave middleware implementation
+ *
+ * @param action$
+ * @param store
+ * @category Epics
+ */
+export declare const clearPendingDataChangesAfterCursorChange: Epic;
+/**
+ *
+ * @param action$
+ * @param store
+ * @category Epics
+ */
+export declare const selectTableCellInit: Epic;
+/**
+ *
+ * @param action$
+ * @param store
+ * @category Epics
+ */
+export declare const showAllTableRecordsInit: Epic;
+/**
+ * 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): Observable<AnyAction>[];
+export declare const viewEpics: {
+    sendOperation: Epic;
+    getRowMetaByForceActive: Epic;
+    sendOperationAssociate: Epic;
+    clearPendingDataChangesAfterCursorChange: Epic;
+    selectTableCellInit: Epic;
+    showAllTableRecordsInit: Epic;
+    showAssocPopup: Epic;
+    showFileUploadPopup: Epic;
+    fileUploadConfirm: Epic;
+};

package/hooks/__tests__/useRowMenu.test.d.ts

@@ -0,0 +1 @@
+export {};

package/hooks/__tests__/useViewTabs.test.d.ts

@@ -0,0 +1 @@
+export {};

package/hooks/__tests__/useWidgetOperations.test.d.ts

@@ -0,0 +1 @@
+export {};

package/hooks/index.d.ts

@@ -0,0 +1,7 @@
+export { useFlatFormFields } from './useFlatFormFields';
+export { useDebounce } from './useDebounce';
+export { useAssocRecords } from './useAssocRecords';
+export { useWidgetOperations, getIncludedOperations } from './useWidgetOperations';
+export { useViewTabs } from './useViewTabs';
+export { useDrillDownUrl } from './useDrillDownUrl';
+export { useRowMenu } from './useRowMenu';

package/hooks/useAssocRecords.d.ts

@@ -0,0 +1,11 @@
+import { AssociatedItem } from '../interfaces/operation';
+import { PendingDataItem } from '../interfaces/data';
+/**
+ * TODO
+ *
+ * @param data
+ * @param pendingChanges
+ * @param isRadio
+ * @category Hooks
+ */
+export declare function useAssocRecords<T extends AssociatedItem>(data: T[], pendingChanges: Record<string, PendingDataItem>, isRadio?: boolean): T[];

package/hooks/useDebounce.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Allows to ignore frequently changing values by returning only the last one received until specified delay.
+ *
+ * @param value Frequently changing value
+ * @param delay Delay until the next change
+ * @category Hooks
+ */
+export declare function useDebounce<T>(value: T, delay: number): T;

package/hooks/useDrillDownUrl.d.ts

@@ -0,0 +1,10 @@
+import { WidgetFieldBase } from '../interfaces/widget';
+/**
+ * @param bcName - bcName passed to field
+ * @param cursor - field ID
+ * @param fieldMeta - widget field meta
+ * @description Allows to override drilldown url from field data by drillDownKey. Checking order allows to disable
+ * drilldown link, for example if object is removed.
+ * @category Hooks
+ */
+export declare function useDrillDownUrl(bcName: string, fieldMeta: WidgetFieldBase, cursor: string): string | null;

package/hooks/useFlatFormFields.d.ts

@@ -0,0 +1,9 @@
+import { WidgetFieldsOrBlocks } from '../interfaces/widget';
+/**
+ * Receive flat list of fields from array containing fields or field blocks.
+ *
+ * @template T Field type
+ * @param fields Array of fields or field blocks
+ * @category Hooks
+ */
+export declare function useFlatFormFields<T>(fields: WidgetFieldsOrBlocks<T>): T[];