@medyll/idae-query 0.180.0 → 0.186.2

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 medyll
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 medyll
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,185 +1,185 @@
-# @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
-
-## 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.
-
-### `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
+
+## 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.
+
+### `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/cli.js

@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+
+const pkgJson = require(path.join(__dirname, 'package.json'));
+const packageName = pkgJson.name.replace(/^@[^/]+\//, '');
+const cmd = process.argv[2];
+
+
+if (cmd === 'get-readme') {
+  const readmePath = path.join(__dirname, 'README.md');
+  if (fs.existsSync(readmePath)) {
+    const content = fs.readFileSync(readmePath, 'utf8');
+    console.log(content);
+  } else {
+    console.error('README.md not found in this package.');
+    process.exit(1);
+  }
+} else if (cmd === 'install-skill') {
+  const readline = require('readline');
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+  const skillSrc = path.join(__dirname, 'SKILL.md');
+  const skillDest = path.resolve(__dirname, `../../../.github/skills/${packageName}/SKILL.md`);
+  if (!fs.existsSync(skillSrc)) {
+    console.error('SKILL.md not found in this package.');
+    process.exit(1);
+  }
+  rl.question(`This will copy SKILL.md to .github/skills/${packageName}/SKILL.md. Continue? (y/n): `, (answer) => {
+    if (answer.trim().toLowerCase() === 'y' || answer.trim().toLowerCase() === 'yes') {
+      fs.mkdirSync(path.dirname(skillDest), { recursive: true });
+      fs.copyFileSync(skillSrc, skillDest);
+      console.log(`SKILL.md installed to .github/skills/${packageName}/SKILL.md`);
+    } else {
+      console.log('Operation cancelled.');
+    }
+    rl.close();
+  });
+} else {
+  console.log('Usage: <cli> get-readme | install-skill');
+  process.exit(1);
+}

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,6 +1,6 @@
 // auto exports of entry components
 export * from './types.js';
-export * from './resultSet/resultset.js';
 export * from './query/query.js';
-export * from './path/pathResolver.js';
+export * from './resultSet/resultset.js';
 export * from './operators/operators.js';
+export * from './path/pathResolver.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>): any;
+    where(qy: Where<T>): import("../resultset/resultset.js").ResultSet<T>;
     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,15 @@
 {
   "name": "@medyll/idae-query",
+  "bin": {
+    "idae-query": "./cli.js"
+  },
   "scope": "@medyll",
-  "version": "0.180.0",
+  "author": "Lebrun Meddy",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/medyll/idae.git"
+  },
+  "version": "0.186.2",
   "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.",
   "exports": {
     ".": {
@@ -17,7 +25,12 @@
   "peerDependencies": {
     "svelte": "^5.0.0-next"
   },
+  "publishConfig": {
+    "access": "public",
+    "directory": "."
+  },
   "devDependencies": {
+    "@semantic-release/github": "^10.3.5",
     "@sveltejs/adapter-auto": "^6.0.0",
     "@sveltejs/kit": "^2.20.7",
     "@sveltejs/package": "^2.3.11",
@@ -37,8 +50,8 @@
     "typescript-eslint": "^8.30.1",
     "vite": "^6.3.2",
     "vitest": "^3.1.1",
-    "@medyll/idae-engine": "1.179.0",
-    "@medyll/idae-prettier-config": "1.2.1"
+    "@medyll/idae-engine": "1.185.2",
+    "@medyll/idae-eslint-config": "0.1.5"
   },
   "svelte": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -54,6 +67,6 @@
     "test": "vitest",
     "lint": "prettier --check . && eslint .",
     "format": "prettier --write .",
-    "package:pre": "node scripts/package-pre.js"
+    "prepackage": "node scripts/package-pre.js"
   }
 }