@buley/dash 0.0.30 → 2.1.1

package/src/index/index.ts

@@ -1,61 +0,0 @@
-/**
- * Index methods
- * @module index
- */
-
-import { cloneError, DashContext } from "../utilities";
-
-// Index methods
-export const indexMethods = {
-    /**
-     * Get an index.
-     * @param get_ctx 
-     * @returns Promise<DashContext>
-     * @private
-     */
-    get: (get_ctx: DashContext) => {
-        return new Promise((resolve, reject) => {
-            const request = get_ctx.idx?.get(get_ctx.key);
-
-            request?.addEventListener('success', () => {
-                get_ctx.entry = request.result;
-                resolve(get_ctx);
-            });
-
-            request?.addEventListener('error', (event) => {
-                get_ctx.error = cloneError((event as any).target.error);
-                reject(get_ctx);
-            });
-        });
-    },
-    /**
-     * Remove an index.
-     * @param remove_ctx 
-     * @returns Promise<DashContext>
-     * @private
-     */
-    remove: (remove_ctx: DashContext) => {
-        return new Promise((resolve, reject) => {
-            remove_ctx.objectstore?.deleteIndex(remove_ctx.key);
-            // Why don't we have success/error handlers?
-            // Because this method returns void, not a request object.
-            // https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/deleteIndex#return_value
-            resolve(remove_ctx);
-        });
-    },
-    /**
-     * Get indexes.
-     * @param ctx 
-     * @returns Promise<DashContext>
-     * @private
-     */
-    getIndexes: (ctx: DashContext) => {
-        return new Promise((resolve) => {
-            const indexes = ctx.objectstore?.indexNames;
-            ctx.indexes = Array.from(indexes || []);
-            resolve(ctx);
-        });
-    }
-};
-
-export default indexMethods;

package/src/index.ts

@@ -1,96 +0,0 @@
-/*
-      ▀██                 ▀██      
-    ▄▄ ██   ▄▄▄▄    ▄▄▄▄   ██ ▄▄   
-  ▄▀  ▀██  ▀▀ ▄██  ██▄ ▀   ██▀ ██  
-  █▄   ██  ▄█▀ ██  ▄ ▀█▄▄  ██  ██  
-  ▀█▄▄▀██▄ ▀█▄▄▀█▀ █▀▄▄█▀ ▄██▄ ██▄ 
-
-  Dash is a simple, lightweight wrapper around the IndexedDB API.
-  There are four main modules: database, store, index, and entry.
-  Each module has a get, put, and remove method.
-  The library is designed to be used in a promise chain.
-
-  Version -> 0.0.1
-  Repo -> http://github.com/buley/dash
-  Author -> Taylor Buley (@taylorbuley)
-  Copyright -> (c) 2011-2024 Taylor Buley
-  License -> MIT (https://opensource.org/licenses/MIT)
-*/
-
-// Databases
-import databaseMethods from './database';
-import databasesMethods from './databases';
-// Stores
-import storeMethods from './store';
-import storesMethods from './stores';
-// Entries
-import entryMethods from './entry';
-// Indexes
-import indexMethods from './index';
-import indexesMethods from './indexes';
-// Behaviors
-import behaviorMethods from './behaviors';
-
-const dash = ((internal: any) => {
-  'use strict';
-
-  var Public: any = {};
-  var names: string[] = [];
-  var name: string;
-
-  // Function to safely iterate over internal API and build the Public API
-  function safeIterate(obj: any, callback: (sig: string, fnref: Function) => void) {
-    for (const key in obj) {
-      if (obj.hasOwnProperty(key)) {
-        callback(key, obj[key]);
-      }
-    }
-  }
-
-  // Function to wrap each request (assuming wrapRequest provides promise handling or similar)
-  function wrapRequest(fnref: Function, sig: string) {
-    return (...args: any[]) => {
-      try {
-        return fnref.apply(null, args);
-      } catch (error) {
-        console.error(`Error in ${sig}:`, error);
-        throw error;
-      }
-    };
-  }
-
-  // Iterate over the internal API object and construct the Public API
-  safeIterate(internal, function (sig: string, fnref: Function) {
-    names = sig.split('.');
-    name = names[0];
-    Public[name] = Public[name] || {};
-    Public[name][names[1]] = wrapRequest(fnref, sig);
-  });
-
-  return Public;
-})({
-  'add.entry': entryMethods.put,
-  'add.behavior': behaviorMethods.add,
-  'clear.store': storeMethods.clear,
-  'count.entries': entryMethods.count,
-  'get.behaviors': behaviorMethods.get,
-  'get.database': databaseMethods.get,
-  'get.databases': databasesMethods.get,
-  'get.store': storeMethods.get,
-  'get.stores': storesMethods.get,
-  //'get.index': indexMethods.get,
-  'get.indexes': indexesMethods.get,
-  'get.entries': entryMethods.get,
-  'get.entry': entryMethods.get,
-  'remove.database': databaseMethods.remove,
-  'remove.entries': entryMethods.remove,
-  //'remove.index': indexMethods.remove,
-  'remove.entry': entryMethods.remove,
-  'remove.store': storeMethods.remove,
-  'update.entries': entryMethods.update,
-  'update.entry': entryMethods.put,
-  '$$': behaviorMethods.process
-});
-
-// Export the dash library
-export default dash;

package/src/indexes/index.ts

@@ -1,151 +0,0 @@
-
-/**
- * Indexes methods
- * @module indexes
- */
-import { cloneError, DashContext, safeApply } from "../utilities";
-
-// Indexes methods
-export const indexesMethods = {
-    /**
-     * Get all indexes from a specific object store.
-     * @param get_ctx The context object.
-     * @returns Promise<DashContext>
-     */
-    get: function (get_ctx: DashContext): Promise<DashContext> {
-        return new Promise((resolve, reject) => {
-            try {
-                get_ctx.indexes = get_ctx.objectstore?.indexNames;
-                if (get_ctx.on_success) {
-                    safeApply(get_ctx.on_success, [get_ctx]);
-                }
-                resolve(get_ctx);
-            } catch (error) {
-                get_ctx.error = cloneError(error as Error);
-                if (get_ctx.on_error) {
-                    safeApply(get_ctx.on_error, [get_ctx]);
-                }
-                reject(get_ctx);
-            }
-        });
-    },
-
-    /**
-     * Add a new index to an object store.
-     * @param add_ctx The context object.
-     * @returns Promise<DashContext>
-     */
-    add: function (add_ctx: DashContext): Promise<DashContext> {
-        return new Promise((resolve, reject) => {
-            try {
-                add_ctx.objectstore?.createIndex(add_ctx.index, add_ctx.index_key_path, {
-                    unique: !!add_ctx.index_unique,
-                    multiEntry: !!add_ctx.index_multi_entry
-                });
-                if (add_ctx.on_success) {
-                    safeApply(add_ctx.on_success, [add_ctx]);
-                }
-                resolve(add_ctx);
-            } catch (error) {
-                add_ctx.error = cloneError(error as Error);
-                if (add_ctx.on_error) {
-                    safeApply(add_ctx.on_error, [add_ctx]);
-                }
-                reject(add_ctx);
-            }
-        });
-    },
-
-    /**
-     * Remove an index from an object store.
-     * @param remove_ctx The context object.
-     * @returns Promise<DashContext>
-     */
-    remove: function (remove_ctx: DashContext): Promise<DashContext> {
-        return new Promise((resolve, reject) => {
-            try {
-                remove_ctx.objectstore?.deleteIndex(remove_ctx.index);
-                if (remove_ctx.on_success) {
-                    safeApply(remove_ctx.on_success, [remove_ctx]);
-                }
-                resolve(remove_ctx);
-            } catch (error) {
-                remove_ctx.error = cloneError(error as Error);
-                if (remove_ctx.on_error) {
-                    safeApply(remove_ctx.on_error, [remove_ctx]);
-                }
-                reject(remove_ctx);
-            }
-        });
-    },
-    /**
- * Get all entries from a specific index.
- * @param get_ctx The context object.
- * @returns Promise<DashContext>
- */
-    getEntries: function (get_ctx: DashContext): Promise<DashContext> {
-        return new Promise((resolve, reject) => {
-            const request = get_ctx.objectstore?.index(get_ctx.index)?.openCursor();
-
-            if (!request) {
-                get_ctx.error = new Error("Failed to open cursor");
-                if (get_ctx.on_error) {
-                    safeApply(get_ctx.on_error, [get_ctx]);
-                }
-                reject(get_ctx);
-                return;
-            }
-
-            request.onsuccess = function (event) {
-                const cursor = request.result;
-                if (cursor) {
-                    if (get_ctx.on_success) {
-                        safeApply(get_ctx.on_success, [cursor.value]);
-                    }
-                    cursor.continue();
-                } else {
-                    if (get_ctx.on_complete) {
-                        safeApply(get_ctx.on_complete, [get_ctx]);
-                    }
-                    resolve(get_ctx);
-                }
-            };
-
-            request.onerror = function (event) {
-                get_ctx.error = cloneError(request.error!);
-                if (get_ctx.on_error) {
-                    safeApply(get_ctx.on_error, [get_ctx]);
-                }
-                reject(get_ctx);
-            };
-        });
-    },
-    /**
-     * Counts the number of entries in a specific index.
-     * @param count_ctx The context object.
-     * @returns Promise<DashContext>
-     */
-    countEntries: function (count_ctx: DashContext): Promise<DashContext> {
-        return new Promise((resolve, reject) => {
-            const request = count_ctx.objectstore?.index(count_ctx.index)?.count();
-
-            request?.addEventListener('success', function () {
-                count_ctx.total = request.result;
-                if (count_ctx.on_success) {
-                    safeApply(count_ctx.on_success, [count_ctx]);
-                }
-                resolve(count_ctx);
-            });
-
-            request?.addEventListener('error', function (event: any) {
-                count_ctx.error = cloneError((event as any).target.error);
-                if (count_ctx.on_error) {
-                    safeApply(count_ctx.on_error, [count_ctx]);
-                }
-                reject(count_ctx);
-            });
-        });
-    }
-};
-
-export default indexesMethods;

package/src/store/index.ts

@@ -1,102 +0,0 @@
-
-/**
- * Store methods
- * @module store
- */
-
-import { cloneError, DashContext, exists } from "../utilities";
-
-// Store methods
-export const storeMethods = {
-    /**
-     * Clear a store.
-     * @param clear_ctx 
-     * @returns Promise<DashContext>
-     */
-    clear: (clear_ctx: DashContext): Promise<DashContext> => {
-        return new Promise((resolve, reject) => {
-            const request: IDBRequest<any> | undefined = clear_ctx.objectstore?.clear();
-
-            request?.addEventListener('success', () => {
-                if (clear_ctx.on_success) {
-                    clear_ctx.on_success(clear_ctx);  // Call the success callback here
-                }
-                resolve(clear_ctx);
-            });
-
-            request?.addEventListener('error', (event) => {
-                clear_ctx.error = cloneError((event as any).target.error);
-                if (clear_ctx.on_error) {
-                    clear_ctx.on_error(clear_ctx);  // Call the error callback here
-                }
-                reject(clear_ctx);
-            });
-        });
-    },
-    
-    /**
-     * Remove a store entry.
-     * @param remove_ctx 
-     * @returns Promise<DashContext>
-     */
-    remove: (remove_ctx: DashContext): Promise<DashContext> => {
-        return new Promise((resolve, reject) => {
-            const request: IDBRequest<any> | undefined = remove_ctx.objectstore?.delete(remove_ctx.key);
-
-            request?.addEventListener('success', () => {
-                if (remove_ctx.on_success) {
-                    remove_ctx.on_success(remove_ctx);  // Call the success callback here
-                }
-                resolve(remove_ctx);
-            });
-
-            request?.addEventListener('error', (event) => {
-                remove_ctx.error = cloneError((event as any).target.error);
-                if (remove_ctx.on_error) {
-                    remove_ctx.on_error(remove_ctx);  // Call the error callback here
-                }
-                reject(remove_ctx);
-            });
-        });
-    },
-
-    /**
-     * Get a store entry.
-     * @param get_ctx 
-     * @returns Promise<DashContext>
-     */
-    get: (get_ctx: DashContext): Promise<DashContext> => {
-        return new Promise((resolve, reject) => {
-            const request: IDBRequest<any> | undefined = exists(get_ctx.index)
-                ? get_ctx.objectstore?.index(get_ctx.index)?.get(get_ctx.key) as IDBRequest<any>
-                : get_ctx.objectstore?.get(get_ctx.key) as IDBRequest<any>;
-
-            request?.addEventListener('success', () => {
-                get_ctx.entry = request.result;
-                if (!get_ctx.entry) {
-                    get_ctx.error = { message: 'missing', name: 'DashNoEntry' };
-                    if (get_ctx.on_error) {
-                        get_ctx.on_error(get_ctx);  // Call the error callback here
-                    }
-                    reject(get_ctx);
-                } else {
-                    if (get_ctx.on_success) {
-                        get_ctx.on_success(get_ctx);  // Call the success callback here
-                    }
-                    resolve(get_ctx);
-                }
-            });
-
-            request?.addEventListener('error', (event) => {
-                get_ctx.error = cloneError((event as any).target.error);
-                if (get_ctx.on_error) {
-                    get_ctx.on_error(get_ctx);  // Call the error callback here
-                }
-                reject(get_ctx);
-            });
-        });
-    }
-};
-
-// Export the store methods
-export default storeMethods;

package/src/stores/index.ts

@@ -1,90 +0,0 @@
-/**
- * Stores methods.
- * @Module stores
- */
-import { cloneError, DashContext, exists, safeApply } from "../utilities";
-
-// Store methods
-export const storesMethods = {
-    /**
-     * Get all object stores from the current database.
-     * @param get_ctx The context object.
-     * @returns Promise<DashContext>
-     * @private
-     */
-    get: function (get_ctx: DashContext) {
-        // This method retrieves all object stores synchronously or asynchronously via an on_success callback.
-        get_ctx.stores = get_ctx.db?.objectStoreNames;
-        safeApply(get_ctx.on_success, [get_ctx]);
-    },
-    /**
-     * Add a new object store to the current database.
-     * @param add_ctx The context object.
-     * @returns Promise<DashContext>
-     * @private
-     */
-    add: function (add_ctx: DashContext) {
-        // This method adds a new object store in the database, creating a version change.
-        add_ctx.db = add_ctx.request?.result;
-        if (!add_ctx.db) {
-            throw new Error("Database is undefined");
-        }
-        const store = add_ctx.db.createObjectStore(add_ctx.store, {
-            keyPath: add_ctx.store_key_path || null,
-            autoIncrement: !!add_ctx.auto_increment
-        });
-
-        if (add_ctx.request) {
-            add_ctx.db = add_ctx.request.result;
-        }
-
-        if (add_ctx.indexes) {
-            // If there are indexes defined, we create them in the new store
-            add_ctx.indexes.forEach((idx: any) => {
-                store.createIndex(idx.name, idx.keyPath, {
-                    unique: !!idx.unique,
-                    multiEntry: !!idx.multiEntry
-                });
-            });
-        }
-
-        safeApply(add_ctx.on_success, [add_ctx]);
-    },
-    /**
-     * Remove an object store from the current database.
-     * @param remove_ctx The context object.
-     * @returns Promise<DashContext>
-     * @private
-     */
-    remove: function (remove_ctx: DashContext) {
-        // This method deletes a specified object store, triggering a version change.
-        remove_ctx.db?.deleteObjectStore(remove_ctx.store);
-        safeApply(remove_ctx.on_success, [remove_ctx]);
-    },
-    /**
-     * Clear all object stores in the current database.
-     * @param clear_ctx The context object.
-     * @returns Promise<DashContext>
-     * @private
-     */
-    clearAll: function (clear_ctx: DashContext) {
-        // This method clears all entries in all object stores in the current database.
-        const storeNames = Array.from(clear_ctx.db?.objectStoreNames || []);
-        const transaction = clear_ctx.db?.transaction(storeNames as any, "readwrite");
-
-        storeNames?.forEach((storeName: string) => {
-            const objectStore = transaction?.objectStore(storeName);
-            objectStore?.clear();
-        });
-
-        transaction?.addEventListener('complete', () => {
-            safeApply(clear_ctx.on_success, [clear_ctx]);
-        });
-
-        transaction?.addEventListener('error', (event) => {
-            clear_ctx.error = cloneError((event as any).target.error);
-            safeApply(clear_ctx.on_error, [clear_ctx]);
-        });
-    }
-};
-export default storesMethods;