@octokit/webhooks - npm Package Compare versions

Comparing version 13.0.0-beta.2 to 13.0.0-beta.3

dist-node/index.js

@@ -646,2 +646,10 @@ // pkg/dist-src/createLogger.js
 var Webhooks = class {
+  sign;
+  verify;
+  on;
+  onAny;
+  onError;
+  removeListener;
+  receive;
+  verifyAndReceive;
   constructor(options) {
@@ -648,0 +656,0 @@ if (!options || !options.secret) {

dist-src/index.js

 import { createLogger } from "./createLogger.js";
-import { createEventHandler } from "./event-handler/index.js";
+import {
+  createEventHandler
+} from "./event-handler/index.js";
 import { sign, verify } from "@octokit/webhooks-methods";
@@ -8,2 +10,10 @@ import { verifyAndReceive } from "./verify-and-receive.js";
 class Webhooks {
+  sign;
+  verify;
+  on;
+  onAny;
+  onError;
+  removeListener;
+  receive;
+  verifyAndReceive;
   constructor(options) {
@@ -10,0 +20,0 @@ if (!options || !options.secret) {

dist-types/event-handler/index.d.ts

@@ -1,3 +0,3 @@
-import type { EmitterWebhookEvent, EmitterWebhookEventName, HandlerFunction, Options, WebhookEventHandlerError } from "../types.js";
-interface EventHandler<TTransformed> {
+import type { EmitterWebhookEvent, EmitterWebhookEventName, HandlerFunction, Options, WebhookError, WebhookEventHandlerError } from "../types.js";
+export interface EventHandler<TTransformed> {
     on<E extends EmitterWebhookEventName>(event: E | E[], callback: HandlerFunction<E, TTransformed>): void;
@@ -7,5 +7,4 @@ onAny(handler: (event: TTransformed extends unknown ? EmitterWebhookEvent : EmitterWebhookEvent & TTransformed) => any): void;
     removeListener<E extends EmitterWebhookEventName>(event: E | E[], callback: HandlerFunction<E, TTransformed>): void;
-    receive(event: EmitterWebhookEvent): Promise<void>;
+    receive(event: EmitterWebhookEvent | WebhookError): Promise<void>;
 }
 export declare function createEventHandler<TTransformed>(options: Options<TTransformed>): EventHandler<TTransformed>;
-export {};

dist-types/event-handler/receive.d.ts

@@ -1,2 +0,2 @@
-import type { EmitterWebhookEvent, State } from "../types.js";
-export declare function receiverHandle(state: State, event: EmitterWebhookEvent): Promise<void>;
+import type { EmitterWebhookEvent, State, WebhookError } from "../types.js";
+export declare function receiverHandle(state: State, event: EmitterWebhookEvent | WebhookError): Promise<void>;

dist-types/types.d.ts

 import type { RequestError } from "@octokit/request-error";
-import type { webhooks as OpenAPIWebhooks } from "@wolfy1339/openapi-webhooks-types";
+import type { webhooks as OpenAPIWebhooks } from "@octokit/openapi-webhooks-types";
 import type { EventPayloadMap } from "./generated/webhook-identifiers.js";
 import type { Logger } from "./createLogger.js";
+import type { EventHandler } from "./event-handler/index.js";
 import type { emitterEventNames } from "./generated/webhook-names.js";
@@ -19,3 +20,3 @@ import type AggregateError from "aggregate-error";
     id: string;
-    name: EmitterWebhookEventName;
+    name: WebhookEventName;
     payload: string;
@@ -41,3 +42,3 @@ signature: string;
 export interface State extends Options<any> {
-    eventHandler?: any;
+    eventHandler?: EventHandler<unknown>;
     hooks: Hooks;
@@ -44,0 +45,0 @@ log: Logger;

dist-types/verify-and-receive.d.ts

 import type { EmitterWebhookEventWithStringPayloadAndSignature, State } from "./types.js";
+import type { EventHandler } from "./event-handler/index.js";
 export declare function verifyAndReceive(state: State & {
     secret: string;
+    eventHandler: EventHandler<unknown>;
 }, event: EmitterWebhookEventWithStringPayloadAndSignature): Promise<void>;

dist-web/index.js

@@ -646,2 +646,10 @@ // pkg/dist-src/createLogger.js
 var Webhooks = class {
+  sign;
+  verify;
+  on;
+  onAny;
+  onError;
+  removeListener;
+  receive;
+  verifyAndReceive;
   constructor(options) {
@@ -648,0 +656,0 @@ if (!options || !options.secret) {

package.json

 {
   "name": "@octokit/webhooks",
-  "version": "13.0.0-beta.2",
+  "version": "13.0.0-beta.3",
   "type": "module",
@@ -13,3 +13,3 @@ "description": "GitHub webhook events toolset for Node.js",
     "@octokit/webhooks-methods": "^4.0.0",
-    "@wolfy1339/openapi-webhooks-types": "5.1.3",
+    "@octokit/openapi-webhooks-types": "5.3.2",
     "aggregate-error": "^5.0.0"
@@ -19,6 +19,6 @@ },
     "@jest/types": "^29.0.0",
-    "@octokit/tsconfig": "^2.0.0",
+    "@octokit/openapi-webhooks": "5.3.2",
+    "@octokit/tsconfig": "^3.0.0",
     "@types/jest": "^29.0.0",
     "@types/node": "^20.0.0",
-    "@wolfy1339/openapi-webhooks": "5.1.3",
     "axios": "^1.0.0",
@@ -25,0 +25,0 @@ "esbuild": "^0.20.0",

README.md

@@ -186,3 +186,3 @@ # @octokit/webhooks
         <em>
-          (Object [deprecated] or String)
+          (String)
         </em>
@@ -250,3 +250,3 @@ </td>
         <em>
-          Object (deprecated) or String
+          String
         </em>
@@ -253,0 +253,0 @@ </td>

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

207214

increased by0.4%

Lines of code

2287

increased by1.24%

Dependency changes

• + Added@octokit/openapi-webhooks-types@5.3.2

• + Added@octokit/openapi-webhooks-types@5.3.2(transitive)

• - Removed@wolfy1339/openapi-webhooks-types@5.1.3

• - Removed@wolfy1339/openapi-webhooks-types@5.1.3(transitive)