Skip to content

Commit

Permalink
feat(typescript): typescript definitions
Browse files Browse the repository at this point in the history
  • Loading branch information
@gr2m
gr2m committed Jun 29, 2021
1 parent 72f58f7 commit 8164819
Show file tree
Hide file tree
Showing 32 changed files with 55,296 additions and 239 deletions.
17 changes: 13 additions & 4 deletions docs/ghe-220.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,20 @@ octokit.enterpriseAdmin.deleteUser({ username });
octokit.enterpriseAdmin.demoteSiteAdministrator({ username });
octokit.enterpriseAdmin.enableOrDisableMaintenanceMode({ maintenance });
octokit.enterpriseAdmin.getAllAuthorizedSshKeys();
octokit.enterpriseAdmin.getAllStats();
octokit.enterpriseAdmin.getCommentStats();
octokit.enterpriseAdmin.getConfigurationStatus();
octokit.enterpriseAdmin.getDownloadStatusForPreReceiveEnvironment({
pre_receive_environment_id,
});
octokit.enterpriseAdmin.getGlobalWebhook({ hook_id });
octokit.enterpriseAdmin.getHooksStats();
octokit.enterpriseAdmin.getIssueStats();
octokit.enterpriseAdmin.getLicenseInformation();
octokit.enterpriseAdmin.getMaintenanceStatus();
octokit.enterpriseAdmin.getMilestoneStats();
octokit.enterpriseAdmin.getOrgStats();
octokit.enterpriseAdmin.getPagesStats();
octokit.enterpriseAdmin.getPreReceiveEnvironment({
pre_receive_environment_id,
});
Expand All @@ -53,8 +60,10 @@ octokit.enterpriseAdmin.getPreReceiveHookForRepo({
repo,
pre_receive_hook_id,
});
octokit.enterpriseAdmin.getPullRequestStats();
octokit.enterpriseAdmin.getRepoStats();
octokit.enterpriseAdmin.getSettings();
octokit.enterpriseAdmin.getTypeStats({ type });
octokit.enterpriseAdmin.getUserStats();
octokit.enterpriseAdmin.listGlobalWebhooks({ per_page, page });
octokit.enterpriseAdmin.listPersonalAccessTokens({ per_page, page });
octokit.enterpriseAdmin.listPreReceiveEnvironments({
Expand Down Expand Up @@ -524,7 +533,7 @@ octokit.repos.setUserAccessRestrictions({owner, repo, branch, users});
octokit.repos.testPushWebhook({owner, repo, hook_id});
octokit.repos.transfer({owner, repo, new_owner, team_ids});
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});
octokit.repos.updateBranchProtection({owner, repo, branch, required_status_checks, enforce_admins, required_pull_request_reviews, restrictions, required_linear_history, allow_force_pushes, allow_deletions});
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});
octokit.repos.updateCommitComment({owner, repo, comment_id, body});
octokit.repos.updateInformationAboutPagesSite({owner, repo, https_enforced, public, source});
octokit.repos.updateInvitation({owner, repo, invitation_id, permissions});
Expand All @@ -537,9 +546,9 @@ octokit.repos.uploadReleaseAsset({owner, repo, release_id, name, label, data, or
octokit.search.code({q, sort, order, per_page, page});
octokit.search.commits({q, sort, order, per_page, page});
octokit.search.issuesAndPullRequests({q, sort, order, per_page, page});
octokit.search.labels({repository_id, q, sort, order});
octokit.search.labels({repository_id, q, sort, order, per_page, page});
octokit.search.repos({q, sort, order, per_page, page});
octokit.search.topics({q});
octokit.search.topics({q, per_page, page});
octokit.search.users({q, sort, order, per_page, page});
octokit.teams.addMemberLegacy({team_id, username});
octokit.teams.addOrUpdateMembershipForUser({team_id, username, role});
Expand Down
17 changes: 13 additions & 4 deletions docs/ghe-221.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,20 @@ octokit.enterpriseAdmin.deleteUser({ username });
octokit.enterpriseAdmin.demoteSiteAdministrator({ username });
octokit.enterpriseAdmin.enableOrDisableMaintenanceMode({ maintenance });
octokit.enterpriseAdmin.getAllAuthorizedSshKeys();
octokit.enterpriseAdmin.getAllStats();
octokit.enterpriseAdmin.getCommentStats();
octokit.enterpriseAdmin.getConfigurationStatus();
octokit.enterpriseAdmin.getDownloadStatusForPreReceiveEnvironment({
pre_receive_environment_id,
});
octokit.enterpriseAdmin.getGlobalWebhook({ hook_id });
octokit.enterpriseAdmin.getHooksStats();
octokit.enterpriseAdmin.getIssueStats();
octokit.enterpriseAdmin.getLicenseInformation();
octokit.enterpriseAdmin.getMaintenanceStatus();
octokit.enterpriseAdmin.getMilestoneStats();
octokit.enterpriseAdmin.getOrgStats();
octokit.enterpriseAdmin.getPagesStats();
octokit.enterpriseAdmin.getPreReceiveEnvironment({
pre_receive_environment_id,
});
Expand All @@ -53,8 +60,10 @@ octokit.enterpriseAdmin.getPreReceiveHookForRepo({
repo,
pre_receive_hook_id,
});
octokit.enterpriseAdmin.getPullRequestStats();
octokit.enterpriseAdmin.getRepoStats();
octokit.enterpriseAdmin.getSettings();
octokit.enterpriseAdmin.getTypeStats({ type });
octokit.enterpriseAdmin.getUserStats();
octokit.enterpriseAdmin.listGlobalWebhooks({ per_page, page });
octokit.enterpriseAdmin.listPersonalAccessTokens({ per_page, page });
octokit.enterpriseAdmin.listPreReceiveEnvironments({
Expand Down Expand Up @@ -541,7 +550,7 @@ octokit.repos.setUserAccessRestrictions({owner, repo, branch, users});
octokit.repos.testPushWebhook({owner, repo, hook_id});
octokit.repos.transfer({owner, repo, new_owner, team_ids});
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});
octokit.repos.updateBranchProtection({owner, repo, branch, required_status_checks, enforce_admins, required_pull_request_reviews, restrictions, required_linear_history, allow_force_pushes, allow_deletions});
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});
octokit.repos.updateCommitComment({owner, repo, comment_id, body});
octokit.repos.updateInformationAboutPagesSite({owner, repo, https_enforced, public, source});
octokit.repos.updateInvitation({owner, repo, invitation_id, permissions});
Expand All @@ -554,9 +563,9 @@ octokit.repos.uploadReleaseAsset({owner, repo, release_id, name, label, data, or
octokit.search.code({q, sort, order, per_page, page});
octokit.search.commits({q, sort, order, per_page, page});
octokit.search.issuesAndPullRequests({q, sort, order, per_page, page});
octokit.search.labels({repository_id, q, sort, order});
octokit.search.labels({repository_id, q, sort, order, per_page, page});
octokit.search.repos({q, sort, order, per_page, page});
octokit.search.topics({q});
octokit.search.topics({q, per_page, page});
octokit.search.users({q, sort, order, per_page, page});
octokit.teams.addMemberLegacy({team_id, username});
octokit.teams.addOrUpdateMembershipForUser({team_id, username, role});
Expand Down
17 changes: 13 additions & 4 deletions docs/ghe-222.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,20 @@ octokit.enterpriseAdmin.deleteUser({ username });
octokit.enterpriseAdmin.demoteSiteAdministrator({ username });
octokit.enterpriseAdmin.enableOrDisableMaintenanceMode({ maintenance });
octokit.enterpriseAdmin.getAllAuthorizedSshKeys();
octokit.enterpriseAdmin.getAllStats();
octokit.enterpriseAdmin.getCommentStats();
octokit.enterpriseAdmin.getConfigurationStatus();
octokit.enterpriseAdmin.getDownloadStatusForPreReceiveEnvironment({
pre_receive_environment_id,
});
octokit.enterpriseAdmin.getGlobalWebhook({ hook_id });
octokit.enterpriseAdmin.getHooksStats();
octokit.enterpriseAdmin.getIssueStats();
octokit.enterpriseAdmin.getLicenseInformation();
octokit.enterpriseAdmin.getMaintenanceStatus();
octokit.enterpriseAdmin.getMilestoneStats();
octokit.enterpriseAdmin.getOrgStats();
octokit.enterpriseAdmin.getPagesStats();
octokit.enterpriseAdmin.getPreReceiveEnvironment({
pre_receive_environment_id,
});
Expand All @@ -53,8 +60,10 @@ octokit.enterpriseAdmin.getPreReceiveHookForRepo({
repo,
pre_receive_hook_id,
});
octokit.enterpriseAdmin.getPullRequestStats();
octokit.enterpriseAdmin.getRepoStats();
octokit.enterpriseAdmin.getSettings();
octokit.enterpriseAdmin.getTypeStats({ type });
octokit.enterpriseAdmin.getUserStats();
octokit.enterpriseAdmin.listGlobalWebhooks({ per_page, page });
octokit.enterpriseAdmin.listPersonalAccessTokens({ per_page, page });
octokit.enterpriseAdmin.listPreReceiveEnvironments({
Expand Down Expand Up @@ -593,7 +602,7 @@ octokit.repos.setUserAccessRestrictions({owner, repo, branch, users});
octokit.repos.testPushWebhook({owner, repo, hook_id});
octokit.repos.transfer({owner, repo, new_owner, team_ids});
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});
octokit.repos.updateBranchProtection({owner, repo, branch, required_status_checks, enforce_admins, required_pull_request_reviews, restrictions, required_linear_history, allow_force_pushes, allow_deletions});
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});
octokit.repos.updateCommitComment({owner, repo, comment_id, body});
octokit.repos.updateInformationAboutPagesSite({owner, repo, cname, https_enforced, public, source});
octokit.repos.updateInvitation({owner, repo, invitation_id, permissions});
Expand All @@ -606,9 +615,9 @@ octokit.repos.uploadReleaseAsset({owner, repo, release_id, name, label, data, or
octokit.search.code({q, sort, order, per_page, page});
octokit.search.commits({q, sort, order, per_page, page});
octokit.search.issuesAndPullRequests({q, sort, order, per_page, page});
octokit.search.labels({repository_id, q, sort, order});
octokit.search.labels({repository_id, q, sort, order, per_page, page});
octokit.search.repos({q, sort, order, per_page, page});
octokit.search.topics({q});
octokit.search.topics({q, per_page, page});
octokit.search.users({q, sort, order, per_page, page});
octokit.teams.addMemberLegacy({team_id, username});
octokit.teams.addOrUpdateMembershipForUser({team_id, username, role});
Expand Down
17 changes: 13 additions & 4 deletions docs/ghe-30.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,23 @@ octokit.enterpriseAdmin.enableSelectedOrganizationGithubActionsEnterprise({
org_id,
});
octokit.enterpriseAdmin.getAllAuthorizedSshKeys();
octokit.enterpriseAdmin.getAllStats();
octokit.enterpriseAdmin.getAllowedActionsEnterprise({ enterprise });
octokit.enterpriseAdmin.getAnnouncement();
octokit.enterpriseAdmin.getCommentStats();
octokit.enterpriseAdmin.getConfigurationStatus();
octokit.enterpriseAdmin.getDownloadStatusForPreReceiveEnvironment({
pre_receive_environment_id,
});
octokit.enterpriseAdmin.getGithubActionsPermissionsEnterprise({ enterprise });
octokit.enterpriseAdmin.getGlobalWebhook({ hook_id });
octokit.enterpriseAdmin.getHooksStats();
octokit.enterpriseAdmin.getIssueStats();
octokit.enterpriseAdmin.getLicenseInformation();
octokit.enterpriseAdmin.getMaintenanceStatus();
octokit.enterpriseAdmin.getMilestoneStats();
octokit.enterpriseAdmin.getOrgStats();
octokit.enterpriseAdmin.getPagesStats();
octokit.enterpriseAdmin.getPreReceiveEnvironment({
pre_receive_environment_id,
});
Expand All @@ -64,8 +71,10 @@ octokit.enterpriseAdmin.getPreReceiveHookForRepo({
repo,
pre_receive_hook_id,
});
octokit.enterpriseAdmin.getPullRequestStats();
octokit.enterpriseAdmin.getRepoStats();
octokit.enterpriseAdmin.getSettings();
octokit.enterpriseAdmin.getTypeStats({ type });
octokit.enterpriseAdmin.getUserStats();
octokit.enterpriseAdmin.listGlobalWebhooks({ per_page, page });
octokit.enterpriseAdmin.listPersonalAccessTokens({ per_page, page });
octokit.enterpriseAdmin.listPreReceiveEnvironments({
Expand Down Expand Up @@ -643,7 +652,7 @@ octokit.repos.setUserAccessRestrictions({owner, repo, branch, users});
octokit.repos.testPushWebhook({owner, repo, hook_id});
octokit.repos.transfer({owner, repo, new_owner, team_ids});
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});
octokit.repos.updateBranchProtection({owner, repo, branch, required_status_checks, enforce_admins, required_pull_request_reviews, restrictions, required_linear_history, allow_force_pushes, allow_deletions});
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});
octokit.repos.updateCommitComment({owner, repo, comment_id, body});
octokit.repos.updateInformationAboutPagesSite({owner, repo, cname, https_enforced, public, source});
octokit.repos.updateInvitation({owner, repo, invitation_id, permissions});
Expand All @@ -657,9 +666,9 @@ octokit.repos.uploadReleaseAsset({owner, repo, release_id, name, label, data, or
octokit.search.code({q, sort, order, per_page, page});
octokit.search.commits({q, sort, order, per_page, page});
octokit.search.issuesAndPullRequests({q, sort, order, per_page, page});
octokit.search.labels({repository_id, q, sort, order});
octokit.search.labels({repository_id, q, sort, order, per_page, page});
octokit.search.repos({q, sort, order, per_page, page});
octokit.search.topics({q});
octokit.search.topics({q, per_page, page});
octokit.search.users({q, sort, order, per_page, page});
octokit.teams.addMemberLegacy({team_id, username});
octokit.teams.addOrUpdateMembershipForUser({team_id, username, role});
Expand Down
12 changes: 12 additions & 0 deletions package-lock.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
"test": "jest --coverage",
"update-endpoints": "npm-run-all update-endpoints:*",
"update-endpoints:fetch-json": "node scripts/update-endpoints/fetch-json",
"update-endpoints:code": "node scripts/update-endpoints/code"
"update-endpoints:code": "node scripts/update-endpoints/code",
"update-endpoints:types": "node scripts/update-endpoints/types"
},
"repository": "github:octokit/plugin-enterprise-server.js",
"keywords": [
Expand Down Expand Up @@ -44,11 +45,13 @@
"fetch-mock": "^9.0.0",
"github-openapi-graphql-query": "^1.0.5",
"jest": "^27.0.0",
"lodash.camelcase": "^4.3.0",
"npm-run-all": "^4.1.5",
"prettier": "2.3.2",
"semantic-release": "^17.0.0",
"semantic-release-plugin-update-version-in-files": "^1.0.0",
"sort-keys": "^4.2.0",
"string-to-jsdoc-comment": "^1.0.0",
"ts-jest": "^27.0.0-next.12",
"typescript": "^4.0.2"
},
Expand Down
7 changes: 5 additions & 2 deletions scripts/update-endpoints/code.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,16 +110,19 @@ async function generateRoutes() {
(version) => `
import ENDPOINTS_${version} from "./generated/ghe-${version}-endpoints";
import ADMIN_ENDPOINTS_${version} from "./generated/ghe-${version}-admin-endpoints";
import { RestEndpointMethods as RestEndpointMethods_${version} } from "./generated/ghe-${version}-method-types";
`
).join("\n");
const methods = GHE_VERSIONS.map(
(version) => `
export function enterpriseServer${version}Admin(octokit: Octokit) {
export function enterpriseServer${version}Admin(octokit: Octokit): { enterpriseAdmin: RestEndpointMethods_${version}["enterpriseAdmin"] } {
// @ts-ignore - not worth the hassle
return endpointsToMethods(octokit, ADMIN_ENDPOINTS_${version});
}
enterpriseServer${version}Admin.VERSION = VERSION;
export function enterpriseServer${version}(octokit: Octokit) {
export function enterpriseServer${version}(octokit: Octokit): RestEndpointMethods_${version} {
// @ts-ignore - not worth the hassle
return endpointsToMethods(octokit, ENDPOINTS_${version});
}
enterpriseServer${version}.VERSION = VERSION;
Expand Down
Loading

0 comments on commit 8164819

Please sign in to comment.