feat(typescript): definitions for .verify, .verifyAndReceive, .receiv…

…e, .removeListener, .middleware methods (#55)
octokit · Jan 26, 2019 · 79fcec2 · 79fcec2
1 parent 91ebccb
commit 79fcec2
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 4 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -1,10 +1,14 @@
 // DO NOT EDIT THIS FILE DIRECTLY
 // make edits in scripts/generate-types.js
 
+import http = require("http");
+
 export type Options = {
   secret: string;
   path?: string;
-  transform?: (event: Webhooks.WebhookEvent<T>) => Webhooks.WebhookEvent<T> & { [key: string]: any };
+  transform?: (
+    event: Webhooks.WebhookEvent<T>
+  ) => Webhooks.WebhookEvent<T> & { [key: string]: any };
 };
 
 export type WebhookPayloadWatchSender = {
@@ -3477,9 +3481,13 @@ export namespace Webhooks {
 
     public on(event: "error", callback: (event: Error) => void): void;
     public on(
-      event: "*" | string[],
+      event: "*" | string | string[],
       callback: (event: Webhooks.WebhookEvent<any>) => void
     ): void;
+    public on(
+      event: "*" | string | string[],
+      callback: (event: Webhooks.WebhookEvent<any>) => Promise<void>
+    ): void;
 
     public on(
       event:
@@ -3812,5 +3820,30 @@ export namespace Webhooks {
     ): void;
 
     public sign(data: any): string;
+    public verify(eventPayload: any, signature: string): boolean;
+    public verifyAndReceive(options: {
+      id: string;
+      name: string;
+      payload: any;
+      signature: string;
+    }): Promise<void>;
+    public receive(options: {
+      id: string;
+      name: string;
+      payload: any;
+    }): Promise<void>;
+    public removeListener(
+      event: string | string[],
+      callback: (event: Webhooks.WebhookEvent<any>) => void
+    ): void;
+    public removeListener(
+      event: string | string[],
+      callback: (event: Webhooks.WebhookEvent<any>) => Promise<void>
+    ): void;
+    public middleware(
+      request: http.ClientRequest,
+      response: http.ServerResponse,
+      next: (err?: any) => void
+    ): (request: http.IncomingMessage, response: http.ServerResponse) => void;
   }
 }
diff --git a/package.json b/package.json
@@ -38,7 +38,7 @@
     "pretest": "standard",
     "test": "tap --100 --coverage 'test/**/*-test.js'",
     "semantic-release": "semantic-release",
-    "generate-types": "node generate-types.js"
+    "generate-types": "node scripts/generate-types.js"
   },
   "repository": {
     "type": "git",

diff --git a/scripts/generate-types.js b/scripts/generate-types.js
@@ -32,6 +32,8 @@ const definition = `
 // DO NOT EDIT THIS FILE DIRECTLY
 // make edits in scripts/generate-types.js
 
+import http = require('http')
+
 export type Options = {
   secret: string
   path?: string
@@ -53,10 +55,17 @@ export namespace Webhooks {
     constructor (options: Options)
 
     public on (event: 'error', callback: (event: Error) => void): void
-    public on (event: '*' | string[], callback: (event: Webhooks.WebhookEvent<any>) => void): void
+    public on (event: '*' | string | string[], callback: (event: Webhooks.WebhookEvent<any>) => void): void
+    public on (event: '*' | string | string[], callback: (event: Webhooks.WebhookEvent<any>) => Promise<void>): void
     ${signatures.join('\n')}
 
     public sign (data: any): string
+    public verify (eventPayload: any, signature: string): boolean
+    public verifyAndReceive (options: { id: string, name: string, payload: any, signature: string }): Promise<void>
+    public receive (options: { id: string, name: string, payload: any }): Promise<void>
+    public removeListener (event: string | string[], callback: (event: Webhooks.WebhookEvent<any>) => void): void
+    public removeListener (event: string | string[], callback: (event: Webhooks.WebhookEvent<any>) => Promise<void>): void
+    public middleware (request: http.ClientRequest, response: http.ServerResponse, next: (err?: any) => void): (request: http.IncomingMessage, response: http.ServerResponse) => void
   }
 }
 `