querier-ts 2.7.0 → 2.8.0

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Changelog
 
+## v2.8.0
+
+### Summary
+
+- [ ] Bug fixes
+- [ ] Code refactoring
+- [x] New features
+- [ ] Breaking changes
+
+### New features
+
+- Added row index as argument to `Query.map()` callback.
+
+## v2.7.1
+
+### Summary
+
+- [x] Documentation updates
+- [ ] Bug fixes
+- [ ] Code refactoring
+- [ ] New features
+- [ ] Breaking changes
+
+### Documentation updates
+
+- Update `README.md` documentation for `orderBy()` method with new overload and examples.
+
 ## v2.7.0
 
 ### Summary

package/README.md

@@ -5,7 +5,8 @@ querier-ts
 A lightweight, type-safe in-memory query engine for JavaScript and TypeScript.
 <p>
 <p align="center">
-  <a href="https://npmx.dev/package/querier-ts"><img src="https://img.shields.io/npm/v/querier-ts?color=729B1B&label=" alt="current querier-ts version badge"></a>
+  <a href="https://www.npmjs.com/package/querier-ts"><img src="https://img.shields.io/npm/v/querier-ts.svg" alt="current querier-ts version badge"></a>
+  <a href="https://codecov.io/gh/luizfilipezs/querier-ts"><img alt="Codecov" src="https://img.shields.io/codecov/c/github/luizfilipezs/querier-ts.svg?style=flat-square"></a>
 <p>
 
 ## `Query`
@@ -116,6 +117,11 @@ Transforms each row into a new object using a callback function.
 
 Like `select()`, this method is intended for data projection, but it is more flexible and better suited for complex transformations:
 
+Callback arguments:
+
+- `row`: The current row.
+- `index`: The index of the current row.
+
 
 ```ts
 const authorsWithFirstPostQuery = Query.from(authors)
@@ -144,23 +150,30 @@ const query = Query.from()
 
 ### Ordering results
 
-#### `orderBy(...columns)`
+#### `orderBy(...columns | (callback, order?))`
 
-Sorts the results. You can pass multiple columns.
+Sorts the results.
 
-```ts
-.orderBy('name', 'id')
-```
+- `columns`: the columns to order by.
+- `callback`: A function that maps each row to a value.
+- `order`: The order to sort in.
 
-In this example, `name` has higher priority than `id`.
+You can specify column names or a callback function to map each row to a value.
 
-You can also sort in descending order by prefixing the column with `-`:
+Examples:
 
 ```ts
-const lastId = Query.from(users)
-  .select('id')
-  .orderBy('-id')
-  .scalar();
+// Column names with ASC and DESC (-) order
+.orderBy('name', '-createdAt')
+
+// callback with ASC order by default
+.orderBy((user) => user.address.country)
+
+// callback with ASC order set explicitly
+.orderBy((user) => user.address.country, 'asc')
+
+// callback with DESC order
+.orderBy((user) => user.address.country, 'desc')
 ```
 
 ---

package/dist/cjs/index.cjs

@@ -295,7 +295,7 @@ var _Query = class _Query {
     const source = this.#rows;
     const rows = [];
     for (let i = 0; i < source.length; i++) {
-      rows.push(callback(source[i]));
+      rows.push(callback(source[i], i));
     }
     const query = new _Query(rows);
     this.cloneStateInto(query);

package/dist/esm/index.d.ts

@@ -110,7 +110,7 @@ declare class Query<T extends object> {
      * @param callback Function to be called for each row.
      * @returns New query with the mapped rows.
      */
-    map<TReturn extends object>(callback: (obj: T) => TReturn): Query<TReturn>;
+    map<TReturn extends object>(callback: (row: T, index: number) => TReturn): Query<TReturn>;
     /**
      * Removes duplicate rows based on a key.
      *

package/dist/esm/index.js

@@ -293,7 +293,7 @@ var _Query = class _Query {
     const source = this.#rows;
     const rows = [];
     for (let i = 0; i < source.length; i++) {
-      rows.push(callback(source[i]));
+      rows.push(callback(source[i], i));
     }
     const query = new _Query(rows);
     this.cloneStateInto(query);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "querier-ts",
   "type": "module",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "A lightweight, type-safe in-memory query engine for JavaScript and TypeScript",
   "repository": {
     "type": "git",