12 |
11 |
12 |
17 | 
247 |
--------------------------------------------------------------------------------
/core/__tests__/multiLevelDepthFilter.test.ts:
--------------------------------------------------------------------------------
1 | import { Querier } from '../orbiter';
2 |
3 | /**
4 | * ====================================
5 | * 🧪🔬 TEST OF MLDF WORKER🩺🧫
6 | * ====================================
7 | */
8 | describe('🟡 Testing Querier.filterComplexArray() ...', () => {
9 | it('should filter a Multi Level Depth array of objects by custom predicates', () => {
10 | const products = [
11 | { name: 'A', color: 'Blue', size: 50, locations: ['USA', 'Europe'], details: { length: 20, width: 70 } },
12 | { name: 'B', color: 'Blue', size: 60, locations: [], details: { length: 20, width: 70 } },
13 | { name: 'C', color: 'Black', size: 70, locations: ['Japan'], details: { length: 20, width: 71 } },
14 | { name: 'D', color: 'Green', size: 50, locations: ['USA'], details: { length: 20, width: 71 } },
15 | ];
16 |
17 | /**
18 | * Exemple One Of Filters Possibility.
19 | * You can choose one Of Those to Test with.
20 | */
21 | const filters = {
22 | size: (size: number) => size === 50 || size === 70,
23 | color: (color: string) => ['blue', 'black'].includes(color.toLowerCase()),
24 | locations: (locations: any[]) => locations.find((x: string) => ['JAPAN', 'USA'].includes(x.toUpperCase())),
25 | details: (details: { length: number; width: number }) => details.length < 30 && details.width >= 70,
26 | };
27 |
28 | /**
29 | * Exemple Two Of Filters Possibility.
30 | * You can choose one Of Those to Test with.
31 | */
32 | const filters2 = {
33 | size: (size: number) => size === 50 || size === 70,
34 | color: (color: string) => ['blue', 'black'].includes(color.toLowerCase()),
35 | details: (details: { length: number; width: number }) => details.length < 30 && details.width >= 70,
36 | locations: (locations: string | string[]) => {
37 | if (locations.includes('USA')) return true; // case sensitive
38 | if (locations.includes('Japan')) return true; // case sensitive
39 |
40 | const url = window.location.pathname.toLowerCase();
41 | if (url.includes('/en-us/')) return true; // not case sensitive
42 | if (url.includes('/es/')) return true; // not case sensitive
43 | return false;
44 | },
45 | };
46 |
47 | // Data Extraction using Filters
48 | const filtered = Querier.filterComplexArray(products, filters);
49 |
50 | const expected = [
51 | { name: 'A', color: 'Blue', size: 50, locations: ['USA', 'Europe'], details: { length: 20, width: 70 } },
52 | { name: 'C', color: 'Black', size: 70, locations: ['Japan'], details: { length: 20, width: 71 } },
53 | ];
54 | expect(filtered).toStrictEqual(expected);
55 | });
56 | });
57 |
--------------------------------------------------------------------------------
/core/__tests__/oneLevelDepthFilter.test.ts:
--------------------------------------------------------------------------------
1 | import { Querier } from '../orbiter';
2 |
3 | /**
4 | * ====================================
5 | * 🧪🔬 TEST OF OLDF WORKER🩺🧫
6 | * ====================================
7 | */
8 | describe('🟡 Testing Querier.filterSimpleArray() ...', () => {
9 | it('should filter an array of objects with one level-depth', () => {
10 | const products = [
11 | { name: 'A', color: 'Blue', size: 50 },
12 | { name: 'B', color: 'Blue', size: 60 },
13 | { name: 'C', color: 'Black', size: 70 },
14 | { name: 'D', color: 'Green', size: 50 },
15 | ];
16 |
17 | const filters = {
18 | color: ['BLUE', 'black'],
19 | size: [70, 50],
20 | };
21 |
22 | // Data Extraction using Filters
23 | const filtered = Querier.filterSimpleArray(products, filters);
24 |
25 | const expected = [
26 | { name: 'A', color: 'Blue', size: 50 },
27 | { name: 'C', color: 'Black', size: 70 },
28 | ];
29 | expect(filtered).toStrictEqual(expected);
30 | });
31 | });
32 |
--------------------------------------------------------------------------------
/core/orbiter.ts:
--------------------------------------------------------------------------------
1 | import { ComplexFilter } from './workers/multiLevelDepthFilter';
2 | import { SimpleFilter } from './workers/oneLevelDepthFilter';
3 |
4 | // 🟢💻 WELCOME TO THE SPACESHIP - DEVELOPED BY 💻🟢
5 | // ██████╗ ██████╗ ██████╗ ██╗████████╗ ████████╗██╗ ██╗██████╗ ███╗ ██╗███████╗██████╗
6 | // ██╔═══██╗██╔══██╗██╔══██╗██║╚══██╔══╝ ╚══██╔══╝██║ ██║██╔══██╗████╗ ██║██╔════╝██╔══██╗
7 | // ██║ ██║██████╔╝██████╔╝██║ ██║ ██║ ██║ ██║██████╔╝██╔██╗ ██║█████╗ ██████╔╝
8 | // ██║ ██║██╔══██╗██╔══██╗██║ ██║ ██║ ██║ ██║██╔══██╗██║╚██╗██║██╔══╝ ██╔══██╗
9 | // ╚██████╔╝██║ ██║██████╔╝██║ ██║ ██║ ╚██████╔╝██║ ██║██║ ╚████║███████╗██║ ██║
10 | // ╚═════╝ ╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝╚═╝ ╚═══╝╚══════╝╚═╝ ╚═╝
11 | // 💚🔰 KEEP GOING FURTHER 🔰💚
12 | /**
13 | * 💨 Project Name : Array-Querier
14 | * 💨 Project Repo : https://github.com/orbitturner/array-querier
15 | * 💨 My GitHub : https://github.com/orbitturner
16 | * 💨 My LinkedIn : https://linkedin.com/in/orbitturner
17 | * 💨 My Twitter : https://twitter.com/orbitturner
18 | */
19 |
20 | /**
21 | * Filters an array of objects with multiple match-criteria.
22 | * Choose One of the available function depending on your array composition.
23 | *
24 | * @see -> https://github.com/orbitturner/array-querier
25 | * @exports {filterSimpleArray, filterComplexArray}
26 | */
27 | export class Querier {
28 | /**
29 | * Filters an array of objects (one level-depth) with multiple criteria.
30 | * The function returns an array of the same type as the input array.
31 | *
32 | * @param array -> The Array of JSON Object to filter.
33 | * @param filters -> An object with all the filter criteria you want.
34 | * @returns {Array} -> Filtered Data Array.
35 | */
36 | public static filterSimpleArray(array: any[], filters: { [x: string]: any[] }): any[] {
37 | return SimpleFilter.oneLevelDepthFilter(array, filters);
38 | }
39 |
40 | /**
41 | * Filters a multi Level Depth array of objects using custom predicates.
42 | *
43 | * @param {Array} -> The Array of JSON Object to filter.
44 | * @param {Object} -> An object with all the filter criteria you want.
45 | * @return {Array} -> Filtered Data Array.
46 | */
47 | public static filterComplexArray(array: any[], filters: { [x: string]: (arg0: any) => any }): any[] {
48 | return ComplexFilter.multiLevelDepthFilter(array, filters);
49 | }
50 | }
51 |
52 | // export } as Querier;
53 |
--------------------------------------------------------------------------------
/core/workers/multiLevelDepthFilter.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * =============================================
3 | * 🧱 Multi Level Depth Array Worker Class. 🧱
4 | * =============================================
5 | */
6 | export class ComplexFilter {
7 | /**
8 | * Filters a multi Level Depth array of objects using custom predicates.
9 | *
10 | * @param {Array} -> The Array of JSON Object to filter.
11 | * @param {Object} -> An object with all the filter criteria you want.
12 | * @return {Array} -> Filtered Data Array.
13 | */
14 | public static multiLevelDepthFilter(array: any[], filters: { [x: string]: (arg0: any) => any }) {
15 | const filterKeys = Object.keys(filters);
16 | return array.filter((item: { [x: string]: any }) => {
17 | // validates all filter criteria
18 | return filterKeys.every((key) => {
19 | // ignores non-function predicates
20 | if (typeof filters[key] !== 'function') return true;
21 | return filters[key](item[key]);
22 | });
23 | });
24 | }
25 | }
26 |
--------------------------------------------------------------------------------
/core/workers/oneLevelDepthFilter.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * ==========================================
3 | * 🔹 One Level Depth Array Worker Class. 🔹
4 | * ==========================================
5 | */
6 | export class SimpleFilter {
7 | // =================================================
8 | // ignores case-sensitive for Array Filter
9 | private static getValue = (value: string) => (typeof value === 'string' ? value.toUpperCase() : value);
10 | // =================================================
11 |
12 | /**
13 | * Filters an array of objects (one level-depth) with multiple criteria.
14 | * The function returns an array of the same type as the input array.
15 | *
16 | * @param array -> The Array of JSON Object to filter.
17 | * @param filters -> An object with all the filter criteria you want.
18 | * @returns {Array} -> Filtered Data Array.
19 | */
20 | public static oneLevelDepthFilter(array: any[], filters: { [x: string]: any[] }): any[] {
21 | const filterKeys = Object.keys(filters);
22 | return array.filter((item) => {
23 | // validates all filter criteria
24 | return filterKeys.every((key) => {
25 | // ignores an empty filter
26 | if (!filters[key].length) {
27 | return true;
28 | }
29 | return filters[key].find((filter) => this.getValue(filter) === this.getValue(item[key]));
30 | });
31 | });
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/jestconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "transform": {
3 | "^.+\\.(t|j)sx?$": "ts-jest"
4 | },
5 | "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
6 | "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"]
7 | }
--------------------------------------------------------------------------------
/orbit.md:
--------------------------------------------------------------------------------
1 | // 🟢💻 WELCOME TO THE SPACESHIP - DEVELOPED BY 💻🟢
2 | // ██████╗ ██████╗ ██████╗ ██╗████████╗ ████████╗██╗ ██╗██████╗ ███╗ ██╗███████╗██████╗
3 | // ██╔═══██╗██╔══██╗██╔══██╗██║╚══██╔══╝ ╚══██╔══╝██║ ██║██╔══██╗████╗ ██║██╔════╝██╔══██╗
4 | // ██║ ██║██████╔╝██████╔╝██║ ██║ ██║ ██║ ██║██████╔╝██╔██╗ ██║█████╗ ██████╔╝
5 | // ██║ ██║██╔══██╗██╔══██╗██║ ██║ ██║ ██║ ██║██╔══██╗██║╚██╗██║██╔══╝ ██╔══██╗
6 | // ╚██████╔╝██║ ██║██████╔╝██║ ██║ ██║ ╚██████╔╝██║ ██║██║ ╚████║███████╗██║ ██║
7 | // ╚═════╝ ╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝╚═╝ ╚═══╝╚══════╝╚═╝ ╚═╝
8 | // 💚🔰 KEEP GOING FURTHER 🔰💚
9 | /**
10 | * 💨 Project Name : Array-Querier
11 | * 💨 Project Repo : https://github.com/orbitturner/array-querier
12 | * 💨 My GitHub : https://github.com/orbitturner
13 | * 💨 My LinkedIn : https://linkedin.com/in/orbitturner
14 | * 💨 My Twitter : https://twitter.com/orbitturner
15 | */
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "array-querier",
3 | "version": "1.2.1",
4 | "description": "A TS/JS NPM Package to Filter an array of objects with multiple match-criteria.",
5 | "main": "index.js",
6 | "scripts": {
7 | "test": "jest --config jestconfig.json",
8 | "build": "tsc",
9 | "format": "prettier --write \"core/**/*.ts\"",
10 | "lint": "tslint -p tsconfig.json",
11 | "prepublishOnly": "npm test",
12 | "prepare": "npm run build",
13 | "preversion": "npm run lint",
14 | "xversion": "npm run format && npm --no-git-tag-version version patch",
15 | "gitupdate": "git add . && git commit -m \"🟢 RELEASING V %npm_package_version% ✨\" && git push --tags ",
16 | "release": "npm run xversion && npm run gitupdate && npm publish"
17 | },
18 | "repository": {
19 | "type": "git",
20 | "url": "git+https://github.com/orbitturner/array-querier.git"
21 | },
22 | "keywords": [
23 | "Array Filter",
24 | "Array Query",
25 | "Query",
26 | "Filter",
27 | "orbitturner"
28 | ],
29 | "author": "Orbit Turner",
30 | "license": "MIT",
31 | "bugs": {
32 | "url": "https://github.com/orbitturner/array-querier/issues"
33 | },
34 | "homepage": "https://github.com/orbitturner/array-querier#readme",
35 | "devDependencies": {
36 | "@types/jest": "^26.0.22",
37 | "jest": "^26.6.3",
38 | "prettier": "^2.2.1",
39 | "ts-jest": "^26.5.4",
40 | "tslint": "^6.1.3",
41 | "tslint-config-prettier": "^1.18.0",
42 | "typescript": "^4.2.3"
43 | },
44 | "files": [
45 | "lib/**/*"
46 | ]
47 | }
48 |
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "target": "es6",
4 | "module": "commonjs",
5 | "declaration": true,
6 | "outDir": "./lib",
7 | "strict": true
8 | },
9 | "include": ["core"],
10 | "exclude": ["node_modules", "**/__tests__/*"]
11 | }
--------------------------------------------------------------------------------
/tslint.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": ["tslint:recommended", "tslint-config-prettier"]
3 | }
--------------------------------------------------------------------------------