@awell-health/awell-extensions 2.0.292 → 2.0.293

package/dist/extensions/freshdesk/webhooks/TicketCreated/__testdata__/ticketCreated.mock.d.ts

@@ -1 +1,5 @@
-export declare const ticketCreatedPayload: {};
+export declare const ticketCreatedPayload: {
+    freshdesk_webhook: {
+        ticket_id: string;
+    };
+};

package/dist/extensions/freshdesk/webhooks/TicketCreated/__testdata__/ticketCreated.mock.js

@@ -1,5 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ticketCreatedPayload = void 0;
-exports.ticketCreatedPayload = {};
+exports.ticketCreatedPayload = {
+    freshdesk_webhook: {
+        ticket_id: '295186',
+    },
+};
 //# sourceMappingURL=ticketCreated.mock.js.map

package/dist/extensions/freshdesk/webhooks/TicketCreated/__testdata__/ticketCreated.mock.js.map

@@ -1 +1 @@
-{"version":3,"file":"ticketCreated.mock.js","sourceRoot":"","sources":["../../../../../../extensions/freshdesk/webhooks/TicketCreated/__testdata__/ticketCreated.mock.ts"],"names":[],"mappings":";;;AAEa,QAAA,oBAAoB,GAAG,EAAwC,CAAA"}
+{"version":3,"file":"ticketCreated.mock.js","sourceRoot":"","sources":["../../../../../../extensions/freshdesk/webhooks/TicketCreated/__testdata__/ticketCreated.mock.ts"],"names":[],"mappings":";;;AAEa,QAAA,oBAAoB,GAAG;IAClC,iBAAiB,EAAE;QACjB,SAAS,EAAE,QAAQ;KACpB;CACoC,CAAA"}

package/dist/extensions/freshdesk/webhooks/TicketCreated/ticketCreated.d.ts

@@ -1,7 +1,12 @@
 import { type Webhook } from '@awell-health/extensions-core';
 import { type settings } from '../../settings';
 import { type TicketCreatedWebhookPayload } from './types';
-declare const dataPoints: {};
+declare const dataPoints: {
+    ticketId: {
+        key: string;
+        valueType: "string";
+    };
+};
 export declare const ticketCreated: Webhook<keyof typeof dataPoints, TicketCreatedWebhookPayload, typeof settings>;
 export type TicketCreated = typeof ticketCreated;
 export {};

package/dist/extensions/freshdesk/webhooks/TicketCreated/ticketCreated.js

@@ -1,13 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ticketCreated = void 0;
-const dataPoints = {};
+const types_1 = require("./types");
+const dataPoints = {
+    ticketId: {
+        key: 'ticketId',
+        valueType: 'string',
+    },
+};
 exports.ticketCreated = {
     key: 'ticketCreated',
     dataPoints,
     onEvent: async ({ payload: { payload, rawBody, headers, settings }, onSuccess, onError, }) => {
+        const parsedPayload = types_1.zTicketCreatedWebhookPayload.safeParse(payload);
+        if (!parsedPayload.success) {
+            await onError({
+                response: {
+                    statusCode: 400,
+                    message: JSON.stringify(parsedPayload.error, null, 2),
+                },
+            });
+            return;
+        }
         await onSuccess({
-            data_points: {},
+            data_points: {
+                ticketId: parsedPayload.data.freshdesk_webhook.ticket_id,
+            },
         });
     },
 };

package/dist/extensions/freshdesk/webhooks/TicketCreated/ticketCreated.js.map

@@ -1 +1 @@
-{"version":3,"file":"ticketCreated.js","sourceRoot":"","sources":["../../../../../extensions/freshdesk/webhooks/TicketCreated/ticketCreated.ts"],"names":[],"mappings":";;;AAOA,MAAM,UAAU,GAAG,EAAgD,CAAA;AAEtD,QAAA,aAAa,GAItB;IACF,GAAG,EAAE,eAAe;IACpB,UAAU;IACV,OAAO,EAAE,KAAK,EAAE,EACd,OAAO,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,EAChD,SAAS,EACT,OAAO,GACR,EAAE,EAAE;QACH,MAAM,SAAS,CAAC;YACd,WAAW,EAAE,EAAE;SAChB,CAAC,CAAA;IACJ,CAAC;CACF,CAAA"}
+{"version":3,"file":"ticketCreated.js","sourceRoot":"","sources":["../../../../../extensions/freshdesk/webhooks/TicketCreated/ticketCreated.ts"],"names":[],"mappings":";;;AAMA,mCAAsD;AAEtD,MAAM,UAAU,GAAG;IACjB,QAAQ,EAAE;QACR,GAAG,EAAE,UAAU;QACf,SAAS,EAAE,QAAQ;KACpB;CAC4C,CAAA;AAElC,QAAA,aAAa,GAItB;IACF,GAAG,EAAE,eAAe;IACpB,UAAU;IACV,OAAO,EAAE,KAAK,EAAE,EACd,OAAO,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,EAChD,SAAS,EACT,OAAO,GACR,EAAE,EAAE;QACH,MAAM,aAAa,GAAG,oCAA4B,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;QAErE,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;YAC3B,MAAM,OAAO,CAAC;gBACZ,QAAQ,EAAE;oBACR,UAAU,EAAE,GAAG;oBACf,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;iBACtD;aACF,CAAC,CAAA;YACF,OAAM;QACR,CAAC;QAED,MAAM,SAAS,CAAC;YACd,WAAW,EAAE;gBACX,QAAQ,EAAE,aAAa,CAAC,IAAI,CAAC,iBAAiB,CAAC,SAAS;aACzD;SACF,CAAC,CAAA;IACJ,CAAC;CACF,CAAA"}

package/dist/extensions/freshdesk/webhooks/TicketCreated/types.d.ts

@@ -1,3 +1,4 @@
+import { z } from 'zod';
 /**
  * Problem:
  * Freshdesk allows their users to define a custom webhook payload.
@@ -13,4 +14,21 @@
  *
  * See https://support.freshdesk.com/support/solutions/articles/132589-using-webhooks-in-automation-rules
  */
-export type TicketCreatedWebhookPayload = Record<string, unknown>;
+export declare const zTicketCreatedWebhookPayload: z.ZodObject<{
+    freshdesk_webhook: z.ZodObject<{
+        ticket_id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        ticket_id: string;
+    }, {
+        ticket_id: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    freshdesk_webhook: {
+        ticket_id: string;
+    };
+}, {
+    freshdesk_webhook: {
+        ticket_id: string;
+    };
+}>;
+export type TicketCreatedWebhookPayload = z.infer<typeof zTicketCreatedWebhookPayload>;

package/dist/extensions/freshdesk/webhooks/TicketCreated/types.js

@@ -1,3 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.zTicketCreatedWebhookPayload = void 0;
+const zod_1 = require("zod");
+/**
+ * Problem:
+ * Freshdesk allows their users to define a custom webhook payload.
+ * This means there's no "standard" webhook payload and it's not possible to define a "standard" schema for it.
+ *
+ * Alternative 1:
+ * If a customer wants to use a webhook-based integration with Freshdesk, we register the webhook
+ * in a private extension and define a custom contract/schema together with the customer and use that instead.
+ *
+ * Alternative 2:
+ * We try to define a schema for the webhook payload that is flexible enough to handle all possible payloads.
+ * Haven't attempted this yet.
+ *
+ * See https://support.freshdesk.com/support/solutions/articles/132589-using-webhooks-in-automation-rules
+ */
+exports.zTicketCreatedWebhookPayload = zod_1.z.object({
+    freshdesk_webhook: zod_1.z.object({
+        ticket_id: zod_1.z.string(),
+    }),
+});
 //# sourceMappingURL=types.js.map

package/dist/extensions/freshdesk/webhooks/TicketCreated/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../extensions/freshdesk/webhooks/TicketCreated/types.ts"],"names":[],"mappings":""}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../extensions/freshdesk/webhooks/TicketCreated/types.ts"],"names":[],"mappings":";;;AAAA,6BAAuB;AAEvB;;;;;;;;;;;;;;GAcG;AAEU,QAAA,4BAA4B,GAAG,OAAC,CAAC,MAAM,CAAC;IACnD,iBAAiB,EAAE,OAAC,CAAC,MAAM,CAAC;QAC1B,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;KACtB,CAAC;CACH,CAAC,CAAA"}

package/dist/extensions/freshdesk/webhooks/index.d.ts

@@ -1,4 +1,8 @@
-export declare const webhooks: import("@awell-health/extensions-core").Webhook<never, import("./TicketCreated/types").TicketCreatedWebhookPayload, {
+export declare const webhooks: import("@awell-health/extensions-core").Webhook<"ticketId", {
+    freshdesk_webhook: {
+        ticket_id: string;
+    };
+}, {
     domain: {
         key: string;
         label: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awell-health/awell-extensions",
-  "version": "2.0.292",
+  "version": "2.0.293",
   "packageManager": "yarn@4.5.3",
   "main": "dist/src/index.js",
   "repository": {