feat: new GET /users/{username}/settings/billing/usage, POST /credentials/revoke endpoints, endpoint type updates, type performance fixes (#675)

octokit[bot] · octokitbot · wolfy1339 · web-flow · commit a7ec8303ea2c · 2025-05-25T18:37:08.000-04:00
* WIP octokit/openapi updated * fix: implement some performance improvements (#667) * Pre-compute the keys of the `Endpoint` type in order to not have to compute them multiple times * Use interface extends instead of intersections See https://github.com/microsoft/TypeScript/wiki/Performance Part of #666 --------- Co-authored-by: Octokit Bot <33075676+octokitbot@users.noreply.github.com> Co-authored-by: wolfy1339 <4595477+wolfy1339@users.noreply.github.com>
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -7,7 +7,7 @@
   },
   "description": "Shared TypeScript definitions for Octokit projects",
   "dependencies": {
-    "@octokit/openapi-types": "^25.0.0"
+    "@octokit/openapi-types": "^25.1.0"
   },
   "scripts": {
     "build": "node scripts/build.mjs && tsc -p tsconfig.json",
@@ -76,6 +76,6 @@
     ]
   },
   "octokit": {
-    "openapi-version": "19.0.0"
+    "openapi-version": "19.1.0"
   }
 }
diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json
@@ -3961,6 +3961,19 @@
     ],
     "renamed": null
   },
+  {
+    "method": "GET",
+    "url": "/users/{username}/settings/billing/usage",
+    "documentationUrl": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-a-user",
+    "parameters": [
+      { "alias": null, "deprecated": null, "in": "PATH", "name": "username" },
+      { "alias": null, "deprecated": null, "in": "QUERY", "name": "year" },
+      { "alias": null, "deprecated": null, "in": "QUERY", "name": "month" },
+      { "alias": null, "deprecated": null, "in": "QUERY", "name": "day" },
+      { "alias": null, "deprecated": null, "in": "QUERY", "name": "hour" }
+    ],
+    "renamed": null
+  },
   {
     "method": "GET",
     "url": "/orgs/{org}/settings/billing/packages",
@@ -6938,6 +6951,15 @@
     ],
     "renamed": null
   },
+  {
+    "method": "POST",
+    "url": "/credentials/revoke",
+    "documentationUrl": "https://docs.github.com/rest/credentials/revoke#revoke-a-list-of-credentials",
+    "parameters": [
+      { "alias": null, "deprecated": null, "in": "BODY", "name": "credentials" }
+    ],
+    "renamed": null
+  },
   {
     "method": "PUT",
     "url": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}",
@@ -7104,6 +7126,7 @@
         "in": "QUERY",
         "name": "epss_percentage"
       },
+      { "alias": null, "deprecated": null, "in": "QUERY", "name": "has" },
       { "alias": null, "deprecated": null, "in": "QUERY", "name": "scope" },
       { "alias": null, "deprecated": null, "in": "QUERY", "name": "sort" },
       { "alias": null, "deprecated": null, "in": "QUERY", "name": "direction" },
@@ -7131,6 +7154,7 @@
         "in": "QUERY",
         "name": "epss_percentage"
       },
+      { "alias": null, "deprecated": null, "in": "QUERY", "name": "has" },
       { "alias": null, "deprecated": null, "in": "QUERY", "name": "scope" },
       { "alias": null, "deprecated": null, "in": "QUERY", "name": "sort" },
       { "alias": null, "deprecated": null, "in": "QUERY", "name": "direction" },
@@ -7160,6 +7184,7 @@
         "in": "QUERY",
         "name": "epss_percentage"
       },
+      { "alias": null, "deprecated": null, "in": "QUERY", "name": "has" },
       { "alias": null, "deprecated": null, "in": "QUERY", "name": "scope" },
       { "alias": null, "deprecated": null, "in": "QUERY", "name": "sort" },
       { "alias": null, "deprecated": null, "in": "QUERY", "name": "direction" },
diff --git a/scripts/update-endpoints/templates/endpoints.ts.template b/scripts/update-endpoints/templates/endpoints.ts.template
@@ -116,4 +116,6 @@ export interface Endpoints {
     "{{method}}"
   >,
   {{/each}}
-}
+}
+
+export type EndpointKeys = keyof Endpoints;
diff --git a/src/EndpointDefaults.ts b/src/EndpointDefaults.ts
@@ -7,7 +7,7 @@ import type { Url } from "./Url.js";
  * The `.endpoint()` method is guaranteed to set all keys defined by RequestParameters
  * as well as the method property.
  */
-export type EndpointDefaults = RequestParameters & {
+export interface EndpointDefaults extends RequestParameters {
   baseUrl: Url;
   method: RequestMethod;
   url?: Url;
@@ -19,4 +19,4 @@ export type EndpointDefaults = RequestParameters & {
     format: string;
     previews?: string[];
   };
-};
+}
diff --git a/src/EndpointInterface.ts b/src/EndpointInterface.ts
@@ -3,7 +3,7 @@ import type { RequestOptions } from "./RequestOptions.js";
 import type { RequestParameters } from "./RequestParameters.js";
 import type { Route } from "./Route.js";
 
-import type { Endpoints } from "./generated/Endpoints.js";
+import type { EndpointKeys, Endpoints } from "./generated/Endpoints.js";
 
 export interface EndpointInterface<D extends object = object> {
   /**
@@ -25,13 +25,13 @@ export interface EndpointInterface<D extends object = object> {
    */
   <
     R extends Route,
-    P extends RequestParameters = R extends keyof Endpoints
+    P extends RequestParameters = R extends EndpointKeys
       ? Endpoints[R]["parameters"] & RequestParameters
       : RequestParameters,
   >(
-    route: keyof Endpoints | R,
+    route: EndpointKeys | R,
     parameters?: P,
-  ): (R extends keyof Endpoints ? Endpoints[R]["request"] : RequestOptions) &
+  ): (R extends EndpointKeys ? Endpoints[R]["request"] : RequestOptions) &
     Pick<P, keyof RequestOptions>;
 
   /**
@@ -57,14 +57,14 @@ export interface EndpointInterface<D extends object = object> {
      */
     <
       R extends Route,
-      P extends RequestParameters = R extends keyof Endpoints
+      P extends RequestParameters = R extends EndpointKeys
         ? Endpoints[R]["parameters"] & RequestParameters
         : RequestParameters,
     >(
-      route: keyof Endpoints | R,
+      route: EndpointKeys | R,
       parameters?: P,
     ): D &
-      (R extends keyof Endpoints
+      (R extends EndpointKeys
         ? Endpoints[R]["request"] & Endpoints[R]["parameters"]
         : EndpointDefaults) &
       P;
diff --git a/src/EndpointOptions.ts b/src/EndpointOptions.ts
@@ -2,7 +2,7 @@ import type { RequestMethod } from "./RequestMethod.js";
 import type { Url } from "./Url.js";
 import type { RequestParameters } from "./RequestParameters.js";
 
-export type EndpointOptions = RequestParameters & {
+export interface EndpointOptions extends RequestParameters {
   method: RequestMethod;
   url: Url;
-};
+}
diff --git a/src/RequestInterface.ts b/src/RequestInterface.ts
@@ -3,7 +3,7 @@ import type { OctokitResponse } from "./OctokitResponse.js";
 import type { RequestParameters } from "./RequestParameters.js";
 import type { Route } from "./Route.js";
 
-import type { Endpoints } from "./generated/Endpoints.js";
+import type { EndpointKeys, Endpoints } from "./generated/Endpoints.js";
 
 export interface RequestInterface<D extends object = object> {
   /**
@@ -24,11 +24,11 @@ export interface RequestInterface<D extends object = object> {
    * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`.
    */
   <R extends Route>(
-    route: keyof Endpoints | R,
-    options?: R extends keyof Endpoints
+    route: EndpointKeys | R,
+    options?: R extends EndpointKeys
       ? Endpoints[R]["parameters"] & RequestParameters
       : RequestParameters,
-  ): R extends keyof Endpoints
+  ): R extends EndpointKeys
     ? Promise<Endpoints[R]["response"]>
     : Promise<OctokitResponse<any>>;
 
diff --git a/src/generated/Endpoints.ts b/src/generated/Endpoints.ts
@@ -4724,6 +4724,13 @@ export interface Endpoints {
     "/users/{username}/settings/billing/shared-storage",
     "get"
   >;
+  /**
+   * @see https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-a-user
+   */
+  "GET /users/{username}/settings/billing/usage": Operation<
+    "/users/{username}/settings/billing/usage",
+    "get"
+  >;
   /**
    * @see https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user
    */
@@ -5205,6 +5212,10 @@ export interface Endpoints {
     "/applications/{client_id}/token/scoped",
     "post"
   >;
+  /**
+   * @see https://docs.github.com/rest/credentials/revoke#revoke-a-list-of-credentials
+   */
+  "POST /credentials/revoke": Operation<"/credentials/revoke", "post">;
   /**
    * @see https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise
    */
@@ -6892,3 +6903,5 @@ export interface Endpoints {
     "put"
   >;
 }
+
+export type EndpointKeys = keyof Endpoints;

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`},`
`8`	`8`	`"description": "Shared TypeScript definitions for Octokit projects",`
`9`	`9`	`"dependencies": {`
`10`		`- "@octokit/openapi-types": "^25.0.0"`
	`10`	`+ "@octokit/openapi-types": "^25.1.0"`
`11`	`11`	`},`
`12`	`12`	`"scripts": {`
`13`	`13`	`"build": "node scripts/build.mjs && tsc -p tsconfig.json",`
`@@ -76,6 +76,6 @@`
`76`	`76`	`]`
`77`	`77`	`},`
`78`	`78`	`"octokit": {`
`79`		`- "openapi-version": "19.0.0"`
	`79`	`+ "openapi-version": "19.1.0"`
`80`	`80`	`}`
`81`	`81`	`}`