@pinelab/vendure-plugin-webhook 0.0.3

package/dist/webhook.plugin.d.ts

@@ -0,0 +1,34 @@
+import { Type } from '@vendure/core';
+import { AdminUiExtension } from '@vendure/ui-devkit/compiler';
+import { EventWithContext, RequestTransformer } from './api/request-transformer';
+export interface WebhookPluginOptions {
+    /**
+     * The plugin will listen to these events and call the corresponding webhooks
+     */
+    events: Type<EventWithContext>[];
+    /**
+     * A list of available transformers to create custom body and headers for webhook requests
+     */
+    requestTransformers?: Array<RequestTransformer<Type<EventWithContext>[]>>;
+    /**
+     * Wait for more of the same events before calling webhook, and only call the configured webhook once.
+     * E.g: With `delay: 100` only 1 call to your webhook will be done,
+     * even if 10 of the same events are fired within 100ms.
+     *
+     * Delay is in ms
+     */
+    delay?: number;
+    /**
+     * Disable the plugin. Default is false
+     */
+    disabled?: boolean;
+}
+/**
+ * Calls a configurable webhook when configured events arise.
+ * 1 webhook per channel is configurable
+ */
+export declare class WebhookPlugin {
+    static options: WebhookPluginOptions;
+    static init(options: WebhookPluginOptions): typeof WebhookPlugin;
+    static ui: AdminUiExtension;
+}

package/dist/webhook.plugin.js

@@ -0,0 +1,73 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var WebhookPlugin_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookPlugin = void 0;
+const core_1 = require("@vendure/core");
+const path_1 = __importDefault(require("path"));
+const api_extension_1 = require("./api/api-extension");
+const webhook_resolver_1 = require("./api/webhook.resolver");
+const webhook_service_1 = require("./api/webhook.service");
+const constants_1 = require("./constants");
+const webhook_entity_1 = require("./api/webhook.entity");
+/**
+ * Calls a configurable webhook when configured events arise.
+ * 1 webhook per channel is configurable
+ */
+let WebhookPlugin = WebhookPlugin_1 = class WebhookPlugin {
+    static init(options) {
+        this.options = {
+            ...this.options,
+            ...options,
+        };
+        return WebhookPlugin_1;
+    }
+};
+WebhookPlugin.options = {
+    events: [],
+    delay: 0,
+};
+WebhookPlugin.ui = {
+    extensionPath: path_1.default.join(__dirname, 'ui'),
+    ngModules: [
+        {
+            type: 'lazy',
+            route: 'webhook',
+            ngModuleFileName: 'webhook.module.ts',
+            ngModuleName: 'WebhookModule',
+        },
+        {
+            type: 'shared',
+            ngModuleFileName: 'webhook-nav.module.ts',
+            ngModuleName: 'WebhookNavModule',
+        },
+    ],
+};
+WebhookPlugin = WebhookPlugin_1 = __decorate([
+    (0, core_1.VendurePlugin)({
+        imports: [core_1.PluginCommonModule],
+        entities: [webhook_entity_1.Webhook],
+        providers: [
+            webhook_service_1.WebhookService,
+            { provide: constants_1.PLUGIN_INIT_OPTIONS, useFactory: () => WebhookPlugin_1.options },
+        ],
+        adminApiExtensions: {
+            schema: api_extension_1.adminSchema,
+            resolvers: [webhook_resolver_1.WebhookResolver, webhook_resolver_1.WebhookRequestTransformerResolver],
+        },
+        configuration: (config) => {
+            config.authOptions.customPermissions.push(webhook_resolver_1.webhookPermission);
+            return config;
+        },
+        compatibility: '^2.0.0',
+    })
+], WebhookPlugin);
+exports.WebhookPlugin = WebhookPlugin;

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@pinelab/vendure-plugin-webhook",
+  "version": "0.0.3",
+  "description": "Call webhooks based on configured events from Vendure",
+  "author": "Martijn van de Brug <martijn@pinelab.studio>",
+  "homepage": "https://pinelab-plugins.com/",
+  "repository": "https://github.com/Pinelab-studio/pinelab-vendure-plugins",
+  "license": "MIT",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "yarn graphql-codegen && rimraf dist && tsc && copyfiles -u 1 'src/ui/**/*' dist/",
+    "start": "yarn ts-node test/dev-server.ts",
+    "test": "vitest run"
+  },
+  "devDependencies": {
+    "@graphql-codegen/cli": "^3.3.1",
+    "@graphql-codegen/typescript": "^3.0.4",
+    "@graphql-codegen/typescript-document-nodes": "^3.0.4",
+    "@graphql-codegen/typescript-operations": "^3.0.4",
+    "@swc/core": "^1.3.61",
+    "@vendure/admin-ui-plugin": "2.0.4",
+    "@vendure/core": "2.0.4",
+    "@vendure/testing": "2.0.4",
+    "@vendure/ui-devkit": "2.0.4",
+    "copyfiles": "^2.4.1",
+    "nock": "^13.2.9",
+    "rimraf": "^3.0.2",
+    "ts-node": "^10.7.0",
+    "typescript": "4.9.5",
+    "unplugin-swc": "^1.3.2",
+    "vitest": "^0.31.1"
+  },
+  "gitHead": "5673faf91c029dc4716226965ce3531931b434b6"
+}