@shelf/gh-sdk - npm Package Compare versions

Comparing version 0.2.3 to 0.3.0

lib/index.d.ts

@@ -1,2 +0,3 @@
-import { Octokit } from '@octokit/rest';
+import { PullsCreateReviewResponseData, PullsMergeResponseData } from '@octokit/types';
+import { PullsMergeResponse405Data, PullsMergeResponse409Data } from '@octokit/types/dist-types/generated/Endpoints';
 export { listOpenPRs } from './prs/list-open-prs';
@@ -7,2 +8,3 @@ export { listOrgRepos } from './repos/list-org-repos';
 export { createReleasePR } from './prs/create-release-pr';
+export { getPR } from './prs/get-pr';
 export { createReleaseBranch } from './repos/create-release-branch';
@@ -15,4 +17,4 @@ export { getLatestBranchCommit, getLatestDevelopCommit, getLatestDevelopCommitSHA } from './repos/get-latest-branch-commit';
 }
-export declare function approvePR(params: ApprovePRParams): Promise<Octokit.PullsCreateReviewResponse>;
-export declare function mergePR(params: ApprovePRParams): Promise<Octokit.PullsMergeResponse>;
+export declare function approvePR(params: ApprovePRParams): Promise<PullsCreateReviewResponseData>;
+export declare function mergePR(params: ApprovePRParams): Promise<PullsMergeResponseData | PullsMergeResponse405Data | PullsMergeResponse409Data>;
 export declare function getUserOrgs(): Promise<string[]>;

lib/index.js

@@ -51,2 +51,8 @@ "use strict";
 });
+Object.defineProperty(exports, "getPR", {
+  enumerable: true,
+  get: function () {
+    return _getPr.getPR;
+  }
+});
 Object.defineProperty(exports, "createReleaseBranch", {
@@ -89,2 +95,4 @@ enumerable: true,
 
+var _getPr = require("./prs/get-pr");
+
 var _createReleaseBranch = require("./repos/create-release-branch");
@@ -91,0 +99,0 @@

lib/prs/create-release-pr.d.ts

@@ -1,2 +0,2 @@
-import { Octokit } from '@octokit/rest';
+import { PullsCreateResponseData } from '@octokit/types';
 export declare function createReleasePR({ owner, repo, version, releaseTitle }: {
@@ -7,2 +7,2 @@ owner: string;
     releaseTitle: string;
-}): Promise<Octokit.PullsCreateResponse>;
+}): Promise<PullsCreateResponseData>;

lib/prs/list-open-prs.d.ts

@@ -1,2 +0,2 @@
-import { Octokit } from '@octokit/rest';
+import { SearchIssuesAndPullRequestsResponseData } from '@octokit/types';
 interface ListPRsParams {
@@ -6,3 +6,3 @@ owner: string;
 }
-export declare function listOpenPRs(params: ListPRsParams): Promise<Octokit.SearchIssuesAndPullRequestsResponseItemsItem[]>;
+export declare function listOpenPRs(params: ListPRsParams): Promise<SearchIssuesAndPullRequestsResponseData['items']>;
 export {};

lib/repos/create-release-branch.d.ts

@@ -1,2 +0,2 @@
-import { Octokit } from '@octokit/rest';
+import { GitCreateRefResponseData } from '@octokit/types';
 export declare function createReleaseBranch({ owner, repo, version, sha }: {
@@ -7,2 +7,2 @@ owner: string;
     sha: string;
-}): Promise<Octokit.GitCreateRefResponse>;
+}): Promise<GitCreateRefResponseData>;

lib/repos/delete-branch.d.ts

@@ -1,2 +0,3 @@
-import { Octokit } from '@octokit/rest';
-export declare function deleteBranch({ owner, repo, ref }: Octokit.GitDeleteRefParams): Promise<Octokit.AnyResponse>;
+import { RestEndpointMethodTypes } from '@octokit/plugin-rest-endpoint-methods';
+import { OctokitResponse } from '@octokit/types';
+export declare function deleteBranch({ owner, repo, ref }: RestEndpointMethodTypes['git']['deleteRef']['parameters']): Promise<OctokitResponse<any>>;

lib/repos/get-latest-branch-commit.d.ts

@@ -1,2 +0,2 @@
-import { Octokit } from '@octokit/rest';
+import { getRepoBranch } from './get-repo-branches';
 declare type LatestBranchCommit = {
@@ -24,5 +24,5 @@ author: {
     url: string;
-    commit?: object;
+    commit?: Record<string, unknown>;
 };
-export declare function getLatestBranchCommit({ owner, repo, branch }: Octokit.ReposGetBranchParams): Promise<LatestBranchCommit>;
+export declare function getLatestBranchCommit({ owner, repo, branch }: Parameters<typeof getRepoBranch>[0]): Promise<LatestBranchCommit>;
 export declare function getLatestDevelopCommit({ owner, repo }: {
@@ -29,0 +29,0 @@ owner: string;

lib/repos/get-repo-branches.d.ts

@@ -1,4 +0,5 @@
-import { Octokit } from '@octokit/rest';
-export declare function getRepoBranch({ owner, repo, branch }: Octokit.ReposGetBranchParams): Promise<Octokit.ReposGetBranchResponse>;
-export declare function getRepoBranches({ owner, repo }: Octokit.ReposListBranchesParams): Promise<Octokit.ReposListBranchesResponse>;
+import { RestEndpointMethodTypes } from '@octokit/plugin-rest-endpoint-methods';
+import { ReposGetBranchResponseData, ReposListBranchesResponseData } from '@octokit/types';
+export declare function getRepoBranch({ owner, repo, branch }: RestEndpointMethodTypes['repos']['getBranch']['parameters']): Promise<ReposGetBranchResponseData>;
+export declare function getRepoBranches({ owner, repo }: RestEndpointMethodTypes['repos']['listBranches']['parameters']): Promise<ReposListBranchesResponseData>;
 export declare function getRepoBranchesNames({ owner, repo }: {
@@ -5,0 +6,0 @@ owner: string;

lib/repos/list-org-repos.d.ts

@@ -1,2 +0,2 @@
-import { Octokit } from '@octokit/rest';
-export declare function listOrgRepos(org: string): Promise<Octokit.ReposListForOrgResponseItem[]>;
+import { ReposListForOrgResponseData } from '@octokit/types';
+export declare function listOrgRepos(org: string): Promise<ReposListForOrgResponseData>;

package.json

 {
   "name": "@shelf/gh-sdk",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "description": "Convenient wrapper for GitHub API for automation tasks",
@@ -48,21 +48,21 @@ "license": "MIT",
   "dependencies": {
-    "@octokit/rest": "16.43.1",
-    "lodash": "4.17.15"
+    "@octokit/rest": "18.0.6",
+    "lodash": "4.17.20"
   },
   "devDependencies": {
-    "@babel/cli": "7.8.4",
-    "@babel/core": "7.9.6",
-    "@babel/preset-env": "7.9.6",
-    "@babel/preset-typescript": "7.9.0",
-    "@shelf/eslint-config": "0.19.0",
+    "@babel/cli": "7.12.1",
+    "@babel/core": "7.12.3",
+    "@babel/preset-env": "7.12.1",
+    "@babel/preset-typescript": "7.12.1",
+    "@shelf/eslint-config": "0.23.1",
     "@shelf/prettier-config": "0.0.7",
-    "@types/jest": "26.0.9",
+    "@types/jest": "26.0.15",
     "@types/node": "12.12.31",
-    "babel-jest": "26.2.2",
-    "eslint": "7.1.0",
-    "husky": "4.2.5",
-    "jest": "26.2.2",
-    "lint-staged": "10.2.6",
-    "prettier": "2.0.5",
-    "typescript": "3.9.3"
+    "babel-jest": "26.6.0",
+    "eslint": "7.11.0",
+    "husky": "4.3.0",
+    "jest": "26.6.0",
+    "lint-staged": "10.4.2",
+    "prettier": "2.1.2",
+    "typescript": "4.0.3"
   },
@@ -69,0 +69,0 @@ "engines": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

17738

increased by8.56%

Number of package files

23

increased by9.52%

Lines of code

477

increased by8.41%

Dependency changes

• + Added@octokit/core@3.6.0(transitive)

• + Added@octokit/graphql@4.8.0(transitive)

• + Added@octokit/plugin-paginate-rest@2.21.3(transitive)

• + Added@octokit/plugin-rest-endpoint-methods@4.2.0(transitive)

• + Added@octokit/rest@18.0.6(transitive)

• + Added@octokit/types@5.5.0(transitive)

• + Addedlodash@4.17.20(transitive)

• - Removed@octokit/auth-token@5.1.1(transitive)

• - Removed@octokit/core@6.1.2(transitive)

• - Removed@octokit/endpoint@10.1.1(transitive)

• - Removed@octokit/graphql@8.1.1(transitive)

• - Removed@octokit/openapi-types@22.2.0(transitive)

• - Removed@octokit/plugin-paginate-rest@1.1.2(transitive)

• - Removed@octokit/plugin-rest-endpoint-methods@2.4.0(transitive)

• - Removed@octokit/request@9.1.3(transitive)

• - Removed@octokit/request-error@1.2.16.1.5(transitive)

• - Removed@octokit/rest@16.43.1(transitive)

• - Removed@octokit/types@13.6.12.16.2(transitive)

• - Removedatob-lite@2.0.0(transitive)

• - Removedbefore-after-hook@3.0.2(transitive)

• - Removedbtoa-lite@1.0.0(transitive)

• - Removedcross-spawn@6.0.5(transitive)

• - Removedend-of-stream@1.4.4(transitive)

• - Removedexeca@1.0.0(transitive)

• - Removedget-stream@4.1.0(transitive)

• - Removedis-stream@1.1.0(transitive)

• - Removedisexe@2.0.0(transitive)

• - Removedlodash@4.17.15(transitive)

• - Removedlodash.get@4.4.2(transitive)

• - Removedlodash.set@4.3.2(transitive)

• - Removedlodash.uniq@4.5.0(transitive)

• - Removedmacos-release@2.5.1(transitive)

• - Removednice-try@1.0.5(transitive)

• - Removednpm-run-path@2.0.2(transitive)

• - Removedoctokit-pagination-methods@1.1.0(transitive)

• - Removedos-name@3.1.0(transitive)

• - Removedp-finally@1.0.0(transitive)

• - Removedpath-key@2.0.1(transitive)

• - Removedpump@3.0.2(transitive)

• - Removedsemver@5.7.2(transitive)

• - Removedshebang-command@1.2.0(transitive)

• - Removedshebang-regex@1.0.0(transitive)

• - Removedsignal-exit@3.0.7(transitive)

• - Removedstrip-eof@1.0.0(transitive)

• - Removeduniversal-user-agent@4.0.17.0.2(transitive)

• - Removedwhich@1.3.1(transitive)

• - Removedwindows-release@3.3.3(transitive)

• Updated@octokit/rest@18.0.6

• Updatedlodash@4.17.20