pathao-merchant-sdk 2.0.2 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,193 @@
1
+ 'use strict';
2
+
3
+ var events = require('events');
4
+
5
+ // src/webhooks.ts
6
+ var PathaoWebhookError = class extends Error {
7
+ constructor(message) {
8
+ super(message);
9
+ this.name = "PathaoWebhookError";
10
+ }
11
+ };
12
+ var PathaoWebhookEvent = /* @__PURE__ */ ((PathaoWebhookEvent2) => {
13
+ PathaoWebhookEvent2["WEBHOOK_INTEGRATION"] = "webhook_integration";
14
+ PathaoWebhookEvent2["ORDER_CREATED"] = "order.created";
15
+ PathaoWebhookEvent2["ORDER_UPDATED"] = "order.updated";
16
+ PathaoWebhookEvent2["ORDER_PICKUP_REQUESTED"] = "order.pickup-requested";
17
+ PathaoWebhookEvent2["ORDER_ASSIGNED_FOR_PICKUP"] = "order.assigned-for-pickup";
18
+ PathaoWebhookEvent2["ORDER_PICKED"] = "order.picked";
19
+ PathaoWebhookEvent2["ORDER_PICKUP_FAILED"] = "order.pickup-failed";
20
+ PathaoWebhookEvent2["ORDER_PICKUP_CANCELLED"] = "order.pickup-cancelled";
21
+ PathaoWebhookEvent2["ORDER_AT_THE_SORTING_HUB"] = "order.at-the-sorting-hub";
22
+ PathaoWebhookEvent2["ORDER_IN_TRANSIT"] = "order.in-transit";
23
+ PathaoWebhookEvent2["ORDER_RECEIVED_AT_LAST_MILE_HUB"] = "order.received-at-last-mile-hub";
24
+ PathaoWebhookEvent2["ORDER_ASSIGNED_FOR_DELIVERY"] = "order.assigned-for-delivery";
25
+ PathaoWebhookEvent2["ORDER_DELIVERED"] = "order.delivered";
26
+ PathaoWebhookEvent2["ORDER_PARTIAL_DELIVERY"] = "order.partial-delivery";
27
+ PathaoWebhookEvent2["ORDER_RETURNED"] = "order.returned";
28
+ PathaoWebhookEvent2["ORDER_DELIVERY_FAILED"] = "order.delivery-failed";
29
+ PathaoWebhookEvent2["ORDER_ON_HOLD"] = "order.on-hold";
30
+ PathaoWebhookEvent2["ORDER_PAID"] = "order.paid";
31
+ PathaoWebhookEvent2["ORDER_PAID_RETURN"] = "order.paid-return";
32
+ PathaoWebhookEvent2["ORDER_EXCHANGED"] = "order.exchanged";
33
+ PathaoWebhookEvent2["STORE_CREATED"] = "store.created";
34
+ PathaoWebhookEvent2["STORE_UPDATED"] = "store.updated";
35
+ return PathaoWebhookEvent2;
36
+ })(PathaoWebhookEvent || {});
37
+ var PATHAO_SECRET_HEADER = "x-pathao-merchant-webhook-integration-secret";
38
+ function constructEvent(rawBody) {
39
+ let parsed;
40
+ if (typeof rawBody === "object" && !Buffer.isBuffer(rawBody)) {
41
+ parsed = rawBody;
42
+ } else {
43
+ const bodyStr = Buffer.isBuffer(rawBody) ? rawBody.toString("utf8") : rawBody;
44
+ try {
45
+ parsed = JSON.parse(bodyStr);
46
+ } catch {
47
+ throw new PathaoWebhookError("Webhook payload is not valid JSON.");
48
+ }
49
+ }
50
+ if (!parsed || typeof parsed !== "object" || !("event" in parsed)) {
51
+ throw new PathaoWebhookError(
52
+ "Webhook payload is missing the required `event` field."
53
+ );
54
+ }
55
+ return parsed;
56
+ }
57
+ var PathaoWebhookHandler = class extends events.EventEmitter {
58
+ constructor(webhookSecret) {
59
+ super();
60
+ if (!webhookSecret) {
61
+ throw new PathaoWebhookError(
62
+ "webhookSecret is required to create a PathaoWebhookHandler."
63
+ );
64
+ }
65
+ this.webhookSecret = webhookSecret;
66
+ }
67
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
68
+ on(event, listener) {
69
+ return super.on(event, listener);
70
+ }
71
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
72
+ once(event, listener) {
73
+ return super.once(event, listener);
74
+ }
75
+ // ─────────────────────────────────────────────────────────────────────────
76
+ /**
77
+ * Parse the body and dispatch the event.
78
+ *
79
+ * Throws \`PathaoWebhookError\` on failure and also emits \`'error'\` so
80
+ * listeners can respond without a try/catch.
81
+ *
82
+ * @param rawBody Raw request body or matched json object
83
+ */
84
+ process(rawBody) {
85
+ let payload;
86
+ try {
87
+ payload = constructEvent(rawBody);
88
+ } catch (err) {
89
+ const webhookErr = err instanceof PathaoWebhookError ? err : new PathaoWebhookError(err instanceof Error ? err.message : "Unknown error");
90
+ if (this.listenerCount("error") > 0) {
91
+ this.emit("error", webhookErr);
92
+ }
93
+ throw webhookErr;
94
+ }
95
+ this.emit(payload.event, payload);
96
+ this.emit("webhook", payload);
97
+ return payload;
98
+ }
99
+ /**
100
+ * Returns an Express-compatible middleware function.
101
+ *
102
+ * Automatically sets the required \`X-Pathao-Merchant-Webhook-Integration-Secret\` header.
103
+ * Automatically responds with 202 for the \`webhook_integration\` handshake.
104
+ * For standard events, attaches the payload to \`req.pathaoWebhook\` and calls \`next()\`.
105
+ * On error, calls \`next(err)\`.
106
+ *
107
+ * \`\`\`typescript
108
+ * app.post(
109
+ * '/webhooks/pathao',
110
+ * express.json(),
111
+ * handler.expressMiddleware(),
112
+ * (req, res) => res.sendStatus(200) // You must send 200 for other events
113
+ * );
114
+ * \`\`\`
115
+ */
116
+ expressMiddleware() {
117
+ return (req, res, next) => {
118
+ try {
119
+ res.setHeader(PATHAO_SECRET_HEADER, this.webhookSecret);
120
+ const payload = this.process(req.body);
121
+ req.pathaoWebhook = payload;
122
+ if (payload.event === "webhook_integration" /* WEBHOOK_INTEGRATION */) {
123
+ res.status(202).send();
124
+ return;
125
+ }
126
+ next();
127
+ } catch (err) {
128
+ next(err);
129
+ }
130
+ };
131
+ }
132
+ /**
133
+ * Returns response instructions for any framework (Fastify, Hono, etc.).
134
+ *
135
+ * Never throws — always resolves with a \`WebhookResponseInstructions\` object
136
+ * that tells you which status code and headers to return, along with the payload/error.
137
+ *
138
+ * \`\`\`typescript
139
+ * const handle = handler.middleware();
140
+ * const instructions = await handle(request.body);
141
+ *
142
+ * // Apply the required headers (the secret header)
143
+ * for (const [key, value] of Object.entries(instructions.headers)) {
144
+ * reply.header(key, value);
145
+ * }
146
+ *
147
+ * if (instructions.error) {
148
+ * return reply.status(instructions.statusCode).send({ error: instructions.error.message });
149
+ * }
150
+ *
151
+ * // If it was the handshake, we should just return 202 as instructed
152
+ * if (instructions.payload?.event === 'webhook_integration') {
153
+ * return reply.status(instructions.statusCode).send();
154
+ * }
155
+ *
156
+ * // Process your real webhook
157
+ * return reply.status(instructions.statusCode).send({ received: true });
158
+ * \`\`\`
159
+ */
160
+ middleware() {
161
+ return async (rawBody) => {
162
+ const headers = { [PATHAO_SECRET_HEADER]: this.webhookSecret };
163
+ try {
164
+ const payload = this.process(rawBody);
165
+ const isHandshake = payload.event === "webhook_integration" /* WEBHOOK_INTEGRATION */;
166
+ return {
167
+ statusCode: isHandshake ? 202 : 200,
168
+ headers,
169
+ payload,
170
+ error: null
171
+ };
172
+ } catch (err) {
173
+ const webhookErr = err instanceof PathaoWebhookError ? err : new PathaoWebhookError(
174
+ err instanceof Error ? err.message : "Unknown error"
175
+ );
176
+ return {
177
+ statusCode: 400,
178
+ headers,
179
+ payload: null,
180
+ error: webhookErr
181
+ };
182
+ }
183
+ };
184
+ }
185
+ };
186
+
187
+ exports.PATHAO_SECRET_HEADER = PATHAO_SECRET_HEADER;
188
+ exports.PathaoWebhookError = PathaoWebhookError;
189
+ exports.PathaoWebhookEvent = PathaoWebhookEvent;
190
+ exports.PathaoWebhookHandler = PathaoWebhookHandler;
191
+ exports.constructEvent = constructEvent;
192
+ //# sourceMappingURL=webhooks.js.map
193
+ //# sourceMappingURL=webhooks.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/webhooks.ts"],"names":["PathaoWebhookEvent","EventEmitter"],"mappings":";;;;;AA6CO,IAAM,kBAAA,GAAN,cAAiC,KAAA,CAAM;AAAA,EAC5C,YAAY,OAAA,EAAiB;AAC3B,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAO,oBAAA;AAAA,EACd;AACF;AAUO,IAAK,kBAAA,qBAAAA,mBAAAA,KAAL;AACL,EAAAA,oBAAA,qBAAA,CAAA,GAAkC,qBAAA;AAClC,EAAAA,oBAAA,eAAA,CAAA,GAAkC,eAAA;AAClC,EAAAA,oBAAA,eAAA,CAAA,GAAkC,eAAA;AAClC,EAAAA,oBAAA,wBAAA,CAAA,GAAkC,wBAAA;AAClC,EAAAA,oBAAA,2BAAA,CAAA,GAAkC,2BAAA;AAClC,EAAAA,oBAAA,cAAA,CAAA,GAAkC,cAAA;AAClC,EAAAA,oBAAA,qBAAA,CAAA,GAAkC,qBAAA;AAClC,EAAAA,oBAAA,wBAAA,CAAA,GAAkC,wBAAA;AAClC,EAAAA,oBAAA,0BAAA,CAAA,GAAkC,0BAAA;AAClC,EAAAA,oBAAA,kBAAA,CAAA,GAAkC,kBAAA;AAClC,EAAAA,oBAAA,iCAAA,CAAA,GAAkC,iCAAA;AAClC,EAAAA,oBAAA,6BAAA,CAAA,GAAkC,6BAAA;AAClC,EAAAA,oBAAA,iBAAA,CAAA,GAAkC,iBAAA;AAClC,EAAAA,oBAAA,wBAAA,CAAA,GAAkC,wBAAA;AAClC,EAAAA,oBAAA,gBAAA,CAAA,GAAkC,gBAAA;AAClC,EAAAA,oBAAA,uBAAA,CAAA,GAAkC,uBAAA;AAClC,EAAAA,oBAAA,eAAA,CAAA,GAAkC,eAAA;AAClC,EAAAA,oBAAA,YAAA,CAAA,GAAkC,YAAA;AAClC,EAAAA,oBAAA,mBAAA,CAAA,GAAkC,mBAAA;AAClC,EAAAA,oBAAA,iBAAA,CAAA,GAAkC,iBAAA;AAClC,EAAAA,oBAAA,eAAA,CAAA,GAAkC,eAAA;AAClC,EAAAA,oBAAA,eAAA,CAAA,GAAkC,eAAA;AAtBxB,EAAA,OAAAA,mBAAAA;AAAA,CAAA,EAAA,kBAAA,IAAA,EAAA;AAsNL,IAAM,oBAAA,GAAuB;AAU7B,SAAS,eACd,OAAA,EACsB;AACtB,EAAA,IAAI,MAAA;AACJ,EAAA,IAAI,OAAO,OAAA,KAAY,QAAA,IAAY,CAAC,MAAA,CAAO,QAAA,CAAS,OAAO,CAAA,EAAG;AAC5D,IAAA,MAAA,GAAS,OAAA;AAAA,EACX,CAAA,MAAO;AACL,IAAA,MAAM,OAAA,GAAU,OAAO,QAAA,CAAS,OAAO,IAAI,OAAA,CAAQ,QAAA,CAAS,MAAM,CAAA,GAAI,OAAA;AACtE,IAAA,IAAI;AACF,MAAA,MAAA,GAAS,IAAA,CAAK,MAAM,OAAO,CAAA;AAAA,IAC7B,CAAA,CAAA,MAAQ;AACN,MAAA,MAAM,IAAI,mBAAmB,oCAAoC,CAAA;AAAA,IACnE;AAAA,EACF;AAEA,EAAA,IACE,CAAC,MAAA,IACD,OAAO,WAAW,QAAA,IAClB,EAAE,WAAW,MAAA,CAAA,EACb;AACA,IAAA,MAAM,IAAI,kBAAA;AAAA,MACR;AAAA,KACF;AAAA,EACF;AAEA,EAAA,OAAO,MAAA;AACT;AA2BO,IAAM,oBAAA,GAAN,cAAmCC,mBAAA,CAAa;AAAA,EAGrD,YAAY,aAAA,EAAuB;AACjC,IAAA,KAAA,EAAM;AACN,IAAA,IAAI,CAAC,aAAA,EAAe;AAClB,MAAA,MAAM,IAAI,kBAAA;AAAA,QACR;AAAA,OACF;AAAA,IACF;AACA,IAAA,IAAA,CAAK,aAAA,GAAgB,aAAA;AAAA,EACvB;AAAA;AAAA,EAcA,EAAA,CAAG,OAAwB,QAAA,EAA0C;AACnE,IAAA,OAAO,KAAA,CAAM,EAAA,CAAG,KAAA,EAAO,QAAQ,CAAA;AAAA,EACjC;AAAA;AAAA,EAUA,IAAA,CAAK,OAAwB,QAAA,EAA0C;AACrE,IAAA,OAAO,KAAA,CAAM,IAAA,CAAK,KAAA,EAAO,QAAQ,CAAA;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,QAAQ,OAAA,EAAyD;AAC/D,IAAA,IAAI,OAAA;AAEJ,IAAA,IAAI;AACF,MAAA,OAAA,GAAU,eAAe,OAAO,CAAA;AAAA,IAClC,SAAS,GAAA,EAAK;AACZ,MAAA,MAAM,UAAA,GAAa,GAAA,YAAe,kBAAA,GAC9B,GAAA,GACA,IAAI,mBAAmB,GAAA,YAAe,KAAA,GAAQ,GAAA,CAAI,OAAA,GAAU,eAAe,CAAA;AAC/E,MAAA,IAAI,IAAA,CAAK,aAAA,CAAc,OAAO,CAAA,GAAI,CAAA,EAAG;AACnC,QAAA,IAAA,CAAK,IAAA,CAAK,SAAS,UAAU,CAAA;AAAA,MAC/B;AACA,MAAA,MAAM,UAAA;AAAA,IACR;AAEA,IAAA,IAAA,CAAK,IAAA,CAAK,OAAA,CAAQ,KAAA,EAAO,OAAO,CAAA;AAChC,IAAA,IAAA,CAAK,IAAA,CAAK,WAAW,OAAO,CAAA;AAE5B,IAAA,OAAO,OAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBA,iBAAA,GAAoB;AAClB,IAAA,OAAO,CACL,GAAA,EAIA,GAAA,EAIA,IAAA,KACS;AACT,MAAA,IAAI;AACF,QAAA,GAAA,CAAI,SAAA,CAAU,oBAAA,EAAsB,IAAA,CAAK,aAAa,CAAA;AAEtD,QAAA,MAAM,OAAA,GAAU,IAAA,CAAK,OAAA,CAAQ,GAAA,CAAI,IAAI,CAAA;AACrC,QAAA,GAAA,CAAI,aAAA,GAAgB,OAAA;AAEpB,QAAA,IAAI,OAAA,CAAQ,UAAU,qBAAA,4BAAwC;AAC5D,UAAA,GAAA,CAAI,MAAA,CAAO,GAAG,CAAA,CAAE,IAAA,EAAK;AACrB,UAAA;AAAA,QACF;AAEA,QAAA,IAAA,EAAK;AAAA,MACP,SAAS,GAAA,EAAK;AACZ,QAAA,IAAA,CAAK,GAAG,CAAA;AAAA,MACV;AAAA,IACF,CAAA;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA8BA,UAAA,GAAa;AACX,IAAA,OAAO,OACL,OAAA,KACyC;AACzC,MAAA,MAAM,UAAU,EAAE,CAAC,oBAAoB,GAAG,KAAK,aAAA,EAAc;AAE7D,MAAA,IAAI;AACF,QAAA,MAAM,OAAA,GAAU,IAAA,CAAK,OAAA,CAAQ,OAAO,CAAA;AACpC,QAAA,MAAM,WAAA,GAAc,QAAQ,KAAA,KAAU,qBAAA;AACtC,QAAA,OAAO;AAAA,UACL,UAAA,EAAY,cAAc,GAAA,GAAM,GAAA;AAAA,UAChC,OAAA;AAAA,UACA,OAAA;AAAA,UACA,KAAA,EAAO;AAAA,SACT;AAAA,MACF,SAAS,GAAA,EAAK;AACZ,QAAA,MAAM,UAAA,GAAa,GAAA,YAAe,kBAAA,GAC9B,GAAA,GACA,IAAI,kBAAA;AAAA,UACJ,GAAA,YAAe,KAAA,GAAQ,GAAA,CAAI,OAAA,GAAU;AAAA,SACvC;AACF,QAAA,OAAO;AAAA,UACL,UAAA,EAAY,GAAA;AAAA,UACZ,OAAA;AAAA,UACA,OAAA,EAAS,IAAA;AAAA,UACT,KAAA,EAAO;AAAA,SACT;AAAA,MACF;AAAA,IACF,CAAA;AAAA,EACF;AACF","file":"webhooks.js","sourcesContent":["/**\n * Pathao Webhook Support\n *\n * Handles incoming webhook events from Pathao.\n *\n * IMPORTANT INTEGRATION DETAILS:\n * - Pathao does NOT sign incoming requests.\n * - Instead, Pathao requires you to prove ownership by echoing your webhook secret\n * in the \\`X-Pathao-Merchant-Webhook-Integration-Secret\\` header of EVERY response.\n * - This SDK automatically handles the \\`webhook_integration\\` handshake event, which\n * expects a 202 status code and the secret header.\n *\n * @example — Express\n * \\`\\`\\`typescript\n * import express from 'express';\n * import {\n * PathaoWebhookHandler,\n * PathaoWebhookEvent,\n * } from 'pathao-merchant-sdk/webhooks';\n *\n * const app = express();\n * const handler = new PathaoWebhookHandler(process.env.PATHAO_WEBHOOK_SECRET!);\n *\n * handler.on(PathaoWebhookEvent.ORDER_DELIVERED, (payload) => { ... });\n *\n * // Mount express.json() BEFORE the webhook middleware\n * app.post(\n * '/webhooks/pathao',\n * express.json(),\n * handler.expressMiddleware(),\n * (req, res) => {\n * // The middleware already sets the required secret header.\n * // You just need to return a 200 OK for standard events.\n * res.status(200).send('OK');\n * }\n * );\n * \\`\\`\\`\n */\n\nimport { EventEmitter } from 'events';\n\n// ---------------------------------------------------------------------------\n// Error\n// ---------------------------------------------------------------------------\n\nexport class PathaoWebhookError extends Error {\n constructor(message: string) {\n super(message);\n this.name = 'PathaoWebhookError';\n }\n}\n\n// ---------------------------------------------------------------------------\n// Event types\n// ---------------------------------------------------------------------------\n\n/**\n * All webhook event types emitted by Pathao.\n * Values are the exact strings that appear in the \\`event\\` field of each payload.\n */\nexport enum PathaoWebhookEvent {\n WEBHOOK_INTEGRATION = 'webhook_integration',\n ORDER_CREATED = 'order.created',\n ORDER_UPDATED = 'order.updated',\n ORDER_PICKUP_REQUESTED = 'order.pickup-requested',\n ORDER_ASSIGNED_FOR_PICKUP = 'order.assigned-for-pickup',\n ORDER_PICKED = 'order.picked',\n ORDER_PICKUP_FAILED = 'order.pickup-failed',\n ORDER_PICKUP_CANCELLED = 'order.pickup-cancelled',\n ORDER_AT_THE_SORTING_HUB = 'order.at-the-sorting-hub',\n ORDER_IN_TRANSIT = 'order.in-transit',\n ORDER_RECEIVED_AT_LAST_MILE_HUB = 'order.received-at-last-mile-hub',\n ORDER_ASSIGNED_FOR_DELIVERY = 'order.assigned-for-delivery',\n ORDER_DELIVERED = 'order.delivered',\n ORDER_PARTIAL_DELIVERY = 'order.partial-delivery',\n ORDER_RETURNED = 'order.returned',\n ORDER_DELIVERY_FAILED = 'order.delivery-failed',\n ORDER_ON_HOLD = 'order.on-hold',\n ORDER_PAID = 'order.paid',\n ORDER_PAID_RETURN = 'order.paid-return',\n ORDER_EXCHANGED = 'order.exchanged',\n STORE_CREATED = 'store.created',\n STORE_UPDATED = 'store.updated',\n}\n\n// ---------------------------------------------------------------------------\n// Payload types\n// ---------------------------------------------------------------------------\n\nexport interface WebhookIntegrationPayload {\n event: PathaoWebhookEvent.WEBHOOK_INTEGRATION;\n}\n\n/** Fields present on every normal webhook payload */\nexport interface BaseWebhookPayload {\n event: string;\n /** Format: MySQL datetime YYYY-MM-DD HH:MM:SS (no timezone indicator) */\n updated_at: string;\n /** Format: ISO 8601 timestamp */\n timestamp: string;\n}\n\n/** Fields shared by all order-related events */\nexport interface OrderWebhookPayload extends BaseWebhookPayload {\n consignment_id: string;\n merchant_order_id?: string;\n store_id: number;\n delivery_fee?: number;\n}\n\n/** Fields shared by all store-related events */\nexport interface StoreWebhookPayload extends BaseWebhookPayload {\n store_id: number;\n store_name: string;\n store_address: string;\n is_active: 0 | 1;\n}\n\n// Per-event payload types ────────────────────────────────────────────────────\n\nexport interface OrderCreatedPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_CREATED;\n delivery_fee: number;\n}\n\nexport interface OrderUpdatedPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_UPDATED;\n delivery_fee: number;\n}\n\nexport interface OrderPickupRequestedPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_PICKUP_REQUESTED;\n delivery_fee: number;\n}\n\nexport interface OrderAssignedForPickupPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_ASSIGNED_FOR_PICKUP;\n}\n\nexport interface OrderPickedPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_PICKED;\n}\n\nexport interface OrderPickupFailedPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_PICKUP_FAILED;\n}\n\nexport interface OrderPickupCancelledPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_PICKUP_CANCELLED;\n}\n\nexport interface OrderAtSortingHubPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_AT_THE_SORTING_HUB;\n}\n\nexport interface OrderInTransitPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_IN_TRANSIT;\n}\n\nexport interface OrderAtLastMileHubPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_RECEIVED_AT_LAST_MILE_HUB;\n}\n\nexport interface OrderAssignedForDeliveryPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_ASSIGNED_FOR_DELIVERY;\n}\n\nexport interface OrderDeliveredPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_DELIVERED;\n collected_amount: number;\n}\n\nexport interface OrderPartialDeliveryPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_PARTIAL_DELIVERY;\n collected_amount: number;\n reason?: string;\n}\n\nexport interface OrderReturnedPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_RETURNED;\n reason?: string;\n}\n\nexport interface OrderDeliveryFailedPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_DELIVERY_FAILED;\n reason?: string;\n}\n\nexport interface OrderOnHoldPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_ON_HOLD;\n reason?: string;\n}\n\nexport interface OrderPaidPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_PAID;\n invoice_id: string;\n}\n\nexport interface OrderPaidReturnPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_PAID_RETURN;\n collected_amount: number;\n reason?: string;\n}\n\nexport interface OrderExchangedPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_EXCHANGED;\n collected_amount: number;\n reason?: string;\n}\n\nexport interface StoreCreatedPayload extends StoreWebhookPayload {\n event: PathaoWebhookEvent.STORE_CREATED;\n}\n\nexport interface StoreUpdatedPayload extends StoreWebhookPayload {\n event: PathaoWebhookEvent.STORE_UPDATED;\n}\n\n/** Union of all possible webhook payloads */\nexport type PathaoWebhookPayload =\n | WebhookIntegrationPayload\n | OrderCreatedPayload\n | OrderUpdatedPayload\n | OrderPickupRequestedPayload\n | OrderAssignedForPickupPayload\n | OrderPickedPayload\n | OrderPickupFailedPayload\n | OrderPickupCancelledPayload\n | OrderAtSortingHubPayload\n | OrderInTransitPayload\n | OrderAtLastMileHubPayload\n | OrderAssignedForDeliveryPayload\n | OrderDeliveredPayload\n | OrderPartialDeliveryPayload\n | OrderReturnedPayload\n | OrderDeliveryFailedPayload\n | OrderOnHoldPayload\n | OrderPaidPayload\n | OrderPaidReturnPayload\n | OrderExchangedPayload\n | StoreCreatedPayload\n | StoreUpdatedPayload;\n\n/** Maps each \\`PathaoWebhookEvent\\` to its specific payload type */\nexport interface WebhookEventPayloadMap {\n [PathaoWebhookEvent.WEBHOOK_INTEGRATION]: WebhookIntegrationPayload;\n [PathaoWebhookEvent.ORDER_CREATED]: OrderCreatedPayload;\n [PathaoWebhookEvent.ORDER_UPDATED]: OrderUpdatedPayload;\n [PathaoWebhookEvent.ORDER_PICKUP_REQUESTED]: OrderPickupRequestedPayload;\n [PathaoWebhookEvent.ORDER_ASSIGNED_FOR_PICKUP]: OrderAssignedForPickupPayload;\n [PathaoWebhookEvent.ORDER_PICKED]: OrderPickedPayload;\n [PathaoWebhookEvent.ORDER_PICKUP_FAILED]: OrderPickupFailedPayload;\n [PathaoWebhookEvent.ORDER_PICKUP_CANCELLED]: OrderPickupCancelledPayload;\n [PathaoWebhookEvent.ORDER_AT_THE_SORTING_HUB]: OrderAtSortingHubPayload;\n [PathaoWebhookEvent.ORDER_IN_TRANSIT]: OrderInTransitPayload;\n [PathaoWebhookEvent.ORDER_RECEIVED_AT_LAST_MILE_HUB]: OrderAtLastMileHubPayload;\n [PathaoWebhookEvent.ORDER_ASSIGNED_FOR_DELIVERY]: OrderAssignedForDeliveryPayload;\n [PathaoWebhookEvent.ORDER_DELIVERED]: OrderDeliveredPayload;\n [PathaoWebhookEvent.ORDER_PARTIAL_DELIVERY]: OrderPartialDeliveryPayload;\n [PathaoWebhookEvent.ORDER_RETURNED]: OrderReturnedPayload;\n [PathaoWebhookEvent.ORDER_DELIVERY_FAILED]: OrderDeliveryFailedPayload;\n [PathaoWebhookEvent.ORDER_ON_HOLD]: OrderOnHoldPayload;\n [PathaoWebhookEvent.ORDER_PAID]: OrderPaidPayload;\n [PathaoWebhookEvent.ORDER_PAID_RETURN]: OrderPaidReturnPayload;\n [PathaoWebhookEvent.ORDER_EXCHANGED]: OrderExchangedPayload;\n [PathaoWebhookEvent.STORE_CREATED]: StoreCreatedPayload;\n [PathaoWebhookEvent.STORE_UPDATED]: StoreUpdatedPayload;\n}\n\n// ---------------------------------------------------------------------------\n// Core functions\n// ---------------------------------------------------------------------------\n\n/** Required response header used to authorize your endpoint with Pathao */\nexport const PATHAO_SECRET_HEADER = 'x-pathao-merchant-webhook-integration-secret';\n\n/**\n * Parses the raw body into a webhook payload.\n * Pathao does not sign inbound requests, so this just ensures it is valid JSON with an event field.\n *\n * Throws \\`PathaoWebhookError\\` on malformed JSON or missing event.\n *\n * @param rawBody Raw request body or parsed object\n */\nexport function constructEvent(\n rawBody: Buffer | string | object,\n): PathaoWebhookPayload {\n let parsed: unknown;\n if (typeof rawBody === 'object' && !Buffer.isBuffer(rawBody)) {\n parsed = rawBody;\n } else {\n const bodyStr = Buffer.isBuffer(rawBody) ? rawBody.toString('utf8') : rawBody;\n try {\n parsed = JSON.parse(bodyStr);\n } catch {\n throw new PathaoWebhookError('Webhook payload is not valid JSON.');\n }\n }\n\n if (\n !parsed ||\n typeof parsed !== 'object' ||\n !('event' in parsed)\n ) {\n throw new PathaoWebhookError(\n 'Webhook payload is missing the required \\`event\\` field.',\n );\n }\n\n return parsed as PathaoWebhookPayload;\n}\n\n// ---------------------------------------------------------------------------\n// PathaoWebhookHandler\n// ---------------------------------------------------------------------------\n\nexport type WebhookResponseInstructions = {\n statusCode: number;\n headers: Record<string, string>;\n payload: PathaoWebhookPayload | null;\n error: PathaoWebhookError | null;\n};\n\n/**\n * Stateful webhook handler that parses payloads, provides response instructions,\n * and dispatches events to typed listeners.\n *\n * @example\n * \\`\\`\\`typescript\n * const handler = new PathaoWebhookHandler(process.env.PATHAO_WEBHOOK_SECRET!);\n *\n * handler.on(PathaoWebhookEvent.ORDER_DELIVERED, (payload) => {\n * // payload is fully typed as OrderDeliveredPayload\n * console.log(payload.consignment_id, payload.collected_amount);\n * });\n * \\`\\`\\`\n */\nexport class PathaoWebhookHandler extends EventEmitter {\n private readonly webhookSecret: string;\n\n constructor(webhookSecret: string) {\n super();\n if (!webhookSecret) {\n throw new PathaoWebhookError(\n 'webhookSecret is required to create a PathaoWebhookHandler.',\n );\n }\n this.webhookSecret = webhookSecret;\n }\n\n // Typed on() overloads ──────────────────────────────────────────────────\n\n /** Listen for a specific Pathao event with a fully-typed payload callback. */\n on<E extends PathaoWebhookEvent>(\n event: E,\n listener: (payload: WebhookEventPayloadMap[E]) => void,\n ): this;\n /** Fires for every successfully parsed event regardless of type. */\n on(event: 'webhook', listener: (payload: PathaoWebhookPayload) => void): this;\n /** Fires when parsing fails. */\n on(event: 'error', listener: (error: PathaoWebhookError) => void): this;\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n on(event: string | symbol, listener: (...args: any[]) => void): this {\n return super.on(event, listener);\n }\n\n /** Listen once for a specific Pathao event. */\n once<E extends PathaoWebhookEvent>(\n event: E,\n listener: (payload: WebhookEventPayloadMap[E]) => void,\n ): this;\n once(event: 'webhook', listener: (payload: PathaoWebhookPayload) => void): this;\n once(event: 'error', listener: (error: PathaoWebhookError) => void): this;\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n once(event: string | symbol, listener: (...args: any[]) => void): this {\n return super.once(event, listener);\n }\n\n // ─────────────────────────────────────────────────────────────────────────\n\n /**\n * Parse the body and dispatch the event.\n *\n * Throws \\`PathaoWebhookError\\` on failure and also emits \\`'error'\\` so\n * listeners can respond without a try/catch.\n *\n * @param rawBody Raw request body or matched json object\n */\n process(rawBody: Buffer | string | object): PathaoWebhookPayload {\n let payload: PathaoWebhookPayload;\n\n try {\n payload = constructEvent(rawBody);\n } catch (err) {\n const webhookErr = err instanceof PathaoWebhookError\n ? err\n : new PathaoWebhookError(err instanceof Error ? err.message : 'Unknown error');\n if (this.listenerCount('error') > 0) {\n this.emit('error', webhookErr);\n }\n throw webhookErr;\n }\n\n this.emit(payload.event, payload);\n this.emit('webhook', payload);\n\n return payload;\n }\n\n /**\n * Returns an Express-compatible middleware function.\n *\n * Automatically sets the required \\`X-Pathao-Merchant-Webhook-Integration-Secret\\` header.\n * Automatically responds with 202 for the \\`webhook_integration\\` handshake.\n * For standard events, attaches the payload to \\`req.pathaoWebhook\\` and calls \\`next()\\`.\n * On error, calls \\`next(err)\\`.\n *\n * \\`\\`\\`typescript\n * app.post(\n * '/webhooks/pathao',\n * express.json(),\n * handler.expressMiddleware(),\n * (req, res) => res.sendStatus(200) // You must send 200 for other events\n * );\n * \\`\\`\\`\n */\n expressMiddleware() {\n return (\n req: {\n body: Buffer | string | object;\n pathaoWebhook?: PathaoWebhookPayload;\n },\n res: {\n setHeader: (name: string, value: string) => void;\n status: (code: number) => { send: () => void };\n },\n next: (err?: unknown) => void,\n ): void => {\n try {\n res.setHeader(PATHAO_SECRET_HEADER, this.webhookSecret);\n \n const payload = this.process(req.body);\n req.pathaoWebhook = payload;\n \n if (payload.event === PathaoWebhookEvent.WEBHOOK_INTEGRATION) {\n res.status(202).send();\n return;\n }\n\n next();\n } catch (err) {\n next(err);\n }\n };\n }\n\n /**\n * Returns response instructions for any framework (Fastify, Hono, etc.).\n *\n * Never throws — always resolves with a \\`WebhookResponseInstructions\\` object\n * that tells you which status code and headers to return, along with the payload/error.\n *\n * \\`\\`\\`typescript\n * const handle = handler.middleware();\n * const instructions = await handle(request.body);\n * \n * // Apply the required headers (the secret header)\n * for (const [key, value] of Object.entries(instructions.headers)) {\n * reply.header(key, value);\n * }\n * \n * if (instructions.error) {\n * return reply.status(instructions.statusCode).send({ error: instructions.error.message });\n * }\n * \n * // If it was the handshake, we should just return 202 as instructed\n * if (instructions.payload?.event === 'webhook_integration') {\n * return reply.status(instructions.statusCode).send();\n * }\n * \n * // Process your real webhook\n * return reply.status(instructions.statusCode).send({ received: true });\n * \\`\\`\\`\n */\n middleware() {\n return async (\n rawBody: Buffer | string | object,\n ): Promise<WebhookResponseInstructions> => {\n const headers = { [PATHAO_SECRET_HEADER]: this.webhookSecret };\n \n try {\n const payload = this.process(rawBody);\n const isHandshake = payload.event === PathaoWebhookEvent.WEBHOOK_INTEGRATION;\n return {\n statusCode: isHandshake ? 202 : 200,\n headers,\n payload,\n error: null\n };\n } catch (err) {\n const webhookErr = err instanceof PathaoWebhookError\n ? err\n : new PathaoWebhookError(\n err instanceof Error ? err.message : 'Unknown error',\n );\n return {\n statusCode: 400,\n headers,\n payload: null,\n error: webhookErr\n };\n }\n };\n }\n}\n"]}
@@ -0,0 +1,187 @@
1
+ import { EventEmitter } from 'events';
2
+
3
+ // src/webhooks.ts
4
+ var PathaoWebhookError = class extends Error {
5
+ constructor(message) {
6
+ super(message);
7
+ this.name = "PathaoWebhookError";
8
+ }
9
+ };
10
+ var PathaoWebhookEvent = /* @__PURE__ */ ((PathaoWebhookEvent2) => {
11
+ PathaoWebhookEvent2["WEBHOOK_INTEGRATION"] = "webhook_integration";
12
+ PathaoWebhookEvent2["ORDER_CREATED"] = "order.created";
13
+ PathaoWebhookEvent2["ORDER_UPDATED"] = "order.updated";
14
+ PathaoWebhookEvent2["ORDER_PICKUP_REQUESTED"] = "order.pickup-requested";
15
+ PathaoWebhookEvent2["ORDER_ASSIGNED_FOR_PICKUP"] = "order.assigned-for-pickup";
16
+ PathaoWebhookEvent2["ORDER_PICKED"] = "order.picked";
17
+ PathaoWebhookEvent2["ORDER_PICKUP_FAILED"] = "order.pickup-failed";
18
+ PathaoWebhookEvent2["ORDER_PICKUP_CANCELLED"] = "order.pickup-cancelled";
19
+ PathaoWebhookEvent2["ORDER_AT_THE_SORTING_HUB"] = "order.at-the-sorting-hub";
20
+ PathaoWebhookEvent2["ORDER_IN_TRANSIT"] = "order.in-transit";
21
+ PathaoWebhookEvent2["ORDER_RECEIVED_AT_LAST_MILE_HUB"] = "order.received-at-last-mile-hub";
22
+ PathaoWebhookEvent2["ORDER_ASSIGNED_FOR_DELIVERY"] = "order.assigned-for-delivery";
23
+ PathaoWebhookEvent2["ORDER_DELIVERED"] = "order.delivered";
24
+ PathaoWebhookEvent2["ORDER_PARTIAL_DELIVERY"] = "order.partial-delivery";
25
+ PathaoWebhookEvent2["ORDER_RETURNED"] = "order.returned";
26
+ PathaoWebhookEvent2["ORDER_DELIVERY_FAILED"] = "order.delivery-failed";
27
+ PathaoWebhookEvent2["ORDER_ON_HOLD"] = "order.on-hold";
28
+ PathaoWebhookEvent2["ORDER_PAID"] = "order.paid";
29
+ PathaoWebhookEvent2["ORDER_PAID_RETURN"] = "order.paid-return";
30
+ PathaoWebhookEvent2["ORDER_EXCHANGED"] = "order.exchanged";
31
+ PathaoWebhookEvent2["STORE_CREATED"] = "store.created";
32
+ PathaoWebhookEvent2["STORE_UPDATED"] = "store.updated";
33
+ return PathaoWebhookEvent2;
34
+ })(PathaoWebhookEvent || {});
35
+ var PATHAO_SECRET_HEADER = "x-pathao-merchant-webhook-integration-secret";
36
+ function constructEvent(rawBody) {
37
+ let parsed;
38
+ if (typeof rawBody === "object" && !Buffer.isBuffer(rawBody)) {
39
+ parsed = rawBody;
40
+ } else {
41
+ const bodyStr = Buffer.isBuffer(rawBody) ? rawBody.toString("utf8") : rawBody;
42
+ try {
43
+ parsed = JSON.parse(bodyStr);
44
+ } catch {
45
+ throw new PathaoWebhookError("Webhook payload is not valid JSON.");
46
+ }
47
+ }
48
+ if (!parsed || typeof parsed !== "object" || !("event" in parsed)) {
49
+ throw new PathaoWebhookError(
50
+ "Webhook payload is missing the required `event` field."
51
+ );
52
+ }
53
+ return parsed;
54
+ }
55
+ var PathaoWebhookHandler = class extends EventEmitter {
56
+ constructor(webhookSecret) {
57
+ super();
58
+ if (!webhookSecret) {
59
+ throw new PathaoWebhookError(
60
+ "webhookSecret is required to create a PathaoWebhookHandler."
61
+ );
62
+ }
63
+ this.webhookSecret = webhookSecret;
64
+ }
65
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
66
+ on(event, listener) {
67
+ return super.on(event, listener);
68
+ }
69
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
70
+ once(event, listener) {
71
+ return super.once(event, listener);
72
+ }
73
+ // ─────────────────────────────────────────────────────────────────────────
74
+ /**
75
+ * Parse the body and dispatch the event.
76
+ *
77
+ * Throws \`PathaoWebhookError\` on failure and also emits \`'error'\` so
78
+ * listeners can respond without a try/catch.
79
+ *
80
+ * @param rawBody Raw request body or matched json object
81
+ */
82
+ process(rawBody) {
83
+ let payload;
84
+ try {
85
+ payload = constructEvent(rawBody);
86
+ } catch (err) {
87
+ const webhookErr = err instanceof PathaoWebhookError ? err : new PathaoWebhookError(err instanceof Error ? err.message : "Unknown error");
88
+ if (this.listenerCount("error") > 0) {
89
+ this.emit("error", webhookErr);
90
+ }
91
+ throw webhookErr;
92
+ }
93
+ this.emit(payload.event, payload);
94
+ this.emit("webhook", payload);
95
+ return payload;
96
+ }
97
+ /**
98
+ * Returns an Express-compatible middleware function.
99
+ *
100
+ * Automatically sets the required \`X-Pathao-Merchant-Webhook-Integration-Secret\` header.
101
+ * Automatically responds with 202 for the \`webhook_integration\` handshake.
102
+ * For standard events, attaches the payload to \`req.pathaoWebhook\` and calls \`next()\`.
103
+ * On error, calls \`next(err)\`.
104
+ *
105
+ * \`\`\`typescript
106
+ * app.post(
107
+ * '/webhooks/pathao',
108
+ * express.json(),
109
+ * handler.expressMiddleware(),
110
+ * (req, res) => res.sendStatus(200) // You must send 200 for other events
111
+ * );
112
+ * \`\`\`
113
+ */
114
+ expressMiddleware() {
115
+ return (req, res, next) => {
116
+ try {
117
+ res.setHeader(PATHAO_SECRET_HEADER, this.webhookSecret);
118
+ const payload = this.process(req.body);
119
+ req.pathaoWebhook = payload;
120
+ if (payload.event === "webhook_integration" /* WEBHOOK_INTEGRATION */) {
121
+ res.status(202).send();
122
+ return;
123
+ }
124
+ next();
125
+ } catch (err) {
126
+ next(err);
127
+ }
128
+ };
129
+ }
130
+ /**
131
+ * Returns response instructions for any framework (Fastify, Hono, etc.).
132
+ *
133
+ * Never throws — always resolves with a \`WebhookResponseInstructions\` object
134
+ * that tells you which status code and headers to return, along with the payload/error.
135
+ *
136
+ * \`\`\`typescript
137
+ * const handle = handler.middleware();
138
+ * const instructions = await handle(request.body);
139
+ *
140
+ * // Apply the required headers (the secret header)
141
+ * for (const [key, value] of Object.entries(instructions.headers)) {
142
+ * reply.header(key, value);
143
+ * }
144
+ *
145
+ * if (instructions.error) {
146
+ * return reply.status(instructions.statusCode).send({ error: instructions.error.message });
147
+ * }
148
+ *
149
+ * // If it was the handshake, we should just return 202 as instructed
150
+ * if (instructions.payload?.event === 'webhook_integration') {
151
+ * return reply.status(instructions.statusCode).send();
152
+ * }
153
+ *
154
+ * // Process your real webhook
155
+ * return reply.status(instructions.statusCode).send({ received: true });
156
+ * \`\`\`
157
+ */
158
+ middleware() {
159
+ return async (rawBody) => {
160
+ const headers = { [PATHAO_SECRET_HEADER]: this.webhookSecret };
161
+ try {
162
+ const payload = this.process(rawBody);
163
+ const isHandshake = payload.event === "webhook_integration" /* WEBHOOK_INTEGRATION */;
164
+ return {
165
+ statusCode: isHandshake ? 202 : 200,
166
+ headers,
167
+ payload,
168
+ error: null
169
+ };
170
+ } catch (err) {
171
+ const webhookErr = err instanceof PathaoWebhookError ? err : new PathaoWebhookError(
172
+ err instanceof Error ? err.message : "Unknown error"
173
+ );
174
+ return {
175
+ statusCode: 400,
176
+ headers,
177
+ payload: null,
178
+ error: webhookErr
179
+ };
180
+ }
181
+ };
182
+ }
183
+ };
184
+
185
+ export { PATHAO_SECRET_HEADER, PathaoWebhookError, PathaoWebhookEvent, PathaoWebhookHandler, constructEvent };
186
+ //# sourceMappingURL=webhooks.mjs.map
187
+ //# sourceMappingURL=webhooks.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/webhooks.ts"],"names":["PathaoWebhookEvent"],"mappings":";;;AA6CO,IAAM,kBAAA,GAAN,cAAiC,KAAA,CAAM;AAAA,EAC5C,YAAY,OAAA,EAAiB;AAC3B,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAO,oBAAA;AAAA,EACd;AACF;AAUO,IAAK,kBAAA,qBAAAA,mBAAAA,KAAL;AACL,EAAAA,oBAAA,qBAAA,CAAA,GAAkC,qBAAA;AAClC,EAAAA,oBAAA,eAAA,CAAA,GAAkC,eAAA;AAClC,EAAAA,oBAAA,eAAA,CAAA,GAAkC,eAAA;AAClC,EAAAA,oBAAA,wBAAA,CAAA,GAAkC,wBAAA;AAClC,EAAAA,oBAAA,2BAAA,CAAA,GAAkC,2BAAA;AAClC,EAAAA,oBAAA,cAAA,CAAA,GAAkC,cAAA;AAClC,EAAAA,oBAAA,qBAAA,CAAA,GAAkC,qBAAA;AAClC,EAAAA,oBAAA,wBAAA,CAAA,GAAkC,wBAAA;AAClC,EAAAA,oBAAA,0BAAA,CAAA,GAAkC,0BAAA;AAClC,EAAAA,oBAAA,kBAAA,CAAA,GAAkC,kBAAA;AAClC,EAAAA,oBAAA,iCAAA,CAAA,GAAkC,iCAAA;AAClC,EAAAA,oBAAA,6BAAA,CAAA,GAAkC,6BAAA;AAClC,EAAAA,oBAAA,iBAAA,CAAA,GAAkC,iBAAA;AAClC,EAAAA,oBAAA,wBAAA,CAAA,GAAkC,wBAAA;AAClC,EAAAA,oBAAA,gBAAA,CAAA,GAAkC,gBAAA;AAClC,EAAAA,oBAAA,uBAAA,CAAA,GAAkC,uBAAA;AAClC,EAAAA,oBAAA,eAAA,CAAA,GAAkC,eAAA;AAClC,EAAAA,oBAAA,YAAA,CAAA,GAAkC,YAAA;AAClC,EAAAA,oBAAA,mBAAA,CAAA,GAAkC,mBAAA;AAClC,EAAAA,oBAAA,iBAAA,CAAA,GAAkC,iBAAA;AAClC,EAAAA,oBAAA,eAAA,CAAA,GAAkC,eAAA;AAClC,EAAAA,oBAAA,eAAA,CAAA,GAAkC,eAAA;AAtBxB,EAAA,OAAAA,mBAAAA;AAAA,CAAA,EAAA,kBAAA,IAAA,EAAA;AAsNL,IAAM,oBAAA,GAAuB;AAU7B,SAAS,eACd,OAAA,EACsB;AACtB,EAAA,IAAI,MAAA;AACJ,EAAA,IAAI,OAAO,OAAA,KAAY,QAAA,IAAY,CAAC,MAAA,CAAO,QAAA,CAAS,OAAO,CAAA,EAAG;AAC5D,IAAA,MAAA,GAAS,OAAA;AAAA,EACX,CAAA,MAAO;AACL,IAAA,MAAM,OAAA,GAAU,OAAO,QAAA,CAAS,OAAO,IAAI,OAAA,CAAQ,QAAA,CAAS,MAAM,CAAA,GAAI,OAAA;AACtE,IAAA,IAAI;AACF,MAAA,MAAA,GAAS,IAAA,CAAK,MAAM,OAAO,CAAA;AAAA,IAC7B,CAAA,CAAA,MAAQ;AACN,MAAA,MAAM,IAAI,mBAAmB,oCAAoC,CAAA;AAAA,IACnE;AAAA,EACF;AAEA,EAAA,IACE,CAAC,MAAA,IACD,OAAO,WAAW,QAAA,IAClB,EAAE,WAAW,MAAA,CAAA,EACb;AACA,IAAA,MAAM,IAAI,kBAAA;AAAA,MACR;AAAA,KACF;AAAA,EACF;AAEA,EAAA,OAAO,MAAA;AACT;AA2BO,IAAM,oBAAA,GAAN,cAAmC,YAAA,CAAa;AAAA,EAGrD,YAAY,aAAA,EAAuB;AACjC,IAAA,KAAA,EAAM;AACN,IAAA,IAAI,CAAC,aAAA,EAAe;AAClB,MAAA,MAAM,IAAI,kBAAA;AAAA,QACR;AAAA,OACF;AAAA,IACF;AACA,IAAA,IAAA,CAAK,aAAA,GAAgB,aAAA;AAAA,EACvB;AAAA;AAAA,EAcA,EAAA,CAAG,OAAwB,QAAA,EAA0C;AACnE,IAAA,OAAO,KAAA,CAAM,EAAA,CAAG,KAAA,EAAO,QAAQ,CAAA;AAAA,EACjC;AAAA;AAAA,EAUA,IAAA,CAAK,OAAwB,QAAA,EAA0C;AACrE,IAAA,OAAO,KAAA,CAAM,IAAA,CAAK,KAAA,EAAO,QAAQ,CAAA;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,QAAQ,OAAA,EAAyD;AAC/D,IAAA,IAAI,OAAA;AAEJ,IAAA,IAAI;AACF,MAAA,OAAA,GAAU,eAAe,OAAO,CAAA;AAAA,IAClC,SAAS,GAAA,EAAK;AACZ,MAAA,MAAM,UAAA,GAAa,GAAA,YAAe,kBAAA,GAC9B,GAAA,GACA,IAAI,mBAAmB,GAAA,YAAe,KAAA,GAAQ,GAAA,CAAI,OAAA,GAAU,eAAe,CAAA;AAC/E,MAAA,IAAI,IAAA,CAAK,aAAA,CAAc,OAAO,CAAA,GAAI,CAAA,EAAG;AACnC,QAAA,IAAA,CAAK,IAAA,CAAK,SAAS,UAAU,CAAA;AAAA,MAC/B;AACA,MAAA,MAAM,UAAA;AAAA,IACR;AAEA,IAAA,IAAA,CAAK,IAAA,CAAK,OAAA,CAAQ,KAAA,EAAO,OAAO,CAAA;AAChC,IAAA,IAAA,CAAK,IAAA,CAAK,WAAW,OAAO,CAAA;AAE5B,IAAA,OAAO,OAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBA,iBAAA,GAAoB;AAClB,IAAA,OAAO,CACL,GAAA,EAIA,GAAA,EAIA,IAAA,KACS;AACT,MAAA,IAAI;AACF,QAAA,GAAA,CAAI,SAAA,CAAU,oBAAA,EAAsB,IAAA,CAAK,aAAa,CAAA;AAEtD,QAAA,MAAM,OAAA,GAAU,IAAA,CAAK,OAAA,CAAQ,GAAA,CAAI,IAAI,CAAA;AACrC,QAAA,GAAA,CAAI,aAAA,GAAgB,OAAA;AAEpB,QAAA,IAAI,OAAA,CAAQ,UAAU,qBAAA,4BAAwC;AAC5D,UAAA,GAAA,CAAI,MAAA,CAAO,GAAG,CAAA,CAAE,IAAA,EAAK;AACrB,UAAA;AAAA,QACF;AAEA,QAAA,IAAA,EAAK;AAAA,MACP,SAAS,GAAA,EAAK;AACZ,QAAA,IAAA,CAAK,GAAG,CAAA;AAAA,MACV;AAAA,IACF,CAAA;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA8BA,UAAA,GAAa;AACX,IAAA,OAAO,OACL,OAAA,KACyC;AACzC,MAAA,MAAM,UAAU,EAAE,CAAC,oBAAoB,GAAG,KAAK,aAAA,EAAc;AAE7D,MAAA,IAAI;AACF,QAAA,MAAM,OAAA,GAAU,IAAA,CAAK,OAAA,CAAQ,OAAO,CAAA;AACpC,QAAA,MAAM,WAAA,GAAc,QAAQ,KAAA,KAAU,qBAAA;AACtC,QAAA,OAAO;AAAA,UACL,UAAA,EAAY,cAAc,GAAA,GAAM,GAAA;AAAA,UAChC,OAAA;AAAA,UACA,OAAA;AAAA,UACA,KAAA,EAAO;AAAA,SACT;AAAA,MACF,SAAS,GAAA,EAAK;AACZ,QAAA,MAAM,UAAA,GAAa,GAAA,YAAe,kBAAA,GAC9B,GAAA,GACA,IAAI,kBAAA;AAAA,UACJ,GAAA,YAAe,KAAA,GAAQ,GAAA,CAAI,OAAA,GAAU;AAAA,SACvC;AACF,QAAA,OAAO;AAAA,UACL,UAAA,EAAY,GAAA;AAAA,UACZ,OAAA;AAAA,UACA,OAAA,EAAS,IAAA;AAAA,UACT,KAAA,EAAO;AAAA,SACT;AAAA,MACF;AAAA,IACF,CAAA;AAAA,EACF;AACF","file":"webhooks.mjs","sourcesContent":["/**\n * Pathao Webhook Support\n *\n * Handles incoming webhook events from Pathao.\n *\n * IMPORTANT INTEGRATION DETAILS:\n * - Pathao does NOT sign incoming requests.\n * - Instead, Pathao requires you to prove ownership by echoing your webhook secret\n * in the \\`X-Pathao-Merchant-Webhook-Integration-Secret\\` header of EVERY response.\n * - This SDK automatically handles the \\`webhook_integration\\` handshake event, which\n * expects a 202 status code and the secret header.\n *\n * @example — Express\n * \\`\\`\\`typescript\n * import express from 'express';\n * import {\n * PathaoWebhookHandler,\n * PathaoWebhookEvent,\n * } from 'pathao-merchant-sdk/webhooks';\n *\n * const app = express();\n * const handler = new PathaoWebhookHandler(process.env.PATHAO_WEBHOOK_SECRET!);\n *\n * handler.on(PathaoWebhookEvent.ORDER_DELIVERED, (payload) => { ... });\n *\n * // Mount express.json() BEFORE the webhook middleware\n * app.post(\n * '/webhooks/pathao',\n * express.json(),\n * handler.expressMiddleware(),\n * (req, res) => {\n * // The middleware already sets the required secret header.\n * // You just need to return a 200 OK for standard events.\n * res.status(200).send('OK');\n * }\n * );\n * \\`\\`\\`\n */\n\nimport { EventEmitter } from 'events';\n\n// ---------------------------------------------------------------------------\n// Error\n// ---------------------------------------------------------------------------\n\nexport class PathaoWebhookError extends Error {\n constructor(message: string) {\n super(message);\n this.name = 'PathaoWebhookError';\n }\n}\n\n// ---------------------------------------------------------------------------\n// Event types\n// ---------------------------------------------------------------------------\n\n/**\n * All webhook event types emitted by Pathao.\n * Values are the exact strings that appear in the \\`event\\` field of each payload.\n */\nexport enum PathaoWebhookEvent {\n WEBHOOK_INTEGRATION = 'webhook_integration',\n ORDER_CREATED = 'order.created',\n ORDER_UPDATED = 'order.updated',\n ORDER_PICKUP_REQUESTED = 'order.pickup-requested',\n ORDER_ASSIGNED_FOR_PICKUP = 'order.assigned-for-pickup',\n ORDER_PICKED = 'order.picked',\n ORDER_PICKUP_FAILED = 'order.pickup-failed',\n ORDER_PICKUP_CANCELLED = 'order.pickup-cancelled',\n ORDER_AT_THE_SORTING_HUB = 'order.at-the-sorting-hub',\n ORDER_IN_TRANSIT = 'order.in-transit',\n ORDER_RECEIVED_AT_LAST_MILE_HUB = 'order.received-at-last-mile-hub',\n ORDER_ASSIGNED_FOR_DELIVERY = 'order.assigned-for-delivery',\n ORDER_DELIVERED = 'order.delivered',\n ORDER_PARTIAL_DELIVERY = 'order.partial-delivery',\n ORDER_RETURNED = 'order.returned',\n ORDER_DELIVERY_FAILED = 'order.delivery-failed',\n ORDER_ON_HOLD = 'order.on-hold',\n ORDER_PAID = 'order.paid',\n ORDER_PAID_RETURN = 'order.paid-return',\n ORDER_EXCHANGED = 'order.exchanged',\n STORE_CREATED = 'store.created',\n STORE_UPDATED = 'store.updated',\n}\n\n// ---------------------------------------------------------------------------\n// Payload types\n// ---------------------------------------------------------------------------\n\nexport interface WebhookIntegrationPayload {\n event: PathaoWebhookEvent.WEBHOOK_INTEGRATION;\n}\n\n/** Fields present on every normal webhook payload */\nexport interface BaseWebhookPayload {\n event: string;\n /** Format: MySQL datetime YYYY-MM-DD HH:MM:SS (no timezone indicator) */\n updated_at: string;\n /** Format: ISO 8601 timestamp */\n timestamp: string;\n}\n\n/** Fields shared by all order-related events */\nexport interface OrderWebhookPayload extends BaseWebhookPayload {\n consignment_id: string;\n merchant_order_id?: string;\n store_id: number;\n delivery_fee?: number;\n}\n\n/** Fields shared by all store-related events */\nexport interface StoreWebhookPayload extends BaseWebhookPayload {\n store_id: number;\n store_name: string;\n store_address: string;\n is_active: 0 | 1;\n}\n\n// Per-event payload types ────────────────────────────────────────────────────\n\nexport interface OrderCreatedPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_CREATED;\n delivery_fee: number;\n}\n\nexport interface OrderUpdatedPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_UPDATED;\n delivery_fee: number;\n}\n\nexport interface OrderPickupRequestedPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_PICKUP_REQUESTED;\n delivery_fee: number;\n}\n\nexport interface OrderAssignedForPickupPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_ASSIGNED_FOR_PICKUP;\n}\n\nexport interface OrderPickedPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_PICKED;\n}\n\nexport interface OrderPickupFailedPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_PICKUP_FAILED;\n}\n\nexport interface OrderPickupCancelledPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_PICKUP_CANCELLED;\n}\n\nexport interface OrderAtSortingHubPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_AT_THE_SORTING_HUB;\n}\n\nexport interface OrderInTransitPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_IN_TRANSIT;\n}\n\nexport interface OrderAtLastMileHubPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_RECEIVED_AT_LAST_MILE_HUB;\n}\n\nexport interface OrderAssignedForDeliveryPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_ASSIGNED_FOR_DELIVERY;\n}\n\nexport interface OrderDeliveredPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_DELIVERED;\n collected_amount: number;\n}\n\nexport interface OrderPartialDeliveryPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_PARTIAL_DELIVERY;\n collected_amount: number;\n reason?: string;\n}\n\nexport interface OrderReturnedPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_RETURNED;\n reason?: string;\n}\n\nexport interface OrderDeliveryFailedPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_DELIVERY_FAILED;\n reason?: string;\n}\n\nexport interface OrderOnHoldPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_ON_HOLD;\n reason?: string;\n}\n\nexport interface OrderPaidPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_PAID;\n invoice_id: string;\n}\n\nexport interface OrderPaidReturnPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_PAID_RETURN;\n collected_amount: number;\n reason?: string;\n}\n\nexport interface OrderExchangedPayload extends OrderWebhookPayload {\n event: PathaoWebhookEvent.ORDER_EXCHANGED;\n collected_amount: number;\n reason?: string;\n}\n\nexport interface StoreCreatedPayload extends StoreWebhookPayload {\n event: PathaoWebhookEvent.STORE_CREATED;\n}\n\nexport interface StoreUpdatedPayload extends StoreWebhookPayload {\n event: PathaoWebhookEvent.STORE_UPDATED;\n}\n\n/** Union of all possible webhook payloads */\nexport type PathaoWebhookPayload =\n | WebhookIntegrationPayload\n | OrderCreatedPayload\n | OrderUpdatedPayload\n | OrderPickupRequestedPayload\n | OrderAssignedForPickupPayload\n | OrderPickedPayload\n | OrderPickupFailedPayload\n | OrderPickupCancelledPayload\n | OrderAtSortingHubPayload\n | OrderInTransitPayload\n | OrderAtLastMileHubPayload\n | OrderAssignedForDeliveryPayload\n | OrderDeliveredPayload\n | OrderPartialDeliveryPayload\n | OrderReturnedPayload\n | OrderDeliveryFailedPayload\n | OrderOnHoldPayload\n | OrderPaidPayload\n | OrderPaidReturnPayload\n | OrderExchangedPayload\n | StoreCreatedPayload\n | StoreUpdatedPayload;\n\n/** Maps each \\`PathaoWebhookEvent\\` to its specific payload type */\nexport interface WebhookEventPayloadMap {\n [PathaoWebhookEvent.WEBHOOK_INTEGRATION]: WebhookIntegrationPayload;\n [PathaoWebhookEvent.ORDER_CREATED]: OrderCreatedPayload;\n [PathaoWebhookEvent.ORDER_UPDATED]: OrderUpdatedPayload;\n [PathaoWebhookEvent.ORDER_PICKUP_REQUESTED]: OrderPickupRequestedPayload;\n [PathaoWebhookEvent.ORDER_ASSIGNED_FOR_PICKUP]: OrderAssignedForPickupPayload;\n [PathaoWebhookEvent.ORDER_PICKED]: OrderPickedPayload;\n [PathaoWebhookEvent.ORDER_PICKUP_FAILED]: OrderPickupFailedPayload;\n [PathaoWebhookEvent.ORDER_PICKUP_CANCELLED]: OrderPickupCancelledPayload;\n [PathaoWebhookEvent.ORDER_AT_THE_SORTING_HUB]: OrderAtSortingHubPayload;\n [PathaoWebhookEvent.ORDER_IN_TRANSIT]: OrderInTransitPayload;\n [PathaoWebhookEvent.ORDER_RECEIVED_AT_LAST_MILE_HUB]: OrderAtLastMileHubPayload;\n [PathaoWebhookEvent.ORDER_ASSIGNED_FOR_DELIVERY]: OrderAssignedForDeliveryPayload;\n [PathaoWebhookEvent.ORDER_DELIVERED]: OrderDeliveredPayload;\n [PathaoWebhookEvent.ORDER_PARTIAL_DELIVERY]: OrderPartialDeliveryPayload;\n [PathaoWebhookEvent.ORDER_RETURNED]: OrderReturnedPayload;\n [PathaoWebhookEvent.ORDER_DELIVERY_FAILED]: OrderDeliveryFailedPayload;\n [PathaoWebhookEvent.ORDER_ON_HOLD]: OrderOnHoldPayload;\n [PathaoWebhookEvent.ORDER_PAID]: OrderPaidPayload;\n [PathaoWebhookEvent.ORDER_PAID_RETURN]: OrderPaidReturnPayload;\n [PathaoWebhookEvent.ORDER_EXCHANGED]: OrderExchangedPayload;\n [PathaoWebhookEvent.STORE_CREATED]: StoreCreatedPayload;\n [PathaoWebhookEvent.STORE_UPDATED]: StoreUpdatedPayload;\n}\n\n// ---------------------------------------------------------------------------\n// Core functions\n// ---------------------------------------------------------------------------\n\n/** Required response header used to authorize your endpoint with Pathao */\nexport const PATHAO_SECRET_HEADER = 'x-pathao-merchant-webhook-integration-secret';\n\n/**\n * Parses the raw body into a webhook payload.\n * Pathao does not sign inbound requests, so this just ensures it is valid JSON with an event field.\n *\n * Throws \\`PathaoWebhookError\\` on malformed JSON or missing event.\n *\n * @param rawBody Raw request body or parsed object\n */\nexport function constructEvent(\n rawBody: Buffer | string | object,\n): PathaoWebhookPayload {\n let parsed: unknown;\n if (typeof rawBody === 'object' && !Buffer.isBuffer(rawBody)) {\n parsed = rawBody;\n } else {\n const bodyStr = Buffer.isBuffer(rawBody) ? rawBody.toString('utf8') : rawBody;\n try {\n parsed = JSON.parse(bodyStr);\n } catch {\n throw new PathaoWebhookError('Webhook payload is not valid JSON.');\n }\n }\n\n if (\n !parsed ||\n typeof parsed !== 'object' ||\n !('event' in parsed)\n ) {\n throw new PathaoWebhookError(\n 'Webhook payload is missing the required \\`event\\` field.',\n );\n }\n\n return parsed as PathaoWebhookPayload;\n}\n\n// ---------------------------------------------------------------------------\n// PathaoWebhookHandler\n// ---------------------------------------------------------------------------\n\nexport type WebhookResponseInstructions = {\n statusCode: number;\n headers: Record<string, string>;\n payload: PathaoWebhookPayload | null;\n error: PathaoWebhookError | null;\n};\n\n/**\n * Stateful webhook handler that parses payloads, provides response instructions,\n * and dispatches events to typed listeners.\n *\n * @example\n * \\`\\`\\`typescript\n * const handler = new PathaoWebhookHandler(process.env.PATHAO_WEBHOOK_SECRET!);\n *\n * handler.on(PathaoWebhookEvent.ORDER_DELIVERED, (payload) => {\n * // payload is fully typed as OrderDeliveredPayload\n * console.log(payload.consignment_id, payload.collected_amount);\n * });\n * \\`\\`\\`\n */\nexport class PathaoWebhookHandler extends EventEmitter {\n private readonly webhookSecret: string;\n\n constructor(webhookSecret: string) {\n super();\n if (!webhookSecret) {\n throw new PathaoWebhookError(\n 'webhookSecret is required to create a PathaoWebhookHandler.',\n );\n }\n this.webhookSecret = webhookSecret;\n }\n\n // Typed on() overloads ──────────────────────────────────────────────────\n\n /** Listen for a specific Pathao event with a fully-typed payload callback. */\n on<E extends PathaoWebhookEvent>(\n event: E,\n listener: (payload: WebhookEventPayloadMap[E]) => void,\n ): this;\n /** Fires for every successfully parsed event regardless of type. */\n on(event: 'webhook', listener: (payload: PathaoWebhookPayload) => void): this;\n /** Fires when parsing fails. */\n on(event: 'error', listener: (error: PathaoWebhookError) => void): this;\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n on(event: string | symbol, listener: (...args: any[]) => void): this {\n return super.on(event, listener);\n }\n\n /** Listen once for a specific Pathao event. */\n once<E extends PathaoWebhookEvent>(\n event: E,\n listener: (payload: WebhookEventPayloadMap[E]) => void,\n ): this;\n once(event: 'webhook', listener: (payload: PathaoWebhookPayload) => void): this;\n once(event: 'error', listener: (error: PathaoWebhookError) => void): this;\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n once(event: string | symbol, listener: (...args: any[]) => void): this {\n return super.once(event, listener);\n }\n\n // ─────────────────────────────────────────────────────────────────────────\n\n /**\n * Parse the body and dispatch the event.\n *\n * Throws \\`PathaoWebhookError\\` on failure and also emits \\`'error'\\` so\n * listeners can respond without a try/catch.\n *\n * @param rawBody Raw request body or matched json object\n */\n process(rawBody: Buffer | string | object): PathaoWebhookPayload {\n let payload: PathaoWebhookPayload;\n\n try {\n payload = constructEvent(rawBody);\n } catch (err) {\n const webhookErr = err instanceof PathaoWebhookError\n ? err\n : new PathaoWebhookError(err instanceof Error ? err.message : 'Unknown error');\n if (this.listenerCount('error') > 0) {\n this.emit('error', webhookErr);\n }\n throw webhookErr;\n }\n\n this.emit(payload.event, payload);\n this.emit('webhook', payload);\n\n return payload;\n }\n\n /**\n * Returns an Express-compatible middleware function.\n *\n * Automatically sets the required \\`X-Pathao-Merchant-Webhook-Integration-Secret\\` header.\n * Automatically responds with 202 for the \\`webhook_integration\\` handshake.\n * For standard events, attaches the payload to \\`req.pathaoWebhook\\` and calls \\`next()\\`.\n * On error, calls \\`next(err)\\`.\n *\n * \\`\\`\\`typescript\n * app.post(\n * '/webhooks/pathao',\n * express.json(),\n * handler.expressMiddleware(),\n * (req, res) => res.sendStatus(200) // You must send 200 for other events\n * );\n * \\`\\`\\`\n */\n expressMiddleware() {\n return (\n req: {\n body: Buffer | string | object;\n pathaoWebhook?: PathaoWebhookPayload;\n },\n res: {\n setHeader: (name: string, value: string) => void;\n status: (code: number) => { send: () => void };\n },\n next: (err?: unknown) => void,\n ): void => {\n try {\n res.setHeader(PATHAO_SECRET_HEADER, this.webhookSecret);\n \n const payload = this.process(req.body);\n req.pathaoWebhook = payload;\n \n if (payload.event === PathaoWebhookEvent.WEBHOOK_INTEGRATION) {\n res.status(202).send();\n return;\n }\n\n next();\n } catch (err) {\n next(err);\n }\n };\n }\n\n /**\n * Returns response instructions for any framework (Fastify, Hono, etc.).\n *\n * Never throws — always resolves with a \\`WebhookResponseInstructions\\` object\n * that tells you which status code and headers to return, along with the payload/error.\n *\n * \\`\\`\\`typescript\n * const handle = handler.middleware();\n * const instructions = await handle(request.body);\n * \n * // Apply the required headers (the secret header)\n * for (const [key, value] of Object.entries(instructions.headers)) {\n * reply.header(key, value);\n * }\n * \n * if (instructions.error) {\n * return reply.status(instructions.statusCode).send({ error: instructions.error.message });\n * }\n * \n * // If it was the handshake, we should just return 202 as instructed\n * if (instructions.payload?.event === 'webhook_integration') {\n * return reply.status(instructions.statusCode).send();\n * }\n * \n * // Process your real webhook\n * return reply.status(instructions.statusCode).send({ received: true });\n * \\`\\`\\`\n */\n middleware() {\n return async (\n rawBody: Buffer | string | object,\n ): Promise<WebhookResponseInstructions> => {\n const headers = { [PATHAO_SECRET_HEADER]: this.webhookSecret };\n \n try {\n const payload = this.process(rawBody);\n const isHandshake = payload.event === PathaoWebhookEvent.WEBHOOK_INTEGRATION;\n return {\n statusCode: isHandshake ? 202 : 200,\n headers,\n payload,\n error: null\n };\n } catch (err) {\n const webhookErr = err instanceof PathaoWebhookError\n ? err\n : new PathaoWebhookError(\n err instanceof Error ? err.message : 'Unknown error',\n );\n return {\n statusCode: 400,\n headers,\n payload: null,\n error: webhookErr\n };\n }\n };\n }\n}\n"]}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "pathao-merchant-sdk",
3
- "version": "2.0.2",
4
- "description": "Unofficial Pathao Merchant API SDK for Node.js and TypeScript",
3
+ "version": "2.2.0",
4
+ "description": "Unofficial TypeScript SDK for the Pathao Merchant API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
7
7
  "types": "dist/index.d.ts",
@@ -10,6 +10,11 @@
10
10
  "types": "./dist/index.d.ts",
11
11
  "import": "./dist/index.mjs",
12
12
  "require": "./dist/index.js"
13
+ },
14
+ "./webhooks": {
15
+ "types": "./dist/webhooks.d.ts",
16
+ "import": "./dist/webhooks.mjs",
17
+ "require": "./dist/webhooks.js"
13
18
  }
14
19
  },
15
20
  "sideEffects": false,
@@ -46,7 +51,8 @@
46
51
  "bangladesh",
47
52
  "shipping",
48
53
  "logistics",
49
- "ecommerce"
54
+ "ecommerce",
55
+ "webhook"
50
56
  ],
51
57
  "author": "Sifat Jasim <sifatjasim@gmail.com>",
52
58
  "license": "MIT",
@@ -69,6 +75,7 @@
69
75
  "@types/node": "^20.0.0",
70
76
  "@typescript-eslint/eslint-plugin": "^6.21.0",
71
77
  "@typescript-eslint/parser": "^6.21.0",
78
+ "axios-mock-adapter": "^2.1.0",
72
79
  "eslint": "^8.0.0",
73
80
  "jest": "^29.0.0",
74
81
  "ts-jest": "^29.0.0",