@fireproof/core 0.7.0-alpha.0 → 0.7.0-alpha.10

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%;">

package/dist/fireproof.js

@@ -9,21 +9,10 @@ class Fireproof {
      * Creates a new Fireproof instance with default storage settings
      * Most apps should use this and not worry about the details.
      * @static
-     * @returns {Database|Promise<Database>} - a new Fireproof instance or a promise for remote loaders
+     * @returns {Database} - a new Fireproof instance
      */
     static storage = (name = null, opts = {}) => {
-        if (!name) {
-            return new Database(null, opts);
-        }
-        else {
-            // const primaryLoader = Loader.appropriate(name, opts.primary, { key: null })
-            // const secondaryLoader = opts.secondary ? Loader.appropriate(name, opts.secondary, { key: null }) : null
-            const db = new Database(name, opts);
-            return db;
-            // const loaders = [pr]
-            // todo we need branch names here
-            // console.log('storage', name, opts, primaryLoader, secondaryLoader)
-        }
+        return new Database(name, opts);
     };
     // static fromConfig (name, primary, secondary, opts = {}) {
     //   console.log('fromConfig', name, primary, secondary, opts)
@@ -49,7 +38,7 @@ class Fireproof {
                     clock: {
                         byId: byId ? parseCID(byId) : null,
                         byKey: byKey ? parseCID(byKey) : null,
-                        db: (db && db.length > 0) ? db.map(c => parseCID(c)) : null
+                        db: db && db.length > 0 ? db.map(c => parseCID(c)) : null
                     },
                     code,
                     name
@@ -70,7 +59,9 @@ class Fireproof {
         }
         const withBlocks = new Database(database.name);
         withBlocks.blocks = database.blocks;
-        withBlocks.clock = definition.clock;
+        withBlocks.ready.then(() => {
+            withBlocks.clock = definition.clock.map(c => parseCID(c));
+        });
         const snappedDb = Fireproof.fromJSON(definition, null, withBlocks);
         [...database.indexes.values()].forEach(index => {
             snappedDb.indexes.get(index.mapFnString).mapFn = index.mapFn;

package/dist/loader.js

@@ -1,23 +1,13 @@
 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;
+        if (config.StorageClass) {
+            return new config.StorageClass(name, config);
         }
-        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);
-        }
+        return new Browser(name, config);
     }
 };

package/dist/src/fireproof.d.ts

@@ -1,119 +1,8 @@
 import * as multiformats from 'multiformats';
 import { Link, CID } from 'multiformats';
-import * as multiformats_link from 'multiformats/link';
-import * as _ipld_car_dist_src_api_js from '@ipld/car/dist/src/api.js';
-import * as idb from 'idb';
 
 type AnyLink = Link<unknown, number, number, 1|0>
 
-declare class Base {
-    constructor(name: any, config?: {});
-    valetRootCarCid: any;
-    keyMaterial: any;
-    keyId: string;
-    instanceId: string;
-    name: any;
-    config: {};
-    ready: Promise<{}>;
-    setCarCidMapCarCid(carCid: any): void;
-    valetCarCidMap: Map<any, any>;
-    setKeyMaterial(km: any): void;
-    saveCar(carCid: any, value: any, cids: any): Promise<multiformats.BlockView<Uint8Array, 85, 18, 1>>;
-    applyHeaders(headers: any): void;
-    headers: any;
-    getHeaders(): Promise<{}>;
-    loadHeader(branch?: string): void;
-    saveHeader(header: any): Promise<void>;
-    prepareHeader(header: any, json?: boolean): any;
-    writeHeader(branch: any, header: any): void;
-    getCarCIDForCID(cid: any): Promise<{
-        result: any;
-    }>;
-    readCar(carCid: any): Promise<Uint8Array>;
-    getLoaderBlock(dataCID: any): Promise<{
-        block: any;
-        reader: {
-            entries: () => Generator<any, void, unknown>;
-            root: any;
-            gat: (dataCID: any) => Promise<any>;
-            get: (dataCID: any) => Promise<any>;
-        } | {
-            entries: any;
-            root: any;
-            gat: (dataCID: any) => Promise<_ipld_car_dist_src_api_js.Block>;
-            get: (dataCID: any) => Promise<Uint8Array>;
-        };
-        carCid: any;
-    }>;
-    /** Private - internal **/
-    getCidCarMap(): Promise<Map<any, any>>;
-    mapForIPLDHashmapCarCid(carCid: any): Promise<Map<any, any>>;
-    getWriteableCarReader(carCid: any): Promise<{
-        blocks: VMemoryBlockstore;
-        root: any;
-        put: (cid: any, bytes: any) => Promise<void>;
-        get: (cid: any) => Promise<any>;
-    }>;
-    getCarReader(carCid: any): Promise<{
-        entries: () => Generator<any, void, unknown>;
-        root: any;
-        gat: (dataCID: any) => Promise<any>;
-        get: (dataCID: any) => Promise<any>;
-    } | {
-        entries: any;
-        root: any;
-        gat: (dataCID: any) => Promise<_ipld_car_dist_src_api_js.Block>;
-        get: (dataCID: any) => Promise<Uint8Array>;
-    }>;
-    writeCars(cars: any): void;
-    updateCarCidMap(carCid: any, cids: any): Promise<multiformats.BlockView<Uint8Array, 85, 18, 1>>;
-    persistCarMap(theCarMap: any): Promise<multiformats.BlockView<Uint8Array, 85, 18, 1>>;
-}
-declare class VMemoryBlockstore {
-    /** @type {Map<string, Uint8Array>} */
-    blocks: Map<string, Uint8Array>;
-    instanceId: string;
-    get(cid: any): Promise<{
-        cid: any;
-        bytes: Uint8Array;
-    }>;
-    /**
-     * @param {any} cid
-     * @param {Uint8Array} bytes
-     */
-    put(cid: any, bytes: Uint8Array): Promise<void>;
-    entries(): Generator<{
-        cid: multiformats_link.Link<unknown, number, number, multiformats_link.Version>;
-        bytes: Uint8Array;
-    }, void, unknown>;
-}
-
-declare class Rest extends Base {
-    headerURL(branch?: string): string;
-    writeCars(cars: any): Promise<void>;
-    loadHeader(branch?: string): Promise<unknown>;
-    writeHeader(branch: any, header: any): Promise<void>;
-}
-
-declare class Filesystem extends Base {
-    writeCars(cars: any): Promise<void>;
-    readCar(carCid: any): Promise<any>;
-    loadHeader(branch?: string): any;
-    writeHeader(branch: any, header: any): Promise<void>;
-    headerFilename(branch?: string): any;
-}
-
-declare class Browser extends Base {
-    isBrowser: boolean;
-    withDB: (dbWorkFun: any) => Promise<any>;
-    idb: idb.IDBPDatabase<unknown>;
-    writeCars(cars: any): Promise<any>;
-    readCar(carCid: any): Promise<any>;
-    loadHeader(branch?: string): string;
-    writeHeader(branch: any, header: any): Promise<void>;
-    headerKey(branch?: string): string;
-}
-
 declare class Valet {
     constructor(name?: string, config?: {});
     idb: any;
@@ -121,10 +10,10 @@ declare class Valet {
     uploadQueue: any;
     alreadyEnqueued: Set<any>;
     instanceId: string;
-    primary: Browser | Filesystem | Rest;
-    secondary: Browser | Filesystem | Rest;
-    ready: Promise<{}[]>;
-    saveHeader(header: any): Promise<void>;
+    primary: any;
+    secondary: any;
+    ready: Promise<any[]>;
+    saveHeader(header: any): Promise<any>;
     /**
      * Group the blocks into a car and write it to the valet.
      * @param {import('./blockstore.js').InnerBlockstore} innerBlockstore
@@ -167,7 +56,7 @@ declare class TransactionBlockstore {
     instanceId: string;
     inflightTransactions: Set<any>;
     syncs: Set<any>;
-    ready: Promise<void> | Promise<{}[]>;
+    ready: Promise<void> | Promise<any[]>;
     remoteBlockFunction: any;
     /**
      * Get a block from the store.
@@ -569,9 +458,9 @@ declare class Fireproof {
      * Creates a new Fireproof instance with default storage settings
      * Most apps should use this and not worry about the details.
      * @static
-     * @returns {Database|Promise<Database>} - a new Fireproof instance or a promise for remote loaders
+     * @returns {Database} - a new Fireproof instance
      */
-    static storage: (name?: any, opts?: {}) => Database | Promise<Database>;
+    static storage: (name?: any, opts?: {}) => Database;
     static fromJSON(primary: any, secondary: any, database: any): any;
     static snapshot(database: any, clock: any): any;
     static zoom(database: any, clock: any): Promise<any>;