@fireproof/core 0.6.4 → 0.6.6

package/README.md

@@ -8,8 +8,8 @@
 </h3>
 
 <p align="center">
-  <a href="https://github.com/jchris/fireproof/actions/workflows/test.yml">
-    <img src="https://github.com/jchris/fireproof/actions/workflows/test.yml/badge.svg" alt="Test" style="max-width: 100%;">
+  <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%;">
@@ -38,14 +38,14 @@ With Fireproof, you **build first** and connect it to your cloud of choice when
 ```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 `useLiveDocument` and database setup helpers. Don't forget to star 🌟 this repo on the way over.
+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, useLiveDocument, database } = useFireproof(); const result = useLiveQuery(doc => doc.word, { limit: 10 }); const [{ count }, saveCountDocument] = useLiveDocument({_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></>)}
+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:

package/dist/{src/db-index.js → db-index.js}

@@ -127,13 +127,23 @@ export class DbIndex {
     applyMapFn(mapFn, name) {
         if (typeof mapFn === 'string') {
             this.mapFnString = mapFn;
+            // make a regex that matches strings that only have letters, numbers, and spaces
+            const regex = /^[a-zA-Z0-9 ]+$/;
+            // if the string matches the regex, make a function that returns the value at that key
+            if (regex.test(mapFn)) {
+                this.mapFn = (doc, emit) => {
+                    if (doc[mapFn])
+                        emit(doc[mapFn]);
+                };
+                this.includeDocsDefault = true;
+            }
         }
         else {
             this.mapFn = mapFn;
             this.mapFnString = mapFn.toString();
         }
         const matches = /=>\s*(.*)/.exec(this.mapFnString);
-        this.includeDocsDefault = matches && matches.length > 0;
+        this.includeDocsDefault = this.includeDocsDefault || (matches && matches.length > 0);
         this.name = name || this.makeName();
     }
     makeName() {

package/dist/fireproof.js

@@ -0,0 +1,90 @@
+import randomBytes from 'randombytes';
+import { Database, parseCID } from './database.js';
+import { Listener } from './listener.js';
+import { DbIndex as Index } from './db-index.js';
+// import { TransactionBlockstore } from './blockstore.js'
+import { localGet } from './utils.js';
+import { Sync } from './sync.js';
+// todo remove Listener in 0.7.0
+export { Index, Listener, Database, Sync };
+class Fireproof {
+    /**
+     * @function storage
+     * @memberof Fireproof
+     * Creates a new Fireproof instance with default storage settings
+     * Most apps should use this and not worry about the details.
+     * @static
+     * @returns {Database} - a new Fireproof instance
+     */
+    static storage = (name = null, opts = {}) => {
+        if (name) {
+            opts.name = name;
+            // todo this can come from a registry also eg remote database / config, etc
+            const existing = localGet('fp.' + name);
+            if (existing) {
+                const existingConfig = JSON.parse(existing);
+                return Fireproof.fromConfig(name, existingConfig, opts);
+            }
+            else {
+                const instanceKey = randomBytes(32).toString('hex'); // pass null to disable encryption
+                opts.key = instanceKey;
+                return new Database(name, [], opts);
+            }
+        }
+        else {
+            return new Database(null, [], opts);
+        }
+    };
+    static fromConfig(name, existingConfig, opts = {}) {
+        opts.key = existingConfig.key;
+        const fp = new Database(name, [], opts);
+        return Fireproof.fromJSON(existingConfig, fp);
+    }
+    static fromJSON(json, database) {
+        database.hydrate({ car: json.car, indexCar: json.indexCar, clock: json.clock.map(c => parseCID(c)), name: json.name, key: json.key });
+        if (json.indexes) {
+            for (const { name, code, clock: { byId, byKey, db } } of json.indexes) {
+                Index.fromJSON(database, {
+                    clock: {
+                        byId: byId ? parseCID(byId) : null,
+                        byKey: byKey ? parseCID(byKey) : null,
+                        db: (db && db.length > 0) ? db.map(c => parseCID(c)) : null
+                    },
+                    code,
+                    name
+                });
+            }
+        }
+        return database;
+    }
+    static snapshot(database, clock) {
+        const definition = database.toJSON();
+        const withBlocks = new Database(database.name);
+        withBlocks.blocks = database.blocks;
+        if (clock) {
+            definition.clock = clock.map(c => parseCID(c));
+            definition.indexes.forEach(index => {
+                index.clock.byId = null;
+                index.clock.byKey = null;
+                index.clock.db = null;
+            });
+        }
+        const snappedDb = Fireproof.fromJSON(definition, withBlocks);
+        [...database.indexes.values()].forEach(index => {
+            snappedDb.indexes.get(index.mapFnString).mapFn = index.mapFn;
+        });
+        return snappedDb;
+    }
+    static async zoom(database, clock) {
+        ;
+        [...database.indexes.values()].forEach(index => {
+            index.indexById = { root: null, cid: null };
+            index.indexByKey = { root: null, cid: null };
+            index.dbHead = null;
+        });
+        database.clock = clock.map(c => parseCID(c));
+        await database.notifyReset(); // hmm... indexes should listen to this? might be more complex than worth it. so far this is the only caller
+        return database;
+    }
+}
+export { Fireproof };

package/dist/import.js

@@ -0,0 +1,29 @@
+import { createReadStream } from 'fs';
+import { join } from 'path';
+import { parse } from '@jsonlines/core';
+import cargoQueue from 'async/cargoQueue.js';
+// todo maybe this goes in a utils package for tree-shaking?
+async function loadData(database, filename) {
+    const fullFilePath = join(process.cwd(), filename);
+    const readableStream = createReadStream(fullFilePath);
+    const parseStream = parse();
+    readableStream.pipe(parseStream);
+    const saveQueue = cargoQueue(async (tasks, callback) => {
+        for (const t of tasks) {
+            await database.put(t);
+        }
+        callback();
+    });
+    parseStream.on('data', async (data) => {
+        saveQueue.push(data);
+    });
+    let res;
+    const p = new Promise((resolve, reject) => {
+        res = resolve;
+    });
+    saveQueue.drain(async (x) => {
+        res();
+    });
+    return p;
+}
+export { loadData };

package/dist/loader.js

@@ -0,0 +1,23 @@
+import { Browser } from './storage/browser.js';
+import { Filesystem } from './storage/filesystem.js';
+import { Rest } from './storage/rest.js';
+const FORCE_IDB = typeof process !== 'undefined' && !!process.env?.FORCE_IDB;
+/* global window */
+export const Loader = {
+    appropriate: (name, config = {}) => {
+        let isBrowser = false;
+        try {
+            isBrowser = window.localStorage && true;
+        }
+        catch (e) { }
+        if (config.type === 'rest') {
+            return new Rest(name, config);
+        }
+        if (FORCE_IDB || isBrowser) {
+            return new Browser(name, config);
+        }
+        else {
+            return new Filesystem(name, config);
+        }
+    }
+};

package/dist/src/fireproof.d.ts

@@ -398,7 +398,7 @@ declare class DbIndex {
     applyMapFn(mapFn: any, name: any): void;
     mapFnString: any;
     mapFn: any;
-    includeDocsDefault: boolean;
+    includeDocsDefault: any;
     name: any;
     makeName(): any;
     toJSON(): {

package/dist/src/fireproof.js

@@ -41711,12 +41711,21 @@ class DbIndex {
   applyMapFn (mapFn, name) {
     if (typeof mapFn === 'string') {
       this.mapFnString = mapFn;
+      // make a regex that matches strings that only have letters, numbers, and spaces
+      const regex = /^[a-zA-Z0-9 ]+$/;
+      // if the string matches the regex, make a function that returns the value at that key
+      if (regex.test(mapFn)) {
+        this.mapFn = (doc, emit) => {
+          if (doc[mapFn]) emit(doc[mapFn]);
+        };
+        this.includeDocsDefault = true;
+      }
     } else {
       this.mapFn = mapFn;
       this.mapFnString = mapFn.toString();
     }
     const matches = /=>\s*(.*)/.exec(this.mapFnString);
-    this.includeDocsDefault = matches && matches.length > 0;
+    this.includeDocsDefault = this.includeDocsDefault || (matches && matches.length > 0);
     this.name = name || this.makeName();
   }