@octokit/plugin-rest-endpoint-methods - npm Package Compare versions

Comparing version 3.6.0 to 3.7.0

dist-node/index.js

@@ -1166,3 +1166,3 @@ 'use strict';
 
-const VERSION = "3.6.0";
+const VERSION = "3.7.0";
 
@@ -1169,0 +1169,0 @@ function endpointsToMethods(octokit, endpointsMap) {

dist-src/version.js

@@ -1,1 +0,1 @@
-export const VERSION = "3.6.0";
+export const VERSION = "3.7.0";

dist-types/endpoints-to-methods.d.ts

 import { Octokit } from "@octokit/core";
 import { EndpointsDefaultsAndDecorations } from "./types";
-import { RestEndpointMethods } from "./generated/types";
+import { RestEndpointMethods } from "./generated/method-types";
 export declare function endpointsToMethods(octokit: Octokit, endpointsMap: EndpointsDefaultsAndDecorations): RestEndpointMethods;

dist-types/index.d.ts

 import { Octokit } from "@octokit/core";
+export { RestEndpointMethodTypes } from "./generated/parameters-and-response-types";
 import { Api } from "./types";
@@ -3,0 +4,0 @@ /**

dist-types/types.d.ts

 import { Route, RequestParameters } from "@octokit/types";
-import { RestEndpointMethods } from "./generated/types";
+import { RestEndpointMethods } from "./generated/method-types";
 export declare type Api = RestEndpointMethods;
@@ -4,0 +4,0 @@ export declare type EndpointDecorations = {

dist-types/version.d.ts

@@ -1,1 +0,1 @@
-export declare const VERSION = "3.6.0";
+export declare const VERSION = "3.7.0";

dist-web/index.js

@@ -1293,3 +1293,3 @@ const Endpoints = {
 
-const VERSION = "3.6.0";
+const VERSION = "3.7.0";
 
@@ -1296,0 +1296,0 @@ function endpointsToMethods(octokit, endpointsMap) {

package.json

 {
   "name": "@octokit/plugin-rest-endpoint-methods",
   "description": "Octokit plugin adding one method for all of api.github.com REST API endpoints",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "license": "MIT",
@@ -20,3 +20,3 @@ "files": [
   "dependencies": {
-    "@octokit/types": "^2.0.1",
+    "@octokit/types": "^2.11.1",
     "deprecation": "^2.3.1"
@@ -23,0 +23,0 @@ },

README.md

@@ -54,2 +54,15 @@ # plugin-rest-endpoint-methods.js
 
+## TypeScript
+
+Parameter and response types for all endpoint methods exported as `{ RestEndpointMethodTypes }`.
+
+Example
+
+```ts
+import { RestEndpointMethodTypes } from "@octokit/rest-endpoint-methods";
+
+type UpdateLabelParameters = RestEndpointMethodTypes["issues"]["updateLabel"]["parameters"];
+type UpdateLabelResponse = RestEndpointMethodTypes["issues"]["updateLabel"]["response"];
+```
+
 ## Contributing
@@ -56,0 +69,0 @@

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

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

Number of package files

21

increased by10.53%

Number of lines in readme file

74

increased by21.31%

Worsened metrics

Total package byte prevSize

956097

decreased by-38.24%

Lines of code

12306

decreased by-67.08%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• Updated@octokit/types@^2.11.1