@medyll/idae-query 0.120.1 → 0.122.0

package/README.md

@@ -1,78 +1,78 @@
-# @medyll/idae-query
-
-A powerful and flexible query library for TypeScript and JavaScript applications.
-
-## Features
-
-- Chainable and iterable result sets
-- Sorting, grouping, and pagination support
-- Dot path resolution for nested properties
-- Integration with `@medyll/idae-engine` for data operations
-
-## Installation
-
-```bash
-npm install @medyll/idae-query
-```
-
-## Quick Start
-
-Here's a quick example to get you started:
-
-```typescript
-import { getResultset } from '@medyll/idae-query';
-
-const data = [
-  { id: 1, name: 'John', age: 25, metadata: { order: 1 } },
-  { id: 2, name: 'Jane', age: 30, metadata: { order: 2 } },
-  { id: 3, name: 'Bob', age: 35, metadata: { order: 3 } },
-  { id: 4, name: 'Alice', age: 40, metadata: { order: 4 } },
-];
-
-const resultSet = getResultset(data);
-
-// Sorting
-const sortedData = resultSet.sortBy({ age: 'asc' });
-
-// Grouping
-const groupedData = resultSet.groupBy('age');
-
-// Pagination
-const pageData = resultSet.getPage(1, 2);
-
-console.log(sortedData);
-console.log(groupedData);
-console.log(pageData);
-```
-
-## API
-
-### `getResultset(data: any[]): ResultSet`
-
-Creates a new result set from the provided data.
-
-### `ResultSet`
-
-A chainable and iterable result set of data.
-
-#### Methods
-
-- `setOptions(options: ResultsetOptions): ResultSet` - Sets options for the result set.
-- `sortBy(sortOptions: Record<DotPath, 'asc' | 'desc'>): ResultSet` - Sorts the result set by the specified options.
-- `groupBy(groupBy: DotPath): Record<string, any[]>` - Groups the result set by the specified property.
-- `getPage(page: number, pageSize: number): any[]` - Gets the specified page of data.
-
-## Testing
-
-To run the tests:
-
-1. Clone the repository
-2. Install dependencies: `npm install` or `yarn install`
-3. Run tests: `npm test` or `yarn test`
-
-The tests cover various scenarios for each method, ensuring the reliability and correctness of the `ResultSet` class.
-
-## License
-
-This project is licensed under the MIT License.
-
+# @medyll/idae-query
+
+A powerful and flexible query library for TypeScript and JavaScript applications.
+
+## Features
+
+- Chainable and iterable result sets
+- Sorting, grouping, and pagination support
+- Dot path resolution for nested properties
+- Integration with `@medyll/idae-engine` for data operations
+
+## Installation
+
+```bash
+npm install @medyll/idae-query
+```
+
+## Quick Start
+
+Here's a quick example to get you started:
+
+```typescript
+import { getResultset } from '@medyll/idae-query';
+
+const data = [
+  { id: 1, name: 'John', age: 25, metadata: { order: 1 } },
+  { id: 2, name: 'Jane', age: 30, metadata: { order: 2 } },
+  { id: 3, name: 'Bob', age: 35, metadata: { order: 3 } },
+  { id: 4, name: 'Alice', age: 40, metadata: { order: 4 } },
+];
+
+const resultSet = getResultset(data);
+
+// Sorting
+const sortedData = resultSet.sortBy({ age: 'asc' });
+
+// Grouping
+const groupedData = resultSet.groupBy('age');
+
+// Pagination
+const pageData = resultSet.getPage(1, 2);
+
+console.log(sortedData);
+console.log(groupedData);
+console.log(pageData);
+```
+
+## API
+
+### `getResultset(data: any[]): ResultSet`
+
+Creates a new result set from the provided data.
+
+### `ResultSet`
+
+A chainable and iterable result set of data.
+
+#### Methods
+
+- `setOptions(options: ResultsetOptions): ResultSet` - Sets options for the result set.
+- `sortBy(sortOptions: Record<DotPath, 'asc' | 'desc'>): ResultSet` - Sorts the result set by the specified options.
+- `groupBy(groupBy: DotPath): Record<string, any[]>` - Groups the result set by the specified property.
+- `getPage(page: number, pageSize: number): any[]` - Gets the specified page of data.
+
+## Testing
+
+To run the tests:
+
+1. Clone the repository
+2. Install dependencies: `npm install` or `yarn install`
+3. Run tests: `npm test` or `yarn test`
+
+The tests cover various scenarios for each method, ensuring the reliability and correctness of the `ResultSet` class.
+
+## License
+
+This project is licensed under the MIT License.
+

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export * from './types.js';
-export * from './query/query.js';
 export * from './resultSet/resultset.js';
+export * from './query/query.js';
 export * from './path/pathResolver.js';
 export * from './operators/operators.js';

package/dist/index.js

@@ -1,6 +1,6 @@
 // auto exports of entry components
 export * from './types.js';
-export * from './query/query.js';
 export * from './resultSet/resultset.js';
+export * from './query/query.js';
 export * from './path/pathResolver.js';
 export * from './operators/operators.js';

package/dist/query/query.d.ts

@@ -2,7 +2,7 @@ import type { Where } from '../types.js';
 export declare class Query<T extends object> {
     data: T[];
     constructor(data: T[]);
-    where(qy: Where<T>): import("../resultset/resultset.js").ResultSet<T>;
+    where(qy: Where<T>): any;
     private matchesQuery;
     private matchesField;
 }

package/dist/resultSet/Readme.md

@@ -1,39 +1,39 @@
-## ResultSet.ts
-
-This class `ResultSet` is used to manipulate and iterate over a set of data. The class is iterable, meaning it can be spread into an array or iterated over with a `for...of` loop.
-
-### Methods
-
- 
-
-#### setOptions<T>(options: OptionsType)
-
-- Action: Sets the options for the result set in one pass.
-- Arguments: An `OptionsType` object which can contain `sort`, `page`, and `groupBy` properties.
-  - `sort`: An object where the keys represent the properties to sort by, and the values represent the sort order ("asc" for ascending, "desc" for descending).
-  - `page`: An object with `size` and `number` properties, representing the number of items per page and the page number to retrieve, respectively.
-  - `groupBy`: A string or an array of strings, representing the field names to group by.
-- Return: The updated result set.
-
-
-#### sortBy(args: Record<string, "asc" | "desc">)
-
-- Action: Sorts the data in the result set based on the provided sorting criteria.
-- Arguments: An object where the keys represent the properties to sort by, and the values represent the sort order ("asc" for ascending, "desc" for descending).
-- Return: The sorted result set.
-
-#### getPage(size: number, page: number)
-
-- Action: Retrieves a specific page of data from the result set.
-- Arguments: The `size` parameter specifies the number of items per page, and the `page` parameter specifies the page number to retrieve.
-- Return: A new result set containing the specified page of data.
-
-#### groupBy(fieldName: string | string[], transform?: (value: any) => void)
-
-- Action: Groups the result set by the specified field name(s).
-- Arguments: The `fieldName` parameter can be a string or an array of strings, representing the field names to group by. The `transform` parameter is an optional transformation function to apply to each grouped value.
-- Return: An object representing the grouped result set.
-
-### Iterability
-
-The `ResultSet` class is iterable, meaning it can be spread into an array or iterated over with a `for...of` loop. This is achieved by implementing the `[Symbol.iterator]` method.
+## ResultSet.ts
+
+This class `ResultSet` is used to manipulate and iterate over a set of data. The class is iterable, meaning it can be spread into an array or iterated over with a `for...of` loop.
+
+### Methods
+
+ 
+
+#### setOptions<T>(options: OptionsType)
+
+- Action: Sets the options for the result set in one pass.
+- Arguments: An `OptionsType` object which can contain `sort`, `page`, and `groupBy` properties.
+  - `sort`: An object where the keys represent the properties to sort by, and the values represent the sort order ("asc" for ascending, "desc" for descending).
+  - `page`: An object with `size` and `number` properties, representing the number of items per page and the page number to retrieve, respectively.
+  - `groupBy`: A string or an array of strings, representing the field names to group by.
+- Return: The updated result set.
+
+
+#### sortBy(args: Record<string, "asc" | "desc">)
+
+- Action: Sorts the data in the result set based on the provided sorting criteria.
+- Arguments: An object where the keys represent the properties to sort by, and the values represent the sort order ("asc" for ascending, "desc" for descending).
+- Return: The sorted result set.
+
+#### getPage(size: number, page: number)
+
+- Action: Retrieves a specific page of data from the result set.
+- Arguments: The `size` parameter specifies the number of items per page, and the `page` parameter specifies the page number to retrieve.
+- Return: A new result set containing the specified page of data.
+
+#### groupBy(fieldName: string | string[], transform?: (value: any) => void)
+
+- Action: Groups the result set by the specified field name(s).
+- Arguments: The `fieldName` parameter can be a string or an array of strings, representing the field names to group by. The `transform` parameter is an optional transformation function to apply to each grouped value.
+- Return: An object representing the grouped result set.
+
+### Iterability
+
+The `ResultSet` class is iterable, meaning it can be spread into an array or iterated over with a `for...of` loop. This is achieved by implementing the `[Symbol.iterator]` method.

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@medyll/idae-query",
 	"scope": "@medyll",
-	"version": "0.120.1",
+	"version": "0.122.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",