First upload version 0.0.1
This commit is contained in:
Neyra
20
node_modules/@octokit/webhooks/LICENSE.md
generated
vendored
Normal file
20
node_modules/@octokit/webhooks/LICENSE.md
generated
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
Copyright (c) GitHub 2025 - Licensed as MIT.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
786
node_modules/@octokit/webhooks/README.md
generated
vendored
Normal file
786
node_modules/@octokit/webhooks/README.md
generated
vendored
Normal file
@@ -0,0 +1,786 @@
|
||||
# @octokit/webhooks
|
||||
|
||||
> GitHub webhook events toolset for Node.js
|
||||
|
||||
[](https://www.npmjs.com/package/@octokit/webhooks)
|
||||
[](https://github.com/octokit/webhooks.js/actions?query=workflow)
|
||||
|
||||
<!-- toc -->
|
||||
|
||||
- [Usage](#usage)
|
||||
- [Local development](#local-development)
|
||||
- [API](#api)
|
||||
- [Constructor](#constructor)
|
||||
- [webhooks.sign()](#webhookssign)
|
||||
- [webhooks.verify()](#webhooksverify)
|
||||
- [webhooks.verifyAndReceive()](#webhooksverifyandreceive)
|
||||
- [webhooks.receive()](#webhooksreceive)
|
||||
- [webhooks.on()](#webhookson)
|
||||
- [webhooks.onAny()](#webhooksonany)
|
||||
- [webhooks.onError()](#webhooksonerror)
|
||||
- [webhooks.removeListener()](#webhooksremovelistener)
|
||||
- [createNodeMiddleware()](#createnodemiddleware)
|
||||
- [Webhook events](#webhook-events)
|
||||
- [emitterEventNames](#emittereventnames)
|
||||
- [validateEventName](#validateeventname)
|
||||
- [TypeScript](#typescript)
|
||||
- [`EmitterWebhookEventName`](#emitterwebhookeventname)
|
||||
- [`EmitterWebhookEvent`](#emitterwebhookevent)
|
||||
- [License](#license)
|
||||
|
||||
<!-- tocstop -->
|
||||
|
||||
`@octokit/webhooks` helps to handle webhook events received from GitHub.
|
||||
|
||||
[GitHub webhooks](https://docs.github.com/webhooks/) can be registered in multiple ways
|
||||
|
||||
1. In repository or organization settings on [github.com](https://github.com/).
|
||||
2. Using the REST API for [repositories](https://docs.github.com/rest/reference/repos#webhooks) or [organizations](https://docs.github.com/rest/reference/orgs#webhooks/)
|
||||
3. By [creating a GitHub App](https://docs.github.com/developers/apps/creating-a-github-app).
|
||||
|
||||
Note that while setting a secret is optional on GitHub, it is required to be set in order to use `@octokit/webhooks`. Content Type must be set to `application/json`, `application/x-www-form-urlencoded` is not supported.
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
// install with: npm install @octokit/webhooks
|
||||
import { Webhooks, createNodeMiddleware } from "@octokit/webhooks";
|
||||
import { createServer } from "node:http";
|
||||
const webhooks = new Webhooks({
|
||||
secret: "mysecret",
|
||||
});
|
||||
|
||||
webhooks.onAny(({ id, name, payload }) => {
|
||||
console.log(name, "event received");
|
||||
});
|
||||
|
||||
createServer(createNodeMiddleware(webhooks)).listen(3000);
|
||||
// can now receive webhook events at /api/github/webhooks
|
||||
```
|
||||
|
||||
## Local development
|
||||
|
||||
You can receive webhooks on your local machine or even browser using [EventSource](https://developer.mozilla.org/en-US/docs/Web/API/EventSource) and [smee.io](https://smee.io/).
|
||||
|
||||
Go to [smee.io](https://smee.io/) and <kbd>Start a new channel</kbd>. Then copy the "Webhook Proxy URL" and
|
||||
|
||||
1. enter it in the GitHub App’s "Webhook URL" input
|
||||
2. pass it to the [EventSource](https://github.com/EventSource/eventsource) constructor, see below
|
||||
|
||||
```js
|
||||
const webhookProxyUrl = "https://smee.io/IrqK0nopGAOc847"; // replace with your own Webhook Proxy URL
|
||||
const source = new EventSource(webhookProxyUrl);
|
||||
source.onmessage = (event) => {
|
||||
const webhookEvent = JSON.parse(event.data);
|
||||
webhooks
|
||||
.verifyAndReceive({
|
||||
id: webhookEvent["x-request-id"],
|
||||
name: webhookEvent["x-github-event"],
|
||||
signature: webhookEvent["x-hub-signature"],
|
||||
payload: JSON.stringify(webhookEvent.body),
|
||||
})
|
||||
.catch(console.error);
|
||||
};
|
||||
```
|
||||
|
||||
`EventSource` is a native browser API and can be polyfilled for browsers that don’t support it. In node, you can use the [`eventsource`](https://github.com/EventSource/eventsource) package: install with `npm install eventsource`, then `import EventSource from "eventsource";)`
|
||||
|
||||
## API
|
||||
|
||||
1. [Constructor](#constructor)
|
||||
1. [webhooks.sign()](#webhookssign)
|
||||
1. [webhooks.verify()](#webhooksverify)
|
||||
1. [webhooks.verifyAndReceive()](#webhooksverifyandreceive)
|
||||
1. [webhooks.receive()](#webhooksreceive)
|
||||
1. [webhooks.on()](#webhookson)
|
||||
1. [webhooks.onAny()](#webhooksonany)
|
||||
1. [webhooks.onError()](#webhooksonerror)
|
||||
1. [webhooks.removeListener()](#webhooksremovelistener)
|
||||
1. [createNodeMiddleware()](#createnodemiddleware)
|
||||
1. [createWebMiddleware()](#createwebmiddleware)
|
||||
1. [Webhook events](#webhook-events)
|
||||
1. [emitterEventNames](#emittereventnames)
|
||||
1. [validateEventName](#validateeventname)
|
||||
|
||||
### Constructor
|
||||
|
||||
```js
|
||||
new Webhooks({ secret /*, transform */ });
|
||||
```
|
||||
|
||||
<table width="100%">
|
||||
<tbody valign="top">
|
||||
<tr>
|
||||
<td>
|
||||
<code>secret</code>
|
||||
<em>(String)</em>
|
||||
</td>
|
||||
<td>
|
||||
<strong>Required.</strong>
|
||||
Secret as configured in GitHub Settings.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>transform</code>
|
||||
<em>(Function)</em>
|
||||
</td>
|
||||
<td>
|
||||
Only relevant for <a href="#webhookson"><code>webhooks.on</code></a>.
|
||||
Transform emitted event before calling handlers. Can be asynchronous.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>log</code>
|
||||
<em>
|
||||
object
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Used for internal logging. Defaults to [`console`](https://developer.mozilla.org/en-US/docs/Web/API/console) with `debug` and `info` doing nothing.
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
Returns the `webhooks` API.
|
||||
|
||||
### webhooks.sign()
|
||||
|
||||
```js
|
||||
webhooks.sign(eventPayload);
|
||||
```
|
||||
|
||||
<table width="100%">
|
||||
<tbody valign="top">
|
||||
<tr>
|
||||
<td>
|
||||
<code>eventPayload</code>
|
||||
<em>
|
||||
(String)
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<strong>Required.</strong>
|
||||
Webhook request payload as received from GitHub
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
Returns a `signature` string. Throws error if `eventPayload` is not passed.
|
||||
|
||||
The `sign` method can be imported as static method from [`@octokit/webhooks-methods`](https://github.com/octokit/webhooks-methods.js/#readme).
|
||||
|
||||
### webhooks.verify()
|
||||
|
||||
```js
|
||||
webhooks.verify(eventPayload, signature);
|
||||
```
|
||||
|
||||
<table width="100%">
|
||||
<tbody valign="top">
|
||||
<tr>
|
||||
<td>
|
||||
<code>eventPayload</code>
|
||||
<em>
|
||||
(String)
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<strong>Required.</strong>
|
||||
Webhook event request payload as received from GitHub.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>signature</code>
|
||||
<em>
|
||||
(String)
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<strong>Required.</strong>
|
||||
Signature string as calculated by <code><a href="#webhookssign">webhooks.sign()</a></code>.
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
Returns `true` or `false`. Throws error if `eventPayload` or `signature` not passed.
|
||||
|
||||
The `verify` method can be imported as static method from [`@octokit/webhooks-methods`](https://github.com/octokit/webhooks-methods.js/#readme).
|
||||
|
||||
### webhooks.verifyAndReceive()
|
||||
|
||||
```js
|
||||
webhooks.verifyAndReceive({ id, name, payload, signature });
|
||||
```
|
||||
|
||||
<table width="100%">
|
||||
<tbody valign="top">
|
||||
<tr>
|
||||
<td>
|
||||
<code>id</code>
|
||||
<em>
|
||||
String
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
Unique webhook event request id
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>name</code>
|
||||
<em>
|
||||
String
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<strong>Required.</strong>
|
||||
Name of the event. (Event names are set as <a href="https://docs.github.com/developers/webhooks-and-events/webhook-events-and-payloads#delivery-headers"><code>X-GitHub-Event</code> header</a>
|
||||
in the webhook event request.)
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>payload</code>
|
||||
<em>
|
||||
String
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<strong>Required.</strong>
|
||||
Webhook event request payload as received from GitHub.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>signature</code>
|
||||
<em>
|
||||
(String)
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<strong>Required.</strong>
|
||||
Signature string as calculated by <code><a href="#webhookssign">webhooks.sign()</a></code>.
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
Returns a promise.
|
||||
|
||||
Verifies event using [webhooks.verify()](#webhooksverify), then handles the event using [webhooks.receive()](#webhooksreceive).
|
||||
|
||||
Additionally, if verification fails, rejects the returned promise and emits an `error` event.
|
||||
|
||||
Example
|
||||
|
||||
```js
|
||||
import { Webhooks } from "@octokit/webhooks";
|
||||
const webhooks = new Webhooks({
|
||||
secret: "mysecret",
|
||||
});
|
||||
eventHandler.on("error", handleSignatureVerificationError);
|
||||
|
||||
// put this inside your webhooks route handler
|
||||
eventHandler
|
||||
.verifyAndReceive({
|
||||
id: request.headers["x-github-delivery"],
|
||||
name: request.headers["x-github-event"],
|
||||
payload: request.body,
|
||||
signature: request.headers["x-hub-signature-256"],
|
||||
})
|
||||
.catch(handleErrorsFromHooks);
|
||||
```
|
||||
|
||||
### webhooks.receive()
|
||||
|
||||
```js
|
||||
webhooks.receive({ id, name, payload });
|
||||
```
|
||||
|
||||
<table width="100%">
|
||||
<tbody valign="top">
|
||||
<tr>
|
||||
<td>
|
||||
<code>id</code>
|
||||
<em>
|
||||
String
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
Unique webhook event request id
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>name</code>
|
||||
<em>
|
||||
String
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<strong>Required.</strong>
|
||||
Name of the event. (Event names are set as <a href="https://docs.github.com/developers/webhooks-and-events/webhook-events-and-payloads#delivery-headers"><code>X-GitHub-Event</code> header</a>
|
||||
in the webhook event request.)
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>payload</code>
|
||||
<em>
|
||||
Object
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<strong>Required.</strong>
|
||||
Webhook event request payload as received from GitHub.
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
Returns a promise. Runs all handlers set with [`webhooks.on()`](#webhookson) in parallel and waits for them to finish. If one of the handlers rejects or throws an error, then `webhooks.receive()` rejects. The returned error has an `.errors` property which holds an array of all errors caught from the handlers. If no errors occur, `webhooks.receive()` resolves without passing any value.
|
||||
|
||||
The `.receive()` method belongs to the `event-handler` module which can be used [standalone](src/event-handler/).
|
||||
|
||||
### webhooks.on()
|
||||
|
||||
```js
|
||||
webhooks.on(eventName, handler);
|
||||
webhooks.on(eventNames, handler);
|
||||
```
|
||||
|
||||
<table width="100%">
|
||||
<tbody valign="top">
|
||||
<tr>
|
||||
<td>
|
||||
<code>eventName</code>
|
||||
<em>
|
||||
String
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<strong>Required.</strong>
|
||||
Name of the event. One of <a href="#webhook-events">GitHub's supported event names</a>, or (if the event has an action property) the name of an event followed by its action in the form of <code><event>.<action></code>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>eventNames</code>
|
||||
<em>
|
||||
Array
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<strong>Required.</strong>
|
||||
Array of event names.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>handler</code>
|
||||
<em>
|
||||
Function
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<strong>Required.</strong>
|
||||
Method to be run each time the event with the passed name is received.
|
||||
the <code>handler</code> function can be an async function, throw an error or
|
||||
return a Promise. The handler is called with an event object: <code>{id, name, payload}</code>.
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
The `.on()` method belongs to the `event-handler` module which can be used [standalone](src/event-handler/).
|
||||
|
||||
### webhooks.onAny()
|
||||
|
||||
```js
|
||||
webhooks.onAny(handler);
|
||||
```
|
||||
|
||||
<table width="100%">
|
||||
<tbody valign="top">
|
||||
<tr>
|
||||
<td>
|
||||
<code>handler</code>
|
||||
<em>
|
||||
Function
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<strong>Required.</strong>
|
||||
Method to be run each time any event is received.
|
||||
the <code>handler</code> function can be an async function, throw an error or
|
||||
return a Promise. The handler is called with an event object: <code>{id, name, payload}</code>.
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
The `.onAny()` method belongs to the `event-handler` module which can be used [standalone](src/event-handler/).
|
||||
|
||||
### webhooks.onError()
|
||||
|
||||
```js
|
||||
webhooks.onError(handler);
|
||||
```
|
||||
|
||||
If a webhook event handler throws an error or returns a promise that rejects, an error event is triggered. You can use this handler for logging or reporting events. The passed error object has a .event property which has all information on the event.
|
||||
|
||||
Asynchronous `error` event handler are not blocking the `.receive()` method from completing.
|
||||
|
||||
<table width="100%">
|
||||
<tbody valign="top">
|
||||
<tr>
|
||||
<td>
|
||||
<code>handler</code>
|
||||
<em>
|
||||
Function
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<strong>Required.</strong>
|
||||
Method to be run each time a webhook event handler throws an error or returns a promise that rejects.
|
||||
The <code>handler</code> function can be an async function,
|
||||
return a Promise. The handler is called with an error object that has a .event property which has all the information on the event: <code>{id, name, payload}</code>.
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
The `.onError()` method belongs to the `event-handler` module which can be used [standalone](src/event-handler/).
|
||||
|
||||
### webhooks.removeListener()
|
||||
|
||||
```js
|
||||
webhooks.removeListener(eventName, handler);
|
||||
webhooks.removeListener(eventNames, handler);
|
||||
```
|
||||
|
||||
<table width="100%">
|
||||
<tbody valign="top">
|
||||
<tr>
|
||||
<td>
|
||||
<code>eventName</code>
|
||||
<em>
|
||||
String
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<strong>Required.</strong>
|
||||
Name of the event. One of <a href="#webhook-events">GitHub's supported event names</a>, or (if the event has an action property) the name of an event followed by its action in the form of <code><event>.<action></code>, or '*' for the <code>onAny()</code> method or 'error' for the <code>onError()</code> method.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>eventNames</code>
|
||||
<em>
|
||||
Array
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<strong>Required.</strong>
|
||||
Array of event names.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>handler</code>
|
||||
<em>
|
||||
Function
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<strong>Required.</strong>
|
||||
Method which was previously passed to <code><a href="webhookson">webhooks.on()</a></code>. If the same handler was registered multiple times for the same event, only the most recent handler gets removed.
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
The `.removeListener()` method belongs to the `event-handler` module which can be used [standalone](src/event-handler/).
|
||||
|
||||
### createNodeMiddleware()
|
||||
|
||||
```js
|
||||
import { createServer } from "node:http";
|
||||
import { Webhooks, createNodeMiddleware } from "@octokit/webhooks";
|
||||
|
||||
const webhooks = new Webhooks({
|
||||
secret: "mysecret",
|
||||
});
|
||||
|
||||
const middleware = createNodeMiddleware(webhooks, { path: "/webhooks" });
|
||||
createServer(async (req, res) => {
|
||||
// `middleware` returns `false` when `req` is unhandled (beyond `/webhooks`)
|
||||
if (await middleware(req, res)) return;
|
||||
res.writeHead(404);
|
||||
res.end();
|
||||
}).listen(3000);
|
||||
// can now receive user authorization callbacks at POST /webhooks
|
||||
```
|
||||
|
||||
The middleware returned from `createNodeMiddleware` can also serve as an
|
||||
`Express.js` middleware directly.
|
||||
|
||||
<table width="100%">
|
||||
<tbody valign="top">
|
||||
<tr>
|
||||
<td>
|
||||
<code>webhooks</code>
|
||||
<em>
|
||||
Webhooks instance
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<strong>Required.</strong>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>path</code>
|
||||
<em>
|
||||
string
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
Custom path to match requests against. Defaults to <code>/api/github/webhooks</code>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>log</code>
|
||||
<em>
|
||||
object
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Used for internal logging. Defaults to [`console`](https://developer.mozilla.org/en-US/docs/Web/API/console) with `debug` and `info` doing nothing.
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tbody>
|
||||
</table>
|
||||
|
||||
### createWebMiddleware()
|
||||
|
||||
```js
|
||||
import { Webhooks, createWebMiddleware } from "@octokit/webhooks";
|
||||
|
||||
const webhooks = new Webhooks({
|
||||
secret: "mysecret",
|
||||
});
|
||||
|
||||
const middleware = createWebMiddleware(webhooks, { path: "/webhooks" });
|
||||
|
||||
// Example usage in Deno
|
||||
Deno.serve({ port: 3000 }, middleware);
|
||||
```
|
||||
|
||||
The middleware returned from `createWebMiddleware` can also be used in serverless environments like AWS Lambda, Cloudflare Workers, and Vercel.
|
||||
|
||||
<table width="100%">
|
||||
<tbody valign="top">
|
||||
<tr>
|
||||
<td>
|
||||
<code>webhooks</code>
|
||||
<em>
|
||||
Webhooks instance
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
<strong>Required.</strong>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>path</code>
|
||||
<em>
|
||||
string
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
Custom path to match requests against. Defaults to <code>/api/github/webhooks</code>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>log</code>
|
||||
<em>
|
||||
object
|
||||
</em>
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Used for internal logging. Defaults to [`console`](https://developer.mozilla.org/en-US/docs/Web/API/console) with `debug` and `info` doing nothing.
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tbody>
|
||||
</table>
|
||||
|
||||
### Webhook events
|
||||
|
||||
See the full list of [event types with example payloads](https://docs.github.com/developers/webhooks-and-events/webhook-events-and-payloads/).
|
||||
|
||||
If there are actions for a webhook, events are emitted for both, the webhook name as well as a combination of the webhook name and the action, e.g. `installation` and `installation.created`.
|
||||
|
||||
<!-- autogenerated via scripts/generate-types.ts -->
|
||||
|
||||
| Event | Actions |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| [`branch_protection_configuration`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#branch_protection_configuration) | `disabled`<br>`enabled` |
|
||||
| [`branch_protection_rule`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#branch_protection_rule) | `created`<br>`deleted`<br>`edited` |
|
||||
| [`check_run`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#check_run) | `completed`<br>`created`<br>`requested_action`<br>`rerequested` |
|
||||
| [`check_suite`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#check_suite) | `completed`<br>`requested`<br>`rerequested` |
|
||||
| [`code_scanning_alert`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#code_scanning_alert) | `appeared_in_branch`<br>`closed_by_user`<br>`created`<br>`fixed`<br>`reopened`<br>`reopened_by_user` |
|
||||
| [`commit_comment`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#commit_comment) | `created` |
|
||||
| [`create`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#create) | |
|
||||
| [`custom_property`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#custom_property) | `created`<br>`deleted`<br>`promote_to_enterprise`<br>`updated` |
|
||||
| [`custom_property_values`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#custom_property_values) | `updated` |
|
||||
| [`delete`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#delete) | |
|
||||
| [`dependabot_alert`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#dependabot_alert) | `auto_dismissed`<br>`auto_reopened`<br>`created`<br>`dismissed`<br>`fixed`<br>`reintroduced`<br>`reopened` |
|
||||
| [`deploy_key`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#deploy_key) | `created`<br>`deleted` |
|
||||
| [`deployment`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#deployment) | `created` |
|
||||
| [`deployment_protection_rule`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#deployment_protection_rule) | `requested` |
|
||||
| [`deployment_review`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#deployment_review) | `approved`<br>`rejected`<br>`requested` |
|
||||
| [`deployment_status`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#deployment_status) | `created` |
|
||||
| [`discussion`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#discussion) | `answered`<br>`category_changed`<br>`closed`<br>`created`<br>`deleted`<br>`edited`<br>`labeled`<br>`locked`<br>`pinned`<br>`reopened`<br>`transferred`<br>`unanswered`<br>`unlabeled`<br>`unlocked`<br>`unpinned` |
|
||||
| [`discussion_comment`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#discussion_comment) | `created`<br>`deleted`<br>`edited` |
|
||||
| [`fork`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#fork) | |
|
||||
| [`github_app_authorization`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#github_app_authorization) | `revoked` |
|
||||
| [`gollum`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#gollum) | |
|
||||
| [`installation`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#installation) | `created`<br>`deleted`<br>`new_permissions_accepted`<br>`suspend`<br>`unsuspend` |
|
||||
| [`installation_repositories`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#installation_repositories) | `added`<br>`removed` |
|
||||
| [`installation_target`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#installation_target) | `renamed` |
|
||||
| [`issue_comment`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#issue_comment) | `created`<br>`deleted`<br>`edited` |
|
||||
| [`issue_dependencies`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#issue_dependencies) | `blocked_by_added`<br>`blocked_by_removed`<br>`blocking_added`<br>`blocking_removed` |
|
||||
| [`issues`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#issues) | `assigned`<br>`closed`<br>`deleted`<br>`demilestoned`<br>`edited`<br>`labeled`<br>`locked`<br>`milestoned`<br>`opened`<br>`pinned`<br>`reopened`<br>`transferred`<br>`typed`<br>`unassigned`<br>`unlabeled`<br>`unlocked`<br>`unpinned`<br>`untyped` |
|
||||
| [`label`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#label) | `created`<br>`deleted`<br>`edited` |
|
||||
| [`marketplace_purchase`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#marketplace_purchase) | `cancelled`<br>`changed`<br>`pending_change`<br>`pending_change_cancelled`<br>`purchased` |
|
||||
| [`member`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#member) | `added`<br>`edited`<br>`removed` |
|
||||
| [`membership`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#membership) | `added`<br>`removed` |
|
||||
| [`merge_group`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#merge_group) | `checks_requested`<br>`destroyed` |
|
||||
| [`meta`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#meta) | `deleted` |
|
||||
| [`milestone`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#milestone) | `closed`<br>`created`<br>`deleted`<br>`edited`<br>`opened` |
|
||||
| [`org_block`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#org_block) | `blocked`<br>`unblocked` |
|
||||
| [`organization`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#organization) | `deleted`<br>`member_added`<br>`member_invited`<br>`member_removed`<br>`renamed` |
|
||||
| [`package`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#package) | `published`<br>`updated` |
|
||||
| [`page_build`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#page_build) | |
|
||||
| [`personal_access_token_request`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#personal_access_token_request) | `approved`<br>`cancelled`<br>`created`<br>`denied` |
|
||||
| [`ping`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#ping) | |
|
||||
| [`project`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#project) | `closed`<br>`created`<br>`deleted`<br>`edited`<br>`reopened` |
|
||||
| [`project_card`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#project_card) | `converted`<br>`created`<br>`deleted`<br>`edited`<br>`moved` |
|
||||
| [`project_column`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#project_column) | `created`<br>`deleted`<br>`edited`<br>`moved` |
|
||||
| [`projects_v2`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#projects_v2) | `closed`<br>`created`<br>`deleted`<br>`edited`<br>`reopened` |
|
||||
| [`projects_v2_item`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#projects_v2_item) | `archived`<br>`converted`<br>`created`<br>`deleted`<br>`edited`<br>`reordered`<br>`restored` |
|
||||
| [`projects_v2_status_update`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#projects_v2_status_update) | `created`<br>`deleted`<br>`edited` |
|
||||
| [`public`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#public) | |
|
||||
| [`pull_request`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request) | `assigned`<br>`auto_merge_disabled`<br>`auto_merge_enabled`<br>`closed`<br>`converted_to_draft`<br>`demilestoned`<br>`dequeued`<br>`edited`<br>`enqueued`<br>`labeled`<br>`locked`<br>`milestoned`<br>`opened`<br>`ready_for_review`<br>`reopened`<br>`review_request_removed`<br>`review_requested`<br>`synchronize`<br>`unassigned`<br>`unlabeled`<br>`unlocked` |
|
||||
| [`pull_request_review`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request_review) | `dismissed`<br>`edited`<br>`submitted` |
|
||||
| [`pull_request_review_comment`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request_review_comment) | `created`<br>`deleted`<br>`edited` |
|
||||
| [`pull_request_review_thread`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request_review_thread) | `resolved`<br>`unresolved` |
|
||||
| [`push`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#push) | |
|
||||
| [`registry_package`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#registry_package) | `published`<br>`updated` |
|
||||
| [`release`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#release) | `created`<br>`deleted`<br>`edited`<br>`prereleased`<br>`published`<br>`released`<br>`unpublished` |
|
||||
| [`repository`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#repository) | `archived`<br>`created`<br>`deleted`<br>`edited`<br>`privatized`<br>`publicized`<br>`renamed`<br>`transferred`<br>`unarchived` |
|
||||
| [`repository_advisory`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#repository_advisory) | `published`<br>`reported` |
|
||||
| [`repository_dispatch`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#repository_dispatch) | `sample` |
|
||||
| [`repository_import`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#repository_import) | |
|
||||
| [`repository_ruleset`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#repository_ruleset) | `created`<br>`deleted`<br>`edited` |
|
||||
| [`repository_vulnerability_alert`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#repository_vulnerability_alert) | `create`<br>`dismiss`<br>`reopen`<br>`resolve` |
|
||||
| [`secret_scanning_alert`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#secret_scanning_alert) | `assigned`<br>`created`<br>`publicly_leaked`<br>`reopened`<br>`resolved`<br>`unassigned`<br>`validated` |
|
||||
| [`secret_scanning_alert_location`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#secret_scanning_alert_location) | `created` |
|
||||
| [`secret_scanning_scan`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#secret_scanning_scan) | `completed` |
|
||||
| [`security_advisory`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#security_advisory) | `published`<br>`updated`<br>`withdrawn` |
|
||||
| [`security_and_analysis`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#security_and_analysis) | |
|
||||
| [`sponsorship`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#sponsorship) | `cancelled`<br>`created`<br>`edited`<br>`pending_cancellation`<br>`pending_tier_change`<br>`tier_changed` |
|
||||
| [`star`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#star) | `created`<br>`deleted` |
|
||||
| [`status`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#status) | |
|
||||
| [`sub_issues`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#sub_issues) | `parent_issue_added`<br>`parent_issue_removed`<br>`sub_issue_added`<br>`sub_issue_removed` |
|
||||
| [`team`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#team) | `added_to_repository`<br>`created`<br>`deleted`<br>`edited`<br>`removed_from_repository` |
|
||||
| [`team_add`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#team_add) | |
|
||||
| [`watch`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#watch) | `started` |
|
||||
| [`workflow_dispatch`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#workflow_dispatch) | |
|
||||
| [`workflow_job`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#workflow_job) | `completed`<br>`in_progress`<br>`queued`<br>`waiting` |
|
||||
| [`workflow_run`](https://docs.github.com/en/webhooks/webhook-events-and-payloads#workflow_run) | `completed`<br>`in_progress`<br>`requested` |
|
||||
|
||||
<!-- /autogenerated via scripts/generate-types.ts -->
|
||||
|
||||
### emitterEventNames
|
||||
|
||||
A read only tuple containing all the possible combinations of the webhook events + actions listed above. This might be useful in GUI and input validation.
|
||||
|
||||
```js
|
||||
import { emitterEventNames } from "@octokit/webhooks";
|
||||
emitterEventNames; // ["check_run", "check_run.completed", ...]
|
||||
```
|
||||
|
||||
### validateEventName
|
||||
|
||||
The function `validateEventName` asserts that the provided event name is a valid event name or event/action combination.
|
||||
It throws an error if the event name is not valid, or '\*' or 'error' is passed.
|
||||
|
||||
The second parameter is an optional options object that can be used to customize the behavior of the validation. You can set
|
||||
a `onUnknownEventName` property to `"warn"` to log a warning instead of throwing an error, and a `log` property to provide a custom logger object, which should have a `"warn"` method. You can also set `onUnknownEventName` to `"ignore"` to disable logging or throwing an error for unknown event names.
|
||||
|
||||
```ts
|
||||
import { validateEventName } from "@octokit/webhooks";
|
||||
|
||||
validateEventName("push"); // no error
|
||||
validateEventName("invalid_event"); // throws an error
|
||||
validateEventName("*"); // throws an error
|
||||
validateEventName("error"); // throws an error
|
||||
|
||||
validateEventName("invalid_event", { onUnknownEventName: "warn" }); // logs a warning
|
||||
validateEventName("invalid_event", {
|
||||
onUnknownEventName: false,
|
||||
log: {
|
||||
warn: console.info, // instead of warning we just log it via console.info
|
||||
},
|
||||
});
|
||||
|
||||
validateEventName("*", { onUnkownEventName: "ignore" }); // throws an error
|
||||
validateEventName("invalid_event", { onUnkownEventName: "ignore" }); // no error, no warning
|
||||
```
|
||||
|
||||
## TypeScript
|
||||
|
||||
The types for the webhook payloads are sourced from [`@octokit/openapi-webhooks-types`](https://github.com/octokit/openapi-webhooks/tree/main/packages/openapi-webhooks-types),
|
||||
which can be used by themselves.
|
||||
|
||||
In addition to these types, `@octokit/webhooks` exports 2 types specific to itself:
|
||||
|
||||
Note that changes to the exported types are not considered breaking changes, as the changes will not impact production code, but only fail locally or during CI at build time.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> As we use [conditional exports](https://nodejs.org/api/packages.html#conditional-exports), you will need to adapt your `tsconfig.json` by setting `"moduleResolution": "node16", "module": "node16"`.
|
||||
>
|
||||
> See the TypeScript docs on [package.json "exports"](https://www.typescriptlang.org/docs/handbook/modules/reference.html#packagejson-exports).<br>
|
||||
> See this [helpful guide on transitioning to ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) from [@sindresorhus](https://github.com/sindresorhus)
|
||||
|
||||
**⚠️ Caution ⚠️**: Webhooks Types are expected to be used with the [`strictNullChecks` option](https://www.typescriptlang.org/tsconfig#strictNullChecks) enabled in your `tsconfig`. If you don't have this option enabled, there's the possibility that you get `never` as the inferred type in some use cases. See [octokit/webhooks#395](https://github.com/octokit/webhooks/issues/395) for details.
|
||||
|
||||
### `EmitterWebhookEventName`
|
||||
|
||||
A union of all possible events and event/action combinations supported by the event emitter, e.g. `"check_run" | "check_run.completed" | ... many more ... | "workflow_run.requested"`.
|
||||
|
||||
### `EmitterWebhookEvent`
|
||||
|
||||
The object that is emitted by `@octokit/webhooks` as an event; made up of an `id`, `name`, and `payload` properties.
|
||||
An optional generic parameter can be passed to narrow the type of the `name` and `payload` properties based on event names or event/action combinations, e.g. `EmitterWebhookEvent<"check_run" | "code_scanning_alert.fixed">`.
|
||||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE.md)
|
||||
871
node_modules/@octokit/webhooks/dist-bundle/index.js
generated
vendored
Normal file
871
node_modules/@octokit/webhooks/dist-bundle/index.js
generated
vendored
Normal file
@@ -0,0 +1,871 @@
|
||||
// pkg/dist-src/create-logger.js
|
||||
var createLogger = (logger = {}) => {
|
||||
if (typeof logger.debug !== "function") {
|
||||
logger.debug = () => {
|
||||
};
|
||||
}
|
||||
if (typeof logger.info !== "function") {
|
||||
logger.info = () => {
|
||||
};
|
||||
}
|
||||
if (typeof logger.warn !== "function") {
|
||||
logger.warn = console.warn.bind(console);
|
||||
}
|
||||
if (typeof logger.error !== "function") {
|
||||
logger.error = console.error.bind(console);
|
||||
}
|
||||
return logger;
|
||||
};
|
||||
|
||||
// pkg/dist-src/generated/webhook-names.js
|
||||
var emitterEventNames = [
|
||||
"branch_protection_configuration",
|
||||
"branch_protection_configuration.disabled",
|
||||
"branch_protection_configuration.enabled",
|
||||
"branch_protection_rule",
|
||||
"branch_protection_rule.created",
|
||||
"branch_protection_rule.deleted",
|
||||
"branch_protection_rule.edited",
|
||||
"check_run",
|
||||
"check_run.completed",
|
||||
"check_run.created",
|
||||
"check_run.requested_action",
|
||||
"check_run.rerequested",
|
||||
"check_suite",
|
||||
"check_suite.completed",
|
||||
"check_suite.requested",
|
||||
"check_suite.rerequested",
|
||||
"code_scanning_alert",
|
||||
"code_scanning_alert.appeared_in_branch",
|
||||
"code_scanning_alert.closed_by_user",
|
||||
"code_scanning_alert.created",
|
||||
"code_scanning_alert.fixed",
|
||||
"code_scanning_alert.reopened",
|
||||
"code_scanning_alert.reopened_by_user",
|
||||
"commit_comment",
|
||||
"commit_comment.created",
|
||||
"create",
|
||||
"custom_property",
|
||||
"custom_property.created",
|
||||
"custom_property.deleted",
|
||||
"custom_property.promote_to_enterprise",
|
||||
"custom_property.updated",
|
||||
"custom_property_values",
|
||||
"custom_property_values.updated",
|
||||
"delete",
|
||||
"dependabot_alert",
|
||||
"dependabot_alert.auto_dismissed",
|
||||
"dependabot_alert.auto_reopened",
|
||||
"dependabot_alert.created",
|
||||
"dependabot_alert.dismissed",
|
||||
"dependabot_alert.fixed",
|
||||
"dependabot_alert.reintroduced",
|
||||
"dependabot_alert.reopened",
|
||||
"deploy_key",
|
||||
"deploy_key.created",
|
||||
"deploy_key.deleted",
|
||||
"deployment",
|
||||
"deployment.created",
|
||||
"deployment_protection_rule",
|
||||
"deployment_protection_rule.requested",
|
||||
"deployment_review",
|
||||
"deployment_review.approved",
|
||||
"deployment_review.rejected",
|
||||
"deployment_review.requested",
|
||||
"deployment_status",
|
||||
"deployment_status.created",
|
||||
"discussion",
|
||||
"discussion.answered",
|
||||
"discussion.category_changed",
|
||||
"discussion.closed",
|
||||
"discussion.created",
|
||||
"discussion.deleted",
|
||||
"discussion.edited",
|
||||
"discussion.labeled",
|
||||
"discussion.locked",
|
||||
"discussion.pinned",
|
||||
"discussion.reopened",
|
||||
"discussion.transferred",
|
||||
"discussion.unanswered",
|
||||
"discussion.unlabeled",
|
||||
"discussion.unlocked",
|
||||
"discussion.unpinned",
|
||||
"discussion_comment",
|
||||
"discussion_comment.created",
|
||||
"discussion_comment.deleted",
|
||||
"discussion_comment.edited",
|
||||
"fork",
|
||||
"github_app_authorization",
|
||||
"github_app_authorization.revoked",
|
||||
"gollum",
|
||||
"installation",
|
||||
"installation.created",
|
||||
"installation.deleted",
|
||||
"installation.new_permissions_accepted",
|
||||
"installation.suspend",
|
||||
"installation.unsuspend",
|
||||
"installation_repositories",
|
||||
"installation_repositories.added",
|
||||
"installation_repositories.removed",
|
||||
"installation_target",
|
||||
"installation_target.renamed",
|
||||
"issue_comment",
|
||||
"issue_comment.created",
|
||||
"issue_comment.deleted",
|
||||
"issue_comment.edited",
|
||||
"issue_dependencies",
|
||||
"issue_dependencies.blocked_by_added",
|
||||
"issue_dependencies.blocked_by_removed",
|
||||
"issue_dependencies.blocking_added",
|
||||
"issue_dependencies.blocking_removed",
|
||||
"issues",
|
||||
"issues.assigned",
|
||||
"issues.closed",
|
||||
"issues.deleted",
|
||||
"issues.demilestoned",
|
||||
"issues.edited",
|
||||
"issues.labeled",
|
||||
"issues.locked",
|
||||
"issues.milestoned",
|
||||
"issues.opened",
|
||||
"issues.pinned",
|
||||
"issues.reopened",
|
||||
"issues.transferred",
|
||||
"issues.typed",
|
||||
"issues.unassigned",
|
||||
"issues.unlabeled",
|
||||
"issues.unlocked",
|
||||
"issues.unpinned",
|
||||
"issues.untyped",
|
||||
"label",
|
||||
"label.created",
|
||||
"label.deleted",
|
||||
"label.edited",
|
||||
"marketplace_purchase",
|
||||
"marketplace_purchase.cancelled",
|
||||
"marketplace_purchase.changed",
|
||||
"marketplace_purchase.pending_change",
|
||||
"marketplace_purchase.pending_change_cancelled",
|
||||
"marketplace_purchase.purchased",
|
||||
"member",
|
||||
"member.added",
|
||||
"member.edited",
|
||||
"member.removed",
|
||||
"membership",
|
||||
"membership.added",
|
||||
"membership.removed",
|
||||
"merge_group",
|
||||
"merge_group.checks_requested",
|
||||
"merge_group.destroyed",
|
||||
"meta",
|
||||
"meta.deleted",
|
||||
"milestone",
|
||||
"milestone.closed",
|
||||
"milestone.created",
|
||||
"milestone.deleted",
|
||||
"milestone.edited",
|
||||
"milestone.opened",
|
||||
"org_block",
|
||||
"org_block.blocked",
|
||||
"org_block.unblocked",
|
||||
"organization",
|
||||
"organization.deleted",
|
||||
"organization.member_added",
|
||||
"organization.member_invited",
|
||||
"organization.member_removed",
|
||||
"organization.renamed",
|
||||
"package",
|
||||
"package.published",
|
||||
"package.updated",
|
||||
"page_build",
|
||||
"personal_access_token_request",
|
||||
"personal_access_token_request.approved",
|
||||
"personal_access_token_request.cancelled",
|
||||
"personal_access_token_request.created",
|
||||
"personal_access_token_request.denied",
|
||||
"ping",
|
||||
"project",
|
||||
"project.closed",
|
||||
"project.created",
|
||||
"project.deleted",
|
||||
"project.edited",
|
||||
"project.reopened",
|
||||
"project_card",
|
||||
"project_card.converted",
|
||||
"project_card.created",
|
||||
"project_card.deleted",
|
||||
"project_card.edited",
|
||||
"project_card.moved",
|
||||
"project_column",
|
||||
"project_column.created",
|
||||
"project_column.deleted",
|
||||
"project_column.edited",
|
||||
"project_column.moved",
|
||||
"projects_v2",
|
||||
"projects_v2.closed",
|
||||
"projects_v2.created",
|
||||
"projects_v2.deleted",
|
||||
"projects_v2.edited",
|
||||
"projects_v2.reopened",
|
||||
"projects_v2_item",
|
||||
"projects_v2_item.archived",
|
||||
"projects_v2_item.converted",
|
||||
"projects_v2_item.created",
|
||||
"projects_v2_item.deleted",
|
||||
"projects_v2_item.edited",
|
||||
"projects_v2_item.reordered",
|
||||
"projects_v2_item.restored",
|
||||
"projects_v2_status_update",
|
||||
"projects_v2_status_update.created",
|
||||
"projects_v2_status_update.deleted",
|
||||
"projects_v2_status_update.edited",
|
||||
"public",
|
||||
"pull_request",
|
||||
"pull_request.assigned",
|
||||
"pull_request.auto_merge_disabled",
|
||||
"pull_request.auto_merge_enabled",
|
||||
"pull_request.closed",
|
||||
"pull_request.converted_to_draft",
|
||||
"pull_request.demilestoned",
|
||||
"pull_request.dequeued",
|
||||
"pull_request.edited",
|
||||
"pull_request.enqueued",
|
||||
"pull_request.labeled",
|
||||
"pull_request.locked",
|
||||
"pull_request.milestoned",
|
||||
"pull_request.opened",
|
||||
"pull_request.ready_for_review",
|
||||
"pull_request.reopened",
|
||||
"pull_request.review_request_removed",
|
||||
"pull_request.review_requested",
|
||||
"pull_request.synchronize",
|
||||
"pull_request.unassigned",
|
||||
"pull_request.unlabeled",
|
||||
"pull_request.unlocked",
|
||||
"pull_request_review",
|
||||
"pull_request_review.dismissed",
|
||||
"pull_request_review.edited",
|
||||
"pull_request_review.submitted",
|
||||
"pull_request_review_comment",
|
||||
"pull_request_review_comment.created",
|
||||
"pull_request_review_comment.deleted",
|
||||
"pull_request_review_comment.edited",
|
||||
"pull_request_review_thread",
|
||||
"pull_request_review_thread.resolved",
|
||||
"pull_request_review_thread.unresolved",
|
||||
"push",
|
||||
"registry_package",
|
||||
"registry_package.published",
|
||||
"registry_package.updated",
|
||||
"release",
|
||||
"release.created",
|
||||
"release.deleted",
|
||||
"release.edited",
|
||||
"release.prereleased",
|
||||
"release.published",
|
||||
"release.released",
|
||||
"release.unpublished",
|
||||
"repository",
|
||||
"repository.archived",
|
||||
"repository.created",
|
||||
"repository.deleted",
|
||||
"repository.edited",
|
||||
"repository.privatized",
|
||||
"repository.publicized",
|
||||
"repository.renamed",
|
||||
"repository.transferred",
|
||||
"repository.unarchived",
|
||||
"repository_advisory",
|
||||
"repository_advisory.published",
|
||||
"repository_advisory.reported",
|
||||
"repository_dispatch",
|
||||
"repository_dispatch.sample.collected",
|
||||
"repository_import",
|
||||
"repository_ruleset",
|
||||
"repository_ruleset.created",
|
||||
"repository_ruleset.deleted",
|
||||
"repository_ruleset.edited",
|
||||
"repository_vulnerability_alert",
|
||||
"repository_vulnerability_alert.create",
|
||||
"repository_vulnerability_alert.dismiss",
|
||||
"repository_vulnerability_alert.reopen",
|
||||
"repository_vulnerability_alert.resolve",
|
||||
"secret_scanning_alert",
|
||||
"secret_scanning_alert.assigned",
|
||||
"secret_scanning_alert.created",
|
||||
"secret_scanning_alert.publicly_leaked",
|
||||
"secret_scanning_alert.reopened",
|
||||
"secret_scanning_alert.resolved",
|
||||
"secret_scanning_alert.unassigned",
|
||||
"secret_scanning_alert.validated",
|
||||
"secret_scanning_alert_location",
|
||||
"secret_scanning_alert_location.created",
|
||||
"secret_scanning_scan",
|
||||
"secret_scanning_scan.completed",
|
||||
"security_advisory",
|
||||
"security_advisory.published",
|
||||
"security_advisory.updated",
|
||||
"security_advisory.withdrawn",
|
||||
"security_and_analysis",
|
||||
"sponsorship",
|
||||
"sponsorship.cancelled",
|
||||
"sponsorship.created",
|
||||
"sponsorship.edited",
|
||||
"sponsorship.pending_cancellation",
|
||||
"sponsorship.pending_tier_change",
|
||||
"sponsorship.tier_changed",
|
||||
"star",
|
||||
"star.created",
|
||||
"star.deleted",
|
||||
"status",
|
||||
"sub_issues",
|
||||
"sub_issues.parent_issue_added",
|
||||
"sub_issues.parent_issue_removed",
|
||||
"sub_issues.sub_issue_added",
|
||||
"sub_issues.sub_issue_removed",
|
||||
"team",
|
||||
"team.added_to_repository",
|
||||
"team.created",
|
||||
"team.deleted",
|
||||
"team.edited",
|
||||
"team.removed_from_repository",
|
||||
"team_add",
|
||||
"watch",
|
||||
"watch.started",
|
||||
"workflow_dispatch",
|
||||
"workflow_job",
|
||||
"workflow_job.completed",
|
||||
"workflow_job.in_progress",
|
||||
"workflow_job.queued",
|
||||
"workflow_job.waiting",
|
||||
"workflow_run",
|
||||
"workflow_run.completed",
|
||||
"workflow_run.in_progress",
|
||||
"workflow_run.requested"
|
||||
];
|
||||
|
||||
// pkg/dist-src/event-handler/validate-event-name.js
|
||||
function validateEventName(eventName, options = {}) {
|
||||
if (typeof eventName !== "string") {
|
||||
throw new TypeError("eventName must be of type string");
|
||||
}
|
||||
if (eventName === "*") {
|
||||
throw new TypeError(
|
||||
`Using the "*" event with the regular Webhooks.on() function is not supported. Please use the Webhooks.onAny() method instead`
|
||||
);
|
||||
}
|
||||
if (eventName === "error") {
|
||||
throw new TypeError(
|
||||
`Using the "error" event with the regular Webhooks.on() function is not supported. Please use the Webhooks.onError() method instead`
|
||||
);
|
||||
}
|
||||
if (options.onUnknownEventName === "ignore") {
|
||||
return;
|
||||
}
|
||||
if (!emitterEventNames.includes(eventName)) {
|
||||
if (options.onUnknownEventName !== "warn") {
|
||||
throw new TypeError(
|
||||
`"${eventName}" is not a known webhook name (https://developer.github.com/v3/activity/events/types/)`
|
||||
);
|
||||
} else {
|
||||
(options.log || console).warn(
|
||||
`"${eventName}" is not a known webhook name (https://developer.github.com/v3/activity/events/types/)`
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// pkg/dist-src/event-handler/on.js
|
||||
function handleEventHandlers(state, webhookName, handler) {
|
||||
if (!state.hooks[webhookName]) {
|
||||
state.hooks[webhookName] = [];
|
||||
}
|
||||
state.hooks[webhookName].push(handler);
|
||||
}
|
||||
function receiverOn(state, webhookNameOrNames, handler) {
|
||||
if (Array.isArray(webhookNameOrNames)) {
|
||||
webhookNameOrNames.forEach(
|
||||
(webhookName) => receiverOn(state, webhookName, handler)
|
||||
);
|
||||
return;
|
||||
}
|
||||
validateEventName(webhookNameOrNames, {
|
||||
onUnknownEventName: "warn",
|
||||
log: state.log
|
||||
});
|
||||
handleEventHandlers(state, webhookNameOrNames, handler);
|
||||
}
|
||||
function receiverOnAny(state, handler) {
|
||||
handleEventHandlers(state, "*", handler);
|
||||
}
|
||||
function receiverOnError(state, handler) {
|
||||
handleEventHandlers(state, "error", handler);
|
||||
}
|
||||
|
||||
// pkg/dist-src/event-handler/wrap-error-handler.js
|
||||
function wrapErrorHandler(handler, error) {
|
||||
let returnValue;
|
||||
try {
|
||||
returnValue = handler(error);
|
||||
} catch (error2) {
|
||||
console.log('FATAL: Error occurred in "error" event handler');
|
||||
console.log(error2);
|
||||
}
|
||||
if (returnValue && returnValue.catch) {
|
||||
returnValue.catch((error2) => {
|
||||
console.log('FATAL: Error occurred in "error" event handler');
|
||||
console.log(error2);
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
// pkg/dist-src/event-handler/receive.js
|
||||
function getHooks(state, eventPayloadAction, eventName) {
|
||||
const hooks = [state.hooks[eventName], state.hooks["*"]];
|
||||
if (eventPayloadAction) {
|
||||
hooks.unshift(state.hooks[`${eventName}.${eventPayloadAction}`]);
|
||||
}
|
||||
return [].concat(...hooks.filter(Boolean));
|
||||
}
|
||||
function receiverHandle(state, event) {
|
||||
const errorHandlers = state.hooks.error || [];
|
||||
if (event instanceof Error) {
|
||||
const error = Object.assign(new AggregateError([event], event.message), {
|
||||
event
|
||||
});
|
||||
errorHandlers.forEach((handler) => wrapErrorHandler(handler, error));
|
||||
return Promise.reject(error);
|
||||
}
|
||||
if (!event || !event.name) {
|
||||
const error = new Error("Event name not passed");
|
||||
throw new AggregateError([error], error.message);
|
||||
}
|
||||
if (!event.payload) {
|
||||
const error = new Error("Event name not passed");
|
||||
throw new AggregateError([error], error.message);
|
||||
}
|
||||
const hooks = getHooks(
|
||||
state,
|
||||
"action" in event.payload ? event.payload.action : null,
|
||||
event.name
|
||||
);
|
||||
if (hooks.length === 0) {
|
||||
return Promise.resolve();
|
||||
}
|
||||
const errors = [];
|
||||
const promises = hooks.map((handler) => {
|
||||
let promise = Promise.resolve(event);
|
||||
if (state.transform) {
|
||||
promise = promise.then(state.transform);
|
||||
}
|
||||
return promise.then((event2) => {
|
||||
return handler(event2);
|
||||
}).catch((error) => errors.push(Object.assign(error, { event })));
|
||||
});
|
||||
return Promise.all(promises).then(() => {
|
||||
if (errors.length === 0) {
|
||||
return;
|
||||
}
|
||||
const error = new AggregateError(
|
||||
errors,
|
||||
errors.map((error2) => error2.message).join("\n")
|
||||
);
|
||||
Object.assign(error, {
|
||||
event
|
||||
});
|
||||
errorHandlers.forEach((handler) => wrapErrorHandler(handler, error));
|
||||
throw error;
|
||||
});
|
||||
}
|
||||
|
||||
// pkg/dist-src/event-handler/remove-listener.js
|
||||
function removeListener(state, webhookNameOrNames, handler) {
|
||||
if (Array.isArray(webhookNameOrNames)) {
|
||||
webhookNameOrNames.forEach(
|
||||
(webhookName) => removeListener(state, webhookName, handler)
|
||||
);
|
||||
return;
|
||||
}
|
||||
if (!state.hooks[webhookNameOrNames]) {
|
||||
return;
|
||||
}
|
||||
for (let i = state.hooks[webhookNameOrNames].length - 1; i >= 0; i--) {
|
||||
if (state.hooks[webhookNameOrNames][i] === handler) {
|
||||
state.hooks[webhookNameOrNames].splice(i, 1);
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// pkg/dist-src/event-handler/index.js
|
||||
function createEventHandler(options) {
|
||||
const state = {
|
||||
hooks: {},
|
||||
log: createLogger(options && options.log)
|
||||
};
|
||||
if (options && options.transform) {
|
||||
state.transform = options.transform;
|
||||
}
|
||||
return {
|
||||
on: receiverOn.bind(null, state),
|
||||
onAny: receiverOnAny.bind(null, state),
|
||||
onError: receiverOnError.bind(null, state),
|
||||
removeListener: removeListener.bind(null, state),
|
||||
receive: receiverHandle.bind(null, state)
|
||||
};
|
||||
}
|
||||
|
||||
// pkg/dist-src/index.js
|
||||
import { sign, verify } from "@octokit/webhooks-methods";
|
||||
|
||||
// pkg/dist-src/verify-and-receive.js
|
||||
import { verifyWithFallback } from "@octokit/webhooks-methods";
|
||||
async function verifyAndReceive(state, event) {
|
||||
const matchesSignature = await verifyWithFallback(
|
||||
state.secret,
|
||||
event.payload,
|
||||
event.signature,
|
||||
state.additionalSecrets
|
||||
).catch(() => false);
|
||||
if (!matchesSignature) {
|
||||
const error = new Error(
|
||||
"[@octokit/webhooks] signature does not match event payload and secret"
|
||||
);
|
||||
error.event = event;
|
||||
error.status = 400;
|
||||
return state.eventHandler.receive(error);
|
||||
}
|
||||
let payload;
|
||||
try {
|
||||
payload = JSON.parse(event.payload);
|
||||
} catch (error) {
|
||||
error.message = "Invalid JSON";
|
||||
error.status = 400;
|
||||
throw new AggregateError([error], error.message);
|
||||
}
|
||||
return state.eventHandler.receive({
|
||||
id: event.id,
|
||||
name: event.name,
|
||||
payload
|
||||
});
|
||||
}
|
||||
|
||||
// pkg/dist-src/normalize-trailing-slashes.js
|
||||
function normalizeTrailingSlashes(path) {
|
||||
let i = path.length;
|
||||
if (i === 0) {
|
||||
return "/";
|
||||
}
|
||||
while (i > 0) {
|
||||
if (path.charCodeAt(--i) !== 47) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (i === -1) {
|
||||
return "/";
|
||||
}
|
||||
return path.slice(0, i + 1);
|
||||
}
|
||||
|
||||
// pkg/dist-src/middleware/create-middleware.js
|
||||
var isApplicationJsonRE = /^\s*(application\/json)\s*(?:;|$)/u;
|
||||
var WEBHOOK_HEADERS = [
|
||||
"x-github-event",
|
||||
"x-hub-signature-256",
|
||||
"x-github-delivery"
|
||||
];
|
||||
function createMiddleware(options) {
|
||||
const { handleResponse: handleResponse3, getRequestHeader: getRequestHeader3, getPayload: getPayload3 } = options;
|
||||
return function middleware(webhooks, options2) {
|
||||
const middlewarePath = normalizeTrailingSlashes(options2.path);
|
||||
return async function octokitWebhooksMiddleware(request, response, next) {
|
||||
let pathname;
|
||||
try {
|
||||
pathname = new URL(
|
||||
normalizeTrailingSlashes(request.url),
|
||||
"http://localhost"
|
||||
).pathname;
|
||||
} catch (error) {
|
||||
return handleResponse3(
|
||||
JSON.stringify({
|
||||
error: `Request URL could not be parsed: ${request.url}`
|
||||
}),
|
||||
422,
|
||||
{
|
||||
"content-type": "application/json"
|
||||
},
|
||||
response
|
||||
);
|
||||
}
|
||||
if (pathname !== middlewarePath) {
|
||||
next?.();
|
||||
return handleResponse3(null);
|
||||
} else if (request.method !== "POST") {
|
||||
return handleResponse3(
|
||||
JSON.stringify({
|
||||
error: `Unknown route: ${request.method} ${pathname}`
|
||||
}),
|
||||
404,
|
||||
{
|
||||
"content-type": "application/json"
|
||||
},
|
||||
response
|
||||
);
|
||||
}
|
||||
const contentType = getRequestHeader3(request, "content-type");
|
||||
if (typeof contentType !== "string" || !isApplicationJsonRE.test(contentType)) {
|
||||
return handleResponse3(
|
||||
JSON.stringify({
|
||||
error: `Unsupported "Content-Type" header value. Must be "application/json"`
|
||||
}),
|
||||
415,
|
||||
{
|
||||
"content-type": "application/json",
|
||||
accept: "application/json"
|
||||
},
|
||||
response
|
||||
);
|
||||
}
|
||||
const missingHeaders = WEBHOOK_HEADERS.filter((header) => {
|
||||
return getRequestHeader3(request, header) == void 0;
|
||||
}).join(", ");
|
||||
if (missingHeaders) {
|
||||
return handleResponse3(
|
||||
JSON.stringify({
|
||||
error: `Required headers missing: ${missingHeaders}`
|
||||
}),
|
||||
400,
|
||||
{
|
||||
"content-type": "application/json",
|
||||
accept: "application/json"
|
||||
},
|
||||
response
|
||||
);
|
||||
}
|
||||
const eventName = getRequestHeader3(
|
||||
request,
|
||||
"x-github-event"
|
||||
);
|
||||
const signature = getRequestHeader3(request, "x-hub-signature-256");
|
||||
const id = getRequestHeader3(request, "x-github-delivery");
|
||||
options2.log.debug(`${eventName} event received (id: ${id})`);
|
||||
let didTimeout = false;
|
||||
let timeout;
|
||||
const timeoutPromise = new Promise((resolve) => {
|
||||
timeout = setTimeout(() => {
|
||||
didTimeout = true;
|
||||
resolve(
|
||||
handleResponse3(
|
||||
"still processing\n",
|
||||
202,
|
||||
{
|
||||
"Content-Type": "text/plain",
|
||||
accept: "application/json"
|
||||
},
|
||||
response
|
||||
)
|
||||
);
|
||||
}, options2.timeout);
|
||||
});
|
||||
const processWebhook = async () => {
|
||||
try {
|
||||
const payload = await getPayload3(request);
|
||||
await webhooks.verifyAndReceive({
|
||||
id,
|
||||
name: eventName,
|
||||
payload,
|
||||
signature
|
||||
});
|
||||
clearTimeout(timeout);
|
||||
if (didTimeout) return handleResponse3(null);
|
||||
return handleResponse3(
|
||||
"ok\n",
|
||||
200,
|
||||
{
|
||||
"content-type": "text/plain",
|
||||
accept: "application/json"
|
||||
},
|
||||
response
|
||||
);
|
||||
} catch (error) {
|
||||
clearTimeout(timeout);
|
||||
if (didTimeout) return handleResponse3(null);
|
||||
const err = Array.from(error.errors)[0];
|
||||
const errorMessage = err.message ? `${err.name}: ${err.message}` : "Error: An Unspecified error occurred";
|
||||
const statusCode = typeof err.status !== "undefined" ? err.status : 500;
|
||||
options2.log.error(error);
|
||||
return handleResponse3(
|
||||
JSON.stringify({
|
||||
error: errorMessage
|
||||
}),
|
||||
statusCode,
|
||||
{
|
||||
"content-type": "application/json",
|
||||
accept: "application/json"
|
||||
},
|
||||
response
|
||||
);
|
||||
}
|
||||
};
|
||||
return await Promise.race([timeoutPromise, processWebhook()]);
|
||||
};
|
||||
};
|
||||
}
|
||||
|
||||
// pkg/dist-src/middleware/node/handle-response.js
|
||||
function handleResponse(body, status = 200, headers = {}, response) {
|
||||
if (body === null) {
|
||||
return false;
|
||||
}
|
||||
headers["content-length"] = body.length.toString();
|
||||
response.writeHead(status, headers).end(body);
|
||||
return true;
|
||||
}
|
||||
|
||||
// pkg/dist-src/middleware/node/get-request-header.js
|
||||
function getRequestHeader(request, key) {
|
||||
return request.headers[key];
|
||||
}
|
||||
|
||||
// pkg/dist-src/concat-uint8array.js
|
||||
function concatUint8Array(data) {
|
||||
if (data.length === 0) {
|
||||
return new Uint8Array(0);
|
||||
}
|
||||
let totalLength = 0;
|
||||
for (let i = 0; i < data.length; i++) {
|
||||
totalLength += data[i].length;
|
||||
}
|
||||
if (totalLength === 0) {
|
||||
return new Uint8Array(0);
|
||||
}
|
||||
const result = new Uint8Array(totalLength);
|
||||
let offset = 0;
|
||||
for (let i = 0; i < data.length; i++) {
|
||||
result.set(data[i], offset);
|
||||
offset += data[i].length;
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
// pkg/dist-src/middleware/node/get-payload.js
|
||||
var textDecoder = new TextDecoder("utf-8", { fatal: false });
|
||||
var decode = textDecoder.decode.bind(textDecoder);
|
||||
async function getPayload(request) {
|
||||
if (typeof request.body === "object" && "rawBody" in request && request.rawBody instanceof Uint8Array) {
|
||||
return decode(request.rawBody);
|
||||
} else if (typeof request.body === "string") {
|
||||
return request.body;
|
||||
}
|
||||
const payload = await getPayloadFromRequestStream(request);
|
||||
return decode(payload);
|
||||
}
|
||||
function getPayloadFromRequestStream(request) {
|
||||
return new Promise((resolve, reject) => {
|
||||
let data = [];
|
||||
request.on(
|
||||
"error",
|
||||
(error) => reject(new AggregateError([error], error.message))
|
||||
);
|
||||
request.on("data", data.push.bind(data));
|
||||
request.on("end", () => {
|
||||
const result = concatUint8Array(data);
|
||||
queueMicrotask(() => resolve(result));
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
// pkg/dist-src/middleware/node/index.js
|
||||
function createNodeMiddleware(webhooks, {
|
||||
path = "/api/github/webhooks",
|
||||
log = createLogger(),
|
||||
timeout = 9e3
|
||||
} = {}) {
|
||||
return createMiddleware({
|
||||
handleResponse,
|
||||
getRequestHeader,
|
||||
getPayload
|
||||
})(webhooks, {
|
||||
path,
|
||||
log,
|
||||
timeout
|
||||
});
|
||||
}
|
||||
|
||||
// pkg/dist-src/middleware/web/get-payload.js
|
||||
function getPayload2(request) {
|
||||
return request.text();
|
||||
}
|
||||
|
||||
// pkg/dist-src/middleware/web/get-request-header.js
|
||||
function getRequestHeader2(request, key) {
|
||||
return request.headers.get(key);
|
||||
}
|
||||
|
||||
// pkg/dist-src/middleware/web/handle-response.js
|
||||
function handleResponse2(body, status = 200, headers = {}) {
|
||||
if (body !== null) {
|
||||
headers["content-length"] = body.length.toString();
|
||||
}
|
||||
return new Response(body, {
|
||||
status,
|
||||
headers
|
||||
});
|
||||
}
|
||||
|
||||
// pkg/dist-src/middleware/web/index.js
|
||||
function createWebMiddleware(webhooks, {
|
||||
path = "/api/github/webhooks",
|
||||
log = createLogger(),
|
||||
timeout = 9e3
|
||||
} = {}) {
|
||||
return createMiddleware({
|
||||
handleResponse: handleResponse2,
|
||||
getRequestHeader: getRequestHeader2,
|
||||
getPayload: getPayload2
|
||||
})(webhooks, {
|
||||
path,
|
||||
log,
|
||||
timeout
|
||||
});
|
||||
}
|
||||
|
||||
// pkg/dist-src/index.js
|
||||
var Webhooks = class {
|
||||
sign;
|
||||
verify;
|
||||
on;
|
||||
onAny;
|
||||
onError;
|
||||
removeListener;
|
||||
receive;
|
||||
verifyAndReceive;
|
||||
constructor(options) {
|
||||
if (!options || !options.secret) {
|
||||
throw new Error("[@octokit/webhooks] options.secret required");
|
||||
}
|
||||
const state = {
|
||||
eventHandler: createEventHandler(options),
|
||||
secret: options.secret,
|
||||
additionalSecrets: options.additionalSecrets,
|
||||
hooks: {},
|
||||
log: createLogger(options.log)
|
||||
};
|
||||
this.sign = sign.bind(null, options.secret);
|
||||
this.verify = verify.bind(null, options.secret);
|
||||
this.on = state.eventHandler.on;
|
||||
this.onAny = state.eventHandler.onAny;
|
||||
this.onError = state.eventHandler.onError;
|
||||
this.removeListener = state.eventHandler.removeListener;
|
||||
this.receive = state.eventHandler.receive;
|
||||
this.verifyAndReceive = verifyAndReceive.bind(null, state);
|
||||
}
|
||||
};
|
||||
export {
|
||||
Webhooks,
|
||||
createEventHandler,
|
||||
createNodeMiddleware,
|
||||
createWebMiddleware,
|
||||
emitterEventNames,
|
||||
validateEventName
|
||||
};
|
||||
7
node_modules/@octokit/webhooks/dist-bundle/index.js.map
generated
vendored
Normal file
7
node_modules/@octokit/webhooks/dist-bundle/index.js.map
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
22
node_modules/@octokit/webhooks/dist-src/concat-uint8array.js
generated
vendored
Normal file
22
node_modules/@octokit/webhooks/dist-src/concat-uint8array.js
generated
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
function concatUint8Array(data) {
|
||||
if (data.length === 0) {
|
||||
return new Uint8Array(0);
|
||||
}
|
||||
let totalLength = 0;
|
||||
for (let i = 0; i < data.length; i++) {
|
||||
totalLength += data[i].length;
|
||||
}
|
||||
if (totalLength === 0) {
|
||||
return new Uint8Array(0);
|
||||
}
|
||||
const result = new Uint8Array(totalLength);
|
||||
let offset = 0;
|
||||
for (let i = 0; i < data.length; i++) {
|
||||
result.set(data[i], offset);
|
||||
offset += data[i].length;
|
||||
}
|
||||
return result;
|
||||
}
|
||||
export {
|
||||
concatUint8Array
|
||||
};
|
||||
20
node_modules/@octokit/webhooks/dist-src/create-logger.js
generated
vendored
Normal file
20
node_modules/@octokit/webhooks/dist-src/create-logger.js
generated
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
const createLogger = (logger = {}) => {
|
||||
if (typeof logger.debug !== "function") {
|
||||
logger.debug = () => {
|
||||
};
|
||||
}
|
||||
if (typeof logger.info !== "function") {
|
||||
logger.info = () => {
|
||||
};
|
||||
}
|
||||
if (typeof logger.warn !== "function") {
|
||||
logger.warn = console.warn.bind(console);
|
||||
}
|
||||
if (typeof logger.error !== "function") {
|
||||
logger.error = console.error.bind(console);
|
||||
}
|
||||
return logger;
|
||||
};
|
||||
export {
|
||||
createLogger
|
||||
};
|
||||
27
node_modules/@octokit/webhooks/dist-src/event-handler/index.js
generated
vendored
Normal file
27
node_modules/@octokit/webhooks/dist-src/event-handler/index.js
generated
vendored
Normal file
@@ -0,0 +1,27 @@
|
||||
import { createLogger } from "../create-logger.js";
|
||||
import {
|
||||
receiverOn as on,
|
||||
receiverOnAny as onAny,
|
||||
receiverOnError as onError
|
||||
} from "./on.js";
|
||||
import { receiverHandle as receive } from "./receive.js";
|
||||
import { removeListener } from "./remove-listener.js";
|
||||
function createEventHandler(options) {
|
||||
const state = {
|
||||
hooks: {},
|
||||
log: createLogger(options && options.log)
|
||||
};
|
||||
if (options && options.transform) {
|
||||
state.transform = options.transform;
|
||||
}
|
||||
return {
|
||||
on: on.bind(null, state),
|
||||
onAny: onAny.bind(null, state),
|
||||
onError: onError.bind(null, state),
|
||||
removeListener: removeListener.bind(null, state),
|
||||
receive: receive.bind(null, state)
|
||||
};
|
||||
}
|
||||
export {
|
||||
createEventHandler
|
||||
};
|
||||
31
node_modules/@octokit/webhooks/dist-src/event-handler/on.js
generated
vendored
Normal file
31
node_modules/@octokit/webhooks/dist-src/event-handler/on.js
generated
vendored
Normal file
@@ -0,0 +1,31 @@
|
||||
import { validateEventName } from "./validate-event-name.js";
|
||||
function handleEventHandlers(state, webhookName, handler) {
|
||||
if (!state.hooks[webhookName]) {
|
||||
state.hooks[webhookName] = [];
|
||||
}
|
||||
state.hooks[webhookName].push(handler);
|
||||
}
|
||||
function receiverOn(state, webhookNameOrNames, handler) {
|
||||
if (Array.isArray(webhookNameOrNames)) {
|
||||
webhookNameOrNames.forEach(
|
||||
(webhookName) => receiverOn(state, webhookName, handler)
|
||||
);
|
||||
return;
|
||||
}
|
||||
validateEventName(webhookNameOrNames, {
|
||||
onUnknownEventName: "warn",
|
||||
log: state.log
|
||||
});
|
||||
handleEventHandlers(state, webhookNameOrNames, handler);
|
||||
}
|
||||
function receiverOnAny(state, handler) {
|
||||
handleEventHandlers(state, "*", handler);
|
||||
}
|
||||
function receiverOnError(state, handler) {
|
||||
handleEventHandlers(state, "error", handler);
|
||||
}
|
||||
export {
|
||||
receiverOn,
|
||||
receiverOnAny,
|
||||
receiverOnError
|
||||
};
|
||||
61
node_modules/@octokit/webhooks/dist-src/event-handler/receive.js
generated
vendored
Normal file
61
node_modules/@octokit/webhooks/dist-src/event-handler/receive.js
generated
vendored
Normal file
@@ -0,0 +1,61 @@
|
||||
import { wrapErrorHandler } from "./wrap-error-handler.js";
|
||||
function getHooks(state, eventPayloadAction, eventName) {
|
||||
const hooks = [state.hooks[eventName], state.hooks["*"]];
|
||||
if (eventPayloadAction) {
|
||||
hooks.unshift(state.hooks[`${eventName}.${eventPayloadAction}`]);
|
||||
}
|
||||
return [].concat(...hooks.filter(Boolean));
|
||||
}
|
||||
function receiverHandle(state, event) {
|
||||
const errorHandlers = state.hooks.error || [];
|
||||
if (event instanceof Error) {
|
||||
const error = Object.assign(new AggregateError([event], event.message), {
|
||||
event
|
||||
});
|
||||
errorHandlers.forEach((handler) => wrapErrorHandler(handler, error));
|
||||
return Promise.reject(error);
|
||||
}
|
||||
if (!event || !event.name) {
|
||||
const error = new Error("Event name not passed");
|
||||
throw new AggregateError([error], error.message);
|
||||
}
|
||||
if (!event.payload) {
|
||||
const error = new Error("Event name not passed");
|
||||
throw new AggregateError([error], error.message);
|
||||
}
|
||||
const hooks = getHooks(
|
||||
state,
|
||||
"action" in event.payload ? event.payload.action : null,
|
||||
event.name
|
||||
);
|
||||
if (hooks.length === 0) {
|
||||
return Promise.resolve();
|
||||
}
|
||||
const errors = [];
|
||||
const promises = hooks.map((handler) => {
|
||||
let promise = Promise.resolve(event);
|
||||
if (state.transform) {
|
||||
promise = promise.then(state.transform);
|
||||
}
|
||||
return promise.then((event2) => {
|
||||
return handler(event2);
|
||||
}).catch((error) => errors.push(Object.assign(error, { event })));
|
||||
});
|
||||
return Promise.all(promises).then(() => {
|
||||
if (errors.length === 0) {
|
||||
return;
|
||||
}
|
||||
const error = new AggregateError(
|
||||
errors,
|
||||
errors.map((error2) => error2.message).join("\n")
|
||||
);
|
||||
Object.assign(error, {
|
||||
event
|
||||
});
|
||||
errorHandlers.forEach((handler) => wrapErrorHandler(handler, error));
|
||||
throw error;
|
||||
});
|
||||
}
|
||||
export {
|
||||
receiverHandle
|
||||
};
|
||||
20
node_modules/@octokit/webhooks/dist-src/event-handler/remove-listener.js
generated
vendored
Normal file
20
node_modules/@octokit/webhooks/dist-src/event-handler/remove-listener.js
generated
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
function removeListener(state, webhookNameOrNames, handler) {
|
||||
if (Array.isArray(webhookNameOrNames)) {
|
||||
webhookNameOrNames.forEach(
|
||||
(webhookName) => removeListener(state, webhookName, handler)
|
||||
);
|
||||
return;
|
||||
}
|
||||
if (!state.hooks[webhookNameOrNames]) {
|
||||
return;
|
||||
}
|
||||
for (let i = state.hooks[webhookNameOrNames].length - 1; i >= 0; i--) {
|
||||
if (state.hooks[webhookNameOrNames][i] === handler) {
|
||||
state.hooks[webhookNameOrNames].splice(i, 1);
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
export {
|
||||
removeListener
|
||||
};
|
||||
33
node_modules/@octokit/webhooks/dist-src/event-handler/validate-event-name.js
generated
vendored
Normal file
33
node_modules/@octokit/webhooks/dist-src/event-handler/validate-event-name.js
generated
vendored
Normal file
@@ -0,0 +1,33 @@
|
||||
import { emitterEventNames } from "../generated/webhook-names.js";
|
||||
function validateEventName(eventName, options = {}) {
|
||||
if (typeof eventName !== "string") {
|
||||
throw new TypeError("eventName must be of type string");
|
||||
}
|
||||
if (eventName === "*") {
|
||||
throw new TypeError(
|
||||
`Using the "*" event with the regular Webhooks.on() function is not supported. Please use the Webhooks.onAny() method instead`
|
||||
);
|
||||
}
|
||||
if (eventName === "error") {
|
||||
throw new TypeError(
|
||||
`Using the "error" event with the regular Webhooks.on() function is not supported. Please use the Webhooks.onError() method instead`
|
||||
);
|
||||
}
|
||||
if (options.onUnknownEventName === "ignore") {
|
||||
return;
|
||||
}
|
||||
if (!emitterEventNames.includes(eventName)) {
|
||||
if (options.onUnknownEventName !== "warn") {
|
||||
throw new TypeError(
|
||||
`"${eventName}" is not a known webhook name (https://developer.github.com/v3/activity/events/types/)`
|
||||
);
|
||||
} else {
|
||||
(options.log || console).warn(
|
||||
`"${eventName}" is not a known webhook name (https://developer.github.com/v3/activity/events/types/)`
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
export {
|
||||
validateEventName
|
||||
};
|
||||
18
node_modules/@octokit/webhooks/dist-src/event-handler/wrap-error-handler.js
generated
vendored
Normal file
18
node_modules/@octokit/webhooks/dist-src/event-handler/wrap-error-handler.js
generated
vendored
Normal file
@@ -0,0 +1,18 @@
|
||||
function wrapErrorHandler(handler, error) {
|
||||
let returnValue;
|
||||
try {
|
||||
returnValue = handler(error);
|
||||
} catch (error2) {
|
||||
console.log('FATAL: Error occurred in "error" event handler');
|
||||
console.log(error2);
|
||||
}
|
||||
if (returnValue && returnValue.catch) {
|
||||
returnValue.catch((error2) => {
|
||||
console.log('FATAL: Error occurred in "error" event handler');
|
||||
console.log(error2);
|
||||
});
|
||||
}
|
||||
}
|
||||
export {
|
||||
wrapErrorHandler
|
||||
};
|
||||
0
node_modules/@octokit/webhooks/dist-src/generated/webhook-identifiers.js
generated
vendored
Normal file
0
node_modules/@octokit/webhooks/dist-src/generated/webhook-identifiers.js
generated
vendored
Normal file
328
node_modules/@octokit/webhooks/dist-src/generated/webhook-names.js
generated
vendored
Normal file
328
node_modules/@octokit/webhooks/dist-src/generated/webhook-names.js
generated
vendored
Normal file
@@ -0,0 +1,328 @@
|
||||
const emitterEventNames = [
|
||||
"branch_protection_configuration",
|
||||
"branch_protection_configuration.disabled",
|
||||
"branch_protection_configuration.enabled",
|
||||
"branch_protection_rule",
|
||||
"branch_protection_rule.created",
|
||||
"branch_protection_rule.deleted",
|
||||
"branch_protection_rule.edited",
|
||||
"check_run",
|
||||
"check_run.completed",
|
||||
"check_run.created",
|
||||
"check_run.requested_action",
|
||||
"check_run.rerequested",
|
||||
"check_suite",
|
||||
"check_suite.completed",
|
||||
"check_suite.requested",
|
||||
"check_suite.rerequested",
|
||||
"code_scanning_alert",
|
||||
"code_scanning_alert.appeared_in_branch",
|
||||
"code_scanning_alert.closed_by_user",
|
||||
"code_scanning_alert.created",
|
||||
"code_scanning_alert.fixed",
|
||||
"code_scanning_alert.reopened",
|
||||
"code_scanning_alert.reopened_by_user",
|
||||
"commit_comment",
|
||||
"commit_comment.created",
|
||||
"create",
|
||||
"custom_property",
|
||||
"custom_property.created",
|
||||
"custom_property.deleted",
|
||||
"custom_property.promote_to_enterprise",
|
||||
"custom_property.updated",
|
||||
"custom_property_values",
|
||||
"custom_property_values.updated",
|
||||
"delete",
|
||||
"dependabot_alert",
|
||||
"dependabot_alert.auto_dismissed",
|
||||
"dependabot_alert.auto_reopened",
|
||||
"dependabot_alert.created",
|
||||
"dependabot_alert.dismissed",
|
||||
"dependabot_alert.fixed",
|
||||
"dependabot_alert.reintroduced",
|
||||
"dependabot_alert.reopened",
|
||||
"deploy_key",
|
||||
"deploy_key.created",
|
||||
"deploy_key.deleted",
|
||||
"deployment",
|
||||
"deployment.created",
|
||||
"deployment_protection_rule",
|
||||
"deployment_protection_rule.requested",
|
||||
"deployment_review",
|
||||
"deployment_review.approved",
|
||||
"deployment_review.rejected",
|
||||
"deployment_review.requested",
|
||||
"deployment_status",
|
||||
"deployment_status.created",
|
||||
"discussion",
|
||||
"discussion.answered",
|
||||
"discussion.category_changed",
|
||||
"discussion.closed",
|
||||
"discussion.created",
|
||||
"discussion.deleted",
|
||||
"discussion.edited",
|
||||
"discussion.labeled",
|
||||
"discussion.locked",
|
||||
"discussion.pinned",
|
||||
"discussion.reopened",
|
||||
"discussion.transferred",
|
||||
"discussion.unanswered",
|
||||
"discussion.unlabeled",
|
||||
"discussion.unlocked",
|
||||
"discussion.unpinned",
|
||||
"discussion_comment",
|
||||
"discussion_comment.created",
|
||||
"discussion_comment.deleted",
|
||||
"discussion_comment.edited",
|
||||
"fork",
|
||||
"github_app_authorization",
|
||||
"github_app_authorization.revoked",
|
||||
"gollum",
|
||||
"installation",
|
||||
"installation.created",
|
||||
"installation.deleted",
|
||||
"installation.new_permissions_accepted",
|
||||
"installation.suspend",
|
||||
"installation.unsuspend",
|
||||
"installation_repositories",
|
||||
"installation_repositories.added",
|
||||
"installation_repositories.removed",
|
||||
"installation_target",
|
||||
"installation_target.renamed",
|
||||
"issue_comment",
|
||||
"issue_comment.created",
|
||||
"issue_comment.deleted",
|
||||
"issue_comment.edited",
|
||||
"issue_dependencies",
|
||||
"issue_dependencies.blocked_by_added",
|
||||
"issue_dependencies.blocked_by_removed",
|
||||
"issue_dependencies.blocking_added",
|
||||
"issue_dependencies.blocking_removed",
|
||||
"issues",
|
||||
"issues.assigned",
|
||||
"issues.closed",
|
||||
"issues.deleted",
|
||||
"issues.demilestoned",
|
||||
"issues.edited",
|
||||
"issues.labeled",
|
||||
"issues.locked",
|
||||
"issues.milestoned",
|
||||
"issues.opened",
|
||||
"issues.pinned",
|
||||
"issues.reopened",
|
||||
"issues.transferred",
|
||||
"issues.typed",
|
||||
"issues.unassigned",
|
||||
"issues.unlabeled",
|
||||
"issues.unlocked",
|
||||
"issues.unpinned",
|
||||
"issues.untyped",
|
||||
"label",
|
||||
"label.created",
|
||||
"label.deleted",
|
||||
"label.edited",
|
||||
"marketplace_purchase",
|
||||
"marketplace_purchase.cancelled",
|
||||
"marketplace_purchase.changed",
|
||||
"marketplace_purchase.pending_change",
|
||||
"marketplace_purchase.pending_change_cancelled",
|
||||
"marketplace_purchase.purchased",
|
||||
"member",
|
||||
"member.added",
|
||||
"member.edited",
|
||||
"member.removed",
|
||||
"membership",
|
||||
"membership.added",
|
||||
"membership.removed",
|
||||
"merge_group",
|
||||
"merge_group.checks_requested",
|
||||
"merge_group.destroyed",
|
||||
"meta",
|
||||
"meta.deleted",
|
||||
"milestone",
|
||||
"milestone.closed",
|
||||
"milestone.created",
|
||||
"milestone.deleted",
|
||||
"milestone.edited",
|
||||
"milestone.opened",
|
||||
"org_block",
|
||||
"org_block.blocked",
|
||||
"org_block.unblocked",
|
||||
"organization",
|
||||
"organization.deleted",
|
||||
"organization.member_added",
|
||||
"organization.member_invited",
|
||||
"organization.member_removed",
|
||||
"organization.renamed",
|
||||
"package",
|
||||
"package.published",
|
||||
"package.updated",
|
||||
"page_build",
|
||||
"personal_access_token_request",
|
||||
"personal_access_token_request.approved",
|
||||
"personal_access_token_request.cancelled",
|
||||
"personal_access_token_request.created",
|
||||
"personal_access_token_request.denied",
|
||||
"ping",
|
||||
"project",
|
||||
"project.closed",
|
||||
"project.created",
|
||||
"project.deleted",
|
||||
"project.edited",
|
||||
"project.reopened",
|
||||
"project_card",
|
||||
"project_card.converted",
|
||||
"project_card.created",
|
||||
"project_card.deleted",
|
||||
"project_card.edited",
|
||||
"project_card.moved",
|
||||
"project_column",
|
||||
"project_column.created",
|
||||
"project_column.deleted",
|
||||
"project_column.edited",
|
||||
"project_column.moved",
|
||||
"projects_v2",
|
||||
"projects_v2.closed",
|
||||
"projects_v2.created",
|
||||
"projects_v2.deleted",
|
||||
"projects_v2.edited",
|
||||
"projects_v2.reopened",
|
||||
"projects_v2_item",
|
||||
"projects_v2_item.archived",
|
||||
"projects_v2_item.converted",
|
||||
"projects_v2_item.created",
|
||||
"projects_v2_item.deleted",
|
||||
"projects_v2_item.edited",
|
||||
"projects_v2_item.reordered",
|
||||
"projects_v2_item.restored",
|
||||
"projects_v2_status_update",
|
||||
"projects_v2_status_update.created",
|
||||
"projects_v2_status_update.deleted",
|
||||
"projects_v2_status_update.edited",
|
||||
"public",
|
||||
"pull_request",
|
||||
"pull_request.assigned",
|
||||
"pull_request.auto_merge_disabled",
|
||||
"pull_request.auto_merge_enabled",
|
||||
"pull_request.closed",
|
||||
"pull_request.converted_to_draft",
|
||||
"pull_request.demilestoned",
|
||||
"pull_request.dequeued",
|
||||
"pull_request.edited",
|
||||
"pull_request.enqueued",
|
||||
"pull_request.labeled",
|
||||
"pull_request.locked",
|
||||
"pull_request.milestoned",
|
||||
"pull_request.opened",
|
||||
"pull_request.ready_for_review",
|
||||
"pull_request.reopened",
|
||||
"pull_request.review_request_removed",
|
||||
"pull_request.review_requested",
|
||||
"pull_request.synchronize",
|
||||
"pull_request.unassigned",
|
||||
"pull_request.unlabeled",
|
||||
"pull_request.unlocked",
|
||||
"pull_request_review",
|
||||
"pull_request_review.dismissed",
|
||||
"pull_request_review.edited",
|
||||
"pull_request_review.submitted",
|
||||
"pull_request_review_comment",
|
||||
"pull_request_review_comment.created",
|
||||
"pull_request_review_comment.deleted",
|
||||
"pull_request_review_comment.edited",
|
||||
"pull_request_review_thread",
|
||||
"pull_request_review_thread.resolved",
|
||||
"pull_request_review_thread.unresolved",
|
||||
"push",
|
||||
"registry_package",
|
||||
"registry_package.published",
|
||||
"registry_package.updated",
|
||||
"release",
|
||||
"release.created",
|
||||
"release.deleted",
|
||||
"release.edited",
|
||||
"release.prereleased",
|
||||
"release.published",
|
||||
"release.released",
|
||||
"release.unpublished",
|
||||
"repository",
|
||||
"repository.archived",
|
||||
"repository.created",
|
||||
"repository.deleted",
|
||||
"repository.edited",
|
||||
"repository.privatized",
|
||||
"repository.publicized",
|
||||
"repository.renamed",
|
||||
"repository.transferred",
|
||||
"repository.unarchived",
|
||||
"repository_advisory",
|
||||
"repository_advisory.published",
|
||||
"repository_advisory.reported",
|
||||
"repository_dispatch",
|
||||
"repository_dispatch.sample.collected",
|
||||
"repository_import",
|
||||
"repository_ruleset",
|
||||
"repository_ruleset.created",
|
||||
"repository_ruleset.deleted",
|
||||
"repository_ruleset.edited",
|
||||
"repository_vulnerability_alert",
|
||||
"repository_vulnerability_alert.create",
|
||||
"repository_vulnerability_alert.dismiss",
|
||||
"repository_vulnerability_alert.reopen",
|
||||
"repository_vulnerability_alert.resolve",
|
||||
"secret_scanning_alert",
|
||||
"secret_scanning_alert.assigned",
|
||||
"secret_scanning_alert.created",
|
||||
"secret_scanning_alert.publicly_leaked",
|
||||
"secret_scanning_alert.reopened",
|
||||
"secret_scanning_alert.resolved",
|
||||
"secret_scanning_alert.unassigned",
|
||||
"secret_scanning_alert.validated",
|
||||
"secret_scanning_alert_location",
|
||||
"secret_scanning_alert_location.created",
|
||||
"secret_scanning_scan",
|
||||
"secret_scanning_scan.completed",
|
||||
"security_advisory",
|
||||
"security_advisory.published",
|
||||
"security_advisory.updated",
|
||||
"security_advisory.withdrawn",
|
||||
"security_and_analysis",
|
||||
"sponsorship",
|
||||
"sponsorship.cancelled",
|
||||
"sponsorship.created",
|
||||
"sponsorship.edited",
|
||||
"sponsorship.pending_cancellation",
|
||||
"sponsorship.pending_tier_change",
|
||||
"sponsorship.tier_changed",
|
||||
"star",
|
||||
"star.created",
|
||||
"star.deleted",
|
||||
"status",
|
||||
"sub_issues",
|
||||
"sub_issues.parent_issue_added",
|
||||
"sub_issues.parent_issue_removed",
|
||||
"sub_issues.sub_issue_added",
|
||||
"sub_issues.sub_issue_removed",
|
||||
"team",
|
||||
"team.added_to_repository",
|
||||
"team.created",
|
||||
"team.deleted",
|
||||
"team.edited",
|
||||
"team.removed_from_repository",
|
||||
"team_add",
|
||||
"watch",
|
||||
"watch.started",
|
||||
"workflow_dispatch",
|
||||
"workflow_job",
|
||||
"workflow_job.completed",
|
||||
"workflow_job.in_progress",
|
||||
"workflow_job.queued",
|
||||
"workflow_job.waiting",
|
||||
"workflow_run",
|
||||
"workflow_run.completed",
|
||||
"workflow_run.in_progress",
|
||||
"workflow_run.requested"
|
||||
];
|
||||
export {
|
||||
emitterEventNames
|
||||
};
|
||||
48
node_modules/@octokit/webhooks/dist-src/index.js
generated
vendored
Normal file
48
node_modules/@octokit/webhooks/dist-src/index.js
generated
vendored
Normal file
@@ -0,0 +1,48 @@
|
||||
import { createLogger } from "./create-logger.js";
|
||||
import {
|
||||
createEventHandler
|
||||
} from "./event-handler/index.js";
|
||||
import { validateEventName } from "./event-handler/validate-event-name.js";
|
||||
import { sign, verify } from "@octokit/webhooks-methods";
|
||||
import { verifyAndReceive } from "./verify-and-receive.js";
|
||||
import { createNodeMiddleware } from "./middleware/node/index.js";
|
||||
import { createWebMiddleware } from "./middleware/web/index.js";
|
||||
import { emitterEventNames } from "./generated/webhook-names.js";
|
||||
class Webhooks {
|
||||
sign;
|
||||
verify;
|
||||
on;
|
||||
onAny;
|
||||
onError;
|
||||
removeListener;
|
||||
receive;
|
||||
verifyAndReceive;
|
||||
constructor(options) {
|
||||
if (!options || !options.secret) {
|
||||
throw new Error("[@octokit/webhooks] options.secret required");
|
||||
}
|
||||
const state = {
|
||||
eventHandler: createEventHandler(options),
|
||||
secret: options.secret,
|
||||
additionalSecrets: options.additionalSecrets,
|
||||
hooks: {},
|
||||
log: createLogger(options.log)
|
||||
};
|
||||
this.sign = sign.bind(null, options.secret);
|
||||
this.verify = verify.bind(null, options.secret);
|
||||
this.on = state.eventHandler.on;
|
||||
this.onAny = state.eventHandler.onAny;
|
||||
this.onError = state.eventHandler.onError;
|
||||
this.removeListener = state.eventHandler.removeListener;
|
||||
this.receive = state.eventHandler.receive;
|
||||
this.verifyAndReceive = verifyAndReceive.bind(null, state);
|
||||
}
|
||||
}
|
||||
export {
|
||||
Webhooks,
|
||||
createEventHandler,
|
||||
createNodeMiddleware,
|
||||
createWebMiddleware,
|
||||
emitterEventNames,
|
||||
validateEventName
|
||||
};
|
||||
147
node_modules/@octokit/webhooks/dist-src/middleware/create-middleware.js
generated
vendored
Normal file
147
node_modules/@octokit/webhooks/dist-src/middleware/create-middleware.js
generated
vendored
Normal file
@@ -0,0 +1,147 @@
|
||||
import { normalizeTrailingSlashes } from "../normalize-trailing-slashes.js";
|
||||
const isApplicationJsonRE = /^\s*(application\/json)\s*(?:;|$)/u;
|
||||
const WEBHOOK_HEADERS = [
|
||||
"x-github-event",
|
||||
"x-hub-signature-256",
|
||||
"x-github-delivery"
|
||||
];
|
||||
function createMiddleware(options) {
|
||||
const { handleResponse, getRequestHeader, getPayload } = options;
|
||||
return function middleware(webhooks, options2) {
|
||||
const middlewarePath = normalizeTrailingSlashes(options2.path);
|
||||
return async function octokitWebhooksMiddleware(request, response, next) {
|
||||
let pathname;
|
||||
try {
|
||||
pathname = new URL(
|
||||
normalizeTrailingSlashes(request.url),
|
||||
"http://localhost"
|
||||
).pathname;
|
||||
} catch (error) {
|
||||
return handleResponse(
|
||||
JSON.stringify({
|
||||
error: `Request URL could not be parsed: ${request.url}`
|
||||
}),
|
||||
422,
|
||||
{
|
||||
"content-type": "application/json"
|
||||
},
|
||||
response
|
||||
);
|
||||
}
|
||||
if (pathname !== middlewarePath) {
|
||||
next?.();
|
||||
return handleResponse(null);
|
||||
} else if (request.method !== "POST") {
|
||||
return handleResponse(
|
||||
JSON.stringify({
|
||||
error: `Unknown route: ${request.method} ${pathname}`
|
||||
}),
|
||||
404,
|
||||
{
|
||||
"content-type": "application/json"
|
||||
},
|
||||
response
|
||||
);
|
||||
}
|
||||
const contentType = getRequestHeader(request, "content-type");
|
||||
if (typeof contentType !== "string" || !isApplicationJsonRE.test(contentType)) {
|
||||
return handleResponse(
|
||||
JSON.stringify({
|
||||
error: `Unsupported "Content-Type" header value. Must be "application/json"`
|
||||
}),
|
||||
415,
|
||||
{
|
||||
"content-type": "application/json",
|
||||
accept: "application/json"
|
||||
},
|
||||
response
|
||||
);
|
||||
}
|
||||
const missingHeaders = WEBHOOK_HEADERS.filter((header) => {
|
||||
return getRequestHeader(request, header) == void 0;
|
||||
}).join(", ");
|
||||
if (missingHeaders) {
|
||||
return handleResponse(
|
||||
JSON.stringify({
|
||||
error: `Required headers missing: ${missingHeaders}`
|
||||
}),
|
||||
400,
|
||||
{
|
||||
"content-type": "application/json",
|
||||
accept: "application/json"
|
||||
},
|
||||
response
|
||||
);
|
||||
}
|
||||
const eventName = getRequestHeader(
|
||||
request,
|
||||
"x-github-event"
|
||||
);
|
||||
const signature = getRequestHeader(request, "x-hub-signature-256");
|
||||
const id = getRequestHeader(request, "x-github-delivery");
|
||||
options2.log.debug(`${eventName} event received (id: ${id})`);
|
||||
let didTimeout = false;
|
||||
let timeout;
|
||||
const timeoutPromise = new Promise((resolve) => {
|
||||
timeout = setTimeout(() => {
|
||||
didTimeout = true;
|
||||
resolve(
|
||||
handleResponse(
|
||||
"still processing\n",
|
||||
202,
|
||||
{
|
||||
"Content-Type": "text/plain",
|
||||
accept: "application/json"
|
||||
},
|
||||
response
|
||||
)
|
||||
);
|
||||
}, options2.timeout);
|
||||
});
|
||||
const processWebhook = async () => {
|
||||
try {
|
||||
const payload = await getPayload(request);
|
||||
await webhooks.verifyAndReceive({
|
||||
id,
|
||||
name: eventName,
|
||||
payload,
|
||||
signature
|
||||
});
|
||||
clearTimeout(timeout);
|
||||
if (didTimeout) return handleResponse(null);
|
||||
return handleResponse(
|
||||
"ok\n",
|
||||
200,
|
||||
{
|
||||
"content-type": "text/plain",
|
||||
accept: "application/json"
|
||||
},
|
||||
response
|
||||
);
|
||||
} catch (error) {
|
||||
clearTimeout(timeout);
|
||||
if (didTimeout) return handleResponse(null);
|
||||
const err = Array.from(error.errors)[0];
|
||||
const errorMessage = err.message ? `${err.name}: ${err.message}` : "Error: An Unspecified error occurred";
|
||||
const statusCode = typeof err.status !== "undefined" ? err.status : 500;
|
||||
options2.log.error(error);
|
||||
return handleResponse(
|
||||
JSON.stringify({
|
||||
error: errorMessage
|
||||
}),
|
||||
statusCode,
|
||||
{
|
||||
"content-type": "application/json",
|
||||
accept: "application/json"
|
||||
},
|
||||
response
|
||||
);
|
||||
}
|
||||
};
|
||||
return await Promise.race([timeoutPromise, processWebhook()]);
|
||||
};
|
||||
};
|
||||
}
|
||||
export {
|
||||
createMiddleware
|
||||
};
|
||||
30
node_modules/@octokit/webhooks/dist-src/middleware/node/get-payload.js
generated
vendored
Normal file
30
node_modules/@octokit/webhooks/dist-src/middleware/node/get-payload.js
generated
vendored
Normal file
@@ -0,0 +1,30 @@
|
||||
import { concatUint8Array } from "../../concat-uint8array.js";
|
||||
const textDecoder = new TextDecoder("utf-8", { fatal: false });
|
||||
const decode = textDecoder.decode.bind(textDecoder);
|
||||
async function getPayload(request) {
|
||||
if (typeof request.body === "object" && "rawBody" in request && request.rawBody instanceof Uint8Array) {
|
||||
return decode(request.rawBody);
|
||||
} else if (typeof request.body === "string") {
|
||||
return request.body;
|
||||
}
|
||||
const payload = await getPayloadFromRequestStream(request);
|
||||
return decode(payload);
|
||||
}
|
||||
function getPayloadFromRequestStream(request) {
|
||||
return new Promise((resolve, reject) => {
|
||||
let data = [];
|
||||
request.on(
|
||||
"error",
|
||||
(error) => reject(new AggregateError([error], error.message))
|
||||
);
|
||||
request.on("data", data.push.bind(data));
|
||||
request.on("end", () => {
|
||||
const result = concatUint8Array(data);
|
||||
queueMicrotask(() => resolve(result));
|
||||
});
|
||||
});
|
||||
}
|
||||
export {
|
||||
getPayload,
|
||||
getPayloadFromRequestStream
|
||||
};
|
||||
6
node_modules/@octokit/webhooks/dist-src/middleware/node/get-request-header.js
generated
vendored
Normal file
6
node_modules/@octokit/webhooks/dist-src/middleware/node/get-request-header.js
generated
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
function getRequestHeader(request, key) {
|
||||
return request.headers[key];
|
||||
}
|
||||
export {
|
||||
getRequestHeader
|
||||
};
|
||||
11
node_modules/@octokit/webhooks/dist-src/middleware/node/handle-response.js
generated
vendored
Normal file
11
node_modules/@octokit/webhooks/dist-src/middleware/node/handle-response.js
generated
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
function handleResponse(body, status = 200, headers = {}, response) {
|
||||
if (body === null) {
|
||||
return false;
|
||||
}
|
||||
headers["content-length"] = body.length.toString();
|
||||
response.writeHead(status, headers).end(body);
|
||||
return true;
|
||||
}
|
||||
export {
|
||||
handleResponse
|
||||
};
|
||||
23
node_modules/@octokit/webhooks/dist-src/middleware/node/index.js
generated
vendored
Normal file
23
node_modules/@octokit/webhooks/dist-src/middleware/node/index.js
generated
vendored
Normal file
@@ -0,0 +1,23 @@
|
||||
import { createLogger } from "../../create-logger.js";
|
||||
import { createMiddleware } from "../create-middleware.js";
|
||||
import { handleResponse } from "./handle-response.js";
|
||||
import { getRequestHeader } from "./get-request-header.js";
|
||||
import { getPayload } from "./get-payload.js";
|
||||
function createNodeMiddleware(webhooks, {
|
||||
path = "/api/github/webhooks",
|
||||
log = createLogger(),
|
||||
timeout = 9e3
|
||||
} = {}) {
|
||||
return createMiddleware({
|
||||
handleResponse,
|
||||
getRequestHeader,
|
||||
getPayload
|
||||
})(webhooks, {
|
||||
path,
|
||||
log,
|
||||
timeout
|
||||
});
|
||||
}
|
||||
export {
|
||||
createNodeMiddleware
|
||||
};
|
||||
6
node_modules/@octokit/webhooks/dist-src/middleware/web/get-payload.js
generated
vendored
Normal file
6
node_modules/@octokit/webhooks/dist-src/middleware/web/get-payload.js
generated
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
function getPayload(request) {
|
||||
return request.text();
|
||||
}
|
||||
export {
|
||||
getPayload
|
||||
};
|
||||
6
node_modules/@octokit/webhooks/dist-src/middleware/web/get-request-header.js
generated
vendored
Normal file
6
node_modules/@octokit/webhooks/dist-src/middleware/web/get-request-header.js
generated
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
function getRequestHeader(request, key) {
|
||||
return request.headers.get(key);
|
||||
}
|
||||
export {
|
||||
getRequestHeader
|
||||
};
|
||||
12
node_modules/@octokit/webhooks/dist-src/middleware/web/handle-response.js
generated
vendored
Normal file
12
node_modules/@octokit/webhooks/dist-src/middleware/web/handle-response.js
generated
vendored
Normal file
@@ -0,0 +1,12 @@
|
||||
function handleResponse(body, status = 200, headers = {}) {
|
||||
if (body !== null) {
|
||||
headers["content-length"] = body.length.toString();
|
||||
}
|
||||
return new Response(body, {
|
||||
status,
|
||||
headers
|
||||
});
|
||||
}
|
||||
export {
|
||||
handleResponse
|
||||
};
|
||||
23
node_modules/@octokit/webhooks/dist-src/middleware/web/index.js
generated
vendored
Normal file
23
node_modules/@octokit/webhooks/dist-src/middleware/web/index.js
generated
vendored
Normal file
@@ -0,0 +1,23 @@
|
||||
import { createLogger } from "../../create-logger.js";
|
||||
import { createMiddleware } from "../create-middleware.js";
|
||||
import { getPayload } from "./get-payload.js";
|
||||
import { getRequestHeader } from "./get-request-header.js";
|
||||
import { handleResponse } from "./handle-response.js";
|
||||
function createWebMiddleware(webhooks, {
|
||||
path = "/api/github/webhooks",
|
||||
log = createLogger(),
|
||||
timeout = 9e3
|
||||
} = {}) {
|
||||
return createMiddleware({
|
||||
handleResponse,
|
||||
getRequestHeader,
|
||||
getPayload
|
||||
})(webhooks, {
|
||||
path,
|
||||
log,
|
||||
timeout
|
||||
});
|
||||
}
|
||||
export {
|
||||
createWebMiddleware
|
||||
};
|
||||
18
node_modules/@octokit/webhooks/dist-src/normalize-trailing-slashes.js
generated
vendored
Normal file
18
node_modules/@octokit/webhooks/dist-src/normalize-trailing-slashes.js
generated
vendored
Normal file
@@ -0,0 +1,18 @@
|
||||
function normalizeTrailingSlashes(path) {
|
||||
let i = path.length;
|
||||
if (i === 0) {
|
||||
return "/";
|
||||
}
|
||||
while (i > 0) {
|
||||
if (path.charCodeAt(--i) !== 47) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (i === -1) {
|
||||
return "/";
|
||||
}
|
||||
return path.slice(0, i + 1);
|
||||
}
|
||||
export {
|
||||
normalizeTrailingSlashes
|
||||
};
|
||||
33
node_modules/@octokit/webhooks/dist-src/verify-and-receive.js
generated
vendored
Normal file
33
node_modules/@octokit/webhooks/dist-src/verify-and-receive.js
generated
vendored
Normal file
@@ -0,0 +1,33 @@
|
||||
import { verifyWithFallback } from "@octokit/webhooks-methods";
|
||||
async function verifyAndReceive(state, event) {
|
||||
const matchesSignature = await verifyWithFallback(
|
||||
state.secret,
|
||||
event.payload,
|
||||
event.signature,
|
||||
state.additionalSecrets
|
||||
).catch(() => false);
|
||||
if (!matchesSignature) {
|
||||
const error = new Error(
|
||||
"[@octokit/webhooks] signature does not match event payload and secret"
|
||||
);
|
||||
error.event = event;
|
||||
error.status = 400;
|
||||
return state.eventHandler.receive(error);
|
||||
}
|
||||
let payload;
|
||||
try {
|
||||
payload = JSON.parse(event.payload);
|
||||
} catch (error) {
|
||||
error.message = "Invalid JSON";
|
||||
error.status = 400;
|
||||
throw new AggregateError([error], error.message);
|
||||
}
|
||||
return state.eventHandler.receive({
|
||||
id: event.id,
|
||||
name: event.name,
|
||||
payload
|
||||
});
|
||||
}
|
||||
export {
|
||||
verifyAndReceive
|
||||
};
|
||||
1
node_modules/@octokit/webhooks/dist-types/concat-uint8array.d.ts
generated
vendored
Normal file
1
node_modules/@octokit/webhooks/dist-types/concat-uint8array.d.ts
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
export declare function concatUint8Array(data: Uint8Array[]): Uint8Array;
|
||||
7
node_modules/@octokit/webhooks/dist-types/create-logger.d.ts
generated
vendored
Normal file
7
node_modules/@octokit/webhooks/dist-types/create-logger.d.ts
generated
vendored
Normal file
@@ -0,0 +1,7 @@
|
||||
export interface Logger {
|
||||
debug: (...data: any[]) => void;
|
||||
info: (...data: any[]) => void;
|
||||
warn: (...data: any[]) => void;
|
||||
error: (...data: any[]) => void;
|
||||
}
|
||||
export declare const createLogger: (logger?: Partial<Logger>) => Logger;
|
||||
9
node_modules/@octokit/webhooks/dist-types/event-handler/index.d.ts
generated
vendored
Normal file
9
node_modules/@octokit/webhooks/dist-types/event-handler/index.d.ts
generated
vendored
Normal file
@@ -0,0 +1,9 @@
|
||||
import type { EmitterWebhookEvent, EmitterWebhookEventName, HandlerFunction, Options, WebhookError, WebhookEventHandlerError } from "../types.ts";
|
||||
export interface EventHandler<TTransformed = unknown> {
|
||||
on<E extends EmitterWebhookEventName>(event: E | E[], callback: HandlerFunction<E, TTransformed>): void;
|
||||
onAny(handler: (event: TTransformed extends unknown ? EmitterWebhookEvent : EmitterWebhookEvent & TTransformed) => any): void;
|
||||
onError(handler: (event: WebhookEventHandlerError<TTransformed>) => any): void;
|
||||
removeListener<E extends EmitterWebhookEventName>(event: E | E[], callback: HandlerFunction<E, TTransformed>): void;
|
||||
receive(event: EmitterWebhookEvent | WebhookError): Promise<void>;
|
||||
}
|
||||
export declare function createEventHandler<TTransformed = unknown>(options: Options<TTransformed>): EventHandler<TTransformed>;
|
||||
4
node_modules/@octokit/webhooks/dist-types/event-handler/on.d.ts
generated
vendored
Normal file
4
node_modules/@octokit/webhooks/dist-types/event-handler/on.d.ts
generated
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
import type { EmitterWebhookEvent, EmitterWebhookEventName, State, WebhookEventHandlerError } from "../types.ts";
|
||||
export declare function receiverOn(state: State, webhookNameOrNames: EmitterWebhookEventName | EmitterWebhookEventName[], handler: Function): void;
|
||||
export declare function receiverOnAny<TTransformed>(state: State, handler: (event: TTransformed extends unknown ? EmitterWebhookEvent : EmitterWebhookEvent & TTransformed) => any): void;
|
||||
export declare function receiverOnError<TTransformed>(state: State, handler: (event: WebhookEventHandlerError<TTransformed>) => any): void;
|
||||
2
node_modules/@octokit/webhooks/dist-types/event-handler/receive.d.ts
generated
vendored
Normal file
2
node_modules/@octokit/webhooks/dist-types/event-handler/receive.d.ts
generated
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
import type { EmitterWebhookEvent, State, WebhookError } from "../types.ts";
|
||||
export declare function receiverHandle(state: State, event: EmitterWebhookEvent | WebhookError): Promise<void>;
|
||||
2
node_modules/@octokit/webhooks/dist-types/event-handler/remove-listener.d.ts
generated
vendored
Normal file
2
node_modules/@octokit/webhooks/dist-types/event-handler/remove-listener.d.ts
generated
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
import type { EmitterWebhookEventName, State } from "../types.ts";
|
||||
export declare function removeListener(state: State, webhookNameOrNames: "*" | EmitterWebhookEventName | EmitterWebhookEventName[], handler: Function): void;
|
||||
14
node_modules/@octokit/webhooks/dist-types/event-handler/validate-event-name.d.ts
generated
vendored
Normal file
14
node_modules/@octokit/webhooks/dist-types/event-handler/validate-event-name.d.ts
generated
vendored
Normal file
@@ -0,0 +1,14 @@
|
||||
import type { Logger } from "../create-logger.ts";
|
||||
import type { EmitterWebhookEventName } from "../types.ts";
|
||||
type ValidateEventNameOptions = {
|
||||
onUnknownEventName?: undefined | "throw";
|
||||
} | {
|
||||
onUnknownEventName: "ignore";
|
||||
} | {
|
||||
onUnknownEventName: "warn";
|
||||
log?: Pick<Logger, "warn">;
|
||||
};
|
||||
export declare function validateEventName<TOptions extends ValidateEventNameOptions = ValidateEventNameOptions>(eventName: EmitterWebhookEventName | (string & Record<never, never>), options?: TOptions): asserts eventName is TOptions extends {
|
||||
onUnknownEventName: "throw";
|
||||
} ? EmitterWebhookEventName : Exclude<string, "*" | "error">;
|
||||
export {};
|
||||
1
node_modules/@octokit/webhooks/dist-types/event-handler/wrap-error-handler.d.ts
generated
vendored
Normal file
1
node_modules/@octokit/webhooks/dist-types/event-handler/wrap-error-handler.d.ts
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
export declare function wrapErrorHandler(handler: Function, error: Error): void;
|
||||
79
node_modules/@octokit/webhooks/dist-types/generated/webhook-identifiers.d.ts
generated
vendored
Normal file
79
node_modules/@octokit/webhooks/dist-types/generated/webhook-identifiers.d.ts
generated
vendored
Normal file
@@ -0,0 +1,79 @@
|
||||
import type { WebhookEventDefinition } from "../types.ts";
|
||||
export type EventPayloadMap = {
|
||||
branch_protection_configuration: WebhookEventDefinition<"branch-protection-configuration-disabled"> | WebhookEventDefinition<"branch-protection-configuration-enabled">;
|
||||
branch_protection_rule: WebhookEventDefinition<"branch-protection-rule-created"> | WebhookEventDefinition<"branch-protection-rule-deleted"> | WebhookEventDefinition<"branch-protection-rule-edited">;
|
||||
check_run: WebhookEventDefinition<"check-run-completed"> | WebhookEventDefinition<"check-run-created"> | WebhookEventDefinition<"check-run-requested-action"> | WebhookEventDefinition<"check-run-rerequested">;
|
||||
check_suite: WebhookEventDefinition<"check-suite-completed"> | WebhookEventDefinition<"check-suite-requested"> | WebhookEventDefinition<"check-suite-rerequested">;
|
||||
code_scanning_alert: WebhookEventDefinition<"code-scanning-alert-appeared-in-branch"> | WebhookEventDefinition<"code-scanning-alert-closed-by-user"> | WebhookEventDefinition<"code-scanning-alert-created"> | WebhookEventDefinition<"code-scanning-alert-fixed"> | WebhookEventDefinition<"code-scanning-alert-reopened"> | WebhookEventDefinition<"code-scanning-alert-reopened-by-user">;
|
||||
commit_comment: WebhookEventDefinition<"commit-comment-created">;
|
||||
create: WebhookEventDefinition<"create">;
|
||||
custom_property: WebhookEventDefinition<"custom-property-created"> | WebhookEventDefinition<"custom-property-deleted"> | WebhookEventDefinition<"custom-property-promoted-to-enterprise"> | WebhookEventDefinition<"custom-property-updated">;
|
||||
custom_property_values: WebhookEventDefinition<"custom-property-values-updated">;
|
||||
delete: WebhookEventDefinition<"delete">;
|
||||
dependabot_alert: WebhookEventDefinition<"dependabot-alert-auto-dismissed"> | WebhookEventDefinition<"dependabot-alert-auto-reopened"> | WebhookEventDefinition<"dependabot-alert-created"> | WebhookEventDefinition<"dependabot-alert-dismissed"> | WebhookEventDefinition<"dependabot-alert-fixed"> | WebhookEventDefinition<"dependabot-alert-reintroduced"> | WebhookEventDefinition<"dependabot-alert-reopened">;
|
||||
deploy_key: WebhookEventDefinition<"deploy-key-created"> | WebhookEventDefinition<"deploy-key-deleted">;
|
||||
deployment: WebhookEventDefinition<"deployment-created">;
|
||||
deployment_protection_rule: WebhookEventDefinition<"deployment-protection-rule-requested">;
|
||||
deployment_review: WebhookEventDefinition<"deployment-review-approved"> | WebhookEventDefinition<"deployment-review-rejected"> | WebhookEventDefinition<"deployment-review-requested">;
|
||||
deployment_status: WebhookEventDefinition<"deployment-status-created">;
|
||||
discussion: WebhookEventDefinition<"discussion-answered"> | WebhookEventDefinition<"discussion-category-changed"> | WebhookEventDefinition<"discussion-closed"> | WebhookEventDefinition<"discussion-created"> | WebhookEventDefinition<"discussion-deleted"> | WebhookEventDefinition<"discussion-edited"> | WebhookEventDefinition<"discussion-labeled"> | WebhookEventDefinition<"discussion-locked"> | WebhookEventDefinition<"discussion-pinned"> | WebhookEventDefinition<"discussion-reopened"> | WebhookEventDefinition<"discussion-transferred"> | WebhookEventDefinition<"discussion-unanswered"> | WebhookEventDefinition<"discussion-unlabeled"> | WebhookEventDefinition<"discussion-unlocked"> | WebhookEventDefinition<"discussion-unpinned">;
|
||||
discussion_comment: WebhookEventDefinition<"discussion-comment-created"> | WebhookEventDefinition<"discussion-comment-deleted"> | WebhookEventDefinition<"discussion-comment-edited">;
|
||||
fork: WebhookEventDefinition<"fork">;
|
||||
github_app_authorization: WebhookEventDefinition<"github-app-authorization-revoked">;
|
||||
gollum: WebhookEventDefinition<"gollum">;
|
||||
installation: WebhookEventDefinition<"installation-created"> | WebhookEventDefinition<"installation-deleted"> | WebhookEventDefinition<"installation-new-permissions-accepted"> | WebhookEventDefinition<"installation-suspend"> | WebhookEventDefinition<"installation-unsuspend">;
|
||||
installation_repositories: WebhookEventDefinition<"installation-repositories-added"> | WebhookEventDefinition<"installation-repositories-removed">;
|
||||
installation_target: WebhookEventDefinition<"installation-target-renamed">;
|
||||
issue_comment: WebhookEventDefinition<"issue-comment-created"> | WebhookEventDefinition<"issue-comment-deleted"> | WebhookEventDefinition<"issue-comment-edited">;
|
||||
issue_dependencies: WebhookEventDefinition<"issue-dependencies-blocked-by-added"> | WebhookEventDefinition<"issue-dependencies-blocked-by-removed"> | WebhookEventDefinition<"issue-dependencies-blocking-added"> | WebhookEventDefinition<"issue-dependencies-blocking-removed">;
|
||||
issues: WebhookEventDefinition<"issues-assigned"> | WebhookEventDefinition<"issues-closed"> | WebhookEventDefinition<"issues-deleted"> | WebhookEventDefinition<"issues-demilestoned"> | WebhookEventDefinition<"issues-edited"> | WebhookEventDefinition<"issues-labeled"> | WebhookEventDefinition<"issues-locked"> | WebhookEventDefinition<"issues-milestoned"> | WebhookEventDefinition<"issues-opened"> | WebhookEventDefinition<"issues-pinned"> | WebhookEventDefinition<"issues-reopened"> | WebhookEventDefinition<"issues-transferred"> | WebhookEventDefinition<"issues-typed"> | WebhookEventDefinition<"issues-unassigned"> | WebhookEventDefinition<"issues-unlabeled"> | WebhookEventDefinition<"issues-unlocked"> | WebhookEventDefinition<"issues-unpinned"> | WebhookEventDefinition<"issues-untyped">;
|
||||
label: WebhookEventDefinition<"label-created"> | WebhookEventDefinition<"label-deleted"> | WebhookEventDefinition<"label-edited">;
|
||||
marketplace_purchase: WebhookEventDefinition<"marketplace-purchase-cancelled"> | WebhookEventDefinition<"marketplace-purchase-changed"> | WebhookEventDefinition<"marketplace-purchase-pending-change"> | WebhookEventDefinition<"marketplace-purchase-pending-change-cancelled"> | WebhookEventDefinition<"marketplace-purchase-purchased">;
|
||||
member: WebhookEventDefinition<"member-added"> | WebhookEventDefinition<"member-edited"> | WebhookEventDefinition<"member-removed">;
|
||||
membership: WebhookEventDefinition<"membership-added"> | WebhookEventDefinition<"membership-removed">;
|
||||
merge_group: WebhookEventDefinition<"merge-group-checks-requested"> | WebhookEventDefinition<"merge-group-destroyed">;
|
||||
meta: WebhookEventDefinition<"meta-deleted">;
|
||||
milestone: WebhookEventDefinition<"milestone-closed"> | WebhookEventDefinition<"milestone-created"> | WebhookEventDefinition<"milestone-deleted"> | WebhookEventDefinition<"milestone-edited"> | WebhookEventDefinition<"milestone-opened">;
|
||||
org_block: WebhookEventDefinition<"org-block-blocked"> | WebhookEventDefinition<"org-block-unblocked">;
|
||||
organization: WebhookEventDefinition<"organization-deleted"> | WebhookEventDefinition<"organization-member-added"> | WebhookEventDefinition<"organization-member-invited"> | WebhookEventDefinition<"organization-member-removed"> | WebhookEventDefinition<"organization-renamed">;
|
||||
package: WebhookEventDefinition<"package-published"> | WebhookEventDefinition<"package-updated">;
|
||||
page_build: WebhookEventDefinition<"page-build">;
|
||||
personal_access_token_request: WebhookEventDefinition<"personal-access-token-request-approved"> | WebhookEventDefinition<"personal-access-token-request-cancelled"> | WebhookEventDefinition<"personal-access-token-request-created"> | WebhookEventDefinition<"personal-access-token-request-denied">;
|
||||
ping: WebhookEventDefinition<"ping">;
|
||||
project_card: WebhookEventDefinition<"project-card-converted"> | WebhookEventDefinition<"project-card-created"> | WebhookEventDefinition<"project-card-deleted"> | WebhookEventDefinition<"project-card-edited"> | WebhookEventDefinition<"project-card-moved">;
|
||||
project: WebhookEventDefinition<"project-closed"> | WebhookEventDefinition<"project-created"> | WebhookEventDefinition<"project-deleted"> | WebhookEventDefinition<"project-edited"> | WebhookEventDefinition<"project-reopened">;
|
||||
project_column: WebhookEventDefinition<"project-column-created"> | WebhookEventDefinition<"project-column-deleted"> | WebhookEventDefinition<"project-column-edited"> | WebhookEventDefinition<"project-column-moved">;
|
||||
projects_v2: WebhookEventDefinition<"projects-v2-closed"> | WebhookEventDefinition<"projects-v2-created"> | WebhookEventDefinition<"projects-v2-deleted"> | WebhookEventDefinition<"projects-v2-edited"> | WebhookEventDefinition<"projects-v2-reopened">;
|
||||
projects_v2_item: WebhookEventDefinition<"projects-v2-item-archived"> | WebhookEventDefinition<"projects-v2-item-converted"> | WebhookEventDefinition<"projects-v2-item-created"> | WebhookEventDefinition<"projects-v2-item-deleted"> | WebhookEventDefinition<"projects-v2-item-edited"> | WebhookEventDefinition<"projects-v2-item-reordered"> | WebhookEventDefinition<"projects-v2-item-restored">;
|
||||
projects_v2_status_update: WebhookEventDefinition<"projects-v2-status-update-created"> | WebhookEventDefinition<"projects-v2-status-update-deleted"> | WebhookEventDefinition<"projects-v2-status-update-edited">;
|
||||
public: WebhookEventDefinition<"public">;
|
||||
pull_request: WebhookEventDefinition<"pull-request-assigned"> | WebhookEventDefinition<"pull-request-auto-merge-disabled"> | WebhookEventDefinition<"pull-request-auto-merge-enabled"> | WebhookEventDefinition<"pull-request-closed"> | WebhookEventDefinition<"pull-request-converted-to-draft"> | WebhookEventDefinition<"pull-request-demilestoned"> | WebhookEventDefinition<"pull-request-dequeued"> | WebhookEventDefinition<"pull-request-edited"> | WebhookEventDefinition<"pull-request-enqueued"> | WebhookEventDefinition<"pull-request-labeled"> | WebhookEventDefinition<"pull-request-locked"> | WebhookEventDefinition<"pull-request-milestoned"> | WebhookEventDefinition<"pull-request-opened"> | WebhookEventDefinition<"pull-request-ready-for-review"> | WebhookEventDefinition<"pull-request-reopened"> | WebhookEventDefinition<"pull-request-review-request-removed"> | WebhookEventDefinition<"pull-request-review-requested"> | WebhookEventDefinition<"pull-request-synchronize"> | WebhookEventDefinition<"pull-request-unassigned"> | WebhookEventDefinition<"pull-request-unlabeled"> | WebhookEventDefinition<"pull-request-unlocked">;
|
||||
pull_request_review_comment: WebhookEventDefinition<"pull-request-review-comment-created"> | WebhookEventDefinition<"pull-request-review-comment-deleted"> | WebhookEventDefinition<"pull-request-review-comment-edited">;
|
||||
pull_request_review: WebhookEventDefinition<"pull-request-review-dismissed"> | WebhookEventDefinition<"pull-request-review-edited"> | WebhookEventDefinition<"pull-request-review-submitted">;
|
||||
pull_request_review_thread: WebhookEventDefinition<"pull-request-review-thread-resolved"> | WebhookEventDefinition<"pull-request-review-thread-unresolved">;
|
||||
push: WebhookEventDefinition<"push">;
|
||||
registry_package: WebhookEventDefinition<"registry-package-published"> | WebhookEventDefinition<"registry-package-updated">;
|
||||
release: WebhookEventDefinition<"release-created"> | WebhookEventDefinition<"release-deleted"> | WebhookEventDefinition<"release-edited"> | WebhookEventDefinition<"release-prereleased"> | WebhookEventDefinition<"release-published"> | WebhookEventDefinition<"release-released"> | WebhookEventDefinition<"release-unpublished">;
|
||||
repository_advisory: WebhookEventDefinition<"repository-advisory-published"> | WebhookEventDefinition<"repository-advisory-reported">;
|
||||
repository: WebhookEventDefinition<"repository-archived"> | WebhookEventDefinition<"repository-created"> | WebhookEventDefinition<"repository-deleted"> | WebhookEventDefinition<"repository-edited"> | WebhookEventDefinition<"repository-privatized"> | WebhookEventDefinition<"repository-publicized"> | WebhookEventDefinition<"repository-renamed"> | WebhookEventDefinition<"repository-transferred"> | WebhookEventDefinition<"repository-unarchived">;
|
||||
repository_dispatch: WebhookEventDefinition<"repository-dispatch-sample.collected">;
|
||||
repository_import: WebhookEventDefinition<"repository-import">;
|
||||
repository_ruleset: WebhookEventDefinition<"repository-ruleset-created"> | WebhookEventDefinition<"repository-ruleset-deleted"> | WebhookEventDefinition<"repository-ruleset-edited">;
|
||||
repository_vulnerability_alert: WebhookEventDefinition<"repository-vulnerability-alert-create"> | WebhookEventDefinition<"repository-vulnerability-alert-dismiss"> | WebhookEventDefinition<"repository-vulnerability-alert-reopen"> | WebhookEventDefinition<"repository-vulnerability-alert-resolve">;
|
||||
secret_scanning_alert: WebhookEventDefinition<"secret-scanning-alert-assigned"> | WebhookEventDefinition<"secret-scanning-alert-created"> | WebhookEventDefinition<"secret-scanning-alert-publicly-leaked"> | WebhookEventDefinition<"secret-scanning-alert-reopened"> | WebhookEventDefinition<"secret-scanning-alert-resolved"> | WebhookEventDefinition<"secret-scanning-alert-unassigned"> | WebhookEventDefinition<"secret-scanning-alert-validated">;
|
||||
secret_scanning_alert_location: WebhookEventDefinition<"secret-scanning-alert-location-created">;
|
||||
secret_scanning_scan: WebhookEventDefinition<"secret-scanning-scan-completed">;
|
||||
security_advisory: WebhookEventDefinition<"security-advisory-published"> | WebhookEventDefinition<"security-advisory-updated"> | WebhookEventDefinition<"security-advisory-withdrawn">;
|
||||
security_and_analysis: WebhookEventDefinition<"security-and-analysis">;
|
||||
sponsorship: WebhookEventDefinition<"sponsorship-cancelled"> | WebhookEventDefinition<"sponsorship-created"> | WebhookEventDefinition<"sponsorship-edited"> | WebhookEventDefinition<"sponsorship-pending-cancellation"> | WebhookEventDefinition<"sponsorship-pending-tier-change"> | WebhookEventDefinition<"sponsorship-tier-changed">;
|
||||
star: WebhookEventDefinition<"star-created"> | WebhookEventDefinition<"star-deleted">;
|
||||
status: WebhookEventDefinition<"status">;
|
||||
sub_issues: WebhookEventDefinition<"sub-issues-parent-issue-added"> | WebhookEventDefinition<"sub-issues-parent-issue-removed"> | WebhookEventDefinition<"sub-issues-sub-issue-added"> | WebhookEventDefinition<"sub-issues-sub-issue-removed">;
|
||||
team_add: WebhookEventDefinition<"team-add">;
|
||||
team: WebhookEventDefinition<"team-added-to-repository"> | WebhookEventDefinition<"team-created"> | WebhookEventDefinition<"team-deleted"> | WebhookEventDefinition<"team-edited"> | WebhookEventDefinition<"team-removed-from-repository">;
|
||||
watch: WebhookEventDefinition<"watch-started">;
|
||||
workflow_dispatch: WebhookEventDefinition<"workflow-dispatch">;
|
||||
workflow_job: WebhookEventDefinition<"workflow-job-completed"> | WebhookEventDefinition<"workflow-job-in-progress"> | WebhookEventDefinition<"workflow-job-queued"> | WebhookEventDefinition<"workflow-job-waiting">;
|
||||
workflow_run: WebhookEventDefinition<"workflow-run-completed"> | WebhookEventDefinition<"workflow-run-in-progress"> | WebhookEventDefinition<"workflow-run-requested">;
|
||||
};
|
||||
export type WebhookEventName = keyof EventPayloadMap;
|
||||
1
node_modules/@octokit/webhooks/dist-types/generated/webhook-names.d.ts
generated
vendored
Normal file
1
node_modules/@octokit/webhooks/dist-types/generated/webhook-names.d.ts
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
20
node_modules/@octokit/webhooks/dist-types/index.d.ts
generated
vendored
Normal file
20
node_modules/@octokit/webhooks/dist-types/index.d.ts
generated
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
import { createEventHandler } from "./event-handler/index.ts";
|
||||
import { validateEventName } from "./event-handler/validate-event-name.ts";
|
||||
import type { EmitterWebhookEvent, EmitterWebhookEventName, HandlerFunction, RemoveHandlerFunction, Options, WebhookError, WebhookEventHandlerError, EmitterWebhookEventWithStringPayloadAndSignature } from "./types.ts";
|
||||
export { createNodeMiddleware } from "./middleware/node/index.ts";
|
||||
export { createWebMiddleware } from "./middleware/web/index.ts";
|
||||
export { emitterEventNames } from "./generated/webhook-names.ts";
|
||||
declare class Webhooks<TTransformed = unknown> {
|
||||
sign: (payload: string) => Promise<string>;
|
||||
verify: (eventPayload: string, signature: string) => Promise<boolean>;
|
||||
on: <E extends EmitterWebhookEventName>(event: E | E[], callback: HandlerFunction<E, TTransformed>) => void;
|
||||
onAny: (callback: (event: TTransformed extends unknown ? EmitterWebhookEvent : EmitterWebhookEvent & TTransformed) => any) => void;
|
||||
onError: (callback: (event: WebhookEventHandlerError<TTransformed>) => any) => void;
|
||||
removeListener: <E extends EmitterWebhookEventName | "*">(event: E | E[], callback: RemoveHandlerFunction<E, TTransformed>) => void;
|
||||
receive: (event: EmitterWebhookEvent) => Promise<void>;
|
||||
verifyAndReceive: (options: EmitterWebhookEventWithStringPayloadAndSignature) => Promise<void>;
|
||||
constructor(options: Options<TTransformed> & {
|
||||
secret: string;
|
||||
});
|
||||
}
|
||||
export { createEventHandler, validateEventName, Webhooks, type EmitterWebhookEvent, type EmitterWebhookEventName, type WebhookError, };
|
||||
11
node_modules/@octokit/webhooks/dist-types/middleware/create-middleware.d.ts
generated
vendored
Normal file
11
node_modules/@octokit/webhooks/dist-types/middleware/create-middleware.d.ts
generated
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
import type { Webhooks } from "../index.ts";
|
||||
import type { MiddlewareOptions } from "./types.ts";
|
||||
type CreateMiddlewareOptions = {
|
||||
handleResponse: (body: string | null, status?: number, headers?: Record<string, string>, response?: any) => any;
|
||||
getPayload: (request: Request) => Promise<string>;
|
||||
getRequestHeader: <T = string>(request: Request, key: string) => T;
|
||||
};
|
||||
type IncomingMessage = any;
|
||||
type ServerResponse = any;
|
||||
export declare function createMiddleware(options: CreateMiddlewareOptions): (webhooks: Webhooks, options: Required<MiddlewareOptions>) => (request: IncomingMessage, response?: ServerResponse, next?: Function) => Promise<any>;
|
||||
export {};
|
||||
4
node_modules/@octokit/webhooks/dist-types/middleware/node/get-payload.d.ts
generated
vendored
Normal file
4
node_modules/@octokit/webhooks/dist-types/middleware/node/get-payload.d.ts
generated
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
type IncomingMessage = any;
|
||||
export declare function getPayload(request: IncomingMessage): Promise<string>;
|
||||
export declare function getPayloadFromRequestStream(request: IncomingMessage): Promise<Uint8Array>;
|
||||
export {};
|
||||
1
node_modules/@octokit/webhooks/dist-types/middleware/node/get-request-header.d.ts
generated
vendored
Normal file
1
node_modules/@octokit/webhooks/dist-types/middleware/node/get-request-header.d.ts
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
export declare function getRequestHeader<T = string>(request: any, key: string): T;
|
||||
1
node_modules/@octokit/webhooks/dist-types/middleware/node/handle-response.d.ts
generated
vendored
Normal file
1
node_modules/@octokit/webhooks/dist-types/middleware/node/handle-response.d.ts
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
export declare function handleResponse(body: string | null, status?: number, headers?: Record<string, string>, response?: any): boolean;
|
||||
3
node_modules/@octokit/webhooks/dist-types/middleware/node/index.d.ts
generated
vendored
Normal file
3
node_modules/@octokit/webhooks/dist-types/middleware/node/index.d.ts
generated
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
import type { Webhooks } from "../../index.ts";
|
||||
import type { MiddlewareOptions } from "../types.ts";
|
||||
export declare function createNodeMiddleware(webhooks: Webhooks, { path, log, timeout, }?: MiddlewareOptions): (request: any, response?: any, next?: Function) => Promise<any>;
|
||||
6
node_modules/@octokit/webhooks/dist-types/middleware/types.d.ts
generated
vendored
Normal file
6
node_modules/@octokit/webhooks/dist-types/middleware/types.d.ts
generated
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
import type { Logger } from "../create-logger.ts";
|
||||
export type MiddlewareOptions = {
|
||||
timeout?: number;
|
||||
path?: string;
|
||||
log?: Logger;
|
||||
};
|
||||
1
node_modules/@octokit/webhooks/dist-types/middleware/web/get-payload.d.ts
generated
vendored
Normal file
1
node_modules/@octokit/webhooks/dist-types/middleware/web/get-payload.d.ts
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
export declare function getPayload(request: Request): Promise<string>;
|
||||
1
node_modules/@octokit/webhooks/dist-types/middleware/web/get-request-header.d.ts
generated
vendored
Normal file
1
node_modules/@octokit/webhooks/dist-types/middleware/web/get-request-header.d.ts
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
export declare function getRequestHeader<T = string>(request: Request, key: string): T;
|
||||
1
node_modules/@octokit/webhooks/dist-types/middleware/web/handle-response.d.ts
generated
vendored
Normal file
1
node_modules/@octokit/webhooks/dist-types/middleware/web/handle-response.d.ts
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
export declare function handleResponse(body: string | null, status?: number, headers?: Record<string, string>): import("undici-types").Response;
|
||||
3
node_modules/@octokit/webhooks/dist-types/middleware/web/index.d.ts
generated
vendored
Normal file
3
node_modules/@octokit/webhooks/dist-types/middleware/web/index.d.ts
generated
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
import type { Webhooks } from "../../index.ts";
|
||||
import type { MiddlewareOptions } from "../types.ts";
|
||||
export declare function createWebMiddleware(webhooks: Webhooks, { path, log, timeout, }?: MiddlewareOptions): (request: any, response?: any, next?: Function) => Promise<any>;
|
||||
1
node_modules/@octokit/webhooks/dist-types/normalize-trailing-slashes.d.ts
generated
vendored
Normal file
1
node_modules/@octokit/webhooks/dist-types/normalize-trailing-slashes.d.ts
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
export declare function normalizeTrailingSlashes(path: string): string;
|
||||
57
node_modules/@octokit/webhooks/dist-types/types.d.ts
generated
vendored
Normal file
57
node_modules/@octokit/webhooks/dist-types/types.d.ts
generated
vendored
Normal file
@@ -0,0 +1,57 @@
|
||||
import type { RequestError } from "@octokit/request-error";
|
||||
import type { webhooks as OpenAPIWebhooks } from "@octokit/openapi-webhooks-types";
|
||||
import type { EventPayloadMap } from "./generated/webhook-identifiers.ts";
|
||||
import type { Logger } from "./create-logger.ts";
|
||||
import type { EventHandler } from "./event-handler/index.ts";
|
||||
import type { emitterEventNames } from "./generated/webhook-names.ts";
|
||||
export type WebhookEventName = keyof EventPayloadMap;
|
||||
export type ExtractEvents<TEventName> = TEventName extends `${infer _TWebhookEvent}.${infer _TAction}` ? never : TEventName;
|
||||
export type WebhookEvents = ExtractEvents<EmitterWebhookEventName>;
|
||||
export type WebhookEventDefinition<TEventName extends keyof OpenAPIWebhooks> = OpenAPIWebhooks[TEventName]["post"]["requestBody"]["content"]["application/json"];
|
||||
export type EmitterWebhookEventName = (typeof emitterEventNames)[number];
|
||||
export type EmitterWebhookEvent<TEmitterEvent extends EmitterWebhookEventName = EmitterWebhookEventName> = TEmitterEvent extends `${infer TWebhookEvent}.${infer TAction}` ? BaseWebhookEvent<Extract<TWebhookEvent, WebhookEventName>> & {
|
||||
payload: {
|
||||
action: TAction;
|
||||
};
|
||||
} : BaseWebhookEvent<Extract<TEmitterEvent, WebhookEventName>>;
|
||||
export type EmitterWebhookEventWithStringPayloadAndSignature = {
|
||||
id: string;
|
||||
name: string;
|
||||
payload: string;
|
||||
signature: string;
|
||||
};
|
||||
interface BaseWebhookEvent<TName extends WebhookEventName> {
|
||||
id: string;
|
||||
name: TName;
|
||||
payload: EventPayloadMap[TName];
|
||||
}
|
||||
export interface Options<TTransformed = unknown> {
|
||||
secret?: string;
|
||||
additionalSecrets?: string[] | undefined;
|
||||
transform?: TransformMethod<TTransformed>;
|
||||
log?: Partial<Logger>;
|
||||
}
|
||||
type TransformMethod<T> = (event: EmitterWebhookEvent) => T | PromiseLike<T>;
|
||||
export type HandlerFunction<TName extends EmitterWebhookEventName, TTransformed = unknown> = (event: EmitterWebhookEvent<TName> & TTransformed) => any;
|
||||
export type RemoveHandlerFunction<TName extends EmitterWebhookEventName | "*", TTransformed = unknown> = (event: EmitterWebhookEvent<Exclude<TName, "*">> & TTransformed) => any;
|
||||
type Hooks = {
|
||||
[key: string]: Function[];
|
||||
};
|
||||
export interface State extends Options<any> {
|
||||
eventHandler?: EventHandler<unknown>;
|
||||
hooks: Hooks;
|
||||
log: Logger;
|
||||
}
|
||||
/**
|
||||
* Error object with optional properties coming from `octokit.request` errors
|
||||
*/
|
||||
export type WebhookError = Error & Partial<RequestError> & {
|
||||
event?: EmitterWebhookEventWithStringPayloadAndSignature | undefined;
|
||||
};
|
||||
export interface AggregateWebhookError extends AggregateError {
|
||||
errors: WebhookError[];
|
||||
}
|
||||
export interface WebhookEventHandlerError<TTransformed = unknown> extends AggregateWebhookError {
|
||||
event: TTransformed extends unknown ? EmitterWebhookEvent : EmitterWebhookEvent & TTransformed;
|
||||
}
|
||||
export {};
|
||||
6
node_modules/@octokit/webhooks/dist-types/verify-and-receive.d.ts
generated
vendored
Normal file
6
node_modules/@octokit/webhooks/dist-types/verify-and-receive.d.ts
generated
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
import type { EmitterWebhookEventWithStringPayloadAndSignature, State } from "./types.ts";
|
||||
import type { EventHandler } from "./event-handler/index.ts";
|
||||
export declare function verifyAndReceive(state: State & {
|
||||
secret: string;
|
||||
eventHandler: EventHandler<unknown>;
|
||||
}, event: EmitterWebhookEventWithStringPayloadAndSignature): Promise<void>;
|
||||
54
node_modules/@octokit/webhooks/package.json
generated
vendored
Normal file
54
node_modules/@octokit/webhooks/package.json
generated
vendored
Normal file
@@ -0,0 +1,54 @@
|
||||
{
|
||||
"name": "@octokit/webhooks",
|
||||
"version": "14.2.0",
|
||||
"description": "GitHub webhook events toolset for Node.js",
|
||||
"keywords": [],
|
||||
"repository": "github:octokit/webhooks.js",
|
||||
"license": "MIT",
|
||||
"author": "Gregor Martynus (https://twitter.com/gr2m)",
|
||||
"type": "module",
|
||||
"dependencies": {
|
||||
"@octokit/openapi-webhooks-types": "12.1.0",
|
||||
"@octokit/request-error": "^7.0.0",
|
||||
"@octokit/webhooks-methods": "^6.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@octokit/openapi-webhooks": "12.1.0",
|
||||
"@octokit/tsconfig": "^4.0.0",
|
||||
"@types/express": "^5.0.1",
|
||||
"@types/node": "^22.0.0",
|
||||
"@vitest/coverage-v8": "^4.0.0",
|
||||
"esbuild": "^0.25.0",
|
||||
"express": "^5.1.0",
|
||||
"get-port": "^7.1.0",
|
||||
"prettier": "3.6.2",
|
||||
"prettier-plugin-packagejson": "^2.2.9",
|
||||
"tsx": "^4.19.3",
|
||||
"typescript": "^5.0.0",
|
||||
"vitest": "^4.0.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 20"
|
||||
},
|
||||
"publishConfig": {
|
||||
"access": "public",
|
||||
"provenance": true
|
||||
},
|
||||
"files": [
|
||||
"dist-*/**",
|
||||
"bin/**"
|
||||
],
|
||||
"types": "dist-types/index.d.ts",
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./dist-types/index.d.ts",
|
||||
"import": "./dist-bundle/index.js",
|
||||
"default": "./dist-bundle/index.js"
|
||||
},
|
||||
"./types": {
|
||||
"types": "./dist-types/types.d.ts"
|
||||
}
|
||||
},
|
||||
"source": "dist-src/index.js",
|
||||
"sideEffects": false
|
||||
}
|
||||
Reference in New Issue
Block a user