@fireproof/core 0.4.0 → 0.5.0

package/dist/fireproof.js

@@ -1,83 +0,0 @@
-import randomBytes from 'randombytes';
-import { Database } from './database.js';
-import { Listener } from './listener.js';
-import { DbIndex as Index } from './db-index.js';
-import { CID } from 'multiformats';
-import { TransactionBlockstore } from './blockstore.js';
-import { localGet } from './utils.js';
-export { Index, Listener };
-const parseCID = cid => typeof cid === 'string' ? CID.parse(cid) : cid;
-class Fireproof {
-    /**
-     * @function storage
-     * @memberof Fireproof
-     * Creates a new Fireproof instance with default storage settings
-     * Most apps should use this and not worry about the details.
-     * @static
-     * @returns {Fireproof} - a new Fireproof instance
-     */
-    static storage = (name = null, opts = {}) => {
-        if (name) {
-            opts.name = name;
-            const existing = localGet('fp.' + name);
-            if (existing) {
-                const existingConfig = JSON.parse(existing);
-                const fp = new Database(new TransactionBlockstore(name, existingConfig.key), [], opts);
-                return this.fromJSON(existingConfig, fp);
-            }
-            else {
-                const instanceKey = randomBytes(32).toString('hex'); // pass null to disable encryption
-                return new Database(new TransactionBlockstore(name, instanceKey), [], opts);
-            }
-        }
-        else {
-            return new Database(new TransactionBlockstore(), [], opts);
-        }
-    };
-    static fromJSON(json, database) {
-        database.hydrate({ clock: json.clock.map(c => parseCID(c)), name: json.name, key: json.key });
-        if (json.indexes) {
-            for (const { name, code, clock: { byId, byKey, db } } of json.indexes) {
-                Index.fromJSON(database, {
-                    clock: {
-                        byId: byId ? parseCID(byId) : null,
-                        byKey: byKey ? parseCID(byKey) : null,
-                        db: db ? db.map(c => parseCID(c)) : null
-                    },
-                    code,
-                    name
-                });
-            }
-        }
-        return database;
-    }
-    static snapshot(database, clock) {
-        const definition = database.toJSON();
-        const withBlocks = new Database(database.blocks);
-        if (clock) {
-            definition.clock = clock.map(c => parseCID(c));
-            definition.indexes.forEach(index => {
-                index.clock.byId = null;
-                index.clock.byKey = null;
-                index.clock.db = null;
-            });
-        }
-        const snappedDb = this.fromJSON(definition, withBlocks);
-        ([...database.indexes.values()]).forEach(index => {
-            snappedDb.indexes.get(index.mapFnString).mapFn = index.mapFn;
-        });
-        return snappedDb;
-    }
-    static async zoom(database, clock) {
-        ;
-        ([...database.indexes.values()]).forEach(index => {
-            index.indexById = { root: null, cid: null };
-            index.indexByKey = { root: null, cid: null };
-            index.dbHead = null;
-        });
-        database.clock = clock.map(c => parseCID(c));
-        await database.notifyReset(); // hmm... indexes should listen to this? might be more complex than worth it. so far this is the only caller
-        return database;
-    }
-}
-export { Fireproof };

package/dist/hooks/use-fireproof.js

@@ -1,100 +0,0 @@
-// @ts-ignore
-import { useEffect, useState } from 'react';
-import { Fireproof, Listener } from '../src/fireproof.js';
-/**
-@typedef {Object} FireproofCtxValue
-@property {Function} addSubscriber - A function to add a subscriber with a label and function.
-@property {Fireproof} database - An instance of the Fireproof class.
-@property {boolean} ready - A boolean indicating whether the database is ready.
-@param {string} label - A label for the subscriber.
-@param {Function} fn - A function to be added as a subscriber.
-@returns {void}
-*/
-const inboundSubscriberQueue = new Map();
-let startedSetup = false;
-let database;
-let listener;
-const initializeDatabase = name => {
-    if (database)
-        return;
-    database = Fireproof.storage(name);
-    listener = new Listener(database);
-};
-/**
-
-@function useFireproof
-React hook to initialize a Fireproof database, automatically saving and loading the clock.
-You might need to import { nodePolyfills } from 'vite-plugin-node-polyfills' in your vite.config.ts
-@param {string} name - The path to the database file
-@param {function(database): void} [defineDatabaseFn] - Synchronous function that defines the database, run this before any async calls
-@param {function(database): Promise<void>} [setupDatabaseFn] - Asynchronous function that sets up the database, run this to load fixture data etc
-@returns {FireproofCtxValue} { addSubscriber, database, ready }
-*/
-export function useFireproof(name, defineDatabaseFn = () => { }, setupDatabaseFn = async () => { }) {
-    const [ready, setReady] = useState(false);
-    initializeDatabase(name || 'useFireproof');
-    const addSubscriber = (label, fn) => {
-        inboundSubscriberQueue.set(label, fn);
-    };
-    const listenerCallback = async (event) => {
-        if (event._external)
-            return;
-        for (const [, fn] of inboundSubscriberQueue)
-            fn();
-    };
-    useEffect(() => {
-        const doSetup = async () => {
-            if (ready)
-                return;
-            if (startedSetup)
-                return;
-            startedSetup = true;
-            defineDatabaseFn(database); // define indexes before querying them
-            if (database.clock.length === 0) {
-                await setupDatabaseFn(database);
-            }
-            setReady(true);
-            listener.on('*', listenerCallback); // hushed('*', listenerCallback, 250))
-        };
-        doSetup();
-    }, [ready]);
-    return {
-        addSubscriber,
-        database,
-        ready
-    };
-}
-// const husherMap = new Map()
-// const husher = (id, workFn, ms) => {
-//   if (!husherMap.has(id)) {
-//     const start = Date.now()
-//     husherMap.set(
-//       id,
-//       workFn().finally(() => setTimeout(() => husherMap.delete(id), ms - (Date.now() - start)))
-//     )
-//   }
-//   return husherMap.get(id)
-// }
-// const hushed =
-//   (id, workFn, ms) =>
-//     (...args) =>
-//       husher(id, () => workFn(...args), ms)
-// let storageSupported = false
-// try {
-//   storageSupported = window.localStorage && true
-// } catch (e) {}
-// export function localGet (key) {
-//   if (storageSupported) {
-//     return localStorage && localStorage.getItem(key)
-//   }
-// }
-// function localSet (key, value) {
-//   if (storageSupported) {
-//     return localStorage && localStorage.setItem(key, value)
-//   }
-// }
-// function localRemove(key) {
-//   if (storageSupported) {
-//     return localStorage && localStorage.removeItem(key)
-//   }
-// }

package/dist/listener.js

@@ -1,110 +0,0 @@
-/**
- * A Fireproof database Listener allows you to react to events in the database.
- *
- * @class Listener
- * @classdesc An listener attaches to a Fireproof database and runs a routing function on each change, sending the results to subscribers.
- *
- * @param {import('./database.js').Database} database - The Database database instance to index.
- * @param {Function} routingFn - The routing function to apply to each entry in the database.
- */
-// import { ChangeEvent } from './db-index'
-export class Listener {
-    subcribers = new Map();
-    doStopListening = null;
-    /**
-     * @param {import('./database.js').Database} database
-     * @param {(_: any, emit: any) => void} routingFn
-     */
-    constructor(database, routingFn) {
-        this.database = database;
-        this.doStopListening = database.registerListener((/** @type {any} */ changes) => this.onChanges(changes));
-        /**
-         * The map function to apply to each entry in the database.
-         * @type {Function}
-         */
-        this.routingFn =
-            routingFn ||
-                function (/** @type {any} */ _, /** @type {(arg0: string) => void} */ emit) {
-                    emit('*');
-                };
-        this.dbHead = null;
-    }
-    /**
-     * Subscribe to a topic emitted by the event function.
-     * @param {string} topic - The topic to subscribe to.
-     * @param {Function} subscriber - The function to call when the topic is emitted.
-     * @returns {Function} A function to unsubscribe from the topic.
-     * @memberof Listener
-     * @instance
-     * @param {any} since
-     */
-    on(topic, subscriber, since) {
-        const listOfTopicSubscribers = getTopicList(this.subcribers, topic);
-        listOfTopicSubscribers.push(subscriber);
-        if (typeof since !== 'undefined') {
-            this.database.changesSince(since).then(({ rows: changes }) => {
-                const keys = topicsForChanges(changes, this.routingFn).get(topic);
-                if (keys)
-                    keys.forEach((/** @type {any} */ key) => subscriber(key));
-            });
-        }
-        return () => {
-            const index = listOfTopicSubscribers.indexOf(subscriber);
-            if (index > -1)
-                listOfTopicSubscribers.splice(index, 1);
-        };
-    }
-    /**
-     * @typedef {import('./db-index').ChangeEvent} ChangeEvent
-     */
-    /**
-     * @param {ChangeEvent[]} changes
-     */
-    onChanges(changes) {
-        if (Array.isArray(changes)) {
-            const seenTopics = topicsForChanges(changes, this.routingFn);
-            for (const [topic, keys] of seenTopics) {
-                const listOfTopicSubscribers = getTopicList(this.subcribers, topic);
-                listOfTopicSubscribers.forEach((/** @type {(arg0: any) => any} */ subscriber) => keys.forEach((/** @type {any} */ key) => subscriber(key)));
-            }
-        }
-        else {
-            // non-arrays go to all subscribers
-            for (const [, listOfTopicSubscribers] of this.subcribers) {
-                listOfTopicSubscribers.forEach((/** @type {(arg0: any) => any} */ subscriber) => subscriber(changes));
-            }
-        }
-    }
-}
-/**
- * @param {Map<any, any>} subscribersMap
- * @param {string} name
- */
-function getTopicList(subscribersMap, name) {
-    let topicList = subscribersMap.get(name);
-    if (!topicList) {
-        topicList = [];
-        subscribersMap.set(name, topicList);
-    }
-    return topicList;
-}
-/**
- * Transforms a set of changes to events using an emitter function.
- *
- * @param {ChangeEvent[]} changes
- * @param {Function} routingFn
- * @returns {Map<string,string[]>} The topics emmitted by the event function.
- * @private
- */
-const topicsForChanges = (changes, routingFn) => {
-    const seenTopics = new Map();
-    changes.forEach(({ key, value, del }) => {
-        if (del || !value)
-            value = { _deleted: true };
-        routingFn({ _id: key, ...value }, (/** @type {any} */ t) => {
-            const topicList = getTopicList(seenTopics, t);
-            topicList.push(key);
-        });
-    });
-    return seenTopics;
-};