@promoboxx/use-filter 1.0.2 → 1.0.5

package/src/useFilter.ts

@@ -1,280 +0,0 @@
-import { useEffect, useRef, useCallback, useState } from 'react'
-
-import buildDefaultFilterInfo from './lib/buildDefaultFilterInfo'
-import getOffsetFromPage from './lib/getOffsetFromPage'
-import getPageFromOffset from './lib/getPageFromOffset'
-import shallowEqual from './lib/shallowEqual'
-import { getFilterStore } from './store'
-
-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
-}
-
-function useFilter<T>(namespace: string, options: UseFilterOptions<T, any>) {
-  const [filterInfo, setFilterInfoState] = useState<
-    FilterInfo<T> | null | undefined
-  >(() => getFilterStore().getFilter(namespace))
-
-  const setFilterInfo = useCallback(
-    (filterInfo: FilterInfo<T>, skipFetch = false) => {
-      setFilterInfoState((previousFilterInfo) => {
-        let lastRefreshAt: number | undefined
-
-        if (skipFetch) {
-          lastRefreshAt = previousFilterInfo?.lastRefreshAt
-        } else {
-          lastRefreshAt = new Date().getTime()
-        }
-
-        if (!lastRefreshAt) {
-          throw new Error()
-        }
-
-        return {
-          ...filterInfo,
-          lastRefreshAt,
-        }
-      })
-    },
-    [],
-  )
-
-  const ctxRef = useRef<
-    Pick<
-      UseFilterOptions<T, any>,
-      'onChange' | 'debounceDuration' | 'defaultFilterInfo'
-    > & { namespace: typeof namespace }
-  >({
-    namespace,
-    onChange: options.onChange,
-    debounceDuration: options.debounceDuration,
-    defaultFilterInfo: options.defaultFilterInfo,
-  })
-
-  const [isLoading, setIsLoading] = useState(!filterInfo)
-  const doesFilterExist = useRef(!!filterInfo)
-  const lastRefreshAtRef = useRef(
-    // if shouldForceRunOnMount is set, always use -1
-    // otherwise, try grabbing lastRefreshAt
-    // then, just use -1 cause there's no other option
-    options.shouldForceRunOnMount
-      ? -1
-      : filterInfo
-      ? filterInfo.lastRefreshAt
-      : -1,
-  )
-
-  // Call onChange when data changes.
-  useEffect(() => {
-    setIsLoading(true)
-
-    // If there is no existing filter info, set it to the defaults and return.
-    // This same effect will trigger next go.
-    if (!filterInfo) {
-      setFilterInfo(buildDefaultFilterInfo(ctxRef.current.defaultFilterInfo))
-      return
-    }
-
-    // If the lastRefreshAt hasn't changed, don't make a request.
-    if (lastRefreshAtRef.current === filterInfo.lastRefreshAt) {
-      setIsLoading(false)
-      return
-    }
-
-    const timeout = setTimeout(
-      () => {
-        lastRefreshAtRef.current = filterInfo.lastRefreshAt
-        const response = ctxRef.current.onChange(filterInfo)
-        getFilterStore().saveFilter(namespace, filterInfo)
-
-        if (!response) {
-          setIsLoading(false)
-          return
-        }
-
-        function handleResponse(response?: UseFilterOnChangeResult<T, any>) {
-          if (!filterInfo) {
-            return
-          }
-
-          if (!response) {
-            return
-          }
-
-          if (response.filterInfo) {
-            const extra: Partial<FilterInfo<T>> = {}
-            const {
-              page,
-              offset,
-              totalResults,
-              pageSize,
-              ...filterInfoFromResponse
-            } = response.filterInfo
-
-            const pageSizeNumber = Number(pageSize || filterInfo.pageSize)
-
-            if (page != null && offset == null) {
-              extra.offset = getOffsetFromPage(page, pageSizeNumber)
-              extra.page = page
-              // If there's an offset but no page, set the page.
-            } else if (page == null && offset != null) {
-              const offsetNumber = Number(offset)
-              extra.offset = offsetNumber
-              extra.page = getPageFromOffset(offsetNumber, pageSizeNumber)
-            }
-
-            if (totalResults) {
-              extra.totalResults = Number(totalResults)
-              extra.totalPages = Math.ceil(extra.totalResults / pageSizeNumber)
-            }
-
-            // TODO Don't do anther request here????
-            setFilterInfo(
-              {
-                ...filterInfo,
-                ...filterInfoFromResponse,
-                ...extra,
-              },
-              true,
-            )
-          }
-        }
-
-        if (isPromise(response)) {
-          response.then(handleResponse).finally(() => setIsLoading(false))
-        } else {
-          handleResponse(response)
-          setIsLoading(false)
-        }
-      },
-      ctxRef.current.debounceDuration != null
-        ? ctxRef.current.debounceDuration
-        : 500,
-    )
-
-    return () => {
-      if (timeout) {
-        clearTimeout(timeout)
-      }
-    }
-  }, [filterInfo, setFilterInfo, namespace])
-
-  return {
-    isLoading,
-    doesFilterExist: doesFilterExist.current,
-    filterInfo: filterInfo || buildDefaultFilterInfo(options.defaultFilterInfo),
-
-    updateFilter(filter: T) {
-      if (!filterInfo) {
-        throw new Error()
-      }
-
-      const nextFilter = {
-        ...filterInfo.filter,
-        ...filter,
-      }
-
-      if (shallowEqual(filterInfo.filter, nextFilter)) {
-        return
-      }
-
-      setFilterInfo({
-        ...filterInfo,
-        offset: 0,
-        page: 1,
-        totalResults: 1,
-        totalPages: 1,
-        filter: nextFilter,
-      })
-    },
-
-    resetFilter() {
-      setFilterInfo(buildDefaultFilterInfo(options.defaultFilterInfo))
-    },
-
-    setOffset(offset: number | string) {
-      if (!filterInfo) {
-        throw new Error()
-      }
-
-      const offsetNumber = Number(offset)
-
-      setFilterInfo({
-        ...filterInfo,
-        offset: offsetNumber,
-        page: getPageFromOffset(offsetNumber, filterInfo.pageSize),
-      })
-    },
-
-    setPage(page: number | string) {
-      if (!filterInfo) {
-        throw new Error()
-      }
-
-      const pageNumber = Number(page)
-
-      setFilterInfo({
-        ...filterInfo,
-        offset: getOffsetFromPage(pageNumber, filterInfo.pageSize),
-        page: pageNumber,
-      })
-    },
-
-    setSort(sort: string | undefined) {
-      if (!filterInfo) {
-        throw new Error()
-      }
-
-      setFilterInfo({
-        ...filterInfo,
-        sort,
-      })
-    },
-
-    forceRefresh() {
-      if (!filterInfo) {
-        throw new Error()
-      }
-
-      setFilterInfo({
-        ...filterInfo,
-        lastRefreshAt: new Date().getTime(),
-      })
-    },
-  }
-}
-
-export default useFilter
-
-export interface FilterInfo<TFilter> {
-  filter: TFilter
-  offset: number
-  page: number
-  sort?: string
-  pageSize: number
-  lastRefreshAt: number
-  totalResults: number
-  totalPages: number
-}
-
-type UseFilterOnChangeResult<TFilter, TResult> = void | {
-  filterInfo?: Partial<
-    Omit<FilterInfo<TFilter>, 'totalResults' | 'offset' | 'pageSize'> & {
-      totalResults: string | number
-      offset: string | number
-      pageSize: string | number
-    }
-  >
-  data?: TResult
-}
-
-function isPromise(t?: any): t is Promise<any> {
-  return !!t?.then
-}

package/tsconfig.json

@@ -1,75 +0,0 @@
-{
-  "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig.json to read more about this file */
-
-    /* Basic Options */
-    // "incremental": true,                         /* Enable incremental compilation */
-    "target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', 'ES2021', or 'ESNEXT'. */,
-    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
-    "lib": [
-      "DOM",
-      "es2018"
-    ] /* Specify library files to be included in the compilation. */,
-    // "allowJs": true,                             /* Allow javascript files to be compiled. */
-    // "checkJs": true,                             /* Report errors in .js files. */
-    "jsx": "react" /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */,
-    // "declaration": true,                         /* Generates corresponding '.d.ts' file. */
-    // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    // "sourceMap": true,                           /* Generates corresponding '.map' file. */
-    // "outFile": "./",                             /* Concatenate and emit output to single file. */
-    "outDir": "./dist" /* Redirect output structure to the directory. */,
-    "rootDir": "./src" /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
-    // "composite": true,                           /* Enable project compilation */
-    // "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
-    // "removeComments": true,                      /* Do not emit comments to output. */
-    // "noEmit": true,                              /* Do not emit outputs. */
-    // "importHelpers": true,                       /* Import emit helpers from 'tslib'. */
-    // "downlevelIteration": true,                  /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-    // "isolatedModules": true,                     /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-
-    /* Strict Type-Checking Options */
-    "strict": true /* Enable all strict type-checking options. */,
-    // "noImplicitAny": true,                       /* Raise error on expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,                    /* Enable strict null checks. */
-    // "strictFunctionTypes": true,                 /* Enable strict checking of function types. */
-    // "strictBindCallApply": true,                 /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
-    // "strictPropertyInitialization": true,        /* Enable strict checking of property initialization in classes. */
-    // "noImplicitThis": true,                      /* Raise error on 'this' expressions with an implied 'any' type. */
-    // "alwaysStrict": true,                        /* Parse in strict mode and emit "use strict" for each source file. */
-
-    /* Additional Checks */
-    // "noUnusedLocals": true,                      /* Report errors on unused locals. */
-    // "noUnusedParameters": true,                  /* Report errors on unused parameters. */
-    // "noImplicitReturns": true,                   /* Report error when not all code paths in function return a value. */
-    // "noFallthroughCasesInSwitch": true,          /* Report errors for fallthrough cases in switch statement. */
-    // "noUncheckedIndexedAccess": true,            /* Include 'undefined' in index signature results */
-    // "noImplicitOverride": true,                  /* Ensure overriding members in derived classes are marked with an 'override' modifier. */
-    // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */
-
-    /* Module Resolution Options */
-    // "moduleResolution": "node",                  /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-    // "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
-    // "paths": {},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-    // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                             /* List of folders to include type definitions from. */
-    // "types": [],                                 /* Type declaration files to be included in compilation. */
-    // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
-    // "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
-    // "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */
-
-    /* Source Map Options */
-    // "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
-    // "inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
-
-    /* Experimental Options */
-    // "experimentalDecorators": true,              /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,               /* Enables experimental support for emitting type metadata for decorators. */
-
-    /* Advanced Options */
-    "skipLibCheck": true /* Skip type checking of declaration files. */,
-    "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
-  }
-}