@invect/webhooks 0.0.1 → 0.0.3

package/README.md

@@ -0,0 +1,79 @@
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="../../../.github/assets/logo-light.svg">
+    <img alt="Invect" src="../../../.github/assets/logo-dark.svg" width="50">
+  </picture>
+</p>
+
+<h1 align="center">@invect/webhooks</h1>
+
+<p align="center">
+  Webhook trigger plugin for Invect.
+  <br />
+  <a href="https://invect.dev/docs/plugins"><strong>Docs</strong></a>
+</p>
+
+---
+
+Adds webhook management, ingestion, signature verification, and rate limiting to Invect. Create webhook endpoints that trigger flow runs when external services send events.
+
+## Install
+
+```bash
+pnpm add @invect/webhooks
+```
+
+## Backend
+
+```ts
+import { webhooksPlugin } from '@invect/webhooks';
+
+const invectRouter = await createInvectRouter({
+  database: { type: 'sqlite', connectionString: 'file:./dev.db' },
+  encryptionKey: process.env.INVECT_ENCRYPTION_KEY!,
+  plugins: [webhooksPlugin()],
+});
+
+app.use('/invect', invectRouter);
+```
+
+### Options
+
+```ts
+webhooksPlugin({
+  webhookBaseUrl: 'https://example.com/api/invect', // Base URL for webhook endpoints
+  rateLimitMaxRequests: 60, // Max requests per window (default: 60)
+  rateLimitWindowMs: 60_000, // Rate limit window in ms (default: 60s)
+  dedupTtlMs: 86_400_000, // Deduplication TTL in ms (default: 24h)
+});
+```
+
+## Frontend
+
+```tsx
+import { Invect } from '@invect/ui';
+import { webhooksFrontendPlugin } from '@invect/webhooks/ui';
+
+<Invect apiBaseUrl="/api/invect" plugins={[webhooksFrontendPlugin]} />;
+```
+
+The plugin adds a Webhooks page to the sidebar for managing webhook triggers.
+
+## Features
+
+- **Signature verification** — HMAC validation for GitHub, GitLab, Slack, and generic providers.
+- **Rate limiting** — Per-IP/path rate limiting with configurable windows.
+- **Deduplication** — Idempotency via event deduplication (24h TTL default).
+- **IP allowlisting** — Restrict webhook sources by IP address.
+
+## Exports
+
+| Entry Point              | Content                                                    |
+| ------------------------ | ---------------------------------------------------------- |
+| `@invect/webhooks`       | Backend plugin (Node.js)                                   |
+| `@invect/webhooks/ui`    | Frontend plugin — `webhooksFrontendPlugin`, `WebhooksPage` |
+| `@invect/webhooks/types` | Shared types                                               |
+
+## License
+
+[MIT](../../../LICENSE)

package/dist/backend/index.cjs

@@ -3264,7 +3264,16 @@ function generateWebhookPath() {
 	for (let i = 0; i < 24; i++) path += chars[Math.floor(Math.random() * 36)];
 	return path;
 }
-function webhooksPlugin(options) {
+function webhooks(options) {
+	const { frontend, ...backendOptions } = options ?? {};
+	return {
+		id: "webhooks",
+		name: "Webhooks",
+		backend: _webhooksBackendPlugin(backendOptions),
+		frontend
+	};
+}
+function _webhooksBackendPlugin(options) {
 	let state = null;
 	function createEndpoints() {
 		return [
@@ -3490,7 +3499,7 @@ function webhooksPlugin(options) {
 				state = null;
 			}
 		},
-		setupInstructions: "Run `npx invect generate` to generate the webhook_triggers table schema, then `npx invect migrate` to apply it."
+		setupInstructions: "Run `npx invect-cli generate` to generate the webhook_triggers table schema, then `npx invect-cli migrate` to apply it."
 	};
 }
 //#endregion
@@ -3498,6 +3507,6 @@ exports.WEBHOOK_PROVIDER_SIGNATURES = WEBHOOK_PROVIDER_SIGNATURES;
 exports.WebhookDedupService = WebhookDedupService;
 exports.WebhookRateLimiter = WebhookRateLimiter;
 exports.WebhookSignatureService = WebhookSignatureService;
-exports.webhooksPlugin = webhooksPlugin;
+exports.webhooks = webhooks;
 
 //# sourceMappingURL=index.cjs.map