@singularsystems/neo-core 1.0.0-alpha.3 → 1.0.0-alpha.4

package/dist/Data/Paging/PageManager.d.ts

@@ -1,167 +1,167 @@
-import { AxiosPromise } from 'axios';
-import { PageResult } from './PageResult';
-import { PageRequest } from './PageRequest';
-import { ITaskRunner } from '../../Components/TaskRunner/TaskRunner';
-import ValueObject from '../../Model/ValueObject';
-import { IBindableBase, PartialPlainObject } from '../../Model/IModelBase';
-import { DataViewBase } from '../DataView';
-import { Model } from '../../';
-import PropertyInfo from '../../Model/PropertyInfo';
-import List from '../../Model/List';
-import { IDeserialiseOptions } from '../Deserialiser';
-export interface IPageManagerOptions<TCriteria extends ValueObject, TModel> {
-    /**
-     * No of records per page. Default is 20.
-     */
-    pageSize?: number;
-    /**
-     * User selectable page sizes. Defaults to 10, 20, 50.
-     */
-    pageSizeOptions?: number[];
-    /**
-     * Initial sort property or array of properties.
-     */
-    sortBy?: keyof TModel | (keyof TModel)[];
-    /**
-     * Initial sort direction or directions.
-     */
-    sortAscending?: boolean | boolean[];
-    /**
-     * Set to false if you don't want to allow sorting.
-     */
-    allowSort?: boolean;
-    /**
-     * Set to true if you want initial data to be fetched when the page manager is first displayed.
-     */
-    fetchInitial?: boolean;
-    /**
-     * Task runner through which paging requests should flow.
-     */
-    taskRunner?: ITaskRunner;
-    /**
-     * Task runner to use for the initial data request.
-     */
-    initialTaskRunner?: ITaskRunner;
-    /**
-     * Called after criteria has been populated, and before the api endpoint is called.
-     */
-    beforeFetch?: (criteria: Model.PlainObject<PageRequest<TCriteria>>) => void;
-    /**
-     * Called after data has been fetched and deserialised.
-     */
-    afterFetch?: (data: TModel[]) => void | Promise<void>;
-    /**
-     * Options to pass to the deserialiser.
-     */
-    deserialiseOptions?: IDeserialiseOptions;
-}
-export interface IPageManager {
-    /** Go to the first page. */
-    firstPage(): void;
-    /** Go to the previous page. */
-    previousPage(): void;
-    /** Go to the next page. */
-    nextPage(): void;
-    /** Go to the last page. */
-    lastPage(): void;
-    /** Gets or sets the current page no. */
-    pageNo: number;
-    /** Gets or sets the page size. */
-    pageSize: number;
-    /** Gets the total number of pages based on the total number of records. */
-    readonly totalPages: number;
-    /** Gets the user selectable page sizes. */
-    readonly pageSizeOptions: number[];
-    /**
-     * Refresh the data by calling the api endpoint with the current criteria.
-     * Note: the page index will be reset to zero. Use this when your criteria has changed
-     * @param getCount True if criteria has changed, and the total number of records needs to be refetched.
-     * @param taskRunner Optional alternate task runner to use.
-     */
-    refreshData(getCount?: boolean, taskRunner?: ITaskRunner): Promise<void>;
-    /**
-     * Refresh the data by calling the api endpoint with the current criteria.
-     * This will not reset the page index, and will not update the total record count, therefore should only be called if your criteria has not changed since the last full fetch using refreshData().
-     * @param taskRunner Optional alternate task runner to use.
-     */
-    refreshPage(taskRunner?: ITaskRunner): Promise<void>;
-}
-export declare class PageManager<TCriteria extends ValueObject, TModel extends IBindableBase> extends DataViewBase<TModel> implements IPageManager {
-    private modelType;
-    private dataSource;
-    private options;
-    constructor(criteria: TCriteria, modelType: new () => TModel, dataSource: (criteria: Model.PartialPlainNonTrackedObject<PageRequest<TCriteria>>) => (AxiosPromise<PageResult<Model.PlainObject<TModel>>> | Promise<PageResult<Model.PlainObject<TModel>>>), options?: IPageManagerOptions<TCriteria, TModel>);
-    taskRunner: ITaskRunner;
-    private hasInitialised;
-    private pageRequest;
-    private _totalRecords;
-    private currentData;
-    private initialFetchState;
-    /**
-     * Gets or sets the criteria.
-     */
-    get criteria(): TCriteria | undefined;
-    set criteria(value: TCriteria | undefined);
-    /**
-     * Returns the state of the initial data request. Does not change after the first request has been made.
-     * Note, this will return null while loading, so you should check against a boolean value. E.g. if (hasFetched === false)
-     */
-    get hasFetched(): boolean | null;
-    /**
-     * Gets or sets the 1 based page number.
-     */
-    get pageNo(): number;
-    set pageNo(value: number);
-    get pageSize(): number;
-    set pageSize(value: number);
-    get totalRecords(): number;
-    /** Gets the total number of pages based on the total number of records. */
-    get totalPages(): number;
-    /**
-     * Called by the pager component on first display. Will fetch data if options.fetchInitial is set to true.
-     */
-    initialise(): void;
-    /**
-     * Refresh the data by calling the api endpoint with the current criteria.
-     * Note: the page index will be reset to zero. Use this when your criteria has changed
-     * @param getCount True if criteria has changed, and the total number of records needs to be refetched.
-     * @param taskRunner Optional alternate task runner to use.
-     */
-    refreshData(getCount?: boolean, taskRunner?: ITaskRunner): Promise<void>;
-    /**
-     * Refresh the data by calling the api endpoint with the current criteria.
-     * This will not reset the page index, and will not update the total record count, therefore should only be called if your criteria has not changed since the last full fetch using refreshData().
-     * @param taskRunner Optional alternate task runner to use.
-     */
-    refreshPage(taskRunner?: ITaskRunner): Promise<void>;
-    private fetchAndSetData;
-    setData(pageRecords: PartialPlainObject<TModel>[], totalRecords?: number): Promise<void>;
-    /**
-     * Resets the page manager to its initial state and clears the current data.
-     */
-    reset(): void;
-    /**
-     * Resets the sort properties. A new sort property can be provided.
-     * If the provided sort property matches the first existing sort property, and sortAscending is undefined, then the current sort order will be reversed.
-     */
-    resetSort(property?: PropertyInfo, sortAscending?: boolean): void;
-    /**
-     * Adds a sort property.
-     * If the property already exists, the sort direction of the property will be reversed.
-     */
-    addSort(property: PropertyInfo, sortAscending?: boolean): void;
-    /** Sets a single or multiple sort operations. Does not refresh data. */
-    setSortOperations(sortBy: keyof TModel | (keyof TModel)[], sortAscending?: boolean | boolean[]): void;
-    get rawItems(): List<TModel>;
-    getItems(): TModel[];
-    /**
-     * Returns the current list.
-     */
-    get data(): List<TModel>;
-    get pageSizeOptions(): number[];
-    getMetaItem(): TModel;
-    firstPage(): void;
-    previousPage(): void;
-    nextPage(): void;
-    lastPage(): void;
-}
+import { AxiosPromise } from 'axios';
+import { PageResult } from './PageResult';
+import { PageRequest } from './PageRequest';
+import { ITaskRunner } from '../../Components/TaskRunner/TaskRunner';
+import ValueObject from '../../Model/ValueObject';
+import { IBindableBase, PartialPlainObject } from '../../Model/IModelBase';
+import { DataViewBase } from '../DataView';
+import { Model } from '../../';
+import PropertyInfo from '../../Model/PropertyInfo';
+import List from '../../Model/List';
+import { IDeserialiseOptions } from '../Deserialiser';
+export interface IPageManagerOptions<TCriteria extends ValueObject, TModel> {
+    /**
+     * No of records per page. Default is 20.
+     */
+    pageSize?: number;
+    /**
+     * User selectable page sizes. Defaults to 10, 20, 50.
+     */
+    pageSizeOptions?: number[];
+    /**
+     * Initial sort property or array of properties.
+     */
+    sortBy?: keyof TModel | (keyof TModel)[];
+    /**
+     * Initial sort direction or directions.
+     */
+    sortAscending?: boolean | boolean[];
+    /**
+     * Set to false if you don't want to allow sorting.
+     */
+    allowSort?: boolean;
+    /**
+     * Set to true if you want initial data to be fetched when the page manager is first displayed.
+     */
+    fetchInitial?: boolean;
+    /**
+     * Task runner through which paging requests should flow.
+     */
+    taskRunner?: ITaskRunner;
+    /**
+     * Task runner to use for the initial data request.
+     */
+    initialTaskRunner?: ITaskRunner;
+    /**
+     * Called after criteria has been populated, and before the api endpoint is called.
+     */
+    beforeFetch?: (criteria: Model.PlainObject<PageRequest<TCriteria>>) => void;
+    /**
+     * Called after data has been fetched and deserialised.
+     */
+    afterFetch?: (data: TModel[]) => void | Promise<void>;
+    /**
+     * Options to pass to the deserialiser.
+     */
+    deserialiseOptions?: IDeserialiseOptions;
+}
+export interface IPageManager {
+    /** Go to the first page. */
+    firstPage(): void;
+    /** Go to the previous page. */
+    previousPage(): void;
+    /** Go to the next page. */
+    nextPage(): void;
+    /** Go to the last page. */
+    lastPage(): void;
+    /** Gets or sets the current page no. */
+    pageNo: number;
+    /** Gets or sets the page size. */
+    pageSize: number;
+    /** Gets the total number of pages based on the total number of records. */
+    readonly totalPages: number;
+    /** Gets the user selectable page sizes. */
+    readonly pageSizeOptions: number[];
+    /**
+     * Refresh the data by calling the api endpoint with the current criteria.
+     * Note: the page index will be reset to zero. Use this when your criteria has changed
+     * @param getCount True if criteria has changed, and the total number of records needs to be refetched.
+     * @param taskRunner Optional alternate task runner to use.
+     */
+    refreshData(getCount?: boolean, taskRunner?: ITaskRunner): Promise<void>;
+    /**
+     * Refresh the data by calling the api endpoint with the current criteria.
+     * This will not reset the page index, and will not update the total record count, therefore should only be called if your criteria has not changed since the last full fetch using refreshData().
+     * @param taskRunner Optional alternate task runner to use.
+     */
+    refreshPage(taskRunner?: ITaskRunner): Promise<void>;
+}
+export declare class PageManager<TCriteria extends ValueObject, TModel extends IBindableBase> extends DataViewBase<TModel> implements IPageManager {
+    private modelType;
+    private dataSource;
+    private options;
+    constructor(criteria: TCriteria, modelType: new () => TModel, dataSource: (criteria: Model.PartialPlainNonTrackedObject<PageRequest<TCriteria>>) => (AxiosPromise<PageResult<Model.PlainObject<TModel>>> | Promise<PageResult<Model.PlainObject<TModel>>>), options?: IPageManagerOptions<TCriteria, TModel>);
+    taskRunner: ITaskRunner;
+    private hasInitialised;
+    private pageRequest;
+    private _totalRecords;
+    private currentData;
+    private initialFetchState;
+    /**
+     * Gets or sets the criteria.
+     */
+    get criteria(): TCriteria | undefined;
+    set criteria(value: TCriteria | undefined);
+    /**
+     * Returns the state of the initial data request. Does not change after the first request has been made.
+     * Note, this will return null while loading, so you should check against a boolean value. E.g. if (hasFetched === false)
+     */
+    get hasFetched(): boolean | null;
+    /**
+     * Gets or sets the 1 based page number.
+     */
+    get pageNo(): number;
+    set pageNo(value: number);
+    get pageSize(): number;
+    set pageSize(value: number);
+    get totalRecords(): number;
+    /** Gets the total number of pages based on the total number of records. */
+    get totalPages(): number;
+    /**
+     * Called by the pager component on first display. Will fetch data if options.fetchInitial is set to true.
+     */
+    initialise(): void;
+    /**
+     * Refresh the data by calling the api endpoint with the current criteria.
+     * Note: the page index will be reset to zero. Use this when your criteria has changed
+     * @param getCount True if criteria has changed, and the total number of records needs to be refetched.
+     * @param taskRunner Optional alternate task runner to use.
+     */
+    refreshData(getCount?: boolean, taskRunner?: ITaskRunner): Promise<void>;
+    /**
+     * Refresh the data by calling the api endpoint with the current criteria.
+     * This will not reset the page index, and will not update the total record count, therefore should only be called if your criteria has not changed since the last full fetch using refreshData().
+     * @param taskRunner Optional alternate task runner to use.
+     */
+    refreshPage(taskRunner?: ITaskRunner): Promise<void>;
+    private fetchAndSetData;
+    setData(pageRecords: PartialPlainObject<TModel>[], totalRecords?: number): Promise<void>;
+    /**
+     * Resets the page manager to its initial state and clears the current data.
+     */
+    reset(): void;
+    /**
+     * Resets the sort properties. A new sort property can be provided.
+     * If the provided sort property matches the first existing sort property, and sortAscending is undefined, then the current sort order will be reversed.
+     */
+    resetSort(property?: PropertyInfo, sortAscending?: boolean): void;
+    /**
+     * Adds a sort property.
+     * If the property already exists, the sort direction of the property will be reversed.
+     */
+    addSort(property: PropertyInfo, sortAscending?: boolean): void;
+    /** Sets a single or multiple sort operations. Does not refresh data. */
+    setSortOperations(sortBy: keyof TModel | (keyof TModel)[], sortAscending?: boolean | boolean[]): void;
+    get rawItems(): List<TModel>;
+    getItems(): TModel[];
+    /**
+     * Returns the current list.
+     */
+    get data(): List<TModel>;
+    get pageSizeOptions(): number[];
+    getMetaItem(): TModel;
+    firstPage(): void;
+    previousPage(): void;
+    nextPage(): void;
+    lastPage(): void;
+}