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

package/dist/cjs/features/constants.js

@@ -1,15 +1,25 @@
 "use strict";
 exports.__esModule = true;
-exports.CHECK_USER_NAME = exports.GET_ALL_TRANSFER_BY_USER_ID = exports.GET_TRANSFER_BY_USER_ID = exports.TRANSFER_UNITS = exports.GET_USER_ACCOUNT_BY_ID = exports.GET_USER_ACCOUNT = exports.CREATE_USER_ACCOUNT = exports.CONTRACT_TRANSACTION = exports.CONTRACT_TRANSACTIONS_PAYLOAD = exports.CONTRACT_PAYLOAD = exports.API = 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.API = 'http://localhost:2818';
-exports.CONTRACT_PAYLOAD = '/get_last_contract_transaction';
-exports.CONTRACT_TRANSACTIONS_PAYLOAD = '/get_contract_transactions';
-exports.CONTRACT_TRANSACTION = '/post_contract_transaction';
-exports.CREATE_USER_ACCOUNT = '/create_user_account';
-exports.GET_USER_ACCOUNT = '/get_user_account';
-exports.GET_USER_ACCOUNT_BY_ID = '/get_user_account_by_id';
-exports.TRANSFER_UNITS = '/transfer_units';
-exports.GET_TRANSFER_BY_USER_ID = '/get_transfer_by_user_id';
-exports.GET_ALL_TRANSFER_BY_USER_ID = '/get_all_transfers_by_user_id';
-exports.CHECK_USER_NAME = '/check_user_name';
+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_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) {
+    if (limit === void 0) { limit = 25; }
+    return "".concat(exports.API_BASE, "/table/").concat(table, "/history?limit=").concat(limit);
+};
+exports.GET_HISTORY = GET_HISTORY;
+var FIND_WHERE_BASIC = function (table) { return "".concat(exports.API_BASE, "/table/").concat(table, "/find"); };
+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/events.d.ts

@@ -0,0 +1,28 @@
+type EventCallback = (data: any) => void;
+declare class Events {
+    private socket;
+    private eventListeners;
+    private connected;
+    constructor(url: string, auth: string);
+    /**
+     * Subscribe to an event
+     * @param event Event name to subscribe to
+     * @param callback Function to call when the event is received
+     */
+    subscribe(event: string, callback: EventCallback): void;
+    /**
+     * Unsubscribe from an event
+     * @param event Event name to unsubscribe from
+     * @param callback Optional callback to remove. If not provided, all callbacks for the event will be removed.
+     */
+    unsubscribe(event: string, callback?: EventCallback): void;
+    /**
+     * Close the WebSocket connection
+     */
+    close(): void;
+    /**
+     * Check if the WebSocket connection is established
+     */
+    isConnected(): boolean;
+}
+export default Events;

package/dist/cjs/features/events.js

@@ -0,0 +1,89 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var ws_1 = __importDefault(require("ws"));
+var Events = /** @class */ (function () {
+    function Events(url, auth) {
+        var _this = this;
+        this.eventListeners = new Map();
+        this.connected = false;
+        this.socket = new ws_1["default"](url, {
+            headers: {
+                Authorization: "Basic ".concat(auth)
+            }
+        });
+        //
+        this.socket.onopen = function () {
+            _this.connected = true;
+            console.log('ChainDB: WebSocket connection established');
+        };
+        this.socket.on('message', function (data) {
+            try {
+                var parsedData_1 = JSON.parse(data.toString());
+                if (parsedData_1.event_type && _this.eventListeners.has(parsedData_1.event_type)) {
+                    var listeners = _this.eventListeners.get(parsedData_1.event_type) || [];
+                    listeners.forEach(function (callback) { return callback(parsedData_1); });
+                }
+            }
+            catch (error) {
+                console.error('Error parsing WebSocket message:', error);
+            }
+        });
+        this.socket.on('close', function () {
+            _this.connected = false;
+            console.log('ChainDB: WebSocket connection closed');
+        });
+        this.socket.on('error', function (error) {
+            console.error('WebSocket error:', error);
+        });
+    }
+    /**
+     * Subscribe to an event
+     * @param event Event name to subscribe to
+     * @param callback Function to call when the event is received
+     */
+    Events.prototype.subscribe = function (event, callback) {
+        if (!this.eventListeners.has(event)) {
+            this.eventListeners.set(event, []);
+        }
+        var listeners = this.eventListeners.get(event) || [];
+        listeners.push(callback);
+        this.eventListeners.set(event, listeners);
+    };
+    /**
+     * Unsubscribe from an event
+     * @param event Event name to unsubscribe from
+     * @param callback Optional callback to remove. If not provided, all callbacks for the event will be removed.
+     */
+    Events.prototype.unsubscribe = function (event, callback) {
+        if (!this.eventListeners.has(event)) {
+            return;
+        }
+        if (callback) {
+            // Remove specific callback
+            var listeners = this.eventListeners.get(event) || [];
+            var updatedListeners = listeners.filter(function (cb) { return cb !== callback; });
+            this.eventListeners.set(event, updatedListeners);
+        }
+        else {
+            // Remove all callbacks for this event
+            this.eventListeners["delete"](event);
+        }
+    };
+    /**
+     * Close the WebSocket connection
+     */
+    Events.prototype.close = function () {
+        this.socket.close();
+    };
+    /**
+     * Check if the WebSocket connection is established
+     */
+    Events.prototype.isConnected = function () {
+        return this.connected;
+    };
+    return Events;
+}());
+exports["default"] = 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,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;