chain-db-ts 0.0.2 → 1.0.0-rc.2

package/features/table-doc.js

@@ -0,0 +1,129 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+import axios from 'axios';
+import { UPDATE_ITEM, GET_DOC } from './constants';
+import { post } from './utils';
+/**
+ * Implementation of TableDoc interface
+ * Represents a specific document from a table
+ */
+var TableDocImpl = /** @class */ (function () {
+    function TableDocImpl(tableName, doc_id, data, db) {
+        this.tableName = tableName;
+        this.doc_id = doc_id;
+        this.doc = data;
+        this.db = db;
+    }
+    /**
+     * Update the document data
+     * This will update the specific document without creating a new one
+     */
+    TableDocImpl.prototype.update = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var url, body, response, e_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        url = "".concat(this.db.server).concat(UPDATE_ITEM(this.tableName));
+                        body = {
+                            data: this.doc,
+                            doc_id: this.doc_id
+                        };
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, post(url, body, this.db.auth)];
+                    case 2:
+                        response = _a.sent();
+                        if (!response.data.success) {
+                            throw new Error(response.data.message);
+                        }
+                        return [3 /*break*/, 4];
+                    case 3:
+                        e_1 = _a.sent();
+                        throw new Error("Something went wrong updating document ".concat(this.doc_id, ": ").concat(e_1.message || String(e_1)));
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Refetch the document data from the database
+     * Useful when the document might have been updated by another application
+     */
+    TableDocImpl.prototype.refetch = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var url, response, e_2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        url = "".concat(this.db.server).concat(GET_DOC(this.tableName, this.doc_id));
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, axios.get(url, { headers: { Authorization: "Basic ".concat(this.db.auth) } })];
+                    case 2:
+                        response = _a.sent();
+                        if (!response.data.success) {
+                            throw new Error(response.data.message);
+                        }
+                        // Update the table data with the latest data from the database
+                        this.doc = response.data.data;
+                        return [3 /*break*/, 4];
+                    case 3:
+                        e_2 = _a.sent();
+                        throw new Error("Something went wrong refetching document ".concat(this.doc_id, ": ").concat(e_2.message || String(e_2)));
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Get the table name this document belongs to
+     */
+    TableDocImpl.prototype.getTableName = function () {
+        return this.tableName;
+    };
+    /**
+     * Check if the table is empty
+     */
+    TableDocImpl.prototype.isEmpty = function () {
+        return Object.keys(this.doc).length === 0;
+    };
+    return TableDocImpl;
+}());
+export { TableDocImpl };

package/features/table.d.ts

@@ -1,19 +1,91 @@
 import { ChainDB } from './chain-db';
+import { Criteria, CriteriaAdvanced, DocId, TableDoc } from './types';
 declare class Table<Model> {
-    table: Model;
-    private contract_id;
+    currentDoc: Model;
+    private name;
     private db;
-    constructor(table: Model, contract_id: string, db: ChainDB);
+    constructor(name: string, db: ChainDB);
     /**
-     * Persist table data on chain
+     * Persist table's document data changes
      */
-    persist(): Promise<void>;
+    persist(): Promise<DocId<Model>>;
     /**
      * Get the history of changes. A list of transactions from the most recent to the most old
      * in a range of depth
-     * @param depth
+     * @param limit
      */
-    getHistory(depth: number): Promise<Model[]>;
+    getHistory(limit: number): Promise<DocId<Model>[]>;
+    /**
+     * Refetch the table data
+     */
+    refetch(): Promise<void>;
+    /**
+     * Check if the table is empty
+     */
+    isEmpty(): boolean;
+    /**
+     * Get the table's name
+     */
+    getName(): string;
+    /**
+     * Find items in the table using basic criteria with exact matches
+     * @param criteria Object with fields and values to match exactly, e.g.: {age: 44, name: "john"}
+     * @param limit Maximum number of items to return (default: 1000)
+     * @param reverse If true, returns items in reverse order (default: true)
+     * @returns Array of found items matching the criteria
+     * @example
+     * // Find items where age is 44
+     * table.findWhere({
+     *   age: 44,
+     * })
+     *
+     * // Find items with multiple criteria
+     * table.findWhere({
+     *   age: 44,
+     *   name: "john",
+     *   active: true,
+     *   score: 100
+     * })
+     */
+    findWhere(criteria: Criteria<Model>, limit?: number, reverse?: boolean): Promise<DocId<Model>[]>;
+    /**
+     * Find items in the table using advanced criteria with operators
+     * @param criteria Array of criteria to filter items. Each criteria contains:
+     * - field: The field name to filter
+     * - operator: The operator to use in comparison. Available operators:
+     *   - Eq (==) Equal
+     *   - Ne (!=) Not Equal
+     *   - Gt (>) Greater Than
+     *   - Ge (>=) Greater Than or Equal
+     *   - Lt (<) Less Than
+     *   - Le (<=) Less Than or Equal
+     *   - Contains: Check if field contains value (for strings and arrays)
+     *   - StartsWith: Check if field starts with value (for strings)
+     *   - EndsWith: Check if field ends with value (for strings)
+     * - value: The value to compare against
+     * @param limit Maximum number of items to return (default: 1000)
+     * @param reverse If true, returns items in reverse order (default: true)
+     * @returns Array of found items matching the criteria
+     * @example
+     * // Find items where greeting contains "arg"
+     * table.findWhereAdvanced([
+     *   {
+     *     field: "greeting",
+     *     operator: Operators.Contains,
+     *     value: "hello"
+     *   }
+     * ])
+     */
+    findWhereAdvanced(criteria: CriteriaAdvanced<Model>[], limit?: number, reverse?: boolean): Promise<DocId<Model>[]>;
+    /**
+     * Get the current document ID
+     */
+    getCurrentDocId(): string;
+    /**
+     * Get a specific document by its ID
+     * @param doc_id The document ID to retrieve
+     * @returns A TableDoc instance with the specific document data
+     */
+    getDoc(doc_id: string): Promise<TableDoc<Model>>;
 }
-export declare const get: <Model>(db: ChainDB, table_name: string, model: Model) => Promise<Table<Model>>;
-export {};
+export default Table;

package/features/table.js

@@ -35,43 +35,42 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 import axios from 'axios';
-import { CONTRACT_PAYLOAD, CONTRACT_TRANSACTION, CONTRACT_TRANSACTIONS_PAYLOAD } from './constants';
-import { TransactionType } from './types';
+import { FIND_WHERE_ADVANCED, FIND_WHERE_BASIC, GET_HISTORY, GET_TABLE, PERSIST_NEW_DATA, GET_DOC } from './constants';
 import { post } from './utils';
+import { TableDocImpl } from './table-doc';
 var Table = /** @class */ (function () {
-    function Table(table, contract_id, db) {
-        this.contract_id = '';
-        this.table = table;
-        this.contract_id = contract_id;
+    function Table(name, db) {
+        this.name = '';
+        this.currentDoc = {};
+        this.name = name;
         this.db = db;
     }
     /**
-     * Persist table data on chain
+     * Persist table's document data changes
      */
     Table.prototype.persist = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var url, contract_data, body, _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
+            var url, body, response, e_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
                     case 0:
-                        url = "".concat(this.db.api).concat(CONTRACT_TRANSACTION);
-                        contract_data = JSON.stringify(this.table);
+                        url = "".concat(this.db.server).concat(PERSIST_NEW_DATA(this.name));
                         body = {
-                            tx_type: TransactionType.CONTRACT,
-                            contract_id: this.contract_id,
-                            db_access_key: this.db.access_key,
-                            data: contract_data
+                            data: this.currentDoc
                         };
-                        _b.label = 1;
+                        _a.label = 1;
                     case 1:
-                        _b.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, post(url, body)];
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, post(url, body, this.db.auth)];
                     case 2:
-                        _b.sent();
-                        return [3 /*break*/, 4];
+                        response = _a.sent();
+                        if (!response.data.success) {
+                            throw new Error(response.data.message);
+                        }
+                        return [2 /*return*/, response.data.data];
                     case 3:
-                        _a = _b.sent();
-                        throw new Error('Something went wrong!');
+                        e_1 = _a.sent();
+                        throw new Error("Something went wrong with persist operation: ".concat(e_1.message || String(e_1)));
                     case 4: return [2 /*return*/];
                 }
             });
@@ -80,32 +79,218 @@ var Table = /** @class */ (function () {
     /**
      * Get the history of changes. A list of transactions from the most recent to the most old
      * in a range of depth
-     * @param depth
+     * @param limit
      */
-    Table.prototype.getHistory = function (depth) {
+    Table.prototype.getHistory = function (limit) {
         return __awaiter(this, void 0, void 0, function () {
-            var url, contract_response, contract_data_json_list, transaction_data, _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
+            var url, response, e_2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
                     case 0:
-                        url = "".concat(this.db.api).concat(CONTRACT_TRANSACTIONS_PAYLOAD, "/").concat(this.contract_id, "/").concat(this.db.access_key, "/").concat(depth);
-                        _b.label = 1;
+                        url = "".concat(this.db.server).concat(GET_HISTORY(this.name, limit));
+                        _a.label = 1;
                     case 1:
-                        _b.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, axios.get(url)];
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, axios.get(url, { headers: { Authorization: "Basic ".concat(this.db.auth) } })];
                     case 2:
-                        contract_response = _b.sent();
-                        contract_data_json_list = contract_response.data;
-                        transaction_data = contract_data_json_list.map(function (transaction) { return transaction.data; });
-                        // Return empty if theres no data
-                        if (contract_data_json_list.length === 1 && contract_data_json_list[0].tx_type === TransactionType.NONE) {
-                            return [2 /*return*/, []];
+                        response = _a.sent();
+                        if (!response.data.success) {
+                            throw new Error(response.data.message);
                         }
                         // Return data. Only table fields, e.g.: [{fieldA: 'Hi', filedB: 22}]
-                        return [2 /*return*/, transaction_data];
+                        return [2 /*return*/, response.data.data];
+                    case 3:
+                        e_2 = _a.sent();
+                        throw new Error("Something went wrong with getHistory operation: ".concat(e_2.message || String(e_2)));
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Refetch the table data
+     */
+    Table.prototype.refetch = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var url, response, e_3;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        url = "".concat(this.db.server).concat(GET_TABLE(this.name));
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, axios.get(url, { headers: { Authorization: "Basic ".concat(this.db.auth) } })];
+                    case 2:
+                        response = _a.sent();
+                        this.currentDoc = response.data.data ? response.data.data : {};
+                        return [3 /*break*/, 4];
                     case 3:
-                        _a = _b.sent();
-                        throw new Error('Something went wrong!');
+                        e_3 = _a.sent();
+                        throw new Error("Something went wrong with refetch operation: ".concat(e_3.message || String(e_3)));
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Check if the table is empty
+     */
+    Table.prototype.isEmpty = function () {
+        return Object.keys(this.currentDoc).length === 0;
+    };
+    /**
+     * Get the table's name
+     */
+    Table.prototype.getName = function () {
+        return this.name;
+    };
+    /**
+     * Find items in the table using basic criteria with exact matches
+     * @param criteria Object with fields and values to match exactly, e.g.: {age: 44, name: "john"}
+     * @param limit Maximum number of items to return (default: 1000)
+     * @param reverse If true, returns items in reverse order (default: true)
+     * @returns Array of found items matching the criteria
+     * @example
+     * // Find items where age is 44
+     * table.findWhere({
+     *   age: 44,
+     * })
+     *
+     * // Find items with multiple criteria
+     * table.findWhere({
+     *   age: 44,
+     *   name: "john",
+     *   active: true,
+     *   score: 100
+     * })
+     */
+    Table.prototype.findWhere = function (criteria, limit, reverse) {
+        if (limit === void 0) { limit = 1000; }
+        if (reverse === void 0) { reverse = true; }
+        return __awaiter(this, void 0, void 0, function () {
+            var url, body, response, e_4;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        url = "".concat(this.db.server).concat(FIND_WHERE_BASIC(this.name));
+                        body = {
+                            criteria: criteria,
+                            limit: limit,
+                            reverse: reverse
+                        };
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, post(url, body, this.db.auth)];
+                    case 2:
+                        response = _a.sent();
+                        if (!response.data.success) {
+                            throw new Error(response.data.message);
+                        }
+                        // Return found data. Only table fields, e.g.: [{fieldA: 'Hi', filedB: 22}]
+                        return [2 /*return*/, response.data.data];
+                    case 3:
+                        e_4 = _a.sent();
+                        throw new Error("Something went wrong with findWhere operation: ".concat(e_4.message || String(e_4)));
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Find items in the table using advanced criteria with operators
+     * @param criteria Array of criteria to filter items. Each criteria contains:
+     * - field: The field name to filter
+     * - operator: The operator to use in comparison. Available operators:
+     *   - Eq (==) Equal
+     *   - Ne (!=) Not Equal
+     *   - Gt (>) Greater Than
+     *   - Ge (>=) Greater Than or Equal
+     *   - Lt (<) Less Than
+     *   - Le (<=) Less Than or Equal
+     *   - Contains: Check if field contains value (for strings and arrays)
+     *   - StartsWith: Check if field starts with value (for strings)
+     *   - EndsWith: Check if field ends with value (for strings)
+     * - value: The value to compare against
+     * @param limit Maximum number of items to return (default: 1000)
+     * @param reverse If true, returns items in reverse order (default: true)
+     * @returns Array of found items matching the criteria
+     * @example
+     * // Find items where greeting contains "arg"
+     * table.findWhereAdvanced([
+     *   {
+     *     field: "greeting",
+     *     operator: Operators.Contains,
+     *     value: "hello"
+     *   }
+     * ])
+     */
+    Table.prototype.findWhereAdvanced = function (criteria, limit, reverse) {
+        if (limit === void 0) { limit = 1000; }
+        if (reverse === void 0) { reverse = true; }
+        return __awaiter(this, void 0, void 0, function () {
+            var url, body, response, e_5;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        url = "".concat(this.db.server).concat(FIND_WHERE_ADVANCED(this.name));
+                        body = {
+                            criteria: criteria,
+                            limit: limit,
+                            reverse: reverse
+                        };
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, post(url, body, this.db.auth)];
+                    case 2:
+                        response = _a.sent();
+                        if (!response.data.success) {
+                            throw new Error(response.data.message);
+                        }
+                        // Return found data. Only table fields, e.g.: [{fieldA: 'Hi', filedB: 22}]
+                        return [2 /*return*/, response.data.data];
+                    case 3:
+                        e_5 = _a.sent();
+                        throw new Error("Something went wrong with findWhereAdvanced operation: ".concat(e_5.message || String(e_5)));
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Get the current document ID
+     */
+    Table.prototype.getCurrentDocId = function () {
+        return this.currentDoc.doc_id;
+    };
+    /**
+     * Get a specific document by its ID
+     * @param doc_id The document ID to retrieve
+     * @returns A TableDoc instance with the specific document data
+     */
+    Table.prototype.getDoc = function (doc_id) {
+        return __awaiter(this, void 0, void 0, function () {
+            var url, response, e_6;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        url = "".concat(this.db.server).concat(GET_DOC(this.name, doc_id));
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, axios.get(url, { headers: { Authorization: "Basic ".concat(this.db.auth) } })];
+                    case 2:
+                        response = _a.sent();
+                        if (!response.data.success) {
+                            throw new Error(response.data.message);
+                        }
+                        // Create a TableDoc instance with the document data
+                        return [2 /*return*/, new TableDocImpl(this.name, doc_id, response.data.data, this.db)];
+                    case 3:
+                        e_6 = _a.sent();
+                        throw new Error("Something went wrong with getDoc operation: ".concat(e_6.message || String(e_6)));
                     case 4: return [2 /*return*/];
                 }
             });
@@ -113,31 +298,4 @@ var Table = /** @class */ (function () {
     };
     return Table;
 }());
-export var get = function (db, table_name, model) { return __awaiter(void 0, void 0, void 0, function () {
-    var contract_id, url, contract_response, contract_data_json, table_1, table, _a;
-    return __generator(this, function (_b) {
-        switch (_b.label) {
-            case 0:
-                contract_id = db.access.parse(db.name, table_name);
-                url = "".concat(db.api).concat(CONTRACT_PAYLOAD, "/").concat(contract_id, "/").concat(db.access_key);
-                _b.label = 1;
-            case 1:
-                _b.trys.push([1, 3, , 4]);
-                return [4 /*yield*/, axios.get(url)];
-            case 2:
-                contract_response = _b.sent();
-                contract_data_json = contract_response.data;
-                // If there's already a table (contract) with data, then, fetch its data
-                if (contract_data_json.tx_type === TransactionType.CONTRACT) {
-                    table_1 = new Table(contract_data_json.data, contract_id, db);
-                    return [2 /*return*/, table_1];
-                }
-                table = new Table(model, contract_id, db);
-                return [2 /*return*/, table];
-            case 3:
-                _a = _b.sent();
-                throw new Error('Something went wrong!');
-            case 4: return [2 /*return*/];
-        }
-    });
-}); };
+export default Table;

package/features/types.d.ts

@@ -1,29 +1,87 @@
 export type BasicResponse<D> = {
     success: boolean;
-    error_msg: string;
+    message: string;
     data?: D;
 };
-export type SignedUserAccount = {
-    id: string;
-    user_name: string;
-    units: number;
+export type Connection = {
+    server: string | null;
+    database: string;
+    user: string;
+    password: string;
 };
-export type TransferUnitsRegistry = {
-    from: string;
-    to: string;
-    units: number;
+export type Criteria<Model> = Partial<Record<keyof Model, string | number | boolean>>;
+export type CriteriaAdvanced<Model> = {
+    field: Partial<keyof Model>;
+    /**
+     * @see Operators
+     */
+    operator: string;
+    value: string | number | boolean;
 };
-export declare enum TransactionType {
-    NONE = "NONE",
-    ACCOUNT = "ACCOUNT",
-    CONTRACT = "CONTRACT",
-    TRANSFER = "TRANSFER"
+/**
+ * Operators for the advanced criteria
+ * @see https://docs.chaindb.com/docs/query-language/ (TODO)
+ */
+export declare const Operators: {
+    EQUAL: string;
+    NOT_EQUAL: string;
+    GREATER_THAN: string;
+    GREATER_THAN_OR_EQUAL: string;
+    LESS_THAN: string;
+    LESS_THAN_OR_EQUAL: string;
+    CONTAINS: string;
+    STARTS_WITH: string;
+    ENDS_WITH: string;
+};
+export declare const EventTypes: {
+    TABLE_PERSIST: string;
+    TABLE_UPDATE: string;
+};
+export type EventData = {
+    event_type: string;
+    database: string;
+    table: string;
+    /**
+     * Data of the event (also to/from the table)
+     */
+    data: Record<string, any>;
+    /**
+     * Timestamp of the event
+     */
+    timestamp: number;
+};
+export type EventCallback = (data: EventData) => void;
+/**
+ * Represents a specific document from a table
+ * Contains only the necessary methods to work with a specific document
+ */
+export interface TableDoc<Model> {
+    /**
+     * The document data
+     */
+    doc: DocId<Model>;
+    /**
+     * Update the document data
+     * This will update the specific document without creating a new one
+     */
+    update(): Promise<void>;
+    /**
+     * Get the table name this document belongs to
+     */
+    getTableName(): string;
+    /**
+     * Refetch the document data from the database
+     * Useful when the document might have been updated by another application
+     */
+    refetch(): Promise<void>;
+    /**
+     * Check if the document is empty
+     */
+    isEmpty(): boolean;
 }
-export type ContractTransactionData<Model> = {
-    tx_type: TransactionType;
-    contract_id: string;
-    timestamp?: number;
-    data: Model;
-    block_hash: string;
-    block_height: number;
+export type DocId<Model> = Model & {
+    /**
+     * The document ID (unique identifier). Immutable.
+     */
+    readonly doc_id: string;
 };