eth-graph-query 1.0.0 → 1.0.1

package/README.md

@@ -1,7 +1,32 @@
-<div align="center">
-Eth graph query
-</div>
+<h1>
+ETH GRAPH QUERY
+</h1>
+
+---
 
 ### Installation
 
+```shell
+npm install eth-graph-query
+
+```
+
+---
+
 ### Usage
+
+---
+
+### For develop
+
+- To test package, you can run below command
+
+```shell
+npm run test
+```
+
+- Before running above command, you must create `.env` file
+
+```shell
+cp .env.example .env
+```

package/lib/index.d.ts

@@ -1 +1,7 @@
-export declare function greet(name: string): string;
+import { AxiosRequestConfig } from 'axios';
+import NormalQuery from './normal-query';
+import { GraphParams } from './type';
+export default class EthGraphQuery extends NormalQuery {
+    constructor(rootUrl: string, config?: AxiosRequestConfig);
+    query(collection: string, params: GraphParams): Promise<any>;
+}

package/lib/index.js

@@ -1,7 +1,25 @@
 "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());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.greet = void 0;
-function greet(name) {
-    return `Hello ${name}`;
+const normal_query_1 = require("./normal-query");
+const query_builder_1 = require("./query-builder");
+class EthGraphQuery extends normal_query_1.default {
+    constructor(rootUrl, config) {
+        super(rootUrl, config);
+    }
+    query(collection, params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const sQuery = query_builder_1.default.buildQuery(collection, params);
+            return yield this.post('', { query: query_builder_1.default.makeFullQuery(sQuery) });
+        });
+    }
 }
-exports.greet = greet;
+exports.default = EthGraphQuery;

package/lib/normal-query.d.ts

@@ -0,0 +1,14 @@
+import { AxiosRequestConfig } from 'axios';
+export declare const defaultHeader: {
+    Accept: string;
+    'Content-Type': string;
+};
+export default class NormalQuery {
+    root: string;
+    config: AxiosRequestConfig;
+    constructor(rootUrl: string, config?: AxiosRequestConfig);
+    get<T = any>(url: string, config?: AxiosRequestConfig): Promise<T>;
+    post<B = any, T = any>(url: string, data?: B, config?: AxiosRequestConfig): Promise<T>;
+    put<B = any, T = any>(url: string, data?: B, config?: AxiosRequestConfig): Promise<T>;
+    del<T = any>(url: string, config?: AxiosRequestConfig): Promise<T>;
+}

package/lib/normal-query.js

@@ -0,0 +1,45 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultHeader = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const axios_1 = require("axios");
+exports.defaultHeader = { Accept: 'application/json', 'Content-Type': 'application/json' };
+function responseBody(res) {
+    return res.data;
+}
+class NormalQuery {
+    constructor(rootUrl, config) {
+        this.root = rootUrl;
+        this.config = config ? Object.assign(Object.assign({}, config), { headers: exports.defaultHeader }) : { headers: exports.defaultHeader };
+    }
+    get(url, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield axios_1.default.get(`${this.root}${url}`, Object.assign(Object.assign({}, config), this.config)).then(responseBody);
+        });
+    }
+    post(url, data, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield axios_1.default.post(`${this.root}${url}`, data, Object.assign(Object.assign({}, config), this.config)).then(responseBody);
+        });
+    }
+    put(url, data, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield axios_1.default.put(`${this.root}${url}`, data, Object.assign(Object.assign({}, config), this.config)).then(responseBody);
+        });
+    }
+    del(url, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield axios_1.default.delete(`${this.root}${url}`, Object.assign(Object.assign({}, config), this.config)).then(responseBody);
+        });
+    }
+}
+exports.default = NormalQuery;

package/lib/query-builder.d.ts

@@ -0,0 +1,6 @@
+import { GraphParams, QueryJson } from './type';
+export default class QueryBuilder {
+    static buildJsonQuery(query: QueryJson): string;
+    static buildQuery(collection: string, params: GraphParams): string;
+    static makeFullQuery(query: string): string;
+}

package/lib/query-builder.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class QueryBuilder {
+    static buildJsonQuery(query) {
+        const whereList = [];
+        for (const key in query) {
+            if (query[key] != undefined) {
+                if (typeof query[key] == 'object')
+                    whereList.push(`${key}: {${this.buildJsonQuery(query[key])}}`);
+                else
+                    whereList.push(`${key}: ${query[key]}`);
+            }
+        }
+        return whereList.join(', ');
+    }
+    static buildQuery(collection, params) {
+        const filters = [];
+        if (params.id != undefined)
+            filters.push(`id: ${params.id}`);
+        if (params.orderBy)
+            filters.push(`orderBy: ${params.orderBy}`);
+        if (params.orderDirection)
+            filters.push(`orderDirection: ${params.orderDirection}`);
+        if (params.first != undefined) {
+            if (params.first < 0)
+                params.first = 0;
+            else if (params.first > 1000)
+                params.first = 1000;
+            filters.push(`first: ${params.first}`);
+        }
+        if (params.skip != undefined) {
+            if (params.skip < 0)
+                params.skip = 0;
+            else if (params.skip > 5000)
+                params.skip = 5000;
+            filters.push(`skip: ${params.skip}`);
+        }
+        if (params.where) {
+            const sWhere = this.buildJsonQuery(params.where);
+            if (sWhere.length > 0)
+                filters.push(`where: {${sWhere}}`);
+        }
+        if (params.block) {
+            const sBlock = this.buildJsonQuery(params.block);
+            if (sBlock.length > 0)
+                filters.push(`block: {${sBlock}}`);
+        }
+        const filterString = filters.join(', ');
+        if (filterString.length > 0)
+            return `${collection}(${filterString}) {${params.elements.join(' ')}}`;
+        else
+            return `${collection} {${params.elements.join(' ')}}`;
+    }
+    static makeFullQuery(query) {
+        return `query MyQuery {${query}}`;
+    }
+}
+exports.default = QueryBuilder;

package/lib/type.d.ts

@@ -0,0 +1,19 @@
+export type QueryJson = {
+    [key: string]: QueryJson | string | number | boolean | undefined;
+};
+export type BlockQuery = {
+    hash?: string;
+    number?: number;
+    number_gte?: number;
+};
+export interface GraphParams {
+    elements: Array<string>;
+    where?: QueryJson;
+    id?: string;
+    first?: number;
+    orderBy?: string;
+    orderDirection?: 'asc' | 'desc';
+    skip?: number;
+    subgraphError?: 'allow' | 'deny';
+    block?: BlockQuery;
+}

package/lib/type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eth-graph-query",
-  "version": "1.0.0",
-  "description": "simple package for create query command to graph database in ethereum",
+  "version": "1.0.1",
+  "description": "simple package for create query command to the GraphQL in ethereum",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
@@ -9,14 +9,19 @@
   ],
   "scripts": {
     "build": "tsc",
-    "prepare": "npm run build"
+    "prepare": "npm run build && husky install",
+    "tape": "tape -r ts-node/register",
+    "test:node": "npm run tape -- test/*.spec.ts",
+    "test": "npm run test:node",
+    "eslint": "eslint . --ext .ts"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/phamhongphuc1999/eth-graph-query.git"
   },
   "keywords": [
-    "graph"
+    "the graph", 
+    "ethereum"
   ],
   "author": "phamhongphuc1999",
   "license": "ISC",
@@ -24,7 +29,47 @@
     "url": "https://github.com/phamhongphuc1999/eth-graph-query/issues"
   },
   "homepage": "https://github.com/phamhongphuc1999/eth-graph-query#readme",
+  "dependencies": {
+    "axios": "^1.4.0"
+  },
   "devDependencies": {
-    "typescript": "^5.1.3"
+    "@commitlint/cli": "^17.6.5",
+    "@commitlint/config-conventional": "^17.6.5",
+    "@types/tape": "^5.6.0",
+    "@typescript-eslint/eslint-plugin": "5.59.6",
+    "dotenv": "^16.1.4",
+    "eslint": "^8.40.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-import-resolver-alias": "^1.1.2",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "husky": "^8.0.3",
+    "lint-staged": "^13.2.2",
+    "prettier": "^2.8.8",
+    "tape": "^5.6.3",
+    "ts-node": "10.9.1",
+    "typescript": "5.0.4"
+  },
+  "contributors": [
+    {
+      "name": "Phạm Hồng Phúc",
+      "email": "phamhongphuc12atm1@gmail.com",
+      "url": "https://github.com/phamhongphuc1999"
+    }
+  ],
+  "engines": {
+    "node": ">=14",
+    "npm": ">=7"
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx}": "eslint --config ./.eslintrc-staged.js --cache --fix",
+    "*.{json,yml,md}": [
+      "prettier --write"
+    ]
   }
 }