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

package/epics/data/__tests__/bcCancelCreateDataEpic.test.d.ts

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

package/epics/data/__tests__/bcFetchData.test.d.ts

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

package/epics/data/__tests__/bcFetchRowMetaRequest.test.d.ts

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

package/epics/data/__tests__/bcNewDataEpic.test.d.ts

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

package/epics/data/__tests__/bcSaveData.test.d.ts

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

package/epics/data/__tests__/bcSelectDepthRecord.test.d.ts

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

package/epics/data/__tests__/removeMultivalueTag.test.d.ts

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

package/epics/data/__tests__/saveAssociationsActive.test.d.ts

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

package/epics/data/__tests__/selectView.test.d.ts

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

package/epics/data/bcCancelCreateDataEpic.d.ts

@@ -0,0 +1,28 @@
+import { Observable } from 'rxjs';
+import { Store } from 'redux';
+import { Epic, AnyAction, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+/**
+ * Sends `cancel-create` custom operation with record's pending changes and vstamp;
+ * Dispatches `sendOperationSuccess` and `bcChangeCursors` to drop cursors, also
+ * `processPostInvoke` if received `postActions` in response.
+ *
+ * @param action sendOperation with `cancel-create` role
+ * @param store Store instance
+ * @category Epics
+ */
+export declare const bcCancelCreateDataEpic: Epic;
+/**
+ * Default implementation for `bcCancelCreateDataEpic` epic
+ *
+ * Sends `cancel-create` custom operation with record's pending changes and vstamp;
+ * Dispatches `sendOperationSuccess` and `bcChangeCursors` to drop cursors, also
+ * `processPostInvoke` if received `postActions` in response.
+ *
+ * On error dispatches `bcDeleteDataFail`.
+ *
+ * @param action sendOperation with `cancel-create` role
+ * @param store Store instance
+ * @category Epics
+ */
+export declare function bcCancelCreateDataEpicImpl(action: ActionsMap['sendOperation'], store: Store<CoreStore, AnyAction>): Observable<AnyAction>;

package/epics/data/bcFetchData.d.ts

@@ -0,0 +1,21 @@
+import { Observable } from 'rxjs';
+import { Store, AnyAction } from 'redux';
+import { Epic, types, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+import { ActionsObservable } from 'redux-observable';
+/**
+ *
+ *
+ * Loads BC's data.
+ * In case successful download:
+ * - dispatches action to store
+ * - initializes rowMeta load
+ * - initializes child BCs data load
+ *
+ * @param action.payload.bcName BC's name for data load
+ * @category Epics
+ */
+export declare const bcFetchDataEpic: Epic;
+declare type ActionType = ActionsMap[typeof types.bcFetchDataRequest | typeof types.bcFetchDataPages | typeof types.showViewPopup | typeof types.bcForceUpdate | typeof types.bcChangePage];
+export declare function bcFetchDataImpl(action: ActionType, store: Store<CoreStore, AnyAction>, actionObservable: ActionsObservable<AnyAction>): Array<Observable<AnyAction>>;
+export {};

package/epics/data/bcFetchRowMetaRequest.d.ts

@@ -0,0 +1,50 @@
+import { Observable } from 'rxjs';
+import { Store, AnyAction } from 'redux';
+import { Epic, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+import { ActionsObservable } from 'redux-observable';
+/**
+ * Access `row-meta` API endpoint for business component; response will contain information
+ * about operations available for row and additional information about row fields.
+ *
+ * On success, {@link ActionPayloadTypes.bcFetchRowMetaSuccess | bcFetchRowMetaSuccess} action dispatched
+ * to store received row meta.
+ * On failure, console.error called and {@link ActionPayloadTypes.bcFetchRowMetaFail | bcFetchRowMetaFail} action
+ * dispatched to drop fetching state.
+ *
+ * If any action from `cancelRequestActionTypes` array dispatched while this epic is in progress,
+ * this epic will be cancelled and {@link ActionPayloadTypes.bcFetchRowMetaFail | bcFetchRowMetaFail} action
+ * will be dispatched.
+ *
+ * @param action {@link ActionPayloadTypes.bcFetchRowMeta | bcFetchRowMeta}
+ * @param store Store instance
+ * @category Epics
+ */
+export declare const bcFetchRowMetaRequest: Epic;
+/**
+ * Default implementation for `bcFetchRowMetaRequest` epic
+ *
+ * Access `row-meta` API endpoint for business component; response will contain information
+ * about operations available for row and additional information about row fields.
+ *
+ * On success, {@link ActionPayloadTypes.bcFetchRowMetaSuccess | bcFetchRowMetaSuccess} action dispatched
+ * to store received row meta.
+ * On failure, console.error called and {@link ActionPayloadTypes.bcFetchRowMetaFail | bcFetchRowMetaFail} action
+ * dispatched to drop fetching state.
+ *
+ * If any action from `cancelRequestActionTypes` array dispatched while this epic is in progress,
+ * this epic will be cancelled and {@link ActionPayloadTypes.bcFetchRowMetaFail | bcFetchRowMetaFail} action
+ * will be dispatched.
+ *
+ * @param action {@link ActionPayloadTypes.bcFetchRowMeta | bcFetchRowMeta}
+ * @param store Store instance
+ * @param actionObservable Root epic to cancel
+ * @category Epics
+ */
+export declare function bcFetchRowMetaRequestImpl(action: ActionsMap['bcFetchRowMeta'], store: Store<CoreStore, AnyAction>, actionObservable: ActionsObservable<AnyAction>): Observable<AnyAction>;
+/**
+ * Compatibility for testing cancellable epics
+ *
+ * TODO: Move in `bcFetchRowMetaRequestImpl` in 2.0.0
+ */
+export declare function bcFetchRowMetaRequestCompatibility(action: ActionsMap['bcFetchRowMeta'], store: Store<CoreStore, AnyAction>, actionObservable: ActionsObservable<AnyAction>): Array<Observable<AnyAction>>;

package/epics/data/bcNewDataEpic.d.ts

@@ -0,0 +1,37 @@
+import { Observable } from 'rxjs';
+import { Store } from 'redux';
+import { Epic, AnyAction, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+/**
+ * Access `row-meta-new` API endpoint for business component endpoint; response will contain
+ * row meta where `currentValue` of `id` field will contain an id for newly created record.
+ *
+ * `bcNewDataSuccess` action dispatched with new data item draft (vstamp = -1).
+ * `bcFetchRowMetaSuccess` action dispatched to set BC cursor to this new id.
+ * `changeDataItem` action dispatched to add this new item to pending changes.
+ * `processPostInvoke` dispatched to handle possible post invokes.
+ *
+ * In case of an error message is logged as warning and `bcNewDataFail` action dispatched.
+ *
+ * @param action$ `sendOperation` with `create` role
+ * @param store Store instance
+ */
+export declare const bcNewDataEpic: Epic;
+/**
+ * Default implementation for `bcNewDataEpic` epic
+ *
+ * Access `row-meta-new` API endpoint for business component endpoint; response will contain
+ * row meta where `currentValue` of `id` field will contain an id for newly created record.
+ *
+ * `bcNewDataSuccess` action dispatched with new data item draft (vstamp = -1).
+ * `bcFetchRowMetaSuccess` action dispatched to set BC cursor to this new id.
+ * `changeDataItem` action dispatched to add this new item to pending changes.
+ * `processPostInvoke` dispatched to handle possible post invokes.
+ *
+ * In case of an error message is logged as warning and `bcNewDataFail` action dispatched.
+ *
+ * @param action `sendOperation` with `create` role
+ * @param store Store instance
+ * @category Epics
+ */
+export declare function bcNewDataEpicImpl(action: ActionsMap['sendOperation'], store: Store<CoreStore, AnyAction>): Observable<AnyAction>;

package/epics/data/bcSaveData.d.ts

@@ -0,0 +1,58 @@
+import { ActionsMap, AnyAction, Epic } from '../../actions/actions';
+import { Store } from 'redux';
+import { Store as CoreStore } from '../../interfaces/store';
+import { Observable } from 'rxjs';
+/**
+ * Post record's pending changes to `save data` API endpoint.
+ * Pending changes for fields disabled through row meta are not send; pleace notice that fields are
+ * disabled by default.
+ *
+ * On success following actions are dispatched:
+ * - {@link ActionPayloadTypes.bcSaveDataSuccess | bcSaveDataSuccess}
+ * - {@link ActionPayloadTypes.bcFetchRowMeta | bcFetchRowMeta}
+ * - one {@link ActionPayloadTypes.bcFetchDataRequest | bcFetchDataRequest } for each children of saved
+ * business component
+ * - optional {@link ActionPayloadTypes.processPostInvoke | processPostInvoke } if present in response
+ * - optional `onSuccessAction` callback if provided in payload.
+ *
+ * On failure, console.error called and {@link ActionPayloadTypes.bcSaveDataFail | bcSaveDataFail} action
+ * dispatched.
+ *
+ * If there was a `onSuccessAction` callback provided in action payload (and widget option
+ * {@link WidgetOptions.disableNotification | disableNotification } was not set)
+ * then a notification will be shown on failure with suggestion to cancel pending changes and a button that fires
+ * {@link ActionPayloadTypes.bcCancelPendingChanges | bcCancelPendingChanges}
+ *
+ * @param action {@link ActionPayloadTypes.sendOperation | sendOperation} with `save` role
+ * @param store Store instance
+ * @category Epics
+ */
+export declare const bcSaveDataEpic: Epic;
+/**
+ * Default implementation for `bcSaveData` epic
+ *
+ * Post record's pending changes to `save data` API endpoint.
+ * Pending changes for fields disabled through row meta are not send; pleace notice that fields are
+ * disabled by default.
+ *
+ * On success following actions are dispatched:
+ * - {@link ActionPayloadTypes.bcSaveDataSuccess | bcSaveDataSuccess}
+ * - {@link ActionPayloadTypes.bcFetchRowMeta | bcFetchRowMeta}
+ * - one {@link ActionPayloadTypes.bcFetchDataRequest | bcFetchDataRequest } for each children of saved
+ * business component
+ * - optional {@link ActionPayloadTypes.processPostInvoke | processPostInvoke } if present in response
+ * - optional `onSuccessAction` callback if provided in payload.
+ *
+ * On failure, console.error called and {@link ActionPayloadTypes.bcSaveDataFail | bcSaveDataFail} action
+ * dispatched.
+ *
+ * If there was a `onSuccessAction` callback provided in action payload (and widget option
+ * {@link WidgetOptions.disableNotification | disableNotification } was not set)
+ * then a notification will be shown on failure with suggestion to cancel pending changes and a button that fires
+ * {@link ActionPayloadTypes.bcCancelPendingChanges | bcCancelPendingChanges}
+ *
+ * @param action {@link ActionPayloadTypes.sendOperation | sendOperation} with `save` role
+ * @param store Store instance
+ * @category Epics
+ */
+export declare function bcSaveDataImpl(action: ActionsMap['sendOperation'], store: Store<CoreStore, AnyAction>): Observable<AnyAction>;

package/epics/data/bcSelectDepthRecord.d.ts

@@ -0,0 +1,21 @@
+import { Observable } from 'rxjs';
+import { Epic, AnyAction, ActionsMap } from '../../actions/actions';
+export declare const bcSelectDepthRecord: Epic;
+/**
+ * Set a cursor when expanding a record in hierarchy widgets builded around single business components
+ * and fetch the data for children of expanded record.
+ *
+ * {@link ActionPayloadTypes.bcChangeDepthCursor | bcChangeDepthCursor} action is dispatched to set the cursor
+ * for expanded record; only one expanded record is allowed per hierarchy depth level.
+ *
+ * {@link ActionPayloadTypes.bcFetchDataRequest | bcFetchDataRequest} action is dispatched to fetch children data
+ * for expanded record. `ignorePageLimit`` is set as there are no controls for navigating between data pages
+ * in nested levels of hierarchy so instead all records are fetched.
+ *
+ * TODO: There is no apparent reason why `widgetName` is empty; probably will be mandatory and replace `bcName` in 2.0.0.
+ *
+ * @param action This epic will fire on {@link ActionPayloadTypes.bcSelectDepthRecord | bcSelectDepthRecord} action
+ * @deprecated Do not use; TODO: Will be removed in 2.0.0
+ * @category Epics
+ */
+export declare function bcSelectDepthRecordImpl(action: ActionsMap['bcSelectDepthRecord']): Observable<AnyAction>;

package/epics/data/removeMultivalueTag.d.ts

@@ -0,0 +1,45 @@
+import { Observable } from 'rxjs';
+import { Store } from 'redux';
+import { Epic, AnyAction, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+/**
+ * For full hierarchies it fires `changeDataItem` action to remove value from source record
+ *
+ * With `hierarchyGroupDeselection` widget option, parent removal also remove children; removing
+ * last child will also remove the parent.
+ *
+ * With `hierarchyTraverse` widget option, descendants are used instead of children.
+ *
+ * When parent should be removed with both option, `removeMultivalueTag` with updated `removedItem` will
+ * fire instead of `changeDataItem`.
+ *
+ * For non-full hierarchies two `changeDataItem` actions will fire, first to drop `_associate` flag
+ * of remove item and second to update value of source record.
+ * Widget options are not tested for non-full hierarchies.
+ *
+ * @param action removeMultivalueTag
+ * @param store Store instance
+ */
+export declare const removeMultivalueTag: Epic;
+/**
+ * Default implementation for `removeMultivalueTag` epic
+ *
+ * For full hierarchies it fires `changeDataItem` action to remove value from source record
+ *
+ * With `hierarchyGroupDeselection` widget option, parent removal also remove children; removing
+ * last child will also remove the parent.
+ *
+ * With `hierarchyTraverse` widget option, descendants are used instead of children.
+ *
+ * When parent should be removed with both option, `removeMultivalueTag` with updated `removedItem` will
+ * fire instead of `changeDataItem`.
+ *
+ * For non-full hierarchies two `changeDataItem` actions will fire, first to drop `_associate` flag
+ * of remove item and second to update value of soure record.
+ * Widget options are not tested for non-full hierarchies.
+ *
+ * @param action removeMultivalueTag
+ * @param store Store instance
+ * @category Epics
+ */
+export declare function removeMultivalueTagImpl(action: ActionsMap['removeMultivalueTag'], store: Store<CoreStore, AnyAction>): Observable<AnyAction>;

package/{dist/epics/data/saveAssociationsActiveEpic.d.ts → epics/data/saveAssociationsActive.d.ts}

@@ -1,7 +1,7 @@
-import { CXBoxEpic } from '../../interfaces';
+import { Epic } from '../../actions/actions';
 /**
  * Works with assoc-lists, which does call back-end's assoc methods by click on confirm button in modal window
  *
  * @category Epics
  */
-export declare const saveAssociationsActiveEpic: CXBoxEpic;
+export declare const saveAssociationsActive: Epic;

package/epics/data/selectView.d.ts

@@ -0,0 +1,36 @@
+import { ActionsMap, AnyAction, Epic } from '../../actions/actions';
+import { Store } from 'redux';
+import { Store as CoreStore } from '../../interfaces/store';
+/**
+ * Schedules data fetch for every widget on the view
+ *
+ * After selecting a view, this epic schedules a data fetch for every widget present on the view.
+ * If business componenet for the widget has a parent, then root ancestor BC is scheduled for data fetch instead
+ * and data for its descendants will be scheduled after ancestor data fetch resolved.
+ *
+ * @see {@link src/epics/data/bcFetchDataEpic.ts} for details how descendants resolved
+ * @param action `selectView` action
+ * @param store Store instance
+ */
+export declare const selectView: Epic;
+/**
+ * Default implementation for `selectView` epic.
+ *
+ * Schedules data fetch for every widget on the view
+ *
+ * After selecting a view, this epic schedules a data fetch for every widget present on the view.
+ * If business componenet for the widget has a parent, then root ancestor BC is scheduled for data fetch instead
+ * and data for its descendants will be scheduled after ancestor data fetch resolved.
+ *
+ * @see {@link src/epics/data/bcFetchDataEpic.ts} for details how descendants resolved
+ * @param action `selectView` action
+ * @param store Store instance
+ * @category Epics
+ */
+export declare function selectViewImpl(action: ActionsMap['selectView'], store: Store<CoreStore, AnyAction>): import("../..").Action<"bcFetchDataRequest", {
+    bcName?: string;
+    depth?: number;
+    widgetName: string;
+    ignorePageLimit?: boolean;
+    keepDelta?: boolean;
+}>[];

package/epics/data.d.ts

@@ -0,0 +1,105 @@
+/**
+ * For epics which work with records
+ */
+import { Epic } from '../actions/actions';
+/**
+ *
+ * @param action$
+ * @param store
+ * @category Epics
+ */
+export declare const bcLoadMore: Epic;
+/**
+ *
+ * @param action$
+ * @param store
+ * @category Epics
+ */
+export declare const bcSelectRecord: Epic;
+/**
+ *
+ * @param action$
+ * @param store
+ * @category Epics
+ */
+export declare const inlinePickListFetchDataEpic: Epic;
+/**
+ *
+ * @param action$
+ * @param store
+ * @category Epics
+ */
+export declare const bcDeleteDataEpic: Epic;
+/**
+ * Works with assoc-lists, which doesn't call back-end's assoc methods
+ *
+ * @category Epics
+ */
+export declare const saveAssociationsPassive: Epic;
+/**
+ *
+ * @param action$
+ * @param store
+ * @category Epics
+ */
+export declare const changeChildrenAssociations: Epic;
+/**
+ *
+ * @param action$
+ * @param store
+ * @category Epics
+ */
+export declare const changeChildrenAssociationsSameBc: Epic;
+/**
+ * Change full hierarchy descendants association state.
+ *
+ * @param action$
+ * @param store
+ * @category Epics
+ */
+export declare const changeDescendantsAssociationsFull: Epic;
+/**
+ *
+ * @param action$
+ * @param store
+ * @category Epics
+ */
+export declare const changeAssociation: Epic;
+/**
+ *
+ * @param action$
+ * @param store
+ * @category Epics
+ */
+export declare const changeAssociationSameBc: Epic;
+/**
+ * Change full hierarchy record association state. Also select/deselect dependent records according to widget options.
+ *
+ * @param action$
+ * @param store
+ * @category Epics
+ */
+export declare const changeAssociationFull: Epic;
+export declare const dataEpics: {
+    bcFetchRowMetaRequest: Epic;
+    bcFetchDataEpic: Epic;
+    bcSelectRecord: Epic;
+    bcSelectDepthRecord: Epic;
+    inlinePickListFetchDataEpic: Epic;
+    selectView: Epic;
+    bcNewDataEpic: Epic;
+    bcDeleteDataEpic: Epic;
+    bcSaveDataEpic: Epic;
+    bcCancelCreateDataEpic: Epic;
+    saveAssociationsActive: Epic;
+    saveAssociationsPassive: Epic;
+    changeAssociation: Epic;
+    changeAssociationSameBc: Epic;
+    changeChildrenAssociations: Epic;
+    changeChildrenAssociationsSameBc: Epic;
+    changeAssociationFull: Epic;
+    changeDescendantsAssociationsFull: Epic;
+    bcLoadMore: Epic;
+    removeMultivalueTag: Epic;
+};
+export default dataEpics;

package/epics/index.d.ts

@@ -0,0 +1,74 @@
+import { Epic } from 'redux-observable';
+export declare const coreEpics: {
+    utilsEpics: {
+        exportStateEpic: import("../actions/actions").Epic;
+    };
+    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;
+    };
+    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;
+    };
+    screenEpics: {
+        processPostInvoke: import("../actions/actions").Epic;
+        downloadFile: import("../actions/actions").Epic;
+        downloadFileByUrl: import("../actions/actions").Epic;
+        processPostInvokeConfirm: import("../actions/actions").Epic;
+        apiError: import("../actions/actions").Epic;
+        httpError401: import("../actions/actions").Epic;
+        httpError409: import("../actions/actions").Epic;
+        httpError418: import("../actions/actions").Epic;
+        httpError500: import("../actions/actions").Epic;
+        httpErrorDefault: import("../actions/actions").Epic;
+    };
+    viewEpics: {
+        sendOperation: import("../actions/actions").Epic;
+        getRowMetaByForceActive: import("../actions/actions").Epic;
+        sendOperationAssociate: import("../actions/actions").Epic;
+        clearPendingDataChangesAfterCursorChange: import("../actions/actions").Epic;
+        selectTableCellInit: import("../actions/actions").Epic;
+        showAllTableRecordsInit: import("../actions/actions").Epic;
+        showAssocPopup: import("../actions/actions").Epic;
+        showFileUploadPopup: import("../actions/actions").Epic;
+        fileUploadConfirm: import("../actions/actions").Epic;
+    };
+    dataEpics: {
+        bcFetchRowMetaRequest: import("../actions/actions").Epic;
+        bcFetchDataEpic: import("../actions/actions").Epic;
+        bcSelectRecord: import("../actions/actions").Epic;
+        bcSelectDepthRecord: import("../actions/actions").Epic;
+        inlinePickListFetchDataEpic: import("../actions/actions").Epic;
+        selectView: import("../actions/actions").Epic;
+        bcNewDataEpic: import("../actions/actions").Epic;
+        bcDeleteDataEpic: import("../actions/actions").Epic;
+        bcSaveDataEpic: import("../actions/actions").Epic;
+        bcCancelCreateDataEpic: import("../actions/actions").Epic;
+        saveAssociationsActive: import("../actions/actions").Epic;
+        saveAssociationsPassive: import("../actions/actions").Epic;
+        changeAssociation: import("../actions/actions").Epic;
+        changeAssociationSameBc: import("../actions/actions").Epic;
+        changeChildrenAssociations: import("../actions/actions").Epic;
+        changeChildrenAssociationsSameBc: import("../actions/actions").Epic;
+        changeAssociationFull: import("../actions/actions").Epic;
+        changeDescendantsAssociationsFull: import("../actions/actions").Epic;
+        bcLoadMore: import("../actions/actions").Epic;
+        removeMultivalueTag: import("../actions/actions").Epic;
+    };
+};
+/**
+ * @deprecated TODO: For backward compatibility; remove in 2.0.0
+ */
+export declare const legacyCoreEpics: Epic<any, any>;
+export default coreEpics;

package/epics/router/__tests__/changeLocation.test.d.ts

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

package/epics/router/__tests__/drilldown.test.d.ts

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

package/epics/router/__tests__/handleRouter.test.d.ts

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

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

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

package/epics/router/__tests__/selectScreen.test.d.ts

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

package/epics/router/__tests__/selectScreenFail.test.d.ts

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

package/epics/router/__tests__/selectView.test.d.ts

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

package/epics/router/__tests__/selectViewFail.test.d.ts

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

package/epics/router/__tests__/userDrillDown.test.d.ts

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

package/{dist/epics/router/changeLocationEpic.d.ts → epics/router/changeLocation.d.ts}

@@ -1,4 +1,4 @@
-import { CXBoxEpic } from '../../interfaces';
+import { Epic } from '../../actions/actions';
 /**
  * Epic of changing the current route
  *
@@ -6,5 +6,6 @@ import { CXBoxEpic } from '../../interfaces';
  * that are currently stored in the store, and in case of a mismatch
  * initiates reloading the screen, view or BC with new cursors.
  *
+ * @param action$ changeLocation
  */
-export declare const changeLocationEpic: CXBoxEpic;
+export declare const changeLocation: Epic;

package/epics/router/drilldown.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 drillDown: Epic;
+/**
+ *
+ * @param action
+ * @param store
+ * @category Epics
+ */
+export declare function drillDownImpl(action: ActionsMap['drillDown'], store: Store<CoreStore, AnyAction>): Observable<AnyAction>;

package/epics/router/handleRouter.d.ts

@@ -0,0 +1,17 @@
+import { Observable } from 'rxjs';
+import { Store } from 'redux';
+import { Epic, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+export declare const handleRouter: Epic;
+/**
+ * Default implementation for `handleRouter` epic.
+ *
+ * If server routing is used, this epic will send a requst to Cxbox API router endpoint.
+ * It writes a console error if request fails.
+ *
+ * @param action This epic will fire on {@link ActionPayloadTypes.handleRouter | handleRouter} action
+ * @param store Redux store instance
+ * @returns Default implementation does not throw any additional actions
+ * @category Epics
+ */
+export declare function handleRouterImpl(action: ActionsMap['handleRouter'], store: Store<CoreStore>): Observable<never>;

package/epics/router/loginDone.d.ts

@@ -0,0 +1,20 @@
+import { Observable } from 'rxjs';
+import { Store } from 'redux';
+import { Epic, AnyAction, ActionsMap } from '../../actions/actions';
+import { Store as CoreStore } from '../../interfaces/store';
+/**
+ * Fires `selectScreen` or `selectScreenFail` to set requested in url screen as active
+ * after succesful login.
+ *
+ * For server-side router fires `handleRouter` instead.
+ *
+ * @param action$ loginDone
+ */
+export declare const loginDone: Epic;
+/**
+ *
+ * @param action
+ * @param store
+ * @category Epics
+ */
+export declare function loginDoneImpl(action: ActionsMap['loginDone'], store: Store<CoreStore>): Observable<AnyAction>;

package/epics/router/selectScreen.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 `selectScreen` in 2.0.0
+ *
+ * @param action$ `selectScreen` action
+ * @param store
+ */
+export declare const changeScreen: Epic;
+/**
+ *
+ * @param action
+ * @param store
+ * @category Epics
+ */
+export declare function selectScreenImpl(action: ActionsMap['selectScreen'], store: Store<CoreStore>): Observable<AnyAction>;