@promoboxx/use-filter 1.0.3 → 1.0.4

package/Makefile

@@ -1,31 +0,0 @@
-all: test
-
-prepare-env:
-ifeq ($(CI),true)
-	npm ci --ignore-scripts
-else
-	npm install
-endif
-
-prepare-when-local:
-ifneq ($(CI),true)
-	$(MAKE) prepare-env
-endif
-
-build: prepare-when-local
-	rm -rf dist/
-	npx tsc
-
-test: prepare-when-local
-ifeq ($(CI),true)
-	npx jest --ci
-else
-	npx jest --watch
-endif
-
-deploy:
-ifeq ($(GITHUB_REF),refs/heads/main)
-	npx standard-version
-	git push origin --tags HEAD
-	npm publish
-endif

package/jest.config.js

@@ -1,196 +0,0 @@
-/*
- * For a detailed explanation regarding each configuration property and type check, visit:
- * https://jestjs.io/docs/configuration
- */
-
-const config = {
-  // All imported modules in your tests should be mocked automatically
-  // automock: false,
-
-  // Stop running tests after `n` failures
-  // bail: 0,
-
-  // The directory where Jest should store its cached dependency information
-  // cacheDirectory: "/tmp/jest_rs",
-
-  // Automatically clear mock calls and instances between every test
-  clearMocks: true,
-
-  // Indicates whether the coverage information should be collected while executing the test
-  // collectCoverage: false,
-
-  // An array of glob patterns indicating a set of files for which coverage information should be collected
-  // collectCoverageFrom: undefined,
-
-  // The directory where Jest should output its coverage files
-  // coverageDirectory: undefined,
-
-  // An array of regexp pattern strings used to skip coverage collection
-  // coveragePathIgnorePatterns: [
-  //   "/node_modules/"
-  // ],
-
-  // Indicates which provider should be used to instrument code for coverage
-  coverageProvider: 'v8',
-
-  // A list of reporter names that Jest uses when writing coverage reports
-  // coverageReporters: [
-  //   "json",
-  //   "text",
-  //   "lcov",
-  //   "clover"
-  // ],
-
-  // An object that configures minimum threshold enforcement for coverage results
-  // coverageThreshold: undefined,
-
-  // A path to a custom dependency extractor
-  // dependencyExtractor: undefined,
-
-  // Make calling deprecated APIs throw helpful error messages
-  // errorOnDeprecated: false,
-
-  // Force coverage collection from ignored files using an array of glob patterns
-  // forceCoverageMatch: [],
-
-  // A path to a module which exports an async function that is triggered once before all test suites
-  // globalSetup: undefined,
-
-  // A path to a module which exports an async function that is triggered once after all test suites
-  // globalTeardown: undefined,
-
-  // A set of global variables that need to be available in all test environments
-  // globals: {},
-
-  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
-  // maxWorkers: "50%",
-
-  // An array of directory names to be searched recursively up from the requiring module's location
-  // moduleDirectories: [
-  //   "node_modules"
-  // ],
-
-  // An array of file extensions your modules use
-  // moduleFileExtensions: [
-  //   "js",
-  //   "jsx",
-  //   "ts",
-  //   "tsx",
-  //   "json",
-  //   "node"
-  // ],
-
-  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
-  // moduleNameMapper: {},
-
-  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
-  // modulePathIgnorePatterns: [],
-
-  // Activates notifications for test results
-  // notify: false,
-
-  // An enum that specifies notification mode. Requires { notify: true }
-  // notifyMode: "failure-change",
-
-  // A preset that is used as a base for Jest's configuration
-  preset: 'ts-jest/presets/js-with-ts',
-
-  // Run tests from one or more projects
-  // projects: undefined,
-
-  // Use this configuration option to add custom reporters to Jest
-  // reporters: undefined,
-
-  // Automatically reset mock state between every test
-  // resetMocks: false,
-
-  // Reset the module registry before running each individual test
-  // resetModules: false,
-
-  // A path to a custom resolver
-  // resolver: undefined,
-
-  // Automatically restore mock state between every test
-  // restoreMocks: false,
-
-  // The root directory that Jest should scan for tests and modules within
-  // rootDir: undefined,
-
-  // A list of paths to directories that Jest should use to search for files in
-  // roots: [
-  //   "<rootDir>"
-  // ],
-
-  // Allows you to use a custom runner instead of Jest's default test runner
-  // runner: "jest-runner",
-
-  // The paths to modules that run some code to configure or set up the testing environment before each test
-  // setupFiles: [],
-
-  // A list of paths to modules that run some code to configure or set up the testing framework before each test
-  // setupFilesAfterEnv: [],
-
-  // The number of seconds after which a test is considered as slow and reported as such in the results.
-  // slowTestThreshold: 5,
-
-  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
-  // snapshotSerializers: [],
-
-  // The test environment that will be used for testing
-  testEnvironment: 'jsdom',
-
-  // Options that will be passed to the testEnvironment
-  // testEnvironmentOptions: {},
-
-  // Adds a location field to test results
-  // testLocationInResults: false,
-
-  // The glob patterns Jest uses to detect test files
-  // testMatch: [
-  //   "**/__tests__/**/*.[jt]s?(x)",
-  //   "**/?(*.)+(spec|test).[tj]s?(x)"
-  // ],
-
-  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-  // testPathIgnorePatterns: [
-  //   "/node_modules/"
-  // ],
-
-  // The regexp pattern or array of patterns that Jest uses to detect test files
-  // testRegex: [],
-
-  // This option allows the use of a custom results processor
-  // testResultsProcessor: undefined,
-
-  // This option allows use of a custom test runner
-  // testRunner: "jest-circus/runner",
-
-  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
-  // testURL: "http://localhost",
-
-  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
-  // timers: "real",
-
-  // A map from regular expressions to paths to transformers
-  // transform: undefined,
-
-  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
-  // transformIgnorePatterns: [
-  //   "/node_modules/",
-  //   "\\.pnp\\.[^\\/]+$"
-  // ],
-
-  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
-  // unmockedModulePathPatterns: undefined,
-
-  // Indicates whether each individual test should be reported during the run
-  verbose: true,
-
-  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
-  // watchPathIgnorePatterns: [],
-
-  // Whether to use watchman for file crawling
-  // watchman: true,
-}
-
-module.exports = config

package/prettier.config.js

@@ -1 +0,0 @@
-module.exports = require('@promoboxx/eslint-config/prettier.config')

package/src/lib/buildDefaultFilterInfo.ts

@@ -1,35 +0,0 @@
-import { FilterInfo } from '../useFilter'
-
-import getOffsetFromPage from './getOffsetFromPage'
-import getPageFromOffset from './getPageFromOffset'
-
-function buildDefaultFilterInfo<T>(
-  filterInfo: Partial<FilterInfo<T>> = {},
-): FilterInfo<T> {
-  const merged: FilterInfo<T> = {
-    // Cast here to work around "'T' could be instantiated with an arbitrary
-    // type which could be unrelated to '{}'"
-    filter: {} as T,
-
-    sort: undefined,
-    pageSize: 20,
-    lastRefreshAt: new Date().getTime(),
-    totalResults: 1,
-    totalPages: 1,
-    offset: 0,
-    page: 1,
-    ...filterInfo,
-  }
-
-  // If there's a page but no offset, set the offset.
-  if (filterInfo.page != null && filterInfo.offset == null) {
-    merged.offset = getOffsetFromPage(filterInfo.page, merged.pageSize)
-    // If there's an offset but no page, set the page.
-  } else if (filterInfo.page == null && filterInfo.offset != null) {
-    merged.page = getPageFromOffset(filterInfo.offset, merged.pageSize)
-  }
-
-  return merged
-}
-
-export default buildDefaultFilterInfo

package/src/lib/getOffsetFromPage.ts

@@ -1,5 +0,0 @@
-function getOffsetFromPage(page: number, pageSize: number) {
-  return pageSize * (page - 1)
-}
-
-export default getOffsetFromPage

package/src/lib/getPageFromOffset.ts

@@ -1,5 +0,0 @@
-function getPageFromOffset(offset: number, pageSize: number) {
-  return Math.floor(offset / pageSize) + 1
-}
-
-export default getPageFromOffset

package/src/lib/shallowEqual.test.ts

@@ -1,71 +0,0 @@
-import shallowEqual from './shallowEqual'
-
-describe('shallowEqual', () => {
-  it('should return true if arguments fields are equal', () => {
-    expect(
-      shallowEqual({ a: 1, b: 2, c: undefined }, { a: 1, b: 2, c: undefined }),
-    ).toBe(true)
-
-    expect(shallowEqual({ a: 1, b: 2, c: 3 }, { a: 1, b: 2, c: 3 })).toBe(true)
-
-    const o = {}
-    expect(shallowEqual({ a: 1, b: 2, c: o }, { a: 1, b: 2, c: o })).toBe(true)
-
-    const d = function () {
-      return 1
-    }
-    expect(shallowEqual({ a: 1, b: 2, c: o, d }, { a: 1, b: 2, c: o, d })).toBe(
-      true,
-    )
-  })
-
-  it('should return false if arguments fields are different function identities', () => {
-    expect(
-      shallowEqual(
-        {
-          a: 1,
-          b: 2,
-          d() {
-            return 1
-          },
-        },
-        {
-          a: 1,
-          b: 2,
-          d() {
-            return 1
-          },
-        },
-      ),
-    ).toBe(false)
-  })
-
-  it('should return false if first argument has too many keys', () => {
-    expect(shallowEqual({ a: 1, b: 2, c: 3 }, { a: 1, b: 2 })).toBe(false)
-  })
-
-  it('should return false if second argument has too many keys', () => {
-    expect(shallowEqual({ a: 1, b: 2 }, { a: 1, b: 2, c: 3 })).toBe(false)
-  })
-
-  it('should return false if arguments have different keys', () => {
-    expect(
-      shallowEqual({ a: 1, b: 2, c: undefined }, { a: 1, bb: 2, c: undefined }),
-    ).toBe(false)
-  })
-
-  it('should compare two NaN values', () => {
-    expect(shallowEqual(NaN, NaN)).toBe(true)
-  })
-
-  it('should compare empty objects, with false', () => {
-    expect(shallowEqual({}, false)).toBe(false)
-    expect(shallowEqual(false, {})).toBe(false)
-    expect(shallowEqual([], false)).toBe(false)
-    expect(shallowEqual(false, [])).toBe(false)
-  })
-
-  it('should compare two zero values', () => {
-    expect(shallowEqual(0, 0)).toBe(true)
-  })
-})

package/src/lib/shallowEqual.ts

@@ -1,26 +0,0 @@
-const shallowEqual = (objA: any, objB: any) => {
-  if (Object.is(objA, objB)) {
-    return true
-  }
-
-  if (typeof objA !== 'object' || !objA || typeof objB !== 'object' || !objB) {
-    return false
-  }
-
-  const keysA = Object.keys(objA)
-  const keysB = Object.keys(objB)
-
-  if (keysA.length !== keysB.length) {
-    return false
-  }
-
-  for (const key of keysA) {
-    if (!Object.is(objA[key], objB[key])) {
-      return false
-    }
-  }
-
-  return true
-}
-
-export default shallowEqual

package/src/store/index.ts

@@ -1,21 +0,0 @@
-import { FilterInfo } from '../useFilter'
-
-export interface FilterStore {
-  getFilter(namespace: string): FilterInfo<any> | null | undefined
-  saveFilter(namespace: string, filter: FilterInfo<any>): void
-  clear(): void
-}
-
-let store: FilterStore | undefined
-
-export function setFilterStore(newStore: FilterStore) {
-  store = newStore
-}
-
-export function getFilterStore() {
-  if (!store) {
-    throw new Error('A store must be set with setFilterStore')
-  }
-
-  return store
-}

package/src/store/memoryStore.ts

@@ -1,19 +0,0 @@
-import { FilterInfo } from '../useFilter'
-
-import { FilterStore } from '.'
-
-let filters: Record<string, FilterInfo<any>> = {}
-
-const memoryStore: FilterStore = {
-  getFilter(namespace) {
-    return filters[namespace]
-  },
-  saveFilter(namespace, filter) {
-    filters[namespace] = filter
-  },
-  clear() {
-    filters = {}
-  },
-}
-
-export default memoryStore