@apia/api 4.0.24 → 4.0.26

package/dist/index.d.ts

@@ -2,11 +2,10 @@ import * as react from 'react';
 import react__default from 'react';
 import { AxiosResponse, AxiosRequestConfig } from 'axios';
 import * as _apia_util from '@apia/util';
-import { TModify, TApiaLoad, TApiaFormElement, TApiaFilterOption, TApiaFilter, TApiaFunction, TApiaFunctionPageInfo, EventEmitter, UnSubscriber } from '@apia/util';
+import { TModify, TApiaLoad, TApiaFormElement, TApiaFilterOption, TApiaFilter, Mutex, TApiaFunction, TApiaFunctionPageInfo, EventEmitter, UnSubscriber } from '@apia/util';
 import { TNotificationMessage, notify } from '@apia/notifications';
 import { TModal, TOpenModal, ApiaUtilModalHandler } from '@apia/components';
 import QueryString from 'qs';
-import * as lodash from 'lodash';
 import { TResponsiveTableColumn, TResponsiveTableContextProps, TResponsiveTableRowsSelectionEvent, TResponsiveTableSortChangeEvent, TResponsiveTableRow } from '@apia/table';
 import * as theme_ui from 'theme-ui';
 
@@ -285,6 +284,7 @@ type TFilter = {
     onChange?: (queryController: QueryController) => unknown;
     options?: TApiaFilterOption[];
     placeholder?: string;
+    multiplier?: number;
     readonly?: boolean;
     required?: boolean;
     runAutomatically?: boolean;
@@ -297,6 +297,27 @@ type TFilter = {
     isSize?: boolean;
 };
 
+type TFilterTypesElementConditions = {
+    onChange: string;
+    readonly: boolean;
+    name: string;
+    valueAsAttribute: boolean;
+    disabled: boolean;
+    html: boolean;
+    text: string;
+    id: string;
+    title: string;
+    type: string;
+    value: string;
+    selected: boolean;
+    options: {
+        option: {
+            content: string;
+            value: string;
+        }[];
+    };
+};
+
 declare class Filter {
     protected tableName?: string;
     filterState: TFilter;
@@ -311,6 +332,9 @@ declare class Filter {
     getRangeRenderer({ filter }: {
         filter: TApiaFilter;
     }): react.JSX.Element;
+    getDateRenderer({ filter }: {
+        filter: TApiaFilter;
+    }): react.JSX.Element;
     Component: (({ filter }: {
         filter: TApiaFilter;
     }) => react.JSX.Element) & {
@@ -319,9 +343,10 @@ declare class Filter {
 }
 
 type TableControllerState = {
-    finishedLoading: boolean;
+    finishedFirstLoad: boolean;
     columns: Map<string, TResponsiveTableColumn>;
     filters: Map<string | number, Filter>;
+    isLoading: boolean;
     pagination: {
         currentPage: number;
         totalPages: number;
@@ -342,42 +367,10 @@ type TableControllerEvents = {
     onSortChange: TResponsiveTableSortChangeEvent;
 };
 
-type TFilterTypesElementConditions = {
-    onChange: string;
-    readonly: boolean;
-    name: string;
-    valueAsAttribute: boolean;
-    disabled: boolean;
-    html: boolean;
-    text: string;
-    id: string;
-    title: string;
-    type: string;
-    value: string;
-    selected: boolean;
-    options: {
-        option: {
-            content: string;
-            value: string;
-        }[];
-    };
-};
-
-declare class FilterTypes {
-    conditions: TFilterTypesElementConditions[];
-    constructor();
-    protected getFilterTypes(): Promise<void>;
-    Component: () => react.JSX.Element;
-    initialLoad(): Promise<void>;
-    setFilterOptions(): Promise<void>;
-}
-
 declare class TableController {
     private emitter;
     private tableName;
-    private tableSelectionController;
     private controllerComponent;
-    filterTypes: FilterTypes;
     state: TableControllerState;
     constructor(initialState?: Partial<TableControllerState>);
     clearFilters(): void;
@@ -398,23 +391,33 @@ declare class TableController {
 }
 
 type QueryControllerStructure = {
-    columns: TResponsiveTableColumn[];
     description: string;
-    filters: TFilter[];
     hasAdditionalInformation: boolean;
     isDynamic: boolean;
     openFiltersAutomatically: boolean;
     runFiltersAutomatically: boolean;
     hideFilterTypes: boolean;
     title: string;
+    columns: TResponsiveTableColumn[];
+    filters: TFilter[];
 };
+type StoredQueryControllerStructure = Omit<QueryControllerStructure, 'columns' | 'filters'>;
 declare class QueryController {
     ajaxUrl: string;
     private hasInited;
     private initializing;
-    structure: QueryControllerStructure | null;
+    protected mutex: Mutex;
+    structure: StoredQueryControllerStructure | null;
     tableController: TableController;
-    getTableControllerDefaultProps(): {};
+    conditions: TFilterTypesElementConditions[];
+    constructor(ajaxUrl: string);
+    protected actualRefreshMethod(): Promise<void>;
+    protected areRequiredFilters(): boolean;
+    protected buildTableController(): TableController;
+    clearFilters(): Promise<void>;
+    private timeout;
+    protected executeRefresh(): void;
+    getTableControllerDefaultProps(): Omit<TResponsiveTableContextProps, 'FiltersRenderer' | 'SelectionHandler' | 'filters' | 'columns' | 'rows' | keyof TableControllerEvents> & Pick<TResponsiveTableContextProps, 'statesColumns'>;
     protected getEventsHandlers(): {
         onChangeSelection: (ev: TResponsiveTableRowsSelectionEvent) => void;
         onFilterBlur: (_ev: TApiaFilter) => void;
@@ -424,46 +427,47 @@ declare class QueryController {
         onSelectRows: (_ev: TResponsiveTableRowsSelectionEvent) => void;
         onSortChange: (ev: TResponsiveTableSortChangeEvent) => void;
         onPage: (num: number) => Promise<void>;
-        onRefresh: () => Promise<void | undefined>;
+        onRefresh: () => Promise<void>;
     };
-    protected buildTableController(): TableController;
-    constructor(ajaxUrl: string);
-    protected initEvents(): void;
     protected getLoadStructureParameters(): Record<string, unknown>;
     protected getClearFiltersParameters(): Record<string, unknown>;
     protected getFiltersValuesMap(): Record<string, unknown>;
+    get isLoading(): boolean;
     protected getPageParameters(): Record<string, unknown>;
     protected getRefreshParameters(): Record<string, unknown>;
     protected getSortParameters(): Record<string, unknown>;
-    protected parseLoadStructureResponse(response: any): QueryControllerStructure;
+    protected getStructure(): Promise<QueryControllerStructure & {
+        columns: TResponsiveTableColumn[];
+        filters: TFilter[];
+    }>;
+    protected initEvents(): void;
+    initialLoad(): Promise<void>;
+    protected loadFilterTypes(): Promise<void>;
+    page(num: number): Promise<void>;
+    protected parseLoadStructureResponse(response: any): QueryControllerStructure & {
+        columns: TResponsiveTableColumn[];
+        filters: TFilter[];
+    };
     protected parseRefreshResponse(response?: TApiaFunction | null): void;
-    protected getStructure(): Promise<QueryControllerStructure>;
-    protected parseStructure(structure: QueryControllerStructure): void;
+    protected parseStructure(structure: ReturnType<QueryController['parseLoadStructureResponse']>): void;
+    refresh(now?: boolean): Promise<void>;
+    setFilterOptions(): Promise<void>;
+    sort(column: string, orderType: 'Asc' | 'Des'): Promise<void>;
     protected updatePageState(pageInfo?: TApiaFunctionPageInfo): void;
     protected updateRows(rows: TResponsiveTableRow[]): void;
-    clearFilters(): Promise<void>;
-    initialLoad(): Promise<void>;
-    page(num: number): Promise<void>;
-    protected areRequiredFilters(): boolean;
-    protected actualRefreshMethod(): Promise<void>;
-    /**
-     * Allows to throttle calls to actual refresh method.
-     */
-    protected executeRefresh: lodash.DebouncedFunc<() => Promise<void>>;
-    refresh(now?: boolean): Promise<void | undefined>;
-    sort(column: string): Promise<void>;
 }
 
 type QueryModalControllerEvents = Pick<TableControllerEvents, 'onSelectRows'> & {
     cancel: null;
 };
 declare class QueryModalController {
+    protected title?: string | undefined;
     protected emitter: EventEmitter<QueryModalControllerEvents>;
     protected queryController: QueryController;
     private modalHandler;
     protected currentSelection: TResponsiveTableRowsSelectionEvent | null;
     private additionalFiltersController;
-    constructor(queryController: QueryController);
+    constructor(queryController: QueryController, title?: string | undefined);
     protected getModalDefinition(): TOpenModal;
     getQueryController(): QueryController;
     protected on<K extends keyof QueryModalControllerEvents>(ev: K, cb: (e: QueryModalControllerEvents[K]) => unknown): UnSubscriber;
@@ -473,42 +477,35 @@ declare class QueryModalController {
     protected onConfirmResolve<T>(): Promise<T>;
 }
 
-declare const ApiaUsersModal2: QueryModalController;
+declare const makeApiaUsersModal2: () => QueryModalController;
+
+declare class GenericListQuery extends QueryController {
+    ajaxUrl: string;
+    constructor(ajaxUrl: string);
+    protected getClearFiltersParameters(): Record<string, unknown>;
+    getTableControllerDefaultProps(): Omit<TResponsiveTableContextProps, 'FiltersRenderer' | 'SelectionHandler' | 'filters' | 'columns' | 'rows' | keyof TableControllerEvents> & Pick<TResponsiveTableContextProps, 'statesColumns'>;
+    protected getLoadStructureParameters(): {
+        action: string;
+    };
+    protected getRefreshParameters(): Record<string, unknown>;
+    protected parseRefreshResponse(response?: TApiaFunction | null): void;
+    protected parseLoadStructureResponse(response: any): QueryControllerStructure;
+    initialLoad(): Promise<void>;
+}
 
-declare const ApiaPoolsModals2: QueryModalController;
+declare const makeApiaPoolsModals2: () => QueryModalController;
 
 type TOpenMonDocModal = {
     docTypeId: string[];
     docTypeSel: string;
     monDocId: number;
 };
-declare class ApiaMonDocModal extends QueryModalController {
+declare class ApiaMonDocModal2 extends QueryModalController {
     constructor();
     openModal<T = TResponsiveTableRowsSelectionEvent>(properties: TOpenModal & {
         monitorProperties: TOpenMonDocModal;
     }): Promise<T>;
 }
-declare const ApiaMonDocModal2: ApiaMonDocModal;
-
-declare class GenericListQuery extends QueryController {
-    ajaxUrl: string;
-    constructor(ajaxUrl: string);
-    getTableControllerDefaultProps(): {
-        isMultiple: boolean;
-    };
-    protected getLoadStructureParameters(): {
-        action: string;
-    };
-    protected getRefreshParameters(): Record<string, unknown>;
-    protected getSortParameters(): Record<string, unknown>;
-    protected getFilterParameters(): Record<string, unknown>;
-    protected getFiltersValuesMap(): Record<string, unknown>;
-    protected filter(): Promise<void>;
-    protected parseLoadStructureResponse(response: any): QueryControllerStructure;
-    initialLoad(): Promise<void>;
-    refresh(): Promise<void>;
-    sort(column: string): Promise<void>;
-}
 
-export { ApiaApi, ApiaApiHandler, ApiaMonDocModal2, ApiaPoolsModals2, ApiaUsersModal2, GenericListQuery, type IApiaApiRequestConfig, QueryController, type QueryControllerStructure, QueryModalController, type TApiaApiAxiosResponse, type TApiaApiMethod, type TApiaApiResult, type TFilter, getFunction, getModal, isHtmlResponse, isXmlResponse, makeApiaUrl, parseSuccessfulResponse };
+export { ApiaApi, ApiaApiHandler, ApiaMonDocModal2, GenericListQuery, type IApiaApiRequestConfig, QueryController, type QueryControllerStructure, QueryModalController, type TApiaApiAxiosResponse, type TApiaApiMethod, type TApiaApiResult, type TFilter, getFunction, getModal, isHtmlResponse, isXmlResponse, makeApiaPoolsModals2, makeApiaUrl, makeApiaUsersModal2, parseSuccessfulResponse };
 //# sourceMappingURL=index.d.ts.map