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

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 ledger
+# <img src="https://fireproof.storage/static/img/flame.svg" alt="Fireproof logo" width="25"> [Fireproof](https://fireproof.storage) realtime database
 
 <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 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.
+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.
 
 ### JavaScript quick start
 
-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.
+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.
 
 ```js
 import { fireproof } from "@fireproof/core";
@@ -32,7 +32,7 @@ beyonceDoc.hitSingles += 1;
 await db.put(beyonceDoc);
 ```
 
-Jump to the docs site [for JavaScript API basics.](https://use-fireproof.com/docs/ledger-api/basics)
+Jump to the docs site [for JavaScript API basics.](https://use-fireproof.com/docs/database-api/basics)
 
 ### Live data hooks for React
 
@@ -51,16 +51,16 @@ Read the [step-by-step React tutorial](https://use-fireproof.com/docs/react-tuto
 
 ## Why choose Fireproof
 
-Compared to other embedded ledgers, Fireproof:
+Compared to other embedded databases, 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 tamperproof data anywhere.
+Deliver interactive experiences without waiting on the backend. Fireproof runs in any cloud, browser, or edge environment, so your application can access 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 ledger [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 database [architecture](https://use-fireproof.com/docs/architecture).
 
 ### Use cases
 
@@ -84,7 +84,7 @@ Get started with the React hooks:
 npm install use-fireproof
 ```
 
-or install the ledger in any JavaScript environment:
+or install the database in any JavaScript environment:
 
 ```sh
 npm install @fireproof/core
@@ -96,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 ledger to any web page via HTML script tag (global is `Fireproof`):
+Add the database 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>
@@ -166,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 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.
+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.
 
 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/index.cjs

@@ -31,9 +31,9 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   CRDT: () => CRDT,
+  DatabaseFactory: () => DatabaseFactory,
+  DatabaseShell: () => DatabaseShell,
   Index: () => Index,
-  LedgerFactory: () => LedgerFactory,
-  LedgerShell: () => LedgerShell,
   NotFoundError: () => NotFoundError,
   PACKAGE_VERSION: () => PACKAGE_VERSION,
   PARAM: () => PARAM,
@@ -54,8 +54,8 @@ __export(index_exports, {
   getStore: () => getStore,
   index: () => index,
   inplaceFilter: () => inplaceFilter,
+  isDatabase: () => isDatabase,
   isFalsy: () => isFalsy,
-  isLedger: () => isLedger,
   isNotFoundError: () => isNotFoundError,
   keyConfigOpts: () => keyConfigOpts,
   onSuperThis: () => onSuperThis,
@@ -67,7 +67,7 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
-// src/ledger.ts
+// src/database.ts
 var import_cement20 = require("@adviser/cement");
 
 // src/utils.ts
@@ -849,7 +849,7 @@ var EncryptedBlockstore = class extends BaseBlockstore {
   }
   async getFile(car, cid) {
     await this.ready();
-    if (!this.loader) throw this.logger.Error().Msg("loader required to get file, ledger must be named").AsError();
+    if (!this.loader) throw this.logger.Error().Msg("loader required to get file, database must be named").AsError();
     const reader = await this.loader.loadFileCar(
       car
       /*, isPublic */
@@ -3301,9 +3301,9 @@ var ConnectionBase = class {
   //   //   await this.compact()
   //   // }
   //   const currents = await this.loader?.metaStore?.load()
-  //   if (!currents) throw new Error("Can't sync empty ledger: save data first")
+  //   if (!currents) throw new Error("Can't sync empty database: save data first")
   //   if (currents.length > 1)
-  //     throw new Error("Can't sync ledger with split heads: make an update first")
+  //     throw new Error("Can't sync database with split heads: make an update first")
   //   const current = currents[0]
   //   const params = {
   //     car: current.car.toString()
@@ -3402,7 +3402,7 @@ async function processFiles(store, blocks, doc, logger) {
 }
 async function processFileset(logger, store, blocks, files) {
   const dbBlockstore = blocks.parent;
-  if (!dbBlockstore.loader) throw logger.Error().Msg("Missing loader, ledger name is required").AsError();
+  if (!dbBlockstore.loader) throw logger.Error().Msg("Missing loader, database name is required").AsError();
   const t = new CarTransaction(dbBlockstore);
   const didPut = [];
   for (const filename in files) {
@@ -3434,7 +3434,7 @@ async function processFileset(logger, store, blocks, files) {
   }
 }
 async function getValueFromCrdt(blocks, head, key, logger) {
-  if (!head.length) throw logger.Debug().Msg("Getting from an empty ledger").AsError();
+  if (!head.length) throw logger.Debug().Msg("Getting from an empty database").AsError();
   const link = await (0, import_crdt.get)(blocks, head, key);
   if (!link) throw logger.Error().Str("key", key).Msg(`Missing key`).AsError();
   return await getValueFromLink(blocks, link, logger);
@@ -4233,8 +4233,8 @@ var CRDT = class {
   }
 };
 
-// src/ledger.ts
-var ledgers = new import_cement20.KeyedResolvOnce();
+// src/database.ts
+var databases = new import_cement20.KeyedResolvOnce();
 function keyConfigOpts(sthis, name, opts) {
   return JSON.stringify(
     toSortedArray({
@@ -4243,14 +4243,14 @@ function keyConfigOpts(sthis, name, opts) {
     })
   );
 }
-function isLedger(db) {
-  return db instanceof LedgerImpl || db instanceof LedgerShell;
+function isDatabase(db) {
+  return db instanceof DatabaseImpl || db instanceof DatabaseShell;
 }
-function LedgerFactory(name, opts) {
+function DatabaseFactory(name, opts) {
   const sthis = ensureSuperThis(opts);
-  return new LedgerShell(
-    ledgers.get(keyConfigOpts(sthis, name, opts)).once((key) => {
-      const db = new LedgerImpl(sthis, {
+  return new DatabaseShell(
+    databases.get(keyConfigOpts(sthis, name, opts)).once((key) => {
+      const db = new DatabaseImpl(sthis, {
         name,
         meta: opts?.meta,
         keyBag: defaultKeyBagOpts(sthis, opts?.keyBag),
@@ -4264,13 +4264,13 @@ function LedgerFactory(name, opts) {
         }
       });
       db.onClosed(() => {
-        ledgers.unget(key);
+        databases.unget(key);
       });
       return db;
     })
   );
 }
-var LedgerShell = class {
+var DatabaseShell = class {
   constructor(ref) {
     this.ref = ref;
     ref.addShell(this);
@@ -4333,7 +4333,7 @@ var LedgerShell = class {
     return this.ref.compact();
   }
 };
-var LedgerImpl = class {
+var DatabaseImpl = class {
   constructor(sthis, opts) {
     this._listening = false;
     this._listeners = /* @__PURE__ */ new Set();
@@ -4345,7 +4345,7 @@ var LedgerImpl = class {
     this.opts = opts;
     this.sthis = sthis;
     this.id = sthis.timeOrderedNextId().str;
-    this.logger = ensureLogger(this.sthis, "Ledger");
+    this.logger = ensureLogger(this.sthis, "Database");
     this.crdt = new CRDT(this.sthis, this.opts);
     this._writeQueue = writeQueue(this.sthis, async (updates) => this.crdt.bulk(updates), this.opts.writeQueue);
     this.crdt.clock.onTock(() => this._no_update_notify());
@@ -4361,7 +4361,7 @@ var LedgerImpl = class {
   }
   async shellClose(db) {
     if (!this.shells.has(db)) {
-      throw this.logger.Error().Str("db", this.name).Msg(`LedgerShell mismatch`).AsError();
+      throw this.logger.Error().Str("db", this.name).Msg(`DatabaseShell mismatch`).AsError();
     }
     this.shells.delete(db);
     if (this.shells.size === 0) {
@@ -4515,7 +4515,7 @@ function defaultURI2(sthis, curi, uri, store, ctx) {
   if (!ret.hasParam("name" /* NAME */)) {
     const name = sthis.pathOps.basename(ret.URI().pathname);
     if (!name) {
-      throw sthis.logger.Error().Url(ret).Any("ctx", ctx).Msg("Ledger name is required").AsError();
+      throw sthis.logger.Error().Url(ret).Any("ctx", ctx).Msg("Database name is required").AsError();
     }
     ret.setParam("name" /* NAME */, name);
   }
@@ -4564,7 +4564,7 @@ function toStoreURIRuntime(sthis, name, sopts) {
   };
 }
 function fireproof(name, opts) {
-  return LedgerFactory(name, opts);
+  return DatabaseFactory(name, opts);
 }
 function makeName(fnString) {
   const regex = /\(([^,()]+,\s*[^,()]+|\[[^\]]+\],\s*[^,()]+)\)/g;
@@ -4585,6 +4585,6 @@ function makeName(fnString) {
 
 // src/version.ts
 var PACKAGE_VERSION = Object.keys({
-  "0.20.0-dev-preview-05": "xxxx"
+  "0.20.0-dev-preview-06": "xxxx"
 })[0];
 //# sourceMappingURL=index.cjs.map