eth-graph-query 2.0.15 → 2.0.21

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eth-graph-query",
-  "version": "2.0.15",
-  "description": "simple package for creating query to the GraphQL in ethereum",
+  "version": "2.0.21",
+  "description": "A lightweight and flexible library for building The Graph queries using simple JSON objects. Eliminate the need for complex string concatenation and maintain type-safe queries.",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
@@ -9,14 +9,16 @@
   "files": [
     "dist"
   ],
+  "sideEffects": false,
   "scripts": {
-    "build": "npm run clear && tsc && vite build",
+    "build": "bun run clear && tsc && vite build",
     "preview": "vite preview",
     "clear": "rm -rf dist",
     "test": "vitest run",
-    "prepare": "npm run build && husky install",
-    "eslint": "eslint . --ext .ts",
-    "prepublishOnly": "npm run clear && npm run build && npm run test"
+    "prepare": "bun run build && husky install",
+    "eslint": "eslint --config ./eslint.config.js --cache",
+    "format": "prettier --write .",
+    "prepublishOnly": "bun run clear && bun run build && bun run test"
   },
   "repository": {
     "type": "git",
@@ -32,29 +34,28 @@
     "url": "https://github.com/phamhongphuc1999/eth-graph-query/issues"
   },
   "homepage": "https://github.com/phamhongphuc1999/eth-graph-query#readme",
-  "dependencies": {
-    "axios": "^1.6.8"
+  "peerDependencies": {
+    "axios": "^1.13.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.6.5",
-    "@commitlint/config-conventional": "^17.6.5",
-    "@rollup/plugin-typescript": "^11.1.6",
+    "@commitlint/cli": "^19.4.0",
+    "@commitlint/config-conventional": "^19.2.2",
+    "@eslint/js": "^9.29.0",
     "@types/node": "^20.12.2",
-    "@typescript-eslint/eslint-plugin": "5.59.6",
-    "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",
+    "axios": "^1.13.2",
+    "eslint": "^9.29.0",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-prettier": "^5.5.1",
+    "eslint-plugin-react-hooks": "^5.2.0",
+    "eslint-plugin-react-refresh": "^0.4.20",
+    "husky": "^9.1.6",
     "path": "^0.12.7",
-    "prettier": "^2.8.8",
-    "rollup-plugin-typescript-paths": "^1.5.0",
-    "tslib": "^2.6.2",
-    "typescript": "^5.2.2",
-    "vite": "^5.2.0",
-    "vitest": "^1.4.0"
+    "typescript": "5.5.3",
+    "typescript-eslint": "^8.34.1",
+    "vite": "^7.2.7",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^4.0.15"
   },
   "contributors": [
     {
@@ -64,18 +65,12 @@
     }
   ],
   "engines": {
-    "node": ">=16",
-    "npm": ">=7"
+    "node": ">=20",
+    "npm": ">=10"
   },
   "commitlint": {
     "extends": [
       "@commitlint/config-conventional"
     ]
-  },
-  "lint-staged": {
-    "*.{js,jsx,ts,tsx}": "eslint --config ./.eslintrc-staged.cjs --cache --fix",
-    "*.{json,yml,md}": [
-      "prettier --write"
-    ]
   }
 }

package/dist/api-query.d.ts

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

package/dist/eth-graph-query.d.ts

@@ -1,34 +0,0 @@
-import { AxiosRequestConfig } from 'axios';
-import { ApiQuery } from './api-query';
-import { GraphObject, Metadata } from './type';
-export declare class EthGraphQuery extends ApiQuery {
-    queryName: string;
-    /**
-     * The constructor for create a query instance.
-     * @param {string} rootUrl The url leading to the graph
-     * @param {AxiosRequestConfig | undefined} config Config for base axios
-     */
-    constructor(rootUrl: string, config?: AxiosRequestConfig);
-    /**
-     * Given query string, returns the data respective with it.
-     * @param {string} query A query string containing all data you want to fetch
-     * @returns The data respective with the query string
-     */
-    stringQuery<T = any>(data: string): Promise<T>;
-    /**
-     * Create a query to a particular collection, returns the data respective with the query data.
-     * @param {GraphObject} data An data for create query, contains two elements:
-     *    1. collection: string - collection name
-     *    2. params: GraphParams | undefined - If it is defined, it create a query to the collection
-     * @param {Metadata | undefined} metadata If it is defined, the query can get metadata that you defined
-     * @returns The data respective with the query data
-     */
-    query<T = any>(data: GraphObject, metadata?: Metadata): Promise<T>;
-    /**
-     * Create a query to many collections, returns the data respective with the query data.
-     * @param {Array<GraphObject>} data An array contain data to query to many collections
-     * @param {Metadata | undefined} metadata If it is defined, the query can get metadata that you defined
-     * @returns The data respective with the query data
-     */
-    multipleQuery<T = any>(data: Array<GraphObject>, metadata?: Metadata): Promise<T>;
-}

package/dist/query-builder.d.ts

@@ -1,51 +0,0 @@
-import { ElementType, GraphObject, InlineFragmentType, Metadata, QueryJson } from './type';
-export declare class QueryBuilder {
-    /**
-     * Create a query string from a query with json format.
-     * @param {QueryJson} query the json format query
-     * @returns a query string respective with the json format query
-     */
-    static buildJsonQuery(query: QueryJson): string;
-    /**
-     * Given a json format array as element input, returns the string array represent elements you want to query in the graph.
-     * @param {Array<ElementType>} elements A array with {@link ElementType} elements, each element in the array represent a element in the graph you want to query
-     * @returns {Array<string>} The string array represent the input array
-     */
-    static buildElements(elements: Array<ElementType>): Array<string>;
-    /**
-     * Given a instance of {@link Metadata}, returns the string represent the metadata you want to query
-     * @param {Metadata} metadata The instance represent all metadata you want to query
-     * @returns The string represent the metadata you want to query
-     */
-    static buildMetadata(metadata: Metadata): string;
-    private static _buildInlineFragment;
-    /**
-     * Given a instance of Array<{@link InlineFragmentType}>, returns the string represent the inline fragments you want to query
-     * @param {Array<InlineFragmentType>} fragments The instance represent the inline fragments you want to query
-     * @returns The string represent the inline fragments you want to query
-     */
-    static buildInlineFragments(fragments: Array<InlineFragmentType>): string;
-    /**
-     * Given json data, returns the string query. This function only can create a string query for a particular collection.
-     * @param {GraphObject} data An data for create query, contains two elements:
-     *   1. collection: string - collection name
-     *   2. params: GraphParams | undefined - If it is defined, it create a query to the collection
-     * @param {Metadata | undefined} metadata If it is defined, the query can get metadata that you defined
-     * @returns The string query
-     */
-    static buildQuery(data: GraphObject, metadata?: Metadata): string;
-    /**
-     * Given a array contain many json data, return a query string represent a query to all collections that is in a array.
-     * @param {Array<GraphObject>} data An array contain data to query to many collections
-     * @param {Metadata | undefined} metadata If it is defined, the query can get metadata that you defined
-     * @returns The query string
-     */
-    static buildMultipleQuery(data: Array<GraphObject>, metadata?: Metadata): string;
-    /**
-     * Create complete query string, you can use directly this query to query to the graph
-     * @param {string} query The query string
-     * @param {string} queryName The query name(default query)
-     * @returns The complete query string
-     */
-    static makeFullQuery(query: string, queryName?: string): string;
-}

package/dist/type.d.ts

@@ -1,66 +0,0 @@
-type BaseQueryType = Array<string | number | boolean> | string | number | boolean | null | undefined;
-export declare const OptionKeys: string[];
-export type TextWhereOptions = {
-    $contains?: BaseQueryType;
-    $contains_nocase?: BaseQueryType;
-    $ends_with?: BaseQueryType;
-    $end_with_nocase?: BaseQueryType;
-    $starts_with?: BaseQueryType;
-    $starts_with_nocase?: BaseQueryType;
-    $not_contains?: BaseQueryType;
-    $not_contains_nocase?: BaseQueryType;
-    $not_ends_with?: BaseQueryType;
-    $not_ends_with_nocase?: BaseQueryType;
-    $not_starts_with?: BaseQueryType;
-    $not_starts_with_nocase?: BaseQueryType;
-};
-export type CommonWhereOptions = {
-    $gt?: BaseQueryType;
-    $gte?: BaseQueryType;
-    $lt?: BaseQueryType;
-    $lte?: BaseQueryType;
-    $not?: BaseQueryType;
-    $in?: BaseQueryType;
-    $not_in?: BaseQueryType;
-};
-export type WhereOptions = TextWhereOptions & CommonWhereOptions;
-export type QueryJson = {
-    [key: string]: QueryJson | WhereOptions | BaseQueryType;
-};
-export type BlockQuery = {
-    hash?: string;
-    number?: number;
-    number_gte?: number;
-};
-export type Metadata = {
-    elements?: Array<'deployment' | 'hasIndexingErrors' | 'hash' | 'number' | 'timestamp'>;
-    blockQuery?: BlockQuery;
-};
-export type ElementType = string | GraphObject;
-export type InlineFragmentType = {
-    collection: string;
-    params?: Pick<GraphParams, 'elements'>;
-};
-export interface GraphParams {
-    elements?: Array<ElementType>;
-    inlineFragments?: Array<InlineFragmentType>;
-    where?: QueryJson;
-    id?: string;
-    first?: number;
-    orderBy?: string;
-    orderDirection?: 'asc' | 'desc';
-    skip?: number;
-    subgraphError?: 'allow' | 'deny';
-    block?: BlockQuery;
-}
-export interface GraphObject {
-    collection: string;
-    params?: GraphParams;
-}
-export type ErrorObject = {
-    errors: Array<{
-        message: string;
-        locations: Array<unknown>;
-    }>;
-};
-export {};