@medyll/idae-query 0.146.0 → 0.148.0

package/README.md

@@ -20,7 +20,7 @@ npm install @medyll/idae-query
 Here's a quick example to get you started:
 
 ```typescript
-import { getResultset } from '@medyll/idae-query';
+import { getResultSet } from '@medyll/idae-query';
 
 const data = [
   { id: 1, name: 'John', age: 25, metadata: { order: 1 } },
@@ -29,7 +29,7 @@ const data = [
   { id: 4, name: 'Alice', age: 40, metadata: { order: 4 } },
 ];
 
-const resultSet = getResultset(data);
+const resultSet = getResultSet(data);
 
 // Sorting
 const sortedData = resultSet.sortBy({ age: 'asc' });
@@ -47,6 +47,113 @@ console.log(pageData);
 
 ## API
 
+## Operators Demo
+
+## Query Operators Usage
+
+## Advanced Usage
+
+### Multi-criteria Sorting
+```typescript
+const resultSet = getResultSet(data);
+const sorted = resultSet.sortBy({ age: 'asc', name: 'desc' });
+// Tri d'abord par age croissant, puis par name décroissant
+```
+
+### Grouping by Nested Property
+```typescript
+const resultSet = getResultSet(data);
+const grouped = resultSet.groupBy('metadata.order');
+// Regroupe par la propriété imbriquée metadata.order
+```
+
+### Pagination
+```typescript
+const resultSet = getResultSet(data);
+const page1 = resultSet.getPage(1, 2); // Page 1, 2 éléments
+const page2 = resultSet.getPage(2, 2); // Page 2, 2 éléments
+```
+
+### Combined Example
+```typescript
+const resultSet = getResultSet(data)
+  .sortBy({ age: 'asc' })
+  .groupBy('age');
+const page = resultSet.getPage(1, 2);
+```
+
+All operators are used via the main API (`getResultSet` or `Query`).
+
+### Example with getResultSet
+```typescript
+import { getResultSet } from '@medyll/idae-query';
+
+const data = [
+  { id: 1, name: 'John', age: 25 },
+  { id: 2, name: 'Jane', age: 30 },
+  { id: 3, name: 'Bob', age: 35 },
+];
+
+const resultSet = getResultSet(data);
+
+// eq
+const eqResult = resultSet.where({ age: { eq: 30 } }); // [{ id: 2, name: 'Jane', age: 30 }]
+
+// gt
+const gtResult = resultSet.where({ age: { gt: 25 } }); // [{ id: 2, name: 'Jane', age: 30 }, { id: 3, name: 'Bob', age: 35 }]
+
+// gte
+const gteResult = resultSet.where({ age: { gte: 30 } }); // [{ id: 2, name: 'Jane', age: 30 }, { id: 3, name: 'Bob', age: 35 }]
+
+// lt
+const ltResult = resultSet.where({ age: { lt: 30 } }); // [{ id: 1, name: 'John', age: 25 }]
+
+// lte
+const lteResult = resultSet.where({ age: { lte: 30 } }); // [{ id: 1, name: 'John', age: 25 }, { id: 2, name: 'Jane', age: 30 }]
+
+// ne
+const neResult = resultSet.where({ age: { ne: 25 } }); // [{ id: 2, name: 'Jane', age: 30 }, { id: 3, name: 'Bob', age: 35 }]
+
+// in
+const inResult = resultSet.where({ age: { in: [25, 35] } }); // [{ id: 1, name: 'John', age: 25 }, { id: 3, name: 'Bob', age: 35 }]
+
+// nin
+const ninResult = resultSet.where({ age: { nin: [25, 35] } }); // [{ id: 2, name: 'Jane', age: 30 }]
+
+// contains
+const containsResult = resultSet.where({ name: { contains: 'an' } }); // [{ id: 2, name: 'Jane', age: 30 }]
+
+// startsWith
+const startsWithResult = resultSet.where({ name: { startsWith: 'Ja' } }); // [{ id: 2, name: 'Jane', age: 30 }]
+
+// endsWith
+const endsWithResult = resultSet.where({ name: { endsWith: 'hn' } }); // [{ id: 1, name: 'John', age: 25 }]
+
+// btw
+const btwResult = resultSet.where({ age: { btw: [25, 35] } }); // [{ id: 1, name: 'John', age: 25 }, { id: 2, name: 'Jane', age: 30 }, { id: 3, name: 'Bob', age: 35 }]
+
+// Custom operator
+import { Operators } from '@medyll/idae-query';
+Operators.addCustomOperator('isEven', (field, value, data) => data[field] % 2 === 0);
+const customResult = resultSet.where({ age: { isEven: true } }); // [{ id: 2, name: 'Jane', age: 30 }]
+```
+
+### Example with Query class
+```typescript
+import { Query } from '@medyll/idae-query';
+
+const data = [
+  { id: 1, value: 10 },
+  { id: 2, value: 20 },
+  { id: 3, value: 30 },
+];
+
+const query = new Query(data);
+const result = query.where({ value: { gt: 15, lt: 30 } }); // [{ id: 2, value: 20 }]
+```
+
+## API
+
 ### `getResultset(data: any[]): ResultSet`
 
 Creates a new result set from the provided data.

package/dist/query/query.js

@@ -1,15 +1,15 @@
 /* src\lib\scripts\query\query.ts */
 import { Operators } from '../operators/operators.js';
-import { getResultset } from '../resultset/resultset.js';
+import { getResultSet } from '../resultset/resultset.js';
 export class Query {
     data;
     constructor(data) {
         this.data = data;
-        getResultset(this.data ?? []);
+        getResultSet(this.data ?? []);
     }
     where(qy) {
         this.data = this.data.filter((item) => this.matchesQuery(item, qy));
-        return getResultset(this.data);
+        return getResultSet(this.data);
     }
     matchesQuery(item, query) {
         if (typeof query !== 'object' || query === null) {

package/dist/resultSet/resultset.d.ts

@@ -29,10 +29,14 @@ export type ResultSet<T> = T[] & {
     getPage: (page: number, size: number) => ResultSet<T>;
     toObject: (dotPath: DotPath<T>) => T[];
 };
+/**
+ * @deprecated Use getResultSet instead. Will be removed in future versions.
+ */
+export declare function getResultset<T = (typeof arguments)[0]>(data: T[]): ResultSet<T>;
 /**
  * Generates a ResultSet based on the provided data array and defines additional properties like setOptions, sortBy, groupBy, and getPage for customization and manipulation.
  *
  * @param {T[]} data - The array of data to generate the ResultSet from.
  * @return {ResultSet<T>} The generated ResultSet with additional properties for customization.
  */
-export declare function getResultset<T = (typeof arguments)[0]>(data: T[]): ResultSet<T>;
+export declare function getResultSet<T = (typeof arguments)[0]>(data: T[]): ResultSet<T>;

package/dist/resultSet/resultset.js

@@ -1,13 +1,18 @@
 import { dotPath } from "../path/pathResolver.js";
 import { dataOp } from "@medyll/idae-engine";
+/**
+ * @deprecated Use getResultSet instead. Will be removed in future versions.
+ */
+export function getResultset(data) {
+    return getResultSet(data);
+}
 /**
  * Generates a ResultSet based on the provided data array and defines additional properties like setOptions, sortBy, groupBy, and getPage for customization and manipulation.
  *
  * @param {T[]} data - The array of data to generate the ResultSet from.
  * @return {ResultSet<T>} The generated ResultSet with additional properties for customization.
  */
-export function getResultset(data) {
-    // : ResultSet<T>
+export function getResultSet(data) {
     Object.defineProperties(data, {
         setOptions: {
             value: function (options = {}) {

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@medyll/idae-query",
 	"scope": "@medyll",
-	"version": "0.146.0",
+	"version": "0.148.0",
 	"description": "A powerful and flexible query library for TypeScript and JavaScript applications, featuring a MongoDB-like query interface, strong TypeScript support, and easy integration with front-end frameworks.",
 	"scripts": {
 		"dev": "vite dev",