eth-graph-query 1.0.2 → 1.0.6

package/README.md

@@ -2,7 +2,7 @@
 eth-graph-query
 </h1>
 
-Simple package for create query command to the GraphQL in ethereum
+Simple package for create query to [the GraphQL](https://thegraph.com/).
 
 ---
 
@@ -13,11 +13,17 @@ npm install eth-graph-query
 
 ```
 
+- Or if you use `yarn`
+
+```shell
+yarn add eth-graph-query
+```
+
 ---
 
 ### Usage
 
-- The first thing you have to do is create a query instance
+- The first thing you have to do is creating a query instance
 
 ```js
 const query = new EthGraphQuery(root);
@@ -33,13 +39,40 @@ const result = await query.query('collection1', { elements: ['element1', 'elemen
 
 ```js
 const result = await query.mergeQuery([
-  {collection: 'collection1', {element: ['element11', 'element12']}},
-  {collection: 'collection2', {element: ['element21', 'element22']}}
-])
+  { collection: 'collection1', params: { elements: ['element11', 'element12'] } },
+  { collection: 'collection2', params: { elements: ['element21', 'element22'] } },
+]);
+```
+
+- You can create a complex query
+
+```js
+const result1 = await query.mergeQuery([
+  { collection: 'collection1', params: { elements: ['element11', 'element12'], where: { element11: 'abc' } } },
+  {
+    collection: 'collection2',
+    params: {
+      elements: [
+        'element21',
+        {
+          collection: 'collection3',
+          params: { elements: ['element31'], where: { id: { in: ['123'] }, element31: 'element31' }, first: 50 },
+        },
+      ],
+      where: { element21: '123', collection3: { element31: '123' } },
+    },
+  },
+]);
 ```
 
 ---
 
+### API
+
+Read the [API Docs](https://github.com/phamhongphuc1999/eth-graph-query/blob/main/docs/api.md)
+
+---
+
 ### For develop
 
 - To test package, you can run below command

package/dist/cjs/index.d.ts

@@ -1,12 +1,16 @@
 import { AxiosRequestConfig } from 'axios';
 import NormalQuery from './normal-query';
-import { GraphParams } from './type';
+import { GraphParams, Metadata } from './type';
 export default class EthGraphQuery extends NormalQuery {
+    queryName: string;
     constructor(rootUrl: string, config?: AxiosRequestConfig);
-    private _fetch;
-    query(collection: string, params?: GraphParams): Promise<any>;
-    mergeQuery(data: Array<{
+    protected _fetch<T>(query: string): Promise<T>;
+    query<T = any>(data: {
         collection: string;
         params?: GraphParams;
-    }>): Promise<any>;
+    }, metadata?: Metadata): Promise<T>;
+    mergeQuery<T = any>(data: Array<{
+        collection: string;
+        params?: GraphParams;
+    }>, metadata?: Metadata): Promise<T>;
 }

package/dist/cjs/index.js

@@ -5,17 +5,18 @@ const query_builder_1 = require("./query-builder");
 class EthGraphQuery extends normal_query_1.default {
     constructor(rootUrl, config) {
         super(rootUrl, config);
+        this.queryName = 'query';
     }
     async _fetch(query) {
         return await this.post('', { query: query });
     }
-    async query(collection, params) {
-        const sQuery = query_builder_1.default.buildQuery(collection, params);
-        return await this._fetch(query_builder_1.default.makeFullQuery(sQuery));
+    async query(data, metadata) {
+        const sQuery = query_builder_1.default.buildQuery({ collection: data.collection, params: data.params }, metadata);
+        return await this._fetch(query_builder_1.default.makeFullQuery(sQuery, this.queryName));
     }
-    async mergeQuery(data) {
-        const sQuery = query_builder_1.default.mergeQuery(data);
-        return await this._fetch(query_builder_1.default.makeFullQuery(sQuery));
+    async mergeQuery(data, metadata) {
+        const sQuery = query_builder_1.default.mergeQuery(data, metadata);
+        return await this._fetch(query_builder_1.default.makeFullQuery(sQuery, this.queryName));
     }
 }
 exports.default = EthGraphQuery;

package/dist/cjs/normal-query.d.ts

@@ -7,8 +7,8 @@ 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>;
+    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/cjs/query-builder.d.ts

@@ -1,10 +1,16 @@
-import { GraphParams, QueryJson } from './type';
+import { ElementType, GraphParams, Metadata, QueryJson } from './type';
 export default class QueryBuilder {
+    private static isWhereOptions;
     static buildJsonQuery(query: QueryJson): string;
-    static buildQuery(collection: string, params?: GraphParams): string;
+    static buildElements(elements: Array<ElementType>): Array<string>;
+    static buildMetadata(metadata: Metadata): string;
+    static buildQuery(data: {
+        collection: string;
+        params?: GraphParams;
+    }, metadata?: Metadata): string;
     static mergeQuery(data: Array<{
         collection: string;
         params?: GraphParams;
-    }>): string;
-    static makeFullQuery(query: string): string;
+    }>, metadata?: Metadata): string;
+    static makeFullQuery(query: string, queryName?: string): string;
 }

package/dist/cjs/query-builder.js

@@ -1,6 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const type_1 = require("./type");
 class QueryBuilder {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    static isWhereOptions(data) {
+        const keys = Object.keys(data);
+        if (keys.length == 0)
+            return true;
+        for (const key of keys) {
+            if (!type_1.OptionKeys.includes(key))
+                return false;
+        }
+        return true;
+    }
     static buildJsonQuery(query) {
         const whereList = [];
         for (const key in query) {
@@ -9,6 +21,16 @@ class QueryBuilder {
                     const queryArray = query[key];
                     whereList.push(`${key}: [${queryArray.map((item) => `"${item}"`).join(', ')}]`);
                 }
+                else if (this.isWhereOptions(query[key])) {
+                    const realJson = {};
+                    const options = query[key];
+                    for (const option in options) {
+                        const value = options[option];
+                        if (value)
+                            realJson[`${key}_${option}`] = value;
+                    }
+                    whereList.push(`${this.buildJsonQuery(realJson)}`);
+                }
                 else if (typeof query[key] == 'object')
                     whereList.push(`${key}: {${this.buildJsonQuery(query[key])}}`);
                 else if (typeof query[key] == 'string')
@@ -19,7 +41,59 @@ class QueryBuilder {
         }
         return whereList.join(', ');
     }
-    static buildQuery(collection, params) {
+    static buildElements(elements) {
+        const elementList = [];
+        for (const element of elements) {
+            if (typeof element == 'string')
+                elementList.push(element);
+            else {
+                const object = element;
+                elementList.push(this.buildQuery({ collection: object.collection, params: object.params }));
+            }
+        }
+        return elementList;
+    }
+    static buildMetadata(metadata) {
+        let result = '';
+        const blockQuery = [];
+        if (metadata.blockQuery) {
+            if (metadata.blockQuery.hash)
+                blockQuery.push(`hash: "${metadata.blockQuery.hash}"`);
+            if (metadata.blockQuery.number)
+                blockQuery.push(`number: ${metadata.blockQuery.number}`);
+            if (metadata.blockQuery.number_gte)
+                blockQuery.push(`number_gte: ${metadata.blockQuery.number_gte}`);
+        }
+        const sBlockQuery = blockQuery.join(', ');
+        if (sBlockQuery.length > 0)
+            result += `(block: {${sBlockQuery}})`;
+        const filters = [];
+        const blockFilters = [];
+        if (metadata.elements) {
+            for (const filter of metadata.elements) {
+                if (filter == 'deployment' || filter == 'hasIndexingErrors') {
+                    const sFilter = filter.toString();
+                    if (!filters.includes(sFilter))
+                        filters.push(sFilter);
+                }
+                else {
+                    const sFilter = filter.toString();
+                    if (!blockFilters.includes(sFilter))
+                        blockFilters.push(sFilter);
+                }
+            }
+            const blockFilterQuery = blockFilters.join(' ');
+            if (blockFilterQuery.length > 0)
+                filters.push(`block{${blockFilterQuery}}`);
+            const sFiltersQuery = filters.join(' ');
+            if (sFiltersQuery.length > 0)
+                result += `{${sFiltersQuery}}`;
+        }
+        return result.length > 0 ? `_meta${result}` : '';
+    }
+    static buildQuery(data, metadata) {
+        const collection = data.collection;
+        const params = data.params;
         const filters = [];
         if (params?.id != undefined)
             filters.push(`id: ${params.id}`);
@@ -55,20 +129,37 @@ class QueryBuilder {
         let elements = ['id'];
         if (params?.elements)
             if (params.elements.length > 0)
-                elements = params.elements;
+                elements = this.buildElements(params.elements);
+        let finalQuery = '';
         if (filterString.length > 0)
-            return `${collection}(${filterString}) {${elements.join(' ')}}`;
+            finalQuery = `${collection}(${filterString}) {${elements.join(' ')}}`;
         else
-            return `${collection} {${elements.join(' ')}}`;
+            finalQuery = `${collection} {${elements.join(' ')}}`;
+        if (metadata) {
+            const sMetadata = this.buildMetadata(metadata);
+            if (sMetadata.length > 0)
+                return `${sMetadata} ${finalQuery}`;
+            else
+                return finalQuery;
+        }
+        return finalQuery;
     }
-    static mergeQuery(data) {
+    static mergeQuery(data, metadata) {
         const queries = [];
         for (const item of data)
-            queries.push(this.buildQuery(item.collection, item.params));
-        return queries.join(' ');
+            queries.push(this.buildQuery({ collection: item.collection, params: item.params }));
+        const finalQuery = queries.join(' ');
+        if (metadata) {
+            const sMetadata = this.buildMetadata(metadata);
+            if (sMetadata.length > 0)
+                return `${sMetadata} ${finalQuery}`;
+            else
+                return finalQuery;
+        }
+        return finalQuery;
     }
-    static makeFullQuery(query) {
-        return `query MyQuery {${query}}`;
+    static makeFullQuery(query, queryName = 'query') {
+        return `query ${queryName} {${query}}`;
     }
 }
 exports.default = QueryBuilder;

package/dist/cjs/type.d.ts

@@ -1,13 +1,48 @@
+type BaseQueryType = Array<string> | string | number | boolean | undefined;
+export declare const OptionKeys: string[];
+export type OptionsKey = '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';
+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 | Array<string> | string | number | boolean | undefined;
+    [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 | {
+    collection: string;
+    params?: GraphParams;
+};
 export interface GraphParams {
-    elements?: Array<string>;
+    elements?: Array<ElementType>;
     where?: QueryJson;
     id?: string;
     first?: number;
@@ -17,3 +52,4 @@ export interface GraphParams {
     subgraphError?: 'allow' | 'deny';
     block?: BlockQuery;
 }
+export {};

package/dist/cjs/type.js

@@ -1,2 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.OptionKeys = void 0;
+exports.OptionKeys = [
+    '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',
+];

package/dist/esm/index.d.ts

@@ -1,12 +1,16 @@
 import { AxiosRequestConfig } from 'axios';
 import NormalQuery from './normal-query';
-import { GraphParams } from './type';
+import { GraphParams, Metadata } from './type';
 export default class EthGraphQuery extends NormalQuery {
+    queryName: string;
     constructor(rootUrl: string, config?: AxiosRequestConfig);
-    private _fetch;
-    query(collection: string, params?: GraphParams): Promise<any>;
-    mergeQuery(data: Array<{
+    protected _fetch<T>(query: string): Promise<T>;
+    query<T = any>(data: {
         collection: string;
         params?: GraphParams;
-    }>): Promise<any>;
+    }, metadata?: Metadata): Promise<T>;
+    mergeQuery<T = any>(data: Array<{
+        collection: string;
+        params?: GraphParams;
+    }>, metadata?: Metadata): Promise<T>;
 }

package/dist/esm/index.js

@@ -3,16 +3,17 @@ import QueryBuilder from './query-builder';
 export default class EthGraphQuery extends NormalQuery {
     constructor(rootUrl, config) {
         super(rootUrl, config);
+        this.queryName = 'query';
     }
     async _fetch(query) {
         return await this.post('', { query: query });
     }
-    async query(collection, params) {
-        const sQuery = QueryBuilder.buildQuery(collection, params);
-        return await this._fetch(QueryBuilder.makeFullQuery(sQuery));
+    async query(data, metadata) {
+        const sQuery = QueryBuilder.buildQuery({ collection: data.collection, params: data.params }, metadata);
+        return await this._fetch(QueryBuilder.makeFullQuery(sQuery, this.queryName));
     }
-    async mergeQuery(data) {
-        const sQuery = QueryBuilder.mergeQuery(data);
-        return await this._fetch(QueryBuilder.makeFullQuery(sQuery));
+    async mergeQuery(data, metadata) {
+        const sQuery = QueryBuilder.mergeQuery(data, metadata);
+        return await this._fetch(QueryBuilder.makeFullQuery(sQuery, this.queryName));
     }
 }

package/dist/esm/normal-query.d.ts

@@ -7,8 +7,8 @@ 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>;
+    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/esm/query-builder.d.ts

@@ -1,10 +1,16 @@
-import { GraphParams, QueryJson } from './type';
+import { ElementType, GraphParams, Metadata, QueryJson } from './type';
 export default class QueryBuilder {
+    private static isWhereOptions;
     static buildJsonQuery(query: QueryJson): string;
-    static buildQuery(collection: string, params?: GraphParams): string;
+    static buildElements(elements: Array<ElementType>): Array<string>;
+    static buildMetadata(metadata: Metadata): string;
+    static buildQuery(data: {
+        collection: string;
+        params?: GraphParams;
+    }, metadata?: Metadata): string;
     static mergeQuery(data: Array<{
         collection: string;
         params?: GraphParams;
-    }>): string;
-    static makeFullQuery(query: string): string;
+    }>, metadata?: Metadata): string;
+    static makeFullQuery(query: string, queryName?: string): string;
 }

package/dist/esm/query-builder.js

@@ -1,4 +1,16 @@
+import { OptionKeys } from './type';
 export default class QueryBuilder {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    static isWhereOptions(data) {
+        const keys = Object.keys(data);
+        if (keys.length == 0)
+            return true;
+        for (const key of keys) {
+            if (!OptionKeys.includes(key))
+                return false;
+        }
+        return true;
+    }
     static buildJsonQuery(query) {
         const whereList = [];
         for (const key in query) {
@@ -7,6 +19,16 @@ export default class QueryBuilder {
                     const queryArray = query[key];
                     whereList.push(`${key}: [${queryArray.map((item) => `"${item}"`).join(', ')}]`);
                 }
+                else if (this.isWhereOptions(query[key])) {
+                    const realJson = {};
+                    const options = query[key];
+                    for (const option in options) {
+                        const value = options[option];
+                        if (value)
+                            realJson[`${key}_${option}`] = value;
+                    }
+                    whereList.push(`${this.buildJsonQuery(realJson)}`);
+                }
                 else if (typeof query[key] == 'object')
                     whereList.push(`${key}: {${this.buildJsonQuery(query[key])}}`);
                 else if (typeof query[key] == 'string')
@@ -17,7 +39,59 @@ export default class QueryBuilder {
         }
         return whereList.join(', ');
     }
-    static buildQuery(collection, params) {
+    static buildElements(elements) {
+        const elementList = [];
+        for (const element of elements) {
+            if (typeof element == 'string')
+                elementList.push(element);
+            else {
+                const object = element;
+                elementList.push(this.buildQuery({ collection: object.collection, params: object.params }));
+            }
+        }
+        return elementList;
+    }
+    static buildMetadata(metadata) {
+        let result = '';
+        const blockQuery = [];
+        if (metadata.blockQuery) {
+            if (metadata.blockQuery.hash)
+                blockQuery.push(`hash: "${metadata.blockQuery.hash}"`);
+            if (metadata.blockQuery.number)
+                blockQuery.push(`number: ${metadata.blockQuery.number}`);
+            if (metadata.blockQuery.number_gte)
+                blockQuery.push(`number_gte: ${metadata.blockQuery.number_gte}`);
+        }
+        const sBlockQuery = blockQuery.join(', ');
+        if (sBlockQuery.length > 0)
+            result += `(block: {${sBlockQuery}})`;
+        const filters = [];
+        const blockFilters = [];
+        if (metadata.elements) {
+            for (const filter of metadata.elements) {
+                if (filter == 'deployment' || filter == 'hasIndexingErrors') {
+                    const sFilter = filter.toString();
+                    if (!filters.includes(sFilter))
+                        filters.push(sFilter);
+                }
+                else {
+                    const sFilter = filter.toString();
+                    if (!blockFilters.includes(sFilter))
+                        blockFilters.push(sFilter);
+                }
+            }
+            const blockFilterQuery = blockFilters.join(' ');
+            if (blockFilterQuery.length > 0)
+                filters.push(`block{${blockFilterQuery}}`);
+            const sFiltersQuery = filters.join(' ');
+            if (sFiltersQuery.length > 0)
+                result += `{${sFiltersQuery}}`;
+        }
+        return result.length > 0 ? `_meta${result}` : '';
+    }
+    static buildQuery(data, metadata) {
+        const collection = data.collection;
+        const params = data.params;
         const filters = [];
         if (params?.id != undefined)
             filters.push(`id: ${params.id}`);
@@ -53,19 +127,36 @@ export default class QueryBuilder {
         let elements = ['id'];
         if (params?.elements)
             if (params.elements.length > 0)
-                elements = params.elements;
+                elements = this.buildElements(params.elements);
+        let finalQuery = '';
         if (filterString.length > 0)
-            return `${collection}(${filterString}) {${elements.join(' ')}}`;
+            finalQuery = `${collection}(${filterString}) {${elements.join(' ')}}`;
         else
-            return `${collection} {${elements.join(' ')}}`;
+            finalQuery = `${collection} {${elements.join(' ')}}`;
+        if (metadata) {
+            const sMetadata = this.buildMetadata(metadata);
+            if (sMetadata.length > 0)
+                return `${sMetadata} ${finalQuery}`;
+            else
+                return finalQuery;
+        }
+        return finalQuery;
     }
-    static mergeQuery(data) {
+    static mergeQuery(data, metadata) {
         const queries = [];
         for (const item of data)
-            queries.push(this.buildQuery(item.collection, item.params));
-        return queries.join(' ');
+            queries.push(this.buildQuery({ collection: item.collection, params: item.params }));
+        const finalQuery = queries.join(' ');
+        if (metadata) {
+            const sMetadata = this.buildMetadata(metadata);
+            if (sMetadata.length > 0)
+                return `${sMetadata} ${finalQuery}`;
+            else
+                return finalQuery;
+        }
+        return finalQuery;
     }
-    static makeFullQuery(query) {
-        return `query MyQuery {${query}}`;
+    static makeFullQuery(query, queryName = 'query') {
+        return `query ${queryName} {${query}}`;
     }
 }

package/dist/esm/type.d.ts

@@ -1,13 +1,48 @@
+type BaseQueryType = Array<string> | string | number | boolean | undefined;
+export declare const OptionKeys: string[];
+export type OptionsKey = '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';
+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 | Array<string> | string | number | boolean | undefined;
+    [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 | {
+    collection: string;
+    params?: GraphParams;
+};
 export interface GraphParams {
-    elements?: Array<string>;
+    elements?: Array<ElementType>;
     where?: QueryJson;
     id?: string;
     first?: number;
@@ -17,3 +52,4 @@ export interface GraphParams {
     subgraphError?: 'allow' | 'deny';
     block?: BlockQuery;
 }
+export {};