@medyll/idae-idbql 0.64.0 → 0.66.0

package/dist/idbqlCore/idbqlCore.d.ts

@@ -1,5 +1,5 @@
 import { CollectionCore } from "../collection/collection.svelte.js";
-import { type StateCollectionDyn } from "../state/idbstate.svelte.js";
+import { type CollectionState } from "../state/idbstate.svelte.js";
 export declare enum enumPrimitive {
     id = "id",
     any = "any",
@@ -70,7 +70,7 @@ type ReadonlyCollections<T extends IdbqModel> = {
     [K in keyof T]: CollectionCore<T[K]["ts"]>;
 };
 type StateCollections<T extends IdbqModel> = {
-    [K in keyof T]: StateCollectionDyn<T[K]["ts"]>;
+    [K in keyof T]: CollectionState<T[K]["ts"]>;
 };
 /**
  * Represents the IndexedDB wrapper for managing database operations.
@@ -112,6 +112,7 @@ export declare const createIdbqDb: <T extends IdbqModel>(model: T, version: numb
         idbDatabase: IdbqlIndexedCore<T>;
         idbql: ReadonlyCollections<T>;
         idbqlState: StateCollections<T>;
+        qolie: any;
         idbqModel: T;
     };
 };
@@ -120,6 +121,7 @@ export declare const idbqBase: <T extends IdbqModel>(model: T, version: number)
         idbDatabase: IdbqlIndexedCore<T>;
         idbql: ReadonlyCollections<T>;
         idbqlState: StateCollections<T>;
+        qolie: any;
         idbqModel: T;
     };
 };

package/dist/idbqlCore/idbqlCore.js

@@ -143,10 +143,12 @@ export const createIdbqDb = (model, version) => {
     return {
         create: (name) => {
             const idb_ = new IdbqlIndexedCore(name, model, version);
+            const idbqlState = createIdbqlState(idb_);
             return {
                 idbDatabase: idb_,
                 idbql: idb_,
-                idbqlState: createIdbqlState(idb_).state,
+                idbqlState: idbqlState.collectionState,
+                qolie: idbqlState.qolie,
                 idbqModel: model,
             };
         },

package/dist/state/idbqlEvent.svelte.js

@@ -77,6 +77,7 @@ class IdbqlStateEvent {
                         }
                     });
                     for (let i = indicesToRemove.length - 1; i >= 0; i--) {
+                        this.dataState[collection][indicesToRemove[i]] = undefined;
                         this.dataState[collection].splice(indicesToRemove[i], 1);
                     }
                 }

package/dist/state/idbstate.svelte.d.ts

@@ -11,36 +11,135 @@ import { type Where, type ResultSet, type ResultsetOptions } from "@medyll/idae-
  * @returns {object} - The state object.
  */
 export declare const createIdbqlState: (idbBase: IdbqlIndexedCore) => {
-    readonly state: Record<string, any>;
-    onCollection: <T>(collectionName: string) => StateCollectionDyn<T>;
-    addCollection: <T>(collectionName: string) => StateCollectionDyn<T>;
+    readonly collectionState: Record<string, CollectionState<any>>;
+    readonly qolie: (collection: string) => {
+        get: (value: any, pathKey?: string) => ResultSet<any>;
+        getBy: (value: any, pathKey?: string) => ResultSet<any>;
+        getOne: (value: any, pathKey?: string) => any;
+        getAll: () => ResultSet<any>;
+        create: (value: Partial<any>) => Promise<any>;
+        delete: (keyPathValue: string | number) => Promise<boolean | undefined>;
+        deleteWhere: (where: Where<any>) => Promise<boolean | undefined>;
+        update: (keyPathValue: string | number, data: Partial<any>) => Promise<boolean | undefined>;
+        where: (qy: Where<any>, options?: ResultsetOptions) => ResultSet<any>;
+        updateWhere: (where: Where<any>, data: Partial<any>) => Promise<boolean | undefined>;
+    };
+    onCollection: <T>(collectionName: string) => CollectionState<T>;
+    addCollection: <T>(collectionName: string) => CollectionState<T>;
 };
 /**
- * Adds a collection to the svelte 5 state and synchronize with indexedDB if it exists.
- * @template T - The type of data in the collection.
- * @param {string} collectionName - The name of the collection.
- * @param {string} [keyPath="id"] - The key path for the collection.
- * @returns {Proxy} - A proxy object with methods to interact with the collection.
+ * Represents a dynamic state collection that interacts with an IndexedDB base.
+ * Provides methods for performing CRUD operations and querying the collection.
+ *
+ * @template T - The type of items in the collection.
  */
-export declare class StateCollectionDyn<T> {
+export declare class CollectionState<T> {
     private collectionName;
     private idbBase;
+    /**
+     * Creates an instance of StateCollectionDyn.
+     * @param {string} collectionName - The name of the collection.
+     * @param {IdbqlIndexedCore} idbBase - The instance of the IndexedDB base.
+     */
     constructor(collectionName: string, idbBase: IdbqlIndexedCore);
+    /**
+     * Gets the current state of the collection.
+     * @returns {ResultSet<T>} The state of the collection.
+     */
     get collectionState(): ResultSet<T>;
+    /**
+     * Tests if the collection exists in the IndexedDB base.
+     * @param {string} collection - The name of the collection.
+     * @returns {boolean} True if the collection exists, otherwise false.
+     */
     private testIdbql;
+    /**
+     * Feeds the collection with data from the IndexedDB base.
+     */
     private feed;
+    /**
+     * Performs a "where" query on the collection.
+     * @param {Where<T>} qy - The "where" query.
+     * @param {ResultsetOptions} [options] - Optional result set options.
+     * @returns {ResultSet<T>} The result set of the query.
+     */
     _where(qy: Where<T>, options?: ResultsetOptions): ResultSet<T>;
+    /**
+     * Gets a function to perform a "where" query on the collection.
+     * @returns {(qy: Where<T>, options?: ResultsetOptions) => ResultSet<T>} The function to perform the query.
+     */
     get where(): (qy: Where<T>, options?: ResultsetOptions) => ResultSet<T>;
+    /**
+     * Gets items from the collection by a specific value and key.
+     * @param {any} value - The value to search for.
+     * @param {string} [pathKey="id"] - The key to search by.
+     * @returns {ResultSet<T>} The result set of the query.
+     */
     get(value: any, pathKey?: string): ResultSet<T>;
-    getOne(value: any, pathKey?: string): T;
+    /**
+     * Gets items from the collection by a specific value and key using a "where" query.
+     * @param {any} value - The value to search for.
+     * @param {string} [pathKey="id"] - The key to search by.
+     * @returns {ResultSet<T>} The result set of the query.
+     */
+    getBy(value: any, pathKey?: string): ResultSet<T>;
+    /**
+     * Gets a single item from the collection by a specific value and key.
+     * @deprecated Use getBy instead.
+     * @param {any} value - The value to search for.
+     * @param {string} [pathKey="id"] - The key to search by.
+     * @returns {T | undefined} The item found, or undefined if not found.
+     */
+    getOne(value: any, pathKey?: string): T | undefined;
+    /**
+     * Gets all items from the collection.
+     * @returns {ResultSet<T>} The result set of all items.
+     */
     getAll: () => ResultSet<T>;
+    /**
+     * Updates an item in the collection by a specific key path value.
+     * @param {string | number} keyPathValue - The key path value of the item to update.
+     * @param {Partial<T>} data - The data to update.
+     * @returns {Promise<boolean | undefined>} True if the update was successful, otherwise undefined.
+     */
     update(keyPathValue: string | number, data: Partial<T>): Promise<boolean | undefined>;
+    /**
+     * Updates items in the collection that match a "where" query.
+     * @param {Where<T>} where - The "where" query to match items.
+     * @param {Partial<T>} data - The data to update.
+     * @returns {Promise<boolean | undefined>} True if the update was successful, otherwise undefined.
+     */
     updateWhere(where: Where<T>, data: Partial<T>): Promise<boolean | undefined>;
+    /**
+     * Puts an item into the collection.
+     * @param {Partial<T>} value - The item to put.
+     * @returns {Promise<T | undefined>} The item put, or undefined if the operation failed.
+     */
     put(value: Partial<T>): Promise<T | undefined>;
+    /**
+     * Adds an item to the collection.
+     * @param {T} data - The item to add.
+     * @returns {Promise<T | undefined>} The item added, or undefined if the operation failed.
+     */
     add(data: T): Promise<T | undefined>;
+    /**
+     * Deletes an item from the collection by a specific key path value.
+     * @param {string | number} keyPathValue - The key path value of the item to delete.
+     * @returns {Promise<boolean | undefined>} True if the deletion was successful, otherwise undefined.
+     */
     delete(keyPathValue: string | number): Promise<boolean | undefined>;
-    /** @deprecated */
+    /**
+     * Deletes an item from the collection by a specific key path value.
+     * @deprecated Use delete instead.
+     * @param {string | number} keyPathValue - The key path value of the item to delete.
+     * @returns {Promise<boolean | undefined>} True if the deletion was successful, otherwise undefined.
+     */
     del(keyPathValue: string | number): Promise<boolean | undefined>;
+    /**
+     * Deletes items from the collection that match a "where" query.
+     * @param {Where<T>} where - The "where" query to match items.
+     * @returns {Promise<boolean | undefined>} True if the deletion was successful, otherwise undefined.
+     */
     deleteWhere(where: Where<T>): Promise<boolean | undefined>;
 }
 export {};

package/dist/state/idbstate.svelte.js

@@ -1,7 +1,6 @@
 import { idbqlEvent } from "./idbqlEvent.svelte.js";
 //
 import { Operators, getResultset, } from "@medyll/idae-query";
-//
 /**
  * Main entry point.
  * Creates a state object with indexedDB synchronization.
@@ -13,15 +12,24 @@ export const createIdbqlState = (idbBase) => {
     if (idbBase.schema) {
         addCollections(idbBase.schema);
     }
-    /**
-     * Adds a collection to the svelte 5 state and synchronize with indexedDB if it exists.
-     * @template T - The type of data in the collection.
-     * @param {string} collectionName - The name of the collection.
-     * @param {string} [keyPath="id"] - The key path for the collection.
-     * @returns {Proxy} - A proxy object with methods to interact with the collection.
-     */
+    let qolie = function dbQuery(collection) {
+        if (!collections[collection])
+            throw new Error(`Collection ${collection} not found`);
+        return {
+            get: collections[collection].get,
+            getBy: collections[collection].getBy,
+            getOne: collections[collection].getOne,
+            getAll: collections[collection].getAll,
+            create: collections[collection].put,
+            delete: collections[collection].delete,
+            deleteWhere: collections[collection].deleteWhere,
+            update: collections[collection].update,
+            where: collections[collection].where,
+            updateWhere: collections[collection].updateWhere,
+        };
+    };
     function addCollection(collectionName) {
-        return new StateCollectionDyn(collectionName, idbBase);
+        return new CollectionState(collectionName, idbBase);
     }
     function addCollections(args) {
         Object.keys(args).map((collection) => {
@@ -30,23 +38,30 @@ export const createIdbqlState = (idbBase) => {
         });
     }
     return {
-        get state() {
+        get collectionState() {
             return collections;
         },
+        get qolie() {
+            return qolie;
+        },
         onCollection: addCollection,
         addCollection: addCollection,
     };
 };
 /**
- * Adds a collection to the svelte 5 state and synchronize with indexedDB if it exists.
- * @template T - The type of data in the collection.
- * @param {string} collectionName - The name of the collection.
- * @param {string} [keyPath="id"] - The key path for the collection.
- * @returns {Proxy} - A proxy object with methods to interact with the collection.
+ * Represents a dynamic state collection that interacts with an IndexedDB base.
+ * Provides methods for performing CRUD operations and querying the collection.
+ *
+ * @template T - The type of items in the collection.
  */
-export class StateCollectionDyn {
+export class CollectionState {
     collectionName;
     idbBase;
+    /**
+     * Creates an instance of StateCollectionDyn.
+     * @param {string} collectionName - The name of the collection.
+     * @param {IdbqlIndexedCore} idbBase - The instance of the IndexedDB base.
+     */
     constructor(collectionName, idbBase) {
         if (!idbqlEvent.dataState?.[collectionName]) {
             idbqlEvent.dataState[collectionName] = [];
@@ -56,24 +71,38 @@ export class StateCollectionDyn {
         this.feed();
         return this;
     }
+    /**
+     * Gets the current state of the collection.
+     * @returns {ResultSet<T>} The state of the collection.
+     */
     get collectionState() {
         return idbqlEvent?.dataState?.[this.collectionName];
     }
+    /**
+     * Tests if the collection exists in the IndexedDB base.
+     * @param {string} collection - The name of the collection.
+     * @returns {boolean} True if the collection exists, otherwise false.
+     */
     testIdbql(collection) {
         return this.idbBase && Boolean(this.idbBase?.[collection]);
     }
+    /**
+     * Feeds the collection with data from the IndexedDB base.
+     */
     feed() {
         if (this.idbBase && this.testIdbql(this.collectionName)) {
             this.idbBase[this.collectionName].getAll().then((data) => {
                 idbqlEvent.dataState[this.collectionName] = getResultset(data);
-                /* idbqlEvent.dataState = {
-                  ...idbqlEvent.dataState,
-                  [this.collectionName]: getResultset(data),
-                }; */
             });
         }
     }
-    /* READ OP */
+    /* READ OPERATIONS */
+    /**
+     * Performs a "where" query on the collection.
+     * @param {Where<T>} qy - The "where" query.
+     * @param {ResultsetOptions} [options] - Optional result set options.
+     * @returns {ResultSet<T>} The result set of the query.
+     */
     _where(qy, options) {
         let dts = this.collectionState;
         let c = Operators.parse(dts ?? getResultset([]), qy);
@@ -82,31 +111,78 @@ export class StateCollectionDyn {
             r.setOptions(options);
         return r;
     }
+    /**
+     * Gets a function to perform a "where" query on the collection.
+     * @returns {(qy: Where<T>, options?: ResultsetOptions) => ResultSet<T>} The function to perform the query.
+     */
     get where() {
         return (qy, options) => this._where(qy, options);
     }
+    /**
+     * Gets items from the collection by a specific value and key.
+     * @param {any} value - The value to search for.
+     * @param {string} [pathKey="id"] - The key to search by.
+     * @returns {ResultSet<T>} The result set of the query.
+     */
     get(value, pathKey = "id") {
-        return this.collectionState.filter((d) => d[pathKey] === value);
+        return this.collectionState?.filter((d) => d[pathKey] === value);
     }
+    /**
+     * Gets items from the collection by a specific value and key using a "where" query.
+     * @param {any} value - The value to search for.
+     * @param {string} [pathKey="id"] - The key to search by.
+     * @returns {ResultSet<T>} The result set of the query.
+     */
+    getBy(value, pathKey = "id") {
+        return this.where({ [pathKey]: value });
+    }
+    /**
+     * Gets a single item from the collection by a specific value and key.
+     * @deprecated Use getBy instead.
+     * @param {any} value - The value to search for.
+     * @param {string} [pathKey="id"] - The key to search by.
+     * @returns {T | undefined} The item found, or undefined if not found.
+     */
     getOne(value, pathKey = "id") {
-        return this.collectionState.filter((d) => d?.[pathKey] === value)?.[0];
+        return this.where({ [pathKey]: value })?.[0];
     }
+    /**
+     * Gets all items from the collection.
+     * @returns {ResultSet<T>} The result set of all items.
+     */
     getAll = () => {
         return this.collectionState;
     };
-    /* WRITE OP */
+    /* WRITE OPERATIONS */
+    /**
+     * Updates an item in the collection by a specific key path value.
+     * @param {string | number} keyPathValue - The key path value of the item to update.
+     * @param {Partial<T>} data - The data to update.
+     * @returns {Promise<boolean | undefined>} True if the update was successful, otherwise undefined.
+     */
     async update(keyPathValue, data) {
         if (this.idbBase && this.testIdbql(this.collectionName)) {
             return (await this.idbBase[this.collectionName].update(keyPathValue, data));
         }
         return undefined;
     }
+    /**
+     * Updates items in the collection that match a "where" query.
+     * @param {Where<T>} where - The "where" query to match items.
+     * @param {Partial<T>} data - The data to update.
+     * @returns {Promise<boolean | undefined>} True if the update was successful, otherwise undefined.
+     */
     async updateWhere(where, data) {
         if (this.idbBase && this.testIdbql(this.collectionName)) {
             return (await this.idbBase[this.collectionName].updateWhere(where, data));
         }
         return undefined;
     }
+    /**
+     * Puts an item into the collection.
+     * @param {Partial<T>} value - The item to put.
+     * @returns {Promise<T | undefined>} The item put, or undefined if the operation failed.
+     */
     async put(value) {
         if (this.idbBase && this.testIdbql(this.collectionName)) {
             return this.idbBase[this.collectionName].put(value).then((data) => {
@@ -115,24 +191,44 @@ export class StateCollectionDyn {
         }
         return undefined;
     }
+    /**
+     * Adds an item to the collection.
+     * @param {T} data - The item to add.
+     * @returns {Promise<T | undefined>} The item added, or undefined if the operation failed.
+     */
     async add(data) {
         if (this.idbBase && this.testIdbql(this.collectionName)) {
             return (await this.idbBase[this.collectionName].add(data));
         }
         return undefined;
     }
+    /**
+     * Deletes an item from the collection by a specific key path value.
+     * @param {string | number} keyPathValue - The key path value of the item to delete.
+     * @returns {Promise<boolean | undefined>} True if the deletion was successful, otherwise undefined.
+     */
     async delete(keyPathValue) {
         if (this.idbBase && this.testIdbql(this.collectionName)) {
             return await this.idbBase[this.collectionName].delete(keyPathValue);
         }
         return undefined;
     }
-    /** @deprecated */
+    /**
+     * Deletes an item from the collection by a specific key path value.
+     * @deprecated Use delete instead.
+     * @param {string | number} keyPathValue - The key path value of the item to delete.
+     * @returns {Promise<boolean | undefined>} True if the deletion was successful, otherwise undefined.
+     */
     async del(keyPathValue) {
         if (this.idbBase && this.testIdbql(this.collectionName)) {
             return await this.idbBase[this.collectionName].delete(keyPathValue);
         }
     }
+    /**
+     * Deletes items from the collection that match a "where" query.
+     * @param {Where<T>} where - The "where" query to match items.
+     * @returns {Promise<boolean | undefined>} True if the deletion was successful, otherwise undefined.
+     */
     async deleteWhere(where) {
         if (this.idbBase && this.testIdbql(this.collectionName)) {
             return await this.idbBase[this.collectionName].deleteWhere(where);

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@medyll/idae-idbql",
 	"scope": "@medyll",
-	"version": "0.64.0",
+	"version": "0.66.0",
 	"description": "A powerful and flexible IndexedDB query library for TypeScript and JavaScript applications, offering a MongoDB-like query interface, strong TypeScript support, reactive state management, and easy integration with front-end frameworks like Svelte.",
 	"scripts": {
 		"dev": "vite dev",
@@ -32,10 +32,9 @@
 	"devDependencies": {
 		"@medyll/idae-prettier-config": "^1.1.0",
 		"@sveltejs/adapter-auto": "^4.0.0",
-		"@sveltejs/kit": "^2.17.3",
-		"@sveltejs/package": "^2.3.10",
-		"@sveltejs/vite-plugin-svelte": "^5.0.3",
-		"svelte": "^5.20.5",
+		"@sveltejs/kit": "^2.18.0",
+		"@sveltejs/package": "^2.0.0",
+		"svelte": "^5.22.4",
 		"svelte-check": "^4.1.4",
 		"tslib": "^2.8.1",
 		"typescript": "^5.8.2",
@@ -45,6 +44,6 @@
 	"types": "./dist/index.d.ts",
 	"type": "module",
 	"dependencies": {
-		"@medyll/idae-query": "^0.65.0"
+		"@medyll/idae-query": "^0.67.0"
 	}
 }