@fireproof/core 0.5.18 → 0.5.19

package/dist/src/clock.js

@@ -78,7 +78,7 @@ export class EventBlock extends Block {
      * @param {Uint8Array} config.bytes
      */
     constructor({ cid, value, bytes }) {
-        // @ts-expect-error
+        // @ts-ignore
         super({ cid, value, bytes });
     }
     /**
@@ -129,7 +129,7 @@ export class EventFetcher {
 export async function encodeEventBlock(value) {
     // TODO: sort parents
     const { cid, bytes } = await encode({ value, codec: cbor, hasher: sha256 });
-    // @ts-expect-error
+    // @ts-ignore
     return new Block({ cid, value, bytes });
 }
 /**
@@ -139,7 +139,7 @@ export async function encodeEventBlock(value) {
  */
 export async function decodeEventBlock(bytes) {
     const { cid, value } = await decode({ bytes, codec: cbor, hasher: sha256 });
-    // @ts-expect-error
+    // @ts-ignore
     return new Block({ cid, value, bytes });
 }
 /**

package/dist/src/database.js

@@ -75,6 +75,17 @@ export class Database {
             localSet('fp.' + this.name, JSON.stringify(this));
         }
     }
+    index(name) {
+        // iterate over the indexes and gather any with the same name
+        // if there are more than one, throw an error
+        // if there is one, return it
+        // if there are none, return null
+        const indexes = [...this.indexes.values()].filter(index => index.name === name);
+        if (indexes.length > 1) {
+            throw new Error(`Multiple indexes found with name ${name}`);
+        }
+        return indexes[0] || null;
+    }
     /**
      * Triggers a notification to all listeners
      * of the Fireproof instance so they can repaint UI, etc.
@@ -215,12 +226,11 @@ export class Database {
         return doc;
     }
     /**
-     * @typedef {Object} Document
+     * @typedef {any} Document
      * @property {string} _id - The ID of the document (required)
      * @property {string} [_proof] - The proof of the document (optional)
      * @property {string} [_clock] - The clock of the document (optional)
-     * @property {any} [key: string] - Index signature notation to allow any other unknown fields
-     *  * @property {Object.<string, any>} [otherProperties] - Any other unknown properties (optional)
+     * @property {Object.<string, any>} [unknown: string] - Any other unknown properties (optional)
      */
     /**
      * Adds a new document to the database, or updates an existing document. Returns the ID of the document and the new clock head.

package/dist/src/fireproof.d.ts

@@ -236,6 +236,7 @@ declare class Database {
         indexCar: any;
     }): void;
     maybeSaveClock(): void;
+    index(name: any): any;
     /**
      * Triggers a notification to all listeners
      * of the Fireproof instance so they can repaint UI, etc.
@@ -290,12 +291,11 @@ declare class Database {
         _id: string;
     }>;
     /**
-     * @typedef {Object} Document
+     * @typedef {any} Document
      * @property {string} _id - The ID of the document (required)
      * @property {string} [_proof] - The proof of the document (optional)
      * @property {string} [_clock] - The clock of the document (optional)
-     * @property {any} [key: string] - Index signature notation to allow any other unknown fields
-     *  * @property {Object.<string, any>} [otherProperties] - Any other unknown properties (optional)
+     * @property {Object.<string, any>} [unknown: string] - Any other unknown properties (optional)
      */
     /**
      * Adds a new document to the database, or updates an existing document. Returns the ID of the document and the new clock head.
@@ -305,31 +305,7 @@ declare class Database {
      * @memberof Fireproof
      * @instance
      */
-    put({ _id, _proof, ...doc }: {
-        /**
-         * - The ID of the document (required)
-         */
-        _id: string;
-        /**
-         * - The proof of the document (optional)
-         */
-        _proof?: string;
-        /**
-         * - The clock of the document (optional)
-         */
-        _clock?: string;
-        /**
-         * : string] - Index signature notation to allow any other unknown fields
-         * *
-         */
-        key?: any;
-        /**
-         * - Any other unknown properties (optional)
-         */
-        otherProperties?: {
-            [x: string]: any;
-        };
-    }): Promise<{
+    put({ _id, _proof, ...doc }: any): Promise<{
         id: string;
         clock: CID[];
     }>;

package/dist/src/fireproof.js

@@ -5566,7 +5566,7 @@ class EventBlock extends Block {
    * @param {Uint8Array} config.bytes
    */
   constructor ({ cid, value, bytes }) {
-    // @ts-expect-error
+    // @ts-ignore
     super({ cid, value, bytes });
   }
 
@@ -5620,7 +5620,7 @@ class EventFetcher {
 async function encodeEventBlock (value) {
   // TODO: sort parents
   const { cid, bytes } = await encode$7({ value, codec: codec$1, hasher: sha256$2 });
-  // @ts-expect-error
+  // @ts-ignore
   return new Block({ cid, value, bytes })
 }
 
@@ -5631,7 +5631,7 @@ async function encodeEventBlock (value) {
  */
 async function decodeEventBlock (bytes) {
   const { cid, value } = await decode$9({ bytes, codec: codec$1, hasher: sha256$2 });
-  // @ts-expect-error
+  // @ts-ignore
   return new Block({ cid, value, bytes })
 }
 
@@ -41014,6 +41014,18 @@ class Database {
     }
   }
 
+  index (name) {
+    // iterate over the indexes and gather any with the same name
+    // if there are more than one, throw an error
+    // if there is one, return it
+    // if there are none, return null
+    const indexes = [...this.indexes.values()].filter(index => index.name === name);
+    if (indexes.length > 1) {
+      throw new Error(`Multiple indexes found with name ${name}`)
+    }
+    return indexes[0] || null
+  }
+
   /**
    * Triggers a notification to all listeners
    * of the Fireproof instance so they can repaint UI, etc.
@@ -41161,12 +41173,11 @@ class Database {
     return doc
   }
   /**
-   * @typedef {Object} Document
+   * @typedef {any} Document
    * @property {string} _id - The ID of the document (required)
    * @property {string} [_proof] - The proof of the document (optional)
    * @property {string} [_clock] - The clock of the document (optional)
-   * @property {any} [key: string] - Index signature notation to allow any other unknown fields
-   *  * @property {Object.<string, any>} [otherProperties] - Any other unknown properties (optional)
+   * @property {Object.<string, any>} [unknown: string] - Any other unknown properties (optional)
    */
 
   /**