@fireproof/core 0.15.0-dev → 0.16.1

package/dist/types/crdt-clock.d.ts

@@ -1,4 +1,4 @@
-import { TransactionBlockstore } from './transaction';
+import type { EncryptedBlockstore } from '@fireproof/encrypted-blockstore';
 import type { DocUpdate, ClockHead } from './types';
 import { ApplyHeadQueue } from './apply-head-queue';
 export declare class CRDTClock {
@@ -6,7 +6,7 @@ export declare class CRDTClock {
     zoomers: Set<() => void>;
     watchers: Set<(updates: DocUpdate[]) => void>;
     emptyWatchers: Set<() => void>;
-    blocks: TransactionBlockstore | null;
+    blockstore: EncryptedBlockstore | null;
     applyHeadQueue: ApplyHeadQueue;
     constructor();
     setHead(head: ClockHead): void;

package/dist/types/crdt-helpers.d.ts

@@ -1,19 +1,14 @@
 import { Block } from 'multiformats/block';
-import { LoggingFetcher, Transaction } from './transaction';
-import type { TransactionBlockstore } from './transaction';
-import type { DocUpdate, ClockHead, AnyLink, DocValue, BulkResult, ChangesOptions, BlockFetcher } from './types';
-export declare function applyBulkUpdateToCrdt(tblocks: Transaction, head: ClockHead, updates: DocUpdate[], options?: object): Promise<BulkResult>;
-export declare function getValueFromCrdt(blocks: TransactionBlockstore, head: ClockHead, key: string): Promise<DocValue>;
-export declare function readFiles(blocks: TransactionBlockstore | LoggingFetcher, { doc }: DocValue): void;
-export declare function clockChangesSince(blocks: TransactionBlockstore | LoggingFetcher, head: ClockHead, since: ClockHead, opts: ChangesOptions): Promise<{
+import { type EncryptedBlockstore, type CompactionFetcher, CarTransaction, BlockFetcher } from '@fireproof/encrypted-blockstore';
+import type { DocUpdate, ClockHead, DocValue, CRDTMeta, ChangesOptions } from './types';
+export declare function applyBulkUpdateToCrdt(tblocks: CarTransaction, head: ClockHead, updates: DocUpdate[], options?: object): Promise<CRDTMeta>;
+export declare function getValueFromCrdt(blocks: EncryptedBlockstore, head: ClockHead, key: string): Promise<DocValue>;
+export declare function readFiles(blocks: EncryptedBlockstore, { doc }: DocValue): void;
+export declare function clockChangesSince(blocks: BlockFetcher, head: ClockHead, since: ClockHead, opts: ChangesOptions): Promise<{
     result: DocUpdate[];
     head: ClockHead;
 }>;
-export declare function getAllEntries(blocks: TransactionBlockstore | LoggingFetcher, head: ClockHead): AsyncGenerator<DocUpdate, void, unknown>;
-export declare function clockVis(blocks: TransactionBlockstore, head: ClockHead): AsyncGenerator<string, void, unknown>;
-export declare function doCompact(blocks: TransactionBlockstore, head: ClockHead): Promise<AnyLink | undefined>;
-export declare function getThatBlock({ bytes }: {
-    cid: string;
-    bytes: string;
-}): Promise<Block<unknown, 113, 18, 1>>;
+export declare function getAllEntries(blocks: BlockFetcher, head: ClockHead): AsyncGenerator<DocUpdate, void, unknown>;
+export declare function clockVis(blocks: EncryptedBlockstore, head: ClockHead): AsyncGenerator<string, void, unknown>;
+export declare function doCompact(blockLog: CompactionFetcher, head: ClockHead): Promise<void>;
 export declare function getBlock(blocks: BlockFetcher, cidString: string): Promise<Block<unknown, 113, 18, 1>>;

package/dist/types/crdt.d.ts

@@ -1,24 +1,23 @@
-import { TransactionBlockstore, IndexBlockstore } from './transaction';
-import type { DocUpdate, BulkResult, ClockHead, FireproofOptions, ChangesOptions } from './types';
-import type { Index } from './index';
+import { EncryptedBlockstore } from '@fireproof/encrypted-blockstore';
+import type { DocUpdate, CRDTMeta, ClockHead, ConfigOpts, ChangesOptions } from './types';
+import { type Index } from './index';
 import { CRDTClock } from './crdt-clock';
 export declare class CRDT {
     name: string | null;
-    opts: FireproofOptions;
+    opts: ConfigOpts;
     ready: Promise<void>;
-    blocks: TransactionBlockstore;
-    indexBlocks: IndexBlockstore;
+    blockstore: EncryptedBlockstore;
+    indexBlockstore: EncryptedBlockstore;
     indexers: Map<string, Index>;
     clock: CRDTClock;
-    constructor(name?: string, opts?: FireproofOptions);
-    bulk(updates: DocUpdate[], options?: object): Promise<BulkResult>;
+    constructor(name?: string, opts?: ConfigOpts);
+    bulk(updates: DocUpdate[], options?: object): Promise<CRDTMeta>;
     allDocs(): Promise<{
         result: DocUpdate[];
         head: ClockHead;
     }>;
     vis(): Promise<string>;
     getBlock(cidString: string): Promise<import("multiformats/dist/types/src/block").Block<unknown, 113, 18, 1>>;
-    getThatBlock(): Promise<import("multiformats/dist/types/src/block").Block<unknown, 113, 18, 1>>;
     get(key: string): Promise<import("./types").DocValue | null>;
     changes(since?: ClockHead, opts?: ChangesOptions): Promise<{
         result: DocUpdate[];

package/dist/types/database.d.ts

@@ -1,18 +1,20 @@
 import { WriteQueue } from './write-queue';
 import { CRDT } from './crdt';
-import type { DocUpdate, ClockHead, Doc, FireproofOptions, MapFn, QueryOpts, ChangesOptions } from './types';
+import type { DocUpdate, ClockHead, Doc, ConfigOpts, MapFn, QueryOpts, ChangesOptions } from './types';
 import { DbResponse, ChangesResponse } from './types';
+import { EncryptedBlockstore } from '@fireproof/encrypted-blockstore';
 type DbName = string | null;
 export declare class Database {
     static databases: Map<string, Database>;
     name: DbName;
-    opts: FireproofOptions;
+    opts: ConfigOpts;
     _listening: boolean;
     _listeners: Set<ListenerFn>;
     _noupdate_listeners: Set<ListenerFn>;
     _crdt: CRDT;
     _writeQueue: WriteQueue;
-    constructor(name?: string, opts?: FireproofOptions);
+    blockstore: EncryptedBlockstore;
+    constructor(name?: string, opts?: ConfigOpts);
     get(id: string): Promise<Doc>;
     put(doc: Doc): Promise<DbResponse>;
     del(id: string): Promise<DbResponse>;
@@ -36,13 +38,11 @@ export declare class Database {
         rows: import("./types").IndexRow[];
     }>;
     compact(): Promise<void>;
-    getDashboardURL(compact?: boolean): Promise<URL>;
-    openDashboard(): void;
     _notify(updates: DocUpdate[]): Promise<void>;
     _no_update_notify(): Promise<void>;
 }
 type UpdateListenerFn = (docs: Doc[]) => Promise<void> | void;
 type NoUpdateListenerFn = () => Promise<void> | void;
 type ListenerFn = UpdateListenerFn | NoUpdateListenerFn;
-export declare function fireproof(name: string, opts?: FireproofOptions): Database;
+export declare function fireproof(name: string, opts?: ConfigOpts): Database;
 export {};

package/dist/types/eb-node.d.ts

@@ -0,0 +1,3 @@
+import * as crypto from '@fireproof/encrypted-blockstore/crypto-node';
+import * as store from '@fireproof/encrypted-blockstore/store-node';
+export { store, crypto };

package/dist/types/eb-web.d.ts

@@ -0,0 +1,3 @@
+import * as crypto from '@fireproof/encrypted-blockstore/crypto-web';
+import * as store from '@fireproof/encrypted-blockstore/store-web';
+export { store, crypto };

package/dist/types/fireproof.d.ts

@@ -1,7 +1,3 @@
 export * from './database';
-export * from './index';
-export * from './loader-helpers';
-export * from './store';
-export * from './loader';
 
 export * from './types';

package/dist/types/index.d.ts

@@ -1,12 +1,12 @@
 import type { ClockHead, MapFn, QueryOpts, IdxMeta } from './types';
-import { IndexBlockstore } from './transaction';
+import { EncryptedBlockstore } from '@fireproof/encrypted-blockstore';
 import { IndexTree } from './indexer-helpers';
 import { CRDT } from './crdt';
 export declare function index({ _crdt }: {
     _crdt: CRDT;
 }, name: string, mapFn?: MapFn, meta?: IdxMeta): Index;
 export declare class Index {
-    blocks: IndexBlockstore;
+    blockstore: EncryptedBlockstore;
     crdt: CRDT;
     name: string | null;
     mapFn: MapFn | null;
@@ -24,7 +24,7 @@ export declare class Index {
     }>;
     _resetIndex(): void;
     _hydrateIndex(): Promise<void>;
-    _updateIndex(): Promise<(IdxMeta & import("./types").CarCommit) | {
+    _updateIndex(): Promise<import("@fireproof/encrypted-blockstore/dist/types/types").TransactionMeta | {
         byId: IndexTree;
         byKey: IndexTree;
     }>;

package/dist/types/indexer-helpers.d.ts

@@ -1,7 +1,7 @@
 import type { Block, Link } from 'multiformats';
 import { ProllyNode as BaseNode } from 'prolly-trees/base';
-import { AnyLink, DocUpdate, MapFn, DocFragment, BlockFetcher, IndexKey, IndexUpdate, QueryOpts, IndexRow } from './types';
-import { Transaction } from './transaction';
+import { AnyLink, DocUpdate, MapFn, DocFragment, IndexKey, IndexUpdate, QueryOpts, IndexRow } from './types';
+import { CarTransaction, BlockFetcher } from '@fireproof/encrypted-blockstore';
 import { CRDT } from './crdt';
 export declare class IndexTree {
     cid: AnyLink | null;
@@ -13,7 +13,7 @@ export declare function indexEntriesForChanges(changes: DocUpdate[], mapFn: MapF
     key: [string, string];
     value: DocFragment;
 }[];
-export declare function bulkIndex(tblocks: Transaction, inIndex: IndexTree, indexEntries: IndexUpdate[], opts: StaticProllyOptions): Promise<IndexTree>;
+export declare function bulkIndex(tblocks: CarTransaction, inIndex: IndexTree, indexEntries: IndexUpdate[], opts: StaticProllyOptions): Promise<IndexTree>;
 export declare function loadIndex(tblocks: BlockFetcher, cid: AnyLink, opts: StaticProllyOptions): Promise<ProllyNode>;
 export declare function applyQuery(crdt: CRDT, resp: {
     result: IndexRow[];

package/dist/types/types.d.ts

@@ -1,9 +1,10 @@
 import type { Link } from 'multiformats'
 import type { EventLink } from '@alanshaw/pail/clock'
 import type { EventData } from '@alanshaw/pail/crdt'
-import { ClockHead, Doc } from './types'
 
-export type FireproofOptions = {
+import type { DbMeta } from '@fireproof/encrypted-blockstore'
+
+export type ConfigOpts = {
   public?: boolean
   meta?: DbMeta
   persistIndexes?: boolean
@@ -14,7 +15,15 @@ export type ClockLink = EventLink<EventData>
 
 export type ClockHead = ClockLink[]
 
-export type DocFragment = Uint8Array | string | number | boolean | null | DocFragment[] | { [key: string]: DocFragment }
+export type DocFragment =
+  | Uint8Array
+  | string
+  | number
+  | boolean
+  | null
+  | AnyLink
+  | DocFragment[]
+  | { [key: string]: DocFragment }
 
 export type Doc = DocBody & DocBase
 
@@ -25,31 +34,25 @@ export type DocBase = {
 }
 
 export type DocFileMeta = {
-  type: string;
-  size: number;
-  cid: AnyLink;
-  car?: AnyLink;
-  url?: string;
-  file?: () => Promise<File>;
+  type: string
+  size: number
+  cid: AnyLink
+  car?: AnyLink
+  url?: string
+  file?: () => Promise<File>
 }
 
-type DocFiles = {
-  [key: string]: File | DocFileMeta
-}
+export type DocFiles = Record<string, DocFileMeta | File>;
 
-export type FileCarHeader = {
-  files: AnyLink[]
-}
-type DocBody = {
-  _files?: DocFiles
-  _publicFiles?: DocFiles
-  [key: string]: DocFragment
+type DocBody = Record<string, DocFragment> & {
+  _files?: DocFiles;
+  _publicFiles?: DocFiles;
 }
 
-type DocMeta = {
-  proof?: DocFragment
-  clock?: ClockHead
-}
+// type DocMeta = {
+//   proof?: DocFragment
+//   clock?: ClockHead
+// }
 
 export type DocUpdate = {
   key: string
@@ -57,16 +60,12 @@ export type DocUpdate = {
   del?: boolean
   clock?: AnyLink
 }
-
+// todo merge into above
 export type DocValue = {
   doc?: DocBody
   del?: boolean
 }
 
-type IndexCars = {
-  [key: string]: AnyLink
-}
-
 export type IndexKey = [string, string] | string
 
 export type IndexUpdate = {
@@ -84,17 +83,13 @@ export type IndexRow = {
   del?: boolean
 }
 
-type CarCommit = {
-  car?: AnyLink
-}
-
-export type BulkResult = {
+export type CRDTMeta = {
   head: ClockHead
 }
 
-export type FileResult = {
-  files: { [key: string]: DocFileMeta }
-}
+// export type FileMeta = {
+//   files: { [key: string]: DocFileMeta }
+// }
 
 export type IdxMeta = {
   byId: AnyLink
@@ -108,51 +103,22 @@ export type IdxMetaMap = {
   indexes: Map<string, IdxMeta>
 }
 
-type CarHeader = {
-  cars: AnyLink[]
-  compact: AnyLink[]
-}
-
-export type IdxCarHeader = CarHeader & IdxMetaMap
-
-export type DbCarHeader = CarHeader & {
-  head: ClockHead
-}
-
-export type AnyCarHeader = DbCarHeader | IdxCarHeader | FileCarHeader
-
-export type CarLoaderHeader = DbCarHeader | IdxCarHeader
-
 export type QueryOpts = {
   descending?: boolean
   limit?: number
   includeDocs?: boolean
   range?: [IndexKey, IndexKey]
-  key?: DocFragment,
+  key?: DocFragment
   keys?: DocFragment[]
   prefix?: DocFragment | [DocFragment]
 }
 
 export type AnyLink = Link<unknown, number, number, 1 | 0>
 export type AnyBlock = { cid: AnyLink; bytes: Uint8Array }
-export type AnyDecodedBlock = { cid: AnyLink; bytes: Uint8Array, value: any }
-
-export type BlockFetcher = { get: (link: AnyLink) => Promise<AnyBlock | undefined> }
-
-type CallbackFn = (k: DocFragment, v?: DocFragment) => void
-
-export type MapFn = (doc: Doc, map: CallbackFn) => DocFragment | void
-
-export type DbMeta = { car: AnyLink, key: string | null }
-
-export type CommitOpts = { noLoader?: boolean, compact?: boolean, public?: boolean }
-
-export interface CarMakeable {
-  entries(): Iterable<AnyBlock>
-  get(cid: AnyLink): Promise<AnyBlock | undefined>
-}
-
+export type AnyDecodedBlock = { cid: AnyLink; bytes: Uint8Array; value: any }
 
+type EmitFn = (k: DocFragment, v?: DocFragment) => void
+export type MapFn = (doc: Doc, emit: EmitFn) => DocFragment | void
 
 export type ChangesOptions = {
   dirty?: boolean

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const PACKAGE_VERSION = "0.15.0-dev";
+export declare const PACKAGE_VERSION = "0.16.1";

package/dist/types/write-queue.d.ts

@@ -1,7 +1,7 @@
-import { BulkResult, DocUpdate } from './types';
-type WorkerFunction = (tasks: DocUpdate[]) => Promise<BulkResult>;
+import { CRDTMeta, DocUpdate } from './types';
+type WorkerFunction = (tasks: DocUpdate[]) => Promise<CRDTMeta>;
 export type WriteQueue = {
-    push(task: DocUpdate): Promise<BulkResult>;
+    push(task: DocUpdate): Promise<CRDTMeta>;
 };
 export declare function writeQueue(worker: WorkerFunction, payload?: number, unbounded?: boolean): WriteQueue;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fireproof/core",
-  "version": "0.15.0-dev",
+  "version": "0.16.1",
   "description": "Live database for the web.",
   "main": "./dist/browser/fireproof.cjs",
   "module": "./dist/browser/fireproof.esm.js",
@@ -33,32 +33,6 @@
     "dist/types"
   ],
   "type": "module",
-  "scripts": {
-    "prepublishOnly": "cp ../../README.md . && npm run build:all",
-    "postpublish": "rm README.md",
-    "clean": "rm -rf dist/*",
-    "build:version": "node -p \"'export const PACKAGE_VERSION = ' + JSON.stringify(require('./package.json').version) + ';'\" > src/version.ts",
-    "build:esbuild": "node ./scripts/build.js",
-    "build:_types": "tsc --declaration --outDir dist/types && node ./scripts/types.js",
-    "build:rollup": "rollup -c scripts/rollup.js",
-    "build:tsc": "npm run clean && tsc && mkdir dist/tsc && mv dist/*.js dist/tsc/ && node ./scripts/types.js",
-    "test:watch:follow": "nodemon -w src -w test -e ts,js --exec \"sleep 2 && npm run test:node\"",
-    "test:node": "node ./scripts/test.js",
-    "test:browser": "node ./scripts/browser-test.js",
-    "lint:fix": "eslint --fix '{src,test}/**/*.{js,ts}'",
-    "lint:exports": "ts-unused-exports tsconfig.json",
-    "serve": "npx serve-http -p 8080 test/www",
-    "lint": "eslint 'src/**/*.{js,ts}'",
-    "analyze": "node ./scripts/analyze.js",
-    "test:coverage": "c8 --reporter=html --include='dist/*' node ./scripts/test.js && open coverage/src/index.html",
-    "tsc:watch": "tsc --watch",
-    "lint:all": "npm run lint:fix && npm run lint:exports",
-    "test:watch": "nodemon -w src -w test -e ts,js --exec \"npm run build:test && npm run test:node\"",
-    "test": "npm run build:test && npm run test:node && tsc",
-    "build:test": "node ./scripts/build.js",
-    "build": "npm run build:version && npm run build:tsc && npm run build:test && cp dist/browser/fireproof.iife.* test/www/",
-    "build:all": " npm run build && npm run test:browser"
-  },
   "keywords": [
     "database",
     "JSON",
@@ -123,7 +97,7 @@
     "util": "^0.12.5"
   },
   "dependencies": {
-    "@alanshaw/pail": "^0.3.3",
+    "@alanshaw/pail": "^0.3.4",
     "@ipld/car": "^5.2.0",
     "@ipld/dag-cbor": "^9.0.3",
     "@ipld/dag-json": "^10.1.2",
@@ -135,6 +109,33 @@
     "multiformats": "^12.0.1",
     "p-limit": "^4.0.0",
     "prolly-trees": "^1.0.4",
-    "uuidv7": "^0.6.2"
+    "uuidv7": "^0.6.2",
+    "@fireproof/encrypted-blockstore": "^0.16.10"
+  },
+  "scripts": {
+    "build": "npm run build:version && npm run build:tsc && npm run build:test && cp dist/browser/fireproof.iife.* test/www/",
+    "build:all": " npm run build && npm run test:browser",
+    "build:clean": "rm -rf dist",
+    "build:esbuild": "node ./scripts/build.js",
+    "build:rollup": "rollup -c scripts/rollup.js",
+    "build:test": "node ./scripts/build.js",
+    "build:tsc": "npm run build:clean && tsc && mkdir dist/tsc && mv dist/*.js dist/tsc/ && node ./scripts/types.js",
+    "build:version": "node -p \"'export const PACKAGE_VERSION = ' + JSON.stringify(require('./package.json').version) + ';'\" > src/version.ts",
+    "build:_types": "tsc --declaration --outDir dist/types && node ./scripts/types.js",
+    "clean": "rm -rf node_modules",
+    "test:watch:follow": "nodemon -w src -w test -e ts,js --exec \"sleep 2 && npm run test:node\"",
+    "test:node": "node ./scripts/test.js",
+    "test:browser": "node ./scripts/browser-test.js",
+    "lint:fix": "eslint --fix '{src,test}/**/*.{js,ts}'",
+    "lint:exports": "ts-unused-exports tsconfig.json",
+    "serve": "npx serve-http -p 8080 test/www",
+    "lint": "eslint 'src/**/*.{js,ts}'",
+    "analyze": "node ./scripts/analyze.js",
+    "test:coverage": "c8 --reporter=html --include='dist/*' node ./scripts/test.js && open coverage/src/index.html",
+    "tsc:watch": "tsc --watch",
+    "lint:all": "npm run lint:fix && npm run lint:exports",
+    "test:watch": "nodemon -w src -w test -e ts,js --exec \"npm run build:test && npm run test:node\"",
+    "test": "npm run build:test && npm run test:node && tsc",
+    "test:serve": "npx serve-http test/www -p 8080"
   }
-}
+}