chain-db-ts 1.0.0-rc.1 → 1.0.0-rc.3

package/CHANGELOG.md

@@ -0,0 +1,116 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.0.0-rc.3] - 2025-03-11
+
+### Changed
+
+- Added support to older version while using the `getCurrentDocId()` method.
+
+## [1.0.0-rc.2] - 2025-03-05
+
+### Added
+
+- New `TableDoc` interface for working with specific documents
+- Added `refetch()` method to `TableDoc` to get the latest document data
+- Added `getTableName()` method to `TableDoc` to get the table name
+- Added `isEmpty()` method to `TableDoc` to check if the document is empty
+- Added `DocId<Model>` type that adds a readonly `doc_id` property to models
+- Added `getCurrentDocId()` method to `Table` to get the current document ID
+- The `persist()` method now returns the created document with its `doc_id`
+- Document IDs are now accessible directly via `doc_id` property in both `Table` and `TableDoc` instances
+
+### Changed
+
+- **BREAKING CHANGE**: Renamed `table` property to `currentDoc` in `Table` class for better semantics
+- Improved error messages with more details about the operation and error
+- Enhanced type safety with the `DocId<Model>` type
+
+### Removed
+
+- **BREAKING CHANGE**: Removed `update()` method from `Table` class
+  - To update documents, you must now use `getDoc()` to get a document reference and then call `update()` on that reference
+  - This change prevents accidental creation of duplicate records and makes the API more intuitive
+
+### Migration Guide
+
+#### Property Renaming
+
+Before:
+
+```typescript
+// Accessing table data
+console.log(greetingTable.table)
+
+// Accessing document data from TableDoc
+console.log(specificDoc.table)
+```
+
+After:
+
+```typescript
+// Accessing current document data from Table
+console.log(greetingTable.currentDoc)
+
+// Accessing document data from TableDoc
+console.log(specificDoc.doc)
+```
+
+#### Updating Documents
+
+Before:
+
+```typescript
+// Update the last item
+greetingTable.table.greeting = 'Updated greeting'
+await greetingTable.update()
+
+// Update a specific document by ID
+greetingTable.table.greeting = 'Updated specific document'
+await greetingTable.update('550e8400-e29b-41d4-a716-446655440000')
+```
+
+After:
+
+```typescript
+// Get a specific document by ID
+const specificDoc = await greetingTable.getDoc('550e8400-e29b-41d4-a716-446655440000')
+
+// Update the document
+specificDoc.doc.greeting = 'Updated greeting'
+await specificDoc.update()
+
+// Optionally, refetch the document to get the latest data
+await specificDoc.refetch()
+```
+
+#### Accessing Document IDs
+
+New in this version:
+
+```typescript
+// When persisting data, you get the document ID in the result
+const result = await greetingTable.persist()
+console.log(result.doc_id) // The ID of the newly created document
+
+// You can also get the current document ID directly from the table
+const currentDocId = greetingTable.getCurrentDocId()
+
+// When working with a specific document, the ID is available in multiple ways
+const specificDoc = await greetingTable.getDoc(docId)
+console.log(specificDoc.doc_id) // From the TableDoc instance
+console.log(specificDoc.doc.doc_id) // From the document object
+```
+
+## [1.0.0-rc.1] - 2025-03-01
+
+Initial release candidate.
+
+### Added
+
+- Type-safe API with TypeScript generics
+- Promise-based API with async/await
+- WebSocket support for real-time updates
+- Advanced query capabilities
+- Complete history access

package/dist/cjs/features/constants.d.ts

@@ -2,9 +2,10 @@ export declare const DEFAULT_API_SERVER = "http://localhost:2818";
 export declare const API_BASE = "/api/v1";
 export declare const CONNECT: string;
 export declare const GET_TABLE: (table: string) => string;
-export declare const UPDATE_LAST_ITEM: (table: string) => string;
+export declare const UPDATE_ITEM: (table: string) => string;
 export declare const PERSIST_NEW_DATA: (table: string) => string;
 export declare const GET_HISTORY: (table: string, limit?: number) => string;
 export declare const FIND_WHERE_BASIC: (table: string) => string;
 export declare const FIND_WHERE_ADVANCED: (table: string) => string;
+export declare const GET_DOC: (table: string, doc_id: string) => string;
 export declare const WEB_SOCKET_EVENTS: string;

package/dist/cjs/features/constants.js

@@ -1,14 +1,14 @@
 "use strict";
 exports.__esModule = true;
-exports.WEB_SOCKET_EVENTS = exports.FIND_WHERE_ADVANCED = exports.FIND_WHERE_BASIC = exports.GET_HISTORY = exports.PERSIST_NEW_DATA = exports.UPDATE_LAST_ITEM = exports.GET_TABLE = exports.CONNECT = exports.API_BASE = exports.DEFAULT_API_SERVER = void 0;
+exports.WEB_SOCKET_EVENTS = exports.GET_DOC = exports.FIND_WHERE_ADVANCED = exports.FIND_WHERE_BASIC = exports.GET_HISTORY = exports.PERSIST_NEW_DATA = exports.UPDATE_ITEM = exports.GET_TABLE = exports.CONNECT = exports.API_BASE = exports.DEFAULT_API_SERVER = void 0;
 // Contants
 exports.DEFAULT_API_SERVER = 'http://localhost:2818';
 exports.API_BASE = '/api/v1';
 exports.CONNECT = "".concat(exports.API_BASE, "/database/connect");
 var GET_TABLE = function (table) { return "".concat(exports.API_BASE, "/table/").concat(table); };
 exports.GET_TABLE = GET_TABLE;
-var UPDATE_LAST_ITEM = function (table) { return "".concat(exports.API_BASE, "/table/").concat(table, "/update"); };
-exports.UPDATE_LAST_ITEM = UPDATE_LAST_ITEM;
+var UPDATE_ITEM = function (table) { return "".concat(exports.API_BASE, "/table/").concat(table, "/update"); };
+exports.UPDATE_ITEM = UPDATE_ITEM;
 var PERSIST_NEW_DATA = function (table) { return "".concat(exports.API_BASE, "/table/").concat(table, "/persist"); };
 exports.PERSIST_NEW_DATA = PERSIST_NEW_DATA;
 var GET_HISTORY = function (table, limit) {
@@ -20,4 +20,6 @@ var FIND_WHERE_BASIC = function (table) { return "".concat(exports.API_BASE, "/t
 exports.FIND_WHERE_BASIC = FIND_WHERE_BASIC;
 var FIND_WHERE_ADVANCED = function (table) { return "".concat(exports.API_BASE, "/table/").concat(table, "/find-advanced"); };
 exports.FIND_WHERE_ADVANCED = FIND_WHERE_ADVANCED;
+var GET_DOC = function (table, doc_id) { return "".concat(exports.API_BASE, "/table/").concat(table, "/doc/").concat(doc_id); };
+exports.GET_DOC = GET_DOC;
 exports.WEB_SOCKET_EVENTS = "".concat(exports.API_BASE, "/events");

package/dist/cjs/features/table-doc.d.ts

@@ -0,0 +1,37 @@
+import { ChainDB } from './chain-db';
+import { DocId, TableDoc } from './types';
+/**
+ * Implementation of TableDoc interface
+ * Represents a specific document from a table
+ */
+export declare class TableDocImpl<Model> implements TableDoc<Model> {
+    /**
+     * The document data
+     */
+    doc: DocId<Model>;
+    /**
+     * The document ID
+     */
+    private doc_id;
+    private tableName;
+    private db;
+    constructor(tableName: string, doc_id: string, data: DocId<Model>, db: ChainDB);
+    /**
+     * Update the document data
+     * This will update the specific document without creating a new one
+     */
+    update(): Promise<void>;
+    /**
+     * Refetch the document data from the database
+     * Useful when the document might have been updated by another application
+     */
+    refetch(): Promise<void>;
+    /**
+     * Get the table name this document belongs to
+     */
+    getTableName(): string;
+    /**
+     * Check if the table is empty
+     */
+    isEmpty(): boolean;
+}

package/dist/cjs/features/table-doc.js

@@ -0,0 +1,135 @@
+"use strict";
+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 };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+exports.TableDocImpl = void 0;
+var axios_1 = __importDefault(require("axios"));
+var constants_1 = require("./constants");
+var utils_1 = require("./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((0, constants_1.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*/, (0, utils_1.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((0, constants_1.GET_DOC)(this.tableName, this.doc_id));
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, axios_1["default"].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;
+}());
+exports.TableDocImpl = TableDocImpl;

package/dist/cjs/features/table.d.ts

@@ -1,25 +1,23 @@
 import { ChainDB } from './chain-db';
-import { Criteria, CriteriaAdvanced } from './types';
+import { Criteria, CriteriaAdvanced, DocId, TableDoc } from './types';
 declare class Table<Model> {
-    table: Model;
+    /**
+     * The current document data
+     */
+    currentDoc: Model;
     private name;
     private db;
     constructor(name: string, db: ChainDB);
     /**
-     * Persist table data changes
-     */
-    persist(): Promise<void>;
-    /**
-     * Update data of the last table's item (or create a new item if there is none).
-     * This ensures that no new item is created.
+     * Persist table's document data changes
      */
-    update(): 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 limit
      */
-    getHistory(limit: number): Promise<Model[]>;
+    getHistory(limit: number): Promise<DocId<Model>[]>;
     /**
      * Refetch the table data
      */
@@ -52,7 +50,7 @@ declare class Table<Model> {
      *   score: 100
      * })
      */
-    findWhere(criteria: Criteria<Model>, limit?: number, reverse?: boolean): Promise<Model[]>;
+    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:
@@ -81,6 +79,16 @@ declare class Table<Model> {
      *   }
      * ])
      */
-    findWhereAdvanced(criteria: CriteriaAdvanced<Model>[], limit?: number, reverse?: boolean): Promise<Model[]>;
+    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 default Table;

package/dist/cjs/features/table.js

@@ -42,15 +42,16 @@ exports.__esModule = true;
 var axios_1 = __importDefault(require("axios"));
 var constants_1 = require("./constants");
 var utils_1 = require("./utils");
+var table_doc_1 = require("./table-doc");
 var Table = /** @class */ (function () {
     function Table(name, db) {
         this.name = '';
-        this.table = {};
+        this.currentDoc = {};
         this.name = name;
         this.db = db;
     }
     /**
-     * Persist table data changes
+     * Persist table's document data changes
      */
     Table.prototype.persist = function () {
         return __awaiter(this, void 0, void 0, function () {
@@ -60,7 +61,7 @@ var Table = /** @class */ (function () {
                     case 0:
                         url = "".concat(this.db.server).concat((0, constants_1.PERSIST_NEW_DATA)(this.name));
                         body = {
-                            data: this.table
+                            data: this.currentDoc
                         };
                         _a.label = 1;
                     case 1:
@@ -71,7 +72,7 @@ var Table = /** @class */ (function () {
                         if (!response.data.success) {
                             throw new Error(response.data.message);
                         }
-                        return [3 /*break*/, 4];
+                        return [2 /*return*/, response.data.data];
                     case 3:
                         e_1 = _a.sent();
                         throw new Error("Something went wrong with persist operation: ".concat(e_1.message || String(e_1)));
@@ -80,38 +81,6 @@ var Table = /** @class */ (function () {
             });
         });
     };
-    /**
-     * Update data of the last table's item (or create a new item if there is none).
-     * This ensures that no new item is created.
-     */
-    Table.prototype.update = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            var url, body, response, e_2;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        url = "".concat(this.db.server).concat((0, constants_1.UPDATE_LAST_ITEM)(this.name));
-                        body = {
-                            data: this.table
-                        };
-                        _a.label = 1;
-                    case 1:
-                        _a.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, (0, utils_1.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_2 = _a.sent();
-                        throw new Error("Something went wrong with update operation: ".concat(e_2.message || String(e_2)));
-                    case 4: return [2 /*return*/];
-                }
-            });
-        });
-    };
     /**
      * Get the history of changes. A list of transactions from the most recent to the most old
      * in a range of depth
@@ -119,7 +88,7 @@ var Table = /** @class */ (function () {
      */
     Table.prototype.getHistory = function (limit) {
         return __awaiter(this, void 0, void 0, function () {
-            var url, response, e_3;
+            var url, response, e_2;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -136,8 +105,8 @@ var Table = /** @class */ (function () {
                         // Return data. Only table fields, e.g.: [{fieldA: 'Hi', filedB: 22}]
                         return [2 /*return*/, response.data.data];
                     case 3:
-                        e_3 = _a.sent();
-                        throw new Error("Something went wrong with getHistory operation: ".concat(e_3.message || String(e_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*/];
                 }
             });
@@ -148,7 +117,7 @@ var Table = /** @class */ (function () {
      */
     Table.prototype.refetch = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var url, response, e_4;
+            var url, response, e_3;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -159,11 +128,11 @@ var Table = /** @class */ (function () {
                         return [4 /*yield*/, axios_1["default"].get(url, { headers: { Authorization: "Basic ".concat(this.db.auth) } })];
                     case 2:
                         response = _a.sent();
-                        this.table = response.data.data ? response.data.data : {};
+                        this.currentDoc = response.data.data ? response.data.data : {};
                         return [3 /*break*/, 4];
                     case 3:
-                        e_4 = _a.sent();
-                        throw new Error("Something went wrong with refetch operation: ".concat(e_4.message || String(e_4)));
+                        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*/];
                 }
             });
@@ -173,7 +142,7 @@ var Table = /** @class */ (function () {
      * Check if the table is empty
      */
     Table.prototype.isEmpty = function () {
-        return Object.keys(this.table).length === 0;
+        return Object.keys(this.currentDoc).length === 0;
     };
     /**
      * Get the table's name
@@ -205,7 +174,7 @@ var Table = /** @class */ (function () {
         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;
+            var url, body, response, e_4;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -227,14 +196,13 @@ var Table = /** @class */ (function () {
                         // 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 findWhere operation: ".concat(e_5.message || String(e_5)));
+                        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*/];
                 }
             });
         });
     };
-    // TODO: Implement documentation
     /**
      * Find items in the table using advanced criteria with operators
      * @param criteria Array of criteria to filter items. Each criteria contains:
@@ -267,7 +235,7 @@ var Table = /** @class */ (function () {
         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_6;
+            var url, body, response, e_5;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -288,9 +256,48 @@ var Table = /** @class */ (function () {
                         }
                         // 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 () {
+        var _doc = this.currentDoc;
+        // Support to applications using older versions
+        return _doc.doc_id ? _doc.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((0, constants_1.GET_DOC)(this.name, doc_id));
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, axios_1["default"].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 table_doc_1.TableDocImpl(this.name, doc_id, response.data.data, this.db)];
                     case 3:
                         e_6 = _a.sent();
-                        throw new Error("Something went wrong with findWhereAdvanced operation: ".concat(e_6.message || String(e_6)));
+                        throw new Error("Something went wrong with getDoc operation: ".concat(e_6.message || String(e_6)));
                     case 4: return [2 /*return*/];
                 }
             });

package/dist/cjs/features/types.d.ts

@@ -51,3 +51,37 @@ export type EventData = {
     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 DocId<Model> = Model & {
+    /**
+     * The document ID (unique identifier). Immutable.
+     */
+    readonly doc_id: string;
+};

package/dist/cjs/index.d.ts

@@ -1,2 +1,4 @@
 export { ChainDB, connect } from './features/chain-db';
-export { BasicResponse, Operators, CriteriaAdvanced, Criteria, EventTypes, EventData, EventCallback, } from './features/types';
+export { BasicResponse, Operators, CriteriaAdvanced, Criteria, TableDoc, EventTypes, EventData, EventCallback, } from './features/types';
+export { default as Events } from './features/events';
+export { TableDocImpl } from './features/table-doc';

package/dist/cjs/index.js

@@ -11,10 +11,14 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     o[k2] = m[k];
 }));
 exports.__esModule = true;
-exports.EventTypes = exports.Operators = exports.connect = exports.ChainDB = void 0;
+exports.TableDocImpl = exports.Events = exports.EventTypes = exports.Operators = exports.connect = exports.ChainDB = void 0;
 var chain_db_1 = require("./features/chain-db");
 __createBinding(exports, chain_db_1, "ChainDB");
 __createBinding(exports, chain_db_1, "connect");
 var types_1 = require("./features/types");
 __createBinding(exports, types_1, "Operators");
 __createBinding(exports, types_1, "EventTypes");
+var events_1 = require("./features/events");
+__createBinding(exports, events_1, "default", "Events");
+var table_doc_1 = require("./features/table-doc");
+__createBinding(exports, table_doc_1, "TableDocImpl");

package/features/constants.d.ts

@@ -2,9 +2,10 @@ export declare const DEFAULT_API_SERVER = "http://localhost:2818";
 export declare const API_BASE = "/api/v1";
 export declare const CONNECT: string;
 export declare const GET_TABLE: (table: string) => string;
-export declare const UPDATE_LAST_ITEM: (table: string) => string;
+export declare const UPDATE_ITEM: (table: string) => string;
 export declare const PERSIST_NEW_DATA: (table: string) => string;
 export declare const GET_HISTORY: (table: string, limit?: number) => string;
 export declare const FIND_WHERE_BASIC: (table: string) => string;
 export declare const FIND_WHERE_ADVANCED: (table: string) => string;
+export declare const GET_DOC: (table: string, doc_id: string) => string;
 export declare const WEB_SOCKET_EVENTS: string;