@fireproof/core 0.6.5 → 0.6.6

package/dist/{src/storage → storage}/filesystem.js

@@ -1,8 +1,11 @@
-import { readFileSync } from 'fs';
-import { mkdir, writeFile } from 'fs/promises';
+// import { mkdir, writeFile } from 'fs/promises'
 import { join, dirname } from 'path';
 import { homedir } from 'os';
 import { Base } from './base.js';
+// import { readFileSync } from 'node:fs'
+// const { readFileSync } = require('fs')
+import fs from 'fs';
+const readFileSync = fs.readFileSync;
 export const defaultConfig = {
     dataDir: join(homedir(), '.fireproof')
 };
@@ -59,7 +62,7 @@ function loadSync(filename) {
     }
 }
 async function writeSync(fullpath, stringValue) {
-    await mkdir(dirname(fullpath), { recursive: true });
+    await fs.promises.mkdir(dirname(fullpath), { recursive: true });
     // writeFileSync(fullpath, stringValue)
-    await writeFile(fullpath, stringValue);
+    await fs.promises.writeFile(fullpath, stringValue);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fireproof/core",
-  "version": "0.6.5",
+  "version": "0.6.6",
   "description": "Live data for React, accelerated by proofs, powered by IPFS",
   "main": "dist/src/fireproof.js",
   "module": "dist/src/fireproof.mjs",
@@ -110,9 +110,6 @@
       "default": "./dist/src/fireproof.js",
       "require": "./dist/src/fireproof.js"
     },
-    "./hooks/use-fireproof": {
-      "import": "./hooks/use-fireproof.js"
-    },
     "./package.json": "./package.json"
   },
   "files": [

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/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)
-//   }
-// }