@promoboxx/use-filter 1.0.4 → 1.0.5

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### 1.0.5 (2021-07-16)
+
+
+### Bug Fixes
+
+* declaration files ([4ce29e4](https://github.com/promoboxx/use-filter/commit/4ce29e43469ad4ade2d222c3b09f38ad8f89ca4c))
+
 ### 1.0.4 (2021-07-16)
 
 

package/dist/lib/buildDefaultFilterInfo.d.ts

@@ -0,0 +1,3 @@
+import { FilterInfo } from '../useFilter';
+declare function buildDefaultFilterInfo<T>(filterInfo?: Partial<FilterInfo<T>>): FilterInfo<T>;
+export default buildDefaultFilterInfo;

package/dist/lib/getOffsetFromPage.d.ts

@@ -0,0 +1,2 @@
+declare function getOffsetFromPage(page: number, pageSize: number): number;
+export default getOffsetFromPage;

package/dist/lib/getPageFromOffset.d.ts

@@ -0,0 +1,2 @@
+declare function getPageFromOffset(offset: number, pageSize: number): number;
+export default getPageFromOffset;

package/dist/lib/shallowEqual.d.ts

@@ -0,0 +1,2 @@
+declare const shallowEqual: (objA: any, objB: any) => boolean;
+export default shallowEqual;

package/dist/lib/shallowEqual.test.d.ts

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

package/dist/store/index.d.ts

@@ -0,0 +1,8 @@
+import { FilterInfo } from '../useFilter';
+export interface FilterStore {
+    getFilter(namespace: string): FilterInfo<any> | null | undefined;
+    saveFilter(namespace: string, filter: FilterInfo<any>): void;
+    clear(): void;
+}
+export declare function setFilterStore(newStore: FilterStore): void;
+export declare function getFilterStore(): FilterStore;

package/dist/store/memoryStore.d.ts

@@ -0,0 +1,3 @@
+import { FilterStore } from '.';
+declare const memoryStore: FilterStore;
+export default memoryStore;

package/dist/useFilter.d.ts

@@ -0,0 +1,37 @@
+declare type MaybePromise<T> = T | Promise<T>;
+interface UseFilterOptions<TFilter, TResult> {
+    defaultFilterInfo?: Partial<FilterInfo<TFilter>>;
+    shouldForceRunOnMount?: boolean;
+    onChange: (filterInfo: FilterInfo<TFilter>) => MaybePromise<UseFilterOnChangeResult<TFilter, TResult>>;
+    debounceDuration?: number;
+}
+declare function useFilter<T>(namespace: string, options: UseFilterOptions<T, any>): {
+    isLoading: boolean;
+    doesFilterExist: boolean;
+    filterInfo: FilterInfo<T>;
+    updateFilter(filter: T): void;
+    resetFilter(): void;
+    setOffset(offset: number | string): void;
+    setPage(page: number | string): void;
+    setSort(sort: string | undefined): void;
+    forceRefresh(): void;
+};
+export default useFilter;
+export interface FilterInfo<TFilter> {
+    filter: TFilter;
+    offset: number;
+    page: number;
+    sort?: string;
+    pageSize: number;
+    lastRefreshAt: number;
+    totalResults: number;
+    totalPages: number;
+}
+declare type UseFilterOnChangeResult<TFilter, TResult> = void | {
+    filterInfo?: Partial<Omit<FilterInfo<TFilter>, 'totalResults' | 'offset' | 'pageSize'> & {
+        totalResults: string | number;
+        offset: string | number;
+        pageSize: string | number;
+    }>;
+    data?: TResult;
+};

package/dist/useFilter.test.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@promoboxx/use-filter",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "",
   "main": "dist/useFilter.js",
   "scripts": {
@@ -23,14 +23,23 @@
     "typescript": "^4.3.5"
   },
   "files": [
+    "dist/useFilter.d.ts",
+    "dist/store/index.d.ts",
     "dist/store/index.js",
     "dist/store/memoryStore.js",
+    "dist/store/memoryStore.d.ts",
     "dist/useFilter.js",
     "dist/lib/buildDefaultFilterInfo.js",
     "dist/lib/shallowEqual.test.js",
     "dist/lib/shallowEqual.js",
     "dist/lib/getOffsetFromPage.js",
+    "dist/lib/buildDefaultFilterInfo.d.ts",
+    "dist/lib/shallowEqual.test.d.ts",
+    "dist/lib/getOffsetFromPage.d.ts",
     "dist/lib/getPageFromOffset.js",
+    "dist/lib/shallowEqual.d.ts",
+    "dist/lib/getPageFromOffset.d.ts",
+    "dist/useFilter.test.d.ts",
     "dist/useFilter.test.js"
   ]
 }