eth-graph-query 2.0.20 → 2.0.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eth-graph-query",
-  "version": "2.0.20",
+  "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",
@@ -9,15 +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",
+    "prepare": "bun run build && husky install",
     "eslint": "eslint --config ./eslint.config.js --cache",
     "format": "prettier --write .",
-    "prepublishOnly": "npm run clear && npm run build && npm run test"
+    "prepublishOnly": "bun run clear && bun run build && bun run test"
   },
   "repository": {
     "type": "git",
@@ -33,15 +34,15 @@
     "url": "https://github.com/phamhongphuc1999/eth-graph-query/issues"
   },
   "homepage": "https://github.com/phamhongphuc1999/eth-graph-query#readme",
-  "dependencies": {
+  "peerDependencies": {
     "axios": "^1.13.2"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.4.0",
     "@commitlint/config-conventional": "^19.2.2",
     "@eslint/js": "^9.29.0",
-    "@rollup/plugin-typescript": "^11.1.6",
     "@types/node": "^20.12.2",
+    "axios": "^1.13.2",
     "eslint": "^9.29.0",
     "eslint-import-resolver-typescript": "^4.4.4",
     "eslint-plugin-import": "^2.32.0",
@@ -50,11 +51,10 @@
     "eslint-plugin-react-refresh": "^0.4.20",
     "husky": "^9.1.6",
     "path": "^0.12.7",
-    "rollup-plugin-typescript-paths": "^1.5.0",
-    "tslib": "^2.6.2",
     "typescript": "5.5.3",
     "typescript-eslint": "^8.34.1",
     "vite": "^7.2.7",
+    "vite-plugin-dts": "^4.5.4",
     "vitest": "^4.0.15"
   },
   "contributors": [

package/dist/api-query.d.ts

@@ -1,67 +0,0 @@
-import { AxiosRequestConfig } from 'axios';
-export declare const defaultHeader: {
-    Accept: string;
-    'Content-Type': string;
-};
-/**
- * Base class for handling API requests using axios.
- * Provides protected methods for common HTTP verbs.
- */
-export declare class ApiQuery {
-    /** The root URL for all API requests. */
-    root: string;
-    /** Axios configuration used for all requests. */
-    config: AxiosRequestConfig;
-    /**
-     * Initializes a new instance of the ApiQuery class.
-     * @param rootUrl - The base URL for the API.
-     * @param config - Optional axios configuration.
-     */
-    constructor(rootUrl: string, config?: AxiosRequestConfig);
-    /**
-     * Performs an API request.
-     * @template T - The expected response type.
-     * @param method - The HTTP method to use.
-     * @param url - The relative URL for the request.
-     * @param data - The request payload (for POST, PUT).
-     * @param config - Optional axios configuration to override defaults.
-     * @returns A promise that resolves to the response data.
-     */
-    private request;
-    /**
-     * Performs a GET request.
-     * @template T - The expected response type.
-     * @param url - The relative URL for the request.
-     * @param config - Optional axios configuration to override defaults.
-     * @returns A promise that resolves to the response data.
-     */
-    protected get<T = any>(url: string, config?: AxiosRequestConfig): Promise<T>;
-    /**
-     * Performs a POST request.
-     * @template B - The request body type.
-     * @template T - The expected response type.
-     * @param url - The relative URL for the request.
-     * @param data - The request payload.
-     * @param config - Optional axios configuration to override defaults.
-     * @returns A promise that resolves to the response data.
-     */
-    protected post<B = any, T = any>(url: string, data?: B, config?: AxiosRequestConfig): Promise<T>;
-    /**
-     * Performs a PUT request.
-     * @template B - The request body type.
-     * @template T - The expected response type.
-     * @param url - The relative URL for the request.
-     * @param data - The request payload.
-     * @param config - Optional axios configuration to override defaults.
-     * @returns A promise that resolves to the response data.
-     */
-    protected put<B = any, T = any>(url: string, data?: B, config?: AxiosRequestConfig): Promise<T>;
-    /**
-     * Performs a DELETE request.
-     * @template T - The expected response type.
-     * @param url - The relative URL for the request.
-     * @param config - Optional axios configuration to override defaults.
-     * @returns A promise that resolves to the response data.
-     */
-    protected del<T = any>(url: string, config?: AxiosRequestConfig): Promise<T>;
-}

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

@@ -1,41 +0,0 @@
-import { AxiosRequestConfig } from 'axios';
-import { ApiQuery } from './api-query';
-import { GraphObject, Metadata } from './type';
-/**
- * Main class for performing queries against The Graph protocols.
- * Extends ApiQuery to handle HTTP communication.
- */
-export declare class EthGraphQuery extends ApiQuery {
-    /** The name of the GraphQL query, used in makeFullQuery. */
-    queryName: string;
-    /**
-     * Initializes a new EthGraphQuery instance.
-     * @param rootUrl - The endpoint URL of the subgraph.
-     * @param config - Optional axios configuration for custom headers or timeouts.
-     */
-    constructor(rootUrl: string, config?: AxiosRequestConfig);
-    /**
-     * Executes a raw GraphQL query string.
-     * @template T - The expected return type of the data.
-     * @param data - The raw GraphQL query string.
-     * @returns A promise resolving to the query result.
-     * @throws Error if the response contains any GraphQL errors.
-     */
-    stringQuery<T = any>(data: string): Promise<T>;
-    /**
-     * Executes a single collection query using a JSON configuration.
-     * @template T - The expected return type of the data.
-     * @param data - The configuration for the collection query.
-     * @param metadata - Optional metadata fields to include in the query.
-     * @returns A promise resolving to the fetched data.
-     */
-    query<T = any>(data: GraphObject, metadata?: Metadata): Promise<T>;
-    /**
-     * Executes multiple collection queries in a single request using JSON configurations.
-     * @template T - The expected return type of the data.
-     * @param data - An array of query configurations.
-     * @param metadata - Optional metadata fields to include in the query.
-     * @returns A promise resolving to the merged results of all queries.
-     */
-    multipleQuery<T = any>(data: Array<GraphObject>, metadata?: Metadata): Promise<T>;
-}

package/dist/query-builder.d.ts

@@ -1,56 +0,0 @@
-import { ElementType, GraphObject, InlineFragmentType, Metadata, QueryJson } from './type';
-export declare class QueryBuilder {
-    /**
-     * Converts a JSON query object into a GraphQL-compatible string.
-     * Handles nested objects and operator mapping (e.g., $gt -> _gt).
-     * @param query - The JSON filter object to build.
-     * @returns A string representing the GraphQL 'where' or 'block' filter.
-     */
-    static buildJsonQuery(query: QueryJson): string;
-    /**
-     * Builds the fields/elements part of a GraphQL query from an array of strings or objects.
-     * @param elements - An array of fields to query. Can include nested collections as GraphObject.
-     * @returns An array of strings representing the selected fields.
-     */
-    static buildElements(elements: Array<ElementType>): Array<string>;
-    /**
-     * Builds the metadata (_meta) fragment of a GraphQL query.
-     * @param metadata - The metadata configuration.
-     * @returns A string representing the _meta query fragment.
-     */
-    static buildMetadata(metadata: Metadata): string;
-    /**
-     * Builds an inline fragment (... on Collection { ... }) for a query.
-     * @param fragment - The inline fragment configuration.
-     * @returns A string representing the inline fragment.
-     * @private
-     */
-    private static _buildInlineFragment;
-    /**
-     * Builds multiple inline fragments from an array of fragment configurations.
-     * @param fragments - An array of inline fragments.
-     * @returns A string containing all built inline fragments.
-     */
-    static buildInlineFragments(fragments: Array<InlineFragmentType>): string;
-    /**
-     * Builds a complete GraphQL query for a single collection.
-     * @param data - The collection and parameters for the query.
-     * @param metadata - Optional metadata configuration.
-     * @returns A string containing the GraphQL query for the collection.
-     */
-    static buildQuery(data: GraphObject, metadata?: Metadata): string;
-    /**
-     * Builds a query that targets multiple collections simultaneously.
-     * @param data - An array of collection queries and their parameters.
-     * @param metadata - Optional metadata configuration that applies to the entire query.
-     * @returns A string containing the merged GraphQL query for multiple collections.
-     */
-    static buildMultipleQuery(data: Array<GraphObject>, metadata?: Metadata): string;
-    /**
-     * Wraps a query fragment into a full GraphQL 'query' block.
-     * @param query - The query fragment to wrap.
-     * @param queryName - An optional name for the GraphQL query (defaults to 'query').
-     * @returns The full GraphQL query string.
-     */
-    static makeFullQuery(query: string, queryName?: string): string;
-}

package/dist/type.d.ts

@@ -1,149 +0,0 @@
-/**
- * Base types that can be used in query filters.
- */
-export type BaseQueryType = string | number | boolean | Array<string | number | boolean> | null | undefined;
-/**
- * Valid operator suffixes for The Graph queries (e.g., _gt, _in, _contains).
- */
-export declare const OptionKeys: readonly ["contains", "contains_nocase", "ends_with", "end_with_nocase", "starts_with", "starts_with_nocase", "not_contains", "not_contains_nocase", "not_ends_with", "not_ends_with_nocase", "not_starts_with", "not_starts_with_nocase", "gt", "gte", "lt", "lte", "not", "in", "not_in"];
-/**
- * Type representing the valid operator keys.
- */
-export type OptionKey = (typeof OptionKeys)[number];
-/**
- * Filter options for text-based fields.
- */
-export type TextWhereOptions = {
-    /** Matches values containing the substring. */
-    $contains?: BaseQueryType;
-    /** Case-insensitive contains. */
-    $contains_nocase?: BaseQueryType;
-    /** Matches values ending with the substring. */
-    $ends_with?: BaseQueryType;
-    /** Case-insensitive ends_with. */
-    $end_with_nocase?: BaseQueryType;
-    /** Matches values starting with the substring. */
-    $starts_with?: BaseQueryType;
-    /** Case-insensitive starts_with. */
-    $starts_with_nocase?: BaseQueryType;
-    /** Matches values NOT containing the substring. */
-    $not_contains?: BaseQueryType;
-    /** Case-insensitive not_contains. */
-    $not_contains_nocase?: BaseQueryType;
-    /** Matches values NOT ending with the substring. */
-    $not_ends_with?: BaseQueryType;
-    /** Case-insensitive not_ends_with. */
-    $not_ends_with_nocase?: BaseQueryType;
-    /** Matches values NOT starting with the substring. */
-    $not_starts_with?: BaseQueryType;
-    /** Case-insensitive not_starts_with. */
-    $not_starts_with_nocase?: BaseQueryType;
-};
-/**
- * Common filter options for all field types.
- */
-export type CommonWhereOptions = {
-    /** Greater than. */
-    $gt?: BaseQueryType;
-    /** Greater than or equal to. */
-    $gte?: BaseQueryType;
-    /** Less than. */
-    $lt?: BaseQueryType;
-    /** Less than or equal to. */
-    $lte?: BaseQueryType;
-    /** Not equal to. */
-    $not?: BaseQueryType;
-    /** Included in the provided array. */
-    $in?: BaseQueryType;
-    /** Not included in the provided array. */
-    $not_in?: BaseQueryType;
-};
-/**
- * Combined filter options for a field.
- */
-export type WhereOptions = TextWhereOptions & CommonWhereOptions;
-/**
- * JSON structure representing the 'where' filter in a query.
- * Keys are field names, and values can be primitive values or WhereOptions.
- */
-export type QueryJson = {
-    [key: string]: QueryJson | WhereOptions | BaseQueryType;
-};
-/**
- * Filter for querying data at a specific block.
- */
-export type BlockQuery = {
-    /** Filter by block hash. */
-    hash?: string;
-    /** Filter by exact block number. */
-    number?: number;
-    /** Filter by blocks with number greater than or equal to. */
-    number_gte?: number;
-};
-/**
- * Metadata fields to query from the subgraph (_meta).
- */
-export type Metadata = {
-    /** Specific metadata elements to fetch. */
-    elements?: Array<'deployment' | 'hasIndexingErrors' | 'hash' | 'number' | 'timestamp'>;
-    /** Query metadata for a specific block. */
-    blockQuery?: BlockQuery;
-};
-/**
- * Represents a field in a query. Can be a simple string (field name)
- * or a GraphObject for nested collection queries.
- */
-export type ElementType = string | GraphObject;
-/**
- * Represents an inline fragment for polymorphic types.
- */
-export type InlineFragmentType = {
-    /** The collection name for the fragment (e.g., 'User'). */
-    collection: string;
-    /** Fields to select within the fragment. */
-    params?: Pick<GraphParams, 'elements'>;
-};
-/**
- * Parameters for a collection query.
- */
-export interface GraphParams {
-    /** Fields to select from the collection. */
-    elements?: Array<ElementType>;
-    /** Inline fragments for selecting fields on specific types. */
-    inlineFragments?: Array<InlineFragmentType>;
-    /** Filter conditions for the query. */
-    where?: QueryJson;
-    /** Filter by specific entity ID (shortcut for where: { id: ... }). */
-    id?: string;
-    /** Number of items to return (max 1000). */
-    first?: number;
-    /** Field to sort the results by. */
-    orderBy?: string;
-    /** Direction of the sort (asc or desc). */
-    orderDirection?: 'asc' | 'desc';
-    /** Number of items to skip (max 5000). */
-    skip?: number;
-    /** Re-run the query even if the subgraph has indexing errors. */
-    subgraphError?: 'allow' | 'deny';
-    /** Query the collection state at a specific block. */
-    block?: BlockQuery;
-}
-/**
- * Configuration for a query against a specific collection.
- */
-export interface GraphObject {
-    /** The name of the collection to query (e.g., 'users'). */
-    collection: string;
-    /** Optional parameters for filtering, sorting, and pagination. */
-    params?: GraphParams;
-}
-/**
- * Error structure returned by The Graph API.
- */
-export type ErrorObject = {
-    /** List of errors encountered during query execution. */
-    errors: Array<{
-        message: string;
-        locations: Array<unknown>;
-    }>;
-};