Skip to content

Commit 8164819

Browse files
gr2mgr2m
committed
feat(typescript): typescript definitions
1 parent 72f58f7 commit 8164819

32 files changed

+55296
-239
lines changed

‎docs/ghe-220.md‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,20 @@ octokit.enterpriseAdmin.deleteUser({ username });
3636
octokit.enterpriseAdmin.demoteSiteAdministrator({ username });
3737
octokit.enterpriseAdmin.enableOrDisableMaintenanceMode({ maintenance });
3838
octokit.enterpriseAdmin.getAllAuthorizedSshKeys();
39+
octokit.enterpriseAdmin.getAllStats();
40+
octokit.enterpriseAdmin.getCommentStats();
3941
octokit.enterpriseAdmin.getConfigurationStatus();
4042
octokit.enterpriseAdmin.getDownloadStatusForPreReceiveEnvironment({
4143
pre_receive_environment_id,
4244
});
4345
octokit.enterpriseAdmin.getGlobalWebhook({ hook_id });
46+
octokit.enterpriseAdmin.getHooksStats();
47+
octokit.enterpriseAdmin.getIssueStats();
4448
octokit.enterpriseAdmin.getLicenseInformation();
4549
octokit.enterpriseAdmin.getMaintenanceStatus();
50+
octokit.enterpriseAdmin.getMilestoneStats();
51+
octokit.enterpriseAdmin.getOrgStats();
52+
octokit.enterpriseAdmin.getPagesStats();
4653
octokit.enterpriseAdmin.getPreReceiveEnvironment({
4754
pre_receive_environment_id,
4855
});
@@ -53,8 +60,10 @@ octokit.enterpriseAdmin.getPreReceiveHookForRepo({
5360
repo,
5461
pre_receive_hook_id,
5562
});
63+
octokit.enterpriseAdmin.getPullRequestStats();
64+
octokit.enterpriseAdmin.getRepoStats();
5665
octokit.enterpriseAdmin.getSettings();
57-
octokit.enterpriseAdmin.getTypeStats({ type });
66+
octokit.enterpriseAdmin.getUserStats();
5867
octokit.enterpriseAdmin.listGlobalWebhooks({ per_page, page });
5968
octokit.enterpriseAdmin.listPersonalAccessTokens({ per_page, page });
6069
octokit.enterpriseAdmin.listPreReceiveEnvironments({
@@ -524,7 +533,7 @@ octokit.repos.setUserAccessRestrictions({owner, repo, branch, users});
524533
octokit.repos.testPushWebhook({owner, repo, hook_id});
525534
octokit.repos.transfer({owner, repo, new_owner, team_ids});
526535
octokit.repos.update({owner, repo, name, description, homepage, private, visibility, has_issues, has_projects, has_wiki, is_template, default_branch, allow_squash_merge, allow_merge_commit, allow_rebase_merge, delete_branch_on_merge, archived});
527-
octokit.repos.updateBranchProtection({owner, repo, branch, required_status_checks, enforce_admins, required_pull_request_reviews, restrictions, required_linear_history, allow_force_pushes, allow_deletions});
536+
octokit.repos.updateBranchProtection({owner, repo, branch, required_status_checks, enforce_admins, required_pull_request_reviews, restrictions, required_linear_history, allow_force_pushes, allow_deletions, required_conversation_resolution});
528537
octokit.repos.updateCommitComment({owner, repo, comment_id, body});
529538
octokit.repos.updateInformationAboutPagesSite({owner, repo, https_enforced, public, source});
530539
octokit.repos.updateInvitation({owner, repo, invitation_id, permissions});
@@ -537,9 +546,9 @@ octokit.repos.uploadReleaseAsset({owner, repo, release_id, name, label, data, or
537546
octokit.search.code({q, sort, order, per_page, page});
538547
octokit.search.commits({q, sort, order, per_page, page});
539548
octokit.search.issuesAndPullRequests({q, sort, order, per_page, page});
540-
octokit.search.labels({repository_id, q, sort, order});
549+
octokit.search.labels({repository_id, q, sort, order, per_page, page});
541550
octokit.search.repos({q, sort, order, per_page, page});
542-
octokit.search.topics({q});
551+
octokit.search.topics({q, per_page, page});
543552
octokit.search.users({q, sort, order, per_page, page});
544553
octokit.teams.addMemberLegacy({team_id, username});
545554
octokit.teams.addOrUpdateMembershipForUser({team_id, username, role});

‎docs/ghe-221.md‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,20 @@ octokit.enterpriseAdmin.deleteUser({ username });
3636
octokit.enterpriseAdmin.demoteSiteAdministrator({ username });
3737
octokit.enterpriseAdmin.enableOrDisableMaintenanceMode({ maintenance });
3838
octokit.enterpriseAdmin.getAllAuthorizedSshKeys();
39+
octokit.enterpriseAdmin.getAllStats();
40+
octokit.enterpriseAdmin.getCommentStats();
3941
octokit.enterpriseAdmin.getConfigurationStatus();
4042
octokit.enterpriseAdmin.getDownloadStatusForPreReceiveEnvironment({
4143
pre_receive_environment_id,
4244
});
4345
octokit.enterpriseAdmin.getGlobalWebhook({ hook_id });
46+
octokit.enterpriseAdmin.getHooksStats();
47+
octokit.enterpriseAdmin.getIssueStats();
4448
octokit.enterpriseAdmin.getLicenseInformation();
4549
octokit.enterpriseAdmin.getMaintenanceStatus();
50+
octokit.enterpriseAdmin.getMilestoneStats();
51+
octokit.enterpriseAdmin.getOrgStats();
52+
octokit.enterpriseAdmin.getPagesStats();
4653
octokit.enterpriseAdmin.getPreReceiveEnvironment({
4754
pre_receive_environment_id,
4855
});
@@ -53,8 +60,10 @@ octokit.enterpriseAdmin.getPreReceiveHookForRepo({
5360
repo,
5461
pre_receive_hook_id,
5562
});
63+
octokit.enterpriseAdmin.getPullRequestStats();
64+
octokit.enterpriseAdmin.getRepoStats();
5665
octokit.enterpriseAdmin.getSettings();
57-
octokit.enterpriseAdmin.getTypeStats({ type });
66+
octokit.enterpriseAdmin.getUserStats();
5867
octokit.enterpriseAdmin.listGlobalWebhooks({ per_page, page });
5968
octokit.enterpriseAdmin.listPersonalAccessTokens({ per_page, page });
6069
octokit.enterpriseAdmin.listPreReceiveEnvironments({
@@ -541,7 +550,7 @@ octokit.repos.setUserAccessRestrictions({owner, repo, branch, users});
541550
octokit.repos.testPushWebhook({owner, repo, hook_id});
542551
octokit.repos.transfer({owner, repo, new_owner, team_ids});
543552
octokit.repos.update({owner, repo, name, description, homepage, private, visibility, has_issues, has_projects, has_wiki, is_template, default_branch, allow_squash_merge, allow_merge_commit, allow_rebase_merge, delete_branch_on_merge, archived});
544-
octokit.repos.updateBranchProtection({owner, repo, branch, required_status_checks, enforce_admins, required_pull_request_reviews, restrictions, required_linear_history, allow_force_pushes, allow_deletions});
553+
octokit.repos.updateBranchProtection({owner, repo, branch, required_status_checks, enforce_admins, required_pull_request_reviews, restrictions, required_linear_history, allow_force_pushes, allow_deletions, required_conversation_resolution});
545554
octokit.repos.updateCommitComment({owner, repo, comment_id, body});
546555
octokit.repos.updateInformationAboutPagesSite({owner, repo, https_enforced, public, source});
547556
octokit.repos.updateInvitation({owner, repo, invitation_id, permissions});
@@ -554,9 +563,9 @@ octokit.repos.uploadReleaseAsset({owner, repo, release_id, name, label, data, or
554563
octokit.search.code({q, sort, order, per_page, page});
555564
octokit.search.commits({q, sort, order, per_page, page});
556565
octokit.search.issuesAndPullRequests({q, sort, order, per_page, page});
557-
octokit.search.labels({repository_id, q, sort, order});
566+
octokit.search.labels({repository_id, q, sort, order, per_page, page});
558567
octokit.search.repos({q, sort, order, per_page, page});
559-
octokit.search.topics({q});
568+
octokit.search.topics({q, per_page, page});
560569
octokit.search.users({q, sort, order, per_page, page});
561570
octokit.teams.addMemberLegacy({team_id, username});
562571
octokit.teams.addOrUpdateMembershipForUser({team_id, username, role});

‎docs/ghe-222.md‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,20 @@ octokit.enterpriseAdmin.deleteUser({ username });
3636
octokit.enterpriseAdmin.demoteSiteAdministrator({ username });
3737
octokit.enterpriseAdmin.enableOrDisableMaintenanceMode({ maintenance });
3838
octokit.enterpriseAdmin.getAllAuthorizedSshKeys();
39+
octokit.enterpriseAdmin.getAllStats();
40+
octokit.enterpriseAdmin.getCommentStats();
3941
octokit.enterpriseAdmin.getConfigurationStatus();
4042
octokit.enterpriseAdmin.getDownloadStatusForPreReceiveEnvironment({
4143
pre_receive_environment_id,
4244
});
4345
octokit.enterpriseAdmin.getGlobalWebhook({ hook_id });
46+
octokit.enterpriseAdmin.getHooksStats();
47+
octokit.enterpriseAdmin.getIssueStats();
4448
octokit.enterpriseAdmin.getLicenseInformation();
4549
octokit.enterpriseAdmin.getMaintenanceStatus();
50+
octokit.enterpriseAdmin.getMilestoneStats();
51+
octokit.enterpriseAdmin.getOrgStats();
52+
octokit.enterpriseAdmin.getPagesStats();
4653
octokit.enterpriseAdmin.getPreReceiveEnvironment({
4754
pre_receive_environment_id,
4855
});
@@ -53,8 +60,10 @@ octokit.enterpriseAdmin.getPreReceiveHookForRepo({
5360
repo,
5461
pre_receive_hook_id,
5562
});
63+
octokit.enterpriseAdmin.getPullRequestStats();
64+
octokit.enterpriseAdmin.getRepoStats();
5665
octokit.enterpriseAdmin.getSettings();
57-
octokit.enterpriseAdmin.getTypeStats({ type });
66+
octokit.enterpriseAdmin.getUserStats();
5867
octokit.enterpriseAdmin.listGlobalWebhooks({ per_page, page });
5968
octokit.enterpriseAdmin.listPersonalAccessTokens({ per_page, page });
6069
octokit.enterpriseAdmin.listPreReceiveEnvironments({
@@ -593,7 +602,7 @@ octokit.repos.setUserAccessRestrictions({owner, repo, branch, users});
593602
octokit.repos.testPushWebhook({owner, repo, hook_id});
594603
octokit.repos.transfer({owner, repo, new_owner, team_ids});
595604
octokit.repos.update({owner, repo, name, description, homepage, private, visibility, has_issues, has_projects, has_wiki, is_template, default_branch, allow_squash_merge, allow_merge_commit, allow_rebase_merge, delete_branch_on_merge, archived});
596-
octokit.repos.updateBranchProtection({owner, repo, branch, required_status_checks, enforce_admins, required_pull_request_reviews, restrictions, required_linear_history, allow_force_pushes, allow_deletions});
605+
octokit.repos.updateBranchProtection({owner, repo, branch, required_status_checks, enforce_admins, required_pull_request_reviews, restrictions, required_linear_history, allow_force_pushes, allow_deletions, required_conversation_resolution});
597606
octokit.repos.updateCommitComment({owner, repo, comment_id, body});
598607
octokit.repos.updateInformationAboutPagesSite({owner, repo, cname, https_enforced, public, source});
599608
octokit.repos.updateInvitation({owner, repo, invitation_id, permissions});
@@ -606,9 +615,9 @@ octokit.repos.uploadReleaseAsset({owner, repo, release_id, name, label, data, or
606615
octokit.search.code({q, sort, order, per_page, page});
607616
octokit.search.commits({q, sort, order, per_page, page});
608617
octokit.search.issuesAndPullRequests({q, sort, order, per_page, page});
609-
octokit.search.labels({repository_id, q, sort, order});
618+
octokit.search.labels({repository_id, q, sort, order, per_page, page});
610619
octokit.search.repos({q, sort, order, per_page, page});
611-
octokit.search.topics({q});
620+
octokit.search.topics({q, per_page, page});
612621
octokit.search.users({q, sort, order, per_page, page});
613622
octokit.teams.addMemberLegacy({team_id, username});
614623
octokit.teams.addOrUpdateMembershipForUser({team_id, username, role});

‎docs/ghe-30.md‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,16 +44,23 @@ octokit.enterpriseAdmin.enableSelectedOrganizationGithubActionsEnterprise({
4444
org_id,
4545
});
4646
octokit.enterpriseAdmin.getAllAuthorizedSshKeys();
47+
octokit.enterpriseAdmin.getAllStats();
4748
octokit.enterpriseAdmin.getAllowedActionsEnterprise({ enterprise });
4849
octokit.enterpriseAdmin.getAnnouncement();
50+
octokit.enterpriseAdmin.getCommentStats();
4951
octokit.enterpriseAdmin.getConfigurationStatus();
5052
octokit.enterpriseAdmin.getDownloadStatusForPreReceiveEnvironment({
5153
pre_receive_environment_id,
5254
});
5355
octokit.enterpriseAdmin.getGithubActionsPermissionsEnterprise({ enterprise });
5456
octokit.enterpriseAdmin.getGlobalWebhook({ hook_id });
57+
octokit.enterpriseAdmin.getHooksStats();
58+
octokit.enterpriseAdmin.getIssueStats();
5559
octokit.enterpriseAdmin.getLicenseInformation();
5660
octokit.enterpriseAdmin.getMaintenanceStatus();
61+
octokit.enterpriseAdmin.getMilestoneStats();
62+
octokit.enterpriseAdmin.getOrgStats();
63+
octokit.enterpriseAdmin.getPagesStats();
5764
octokit.enterpriseAdmin.getPreReceiveEnvironment({
5865
pre_receive_environment_id,
5966
});
@@ -64,8 +71,10 @@ octokit.enterpriseAdmin.getPreReceiveHookForRepo({
6471
repo,
6572
pre_receive_hook_id,
6673
});
74+
octokit.enterpriseAdmin.getPullRequestStats();
75+
octokit.enterpriseAdmin.getRepoStats();
6776
octokit.enterpriseAdmin.getSettings();
68-
octokit.enterpriseAdmin.getTypeStats({ type });
77+
octokit.enterpriseAdmin.getUserStats();
6978
octokit.enterpriseAdmin.listGlobalWebhooks({ per_page, page });
7079
octokit.enterpriseAdmin.listPersonalAccessTokens({ per_page, page });
7180
octokit.enterpriseAdmin.listPreReceiveEnvironments({
@@ -643,7 +652,7 @@ octokit.repos.setUserAccessRestrictions({owner, repo, branch, users});
643652
octokit.repos.testPushWebhook({owner, repo, hook_id});
644653
octokit.repos.transfer({owner, repo, new_owner, team_ids});
645654
octokit.repos.update({owner, repo, name, description, homepage, private, visibility, has_issues, has_projects, has_wiki, is_template, default_branch, allow_squash_merge, allow_merge_commit, allow_rebase_merge, delete_branch_on_merge, archived});
646-
octokit.repos.updateBranchProtection({owner, repo, branch, required_status_checks, enforce_admins, required_pull_request_reviews, restrictions, required_linear_history, allow_force_pushes, allow_deletions});
655+
octokit.repos.updateBranchProtection({owner, repo, branch, required_status_checks, enforce_admins, required_pull_request_reviews, restrictions, required_linear_history, allow_force_pushes, allow_deletions, required_conversation_resolution});
647656
octokit.repos.updateCommitComment({owner, repo, comment_id, body});
648657
octokit.repos.updateInformationAboutPagesSite({owner, repo, cname, https_enforced, public, source});
649658
octokit.repos.updateInvitation({owner, repo, invitation_id, permissions});
@@ -657,9 +666,9 @@ octokit.repos.uploadReleaseAsset({owner, repo, release_id, name, label, data, or
657666
octokit.search.code({q, sort, order, per_page, page});
658667
octokit.search.commits({q, sort, order, per_page, page});
659668
octokit.search.issuesAndPullRequests({q, sort, order, per_page, page});
660-
octokit.search.labels({repository_id, q, sort, order});
669+
octokit.search.labels({repository_id, q, sort, order, per_page, page});
661670
octokit.search.repos({q, sort, order, per_page, page});
662-
octokit.search.topics({q});
671+
octokit.search.topics({q, per_page, page});
663672
octokit.search.users({q, sort, order, per_page, page});
664673
octokit.teams.addMemberLegacy({team_id, username});
665674
octokit.teams.addOrUpdateMembershipForUser({team_id, username, role});

‎package-lock.json‎

Lines changed: 12 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@
1313
"test": "jest --coverage",
1414
"update-endpoints": "npm-run-all update-endpoints:*",
1515
"update-endpoints:fetch-json": "node scripts/update-endpoints/fetch-json",
16-
"update-endpoints:code": "node scripts/update-endpoints/code"
16+
"update-endpoints:code": "node scripts/update-endpoints/code",
17+
"update-endpoints:types": "node scripts/update-endpoints/types"
1718
},
1819
"repository": "github:octokit/plugin-enterprise-server.js",
1920
"keywords": [
@@ -44,11 +45,13 @@
4445
"fetch-mock": "^9.0.0",
4546
"github-openapi-graphql-query": "^1.0.5",
4647
"jest": "^27.0.0",
48+
"lodash.camelcase": "^4.3.0",
4749
"npm-run-all": "^4.1.5",
4850
"prettier": "2.3.2",
4951
"semantic-release": "^17.0.0",
5052
"semantic-release-plugin-update-version-in-files": "^1.0.0",
5153
"sort-keys": "^4.2.0",
54+
"string-to-jsdoc-comment": "^1.0.0",
5255
"ts-jest": "^27.0.0-next.12",
5356
"typescript": "^4.0.2"
5457
},

‎scripts/update-endpoints/code.js‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,16 +110,19 @@ async function generateRoutes() {
110110
(version) => `
111111
import ENDPOINTS_${version} from "./generated/ghe-${version}-endpoints";
112112
import ADMIN_ENDPOINTS_${version} from "./generated/ghe-${version}-admin-endpoints";
113+
import { RestEndpointMethods as RestEndpointMethods_${version} } from "./generated/ghe-${version}-method-types";
113114
`
114115
).join("\n");
115116
const methods = GHE_VERSIONS.map(
116117
(version) => `
117-
export function enterpriseServer${version}Admin(octokit: Octokit) {
118+
export function enterpriseServer${version}Admin(octokit: Octokit): { enterpriseAdmin: RestEndpointMethods_${version}["enterpriseAdmin"] } {
119+
// @ts-ignore - not worth the hassle
118120
return endpointsToMethods(octokit, ADMIN_ENDPOINTS_${version});
119121
}
120122
enterpriseServer${version}Admin.VERSION = VERSION;
121123
122-
export function enterpriseServer${version}(octokit: Octokit) {
124+
export function enterpriseServer${version}(octokit: Octokit): RestEndpointMethods_${version} {
125+
// @ts-ignore - not worth the hassle
123126
return endpointsToMethods(octokit, ENDPOINTS_${version});
124127
}
125128
enterpriseServer${version}.VERSION = VERSION;

0 commit comments

Comments
 (0)