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

package/dist/interfaces/operation.d.ts

@@ -1,336 +0,0 @@
-import { DrillDownType } from './router';
-import { AppNotificationType } from './objectMap';
-import { DataItem } from './data';
-import { OperationTypeCrud, OperationType } from '@cxbox-ui/schema';
-export type { OperationType, OperationInclusionDescriptor } from '@cxbox-ui/schema';
-export { OperationTypeCrud };
-export declare const coreOperations: OperationTypeCrud[];
-/**
- *
- * @param operation
- */
-export declare function isOperationGroup(operation: Operation | OperationGroup): operation is OperationGroup;
-/**
- * User operation: CRUD or any custom business action.
- *
- * Received from record's row meta.
- */
-export interface Operation {
-    /**
-     * Displayed name
-     */
-    text: string;
-    /**
-     * String that uniquely identifies an operation on widget
-     */
-    type: OperationType;
-    /**
-     * A hint to decide where to display an operation which is related to the record or the whole widget
-     */
-    scope: OperationScope;
-    /**
-     * @deprecated TODO: Remove in 2.0.0, designation unknown
-     */
-    action?: string;
-    /**
-     * An icon (https://ant.design/components/icon) to display on operation button,
-     */
-    icon?: string;
-    /**
-     * @deprecated TODO: Remove in 2.0.0 in favor of client-side custom parameters
-     */
-    bcKey?: string;
-    /**
-     * Omit text value of operation in favor of icon
-     */
-    showOnlyIcon?: boolean;
-    /**
-     * An operation that should be fired before initiating this operation
-     */
-    preInvoke?: OperationPreInvoke;
-    /**
-     * Validate the record for empty "required" fields before API call
-     */
-    autoSaveBefore?: boolean;
-    /**
-     * ???
-     */
-    confirmOperation?: OperationPreInvoke;
-    /**
-     * If custom operation needs to be processed as if it was a default crud operation,
-     * this flag can be specified and will be used instead of real `type`
-     */
-    actionRole?: OperationType;
-    /**
-     * Subtype for association popup, used for calling multiFileUploadPopup,
-     * else has default behaviour of assoc popup
-     */
-    subtype?: 'bc' | 'multiFileUpload';
-}
-/**
- * Group of actions.
- *
- * It shows name of a group, drop down list of actions
- * and some actions which are shown in case list is covered.
- * Группа действий, показывает название группы и раскрываемые список ее действий,
- * а также несколько действий рядом с группой, которые видны не раскрывая список.
- */
-export interface OperationGroup {
-    /**
-     * Unique identifier for the operation group
-     */
-    type?: string;
-    /**
-     * Displayed name of a group
-     */
-    text: string;
-    /**
-     * An icon (https://ant.design/components/icon) to display on operation button,
-     */
-    icon?: string;
-    /**
-     * Omit text value of operation in favor of icon
-     */
-    showOnlyIcon?: boolean;
-    /**
-     * List of group actions
-     */
-    actions: Operation[];
-    /**
-     * Number of showed actions in case list is covered
-     */
-    maxGroupVisualButtonsCount: number;
-}
-/**
- * An action which fires before user's operation
- */
-export interface OperationPreInvoke {
-    /**
-     * A type of operation (Pop-up message. Other types are not supported)
-     */
-    type: OperationPreInvokeType;
-    /**
-     * A message shown to user before operation fires
-     */
-    message: string;
-}
-/**
- * A type of message shown to user before operation fires
- */
-export declare enum OperationPreInvokeType {
-    /**
-     * Pop-up message contains "Yes/No" answers.
-     * If user says "Yes" then operation fires
-     */
-    confirm = "confirm",
-    /**
-     * Pop-up message contains some informational text with info icon
-     */
-    info = "info",
-    /**
-     * Pop-up message contains some information about error with error icon
-     * Перед операцией пользователя будет показано всплывающее сообщение
-     * с иконкой ошибки и операция не будет выполнена (TODO: Будет или не будет? Проверить)
-     */
-    error = "error"
-}
-/**
- * A type of action which fires after user's operation
- */
-export declare enum OperationPostInvokeType {
-    /**
-     * BC's refresh. It leads to cursor dropping, data.ts refresh of current BC and its children
-     */
-    refreshBC = "refreshBC",
-    /**
-     * File downloading by `fileId` which comes from  answer to user's operation.
-     * Вызов сохранения файла в браузере по пришедшему в ответе fileId
-     */
-    downloadFile = "downloadFile",
-    /**
-     * File downloading by `url` which comes from  answer to user's operation.
-     * Вызов сохранения файла в браузере по пришедшему в ответе url
-     */
-    downloadFileByUrl = "downloadFileByUrl",
-    /**
-     * Calling a browser transition to some record
-     */
-    drillDown = "drillDown",
-    /**
-     * `Pick list` widget opening
-     */
-    openPickList = "openPickList",
-    /**
-     * @deprecated TODO: Не работает, удалить все упоминания из Досье и убрать всех свидетелей
-     *
-     */
-    /**
-     * Showing pop-up message
-     */
-    showMessage = "showMessage",
-    /**
-     * Инициировать удаление записей
-     *
-     * @deprecated TODO: Remove in 2.0.0
-     */
-    postDelete = "postDelete"
-}
-/**
- * The type of message that will be shown to the user for confirmation
- */
-export declare enum OperationPostInvokeConfirmType {
-    /**
-     * Simple confirmation
-     */
-    confirm = "confirm",
-    /**
-     * Сonfirmation with text from the user
-     */
-    confirmText = "confirmText"
-}
-/**
- * The action that will be performed after the user confirms it
- */
-export interface OperationPostInvokeConfirm {
-    /**
-     * Type of postInvokeConfirm action
-     */
-    type: OperationPostInvokeConfirmType | string;
-    /**
-     * Body text of a modal actually
-     * TODO 2.0.0 rename correctly
-     */
-    message: string;
-    /**
-     * Custom modal title actually
-     * TODO 2.0.0 rename correctly
-     */
-    messageContent?: string;
-    /**
-     * Custom label of OK button
-     */
-    okText?: string;
-    /**
-     * Custom label of Cancel button
-     */
-    cancelText?: string;
-}
-/**
- * Modal window operation types
- */
-export interface OperationModalInvokeConfirm extends OperationPostInvokeConfirm {
-    /**
-     * Type of confirm action
-     */
-    type: OperationPostInvokeConfirmType | OperationPreInvokeType | string;
-}
-/**
- * An action which fires after user's operation
- *
- * @param bc Имя бизнес-компоненты, которую надо обновлять при refreshBC
- * @param fileId Идентификатор файла, который надо скачать при downloadFile
- * @param url?
- *
- * @param [key: string] ??? TODO: Это что?
- */
-export interface OperationPostInvoke {
-    /**
-     * A type of action
-     */
-    type: OperationPostInvokeType | string;
-}
-/**
- * BC's refresh. It leads to cursor dropping, data.ts refresh of current BC and its children
- */
-export interface OperationPostInvokeRefreshBc extends OperationPostInvoke {
-    /**
-     * BC's name
-     */
-    bc: string;
-}
-/**
- * File downloading by `fileId` which comes from  answer.
- */
-export interface OperationPostInvokeDownloadFile extends OperationPostInvoke {
-    /**
-     * Backend's file ID
-     */
-    fileId: string;
-}
-/**
- * File downloading by `url` which comes from answer.
- */
-export interface OperationPostInvokeDownloadFileByUrl extends OperationPostInvoke {
-    /**
-     * File's URL
-     */
-    url: string;
-}
-/**
- * Calling a browser transition to some record
- *
- * @param urlName При выполнении перехода на внешнюю сущность (POST-запрос на пришедший url),
- * этот адрес будет передан в теле запроса (см. CBR-9320 МР и тикет)
- */
-export interface OperationPostInvokeDrillDown extends OperationPostInvoke {
-    /**
-     * URL of transition
-     */
-    url: string;
-    /**
-     * A type of transition
-     */
-    drillDownType?: DrillDownType;
-    /**
-     * If transition performs to outer entity (POST call),
-     * this param will be passed to request body
-     */
-    urlName?: string;
-}
-/**
- * `Pick list` widget opening
- */
-export interface OperationPostInvokeOpenPickList extends OperationPostInvoke {
-    /**
-     * BC name of pick list widget
-     */
-    pickList: string;
-}
-/**
- * Pop-up message showing
- */
-export interface OperationPostInvokeShowMessage extends OperationPostInvoke {
-    /**
-     * A type of a message
-     */
-    messageType: AppNotificationType;
-    /**
-     * A text of a message
-     */
-    messageText: string;
-}
-/**
- * A union of all action types which could be be fired after user's operation
- */
-export type OperationPostInvokeAny = OperationPostInvokeRefreshBc | OperationPostInvokeDownloadFile | OperationPostInvokeDownloadFileByUrl | OperationPostInvokeDrillDown | OperationPostInvokeOpenPickList | OperationPostInvokeShowMessage | OperationPostInvokeConfirm;
-/**
- * TODO: ???
- */
-export type OperationScope = 'bc' | 'record' | 'page' | 'associate';
-export interface AssociatedItem extends DataItem {
-    _associate: boolean;
-}
-export interface OperationError {
-    success: false;
-    error: {
-        entity?: OperationErrorEntity;
-        popup?: string[];
-        postActions?: OperationPostInvokeAny[];
-    };
-}
-export interface OperationErrorEntity {
-    bcName: string;
-    fields: Record<string, string>;
-    id: string;
-}
-export type RequestType = 'data' | 'row-meta' | 'force-active';

package/dist/interfaces/router.d.ts

@@ -1,17 +0,0 @@
-export { DrillDownType } from '@cxbox-ui/schema';
-export interface Route {
-    type: RouteType;
-    path: string;
-    search: string;
-    params: Record<string, unknown>;
-    screenName?: string;
-    viewName?: string;
-    bcPath?: string;
-}
-export declare enum RouteType {
-    screen = "screen",
-    default = "default",
-    router = "router",
-    invalid = "invalid",
-    unknown = "unknown"
-}

package/dist/interfaces/rowMeta.d.ts

@@ -1,74 +0,0 @@
-import { CxboxResponse } from './objectMap';
-import { Operation, OperationGroup, OperationPostInvokeAny } from './operation';
-import { DataValue } from './data';
-/**
- * Мета записи, содержит информацию:
- *
- * @param actions о действиях, которые с ней можно совершить
- * @param fields о полях, которые есть в этой записи
- * @param errors об ошибках, если запись не проходит валидацию бэка
- *
- * TODO: По смыслу тут должно быть название DataItemMeta
- */
-export interface RowMeta {
-    actions: Array<Operation | OperationGroup>;
-    fields: RowMetaField[];
-    errors?: Record<string, string>;
-}
-export interface RowMetaResponse extends CxboxResponse {
-    data: {
-        row: RowMeta;
-        postActions?: OperationPostInvokeAny[];
-    };
-}
-/**
- * Мета поля, которую предоставляет мета записи.
- * Описывает разную дополнительную информацию о поле, которая не связана
- * с конкретной записью или с конкретным виджетом.
- *
- * @param key - ключ поля, уникально его идентифицирующий (см. DataItem [fieldName: string])
- * @param currentValue - актуальное значение на бэке, присылаемое на случай конфликтов совместного изменения
- * @param disabled - доступно ли поле для редактирования
- * @param placeholder - hint for filling the field
- * @param ephemeral - при любой операции поле будет отправляться на бэк, даже если не изменялось
- * @param hidden - поле не видно пользователю
- * @param required - поле обязательно для заполнения
- * @param forceActive - любое изменение этого поля пользователем должно инициировать запрос новой меты записи
- * @param drillDown - адрес, по которому поле позволяет осуществить переход
- * @param drillDownType - как будет обработан переход по адресу в браузере
- * @param drillDownKey - ключ для получения адреса из данных
- * @param values TODO:
- * @param filterValues TODO:
- * @param filterable - можно ли фильтровать записи по этому полю
- */
-export interface RowMetaField {
-    key: string;
-    defaultValue?: DataValue;
-    currentValue: DataValue;
-    disabled?: boolean;
-    placeholder?: string;
-    ephemeral?: boolean;
-    hidden?: boolean;
-    required?: boolean;
-    forceActive?: boolean;
-    /**
-     * @deprecated
-     * Флаг, определяющий надо ли устанавливать значение переданное в forceValue
-     * TODO: В Досье не используется, проверить на бэке и удалить
-     */
-    setForced?: boolean;
-    drillDown?: string;
-    drillDownType?: string;
-    /**
-     * @deprecated
-     * TODO: В Досье не используется, проверить на бэке и удалить
-     */
-    values?: Array<{
-        value: string;
-        icon: string;
-    }>;
-    filterValues?: Array<{
-        value: string;
-    }>;
-    filterable?: boolean;
-}

package/dist/interfaces/screen.d.ts

@@ -1,28 +0,0 @@
-import { ViewMetaResponse } from '../interfaces/view';
-import { BcMeta, BcMetaState } from '../interfaces/bc';
-import { BcFilter, BcSorter } from '../interfaces/filters';
-import { ViewNavigationGroup, ViewNavigationItem } from '../interfaces/navigation';
-export interface ScreenMetaResponse {
-    bo: {
-        bc: BcMeta[];
-    };
-    views: ViewMetaResponse[];
-    primary?: string;
-    navigation?: {
-        menu: Array<ViewNavigationGroup | ViewNavigationItem>;
-    };
-}
-export interface ScreenState {
-    screenName: string;
-    bo: {
-        activeBcName: string;
-        bc: Record<string, BcMetaState>;
-    };
-    cachedBc: {
-        [bcName: string]: string;
-    };
-    views: ViewMetaResponse[];
-    primaryView: string;
-    filters: Record<string, BcFilter[]>;
-    sorters: Record<string, BcSorter[]>;
-}

package/dist/interfaces/session.d.ts

@@ -1,83 +0,0 @@
-import { ScreenMetaResponse } from './screen';
-import { CxboxResponse } from './objectMap';
-import { RequestType } from './operation';
-export interface UserRole {
-    type: string;
-    key: string;
-    value: string;
-    description: string;
-    language: string;
-    displayOrder: number;
-    active: boolean;
-    cacheLoaderName: string;
-}
-export type DefaultNotificationType = 'success' | 'error' | 'info' | 'warning';
-export interface Notification {
-    key: string;
-    type: DefaultNotificationType | string;
-    message: string;
-    description?: string;
-    options?: {
-        messageOptions?: {
-            [key: string]: string | number;
-        };
-        buttonWarningNotificationOptions?: {
-            buttonText: string;
-            actionsForClick?: Array<Record<string, any>>;
-        };
-    };
-    duration?: number;
-}
-export type NotificationKeys = string[];
-export interface Session {
-    /**
-     * Whether dev tools panel is shown
-     */
-    devPanelEnabled?: boolean;
-    activeRole?: string;
-    roles?: UserRole[];
-    /**
-     * Shows if debug mode is enabled
-     */
-    debugMode?: boolean;
-    /**
-     * Enables availability of saving redux store and other info on user device.
-     * There is need to set it to `true` from client application.
-     */
-    exportStateEnabled?: boolean;
-    firstName?: string;
-    lastName?: string;
-    login?: string;
-    active: boolean;
-    logout: boolean;
-    screens: SessionScreen[];
-    loginSpin: boolean;
-    errorMsg?: string;
-    pendingRequests?: PendingRequest[];
-    notifications: Notification[];
-    isMetaRefreshing: boolean;
-}
-export interface LoginResponse extends CxboxResponse {
-    devPanelEnabled?: boolean;
-    activeRole?: string;
-    roles?: UserRole[];
-    firstName?: string;
-    lastName?: string;
-    login?: string;
-    screens: SessionScreen[];
-}
-export interface SessionScreen {
-    id: string;
-    name: string;
-    text: string;
-    url: string;
-    primary?: string;
-    defaultScreen?: boolean;
-    meta?: ScreenMetaResponse;
-    icon?: string;
-    notification?: number;
-}
-export interface PendingRequest {
-    requestId: string;
-    type: RequestType;
-}

package/dist/interfaces/store.d.ts

@@ -1,14 +0,0 @@
-import { Route } from './router';
-import { Session } from './session';
-import { ScreenState } from './screen';
-import { ViewState } from './view';
-import { DataState, DepthDataState } from './data';
-export interface Store {
-    router: Route;
-    session: Session;
-    screen: ScreenState;
-    view: ViewState;
-    data: DataState;
-    depthData: DepthDataState;
-    [reducerName: string]: any;
-}

package/dist/interfaces/tree.d.ts

@@ -1,66 +0,0 @@
-import { DataItem } from './data';
-import { AssociatedItem } from './operation';
-export interface BaseDataNode {
-    /**
-     * Uniquely identifies record
-     */
-    id: string;
-}
-/**
- * Types for Tree-like structures (tree traversal, search, etc)
- */
-/**
- * Base type for tree-like structures in flat array form
- */
-export interface DataNode extends BaseDataNode {
-    /**
-     * String reference to a parent node
-     */
-    parentId: string;
-    /**
-     * The depth of the node counting from the root of the tree
-     */
-    level?: number;
-}
-/**
- * Cxbox-specific data.ts item that classifies as tree node
- */
-export type DataItemNode = DataNode & DataItem;
-/**
- * Base type for tree nodes that keep references to parent nodes
- */
-export interface TreeNodeAscending extends DataNode {
-    /**
-     * Reference to parent node
-     */
-    parent: TreeNodeAscending;
-}
-/**
- * Base type for tree nodes that keep references to children nodes
- */
-export interface TreeNodeDescending extends BaseDataNode {
-    /**
-     * An array of references to children nodes
-     */
-    children?: TreeNodeDescending[];
-}
-/**
- * Base type for tree nodes that keep references both to the parent and children nodes
- */
-export interface TreeNodeBidirectional extends DataNode {
-    /**
-     * Reference to the parent
-     */
-    parent: TreeNodeBidirectional;
-    /**
-     * An array of children
-     */
-    children?: TreeNodeBidirectional[];
-}
-export type TreeAssociatedRecord = DataNode & AssociatedItem;
-/**
- * Tree node that keeps a status if it is expanded (i.e. children also should be displayed)
- */
-export type TreeNodeCollapsable<T extends TreeNodeBidirectional = TreeNodeBidirectional> = T & {
-    _expanded: boolean;
-};