aykutkardas / json-function

It allows you to use methods such as schema, innerJoin, where, limit, select, orderBy on JSON data.

Json Function

Documentation • Changelog

Lets you use where, limit, select, orderBy, and more in JSON data.

Install

npm install json-function

or

yarn add json-function

Usage

JsonFunction • documentation

Json-Function provides a lot of useful functions especially for your json data. It contains the methods you need too much to eliminate unnecessary code repetition.

You can use the Json-Function methods separately, but it is possible to use them all together. You can also chain it.

Chaining

import JsonFunction from "json-function";

const result = JsonFunction
  .where({ completed: false })
  .select(["title", "completed"])
  .orderBy("title", "DESC")
  .limit(2)
  .get(data);

or Basic

import JsonFunction from "json-function";

JsonFunction.where({ completed: false });
JsonFunction.select(["title", "completed"]);
JsonFunction.orderBy("title", "DESC");
JsonFunction.limit(2);
const result = JsonFunction.get(data);

or create a query and use it at any time.

const queryTwoIncompleteTasks = JsonFunction
  .where({ completed: false })
  .select(["title", "completed"])
  .limit(2)
  .getQuery();
  

Query usage

JsonFunction.setQuery(queryTwoIncompleteTasks).get(data);
// or
JsonFunction.get(data, { query: queryTwoIncompleteTasks });

Methods

Instead of an entire "class", you can use only the methods you need.

innerJoin • documentation

The "innerJoin" function is used to join two arrays.

import { innerJoin } from "json-function";

innerJoin(data, data2, "id", "userId");

schema • documentation

The "Schema" function is a great way to reconfigure your json data and make it your own.

import { schema } from "json-function";

schema(data, {
  book: {
    id: "id",
    title: "title"
  },
  firstname: "user.firstname",
  lastname: "user.lastname"
});

Use "callback" for advanced conversions.

schema(data, (sc) => ({
  id: "id",
  fullName: sc.join("user.firstname", "user.lastname")
}));

Custom separator

schema(data, (sc) => ({
  id: "id",
  fullName: sc.join("user.firstname", "user.lastname", { separator: "_" })
}));

Use your own special function.

schema(data, (sc) => ({
  id: "id",
  fullName: sc.custom(
    (firstname, lastname) => `${firstname.toUpperCase()} ${lastname.toUpperCase()}`,
    "user.firstname",
    "user.lastname"
  ),
}))

Example

schema(data, (sc) => ({
  id: "id",
  createdAt: sc.custom(
    (createdAt) => moment(createdAt).format("DD/MM/YYYY"),
    "createdAt",
  ),
}))

where • documentation • samples

The "Where" function provides a comfortable method for filtering a json data.

import { where } from "json-function";

// Single
// (completed === false)
where(data, { completed: false });

// Multiple (or)
// (completed === false || userId === 2)
where(data, [{ completed: false }, { userId: 2 }]);

// Deep
// (address.city === "New York")
where(data, { "address.city": "New York" }, { deep: true });

Use "callback" for advanced filter.

// id <= 3
where(data, (wh) => ({
  id: wh.lte(3),
}));

Other wh methods.

wh.lte(3)             // value <= 3
wh.lt(3)              // value <  3
wh.gte(3)             // value >= 3
wh.gt(3)              // value >  3
wh.between(3,5)       // value >= 3 && value <= 5
wh.eq("3")            // value == 3
wh.ne("3")            // value != 3
wh.in("test")         // value.includes("test")
wh.nin("test")        // !value.includes("test")
wh.oneOf([1, 2, 3])  // [1, 2, 3].includes(value)

select • documentation

The "Select" function is a practical method where you only get the desired fields of a json data.

import { select } from "json-function";

// Single
select(data, "title");

// Multiple
select(data, ["title", "completed"]);

limit • documentation

"Limit" is used to get a limited number of elements from a json data. Almost javascript works like slice() but it is much easier and clearer.

import { limit } from "json-function";

// limit
limit(data, 2);

// limit and Start
limit(data, 2, 2);

orderBy • documentation

With the "orderBy" function you can reorder the data in your json array.

import { orderBy } from "json-function";

orderBy(data, "title", "DESC");

orderBy(data, "user.firstname", "DESC", { deep: true });

search • documentation

Search over fields of objects.

import { search } from "json-function";

// Syntax: search(data: Object[], key: any, fields: string | string[], options?);

// single field
search(data, "key", "description");

// multiple field
search(data, "key", ["user.firstName", "description"]);

// case sensitive
search(data, "key", "description", { caseSensitive: false });

toArray • documentation

Converts objects into meaningful sequences.

import { toArray } from "json-function";

// default key "uid"
toArray(data);

// custom key
toArray(data, { key: "_id_" });

transform • documentation

JSON converts the snake_case keys in your data to camelCase.

import { transform } from "json-function";

transform(data);

json-function's Issues

Any plans to provide OR condition is this possible JsonFunction.where with deep:true?

Any plans to provide OR condition in JsonFunction.where((wh) => ...) with deep:true?

const data = [ { id: 1, metaData: { field1: "bobby", field2: 2 } }];

is this possible JsonFunction.where((wh) => ( [ {'metaData.field1': 'aa'}, {'metaData.field2': 2} ], {deep:true} ));

Note: why do we need to pass {deep: true} in where, orderBy etc? Can't we find it based on the key value, like if it has dot (e.g. metaData.field1) then enable deep automatically?

Alias `.get` to `.from`

That way it is more similar to SQL.

[PERF] too many loops inside where

Hi,

I've noticed a performance problem for where utility. There are many loops :

• a loop to add UNIQUE_IDX_KEY for each query object

  Json-Function/src/package/where/index.ts

  Lines 53 to 58 in 032bc2e

  	let temp = data.map((item, index) => {
  	if (!item[UNIQUE_IDX_KEY]) {
  	item[UNIQUE_IDX_KEY] = index
  	}
  	return item;
  	});

• a loop to filter data

  Json-Function/src/package/where/index.ts

  Lines 61 to 74 in 032bc2e

  	temp = temp.filter((item) => {
  	let value = item[fieldName];
  	const activeQuery = query[fieldName];
  	if (options && options.deep) {
  	value = getObjDeepProp(fieldName)(item);
  	}
  	if (isFunction(activeQuery)) {
  	return activeQuery(value);
  	}
  	return value === activeQuery;
  	});

• a loop to contruct the result array

  Json-Function/src/package/where/index.ts

  Lines 77 to 81 in 032bc2e

  	temp.forEach((tempItem) => {
  	if (!isAlreadyDefine(result, tempItem)) {
  	result.push(tempItem);
  	}
  	});

• a loop to remove UNIQUE_IDX_KEY from the result array

  Json-Function/src/package/where/index.ts

  Lines 84 to 87 in 032bc2e

  	return result.map((item) => {
  	delete item[UNIQUE_IDX_KEY];
  	return item;
  	});

IMO, you only need 1 loop to filter the data and return the result

Advanced "where" methods do not work correctly for more than one query.

where(data, [{ id: 1 }, { id: 2 }]) // It's work.

where(data, wh => [{ id: 1 }, { id: 2 }]) // Not working!

where(data, wh => [{ id: wh.eq(1) }, { id: wh.eq(2) }]) // Not working!

Not able import and use search function

Not able import and use search function. Also documentation link not available.

https://worn.gitbook.io/json-function/functions/search

Version: 1.8.18

Is it possible to provide wh.inArray(['ABC','XYZ']) and wh.inArray([21,22])?

Is it possible to provide a functionality like wh.inArray(['ABC','XYZ']) and wh.inArray([21,22]) and .notInArray also?

Select & Schema

Hi,

I've read the source code, and have noticed that select is a simpler form of schema, where :

'fieldname' => { "fieldname": "fieldname" }

['field1', 'field2', ...] => { "field1": "field1", "field2": "field2", ... }

IMO, it needs some refactoring !!

Module not found: Error: Can't resolve 'json-function'

When using the latest version (1.8.16) getting Module not found: Error: Can't resolve 'json-function' issues.
import JsonFunction from 'json-function';
import { where } from 'json-function';
Tries to import in both ways but no luck. But works in version 1.8.14. Anything i am missing here.

Thank You!

Is there any possibility to do deep orderby?

Is there any possibility to do deep orderby?
const data = [{ id: 3, userId: 2, title: "delectus aut autem", metadata: {field1: 'bb', field2: 'btest'} }, { id: 2, userId: 1, title: "lorem ipsum", metadata: {field1: 'aa', field2: 'atest'} }];
orderBy(data, "metadata.field1", "ASC");

Its a awesome library, which reduces most of my time and code. 👍
Thank you in advance!

Performance issue in where with 40k objects

There is a performance issue when we use wh.in('') on array which has 40k objects in it. It takes 7 seconds to respond.

Getting undefined error when field is missing for wh.in condition

Getting the below error when field name is missing or value is null when we use wh.in(). But the same error not occurring to wh.eq()

Uncaught (in promise): TypeError: Cannot read property 'includes' of undefined

[PERF] processes priority order

Hi,

In JsonFunction class, the commands are executed in the definition order, not order of priority.

For example in this code, the order is select -> where -> orderBy -> limit

JsonFunction
  .select(["title", "completed"])
  .where({ owner: "John" })
  .orderBy("title")
  .limit(2)

but the priority order will be where -> orderBy -> limit -> select

select and schema are the lesser priority command, in case where returns nothing, select should process nothing too.