@fireproof/core 0.19.118 → 0.19.119

package/README.md

@@ -155,6 +155,14 @@ It might be that using our provided deno.json is somekind of odd
 deno run --config node_modules/@fireproof/core/deno.json --allow-read --allow-write --allow-env --unstable-sloppy-imports ./node-test.ts
 ```
 
+### Create Docs
+
+Caution it will be pushed directly
+
+```shell
+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.

package/deno.json

@@ -1,15 +1,15 @@
 {
   "imports": {
     "@fireproof/core": "./index.js",
-    "@adviser/cement": "npm:@adviser/cement@^0.2.41",
+    "@adviser/cement": "npm:@adviser/cement@^0.3.0",
     "@fireproof/vendor": "npm:@fireproof/vendor@^1.0.0",
     "@ipld/unixfs": "npm:@ipld/unixfs@^3.0.0",
     "multiformats": "npm:multiformats@^13.3.1",
     "charwise": "npm:charwise@^3.0.1",
     "prolly-trees": "npm:prolly-trees@^1.0.4",
-    "idb": "npm:idb@^8.0.0",
-    "memfs": "npm:memfs@^4.15.0",
-    "p-limit": "npm:p-limit@^6.1.0",
+    "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"
   }

package/index.cjs

@@ -714,8 +714,8 @@ var init_gateway2 = __esm({
 });
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   CRDT: () => CRDT,
   Database: () => Database,
   Index: () => Index,
@@ -742,7 +742,7 @@ __export(src_exports, {
   runtime: () => runtime_exports,
   throwFalsy: () => throwFalsy
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/database.ts
 var import_cement16 = require("@adviser/cement");
@@ -3994,11 +3994,17 @@ var Database = class {
   static {
     this.databases = /* @__PURE__ */ new Map();
   }
+  /**
+   * Close the database and release resources
+   */
   async close() {
     await this.ready();
     await this._crdt.close();
     await this.blockstore.close();
   }
+  /**
+   * Destroy the database and release all resources
+   */
   async destroy() {
     await this.ready();
     await this._crdt.destroy();
@@ -4011,6 +4017,12 @@ var Database = class {
       await this.blockstore.ready();
     });
   }
+  /**
+   * Get a document from the database
+   * @param id - the document id
+   * @returns the document with the _id
+   * @throws NotFoundError if the document is not found
+   */
   async get(id) {
     if (!id) throw this.logger.Error().Str("db", this.name).Msg(`Doc id is required`).AsError();
     await this.ready();
@@ -4022,6 +4034,11 @@ var Database = class {
     const { doc } = got;
     return { ...doc, _id: id };
   }
+  /**
+   * Put a document from the database
+   * @param doc - the document to put
+   * @returns add DocResponse with the id and clock
+   */
   async put(doc) {
     await this.ready();
     this.logger.Debug().Str("id", doc._id).Msg("put");
@@ -4036,6 +4053,11 @@ var Database = class {
     });
     return { id: docId, clock: result?.head, name: this.name };
   }
+  /**
+   * delete a document from the database
+   * @param id Document id
+   * @returns DocResponse with the id and clock
+   */
   async del(id) {
     await this.ready();
     this.logger.Debug().Str("id", id).Msg("del");
@@ -4193,6 +4215,6 @@ init_utils();
 
 // src/version.ts
 var PACKAGE_VERSION = Object.keys({
-  "0.19.118": "xxxx"
+  "0.19.119": "xxxx"
 })[0];
 //# sourceMappingURL=index.cjs.map