@fireproof/core 0.19.119-dev-log → 0.19.120

package/index.d.cts

@@ -43,6 +43,7 @@ declare class CommitQueue<T = void> {
     processNext(): void;
 }
 
+declare function onSuperThis(fn: (sthis: SuperThis) => void): () => void;
 declare function ensureSuperThis(osthis?: Partial<SuperThisOpts>): SuperThis;
 declare function ensureSuperLog(sthis: SuperThis, componentName: string, ctx?: Record<string, unknown>): SuperThis;
 declare function ensureLogger(sthis: SuperThis, componentName: string, ctx?: Record<string, unknown>): Logger;
@@ -1137,5 +1138,5 @@ declare namespace index {
 
 declare const PACKAGE_VERSION: string;
 
-export { type AllDocsQueryOpts, type AllDocsResponse, CRDT, type CRDTEntry, type CRDTMeta, type ChangesOptions, type ChangesResponse, type ChangesResponseRow, type ClockHead, type ClockLink, type ConfigOpts, type Connectable, Database, type DocBase, type DocFileMeta, type DocFiles, type DocFragment, type DocLiteral, type DocObject, type DocRecord, type DocResponse, type DocSet, type DocTypes, type DocUpdate, type DocValue, type DocWithId, type Falsy, type FileTransactionMeta, type IdxMeta, type IdxMetaMap, Index, type IndexKey, type IndexKeyType, type IndexRow, type IndexRows, type IndexTransactionMeta, type IndexUpdate, type IndexUpdateString, type Joiner, type KeyLiteral, type ListenerFn, type MapFn, type MetaType, type NoUpdateListenerFn, NotFoundError, PACKAGE_VERSION, type PathOps, type QueryOpts, type Store, type StoreType, type SuperThis, type SuperThisOpts, type SysFileSystem, type TextEndeCoder, UInt8ArrayEqual, type UnknownDoc, type UpdateListenerFn, index$3 as blockstore, index$3 as bs, dataDir, ensureLogger, ensureSuperLog, ensureSuperThis, exceptionWrapper, falsyToUndef, fireproof, getKey, getName, getStore, index$2 as index, isFalsy, isNotFoundError, index as rt, index as runtime, throwFalsy };
+export { type AllDocsQueryOpts, type AllDocsResponse, CRDT, type CRDTEntry, type CRDTMeta, type ChangesOptions, type ChangesResponse, type ChangesResponseRow, type ClockHead, type ClockLink, type ConfigOpts, type Connectable, Database, type DocBase, type DocFileMeta, type DocFiles, type DocFragment, type DocLiteral, type DocObject, type DocRecord, type DocResponse, type DocSet, type DocTypes, type DocUpdate, type DocValue, type DocWithId, type Falsy, type FileTransactionMeta, type IdxMeta, type IdxMetaMap, Index, type IndexKey, type IndexKeyType, type IndexRow, type IndexRows, type IndexTransactionMeta, type IndexUpdate, type IndexUpdateString, type Joiner, type KeyLiteral, type ListenerFn, type MapFn, type MetaType, type NoUpdateListenerFn, NotFoundError, PACKAGE_VERSION, type PathOps, type QueryOpts, type Store, type StoreType, type SuperThis, type SuperThisOpts, type SysFileSystem, type TextEndeCoder, UInt8ArrayEqual, type UnknownDoc, type UpdateListenerFn, index$3 as blockstore, index$3 as bs, dataDir, ensureLogger, ensureSuperLog, ensureSuperThis, exceptionWrapper, falsyToUndef, fireproof, getKey, getName, getStore, index$2 as index, isFalsy, isNotFoundError, onSuperThis, index as rt, index as runtime, throwFalsy };
 declare module '@fireproof/core'

package/index.d.ts

@@ -43,6 +43,7 @@ declare class CommitQueue<T = void> {
     processNext(): void;
 }
 
+declare function onSuperThis(fn: (sthis: SuperThis) => void): () => void;
 declare function ensureSuperThis(osthis?: Partial<SuperThisOpts>): SuperThis;
 declare function ensureSuperLog(sthis: SuperThis, componentName: string, ctx?: Record<string, unknown>): SuperThis;
 declare function ensureLogger(sthis: SuperThis, componentName: string, ctx?: Record<string, unknown>): Logger;
@@ -1137,5 +1138,5 @@ declare namespace index {
 
 declare const PACKAGE_VERSION: string;
 
-export { type AllDocsQueryOpts, type AllDocsResponse, CRDT, type CRDTEntry, type CRDTMeta, type ChangesOptions, type ChangesResponse, type ChangesResponseRow, type ClockHead, type ClockLink, type ConfigOpts, type Connectable, Database, type DocBase, type DocFileMeta, type DocFiles, type DocFragment, type DocLiteral, type DocObject, type DocRecord, type DocResponse, type DocSet, type DocTypes, type DocUpdate, type DocValue, type DocWithId, type Falsy, type FileTransactionMeta, type IdxMeta, type IdxMetaMap, Index, type IndexKey, type IndexKeyType, type IndexRow, type IndexRows, type IndexTransactionMeta, type IndexUpdate, type IndexUpdateString, type Joiner, type KeyLiteral, type ListenerFn, type MapFn, type MetaType, type NoUpdateListenerFn, NotFoundError, PACKAGE_VERSION, type PathOps, type QueryOpts, type Store, type StoreType, type SuperThis, type SuperThisOpts, type SysFileSystem, type TextEndeCoder, UInt8ArrayEqual, type UnknownDoc, type UpdateListenerFn, index$3 as blockstore, index$3 as bs, dataDir, ensureLogger, ensureSuperLog, ensureSuperThis, exceptionWrapper, falsyToUndef, fireproof, getKey, getName, getStore, index$2 as index, isFalsy, isNotFoundError, index as rt, index as runtime, throwFalsy };
+export { type AllDocsQueryOpts, type AllDocsResponse, CRDT, type CRDTEntry, type CRDTMeta, type ChangesOptions, type ChangesResponse, type ChangesResponseRow, type ClockHead, type ClockLink, type ConfigOpts, type Connectable, Database, type DocBase, type DocFileMeta, type DocFiles, type DocFragment, type DocLiteral, type DocObject, type DocRecord, type DocResponse, type DocSet, type DocTypes, type DocUpdate, type DocValue, type DocWithId, type Falsy, type FileTransactionMeta, type IdxMeta, type IdxMetaMap, Index, type IndexKey, type IndexKeyType, type IndexRow, type IndexRows, type IndexTransactionMeta, type IndexUpdate, type IndexUpdateString, type Joiner, type KeyLiteral, type ListenerFn, type MapFn, type MetaType, type NoUpdateListenerFn, NotFoundError, PACKAGE_VERSION, type PathOps, type QueryOpts, type Store, type StoreType, type SuperThis, type SuperThisOpts, type SysFileSystem, type TextEndeCoder, UInt8ArrayEqual, type UnknownDoc, type UpdateListenerFn, index$3 as blockstore, index$3 as bs, dataDir, ensureLogger, ensureSuperLog, ensureSuperThis, exceptionWrapper, falsyToUndef, fireproof, getKey, getName, getStore, index$2 as index, isFalsy, isNotFoundError, onSuperThis, index as rt, index as runtime, throwFalsy };
 declare module '@fireproof/core'

package/index.js

@@ -5,7 +5,7 @@ import {
   getFileName,
   getFileSystem,
   getPath
-} from "./chunk-WVN66YAN.js";
+} from "./chunk-F4FC6B2T.js";
 import {
   NotFoundError,
   Result,
@@ -18,8 +18,9 @@ import {
   getKey,
   getName,
   getStore,
-  isNotFoundError
-} from "./chunk-2D2X6HIB.js";
+  isNotFoundError,
+  onSuperThis
+} from "./chunk-RXC4JGJT.js";
 import {
   __export
 } from "./chunk-PZ5AY32C.js";
@@ -683,14 +684,14 @@ var keyBagProviderFactories = new Map(
     {
       protocol: "file:",
       factory: async (url, sthis) => {
-        const { KeyBagProviderFile } = await import("./key-bag-file-CBCAWTVG.js");
+        const { KeyBagProviderFile } = await import("./key-bag-file-PWZ3QE7B.js");
         return new KeyBagProviderFile(url, sthis);
       }
     },
     {
       protocol: "indexdb:",
       factory: async (url, sthis) => {
-        const { KeyBagProviderIndexDB } = await import("./key-bag-indexdb-RTSMSGM7.js");
+        const { KeyBagProviderIndexDB } = await import("./key-bag-indexdb-SYG3YD4D.js");
         return new KeyBagProviderIndexDB(url, sthis);
       }
     }
@@ -2243,22 +2244,22 @@ function toStoreRuntime(opts, sthis) {
 registerStoreProtocol({
   protocol: "file:",
   gateway: async (sthis) => {
-    const { FileGateway } = await import("./gateway-2O7QPHGW.js");
+    const { FileGateway } = await import("./gateway-VVS4QWDA.js");
     return new FileGateway(sthis);
   },
   test: async (sthis) => {
-    const { FileTestStore } = await import("./gateway-2O7QPHGW.js");
+    const { FileTestStore } = await import("./gateway-VVS4QWDA.js");
     return new FileTestStore(sthis);
   }
 });
 registerStoreProtocol({
   protocol: "indexdb:",
   gateway: async (sthis) => {
-    const { IndexDBGateway } = await import("./gateway-G4CPXEQF.js");
+    const { IndexDBGateway } = await import("./gateway-C62S56GY.js");
     return new IndexDBGateway(sthis);
   },
   test: async (sthis) => {
-    const { IndexDBTestStore } = await import("./gateway-G4CPXEQF.js");
+    const { IndexDBTestStore } = await import("./gateway-C62S56GY.js");
     return new IndexDBTestStore(sthis);
   }
 });
@@ -3268,11 +3269,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();
@@ -3285,6 +3292,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();
@@ -3296,6 +3309,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");
@@ -3310,6 +3328,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");
@@ -3462,7 +3485,7 @@ var INDEXDB_VERSION = "v0.19-indexdb";
 
 // src/version.ts
 var PACKAGE_VERSION = Object.keys({
-  "0.19.119-dev-log": "xxxx"
+  "0.19.120": "xxxx"
 })[0];
 export {
   CRDT,
@@ -3487,6 +3510,7 @@ export {
   index,
   isFalsy,
   isNotFoundError,
+  onSuperThis,
   runtime_exports as rt,
   runtime_exports as runtime,
   throwFalsy