@fireproof/core 0.8.0 → 0.10.1-dev

package/package.json

@@ -1,99 +1,40 @@
 {
   "name": "@fireproof/core",
-  "version": "0.8.0",
-  "description": "Live data for React, accelerated by proofs, powered by IPFS",
-  "main": "dist/src/fireproof.js",
-  "module": "dist/src/fireproof.mjs",
-  "typings": "dist/src/fireproof.d.ts",
-  "types": "dist/src/fireproof.d.ts",
+  "version": "0.10.1-dev",
+  "description": "Immutable embedded distributed database for the web",
+  "main": "dist/fireproof.cjs.js",
+  "module": "dist/fireproof.esm.js",
+  "exports": {
+    ".": {
+      "import": "./dist/fireproof.esm.js",
+      "require": "./dist/fireproof.cjs.js"
+    },
+    "./browser": "./dist/fireproof.browser.js"
+  },
+  "browser": "./dist/fireproof.browser.js",
+  "files": [
+    "dist/fireproof.*"
+  ],
   "type": "module",
   "scripts": {
-    "keygen": "node scripts/keygen.js",
-    "server": "node scripts/sever.js",
-    "test": "standard && tsc && npm run test:unencrypted && npm run test:mocha",
-    "test:unencrypted": "set NO_ENCRYPT=true && npm run test:mocha",
-    "test:mocha": "mocha test/*.test.js",
-    "test:watch": "npm run test:mocha -- -w --parallel",
-    "coverage": "c8 -r html -r text npm test",
-    "prepublishOnly": "cp ../../README.md . && npm run build",
-    "postpublish": "rm README.md",
-    "lint": "standard",
-    "lint:fix": "standard --fix",
-    "tsc": "tsc --watch",
-    "build": "tsc && rollup -c"
+    "build": "npm run clean && node ./scripts/build.js",
+    "prepublishOnly": "npm run build",
+    "clean": "rm -rf dist/*",
+    "start": "node ./scripts/serve.js",
+    "analyze": "node ./scripts/analyze.js",
+    "test:watch": "nodemon -w src -w test -e ts,js --exec \"npm run build && npm run test:node\"",
+    "test:node": "node ./scripts/test.js",
+    "test:browser": "polendina test/*.js --webpack-config webpack.config.cjs",
+    "test": "npm run build && npm run test:node && npm run test:browser",
+    "lint": "eslint 'src/**/*.{js,ts}'",
+    "lint:fix": "eslint --fix 'src/**/*.{js,ts}'"
   },
   "keywords": [
-    "database",
-    "JSON",
-    "document",
-    "IPLD",
-    "CID",
-    "IPFS"
-  ],
-  "contributors": [
-    "J Chris Anderson",
-    "Alan Shaw",
-    "Travis Vachon",
-    "Mikeal Rogers"
+    "database"
   ],
+  "author": "J Chris Anderson",
   "license": "Apache-2.0 OR MIT",
-  "gptdoc": "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);",
-  "dependencies": {
-    "@ipld/car": "^5.1.0",
-    "@ipld/dag-cbor": "^9.0.0",
-    "@jsonlines/core": "^1.0.2",
-    "@web3-storage/clock": "^0.3.0",
-    "@web3-storage/w3up-client": "^7.0.0",
-    "async": "^3.2.4",
-    "charwise": "^3.0.1",
-    "cross-fetch": "^3.1.6",
-    "crypto-browserify": "^3.12.0",
-    "idb": "^7.1.1",
-    "ipld-hashmap": "^2.1.18",
-    "js-crypto-aes": "^1.0.4",
-    "multiformats": "^11.0.1",
-    "prolly-trees": "1.0.4",
-    "randombytes": "^2.1.0",
-    "simple-peer": "^9.11.1"
-  },
-  "devDependencies": {
-    "@rollup/plugin-alias": "^5.0.0",
-    "@rollup/plugin-commonjs": "^24.0.1",
-    "@rollup/plugin-json": "^6.0.0",
-    "@rollup/plugin-node-resolve": "^15.0.2",
-    "c8": "^7.12.0",
-    "esbuild": "^0.17.16",
-    "fake-indexeddb": "^4.0.1",
-    "flexsearch": "^0.7.31",
-    "mocha": "^10.2.0",
-    "nanoid": "^4.0.0",
-    "node-polyfill-webpack-plugin": "^2.0.1",
-    "rollup": "^3.20.2",
-    "rollup-plugin-auto-external": "^2.0.0",
-    "rollup-plugin-dts": "^5.3.0",
-    "rollup-plugin-esbuild": "^5.0.0",
-    "rollup-plugin-polyfill-node": "^0.12.0",
-    "rollup-plugin-visualizer": "^5.9.0",
-    "standard": "^17.0.0",
-    "typescript": "^5.0.2",
-    "vector-storage": "^1.0.55",
-    "webpack": "^5.78.0",
-    "webpack-cli": "^5.0.1"
-  },
-  "mocha": {
-    "require": [
-      "fake-indexeddb/auto"
-    ]
-  },
-  "standard": {
-    "ignore": [
-      "examples/**/*.tsx",
-      "examples/**/dist",
-      "out/**",
-      "packages/react/**",
-      "rollup.config.js"
-    ]
-  },
+  "homepage": "https://fireproof.storage",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/fireproof-storage/fireproof.git"
@@ -101,22 +42,33 @@
   "bugs": {
     "url": "https://github.com/fireproof-storage/fireproof/issues"
   },
-  "homepage": "https://fireproof.storage",
-  "exports": {
-    ".": {
-      "types": "./dist/src/fireproof.d.ts",
-      "import": "./dist/src/fireproof.mjs",
-      "module": "./dist/src/fireproof.mjs",
-      "default": "./dist/src/fireproof.js",
-      "require": "./dist/src/fireproof.js"
-    },
-    "./src/*.js": "./src/*.js",
-    "./src/**/*.js": "./src/**/*.js",
-    "./package.json": "./package.json"
+  "devDependencies": {
+    "@types/async": "^3.2.20",
+    "@types/mocha": "^10.0.1",
+    "@typescript-eslint/eslint-plugin": "^6.1.0",
+    "@typescript-eslint/parser": "^6.1.0",
+    "browser-assert": "^1.2.1",
+    "esbuild": "^0.18.14",
+    "esbuild-plugin-polyfill-node": "^0.3.0",
+    "esbuild-plugin-tsc": "^0.4.0",
+    "eslint": "^8.45.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-mocha": "^10.1.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^6.1.1",
+    "mocha": "^10.2.0",
+    "nodemon": "^3.0.1",
+    "polendina": "^3.2.1",
+    "tslib": "^2.6.0",
+    "typescript": "^5.1.6"
   },
-  "files": [
-    "src",
-    "dist",
-    "README.md"
-  ]
+  "dependencies": {
+    "@alanshaw/pail": "^0.3.3",
+    "@ipld/dag-cbor": "^9.0.3",
+    "async": "^3.2.4",
+    "idb": "^7.1.1",
+    "multiformats": "^12.0.1",
+    "prolly-trees": "^1.0.4"
+  }
 }

package/dist/blockstore.js

@@ -1,268 +0,0 @@
-import { parse } from 'multiformats/link';
-import { CID } from 'multiformats';
-import { Valet } from './valet.js';
-// const sleep = ms => new Promise(r => setTimeout(r, ms))
-const husherMap = new Map();
-const husher = (id, workFn) => {
-    if (!husherMap.has(id)) {
-        husherMap.set(id, workFn().finally(() => setTimeout(() => husherMap.delete(id), 100)));
-    }
-    return husherMap.get(id);
-};
-/**
- * @typedef {{ get: (link: import('../src/link').AnyLink) => Promise<AnyBlock | undefined> }} BlockFetcher
- */
-/**
- * @typedef {Object} AnyBlock
- * @property {import('./link').AnyLink} cid - The CID of the block
- * @property {Uint8Array} bytes - The block's data
- *
- * @typedef {Object} Blockstore
- * @property {function(import('./link').AnyLink): Promise<AnyBlock|undefined>} get - A function to retrieve a block by CID
- * @property {function(import('./link').AnyLink, Uint8Array): Promise<void>} put - A function to store a block's data and CID
- *
- * A blockstore that caches writes to a transaction and only persists them when committed.
-*/
-export class TransactionBlockstore {
-    /** @type {Map<string, Uint8Array>} */
-    committedBlocks = new Map();
-    /** @type {Valet} */
-    valet = null;
-    instanceId = 'blkz.' + Math.random().toString(36).substring(2, 4);
-    inflightTransactions = new Set();
-    syncs = new Set();
-    constructor(name, config) {
-        if (name) {
-            this.valet = new Valet(name, config);
-            this.ready = this.valet.ready;
-        }
-        else {
-            this.ready = Promise.resolve();
-        }
-        this.remoteBlockFunction = null;
-    }
-    /**
-     * Get a block from the store.
-     *
-     * @param {import('./link').AnyLink} cid
-     * @returns {Promise<AnyBlock | undefined>}
-     */
-    async get(cid) {
-        const key = cid.toString();
-        // it is safe to read from the in-flight transactions becauase they are immutable
-        const bytes = await Promise.any([this.transactionsGet(key), this.committedGet(key)]).catch(e => {
-            console.log('get error', cid.toString(), e);
-            return this.networkGet(key);
-        });
-        if (!bytes)
-            throw new Error('Missing block: ' + key);
-        return { cid, bytes };
-    }
-    // this iterates over the in-flight transactions
-    // and returns the first matching block it finds
-    async transactionsGet(key) {
-        for (const transaction of this.inflightTransactions) {
-            const got = await transaction.get(key);
-            if (got && got.bytes)
-                return got.bytes;
-        }
-        throw new Error('Missing block: ' + key);
-    }
-    async committedGet(key) {
-        const old = this.committedBlocks.get(key);
-        // console.log('committedGet: ' + key + ' ' + this.instanceId, old.length)
-        if (old)
-            return old;
-        if (!this.valet)
-            throw new Error('Missing block: ' + key);
-        const got = await this.valet.getValetBlock(key);
-        this.committedBlocks.set(key, got);
-        return got;
-    }
-    async clearCommittedCache() {
-        this.committedBlocks.clear();
-    }
-    async networkGet(key) {
-        if (this.remoteBlockFunction) {
-            const value = await husher(key, async () => await this.remoteBlockFunction(key));
-            if (value) {
-                // console.log('networkGot: ' + key, value.length)
-                doTransaction('networkGot: ' + key, this, async (innerBlockstore) => {
-                    await innerBlockstore.put(CID.parse(key), value);
-                });
-                return value;
-            }
-        }
-        else {
-            return false;
-        }
-    }
-    /**
-     * Add a block to the store. Usually bound to a transaction by a closure.
-     * It sets the lastCid property to the CID of the block that was put.
-     * This is used by the transaction as the head of the car when written to the valet.
-     * We don't have to worry about which transaction we are when we are here because
-     * we are the transactionBlockstore.
-     *
-     * @param {import('./link').AnyLink} cid
-     * @param {Uint8Array} bytes
-     */
-    put(cid, bytes) {
-        throw new Error('use a transaction to put');
-    }
-    /**
-     * Iterate over all blocks in the store.
-     *
-     * @yields {{cid: string, bytes: Uint8Array}}
-     * @returns {AsyncGenerator<any, any, any>}
-     */
-    async *entries() {
-        for (const transaction of this.inflightTransactions) {
-            for (const [cid, bytes] of transaction.entries()) { // test for this?
-                yield { cid: cid.toString(), bytes };
-            }
-        }
-        for (const [str, bytes] of this.committedBlocks) {
-            yield { cid: str, bytes };
-        }
-        if (this.valet) {
-            for await (const { cid } of this.valet.cids()) {
-                yield { cid };
-            }
-        }
-    }
-    /**
-     * Begin a transaction. Ensures the uncommited blocks are empty at the begining.
-     * Returns the blocks to read and write during the transaction.
-     * @returns {InnerBlockstore}
-     * @memberof TransactionBlockstore
-     */
-    begin(label = '') {
-        const innerTransactionBlockstore = new InnerBlockstore(label, this);
-        this.inflightTransactions.add(innerTransactionBlockstore);
-        return innerTransactionBlockstore;
-    }
-    /**
-     * Commit the transaction. Writes the blocks to the store.
-     * @returns {Promise<void>}
-     * @memberof TransactionBlockstore
-     */
-    async commit(innerBlockstore, doSync = true) {
-        // console.log('commit', doSync, innerBlockstore.label)
-        await this.doCommit(innerBlockstore);
-        if (doSync) {
-            // const all =
-            // console.log('syncing', innerBlockstore.label)
-            await Promise.all([...this.syncs].map(async (sync) => sync.sendUpdate(innerBlockstore).catch(e => {
-                console.error('sync error, cancelling', e);
-                sync.destroy();
-            })));
-        }
-    }
-    // first get the transaction blockstore from the map of transaction blockstores
-    // then copy it to committedBlocks
-    // then write the transaction blockstore to a car
-    // then write the car to the valet
-    // then remove the transaction blockstore from the map of transaction blockstores
-    doCommit = async (innerBlockstore) => {
-        const cids = new Set();
-        for (const { cid, bytes } of innerBlockstore.entries()) {
-            const stringCid = cid.toString();
-            if (this.committedBlocks.has(stringCid)) {
-                // console.log('Duplicate block: ' + stringCid) // todo some of this can be avoided, cost is extra size on car files
-            }
-            else {
-                this.committedBlocks.set(stringCid, bytes);
-                cids.add(stringCid);
-            }
-        }
-        // console.log(innerBlockstore.label, 'committing', cids.size, 'blocks', [...cids].map(cid => cid.toString()), this.valet)
-        if (cids.size > 0 && this.valet) {
-            await this.valet.writeTransaction(innerBlockstore, cids);
-        }
-    };
-    /**
-     * Retire the transaction. Clears the uncommited blocks.
-     * @returns {void}
-     * @memberof TransactionBlockstore
-     */
-    retire(innerBlockstore) {
-        this.inflightTransactions.delete(innerBlockstore);
-    }
-}
-/**
- * Runs a function on an inner blockstore, then persists the change to a car writer
- * or other outer blockstore.
- * @param {string} label
- * @param {TransactionBlockstore} blockstore
- * @param {(innerBlockstore: Blockstore) => Promise<any>} doFun
- * @returns {Promise<any>}
- * @memberof TransactionBlockstore
- */
-export const doTransaction = async (label, blockstore, doFun, doSync = true) => {
-    // @ts-ignore
-    if (!blockstore.commit)
-        return await doFun(blockstore);
-    // @ts-ignore
-    const innerBlockstore = blockstore.begin(label);
-    try {
-        const result = await doFun(innerBlockstore);
-        // console.log('doTransaction', label, 'result', result.head)
-        if (result && result.head) {
-            innerBlockstore.head = result.head;
-        }
-        // pass the latest clock head for writing to the valet
-        // @ts-ignore
-        await blockstore.commit(innerBlockstore, doSync);
-        return result;
-    }
-    catch (e) {
-        console.error(`Transaction ${label} failed`, e, e.stack);
-        throw e;
-    }
-    finally {
-        // @ts-ignore
-        blockstore.retire(innerBlockstore);
-    }
-};
-export class InnerBlockstore {
-    /** @type {Map<string, Uint8Array>} */
-    blocks = new Map();
-    head = [];
-    lastCid = null;
-    label = '';
-    parentBlockstore = null;
-    constructor(label, parentBlockstore) {
-        this.label = label;
-        this.parentBlockstore = parentBlockstore;
-    }
-    /**
-     * @param {import('./link').AnyLink} cid
-     * @returns {Promise<AnyBlock | undefined>}
-     */
-    async get(cid) {
-        const key = cid.toString();
-        let bytes = this.blocks.get(key);
-        if (bytes) {
-            return { cid, bytes };
-        }
-        bytes = await this.parentBlockstore.committedGet(key);
-        if (bytes) {
-            return { cid, bytes };
-        }
-    }
-    /**
-     * @param {import('./link').AnyLink} cid
-     * @param {Uint8Array} bytes
-     */
-    async put(cid, bytes) {
-        // console.log('put', cid)
-        this.blocks.set(cid.toString(), bytes);
-        this.lastCid = cid;
-    }
-    *entries() {
-        for (const [str, bytes] of this.blocks) {
-            yield { cid: parse(str), bytes };
-        }
-    }
-}