@fireproof/core 0.4.1 → 0.5.1

package/README.md

@@ -8,9 +8,28 @@ to offer a new kind of database that:
 
 Learn more about the [concepts and architecture behind Fireproof](https://fireproof.storage/documentation/how-the-database-engine-works/), or jump to the [quick start](#quick-start) for React and server-side examples.
 
+## Quick Start
+
+Look in the `examples/` directory for projects using the database, or see [examples on CodePen](https://codepen.io/jchrisa/pen/GRYJJEM). If you are adding Fireproof to an existing page, just install it and try some operations.
+
+```sh
+npm install @fireproof/core
+```
+
+In your `app.js` or `app.tsx` file:
+
+```js
+import { Fireproof } from '@fireproof/core'
+const fireproof = Fireproof.storage("my-db")
+const ok = await fireproof.put({ hello: 'world' })
+const doc = await fireproof.get(ok.id)
+```
+
+🤫 I like to drop a `window.fireproof = fireproof` in there as a development aid.
+
 ### Status
 
-Fireproof is alpha software, you should only use it if you are planning to contribute. For now, [check out our React TodoMVC implementation running in browser-local mode.](https://main--lucky-naiad-5aa507.netlify.app/) It demonstrates document persistence, index queries, and event subscriptions, and uses the [`useFireproof()` React hook.](https://github.com/fireproof-storage/fireproof/blob/main/packages/fireproof/hooks/use-fireproof.tsx)
+Fireproof is alpha software, ready for you to evaluate for your future applications. For now, [check out our React TodoMVC implementation running in browser-local mode.](https://main--lucky-naiad-5aa507.netlify.app/) It demonstrates document persistence, index queries, and event subscriptions, and uses the [`useFireproof()` React hook.](https://github.com/fireproof-storage/fireproof/blob/main/packages/fireproof/hooks/use-fireproof.tsx)
 
 [![Test](https://github.com/jchris/fireproof/actions/workflows/test.yml/badge.svg)](https://github.com/jchris/fireproof/actions/workflows/test.yml)
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
@@ -118,28 +137,18 @@ Fireproof is a synthesis of work done by people in the web community over the ye
 
 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).
 
-## Quick Start
-
-Look in the `examples/` directory for projects using the database. It's not picky how you use it, but we want to provide convenient jumping off places. Think of the examples as great to fork when starting your next project.
-
-If are adding Fireproof to an existing page, just install it and try some operations.
-
-```sh
-npm install @fireproof/core
-```
-
-In your `app.js` or `app.tsx` file:
-
-```js
-import { Fireproof } from '@fireproof/core'
-const fireproof = Fireproof.storage()
-const ok = await fireproof.put({ hello: 'world' })
-const doc = await fireproof.get(ok.id)
-```
+# Contributing
 
-🤫 I like to drop a `window.fireproof = fireproof` in there as a development aid.
+To contribute please follow these steps for local setup and installation of the project
 
-# Contributing
+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)!
 

package/dist/src/fireproof.d.ts

@@ -1,3 +1,5 @@
+import * as multiformats from 'multiformats';
+
 /**
  * Represents an DbIndex for a Fireproof database.
  *
@@ -15,7 +17,7 @@ declare class DbIndex {
         clock: any;
         name: any;
     }): DbIndex;
-    constructor(database: any, mapFn: any, clock: any, opts?: {});
+    constructor(database: any, name: any, mapFn: any, clock?: any, opts?: {});
     database: any;
     mapFnString: any;
     mapFn: any;
@@ -30,7 +32,7 @@ declare class DbIndex {
     };
     dbHead: any;
     instanceId: string;
-    updateIndexPromise: Promise<void>;
+    updateIndexPromise: Promise<any>;
     makeName(): any;
     toJSON(): {
         name: any;
@@ -54,7 +56,7 @@ declare class DbIndex {
      * @memberof DbIndex
      * @instance
      */
-    query(query: {
+    query(query?: {
         /**
          * - The range to query.
          */
@@ -73,7 +75,7 @@ declare class DbIndex {
      * @returns {Promise<void>}
      */
     private updateIndex;
-    innerUpdateIndex(inBlocks: any): Promise<void>;
+    innerUpdateIndex(inBlocks: any): Promise<any>;
 }
 /**
  * JDoc for the result row type.
@@ -105,7 +107,7 @@ type ChangeEvent = {
  * @param {object} [authCtx] - Optional authorization context object to use for any authentication checks.
  *
  */
-declare class Database$1 {
+declare class Database {
     constructor(blocks: any, clock: any, config?: {});
     listeners: Set<any>;
     name: any;
@@ -165,6 +167,7 @@ declare class Database$1 {
         clock: string[];
         proof: any[];
     }>;
+    allCIDs(): Promise<any[]>;
     /**
      * Runs validation on the specified document using the Fireproof instance's configuration. Throws an error if the document is invalid.
      *
@@ -188,13 +191,13 @@ declare class Database$1 {
         _id: string;
     }>;
     /**
-   * @typedef {Object} Document
-   * @property {string} _id - The ID of the document (required)
-   * @property {string} [_proof] - The proof of the document (optional)
-   * @property {string} [_clock] - The clock of the document (optional)
-   * @property {any} [key: string] - Index signature notation to allow any other unknown fields
-   *  * @property {Object.<string, any>} [otherProperties] - Any other unknown properties (optional)
-   */
+     * @typedef {Object} Document
+     * @property {string} _id - The ID of the document (required)
+     * @property {string} [_proof] - The proof of the document (optional)
+     * @property {string} [_clock] - The clock of the document (optional)
+     * @property {any} [key: string] - Index signature notation to allow any other unknown fields
+     *  * @property {Object.<string, any>} [otherProperties] - Any other unknown properties (optional)
+     */
     /**
      * Adds a new document to the database, or updates an existing document. Returns the ID of the document and the new clock head.
      *
@@ -249,6 +252,7 @@ declare class Database$1 {
      * @returns {Promise<{ proof:{}, id: string, clock: CID[] }>} - The result of adding the event to storage
      */
     private putToProllyTree;
+    applyClock(prevClock: any, newClock: any): void;
     vis(): AsyncGenerator<any, {
         cids: any;
         result: any;
@@ -297,10 +301,10 @@ declare class Listener {
      * @param {import('./database.js').Database} database
      * @param {(_: any, emit: any) => void} routingFn
      */
-    constructor(database: Database$1, routingFn?: (_: any, emit: any) => void);
+    constructor(database: Database, routingFn?: (_: any, emit: any) => void);
     subcribers: Map<any, any>;
     doStopListening: any;
-    database: Database$1;
+    database: Database;
     /**
      * The map function to apply to each entry in the database.
      * @type {Function}
@@ -339,6 +343,7 @@ declare class Fireproof {
     static fromJSON(json: any, database: any): any;
     static snapshot(database: any, clock: any): any;
     static zoom(database: any, clock: any): Promise<any>;
+    static makeCar(database: any, key: any): Promise<multiformats.BlockView<Uint8Array, 85, 18, 1>>;
 }
 
-export { Fireproof, DbIndex as Index, Listener };
+export { Database, Fireproof, DbIndex as Index, Listener };