@medyll/idae-query 0.68.0 → 0.69.0

package/README.md

@@ -1,184 +1,78 @@
-# @medyll/idae-idbql
+# @medyll/idae-query
 
-A powerful and flexible IndexedDB query library for TypeScript and JavaScript applications.
+A powerful and flexible query library for TypeScript and JavaScript applications.
 
 ## Features
 
-- MongoDB-like query interface for IndexedDB
-- Strong TypeScript support with full type inference
-- Reactive state management for real-time UI updates
-- Support for complex CRUD operations and advanced querying
-- Flexible data modeling with automatic schema creation
-- Built-in indexing and optimization features
-- Easy integration with front-end frameworks, especially Svelte
-- Robust error handling and logging
-- Versioning and database migration support
-- Support for svelte 5 state
+- 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-idbql
+npm install @medyll/idae-query
 ```
 
 ## Quick Start
 
-```typescript
-import { createIdbqDb } from '@medyll/idae-idbql';
-
-// Define your data model
-const exampleModel = {
-  messages: {
-    keyPath: "++id, chatId, created_at",
-    ts: {} as ChatMessage,
-  },
-  chat: {
-    keyPath: "&chatId, created_at, dateLastMessage",
-    ts: {} as Chat,
-    template: {},
-  },
-};
-
-// Create a database instance
-const idbqStore = createIdbqDb(exampleModel, 1);
-const { idbql, idbqlState, idbDatabase, idbqModel } = idbqStore.create("myDatabase");
-
-// Perform database operations
-async function fetchMessages() {
-  const messages = await idbql.messages.where({ chatId: "123" }).toArray();
-  console.log(messages);
-}
-
-fetchMessages();
-```
-
-## API Reference
-
-### createIdbqDb(model, version)
-
-Creates an IndexedDB database instance with the specified model and version.
-
-### idbql
-
-The main interface for database operations. Provides methods for each collection defined in your model.
-
-### idbqlState
-
-A reactive state object that reflects the current state of your database.
-
-### idbDatabase
-
-Provides low-level access to the IndexedDB instance.
-
-### idbqModel
-
-Contains the database model definition.
-
-## Query Operations
+Here's a quick example to get you started:
 
 ```typescript
-// Add a new item
-await idbql.messages.add({ chatId: "123", content: "Hello" });
+import { getResultset } from '@medyll/idae-query';
 
-// Update an item
-await idbql.messages.put({ id: 1, content: "Updated message" });
+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 } },
+];
 
-// Delete an item
-await idbql.messages.delete(1);
+const resultSet = getResultset(data);
 
-// Query items
-const recentMessages = await idbql.messages
-  .where({ created_at: { gt: new Date(Date.now() - 86400000) } })
-  .toArray();
-```
-
-## Transactions
+// Sorting
+const sortedData = resultSet.sortBy({ age: 'asc' });
 
-idbql supports complex transactions across multiple object stores:
+// Grouping
+const groupedData = resultSet.groupBy('age');
 
-```typescript
-const result = await idbql.transaction(
-  ["users", "posts"],
-  "readwrite",
-  async (tx) => {
-    const userStore = tx.objectStore("users");
-    const postStore = tx.objectStore("posts");
-
-    const userId = await userStore.add({ name: "Alice", email: "alice@example.com" });
-    const postId = await postStore.add({ userId, title: "Alice's First Post", content: "Hello, World!" });
-
-    return { userId, postId };
-  }
-);
-```
-
-## Reactive State Management
-
-```typescript
-import { derived } from 'svelte/store';
+// Pagination
+const pageData = resultSet.getPage(1, 2);
 
-const activeUsers = $derived(idbqlState.users.where({ isActive: true }));
+console.log(sortedData);
+console.log(groupedData);
+console.log(pageData);
 ```
 
-## Integration with Svelte
+## API
 
-```svelte
-<script>
-import { derived } from 'svelte/store';
-import { idbqlState } from './store';
+### `getResultset(data: any[]): ResultSet`
 
-const messages = $derived(idbqlState.messages.where({ chatId: "123" }));
-</script>
+Creates a new result set from the provided data.
 
-{#each $messages as message}
-  <p>{message.content}</p>
-{/each}
-```
+### `ResultSet`
 
-## Versioning and Migrations
+A chainable and iterable result set of data.
 
-```typescript
-const idbqStore = createIdbqDb(myModel, 2);
-const { idbDatabase } = idbqStore.create("myDb", {
-  upgrade(oldVersion, newVersion, transaction) {
-    if (oldVersion < 2) {
-      const userStore = transaction.objectStore("users");
-      userStore.createIndex("emailIndex", "email", { unique: true });
-    }
-  },
-});
-```
+#### Methods
 
-## Error Handling
+- `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.
 
-```typescript
-try {
-  await idbql.users.add({ username: "existing_user" });
-} catch (error) {
-  if (error instanceof UniqueConstraintError) {
-    console.error("Username already exists");
-  } else {
-    console.error("An unexpected error occurred", error);
-  }
-}
-```
-
-## Performance Tips
+## Testing
 
-- Use appropriate indexes
-- Limit result sets with `.limit(n)`
-- Use `.count()` instead of `.toArray().length`
-- Optimize queries to use indexes effectively
+To run the tests:
 
-## Contributing
+1. Clone the repository
+2. Install dependencies: `npm install` or `yarn install`
+3. Run tests: `npm test` or `yarn test`
 
-Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
+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. See the [LICENSE](LICENSE) file for details.
-
-## Support
+This project is licensed under the MIT License.
 
-If you encounter any issues or have questions, please file an issue on the GitHub repository.
- 

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 './query/query.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 './resultSet/resultset.js';
-export * from './query/query.js';
 export * from './path/pathResolver.js';
+export * from './query/query.js';
 export * from './operators/operators.js';

package/dist/resultSet/resultset.js

@@ -47,23 +47,11 @@ export function getResultset(data) {
         },
         groupBy: {
             value: function (fieldName, keepUngroupedData = true) {
-                return dataOp.groupBy({ dataList: this, groupBy: fieldName });
-                /* const finalFieldName =
-                  typeof fieldName === "string" ? [fieldName] : fieldName;
-                return this.reduce(
-                  (acc: { [x: string]: any[] }, curr: Record<string, any>) => {
-                    let key = "";
-                    for (let i = 0; i < finalFieldName.length; i++) {
-                      key += dotPath<typeof curr>(curr, finalFieldName[i]);
-                    }
-                    if (!acc[key]) {
-                      acc[key] = [];
-                    }
-                    acc[key].push(curr);
-                    return acc;
-                  },
-                  {},
-                ); */
+                return dataOp.groupBy({
+                    dataList: this,
+                    groupBy: fieldName,
+                    keepUngroupedData,
+                });
             },
             enumerable: true,
             configurable: true,

package/package.json

@@ -1,8 +1,8 @@
 {
 	"name": "@medyll/idae-query",
 	"scope": "@medyll",
-	"version": "0.68.0",
-	"description": "A powerful and flexible IndexedDB query library for TypeScript and JavaScript applications, featuring a MongoDB-like query interface, strong TypeScript support, reactive state management, and easy integration with front-end frameworks like Svelte.",
+	"version": "0.69.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",
 		"build": "vite build && npm run package",
@@ -28,6 +28,9 @@
 		"!dist/**/*.test.*",
 		"!dist/**/*.spec.*"
 	],
+	"dependencies": {
+		"@medyll/idae-engine": "next"
+	},
 	"peerDependencies": {
 		"svelte": "^5.0.0-next"
 	},