@quicknode/sdk 0.5.0 → 0.5.2

package/README.md

@@ -1,13 +1,15 @@
-![npm](https://img.shields.io/npm/dm/@quicknode/sdk)
-![npm](https://img.shields.io/npm/v/@quicknode/sdk?color=g)
-![Maintenance](https://img.shields.io/maintenance/yes/2022?color=g)
-![NPM](https://img.shields.io/npm/l/@quicknode/sdk?color=g)
-![GitHub issues](https://img.shields.io/github/issues-raw/quiknode-labs/qn-oss?color=g)
-![Discord](https://img.shields.io/discord/880505845090250794?color=g)
-
 # QuickNode SDK
 
-Currently has support for getting started with [Icy Tools GraphQL API](https://developers.icy.tools/) in a blink!
+An SDK from [QuickNode](https://www.quicknode.com/) making it easy for developers to interact with the blockchain.
+
+Currently supports getting started with [Icy Tools GraphQL API](https://developers.icy.tools/) in a blink!
+
+[![npm](https://img.shields.io/npm/dm/@quicknode/sdk)](https://www.npmjs.com/package/@quicknode/sdk)
+[![npm](https://img.shields.io/npm/v/@quicknode/sdk?color=g)](https://www.npmjs.com/package/@quicknode/sdk)
+![Maintenance](https://img.shields.io/maintenance/yes/2022?color=g)
+[![License](https://img.shields.io/npm/l/@quicknode/sdk?color=g)](https://github.com/quiknode-labs/qn-oss/blob/main/LICENSE.txt)
+[![GitHub issues](https://img.shields.io/github/issues-raw/quiknode-labs/qn-oss?color=g)](https://github.com/quiknode-labs/qn-oss/issues)
+[![Discord](https://img.shields.io/discord/880505845090250794?color=g)](https://discord.gg/DkdgEqE)
 
 ## Quick Start
 
@@ -225,6 +227,29 @@ client.nft
   .then((response) => console.log(response));
 ```
 
+### nft.getTrendingNFTCollections
+
+| Argument       | Values                            | Optional | Description                                                                                                                                                                                        | Example                     |
+| -------------- | --------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
+| first          | number                            | ✅       | Number of results to return                                                                                                                                                                        | 10                          |
+| after          | string                            | ✅       | Return results after end cursor                                                                                                                                                                    | YXJyYXljb25uZWN0aW9uOjUwNQ= |
+| orderBy        | TrendingCollectionsOrderByEnum    | ✅       | Sort contracts by average sale price ('AVERAGE'), number of sales ('SALES') or volume ('VOLUME')                                                                                                   | 'AVERAGE'                   |
+| orderDirection | OrderDirectionEnum                | ✅       | Sort results ascending ('ASC') or descending ('DESC')                                                                                                                                              | 'ASC'                       |
+| timePeriod     | TrendingCollectionsTimePeriodEnum | ✅       | Get results from last hour ('ONE_HOUR'), last 12 hours ('TWELVE_HOURS') results, last day ('ONE_DAY') or last 7 days ('SEVEN_DAYS')                                                                | 'ONE_HOUR'                  |
+| timeRange      | DateInputType                     | ✅       | Define the modifier in which `timePeriod` will take action to. It can be equal to ('eq'), greater than ('gt'), greater than or equal to ('gte'), less than ('lt') or less than or equal to ('lte') | 'gt'                        |
+
+```ts
+import { QuickNodeSDK } from '@quicknode/sdk';
+
+const client = new QuickNodeSDK();
+
+client.nft
+  .getTrendingNFTCollections({
+    first: 10,
+  })
+  .then((response) => console.log(response));
+```
+
 ## Pagination
 
 For functions that support pagination, use the `first` property to specify the amount of results to return.
@@ -256,6 +281,10 @@ client.nft.getNFTsByWalletENS({
 
 # Contributing corner
 
+## Issues
+
+Please submit any questions, issues, or feedback as an [issue in Github](https://github.com/quiknode-labs/qn-oss/issues).
+
 ## Building
 
 Run `nx build libs-api-sdk` to build the library.
@@ -267,3 +296,7 @@ Run `nx test libs-api-sdk` to execute the unit tests via [Jest](https://jestjs.i
 ## Running lint
 
 Run `nx lint libs-api-sdk` to execute the lint via [ESLint](https://eslint.org/).
+
+## Generate graphql
+
+Run `yarn codegen` to generate graphql typings via [Codegen](https://www.the-guild.dev/graphql/codegen).

package/package.json

@@ -6,21 +6,29 @@
     "directory": "packages/libs/api/sdk"
   },
   "license": "MIT",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "main": "./src/index.js",
   "module": "./src/index.esm.js",
   "types": "./src/index.d.ts",
   "dependencies": {
     "@apollo/client": "^3.6.9",
-    "graphql": "^16.5.0",
-    "cross-fetch": "^3.1.5"
+    "cross-fetch": "^3.1.5",
+    "graphql": "^16.5.0"
   },
   "devDependencies": {
+    "@graphql-codegen/cli": "2.13.8",
+    "@graphql-codegen/fragment-matcher": "^3.3.1",
+    "@graphql-codegen/typescript": "2.8.0",
+    "@graphql-codegen/typescript-document-nodes": "^2.3.6",
+    "@graphql-codegen/typescript-operations": "^2.5.5",
     "@pollyjs/adapter-node-http": "^6.0.5",
     "@pollyjs/core": "^6.0.5",
     "@pollyjs/persister-fs": "^6.0.5",
-    "@types/supertest": "^2.0.12",
     "@types/node": "16.11.7",
+    "@types/supertest": "^2.0.12",
     "supertest": "^6.2.4"
+  },
+  "scripts": {
+    "codegen": "graphql-codegen --config codegen.yml"
   }
 }

package/src/client/customApolloClient.d.ts

@@ -1,9 +1,14 @@
-import { ApolloClient, NormalizedCacheObject, QueryOptions } from '@apollo/client';
+import { ApolloClient, NormalizedCacheObject, OperationVariables, QueryOptions } from '@apollo/client';
+import { ResultOutput } from '../utils/removeNodesAndEdges';
 export declare class CustomApolloClient {
     apolloClient: ApolloClient<NormalizedCacheObject>;
     constructor(apolloClient: ApolloClient<NormalizedCacheObject>);
-    /**
-     * @todo improve typing here
-     */
-    query(options: QueryOptions<any, any>): Promise<any>;
+    query<TVariables extends OperationVariables, KResults extends Record<string, any>, KResultsOutput extends ResultOutput>(options: QueryOptions<TVariables, KResults>): Promise<{
+        data: KResultsOutput;
+        errors?: readonly import("graphql").GraphQLError[] | undefined;
+        error?: import("@apollo/client").ApolloError | undefined;
+        loading: boolean;
+        networkStatus: import("@apollo/client").NetworkStatus;
+        partial?: boolean | undefined;
+    }>;
 }

package/src/graphql/fragmentMatcher.d.ts

@@ -0,0 +1,7 @@
+export interface PossibleTypesResultData {
+    possibleTypes: {
+        [key: string]: string[];
+    };
+}
+declare const result: PossibleTypesResultData;
+export default result;