@fireproof/core 0.8.0 → 0.10.1-dev

package/README.md

@@ -1,188 +1,9 @@
-<p align="center" >
-  <a href="https://fireproof.storage/">
-    <img src="https://fireproof.storage/static/img/logo-animated-black.svg" alt="Fireproof logo" width="200">
-  </a>
-</p>
-<h3 align="center">
-  Cloudless database for React apps
-</h3>
+# Fireproof
 
-<p align="center">
-  <a href="https://github.com/fireproof-storage/fireproof/actions/workflows/test.yml">
-    <img src="https://github.com/fireproof-storage/fireproof/actions/workflows/test.yml/badge.svg" alt="Test" style="max-width: 100%;">
-  </a>
-  <a href="https://standardjs.com" rel="nofollow">
-    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="JavaScript Style Guide"  style="max-width: 100%;">
-  </a>
-  <a href="https://github.com/fireproof-storage/fireproof/blob/main/packages/react/README.md">
-    <img src="https://shields.io/badge/react-black?logo=react&style=for-the-badge%22" alt="React"  style="max-width: 100%;">
-  </a>
-  <a href="https://bundlephobia.com/package/@fireproof/core" rel="nofollow">
-    <img src="https://deno.bundlejs.com/?q=@fireproof/core&treeshake=[*+as+fireproofCore]&badge" alt="Bundle Size"  style="max-width: 100%;">
-  </a>
-</p>
+## Build and Lint Process
 
-Fireproof uses immutable data and distributed protocols to offer a new kind of database that:
-- can be embedded in any page or app, with a flexible data ownership model
-- can be hosted on any cloud
-- uses cryptographically verifiable protocols (what plants crave)
+The project uses `esbuild` and `esbuild-plugin-tsc` for compiling TypeScript to JavaScript, the results of which are bundled into different module formats for different environments. The `build.js` script in the `scripts` directory orchestrates this process. You can trigger the build process by running `npm run build` in your terminal.
 
-Fireproof is optimized to make [building React apps](https://github.com/fireproof-storage/fireproof/blob/main/packages/react/README.md) fast and fun, with reliable results. Suitable for mission-critical data workloads like [LLM orchestration](https://fireproof.storage/posts/why-proofs-matter-for-ai/), supply-chain provenance, and field use of auditable data, [ Fireproof is also great](https://fireproof.storage/posts/great-opportunites-to-use-fireproof/) for social media, collaborative world-building, and rapidly implementing executive decision support tools that can stand up to blockchain levels of scrutiny.
+For code quality assurance, we utilize ESLint with `@typescript-eslint/parser` and `@typescript-eslint/eslint-plugin`. ESLint checks both the JavaScript and TypeScript code in the project. The configuration for ESLint is stored in the `.eslintrc.js` file. For the test files located in the `test` directory, there are additional linting configurations to accommodate Mocha-specific code.
 
-With Fireproof, you **build first** and connect it to your cloud of choice when you are ready, so there's nothing holding you back from adding it to your existing apps, or [writing something new.](https://hackernoon.com/get-chatgpt-to-focus-on-coding-on-the-right-apis-with-gptdoc-strings)
-
-
-## React Quick Start
-*One-line preview:* in the context of a React component render, `useLiveQuery` will automatically refresh (even on changes by remote collaborators):
-
-```js
-  const completedTodos = useLiveQuery((doc) => doc.completed, { key: true })
-```
-This is the README for the core database technology. [The `useFireproof` hook documentation has features and a getting started guide](https://github.com/fireproof-storage/fireproof/blob/main/packages/react/README.md), like `useDocument` and database setup helpers. Don't forget to star 🌟 this repo on the way over.
-
-## AI Assistant Quick Start
-
-Because Fireproof is designed around the mantra of build-first, it's ideal for AI-assisted app development as you can get an app up and running before even considering the cloud. If you are using GPT-3.5, GPT-4, or Bard, you can [easily enable the AI to write React apps using Fireproof](https://hackernoon.com/get-chatgpt-to-focus-on-coding-on-the-right-apis-with-gptdoc-strings). Paste this line of code into your prompt, along with a detailed description of the app to build:
-
-```
-Fireproof/React/Usage: import { useFireproof } from '@fireproof/react'; function App() { const { useLiveQuery, useDocument, database } = useFireproof(); const result = useLiveQuery(doc => doc.word, { limit: 10 }); const [{ count }, saveCountDocument] = useDocument({_id: 'count', count: 0}); return (<><p>{count} changes</p><input type='text' onChange={() => saveCountDocument({count: count + 1})} onSubmit={e => database.put({word: e.target.value})} /><ul>{result.map(row => (<li key={row.id}>{row.key}</li>))}</ul></>)}
-```
-
-Here are some examples that worked for us:
-
-* Create a React app using Fireproof for tracking party invites. It should have a text input that creates a new document with the guest name, and an Index that lists all guests in a &lt;ul&gt;. ([Running copy here.](https://codepen.io/jchrisa/pen/zYmogWO))
-* Build a photo grid app with drag-and-drop ordering that references photos by URL. Use tailwind and render all photos as squares. Keep grid arrangement in Fireproof with one document for each gallery, that is 4-16 photos arranged into a layout.
-* Build a React app that allows users to create a list of their favorite movies, and then share that list with friends. Use Fireproof to store the list of movies, and to store the list of friends. Use MagicLink to authenticate users. Use Tailwind to make it look good.
-
-You can enhance the AI's understanding by adding the core APIs. Use this if you aren't using React, or you are adding additional features to your app and you need to go deeper than the React hooks.
-
-```
-Fireproof/API/Usage: import { Fireproof, Index } from '@fireproof/core'; const db = fireproof.storage('app-db-name'); const ok = await db.put({ any: 'json' }); const doc = await db.get(ok.id); await db.del(doc._id); const all = await db.allDocuments(); all.rows.map(({key, value}) => value); useEffect(()=> db.subscribe(updateReactStateFn), []); const index = new Index(db, (doc, map) => map(doc.any, {custom: Object.keys(doc)})); const result = await index.query({range : ['a', 'z']}); result.rows.map(({ key }) => key);
-```
-
-Please share your successes with us here or on [Twitter.](https://twitter.com/FireproofStorge)
-
-# Database Features
-
-The core features of the database are available on any platform in a compact JavaScript package and a foundational cloud storage service.
-
-* **Local** - always encrypted, data automatically collocates with your users, for faster and more reliable apps.
-* **Immutable** - [cutting-edge git-like data structures](https://fireproof.storage/posts/from-mlops-to-point-of-sale:-merkle-proofs-and-data-locality/) allow Fireproof to combine cryptographic verification with append-only storage, automatically converging on a verified state.
-* **Distributed** - immutable data can be stored on the Fireproof service, your cloud, and the distributed IPFS network, so it is always available.
-* **Realtime** - use the Fireproof service or APIs like WebRTC, libp2p, PartyKit, or SocketSupply to push changes to connected peers. React hook APIs like `useLiveQuery` are designed for automatic UI refresh.
-* **Verifiable** - [cryptographic proofs make results verifiable](https://fireproof.storage/posts/why-proofs-matter-for-ai/), sync fast, and storage cheap.
-* **[Cloudless](https://www.oreilly.com/radar/the-paradigm-shift-to-cloudless-computing/)** - data can be hosted on any cloud, on the IPFS network, or both. UCAN integration allows for flexible data ownership models.
-
-
-Learn more about the [architecture](https://fireproof.storage/documentation/how-the-database-engine-works/) behind Fireproof, or see [examples on CodePen](https://codepen.io/jchrisa/pen/GRYJJEM). 
-
-## API Usage
-
-### Encrypted Documents
-
-A simple put, get and delete interface for keeping track of all your JSON documents. Once your data is in Fireproof you can access it from any app or website. Fireproof document store uses MVCC versioning and Merkle clocks so you can always recover the version you are looking for.
-
-```js
-const { id, ref } = await database.put({
-    _id: 'three-thousand'
-    name: 'André',
-    age: 47
-});
-
-// mvcc is optional
-const doc = await database.get('three-thousand', { mvcc: true }) 
-// {
-//    _id  : 'three-thousand'
-//    _clock : CID(bafy84...agfw7)
-//    name : 'André',
-//    age  : 47
-// }
-```
-
-As you can see in the return value above, the `_clock` allows you to query a stable snapshot of that version of the database. Fireproof uses immutable data structures under the hood, so you can always rollback to old data. Files can be embedded anywhere in your document using IPFS links like `{"/": "bafybeih3e3zdiehbqfpxzpppxrb6kaaw4xkbqzyr2f5pwr5refq2te2ape"}`, with API sugar coming soon.
-
-### Live Query
-
-Fireproof provides a live query interface that allows you to subscribe to changes in your data. This means that your UI will automatically update whenever there is a change to your data. See the [useFireproof React hooks documentation](https://github.com/fireproof-storage/fireproof/blob/main/packages/react/README.md) for the easiest way to use this feature.
-
-Fireproof indexes are defined by custom JavaScript functions that you write, allowing you to easily index and search your data in the way that works best for your application. Easily handle data variety and schema drift by normalizing any data to the desired index. The index function defines the sort order. You can use the index to query for a range of values or to find exact matches. This baseline functionality is all you need to build many kinds of complex queries.
-
-```js
-const index = new Index(database, "byAge", (doc) => doc.age)
-const { rows, proof } = await index.query({ range: [40, 52] })
-```
-
-You can ignore the proof or use it to optimize hydration of your client side components. The `rows` are the results of the query. You can use `database.subscribe(myAppQueryFn)` to get notified of changes and re-issue your query. The React [useLiveQuery](https://fireproof.storage/documentation/usefireproof-hook-for-react/) hook does this for you automatically.
-
-If you need more control over the results, you can use the optional second argument to your map function to specify both keys and values for the index:
-
-```js
-const index = new Index(database, "namesByAge", function (doc, map) {
-  map(doc.age, doc.name)
-})
-const { rows, ref } = await index.query({ range: [40, 52] })
-// [ { key: 42, value: 'alice', id: 'a1s3b32a-3c3a-4b5e-9c1c-8c5c0c5c0c5c' },
-//   { key: 47, value: 'André', id: 'three-thousand' } ]
-```
-
-The same mechanism that powers the built-in indexes can all be used to connect secondary [vector indexers](https://github.com/tantaraio/voy) or fulltext indexes to Fireproof. [Follow this tutorial to connect a secondary index](https://fireproof.storage/documentation/external-indexers/).
-
-### Realtime Updates
-
-Subscribe to query changes in your application, so your UI updates automatically. Use the supplied React hooks, or simple function calls to be notified of relevant changes.
-
-```js
-const unsubscribe = database.subscribe(changes) => {
-  changes.forEach(change => {
-    console.log(change)
-  })
-})
-```
-
-Return the `unsubscribe` function from `useEffect` and React will handle it for you. (In the code below, we use the arrow function's implicit return to connect the unsubscribe function to the `useEffect` hook. This prevents extra subscriptions from building up on each render.)
-
-```js
-useEffect(() => database.subscribe((changes) => 
-    changes.forEach(change => console.log(change))), [])
-```
-
-### Cryptographic Proofs
-
-Fireproof's Merkle clocks and hash trees are immutable and self-validating, and all query results are offline-capable data slices. Fireproof makes cryptographic proofs available for all of its operations, accelerating replication and making trustless index sharing possible. If you are making a "DocuSign for _____", [proofs make Fireproof the ideal verifiable document database](https://fireproof.storage/posts/from-mlops-to-point-of-sale:-merkle-proofs-and-data-locality/) for smart contracts and other applications where unique, verifiable, and trustworthy data is required. [Proof chains provide performance benefits as well](https://purrfect-tracker-45c.notion.site/Data-Routing-23c37b269b4c4c3dacb60d0077113bcb), by allowing recipients to skip costly I/O operations and instead cryptographically verify that changes contain all of the required context.
-
-### Automatic Replication
-
-Documents changes are persisted to [Filecoin](https://filecoin.io) via [web3.storage](https://web3.storage), and made available over IPFS and on a global content delivery network. All you need to do to sync state is send a link to the latest database head, and Fireproof will take care of the rest. 
-
-### Peer-to-peer Sync
-
-Application instances can be connected using WebRTC or any other stream API library, like [Socket Supply](https://socketsupply.co), [libp2p](https://libp2p.io), or [PartyKit](https://partykit.io). The [first sync demo uses pure WebRTC with no signaling server](https://game.fireproof.storage), which limits its usability. There are demos with other transports coming soon.
-
-### Self-sovereign Identity
-
-Fireproof is so easy to integrate with any site or app because you can get started right away, and set up an account later. By default users write to their own database copy, so you can get pretty far before you even have to think about API keys. [Authorization is via non-extractable keypair](https://ucan.xyz), like TouchID / FaceID.
-
-## Thanks 🙏
-
-Fireproof is a synthesis of work done by people in the web community over the years. I couldn't even begin to name all the folks who made pivotal contributions. Without npm, React, and VS Code all this would have taken so much longer. Thanks to everyone who supported me getting into database development via Apache CouchDB, one of the original document databases. The distinguishing work on immutable data-structures comes from the years of consideration [IPFS](https://ipfs.tech), [IPLD](https://ipld.io), and the [Filecoin APIs](https://docs.filecoin.io) have enjoyed.
-
-Thanks to Alan Shaw and Mikeal Rogers without whom this project would have never got started. The core Merkle hash-tree clock is based on [Alan's Pail](https://github.com/alanshaw/pail), and you can see the repository history goes all the way back to work begun as a branch of that repo. Mikeal wrote [the prolly trees implementation](https://github.com/mikeal/prolly-trees).
-
-# Contributing
-
-To contribute please follow these steps for local setup and installation of the project
-
-1. Click on the "Fork" button in the top-right corner of the repository's page. This will create a copy of the repository in your account.
-2. Clone the forked repository to your local machine using Git.
-3. Now cd to the target directory, or load the directory in your IDE, and open up a terminal.
-4. Write the command `pnpm install`. This will install all the dependencies that are listed in the `package.json` file.
-5. Now change the directory to packages/fireproof using the command `cd packages/fireproof`.
-6. See the `package.json` file to work with all the listed commands and try them out. You can also test your application locally using `npm test`.
-7. Also change directory to `examples/todomvc` and run the command `npm run dev` to load up a simple application to understand the use of Fireproof as a real-time database.
-8. Keep contributing :) See [projects](https://github.com/fireproof-storage/fireproof/projects?query=is%3Aopen) and [issues](https://github.com/fireproof-storage/fireproof/issues) for ideas where to get started.
-
-Feel free to join in. All welcome. [Open an issue](https://github.com/jchris/fireproof/issues)!
-
-# License
-
-Dual-licensed under [MIT or Apache 2.0](https://github.com/jchris/fireproof/blob/main/LICENSE.md)
+Tests in this project are written with Mocha and can be run in both Node.js and a browser environment through the use of `polendina`. Test files are located in the `test` directory and are recognizable by their `.test.js` extension. You can run the tests by executing the command `npm test`, which also triggers the build process and checks for any linting errors.