gh-gql - npm Package Compare versions

Comparing version 2.0.1 to 2.0.2

CHANGELOG.md

@@ -8,3 +8,3 @@ # Important Changes
 
-- Bumped **[dotenv](https://www.npmjs.com/package/dotenv/v/9.0.0)** from `8.2.0` to `9.0.0`
+- Bumped **[dotenv](https://www.npmjs.com/package/dotenv/v/10.0.0)** from `9.0.0` to `10.0.0`
 
@@ -16,15 +16,33 @@ </details>
 
-- Bumped **[@babel/preset-env](https://www.npmjs.com/package/@babel/preset-env/v/7.14.1)** from `7.14.0` to `7.14.1`
-- Bumped **[@tagproject/ts-package-shared-config](https://www.npmjs.com/package/@tagproject/ts-package-shared-config/v/3.0.0)** from `2.0.1` to `3.0.0`
-- Bumped **[@types/node](https://www.npmjs.com/package/@types/node/v/15.0.2)** from `15.0.1` to `15.0.2`
-- Bumped **[@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin/v/4.22.1)** from `4.22.0` to `4.22.1`
-- Bumped **[@typescript-eslint/parser](https://www.npmjs.com/package/@typescript-eslint/parser/v/4.22.1)** from `4.22.0` to `4.22.1`
-- Bumped **[changelog-guru](https://www.npmjs.com/package/changelog-guru/v/3.0.1)** from `2.3.1` to `3.0.1`
-- Bumped **[cspell](https://www.npmjs.com/package/cspell/v/5.4.0)** from `5.3.12` to `5.4.0`
-- Bumped **[ghinfo](https://www.npmjs.com/package/ghinfo/v/2.0.2)** from `1.0.8` to `2.0.2`
-- Bumped **[ts-jest](https://www.npmjs.com/package/ts-jest/v/26.5.6)** from `26.5.5` to `26.5.6`
-- Bumped **[typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown/v/3.8.0)** from `3.7.2` to `3.8.0`
+- Bumped **[@babel/plugin-transform-runtime](https://www.npmjs.com/package/@babel/plugin-transform-runtime/v/7.14.3)** from `7.13.15` to `7.14.3`
+- Bumped **[@babel/preset-env](https://www.npmjs.com/package/@babel/preset-env/v/7.14.4)** from `7.14.1` to `7.14.4`
+- Bumped **[@graphql-codegen/cli](https://www.npmjs.com/package/@graphql-codegen/cli/v/1.21.5)** from `1.21.4` to `1.21.5`
+- Bumped **[@graphql-codegen/import-types-preset](https://www.npmjs.com/package/@graphql-codegen/import-types-preset/v/1.18.2)** from `1.18.1` to `1.18.2`
+- Bumped **[@graphql-codegen/near-operation-file-preset](https://www.npmjs.com/package/@graphql-codegen/near-operation-file-preset/v/1.18.1)** from `1.18.0` to `1.18.1`
+- Bumped **[@graphql-codegen/typescript](https://www.npmjs.com/package/@graphql-codegen/typescript/v/1.22.1)** from `1.22.0` to `1.22.1`
+- Bumped **[@graphql-codegen/typescript-graphql-request](https://www.npmjs.com/package/@graphql-codegen/typescript-graphql-request/v/3.2.1)** from `3.1.1` to `3.2.1`
+- Bumped **[@graphql-codegen/typescript-operations](https://www.npmjs.com/package/@graphql-codegen/typescript-operations/v/1.18.0)** from `1.17.16` to `1.18.0`
+- Bumped **[@tagproject/ts-package-shared-config](https://www.npmjs.com/package/@tagproject/ts-package-shared-config/v/4.0.0)** from `3.0.0` to `4.0.0`
+- Bumped **[@types/node](https://www.npmjs.com/package/@types/node/v/15.6.1)** from `15.0.2` to `15.6.1`
+- Bumped **[@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin/v/4.26.0)** from `4.22.1` to `4.26.0`
+- Bumped **[@typescript-eslint/parser](https://www.npmjs.com/package/@typescript-eslint/parser/v/4.26.0)** from `4.22.1` to `4.26.0`
+- Bumped **[babel-jest](https://www.npmjs.com/package/babel-jest/v/27.0.2)** from `26.6.3` to `27.0.2`
+- Bumped **[changelog-guru](https://www.npmjs.com/package/changelog-guru/v/3.0.2)** from `3.0.1` to `3.0.2`
+- Bumped **[cspell](https://www.npmjs.com/package/cspell/v/5.5.2)** from `5.4.0` to `5.5.2`
+- Bumped **[eslint](https://www.npmjs.com/package/eslint/v/7.27.0)** from `7.25.0` to `7.27.0`
+- Bumped **[eslint-plugin-import](https://www.npmjs.com/package/eslint-plugin-import/v/2.23.4)** from `2.22.1` to `2.23.4`
+- Bumped **[ghinfo](https://www.npmjs.com/package/ghinfo/v/2.0.3)** from `2.0.2` to `2.0.3`
+- Bumped **[jest](https://www.npmjs.com/package/jest/v/27.0.3)** from `26.6.3` to `27.0.3`
+- Bumped **[prettier](https://www.npmjs.com/package/prettier/v/2.3.0)** from `2.2.1` to `2.3.0`
+- Bumped **[ts-jest](https://www.npmjs.com/package/ts-jest/v/27.0.2)** from `26.5.6` to `27.0.2`
+- Bumped **[typescript](https://www.npmjs.com/package/typescript/v/4.3.2)** from `4.2.4` to `4.3.2`
+- Removed **[typedoc](https://www.npmjs.com/package/typedoc/v/0.20.36)**, with `^0.20.36`
+- Removed **[typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown/v/3.8.0)**, with `^3.8.0`
 
 </details>
 
+# :bug: Bug Fixes
+
+- Remove typedoc, bump deps [`32393ce`](https://github.com/keindev/gh-gql/commit/32393cece1c1daab6a86f209db79e3e8b7a50738)
+
 ---
@@ -31,0 +49,0 @@

lib/Provider.js

@@ -10,4 +10,7 @@ import dotenv from 'dotenv';
 export class Provider {
+    static DEFAULT_USER_AGENT = `gh-gql ${getUserAgent()}`;
+    static ENDPOINT = 'https://api.github.com/graphql';
+    query;
+    #queries = new Map();
     constructor(userAgent = Provider.DEFAULT_USER_AGENT) {
-        this.#queries = new Map();
         const client = new GraphQLClient(Provider.ENDPOINT, {
@@ -45,6 +48,3 @@ method: 'POST',
     }
-    #queries;
 }
-Provider.DEFAULT_USER_AGENT = `gh-gql ${getUserAgent()}`;
-Provider.ENDPOINT = 'https://api.github.com/graphql';
 export default Provider;

lib/queries/Query.js

 export default class Query {
+    static DELIMITER = '\n';
+    static PAGE_SIZE = 100;
+    static TAB_WIDTH = 2;
+    sdk;
     constructor(client, getSdk) {
@@ -15,4 +19,1 @@ this.sdk = getSdk(client);
 }
-Query.DELIMITER = '\n';
-Query.PAGE_SIZE = 100;
-Query.TAB_WIDTH = 2;

package.json

 {
   "name": "gh-gql",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "GitHub GraphQL API helper for TypeScript",
@@ -33,3 +33,2 @@ "homepage": "https://github.com/keindev/gh-gql#readme",
     "generate:changelog": "node --experimental-specifier-resolution=node node_modules/.bin/changelog generate --bump",
-    "generate:docs": "rimraf docs/api && typedoc",
     "generate:ghinfo": "node --experimental-specifier-resolution=node node_modules/.bin/ghinfo generate -d media -t utils",
@@ -50,3 +49,3 @@ "lint": "npm-run-all lint:*",
   "dependencies": {
-    "dotenv": "^9.0.0",
+    "dotenv": "^10.0.0",
     "graphql": "^15.5.0",
@@ -58,23 +57,23 @@ "graphql-request": "^3.4.0",
   "devDependencies": {
-    "@babel/plugin-transform-runtime": "^7.13.15",
-    "@babel/preset-env": "^7.14.1",
+    "@babel/plugin-transform-runtime": "^7.14.3",
+    "@babel/preset-env": "^7.14.4",
     "@graphql-codegen/add": "^2.0.2",
-    "@graphql-codegen/cli": "^1.21.4",
-    "@graphql-codegen/import-types-preset": "^1.18.1",
-    "@graphql-codegen/near-operation-file-preset": "^1.18.0",
-    "@graphql-codegen/typescript": "^1.22.0",
-    "@graphql-codegen/typescript-graphql-request": "^3.1.1",
-    "@graphql-codegen/typescript-operations": "^1.17.16",
-    "@tagproject/ts-package-shared-config": "^3.0.0",
+    "@graphql-codegen/cli": "^1.21.5",
+    "@graphql-codegen/import-types-preset": "^1.18.2",
+    "@graphql-codegen/near-operation-file-preset": "^1.18.1",
+    "@graphql-codegen/typescript": "^1.22.1",
+    "@graphql-codegen/typescript-graphql-request": "^3.2.1",
+    "@graphql-codegen/typescript-operations": "^1.18.0",
+    "@tagproject/ts-package-shared-config": "^4.0.0",
     "@types/jest": "^26.0.23",
-    "@types/node": "^15.0.2",
-    "@typescript-eslint/eslint-plugin": "^4.22.1",
-    "@typescript-eslint/parser": "^4.22.1",
-    "babel-jest": "^26.6.3",
-    "changelog-guru": "^3.0.1",
-    "cspell": "^5.4.0",
+    "@types/node": "^15.6.1",
+    "@typescript-eslint/eslint-plugin": "^4.26.0",
+    "@typescript-eslint/parser": "^4.26.0",
+    "babel-jest": "^27.0.2",
+    "changelog-guru": "^3.0.2",
+    "cspell": "^5.5.2",
     "dotenv-cli": "^4.0.0",
-    "eslint": "^7.25.0",
+    "eslint": "^7.27.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-import": "^2.23.4",
     "eslint-plugin-jest": "^24.3.6",
@@ -84,13 +83,11 @@ "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^5.1.0",
-    "ghinfo": "^2.0.2",
+    "ghinfo": "^2.0.3",
     "husky": "^6.0.0",
-    "jest": "^26.6.3",
+    "jest": "^27.0.3",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.2.1",
+    "prettier": "^2.3.0",
     "rimraf": "^3.0.2",
-    "ts-jest": "^26.5.6",
-    "typedoc": "^0.20.36",
-    "typedoc-plugin-markdown": "^3.8.0",
-    "typescript": "^4.2.4"
+    "ts-jest": "^27.0.2",
+    "typescript": "^4.3.2"
   }
 }

README.md

@@ -25,4 +25,5 @@ <p align="center"><img width="400" src="https://cdn.jsdelivr.net/gh/keindev/gh-gql/media/logo.svg" alt="GitHub GraphQL API client for JavaScript"></p>
 
-```JavaScript
-const { Provider } = require('gh-gql');
+```javascript
+import Provider from 'gh-gql';
+
 const { query } = new Provider();
@@ -34,5 +35,1 @@
 ```
-
-## API
-
-Read the [API documentation](https://github.com/keindev/gh-gql/blob/master/docs/api/index.md) for more information.

No alert changes

Improved metrics

Total package byte prevSize

460818

increased by0.36%

Dev dependency count

33

decreased by-5.71%

Lines of code

11768

increased by0.01%

Worsened metrics

Number of lines in readme file

34

decreased by-8.11%

Dependency changes

• + Addeddotenv@10.0.0(transitive)

• - Removeddotenv@9.0.2(transitive)

• Updateddotenv@^10.0.0