@fireproof/core 0.6.4 → 0.7.0-alpha.0

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

package/src/listener.js

@@ -1,119 +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'
-/**
- * @deprecated since version 0.7.0
- */
-export class Listener {
-  subcribers = new Map()
-  doStopListening = null
-
-  /**
-   * @param {import('./database.js').Database} database
-   * @param {(_: any, emit: any) => void} routingFn
-   */
-  constructor (
-    database,
-    routingFn = function (/** @type {any} */ _, /** @type {(arg0: string) => void} */ emit) {
-      emit('*')
-    }
-  ) {
-    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
-
-    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] - clock to flush from on launch, pass null for all
-   */
-  on (topic, subscriber, since = undefined) {
-    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
-}

package/src/utils.js

@@ -1,16 +0,0 @@
-
-/* global localStorage */
-let storageSupported = false
-try {
-  storageSupported = window.localStorage && true
-} catch (e) {}
-export function localGet (key) {
-  if (storageSupported) {
-    return localStorage && localStorage.getItem(key)
-  }
-}
-export function localSet (key, value) {
-  if (storageSupported) {
-    return localStorage && localStorage.setItem(key, value)
-  }
-}