@pinelab/vendure-plugin-webhook 1.3.0 → 1.4.1

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 1.4.1 (2025-02-06)
+
+- Log info message when event is ignored because transformer returned 'false'
+
+# 1.4.0 (2025-02-06)
+
+- Allow cancelling webhook by returning `false` in request transformers
+- Fixed union type inference from events array in transformer
+
+# 1.3.1 (2025-01-28)
+
+- Correct UI label for actions dropdown
+
 # 1.3.0 (2024-12-19)
 
 - Update Vendure to 3.1.1

package/README.md

@@ -67,24 +67,20 @@ export const stringifyProductTransformer = new RequestTransformer({
   name: 'Stringify Product events',
   supportedEvents: [ProductEvent],
   transform: (event, injector, webhook) => {
-    if (event instanceof ProductEvent) {
-      return {
-        body: JSON.stringify({
-          type: webhook.event, // Name of the event ("ProductEvent")
-          event: {
-            ...event,
-            ctx: undefined, // Remove ctx or use event.ctx.serialize()
-          },
-        }),
-        headers: {
-          authorization: 'Bearer MyToken',
-          'x-custom-header': 'custom-example-header',
-          'content-type': 'application/json',
+    return {
+      body: JSON.stringify({
+        type: webhook.event, // Name of the event ("ProductEvent")
+        event: {
+          ...event,
+          ctx: undefined, // Remove ctx or use event.ctx.serialize()
         },
-      };
-    } else {
-      throw Error(`This transformer is only for ProductEvents!`);
-    }
+      }),
+      headers: {
+        authorization: 'Bearer MyToken',
+        'x-custom-header': 'custom-example-header',
+        'content-type': 'application/json',
+      },
+    };
   },
 });
 

package/dist/api/request-transformer.d.ts

@@ -1,6 +1,6 @@
 import { Injector, RequestContext, Type, VendureEvent } from '@vendure/core';
 import { Webhook } from './webhook.entity';
-export type TransformFn<T extends EventWithContext> = (event: T, injector: Injector, webhook: Webhook) => WebhookRequest | Promise<WebhookRequest>;
+export type TransformFn<T extends EventWithContext> = (event: T, injector: Injector, webhook: Webhook) => WebhookRequest | Promise<WebhookRequest> | false | Promise<false>;
 export type EventWithContext = VendureEvent & {
     ctx: RequestContext;
 };
@@ -12,13 +12,17 @@ export declare class RequestTransformer<T extends Array<Type<EventWithContext>>>
     private readonly options;
     readonly name: string;
     readonly supportedEvents: T;
-    readonly transform: TransformFn<EventWithContext>;
+    readonly transform: TransformFn<InstanceType<T[number]>>;
     constructor(options: {
         name: string;
         /**
          * The events that this transformer supports
          */
         supportedEvents: T;
-        transform: TransformFn<EventWithContext>;
+        /**
+         * Transform the body and/or headers for the webhook request.
+         * When returning `false`, the webhook will not be called.
+         */
+        transform: TransformFn<InstanceType<T[number]>>;
     });
 }

package/dist/api/request-transformer.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RequestTransformer = void 0;
+const core_1 = require("@vendure/core");
 class RequestTransformer {
     constructor(options) {
         this.options = options;
@@ -10,3 +11,11 @@ class RequestTransformer {
     }
 }
 exports.RequestTransformer = RequestTransformer;
+// This only exists to test TS type compilation for this plugin, because of the complex type inference above
+new RequestTransformer({
+    name: 'Stringify Product events',
+    supportedEvents: [core_1.ProductEvent, core_1.ProductVariantEvent],
+    transform: (event, injector) => {
+        return {};
+    },
+});

package/dist/api/webhook.service.js

@@ -163,6 +163,11 @@ let WebhookService = class WebhookService {
             throw Error(`Could not find transformer ${webhook.transformerName}`);
         }
         const request = await transformer.transform(event, new core_2.Injector(this.moduleRef), webhook);
+        if (request === false) {
+            // Don't call webhook if transformer returns false
+            core_2.Logger.info(`Ignoring event ${event.constructor.name} for channel ${webhook.channelId} because transformer "${webhook.transformerName}" returned false`, constants_1.loggerCtx);
+            return;
+        }
         // Call the webhook with the constructed request
         try {
             await (0, node_fetch_1.default)(webhook.url, {

package/dist/ui/webhook.component.html

@@ -98,7 +98,7 @@
       <td>
         <vdr-dropdown>
           <button type="button" class="btn btn-link btn-sm" vdrDropdownTrigger>
-            {{ 'common.actions' | translate }}
+            {{ 'marketing.actions' | translate }}
             <clr-icon shape="caret down"></clr-icon>
           </button>
           <vdr-dropdown-menu vdrPosition="bottom-right">
@@ -117,7 +117,7 @@
               vdrDropdownItem
             >
               <clr-icon shape="copy"></clr-icon>
-              Duplicate
+              {{ 'common.duplicate' | translate }}
             </button>
           </vdr-dropdown-menu>
         </vdr-dropdown>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pinelab/vendure-plugin-webhook",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "description": "Call webhooks based on configured events from Vendure",
   "author": "Martijn van de Brug <martijn@pinelab.studio>",
   "homepage": "https://pinelab-plugins.com/",
@@ -23,5 +23,5 @@
     "test": "vitest run",
     "lint": "echo 'No linting configured'"
   },
-  "gitHead": "9c5bcd59af3ebeb3287084e495d7c5c359cf5d40"
+  "gitHead": "70f5ad2f67926c28dc1179474c3973a61de4022b"
 }