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

package/features/chain-db.d.ts

@@ -1,10 +1,10 @@
-import { Access } from './access';
-import { BasicResponse, SignedUserAccount, TransferUnitsRegistry } from './types';
+import Table from './table';
+import { Connection, EventCallback } from './types';
 export declare class ChainDB {
-    api: string;
-    name: string;
-    access: Access | null;
-    access_key: string;
+    server: string;
+    database: string;
+    auth: string;
+    private _events;
     /**
      * Connection information.
      * @param server Server location. If the `server` parameter is empty, then "http://localhost" will be used.
@@ -12,63 +12,28 @@ export declare class ChainDB {
      * @param user  User to access the data base
      * @param password  Password to access the data base
      */
-    connect(server: string | null, data_base: string, user: string, password: string): void;
-    /**
-     * Create a new user account inside the connected table
-     * @param user_name
-     * @param password
-     * @param units
-     * @param password_hint
-     * @returns
-     */
-    create_user_account(user_name: string, password: string, units?: number, password_hint?: string): Promise<BasicResponse<SignedUserAccount>>;
-    /**
-     * Get user account info (login method)
-     * @param user_name
-     * @param password
-     * @returns
-     */
-    get_user_account(user_name: string, password: string): Promise<BasicResponse<SignedUserAccount>>;
-    /**
-     * Get user account info by its id
-     * @param user_id
-     * @returns
-     */
-    get_user_account_by_id(user_id: string): Promise<BasicResponse<SignedUserAccount>>;
-    /**
-     * Check if user_name is already taken
-     * @param user_name
-     */
-    check_user_name(user_name: string): Promise<BasicResponse<string>>;
-    /**
-     * Transfer units between users
-     * @param from user_id
-     * @param to user_id
-     * @param units
-     * @returns
-     */
-    transfer_units(from: string, to: string, units: number): Promise<BasicResponse<null>>;
-    /**
-     * Fetch the last Transference of units Records by User
-     * @param user_id
-     * @returns
-     */
-    get_transfer_by_user_id(user_id: string): Promise<BasicResponse<TransferUnitsRegistry>>;
-    /**
-     * Fetch all Transference of units Records by User
-     * @param user_id
-     * @returns
-     */
-    get_all_transfers_by_user_id(user_id: string): Promise<BasicResponse<TransferUnitsRegistry[]>>;
+    connect(connection: Connection): Promise<void>;
     /**
      * Initialize a table, fetching its more updated data
      */
-    get_table<Model>(table_name: string, model: Model): Promise<{
-        table: Model;
+    getTable<Model>(table_name: string): Promise<Table<Model>>;
+    events(): {
+        /**
+         * Subscribe to an event
+         * @param event Event name to subscribe to @see {EventTypes}
+         * @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 @see {EventTypes}
+         * @param callback Optional callback to remove. If not provided, all callbacks for the event will be removed.
+         */
+        unsubscribe: (event: string, callback?: EventCallback) => void;
         /**
-         * Persist table data on chain
+         * Close the events transmission
          */
-        persist: () => Promise<void>;
-    }>;
+        closeEvents: () => void;
+    };
 }
-export declare const connect: (server: string | null, data_base: string, user: string, password: string) => ChainDB;
+export declare const connect: (connection: Connection) => Promise<ChainDB>;

package/features/chain-db.js

@@ -34,18 +34,16 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-import sha256 from 'sha256';
-import axios from 'axios';
-import { Access } from './access';
-import { API, CHECK_USER_NAME, CREATE_USER_ACCOUNT, GET_ALL_TRANSFER_BY_USER_ID, GET_TRANSFER_BY_USER_ID, GET_USER_ACCOUNT, GET_USER_ACCOUNT_BY_ID, TRANSFER_UNITS, } from './constants';
+import { DEFAULT_API_SERVER, CONNECT, WEB_SOCKET_EVENTS } from './constants';
 import { post } from './utils';
-import * as table from './table';
+import Table from './table';
+import Events from './events';
 var ChainDB = /** @class */ (function () {
     function ChainDB() {
-        this.api = '';
-        this.name = '';
-        this.access = null;
-        this.access_key = '';
+        this.server = DEFAULT_API_SERVER;
+        this.database = '';
+        this.auth = '';
+        this._events = null;
     }
     /**
      * Connection information.
@@ -54,224 +52,34 @@ var ChainDB = /** @class */ (function () {
      * @param user  User to access the data base
      * @param password  Password to access the data base
      */
-    ChainDB.prototype.connect = function (server, data_base, user, password) {
-        var key_data = "".concat(data_base).concat(user).concat(password);
-        var key = sha256(key_data);
-        this.api = server || API;
-        this.name = data_base;
-        this.access = new Access(user, password);
-        this.access_key = key;
-    };
-    /**
-     * Create a new user account inside the connected table
-     * @param user_name
-     * @param password
-     * @param units
-     * @param password_hint
-     * @returns
-     */
-    ChainDB.prototype.create_user_account = function (user_name, password, units, password_hint) {
+    ChainDB.prototype.connect = function (connection) {
         return __awaiter(this, void 0, void 0, function () {
-            var url, body, response, _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        url = "".concat(this.api).concat(CREATE_USER_ACCOUNT);
-                        body = {
-                            db_access_key: this.access_key,
-                            user_name: user_name,
-                            password: password,
-                            password_hint: password_hint,
-                            units: units
-                        };
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 4, , 5]);
-                        return [4 /*yield*/, post(url, body)];
-                    case 2:
-                        response = _b.sent();
-                        return [4 /*yield*/, response.data];
-                    case 3: return [2 /*return*/, _b.sent()];
-                    case 4:
-                        _a = _b.sent();
-                        throw new Error('Something went wrong!');
-                    case 5: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    /**
-     * Get user account info (login method)
-     * @param user_name
-     * @param password
-     * @returns
-     */
-    ChainDB.prototype.get_user_account = function (user_name, password) {
-        return __awaiter(this, void 0, void 0, function () {
-            var url, response, _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        url = "".concat(this.api).concat(GET_USER_ACCOUNT, "/").concat(user_name, "/").concat(password, "/").concat(this.access_key);
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 4, , 5]);
-                        return [4 /*yield*/, axios.get(url)];
-                    case 2:
-                        response = _b.sent();
-                        return [4 /*yield*/, response.data];
-                    case 3: return [2 /*return*/, _b.sent()];
-                    case 4:
-                        _a = _b.sent();
-                        throw new Error('Something went wrong!');
-                    case 5: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    /**
-     * Get user account info by its id
-     * @param user_id
-     * @returns
-     */
-    ChainDB.prototype.get_user_account_by_id = function (user_id) {
-        return __awaiter(this, void 0, void 0, function () {
-            var url, response, _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        url = "".concat(this.api).concat(GET_USER_ACCOUNT_BY_ID, "/").concat(user_id, "/").concat(this.access_key);
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 4, , 5]);
-                        return [4 /*yield*/, axios.get(url)];
-                    case 2:
-                        response = _b.sent();
-                        return [4 /*yield*/, response.data];
-                    case 3: return [2 /*return*/, _b.sent()];
-                    case 4:
-                        _a = _b.sent();
-                        throw new Error('Something went wrong!');
-                    case 5: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    /**
-     * Check if user_name is already taken
-     * @param user_name
-     */
-    ChainDB.prototype.check_user_name = function (user_name) {
-        return __awaiter(this, void 0, void 0, function () {
-            var url, response, _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        url = "".concat(this.api).concat(CHECK_USER_NAME, "/").concat(user_name, "/").concat(this.access_key);
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 4, , 5]);
-                        return [4 /*yield*/, axios.get(url)];
-                    case 2:
-                        response = _b.sent();
-                        return [4 /*yield*/, response.data];
-                    case 3: return [2 /*return*/, _b.sent()];
-                    case 4:
-                        _a = _b.sent();
-                        throw new Error('Something went wrong!');
-                    case 5: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    /**
-     * Transfer units between users
-     * @param from user_id
-     * @param to user_id
-     * @param units
-     * @returns
-     */
-    ChainDB.prototype.transfer_units = function (from, to, units) {
-        return __awaiter(this, void 0, void 0, function () {
-            var url, body, response, _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        url = "".concat(this.api).concat(TRANSFER_UNITS);
-                        body = {
-                            db_access_key: this.access_key,
-                            from: from,
-                            to: to,
-                            units: units
-                        };
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 4, , 5]);
-                        return [4 /*yield*/, post(url, body)];
-                    case 2:
-                        response = _b.sent();
-                        return [4 /*yield*/, response.data];
-                    case 3: return [2 /*return*/, _b.sent()];
-                    case 4:
-                        _a = _b.sent();
-                        throw new Error('Something went wrong!');
-                    case 5: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    /**
-     * Fetch the last Transference of units Records by User
-     * @param user_id
-     * @returns
-     */
-    ChainDB.prototype.get_transfer_by_user_id = function (user_id) {
-        return __awaiter(this, void 0, void 0, function () {
-            var url, response, _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        url = "".concat(this.api).concat(GET_TRANSFER_BY_USER_ID, "/").concat(user_id, "/").concat(this.access_key);
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 4, , 5]);
-                        return [4 /*yield*/, axios.get(url)];
-                    case 2:
-                        response = _b.sent();
-                        return [4 /*yield*/, response.data];
-                    case 3: return [2 /*return*/, _b.sent()];
-                    case 4:
-                        _a = _b.sent();
-                        throw new Error('Something went wrong!');
-                    case 5: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    /**
-     * Fetch all Transference of units Records by User
-     * @param user_id
-     * @returns
-     */
-    ChainDB.prototype.get_all_transfers_by_user_id = function (user_id) {
-        return __awaiter(this, void 0, void 0, function () {
-            var url, response, _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
+            var server, database, user, password, response, e_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
                     case 0:
-                        url = "".concat(this.api).concat(GET_ALL_TRANSFER_BY_USER_ID, "/").concat(user_id, "/").concat(this.access_key);
-                        _b.label = 1;
+                        server = connection.server, database = connection.database, user = connection.user, password = connection.password;
+                        this.server = server || DEFAULT_API_SERVER;
+                        this.database = database;
+                        _a.label = 1;
                     case 1:
-                        _b.trys.push([1, 4, , 5]);
-                        return [4 /*yield*/, axios.get(url)];
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, post("".concat(this.server).concat(CONNECT), {
+                                name: this.database,
+                                user: user,
+                                password: password
+                            })];
                     case 2:
-                        response = _b.sent();
-                        return [4 /*yield*/, response.data];
-                    case 3: return [2 /*return*/, _b.sent()];
-                    case 4:
-                        _a = _b.sent();
-                        throw new Error('Something went wrong!');
-                    case 5: return [2 /*return*/];
+                        response = _a.sent();
+                        if (!response.data.success) {
+                            throw new Error(response.data.message);
+                        }
+                        this.auth = response.data.data;
+                        return [3 /*break*/, 4];
+                    case 3:
+                        e_1 = _a.sent();
+                        throw new Error("Something went wrong! ".concat(e_1.message || String(e_1)));
+                    case 4: return [2 /*return*/];
                 }
             });
         });
@@ -279,39 +87,91 @@ var ChainDB = /** @class */ (function () {
     /**
      * Initialize a table, fetching its more updated data
      */
-    ChainDB.prototype.get_table = function (table_name, model) {
+    ChainDB.prototype.getTable = function (table_name) {
         return __awaiter(this, void 0, void 0, function () {
-            var chainDbCopy, table_data;
+            var tableData;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        chainDbCopy = connect(this.api, this.name, this.access.user, this.access.password);
-                        return [4 /*yield*/, table.get(chainDbCopy, table_name, model)
+                        tableData = new Table(table_name, this);
+                        return [4 /*yield*/, tableData.refetch()];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/, tableData
+                            // const table_data = await table.get<Model>(this, table_name, model)
                             // NOTE: Although only the "table" and "persist" properties are displayed by
                             // the lint, all Table properties are being exposed.
                             // This is due to a javascript limitation on classes.
                             //
                             // There was an attempt to return a new object with only the required
                             // data, but this generates an error in the "this" instance of the Table.
+                            // return table_data as {
+                            //   table: Model
+                            //   /**
+                            //    * Persist table data on chain
+                            //    */
+                            //   persist: () => Promise<void>
+                            //   /**
+                            //    * Get the history of changes. A list of transactions from the most recent to the most old
+                            //    * in a range of depth
+                            //    * @param depth
+                            //    */
+                            //   getHistory: (depth: number) => Promise<Model[]>
+                            // }
                         ];
-                    case 1:
-                        table_data = _a.sent();
-                        // NOTE: Although only the "table" and "persist" properties are displayed by
-                        // the lint, all Table properties are being exposed.
-                        // This is due to a javascript limitation on classes.
-                        //
-                        // There was an attempt to return a new object with only the required
-                        // data, but this generates an error in the "this" instance of the Table.
-                        return [2 /*return*/, table_data];
                 }
             });
         });
     };
+    ChainDB.prototype.events = function () {
+        var _this = this;
+        return {
+            /**
+             * Subscribe to an event
+             * @param event Event name to subscribe to @see {EventTypes}
+             * @param callback Function to call when the event is received
+             */
+            subscribe: function (event, callback) {
+                var _a;
+                if (_this._events === null) {
+                    var wsUrl = "".concat(_this.server.replace('http', 'ws')).concat(WEB_SOCKET_EVENTS);
+                    _this._events = new Events(wsUrl, _this.auth);
+                }
+                (_a = _this._events) === null || _a === void 0 ? void 0 : _a.subscribe(event, callback);
+            },
+            /**
+             * Unsubscribe from an event
+             * @param event Event name to unsubscribe from @see {EventTypes}
+             * @param callback Optional callback to remove. If not provided, all callbacks for the event will be removed.
+             */
+            unsubscribe: function (event, callback) {
+                if (!_this._events || !_this._events.isConnected()) {
+                    return;
+                }
+                _this._events.unsubscribe(event, callback);
+            },
+            /**
+             * Close the events transmission
+             */
+            closeEvents: function () {
+                var _a;
+                (_a = _this._events) === null || _a === void 0 ? void 0 : _a.close();
+            }
+        };
+    };
     return ChainDB;
 }());
 export { ChainDB };
-export var connect = function (server, data_base, user, password) {
-    var chainDb = new ChainDB();
-    chainDb.connect(server, data_base, user, password);
-    return chainDb;
-};
+export var connect = function (connection) { return __awaiter(void 0, void 0, void 0, function () {
+    var chainDb;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                chainDb = new ChainDB();
+                return [4 /*yield*/, chainDb.connect(connection)];
+            case 1:
+                _a.sent();
+                return [2 /*return*/, chainDb];
+        }
+    });
+}); };

package/features/constants.d.ts

@@ -1,10 +1,10 @@
-export declare const API = "http://localhost:2818";
-export declare const CONTRACT_PAYLOAD = "/get_last_contract_transaction";
-export declare const CONTRACT_TRANSACTION = "/post_contract_transaction";
-export declare const CREATE_USER_ACCOUNT = "/create_user_account";
-export declare const GET_USER_ACCOUNT = "/get_user_account";
-export declare const GET_USER_ACCOUNT_BY_ID = "/get_user_account_by_id";
-export declare const TRANSFER_UNITS = "/transfer_units";
-export declare const GET_TRANSFER_BY_USER_ID = "/get_transfer_by_user_id";
-export declare const GET_ALL_TRANSFER_BY_USER_ID = "/get_all_transfers_by_user_id";
-export declare const CHECK_USER_NAME = "/check_user_name";
+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 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 WEB_SOCKET_EVENTS: string;

package/features/constants.js

@@ -1,11 +1,14 @@
 // Contants
-export var API = 'http://localhost:2818';
-export var CONTRACT_PAYLOAD = '/get_last_contract_transaction';
-export var CONTRACT_TRANSACTION = '/post_contract_transaction';
-export var CREATE_USER_ACCOUNT = '/create_user_account';
-export var GET_USER_ACCOUNT = '/get_user_account';
-export var GET_USER_ACCOUNT_BY_ID = '/get_user_account_by_id';
-export var TRANSFER_UNITS = '/transfer_units';
-export var GET_TRANSFER_BY_USER_ID = '/get_transfer_by_user_id';
-export var GET_ALL_TRANSFER_BY_USER_ID = '/get_all_transfers_by_user_id';
-export var CHECK_USER_NAME = '/check_user_name';
+export var DEFAULT_API_SERVER = 'http://localhost:2818';
+export var API_BASE = '/api/v1';
+export var CONNECT = "".concat(API_BASE, "/database/connect");
+export var GET_TABLE = function (table) { return "".concat(API_BASE, "/table/").concat(table); };
+export var UPDATE_LAST_ITEM = function (table) { return "".concat(API_BASE, "/table/").concat(table, "/update"); };
+export var PERSIST_NEW_DATA = function (table) { return "".concat(API_BASE, "/table/").concat(table, "/persist"); };
+export var GET_HISTORY = function (table, limit) {
+    if (limit === void 0) { limit = 25; }
+    return "".concat(API_BASE, "/table/").concat(table, "/history?limit=").concat(limit);
+};
+export var FIND_WHERE_BASIC = function (table) { return "".concat(API_BASE, "/table/").concat(table, "/find"); };
+export var FIND_WHERE_ADVANCED = function (table) { return "".concat(API_BASE, "/table/").concat(table, "/find-advanced"); };
+export var WEB_SOCKET_EVENTS = "".concat(API_BASE, "/events");

package/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/features/events.js

@@ -0,0 +1,84 @@
+import WebSocket from 'ws';
+var Events = /** @class */ (function () {
+    function Events(url, auth) {
+        var _this = this;
+        this.eventListeners = new Map();
+        this.connected = false;
+        this.socket = new WebSocket(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;
+}());
+export default Events;