@fireproof/core 0.19.121 → 0.20.0-dev-preview-05

package/README.md

@@ -1,4 +1,4 @@
-# <img src="https://fireproof.storage/static/img/flame.svg" alt="Fireproof logo" width="25"> [Fireproof](https://fireproof.storage) realtime database
+# <img src="https://fireproof.storage/static/img/flame.svg" alt="Fireproof logo" width="25"> [Fireproof](https://fireproof.storage) realtime ledger
 
 <p align="right">
   <img src="https://img.shields.io/bundlephobia/minzip/%40fireproof%2Fcore" alt="Package size">
@@ -9,11 +9,11 @@
 
 ### No setup: write features first, access your data anywhere
 
-Add collaboration to any app with Fireproof. Access data from JavaScript servers and edge functions. Use live queries to update your UI automatically when the database changes. [Connect realtime sync](https://www.npmjs.com/package/@fireproof/connect) and those changes will sync between browsers and backend functions. Apps built this way are multi-player by default.
+Add collaboration to any app with Fireproof. Access data from JavaScript servers and edge functions. Use live queries to update your UI automatically when the ledger changes. [Connect realtime sync](https://www.npmjs.com/package/@fireproof/connect) and those changes will sync between browsers and backend functions. Apps built this way are multi-player by default.
 
 ### JavaScript quick start
 
-The document database API will feel familiar. Queries use dynamic indexes, and the database can refresh your UI, as seen in the `db.subscribe` call below, as well as the React liveQuery hook.
+The document ledger API will feel familiar. Queries use dynamic indexes, and the ledger can refresh your UI, as seen in the `db.subscribe` call below, as well as the React liveQuery hook.
 
 ```js
 import { fireproof } from "@fireproof/core";
@@ -32,34 +32,35 @@ beyonceDoc.hitSingles += 1;
 await db.put(beyonceDoc);
 ```
 
-Jump to the docs site [for JavaScript API basics.](https://use-fireproof.com/docs/database-api/basics)
+Jump to the docs site [for JavaScript API basics.](https://use-fireproof.com/docs/ledger-api/basics)
 
 ### Live data hooks for React
 
 Fireproof [React hooks for live data](https://use-fireproof.com/docs/category/react-hooks) avoid boilerplate and make building collaborative apps a breeze.
 
 ```js
-import { useLiveQuery, useDocument } from 'use-fireproof'
+import { useFireproof } from 'use-fireproof'
 
 function App() {
+  const { useLiveQuery, useDocument } = useFireproof("my-db-name")
   const completedTodos = useLiveQuery('completed', { limit: 10 })
-  const [newTodo, setNewTodoData, saveNewTodo] = useDocument({type: 'todo', text: '', completed: false, created: Date.now() })
+  const [newTodo, setNewTodo, saveNewTodo] = useDocument(() => ({type: 'todo', text: '', completed: false, created: Date.now() }))
 ```
 
 Read the [step-by-step React tutorial](https://use-fireproof.com/docs/react-tutorial) to get started.
 
 ## Why choose Fireproof
 
-Compared to other embedded databases, Fireproof:
+Compared to other embedded ledgers, Fireproof:
 
 - is network aware, encrypted, and multi-writer safe
 - is designed for real-time collaboration with CRDTs
 - offers cryptographic causal integrity for all operations
 - is built for the web, with a small package size and no wasm
 
-Deliver interactive experiences without waiting on the backend. Fireproof runs in any cloud, browser, or edge environment, so your application can access data anywhere.
+Deliver interactive experiences without waiting on the backend. Fireproof runs in any cloud, browser, or edge environment, so your application can access tamperproof data anywhere.
 
-[Get the latest roadmap updates on our blog](https://fireproof.storage/blog/) or join our [Discord](https://discord.gg/cCryrNHePH) to collaborate. Read the docs to learn more about the database [architecture](https://use-fireproof.com/docs/architecture).
+[Get the latest roadmap updates on our blog](https://fireproof.storage/blog/) or join our [Discord](https://discord.gg/cCryrNHePH) to collaborate. Read the docs to learn more about the ledger [architecture](https://use-fireproof.com/docs/architecture).
 
 ### Use cases
 
@@ -83,7 +84,7 @@ Get started with the React hooks:
 npm install use-fireproof
 ```
 
-or install the database in any JavaScript environment:
+or install the ledger in any JavaScript environment:
 
 ```sh
 npm install @fireproof/core
@@ -95,7 +96,7 @@ The default build is optimized for browsers, to load the node build add `/node`:
 import { fireproof } from "@fireproof/core/node";
 ```
 
-Add the database to any web page via HTML script tag (global is `Fireproof`):
+Add the ledger to any web page via HTML script tag (global is `Fireproof`):
 
 ```html
 <script src="https://cdn.jsdelivr.net/npm/@fireproof/core/dist/browser/fireproof.global.js"></script>
@@ -165,7 +166,7 @@ pnpm run build:doc
 
 ## Thanks 🙏
 
-Fireproof is a synthesis of work done by people in the web community over the years. I couldn't even begin to name all the folks who made pivotal contributions. Without npm, React, and VS Code all this would have taken so much longer. Thanks to everyone who supported me getting into database development via Apache CouchDB, one of the original document databases. The distinguishing work on immutable data-structures comes from the years of consideration [IPFS](https://ipfs.tech), [IPLD](https://ipld.io), and the [Filecoin APIs](https://docs.filecoin.io) have enjoyed.
+Fireproof is a synthesis of work done by people in the web community over the years. I couldn't even begin to name all the folks who made pivotal contributions. Without npm, React, and VS Code all this would have taken so much longer. Thanks to everyone who supported me getting into ledger development via Apache CouchDB, one of the original document ledgers. The distinguishing work on immutable data-structures comes from the years of consideration [IPFS](https://ipfs.tech), [IPLD](https://ipld.io), and the [Filecoin APIs](https://docs.filecoin.io) have enjoyed.
 
 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).
 

package/deno/index.d.ts

@@ -0,0 +1,7 @@
+import { SysFileSystem } from '@fireproof/core';
+import { URI } from '@adviser/cement';
+
+declare function getSysFileSystem(url: URI): Promise<SysFileSystem>;
+
+export { getSysFileSystem };
+declare module '@fireproof/core/deno'

package/deno/index.js

@@ -0,0 +1,66 @@
+// src/runtime/gateways/file/deno/deno-filesystem.ts
+var DenoFileSystem = class {
+  async start() {
+    this.fs = Deno;
+    return this;
+  }
+  async mkdir(path, options) {
+    return this.fs?.mkdir(path, options).then(() => path);
+  }
+  async readdir(path) {
+    const ret = [];
+    for await (const dirEntry of this.fs.readdir(path)) {
+      ret.push(dirEntry.name);
+    }
+    return ret;
+  }
+  async rm(path, options) {
+    return this.fs?.rm(path, options);
+  }
+  async copyFile(source, destination) {
+    return this.fs?.copyFile(source, destination);
+  }
+  async readfile(path) {
+    return this.fs.readFile(path);
+  }
+  async stat(path) {
+    const x = await this.fs.stat(path);
+    return {
+      isFile: () => x.isFile,
+      isDirectory: () => x.isDirectory,
+      isBlockDevice: () => !!x.isBlockDevice,
+      isCharacterDevice: () => !!x.isCharDevice,
+      isSymbolicLink: () => !!x.isSymlink,
+      isFIFO: () => !!x.isFifo,
+      isSocket: () => !!x.isSocket,
+      uid: x.uid,
+      gid: x.gid,
+      size: x.size,
+      atime: x.atime,
+      mtime: x.mtime,
+      ctime: x.birthtime,
+      birthtime: x.birthtime
+    };
+  }
+  async unlink(path) {
+    return this.fs?.unlink(path);
+  }
+  async writefile(path, data) {
+    return this.fs?.writeFile(path, Buffer.from(data));
+  }
+};
+
+// src/runtime/gateways/file/deno/get-sys-file-system.ts
+import { ResolveOnce } from "@adviser/cement";
+var nfs = new ResolveOnce();
+async function getSysFileSystem(url) {
+  return nfs.once(async () => {
+    const nfs2 = new DenoFileSystem();
+    await nfs2.start();
+    return nfs2;
+  });
+}
+export {
+  getSysFileSystem
+};
+//# sourceMappingURL=index.js.map

package/deno/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/runtime/gateways/file/deno/deno-filesystem.ts","../../../src/runtime/gateways/file/deno/get-sys-file-system.ts"],"sourcesContent":["import type { FPStats, SysFileSystem } from \"@fireproof/core\";\n\nexport class DenoFileSystem implements SysFileSystem {\n  fs?: {\n    mkdir: typeof Deno.mkdir;\n    readdir: typeof Deno.readDir;\n    rm: typeof Deno.remove;\n    copyFile: typeof Deno.copyFile;\n    readFile: typeof Deno.readFile;\n    stat: typeof Deno.stat;\n    unlink: typeof Deno.remove;\n    writeFile: typeof Deno.writeFile;\n  };\n\n  async start(): Promise<SysFileSystem> {\n    this.fs = Deno as unknown as DenoFileSystem[\"fs\"];\n    return this;\n  }\n  async mkdir(path: string, options?: { recursive: boolean }): Promise<string | undefined> {\n    return this.fs?.mkdir(path, options).then(() => path);\n  }\n  async readdir(path: string): Promise<string[]> {\n    const ret = [];\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    for await (const dirEntry of this.fs!.readdir(path)) {\n      ret.push(dirEntry.name);\n    }\n    return ret;\n  }\n  async rm(path: string, options?: { recursive: boolean }): Promise<void> {\n    return this.fs?.rm(path, options);\n  }\n  async copyFile(source: string, destination: string): Promise<void> {\n    return this.fs?.copyFile(source, destination);\n  }\n  async readfile(path: string): Promise<Uint8Array> {\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    return this.fs!.readFile(path);\n  }\n  async stat(path: string): Promise<FPStats> {\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    const x = await this.fs!.stat(path);\n    return {\n      isFile: () => x.isFile,\n      isDirectory: () => x.isDirectory,\n      isBlockDevice: () => !!x.isBlockDevice,\n      isCharacterDevice: () => !!x.isCharDevice,\n      isSymbolicLink: () => !!x.isSymlink,\n      isFIFO: () => !!x.isFifo,\n      isSocket: () => !!x.isSocket,\n      uid: x.uid,\n      gid: x.gid,\n      size: x.size,\n      atime: x.atime,\n      mtime: x.mtime,\n      ctime: x.birthtime,\n      birthtime: x.birthtime,\n    };\n  }\n  async unlink(path: string): Promise<void> {\n    return this.fs?.unlink(path);\n  }\n  async writefile(path: string, data: Uint8Array | string): Promise<void> {\n    return this.fs?.writeFile(path, Buffer.from(data));\n  }\n}\n","import type { SysFileSystem } from \"@fireproof/core\";\nimport { DenoFileSystem } from \"./deno-filesystem.js\";\nimport { ResolveOnce, URI } from \"@adviser/cement\";\n\nconst nfs = new ResolveOnce<SysFileSystem>();\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nexport async function getSysFileSystem(url: URI): Promise<SysFileSystem> {\n  return nfs.once(async () => {\n    const nfs = new DenoFileSystem();\n    await nfs.start();\n    return nfs;\n  });\n}\n"],"mappings":";AAEO,IAAM,iBAAN,MAA8C;AAAA,EAYnD,MAAM,QAAgC;AACpC,SAAK,KAAK;AACV,WAAO;AAAA,EACT;AAAA,EACA,MAAM,MAAM,MAAc,SAA+D;AACvF,WAAO,KAAK,IAAI,MAAM,MAAM,OAAO,EAAE,KAAK,MAAM,IAAI;AAAA,EACtD;AAAA,EACA,MAAM,QAAQ,MAAiC;AAC7C,UAAM,MAAM,CAAC;AAEb,qBAAiB,YAAY,KAAK,GAAI,QAAQ,IAAI,GAAG;AACnD,UAAI,KAAK,SAAS,IAAI;AAAA,IACxB;AACA,WAAO;AAAA,EACT;AAAA,EACA,MAAM,GAAG,MAAc,SAAiD;AACtE,WAAO,KAAK,IAAI,GAAG,MAAM,OAAO;AAAA,EAClC;AAAA,EACA,MAAM,SAAS,QAAgB,aAAoC;AACjE,WAAO,KAAK,IAAI,SAAS,QAAQ,WAAW;AAAA,EAC9C;AAAA,EACA,MAAM,SAAS,MAAmC;AAEhD,WAAO,KAAK,GAAI,SAAS,IAAI;AAAA,EAC/B;AAAA,EACA,MAAM,KAAK,MAAgC;AAEzC,UAAM,IAAI,MAAM,KAAK,GAAI,KAAK,IAAI;AAClC,WAAO;AAAA,MACL,QAAQ,MAAM,EAAE;AAAA,MAChB,aAAa,MAAM,EAAE;AAAA,MACrB,eAAe,MAAM,CAAC,CAAC,EAAE;AAAA,MACzB,mBAAmB,MAAM,CAAC,CAAC,EAAE;AAAA,MAC7B,gBAAgB,MAAM,CAAC,CAAC,EAAE;AAAA,MAC1B,QAAQ,MAAM,CAAC,CAAC,EAAE;AAAA,MAClB,UAAU,MAAM,CAAC,CAAC,EAAE;AAAA,MACpB,KAAK,EAAE;AAAA,MACP,KAAK,EAAE;AAAA,MACP,MAAM,EAAE;AAAA,MACR,OAAO,EAAE;AAAA,MACT,OAAO,EAAE;AAAA,MACT,OAAO,EAAE;AAAA,MACT,WAAW,EAAE;AAAA,IACf;AAAA,EACF;AAAA,EACA,MAAM,OAAO,MAA6B;AACxC,WAAO,KAAK,IAAI,OAAO,IAAI;AAAA,EAC7B;AAAA,EACA,MAAM,UAAU,MAAc,MAA0C;AACtE,WAAO,KAAK,IAAI,UAAU,MAAM,OAAO,KAAK,IAAI,CAAC;AAAA,EACnD;AACF;;;AC/DA,SAAS,mBAAwB;AAEjC,IAAM,MAAM,IAAI,YAA2B;AAE3C,eAAsB,iBAAiB,KAAkC;AACvE,SAAO,IAAI,KAAK,YAAY;AAC1B,UAAMA,OAAM,IAAI,eAAe;AAC/B,UAAMA,KAAI,MAAM;AAChB,WAAOA;AAAA,EACT,CAAC;AACH;","names":["nfs"]}

package/deno/metafile-esm.json

@@ -0,0 +1 @@
+{"inputs":{"src/runtime/gateways/file/deno/deno-filesystem.ts":{"bytes":2181,"imports":[],"format":"esm"},"src/runtime/gateways/file/deno/get-sys-file-system.ts":{"bytes":462,"imports":[{"path":"src/runtime/gateways/file/deno/deno-filesystem.ts","kind":"import-statement","original":"./deno-filesystem.js"},{"path":"@adviser/cement","kind":"import-statement","external":true}],"format":"esm"},"src/runtime/gateways/file/deno/index.ts":{"bytes":61,"imports":[{"path":"src/runtime/gateways/file/deno/get-sys-file-system.ts","kind":"import-statement","original":"./get-sys-file-system.js"}],"format":"esm"}},"outputs":{"dist/fireproof-core/deno/index.js.map":{"imports":[],"exports":[],"inputs":{},"bytes":4331},"dist/fireproof-core/deno/index.js":{"imports":[{"path":"@adviser/cement","kind":"import-statement","external":true}],"exports":["getSysFileSystem"],"entryPoint":"src/runtime/gateways/file/deno/index.ts","inputs":{"src/runtime/gateways/file/deno/deno-filesystem.ts":{"bytesInOutput":1243},"src/runtime/gateways/file/deno/get-sys-file-system.ts":{"bytesInOutput":235},"src/runtime/gateways/file/deno/index.ts":{"bytesInOutput":0}},"bytes":1620}}}

package/deno.json

@@ -1,14 +1,13 @@
 {
   "imports": {
     "@fireproof/core": "./index.js",
-    "@adviser/cement": "npm:@adviser/cement@^0.3.4",
+    "@adviser/cement": "npm:@adviser/cement@^0.3.5",
     "@fireproof/vendor": "npm:@fireproof/vendor@^1.0.4",
-    "@ipld/unixfs": "npm:@ipld/unixfs@^3.0.0",
     "multiformats": "npm:multiformats@^13.3.1",
+    "@ipld/unixfs": "npm:@ipld/unixfs@^3.0.0",
     "charwise": "npm:charwise@^3.0.1",
     "prolly-trees": "npm:prolly-trees@^1.0.4",
     "idb": "npm:idb@^8.0.1",
-    "memfs": "npm:memfs@^4.15.1",
     "p-limit": "npm:p-limit@^6.2.0",
     "p-map": "npm:p-map@^7.0.3",
     "p-retry": "npm:p-retry@^6.2.1"