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

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

@@ -9,6 +9,11 @@ export type Connection = {
     user: string;
     password: string;
 };
+export type ConnectionWithToken = {
+    server: string | null;
+    database: string;
+    token: string;
+};
 export type Criteria<Model> = Partial<Record<keyof Model, string | number | boolean>>;
 export type CriteriaAdvanced<Model> = {
     field: Partial<keyof Model>;

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

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

package/dist/cjs/features/utils.js

@@ -3,8 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 exports.__esModule = true;
-exports.post = void 0;
+exports.get = exports.post = void 0;
 var axios_1 = __importDefault(require("axios"));
+// Using Axios
 var post = function (url, body, auth) {
     if (auth === void 0) { auth = ''; }
     return axios_1["default"].post(url, body, {
@@ -12,3 +13,10 @@ var post = function (url, body, auth) {
     });
 };
 exports.post = post;
+var get = function (url, auth) {
+    if (auth === void 0) { auth = ''; }
+    return axios_1["default"].get(url, {
+        headers: { Authorization: "Basic ".concat(auth) }
+    });
+};
+exports.get = get;

package/dist/cjs/index.d.ts

@@ -1,4 +1,5 @@
-export { ChainDB, connect } from './features/chain-db';
+export { ChainDB, connect, connectWithToken } from './features/chain-db';
 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';
+export { default as Table } from './features/table';

package/dist/cjs/index.js

@@ -11,10 +11,11 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     o[k2] = m[k];
 }));
 exports.__esModule = true;
-exports.TableDocImpl = exports.Events = exports.EventTypes = exports.Operators = exports.connect = exports.ChainDB = void 0;
+exports.Table = exports.TableDocImpl = exports.Events = exports.EventTypes = exports.Operators = exports.connectWithToken = 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");
+__createBinding(exports, chain_db_1, "connectWithToken");
 var types_1 = require("./features/types");
 __createBinding(exports, types_1, "Operators");
 __createBinding(exports, types_1, "EventTypes");
@@ -22,3 +23,5 @@ 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");
+var table_1 = require("./features/table");
+__createBinding(exports, table_1, "default", "Table");

package/features/chain-db.d.ts

@@ -1,5 +1,5 @@
 import Table from './table';
-import { Connection, EventCallback } from './types';
+import { Connection, ConnectionWithToken, EventCallback } from './types';
 export declare class ChainDB {
     server: string;
     database: string;
@@ -13,10 +13,15 @@ export declare class ChainDB {
      * @param password  Password to access the data base
      */
     connect(connection: Connection): Promise<void>;
+    /**
+     * Connect to Chain DB with a token (Synchronously). This is useful if you don't want to use a promise to connect to Chain DB.
+     * @param connection Connection information with token
+     */
+    connectWithToken(connection: ConnectionWithToken): void;
     /**
      * Initialize a table, fetching its more updated data
      */
-    getTable<Model>(table_name: string): Promise<Table<Model>>;
+    getTable<Model>(table_name: string): Table<Model>;
     events(): {
         /**
          * Subscribe to an event
@@ -37,3 +42,4 @@ export declare class ChainDB {
     };
 }
 export declare const connect: (connection: Connection) => Promise<ChainDB>;
+export declare const connectWithToken: (connection: ConnectionWithToken) => ChainDB;

package/features/chain-db.js

@@ -84,44 +84,43 @@ var ChainDB = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Connect to Chain DB with a token (Synchronously). This is useful if you don't want to use a promise to connect to Chain DB.
+     * @param connection Connection information with token
+     */
+    ChainDB.prototype.connectWithToken = function (connection) {
+        var server = connection.server, database = connection.database, token = connection.token;
+        this.server = server || DEFAULT_API_SERVER;
+        this.database = database;
+        this.auth = token;
+    };
     /**
      * Initialize a table, fetching its more updated data
      */
     ChainDB.prototype.getTable = function (table_name) {
-        return __awaiter(this, void 0, void 0, function () {
-            var tableData;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        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[]>
-                            // }
-                        ];
-                }
-            });
-        });
+        var tableData = new Table(table_name, this);
+        // await tableData.refetch()
+        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[]>
+        // }
     };
     ChainDB.prototype.events = function () {
         var _this = this;
@@ -175,3 +174,8 @@ export var connect = function (connection) { return __awaiter(void 0, void 0, vo
         }
     });
 }); };
+export var connectWithToken = function (connection) {
+    var chainDb = new ChainDB();
+    chainDb.connectWithToken(connection);
+    return chainDb;
+};

package/features/table-doc.js

@@ -34,9 +34,8 @@ 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 axios from 'axios';
 import { UPDATE_ITEM, GET_DOC } from './constants';
-import { post } from './utils';
+import { get, post } from './utils';
 /**
  * Implementation of TableDoc interface
  * Represents a specific document from a table
@@ -75,7 +74,8 @@ var TableDocImpl = /** @class */ (function () {
                         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)));
+                        // throw new Error(`Something went wrong updating document ${this.doc_id}: ${e.message || String(e)}`)
+                        throw new Error(e_1);
                     case 4: return [2 /*return*/];
                 }
             });
@@ -95,7 +95,7 @@ var TableDocImpl = /** @class */ (function () {
                         _a.label = 1;
                     case 1:
                         _a.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, axios.get(url, { headers: { Authorization: "Basic ".concat(this.db.auth) } })];
+                        return [4 /*yield*/, get(url, this.db.auth)];
                     case 2:
                         response = _a.sent();
                         if (!response.data.success) {
@@ -106,7 +106,8 @@ var TableDocImpl = /** @class */ (function () {
                         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)));
+                        // throw new Error(`Something went wrong refetching document ${this.doc_id}: ${e.message || String(e)}`)
+                        throw new Error(e_2);
                     case 4: return [2 /*return*/];
                 }
             });

package/features/table.d.ts

@@ -1,28 +1,27 @@
 import { ChainDB } from './chain-db';
 import { Criteria, CriteriaAdvanced, DocId, TableDoc } from './types';
+import { TableDocImpl } from './table-doc';
 declare class Table<Model> {
-    currentDoc: Model;
+    /**
+     * The current document data
+     */
     private name;
     private db;
     constructor(name: string, db: ChainDB);
     /**
-     * Persist table's document data changes
+     * Create a new document in the table
      */
-    persist(): Promise<DocId<Model>>;
+    new(data: Model): Promise<TableDoc<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<DocId<Model>[]>;
-    /**
-     * Refetch the table data
+     * @param limit Maximum number of items to return (default: 100)
      */
-    refetch(): Promise<void>;
+    getHistory(limit?: number): Promise<TableDocImpl<DocId<Model>>[]>;
     /**
-     * Check if the table is empty
+     * Get the last record stored in the table
      */
-    isEmpty(): boolean;
+    last(): Promise<TableDocImpl<DocId<Model>>>;
     /**
      * Get the table's name
      */
@@ -31,7 +30,7 @@ declare class Table<Model> {
      * 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)
+     * @param reverse If true, returns items in reverse order, newer items first (default: true)
      * @returns Array of found items matching the criteria
      * @example
      * // Find items where age is 44
@@ -47,9 +46,16 @@ declare class Table<Model> {
      *   score: 100
      * })
      */
-    findWhere(criteria: Criteria<Model>, limit?: number, reverse?: boolean): Promise<DocId<Model>[]>;
+    findWhere(criteria: Criteria<Model>, limit?: number, reverse?: boolean): Promise<TableDocImpl<DocId<Model>>[]>;
+    /**
+     * Find the first item 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 reverse If true, returns items in reverse order, newer items first (default: true)
+     * @returns The first found item matching the criteria or null if no item is found
+     */
+    find(criteria: Criteria<Model>, reverse?: boolean): Promise<TableDocImpl<DocId<Model>>>;
     /**
-     * Find items in the table using advanced criteria with operators
+     * Find the first item 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:
@@ -64,7 +70,7 @@ declare class Table<Model> {
      *   - 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)
+     * @param reverse If true, returns items in reverse order, newer items first (default: true)
      * @returns Array of found items matching the criteria
      * @example
      * // Find items where greeting contains "arg"
@@ -76,16 +82,40 @@ declare class Table<Model> {
      *   }
      * ])
      */
-    findWhereAdvanced(criteria: CriteriaAdvanced<Model>[], limit?: number, reverse?: boolean): Promise<DocId<Model>[]>;
+    findWhereAdvanced(criteria: CriteriaAdvanced<Model>[], limit?: number, reverse?: boolean): Promise<TableDocImpl<DocId<Model>>[]>;
     /**
-     * Get the current document ID
+     * Find the first single item 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 reverse If true, returns items in reverse order, newer items first (default: true)
+     * @returns The first found item matching the criteria or null if no item is found
+     * @example
+     * // Find items where greeting contains "arg"
+     * table.findAdvanced([
+     *   {
+     *     field: "greeting",
+     *     operator: Operators.Contains,
+     *     value: "hello"
+     *   }
+     * ])
      */
-    getCurrentDocId(): string;
+    findAdvanced(criteria: CriteriaAdvanced<Model>[], reverse?: boolean): Promise<TableDocImpl<DocId<Model>>>;
     /**
      * 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>>;
+    getByDocId(doc_id: string): Promise<TableDoc<Model>>;
 }
 export default Table;