@mackin.com/styleguide 9.9.1 → 9.10.0

package/index.d.ts

@@ -440,6 +440,51 @@ interface OmniLinkProps extends LinkProps {
 }
 declare const OmniLink: (props: OmniLinkProps) => JSX.Element;
 
+interface PagedResultDto<T> {
+    total: number;
+    /** The zero-based page index. */
+    page: number;
+    limit: number;
+    items: T[];
+}
+
+/** A page of data with helpers props.  */
+declare class PagedResult<T> {
+    constructor(items?: T[], total?: number, page?: number, limit?: number);
+    /** @deprecated Use fromPagedResultDto going forward. */
+    static fromDto<T>(dto: {
+        [key: string]: any;
+    }): PagedResult<T>;
+    static fromPagedResultDto<TDto, TDomain>(dto: PagedResultDto<TDto>, convert?: (dto: TDto) => TDomain): PagedResult<TDomain>;
+    total: number;
+    /** The zero-based page index. */
+    page: number;
+    limit: number;
+    items: T[];
+    /** Helper for items.length */
+    get length(): number;
+    get hasItems(): boolean;
+    get previousPage(): number;
+    get hasPrevious(): boolean;
+    get nextPage(): number;
+    get hasNext(): boolean;
+    get lastPage(): number;
+    get totalPages(): number;
+    get minPageItemIndex(): number;
+    get maxPageItemIndex(): number;
+    /** Returns the first item on the current page. */
+    get firstPageItem(): T;
+    /** Returns the last item on the current page */
+    get lastPageItem(): T;
+    getPageRelativeItemIndex(item: T): number;
+    getResultRelativeItemIndex(item: T): number | undefined;
+    getPreviousItem(fromItem: T): T | undefined;
+    getNextItem(fromItem: T): T | undefined;
+    getPagingRange(radius: number): number[];
+    toJSON(): PagedResultDto<T>;
+    clone(newItems?: T[]): PagedResult<T>;
+}
+
 declare type SortDirection = 'asc' | 'desc';
 interface PagerSortOption<TItem> {
     id: string;
@@ -492,6 +537,8 @@ declare class ItemPager<TItem> {
      * @param sortId The ID or partial ID (no '-asc' or '-desc') of a sort option created through addToggleSortOption
      */
     toggleSort(sortId: string): void;
+    /** Filters the current results by the filtering function ONCE.
+     * You will need to re-add the filter if the contents of the filtering function changes. */
     applyFilter(filter?: (item: TItem) => boolean, keepPage?: boolean): void;
     next(): void;
     previous(): void;
@@ -501,6 +548,8 @@ declare class ItemPager<TItem> {
     /** Removes the matched item(s). */
     remove(comparer: (item: TItem) => boolean, keepPage?: boolean): void;
     replace(newItem: TItem, comparer: (item: TItem) => boolean): void;
+    /** Returns a clone of the underlying PagedResult. */
+    toPagedResult(): PagedResult<TItem>;
     private _allItems;
     private _page;
     private _limit;
@@ -572,51 +621,6 @@ interface Props<T> extends PagerStyleProps {
 }
 declare const BoundStaticPager: <T>(p: Props<T>) => JSX.Element;
 
-interface PagedResultDto<T> {
-    total: number;
-    /** The zero-based page index. */
-    page: number;
-    limit: number;
-    items: T[];
-}
-
-/** A page of data with helpers props.  */
-declare class PagedResult<T> {
-    constructor(items?: T[], total?: number, page?: number, limit?: number);
-    /** @deprecated Use fromPagedResultDto going forward. */
-    static fromDto<T>(dto: {
-        [key: string]: any;
-    }): PagedResult<T>;
-    static fromPagedResultDto<TDto, TDomain>(dto: PagedResultDto<TDto>, convert?: (dto: TDto) => TDomain): PagedResult<TDomain>;
-    total: number;
-    /** The zero-based page index. */
-    page: number;
-    limit: number;
-    items: T[];
-    /** Helper for items.length */
-    get length(): number;
-    get hasItems(): boolean;
-    get previousPage(): number;
-    get hasPrevious(): boolean;
-    get nextPage(): number;
-    get hasNext(): boolean;
-    get lastPage(): number;
-    get totalPages(): number;
-    get minPageItemIndex(): number;
-    get maxPageItemIndex(): number;
-    /** Returns the first item on the current page. */
-    get firstPageItem(): T;
-    /** Returns the last item on the current page */
-    get lastPageItem(): T;
-    getPageRelativeItemIndex(item: T): number;
-    getResultRelativeItemIndex(item: T): number | undefined;
-    getPreviousItem(fromItem: T): T | undefined;
-    getNextItem(fromItem: T): T | undefined;
-    getPagingRange(radius: number): number[];
-    toJSON(): PagedResultDto<T>;
-    clone(newItems?: T[]): PagedResult<T>;
-}
-
 declare type PickerValue = string | number;
 declare type PickerOption<T> = T | {
     id: T;

package/index.esm.js

@@ -3481,6 +3481,8 @@ class ItemPager {
         }
         this.sort = nextSort;
     }
+    /** Filters the current results by the filtering function ONCE.
+     * You will need to re-add the filter if the contents of the filtering function changes. */
     applyFilter(filter, keepPage) {
         this._currentFilter = filter;
         if (!this._currentFilter) {
@@ -3541,6 +3543,10 @@ class ItemPager {
         });
         this.applyFilter(this._currentFilter, true);
     }
+    /** Returns a clone of the underlying PagedResult. */
+    toPagedResult() {
+        return this.createPageResult();
+    }
     createPageResult() {
         const page = new PagedResult([], this._filteredItems.length, this.page, this.limit);
         page.items = this._filteredItems.slice(page.minPageItemIndex, page.maxPageItemIndex + 1) || [];

package/index.js

@@ -3508,6 +3508,8 @@ class ItemPager {
         }
         this.sort = nextSort;
     }
+    /** Filters the current results by the filtering function ONCE.
+     * You will need to re-add the filter if the contents of the filtering function changes. */
     applyFilter(filter, keepPage) {
         this._currentFilter = filter;
         if (!this._currentFilter) {
@@ -3568,6 +3570,10 @@ class ItemPager {
         });
         this.applyFilter(this._currentFilter, true);
     }
+    /** Returns a clone of the underlying PagedResult. */
+    toPagedResult() {
+        return this.createPageResult();
+    }
     createPageResult() {
         const page = new PagedResult([], this._filteredItems.length, this.page, this.limit);
         page.items = this._filteredItems.slice(page.minPageItemIndex, page.maxPageItemIndex + 1) || [];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mackin.com/styleguide",
-    "version": "9.9.1",
+    "version": "9.10.0",
     "description": "",
     "main": "./index.js",
     "module": "./index.esm.js",