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

package/features/table.d.ts

@@ -1,13 +1,86 @@
 import { ChainDB } from './chain-db';
+import { Criteria, CriteriaAdvanced } from './types';
 declare class Table<Model> {
     table: Model;
-    private contract_id;
+    private name;
     private db;
-    constructor(table: Model, contract_id: string, db: ChainDB);
+    constructor(name: string, db: ChainDB);
     /**
-     * Persist table data on chain
+     * 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.
+     */
+    update(): 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 limit
+     */
+    getHistory(limit: number): Promise<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<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<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,257 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 import axios from 'axios';
-import { CONTRACT_PAYLOAD, CONTRACT_TRANSACTION } from './constants';
-import { TransactionType } from './types';
+import { FIND_WHERE_ADVANCED, FIND_WHERE_BASIC, GET_HISTORY, GET_TABLE, PERSIST_NEW_DATA, UPDATE_LAST_ITEM, } from './constants';
 import { post } from './utils';
 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.table = {};
+        this.name = name;
         this.db = db;
     }
     /**
-     * Persist table data on chain
+     * Persist table 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.table
                         };
-                        _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();
+                        response = _a.sent();
+                        if (!response.data.success) {
+                            throw new Error(response.data.message);
+                        }
                         return [3 /*break*/, 4];
                     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*/];
+                }
+            });
+        });
+    };
+    /**
+     * 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(UPDATE_LAST_ITEM(this.name));
+                        body = {
+                            data: this.table
+                        };
+                        _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_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
+     * @param limit
+     */
+    Table.prototype.getHistory = function (limit) {
+        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_HISTORY(this.name, limit));
+                        _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);
+                        }
+                        // 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)));
+                    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_4;
+            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.table = 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)));
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Check if the table is empty
+     */
+    Table.prototype.isEmpty = function () {
+        return Object.keys(this.table).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_5;
+            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_5 = _a.sent();
+                        throw new Error("Something went wrong with findWhere operation: ".concat(e_5.message || String(e_5)));
+                    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:
+     * - 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_6;
+            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_6 = _a.sent();
+                        throw new Error("Something went wrong with findWhereAdvanced operation: ".concat(e_6.message || String(e_6)));
                     case 4: return [2 /*return*/];
                 }
             });
@@ -79,31 +293,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,27 +1,53 @@
 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"
-}
-export type ContractTransactionData<Model> = {
-    tx_type: TransactionType;
-    contract_id: string;
-    timestamp?: number;
-    data: Model;
+/**
+ * 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;

package/features/types.js

@@ -1,7 +1,29 @@
-export var TransactionType;
-(function (TransactionType) {
-    TransactionType["NONE"] = "NONE";
-    TransactionType["ACCOUNT"] = "ACCOUNT";
-    TransactionType["CONTRACT"] = "CONTRACT";
-    TransactionType["TRANSFER"] = "TRANSFER";
-})(TransactionType || (TransactionType = {}));
+/**
+ * Operators for the advanced criteria
+ * @see https://docs.chaindb.com/docs/query-language/ (TODO)
+ */
+export var Operators = {
+    // (==)
+    EQUAL: 'Eq',
+    // (!=)
+    NOT_EQUAL: 'Ne',
+    // (>)
+    GREATER_THAN: 'Gt',
+    // (>=)
+    GREATER_THAN_OR_EQUAL: 'Ge',
+    // (<)
+    LESS_THAN: 'Lt',
+    // (<=)
+    LESS_THAN_OR_EQUAL: 'Le',
+    // (for strings and arrays)
+    CONTAINS: 'Contains',
+    // (for strings)
+    STARTS_WITH: 'StartsWith',
+    // (for strings)
+    ENDS_WITH: 'EndsWith'
+};
+// Events
+export var EventTypes = {
+    TABLE_PERSIST: 'TablePersist',
+    TABLE_UPDATE: 'TableUpdate'
+};

package/features/utils.d.ts

@@ -1 +1,2 @@
-export declare const post: (url: string, body: any) => Promise<import("axios").AxiosResponse<any, any>>;
+import { BasicResponse } from './types';
+export declare const post: (url: string, body: any, auth?: string) => Promise<import("axios").AxiosResponse<BasicResponse<any>, any>>;

package/features/utils.js

@@ -1,4 +1,7 @@
 import axios from 'axios';
-export var post = function (url, body) {
-    return axios.post(url, body, { headers: { 'content-type': 'application/json' } });
+export var post = function (url, body, auth) {
+    if (auth === void 0) { auth = ''; }
+    return axios.post(url, body, {
+        headers: { 'content-type': 'application/json', Authorization: "Basic ".concat(auth) }
+    });
 };

package/index.d.ts

@@ -1,3 +1,2 @@
 export { ChainDB, connect } from './features/chain-db';
-export { Access } from './features/access';
-export { BasicResponse, SignedUserAccount } from './features/types';
+export { BasicResponse, Operators, CriteriaAdvanced, Criteria, EventTypes, EventData, EventCallback, } from './features/types';

package/index.js

@@ -1,2 +1,2 @@
 export { ChainDB, connect } from './features/chain-db';
-export { Access } from './features/access';
+export { Operators, EventTypes, } from './features/types';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chain-db-ts",
-  "version": "0.0.1",
+  "version": "1.0.0-rc.1",
   "description": "Chain DB Client for Javascript/Typescript Node apps.",
   "main": "./dist/cjs/index.js",
   "module": "./index.js",
@@ -26,7 +26,7 @@
   "license": "MIT",
   "devDependencies": {
     "@types/node": "^18.15.5",
-    "@types/sha256": "^0.2.0",
+    "@types/ws": "^8.5.14",
     "nodemon": "^3.0.1",
     "ts-node": "^10.9.1",
     "tslib": "^2.5.0",
@@ -35,6 +35,8 @@
   "repository": "git://github.com/wpdas/chain-db-ts.git",
   "dependencies": {
     "axios": "^1.4.0",
-    "sha256": "^0.2.0"
+    "bufferutil": "^4.0.9",
+    "utf-8-validate": "^6.0.5",
+    "ws": "^8.18.1"
   }
 }