gridify-client 2.0.0-preview.2 → 2.0.0-preview.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +59 -0
- package/dist/index.cjs.js +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.esm.js +1 -1
- package/dist/index.umd.js +1 -1
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# Gridify (A Modern Dynamic LINQ library)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
[](https://www.nuget.org/packages/Gridify/)
|
|
8
|
+
|
|
9
|
+
[](https://www.fuget.org/packages/Gridify)
|
|
10
|
+
[](https://alirezanet.github.io/Gridify/)
|
|
11
|
+
[](https://discord.gg/jaSXnDMv)
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
[](https://alirezanet.github.io/Gridify/)
|
|
17
|
+
|
|
18
|
+
## Introduction
|
|
19
|
+
Gridify is a dynamic LINQ library that simplifies the process of converting strings to LINQ queries. With exceptional performance and ease-of-use, Gridify makes it effortless to apply filtering, sorting, and pagination using text-based data.
|
|
20
|
+
|
|
21
|
+
## Features
|
|
22
|
+
|
|
23
|
+
- Fast and easy to use
|
|
24
|
+
- Supports filtering, sorting, and pagination
|
|
25
|
+
- Supports `string` to LINQ conversion
|
|
26
|
+
- Supports nested queries and sub-collections
|
|
27
|
+
- Supports `string` to `object` mapping
|
|
28
|
+
- Supports query compilation
|
|
29
|
+
- Supports collection indexes
|
|
30
|
+
- Custom Operators
|
|
31
|
+
- Compatible with ORMs, especially Entity Framework
|
|
32
|
+
- Can be used on every collection that LINQ supports
|
|
33
|
+
- Compatible with object-mappers like AutoMapper
|
|
34
|
+
- Compatible with Elasticsearch 🔥🔥
|
|
35
|
+
|
|
36
|
+
## Documentation
|
|
37
|
+
|
|
38
|
+
Check out our docs at [https://alirezanet.github.io/Gridify/](https://alirezanet.github.io/Gridify/).
|
|
39
|
+
|
|
40
|
+
## Articles / Examples
|
|
41
|
+
- [Using Gridify in the api controllers](https://alirezanet.github.io/Gridify/example/api-controller.html#using-gridify-in-api-controllers)
|
|
42
|
+
- [Trabajando con filtros dinámicos usando Gridify en .NET](https://henriquemauri.net/trabalhando-com-filtros-dinamicos-utilizando-o-gridify-no-net/) by [@Henrique Mauri](https://github.com/hgmauri) (Spanish)
|
|
43
|
+
- [<span dir="rtl" align="right">آشنایی با Gridify</span>](https://www.dntips.ir/post/3345/%d8%a2%d8%b4%d9%86%d8%a7%db%8c%db%8c-%d8%a8%d8%a7-gridify) (Persian)
|
|
44
|
+
- Comming soon
|
|
45
|
+
|
|
46
|
+
## Want to support us?
|
|
47
|
+
|
|
48
|
+
- Don't forget to give a ⭐ to this repo on GitHub!
|
|
49
|
+
- Share your feedback and ideas to improve the library!
|
|
50
|
+
- Share the library on your favorite social media and with your friends!
|
|
51
|
+
- Help us to improve the documentation!
|
|
52
|
+
|
|
53
|
+
## Contribution
|
|
54
|
+
|
|
55
|
+
We welcome contributions! Feel free to send us a pull request. Check out our [Contribution Page](https://alirezanet.github.io/Gridify/contribution) for more information.
|
|
56
|
+
|
|
57
|
+
## License
|
|
58
|
+
|
|
59
|
+
This project is licensed under the [MIT License](https://github.com/alirezanet/gridify/blob/master/LICENSE).
|
package/dist/index.cjs.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var
|
|
1
|
+
(()=>{"use strict";var r,e,t={d:(r,e)=>{for(var o in e)t.o(e,o)&&!t.o(r,o)&&Object.defineProperty(r,o,{enumerable:!0,get:e[o]})},o:(r,e)=>Object.prototype.hasOwnProperty.call(r,e),r:r=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(r,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(r,"__esModule",{value:!0})}},o={};t.r(o),t.d(o,{ConditionalOperator:()=>r,GridifyQueryBuilder:()=>i,LogicalOperator:()=>e}),function(r){r.Equal="=",r.NotEqual="!=",r.LessThan="<",r.GreaterThan=">",r.GreaterThanOrEqual=">=",r.LessThanOrEqual="<=",r.Contains="*",r.NotContains="!*",r.StartsWith="^",r.NotStartsWith="!^",r.EndsWith="$",r.NotEndsWith="!$"}(r||(r={})),function(r){r.And=",",r.Or="|"}(e||(e={}));const i=class{constructor(){this.query={page:1,pageSize:20,orderBy:"",filter:""},this.filteringExpressions=[]}setPage(r){return this.query.page=r,this}setPageSize(r){return this.query.pageSize=r,this}addOrderBy(r,e=!1){const t=`${r.trim()} ${e?"desc":""}`.trim();return this.query.orderBy=this.query.orderBy?`${this.query.orderBy}, ${t}`:t,this}addCondition(r,e,t,o=!0,i=!0){let n=t;i&&"string"==typeof t&&(n=t.replace(/([(),|]|\/i)/g,"\\$1")),n=o?n.toString():`${n.toString()}/i`;var s=`${r.trim()}${e}${n}`;return this.filteringExpressions.push({value:s,type:"filter"}),this}startGroup(){return this.filteringExpressions.push({value:"(",type:"startGroup"}),this}endGroup(){return this.filteringExpressions.push({value:")",type:"endGroup"}),this}and(){return this.filteringExpressions.push({value:e.And,type:"op"}),this}or(){return this.filteringExpressions.push({value:e.Or,type:"op"}),this}build(){let r=null,e=0;if(this.filteringExpressions.forEach((t=>{if("startGroup"===t.type&&e++,"endGroup"===t.type&&e--,null===r&&"op"===t.type)throw new Error("expression cannot start with a logical operator");if("filter"===r&&"filter"===t.type)throw new Error("consecutive conditions are not allowed, consider adding a logical operator");if("op"===r&&"op"===t.type)throw new Error("consecutive operators are not allowed, consider adding a filter");if("startGroup"===r&&"op"===t.type)throw new Error("logical operator immediately after startGroup is not allowed");if("endGroup"===r&&"filter"===t.type)throw new Error("Missing logical operator after endGroup");if("startGroup"===r&&"endGroup"===t.type)throw new Error("Empty groups are not allowed");if("endGroup"===r&&"startGroup"===t.type)throw new Error("Missing a logical operator between groups");r=t.type,this.query.filter+=t.value})),0!=e)throw new Error("Group not properly closed");return this.query}};module.exports.GridifyClient=o})();
|
package/dist/index.d.ts
CHANGED
package/dist/index.esm.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var t,
|
|
1
|
+
var r,t,e={d:(r,t)=>{for(var o in t)e.o(t,o)&&!e.o(r,o)&&Object.defineProperty(r,o,{enumerable:!0,get:t[o]})},o:(r,t)=>Object.prototype.hasOwnProperty.call(r,t)},o={};e.d(o,{SQ:()=>r,Fw:()=>i,Fn:()=>t}),function(r){r.Equal="=",r.NotEqual="!=",r.LessThan="<",r.GreaterThan=">",r.GreaterThanOrEqual=">=",r.LessThanOrEqual="<=",r.Contains="*",r.NotContains="!*",r.StartsWith="^",r.NotStartsWith="!^",r.EndsWith="$",r.NotEndsWith="!$"}(r||(r={})),function(r){r.And=",",r.Or="|"}(t||(t={}));const i=class{constructor(){this.query={page:1,pageSize:20,orderBy:"",filter:""},this.filteringExpressions=[]}setPage(r){return this.query.page=r,this}setPageSize(r){return this.query.pageSize=r,this}addOrderBy(r,t=!1){const e=`${r.trim()} ${t?"desc":""}`.trim();return this.query.orderBy=this.query.orderBy?`${this.query.orderBy}, ${e}`:e,this}addCondition(r,t,e,o=!0,i=!0){let s=e;i&&"string"==typeof e&&(s=e.replace(/([(),|]|\/i)/g,"\\$1")),s=o?s.toString():`${s.toString()}/i`;var n=`${r.trim()}${t}${s}`;return this.filteringExpressions.push({value:n,type:"filter"}),this}startGroup(){return this.filteringExpressions.push({value:"(",type:"startGroup"}),this}endGroup(){return this.filteringExpressions.push({value:")",type:"endGroup"}),this}and(){return this.filteringExpressions.push({value:t.And,type:"op"}),this}or(){return this.filteringExpressions.push({value:t.Or,type:"op"}),this}build(){let r=null,t=0;if(this.filteringExpressions.forEach((e=>{if("startGroup"===e.type&&t++,"endGroup"===e.type&&t--,null===r&&"op"===e.type)throw new Error("expression cannot start with a logical operator");if("filter"===r&&"filter"===e.type)throw new Error("consecutive conditions are not allowed, consider adding a logical operator");if("op"===r&&"op"===e.type)throw new Error("consecutive operators are not allowed, consider adding a filter");if("startGroup"===r&&"op"===e.type)throw new Error("logical operator immediately after startGroup is not allowed");if("endGroup"===r&&"filter"===e.type)throw new Error("Missing logical operator after endGroup");if("startGroup"===r&&"endGroup"===e.type)throw new Error("Empty groups are not allowed");if("endGroup"===r&&"startGroup"===e.type)throw new Error("Missing a logical operator between groups");r=e.type,this.query.filter+=e.value})),0!=t)throw new Error("Group not properly closed");return this.query}};var s=o.SQ,n=o.Fw,a=o.Fn;export{s as ConditionalOperator,n as GridifyQueryBuilder,a as LogicalOperator};
|
package/dist/index.umd.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
!function(e
|
|
1
|
+
!function(r,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.GridifyClient=e():r.GridifyClient=e()}(this,(()=>(()=>{"use strict";var r,e,t={d:(r,e)=>{for(var o in e)t.o(e,o)&&!t.o(r,o)&&Object.defineProperty(r,o,{enumerable:!0,get:e[o]})},o:(r,e)=>Object.prototype.hasOwnProperty.call(r,e),r:r=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(r,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(r,"__esModule",{value:!0})}},o={};t.r(o),t.d(o,{ConditionalOperator:()=>r,GridifyQueryBuilder:()=>i,LogicalOperator:()=>e}),function(r){r.Equal="=",r.NotEqual="!=",r.LessThan="<",r.GreaterThan=">",r.GreaterThanOrEqual=">=",r.LessThanOrEqual="<=",r.Contains="*",r.NotContains="!*",r.StartsWith="^",r.NotStartsWith="!^",r.EndsWith="$",r.NotEndsWith="!$"}(r||(r={})),function(r){r.And=",",r.Or="|"}(e||(e={}));const i=class{constructor(){this.query={page:1,pageSize:20,orderBy:"",filter:""},this.filteringExpressions=[]}setPage(r){return this.query.page=r,this}setPageSize(r){return this.query.pageSize=r,this}addOrderBy(r,e=!1){const t=`${r.trim()} ${e?"desc":""}`.trim();return this.query.orderBy=this.query.orderBy?`${this.query.orderBy}, ${t}`:t,this}addCondition(r,e,t,o=!0,i=!0){let n=t;i&&"string"==typeof t&&(n=t.replace(/([(),|]|\/i)/g,"\\$1")),n=o?n.toString():`${n.toString()}/i`;var s=`${r.trim()}${e}${n}`;return this.filteringExpressions.push({value:s,type:"filter"}),this}startGroup(){return this.filteringExpressions.push({value:"(",type:"startGroup"}),this}endGroup(){return this.filteringExpressions.push({value:")",type:"endGroup"}),this}and(){return this.filteringExpressions.push({value:e.And,type:"op"}),this}or(){return this.filteringExpressions.push({value:e.Or,type:"op"}),this}build(){let r=null,e=0;if(this.filteringExpressions.forEach((t=>{if("startGroup"===t.type&&e++,"endGroup"===t.type&&e--,null===r&&"op"===t.type)throw new Error("expression cannot start with a logical operator");if("filter"===r&&"filter"===t.type)throw new Error("consecutive conditions are not allowed, consider adding a logical operator");if("op"===r&&"op"===t.type)throw new Error("consecutive operators are not allowed, consider adding a filter");if("startGroup"===r&&"op"===t.type)throw new Error("logical operator immediately after startGroup is not allowed");if("endGroup"===r&&"filter"===t.type)throw new Error("Missing logical operator after endGroup");if("startGroup"===r&&"endGroup"===t.type)throw new Error("Empty groups are not allowed");if("endGroup"===r&&"startGroup"===t.type)throw new Error("Missing a logical operator between groups");r=t.type,this.query.filter+=t.value})),0!=e)throw new Error("Group not properly closed");return this.query}};return o})()));
|