@fireproof/core 0.6.4 → 0.6.6

package/dist/hooks/use-fireproof.js

@@ -1,150 +0,0 @@
-// @ts-ignore
-import { useEffect, useState, useCallback, createContext } from 'react';
-import { Fireproof, Index } from '@fireproof/core';
-/**
-@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 {Function} useLiveQuery - A hook to return a query result
-@property {Function} useLiveDocument - A hook to return a live document
-@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}
-*/
-export const FireproofCtx = createContext({
-    addSubscriber: () => { },
-    database: null,
-    ready: false
-});
-// const inboundSubscriberQueue = new Map()
-let startedSetup = false;
-let database;
-const initializeDatabase = name => {
-    if (database)
-        return;
-    database = Fireproof.storage(name);
-};
-/**
-@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
-@deprecated - npm install @fireproof/react instead
-@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} { useLiveQuery, useLiveDocument, database, ready }
-*/
-export function useFireproof(name = 'useFireproof', defineDatabaseFn = () => { }, setupDatabaseFn = async () => { }) {
-    const [ready, setReady] = useState(false);
-    initializeDatabase(name);
-    /**
-     * @deprecated - use database.subscribe instead
-     */
-    const addSubscriber = (label, fn) => {
-        // todo test that the label is not needed
-        return database.registerListener(fn);
-        // inboundSubscriberQueue.set(label, 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);
-        };
-        doSetup();
-    }, [ready]);
-    function useLiveDocument(initialDoc) {
-        const id = initialDoc._id;
-        const [doc, setDoc] = useState(initialDoc);
-        const saveDoc = async (newDoc) => {
-            await database.put({ _id: id, ...newDoc });
-        };
-        const refreshDoc = useCallback(async () => {
-            // todo add option for mvcc checks
-            const got = await database.get(id).catch(() => initialDoc);
-            setDoc(got);
-        }, [id, initialDoc]);
-        useEffect(() => database.subscribe(change => {
-            if (change.find(c => c.key === id)) {
-                refreshDoc(); // todo use change.value
-            }
-        }), [id, refreshDoc]);
-        useEffect(() => {
-            refreshDoc();
-        }, []);
-        return [doc, saveDoc];
-    }
-    function useLiveQuery(mapFn, query = null, initialRows = []) {
-        const [rows, setRows] = useState({ rows: initialRows, proof: {} });
-        const [index, setIndex] = useState(null);
-        const refreshRows = useCallback(async () => {
-            if (!index)
-                return;
-            const got = await index.query(query || {});
-            setRows(got);
-        }, [index, JSON.stringify(query)]);
-        useEffect(() => {
-            // todo listen to index changes
-            return database.subscribe(() => {
-                refreshRows();
-            });
-        }, [refreshRows]);
-        useEffect(() => {
-            refreshRows();
-        }, [index]);
-        useEffect(() => {
-            const index = new Index(database, null, mapFn); // this should only be created once
-            setIndex(index);
-        }, [mapFn.toString()]);
-        return rows;
-    }
-    return {
-        addSubscriber,
-        useLiveQuery,
-        useLiveDocument,
-        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/src/crypto-poly.js

@@ -1,4 +0,0 @@
-import crypto from 'crypto-browserify';
-export function randomBytes(n) {
-    return crypto.randomBytes(n);
-}

package/dist/src/link.js

@@ -1 +0,0 @@
-export {};

package/dist/src/loader.js

@@ -1,131 +0,0 @@
-import { readFileSync
-// createReadStream
- } from 'node:fs';
-import { mkdir, writeFile } from 'node:fs/promises';
-import { openDB } from 'idb';
-import { join, dirname } from 'path';
-// import { parse } from '@jsonlines/core'
-// import cargoQueue from 'async/cargoQueue.js'
-import { homedir } from 'os';
-const defaultConfig = {
-    dataDir: join(homedir(), '.fireproof'),
-    headerKeyPrefix: 'fp.'
-};
-const FORCE_IDB = typeof process !== 'undefined' && !!process.env?.FORCE_IDB;
-/* global localStorage */
-export class Loader {
-    constructor(name, keyId, config = defaultConfig) {
-        this.name = name;
-        this.keyId = keyId;
-        this.config = config;
-        this.isBrowser = false;
-        try {
-            this.isBrowser = window.localStorage && true;
-        }
-        catch (e) { }
-    }
-    withDB = async (dbWorkFun) => {
-        if (!this.idb) {
-            this.idb = await openDB(`fp.${this.keyId}.${this.name}.valet`, 3, {
-                upgrade(db, oldVersion, newVersion, transaction) {
-                    if (oldVersion < 1) {
-                        db.createObjectStore('cars');
-                    }
-                }
-            });
-        }
-        return await dbWorkFun(this.idb);
-    };
-    async writeCars(cars) {
-        // console.log('writeCars', this.config.dataDir, this.name, cars.map(c => c.cid.toString()))
-        // console.log('writeCars', cars.length)
-        if (FORCE_IDB || this.isBrowser) {
-            await this.writeCarsIDB(cars);
-        }
-        else {
-            const writes = [];
-            for (const { cid, bytes } of cars) {
-                const carFilename = join(this.config.dataDir, this.name, `${cid.toString()}.car`);
-                // console.log('writeCars', carFilename)
-                writes.push(writeSync(carFilename, bytes));
-            }
-            await Promise.all(writes);
-        }
-    }
-    async writeCarsIDB(cars) {
-        return await this.withDB(async (db) => {
-            const tx = db.transaction(['cars'], 'readwrite');
-            for (const { cid, bytes, replaces } of cars) {
-                await tx.objectStore('cars').put(bytes, cid.toString());
-                // todo remove old maps
-                if (replaces) {
-                    await tx.objectStore('cars').delete(replaces.toString());
-                }
-            }
-            return await tx.done;
-        });
-    }
-    async readCar(carCid) {
-        if (FORCE_IDB || this.isBrowser) {
-            return await this.readCarIDB(carCid);
-        }
-        else {
-            const carFilename = join(this.config.dataDir, this.name, `${carCid.toString()}.car`);
-            const got = readFileSync(carFilename);
-            // console.log('readCar', carFilename, got.constructor.name)
-            return got;
-        }
-    }
-    async readCarIDB(carCid) {
-        return await this.withDB(async (db) => {
-            const tx = db.transaction(['cars'], 'readonly');
-            // console.log('getCarReader', carCid)
-            return await tx.objectStore('cars').get(carCid);
-        });
-    }
-    getHeader() {
-        if (this.isBrowser) {
-            return localStorage.getItem(this.config.headerKeyPrefix + this.name);
-        }
-        else {
-            return loadSync(this.headerFilename());
-            // return null
-        }
-    }
-    async saveHeader(stringValue) {
-        // console.log('saveHeader', this.isBrowser)
-        if (this.isBrowser) {
-            // console.log('localStorage!', this.config.headerKeyPrefix)
-            return localStorage.setItem(this.config.headerKeyPrefix + this.name, stringValue);
-        }
-        else {
-            // console.log('no localStorage', this.config.dataDir, this.name)
-            // console.log('saving clock to', this.headerFilename(), stringValue)
-            try {
-                await writeSync(this.headerFilename(), stringValue);
-            }
-            catch (error) {
-                console.log('error', error);
-            }
-            // console.log('saved clock to', this.headerFilename())
-        }
-    }
-    headerFilename() {
-        // console.log('headerFilename', this.config.dataDir, this.name)
-        return join(this.config.dataDir, this.name, 'header.json');
-    }
-}
-function loadSync(filename) {
-    try {
-        return readFileSync(filename, 'utf8').toString();
-    }
-    catch (error) {
-        // console.log('error', error)
-        return null;
-    }
-}
-async function writeSync(fullpath, stringValue) {
-    await mkdir(dirname(fullpath), { recursive: true });
-    // writeFileSync(fullpath, stringValue)
-    await writeFile(fullpath, stringValue);
-}

package/hooks/use-fireproof.js

@@ -1,173 +0,0 @@
-// @ts-ignore
-import { useEffect, useState, useCallback, createContext } from 'react'
-import { Fireproof, Index } from '@fireproof/core'
-
-/**
-@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 {Function} useLiveQuery - A hook to return a query result
-@property {Function} useLiveDocument - A hook to return a live document
-@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}
-*/
-export const FireproofCtx = createContext({
-  addSubscriber: () => {},
-  database: null,
-  ready: false
-})
-
-// const inboundSubscriberQueue = new Map()
-
-let startedSetup = false
-let database
-const initializeDatabase = name => {
-  if (database) return
-  database = Fireproof.storage(name)
-}
-
-/**
-@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
-@deprecated - npm install @fireproof/react instead
-@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} { useLiveQuery, useLiveDocument, database, ready }
-*/
-export function useFireproof (name = 'useFireproof', defineDatabaseFn = () => {}, setupDatabaseFn = async () => {}) {
-  const [ready, setReady] = useState(false)
-  initializeDatabase(name)
-
-  /**
-   * @deprecated - use database.subscribe instead
-   */
-  const addSubscriber = (label, fn) => {
-    // todo test that the label is not needed
-    return database.registerListener(fn)
-    // inboundSubscriberQueue.set(label, 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)
-    }
-    doSetup()
-  }, [ready])
-
-  function useLiveDocument (initialDoc) {
-    const id = initialDoc._id
-    const [doc, setDoc] = useState(initialDoc)
-
-    const saveDoc = async newDoc => {
-      await database.put({ _id: id, ...newDoc })
-    }
-    const refreshDoc = useCallback(async () => {
-      // todo add option for mvcc checks
-      const got = await database.get(id).catch(() => initialDoc)
-      setDoc(got)
-    }, [id, initialDoc])
-
-    useEffect(
-      () =>
-        database.subscribe(change => {
-          if (change.find(c => c.key === id)) {
-            refreshDoc() // todo use change.value
-          }
-        }),
-      [id, refreshDoc]
-    )
-
-    useEffect(() => {
-      refreshDoc()
-    }, [])
-
-    return [doc, saveDoc]
-  }
-
-  function useLiveQuery (mapFn, query = null, initialRows = []) {
-    const [rows, setRows] = useState({ rows: initialRows, proof: {} })
-    const [index, setIndex] = useState(null)
-
-    const refreshRows = useCallback(async () => {
-      if (!index) return
-      const got = await index.query(query || {})
-      setRows(got)
-    }, [index, JSON.stringify(query)])
-
-    useEffect(
-      () => {
-        // todo listen to index changes
-        return database.subscribe(() => {
-          refreshRows()
-        })
-      },
-      [refreshRows]
-    )
-
-    useEffect(() => {
-      refreshRows()
-    }, [index])
-
-    useEffect(() => {
-      const index = new Index(database, null, mapFn) // this should only be created once
-      setIndex(index)
-    }, [mapFn.toString()])
-
-    return rows
-  }
-
-  return {
-    addSubscriber,
-    useLiveQuery,
-    useLiveDocument,
-    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)
-//   }
-// }